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 #ifndef pr_fmt
  13 # define pr_fmt(fmt) "fuse: " fmt
  14 #endif
  15
  16 #include <linux/fuse.h>
  17 #include <linux/fs.h>
  18 #include <linux/mount.h>
  19 #include <linux/wait.h>
  20 #include <linux/list.h>
  21 #include <linux/spinlock.h>
  22 #include <linux/mm.h>
  23 #include <linux/backing-dev.h>
  24 #include <linux/mutex.h>
  25 #include <linux/rwsem.h>
  26 #include <linux/rbtree.h>
  27 #include <linux/poll.h>
  28 #include <linux/workqueue.h>
  29 #include <linux/kref.h>
  30 #include <linux/xattr.h>
  31 #include <linux/pid_namespace.h>
  32 #include <linux/refcount.h>
  33 #include <linux/user_namespace.h>
  34
  35 /** Default max number of pages that can be used in a single read request */
  36 #define FUSE_DEFAULT_MAX_PAGES_PER_REQ 32
  37
  38 /** Maximum of max_pages received in init_out */
  39 #define FUSE_MAX_MAX_PAGES 256
  40
  41 /** Bias for fi->writectr, meaning new writepages must not be sent */
  42 #define FUSE_NOWRITE INT_MIN
  43
  44 /** It could be as large as PATH_MAX, but would that have any uses? */
  45 #define FUSE_NAME_MAX 1024
  46
  47 /** Number of dentries for each connection in the control filesystem */
  48 #define FUSE_CTL_NUM_DENTRIES 5
  49
  50 /** List of active connections */
  51 extern struct list_head fuse_conn_list;
  52
  53 /** Global mutex protecting fuse_conn_list and the control filesystem */
  54 extern struct mutex fuse_mutex;
  55
  56 /** Module parameters */
  57 extern unsigned max_user_bgreq;
  58 extern unsigned max_user_congthresh;
  59
  60 /* One forget request */
  61 struct fuse_forget_link {
  62         struct fuse_forget_one forget_one;
  63         struct fuse_forget_link *next;
  64 };
  65
  66 /* Submount lookup tracking */
  67 struct fuse_submount_lookup {
  68         /** Refcount */
  69         refcount_t count;
  70
  71         /** Unique ID, which identifies the inode between userspace
  72          * and kernel */
  73         u64 nodeid;
  74
  75         /** The request used for sending the FORGET message */
  76         struct fuse_forget_link *forget;
  77 };
  78
  79 /** FUSE inode */
  80 struct fuse_inode {
  81         /** Inode data */
  82         struct inode inode;
  83
  84         /** Unique ID, which identifies the inode between userspace
  85          * and kernel */
  86         u64 nodeid;
  87
  88         /** Number of lookups on this inode */
  89         u64 nlookup;
  90
  91         /** The request used for sending the FORGET message */
  92         struct fuse_forget_link *forget;
  93
  94         /** Time in jiffies until the file attributes are valid */
  95         u64 i_time;
  96
  97         /* Which attributes are invalid */
  98         u32 inval_mask;
  99
 100         /** The sticky bit in inode->i_mode may have been removed, so
 101             preserve the original mode */
 102         umode_t orig_i_mode;
 103
 104         /** 64 bit inode number */
 105         u64 orig_ino;
 106
 107         /** Version of last attribute change */
 108         u64 attr_version;
 109
 110         union {
 111                 /* Write related fields (regular file only) */
 112                 struct {
 113                         /* Files usable in writepage.  Protected by fi->lock */
 114                         struct list_head write_files;
 115
 116                         /* Writepages pending on truncate or fsync */
 117                         struct list_head queued_writes;
 118
 119                         /* Number of sent writes, a negative bias
 120                          * (FUSE_NOWRITE) means more writes are blocked */
 121                         int writectr;
 122
 123                         /* Waitq for writepage completion */
 124                         wait_queue_head_t page_waitq;
 125
 126                         /* List of writepage requestst (pending or sent) */
 127                         struct rb_root writepages;
 128                 };
 129
 130                 /* readdir cache (directory only) */
 131                 struct {
 132                         /* true if fully cached */
 133                         bool cached;
 134
 135                         /* size of cache */
 136                         loff_t size;
 137
 138                         /* position at end of cache (position of next entry) */
 139                         loff_t pos;
 140
 141                         /* version of the cache */
 142                         u64 version;
 143
 144                         /* modification time of directory when cache was
 145                          * started */
 146                         struct timespec64 mtime;
 147
 148                         /* iversion of directory when cache was started */
 149                         u64 iversion;
 150
 151                         /* protects above fields */
 152                         spinlock_t lock;
 153                 } rdc;
 154         };
 155
 156         /** Miscellaneous bits describing inode state */
 157         unsigned long state;
 158
 159         /** Lock for serializing lookup and readdir for back compatibility*/
 160         struct mutex mutex;
 161
 162         /** Lock to protect write related fields */
 163         spinlock_t lock;
 164
 165 #ifdef CONFIG_FUSE_DAX
 166         /*
 167          * Dax specific inode data
 168          */
 169         struct fuse_inode_dax *dax;
 170 #endif
 171         /** Submount specific lookup tracking */
 172         struct fuse_submount_lookup *submount_lookup;
 173 };
 174
 175 /** FUSE inode state bits */
 176 enum {
 177         /** Advise readdirplus  */
 178         FUSE_I_ADVISE_RDPLUS,
 179         /** Initialized with readdirplus */
 180         FUSE_I_INIT_RDPLUS,
 181         /** An operation changing file size is in progress  */
 182         FUSE_I_SIZE_UNSTABLE,
 183         /* Bad inode */
 184         FUSE_I_BAD,
 185 };
 186
 187 struct fuse_conn;
 188 struct fuse_mount;
 189 struct fuse_release_args;
 190
 191 /** FUSE specific file data */
 192 struct fuse_file {
 193         /** Fuse connection for this file */
 194         struct fuse_mount *fm;
 195
 196         /* Argument space reserved for release */
 197         struct fuse_release_args *release_args;
 198
 199         /** Kernel file handle guaranteed to be unique */
 200         u64 kh;
 201
 202         /** File handle used by userspace */
 203         u64 fh;
 204
 205         /** Node id of this file */
 206         u64 nodeid;
 207
 208         /** Refcount */
 209         refcount_t count;
 210
 211         /** FOPEN_* flags returned by open */
 212         u32 open_flags;
 213
 214         /** Entry on inode's write_files list */
 215         struct list_head write_entry;
 216
 217         /* Readdir related */
 218         struct {
 219                 /*
 220                  * Protects below fields against (crazy) parallel readdir on
 221                  * same open file.  Uncontended in the normal case.
 222                  */
 223                 struct mutex lock;
 224
 225                 /* Dir stream position */
 226                 loff_t pos;
 227
 228                 /* Offset in cache */
 229                 loff_t cache_off;
 230
 231                 /* Version of cache we are reading */
 232                 u64 version;
 233
 234         } readdir;
 235
 236         /** RB node to be linked on fuse_conn->polled_files */
 237         struct rb_node polled_node;
 238
 239         /** Wait queue head for poll */
 240         wait_queue_head_t poll_wait;
 241
 242         /** Has flock been performed on this file? */
 243         bool flock:1;
 244 };
 245
 246 /** One input argument of a request */
 247 struct fuse_in_arg {
 248         unsigned size;
 249         const void *value;
 250 };
 251
 252 /** One output argument of a request */
 253 struct fuse_arg {
 254         unsigned size;
 255         void *value;
 256 };
 257
 258 /** FUSE page descriptor */
 259 struct fuse_page_desc {
 260         unsigned int length;
 261         unsigned int offset;
 262 };
 263
 264 struct fuse_args {
 265         uint64_t nodeid;
 266         uint32_t opcode;
 267         unsigned short in_numargs;
 268         unsigned short out_numargs;
 269         bool force:1;
 270         bool noreply:1;
 271         bool nocreds:1;
 272         bool in_pages:1;
 273         bool out_pages:1;
 274         bool user_pages:1;
 275         bool out_argvar:1;
 276         bool page_zeroing:1;
 277         bool page_replace:1;
 278         bool may_block:1;
 279         struct fuse_in_arg in_args[3];
 280         struct fuse_arg out_args[2];
 281         void (*end)(struct fuse_mount *fm, struct fuse_args *args, int error);
 282 };
 283
 284 struct fuse_args_pages {
 285         struct fuse_args args;
 286         struct page **pages;
 287         struct fuse_page_desc *descs;
 288         unsigned int num_pages;
 289 };
 290
 291 #define FUSE_ARGS(args) struct fuse_args args = {}
 292
 293 /** The request IO state (for asynchronous processing) */
 294 struct fuse_io_priv {
 295         struct kref refcnt;
 296         int async;
 297         spinlock_t lock;
 298         unsigned reqs;
 299         ssize_t bytes;
 300         size_t size;
 301         __u64 offset;
 302         bool write;
 303         bool should_dirty;
 304         int err;
 305         struct kiocb *iocb;
 306         struct completion *done;
 307         bool blocking;
 308 };
 309
 310 #define FUSE_IO_PRIV_SYNC(i) \
 311 {                                       \
 312         .refcnt = KREF_INIT(1),         \
 313         .async = 0,                     \
 314         .iocb = i,                      \
 315 }
 316
 317 /**
 318  * Request flags
 319  *
 320  * FR_ISREPLY:          set if the request has reply
 321  * FR_FORCE:            force sending of the request even if interrupted
 322  * FR_BACKGROUND:       request is sent in the background
 323  * FR_WAITING:          request is counted as "waiting"
 324  * FR_ABORTED:          the request was aborted
 325  * FR_INTERRUPTED:      the request has been interrupted
 326  * FR_LOCKED:           data is being copied to/from the request
 327  * FR_PENDING:          request is not yet in userspace
 328  * FR_SENT:             request is in userspace, waiting for an answer
 329  * FR_FINISHED:         request is finished
 330  * FR_PRIVATE:          request is on private list
 331  * FR_ASYNC:            request is asynchronous
 332  */
 333 enum fuse_req_flag {
 334         FR_ISREPLY,
 335         FR_FORCE,
 336         FR_BACKGROUND,
 337         FR_WAITING,
 338         FR_ABORTED,
 339         FR_INTERRUPTED,
 340         FR_LOCKED,
 341         FR_PENDING,
 342         FR_SENT,
 343         FR_FINISHED,
 344         FR_PRIVATE,
 345         FR_ASYNC,
 346 };
 347
 348 /**
 349  * A request to the client
 350  *
 351  * .waitq.lock protects the following fields:
 352  *   - FR_ABORTED
 353  *   - FR_LOCKED (may also be modified under fc->lock, tested under both)
 354  */
 355 struct fuse_req {
 356         /** This can be on either pending processing or io lists in
 357             fuse_conn */
 358         struct list_head list;
 359
 360         /** Entry on the interrupts list  */
 361         struct list_head intr_entry;
 362
 363         /* Input/output arguments */
 364         struct fuse_args *args;
 365
 366         /** refcount */
 367         refcount_t count;
 368
 369         /* Request flags, updated with test/set/clear_bit() */
 370         unsigned long flags;
 371
 372         /* The request input header */
 373         struct {
 374                 struct fuse_in_header h;
 375         } in;
 376
 377         /* The request output header */
 378         struct {
 379                 struct fuse_out_header h;
 380         } out;
 381
 382         /** Used to wake up the task waiting for completion of request*/
 383         wait_queue_head_t waitq;
 384
 385 #if IS_ENABLED(CONFIG_VIRTIO_FS)
 386         /** virtio-fs's physically contiguous buffer for in and out args */
 387         void *argbuf;
 388 #endif
 389
 390         /** fuse_mount this request belongs to */
 391         struct fuse_mount *fm;
 392 };
 393
 394 struct fuse_iqueue;
 395
 396 /**
 397  * Input queue callbacks
 398  *
 399  * Input queue signalling is device-specific.  For example, the /dev/fuse file
 400  * uses fiq->waitq and fasync to wake processes that are waiting on queue
 401  * readiness.  These callbacks allow other device types to respond to input
 402  * queue activity.
 403  */
 404 struct fuse_iqueue_ops {
 405         /**
 406          * Signal that a forget has been queued
 407          */
 408         void (*wake_forget_and_unlock)(struct fuse_iqueue *fiq)
 409                 __releases(fiq->lock);
 410
 411         /**
 412          * Signal that an INTERRUPT request has been queued
 413          */
 414         void (*wake_interrupt_and_unlock)(struct fuse_iqueue *fiq)
 415                 __releases(fiq->lock);
 416
 417         /**
 418          * Signal that a request has been queued
 419          */
 420         void (*wake_pending_and_unlock)(struct fuse_iqueue *fiq)
 421                 __releases(fiq->lock);
 422
 423         /**
 424          * Clean up when fuse_iqueue is destroyed
 425          */
 426         void (*release)(struct fuse_iqueue *fiq);
 427 };
 428
 429 /** /dev/fuse input queue operations */
 430 extern const struct fuse_iqueue_ops fuse_dev_fiq_ops;
 431
 432 struct fuse_iqueue {
 433         /** Connection established */
 434         unsigned connected;
 435
 436         /** Lock protecting accesses to members of this structure */
 437         spinlock_t lock;
 438
 439         /** Readers of the connection are waiting on this */
 440         wait_queue_head_t waitq;
 441
 442         /** The next unique request id */
 443         u64 reqctr;
 444
 445         /** The list of pending requests */
 446         struct list_head pending;
 447
 448         /** Pending interrupts */
 449         struct list_head interrupts;
 450
 451         /** Queue of pending forgets */
 452         struct fuse_forget_link forget_list_head;
 453         struct fuse_forget_link *forget_list_tail;
 454
 455         /** Batching of FORGET requests (positive indicates FORGET batch) */
 456         int forget_batch;
 457
 458         /** O_ASYNC requests */
 459         struct fasync_struct *fasync;
 460
 461         /** Device-specific callbacks */
 462         const struct fuse_iqueue_ops *ops;
 463
 464         /** Device-specific state */
 465         void *priv;
 466 };
 467
 468 #define FUSE_PQ_HASH_BITS 8
 469 #define FUSE_PQ_HASH_SIZE (1 << FUSE_PQ_HASH_BITS)
 470
 471 struct fuse_pqueue {
 472         /** Connection established */
 473         unsigned connected;
 474
 475         /** Lock protecting accessess to  members of this structure */
 476         spinlock_t lock;
 477
 478         /** Hash table of requests being processed */
 479         struct list_head *processing;
 480
 481         /** The list of requests under I/O */
 482         struct list_head io;
 483 };
 484
 485 /**
 486  * Fuse device instance
 487  */
 488 struct fuse_dev {
 489         /** Fuse connection for this device */
 490         struct fuse_conn *fc;
 491
 492         /** Processing queue */
 493         struct fuse_pqueue pq;
 494
 495         /** list entry on fc->devices */
 496         struct list_head entry;
 497 };
 498
 499 enum fuse_dax_mode {
 500         FUSE_DAX_INODE_DEFAULT, /* default */
 501         FUSE_DAX_ALWAYS,        /* "-o dax=always" */
 502         FUSE_DAX_NEVER,         /* "-o dax=never" */
 503         FUSE_DAX_INODE_USER,    /* "-o dax=inode" */
 504 };
 505
 506 static inline bool fuse_is_inode_dax_mode(enum fuse_dax_mode mode)
 507 {
 508         return mode == FUSE_DAX_INODE_DEFAULT || mode == FUSE_DAX_INODE_USER;
 509 }
 510
 511 struct fuse_fs_context {
 512         int fd;
 513         struct file *file;
 514         unsigned int rootmode;
 515         kuid_t user_id;
 516         kgid_t group_id;
 517         bool is_bdev:1;
 518         bool fd_present:1;
 519         bool rootmode_present:1;
 520         bool user_id_present:1;
 521         bool group_id_present:1;
 522         bool default_permissions:1;
 523         bool allow_other:1;
 524         bool destroy:1;
 525         bool no_control:1;
 526         bool no_force_umount:1;
 527         bool legacy_opts_show:1;
 528         enum fuse_dax_mode dax_mode;
 529         unsigned int max_read;
 530         unsigned int blksize;
 531         const char *subtype;
 532
 533         /* DAX device, may be NULL */
 534         struct dax_device *dax_dev;
 535
 536         /* fuse_dev pointer to fill in, should contain NULL on entry */
 537         void **fudptr;
 538 };
 539
 540 struct fuse_sync_bucket {
 541         /* count is a possible scalability bottleneck */
 542         atomic_t count;
 543         wait_queue_head_t waitq;
 544         struct rcu_head rcu;
 545 };
 546
 547 /**
 548  * A Fuse connection.
 549  *
 550  * This structure is created, when the root filesystem is mounted, and
 551  * is destroyed, when the client device is closed and the last
 552  * fuse_mount is destroyed.
 553  */
 554 struct fuse_conn {
 555         /** Lock protecting accessess to  members of this structure */
 556         spinlock_t lock;
 557
 558         /** Refcount */
 559         refcount_t count;
 560
 561         /** Number of fuse_dev's */
 562         atomic_t dev_count;
 563
 564         struct rcu_head rcu;
 565
 566         /** The user id for this mount */
 567         kuid_t user_id;
 568
 569         /** The group id for this mount */
 570         kgid_t group_id;
 571
 572         /** The pid namespace for this mount */
 573         struct pid_namespace *pid_ns;
 574
 575         /** The user namespace for this mount */
 576         struct user_namespace *user_ns;
 577
 578         /** Maximum read size */
 579         unsigned max_read;
 580
 581         /** Maximum write size */
 582         unsigned max_write;
 583
 584         /** Maximum number of pages that can be used in a single request */
 585         unsigned int max_pages;
 586
 587         /** Constrain ->max_pages to this value during feature negotiation */
 588         unsigned int max_pages_limit;
 589
 590         /** Input queue */
 591         struct fuse_iqueue iq;
 592
 593         /** The next unique kernel file handle */
 594         atomic64_t khctr;
 595
 596         /** rbtree of fuse_files waiting for poll events indexed by ph */
 597         struct rb_root polled_files;
 598
 599         /** Maximum number of outstanding background requests */
 600         unsigned max_background;
 601
 602         /** Number of background requests at which congestion starts */
 603         unsigned congestion_threshold;
 604
 605         /** Number of requests currently in the background */
 606         unsigned num_background;
 607
 608         /** Number of background requests currently queued for userspace */
 609         unsigned active_background;
 610
 611         /** The list of background requests set aside for later queuing */
 612         struct list_head bg_queue;
 613
 614         /** Protects: max_background, congestion_threshold, num_background,
 615          * active_background, bg_queue, blocked */
 616         spinlock_t bg_lock;
 617
 618         /** Flag indicating that INIT reply has been received. Allocating
 619          * any fuse request will be suspended until the flag is set */
 620         int initialized;
 621
 622         /** Flag indicating if connection is blocked.  This will be
 623             the case before the INIT reply is received, and if there
 624             are too many outstading backgrounds requests */
 625         int blocked;
 626
 627         /** waitq for blocked connection */
 628         wait_queue_head_t blocked_waitq;
 629
 630         /** Connection established, cleared on umount, connection
 631             abort and device release */
 632         unsigned connected;
 633
 634         /** Connection aborted via sysfs */
 635         bool aborted;
 636
 637         /** Connection failed (version mismatch).  Cannot race with
 638             setting other bitfields since it is only set once in INIT
 639             reply, before any other request, and never cleared */
 640         unsigned conn_error:1;
 641
 642         /** Connection successful.  Only set in INIT */
 643         unsigned conn_init:1;
 644
 645         /** Do readahead asynchronously?  Only set in INIT */
 646         unsigned async_read:1;
 647
 648         /** Return an unique read error after abort.  Only set in INIT */
 649         unsigned abort_err:1;
 650
 651         /** Do not send separate SETATTR request before open(O_TRUNC)  */
 652         unsigned atomic_o_trunc:1;
 653
 654         /** Filesystem supports NFS exporting.  Only set in INIT */
 655         unsigned export_support:1;
 656
 657         /** write-back cache policy (default is write-through) */
 658         unsigned writeback_cache:1;
 659
 660         /** allow parallel lookups and readdir (default is serialized) */
 661         unsigned parallel_dirops:1;
 662
 663         /** handle fs handles killing suid/sgid/cap on write/chown/trunc */
 664         unsigned handle_killpriv:1;
 665
 666         /** cache READLINK responses in page cache */
 667         unsigned cache_symlinks:1;
 668
 669         /* show legacy mount options */
 670         unsigned int legacy_opts_show:1;
 671
 672         /*
 673          * fs kills suid/sgid/cap on write/chown/trunc. suid is killed on
 674          * write/trunc only if caller did not have CAP_FSETID.  sgid is killed
 675          * on write/truncate only if caller did not have CAP_FSETID as well as
 676          * file has group execute permission.
 677          */
 678         unsigned handle_killpriv_v2:1;
 679
 680         /*
 681          * The following bitfields are only for optimization purposes
 682          * and hence races in setting them will not cause malfunction
 683          */
 684
 685         /** Is open/release not implemented by fs? */
 686         unsigned no_open:1;
 687
 688         /** Is opendir/releasedir not implemented by fs? */
 689         unsigned no_opendir:1;
 690
 691         /** Is fsync not implemented by fs? */
 692         unsigned no_fsync:1;
 693
 694         /** Is fsyncdir not implemented by fs? */
 695         unsigned no_fsyncdir:1;
 696
 697         /** Is flush not implemented by fs? */
 698         unsigned no_flush:1;
 699
 700         /** Is setxattr not implemented by fs? */
 701         unsigned no_setxattr:1;
 702
 703         /** Does file server support extended setxattr */
 704         unsigned setxattr_ext:1;
 705
 706         /** Is getxattr not implemented by fs? */
 707         unsigned no_getxattr:1;
 708
 709         /** Is listxattr not implemented by fs? */
 710         unsigned no_listxattr:1;
 711
 712         /** Is removexattr not implemented by fs? */
 713         unsigned no_removexattr:1;
 714
 715         /** Are posix file locking primitives not implemented by fs? */
 716         unsigned no_lock:1;
 717
 718         /** Is access not implemented by fs? */
 719         unsigned no_access:1;
 720
 721         /** Is create not implemented by fs? */
 722         unsigned no_create:1;
 723
 724         /** Is interrupt not implemented by fs? */
 725         unsigned no_interrupt:1;
 726
 727         /** Is bmap not implemented by fs? */
 728         unsigned no_bmap:1;
 729
 730         /** Is poll not implemented by fs? */
 731         unsigned no_poll:1;
 732
 733         /** Do multi-page cached writes */
 734         unsigned big_writes:1;
 735
 736         /** Don't apply umask to creation modes */
 737         unsigned dont_mask:1;
 738
 739         /** Are BSD file locking primitives not implemented by fs? */
 740         unsigned no_flock:1;
 741
 742         /** Is fallocate not implemented by fs? */
 743         unsigned no_fallocate:1;
 744
 745         /** Is rename with flags implemented by fs? */
 746         unsigned no_rename2:1;
 747
 748         /** Use enhanced/automatic page cache invalidation. */
 749         unsigned auto_inval_data:1;
 750
 751         /** Filesystem is fully responsible for page cache invalidation. */
 752         unsigned explicit_inval_data:1;
 753
 754         /** Does the filesystem support readdirplus? */
 755         unsigned do_readdirplus:1;
 756
 757         /** Does the filesystem want adaptive readdirplus? */
 758         unsigned readdirplus_auto:1;
 759
 760         /** Does the filesystem support asynchronous direct-IO submission? */
 761         unsigned async_dio:1;
 762
 763         /** Is lseek not implemented by fs? */
 764         unsigned no_lseek:1;
 765
 766         /** Does the filesystem support posix acls? */
 767         unsigned posix_acl:1;
 768
 769         /** Check permissions based on the file mode or not? */
 770         unsigned default_permissions:1;
 771
 772         /** Allow other than the mounter user to access the filesystem ? */
 773         unsigned allow_other:1;
 774
 775         /** Does the filesystem support copy_file_range? */
 776         unsigned no_copy_file_range:1;
 777
 778         /* Send DESTROY request */
 779         unsigned int destroy:1;
 780
 781         /* Delete dentries that have gone stale */
 782         unsigned int delete_stale:1;
 783
 784         /** Do not create entry in fusectl fs */
 785         unsigned int no_control:1;
 786
 787         /** Do not allow MNT_FORCE umount */
 788         unsigned int no_force_umount:1;
 789
 790         /* Auto-mount submounts announced by the server */
 791         unsigned int auto_submounts:1;
 792
 793         /* Propagate syncfs() to server */
 794         unsigned int sync_fs:1;
 795
 796         /* Initialize security xattrs when creating a new inode */
 797         unsigned int init_security:1;
 798
 799         /* Does the filesystem support per inode DAX? */
 800         unsigned int inode_dax:1;
 801
 802         /* Is tmpfile not implemented by fs? */
 803         unsigned int no_tmpfile:1;
 804
 805         /** The number of requests waiting for completion */
 806         atomic_t num_waiting;
 807
 808         /** Negotiated minor version */
 809         unsigned minor;
 810
 811         /** Entry on the fuse_mount_list */
 812         struct list_head entry;
 813
 814         /** Device ID from the root super block */
 815         dev_t dev;
 816
 817         /** Dentries in the control filesystem */
 818         struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
 819
 820         /** number of dentries used in the above array */
 821         int ctl_ndents;
 822
 823         /** Key for lock owner ID scrambling */
 824         u32 scramble_key[4];
 825
 826         /** Version counter for attribute changes */
 827         atomic64_t attr_version;
 828
 829         /** Called on final put */
 830         void (*release)(struct fuse_conn *);
 831
 832         /**
 833          * Read/write semaphore to hold when accessing the sb of any
 834          * fuse_mount belonging to this connection
 835          */
 836         struct rw_semaphore killsb;
 837
 838         /** List of device instances belonging to this connection */
 839         struct list_head devices;
 840
 841 #ifdef CONFIG_FUSE_DAX
 842         /* Dax mode */
 843         enum fuse_dax_mode dax_mode;
 844
 845         /* Dax specific conn data, non-NULL if DAX is enabled */
 846         struct fuse_conn_dax *dax;
 847 #endif
 848
 849         /** List of filesystems using this connection */
 850         struct list_head mounts;
 851
 852         /* New writepages go into this bucket */
 853         struct fuse_sync_bucket __rcu *curr_bucket;
 854 };
 855
 856 /*
 857  * Represents a mounted filesystem, potentially a submount.
 858  *
 859  * This object allows sharing a fuse_conn between separate mounts to
 860  * allow submounts with dedicated superblocks and thus separate device
 861  * IDs.
 862  */
 863 struct fuse_mount {
 864         /* Underlying (potentially shared) connection to the FUSE server */
 865         struct fuse_conn *fc;
 866
 867         /*
 868          * Super block for this connection (fc->killsb must be held when
 869          * accessing this).
 870          */
 871         struct super_block *sb;
 872
 873         /* Entry on fc->mounts */
 874         struct list_head fc_entry;
 875 };
 876
 877 static inline struct fuse_mount *get_fuse_mount_super(struct super_block *sb)
 878 {
 879         return sb->s_fs_info;
 880 }
 881
 882 static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
 883 {
 884         return get_fuse_mount_super(sb)->fc;
 885 }
 886
 887 static inline struct fuse_mount *get_fuse_mount(struct inode *inode)
 888 {
 889         return get_fuse_mount_super(inode->i_sb);
 890 }
 891
 892 static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
 893 {
 894         return get_fuse_mount_super(inode->i_sb)->fc;
 895 }
 896
 897 static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
 898 {
 899         return container_of(inode, struct fuse_inode, inode);
 900 }
 901
 902 static inline u64 get_node_id(struct inode *inode)
 903 {
 904         return get_fuse_inode(inode)->nodeid;
 905 }
 906
 907 static inline int invalid_nodeid(u64 nodeid)
 908 {
 909         return !nodeid || nodeid == FUSE_ROOT_ID;
 910 }
 911
 912 static inline u64 fuse_get_attr_version(struct fuse_conn *fc)
 913 {
 914         return atomic64_read(&fc->attr_version);
 915 }
 916
 917 static inline bool fuse_stale_inode(const struct inode *inode, int generation,
 918                                     struct fuse_attr *attr)
 919 {
 920         return inode->i_generation != generation ||
 921                 inode_wrong_type(inode, attr->mode);
 922 }
 923
 924 static inline void fuse_make_bad(struct inode *inode)
 925 {
 926         set_bit(FUSE_I_BAD, &get_fuse_inode(inode)->state);
 927 }
 928
 929 static inline bool fuse_is_bad(struct inode *inode)
 930 {
 931         return unlikely(test_bit(FUSE_I_BAD, &get_fuse_inode(inode)->state));
 932 }
 933
 934 static inline struct page **fuse_pages_alloc(unsigned int npages, gfp_t flags,
 935                                              struct fuse_page_desc **desc)
 936 {
 937         struct page **pages;
 938
 939         pages = kzalloc(npages * (sizeof(struct page *) +
 940                                   sizeof(struct fuse_page_desc)), flags);
 941         *desc = (void *) (pages + npages);
 942
 943         return pages;
 944 }
 945
 946 static inline void fuse_page_descs_length_init(struct fuse_page_desc *descs,
 947                                                unsigned int index,
 948                                                unsigned int nr_pages)
 949 {
 950         int i;
 951
 952         for (i = index; i < index + nr_pages; i++)
 953                 descs[i].length = PAGE_SIZE - descs[i].offset;
 954 }
 955
 956 static inline void fuse_sync_bucket_dec(struct fuse_sync_bucket *bucket)
 957 {
 958         /* Need RCU protection to prevent use after free after the decrement */
 959         rcu_read_lock();
 960         if (atomic_dec_and_test(&bucket->count))
 961                 wake_up(&bucket->waitq);
 962         rcu_read_unlock();
 963 }
 964
 965 /** Device operations */
 966 extern const struct file_operations fuse_dev_operations;
 967
 968 extern const struct dentry_operations fuse_dentry_operations;
 969 extern const struct dentry_operations fuse_root_dentry_operations;
 970
 971 /**
 972  * Get a filled in inode
 973  */
 974 struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
 975                         int generation, struct fuse_attr *attr,
 976                         u64 attr_valid, u64 attr_version);
 977
 978 int fuse_lookup_name(struct super_block *sb, u64 nodeid, const struct qstr *name,
 979                      struct fuse_entry_out *outarg, struct inode **inode);
 980
 981 /**
 982  * Send FORGET command
 983  */
 984 void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
 985                        u64 nodeid, u64 nlookup);
 986
 987 struct fuse_forget_link *fuse_alloc_forget(void);
 988
 989 struct fuse_forget_link *fuse_dequeue_forget(struct fuse_iqueue *fiq,
 990                                              unsigned int max,
 991                                              unsigned int *countp);
 992
 993 /*
 994  * Initialize READ or READDIR request
 995  */
 996 struct fuse_io_args {
 997         union {
 998                 struct {
 999                         struct fuse_read_in in;
1000                         u64 attr_ver;
1001                 } read;
1002                 struct {
1003                         struct fuse_write_in in;
1004                         struct fuse_write_out out;
1005                         bool page_locked;
1006                 } write;
1007         };
1008         struct fuse_args_pages ap;
1009         struct fuse_io_priv *io;
1010         struct fuse_file *ff;
1011 };
1012
1013 void fuse_read_args_fill(struct fuse_io_args *ia, struct file *file, loff_t pos,
1014                          size_t count, int opcode);
1015
1016
1017 /**
1018  * Send OPEN or OPENDIR request
1019  */
1020 int fuse_open_common(struct inode *inode, struct file *file, bool isdir);
1021
1022 struct fuse_file *fuse_file_alloc(struct fuse_mount *fm);
1023 void fuse_file_free(struct fuse_file *ff);
1024 void fuse_finish_open(struct inode *inode, struct file *file);
1025
1026 void fuse_sync_release(struct fuse_inode *fi, struct fuse_file *ff,
1027                        unsigned int flags);
1028
1029 /**
1030  * Send RELEASE or RELEASEDIR request
1031  */
1032 void fuse_release_common(struct file *file, bool isdir);
1033
1034 /**
1035  * Send FSYNC or FSYNCDIR request
1036  */
1037 int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
1038                       int datasync, int opcode);
1039
1040 /**
1041  * Notify poll wakeup
1042  */
1043 int fuse_notify_poll_wakeup(struct fuse_conn *fc,
1044                             struct fuse_notify_poll_wakeup_out *outarg);
1045
1046 /**
1047  * Initialize file operations on a regular file
1048  */
1049 void fuse_init_file_inode(struct inode *inode, unsigned int flags);
1050
1051 /**
1052  * Initialize inode operations on regular files and special files
1053  */
1054 void fuse_init_common(struct inode *inode);
1055
1056 /**
1057  * Initialize inode and file operations on a directory
1058  */
1059 void fuse_init_dir(struct inode *inode);
1060
1061 /**
1062  * Initialize inode operations on a symlink
1063  */
1064 void fuse_init_symlink(struct inode *inode);
1065
1066 /**
1067  * Change attributes of an inode
1068  */
1069 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
1070                             u64 attr_valid, u64 attr_version);
1071
1072 void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
1073                                    u64 attr_valid, u32 cache_mask);
1074
1075 u32 fuse_get_cache_mask(struct inode *inode);
1076
1077 /**
1078  * Initialize the client device
1079  */
1080 int fuse_dev_init(void);
1081
1082 /**
1083  * Cleanup the client device
1084  */
1085 void fuse_dev_cleanup(void);
1086
1087 int fuse_ctl_init(void);
1088 void __exit fuse_ctl_cleanup(void);
1089
1090 /**
1091  * Simple request sending that does request allocation and freeing
1092  */
1093 ssize_t fuse_simple_request(struct fuse_mount *fm, struct fuse_args *args);
1094 int fuse_simple_background(struct fuse_mount *fm, struct fuse_args *args,
1095                            gfp_t gfp_flags);
1096
1097 /**
1098  * End a finished request
1099  */
1100 void fuse_request_end(struct fuse_req *req);
1101
1102 /* Abort all requests */
1103 void fuse_abort_conn(struct fuse_conn *fc);
1104 void fuse_wait_aborted(struct fuse_conn *fc);
1105
1106 /**
1107  * Invalidate inode attributes
1108  */
1109
1110 /* Attributes possibly changed on data modification */
1111 #define FUSE_STATX_MODIFY       (STATX_MTIME | STATX_CTIME | STATX_BLOCKS)
1112
1113 /* Attributes possibly changed on data and/or size modification */
1114 #define FUSE_STATX_MODSIZE      (FUSE_STATX_MODIFY | STATX_SIZE)
1115
1116 void fuse_invalidate_attr(struct inode *inode);
1117 void fuse_invalidate_attr_mask(struct inode *inode, u32 mask);
1118
1119 void fuse_invalidate_entry_cache(struct dentry *entry);
1120
1121 void fuse_invalidate_atime(struct inode *inode);
1122
1123 u64 entry_attr_timeout(struct fuse_entry_out *o);
1124 void fuse_change_entry_timeout(struct dentry *entry, struct fuse_entry_out *o);
1125
1126 /**
1127  * Acquire reference to fuse_conn
1128  */
1129 struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
1130
1131 /**
1132  * Initialize fuse_conn
1133  */
1134 void fuse_conn_init(struct fuse_conn *fc, struct fuse_mount *fm,
1135                     struct user_namespace *user_ns,
1136                     const struct fuse_iqueue_ops *fiq_ops, void *fiq_priv);
1137
1138 /**
1139  * Release reference to fuse_conn
1140  */
1141 void fuse_conn_put(struct fuse_conn *fc);
1142
1143 struct fuse_dev *fuse_dev_alloc_install(struct fuse_conn *fc);
1144 struct fuse_dev *fuse_dev_alloc(void);
1145 void fuse_dev_install(struct fuse_dev *fud, struct fuse_conn *fc);
1146 void fuse_dev_free(struct fuse_dev *fud);
1147 void fuse_send_init(struct fuse_mount *fm);
1148
1149 /**
1150  * Fill in superblock and initialize fuse connection
1151  * @sb: partially-initialized superblock to fill in
1152  * @ctx: mount context
1153  */
1154 int fuse_fill_super_common(struct super_block *sb, struct fuse_fs_context *ctx);
1155
1156 /*
1157  * Remove the mount from the connection
1158  *
1159  * Returns whether this was the last mount
1160  */
1161 bool fuse_mount_remove(struct fuse_mount *fm);
1162
1163 /*
1164  * Setup context ops for submounts
1165  */
1166 int fuse_init_fs_context_submount(struct fs_context *fsc);
1167
1168 /*
1169  * Shut down the connection (possibly sending DESTROY request).
1170  */
1171 void fuse_conn_destroy(struct fuse_mount *fm);
1172
1173 /* Drop the connection and free the fuse mount */
1174 void fuse_mount_destroy(struct fuse_mount *fm);
1175
1176 /**
1177  * Add connection to control filesystem
1178  */
1179 int fuse_ctl_add_conn(struct fuse_conn *fc);
1180
1181 /**
1182  * Remove connection from control filesystem
1183  */
1184 void fuse_ctl_remove_conn(struct fuse_conn *fc);
1185
1186 /**
1187  * Is file type valid?
1188  */
1189 int fuse_valid_type(int m);
1190
1191 bool fuse_invalid_attr(struct fuse_attr *attr);
1192
1193 /**
1194  * Is current process allowed to perform filesystem operation?
1195  */
1196 int fuse_allow_current_process(struct fuse_conn *fc);
1197
1198 u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
1199
1200 void fuse_flush_time_update(struct inode *inode);
1201 void fuse_update_ctime(struct inode *inode);
1202
1203 int fuse_update_attributes(struct inode *inode, struct file *file, u32 mask);
1204
1205 void fuse_flush_writepages(struct inode *inode);
1206
1207 void fuse_set_nowrite(struct inode *inode);
1208 void fuse_release_nowrite(struct inode *inode);
1209
1210 /**
1211  * Scan all fuse_mounts belonging to fc to find the first where
1212  * ilookup5() returns a result.  Return that result and the
1213  * respective fuse_mount in *fm (unless fm is NULL).
1214  *
1215  * The caller must hold fc->killsb.
1216  */
1217 struct inode *fuse_ilookup(struct fuse_conn *fc, u64 nodeid,
1218                            struct fuse_mount **fm);
1219
1220 /**
1221  * File-system tells the kernel to invalidate cache for the given node id.
1222  */
1223 int fuse_reverse_inval_inode(struct fuse_conn *fc, u64 nodeid,
1224                              loff_t offset, loff_t len);
1225
1226 /**
1227  * File-system tells the kernel to invalidate parent attributes and
1228  * the dentry matching parent/name.
1229  *
1230  * If the child_nodeid is non-zero and:
1231  *    - matches the inode number for the dentry matching parent/name,
1232  *    - is not a mount point
1233  *    - is a file or oan empty directory
1234  * then the dentry is unhashed (d_delete()).
1235  */
1236 int fuse_reverse_inval_entry(struct fuse_conn *fc, u64 parent_nodeid,
1237                              u64 child_nodeid, struct qstr *name);
1238
1239 int fuse_do_open(struct fuse_mount *fm, u64 nodeid, struct file *file,
1240                  bool isdir);
1241
1242 /**
1243  * fuse_direct_io() flags
1244  */
1245
1246 /** If set, it is WRITE; otherwise - READ */
1247 #define FUSE_DIO_WRITE (1 << 0)
1248
1249 /** CUSE pass fuse_direct_io() a file which f_mapping->host is not from FUSE */
1250 #define FUSE_DIO_CUSE  (1 << 1)
1251
1252 ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
1253                        loff_t *ppos, int flags);
1254 long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
1255                    unsigned int flags);
1256 long fuse_ioctl_common(struct file *file, unsigned int cmd,
1257                        unsigned long arg, unsigned int flags);
1258 __poll_t fuse_file_poll(struct file *file, poll_table *wait);
1259 int fuse_dev_release(struct inode *inode, struct file *file);
1260
1261 bool fuse_write_update_attr(struct inode *inode, loff_t pos, ssize_t written);
1262
1263 int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
1264 int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
1265
1266 int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
1267                     struct file *file);
1268
1269 void fuse_set_initialized(struct fuse_conn *fc);
1270
1271 void fuse_unlock_inode(struct inode *inode, bool locked);
1272 bool fuse_lock_inode(struct inode *inode);
1273
1274 int fuse_setxattr(struct inode *inode, const char *name, const void *value,
1275                   size_t size, int flags, unsigned int extra_flags);
1276 ssize_t fuse_getxattr(struct inode *inode, const char *name, void *value,
1277                       size_t size);
1278 ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
1279 int fuse_removexattr(struct inode *inode, const char *name);
1280 extern const struct xattr_handler *fuse_xattr_handlers[];
1281 extern const struct xattr_handler *fuse_acl_xattr_handlers[];
1282 extern const struct xattr_handler *fuse_no_acl_xattr_handlers[];
1283
1284 struct posix_acl;
1285 struct posix_acl *fuse_get_acl(struct inode *inode, int type, bool rcu);
1286 int fuse_set_acl(struct user_namespace *mnt_userns, struct inode *inode,
1287                  struct posix_acl *acl, int type);
1288
1289 /* readdir.c */
1290 int fuse_readdir(struct file *file, struct dir_context *ctx);
1291
1292 /**
1293  * Return the number of bytes in an arguments list
1294  */
1295 unsigned int fuse_len_args(unsigned int numargs, struct fuse_arg *args);
1296
1297 /**
1298  * Get the next unique ID for a request
1299  */
1300 u64 fuse_get_unique(struct fuse_iqueue *fiq);
1301 void fuse_free_conn(struct fuse_conn *fc);
1302
1303 /* dax.c */
1304
1305 #define FUSE_IS_DAX(inode) (IS_ENABLED(CONFIG_FUSE_DAX) && IS_DAX(inode))
1306
1307 ssize_t fuse_dax_read_iter(struct kiocb *iocb, struct iov_iter *to);
1308 ssize_t fuse_dax_write_iter(struct kiocb *iocb, struct iov_iter *from);
1309 int fuse_dax_mmap(struct file *file, struct vm_area_struct *vma);
1310 int fuse_dax_break_layouts(struct inode *inode, u64 dmap_start, u64 dmap_end);
1311 int fuse_dax_conn_alloc(struct fuse_conn *fc, enum fuse_dax_mode mode,
1312                         struct dax_device *dax_dev);
1313 void fuse_dax_conn_free(struct fuse_conn *fc);
1314 bool fuse_dax_inode_alloc(struct super_block *sb, struct fuse_inode *fi);
1315 void fuse_dax_inode_init(struct inode *inode, unsigned int flags);
1316 void fuse_dax_inode_cleanup(struct inode *inode);
1317 void fuse_dax_dontcache(struct inode *inode, unsigned int flags);
1318 bool fuse_dax_check_alignment(struct fuse_conn *fc, unsigned int map_alignment);
1319 void fuse_dax_cancel_work(struct fuse_conn *fc);
1320
1321 /* ioctl.c */
1322 long fuse_file_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1323 long fuse_file_compat_ioctl(struct file *file, unsigned int cmd,
1324                             unsigned long arg);
1325 int fuse_fileattr_get(struct dentry *dentry, struct fileattr *fa);
1326 int fuse_fileattr_set(struct user_namespace *mnt_userns,
1327                       struct dentry *dentry, struct fileattr *fa);
1328
1329 /* file.c */
1330
1331 struct fuse_file *fuse_file_open(struct fuse_mount *fm, u64 nodeid,
1332                                  unsigned int open_flags, bool isdir);
1333 void fuse_file_release(struct inode *inode, struct fuse_file *ff,
1334                        unsigned int open_flags, fl_owner_t id, bool isdir);
1335
1336 #endif /* _FS_FUSE_I_H */