fuse_i.h 22.6 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;
Maxim Patlasov's avatar
Maxim Patlasov committed
262
263
};

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

Miklos Szeredi's avatar
Miklos Szeredi committed
271
272
273
274
275
276
277
278
279
280
/**
 * 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
281
282
283
 * FR_PENDING:		request is not yet in userspace
 * FR_SENT:		request is in userspace, waiting for an answer
 * FR_FINISHED:		request is finished
284
 * FR_PRIVATE:		request is on private list
Miklos Szeredi's avatar
Miklos Szeredi committed
285
286
287
288
289
290
291
292
293
 */
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
294
295
296
	FR_PENDING,
	FR_SENT,
	FR_FINISHED,
297
	FR_PRIVATE,
Miklos Szeredi's avatar
Miklos Szeredi committed
298
299
};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
	/** 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;
};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

549
550
551
552
553
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

554
555
556
	/** Is open/release not implemented by fs? */
	unsigned no_open:1;

557
	/** Is fsync not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
558
	unsigned no_fsync:1;
559

560
	/** Is fsyncdir not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
561
	unsigned no_fsyncdir:1;
562

563
	/** Is flush not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
564
	unsigned no_flush:1;
565

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

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

	/** Is listxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
573
	unsigned no_listxattr:1;
574
575

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

Miklos Szeredi's avatar
Miklos Szeredi committed
578
	/** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
579
	unsigned no_lock:1;
580

Miklos Szeredi's avatar
Miklos Szeredi committed
581
	/** Is access not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
582
	unsigned no_access:1;
Miklos Szeredi's avatar
Miklos Szeredi committed
583

584
	/** Is create not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
585
	unsigned no_create:1;
586

587
	/** Is interrupt not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
588
	unsigned no_interrupt:1;
589

590
	/** Is bmap not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
591
	unsigned no_bmap:1;
592

Tejun Heo's avatar
Tejun Heo committed
593
594
595
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

596
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
597
	unsigned big_writes:1;
598

599
600
601
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
602
603
604
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

605
606
607
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
608
609
610
	/** Is rename with flags implemented by fs? */
	unsigned no_rename2:1;

611
612
613
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

614
	/** Does the filesystem support readdirplus? */
615
616
	unsigned do_readdirplus:1;

617
618
619
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

620
621
622
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

623
624
625
	/** Is lseek not implemented by fs? */
	unsigned no_lseek:1;

626
627
628
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

629
630
631
	/** Negotiated minor version */
	unsigned minor;

Miklos Szeredi's avatar
Miklos Szeredi committed
632
633
	/** Backing dev info */
	struct backing_dev_info bdi;
634

635
636
637
	/** Entry on the fuse_conn_list */
	struct list_head entry;

638
639
	/** Device ID from super block */
	dev_t dev;
640
641
642
643
644
645

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

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

647
648
	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
649
650
651

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
652
653
654

	/** Version counter for attribute changes */
	u64 attr_version;
Tejun Heo's avatar
Tejun Heo committed
655
656
657

	/** Called on final put */
	void (*release)(struct fuse_conn *);
John Muir's avatar
John Muir committed
658
659
660
661
662
663

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

	/** Read/write semaphore to hold when accessing sb. */
	struct rw_semaphore killsb;
664
665
666

	/** List of device instances belonging to this connection */
	struct list_head devices;
Miklos Szeredi's avatar
Miklos Szeredi committed
667
668
669
670
};

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

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

689
/** Device operations */
690
extern const struct file_operations fuse_dev_operations;
691

Al Viro's avatar
Al Viro committed
692
extern const struct dentry_operations fuse_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
693

John Muir's avatar
John Muir committed
694
695
696
697
698
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

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

706
707
708
int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
		     struct fuse_entry_out *outarg, struct inode **inode);

709
710
711
/**
 * Send FORGET command
 */
712
713
714
715
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);
716

717
718
719
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

720
/**
721
 * Initialize READ or READDIR request
722
 */
723
void fuse_read_fill(struct fuse_req *req, struct file *file,
724
		    loff_t pos, size_t count, int opcode);
725
726
727
728

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

Tejun Heo's avatar
Tejun Heo committed
731
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
732
struct fuse_file *fuse_file_get(struct fuse_file *ff);
733
void fuse_file_free(struct fuse_file *ff);
734
void fuse_finish_open(struct inode *inode, struct file *file);
735

