xref: /freebsd/tests/sys/fs/fusefs/open.cc (revision a154214620e341704be58566f85516b6b6b5bcf8)
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.
299821f1d3SAlan Somers  */
309821f1d3SAlan Somers 
319821f1d3SAlan Somers extern "C" {
32*a1542146SAlan Somers #include <sys/wait.h>
339821f1d3SAlan Somers #include <fcntl.h>
349821f1d3SAlan Somers }
359821f1d3SAlan Somers 
369821f1d3SAlan Somers #include "mockfs.hh"
379821f1d3SAlan Somers #include "utils.hh"
389821f1d3SAlan Somers 
399821f1d3SAlan Somers using namespace testing;
409821f1d3SAlan Somers 
419821f1d3SAlan Somers class Open: public FuseTest {
429821f1d3SAlan Somers 
439821f1d3SAlan Somers public:
449821f1d3SAlan Somers 
459821f1d3SAlan Somers /* Test an OK open of a file with the given flags */
469821f1d3SAlan Somers void test_ok(int os_flags, int fuse_flags) {
479821f1d3SAlan Somers 	const char FULLPATH[] = "mountpoint/some_file.txt";
489821f1d3SAlan Somers 	const char RELPATH[] = "some_file.txt";
499821f1d3SAlan Somers 	uint64_t ino = 42;
509821f1d3SAlan Somers 	int fd;
519821f1d3SAlan Somers 
529821f1d3SAlan Somers 	FuseTest::expect_lookup(RELPATH, ino, S_IFREG | 0644, 0, 1);
539821f1d3SAlan Somers 	EXPECT_CALL(*m_mock, process(
549821f1d3SAlan Somers 		ResultOf([=](auto in) {
559821f1d3SAlan Somers 			return (in->header.opcode == FUSE_OPEN &&
569821f1d3SAlan Somers 				in->body.open.flags == (uint32_t)fuse_flags &&
579821f1d3SAlan Somers 				in->header.nodeid == ino);
589821f1d3SAlan Somers 		}, Eq(true)),
599821f1d3SAlan Somers 		_)
609821f1d3SAlan Somers 	).WillOnce(Invoke(ReturnImmediate([](auto in __unused, auto out) {
619821f1d3SAlan Somers 		out->header.len = sizeof(out->header);
629821f1d3SAlan Somers 		SET_OUT_HEADER_LEN(out, open);
639821f1d3SAlan Somers 	})));
649821f1d3SAlan Somers 
659821f1d3SAlan Somers 	fd = open(FULLPATH, os_flags);
669821f1d3SAlan Somers 	EXPECT_LE(0, fd) << strerror(errno);
679821f1d3SAlan Somers 	/* Deliberately leak fd.  close(2) will be tested in release.cc */
689821f1d3SAlan Somers }
699821f1d3SAlan Somers };
709821f1d3SAlan Somers 
719821f1d3SAlan Somers 
729821f1d3SAlan Somers /*
73bf4d7084SAlan Somers  * fusefs(5) does not support I/O on device nodes (neither does UFS).  But it
74bf4d7084SAlan Somers  * shouldn't crash
75bf4d7084SAlan Somers  */
76bf4d7084SAlan Somers TEST_F(Open, chr)
77bf4d7084SAlan Somers {
78bf4d7084SAlan Somers 	const char FULLPATH[] = "mountpoint/zero";
79bf4d7084SAlan Somers 	const char RELPATH[] = "zero";
80bf4d7084SAlan Somers 	uint64_t ino = 42;
81bf4d7084SAlan Somers 
82bf4d7084SAlan Somers 	EXPECT_LOOKUP(1, RELPATH)
83bf4d7084SAlan Somers 	.WillRepeatedly(Invoke(ReturnImmediate([=](auto in __unused, auto out) {
84bf4d7084SAlan Somers 		SET_OUT_HEADER_LEN(out, entry);
85bf4d7084SAlan Somers 		out->body.entry.attr.mode = S_IFCHR | 0644;
86bf4d7084SAlan Somers 		out->body.entry.nodeid = ino;
87bf4d7084SAlan Somers 		out->body.entry.attr.nlink = 1;
88bf4d7084SAlan Somers 		out->body.entry.attr_valid = UINT64_MAX;
89bf4d7084SAlan Somers 		out->body.entry.attr.rdev = 44;	/* /dev/zero's rdev */
90bf4d7084SAlan Somers 	})));
91bf4d7084SAlan Somers 
92bf4d7084SAlan Somers 	ASSERT_EQ(-1, open(FULLPATH, O_RDONLY));
93bf4d7084SAlan Somers 	EXPECT_EQ(EOPNOTSUPP, errno);
94bf4d7084SAlan Somers }
95bf4d7084SAlan Somers 
96bf4d7084SAlan Somers /*
979821f1d3SAlan Somers  * The fuse daemon fails the request with enoent.  This usually indicates a
989821f1d3SAlan Somers  * race condition: some other FUSE client removed the file in between when the
999821f1d3SAlan Somers  * kernel checked for it with lookup and tried to open it
1009821f1d3SAlan Somers  */
1019821f1d3SAlan Somers TEST_F(Open, enoent)
1029821f1d3SAlan Somers {
1039821f1d3SAlan Somers 	const char FULLPATH[] = "mountpoint/some_file.txt";
1049821f1d3SAlan Somers 	const char RELPATH[] = "some_file.txt";
1059821f1d3SAlan Somers 	uint64_t ino = 42;
1069821f1d3SAlan Somers 
1079821f1d3SAlan Somers 	expect_lookup(RELPATH, ino, S_IFREG | 0644, 0, 1);
1089821f1d3SAlan Somers 	EXPECT_CALL(*m_mock, process(
1099821f1d3SAlan Somers 		ResultOf([=](auto in) {
1109821f1d3SAlan Somers 			return (in->header.opcode == FUSE_OPEN &&
1119821f1d3SAlan Somers 				in->header.nodeid == ino);
1129821f1d3SAlan Somers 		}, Eq(true)),
1139821f1d3SAlan Somers 		_)
1149821f1d3SAlan Somers 	).WillOnce(Invoke(ReturnErrno(ENOENT)));
1159821f1d3SAlan Somers 	EXPECT_NE(0, open(FULLPATH, O_RDONLY));
1169821f1d3SAlan Somers 	EXPECT_EQ(ENOENT, errno);
1179821f1d3SAlan Somers }
1189821f1d3SAlan Somers 
1199821f1d3SAlan Somers /*
1209821f1d3SAlan Somers  * The daemon is responsible for checking file permissions (unless the
1219821f1d3SAlan Somers  * default_permissions mount option was used)
1229821f1d3SAlan Somers  */
1239821f1d3SAlan Somers TEST_F(Open, eperm)
1249821f1d3SAlan Somers {
1259821f1d3SAlan Somers 	const char FULLPATH[] = "mountpoint/some_file.txt";
1269821f1d3SAlan Somers 	const char RELPATH[] = "some_file.txt";
1279821f1d3SAlan Somers 	uint64_t ino = 42;
1289821f1d3SAlan Somers 
1299821f1d3SAlan Somers 	expect_lookup(RELPATH, ino, S_IFREG | 0644, 0, 1);
1309821f1d3SAlan Somers 	EXPECT_CALL(*m_mock, process(
1319821f1d3SAlan Somers 		ResultOf([=](auto in) {
1329821f1d3SAlan Somers 			return (in->header.opcode == FUSE_OPEN &&
1339821f1d3SAlan Somers 				in->header.nodeid == ino);
1349821f1d3SAlan Somers 		}, Eq(true)),
1359821f1d3SAlan Somers 		_)
1369821f1d3SAlan Somers 	).WillOnce(Invoke(ReturnErrno(EPERM)));
1379821f1d3SAlan Somers 	EXPECT_NE(0, open(FULLPATH, O_RDONLY));
1389821f1d3SAlan Somers 	EXPECT_EQ(EPERM, errno);
1399821f1d3SAlan Somers }
1409821f1d3SAlan Somers 
141bf4d7084SAlan Somers /* fusefs(5) does not yet support I/O on fifos.  But it shouldn't crash. */
142bf4d7084SAlan Somers TEST_F(Open, fifo)
143bf4d7084SAlan Somers {
144bf4d7084SAlan Somers 	const char FULLPATH[] = "mountpoint/zero";
145bf4d7084SAlan Somers 	const char RELPATH[] = "zero";
146bf4d7084SAlan Somers 	uint64_t ino = 42;
147bf4d7084SAlan Somers 
148bf4d7084SAlan Somers 	EXPECT_LOOKUP(1, RELPATH)
149bf4d7084SAlan Somers 	.WillRepeatedly(Invoke(ReturnImmediate([=](auto in __unused, auto out) {
150bf4d7084SAlan Somers 		SET_OUT_HEADER_LEN(out, entry);
151bf4d7084SAlan Somers 		out->body.entry.attr.mode = S_IFIFO | 0644;
152bf4d7084SAlan Somers 		out->body.entry.nodeid = ino;
153bf4d7084SAlan Somers 		out->body.entry.attr.nlink = 1;
154bf4d7084SAlan Somers 		out->body.entry.attr_valid = UINT64_MAX;
155bf4d7084SAlan Somers 	})));
156bf4d7084SAlan Somers 
157bf4d7084SAlan Somers 	ASSERT_EQ(-1, open(FULLPATH, O_RDONLY));
158bf4d7084SAlan Somers 	EXPECT_EQ(EOPNOTSUPP, errno);
159bf4d7084SAlan Somers }
160bf4d7084SAlan Somers 
16142d50d16SAlan Somers /*
16242d50d16SAlan Somers  * fusefs must issue multiple FUSE_OPEN operations if clients with different
16342d50d16SAlan Somers  * credentials open the same file, even if they use the same mode.  This is
16442d50d16SAlan Somers  * necessary so that the daemon can validate each set of credentials.
16542d50d16SAlan Somers  */
166f8d4af10SAlan Somers TEST_F(Open, multiple_creds)
16742d50d16SAlan Somers {
16842d50d16SAlan Somers 	const static char FULLPATH[] = "mountpoint/some_file.txt";
16942d50d16SAlan Somers 	const static char RELPATH[] = "some_file.txt";
170*a1542146SAlan Somers 	int fd1, status;
17142d50d16SAlan Somers 	const static uint64_t ino = 42;
17242d50d16SAlan Somers 	const static uint64_t fh0 = 100, fh1 = 200;
17342d50d16SAlan Somers 
17442d50d16SAlan Somers 	/* Fork a child to open the file with different credentials */
175*a1542146SAlan Somers 	fork(false, &status, [&] {
17642d50d16SAlan Somers 
17742d50d16SAlan Somers 		expect_lookup(RELPATH, ino, S_IFREG | 0644, 0, 2);
17842d50d16SAlan Somers 		EXPECT_CALL(*m_mock, process(
17942d50d16SAlan Somers 			ResultOf([=](auto in) {
18042d50d16SAlan Somers 				return (in->header.opcode == FUSE_OPEN &&
18142d50d16SAlan Somers 					in->header.pid == (uint32_t)getpid() &&
18242d50d16SAlan Somers 					in->header.nodeid == ino);
18342d50d16SAlan Somers 			}, Eq(true)),
18442d50d16SAlan Somers 			_)
18542d50d16SAlan Somers 		).WillOnce(Invoke(
18642d50d16SAlan Somers 			ReturnImmediate([](auto in __unused, auto out) {
18742d50d16SAlan Somers 			out->body.open.fh = fh0;
18842d50d16SAlan Somers 			out->header.len = sizeof(out->header);
18942d50d16SAlan Somers 			SET_OUT_HEADER_LEN(out, open);
19042d50d16SAlan Somers 		})));
19142d50d16SAlan Somers 
19242d50d16SAlan Somers 		EXPECT_CALL(*m_mock, process(
19342d50d16SAlan Somers 			ResultOf([=](auto in) {
19442d50d16SAlan Somers 				return (in->header.opcode == FUSE_OPEN &&
19542d50d16SAlan Somers 					in->header.pid != (uint32_t)getpid() &&
19642d50d16SAlan Somers 					in->header.nodeid == ino);
19742d50d16SAlan Somers 			}, Eq(true)),
19842d50d16SAlan Somers 			_)
19942d50d16SAlan Somers 		).WillOnce(Invoke(
20042d50d16SAlan Somers 			ReturnImmediate([](auto in __unused, auto out) {
20142d50d16SAlan Somers 			out->body.open.fh = fh1;
20242d50d16SAlan Somers 			out->header.len = sizeof(out->header);
20342d50d16SAlan Somers 			SET_OUT_HEADER_LEN(out, open);
20442d50d16SAlan Somers 		})));
2059f10f423SAlan Somers 		expect_flush(ino, 2, ReturnErrno(0));
20642d50d16SAlan Somers 		expect_release(ino, fh0);
20742d50d16SAlan Somers 		expect_release(ino, fh1);
20842d50d16SAlan Somers 
20942d50d16SAlan Somers 		fd1 = open(FULLPATH, O_RDONLY);
21042d50d16SAlan Somers 		EXPECT_LE(0, fd1) << strerror(errno);
21142d50d16SAlan Somers 	}, [] {
21242d50d16SAlan Somers 		int fd0;
21342d50d16SAlan Somers 
21442d50d16SAlan Somers 		fd0 = open(FULLPATH, O_RDONLY);
21542d50d16SAlan Somers 		if (fd0 < 0) {
21642d50d16SAlan Somers 			perror("open");
21742d50d16SAlan Somers 			return(1);
21842d50d16SAlan Somers 		}
21942d50d16SAlan Somers 		return 0;
22042d50d16SAlan Somers 	}
22142d50d16SAlan Somers 	);
222*a1542146SAlan Somers 	ASSERT_EQ(0, WEXITSTATUS(status));
22342d50d16SAlan Somers 
22442d50d16SAlan Somers 	close(fd1);
22542d50d16SAlan Somers }
22642d50d16SAlan Somers 
2279821f1d3SAlan Somers /* https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=236340 */
2289821f1d3SAlan Somers TEST_F(Open, DISABLED_o_append)
2299821f1d3SAlan Somers {
2309821f1d3SAlan Somers 	test_ok(O_WRONLY | O_APPEND, O_WRONLY | O_APPEND);
2319821f1d3SAlan Somers }
2329821f1d3SAlan Somers 
2339821f1d3SAlan Somers /* The kernel is supposed to filter out this flag */
2349821f1d3SAlan Somers TEST_F(Open, o_creat)
2359821f1d3SAlan Somers {
2369821f1d3SAlan Somers 	test_ok(O_WRONLY | O_CREAT, O_WRONLY);
2379821f1d3SAlan Somers }
2389821f1d3SAlan Somers 
2399821f1d3SAlan Somers /* https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=236340 */
2409821f1d3SAlan Somers TEST_F(Open, DISABLED_o_direct)
2419821f1d3SAlan Somers {
2429821f1d3SAlan Somers 	test_ok(O_WRONLY | O_DIRECT, O_WRONLY | O_DIRECT);
2439821f1d3SAlan Somers }
2449821f1d3SAlan Somers 
2459821f1d3SAlan Somers /* The kernel is supposed to filter out this flag */
2469821f1d3SAlan Somers TEST_F(Open, o_excl)
2479821f1d3SAlan Somers {
2489821f1d3SAlan Somers 	test_ok(O_WRONLY | O_EXCL, O_WRONLY);
2499821f1d3SAlan Somers }
2509821f1d3SAlan Somers 
251363a7416SAlan Somers TEST_F(Open, o_exec)
2529821f1d3SAlan Somers {
2539821f1d3SAlan Somers 	test_ok(O_EXEC, O_EXEC);
2549821f1d3SAlan Somers }
2559821f1d3SAlan Somers 
2569821f1d3SAlan Somers /* The kernel is supposed to filter out this flag */
2579821f1d3SAlan Somers TEST_F(Open, o_noctty)
2589821f1d3SAlan Somers {
2599821f1d3SAlan Somers 	test_ok(O_WRONLY | O_NOCTTY, O_WRONLY);
2609821f1d3SAlan Somers }
2619821f1d3SAlan Somers 
2629821f1d3SAlan Somers TEST_F(Open, o_rdonly)
2639821f1d3SAlan Somers {
2649821f1d3SAlan Somers 	test_ok(O_RDONLY, O_RDONLY);
2659821f1d3SAlan Somers }
2669821f1d3SAlan Somers 
2679821f1d3SAlan Somers /* https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=236340 */
2689821f1d3SAlan Somers TEST_F(Open, DISABLED_o_trunc)
2699821f1d3SAlan Somers {
2709821f1d3SAlan Somers 	test_ok(O_WRONLY | O_TRUNC, O_WRONLY | O_TRUNC);
2719821f1d3SAlan Somers }
2729821f1d3SAlan Somers 
2739821f1d3SAlan Somers TEST_F(Open, o_wronly)
2749821f1d3SAlan Somers {
2759821f1d3SAlan Somers 	test_ok(O_WRONLY, O_WRONLY);
2769821f1d3SAlan Somers }
2779821f1d3SAlan Somers 
2789821f1d3SAlan Somers TEST_F(Open, o_rdwr)
2799821f1d3SAlan Somers {
2809821f1d3SAlan Somers 	test_ok(O_RDWR, O_RDWR);
2819821f1d3SAlan Somers }
2829821f1d3SAlan Somers 
283