fuse_i.h 11 KB
Newer Older
Miklos Szeredi's avatar
Miklos Szeredi committed
1
2
/*
  FUSE: Filesystem in Userspace
3
  Copyright (C) 2001-2006  Miklos Szeredi <miklos@szeredi.hu>
Miklos Szeredi's avatar
Miklos Szeredi committed
4
5
6
7
8
9
10
11
12
13
14
15
16
17

  This program can be distributed under the terms of the GNU GPL.
  See the file COPYING.
*/

#include <linux/fuse.h>
#include <linux/fs.h>
#include <linux/wait.h>
#include <linux/list.h>
#include <linux/spinlock.h>
#include <linux/mm.h>
#include <linux/backing-dev.h>
#include <asm/semaphore.h>

18
19
20
/** Max number of pages that can be used in a single read request */
#define FUSE_MAX_PAGES_PER_REQ 32

21
22
23
/** Maximum number of outstanding background requests */
#define FUSE_MAX_BACKGROUND 10

24
25
26
/** It could be as large as PATH_MAX, but would that have any uses? */
#define FUSE_NAME_MAX 1024

Miklos Szeredi's avatar
Miklos Szeredi committed
27
28
29
30
31
32
33
34
35
/** If the FUSE_DEFAULT_PERMISSIONS flag is given, the filesystem
    module will check permissions based on the file mode.  Otherwise no
    permission checking is done in the kernel */
#define FUSE_DEFAULT_PERMISSIONS (1 << 0)

/** If the FUSE_ALLOW_OTHER flag is given, then not only the user
    doing the mount will be allowed to access the filesystem */
#define FUSE_ALLOW_OTHER         (1 << 1)

Miklos Szeredi's avatar
Miklos Szeredi committed
36

Miklos Szeredi's avatar
Miklos Szeredi committed
37
38
39
40
41
42
43
44
45
/** FUSE inode */
struct fuse_inode {
	/** Inode data */
	struct inode inode;

	/** Unique ID, which identifies the inode between userspace
	 * and kernel */
	u64 nodeid;

46
47
48
	/** Number of lookups on this inode */
	u64 nlookup;

49
50
51
	/** The request used for sending the FORGET message */
	struct fuse_req *forget_req;

Miklos Szeredi's avatar
Miklos Szeredi committed
52
53
54
55
	/** Time in jiffies until the file attributes are valid */
	unsigned long i_time;
};

56
57
58
59
60
61
62
63
64
/** FUSE specific file data */
struct fuse_file {
	/** Request reserved for flush and release */
	struct fuse_req *release_req;

	/** File handle used by userspace */
	u64 fh;
};

65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/** One input argument of a request */
struct fuse_in_arg {
	unsigned size;
	const void *value;
};

/** The request input */
struct fuse_in {
	/** The request header */
	struct fuse_in_header h;

	/** True if the data for the last argument is in req->pages */
	unsigned argpages:1;

	/** Number of arguments */
	unsigned numargs;

	/** Array of arguments */
	struct fuse_in_arg args[3];
};

/** One output argument of a request */
struct fuse_arg {
	unsigned size;
	void *value;
};

/** The request output */
struct fuse_out {
	/** Header returned from userspace */
	struct fuse_out_header h;

97
98
99
100
101
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
	/** Last argument is variable length (can be shorter than
	    arg->size) */
	unsigned argvar:1;

	/** Last argument is a list of pages to copy data to */
	unsigned argpages:1;

	/** Zero partially or not copied pages */
	unsigned page_zeroing:1;

	/** Number or arguments */
	unsigned numargs;

	/** Array of arguments */
	struct fuse_arg args[3];
};

119
120
121
122
123
124
125
126
127
/** The request state */
enum fuse_req_state {
	FUSE_REQ_INIT = 0,
	FUSE_REQ_PENDING,
	FUSE_REQ_READING,
	FUSE_REQ_SENT,
	FUSE_REQ_FINISHED
};

128
129
struct fuse_conn;

130
131
132
133
/**
 * A request to the client
 */
struct fuse_req {
134
135
	/** This can be on either pending processing or io lists in
	    fuse_conn */
136
137
	struct list_head list;

Miklos Szeredi's avatar
Miklos Szeredi committed
138
139
140
	/** Entry on the background list */
	struct list_head bg_entry;

141
142
143
	/** refcount */
	atomic_t count;

144
145
146
	/*
	 * The following bitfields are either set once before the
	 * request is queued or setting/clearing them is protected by
147
	 * fuse_conn->lock
148
149
	 */

150
151
152
153
154
155
156
157
158
159
160
161
	/** True if the request has reply */
	unsigned isreply:1;

	/** The request was interrupted */
	unsigned interrupted:1;

