fs/fuse/fuse_i.h

   1 /*
   2   FUSE: Filesystem in Userspace
   3   Copyright (C) 2001-2008  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 #ifndef _FS_FUSE_I_H
  10 #define _FS_FUSE_I_H
  11
  12 #include <linux/fuse.h>
  13 #include <linux/fs.h>
  14 #include <linux/mount.h>
  15 #include <linux/wait.h>
  16 #include <linux/list.h>
  17 #include <linux/spinlock.h>
  18 #include <linux/mm.h>
  19 #include <linux/backing-dev.h>
  20 #include <linux/mutex.h>
  21 #include <linux/rwsem.h>
  22 #include <linux/rbtree.h>
  23 #include <linux/poll.h>
  24
  25 /** Max number of pages that can be used in a single read request */
  26 #define FUSE_MAX_PAGES_PER_REQ 32
  27
  28 /** Maximum number of outstanding background requests */
  29 #define FUSE_MAX_BACKGROUND 12
  30
  31 /** Congestion starts at 75% of maximum */
  32 #define FUSE_CONGESTION_THRESHOLD (FUSE_MAX_BACKGROUND * 75 / 100)
  33
  34 /** Bias for fi->writectr, meaning new writepages must not be sent */
  35 #define FUSE_NOWRITE INT_MIN
  36
  37 /** It could be as large as PATH_MAX, but would that have any uses? */
  38 #define FUSE_NAME_MAX 1024
  39
  40 /** Number of dentries for each connection in the control filesystem */
  41 #define FUSE_CTL_NUM_DENTRIES 3
  42
  43 /** If the FUSE_DEFAULT_PERMISSIONS flag is given, the filesystem
  44     module will check permissions based on the file mode.  Otherwise no
  45     permission checking is done in the kernel */
  46 #define FUSE_DEFAULT_PERMISSIONS (1 << 0)
  47
  48 /** If the FUSE_ALLOW_OTHER flag is given, then not only the user
  49     doing the mount will be allowed to access the filesystem */
  50 #define FUSE_ALLOW_OTHER         (1 << 1)
  51
  52 /** List of active connections */
  53 extern struct list_head fuse_conn_list;
  54
  55 /** Global mutex protecting fuse_conn_list and the control filesystem */
  56 extern struct mutex fuse_mutex;
  57
  58 /** FUSE inode */
  59 struct fuse_inode {
  60         /** Inode data */
  61         struct inode inode;
  62
  63         /** Unique ID, which identifies the inode between userspace
  64          * and kernel */
  65         u64 nodeid;
  66
  67         /** Number of lookups on this inode */
  68         u64 nlookup;
  69
  70         /** The request used for sending the FORGET message */
  71         struct fuse_req *forget_req;
  72
  73         /** Time in jiffies until the file attributes are valid */
  74         u64 i_time;
  75
  76         /** The sticky bit in inode->i_mode may have been removed, so
  77             preserve the original mode */
  78         mode_t orig_i_mode;
  79
  80         /** Version of last attribute change */
  81         u64 attr_version;
  82
  83         /** Files usable in writepage.  Protected by fc->lock */
  84         struct list_head write_files;
  85
  86         /** Writepages pending on truncate or fsync */
  87         struct list_head queued_writes;
  88
  89         /** Number of sent writes, a negative bias (FUSE_NOWRITE)
  90          * means more writes are blocked */
  91         int writectr;
  92
  93         /** Waitq for writepage completion */
  94         wait_queue_head_t page_waitq;
  95
  96         /** List of writepage requestst (pending or sent) */
  97         struct list_head writepages;
  98 };
  99
 100 struct fuse_conn;
 101
 102 /** FUSE specific file data */
 103 struct fuse_file {
 104         /** Fuse connection for this file */
 105         struct fuse_conn *fc;
 106
 107         /** Request reserved for flush and release */
 108         struct fuse_req *reserved_req;
 109
 110         /** Kernel file handle guaranteed to be unique */
 111         u64 kh;
 112
 113         /** File handle used by userspace */
 114         u64 fh;
 115
 116         /** Node id of this file */
 117         u64 nodeid;
 118
 119         /** Refcount */
 120         atomic_t count;
 121
 122         /** Entry on inode's write_files list */
 123         struct list_head write_entry;
 124
 125         /** RB node to be linked on fuse_conn->polled_files */
 126         struct rb_node polled_node;
 127
 128         /** Wait queue head for poll */
 129         wait_queue_head_t poll_wait;
 130 };
 131
 132 /** One input argument of a request */
 133 struct fuse_in_arg {
 134         unsigned size;
 135         const void *value;
 136 };
 137
 138 /** The request input */
 139 struct fuse_in {
 140         /** The request header */
 141         struct fuse_in_header h;
 142
 143         /** True if the data for the last argument is in req->pages */
 144         unsigned argpages:1;
 145
 146         /** Number of arguments */
 147         unsigned numargs;
 148
 149         /** Array of arguments */
 150         struct fuse_in_arg args[3];
 151 };
 152
 153 /** One output argument of a request */
 154 struct fuse_arg {
 155         unsigned size;
 156         void *value;
 157 };
 158
 159 /** The request output */
 160 struct fuse_out {
 161         /** Header returned from userspace */
 162         struct fuse_out_header h;
 163
 164         /*
 165          * The following bitfields are not changed during the request
 166          * processing
 167          */
 168
 169         /** Last argument is variable length (can be shorter than
 170             arg->size) */
 171         unsigned argvar:1;
 172
 173         /** Last argument is a list of pages to copy data to */
 174         unsigned argpages:1;
 175
 176         /** Zero partially or not copied pages */
 177         unsigned page_zeroing:1;
 178
 179         /** Number or arguments */
 180         unsigned numargs;
 181
 182         /** Array of arguments */
 183         struct fuse_arg args[3];
 184 };
 185
 186 /** The request state */
 187 enum fuse_req_state {
 188         FUSE_REQ_INIT = 0,
 189         FUSE_REQ_PENDING,
 190         FUSE_REQ_READING,
 191         FUSE_REQ_SENT,
 192         FUSE_REQ_WRITING,
 193         FUSE_REQ_FINISHED
 194 };
 195
 196 /**
 197  * A request to the client
 198  */
 199 struct fuse_req {
 200         /** This can be on either pending processing or io lists in
 201             fuse_conn */
 202         struct list_head list;
 203
 204         /** Entry on the interrupts list  */
 205         struct list_head intr_entry;
 206
 207         /** refcount */
 208         atomic_t count;
 209
 210         /** Unique ID for the interrupt request */
 211         u64 intr_unique;
 212
 213         /*
 214          * The following bitfields are either set once before the
 215          * request is queued or setting/clearing them is protected by
 216          * fuse_conn->lock
 217          */
 218
 219         /** True if the request has reply */
 220         unsigned isreply:1;
 221
 222         /** Force sending of the request even if interrupted */
 223         unsigned force:1;
 224
 225         /** The request was aborted */
 226         unsigned aborted:1;
 227
 228         /** Request is sent in the background */
 229         unsigned background:1;
 230
 231         /** The request has been interrupted */
 232         unsigned interrupted:1;
 233
 234         /** Data is being copied to/from the request */
 235         unsigned locked:1;
 236
 237         /** Request is counted as "waiting" */
 238         unsigned waiting:1;
 239
 240         /** State of the request */
 241         enum fuse_req_state state;
 242
 243         /** The request input */
 244         struct fuse_in in;
 245
 246         /** The request output */
 247         struct fuse_out out;
 248
 249         /** Used to wake up the task waiting for completion of request*/
 250         wait_queue_head_t waitq;
 251
 252         /** Data for asynchronous requests */
 253         union {
 254                 struct fuse_forget_in forget_in;
 255                 struct {
 256                         struct fuse_release_in in;
 257                         struct path path;
 258                 } release;
 259                 struct fuse_init_in init_in;
 260                 struct fuse_init_out init_out;
 261                 struct {
 262                         struct fuse_read_in in;
 263                         u64 attr_ver;
 264                 } read;
 265                 struct {
 266                         struct fuse_write_in in;
 267                         struct fuse_write_out out;
 268                 } write;
 269                 struct fuse_lk_in lk_in;
 270         } misc;
 271
 272         /** page vector */
 273         struct page *pages[FUSE_MAX_PAGES_PER_REQ];
 274
 275         /** number of pages in vector */
 276         unsigned num_pages;
 277
 278         /** offset of data on first page */
 279         unsigned page_offset;
 280
 281         /** File used in the request (or NULL) */
 282         struct fuse_file *ff;
 283
 284         /** Inode used in the request or NULL */
 285         struct inode *inode;
 286
 287         /** Link on fi->writepages */
 288         struct list_head writepages_entry;
 289
 290         /** Request completion callback */
 291         void (*end)(struct fuse_conn *, struct fuse_req *);
 292
 293         /** Request is stolen from fuse_file->reserved_req */
 294         struct file *stolen_file;
 295 };
 296
 297 /**
 298  * A Fuse connection.
 299  *
 300  * This structure is created, when the filesystem is mounted, and is
 301  * destroyed, when the client device is closed and the filesystem is
 302  * unmounted.
 303  */
 304 struct fuse_conn {
 305         /** Lock protecting accessess to  members of this structure */
 306         spinlock_t lock;
 307
 308         /** Mutex protecting against directory alias creation */
 309         struct mutex inst_mutex;
 310
 311         /** Refcount */
 312         atomic_t count;
 313
 314         /** The user id for this mount */
 315         uid_t user_id;
 316
 317         /** The group id for this mount */
 318         gid_t group_id;
 319
 320         /** The fuse mount flags for this mount */
 321         unsigned flags;
 322
 323         /** Maximum read size */
 324         unsigned max_read;
 325
 326         /** Maximum write size */
 327         unsigned max_write;
 328
 329         /** Readers of the connection are waiting on this */
 330         wait_queue_head_t waitq;
 331
 332         /** The list of pending requests */
 333         struct list_head pending;
 334
 335         /** The list of requests being processed */
 336         struct list_head processing;
 337
 338         /** The list of requests under I/O */
 339         struct list_head io;
 340
 341         /** The next unique kernel file handle */
 342         u64 khctr;
 343
 344         /** rbtree of fuse_files waiting for poll events indexed by ph */
 345         struct rb_root polled_files;
 346
 347         /** Number of requests currently in the background */
 348         unsigned num_background;
 349
 350         /** Number of background requests currently queued for userspace */
 351         unsigned active_background;
 352
 353         /** The list of background requests set aside for later queuing */
 354         struct list_head bg_queue;
 355
 356         /** Pending interrupts */
 357         struct list_head interrupts;
 358
 359         /** Flag indicating if connection is blocked.  This will be
 360             the case before the INIT reply is received, and if there
 361             are too many outstading backgrounds requests */
 362         int blocked;
 363
 364         /** waitq for blocked connection */
 365         wait_queue_head_t blocked_waitq;
 366
 367         /** waitq for reserved requests */
 368         wait_queue_head_t reserved_req_waitq;
 369
 370         /** The next unique request id */
 371         u64 reqctr;
 372
 373         /** Connection established, cleared on umount, connection
 374             abort and device release */
 375         unsigned connected;
 376
 377         /** Connection failed (version mismatch).  Cannot race with
 378             setting other bitfields since it is only set once in INIT
 379             reply, before any other request, and never cleared */
 380         unsigned conn_error:1;
 381
 382         /** Connection successful.  Only set in INIT */
 383         unsigned conn_init:1;
 384
 385         /** Do readpages asynchronously?  Only set in INIT */
 386         unsigned async_read:1;
 387
 388         /** Do not send separate SETATTR request before open(O_TRUNC)  */
 389         unsigned atomic_o_trunc:1;
 390
 391         /** Filesystem supports NFS exporting.  Only set in INIT */
 392         unsigned export_support:1;
 393
 394         /*
 395          * The following bitfields are only for optimization purposes
 396          * and hence races in setting them will not cause malfunction
 397          */
 398
 399         /** Is fsync not implemented by fs? */
 400         unsigned no_fsync:1;
 401
 402         /** Is fsyncdir not implemented by fs? */
 403         unsigned no_fsyncdir:1;
 404
 405         /** Is flush not implemented by fs? */
 406         unsigned no_flush:1;
 407
 408         /** Is setxattr not implemented by fs? */
 409         unsigned no_setxattr:1;
 410
 411         /** Is getxattr not implemented by fs? */
 412         unsigned no_getxattr:1;
 413
 414         /** Is listxattr not implemented by fs? */
 415         unsigned no_listxattr:1;
 416
 417         /** Is removexattr not implemented by fs? */
 418         unsigned no_removexattr:1;
 419
 420         /** Are file locking primitives not implemented by fs? */
 421         unsigned no_lock:1;
 422
 423         /** Is access not implemented by fs? */
 424         unsigned no_access:1;
 425
 426         /** Is create not implemented by fs? */
 427         unsigned no_create:1;
 428
 429         /** Is interrupt not implemented by fs? */
 430         unsigned no_interrupt:1;
 431
 432         /** Is bmap not implemented by fs? */
 433         unsigned no_bmap:1;
 434
 435         /** Is poll not implemented by fs? */
 436         unsigned no_poll:1;
 437
 438         /** Do multi-page cached writes */
 439         unsigned big_writes:1;
 440
 441         /** The number of requests waiting for completion */
 442         atomic_t num_waiting;
 443
 444         /** Negotiated minor version */
 445         unsigned minor;
 446
 447         /** Backing dev info */
 448         struct backing_dev_info bdi;
 449
 450         /** Entry on the fuse_conn_list */
 451         struct list_head entry;
 452
 453         /** Device ID from super block */
 454         dev_t dev;
 455
 456         /** Dentries in the control filesystem */
 457         struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
 458
 459         /** number of dentries used in the above array */
 460         int ctl_ndents;
 461
 462         /** O_ASYNC requests */
 463         struct fasync_struct *fasync;
 464
 465         /** Key for lock owner ID scrambling */
 466         u32 scramble_key[4];
 467
 468         /** Reserved request for the DESTROY message */
 469         struct fuse_req *destroy_req;
 470
 471         /** Version counter for attribute changes */
 472         u64 attr_version;
 473
 474         /** Called on final put */
 475         void (*release)(struct fuse_conn *);
 476 };
 477
 478 static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
 479 {
 480         return sb->s_fs_info;
 481 }
 482
 483 static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
 484 {
 485         return get_fuse_conn_super(inode->i_sb);
 486 }
 487
 488 static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
 489 {
 490         return container_of(inode, struct fuse_inode, inode);
 491 }
 492
 493 static inline u64 get_node_id(struct inode *inode)
 494 {
 495         return get_fuse_inode(inode)->nodeid;
 496 }
 497
 498 /** Device operations */
 499 extern const struct file_operations fuse_dev_operations;
 500
 501 extern const struct dentry_operations fuse_dentry_operations;
 502
 503 /**
 504  * Get a filled in inode
 505  */
 506 struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
 507                         int generation, struct fuse_attr *attr,
 508                         u64 attr_valid, u64 attr_version);
 509
 510 int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
 511                      struct fuse_entry_out *outarg, struct inode **inode);
 512
 513 /**
 514  * Send FORGET command
 515  */
 516 void fuse_send_forget(struct fuse_conn *fc, struct fuse_req *req,
 517                       u64 nodeid, u64 nlookup);
 518
 519 /**
 520  * Initialize READ or READDIR request
 521  */
 522 void fuse_read_fill(struct fuse_req *req, struct file *file,
 523                     struct inode *inode, loff_t pos, size_t count, int opcode);
 524
 525 /**
 526  * Send OPEN or OPENDIR request
 527  */
 528 int fuse_open_common(struct inode *inode, struct file *file, int isdir);
 529
 530 struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
 531 void fuse_file_free(struct fuse_file *ff);
 532 void fuse_finish_open(struct inode *inode, struct file *file,
 533                       struct fuse_file *ff, struct fuse_open_out *outarg);
 534
 535 /** Fill in ff->reserved_req with a RELEASE request */
 536 void fuse_release_fill(struct fuse_file *ff, u64 nodeid, int flags, int opcode);
 537
 538 /**
 539  * Send RELEASE or RELEASEDIR request
 540  */
 541 int fuse_release_common(struct inode *inode, struct file *file, int isdir);
 542
 543 /**
 544  * Send FSYNC or FSYNCDIR request
 545  */
 546 int fuse_fsync_common(struct file *file, struct dentry *de, int datasync,
 547                       int isdir);
 548
 549 /**
 550  * Notify poll wakeup
 551  */
 552 int fuse_notify_poll_wakeup(struct fuse_conn *fc,
 553                             struct fuse_notify_poll_wakeup_out *outarg);
 554
 555 /**
 556  * Initialize file operations on a regular file
 557  */
 558 void fuse_init_file_inode(struct inode *inode);
 559
 560 /**
 561  * Initialize inode operations on regular files and special files
 562  */
 563 void fuse_init_common(struct inode *inode);
 564
 565 /**
 566  * Initialize inode and file operations on a directory
 567  */
 568 void fuse_init_dir(struct inode *inode);
 569
 570 /**
 571  * Initialize inode operations on a symlink
 572  */
 573 void fuse_init_symlink(struct inode *inode);
 574
 575 /**
 576  * Change attributes of an inode
 577  */
 578 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
 579                             u64 attr_valid, u64 attr_version);
 580
 581 void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
 582                                    u64 attr_valid);
 583
 584 void fuse_truncate(struct address_space *mapping, loff_t offset);
 585
 586 /**
 587  * Initialize the client device
 588  */
 589 int fuse_dev_init(void);
 590
 591 /**
 592  * Cleanup the client device
 593  */
 594 void fuse_dev_cleanup(void);
 595
 596 int fuse_ctl_init(void);
 597 void fuse_ctl_cleanup(void);
 598
 599 /**
 600  * Allocate a request
 601  */
 602 struct fuse_req *fuse_request_alloc(void);
 603
 604 struct fuse_req *fuse_request_alloc_nofs(void);
 605
 606 /**
 607  * Free a request
 608  */
 609 void fuse_request_free(struct fuse_req *req);
 610
 611 /**
 612  * Get a request, may fail with -ENOMEM
 613  */
 614 struct fuse_req *fuse_get_req(struct fuse_conn *fc);
 615
 616 /**
 617  * Gets a requests for a file operation, always succeeds
 618  */
 619 struct fuse_req *fuse_get_req_nofail(struct fuse_conn *fc, struct file *file);
 620
 621 /**
 622  * Decrement reference count of a request.  If count goes to zero free
 623  * the request.
 624  */
 625 void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
 626
 627 /**
 628  * Send a request (synchronous)
 629  */
 630 void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
 631
 632 /**
 633  * Send a request with no reply
 634  */
 635 void fuse_request_send_noreply(struct fuse_conn *fc, struct fuse_req *req);
 636
 637 /**
 638  * Send a request in the background
 639  */
 640 void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
 641
 642 void fuse_request_send_background_locked(struct fuse_conn *fc,
 643                                          struct fuse_req *req);
 644
 645 /* Abort all requests */
 646 void fuse_abort_conn(struct fuse_conn *fc);
 647
 648 /**
 649  * Invalidate inode attributes
 650  */
 651 void fuse_invalidate_attr(struct inode *inode);
 652
 653 void fuse_invalidate_entry_cache(struct dentry *entry);
 654
 655 /**
 656  * Acquire reference to fuse_conn
 657  */
 658 struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
 659
 660 /**
 661  * Initialize fuse_conn
 662  */
 663 int fuse_conn_init(struct fuse_conn *fc, struct super_block *sb);
 664
 665 /**
 666  * Release reference to fuse_conn
 667  */
 668 void fuse_conn_put(struct fuse_conn *fc);
 669
 670 /**
 671  * Add connection to control filesystem
 672  */
 673 int fuse_ctl_add_conn(struct fuse_conn *fc);
 674
 675 /**
 676  * Remove connection from control filesystem
 677  */
 678 void fuse_ctl_remove_conn(struct fuse_conn *fc);
 679
 680 /**
 681  * Is file type valid?
 682  */
 683 int fuse_valid_type(int m);
 684
 685 /**
 686  * Is task allowed to perform filesystem operation?
 687  */
 688 int fuse_allow_task(struct fuse_conn *fc, struct task_struct *task);
 689
 690 u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
 691
 692 int fuse_update_attributes(struct inode *inode, struct kstat *stat,
 693                            struct file *file, bool *refreshed);
 694
 695 void fuse_flush_writepages(struct inode *inode);
 696
 697 void fuse_set_nowrite(struct inode *inode);
 698 void fuse_release_nowrite(struct inode *inode);
 699
 700 u64 fuse_get_attr_version(struct fuse_conn *fc);
 701
 702 #endif /* _FS_FUSE_I_H */