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

Kirill Smelkov's avatar
Kirill Smelkov committed
12
13
14
15
#ifndef pr_fmt
# define pr_fmt(fmt) "fuse: " fmt
#endif

Miklos Szeredi's avatar
Miklos Szeredi committed
16
17
#include <linux/fuse.h>
#include <linux/fs.h>
18
#include <linux/mount.h>
Miklos Szeredi's avatar
Miklos Szeredi committed
19
20
21
22
23
#include <linux/wait.h>
#include <linux/list.h>
#include <linux/spinlock.h>
#include <linux/mm.h>
#include <linux/backing-dev.h>
24
#include <linux/mutex.h>
Miklos Szeredi's avatar
Miklos Szeredi committed
25
#include <linux/rwsem.h>
Tejun Heo's avatar
Tejun Heo committed
26
27
#include <linux/rbtree.h>
#include <linux/poll.h>
28
#include <linux/workqueue.h>
29
#include <linux/kref.h>
Seth Forshee's avatar
Seth Forshee committed
30
#include <linux/xattr.h>
31
#include <linux/pid_namespace.h>
32
#include <linux/refcount.h>
33
#include <linux/user_namespace.h>
Miklos Szeredi's avatar
Miklos Szeredi committed
34

35
36
37
38
39
/** Default max number of pages that can be used in a single read request */
#define FUSE_DEFAULT_MAX_PAGES_PER_REQ 32

/** Maximum of max_pages received in init_out */
#define FUSE_MAX_MAX_PAGES 256
40

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

44
45
46
/** It could be as large as PATH_MAX, but would that have any uses? */
#define FUSE_NAME_MAX 1024

47
/** Number of dentries for each connection in the control filesystem */
48
#define FUSE_CTL_NUM_DENTRIES 5
49
50
51
52
53
54

/** List of active connections */
extern struct list_head fuse_conn_list;

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

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

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

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

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

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

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

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

84
85
86
	/* Which attributes are invalid */
	u32 inval_mask;

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

91
92
93
	/** 64 bit inode number */
	u64 orig_ino;

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

97
98
99
	union {
		/* Write related fields (regular file only) */
		struct {
100
			/* Files usable in writepage.  Protected by fi->lock */
101
			struct list_head write_files;
Miklos Szeredi's avatar
Miklos Szeredi committed
102

103
104
			/* Writepages pending on truncate or fsync */
			struct list_head queued_writes;
Miklos Szeredi's avatar
Miklos Szeredi committed
105

106
107
108
			/* Number of sent writes, a negative bias
			 * (FUSE_NOWRITE) means more writes are blocked */
			int writectr;
Miklos Szeredi's avatar
Miklos Szeredi committed
109

110
111
			/* Waitq for writepage completion */
			wait_queue_head_t page_waitq;
Miklos Szeredi's avatar
Miklos Szeredi committed
112

113
114
115
			/* List of writepage requestst (pending or sent) */
			struct list_head writepages;
		};
116

117
118
119
120
		/* readdir cache (directory only) */
		struct {
			/* true if fully cached */
			bool cached;
Miklos Szeredi's avatar
Miklos Szeredi committed
121

122
123
			/* size of cache */
			loff_t size;
Miklos Szeredi's avatar
Miklos Szeredi committed
124

125
126
			/* position at end of cache (position of next entry) */
			loff_t pos;
Miklos Szeredi's avatar
Miklos Szeredi committed
127

128
129
			/* version of the cache */
			u64 version;
130

131
132
133
			/* modification time of directory when cache was
			 * started */
			struct timespec64 mtime;
134

135
136
			/* iversion of directory when cache was started */
			u64 iversion;
137

138
139
140
141
			/* protects above fields */
			spinlock_t lock;
		} rdc;
	};
Miklos Szeredi's avatar
Miklos Szeredi committed
142

143
144
	/** Miscellaneous bits describing inode state */
	unsigned long state;
145
146
147

	/** Lock for serializing lookup and readdir for back compatibility*/
	struct mutex mutex;
148
149
150

	/** Lock to protect write related fields */
	spinlock_t lock;
151
152
153
154
155
156
};

