fuse_i.h 25.3 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
34
35
/** 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
36

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

40
41
42
/** It could be as large as PATH_MAX, but would that have any uses? */
#define FUSE_NAME_MAX 1024

43
/** Number of dentries for each connection in the control filesystem */
44
#define FUSE_CTL_NUM_DENTRIES 5
45

46
47
48
/** Number of page pointers embedded in fuse_req */
#define FUSE_REQ_INLINE_PAGES 1

49
50
51
52
53
/** 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
54

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

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

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

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

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

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

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

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

87
88
89
	/** 64 bit inode number */
	u64 orig_ino;

90
91
	/** Version of last attribute change */
	u64 attr_version;
92

93
94
95
96
97
	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
98

99
100
			/* Writepages pending on truncate or fsync */
			struct list_head queued_writes;
Miklos Szeredi's avatar
Miklos Szeredi committed
101

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

106
107
			/* Waitq for writepage completion */
			wait_queue_head_t page_waitq;
Miklos Szeredi's avatar
Miklos Szeredi committed
108

109
110
111
			/* List of writepage requestst (pending or sent) */
			struct list_head writepages;
		};
112

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

118
119
			/* size of cache */
			loff_t size;
Miklos Szeredi's avatar
Miklos Szeredi committed
120

121
122
			/* position at end of cache (position of next entry) */
			loff_t pos;
Miklos Szeredi's avatar
Miklos Szeredi committed
123

124
125
			/* version of the cache */
			u64 version;
126

127
128
129
			/* modification time of directory when cache was
			 * started */
			struct timespec64 mtime;
130

131
132
			/* iversion of directory when cache was started */
			u64 iversion;
133

134
135
136
137
			/* protects above fields */
			spinlock_t lock;
		} rdc;
	};
Miklos Szeredi's avatar
Miklos Szeredi committed
138

139
140
	/** Miscellaneous bits describing inode state */
	unsigned long state;
141
142
143

	/** Lock for serializing lookup and readdir for back compatibility*/
	struct mutex mutex;
144
145
146
147
148
149
};

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

156
157
struct fuse_conn;

158
159
/** FUSE specific file data */
struct fuse_file {
160
161
162
	/** Fuse connection for this file */
	struct fuse_conn *fc;

163
	/** Request reserved for flush and release */
164
	struct fuse_req *reserved_req;
165

Tejun Heo's avatar
Tejun Heo committed
166
167
168
	/** Kernel file handle guaranteed to be unique */
	u64 kh;

169
170
	/** File handle used by userspace */
	u64 fh;
171

172
173
174
	/** Node id of this file */
	u64 nodeid;

175
	/** Refcount */
176
	refcount_t count;
177

178
179
180
	/** FOPEN_* flags returned by open */
	u32 open_flags;

181
182
	/** Entry on inode's write_files list */
	struct list_head write_entry;
Tejun Heo's avatar
Tejun Heo committed
183

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

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

201
202
	} readdir;

Tejun Heo's avatar
Tejun Heo committed
203
204
205
206
207
	/** 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
208
209
210

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

245
246
247
248
249
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

250
251
252
253
254
255
256
257
258
259
	/** 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;

260
261
262
	/** Pages may be replaced with new ones */
	unsigned page_replace:1;

263
264
265
266
	/** Number or arguments */
	unsigned numargs;

	/** Array of arguments */
Miklos Szeredi's avatar
Miklos Szeredi committed
267
	struct fuse_arg args[2];
268
269
};

270
271
272
273
274
275
/** FUSE page descriptor */
struct fuse_page_desc {
	unsigned int length;
	unsigned int offset;
};

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

312
#define FUSE_IO_PRIV_SYNC(i) \
313
{					\
314
	.refcnt = KREF_INIT(1),		\
315
	.async = 0,			\
316
	.iocb = i,			\
317
318
}

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

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

360
361
362
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

363
	/** refcount */
364
	refcount_t count;
365

Miklos Szeredi's avatar
Miklos Szeredi committed
366
367
	/* Request flags, updated with test/set/clear_bit() */
	unsigned long flags;
368

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

	/** page vector */
400
401
	struct page **pages;

402
403
404
	/** page-descriptor vector */
	struct fuse_page_desc *page_descs;

405
406
407
408
409
	/** size of the 'pages' array */
	unsigned max_pages;

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

411
412
413
	/** inline page-descriptor vector */
	struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];

