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