736
void fuse_sync_release(struct fuse_file *ff, int flags);
737

738
739
740
/**
 * Send RELEASE or RELEASEDIR request
 */
741
void fuse_release_common(struct file *file, int opcode);
742

743
744
745
/**
 * Send FSYNC or FSYNCDIR request
 */
746
747
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
748

Tejun Heo's avatar
Tejun Heo committed
749
750
751
752
753
754
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

755
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
756
 * Initialize file operations on a regular file
757
758
759
 */
void fuse_init_file_inode(struct inode *inode);

760
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
761
 * Initialize inode operations on regular files and special files
762
763
764
765
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
766
 * Initialize inode and file operations on a directory
767
768
769
770
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
771
 * Initialize inode operations on a symlink
772
773
774
775
776
777
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
778
779
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
780

Miklos Szeredi's avatar
Miklos Szeredi committed
781
782
783
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

784
785
786
787
788
789
790
791
792
793
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

794
int fuse_ctl_init(void);
795
void __exit fuse_ctl_cleanup(void);
796

797
798
799
/**
 * Allocate a request
 */
800
struct fuse_req *fuse_request_alloc(unsigned npages);
801

802
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
Miklos Szeredi's avatar
Miklos Szeredi committed
803

804
805
806
807
808
809
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

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

817
818
819
820
821
/*
 * Increment reference count on request
 */
void __fuse_get_request(struct fuse_req *req);

822
823
824
/**
 * Gets a requests for a file operation, always succeeds
 */
825
826
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
827

828
/**
829
830
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
831
832
833
834
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
835
 * Send a request (synchronous)
836
 */
837
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
838

839
840
841
842
843
/**
 * Simple request sending that does request allocation and freeing
 */
ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);

844
845
846
/**
 * Send a request in the background
 */
847
void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
848

849
850
void fuse_request_send_background_locked(struct fuse_conn *fc,
					 struct fuse_req *req);
Miklos Szeredi's avatar
Miklos Szeredi committed
851

852
/* Abort all requests */
853
854
void fuse_abort_conn(struct fuse_conn *fc);

855
856
857
858
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
859

Miklos Szeredi's avatar
Miklos Szeredi committed
860
861
void fuse_invalidate_entry_cache(struct dentry *entry);

862
863
void fuse_invalidate_atime(struct inode *inode);

864
865
866
867
868
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

869
870
871
/**
 * Initialize fuse_conn
 */
872
void fuse_conn_init(struct fuse_conn *fc);
873

874
875
876
877
878
/**
 * Release reference to fuse_conn
 */
void fuse_conn_put(struct fuse_conn *fc);

879
880
881
struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
void fuse_dev_free(struct fuse_dev *fud);

882
883
884
885
886
887
888
889
890
/**
 * 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);
891
892
893
894
895

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

/**
898
 * Is current process allowed to perform filesystem operation?
Miklos Szeredi's avatar
Miklos Szeredi committed
899
 */
900
int fuse_allow_current_process(struct fuse_conn *fc);
901
902

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

int fuse_update_attributes(struct inode *inode, struct kstat *stat,
			   struct file *file, bool *refreshed);
Miklos Szeredi's avatar
Miklos Szeredi committed
906
907
908
909
910

void fuse_flush_writepages(struct inode *inode);

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

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

John Muir's avatar
John Muir committed
914
915
916
917
918
919
920
921
922
/**
 * 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.
923
924
925
926
927
928
 *
 * 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
929
930
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
931
			     u64 child_nodeid, struct qstr *name);
John Muir's avatar
John Muir committed
932

933
934
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
935
936
937
938
939
940
941
942
943
944
945

/**
 * 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)

946
947
ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
		       loff_t *ppos, int flags);
948
949
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
950
951
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
952
953
954
unsigned fuse_file_poll(struct file *file, poll_table *wait);
int fuse_dev_release(struct inode *inode, struct file *file);

955
956
bool fuse_write_update_size(struct inode *inode, loff_t pos);

957
int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
Miklos Szeredi's avatar
Miklos Szeredi committed
958
int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
Miklos Szeredi's avatar
Miklos Szeredi committed
959

960
961
962
int fuse_do_setattr(struct inode *inode, struct iattr *attr,
		    struct file *file);

963
964
void fuse_set_initialized(struct fuse_conn *fc);

965
966
967
void fuse_unlock_inode(struct inode *inode);
void fuse_lock_inode(struct inode *inode);

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