2 FUSE: Filesystem in Userspace
3 Copyright (C) 2001-2005 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/mount.h>
15 #include <linux/seq_file.h>
16 #include <linux/init.h>
17 #include <linux/module.h>
18 #include <linux/parser.h>
19 #include <linux/statfs.h>
21 MODULE_AUTHOR("Miklos Szeredi <miklos@szeredi.hu>");
22 MODULE_DESCRIPTION("Filesystem in Userspace");
23 MODULE_LICENSE("GPL");
26 static kmem_cache_t *fuse_inode_cachep;
27 static struct subsystem connections_subsys;
29 struct fuse_conn_attr {
30 struct attribute attr;
31 ssize_t (*show)(struct fuse_conn *, char *);
32 ssize_t (*store)(struct fuse_conn *, const char *, size_t);
35 #define FUSE_SUPER_MAGIC 0x65735546
37 struct fuse_mount_data {
42 unsigned fd_present : 1;
43 unsigned rootmode_present : 1;
44 unsigned user_id_present : 1;
45 unsigned group_id_present : 1;
50 static struct inode *fuse_alloc_inode(struct super_block *sb)
53 struct fuse_inode *fi;
55 inode = kmem_cache_alloc(fuse_inode_cachep, SLAB_KERNEL);
59 fi = get_fuse_inode(inode);
60 fi->i_time = jiffies - 1;
63 fi->forget_req = fuse_request_alloc();
64 if (!fi->forget_req) {
65 kmem_cache_free(fuse_inode_cachep, inode);
72 static void fuse_destroy_inode(struct inode *inode)
74 struct fuse_inode *fi = get_fuse_inode(inode);
76 fuse_request_free(fi->forget_req);
77 kmem_cache_free(fuse_inode_cachep, inode);
80 static void fuse_read_inode(struct inode *inode)
85 void fuse_send_forget(struct fuse_conn *fc, struct fuse_req *req,
86 unsigned long nodeid, u64 nlookup)
88 struct fuse_forget_in *inarg = &req->misc.forget_in;
89 inarg->nlookup = nlookup;
90 req->in.h.opcode = FUSE_FORGET;
91 req->in.h.nodeid = nodeid;
93 req->in.args[0].size = sizeof(struct fuse_forget_in);
94 req->in.args[0].value = inarg;
95 request_send_noreply(fc, req);
98 static void fuse_clear_inode(struct inode *inode)
100 if (inode->i_sb->s_flags & MS_ACTIVE) {
101 struct fuse_conn *fc = get_fuse_conn(inode);
102 struct fuse_inode *fi = get_fuse_inode(inode);
103 fuse_send_forget(fc, fi->forget_req, fi->nodeid, fi->nlookup);
104 fi->forget_req = NULL;
108 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr)
110 if (S_ISREG(inode->i_mode) && i_size_read(inode) != attr->size)
111 invalidate_inode_pages(inode->i_mapping);
113 inode->i_ino = attr->ino;
114 inode->i_mode = (inode->i_mode & S_IFMT) + (attr->mode & 07777);
115 inode->i_nlink = attr->nlink;
116 inode->i_uid = attr->uid;
117 inode->i_gid = attr->gid;
118 i_size_write(inode, attr->size);
119 inode->i_blksize = PAGE_CACHE_SIZE;
120 inode->i_blocks = attr->blocks;
121 inode->i_atime.tv_sec = attr->atime;
122 inode->i_atime.tv_nsec = attr->atimensec;
123 inode->i_mtime.tv_sec = attr->mtime;
124 inode->i_mtime.tv_nsec = attr->mtimensec;
125 inode->i_ctime.tv_sec = attr->ctime;
126 inode->i_ctime.tv_nsec = attr->ctimensec;
129 static void fuse_init_inode(struct inode *inode, struct fuse_attr *attr)
131 inode->i_mode = attr->mode & S_IFMT;
132 i_size_write(inode, attr->size);
133 if (S_ISREG(inode->i_mode)) {
134 fuse_init_common(inode);
135 fuse_init_file_inode(inode);
136 } else if (S_ISDIR(inode->i_mode))
137 fuse_init_dir(inode);
138 else if (S_ISLNK(inode->i_mode))
139 fuse_init_symlink(inode);
140 else if (S_ISCHR(inode->i_mode) || S_ISBLK(inode->i_mode) ||
141 S_ISFIFO(inode->i_mode) || S_ISSOCK(inode->i_mode)) {
142 fuse_init_common(inode);
143 init_special_inode(inode, inode->i_mode,
144 new_decode_dev(attr->rdev));
149 static int fuse_inode_eq(struct inode *inode, void *_nodeidp)
151 unsigned long nodeid = *(unsigned long *) _nodeidp;
152 if (get_node_id(inode) == nodeid)
158 static int fuse_inode_set(struct inode *inode, void *_nodeidp)
160 unsigned long nodeid = *(unsigned long *) _nodeidp;
161 get_fuse_inode(inode)->nodeid = nodeid;
165 struct inode *fuse_iget(struct super_block *sb, unsigned long nodeid,
166 int generation, struct fuse_attr *attr)
169 struct fuse_inode *fi;
170 struct fuse_conn *fc = get_fuse_conn_super(sb);
174 inode = iget5_locked(sb, nodeid, fuse_inode_eq, fuse_inode_set, &nodeid);
178 if ((inode->i_state & I_NEW)) {
179 inode->i_flags |= S_NOATIME|S_NOCMTIME;
180 inode->i_generation = generation;
181 inode->i_data.backing_dev_info = &fc->bdi;
182 fuse_init_inode(inode, attr);
183 unlock_new_inode(inode);
184 } else if ((inode->i_mode ^ attr->mode) & S_IFMT) {
186 /* Inode has changed type, any I/O on the old should fail */
187 make_bad_inode(inode);
193 fi = get_fuse_inode(inode);
195 fuse_change_attributes(inode, attr);
199 static void fuse_put_super(struct super_block *sb)
201 struct fuse_conn *fc = get_fuse_conn_super(sb);
203 down_write(&fc->sbput_sem);
204 while (!list_empty(&fc->background))
205 fuse_release_background(list_entry(fc->background.next,
206 struct fuse_req, bg_entry));
208 spin_lock(&fuse_lock);
211 spin_unlock(&fuse_lock);
212 up_write(&fc->sbput_sem);
213 /* Flush all readers on this fs */
214 wake_up_all(&fc->waitq);
215 kobject_del(&fc->kobj);
216 kobject_put(&fc->kobj);
219 static void convert_fuse_statfs(struct kstatfs *stbuf, struct fuse_kstatfs *attr)
221 stbuf->f_type = FUSE_SUPER_MAGIC;
222 stbuf->f_bsize = attr->bsize;
223 stbuf->f_frsize = attr->frsize;
224 stbuf->f_blocks = attr->blocks;
225 stbuf->f_bfree = attr->bfree;
226 stbuf->f_bavail = attr->bavail;
227 stbuf->f_files = attr->files;
228 stbuf->f_ffree = attr->ffree;
229 stbuf->f_namelen = attr->namelen;
230 /* fsid is left zero */
233 static int fuse_statfs(struct super_block *sb, struct kstatfs *buf)
235 struct fuse_conn *fc = get_fuse_conn_super(sb);
236 struct fuse_req *req;
237 struct fuse_statfs_out outarg;
240 req = fuse_get_request(fc);
244 memset(&outarg, 0, sizeof(outarg));
246 req->in.h.opcode = FUSE_STATFS;
247 req->out.numargs = 1;
248 req->out.args[0].size =
249 fc->minor < 4 ? FUSE_COMPAT_STATFS_SIZE : sizeof(outarg);
250 req->out.args[0].value = &outarg;
251 request_send(fc, req);
252 err = req->out.h.error;
254 convert_fuse_statfs(buf, &outarg.st);
255 fuse_put_request(fc, req);
264 OPT_DEFAULT_PERMISSIONS,
270 static match_table_t tokens = {
272 {OPT_ROOTMODE, "rootmode=%o"},
273 {OPT_USER_ID, "user_id=%u"},
274 {OPT_GROUP_ID, "group_id=%u"},
275 {OPT_DEFAULT_PERMISSIONS, "default_permissions"},
276 {OPT_ALLOW_OTHER, "allow_other"},
277 {OPT_MAX_READ, "max_read=%u"},
281 static int parse_fuse_opt(char *opt, struct fuse_mount_data *d)
284 memset(d, 0, sizeof(struct fuse_mount_data));
287 while ((p = strsep(&opt, ",")) != NULL) {
290 substring_t args[MAX_OPT_ARGS];
294 token = match_token(p, tokens, args);
297 if (match_int(&args[0], &value))
304 if (match_octal(&args[0], &value))
307 d->rootmode_present = 1;
311 if (match_int(&args[0], &value))
314 d->user_id_present = 1;
318 if (match_int(&args[0], &value))
321 d->group_id_present = 1;
324 case OPT_DEFAULT_PERMISSIONS:
325 d->flags |= FUSE_DEFAULT_PERMISSIONS;
328 case OPT_ALLOW_OTHER:
329 d->flags |= FUSE_ALLOW_OTHER;
333 if (match_int(&args[0], &value))
343 if (!d->fd_present || !d->rootmode_present ||
344 !d->user_id_present || !d->group_id_present)
350 static int fuse_show_options(struct seq_file *m, struct vfsmount *mnt)
352 struct fuse_conn *fc = get_fuse_conn_super(mnt->mnt_sb);
354 seq_printf(m, ",user_id=%u", fc->user_id);
355 seq_printf(m, ",group_id=%u", fc->group_id);
356 if (fc->flags & FUSE_DEFAULT_PERMISSIONS)
357 seq_puts(m, ",default_permissions");
358 if (fc->flags & FUSE_ALLOW_OTHER)
359 seq_puts(m, ",allow_other");
360 if (fc->max_read != ~0)
361 seq_printf(m, ",max_read=%u", fc->max_read);
365 static void fuse_conn_release(struct kobject *kobj)
367 struct fuse_conn *fc = get_fuse_conn_kobj(kobj);
369 while (!list_empty(&fc->unused_list)) {
370 struct fuse_req *req;
371 req = list_entry(fc->unused_list.next, struct fuse_req, list);
372 list_del(&req->list);
373 fuse_request_free(req);
378 static struct fuse_conn *new_conn(void)
380 struct fuse_conn *fc;
382 fc = kzalloc(sizeof(*fc), GFP_KERNEL);
385 init_waitqueue_head(&fc->waitq);
386 INIT_LIST_HEAD(&fc->pending);
387 INIT_LIST_HEAD(&fc->processing);
388 INIT_LIST_HEAD(&fc->io);
389 INIT_LIST_HEAD(&fc->unused_list);
390 INIT_LIST_HEAD(&fc->background);
391 sema_init(&fc->outstanding_sem, 1); /* One for INIT */
392 init_rwsem(&fc->sbput_sem);
393 kobj_set_kset_s(fc, connections_subsys);
394 kobject_init(&fc->kobj);
395 for (i = 0; i < FUSE_MAX_OUTSTANDING; i++) {
396 struct fuse_req *req = fuse_request_alloc();
398 kobject_put(&fc->kobj);
401 list_add(&req->list, &fc->unused_list);
403 fc->bdi.ra_pages = (VM_MAX_READAHEAD * 1024) / PAGE_CACHE_SIZE;
404 fc->bdi.unplug_io_fn = default_unplug_io_fn;
410 static struct fuse_conn *get_conn(struct file *file, struct super_block *sb)
412 struct fuse_conn *fc;
416 if (file->f_op != &fuse_dev_operations)
424 spin_lock(&fuse_lock);
426 if (file->private_data)
429 kobject_get(&fc->kobj);
430 file->private_data = fc;
431 spin_unlock(&fuse_lock);
435 spin_unlock(&fuse_lock);
436 kobject_put(&fc->kobj);
441 static struct inode *get_root_inode(struct super_block *sb, unsigned mode)
443 struct fuse_attr attr;
444 memset(&attr, 0, sizeof(attr));
447 attr.ino = FUSE_ROOT_ID;
448 return fuse_iget(sb, 1, 0, &attr);
451 static struct super_operations fuse_super_operations = {
452 .alloc_inode = fuse_alloc_inode,
453 .destroy_inode = fuse_destroy_inode,
454 .read_inode = fuse_read_inode,
455 .clear_inode = fuse_clear_inode,
456 .put_super = fuse_put_super,
457 .statfs = fuse_statfs,
458 .show_options = fuse_show_options,
461 static unsigned long long conn_id(void)
463 static unsigned long long ctr = 1;
464 unsigned long long val;
465 spin_lock(&fuse_lock);
467 spin_unlock(&fuse_lock);
471 static int fuse_fill_super(struct super_block *sb, void *data, int silent)
473 struct fuse_conn *fc;
475 struct fuse_mount_data d;
477 struct dentry *root_dentry;
480 if (!parse_fuse_opt((char *) data, &d))
483 sb->s_blocksize = PAGE_CACHE_SIZE;
484 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
485 sb->s_magic = FUSE_SUPER_MAGIC;
486 sb->s_op = &fuse_super_operations;
487 sb->s_maxbytes = MAX_LFS_FILESIZE;
493 fc = get_conn(file, sb);
499 fc->user_id = d.user_id;
500 fc->group_id = d.group_id;
501 fc->max_read = d.max_read;
502 if (fc->max_read / PAGE_CACHE_SIZE < fc->bdi.ra_pages)
503 fc->bdi.ra_pages = fc->max_read / PAGE_CACHE_SIZE;
505 /* Used by get_root_inode() */
509 root = get_root_inode(sb, d.rootmode);
513 root_dentry = d_alloc_root(root);
519 err = kobject_set_name(&fc->kobj, "%llu", conn_id());
523 err = kobject_add(&fc->kobj);
527 sb->s_root = root_dentry;
528 spin_lock(&fuse_lock);
531 spin_unlock(&fuse_lock);
540 kobject_put(&fc->kobj);
544 static struct super_block *fuse_get_sb(struct file_system_type *fs_type,
545 int flags, const char *dev_name,
548 return get_sb_nodev(fs_type, flags, raw_data, fuse_fill_super);
551 static struct file_system_type fuse_fs_type = {
552 .owner = THIS_MODULE,
554 .get_sb = fuse_get_sb,
555 .kill_sb = kill_anon_super,
558 static ssize_t fuse_conn_waiting_show(struct fuse_conn *fc, char *page)
560 return sprintf(page, "%i\n", atomic_read(&fc->num_waiting));
563 static struct fuse_conn_attr fuse_conn_waiting =
564 __ATTR(waiting, 0400, fuse_conn_waiting_show, NULL);
566 static struct attribute *fuse_conn_attrs[] = {
567 &fuse_conn_waiting.attr,
571 static ssize_t fuse_conn_attr_show(struct kobject *kobj,
572 struct attribute *attr,
575 struct fuse_conn_attr *fca =
576 container_of(attr, struct fuse_conn_attr, attr);
579 return fca->show(get_fuse_conn_kobj(kobj), page);
584 static ssize_t fuse_conn_attr_store(struct kobject *kobj,
585 struct attribute *attr,
586 const char *page, size_t count)
588 struct fuse_conn_attr *fca =
589 container_of(attr, struct fuse_conn_attr, attr);
592 return fca->store(get_fuse_conn_kobj(kobj), page, count);
597 static struct sysfs_ops fuse_conn_sysfs_ops = {
598 .show = &fuse_conn_attr_show,
599 .store = &fuse_conn_attr_store,
602 static struct kobj_type ktype_fuse_conn = {
603 .release = fuse_conn_release,
604 .sysfs_ops = &fuse_conn_sysfs_ops,
605 .default_attrs = fuse_conn_attrs,
608 static decl_subsys(fuse, NULL, NULL);
609 static decl_subsys(connections, &ktype_fuse_conn, NULL);
611 static void fuse_inode_init_once(void *foo, kmem_cache_t *cachep,
614 struct inode * inode = foo;
616 if ((flags & (SLAB_CTOR_VERIFY|SLAB_CTOR_CONSTRUCTOR)) ==
617 SLAB_CTOR_CONSTRUCTOR)
618 inode_init_once(inode);
621 static int __init fuse_fs_init(void)
625 err = register_filesystem(&fuse_fs_type);
627 printk("fuse: failed to register filesystem\n");
629 fuse_inode_cachep = kmem_cache_create("fuse_inode",
630 sizeof(struct fuse_inode),
631 0, SLAB_HWCACHE_ALIGN,
632 fuse_inode_init_once, NULL);
633 if (!fuse_inode_cachep) {
634 unregister_filesystem(&fuse_fs_type);
642 static void fuse_fs_cleanup(void)
644 unregister_filesystem(&fuse_fs_type);
645 kmem_cache_destroy(fuse_inode_cachep);
648 static int fuse_sysfs_init(void)
652 kset_set_kset_s(&fuse_subsys, fs_subsys);
653 err = subsystem_register(&fuse_subsys);
657 kset_set_kset_s(&connections_subsys, fuse_subsys);
658 err = subsystem_register(&connections_subsys);
660 goto out_fuse_unregister;
665 subsystem_unregister(&fuse_subsys);
670 static void fuse_sysfs_cleanup(void)
672 subsystem_unregister(&connections_subsys);
673 subsystem_unregister(&fuse_subsys);
676 static int __init fuse_init(void)
680 printk("fuse init (API version %i.%i)\n",
681 FUSE_KERNEL_VERSION, FUSE_KERNEL_MINOR_VERSION);
683 spin_lock_init(&fuse_lock);
684 res = fuse_fs_init();
688 res = fuse_dev_init();
692 res = fuse_sysfs_init();
694 goto err_dev_cleanup;
706 static void __exit fuse_exit(void)
708 printk(KERN_DEBUG "fuse exit\n");
710 fuse_sysfs_cleanup();
715 module_init(fuse_init);
716 module_exit(fuse_exit);