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 #include <linux/fuse.h>
  13 #include <linux/fs.h>
  14 #include <linux/mount.h>
  15 #include <linux/wait.h>
  16 #include <linux/list.h>
  17 #include <linux/spinlock.h>
  18 #include <linux/mm.h>
  19 #include <linux/backing-dev.h>
  20 #include <linux/mutex.h>
  21 #include <linux/rwsem.h>
  22 #include <linux/rbtree.h>
  23 #include <linux/poll.h>
  24 #include <linux/workqueue.h>
  25 #include <linux/kref.h>
  26 #include <linux/xattr.h>
  27
  28 /** Max number of pages that can be used in a single read request */
  29 #define FUSE_MAX_PAGES_PER_REQ 32
  30
  31 /** Bias for fi->writectr, meaning new writepages must not be sent */
  32 #define FUSE_NOWRITE INT_MIN
  33
  34 /** It could be as large as PATH_MAX, but would that have any uses? */
  35 #define FUSE_NAME_MAX 1024
  36
  37 /** Number of dentries for each connection in the control filesystem */
  38 #define FUSE_CTL_NUM_DENTRIES 5
  39
  40 /** Number of page pointers embedded in fuse_req */
  41 #define FUSE_REQ_INLINE_PAGES 1
  42
  43 /** List of active connections */
  44 extern struct list_head fuse_conn_list;
  45
  46 /** Global mutex protecting fuse_conn_list and the control filesystem */
  47 extern struct mutex fuse_mutex;
  48
  49 /** Module parameters */
  50 extern unsigned max_user_bgreq;
  51 extern unsigned max_user_congthresh;
  52
  53 /* One forget request */
  54 struct fuse_forget_link {
  55         struct fuse_forget_one forget_one;
  56         struct fuse_forget_link *next;
  57 };
  58
  59 /** FUSE inode */
  60 struct fuse_inode {
  61         /** Inode data */
  62         struct inode inode;
  63
  64         /** Unique ID, which identifies the inode between userspace
  65          * and kernel */
  66         u64 nodeid;
  67
  68         /** Number of lookups on this inode */
  69         u64 nlookup;
  70
  71         /** The request used for sending the FORGET message */
  72         struct fuse_forget_link *forget;
  73
  74         /** Time in jiffies until the file attributes are valid */
  75         u64 i_time;
  76
  77         /** The sticky bit in inode->i_mode may have been removed, so
  78             preserve the original mode */
  79         umode_t orig_i_mode;
  80
  81         /** 64 bit inode number */
  82         u64 orig_ino;
  83
  84         /** Version of last attribute change */
  85         u64 attr_version;
  86
  87         /** Files usable in writepage.  Protected by fc->lock */
  88         struct list_head write_files;
  89
  90         /** Writepages pending on truncate or fsync */
  91         struct list_head queued_writes;
  92
  93         /** Number of sent writes, a negative bias (FUSE_NOWRITE)
  94          * means more writes are blocked */
  95         int writectr;
  96
  97         /** Waitq for writepage completion */
  98         wait_queue_head_t page_waitq;
  99
 100         /** List of writepage requestst (pending or sent) */
 101         struct list_head writepages;
 102
 103         /** Miscellaneous bits describing inode state */
 104         unsigned long state;
 105
 106         /** Lock for serializing lookup and readdir for back compatibility*/
 107         struct mutex mutex;
 108 };
 109
 110 /** FUSE inode state bits */
 111 enum {
 112         /** Advise readdirplus  */
 113         FUSE_I_ADVISE_RDPLUS,
 114         /** Initialized with readdirplus */
 115         FUSE_I_INIT_RDPLUS,
 116         /** An operation changing file size is in progress  */
 117         FUSE_I_SIZE_UNSTABLE,
 118         /* Bad inode */
 119         FUSE_I_BAD,
 120 };
 121
 122 struct fuse_conn;
 123
 124 /** FUSE specific file data */
 125 struct fuse_file {
 126         /** Fuse connection for this file */
 127         struct fuse_conn *fc;
 128
 129         /** Request reserved for flush and release */
 130         struct fuse_req *reserved_req;
 131
 132         /** Kernel file handle guaranteed to be unique */
 133         u64 kh;
 134
 135         /** File handle used by userspace */
 136         u64 fh;
 137
 138         /** Node id of this file */
 139         u64 nodeid;
 140
 141         /** Refcount */
 142         atomic_t count;
 143
 144         /** FOPEN_* flags returned by open */
 145         u32 open_flags;
 146
 147         /** Entry on inode's write_files list */
 148         struct list_head write_entry;
 149
 150         /** RB node to be linked on fuse_conn->polled_files */
 151         struct rb_node polled_node;
 152
 153         /** Wait queue head for poll */
 154         wait_queue_head_t poll_wait;
 155
 156         /** Has flock been performed on this file? */
 157         bool flock:1;
 158 };
 159
 160 /** One input argument of a request */
 161 struct fuse_in_arg {
 162         unsigned size;
 163         const void *value;
 164 };
 165
 166 /** The request input */
 167 struct fuse_in {
 168         /** The request header */
 169         struct fuse_in_header h;
 170
 171         /** True if the data for the last argument is in req->pages */
 172         unsigned argpages:1;
 173
 174         /** Number of arguments */
 175         unsigned numargs;
 176
 177         /** Array of arguments */
 178         struct fuse_in_arg args[3];
 179 };
 180
 181 /** One output argument of a request */
 182 struct fuse_arg {
 183         unsigned size;
 184         void *value;
 185 };
 186
 187 /** The request output */
 188 struct fuse_out {
 189         /** Header returned from userspace */
 190         struct fuse_out_header h;
 191
 192         /*
 193          * The following bitfields are not changed during the request
 194          * processing
 195          */
 196
 197         /** Last argument is variable length (can be shorter than
 198             arg->size) */
 199         unsigned argvar:1;
 200
 201         /** Last argument is a list of pages to copy data to */
 202         unsigned argpages:1;
 203
 204         /** Zero partially or not copied pages */
 205         unsigned page_zeroing:1;
 206
 207         /** Pages may be replaced with new ones */
 208         unsigned page_replace:1;
 209
 210         /** Number or arguments */
 211         unsigned numargs;
 212
 213         /** Array of arguments */
 214         struct fuse_arg args[2];
 215 };
 216
 217 /** FUSE page descriptor */
 218 struct fuse_page_desc {
 219         unsigned int length;
 220         unsigned int offset;
 221 };
 222
 223 struct fuse_args {
 224         struct {
 225                 struct {
 226                         uint32_t opcode;
 227                         uint64_t nodeid;
 228                 } h;
 229                 unsigned numargs;
 230                 struct fuse_in_arg args[3];
 231
 232         } in;
 233         struct {
 234                 unsigned argvar:1;
 235                 unsigned numargs;
 236                 struct fuse_arg args[2];
 237         } out;
 238 };
 239
 240 #define FUSE_ARGS(args) struct fuse_args args = {}
 241
 242 /** The request IO state (for asynchronous processing) */
 243 struct fuse_io_priv {
 244         struct kref refcnt;
 245         int async;
 246         spinlock_t lock;
 247         unsigned reqs;
 248         ssize_t bytes;
 249         size_t size;
 250         __u64 offset;
 251         bool write;
 252         int err;
 253         struct kiocb *iocb;
 254         struct file *file;
 255         struct completion *done;
 256         bool blocking;
 257 };
 258
 259 #define FUSE_IO_PRIV_SYNC(f) \
 260 {                                       \
 261         .refcnt = { ATOMIC_INIT(1) },   \
 262         .async = 0,                     \
 263         .file = f,                      \
 264 }
 265
 266 /**
 267  * Request flags
 268  *
 269  * FR_ISREPLY:          set if the request has reply
 270  * FR_FORCE:            force sending of the request even if interrupted
 271  * FR_BACKGROUND:       request is sent in the background
 272  * FR_WAITING:          request is counted as "waiting"
 273  * FR_ABORTED:          the request was aborted
 274  * FR_INTERRUPTED:      the request has been interrupted
 275  * FR_LOCKED:           data is being copied to/from the request
 276  * FR_PENDING:          request is not yet in userspace
 277  * FR_SENT:             request is in userspace, waiting for an answer
 278  * FR_FINISHED:         request is finished
 279  * FR_PRIVATE:          request is on private list
 280  */
 281 enum fuse_req_flag {
 282         FR_ISREPLY,
 283         FR_FORCE,
 284         FR_BACKGROUND,
 285         FR_WAITING,
 286         FR_ABORTED,
 287         FR_INTERRUPTED,
 288         FR_LOCKED,
 289         FR_PENDING,
 290         FR_SENT,
 291         FR_FINISHED,
 292         FR_PRIVATE,
 293 };
 294
 295 /**
 296  * A request to the client
 297  *
 298  * .waitq.lock protects the following fields:
 299  *   - FR_ABORTED
 300  *   - FR_LOCKED (may also be modified under fc->lock, tested under both)
 301  */
 302 struct fuse_req {
 303         /** This can be on either pending processing or io lists in
 304             fuse_conn */
 305         struct list_head list;
 306
 307         /** Entry on the interrupts list  */
 308         struct list_head intr_entry;
 309
 310         /** refcount */
 311         atomic_t count;
 312
 313         bool user_pages;
 314
 315         /** Unique ID for the interrupt request */
 316         u64 intr_unique;
 317
 318         /* Request flags, updated with test/set/clear_bit() */
 319         unsigned long flags;
 320
 321         /** The request input */
 322         struct fuse_in in;
 323
 324         /** The request output */
 325         struct fuse_out out;
 326
 327         /** Used to wake up the task waiting for completion of request*/
 328         wait_queue_head_t waitq;
 329
 330         /** Data for asynchronous requests */
 331         union {
 332                 struct {
 333                         struct fuse_release_in in;
 334                         struct inode *inode;
 335                 } release;
 336                 struct fuse_init_in init_in;
 337                 struct fuse_init_out init_out;
 338                 struct cuse_init_in cuse_init_in;
 339                 struct {
 340                         struct fuse_read_in in;
 341                         u64 attr_ver;
 342                 } read;
 343                 struct {
 344                         struct fuse_write_in in;
 345                         struct fuse_write_out out;
 346                         struct fuse_req *next;
 347                 } write;
 348                 struct fuse_notify_retrieve_in retrieve_in;
 349         } misc;
 350
 351         /** page vector */
 352         struct page **pages;
 353
 354         /** page-descriptor vector */
 355         struct fuse_page_desc *page_descs;
 356
 357         /** size of the 'pages' array */
 358         unsigned max_pages;
 359
 360         /** inline page vector */
 361         struct page *inline_pages[FUSE_REQ_INLINE_PAGES];
 362
 363         /** inline page-descriptor vector */
 364         struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];
 365
 366         /** number of pages in vector */
 367         unsigned num_pages;
 368
 369         /** File used in the request (or NULL) */
 370         struct fuse_file *ff;
 371
 372         /** Inode used in the request or NULL */
 373         struct inode *inode;
 374
 375         /** AIO control block */
 376         struct fuse_io_priv *io;
 377
 378         /** Link on fi->writepages */
 379         struct list_head writepages_entry;
 380
 381         /** Request completion callback */
 382         void (*end)(struct fuse_conn *, struct fuse_req *);
 383
 384         /** Request is stolen from fuse_file->reserved_req */
 385         struct file *stolen_file;
 386 };
 387
 388 struct fuse_iqueue {
 389         /** Connection established */
 390         unsigned connected;
 391
 392         /** Readers of the connection are waiting on this */
 393         wait_queue_head_t waitq;
 394
 395         /** The next unique request id */
 396         u64 reqctr;
 397
 398         /** The list of pending requests */
 399         struct list_head pending;
 400
 401         /** Pending interrupts */
 402         struct list_head interrupts;
 403
 404         /** Queue of pending forgets */
 405         struct fuse_forget_link forget_list_head;
 406         struct fuse_forget_link *forget_list_tail;
 407
 408         /** Batching of FORGET requests (positive indicates FORGET batch) */
 409         int forget_batch;
 410
 411         /** O_ASYNC requests */
 412         struct fasync_struct *fasync;
 413 };
 414
 415 struct fuse_pqueue {
 416         /** Connection established */
 417         unsigned connected;
 418
 419         /** Lock protecting accessess to  members of this structure */
 420         spinlock_t lock;
 421
 422         /** The list of requests being processed */
 423         struct list_head processing;
 424
 425         /** The list of requests under I/O */
 426         struct list_head io;
 427 };
 428
 429 /**
 430  * Fuse device instance
 431  */
 432 struct fuse_dev {
 433         /** Fuse connection for this device */
 434         struct fuse_conn *fc;
 435
 436         /** Processing queue */
 437         struct fuse_pqueue pq;
 438
 439         /** list entry on fc->devices */
 440         struct list_head entry;
 441 };
 442
 443 /**
 444  * A Fuse connection.
 445  *
 446  * This structure is created, when the filesystem is mounted, and is
 447  * destroyed, when the client device is closed and the filesystem is
 448  * unmounted.
 449  */
 450 struct fuse_conn {
 451         /** Lock protecting accessess to  members of this structure */
 452         spinlock_t lock;
 453
 454         /** Refcount */
 455         atomic_t count;
 456
 457         /** Number of fuse_dev's */
 458         atomic_t dev_count;
 459
 460         struct rcu_head rcu;
 461
 462         /** The user id for this mount */
 463         kuid_t user_id;
 464
 465         /** The group id for this mount */
 466         kgid_t group_id;
 467
 468         /** Maximum read size */
 469         unsigned max_read;
 470
 471         /** Maximum write size */
 472         unsigned max_write;
 473
 474         /** Input queue */
 475         struct fuse_iqueue iq;
 476
 477         /** The next unique kernel file handle */
 478         u64 khctr;
 479
 480         /** rbtree of fuse_files waiting for poll events indexed by ph */
 481         struct rb_root polled_files;
 482
 483         /** Maximum number of outstanding background requests */
 484         unsigned max_background;
 485
 486         /** Number of background requests at which congestion starts */
 487         unsigned congestion_threshold;
 488
 489         /** Number of requests currently in the background */
 490         unsigned num_background;
 491
 492         /** Number of background requests currently queued for userspace */
 493         unsigned active_background;
 494
 495         /** The list of background requests set aside for later queuing */
 496         struct list_head bg_queue;
 497
 498         /** Flag indicating that INIT reply has been received. Allocating
 499          * any fuse request will be suspended until the flag is set */
 500         int initialized;
 501
 502         /** Flag indicating if connection is blocked.  This will be
 503             the case before the INIT reply is received, and if there
 504             are too many outstading backgrounds requests */
 505         int blocked;
 506
 507         /** waitq for blocked connection */
 508         wait_queue_head_t blocked_waitq;
 509
 510         /** waitq for reserved requests */
 511         wait_queue_head_t reserved_req_waitq;
 512
 513         /** Connection established, cleared on umount, connection
 514             abort and device release */
 515         unsigned connected;
 516
 517         /** Connection failed (version mismatch).  Cannot race with
 518             setting other bitfields since it is only set once in INIT
 519             reply, before any other request, and never cleared */
 520         unsigned conn_error:1;
 521
 522         /** Connection successful.  Only set in INIT */
 523         unsigned conn_init:1;
 524
 525         /** Do readpages asynchronously?  Only set in INIT */
 526         unsigned async_read:1;
 527
 528         /** Do not send separate SETATTR request before open(O_TRUNC)  */
 529         unsigned atomic_o_trunc:1;
 530
 531         /** Filesystem supports NFS exporting.  Only set in INIT */
 532         unsigned export_support:1;
 533
 534         /** Set if bdi is valid */
 535         unsigned bdi_initialized:1;
 536
 537         /** write-back cache policy (default is write-through) */
 538         unsigned writeback_cache:1;
 539
 540         /** allow parallel lookups and readdir (default is serialized) */
 541         unsigned parallel_dirops:1;
 542
 543         /** handle fs handles killing suid/sgid/cap on write/chown/trunc */
 544         unsigned handle_killpriv:1;
 545
 546         /*
 547          * The following bitfields are only for optimization purposes
 548          * and hence races in setting them will not cause malfunction
 549          */
 550
 551         /** Is open/release not implemented by fs? */
 552         unsigned no_open:1;
 553
 554         /** Is fsync not implemented by fs? */
 555         unsigned no_fsync:1;
 556
 557         /** Is fsyncdir not implemented by fs? */
 558         unsigned no_fsyncdir:1;
 559
 560         /** Is flush not implemented by fs? */
 561         unsigned no_flush:1;
 562
 563         /** Is setxattr not implemented by fs? */
 564         unsigned no_setxattr:1;
 565
 566         /** Is getxattr not implemented by fs? */
 567         unsigned no_getxattr:1;
 568
 569         /** Is listxattr not implemented by fs? */
 570         unsigned no_listxattr:1;
 571
 572         /** Is removexattr not implemented by fs? */
 573         unsigned no_removexattr:1;
 574
 575         /** Are posix file locking primitives not implemented by fs? */
 576         unsigned no_lock:1;
 577
 578         /** Is access not implemented by fs? */
 579         unsigned no_access:1;
 580
 581         /** Is create not implemented by fs? */
 582         unsigned no_create:1;
 583
 584         /** Is interrupt not implemented by fs? */
 585         unsigned no_interrupt:1;
 586
 587         /** Is bmap not implemented by fs? */
 588         unsigned no_bmap:1;
 589
 590         /** Is poll not implemented by fs? */
 591         unsigned no_poll:1;
 592
 593         /** Do multi-page cached writes */
 594         unsigned big_writes:1;
 595
 596         /** Don't apply umask to creation modes */
 597         unsigned dont_mask:1;
 598
 599         /** Are BSD file locking primitives not implemented by fs? */
 600         unsigned no_flock:1;
 601
 602         /** Is fallocate not implemented by fs? */
 603         unsigned no_fallocate:1;
 604
 605         /** Is rename with flags implemented by fs? */
 606         unsigned no_rename2:1;
 607
 608         /** Use enhanced/automatic page cache invalidation. */
 609         unsigned auto_inval_data:1;
 610
 611         /** Does the filesystem support readdirplus? */
 612         unsigned do_readdirplus:1;
 613
 614         /** Does the filesystem want adaptive readdirplus? */
 615         unsigned readdirplus_auto:1;
 616
 617         /** Does the filesystem support asynchronous direct-IO submission? */
 618         unsigned async_dio:1;
 619
 620         /** Is lseek not implemented by fs? */
 621         unsigned no_lseek:1;
 622
 623         /** Does the filesystem support posix acls? */
 624         unsigned posix_acl:1;
 625
 626         /** Check permissions based on the file mode or not? */
 627         unsigned default_permissions:1;
 628
 629         /** Allow other than the mounter user to access the filesystem ? */
 630         unsigned allow_other:1;
 631
 632         /** The number of requests waiting for completion */
 633         atomic_t num_waiting;
 634
 635         /** Negotiated minor version */
 636         unsigned minor;
 637
 638         /** Backing dev info */
 639         struct backing_dev_info bdi;
 640
 641         /** Entry on the fuse_conn_list */
 642         struct list_head entry;
 643
 644         /** Device ID from super block */
 645         dev_t dev;
 646
 647         /** Dentries in the control filesystem */
 648         struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
 649
 650         /** number of dentries used in the above array */
 651         int ctl_ndents;
 652
 653         /** Key for lock owner ID scrambling */
 654         u32 scramble_key[4];
 655
 656         /** Reserved request for the DESTROY message */
 657         struct fuse_req *destroy_req;
 658
 659         /** Version counter for attribute changes */
 660         u64 attr_version;
 661
 662         /** Called on final put */
 663         void (*release)(struct fuse_conn *);
 664
 665         /** Super block for this connection. */
 666         struct super_block *sb;
 667
 668         /** Read/write semaphore to hold when accessing sb. */
 669         struct rw_semaphore killsb;
 670
 671         /** List of device instances belonging to this connection */
 672         struct list_head devices;
 673 };
 674
 675 static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
 676 {
 677         return sb->s_fs_info;
 678 }
 679
 680 static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
 681 {
 682         return get_fuse_conn_super(inode->i_sb);
 683 }
 684
 685 static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
 686 {
 687         return container_of(inode, struct fuse_inode, inode);
 688 }
 689
 690 static inline u64 get_node_id(struct inode *inode)
 691 {
 692         return get_fuse_inode(inode)->nodeid;
 693 }
 694
 695 static inline void fuse_make_bad(struct inode *inode)
 696 {
 697         remove_inode_hash(inode);
 698         set_bit(FUSE_I_BAD, &get_fuse_inode(inode)->state);
 699 }
 700
 701 static inline bool fuse_is_bad(struct inode *inode)
 702 {
 703         return unlikely(test_bit(FUSE_I_BAD, &get_fuse_inode(inode)->state));
 704 }
 705
 706 /** Device operations */
 707 extern const struct file_operations fuse_dev_operations;
 708
 709 extern const struct dentry_operations fuse_dentry_operations;
 710 extern const struct dentry_operations fuse_root_dentry_operations;
 711
 712 /**
 713  * Inode to nodeid comparison.
 714  */
 715 int fuse_inode_eq(struct inode *inode, void *_nodeidp);
 716
 717 /**
 718  * Get a filled in inode
 719  */
 720 struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
 721                         int generation, struct fuse_attr *attr,
 722                         u64 attr_valid, u64 attr_version);
 723
 724 int fuse_lookup_name(struct super_block *sb, u64 nodeid, const struct qstr *name,
 725                      struct fuse_entry_out *outarg, struct inode **inode);
 726
 727 /**
 728  * Send FORGET command
 729  */
 730 void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
 731                        u64 nodeid, u64 nlookup);
 732
 733 struct fuse_forget_link *fuse_alloc_forget(void);
 734
 735 /* Used by READDIRPLUS */
 736 void fuse_force_forget(struct file *file, u64 nodeid);
 737
 738 /**
 739  * Initialize READ or READDIR request
 740  */
 741 void fuse_read_fill(struct fuse_req *req, struct file *file,
 742                     loff_t pos, size_t count, int opcode);
 743
 744 /**
 745  * Send OPEN or OPENDIR request
 746  */
 747 int fuse_open_common(struct inode *inode, struct file *file, bool isdir);
 748
 749 struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
 750 struct fuse_file *fuse_file_get(struct fuse_file *ff);
 751 void fuse_file_free(struct fuse_file *ff);
 752 void fuse_finish_open(struct inode *inode, struct file *file);
 753
 754 void fuse_sync_release(struct fuse_file *ff, int flags);
 755
 756 /**
 757  * Send RELEASE or RELEASEDIR request
 758  */
 759 void fuse_release_common(struct file *file, int opcode);
 760
 761 /**
 762  * Send FSYNC or FSYNCDIR request
 763  */
 764 int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
 765                       int datasync, int isdir);
 766
 767 /**
 768  * Notify poll wakeup
 769  */
 770 int fuse_notify_poll_wakeup(struct fuse_conn *fc,
 771                             struct fuse_notify_poll_wakeup_out *outarg);
 772
 773 /**
 774  * Initialize file operations on a regular file
 775  */
 776 void fuse_init_file_inode(struct inode *inode);
 777
 778 /**
 779  * Initialize inode operations on regular files and special files
 780  */
 781 void fuse_init_common(struct inode *inode);
 782
 783 /**
 784  * Initialize inode and file operations on a directory
 785  */
 786 void fuse_init_dir(struct inode *inode);
 787
 788 /**
 789  * Initialize inode operations on a symlink
 790  */
 791 void fuse_init_symlink(struct inode *inode);
 792
 793 /**
 794  * Change attributes of an inode
 795  */
 796 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
 797                             u64 attr_valid, u64 attr_version);
 798
 799 void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
 800                                    u64 attr_valid);
 801
 802 /**
 803  * Initialize the client device
 804  */
 805 int fuse_dev_init(void);
 806
 807 /**
 808  * Cleanup the client device
 809  */
 810 void fuse_dev_cleanup(void);
 811
 812 int fuse_ctl_init(void);
 813 void __exit fuse_ctl_cleanup(void);
 814
 815 /**
 816  * Allocate a request
 817  */
 818 struct fuse_req *fuse_request_alloc(unsigned npages);
 819
 820 struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
 821
 822 /**
 823  * Free a request
 824  */
 825 void fuse_request_free(struct fuse_req *req);
 826
 827 /**
 828  * Get a request, may fail with -ENOMEM,
 829  * caller should specify # elements in req->pages[] explicitly
 830  */
 831 struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
 832 struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
 833                                              unsigned npages);
 834
 835 /*
 836  * Increment reference count on request
 837  */
 838 void __fuse_get_request(struct fuse_req *req);
 839
 840 /**
 841  * Gets a requests for a file operation, always succeeds
 842  */
 843 struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
 844                                              struct file *file);
 845
 846 /**
 847  * Decrement reference count of a request.  If count goes to zero free
 848  * the request.
 849  */
 850 void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
 851
 852 /**
 853  * Send a request (synchronous)
 854  */
 855 void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
 856
 857 /**
 858  * Simple request sending that does request allocation and freeing
 859  */
 860 ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);
 861
 862 /**
 863  * Send a request in the background
 864  */
 865 void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
 866
 867 void fuse_request_send_background_locked(struct fuse_conn *fc,
 868                                          struct fuse_req *req);
 869
 870 /* Abort all requests */
 871 void fuse_abort_conn(struct fuse_conn *fc);
 872 void fuse_wait_aborted(struct fuse_conn *fc);
 873
 874 /**
 875  * Invalidate inode attributes
 876  */
 877 void fuse_invalidate_attr(struct inode *inode);
 878
 879 void fuse_invalidate_entry_cache(struct dentry *entry);
 880
 881 void fuse_invalidate_atime(struct inode *inode);
 882
 883 /**
 884  * Acquire reference to fuse_conn
 885  */
 886 struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
 887
 888 /**
 889  * Initialize fuse_conn
 890  */
 891 void fuse_conn_init(struct fuse_conn *fc);
 892
 893 /**
 894  * Release reference to fuse_conn
 895  */
 896 void fuse_conn_put(struct fuse_conn *fc);
 897
 898 struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
 899 void fuse_dev_free(struct fuse_dev *fud);
 900
 901 /**
 902  * Add connection to control filesystem
 903  */
 904 int fuse_ctl_add_conn(struct fuse_conn *fc);
 905
 906 /**
 907  * Remove connection from control filesystem
 908  */
 909 void fuse_ctl_remove_conn(struct fuse_conn *fc);
 910
 911 /**
 912  * Is file type valid?
 913  */
 914 int fuse_valid_type(int m);
 915
 916 bool fuse_invalid_attr(struct fuse_attr *attr);
 917
 918 /**
 919  * Is current process allowed to perform filesystem operation?
 920  */
 921 int fuse_allow_current_process(struct fuse_conn *fc);
 922
 923 u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
 924
 925 void fuse_update_ctime(struct inode *inode);
 926
 927 int fuse_update_attributes(struct inode *inode, struct kstat *stat,
 928                            struct file *file, bool *refreshed);
 929
 930 void fuse_flush_writepages(struct inode *inode);
 931
 932 void fuse_set_nowrite(struct inode *inode);
 933 void fuse_release_nowrite(struct inode *inode);
 934
 935 u64 fuse_get_attr_version(struct fuse_conn *fc);
 936
 937 /**
 938  * File-system tells the kernel to invalidate cache for the given node id.
 939  */
 940 int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid,
 941                              loff_t offset, loff_t len);
 942
 943 /**
 944  * File-system tells the kernel to invalidate parent attributes and
 945  * the dentry matching parent/name.
 946  *
 947  * If the child_nodeid is non-zero and:
 948  *    - matches the inode number for the dentry matching parent/name,
 949  *    - is not a mount point
 950  *    - is a file or oan empty directory
 951  * then the dentry is unhashed (d_delete()).
 952  */
 953 int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
 954                              u64 child_nodeid, struct qstr *name);
 955
 956 int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
 957                  bool isdir);
 958
 959 /**
 960  * fuse_direct_io() flags
 961  */
 962
 963 /** If set, it is WRITE; otherwise - READ */
 964 #define FUSE_DIO_WRITE (1 << 0)
 965
 966 /** CUSE pass fuse_direct_io() a file which f_mapping->host is not from FUSE */
 967 #define FUSE_DIO_CUSE  (1 << 1)
 968
 969 ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
 970                        loff_t *ppos, int flags);
 971 long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
 972                    unsigned int flags);
 973 long fuse_ioctl_common(struct file *file, unsigned int cmd,
 974                        unsigned long arg, unsigned int flags);
 975 unsigned fuse_file_poll(struct file *file, poll_table *wait);
 976 int fuse_dev_release(struct inode *inode, struct file *file);
 977
 978 bool fuse_write_update_size(struct inode *inode, loff_t pos);
 979
 980 int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
 981 int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
 982
 983 int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
 984                     struct file *file);
 985
 986 void fuse_set_initialized(struct fuse_conn *fc);
 987
 988 void fuse_unlock_inode(struct inode *inode, bool locked);
 989 bool fuse_lock_inode(struct inode *inode);
 990
 991 int fuse_setxattr(struct inode *inode, const char *name, const void *value,
 992                   size_t size, int flags);
 993 ssize_t fuse_getxattr(struct inode *inode, const char *name, void *value,
 994                       size_t size);
 995 ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
 996 int fuse_removexattr(struct inode *inode, const char *name);
 997 extern const struct xattr_handler *fuse_xattr_handlers[];
 998 extern const struct xattr_handler *fuse_acl_xattr_handlers[];
 999
1000 struct posix_acl;
1001 struct posix_acl *fuse_get_acl(struct inode *inode, int type);
1002 int fuse_set_acl(struct inode *inode, struct posix_acl *acl, int type);
1003
1004 #endif /* _FS_FUSE_I_H */