tests/sys/fs/fusefs/utils.hh

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