2 FUSE: Filesystem in Userspace
3 Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu>
5 This program can be distributed under the terms of the GNU GPL.
11 #include <linux/init.h>
12 #include <linux/module.h>
13 #include <linux/poll.h>
14 #include <linux/sched/signal.h>
15 #include <linux/uio.h>
16 #include <linux/miscdevice.h>
17 #include <linux/pagemap.h>
18 #include <linux/file.h>
19 #include <linux/slab.h>
20 #include <linux/pipe_fs_i.h>
21 #include <linux/swap.h>
22 #include <linux/splice.h>
23 #include <linux/sched.h>
25 MODULE_ALIAS_MISCDEV(FUSE_MINOR
);
26 MODULE_ALIAS("devname:fuse");
28 /* Ordinary requests have even IDs, while interrupts IDs are odd */
29 #define FUSE_INT_REQ_BIT (1ULL << 0)
30 #define FUSE_REQ_ID_STEP (1ULL << 1)
32 static struct kmem_cache
*fuse_req_cachep
;
34 static struct fuse_dev
*fuse_get_dev(struct file
*file
)
37 * Lockless access is OK, because file->private data is set
38 * once during mount and is valid until the file is released.
40 return READ_ONCE(file
->private_data
);
43 static void fuse_request_init(struct fuse_mount
*fm
, struct fuse_req
*req
)
45 INIT_LIST_HEAD(&req
->list
);
46 INIT_LIST_HEAD(&req
->intr_entry
);
47 init_waitqueue_head(&req
->waitq
);
48 refcount_set(&req
->count
, 1);
49 __set_bit(FR_PENDING
, &req
->flags
);
53 static struct fuse_req
*fuse_request_alloc(struct fuse_mount
*fm
, gfp_t flags
)
55 struct fuse_req
*req
= kmem_cache_zalloc(fuse_req_cachep
, flags
);
57 fuse_request_init(fm
, req
);
62 static void fuse_request_free(struct fuse_req
*req
)
64 kmem_cache_free(fuse_req_cachep
, req
);
67 static void __fuse_get_request(struct fuse_req
*req
)
69 refcount_inc(&req
->count
);
72 /* Must be called with > 1 refcount */
73 static void __fuse_put_request(struct fuse_req
*req
)
75 refcount_dec(&req
->count
);
78 void fuse_set_initialized(struct fuse_conn
*fc
)
80 /* Make sure stores before this are seen on another CPU */
85 static bool fuse_block_alloc(struct fuse_conn
*fc
, bool for_background
)
87 return !fc
->initialized
|| (for_background
&& fc
->blocked
);
90 static void fuse_drop_waiting(struct fuse_conn
*fc
)
93 * lockess check of fc->connected is okay, because atomic_dec_and_test()
94 * provides a memory barrier mached with the one in fuse_wait_aborted()
95 * to ensure no wake-up is missed.
97 if (atomic_dec_and_test(&fc
->num_waiting
) &&
98 !READ_ONCE(fc
->connected
)) {
99 /* wake up aborters */
100 wake_up_all(&fc
->blocked_waitq
);
104 static void fuse_put_request(struct fuse_req
*req
);
106 static struct fuse_req
*fuse_get_req(struct fuse_mount
*fm
, bool for_background
)
108 struct fuse_conn
*fc
= fm
->fc
;
109 struct fuse_req
*req
;
111 atomic_inc(&fc
->num_waiting
);
113 if (fuse_block_alloc(fc
, for_background
)) {
115 if (wait_event_killable_exclusive(fc
->blocked_waitq
,
116 !fuse_block_alloc(fc
, for_background
)))
119 /* Matches smp_wmb() in fuse_set_initialized() */
130 req
= fuse_request_alloc(fm
, GFP_KERNEL
);
134 wake_up(&fc
->blocked_waitq
);
138 req
->in
.h
.uid
= from_kuid(fc
->user_ns
, current_fsuid());
139 req
->in
.h
.gid
= from_kgid(fc
->user_ns
, current_fsgid());
140 req
->in
.h
.pid
= pid_nr_ns(task_pid(current
), fc
->pid_ns
);
142 __set_bit(FR_WAITING
, &req
->flags
);
144 __set_bit(FR_BACKGROUND
, &req
->flags
);
146 if (unlikely(req
->in
.h
.uid
== ((uid_t
)-1) ||
147 req
->in
.h
.gid
== ((gid_t
)-1))) {
148 fuse_put_request(req
);
149 return ERR_PTR(-EOVERFLOW
);
154 fuse_drop_waiting(fc
);
158 static void fuse_put_request(struct fuse_req
*req
)
160 struct fuse_conn
*fc
= req
->fm
->fc
;
162 if (refcount_dec_and_test(&req
->count
)) {
163 if (test_bit(FR_BACKGROUND
, &req
->flags
)) {
165 * We get here in the unlikely case that a background
166 * request was allocated but not sent
168 spin_lock(&fc
->bg_lock
);
170 wake_up(&fc
->blocked_waitq
);
171 spin_unlock(&fc
->bg_lock
);
174 if (test_bit(FR_WAITING
, &req
->flags
)) {
175 __clear_bit(FR_WAITING
, &req
->flags
);
176 fuse_drop_waiting(fc
);
179 fuse_request_free(req
);
183 unsigned int fuse_len_args(unsigned int numargs
, struct fuse_arg
*args
)
188 for (i
= 0; i
< numargs
; i
++)
189 nbytes
+= args
[i
].size
;
193 EXPORT_SYMBOL_GPL(fuse_len_args
);
195 u64
fuse_get_unique(struct fuse_iqueue
*fiq
)
197 fiq
->reqctr
+= FUSE_REQ_ID_STEP
;
200 EXPORT_SYMBOL_GPL(fuse_get_unique
);
202 static unsigned int fuse_req_hash(u64 unique
)
204 return hash_long(unique
& ~FUSE_INT_REQ_BIT
, FUSE_PQ_HASH_BITS
);
208 * A new request is available, wake fiq->waitq
210 static void fuse_dev_wake_and_unlock(struct fuse_iqueue
*fiq
)
211 __releases(fiq
->lock
)
213 wake_up(&fiq
->waitq
);
214 kill_fasync(&fiq
->fasync
, SIGIO
, POLL_IN
);
215 spin_unlock(&fiq
->lock
);
218 const struct fuse_iqueue_ops fuse_dev_fiq_ops
= {
219 .wake_forget_and_unlock
= fuse_dev_wake_and_unlock
,
220 .wake_interrupt_and_unlock
= fuse_dev_wake_and_unlock
,
221 .wake_pending_and_unlock
= fuse_dev_wake_and_unlock
,
223 EXPORT_SYMBOL_GPL(fuse_dev_fiq_ops
);
225 static void queue_request_and_unlock(struct fuse_iqueue
*fiq
,
226 struct fuse_req
*req
)
227 __releases(fiq
->lock
)
229 req
->in
.h
.len
= sizeof(struct fuse_in_header
) +
230 fuse_len_args(req
->args
->in_numargs
,
231 (struct fuse_arg
*) req
->args
->in_args
);
232 list_add_tail(&req
->list
, &fiq
->pending
);
233 fiq
->ops
->wake_pending_and_unlock(fiq
);
236 void fuse_queue_forget(struct fuse_conn
*fc
, struct fuse_forget_link
*forget
,
237 u64 nodeid
, u64 nlookup
)
239 struct fuse_iqueue
*fiq
= &fc
->iq
;
241 forget
->forget_one
.nodeid
= nodeid
;
242 forget
->forget_one
.nlookup
= nlookup
;
244 spin_lock(&fiq
->lock
);
245 if (fiq
->connected
) {
246 fiq
->forget_list_tail
->next
= forget
;
247 fiq
->forget_list_tail
= forget
;
248 fiq
->ops
->wake_forget_and_unlock(fiq
);
251 spin_unlock(&fiq
->lock
);
255 static void flush_bg_queue(struct fuse_conn
*fc
)
257 struct fuse_iqueue
*fiq
= &fc
->iq
;
259 while (fc
->active_background
< fc
->max_background
&&
260 !list_empty(&fc
->bg_queue
)) {
261 struct fuse_req
*req
;
263 req
= list_first_entry(&fc
->bg_queue
, struct fuse_req
, list
);
264 list_del(&req
->list
);
265 fc
->active_background
++;
266 spin_lock(&fiq
->lock
);
267 req
->in
.h
.unique
= fuse_get_unique(fiq
);
268 queue_request_and_unlock(fiq
, req
);
273 * This function is called when a request is finished. Either a reply
274 * has arrived or it was aborted (and not yet sent) or some error
275 * occurred during communication with userspace, or the device file
276 * was closed. The requester thread is woken up (if still waiting),
277 * the 'end' callback is called if given, else the reference to the
278 * request is released
280 void fuse_request_end(struct fuse_req
*req
)
282 struct fuse_mount
*fm
= req
->fm
;
283 struct fuse_conn
*fc
= fm
->fc
;
284 struct fuse_iqueue
*fiq
= &fc
->iq
;
286 if (test_and_set_bit(FR_FINISHED
, &req
->flags
))
290 * test_and_set_bit() implies smp_mb() between bit
291 * changing and below intr_entry check. Pairs with
292 * smp_mb() from queue_interrupt().
294 if (!list_empty(&req
->intr_entry
)) {
295 spin_lock(&fiq
->lock
);
296 list_del_init(&req
->intr_entry
);
297 spin_unlock(&fiq
->lock
);
299 WARN_ON(test_bit(FR_PENDING
, &req
->flags
));
300 WARN_ON(test_bit(FR_SENT
, &req
->flags
));
301 if (test_bit(FR_BACKGROUND
, &req
->flags
)) {
302 spin_lock(&fc
->bg_lock
);
303 clear_bit(FR_BACKGROUND
, &req
->flags
);
304 if (fc
->num_background
== fc
->max_background
) {
306 wake_up(&fc
->blocked_waitq
);
307 } else if (!fc
->blocked
) {
309 * Wake up next waiter, if any. It's okay to use
310 * waitqueue_active(), as we've already synced up
311 * fc->blocked with waiters with the wake_up() call
314 if (waitqueue_active(&fc
->blocked_waitq
))
315 wake_up(&fc
->blocked_waitq
);
318 if (fc
->num_background
== fc
->congestion_threshold
&& fm
->sb
) {
319 clear_bdi_congested(fm
->sb
->s_bdi
, BLK_RW_SYNC
);
320 clear_bdi_congested(fm
->sb
->s_bdi
, BLK_RW_ASYNC
);
322 fc
->num_background
--;
323 fc
->active_background
--;
325 spin_unlock(&fc
->bg_lock
);
327 /* Wake up waiter sleeping in request_wait_answer() */
328 wake_up(&req
->waitq
);
331 if (test_bit(FR_ASYNC
, &req
->flags
))
332 req
->args
->end(fm
, req
->args
, req
->out
.h
.error
);
334 fuse_put_request(req
);
336 EXPORT_SYMBOL_GPL(fuse_request_end
);
338 static int queue_interrupt(struct fuse_req
*req
)
340 struct fuse_iqueue
*fiq
= &req
->fm
->fc
->iq
;
342 spin_lock(&fiq
->lock
);
343 /* Check for we've sent request to interrupt this req */
344 if (unlikely(!test_bit(FR_INTERRUPTED
, &req
->flags
))) {
345 spin_unlock(&fiq
->lock
);
349 if (list_empty(&req
->intr_entry
)) {
350 list_add_tail(&req
->intr_entry
, &fiq
->interrupts
);
352 * Pairs with smp_mb() implied by test_and_set_bit()
353 * from fuse_request_end().
356 if (test_bit(FR_FINISHED
, &req
->flags
)) {
357 list_del_init(&req
->intr_entry
);
358 spin_unlock(&fiq
->lock
);
361 fiq
->ops
->wake_interrupt_and_unlock(fiq
);
363 spin_unlock(&fiq
->lock
);
368 static void request_wait_answer(struct fuse_req
*req
)
370 struct fuse_conn
*fc
= req
->fm
->fc
;
371 struct fuse_iqueue
*fiq
= &fc
->iq
;
374 if (!fc
->no_interrupt
) {
375 /* Any signal may interrupt this */
376 err
= wait_event_interruptible(req
->waitq
,
377 test_bit(FR_FINISHED
, &req
->flags
));
381 set_bit(FR_INTERRUPTED
, &req
->flags
);
382 /* matches barrier in fuse_dev_do_read() */
383 smp_mb__after_atomic();
384 if (test_bit(FR_SENT
, &req
->flags
))
385 queue_interrupt(req
);
388 if (!test_bit(FR_FORCE
, &req
->flags
)) {
389 /* Only fatal signals may interrupt this */
390 err
= wait_event_killable(req
->waitq
,
391 test_bit(FR_FINISHED
, &req
->flags
));
395 spin_lock(&fiq
->lock
);
396 /* Request is not yet in userspace, bail out */
397 if (test_bit(FR_PENDING
, &req
->flags
)) {
398 list_del(&req
->list
);
399 spin_unlock(&fiq
->lock
);
400 __fuse_put_request(req
);
401 req
->out
.h
.error
= -EINTR
;
404 spin_unlock(&fiq
->lock
);
408 * Either request is already in userspace, or it was forced.
411 wait_event(req
->waitq
, test_bit(FR_FINISHED
, &req
->flags
));
414 static void __fuse_request_send(struct fuse_req
*req
)
416 struct fuse_iqueue
*fiq
= &req
->fm
->fc
->iq
;
418 BUG_ON(test_bit(FR_BACKGROUND
, &req
->flags
));
419 spin_lock(&fiq
->lock
);
420 if (!fiq
->connected
) {
421 spin_unlock(&fiq
->lock
);
422 req
->out
.h
.error
= -ENOTCONN
;
424 req
->in
.h
.unique
= fuse_get_unique(fiq
);
425 /* acquire extra reference, since request is still needed
426 after fuse_request_end() */
427 __fuse_get_request(req
);
428 queue_request_and_unlock(fiq
, req
);
430 request_wait_answer(req
);
431 /* Pairs with smp_wmb() in fuse_request_end() */
436 static void fuse_adjust_compat(struct fuse_conn
*fc
, struct fuse_args
*args
)
438 if (fc
->minor
< 4 && args
->opcode
== FUSE_STATFS
)
439 args
->out_args
[0].size
= FUSE_COMPAT_STATFS_SIZE
;
442 switch (args
->opcode
) {
449 args
->out_args
[0].size
= FUSE_COMPAT_ENTRY_OUT_SIZE
;
453 args
->out_args
[0].size
= FUSE_COMPAT_ATTR_OUT_SIZE
;
457 if (fc
->minor
< 12) {
458 switch (args
->opcode
) {
460 args
->in_args
[0].size
= sizeof(struct fuse_open_in
);
463 args
->in_args
[0].size
= FUSE_COMPAT_MKNOD_IN_SIZE
;
469 static void fuse_force_creds(struct fuse_req
*req
)
471 struct fuse_conn
*fc
= req
->fm
->fc
;
473 req
->in
.h
.uid
= from_kuid_munged(fc
->user_ns
, current_fsuid());
474 req
->in
.h
.gid
= from_kgid_munged(fc
->user_ns
, current_fsgid());
475 req
->in
.h
.pid
= pid_nr_ns(task_pid(current
), fc
->pid_ns
);
478 static void fuse_args_to_req(struct fuse_req
*req
, struct fuse_args
*args
)
480 req
->in
.h
.opcode
= args
->opcode
;
481 req
->in
.h
.nodeid
= args
->nodeid
;
484 __set_bit(FR_ASYNC
, &req
->flags
);
487 ssize_t
fuse_simple_request(struct fuse_mount
*fm
, struct fuse_args
*args
)
489 struct fuse_conn
*fc
= fm
->fc
;
490 struct fuse_req
*req
;
494 atomic_inc(&fc
->num_waiting
);
495 req
= fuse_request_alloc(fm
, GFP_KERNEL
| __GFP_NOFAIL
);
498 fuse_force_creds(req
);
500 __set_bit(FR_WAITING
, &req
->flags
);
501 __set_bit(FR_FORCE
, &req
->flags
);
503 WARN_ON(args
->nocreds
);
504 req
= fuse_get_req(fm
, false);
509 /* Needs to be done after fuse_get_req() so that fc->minor is valid */
510 fuse_adjust_compat(fc
, args
);
511 fuse_args_to_req(req
, args
);
514 __set_bit(FR_ISREPLY
, &req
->flags
);
515 __fuse_request_send(req
);
516 ret
= req
->out
.h
.error
;
517 if (!ret
&& args
->out_argvar
) {
518 BUG_ON(args
->out_numargs
== 0);
519 ret
= args
->out_args
[args
->out_numargs
- 1].size
;
521 fuse_put_request(req
);
526 static bool fuse_request_queue_background(struct fuse_req
*req
)
528 struct fuse_mount
*fm
= req
->fm
;
529 struct fuse_conn
*fc
= fm
->fc
;
532 WARN_ON(!test_bit(FR_BACKGROUND
, &req
->flags
));
533 if (!test_bit(FR_WAITING
, &req
->flags
)) {
534 __set_bit(FR_WAITING
, &req
->flags
);
535 atomic_inc(&fc
->num_waiting
);
537 __set_bit(FR_ISREPLY
, &req
->flags
);
538 spin_lock(&fc
->bg_lock
);
539 if (likely(fc
->connected
)) {
540 fc
->num_background
++;
541 if (fc
->num_background
== fc
->max_background
)
543 if (fc
->num_background
== fc
->congestion_threshold
&& fm
->sb
) {
544 set_bdi_congested(fm
->sb
->s_bdi
, BLK_RW_SYNC
);
545 set_bdi_congested(fm
->sb
->s_bdi
, BLK_RW_ASYNC
);
547 list_add_tail(&req
->list
, &fc
->bg_queue
);
551 spin_unlock(&fc
->bg_lock
);
556 int fuse_simple_background(struct fuse_mount
*fm
, struct fuse_args
*args
,
559 struct fuse_req
*req
;
562 WARN_ON(!args
->nocreds
);
563 req
= fuse_request_alloc(fm
, gfp_flags
);
566 __set_bit(FR_BACKGROUND
, &req
->flags
);
568 WARN_ON(args
->nocreds
);
569 req
= fuse_get_req(fm
, true);
574 fuse_args_to_req(req
, args
);
576 if (!fuse_request_queue_background(req
)) {
577 fuse_put_request(req
);
583 EXPORT_SYMBOL_GPL(fuse_simple_background
);
585 static int fuse_simple_notify_reply(struct fuse_mount
*fm
,
586 struct fuse_args
*args
, u64 unique
)
588 struct fuse_req
*req
;
589 struct fuse_iqueue
*fiq
= &fm
->fc
->iq
;
592 req
= fuse_get_req(fm
, false);
596 __clear_bit(FR_ISREPLY
, &req
->flags
);
597 req
->in
.h
.unique
= unique
;
599 fuse_args_to_req(req
, args
);
601 spin_lock(&fiq
->lock
);
602 if (fiq
->connected
) {
603 queue_request_and_unlock(fiq
, req
);
606 spin_unlock(&fiq
->lock
);
607 fuse_put_request(req
);
614 * Lock the request. Up to the next unlock_request() there mustn't be
615 * anything that could cause a page-fault. If the request was already
618 static int lock_request(struct fuse_req
*req
)
622 spin_lock(&req
->waitq
.lock
);
623 if (test_bit(FR_ABORTED
, &req
->flags
))
626 set_bit(FR_LOCKED
, &req
->flags
);
627 spin_unlock(&req
->waitq
.lock
);
633 * Unlock request. If it was aborted while locked, caller is responsible
634 * for unlocking and ending the request.
636 static int unlock_request(struct fuse_req
*req
)
640 spin_lock(&req
->waitq
.lock
);
641 if (test_bit(FR_ABORTED
, &req
->flags
))
644 clear_bit(FR_LOCKED
, &req
->flags
);
645 spin_unlock(&req
->waitq
.lock
);
650 struct fuse_copy_state
{
652 struct fuse_req
*req
;
653 struct iov_iter
*iter
;
654 struct pipe_buffer
*pipebufs
;
655 struct pipe_buffer
*currbuf
;
656 struct pipe_inode_info
*pipe
;
657 unsigned long nr_segs
;
661 unsigned move_pages
:1;
664 static void fuse_copy_init(struct fuse_copy_state
*cs
, int write
,
665 struct iov_iter
*iter
)
667 memset(cs
, 0, sizeof(*cs
));
672 /* Unmap and put previous page of userspace buffer */
673 static void fuse_copy_finish(struct fuse_copy_state
*cs
)
676 struct pipe_buffer
*buf
= cs
->currbuf
;
679 buf
->len
= PAGE_SIZE
- cs
->len
;
683 flush_dcache_page(cs
->pg
);
684 set_page_dirty_lock(cs
->pg
);
692 * Get another pagefull of userspace buffer, and map it to kernel
693 * address space, and lock request
695 static int fuse_copy_fill(struct fuse_copy_state
*cs
)
700 err
= unlock_request(cs
->req
);
704 fuse_copy_finish(cs
);
706 struct pipe_buffer
*buf
= cs
->pipebufs
;
709 err
= pipe_buf_confirm(cs
->pipe
, buf
);
713 BUG_ON(!cs
->nr_segs
);
716 cs
->offset
= buf
->offset
;
721 if (cs
->nr_segs
>= cs
->pipe
->max_usage
)
724 page
= alloc_page(GFP_HIGHUSER
);
741 err
= iov_iter_get_pages(cs
->iter
, &page
, PAGE_SIZE
, 1, &off
);
748 iov_iter_advance(cs
->iter
, err
);
751 return lock_request(cs
->req
);
754 /* Do as much copy to/from userspace buffer as we can */
755 static int fuse_copy_do(struct fuse_copy_state
*cs
, void **val
, unsigned *size
)
757 unsigned ncpy
= min(*size
, cs
->len
);
759 void *pgaddr
= kmap_atomic(cs
->pg
);
760 void *buf
= pgaddr
+ cs
->offset
;
763 memcpy(buf
, *val
, ncpy
);
765 memcpy(*val
, buf
, ncpy
);
767 kunmap_atomic(pgaddr
);
776 static int fuse_check_page(struct page
*page
)
778 if (page_mapcount(page
) ||
779 page
->mapping
!= NULL
||
780 (page
->flags
& PAGE_FLAGS_CHECK_AT_PREP
&
788 dump_page(page
, "fuse: trying to steal weird page");
794 static int fuse_try_move_page(struct fuse_copy_state
*cs
, struct page
**pagep
)
797 struct page
*oldpage
= *pagep
;
798 struct page
*newpage
;
799 struct pipe_buffer
*buf
= cs
->pipebufs
;
802 err
= unlock_request(cs
->req
);
806 fuse_copy_finish(cs
);
808 err
= pipe_buf_confirm(cs
->pipe
, buf
);
812 BUG_ON(!cs
->nr_segs
);
818 if (cs
->len
!= PAGE_SIZE
)
821 if (!pipe_buf_try_steal(cs
->pipe
, buf
))
826 if (!PageUptodate(newpage
))
827 SetPageUptodate(newpage
);
829 ClearPageMappedToDisk(newpage
);
831 if (fuse_check_page(newpage
) != 0)
832 goto out_fallback_unlock
;
835 * This is a new and locked page, it shouldn't be mapped or
836 * have any special flags on it
838 if (WARN_ON(page_mapped(oldpage
)))
839 goto out_fallback_unlock
;
840 if (WARN_ON(page_has_private(oldpage
)))
841 goto out_fallback_unlock
;
842 if (WARN_ON(PageDirty(oldpage
) || PageWriteback(oldpage
)))
843 goto out_fallback_unlock
;
844 if (WARN_ON(PageMlocked(oldpage
)))
845 goto out_fallback_unlock
;
847 err
= replace_page_cache_page(oldpage
, newpage
, GFP_KERNEL
);
849 unlock_page(newpage
);
855 if (!(buf
->flags
& PIPE_BUF_FLAG_LRU
))
856 lru_cache_add(newpage
);
859 spin_lock(&cs
->req
->waitq
.lock
);
860 if (test_bit(FR_ABORTED
, &cs
->req
->flags
))
864 spin_unlock(&cs
->req
->waitq
.lock
);
867 unlock_page(newpage
);
872 unlock_page(oldpage
);
873 /* Drop ref for ap->pages[] array */
879 /* Drop ref obtained in this function */
884 unlock_page(newpage
);
887 cs
->offset
= buf
->offset
;
889 err
= lock_request(cs
->req
);
896 static int fuse_ref_page(struct fuse_copy_state
*cs
, struct page
*page
,
897 unsigned offset
, unsigned count
)
899 struct pipe_buffer
*buf
;
902 if (cs
->nr_segs
>= cs
->pipe
->max_usage
)
906 err
= unlock_request(cs
->req
);
912 fuse_copy_finish(cs
);
916 buf
->offset
= offset
;
927 * Copy a page in the request to/from the userspace buffer. Must be
930 static int fuse_copy_page(struct fuse_copy_state
*cs
, struct page
**pagep
,
931 unsigned offset
, unsigned count
, int zeroing
)
934 struct page
*page
= *pagep
;
936 if (page
&& zeroing
&& count
< PAGE_SIZE
)
937 clear_highpage(page
);
940 if (cs
->write
&& cs
->pipebufs
&& page
) {
941 return fuse_ref_page(cs
, page
, offset
, count
);
942 } else if (!cs
->len
) {
943 if (cs
->move_pages
&& page
&&
944 offset
== 0 && count
== PAGE_SIZE
) {
945 err
= fuse_try_move_page(cs
, pagep
);
949 err
= fuse_copy_fill(cs
);
955 void *mapaddr
= kmap_atomic(page
);
956 void *buf
= mapaddr
+ offset
;
957 offset
+= fuse_copy_do(cs
, &buf
, &count
);
958 kunmap_atomic(mapaddr
);
960 offset
+= fuse_copy_do(cs
, NULL
, &count
);
962 if (page
&& !cs
->write
)
963 flush_dcache_page(page
);
967 /* Copy pages in the request to/from userspace buffer */
968 static int fuse_copy_pages(struct fuse_copy_state
*cs
, unsigned nbytes
,
972 struct fuse_req
*req
= cs
->req
;
973 struct fuse_args_pages
*ap
= container_of(req
->args
, typeof(*ap
), args
);
976 for (i
= 0; i
< ap
->num_pages
&& (nbytes
|| zeroing
); i
++) {
978 unsigned int offset
= ap
->descs
[i
].offset
;
979 unsigned int count
= min(nbytes
, ap
->descs
[i
].length
);
981 err
= fuse_copy_page(cs
, &ap
->pages
[i
], offset
, count
, zeroing
);
990 /* Copy a single argument in the request to/from userspace buffer */
991 static int fuse_copy_one(struct fuse_copy_state
*cs
, void *val
, unsigned size
)
995 int err
= fuse_copy_fill(cs
);
999 fuse_copy_do(cs
, &val
, &size
);
1004 /* Copy request arguments to/from userspace buffer */
1005 static int fuse_copy_args(struct fuse_copy_state
*cs
, unsigned numargs
,
1006 unsigned argpages
, struct fuse_arg
*args
,
1012 for (i
= 0; !err
&& i
< numargs
; i
++) {
1013 struct fuse_arg
*arg
= &args
[i
];
1014 if (i
== numargs
- 1 && argpages
)
1015 err
= fuse_copy_pages(cs
, arg
->size
, zeroing
);
1017 err
= fuse_copy_one(cs
, arg
->value
, arg
->size
);
1022 static int forget_pending(struct fuse_iqueue
*fiq
)
1024 return fiq
->forget_list_head
.next
!= NULL
;
1027 static int request_pending(struct fuse_iqueue
*fiq
)
1029 return !list_empty(&fiq
->pending
) || !list_empty(&fiq
->interrupts
) ||
1030 forget_pending(fiq
);
1034 * Transfer an interrupt request to userspace
1036 * Unlike other requests this is assembled on demand, without a need
1037 * to allocate a separate fuse_req structure.
1039 * Called with fiq->lock held, releases it
1041 static int fuse_read_interrupt(struct fuse_iqueue
*fiq
,
1042 struct fuse_copy_state
*cs
,
1043 size_t nbytes
, struct fuse_req
*req
)
1044 __releases(fiq
->lock
)
1046 struct fuse_in_header ih
;
1047 struct fuse_interrupt_in arg
;
1048 unsigned reqsize
= sizeof(ih
) + sizeof(arg
);
1051 list_del_init(&req
->intr_entry
);
1052 memset(&ih
, 0, sizeof(ih
));
1053 memset(&arg
, 0, sizeof(arg
));
1055 ih
.opcode
= FUSE_INTERRUPT
;
1056 ih
.unique
= (req
->in
.h
.unique
| FUSE_INT_REQ_BIT
);
1057 arg
.unique
= req
->in
.h
.unique
;
1059 spin_unlock(&fiq
->lock
);
1060 if (nbytes
< reqsize
)
1063 err
= fuse_copy_one(cs
, &ih
, sizeof(ih
));
1065 err
= fuse_copy_one(cs
, &arg
, sizeof(arg
));
1066 fuse_copy_finish(cs
);
1068 return err
? err
: reqsize
;
1071 struct fuse_forget_link
*fuse_dequeue_forget(struct fuse_iqueue
*fiq
,
1073 unsigned int *countp
)
1075 struct fuse_forget_link
*head
= fiq
->forget_list_head
.next
;
1076 struct fuse_forget_link
**newhead
= &head
;
1079 for (count
= 0; *newhead
!= NULL
&& count
< max
; count
++)
1080 newhead
= &(*newhead
)->next
;
1082 fiq
->forget_list_head
.next
= *newhead
;
1084 if (fiq
->forget_list_head
.next
== NULL
)
1085 fiq
->forget_list_tail
= &fiq
->forget_list_head
;
1092 EXPORT_SYMBOL(fuse_dequeue_forget
);
1094 static int fuse_read_single_forget(struct fuse_iqueue
*fiq
,
1095 struct fuse_copy_state
*cs
,
1097 __releases(fiq
->lock
)
1100 struct fuse_forget_link
*forget
= fuse_dequeue_forget(fiq
, 1, NULL
);
1101 struct fuse_forget_in arg
= {
1102 .nlookup
= forget
->forget_one
.nlookup
,
1104 struct fuse_in_header ih
= {
1105 .opcode
= FUSE_FORGET
,
1106 .nodeid
= forget
->forget_one
.nodeid
,
1107 .unique
= fuse_get_unique(fiq
),
1108 .len
= sizeof(ih
) + sizeof(arg
),
1111 spin_unlock(&fiq
->lock
);
1113 if (nbytes
< ih
.len
)
1116 err
= fuse_copy_one(cs
, &ih
, sizeof(ih
));
1118 err
= fuse_copy_one(cs
, &arg
, sizeof(arg
));
1119 fuse_copy_finish(cs
);
1127 static int fuse_read_batch_forget(struct fuse_iqueue
*fiq
,
1128 struct fuse_copy_state
*cs
, size_t nbytes
)
1129 __releases(fiq
->lock
)
1132 unsigned max_forgets
;
1134 struct fuse_forget_link
*head
;
1135 struct fuse_batch_forget_in arg
= { .count
= 0 };
1136 struct fuse_in_header ih
= {
1137 .opcode
= FUSE_BATCH_FORGET
,
1138 .unique
= fuse_get_unique(fiq
),
1139 .len
= sizeof(ih
) + sizeof(arg
),
1142 if (nbytes
< ih
.len
) {
1143 spin_unlock(&fiq
->lock
);
1147 max_forgets
= (nbytes
- ih
.len
) / sizeof(struct fuse_forget_one
);
1148 head
= fuse_dequeue_forget(fiq
, max_forgets
, &count
);
1149 spin_unlock(&fiq
->lock
);
1152 ih
.len
+= count
* sizeof(struct fuse_forget_one
);
1153 err
= fuse_copy_one(cs
, &ih
, sizeof(ih
));
1155 err
= fuse_copy_one(cs
, &arg
, sizeof(arg
));
1158 struct fuse_forget_link
*forget
= head
;
1161 err
= fuse_copy_one(cs
, &forget
->forget_one
,
1162 sizeof(forget
->forget_one
));
1164 head
= forget
->next
;
1168 fuse_copy_finish(cs
);
1176 static int fuse_read_forget(struct fuse_conn
*fc
, struct fuse_iqueue
*fiq
,
1177 struct fuse_copy_state
*cs
,
1179 __releases(fiq
->lock
)
1181 if (fc
->minor
< 16 || fiq
->forget_list_head
.next
->next
== NULL
)
1182 return fuse_read_single_forget(fiq
, cs
, nbytes
);
1184 return fuse_read_batch_forget(fiq
, cs
, nbytes
);
1188 * Read a single request into the userspace filesystem's buffer. This
1189 * function waits until a request is available, then removes it from
1190 * the pending list and copies request data to userspace buffer. If
1191 * no reply is needed (FORGET) or request has been aborted or there
1192 * was an error during the copying then it's finished by calling
1193 * fuse_request_end(). Otherwise add it to the processing list, and set
1196 static ssize_t
fuse_dev_do_read(struct fuse_dev
*fud
, struct file
*file
,
1197 struct fuse_copy_state
*cs
, size_t nbytes
)
1200 struct fuse_conn
*fc
= fud
->fc
;
1201 struct fuse_iqueue
*fiq
= &fc
->iq
;
1202 struct fuse_pqueue
*fpq
= &fud
->pq
;
1203 struct fuse_req
*req
;
1204 struct fuse_args
*args
;
1209 * Require sane minimum read buffer - that has capacity for fixed part
1210 * of any request header + negotiated max_write room for data.
1212 * Historically libfuse reserves 4K for fixed header room, but e.g.
1213 * GlusterFS reserves only 80 bytes
1215 * = `sizeof(fuse_in_header) + sizeof(fuse_write_in)`
1217 * which is the absolute minimum any sane filesystem should be using
1220 if (nbytes
< max_t(size_t, FUSE_MIN_READ_BUFFER
,
1221 sizeof(struct fuse_in_header
) +
1222 sizeof(struct fuse_write_in
) +
1228 spin_lock(&fiq
->lock
);
1229 if (!fiq
->connected
|| request_pending(fiq
))
1231 spin_unlock(&fiq
->lock
);
1233 if (file
->f_flags
& O_NONBLOCK
)
1235 err
= wait_event_interruptible_exclusive(fiq
->waitq
,
1236 !fiq
->connected
|| request_pending(fiq
));
1241 if (!fiq
->connected
) {
1242 err
= fc
->aborted
? -ECONNABORTED
: -ENODEV
;
1246 if (!list_empty(&fiq
->interrupts
)) {
1247 req
= list_entry(fiq
->interrupts
.next
, struct fuse_req
,
1249 return fuse_read_interrupt(fiq
, cs
, nbytes
, req
);
1252 if (forget_pending(fiq
)) {
1253 if (list_empty(&fiq
->pending
) || fiq
->forget_batch
-- > 0)
1254 return fuse_read_forget(fc
, fiq
, cs
, nbytes
);
1256 if (fiq
->forget_batch
<= -8)
1257 fiq
->forget_batch
= 16;
1260 req
= list_entry(fiq
->pending
.next
, struct fuse_req
, list
);
1261 clear_bit(FR_PENDING
, &req
->flags
);
1262 list_del_init(&req
->list
);
1263 spin_unlock(&fiq
->lock
);
1266 reqsize
= req
->in
.h
.len
;
1268 /* If request is too large, reply with an error and restart the read */
1269 if (nbytes
< reqsize
) {
1270 req
->out
.h
.error
= -EIO
;
1271 /* SETXATTR is special, since it may contain too large data */
1272 if (args
->opcode
== FUSE_SETXATTR
)
1273 req
->out
.h
.error
= -E2BIG
;
1274 fuse_request_end(req
);
1277 spin_lock(&fpq
->lock
);
1278 list_add(&req
->list
, &fpq
->io
);
1279 spin_unlock(&fpq
->lock
);
1281 err
= fuse_copy_one(cs
, &req
->in
.h
, sizeof(req
->in
.h
));
1283 err
= fuse_copy_args(cs
, args
->in_numargs
, args
->in_pages
,
1284 (struct fuse_arg
*) args
->in_args
, 0);
1285 fuse_copy_finish(cs
);
1286 spin_lock(&fpq
->lock
);
1287 clear_bit(FR_LOCKED
, &req
->flags
);
1288 if (!fpq
->connected
) {
1289 err
= fc
->aborted
? -ECONNABORTED
: -ENODEV
;
1293 req
->out
.h
.error
= -EIO
;
1296 if (!test_bit(FR_ISREPLY
, &req
->flags
)) {
1300 hash
= fuse_req_hash(req
->in
.h
.unique
);
1301 list_move_tail(&req
->list
, &fpq
->processing
[hash
]);
1302 __fuse_get_request(req
);
1303 set_bit(FR_SENT
, &req
->flags
);
1304 spin_unlock(&fpq
->lock
);
1305 /* matches barrier in request_wait_answer() */
1306 smp_mb__after_atomic();
1307 if (test_bit(FR_INTERRUPTED
, &req
->flags
))
1308 queue_interrupt(req
);
1309 fuse_put_request(req
);
1314 if (!test_bit(FR_PRIVATE
, &req
->flags
))
1315 list_del_init(&req
->list
);
1316 spin_unlock(&fpq
->lock
);
1317 fuse_request_end(req
);
1321 spin_unlock(&fiq
->lock
);
1325 static int fuse_dev_open(struct inode
*inode
, struct file
*file
)
1328 * The fuse device's file's private_data is used to hold
1329 * the fuse_conn(ection) when it is mounted, and is used to
1330 * keep track of whether the file has been mounted already.
1332 file
->private_data
= NULL
;
1336 static ssize_t
fuse_dev_read(struct kiocb
*iocb
, struct iov_iter
*to
)
1338 struct fuse_copy_state cs
;
1339 struct file
*file
= iocb
->ki_filp
;
1340 struct fuse_dev
*fud
= fuse_get_dev(file
);
1345 if (!iter_is_iovec(to
))
1348 fuse_copy_init(&cs
, 1, to
);
1350 return fuse_dev_do_read(fud
, file
, &cs
, iov_iter_count(to
));
1353 static ssize_t
fuse_dev_splice_read(struct file
*in
, loff_t
*ppos
,
1354 struct pipe_inode_info
*pipe
,
1355 size_t len
, unsigned int flags
)
1359 struct pipe_buffer
*bufs
;
1360 struct fuse_copy_state cs
;
1361 struct fuse_dev
*fud
= fuse_get_dev(in
);
1366 bufs
= kvmalloc_array(pipe
->max_usage
, sizeof(struct pipe_buffer
),
1371 fuse_copy_init(&cs
, 1, NULL
);
1374 ret
= fuse_dev_do_read(fud
, in
, &cs
, len
);
1378 if (pipe_occupancy(pipe
->head
, pipe
->tail
) + cs
.nr_segs
> pipe
->max_usage
) {
1383 for (ret
= total
= 0; page_nr
< cs
.nr_segs
; total
+= ret
) {
1385 * Need to be careful about this. Having buf->ops in module
1386 * code can Oops if the buffer persists after module unload.
1388 bufs
[page_nr
].ops
= &nosteal_pipe_buf_ops
;
1389 bufs
[page_nr
].flags
= 0;
1390 ret
= add_to_pipe(pipe
, &bufs
[page_nr
++]);
1391 if (unlikely(ret
< 0))
1397 for (; page_nr
< cs
.nr_segs
; page_nr
++)
1398 put_page(bufs
[page_nr
].page
);
1404 static int fuse_notify_poll(struct fuse_conn
*fc
, unsigned int size
,
1405 struct fuse_copy_state
*cs
)
1407 struct fuse_notify_poll_wakeup_out outarg
;
1410 if (size
!= sizeof(outarg
))
1413 err
= fuse_copy_one(cs
, &outarg
, sizeof(outarg
));
1417 fuse_copy_finish(cs
);
1418 return fuse_notify_poll_wakeup(fc
, &outarg
);
1421 fuse_copy_finish(cs
);
1425 static int fuse_notify_inval_inode(struct fuse_conn
*fc
, unsigned int size
,
1426 struct fuse_copy_state
*cs
)
1428 struct fuse_notify_inval_inode_out outarg
;
1431 if (size
!= sizeof(outarg
))
1434 err
= fuse_copy_one(cs
, &outarg
, sizeof(outarg
));
1437 fuse_copy_finish(cs
);
1439 down_read(&fc
->killsb
);
1440 err
= fuse_reverse_inval_inode(fc
, outarg
.ino
,
1441 outarg
.off
, outarg
.len
);
1442 up_read(&fc
->killsb
);
1446 fuse_copy_finish(cs
);
1450 static int fuse_notify_inval_entry(struct fuse_conn
*fc
, unsigned int size
,
1451 struct fuse_copy_state
*cs
)
1453 struct fuse_notify_inval_entry_out outarg
;
1458 buf
= kzalloc(FUSE_NAME_MAX
+ 1, GFP_KERNEL
);
1463 if (size
< sizeof(outarg
))
1466 err
= fuse_copy_one(cs
, &outarg
, sizeof(outarg
));
1470 err
= -ENAMETOOLONG
;
1471 if (outarg
.namelen
> FUSE_NAME_MAX
)
1475 if (size
!= sizeof(outarg
) + outarg
.namelen
+ 1)
1479 name
.len
= outarg
.namelen
;
1480 err
= fuse_copy_one(cs
, buf
, outarg
.namelen
+ 1);
1483 fuse_copy_finish(cs
);
1484 buf
[outarg
.namelen
] = 0;
1486 down_read(&fc
->killsb
);
1487 err
= fuse_reverse_inval_entry(fc
, outarg
.parent
, 0, &name
);
1488 up_read(&fc
->killsb
);
1494 fuse_copy_finish(cs
);
1498 static int fuse_notify_delete(struct fuse_conn
*fc
, unsigned int size
,
1499 struct fuse_copy_state
*cs
)
1501 struct fuse_notify_delete_out outarg
;
1506 buf
= kzalloc(FUSE_NAME_MAX
+ 1, GFP_KERNEL
);
1511 if (size
< sizeof(outarg
))
1514 err
= fuse_copy_one(cs
, &outarg
, sizeof(outarg
));
1518 err
= -ENAMETOOLONG
;
1519 if (outarg
.namelen
> FUSE_NAME_MAX
)
1523 if (size
!= sizeof(outarg
) + outarg
.namelen
+ 1)
1527 name
.len
= outarg
.namelen
;
1528 err
= fuse_copy_one(cs
, buf
, outarg
.namelen
+ 1);
1531 fuse_copy_finish(cs
);
1532 buf
[outarg
.namelen
] = 0;
1534 down_read(&fc
->killsb
);
1535 err
= fuse_reverse_inval_entry(fc
, outarg
.parent
, outarg
.child
, &name
);
1536 up_read(&fc
->killsb
);
1542 fuse_copy_finish(cs
);
1546 static int fuse_notify_store(struct fuse_conn
*fc
, unsigned int size
,
1547 struct fuse_copy_state
*cs
)
1549 struct fuse_notify_store_out outarg
;
1550 struct inode
*inode
;
1551 struct address_space
*mapping
;
1555 unsigned int offset
;
1561 if (size
< sizeof(outarg
))
1564 err
= fuse_copy_one(cs
, &outarg
, sizeof(outarg
));
1569 if (size
- sizeof(outarg
) != outarg
.size
)
1572 nodeid
= outarg
.nodeid
;
1574 down_read(&fc
->killsb
);
1577 inode
= fuse_ilookup(fc
, nodeid
, NULL
);
1581 mapping
= inode
->i_mapping
;
1582 index
= outarg
.offset
>> PAGE_SHIFT
;
1583 offset
= outarg
.offset
& ~PAGE_MASK
;
1584 file_size
= i_size_read(inode
);
1585 end
= outarg
.offset
+ outarg
.size
;
1586 if (end
> file_size
) {
1588 fuse_write_update_size(inode
, file_size
);
1594 unsigned int this_num
;
1597 page
= find_or_create_page(mapping
, index
,
1598 mapping_gfp_mask(mapping
));
1602 this_num
= min_t(unsigned, num
, PAGE_SIZE
- offset
);
1603 err
= fuse_copy_page(cs
, &page
, offset
, this_num
, 0);
1604 if (!err
&& offset
== 0 &&
1605 (this_num
== PAGE_SIZE
|| file_size
== end
))
1606 SetPageUptodate(page
);
1623 up_read(&fc
->killsb
);
1625 fuse_copy_finish(cs
);
1629 struct fuse_retrieve_args
{
1630 struct fuse_args_pages ap
;
1631 struct fuse_notify_retrieve_in inarg
;
1634 static void fuse_retrieve_end(struct fuse_mount
*fm
, struct fuse_args
*args
,
1637 struct fuse_retrieve_args
*ra
=
1638 container_of(args
, typeof(*ra
), ap
.args
);
1640 release_pages(ra
->ap
.pages
, ra
->ap
.num_pages
);
1644 static int fuse_retrieve(struct fuse_mount
*fm
, struct inode
*inode
,
1645 struct fuse_notify_retrieve_out
*outarg
)
1648 struct address_space
*mapping
= inode
->i_mapping
;
1652 unsigned int offset
;
1653 size_t total_len
= 0;
1654 unsigned int num_pages
;
1655 struct fuse_conn
*fc
= fm
->fc
;
1656 struct fuse_retrieve_args
*ra
;
1657 size_t args_size
= sizeof(*ra
);
1658 struct fuse_args_pages
*ap
;
1659 struct fuse_args
*args
;
1661 offset
= outarg
->offset
& ~PAGE_MASK
;
1662 file_size
= i_size_read(inode
);
1664 num
= min(outarg
->size
, fc
->max_write
);
1665 if (outarg
->offset
> file_size
)
1667 else if (outarg
->offset
+ num
> file_size
)
1668 num
= file_size
- outarg
->offset
;
1670 num_pages
= (num
+ offset
+ PAGE_SIZE
- 1) >> PAGE_SHIFT
;
1671 num_pages
= min(num_pages
, fc
->max_pages
);
1673 args_size
+= num_pages
* (sizeof(ap
->pages
[0]) + sizeof(ap
->descs
[0]));
1675 ra
= kzalloc(args_size
, GFP_KERNEL
);
1680 ap
->pages
= (void *) (ra
+ 1);
1681 ap
->descs
= (void *) (ap
->pages
+ num_pages
);
1684 args
->nodeid
= outarg
->nodeid
;
1685 args
->opcode
= FUSE_NOTIFY_REPLY
;
1686 args
->in_numargs
= 2;
1687 args
->in_pages
= true;
1688 args
->end
= fuse_retrieve_end
;
1690 index
= outarg
->offset
>> PAGE_SHIFT
;
1692 while (num
&& ap
->num_pages
< num_pages
) {
1694 unsigned int this_num
;
1696 page
= find_get_page(mapping
, index
);
1700 this_num
= min_t(unsigned, num
, PAGE_SIZE
- offset
);
1701 ap
->pages
[ap
->num_pages
] = page
;
1702 ap
->descs
[ap
->num_pages
].offset
= offset
;
1703 ap
->descs
[ap
->num_pages
].length
= this_num
;
1708 total_len
+= this_num
;
1711 ra
->inarg
.offset
= outarg
->offset
;
1712 ra
->inarg
.size
= total_len
;
1713 args
->in_args
[0].size
= sizeof(ra
->inarg
);
1714 args
->in_args
[0].value
= &ra
->inarg
;
1715 args
->in_args
[1].size
= total_len
;
1717 err
= fuse_simple_notify_reply(fm
, args
, outarg
->notify_unique
);
1719 fuse_retrieve_end(fm
, args
, err
);
1724 static int fuse_notify_retrieve(struct fuse_conn
*fc
, unsigned int size
,
1725 struct fuse_copy_state
*cs
)
1727 struct fuse_notify_retrieve_out outarg
;
1728 struct fuse_mount
*fm
;
1729 struct inode
*inode
;
1734 if (size
!= sizeof(outarg
))
1737 err
= fuse_copy_one(cs
, &outarg
, sizeof(outarg
));
1741 fuse_copy_finish(cs
);
1743 down_read(&fc
->killsb
);
1745 nodeid
= outarg
.nodeid
;
1747 inode
= fuse_ilookup(fc
, nodeid
, &fm
);
1749 err
= fuse_retrieve(fm
, inode
, &outarg
);
1752 up_read(&fc
->killsb
);
1757 fuse_copy_finish(cs
);
1761 static int fuse_notify(struct fuse_conn
*fc
, enum fuse_notify_code code
,
1762 unsigned int size
, struct fuse_copy_state
*cs
)
1764 /* Don't try to move pages (yet) */
1768 case FUSE_NOTIFY_POLL
:
1769 return fuse_notify_poll(fc
, size
, cs
);
1771 case FUSE_NOTIFY_INVAL_INODE
:
1772 return fuse_notify_inval_inode(fc
, size
, cs
);
1774 case FUSE_NOTIFY_INVAL_ENTRY
:
1775 return fuse_notify_inval_entry(fc
, size
, cs
);
1777 case FUSE_NOTIFY_STORE
:
1778 return fuse_notify_store(fc
, size
, cs
);
1780 case FUSE_NOTIFY_RETRIEVE
:
1781 return fuse_notify_retrieve(fc
, size
, cs
);
1783 case FUSE_NOTIFY_DELETE
:
1784 return fuse_notify_delete(fc
, size
, cs
);
1787 fuse_copy_finish(cs
);
1792 /* Look up request on processing list by unique ID */
1793 static struct fuse_req
*request_find(struct fuse_pqueue
*fpq
, u64 unique
)
1795 unsigned int hash
= fuse_req_hash(unique
);
1796 struct fuse_req
*req
;
1798 list_for_each_entry(req
, &fpq
->processing
[hash
], list
) {
1799 if (req
->in
.h
.unique
== unique
)
1805 static int copy_out_args(struct fuse_copy_state
*cs
, struct fuse_args
*args
,
1808 unsigned reqsize
= sizeof(struct fuse_out_header
);
1810 reqsize
+= fuse_len_args(args
->out_numargs
, args
->out_args
);
1812 if (reqsize
< nbytes
|| (reqsize
> nbytes
&& !args
->out_argvar
))
1814 else if (reqsize
> nbytes
) {
1815 struct fuse_arg
*lastarg
= &args
->out_args
[args
->out_numargs
-1];
1816 unsigned diffsize
= reqsize
- nbytes
;
1818 if (diffsize
> lastarg
->size
)
1820 lastarg
->size
-= diffsize
;
1822 return fuse_copy_args(cs
, args
->out_numargs
, args
->out_pages
,
1823 args
->out_args
, args
->page_zeroing
);
1827 * Write a single reply to a request. First the header is copied from
1828 * the write buffer. The request is then searched on the processing
1829 * list by the unique ID found in the header. If found, then remove
1830 * it from the list and copy the rest of the buffer to the request.
1831 * The request is finished by calling fuse_request_end().
1833 static ssize_t
fuse_dev_do_write(struct fuse_dev
*fud
,
1834 struct fuse_copy_state
*cs
, size_t nbytes
)
1837 struct fuse_conn
*fc
= fud
->fc
;
1838 struct fuse_pqueue
*fpq
= &fud
->pq
;
1839 struct fuse_req
*req
;
1840 struct fuse_out_header oh
;
1843 if (nbytes
< sizeof(struct fuse_out_header
))
1846 err
= fuse_copy_one(cs
, &oh
, sizeof(oh
));
1851 if (oh
.len
!= nbytes
)
1855 * Zero oh.unique indicates unsolicited notification message
1856 * and error contains notification code.
1859 err
= fuse_notify(fc
, oh
.error
, nbytes
- sizeof(oh
), cs
);
1864 if (oh
.error
<= -1000 || oh
.error
> 0)
1867 spin_lock(&fpq
->lock
);
1870 req
= request_find(fpq
, oh
.unique
& ~FUSE_INT_REQ_BIT
);
1874 spin_unlock(&fpq
->lock
);
1878 /* Is it an interrupt reply ID? */
1879 if (oh
.unique
& FUSE_INT_REQ_BIT
) {
1880 __fuse_get_request(req
);
1881 spin_unlock(&fpq
->lock
);
1884 if (nbytes
!= sizeof(struct fuse_out_header
))
1886 else if (oh
.error
== -ENOSYS
)
1887 fc
->no_interrupt
= 1;
1888 else if (oh
.error
== -EAGAIN
)
1889 err
= queue_interrupt(req
);
1891 fuse_put_request(req
);
1896 clear_bit(FR_SENT
, &req
->flags
);
1897 list_move(&req
->list
, &fpq
->io
);
1899 set_bit(FR_LOCKED
, &req
->flags
);
1900 spin_unlock(&fpq
->lock
);
1902 if (!req
->args
->page_replace
)
1906 err
= nbytes
!= sizeof(oh
) ? -EINVAL
: 0;
1908 err
= copy_out_args(cs
, req
->args
, nbytes
);
1909 fuse_copy_finish(cs
);
1911 spin_lock(&fpq
->lock
);
1912 clear_bit(FR_LOCKED
, &req
->flags
);
1913 if (!fpq
->connected
)
1916 req
->out
.h
.error
= -EIO
;
1917 if (!test_bit(FR_PRIVATE
, &req
->flags
))
1918 list_del_init(&req
->list
);
1919 spin_unlock(&fpq
->lock
);
1921 fuse_request_end(req
);
1923 return err
? err
: nbytes
;
1926 fuse_copy_finish(cs
);
1930 static ssize_t
fuse_dev_write(struct kiocb
*iocb
, struct iov_iter
*from
)
1932 struct fuse_copy_state cs
;
1933 struct fuse_dev
*fud
= fuse_get_dev(iocb
->ki_filp
);
1938 if (!iter_is_iovec(from
))
1941 fuse_copy_init(&cs
, 0, from
);
1943 return fuse_dev_do_write(fud
, &cs
, iov_iter_count(from
));
1946 static ssize_t
fuse_dev_splice_write(struct pipe_inode_info
*pipe
,
1947 struct file
*out
, loff_t
*ppos
,
1948 size_t len
, unsigned int flags
)
1950 unsigned int head
, tail
, mask
, count
;
1953 struct pipe_buffer
*bufs
;
1954 struct fuse_copy_state cs
;
1955 struct fuse_dev
*fud
;
1959 fud
= fuse_get_dev(out
);
1967 mask
= pipe
->ring_size
- 1;
1968 count
= head
- tail
;
1970 bufs
= kvmalloc_array(count
, sizeof(struct pipe_buffer
), GFP_KERNEL
);
1978 for (idx
= tail
; idx
!= head
&& rem
< len
; idx
++)
1979 rem
+= pipe
->bufs
[idx
& mask
].len
;
1987 struct pipe_buffer
*ibuf
;
1988 struct pipe_buffer
*obuf
;
1990 if (WARN_ON(nbuf
>= count
|| tail
== head
))
1993 ibuf
= &pipe
->bufs
[tail
& mask
];
1996 if (rem
>= ibuf
->len
) {
2002 if (!pipe_buf_get(pipe
, ibuf
))
2006 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
2008 ibuf
->offset
+= obuf
->len
;
2009 ibuf
->len
-= obuf
->len
;
2016 fuse_copy_init(&cs
, 0, NULL
);
2021 if (flags
& SPLICE_F_MOVE
)
2024 ret
= fuse_dev_do_write(fud
, &cs
, len
);
2028 for (idx
= 0; idx
< nbuf
; idx
++)
2029 pipe_buf_release(pipe
, &bufs
[idx
]);
2036 static __poll_t
fuse_dev_poll(struct file
*file
, poll_table
*wait
)
2038 __poll_t mask
= EPOLLOUT
| EPOLLWRNORM
;
2039 struct fuse_iqueue
*fiq
;
2040 struct fuse_dev
*fud
= fuse_get_dev(file
);
2046 poll_wait(file
, &fiq
->waitq
, wait
);
2048 spin_lock(&fiq
->lock
);
2049 if (!fiq
->connected
)
2051 else if (request_pending(fiq
))
2052 mask
|= EPOLLIN
| EPOLLRDNORM
;
2053 spin_unlock(&fiq
->lock
);
2058 /* Abort all requests on the given list (pending or processing) */
2059 static void end_requests(struct list_head
*head
)
2061 while (!list_empty(head
)) {
2062 struct fuse_req
*req
;
2063 req
= list_entry(head
->next
, struct fuse_req
, list
);
2064 req
->out
.h
.error
= -ECONNABORTED
;
2065 clear_bit(FR_SENT
, &req
->flags
);
2066 list_del_init(&req
->list
);
2067 fuse_request_end(req
);
2071 static void end_polls(struct fuse_conn
*fc
)
2075 p
= rb_first(&fc
->polled_files
);
2078 struct fuse_file
*ff
;
2079 ff
= rb_entry(p
, struct fuse_file
, polled_node
);
2080 wake_up_interruptible_all(&ff
->poll_wait
);
2087 * Abort all requests.
2089 * Emergency exit in case of a malicious or accidental deadlock, or just a hung
2092 * The same effect is usually achievable through killing the filesystem daemon
2093 * and all users of the filesystem. The exception is the combination of an
2094 * asynchronous request and the tricky deadlock (see
2095 * Documentation/filesystems/fuse.rst).
2097 * Aborting requests under I/O goes as follows: 1: Separate out unlocked
2098 * requests, they should be finished off immediately. Locked requests will be
2099 * finished after unlock; see unlock_request(). 2: Finish off the unlocked
2100 * requests. It is possible that some request will finish before we can. This
2101 * is OK, the request will in that case be removed from the list before we touch
2104 void fuse_abort_conn(struct fuse_conn
*fc
)
2106 struct fuse_iqueue
*fiq
= &fc
->iq
;
2108 spin_lock(&fc
->lock
);
2109 if (fc
->connected
) {
2110 struct fuse_dev
*fud
;
2111 struct fuse_req
*req
, *next
;
2115 /* Background queuing checks fc->connected under bg_lock */
2116 spin_lock(&fc
->bg_lock
);
2118 spin_unlock(&fc
->bg_lock
);
2120 fuse_set_initialized(fc
);
2121 list_for_each_entry(fud
, &fc
->devices
, entry
) {
2122 struct fuse_pqueue
*fpq
= &fud
->pq
;
2124 spin_lock(&fpq
->lock
);
2126 list_for_each_entry_safe(req
, next
, &fpq
->io
, list
) {
2127 req
->out
.h
.error
= -ECONNABORTED
;
2128 spin_lock(&req
->waitq
.lock
);
2129 set_bit(FR_ABORTED
, &req
->flags
);
2130 if (!test_bit(FR_LOCKED
, &req
->flags
)) {
2131 set_bit(FR_PRIVATE
, &req
->flags
);
2132 __fuse_get_request(req
);
2133 list_move(&req
->list
, &to_end
);
2135 spin_unlock(&req
->waitq
.lock
);
2137 for (i
= 0; i
< FUSE_PQ_HASH_SIZE
; i
++)
2138 list_splice_tail_init(&fpq
->processing
[i
],
2140 spin_unlock(&fpq
->lock
);
2142 spin_lock(&fc
->bg_lock
);
2144 fc
->max_background
= UINT_MAX
;
2146 spin_unlock(&fc
->bg_lock
);
2148 spin_lock(&fiq
->lock
);
2150 list_for_each_entry(req
, &fiq
->pending
, list
)
2151 clear_bit(FR_PENDING
, &req
->flags
);
2152 list_splice_tail_init(&fiq
->pending
, &to_end
);
2153 while (forget_pending(fiq
))
2154 kfree(fuse_dequeue_forget(fiq
, 1, NULL
));
2155 wake_up_all(&fiq
->waitq
);
2156 spin_unlock(&fiq
->lock
);
2157 kill_fasync(&fiq
->fasync
, SIGIO
, POLL_IN
);
2159 wake_up_all(&fc
->blocked_waitq
);
2160 spin_unlock(&fc
->lock
);
2162 end_requests(&to_end
);
2164 spin_unlock(&fc
->lock
);
2167 EXPORT_SYMBOL_GPL(fuse_abort_conn
);
2169 void fuse_wait_aborted(struct fuse_conn
*fc
)
2171 /* matches implicit memory barrier in fuse_drop_waiting() */
2173 wait_event(fc
->blocked_waitq
, atomic_read(&fc
->num_waiting
) == 0);
2176 int fuse_dev_release(struct inode
*inode
, struct file
*file
)
2178 struct fuse_dev
*fud
= fuse_get_dev(file
);
2181 struct fuse_conn
*fc
= fud
->fc
;
2182 struct fuse_pqueue
*fpq
= &fud
->pq
;
2186 spin_lock(&fpq
->lock
);
2187 WARN_ON(!list_empty(&fpq
->io
));
2188 for (i
= 0; i
< FUSE_PQ_HASH_SIZE
; i
++)
2189 list_splice_init(&fpq
->processing
[i
], &to_end
);
2190 spin_unlock(&fpq
->lock
);
2192 end_requests(&to_end
);
2194 /* Are we the last open device? */
2195 if (atomic_dec_and_test(&fc
->dev_count
)) {
2196 WARN_ON(fc
->iq
.fasync
!= NULL
);
2197 fuse_abort_conn(fc
);
2203 EXPORT_SYMBOL_GPL(fuse_dev_release
);
2205 static int fuse_dev_fasync(int fd
, struct file
*file
, int on
)
2207 struct fuse_dev
*fud
= fuse_get_dev(file
);
2212 /* No locking - fasync_helper does its own locking */
2213 return fasync_helper(fd
, file
, on
, &fud
->fc
->iq
.fasync
);
2216 static int fuse_device_clone(struct fuse_conn
*fc
, struct file
*new)
2218 struct fuse_dev
*fud
;
2220 if (new->private_data
)
2223 fud
= fuse_dev_alloc_install(fc
);
2227 new->private_data
= fud
;
2228 atomic_inc(&fc
->dev_count
);
2233 static long fuse_dev_ioctl(struct file
*file
, unsigned int cmd
,
2238 if (cmd
== FUSE_DEV_IOC_CLONE
) {
2242 if (!get_user(oldfd
, (__u32 __user
*) arg
)) {
2243 struct file
*old
= fget(oldfd
);
2247 struct fuse_dev
*fud
= NULL
;
2250 * Check against file->f_op because CUSE
2251 * uses the same ioctl handler.
2253 if (old
->f_op
== file
->f_op
&&
2254 old
->f_cred
->user_ns
== file
->f_cred
->user_ns
)
2255 fud
= fuse_get_dev(old
);
2258 mutex_lock(&fuse_mutex
);
2259 err
= fuse_device_clone(fud
->fc
, file
);
2260 mutex_unlock(&fuse_mutex
);
2269 const struct file_operations fuse_dev_operations
= {
2270 .owner
= THIS_MODULE
,
2271 .open
= fuse_dev_open
,
2272 .llseek
= no_llseek
,
2273 .read_iter
= fuse_dev_read
,
2274 .splice_read
= fuse_dev_splice_read
,
2275 .write_iter
= fuse_dev_write
,
2276 .splice_write
= fuse_dev_splice_write
,
2277 .poll
= fuse_dev_poll
,
2278 .release
= fuse_dev_release
,
2279 .fasync
= fuse_dev_fasync
,
2280 .unlocked_ioctl
= fuse_dev_ioctl
,
2281 .compat_ioctl
= compat_ptr_ioctl
,
2283 EXPORT_SYMBOL_GPL(fuse_dev_operations
);
2285 static struct miscdevice fuse_miscdevice
= {
2286 .minor
= FUSE_MINOR
,
2288 .fops
= &fuse_dev_operations
,
2291 int __init
fuse_dev_init(void)
2294 fuse_req_cachep
= kmem_cache_create("fuse_request",
2295 sizeof(struct fuse_req
),
2297 if (!fuse_req_cachep
)
2300 err
= misc_register(&fuse_miscdevice
);
2302 goto out_cache_clean
;
2307 kmem_cache_destroy(fuse_req_cachep
);
2312 void fuse_dev_cleanup(void)
2314 misc_deregister(&fuse_miscdevice
);
2315 kmem_cache_destroy(fuse_req_cachep
);