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