	/** Request is sent in the background */
	unsigned background:1;

	/** Data is being copied to/from the request */
	unsigned locked:1;

162
163
164
	/** Request is counted as "waiting" */
	unsigned waiting:1;

165
166
	/** State of the request */
	enum fuse_req_state state;
167
168
169
170
171
172
173
174
175
176
177
178

	/** The request input */
	struct fuse_in in;

	/** The request output */
	struct fuse_out out;

	/** Used to wake up the task waiting for completion of request*/
	wait_queue_head_t waitq;

	/** Data for asynchronous requests */
	union {
179
		struct fuse_forget_in forget_in;
180
		struct fuse_release_in release_in;
181
182
		struct fuse_init_in init_in;
		struct fuse_init_out init_out;
183
		struct fuse_read_in read_in;
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
	} misc;

	/** page vector */
	struct page *pages[FUSE_MAX_PAGES_PER_REQ];

	/** number of pages in vector */
	unsigned num_pages;

	/** offset of data on first page */
	unsigned page_offset;

	/** Inode used in the request */
	struct inode *inode;

	/** Second inode used in the request (or NULL) */
	struct inode *inode2;

	/** File used in the request (or NULL) */
	struct file *file;
203
204
205

	/** Request completion callback */
	void (*end)(struct fuse_conn *, struct fuse_req *);
206
207
};

Miklos Szeredi's avatar
Miklos Szeredi committed
208
209
210
211
212
213
214
215
/**
 * A Fuse connection.
 *
 * This structure is created, when the filesystem is mounted, and is
 * destroyed, when the client device is closed and the filesystem is
 * unmounted.
 */
struct fuse_conn {
216
217
218
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

Miklos Szeredi's avatar
Miklos Szeredi committed
219
220
221
	/** The user id for this mount */
	uid_t user_id;

222
223
224
	/** The group id for this mount */
	gid_t group_id;

Miklos Szeredi's avatar
Miklos Szeredi committed
225
226
227
	/** The fuse mount flags for this mount */
	unsigned flags;

228
229
230
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
231
232
233
	/** Maximum write size */
	unsigned max_write;

234
235
236
237
238
239
240
241
242
	/** Readers of the connection are waiting on this */
	wait_queue_head_t waitq;

	/** The list of pending requests */
	struct list_head pending;

	/** The list of requests being processed */
	struct list_head processing;

243
244
245
	/** The list of requests under I/O */
	struct list_head io;

Miklos Szeredi's avatar
Miklos Szeredi committed
246
247
248
249
	/** Requests put in the background (RELEASE or any other
	    interrupted request) */
	struct list_head background;

250
251
252
253
254
255
256
257
258
259
260
	/** Number of requests currently in the background */
	unsigned num_background;

	/** Flag indicating if connection is blocked.  This will be
	    the case before the INIT reply is received, and if there
	    are too many outstading backgrounds requests */
	int blocked;

	/** waitq for blocked connection */
	wait_queue_head_t blocked_waitq;

261
262
263
	/** RW semaphore for exclusion with fuse_put_super() */
	struct rw_semaphore sbput_sem;

264
265
266
	/** The next unique request id */
	u64 reqctr;

267
268
269
	/** Mount is active */
	unsigned mounted;

270
271
	/** Connection established, cleared on umount, connection
	    abort and device release */
272
	unsigned connected;
Miklos Szeredi's avatar
Miklos Szeredi committed
273

274
275
276
	/** Connection failed (version mismatch).  Cannot race with
	    setting other bitfields since it is only set once in INIT
	    reply, before any other request, and never cleared */
277
278
	unsigned conn_error : 1;

279
280
281
	/** Do readpages asynchronously?  Only set in INIT */
	unsigned async_read : 1;

282
283
284
285
286
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

287
288
289
	/** Is fsync not implemented by fs? */
	unsigned no_fsync : 1;

290
291
292
	/** Is fsyncdir not implemented by fs? */
	unsigned no_fsyncdir : 1;

293
294
295
	/** Is flush not implemented by fs? */
	unsigned no_flush : 1;

296
297
298
299
300
301
302
303
304
305
306
307
	/** Is setxattr not implemented by fs? */
	unsigned no_setxattr : 1;

	/** Is getxattr not implemented by fs? */
	unsigned no_getxattr : 1;

	/** Is listxattr not implemented by fs? */
	unsigned no_listxattr : 1;

	/** Is removexattr not implemented by fs? */
	unsigned no_removexattr : 1;

Miklos Szeredi's avatar
Miklos Szeredi committed
308
309
310
	/** Is access not implemented by fs? */
	unsigned no_access : 1;

311
312
313
	/** Is create not implemented by fs? */
	unsigned no_create : 1;

314
315
316
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

317
318
319
	/** Negotiated minor version */
	unsigned minor;

Miklos Szeredi's avatar
Miklos Szeredi committed
320
321
	/** Backing dev info */
	struct backing_dev_info bdi;
322
323
324

