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