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