fuse_i.h 25 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
92
93
94
	union {
		/* Write related fields (regular file only) */
		struct {
			/* Files usable in writepage.  Protected by fc->lock */
			struct list_head write_files;
Miklos Szeredi's avatar
Miklos Szeredi committed
95

96
97
			/* Writepages pending on truncate or fsync */
			struct list_head queued_writes;
Miklos Szeredi's avatar
Miklos Szeredi committed
98

99
100
101
			/* Number of sent writes, a negative bias
			 * (FUSE_NOWRITE) means more writes are blocked */
			int writectr;
Miklos Szeredi's avatar
Miklos Szeredi committed
102

103
104
			/* Waitq for writepage completion */
			wait_queue_head_t page_waitq;
Miklos Szeredi's avatar
Miklos Szeredi committed
105

106
107
108
			/* List of writepage requestst (pending or sent) */
			struct list_head writepages;
		};
109

110
111
112
113
		/* readdir cache (directory only) */
		struct {
			/* true if fully cached */
			bool cached;
Miklos Szeredi's avatar
Miklos Szeredi committed
114

115
116
			/* size of cache */
			loff_t size;
Miklos Szeredi's avatar
Miklos Szeredi committed
117

118
119
			/* position at end of cache (position of next entry) */
			loff_t pos;
Miklos Szeredi's avatar
Miklos Szeredi committed
120

121
122
			/* version of the cache */
			u64 version;
123

124
125
126
			/* modification time of directory when cache was
			 * started */
			struct timespec64 mtime;
127

128
129
			/* iversion of directory when cache was started */
			u64 iversion;
130

131
132
133
134
			/* protects above fields */
			spinlock_t lock;
		} rdc;
	};
Miklos Szeredi's avatar
Miklos Szeredi committed
135

136
137
	/** Miscellaneous bits describing inode state */
	unsigned long state;
138
139
140

	/** Lock for serializing lookup and readdir for back compatibility*/
	struct mutex mutex;
141
142
143
144
145
146
};

/** FUSE inode state bits */
enum {
	/** Advise readdirplus  */
	FUSE_I_ADVISE_RDPLUS,
147
148
	/** Initialized with readdirplus */
	FUSE_I_INIT_RDPLUS,
149
150
	/** An operation changing file size is in progress  */
	FUSE_I_SIZE_UNSTABLE,
Miklos Szeredi's avatar
Miklos Szeredi committed
151
152
};

153
154
struct fuse_conn;

155
156
/** FUSE specific file data */
struct fuse_file {
157
158
159
	/** Fuse connection for this file */
	struct fuse_conn *fc;

160
	/** Request reserved for flush and release */
161
	struct fuse_req *reserved_req;
162

Tejun Heo's avatar
Tejun Heo committed
163
164
165
	/** Kernel file handle guaranteed to be unique */
	u64 kh;

166
167
	/** File handle used by userspace */
	u64 fh;
168

169
170
171
	/** Node id of this file */
	u64 nodeid;

172
	/** Refcount */
173
	refcount_t count;
174

175
176
177
	/** FOPEN_* flags returned by open */
	u32 open_flags;

178
179
	/** Entry on inode's write_files list */
	struct list_head write_entry;
Tejun Heo's avatar
Tejun Heo committed
180

181
182
183
184
185
186
187
188
189
190
191
192
193
	/* 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;
194
195
196
197

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

198
199
	} readdir;

Tejun Heo's avatar
Tejun Heo committed
200
201
202
203
204
	/** 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
205
206
207

	/** Has flock been performed on this file? */
	bool flock:1;
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
233
234
235
236
237
238
239
240
241
/** 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;

242
243
244
245
246
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

247
248
249
250
251
252
253
254
255
256
	/** 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;

257
258
259
	/** Pages may be replaced with new ones */
	unsigned page_replace:1;

260
261
262
263
	/** Number or arguments */
	unsigned numargs;

	/** Array of arguments */
Miklos Szeredi's avatar
Miklos Szeredi committed
264
	struct fuse_arg args[2];
265
266
};

267
268
269
270
271
272
/** FUSE page descriptor */
struct fuse_page_desc {
	unsigned int length;
	unsigned int offset;
};

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

309
#define FUSE_IO_PRIV_SYNC(i) \
310
{					\
311
	.refcnt = KREF_INIT(1),		\
312
	.async = 0,			\
313
	.iocb = i,			\
314
315
}

