]> git.ipfire.org Git - thirdparty/kernel/linux.git/blame - fs/fuse/fuse_i.h
[fuse] fix deadlock between fuse_put_super() and request_end()
[thirdparty/kernel/linux.git] / fs / fuse / fuse_i.h
CommitLineData
d8a5ba45
MS
1/*
2 FUSE: Filesystem in Userspace
d7133114 3 Copyright (C) 2001-2006 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
9#include <linux/fuse.h>
10#include <linux/fs.h>
11#include <linux/wait.h>
12#include <linux/list.h>
13#include <linux/spinlock.h>
14#include <linux/mm.h>
15#include <linux/backing-dev.h>
16#include <asm/semaphore.h>
17
334f485d
MS
18/** Max number of pages that can be used in a single read request */
19#define FUSE_MAX_PAGES_PER_REQ 32
20
08a53cdc
MS
21/** Maximum number of outstanding background requests */
22#define FUSE_MAX_BACKGROUND 10
23
1d3d752b
MS
24/** It could be as large as PATH_MAX, but would that have any uses? */
25#define FUSE_NAME_MAX 1024
26
1e9a4ed9
MS
27/** If the FUSE_DEFAULT_PERMISSIONS flag is given, the filesystem
28 module will check permissions based on the file mode. Otherwise no
29 permission checking is done in the kernel */
30#define FUSE_DEFAULT_PERMISSIONS (1 << 0)
31
32/** If the FUSE_ALLOW_OTHER flag is given, then not only the user
33 doing the mount will be allowed to access the filesystem */
34#define FUSE_ALLOW_OTHER (1 << 1)
35
413ef8cb 36
d8a5ba45
MS
37/** FUSE inode */
38struct fuse_inode {
39 /** Inode data */
40 struct inode inode;
41
42 /** Unique ID, which identifies the inode between userspace
43 * and kernel */
44 u64 nodeid;
45
9e6268db
MS
46 /** Number of lookups on this inode */
47 u64 nlookup;
48
e5e5558e
MS
49 /** The request used for sending the FORGET message */
50 struct fuse_req *forget_req;
51
d8a5ba45
MS
52 /** Time in jiffies until the file attributes are valid */
53 unsigned long i_time;
54};
55
b6aeaded
MS
56/** FUSE specific file data */
57struct fuse_file {
58 /** Request reserved for flush and release */
59 struct fuse_req *release_req;
60
61 /** File handle used by userspace */
62 u64 fh;
63};
64
334f485d
MS
65/** One input argument of a request */
66struct fuse_in_arg {
67 unsigned size;
68 const void *value;
69};
70
71/** The request input */
72struct fuse_in {
73 /** The request header */
74 struct fuse_in_header h;
75
76 /** True if the data for the last argument is in req->pages */
77 unsigned argpages:1;
78
79 /** Number of arguments */
80 unsigned numargs;
81
82 /** Array of arguments */
83 struct fuse_in_arg args[3];
84};
85
86/** One output argument of a request */
87struct fuse_arg {
88 unsigned size;
89 void *value;
90};
91
92/** The request output */
93struct fuse_out {
94 /** Header returned from userspace */
95 struct fuse_out_header h;
96
095da6cb
MS
97 /*
98 * The following bitfields are not changed during the request
99 * processing
100 */
101
334f485d
MS
102 /** Last argument is variable length (can be shorter than
103 arg->size) */
104 unsigned argvar:1;
105
106 /** Last argument is a list of pages to copy data to */
107 unsigned argpages:1;
108
109 /** Zero partially or not copied pages */
110 unsigned page_zeroing:1;
111
112 /** Number or arguments */
113 unsigned numargs;
114
115 /** Array of arguments */
116 struct fuse_arg args[3];
117};
118
83cfd493
MS
119/** The request state */
120enum fuse_req_state {
121 FUSE_REQ_INIT = 0,
122 FUSE_REQ_PENDING,
123 FUSE_REQ_READING,
124 FUSE_REQ_SENT,
125 FUSE_REQ_FINISHED
126};
127
64c6d8ed
MS
128struct fuse_conn;
129
334f485d
MS
130/**
131 * A request to the client
132 */
133struct fuse_req {
ce1d5a49
MS
134 /** This can be on either pending processing or io lists in
135 fuse_conn */
334f485d
MS
136 struct list_head list;
137
1e9a4ed9
MS
138 /** Entry on the background list */
139 struct list_head bg_entry;
140
334f485d
MS
141 /** refcount */
142 atomic_t count;
143
095da6cb
MS
144 /*
145 * The following bitfields are either set once before the
146 * request is queued or setting/clearing them is protected by
d7133114 147 * fuse_conn->lock
095da6cb
MS
148 */
149
334f485d
MS
150 /** True if the request has reply */
151 unsigned isreply:1;
152
334f485d
MS
153 /** The request was interrupted */
154 unsigned interrupted:1;
155
156 /** Request is sent in the background */
157 unsigned background:1;
158
159 /** Data is being copied to/from the request */
160 unsigned locked:1;
161
83cfd493
MS
162 /** State of the request */
163 enum fuse_req_state state;
334f485d
MS
164
165 /** The request input */
166 struct fuse_in in;
167
168 /** The request output */
169 struct fuse_out out;
170
171 /** Used to wake up the task waiting for completion of request*/
172 wait_queue_head_t waitq;
173
174 /** Data for asynchronous requests */
175 union {
e5e5558e 176 struct fuse_forget_in forget_in;
b6aeaded 177 struct fuse_release_in release_in;
3ec870d5
MS
178 struct fuse_init_in init_in;
179 struct fuse_init_out init_out;
361b1eb5 180 struct fuse_read_in read_in;
334f485d
MS
181 } misc;
182
183 /** page vector */
184 struct page *pages[FUSE_MAX_PAGES_PER_REQ];
185
186 /** number of pages in vector */
187 unsigned num_pages;
188
189 /** offset of data on first page */
190 unsigned page_offset;
191
192 /** Inode used in the request */
193 struct inode *inode;
194
195 /** Second inode used in the request (or NULL) */
196 struct inode *inode2;
197
198 /** File used in the request (or NULL) */
199 struct file *file;
64c6d8ed
MS
200
201 /** Request completion callback */
202 void (*end)(struct fuse_conn *, struct fuse_req *);
334f485d
MS
203};
204
d8a5ba45
MS
205/**
206 * A Fuse connection.
207 *
208 * This structure is created, when the filesystem is mounted, and is
209 * destroyed, when the client device is closed and the filesystem is
210 * unmounted.
211 */
212struct fuse_conn {
d7133114
MS
213 /** Lock protecting accessess to members of this structure */
214 spinlock_t lock;
215
d8a5ba45
MS
216 /** The user id for this mount */
217 uid_t user_id;
218
87729a55
MS
219 /** The group id for this mount */
220 gid_t group_id;
221
1e9a4ed9
MS
222 /** The fuse mount flags for this mount */
223 unsigned flags;
224
db50b96c
MS
225 /** Maximum read size */
226 unsigned max_read;
227
413ef8cb
MS
228 /** Maximum write size */
229 unsigned max_write;
230
334f485d
MS
231 /** Readers of the connection are waiting on this */
232 wait_queue_head_t waitq;
233
234 /** The list of pending requests */
235 struct list_head pending;
236
237 /** The list of requests being processed */
238 struct list_head processing;
239
d77a1d5b
MS
240 /** The list of requests under I/O */
241 struct list_head io;
242
1e9a4ed9
MS
243 /** Requests put in the background (RELEASE or any other
244 interrupted request) */
245 struct list_head background;
246
08a53cdc
MS
247 /** Number of requests currently in the background */
248 unsigned num_background;
249
250 /** Flag indicating if connection is blocked. This will be
251 the case before the INIT reply is received, and if there
252 are too many outstading backgrounds requests */
253 int blocked;
254
255 /** waitq for blocked connection */
256 wait_queue_head_t blocked_waitq;
257
334f485d
MS
258 /** The next unique request id */
259 u64 reqctr;
260
69a53bf2
MS
261 /** Connection established, cleared on umount, connection
262 abort and device release */
095da6cb 263 unsigned connected;
1e9a4ed9 264
095da6cb
MS
265 /** Connection failed (version mismatch). Cannot race with
266 setting other bitfields since it is only set once in INIT
267 reply, before any other request, and never cleared */
334f485d
MS
268 unsigned conn_error : 1;
269
9cd68455
MS
270 /** Do readpages asynchronously? Only set in INIT */
271 unsigned async_read : 1;
272
095da6cb
MS
273 /*
274 * The following bitfields are only for optimization purposes
275 * and hence races in setting them will not cause malfunction
276 */
277
b6aeaded
MS
278 /** Is fsync not implemented by fs? */
279 unsigned no_fsync : 1;
280
82547981
MS
281 /** Is fsyncdir not implemented by fs? */
282 unsigned no_fsyncdir : 1;
283
b6aeaded
MS
284 /** Is flush not implemented by fs? */
285 unsigned no_flush : 1;
286
92a8780e
MS
287 /** Is setxattr not implemented by fs? */
288 unsigned no_setxattr : 1;
289
290 /** Is getxattr not implemented by fs? */
291 unsigned no_getxattr : 1;
292
293 /** Is listxattr not implemented by fs? */
294 unsigned no_listxattr : 1;
295
296 /** Is removexattr not implemented by fs? */
297 unsigned no_removexattr : 1;
298
31d40d74
MS
299 /** Is access not implemented by fs? */
300 unsigned no_access : 1;
301
fd72faac
MS
302 /** Is create not implemented by fs? */
303 unsigned no_create : 1;
304
0cd5b885
MS
305 /** The number of requests waiting for completion */
306 atomic_t num_waiting;
307
45714d65
MS
308 /** Negotiated minor version */
309 unsigned minor;
310
d8a5ba45
MS
311 /** Backing dev info */
312 struct backing_dev_info bdi;
f543f253
MS
313
314 /** kobject */
315 struct kobject kobj;
385a17bf
JD
316
317 /** O_ASYNC requests */
318 struct fasync_struct *fasync;
d8a5ba45
MS
319};
320
d8a5ba45
MS
321static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
322{
6383bdaa 323 return sb->s_fs_info;
d8a5ba45
MS
324}
325
326static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
327{
328 return get_fuse_conn_super(inode->i_sb);
329}
330
f543f253
MS
331static inline struct fuse_conn *get_fuse_conn_kobj(struct kobject *obj)
332{
333 return container_of(obj, struct fuse_conn, kobj);
334}
335
d8a5ba45
MS
336static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
337{
338 return container_of(inode, struct fuse_inode, inode);
339}
340
341static inline u64 get_node_id(struct inode *inode)
342{
343 return get_fuse_inode(inode)->nodeid;
344}
345
334f485d 346/** Device operations */
4b6f5d20 347extern const struct file_operations fuse_dev_operations;
334f485d 348
e5e5558e
MS
349/**
350 * Get a filled in inode
351 */
352struct inode *fuse_iget(struct super_block *sb, unsigned long nodeid,
9e6268db 353 int generation, struct fuse_attr *attr);
e5e5558e
MS
354
355/**
356 * Send FORGET command
357 */
358void fuse_send_forget(struct fuse_conn *fc, struct fuse_req *req,
9e6268db 359 unsigned long nodeid, u64 nlookup);
e5e5558e 360
04730fef 361/**
361b1eb5 362 * Initialize READ or READDIR request
04730fef 363 */
361b1eb5
MS
364void fuse_read_fill(struct fuse_req *req, struct file *file,
365 struct inode *inode, loff_t pos, size_t count, int opcode);
04730fef
MS
366
367/**
368 * Send OPEN or OPENDIR request
369 */
370int fuse_open_common(struct inode *inode, struct file *file, int isdir);
371
fd72faac
MS
372struct fuse_file *fuse_file_alloc(void);
373void fuse_file_free(struct fuse_file *ff);
374void fuse_finish_open(struct inode *inode, struct file *file,
375 struct fuse_file *ff, struct fuse_open_out *outarg);
376
377/**
378 * Send a RELEASE request
379 */
380void fuse_send_release(struct fuse_conn *fc, struct fuse_file *ff,
381 u64 nodeid, struct inode *inode, int flags, int isdir);
382
04730fef
MS
383/**
384 * Send RELEASE or RELEASEDIR request
385 */
386int fuse_release_common(struct inode *inode, struct file *file, int isdir);
387
82547981
MS
388/**
389 * Send FSYNC or FSYNCDIR request
390 */
391int fuse_fsync_common(struct file *file, struct dentry *de, int datasync,
392 int isdir);
393
b6aeaded 394/**
1779381d 395 * Initialize file operations on a regular file
b6aeaded
MS
396 */
397void fuse_init_file_inode(struct inode *inode);
398
e5e5558e 399/**
1779381d 400 * Initialize inode operations on regular files and special files
e5e5558e
MS
401 */
402void fuse_init_common(struct inode *inode);
403
404/**
1779381d 405 * Initialize inode and file operations on a directory
e5e5558e
MS
406 */
407void fuse_init_dir(struct inode *inode);
408
409/**
1779381d 410 * Initialize inode operations on a symlink
e5e5558e
MS
411 */
412void fuse_init_symlink(struct inode *inode);
413
414/**
415 * Change attributes of an inode
416 */
417void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr);
418
334f485d
MS
419/**
420 * Initialize the client device
421 */
422int fuse_dev_init(void);
423
424/**
425 * Cleanup the client device
426 */
427void fuse_dev_cleanup(void);
428
429/**
430 * Allocate a request
431 */
432struct fuse_req *fuse_request_alloc(void);
433
434/**
435 * Free a request
436 */
437void fuse_request_free(struct fuse_req *req);
438
439/**
440 * Reinitialize a request, the preallocated flag is left unmodified
441 */
442void fuse_reset_request(struct fuse_req *req);
443
444/**
445 * Reserve a preallocated request
446 */
ce1d5a49 447struct fuse_req *fuse_get_req(struct fuse_conn *fc);
334f485d 448
334f485d 449/**
ce1d5a49
MS
450 * Decrement reference count of a request. If count goes to zero free
451 * the request.
334f485d
MS
452 */
453void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
454
455/**
7c352bdf 456 * Send a request (synchronous)
334f485d
MS
457 */
458void request_send(struct fuse_conn *fc, struct fuse_req *req);
459
334f485d
MS
460/**
461 * Send a request with no reply
462 */
463void request_send_noreply(struct fuse_conn *fc, struct fuse_req *req);
464
465/**
466 * Send a request in the background
467 */
468void request_send_background(struct fuse_conn *fc, struct fuse_req *req);
469
1e9a4ed9 470/**
73ce8355 471 * Remove request from the the background list
1e9a4ed9 472 */
73ce8355 473void fuse_remove_background(struct fuse_conn *fc, struct fuse_req *req);
1e9a4ed9 474
73ce8355 475/** Abort all requests */
69a53bf2
MS
476void fuse_abort_conn(struct fuse_conn *fc);
477
e5e5558e
MS
478/**
479 * Get the attributes of a file
480 */
481int fuse_do_getattr(struct inode *inode);
482
483/**
484 * Invalidate inode attributes
485 */
486void fuse_invalidate_attr(struct inode *inode);