146317ff81b9b2cbc9d469655eaf641ed99abfad
[linux-3.10.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
25 /** Max number of pages that can be used in a single read request */
26 #define FUSE_MAX_PAGES_PER_REQ 32
27
28 /** Maximum number of outstanding background requests */
29 #define FUSE_MAX_BACKGROUND 12
30
31 /** Congestion starts at 75% of maximum */
32 #define FUSE_CONGESTION_THRESHOLD (FUSE_MAX_BACKGROUND * 75 / 100)
33
34 /** Bias for fi->writectr, meaning new writepages must not be sent */
35 #define FUSE_NOWRITE INT_MIN
36
37 /** It could be as large as PATH_MAX, but would that have any uses? */
38 #define FUSE_NAME_MAX 1024
39
40 /** Number of dentries for each connection in the control filesystem */
41 #define FUSE_CTL_NUM_DENTRIES 3
42
43 /** If the FUSE_DEFAULT_PERMISSIONS flag is given, the filesystem
44     module will check permissions based on the file mode.  Otherwise no
45     permission checking is done in the kernel */
46 #define FUSE_DEFAULT_PERMISSIONS (1 << 0)
47
48 /** If the FUSE_ALLOW_OTHER flag is given, then not only the user
49     doing the mount will be allowed to access the filesystem */
50 #define FUSE_ALLOW_OTHER         (1 << 1)
51
52 /** List of active connections */
53 extern struct list_head fuse_conn_list;
54
55 /** Global mutex protecting fuse_conn_list and the control filesystem */
56 extern struct mutex fuse_mutex;
57
58 /** FUSE inode */
59 struct fuse_inode {
60         /** Inode data */
61         struct inode inode;
62
63         /** Unique ID, which identifies the inode between userspace
64          * and kernel */
65         u64 nodeid;
66
67         /** Number of lookups on this inode */
68         u64 nlookup;
69
70         /** The request used for sending the FORGET message */
71         struct fuse_req *forget_req;
72
73         /** Time in jiffies until the file attributes are valid */
74         u64 i_time;
75
76         /** The sticky bit in inode->i_mode may have been removed, so
77             preserve the original mode */
78         mode_t orig_i_mode;
79
80         /** Version of last attribute change */
81         u64 attr_version;
82
83         /** Files usable in writepage.  Protected by fc->lock */
84         struct list_head write_files;
85
86         /** Writepages pending on truncate or fsync */
87         struct list_head queued_writes;
88
89         /** Number of sent writes, a negative bias (FUSE_NOWRITE)
90          * means more writes are blocked */
91         int writectr;
92
93         /** Waitq for writepage completion */
94         wait_queue_head_t page_waitq;
95
96         /** List of writepage requestst (pending or sent) */
97         struct list_head writepages;
98 };
99
100 /** FUSE specific file data */
101 struct fuse_file {
102         /** Request reserved for flush and release */
103         struct fuse_req *reserved_req;
104
105         /** Kernel file handle guaranteed to be unique */
106         u64 kh;
107
108         /** File handle used by userspace */
109         u64 fh;
110
111         /** Refcount */
112         atomic_t count;
113
114         /** Entry on inode's write_files list */
115         struct list_head write_entry;
116
117         /** RB node to be linked on fuse_conn->polled_files */
118         struct rb_node polled_node;
119
120         /** Wait queue head for poll */
121         wait_queue_head_t poll_wait;
122 };
123
124 /** One input argument of a request */
125 struct fuse_in_arg {
126         unsigned size;
127         const void *value;
128 };
129
130 /** The request input */
131 struct fuse_in {
132         /** The request header */
133         struct fuse_in_header h;
134
135         /** True if the data for the last argument is in req->pages */
136         unsigned argpages:1;
137
138         /** Number of arguments */
139         unsigned numargs;
140
141         /** Array of arguments */
142         struct fuse_in_arg args[3];
143 };
144
145 /** One output argument of a request */
146 struct fuse_arg {
147         unsigned size;
148         void *value;
149 };
150
151 /** The request output */
152 struct fuse_out {
153         /** Header returned from userspace */
154         struct fuse_out_header h;
155
156         /*
157          * The following bitfields are not changed during the request
158          * processing
159          */
160
161         /** Last argument is variable length (can be shorter than
162             arg->size) */
163         unsigned argvar:1;
164
165         /** Last argument is a list of pages to copy data to */
166         unsigned argpages:1;
167
168         /** Zero partially or not copied pages */
169         unsigned page_zeroing:1;
170
171         /** Number or arguments */
172         unsigned numargs;
173
174         /** Array of arguments */
175         struct fuse_arg args[3];
176 };
177
178 /** The request state */
179 enum fuse_req_state {
180         FUSE_REQ_INIT = 0,
181         FUSE_REQ_PENDING,
182         FUSE_REQ_READING,
183         FUSE_REQ_SENT,
184         FUSE_REQ_WRITING,
185         FUSE_REQ_FINISHED
186 };
187
188 struct fuse_conn;
189
190 /**
191  * A request to the client
192  */
193 struct fuse_req {
194         /** This can be on either pending processing or io lists in
195             fuse_conn */
196         struct list_head list;
197
198         /** Entry on the interrupts list  */
199         struct list_head intr_entry;
200
201         /** refcount */
202         atomic_t count;
203
204         /** Unique ID for the interrupt request */
205         u64 intr_unique;
206
207         /*
208          * The following bitfields are either set once before the
209          * request is queued or setting/clearing them is protected by
210          * fuse_conn->lock
211          */
212
213         /** True if the request has reply */
214         unsigned isreply:1;
215
216         /** Force sending of the request even if interrupted */
217         unsigned force:1;
218
219         /** The request was aborted */
220         unsigned aborted:1;
221
222         /** Request is sent in the background */
223         unsigned background:1;
224
225         /** The request has been interrupted */
226         unsigned interrupted:1;
227
228         /** Data is being copied to/from the request */
229         unsigned locked:1;
230
231         /** Request is counted as "waiting" */
232         unsigned waiting:1;
233
234         /** State of the request */
235         enum fuse_req_state state;
236
237         /** The request input */
238         struct fuse_in in;
239
240         /** The request output */
241         struct fuse_out out;
242
243         /** Used to wake up the task waiting for completion of request*/
244         wait_queue_head_t waitq;
245
246         /** Data for asynchronous requests */
247         union {
248                 struct fuse_forget_in forget_in;
249                 struct {
250                         struct fuse_release_in in;
251                         struct path path;
252                 } release;
253                 struct fuse_init_in init_in;
254                 struct fuse_init_out init_out;
255                 struct {
256                         struct fuse_read_in in;
257                         u64 attr_ver;
258                 } read;
259                 struct {
260                         struct fuse_write_in in;
261                         struct fuse_write_out out;
262                 } write;
263                 struct fuse_lk_in lk_in;
264         } misc;
265
266         /** page vector */
267         struct page *pages[FUSE_MAX_PAGES_PER_REQ];
268
269         /** number of pages in vector */
270         unsigned num_pages;
271
272         /** offset of data on first page */
273         unsigned page_offset;
274
275         /** File used in the request (or NULL) */
276         struct fuse_file *ff;
277
278         /** Inode used in the request or NULL */
279         struct inode *inode;
280
281         /** Link on fi->writepages */
282         struct list_head writepages_entry;
283
284         /** Request completion callback */
285         void (*end)(struct fuse_conn *, struct fuse_req *);
286
287         /** Request is stolen from fuse_file->reserved_req */
288         struct file *stolen_file;
289 };
290
291 /**
292  * A Fuse connection.
293  *
294  * This structure is created, when the filesystem is mounted, and is
295  * destroyed, when the client device is closed and the filesystem is
296  * unmounted.
297  */
298 struct fuse_conn {
299         /** Lock protecting accessess to  members of this structure */
300         spinlock_t lock;
301
302         /** Mutex protecting against directory alias creation */
303         struct mutex inst_mutex;
304
305         /** Refcount */
306         atomic_t count;
307
308         /** The user id for this mount */
309         uid_t user_id;
310
311         /** The group id for this mount */
312         gid_t group_id;
313
314         /** The fuse mount flags for this mount */
315         unsigned flags;
316
317         /** Maximum read size */
318         unsigned max_read;
319
320         /** Maximum write size */
321         unsigned max_write;
322
323         /** Readers of the connection are waiting on this */
324         wait_queue_head_t waitq;
325
326         /** The list of pending requests */
327         struct list_head pending;
328
329         /** The list of requests being processed */
330         struct list_head processing;
331
332         /** The list of requests under I/O */
333         struct list_head io;
334
335         /** The next unique kernel file handle */
336         u64 khctr;
337
338         /** rbtree of fuse_files waiting for poll events indexed by ph */
339         struct rb_root polled_files;
340
341         /** Number of requests currently in the background */
342         unsigned num_background;
343
344         /** Number of background requests currently queued for userspace */
345         unsigned active_background;
346
347         /** The list of background requests set aside for later queuing */
348         struct list_head bg_queue;
349
350         /** Pending interrupts */
351         struct list_head interrupts;
352
353         /** Flag indicating if connection is blocked.  This will be
354             the case before the INIT reply is received, and if there
355             are too many outstading backgrounds requests */
356         int blocked;
357
358         /** waitq for blocked connection */
359         wait_queue_head_t blocked_waitq;
360
361         /** waitq for reserved requests */
362         wait_queue_head_t reserved_req_waitq;
363
364         /** The next unique request id */
365         u64 reqctr;
366
367         /** Connection established, cleared on umount, connection
368             abort and device release */
369         unsigned connected;
370
371         /** Connection failed (version mismatch).  Cannot race with
372             setting other bitfields since it is only set once in INIT
373             reply, before any other request, and never cleared */
374         unsigned conn_error:1;
375
376         /** Connection successful.  Only set in INIT */
377         unsigned conn_init:1;
378
379         /** Do readpages asynchronously?  Only set in INIT */
380         unsigned async_read:1;
381
382         /** Do not send separate SETATTR request before open(O_TRUNC)  */
383         unsigned atomic_o_trunc:1;
384
385         /** Filesystem supports NFS exporting.  Only set in INIT */
386         unsigned export_support:1;
387
388         /*
389          * The following bitfields are only for optimization purposes
390          * and hence races in setting them will not cause malfunction
391          */
392
393         /** Is fsync not implemented by fs? */
394         unsigned no_fsync:1;
395
396         /** Is fsyncdir not implemented by fs? */
397         unsigned no_fsyncdir:1;
398
399         /** Is flush not implemented by fs? */
400         unsigned no_flush:1;
401
402         /** Is setxattr not implemented by fs? */
403         unsigned no_setxattr:1;
404
405         /** Is getxattr not implemented by fs? */
406         unsigned no_getxattr:1;
407
408         /** Is listxattr not implemented by fs? */
409         unsigned no_listxattr:1;
410
411         /** Is removexattr not implemented by fs? */
412         unsigned no_removexattr:1;
413
414         /** Are file locking primitives not implemented by fs? */
415         unsigned no_lock:1;
416
417         /** Is access not implemented by fs? */
418         unsigned no_access:1;
419
420         /** Is create not implemented by fs? */
421         unsigned no_create:1;
422
423         /** Is interrupt not implemented by fs? */
424         unsigned no_interrupt:1;
425
426         /** Is bmap not implemented by fs? */
427         unsigned no_bmap:1;
428
429         /** Is poll not implemented by fs? */
430         unsigned no_poll:1;
431
432         /** Do multi-page cached writes */
433         unsigned big_writes:1;
434
435         /** The number of requests waiting for completion */
436         atomic_t num_waiting;
437
438         /** Negotiated minor version */
439         unsigned minor;
440
441         /** Backing dev info */
442         struct backing_dev_info bdi;
443
444         /** Entry on the fuse_conn_list */
445         struct list_head entry;
446
447         /** Device ID from super block */
448         dev_t dev;
449
450         /** Dentries in the control filesystem */
451         struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
452
453         /** number of dentries used in the above array */
454         int ctl_ndents;
455
456         /** O_ASYNC requests */
457         struct fasync_struct *fasync;
458
459         /** Key for lock owner ID scrambling */
460         u32 scramble_key[4];
461
462         /** Reserved request for the DESTROY message */
463         struct fuse_req *destroy_req;
464
465         /** Version counter for attribute changes */
466         u64 attr_version;
467
468         /** Called on final put */
469         void (*release)(struct fuse_conn *);
470 };
471
472 static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
473 {
474         return sb->s_fs_info;
475 }
476
477 static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
478 {
479         return get_fuse_conn_super(inode->i_sb);
480 }
481
482 static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
483 {
484         return container_of(inode, struct fuse_inode, inode);
485 }
486
487 static inline u64 get_node_id(struct inode *inode)
488 {
489         return get_fuse_inode(inode)->nodeid;
490 }
491
492 /** Device operations */
493 extern const struct file_operations fuse_dev_operations;
494
495 extern const struct dentry_operations fuse_dentry_operations;
496
497 /**
498  * Get a filled in inode
499  */
500 struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
501                         int generation, struct fuse_attr *attr,
502                         u64 attr_valid, u64 attr_version);
503
504 int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
505                      struct fuse_entry_out *outarg, struct inode **inode);
506
507 /**
508  * Send FORGET command
509  */
510 void fuse_send_forget(struct fuse_conn *fc, struct fuse_req *req,
511                       u64 nodeid, u64 nlookup);
512
513 /**
514  * Initialize READ or READDIR request
515  */
516 void fuse_read_fill(struct fuse_req *req, struct file *file,
517                     struct inode *inode, loff_t pos, size_t count, int opcode);
518
519 /**
520  * Send OPEN or OPENDIR request
521  */
522 int fuse_open_common(struct inode *inode, struct file *file, int isdir);
523
524 struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
525 void fuse_file_free(struct fuse_file *ff);
526 void fuse_finish_open(struct inode *inode, struct file *file,
527                       struct fuse_file *ff, struct fuse_open_out *outarg);
528
529 /** Fill in ff->reserved_req with a RELEASE request */
530 void fuse_release_fill(struct fuse_file *ff, u64 nodeid, int flags, int opcode);
531
532 /**
533  * Send RELEASE or RELEASEDIR request
534  */
535 int fuse_release_common(struct inode *inode, struct file *file, int isdir);
536
537 /**
538  * Send FSYNC or FSYNCDIR request
539  */
540 int fuse_fsync_common(struct file *file, struct dentry *de, int datasync,
541                       int isdir);
542
543 /**
544  * Notify poll wakeup
545  */
546 int fuse_notify_poll_wakeup(struct fuse_conn *fc,
547                             struct fuse_notify_poll_wakeup_out *outarg);
548
549 /**
550  * Initialize file operations on a regular file
551  */
552 void fuse_init_file_inode(struct inode *inode);
553
554 /**
555  * Initialize inode operations on regular files and special files
556  */
557 void fuse_init_common(struct inode *inode);
558
559 /**
560  * Initialize inode and file operations on a directory
561  */
562 void fuse_init_dir(struct inode *inode);
563
564 /**
565  * Initialize inode operations on a symlink
566  */
567 void fuse_init_symlink(struct inode *inode);
568
569 /**
570  * Change attributes of an inode
571  */
572 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
573                             u64 attr_valid, u64 attr_version);
574
575 void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
576                                    u64 attr_valid);
577
578 void fuse_truncate(struct address_space *mapping, loff_t offset);
579
580 /**
581  * Initialize the client device
582  */
583 int fuse_dev_init(void);
584
585 /**
586  * Cleanup the client device
587  */
588 void fuse_dev_cleanup(void);
589
590 int fuse_ctl_init(void);
591 void fuse_ctl_cleanup(void);
592
593 /**
594  * Allocate a request
595  */
596 struct fuse_req *fuse_request_alloc(void);
597
598 struct fuse_req *fuse_request_alloc_nofs(void);
599
600 /**
601  * Free a request
602  */
603 void fuse_request_free(struct fuse_req *req);
604
605 /**
606  * Get a request, may fail with -ENOMEM
607  */
608 struct fuse_req *fuse_get_req(struct fuse_conn *fc);
609
610 /**
611  * Gets a requests for a file operation, always succeeds
612  */
613 struct fuse_req *fuse_get_req_nofail(struct fuse_conn *fc, struct file *file);
614
615 /**
616  * Decrement reference count of a request.  If count goes to zero free
617  * the request.
618  */
619 void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
620
621 /**
622  * Send a request (synchronous)
623  */
624 void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
625
626 /**
627  * Send a request with no reply
628  */
629 void fuse_request_send_noreply(struct fuse_conn *fc, struct fuse_req *req);
630
631 /**
632  * Send a request in the background
633  */
634 void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
635
636 void fuse_request_send_background_locked(struct fuse_conn *fc,
637                                          struct fuse_req *req);
638
639 /* Abort all requests */
640 void fuse_abort_conn(struct fuse_conn *fc);
641
642 /**
643  * Invalidate inode attributes
644  */
645 void fuse_invalidate_attr(struct inode *inode);
646
647 void fuse_invalidate_entry_cache(struct dentry *entry);
648
649 /**
650  * Acquire reference to fuse_conn
651  */
652 struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
653
654 /**
655  * Initialize fuse_conn
656  */
657 int fuse_conn_init(struct fuse_conn *fc, struct super_block *sb);
658
659 /**
660  * Release reference to fuse_conn
661  */
662 void fuse_conn_put(struct fuse_conn *fc);
663
664 /**
665  * Add connection to control filesystem
666  */
667 int fuse_ctl_add_conn(struct fuse_conn *fc);
668
669 /**
670  * Remove connection from control filesystem
671  */
672 void fuse_ctl_remove_conn(struct fuse_conn *fc);
673
674 /**
675  * Is file type valid?
676  */
677 int fuse_valid_type(int m);
678
679 /**
680  * Is task allowed to perform filesystem operation?
681  */
682 int fuse_allow_task(struct fuse_conn *fc, struct task_struct *task);
683
684 u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
685
686 int fuse_update_attributes(struct inode *inode, struct kstat *stat,
687                            struct file *file, bool *refreshed);
688
689 void fuse_flush_writepages(struct inode *inode);
690
691 void fuse_set_nowrite(struct inode *inode);
692 void fuse_release_nowrite(struct inode *inode);
693
694 u64 fuse_get_attr_version(struct fuse_conn *fc);
695
696 #endif /* _FS_FUSE_I_H */