blob: 09337bcc255427fe16dbcb1f6c4605831c3cae92 [file] [log] [blame]
Miklos Szeredid8a5ba42005-09-09 13:10:26 -07001/*
2 FUSE: Filesystem in Userspace
Miklos Szeredi1729a162008-11-26 12:03:54 +01003 Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu>
Miklos Szeredid8a5ba42005-09-09 13:10:26 -07004
5 This program can be distributed under the terms of the GNU GPL.
6 See the file COPYING.
7*/
8
Tejun Heo29d434b2008-10-16 16:08:57 +02009#ifndef _FS_FUSE_I_H
10#define _FS_FUSE_I_H
11
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070012#include <linux/fuse.h>
13#include <linux/fs.h>
Miklos Szeredi51eb01e2006-06-25 05:48:50 -070014#include <linux/mount.h>
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070015#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>
Miklos Szeredibafa9652006-06-25 05:48:51 -070020#include <linux/mutex.h>
Miklos Szeredi3be5a522008-04-30 00:54:41 -070021#include <linux/rwsem.h>
Tejun Heo95668a62008-11-26 12:03:55 +010022#include <linux/rbtree.h>
23#include <linux/poll.h>
Miklos Szeredi5a18ec12011-02-25 14:44:58 +010024#include <linux/workqueue.h>
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070025
Miklos Szeredi334f4852005-09-09 13:10:27 -070026/** Max number of pages that can be used in a single read request */
27#define FUSE_MAX_PAGES_PER_REQ 32
28
Miklos Szeredi3be5a522008-04-30 00:54:41 -070029/** Bias for fi->writectr, meaning new writepages must not be sent */
30#define FUSE_NOWRITE INT_MIN
31
Miklos Szeredi1d3d7522006-01-06 00:19:40 -080032/** It could be as large as PATH_MAX, but would that have any uses? */
33#define FUSE_NAME_MAX 1024
34
Miklos Szeredibafa9652006-06-25 05:48:51 -070035/** Number of dentries for each connection in the control filesystem */
Csaba Henk79a9d992009-08-26 19:18:24 +020036#define FUSE_CTL_NUM_DENTRIES 5
Miklos Szeredibafa9652006-06-25 05:48:51 -070037
Miklos Szeredi1e9a4ed2005-09-09 13:10:31 -070038/** 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
Miklos Szeredibafa9652006-06-25 05:48:51 -070047/** List of active connections */
48extern struct list_head fuse_conn_list;
49
50/** Global mutex protecting fuse_conn_list and the control filesystem */
51extern struct mutex fuse_mutex;
Miklos Szeredi413ef8c2005-09-09 13:10:35 -070052
Csaba Henk79a9d992009-08-26 19:18:24 +020053/** Module parameters */
54extern unsigned max_user_bgreq;
55extern unsigned max_user_congthresh;
56
Miklos Szeredi07e77dc2010-12-07 20:16:56 +010057/* One forget request */
58struct fuse_forget_link {
Miklos Szeredi02c048b2010-12-07 20:16:56 +010059 struct fuse_forget_one forget_one;
Miklos Szeredi07e77dc2010-12-07 20:16:56 +010060 struct fuse_forget_link *next;
61};
62
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070063/** FUSE inode */
64struct fuse_inode {
65 /** Inode data */
66 struct inode inode;
67
68 /** Unique ID, which identifies the inode between userspace
69 * and kernel */
70 u64 nodeid;
71
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070072 /** Number of lookups on this inode */
73 u64 nlookup;
74
Miklos Szeredie5e55582005-09-09 13:10:28 -070075 /** The request used for sending the FORGET message */
Miklos Szeredi07e77dc2010-12-07 20:16:56 +010076 struct fuse_forget_link *forget;
Miklos Szeredie5e55582005-09-09 13:10:28 -070077
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070078 /** Time in jiffies until the file attributes are valid */
Miklos Szeredi0a0898c2006-07-30 03:04:10 -070079 u64 i_time;
Miklos Szerediebc14c42007-10-16 23:31:03 -070080
81 /** The sticky bit in inode->i_mode may have been removed, so
82 preserve the original mode */
83 mode_t orig_i_mode;
Miklos Szeredi1fb69e72007-10-18 03:06:58 -070084
85 /** Version of last attribute change */
86 u64 attr_version;
Miklos Szeredi93a8c3c2007-10-18 03:07:03 -070087
88 /** Files usable in writepage. Protected by fc->lock */
89 struct list_head write_files;
Miklos Szeredi3be5a522008-04-30 00:54:41 -070090
91 /** Writepages pending on truncate or fsync */
92 struct list_head queued_writes;
93
94 /** Number of sent writes, a negative bias (FUSE_NOWRITE)
95 * means more writes are blocked */
96 int writectr;
97
98 /** Waitq for writepage completion */
99 wait_queue_head_t page_waitq;
100
101 /** List of writepage requestst (pending or sent) */
102 struct list_head writepages;
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700103};
104
Miklos Szeredida5e4712009-04-28 16:56:36 +0200105struct fuse_conn;
106
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700107/** FUSE specific file data */
108struct fuse_file {
Miklos Szeredida5e4712009-04-28 16:56:36 +0200109 /** Fuse connection for this file */
110 struct fuse_conn *fc;
111
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700112 /** Request reserved for flush and release */
Miklos Szeredi33649c92006-06-25 05:48:52 -0700113 struct fuse_req *reserved_req;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700114
Tejun Heoacf99432008-11-26 12:03:55 +0100115 /** Kernel file handle guaranteed to be unique */
116 u64 kh;
117
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700118 /** File handle used by userspace */
119 u64 fh;
Miklos Szeredic756e0a2007-10-16 23:31:00 -0700120
Miklos Szeredida5e4712009-04-28 16:56:36 +0200121 /** Node id of this file */
122 u64 nodeid;
123
Miklos Szeredic756e0a2007-10-16 23:31:00 -0700124 /** Refcount */
125 atomic_t count;
Miklos Szeredi93a8c3c2007-10-18 03:07:03 -0700126
Miklos Szeredic7b71432009-04-28 16:56:37 +0200127 /** FOPEN_* flags returned by open */
128 u32 open_flags;
129
Miklos Szeredi93a8c3c2007-10-18 03:07:03 -0700130 /** Entry on inode's write_files list */
131 struct list_head write_entry;
Tejun Heo95668a62008-11-26 12:03:55 +0100132
133 /** RB node to be linked on fuse_conn->polled_files */
134 struct rb_node polled_node;
135
136 /** Wait queue head for poll */
137 wait_queue_head_t poll_wait;
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200138
139 /** Has flock been performed on this file? */
140 bool flock:1;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700141};
142
Miklos Szeredi334f4852005-09-09 13:10:27 -0700143/** One input argument of a request */
144struct fuse_in_arg {
145 unsigned size;
146 const void *value;
147};
148
149/** The request input */
150struct fuse_in {
151 /** The request header */
152 struct fuse_in_header h;
153
154 /** True if the data for the last argument is in req->pages */
155 unsigned argpages:1;
156
157 /** Number of arguments */
158 unsigned numargs;
159
160 /** Array of arguments */
161 struct fuse_in_arg args[3];
162};
163
164/** One output argument of a request */
165struct fuse_arg {
166 unsigned size;
167 void *value;
168};
169
170/** The request output */
171struct fuse_out {
172 /** Header returned from userspace */
173 struct fuse_out_header h;
174
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800175 /*
176 * The following bitfields are not changed during the request
177 * processing
178 */
179
Miklos Szeredi334f4852005-09-09 13:10:27 -0700180 /** Last argument is variable length (can be shorter than
181 arg->size) */
182 unsigned argvar:1;
183
184 /** Last argument is a list of pages to copy data to */
185 unsigned argpages:1;
186
187 /** Zero partially or not copied pages */
188 unsigned page_zeroing:1;
189
Miklos Szeredice534fb2010-05-25 15:06:07 +0200190 /** Pages may be replaced with new ones */
191 unsigned page_replace:1;
192
Miklos Szeredi334f4852005-09-09 13:10:27 -0700193 /** Number or arguments */
194 unsigned numargs;
195
196 /** Array of arguments */
197 struct fuse_arg args[3];
198};
199
Miklos Szeredi83cfd492006-01-16 22:14:31 -0800200/** The request state */
201enum fuse_req_state {
202 FUSE_REQ_INIT = 0,
203 FUSE_REQ_PENDING,
204 FUSE_REQ_READING,
205 FUSE_REQ_SENT,
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700206 FUSE_REQ_WRITING,
Miklos Szeredi83cfd492006-01-16 22:14:31 -0800207 FUSE_REQ_FINISHED
208};
209
Miklos Szeredi334f4852005-09-09 13:10:27 -0700210/**
211 * A request to the client
212 */
213struct fuse_req {
Miklos Szeredice1d5a42006-04-10 22:54:58 -0700214 /** This can be on either pending processing or io lists in
215 fuse_conn */
Miklos Szeredi334f4852005-09-09 13:10:27 -0700216 struct list_head list;
217
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700218 /** Entry on the interrupts list */
219 struct list_head intr_entry;
220
Miklos Szeredi334f4852005-09-09 13:10:27 -0700221 /** refcount */
222 atomic_t count;
223
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700224 /** Unique ID for the interrupt request */
225 u64 intr_unique;
226
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800227 /*
228 * The following bitfields are either set once before the
229 * request is queued or setting/clearing them is protected by
Miklos Szeredid7133112006-04-10 22:54:55 -0700230 * fuse_conn->lock
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800231 */
232
Miklos Szeredi334f4852005-09-09 13:10:27 -0700233 /** True if the request has reply */
234 unsigned isreply:1;
235
Miklos Szeredi51eb01e2006-06-25 05:48:50 -0700236 /** Force sending of the request even if interrupted */
237 unsigned force:1;
238
Miklos Szeredif9a28422006-06-25 05:48:53 -0700239 /** The request was aborted */
240 unsigned aborted:1;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700241
242 /** Request is sent in the background */
243 unsigned background:1;
244
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700245 /** The request has been interrupted */
246 unsigned interrupted:1;
247
Miklos Szeredi334f4852005-09-09 13:10:27 -0700248 /** Data is being copied to/from the request */
249 unsigned locked:1;
250
Miklos Szeredi9bc5ddd2006-04-11 21:16:09 +0200251 /** Request is counted as "waiting" */
252 unsigned waiting:1;
253
Miklos Szeredi83cfd492006-01-16 22:14:31 -0800254 /** State of the request */
255 enum fuse_req_state state;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700256
257 /** The request input */
258 struct fuse_in in;
259
260 /** The request output */
261 struct fuse_out out;
262
263 /** Used to wake up the task waiting for completion of request*/
264 wait_queue_head_t waitq;
265
266 /** Data for asynchronous requests */
267 union {
Miklos Szeredib57d4262008-02-06 01:38:39 -0800268 struct {
Miklos Szeredi5a18ec12011-02-25 14:44:58 +0100269 union {
270 struct fuse_release_in in;
271 struct work_struct work;
272 };
Miklos Szeredib0be46e2009-04-28 16:56:36 +0200273 struct path path;
Miklos Szeredib57d4262008-02-06 01:38:39 -0800274 } release;
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800275 struct fuse_init_in init_in;
276 struct fuse_init_out init_out;
Tejun Heo08cbf542009-04-14 10:54:53 +0900277 struct cuse_init_in cuse_init_in;
Miklos Szeredi5c5c5e52008-04-30 00:54:43 -0700278 struct {
279 struct fuse_read_in in;
280 u64 attr_ver;
281 } read;
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700282 struct {
283 struct fuse_write_in in;
284 struct fuse_write_out out;
285 } write;
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200286 struct fuse_notify_retrieve_in retrieve_in;
Miklos Szeredi71421252006-06-25 05:48:52 -0700287 struct fuse_lk_in lk_in;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700288 } misc;
289
290 /** page vector */
291 struct page *pages[FUSE_MAX_PAGES_PER_REQ];
292
293 /** number of pages in vector */
294 unsigned num_pages;
295
296 /** offset of data on first page */
297 unsigned page_offset;
298
Miklos Szeredi334f4852005-09-09 13:10:27 -0700299 /** File used in the request (or NULL) */
Miklos Szeredic756e0a2007-10-16 23:31:00 -0700300 struct fuse_file *ff;
Miklos Szeredi64c6d8e2006-01-16 22:14:42 -0800301
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700302 /** Inode used in the request or NULL */
303 struct inode *inode;
304
305 /** Link on fi->writepages */
306 struct list_head writepages_entry;
307
Miklos Szeredi64c6d8e2006-01-16 22:14:42 -0800308 /** Request completion callback */
309 void (*end)(struct fuse_conn *, struct fuse_req *);
Miklos Szeredi33649c92006-06-25 05:48:52 -0700310
311 /** Request is stolen from fuse_file->reserved_req */
312 struct file *stolen_file;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700313};
314
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700315/**
316 * A Fuse connection.
317 *
318 * This structure is created, when the filesystem is mounted, and is
319 * destroyed, when the client device is closed and the filesystem is
320 * unmounted.
321 */
322struct fuse_conn {
Miklos Szeredid7133112006-04-10 22:54:55 -0700323 /** Lock protecting accessess to members of this structure */
324 spinlock_t lock;
325
Miklos Szeredid2a85162006-10-17 00:10:11 -0700326 /** Mutex protecting against directory alias creation */
327 struct mutex inst_mutex;
328
Miklos Szeredibafa9652006-06-25 05:48:51 -0700329 /** Refcount */
330 atomic_t count;
331
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700332 /** The user id for this mount */
333 uid_t user_id;
334
Miklos Szeredi87729a52005-09-09 13:10:34 -0700335 /** The group id for this mount */
336 gid_t group_id;
337
Miklos Szeredi1e9a4ed2005-09-09 13:10:31 -0700338 /** The fuse mount flags for this mount */
339 unsigned flags;
340
Miklos Szeredidb50b962005-09-09 13:10:33 -0700341 /** Maximum read size */
342 unsigned max_read;
343
Miklos Szeredi413ef8c2005-09-09 13:10:35 -0700344 /** Maximum write size */
345 unsigned max_write;
346
Miklos Szeredi334f4852005-09-09 13:10:27 -0700347 /** Readers of the connection are waiting on this */
348 wait_queue_head_t waitq;
349
350 /** The list of pending requests */
351 struct list_head pending;
352
353 /** The list of requests being processed */
354 struct list_head processing;
355
Miklos Szeredid77a1d52006-01-16 22:14:31 -0800356 /** The list of requests under I/O */
357 struct list_head io;
358
Tejun Heoacf99432008-11-26 12:03:55 +0100359 /** The next unique kernel file handle */
360 u64 khctr;
361
Tejun Heo95668a62008-11-26 12:03:55 +0100362 /** rbtree of fuse_files waiting for poll events indexed by ph */
363 struct rb_root polled_files;
364
Csaba Henk7a6d3c82009-07-01 17:28:41 -0700365 /** Maximum number of outstanding background requests */
366 unsigned max_background;
367
368 /** Number of background requests at which congestion starts */
369 unsigned congestion_threshold;
370
Miklos Szeredi08a53cd2006-04-10 22:54:59 -0700371 /** Number of requests currently in the background */
372 unsigned num_background;
373
Miklos Szeredid12def12008-02-06 01:38:39 -0800374 /** Number of background requests currently queued for userspace */
375 unsigned active_background;
376
377 /** The list of background requests set aside for later queuing */
378 struct list_head bg_queue;
379
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700380 /** Pending interrupts */
381 struct list_head interrupts;
382
Miklos Szeredi07e77dc2010-12-07 20:16:56 +0100383 /** Queue of pending forgets */
384 struct fuse_forget_link forget_list_head;
385 struct fuse_forget_link *forget_list_tail;
386
387 /** Batching of FORGET requests (positive indicates FORGET batch) */
388 int forget_batch;
389
Miklos Szeredi08a53cd2006-04-10 22:54:59 -0700390 /** Flag indicating if connection is blocked. This will be
391 the case before the INIT reply is received, and if there
392 are too many outstading backgrounds requests */
393 int blocked;
394
395 /** waitq for blocked connection */
396 wait_queue_head_t blocked_waitq;
397
Miklos Szeredide5e3de2007-10-16 23:31:00 -0700398 /** waitq for reserved requests */
399 wait_queue_head_t reserved_req_waitq;
400
Miklos Szeredi334f4852005-09-09 13:10:27 -0700401 /** The next unique request id */
402 u64 reqctr;
403
Miklos Szeredi69a53bf2006-01-16 22:14:41 -0800404 /** Connection established, cleared on umount, connection
405 abort and device release */
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800406 unsigned connected;
Miklos Szeredi1e9a4ed2005-09-09 13:10:31 -0700407
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800408 /** Connection failed (version mismatch). Cannot race with
409 setting other bitfields since it is only set once in INIT
410 reply, before any other request, and never cleared */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100411 unsigned conn_error:1;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700412
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800413 /** Connection successful. Only set in INIT */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100414 unsigned conn_init:1;
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800415
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800416 /** Do readpages asynchronously? Only set in INIT */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100417 unsigned async_read:1;
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800418
Miklos Szeredi6ff958e2007-10-18 03:07:02 -0700419 /** Do not send separate SETATTR request before open(O_TRUNC) */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100420 unsigned atomic_o_trunc:1;
Miklos Szeredi6ff958e2007-10-18 03:07:02 -0700421
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700422 /** Filesystem supports NFS exporting. Only set in INIT */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100423 unsigned export_support:1;
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700424
Tejun Heoa325f9b2009-04-14 10:54:52 +0900425 /** Set if bdi is valid */
426 unsigned bdi_initialized:1;
427
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800428 /*
429 * The following bitfields are only for optimization purposes
430 * and hence races in setting them will not cause malfunction
431 */
432
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700433 /** Is fsync not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100434 unsigned no_fsync:1;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700435
Miklos Szeredi82547982005-09-09 13:10:38 -0700436 /** Is fsyncdir not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100437 unsigned no_fsyncdir:1;
Miklos Szeredi82547982005-09-09 13:10:38 -0700438
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700439 /** Is flush not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100440 unsigned no_flush:1;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700441
Miklos Szeredi92a87802005-09-09 13:10:31 -0700442 /** Is setxattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100443 unsigned no_setxattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700444
445 /** Is getxattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100446 unsigned no_getxattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700447
448 /** Is listxattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100449 unsigned no_listxattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700450
451 /** Is removexattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100452 unsigned no_removexattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700453
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200454 /** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100455 unsigned no_lock:1;
Miklos Szeredi71421252006-06-25 05:48:52 -0700456
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800457 /** Is access not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100458 unsigned no_access:1;
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800459
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800460 /** Is create not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100461 unsigned no_create:1;
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800462
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700463 /** Is interrupt not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100464 unsigned no_interrupt:1;
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700465
Miklos Szeredib2d22722006-12-06 20:35:51 -0800466 /** Is bmap not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100467 unsigned no_bmap:1;
Miklos Szeredib2d22722006-12-06 20:35:51 -0800468
Tejun Heo95668a62008-11-26 12:03:55 +0100469 /** Is poll not implemented by fs? */
470 unsigned no_poll:1;
471
Miklos Szeredi78bb6cb2008-05-12 14:02:32 -0700472 /** Do multi-page cached writes */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100473 unsigned big_writes:1;
Miklos Szeredi78bb6cb2008-05-12 14:02:32 -0700474
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200475 /** Don't apply umask to creation modes */
476 unsigned dont_mask:1;
477
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200478 /** Are BSD file locking primitives not implemented by fs? */
479 unsigned no_flock:1;
480
Miklos Szeredi0cd5b882006-01-16 22:14:38 -0800481 /** The number of requests waiting for completion */
482 atomic_t num_waiting;
483
Miklos Szeredi45714d62006-01-06 00:19:36 -0800484 /** Negotiated minor version */
485 unsigned minor;
486
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700487 /** Backing dev info */
488 struct backing_dev_info bdi;
Miklos Szeredif543f252006-01-16 22:14:35 -0800489
Miklos Szeredibafa9652006-06-25 05:48:51 -0700490 /** Entry on the fuse_conn_list */
491 struct list_head entry;
492
Miklos Szeredib6f2fcb2008-04-30 00:54:34 -0700493 /** Device ID from super block */
494 dev_t dev;
Miklos Szeredibafa9652006-06-25 05:48:51 -0700495
496 /** Dentries in the control filesystem */
497 struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
498
499 /** number of dentries used in the above array */
500 int ctl_ndents;
Jeff Dike385a17b2006-04-10 22:54:52 -0700501
502 /** O_ASYNC requests */
503 struct fasync_struct *fasync;
Miklos Szeredi9c8ef562006-06-25 05:48:55 -0700504
505 /** Key for lock owner ID scrambling */
506 u32 scramble_key[4];
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800507
508 /** Reserved request for the DESTROY message */
509 struct fuse_req *destroy_req;
Miklos Szeredi1fb69e72007-10-18 03:06:58 -0700510
511 /** Version counter for attribute changes */
512 u64 attr_version;
Tejun Heo43901aa2008-11-26 12:03:56 +0100513
514 /** Called on final put */
515 void (*release)(struct fuse_conn *);
John Muir3b463ae2009-05-31 11:13:57 -0400516
517 /** Super block for this connection. */
518 struct super_block *sb;
519
520 /** Read/write semaphore to hold when accessing sb. */
521 struct rw_semaphore killsb;
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700522};
523
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700524static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
525{
Miklos Szeredi6383bda2006-01-16 22:14:29 -0800526 return sb->s_fs_info;
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700527}
528
529static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
530{
531 return get_fuse_conn_super(inode->i_sb);
532}
533
534static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
535{
536 return container_of(inode, struct fuse_inode, inode);
537}
538
539static inline u64 get_node_id(struct inode *inode)
540{
541 return get_fuse_inode(inode)->nodeid;
542}
543
Miklos Szeredi334f4852005-09-09 13:10:27 -0700544/** Device operations */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800545extern const struct file_operations fuse_dev_operations;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700546
Al Viro42695902009-02-20 05:59:13 +0000547extern const struct dentry_operations fuse_dentry_operations;
Miklos Szeredidbd561d2008-07-25 01:49:00 -0700548
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700549/**
John Muir3b463ae2009-05-31 11:13:57 -0400550 * Inode to nodeid comparison.
551 */
552int fuse_inode_eq(struct inode *inode, void *_nodeidp);
553
554/**
Miklos Szeredie5e55582005-09-09 13:10:28 -0700555 * Get a filled in inode
556 */
Miklos Szeredib48badf2008-04-30 00:54:44 -0700557struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
Miklos Szeredi1fb69e72007-10-18 03:06:58 -0700558 int generation, struct fuse_attr *attr,
559 u64 attr_valid, u64 attr_version);
Miklos Szeredie5e55582005-09-09 13:10:28 -0700560
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700561int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
562 struct fuse_entry_out *outarg, struct inode **inode);
563
Miklos Szeredie5e55582005-09-09 13:10:28 -0700564/**
565 * Send FORGET command
566 */
Miklos Szeredi07e77dc2010-12-07 20:16:56 +0100567void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
568 u64 nodeid, u64 nlookup);
569
570struct fuse_forget_link *fuse_alloc_forget(void);
Miklos Szeredie5e55582005-09-09 13:10:28 -0700571
572/**
Miklos Szeredi361b1eb2006-01-16 22:14:45 -0800573 * Initialize READ or READDIR request
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700574 */
Miklos Szeredia6643092007-11-28 16:22:00 -0800575void fuse_read_fill(struct fuse_req *req, struct file *file,
Miklos Szeredi2106cb12009-04-28 16:56:37 +0200576 loff_t pos, size_t count, int opcode);
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700577
578/**
579 * Send OPEN or OPENDIR request
580 */
Miklos Szeredi91fe96b2009-04-28 16:56:37 +0200581int fuse_open_common(struct inode *inode, struct file *file, bool isdir);
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700582
Tejun Heoacf99432008-11-26 12:03:55 +0100583struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
Miklos Szeredic7b71432009-04-28 16:56:37 +0200584struct fuse_file *fuse_file_get(struct fuse_file *ff);
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800585void fuse_file_free(struct fuse_file *ff);
Miklos Szeredic7b71432009-04-28 16:56:37 +0200586void fuse_finish_open(struct inode *inode, struct file *file);
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800587
Miklos Szeredi8b0797a2009-04-28 16:56:39 +0200588void fuse_sync_release(struct fuse_file *ff, int flags);
Miklos Szeredic756e0a2007-10-16 23:31:00 -0700589
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700590/**
591 * Send RELEASE or RELEASEDIR request
592 */
Miklos Szeredi8b0797a2009-04-28 16:56:39 +0200593void fuse_release_common(struct file *file, int opcode);
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700594
595/**
Miklos Szeredi82547982005-09-09 13:10:38 -0700596 * Send FSYNC or FSYNCDIR request
597 */
Josef Bacik02c24a82011-07-16 20:44:56 -0400598int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
599 int datasync, int isdir);
Miklos Szeredi82547982005-09-09 13:10:38 -0700600
601/**
Tejun Heo95668a62008-11-26 12:03:55 +0100602 * Notify poll wakeup
603 */
604int fuse_notify_poll_wakeup(struct fuse_conn *fc,
605 struct fuse_notify_poll_wakeup_out *outarg);
606
607/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800608 * Initialize file operations on a regular file
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700609 */
610void fuse_init_file_inode(struct inode *inode);
611
612/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800613 * Initialize inode operations on regular files and special files
Miklos Szeredie5e55582005-09-09 13:10:28 -0700614 */
615void fuse_init_common(struct inode *inode);
616
617/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800618 * Initialize inode and file operations on a directory
Miklos Szeredie5e55582005-09-09 13:10:28 -0700619 */
620void fuse_init_dir(struct inode *inode);
621
622/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800623 * Initialize inode operations on a symlink
Miklos Szeredie5e55582005-09-09 13:10:28 -0700624 */
625void fuse_init_symlink(struct inode *inode);
626
627/**
628 * Change attributes of an inode
629 */
Miklos Szeredi1fb69e72007-10-18 03:06:58 -0700630void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
631 u64 attr_valid, u64 attr_version);
Miklos Szeredie5e55582005-09-09 13:10:28 -0700632
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700633void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
634 u64 attr_valid);
635
Miklos Szeredie5e55582005-09-09 13:10:28 -0700636/**
Miklos Szeredi334f4852005-09-09 13:10:27 -0700637 * Initialize the client device
638 */
639int fuse_dev_init(void);
640
641/**
642 * Cleanup the client device
643 */
644void fuse_dev_cleanup(void);
645
Miklos Szeredibafa9652006-06-25 05:48:51 -0700646int fuse_ctl_init(void);
647void fuse_ctl_cleanup(void);
648
Miklos Szeredi334f4852005-09-09 13:10:27 -0700649/**
650 * Allocate a request
651 */
652struct fuse_req *fuse_request_alloc(void);
653
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700654struct fuse_req *fuse_request_alloc_nofs(void);
655
Miklos Szeredi334f4852005-09-09 13:10:27 -0700656/**
657 * Free a request
658 */
659void fuse_request_free(struct fuse_req *req);
660
661/**
Miklos Szeredi33649c92006-06-25 05:48:52 -0700662 * Get a request, may fail with -ENOMEM
Miklos Szeredi334f4852005-09-09 13:10:27 -0700663 */
Miklos Szeredice1d5a42006-04-10 22:54:58 -0700664struct fuse_req *fuse_get_req(struct fuse_conn *fc);
Miklos Szeredi334f4852005-09-09 13:10:27 -0700665
666/**
Miklos Szeredi33649c92006-06-25 05:48:52 -0700667 * Gets a requests for a file operation, always succeeds
668 */
669struct fuse_req *fuse_get_req_nofail(struct fuse_conn *fc, struct file *file);
670
671/**
Miklos Szeredice1d5a42006-04-10 22:54:58 -0700672 * Decrement reference count of a request. If count goes to zero free
673 * the request.
Miklos Szeredi334f4852005-09-09 13:10:27 -0700674 */
675void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
676
677/**
Miklos Szeredi7c352bd2005-09-09 13:10:39 -0700678 * Send a request (synchronous)
Miklos Szeredi334f4852005-09-09 13:10:27 -0700679 */
Tejun Heob93f8582008-11-26 12:03:55 +0100680void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
Miklos Szeredi334f4852005-09-09 13:10:27 -0700681
682/**
Miklos Szeredi334f4852005-09-09 13:10:27 -0700683 * Send a request in the background
684 */
Tejun Heob93f8582008-11-26 12:03:55 +0100685void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
Miklos Szeredi334f4852005-09-09 13:10:27 -0700686
Tejun Heob93f8582008-11-26 12:03:55 +0100687void fuse_request_send_background_locked(struct fuse_conn *fc,
688 struct fuse_req *req);
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700689
Miklos Szeredi5a5fb1e2006-04-26 10:48:55 +0200690/* Abort all requests */
Miklos Szeredi69a53bf2006-01-16 22:14:41 -0800691void fuse_abort_conn(struct fuse_conn *fc);
692
Miklos Szeredi1e9a4ed2005-09-09 13:10:31 -0700693/**
Miklos Szeredie5e55582005-09-09 13:10:28 -0700694 * Invalidate inode attributes
695 */
696void fuse_invalidate_attr(struct inode *inode);
Miklos Szeredibafa9652006-06-25 05:48:51 -0700697
Miklos Szeredidbd561d2008-07-25 01:49:00 -0700698void fuse_invalidate_entry_cache(struct dentry *entry);
699
Miklos Szeredibafa9652006-06-25 05:48:51 -0700700/**
701 * Acquire reference to fuse_conn
702 */
703struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
704
Tejun Heo08cbf542009-04-14 10:54:53 +0900705void fuse_conn_kill(struct fuse_conn *fc);
706
Miklos Szeredibafa9652006-06-25 05:48:51 -0700707/**
Tejun Heo0d179aa2008-11-26 12:03:55 +0100708 * Initialize fuse_conn
709 */
Tejun Heoa325f9b2009-04-14 10:54:52 +0900710void fuse_conn_init(struct fuse_conn *fc);
Tejun Heo0d179aa2008-11-26 12:03:55 +0100711
712/**
Miklos Szeredibafa9652006-06-25 05:48:51 -0700713 * Release reference to fuse_conn
714 */
715void fuse_conn_put(struct fuse_conn *fc);
716
717/**
718 * Add connection to control filesystem
719 */
720int fuse_ctl_add_conn(struct fuse_conn *fc);
721
722/**
723 * Remove connection from control filesystem
724 */
725void fuse_ctl_remove_conn(struct fuse_conn *fc);
Timo Savolaa5bfffa2007-04-08 16:04:00 -0700726
727/**
728 * Is file type valid?
729 */
730int fuse_valid_type(int m);
Miklos Szeredie57ac682007-10-18 03:06:58 -0700731
732/**
733 * Is task allowed to perform filesystem operation?
734 */
735int fuse_allow_task(struct fuse_conn *fc, struct task_struct *task);
Miklos Szeredif3332112007-10-18 03:07:04 -0700736
737u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
Miklos Szeredibcb4be82007-11-28 16:21:59 -0800738
739int fuse_update_attributes(struct inode *inode, struct kstat *stat,
740 struct file *file, bool *refreshed);
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700741
742void fuse_flush_writepages(struct inode *inode);
743
744void fuse_set_nowrite(struct inode *inode);
745void fuse_release_nowrite(struct inode *inode);
Miklos Szeredi5c5c5e52008-04-30 00:54:43 -0700746
747u64 fuse_get_attr_version(struct fuse_conn *fc);
Tejun Heo29d434b2008-10-16 16:08:57 +0200748
John Muir3b463ae2009-05-31 11:13:57 -0400749/**
750 * File-system tells the kernel to invalidate cache for the given node id.
751 */
752int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid,
753 loff_t offset, loff_t len);
754
755/**
756 * File-system tells the kernel to invalidate parent attributes and
757 * the dentry matching parent/name.
758 */
759int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
760 struct qstr *name);
761
Tejun Heo08cbf542009-04-14 10:54:53 +0900762int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
763 bool isdir);
764ssize_t fuse_direct_io(struct file *file, const char __user *buf,
765 size_t count, loff_t *ppos, int write);
766long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
767 unsigned int flags);
Miklos Szeredib18da0c2011-12-13 11:58:49 +0100768long fuse_ioctl_common(struct file *file, unsigned int cmd,
769 unsigned long arg, unsigned int flags);
Tejun Heo08cbf542009-04-14 10:54:53 +0900770unsigned fuse_file_poll(struct file *file, poll_table *wait);
771int fuse_dev_release(struct inode *inode, struct file *file);
772
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200773void fuse_write_update_size(struct inode *inode, loff_t pos);
774
Tejun Heo29d434b2008-10-16 16:08:57 +0200775#endif /* _FS_FUSE_I_H */