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