blob: c6aa2d4b851733a250205734215c785be6944507 [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 Szeredib6aeade2005-09-09 13:10:30 -0700138};
139
Miklos Szeredi334f4852005-09-09 13:10:27 -0700140/** One input argument of a request */
141struct fuse_in_arg {
142 unsigned size;
143 const void *value;
144};
145
146/** The request input */
147struct fuse_in {
148 /** The request header */
149 struct fuse_in_header h;
150
151 /** True if the data for the last argument is in req->pages */
152 unsigned argpages:1;
153
154 /** Number of arguments */
155 unsigned numargs;
156
157 /** Array of arguments */
158 struct fuse_in_arg args[3];
159};
160
161/** One output argument of a request */
162struct fuse_arg {
163 unsigned size;
164 void *value;
165};
166
167/** The request output */
168struct fuse_out {
169 /** Header returned from userspace */
170 struct fuse_out_header h;
171
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800172 /*
173 * The following bitfields are not changed during the request
174 * processing
175 */
176
Miklos Szeredi334f4852005-09-09 13:10:27 -0700177 /** Last argument is variable length (can be shorter than
178 arg->size) */
179 unsigned argvar:1;
180
181 /** Last argument is a list of pages to copy data to */
182 unsigned argpages:1;
183
184 /** Zero partially or not copied pages */
185 unsigned page_zeroing:1;
186
Miklos Szeredice534fb2010-05-25 15:06:07 +0200187 /** Pages may be replaced with new ones */
188 unsigned page_replace:1;
189
Miklos Szeredi334f4852005-09-09 13:10:27 -0700190 /** Number or arguments */
191 unsigned numargs;
192
193 /** Array of arguments */
194 struct fuse_arg args[3];
195};
196
Miklos Szeredi83cfd492006-01-16 22:14:31 -0800197/** The request state */
198enum fuse_req_state {
199 FUSE_REQ_INIT = 0,
200 FUSE_REQ_PENDING,
201 FUSE_REQ_READING,
202 FUSE_REQ_SENT,
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700203 FUSE_REQ_WRITING,
Miklos Szeredi83cfd492006-01-16 22:14:31 -0800204 FUSE_REQ_FINISHED
205};
206
Miklos Szeredi334f4852005-09-09 13:10:27 -0700207/**
208 * A request to the client
209 */
210struct fuse_req {
Miklos Szeredice1d5a42006-04-10 22:54:58 -0700211 /** This can be on either pending processing or io lists in
212 fuse_conn */
Miklos Szeredi334f4852005-09-09 13:10:27 -0700213 struct list_head list;
214
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700215 /** Entry on the interrupts list */
216 struct list_head intr_entry;
217
Miklos Szeredi334f4852005-09-09 13:10:27 -0700218 /** refcount */
219 atomic_t count;
220
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700221 /** Unique ID for the interrupt request */
222 u64 intr_unique;
223
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800224 /*
225 * The following bitfields are either set once before the
226 * request is queued or setting/clearing them is protected by
Miklos Szeredid7133112006-04-10 22:54:55 -0700227 * fuse_conn->lock
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800228 */
229
Miklos Szeredi334f4852005-09-09 13:10:27 -0700230 /** True if the request has reply */
231 unsigned isreply:1;
232
Miklos Szeredi51eb01e2006-06-25 05:48:50 -0700233 /** Force sending of the request even if interrupted */
234 unsigned force:1;
235
Miklos Szeredif9a28422006-06-25 05:48:53 -0700236 /** The request was aborted */
237 unsigned aborted:1;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700238
239 /** Request is sent in the background */
240 unsigned background:1;
241
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700242 /** The request has been interrupted */
243 unsigned interrupted:1;
244
Miklos Szeredi334f4852005-09-09 13:10:27 -0700245 /** Data is being copied to/from the request */
246 unsigned locked:1;
247
Miklos Szeredi9bc5ddd2006-04-11 21:16:09 +0200248 /** Request is counted as "waiting" */
249 unsigned waiting:1;
250
Miklos Szeredi83cfd492006-01-16 22:14:31 -0800251 /** State of the request */
252 enum fuse_req_state state;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700253
254 /** The request input */
255 struct fuse_in in;
256
257 /** The request output */
258 struct fuse_out out;
259
260 /** Used to wake up the task waiting for completion of request*/
261 wait_queue_head_t waitq;
262
263 /** Data for asynchronous requests */
264 union {
Miklos Szeredib57d4262008-02-06 01:38:39 -0800265 struct {
Miklos Szeredi5a18ec12011-02-25 14:44:58 +0100266 union {
267 struct fuse_release_in in;
268 struct work_struct work;
269 };
Miklos Szeredib0be46e2009-04-28 16:56:36 +0200270 struct path path;
Miklos Szeredib57d4262008-02-06 01:38:39 -0800271 } release;
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800272 struct fuse_init_in init_in;
273 struct fuse_init_out init_out;
Tejun Heo08cbf542009-04-14 10:54:53 +0900274 struct cuse_init_in cuse_init_in;
Miklos Szeredi5c5c5e52008-04-30 00:54:43 -0700275 struct {
276 struct fuse_read_in in;
277 u64 attr_ver;
278 } read;
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700279 struct {
280 struct fuse_write_in in;
281 struct fuse_write_out out;
282 } write;
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200283 struct fuse_notify_retrieve_in retrieve_in;
Miklos Szeredi71421252006-06-25 05:48:52 -0700284 struct fuse_lk_in lk_in;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700285 } misc;
286
287 /** page vector */
288 struct page *pages[FUSE_MAX_PAGES_PER_REQ];
289
290 /** number of pages in vector */
291 unsigned num_pages;
292
293 /** offset of data on first page */
294 unsigned page_offset;
295
Miklos Szeredi334f4852005-09-09 13:10:27 -0700296 /** File used in the request (or NULL) */
Miklos Szeredic756e0a2007-10-16 23:31:00 -0700297 struct fuse_file *ff;
Miklos Szeredi64c6d8e2006-01-16 22:14:42 -0800298
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700299 /** Inode used in the request or NULL */
300 struct inode *inode;
301
302 /** Link on fi->writepages */
303 struct list_head writepages_entry;
304
Miklos Szeredi64c6d8e2006-01-16 22:14:42 -0800305 /** Request completion callback */
306 void (*end)(struct fuse_conn *, struct fuse_req *);
Miklos Szeredi33649c92006-06-25 05:48:52 -0700307
308 /** Request is stolen from fuse_file->reserved_req */
309 struct file *stolen_file;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700310};
311
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700312/**
313 * A Fuse connection.
314 *
315 * This structure is created, when the filesystem is mounted, and is
316 * destroyed, when the client device is closed and the filesystem is
317 * unmounted.
318 */
319struct fuse_conn {
Miklos Szeredid7133112006-04-10 22:54:55 -0700320 /** Lock protecting accessess to members of this structure */
321 spinlock_t lock;
322
Miklos Szeredid2a85162006-10-17 00:10:11 -0700323 /** Mutex protecting against directory alias creation */
324 struct mutex inst_mutex;
325
Miklos Szeredibafa9652006-06-25 05:48:51 -0700326 /** Refcount */
327 atomic_t count;
328
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700329 /** The user id for this mount */
330 uid_t user_id;
331
Miklos Szeredi87729a52005-09-09 13:10:34 -0700332 /** The group id for this mount */
333 gid_t group_id;
334
Miklos Szeredi1e9a4ed2005-09-09 13:10:31 -0700335 /** The fuse mount flags for this mount */
336 unsigned flags;
337
Miklos Szeredidb50b962005-09-09 13:10:33 -0700338 /** Maximum read size */
339 unsigned max_read;
340
Miklos Szeredi413ef8c2005-09-09 13:10:35 -0700341 /** Maximum write size */
342 unsigned max_write;
343
Miklos Szeredi334f4852005-09-09 13:10:27 -0700344 /** Readers of the connection are waiting on this */
345 wait_queue_head_t waitq;
346
347 /** The list of pending requests */
348 struct list_head pending;
349
350 /** The list of requests being processed */
351 struct list_head processing;
352
Miklos Szeredid77a1d52006-01-16 22:14:31 -0800353 /** The list of requests under I/O */
354 struct list_head io;
355
Tejun Heoacf99432008-11-26 12:03:55 +0100356 /** The next unique kernel file handle */
357 u64 khctr;
358
Tejun Heo95668a62008-11-26 12:03:55 +0100359 /** rbtree of fuse_files waiting for poll events indexed by ph */
360 struct rb_root polled_files;
361
Csaba Henk7a6d3c82009-07-01 17:28:41 -0700362 /** Maximum number of outstanding background requests */
363 unsigned max_background;
364
365 /** Number of background requests at which congestion starts */
366 unsigned congestion_threshold;
367
Miklos Szeredi08a53cd2006-04-10 22:54:59 -0700368 /** Number of requests currently in the background */
369 unsigned num_background;
370
Miklos Szeredid12def12008-02-06 01:38:39 -0800371 /** Number of background requests currently queued for userspace */
372 unsigned active_background;
373
374 /** The list of background requests set aside for later queuing */
375 struct list_head bg_queue;
376
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700377 /** Pending interrupts */
378 struct list_head interrupts;
379
Miklos Szeredi07e77dc2010-12-07 20:16:56 +0100380 /** Queue of pending forgets */
381 struct fuse_forget_link forget_list_head;
382 struct fuse_forget_link *forget_list_tail;
383
384 /** Batching of FORGET requests (positive indicates FORGET batch) */
385 int forget_batch;
386
Miklos Szeredi08a53cd2006-04-10 22:54:59 -0700387 /** Flag indicating if connection is blocked. This will be
388 the case before the INIT reply is received, and if there
389 are too many outstading backgrounds requests */
390 int blocked;
391
392 /** waitq for blocked connection */
393 wait_queue_head_t blocked_waitq;
394
Miklos Szeredide5e3de2007-10-16 23:31:00 -0700395 /** waitq for reserved requests */
396 wait_queue_head_t reserved_req_waitq;
397
Miklos Szeredi334f4852005-09-09 13:10:27 -0700398 /** The next unique request id */
399 u64 reqctr;
400
Miklos Szeredi69a53bf2006-01-16 22:14:41 -0800401 /** Connection established, cleared on umount, connection
402 abort and device release */
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800403 unsigned connected;
Miklos Szeredi1e9a4ed2005-09-09 13:10:31 -0700404
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800405 /** Connection failed (version mismatch). Cannot race with
406 setting other bitfields since it is only set once in INIT
407 reply, before any other request, and never cleared */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100408 unsigned conn_error:1;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700409
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800410 /** Connection successful. Only set in INIT */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100411 unsigned conn_init:1;
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800412
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800413 /** Do readpages asynchronously? Only set in INIT */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100414 unsigned async_read:1;
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800415
Miklos Szeredi6ff958e2007-10-18 03:07:02 -0700416 /** Do not send separate SETATTR request before open(O_TRUNC) */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100417 unsigned atomic_o_trunc:1;
Miklos Szeredi6ff958e2007-10-18 03:07:02 -0700418
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700419 /** Filesystem supports NFS exporting. Only set in INIT */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100420 unsigned export_support:1;
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700421
Tejun Heoa325f9b2009-04-14 10:54:52 +0900422 /** Set if bdi is valid */
423 unsigned bdi_initialized:1;
424
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800425 /*
426 * The following bitfields are only for optimization purposes
427 * and hence races in setting them will not cause malfunction
428 */
429
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700430 /** Is fsync not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100431 unsigned no_fsync:1;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700432
Miklos Szeredi82547982005-09-09 13:10:38 -0700433 /** Is fsyncdir not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100434 unsigned no_fsyncdir:1;
Miklos Szeredi82547982005-09-09 13:10:38 -0700435
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700436 /** Is flush not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100437 unsigned no_flush:1;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700438
Miklos Szeredi92a87802005-09-09 13:10:31 -0700439 /** Is setxattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100440 unsigned no_setxattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700441
442 /** Is getxattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100443 unsigned no_getxattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700444
445 /** Is listxattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100446 unsigned no_listxattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700447
448 /** Is removexattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100449 unsigned no_removexattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700450
Miklos Szeredi71421252006-06-25 05:48:52 -0700451 /** Are file locking primitives not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100452 unsigned no_lock:1;
Miklos Szeredi71421252006-06-25 05:48:52 -0700453
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800454 /** Is access not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100455 unsigned no_access:1;
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800456
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800457 /** Is create not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100458 unsigned no_create:1;
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800459
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700460 /** Is interrupt not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100461 unsigned no_interrupt:1;
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700462
Miklos Szeredib2d22722006-12-06 20:35:51 -0800463 /** Is bmap not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100464 unsigned no_bmap:1;
Miklos Szeredib2d22722006-12-06 20:35:51 -0800465
Tejun Heo95668a62008-11-26 12:03:55 +0100466 /** Is poll not implemented by fs? */
467 unsigned no_poll:1;
468
Miklos Szeredi78bb6cb2008-05-12 14:02:32 -0700469 /** Do multi-page cached writes */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100470 unsigned big_writes:1;
Miklos Szeredi78bb6cb2008-05-12 14:02:32 -0700471
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200472 /** Don't apply umask to creation modes */
473 unsigned dont_mask:1;
474
Miklos Szeredi0cd5b882006-01-16 22:14:38 -0800475 /** The number of requests waiting for completion */
476 atomic_t num_waiting;
477
Miklos Szeredi45714d62006-01-06 00:19:36 -0800478 /** Negotiated minor version */
479 unsigned minor;
480
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700481 /** Backing dev info */
482 struct backing_dev_info bdi;
Miklos Szeredif543f252006-01-16 22:14:35 -0800483
Miklos Szeredibafa9652006-06-25 05:48:51 -0700484 /** Entry on the fuse_conn_list */
485 struct list_head entry;
486
Miklos Szeredib6f2fcb2008-04-30 00:54:34 -0700487 /** Device ID from super block */
488 dev_t dev;
Miklos Szeredibafa9652006-06-25 05:48:51 -0700489
490 /** Dentries in the control filesystem */
491 struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
492
493 /** number of dentries used in the above array */
494 int ctl_ndents;
Jeff Dike385a17b2006-04-10 22:54:52 -0700495
496 /** O_ASYNC requests */
497 struct fasync_struct *fasync;
Miklos Szeredi9c8ef562006-06-25 05:48:55 -0700498
499 /** Key for lock owner ID scrambling */
500 u32 scramble_key[4];
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800501
502 /** Reserved request for the DESTROY message */
503 struct fuse_req *destroy_req;
Miklos Szeredi1fb69e72007-10-18 03:06:58 -0700504
505 /** Version counter for attribute changes */
506 u64 attr_version;
Tejun Heo43901aa2008-11-26 12:03:56 +0100507
508 /** Called on final put */
509 void (*release)(struct fuse_conn *);
John Muir3b463ae2009-05-31 11:13:57 -0400510
511 /** Super block for this connection. */
512 struct super_block *sb;
513
514 /** Read/write semaphore to hold when accessing sb. */
515 struct rw_semaphore killsb;
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700516};
517
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700518static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
519{
Miklos Szeredi6383bda2006-01-16 22:14:29 -0800520 return sb->s_fs_info;
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700521}
522
523static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
524{
525 return get_fuse_conn_super(inode->i_sb);
526}
527
528static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
529{
530 return container_of(inode, struct fuse_inode, inode);
531}
532
533static inline u64 get_node_id(struct inode *inode)
534{
535 return get_fuse_inode(inode)->nodeid;
536}
537
Miklos Szeredi334f4852005-09-09 13:10:27 -0700538/** Device operations */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800539extern const struct file_operations fuse_dev_operations;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700540
Al Viro42695902009-02-20 05:59:13 +0000541extern const struct dentry_operations fuse_dentry_operations;
Miklos Szeredidbd561d2008-07-25 01:49:00 -0700542
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700543/**
John Muir3b463ae2009-05-31 11:13:57 -0400544 * Inode to nodeid comparison.
545 */
546int fuse_inode_eq(struct inode *inode, void *_nodeidp);
547
548/**
Miklos Szeredie5e55582005-09-09 13:10:28 -0700549 * Get a filled in inode
550 */
Miklos Szeredib48badf2008-04-30 00:54:44 -0700551struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
Miklos Szeredi1fb69e72007-10-18 03:06:58 -0700552 int generation, struct fuse_attr *attr,
553 u64 attr_valid, u64 attr_version);
Miklos Szeredie5e55582005-09-09 13:10:28 -0700554
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700555int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
556 struct fuse_entry_out *outarg, struct inode **inode);
557
Miklos Szeredie5e55582005-09-09 13:10:28 -0700558/**
559 * Send FORGET command
560 */
Miklos Szeredi07e77dc2010-12-07 20:16:56 +0100561void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
562 u64 nodeid, u64 nlookup);
563
564struct fuse_forget_link *fuse_alloc_forget(void);
Miklos Szeredie5e55582005-09-09 13:10:28 -0700565
566/**
Miklos Szeredi361b1eb52006-01-16 22:14:45 -0800567 * Initialize READ or READDIR request
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700568 */
Miklos Szeredia6643092007-11-28 16:22:00 -0800569void fuse_read_fill(struct fuse_req *req, struct file *file,
Miklos Szeredi2106cb12009-04-28 16:56:37 +0200570 loff_t pos, size_t count, int opcode);
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700571
572/**
573 * Send OPEN or OPENDIR request
574 */
Miklos Szeredi91fe96b2009-04-28 16:56:37 +0200575int fuse_open_common(struct inode *inode, struct file *file, bool isdir);
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700576
Tejun Heoacf99432008-11-26 12:03:55 +0100577struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
Miklos Szeredic7b71432009-04-28 16:56:37 +0200578struct fuse_file *fuse_file_get(struct fuse_file *ff);
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800579void fuse_file_free(struct fuse_file *ff);
Miklos Szeredic7b71432009-04-28 16:56:37 +0200580void fuse_finish_open(struct inode *inode, struct file *file);
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800581
Miklos Szeredi8b0797a2009-04-28 16:56:39 +0200582void fuse_sync_release(struct fuse_file *ff, int flags);
Miklos Szeredic756e0a2007-10-16 23:31:00 -0700583
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700584/**
585 * Send RELEASE or RELEASEDIR request
586 */
Miklos Szeredi8b0797a2009-04-28 16:56:39 +0200587void fuse_release_common(struct file *file, int opcode);
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700588
589/**
Miklos Szeredi82547982005-09-09 13:10:38 -0700590 * Send FSYNC or FSYNCDIR request
591 */
Josef Bacik02c24a82011-07-16 20:44:56 -0400592int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
593 int datasync, int isdir);
Miklos Szeredi82547982005-09-09 13:10:38 -0700594
595/**
Tejun Heo95668a62008-11-26 12:03:55 +0100596 * Notify poll wakeup
597 */
598int fuse_notify_poll_wakeup(struct fuse_conn *fc,
599 struct fuse_notify_poll_wakeup_out *outarg);
600
601/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800602 * Initialize file operations on a regular file
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700603 */
604void fuse_init_file_inode(struct inode *inode);
605
606/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800607 * Initialize inode operations on regular files and special files
Miklos Szeredie5e55582005-09-09 13:10:28 -0700608 */
609void fuse_init_common(struct inode *inode);
610
611/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800612 * Initialize inode and file operations on a directory
Miklos Szeredie5e55582005-09-09 13:10:28 -0700613 */
614void fuse_init_dir(struct inode *inode);
615
616/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800617 * Initialize inode operations on a symlink
Miklos Szeredie5e55582005-09-09 13:10:28 -0700618 */
619void fuse_init_symlink(struct inode *inode);
620
621/**
622 * Change attributes of an inode
623 */
Miklos Szeredi1fb69e72007-10-18 03:06:58 -0700624void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
625 u64 attr_valid, u64 attr_version);
Miklos Szeredie5e55582005-09-09 13:10:28 -0700626
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700627void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
628 u64 attr_valid);
629
Miklos Szeredie5e55582005-09-09 13:10:28 -0700630/**
Miklos Szeredi334f4852005-09-09 13:10:27 -0700631 * Initialize the client device
632 */
633int fuse_dev_init(void);
634
635/**
636 * Cleanup the client device
637 */
638void fuse_dev_cleanup(void);
639
Miklos Szeredibafa9652006-06-25 05:48:51 -0700640int fuse_ctl_init(void);
641void fuse_ctl_cleanup(void);
642
Miklos Szeredi334f4852005-09-09 13:10:27 -0700643/**
644 * Allocate a request
645 */
646struct fuse_req *fuse_request_alloc(void);
647
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700648struct fuse_req *fuse_request_alloc_nofs(void);
649
Miklos Szeredi334f4852005-09-09 13:10:27 -0700650/**
651 * Free a request
652 */
653void fuse_request_free(struct fuse_req *req);
654
655/**
Miklos Szeredi33649c92006-06-25 05:48:52 -0700656 * Get a request, may fail with -ENOMEM
Miklos Szeredi334f4852005-09-09 13:10:27 -0700657 */
Miklos Szeredice1d5a42006-04-10 22:54:58 -0700658struct fuse_req *fuse_get_req(struct fuse_conn *fc);
Miklos Szeredi334f4852005-09-09 13:10:27 -0700659
660/**
Miklos Szeredi33649c92006-06-25 05:48:52 -0700661 * Gets a requests for a file operation, always succeeds
662 */
663struct fuse_req *fuse_get_req_nofail(struct fuse_conn *fc, struct file *file);
664
665/**
Miklos Szeredice1d5a42006-04-10 22:54:58 -0700666 * Decrement reference count of a request. If count goes to zero free
667 * the request.
Miklos Szeredi334f4852005-09-09 13:10:27 -0700668 */
669void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
670
671/**
Miklos Szeredi7c352bd2005-09-09 13:10:39 -0700672 * Send a request (synchronous)
Miklos Szeredi334f4852005-09-09 13:10:27 -0700673 */
Tejun Heob93f8582008-11-26 12:03:55 +0100674void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
Miklos Szeredi334f4852005-09-09 13:10:27 -0700675
676/**
Miklos Szeredi334f4852005-09-09 13:10:27 -0700677 * Send a request in the background
678 */
Tejun Heob93f8582008-11-26 12:03:55 +0100679void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
Miklos Szeredi334f4852005-09-09 13:10:27 -0700680
Tejun Heob93f8582008-11-26 12:03:55 +0100681void fuse_request_send_background_locked(struct fuse_conn *fc,
682 struct fuse_req *req);
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700683
Miklos Szeredi5a5fb1e2006-04-26 10:48:55 +0200684/* Abort all requests */
Miklos Szeredi69a53bf2006-01-16 22:14:41 -0800685void fuse_abort_conn(struct fuse_conn *fc);
686
Miklos Szeredi1e9a4ed2005-09-09 13:10:31 -0700687/**
Miklos Szeredie5e55582005-09-09 13:10:28 -0700688 * Invalidate inode attributes
689 */
690void fuse_invalidate_attr(struct inode *inode);
Miklos Szeredibafa9652006-06-25 05:48:51 -0700691
Miklos Szeredidbd561d2008-07-25 01:49:00 -0700692void fuse_invalidate_entry_cache(struct dentry *entry);
693
Miklos Szeredibafa9652006-06-25 05:48:51 -0700694/**
695 * Acquire reference to fuse_conn
696 */
697struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
698
Tejun Heo08cbf542009-04-14 10:54:53 +0900699void fuse_conn_kill(struct fuse_conn *fc);
700
Miklos Szeredibafa9652006-06-25 05:48:51 -0700701/**
Tejun Heo0d179aa2008-11-26 12:03:55 +0100702 * Initialize fuse_conn
703 */
Tejun Heoa325f9b2009-04-14 10:54:52 +0900704void fuse_conn_init(struct fuse_conn *fc);
Tejun Heo0d179aa2008-11-26 12:03:55 +0100705
706/**
Miklos Szeredibafa9652006-06-25 05:48:51 -0700707 * Release reference to fuse_conn
708 */
709void fuse_conn_put(struct fuse_conn *fc);
710
711/**
712 * Add connection to control filesystem
713 */
714int fuse_ctl_add_conn(struct fuse_conn *fc);
715
716/**
717 * Remove connection from control filesystem
718 */
719void fuse_ctl_remove_conn(struct fuse_conn *fc);
Timo Savolaa5bfffac2007-04-08 16:04:00 -0700720
721/**
722 * Is file type valid?
723 */
724int fuse_valid_type(int m);
Miklos Szeredie57ac682007-10-18 03:06:58 -0700725
726/**
727 * Is task allowed to perform filesystem operation?
728 */
729int fuse_allow_task(struct fuse_conn *fc, struct task_struct *task);
Miklos Szeredif3332112007-10-18 03:07:04 -0700730
731u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
Miklos Szeredibcb4be82007-11-28 16:21:59 -0800732
733int fuse_update_attributes(struct inode *inode, struct kstat *stat,
734 struct file *file, bool *refreshed);
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700735
736void fuse_flush_writepages(struct inode *inode);
737
738void fuse_set_nowrite(struct inode *inode);
739void fuse_release_nowrite(struct inode *inode);
Miklos Szeredi5c5c5e52008-04-30 00:54:43 -0700740
741u64 fuse_get_attr_version(struct fuse_conn *fc);
Tejun Heo29d434b2008-10-16 16:08:57 +0200742
John Muir3b463ae2009-05-31 11:13:57 -0400743/**
744 * File-system tells the kernel to invalidate cache for the given node id.
745 */
746int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid,
747 loff_t offset, loff_t len);
748
749/**
750 * File-system tells the kernel to invalidate parent attributes and
751 * the dentry matching parent/name.
752 */
753int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
754 struct qstr *name);
755
Tejun Heo08cbf542009-04-14 10:54:53 +0900756int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
757 bool isdir);
758ssize_t fuse_direct_io(struct file *file, const char __user *buf,
759 size_t count, loff_t *ppos, int write);
760long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
761 unsigned int flags);
762unsigned fuse_file_poll(struct file *file, poll_table *wait);
763int fuse_dev_release(struct inode *inode, struct file *file);
764
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200765void fuse_write_update_size(struct inode *inode, loff_t pos);
766
Tejun Heo29d434b2008-10-16 16:08:57 +0200767#endif /* _FS_FUSE_I_H */