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