/** FUSE inode state bits */
enum {
	/** Advise readdirplus  */
	FUSE_I_ADVISE_RDPLUS,
157
158
	/** Initialized with readdirplus */
	FUSE_I_INIT_RDPLUS,
159
160
	/** An operation changing file size is in progress  */
	FUSE_I_SIZE_UNSTABLE,
Miklos Szeredi's avatar
Miklos Szeredi committed
161
162
};

163
struct fuse_conn;
164
struct fuse_release_args;
165

166
167
/** FUSE specific file data */
struct fuse_file {
168
169
170
	/** Fuse connection for this file */
	struct fuse_conn *fc;

171
172
	/* Argument space reserved for release */
	struct fuse_release_args *release_args;
173

Tejun Heo's avatar
Tejun Heo committed
174
175
176
	/** Kernel file handle guaranteed to be unique */
	u64 kh;

177
178
	/** File handle used by userspace */
	u64 fh;
179

180
181
182
	/** Node id of this file */
	u64 nodeid;

183
	/** Refcount */
184
	refcount_t count;
185

186
187
188
	/** FOPEN_* flags returned by open */
	u32 open_flags;

189
190
	/** Entry on inode's write_files list */
	struct list_head write_entry;
Tejun Heo's avatar
Tejun Heo committed
191

192
193
194
195
196
197
198
199
200
201
202
203
204
	/* 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;
205
206
207
208

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

209
210
	} readdir;

Tejun Heo's avatar
Tejun Heo committed
211
212
213
214
215
	/** 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
216
217
218

	/** Has flock been performed on this file? */
	bool flock:1;
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;
};

/** One output argument of a request */
struct fuse_arg {
	unsigned size;
	void *value;
};

233
234
235
236
237
238
/** FUSE page descriptor */
struct fuse_page_desc {
	unsigned int length;
	unsigned int offset;
};

239
struct fuse_args {
240
	uint64_t nodeid;
241
242
243
	uint32_t opcode;
	unsigned short in_numargs;
	unsigned short out_numargs;
244
	bool force:1;
245
	bool noreply:1;
246
	bool nocreds:1;
Miklos Szeredi's avatar
Miklos Szeredi committed
247
248
	bool in_pages:1;
	bool out_pages:1;
249
	bool out_argvar:1;
Miklos Szeredi's avatar
Miklos Szeredi committed
250
251
	bool page_zeroing:1;
	bool page_replace:1;
252
253
	struct fuse_in_arg in_args[3];
	struct fuse_arg out_args[2];
254
	void (*end)(struct fuse_conn *fc, struct fuse_args *args, int error);
255
256
};

Miklos Szeredi's avatar
Miklos Szeredi committed
257
258
259
260
261
262
263
struct fuse_args_pages {
	struct fuse_args args;
	struct page **pages;
	struct fuse_page_desc *descs;
	unsigned int num_pages;
};

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

Maxim Patlasov's avatar
Maxim Patlasov committed
266
267
/** The request IO state (for asynchronous processing) */
struct fuse_io_priv {
268
	struct kref refcnt;
Maxim Patlasov's avatar
Maxim Patlasov committed
269
270
271
272
273
274
275
	int async;
	spinlock_t lock;
	unsigned reqs;
	ssize_t bytes;
	size_t size;
	__u64 offset;
	bool write;
276
	bool should_dirty;
Maxim Patlasov's avatar
Maxim Patlasov committed
277
278
	int err;
	struct kiocb *iocb;
279
	struct completion *done;
280
	bool blocking;
Maxim Patlasov's avatar
Maxim Patlasov committed
281
282
};

283
#define FUSE_IO_PRIV_SYNC(i) \
284
{					\
285
	.refcnt = KREF_INIT(1),		\
286
	.async = 0,			\
287
	.iocb = i,			\
288
289
}

Miklos Szeredi's avatar
Miklos Szeredi committed
290
291
292
293
294
295
296
297
298
299
/**
 * 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
300
301
302
 * FR_PENDING:		request is not yet in userspace
 * FR_SENT:		request is in userspace, waiting for an answer
 * FR_FINISHED:		request is finished
303
 * FR_PRIVATE:		request is on private list
Miklos Szeredi's avatar
Miklos Szeredi committed
304
305
306
307
308
309
310
311
312
 */
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
313
314
315
	FR_PENDING,
	FR_SENT,
	FR_FINISHED,
