fuse_i.h 22.9 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>
Tejun Heo's avatar
Tejun Heo committed
22
23
#include <linux/rbtree.h>
#include <linux/poll.h>
24
#include <linux/workqueue.h>
25
#include <linux/kref.h>
Miklos Szeredi's avatar
Miklos Szeredi committed
26

27
28
29
/** Max number of pages that can be used in a single read request */
#define FUSE_MAX_PAGES_PER_REQ 32

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

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

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

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

48
49
50
/** Number of page pointers embedded in fuse_req */
#define FUSE_REQ_INLINE_PAGES 1

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

57
58
59
60
/** Module parameters */
extern unsigned max_user_bgreq;
extern unsigned max_user_congthresh;

61
62
/* One forget request */
struct fuse_forget_link {
63
	struct fuse_forget_one forget_one;
64
65
66
	struct fuse_forget_link *next;
};

Miklos Szeredi's avatar
Miklos Szeredi committed
67
68
69
70
71
72
73
74
75
/** FUSE inode */
struct fuse_inode {
	/** Inode data */
	struct inode inode;

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

76
77
78
	/** Number of lookups on this inode */
	u64 nlookup;

79
	/** The request used for sending the FORGET message */
80
	struct fuse_forget_link *forget;
81

Miklos Szeredi's avatar
Miklos Szeredi committed
82
	/** Time in jiffies until the file attributes are valid */
Miklos Szeredi's avatar
Miklos Szeredi committed
83
	u64 i_time;
84
85
86

	/** The sticky bit in inode->i_mode may have been removed, so
	    preserve the original mode */
Al Viro's avatar
Al Viro committed
87
	umode_t orig_i_mode;
88

89
90
91
	/** 64 bit inode number */
	u64 orig_ino;

92
93
	/** Version of last attribute change */
	u64 attr_version;
94
95
96

	/** Files usable in writepage.  Protected by fc->lock */
	struct list_head write_files;
Miklos Szeredi's avatar
Miklos Szeredi committed
97
98
99
100
101
102
103
104
105
106
107
108
109

	/** 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;
110
111
112

	/** Miscellaneous bits describing inode state */
	unsigned long state;
113
114
115

	/** Lock for serializing lookup and readdir for back compatibility*/
	struct mutex mutex;
116
117
118
119
120
121
};

/** FUSE inode state bits */
enum {
	/** Advise readdirplus  */
	FUSE_I_ADVISE_RDPLUS,
122
123
	/** Initialized with readdirplus */
	FUSE_I_INIT_RDPLUS,
124
125
	/** An operation changing file size is in progress  */
	FUSE_I_SIZE_UNSTABLE,
Miklos Szeredi's avatar
Miklos Szeredi committed
126
127
};

128
129
struct fuse_conn;

130
131
/** FUSE specific file data */
struct fuse_file {
132
133
134
	/** Fuse connection for this file */
	struct fuse_conn *fc;

135
	/** Request reserved for flush and release */
136
	struct fuse_req *reserved_req;
137

Tejun Heo's avatar
Tejun Heo committed
138
139
140
	/** Kernel file handle guaranteed to be unique */
	u64 kh;

141
142
	/** File handle used by userspace */
	u64 fh;
143

144
145
146
	/** Node id of this file */
	u64 nodeid;

147
148
	/** Refcount */
	atomic_t count;
149

150
151
152
	/** FOPEN_* flags returned by open */
	u32 open_flags;

153
154
	/** Entry on inode's write_files list */
	struct list_head write_entry;
Tejun Heo's avatar
Tejun Heo committed
155
156
157
158
159
160

	/** RB node to be linked on fuse_conn->polled_files */
	struct rb_node polled_node;

	/** Wait queue head for poll */
	wait_queue_head_t poll_wait;
Miklos Szeredi's avatar
Miklos Szeredi committed
161
162
163

	/** Has flock been performed on this file? */
	bool flock:1;
164
165
};

