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