2 FUSE: Filesystem in Userspace
3 Copyright (C) 2001-2006 Miklos Szeredi <miklos@szeredi.hu>
5 This program can be distributed under the terms of the GNU GPL.
11 #include <linux/pagemap.h>
12 #include <linux/slab.h>
13 #include <linux/kernel.h>
14 #include <linux/sched.h>
16 static const struct file_operations fuse_direct_io_file_operations;
18 static int fuse_send_open(struct inode *inode, struct file *file, int isdir,
19 struct fuse_open_out *outargp)
21 struct fuse_conn *fc = get_fuse_conn(inode);
22 struct fuse_open_in inarg;
26 req = fuse_get_req(fc);
30 memset(&inarg, 0, sizeof(inarg));
31 inarg.flags = file->f_flags & ~(O_CREAT | O_EXCL | O_NOCTTY);
32 if (!fc->atomic_o_trunc)
33 inarg.flags &= ~O_TRUNC;
34 req->in.h.opcode = isdir ? FUSE_OPENDIR : FUSE_OPEN;
35 req->in.h.nodeid = get_node_id(inode);
37 req->in.args[0].size = sizeof(inarg);
38 req->in.args[0].value = &inarg;
40 req->out.args[0].size = sizeof(*outargp);
41 req->out.args[0].value = outargp;
42 request_send(fc, req);
43 err = req->out.h.error;
44 fuse_put_request(fc, req);
49 struct fuse_file *fuse_file_alloc(void)
52 ff = kmalloc(sizeof(struct fuse_file), GFP_KERNEL);
54 ff->reserved_req = fuse_request_alloc();
55 if (!ff->reserved_req) {
59 INIT_LIST_HEAD(&ff->write_entry);
60 atomic_set(&ff->count, 0);
65 void fuse_file_free(struct fuse_file *ff)
67 fuse_request_free(ff->reserved_req);
71 static struct fuse_file *fuse_file_get(struct fuse_file *ff)
73 atomic_inc(&ff->count);
77 static void fuse_release_end(struct fuse_conn *fc, struct fuse_req *req)
80 mntput(req->vfsmount);
81 fuse_put_request(fc, req);
84 static void fuse_file_put(struct fuse_file *ff)
86 if (atomic_dec_and_test(&ff->count)) {
87 struct fuse_req *req = ff->reserved_req;
88 struct fuse_conn *fc = get_fuse_conn(req->dentry->d_inode);
89 req->end = fuse_release_end;
90 request_send_background(fc, req);
95 void fuse_finish_open(struct inode *inode, struct file *file,
96 struct fuse_file *ff, struct fuse_open_out *outarg)
98 if (outarg->open_flags & FOPEN_DIRECT_IO)
99 file->f_op = &fuse_direct_io_file_operations;
100 if (!(outarg->open_flags & FOPEN_KEEP_CACHE))
101 invalidate_inode_pages2(inode->i_mapping);
103 file->private_data = fuse_file_get(ff);
106 int fuse_open_common(struct inode *inode, struct file *file, int isdir)
108 struct fuse_open_out outarg;
109 struct fuse_file *ff;
112 /* VFS checks this, but only _after_ ->open() */
113 if (file->f_flags & O_DIRECT)
116 err = generic_file_open(inode, file);
120 ff = fuse_file_alloc();
124 err = fuse_send_open(inode, file, isdir, &outarg);
129 outarg.open_flags &= ~FOPEN_DIRECT_IO;
130 fuse_finish_open(inode, file, ff, &outarg);
136 void fuse_release_fill(struct fuse_file *ff, u64 nodeid, int flags, int opcode)
138 struct fuse_req *req = ff->reserved_req;
139 struct fuse_release_in *inarg = &req->misc.release_in;
142 inarg->flags = flags;
143 req->in.h.opcode = opcode;
144 req->in.h.nodeid = nodeid;
146 req->in.args[0].size = sizeof(struct fuse_release_in);
147 req->in.args[0].value = inarg;
150 int fuse_release_common(struct inode *inode, struct file *file, int isdir)
152 struct fuse_file *ff = file->private_data;
154 struct fuse_conn *fc = get_fuse_conn(inode);
156 fuse_release_fill(ff, get_node_id(inode), file->f_flags,
157 isdir ? FUSE_RELEASEDIR : FUSE_RELEASE);
159 /* Hold vfsmount and dentry until release is finished */
160 ff->reserved_req->vfsmount = mntget(file->f_path.mnt);
161 ff->reserved_req->dentry = dget(file->f_path.dentry);
163 spin_lock(&fc->lock);
164 list_del(&ff->write_entry);
165 spin_unlock(&fc->lock);
167 * Normally this will send the RELEASE request,
168 * however if some asynchronous READ or WRITE requests
169 * are outstanding, the sending will be delayed
174 /* Return value is ignored by VFS */
178 static int fuse_open(struct inode *inode, struct file *file)
180 return fuse_open_common(inode, file, 0);
183 static int fuse_release(struct inode *inode, struct file *file)
185 return fuse_release_common(inode, file, 0);
189 * Scramble the ID space with XTEA, so that the value of the files_struct
190 * pointer is not exposed to userspace.
192 static u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id)
194 u32 *k = fc->scramble_key;
195 u64 v = (unsigned long) id;
201 for (i = 0; i < 32; i++) {
202 v0 += ((v1 << 4 ^ v1 >> 5) + v1) ^ (sum + k[sum & 3]);
204 v1 += ((v0 << 4 ^ v0 >> 5) + v0) ^ (sum + k[sum>>11 & 3]);
207 return (u64) v0 + ((u64) v1 << 32);
210 static int fuse_flush(struct file *file, fl_owner_t id)
212 struct inode *inode = file->f_path.dentry->d_inode;
213 struct fuse_conn *fc = get_fuse_conn(inode);
214 struct fuse_file *ff = file->private_data;
215 struct fuse_req *req;
216 struct fuse_flush_in inarg;
219 if (is_bad_inode(inode))
225 req = fuse_get_req_nofail(fc, file);
226 memset(&inarg, 0, sizeof(inarg));
228 inarg.lock_owner = fuse_lock_owner_id(fc, id);
229 req->in.h.opcode = FUSE_FLUSH;
230 req->in.h.nodeid = get_node_id(inode);
232 req->in.args[0].size = sizeof(inarg);
233 req->in.args[0].value = &inarg;
235 request_send(fc, req);
236 err = req->out.h.error;
237 fuse_put_request(fc, req);
238 if (err == -ENOSYS) {
245 int fuse_fsync_common(struct file *file, struct dentry *de, int datasync,
248 struct inode *inode = de->d_inode;
249 struct fuse_conn *fc = get_fuse_conn(inode);
250 struct fuse_file *ff = file->private_data;
251 struct fuse_req *req;
252 struct fuse_fsync_in inarg;
255 if (is_bad_inode(inode))
258 if ((!isdir && fc->no_fsync) || (isdir && fc->no_fsyncdir))
261 req = fuse_get_req(fc);
265 memset(&inarg, 0, sizeof(inarg));
267 inarg.fsync_flags = datasync ? 1 : 0;
268 req->in.h.opcode = isdir ? FUSE_FSYNCDIR : FUSE_FSYNC;
269 req->in.h.nodeid = get_node_id(inode);
271 req->in.args[0].size = sizeof(inarg);
272 req->in.args[0].value = &inarg;
273 request_send(fc, req);
274 err = req->out.h.error;
275 fuse_put_request(fc, req);
276 if (err == -ENOSYS) {
286 static int fuse_fsync(struct file *file, struct dentry *de, int datasync)
288 return fuse_fsync_common(file, de, datasync, 0);
291 void fuse_read_fill(struct fuse_req *req, struct fuse_file *ff,
292 struct inode *inode, loff_t pos, size_t count, int opcode)
294 struct fuse_read_in *inarg = &req->misc.read_in;
299 req->in.h.opcode = opcode;
300 req->in.h.nodeid = get_node_id(inode);
302 req->in.args[0].size = sizeof(struct fuse_read_in);
303 req->in.args[0].value = inarg;
304 req->out.argpages = 1;
306 req->out.numargs = 1;
307 req->out.args[0].size = count;
310 static size_t fuse_send_read(struct fuse_req *req, struct file *file,
311 struct inode *inode, loff_t pos, size_t count)
313 struct fuse_conn *fc = get_fuse_conn(inode);
314 struct fuse_file *ff = file->private_data;
315 fuse_read_fill(req, ff, inode, pos, count, FUSE_READ);
316 request_send(fc, req);
317 return req->out.args[0].size;
320 static int fuse_readpage(struct file *file, struct page *page)
322 struct inode *inode = page->mapping->host;
323 struct fuse_conn *fc = get_fuse_conn(inode);
324 struct fuse_req *req;
328 if (is_bad_inode(inode))
331 req = fuse_get_req(fc);
336 req->out.page_zeroing = 1;
338 req->pages[0] = page;
339 fuse_send_read(req, file, inode, page_offset(page), PAGE_CACHE_SIZE);
340 err = req->out.h.error;
341 fuse_put_request(fc, req);
343 SetPageUptodate(page);
344 fuse_invalidate_attr(inode); /* atime changed */
350 static void fuse_readpages_end(struct fuse_conn *fc, struct fuse_req *req)
354 fuse_invalidate_attr(req->pages[0]->mapping->host); /* atime changed */
356 for (i = 0; i < req->num_pages; i++) {
357 struct page *page = req->pages[i];
358 if (!req->out.h.error)
359 SetPageUptodate(page);
365 fuse_file_put(req->ff);
366 fuse_put_request(fc, req);
369 static void fuse_send_readpages(struct fuse_req *req, struct fuse_file *ff,
372 struct fuse_conn *fc = get_fuse_conn(inode);
373 loff_t pos = page_offset(req->pages[0]);
374 size_t count = req->num_pages << PAGE_CACHE_SHIFT;
375 req->out.page_zeroing = 1;
376 fuse_read_fill(req, ff, inode, pos, count, FUSE_READ);
377 if (fc->async_read) {
378 req->ff = fuse_file_get(ff);
379 req->end = fuse_readpages_end;
380 request_send_background(fc, req);
382 request_send(fc, req);
383 fuse_readpages_end(fc, req);
387 struct fuse_fill_data {
388 struct fuse_req *req;
389 struct fuse_file *ff;
393 static int fuse_readpages_fill(void *_data, struct page *page)
395 struct fuse_fill_data *data = _data;
396 struct fuse_req *req = data->req;
397 struct inode *inode = data->inode;
398 struct fuse_conn *fc = get_fuse_conn(inode);
400 if (req->num_pages &&
401 (req->num_pages == FUSE_MAX_PAGES_PER_REQ ||
402 (req->num_pages + 1) * PAGE_CACHE_SIZE > fc->max_read ||
403 req->pages[req->num_pages - 1]->index + 1 != page->index)) {
404 fuse_send_readpages(req, data->ff, inode);
405 data->req = req = fuse_get_req(fc);
411 req->pages[req->num_pages] = page;
416 static int fuse_readpages(struct file *file, struct address_space *mapping,
417 struct list_head *pages, unsigned nr_pages)
419 struct inode *inode = mapping->host;
420 struct fuse_conn *fc = get_fuse_conn(inode);
421 struct fuse_fill_data data;
425 if (is_bad_inode(inode))
428 data.ff = file->private_data;
430 data.req = fuse_get_req(fc);
431 err = PTR_ERR(data.req);
432 if (IS_ERR(data.req))
435 err = read_cache_pages(mapping, pages, fuse_readpages_fill, &data);
437 if (data.req->num_pages)
438 fuse_send_readpages(data.req, data.ff, inode);
440 fuse_put_request(fc, data.req);
446 static size_t fuse_send_write(struct fuse_req *req, struct file *file,
447 struct inode *inode, loff_t pos, size_t count)
449 struct fuse_conn *fc = get_fuse_conn(inode);
450 struct fuse_file *ff = file->private_data;
451 struct fuse_write_in inarg;
452 struct fuse_write_out outarg;
454 memset(&inarg, 0, sizeof(struct fuse_write_in));
458 req->in.h.opcode = FUSE_WRITE;
459 req->in.h.nodeid = get_node_id(inode);
460 req->in.argpages = 1;
462 req->in.args[0].size = sizeof(struct fuse_write_in);
463 req->in.args[0].value = &inarg;
464 req->in.args[1].size = count;
465 req->out.numargs = 1;
466 req->out.args[0].size = sizeof(struct fuse_write_out);
467 req->out.args[0].value = &outarg;
468 request_send(fc, req);
472 static int fuse_write_begin(struct file *file, struct address_space *mapping,
473 loff_t pos, unsigned len, unsigned flags,
474 struct page **pagep, void **fsdata)
476 pgoff_t index = pos >> PAGE_CACHE_SHIFT;
478 *pagep = __grab_cache_page(mapping, index);
484 static int fuse_buffered_write(struct file *file, struct inode *inode,
485 loff_t pos, unsigned count, struct page *page)
489 struct fuse_conn *fc = get_fuse_conn(inode);
490 struct fuse_inode *fi = get_fuse_inode(inode);
491 unsigned offset = pos & (PAGE_CACHE_SIZE - 1);
492 struct fuse_req *req;
494 if (is_bad_inode(inode))
497 req = fuse_get_req(fc);
502 req->pages[0] = page;
503 req->page_offset = offset;
504 nres = fuse_send_write(req, file, inode, pos, count);
505 err = req->out.h.error;
506 fuse_put_request(fc, req);
511 spin_lock(&fc->lock);
512 fi->attr_version = ++fc->attr_version;
513 if (pos > inode->i_size)
514 i_size_write(inode, pos);
515 spin_unlock(&fc->lock);
517 if (count == PAGE_CACHE_SIZE)
518 SetPageUptodate(page);
520 fuse_invalidate_attr(inode);
521 return err ? err : nres;
524 static int fuse_write_end(struct file *file, struct address_space *mapping,
525 loff_t pos, unsigned len, unsigned copied,
526 struct page *page, void *fsdata)
528 struct inode *inode = mapping->host;
532 res = fuse_buffered_write(file, inode, pos, copied, page);
535 page_cache_release(page);
539 static void fuse_release_user_pages(struct fuse_req *req, int write)
543 for (i = 0; i < req->num_pages; i++) {
544 struct page *page = req->pages[i];
546 set_page_dirty_lock(page);
551 static int fuse_get_user_pages(struct fuse_req *req, const char __user *buf,
552 unsigned nbytes, int write)
554 unsigned long user_addr = (unsigned long) buf;
555 unsigned offset = user_addr & ~PAGE_MASK;
558 /* This doesn't work with nfsd */
562 nbytes = min(nbytes, (unsigned) FUSE_MAX_PAGES_PER_REQ << PAGE_SHIFT);
563 npages = (nbytes + offset + PAGE_SIZE - 1) >> PAGE_SHIFT;
564 npages = min(max(npages, 1), FUSE_MAX_PAGES_PER_REQ);
565 down_read(¤t->mm->mmap_sem);
566 npages = get_user_pages(current, current->mm, user_addr, npages, write,
567 0, req->pages, NULL);
568 up_read(¤t->mm->mmap_sem);
572 req->num_pages = npages;
573 req->page_offset = offset;
577 static ssize_t fuse_direct_io(struct file *file, const char __user *buf,
578 size_t count, loff_t *ppos, int write)
580 struct inode *inode = file->f_path.dentry->d_inode;
581 struct fuse_conn *fc = get_fuse_conn(inode);
582 size_t nmax = write ? fc->max_write : fc->max_read;
585 struct fuse_req *req;
587 if (is_bad_inode(inode))
590 req = fuse_get_req(fc);
596 size_t nbytes = min(count, nmax);
597 int err = fuse_get_user_pages(req, buf, nbytes, !write);
602 nbytes = (req->num_pages << PAGE_SHIFT) - req->page_offset;
603 nbytes = min(count, nbytes);
605 nres = fuse_send_write(req, file, inode, pos, nbytes);
607 nres = fuse_send_read(req, file, inode, pos, nbytes);
608 fuse_release_user_pages(req, !write);
609 if (req->out.h.error) {
611 res = req->out.h.error;
613 } else if (nres > nbytes) {
624 fuse_put_request(fc, req);
625 req = fuse_get_req(fc);
630 fuse_put_request(fc, req);
633 spin_lock(&fc->lock);
634 if (pos > inode->i_size)
635 i_size_write(inode, pos);
636 spin_unlock(&fc->lock);
640 fuse_invalidate_attr(inode);
645 static ssize_t fuse_direct_read(struct file *file, char __user *buf,
646 size_t count, loff_t *ppos)
648 return fuse_direct_io(file, buf, count, ppos, 0);
651 static ssize_t fuse_direct_write(struct file *file, const char __user *buf,
652 size_t count, loff_t *ppos)
654 struct inode *inode = file->f_path.dentry->d_inode;
656 /* Don't allow parallel writes to the same file */
657 mutex_lock(&inode->i_mutex);
658 res = generic_write_checks(file, ppos, &count, 0);
660 res = fuse_direct_io(file, buf, count, ppos, 1);
661 mutex_unlock(&inode->i_mutex);
665 static int fuse_file_mmap(struct file *file, struct vm_area_struct *vma)
667 if ((vma->vm_flags & VM_SHARED)) {
668 if ((vma->vm_flags & VM_WRITE))
671 vma->vm_flags &= ~VM_MAYWRITE;
673 return generic_file_mmap(file, vma);
676 static int fuse_set_page_dirty(struct page *page)
678 printk("fuse_set_page_dirty: should not happen\n");
683 static int convert_fuse_file_lock(const struct fuse_file_lock *ffl,
684 struct file_lock *fl)
692 if (ffl->start > OFFSET_MAX || ffl->end > OFFSET_MAX ||
693 ffl->end < ffl->start)
696 fl->fl_start = ffl->start;
697 fl->fl_end = ffl->end;
698 fl->fl_pid = ffl->pid;
704 fl->fl_type = ffl->type;
708 static void fuse_lk_fill(struct fuse_req *req, struct file *file,
709 const struct file_lock *fl, int opcode, pid_t pid,
712 struct inode *inode = file->f_path.dentry->d_inode;
713 struct fuse_conn *fc = get_fuse_conn(inode);
714 struct fuse_file *ff = file->private_data;
715 struct fuse_lk_in *arg = &req->misc.lk_in;
718 arg->owner = fuse_lock_owner_id(fc, fl->fl_owner);
719 arg->lk.start = fl->fl_start;
720 arg->lk.end = fl->fl_end;
721 arg->lk.type = fl->fl_type;
724 arg->lk_flags |= FUSE_LK_FLOCK;
725 req->in.h.opcode = opcode;
726 req->in.h.nodeid = get_node_id(inode);
728 req->in.args[0].size = sizeof(*arg);
729 req->in.args[0].value = arg;
732 static int fuse_getlk(struct file *file, struct file_lock *fl)
734 struct inode *inode = file->f_path.dentry->d_inode;
735 struct fuse_conn *fc = get_fuse_conn(inode);
736 struct fuse_req *req;
737 struct fuse_lk_out outarg;
740 req = fuse_get_req(fc);
744 fuse_lk_fill(req, file, fl, FUSE_GETLK, 0, 0);
745 req->out.numargs = 1;
746 req->out.args[0].size = sizeof(outarg);
747 req->out.args[0].value = &outarg;
748 request_send(fc, req);
749 err = req->out.h.error;
750 fuse_put_request(fc, req);
752 err = convert_fuse_file_lock(&outarg.lk, fl);
757 static int fuse_setlk(struct file *file, struct file_lock *fl, int flock)
759 struct inode *inode = file->f_path.dentry->d_inode;
760 struct fuse_conn *fc = get_fuse_conn(inode);
761 struct fuse_req *req;
762 int opcode = (fl->fl_flags & FL_SLEEP) ? FUSE_SETLKW : FUSE_SETLK;
763 pid_t pid = fl->fl_type != F_UNLCK ? current->tgid : 0;
766 /* Unlock on close is handled by the flush method */
767 if (fl->fl_flags & FL_CLOSE)
770 req = fuse_get_req(fc);
774 fuse_lk_fill(req, file, fl, opcode, pid, flock);
775 request_send(fc, req);
776 err = req->out.h.error;
777 /* locking is restartable */
780 fuse_put_request(fc, req);
784 static int fuse_file_lock(struct file *file, int cmd, struct file_lock *fl)
786 struct inode *inode = file->f_path.dentry->d_inode;
787 struct fuse_conn *fc = get_fuse_conn(inode);
790 if (cmd == F_GETLK) {
792 posix_test_lock(file, fl);
795 err = fuse_getlk(file, fl);
798 err = posix_lock_file_wait(file, fl);
800 err = fuse_setlk(file, fl, 0);
805 static int fuse_file_flock(struct file *file, int cmd, struct file_lock *fl)
807 struct inode *inode = file->f_path.dentry->d_inode;
808 struct fuse_conn *fc = get_fuse_conn(inode);
812 err = flock_lock_file_wait(file, fl);
814 /* emulate flock with POSIX locks */
815 fl->fl_owner = (fl_owner_t) file;
816 err = fuse_setlk(file, fl, 1);
822 static sector_t fuse_bmap(struct address_space *mapping, sector_t block)
824 struct inode *inode = mapping->host;
825 struct fuse_conn *fc = get_fuse_conn(inode);
826 struct fuse_req *req;
827 struct fuse_bmap_in inarg;
828 struct fuse_bmap_out outarg;
831 if (!inode->i_sb->s_bdev || fc->no_bmap)
834 req = fuse_get_req(fc);
838 memset(&inarg, 0, sizeof(inarg));
840 inarg.blocksize = inode->i_sb->s_blocksize;
841 req->in.h.opcode = FUSE_BMAP;
842 req->in.h.nodeid = get_node_id(inode);
844 req->in.args[0].size = sizeof(inarg);
845 req->in.args[0].value = &inarg;
846 req->out.numargs = 1;
847 req->out.args[0].size = sizeof(outarg);
848 req->out.args[0].value = &outarg;
849 request_send(fc, req);
850 err = req->out.h.error;
851 fuse_put_request(fc, req);
855 return err ? 0 : outarg.block;
858 static const struct file_operations fuse_file_operations = {
859 .llseek = generic_file_llseek,
860 .read = do_sync_read,
861 .aio_read = generic_file_aio_read,
862 .write = do_sync_write,
863 .aio_write = generic_file_aio_write,
864 .mmap = fuse_file_mmap,
867 .release = fuse_release,
869 .lock = fuse_file_lock,
870 .flock = fuse_file_flock,
871 .splice_read = generic_file_splice_read,
874 static const struct file_operations fuse_direct_io_file_operations = {
875 .llseek = generic_file_llseek,
876 .read = fuse_direct_read,
877 .write = fuse_direct_write,
880 .release = fuse_release,
882 .lock = fuse_file_lock,
883 .flock = fuse_file_flock,
884 /* no mmap and splice_read */
887 static const struct address_space_operations fuse_file_aops = {
888 .readpage = fuse_readpage,
889 .write_begin = fuse_write_begin,
890 .write_end = fuse_write_end,
891 .readpages = fuse_readpages,
892 .set_page_dirty = fuse_set_page_dirty,
896 void fuse_init_file_inode(struct inode *inode)
898 inode->i_fop = &fuse_file_operations;
899 inode->i_data.a_ops = &fuse_file_aops;