2 FUSE: Filesystem in Userspace
3 Copyright (C) 2001-2006 Miklos Szeredi <miklos@szeredi.hu>
5 This program can be distributed under the terms of the GNU GPL.
9 #include <linux/fuse.h>
11 #include <linux/mount.h>
12 #include <linux/wait.h>
13 #include <linux/list.h>
14 #include <linux/spinlock.h>
16 #include <linux/backing-dev.h>
17 #include <linux/mutex.h>
19 /** Max number of pages that can be used in a single read request */
20 #define FUSE_MAX_PAGES_PER_REQ 32
22 /** Maximum number of outstanding background requests */
23 #define FUSE_MAX_BACKGROUND 12
25 /** Congestion starts at 75% of maximum */
26 #define FUSE_CONGESTION_THRESHOLD (FUSE_MAX_BACKGROUND * 75 / 100)
28 /** It could be as large as PATH_MAX, but would that have any uses? */
29 #define FUSE_NAME_MAX 1024
31 /** Number of dentries for each connection in the control filesystem */
32 #define FUSE_CTL_NUM_DENTRIES 3
34 /** If the FUSE_DEFAULT_PERMISSIONS flag is given, the filesystem
35 module will check permissions based on the file mode. Otherwise no
36 permission checking is done in the kernel */
37 #define FUSE_DEFAULT_PERMISSIONS (1 << 0)
39 /** If the FUSE_ALLOW_OTHER flag is given, then not only the user
40 doing the mount will be allowed to access the filesystem */
41 #define FUSE_ALLOW_OTHER (1 << 1)
43 /** List of active connections */
44 extern struct list_head fuse_conn_list;
46 /** Global mutex protecting fuse_conn_list and the control filesystem */
47 extern struct mutex fuse_mutex;
54 /** Unique ID, which identifies the inode between userspace
58 /** Number of lookups on this inode */
61 /** The request used for sending the FORGET message */
62 struct fuse_req *forget_req;
64 /** Time in jiffies until the file attributes are valid */
67 /** The sticky bit in inode->i_mode may have been removed, so
68 preserve the original mode */
71 /** Version of last attribute change */
74 /** Files usable in writepage. Protected by fc->lock */
75 struct list_head write_files;
78 /** FUSE specific file data */
80 /** Request reserved for flush and release */
81 struct fuse_req *reserved_req;
83 /** File handle used by userspace */
89 /** Entry on inode's write_files list */
90 struct list_head write_entry;
93 /** One input argument of a request */
99 /** The request input */
101 /** The request header */
102 struct fuse_in_header h;
104 /** True if the data for the last argument is in req->pages */
107 /** Number of arguments */
110 /** Array of arguments */
111 struct fuse_in_arg args[3];
114 /** One output argument of a request */
120 /** The request output */
122 /** Header returned from userspace */
123 struct fuse_out_header h;
126 * The following bitfields are not changed during the request
130 /** Last argument is variable length (can be shorter than
134 /** Last argument is a list of pages to copy data to */
137 /** Zero partially or not copied pages */
138 unsigned page_zeroing:1;
140 /** Number or arguments */
143 /** Array of arguments */
144 struct fuse_arg args[3];
147 /** The request state */
148 enum fuse_req_state {
160 * A request to the client
163 /** This can be on either pending processing or io lists in
165 struct list_head list;
167 /** Entry on the interrupts list */
168 struct list_head intr_entry;
173 /** Unique ID for the interrupt request */
177 * The following bitfields are either set once before the
178 * request is queued or setting/clearing them is protected by
182 /** True if the request has reply */
185 /** Force sending of the request even if interrupted */
188 /** The request was aborted */
191 /** Request is sent in the background */
192 unsigned background:1;
194 /** The request has been interrupted */
195 unsigned interrupted:1;
197 /** Data is being copied to/from the request */
200 /** Request is counted as "waiting" */
203 /** State of the request */
204 enum fuse_req_state state;
206 /** The request input */
209 /** The request output */
212 /** Used to wake up the task waiting for completion of request*/
213 wait_queue_head_t waitq;
215 /** Data for asynchronous requests */
217 struct fuse_forget_in forget_in;
219 struct fuse_release_in in;
220 struct vfsmount *vfsmount;
221 struct dentry *dentry;
223 struct fuse_init_in init_in;
224 struct fuse_init_out init_out;
225 struct fuse_read_in read_in;
227 struct fuse_write_in in;
228 struct fuse_write_out out;
230 struct fuse_lk_in lk_in;
234 struct page *pages[FUSE_MAX_PAGES_PER_REQ];
236 /** number of pages in vector */
239 /** offset of data on first page */
240 unsigned page_offset;
242 /** File used in the request (or NULL) */
243 struct fuse_file *ff;
245 /** Request completion callback */
246 void (*end)(struct fuse_conn *, struct fuse_req *);
248 /** Request is stolen from fuse_file->reserved_req */
249 struct file *stolen_file;
255 * This structure is created, when the filesystem is mounted, and is
256 * destroyed, when the client device is closed and the filesystem is
260 /** Lock protecting accessess to members of this structure */
263 /** Mutex protecting against directory alias creation */
264 struct mutex inst_mutex;
269 /** The user id for this mount */
272 /** The group id for this mount */
275 /** The fuse mount flags for this mount */
278 /** Maximum read size */
281 /** Maximum write size */
284 /** Readers of the connection are waiting on this */
285 wait_queue_head_t waitq;
287 /** The list of pending requests */
288 struct list_head pending;
290 /** The list of requests being processed */
291 struct list_head processing;
293 /** The list of requests under I/O */
296 /** Number of requests currently in the background */
297 unsigned num_background;
299 /** Pending interrupts */
300 struct list_head interrupts;
302 /** Flag indicating if connection is blocked. This will be
303 the case before the INIT reply is received, and if there
304 are too many outstading backgrounds requests */
307 /** waitq for blocked connection */
308 wait_queue_head_t blocked_waitq;
310 /** waitq for reserved requests */
311 wait_queue_head_t reserved_req_waitq;
313 /** The next unique request id */
316 /** Connection established, cleared on umount, connection
317 abort and device release */
320 /** Connection failed (version mismatch). Cannot race with
321 setting other bitfields since it is only set once in INIT
322 reply, before any other request, and never cleared */
323 unsigned conn_error : 1;
325 /** Connection successful. Only set in INIT */
326 unsigned conn_init : 1;
328 /** Do readpages asynchronously? Only set in INIT */
329 unsigned async_read : 1;
331 /** Do not send separate SETATTR request before open(O_TRUNC) */
332 unsigned atomic_o_trunc : 1;
335 * The following bitfields are only for optimization purposes
336 * and hence races in setting them will not cause malfunction
339 /** Is fsync not implemented by fs? */
340 unsigned no_fsync : 1;
342 /** Is fsyncdir not implemented by fs? */
343 unsigned no_fsyncdir : 1;
345 /** Is flush not implemented by fs? */
346 unsigned no_flush : 1;
348 /** Is setxattr not implemented by fs? */
349 unsigned no_setxattr : 1;
351 /** Is getxattr not implemented by fs? */
352 unsigned no_getxattr : 1;
354 /** Is listxattr not implemented by fs? */
355 unsigned no_listxattr : 1;
357 /** Is removexattr not implemented by fs? */
358 unsigned no_removexattr : 1;
360 /** Are file locking primitives not implemented by fs? */
361 unsigned no_lock : 1;
363 /** Is access not implemented by fs? */
364 unsigned no_access : 1;
366 /** Is create not implemented by fs? */
367 unsigned no_create : 1;
369 /** Is interrupt not implemented by fs? */
370 unsigned no_interrupt : 1;
372 /** Is bmap not implemented by fs? */
373 unsigned no_bmap : 1;
375 /** The number of requests waiting for completion */
376 atomic_t num_waiting;
378 /** Negotiated minor version */
381 /** Backing dev info */
382 struct backing_dev_info bdi;
384 /** Entry on the fuse_conn_list */
385 struct list_head entry;
390 /** Dentries in the control filesystem */
391 struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
393 /** number of dentries used in the above array */
396 /** O_ASYNC requests */
397 struct fasync_struct *fasync;
399 /** Key for lock owner ID scrambling */
402 /** Reserved request for the DESTROY message */
403 struct fuse_req *destroy_req;
405 /** Version counter for attribute changes */
409 static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
411 return sb->s_fs_info;
414 static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
416 return get_fuse_conn_super(inode->i_sb);
419 static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
421 return container_of(inode, struct fuse_inode, inode);
424 static inline u64 get_node_id(struct inode *inode)
426 return get_fuse_inode(inode)->nodeid;
429 /** Device operations */
430 extern const struct file_operations fuse_dev_operations;
433 * Get a filled in inode
435 struct inode *fuse_iget(struct super_block *sb, unsigned long nodeid,
436 int generation, struct fuse_attr *attr,
437 u64 attr_valid, u64 attr_version);
440 * Send FORGET command
442 void fuse_send_forget(struct fuse_conn *fc, struct fuse_req *req,
443 unsigned long nodeid, u64 nlookup);
446 * Initialize READ or READDIR request
448 void fuse_read_fill(struct fuse_req *req, struct file *file,
449 struct inode *inode, loff_t pos, size_t count, int opcode);
452 * Send OPEN or OPENDIR request
454 int fuse_open_common(struct inode *inode, struct file *file, int isdir);
456 struct fuse_file *fuse_file_alloc(void);
457 void fuse_file_free(struct fuse_file *ff);
458 void fuse_finish_open(struct inode *inode, struct file *file,
459 struct fuse_file *ff, struct fuse_open_out *outarg);
461 /** Fill in ff->reserved_req with a RELEASE request */
462 void fuse_release_fill(struct fuse_file *ff, u64 nodeid, int flags, int opcode);
465 * Send RELEASE or RELEASEDIR request
467 int fuse_release_common(struct inode *inode, struct file *file, int isdir);
470 * Send FSYNC or FSYNCDIR request
472 int fuse_fsync_common(struct file *file, struct dentry *de, int datasync,
476 * Initialize file operations on a regular file
478 void fuse_init_file_inode(struct inode *inode);
481 * Initialize inode operations on regular files and special files
483 void fuse_init_common(struct inode *inode);
486 * Initialize inode and file operations on a directory
488 void fuse_init_dir(struct inode *inode);
491 * Initialize inode operations on a symlink
493 void fuse_init_symlink(struct inode *inode);
496 * Change attributes of an inode
498 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
499 u64 attr_valid, u64 attr_version);
502 * Initialize the client device
504 int fuse_dev_init(void);
507 * Cleanup the client device
509 void fuse_dev_cleanup(void);
511 int fuse_ctl_init(void);
512 void fuse_ctl_cleanup(void);
517 struct fuse_req *fuse_request_alloc(void);
522 void fuse_request_free(struct fuse_req *req);
525 * Get a request, may fail with -ENOMEM
527 struct fuse_req *fuse_get_req(struct fuse_conn *fc);
530 * Gets a requests for a file operation, always succeeds
532 struct fuse_req *fuse_get_req_nofail(struct fuse_conn *fc, struct file *file);
535 * Decrement reference count of a request. If count goes to zero free
538 void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
541 * Send a request (synchronous)
543 void request_send(struct fuse_conn *fc, struct fuse_req *req);
546 * Send a request with no reply
548 void request_send_noreply(struct fuse_conn *fc, struct fuse_req *req);
551 * Send a request in the background
553 void request_send_background(struct fuse_conn *fc, struct fuse_req *req);
555 /* Abort all requests */
556 void fuse_abort_conn(struct fuse_conn *fc);
559 * Invalidate inode attributes
561 void fuse_invalidate_attr(struct inode *inode);
564 * Acquire reference to fuse_conn
566 struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
569 * Release reference to fuse_conn
571 void fuse_conn_put(struct fuse_conn *fc);
574 * Add connection to control filesystem
576 int fuse_ctl_add_conn(struct fuse_conn *fc);
579 * Remove connection from control filesystem
581 void fuse_ctl_remove_conn(struct fuse_conn *fc);
584 * Is file type valid?
586 int fuse_valid_type(int m);
589 * Is task allowed to perform filesystem operation?
591 int fuse_allow_task(struct fuse_conn *fc, struct task_struct *task);
593 u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
595 int fuse_update_attributes(struct inode *inode, struct kstat *stat,
596 struct file *file, bool *refreshed);