xref: /freebsd/tests/sys/fs/fusefs/opendir.cc (revision f976241773df2260e6170317080761d1c5814fe5)
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  * $FreeBSD$
31  */
32 
33 extern "C" {
34 #include <dirent.h>
35 #include <fcntl.h>
36 }
37 
38 #include "mockfs.hh"
39 #include "utils.hh"
40 
41 using namespace testing;
42 
43 class Opendir: public FuseTest {
44 public:
45 void expect_lookup(const char *relpath, uint64_t ino)
46 {
47 	FuseTest::expect_lookup(relpath, ino, S_IFDIR | 0755, 0, 1);
48 }
49 
50 void expect_opendir(uint64_t ino, uint32_t flags, ProcessMockerT r)
51 {
52 	/* opendir(3) calls fstatfs */
53 	EXPECT_CALL(*m_mock, process(
54 		ResultOf([](auto in) {
55 			return (in.header.opcode == FUSE_STATFS);
56 		}, Eq(true)),
57 		_)
58 	).WillRepeatedly(Invoke(ReturnImmediate([=](auto i __unused, auto& out) {
59 		SET_OUT_HEADER_LEN(out, statfs);
60 	})));
61 
62 	EXPECT_CALL(*m_mock, process(
63 		ResultOf([=](auto in) {
64 			return (in.header.opcode == FUSE_OPENDIR &&
65 				in.header.nodeid == ino &&
66 				in.body.opendir.flags == flags);
67 		}, Eq(true)),
68 		_)
69 	).WillOnce(Invoke(r));
70 }
71 
72 };
73 
74 
75 /*
76  * The fuse daemon fails the request with enoent.  This usually indicates a
77  * race condition: some other FUSE client removed the file in between when the
78  * kernel checked for it with lookup and tried to open it
79  */
80 TEST_F(Opendir, enoent)
81 {
82 	const char FULLPATH[] = "mountpoint/some_dir";
83 	const char RELPATH[] = "some_dir";
84 	uint64_t ino = 42;
85 
86 	expect_lookup(RELPATH, ino);
87 	expect_opendir(ino, O_RDONLY, ReturnErrno(ENOENT));
88 
89 	ASSERT_EQ(-1, open(FULLPATH, O_DIRECTORY));
90 	EXPECT_EQ(ENOENT, errno);
91 }
92 
93 /*
94  * The daemon is responsible for checking file permissions (unless the
95  * default_permissions mount option was used)
96  */
97 TEST_F(Opendir, eperm)
98 {
99 	const char FULLPATH[] = "mountpoint/some_dir";
100 	const char RELPATH[] = "some_dir";
101 	uint64_t ino = 42;
102 
103 	expect_lookup(RELPATH, ino);
104 	expect_opendir(ino, O_RDONLY, ReturnErrno(EPERM));
105 
106 	EXPECT_EQ(-1, open(FULLPATH, O_DIRECTORY));
107 	EXPECT_EQ(EPERM, errno);
108 }
109 
110 TEST_F(Opendir, open)
111 {
112 	const char FULLPATH[] = "mountpoint/some_dir";
113 	const char RELPATH[] = "some_dir";
114 	uint64_t ino = 42;
115 	int fd;
116 
117 	expect_lookup(RELPATH, ino);
118 	expect_opendir(ino, O_RDONLY,
119 	ReturnImmediate([=](auto in __unused, auto& out) {
120 		SET_OUT_HEADER_LEN(out, open);
121 	}));
122 
123 	fd = open(FULLPATH, O_DIRECTORY);
124 	EXPECT_LE(0, fd) << strerror(errno);
125 
126 	leak(fd);
127 }
128 
129 /* Directories can be opened O_EXEC for stuff like fchdir(2) */
130 TEST_F(Opendir, open_exec)
131 {
132 	const char FULLPATH[] = "mountpoint/some_dir";
133 	const char RELPATH[] = "some_dir";
134 	uint64_t ino = 42;
135 	int fd;
136 
137 	expect_lookup(RELPATH, ino);
138 	expect_opendir(ino, O_EXEC,
139 	ReturnImmediate([=](auto in __unused, auto& out) {
140 		SET_OUT_HEADER_LEN(out, open);
141 	}));
142 
143 	fd = open(FULLPATH, O_EXEC | O_DIRECTORY);
144 	ASSERT_LE(0, fd) << strerror(errno);
145 
146 	leak(fd);
147 }
148 
149 TEST_F(Opendir, opendir)
150 {
151 	const char FULLPATH[] = "mountpoint/some_dir";
152 	const char RELPATH[] = "some_dir";
153 	uint64_t ino = 42;
154 
155 	expect_lookup(RELPATH, ino);
156 	expect_opendir(ino, O_RDONLY,
157 	ReturnImmediate([=](auto in __unused, auto& out) {
158 		SET_OUT_HEADER_LEN(out, open);
159 	}));
160 
161 	errno = 0;
162 	EXPECT_NE(nullptr, opendir(FULLPATH)) << strerror(errno);
163 }
164