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_not_impl(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));
360 mtx_init(&ftick->tk_aw_mtx, "fuse answer delivery mutex", NULL, MTX_DEF);
361 fiov_init(&ftick->tk_aw_fiov, 0);
367 fticket_fini(void *mem, int size)
369 struct fuse_ticket *ftick = mem;
371 fiov_teardown(&ftick->tk_ms_fiov);
372 fiov_teardown(&ftick->tk_aw_fiov);
373 mtx_destroy(&ftick->tk_aw_mtx);
376 static inline struct fuse_ticket *
377 fticket_alloc(struct fuse_data *data)
379 return uma_zalloc_arg(ticket_zone, data, M_WAITOK);
383 fticket_destroy(struct fuse_ticket *ftick)
385 return uma_zfree(ticket_zone, ftick);
390 fticket_refresh(struct fuse_ticket *ftick)
392 FUSE_ASSERT_MS_DONE(ftick);
393 FUSE_ASSERT_AW_DONE(ftick);
395 fiov_refresh(&ftick->tk_ms_fiov);
397 bzero(&ftick->tk_aw_ohead, sizeof(struct fuse_out_header));
399 fiov_refresh(&ftick->tk_aw_fiov);
400 ftick->tk_aw_errno = 0;
404 /* Prepar the ticket to be reused, but don't clear its data buffers */
406 fticket_reset(struct fuse_ticket *ftick)
408 FUSE_ASSERT_MS_DONE(ftick);
409 FUSE_ASSERT_AW_DONE(ftick);
411 bzero(&ftick->tk_aw_ohead, sizeof(struct fuse_out_header));
413 ftick->tk_aw_errno = 0;
418 fticket_wait_answer(struct fuse_ticket *ftick)
420 struct thread *td = curthread;
421 sigset_t blockedset, oldset;
422 int err = 0, stops_deferred;
423 struct fuse_data *data = ftick->tk_data;
424 bool interrupted = false;
426 if (fsess_maybe_impl(ftick->tk_data->mp, FUSE_INTERRUPT) &&
427 data->dataflags & FSESS_INTR) {
428 SIGEMPTYSET(blockedset);
430 /* Block all signals except (implicitly) SIGKILL */
431 SIGFILLSET(blockedset);
433 stops_deferred = sigdeferstop(SIGDEFERSTOP_SILENT);
434 kern_sigprocmask(td, SIG_BLOCK, NULL, &oldset, 0);
436 fuse_lck_mtx_lock(ftick->tk_aw_mtx);
439 if (fticket_answered(ftick)) {
443 if (fdata_get_dead(data)) {
445 fticket_set_answered(ftick);
448 kern_sigprocmask(td, SIG_BLOCK, &blockedset, NULL, 0);
449 err = msleep(ftick, &ftick->tk_aw_mtx, PCATCH, "fu_ans",
450 data->daemon_timeout * hz);
451 kern_sigprocmask(td, SIG_SETMASK, &oldset, NULL, 0);
452 if (err == EWOULDBLOCK) {
453 SDT_PROBE2(fusefs, , ipc, trace, 3,
454 "fticket_wait_answer: EWOULDBLOCK");
455 #ifdef XXXIP /* die conditionally */
456 if (!fdata_get_dead(data)) {
457 fdata_set_dead(data);
461 fticket_set_answered(ftick);
462 } else if ((err == EINTR || err == ERESTART)) {
464 * Whether we get EINTR or ERESTART depends on whether
465 * SA_RESTART was set by sigaction(2).
467 * Try to interrupt the operation and wait for an EINTR response
468 * to the original operation. If the file system does not
469 * support FUSE_INTERRUPT, then we'll just wait for it to
470 * complete like normal. If it does support FUSE_INTERRUPT,
471 * then it will either respond EINTR to the original operation,
472 * or EAGAIN to the interrupt.
476 SDT_PROBE2(fusefs, , ipc, trace, 4,
477 "fticket_wait_answer: interrupt");
478 fuse_lck_mtx_unlock(ftick->tk_aw_mtx);
479 fuse_interrupt_send(ftick, err);
481 PROC_LOCK(td->td_proc);
482 mtx_lock(&td->td_proc->p_sigacts->ps_mtx);
483 tmpset = td->td_proc->p_siglist;
484 SIGSETOR(tmpset, td->td_siglist);
485 mtx_unlock(&td->td_proc->p_sigacts->ps_mtx);
486 PROC_UNLOCK(td->td_proc);
488 fuse_lck_mtx_lock(ftick->tk_aw_mtx);
489 if (!interrupted && !SIGISMEMBER(tmpset, SIGKILL)) {
491 * Block all signals while we wait for an interrupt
492 * response. The protocol doesn't discriminate between
495 SIGFILLSET(blockedset);
500 * Return immediately for fatal signals, or if this is
501 * the second interruption. We should only be
502 * interrupted twice if the thread is stopped, for
503 * example during sigexit.
507 SDT_PROBE2(fusefs, , ipc, trace, 6,
508 "fticket_wait_answer: other error");
510 SDT_PROBE2(fusefs, , ipc, trace, 7, "fticket_wait_answer: OK");
513 if (!(err || fticket_answered(ftick))) {
514 SDT_PROBE2(fusefs, , ipc, trace, 1,
515 "FUSE: requester was woken up but still no answer");
518 fuse_lck_mtx_unlock(ftick->tk_aw_mtx);
519 sigallowstop(stops_deferred);
526 fticket_aw_pull_uio(struct fuse_ticket *ftick, struct uio *uio)
529 size_t len = uio_resid(uio);
532 fiov_adjust(fticket_resp(ftick), len);
533 err = uiomove(fticket_resp(ftick)->base, len, uio);
539 fticket_pull(struct fuse_ticket *ftick, struct uio *uio)
543 if (ftick->tk_aw_ohead.error) {
546 err = fuse_body_audit(ftick, uio_resid(uio));
548 err = fticket_aw_pull_uio(ftick, uio);
554 fdata_alloc(struct cdev *fdev, struct ucred *cred)
556 struct fuse_data *data;
558 data = malloc(sizeof(struct fuse_data), M_FUSEMSG, M_WAITOK | M_ZERO);
561 mtx_init(&data->ms_mtx, "fuse message list mutex", NULL, MTX_DEF);
562 STAILQ_INIT(&data->ms_head);
564 knlist_init_mtx(&data->ks_rsel.si_note, &data->ms_mtx);
565 mtx_init(&data->aw_mtx, "fuse answer list mutex", NULL, MTX_DEF);
566 TAILQ_INIT(&data->aw_head);
567 data->daemoncred = crhold(cred);
568 data->daemon_timeout = FUSE_DEFAULT_DAEMON_TIMEOUT;
569 sx_init(&data->rename_lock, "fuse rename lock");
576 fdata_trydestroy(struct fuse_data *data)
579 MPASS(data->ref >= 0);
583 /* Driving off stage all that stuff thrown at device... */
584 sx_destroy(&data->rename_lock);
585 crfree(data->daemoncred);
586 mtx_destroy(&data->aw_mtx);
587 knlist_delete(&data->ks_rsel.si_note, curthread, 0);
588 knlist_destroy(&data->ks_rsel.si_note);
589 mtx_destroy(&data->ms_mtx);
591 free(data, M_FUSEMSG);
595 fdata_set_dead(struct fuse_data *data)
598 if (fdata_get_dead(data)) {
602 fuse_lck_mtx_lock(data->ms_mtx);
603 data->dataflags |= FSESS_DEAD;
605 selwakeuppri(&data->ks_rsel, PZERO + 1);
606 wakeup(&data->ticketer);
607 fuse_lck_mtx_unlock(data->ms_mtx);
612 fuse_ticket_fetch(struct fuse_data *data)
615 struct fuse_ticket *ftick;
617 ftick = fticket_alloc(data);
619 if (!(data->dataflags & FSESS_INITED)) {
620 /* Sleep until get answer for INIT messsage */
622 if (!(data->dataflags & FSESS_INITED) && data->ticketer > 2) {
623 err = msleep(&data->ticketer, &fuse_mtx, PCATCH | PDROP,
626 fdata_set_dead(data);
634 fuse_ticket_drop(struct fuse_ticket *ftick)
638 die = refcount_release(&ftick->tk_refcount);
640 fticket_destroy(ftick);
646 fuse_insert_callback(struct fuse_ticket *ftick, fuse_handler_t * handler)
648 if (fdata_get_dead(ftick->tk_data)) {
651 ftick->tk_aw_handler = handler;
653 fuse_lck_mtx_lock(ftick->tk_data->aw_mtx);
655 fuse_lck_mtx_unlock(ftick->tk_data->aw_mtx);
659 * Insert a new upgoing ticket into the message queue
661 * If urgent is true, insert at the front of the queue. Otherwise, insert in
665 fuse_insert_message(struct fuse_ticket *ftick, bool urgent)
667 if (ftick->tk_flag & FT_DIRTY) {
668 panic("FUSE: ticket reused without being refreshed");
670 ftick->tk_flag |= FT_DIRTY;
672 if (fdata_get_dead(ftick->tk_data)) {
675 fuse_lck_mtx_lock(ftick->tk_data->ms_mtx);
677 fuse_ms_push_head(ftick);
680 wakeup_one(ftick->tk_data);
681 selwakeuppri(&ftick->tk_data->ks_rsel, PZERO + 1);
682 KNOTE_LOCKED(&ftick->tk_data->ks_rsel.si_note, 0);
683 fuse_lck_mtx_unlock(ftick->tk_data->ms_mtx);
687 fuse_body_audit(struct fuse_ticket *ftick, size_t blen)
690 enum fuse_opcode opcode;
692 opcode = fticket_opcode(ftick);
696 err = (blen == sizeof(struct fuse_bmap_out)) ? 0 : EINVAL;
704 if (fuse_libabi_geq(ftick->tk_data, 7, 9)) {
705 err = (blen == sizeof(struct fuse_entry_out)) ?
708 err = (blen == FUSE_COMPAT_ENTRY_OUT_SIZE) ? 0 : EINVAL;
713 panic("FUSE: a handler has been intalled for FUSE_FORGET");
718 if (fuse_libabi_geq(ftick->tk_data, 7, 9)) {
719 err = (blen == sizeof(struct fuse_attr_out)) ?
722 err = (blen == FUSE_COMPAT_ATTR_OUT_SIZE) ? 0 : EINVAL;
727 err = (PAGE_SIZE >= blen) ? 0 : EINVAL;
731 err = (blen == 0) ? 0 : EINVAL;
735 err = (blen == 0) ? 0 : EINVAL;
739 err = (blen == 0) ? 0 : EINVAL;
743 err = (blen == sizeof(struct fuse_open_out)) ? 0 : EINVAL;
747 err = (((struct fuse_read_in *)(
748 (char *)ftick->tk_ms_fiov.base +
749 sizeof(struct fuse_in_header)
750 ))->size >= blen) ? 0 : EINVAL;
754 err = (blen == sizeof(struct fuse_write_out)) ? 0 : EINVAL;
758 if (fuse_libabi_geq(ftick->tk_data, 7, 4)) {
759 err = (blen == sizeof(struct fuse_statfs_out)) ?
762 err = (blen == FUSE_COMPAT_STATFS_SIZE) ? 0 : EINVAL;
767 err = (blen == 0) ? 0 : EINVAL;
771 err = (blen == 0) ? 0 : EINVAL;
775 err = (blen == 0) ? 0 : EINVAL;
781 * These can have varying response lengths, and 0 length
782 * isn't necessarily invalid.
787 case FUSE_REMOVEXATTR:
788 err = (blen == 0) ? 0 : EINVAL;
792 err = (blen == 0) ? 0 : EINVAL;
796 if (blen == sizeof(struct fuse_init_out) ||
797 blen == FUSE_COMPAT_INIT_OUT_SIZE ||
798 blen == FUSE_COMPAT_22_INIT_OUT_SIZE) {
806 err = (blen == sizeof(struct fuse_open_out)) ? 0 : EINVAL;
810 err = (((struct fuse_read_in *)(
811 (char *)ftick->tk_ms_fiov.base +
812 sizeof(struct fuse_in_header)
813 ))->size >= blen) ? 0 : EINVAL;
816 case FUSE_RELEASEDIR:
817 err = (blen == 0) ? 0 : EINVAL;
821 err = (blen == 0) ? 0 : EINVAL;
825 err = (blen == sizeof(struct fuse_lk_out)) ? 0 : EINVAL;
829 err = (blen == 0) ? 0 : EINVAL;
833 err = (blen == 0) ? 0 : EINVAL;
837 err = (blen == 0) ? 0 : EINVAL;
841 if (fuse_libabi_geq(ftick->tk_data, 7, 9)) {
842 err = (blen == sizeof(struct fuse_entry_out) +
843 sizeof(struct fuse_open_out)) ? 0 : EINVAL;
845 err = (blen == FUSE_COMPAT_ENTRY_OUT_SIZE +
846 sizeof(struct fuse_open_out)) ? 0 : EINVAL;
851 err = (blen == 0) ? 0 : EINVAL;
855 err = (blen == sizeof(struct fuse_lseek_out)) ? 0 : EINVAL;
859 panic("FUSE: opcodes out of sync (%d)\n", opcode);
866 fuse_setup_ihead(struct fuse_in_header *ihead, struct fuse_ticket *ftick,
867 uint64_t nid, enum fuse_opcode op, size_t blen, pid_t pid,
870 ihead->len = sizeof(*ihead) + blen;
871 ihead->unique = ftick->tk_unique;
876 ihead->uid = cred->cr_uid;
877 ihead->gid = cred->cr_groups[0];
881 * fuse_standard_handler just pulls indata and wakes up pretender.
882 * Doesn't try to interpret data, that's left for the pretender.
883 * Though might do a basic size verification before the pull-in takes place
887 fuse_standard_handler(struct fuse_ticket *ftick, struct uio *uio)
891 err = fticket_pull(ftick, uio);
893 fuse_lck_mtx_lock(ftick->tk_aw_mtx);
895 if (!fticket_answered(ftick)) {
896 fticket_set_answered(ftick);
897 ftick->tk_aw_errno = err;
900 fuse_lck_mtx_unlock(ftick->tk_aw_mtx);
906 * Reinitialize a dispatcher from a pid and node id, without resizing or
907 * clearing its data buffers
910 fdisp_refresh_pid(struct fuse_dispatcher *fdip, enum fuse_opcode op,
911 struct mount *mp, uint64_t nid, pid_t pid, struct ucred *cred)
914 MPASS2(sizeof(fdip->finh) + fdip->iosize <= fdip->tick->tk_ms_fiov.len,
915 "Must use fdisp_make_pid to increase the size of the fiov");
916 fticket_reset(fdip->tick);
918 FUSE_DIMALLOC(&fdip->tick->tk_ms_fiov, fdip->finh,
919 fdip->indata, fdip->iosize);
921 fuse_setup_ihead(fdip->finh, fdip->tick, nid, op, fdip->iosize, pid,
925 /* Initialize a dispatcher from a pid and node id */
927 fdisp_make_pid(struct fuse_dispatcher *fdip, enum fuse_opcode op,
928 struct fuse_data *data, uint64_t nid, pid_t pid, struct ucred *cred)
931 fticket_refresh(fdip->tick);
933 fdip->tick = fuse_ticket_fetch(data);
936 /* FUSE_DIMALLOC will bzero the fiovs when it enlarges them */
937 FUSE_DIMALLOC(&fdip->tick->tk_ms_fiov, fdip->finh,
938 fdip->indata, fdip->iosize);
940 fuse_setup_ihead(fdip->finh, fdip->tick, nid, op, fdip->iosize, pid, cred);
944 fdisp_make(struct fuse_dispatcher *fdip, enum fuse_opcode op, struct mount *mp,
945 uint64_t nid, struct thread *td, struct ucred *cred)
947 struct fuse_data *data = fuse_get_mpdata(mp);
948 RECTIFY_TDCR(td, cred);
950 return fdisp_make_pid(fdip, op, data, nid, td->td_proc->p_pid, cred);
954 fdisp_make_vp(struct fuse_dispatcher *fdip, enum fuse_opcode op,
955 struct vnode *vp, struct thread *td, struct ucred *cred)
957 struct mount *mp = vnode_mount(vp);
958 struct fuse_data *data = fuse_get_mpdata(mp);
960 RECTIFY_TDCR(td, cred);
961 return fdisp_make_pid(fdip, op, data, VTOI(vp),
962 td->td_proc->p_pid, cred);
965 /* Refresh a fuse_dispatcher so it can be reused, but don't zero its data */
967 fdisp_refresh_vp(struct fuse_dispatcher *fdip, enum fuse_opcode op,
968 struct vnode *vp, struct thread *td, struct ucred *cred)
970 RECTIFY_TDCR(td, cred);
971 return fdisp_refresh_pid(fdip, op, vnode_mount(vp), VTOI(vp),
972 td->td_proc->p_pid, cred);
976 fdisp_refresh(struct fuse_dispatcher *fdip)
978 fticket_refresh(fdip->tick);
981 SDT_PROBE_DEFINE2(fusefs, , ipc, fdisp_wait_answ_error, "char*", "int");
984 fdisp_wait_answ(struct fuse_dispatcher *fdip)
989 fuse_insert_callback(fdip->tick, fuse_standard_handler);
990 fuse_insert_message(fdip->tick, false);
992 if ((err = fticket_wait_answer(fdip->tick))) {
993 fuse_lck_mtx_lock(fdip->tick->tk_aw_mtx);
995 if (fticket_answered(fdip->tick)) {
997 * Just between noticing the interrupt and getting here,
998 * the standard handler has completed his job.
999 * So we drop the ticket and exit as usual.
1001 SDT_PROBE2(fusefs, , ipc, fdisp_wait_answ_error,
1002 "IPC: interrupted, already answered", err);
1003 fuse_lck_mtx_unlock(fdip->tick->tk_aw_mtx);
1007 * So we were faster than the standard handler.
1008 * Then by setting the answered flag we get *him*
1009 * to drop the ticket.
1011 SDT_PROBE2(fusefs, , ipc, fdisp_wait_answ_error,
1012 "IPC: interrupted, setting to answered", err);
1013 fticket_set_answered(fdip->tick);
1014 fuse_lck_mtx_unlock(fdip->tick->tk_aw_mtx);
1019 if (fdip->tick->tk_aw_errno == ENOTCONN) {
1020 /* The daemon died while we were waiting for a response */
1023 } else if (fdip->tick->tk_aw_errno) {
1025 * There was some sort of communication error with the daemon
1026 * that the client wouldn't understand.
1028 SDT_PROBE2(fusefs, , ipc, fdisp_wait_answ_error,
1029 "IPC: explicit EIO-ing", fdip->tick->tk_aw_errno);
1033 if ((err = fdip->tick->tk_aw_ohead.error)) {
1034 SDT_PROBE2(fusefs, , ipc, fdisp_wait_answ_error,
1035 "IPC: setting status", fdip->tick->tk_aw_ohead.error);
1037 * This means a "proper" fuse syscall error.
1038 * We record this value so the caller will
1039 * be able to know it's not a boring messaging
1040 * failure, if she wishes so (and if not, she can
1041 * just simply propagate the return value of this routine).
1042 * [XXX Maybe a bitflag would do the job too,
1043 * if other flags needed, this will be converted thusly.]
1045 fdip->answ_stat = err;
1048 fdip->answ = fticket_resp(fdip->tick)->base;
1049 fdip->iosize = fticket_resp(fdip->tick)->len;
1060 ticket_zone = uma_zcreate("fuse_ticket", sizeof(struct fuse_ticket),
1061 fticket_ctor, fticket_dtor, fticket_init, fticket_fini,
1063 fuse_ticket_count = counter_u64_alloc(M_WAITOK);
1067 fuse_ipc_destroy(void)
1069 counter_u64_free(fuse_ticket_count);
1070 uma_zdestroy(ticket_zone);