2 * Copyright 2013 Facebook, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include "folly/FileUtil.h"
18 #include "folly/detail/FileUtilDetail.h"
22 #include <glog/logging.h>
23 #include <gflags/gflags.h>
24 #include <gtest/gtest.h>
26 #include "folly/Benchmark.h"
27 #include "folly/Range.h"
28 #include "folly/String.h"
30 namespace folly { namespace test {
32 using namespace fileutil_detail;
38 Reader(off_t offset, StringPiece data, std::deque<ssize_t> spec);
41 ssize_t operator()(int fd, void* buf, size_t count);
44 ssize_t operator()(int fd, void* buf, size_t count, off_t offset);
47 ssize_t operator()(int fd, const iovec* iov, int count);
50 ssize_t operator()(int fd, const iovec* iov, int count, off_t offset);
52 const std::deque<ssize_t> spec() const { return spec_; }
59 std::deque<ssize_t> spec_;
62 Reader::Reader(off_t offset, StringPiece data, std::deque<ssize_t> spec)
65 spec_(std::move(spec)) {
68 ssize_t Reader::nextSize() {
70 throw std::runtime_error("spec empty");
72 ssize_t n = spec_.front();
78 spec_.clear(); // so we fail if called again
85 ssize_t Reader::operator()(int fd, void* buf, size_t count) {
86 ssize_t n = nextSize();
91 throw std::runtime_error("requested count too small");
93 memcpy(buf, data_.data(), n);
98 ssize_t Reader::operator()(int fd, void* buf, size_t count, off_t offset) {
99 EXPECT_EQ(offset_, offset);
100 return operator()(fd, buf, count);
103 ssize_t Reader::operator()(int fd, const iovec* iov, int count) {
104 ssize_t n = nextSize();
108 ssize_t remaining = n;
109 for (; count != 0 && remaining != 0; ++iov, --count) {
110 ssize_t len = std::min(remaining, ssize_t(iov->iov_len));
111 memcpy(iov->iov_base, data_.data(), len);
115 if (remaining != 0) {
116 throw std::runtime_error("requested total size too small");
121 ssize_t Reader::operator()(int fd, const iovec* iov, int count, off_t offset) {
122 EXPECT_EQ(offset_, offset);
123 return operator()(fd, iov, count);
128 class FileUtilTest : public ::testing::Test {
132 Reader reader(std::deque<ssize_t> spec);
135 std::vector<std::pair<size_t, Reader>> readers_;
138 FileUtilTest::FileUtilTest()
139 : in_("1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ") {
140 CHECK_EQ(62, in_.size());
142 readers_.emplace_back(0, reader({0}));
143 readers_.emplace_back(62, reader({62}));
144 readers_.emplace_back(62, reader({62, -1})); // error after end (not called)
145 readers_.emplace_back(61, reader({61, 0}));
146 readers_.emplace_back(-1, reader({61, -1})); // error before end
147 readers_.emplace_back(62, reader({31, 31}));
148 readers_.emplace_back(62, reader({1, 10, 20, 10, 1, 20}));
149 readers_.emplace_back(61, reader({1, 10, 20, 10, 20, 0}));
150 readers_.emplace_back(41, reader({1, 10, 20, 10, 0}));
151 readers_.emplace_back(-1, reader({1, 10, 20, 10, 20, -1}));
154 Reader FileUtilTest::reader(std::deque<ssize_t> spec) {
155 return Reader(42, in_, std::move(spec));
158 TEST_F(FileUtilTest, read) {
159 for (auto& p : readers_) {
160 std::string out(in_.size(), '\0');
161 EXPECT_EQ(p.first, wrapFull(p.second, 0, &out[0], out.size()));
163 EXPECT_EQ(in_.substr(0, p.first), out.substr(0, p.first));
168 TEST_F(FileUtilTest, pread) {
169 for (auto& p : readers_) {
170 std::string out(in_.size(), '\0');
171 EXPECT_EQ(p.first, wrapFull(p.second, 0, &out[0], out.size(), off_t(42)));
173 EXPECT_EQ(in_.substr(0, p.first), out.substr(0, p.first));
180 explicit IovecBuffers(std::initializer_list<size_t> sizes);
182 std::vector<iovec> iov() const { return iov_; } // yes, make a copy
183 std::string join() const { return folly::join("", buffers_); }
187 std::vector<std::string> buffers_;
188 std::vector<iovec> iov_;
191 IovecBuffers::IovecBuffers(std::initializer_list<size_t> sizes) {
192 iov_.reserve(sizes.size());
193 for (auto& s : sizes) {
194 buffers_.push_back(std::string(s, '\0'));
196 for (auto& b : buffers_) {
198 iov.iov_base = &b[0];
199 iov.iov_len = b.size();
204 size_t IovecBuffers::size() const {
206 for (auto& b : buffers_) {
212 TEST_F(FileUtilTest, readv) {
213 for (auto& p : readers_) {
214 IovecBuffers buf({12, 19, 31});
215 ASSERT_EQ(62, buf.size());
217 auto iov = buf.iov();
218 EXPECT_EQ(p.first, wrapvFull(p.second, 0, iov.data(), iov.size()));
220 EXPECT_EQ(in_.substr(0, p.first), buf.join().substr(0, p.first));
225 TEST_F(FileUtilTest, preadv) {
226 for (auto& p : readers_) {
227 IovecBuffers buf({12, 19, 31});
228 ASSERT_EQ(62, buf.size());
230 auto iov = buf.iov();
232 wrapvFull(p.second, 0, iov.data(), iov.size(), off_t(42)));
234 EXPECT_EQ(in_.substr(0, p.first), buf.join().substr(0, p.first));
242 int main(int argc, char *argv[]) {
243 testing::InitGoogleTest(&argc, argv);
244 google::ParseCommandLineFlags(&argc, &argv, true);
245 return RUN_ALL_TESTS();