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