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