414
415
416
417
	/** number of pages in vector */
	unsigned num_pages;

	/** File used in the request (or NULL) */
418
	struct fuse_file *ff;
419

Miklos Szeredi's avatar
Miklos Szeredi committed
420
421
422
	/** Inode used in the request or NULL */
	struct inode *inode;

Maxim Patlasov's avatar
Maxim Patlasov committed
423
424
425
	/** AIO control block */
	struct fuse_io_priv *io;

Miklos Szeredi's avatar
Miklos Szeredi committed
426
427
428
	/** Link on fi->writepages */
	struct list_head writepages_entry;

429
430
	/** Request completion callback */
	void (*end)(struct fuse_conn *, struct fuse_req *);
431
432
433

	/** Request is stolen from fuse_file->reserved_req */
	struct file *stolen_file;
434
435
};

436
struct fuse_iqueue {
437
438
439
	/** Connection established */
	unsigned connected;

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

463
464
465
#define FUSE_PQ_HASH_BITS 8
#define FUSE_PQ_HASH_SIZE (1 << FUSE_PQ_HASH_BITS)

466
struct fuse_pqueue {
467
468
469
	/** Connection established */
	unsigned connected;

Miklos Szeredi's avatar
Miklos Szeredi committed
470
471
472
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

473
474
	/** Hash table of requests being processed */
	struct list_head *processing;
475
476
477
478
479

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

480
481
482
483
484
485
486
/**
 * Fuse device instance
 */
struct fuse_dev {
	/** Fuse connection for this device */
	struct fuse_conn *fc;

487
488
489
	/** Processing queue */
	struct fuse_pqueue pq;

490
491
492
493
	/** list entry on fc->devices */
	struct list_head entry;
};

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

505
	/** Refcount */
506
	refcount_t count;
507

508
509
510
	/** Number of fuse_dev's */
	atomic_t dev_count;

Al Viro's avatar
Al Viro committed
511
512
	struct rcu_head rcu;

Miklos Szeredi's avatar
Miklos Szeredi committed
513
	/** The user id for this mount */
514
	kuid_t user_id;
Miklos Szeredi's avatar
Miklos Szeredi committed
515

516
	/** The group id for this mount */
517
	kgid_t group_id;
518

519
520
521
	/** The pid namespace for this mount */
	struct pid_namespace *pid_ns;

522
523
524
	/** The user namespace for this mount */
	struct user_namespace *user_ns;

525
526
527
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
528
529
530
	/** Maximum write size */
	unsigned max_write;

531
532
533
	/** Maxmum number of pages that can be used in a single request */
	unsigned int max_pages;

534
535
	/** Input queue */
	struct fuse_iqueue iq;
536

Tejun Heo's avatar
Tejun Heo committed
537
538
539
	/** The next unique kernel file handle */
	u64 khctr;

Tejun Heo's avatar
Tejun Heo committed
540
541
542
	/** rbtree of fuse_files waiting for poll events indexed by ph */
	struct rb_root polled_files;

543
544
545
546
547
548
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

549
550
551
	/** Number of requests currently in the background */
	unsigned num_background;

552
553
554
555
556
557
	/** 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
558
559
560
561
	/** Protects: max_background, congestion_threshold, num_background,
	 * active_background, bg_queue, blocked */
	spinlock_t bg_lock;

562
563
564
565
	/** Flag indicating that INIT reply has been received. Allocating
	 * any fuse request will be suspended until the flag is set */
	int initialized;

566
567
568
569
570
571
572
	/** 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;
573
574
575

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

577
578
	/** Connection established, cleared on umount, connection
	    abort and device release */
579
	unsigned connected;
Miklos Szeredi's avatar
Miklos Szeredi committed
580

581
582
583
	/** Connection aborted via sysfs */
	bool aborted;

584
585
586
	/** 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
587
	unsigned conn_error:1;
588

589
	/** Connection successful.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
590
	unsigned conn_init:1;
591

592
	/** Do readpages asynchronously?  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
593
	unsigned async_read:1;
594

595
596
597
	/** Return an unique read error after abort.  Only set in INIT */
	unsigned abort_err:1;

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

601
	/** Filesystem supports NFS exporting.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
602
	unsigned export_support:1;
603

604
605
606
	/** write-back cache policy (default is write-through) */
	unsigned writeback_cache:1;

607
608
609
	/** allow parallel lookups and readdir (default is serialized) */
	unsigned parallel_dirops:1;

610
611
612
	/** handle fs handles killing suid/sgid/cap on write/chown/trunc */
	unsigned handle_killpriv:1;

613
614
615
616
617
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

618
619
620
	/** Is open/release not implemented by fs? */
	unsigned no_open:1;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

678
	/** Does the filesystem support readdirplus? */
679
680
	unsigned do_readdirplus:1;

681
682
683
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

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

687
688
689
	/** Is lseek not implemented by fs? */
	unsigned no_lseek:1;

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

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

699
700
701
	/** Does the filesystem support copy_file_range? */
	unsigned no_copy_file_range:1;

702
703
704
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

705
706
707
	/** Negotiated minor version */
	unsigned minor;

708
709
710
	/** Entry on the fuse_conn_list */
	struct list_head entry;

711
712
	/** Device ID from super block */
	dev_t dev;
713
714
715
716
717
718

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

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

720
721
	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
722
723
724

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
725
726
727

