2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2019 The FreeBSD Foundation
6 * This software was developed by BFF Storage Systems, LLC under sponsorship
7 * from the FreeBSD Foundation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 using namespace testing;
42 class Readdir: public FuseTest {
44 void expect_lookup(const char *relpath, uint64_t ino)
46 FuseTest::expect_lookup(relpath, ino, S_IFDIR | 0755, 1);
49 void expect_readdir(uint64_t ino, uint64_t off, vector<struct dirent> &ents)
51 EXPECT_CALL(*m_mock, process(
52 ResultOf([=](auto in) {
53 return (in->header.opcode == FUSE_READDIR &&
54 in->header.nodeid == ino &&
55 in->body.readdir.offset == off);
58 ).WillRepeatedly(Invoke(ReturnImmediate([=](auto in, auto out) {
59 struct fuse_dirent *fde = (struct fuse_dirent*)out->body.bytes;
62 out->header.error = 0;
65 for (const auto& it: ents) {
66 size_t entlen, entsize;
68 fde->ino = it.d_fileno;
70 fde->type = it.d_type;
71 fde->namelen = it.d_namlen;
72 strncpy(fde->name, it.d_name, it.d_namlen);
73 entlen = FUSE_NAME_OFFSET + fde->namelen;
74 entsize = FUSE_DIRENT_SIZE(fde);
76 * The FUSE protocol does not require zeroing out the
77 * unused portion of the name. But it's a good
78 * practice to prevent information disclosure to the
79 * FUSE client, even though the client is usually the
82 memset(fde->name + fde->namelen, 0, entsize - entlen);
83 if (out->header.len + entsize > in->body.read.size) {
84 printf("Overflow in readdir expectation: i=%d\n"
88 out->header.len += entsize;
89 fde = (struct fuse_dirent*)
90 ((long*)fde + entsize / sizeof(long));
93 out->header.len += sizeof(out->header);
99 /* FUSE_READDIR returns nothing but "." and ".." */
100 TEST_F(Readdir, dots)
102 const char FULLPATH[] = "mountpoint/some_dir";
103 const char RELPATH[] = "some_dir";
107 vector<struct dirent> ents(2);
108 vector<struct dirent> empty_ents(0);
109 const char *dot = ".";
110 const char *dotdot = "..";
112 expect_lookup(RELPATH, ino);
114 ents[0].d_fileno = 2;
115 ents[0].d_off = 2000;
116 ents[0].d_namlen = strlen(dotdot);
117 ents[0].d_type = DT_DIR;
118 strncpy(ents[0].d_name, dotdot, ents[0].d_namlen);
119 ents[1].d_fileno = 3;
120 ents[1].d_off = 3000;
121 ents[1].d_namlen = strlen(dot);
122 ents[1].d_type = DT_DIR;
123 strncpy(ents[1].d_name, dot, ents[1].d_namlen);
124 expect_readdir(ino, 0, ents);
125 expect_readdir(ino, 3000, empty_ents);
128 dir = opendir(FULLPATH);
129 ASSERT_NE(NULL, dir) << strerror(errno);
133 ASSERT_NE(NULL, de) << strerror(errno);
134 EXPECT_EQ(2ul, de->d_fileno);
136 * fuse(4) doesn't actually set d_off, which is ok for now because
139 //EXPECT_EQ(2000, de->d_off);
140 EXPECT_EQ(DT_DIR, de->d_type);
141 EXPECT_EQ(2, de->d_namlen);
142 EXPECT_EQ(0, strcmp("..", de->d_name));
146 ASSERT_NE(NULL, de) << strerror(errno);
147 EXPECT_EQ(3ul, de->d_fileno);
148 //EXPECT_EQ(3000, de->d_off);
149 EXPECT_EQ(DT_DIR, de->d_type);
150 EXPECT_EQ(1, de->d_namlen);
151 EXPECT_EQ(0, strcmp(".", de->d_name));
153 ASSERT_EQ(NULL, readdir(dir));
156 /* Deliberately leak dir. RELEASEDIR will be tested separately */
161 const char FULLPATH[] = "mountpoint/some_dir";
162 const char RELPATH[] = "some_dir";
167 expect_lookup(RELPATH, ino);
169 EXPECT_CALL(*m_mock, process(
170 ResultOf([=](auto in) {
171 return (in->header.opcode == FUSE_READDIR &&
172 in->header.nodeid == ino &&
173 in->body.readdir.offset == 0);
176 ).WillOnce(Invoke(ReturnErrno(EIO)));
179 dir = opendir(FULLPATH);
180 ASSERT_NE(NULL, dir) << strerror(errno);
185 ASSERT_EQ(EIO, errno);
187 /* Deliberately leak dir. RELEASEDIR will be tested separately */
191 * FUSE_READDIR returns nothing, not even "." and "..". This is legal, though
192 * the filesystem obviously won't be fully functional.
194 TEST_F(Readdir, nodots)
196 const char FULLPATH[] = "mountpoint/some_dir";
197 const char RELPATH[] = "some_dir";
201 expect_lookup(RELPATH, ino);
204 EXPECT_CALL(*m_mock, process(
205 ResultOf([=](auto in) {
206 return (in->header.opcode == FUSE_READDIR &&
207 in->header.nodeid == ino);
210 ).WillOnce(Invoke(ReturnImmediate([=](auto in __unused, auto out) {
211 out->header.error = 0;
212 out->header.len = sizeof(out->header);
216 dir = opendir(FULLPATH);
217 ASSERT_NE(NULL, dir) << strerror(errno);
219 ASSERT_EQ(NULL, readdir(dir));
222 /* Deliberately leak dir. RELEASEDIR will be tested separately */
225 /* telldir(3) and seekdir(3) should work with fuse */
226 TEST_F(Readdir, seekdir)
228 const char FULLPATH[] = "mountpoint/some_dir";
229 const char RELPATH[] = "some_dir";
234 * use enough entries to be > 4096 bytes, so getdirentries must be
238 vector<struct dirent> ents0(122), ents1(102), ents2(30);
242 for (auto& it: ents0) {
243 snprintf(it.d_name, MAXNAMLEN, "file.%d", i);
245 it.d_off = (2 + i) * 1000;
246 it.d_namlen = strlen(it.d_name);
250 for (auto& it: ents1) {
251 snprintf(it.d_name, MAXNAMLEN, "file.%d", i);
253 it.d_off = (2 + i) * 1000;
254 it.d_namlen = strlen(it.d_name);
258 for (auto& it: ents2) {
259 snprintf(it.d_name, MAXNAMLEN, "file.%d", i);
261 it.d_off = (2 + i) * 1000;
262 it.d_namlen = strlen(it.d_name);
267 expect_lookup(RELPATH, ino);
270 expect_readdir(ino, 0, ents0);
271 expect_readdir(ino, 123000, ents1);
272 expect_readdir(ino, 225000, ents2);
275 dir = opendir(FULLPATH);
276 ASSERT_NE(NULL, dir) << strerror(errno);
278 for (i=0; i < 128; i++) {
281 ASSERT_NE(NULL, de) << strerror(errno);
282 EXPECT_EQ(2 + (ino_t)i, de->d_fileno);
284 bookmark = telldir(dir);
286 for (; i < 232; i++) {
289 ASSERT_NE(NULL, de) << strerror(errno);
290 EXPECT_EQ(2 + (ino_t)i, de->d_fileno);
293 seekdir(dir, bookmark);
295 ASSERT_NE(NULL, de) << strerror(errno);
296 EXPECT_EQ(130ul, de->d_fileno);
298 /* Deliberately leak dir. RELEASEDIR will be tested separately */