fuse_i.h 15.2 KB
Newer Older
Miklos Szeredi's avatar
Miklos Szeredi committed
1
2
/*
  FUSE: Filesystem in Userspace
Miklos Szeredi's avatar
Miklos Szeredi committed
3
  Copyright (C) 2001-2008  Miklos Szeredi <miklos@szeredi.hu>
Miklos Szeredi's avatar
Miklos Szeredi committed
4
5
6
7
8

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

Tejun Heo's avatar
Tejun Heo committed
9
10
11
#ifndef _FS_FUSE_I_H
#define _FS_FUSE_I_H

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

23
24
25
/** Max number of pages that can be used in a single read request */
#define FUSE_MAX_PAGES_PER_REQ 32

26
/** Maximum number of outstanding background requests */
27
28
29
30
#define FUSE_MAX_BACKGROUND 12

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

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

35
36
37
/** It could be as large as PATH_MAX, but would that have any uses? */
#define FUSE_NAME_MAX 1024

38
39
40
/** Number of dentries for each connection in the control filesystem */
#define FUSE_CTL_NUM_DENTRIES 3

Miklos Szeredi's avatar
Miklos Szeredi committed
41
42
43
44
45
46
47
48
49
/** 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)

50
51
52
53
54
/** 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
55

Miklos Szeredi's avatar
Miklos Szeredi committed
56
57
58
59
60
61
62
63
64
/** FUSE inode */
struct fuse_inode {
	/** Inode data */
	struct inode inode;

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

65
66
67
	/** Number of lookups on this inode */
	u64 nlookup;

68
69
70
	/** The request used for sending the FORGET message */
	struct fuse_req *forget_req;

Miklos Szeredi's avatar
Miklos Szeredi committed
71
	/** Time in jiffies until the file attributes are valid */
Miklos Szeredi's avatar
Miklos Szeredi committed
72
	u64 i_time;
73
74
75
76

	/** The sticky bit in inode->i_mode may have been removed, so
	    preserve the original mode */
	mode_t orig_i_mode;
77
78
79

	/** Version of last attribute change */
	u64 attr_version;
80
81
82

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

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

98
99
100
/** FUSE specific file data */
struct fuse_file {
	/** Request reserved for flush and release */
101
	struct fuse_req *reserved_req;
102
103
104

	/** File handle used by userspace */
	u64 fh;
105
106
107

	/** Refcount */
	atomic_t count;
108
109
110

	/** Entry on inode's write_files list */
	struct list_head write_entry;
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
142
143
144
/** 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;

145
146
147
148
149
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

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

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

177
178
struct fuse_conn;

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

187
188
189
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

190
191
192
	/** refcount */
	atomic_t count;

193
194
195
	/** Unique ID for the interrupt request */
	u64 intr_unique;

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

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

205
206
207
	/** Force sending of the request even if interrupted */
	unsigned force:1;

208
209
	/** The request was aborted */
	unsigned aborted:1;
210
211
212
213

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

214
215
216
	/** The request has been interrupted */
	unsigned interrupted:1;

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

220
221
222
	/** Request is counted as "waiting" */
	unsigned waiting:1;

223
224
	/** State of the request */
	enum fuse_req_state state;
225
226
227
228
229
230
231
232
233
234
235
236

	/** 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 {
237
		struct fuse_forget_in forget_in;
238
239
240
241
242
		struct {
			struct fuse_release_in in;
			struct vfsmount *vfsmount;
			struct dentry *dentry;
		} release;
243
244
		struct fuse_init_in init_in;
		struct fuse_init_out init_out;
245
246
247
248
		struct {
			struct fuse_read_in in;
			u64 attr_ver;
		} read;
249
250
251
252
		struct {
			struct fuse_write_in in;
			struct fuse_write_out out;
		} write;
253
		struct fuse_lk_in lk_in;
254
255
256
257
258
259
260
261
262
263
264
265
	} 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) */
266
	struct fuse_file *ff;
267

Miklos Szeredi's avatar
Miklos Szeredi committed
268
269
270
271
272
273
	/** Inode used in the request or NULL */
	struct inode *inode;

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

274
275
	/** Request completion callback */
	void (*end)(struct fuse_conn *, struct fuse_req *);
276
277
278