316
	FR_PRIVATE,
Miklos Szeredi's avatar
Miklos Szeredi committed
317
318
};

319
320
/**
 * A request to the client
321
322
323
324
 *
 * .waitq.lock protects the following fields:
 *   - FR_ABORTED
 *   - FR_LOCKED (may also be modified under fc->lock, tested under both)
325
326
 */
struct fuse_req {
327
328
	/** This can be on either pending processing or io lists in
	    fuse_conn */
329
330
	struct list_head list;

331
332
333
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

334
335
336
	/* Input/output arguments */
	struct fuse_args *args;

337
	/** refcount */
338
	refcount_t count;
339

Miklos Szeredi's avatar
Miklos Szeredi committed
340
341
	/* Request flags, updated with test/set/clear_bit() */
	unsigned long flags;
342

343
344
345
346
	/* The request input header */
	struct {
		struct fuse_in_header h;
	} in;
347

348
349
350
351
	/* The request output header */
	struct {
		struct fuse_out_header h;
	} out;
352
353
354
355

	/** Used to wake up the task waiting for completion of request*/
	wait_queue_head_t waitq;

356
357
358
359
#if IS_ENABLED(CONFIG_VIRTIO_FS)
	/** virtio-fs's physically contiguous buffer for in and out args */
	void *argbuf;
#endif
360
361
};

362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
struct fuse_iqueue;

/**
 * Input queue callbacks
 *
 * Input queue signalling is device-specific.  For example, the /dev/fuse file
 * uses fiq->waitq and fasync to wake processes that are waiting on queue
 * readiness.  These callbacks allow other device types to respond to input
 * queue activity.
 */
struct fuse_iqueue_ops {
	/**
	 * Signal that a forget has been queued
	 */
	void (*wake_forget_and_unlock)(struct fuse_iqueue *fiq)
		__releases(fiq->lock);

	/**
	 * Signal that an INTERRUPT request has been queued
	 */
	void (*wake_interrupt_and_unlock)(struct fuse_iqueue *fiq)
		__releases(fiq->lock);

	/**
	 * Signal that a request has been queued
	 */
	void (*wake_pending_and_unlock)(struct fuse_iqueue *fiq)
		__releases(fiq->lock);
390
391
392
393
394

	/**
	 * Clean up when fuse_iqueue is destroyed
	 */
	void (*release)(struct fuse_iqueue *fiq);
395
396
397
398
399
};

/** /dev/fuse input queue operations */
extern const struct fuse_iqueue_ops fuse_dev_fiq_ops;

400
struct fuse_iqueue {
401
402
403
	/** Connection established */
	unsigned connected;

404
405
406
	/** Lock protecting accesses to members of this structure */
	spinlock_t lock;

407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
	/** 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;
428
429
430
431
432
433

	/** Device-specific callbacks */
	const struct fuse_iqueue_ops *ops;

	/** Device-specific state */
	void *priv;
434
435
};

436
437
438
#define FUSE_PQ_HASH_BITS 8
#define FUSE_PQ_HASH_SIZE (1 << FUSE_PQ_HASH_BITS)

439
struct fuse_pqueue {
440
441
442
	/** Connection established */
	unsigned connected;

Miklos Szeredi's avatar
Miklos Szeredi committed
443
444
445
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

446
447
	/** Hash table of requests being processed */
	struct list_head *processing;
448
449
450
451
452

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

453
454
455
456
457
458
459
/**
 * Fuse device instance
 */
struct fuse_dev {
	/** Fuse connection for this device */
	struct fuse_conn *fc;

460
461
462
	/** Processing queue */
	struct fuse_pqueue pq;

463
464
465
466
	/** list entry on fc->devices */
	struct list_head entry;
};

467
468
469
470
471
472
473
474
475
476
477
478
struct fuse_fs_context {
	int fd;
	unsigned int rootmode;
	kuid_t user_id;
	kgid_t group_id;
	bool is_bdev:1;
	bool fd_present:1;
	bool rootmode_present:1;
	bool user_id_present:1;
	bool group_id_present:1;
	bool default_permissions:1;
	bool allow_other:1;
479
	bool destroy:1;
480
481
	bool no_control:1;
	bool no_force_umount:1;
482
483
484
485
486
487
488
489
	unsigned int max_read;
	unsigned int blksize;
	const char *subtype;