Miklos Szeredi's avatar
Miklos Szeredi committed
316
317
318
319
320
321
322
323
324
325
/**
 * 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
326
327
328
 * FR_PENDING:		request is not yet in userspace
 * FR_SENT:		request is in userspace, waiting for an answer
 * FR_FINISHED:		request is finished
329
 * FR_PRIVATE:		request is on private list
Miklos Szeredi's avatar
Miklos Szeredi committed
330
331
332
333
334
335
336
337
338
 */
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
339
340
341
	FR_PENDING,
	FR_SENT,
	FR_FINISHED,
342
	FR_PRIVATE,
Miklos Szeredi's avatar
Miklos Szeredi committed
343
344
};

345
346
/**
 * A request to the client
347
348
349
350
 *
 * .waitq.lock protects the following fields:
 *   - FR_ABORTED
 *   - FR_LOCKED (may also be modified under fc->lock, tested under both)
351
352
 */
struct fuse_req {
353
354
	/** This can be on either pending processing or io lists in
	    fuse_conn */
355
356
	struct list_head list;

357
358
359
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

360
	/** refcount */
361
	refcount_t count;
362

Miklos Szeredi's avatar
Miklos Szeredi committed
363
364
	/* Request flags, updated with test/set/clear_bit() */
	unsigned long flags;
365

366
367
368
369
370
371
372
373
374
375
376
	/** 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 {
377
		struct {
378
379
			struct fuse_release_in in;
			struct inode *inode;
380
		} release;
381
382
		struct fuse_init_in init_in;
		struct fuse_init_out init_out;
383
		struct cuse_init_in cuse_init_in;
384
385
386
387
		struct {
			struct fuse_read_in in;
			u64 attr_ver;
		} read;
388
389
390
		struct {
			struct fuse_write_in in;
			struct fuse_write_out out;
391
			struct fuse_req *next;
392
		} write;
Miklos Szeredi's avatar
Miklos Szeredi committed
393
		struct fuse_notify_retrieve_in retrieve_in;
394
395
396
	} misc;

	/** page vector */
397
398
	struct page **pages;

399
400
401
	/** page-descriptor vector */
	struct fuse_page_desc *page_descs;

402
403
404
405
406
	/** size of the 'pages' array */
	unsigned max_pages;

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

408
409
410
	/** inline page-descriptor vector */
	struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];

411
412
413
414
	/** number of pages in vector */
	unsigned num_pages;

	/** File used in the request (or NULL) */
415
	struct fuse_file *ff;
416

Miklos Szeredi's avatar
Miklos Szeredi committed
417
418
419
	/** Inode used in the request or NULL */
	struct inode *inode;

Maxim Patlasov's avatar
Maxim Patlasov committed
420
421
422
	/** AIO control block */
	struct fuse_io_priv *io;

Miklos Szeredi's avatar
Miklos Szeredi committed
423
424
425
	/** Link on fi->writepages */
	struct list_head writepages_entry;

426
427
	/** Request completion callback */
	void (*end)(struct fuse_conn *, struct fuse_req *);
428
429
430

	/** Request is stolen from fuse_file->reserved_req */
	struct file *stolen_file;
431
432
};

