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 class FuseTest : public ::testing::Test {
  41         protected:
  42         uint32_t m_maxreadahead;
  43         uint32_t m_init_flags;
  44         bool m_allow_other;
  45         bool m_default_permissions;
  46         bool m_push_symlinks_in;
  47         bool m_ro;
  48         MockFS *m_mock = NULL;
  49         const static uint64_t FH = 0xdeadbeef1a7ebabe;
  50
  51         public:
  52         int m_maxbcachebuf;
  53
  54         FuseTest():
  55                 /*
  56                  * libfuse's default max_readahead is UINT_MAX, though it can
  57                  * be lowered
  58                  */
  59                 m_maxreadahead(UINT_MAX),
  60                 m_init_flags(0),
  61                 m_allow_other(false),
  62                 m_default_permissions(false),
  63                 m_push_symlinks_in(false),
  64                 m_ro(false)
  65         {}
  66
  67         virtual void SetUp();
  68
  69         virtual void TearDown() {
  70                 if (m_mock)
  71                         delete m_mock;
  72         }
  73
  74         /*
  75          * Create an expectation that FUSE_ACCESS will be called once for the
  76          * given inode with the given access_mode, returning the given errno
  77          */
  78         void expect_access(uint64_t ino, mode_t access_mode, int error);
  79
  80         /*
  81          * Create an expectation that FUSE_FLUSH will be called times times for
  82          * the given inode
  83          */
  84         void expect_flush(uint64_t ino, int times, ProcessMockerT r);
  85
  86         /*
  87          * Create an expectation that FUSE_FORGET will be called for the given
  88          * inode.  There will be no response
  89          */
  90         void expect_forget(uint64_t ino, uint64_t nlookup);
  91
  92         /*
  93          * Create an expectation that FUSE_GETATTR will be called for the given
  94          * inode any number of times.  It will respond with a few basic
  95          * attributes, like the given size and the mode S_IFREG | 0644
  96          */
  97         void expect_getattr(uint64_t ino, uint64_t size);
  98
  99         /*
 100          * Create an expectation that FUSE_LOOKUP will be called for the given
 101          * path exactly times times and cache validity period.  It will respond
 102          * with inode ino, mode mode, filesize size.
 103          */
 104         void expect_lookup(const char *relpath, uint64_t ino, mode_t mode,
 105                 uint64_t size, int times, uint64_t attr_valid = UINT64_MAX,
 106                 uid_t uid = 0);
 107
 108         /*
 109          * Create an expectation that FUSE_OPEN will be called for the given
 110          * inode exactly times times.  It will return with open_flags flags and
 111          * file handle FH.
 112          */
 113         void expect_open(uint64_t ino, uint32_t flags, int times);
 114
 115         /*
 116          * Create an expectation that FUSE_OPENDIR will be called exactly once
 117          * for inode ino.
 118          */
 119         void expect_opendir(uint64_t ino);
 120
 121         /*
 122          * Create an expectation that FUSE_READ will be called exactly once for
 123          * the given inode, at offset offset and with size isize.  It will
 124          * return the first osize bytes from contents
 125          */
 126         void expect_read(uint64_t ino, uint64_t offset, uint64_t isize,
 127                 uint64_t osize, const void *contents);
 128
 129         /*
 130          * Create an expectation that FUSE_RELEASE will be called exactly once
 131          * for the given inode and filehandle, returning success
 132          */
 133         void expect_release(uint64_t ino, uint64_t fh);
 134
 135         /*
 136          * Create an expectation that FUSE_RELEASEDIR will be called exactly
 137          * once for the given inode
 138          */
 139         void expect_releasedir(uint64_t ino, ProcessMockerT r);
 140
 141         /*
 142          * Create an expectation that FUSE_UNLINK will be called exactly once
 143          * for the given path, returning an errno
 144          */
 145         void expect_unlink(uint64_t parent, const char *path, int error);
 146
 147         /*
 148          * Create an expectation that FUSE_WRITE will be called exactly once
 149          * for the given inode, at offset offset, with write_flags flags,
 150          * size isize and buffer contents.  It will return osize
 151          */
 152         void expect_write(uint64_t ino, uint64_t offset, uint64_t isize,
 153                 uint64_t osize, uint32_t flags, const void *contents);
 154
 155         /*
 156          * Helper that runs code in a child process.
 157          *
 158          * First, parent_func runs in the parent process.
 159          * Then, child_func runs in the child process, dropping privileges if
 160          * desired.
 161          * Finally, fusetest_fork returns.
 162          *
 163          * # Returns
 164          *
 165          * fusetest_fork may SKIP the test, which the caller should detect with
 166          * the IsSkipped() method.  If not, then the child's exit status will
 167          * be returned in status.
 168          */
 169         void fork(bool drop_privs, int *status,
 170                 std::function<void()> parent_func,
 171                 std::function<int()> child_func);
 172 };