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