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/file.h>
14 #include <linux/seq_file.h>
15 #include <linux/init.h>
16 #include <linux/module.h>
17 #include <linux/parser.h>
18 #include <linux/statfs.h>
19 #include <linux/random.h>
20 #include <linux/sched.h>
22 MODULE_AUTHOR("Miklos Szeredi <miklos@szeredi.hu>");
23 MODULE_DESCRIPTION("Filesystem in Userspace");
24 MODULE_LICENSE("GPL");
26 static struct kmem_cache *fuse_inode_cachep;
27 struct list_head fuse_conn_list;
28 DEFINE_MUTEX(fuse_mutex);
30 #define FUSE_SUPER_MAGIC 0x65735546
32 struct fuse_mount_data {
37 unsigned fd_present : 1;
38 unsigned rootmode_present : 1;
39 unsigned user_id_present : 1;
40 unsigned group_id_present : 1;
46 static struct inode *fuse_alloc_inode(struct super_block *sb)
49 struct fuse_inode *fi;
51 inode = kmem_cache_alloc(fuse_inode_cachep, GFP_KERNEL);
55 fi = get_fuse_inode(inode);
60 INIT_LIST_HEAD(&fi->write_files);
61 fi->forget_req = fuse_request_alloc();
62 if (!fi->forget_req) {
63 kmem_cache_free(fuse_inode_cachep, inode);
70 static void fuse_destroy_inode(struct inode *inode)
72 struct fuse_inode *fi = get_fuse_inode(inode);
73 BUG_ON(!list_empty(&fi->write_files));
75 fuse_request_free(fi->forget_req);
76 kmem_cache_free(fuse_inode_cachep, inode);
79 static void fuse_read_inode(struct inode *inode)
84 void fuse_send_forget(struct fuse_conn *fc, struct fuse_req *req,
85 unsigned long nodeid, u64 nlookup)
87 struct fuse_forget_in *inarg = &req->misc.forget_in;
88 inarg->nlookup = nlookup;
89 req->in.h.opcode = FUSE_FORGET;
90 req->in.h.nodeid = nodeid;
92 req->in.args[0].size = sizeof(struct fuse_forget_in);
93 req->in.args[0].value = inarg;
94 request_send_noreply(fc, req);
97 static void fuse_clear_inode(struct inode *inode)
99 if (inode->i_sb->s_flags & MS_ACTIVE) {
100 struct fuse_conn *fc = get_fuse_conn(inode);
101 struct fuse_inode *fi = get_fuse_inode(inode);
102 fuse_send_forget(fc, fi->forget_req, fi->nodeid, fi->nlookup);
103 fi->forget_req = NULL;
107 static int fuse_remount_fs(struct super_block *sb, int *flags, char *data)
109 if (*flags & MS_MANDLOCK)
115 static void fuse_truncate(struct address_space *mapping, loff_t offset)
117 /* See vmtruncate() */
118 unmap_mapping_range(mapping, offset + PAGE_SIZE - 1, 0, 1);
119 truncate_inode_pages(mapping, offset);
120 unmap_mapping_range(mapping, offset + PAGE_SIZE - 1, 0, 1);
124 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
125 u64 attr_valid, u64 attr_version)
127 struct fuse_conn *fc = get_fuse_conn(inode);
128 struct fuse_inode *fi = get_fuse_inode(inode);
131 spin_lock(&fc->lock);
132 if (attr_version != 0 && fi->attr_version > attr_version) {
133 spin_unlock(&fc->lock);
136 fi->attr_version = ++fc->attr_version;
137 fi->i_time = attr_valid;
139 inode->i_ino = attr->ino;
140 inode->i_mode = (inode->i_mode & S_IFMT) | (attr->mode & 07777);
141 inode->i_nlink = attr->nlink;
142 inode->i_uid = attr->uid;
143 inode->i_gid = attr->gid;
144 inode->i_blocks = attr->blocks;
145 inode->i_atime.tv_sec = attr->atime;
146 inode->i_atime.tv_nsec = attr->atimensec;
147 inode->i_mtime.tv_sec = attr->mtime;
148 inode->i_mtime.tv_nsec = attr->mtimensec;
149 inode->i_ctime.tv_sec = attr->ctime;
150 inode->i_ctime.tv_nsec = attr->ctimensec;
152 if (attr->blksize != 0)
153 inode->i_blkbits = ilog2(attr->blksize);
155 inode->i_blkbits = inode->i_sb->s_blocksize_bits;
158 * Don't set the sticky bit in i_mode, unless we want the VFS
159 * to check permissions. This prevents failures due to the
160 * check in may_delete().
162 fi->orig_i_mode = inode->i_mode;
163 if (!(fc->flags & FUSE_DEFAULT_PERMISSIONS))
164 inode->i_mode &= ~S_ISVTX;
166 oldsize = inode->i_size;
167 i_size_write(inode, attr->size);
168 spin_unlock(&fc->lock);
170 if (S_ISREG(inode->i_mode) && oldsize != attr->size) {
171 if (attr->size < oldsize)
172 fuse_truncate(inode->i_mapping, attr->size);
173 invalidate_inode_pages2(inode->i_mapping);
177 static void fuse_init_inode(struct inode *inode, struct fuse_attr *attr)
179 inode->i_mode = attr->mode & S_IFMT;
180 inode->i_size = attr->size;
181 if (S_ISREG(inode->i_mode)) {
182 fuse_init_common(inode);
183 fuse_init_file_inode(inode);
184 } else if (S_ISDIR(inode->i_mode))
185 fuse_init_dir(inode);
186 else if (S_ISLNK(inode->i_mode))
187 fuse_init_symlink(inode);
188 else if (S_ISCHR(inode->i_mode) || S_ISBLK(inode->i_mode) ||
189 S_ISFIFO(inode->i_mode) || S_ISSOCK(inode->i_mode)) {
190 fuse_init_common(inode);
191 init_special_inode(inode, inode->i_mode,
192 new_decode_dev(attr->rdev));
197 static int fuse_inode_eq(struct inode *inode, void *_nodeidp)
199 unsigned long nodeid = *(unsigned long *) _nodeidp;
200 if (get_node_id(inode) == nodeid)
206 static int fuse_inode_set(struct inode *inode, void *_nodeidp)
208 unsigned long nodeid = *(unsigned long *) _nodeidp;
209 get_fuse_inode(inode)->nodeid = nodeid;
213 struct inode *fuse_iget(struct super_block *sb, unsigned long nodeid,
214 int generation, struct fuse_attr *attr,
215 u64 attr_valid, u64 attr_version)
218 struct fuse_inode *fi;
219 struct fuse_conn *fc = get_fuse_conn_super(sb);
222 inode = iget5_locked(sb, nodeid, fuse_inode_eq, fuse_inode_set, &nodeid);
226 if ((inode->i_state & I_NEW)) {
227 inode->i_flags |= S_NOATIME|S_NOCMTIME;
228 inode->i_generation = generation;
229 inode->i_data.backing_dev_info = &fc->bdi;
230 fuse_init_inode(inode, attr);
231 unlock_new_inode(inode);
232 } else if ((inode->i_mode ^ attr->mode) & S_IFMT) {
233 /* Inode has changed type, any I/O on the old should fail */
234 make_bad_inode(inode);
239 fi = get_fuse_inode(inode);
240 spin_lock(&fc->lock);
242 spin_unlock(&fc->lock);
243 fuse_change_attributes(inode, attr, attr_valid, attr_version);
248 static void fuse_umount_begin(struct vfsmount *vfsmnt, int flags)
250 if (flags & MNT_FORCE)
251 fuse_abort_conn(get_fuse_conn_super(vfsmnt->mnt_sb));
254 static void fuse_send_destroy(struct fuse_conn *fc)
256 struct fuse_req *req = fc->destroy_req;
257 if (req && fc->conn_init) {
258 fc->destroy_req = NULL;
259 req->in.h.opcode = FUSE_DESTROY;
261 request_send(fc, req);
262 fuse_put_request(fc, req);
266 static void fuse_put_super(struct super_block *sb)
268 struct fuse_conn *fc = get_fuse_conn_super(sb);
270 fuse_send_destroy(fc);
271 spin_lock(&fc->lock);
274 spin_unlock(&fc->lock);
275 /* Flush all readers on this fs */
276 kill_fasync(&fc->fasync, SIGIO, POLL_IN);
277 wake_up_all(&fc->waitq);
278 wake_up_all(&fc->blocked_waitq);
279 wake_up_all(&fc->reserved_req_waitq);
280 mutex_lock(&fuse_mutex);
281 list_del(&fc->entry);
282 fuse_ctl_remove_conn(fc);
283 mutex_unlock(&fuse_mutex);
287 static void convert_fuse_statfs(struct kstatfs *stbuf, struct fuse_kstatfs *attr)
289 stbuf->f_type = FUSE_SUPER_MAGIC;
290 stbuf->f_bsize = attr->bsize;
291 stbuf->f_frsize = attr->frsize;
292 stbuf->f_blocks = attr->blocks;
293 stbuf->f_bfree = attr->bfree;
294 stbuf->f_bavail = attr->bavail;
295 stbuf->f_files = attr->files;
296 stbuf->f_ffree = attr->ffree;
297 stbuf->f_namelen = attr->namelen;
298 /* fsid is left zero */
301 static int fuse_statfs(struct dentry *dentry, struct kstatfs *buf)
303 struct super_block *sb = dentry->d_sb;
304 struct fuse_conn *fc = get_fuse_conn_super(sb);
305 struct fuse_req *req;
306 struct fuse_statfs_out outarg;
309 if (!fuse_allow_task(fc, current)) {
310 buf->f_type = FUSE_SUPER_MAGIC;
314 req = fuse_get_req(fc);
318 memset(&outarg, 0, sizeof(outarg));
320 req->in.h.opcode = FUSE_STATFS;
321 req->in.h.nodeid = get_node_id(dentry->d_inode);
322 req->out.numargs = 1;
323 req->out.args[0].size =
324 fc->minor < 4 ? FUSE_COMPAT_STATFS_SIZE : sizeof(outarg);
325 req->out.args[0].value = &outarg;
326 request_send(fc, req);
327 err = req->out.h.error;
329 convert_fuse_statfs(buf, &outarg.st);
330 fuse_put_request(fc, req);
339 OPT_DEFAULT_PERMISSIONS,
346 static match_table_t tokens = {
348 {OPT_ROOTMODE, "rootmode=%o"},
349 {OPT_USER_ID, "user_id=%u"},
350 {OPT_GROUP_ID, "group_id=%u"},
351 {OPT_DEFAULT_PERMISSIONS, "default_permissions"},
352 {OPT_ALLOW_OTHER, "allow_other"},
353 {OPT_MAX_READ, "max_read=%u"},
354 {OPT_BLKSIZE, "blksize=%u"},
358 static int parse_fuse_opt(char *opt, struct fuse_mount_data *d, int is_bdev)
361 memset(d, 0, sizeof(struct fuse_mount_data));
365 while ((p = strsep(&opt, ",")) != NULL) {
368 substring_t args[MAX_OPT_ARGS];
372 token = match_token(p, tokens, args);
375 if (match_int(&args[0], &value))
382 if (match_octal(&args[0], &value))
384 if (!fuse_valid_type(value))
387 d->rootmode_present = 1;
391 if (match_int(&args[0], &value))
394 d->user_id_present = 1;
398 if (match_int(&args[0], &value))
401 d->group_id_present = 1;
404 case OPT_DEFAULT_PERMISSIONS:
405 d->flags |= FUSE_DEFAULT_PERMISSIONS;
408 case OPT_ALLOW_OTHER:
409 d->flags |= FUSE_ALLOW_OTHER;
413 if (match_int(&args[0], &value))
419 if (!is_bdev || match_int(&args[0], &value))
429 if (!d->fd_present || !d->rootmode_present ||
430 !d->user_id_present || !d->group_id_present)
436 static int fuse_show_options(struct seq_file *m, struct vfsmount *mnt)
438 struct fuse_conn *fc = get_fuse_conn_super(mnt->mnt_sb);
440 seq_printf(m, ",user_id=%u", fc->user_id);
441 seq_printf(m, ",group_id=%u", fc->group_id);
442 if (fc->flags & FUSE_DEFAULT_PERMISSIONS)
443 seq_puts(m, ",default_permissions");
444 if (fc->flags & FUSE_ALLOW_OTHER)
445 seq_puts(m, ",allow_other");
446 if (fc->max_read != ~0)
447 seq_printf(m, ",max_read=%u", fc->max_read);
451 static struct fuse_conn *new_conn(void)
453 struct fuse_conn *fc;
456 fc = kzalloc(sizeof(*fc), GFP_KERNEL);
458 spin_lock_init(&fc->lock);
459 mutex_init(&fc->inst_mutex);
460 atomic_set(&fc->count, 1);
461 init_waitqueue_head(&fc->waitq);
462 init_waitqueue_head(&fc->blocked_waitq);
463 init_waitqueue_head(&fc->reserved_req_waitq);
464 INIT_LIST_HEAD(&fc->pending);
465 INIT_LIST_HEAD(&fc->processing);
466 INIT_LIST_HEAD(&fc->io);
467 INIT_LIST_HEAD(&fc->interrupts);
468 atomic_set(&fc->num_waiting, 0);
469 fc->bdi.ra_pages = (VM_MAX_READAHEAD * 1024) / PAGE_CACHE_SIZE;
470 fc->bdi.unplug_io_fn = default_unplug_io_fn;
471 err = bdi_init(&fc->bdi);
479 fc->attr_version = 1;
480 get_random_bytes(&fc->scramble_key, sizeof(fc->scramble_key));
486 void fuse_conn_put(struct fuse_conn *fc)
488 if (atomic_dec_and_test(&fc->count)) {
490 fuse_request_free(fc->destroy_req);
491 mutex_destroy(&fc->inst_mutex);
492 bdi_destroy(&fc->bdi);
497 struct fuse_conn *fuse_conn_get(struct fuse_conn *fc)
499 atomic_inc(&fc->count);
503 static struct inode *get_root_inode(struct super_block *sb, unsigned mode)
505 struct fuse_attr attr;
506 memset(&attr, 0, sizeof(attr));
509 attr.ino = FUSE_ROOT_ID;
511 return fuse_iget(sb, 1, 0, &attr, 0, 0);
514 static const struct super_operations fuse_super_operations = {
515 .alloc_inode = fuse_alloc_inode,
516 .destroy_inode = fuse_destroy_inode,
517 .read_inode = fuse_read_inode,
518 .clear_inode = fuse_clear_inode,
519 .drop_inode = generic_delete_inode,
520 .remount_fs = fuse_remount_fs,
521 .put_super = fuse_put_super,
522 .umount_begin = fuse_umount_begin,
523 .statfs = fuse_statfs,
524 .show_options = fuse_show_options,
527 static void process_init_reply(struct fuse_conn *fc, struct fuse_req *req)
529 struct fuse_init_out *arg = &req->misc.init_out;
531 if (req->out.h.error || arg->major != FUSE_KERNEL_VERSION)
534 unsigned long ra_pages;
536 if (arg->minor >= 6) {
537 ra_pages = arg->max_readahead / PAGE_CACHE_SIZE;
538 if (arg->flags & FUSE_ASYNC_READ)
540 if (!(arg->flags & FUSE_POSIX_LOCKS))
542 if (arg->flags & FUSE_ATOMIC_O_TRUNC)
543 fc->atomic_o_trunc = 1;
545 ra_pages = fc->max_read / PAGE_CACHE_SIZE;
549 fc->bdi.ra_pages = min(fc->bdi.ra_pages, ra_pages);
550 fc->minor = arg->minor;
551 fc->max_write = arg->minor < 5 ? 4096 : arg->max_write;
554 fuse_put_request(fc, req);
556 wake_up_all(&fc->blocked_waitq);
559 static void fuse_send_init(struct fuse_conn *fc, struct fuse_req *req)
561 struct fuse_init_in *arg = &req->misc.init_in;
563 arg->major = FUSE_KERNEL_VERSION;
564 arg->minor = FUSE_KERNEL_MINOR_VERSION;
565 arg->max_readahead = fc->bdi.ra_pages * PAGE_CACHE_SIZE;
566 arg->flags |= FUSE_ASYNC_READ | FUSE_POSIX_LOCKS | FUSE_ATOMIC_O_TRUNC;
567 req->in.h.opcode = FUSE_INIT;
569 req->in.args[0].size = sizeof(*arg);
570 req->in.args[0].value = arg;
571 req->out.numargs = 1;
572 /* Variable length arguement used for backward compatibility
573 with interface version < 7.5. Rest of init_out is zeroed
574 by do_get_request(), so a short reply is not a problem */
576 req->out.args[0].size = sizeof(struct fuse_init_out);
577 req->out.args[0].value = &req->misc.init_out;
578 req->end = process_init_reply;
579 request_send_background(fc, req);
582 static u64 conn_id(void)
588 static int fuse_fill_super(struct super_block *sb, void *data, int silent)
590 struct fuse_conn *fc;
592 struct fuse_mount_data d;
594 struct dentry *root_dentry;
595 struct fuse_req *init_req;
597 int is_bdev = sb->s_bdev != NULL;
599 if (sb->s_flags & MS_MANDLOCK)
602 if (!parse_fuse_opt((char *) data, &d, is_bdev))
607 if (!sb_set_blocksize(sb, d.blksize))
611 sb->s_blocksize = PAGE_CACHE_SIZE;
612 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
614 sb->s_magic = FUSE_SUPER_MAGIC;
615 sb->s_op = &fuse_super_operations;
616 sb->s_maxbytes = MAX_LFS_FILESIZE;
622 if (file->f_op != &fuse_dev_operations)
630 fc->user_id = d.user_id;
631 fc->group_id = d.group_id;
632 fc->max_read = d.max_read;
634 /* Used by get_root_inode() */
638 root = get_root_inode(sb, d.rootmode);
642 root_dentry = d_alloc_root(root);
648 init_req = fuse_request_alloc();
653 fc->destroy_req = fuse_request_alloc();
654 if (!fc->destroy_req)
658 mutex_lock(&fuse_mutex);
660 if (file->private_data)
664 err = fuse_ctl_add_conn(fc);
668 list_add_tail(&fc->entry, &fuse_conn_list);
669 sb->s_root = root_dentry;
671 file->private_data = fuse_conn_get(fc);
672 mutex_unlock(&fuse_mutex);
674 * atomic_dec_and_test() in fput() provides the necessary
675 * memory barrier for file->private_data to be visible on all
680 fuse_send_init(fc, init_req);
685 mutex_unlock(&fuse_mutex);
686 fuse_request_free(init_req);
695 static int fuse_get_sb(struct file_system_type *fs_type,
696 int flags, const char *dev_name,
697 void *raw_data, struct vfsmount *mnt)
699 return get_sb_nodev(fs_type, flags, raw_data, fuse_fill_super, mnt);
702 static struct file_system_type fuse_fs_type = {
703 .owner = THIS_MODULE,
705 .fs_flags = FS_HAS_SUBTYPE,
706 .get_sb = fuse_get_sb,
707 .kill_sb = kill_anon_super,
711 static int fuse_get_sb_blk(struct file_system_type *fs_type,
712 int flags, const char *dev_name,
713 void *raw_data, struct vfsmount *mnt)
715 return get_sb_bdev(fs_type, flags, dev_name, raw_data, fuse_fill_super,
719 static struct file_system_type fuseblk_fs_type = {
720 .owner = THIS_MODULE,
722 .get_sb = fuse_get_sb_blk,
723 .kill_sb = kill_block_super,
724 .fs_flags = FS_REQUIRES_DEV | FS_HAS_SUBTYPE,
727 static inline int register_fuseblk(void)
729 return register_filesystem(&fuseblk_fs_type);
732 static inline void unregister_fuseblk(void)
734 unregister_filesystem(&fuseblk_fs_type);
737 static inline int register_fuseblk(void)
742 static inline void unregister_fuseblk(void)
747 static decl_subsys(fuse, NULL, NULL);
748 static decl_subsys(connections, NULL, NULL);
750 static void fuse_inode_init_once(struct kmem_cache *cachep, void *foo)
752 struct inode * inode = foo;
754 inode_init_once(inode);
757 static int __init fuse_fs_init(void)
761 err = register_filesystem(&fuse_fs_type);
765 err = register_fuseblk();
769 fuse_inode_cachep = kmem_cache_create("fuse_inode",
770 sizeof(struct fuse_inode),
771 0, SLAB_HWCACHE_ALIGN,
772 fuse_inode_init_once);
774 if (!fuse_inode_cachep)
780 unregister_fuseblk();
782 unregister_filesystem(&fuse_fs_type);
787 static void fuse_fs_cleanup(void)
789 unregister_filesystem(&fuse_fs_type);
790 unregister_fuseblk();
791 kmem_cache_destroy(fuse_inode_cachep);
794 static int fuse_sysfs_init(void)
798 kobj_set_kset_s(&fuse_subsys, fs_subsys);
799 err = subsystem_register(&fuse_subsys);
803 kobj_set_kset_s(&connections_subsys, fuse_subsys);
804 err = subsystem_register(&connections_subsys);
806 goto out_fuse_unregister;
811 subsystem_unregister(&fuse_subsys);
816 static void fuse_sysfs_cleanup(void)
818 subsystem_unregister(&connections_subsys);
819 subsystem_unregister(&fuse_subsys);
822 static int __init fuse_init(void)
826 printk("fuse init (API version %i.%i)\n",
827 FUSE_KERNEL_VERSION, FUSE_KERNEL_MINOR_VERSION);
829 INIT_LIST_HEAD(&fuse_conn_list);
830 res = fuse_fs_init();
834 res = fuse_dev_init();
838 res = fuse_sysfs_init();
840 goto err_dev_cleanup;
842 res = fuse_ctl_init();
844 goto err_sysfs_cleanup;
849 fuse_sysfs_cleanup();
858 static void __exit fuse_exit(void)
860 printk(KERN_DEBUG "fuse exit\n");
863 fuse_sysfs_cleanup();
868 module_init(fuse_init);
869 module_exit(fuse_exit);