166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/** 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;

198
199
200
201
202
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

203
204
205
206
207
208
209
210
211
212
	/** 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;

213
214
215
	/** Pages may be replaced with new ones */
	unsigned page_replace:1;

216
217
218
219
	/** Number or arguments */
	unsigned numargs;

	/** Array of arguments */
Miklos Szeredi's avatar
Miklos Szeredi committed
220
	struct fuse_arg args[2];
221
222
};

223
224
225
226
227
228
/** FUSE page descriptor */
struct fuse_page_desc {
	unsigned int length;
	unsigned int offset;
};

229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
struct fuse_args {
	struct {
		struct {
			uint32_t opcode;
			uint64_t nodeid;
		} h;
		unsigned numargs;
		struct fuse_in_arg args[3];

	} in;
	struct {
		unsigned argvar:1;
		unsigned numargs;
		struct fuse_arg args[2];
	} out;
};

#define FUSE_ARGS(args) struct fuse_args args = {}

Maxim Patlasov's avatar
Maxim Patlasov committed
248
249
/** The request IO state (for asynchronous processing) */
struct fuse_io_priv {
250
	struct kref refcnt;
Maxim Patlasov's avatar
Maxim Patlasov committed
251
252
253
254
255
256
257
258
259
260
	int async;
	spinlock_t lock;
	unsigned reqs;
	ssize_t bytes;
	size_t size;
	__u64 offset;
	bool write;
	int err;
	struct kiocb *iocb;
	struct file *file;
261
	struct completion *done;
262
	bool blocking;
Maxim Patlasov's avatar
Maxim Patlasov committed
263
264
};

265
266
267
268
269
270
271
#define FUSE_IO_PRIV_SYNC(f) \
{					\
	.refcnt = { ATOMIC_INIT(1) },	\
	.async = 0,			\
	.file = f,			\
}

Miklos Szeredi's avatar
Miklos Szeredi committed
272
273
274
275
276
277
278
279
280
281
/**
 * Request flags
 *
 * FR_ISREPLY:		set if the request has reply
 * FR_FORCE:		force sending of the request even if interrupted
 * FR_BACKGROUND:	request is sent in the background
 * FR_WAITING:		request is counted as "waiting"
 * FR_ABORTED:		the request was aborted
 * FR_INTERRUPTED:	the request has been interrupted
 * FR_LOCKED:		data is being copied to/from the request
Miklos Szeredi's avatar
Miklos Szeredi committed
282
283
284
 * FR_PENDING:		request is not yet in userspace
 * FR_SENT:		request is in userspace, waiting for an answer
 * FR_FINISHED:		request is finished
285
 * FR_PRIVATE:		request is on private list
Miklos Szeredi's avatar
Miklos Szeredi committed
286
287
288
289
290
291
292
293
294
 */
enum fuse_req_flag {
	FR_ISREPLY,
	FR_FORCE,
	FR_BACKGROUND,
	FR_WAITING,
	FR_ABORTED,
	FR_INTERRUPTED,
	FR_LOCKED,
Miklos Szeredi's avatar
Miklos Szeredi committed
295
296
297
	FR_PENDING,
	FR_SENT,
	FR_FINISHED,
298
	FR_PRIVATE,
Miklos Szeredi's avatar
Miklos Szeredi committed
299
300
};

301
302
/**
 * A request to the client
303
304
305
306
 *
 * .waitq.lock protects the following fields:
 *   - FR_ABORTED
 *   - FR_LOCKED (may also be modified under fc->lock, tested under both)
307
308
 */
