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
  23 /** Max number of pages that can be used in a single read request */
  24 #define FUSE_MAX_PAGES_PER_REQ 32
  25
  26 /** Maximum number of outstanding background requests */
  27 #define FUSE_MAX_BACKGROUND 12
  28
  29 /** Congestion starts at 75% of maximum */
  30 #define FUSE_CONGESTION_THRESHOLD (FUSE_MAX_BACKGROUND * 75 / 100)
  31
  32 /** Bias for fi->writectr, meaning new writepages must not be sent */
  33 #define FUSE_NOWRITE INT_MIN
  34
  35 /** It could be as large as PATH_MAX, but would that have any uses? */
  36 #define FUSE_NAME_MAX 1024
  37
  38 /** Number of dentries for each connection in the control filesystem */
  39 #define FUSE_CTL_NUM_DENTRIES 3
  40
  41 /** If the FUSE_DEFAULT_PERMISSIONS flag is given, the filesystem
  42     module will check permissions based on the file mode.  Otherwise no
  43     permission checking is done in the kernel */
  44 #define FUSE_DEFAULT_PERMISSIONS (1 << 0)
  45
  46 /** If the FUSE_ALLOW_OTHER flag is given, then not only the user
  47     doing the mount will be allowed to access the filesystem */
  48 #define FUSE_ALLOW_OTHER         (1 << 1)
  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 /** FUSE inode */
  57 struct fuse_inode {
  58         /** Inode data */
  59         struct inode inode;
  60
  61         /** Unique ID, which identifies the inode between userspace
  62          * and kernel */
  63         u64 nodeid;
  64
  65         /** Number of lookups on this inode */
  66         u64 nlookup;
  67
  68         /** The request used for sending the FORGET message */
  69         struct fuse_req *forget_req;
  70
  71         /** Time in jiffies until the file attributes are valid */
  72         u64 i_time;
  73
  74         /** The sticky bit in inode->i_mode may have been removed, so
  75             preserve the original mode */
  76         mode_t orig_i_mode;
  77
  78         /** Version of last attribute change */
  79         u64 attr_version;
  80
  81         /** Files usable in writepage.  Protected by fc->lock */
  82         struct list_head write_files;
  83
  84         /** Writepages pending on truncate or fsync */
  85         struct list_head queued_writes;
  86
  87         /** Number of sent writes, a negative bias (FUSE_NOWRITE)
  88          * means more writes are blocked */
  89         int writectr;
  90
  91         /** Waitq for writepage completion */
  92         wait_queue_head_t page_waitq;
  93
  94         /** List of writepage requestst (pending or sent) */
  95         struct list_head writepages;
  96 };
  97
  98 /** FUSE specific file data */
  99 struct fuse_file {
 100         /** Request reserved for flush and release */
 101         struct fuse_req *reserved_req;
 102
 103         /** Kernel file handle guaranteed to be unique */
 104         u64 kh;
 105
 106         /** File handle used by userspace */
 107         u64 fh;
 108
 109         /** Refcount */
 110         atomic_t count;
 111
 112         /** Entry on inode's write_files list */
 113         struct list_head write_entry;
 114 };
 115
 116 /** One input argument of a request */
 117 struct fuse_in_arg {
 118         unsigned size;
 119         const void *value;
 120 };
 121
 122 /** The request input */
 123 struct fuse_in {
 124         /** The request header */
 125         struct fuse_in_header h;
 126
 127         /** True if the data for the last argument is in req->pages */
 128         unsigned argpages:1;
 129
 130         /** Number of arguments */
 131         unsigned numargs;
 132
 133         /** Array of arguments */
 134         struct fuse_in_arg args[3];
 135 };
 136
 137 /** One output argument of a request */
 138 struct fuse_arg {
 139         unsigned size;
 140         void *value;
 141 };
 142
 143 /** The request output */
 144 struct fuse_out {
 145         /** Header returned from userspace */
 146         struct fuse_out_header h;
 147
 148         /*
 149          * The following bitfields are not changed during the request
 150          * processing
 151          */
 152
 153         /** Last argument is variable length (can be shorter than
 154             arg->size) */
 155         unsigned argvar:1;
 156
 157         /** Last argument is a list of pages to copy data to */
 158         unsigned argpages:1;
 159
 160         /** Zero partially or not copied pages */
 161         unsigned page_zeroing:1;
 162
 163         /** Number or arguments */
 164         unsigned numargs;
 165
 166         /** Array of arguments */
 167         struct fuse_arg args[3];
 168 };
 169
 170 /** The request state */
 171 enum fuse_req_state {
 172         FUSE_REQ_INIT = 0,
 173         FUSE_REQ_PENDING,
 174         FUSE_REQ_READING,
 175         FUSE_REQ_SENT,
 176         FUSE_REQ_WRITING,
 177         FUSE_REQ_FINISHED
 178 };
 179
 180 struct fuse_conn;
 181
 182 /**
 183  * A request to the client
 184  */
 185 struct fuse_req {
 186         /** This can be on either pending processing or io lists in
 187             fuse_conn */
 188         struct list_head list;
 189
 190         /** Entry on the interrupts list  */
 191         struct list_head intr_entry;
 192
 193         /** refcount */
 194         atomic_t count;
 195
 196         /** Unique ID for the interrupt request */
 197         u64 intr_unique;
 198
 199         /*
 200          * The following bitfields are either set once before the
 201          * request is queued or setting/clearing them is protected by
 202          * fuse_conn->lock
 203          */
 204
 205         /** True if the request has reply */
 206         unsigned isreply:1;
 207
 208         /** Force sending of the request even if interrupted */
 209         unsigned force:1;
 210
 211         /** The request was aborted */
 212         unsigned aborted:1;
 213
 214         /** Request is sent in the background */
 215         unsigned background:1;
 216
 217         /** The request has been interrupted */
 218         unsigned interrupted:1;
 219
 220         /** Data is being copied to/from the request */
 221         unsigned locked:1;
 222
 223         /** Request is counted as "waiting" */
 224         unsigned waiting:1;
 225
 226         /** State of the request */
 227         enum fuse_req_state state;
 228
 229         /** The request input */
 230         struct fuse_in in;
 231
 232         /** The request output */
 233         struct fuse_out out;
 234
 235         /** Used to wake up the task waiting for completion of request*/
 236         wait_queue_head_t waitq;
 237
 238         /** Data for asynchronous requests */
 239         union {
 240                 struct fuse_forget_in forget_in;
 241                 struct {
 242                         struct fuse_release_in in;
 243                         struct vfsmount *vfsmount;
 244                         struct dentry *dentry;
 245                 } release;
 246                 struct fuse_init_in init_in;
 247                 struct fuse_init_out init_out;
 248                 struct {
 249                         struct fuse_read_in in;
 250                         u64 attr_ver;
 251                 } read;
 252                 struct {
 253                         struct fuse_write_in in;
 254                         struct fuse_write_out out;
 255                 } write;
 256                 struct fuse_lk_in lk_in;
 257         } misc;
 258
 259         /** page vector */
 260         struct page *pages[FUSE_MAX_PAGES_PER_REQ];
 261
 262         /** number of pages in vector */
 263         unsigned num_pages;
 264
 265         /** offset of data on first page */
 266         unsigned page_offset;
 267
 268         /** File used in the request (or NULL) */
 269         struct fuse_file *ff;
 270
 271         /** Inode used in the request or NULL */
 272         struct inode *inode;
 273
 274         /** Link on fi->writepages */
 275         struct list_head writepages_entry;
 276
 277         /** Request completion callback */
 278         void (*end)(struct fuse_conn *, struct fuse_req *);
 279
 280         /** Request is stolen from fuse_file->reserved_req */
 281         struct file *stolen_file;
 282 };
 283
 284 /**
 285  * A Fuse connection.
 286  *
 287  * This structure is created, when the filesystem is mounted, and is
 288  * destroyed, when the client device is closed and the filesystem is
 289  * unmounted.
 290  */
 291 struct fuse_conn {
 292         /** Lock protecting accessess to  members of this structure */
 293         spinlock_t lock;
 294
 295         /** Mutex protecting against directory alias creation */
 296         struct mutex inst_mutex;
 297
 298         /** Refcount */
 299         atomic_t count;
 300
 301         /** The user id for this mount */
 302         uid_t user_id;
 303
 304         /** The group id for this mount */
 305         gid_t group_id;
 306
 307         /** The fuse mount flags for this mount */
 308         unsigned flags;
 309
 310         /** Maximum read size */
 311         unsigned max_read;
 312
 313         /** Maximum write size */
 314         unsigned max_write;
 315
 316         /** Readers of the connection are waiting on this */
 317         wait_queue_head_t waitq;
 318
 319         /** The list of pending requests */
 320         struct list_head pending;
 321
 322         /** The list of requests being processed */
 323         struct list_head processing;
 324
 325         /** The list of requests under I/O */
 326         struct list_head io;
 327
 328         /** The next unique kernel file handle */
 329         u64 khctr;
 330
 331         /** Number of requests currently in the background */
 332         unsigned num_background;
 333
 334         /** Number of background requests currently queued for userspace */
 335         unsigned active_background;
 336
 337         /** The list of background requests set aside for later queuing */
 338         struct list_head bg_queue;
 339
 340         /** Pending interrupts */
 341         struct list_head interrupts;
 342
 343         /** Flag indicating if connection is blocked.  This will be
 344             the case before the INIT reply is received, and if there
 345             are too many outstading backgrounds requests */
 346         int blocked;
 347
 348         /** waitq for blocked connection */
 349         wait_queue_head_t blocked_waitq;
 350
 351         /** waitq for reserved requests */
 352         wait_queue_head_t reserved_req_waitq;
 353
 354         /** The next unique request id */
 355         u64 reqctr;
 356
 357         /** Connection established, cleared on umount, connection
 358             abort and device release */
 359         unsigned connected;
 360
 361         /** Connection failed (version mismatch).  Cannot race with
 362             setting other bitfields since it is only set once in INIT
 363             reply, before any other request, and never cleared */
 364         unsigned conn_error:1;
 365
 366         /** Connection successful.  Only set in INIT */
 367         unsigned conn_init:1;
 368
 369         /** Do readpages asynchronously?  Only set in INIT */
 370         unsigned async_read:1;
 371
 372         /** Do not send separate SETATTR request before open(O_TRUNC)  */
 373         unsigned atomic_o_trunc:1;
 374
 375         /** Filesystem supports NFS exporting.  Only set in INIT */
 376         unsigned export_support:1;
 377
 378         /*
 379          * The following bitfields are only for optimization purposes
 380          * and hence races in setting them will not cause malfunction
 381          */
 382
 383         /** Is fsync not implemented by fs? */
 384         unsigned no_fsync:1;
 385
 386         /** Is fsyncdir not implemented by fs? */
 387         unsigned no_fsyncdir:1;
 388
 389         /** Is flush not implemented by fs? */
 390         unsigned no_flush:1;
 391
 392         /** Is setxattr not implemented by fs? */
 393         unsigned no_setxattr:1;
 394
 395         /** Is getxattr not implemented by fs? */
 396         unsigned no_getxattr:1;
 397
 398         /** Is listxattr not implemented by fs? */
 399         unsigned no_listxattr:1;
 400
 401         /** Is removexattr not implemented by fs? */
 402         unsigned no_removexattr:1;
 403
 404         /** Are file locking primitives not implemented by fs? */
 405         unsigned no_lock:1;
 406
 407         /** Is access not implemented by fs? */
 408         unsigned no_access:1;
 409
 410         /** Is create not implemented by fs? */
 411         unsigned no_create:1;
 412
 413         /** Is interrupt not implemented by fs? */
 414         unsigned no_interrupt:1;
 415
 416         /** Is bmap not implemented by fs? */
 417         unsigned no_bmap:1;
 418
 419         /** Do multi-page cached writes */
 420         unsigned big_writes:1;
 421
 422         /** The number of requests waiting for completion */
 423         atomic_t num_waiting;
 424
 425         /** Negotiated minor version */
 426         unsigned minor;
 427
 428         /** Backing dev info */
 429         struct backing_dev_info bdi;
 430
 431         /** Entry on the fuse_conn_list */
 432         struct list_head entry;
 433
 434         /** Device ID from super block */
 435         dev_t dev;
 436
 437         /** Dentries in the control filesystem */
 438         struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
 439
 440         /** number of dentries used in the above array */
 441         int ctl_ndents;
 442
 443         /** O_ASYNC requests */
 444         struct fasync_struct *fasync;
 445
 446         /** Key for lock owner ID scrambling */
 447         u32 scramble_key[4];
 448
 449         /** Reserved request for the DESTROY message */
 450         struct fuse_req *destroy_req;
 451
 452         /** Version counter for attribute changes */
 453         u64 attr_version;
 454 };
 455
 456 static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
 457 {
 458         return sb->s_fs_info;
 459 }
 460
 461 static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
 462 {
 463         return get_fuse_conn_super(inode->i_sb);
 464 }
 465
 466 static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
 467 {
 468         return container_of(inode, struct fuse_inode, inode);
 469 }
 470
 471 static inline u64 get_node_id(struct inode *inode)
 472 {
 473         return get_fuse_inode(inode)->nodeid;
 474 }
 475
 476 /** Device operations */
 477 extern const struct file_operations fuse_dev_operations;
 478
 479 extern struct dentry_operations fuse_dentry_operations;
 480
 481 /**
 482  * Get a filled in inode
 483  */
 484 struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
 485                         int generation, struct fuse_attr *attr,
 486                         u64 attr_valid, u64 attr_version);
 487
 488 int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
 489                      struct fuse_entry_out *outarg, struct inode **inode);
 490
 491 /**
 492  * Send FORGET command
 493  */
 494 void fuse_send_forget(struct fuse_conn *fc, struct fuse_req *req,
 495                       u64 nodeid, u64 nlookup);
 496
 497 /**
 498  * Initialize READ or READDIR request
 499  */
 500 void fuse_read_fill(struct fuse_req *req, struct file *file,
 501                     struct inode *inode, loff_t pos, size_t count, int opcode);
 502
 503 /**
 504  * Send OPEN or OPENDIR request
 505  */
 506 int fuse_open_common(struct inode *inode, struct file *file, int isdir);
 507
 508 struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
 509 void fuse_file_free(struct fuse_file *ff);
 510 void fuse_finish_open(struct inode *inode, struct file *file,
 511                       struct fuse_file *ff, struct fuse_open_out *outarg);
 512
 513 /** Fill in ff->reserved_req with a RELEASE request */
 514 void fuse_release_fill(struct fuse_file *ff, u64 nodeid, int flags, int opcode);
 515
 516 /**
 517  * Send RELEASE or RELEASEDIR request
 518  */
 519 int fuse_release_common(struct inode *inode, struct file *file, int isdir);
 520
 521 /**
 522  * Send FSYNC or FSYNCDIR request
 523  */
 524 int fuse_fsync_common(struct file *file, struct dentry *de, int datasync,
 525                       int isdir);
 526
 527 /**
 528  * Initialize file operations on a regular file
 529  */
 530 void fuse_init_file_inode(struct inode *inode);
 531
 532 /**
 533  * Initialize inode operations on regular files and special files
 534  */
 535 void fuse_init_common(struct inode *inode);
 536
 537 /**
 538  * Initialize inode and file operations on a directory
 539  */
 540 void fuse_init_dir(struct inode *inode);
 541
 542 /**
 543  * Initialize inode operations on a symlink
 544  */
 545 void fuse_init_symlink(struct inode *inode);
 546
 547 /**
 548  * Change attributes of an inode
 549  */
 550 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
 551                             u64 attr_valid, u64 attr_version);
 552
 553 void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
 554                                    u64 attr_valid);
 555
 556 void fuse_truncate(struct address_space *mapping, loff_t offset);
 557
 558 /**
 559  * Initialize the client device
 560  */
 561 int fuse_dev_init(void);
 562
 563 /**
 564  * Cleanup the client device
 565  */
 566 void fuse_dev_cleanup(void);
 567
 568 int fuse_ctl_init(void);
 569 void fuse_ctl_cleanup(void);
 570
 571 /**
 572  * Allocate a request
 573  */
 574 struct fuse_req *fuse_request_alloc(void);
 575
 576 struct fuse_req *fuse_request_alloc_nofs(void);
 577
 578 /**
 579  * Free a request
 580  */
 581 void fuse_request_free(struct fuse_req *req);
 582
 583 /**
 584  * Get a request, may fail with -ENOMEM
 585  */
 586 struct fuse_req *fuse_get_req(struct fuse_conn *fc);
 587
 588 /**
 589  * Gets a requests for a file operation, always succeeds
 590  */
 591 struct fuse_req *fuse_get_req_nofail(struct fuse_conn *fc, struct file *file);
 592
 593 /**
 594  * Decrement reference count of a request.  If count goes to zero free
 595  * the request.
 596  */
 597 void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
 598
 599 /**
 600  * Send a request (synchronous)
 601  */
 602 void request_send(struct fuse_conn *fc, struct fuse_req *req);
 603
 604 /**
 605  * Send a request with no reply
 606  */
 607 void request_send_noreply(struct fuse_conn *fc, struct fuse_req *req);
 608
 609 /**
 610  * Send a request in the background
 611  */
 612 void request_send_background(struct fuse_conn *fc, struct fuse_req *req);
 613
 614 void request_send_background_locked(struct fuse_conn *fc, struct fuse_req *req);
 615
 616 /* Abort all requests */
 617 void fuse_abort_conn(struct fuse_conn *fc);
 618
 619 /**
 620  * Invalidate inode attributes
 621  */
 622 void fuse_invalidate_attr(struct inode *inode);
 623
 624 void fuse_invalidate_entry_cache(struct dentry *entry);
 625
 626 /**
 627  * Acquire reference to fuse_conn
 628  */
 629 struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
 630
 631 /**
 632  * Release reference to fuse_conn
 633  */
 634 void fuse_conn_put(struct fuse_conn *fc);
 635
 636 /**
 637  * Add connection to control filesystem
 638  */
 639 int fuse_ctl_add_conn(struct fuse_conn *fc);
 640
 641 /**
 642  * Remove connection from control filesystem
 643  */
 644 void fuse_ctl_remove_conn(struct fuse_conn *fc);
 645
 646 /**
 647  * Is file type valid?
 648  */
 649 int fuse_valid_type(int m);
 650
 651 /**
 652  * Is task allowed to perform filesystem operation?
 653  */
 654 int fuse_allow_task(struct fuse_conn *fc, struct task_struct *task);
 655
 656 u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
 657
 658 int fuse_update_attributes(struct inode *inode, struct kstat *stat,
 659                            struct file *file, bool *refreshed);
 660
 661 void fuse_flush_writepages(struct inode *inode);
 662
 663 void fuse_set_nowrite(struct inode *inode);
 664 void fuse_release_nowrite(struct inode *inode);
 665
 666 u64 fuse_get_attr_version(struct fuse_conn *fc);
 667
 668 #endif /* _FS_FUSE_I_H */