	/* fuse_dev pointer to fill in, should contain NULL on entry */
	void **fudptr;
};

Miklos Szeredi's avatar
Miklos Szeredi committed
490
491
492
493
494
495
496
497
/**
 * 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 {
498
499
500
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

501
	/** Refcount */
502
	refcount_t count;
503

504
505
506
	/** Number of fuse_dev's */
	atomic_t dev_count;

Al Viro's avatar
Al Viro committed
507
508
	struct rcu_head rcu;

Miklos Szeredi's avatar
Miklos Szeredi committed
509
	/** The user id for this mount */
510
	kuid_t user_id;
Miklos Szeredi's avatar
Miklos Szeredi committed
511

512
	/** The group id for this mount */
513
	kgid_t group_id;
514

515
516
517
	/** The pid namespace for this mount */
	struct pid_namespace *pid_ns;

518
519
520
	/** The user namespace for this mount */
	struct user_namespace *user_ns;

521
522
523
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
524
525
526
	/** Maximum write size */
	unsigned max_write;

527
528
529
	/** Maxmum number of pages that can be used in a single request */
	unsigned int max_pages;

530
531
	/** Input queue */
	struct fuse_iqueue iq;
532

Tejun Heo's avatar
Tejun Heo committed
533
	/** The next unique kernel file handle */
534
	atomic64_t khctr;
Tejun Heo's avatar
Tejun Heo committed
535

Tejun Heo's avatar
Tejun Heo committed
536
537
538
	/** rbtree of fuse_files waiting for poll events indexed by ph */
	struct rb_root polled_files;

539
540
541
542
543
544
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

545
546
547
	/** Number of requests currently in the background */
	unsigned num_background;

548
549
550
551
552
553
	/** 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
554
555
556
557
	/** Protects: max_background, congestion_threshold, num_background,
	 * active_background, bg_queue, blocked */
	spinlock_t bg_lock;

558
559
560
561
	/** Flag indicating that INIT reply has been received. Allocating
	 * any fuse request will be suspended until the flag is set */
	int initialized;

562
563
564
565
566
567
568
	/** 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;
569

570
571
	/** Connection established, cleared on umount, connection
	    abort and device release */
572
	unsigned connected;
Miklos Szeredi's avatar
Miklos Szeredi committed
573

574
575
576
	/** Connection aborted via sysfs */
	bool aborted;

577
578
579
	/** 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
580
	unsigned conn_error:1;
581

582
	/** Connection successful.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
583
	unsigned conn_init:1;
584

585
	/** Do readpages asynchronously?  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
586
	unsigned async_read:1;
587

588
589
590
	/** Return an unique read error after abort.  Only set in INIT */
	unsigned abort_err:1;

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

594
	/** Filesystem supports NFS exporting.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
595
	unsigned export_support:1;
596

597
598
599
	/** write-back cache policy (default is write-through) */
	unsigned writeback_cache:1;

600
601
602
	/** allow parallel lookups and readdir (default is serialized) */
	unsigned parallel_dirops:1;

603
604
605
	/** handle fs handles killing suid/sgid/cap on write/chown/trunc */
	unsigned handle_killpriv:1;

606
607
608
	/** cache READLINK responses in page cache */
	unsigned cache_symlinks:1;

609
610
611
612
613
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

614
615
616
	/** Is open/release not implemented by fs? */
	unsigned no_open:1;

617
618
619
	/** Is opendir/releasedir not implemented by fs? */
	unsigned no_opendir:1;

620
	/** Is fsync not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
621
	unsigned no_fsync:1;
622

623
	/** Is fsyncdir not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
624
	unsigned no_fsyncdir:1;
625

626
	/** Is flush not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
627
	unsigned no_flush:1;
628

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

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

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

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

Miklos Szeredi's avatar
Miklos Szeredi committed
641
	/** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
642
	unsigned no_lock:1;
643

Miklos Szeredi's avatar
Miklos Szeredi committed
644
	/** Is access not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
645
	unsigned no_access:1;
Miklos Szeredi's avatar
Miklos Szeredi committed
646

647
	/** Is create not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
648
	unsigned no_create:1;
649

650
	/** Is interrupt not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
651
	unsigned no_interrupt:1;
652

653
	/** Is bmap not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
654
	unsigned no_bmap:1;
655

Tejun Heo's avatar
Tejun Heo committed
656
657
658
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

659
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
660
	unsigned big_writes:1;
661

662
663
664
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
665
666
667
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

668
669
670
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
671
672
673
	/** Is rename with flags implemented by fs? */
	unsigned no_rename2:1;

674
675
676
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

677
678
679
	/** Filesystem is fully reponsible for page cache invalidation. */
	unsigned explicit_inval_data:1;

680
	/** Does the filesystem support readdirplus? */
681
682
	unsigned do_readdirplus:1;

683
684
685
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

686
687
688
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

689
690
691
	/** Is lseek not implemented by fs? */
	unsigned no_lseek:1;

Seth Forshee's avatar
Seth Forshee committed
692
693
694
	/** Does the filesystem support posix acls? */
	unsigned posix_acl:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
695
696
697
698
699
700
	/** 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;

701
702
703
	/** Does the filesystem support copy_file_range? */
	unsigned no_copy_file_range:1;

704
705
706
	/* Send DESTROY request */
	unsigned int destroy:1;

707
708
709
	/* Delete dentries that have gone stale */
	unsigned int delete_stale:1;

710
711
712
713
714
715
	/** Do not create entry in fusectl fs */
	unsigned int no_control:1;