struct fuse_req {
309
310
	/** This can be on either pending processing or io lists in
	    fuse_conn */
311
312
	struct list_head list;

313
314
315
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

316
317
318
	/** refcount */
	atomic_t count;

319
320
321
	/** Unique ID for the interrupt request */
	u64 intr_unique;

Miklos Szeredi's avatar
Miklos Szeredi committed
322
323
	/* Request flags, updated with test/set/clear_bit() */
	unsigned long flags;
324

325
326
327
328
329
330
331
332
333
334
335
	/** 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 {
336
		struct {
337
338
			struct fuse_release_in in;
			struct inode *inode;
339
		} release;
340
341
		struct fuse_init_in init_in;
		struct fuse_init_out init_out;
342
		struct cuse_init_in cuse_init_in;
343
344
345
346
		struct {
			struct fuse_read_in in;
			u64 attr_ver;
		} read;
347
348
349
		struct {
			struct fuse_write_in in;
			struct fuse_write_out out;
350
			struct fuse_req *next;
351
		} write;
Miklos Szeredi's avatar
Miklos Szeredi committed
352
		struct fuse_notify_retrieve_in retrieve_in;
353
354
355
	} misc;

	/** page vector */
356
357
	struct page **pages;

358
359
360
	/** page-descriptor vector */
	struct fuse_page_desc *page_descs;

361
362
363
364
365
	/** size of the 'pages' array */
	unsigned max_pages;

	/** inline page vector */
	struct page *inline_pages[FUSE_REQ_INLINE_PAGES];
366

367
368
369
	/** inline page-descriptor vector */
	struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];

370
371
372
373
	/** number of pages in vector */
	unsigned num_pages;

	/** File used in the request (or NULL) */
374
	struct fuse_file *ff;
375

Miklos Szeredi's avatar
Miklos Szeredi committed
376
377
378
	/** Inode used in the request or NULL */
	struct inode *inode;

Maxim Patlasov's avatar
Maxim Patlasov committed
379
380
381
	/** AIO control block */
	struct fuse_io_priv *io;

Miklos Szeredi's avatar
Miklos Szeredi committed
382
383
384
	/** Link on fi->writepages */
	struct list_head writepages_entry;

385
386
	/** Request completion callback */
	void (*end)(struct fuse_conn *, struct fuse_req *);
387
388
389

	/** Request is stolen from fuse_file->reserved_req */
	struct file *stolen_file;
390
391
};

392
struct fuse_iqueue {
393
394
395
	/** Connection established */
	unsigned connected;

396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
	/** Readers of the connection are waiting on this */
	wait_queue_head_t waitq;

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

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

	/** Pending interrupts */
	struct list_head interrupts;

	/** Queue of pending forgets */
	struct fuse_forget_link forget_list_head;
	struct fuse_forget_link *forget_list_tail;

	/** Batching of FORGET requests (positive indicates FORGET batch) */
	int forget_batch;

	/** O_ASYNC requests */
	struct fasync_struct *fasync;
};

419
struct fuse_pqueue {
420
421
422
	/** Connection established */
	unsigned connected;

Miklos Szeredi's avatar
Miklos Szeredi committed
423
424
425
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

426
427
428
429
430
431
432
	/** The list of requests being processed */
	struct list_head processing;

	/** The list of requests under I/O */
	struct list_head io;
};

433
434
435
436
437
438
439
/**
 * Fuse device instance
 */
struct fuse_dev {
	/** Fuse connection for this device */
	struct fuse_conn *fc;

440
441
442
	/** Processing queue */
	struct fuse_pqueue pq;

443
444
445
446
	/** list entry on fc->devices */
	struct list_head entry;
};

Miklos Szeredi's avatar
Miklos Szeredi committed
447
448
449
450
451
452
453
454
/**
 * 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 {
455
456
457
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

458
459
460
	/** Refcount */
	atomic_t count;

461
462
463
	/** Number of fuse_dev's */
	atomic_t dev_count;

Al Viro's avatar
Al Viro committed
464
465
	struct rcu_head rcu;

Miklos Szeredi's avatar
Miklos Szeredi committed
466
	/** The user id for this mount */
467
	kuid_t user_id;
Miklos Szeredi's avatar
Miklos Szeredi committed
468

469
	/** The group id for this mount */
470
	kgid_t group_id;
471

Miklos Szeredi's avatar
Miklos Szeredi committed
472
473
474
	/** The fuse mount flags for this mount */
	unsigned flags;

475
476
477
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
478
479
480
	/** Maximum write size */
	unsigned max_write;

