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

  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
21
22
23
/** Max number of pages that can be used in a single read request */
#define FUSE_MAX_PAGES_PER_REQ 32

/** If more requests are outstanding, then the operation will block */
#define FUSE_MAX_OUTSTANDING 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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/** 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;

	/** 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];
};

114
115
116
117
118
119
120
121
122
/** The request state */
enum fuse_req_state {
	FUSE_REQ_INIT = 0,
	FUSE_REQ_PENDING,
	FUSE_REQ_READING,
	FUSE_REQ_SENT,
	FUSE_REQ_FINISHED
};

123
124
125
126
/**
 * A request to the client
 */
struct fuse_req {
127
128
	/** This can be on either unused_list, pending processing or
	    io lists in fuse_conn */
129
130
	struct list_head list;

Miklos Szeredi's avatar
Miklos Szeredi committed
131
132
133
	/** Entry on the background list */
	struct list_head bg_entry;

134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
	/** refcount */
	atomic_t count;

	/** True if the request has reply */
	unsigned isreply:1;

	/** The request is preallocated */
	unsigned preallocated: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;

152
153
	/** State of the request */
	enum fuse_req_state state;
154
155
156
157
158
159
160
161
162
163
164
165

	/** 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 {
166
		struct fuse_forget_in forget_in;
167
		struct fuse_release_in release_in;
168
169
		struct fuse_init_in init_in;
		struct fuse_init_out init_out;
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
	} 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;
};

Miklos Szeredi's avatar
Miklos Szeredi committed
191
192
193
194
195
196
197
198
199
200
201
/**
 * 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 {
	/** The user id for this mount */
	uid_t user_id;

202
203
204
	/** The group id for this mount */
	gid_t group_id;

Miklos Szeredi's avatar
Miklos Szeredi committed
205
206
207
	/** The fuse mount flags for this mount */
	unsigned flags;

208
209
210
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
211
212
213
	/** Maximum write size */
	unsigned max_write;

214
215
216
217
218
219
220
221
222
	/** 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;

223
224
225
	/** The list of requests under I/O */
	struct list_head io;

Miklos Szeredi's avatar
Miklos Szeredi committed
226
227
228
229
	/** Requests put in the background (RELEASE or any other
	    interrupted request) */
	struct list_head background;

230
231
232
233
234
235
236
	/** Controls the maximum number of outstanding requests */
	struct semaphore outstanding_sem;

	/** This counts the number of outstanding requests if
	    outstanding_sem would go negative */
	unsigned outstanding_debt;

Miklos Szeredi's avatar
Miklos Szeredi committed
237
238
239
	/** RW semaphore for exclusion with fuse_put_super() */
	struct rw_semaphore sbput_sem;

240
241
242
243
244
245
	/** The list of unused requests */
	struct list_head unused_list;

	/** The next unique request id */
	u64 reqctr;

Miklos Szeredi's avatar
Miklos Szeredi committed
246
247
248
	/** Mount is active */
	unsigned mounted : 1;

249
250
	/** Connection established, cleared on umount, connection
	    abort and device release */
Miklos Szeredi's avatar
Miklos Szeredi committed
251
252
	unsigned connected : 1;

253
254
255
	/** Connection failed (version mismatch) */
	unsigned conn_error : 1;

256
257
258
	/** Is fsync not implemented by fs? */
	unsigned no_fsync : 1;

259
260
261
	/** Is fsyncdir not implemented by fs? */
	unsigned no_fsyncdir : 1;

262
263
264
	/** Is flush not implemented by fs? */
	unsigned no_flush : 1;

265
266
267
268
269
270
271
272
273
274
275
276
	/** 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
277
278
279
	/** Is access not implemented by fs? */
	unsigned no_access : 1;

280
281
282
	/** Is create not implemented by fs? */
	unsigned no_create : 1;

283
284
285
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

286
287
288
	/** Negotiated minor version */
	unsigned minor;

Miklos Szeredi's avatar
Miklos Szeredi committed
289
290
	/** Backing dev info */
	struct backing_dev_info bdi;
291
292
293

	/** kobject */
	struct kobject kobj;
Miklos Szeredi's avatar
Miklos Szeredi committed
294
295
296
297
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
298
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
299
300
301
302
303
304
305
}

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

306
307
308
309
310
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
311
312
313
314
315
316
317
318
319
320
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;
}

321
322
323
/** Device operations */
extern struct file_operations fuse_dev_operations;

Miklos Szeredi's avatar
Miklos Szeredi committed
324
325
326
327
328
/**
 * This is the single global spinlock which protects FUSE's structures
 *
 * The following data is protected by this lock:
 *
329
 *  - the private_data field of the device file
Miklos Szeredi's avatar
Miklos Szeredi committed
330
 *  - the s_fs_info field of the super block
331
 *  - unused_list, pending, processing lists in fuse_conn
Miklos Szeredi's avatar
Miklos Szeredi committed
332
 *  - background list in fuse_conn
333
 *  - the unique request ID counter reqctr in fuse_conn
Miklos Szeredi's avatar
Miklos Szeredi committed
334
 *  - the sb (super_block) field in fuse_conn
335
 *  - the file (device file) field in fuse_conn
Miklos Szeredi's avatar
Miklos Szeredi committed
336
337
338
 */
extern spinlock_t fuse_lock;

339
340
341
342
/**
 * Get a filled in inode
 */
struct inode *fuse_iget(struct super_block *sb, unsigned long nodeid,
343
			int generation, struct fuse_attr *attr);
344
345
346
347
348

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

351
352
353
354
355
356
357
358
359
360
361
362
/**
 * Send READ or READDIR request
 */
size_t fuse_send_read_common(struct fuse_req *req, struct file *file,
			     struct inode *inode, loff_t pos, size_t count,
			     int isdir);

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

363
364
365
366
367
368
369
370
371
372
373
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);

374
375
376
377
378
/**
 * Send RELEASE or RELEASEDIR request
 */
int fuse_release_common(struct inode *inode, struct file *file, int isdir);

379
380
381
382
383
384
/**
 * Send FSYNC or FSYNCDIR request
 */
int fuse_fsync_common(struct file *file, struct dentry *de, int datasync,
		      int isdir);

385
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
386
 * Initialize file operations on a regular file
387
388
389
 */
void fuse_init_file_inode(struct inode *inode);

390
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
391
 * Initialize inode operations on regular files and special files
392
393
394
395
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
396
 * Initialize inode and file operations on a directory
397
398
399
400
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
401
 * Initialize inode operations on a symlink
402
403
404
405
406
407
408
409
 */
void fuse_init_symlink(struct inode *inode);

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

410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
/**
 * 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
 */
struct fuse_req *fuse_get_request(struct fuse_conn *fc);

/**
 * Decrement reference count of a request.  If count goes to zero put
Miklos Szeredi's avatar
Miklos Szeredi committed
442
 * on unused list (preallocated) or free request (not preallocated).
443
444
445
446
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
447
 * Send a request (synchronous)
448
449
450
451
452
453
454
455
456
457
458
459
460
 */
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
461
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
462
 * Release inodes and file associated with background request
Miklos Szeredi's avatar
Miklos Szeredi committed
463
464
465
 */
void fuse_release_background(struct fuse_req *req);

466
467
468
/* Abort all requests */
void fuse_abort_conn(struct fuse_conn *fc);

469
470
471
472
473
474
475
476
477
478
/**
 * Get the attributes of a file
 */
int fuse_do_getattr(struct inode *inode);

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

479
480
481
482
/**
 * Send the INIT message
 */
void fuse_send_init(struct fuse_conn *fc);