	/** Do not allow MNT_FORCE umount */
	unsigned int no_force_umount:1;

716
717
718
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

719
720
721
	/** Negotiated minor version */
	unsigned minor;

722
723
724
	/** Entry on the fuse_conn_list */
	struct list_head entry;

725
726
	/** Device ID from super block */
	dev_t dev;
727
728
729
730
731
732

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

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

734
735
	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
736

737
	/** Version counter for attribute changes */
738
	atomic64_t attr_version;
Tejun Heo's avatar
Tejun Heo committed
739
740
741

	/** Called on final put */
	void (*release)(struct fuse_conn *);
John Muir's avatar
John Muir committed
742
743
744
745
746
747

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

	/** Read/write semaphore to hold when accessing sb. */
	struct rw_semaphore killsb;
748
749
750

	/** List of device instances belonging to this connection */
	struct list_head devices;
Miklos Szeredi's avatar
Miklos Szeredi committed
751
752
753
754
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
755
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
}

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
773
774
775
776
777
static inline int invalid_nodeid(u64 nodeid)
{
	return !nodeid || nodeid == FUSE_ROOT_ID;
}

778
779
780
781
782
static inline u64 fuse_get_attr_version(struct fuse_conn *fc)
{
	return atomic64_read(&fc->attr_version);
}

783
/** Device operations */
784
extern const struct file_operations fuse_dev_operations;
785

Al Viro's avatar
Al Viro committed
786
extern const struct dentry_operations fuse_dentry_operations;
787
extern const struct dentry_operations fuse_root_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
788

John Muir's avatar
John Muir committed
789
790
791
792
793
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

794
795
796
/**
 * Get a filled in inode
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
797
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
798
799
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
800

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

804
805
806
/**
 * Send FORGET command
 */
807
808
809
810
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);
811

812
813
814
815
struct fuse_forget_link *fuse_dequeue_forget(struct fuse_iqueue *fiq,
					     unsigned int max,
					     unsigned int *countp);

816
/*
817
 * Initialize READ or READDIR request
818
 */
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
struct fuse_io_args {
	union {
		struct {
			struct fuse_read_in in;
			u64 attr_ver;
		} read;
		struct {
			struct fuse_write_in in;
			struct fuse_write_out out;
		} write;
	};
	struct fuse_args_pages ap;
	struct fuse_io_priv *io;
	struct fuse_file *ff;
};

void fuse_read_args_fill(struct fuse_io_args *ia, struct file *file, loff_t pos,
			 size_t count, int opcode);

838
839
840
841

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

Tejun Heo's avatar
Tejun Heo committed
844
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
845
void fuse_file_free(struct fuse_file *ff);
846
void fuse_finish_open(struct inode *inode, struct file *file);
847