481
482
	/** Input queue */
	struct fuse_iqueue iq;
483

Tejun Heo's avatar
Tejun Heo committed
484
485
486
	/** The next unique kernel file handle */
	u64 khctr;

Tejun Heo's avatar
Tejun Heo committed
487
488
489
	/** rbtree of fuse_files waiting for poll events indexed by ph */
	struct rb_root polled_files;

490
491
492
493
494
495
	/** Maximum number of outstanding background requests */
	unsigned max_background;

	/** Number of background requests at which congestion starts */
	unsigned congestion_threshold;

496
497
498
	/** Number of requests currently in the background */
	unsigned num_background;

499
500
501
502
503
504
	/** 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;

505
506
507
508
	/** Flag indicating that INIT reply has been received. Allocating
	 * any fuse request will be suspended until the flag is set */
	int initialized;

509
510
511
512
513
514
515
	/** 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;
516
517
518

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

520
521
	/** Connection established, cleared on umount, connection
	    abort and device release */
522
	unsigned connected;
Miklos Szeredi's avatar
Miklos Szeredi committed
523

524
525
526
	/** 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
527
	unsigned conn_error:1;
528

529
	/** Connection successful.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
530
	unsigned conn_init:1;
531

532
	/** Do readpages asynchronously?  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
533
	unsigned async_read:1;
534

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

538
	/** Filesystem supports NFS exporting.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
539
	unsigned export_support:1;
540

541
542
543
	/** Set if bdi is valid */
	unsigned bdi_initialized:1;

544
545
546
	/** write-back cache policy (default is write-through) */
	unsigned writeback_cache:1;

547
548
549
	/** allow parallel lookups and readdir (default is serialized) */
	unsigned parallel_dirops:1;

550
551
552
	/** handle fs handles killing suid/sgid/cap on write/chown/trunc */
	unsigned handle_killpriv:1;

553
554
555
556
557
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

558
559
560
	/** Is open/release not implemented by fs? */
	unsigned no_open:1;

561
	/** Is fsync not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
562
	unsigned no_fsync:1;
563

564
	/** Is fsyncdir not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
565
	unsigned no_fsyncdir:1;
566

567
	/** Is flush not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
568
	unsigned no_flush:1;
569

570
	/** Is setxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
571
	unsigned no_setxattr:1;
572
573

	/** Is getxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
574
	unsigned no_getxattr:1;
575
576

	/** Is listxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
577
	unsigned no_listxattr:1;
578
579

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

Miklos Szeredi's avatar
Miklos Szeredi committed
582
	/** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
583
	unsigned no_lock:1;
584

Miklos Szeredi's avatar
Miklos Szeredi committed
585
	/** Is access not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
586
	unsigned no_access:1;
Miklos Szeredi's avatar
Miklos Szeredi committed
587

588
	/** Is create not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
589
	unsigned no_create:1;
590

591
	/** Is interrupt not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
592
	unsigned no_interrupt:1;
593

594
	/** Is bmap not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
595
	unsigned no_bmap:1;
596

Tejun Heo's avatar
Tejun Heo committed
597
598
599
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

600
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
601
	unsigned big_writes:1;
602

603
604
605
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
606
607
608
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

609
610
611
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
612
613
614
	/** Is rename with flags implemented by fs? */
	unsigned no_rename2:1;

615
616
617
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

618
	/** Does the filesystem support readdirplus? */
619
620
	unsigned do_readdirplus:1;

621
622
623
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

624
625
626
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

627
628
629
	/** Is lseek not implemented by fs? */
	unsigned no_lseek:1;

630
631
632
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

633
634
635
	/** Negotiated minor version */
	unsigned minor;

Miklos Szeredi's avatar
Miklos Szeredi committed
636
637
	/** Backing dev info */
	struct backing_dev_info bdi;
638

639
640
641
	/** Entry on the fuse_conn_list */
	struct list_head entry;

642
643
	/** Device ID from super block */
	dev_t dev;
