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 user_pages:1;
 267         bool out_argvar:1;
 268         bool page_zeroing:1;
 269         bool page_replace:1;
 270         bool may_block:1;
 271         struct fuse_in_arg in_args[3];
 272         struct fuse_arg out_args[2];
 273         void (*end)(struct fuse_mount *fm, struct fuse_args *args, int error);
 274 };
 275
 276 struct fuse_args_pages {
 277         struct fuse_args args;
 278         struct page **pages;
 279         struct fuse_page_desc *descs;
 280         unsigned int num_pages;
 281 };
 282
 283 #define FUSE_ARGS(args) struct fuse_args args = {}
 284
 285 /** The request IO state (for asynchronous processing) */
 286 struct fuse_io_priv {
 287         struct kref refcnt;
 288         int async;
 289         spinlock_t lock;
 290         unsigned reqs;
 291         ssize_t bytes;
 292         size_t size;
 293         __u64 offset;
 294         bool write;
 295         bool should_dirty;
 296         int err;
 297         struct kiocb *iocb;
 298         struct completion *done;
 299         bool blocking;
 300 };
 301
 302 #define FUSE_IO_PRIV_SYNC(i) \
 303 {                                       \
 304         .refcnt = KREF_INIT(1),         \
 305         .async = 0,                     \
 306         .iocb = i,                      \
 307 }
 308
 309 /**
 310  * Request flags
 311  *
 312  * FR_ISREPLY:          set if the request has reply
 313  * FR_FORCE:            force sending of the request even if interrupted
 314  * FR_BACKGROUND:       request is sent in the background
 315  * FR_WAITING:          request is counted as "waiting"
 316  * FR_ABORTED:          the request was aborted
 317  * FR_INTERRUPTED:      the request has been interrupted
 318  * FR_LOCKED:           data is being copied to/from the request
 319  * FR_PENDING:          request is not yet in userspace
 320  * FR_SENT:             request is in userspace, waiting for an answer
 321  * FR_FINISHED:         request is finished
 322  * FR_PRIVATE:          request is on private list
 323  * FR_ASYNC:            request is asynchronous
 324  */
 325 enum fuse_req_flag {
 326         FR_ISREPLY,
 327         FR_FORCE,
 328         FR_BACKGROUND,
 329         FR_WAITING,
 330         FR_ABORTED,
 331         FR_INTERRUPTED,
 332         FR_LOCKED,
 333         FR_PENDING,
 334         FR_SENT,
 335         FR_FINISHED,
 336         FR_PRIVATE,
 337         FR_ASYNC,
 338 };
 339
 340 /**
 341  * A request to the client
 342  *
 343  * .waitq.lock protects the following fields:
 344  *   - FR_ABORTED
 345  *   - FR_LOCKED (may also be modified under fc->lock, tested under both)
 346  */
 347 struct fuse_req {
 348         /** This can be on either pending processing or io lists in
 349             fuse_conn */
 350         struct list_head list;
 351
 352         /** Entry on the interrupts list  */
 353         struct list_head intr_entry;
 354
 355         /* Input/output arguments */
 356         struct fuse_args *args;
 357
 358         /** refcount */
 359         refcount_t count;
 360
 361         /* Request flags, updated with test/set/clear_bit() */
 362         unsigned long flags;
 363
 364         /* The request input header */
 365         struct {
 366                 struct fuse_in_header h;
 367         } in;
 368
 369         /* The request output header */
 370         struct {
 371                 struct fuse_out_header h;
 372         } out;
 373
 374         /** Used to wake up the task waiting for completion of request*/
 375         wait_queue_head_t waitq;
 376
 377 #if IS_ENABLED(CONFIG_VIRTIO_FS)
 378         /** virtio-fs's physically contiguous buffer for in and out args */
 379         void *argbuf;
 380 #endif
 381
 382         /** fuse_mount this request belongs to */
 383         struct fuse_mount *fm;
 384 };
 385
 386 struct fuse_iqueue;
 387
 388 /**
 389  * Input queue callbacks
 390  *
 391  * Input queue signalling is device-specific.  For example, the /dev/fuse file
 392  * uses fiq->waitq and fasync to wake processes that are waiting on queue
 393  * readiness.  These callbacks allow other device types to respond to input
 394  * queue activity.
 395  */
 396 struct fuse_iqueue_ops {
 397         /**
 398          * Signal that a forget has been queued
 399          */
 400         void (*wake_forget_and_unlock)(struct fuse_iqueue *fiq)
 401                 __releases(fiq->lock);
 402
 403         /**
 404          * Signal that an INTERRUPT request has been queued
 405          */
 406         void (*wake_interrupt_and_unlock)(struct fuse_iqueue *fiq)
 407                 __releases(fiq->lock);
 408
 409         /**
 410          * Signal that a request has been queued
 411          */
 412         void (*wake_pending_and_unlock)(struct fuse_iqueue *fiq)
 413                 __releases(fiq->lock);
 414
 415         /**
 416          * Clean up when fuse_iqueue is destroyed
 417          */
 418         void (*release)(struct fuse_iqueue *fiq);
 419 };
 420
 421 /** /dev/fuse input queue operations */
 422 extern const struct fuse_iqueue_ops fuse_dev_fiq_ops;
 423
 424 struct fuse_iqueue {
 425         /** Connection established */
 426         unsigned connected;
 427
 428         /** Lock protecting accesses to members of this structure */
 429         spinlock_t lock;
 430
 431         /** Readers of the connection are waiting on this */
 432         wait_queue_head_t waitq;
 433
 434         /** The next unique request id */
 435         u64 reqctr;
 436
 437         /** The list of pending requests */
 438         struct list_head pending;
 439
 440         /** Pending interrupts */
 441         struct list_head interrupts;
 442
 443         /** Queue of pending forgets */
 444         struct fuse_forget_link forget_list_head;
 445         struct fuse_forget_link *forget_list_tail;
 446
 447         /** Batching of FORGET requests (positive indicates FORGET batch) */
 448         int forget_batch;
 449
 450         /** O_ASYNC requests */
 451         struct fasync_struct *fasync;
 452
 453         /** Device-specific callbacks */
 454         const struct fuse_iqueue_ops *ops;
 455
 456         /** Device-specific state */
 457         void *priv;
 458 };
 459
 460 #define FUSE_PQ_HASH_BITS 8
 461 #define FUSE_PQ_HASH_SIZE (1 << FUSE_PQ_HASH_BITS)
 462
 463 struct fuse_pqueue {
 464         /** Connection established */
 465         unsigned connected;
 466
 467         /** Lock protecting accessess to  members of this structure */
 468         spinlock_t lock;
 469
 470         /** Hash table of requests being processed */
 471         struct list_head *processing;
 472
 473         /** The list of requests under I/O */
 474         struct list_head io;
 475 };
 476
 477 /**
 478  * Fuse device instance
 479  */
 480 struct fuse_dev {
 481         /** Fuse connection for this device */
 482         struct fuse_conn *fc;
 483
 484         /** Processing queue */
 485         struct fuse_pqueue pq;
 486
 487         /** list entry on fc->devices */
 488         struct list_head entry;
 489 };
 490
 491 struct fuse_fs_context {
 492         int fd;
 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         /** Maxmum 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          * The following bitfields are only for optimization purposes
 646          * and hence races in setting them will not cause malfunction
 647          */
 648
 649         /** Is open/release not implemented by fs? */
 650         unsigned no_open:1;
 651
 652         /** Is opendir/releasedir not implemented by fs? */
 653         unsigned no_opendir:1;
 654
 655         /** Is fsync not implemented by fs? */
 656         unsigned no_fsync:1;
 657
 658         /** Is fsyncdir not implemented by fs? */
 659         unsigned no_fsyncdir:1;
 660
 661         /** Is flush not implemented by fs? */
 662         unsigned no_flush:1;
 663
 664         /** Is setxattr not implemented by fs? */
 665         unsigned no_setxattr:1;
 666
 667         /** Is getxattr not implemented by fs? */
 668         unsigned no_getxattr:1;
 669
 670         /** Is listxattr not implemented by fs? */
 671         unsigned no_listxattr:1;
 672
 673         /** Is removexattr not implemented by fs? */
 674         unsigned no_removexattr:1;
 675
 676         /** Are posix file locking primitives not implemented by fs? */
 677         unsigned no_lock:1;
 678
 679         /** Is access not implemented by fs? */
 680         unsigned no_access:1;
 681
 682         /** Is create not implemented by fs? */
 683         unsigned no_create:1;
 684
 685         /** Is interrupt not implemented by fs? */
 686         unsigned no_interrupt:1;
 687
 688         /** Is bmap not implemented by fs? */
 689         unsigned no_bmap:1;
 690
 691         /** Is poll not implemented by fs? */
 692         unsigned no_poll:1;
 693
 694         /** Do multi-page cached writes */
 695         unsigned big_writes:1;
 696
 697         /** Don't apply umask to creation modes */
 698         unsigned dont_mask:1;
 699
 700         /** Are BSD file locking primitives not implemented by fs? */
 701         unsigned no_flock:1;
 702
 703         /** Is fallocate not implemented by fs? */
 704         unsigned no_fallocate:1;
 705
 706         /** Is rename with flags implemented by fs? */
 707         unsigned no_rename2:1;
 708
 709         /** Use enhanced/automatic page cache invalidation. */
 710         unsigned auto_inval_data:1;
 711
 712         /** Filesystem is fully reponsible for page cache invalidation. */
 713         unsigned explicit_inval_data:1;
 714
 715         /** Does the filesystem support readdirplus? */
 716         unsigned do_readdirplus:1;
 717
 718         /** Does the filesystem want adaptive readdirplus? */
 719         unsigned readdirplus_auto:1;
 720
 721         /** Does the filesystem support asynchronous direct-IO submission? */
 722         unsigned async_dio:1;
 723
 724         /** Is lseek not implemented by fs? */
 725         unsigned no_lseek:1;
 726
 727         /** Does the filesystem support posix acls? */
 728         unsigned posix_acl:1;
 729
 730         /** Check permissions based on the file mode or not? */
 731         unsigned default_permissions:1;
 732
 733         /** Allow other than the mounter user to access the filesystem ? */
 734         unsigned allow_other:1;
 735
 736         /** Does the filesystem support copy_file_range? */
 737         unsigned no_copy_file_range:1;
 738
 739         /* Send DESTROY request */
 740         unsigned int destroy:1;
 741
 742         /* Delete dentries that have gone stale */
 743         unsigned int delete_stale:1;
 744
 745         /** Do not create entry in fusectl fs */
 746         unsigned int no_control:1;
 747
 748         /** Do not allow MNT_FORCE umount */
 749         unsigned int no_force_umount:1;
 750
 751         /* Auto-mount submounts announced by the server */
 752         unsigned int auto_submounts:1;
 753
 754         /** The number of requests waiting for completion */
 755         atomic_t num_waiting;
 756
 757         /** Negotiated minor version */
 758         unsigned minor;
 759
 760         /** Entry on the fuse_mount_list */
 761         struct list_head entry;
 762
 763         /** Device ID from the root super block */
 764         dev_t dev;
 765
 766         /** Dentries in the control filesystem */
 767         struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
 768
 769         /** number of dentries used in the above array */
 770         int ctl_ndents;
 771
 772         /** Key for lock owner ID scrambling */
 773         u32 scramble_key[4];
 774
 775         /** Version counter for attribute changes */
 776         atomic64_t attr_version;
 777
 778         /** Called on final put */
 779         void (*release)(struct fuse_conn *);
 780
 781         /**
 782          * Read/write semaphore to hold when accessing the sb of any
 783          * fuse_mount belonging to this connection
 784          */
 785         struct rw_semaphore killsb;
 786
 787         /** List of device instances belonging to this connection */
 788         struct list_head devices;
 789
 790 #ifdef CONFIG_FUSE_DAX
 791         /* Dax specific conn data, non-NULL if DAX is enabled */
 792         struct fuse_conn_dax *dax;
 793 #endif
 794
 795         /** List of filesystems using this connection */
 796         struct list_head mounts;
 797 };
 798
 799 /*
 800  * Represents a mounted filesystem, potentially a submount.
 801  *
 802  * This object allows sharing a fuse_conn between separate mounts to
 803  * allow submounts with dedicated superblocks and thus separate device
 804  * IDs.
 805  */
 806 struct fuse_mount {
 807         /* Underlying (potentially shared) connection to the FUSE server */
 808         struct fuse_conn *fc;
 809
 810         /* Refcount */
 811         refcount_t count;
 812
 813         /*
 814          * Super block for this connection (fc->killsb must be held when
 815          * accessing this).
 816          */
 817         struct super_block *sb;
 818
 819         /* Entry on fc->mounts */
 820         struct list_head fc_entry;
 821 };
 822
 823 static inline struct fuse_mount *get_fuse_mount_super(struct super_block *sb)
 824 {
 825         return sb->s_fs_info;
 826 }
 827
 828 static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
 829 {
 830         struct fuse_mount *fm = get_fuse_mount_super(sb);
 831
 832         return fm ? fm->fc : NULL;
 833 }
 834
 835 static inline struct fuse_mount *get_fuse_mount(struct inode *inode)
 836 {
 837         return get_fuse_mount_super(inode->i_sb);
 838 }
 839
 840 static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
 841 {
 842         struct fuse_mount *fm = get_fuse_mount(inode);
 843
 844         return fm ? fm->fc : NULL;
 845 }
 846
 847 static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
 848 {
 849         return container_of(inode, struct fuse_inode, inode);
 850 }
 851
 852 static inline u64 get_node_id(struct inode *inode)
 853 {
 854         return get_fuse_inode(inode)->nodeid;
 855 }
 856
 857 static inline int invalid_nodeid(u64 nodeid)
 858 {
 859         return !nodeid || nodeid == FUSE_ROOT_ID;
 860 }
 861
 862 static inline u64 fuse_get_attr_version(struct fuse_conn *fc)
 863 {
 864         return atomic64_read(&fc->attr_version);
 865 }
 866
 867 static inline bool fuse_stale_inode(const struct inode *inode, int generation,
 868                                     struct fuse_attr *attr)
 869 {
 870         return inode->i_generation != generation ||
 871                 inode_wrong_type(inode, attr->mode);
 872 }
 873
 874 static inline void fuse_make_bad(struct inode *inode)
 875 {
 876         set_bit(FUSE_I_BAD, &get_fuse_inode(inode)->state);
 877 }
 878
 879 static inline bool fuse_is_bad(struct inode *inode)
 880 {
 881         return unlikely(test_bit(FUSE_I_BAD, &get_fuse_inode(inode)->state));
 882 }
 883
 884 /** Device operations */
 885 extern const struct file_operations fuse_dev_operations;
 886
 887 extern const struct dentry_operations fuse_dentry_operations;
 888 extern const struct dentry_operations fuse_root_dentry_operations;
 889
 890 /**
 891  * Get a filled in inode
 892  */
 893 struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
 894                         int generation, struct fuse_attr *attr,
 895                         u64 attr_valid, u64 attr_version);
 896
 897 int fuse_lookup_name(struct super_block *sb, u64 nodeid, const struct qstr *name,
 898                      struct fuse_entry_out *outarg, struct inode **inode);
 899
 900 /**
 901  * Send FORGET command
 902  */
 903 void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
 904                        u64 nodeid, u64 nlookup);
 905
 906 struct fuse_forget_link *fuse_alloc_forget(void);
 907
 908 struct fuse_forget_link *fuse_dequeue_forget(struct fuse_iqueue *fiq,
 909                                              unsigned int max,
 910                                              unsigned int *countp);
 911
 912 /*
 913  * Initialize READ or READDIR request
 914  */
 915 struct fuse_io_args {
 916         union {
 917                 struct {
 918                         struct fuse_read_in in;
 919                         u64 attr_ver;
 920                 } read;
 921                 struct {
 922                         struct fuse_write_in in;
 923                         struct fuse_write_out out;
 924                         bool page_locked;
 925                 } write;
 926         };
 927         struct fuse_args_pages ap;
 928         struct fuse_io_priv *io;
 929         struct fuse_file *ff;
 930 };
 931
 932 void fuse_read_args_fill(struct fuse_io_args *ia, struct file *file, loff_t pos,
 933                          size_t count, int opcode);
 934
 935
 936 /**
 937  * Send OPEN or OPENDIR request
 938  */
 939 int fuse_open_common(struct inode *inode, struct file *file, bool isdir);
 940
 941 struct fuse_file *fuse_file_alloc(struct fuse_mount *fm);
 942 void fuse_file_free(struct fuse_file *ff);
 943 void fuse_finish_open(struct inode *inode, struct file *file);
 944
 945 void fuse_sync_release(struct fuse_inode *fi, struct fuse_file *ff, int flags);
 946
 947 /**
 948  * Send RELEASE or RELEASEDIR request
 949  */
 950 void fuse_release_common(struct file *file, bool isdir);
 951
 952 /**
 953  * Send FSYNC or FSYNCDIR request
 954  */
 955 int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
 956                       int datasync, int opcode);
 957
 958 /**
 959  * Notify poll wakeup
 960  */
 961 int fuse_notify_poll_wakeup(struct fuse_conn *fc,
 962                             struct fuse_notify_poll_wakeup_out *outarg);
 963
 964 /**
 965  * Initialize file operations on a regular file
 966  */
 967 void fuse_init_file_inode(struct inode *inode);
 968
 969 /**
 970  * Initialize inode operations on regular files and special files
 971  */
 972 void fuse_init_common(struct inode *inode);
 973
 974 /**
 975  * Initialize inode and file operations on a directory
 976  */
 977 void fuse_init_dir(struct inode *inode);
 978
 979 /**
 980  * Initialize inode operations on a symlink
 981  */
 982 void fuse_init_symlink(struct inode *inode);
 983
 984 /**
 985  * Change attributes of an inode
 986  */
 987 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
 988                             u64 attr_valid, u64 attr_version);
 989
 990 void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
 991                                    u64 attr_valid);
 992
 993 /**
 994  * Initialize the client device
 995  */
 996 int fuse_dev_init(void);
 997
 998 /**
 999  * Cleanup the client device
1000  */
1001 void fuse_dev_cleanup(void);
1002
1003 int fuse_ctl_init(void);
1004 void __exit fuse_ctl_cleanup(void);
1005
1006 /**
1007  * Simple request sending that does request allocation and freeing
1008  */
1009 ssize_t fuse_simple_request(struct fuse_mount *fm, struct fuse_args *args);
1010 int fuse_simple_background(struct fuse_mount *fm, struct fuse_args *args,
1011                            gfp_t gfp_flags);
1012
1013 /**
1014  * End a finished request
1015  */
1016 void fuse_request_end(struct fuse_req *req);
1017
1018 /* Abort all requests */
1019 void fuse_abort_conn(struct fuse_conn *fc);
1020 void fuse_wait_aborted(struct fuse_conn *fc);
1021
1022 /**
1023  * Invalidate inode attributes
1024  */
1025 void fuse_invalidate_attr(struct inode *inode);
1026
1027 void fuse_invalidate_entry_cache(struct dentry *entry);
1028
1029 void fuse_invalidate_atime(struct inode *inode);
1030
1031 u64 entry_attr_timeout(struct fuse_entry_out *o);
1032 void fuse_change_entry_timeout(struct dentry *entry, struct fuse_entry_out *o);
1033
1034 /**
1035  * Acquire reference to fuse_conn
1036  */
1037 struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
1038
1039 /**
1040  * Initialize fuse_conn
1041  */
1042 void fuse_conn_init(struct fuse_conn *fc, struct fuse_mount *fm,
1043                     struct user_namespace *user_ns,
1044                     const struct fuse_iqueue_ops *fiq_ops, void *fiq_priv);
1045
1046 /**
1047  * Release reference to fuse_conn
1048  */
1049 void fuse_conn_put(struct fuse_conn *fc);
1050
1051 /**
1052  * Acquire reference to fuse_mount
1053  */
1054 struct fuse_mount *fuse_mount_get(struct fuse_mount *fm);
1055
1056 /**
1057  * Release reference to fuse_mount
1058  */
1059 void fuse_mount_put(struct fuse_mount *fm);
1060
1061 struct fuse_dev *fuse_dev_alloc_install(struct fuse_conn *fc);
1062 struct fuse_dev *fuse_dev_alloc(void);
1063 void fuse_dev_install(struct fuse_dev *fud, struct fuse_conn *fc);
1064 void fuse_dev_free(struct fuse_dev *fud);
1065 void fuse_send_init(struct fuse_mount *fm);
1066
1067 /**
1068  * Fill in superblock and initialize fuse connection
1069  * @sb: partially-initialized superblock to fill in
1070  * @ctx: mount context
1071  */
1072 int fuse_fill_super_common(struct super_block *sb, struct fuse_fs_context *ctx);
1073
1074 /*
1075  * Fill in superblock for submounts
1076  * @sb: partially-initialized superblock to fill in
1077  * @parent_fi: The fuse_inode of the parent filesystem where this submount is
1078  *             mounted
1079  */
1080 int fuse_fill_super_submount(struct super_block *sb,
1081                              struct fuse_inode *parent_fi);
1082
1083 /*
1084  * Remove the mount from the connection
1085  *
1086  * Returns whether this was the last mount
1087  */
1088 bool fuse_mount_remove(struct fuse_mount *fm);
1089
1090 /*
1091  * Shut down the connection (possibly sending DESTROY request).
1092  */
1093 void fuse_conn_destroy(struct fuse_mount *fm);
1094
1095 /**
1096  * Add connection to control filesystem
1097  */
1098 int fuse_ctl_add_conn(struct fuse_conn *fc);
1099
1100 /**
1101  * Remove connection from control filesystem
1102  */
1103 void fuse_ctl_remove_conn(struct fuse_conn *fc);
1104
1105 /**
1106  * Is file type valid?
1107  */
1108 int fuse_valid_type(int m);
1109
1110 bool fuse_invalid_attr(struct fuse_attr *attr);
1111
1112 /**
1113  * Is current process allowed to perform filesystem operation?
1114  */
1115 int fuse_allow_current_process(struct fuse_conn *fc);
1116
1117 u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
1118
1119 void fuse_flush_time_update(struct inode *inode);
1120 void fuse_update_ctime(struct inode *inode);
1121
1122 int fuse_update_attributes(struct inode *inode, struct file *file);
1123
1124 void fuse_flush_writepages(struct inode *inode);
1125
1126 void fuse_set_nowrite(struct inode *inode);
1127 void fuse_release_nowrite(struct inode *inode);
1128
1129 /**
1130  * Scan all fuse_mounts belonging to fc to find the first where
1131  * ilookup5() returns a result.  Return that result and the
1132  * respective fuse_mount in *fm (unless fm is NULL).
1133  *
1134  * The caller must hold fc->killsb.
1135  */
1136 struct inode *fuse_ilookup(struct fuse_conn *fc, u64 nodeid,
1137                            struct fuse_mount **fm);
1138
1139 /**
1140  * File-system tells the kernel to invalidate cache for the given node id.
1141  */
1142 int fuse_reverse_inval_inode(struct fuse_conn *fc, u64 nodeid,
1143                              loff_t offset, loff_t len);
1144
1145 /**
1146  * File-system tells the kernel to invalidate parent attributes and
1147  * the dentry matching parent/name.
1148  *
1149  * If the child_nodeid is non-zero and:
1150  *    - matches the inode number for the dentry matching parent/name,
1151  *    - is not a mount point
1152  *    - is a file or oan empty directory
1153  * then the dentry is unhashed (d_delete()).
1154  */
1155 int fuse_reverse_inval_entry(struct fuse_conn *fc, u64 parent_nodeid,
1156                              u64 child_nodeid, struct qstr *name);
1157
1158 int fuse_do_open(struct fuse_mount *fm, u64 nodeid, struct file *file,
1159                  bool isdir);
1160
1161 /**
1162  * fuse_direct_io() flags
1163  */
1164
1165 /** If set, it is WRITE; otherwise - READ */
1166 #define FUSE_DIO_WRITE (1 << 0)
1167
1168 /** CUSE pass fuse_direct_io() a file which f_mapping->host is not from FUSE */
1169 #define FUSE_DIO_CUSE  (1 << 1)
1170
1171 ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
1172                        loff_t *ppos, int flags);
1173 long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
1174                    unsigned int flags);
1175 long fuse_ioctl_common(struct file *file, unsigned int cmd,
1176                        unsigned long arg, unsigned int flags);
1177 __poll_t fuse_file_poll(struct file *file, poll_table *wait);
1178 int fuse_dev_release(struct inode *inode, struct file *file);
1179
1180 bool fuse_write_update_size(struct inode *inode, loff_t pos);
1181
1182 int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
1183 int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
1184
1185 int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
1186                     struct file *file);
1187
1188 void fuse_set_initialized(struct fuse_conn *fc);
1189
1190 void fuse_unlock_inode(struct inode *inode, bool locked);
1191 bool fuse_lock_inode(struct inode *inode);
1192
1193 int fuse_setxattr(struct inode *inode, const char *name, const void *value,
1194                   size_t size, int flags);
1195 ssize_t fuse_getxattr(struct inode *inode, const char *name, void *value,
1196                       size_t size);
1197 ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
1198 int fuse_removexattr(struct inode *inode, const char *name);
1199 extern const struct xattr_handler *fuse_xattr_handlers[];
1200 extern const struct xattr_handler *fuse_acl_xattr_handlers[];
1201 extern const struct xattr_handler *fuse_no_acl_xattr_handlers[];
1202
1203 struct posix_acl;
1204 struct posix_acl *fuse_get_acl(struct inode *inode, int type);
1205 int fuse_set_acl(struct inode *inode, struct posix_acl *acl, int type);
1206
1207
1208 /* readdir.c */
1209 int fuse_readdir(struct file *file, struct dir_context *ctx);
1210
1211 /**
1212  * Return the number of bytes in an arguments list
1213  */
1214 unsigned int fuse_len_args(unsigned int numargs, struct fuse_arg *args);
1215
1216 /**
1217  * Get the next unique ID for a request
1218  */
1219 u64 fuse_get_unique(struct fuse_iqueue *fiq);
1220 void fuse_free_conn(struct fuse_conn *fc);
1221
1222 /* dax.c */
1223
1224 #define FUSE_IS_DAX(inode) (IS_ENABLED(CONFIG_FUSE_DAX) && IS_DAX(inode))
1225
1226 ssize_t fuse_dax_read_iter(struct kiocb *iocb, struct iov_iter *to);
1227 ssize_t fuse_dax_write_iter(struct kiocb *iocb, struct iov_iter *from);
1228 int fuse_dax_mmap(struct file *file, struct vm_area_struct *vma);
1229 int fuse_dax_break_layouts(struct inode *inode, u64 dmap_start, u64 dmap_end);
1230 int fuse_dax_conn_alloc(struct fuse_conn *fc, struct dax_device *dax_dev);
1231 void fuse_dax_conn_free(struct fuse_conn *fc);
1232 bool fuse_dax_inode_alloc(struct super_block *sb, struct fuse_inode *fi);
1233 void fuse_dax_inode_init(struct inode *inode);
1234 void fuse_dax_inode_cleanup(struct inode *inode);
1235 bool fuse_dax_check_alignment(struct fuse_conn *fc, unsigned int map_alignment);
1236 void fuse_dax_cancel_work(struct fuse_conn *fc);
1237
1238 #endif /* _FS_FUSE_I_H */