2 FUSE: Filesystem in Userspace
3 Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu>
5 This program can be distributed under the terms of the GNU GPL.
12 #include <linux/fuse.h>
14 #include <linux/mount.h>
15 #include <linux/wait.h>
16 #include <linux/list.h>
17 #include <linux/spinlock.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>
26 /** Max number of pages that can be used in a single read request */
27 #define FUSE_MAX_PAGES_PER_REQ 32
29 /** Bias for fi->writectr, meaning new writepages must not be sent */
30 #define FUSE_NOWRITE INT_MIN
32 /** It could be as large as PATH_MAX, but would that have any uses? */
33 #define FUSE_NAME_MAX 1024
35 /** Number of dentries for each connection in the control filesystem */
36 #define FUSE_CTL_NUM_DENTRIES 5
38 /** If the FUSE_DEFAULT_PERMISSIONS flag is given, the filesystem
39 module will check permissions based on the file mode. Otherwise no
40 permission checking is done in the kernel */
41 #define FUSE_DEFAULT_PERMISSIONS (1 << 0)
43 /** If the FUSE_ALLOW_OTHER flag is given, then not only the user
44 doing the mount will be allowed to access the filesystem */
45 #define FUSE_ALLOW_OTHER (1 << 1)
47 /** Number of page pointers embedded in fuse_req */
48 #define FUSE_REQ_INLINE_PAGES 1
50 /** List of active connections */
51 extern struct list_head fuse_conn_list;
53 /** Global mutex protecting fuse_conn_list and the control filesystem */
54 extern struct mutex fuse_mutex;
56 /** Module parameters */
57 extern unsigned max_user_bgreq;
58 extern unsigned max_user_congthresh;
60 /* One forget request */
61 struct fuse_forget_link {
62 struct fuse_forget_one forget_one;
63 struct fuse_forget_link *next;
71 /** Unique ID, which identifies the inode between userspace
75 /** Number of lookups on this inode */
78 /** The request used for sending the FORGET message */
79 struct fuse_forget_link *forget;
81 /** Time in jiffies until the file attributes are valid */
84 /** The sticky bit in inode->i_mode may have been removed, so
85 preserve the original mode */
88 /** 64 bit inode number */
91 /** Version of last attribute change */
94 /** Files usable in writepage. Protected by fc->lock */
95 struct list_head write_files;
97 /** Writepages pending on truncate or fsync */
98 struct list_head queued_writes;
100 /** Number of sent writes, a negative bias (FUSE_NOWRITE)
101 * means more writes are blocked */
104 /** Waitq for writepage completion */
105 wait_queue_head_t page_waitq;
107 /** List of writepage requestst (pending or sent) */
108 struct list_head writepages;
110 /** Miscellaneous bits describing inode state */
114 /** FUSE inode state bits */
116 /** Advise readdirplus */
117 FUSE_I_ADVISE_RDPLUS,
118 /** Initialized with readdirplus */
120 /** An operation changing file size is in progress */
121 FUSE_I_SIZE_UNSTABLE,
126 /** FUSE specific file data */
128 /** Fuse connection for this file */
129 struct fuse_conn *fc;
131 /** Request reserved for flush and release */
132 struct fuse_req *reserved_req;
134 /** Kernel file handle guaranteed to be unique */
137 /** File handle used by userspace */
140 /** Node id of this file */
146 /** FOPEN_* flags returned by open */
149 /** Entry on inode's write_files list */
150 struct list_head write_entry;
152 /** RB node to be linked on fuse_conn->polled_files */
153 struct rb_node polled_node;
155 /** Wait queue head for poll */
156 wait_queue_head_t poll_wait;
158 /** Has flock been performed on this file? */
162 /** One input argument of a request */
168 /** The request input */
170 /** The request header */
171 struct fuse_in_header h;
173 /** True if the data for the last argument is in req->pages */
176 /** Number of arguments */
179 /** Array of arguments */
180 struct fuse_in_arg args[3];
183 /** One output argument of a request */
189 /** The request output */
191 /** Header returned from userspace */
192 struct fuse_out_header h;
195 * The following bitfields are not changed during the request
199 /** Last argument is variable length (can be shorter than
203 /** Last argument is a list of pages to copy data to */
206 /** Zero partially or not copied pages */
207 unsigned page_zeroing:1;
209 /** Pages may be replaced with new ones */
210 unsigned page_replace:1;
212 /** Number or arguments */
215 /** Array of arguments */
216 struct fuse_arg args[2];
219 /** FUSE page descriptor */
220 struct fuse_page_desc {
232 struct fuse_in_arg args[3];
238 struct fuse_arg args[2];
242 #define FUSE_ARGS(args) struct fuse_args args = {}
244 /** The request state */
245 enum fuse_req_state {
254 /** The request IO state (for asynchronous processing) */
255 struct fuse_io_priv {
266 struct completion *done;
272 * FR_ISREPLY: set if the request has reply
273 * FR_FORCE: force sending of the request even if interrupted
274 * FR_BACKGROUND: request is sent in the background
275 * FR_WAITING: request is counted as "waiting"
276 * FR_ABORTED: the request was aborted
277 * FR_INTERRUPTED: the request has been interrupted
278 * FR_LOCKED: data is being copied to/from the request
291 * A request to the client
294 /** This can be on either pending processing or io lists in
296 struct list_head list;
298 /** Entry on the interrupts list */
299 struct list_head intr_entry;
304 /** Unique ID for the interrupt request */
307 /* Request flags, updated with test/set/clear_bit() */
310 /** State of the request */
311 enum fuse_req_state state;
313 /** The request input */
316 /** The request output */
319 /** Used to wake up the task waiting for completion of request*/
320 wait_queue_head_t waitq;
322 /** Data for asynchronous requests */
325 struct fuse_release_in in;
328 struct fuse_init_in init_in;
329 struct fuse_init_out init_out;
330 struct cuse_init_in cuse_init_in;
332 struct fuse_read_in in;
336 struct fuse_write_in in;
337 struct fuse_write_out out;
338 struct fuse_req *next;
340 struct fuse_notify_retrieve_in retrieve_in;
346 /** page-descriptor vector */
347 struct fuse_page_desc *page_descs;
349 /** size of the 'pages' array */
352 /** inline page vector */
353 struct page *inline_pages[FUSE_REQ_INLINE_PAGES];
355 /** inline page-descriptor vector */
356 struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];
358 /** number of pages in vector */
361 /** File used in the request (or NULL) */
362 struct fuse_file *ff;
364 /** Inode used in the request or NULL */
367 /** AIO control block */
368 struct fuse_io_priv *io;
370 /** Link on fi->writepages */
371 struct list_head writepages_entry;
373 /** Request completion callback */
374 void (*end)(struct fuse_conn *, struct fuse_req *);
376 /** Request is stolen from fuse_file->reserved_req */
377 struct file *stolen_file;
383 * This structure is created, when the filesystem is mounted, and is
384 * destroyed, when the client device is closed and the filesystem is
388 /** Lock protecting accessess to members of this structure */
396 /** The user id for this mount */
399 /** The group id for this mount */
402 /** The fuse mount flags for this mount */
405 /** Maximum read size */
408 /** Maximum write size */
411 /** Readers of the connection are waiting on this */
412 wait_queue_head_t waitq;
414 /** The list of pending requests */
415 struct list_head pending;
417 /** The list of requests being processed */
418 struct list_head processing;
420 /** The list of requests under I/O */
423 /** The next unique kernel file handle */
426 /** rbtree of fuse_files waiting for poll events indexed by ph */
427 struct rb_root polled_files;
429 /** Maximum number of outstanding background requests */
430 unsigned max_background;
432 /** Number of background requests at which congestion starts */
433 unsigned congestion_threshold;
435 /** Number of requests currently in the background */
436 unsigned num_background;
438 /** Number of background requests currently queued for userspace */
439 unsigned active_background;
441 /** The list of background requests set aside for later queuing */
442 struct list_head bg_queue;
444 /** Pending interrupts */
445 struct list_head interrupts;
447 /** Queue of pending forgets */
448 struct fuse_forget_link forget_list_head;
449 struct fuse_forget_link *forget_list_tail;
451 /** Batching of FORGET requests (positive indicates FORGET batch) */
454 /** Flag indicating that INIT reply has been received. Allocating
455 * any fuse request will be suspended until the flag is set */
458 /** Flag indicating if connection is blocked. This will be
459 the case before the INIT reply is received, and if there
460 are too many outstading backgrounds requests */
463 /** waitq for blocked connection */
464 wait_queue_head_t blocked_waitq;
466 /** waitq for reserved requests */
467 wait_queue_head_t reserved_req_waitq;
469 /** The next unique request id */
472 /** Connection established, cleared on umount, connection
473 abort and device release */
476 /** Connection failed (version mismatch). Cannot race with
477 setting other bitfields since it is only set once in INIT
478 reply, before any other request, and never cleared */
479 unsigned conn_error:1;
481 /** Connection successful. Only set in INIT */
482 unsigned conn_init:1;
484 /** Do readpages asynchronously? Only set in INIT */
485 unsigned async_read:1;
487 /** Do not send separate SETATTR request before open(O_TRUNC) */
488 unsigned atomic_o_trunc:1;
490 /** Filesystem supports NFS exporting. Only set in INIT */
491 unsigned export_support:1;
493 /** Set if bdi is valid */
494 unsigned bdi_initialized:1;
496 /** write-back cache policy (default is write-through) */
497 unsigned writeback_cache:1;
500 * The following bitfields are only for optimization purposes
501 * and hence races in setting them will not cause malfunction
504 /** Is open/release not implemented by fs? */
507 /** Is fsync not implemented by fs? */
510 /** Is fsyncdir not implemented by fs? */
511 unsigned no_fsyncdir:1;
513 /** Is flush not implemented by fs? */
516 /** Is setxattr not implemented by fs? */
517 unsigned no_setxattr:1;
519 /** Is getxattr not implemented by fs? */
520 unsigned no_getxattr:1;
522 /** Is listxattr not implemented by fs? */
523 unsigned no_listxattr:1;
525 /** Is removexattr not implemented by fs? */
526 unsigned no_removexattr:1;
528 /** Are posix file locking primitives not implemented by fs? */
531 /** Is access not implemented by fs? */
532 unsigned no_access:1;
534 /** Is create not implemented by fs? */
535 unsigned no_create:1;
537 /** Is interrupt not implemented by fs? */
538 unsigned no_interrupt:1;
540 /** Is bmap not implemented by fs? */
543 /** Is poll not implemented by fs? */
546 /** Do multi-page cached writes */
547 unsigned big_writes:1;
549 /** Don't apply umask to creation modes */
550 unsigned dont_mask:1;
552 /** Are BSD file locking primitives not implemented by fs? */
555 /** Is fallocate not implemented by fs? */
556 unsigned no_fallocate:1;
558 /** Is rename with flags implemented by fs? */
559 unsigned no_rename2:1;
561 /** Use enhanced/automatic page cache invalidation. */
562 unsigned auto_inval_data:1;
564 /** Does the filesystem support readdirplus? */
565 unsigned do_readdirplus:1;
567 /** Does the filesystem want adaptive readdirplus? */
568 unsigned readdirplus_auto:1;
570 /** Does the filesystem support asynchronous direct-IO submission? */
571 unsigned async_dio:1;
573 /** The number of requests waiting for completion */
574 atomic_t num_waiting;
576 /** Negotiated minor version */
579 /** Backing dev info */
580 struct backing_dev_info bdi;
582 /** Entry on the fuse_conn_list */
583 struct list_head entry;
585 /** Device ID from super block */
588 /** Dentries in the control filesystem */
589 struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
591 /** number of dentries used in the above array */
594 /** O_ASYNC requests */
595 struct fasync_struct *fasync;
597 /** Key for lock owner ID scrambling */
600 /** Reserved request for the DESTROY message */
601 struct fuse_req *destroy_req;
603 /** Version counter for attribute changes */
606 /** Called on final put */
607 void (*release)(struct fuse_conn *);
609 /** Super block for this connection. */
610 struct super_block *sb;
612 /** Read/write semaphore to hold when accessing sb. */
613 struct rw_semaphore killsb;
616 static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
618 return sb->s_fs_info;
621 static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
623 return get_fuse_conn_super(inode->i_sb);
626 static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
628 return container_of(inode, struct fuse_inode, inode);
631 static inline u64 get_node_id(struct inode *inode)
633 return get_fuse_inode(inode)->nodeid;
636 /** Device operations */
637 extern const struct file_operations fuse_dev_operations;
639 extern const struct dentry_operations fuse_dentry_operations;
642 * Inode to nodeid comparison.
644 int fuse_inode_eq(struct inode *inode, void *_nodeidp);
647 * Get a filled in inode
649 struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
650 int generation, struct fuse_attr *attr,
651 u64 attr_valid, u64 attr_version);
653 int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
654 struct fuse_entry_out *outarg, struct inode **inode);
657 * Send FORGET command
659 void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
660 u64 nodeid, u64 nlookup);
662 struct fuse_forget_link *fuse_alloc_forget(void);
664 /* Used by READDIRPLUS */
665 void fuse_force_forget(struct file *file, u64 nodeid);
668 * Initialize READ or READDIR request
670 void fuse_read_fill(struct fuse_req *req, struct file *file,
671 loff_t pos, size_t count, int opcode);
674 * Send OPEN or OPENDIR request
676 int fuse_open_common(struct inode *inode, struct file *file, bool isdir);
678 struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
679 struct fuse_file *fuse_file_get(struct fuse_file *ff);
680 void fuse_file_free(struct fuse_file *ff);
681 void fuse_finish_open(struct inode *inode, struct file *file);
683 void fuse_sync_release(struct fuse_file *ff, int flags);
686 * Send RELEASE or RELEASEDIR request
688 void fuse_release_common(struct file *file, int opcode);
691 * Send FSYNC or FSYNCDIR request
693 int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
694 int datasync, int isdir);
699 int fuse_notify_poll_wakeup(struct fuse_conn *fc,
700 struct fuse_notify_poll_wakeup_out *outarg);
703 * Initialize file operations on a regular file
705 void fuse_init_file_inode(struct inode *inode);
708 * Initialize inode operations on regular files and special files
710 void fuse_init_common(struct inode *inode);
713 * Initialize inode and file operations on a directory
715 void fuse_init_dir(struct inode *inode);
718 * Initialize inode operations on a symlink
720 void fuse_init_symlink(struct inode *inode);
723 * Change attributes of an inode
725 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
726 u64 attr_valid, u64 attr_version);
728 void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
732 * Initialize the client device
734 int fuse_dev_init(void);
737 * Cleanup the client device
739 void fuse_dev_cleanup(void);
741 int fuse_ctl_init(void);
742 void __exit fuse_ctl_cleanup(void);
747 struct fuse_req *fuse_request_alloc(unsigned npages);
749 struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
754 void fuse_request_free(struct fuse_req *req);
757 * Get a request, may fail with -ENOMEM,
758 * caller should specify # elements in req->pages[] explicitly
760 struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
761 struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
765 * Increment reference count on request
767 void __fuse_get_request(struct fuse_req *req);
770 * Gets a requests for a file operation, always succeeds
772 struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
776 * Decrement reference count of a request. If count goes to zero free
779 void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
782 * Send a request (synchronous)
784 void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
787 * Simple request sending that does request allocation and freeing
789 ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);
792 * Send a request in the background
794 void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
796 void fuse_request_send_background_locked(struct fuse_conn *fc,
797 struct fuse_req *req);
799 /* Abort all requests */
800 void fuse_abort_conn(struct fuse_conn *fc);
803 * Invalidate inode attributes
805 void fuse_invalidate_attr(struct inode *inode);
807 void fuse_invalidate_entry_cache(struct dentry *entry);
809 void fuse_invalidate_atime(struct inode *inode);
812 * Acquire reference to fuse_conn
814 struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
817 * Initialize fuse_conn
819 void fuse_conn_init(struct fuse_conn *fc);
822 * Release reference to fuse_conn
824 void fuse_conn_put(struct fuse_conn *fc);
827 * Add connection to control filesystem
829 int fuse_ctl_add_conn(struct fuse_conn *fc);
832 * Remove connection from control filesystem
834 void fuse_ctl_remove_conn(struct fuse_conn *fc);
837 * Is file type valid?
839 int fuse_valid_type(int m);
842 * Is current process allowed to perform filesystem operation?
844 int fuse_allow_current_process(struct fuse_conn *fc);
846 u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
848 int fuse_update_attributes(struct inode *inode, struct kstat *stat,
849 struct file *file, bool *refreshed);
851 void fuse_flush_writepages(struct inode *inode);
853 void fuse_set_nowrite(struct inode *inode);
854 void fuse_release_nowrite(struct inode *inode);
856 u64 fuse_get_attr_version(struct fuse_conn *fc);
859 * File-system tells the kernel to invalidate cache for the given node id.
861 int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid,
862 loff_t offset, loff_t len);
865 * File-system tells the kernel to invalidate parent attributes and
866 * the dentry matching parent/name.
868 * If the child_nodeid is non-zero and:
869 * - matches the inode number for the dentry matching parent/name,
870 * - is not a mount point
871 * - is a file or oan empty directory
872 * then the dentry is unhashed (d_delete()).
874 int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
875 u64 child_nodeid, struct qstr *name);
877 int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
881 * fuse_direct_io() flags
884 /** If set, it is WRITE; otherwise - READ */
885 #define FUSE_DIO_WRITE (1 << 0)
887 /** CUSE pass fuse_direct_io() a file which f_mapping->host is not from FUSE */
888 #define FUSE_DIO_CUSE (1 << 1)
890 ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
891 loff_t *ppos, int flags);
892 long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
894 long fuse_ioctl_common(struct file *file, unsigned int cmd,
895 unsigned long arg, unsigned int flags);
896 unsigned fuse_file_poll(struct file *file, poll_table *wait);
897 int fuse_dev_release(struct inode *inode, struct file *file);
899 bool fuse_write_update_size(struct inode *inode, loff_t pos);
901 int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
902 int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
904 int fuse_do_setattr(struct inode *inode, struct iattr *attr,
907 void fuse_set_initialized(struct fuse_conn *fc);
909 #endif /* _FS_FUSE_I_H */