fs/fuse/fuse_i.h

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