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