644
645
646
647
648
649

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

	/** number of dentries used in the above array */
	int ctl_ndents;
650

651
652
	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
653
654
655

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
656
657
658

	/** Version counter for attribute changes */
	u64 attr_version;
Tejun Heo's avatar
Tejun Heo committed
659
660
661

	/** Called on final put */
	void (*release)(struct fuse_conn *);
John Muir's avatar
John Muir committed
662
663
664
665
666
667

	/** Super block for this connection. */
	struct super_block *sb;

	/** Read/write semaphore to hold when accessing sb. */
	struct rw_semaphore killsb;
668
669
670

	/** List of device instances belonging to this connection */
	struct list_head devices;
Miklos Szeredi's avatar
Miklos Szeredi committed
671
672
673
674
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
675
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
}

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

693
/** Device operations */
694
extern const struct file_operations fuse_dev_operations;
695

Al Viro's avatar
Al Viro committed
696
extern const struct dentry_operations fuse_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
697

John Muir's avatar
John Muir committed
698
699
700
701
702
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

703
704
705
/**
 * Get a filled in inode
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
706
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
707
708
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
709

Al Viro's avatar
Al Viro committed
710
int fuse_lookup_name(struct super_block *sb, u64 nodeid, const struct qstr *name,
711
712
		     struct fuse_entry_out *outarg, struct inode **inode);

713
714
715
/**
 * Send FORGET command
 */
716
717
718
719
void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
		       u64 nodeid, u64 nlookup);

struct fuse_forget_link *fuse_alloc_forget(void);
720

721
722
723
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

724
/**
725
 * Initialize READ or READDIR request
726
 */
727
void fuse_read_fill(struct fuse_req *req, struct file *file,
728
		    loff_t pos, size_t count, int opcode);
729
730
731
732

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

Tejun Heo's avatar
Tejun Heo committed
735
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
736
struct fuse_file *fuse_file_get(struct fuse_file *ff);
737
void fuse_file_free(struct fuse_file *ff);
738
void fuse_finish_open(struct inode *inode, struct file *file);
739

740
void fuse_sync_release(struct fuse_file *ff, int flags);
741

742
743
744
/**
 * Send RELEASE or RELEASEDIR request
 */
745
void fuse_release_common(struct file *file, int opcode);
746

747
748
749
/**
 * Send FSYNC or FSYNCDIR request
 */
750
751
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
752

Tejun Heo's avatar
Tejun Heo committed
753
754
755
756
757
758
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

759
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
760
 * Initialize file operations on a regular file
761
762
763
 */
void fuse_init_file_inode(struct inode *inode);

764
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
765
 * Initialize inode operations on regular files and special files
766
767
768
769
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
770
 * Initialize inode and file operations on a directory
771
772
773
774
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
775
 * Initialize inode operations on a symlink
776
777
778
779
780
781
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
782
783
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
784

Miklos Szeredi's avatar
Miklos Szeredi committed
785
786
787
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

788
789
790
791
792
793
794
795
796
797
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

798
int fuse_ctl_init(void);
799
void __exit fuse_ctl_cleanup(void);
800

801
802
803
/**
 * Allocate a request
 */
804
struct fuse_req *fuse_request_alloc(unsigned npages);
805

806
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
Miklos Szeredi's avatar
Miklos Szeredi committed
807

808
809
810
811
812
813
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
814
815
 * Get a request, may fail with -ENOMEM,
 * caller should specify # elements in req->pages[] explicitly
816
 */
817
struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
818
819
struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
					     unsigned npages);
820

821
822
823
824
825
/*
 * Increment reference count on request
 */
void __fuse_get_request(struct fuse_req *req);

826
827
828
/**
 * Gets a requests for a file operation, always succeeds
 */
829
830
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
831

832
/**
833
834
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
835
836
837
838
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
839
 * Send a request (synchronous)
840
 */
841
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
842

843
844
845
846
847
/**
 * Simple request sending that does request allocation and freeing
 */
ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);

848
849
850
/**
 * Send a request in the background
 */
