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