433
struct fuse_iqueue {
434
435
436
	/** Connection established */
	unsigned connected;

437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
	/** 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;
};

460
461
462
#define FUSE_PQ_HASH_BITS 8
#define FUSE_PQ_HASH_SIZE (1 << FUSE_PQ_HASH_BITS)

463
struct fuse_pqueue {
464
465
466
	/** Connection established */
	unsigned connected;

Miklos Szeredi's avatar
Miklos Szeredi committed
467
468
469
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

470
471
	/** Hash table of requests being processed */
	struct list_head *processing;
472
473
474
475
476

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

477
478
479
480
481
482
483
/**
 * Fuse device instance
 */
struct fuse_dev {
	/** Fuse connection for this device */
	struct fuse_conn *fc;

484
485
486
	/** Processing queue */
	struct fuse_pqueue pq;

487
488
489
490
	/** list entry on fc->devices */
	struct list_head entry;
};

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

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

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

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

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

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

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

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

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

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

528
529
	/** Input queue */
	struct fuse_iqueue iq;
530

Tejun Heo's avatar
Tejun Heo committed
531
532
533
	/** The next unique kernel file handle */
	u64 khctr;

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

537
538
539
540
541
542
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

543
544
545
	/** Number of requests currently in the background */
	unsigned num_background;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

618
	/** Is fsyncdir not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
619
	unsigned no_fsyncdir:1;
620

621
	/** Is flush not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
622
	unsigned no_flush:1;
623

624
	/** Is setxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
625
	unsigned no_setxattr:1;
626
627

	/** Is getxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
628
	unsigned no_getxattr:1;
629
630

	/** Is listxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
631
	unsigned no_listxattr:1;
632
633

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

Miklos Szeredi's avatar
Miklos Szeredi committed
636
	/** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
637
	unsigned no_lock:1;
638

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

642
	/** Is create not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
643
	unsigned no_create:1;
644

645
	/** Is interrupt not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
646
	unsigned no_interrupt:1;
647

648
	/** Is bmap not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
649
	unsigned no_bmap:1;
650

Tejun Heo's avatar
Tejun Heo committed
651
652
653
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

654
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
655
	unsigned big_writes:1;
656

657
658
659
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
660
661
662
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

663
664
665
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
666
667
668
	/** Is rename with flags implemented by fs? */
	unsigned no_rename2:1;

669
670
671
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

672
	/** Does the filesystem support readdirplus? */
673
674
	unsigned do_readdirplus:1;

675
676
677
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

678
679
680
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

681
682
683
	/** Is lseek not implemented by fs? */
	unsigned no_lseek:1;

Seth Forshee's avatar
Seth Forshee committed
684
685
686
	/** Does the filesystem support posix acls? */
	unsigned posix_acl:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
687
688
689
690
691
692
	/** 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;

693
694
695
	/** Does the filesystem support copy_file_range? */
	unsigned no_copy_file_range:1;

696
697
698
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

699
700
701
	/** Negotiated minor version */
	unsigned minor;

702
703
704
	/** Entry on the fuse_conn_list */
	struct list_head entry;

705
706
	/** Device ID from super block */
	dev_t dev;
707
708
709
710
711
712

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

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

714
715
	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
716
717
718

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
719
720
721

	/** Version counter for attribute changes */
	u64 attr_version;
Tejun Heo's avatar
Tejun Heo committed
722
723
724

	/** Called on final put */
	void (*release)(struct fuse_conn *);
John Muir's avatar
John Muir committed
725
726
727
728
729
730

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

	/** Read/write semaphore to hold when accessing sb. */
	struct rw_semaphore killsb;
731
732
733

	/** List of device instances belonging to this connection */
	struct list_head devices;
Miklos Szeredi's avatar
Miklos Szeredi committed
734
735
736
737
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
738
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
}

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
756
757
758
759
760
static inline int invalid_nodeid(u64 nodeid)
{
	return !nodeid || nodeid == FUSE_ROOT_ID;
}

761
/** Device operations */
762
extern const struct file_operations fuse_dev_operations;
763

Al Viro's avatar
Al Viro committed
764
extern const struct dentry_operations fuse_dentry_operations;
765
extern const struct dentry_operations fuse_root_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
766

John Muir's avatar
John Muir committed
767
768
769
770
771
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

772
773
774
/**
 * Get a filled in inode
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
775
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
776
777
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
778

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

782
783
784
/**
 * Send FORGET command
 */
785
786
787
788
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);
789

790
791
792
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

793
/**
794
 * Initialize READ or READDIR request
795
 */
796
void fuse_read_fill(struct fuse_req *req, struct file *file,
797
		    loff_t pos, size_t count, int opcode);
798
799
800
801

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

Tejun Heo's avatar
Tejun Heo committed
804
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
805
void fuse_file_free(struct fuse_file *ff);
806
void fuse_finish_open(struct inode *inode, struct file *file);
807

808
void fuse_sync_release(struct fuse_file *ff, int flags);
809

810
811
812
/**
 * Send RELEASE or RELEASEDIR request
 */
813
void fuse_release_common(struct file *file, int opcode);
814

815
816
817
/**
 * Send FSYNC or FSYNCDIR request
 */
818
819
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
820

Tejun Heo's avatar
Tejun Heo committed
821
822
823
824
825
826
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

827
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
828
 * Initialize file operations on a regular file
829
830
831
 */
void fuse_init_file_inode(struct inode *inode);

832
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
833
 * Initialize inode operations on regular files and special files
834
835
836
837
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
838
 * Initialize inode and file operations on a directory
839
840
841
842
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
843
 * Initialize inode operations on a symlink
844
845
846
847
848
849
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
850
851
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
852