	/** Request is stolen from fuse_file->reserved_req */
	struct file *stolen_file;
279
280
};

Miklos Szeredi's avatar
Miklos Szeredi committed
281
282
283
284
285
286
287
288
/**
 * 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 {
289
290
291
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

292
293
294
	/** Mutex protecting against directory alias creation */
	struct mutex inst_mutex;

295
296
297
	/** Refcount */
	atomic_t count;

Miklos Szeredi's avatar
Miklos Szeredi committed
298
299
300
	/** The user id for this mount */
	uid_t user_id;

301
302
303
	/** The group id for this mount */
	gid_t group_id;

Miklos Szeredi's avatar
Miklos Szeredi committed
304
305
306
	/** The fuse mount flags for this mount */
	unsigned flags;

307
308
309
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
310
311
312
	/** Maximum write size */
	unsigned max_write;

313
314
315
316
317
318
319
320
321
	/** 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;

322
323
324
	/** The list of requests under I/O */
	struct list_head io;

325
326
327
	/** Number of requests currently in the background */
	unsigned num_background;

328
329
330
331
332
333
	/** 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;

334
335
336
	/** Pending interrupts */
	struct list_head interrupts;

337
338
339
340
341
342
343
	/** 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;
344
345
346

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

348
349
350
	/** The next unique request id */
	u64 reqctr;

351
352
	/** Connection established, cleared on umount, connection
	    abort and device release */
353
	unsigned connected;
Miklos Szeredi's avatar
Miklos Szeredi committed
354

355
356
357
	/** 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 */
Miklos Szeredi's avatar
Miklos Szeredi committed
358
	unsigned conn_error:1;
359

360
	/** Connection successful.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
361
	unsigned conn_init:1;
362

363
	/** Do readpages asynchronously?  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
364
	unsigned async_read:1;
365

366
	/** Do not send separate SETATTR request before open(O_TRUNC)  */
Miklos Szeredi's avatar
Miklos Szeredi committed
367
	unsigned atomic_o_trunc:1;
368

369
	/** Filesystem supports NFS exporting.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
370
	unsigned export_support:1;
371

372
373
374
375
376
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

377
	/** Is fsync not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
378
	unsigned no_fsync:1;
379

380
	/** Is fsyncdir not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
381
	unsigned no_fsyncdir:1;
382

383
	/** Is flush not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
384
	unsigned no_flush:1;
385

386
	/** Is setxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
387
	unsigned no_setxattr:1;
388
389

	/** Is getxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
390
	unsigned no_getxattr:1;
391
392

	/** Is listxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
393
	unsigned no_listxattr:1;
394
395

	/** Is removexattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
396
	unsigned no_removexattr:1;
397

398
	/** Are file locking primitives not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
399
	unsigned no_lock:1;
400

Miklos Szeredi's avatar
Miklos Szeredi committed
401
	/** Is access not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
402
	unsigned no_access:1;
Miklos Szeredi's avatar
Miklos Szeredi committed
403

404
	/** Is create not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
405
	unsigned no_create:1;
406

407
	/** Is interrupt not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
408
	unsigned no_interrupt:1;
409

410
	/** Is bmap not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
411
	unsigned no_bmap:1;
412

413
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
414
	unsigned big_writes:1;
415

416
417
418
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

419
420
421
	/** Negotiated minor version */
	unsigned minor;

Miklos Szeredi's avatar
Miklos Szeredi committed
422
423
	/** Backing dev info */
	struct backing_dev_info bdi;
424

425
426
427
	/** Entry on the fuse_conn_list */
	struct list_head entry;

428
429
	/** Device ID from super block */
	dev_t dev;
430
431
432
433
434
435

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

	/** number of dentries used in the above array */
	int ctl_ndents;
436
437
438

	/** O_ASYNC requests */
	struct fasync_struct *fasync;
439
440
441

	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
442
443
444

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
445
446
447

