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