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