fuse_i.h 24.8 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>
Seth Forshee's avatar
Seth Forshee committed
26
#include <linux/xattr.h>
27
#include <linux/pid_namespace.h>
28
#include <linux/refcount.h>
29
#include <linux/user_namespace.h>
Miklos Szeredi's avatar
Miklos Szeredi committed
30

31
32
33
/** 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
34
35
36
/** Bias for fi->writectr, meaning new writepages must not be sent */
#define FUSE_NOWRITE INT_MIN

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

40
/** Number of dentries for each connection in the control filesystem */
41
#define FUSE_CTL_NUM_DENTRIES 5
42

43
44
45
/** Number of page pointers embedded in fuse_req */
#define FUSE_REQ_INLINE_PAGES 1

46
47
48
49
50
/** 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
51

52
53
54
55
/** Module parameters */
extern unsigned max_user_bgreq;
extern unsigned max_user_congthresh;

56
57
/* One forget request */
struct fuse_forget_link {
58
	struct fuse_forget_one forget_one;
59
60
61
	struct fuse_forget_link *next;
};

Miklos Szeredi's avatar
Miklos Szeredi committed
62
63
64
65
66
67
68
69
70
/** FUSE inode */
struct fuse_inode {
	/** Inode data */
	struct inode inode;

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

71
72
73
	/** Number of lookups on this inode */
	u64 nlookup;

74
	/** The request used for sending the FORGET message */
75
	struct fuse_forget_link *forget;
76

Miklos Szeredi's avatar
Miklos Szeredi committed
77
	/** Time in jiffies until the file attributes are valid */
Miklos Szeredi's avatar
Miklos Szeredi committed
78
	u64 i_time;
79
80
81

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

84
85
86
	/** 64 bit inode number */
	u64 orig_ino;

87
88
	/** Version of last attribute change */
	u64 attr_version;
89
90
91

	/** Files usable in writepage.  Protected by fc->lock */
	struct list_head write_files;
Miklos Szeredi's avatar
Miklos Szeredi committed
92
93
94
95
96
97
98
99
100
101
102
103
104

	/** 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;
105

Miklos Szeredi's avatar
Miklos Szeredi committed
106
107
108
109
110
111
112
113
114
115
116
	/* readdir cache */
	struct {
		/* true if fully cached */
		bool cached;

		/* size of cache */
		loff_t size;

		/* position at end of cache (position of next entry) */
		loff_t pos;

117
118
119
		/* version of the cache */
		u64 version;

120
121
122
		/* modification time of directory when cache was started */
		struct timespec64 mtime;

Miklos Szeredi's avatar
Miklos Szeredi committed
123
124
125
126
		/* protects above fields */
		spinlock_t lock;
	} rdc;

127
128
	/** Miscellaneous bits describing inode state */
	unsigned long state;
129
130
131

	/** Lock for serializing lookup and readdir for back compatibility*/
	struct mutex mutex;
132
133
134
135
136
137
};

/** FUSE inode state bits */
enum {
	/** Advise readdirplus  */
	FUSE_I_ADVISE_RDPLUS,
138
139
	/** Initialized with readdirplus */
	FUSE_I_INIT_RDPLUS,
140
141
	/** An operation changing file size is in progress  */
	FUSE_I_SIZE_UNSTABLE,
Miklos Szeredi's avatar
Miklos Szeredi committed
142
143
};

144
145
struct fuse_conn;

146
147
/** FUSE specific file data */
struct fuse_file {
148
149
150
	/** Fuse connection for this file */
	struct fuse_conn *fc;

151
	/** Request reserved for flush and release */
152
	struct fuse_req *reserved_req;
153

Tejun Heo's avatar
Tejun Heo committed
154
155
156
	/** Kernel file handle guaranteed to be unique */
	u64 kh;

157
158
	/** File handle used by userspace */
	u64 fh;
159

160
161
162
	/** Node id of this file */
	u64 nodeid;

163
	/** Refcount */
164
	refcount_t count;
165

166
167
168
	/** FOPEN_* flags returned by open */
	u32 open_flags;

169
170
	/** Entry on inode's write_files list */
	struct list_head write_entry;
Tejun Heo's avatar
Tejun Heo committed
171

172
173
174
175
176
177
178
179
180
181
182
183
184
	/* Readdir related */
	struct {
		/*
		 * Protects below fields against (crazy) parallel readdir on
		 * same open file.  Uncontended in the normal case.
		 */
		struct mutex lock;

