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