xref: /freebsd/tests/sys/fs/fusefs/utils.cc (revision b0ecfb42d1705bc1423c726a16a182c81047f854)
19821f1d3SAlan Somers /*-
29821f1d3SAlan Somers  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
39821f1d3SAlan Somers  *
49821f1d3SAlan Somers  * Copyright (c) 2019 The FreeBSD Foundation
59821f1d3SAlan Somers  *
69821f1d3SAlan Somers  * This software was developed by BFF Storage Systems, LLC under sponsorship
79821f1d3SAlan Somers  * from the FreeBSD Foundation.
89821f1d3SAlan Somers  *
99821f1d3SAlan Somers  * Redistribution and use in source and binary forms, with or without
109821f1d3SAlan Somers  * modification, are permitted provided that the following conditions
119821f1d3SAlan Somers  * are met:
129821f1d3SAlan Somers  * 1. Redistributions of source code must retain the above copyright
139821f1d3SAlan Somers  *    notice, this list of conditions and the following disclaimer.
149821f1d3SAlan Somers  * 2. Redistributions in binary form must reproduce the above copyright
159821f1d3SAlan Somers  *    notice, this list of conditions and the following disclaimer in the
169821f1d3SAlan Somers  *    documentation and/or other materials provided with the distribution.
179821f1d3SAlan Somers  *
189821f1d3SAlan Somers  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
199821f1d3SAlan Somers  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
209821f1d3SAlan Somers  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
219821f1d3SAlan Somers  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
229821f1d3SAlan Somers  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
239821f1d3SAlan Somers  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
249821f1d3SAlan Somers  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
259821f1d3SAlan Somers  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
269821f1d3SAlan Somers  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
279821f1d3SAlan Somers  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
289821f1d3SAlan Somers  * SUCH DAMAGE.
291fa8ebfbSAlan Somers  *
301fa8ebfbSAlan Somers  * $FreeBSD$
319821f1d3SAlan Somers  */
329821f1d3SAlan Somers 
3309c01e67SAlan Somers extern "C" {
349821f1d3SAlan Somers #include <sys/param.h>
3509c01e67SAlan Somers #include <sys/mman.h>
369821f1d3SAlan Somers #include <sys/module.h>
379821f1d3SAlan Somers #include <sys/sysctl.h>
3809c01e67SAlan Somers #include <sys/wait.h>
3909c01e67SAlan Somers 
40e5b50fe7SAlan Somers #include <dirent.h>
41d4fd0c81SAlan Somers #include <fcntl.h>
4261b0a927SAlan Somers #include <grp.h>
4309c01e67SAlan Somers #include <pwd.h>
4409c01e67SAlan Somers #include <semaphore.h>
4509c01e67SAlan Somers #include <unistd.h>
4609c01e67SAlan Somers }
479821f1d3SAlan Somers 
489821f1d3SAlan Somers #include <gtest/gtest.h>
499821f1d3SAlan Somers 
509821f1d3SAlan Somers #include "mockfs.hh"
519821f1d3SAlan Somers #include "utils.hh"
529821f1d3SAlan Somers 
539821f1d3SAlan Somers using namespace testing;
549821f1d3SAlan Somers 
558eecd9ceSAlan Somers /*
568eecd9ceSAlan Somers  * The default max_write is set to this formula in libfuse, though
578eecd9ceSAlan Somers  * individual filesystems can lower it.  The "- 4096" was added in
588eecd9ceSAlan Somers  * commit 154ffe2, with the commit message "fix".
598eecd9ceSAlan Somers  */
608eecd9ceSAlan Somers const uint32_t libfuse_max_write = 32 * getpagesize() + 0x1000 - 4096;
618eecd9ceSAlan Somers 
628eecd9ceSAlan Somers /*
638eecd9ceSAlan Somers  * Set the default max_write to a distinct value from MAXPHYS to catch bugs
648eecd9ceSAlan Somers  * that confuse the two.
658eecd9ceSAlan Somers  */
668eecd9ceSAlan Somers const uint32_t default_max_write = MIN(libfuse_max_write, MAXPHYS / 2);
678eecd9ceSAlan Somers 
688eecd9ceSAlan Somers 
699821f1d3SAlan Somers /* Check that fusefs(4) is accessible and the current user can mount(2) */
709821f1d3SAlan Somers void check_environment()
719821f1d3SAlan Somers {
729821f1d3SAlan Somers 	const char *devnode = "/dev/fuse";
739821f1d3SAlan Somers 	const char *usermount_node = "vfs.usermount";
749821f1d3SAlan Somers 	int usermount_val = 0;
759821f1d3SAlan Somers 	size_t usermount_size = sizeof(usermount_val);
769821f1d3SAlan Somers 	if (eaccess(devnode, R_OK | W_OK)) {
779821f1d3SAlan Somers 		if (errno == ENOENT) {
789821f1d3SAlan Somers 			GTEST_SKIP() << devnode << " does not exist";
799821f1d3SAlan Somers 		} else if (errno == EACCES) {
809821f1d3SAlan Somers 			GTEST_SKIP() << devnode <<
819821f1d3SAlan Somers 			    " is not accessible by the current user";
829821f1d3SAlan Somers 		} else {
839821f1d3SAlan Somers 			GTEST_SKIP() << strerror(errno);
849821f1d3SAlan Somers 		}
859821f1d3SAlan Somers 	}
868e765737SAlan Somers 	ASSERT_EQ(sysctlbyname(usermount_node, &usermount_val, &usermount_size,
878e765737SAlan Somers 			       NULL, 0),
888e765737SAlan Somers 		  0);;
899821f1d3SAlan Somers 	if (geteuid() != 0 && !usermount_val)
909821f1d3SAlan Somers 		GTEST_SKIP() << "current user is not allowed to mount";
919821f1d3SAlan Somers }
929821f1d3SAlan Somers 
93*b0ecfb42SAlan Somers const char *cache_mode_to_s(enum cache_mode cm) {
94*b0ecfb42SAlan Somers 	switch (cm) {
95*b0ecfb42SAlan Somers 	case Uncached:
96*b0ecfb42SAlan Somers 		return "Uncached";
97*b0ecfb42SAlan Somers 	case Writethrough:
98*b0ecfb42SAlan Somers 		return "Writethrough";
99*b0ecfb42SAlan Somers 	case Writeback:
100*b0ecfb42SAlan Somers 		return "Writeback";
101*b0ecfb42SAlan Somers 	case WritebackAsync:
102*b0ecfb42SAlan Somers 		return "WritebackAsync";
103*b0ecfb42SAlan Somers 	default:
104*b0ecfb42SAlan Somers 		return "Unknown";
105*b0ecfb42SAlan Somers 	}
106*b0ecfb42SAlan Somers }
107*b0ecfb42SAlan Somers 
108c2265ae7SAlan Somers bool is_unsafe_aio_enabled(void) {
109c2265ae7SAlan Somers 	const char *node = "vfs.aio.enable_unsafe";
110c2265ae7SAlan Somers 	int val = 0;
111c2265ae7SAlan Somers 	size_t size = sizeof(val);
112c2265ae7SAlan Somers 
113c2265ae7SAlan Somers 	if (sysctlbyname(node, &val, &size, NULL, 0)) {
114c2265ae7SAlan Somers 		perror("sysctlbyname");
115c2265ae7SAlan Somers 		return (false);
116c2265ae7SAlan Somers 	}
117c2265ae7SAlan Somers 	return (val != 0);
118c2265ae7SAlan Somers }
119c2265ae7SAlan Somers 
1209821f1d3SAlan Somers class FuseEnv: public Environment {
1219821f1d3SAlan Somers 	virtual void SetUp() {
1229821f1d3SAlan Somers 	}
1239821f1d3SAlan Somers };
1249821f1d3SAlan Somers 
1259821f1d3SAlan Somers void FuseTest::SetUp() {
126f2704f05SAlan Somers 	const char *maxbcachebuf_node = "vfs.maxbcachebuf";
127f2704f05SAlan Somers 	const char *maxphys_node = "kern.maxphys";
1289821f1d3SAlan Somers 	int val = 0;
1299821f1d3SAlan Somers 	size_t size = sizeof(val);
1309821f1d3SAlan Somers 
1319821f1d3SAlan Somers 	/*
1329821f1d3SAlan Somers 	 * XXX check_environment should be called from FuseEnv::SetUp, but
1339821f1d3SAlan Somers 	 * can't due to https://github.com/google/googletest/issues/2189
1349821f1d3SAlan Somers 	 */
1359821f1d3SAlan Somers 	check_environment();
1369821f1d3SAlan Somers 	if (IsSkipped())
1379821f1d3SAlan Somers 		return;
1389821f1d3SAlan Somers 
139f2704f05SAlan Somers 	ASSERT_EQ(0, sysctlbyname(maxbcachebuf_node, &val, &size, NULL, 0))
1409821f1d3SAlan Somers 		<< strerror(errno);
1419821f1d3SAlan Somers 	m_maxbcachebuf = val;
142f2704f05SAlan Somers 	ASSERT_EQ(0, sysctlbyname(maxphys_node, &val, &size, NULL, 0))
143f2704f05SAlan Somers 		<< strerror(errno);
144f2704f05SAlan Somers 	m_maxphys = val;
1459821f1d3SAlan Somers 
1469821f1d3SAlan Somers 	try {
14791ff3a0dSAlan Somers 		m_mock = new MockFS(m_maxreadahead, m_allow_other,
148140bb492SAlan Somers 			m_default_permissions, m_push_symlinks_in, m_ro,
1498eecd9ceSAlan Somers 			m_pm, m_init_flags, m_kernel_minor_version,
150ed74f781SAlan Somers 			m_maxwrite, m_async, m_noclusterr, m_time_gran,
151ed74f781SAlan Somers 			m_nointr);
152caf5f57dSAlan Somers 		/*
153caf5f57dSAlan Somers 		 * FUSE_ACCESS is called almost universally.  Expecting it in
154caf5f57dSAlan Somers 		 * each test case would be super-annoying.  Instead, set a
155caf5f57dSAlan Somers 		 * default expectation for FUSE_ACCESS and return ENOSYS.
156caf5f57dSAlan Somers 		 *
157caf5f57dSAlan Somers 		 * Individual test cases can override this expectation since
158caf5f57dSAlan Somers 		 * googlemock evaluates expectations in LIFO order.
159caf5f57dSAlan Somers 		 */
160caf5f57dSAlan Somers 		EXPECT_CALL(*m_mock, process(
161caf5f57dSAlan Somers 			ResultOf([=](auto in) {
16229edc611SAlan Somers 				return (in.header.opcode == FUSE_ACCESS);
163caf5f57dSAlan Somers 			}, Eq(true)),
164caf5f57dSAlan Somers 			_)
165caf5f57dSAlan Somers 		).Times(AnyNumber())
166caf5f57dSAlan Somers 		.WillRepeatedly(Invoke(ReturnErrno(ENOSYS)));
167a1c9f4adSAlan Somers 		/*
168a1c9f4adSAlan Somers 		 * FUSE_BMAP is called for most test cases that read data.  Set
169a1c9f4adSAlan Somers 		 * a default expectation and return ENOSYS.
170a1c9f4adSAlan Somers 		 *
171a1c9f4adSAlan Somers 		 * Individual test cases can override this expectation since
172a1c9f4adSAlan Somers 		 * googlemock evaluates expectations in LIFO order.
173a1c9f4adSAlan Somers 		 */
174a1c9f4adSAlan Somers 		EXPECT_CALL(*m_mock, process(
175a1c9f4adSAlan Somers 			ResultOf([=](auto in) {
176a1c9f4adSAlan Somers 				return (in.header.opcode == FUSE_BMAP);
177a1c9f4adSAlan Somers 			}, Eq(true)),
178a1c9f4adSAlan Somers 			_)
179a1c9f4adSAlan Somers 		).Times(AnyNumber())
180a1c9f4adSAlan Somers 		.WillRepeatedly(Invoke(ReturnErrno(ENOSYS)));
1819821f1d3SAlan Somers 	} catch (std::system_error err) {
1829821f1d3SAlan Somers 		FAIL() << err.what();
1839821f1d3SAlan Somers 	}
1849821f1d3SAlan Somers }
1859821f1d3SAlan Somers 
18691ff3a0dSAlan Somers void
18791ff3a0dSAlan Somers FuseTest::expect_access(uint64_t ino, mode_t access_mode, int error)
18891ff3a0dSAlan Somers {
18991ff3a0dSAlan Somers 	EXPECT_CALL(*m_mock, process(
19091ff3a0dSAlan Somers 		ResultOf([=](auto in) {
19129edc611SAlan Somers 			return (in.header.opcode == FUSE_ACCESS &&
19229edc611SAlan Somers 				in.header.nodeid == ino &&
19329edc611SAlan Somers 				in.body.access.mask == access_mode);
19491ff3a0dSAlan Somers 		}, Eq(true)),
19591ff3a0dSAlan Somers 		_)
19691ff3a0dSAlan Somers 	).WillOnce(Invoke(ReturnErrno(error)));
19791ff3a0dSAlan Somers }
19891ff3a0dSAlan Somers 
1999f10f423SAlan Somers void
2003429092cSAlan Somers FuseTest::expect_destroy(int error)
2013429092cSAlan Somers {
2023429092cSAlan Somers 	EXPECT_CALL(*m_mock, process(
2033429092cSAlan Somers 		ResultOf([=](auto in) {
20429edc611SAlan Somers 			return (in.header.opcode == FUSE_DESTROY);
2053429092cSAlan Somers 		}, Eq(true)),
2063429092cSAlan Somers 		_)
20729edc611SAlan Somers 	).WillOnce(Invoke( ReturnImmediate([&](auto in, auto& out) {
2083429092cSAlan Somers 		m_mock->m_quit = true;
20929edc611SAlan Somers 		out.header.len = sizeof(out.header);
21029edc611SAlan Somers 		out.header.unique = in.header.unique;
21129edc611SAlan Somers 		out.header.error = -error;
2123429092cSAlan Somers 	})));
2133429092cSAlan Somers }
2143429092cSAlan Somers 
2153429092cSAlan Somers void
2169f10f423SAlan Somers FuseTest::expect_flush(uint64_t ino, int times, ProcessMockerT r)
2179f10f423SAlan Somers {
2189f10f423SAlan Somers 	EXPECT_CALL(*m_mock, process(
2199f10f423SAlan Somers 		ResultOf([=](auto in) {
22029edc611SAlan Somers 			return (in.header.opcode == FUSE_FLUSH &&
22129edc611SAlan Somers 				in.header.nodeid == ino);
2229f10f423SAlan Somers 		}, Eq(true)),
2239f10f423SAlan Somers 		_)
2249f10f423SAlan Somers 	).Times(times)
2259f10f423SAlan Somers 	.WillRepeatedly(Invoke(r));
2269f10f423SAlan Somers }
2279f10f423SAlan Somers 
228ff4fbdf5SAlan Somers void
2292d6bf515SAlan Somers FuseTest::expect_forget(uint64_t ino, uint64_t nlookup, sem_t *sem)
230ff4fbdf5SAlan Somers {
231ff4fbdf5SAlan Somers 	EXPECT_CALL(*m_mock, process(
232ff4fbdf5SAlan Somers 		ResultOf([=](auto in) {
23329edc611SAlan Somers 			return (in.header.opcode == FUSE_FORGET &&
23429edc611SAlan Somers 				in.header.nodeid == ino &&
23529edc611SAlan Somers 				in.body.forget.nlookup == nlookup);
236ff4fbdf5SAlan Somers 		}, Eq(true)),
237ff4fbdf5SAlan Somers 		_)
2382d6bf515SAlan Somers 	).WillOnce(Invoke([=](auto in __unused, auto &out __unused) {
2392d6bf515SAlan Somers 		if (sem != NULL)
2402d6bf515SAlan Somers 			sem_post(sem);
241ff4fbdf5SAlan Somers 		/* FUSE_FORGET has no response! */
242ff4fbdf5SAlan Somers 	}));
243ff4fbdf5SAlan Somers }
244ff4fbdf5SAlan Somers 
2459821f1d3SAlan Somers void FuseTest::expect_getattr(uint64_t ino, uint64_t size)
2469821f1d3SAlan Somers {
2479821f1d3SAlan Somers 	EXPECT_CALL(*m_mock, process(
2489821f1d3SAlan Somers 		ResultOf([=](auto in) {
24929edc611SAlan Somers 			return (in.header.opcode == FUSE_GETATTR &&
25029edc611SAlan Somers 				in.header.nodeid == ino);
2519821f1d3SAlan Somers 		}, Eq(true)),
2529821f1d3SAlan Somers 		_)
25329edc611SAlan Somers 	).WillOnce(Invoke(ReturnImmediate([=](auto i __unused, auto& out) {
2549821f1d3SAlan Somers 		SET_OUT_HEADER_LEN(out, attr);
25529edc611SAlan Somers 		out.body.attr.attr.ino = ino;	// Must match nodeid
25629edc611SAlan Somers 		out.body.attr.attr.mode = S_IFREG | 0644;
25729edc611SAlan Somers 		out.body.attr.attr.size = size;
25829edc611SAlan Somers 		out.body.attr.attr_valid = UINT64_MAX;
2599821f1d3SAlan Somers 	})));
2609821f1d3SAlan Somers }
2619821f1d3SAlan Somers 
2629821f1d3SAlan Somers void FuseTest::expect_lookup(const char *relpath, uint64_t ino, mode_t mode,
263474ba6faSAlan Somers 	uint64_t size, int times, uint64_t attr_valid, uid_t uid, gid_t gid)
2649821f1d3SAlan Somers {
265a34cdd26SAlan Somers 	EXPECT_LOOKUP(FUSE_ROOT_ID, relpath)
2669821f1d3SAlan Somers 	.Times(times)
26729edc611SAlan Somers 	.WillRepeatedly(Invoke(
26829edc611SAlan Somers 		ReturnImmediate([=](auto in __unused, auto& out) {
2699821f1d3SAlan Somers 		SET_OUT_HEADER_LEN(out, entry);
27029edc611SAlan Somers 		out.body.entry.attr.mode = mode;
27129edc611SAlan Somers 		out.body.entry.nodeid = ino;
27229edc611SAlan Somers 		out.body.entry.attr.nlink = 1;
27329edc611SAlan Somers 		out.body.entry.attr_valid = attr_valid;
27429edc611SAlan Somers 		out.body.entry.attr.size = size;
27529edc611SAlan Somers 		out.body.entry.attr.uid = uid;
27629edc611SAlan Somers 		out.body.entry.attr.gid = gid;
2779821f1d3SAlan Somers 	})));
2789821f1d3SAlan Somers }
2799821f1d3SAlan Somers 
28016bd2d47SAlan Somers void FuseTest::expect_lookup_7_8(const char *relpath, uint64_t ino, mode_t mode,
28116bd2d47SAlan Somers 	uint64_t size, int times, uint64_t attr_valid, uid_t uid, gid_t gid)
28216bd2d47SAlan Somers {
283a34cdd26SAlan Somers 	EXPECT_LOOKUP(FUSE_ROOT_ID, relpath)
28416bd2d47SAlan Somers 	.Times(times)
28529edc611SAlan Somers 	.WillRepeatedly(Invoke(
28629edc611SAlan Somers 		ReturnImmediate([=](auto in __unused, auto& out) {
28716bd2d47SAlan Somers 		SET_OUT_HEADER_LEN(out, entry_7_8);
28829edc611SAlan Somers 		out.body.entry.attr.mode = mode;
28929edc611SAlan Somers 		out.body.entry.nodeid = ino;
29029edc611SAlan Somers 		out.body.entry.attr.nlink = 1;
29129edc611SAlan Somers 		out.body.entry.attr_valid = attr_valid;
29229edc611SAlan Somers 		out.body.entry.attr.size = size;
29329edc611SAlan Somers 		out.body.entry.attr.uid = uid;
29429edc611SAlan Somers 		out.body.entry.attr.gid = gid;
29516bd2d47SAlan Somers 	})));
29616bd2d47SAlan Somers }
29716bd2d47SAlan Somers 
2989821f1d3SAlan Somers void FuseTest::expect_open(uint64_t ino, uint32_t flags, int times)
2999821f1d3SAlan Somers {
3009821f1d3SAlan Somers 	EXPECT_CALL(*m_mock, process(
3019821f1d3SAlan Somers 		ResultOf([=](auto in) {
30229edc611SAlan Somers 			return (in.header.opcode == FUSE_OPEN &&
30329edc611SAlan Somers 				in.header.nodeid == ino);
3049821f1d3SAlan Somers 		}, Eq(true)),
3059821f1d3SAlan Somers 		_)
3069821f1d3SAlan Somers 	).Times(times)
30729edc611SAlan Somers 	.WillRepeatedly(Invoke(
30829edc611SAlan Somers 		ReturnImmediate([=](auto in __unused, auto& out) {
30929edc611SAlan Somers 		out.header.len = sizeof(out.header);
3109821f1d3SAlan Somers 		SET_OUT_HEADER_LEN(out, open);
31129edc611SAlan Somers 		out.body.open.fh = FH;
31229edc611SAlan Somers 		out.body.open.open_flags = flags;
3139821f1d3SAlan Somers 	})));
3149821f1d3SAlan Somers }
3159821f1d3SAlan Somers 
3169821f1d3SAlan Somers void FuseTest::expect_opendir(uint64_t ino)
3179821f1d3SAlan Somers {
318363a7416SAlan Somers 	/* opendir(3) calls fstatfs */
3199821f1d3SAlan Somers 	EXPECT_CALL(*m_mock, process(
3209821f1d3SAlan Somers 		ResultOf([](auto in) {
32129edc611SAlan Somers 			return (in.header.opcode == FUSE_STATFS);
3229821f1d3SAlan Somers 		}, Eq(true)),
3239821f1d3SAlan Somers 		_)
32429edc611SAlan Somers 	).WillRepeatedly(Invoke(
32529edc611SAlan Somers 	ReturnImmediate([=](auto i __unused, auto& out) {
3269821f1d3SAlan Somers 		SET_OUT_HEADER_LEN(out, statfs);
3279821f1d3SAlan Somers 	})));
3289821f1d3SAlan Somers 
3299821f1d3SAlan Somers 	EXPECT_CALL(*m_mock, process(
3309821f1d3SAlan Somers 		ResultOf([=](auto in) {
33129edc611SAlan Somers 			return (in.header.opcode == FUSE_OPENDIR &&
33229edc611SAlan Somers 				in.header.nodeid == ino);
3339821f1d3SAlan Somers 		}, Eq(true)),
3349821f1d3SAlan Somers 		_)
33529edc611SAlan Somers 	).WillOnce(Invoke(ReturnImmediate([=](auto in __unused, auto& out) {
33629edc611SAlan Somers 		out.header.len = sizeof(out.header);
3379821f1d3SAlan Somers 		SET_OUT_HEADER_LEN(out, open);
33829edc611SAlan Somers 		out.body.open.fh = FH;
3399821f1d3SAlan Somers 	})));
3409821f1d3SAlan Somers }
3419821f1d3SAlan Somers 
3429821f1d3SAlan Somers void FuseTest::expect_read(uint64_t ino, uint64_t offset, uint64_t isize,
343d4fd0c81SAlan Somers 	uint64_t osize, const void *contents, int flags)
3449821f1d3SAlan Somers {
3459821f1d3SAlan Somers 	EXPECT_CALL(*m_mock, process(
3469821f1d3SAlan Somers 		ResultOf([=](auto in) {
34729edc611SAlan Somers 			return (in.header.opcode == FUSE_READ &&
34829edc611SAlan Somers 				in.header.nodeid == ino &&
34929edc611SAlan Somers 				in.body.read.fh == FH &&
35029edc611SAlan Somers 				in.body.read.offset == offset &&
351d4fd0c81SAlan Somers 				in.body.read.size == isize &&
352d4fd0c81SAlan Somers 				flags == -1 ?
353d4fd0c81SAlan Somers 					(in.body.read.flags == O_RDONLY ||
354d4fd0c81SAlan Somers 					 in.body.read.flags == O_RDWR)
355d4fd0c81SAlan Somers 				: in.body.read.flags == (uint32_t)flags);
3569821f1d3SAlan Somers 		}, Eq(true)),
3579821f1d3SAlan Somers 		_)
35829edc611SAlan Somers 	).WillOnce(Invoke(ReturnImmediate([=](auto in __unused, auto& out) {
35929edc611SAlan Somers 		out.header.len = sizeof(struct fuse_out_header) + osize;
36029edc611SAlan Somers 		memmove(out.body.bytes, contents, osize);
3619821f1d3SAlan Somers 	}))).RetiresOnSaturation();
3629821f1d3SAlan Somers }
3639821f1d3SAlan Somers 
364e5b50fe7SAlan Somers void FuseTest::expect_readdir(uint64_t ino, uint64_t off,
365e5b50fe7SAlan Somers 	std::vector<struct dirent> &ents)
366e5b50fe7SAlan Somers {
367e5b50fe7SAlan Somers 	EXPECT_CALL(*m_mock, process(
368e5b50fe7SAlan Somers 		ResultOf([=](auto in) {
36929edc611SAlan Somers 			return (in.header.opcode == FUSE_READDIR &&
37029edc611SAlan Somers 				in.header.nodeid == ino &&
37129edc611SAlan Somers 				in.body.readdir.fh == FH &&
37229edc611SAlan Somers 				in.body.readdir.offset == off);
373e5b50fe7SAlan Somers 		}, Eq(true)),
374e5b50fe7SAlan Somers 		_)
37529edc611SAlan Somers 	).WillRepeatedly(Invoke(ReturnImmediate([=](auto in, auto& out) {
37629edc611SAlan Somers 		struct fuse_dirent *fde = (struct fuse_dirent*)&(out.body);
377e5b50fe7SAlan Somers 		int i = 0;
378e5b50fe7SAlan Somers 
37929edc611SAlan Somers 		out.header.error = 0;
38029edc611SAlan Somers 		out.header.len = 0;
381e5b50fe7SAlan Somers 
382e5b50fe7SAlan Somers 		for (const auto& it: ents) {
383e5b50fe7SAlan Somers 			size_t entlen, entsize;
384e5b50fe7SAlan Somers 
385e5b50fe7SAlan Somers 			fde->ino = it.d_fileno;
386e5b50fe7SAlan Somers 			fde->off = it.d_off;
387e5b50fe7SAlan Somers 			fde->type = it.d_type;
388e5b50fe7SAlan Somers 			fde->namelen = it.d_namlen;
389e5b50fe7SAlan Somers 			strncpy(fde->name, it.d_name, it.d_namlen);
390e5b50fe7SAlan Somers 			entlen = FUSE_NAME_OFFSET + fde->namelen;
391e5b50fe7SAlan Somers 			entsize = FUSE_DIRENT_SIZE(fde);
392e5b50fe7SAlan Somers 			/*
393e5b50fe7SAlan Somers 			 * The FUSE protocol does not require zeroing out the
394e5b50fe7SAlan Somers 			 * unused portion of the name.  But it's a good
395e5b50fe7SAlan Somers 			 * practice to prevent information disclosure to the
396e5b50fe7SAlan Somers 			 * FUSE client, even though the client is usually the
397e5b50fe7SAlan Somers 			 * kernel
398e5b50fe7SAlan Somers 			 */
399e5b50fe7SAlan Somers 			memset(fde->name + fde->namelen, 0, entsize - entlen);
40029edc611SAlan Somers 			if (out.header.len + entsize > in.body.read.size) {
401e5b50fe7SAlan Somers 				printf("Overflow in readdir expectation: i=%d\n"
402e5b50fe7SAlan Somers 					, i);
403e5b50fe7SAlan Somers 				break;
404e5b50fe7SAlan Somers 			}
40529edc611SAlan Somers 			out.header.len += entsize;
406e5b50fe7SAlan Somers 			fde = (struct fuse_dirent*)
407b7774b82SAlan Somers 				((intmax_t*)fde + entsize / sizeof(intmax_t));
408e5b50fe7SAlan Somers 			i++;
409e5b50fe7SAlan Somers 		}
41029edc611SAlan Somers 		out.header.len += sizeof(out.header);
411e5b50fe7SAlan Somers 	})));
412e5b50fe7SAlan Somers 
413e5b50fe7SAlan Somers }
41442d50d16SAlan Somers void FuseTest::expect_release(uint64_t ino, uint64_t fh)
4159821f1d3SAlan Somers {
4169821f1d3SAlan Somers 	EXPECT_CALL(*m_mock, process(
4179821f1d3SAlan Somers 		ResultOf([=](auto in) {
41829edc611SAlan Somers 			return (in.header.opcode == FUSE_RELEASE &&
41929edc611SAlan Somers 				in.header.nodeid == ino &&
42029edc611SAlan Somers 				in.body.release.fh == fh);
4219821f1d3SAlan Somers 		}, Eq(true)),
4229821f1d3SAlan Somers 		_)
423e0bec057SAlan Somers 	).WillOnce(Invoke(ReturnErrno(0)));
4249821f1d3SAlan Somers }
425e0bec057SAlan Somers 
42635cf0e7eSAlan Somers void FuseTest::expect_releasedir(uint64_t ino, ProcessMockerT r)
42735cf0e7eSAlan Somers {
42835cf0e7eSAlan Somers 	EXPECT_CALL(*m_mock, process(
42935cf0e7eSAlan Somers 		ResultOf([=](auto in) {
43029edc611SAlan Somers 			return (in.header.opcode == FUSE_RELEASEDIR &&
43129edc611SAlan Somers 				in.header.nodeid == ino &&
43229edc611SAlan Somers 				in.body.release.fh == FH);
43335cf0e7eSAlan Somers 		}, Eq(true)),
43435cf0e7eSAlan Somers 		_)
43535cf0e7eSAlan Somers 	).WillOnce(Invoke(r));
43635cf0e7eSAlan Somers }
43735cf0e7eSAlan Somers 
438ff4fbdf5SAlan Somers void FuseTest::expect_unlink(uint64_t parent, const char *path, int error)
439ff4fbdf5SAlan Somers {
440ff4fbdf5SAlan Somers 	EXPECT_CALL(*m_mock, process(
441ff4fbdf5SAlan Somers 		ResultOf([=](auto in) {
44229edc611SAlan Somers 			return (in.header.opcode == FUSE_UNLINK &&
44329edc611SAlan Somers 				0 == strcmp(path, in.body.unlink) &&
44429edc611SAlan Somers 				in.header.nodeid == parent);
445ff4fbdf5SAlan Somers 		}, Eq(true)),
446ff4fbdf5SAlan Somers 		_)
447ff4fbdf5SAlan Somers 	).WillOnce(Invoke(ReturnErrno(error)));
448ff4fbdf5SAlan Somers }
449ff4fbdf5SAlan Somers 
4509821f1d3SAlan Somers void FuseTest::expect_write(uint64_t ino, uint64_t offset, uint64_t isize,
451bda39894SAlan Somers 	uint64_t osize, uint32_t flags_set, uint32_t flags_unset,
452bda39894SAlan Somers 	const void *contents)
4539821f1d3SAlan Somers {
4549821f1d3SAlan Somers 	EXPECT_CALL(*m_mock, process(
4559821f1d3SAlan Somers 		ResultOf([=](auto in) {
45629edc611SAlan Somers 			const char *buf = (const char*)in.body.bytes +
4579821f1d3SAlan Somers 				sizeof(struct fuse_write_in);
4589821f1d3SAlan Somers 			bool pid_ok;
459bda39894SAlan Somers 			uint32_t wf = in.body.write.write_flags;
4609821f1d3SAlan Somers 
461bda39894SAlan Somers 			if (wf & FUSE_WRITE_CACHE)
4629821f1d3SAlan Somers 				pid_ok = true;
4639821f1d3SAlan Somers 			else
46429edc611SAlan Somers 				pid_ok = (pid_t)in.header.pid == getpid();
4659821f1d3SAlan Somers 
46629edc611SAlan Somers 			return (in.header.opcode == FUSE_WRITE &&
46729edc611SAlan Somers 				in.header.nodeid == ino &&
46829edc611SAlan Somers 				in.body.write.fh == FH &&
46929edc611SAlan Somers 				in.body.write.offset == offset  &&
47029edc611SAlan Somers 				in.body.write.size == isize &&
4719821f1d3SAlan Somers 				pid_ok &&
472bda39894SAlan Somers 				(wf & flags_set) == flags_set &&
473bda39894SAlan Somers 				(wf & flags_unset) == 0 &&
474d4fd0c81SAlan Somers 				(in.body.write.flags == O_WRONLY ||
475d4fd0c81SAlan Somers 				 in.body.write.flags == O_RDWR) &&
4769821f1d3SAlan Somers 				0 == bcmp(buf, contents, isize));
4779821f1d3SAlan Somers 		}, Eq(true)),
4789821f1d3SAlan Somers 		_)
47929edc611SAlan Somers 	).WillOnce(Invoke(ReturnImmediate([=](auto in __unused, auto& out) {
4809821f1d3SAlan Somers 		SET_OUT_HEADER_LEN(out, write);
48129edc611SAlan Somers 		out.body.write.size = osize;
4829821f1d3SAlan Somers 	})));
4839821f1d3SAlan Somers }
4849821f1d3SAlan Somers 
48516bd2d47SAlan Somers void FuseTest::expect_write_7_8(uint64_t ino, uint64_t offset, uint64_t isize,
486bda39894SAlan Somers 	uint64_t osize, const void *contents)
48716bd2d47SAlan Somers {
48816bd2d47SAlan Somers 	EXPECT_CALL(*m_mock, process(
48916bd2d47SAlan Somers 		ResultOf([=](auto in) {
49029edc611SAlan Somers 			const char *buf = (const char*)in.body.bytes +
49116bd2d47SAlan Somers 				FUSE_COMPAT_WRITE_IN_SIZE;
49229edc611SAlan Somers 			bool pid_ok = (pid_t)in.header.pid == getpid();
49329edc611SAlan Somers 			return (in.header.opcode == FUSE_WRITE &&
49429edc611SAlan Somers 				in.header.nodeid == ino &&
49529edc611SAlan Somers 				in.body.write.fh == FH &&
49629edc611SAlan Somers 				in.body.write.offset == offset  &&
49729edc611SAlan Somers 				in.body.write.size == isize &&
49816bd2d47SAlan Somers 				pid_ok &&
49916bd2d47SAlan Somers 				0 == bcmp(buf, contents, isize));
50016bd2d47SAlan Somers 		}, Eq(true)),
50116bd2d47SAlan Somers 		_)
50229edc611SAlan Somers 	).WillOnce(Invoke(ReturnImmediate([=](auto in __unused, auto& out) {
50316bd2d47SAlan Somers 		SET_OUT_HEADER_LEN(out, write);
50429edc611SAlan Somers 		out.body.write.size = osize;
50516bd2d47SAlan Somers 	})));
50616bd2d47SAlan Somers }
50716bd2d47SAlan Somers 
50861b0a927SAlan Somers void
50961b0a927SAlan Somers get_unprivileged_id(uid_t *uid, gid_t *gid)
51009c01e67SAlan Somers {
51109c01e67SAlan Somers 	struct passwd *pw;
51261b0a927SAlan Somers 	struct group *gr;
51309c01e67SAlan Somers 
51409c01e67SAlan Somers 	/*
51509c01e67SAlan Somers 	 * First try "tests", Kyua's default unprivileged user.  XXX after
51609c01e67SAlan Somers 	 * GoogleTest gains a proper Kyua wrapper, get this with the Kyua API
51709c01e67SAlan Somers 	 */
51809c01e67SAlan Somers 	pw = getpwnam("tests");
51909c01e67SAlan Somers 	if (pw == NULL) {
52009c01e67SAlan Somers 		/* Fall back to "nobody" */
52109c01e67SAlan Somers 		pw = getpwnam("nobody");
52209c01e67SAlan Somers 	}
52309c01e67SAlan Somers 	if (pw == NULL)
52409c01e67SAlan Somers 		GTEST_SKIP() << "Test requires an unprivileged user";
52561b0a927SAlan Somers 	/* Use group "nobody", which is Kyua's default unprivileged group */
52661b0a927SAlan Somers 	gr = getgrnam("nobody");
52761b0a927SAlan Somers 	if (gr == NULL)
52861b0a927SAlan Somers 		GTEST_SKIP() << "Test requires an unprivileged group";
52909c01e67SAlan Somers 	*uid = pw->pw_uid;
53061b0a927SAlan Somers 	*gid = gr->gr_gid;
53109c01e67SAlan Somers }
53209c01e67SAlan Somers 
53309c01e67SAlan Somers void
534a1542146SAlan Somers FuseTest::fork(bool drop_privs, int *child_status,
535a1542146SAlan Somers 	std::function<void()> parent_func,
53609c01e67SAlan Somers 	std::function<int()> child_func)
53709c01e67SAlan Somers {
53809c01e67SAlan Somers 	sem_t *sem;
53909c01e67SAlan Somers 	int mprot = PROT_READ | PROT_WRITE;
54009c01e67SAlan Somers 	int mflags = MAP_ANON | MAP_SHARED;
54109c01e67SAlan Somers 	pid_t child;
54209c01e67SAlan Somers 	uid_t uid;
54361b0a927SAlan Somers 	gid_t gid;
54409c01e67SAlan Somers 
54509c01e67SAlan Somers 	if (drop_privs) {
54661b0a927SAlan Somers 		get_unprivileged_id(&uid, &gid);
54709c01e67SAlan Somers 		if (IsSkipped())
54809c01e67SAlan Somers 			return;
54909c01e67SAlan Somers 	}
55009c01e67SAlan Somers 
55109c01e67SAlan Somers 	sem = (sem_t*)mmap(NULL, sizeof(*sem), mprot, mflags, -1, 0);
55209c01e67SAlan Somers 	ASSERT_NE(MAP_FAILED, sem) << strerror(errno);
55309c01e67SAlan Somers 	ASSERT_EQ(0, sem_init(sem, 1, 0)) << strerror(errno);
55409c01e67SAlan Somers 
55509c01e67SAlan Somers 	if ((child = ::fork()) == 0) {
55609c01e67SAlan Somers 		/* In child */
55709c01e67SAlan Somers 		int err = 0;
55809c01e67SAlan Somers 
55909c01e67SAlan Somers 		if (sem_wait(sem)) {
56009c01e67SAlan Somers 			perror("sem_wait");
56109c01e67SAlan Somers 			err = 1;
56209c01e67SAlan Somers 			goto out;
56309c01e67SAlan Somers 		}
56409c01e67SAlan Somers 
56561b0a927SAlan Somers 		if (drop_privs && 0 != setegid(gid)) {
56661b0a927SAlan Somers 			perror("setegid");
56761b0a927SAlan Somers 			err = 1;
56861b0a927SAlan Somers 			goto out;
56961b0a927SAlan Somers 		}
57009c01e67SAlan Somers 		if (drop_privs && 0 != setreuid(-1, uid)) {
57109c01e67SAlan Somers 			perror("setreuid");
57209c01e67SAlan Somers 			err = 1;
57309c01e67SAlan Somers 			goto out;
57409c01e67SAlan Somers 		}
57509c01e67SAlan Somers 		err = child_func();
57609c01e67SAlan Somers 
57709c01e67SAlan Somers out:
57809c01e67SAlan Somers 		sem_destroy(sem);
57909c01e67SAlan Somers 		_exit(err);
58009c01e67SAlan Somers 	} else if (child > 0) {
58109c01e67SAlan Somers 		/*
58209c01e67SAlan Somers 		 * In parent.  Cleanup must happen here, because it's still
58309c01e67SAlan Somers 		 * privileged.
58409c01e67SAlan Somers 		 */
58509c01e67SAlan Somers 		m_mock->m_child_pid = child;
58609c01e67SAlan Somers 		ASSERT_NO_FATAL_FAILURE(parent_func());
58709c01e67SAlan Somers 
58809c01e67SAlan Somers 		/* Signal the child process to go */
58909c01e67SAlan Somers 		ASSERT_EQ(0, sem_post(sem)) << strerror(errno);
59009c01e67SAlan Somers 
591a1542146SAlan Somers 		ASSERT_LE(0, wait(child_status)) << strerror(errno);
59209c01e67SAlan Somers 	} else {
59309c01e67SAlan Somers 		FAIL() << strerror(errno);
59409c01e67SAlan Somers 	}
59509c01e67SAlan Somers 	munmap(sem, sizeof(*sem));
596a1542146SAlan Somers 	return;
59709c01e67SAlan Somers }
59809c01e67SAlan Somers 
5999821f1d3SAlan Somers static void usage(char* progname) {
6009821f1d3SAlan Somers 	fprintf(stderr, "Usage: %s [-v]\n\t-v increase verbosity\n", progname);
6019821f1d3SAlan Somers 	exit(2);
6029821f1d3SAlan Somers }
6039821f1d3SAlan Somers 
6049821f1d3SAlan Somers int main(int argc, char **argv) {
6059821f1d3SAlan Somers 	int ch;
6069821f1d3SAlan Somers 	FuseEnv *fuse_env = new FuseEnv;
6079821f1d3SAlan Somers 
6089821f1d3SAlan Somers 	InitGoogleTest(&argc, argv);
6099821f1d3SAlan Somers 	AddGlobalTestEnvironment(fuse_env);
6109821f1d3SAlan Somers 
6119821f1d3SAlan Somers 	while ((ch = getopt(argc, argv, "v")) != -1) {
6129821f1d3SAlan Somers 		switch (ch) {
6139821f1d3SAlan Somers 			case 'v':
6149821f1d3SAlan Somers 				verbosity++;
6159821f1d3SAlan Somers 				break;
6169821f1d3SAlan Somers 			default:
6179821f1d3SAlan Somers 				usage(argv[0]);
6189821f1d3SAlan Somers 				break;
6199821f1d3SAlan Somers 		}
6209821f1d3SAlan Somers 	}
6219821f1d3SAlan Somers 
6229821f1d3SAlan Somers 	return (RUN_ALL_TESTS());
6239821f1d3SAlan Somers }
624