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);
66 void fuse_file_free(struct fuse_file *ff)
68 fuse_request_free(ff->reserved_req);
72 static struct fuse_file *fuse_file_get(struct fuse_file *ff)
74 atomic_inc(&ff->count);
78 static void fuse_release_end(struct fuse_conn *fc, struct fuse_req *req)
81 mntput(req->vfsmount);
82 fuse_put_request(fc, req);
85 static void fuse_file_put(struct fuse_file *ff)
87 if (atomic_dec_and_test(&ff->count)) {
88 struct fuse_req *req = ff->reserved_req;
89 struct fuse_conn *fc = get_fuse_conn(req->dentry->d_inode);
90 req->end = fuse_release_end;
91 request_send_background(fc, req);
96 void fuse_finish_open(struct inode *inode, struct file *file,
97 struct fuse_file *ff, struct fuse_open_out *outarg)
99 if (outarg->open_flags & FOPEN_DIRECT_IO)
100 file->f_op = &fuse_direct_io_file_operations;
101 if (!(outarg->open_flags & FOPEN_KEEP_CACHE))
102 invalidate_inode_pages2(inode->i_mapping);
104 file->private_data = fuse_file_get(ff);
107 int fuse_open_common(struct inode *inode, struct file *file, int isdir)
109 struct fuse_open_out outarg;
110 struct fuse_file *ff;
113 /* VFS checks this, but only _after_ ->open() */
114 if (file->f_flags & O_DIRECT)
117 err = generic_file_open(inode, file);
121 ff = fuse_file_alloc();
125 err = fuse_send_open(inode, file, isdir, &outarg);
130 outarg.open_flags &= ~FOPEN_DIRECT_IO;
131 fuse_finish_open(inode, file, ff, &outarg);
137 void fuse_release_fill(struct fuse_file *ff, u64 nodeid, int flags, int opcode)
139 struct fuse_req *req = ff->reserved_req;
140 struct fuse_release_in *inarg = &req->misc.release_in;
143 inarg->flags = flags;
144 req->in.h.opcode = opcode;
145 req->in.h.nodeid = nodeid;
147 req->in.args[0].size = sizeof(struct fuse_release_in);
148 req->in.args[0].value = inarg;
151 int fuse_release_common(struct inode *inode, struct file *file, int isdir)
153 struct fuse_file *ff = file->private_data;
155 struct fuse_conn *fc = get_fuse_conn(inode);
157 fuse_release_fill(ff, get_node_id(inode), file->f_flags,
158 isdir ? FUSE_RELEASEDIR : FUSE_RELEASE);
160 /* Hold vfsmount and dentry until release is finished */
161 ff->reserved_req->vfsmount = mntget(file->f_path.mnt);
162 ff->reserved_req->dentry = dget(file->f_path.dentry);
164 spin_lock(&fc->lock);
165 list_del(&ff->write_entry);
166 spin_unlock(&fc->lock);
168 * Normally this will send the RELEASE request,
169 * however if some asynchronous READ or WRITE requests
170 * are outstanding, the sending will be delayed
175 /* Return value is ignored by VFS */
179 static int fuse_open(struct inode *inode, struct file *file)
181 return fuse_open_common(inode, file, 0);
184 static int fuse_release(struct inode *inode, struct file *file)
186 return fuse_release_common(inode, file, 0);
190 * Scramble the ID space with XTEA, so that the value of the files_struct
191 * pointer is not exposed to userspace.
193 u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id)
195 u32 *k = fc->scramble_key;
196 u64 v = (unsigned long) id;
202 for (i = 0; i < 32; i++) {
203 v0 += ((v1 << 4 ^ v1 >> 5) + v1) ^ (sum + k[sum & 3]);
205 v1 += ((v0 << 4 ^ v0 >> 5) + v0) ^ (sum + k[sum>>11 & 3]);
208 return (u64) v0 + ((u64) v1 << 32);
211 static int fuse_flush(struct file *file, fl_owner_t id)
213 struct inode *inode = file->f_path.dentry->d_inode;
214 struct fuse_conn *fc = get_fuse_conn(inode);
215 struct fuse_file *ff = file->private_data;
216 struct fuse_req *req;
217 struct fuse_flush_in inarg;
220 if (is_bad_inode(inode))
226 req = fuse_get_req_nofail(fc, file);
227 memset(&inarg, 0, sizeof(inarg));
229 inarg.lock_owner = fuse_lock_owner_id(fc, id);
230 req->in.h.opcode = FUSE_FLUSH;
231 req->in.h.nodeid = get_node_id(inode);
233 req->in.args[0].size = sizeof(inarg);
234 req->in.args[0].value = &inarg;
236 request_send(fc, req);
237 err = req->out.h.error;
238 fuse_put_request(fc, req);
239 if (err == -ENOSYS) {
246 int fuse_fsync_common(struct file *file, struct dentry *de, int datasync,
249 struct inode *inode = de->d_inode;
250 struct fuse_conn *fc = get_fuse_conn(inode);
251 struct fuse_file *ff = file->private_data;
252 struct fuse_req *req;
253 struct fuse_fsync_in inarg;
256 if (is_bad_inode(inode))
259 if ((!isdir && fc->no_fsync) || (isdir && fc->no_fsyncdir))
262 req = fuse_get_req(fc);
266 memset(&inarg, 0, sizeof(inarg));
268 inarg.fsync_flags = datasync ? 1 : 0;
269 req->in.h.opcode = isdir ? FUSE_FSYNCDIR : FUSE_FSYNC;
270 req->in.h.nodeid = get_node_id(inode);
272 req->in.args[0].size = sizeof(inarg);
273 req->in.args[0].value = &inarg;
274 request_send(fc, req);
275 err = req->out.h.error;
276 fuse_put_request(fc, req);
277 if (err == -ENOSYS) {
287 static int fuse_fsync(struct file *file, struct dentry *de, int datasync)
289 return fuse_fsync_common(file, de, datasync, 0);
292 void fuse_read_fill(struct fuse_req *req, struct fuse_file *ff,
293 struct inode *inode, loff_t pos, size_t count, int opcode)
295 struct fuse_read_in *inarg = &req->misc.read_in;
300 req->in.h.opcode = opcode;
301 req->in.h.nodeid = get_node_id(inode);
303 req->in.args[0].size = sizeof(struct fuse_read_in);
304 req->in.args[0].value = inarg;
305 req->out.argpages = 1;
307 req->out.numargs = 1;
308 req->out.args[0].size = count;
311 static size_t fuse_send_read(struct fuse_req *req, struct file *file,
312 struct inode *inode, loff_t pos, size_t count,
315 struct fuse_conn *fc = get_fuse_conn(inode);
316 struct fuse_file *ff = file->private_data;
318 fuse_read_fill(req, ff, inode, pos, count, FUSE_READ);
320 struct fuse_read_in *inarg = &req->misc.read_in;
322 inarg->read_flags |= FUSE_READ_LOCKOWNER;
323 inarg->lock_owner = fuse_lock_owner_id(fc, owner);
325 request_send(fc, req);
326 return req->out.args[0].size;
329 static int fuse_readpage(struct file *file, struct page *page)
331 struct inode *inode = page->mapping->host;
332 struct fuse_conn *fc = get_fuse_conn(inode);
333 struct fuse_req *req;
337 if (is_bad_inode(inode))
340 req = fuse_get_req(fc);
345 req->out.page_zeroing = 1;
347 req->pages[0] = page;
348 fuse_send_read(req, file, inode, page_offset(page), PAGE_CACHE_SIZE,
350 err = req->out.h.error;
351 fuse_put_request(fc, req);
353 SetPageUptodate(page);
354 fuse_invalidate_attr(inode); /* atime changed */
360 static void fuse_readpages_end(struct fuse_conn *fc, struct fuse_req *req)
364 fuse_invalidate_attr(req->pages[0]->mapping->host); /* atime changed */
366 for (i = 0; i < req->num_pages; i++) {
367 struct page *page = req->pages[i];
368 if (!req->out.h.error)
369 SetPageUptodate(page);
375 fuse_file_put(req->ff);
376 fuse_put_request(fc, req);
379 static void fuse_send_readpages(struct fuse_req *req, struct fuse_file *ff,
382 struct fuse_conn *fc = get_fuse_conn(inode);
383 loff_t pos = page_offset(req->pages[0]);
384 size_t count = req->num_pages << PAGE_CACHE_SHIFT;
385 req->out.page_zeroing = 1;
386 fuse_read_fill(req, ff, inode, pos, count, FUSE_READ);
387 if (fc->async_read) {
388 req->ff = fuse_file_get(ff);
389 req->end = fuse_readpages_end;
390 request_send_background(fc, req);
392 request_send(fc, req);
393 fuse_readpages_end(fc, req);
397 struct fuse_fill_data {
398 struct fuse_req *req;
399 struct fuse_file *ff;
403 static int fuse_readpages_fill(void *_data, struct page *page)
405 struct fuse_fill_data *data = _data;
406 struct fuse_req *req = data->req;
407 struct inode *inode = data->inode;
408 struct fuse_conn *fc = get_fuse_conn(inode);
410 if (req->num_pages &&
411 (req->num_pages == FUSE_MAX_PAGES_PER_REQ ||
412 (req->num_pages + 1) * PAGE_CACHE_SIZE > fc->max_read ||
413 req->pages[req->num_pages - 1]->index + 1 != page->index)) {
414 fuse_send_readpages(req, data->ff, inode);
415 data->req = req = fuse_get_req(fc);
421 req->pages[req->num_pages] = page;
426 static int fuse_readpages(struct file *file, struct address_space *mapping,
427 struct list_head *pages, unsigned nr_pages)
429 struct inode *inode = mapping->host;
430 struct fuse_conn *fc = get_fuse_conn(inode);
431 struct fuse_fill_data data;
435 if (is_bad_inode(inode))
438 data.ff = file->private_data;
440 data.req = fuse_get_req(fc);
441 err = PTR_ERR(data.req);
442 if (IS_ERR(data.req))
445 err = read_cache_pages(mapping, pages, fuse_readpages_fill, &data);
447 if (data.req->num_pages)
448 fuse_send_readpages(data.req, data.ff, inode);
450 fuse_put_request(fc, data.req);
456 static ssize_t fuse_file_aio_read(struct kiocb *iocb, const struct iovec *iov,
457 unsigned long nr_segs, loff_t pos)
459 struct inode *inode = iocb->ki_filp->f_mapping->host;
461 if (pos + iov_length(iov, nr_segs) > i_size_read(inode)) {
464 * If trying to read past EOF, make sure the i_size
465 * attribute is up-to-date.
467 err = fuse_update_attributes(inode, NULL, iocb->ki_filp, NULL);
472 return generic_file_aio_read(iocb, iov, nr_segs, pos);
475 static void fuse_write_fill(struct fuse_req *req, struct fuse_file *ff,
476 struct inode *inode, loff_t pos, size_t count,
479 struct fuse_conn *fc = get_fuse_conn(inode);
480 struct fuse_write_in *inarg = &req->misc.write.in;
481 struct fuse_write_out *outarg = &req->misc.write.out;
483 memset(inarg, 0, sizeof(struct fuse_write_in));
487 inarg->write_flags = writepage ? FUSE_WRITE_CACHE : 0;
488 req->in.h.opcode = FUSE_WRITE;
489 req->in.h.nodeid = get_node_id(inode);
490 req->in.argpages = 1;
493 req->in.args[0].size = FUSE_COMPAT_WRITE_IN_SIZE;
495 req->in.args[0].size = sizeof(struct fuse_write_in);
496 req->in.args[0].value = inarg;
497 req->in.args[1].size = count;
498 req->out.numargs = 1;
499 req->out.args[0].size = sizeof(struct fuse_write_out);
500 req->out.args[0].value = outarg;
503 static size_t fuse_send_write(struct fuse_req *req, struct file *file,
504 struct inode *inode, loff_t pos, size_t count,
507 struct fuse_conn *fc = get_fuse_conn(inode);
508 fuse_write_fill(req, file->private_data, inode, pos, count, 0);
510 struct fuse_write_in *inarg = &req->misc.write.in;
511 inarg->write_flags |= FUSE_WRITE_LOCKOWNER;
512 inarg->lock_owner = fuse_lock_owner_id(fc, owner);
514 request_send(fc, req);
515 return req->misc.write.out.size;
518 static int fuse_write_begin(struct file *file, struct address_space *mapping,
519 loff_t pos, unsigned len, unsigned flags,
520 struct page **pagep, void **fsdata)
522 pgoff_t index = pos >> PAGE_CACHE_SHIFT;
524 *pagep = __grab_cache_page(mapping, index);
530 static int fuse_buffered_write(struct file *file, struct inode *inode,
531 loff_t pos, unsigned count, struct page *page)
535 struct fuse_conn *fc = get_fuse_conn(inode);
536 struct fuse_inode *fi = get_fuse_inode(inode);
537 unsigned offset = pos & (PAGE_CACHE_SIZE - 1);
538 struct fuse_req *req;
540 if (is_bad_inode(inode))
543 req = fuse_get_req(fc);
548 req->pages[0] = page;
549 req->page_offset = offset;
550 nres = fuse_send_write(req, file, inode, pos, count, NULL);
551 err = req->out.h.error;
552 fuse_put_request(fc, req);
557 spin_lock(&fc->lock);
558 fi->attr_version = ++fc->attr_version;
559 if (pos > inode->i_size)
560 i_size_write(inode, pos);
561 spin_unlock(&fc->lock);
563 if (count == PAGE_CACHE_SIZE)
564 SetPageUptodate(page);
566 fuse_invalidate_attr(inode);
567 return err ? err : nres;
570 static int fuse_write_end(struct file *file, struct address_space *mapping,
571 loff_t pos, unsigned len, unsigned copied,
572 struct page *page, void *fsdata)
574 struct inode *inode = mapping->host;
578 res = fuse_buffered_write(file, inode, pos, copied, page);
581 page_cache_release(page);
585 static void fuse_release_user_pages(struct fuse_req *req, int write)
589 for (i = 0; i < req->num_pages; i++) {
590 struct page *page = req->pages[i];
592 set_page_dirty_lock(page);
597 static int fuse_get_user_pages(struct fuse_req *req, const char __user *buf,
598 unsigned nbytes, int write)
600 unsigned long user_addr = (unsigned long) buf;
601 unsigned offset = user_addr & ~PAGE_MASK;
604 /* This doesn't work with nfsd */
608 nbytes = min(nbytes, (unsigned) FUSE_MAX_PAGES_PER_REQ << PAGE_SHIFT);
609 npages = (nbytes + offset + PAGE_SIZE - 1) >> PAGE_SHIFT;
610 npages = min(max(npages, 1), FUSE_MAX_PAGES_PER_REQ);
611 down_read(¤t->mm->mmap_sem);
612 npages = get_user_pages(current, current->mm, user_addr, npages, write,
613 0, req->pages, NULL);
614 up_read(¤t->mm->mmap_sem);
618 req->num_pages = npages;
619 req->page_offset = offset;
623 static ssize_t fuse_direct_io(struct file *file, const char __user *buf,
624 size_t count, loff_t *ppos, int write)
626 struct inode *inode = file->f_path.dentry->d_inode;
627 struct fuse_conn *fc = get_fuse_conn(inode);
628 size_t nmax = write ? fc->max_write : fc->max_read;
631 struct fuse_req *req;
633 if (is_bad_inode(inode))
636 req = fuse_get_req(fc);
642 size_t nbytes = min(count, nmax);
643 int err = fuse_get_user_pages(req, buf, nbytes, !write);
648 nbytes = (req->num_pages << PAGE_SHIFT) - req->page_offset;
649 nbytes = min(count, nbytes);
651 nres = fuse_send_write(req, file, inode, pos, nbytes,
654 nres = fuse_send_read(req, file, inode, pos, nbytes,
656 fuse_release_user_pages(req, !write);
657 if (req->out.h.error) {
659 res = req->out.h.error;
661 } else if (nres > nbytes) {
672 fuse_put_request(fc, req);
673 req = fuse_get_req(fc);
678 fuse_put_request(fc, req);
681 spin_lock(&fc->lock);
682 if (pos > inode->i_size)
683 i_size_write(inode, pos);
684 spin_unlock(&fc->lock);
688 fuse_invalidate_attr(inode);
693 static ssize_t fuse_direct_read(struct file *file, char __user *buf,
694 size_t count, loff_t *ppos)
696 return fuse_direct_io(file, buf, count, ppos, 0);
699 static ssize_t fuse_direct_write(struct file *file, const char __user *buf,
700 size_t count, loff_t *ppos)
702 struct inode *inode = file->f_path.dentry->d_inode;
704 /* Don't allow parallel writes to the same file */
705 mutex_lock(&inode->i_mutex);
706 res = generic_write_checks(file, ppos, &count, 0);
708 res = fuse_direct_io(file, buf, count, ppos, 1);
709 mutex_unlock(&inode->i_mutex);
713 static int fuse_file_mmap(struct file *file, struct vm_area_struct *vma)
715 if ((vma->vm_flags & VM_SHARED)) {
716 if ((vma->vm_flags & VM_WRITE))
719 vma->vm_flags &= ~VM_MAYWRITE;
721 return generic_file_mmap(file, vma);
724 static int fuse_set_page_dirty(struct page *page)
726 printk("fuse_set_page_dirty: should not happen\n");
731 static int convert_fuse_file_lock(const struct fuse_file_lock *ffl,
732 struct file_lock *fl)
740 if (ffl->start > OFFSET_MAX || ffl->end > OFFSET_MAX ||
741 ffl->end < ffl->start)
744 fl->fl_start = ffl->start;
745 fl->fl_end = ffl->end;
746 fl->fl_pid = ffl->pid;
752 fl->fl_type = ffl->type;
756 static void fuse_lk_fill(struct fuse_req *req, struct file *file,
757 const struct file_lock *fl, int opcode, pid_t pid,
760 struct inode *inode = file->f_path.dentry->d_inode;
761 struct fuse_conn *fc = get_fuse_conn(inode);
762 struct fuse_file *ff = file->private_data;
763 struct fuse_lk_in *arg = &req->misc.lk_in;
766 arg->owner = fuse_lock_owner_id(fc, fl->fl_owner);
767 arg->lk.start = fl->fl_start;
768 arg->lk.end = fl->fl_end;
769 arg->lk.type = fl->fl_type;
772 arg->lk_flags |= FUSE_LK_FLOCK;
773 req->in.h.opcode = opcode;
774 req->in.h.nodeid = get_node_id(inode);
776 req->in.args[0].size = sizeof(*arg);
777 req->in.args[0].value = arg;
780 static int fuse_getlk(struct file *file, struct file_lock *fl)
782 struct inode *inode = file->f_path.dentry->d_inode;
783 struct fuse_conn *fc = get_fuse_conn(inode);
784 struct fuse_req *req;
785 struct fuse_lk_out outarg;
788 req = fuse_get_req(fc);
792 fuse_lk_fill(req, file, fl, FUSE_GETLK, 0, 0);
793 req->out.numargs = 1;
794 req->out.args[0].size = sizeof(outarg);
795 req->out.args[0].value = &outarg;
796 request_send(fc, req);
797 err = req->out.h.error;
798 fuse_put_request(fc, req);
800 err = convert_fuse_file_lock(&outarg.lk, fl);
805 static int fuse_setlk(struct file *file, struct file_lock *fl, int flock)
807 struct inode *inode = file->f_path.dentry->d_inode;
808 struct fuse_conn *fc = get_fuse_conn(inode);
809 struct fuse_req *req;
810 int opcode = (fl->fl_flags & FL_SLEEP) ? FUSE_SETLKW : FUSE_SETLK;
811 pid_t pid = fl->fl_type != F_UNLCK ? current->tgid : 0;
814 /* Unlock on close is handled by the flush method */
815 if (fl->fl_flags & FL_CLOSE)
818 req = fuse_get_req(fc);
822 fuse_lk_fill(req, file, fl, opcode, pid, flock);
823 request_send(fc, req);
824 err = req->out.h.error;
825 /* locking is restartable */
828 fuse_put_request(fc, req);
832 static int fuse_file_lock(struct file *file, int cmd, struct file_lock *fl)
834 struct inode *inode = file->f_path.dentry->d_inode;
835 struct fuse_conn *fc = get_fuse_conn(inode);
838 if (cmd == F_GETLK) {
840 posix_test_lock(file, fl);
843 err = fuse_getlk(file, fl);
846 err = posix_lock_file_wait(file, fl);
848 err = fuse_setlk(file, fl, 0);
853 static int fuse_file_flock(struct file *file, int cmd, struct file_lock *fl)
855 struct inode *inode = file->f_path.dentry->d_inode;
856 struct fuse_conn *fc = get_fuse_conn(inode);
860 err = flock_lock_file_wait(file, fl);
862 /* emulate flock with POSIX locks */
863 fl->fl_owner = (fl_owner_t) file;
864 err = fuse_setlk(file, fl, 1);
870 static sector_t fuse_bmap(struct address_space *mapping, sector_t block)
872 struct inode *inode = mapping->host;
873 struct fuse_conn *fc = get_fuse_conn(inode);
874 struct fuse_req *req;
875 struct fuse_bmap_in inarg;
876 struct fuse_bmap_out outarg;
879 if (!inode->i_sb->s_bdev || fc->no_bmap)
882 req = fuse_get_req(fc);
886 memset(&inarg, 0, sizeof(inarg));
888 inarg.blocksize = inode->i_sb->s_blocksize;
889 req->in.h.opcode = FUSE_BMAP;
890 req->in.h.nodeid = get_node_id(inode);
892 req->in.args[0].size = sizeof(inarg);
893 req->in.args[0].value = &inarg;
894 req->out.numargs = 1;
895 req->out.args[0].size = sizeof(outarg);
896 req->out.args[0].value = &outarg;
897 request_send(fc, req);
898 err = req->out.h.error;
899 fuse_put_request(fc, req);
903 return err ? 0 : outarg.block;
906 static const struct file_operations fuse_file_operations = {
907 .llseek = generic_file_llseek,
908 .read = do_sync_read,
909 .aio_read = fuse_file_aio_read,
910 .write = do_sync_write,
911 .aio_write = generic_file_aio_write,
912 .mmap = fuse_file_mmap,
915 .release = fuse_release,
917 .lock = fuse_file_lock,
918 .flock = fuse_file_flock,
919 .splice_read = generic_file_splice_read,
922 static const struct file_operations fuse_direct_io_file_operations = {
923 .llseek = generic_file_llseek,
924 .read = fuse_direct_read,
925 .write = fuse_direct_write,
928 .release = fuse_release,
930 .lock = fuse_file_lock,
931 .flock = fuse_file_flock,
932 /* no mmap and splice_read */
935 static const struct address_space_operations fuse_file_aops = {
936 .readpage = fuse_readpage,
937 .write_begin = fuse_write_begin,
938 .write_end = fuse_write_end,
939 .readpages = fuse_readpages,
940 .set_page_dirty = fuse_set_page_dirty,
944 void fuse_init_file_inode(struct inode *inode)
946 inode->i_fop = &fuse_file_operations;
947 inode->i_data.a_ops = &fuse_file_aops;