		/* Dir stream position */
		loff_t pos;

		/* Offset in cache */
		loff_t cache_off;
185
186
187
188

		/* Version of cache we are reading */
		u64 version;

189
190
	} readdir;

Tejun Heo's avatar
Tejun Heo committed
191
192
193
194
195
	/** 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
196
197
198

	/** Has flock been performed on this file? */
	bool flock:1;
199
200
};

201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
/** 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;

233
234
235
236
237
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

238
239
240
241
242
243
244
245
246
247
	/** 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;

248
249
250
	/** Pages may be replaced with new ones */
	unsigned page_replace:1;

251
252
253
254
	/** Number or arguments */
	unsigned numargs;

	/** Array of arguments */
Miklos Szeredi's avatar
Miklos Szeredi committed
255
	struct fuse_arg args[2];
256
257
};

258
259
260
261
262
263
/** FUSE page descriptor */
struct fuse_page_desc {
	unsigned int length;
	unsigned int offset;
};

264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
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
283
284
/** The request IO state (for asynchronous processing) */
struct fuse_io_priv {
285
	struct kref refcnt;
Maxim Patlasov's avatar
Maxim Patlasov committed
286
287
288
289
290
291
292
	int async;
	spinlock_t lock;
	unsigned reqs;
	ssize_t bytes;
	size_t size;
	__u64 offset;
	bool write;
293
	bool should_dirty;
Maxim Patlasov's avatar
Maxim Patlasov committed
294
295
	int err;
	struct kiocb *iocb;
296
	struct completion *done;
297
	bool blocking;
Maxim Patlasov's avatar
Maxim Patlasov committed
298
299
};

300
#define FUSE_IO_PRIV_SYNC(i) \
301
{					\
302
	.refcnt = KREF_INIT(1),		\
303
	.async = 0,			\
304
	.iocb = i,			\
305
306
}

Miklos Szeredi's avatar
Miklos Szeredi committed
307
308
309
310
311
312
313
314
315
316
/**
 * 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
317
318
319
 * FR_PENDING:		request is not yet in userspace
 * FR_SENT:		request is in userspace, waiting for an answer
 * FR_FINISHED:		request is finished
320
 * FR_PRIVATE:		request is on private list
Miklos Szeredi's avatar
Miklos Szeredi committed
321
322
323
324
325
326
327
328
329
 */
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
330
331
332
	FR_PENDING,
	FR_SENT,
	FR_FINISHED,
333
	FR_PRIVATE,
Miklos Szeredi's avatar
Miklos Szeredi committed
334
335
};

336
337
/**
 * A request to the client
338
339
340
341
 *
 * .waitq.lock protects the following fields:
 *   - FR_ABORTED
 *   - FR_LOCKED (may also be modified under fc->lock, tested under both)
342
343
 */
struct fuse_req {
344
345
	/** This can be on either pending processing or io lists in
	    fuse_conn */
346
347
	struct list_head list;

348
349
350
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

351
	/** refcount */
352
	refcount_t count;
353

Miklos Szeredi's avatar
Miklos Szeredi committed
354
355
	/* Request flags, updated with test/set/clear_bit() */
	unsigned long flags;
356

357
358
359
360
361
362
363
364
365
366
367
	/** 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 {
368
		struct {
369
370
			struct fuse_release_in in;
			struct inode *inode;
371
		} release;
372
373
		struct fuse_init_in init_in;
		struct fuse_init_out init_out;
374
		struct cuse_init_in cuse_init_in;
375
376
377
378
		struct {
			struct fuse_read_in in;
			u64 attr_ver;
		} read;
379
380
381
		struct {
			struct fuse_write_in in;
			struct fuse_write_out out;
382
			struct fuse_req *next;
383
		} write;
Miklos Szeredi's avatar
Miklos Szeredi committed
384
		struct fuse_notify_retrieve_in retrieve_in;
385
386
387
	} misc;

	/** page vector */
388
389
	struct page **pages;

390
391
392
	/** page-descriptor vector */
	struct fuse_page_desc *page_descs;

393
394
395
396
397
	/** size of the 'pages' array */
	unsigned max_pages;

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

399
400
401
	/** inline page-descriptor vector */
	struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];

