]>
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 | ||
83cfd493 MS |
244 | /** The request state */ |
245 | enum fuse_req_state { | |
246 | FUSE_REQ_INIT = 0, | |
247 | FUSE_REQ_PENDING, | |
248 | FUSE_REQ_READING, | |
249 | FUSE_REQ_SENT, | |
a4d27e75 | 250 | FUSE_REQ_WRITING, |
83cfd493 MS |
251 | FUSE_REQ_FINISHED |
252 | }; | |
253 | ||
01e9d11a MP |
254 | /** The request IO state (for asynchronous processing) */ |
255 | struct fuse_io_priv { | |
256 | int async; | |
257 | spinlock_t lock; | |
258 | unsigned reqs; | |
259 | ssize_t bytes; | |
260 | size_t size; | |
261 | __u64 offset; | |
262 | bool write; | |
263 | int err; | |
264 | struct kiocb *iocb; | |
265 | struct file *file; | |
9d5722b7 | 266 | struct completion *done; |
01e9d11a MP |
267 | }; |
268 | ||
825d6d33 MS |
269 | /** |
270 | * Request flags | |
271 | * | |
272 | * FR_ISREPLY: set if the request has reply | |
273 | * FR_FORCE: force sending of the request even if interrupted | |
274 | * FR_BACKGROUND: request is sent in the background | |
275 | * FR_WAITING: request is counted as "waiting" | |
276 | * FR_ABORTED: the request was aborted | |
277 | * FR_INTERRUPTED: the request has been interrupted | |
278 | * FR_LOCKED: data is being copied to/from the request | |
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, | |
288 | }; | |
289 | ||
334f485d MS |
290 | /** |
291 | * A request to the client | |
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 | |
83cfd493 MS |
310 | /** State of the request */ |
311 | enum fuse_req_state state; | |
334f485d MS |
312 | |
313 | /** The request input */ | |
314 | struct fuse_in in; | |
315 | ||
316 | /** The request output */ | |
317 | struct fuse_out out; | |
318 | ||
319 | /** Used to wake up the task waiting for completion of request*/ | |
320 | wait_queue_head_t waitq; | |
321 | ||
322 | /** Data for asynchronous requests */ | |
323 | union { | |
b57d4264 | 324 | struct { |
baebccbe MS |
325 | struct fuse_release_in in; |
326 | struct inode *inode; | |
b57d4264 | 327 | } release; |
3ec870d5 MS |
328 | struct fuse_init_in init_in; |
329 | struct fuse_init_out init_out; | |
08cbf542 | 330 | struct cuse_init_in cuse_init_in; |
5c5c5e51 MS |
331 | struct { |
332 | struct fuse_read_in in; | |
333 | u64 attr_ver; | |
334 | } read; | |
b25e82e5 MS |
335 | struct { |
336 | struct fuse_write_in in; | |
337 | struct fuse_write_out out; | |
8b284dc4 | 338 | struct fuse_req *next; |
b25e82e5 | 339 | } write; |
2d45ba38 | 340 | struct fuse_notify_retrieve_in retrieve_in; |
334f485d MS |
341 | } misc; |
342 | ||
343 | /** page vector */ | |
4250c066 MP |
344 | struct page **pages; |
345 | ||
b2430d75 MP |
346 | /** page-descriptor vector */ |
347 | struct fuse_page_desc *page_descs; | |
348 | ||
4250c066 MP |
349 | /** size of the 'pages' array */ |
350 | unsigned max_pages; | |
351 | ||
352 | /** inline page vector */ | |
353 | struct page *inline_pages[FUSE_REQ_INLINE_PAGES]; | |
334f485d | 354 | |
b2430d75 MP |
355 | /** inline page-descriptor vector */ |
356 | struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES]; | |
357 | ||
334f485d MS |
358 | /** number of pages in vector */ |
359 | unsigned num_pages; | |
360 | ||
334f485d | 361 | /** File used in the request (or NULL) */ |
c756e0a4 | 362 | struct fuse_file *ff; |
64c6d8ed | 363 | |
3be5a52b MS |
364 | /** Inode used in the request or NULL */ |
365 | struct inode *inode; | |
366 | ||
01e9d11a MP |
367 | /** AIO control block */ |
368 | struct fuse_io_priv *io; | |
369 | ||
3be5a52b MS |
370 | /** Link on fi->writepages */ |
371 | struct list_head writepages_entry; | |
372 | ||
64c6d8ed MS |
373 | /** Request completion callback */ |
374 | void (*end)(struct fuse_conn *, struct fuse_req *); | |
33649c91 MS |
375 | |
376 | /** Request is stolen from fuse_file->reserved_req */ | |
377 | struct file *stolen_file; | |
334f485d MS |
378 | }; |
379 | ||
d8a5ba45 MS |
380 | /** |
381 | * A Fuse connection. | |
382 | * | |
383 | * This structure is created, when the filesystem is mounted, and is | |
384 | * destroyed, when the client device is closed and the filesystem is | |
385 | * unmounted. | |
386 | */ | |
387 | struct fuse_conn { | |
d7133114 MS |
388 | /** Lock protecting accessess to members of this structure */ |
389 | spinlock_t lock; | |
390 | ||
bafa9654 MS |
391 | /** Refcount */ |
392 | atomic_t count; | |
393 | ||
dd3e2c55 AV |
394 | struct rcu_head rcu; |
395 | ||
d8a5ba45 | 396 | /** The user id for this mount */ |
499dcf20 | 397 | kuid_t user_id; |
d8a5ba45 | 398 | |
87729a55 | 399 | /** The group id for this mount */ |
499dcf20 | 400 | kgid_t group_id; |
87729a55 | 401 | |
1e9a4ed9 MS |
402 | /** The fuse mount flags for this mount */ |
403 | unsigned flags; | |
404 | ||
db50b96c MS |
405 | /** Maximum read size */ |
406 | unsigned max_read; | |
407 | ||
413ef8cb MS |
408 | /** Maximum write size */ |
409 | unsigned max_write; | |
410 | ||
334f485d MS |
411 | /** Readers of the connection are waiting on this */ |
412 | wait_queue_head_t waitq; | |
413 | ||
414 | /** The list of pending requests */ | |
415 | struct list_head pending; | |
416 | ||
417 | /** The list of requests being processed */ | |
418 | struct list_head processing; | |
419 | ||
d77a1d5b MS |
420 | /** The list of requests under I/O */ |
421 | struct list_head io; | |
422 | ||
acf99433 TH |
423 | /** The next unique kernel file handle */ |
424 | u64 khctr; | |
425 | ||
95668a69 TH |
426 | /** rbtree of fuse_files waiting for poll events indexed by ph */ |
427 | struct rb_root polled_files; | |
428 | ||
7a6d3c8b CH |
429 | /** Maximum number of outstanding background requests */ |
430 | unsigned max_background; | |
431 | ||
432 | /** Number of background requests at which congestion starts */ | |
433 | unsigned congestion_threshold; | |
434 | ||
08a53cdc MS |
435 | /** Number of requests currently in the background */ |
436 | unsigned num_background; | |
437 | ||
d12def1b MS |
438 | /** Number of background requests currently queued for userspace */ |
439 | unsigned active_background; | |
440 | ||
441 | /** The list of background requests set aside for later queuing */ | |
442 | struct list_head bg_queue; | |
443 | ||
a4d27e75 MS |
444 | /** Pending interrupts */ |
445 | struct list_head interrupts; | |
446 | ||
07e77dca MS |
447 | /** Queue of pending forgets */ |
448 | struct fuse_forget_link forget_list_head; | |
449 | struct fuse_forget_link *forget_list_tail; | |
450 | ||
451 | /** Batching of FORGET requests (positive indicates FORGET batch) */ | |
452 | int forget_batch; | |
453 | ||
796523fb MP |
454 | /** Flag indicating that INIT reply has been received. Allocating |
455 | * any fuse request will be suspended until the flag is set */ | |
456 | int initialized; | |
457 | ||
08a53cdc MS |
458 | /** Flag indicating if connection is blocked. This will be |
459 | the case before the INIT reply is received, and if there | |
460 | are too many outstading backgrounds requests */ | |
461 | int blocked; | |
462 | ||
463 | /** waitq for blocked connection */ | |
464 | wait_queue_head_t blocked_waitq; | |
de5e3dec MS |
465 | |
466 | /** waitq for reserved requests */ | |
467 | wait_queue_head_t reserved_req_waitq; | |
08a53cdc | 468 | |
334f485d MS |
469 | /** The next unique request id */ |
470 | u64 reqctr; | |
471 | ||
69a53bf2 MS |
472 | /** Connection established, cleared on umount, connection |
473 | abort and device release */ | |
095da6cb | 474 | unsigned connected; |
1e9a4ed9 | 475 | |
095da6cb MS |
476 | /** Connection failed (version mismatch). Cannot race with |
477 | setting other bitfields since it is only set once in INIT | |
478 | reply, before any other request, and never cleared */ | |
1729a16c | 479 | unsigned conn_error:1; |
334f485d | 480 | |
0ec7ca41 | 481 | /** Connection successful. Only set in INIT */ |
1729a16c | 482 | unsigned conn_init:1; |
0ec7ca41 | 483 | |
9cd68455 | 484 | /** Do readpages asynchronously? Only set in INIT */ |
1729a16c | 485 | unsigned async_read:1; |
9cd68455 | 486 | |
6ff958ed | 487 | /** Do not send separate SETATTR request before open(O_TRUNC) */ |
1729a16c | 488 | unsigned atomic_o_trunc:1; |
6ff958ed | 489 | |
33670fa2 | 490 | /** Filesystem supports NFS exporting. Only set in INIT */ |
1729a16c | 491 | unsigned export_support:1; |
33670fa2 | 492 | |
a325f9b9 TH |
493 | /** Set if bdi is valid */ |
494 | unsigned bdi_initialized:1; | |
495 | ||
d5cd66c5 PE |
496 | /** write-back cache policy (default is write-through) */ |
497 | unsigned writeback_cache:1; | |
498 | ||
095da6cb MS |
499 | /* |
500 | * The following bitfields are only for optimization purposes | |
501 | * and hence races in setting them will not cause malfunction | |
502 | */ | |
503 | ||
7678ac50 AG |
504 | /** Is open/release not implemented by fs? */ |
505 | unsigned no_open:1; | |
506 | ||
b6aeaded | 507 | /** Is fsync not implemented by fs? */ |
1729a16c | 508 | unsigned no_fsync:1; |
b6aeaded | 509 | |
82547981 | 510 | /** Is fsyncdir not implemented by fs? */ |
1729a16c | 511 | unsigned no_fsyncdir:1; |
82547981 | 512 | |
b6aeaded | 513 | /** Is flush not implemented by fs? */ |
1729a16c | 514 | unsigned no_flush:1; |
b6aeaded | 515 | |
92a8780e | 516 | /** Is setxattr not implemented by fs? */ |
1729a16c | 517 | unsigned no_setxattr:1; |
92a8780e MS |
518 | |
519 | /** Is getxattr not implemented by fs? */ | |
1729a16c | 520 | unsigned no_getxattr:1; |
92a8780e MS |
521 | |
522 | /** Is listxattr not implemented by fs? */ | |
1729a16c | 523 | unsigned no_listxattr:1; |
92a8780e MS |
524 | |
525 | /** Is removexattr not implemented by fs? */ | |
1729a16c | 526 | unsigned no_removexattr:1; |
92a8780e | 527 | |
37fb3a30 | 528 | /** Are posix file locking primitives not implemented by fs? */ |
1729a16c | 529 | unsigned no_lock:1; |
71421259 | 530 | |
31d40d74 | 531 | /** Is access not implemented by fs? */ |
1729a16c | 532 | unsigned no_access:1; |
31d40d74 | 533 | |
fd72faac | 534 | /** Is create not implemented by fs? */ |
1729a16c | 535 | unsigned no_create:1; |
fd72faac | 536 | |
a4d27e75 | 537 | /** Is interrupt not implemented by fs? */ |
1729a16c | 538 | unsigned no_interrupt:1; |
a4d27e75 | 539 | |
b2d2272f | 540 | /** Is bmap not implemented by fs? */ |
1729a16c | 541 | unsigned no_bmap:1; |
b2d2272f | 542 | |
95668a69 TH |
543 | /** Is poll not implemented by fs? */ |
544 | unsigned no_poll:1; | |
545 | ||
78bb6cb9 | 546 | /** Do multi-page cached writes */ |
1729a16c | 547 | unsigned big_writes:1; |
78bb6cb9 | 548 | |
e0a43ddc MS |
549 | /** Don't apply umask to creation modes */ |
550 | unsigned dont_mask:1; | |
551 | ||
37fb3a30 MS |
552 | /** Are BSD file locking primitives not implemented by fs? */ |
553 | unsigned no_flock:1; | |
554 | ||
519c6040 MS |
555 | /** Is fallocate not implemented by fs? */ |
556 | unsigned no_fallocate:1; | |
557 | ||
1560c974 MS |
558 | /** Is rename with flags implemented by fs? */ |
559 | unsigned no_rename2:1; | |
560 | ||
72d0d248 BF |
561 | /** Use enhanced/automatic page cache invalidation. */ |
562 | unsigned auto_inval_data:1; | |
563 | ||
634734b6 | 564 | /** Does the filesystem support readdirplus? */ |
0b05b183 AA |
565 | unsigned do_readdirplus:1; |
566 | ||
634734b6 EW |
567 | /** Does the filesystem want adaptive readdirplus? */ |
568 | unsigned readdirplus_auto:1; | |
569 | ||
60b9df7a MS |
570 | /** Does the filesystem support asynchronous direct-IO submission? */ |
571 | unsigned async_dio:1; | |
572 | ||
0cd5b885 MS |
573 | /** The number of requests waiting for completion */ |
574 | atomic_t num_waiting; | |
575 | ||
45714d65 MS |
576 | /** Negotiated minor version */ |
577 | unsigned minor; | |
578 | ||
d8a5ba45 MS |
579 | /** Backing dev info */ |
580 | struct backing_dev_info bdi; | |
f543f253 | 581 | |
bafa9654 MS |
582 | /** Entry on the fuse_conn_list */ |
583 | struct list_head entry; | |
584 | ||
b6f2fcbc MS |
585 | /** Device ID from super block */ |
586 | dev_t dev; | |
bafa9654 MS |
587 | |
588 | /** Dentries in the control filesystem */ | |
589 | struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES]; | |
590 | ||
591 | /** number of dentries used in the above array */ | |
592 | int ctl_ndents; | |
385a17bf JD |
593 | |
594 | /** O_ASYNC requests */ | |
595 | struct fasync_struct *fasync; | |
9c8ef561 MS |
596 | |
597 | /** Key for lock owner ID scrambling */ | |
598 | u32 scramble_key[4]; | |
0ec7ca41 MS |
599 | |
600 | /** Reserved request for the DESTROY message */ | |
601 | struct fuse_req *destroy_req; | |
1fb69e78 MS |
602 | |
603 | /** Version counter for attribute changes */ | |
604 | u64 attr_version; | |
43901aab TH |
605 | |
606 | /** Called on final put */ | |
607 | void (*release)(struct fuse_conn *); | |
3b463ae0 JM |
608 | |
609 | /** Super block for this connection. */ | |
610 | struct super_block *sb; | |
611 | ||
612 | /** Read/write semaphore to hold when accessing sb. */ | |
613 | struct rw_semaphore killsb; | |
d8a5ba45 MS |
614 | }; |
615 | ||
d8a5ba45 MS |
616 | static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb) |
617 | { | |
6383bdaa | 618 | return sb->s_fs_info; |
d8a5ba45 MS |
619 | } |
620 | ||
621 | static inline struct fuse_conn *get_fuse_conn(struct inode *inode) | |
622 | { | |
623 | return get_fuse_conn_super(inode->i_sb); | |
624 | } | |
625 | ||
626 | static inline struct fuse_inode *get_fuse_inode(struct inode *inode) | |
627 | { | |
628 | return container_of(inode, struct fuse_inode, inode); | |
629 | } | |
630 | ||
631 | static inline u64 get_node_id(struct inode *inode) | |
632 | { | |
633 | return get_fuse_inode(inode)->nodeid; | |
634 | } | |
635 | ||
334f485d | 636 | /** Device operations */ |
4b6f5d20 | 637 | extern const struct file_operations fuse_dev_operations; |
334f485d | 638 | |
4269590a | 639 | extern const struct dentry_operations fuse_dentry_operations; |
dbd561d2 | 640 | |
3b463ae0 JM |
641 | /** |
642 | * Inode to nodeid comparison. | |
643 | */ | |
644 | int fuse_inode_eq(struct inode *inode, void *_nodeidp); | |
645 | ||
e5e5558e MS |
646 | /** |
647 | * Get a filled in inode | |
648 | */ | |
b48badf0 | 649 | struct inode *fuse_iget(struct super_block *sb, u64 nodeid, |
1fb69e78 MS |
650 | int generation, struct fuse_attr *attr, |
651 | u64 attr_valid, u64 attr_version); | |
e5e5558e | 652 | |
33670fa2 MS |
653 | int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name, |
654 | struct fuse_entry_out *outarg, struct inode **inode); | |
655 | ||
e5e5558e MS |
656 | /** |
657 | * Send FORGET command | |
658 | */ | |
07e77dca MS |
659 | void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget, |
660 | u64 nodeid, u64 nlookup); | |
661 | ||
662 | struct fuse_forget_link *fuse_alloc_forget(void); | |
e5e5558e | 663 | |
0b05b183 AA |
664 | /* Used by READDIRPLUS */ |
665 | void fuse_force_forget(struct file *file, u64 nodeid); | |
666 | ||
04730fef | 667 | /** |
361b1eb5 | 668 | * Initialize READ or READDIR request |
04730fef | 669 | */ |
a6643094 | 670 | void fuse_read_fill(struct fuse_req *req, struct file *file, |
2106cb18 | 671 | loff_t pos, size_t count, int opcode); |
04730fef MS |
672 | |
673 | /** | |
674 | * Send OPEN or OPENDIR request | |
675 | */ | |
91fe96b4 | 676 | int fuse_open_common(struct inode *inode, struct file *file, bool isdir); |
04730fef | 677 | |
acf99433 | 678 | struct fuse_file *fuse_file_alloc(struct fuse_conn *fc); |
c7b7143c | 679 | struct fuse_file *fuse_file_get(struct fuse_file *ff); |
fd72faac | 680 | void fuse_file_free(struct fuse_file *ff); |
c7b7143c | 681 | void fuse_finish_open(struct inode *inode, struct file *file); |
fd72faac | 682 | |
8b0797a4 | 683 | void fuse_sync_release(struct fuse_file *ff, int flags); |
c756e0a4 | 684 | |
04730fef MS |
685 | /** |
686 | * Send RELEASE or RELEASEDIR request | |
687 | */ | |
8b0797a4 | 688 | void fuse_release_common(struct file *file, int opcode); |
04730fef | 689 | |
82547981 MS |
690 | /** |
691 | * Send FSYNC or FSYNCDIR request | |
692 | */ | |
02c24a82 JB |
693 | int fuse_fsync_common(struct file *file, loff_t start, loff_t end, |
694 | int datasync, int isdir); | |
82547981 | 695 | |
95668a69 TH |
696 | /** |
697 | * Notify poll wakeup | |
698 | */ | |
699 | int fuse_notify_poll_wakeup(struct fuse_conn *fc, | |
700 | struct fuse_notify_poll_wakeup_out *outarg); | |
701 | ||
b6aeaded | 702 | /** |
1779381d | 703 | * Initialize file operations on a regular file |
b6aeaded MS |
704 | */ |
705 | void fuse_init_file_inode(struct inode *inode); | |
706 | ||
e5e5558e | 707 | /** |
1779381d | 708 | * Initialize inode operations on regular files and special files |
e5e5558e MS |
709 | */ |
710 | void fuse_init_common(struct inode *inode); | |
711 | ||
712 | /** | |
1779381d | 713 | * Initialize inode and file operations on a directory |
e5e5558e MS |
714 | */ |
715 | void fuse_init_dir(struct inode *inode); | |
716 | ||
717 | /** | |
1779381d | 718 | * Initialize inode operations on a symlink |
e5e5558e MS |
719 | */ |
720 | void fuse_init_symlink(struct inode *inode); | |
721 | ||
722 | /** | |
723 | * Change attributes of an inode | |
724 | */ | |
1fb69e78 MS |
725 | void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr, |
726 | u64 attr_valid, u64 attr_version); | |
e5e5558e | 727 | |
3be5a52b MS |
728 | void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr, |
729 | u64 attr_valid); | |
730 | ||
334f485d MS |
731 | /** |
732 | * Initialize the client device | |
733 | */ | |
734 | int fuse_dev_init(void); | |
735 | ||
736 | /** | |
737 | * Cleanup the client device | |
738 | */ | |
739 | void fuse_dev_cleanup(void); | |
740 | ||
bafa9654 | 741 | int fuse_ctl_init(void); |
7736e8cc | 742 | void __exit fuse_ctl_cleanup(void); |
bafa9654 | 743 | |
334f485d MS |
744 | /** |
745 | * Allocate a request | |
746 | */ | |
4250c066 | 747 | struct fuse_req *fuse_request_alloc(unsigned npages); |
334f485d | 748 | |
4250c066 | 749 | struct fuse_req *fuse_request_alloc_nofs(unsigned npages); |
3be5a52b | 750 | |
334f485d MS |
751 | /** |
752 | * Free a request | |
753 | */ | |
754 | void fuse_request_free(struct fuse_req *req); | |
755 | ||
334f485d | 756 | /** |
b111c8c0 MP |
757 | * Get a request, may fail with -ENOMEM, |
758 | * caller should specify # elements in req->pages[] explicitly | |
334f485d | 759 | */ |
b111c8c0 | 760 | struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages); |
8b41e671 MP |
761 | struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc, |
762 | unsigned npages); | |
b111c8c0 | 763 | |
36cf66ed MP |
764 | /* |
765 | * Increment reference count on request | |
766 | */ | |
767 | void __fuse_get_request(struct fuse_req *req); | |
768 | ||
33649c91 MS |
769 | /** |
770 | * Gets a requests for a file operation, always succeeds | |
771 | */ | |
b111c8c0 MP |
772 | struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc, |
773 | struct file *file); | |
33649c91 | 774 | |
334f485d | 775 | /** |
ce1d5a49 MS |
776 | * Decrement reference count of a request. If count goes to zero free |
777 | * the request. | |
334f485d MS |
778 | */ |
779 | void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req); | |
780 | ||
781 | /** | |
7c352bdf | 782 | * Send a request (synchronous) |
334f485d | 783 | */ |
b93f858a | 784 | void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req); |
334f485d | 785 | |
7078187a MS |
786 | /** |
787 | * Simple request sending that does request allocation and freeing | |
788 | */ | |
789 | ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args); | |
790 | ||
334f485d MS |
791 | /** |
792 | * Send a request in the background | |
793 | */ | |
b93f858a | 794 | void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req); |
334f485d | 795 | |
b93f858a TH |
796 | void fuse_request_send_background_locked(struct fuse_conn *fc, |
797 | struct fuse_req *req); | |
3be5a52b | 798 | |
5a5fb1ea | 799 | /* Abort all requests */ |
69a53bf2 MS |
800 | void fuse_abort_conn(struct fuse_conn *fc); |
801 | ||
e5e5558e MS |
802 | /** |
803 | * Invalidate inode attributes | |
804 | */ | |
805 | void fuse_invalidate_attr(struct inode *inode); | |
bafa9654 | 806 | |
dbd561d2 MS |
807 | void fuse_invalidate_entry_cache(struct dentry *entry); |
808 | ||
451418fc AG |
809 | void fuse_invalidate_atime(struct inode *inode); |
810 | ||
bafa9654 MS |
811 | /** |
812 | * Acquire reference to fuse_conn | |
813 | */ | |
814 | struct fuse_conn *fuse_conn_get(struct fuse_conn *fc); | |
815 | ||
0d179aa5 TH |
816 | /** |
817 | * Initialize fuse_conn | |
818 | */ | |
a325f9b9 | 819 | void fuse_conn_init(struct fuse_conn *fc); |
0d179aa5 | 820 | |
bafa9654 MS |
821 | /** |
822 | * Release reference to fuse_conn | |
823 | */ | |
824 | void fuse_conn_put(struct fuse_conn *fc); | |
825 | ||
826 | /** | |
827 | * Add connection to control filesystem | |
828 | */ | |
829 | int fuse_ctl_add_conn(struct fuse_conn *fc); | |
830 | ||
831 | /** | |
832 | * Remove connection from control filesystem | |
833 | */ | |
834 | void fuse_ctl_remove_conn(struct fuse_conn *fc); | |
a5bfffac TS |
835 | |
836 | /** | |
837 | * Is file type valid? | |
838 | */ | |
839 | int fuse_valid_type(int m); | |
e57ac683 MS |
840 | |
841 | /** | |
c2132c1b | 842 | * Is current process allowed to perform filesystem operation? |
e57ac683 | 843 | */ |
c2132c1b | 844 | int fuse_allow_current_process(struct fuse_conn *fc); |
f3332114 MS |
845 | |
846 | u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id); | |
bcb4be80 MS |
847 | |
848 | int fuse_update_attributes(struct inode *inode, struct kstat *stat, | |
849 | struct file *file, bool *refreshed); | |
3be5a52b MS |
850 | |
851 | void fuse_flush_writepages(struct inode *inode); | |
852 | ||
853 | void fuse_set_nowrite(struct inode *inode); | |
854 | void fuse_release_nowrite(struct inode *inode); | |
5c5c5e51 MS |
855 | |
856 | u64 fuse_get_attr_version(struct fuse_conn *fc); | |
29d434b3 | 857 | |
3b463ae0 JM |
858 | /** |
859 | * File-system tells the kernel to invalidate cache for the given node id. | |
860 | */ | |
861 | int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid, | |
862 | loff_t offset, loff_t len); | |
863 | ||
864 | /** | |
865 | * File-system tells the kernel to invalidate parent attributes and | |
866 | * the dentry matching parent/name. | |
451d0f59 JM |
867 | * |
868 | * If the child_nodeid is non-zero and: | |
869 | * - matches the inode number for the dentry matching parent/name, | |
870 | * - is not a mount point | |
871 | * - is a file or oan empty directory | |
872 | * then the dentry is unhashed (d_delete()). | |
3b463ae0 JM |
873 | */ |
874 | int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid, | |
451d0f59 | 875 | u64 child_nodeid, struct qstr *name); |
3b463ae0 | 876 | |
08cbf542 TH |
877 | int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file, |
878 | bool isdir); | |
ea8cd333 PE |
879 | |
880 | /** | |
881 | * fuse_direct_io() flags | |
882 | */ | |
883 | ||
884 | /** If set, it is WRITE; otherwise - READ */ | |
885 | #define FUSE_DIO_WRITE (1 << 0) | |
886 | ||
887 | /** CUSE pass fuse_direct_io() a file which f_mapping->host is not from FUSE */ | |
888 | #define FUSE_DIO_CUSE (1 << 1) | |
889 | ||
d22a943f AV |
890 | ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter, |
891 | loff_t *ppos, int flags); | |
08cbf542 TH |
892 | long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg, |
893 | unsigned int flags); | |
b18da0c5 MS |
894 | long fuse_ioctl_common(struct file *file, unsigned int cmd, |
895 | unsigned long arg, unsigned int flags); | |
08cbf542 TH |
896 | unsigned fuse_file_poll(struct file *file, poll_table *wait); |
897 | int fuse_dev_release(struct inode *inode, struct file *file); | |
898 | ||
b0aa7606 MP |
899 | bool fuse_write_update_size(struct inode *inode, loff_t pos); |
900 | ||
ab9e13f7 | 901 | int fuse_flush_times(struct inode *inode, struct fuse_file *ff); |
1e18bda8 | 902 | int fuse_write_inode(struct inode *inode, struct writeback_control *wbc); |
a1d75f25 | 903 | |
efb9fa9e MP |
904 | int fuse_do_setattr(struct inode *inode, struct iattr *attr, |
905 | struct file *file); | |
906 | ||
9759bd51 MS |
907 | void fuse_set_initialized(struct fuse_conn *fc); |
908 | ||
29d434b3 | 909 | #endif /* _FS_FUSE_I_H */ |