fs/fuse/inode.c

   1 /*
   2   FUSE: Filesystem in Userspace
   3   Copyright (C) 2001-2005  Miklos Szeredi <miklos@szeredi.hu>
   4
   5   This program can be distributed under the terms of the GNU GPL.
   6   See the file COPYING.
   7 */
   8
   9 #include "fuse_i.h"
  10
  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>
  20
  21 MODULE_AUTHOR("Miklos Szeredi <miklos@szeredi.hu>");
  22 MODULE_DESCRIPTION("Filesystem in Userspace");
  23 MODULE_LICENSE("GPL");
  24
  25 spinlock_t fuse_lock;
  26 static kmem_cache_t *fuse_inode_cachep;
  27
  28 #define FUSE_SUPER_MAGIC 0x65735546
  29
  30 struct fuse_mount_data {
  31         int fd;
  32         unsigned rootmode;
  33         unsigned user_id;
  34         unsigned group_id;
  35         unsigned fd_present : 1;
  36         unsigned rootmode_present : 1;
  37         unsigned user_id_present : 1;
  38         unsigned group_id_present : 1;
  39         unsigned flags;
  40         unsigned max_read;
  41 };
  42
  43 static struct inode *fuse_alloc_inode(struct super_block *sb)
  44 {
  45         struct inode *inode;
  46         struct fuse_inode *fi;
  47
  48         inode = kmem_cache_alloc(fuse_inode_cachep, SLAB_KERNEL);
  49         if (!inode)
  50                 return NULL;
  51
  52         fi = get_fuse_inode(inode);
  53         fi->i_time = jiffies - 1;
  54         fi->nodeid = 0;
  55         fi->nlookup = 0;
  56         fi->forget_req = fuse_request_alloc();
  57         if (!fi->forget_req) {
  58                 kmem_cache_free(fuse_inode_cachep, inode);
  59                 return NULL;
  60         }
  61
  62         return inode;
  63 }
  64
  65 static void fuse_destroy_inode(struct inode *inode)
  66 {
  67         struct fuse_inode *fi = get_fuse_inode(inode);
  68         if (fi->forget_req)
  69                 fuse_request_free(fi->forget_req);
  70         kmem_cache_free(fuse_inode_cachep, inode);
  71 }
  72
  73 static void fuse_read_inode(struct inode *inode)
  74 {
  75         /* No op */
  76 }
  77
  78 void fuse_send_forget(struct fuse_conn *fc, struct fuse_req *req,
  79                       unsigned long nodeid, u64 nlookup)
  80 {
  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;
  85         req->in.numargs = 1;
  86         req->in.args[0].size = sizeof(struct fuse_forget_in);
  87         req->in.args[0].value = inarg;
  88         request_send_noreply(fc, req);
  89 }
  90
  91 static void fuse_clear_inode(struct inode *inode)
  92 {
  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;
  98         }
  99 }
 100
 101 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr)
 102 {
 103         if (S_ISREG(inode->i_mode) && i_size_read(inode) != attr->size)
 104                 invalidate_inode_pages(inode->i_mapping);
 105
 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;
 120 }
 121
 122 static void fuse_init_inode(struct inode *inode, struct fuse_attr *attr)
 123 {
 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));
 138         } else {
 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);
 143         }
 144 }
 145
 146 static int fuse_inode_eq(struct inode *inode, void *_nodeidp)
 147 {
 148         unsigned long nodeid = *(unsigned long *) _nodeidp;
 149         if (get_node_id(inode) == nodeid)
 150                 return 1;
 151         else
 152                 return 0;
 153 }
 154
 155 static int fuse_inode_set(struct inode *inode, void *_nodeidp)
 156 {
 157         unsigned long nodeid = *(unsigned long *) _nodeidp;
 158         get_fuse_inode(inode)->nodeid = nodeid;
 159         return 0;
 160 }
 161
 162 struct inode *fuse_iget(struct super_block *sb, unsigned long nodeid,
 163                         int generation, struct fuse_attr *attr)
 164 {
 165         struct inode *inode;
 166         struct fuse_inode *fi;
 167         struct fuse_conn *fc = get_fuse_conn_super(sb);
 168         int retried = 0;
 169
 170  retry:
 171         inode = iget5_locked(sb, nodeid, fuse_inode_eq, fuse_inode_set, &nodeid);
 172         if (!inode)
 173                 return NULL;
 174
 175         if ((inode->i_state & I_NEW)) {
 176                 inode->i_generation = generation;
 177                 inode->i_data.backing_dev_info = &fc->bdi;
 178                 fuse_init_inode(inode, attr);
 179                 unlock_new_inode(inode);
 180         } else if ((inode->i_mode ^ attr->mode) & S_IFMT) {
 181                 BUG_ON(retried);
 182                 /* Inode has changed type, any I/O on the old should fail */
 183                 make_bad_inode(inode);
 184                 iput(inode);
 185                 retried = 1;
 186                 goto retry;
 187         }
 188
 189         fi = get_fuse_inode(inode);
 190         fi->nlookup ++;
 191         fuse_change_attributes(inode, attr);
 192         return inode;
 193 }
 194
 195 static void fuse_put_super(struct super_block *sb)
 196 {
 197         struct fuse_conn *fc = get_fuse_conn_super(sb);
 198
 199         down_write(&fc->sbput_sem);
 200         while (!list_empty(&fc->background))
 201                 fuse_release_background(list_entry(fc->background.next,
 202                                                    struct fuse_req, bg_entry));
 203
 204         spin_lock(&fuse_lock);
 205         fc->mounted = 0;
 206         fc->user_id = 0;
 207         fc->group_id = 0;
 208         fc->flags = 0;
 209         /* Flush all readers on this fs */
 210         wake_up_all(&fc->waitq);
 211         up_write(&fc->sbput_sem);
 212         fuse_release_conn(fc);
 213         spin_unlock(&fuse_lock);
 214 }
 215
 216 static void convert_fuse_statfs(struct kstatfs *stbuf, struct fuse_kstatfs *attr)
 217 {
 218         stbuf->f_type    = FUSE_SUPER_MAGIC;
 219         stbuf->f_bsize   = attr->bsize;
 220         stbuf->f_blocks  = attr->blocks;
 221         stbuf->f_bfree   = attr->bfree;
 222         stbuf->f_bavail  = attr->bavail;
 223         stbuf->f_files   = attr->files;
 224         stbuf->f_ffree   = attr->ffree;
 225         stbuf->f_namelen = attr->namelen;
 226         /* fsid is left zero */
 227 }
 228
 229 static int fuse_statfs(struct super_block *sb, struct kstatfs *buf)
 230 {
 231         struct fuse_conn *fc = get_fuse_conn_super(sb);
 232         struct fuse_req *req;
 233         struct fuse_statfs_out outarg;
 234         int err;
 235
 236         req = fuse_get_request(fc);
 237         if (!req)
 238                 return -ERESTARTSYS;
 239
 240         req->in.numargs = 0;
 241         req->in.h.opcode = FUSE_STATFS;
 242         req->out.numargs = 1;
 243         req->out.args[0].size = sizeof(outarg);
 244         req->out.args[0].value = &outarg;
 245         request_send(fc, req);
 246         err = req->out.h.error;
 247         if (!err)
 248                 convert_fuse_statfs(buf, &outarg.st);
 249         fuse_put_request(fc, req);
 250         return err;
 251 }
 252
 253 enum {
 254         OPT_FD,
 255         OPT_ROOTMODE,
 256         OPT_USER_ID,
 257         OPT_GROUP_ID,
 258         OPT_DEFAULT_PERMISSIONS,
 259         OPT_ALLOW_OTHER,
 260         OPT_KERNEL_CACHE,
 261         OPT_MAX_READ,
 262         OPT_ERR
 263 };
 264
 265 static match_table_t tokens = {
 266         {OPT_FD,                        "fd=%u"},
 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_KERNEL_CACHE,              "kernel_cache"},
 273         {OPT_MAX_READ,                  "max_read=%u"},
 274         {OPT_ERR,                       NULL}
 275 };
 276
 277 static int parse_fuse_opt(char *opt, struct fuse_mount_data *d)
 278 {
 279         char *p;
 280         memset(d, 0, sizeof(struct fuse_mount_data));
 281         d->max_read = ~0;
 282
 283         while ((p = strsep(&opt, ",")) != NULL) {
 284                 int token;
 285                 int value;
 286                 substring_t args[MAX_OPT_ARGS];
 287                 if (!*p)
 288                         continue;
 289
 290                 token = match_token(p, tokens, args);
 291                 switch (token) {
 292                 case OPT_FD:
 293                         if (match_int(&args[0], &value))
 294                                 return 0;
 295                         d->fd = value;
 296                         d->fd_present = 1;
 297                         break;
 298
 299                 case OPT_ROOTMODE:
 300                         if (match_octal(&args[0], &value))
 301                                 return 0;
 302                         d->rootmode = value;
 303                         d->rootmode_present = 1;
 304                         break;
 305
 306                 case OPT_USER_ID:
 307                         if (match_int(&args[0], &value))
 308                                 return 0;
 309                         d->user_id = value;
 310                         d->user_id_present = 1;
 311                         break;
 312
 313                 case OPT_GROUP_ID:
 314                         if (match_int(&args[0], &value))
 315                                 return 0;
 316                         d->group_id = value;
 317                         d->group_id_present = 1;
 318                         break;
 319
 320                 case OPT_DEFAULT_PERMISSIONS:
 321                         d->flags |= FUSE_DEFAULT_PERMISSIONS;
 322                         break;
 323
 324                 case OPT_ALLOW_OTHER:
 325                         d->flags |= FUSE_ALLOW_OTHER;
 326                         break;
 327
 328                 case OPT_KERNEL_CACHE:
 329                         d->flags |= FUSE_KERNEL_CACHE;
 330                         break;
 331
 332                 case OPT_MAX_READ:
 333                         if (match_int(&args[0], &value))
 334                                 return 0;
 335                         d->max_read = value;
 336                         break;
 337
 338                 default:
 339                         return 0;
 340                 }
 341         }
 342
 343         if (!d->fd_present || !d->rootmode_present ||
 344             !d->user_id_present || !d->group_id_present)
 345                 return 0;
 346
 347         return 1;
 348 }
 349
 350 static int fuse_show_options(struct seq_file *m, struct vfsmount *mnt)
 351 {
 352         struct fuse_conn *fc = get_fuse_conn_super(mnt->mnt_sb);
 353
 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->flags & FUSE_KERNEL_CACHE)
 361                 seq_puts(m, ",kernel_cache");
 362         if (fc->max_read != ~0)
 363                 seq_printf(m, ",max_read=%u", fc->max_read);
 364         return 0;
 365 }
 366
 367 static void free_conn(struct fuse_conn *fc)
 368 {
 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);
 374         }
 375         kfree(fc);
 376 }
 377
 378 /* Must be called with the fuse lock held */
 379 void fuse_release_conn(struct fuse_conn *fc)
 380 {
 381         fc->count--;
 382         if (!fc->count)
 383                 free_conn(fc);
 384 }
 385
 386 static struct fuse_conn *new_conn(void)
 387 {
 388         struct fuse_conn *fc;
 389
 390         fc = kmalloc(sizeof(*fc), GFP_KERNEL);
 391         if (fc != NULL) {
 392                 int i;
 393                 memset(fc, 0, sizeof(*fc));
 394                 init_waitqueue_head(&fc->waitq);
 395                 INIT_LIST_HEAD(&fc->pending);
 396                 INIT_LIST_HEAD(&fc->processing);
 397                 INIT_LIST_HEAD(&fc->unused_list);
 398                 INIT_LIST_HEAD(&fc->background);
 399                 sema_init(&fc->outstanding_sem, 0);
 400                 init_rwsem(&fc->sbput_sem);
 401                 for (i = 0; i < FUSE_MAX_OUTSTANDING; i++) {
 402                         struct fuse_req *req = fuse_request_alloc();
 403                         if (!req) {
 404                                 free_conn(fc);
 405                                 return NULL;
 406                         }
 407                         list_add(&req->list, &fc->unused_list);
 408                 }
 409                 fc->bdi.ra_pages = (VM_MAX_READAHEAD * 1024) / PAGE_CACHE_SIZE;
 410                 fc->bdi.unplug_io_fn = default_unplug_io_fn;
 411                 fc->reqctr = 0;
 412         }
 413         return fc;
 414 }
 415
 416 static struct fuse_conn *get_conn(struct file *file, struct super_block *sb)
 417 {
 418         struct fuse_conn *fc;
 419
 420         if (file->f_op != &fuse_dev_operations)
 421                 return ERR_PTR(-EINVAL);
 422         fc = new_conn();
 423         if (fc == NULL)
 424                 return ERR_PTR(-ENOMEM);
 425         spin_lock(&fuse_lock);
 426         if (file->private_data) {
 427                 free_conn(fc);
 428                 fc = ERR_PTR(-EINVAL);
 429         } else {
 430                 file->private_data = fc;
 431                 *get_fuse_conn_super_p(sb) = fc;
 432                 fc->mounted = 1;
 433                 fc->connected = 1;
 434                 fc->count = 2;
 435         }
 436         spin_unlock(&fuse_lock);
 437         return fc;
 438 }
 439
 440 static struct inode *get_root_inode(struct super_block *sb, unsigned mode)
 441 {
 442         struct fuse_attr attr;
 443         memset(&attr, 0, sizeof(attr));
 444
 445         attr.mode = mode;
 446         attr.ino = FUSE_ROOT_ID;
 447         return fuse_iget(sb, 1, 0, &attr);
 448 }
 449
 450 static struct super_operations fuse_super_operations = {
 451         .alloc_inode    = fuse_alloc_inode,
 452         .destroy_inode  = fuse_destroy_inode,
 453         .read_inode     = fuse_read_inode,
 454         .clear_inode    = fuse_clear_inode,
 455         .put_super      = fuse_put_super,
 456         .statfs         = fuse_statfs,
 457         .show_options   = fuse_show_options,
 458 };
 459
 460 static int fuse_fill_super(struct super_block *sb, void *data, int silent)
 461 {
 462         struct fuse_conn *fc;
 463         struct inode *root;
 464         struct fuse_mount_data d;
 465         struct file *file;
 466         int err;
 467
 468         if (!parse_fuse_opt((char *) data, &d))
 469                 return -EINVAL;
 470
 471         sb->s_blocksize = PAGE_CACHE_SIZE;
 472         sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
 473         sb->s_magic = FUSE_SUPER_MAGIC;
 474         sb->s_op = &fuse_super_operations;
 475         sb->s_maxbytes = MAX_LFS_FILESIZE;
 476
 477         file = fget(d.fd);
 478         if (!file)
 479                 return -EINVAL;
 480
 481         fc = get_conn(file, sb);
 482         fput(file);
 483         if (IS_ERR(fc))
 484                 return PTR_ERR(fc);
 485
 486         fc->flags = d.flags;
 487         fc->user_id = d.user_id;
 488         fc->group_id = d.group_id;
 489         fc->max_read = d.max_read;
 490         if (fc->max_read / PAGE_CACHE_SIZE < fc->bdi.ra_pages)
 491                 fc->bdi.ra_pages = fc->max_read / PAGE_CACHE_SIZE;
 492
 493         err = -ENOMEM;
 494         root = get_root_inode(sb, d.rootmode);
 495         if (root == NULL)
 496                 goto err;
 497
 498         sb->s_root = d_alloc_root(root);
 499         if (!sb->s_root) {
 500                 iput(root);
 501                 goto err;
 502         }
 503         fuse_send_init(fc);
 504         return 0;
 505
 506  err:
 507         spin_lock(&fuse_lock);
 508         fuse_release_conn(fc);
 509         spin_unlock(&fuse_lock);
 510         return err;
 511 }
 512
 513 static struct super_block *fuse_get_sb(struct file_system_type *fs_type,
 514                                        int flags, const char *dev_name,
 515                                        void *raw_data)
 516 {
 517         return get_sb_nodev(fs_type, flags, raw_data, fuse_fill_super);
 518 }
 519
 520 static struct file_system_type fuse_fs_type = {
 521         .owner          = THIS_MODULE,
 522         .name           = "fuse",
 523         .get_sb         = fuse_get_sb,
 524         .kill_sb        = kill_anon_super,
 525 };
 526
 527 static void fuse_inode_init_once(void *foo, kmem_cache_t *cachep,
 528                                  unsigned long flags)
 529 {
 530         struct inode * inode = foo;
 531
 532         if ((flags & (SLAB_CTOR_VERIFY|SLAB_CTOR_CONSTRUCTOR)) ==
 533             SLAB_CTOR_CONSTRUCTOR)
 534                 inode_init_once(inode);
 535 }
 536
 537 static int __init fuse_fs_init(void)
 538 {
 539         int err;
 540
 541         err = register_filesystem(&fuse_fs_type);
 542         if (err)
 543                 printk("fuse: failed to register filesystem\n");
 544         else {
 545                 fuse_inode_cachep = kmem_cache_create("fuse_inode",
 546                                                       sizeof(struct fuse_inode),
 547                                                       0, SLAB_HWCACHE_ALIGN,
 548                                                       fuse_inode_init_once, NULL);
 549                 if (!fuse_inode_cachep) {
 550                         unregister_filesystem(&fuse_fs_type);
 551                         err = -ENOMEM;
 552                 }
 553         }
 554
 555         return err;
 556 }
 557
 558 static void fuse_fs_cleanup(void)
 559 {
 560         unregister_filesystem(&fuse_fs_type);
 561         kmem_cache_destroy(fuse_inode_cachep);
 562 }
 563
 564 static int __init fuse_init(void)
 565 {
 566         int res;
 567
 568         printk("fuse init (API version %i.%i)\n",
 569                FUSE_KERNEL_VERSION, FUSE_KERNEL_MINOR_VERSION);
 570
 571         spin_lock_init(&fuse_lock);
 572         res = fuse_fs_init();
 573         if (res)
 574                 goto err;
 575
 576         res = fuse_dev_init();
 577         if (res)
 578                 goto err_fs_cleanup;
 579
 580         return 0;
 581
 582  err_fs_cleanup:
 583         fuse_fs_cleanup();
 584  err:
 585         return res;
 586 }
 587
 588 static void __exit fuse_exit(void)
 589 {
 590         printk(KERN_DEBUG "fuse exit\n");
 591
 592         fuse_fs_cleanup();
 593         fuse_dev_cleanup();
 594 }
 595
 596 module_init(fuse_init);
 597 module_exit(fuse_exit);