402
403
404
405
	/** number of pages in vector */
	unsigned num_pages;

	/** File used in the request (or NULL) */
406
	struct fuse_file *ff;
407

Miklos Szeredi's avatar
Miklos Szeredi committed
408
409
410
	/** Inode used in the request or NULL */
	struct inode *inode;

Maxim Patlasov's avatar
Maxim Patlasov committed
411
412
413
	/** AIO control block */
	struct fuse_io_priv *io;

Miklos Szeredi's avatar
Miklos Szeredi committed
414
415
416
	/** Link on fi->writepages */
	struct list_head writepages_entry;

417
418
	/** Request completion callback */
	void (*end)(struct fuse_conn *, struct fuse_req *);
419
420
421

	/** Request is stolen from fuse_file->reserved_req */
	struct file *stolen_file;
422
423
};

424
struct fuse_iqueue {
425
426
427
	/** Connection established */
	unsigned connected;

428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
	/** 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;
};

451
452
453
#define FUSE_PQ_HASH_BITS 8
#define FUSE_PQ_HASH_SIZE (1 << FUSE_PQ_HASH_BITS)

454
struct fuse_pqueue {
455
456
457
	/** Connection established */
	unsigned connected;

Miklos Szeredi's avatar
Miklos Szeredi committed
458
459
460
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

461
462
	/** Hash table of requests being processed */
	struct list_head *processing;
463
464
465
466
467

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

468
469
470
471
472
473
474
/**
 * Fuse device instance
 */
struct fuse_dev {
	/** Fuse connection for this device */
	struct fuse_conn *fc;

475
476
477
	/** Processing queue */
	struct fuse_pqueue pq;

478
479
480
481
	/** list entry on fc->devices */
	struct list_head entry;
};

Miklos Szeredi's avatar
Miklos Szeredi committed
482
483
484
485
486
487
488
489
/**
 * 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 {
490
491
492
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

493
	/** Refcount */
494
	refcount_t count;
495

496
497
498
	/** Number of fuse_dev's */
	atomic_t dev_count;

Al Viro's avatar
Al Viro committed
499
500
	struct rcu_head rcu;

Miklos Szeredi's avatar
Miklos Szeredi committed
501
	/** The user id for this mount */
502
	kuid_t user_id;
Miklos Szeredi's avatar
Miklos Szeredi committed
503

504
	/** The group id for this mount */
505
	kgid_t group_id;
506

507
508
509
	/** The pid namespace for this mount */
	struct pid_namespace *pid_ns;

510
511
512
	/** The user namespace for this mount */
	struct user_namespace *user_ns;

513
514
515
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
516
517
518
	/** Maximum write size */
	unsigned max_write;

519
520
	/** Input queue */
	struct fuse_iqueue iq;
521

Tejun Heo's avatar
Tejun Heo committed
522
523
524
	/** The next unique kernel file handle */
	u64 khctr;

Tejun Heo's avatar
Tejun Heo committed
525
526
527
	/** rbtree of fuse_files waiting for poll events indexed by ph */
	struct rb_root polled_files;

528
529
530
531
532
533
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

534
535
536
	/** Number of requests currently in the background */
	unsigned num_background;

537
538
539
540
541
542
	/** 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;

Kirill Tkhai's avatar
Kirill Tkhai committed
543
544
545
546
	/** Protects: max_background, congestion_threshold, num_background,
	 * active_background, bg_queue, blocked */
	spinlock_t bg_lock;

547
548
549
550
	/** Flag indicating that INIT reply has been received. Allocating
	 * any fuse request will be suspended until the flag is set */
	int initialized;

551
552
553
554
555
556
557
	/** 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;
558
559
560

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

562
563
	/** Connection established, cleared on umount, connection
	    abort and device release */
564
	unsigned connected;
Miklos Szeredi's avatar
Miklos Szeredi committed
565

566
567
568
	/** Connection aborted via sysfs */
	bool aborted;

569
570
571
	/** 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
572
	unsigned conn_error:1;
573

574
	/** Connection successful.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
575
	unsigned conn_init:1;
576

577
	/** Do readpages asynchronously?  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
578
	unsigned async_read:1;
579

580
581
582
	/** Return an unique read error after abort.  Only set in INIT */
	unsigned abort_err:1;

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

586
	/** Filesystem supports NFS exporting.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
587
	unsigned export_support:1;
588

589
590
591
	/** write-back cache policy (default is write-through) */
	unsigned writeback_cache:1;

592
593
594
	/** allow parallel lookups and readdir (default is serialized) */
	unsigned parallel_dirops:1;

595
596
597
	/** handle fs handles killing suid/sgid/cap on write/chown/trunc */
	unsigned handle_killpriv:1;

598
599
600
601
602
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

603
604
605
	/** Is open/release not implemented by fs? */
	unsigned no_open:1;

606
	/** Is fsync not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
607
	unsigned no_fsync:1;
608

609
	/** Is fsyncdir not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
610
	unsigned no_fsyncdir:1;
611

612
	/** Is flush not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
613
	unsigned no_flush:1;
614

615
	/** Is setxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
616
	unsigned no_setxattr:1;
617
618

	/** Is getxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
619
	unsigned no_getxattr:1;
620
621

	/** Is listxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
622
	unsigned no_listxattr:1;
623
624

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

Miklos Szeredi's avatar
Miklos Szeredi committed
627
	/** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
628
	unsigned no_lock:1;
629

Miklos Szeredi's avatar
Miklos Szeredi committed
630
	/** Is access not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
631
	unsigned no_access:1;
Miklos Szeredi's avatar
Miklos Szeredi committed
632

633
	/** Is create not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
634
	unsigned no_create:1;
635

636
	/** Is interrupt not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
637
	unsigned no_interrupt:1;
638

639
	/** Is bmap not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
640
	unsigned no_bmap:1;
641

Tejun Heo's avatar
Tejun Heo committed
642
643
644
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

645
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
646
	unsigned big_writes:1;
647

648
649
650
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
651
652
653
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

654
655
656
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
657
658
659
	/** Is rename with flags implemented by fs? */
	unsigned no_rename2:1;

660
661
662
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

663
	/** Does the filesystem support readdirplus? */
664
665
	unsigned do_readdirplus:1;

666
667
668
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

669
670
671
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

672
673
674
	/** Is lseek not implemented by fs? */
	unsigned no_lseek:1;

Seth Forshee's avatar
Seth Forshee committed
675
676
677
	/** Does the filesystem support posix acls? */
	unsigned posix_acl:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
678
679
680
681
682
683
	/** Check permissions based on the file mode or not? */
	unsigned default_permissions:1;