	/** Version counter for attribute changes */
	u64 attr_version;
Tejun Heo's avatar
Tejun Heo committed
728
729
730

	/** Called on final put */
	void (*release)(struct fuse_conn *);
John Muir's avatar
John Muir committed
731
732
733
734
735
736

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

	/** Read/write semaphore to hold when accessing sb. */
	struct rw_semaphore killsb;
737
738
739

	/** List of device instances belonging to this connection */
	struct list_head devices;
Miklos Szeredi's avatar
Miklos Szeredi committed
740
741
742
743
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
744
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
}

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
762
763
764
765
766
static inline int invalid_nodeid(u64 nodeid)
{
	return !nodeid || nodeid == FUSE_ROOT_ID;
}

767
/** Device operations */
768
extern const struct file_operations fuse_dev_operations;
769

Al Viro's avatar
Al Viro committed
770
extern const struct dentry_operations fuse_dentry_operations;
771
extern const struct dentry_operations fuse_root_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
772

John Muir's avatar
John Muir committed
773
774
775
776
777
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

778
779
780
/**
 * Get a filled in inode
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
781
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
782
783
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
784

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

788
789
790
/**
 * Send FORGET command
 */
791
792
793
794
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);
795

796
797
798
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

799
/**
800
 * Initialize READ or READDIR request
801
 */
802
void fuse_read_fill(struct fuse_req *req, struct file *file,
803
		    loff_t pos, size_t count, int opcode);
804
805
806
807

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

Tejun Heo's avatar
Tejun Heo committed
810
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
811
void fuse_file_free(struct fuse_file *ff);
812
void fuse_finish_open(struct inode *inode, struct file *file);
813

814
void fuse_sync_release(struct fuse_file *ff, int flags);
815

816
817
818
/**
 * Send RELEASE or RELEASEDIR request
 */
819
void fuse_release_common(struct file *file, int opcode);
820

821
822
823
/**
 * Send FSYNC or FSYNCDIR request
 */
824
825
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
826

Tejun Heo's avatar
Tejun Heo committed
827
828
829
830
831
832
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

833
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
834
 * Initialize file operations on a regular file
835
836
837
 */
void fuse_init_file_inode(struct inode *inode);

838
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
839
 * Initialize inode operations on regular files and special files
840
841
842
843
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
844
 * Initialize inode and file operations on a directory
845
846
847
848
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
849
 * Initialize inode operations on a symlink
850
851
852
853
854
855
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
856
857
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
858

Miklos Szeredi's avatar
Miklos Szeredi committed
859
860
861
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

862
863
864
865
866
867
868
869
870
871
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

872
int fuse_ctl_init(void);
873
void __exit fuse_ctl_cleanup(void);
874

875
876
877
/**
 * Allocate a request
 */
878
struct fuse_req *fuse_request_alloc(unsigned npages);
879

880
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
Miklos Szeredi's avatar
Miklos Szeredi committed
881

Miklos Szeredi's avatar
Miklos Szeredi committed
882
883
884
885
bool fuse_req_realloc_pages(struct fuse_conn *fc, struct fuse_req *req,
			    gfp_t flags);


886
887
888
889
890
891
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
892
893
 * Get a request, may fail with -ENOMEM,
 * caller should specify # elements in req->pages[] explicitly
894
 */
895
struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
896
897
struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
					     unsigned npages);
898

