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