fuse_i.h 14.7 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

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

#include <linux/fuse.h>
#include <linux/fs.h>
11
#include <linux/mount.h>
Miklos Szeredi's avatar
Miklos Szeredi committed
12
13
14
15
16
#include <linux/wait.h>
#include <linux/list.h>
#include <linux/spinlock.h>
#include <linux/mm.h>
#include <linux/backing-dev.h>
17
#include <linux/mutex.h>
Miklos Szeredi's avatar
Miklos Szeredi committed
18
#include <linux/rwsem.h>
Miklos Szeredi's avatar
Miklos Szeredi committed
19

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

23
/** Maximum number of outstanding background requests */
24
25
26
27
#define FUSE_MAX_BACKGROUND 12

/** Congestion starts at 75% of maximum */
#define FUSE_CONGESTION_THRESHOLD (FUSE_MAX_BACKGROUND * 75 / 100)
28

Miklos Szeredi's avatar
Miklos Szeredi committed
29
30
31
/** Bias for fi->writectr, meaning new writepages must not be sent */
#define FUSE_NOWRITE INT_MIN

32
33
34
/** It could be as large as PATH_MAX, but would that have any uses? */
#define FUSE_NAME_MAX 1024

35
36
37
/** Number of dentries for each connection in the control filesystem */
#define FUSE_CTL_NUM_DENTRIES 3

Miklos Szeredi's avatar
Miklos Szeredi committed
38
39
40
41
42
43
44
45
46
/** 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)

47
48
49
50
51
/** List of active connections */
extern struct list_head fuse_conn_list;

/** Global mutex protecting fuse_conn_list and the control filesystem */
extern struct mutex fuse_mutex;
Miklos Szeredi's avatar
Miklos Szeredi committed
52

Miklos Szeredi's avatar
Miklos Szeredi committed
53
54
55
56
57
58
59
60
61
/** FUSE inode */
struct fuse_inode {
	/** Inode data */
	struct inode inode;

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

62
63
64
	/** Number of lookups on this inode */
	u64 nlookup;

65
66
67
	/** The request used for sending the FORGET message */
	struct fuse_req *forget_req;

Miklos Szeredi's avatar
Miklos Szeredi committed
68
	/** Time in jiffies until the file attributes are valid */
Miklos Szeredi's avatar
Miklos Szeredi committed
69
	u64 i_time;
70
71
72
73

	/** The sticky bit in inode->i_mode may have been removed, so
	    preserve the original mode */
	mode_t orig_i_mode;
74
75
76

	/** Version of last attribute change */
	u64 attr_version;
77
78
79

	/** Files usable in writepage.  Protected by fc->lock */
	struct list_head write_files;
Miklos Szeredi's avatar
Miklos Szeredi committed
80
81
82
83
84
85
86
87
88
89
90
91
92

	/** Writepages pending on truncate or fsync */
	struct list_head queued_writes;

	/** Number of sent writes, a negative bias (FUSE_NOWRITE)
	 * means more writes are blocked */
	int writectr;

	/** Waitq for writepage completion */
	wait_queue_head_t page_waitq;

	/** List of writepage requestst (pending or sent) */
	struct list_head writepages;
Miklos Szeredi's avatar
Miklos Szeredi committed
93
94
};

95
96
97
/** FUSE specific file data */
struct fuse_file {
	/** Request reserved for flush and release */
98
	struct fuse_req *reserved_req;
99
100
101

	/** File handle used by userspace */
	u64 fh;
102
103
104

	/** Refcount */
	atomic_t count;
105
106
107

	/** Entry on inode's write_files list */
	struct list_head write_entry;
108
109
};

110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/** 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;

142
143
144
145
146
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
	/** 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];
};

164
165
166
167
168
169
/** The request state */
enum fuse_req_state {
	FUSE_REQ_INIT = 0,
	FUSE_REQ_PENDING,
	FUSE_REQ_READING,
	FUSE_REQ_SENT,
170
	FUSE_REQ_WRITING,
171
172
173
	FUSE_REQ_FINISHED
};

174
175
struct fuse_conn;

176
177
178
179
/**
 * A request to the client
 */
struct fuse_req {
180
181
	/** This can be on either pending processing or io lists in
	    fuse_conn */
182
183
	struct list_head list;

184
185
186
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

187
188
189
	/** refcount */
	atomic_t count;

190
191
192
	/** Unique ID for the interrupt request */
	u64 intr_unique;

193
194
195
	/*
	 * The following bitfields are either set once before the
	 * request is queued or setting/clearing them is protected by
196
	 * fuse_conn->lock
197
198
	 */

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

202
203
204
	/** Force sending of the request even if interrupted */
	unsigned force:1;

205
206
	/** The request was aborted */
	unsigned aborted:1;
207
208
209
210

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

211
212
213
	/** The request has been interrupted */
	unsigned interrupted:1;

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

217
218
219
	/** Request is counted as "waiting" */
	unsigned waiting:1;

220
221
	/** State of the request */
	enum fuse_req_state state;
222
223
224
225
226
227
228
229
230
231
232
233

