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 extern "C" { 34 #include <sys/types.h> 35 36 #include <pthread.h> 37 38 #include "fuse_kernel.h" 39 } 40 41 #include <gmock/gmock.h> 42 43 #define TIME_T_MAX (std::numeric_limits<time_t>::max()) 44 45 /* 46 * A pseudo-fuse errno used indicate that a fuse operation should have no 47 * response, at least not immediately 48 */ 49 #define FUSE_NORESPONSE 9999 50 51 #define SET_OUT_HEADER_LEN(out, variant) { \ 52 (out).header.len = (sizeof((out).header) + \ 53 sizeof((out).body.variant)); \ 54 } 55 56 /* 57 * Create an expectation on FUSE_LOOKUP and return it so the caller can set 58 * actions. 59 * 60 * This must be a macro instead of a method because EXPECT_CALL returns a type 61 * with a deleted constructor. 62 */ 63 #define EXPECT_LOOKUP(parent, path) \ 64 EXPECT_CALL(*m_mock, process( \ 65 ResultOf([=](auto in) { \ 66 return (in.header.opcode == FUSE_LOOKUP && \ 67 in.header.nodeid == (parent) && \ 68 strcmp(in.body.lookup, (path)) == 0); \ 69 }, Eq(true)), \ 70 _) \ 71 ) 72 73 extern int verbosity; 74 75 /* 76 * The maximum that a test case can set max_write, limited by the buffer 77 * supplied when reading from /dev/fuse. This limitation is imposed by 78 * fusefs-libs, but not by the FUSE protocol. 79 */ 80 const uint32_t max_max_write = 0x20000; 81 82 83 /* This struct isn't defined by fuse_kernel.h or libfuse, but it should be */ 84 struct fuse_create_out { 85 struct fuse_entry_out entry; 86 struct fuse_open_out open; 87 }; 88 89 /* Protocol 7.8 version of struct fuse_attr */ 90 struct fuse_attr_7_8 91 { 92 uint64_t ino; 93 uint64_t size; 94 uint64_t blocks; 95 uint64_t atime; 96 uint64_t mtime; 97 uint64_t ctime; 98 uint32_t atimensec; 99 uint32_t mtimensec; 100 uint32_t ctimensec; 101 uint32_t mode; 102 uint32_t nlink; 103 uint32_t uid; 104 uint32_t gid; 105 uint32_t rdev; 106 }; 107 108 /* Protocol 7.8 version of struct fuse_attr_out */ 109 struct fuse_attr_out_7_8 110 { 111 uint64_t attr_valid; 112 uint32_t attr_valid_nsec; 113 uint32_t dummy; 114 struct fuse_attr_7_8 attr; 115 }; 116 117 /* Protocol 7.8 version of struct fuse_entry_out */ 118 struct fuse_entry_out_7_8 { 119 uint64_t nodeid; /* Inode ID */ 120 uint64_t generation; /* Inode generation: nodeid:gen must 121 be unique for the fs's lifetime */ 122 uint64_t entry_valid; /* Cache timeout for the name */ 123 uint64_t attr_valid; /* Cache timeout for the attributes */ 124 uint32_t entry_valid_nsec; 125 uint32_t attr_valid_nsec; 126 struct fuse_attr_7_8 attr; 127 }; 128 129 /* Output struct for FUSE_CREATE for protocol 7.8 servers */ 130 struct fuse_create_out_7_8 { 131 struct fuse_entry_out_7_8 entry; 132 struct fuse_open_out open; 133 }; 134 135 /* Output struct for FUSE_INIT for protocol 7.22 and earlier servers */ 136 struct fuse_init_out_7_22 { 137 uint32_t major; 138 uint32_t minor; 139 uint32_t max_readahead; 140 uint32_t flags; 141 uint16_t max_background; 142 uint16_t congestion_threshold; 143 uint32_t max_write; 144 }; 145 146 union fuse_payloads_in { 147 fuse_access_in access; 148 fuse_bmap_in bmap; 149 /* 150 * In fusefs-libs 3.4.2 and below the buffer size is fixed at 0x21000 151 * minus the header sizes. fusefs-libs 3.4.3 (and FUSE Protocol 7.29) 152 * add a FUSE_MAX_PAGES option that allows it to be greater. 153 * 154 * See fuse_kern_chan.c in fusefs-libs 2.9.9 and below, or 155 * FUSE_DEFAULT_MAX_PAGES_PER_REQ in fusefs-libs 3.4.3 and above. 156 */ 157 uint8_t bytes[ 158 max_max_write + 0x1000 - sizeof(struct fuse_in_header) 159 ]; 160 fuse_copy_file_range_in copy_file_range; 161 fuse_create_in create; 162 fuse_flush_in flush; 163 fuse_fsync_in fsync; 164 fuse_fsync_in fsyncdir; 165 fuse_forget_in forget; 166 fuse_getattr_in getattr; 167 fuse_interrupt_in interrupt; 168 fuse_lk_in getlk; 169 fuse_getxattr_in getxattr; 170 fuse_init_in init; 171 fuse_link_in link; 172 fuse_listxattr_in listxattr; 173 char lookup[0]; 174 fuse_lseek_in lseek; 175 fuse_mkdir_in mkdir; 176 fuse_mknod_in mknod; 177 fuse_open_in open; 178 fuse_open_in opendir; 179 fuse_read_in read; 180 fuse_read_in readdir; 181 fuse_release_in release; 182 fuse_release_in releasedir; 183 fuse_rename_in rename; 184 char rmdir[0]; 185 fuse_setattr_in setattr; 186 fuse_setxattr_in setxattr; 187 fuse_lk_in setlk; 188 fuse_lk_in setlkw; 189 char unlink[0]; 190 fuse_write_in write; 191 }; 192 193 struct mockfs_buf_in { 194 fuse_in_header header; 195 union fuse_payloads_in body; 196 }; 197 198 union fuse_payloads_out { 199 fuse_attr_out attr; 200 fuse_attr_out_7_8 attr_7_8; 201 fuse_bmap_out bmap; 202 fuse_create_out create; 203 fuse_create_out_7_8 create_7_8; 204 /* 205 * The protocol places no limits on the size of bytes. Choose 206 * a size big enough for anything we'll test. 207 */ 208 uint8_t bytes[0x20000]; 209 fuse_entry_out entry; 210 fuse_entry_out_7_8 entry_7_8; 211 fuse_lk_out getlk; 212 fuse_getxattr_out getxattr; 213 fuse_init_out init; 214 fuse_init_out_7_22 init_7_22; 215 fuse_lseek_out lseek; 216 /* The inval_entry structure should be followed by the entry's name */ 217 fuse_notify_inval_entry_out inval_entry; 218 fuse_notify_inval_inode_out inval_inode; 219 /* The store structure should be followed by the data to store */ 220 fuse_notify_store_out store; 221 fuse_listxattr_out listxattr; 222 fuse_open_out open; 223 fuse_statfs_out statfs; 224 /* 225 * The protocol places no limits on the length of the string. This is 226 * merely convenient for testing. 227 */ 228 char str[80]; 229 fuse_write_out write; 230 }; 231 232 struct mockfs_buf_out { 233 fuse_out_header header; 234 union fuse_payloads_out body; 235 236 /* Default constructor: zero everything */ 237 mockfs_buf_out() { 238 memset(this, 0, sizeof(*this)); 239 } 240 }; 241 242 /* A function that can be invoked in place of MockFS::process */ 243 typedef std::function<void (const mockfs_buf_in& in, 244 std::vector<std::unique_ptr<mockfs_buf_out>> &out)> 245 ProcessMockerT; 246 247 /* 248 * Helper function used for setting an error expectation for any fuse operation. 249 * The operation will return the supplied error 250 */ 251 ProcessMockerT ReturnErrno(int error); 252 253 /* Helper function used for returning negative cache entries for LOOKUP */ 254 ProcessMockerT ReturnNegativeCache(const struct timespec *entry_valid); 255 256 /* Helper function used for returning a single immediate response */ 257 ProcessMockerT ReturnImmediate( 258 std::function<void(const mockfs_buf_in& in, 259 struct mockfs_buf_out &out)> f); 260 261 /* How the daemon should check /dev/fuse for readiness */ 262 enum poll_method { 263 BLOCKING, 264 SELECT, 265 POLL, 266 KQ 267 }; 268 269 /* 270 * Fake FUSE filesystem 271 * 272 * "Mounts" a filesystem to a temporary directory and services requests 273 * according to the programmed expectations. 274 * 275 * Operates directly on the fusefs(4) kernel API, not the libfuse(3) user api. 276 */ 277 class MockFS { 278 /* 279 * thread id of the fuse daemon thread 280 * 281 * It must run in a separate thread so it doesn't deadlock with the 282 * client test code. 283 */ 284 pthread_t m_daemon_id; 285 286 /* file descriptor of /dev/fuse control device */ 287 volatile int m_fuse_fd; 288 289 /* The minor version of the kernel API that this mock daemon targets */ 290 uint32_t m_kernel_minor_version; 291 292 int m_kq; 293 294 /* The max_readahead file system option */ 295 uint32_t m_maxreadahead; 296 297 /* pid of the test process */ 298 pid_t m_pid; 299 300 /* The unique value of the header of the last received operation */ 301 uint64_t m_last_unique; 302 303 /* Method the daemon should use for I/O to and from /dev/fuse */ 304 enum poll_method m_pm; 305 306 /* Timestamp granularity in nanoseconds */ 307 unsigned m_time_gran; 308 309 void audit_request(const mockfs_buf_in &in, ssize_t buflen); 310 void debug_request(const mockfs_buf_in&, ssize_t buflen); 311 void debug_response(const mockfs_buf_out&); 312 313 /* Initialize a session after mounting */ 314 void init(uint32_t flags); 315 316 /* Is pid from a process that might be involved in the test? */ 317 bool pid_ok(pid_t pid); 318 319 /* Default request handler */ 320 void process_default(const mockfs_buf_in&, 321 std::vector<std::unique_ptr<mockfs_buf_out>>&); 322 323 /* Entry point for the daemon thread */ 324 static void* service(void*); 325 326 /* 327 * Read, but do not process, a single request from the kernel 328 * 329 * @param in Return storage for the FUSE request 330 * @param res Return value of read(2). If positive, the amount of 331 * data read from the fuse device. 332 */ 333 void read_request(mockfs_buf_in& in, ssize_t& res); 334 335 /* Write a single response back to the kernel */ 336 void write_response(const mockfs_buf_out &out); 337 338 public: 339 /* pid of child process, for two-process test cases */ 340 pid_t m_child_pid; 341 342 /* Maximum size of a FUSE_WRITE write */ 343 uint32_t m_maxwrite; 344 345 /* 346 * Number of events that were available from /dev/fuse after the last 347 * kevent call. Only valid when m_pm = KQ. 348 */ 349 int m_nready; 350 351 /* Tell the daemon to shut down ASAP */ 352 bool m_quit; 353 354 /* Create a new mockfs and mount it to a tempdir */ 355 MockFS(int max_readahead, bool allow_other, 356 bool default_permissions, bool push_symlinks_in, bool ro, 357 enum poll_method pm, uint32_t flags, 358 uint32_t kernel_minor_version, uint32_t max_write, bool async, 359 bool no_clusterr, unsigned time_gran, bool nointr); 360 361 virtual ~MockFS(); 362 363 /* Kill the filesystem daemon without unmounting the filesystem */ 364 void kill_daemon(); 365 366 /* Process FUSE requests endlessly */ 367 void loop(); 368 369 /* 370 * Send an asynchronous notification to invalidate a directory entry. 371 * Similar to libfuse's fuse_lowlevel_notify_inval_entry 372 * 373 * This method will block until the client has responded, so it should 374 * generally be run in a separate thread from request processing. 375 * 376 * @param parent Parent directory's inode number 377 * @param name name of dirent to invalidate 378 * @param namelen size of name, including the NUL 379 */ 380 int notify_inval_entry(ino_t parent, const char *name, size_t namelen); 381 382 /* 383 * Send an asynchronous notification to invalidate an inode's cached 384 * data and/or attributes. Similar to libfuse's 385 * fuse_lowlevel_notify_inval_inode. 386 * 387 * This method will block until the client has responded, so it should 388 * generally be run in a separate thread from request processing. 389 * 390 * @param ino File's inode number 391 * @param off offset at which to begin invalidation. A 392 * negative offset means to invalidate attributes 393 * only. 394 * @param len Size of region of data to invalidate. 0 means 395 * to invalidate all cached data. 396 */ 397 int notify_inval_inode(ino_t ino, off_t off, ssize_t len); 398 399 /* 400 * Send an asynchronous notification to store data directly into an 401 * inode's cache. Similar to libfuse's fuse_lowlevel_notify_store. 402 * 403 * This method will block until the client has responded, so it should 404 * generally be run in a separate thread from request processing. 405 * 406 * @param ino File's inode number 407 * @param off Offset at which to store data 408 * @param data Pointer to the data to cache 409 * @param len Size of data 410 */ 411 int notify_store(ino_t ino, off_t off, const void* data, ssize_t size); 412 413 /* 414 * Request handler 415 * 416 * This method is expected to provide the responses to each FUSE 417 * operation. For an immediate response, push one buffer into out. 418 * For a delayed response, push nothing. For an immediate response 419 * plus a delayed response to an earlier operation, push two bufs. 420 * Test cases must define each response using Googlemock expectations 421 */ 422 MOCK_METHOD2(process, void(const mockfs_buf_in&, 423 std::vector<std::unique_ptr<mockfs_buf_out>>&)); 424 425 /* Gracefully unmount */ 426 void unmount(); 427 }; 428