2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2019 The FreeBSD Foundation
6 * This software was developed by BFF Storage Systems, LLC under sponsorship
7 * from the FreeBSD Foundation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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
32 #include <sys/types.h>
36 #include "fuse_kernel.h"
39 #include <gmock/gmock.h>
41 #define TIME_T_MAX (std::numeric_limits<time_t>::max())
44 * A pseudo-fuse errno used indicate that a fuse operation should have no
45 * response, at least not immediately
47 #define FUSE_NORESPONSE 9999
49 #define SET_OUT_HEADER_LEN(out, variant) { \
50 (out)->header.len = (sizeof((out)->header) + \
51 sizeof((out)->body.variant)); \
55 * Create an expectation on FUSE_LOOKUP and return it so the caller can set
58 * This must be a macro instead of a method because EXPECT_CALL returns a type
59 * with a deleted constructor.
61 #define EXPECT_LOOKUP(parent, path) \
62 EXPECT_CALL(*m_mock, process( \
63 ResultOf([=](auto in) { \
64 return (in->header.opcode == FUSE_LOOKUP && \
65 in->header.nodeid == (parent) && \
66 strcmp(in->body.lookup, (path)) == 0); \
73 /* This struct isn't defined by fuse_kernel.h or libfuse, but it should be */
74 struct fuse_create_out {
75 struct fuse_entry_out entry;
76 struct fuse_open_out open;
79 union fuse_payloads_in {
80 fuse_access_in access;
81 /* value is from fuse_kern_chan.c in fusefs-libs */
82 uint8_t bytes[0x21000 - sizeof(struct fuse_in_header)];
85 fuse_fsync_in fsyncdir;
86 fuse_forget_in forget;
87 fuse_interrupt_in interrupt;
89 fuse_getxattr_in getxattr;
92 fuse_listxattr_in listxattr;
100 fuse_release_in release;
101 fuse_release_in releasedir;
102 fuse_rename_in rename;
104 fuse_setattr_in setattr;
105 fuse_setxattr_in setxattr;
112 struct mockfs_buf_in {
113 fuse_in_header header;
114 union fuse_payloads_in body;
117 union fuse_payloads_out {
119 fuse_create_out create;
120 /* The protocol places no limits on the size of bytes */
121 uint8_t bytes[0x20000];
122 fuse_entry_out entry;
124 fuse_getxattr_out getxattr;
126 fuse_listxattr_out listxattr;
128 fuse_statfs_out statfs;
130 * The protocol places no limits on the length of the string. This is
131 * merely convenient for testing.
134 fuse_write_out write;
137 struct mockfs_buf_out {
138 fuse_out_header header;
139 union fuse_payloads_out body;
141 /* Default constructor: zero everything */
143 memset(this, 0, sizeof(*this));
147 /* A function that can be invoked in place of MockFS::process */
148 typedef std::function<void (const struct mockfs_buf_in *in,
149 std::vector<struct mockfs_buf_out*> &out)>
153 * Helper function used for setting an error expectation for any fuse operation.
154 * The operation will return the supplied error
156 ProcessMockerT ReturnErrno(int error);
158 /* Helper function used for returning negative cache entries for LOOKUP */
159 ProcessMockerT ReturnNegativeCache(const struct timespec *entry_valid);
161 /* Helper function used for returning a single immediate response */
162 ProcessMockerT ReturnImmediate(
163 std::function<void(const struct mockfs_buf_in *in,
164 struct mockfs_buf_out *out)> f);
167 * Fake FUSE filesystem
169 * "Mounts" a filesystem to a temporary directory and services requests
170 * according to the programmed expectations.
172 * Operates directly on the fusefs(4) kernel API, not the libfuse(3) user api.
176 * thread id of the fuse daemon thread
178 * It must run in a separate thread so it doesn't deadlock with the
181 pthread_t m_daemon_id;
183 /* file descriptor of /dev/fuse control device */
186 /* The max_readahead filesystem option */
187 uint32_t m_maxreadahead;
189 /* pid of the test process */
192 /* Initialize a session after mounting */
193 void init(uint32_t flags);
195 /* Is pid from a process that might be involved in the test? */
196 bool pid_ok(pid_t pid);
198 /* Default request handler */
199 void process_default(const mockfs_buf_in*,
200 std::vector<mockfs_buf_out*>&);
202 /* Entry point for the daemon thread */
203 static void* service(void*);
205 /* Read, but do not process, a single request from the kernel */
206 void read_request(mockfs_buf_in*);
209 /* pid of child process, for two-process test cases */
212 /* Maximum size of a FUSE_WRITE write */
213 uint32_t m_max_write;
215 /* Create a new mockfs and mount it to a tempdir */
216 MockFS(int max_readahead, bool allow_other,
217 bool default_permissions, bool push_symlinks_in, bool ro,
221 /* Kill the filesystem daemon without unmounting the filesystem */
224 /* Process FUSE requests endlessly */
230 * This method is expected to provide the responses to each FUSE
231 * operation. For an immediate response, push one buffer into out.
232 * For a delayed response, push nothing. For an immediate response
233 * plus a delayed response to an earlier operation, push two bufs.
234 * Test cases must define each response using Googlemock expectations
236 MOCK_METHOD2(process, void(const mockfs_buf_in*,
237 std::vector<mockfs_buf_out*>&));
239 /* Gracefully unmount */