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