2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2007-2009 Google Inc. and Amit Singh
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following disclaimer
15 * in the documentation and/or other materials provided with the
17 * * Neither the name of Google Inc. nor the names of its
18 * contributors may be used to endorse or promote products derived from
19 * this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 * Copyright (C) 2005 Csaba Henk.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in the
43 * documentation and/or other materials provided with the distribution.
45 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
46 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
49 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
51 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
53 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
54 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
63 #include <sys/param.h>
64 #include <sys/refcount.h>
69 size_t allocated_size;
73 void fiov_init(struct fuse_iov *fiov, size_t size);
74 void fiov_teardown(struct fuse_iov *fiov);
75 void fiov_refresh(struct fuse_iov *fiov);
76 void fiov_adjust(struct fuse_iov *fiov, size_t size);
78 #define FUSE_DIMALLOC(fiov, spc1, spc2, amnt) do { \
79 fiov_adjust(fiov, (sizeof(*(spc1)) + (amnt))); \
80 (spc1) = (fiov)->base; \
81 (spc2) = (char *)(fiov)->base + (sizeof(*(spc1))); \
84 #define FU_AT_LEAST(siz) max((siz), 160)
86 #define FUSE_ASSERT_AW_DONE(ftick) \
87 KASSERT((ftick)->tk_aw_link.tqe_next == NULL && \
88 (ftick)->tk_aw_link.tqe_prev == NULL, \
89 ("FUSE: ticket still on answer delivery list %p", (ftick)))
91 #define FUSE_ASSERT_MS_DONE(ftick) \
92 KASSERT((ftick)->tk_ms_link.stqe_next == NULL, \
93 ("FUSE: ticket still on message list %p", (ftick)))
98 typedef int fuse_handler_t(struct fuse_ticket *ftick, struct uio *uio);
101 /* fields giving the identity of the ticket */
103 struct fuse_data *tk_data;
107 * If this ticket's operation has been interrupted, this will hold the
108 * unique value of the FUSE_INTERRUPT operation. Otherwise, it will be
113 /* fields for initiating an upgoing message */
114 struct fuse_iov tk_ms_fiov;
116 size_t tk_ms_bufsize;
117 enum { FT_M_FIOV, FT_M_BUF } tk_ms_type;
118 STAILQ_ENTRY(fuse_ticket) tk_ms_link;
120 /* fields for handling answers coming from userspace */
121 struct fuse_iov tk_aw_fiov;
123 size_t tk_aw_bufsize;
124 enum { FT_A_FIOV, FT_A_BUF } tk_aw_type;
126 struct fuse_out_header tk_aw_ohead;
128 struct mtx tk_aw_mtx;
129 fuse_handler_t *tk_aw_handler;
130 TAILQ_ENTRY(fuse_ticket) tk_aw_link;
133 #define FT_ANSW 0x01 /* request of ticket has already been answered */
134 #define FT_DIRTY 0x04 /* ticket has been used */
136 static inline struct fuse_iov *
137 fticket_resp(struct fuse_ticket *ftick)
139 return (&ftick->tk_aw_fiov);
143 fticket_answered(struct fuse_ticket *ftick)
145 mtx_assert(&ftick->tk_aw_mtx, MA_OWNED);
146 return (ftick->tk_flag & FT_ANSW);
150 fticket_set_answered(struct fuse_ticket *ftick)
152 mtx_assert(&ftick->tk_aw_mtx, MA_OWNED);
153 ftick->tk_flag |= FT_ANSW;
156 static inline struct fuse_in_header*
157 fticket_in_header(struct fuse_ticket *ftick)
159 return (struct fuse_in_header *)(ftick->tk_ms_fiov.base);
162 static inline enum fuse_opcode
163 fticket_opcode(struct fuse_ticket *ftick)
165 return fticket_in_header(ftick)->opcode;
168 int fticket_pull(struct fuse_ticket *ftick, struct uio *uio);
171 * The data representing a FUSE session.
177 struct ucred *daemoncred;
182 STAILQ_HEAD(, fuse_ticket) ms_head;
186 TAILQ_HEAD(, fuse_ticket) aw_head;
189 * Holds the next value of the FUSE operation unique value.
190 * Also, serves as a wakeup channel to prevent any operations from
191 * being created before INIT completes.
195 struct sx rename_lock;
197 uint32_t fuse_libabi_major;
198 uint32_t fuse_libabi_minor;
203 char volname[MAXPATHLEN];
205 struct selinfo ks_rsel;
212 #define FSESS_DEAD 0x0001 /* session is to be closed */
213 #define FSESS_UNUSED0 0x0002 /* unused */
214 #define FSESS_INITED 0x0004 /* session has been inited */
215 #define FSESS_DAEMON_CAN_SPY 0x0010 /* let non-owners access this fs */
216 /* (and being observed by the daemon) */
217 #define FSESS_PUSH_SYMLINKS_IN 0x0020 /* prefix absolute symlinks with mp */
218 #define FSESS_DEFAULT_PERMISSIONS 0x0040 /* kernel does permission checking */
219 #define FSESS_NO_ATTRCACHE 0x0080 /* no attribute caching */
220 #define FSESS_NO_READAHEAD 0x0100 /* no readaheads */
221 #define FSESS_NO_DATACACHE 0x0200 /* disable buffer cache */
222 #define FSESS_NO_NAMECACHE 0x0400 /* disable name cache */
223 #define FSESS_NO_MMAP 0x0800 /* disable mmap */
224 #define FSESS_ASYNC_READ 0x1000 /* allow multiple reads of some file */
225 #define FSESS_POSIX_LOCKS 0x2000 /* daemon supports POSIX locks */
226 #define FSESS_EXPORT_SUPPORT 0x10000 /* daemon supports NFS-style lookups */
227 #define FSESS_MNTOPTS_MASK ( \
228 FSESS_DAEMON_CAN_SPY | FSESS_PUSH_SYMLINKS_IN | \
229 FSESS_DEFAULT_PERMISSIONS | FSESS_NO_ATTRCACHE | \
230 FSESS_NO_READAHEAD | FSESS_NO_DATACACHE | \
231 FSESS_NO_NAMECACHE | FSESS_NO_MMAP)
233 enum fuse_data_cache_mode {
239 extern int fuse_data_cache_mode;
241 static inline struct fuse_data *
242 fuse_get_mpdata(struct mount *mp)
248 fsess_isimpl(struct mount *mp, int opcode)
250 struct fuse_data *data = fuse_get_mpdata(mp);
252 return ((data->notimpl & (1ULL << opcode)) == 0);
256 fsess_set_notimpl(struct mount *mp, int opcode)
258 struct fuse_data *data = fuse_get_mpdata(mp);
260 data->notimpl |= (1ULL << opcode);
264 fsess_opt_datacache(struct mount *mp)
266 struct fuse_data *data = fuse_get_mpdata(mp);
268 return (fuse_data_cache_mode != FUSE_CACHE_UC &&
269 (data->dataflags & FSESS_NO_DATACACHE) == 0);
273 fsess_opt_mmap(struct mount *mp)
275 struct fuse_data *data = fuse_get_mpdata(mp);
277 if (fuse_data_cache_mode == FUSE_CACHE_UC)
279 return ((data->dataflags & (FSESS_NO_DATACACHE | FSESS_NO_MMAP)) == 0);
282 /* Insert a new upgoing message */
284 fuse_ms_push(struct fuse_ticket *ftick)
286 mtx_assert(&ftick->tk_data->ms_mtx, MA_OWNED);
287 refcount_acquire(&ftick->tk_refcount);
288 STAILQ_INSERT_TAIL(&ftick->tk_data->ms_head, ftick, tk_ms_link);
289 ftick->tk_data->ms_count++;
292 /* Insert a new upgoing message to the front of the queue */
294 fuse_ms_push_head(struct fuse_ticket *ftick)
296 mtx_assert(&ftick->tk_data->ms_mtx, MA_OWNED);
297 refcount_acquire(&ftick->tk_refcount);
298 STAILQ_INSERT_HEAD(&ftick->tk_data->ms_head, ftick, tk_ms_link);
299 ftick->tk_data->ms_count++;
302 static inline struct fuse_ticket *
303 fuse_ms_pop(struct fuse_data *data)
305 struct fuse_ticket *ftick = NULL;
307 mtx_assert(&data->ms_mtx, MA_OWNED);
309 if ((ftick = STAILQ_FIRST(&data->ms_head))) {
310 STAILQ_REMOVE_HEAD(&data->ms_head, tk_ms_link);
313 MPASS(data->ms_count >= 0);
314 ftick->tk_ms_link.stqe_next = NULL;
322 fuse_aw_push(struct fuse_ticket *ftick)
324 mtx_assert(&ftick->tk_data->aw_mtx, MA_OWNED);
325 refcount_acquire(&ftick->tk_refcount);
326 TAILQ_INSERT_TAIL(&ftick->tk_data->aw_head, ftick, tk_aw_link);
330 fuse_aw_remove(struct fuse_ticket *ftick)
332 mtx_assert(&ftick->tk_data->aw_mtx, MA_OWNED);
333 TAILQ_REMOVE(&ftick->tk_data->aw_head, ftick, tk_aw_link);
335 ftick->tk_aw_link.tqe_next = NULL;
336 ftick->tk_aw_link.tqe_prev = NULL;
340 static inline struct fuse_ticket *
341 fuse_aw_pop(struct fuse_data *data)
343 struct fuse_ticket *ftick;
345 mtx_assert(&data->aw_mtx, MA_OWNED);
347 if ((ftick = TAILQ_FIRST(&data->aw_head)) != NULL)
348 fuse_aw_remove(ftick);
353 struct fuse_ticket *fuse_ticket_fetch(struct fuse_data *data);
354 int fuse_ticket_drop(struct fuse_ticket *ftick);
355 void fuse_insert_callback(struct fuse_ticket *ftick, fuse_handler_t *handler);
356 void fuse_insert_message(struct fuse_ticket *ftick, bool irq);
359 fuse_libabi_geq(struct fuse_data *data, uint32_t abi_maj, uint32_t abi_min)
361 return (data->fuse_libabi_major > abi_maj ||
362 (data->fuse_libabi_major == abi_maj &&
363 data->fuse_libabi_minor >= abi_min));
366 struct fuse_data *fdata_alloc(struct cdev *dev, struct ucred *cred);
367 void fdata_trydestroy(struct fuse_data *data);
368 void fdata_set_dead(struct fuse_data *data);
371 fdata_get_dead(struct fuse_data *data)
373 return (data->dataflags & FSESS_DEAD);
376 struct fuse_dispatcher {
377 struct fuse_ticket *tick;
378 struct fuse_in_header *finh;
388 fdisp_init(struct fuse_dispatcher *fdisp, size_t iosize)
390 fdisp->iosize = iosize;
395 fdisp_destroy(struct fuse_dispatcher *fdisp)
397 fuse_ticket_drop(fdisp->tick);
403 void fdisp_refresh(struct fuse_dispatcher *fdip);
405 void fdisp_make(struct fuse_dispatcher *fdip, enum fuse_opcode op,
406 struct mount *mp, uint64_t nid, struct thread *td, struct ucred *cred);
408 void fdisp_make_vp(struct fuse_dispatcher *fdip, enum fuse_opcode op,
409 struct vnode *vp, struct thread *td, struct ucred *cred);
411 void fdisp_refresh_vp(struct fuse_dispatcher *fdip, enum fuse_opcode op,
412 struct vnode *vp, struct thread *td, struct ucred *cred);
414 int fdisp_wait_answ(struct fuse_dispatcher *fdip);
417 fdisp_simple_putget_vp(struct fuse_dispatcher *fdip, enum fuse_opcode op,
418 struct vnode *vp, struct thread *td, struct ucred *cred)
420 fdisp_make_vp(fdip, op, vp, td, cred);
421 return (fdisp_wait_answ(fdip));
424 #endif /* _FUSE_IPC_H_ */