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