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/uio.h>
15 #include <linux/miscdevice.h>
16 #include <linux/pagemap.h>
17 #include <linux/file.h>
18 #include <linux/slab.h>
19 #include <linux/pipe_fs_i.h>
20 #include <linux/swap.h>
21 #include <linux/splice.h>
23 MODULE_ALIAS_MISCDEV(FUSE_MINOR);
24 MODULE_ALIAS("devname:fuse");
26 static struct kmem_cache *fuse_req_cachep;
28 static struct fuse_conn *fuse_get_conn(struct file *file)
31 * Lockless access is OK, because file->private data is set
32 * once during mount and is valid until the file is released.
34 return file->private_data;
37 static void fuse_request_init(struct fuse_req *req)
39 memset(req, 0, sizeof(*req));
40 INIT_LIST_HEAD(&req->list);
41 INIT_LIST_HEAD(&req->intr_entry);
42 init_waitqueue_head(&req->waitq);
43 atomic_set(&req->count, 1);
46 struct fuse_req *fuse_request_alloc(void)
48 struct fuse_req *req = kmem_cache_alloc(fuse_req_cachep, GFP_KERNEL);
50 fuse_request_init(req);
53 EXPORT_SYMBOL_GPL(fuse_request_alloc);
55 struct fuse_req *fuse_request_alloc_nofs(void)
57 struct fuse_req *req = kmem_cache_alloc(fuse_req_cachep, GFP_NOFS);
59 fuse_request_init(req);
63 void fuse_request_free(struct fuse_req *req)
65 kmem_cache_free(fuse_req_cachep, req);
68 static void block_sigs(sigset_t *oldset)
72 siginitsetinv(&mask, sigmask(SIGKILL));
73 sigprocmask(SIG_BLOCK, &mask, oldset);
76 static void restore_sigs(sigset_t *oldset)
78 sigprocmask(SIG_SETMASK, oldset, NULL);
81 static void __fuse_get_request(struct fuse_req *req)
83 atomic_inc(&req->count);
86 /* Must be called with > 1 refcount */
87 static void __fuse_put_request(struct fuse_req *req)
89 BUG_ON(atomic_read(&req->count) < 2);
90 atomic_dec(&req->count);
93 static void fuse_req_init_context(struct fuse_req *req)
95 req->in.h.uid = current_fsuid();
96 req->in.h.gid = current_fsgid();
97 req->in.h.pid = current->pid;
100 struct fuse_req *fuse_get_req(struct fuse_conn *fc)
102 struct fuse_req *req;
107 atomic_inc(&fc->num_waiting);
109 intr = wait_event_interruptible(fc->blocked_waitq, !fc->blocked);
110 restore_sigs(&oldset);
119 req = fuse_request_alloc();
124 fuse_req_init_context(req);
129 atomic_dec(&fc->num_waiting);
132 EXPORT_SYMBOL_GPL(fuse_get_req);
135 * Return request in fuse_file->reserved_req. However that may
136 * currently be in use. If that is the case, wait for it to become
139 static struct fuse_req *get_reserved_req(struct fuse_conn *fc,
142 struct fuse_req *req = NULL;
143 struct fuse_file *ff = file->private_data;
146 wait_event(fc->reserved_req_waitq, ff->reserved_req);
147 spin_lock(&fc->lock);
148 if (ff->reserved_req) {
149 req = ff->reserved_req;
150 ff->reserved_req = NULL;
152 req->stolen_file = file;
154 spin_unlock(&fc->lock);
161 * Put stolen request back into fuse_file->reserved_req
163 static void put_reserved_req(struct fuse_conn *fc, struct fuse_req *req)
165 struct file *file = req->stolen_file;
166 struct fuse_file *ff = file->private_data;
168 spin_lock(&fc->lock);
169 fuse_request_init(req);
170 BUG_ON(ff->reserved_req);
171 ff->reserved_req = req;
172 wake_up_all(&fc->reserved_req_waitq);
173 spin_unlock(&fc->lock);
178 * Gets a requests for a file operation, always succeeds
180 * This is used for sending the FLUSH request, which must get to
181 * userspace, due to POSIX locks which may need to be unlocked.
183 * If allocation fails due to OOM, use the reserved request in
186 * This is very unlikely to deadlock accidentally, since the
187 * filesystem should not have it's own file open. If deadlock is
188 * intentional, it can still be broken by "aborting" the filesystem.
190 struct fuse_req *fuse_get_req_nofail(struct fuse_conn *fc, struct file *file)
192 struct fuse_req *req;
194 atomic_inc(&fc->num_waiting);
195 wait_event(fc->blocked_waitq, !fc->blocked);
196 req = fuse_request_alloc();
198 req = get_reserved_req(fc, file);
200 fuse_req_init_context(req);
205 void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req)
207 if (atomic_dec_and_test(&req->count)) {
209 atomic_dec(&fc->num_waiting);
211 if (req->stolen_file)
212 put_reserved_req(fc, req);
214 fuse_request_free(req);
217 EXPORT_SYMBOL_GPL(fuse_put_request);
219 static unsigned len_args(unsigned numargs, struct fuse_arg *args)
224 for (i = 0; i < numargs; i++)
225 nbytes += args[i].size;
230 static u64 fuse_get_unique(struct fuse_conn *fc)
233 /* zero is special */
240 static void queue_request(struct fuse_conn *fc, struct fuse_req *req)
242 req->in.h.len = sizeof(struct fuse_in_header) +
243 len_args(req->in.numargs, (struct fuse_arg *) req->in.args);
244 list_add_tail(&req->list, &fc->pending);
245 req->state = FUSE_REQ_PENDING;
248 atomic_inc(&fc->num_waiting);
251 kill_fasync(&fc->fasync, SIGIO, POLL_IN);
254 void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
255 u64 nodeid, u64 nlookup)
257 forget->forget_one.nodeid = nodeid;
258 forget->forget_one.nlookup = nlookup;
260 spin_lock(&fc->lock);
261 fc->forget_list_tail->next = forget;
262 fc->forget_list_tail = forget;
264 kill_fasync(&fc->fasync, SIGIO, POLL_IN);
265 spin_unlock(&fc->lock);
268 static void flush_bg_queue(struct fuse_conn *fc)
270 while (fc->active_background < fc->max_background &&
271 !list_empty(&fc->bg_queue)) {
272 struct fuse_req *req;
274 req = list_entry(fc->bg_queue.next, struct fuse_req, list);
275 list_del(&req->list);
276 fc->active_background++;
277 req->in.h.unique = fuse_get_unique(fc);
278 queue_request(fc, req);
283 * This function is called when a request is finished. Either a reply
284 * has arrived or it was aborted (and not yet sent) or some error
285 * occurred during communication with userspace, or the device file
286 * was closed. The requester thread is woken up (if still waiting),
287 * the 'end' callback is called if given, else the reference to the
288 * request is released
290 * Called with fc->lock, unlocks it
292 static void request_end(struct fuse_conn *fc, struct fuse_req *req)
295 void (*end) (struct fuse_conn *, struct fuse_req *) = req->end;
297 list_del(&req->list);
298 list_del(&req->intr_entry);
299 req->state = FUSE_REQ_FINISHED;
300 if (req->background) {
301 if (fc->num_background == fc->max_background) {
303 wake_up_all(&fc->blocked_waitq);
305 if (fc->num_background == fc->congestion_threshold &&
306 fc->connected && fc->bdi_initialized) {
307 clear_bdi_congested(&fc->bdi, BLK_RW_SYNC);
308 clear_bdi_congested(&fc->bdi, BLK_RW_ASYNC);
310 fc->num_background--;
311 fc->active_background--;
314 spin_unlock(&fc->lock);
315 wake_up(&req->waitq);
318 fuse_put_request(fc, req);
321 static void wait_answer_interruptible(struct fuse_conn *fc,
322 struct fuse_req *req)
326 if (signal_pending(current))
329 spin_unlock(&fc->lock);
330 wait_event_interruptible(req->waitq, req->state == FUSE_REQ_FINISHED);
331 spin_lock(&fc->lock);
334 static void queue_interrupt(struct fuse_conn *fc, struct fuse_req *req)
336 list_add_tail(&req->intr_entry, &fc->interrupts);
338 kill_fasync(&fc->fasync, SIGIO, POLL_IN);
341 static void request_wait_answer(struct fuse_conn *fc, struct fuse_req *req)
345 if (!fc->no_interrupt) {
346 /* Any signal may interrupt this */
347 wait_answer_interruptible(fc, req);
351 if (req->state == FUSE_REQ_FINISHED)
354 req->interrupted = 1;
355 if (req->state == FUSE_REQ_SENT)
356 queue_interrupt(fc, req);
362 /* Only fatal signals may interrupt this */
364 wait_answer_interruptible(fc, req);
365 restore_sigs(&oldset);
369 if (req->state == FUSE_REQ_FINISHED)
372 /* Request is not yet in userspace, bail out */
373 if (req->state == FUSE_REQ_PENDING) {
374 list_del(&req->list);
375 __fuse_put_request(req);
376 req->out.h.error = -EINTR;
382 * Either request is already in userspace, or it was forced.
385 spin_unlock(&fc->lock);
386 wait_event(req->waitq, req->state == FUSE_REQ_FINISHED);
387 spin_lock(&fc->lock);
393 BUG_ON(req->state != FUSE_REQ_FINISHED);
395 /* This is uninterruptible sleep, because data is
396 being copied to/from the buffers of req. During
397 locked state, there mustn't be any filesystem
398 operation (e.g. page fault), since that could lead
400 spin_unlock(&fc->lock);
401 wait_event(req->waitq, !req->locked);
402 spin_lock(&fc->lock);
406 void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req)
409 spin_lock(&fc->lock);
411 req->out.h.error = -ENOTCONN;
412 else if (fc->conn_error)
413 req->out.h.error = -ECONNREFUSED;
415 req->in.h.unique = fuse_get_unique(fc);
416 queue_request(fc, req);
417 /* acquire extra reference, since request is still needed
418 after request_end() */
419 __fuse_get_request(req);
421 request_wait_answer(fc, req);
423 spin_unlock(&fc->lock);
425 EXPORT_SYMBOL_GPL(fuse_request_send);
427 static void fuse_request_send_nowait_locked(struct fuse_conn *fc,
428 struct fuse_req *req)
431 fc->num_background++;
432 if (fc->num_background == fc->max_background)
434 if (fc->num_background == fc->congestion_threshold &&
435 fc->bdi_initialized) {
436 set_bdi_congested(&fc->bdi, BLK_RW_SYNC);
437 set_bdi_congested(&fc->bdi, BLK_RW_ASYNC);
439 list_add_tail(&req->list, &fc->bg_queue);
443 static void fuse_request_send_nowait(struct fuse_conn *fc, struct fuse_req *req)
445 spin_lock(&fc->lock);
447 fuse_request_send_nowait_locked(fc, req);
448 spin_unlock(&fc->lock);
450 req->out.h.error = -ENOTCONN;
451 request_end(fc, req);
455 void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req)
458 fuse_request_send_nowait(fc, req);
460 EXPORT_SYMBOL_GPL(fuse_request_send_background);
462 static int fuse_request_send_notify_reply(struct fuse_conn *fc,
463 struct fuse_req *req, u64 unique)
468 req->in.h.unique = unique;
469 spin_lock(&fc->lock);
471 queue_request(fc, req);
474 spin_unlock(&fc->lock);
480 * Called under fc->lock
482 * fc->connected must have been checked previously
484 void fuse_request_send_background_locked(struct fuse_conn *fc,
485 struct fuse_req *req)
488 fuse_request_send_nowait_locked(fc, req);
492 * Lock the request. Up to the next unlock_request() there mustn't be
493 * anything that could cause a page-fault. If the request was already
496 static int lock_request(struct fuse_conn *fc, struct fuse_req *req)
500 spin_lock(&fc->lock);
505 spin_unlock(&fc->lock);
511 * Unlock request. If it was aborted during being locked, the
512 * requester thread is currently waiting for it to be unlocked, so
515 static void unlock_request(struct fuse_conn *fc, struct fuse_req *req)
518 spin_lock(&fc->lock);
521 wake_up(&req->waitq);
522 spin_unlock(&fc->lock);
526 struct fuse_copy_state {
527 struct fuse_conn *fc;
529 struct fuse_req *req;
530 const struct iovec *iov;
531 struct pipe_buffer *pipebufs;
532 struct pipe_buffer *currbuf;
533 struct pipe_inode_info *pipe;
534 unsigned long nr_segs;
535 unsigned long seglen;
541 unsigned move_pages:1;
544 static void fuse_copy_init(struct fuse_copy_state *cs, struct fuse_conn *fc,
546 const struct iovec *iov, unsigned long nr_segs)
548 memset(cs, 0, sizeof(*cs));
552 cs->nr_segs = nr_segs;
555 /* Unmap and put previous page of userspace buffer */
556 static void fuse_copy_finish(struct fuse_copy_state *cs)
559 struct pipe_buffer *buf = cs->currbuf;
562 buf->ops->unmap(cs->pipe, buf, cs->mapaddr);
565 buf->len = PAGE_SIZE - cs->len;
569 } else if (cs->mapaddr) {
572 flush_dcache_page(cs->pg);
573 set_page_dirty_lock(cs->pg);
581 * Get another pagefull of userspace buffer, and map it to kernel
582 * address space, and lock request
584 static int fuse_copy_fill(struct fuse_copy_state *cs)
586 unsigned long offset;
589 unlock_request(cs->fc, cs->req);
590 fuse_copy_finish(cs);
592 struct pipe_buffer *buf = cs->pipebufs;
595 err = buf->ops->confirm(cs->pipe, buf);
599 BUG_ON(!cs->nr_segs);
601 cs->mapaddr = buf->ops->map(cs->pipe, buf, 0);
603 cs->buf = cs->mapaddr + buf->offset;
609 if (cs->nr_segs == cs->pipe->buffers)
612 page = alloc_page(GFP_HIGHUSER);
621 cs->mapaddr = kmap(page);
622 cs->buf = cs->mapaddr;
629 BUG_ON(!cs->nr_segs);
630 cs->seglen = cs->iov[0].iov_len;
631 cs->addr = (unsigned long) cs->iov[0].iov_base;
635 err = get_user_pages_fast(cs->addr, 1, cs->write, &cs->pg);
639 offset = cs->addr % PAGE_SIZE;
640 cs->mapaddr = kmap(cs->pg);
641 cs->buf = cs->mapaddr + offset;
642 cs->len = min(PAGE_SIZE - offset, cs->seglen);
643 cs->seglen -= cs->len;
647 return lock_request(cs->fc, cs->req);
650 /* Do as much copy to/from userspace buffer as we can */
651 static int fuse_copy_do(struct fuse_copy_state *cs, void **val, unsigned *size)
653 unsigned ncpy = min(*size, cs->len);
656 memcpy(cs->buf, *val, ncpy);
658 memcpy(*val, cs->buf, ncpy);
667 static int fuse_check_page(struct page *page)
669 if (page_mapcount(page) ||
670 page->mapping != NULL ||
671 page_count(page) != 1 ||
672 (page->flags & PAGE_FLAGS_CHECK_AT_PREP &
679 printk(KERN_WARNING "fuse: trying to steal weird page\n");
680 printk(KERN_WARNING " page=%p index=%li flags=%08lx, count=%i, mapcount=%i, mapping=%p\n", page, page->index, page->flags, page_count(page), page_mapcount(page), page->mapping);
686 static int fuse_try_move_page(struct fuse_copy_state *cs, struct page **pagep)
689 struct page *oldpage = *pagep;
690 struct page *newpage;
691 struct pipe_buffer *buf = cs->pipebufs;
692 struct address_space *mapping;
695 unlock_request(cs->fc, cs->req);
696 fuse_copy_finish(cs);
698 err = buf->ops->confirm(cs->pipe, buf);
702 BUG_ON(!cs->nr_segs);
708 if (cs->len != PAGE_SIZE)
711 if (buf->ops->steal(cs->pipe, buf) != 0)
716 if (WARN_ON(!PageUptodate(newpage)))
719 ClearPageMappedToDisk(newpage);
721 if (fuse_check_page(newpage) != 0)
722 goto out_fallback_unlock;
724 mapping = oldpage->mapping;
725 index = oldpage->index;
728 * This is a new and locked page, it shouldn't be mapped or
729 * have any special flags on it
731 if (WARN_ON(page_mapped(oldpage)))
732 goto out_fallback_unlock;
733 if (WARN_ON(page_has_private(oldpage)))
734 goto out_fallback_unlock;
735 if (WARN_ON(PageDirty(oldpage) || PageWriteback(oldpage)))
736 goto out_fallback_unlock;
737 if (WARN_ON(PageMlocked(oldpage)))
738 goto out_fallback_unlock;
740 err = replace_page_cache_page(oldpage, newpage, GFP_KERNEL);
742 unlock_page(newpage);
746 page_cache_get(newpage);
748 if (!(buf->flags & PIPE_BUF_FLAG_LRU))
749 lru_cache_add_file(newpage);
752 spin_lock(&cs->fc->lock);
753 if (cs->req->aborted)
757 spin_unlock(&cs->fc->lock);
760 unlock_page(newpage);
761 page_cache_release(newpage);
765 unlock_page(oldpage);
766 page_cache_release(oldpage);
772 unlock_page(newpage);
774 cs->mapaddr = buf->ops->map(cs->pipe, buf, 1);
775 cs->buf = cs->mapaddr + buf->offset;
777 err = lock_request(cs->fc, cs->req);
784 static int fuse_ref_page(struct fuse_copy_state *cs, struct page *page,
785 unsigned offset, unsigned count)
787 struct pipe_buffer *buf;
789 if (cs->nr_segs == cs->pipe->buffers)
792 unlock_request(cs->fc, cs->req);
793 fuse_copy_finish(cs);
796 page_cache_get(page);
798 buf->offset = offset;
809 * Copy a page in the request to/from the userspace buffer. Must be
812 static int fuse_copy_page(struct fuse_copy_state *cs, struct page **pagep,
813 unsigned offset, unsigned count, int zeroing)
816 struct page *page = *pagep;
818 if (page && zeroing && count < PAGE_SIZE)
819 clear_highpage(page);
822 if (cs->write && cs->pipebufs && page) {
823 return fuse_ref_page(cs, page, offset, count);
824 } else if (!cs->len) {
825 if (cs->move_pages && page &&
826 offset == 0 && count == PAGE_SIZE) {
827 err = fuse_try_move_page(cs, pagep);
831 err = fuse_copy_fill(cs);
837 void *mapaddr = kmap_atomic(page, KM_USER0);
838 void *buf = mapaddr + offset;
839 offset += fuse_copy_do(cs, &buf, &count);
840 kunmap_atomic(mapaddr, KM_USER0);
842 offset += fuse_copy_do(cs, NULL, &count);
844 if (page && !cs->write)
845 flush_dcache_page(page);
849 /* Copy pages in the request to/from userspace buffer */
850 static int fuse_copy_pages(struct fuse_copy_state *cs, unsigned nbytes,
854 struct fuse_req *req = cs->req;
855 unsigned offset = req->page_offset;
856 unsigned count = min(nbytes, (unsigned) PAGE_SIZE - offset);
858 for (i = 0; i < req->num_pages && (nbytes || zeroing); i++) {
861 err = fuse_copy_page(cs, &req->pages[i], offset, count,
867 count = min(nbytes, (unsigned) PAGE_SIZE);
873 /* Copy a single argument in the request to/from userspace buffer */
874 static int fuse_copy_one(struct fuse_copy_state *cs, void *val, unsigned size)
878 int err = fuse_copy_fill(cs);
882 fuse_copy_do(cs, &val, &size);
887 /* Copy request arguments to/from userspace buffer */
888 static int fuse_copy_args(struct fuse_copy_state *cs, unsigned numargs,
889 unsigned argpages, struct fuse_arg *args,
895 for (i = 0; !err && i < numargs; i++) {
896 struct fuse_arg *arg = &args[i];
897 if (i == numargs - 1 && argpages)
898 err = fuse_copy_pages(cs, arg->size, zeroing);
900 err = fuse_copy_one(cs, arg->value, arg->size);
905 static int forget_pending(struct fuse_conn *fc)
907 return fc->forget_list_head.next != NULL;
910 static int request_pending(struct fuse_conn *fc)
912 return !list_empty(&fc->pending) || !list_empty(&fc->interrupts) ||
916 /* Wait until a request is available on the pending list */
917 static void request_wait(struct fuse_conn *fc)
921 DECLARE_WAITQUEUE(wait, current);
923 add_wait_queue_exclusive(&fc->waitq, &wait);
924 while (fc->connected && !request_pending(fc)) {
925 set_current_state(TASK_INTERRUPTIBLE);
926 if (signal_pending(current))
929 spin_unlock(&fc->lock);
931 spin_lock(&fc->lock);
933 set_current_state(TASK_RUNNING);
934 remove_wait_queue(&fc->waitq, &wait);
938 * Transfer an interrupt request to userspace
940 * Unlike other requests this is assembled on demand, without a need
941 * to allocate a separate fuse_req structure.
943 * Called with fc->lock held, releases it
945 static int fuse_read_interrupt(struct fuse_conn *fc, struct fuse_copy_state *cs,
946 size_t nbytes, struct fuse_req *req)
949 struct fuse_in_header ih;
950 struct fuse_interrupt_in arg;
951 unsigned reqsize = sizeof(ih) + sizeof(arg);
954 list_del_init(&req->intr_entry);
955 req->intr_unique = fuse_get_unique(fc);
956 memset(&ih, 0, sizeof(ih));
957 memset(&arg, 0, sizeof(arg));
959 ih.opcode = FUSE_INTERRUPT;
960 ih.unique = req->intr_unique;
961 arg.unique = req->in.h.unique;
963 spin_unlock(&fc->lock);
964 if (nbytes < reqsize)
967 err = fuse_copy_one(cs, &ih, sizeof(ih));
969 err = fuse_copy_one(cs, &arg, sizeof(arg));
970 fuse_copy_finish(cs);
972 return err ? err : reqsize;
975 static struct fuse_forget_link *dequeue_forget(struct fuse_conn *fc,
979 struct fuse_forget_link *head = fc->forget_list_head.next;
980 struct fuse_forget_link **newhead = &head;
983 for (count = 0; *newhead != NULL && count < max; count++)
984 newhead = &(*newhead)->next;
986 fc->forget_list_head.next = *newhead;
988 if (fc->forget_list_head.next == NULL)
989 fc->forget_list_tail = &fc->forget_list_head;
997 static int fuse_read_single_forget(struct fuse_conn *fc,
998 struct fuse_copy_state *cs,
1000 __releases(fc->lock)
1003 struct fuse_forget_link *forget = dequeue_forget(fc, 1, NULL);
1004 struct fuse_forget_in arg = {
1005 .nlookup = forget->forget_one.nlookup,
1007 struct fuse_in_header ih = {
1008 .opcode = FUSE_FORGET,
1009 .nodeid = forget->forget_one.nodeid,
1010 .unique = fuse_get_unique(fc),
1011 .len = sizeof(ih) + sizeof(arg),
1014 spin_unlock(&fc->lock);
1016 if (nbytes < ih.len)
1019 err = fuse_copy_one(cs, &ih, sizeof(ih));
1021 err = fuse_copy_one(cs, &arg, sizeof(arg));
1022 fuse_copy_finish(cs);
1030 static int fuse_read_batch_forget(struct fuse_conn *fc,
1031 struct fuse_copy_state *cs, size_t nbytes)
1032 __releases(fc->lock)
1035 unsigned max_forgets;
1037 struct fuse_forget_link *head;
1038 struct fuse_batch_forget_in arg = { .count = 0 };
1039 struct fuse_in_header ih = {
1040 .opcode = FUSE_BATCH_FORGET,
1041 .unique = fuse_get_unique(fc),
1042 .len = sizeof(ih) + sizeof(arg),
1045 if (nbytes < ih.len) {
1046 spin_unlock(&fc->lock);
1050 max_forgets = (nbytes - ih.len) / sizeof(struct fuse_forget_one);
1051 head = dequeue_forget(fc, max_forgets, &count);
1052 spin_unlock(&fc->lock);
1055 ih.len += count * sizeof(struct fuse_forget_one);
1056 err = fuse_copy_one(cs, &ih, sizeof(ih));
1058 err = fuse_copy_one(cs, &arg, sizeof(arg));
1061 struct fuse_forget_link *forget = head;
1064 err = fuse_copy_one(cs, &forget->forget_one,
1065 sizeof(forget->forget_one));
1067 head = forget->next;
1071 fuse_copy_finish(cs);
1079 static int fuse_read_forget(struct fuse_conn *fc, struct fuse_copy_state *cs,
1081 __releases(fc->lock)
1083 if (fc->minor < 16 || fc->forget_list_head.next->next == NULL)
1084 return fuse_read_single_forget(fc, cs, nbytes);
1086 return fuse_read_batch_forget(fc, cs, nbytes);
1090 * Read a single request into the userspace filesystem's buffer. This
1091 * function waits until a request is available, then removes it from
1092 * the pending list and copies request data to userspace buffer. If
1093 * no reply is needed (FORGET) or request has been aborted or there
1094 * was an error during the copying then it's finished by calling
1095 * request_end(). Otherwise add it to the processing list, and set
1098 static ssize_t fuse_dev_do_read(struct fuse_conn *fc, struct file *file,
1099 struct fuse_copy_state *cs, size_t nbytes)
1102 struct fuse_req *req;
1107 spin_lock(&fc->lock);
1109 if ((file->f_flags & O_NONBLOCK) && fc->connected &&
1110 !request_pending(fc))
1118 if (!request_pending(fc))
1121 if (!list_empty(&fc->interrupts)) {
1122 req = list_entry(fc->interrupts.next, struct fuse_req,
1124 return fuse_read_interrupt(fc, cs, nbytes, req);
1127 if (forget_pending(fc)) {
1128 if (list_empty(&fc->pending) || fc->forget_batch-- > 0)
1129 return fuse_read_forget(fc, cs, nbytes);
1131 if (fc->forget_batch <= -8)
1132 fc->forget_batch = 16;
1135 req = list_entry(fc->pending.next, struct fuse_req, list);
1136 req->state = FUSE_REQ_READING;
1137 list_move(&req->list, &fc->io);
1140 reqsize = in->h.len;
1141 /* If request is too large, reply with an error and restart the read */
1142 if (nbytes < reqsize) {
1143 req->out.h.error = -EIO;
1144 /* SETXATTR is special, since it may contain too large data */
1145 if (in->h.opcode == FUSE_SETXATTR)
1146 req->out.h.error = -E2BIG;
1147 request_end(fc, req);
1150 spin_unlock(&fc->lock);
1152 err = fuse_copy_one(cs, &in->h, sizeof(in->h));
1154 err = fuse_copy_args(cs, in->numargs, in->argpages,
1155 (struct fuse_arg *) in->args, 0);
1156 fuse_copy_finish(cs);
1157 spin_lock(&fc->lock);
1160 request_end(fc, req);
1164 req->out.h.error = -EIO;
1165 request_end(fc, req);
1169 request_end(fc, req);
1171 req->state = FUSE_REQ_SENT;
1172 list_move_tail(&req->list, &fc->processing);
1173 if (req->interrupted)
1174 queue_interrupt(fc, req);
1175 spin_unlock(&fc->lock);
1180 spin_unlock(&fc->lock);
1184 static ssize_t fuse_dev_read(struct kiocb *iocb, const struct iovec *iov,
1185 unsigned long nr_segs, loff_t pos)
1187 struct fuse_copy_state cs;
1188 struct file *file = iocb->ki_filp;
1189 struct fuse_conn *fc = fuse_get_conn(file);
1193 fuse_copy_init(&cs, fc, 1, iov, nr_segs);
1195 return fuse_dev_do_read(fc, file, &cs, iov_length(iov, nr_segs));
1198 static int fuse_dev_pipe_buf_steal(struct pipe_inode_info *pipe,
1199 struct pipe_buffer *buf)
1204 static const struct pipe_buf_operations fuse_dev_pipe_buf_ops = {
1206 .map = generic_pipe_buf_map,
1207 .unmap = generic_pipe_buf_unmap,
1208 .confirm = generic_pipe_buf_confirm,
1209 .release = generic_pipe_buf_release,
1210 .steal = fuse_dev_pipe_buf_steal,
1211 .get = generic_pipe_buf_get,
1214 static ssize_t fuse_dev_splice_read(struct file *in, loff_t *ppos,
1215 struct pipe_inode_info *pipe,
1216 size_t len, unsigned int flags)
1221 struct pipe_buffer *bufs;
1222 struct fuse_copy_state cs;
1223 struct fuse_conn *fc = fuse_get_conn(in);
1227 bufs = kmalloc(pipe->buffers * sizeof(struct pipe_buffer), GFP_KERNEL);
1231 fuse_copy_init(&cs, fc, 1, NULL, 0);
1234 ret = fuse_dev_do_read(fc, in, &cs, len);
1241 if (!pipe->readers) {
1242 send_sig(SIGPIPE, current, 0);
1248 if (pipe->nrbufs + cs.nr_segs > pipe->buffers) {
1253 while (page_nr < cs.nr_segs) {
1254 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
1255 struct pipe_buffer *buf = pipe->bufs + newbuf;
1257 buf->page = bufs[page_nr].page;
1258 buf->offset = bufs[page_nr].offset;
1259 buf->len = bufs[page_nr].len;
1260 buf->ops = &fuse_dev_pipe_buf_ops;
1275 if (waitqueue_active(&pipe->wait))
1276 wake_up_interruptible(&pipe->wait);
1277 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
1281 for (; page_nr < cs.nr_segs; page_nr++)
1282 page_cache_release(bufs[page_nr].page);
1288 static int fuse_notify_poll(struct fuse_conn *fc, unsigned int size,
1289 struct fuse_copy_state *cs)
1291 struct fuse_notify_poll_wakeup_out outarg;
1294 if (size != sizeof(outarg))
1297 err = fuse_copy_one(cs, &outarg, sizeof(outarg));
1301 fuse_copy_finish(cs);
1302 return fuse_notify_poll_wakeup(fc, &outarg);
1305 fuse_copy_finish(cs);
1309 static int fuse_notify_inval_inode(struct fuse_conn *fc, unsigned int size,
1310 struct fuse_copy_state *cs)
1312 struct fuse_notify_inval_inode_out outarg;
1315 if (size != sizeof(outarg))
1318 err = fuse_copy_one(cs, &outarg, sizeof(outarg));
1321 fuse_copy_finish(cs);
1323 down_read(&fc->killsb);
1326 err = fuse_reverse_inval_inode(fc->sb, outarg.ino,
1327 outarg.off, outarg.len);
1329 up_read(&fc->killsb);
1333 fuse_copy_finish(cs);
1337 static int fuse_notify_inval_entry(struct fuse_conn *fc, unsigned int size,
1338 struct fuse_copy_state *cs)
1340 struct fuse_notify_inval_entry_out outarg;
1345 buf = kzalloc(FUSE_NAME_MAX + 1, GFP_KERNEL);
1350 if (size < sizeof(outarg))
1353 err = fuse_copy_one(cs, &outarg, sizeof(outarg));
1357 err = -ENAMETOOLONG;
1358 if (outarg.namelen > FUSE_NAME_MAX)
1362 name.len = outarg.namelen;
1363 err = fuse_copy_one(cs, buf, outarg.namelen + 1);
1366 fuse_copy_finish(cs);
1367 buf[outarg.namelen] = 0;
1368 name.hash = full_name_hash(name.name, name.len);
1370 down_read(&fc->killsb);
1373 err = fuse_reverse_inval_entry(fc->sb, outarg.parent, &name);
1374 up_read(&fc->killsb);
1380 fuse_copy_finish(cs);
1384 static int fuse_notify_store(struct fuse_conn *fc, unsigned int size,
1385 struct fuse_copy_state *cs)
1387 struct fuse_notify_store_out outarg;
1388 struct inode *inode;
1389 struct address_space *mapping;
1393 unsigned int offset;
1399 if (size < sizeof(outarg))
1402 err = fuse_copy_one(cs, &outarg, sizeof(outarg));
1407 if (size - sizeof(outarg) != outarg.size)
1410 nodeid = outarg.nodeid;
1412 down_read(&fc->killsb);
1418 inode = ilookup5(fc->sb, nodeid, fuse_inode_eq, &nodeid);
1422 mapping = inode->i_mapping;
1423 index = outarg.offset >> PAGE_CACHE_SHIFT;
1424 offset = outarg.offset & ~PAGE_CACHE_MASK;
1425 file_size = i_size_read(inode);
1426 end = outarg.offset + outarg.size;
1427 if (end > file_size) {
1429 fuse_write_update_size(inode, file_size);
1435 unsigned int this_num;
1438 page = find_or_create_page(mapping, index,
1439 mapping_gfp_mask(mapping));
1443 this_num = min_t(unsigned, num, PAGE_CACHE_SIZE - offset);
1444 err = fuse_copy_page(cs, &page, offset, this_num, 0);
1445 if (!err && offset == 0 && (num != 0 || file_size == end))
1446 SetPageUptodate(page);
1448 page_cache_release(page);
1463 up_read(&fc->killsb);
1465 fuse_copy_finish(cs);
1469 static void fuse_retrieve_end(struct fuse_conn *fc, struct fuse_req *req)
1471 release_pages(req->pages, req->num_pages, 0);
1474 static int fuse_retrieve(struct fuse_conn *fc, struct inode *inode,
1475 struct fuse_notify_retrieve_out *outarg)
1478 struct address_space *mapping = inode->i_mapping;
1479 struct fuse_req *req;
1483 unsigned int offset;
1484 size_t total_len = 0;
1486 req = fuse_get_req(fc);
1488 return PTR_ERR(req);
1490 offset = outarg->offset & ~PAGE_CACHE_MASK;
1492 req->in.h.opcode = FUSE_NOTIFY_REPLY;
1493 req->in.h.nodeid = outarg->nodeid;
1494 req->in.numargs = 2;
1495 req->in.argpages = 1;
1496 req->page_offset = offset;
1497 req->end = fuse_retrieve_end;
1499 index = outarg->offset >> PAGE_CACHE_SHIFT;
1500 file_size = i_size_read(inode);
1502 if (outarg->offset > file_size)
1504 else if (outarg->offset + num > file_size)
1505 num = file_size - outarg->offset;
1509 unsigned int this_num;
1511 page = find_get_page(mapping, index);
1515 this_num = min_t(unsigned, num, PAGE_CACHE_SIZE - offset);
1516 req->pages[req->num_pages] = page;
1520 total_len += this_num;
1522 req->misc.retrieve_in.offset = outarg->offset;
1523 req->misc.retrieve_in.size = total_len;
1524 req->in.args[0].size = sizeof(req->misc.retrieve_in);
1525 req->in.args[0].value = &req->misc.retrieve_in;
1526 req->in.args[1].size = total_len;
1528 err = fuse_request_send_notify_reply(fc, req, outarg->notify_unique);
1530 fuse_retrieve_end(fc, req);
1535 static int fuse_notify_retrieve(struct fuse_conn *fc, unsigned int size,
1536 struct fuse_copy_state *cs)
1538 struct fuse_notify_retrieve_out outarg;
1539 struct inode *inode;
1543 if (size != sizeof(outarg))
1546 err = fuse_copy_one(cs, &outarg, sizeof(outarg));
1550 fuse_copy_finish(cs);
1552 down_read(&fc->killsb);
1555 u64 nodeid = outarg.nodeid;
1557 inode = ilookup5(fc->sb, nodeid, fuse_inode_eq, &nodeid);
1559 err = fuse_retrieve(fc, inode, &outarg);
1563 up_read(&fc->killsb);
1568 fuse_copy_finish(cs);
1572 static int fuse_notify(struct fuse_conn *fc, enum fuse_notify_code code,
1573 unsigned int size, struct fuse_copy_state *cs)
1576 case FUSE_NOTIFY_POLL:
1577 return fuse_notify_poll(fc, size, cs);
1579 case FUSE_NOTIFY_INVAL_INODE:
1580 return fuse_notify_inval_inode(fc, size, cs);
1582 case FUSE_NOTIFY_INVAL_ENTRY:
1583 return fuse_notify_inval_entry(fc, size, cs);
1585 case FUSE_NOTIFY_STORE:
1586 return fuse_notify_store(fc, size, cs);
1588 case FUSE_NOTIFY_RETRIEVE:
1589 return fuse_notify_retrieve(fc, size, cs);
1592 fuse_copy_finish(cs);
1597 /* Look up request on processing list by unique ID */
1598 static struct fuse_req *request_find(struct fuse_conn *fc, u64 unique)
1600 struct list_head *entry;
1602 list_for_each(entry, &fc->processing) {
1603 struct fuse_req *req;
1604 req = list_entry(entry, struct fuse_req, list);
1605 if (req->in.h.unique == unique || req->intr_unique == unique)
1611 static int copy_out_args(struct fuse_copy_state *cs, struct fuse_out *out,
1614 unsigned reqsize = sizeof(struct fuse_out_header);
1617 return nbytes != reqsize ? -EINVAL : 0;
1619 reqsize += len_args(out->numargs, out->args);
1621 if (reqsize < nbytes || (reqsize > nbytes && !out->argvar))
1623 else if (reqsize > nbytes) {
1624 struct fuse_arg *lastarg = &out->args[out->numargs-1];
1625 unsigned diffsize = reqsize - nbytes;
1626 if (diffsize > lastarg->size)
1628 lastarg->size -= diffsize;
1630 return fuse_copy_args(cs, out->numargs, out->argpages, out->args,
1635 * Write a single reply to a request. First the header is copied from
1636 * the write buffer. The request is then searched on the processing
1637 * list by the unique ID found in the header. If found, then remove
1638 * it from the list and copy the rest of the buffer to the request.
1639 * The request is finished by calling request_end()
1641 static ssize_t fuse_dev_do_write(struct fuse_conn *fc,
1642 struct fuse_copy_state *cs, size_t nbytes)
1645 struct fuse_req *req;
1646 struct fuse_out_header oh;
1648 if (nbytes < sizeof(struct fuse_out_header))
1651 err = fuse_copy_one(cs, &oh, sizeof(oh));
1656 if (oh.len != nbytes)
1660 * Zero oh.unique indicates unsolicited notification message
1661 * and error contains notification code.
1664 err = fuse_notify(fc, oh.error, nbytes - sizeof(oh), cs);
1665 return err ? err : nbytes;
1669 if (oh.error <= -1000 || oh.error > 0)
1672 spin_lock(&fc->lock);
1677 req = request_find(fc, oh.unique);
1682 spin_unlock(&fc->lock);
1683 fuse_copy_finish(cs);
1684 spin_lock(&fc->lock);
1685 request_end(fc, req);
1688 /* Is it an interrupt reply? */
1689 if (req->intr_unique == oh.unique) {
1691 if (nbytes != sizeof(struct fuse_out_header))
1694 if (oh.error == -ENOSYS)
1695 fc->no_interrupt = 1;
1696 else if (oh.error == -EAGAIN)
1697 queue_interrupt(fc, req);
1699 spin_unlock(&fc->lock);
1700 fuse_copy_finish(cs);
1704 req->state = FUSE_REQ_WRITING;
1705 list_move(&req->list, &fc->io);
1709 if (!req->out.page_replace)
1711 spin_unlock(&fc->lock);
1713 err = copy_out_args(cs, &req->out, nbytes);
1714 fuse_copy_finish(cs);
1716 spin_lock(&fc->lock);
1721 } else if (!req->aborted)
1722 req->out.h.error = -EIO;
1723 request_end(fc, req);
1725 return err ? err : nbytes;
1728 spin_unlock(&fc->lock);
1730 fuse_copy_finish(cs);
1734 static ssize_t fuse_dev_write(struct kiocb *iocb, const struct iovec *iov,
1735 unsigned long nr_segs, loff_t pos)
1737 struct fuse_copy_state cs;
1738 struct fuse_conn *fc = fuse_get_conn(iocb->ki_filp);
1742 fuse_copy_init(&cs, fc, 0, iov, nr_segs);
1744 return fuse_dev_do_write(fc, &cs, iov_length(iov, nr_segs));
1747 static ssize_t fuse_dev_splice_write(struct pipe_inode_info *pipe,
1748 struct file *out, loff_t *ppos,
1749 size_t len, unsigned int flags)
1753 struct pipe_buffer *bufs;
1754 struct fuse_copy_state cs;
1755 struct fuse_conn *fc;
1759 fc = fuse_get_conn(out);
1763 bufs = kmalloc(pipe->buffers * sizeof(struct pipe_buffer), GFP_KERNEL);
1770 for (idx = 0; idx < pipe->nrbufs && rem < len; idx++)
1771 rem += pipe->bufs[(pipe->curbuf + idx) & (pipe->buffers - 1)].len;
1781 struct pipe_buffer *ibuf;
1782 struct pipe_buffer *obuf;
1784 BUG_ON(nbuf >= pipe->buffers);
1785 BUG_ON(!pipe->nrbufs);
1786 ibuf = &pipe->bufs[pipe->curbuf];
1789 if (rem >= ibuf->len) {
1792 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
1795 ibuf->ops->get(pipe, ibuf);
1797 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1799 ibuf->offset += obuf->len;
1800 ibuf->len -= obuf->len;
1807 fuse_copy_init(&cs, fc, 0, NULL, nbuf);
1811 if (flags & SPLICE_F_MOVE)
1814 ret = fuse_dev_do_write(fc, &cs, len);
1816 for (idx = 0; idx < nbuf; idx++) {
1817 struct pipe_buffer *buf = &bufs[idx];
1818 buf->ops->release(pipe, buf);
1825 static unsigned fuse_dev_poll(struct file *file, poll_table *wait)
1827 unsigned mask = POLLOUT | POLLWRNORM;
1828 struct fuse_conn *fc = fuse_get_conn(file);
1832 poll_wait(file, &fc->waitq, wait);
1834 spin_lock(&fc->lock);
1837 else if (request_pending(fc))
1838 mask |= POLLIN | POLLRDNORM;
1839 spin_unlock(&fc->lock);
1845 * Abort all requests on the given list (pending or processing)
1847 * This function releases and reacquires fc->lock
1849 static void end_requests(struct fuse_conn *fc, struct list_head *head)
1850 __releases(fc->lock)
1851 __acquires(fc->lock)
1853 while (!list_empty(head)) {
1854 struct fuse_req *req;
1855 req = list_entry(head->next, struct fuse_req, list);
1856 req->out.h.error = -ECONNABORTED;
1857 request_end(fc, req);
1858 spin_lock(&fc->lock);
1863 * Abort requests under I/O
1865 * The requests are set to aborted and finished, and the request
1866 * waiter is woken up. This will make request_wait_answer() wait
1867 * until the request is unlocked and then return.
1869 * If the request is asynchronous, then the end function needs to be
1870 * called after waiting for the request to be unlocked (if it was
1873 static void end_io_requests(struct fuse_conn *fc)
1874 __releases(fc->lock)
1875 __acquires(fc->lock)
1877 while (!list_empty(&fc->io)) {
1878 struct fuse_req *req =
1879 list_entry(fc->io.next, struct fuse_req, list);
1880 void (*end) (struct fuse_conn *, struct fuse_req *) = req->end;
1883 req->out.h.error = -ECONNABORTED;
1884 req->state = FUSE_REQ_FINISHED;
1885 list_del_init(&req->list);
1886 wake_up(&req->waitq);
1889 __fuse_get_request(req);
1890 spin_unlock(&fc->lock);
1891 wait_event(req->waitq, !req->locked);
1893 fuse_put_request(fc, req);
1894 spin_lock(&fc->lock);
1899 static void end_queued_requests(struct fuse_conn *fc)
1900 __releases(fc->lock)
1901 __acquires(fc->lock)
1903 fc->max_background = UINT_MAX;
1905 end_requests(fc, &fc->pending);
1906 end_requests(fc, &fc->processing);
1907 while (forget_pending(fc))
1908 kfree(dequeue_forget(fc, 1, NULL));
1911 static void end_polls(struct fuse_conn *fc)
1915 p = rb_first(&fc->polled_files);
1918 struct fuse_file *ff;
1919 ff = rb_entry(p, struct fuse_file, polled_node);
1920 wake_up_interruptible_all(&ff->poll_wait);
1927 * Abort all requests.
1929 * Emergency exit in case of a malicious or accidental deadlock, or
1930 * just a hung filesystem.
1932 * The same effect is usually achievable through killing the
1933 * filesystem daemon and all users of the filesystem. The exception
1934 * is the combination of an asynchronous request and the tricky
1935 * deadlock (see Documentation/filesystems/fuse.txt).
1937 * During the aborting, progression of requests from the pending and
1938 * processing lists onto the io list, and progression of new requests
1939 * onto the pending list is prevented by req->connected being false.
1941 * Progression of requests under I/O to the processing list is
1942 * prevented by the req->aborted flag being true for these requests.
1943 * For this reason requests on the io list must be aborted first.
1945 void fuse_abort_conn(struct fuse_conn *fc)
1947 spin_lock(&fc->lock);
1948 if (fc->connected) {
1951 end_io_requests(fc);
1952 end_queued_requests(fc);
1954 wake_up_all(&fc->waitq);
1955 wake_up_all(&fc->blocked_waitq);
1956 kill_fasync(&fc->fasync, SIGIO, POLL_IN);
1958 spin_unlock(&fc->lock);
1960 EXPORT_SYMBOL_GPL(fuse_abort_conn);
1962 int fuse_dev_release(struct inode *inode, struct file *file)
1964 struct fuse_conn *fc = fuse_get_conn(file);
1966 spin_lock(&fc->lock);
1969 end_queued_requests(fc);
1971 wake_up_all(&fc->blocked_waitq);
1972 spin_unlock(&fc->lock);
1978 EXPORT_SYMBOL_GPL(fuse_dev_release);
1980 static int fuse_dev_fasync(int fd, struct file *file, int on)
1982 struct fuse_conn *fc = fuse_get_conn(file);
1986 /* No locking - fasync_helper does its own locking */
1987 return fasync_helper(fd, file, on, &fc->fasync);
1990 const struct file_operations fuse_dev_operations = {
1991 .owner = THIS_MODULE,
1992 .llseek = no_llseek,
1993 .read = do_sync_read,
1994 .aio_read = fuse_dev_read,
1995 .splice_read = fuse_dev_splice_read,
1996 .write = do_sync_write,
1997 .aio_write = fuse_dev_write,
1998 .splice_write = fuse_dev_splice_write,
1999 .poll = fuse_dev_poll,
2000 .release = fuse_dev_release,
2001 .fasync = fuse_dev_fasync,
2003 EXPORT_SYMBOL_GPL(fuse_dev_operations);
2005 static struct miscdevice fuse_miscdevice = {
2006 .minor = FUSE_MINOR,
2008 .fops = &fuse_dev_operations,
2011 int __init fuse_dev_init(void)
2014 fuse_req_cachep = kmem_cache_create("fuse_request",
2015 sizeof(struct fuse_req),
2017 if (!fuse_req_cachep)
2020 err = misc_register(&fuse_miscdevice);
2022 goto out_cache_clean;
2027 kmem_cache_destroy(fuse_req_cachep);
2032 void fuse_dev_cleanup(void)
2034 misc_deregister(&fuse_miscdevice);
2035 kmem_cache_destroy(fuse_req_cachep);