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 #include <linux/kref.h>
  26 #include <linux/xattr.h>
  27 #include <linux/pid_namespace.h>
  28 #include <linux/refcount.h>
  29
  30 /** Max number of pages that can be used in a single read request */
  31 #define FUSE_MAX_PAGES_PER_REQ 32
  32
  33 /** Bias for fi->writectr, meaning new writepages must not be sent */
  34 #define FUSE_NOWRITE INT_MIN
  35
  36 /** It could be as large as PATH_MAX, but would that have any uses? */
  37 #define FUSE_NAME_MAX 1024
  38
  39 /** Number of dentries for each connection in the control filesystem */
  40 #define FUSE_CTL_NUM_DENTRIES 5
  41
  42 /** Number of page pointers embedded in fuse_req */
  43 #define FUSE_REQ_INLINE_PAGES 1
  44
  45 /** List of active connections */
  46 extern struct list_head fuse_conn_list;
  47
  48 /** Global mutex protecting fuse_conn_list and the control filesystem */
  49 extern struct mutex fuse_mutex;
  50
  51 /** Module parameters */
  52 extern unsigned max_user_bgreq;
  53 extern unsigned max_user_congthresh;
  54
  55 /* One forget request */
  56 struct fuse_forget_link {
  57         struct fuse_forget_one forget_one;
  58         struct fuse_forget_link *next;
  59 };
  60
  61 /** FUSE inode */
  62 struct fuse_inode {
  63         /** Inode data */
  64         struct inode inode;
  65
  66         /** Unique ID, which identifies the inode between userspace
  67          * and kernel */
  68         u64 nodeid;
  69
  70         /** Number of lookups on this inode */
  71         u64 nlookup;
  72
  73         /** The request used for sending the FORGET message */
  74         struct fuse_forget_link *forget;
  75
  76         /** Time in jiffies until the file attributes are valid */
  77         u64 i_time;
  78
  79         /** The sticky bit in inode->i_mode may have been removed, so
  80             preserve the original mode */
  81         umode_t orig_i_mode;
  82
  83         /** 64 bit inode number */
  84         u64 orig_ino;
  85
  86         /** Version of last attribute change */
  87         u64 attr_version;
  88
  89         /** Files usable in writepage.  Protected by fc->lock */
  90         struct list_head write_files;
  91
  92         /** Writepages pending on truncate or fsync */
  93         struct list_head queued_writes;
  94
  95         /** Number of sent writes, a negative bias (FUSE_NOWRITE)
  96          * means more writes are blocked */
  97         int writectr;
  98
  99         /** Waitq for writepage completion */
 100         wait_queue_head_t page_waitq;
 101
 102         /** List of writepage requestst (pending or sent) */
 103         struct list_head writepages;
 104
 105         /** Miscellaneous bits describing inode state */
 106         unsigned long state;
 107
 108         /** Lock for serializing lookup and readdir for back compatibility*/
 109         struct mutex mutex;
 110 };
 111
 112 /** FUSE inode state bits */
 113 enum {
 114         /** Advise readdirplus  */
 115         FUSE_I_ADVISE_RDPLUS,
 116         /** Initialized with readdirplus */
 117         FUSE_I_INIT_RDPLUS,
 118         /** An operation changing file size is in progress  */
 119         FUSE_I_SIZE_UNSTABLE,
 120         /* Bad inode */
 121         FUSE_I_BAD,
 122 };
 123
 124 struct fuse_conn;
 125
 126 /** FUSE specific file data */
 127 struct fuse_file {
 128         /** Fuse connection for this file */
 129         struct fuse_conn *fc;
 130
 131         /** Request reserved for flush and release */
 132         struct fuse_req *reserved_req;
 133
 134         /** Kernel file handle guaranteed to be unique */
 135         u64 kh;
 136
 137         /** File handle used by userspace */
 138         u64 fh;
 139
 140         /** Node id of this file */
 141         u64 nodeid;
 142
 143         /** Refcount */
 144         refcount_t count;
 145
 146         /** FOPEN_* flags returned by open */
 147         u32 open_flags;
 148
 149         /** Entry on inode's write_files list */
 150         struct list_head write_entry;
 151
 152         /** RB node to be linked on fuse_conn->polled_files */
 153         struct rb_node polled_node;
 154
 155         /** Wait queue head for poll */
 156         wait_queue_head_t poll_wait;
 157
 158         /** Has flock been performed on this file? */
 159         bool flock:1;
 160 };
 161
 162 /** One input argument of a request */
 163 struct fuse_in_arg {
 164         unsigned size;
 165         const void *value;
 166 };
 167
 168 /** The request input */
 169 struct fuse_in {
 170         /** The request header */
 171         struct fuse_in_header h;
 172
 173         /** True if the data for the last argument is in req->pages */
 174         unsigned argpages:1;
 175
 176         /** Number of arguments */
 177         unsigned numargs;
 178
 179         /** Array of arguments */
 180         struct fuse_in_arg args[3];
 181 };
 182
 183 /** One output argument of a request */
 184 struct fuse_arg {
 185         unsigned size;
 186         void *value;
 187 };
 188
 189 /** The request output */
 190 struct fuse_out {
 191         /** Header returned from userspace */
 192         struct fuse_out_header h;
 193
 194         /*
 195          * The following bitfields are not changed during the request
 196          * processing
 197          */
 198
 199         /** Last argument is variable length (can be shorter than
 200             arg->size) */
 201         unsigned argvar:1;
 202
 203         /** Last argument is a list of pages to copy data to */
 204         unsigned argpages:1;
 205
 206         /** Zero partially or not copied pages */
 207         unsigned page_zeroing:1;
 208
 209         /** Pages may be replaced with new ones */
 210         unsigned page_replace:1;
 211
 212         /** Number or arguments */
 213         unsigned numargs;
 214
 215         /** Array of arguments */
 216         struct fuse_arg args[2];
 217 };
 218
 219 /** FUSE page descriptor */
 220 struct fuse_page_desc {
 221         unsigned int length;
 222         unsigned int offset;
 223 };
 224
 225 struct fuse_args {
 226         struct {
 227                 struct {
 228                         uint32_t opcode;
 229                         uint64_t nodeid;
 230                 } h;
 231                 unsigned numargs;
 232                 struct fuse_in_arg args[3];
 233
 234         } in;
 235         struct {
 236                 unsigned argvar:1;
 237                 unsigned numargs;
 238                 struct fuse_arg args[2];
 239         } out;
 240 };
 241
 242 #define FUSE_ARGS(args) struct fuse_args args = {}
 243
 244 /** The request IO state (for asynchronous processing) */
 245 struct fuse_io_priv {
 246         struct kref refcnt;
 247         int async;
 248         spinlock_t lock;
 249         unsigned reqs;
 250         ssize_t bytes;
 251         size_t size;
 252         __u64 offset;
 253         bool write;
 254         bool should_dirty;
 255         int err;
 256         struct kiocb *iocb;
 257         struct completion *done;
 258         bool blocking;
 259 };
 260
 261 #define FUSE_IO_PRIV_SYNC(i) \
 262 {                                       \
 263         .refcnt = KREF_INIT(1),         \
 264         .async = 0,                     \
 265         .iocb = i,                      \
 266 }
 267
 268 /**
 269  * Request flags
 270  *
 271  * FR_ISREPLY:          set if the request has reply
 272  * FR_FORCE:            force sending of the request even if interrupted
 273  * FR_BACKGROUND:       request is sent in the background
 274  * FR_WAITING:          request is counted as "waiting"
 275  * FR_ABORTED:          the request was aborted
 276  * FR_INTERRUPTED:      the request has been interrupted
 277  * FR_LOCKED:           data is being copied to/from the request
 278  * FR_PENDING:          request is not yet in userspace
 279  * FR_SENT:             request is in userspace, waiting for an answer
 280  * FR_FINISHED:         request is finished
 281  * FR_PRIVATE:          request is on private list
 282  */
 283 enum fuse_req_flag {
 284         FR_ISREPLY,
 285         FR_FORCE,
 286         FR_BACKGROUND,
 287         FR_WAITING,
 288         FR_ABORTED,
 289         FR_INTERRUPTED,
 290         FR_LOCKED,
 291         FR_PENDING,
 292         FR_SENT,
 293         FR_FINISHED,
 294         FR_PRIVATE,
 295 };
 296
 297 /**
 298  * A request to the client
 299  *
 300  * .waitq.lock protects the following fields:
 301  *   - FR_ABORTED
 302  *   - FR_LOCKED (may also be modified under fc->lock, tested under both)
 303  */
 304 struct fuse_req {
 305         /** This can be on either pending processing or io lists in
 306             fuse_conn */
 307         struct list_head list;
 308
 309         /** Entry on the interrupts list  */
 310         struct list_head intr_entry;
 311
 312         /** refcount */
 313         refcount_t count;
 314
 315         /** Unique ID for the interrupt request */
 316         u64 intr_unique;
 317
 318         /* Request flags, updated with test/set/clear_bit() */
 319         unsigned long flags;
 320
 321         /** The request input */
 322         struct fuse_in in;
 323
 324         /** The request output */
 325         struct fuse_out out;
 326
 327         /** Used to wake up the task waiting for completion of request*/
 328         wait_queue_head_t waitq;
 329
 330         /** Data for asynchronous requests */
 331         union {
 332                 struct {
 333                         struct fuse_release_in in;
 334                         struct inode *inode;
 335                 } release;
 336                 struct fuse_init_in init_in;
 337                 struct fuse_init_out init_out;
 338                 struct cuse_init_in cuse_init_in;
 339                 struct {
 340                         struct fuse_read_in in;
 341                         u64 attr_ver;
 342                 } read;
 343                 struct {
 344                         struct fuse_write_in in;
 345                         struct fuse_write_out out;
 346                         struct fuse_req *next;
 347                 } write;
 348                 struct fuse_notify_retrieve_in retrieve_in;
 349         } misc;
 350
 351         /** page vector */
 352         struct page **pages;
 353
 354         /** page-descriptor vector */
 355         struct fuse_page_desc *page_descs;
 356
 357         /** size of the 'pages' array */
 358         unsigned max_pages;
 359
 360         /** inline page vector */
 361         struct page *inline_pages[FUSE_REQ_INLINE_PAGES];
 362
 363         /** inline page-descriptor vector */
 364         struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];
 365
 366         /** number of pages in vector */
 367         unsigned num_pages;
 368
 369         /** File used in the request (or NULL) */
 370         struct fuse_file *ff;
 371
 372         /** Inode used in the request or NULL */
 373         struct inode *inode;
 374
 375         /** AIO control block */
 376         struct fuse_io_priv *io;
 377
 378         /** Link on fi->writepages */
 379         struct list_head writepages_entry;
 380
 381         /** Request completion callback */
 382         void (*end)(struct fuse_conn *, struct fuse_req *);
 383
 384         /** Request is stolen from fuse_file->reserved_req */
 385         struct file *stolen_file;
 386 };
 387
 388 struct fuse_iqueue {
 389         /** Connection established */
 390         unsigned connected;
 391
 392         /** Readers of the connection are waiting on this */
 393         wait_queue_head_t waitq;
 394
 395         /** The next unique request id */
 396         u64 reqctr;
 397
 398         /** The list of pending requests */
 399         struct list_head pending;
 400
 401         /** Pending interrupts */
 402         struct list_head interrupts;
 403
 404         /** Queue of pending forgets */
 405         struct fuse_forget_link forget_list_head;
 406         struct fuse_forget_link *forget_list_tail;
 407
 408         /** Batching of FORGET requests (positive indicates FORGET batch) */
 409         int forget_batch;
 410
 411         /** O_ASYNC requests */
 412         struct fasync_struct *fasync;
 413 };
 414
 415 struct fuse_pqueue {
 416         /** Connection established */
 417         unsigned connected;
 418
 419         /** Lock protecting accessess to  members of this structure */
 420         spinlock_t lock;
 421
 422         /** The list of requests being processed */
 423         struct list_head processing;
 424
 425         /** The list of requests under I/O */
 426         struct list_head io;
 427 };
 428
 429 /**
 430  * Fuse device instance
 431  */
 432 struct fuse_dev {
 433         /** Fuse connection for this device */
 434         struct fuse_conn *fc;
 435
 436         /** Processing queue */
 437         struct fuse_pqueue pq;
 438
 439         /** list entry on fc->devices */
 440         struct list_head entry;
 441 };
 442
 443 /**
 444  * A Fuse connection.
 445  *
 446  * This structure is created, when the filesystem is mounted, and is
 447  * destroyed, when the client device is closed and the filesystem is
 448  * unmounted.
 449  */
 450 struct fuse_conn {
 451         /** Lock protecting accessess to  members of this structure */
 452         spinlock_t lock;
 453
 454         /** Refcount */
 455         refcount_t count;
 456
 457         /** Number of fuse_dev's */
 458         atomic_t dev_count;
 459
 460         struct rcu_head rcu;
 461
 462         /** The user id for this mount */
 463         kuid_t user_id;
 464
 465         /** The group id for this mount */
 466         kgid_t group_id;
 467
 468         /** The pid namespace for this mount */
 469         struct pid_namespace *pid_ns;
 470
 471         /** Maximum read size */
 472         unsigned max_read;
 473
 474         /** Maximum write size */
 475         unsigned max_write;
 476
 477         /** Input queue */
 478         struct fuse_iqueue iq;
 479
 480         /** The next unique kernel file handle */
 481         u64 khctr;
 482
 483         /** rbtree of fuse_files waiting for poll events indexed by ph */
 484         struct rb_root polled_files;
 485
 486         /** Maximum number of outstanding background requests */
 487         unsigned max_background;
 488
 489         /** Number of background requests at which congestion starts */
 490         unsigned congestion_threshold;
 491
 492         /** Number of requests currently in the background */
 493         unsigned num_background;
 494
 495         /** Number of background requests currently queued for userspace */
 496         unsigned active_background;
 497
 498         /** The list of background requests set aside for later queuing */
 499         struct list_head bg_queue;
 500
 501         /** Flag indicating that INIT reply has been received. Allocating
 502          * any fuse request will be suspended until the flag is set */
 503         int initialized;
 504
 505         /** Flag indicating if connection is blocked.  This will be
 506             the case before the INIT reply is received, and if there
 507             are too many outstading backgrounds requests */
 508         int blocked;
 509
 510         /** waitq for blocked connection */
 511         wait_queue_head_t blocked_waitq;
 512
 513         /** waitq for reserved requests */
 514         wait_queue_head_t reserved_req_waitq;
 515
 516         /** Connection established, cleared on umount, connection
 517             abort and device release */
 518         unsigned connected;
 519
 520         /** Connection failed (version mismatch).  Cannot race with
 521             setting other bitfields since it is only set once in INIT
 522             reply, before any other request, and never cleared */
 523         unsigned conn_error:1;
 524
 525         /** Connection successful.  Only set in INIT */
 526         unsigned conn_init:1;
 527
 528         /** Do readpages asynchronously?  Only set in INIT */
 529         unsigned async_read:1;
 530
 531         /** Do not send separate SETATTR request before open(O_TRUNC)  */
 532         unsigned atomic_o_trunc:1;
 533
 534         /** Filesystem supports NFS exporting.  Only set in INIT */
 535         unsigned export_support:1;
 536
 537         /** write-back cache policy (default is write-through) */
 538         unsigned writeback_cache:1;
 539
 540         /** allow parallel lookups and readdir (default is serialized) */
 541         unsigned parallel_dirops:1;
 542
 543         /** handle fs handles killing suid/sgid/cap on write/chown/trunc */
 544         unsigned handle_killpriv:1;
 545
 546         /*
 547          * The following bitfields are only for optimization purposes
 548          * and hence races in setting them will not cause malfunction
 549          */
 550
 551         /** Is open/release not implemented by fs? */
 552         unsigned no_open:1;
 553
 554         /** Is fsync not implemented by fs? */
 555         unsigned no_fsync:1;
 556
 557         /** Is fsyncdir not implemented by fs? */
 558         unsigned no_fsyncdir:1;
 559
 560         /** Is flush not implemented by fs? */
 561         unsigned no_flush:1;
 562
 563         /** Is setxattr not implemented by fs? */
 564         unsigned no_setxattr:1;
 565
 566         /** Is getxattr not implemented by fs? */
 567         unsigned no_getxattr:1;
 568
 569         /** Is listxattr not implemented by fs? */
 570         unsigned no_listxattr:1;
 571
 572         /** Is removexattr not implemented by fs? */
 573         unsigned no_removexattr:1;
 574
 575         /** Are posix file locking primitives not implemented by fs? */
 576         unsigned no_lock:1;
 577
 578         /** Is access not implemented by fs? */
 579         unsigned no_access:1;
 580
 581         /** Is create not implemented by fs? */
 582         unsigned no_create:1;
 583
 584         /** Is interrupt not implemented by fs? */
 585         unsigned no_interrupt:1;
 586
 587         /** Is bmap not implemented by fs? */
 588         unsigned no_bmap:1;
 589
 590         /** Is poll not implemented by fs? */
 591         unsigned no_poll:1;
 592
 593         /** Do multi-page cached writes */
 594         unsigned big_writes:1;
 595
 596         /** Don't apply umask to creation modes */
 597         unsigned dont_mask:1;
 598
 599         /** Are BSD file locking primitives not implemented by fs? */
 600         unsigned no_flock:1;
 601
 602         /** Is fallocate not implemented by fs? */
 603         unsigned no_fallocate:1;
 604
 605         /** Is rename with flags implemented by fs? */
 606         unsigned no_rename2:1;
 607
 608         /** Use enhanced/automatic page cache invalidation. */
 609         unsigned auto_inval_data:1;
 610
 611         /** Does the filesystem support readdirplus? */
 612         unsigned do_readdirplus:1;
 613
 614         /** Does the filesystem want adaptive readdirplus? */
 615         unsigned readdirplus_auto:1;
 616
 617         /** Does the filesystem support asynchronous direct-IO submission? */
 618         unsigned async_dio:1;
 619
 620         /** Is lseek not implemented by fs? */
 621         unsigned no_lseek:1;
 622
 623         /** Does the filesystem support posix acls? */
 624         unsigned posix_acl:1;
 625
 626         /** Check permissions based on the file mode or not? */
 627         unsigned default_permissions:1;
 628
 629         /** Allow other than the mounter user to access the filesystem ? */
 630         unsigned allow_other:1;
 631
 632         /** The number of requests waiting for completion */
 633         atomic_t num_waiting;
 634
 635         /** Negotiated minor version */
 636         unsigned minor;
 637
 638         /** Entry on the fuse_conn_list */
 639         struct list_head entry;
 640
 641         /** Device ID from super block */
 642         dev_t dev;
 643
 644         /** Dentries in the control filesystem */
 645         struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
 646
 647         /** number of dentries used in the above array */
 648         int ctl_ndents;
 649
 650         /** Key for lock owner ID scrambling */
 651         u32 scramble_key[4];
 652
 653         /** Reserved request for the DESTROY message */
 654         struct fuse_req *destroy_req;
 655
 656         /** Version counter for attribute changes */
 657         u64 attr_version;
 658
 659         /** Called on final put */
 660         void (*release)(struct fuse_conn *);
 661
 662         /** Super block for this connection. */
 663         struct super_block *sb;
 664
 665         /** Read/write semaphore to hold when accessing sb. */
 666         struct rw_semaphore killsb;
 667
 668         /** List of device instances belonging to this connection */
 669         struct list_head devices;
 670 };
 671
 672 static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
 673 {
 674         return sb->s_fs_info;
 675 }
 676
 677 static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
 678 {
 679         return get_fuse_conn_super(inode->i_sb);
 680 }
 681
 682 static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
 683 {
 684         return container_of(inode, struct fuse_inode, inode);
 685 }
 686
 687 static inline u64 get_node_id(struct inode *inode)
 688 {
 689         return get_fuse_inode(inode)->nodeid;
 690 }
 691
 692 static inline void fuse_make_bad(struct inode *inode)
 693 {
 694         remove_inode_hash(inode);
 695         set_bit(FUSE_I_BAD, &get_fuse_inode(inode)->state);
 696 }
 697
 698 static inline bool fuse_is_bad(struct inode *inode)
 699 {
 700         return unlikely(test_bit(FUSE_I_BAD, &get_fuse_inode(inode)->state));
 701 }
 702
 703 /** Device operations */
 704 extern const struct file_operations fuse_dev_operations;
 705
 706 extern const struct dentry_operations fuse_dentry_operations;
 707 extern const struct dentry_operations fuse_root_dentry_operations;
 708
 709 /**
 710  * Inode to nodeid comparison.
 711  */
 712 int fuse_inode_eq(struct inode *inode, void *_nodeidp);
 713
 714 /**
 715  * Get a filled in inode
 716  */
 717 struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
 718                         int generation, struct fuse_attr *attr,
 719                         u64 attr_valid, u64 attr_version);
 720
 721 int fuse_lookup_name(struct super_block *sb, u64 nodeid, const struct qstr *name,
 722                      struct fuse_entry_out *outarg, struct inode **inode);
 723
 724 /**
 725  * Send FORGET command
 726  */
 727 void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
 728                        u64 nodeid, u64 nlookup);
 729
 730 struct fuse_forget_link *fuse_alloc_forget(void);
 731
 732 /* Used by READDIRPLUS */
 733 void fuse_force_forget(struct file *file, u64 nodeid);
 734
 735 /**
 736  * Initialize READ or READDIR request
 737  */
 738 void fuse_read_fill(struct fuse_req *req, struct file *file,
 739                     loff_t pos, size_t count, int opcode);
 740
 741 /**
 742  * Send OPEN or OPENDIR request
 743  */
 744 int fuse_open_common(struct inode *inode, struct file *file, bool isdir);
 745
 746 struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
 747 void fuse_file_free(struct fuse_file *ff);
 748 void fuse_finish_open(struct inode *inode, struct file *file);
 749
 750 void fuse_sync_release(struct fuse_file *ff, int flags);
 751
 752 /**
 753  * Send RELEASE or RELEASEDIR request
 754  */
 755 void fuse_release_common(struct file *file, bool isdir);
 756
 757 /**
 758  * Send FSYNC or FSYNCDIR request
 759  */
 760 int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
 761                       int datasync, int isdir);
 762
 763 /**
 764  * Notify poll wakeup
 765  */
 766 int fuse_notify_poll_wakeup(struct fuse_conn *fc,
 767                             struct fuse_notify_poll_wakeup_out *outarg);
 768
 769 /**
 770  * Initialize file operations on a regular file
 771  */
 772 void fuse_init_file_inode(struct inode *inode);
 773
 774 /**
 775  * Initialize inode operations on regular files and special files
 776  */
 777 void fuse_init_common(struct inode *inode);
 778
 779 /**
 780  * Initialize inode and file operations on a directory
 781  */
 782 void fuse_init_dir(struct inode *inode);
 783
 784 /**
 785  * Initialize inode operations on a symlink
 786  */
 787 void fuse_init_symlink(struct inode *inode);
 788
 789 /**
 790  * Change attributes of an inode
 791  */
 792 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
 793                             u64 attr_valid, u64 attr_version);
 794
 795 void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
 796                                    u64 attr_valid);
 797
 798 /**
 799  * Initialize the client device
 800  */
 801 int fuse_dev_init(void);
 802
 803 /**
 804  * Cleanup the client device
 805  */
 806 void fuse_dev_cleanup(void);
 807
 808 int fuse_ctl_init(void);
 809 void __exit fuse_ctl_cleanup(void);
 810
 811 /**
 812  * Allocate a request
 813  */
 814 struct fuse_req *fuse_request_alloc(unsigned npages);
 815
 816 struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
 817
 818 /**
 819  * Free a request
 820  */
 821 void fuse_request_free(struct fuse_req *req);
 822
 823 /**
 824  * Get a request, may fail with -ENOMEM,
 825  * caller should specify # elements in req->pages[] explicitly
 826  */
 827 struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
 828 struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
 829                                              unsigned npages);
 830
 831 /*
 832  * Increment reference count on request
 833  */
 834 void __fuse_get_request(struct fuse_req *req);
 835
 836 /**
 837  * Gets a requests for a file operation, always succeeds
 838  */
 839 struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
 840                                              struct file *file);
 841
 842 /**
 843  * Decrement reference count of a request.  If count goes to zero free
 844  * the request.
 845  */
 846 void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
 847
 848 /**
 849  * Send a request (synchronous)
 850  */
 851 void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
 852
 853 /**
 854  * Simple request sending that does request allocation and freeing
 855  */
 856 ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);
 857
 858 /**
 859  * Send a request in the background
 860  */
 861 void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
 862
 863 void fuse_request_send_background_locked(struct fuse_conn *fc,
 864                                          struct fuse_req *req);
 865
 866 /* Abort all requests */
 867 void fuse_abort_conn(struct fuse_conn *fc);
 868 void fuse_wait_aborted(struct fuse_conn *fc);
 869
 870 /**
 871  * Invalidate inode attributes
 872  */
 873 void fuse_invalidate_attr(struct inode *inode);
 874
 875 void fuse_invalidate_entry_cache(struct dentry *entry);
 876
 877 void fuse_invalidate_atime(struct inode *inode);
 878
 879 /**
 880  * Acquire reference to fuse_conn
 881  */
 882 struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
 883
 884 /**
 885  * Initialize fuse_conn
 886  */
 887 void fuse_conn_init(struct fuse_conn *fc);
 888
 889 /**
 890  * Release reference to fuse_conn
 891  */
 892 void fuse_conn_put(struct fuse_conn *fc);
 893
 894 struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
 895 void fuse_dev_free(struct fuse_dev *fud);
 896
 897 /**
 898  * Add connection to control filesystem
 899  */
 900 int fuse_ctl_add_conn(struct fuse_conn *fc);
 901
 902 /**
 903  * Remove connection from control filesystem
 904  */
 905 void fuse_ctl_remove_conn(struct fuse_conn *fc);
 906
 907 /**
 908  * Is file type valid?
 909  */
 910 int fuse_valid_type(int m);
 911
 912 bool fuse_invalid_attr(struct fuse_attr *attr);
 913
 914 /**
 915  * Is current process allowed to perform filesystem operation?
 916  */
 917 int fuse_allow_current_process(struct fuse_conn *fc);
 918
 919 u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
 920
 921 void fuse_update_ctime(struct inode *inode);
 922
 923 int fuse_update_attributes(struct inode *inode, struct file *file);
 924
 925 void fuse_flush_writepages(struct inode *inode);
 926
 927 void fuse_set_nowrite(struct inode *inode);
 928 void fuse_release_nowrite(struct inode *inode);
 929
 930 u64 fuse_get_attr_version(struct fuse_conn *fc);
 931
 932 /**
 933  * File-system tells the kernel to invalidate cache for the given node id.
 934  */
 935 int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid,
 936                              loff_t offset, loff_t len);
 937
 938 /**
 939  * File-system tells the kernel to invalidate parent attributes and
 940  * the dentry matching parent/name.
 941  *
 942  * If the child_nodeid is non-zero and:
 943  *    - matches the inode number for the dentry matching parent/name,
 944  *    - is not a mount point
 945  *    - is a file or oan empty directory
 946  * then the dentry is unhashed (d_delete()).
 947  */
 948 int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
 949                              u64 child_nodeid, struct qstr *name);
 950
 951 int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
 952                  bool isdir);
 953
 954 /**
 955  * fuse_direct_io() flags
 956  */
 957
 958 /** If set, it is WRITE; otherwise - READ */
 959 #define FUSE_DIO_WRITE (1 << 0)
 960
 961 /** CUSE pass fuse_direct_io() a file which f_mapping->host is not from FUSE */
 962 #define FUSE_DIO_CUSE  (1 << 1)
 963
 964 ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
 965                        loff_t *ppos, int flags);
 966 long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
 967                    unsigned int flags);
 968 long fuse_ioctl_common(struct file *file, unsigned int cmd,
 969                        unsigned long arg, unsigned int flags);
 970 unsigned fuse_file_poll(struct file *file, poll_table *wait);
 971 int fuse_dev_release(struct inode *inode, struct file *file);
 972
 973 bool fuse_write_update_size(struct inode *inode, loff_t pos);
 974
 975 int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
 976 int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
 977
 978 int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
 979                     struct file *file);
 980
 981 void fuse_set_initialized(struct fuse_conn *fc);
 982
 983 void fuse_unlock_inode(struct inode *inode, bool locked);
 984 bool fuse_lock_inode(struct inode *inode);
 985
 986 int fuse_setxattr(struct inode *inode, const char *name, const void *value,
 987                   size_t size, int flags);
 988 ssize_t fuse_getxattr(struct inode *inode, const char *name, void *value,
 989                       size_t size);
 990 ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
 991 int fuse_removexattr(struct inode *inode, const char *name);
 992 extern const struct xattr_handler *fuse_xattr_handlers[];
 993 extern const struct xattr_handler *fuse_acl_xattr_handlers[];
 994
 995 struct posix_acl;
 996 struct posix_acl *fuse_get_acl(struct inode *inode, int type);
 997 int fuse_set_acl(struct inode *inode, struct posix_acl *acl, int type);
 998
 999 #endif /* _FS_FUSE_I_H */