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
32 typedef struct _sem sem_t;
34 /* Nanoseconds to sleep, for tests that must */
35 #define NAP_NS (100'000'000)
37 void get_unprivileged_id(uid_t *uid, gid_t *gid);
40 usleep(NAP_NS / 1000);
43 extern const uint32_t libfuse_max_write;
44 extern const uint32_t default_max_write;
45 class FuseTest : public ::testing::Test {
47 uint32_t m_maxreadahead;
49 uint32_t m_init_flags;
51 bool m_default_permissions;
52 uint32_t m_kernel_minor_version;
53 enum poll_method m_pm;
54 bool m_push_symlinks_in;
59 MockFS *m_mock = NULL;
60 const static uint64_t FH = 0xdeadbeef1a7ebabe;
68 m_maxwrite(default_max_write),
71 m_default_permissions(false),
72 m_kernel_minor_version(FUSE_KERNEL_MINOR_VERSION),
74 m_push_symlinks_in(false),
83 virtual void TearDown() {
89 * Create an expectation that FUSE_ACCESS will be called once for the
90 * given inode with the given access_mode, returning the given errno
92 void expect_access(uint64_t ino, mode_t access_mode, int error);
94 /* Expect FUSE_DESTROY and shutdown the daemon */
95 void expect_destroy(int error);
98 * Create an expectation that FUSE_FLUSH will be called times times for
101 void expect_flush(uint64_t ino, int times, ProcessMockerT r);
104 * Create an expectation that FUSE_FORGET will be called for the given
105 * inode. There will be no response. If sem is provided, it will be
106 * posted after the operation is received by the daemon.
108 void expect_forget(uint64_t ino, uint64_t nlookup, sem_t *sem = NULL);
111 * Create an expectation that FUSE_GETATTR will be called for the given
112 * inode any number of times. It will respond with a few basic
113 * attributes, like the given size and the mode S_IFREG | 0644
115 void expect_getattr(uint64_t ino, uint64_t size);
118 * Create an expectation that FUSE_LOOKUP will be called for the given
119 * path exactly times times and cache validity period. It will respond
120 * with inode ino, mode mode, filesize size.
122 void expect_lookup(const char *relpath, uint64_t ino, mode_t mode,
123 uint64_t size, int times, uint64_t attr_valid = UINT64_MAX,
124 uid_t uid = 0, gid_t gid = 0);
126 /* The protocol 7.8 version of expect_lookup */
127 void expect_lookup_7_8(const char *relpath, uint64_t ino, mode_t mode,
128 uint64_t size, int times, uint64_t attr_valid = UINT64_MAX,
129 uid_t uid = 0, gid_t gid = 0);
132 * Create an expectation that FUSE_OPEN will be called for the given
133 * inode exactly times times. It will return with open_flags flags and
136 void expect_open(uint64_t ino, uint32_t flags, int times);
139 * Create an expectation that FUSE_OPENDIR will be called exactly once
142 void expect_opendir(uint64_t ino);
145 * Create an expectation that FUSE_READ will be called exactly once for
146 * the given inode, at offset offset and with size isize. It will
147 * return the first osize bytes from contents
149 * Protocol 7.8 tests can use this same expectation method because
150 * nothing currently validates the size of the fuse_read_in struct.
152 void expect_read(uint64_t ino, uint64_t offset, uint64_t isize,
153 uint64_t osize, const void *contents, int flags = -1);
156 * Create an expectation that FUSE_READIR will be called any number of
157 * times on the given ino with the given offset, returning (by copy)
158 * the provided entries
160 void expect_readdir(uint64_t ino, uint64_t off,
161 std::vector<struct dirent> &ents);
164 * Create an expectation that FUSE_RELEASE will be called exactly once
165 * for the given inode and filehandle, returning success
167 void expect_release(uint64_t ino, uint64_t fh);
170 * Create an expectation that FUSE_RELEASEDIR will be called exactly
171 * once for the given inode
173 void expect_releasedir(uint64_t ino, ProcessMockerT r);
176 * Create an expectation that FUSE_UNLINK will be called exactly once
177 * for the given path, returning an errno
179 void expect_unlink(uint64_t parent, const char *path, int error);
182 * Create an expectation that FUSE_WRITE will be called exactly once
183 * for the given inode, at offset offset, with size isize and buffer
184 * contents. Any flags present in flags_set must be set, and any
185 * present in flags_unset must not be set. Other flags are don't care.
186 * It will return osize.
188 void expect_write(uint64_t ino, uint64_t offset, uint64_t isize,
189 uint64_t osize, uint32_t flags_set, uint32_t flags_unset,
190 const void *contents);
192 /* Protocol 7.8 version of expect_write */
193 void expect_write_7_8(uint64_t ino, uint64_t offset, uint64_t isize,
194 uint64_t osize, const void *contents);
197 * Helper that runs code in a child process.
199 * First, parent_func runs in the parent process.
200 * Then, child_func runs in the child process, dropping privileges if
202 * Finally, fusetest_fork returns.
206 * fusetest_fork may SKIP the test, which the caller should detect with
207 * the IsSkipped() method. If not, then the child's exit status will
208 * be returned in status.
210 void fork(bool drop_privs, int *status,
211 std::function<void()> parent_func,
212 std::function<int()> child_func);