Miklos Szeredi's avatar
Miklos Szeredi committed
853
854
855
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

856
857
858
859
860
861
862
863
864
865
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

866
int fuse_ctl_init(void);
867
void __exit fuse_ctl_cleanup(void);
868

869
870
871
/**
 * Allocate a request
 */
872
struct fuse_req *fuse_request_alloc(unsigned npages);
873

874
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
Miklos Szeredi's avatar
Miklos Szeredi committed
875

876
877
878
879
880
881
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
882
883
 * Get a request, may fail with -ENOMEM,
 * caller should specify # elements in req->pages[] explicitly
884
 */
885
struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
886
887
struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
					     unsigned npages);
888

889
890
891
892
893
/*
 * Increment reference count on request
 */
void __fuse_get_request(struct fuse_req *req);

894
895
896
/**
 * Gets a requests for a file operation, always succeeds
 */
897
898
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
899

900
/**
901
902
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
903
904
905
906
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
907
 * Send a request (synchronous)
908
 */
909
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
910

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

916
917
918
/**
 * Send a request in the background
 */
919
void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
920
bool fuse_request_queue_background(struct fuse_conn *fc, struct fuse_req *req);
Miklos Szeredi's avatar
Miklos Szeredi committed
921

922
/* Abort all requests */
923
void fuse_abort_conn(struct fuse_conn *fc, bool is_abort);
924
void fuse_wait_aborted(struct fuse_conn *fc);
925

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

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

933
934
void fuse_invalidate_atime(struct inode *inode);

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

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

943
944
945
/**
 * Initialize fuse_conn
 */
946
void fuse_conn_init(struct fuse_conn *fc, struct user_namespace *user_ns);
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(struct fuse_conn *fc);
void fuse_dev_free(struct fuse_dev *fud);

956
957
958
959
960
961
962
963
964
/**
 * 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);
965
966
967
968
969

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

/**
972
 * Is current process allowed to perform filesystem operation?
Miklos Szeredi's avatar
Miklos Szeredi committed
973
 */
974
int fuse_allow_current_process(struct fuse_conn *fc);
975
976

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

Seth Forshee's avatar
Seth Forshee committed
978
979
void fuse_update_ctime(struct inode *inode);

Miklos Szeredi's avatar
Miklos Szeredi committed
980
int fuse_update_attributes(struct inode *inode, struct file *file);
Miklos Szeredi's avatar
Miklos Szeredi committed
981
982
983
984
985

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
986
987

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

John Muir's avatar
John Muir committed
989
990
991
992
993
994
995
996
997
/**
 * 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.
998
999
1000
1001
1002
1003
 *
 * 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
1004
1005
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
1006
			     u64 child_nodeid, struct qstr *name);
John Muir's avatar
John Muir committed
1007

1008
1009
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020

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

1021
1022
ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
		       loff_t *ppos, int flags);
1023
1024
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
1025
1026
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
Al Viro's avatar
Al Viro committed
1027
__poll_t fuse_file_poll(struct file *file, poll_table *wait);
1028
1029
int fuse_dev_release(struct inode *inode, struct file *file);

1030
1031
bool fuse_write_update_size(struct inode *inode, loff_t pos);

1032
int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
Miklos Szeredi's avatar
Miklos Szeredi committed
1033
int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
Miklos Szeredi's avatar
Miklos Szeredi committed
1034

1035
int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
1036
1037
		    struct file *file);

1038
1039
void fuse_set_initialized(struct fuse_conn *fc);

1040
1041
void fuse_unlock_inode(struct inode *inode, bool locked);
bool fuse_lock_inode(struct inode *inode);
1042

Seth Forshee's avatar
Seth Forshee committed
1043
1044
1045
1046
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
1047
ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
Seth Forshee's avatar
Seth Forshee committed
1048
int fuse_removexattr(struct inode *inode, const char *name);
Seth Forshee's avatar
Seth Forshee committed
1049
extern const struct xattr_handler *fuse_xattr_handlers[];
Seth Forshee's avatar
Seth Forshee committed
1050
extern const struct xattr_handler *fuse_acl_xattr_handlers[];
1051
extern const struct xattr_handler *fuse_no_acl_xattr_handlers[];
Seth Forshee's avatar
Seth Forshee committed
1052
1053
1054
1055

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
1056

Miklos Szeredi's avatar
Miklos Szeredi committed
1057
1058
1059
1060

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

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