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