848
void fuse_sync_release(struct fuse_inode *fi, struct fuse_file *ff, int flags);
849

850
851
852
/**
 * Send RELEASE or RELEASEDIR request
 */
853
void fuse_release_common(struct file *file, bool isdir);
854

855
856
857
/**
 * Send FSYNC or FSYNCDIR request
 */
858
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
Miklos Szeredi's avatar
Miklos Szeredi committed
859
		      int datasync, int opcode);
860

Tejun Heo's avatar
Tejun Heo committed
861
862
863
864
865
866
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

867
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
868
 * Initialize file operations on a regular file
869
870
871
 */
void fuse_init_file_inode(struct inode *inode);

872
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
873
 * Initialize inode operations on regular files and special files
874
875
876
877
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
878
 * Initialize inode and file operations on a directory
879
880
881
882
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
883
 * Initialize inode operations on a symlink
884
885
886
887
888
889
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
890
891
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
892

Miklos Szeredi's avatar
Miklos Szeredi committed
893
894
895
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

896
897
898
899
900
901
902
903
904
905
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

906
int fuse_ctl_init(void);
907
void __exit fuse_ctl_cleanup(void);
908

909
910
911
912
/**
 * Simple request sending that does request allocation and freeing
 */
ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);
913
914
int fuse_simple_background(struct fuse_conn *fc, struct fuse_args *args,
			   gfp_t gfp_flags);
915

916
917
918
919
920
/**
 * End a finished request
 */
void fuse_request_end(struct fuse_conn *fc, struct fuse_req *req);

921
/* Abort all requests */
Miklos Szeredi's avatar
Miklos Szeredi committed
922
void fuse_abort_conn(struct fuse_conn *fc);
923
void fuse_wait_aborted(struct fuse_conn *fc);
924

925
926
927
928
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
929

Miklos Szeredi's avatar
Miklos Szeredi committed
930
931
void fuse_invalidate_entry_cache(struct dentry *entry);

932
933
void fuse_invalidate_atime(struct inode *inode);

Miklos Szeredi's avatar
Miklos Szeredi committed
934
935
936
u64 entry_attr_timeout(struct fuse_entry_out *o);
void fuse_change_entry_timeout(struct dentry *entry, struct fuse_entry_out *o);

937
938
939
940
941
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

942
943
944
/**
 * Initialize fuse_conn
 */
945
946
void fuse_conn_init(struct fuse_conn *fc, struct user_namespace *user_ns,
		    const struct fuse_iqueue_ops *fiq_ops, void *fiq_priv);
947

948
949
950
951
952
/**
 * Release reference to fuse_conn
 */
void fuse_conn_put(struct fuse_conn *fc);

953
954
955
struct fuse_dev *fuse_dev_alloc_install(struct fuse_conn *fc);
struct fuse_dev *fuse_dev_alloc(void);
void fuse_dev_install(struct fuse_dev *fud, struct fuse_conn *fc);
956
void fuse_dev_free(struct fuse_dev *fud);
957
void fuse_send_init(struct fuse_conn *fc);
958

959
960
961
962
963
964
965
/**
 * Fill in superblock and initialize fuse connection
 * @sb: partially-initialized superblock to fill in
 * @ctx: mount context
 */
int fuse_fill_super_common(struct super_block *sb, struct fuse_fs_context *ctx);

966
967
968
969
970
971
972
/**
 * Disassociate fuse connection from superblock and kill the superblock
 *
 * Calls kill_anon_super(), do not use with bdev mounts.
 */
void fuse_kill_sb_anon(struct super_block *sb);

973
974
975
976
977
978
979
980
981
/**
 * 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);
982
983
984
985
986

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

/**
989
 * Is current process allowed to perform filesystem operation?
Miklos Szeredi's avatar
Miklos Szeredi committed
990
 */
991
int fuse_allow_current_process(struct fuse_conn *fc);
992
993

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

Seth Forshee's avatar
Seth Forshee committed
995
996
void fuse_update_ctime(struct inode *inode);

Miklos Szeredi's avatar
Miklos Szeredi committed
997
int fuse_update_attributes(struct inode *inode, struct file *file);
Miklos Szeredi's avatar
Miklos Szeredi committed
998
999
1000

void fuse_flush_writepages(struct inode *inode);