	/** kobject */
	struct kobject kobj;
325
326
327

	/** O_ASYNC requests */
	struct fasync_struct *fasync;
Miklos Szeredi's avatar
Miklos Szeredi committed
328
329
330
331
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
332
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
333
334
335
336
337
338
339
}

static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
{
	return get_fuse_conn_super(inode->i_sb);
}

340
341
342
343
344
static inline struct fuse_conn *get_fuse_conn_kobj(struct kobject *obj)
{
	return container_of(obj, struct fuse_conn, kobj);
}

Miklos Szeredi's avatar
Miklos Szeredi committed
345
346
347
348
349
350
351
352
353
354
static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
{
	return container_of(inode, struct fuse_inode, inode);
}

static inline u64 get_node_id(struct inode *inode)
{
	return get_fuse_inode(inode)->nodeid;
}

355
/** Device operations */
356
extern const struct file_operations fuse_dev_operations;
357

358
359
360
361
/**
 * Get a filled in inode
 */
struct inode *fuse_iget(struct super_block *sb, unsigned long nodeid,
362
			int generation, struct fuse_attr *attr);
363
364
365
366
367

/**
 * Send FORGET command
 */
void fuse_send_forget(struct fuse_conn *fc, struct fuse_req *req,
368
		      unsigned long nodeid, u64 nlookup);
369

370
/**
371
 * Initialize READ or READDIR request
372
 */
373
374
void fuse_read_fill(struct fuse_req *req, struct file *file,
		    struct inode *inode, loff_t pos, size_t count, int opcode);
375
376
377
378
379
380

/**
 * Send OPEN or OPENDIR request
 */
int fuse_open_common(struct inode *inode, struct file *file, int isdir);

381
382
383
384
385
386
387
388
389
390
391
struct fuse_file *fuse_file_alloc(void);
void fuse_file_free(struct fuse_file *ff);
void fuse_finish_open(struct inode *inode, struct file *file,
		      struct fuse_file *ff, struct fuse_open_out *outarg);

/**
 * Send a RELEASE request
 */
void fuse_send_release(struct fuse_conn *fc, struct fuse_file *ff,
		       u64 nodeid, struct inode *inode, int flags, int isdir);

392
393
394
395
396
/**
 * Send RELEASE or RELEASEDIR request
 */
int fuse_release_common(struct inode *inode, struct file *file, int isdir);

397
398
399
400
401
402
/**
 * Send FSYNC or FSYNCDIR request
 */
int fuse_fsync_common(struct file *file, struct dentry *de, int datasync,
		      int isdir);

403
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
404
 * Initialize file operations on a regular file
405
406
407
 */
void fuse_init_file_inode(struct inode *inode);

408
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
409
 * Initialize inode operations on regular files and special files
410
411
412
413
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
414
 * Initialize inode and file operations on a directory
415
416
417
418
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
419
 * Initialize inode operations on a symlink
420
421
422
423
424
425
426
427
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr);

428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

/**
 * Cleanup the client device
 */
void fuse_dev_cleanup(void);

/**
 * Allocate a request
 */
struct fuse_req *fuse_request_alloc(void);

/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
 * Reinitialize a request, the preallocated flag is left unmodified
 */
void fuse_reset_request(struct fuse_req *req);

/**
 * Reserve a preallocated request
 */
456
struct fuse_req *fuse_get_req(struct fuse_conn *fc);
457
458

/**
459
460
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
461
462
463
464
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
465
 * Send a request (synchronous)
466
467
468
469
470
471
472
473
474
475
476
477
478
 */
void request_send(struct fuse_conn *fc, struct fuse_req *req);

/**
 * Send a request with no reply
 */
void request_send_noreply(struct fuse_conn *fc, struct fuse_req *req);

/**
 * Send a request in the background
 */
void request_send_background(struct fuse_conn *fc, struct fuse_req *req);

Miklos Szeredi's avatar
Miklos Szeredi committed
479
/**
480
 * Release inodes and file associated with background request
Miklos Szeredi's avatar
Miklos Szeredi committed
481
 */
482
void fuse_release_background(struct fuse_conn *fc, struct fuse_req *req);
Miklos Szeredi's avatar
Miklos Szeredi committed
483

484
/* Abort all requests */
485
486
void fuse_abort_conn(struct fuse_conn *fc);

487
488
489
490
491
492
493
494
495
/**
 * Get the attributes of a file
 */
int fuse_do_getattr(struct inode *inode);

/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);