]>
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> |
d8a5ba45 | 27 | |
334f485d MS |
28 | /** Max number of pages that can be used in a single read request */ |
29 | #define FUSE_MAX_PAGES_PER_REQ 32 | |
30 | ||
3be5a52b MS |
31 | /** Bias for fi->writectr, meaning new writepages must not be sent */ |
32 | #define FUSE_NOWRITE INT_MIN | |
33 | ||
1d3d752b MS |
34 | /** It could be as large as PATH_MAX, but would that have any uses? */ |
35 | #define FUSE_NAME_MAX 1024 | |
36 | ||
bafa9654 | 37 | /** Number of dentries for each connection in the control filesystem */ |
79a9d994 | 38 | #define FUSE_CTL_NUM_DENTRIES 5 |
bafa9654 | 39 | |
4250c066 MP |
40 | /** Number of page pointers embedded in fuse_req */ |
41 | #define FUSE_REQ_INLINE_PAGES 1 | |
42 | ||
bafa9654 MS |
43 | /** List of active connections */ |
44 | extern struct list_head fuse_conn_list; | |
45 | ||
46 | /** Global mutex protecting fuse_conn_list and the control filesystem */ | |
47 | extern struct mutex fuse_mutex; | |
413ef8cb | 48 | |
79a9d994 CH |
49 | /** Module parameters */ |
50 | extern unsigned max_user_bgreq; | |
51 | extern unsigned max_user_congthresh; | |
52 | ||
07e77dca MS |
53 | /* One forget request */ |
54 | struct fuse_forget_link { | |
02c048b9 | 55 | struct fuse_forget_one forget_one; |
07e77dca MS |
56 | struct fuse_forget_link *next; |
57 | }; | |
58 | ||
d8a5ba45 MS |
59 | /** FUSE inode */ |
60 | struct fuse_inode { | |
61 | /** Inode data */ | |
62 | struct inode inode; | |
63 | ||
64 | /** Unique ID, which identifies the inode between userspace | |
65 | * and kernel */ | |
66 | u64 nodeid; | |
67 | ||
9e6268db MS |
68 | /** Number of lookups on this inode */ |
69 | u64 nlookup; | |
70 | ||
e5e5558e | 71 | /** The request used for sending the FORGET message */ |
07e77dca | 72 | struct fuse_forget_link *forget; |
e5e5558e | 73 | |
d8a5ba45 | 74 | /** Time in jiffies until the file attributes are valid */ |
0a0898cf | 75 | u64 i_time; |
ebc14c4d MS |
76 | |
77 | /** The sticky bit in inode->i_mode may have been removed, so | |
78 | preserve the original mode */ | |
541af6a0 | 79 | umode_t orig_i_mode; |
1fb69e78 | 80 | |
45c72cd7 PS |
81 | /** 64 bit inode number */ |
82 | u64 orig_ino; | |
83 | ||
1fb69e78 MS |
84 | /** Version of last attribute change */ |
85 | u64 attr_version; | |
93a8c3cd MS |
86 | |
87 | /** Files usable in writepage. Protected by fc->lock */ | |
88 | struct list_head write_files; | |
3be5a52b MS |
89 | |
90 | /** Writepages pending on truncate or fsync */ | |
91 | struct list_head queued_writes; | |
92 | ||
93 | /** Number of sent writes, a negative bias (FUSE_NOWRITE) | |
94 | * means more writes are blocked */ | |
95 | int writectr; | |
96 | ||
97 | /** Waitq for writepage completion */ | |
98 | wait_queue_head_t page_waitq; | |
99 | ||
100 | /** List of writepage requestst (pending or sent) */ | |
101 | struct list_head writepages; | |
4582a4ab FS |
102 | |
103 | /** Miscellaneous bits describing inode state */ | |
104 | unsigned long state; | |
5c672ab3 MS |
105 | |
106 | /** Lock for serializing lookup and readdir for back compatibility*/ | |
107 | struct mutex mutex; | |
4582a4ab FS |
108 | }; |
109 | ||
110 | /** FUSE inode state bits */ | |
111 | enum { | |
112 | /** Advise readdirplus */ | |
113 | FUSE_I_ADVISE_RDPLUS, | |
6314efee MS |
114 | /** Initialized with readdirplus */ |
115 | FUSE_I_INIT_RDPLUS, | |
06a7c3c2 MP |
116 | /** An operation changing file size is in progress */ |
117 | FUSE_I_SIZE_UNSTABLE, | |
d8a5ba45 MS |
118 | }; |
119 | ||
da5e4714 MS |
120 | struct fuse_conn; |
121 | ||
b6aeaded MS |
122 | /** FUSE specific file data */ |
123 | struct fuse_file { | |
da5e4714 MS |
124 | /** Fuse connection for this file */ |
125 | struct fuse_conn *fc; | |
126 | ||
b6aeaded | 127 | /** Request reserved for flush and release */ |
33649c91 | 128 | struct fuse_req *reserved_req; |
b6aeaded | 129 | |
acf99433 TH |
130 | /** Kernel file handle guaranteed to be unique */ |
131 | u64 kh; | |
132 | ||
b6aeaded MS |
133 | /** File handle used by userspace */ |
134 | u64 fh; | |
c756e0a4 | 135 | |
da5e4714 MS |
136 | /** Node id of this file */ |
137 | u64 nodeid; | |
138 | ||
c756e0a4 MS |
139 | /** Refcount */ |
140 | atomic_t count; | |
93a8c3cd | 141 | |
c7b7143c MS |
142 | /** FOPEN_* flags returned by open */ |
143 | u32 open_flags; | |
144 | ||
93a8c3cd MS |
145 | /** Entry on inode's write_files list */ |
146 | struct list_head write_entry; | |
95668a69 TH |
147 | |
148 | /** RB node to be linked on fuse_conn->polled_files */ | |
149 | struct rb_node polled_node; | |
150 | ||
151 | /** Wait queue head for poll */ | |
152 | wait_queue_head_t poll_wait; | |
37fb3a30 MS |
153 | |
154 | /** Has flock been performed on this file? */ | |
155 | bool flock:1; | |
b6aeaded MS |
156 | }; |
157 | ||
334f485d MS |
158 | /** One input argument of a request */ |
159 | struct fuse_in_arg { | |
160 | unsigned size; | |
161 | const void *value; | |
162 | }; | |
163 | ||
164 | /** The request input */ | |
165 | struct fuse_in { | |
166 | /** The request header */ | |
167 | struct fuse_in_header h; | |
168 | ||
169 | /** True if the data for the last argument is in req->pages */ | |
170 | unsigned argpages:1; | |
171 | ||
172 | /** Number of arguments */ | |
173 | unsigned numargs; | |
174 | ||
175 | /** Array of arguments */ | |
176 | struct fuse_in_arg args[3]; | |
177 | }; | |
178 | ||
179 | /** One output argument of a request */ | |
180 | struct fuse_arg { | |
181 | unsigned size; | |
182 | void *value; | |
183 | }; | |
184 | ||
185 | /** The request output */ | |
186 | struct fuse_out { | |
187 | /** Header returned from userspace */ | |
188 | struct fuse_out_header h; | |
189 | ||
095da6cb MS |
190 | /* |
191 | * The following bitfields are not changed during the request | |
192 | * processing | |
193 | */ | |
194 | ||
334f485d MS |
195 | /** Last argument is variable length (can be shorter than |
196 | arg->size) */ | |
197 | unsigned argvar:1; | |
198 | ||
199 | /** Last argument is a list of pages to copy data to */ | |
200 | unsigned argpages:1; | |
201 | ||
202 | /** Zero partially or not copied pages */ | |
203 | unsigned page_zeroing:1; | |
204 | ||
ce534fb0 MS |
205 | /** Pages may be replaced with new ones */ |
206 | unsigned page_replace:1; | |
207 | ||
334f485d MS |
208 | /** Number or arguments */ |
209 | unsigned numargs; | |
210 | ||
211 | /** Array of arguments */ | |
f704dcb5 | 212 | struct fuse_arg args[2]; |
334f485d MS |
213 | }; |
214 | ||
b2430d75 MP |
215 | /** FUSE page descriptor */ |
216 | struct fuse_page_desc { | |
217 | unsigned int length; | |
218 | unsigned int offset; | |
219 | }; | |
220 | ||
7078187a MS |
221 | struct fuse_args { |
222 | struct { | |
223 | struct { | |
224 | uint32_t opcode; | |
225 | uint64_t nodeid; | |
226 | } h; | |
227 | unsigned numargs; | |
228 | struct fuse_in_arg args[3]; | |
229 | ||
230 | } in; | |
231 | struct { | |
232 | unsigned argvar:1; | |
233 | unsigned numargs; | |
234 | struct fuse_arg args[2]; | |
235 | } out; | |
236 | }; | |
237 | ||
238 | #define FUSE_ARGS(args) struct fuse_args args = {} | |
239 | ||
01e9d11a MP |
240 | /** The request IO state (for asynchronous processing) */ |
241 | struct fuse_io_priv { | |
744742d6 | 242 | struct kref refcnt; |
01e9d11a MP |
243 | int async; |
244 | spinlock_t lock; | |
245 | unsigned reqs; | |
246 | ssize_t bytes; | |
247 | size_t size; | |
248 | __u64 offset; | |
249 | bool write; | |
250 | int err; | |
251 | struct kiocb *iocb; | |
252 | struct file *file; | |
9d5722b7 | 253 | struct completion *done; |
7879c4e5 | 254 | bool blocking; |
01e9d11a MP |
255 | }; |
256 | ||
744742d6 SF |
257 | #define FUSE_IO_PRIV_SYNC(f) \ |
258 | { \ | |
259 | .refcnt = { ATOMIC_INIT(1) }, \ | |
260 | .async = 0, \ | |
261 | .file = f, \ | |
262 | } | |
263 | ||
825d6d33 MS |
264 | /** |
265 | * Request flags | |
266 | * | |
267 | * FR_ISREPLY: set if the request has reply | |
268 | * FR_FORCE: force sending of the request even if interrupted | |
269 | * FR_BACKGROUND: request is sent in the background | |
270 | * FR_WAITING: request is counted as "waiting" | |
271 | * FR_ABORTED: the request was aborted | |
272 | * FR_INTERRUPTED: the request has been interrupted | |
273 | * FR_LOCKED: data is being copied to/from the request | |
33e14b4d MS |
274 | * FR_PENDING: request is not yet in userspace |
275 | * FR_SENT: request is in userspace, waiting for an answer | |
276 | * FR_FINISHED: request is finished | |
77cd9d48 | 277 | * FR_PRIVATE: request is on private list |
825d6d33 MS |
278 | */ |
279 | enum fuse_req_flag { | |
280 | FR_ISREPLY, | |
281 | FR_FORCE, | |
282 | FR_BACKGROUND, | |
283 | FR_WAITING, | |
284 | FR_ABORTED, | |
285 | FR_INTERRUPTED, | |
286 | FR_LOCKED, | |
33e14b4d MS |
287 | FR_PENDING, |
288 | FR_SENT, | |
289 | FR_FINISHED, | |
77cd9d48 | 290 | FR_PRIVATE, |
825d6d33 MS |
291 | }; |
292 | ||
334f485d MS |
293 | /** |
294 | * A request to the client | |
dc00809a MS |
295 | * |
296 | * .waitq.lock protects the following fields: | |
297 | * - FR_ABORTED | |
298 | * - FR_LOCKED (may also be modified under fc->lock, tested under both) | |
334f485d MS |
299 | */ |
300 | struct fuse_req { | |
ce1d5a49 MS |
301 | /** This can be on either pending processing or io lists in |
302 | fuse_conn */ | |
334f485d MS |
303 | struct list_head list; |
304 | ||
a4d27e75 MS |
305 | /** Entry on the interrupts list */ |
306 | struct list_head intr_entry; | |
307 | ||
334f485d MS |
308 | /** refcount */ |
309 | atomic_t count; | |
310 | ||
a4d27e75 MS |
311 | /** Unique ID for the interrupt request */ |
312 | u64 intr_unique; | |
313 | ||
825d6d33 MS |
314 | /* Request flags, updated with test/set/clear_bit() */ |
315 | unsigned long flags; | |
9bc5ddda | 316 | |
334f485d MS |
317 | /** The request input */ |
318 | struct fuse_in in; | |
319 | ||
320 | /** The request output */ | |
321 | struct fuse_out out; | |
322 | ||
323 | /** Used to wake up the task waiting for completion of request*/ | |
324 | wait_queue_head_t waitq; | |
325 | ||
326 | /** Data for asynchronous requests */ | |
327 | union { | |
b57d4264 | 328 | struct { |
baebccbe MS |
329 | struct fuse_release_in in; |
330 | struct inode *inode; | |
b57d4264 | 331 | } release; |
3ec870d5 MS |
332 | struct fuse_init_in init_in; |
333 | struct fuse_init_out init_out; | |
08cbf542 | 334 | struct cuse_init_in cuse_init_in; |
5c5c5e51 MS |
335 | struct { |
336 | struct fuse_read_in in; | |
337 | u64 attr_ver; | |
338 | } read; | |
b25e82e5 MS |
339 | struct { |
340 | struct fuse_write_in in; | |
341 | struct fuse_write_out out; | |
8b284dc4 | 342 | struct fuse_req *next; |
b25e82e5 | 343 | } write; |
2d45ba38 | 344 | struct fuse_notify_retrieve_in retrieve_in; |
334f485d MS |
345 | } misc; |
346 | ||
347 | /** page vector */ | |
4250c066 MP |
348 | struct page **pages; |
349 | ||
b2430d75 MP |
350 | /** page-descriptor vector */ |
351 | struct fuse_page_desc *page_descs; | |
352 | ||
4250c066 MP |
353 | /** size of the 'pages' array */ |
354 | unsigned max_pages; | |
355 | ||
356 | /** inline page vector */ | |
357 | struct page *inline_pages[FUSE_REQ_INLINE_PAGES]; | |
334f485d | 358 | |
b2430d75 MP |
359 | /** inline page-descriptor vector */ |
360 | struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES]; | |
361 | ||
334f485d MS |
362 | /** number of pages in vector */ |
363 | unsigned num_pages; | |
364 | ||
334f485d | 365 | /** File used in the request (or NULL) */ |
c756e0a4 | 366 | struct fuse_file *ff; |
64c6d8ed | 367 | |
3be5a52b MS |
368 | /** Inode used in the request or NULL */ |
369 | struct inode *inode; | |
370 | ||
01e9d11a MP |
371 | /** AIO control block */ |
372 | struct fuse_io_priv *io; | |
373 | ||
3be5a52b MS |
374 | /** Link on fi->writepages */ |
375 | struct list_head writepages_entry; | |
376 | ||
64c6d8ed MS |
377 | /** Request completion callback */ |
378 | void (*end)(struct fuse_conn *, struct fuse_req *); | |
33649c91 MS |
379 | |
380 | /** Request is stolen from fuse_file->reserved_req */ | |
381 | struct file *stolen_file; | |
334f485d MS |
382 | }; |
383 | ||
f88996a9 | 384 | struct fuse_iqueue { |
e16714d8 MS |
385 | /** Connection established */ |
386 | unsigned connected; | |
387 | ||
f88996a9 MS |
388 | /** Readers of the connection are waiting on this */ |
389 | wait_queue_head_t waitq; | |
390 | ||
391 | /** The next unique request id */ | |
392 | u64 reqctr; | |
393 | ||
394 | /** The list of pending requests */ | |
395 | struct list_head pending; | |
396 | ||
397 | /** Pending interrupts */ | |
398 | struct list_head interrupts; | |
399 | ||
400 | /** Queue of pending forgets */ | |
401 | struct fuse_forget_link forget_list_head; | |
402 | struct fuse_forget_link *forget_list_tail; | |
403 | ||
404 | /** Batching of FORGET requests (positive indicates FORGET batch) */ | |
405 | int forget_batch; | |
406 | ||
407 | /** O_ASYNC requests */ | |
408 | struct fasync_struct *fasync; | |
409 | }; | |
410 | ||
3a2b5b9c | 411 | struct fuse_pqueue { |
e96edd94 MS |
412 | /** Connection established */ |
413 | unsigned connected; | |
414 | ||
45a91cb1 MS |
415 | /** Lock protecting accessess to members of this structure */ |
416 | spinlock_t lock; | |
417 | ||
3a2b5b9c MS |
418 | /** The list of requests being processed */ |
419 | struct list_head processing; | |
420 | ||
421 | /** The list of requests under I/O */ | |
422 | struct list_head io; | |
423 | }; | |
424 | ||
cc080e9e MS |
425 | /** |
426 | * Fuse device instance | |
427 | */ | |
428 | struct fuse_dev { | |
429 | /** Fuse connection for this device */ | |
430 | struct fuse_conn *fc; | |
431 | ||
c3696046 MS |
432 | /** Processing queue */ |
433 | struct fuse_pqueue pq; | |
434 | ||
cc080e9e MS |
435 | /** list entry on fc->devices */ |
436 | struct list_head entry; | |
437 | }; | |
438 | ||
d8a5ba45 MS |
439 | /** |
440 | * A Fuse connection. | |
441 | * | |
442 | * This structure is created, when the filesystem is mounted, and is | |
443 | * destroyed, when the client device is closed and the filesystem is | |
444 | * unmounted. | |
445 | */ | |
446 | struct fuse_conn { | |
d7133114 MS |
447 | /** Lock protecting accessess to members of this structure */ |
448 | spinlock_t lock; | |
449 | ||
bafa9654 MS |
450 | /** Refcount */ |
451 | atomic_t count; | |
452 | ||
c3696046 MS |
453 | /** Number of fuse_dev's */ |
454 | atomic_t dev_count; | |
455 | ||
dd3e2c55 AV |
456 | struct rcu_head rcu; |
457 | ||
d8a5ba45 | 458 | /** The user id for this mount */ |
499dcf20 | 459 | kuid_t user_id; |
d8a5ba45 | 460 | |
87729a55 | 461 | /** The group id for this mount */ |
499dcf20 | 462 | kgid_t group_id; |
87729a55 | 463 | |
db50b96c MS |
464 | /** Maximum read size */ |
465 | unsigned max_read; | |
466 | ||
413ef8cb MS |
467 | /** Maximum write size */ |
468 | unsigned max_write; | |
469 | ||
f88996a9 MS |
470 | /** Input queue */ |
471 | struct fuse_iqueue iq; | |
334f485d | 472 | |
acf99433 TH |
473 | /** The next unique kernel file handle */ |
474 | u64 khctr; | |
475 | ||
95668a69 TH |
476 | /** rbtree of fuse_files waiting for poll events indexed by ph */ |
477 | struct rb_root polled_files; | |
478 | ||
7a6d3c8b CH |
479 | /** Maximum number of outstanding background requests */ |
480 | unsigned max_background; | |
481 | ||
482 | /** Number of background requests at which congestion starts */ | |
483 | unsigned congestion_threshold; | |
484 | ||
08a53cdc MS |
485 | /** Number of requests currently in the background */ |
486 | unsigned num_background; | |
487 | ||
d12def1b MS |
488 | /** Number of background requests currently queued for userspace */ |
489 | unsigned active_background; | |
490 | ||
491 | /** The list of background requests set aside for later queuing */ | |
492 | struct list_head bg_queue; | |
493 | ||
796523fb MP |
494 | /** Flag indicating that INIT reply has been received. Allocating |
495 | * any fuse request will be suspended until the flag is set */ | |
496 | int initialized; | |
497 | ||
08a53cdc MS |
498 | /** Flag indicating if connection is blocked. This will be |
499 | the case before the INIT reply is received, and if there | |
500 | are too many outstading backgrounds requests */ | |
501 | int blocked; | |
502 | ||
503 | /** waitq for blocked connection */ | |
504 | wait_queue_head_t blocked_waitq; | |
de5e3dec MS |
505 | |
506 | /** waitq for reserved requests */ | |
507 | wait_queue_head_t reserved_req_waitq; | |
08a53cdc | 508 | |
69a53bf2 MS |
509 | /** Connection established, cleared on umount, connection |
510 | abort and device release */ | |
095da6cb | 511 | unsigned connected; |
1e9a4ed9 | 512 | |
095da6cb MS |
513 | /** Connection failed (version mismatch). Cannot race with |
514 | setting other bitfields since it is only set once in INIT | |
515 | reply, before any other request, and never cleared */ | |
1729a16c | 516 | unsigned conn_error:1; |
334f485d | 517 | |
0ec7ca41 | 518 | /** Connection successful. Only set in INIT */ |
1729a16c | 519 | unsigned conn_init:1; |
0ec7ca41 | 520 | |
9cd68455 | 521 | /** Do readpages asynchronously? Only set in INIT */ |
1729a16c | 522 | unsigned async_read:1; |
9cd68455 | 523 | |
6ff958ed | 524 | /** Do not send separate SETATTR request before open(O_TRUNC) */ |
1729a16c | 525 | unsigned atomic_o_trunc:1; |
6ff958ed | 526 | |
33670fa2 | 527 | /** Filesystem supports NFS exporting. Only set in INIT */ |
1729a16c | 528 | unsigned export_support:1; |
33670fa2 | 529 | |
a325f9b9 TH |
530 | /** Set if bdi is valid */ |
531 | unsigned bdi_initialized:1; | |
532 | ||
d5cd66c5 PE |
533 | /** write-back cache policy (default is write-through) */ |
534 | unsigned writeback_cache:1; | |
535 | ||
5c672ab3 MS |
536 | /** allow parallel lookups and readdir (default is serialized) */ |
537 | unsigned parallel_dirops:1; | |
538 | ||
5e940c1d MS |
539 | /** handle fs handles killing suid/sgid/cap on write/chown/trunc */ |
540 | unsigned handle_killpriv:1; | |
541 | ||
095da6cb MS |
542 | /* |
543 | * The following bitfields are only for optimization purposes | |
544 | * and hence races in setting them will not cause malfunction | |
545 | */ | |
546 | ||
7678ac50 AG |
547 | /** Is open/release not implemented by fs? */ |
548 | unsigned no_open:1; | |
549 | ||
b6aeaded | 550 | /** Is fsync not implemented by fs? */ |
1729a16c | 551 | unsigned no_fsync:1; |
b6aeaded | 552 | |
82547981 | 553 | /** Is fsyncdir not implemented by fs? */ |
1729a16c | 554 | unsigned no_fsyncdir:1; |
82547981 | 555 | |
b6aeaded | 556 | /** Is flush not implemented by fs? */ |
1729a16c | 557 | unsigned no_flush:1; |
b6aeaded | 558 | |
92a8780e | 559 | /** Is setxattr not implemented by fs? */ |
1729a16c | 560 | unsigned no_setxattr:1; |
92a8780e MS |
561 | |
562 | /** Is getxattr not implemented by fs? */ | |
1729a16c | 563 | unsigned no_getxattr:1; |
92a8780e MS |
564 | |
565 | /** Is listxattr not implemented by fs? */ | |
1729a16c | 566 | unsigned no_listxattr:1; |
92a8780e MS |
567 | |
568 | /** Is removexattr not implemented by fs? */ | |
1729a16c | 569 | unsigned no_removexattr:1; |
92a8780e | 570 | |
37fb3a30 | 571 | /** Are posix file locking primitives not implemented by fs? */ |
1729a16c | 572 | unsigned no_lock:1; |
71421259 | 573 | |
31d40d74 | 574 | /** Is access not implemented by fs? */ |
1729a16c | 575 | unsigned no_access:1; |
31d40d74 | 576 | |
fd72faac | 577 | /** Is create not implemented by fs? */ |
1729a16c | 578 | unsigned no_create:1; |
fd72faac | 579 | |
a4d27e75 | 580 | /** Is interrupt not implemented by fs? */ |
1729a16c | 581 | unsigned no_interrupt:1; |
a4d27e75 | 582 | |
b2d2272f | 583 | /** Is bmap not implemented by fs? */ |
1729a16c | 584 | unsigned no_bmap:1; |
b2d2272f | 585 | |
95668a69 TH |
586 | /** Is poll not implemented by fs? */ |
587 | unsigned no_poll:1; | |
588 | ||
78bb6cb9 | 589 | /** Do multi-page cached writes */ |
1729a16c | 590 | unsigned big_writes:1; |
78bb6cb9 | 591 | |
e0a43ddc MS |
592 | /** Don't apply umask to creation modes */ |
593 | unsigned dont_mask:1; | |
594 | ||
37fb3a30 MS |
595 | /** Are BSD file locking primitives not implemented by fs? */ |
596 | unsigned no_flock:1; | |
597 | ||
519c6040 MS |
598 | /** Is fallocate not implemented by fs? */ |
599 | unsigned no_fallocate:1; | |
600 | ||
1560c974 MS |
601 | /** Is rename with flags implemented by fs? */ |
602 | unsigned no_rename2:1; | |
603 | ||
72d0d248 BF |
604 | /** Use enhanced/automatic page cache invalidation. */ |
605 | unsigned auto_inval_data:1; | |
606 | ||
634734b6 | 607 | /** Does the filesystem support readdirplus? */ |
0b05b183 AA |
608 | unsigned do_readdirplus:1; |
609 | ||
634734b6 EW |
610 | /** Does the filesystem want adaptive readdirplus? */ |
611 | unsigned readdirplus_auto:1; | |
612 | ||
60b9df7a MS |
613 | /** Does the filesystem support asynchronous direct-IO submission? */ |
614 | unsigned async_dio:1; | |
615 | ||
0b5da8db R |
616 | /** Is lseek not implemented by fs? */ |
617 | unsigned no_lseek:1; | |
618 | ||
60bcc88a SF |
619 | /** Does the filesystem support posix acls? */ |
620 | unsigned posix_acl:1; | |
621 | ||
29433a29 MS |
622 | /** Check permissions based on the file mode or not? */ |
623 | unsigned default_permissions:1; | |
624 | ||
625 | /** Allow other than the mounter user to access the filesystem ? */ | |
626 | unsigned allow_other:1; | |
627 | ||
0cd5b885 MS |
628 | /** The number of requests waiting for completion */ |
629 | atomic_t num_waiting; | |
630 | ||
45714d65 MS |
631 | /** Negotiated minor version */ |
632 | unsigned minor; | |
633 | ||
d8a5ba45 MS |
634 | /** Backing dev info */ |
635 | struct backing_dev_info bdi; | |
f543f253 | 636 | |
bafa9654 MS |
637 | /** Entry on the fuse_conn_list */ |
638 | struct list_head entry; | |
639 | ||
b6f2fcbc MS |
640 | /** Device ID from super block */ |
641 | dev_t dev; | |
bafa9654 MS |
642 | |
643 | /** Dentries in the control filesystem */ | |
644 | struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES]; | |
645 | ||
646 | /** number of dentries used in the above array */ | |
647 | int ctl_ndents; | |
385a17bf | 648 | |
9c8ef561 MS |
649 | /** Key for lock owner ID scrambling */ |
650 | u32 scramble_key[4]; | |
0ec7ca41 MS |
651 | |
652 | /** Reserved request for the DESTROY message */ | |
653 | struct fuse_req *destroy_req; | |
1fb69e78 MS |
654 | |
655 | /** Version counter for attribute changes */ | |
656 | u64 attr_version; | |
43901aab TH |
657 | |
658 | /** Called on final put */ | |
659 | void (*release)(struct fuse_conn *); | |
3b463ae0 JM |
660 | |
661 | /** Super block for this connection. */ | |
662 | struct super_block *sb; | |
663 | ||
664 | /** Read/write semaphore to hold when accessing sb. */ | |
665 | struct rw_semaphore killsb; | |
cc080e9e MS |
666 | |
667 | /** List of device instances belonging to this connection */ | |
668 | struct list_head devices; | |
d8a5ba45 MS |
669 | }; |
670 | ||
d8a5ba45 MS |
671 | static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb) |
672 | { | |
6383bdaa | 673 | return sb->s_fs_info; |
d8a5ba45 MS |
674 | } |
675 | ||
676 | static inline struct fuse_conn *get_fuse_conn(struct inode *inode) | |
677 | { | |
678 | return get_fuse_conn_super(inode->i_sb); | |
679 | } | |
680 | ||
681 | static inline struct fuse_inode *get_fuse_inode(struct inode *inode) | |
682 | { | |
683 | return container_of(inode, struct fuse_inode, inode); | |
684 | } | |
685 | ||
686 | static inline u64 get_node_id(struct inode *inode) | |
687 | { | |
688 | return get_fuse_inode(inode)->nodeid; | |
689 | } | |
690 | ||
334f485d | 691 | /** Device operations */ |
4b6f5d20 | 692 | extern const struct file_operations fuse_dev_operations; |
334f485d | 693 | |
4269590a | 694 | extern const struct dentry_operations fuse_dentry_operations; |
0ce267ff | 695 | extern const struct dentry_operations fuse_root_dentry_operations; |
dbd561d2 | 696 | |
3b463ae0 JM |
697 | /** |
698 | * Inode to nodeid comparison. | |
699 | */ | |
700 | int fuse_inode_eq(struct inode *inode, void *_nodeidp); | |
701 | ||
e5e5558e MS |
702 | /** |
703 | * Get a filled in inode | |
704 | */ | |
b48badf0 | 705 | struct inode *fuse_iget(struct super_block *sb, u64 nodeid, |
1fb69e78 MS |
706 | int generation, struct fuse_attr *attr, |
707 | u64 attr_valid, u64 attr_version); | |
e5e5558e | 708 | |
13983d06 | 709 | int fuse_lookup_name(struct super_block *sb, u64 nodeid, const struct qstr *name, |
33670fa2 MS |
710 | struct fuse_entry_out *outarg, struct inode **inode); |
711 | ||
e5e5558e MS |
712 | /** |
713 | * Send FORGET command | |
714 | */ | |
07e77dca MS |
715 | void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget, |
716 | u64 nodeid, u64 nlookup); | |
717 | ||
718 | struct fuse_forget_link *fuse_alloc_forget(void); | |
e5e5558e | 719 | |
0b05b183 AA |
720 | /* Used by READDIRPLUS */ |
721 | void fuse_force_forget(struct file *file, u64 nodeid); | |
722 | ||
04730fef | 723 | /** |
361b1eb5 | 724 | * Initialize READ or READDIR request |
04730fef | 725 | */ |
a6643094 | 726 | void fuse_read_fill(struct fuse_req *req, struct file *file, |
2106cb18 | 727 | loff_t pos, size_t count, int opcode); |
04730fef MS |
728 | |
729 | /** | |
730 | * Send OPEN or OPENDIR request | |
731 | */ | |
91fe96b4 | 732 | int fuse_open_common(struct inode *inode, struct file *file, bool isdir); |
04730fef | 733 | |
acf99433 | 734 | struct fuse_file *fuse_file_alloc(struct fuse_conn *fc); |
c7b7143c | 735 | struct fuse_file *fuse_file_get(struct fuse_file *ff); |
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 */ |