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