]> Git Repo - linux.git/blame - fs/fuse/fuse_i.h
fuse: Support fuse filesystems outside of init_user_ns
[linux.git] / fs / fuse / fuse_i.h
CommitLineData
d8a5ba45
MS
1/*
2 FUSE: Filesystem in Userspace
1729a16c 3 Copyright (C) 2001-2008 Miklos Szeredi <[email protected]>
d8a5ba45
MS
4
5 This program can be distributed under the terms of the GNU GPL.
6 See the file COPYING.
7*/
8
29d434b3
TH
9#ifndef _FS_FUSE_I_H
10#define _FS_FUSE_I_H
11
d8a5ba45
MS
12#include <linux/fuse.h>
13#include <linux/fs.h>
51eb01e7 14#include <linux/mount.h>
d8a5ba45
MS
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>
bafa9654 20#include <linux/mutex.h>
3be5a52b 21#include <linux/rwsem.h>
95668a69
TH
22#include <linux/rbtree.h>
23#include <linux/poll.h>
5a18ec17 24#include <linux/workqueue.h>
744742d6 25#include <linux/kref.h>
60bcc88a 26#include <linux/xattr.h>
0b6e9ea0 27#include <linux/pid_namespace.h>
4e8c2eb5 28#include <linux/refcount.h>
8cb08329 29#include <linux/user_namespace.h>
d8a5ba45 30
334f485d
MS
31/** Max number of pages that can be used in a single read request */
32#define FUSE_MAX_PAGES_PER_REQ 32
33
3be5a52b
MS
34/** Bias for fi->writectr, meaning new writepages must not be sent */
35#define FUSE_NOWRITE INT_MIN
36
1d3d752b
MS
37/** It could be as large as PATH_MAX, but would that have any uses? */
38#define FUSE_NAME_MAX 1024
39
bafa9654 40/** Number of dentries for each connection in the control filesystem */
79a9d994 41#define FUSE_CTL_NUM_DENTRIES 5
bafa9654 42
4250c066
MP
43/** Number of page pointers embedded in fuse_req */
44#define FUSE_REQ_INLINE_PAGES 1
45
bafa9654
MS
46/** List of active connections */
47extern struct list_head fuse_conn_list;
48
49/** Global mutex protecting fuse_conn_list and the control filesystem */
50extern struct mutex fuse_mutex;
413ef8cb 51
79a9d994
CH
52/** Module parameters */
53extern unsigned max_user_bgreq;
54extern unsigned max_user_congthresh;
55
07e77dca
MS
56/* One forget request */
57struct fuse_forget_link {
02c048b9 58 struct fuse_forget_one forget_one;
07e77dca
MS
59 struct fuse_forget_link *next;
60};
61
d8a5ba45
MS
62/** FUSE inode */
63struct fuse_inode {
64 /** Inode data */
65 struct inode inode;
66
67 /** Unique ID, which identifies the inode between userspace
68 * and kernel */
69 u64 nodeid;
70
9e6268db
MS
71 /** Number of lookups on this inode */
72 u64 nlookup;
73
e5e5558e 74 /** The request used for sending the FORGET message */
07e77dca 75 struct fuse_forget_link *forget;
e5e5558e 76
d8a5ba45 77 /** Time in jiffies until the file attributes are valid */
0a0898cf 78 u64 i_time;
ebc14c4d
MS
79
80 /** The sticky bit in inode->i_mode may have been removed, so
81 preserve the original mode */
541af6a0 82 umode_t orig_i_mode;
1fb69e78 83
45c72cd7
PS
84 /** 64 bit inode number */
85 u64 orig_ino;
86
1fb69e78
MS
87 /** Version of last attribute change */
88 u64 attr_version;
93a8c3cd
MS
89
90 /** Files usable in writepage. Protected by fc->lock */
91 struct list_head write_files;
3be5a52b
MS
92
93 /** Writepages pending on truncate or fsync */
94 struct list_head queued_writes;
95
96 /** Number of sent writes, a negative bias (FUSE_NOWRITE)
97 * means more writes are blocked */
98 int writectr;
99
100 /** Waitq for writepage completion */
101 wait_queue_head_t page_waitq;
102
103 /** List of writepage requestst (pending or sent) */
104 struct list_head writepages;
4582a4ab
FS
105
106 /** Miscellaneous bits describing inode state */
107 unsigned long state;
5c672ab3
MS
108
109 /** Lock for serializing lookup and readdir for back compatibility*/
110 struct mutex mutex;
4582a4ab
FS
111};
112
113/** FUSE inode state bits */
114enum {
115 /** Advise readdirplus */
116 FUSE_I_ADVISE_RDPLUS,
6314efee
MS
117 /** Initialized with readdirplus */
118 FUSE_I_INIT_RDPLUS,
06a7c3c2
MP
119 /** An operation changing file size is in progress */
120 FUSE_I_SIZE_UNSTABLE,
d8a5ba45
MS
121};
122
da5e4714
MS
123struct fuse_conn;
124
b6aeaded
MS
125/** FUSE specific file data */
126struct fuse_file {
da5e4714
MS
127 /** Fuse connection for this file */
128 struct fuse_conn *fc;
129
b6aeaded 130 /** Request reserved for flush and release */
33649c91 131 struct fuse_req *reserved_req;
b6aeaded 132
acf99433
TH
133 /** Kernel file handle guaranteed to be unique */
134 u64 kh;
135
b6aeaded
MS
136 /** File handle used by userspace */
137 u64 fh;
c756e0a4 138
da5e4714
MS
139 /** Node id of this file */
140 u64 nodeid;
141
c756e0a4 142 /** Refcount */
4e8c2eb5 143 refcount_t count;
93a8c3cd 144
c7b7143c
MS
145 /** FOPEN_* flags returned by open */
146 u32 open_flags;
147
93a8c3cd
MS
148 /** Entry on inode's write_files list */
149 struct list_head write_entry;
95668a69
TH
150
151 /** RB node to be linked on fuse_conn->polled_files */
152 struct rb_node polled_node;
153
154 /** Wait queue head for poll */
155 wait_queue_head_t poll_wait;
37fb3a30
MS
156
157 /** Has flock been performed on this file? */
158 bool flock:1;
b6aeaded
MS
159};
160
334f485d
MS
161/** One input argument of a request */
162struct fuse_in_arg {
163 unsigned size;
164 const void *value;
165};
166
167/** The request input */
168struct fuse_in {
169 /** The request header */
170 struct fuse_in_header h;
171
172 /** True if the data for the last argument is in req->pages */
173 unsigned argpages:1;
174
175 /** Number of arguments */
176 unsigned numargs;
177
178 /** Array of arguments */
179 struct fuse_in_arg args[3];
180};
181
182/** One output argument of a request */
183struct fuse_arg {
184 unsigned size;
185 void *value;
186};
187
188/** The request output */
189struct fuse_out {
190 /** Header returned from userspace */
191 struct fuse_out_header h;
192
095da6cb
MS
193 /*
194 * The following bitfields are not changed during the request
195 * processing
196 */
197
334f485d
MS
198 /** Last argument is variable length (can be shorter than
199 arg->size) */
200 unsigned argvar:1;
201
202 /** Last argument is a list of pages to copy data to */
203 unsigned argpages:1;
204
205 /** Zero partially or not copied pages */
206 unsigned page_zeroing:1;
207
ce534fb0
MS
208 /** Pages may be replaced with new ones */
209 unsigned page_replace:1;
210
334f485d
MS
211 /** Number or arguments */
212 unsigned numargs;
213
214 /** Array of arguments */
f704dcb5 215 struct fuse_arg args[2];
334f485d
MS
216};
217
b2430d75
MP
218/** FUSE page descriptor */
219struct fuse_page_desc {
220 unsigned int length;
221 unsigned int offset;
222};
223
7078187a
MS
224struct fuse_args {
225 struct {
226 struct {
227 uint32_t opcode;
228 uint64_t nodeid;
229 } h;
230 unsigned numargs;
231 struct fuse_in_arg args[3];
232
233 } in;
234 struct {
235 unsigned argvar:1;
236 unsigned numargs;
237 struct fuse_arg args[2];
238 } out;
239};
240
241#define FUSE_ARGS(args) struct fuse_args args = {}
242
01e9d11a
MP
243/** The request IO state (for asynchronous processing) */
244struct fuse_io_priv {
744742d6 245 struct kref refcnt;
01e9d11a
MP
246 int async;
247 spinlock_t lock;
248 unsigned reqs;
249 ssize_t bytes;
250 size_t size;
251 __u64 offset;
252 bool write;
61c12b49 253 bool should_dirty;
01e9d11a
MP
254 int err;
255 struct kiocb *iocb;
9d5722b7 256 struct completion *done;
7879c4e5 257 bool blocking;
01e9d11a
MP
258};
259
e1c0eecb 260#define FUSE_IO_PRIV_SYNC(i) \
744742d6 261{ \
1e24edca 262 .refcnt = KREF_INIT(1), \
744742d6 263 .async = 0, \
e1c0eecb 264 .iocb = i, \
744742d6
SF
265}
266
825d6d33
MS
267/**
268 * Request flags
269 *
270 * FR_ISREPLY: set if the request has reply
271 * FR_FORCE: force sending of the request even if interrupted
272 * FR_BACKGROUND: request is sent in the background
273 * FR_WAITING: request is counted as "waiting"
274 * FR_ABORTED: the request was aborted
275 * FR_INTERRUPTED: the request has been interrupted
276 * FR_LOCKED: data is being copied to/from the request
33e14b4d
MS
277 * FR_PENDING: request is not yet in userspace
278 * FR_SENT: request is in userspace, waiting for an answer
279 * FR_FINISHED: request is finished
77cd9d48 280 * FR_PRIVATE: request is on private list
825d6d33
MS
281 */
282enum fuse_req_flag {
283 FR_ISREPLY,
284 FR_FORCE,
285 FR_BACKGROUND,
286 FR_WAITING,
287 FR_ABORTED,
288 FR_INTERRUPTED,
289 FR_LOCKED,
33e14b4d
MS
290 FR_PENDING,
291 FR_SENT,
292 FR_FINISHED,
77cd9d48 293 FR_PRIVATE,
825d6d33
MS
294};
295
334f485d
MS
296/**
297 * A request to the client
dc00809a
MS
298 *
299 * .waitq.lock protects the following fields:
300 * - FR_ABORTED
301 * - FR_LOCKED (may also be modified under fc->lock, tested under both)
334f485d
MS
302 */
303struct fuse_req {
ce1d5a49
MS
304 /** This can be on either pending processing or io lists in
305 fuse_conn */
334f485d
MS
306 struct list_head list;
307
a4d27e75
MS
308 /** Entry on the interrupts list */
309 struct list_head intr_entry;
310
334f485d 311 /** refcount */
ec99f6d3 312 refcount_t count;
334f485d 313
a4d27e75
MS
314 /** Unique ID for the interrupt request */
315 u64 intr_unique;
316
825d6d33
MS
317 /* Request flags, updated with test/set/clear_bit() */
318 unsigned long flags;
9bc5ddda 319
334f485d
MS
320 /** The request input */
321 struct fuse_in in;
322
323 /** The request output */
324 struct fuse_out out;
325
326 /** Used to wake up the task waiting for completion of request*/
327 wait_queue_head_t waitq;
328
329 /** Data for asynchronous requests */
330 union {
b57d4264 331 struct {
baebccbe
MS
332 struct fuse_release_in in;
333 struct inode *inode;
b57d4264 334 } release;
3ec870d5
MS
335 struct fuse_init_in init_in;
336 struct fuse_init_out init_out;
08cbf542 337 struct cuse_init_in cuse_init_in;
5c5c5e51
MS
338 struct {
339 struct fuse_read_in in;
340 u64 attr_ver;
341 } read;
b25e82e5
MS
342 struct {
343 struct fuse_write_in in;
344 struct fuse_write_out out;
8b284dc4 345 struct fuse_req *next;
b25e82e5 346 } write;
2d45ba38 347 struct fuse_notify_retrieve_in retrieve_in;
334f485d
MS
348 } misc;
349
350 /** page vector */
4250c066
MP
351 struct page **pages;
352
b2430d75
MP
353 /** page-descriptor vector */
354 struct fuse_page_desc *page_descs;
355
4250c066
MP
356 /** size of the 'pages' array */
357 unsigned max_pages;
358
359 /** inline page vector */
360 struct page *inline_pages[FUSE_REQ_INLINE_PAGES];
334f485d 361
b2430d75
MP
362 /** inline page-descriptor vector */
363 struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];
364
334f485d
MS
365 /** number of pages in vector */
366 unsigned num_pages;
367
334f485d 368 /** File used in the request (or NULL) */
c756e0a4 369 struct fuse_file *ff;
64c6d8ed 370
3be5a52b
MS
371 /** Inode used in the request or NULL */
372 struct inode *inode;
373
01e9d11a
MP
374 /** AIO control block */
375 struct fuse_io_priv *io;
376
3be5a52b
MS
377 /** Link on fi->writepages */
378 struct list_head writepages_entry;
379
64c6d8ed
MS
380 /** Request completion callback */
381 void (*end)(struct fuse_conn *, struct fuse_req *);
33649c91
MS
382
383 /** Request is stolen from fuse_file->reserved_req */
384 struct file *stolen_file;
334f485d
MS
385};
386
f88996a9 387struct fuse_iqueue {
e16714d8
MS
388 /** Connection established */
389 unsigned connected;
390
f88996a9
MS
391 /** Readers of the connection are waiting on this */
392 wait_queue_head_t waitq;
393
394 /** The next unique request id */
395 u64 reqctr;
396
397 /** The list of pending requests */
398 struct list_head pending;
399
400 /** Pending interrupts */
401 struct list_head interrupts;
402
403 /** Queue of pending forgets */
404 struct fuse_forget_link forget_list_head;
405 struct fuse_forget_link *forget_list_tail;
406
407 /** Batching of FORGET requests (positive indicates FORGET batch) */
408 int forget_batch;
409
410 /** O_ASYNC requests */
411 struct fasync_struct *fasync;
412};
413
3a2b5b9c 414struct fuse_pqueue {
e96edd94
MS
415 /** Connection established */
416 unsigned connected;
417
45a91cb1
MS
418 /** Lock protecting accessess to members of this structure */
419 spinlock_t lock;
420
3a2b5b9c
MS
421 /** The list of requests being processed */
422 struct list_head processing;
423
424 /** The list of requests under I/O */
425 struct list_head io;
426};
427
cc080e9e
MS
428/**
429 * Fuse device instance
430 */
431struct fuse_dev {
432 /** Fuse connection for this device */
433 struct fuse_conn *fc;
434
c3696046
MS
435 /** Processing queue */
436 struct fuse_pqueue pq;
437
cc080e9e
MS
438 /** list entry on fc->devices */
439 struct list_head entry;
440};
441
d8a5ba45
MS
442/**
443 * A Fuse connection.
444 *
445 * This structure is created, when the filesystem is mounted, and is
446 * destroyed, when the client device is closed and the filesystem is
447 * unmounted.
448 */
449struct fuse_conn {
d7133114
MS
450 /** Lock protecting accessess to members of this structure */
451 spinlock_t lock;
452
bafa9654 453 /** Refcount */
095fc40a 454 refcount_t count;
bafa9654 455
c3696046
MS
456 /** Number of fuse_dev's */
457 atomic_t dev_count;
458
dd3e2c55
AV
459 struct rcu_head rcu;
460
d8a5ba45 461 /** The user id for this mount */
499dcf20 462 kuid_t user_id;
d8a5ba45 463
87729a55 464 /** The group id for this mount */
499dcf20 465 kgid_t group_id;
87729a55 466
0b6e9ea0
SF
467 /** The pid namespace for this mount */
468 struct pid_namespace *pid_ns;
469
8cb08329
EB
470 /** The user namespace for this mount */
471 struct user_namespace *user_ns;
472
db50b96c
MS
473 /** Maximum read size */
474 unsigned max_read;
475
413ef8cb
MS
476 /** Maximum write size */
477 unsigned max_write;
478
f88996a9
MS
479 /** Input queue */
480 struct fuse_iqueue iq;
334f485d 481
acf99433
TH
482 /** The next unique kernel file handle */
483 u64 khctr;
484
95668a69
TH
485 /** rbtree of fuse_files waiting for poll events indexed by ph */
486 struct rb_root polled_files;
487
7a6d3c8b
CH
488 /** Maximum number of outstanding background requests */
489 unsigned max_background;
490
491 /** Number of background requests at which congestion starts */
492 unsigned congestion_threshold;
493
08a53cdc
MS
494 /** Number of requests currently in the background */
495 unsigned num_background;
496
d12def1b
MS
497 /** Number of background requests currently queued for userspace */
498 unsigned active_background;
499
500 /** The list of background requests set aside for later queuing */
501 struct list_head bg_queue;
502
796523fb
MP
503 /** Flag indicating that INIT reply has been received. Allocating
504 * any fuse request will be suspended until the flag is set */
505 int initialized;
506
08a53cdc
MS
507 /** Flag indicating if connection is blocked. This will be
508 the case before the INIT reply is received, and if there
509 are too many outstading backgrounds requests */
510 int blocked;
511
512 /** waitq for blocked connection */
513 wait_queue_head_t blocked_waitq;
de5e3dec
MS
514
515 /** waitq for reserved requests */
516 wait_queue_head_t reserved_req_waitq;
08a53cdc 517
69a53bf2
MS
518 /** Connection established, cleared on umount, connection
519 abort and device release */
095da6cb 520 unsigned connected;
1e9a4ed9 521
3b7008b2
SL
522 /** Connection aborted via sysfs */
523 bool aborted;
524
095da6cb
MS
525 /** Connection failed (version mismatch). Cannot race with
526 setting other bitfields since it is only set once in INIT
527 reply, before any other request, and never cleared */
1729a16c 528 unsigned conn_error:1;
334f485d 529
0ec7ca41 530 /** Connection successful. Only set in INIT */
1729a16c 531 unsigned conn_init:1;
0ec7ca41 532
9cd68455 533 /** Do readpages asynchronously? Only set in INIT */
1729a16c 534 unsigned async_read:1;
9cd68455 535
3b7008b2
SL
536 /** Return an unique read error after abort. Only set in INIT */
537 unsigned abort_err:1;
538
6ff958ed 539 /** Do not send separate SETATTR request before open(O_TRUNC) */
1729a16c 540 unsigned atomic_o_trunc:1;
6ff958ed 541
33670fa2 542 /** Filesystem supports NFS exporting. Only set in INIT */
1729a16c 543 unsigned export_support:1;
33670fa2 544
d5cd66c5
PE
545 /** write-back cache policy (default is write-through) */
546 unsigned writeback_cache:1;
547
5c672ab3
MS
548 /** allow parallel lookups and readdir (default is serialized) */
549 unsigned parallel_dirops:1;
550
5e940c1d
MS
551 /** handle fs handles killing suid/sgid/cap on write/chown/trunc */
552 unsigned handle_killpriv:1;
553
095da6cb
MS
554 /*
555 * The following bitfields are only for optimization purposes
556 * and hence races in setting them will not cause malfunction
557 */
558
7678ac50
AG
559 /** Is open/release not implemented by fs? */
560 unsigned no_open:1;
561
b6aeaded 562 /** Is fsync not implemented by fs? */
1729a16c 563 unsigned no_fsync:1;
b6aeaded 564
82547981 565 /** Is fsyncdir not implemented by fs? */
1729a16c 566 unsigned no_fsyncdir:1;
82547981 567
b6aeaded 568 /** Is flush not implemented by fs? */
1729a16c 569 unsigned no_flush:1;
b6aeaded 570
92a8780e 571 /** Is setxattr not implemented by fs? */
1729a16c 572 unsigned no_setxattr:1;
92a8780e
MS
573
574 /** Is getxattr not implemented by fs? */
1729a16c 575 unsigned no_getxattr:1;
92a8780e
MS
576
577 /** Is listxattr not implemented by fs? */
1729a16c 578 unsigned no_listxattr:1;
92a8780e
MS
579
580 /** Is removexattr not implemented by fs? */
1729a16c 581 unsigned no_removexattr:1;
92a8780e 582
37fb3a30 583 /** Are posix file locking primitives not implemented by fs? */
1729a16c 584 unsigned no_lock:1;
71421259 585
31d40d74 586 /** Is access not implemented by fs? */
1729a16c 587 unsigned no_access:1;
31d40d74 588
fd72faac 589 /** Is create not implemented by fs? */
1729a16c 590 unsigned no_create:1;
fd72faac 591
a4d27e75 592 /** Is interrupt not implemented by fs? */
1729a16c 593 unsigned no_interrupt:1;
a4d27e75 594
b2d2272f 595 /** Is bmap not implemented by fs? */
1729a16c 596 unsigned no_bmap:1;
b2d2272f 597
95668a69
TH
598 /** Is poll not implemented by fs? */
599 unsigned no_poll:1;
600
78bb6cb9 601 /** Do multi-page cached writes */
1729a16c 602 unsigned big_writes:1;
78bb6cb9 603
e0a43ddc
MS
604 /** Don't apply umask to creation modes */
605 unsigned dont_mask:1;
606
37fb3a30
MS
607 /** Are BSD file locking primitives not implemented by fs? */
608 unsigned no_flock:1;
609
519c6040
MS
610 /** Is fallocate not implemented by fs? */
611 unsigned no_fallocate:1;
612
1560c974
MS
613 /** Is rename with flags implemented by fs? */
614 unsigned no_rename2:1;
615
72d0d248
BF
616 /** Use enhanced/automatic page cache invalidation. */
617 unsigned auto_inval_data:1;
618
634734b6 619 /** Does the filesystem support readdirplus? */
0b05b183
AA
620 unsigned do_readdirplus:1;
621
634734b6
EW
622 /** Does the filesystem want adaptive readdirplus? */
623 unsigned readdirplus_auto:1;
624
60b9df7a
MS
625 /** Does the filesystem support asynchronous direct-IO submission? */
626 unsigned async_dio:1;
627
0b5da8db
R
628 /** Is lseek not implemented by fs? */
629 unsigned no_lseek:1;
630
60bcc88a
SF
631 /** Does the filesystem support posix acls? */
632 unsigned posix_acl:1;
633
29433a29
MS
634 /** Check permissions based on the file mode or not? */
635 unsigned default_permissions:1;
636
637 /** Allow other than the mounter user to access the filesystem ? */
638 unsigned allow_other:1;
639
0cd5b885
MS
640 /** The number of requests waiting for completion */
641 atomic_t num_waiting;
642
45714d65
MS
643 /** Negotiated minor version */
644 unsigned minor;
645
bafa9654
MS
646 /** Entry on the fuse_conn_list */
647 struct list_head entry;
648
b6f2fcbc
MS
649 /** Device ID from super block */
650 dev_t dev;
bafa9654
MS
651
652 /** Dentries in the control filesystem */
653 struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
654
655 /** number of dentries used in the above array */
656 int ctl_ndents;
385a17bf 657
9c8ef561
MS
658 /** Key for lock owner ID scrambling */
659 u32 scramble_key[4];
0ec7ca41
MS
660
661 /** Reserved request for the DESTROY message */
662 struct fuse_req *destroy_req;
1fb69e78
MS
663
664 /** Version counter for attribute changes */
665 u64 attr_version;
43901aab
TH
666
667 /** Called on final put */
668 void (*release)(struct fuse_conn *);
3b463ae0
JM
669
670 /** Super block for this connection. */
671 struct super_block *sb;
672
673 /** Read/write semaphore to hold when accessing sb. */
674 struct rw_semaphore killsb;
cc080e9e
MS
675
676 /** List of device instances belonging to this connection */
677 struct list_head devices;
d8a5ba45
MS
678};
679
d8a5ba45
MS
680static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
681{
6383bdaa 682 return sb->s_fs_info;
d8a5ba45
MS
683}
684
685static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
686{
687 return get_fuse_conn_super(inode->i_sb);
688}
689
690static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
691{
692 return container_of(inode, struct fuse_inode, inode);
693}
694
695static inline u64 get_node_id(struct inode *inode)
696{
697 return get_fuse_inode(inode)->nodeid;
698}
699
334f485d 700/** Device operations */
4b6f5d20 701extern const struct file_operations fuse_dev_operations;
334f485d 702
4269590a 703extern const struct dentry_operations fuse_dentry_operations;
0ce267ff 704extern const struct dentry_operations fuse_root_dentry_operations;
dbd561d2 705
3b463ae0
JM
706/**
707 * Inode to nodeid comparison.
708 */
709int fuse_inode_eq(struct inode *inode, void *_nodeidp);
710
e5e5558e
MS
711/**
712 * Get a filled in inode
713 */
b48badf0 714struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
1fb69e78
MS
715 int generation, struct fuse_attr *attr,
716 u64 attr_valid, u64 attr_version);
e5e5558e 717
13983d06 718int fuse_lookup_name(struct super_block *sb, u64 nodeid, const struct qstr *name,
33670fa2
MS
719 struct fuse_entry_out *outarg, struct inode **inode);
720
e5e5558e
MS
721/**
722 * Send FORGET command
723 */
07e77dca
MS
724void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
725 u64 nodeid, u64 nlookup);
726
727struct fuse_forget_link *fuse_alloc_forget(void);
e5e5558e 728
0b05b183
AA
729/* Used by READDIRPLUS */
730void fuse_force_forget(struct file *file, u64 nodeid);
731
04730fef 732/**
361b1eb5 733 * Initialize READ or READDIR request
04730fef 734 */
a6643094 735void fuse_read_fill(struct fuse_req *req, struct file *file,
2106cb18 736 loff_t pos, size_t count, int opcode);
04730fef
MS
737
738/**
739 * Send OPEN or OPENDIR request
740 */
91fe96b4 741int fuse_open_common(struct inode *inode, struct file *file, bool isdir);
04730fef 742
acf99433 743struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
fd72faac 744void fuse_file_free(struct fuse_file *ff);
c7b7143c 745void fuse_finish_open(struct inode *inode, struct file *file);
fd72faac 746
8b0797a4 747void fuse_sync_release(struct fuse_file *ff, int flags);
c756e0a4 748
04730fef
MS
749/**
750 * Send RELEASE or RELEASEDIR request
751 */
8b0797a4 752void fuse_release_common(struct file *file, int opcode);
04730fef 753
82547981
MS
754/**
755 * Send FSYNC or FSYNCDIR request
756 */
02c24a82
JB
757int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
758 int datasync, int isdir);
82547981 759
95668a69
TH
760/**
761 * Notify poll wakeup
762 */
763int fuse_notify_poll_wakeup(struct fuse_conn *fc,
764 struct fuse_notify_poll_wakeup_out *outarg);
765
b6aeaded 766/**
1779381d 767 * Initialize file operations on a regular file
b6aeaded
MS
768 */
769void fuse_init_file_inode(struct inode *inode);
770
e5e5558e 771/**
1779381d 772 * Initialize inode operations on regular files and special files
e5e5558e
MS
773 */
774void fuse_init_common(struct inode *inode);
775
776/**
1779381d 777 * Initialize inode and file operations on a directory
e5e5558e
MS
778 */
779void fuse_init_dir(struct inode *inode);
780
781/**
1779381d 782 * Initialize inode operations on a symlink
e5e5558e
MS
783 */
784void fuse_init_symlink(struct inode *inode);
785
786/**
787 * Change attributes of an inode
788 */
1fb69e78
MS
789void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
790 u64 attr_valid, u64 attr_version);
e5e5558e 791
3be5a52b
MS
792void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
793 u64 attr_valid);
794
334f485d
MS
795/**
796 * Initialize the client device
797 */
798int fuse_dev_init(void);
799
800/**
801 * Cleanup the client device
802 */
803void fuse_dev_cleanup(void);
804
bafa9654 805int fuse_ctl_init(void);
7736e8cc 806void __exit fuse_ctl_cleanup(void);
bafa9654 807
334f485d
MS
808/**
809 * Allocate a request
810 */
4250c066 811struct fuse_req *fuse_request_alloc(unsigned npages);
334f485d 812
4250c066 813struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
3be5a52b 814
334f485d
MS
815/**
816 * Free a request
817 */
818void fuse_request_free(struct fuse_req *req);
819
334f485d 820/**
b111c8c0
MP
821 * Get a request, may fail with -ENOMEM,
822 * caller should specify # elements in req->pages[] explicitly
334f485d 823 */
b111c8c0 824struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
8b41e671
MP
825struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
826 unsigned npages);
b111c8c0 827
36cf66ed
MP
828/*
829 * Increment reference count on request
830 */
831void __fuse_get_request(struct fuse_req *req);
832
33649c91
MS
833/**
834 * Gets a requests for a file operation, always succeeds
835 */
b111c8c0
MP
836struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
837 struct file *file);
33649c91 838
334f485d 839/**
ce1d5a49
MS
840 * Decrement reference count of a request. If count goes to zero free
841 * the request.
334f485d
MS
842 */
843void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
844
845/**
7c352bdf 846 * Send a request (synchronous)
334f485d 847 */
b93f858a 848void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
334f485d 849
7078187a
MS
850/**
851 * Simple request sending that does request allocation and freeing
852 */
853ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);
854
334f485d
MS
855/**
856 * Send a request in the background
857 */
b93f858a 858void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
334f485d 859
b93f858a
TH
860void fuse_request_send_background_locked(struct fuse_conn *fc,
861 struct fuse_req *req);
3be5a52b 862
5a5fb1ea 863/* Abort all requests */
3b7008b2 864void fuse_abort_conn(struct fuse_conn *fc, bool is_abort);
69a53bf2 865
e5e5558e
MS
866/**
867 * Invalidate inode attributes
868 */
869void fuse_invalidate_attr(struct inode *inode);
bafa9654 870
dbd561d2
MS
871void fuse_invalidate_entry_cache(struct dentry *entry);
872
451418fc
AG
873void fuse_invalidate_atime(struct inode *inode);
874
bafa9654
MS
875/**
876 * Acquire reference to fuse_conn
877 */
878struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
879
0d179aa5
TH
880/**
881 * Initialize fuse_conn
882 */
8cb08329 883void fuse_conn_init(struct fuse_conn *fc, struct user_namespace *user_ns);
0d179aa5 884
bafa9654
MS
885/**
886 * Release reference to fuse_conn
887 */
888void fuse_conn_put(struct fuse_conn *fc);
889
cc080e9e
MS
890struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
891void fuse_dev_free(struct fuse_dev *fud);
892
bafa9654
MS
893/**
894 * Add connection to control filesystem
895 */
896int fuse_ctl_add_conn(struct fuse_conn *fc);
897
898/**
899 * Remove connection from control filesystem
900 */
901void fuse_ctl_remove_conn(struct fuse_conn *fc);
a5bfffac
TS
902
903/**
904 * Is file type valid?
905 */
906int fuse_valid_type(int m);
e57ac683
MS
907
908/**
c2132c1b 909 * Is current process allowed to perform filesystem operation?
e57ac683 910 */
c2132c1b 911int fuse_allow_current_process(struct fuse_conn *fc);
f3332114
MS
912
913u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
bcb4be80 914
703c7362
SF
915void fuse_update_ctime(struct inode *inode);
916
5b97eeac 917int fuse_update_attributes(struct inode *inode, struct file *file);
3be5a52b
MS
918
919void fuse_flush_writepages(struct inode *inode);
920
921void fuse_set_nowrite(struct inode *inode);
922void fuse_release_nowrite(struct inode *inode);
5c5c5e51
MS
923
924u64 fuse_get_attr_version(struct fuse_conn *fc);
29d434b3 925
3b463ae0
JM
926/**
927 * File-system tells the kernel to invalidate cache for the given node id.
928 */
929int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid,
930 loff_t offset, loff_t len);
931
932/**
933 * File-system tells the kernel to invalidate parent attributes and
934 * the dentry matching parent/name.
451d0f59
JM
935 *
936 * If the child_nodeid is non-zero and:
937 * - matches the inode number for the dentry matching parent/name,
938 * - is not a mount point
939 * - is a file or oan empty directory
940 * then the dentry is unhashed (d_delete()).
3b463ae0
JM
941 */
942int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
451d0f59 943 u64 child_nodeid, struct qstr *name);
3b463ae0 944
08cbf542
TH
945int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
946 bool isdir);
ea8cd333
PE
947
948/**
949 * fuse_direct_io() flags
950 */
951
952/** If set, it is WRITE; otherwise - READ */
953#define FUSE_DIO_WRITE (1 << 0)
954
955/** CUSE pass fuse_direct_io() a file which f_mapping->host is not from FUSE */
956#define FUSE_DIO_CUSE (1 << 1)
957
d22a943f
AV
958ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
959 loff_t *ppos, int flags);
08cbf542
TH
960long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
961 unsigned int flags);
b18da0c5
MS
962long fuse_ioctl_common(struct file *file, unsigned int cmd,
963 unsigned long arg, unsigned int flags);
076ccb76 964__poll_t fuse_file_poll(struct file *file, poll_table *wait);
08cbf542
TH
965int fuse_dev_release(struct inode *inode, struct file *file);
966
b0aa7606
MP
967bool fuse_write_update_size(struct inode *inode, loff_t pos);
968
ab9e13f7 969int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
1e18bda8 970int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
a1d75f25 971
62490330 972int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
efb9fa9e
MP
973 struct file *file);
974
9759bd51
MS
975void fuse_set_initialized(struct fuse_conn *fc);
976
5c672ab3
MS
977void fuse_unlock_inode(struct inode *inode);
978void fuse_lock_inode(struct inode *inode);
979
60bcc88a
SF
980int fuse_setxattr(struct inode *inode, const char *name, const void *value,
981 size_t size, int flags);
982ssize_t fuse_getxattr(struct inode *inode, const char *name, void *value,
983 size_t size);
703c7362 984ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
60bcc88a 985int fuse_removexattr(struct inode *inode, const char *name);
703c7362 986extern const struct xattr_handler *fuse_xattr_handlers[];
60bcc88a
SF
987extern const struct xattr_handler *fuse_acl_xattr_handlers[];
988
989struct posix_acl;
990struct posix_acl *fuse_get_acl(struct inode *inode, int type);
991int fuse_set_acl(struct inode *inode, struct posix_acl *acl, int type);
703c7362 992
29d434b3 993#endif /* _FS_FUSE_I_H */
This page took 0.949424 seconds and 4 git commands to generate.