	/** Version counter for attribute changes */
	u64 attr_version;
Miklos Szeredi's avatar
Miklos Szeredi committed
448
449
450
451
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
452
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
}

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

470
/** Device operations */
471
extern const struct file_operations fuse_dev_operations;
472

Miklos Szeredi's avatar
Miklos Szeredi committed
473
474
extern struct dentry_operations fuse_dentry_operations;

475
476
477
/**
 * Get a filled in inode
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
478
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
479
480
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
481

482
483
484
int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
		     struct fuse_entry_out *outarg, struct inode **inode);

485
486
487
488
/**
 * Send FORGET command
 */
void fuse_send_forget(struct fuse_conn *fc, struct fuse_req *req,
Miklos Szeredi's avatar
Miklos Szeredi committed
489
		      u64 nodeid, u64 nlookup);
490

491
/**
492
 * Initialize READ or READDIR request
493
 */
494
void fuse_read_fill(struct fuse_req *req, struct file *file,
495
		    struct inode *inode, loff_t pos, size_t count, int opcode);
496
497
498
499
500
501

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

502
503
504
505
506
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);

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

510
511
512
513
514
/**
 * Send RELEASE or RELEASEDIR request
 */
int fuse_release_common(struct inode *inode, struct file *file, int isdir);

515
516
517
518
519
520
/**
 * Send FSYNC or FSYNCDIR request
 */
int fuse_fsync_common(struct file *file, struct dentry *de, int datasync,
		      int isdir);

521
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
522
 * Initialize file operations on a regular file
523
524
525
 */
void fuse_init_file_inode(struct inode *inode);

526
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
527
 * Initialize inode operations on regular files and special files
528
529
530
531
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
532
 * Initialize inode and file operations on a directory
533
534
535
536
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
537
 * Initialize inode operations on a symlink
538
539
540
541
542
543
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
544
545
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
546

Miklos Szeredi's avatar
Miklos Szeredi committed
547
548
549
550
551
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);

552
553
554
555
556
557
558
559
560
561
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

562
563
564
int fuse_ctl_init(void);
void fuse_ctl_cleanup(void);

565
566
567
568
569
/**
 * Allocate a request
 */
struct fuse_req *fuse_request_alloc(void);

Miklos Szeredi's avatar
Miklos Szeredi committed
570
571
struct fuse_req *fuse_request_alloc_nofs(void);

572
573
574
575
576
577
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
578
 * Get a request, may fail with -ENOMEM
579
 */
580
struct fuse_req *fuse_get_req(struct fuse_conn *fc);
581

582
583
584
585
586
/**
 * Gets a requests for a file operation, always succeeds
 */
struct fuse_req *fuse_get_req_nofail(struct fuse_conn *fc, struct file *file);

587
/**
588
589
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
590
591
592
593
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
594
 * Send a request (synchronous)
595
596
597
598
599
600
601
602
603
604
605
606
607
 */
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
608
609
void request_send_background_locked(struct fuse_conn *fc, struct fuse_req *req);

610
/* Abort all requests */
611
612
void fuse_abort_conn(struct fuse_conn *fc);

613
614
615
616
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
617

Miklos Szeredi's avatar
Miklos Szeredi committed
618
619
void fuse_invalidate_entry_cache(struct dentry *entry);

620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
/**
 * 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);
639
640
641
642
643

/**
 * Is file type valid?
 */
int fuse_valid_type(int m);
Miklos Szeredi's avatar
Miklos Szeredi committed
644
645
646
647
648

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

u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
Miklos Szeredi's avatar
Miklos Szeredi committed
651
652
653

int fuse_update_attributes(struct inode *inode, struct kstat *stat,
			   struct file *file, bool *refreshed);
Miklos Szeredi's avatar
Miklos Szeredi committed
654
655
656
657
658

void fuse_flush_writepages(struct inode *inode);

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

u64 fuse_get_attr_version(struct fuse_conn *fc);
Tejun Heo's avatar
Tejun Heo committed
661
662

#endif /* _FS_FUSE_I_H */