	/** 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 {
234
		struct fuse_forget_in forget_in;
235
236
237
238
239
		struct {
			struct fuse_release_in in;
			struct vfsmount *vfsmount;
			struct dentry *dentry;
		} release;
240
241
		struct fuse_init_in init_in;
		struct fuse_init_out init_out;
242
		struct fuse_read_in read_in;
243
244
245
246
		struct {
			struct fuse_write_in in;
			struct fuse_write_out out;
		} write;
247
		struct fuse_lk_in lk_in;
248
249
250
251
252
253
254
255
256
257
258
259
	} 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;

	/** File used in the request (or NULL) */
260
	struct fuse_file *ff;
261

Miklos Szeredi's avatar
Miklos Szeredi committed
262
263
264
265
266
267
	/** Inode used in the request or NULL */
	struct inode *inode;

	/** Link on fi->writepages */
	struct list_head writepages_entry;

268
269
	/** Request completion callback */
	void (*end)(struct fuse_conn *, struct fuse_req *);
270
271
272

	/** Request is stolen from fuse_file->reserved_req */
	struct file *stolen_file;
273
274
};

Miklos Szeredi's avatar
Miklos Szeredi committed
275
276
277
278
279
280
281
282
/**
 * 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 {
283
284
285
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

286
287
288
	/** Mutex protecting against directory alias creation */
	struct mutex inst_mutex;

289
290
291
	/** Refcount */
	atomic_t count;

Miklos Szeredi's avatar
Miklos Szeredi committed
292
293
294
	/** The user id for this mount */
	uid_t user_id;

295
296
297
	/** The group id for this mount */
	gid_t group_id;

Miklos Szeredi's avatar
Miklos Szeredi committed
298
299
300
	/** The fuse mount flags for this mount */
	unsigned flags;

301
302
303
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
304
305
306
	/** Maximum write size */
	unsigned max_write;

307
308
309
310
311
312
313
314
315
	/** 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;

316
317
318
	/** The list of requests under I/O */
	struct list_head io;

319
320
321
	/** Number of requests currently in the background */
	unsigned num_background;

322
323
324
325
326
327
	/** Number of background requests currently queued for userspace */
	unsigned active_background;

	/** The list of background requests set aside for later queuing */
	struct list_head bg_queue;

328
329
330
	/** Pending interrupts */
	struct list_head interrupts;

331
332
333
334
335
336
337
	/** 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;
338
339
340

	/** waitq for reserved requests */
	wait_queue_head_t reserved_req_waitq;
341

342
343
344
	/** The next unique request id */
	u64 reqctr;

345
346
	/** Connection established, cleared on umount, connection
	    abort and device release */
347
	unsigned connected;
Miklos Szeredi's avatar
Miklos Szeredi committed
348

349
350
351
	/** 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 */
352
353
	unsigned conn_error : 1;

354
355
356
	/** Connection successful.  Only set in INIT */
	unsigned conn_init : 1;

357
358
359
	/** Do readpages asynchronously?  Only set in INIT */
	unsigned async_read : 1;

360
361
362
	/** Do not send separate SETATTR request before open(O_TRUNC)  */
	unsigned atomic_o_trunc : 1;

363
364
365
366
367
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

368
369
370
	/** Is fsync not implemented by fs? */
	unsigned no_fsync : 1;

371
372
373
	/** Is fsyncdir not implemented by fs? */
	unsigned no_fsyncdir : 1;

374
375
376
	/** Is flush not implemented by fs? */
	unsigned no_flush : 1;

377
378
379
380
381
382
383
384
385
386
387
388
	/** 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;

389
390
391
	/** Are file locking primitives not implemented by fs? */
	unsigned no_lock : 1;

Miklos Szeredi's avatar
Miklos Szeredi committed
392
393
394
	/** Is access not implemented by fs? */
	unsigned no_access : 1;

395
396
397
	/** Is create not implemented by fs? */
	unsigned no_create : 1;

398
399
400
	/** Is interrupt not implemented by fs? */
	unsigned no_interrupt : 1;

401
402
403
	/** Is bmap not implemented by fs? */
	unsigned no_bmap : 1;

404
405
406
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

