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