	/** Allow other than the mounter user to access the filesystem ? */
	unsigned allow_other:1;

684
685
686
	/** Does the filesystem support copy_file_range? */
	unsigned no_copy_file_range:1;

687
688
689
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

690
691
692
	/** Negotiated minor version */
	unsigned minor;

693
694
695
	/** Entry on the fuse_conn_list */
	struct list_head entry;

696
697
	/** Device ID from super block */
	dev_t dev;
698
699
700
701
702
703

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

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

705
706
	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
707
708
709

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
710
711
712

	/** Version counter for attribute changes */
	u64 attr_version;
Tejun Heo's avatar
Tejun Heo committed
713
714
715

	/** Called on final put */
	void (*release)(struct fuse_conn *);
John Muir's avatar
John Muir committed
716
717
718
719
720
721

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

	/** Read/write semaphore to hold when accessing sb. */
	struct rw_semaphore killsb;
722
723
724

	/** List of device instances belonging to this connection */
	struct list_head devices;
Miklos Szeredi's avatar
Miklos Szeredi committed
725
726
727
728
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
729
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
}

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

Miklos Szeredi's avatar
Miklos Szeredi committed
747
748
749
750
751
static inline int invalid_nodeid(u64 nodeid)
{
	return !nodeid || nodeid == FUSE_ROOT_ID;
}

