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