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