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 /** List of active connections */
48 extern struct list_head fuse_conn_list;
50 /** Global mutex protecting fuse_conn_list and the control filesystem */
51 extern struct mutex fuse_mutex;
53 /** Module parameters */
54 extern unsigned max_user_bgreq;
55 extern unsigned max_user_congthresh;
57 /* One forget request */
58 struct fuse_forget_link {
59 struct fuse_forget_one forget_one;
60 struct fuse_forget_link *next;
68 /** Unique ID, which identifies the inode between userspace
72 /** Number of lookups on this inode */
75 /** The request used for sending the FORGET message */
76 struct fuse_forget_link *forget;
78 /** Time in jiffies until the file attributes are valid */
81 /** The sticky bit in inode->i_mode may have been removed, so
82 preserve the original mode */
85 /** Version of last attribute change */
88 /** Files usable in writepage. Protected by fc->lock */
89 struct list_head write_files;
91 /** Writepages pending on truncate or fsync */
92 struct list_head queued_writes;
94 /** Number of sent writes, a negative bias (FUSE_NOWRITE)
95 * means more writes are blocked */
98 /** Waitq for writepage completion */
99 wait_queue_head_t page_waitq;
101 /** List of writepage requestst (pending or sent) */
102 struct list_head writepages;
107 /** FUSE specific file data */
109 /** Fuse connection for this file */
110 struct fuse_conn *fc;
112 /** Request reserved for flush and release */
113 struct fuse_req *reserved_req;
115 /** Kernel file handle guaranteed to be unique */
118 /** File handle used by userspace */
121 /** Node id of this file */
127 /** FOPEN_* flags returned by open */
130 /** Entry on inode's write_files list */
131 struct list_head write_entry;
133 /** RB node to be linked on fuse_conn->polled_files */
134 struct rb_node polled_node;
136 /** Wait queue head for poll */
137 wait_queue_head_t poll_wait;
139 /** Has flock been performed on this file? */
143 /** One input argument of a request */
149 /** The request input */
151 /** The request header */
152 struct fuse_in_header h;
154 /** True if the data for the last argument is in req->pages */
157 /** Number of arguments */
160 /** Array of arguments */
161 struct fuse_in_arg args[3];
164 /** One output argument of a request */
170 /** The request output */
172 /** Header returned from userspace */
173 struct fuse_out_header h;
176 * The following bitfields are not changed during the request
180 /** Last argument is variable length (can be shorter than
184 /** Last argument is a list of pages to copy data to */
187 /** Zero partially or not copied pages */
188 unsigned page_zeroing:1;
190 /** Pages may be replaced with new ones */
191 unsigned page_replace:1;
193 /** Number or arguments */
196 /** Array of arguments */
197 struct fuse_arg args[3];
200 /** The request state */
201 enum fuse_req_state {
211 * A request to the client
214 /** This can be on either pending processing or io lists in
216 struct list_head list;
218 /** Entry on the interrupts list */
219 struct list_head intr_entry;
224 /** Unique ID for the interrupt request */
228 * The following bitfields are either set once before the
229 * request is queued or setting/clearing them is protected by
233 /** True if the request has reply */
236 /** Force sending of the request even if interrupted */
239 /** The request was aborted */
242 /** Request is sent in the background */
243 unsigned background:1;
245 /** The request has been interrupted */
246 unsigned interrupted:1;
248 /** Data is being copied to/from the request */
251 /** Request is counted as "waiting" */
254 /** State of the request */
255 enum fuse_req_state state;
257 /** The request input */
260 /** The request output */
263 /** Used to wake up the task waiting for completion of request*/
264 wait_queue_head_t waitq;
266 /** Data for asynchronous requests */
270 struct fuse_release_in in;
271 struct work_struct work;
275 struct fuse_init_in init_in;
276 struct fuse_init_out init_out;
277 struct cuse_init_in cuse_init_in;
279 struct fuse_read_in in;
283 struct fuse_write_in in;
284 struct fuse_write_out out;
286 struct fuse_notify_retrieve_in retrieve_in;
287 struct fuse_lk_in lk_in;
291 struct page *pages[FUSE_MAX_PAGES_PER_REQ];
293 /** number of pages in vector */
296 /** offset of data on first page */
297 unsigned page_offset;
299 /** File used in the request (or NULL) */
300 struct fuse_file *ff;
302 /** Inode used in the request or NULL */
305 /** Link on fi->writepages */
306 struct list_head writepages_entry;
308 /** Request completion callback */
309 void (*end)(struct fuse_conn *, struct fuse_req *);
311 /** Request is stolen from fuse_file->reserved_req */
312 struct file *stolen_file;
318 * This structure is created, when the filesystem is mounted, and is
319 * destroyed, when the client device is closed and the filesystem is
323 /** Lock protecting accessess to members of this structure */
326 /** Mutex protecting against directory alias creation */
327 struct mutex inst_mutex;
332 /** The user id for this mount */
335 /** The group id for this mount */
338 /** The fuse mount flags for this mount */
341 /** Maximum read size */
344 /** Maximum write size */
347 /** Readers of the connection are waiting on this */
348 wait_queue_head_t waitq;
350 /** The list of pending requests */
351 struct list_head pending;
353 /** The list of requests being processed */
354 struct list_head processing;
356 /** The list of requests under I/O */
359 /** The next unique kernel file handle */
362 /** rbtree of fuse_files waiting for poll events indexed by ph */
363 struct rb_root polled_files;
365 /** Maximum number of outstanding background requests */
366 unsigned max_background;
368 /** Number of background requests at which congestion starts */
369 unsigned congestion_threshold;
371 /** Number of requests currently in the background */
372 unsigned num_background;
374 /** Number of background requests currently queued for userspace */
375 unsigned active_background;
377 /** The list of background requests set aside for later queuing */
378 struct list_head bg_queue;
380 /** Pending interrupts */
381 struct list_head interrupts;
383 /** Queue of pending forgets */
384 struct fuse_forget_link forget_list_head;
385 struct fuse_forget_link *forget_list_tail;
387 /** Batching of FORGET requests (positive indicates FORGET batch) */
390 /** Flag indicating if connection is blocked. This will be
391 the case before the INIT reply is received, and if there
392 are too many outstading backgrounds requests */
395 /** waitq for blocked connection */
396 wait_queue_head_t blocked_waitq;
398 /** waitq for reserved requests */
399 wait_queue_head_t reserved_req_waitq;
401 /** The next unique request id */
404 /** Connection established, cleared on umount, connection
405 abort and device release */
408 /** Connection failed (version mismatch). Cannot race with
409 setting other bitfields since it is only set once in INIT
410 reply, before any other request, and never cleared */
411 unsigned conn_error:1;
413 /** Connection successful. Only set in INIT */
414 unsigned conn_init:1;
416 /** Do readpages asynchronously? Only set in INIT */
417 unsigned async_read:1;
419 /** Do not send separate SETATTR request before open(O_TRUNC) */
420 unsigned atomic_o_trunc:1;
422 /** Filesystem supports NFS exporting. Only set in INIT */
423 unsigned export_support:1;
425 /** Set if bdi is valid */
426 unsigned bdi_initialized:1;
429 * The following bitfields are only for optimization purposes
430 * and hence races in setting them will not cause malfunction
433 /** Is fsync not implemented by fs? */
436 /** Is fsyncdir not implemented by fs? */
437 unsigned no_fsyncdir:1;
439 /** Is flush not implemented by fs? */
442 /** Is setxattr not implemented by fs? */
443 unsigned no_setxattr:1;
445 /** Is getxattr not implemented by fs? */
446 unsigned no_getxattr:1;
448 /** Is listxattr not implemented by fs? */
449 unsigned no_listxattr:1;
451 /** Is removexattr not implemented by fs? */
452 unsigned no_removexattr:1;
454 /** Are posix file locking primitives not implemented by fs? */
457 /** Is access not implemented by fs? */
458 unsigned no_access:1;
460 /** Is create not implemented by fs? */
461 unsigned no_create:1;
463 /** Is interrupt not implemented by fs? */
464 unsigned no_interrupt:1;
466 /** Is bmap not implemented by fs? */
469 /** Is poll not implemented by fs? */
472 /** Do multi-page cached writes */
473 unsigned big_writes:1;
475 /** Don't apply umask to creation modes */
476 unsigned dont_mask:1;
478 /** Are BSD file locking primitives not implemented by fs? */
481 /** Is fallocate not implemented by fs? */
482 unsigned no_fallocate:1;
484 /** The number of requests waiting for completion */
485 atomic_t num_waiting;
487 /** Negotiated minor version */
490 /** Backing dev info */
491 struct backing_dev_info bdi;
493 /** Entry on the fuse_conn_list */
494 struct list_head entry;
496 /** Device ID from super block */
499 /** Dentries in the control filesystem */
500 struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
502 /** number of dentries used in the above array */
505 /** O_ASYNC requests */
506 struct fasync_struct *fasync;
508 /** Key for lock owner ID scrambling */
511 /** Reserved request for the DESTROY message */
512 struct fuse_req *destroy_req;
514 /** Version counter for attribute changes */
517 /** Called on final put */
518 void (*release)(struct fuse_conn *);
520 /** Super block for this connection. */
521 struct super_block *sb;
523 /** Read/write semaphore to hold when accessing sb. */
524 struct rw_semaphore killsb;
527 static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
529 return sb->s_fs_info;
532 static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
534 return get_fuse_conn_super(inode->i_sb);
537 static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
539 return container_of(inode, struct fuse_inode, inode);
542 static inline u64 get_node_id(struct inode *inode)
544 return get_fuse_inode(inode)->nodeid;
547 /** Device operations */
548 extern const struct file_operations fuse_dev_operations;
550 extern const struct dentry_operations fuse_dentry_operations;
553 * Inode to nodeid comparison.
555 int fuse_inode_eq(struct inode *inode, void *_nodeidp);
558 * Get a filled in inode
560 struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
561 int generation, struct fuse_attr *attr,
562 u64 attr_valid, u64 attr_version);
564 int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
565 struct fuse_entry_out *outarg, struct inode **inode);
568 * Send FORGET command
570 void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
571 u64 nodeid, u64 nlookup);
573 struct fuse_forget_link *fuse_alloc_forget(void);
576 * Initialize READ or READDIR request
578 void fuse_read_fill(struct fuse_req *req, struct file *file,
579 loff_t pos, size_t count, int opcode);
582 * Send OPEN or OPENDIR request
584 int fuse_open_common(struct inode *inode, struct file *file, bool isdir);
586 struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
587 struct fuse_file *fuse_file_get(struct fuse_file *ff);
588 void fuse_file_free(struct fuse_file *ff);
589 void fuse_finish_open(struct inode *inode, struct file *file);
591 void fuse_sync_release(struct fuse_file *ff, int flags);
594 * Send RELEASE or RELEASEDIR request
596 void fuse_release_common(struct file *file, int opcode);
599 * Send FSYNC or FSYNCDIR request
601 int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
602 int datasync, int isdir);
607 int fuse_notify_poll_wakeup(struct fuse_conn *fc,
608 struct fuse_notify_poll_wakeup_out *outarg);
611 * Initialize file operations on a regular file
613 void fuse_init_file_inode(struct inode *inode);
616 * Initialize inode operations on regular files and special files
618 void fuse_init_common(struct inode *inode);
621 * Initialize inode and file operations on a directory
623 void fuse_init_dir(struct inode *inode);
626 * Initialize inode operations on a symlink
628 void fuse_init_symlink(struct inode *inode);
631 * Change attributes of an inode
633 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
634 u64 attr_valid, u64 attr_version);
636 void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
640 * Initialize the client device
642 int fuse_dev_init(void);
645 * Cleanup the client device
647 void fuse_dev_cleanup(void);
649 int fuse_ctl_init(void);
650 void fuse_ctl_cleanup(void);
655 struct fuse_req *fuse_request_alloc(void);
657 struct fuse_req *fuse_request_alloc_nofs(void);
662 void fuse_request_free(struct fuse_req *req);
665 * Get a request, may fail with -ENOMEM
667 struct fuse_req *fuse_get_req(struct fuse_conn *fc);
670 * Gets a requests for a file operation, always succeeds
672 struct fuse_req *fuse_get_req_nofail(struct fuse_conn *fc, struct file *file);
675 * Decrement reference count of a request. If count goes to zero free
678 void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
681 * Send a request (synchronous)
683 void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
686 * Send a request in the background
688 void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
690 void fuse_request_send_background_locked(struct fuse_conn *fc,
691 struct fuse_req *req);
693 /* Abort all requests */
694 void fuse_abort_conn(struct fuse_conn *fc);
697 * Invalidate inode attributes
699 void fuse_invalidate_attr(struct inode *inode);
701 void fuse_invalidate_entry_cache(struct dentry *entry);
704 * Acquire reference to fuse_conn
706 struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
708 void fuse_conn_kill(struct fuse_conn *fc);
711 * Initialize fuse_conn
713 void fuse_conn_init(struct fuse_conn *fc);
716 * Release reference to fuse_conn
718 void fuse_conn_put(struct fuse_conn *fc);
721 * Add connection to control filesystem
723 int fuse_ctl_add_conn(struct fuse_conn *fc);
726 * Remove connection from control filesystem
728 void fuse_ctl_remove_conn(struct fuse_conn *fc);
731 * Is file type valid?
733 int fuse_valid_type(int m);
736 * Is task allowed to perform filesystem operation?
738 int fuse_allow_task(struct fuse_conn *fc, struct task_struct *task);
740 u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
742 int fuse_update_attributes(struct inode *inode, struct kstat *stat,
743 struct file *file, bool *refreshed);
745 void fuse_flush_writepages(struct inode *inode);
747 void fuse_set_nowrite(struct inode *inode);
748 void fuse_release_nowrite(struct inode *inode);
750 u64 fuse_get_attr_version(struct fuse_conn *fc);
753 * File-system tells the kernel to invalidate cache for the given node id.
755 int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid,
756 loff_t offset, loff_t len);
759 * File-system tells the kernel to invalidate parent attributes and
760 * the dentry matching parent/name.
762 * If the child_nodeid is non-zero and:
763 * - matches the inode number for the dentry matching parent/name,
764 * - is not a mount point
765 * - is a file or oan empty directory
766 * then the dentry is unhashed (d_delete()).
768 int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
769 u64 child_nodeid, struct qstr *name);
771 int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
773 ssize_t fuse_direct_io(struct file *file, const char __user *buf,
774 size_t count, loff_t *ppos, int write);
775 long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
777 long fuse_ioctl_common(struct file *file, unsigned int cmd,
778 unsigned long arg, unsigned int flags);
779 unsigned fuse_file_poll(struct file *file, poll_table *wait);
780 int fuse_dev_release(struct inode *inode, struct file *file);
782 void fuse_write_update_size(struct inode *inode, loff_t pos);
784 #endif /* _FS_FUSE_I_H */