1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2019 The FreeBSD Foundation
5 *
6 * This software was developed by BFF Storage Systems, LLC under sponsorship
7 * from the FreeBSD Foundation.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
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.
17 *
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
28 * SUCH DAMAGE.
29 */
30
31 struct _sem;
32 typedef struct _sem sem_t;
33 struct _dirdesc;
34 typedef struct _dirdesc DIR;
35
36 /* Nanoseconds to sleep, for tests that must */
37 #define NAP_NS (100'000'000)
38
39 void get_unprivileged_id(uid_t *uid, gid_t *gid);
nap()40 inline void nap()
41 {
42 usleep(NAP_NS / 1000);
43 }
44
45 enum cache_mode {
46 Uncached,
47 Writethrough,
48 Writeback,
49 WritebackAsync
50 };
51
52 const char *cache_mode_to_s(enum cache_mode cm);
53 bool is_unsafe_aio_enabled(void);
54
55 extern const uint32_t libfuse_max_write;
56 class FuseTest : public ::testing::Test {
57 protected:
58 uint32_t m_maxread;
59 uint32_t m_maxreadahead;
60 uint32_t m_maxwrite;
61 uint32_t m_init_flags;
62 bool m_allow_other;
63 bool m_default_permissions;
64 uint32_t m_kernel_minor_version;
65 enum poll_method m_pm;
66 bool m_noatime;
67 bool m_push_symlinks_in;
68 bool m_ro;
69 bool m_async;
70 bool m_noclusterr;
71 bool m_nointr;
72 bool m_no_auto_init;
73 bool m_auto_unmount;
74 unsigned m_time_gran;
75 MockFS *m_mock = NULL;
76 const static uint64_t FH = 0xdeadbeef1a7ebabe;
77 const char *reclaim_mib = "debug.try_reclaim_vnode";
78 const char *m_fsname;
79 const char *m_subtype;
80
81 public:
82 int m_maxbcachebuf;
83 unsigned long m_maxphys;
84
FuseTest()85 FuseTest():
86 m_maxread(0),
87 m_maxreadahead(0),
88 m_maxwrite(0),
89 m_init_flags(0),
90 m_allow_other(false),
91 m_default_permissions(false),
92 m_kernel_minor_version(FUSE_KERNEL_MINOR_VERSION),
93 m_pm(BLOCKING),
94 m_noatime(false),
95 m_push_symlinks_in(false),
96 m_ro(false),
97 m_async(false),
98 m_noclusterr(false),
99 m_nointr(false),
100 m_no_auto_init(false),
101 m_auto_unmount(false),
102 m_time_gran(1),
103 m_fsname(""),
104 m_subtype(""),
105 m_maxbcachebuf(0),
106 m_maxphys(0)
107 {}
108
109 virtual void SetUp();
110
TearDown()111 virtual void TearDown() {
112 if (m_mock)
113 delete m_mock;
114 }
115
116 /*
117 * Create an expectation that FUSE_ACCESS will be called once for the
118 * given inode with the given access_mode, returning the given errno
119 */
120 void expect_access(uint64_t ino, mode_t access_mode, int error);
121
122 /* Expect FUSE_DESTROY and shutdown the daemon */
123 void expect_destroy(int error);
124
125 /*
126 * Create an expectation that FUSE_FALLOCATE will be called with the
127 * given inode, offset, length, and mode, exactly times times and
128 * returning error
129 */
130 void expect_fallocate(uint64_t ino, uint64_t offset, uint64_t length,
131 uint32_t mode, int error, int times=1);
132
133 /*
134 * Create an expectation that FUSE_FLUSH will be called times times for
135 * the given inode
136 */
137 void expect_flush(uint64_t ino, int times, ProcessMockerT r);
138
139 /*
140 * Create an expectation that FUSE_FORGET will be called for the given
141 * inode. There will be no response. If sem is provided, it will be
142 * posted after the operation is received by the daemon.
143 */
144 void expect_forget(uint64_t ino, uint64_t nlookup, sem_t *sem = NULL);
145
146 /*
147 * Create an expectation that FUSE_GETATTR will be called for the given
148 * inode any number of times. It will respond with a few basic
149 * attributes, like the given size and the mode S_IFREG | 0644
150 */
151 void expect_getattr(uint64_t ino, uint64_t size);
152
153 /*
154 * Create an expectation that FUSE_GETXATTR will be called once for the
155 * given inode.
156 */
157 void expect_getxattr(uint64_t ino, const char *attr, ProcessMockerT r);
158
159 /*
160 * Create an expectation that FUSE_LOOKUP will be called for the given
161 * path exactly times times and cache validity period. It will respond
162 * with inode ino, mode mode, filesize size.
163 */
164 void expect_lookup(const char *relpath, uint64_t ino, mode_t mode,
165 uint64_t size, int times, uint64_t attr_valid = UINT64_MAX,
166 uid_t uid = 0, gid_t gid = 0);
167
168 /* The protocol 7.8 version of expect_lookup */
169 void expect_lookup_7_8(const char *relpath, uint64_t ino, mode_t mode,
170 uint64_t size, int times, uint64_t attr_valid = UINT64_MAX,
171 uid_t uid = 0, gid_t gid = 0);
172
173 /*
174 * Create an expectation that FUSE_OPEN will be called for the given
175 * inode exactly times times. It will return with open_flags flags and
176 * file handle FH.
177 */
178 void expect_open(uint64_t ino, uint32_t flags, int times);
179
180 /*
181 * Create an expectation that FUSE_OPENDIR will be called exactly once
182 * for inode ino.
183 */
184 void expect_opendir(uint64_t ino);
185
186 /*
187 * Create an expectation that FUSE_READ will be called exactly once for
188 * the given inode, at offset offset and with size isize. It will
189 * return the first osize bytes from contents
190 *
191 * Protocol 7.8 tests can use this same expectation method because
192 * nothing currently validates the size of the fuse_read_in struct.
193 */
194 void expect_read(uint64_t ino, uint64_t offset, uint64_t isize,
195 uint64_t osize, const void *contents, int flags = -1,
196 uint64_t fh = FH);
197
198 /*
199 * Create an expectation that FUSE_READIR will be called any number of
200 * times on the given ino with the given offset, returning (by copy)
201 * the provided entries
202 */
203 void expect_readdir(uint64_t ino, uint64_t off,
204 std::vector<struct dirent> &ents);
205
206 /*
207 * Create an expectation that FUSE_RELEASE will be called exactly once
208 * for the given inode and filehandle, returning success
209 */
210 void expect_release(uint64_t ino, uint64_t fh);
211
212 /*
213 * Create an expectation that FUSE_RELEASEDIR will be called exactly
214 * once for the given inode
215 */
216 void expect_releasedir(uint64_t ino, ProcessMockerT r);
217
218 /*
219 * Create an expectation that FUSE_UNLINK will be called exactly once
220 * for the given path, returning an errno
221 */
222 void expect_unlink(uint64_t parent, const char *path, int error);
223
224 /*
225 * Create an expectation that FUSE_WRITE will be called exactly once
226 * for the given inode, at offset offset, with size isize and buffer
227 * contents. Any flags present in flags_set must be set, and any
228 * present in flags_unset must not be set. Other flags are don't care.
229 * It will return osize.
230 */
231 void expect_write(uint64_t ino, uint64_t offset, uint64_t isize,
232 uint64_t osize, uint32_t flags_set, uint32_t flags_unset,
233 const void *contents);
234
235 /* Protocol 7.8 version of expect_write */
236 void expect_write_7_8(uint64_t ino, uint64_t offset, uint64_t isize,
237 uint64_t osize, const void *contents);
238
239 /* Duplicate the /dev/fuse file descriptor, and return the duplicate */
240 int dup_dev_fuse();
241
242 /*
243 * Helper that runs code in a child process.
244 *
245 * First, parent_func runs in the parent process.
246 * Then, child_func runs in the child process, dropping privileges if
247 * desired.
248 * Finally, fusetest_fork returns.
249 *
250 * # Returns
251 *
252 * fusetest_fork may SKIP the test, which the caller should detect with
253 * the IsSkipped() method. If not, then the child's exit status will
254 * be returned in status.
255 */
256 void fork(bool drop_privs, int *status,
257 std::function<void()> parent_func,
258 std::function<int()> child_func);
259
260 /*
261 * Deliberately leak a file descriptor.
262 *
263 * Closing a file descriptor on fusefs would cause the server to
264 * receive FUSE_CLOSE and possibly FUSE_INACTIVE. Handling those
265 * operations would needlessly complicate most tests. So most tests
266 * deliberately leak the file descriptors instead. This method serves
267 * to document the leakage, and provide a single point of suppression
268 * for static analyzers.
269 */
270 /* coverity[+close: arg-0] */
leak(int fd __unused)271 static void leak(int fd __unused) {}
272
273 /*
274 * Deliberately leak a DIR* pointer
275 *
276 * See comments for FuseTest::leak
277 */
leakdir(DIR * dirp __unused)278 static void leakdir(DIR* dirp __unused) {}
279
280 /* Manually reclaim a vnode. Requires root privileges. */
281 void reclaim_vnode(const char *fullpath);
282 };
283