851
void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
852

853
854
void fuse_request_send_background_locked(struct fuse_conn *fc,
					 struct fuse_req *req);
Miklos Szeredi's avatar
Miklos Szeredi committed
855

856
/* Abort all requests */
857
858
void fuse_abort_conn(struct fuse_conn *fc);

859
860
861
862
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
863

Miklos Szeredi's avatar
Miklos Szeredi committed
864
865
void fuse_invalidate_entry_cache(struct dentry *entry);

866
867
void fuse_invalidate_atime(struct inode *inode);

868
869
870
871
872
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

873
874
875
/**
 * Initialize fuse_conn
 */
876
void fuse_conn_init(struct fuse_conn *fc);
877

878
879
880
881
882
/**
 * Release reference to fuse_conn
 */
void fuse_conn_put(struct fuse_conn *fc);

883
884
885
struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
void fuse_dev_free(struct fuse_dev *fud);

886
887
888
889
890
891
892
893
894
/**
 * 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);
895
896
897
898
899

/**
 * Is file type valid?
 */
int fuse_valid_type(int m);
Miklos Szeredi's avatar
Miklos Szeredi committed
900
901

/**
902
 * Is current process allowed to perform filesystem operation?
Miklos Szeredi's avatar
Miklos Szeredi committed
903
 */
904
int fuse_allow_current_process(struct fuse_conn *fc);
905
906

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

Seth Forshee's avatar
Seth Forshee committed
908
909
void fuse_update_ctime(struct inode *inode);

Miklos Szeredi's avatar
Miklos Szeredi committed
910
911
int fuse_update_attributes(struct inode *inode, struct kstat *stat,
			   struct file *file, bool *refreshed);
Miklos Szeredi's avatar
Miklos Szeredi committed
912
913
914
915
916

void fuse_flush_writepages(struct inode *inode);

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

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

John Muir's avatar
John Muir committed
920
921
922
923
924
925
926
927
928
/**
 * File-system tells the kernel to invalidate cache for the given node id.
 */
int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid,
			     loff_t offset, loff_t len);

/**
 * File-system tells the kernel to invalidate parent attributes and
 * the dentry matching parent/name.
929
930
931
932
933
934
 *
 * If the child_nodeid is non-zero and:
 *    - matches the inode number for the dentry matching parent/name,
 *    - is not a mount point
 *    - is a file or oan empty directory
 * then the dentry is unhashed (d_delete()).
John Muir's avatar
John Muir committed
935
936
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
937
			     u64 child_nodeid, struct qstr *name);
John Muir's avatar
John Muir committed
938

939
940
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
941
942
943
944
945
946
947
948
949
950
951

/**
 * fuse_direct_io() flags
 */

/** If set, it is WRITE; otherwise - READ */
#define FUSE_DIO_WRITE (1 << 0)

/** CUSE pass fuse_direct_io() a file which f_mapping->host is not from FUSE */
#define FUSE_DIO_CUSE  (1 << 1)

952
953
ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
		       loff_t *ppos, int flags);
954
955
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
956
957
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
958
959
960
unsigned fuse_file_poll(struct file *file, poll_table *wait);
int fuse_dev_release(struct inode *inode, struct file *file);

961
962
bool fuse_write_update_size(struct inode *inode, loff_t pos);

963
int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
Miklos Szeredi's avatar
Miklos Szeredi committed
964
int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
Miklos Szeredi's avatar
Miklos Szeredi committed
965

966
967
968
int fuse_do_setattr(struct inode *inode, struct iattr *attr,
		    struct file *file);

969
970
void fuse_set_initialized(struct fuse_conn *fc);

971
972
973
void fuse_unlock_inode(struct inode *inode);
void fuse_lock_inode(struct inode *inode);

Seth Forshee's avatar
Seth Forshee committed
974
975
976
ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
extern const struct xattr_handler *fuse_xattr_handlers[];

Tejun Heo's avatar
Tejun Heo committed
977
#endif /* _FS_FUSE_I_H */