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