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