752
/** Device operations */
753
extern const struct file_operations fuse_dev_operations;
754

Al Viro's avatar
Al Viro committed
755
extern const struct dentry_operations fuse_dentry_operations;
756
extern const struct dentry_operations fuse_root_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
757

John Muir's avatar
John Muir committed
758
759
760
761
762
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

763
764
765
/**
 * Get a filled in inode
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
766
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
767
768
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
769

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

773
774
775
/**
 * Send FORGET command
 */
776
777
778
779
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);
780

781
782
783
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

784
/**
785
 * Initialize READ or READDIR request
786
 */
787
void fuse_read_fill(struct fuse_req *req, struct file *file,
788
		    loff_t pos, size_t count, int opcode);
789
790
791
792

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

Tejun Heo's avatar
Tejun Heo committed
795
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
796
void fuse_file_free(struct fuse_file *ff);
797
void fuse_finish_open(struct inode *inode, struct file *file);
798

799
void fuse_sync_release(struct fuse_file *ff, int flags);
800

801
802
803
/**
 * Send RELEASE or RELEASEDIR request
 */
804
void fuse_release_common(struct file *file, int opcode);
805

806
807
808
/**
 * Send FSYNC or FSYNCDIR request
 */
809
810
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
811

Tejun Heo's avatar
Tejun Heo committed
812
813
814
815
816
817
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

818
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
819
 * Initialize file operations on a regular file
820
821
822
 */
void fuse_init_file_inode(struct inode *inode);

823
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
824
 * Initialize inode operations on regular files and special files
825
826
827
828
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
829
 * Initialize inode and file operations on a directory
830
831
832
833
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
834
 * Initialize inode operations on a symlink
835
836
837
838
839
840
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
841
842
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
843

Miklos Szeredi's avatar
Miklos Szeredi committed
844
845
846
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

847
848
849
850
851
852
853
854
855
856
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

857
int fuse_ctl_init(void);
858
void __exit fuse_ctl_cleanup(void);
859

860
861
862
/**
 * Allocate a request
 */
863
struct fuse_req *fuse_request_alloc(unsigned npages);
864

865
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
Miklos Szeredi's avatar
Miklos Szeredi committed
866

867
868
869
870
871
872
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
873
874
 * Get a request, may fail with -ENOMEM,
 * caller should specify # elements in req->pages[] explicitly
875
 */
876
struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
877
878
struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
					     unsigned npages);
879

880
881
882
883
884
/*
 * Increment reference count on request
 */
void __fuse_get_request(struct fuse_req *req);

885
886
887
/**
 * Gets a requests for a file operation, always succeeds
 */
888
889
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
890

891
/**
892
893
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
894
895
896
897
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
898
 * Send a request (synchronous)
899
 */
900
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
901

902
903
904
905
906
/**
 * Simple request sending that does request allocation and freeing
 */
ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);

907
908
909
/**
 * Send a request in the background
 */
910
void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
911
bool fuse_request_queue_background(struct fuse_conn *fc, struct fuse_req *req);
Miklos Szeredi's avatar
Miklos Szeredi committed
912

913
/* Abort all requests */
914
void fuse_abort_conn(struct fuse_conn *fc, bool is_abort);
915
void fuse_wait_aborted(struct fuse_conn *fc);
916

917
918
919
920
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
921