899
900
901
902
903
/*
 * Increment reference count on request
 */
void __fuse_get_request(struct fuse_req *req);

904
905
906
/**
 * Gets a requests for a file operation, always succeeds
 */
907
908
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
909

910
/**
911
912
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
913
914
915
916
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
917
 * Send a request (synchronous)
918
 */
919
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
920

921
922
923
924
925
/**
 * Simple request sending that does request allocation and freeing
 */
ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);

926
927
928
/**
 * Send a request in the background
 */
929
void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
930
bool fuse_request_queue_background(struct fuse_conn *fc, struct fuse_req *req);
Miklos Szeredi's avatar
Miklos Szeredi committed
931

932
/* Abort all requests */
933
void fuse_abort_conn(struct fuse_conn *fc, bool is_abort);
934
void fuse_wait_aborted(struct fuse_conn *fc);
935

936
937
938
939
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
940

Miklos Szeredi's avatar
Miklos Szeredi committed
941
942
void fuse_invalidate_entry_cache(struct dentry *entry);

943
944
void fuse_invalidate_atime(struct inode *inode);

Miklos Szeredi's avatar
Miklos Szeredi committed
945
946
947
u64 entry_attr_timeout(struct fuse_entry_out *o);
void fuse_change_entry_timeout(struct dentry *entry, struct fuse_entry_out *o);

948
949
950
951
952
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

953
954
955
/**
 * Initialize fuse_conn
 */
956
void fuse_conn_init(struct fuse_conn *fc, struct user_namespace *user_ns);
957

958
959
960
961
962
/**
 * Release reference to fuse_conn
 */
void fuse_conn_put(struct fuse_conn *fc);

963
964
965
struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
void fuse_dev_free(struct fuse_dev *fud);

966
967
968
969
970
971
972
973
974
/**
 * 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);
975
976
977
978
979

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

/**
982
 * Is current process allowed to perform filesystem operation?
Miklos Szeredi's avatar
Miklos Szeredi committed
983
 */
984
int fuse_allow_current_process(struct fuse_conn *fc);
985
986

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

Seth Forshee's avatar
Seth Forshee committed
988
989
void fuse_update_ctime(struct inode *inode);

Miklos Szeredi's avatar
Miklos Szeredi committed
990
int fuse_update_attributes(struct inode *inode, struct file *file);
Miklos Szeredi's avatar
Miklos Szeredi committed
991
992
993
994
995

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
996
997

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

John Muir's avatar
John Muir committed
999
1000
1001
1002
1003
1004
1005
1006
1007
/**
 * 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.
1008
1009
1010
1011
1012
1013
 *
 * 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
1014
1015
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
1016
			     u64 child_nodeid, struct qstr *name);
John Muir's avatar
John Muir committed
1017

1018
1019
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030

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

1031
1032
ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
		       loff_t *ppos, int flags);
1033
1034
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
1035
1036
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
Al Viro's avatar
Al Viro committed
1037
__poll_t fuse_file_poll(struct file *file, poll_table *wait);
1038
1039
int fuse_dev_release(struct inode *inode, struct file *file);

1040
1041
bool fuse_write_update_size(struct inode *inode, loff_t pos);

1042
int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
Miklos Szeredi's avatar
Miklos Szeredi committed
1043
int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
Miklos Szeredi's avatar
Miklos Szeredi committed
1044

1045
int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
1046
1047
		    struct file *file);

1048
1049
void fuse_set_initialized(struct fuse_conn *fc);

1050
1051
void fuse_unlock_inode(struct inode *inode, bool locked);
bool fuse_lock_inode(struct inode *inode);
1052

Seth Forshee's avatar
Seth Forshee committed
1053
1054
1055
1056
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
1057
ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
Seth Forshee's avatar
Seth Forshee committed
1058
int fuse_removexattr(struct inode *inode, const char *name);
Seth Forshee's avatar
Seth Forshee committed
1059
extern const struct xattr_handler *fuse_xattr_handlers[];
Seth Forshee's avatar
Seth Forshee committed
1060
extern const struct xattr_handler *fuse_acl_xattr_handlers[];
1061
extern const struct xattr_handler *fuse_no_acl_xattr_handlers[];
Seth Forshee's avatar
Seth Forshee committed
1062
1063
1064
1065

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
1066

Miklos Szeredi's avatar
Miklos Szeredi committed
1067
1068
1069
1070

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

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