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 * Copyright (c) 2019 The FreeBSD Foundation
38 * Portions of this software were developed by BFF Storage Systems, LLC under
39 * sponsorship from the FreeBSD Foundation.
41 * Redistribution and use in source and binary forms, with or without
42 * modification, are permitted provided that the following conditions
44 * 1. Redistributions of source code must retain the above copyright
45 * notice, this list of conditions and the following disclaimer.
46 * 2. Redistributions in binary form must reproduce the above copyright
47 * notice, this list of conditions and the following disclaimer in the
48 * documentation and/or other materials provided with the distribution.
50 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
51 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
54 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
63 #include <sys/cdefs.h>
64 __FBSDID("$FreeBSD$");
66 #include <sys/param.h>
67 #include <sys/module.h>
68 #include <sys/systm.h>
69 #include <sys/counter.h>
70 #include <sys/errno.h>
71 #include <sys/kernel.h>
74 #include <sys/malloc.h>
75 #include <sys/queue.h>
78 #include <sys/mutex.h>
80 #include <sys/mount.h>
82 #include <sys/vnode.h>
83 #include <sys/signalvar.h>
84 #include <sys/syscallsubr.h>
85 #include <sys/sysctl.h>
89 #include "fuse_node.h"
91 #include "fuse_internal.h"
93 SDT_PROVIDER_DECLARE(fusefs);
96 * arg0: verbosity. Higher numbers give more verbose messages
97 * arg1: Textual message
99 SDT_PROBE_DEFINE2(fusefs, , ipc, trace, "int", "char*");
101 static void fdisp_make_pid(struct fuse_dispatcher *fdip, enum fuse_opcode op,
102 struct fuse_data *data, uint64_t nid, pid_t pid, struct ucred *cred);
103 static void fuse_interrupt_send(struct fuse_ticket *otick, int err);
104 static struct fuse_ticket *fticket_alloc(struct fuse_data *data);
105 static void fticket_refresh(struct fuse_ticket *ftick);
106 static void fticket_destroy(struct fuse_ticket *ftick);
107 static int fticket_wait_answer(struct fuse_ticket *ftick);
109 fticket_aw_pull_uio(struct fuse_ticket *ftick,
112 static int fuse_body_audit(struct fuse_ticket *ftick, size_t blen);
114 static fuse_handler_t fuse_standard_handler;
116 static counter_u64_t fuse_ticket_count;
117 SYSCTL_COUNTER_U64(_vfs_fusefs_stats, OID_AUTO, ticket_count, CTLFLAG_RD,
118 &fuse_ticket_count, "Number of allocated tickets");
120 static long fuse_iov_permanent_bufsize = 1 << 19;
122 SYSCTL_LONG(_vfs_fusefs, OID_AUTO, iov_permanent_bufsize, CTLFLAG_RW,
123 &fuse_iov_permanent_bufsize, 0,
124 "limit for permanently stored buffer size for fuse_iovs");
125 static int fuse_iov_credit = 16;
127 SYSCTL_INT(_vfs_fusefs, OID_AUTO, iov_credit, CTLFLAG_RW,
129 "how many times is an oversized fuse_iov tolerated");
131 MALLOC_DEFINE(M_FUSEMSG, "fuse_msgbuf", "fuse message buffer");
132 static uma_zone_t ticket_zone;
135 * TODO: figure out how to timeout INTERRUPT requests, because the daemon may
136 * leagally never respond
139 fuse_interrupt_callback(struct fuse_ticket *tick, struct uio *uio)
141 struct fuse_ticket *otick, *x_tick;
142 struct fuse_interrupt_in *fii;
143 struct fuse_data *data = tick->tk_data;
146 fii = (struct fuse_interrupt_in*)((char*)tick->tk_ms_fiov.base +
147 sizeof(struct fuse_in_header));
149 fuse_lck_mtx_lock(data->aw_mtx);
150 TAILQ_FOREACH_SAFE(otick, &data->aw_head, tk_aw_link, x_tick) {
151 if (otick->tk_unique == fii->unique) {
156 fuse_lck_mtx_unlock(data->aw_mtx);
159 /* Original is already complete. Just return */
163 /* Clear the original ticket's interrupt association */
164 otick->irq_unique = 0;
166 if (tick->tk_aw_ohead.error == ENOSYS) {
167 fsess_set_notimpl(data->mp, FUSE_INTERRUPT);
169 } else if (tick->tk_aw_ohead.error == EAGAIN) {
171 * There are two reasons we might get this:
172 * 1) the daemon received the INTERRUPT request before the
174 * 2) the daemon received the INTERRUPT request after it
175 * completed the original request.
176 * In the first case we should re-send the INTERRUPT. In the
177 * second, we should ignore it.
180 fuse_interrupt_send(otick, EINTR);
183 /* Illegal FUSE_INTERRUPT response */
188 /* Interrupt the operation otick. Return err as its error code */
190 fuse_interrupt_send(struct fuse_ticket *otick, int err)
192 struct fuse_dispatcher fdi;
193 struct fuse_interrupt_in *fii;
194 struct fuse_in_header *ftick_hdr;
195 struct fuse_data *data = otick->tk_data;
196 struct fuse_ticket *tick, *xtick;
197 struct ucred reused_creds;
198 gid_t reused_groups[1];
200 if (otick->irq_unique == 0) {
202 * If the daemon hasn't yet received otick, then we can answer
203 * it ourselves and return.
205 fuse_lck_mtx_lock(data->ms_mtx);
206 STAILQ_FOREACH_SAFE(tick, &otick->tk_data->ms_head, tk_ms_link,
209 STAILQ_REMOVE(&otick->tk_data->ms_head, tick,
210 fuse_ticket, tk_ms_link);
211 otick->tk_data->ms_count--;
212 otick->tk_ms_link.stqe_next = NULL;
213 fuse_lck_mtx_unlock(data->ms_mtx);
215 fuse_lck_mtx_lock(otick->tk_aw_mtx);
216 if (!fticket_answered(otick)) {
217 fticket_set_answered(otick);
218 otick->tk_aw_errno = err;
221 fuse_lck_mtx_unlock(otick->tk_aw_mtx);
223 fuse_ticket_drop(tick);
227 fuse_lck_mtx_unlock(data->ms_mtx);
230 * If the fuse daemon doesn't support interrupts, then there's
231 * nothing more that we can do
233 if (!fsess_isimpl(data->mp, FUSE_INTERRUPT))
237 * If the fuse daemon has already received otick, then we must
238 * send FUSE_INTERRUPT.
240 ftick_hdr = fticket_in_header(otick);
241 reused_creds.cr_uid = ftick_hdr->uid;
242 reused_groups[0] = ftick_hdr->gid;
243 reused_creds.cr_groups = reused_groups;
244 fdisp_init(&fdi, sizeof(*fii));
245 fdisp_make_pid(&fdi, FUSE_INTERRUPT, data, ftick_hdr->nodeid,
246 ftick_hdr->pid, &reused_creds);
249 fii->unique = otick->tk_unique;
250 fuse_insert_callback(fdi.tick, fuse_interrupt_callback);
252 otick->irq_unique = fdi.tick->tk_unique;
253 /* Interrupt ops should be delivered ASAP */
254 fuse_insert_message(fdi.tick, true);
257 /* This ticket has already been interrupted */
262 fiov_init(struct fuse_iov *fiov, size_t size)
264 uint32_t msize = FU_AT_LEAST(size);
268 fiov->base = malloc(msize, M_FUSEMSG, M_WAITOK | M_ZERO);
270 fiov->allocated_size = msize;
271 fiov->credit = fuse_iov_credit;
275 fiov_teardown(struct fuse_iov *fiov)
277 MPASS(fiov->base != NULL);
278 free(fiov->base, M_FUSEMSG);
282 fiov_adjust(struct fuse_iov *fiov, size_t size)
284 if (fiov->allocated_size < size ||
285 (fuse_iov_permanent_bufsize >= 0 &&
286 fiov->allocated_size - size > fuse_iov_permanent_bufsize &&
287 --fiov->credit < 0)) {
288 fiov->base = realloc(fiov->base, FU_AT_LEAST(size), M_FUSEMSG,
291 panic("FUSE: realloc failed");
293 fiov->allocated_size = FU_AT_LEAST(size);
294 fiov->credit = fuse_iov_credit;
295 /* Clear data buffer after reallocation */
296 bzero(fiov->base, size);
297 } else if (size > fiov->len) {
298 /* Clear newly extended portion of data buffer */
299 bzero((char*)fiov->base + fiov->len, size - fiov->len);
304 /* Resize the fiov if needed, and clear it's buffer */
306 fiov_refresh(struct fuse_iov *fiov)
308 fiov_adjust(fiov, 0);
312 fticket_ctor(void *mem, int size, void *arg, int flags)
314 struct fuse_ticket *ftick = mem;
315 struct fuse_data *data = arg;
317 FUSE_ASSERT_MS_DONE(ftick);
318 FUSE_ASSERT_AW_DONE(ftick);
320 ftick->tk_data = data;
322 if (ftick->tk_unique != 0)
323 fticket_refresh(ftick);
325 /* May be truncated to 32 bits */
326 ftick->tk_unique = atomic_fetchadd_long(&data->ticketer, 1);
327 if (ftick->tk_unique == 0)
328 ftick->tk_unique = atomic_fetchadd_long(&data->ticketer, 1);
330 ftick->irq_unique = 0;
332 refcount_init(&ftick->tk_refcount, 1);
333 counter_u64_add(fuse_ticket_count, 1);
339 fticket_dtor(void *mem, int size, void *arg)
342 struct fuse_ticket *ftick = mem;
345 FUSE_ASSERT_MS_DONE(ftick);
346 FUSE_ASSERT_AW_DONE(ftick);
348 counter_u64_add(fuse_ticket_count, -1);
352 fticket_init(void *mem, int size, int flags)
354 struct fuse_ticket *ftick = mem;
356 bzero(ftick, sizeof(struct fuse_ticket));
358 fiov_init(&ftick->tk_ms_fiov, sizeof(struct fuse_in_header));
359 ftick->tk_ms_type = FT_M_FIOV;
361 mtx_init(&ftick->tk_aw_mtx, "fuse answer delivery mutex", NULL, MTX_DEF);
362 fiov_init(&ftick->tk_aw_fiov, 0);
363 ftick->tk_aw_type = FT_A_FIOV;
369 fticket_fini(void *mem, int size)
371 struct fuse_ticket *ftick = mem;
373 fiov_teardown(&ftick->tk_ms_fiov);
374 fiov_teardown(&ftick->tk_aw_fiov);
375 mtx_destroy(&ftick->tk_aw_mtx);
378 static inline struct fuse_ticket *
379 fticket_alloc(struct fuse_data *data)
381 return uma_zalloc_arg(ticket_zone, data, M_WAITOK);
385 fticket_destroy(struct fuse_ticket *ftick)
387 return uma_zfree(ticket_zone, ftick);
392 fticket_refresh(struct fuse_ticket *ftick)
394 FUSE_ASSERT_MS_DONE(ftick);
395 FUSE_ASSERT_AW_DONE(ftick);
397 fiov_refresh(&ftick->tk_ms_fiov);
398 ftick->tk_ms_bufdata = NULL;
399 ftick->tk_ms_bufsize = 0;
400 ftick->tk_ms_type = FT_M_FIOV;
402 bzero(&ftick->tk_aw_ohead, sizeof(struct fuse_out_header));
404 fiov_refresh(&ftick->tk_aw_fiov);
405 ftick->tk_aw_errno = 0;
406 ftick->tk_aw_bufdata = NULL;
407 ftick->tk_aw_bufsize = 0;
408 ftick->tk_aw_type = FT_A_FIOV;
413 /* Prepar the ticket to be reused, but don't clear its data buffers */
415 fticket_reset(struct fuse_ticket *ftick)
417 FUSE_ASSERT_MS_DONE(ftick);
418 FUSE_ASSERT_AW_DONE(ftick);
420 ftick->tk_ms_bufdata = NULL;
421 ftick->tk_ms_bufsize = 0;
422 ftick->tk_ms_type = FT_M_FIOV;
424 bzero(&ftick->tk_aw_ohead, sizeof(struct fuse_out_header));
426 ftick->tk_aw_errno = 0;
427 ftick->tk_aw_bufdata = NULL;
428 ftick->tk_aw_bufsize = 0;
429 ftick->tk_aw_type = FT_A_FIOV;
435 fticket_wait_answer(struct fuse_ticket *ftick)
437 struct thread *td = curthread;
438 sigset_t blockedset, oldset;
439 int err = 0, stops_deferred;
440 struct fuse_data *data = ftick->tk_data;
441 bool interrupted = false;
443 if (fsess_isimpl(ftick->tk_data->mp, FUSE_INTERRUPT) &&
444 data->dataflags & FSESS_INTR) {
445 SIGEMPTYSET(blockedset);
447 /* Block all signals except (implicitly) SIGKILL */
448 SIGFILLSET(blockedset);
450 stops_deferred = sigdeferstop(SIGDEFERSTOP_SILENT);
451 kern_sigprocmask(td, SIG_BLOCK, NULL, &oldset, 0);
453 fuse_lck_mtx_lock(ftick->tk_aw_mtx);
456 if (fticket_answered(ftick)) {
460 if (fdata_get_dead(data)) {
462 fticket_set_answered(ftick);
465 kern_sigprocmask(td, SIG_BLOCK, &blockedset, NULL, 0);
466 err = msleep(ftick, &ftick->tk_aw_mtx, PCATCH, "fu_ans",
467 data->daemon_timeout * hz);
468 kern_sigprocmask(td, SIG_SETMASK, &oldset, NULL, 0);
469 if (err == EWOULDBLOCK) {
470 SDT_PROBE2(fusefs, , ipc, trace, 3,
471 "fticket_wait_answer: EWOULDBLOCK");
472 #ifdef XXXIP /* die conditionally */
473 if (!fdata_get_dead(data)) {
474 fdata_set_dead(data);
478 fticket_set_answered(ftick);
479 } else if ((err == EINTR || err == ERESTART)) {
481 * Whether we get EINTR or ERESTART depends on whether
482 * SA_RESTART was set by sigaction(2).
484 * Try to interrupt the operation and wait for an EINTR response
485 * to the original operation. If the file system does not
486 * support FUSE_INTERRUPT, then we'll just wait for it to
487 * complete like normal. If it does support FUSE_INTERRUPT,
488 * then it will either respond EINTR to the original operation,
489 * or EAGAIN to the interrupt.
493 SDT_PROBE2(fusefs, , ipc, trace, 4,
494 "fticket_wait_answer: interrupt");
495 fuse_lck_mtx_unlock(ftick->tk_aw_mtx);
496 fuse_interrupt_send(ftick, err);
498 PROC_LOCK(td->td_proc);
499 mtx_lock(&td->td_proc->p_sigacts->ps_mtx);
500 tmpset = td->td_proc->p_siglist;
501 SIGSETOR(tmpset, td->td_siglist);
502 mtx_unlock(&td->td_proc->p_sigacts->ps_mtx);
503 PROC_UNLOCK(td->td_proc);
505 fuse_lck_mtx_lock(ftick->tk_aw_mtx);
506 if (!interrupted && !SIGISMEMBER(tmpset, SIGKILL)) {
508 * Block all signals while we wait for an interrupt
509 * response. The protocol doesn't discriminate between
512 SIGFILLSET(blockedset);
517 * Return immediately for fatal signals, or if this is
518 * the second interruption. We should only be
519 * interrupted twice if the thread is stopped, for
520 * example during sigexit.
524 SDT_PROBE2(fusefs, , ipc, trace, 6,
525 "fticket_wait_answer: other error");
527 SDT_PROBE2(fusefs, , ipc, trace, 7, "fticket_wait_answer: OK");
530 if (!(err || fticket_answered(ftick))) {
531 SDT_PROBE2(fusefs, , ipc, trace, 1,
532 "FUSE: requester was woken up but still no answer");
535 fuse_lck_mtx_unlock(ftick->tk_aw_mtx);
536 sigallowstop(stops_deferred);
543 fticket_aw_pull_uio(struct fuse_ticket *ftick, struct uio *uio)
546 size_t len = uio_resid(uio);
549 switch (ftick->tk_aw_type) {
551 fiov_adjust(fticket_resp(ftick), len);
552 err = uiomove(fticket_resp(ftick)->base, len, uio);
556 ftick->tk_aw_bufsize = len;
557 err = uiomove(ftick->tk_aw_bufdata, len, uio);
561 panic("FUSE: unknown answer type for ticket %p", ftick);
568 fticket_pull(struct fuse_ticket *ftick, struct uio *uio)
572 if (ftick->tk_aw_ohead.error) {
575 err = fuse_body_audit(ftick, uio_resid(uio));
577 err = fticket_aw_pull_uio(ftick, uio);
583 fdata_alloc(struct cdev *fdev, struct ucred *cred)
585 struct fuse_data *data;
587 data = malloc(sizeof(struct fuse_data), M_FUSEMSG, M_WAITOK | M_ZERO);
590 mtx_init(&data->ms_mtx, "fuse message list mutex", NULL, MTX_DEF);
591 STAILQ_INIT(&data->ms_head);
593 knlist_init_mtx(&data->ks_rsel.si_note, &data->ms_mtx);
594 mtx_init(&data->aw_mtx, "fuse answer list mutex", NULL, MTX_DEF);
595 TAILQ_INIT(&data->aw_head);
596 data->daemoncred = crhold(cred);
597 data->daemon_timeout = FUSE_DEFAULT_DAEMON_TIMEOUT;
598 sx_init(&data->rename_lock, "fuse rename lock");
605 fdata_trydestroy(struct fuse_data *data)
608 MPASS(data->ref >= 0);
612 /* Driving off stage all that stuff thrown at device... */
613 sx_destroy(&data->rename_lock);
614 crfree(data->daemoncred);
615 mtx_destroy(&data->aw_mtx);
616 knlist_delete(&data->ks_rsel.si_note, curthread, 0);
617 knlist_destroy(&data->ks_rsel.si_note);
618 mtx_destroy(&data->ms_mtx);
620 free(data, M_FUSEMSG);
624 fdata_set_dead(struct fuse_data *data)
627 if (fdata_get_dead(data)) {
631 fuse_lck_mtx_lock(data->ms_mtx);
632 data->dataflags |= FSESS_DEAD;
634 selwakeuppri(&data->ks_rsel, PZERO + 1);
635 wakeup(&data->ticketer);
636 fuse_lck_mtx_unlock(data->ms_mtx);
641 fuse_ticket_fetch(struct fuse_data *data)
644 struct fuse_ticket *ftick;
646 ftick = fticket_alloc(data);
648 if (!(data->dataflags & FSESS_INITED)) {
649 /* Sleep until get answer for INIT messsage */
651 if (!(data->dataflags & FSESS_INITED) && data->ticketer > 2) {
652 err = msleep(&data->ticketer, &fuse_mtx, PCATCH | PDROP,
655 fdata_set_dead(data);
663 fuse_ticket_drop(struct fuse_ticket *ftick)
667 die = refcount_release(&ftick->tk_refcount);
669 fticket_destroy(ftick);
675 fuse_insert_callback(struct fuse_ticket *ftick, fuse_handler_t * handler)
677 if (fdata_get_dead(ftick->tk_data)) {
680 ftick->tk_aw_handler = handler;
682 fuse_lck_mtx_lock(ftick->tk_data->aw_mtx);
684 fuse_lck_mtx_unlock(ftick->tk_data->aw_mtx);
688 * Insert a new upgoing ticket into the message queue
690 * If urgent is true, insert at the front of the queue. Otherwise, insert in
694 fuse_insert_message(struct fuse_ticket *ftick, bool urgent)
696 if (ftick->tk_flag & FT_DIRTY) {
697 panic("FUSE: ticket reused without being refreshed");
699 ftick->tk_flag |= FT_DIRTY;
701 if (fdata_get_dead(ftick->tk_data)) {
704 fuse_lck_mtx_lock(ftick->tk_data->ms_mtx);
706 fuse_ms_push_head(ftick);
709 wakeup_one(ftick->tk_data);
710 selwakeuppri(&ftick->tk_data->ks_rsel, PZERO + 1);
711 KNOTE_LOCKED(&ftick->tk_data->ks_rsel.si_note, 0);
712 fuse_lck_mtx_unlock(ftick->tk_data->ms_mtx);
716 fuse_body_audit(struct fuse_ticket *ftick, size_t blen)
719 enum fuse_opcode opcode;
721 opcode = fticket_opcode(ftick);
725 err = (blen == sizeof(struct fuse_bmap_out)) ? 0 : EINVAL;
733 if (fuse_libabi_geq(ftick->tk_data, 7, 9)) {
734 err = (blen == sizeof(struct fuse_entry_out)) ?
737 err = (blen == FUSE_COMPAT_ENTRY_OUT_SIZE) ? 0 : EINVAL;
742 panic("FUSE: a handler has been intalled for FUSE_FORGET");
747 if (fuse_libabi_geq(ftick->tk_data, 7, 9)) {
748 err = (blen == sizeof(struct fuse_attr_out)) ?
751 err = (blen == FUSE_COMPAT_ATTR_OUT_SIZE) ? 0 : EINVAL;
756 err = (PAGE_SIZE >= blen) ? 0 : EINVAL;
760 err = (blen == 0) ? 0 : EINVAL;
764 err = (blen == 0) ? 0 : EINVAL;
768 err = (blen == 0) ? 0 : EINVAL;
772 err = (blen == sizeof(struct fuse_open_out)) ? 0 : EINVAL;
776 err = (((struct fuse_read_in *)(
777 (char *)ftick->tk_ms_fiov.base +
778 sizeof(struct fuse_in_header)
779 ))->size >= blen) ? 0 : EINVAL;
783 err = (blen == sizeof(struct fuse_write_out)) ? 0 : EINVAL;
787 if (fuse_libabi_geq(ftick->tk_data, 7, 4)) {
788 err = (blen == sizeof(struct fuse_statfs_out)) ?
791 err = (blen == FUSE_COMPAT_STATFS_SIZE) ? 0 : EINVAL;
796 err = (blen == 0) ? 0 : EINVAL;
800 err = (blen == 0) ? 0 : EINVAL;
804 err = (blen == 0) ? 0 : EINVAL;
810 * These can have varying response lengths, and 0 length
811 * isn't necessarily invalid.
816 case FUSE_REMOVEXATTR:
817 err = (blen == 0) ? 0 : EINVAL;
821 err = (blen == 0) ? 0 : EINVAL;
825 if (blen == sizeof(struct fuse_init_out) ||
826 blen == FUSE_COMPAT_INIT_OUT_SIZE ||
827 blen == FUSE_COMPAT_22_INIT_OUT_SIZE) {
835 err = (blen == sizeof(struct fuse_open_out)) ? 0 : EINVAL;
839 err = (((struct fuse_read_in *)(
840 (char *)ftick->tk_ms_fiov.base +
841 sizeof(struct fuse_in_header)
842 ))->size >= blen) ? 0 : EINVAL;
845 case FUSE_RELEASEDIR:
846 err = (blen == 0) ? 0 : EINVAL;
850 err = (blen == 0) ? 0 : EINVAL;
854 err = (blen == sizeof(struct fuse_lk_out)) ? 0 : EINVAL;
858 err = (blen == 0) ? 0 : EINVAL;
862 err = (blen == 0) ? 0 : EINVAL;
866 err = (blen == 0) ? 0 : EINVAL;
870 if (fuse_libabi_geq(ftick->tk_data, 7, 9)) {
871 err = (blen == sizeof(struct fuse_entry_out) +
872 sizeof(struct fuse_open_out)) ? 0 : EINVAL;
874 err = (blen == FUSE_COMPAT_ENTRY_OUT_SIZE +
875 sizeof(struct fuse_open_out)) ? 0 : EINVAL;
880 err = (blen == 0) ? 0 : EINVAL;
884 panic("FUSE: opcodes out of sync (%d)\n", opcode);
891 fuse_setup_ihead(struct fuse_in_header *ihead, struct fuse_ticket *ftick,
892 uint64_t nid, enum fuse_opcode op, size_t blen, pid_t pid,
895 ihead->len = sizeof(*ihead) + blen;
896 ihead->unique = ftick->tk_unique;
901 ihead->uid = cred->cr_uid;
902 ihead->gid = cred->cr_groups[0];
906 * fuse_standard_handler just pulls indata and wakes up pretender.
907 * Doesn't try to interpret data, that's left for the pretender.
908 * Though might do a basic size verification before the pull-in takes place
912 fuse_standard_handler(struct fuse_ticket *ftick, struct uio *uio)
916 err = fticket_pull(ftick, uio);
918 fuse_lck_mtx_lock(ftick->tk_aw_mtx);
920 if (!fticket_answered(ftick)) {
921 fticket_set_answered(ftick);
922 ftick->tk_aw_errno = err;
925 fuse_lck_mtx_unlock(ftick->tk_aw_mtx);
931 * Reinitialize a dispatcher from a pid and node id, without resizing or
932 * clearing its data buffers
935 fdisp_refresh_pid(struct fuse_dispatcher *fdip, enum fuse_opcode op,
936 struct mount *mp, uint64_t nid, pid_t pid, struct ucred *cred)
939 MPASS2(sizeof(fdip->finh) + fdip->iosize <= fdip->tick->tk_ms_fiov.len,
940 "Must use fdisp_make_pid to increase the size of the fiov");
941 fticket_reset(fdip->tick);
943 FUSE_DIMALLOC(&fdip->tick->tk_ms_fiov, fdip->finh,
944 fdip->indata, fdip->iosize);
946 fuse_setup_ihead(fdip->finh, fdip->tick, nid, op, fdip->iosize, pid,
950 /* Initialize a dispatcher from a pid and node id */
952 fdisp_make_pid(struct fuse_dispatcher *fdip, enum fuse_opcode op,
953 struct fuse_data *data, uint64_t nid, pid_t pid, struct ucred *cred)
956 fticket_refresh(fdip->tick);
958 fdip->tick = fuse_ticket_fetch(data);
961 /* FUSE_DIMALLOC will bzero the fiovs when it enlarges them */
962 FUSE_DIMALLOC(&fdip->tick->tk_ms_fiov, fdip->finh,
963 fdip->indata, fdip->iosize);
965 fuse_setup_ihead(fdip->finh, fdip->tick, nid, op, fdip->iosize, pid, cred);
969 fdisp_make(struct fuse_dispatcher *fdip, enum fuse_opcode op, struct mount *mp,
970 uint64_t nid, struct thread *td, struct ucred *cred)
972 struct fuse_data *data = fuse_get_mpdata(mp);
973 RECTIFY_TDCR(td, cred);
975 return fdisp_make_pid(fdip, op, data, nid, td->td_proc->p_pid, cred);
979 fdisp_make_vp(struct fuse_dispatcher *fdip, enum fuse_opcode op,
980 struct vnode *vp, struct thread *td, struct ucred *cred)
982 struct mount *mp = vnode_mount(vp);
983 struct fuse_data *data = fuse_get_mpdata(mp);
985 RECTIFY_TDCR(td, cred);
986 return fdisp_make_pid(fdip, op, data, VTOI(vp),
987 td->td_proc->p_pid, cred);
990 /* Refresh a fuse_dispatcher so it can be reused, but don't zero its data */
992 fdisp_refresh_vp(struct fuse_dispatcher *fdip, enum fuse_opcode op,
993 struct vnode *vp, struct thread *td, struct ucred *cred)
995 RECTIFY_TDCR(td, cred);
996 return fdisp_refresh_pid(fdip, op, vnode_mount(vp), VTOI(vp),
997 td->td_proc->p_pid, cred);
1001 fdisp_refresh(struct fuse_dispatcher *fdip)
1003 fticket_refresh(fdip->tick);
1006 SDT_PROBE_DEFINE2(fusefs, , ipc, fdisp_wait_answ_error, "char*", "int");
1009 fdisp_wait_answ(struct fuse_dispatcher *fdip)
1013 fdip->answ_stat = 0;
1014 fuse_insert_callback(fdip->tick, fuse_standard_handler);
1015 fuse_insert_message(fdip->tick, false);
1017 if ((err = fticket_wait_answer(fdip->tick))) {
1018 fuse_lck_mtx_lock(fdip->tick->tk_aw_mtx);
1020 if (fticket_answered(fdip->tick)) {
1022 * Just between noticing the interrupt and getting here,
1023 * the standard handler has completed his job.
1024 * So we drop the ticket and exit as usual.
1026 SDT_PROBE2(fusefs, , ipc, fdisp_wait_answ_error,
1027 "IPC: interrupted, already answered", err);
1028 fuse_lck_mtx_unlock(fdip->tick->tk_aw_mtx);
1032 * So we were faster than the standard handler.
1033 * Then by setting the answered flag we get *him*
1034 * to drop the ticket.
1036 SDT_PROBE2(fusefs, , ipc, fdisp_wait_answ_error,
1037 "IPC: interrupted, setting to answered", err);
1038 fticket_set_answered(fdip->tick);
1039 fuse_lck_mtx_unlock(fdip->tick->tk_aw_mtx);
1044 if (fdip->tick->tk_aw_errno == ENOTCONN) {
1045 /* The daemon died while we were waiting for a response */
1048 } else if (fdip->tick->tk_aw_errno) {
1050 * There was some sort of communication error with the daemon
1051 * that the client wouldn't understand.
1053 SDT_PROBE2(fusefs, , ipc, fdisp_wait_answ_error,
1054 "IPC: explicit EIO-ing", fdip->tick->tk_aw_errno);
1058 if ((err = fdip->tick->tk_aw_ohead.error)) {
1059 SDT_PROBE2(fusefs, , ipc, fdisp_wait_answ_error,
1060 "IPC: setting status", fdip->tick->tk_aw_ohead.error);
1062 * This means a "proper" fuse syscall error.
1063 * We record this value so the caller will
1064 * be able to know it's not a boring messaging
1065 * failure, if she wishes so (and if not, she can
1066 * just simply propagate the return value of this routine).
1067 * [XXX Maybe a bitflag would do the job too,
1068 * if other flags needed, this will be converted thusly.]
1070 fdip->answ_stat = err;
1073 fdip->answ = fticket_resp(fdip->tick)->base;
1074 fdip->iosize = fticket_resp(fdip->tick)->len;
1085 ticket_zone = uma_zcreate("fuse_ticket", sizeof(struct fuse_ticket),
1086 fticket_ctor, fticket_dtor, fticket_init, fticket_fini,
1088 fuse_ticket_count = counter_u64_alloc(M_WAITOK);
1092 fuse_ipc_destroy(void)
1094 counter_u64_free(fuse_ticket_count);
1095 uma_zdestroy(ticket_zone);