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