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;
28 #define FUSE_SUPER_MAGIC 0x65735546
30 struct fuse_mount_data {
35 unsigned fd_present : 1;
36 unsigned rootmode_present : 1;
37 unsigned user_id_present : 1;
38 unsigned group_id_present : 1;
43 static struct inode *fuse_alloc_inode(struct super_block *sb)
46 struct fuse_inode *fi;
48 inode = kmem_cache_alloc(fuse_inode_cachep, SLAB_KERNEL);
52 fi = get_fuse_inode(inode);
53 fi->i_time = jiffies - 1;
56 fi->forget_req = fuse_request_alloc();
57 if (!fi->forget_req) {
58 kmem_cache_free(fuse_inode_cachep, inode);
65 static void fuse_destroy_inode(struct inode *inode)
67 struct fuse_inode *fi = get_fuse_inode(inode);
69 fuse_request_free(fi->forget_req);
70 kmem_cache_free(fuse_inode_cachep, inode);
73 static void fuse_read_inode(struct inode *inode)
78 void fuse_send_forget(struct fuse_conn *fc, struct fuse_req *req,
79 unsigned long nodeid, u64 nlookup)
81 struct fuse_forget_in *inarg = &req->misc.forget_in;
82 inarg->nlookup = nlookup;
83 req->in.h.opcode = FUSE_FORGET;
84 req->in.h.nodeid = nodeid;
86 req->in.args[0].size = sizeof(struct fuse_forget_in);
87 req->in.args[0].value = inarg;
88 request_send_noreply(fc, req);
91 static void fuse_clear_inode(struct inode *inode)
93 if (inode->i_sb->s_flags & MS_ACTIVE) {
94 struct fuse_conn *fc = get_fuse_conn(inode);
95 struct fuse_inode *fi = get_fuse_inode(inode);
96 fuse_send_forget(fc, fi->forget_req, fi->nodeid, fi->nlookup);
97 fi->forget_req = NULL;
101 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr)
103 if (S_ISREG(inode->i_mode) && i_size_read(inode) != attr->size)
104 invalidate_inode_pages(inode->i_mapping);
106 inode->i_ino = attr->ino;
107 inode->i_mode = (inode->i_mode & S_IFMT) + (attr->mode & 07777);
108 inode->i_nlink = attr->nlink;
109 inode->i_uid = attr->uid;
110 inode->i_gid = attr->gid;
111 i_size_write(inode, attr->size);
112 inode->i_blksize = PAGE_CACHE_SIZE;
113 inode->i_blocks = attr->blocks;
114 inode->i_atime.tv_sec = attr->atime;
115 inode->i_atime.tv_nsec = attr->atimensec;
116 inode->i_mtime.tv_sec = attr->mtime;
117 inode->i_mtime.tv_nsec = attr->mtimensec;
118 inode->i_ctime.tv_sec = attr->ctime;
119 inode->i_ctime.tv_nsec = attr->ctimensec;
122 static void fuse_init_inode(struct inode *inode, struct fuse_attr *attr)
124 inode->i_mode = attr->mode & S_IFMT;
125 i_size_write(inode, attr->size);
126 if (S_ISREG(inode->i_mode)) {
127 fuse_init_common(inode);
128 fuse_init_file_inode(inode);
129 } else if (S_ISDIR(inode->i_mode))
130 fuse_init_dir(inode);
131 else if (S_ISLNK(inode->i_mode))
132 fuse_init_symlink(inode);
133 else if (S_ISCHR(inode->i_mode) || S_ISBLK(inode->i_mode) ||
134 S_ISFIFO(inode->i_mode) || S_ISSOCK(inode->i_mode)) {
135 fuse_init_common(inode);
136 init_special_inode(inode, inode->i_mode,
137 new_decode_dev(attr->rdev));
139 /* Don't let user create weird files */
140 inode->i_mode = S_IFREG;
141 fuse_init_common(inode);
142 fuse_init_file_inode(inode);
146 static int fuse_inode_eq(struct inode *inode, void *_nodeidp)
148 unsigned long nodeid = *(unsigned long *) _nodeidp;
149 if (get_node_id(inode) == nodeid)
155 static int fuse_inode_set(struct inode *inode, void *_nodeidp)
157 unsigned long nodeid = *(unsigned long *) _nodeidp;
158 get_fuse_inode(inode)->nodeid = nodeid;
162 struct inode *fuse_iget(struct super_block *sb, unsigned long nodeid,
163 int generation, struct fuse_attr *attr)
166 struct fuse_inode *fi;
167 struct fuse_conn *fc = get_fuse_conn_super(sb);
171 inode = iget5_locked(sb, nodeid, fuse_inode_eq, fuse_inode_set, &nodeid);
175 if ((inode->i_state & I_NEW)) {
176 inode->i_flags |= S_NOATIME|S_NOCMTIME;
177 inode->i_generation = generation;
178 inode->i_data.backing_dev_info = &fc->bdi;
179 fuse_init_inode(inode, attr);
180 unlock_new_inode(inode);
181 } else if ((inode->i_mode ^ attr->mode) & S_IFMT) {
183 /* Inode has changed type, any I/O on the old should fail */
184 make_bad_inode(inode);
190 fi = get_fuse_inode(inode);
192 fuse_change_attributes(inode, attr);
196 static void fuse_put_super(struct super_block *sb)
198 struct fuse_conn *fc = get_fuse_conn_super(sb);
200 down_write(&fc->sbput_sem);
201 while (!list_empty(&fc->background))
202 fuse_release_background(list_entry(fc->background.next,
203 struct fuse_req, bg_entry));
205 spin_lock(&fuse_lock);
210 /* Flush all readers on this fs */
211 wake_up_all(&fc->waitq);
212 up_write(&fc->sbput_sem);
213 fuse_release_conn(fc);
214 spin_unlock(&fuse_lock);
217 static void convert_fuse_statfs(struct kstatfs *stbuf, struct fuse_kstatfs *attr)
219 stbuf->f_type = FUSE_SUPER_MAGIC;
220 stbuf->f_bsize = attr->bsize;
221 stbuf->f_blocks = attr->blocks;
222 stbuf->f_bfree = attr->bfree;
223 stbuf->f_bavail = attr->bavail;
224 stbuf->f_files = attr->files;
225 stbuf->f_ffree = attr->ffree;
226 stbuf->f_namelen = attr->namelen;
227 /* fsid is left zero */
230 static int fuse_statfs(struct super_block *sb, struct kstatfs *buf)
232 struct fuse_conn *fc = get_fuse_conn_super(sb);
233 struct fuse_req *req;
234 struct fuse_statfs_out outarg;
237 req = fuse_get_request(fc);
242 req->in.h.opcode = FUSE_STATFS;
243 req->out.numargs = 1;
244 req->out.args[0].size = sizeof(outarg);
245 req->out.args[0].value = &outarg;
246 request_send(fc, req);
247 err = req->out.h.error;
249 convert_fuse_statfs(buf, &outarg.st);
250 fuse_put_request(fc, req);
259 OPT_DEFAULT_PERMISSIONS,
265 static match_table_t tokens = {
267 {OPT_ROOTMODE, "rootmode=%o"},
268 {OPT_USER_ID, "user_id=%u"},
269 {OPT_GROUP_ID, "group_id=%u"},
270 {OPT_DEFAULT_PERMISSIONS, "default_permissions"},
271 {OPT_ALLOW_OTHER, "allow_other"},
272 {OPT_MAX_READ, "max_read=%u"},
276 static int parse_fuse_opt(char *opt, struct fuse_mount_data *d)
279 memset(d, 0, sizeof(struct fuse_mount_data));
282 while ((p = strsep(&opt, ",")) != NULL) {
285 substring_t args[MAX_OPT_ARGS];
289 token = match_token(p, tokens, args);
292 if (match_int(&args[0], &value))
299 if (match_octal(&args[0], &value))
302 d->rootmode_present = 1;
306 if (match_int(&args[0], &value))
309 d->user_id_present = 1;
313 if (match_int(&args[0], &value))
316 d->group_id_present = 1;
319 case OPT_DEFAULT_PERMISSIONS:
320 d->flags |= FUSE_DEFAULT_PERMISSIONS;
323 case OPT_ALLOW_OTHER:
324 d->flags |= FUSE_ALLOW_OTHER;
328 if (match_int(&args[0], &value))
338 if (!d->fd_present || !d->rootmode_present ||
339 !d->user_id_present || !d->group_id_present)
345 static int fuse_show_options(struct seq_file *m, struct vfsmount *mnt)
347 struct fuse_conn *fc = get_fuse_conn_super(mnt->mnt_sb);
349 seq_printf(m, ",user_id=%u", fc->user_id);
350 seq_printf(m, ",group_id=%u", fc->group_id);
351 if (fc->flags & FUSE_DEFAULT_PERMISSIONS)
352 seq_puts(m, ",default_permissions");
353 if (fc->flags & FUSE_ALLOW_OTHER)
354 seq_puts(m, ",allow_other");
355 if (fc->max_read != ~0)
356 seq_printf(m, ",max_read=%u", fc->max_read);
360 static void free_conn(struct fuse_conn *fc)
362 while (!list_empty(&fc->unused_list)) {
363 struct fuse_req *req;
364 req = list_entry(fc->unused_list.next, struct fuse_req, list);
365 list_del(&req->list);
366 fuse_request_free(req);
371 /* Must be called with the fuse lock held */
372 void fuse_release_conn(struct fuse_conn *fc)
379 static struct fuse_conn *new_conn(void)
381 struct fuse_conn *fc;
383 fc = kmalloc(sizeof(*fc), GFP_KERNEL);
386 memset(fc, 0, sizeof(*fc));
387 init_waitqueue_head(&fc->waitq);
388 INIT_LIST_HEAD(&fc->pending);
389 INIT_LIST_HEAD(&fc->processing);
390 INIT_LIST_HEAD(&fc->unused_list);
391 INIT_LIST_HEAD(&fc->background);
392 sema_init(&fc->outstanding_sem, 0);
393 init_rwsem(&fc->sbput_sem);
394 for (i = 0; i < FUSE_MAX_OUTSTANDING; i++) {
395 struct fuse_req *req = fuse_request_alloc();
400 list_add(&req->list, &fc->unused_list);
402 fc->bdi.ra_pages = (VM_MAX_READAHEAD * 1024) / PAGE_CACHE_SIZE;
403 fc->bdi.unplug_io_fn = default_unplug_io_fn;
409 static struct fuse_conn *get_conn(struct file *file, struct super_block *sb)
411 struct fuse_conn *fc;
413 if (file->f_op != &fuse_dev_operations)
414 return ERR_PTR(-EINVAL);
417 return ERR_PTR(-ENOMEM);
418 spin_lock(&fuse_lock);
419 if (file->private_data) {
421 fc = ERR_PTR(-EINVAL);
423 file->private_data = fc;
424 *get_fuse_conn_super_p(sb) = fc;
429 spin_unlock(&fuse_lock);
433 static struct inode *get_root_inode(struct super_block *sb, unsigned mode)
435 struct fuse_attr attr;
436 memset(&attr, 0, sizeof(attr));
439 attr.ino = FUSE_ROOT_ID;
440 return fuse_iget(sb, 1, 0, &attr);
443 static struct super_operations fuse_super_operations = {
444 .alloc_inode = fuse_alloc_inode,
445 .destroy_inode = fuse_destroy_inode,
446 .read_inode = fuse_read_inode,
447 .clear_inode = fuse_clear_inode,
448 .put_super = fuse_put_super,
449 .statfs = fuse_statfs,
450 .show_options = fuse_show_options,
453 static int fuse_fill_super(struct super_block *sb, void *data, int silent)
455 struct fuse_conn *fc;
457 struct fuse_mount_data d;
461 if (!parse_fuse_opt((char *) data, &d))
464 sb->s_blocksize = PAGE_CACHE_SIZE;
465 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
466 sb->s_magic = FUSE_SUPER_MAGIC;
467 sb->s_op = &fuse_super_operations;
468 sb->s_maxbytes = MAX_LFS_FILESIZE;
474 fc = get_conn(file, sb);
480 fc->user_id = d.user_id;
481 fc->group_id = d.group_id;
482 fc->max_read = d.max_read;
483 if (fc->max_read / PAGE_CACHE_SIZE < fc->bdi.ra_pages)
484 fc->bdi.ra_pages = fc->max_read / PAGE_CACHE_SIZE;
485 fc->max_write = FUSE_MAX_IN / 2;
488 root = get_root_inode(sb, d.rootmode);
492 sb->s_root = d_alloc_root(root);
501 spin_lock(&fuse_lock);
502 fuse_release_conn(fc);
503 spin_unlock(&fuse_lock);
507 static struct super_block *fuse_get_sb(struct file_system_type *fs_type,
508 int flags, const char *dev_name,
511 return get_sb_nodev(fs_type, flags, raw_data, fuse_fill_super);
514 static struct file_system_type fuse_fs_type = {
515 .owner = THIS_MODULE,
517 .get_sb = fuse_get_sb,
518 .kill_sb = kill_anon_super,
521 static void fuse_inode_init_once(void *foo, kmem_cache_t *cachep,
524 struct inode * inode = foo;
526 if ((flags & (SLAB_CTOR_VERIFY|SLAB_CTOR_CONSTRUCTOR)) ==
527 SLAB_CTOR_CONSTRUCTOR)
528 inode_init_once(inode);
531 static int __init fuse_fs_init(void)
535 err = register_filesystem(&fuse_fs_type);
537 printk("fuse: failed to register filesystem\n");
539 fuse_inode_cachep = kmem_cache_create("fuse_inode",
540 sizeof(struct fuse_inode),
541 0, SLAB_HWCACHE_ALIGN,
542 fuse_inode_init_once, NULL);
543 if (!fuse_inode_cachep) {
544 unregister_filesystem(&fuse_fs_type);
552 static void fuse_fs_cleanup(void)
554 unregister_filesystem(&fuse_fs_type);
555 kmem_cache_destroy(fuse_inode_cachep);
558 static int __init fuse_init(void)
562 printk("fuse init (API version %i.%i)\n",
563 FUSE_KERNEL_VERSION, FUSE_KERNEL_MINOR_VERSION);
565 spin_lock_init(&fuse_lock);
566 res = fuse_fs_init();
570 res = fuse_dev_init();
582 static void __exit fuse_exit(void)
584 printk(KERN_DEBUG "fuse exit\n");
590 module_init(fuse_init);
591 module_exit(fuse_exit);