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