Miklos Szeredi's avatar
Miklos Szeredi committed
922
923
void fuse_invalidate_entry_cache(struct dentry *entry);

924
925
void fuse_invalidate_atime(struct inode *inode);

Miklos Szeredi's avatar
Miklos Szeredi committed
926
927
928
u64 entry_attr_timeout(struct fuse_entry_out *o);
void fuse_change_entry_timeout(struct dentry *entry, struct fuse_entry_out *o);

929
930
931
932
933
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

934
935
936
/**
 * Initialize fuse_conn
 */
937
void fuse_conn_init(struct fuse_conn *fc, struct user_namespace *user_ns);
938

939
940
941
942
943
/**
 * Release reference to fuse_conn
 */
void fuse_conn_put(struct fuse_conn *fc);

944
945
946
struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
void fuse_dev_free(struct fuse_dev *fud);

947
948
949
950
951
952
953
954
955
/**
 * 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);
956
957
958
959
960

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

/**
963
 * Is current process allowed to perform filesystem operation?
Miklos Szeredi's avatar
Miklos Szeredi committed
964
 */
965
int fuse_allow_current_process(struct fuse_conn *fc);
966
967

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

Seth Forshee's avatar
Seth Forshee committed
969
970
void fuse_update_ctime(struct inode *inode);

Miklos Szeredi's avatar
Miklos Szeredi committed
971
int fuse_update_attributes(struct inode *inode, struct file *file);
Miklos Szeredi's avatar
Miklos Szeredi committed
972
973
974
975
976

void fuse_flush_writepages(struct inode *inode);

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

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

John Muir's avatar
John Muir committed
980
981
982
983
984
985
986
987
988
/**
 * 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.
989
990
991
992
993
994
 *
 * 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
995
996
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
997
			     u64 child_nodeid, struct qstr *name);
John Muir's avatar
John Muir committed
998

999
1000
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011

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

1012
1013
ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
		       loff_t *ppos, int flags);
1014
1015
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
1016
1017
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
Al Viro's avatar
Al Viro committed
1018
__poll_t fuse_file_poll(struct file *file, poll_table *wait);
1019
1020
int fuse_dev_release(struct inode *inode, struct file *file);

1021
1022
bool fuse_write_update_size(struct inode *inode, loff_t pos);

1023
int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
Miklos Szeredi's avatar
Miklos Szeredi committed
1024
int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
Miklos Szeredi's avatar
Miklos Szeredi committed
1025

1026
int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
1027
1028
		    struct file *file);

1029
1030
void fuse_set_initialized(struct fuse_conn *fc);

1031
1032
void fuse_unlock_inode(struct inode *inode, bool locked);
bool fuse_lock_inode(struct inode *inode);
1033

Seth Forshee's avatar
Seth Forshee committed
1034
1035
1036
1037
int fuse_setxattr(struct inode *inode, const char *name, const void *value,
		  size_t size, int flags);
ssize_t fuse_getxattr(struct inode *inode, const char *name, void *value,
		      size_t size);
Seth Forshee's avatar
Seth Forshee committed
1038
ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
Seth Forshee's avatar
Seth Forshee committed
1039
int fuse_removexattr(struct inode *inode, const char *name);
Seth Forshee's avatar
Seth Forshee committed
1040
extern const struct xattr_handler *fuse_xattr_handlers[];
Seth Forshee's avatar
Seth Forshee committed
1041
extern const struct xattr_handler *fuse_acl_xattr_handlers[];
1042
extern const struct xattr_handler *fuse_no_acl_xattr_handlers[];
Seth Forshee's avatar
Seth Forshee committed
1043
1044
1045
1046

struct posix_acl;
struct posix_acl *fuse_get_acl(struct inode *inode, int type);
int fuse_set_acl(struct inode *inode, struct posix_acl *acl, int type);
Seth Forshee's avatar
Seth Forshee committed
1047

Miklos Szeredi's avatar
Miklos Szeredi committed
1048
1049
1050
1051

/* readdir.c */
int fuse_readdir(struct file *file, struct dir_context *ctx);

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