407
408
409
	/** Negotiated minor version */
	unsigned minor;

Miklos Szeredi's avatar
Miklos Szeredi committed
410
411
	/** Backing dev info */
	struct backing_dev_info bdi;
412

413
414
415
	/** Entry on the fuse_conn_list */
	struct list_head entry;

416
417
	/** Device ID from super block */
	dev_t dev;
418
419
420
421
422
423

	/** Dentries in the control filesystem */
	struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];

	/** number of dentries used in the above array */
	int ctl_ndents;
424
425
426

	/** O_ASYNC requests */
	struct fasync_struct *fasync;
427
428
429

	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
430
431
432

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
433
434
435

	/** Version counter for attribute changes */
	u64 attr_version;
Miklos Szeredi's avatar
Miklos Szeredi committed
436
437
438
439
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
440
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
}

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

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;
}

458
/** Device operations */
459
extern const struct file_operations fuse_dev_operations;
460

461
462
463
464
/**
 * Get a filled in inode
 */
struct inode *fuse_iget(struct super_block *sb, unsigned long nodeid,
465
466
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
467
468
469
470
471

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

474
/**
475
 * Initialize READ or READDIR request
476
 */
477
void fuse_read_fill(struct fuse_req *req, struct file *file,
478
		    struct inode *inode, loff_t pos, size_t count, int opcode);
479
480
481
482
483
484

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

485
486
487
488
489
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);

490
491
492
/** Fill in ff->reserved_req with a RELEASE request */
void fuse_release_fill(struct fuse_file *ff, u64 nodeid, int flags, int opcode);

493
494
495
496
497
/**
 * Send RELEASE or RELEASEDIR request
 */
int fuse_release_common(struct inode *inode, struct file *file, int isdir);

498
499
500
501
502
503
/**
 * Send FSYNC or FSYNCDIR request
 */
int fuse_fsync_common(struct file *file, struct dentry *de, int datasync,
		      int isdir);

504
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
505
 * Initialize file operations on a regular file
506
507
508
 */
void fuse_init_file_inode(struct inode *inode);

509
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
510
 * Initialize inode operations on regular files and special files
511
512
513
514
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
515
 * Initialize inode and file operations on a directory
516
517
518
519
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
520
 * Initialize inode operations on a symlink
521
522
523
524
525
526
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
527
528
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
529

Miklos Szeredi's avatar
Miklos Szeredi committed
530
531
532
533
534
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

void fuse_truncate(struct address_space *mapping, loff_t offset);

535
536
537
538
539
540
541
542
543
544
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

545
546
547
int fuse_ctl_init(void);
void fuse_ctl_cleanup(void);

548
549
550
551
552
/**
 * Allocate a request
 */
struct fuse_req *fuse_request_alloc(void);

Miklos Szeredi's avatar
Miklos Szeredi committed
553
554
struct fuse_req *fuse_request_alloc_nofs(void);

555
556
557
558
559
560
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
561
 * Get a request, may fail with -ENOMEM
562
 */
563
struct fuse_req *fuse_get_req(struct fuse_conn *fc);
564

565
566
567
568
569
/**
 * Gets a requests for a file operation, always succeeds
 */
struct fuse_req *fuse_get_req_nofail(struct fuse_conn *fc, struct file *file);

570
/**
571
572
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
573
574
575
576
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
577
 * Send a request (synchronous)
578
579
580
581
582
583
584
585
586
587
588
589
590
 */
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
591
592
void request_send_background_locked(struct fuse_conn *fc, struct fuse_req *req);

593
/* Abort all requests */
594
595
void fuse_abort_conn(struct fuse_conn *fc);

596
597
598
599
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619

/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

/**
 * Release reference to fuse_conn
 */
void fuse_conn_put(struct fuse_conn *fc);

/**
 * Add connection to control filesystem
 */
int fuse_ctl_add_conn(struct fuse_conn *fc);

/**
 * Remove connection from control filesystem
 */
void fuse_ctl_remove_conn(struct fuse_conn *fc);
620
621
622
623
624

/**
 * Is file type valid?
 */
int fuse_valid_type(int m);
Miklos Szeredi's avatar
Miklos Szeredi committed
625
626
627
628
629

/**
 * Is task allowed to perform filesystem operation?
 */
int fuse_allow_task(struct fuse_conn *fc, struct task_struct *task);
630
631

u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
Miklos Szeredi's avatar
Miklos Szeredi committed
632
633
634

int fuse_update_attributes(struct inode *inode, struct kstat *stat,
			   struct file *file, bool *refreshed);
Miklos Szeredi's avatar
Miklos Szeredi committed
635
636
637
638
639

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);