fuse_i.h 24.1 KB
Newer Older
Miklos Szeredi's avatar
Miklos Szeredi committed
1
2
/*
  FUSE: Filesystem in Userspace
Miklos Szeredi's avatar
Miklos Szeredi committed
3
  Copyright (C) 2001-2008  Miklos Szeredi <miklos@szeredi.hu>
Miklos Szeredi's avatar
Miklos Szeredi committed
4
5
6
7
8

  This program can be distributed under the terms of the GNU GPL.
  See the file COPYING.
*/

Tejun Heo's avatar
Tejun Heo committed
9
10
11
#ifndef _FS_FUSE_I_H
#define _FS_FUSE_I_H

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

31
32
33
/** Max number of pages that can be used in a single read request */
#define FUSE_MAX_PAGES_PER_REQ 32

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

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

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

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

46
47
48
49
50
/** List of active connections */
extern struct list_head fuse_conn_list;

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

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

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

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

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

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

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

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

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

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

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

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

	/** Writepages pending on truncate or fsync */
	struct list_head queued_writes;

	/** Number of sent writes, a negative bias (FUSE_NOWRITE)
	 * means more writes are blocked */
	int writectr;

	/** Waitq for writepage completion */
	wait_queue_head_t page_waitq;

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

	/** Miscellaneous bits describing inode state */
	unsigned long state;
108
109
110

	/** Lock for serializing lookup and readdir for back compatibility*/
	struct mutex mutex;
111
112
113
114
115
116
};

/** FUSE inode state bits */
enum {
	/** Advise readdirplus  */
	FUSE_I_ADVISE_RDPLUS,
117
118
	/** Initialized with readdirplus */
	FUSE_I_INIT_RDPLUS,
119
120
	/** An operation changing file size is in progress  */
	FUSE_I_SIZE_UNSTABLE,
Miklos Szeredi's avatar
Miklos Szeredi committed
121
122
};

123
124
struct fuse_conn;

125
126
/** FUSE specific file data */
struct fuse_file {
127
128
129
	/** Fuse connection for this file */
	struct fuse_conn *fc;

130
	/** Request reserved for flush and release */
131
	struct fuse_req *reserved_req;
132

Tejun Heo's avatar
Tejun Heo committed
133
134
135
	/** Kernel file handle guaranteed to be unique */
	u64 kh;

136
137
	/** File handle used by userspace */
	u64 fh;
138

139
140
141
	/** Node id of this file */
	u64 nodeid;

142
	/** Refcount */
143
	refcount_t count;
144

145
146
147
	/** FOPEN_* flags returned by open */
	u32 open_flags;

148
149
	/** Entry on inode's write_files list */
	struct list_head write_entry;
Tejun Heo's avatar
Tejun Heo committed
150
151
152
153
154
155

	/** 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
156
157
158

	/** Has flock been performed on this file? */
	bool flock:1;
159
160
};

161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/** 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;

193
194
195
196
197
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

198
199
200
201
202
203
204
205
206
207
	/** 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;

208
209
210
	/** Pages may be replaced with new ones */
	unsigned page_replace:1;

211
212
213
214
	/** Number or arguments */
	unsigned numargs;

	/** Array of arguments */
Miklos Szeredi's avatar
Miklos Szeredi committed
215
	struct fuse_arg args[2];
216
217
};

218
219
220
221
222
223
/** FUSE page descriptor */
struct fuse_page_desc {
	unsigned int length;
	unsigned int offset;
};

224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
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
243
244
/** The request IO state (for asynchronous processing) */
struct fuse_io_priv {
245
	struct kref refcnt;
Maxim Patlasov's avatar
Maxim Patlasov committed
246
247
248
249
250
251
252
	int async;
	spinlock_t lock;
	unsigned reqs;
	ssize_t bytes;
	size_t size;
	__u64 offset;
	bool write;
253
	bool should_dirty;
Maxim Patlasov's avatar
Maxim Patlasov committed
254
255
	int err;
	struct kiocb *iocb;
256
	struct completion *done;
257
	bool blocking;
Maxim Patlasov's avatar
Maxim Patlasov committed
258
259
};

260
#define FUSE_IO_PRIV_SYNC(i) \
261
{					\
262
	.refcnt = KREF_INIT(1),		\
263
	.async = 0,			\
264
	.iocb = i,			\
265
266
}

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

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

308
309
310
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

311
	/** refcount */
312
	refcount_t count;
313

Miklos Szeredi's avatar
Miklos Szeredi committed
314
315
	/* Request flags, updated with test/set/clear_bit() */
	unsigned long flags;
316

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

	/** page vector */
348
349
	struct page **pages;

350
351
352
	/** page-descriptor vector */
	struct fuse_page_desc *page_descs;

353
354
355
356
357
	/** size of the 'pages' array */
	unsigned max_pages;

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

359
360
361
	/** inline page-descriptor vector */
	struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];

362
363
364
365
	/** number of pages in vector */
	unsigned num_pages;

	/** File used in the request (or NULL) */
366
	struct fuse_file *ff;
367

Miklos Szeredi's avatar
Miklos Szeredi committed
368
369
370
	/** Inode used in the request or NULL */
	struct inode *inode;

Maxim Patlasov's avatar
Maxim Patlasov committed
371
372
373
	/** AIO control block */
	struct fuse_io_priv *io;

Miklos Szeredi's avatar
Miklos Szeredi committed
374
375
376
	/** Link on fi->writepages */
	struct list_head writepages_entry;

377
378
	/** Request completion callback */
	void (*end)(struct fuse_conn *, struct fuse_req *);
379
380
381

	/** Request is stolen from fuse_file->reserved_req */
	struct file *stolen_file;
382
383
};

384
struct fuse_iqueue {
385
386
387
	/** Connection established */
	unsigned connected;

388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
	/** 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;
};

411
412
413
#define FUSE_PQ_HASH_BITS 8
#define FUSE_PQ_HASH_SIZE (1 << FUSE_PQ_HASH_BITS)

414
struct fuse_pqueue {
415
416
417
	/** Connection established */
	unsigned connected;

Miklos Szeredi's avatar
Miklos Szeredi committed
418
419
420
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

421
422
	/** Hash table of requests being processed */
	struct list_head *processing;
423
424
425
426
427

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

428
429
430
431
432
433
434
/**
 * Fuse device instance
 */
struct fuse_dev {
	/** Fuse connection for this device */
	struct fuse_conn *fc;

435
436
437
	/** Processing queue */
	struct fuse_pqueue pq;

438
439
440
441
	/** list entry on fc->devices */
	struct list_head entry;
};

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

453
	/** Refcount */
454
	refcount_t count;
455

456
457
458
	/** Number of fuse_dev's */
	atomic_t dev_count;

Al Viro's avatar
Al Viro committed
459
460
	struct rcu_head rcu;

Miklos Szeredi's avatar
Miklos Szeredi committed
461
	/** The user id for this mount */
462
	kuid_t user_id;
Miklos Szeredi's avatar
Miklos Szeredi committed
463

464
	/** The group id for this mount */
465
	kgid_t group_id;
466

467
468
469
	/** The pid namespace for this mount */
	struct pid_namespace *pid_ns;

470
471
472
	/** The user namespace for this mount */
	struct user_namespace *user_ns;

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

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

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

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

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

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

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

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

497
498
499
500
501
502
	/** 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
503
504
505
506
	/** Protects: max_background, congestion_threshold, num_background,
	 * active_background, bg_queue, blocked */
	spinlock_t bg_lock;

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

511
512
513
514
515
516
517
	/** 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;
518
519
520

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

522
523
	/** Connection established, cleared on umount, connection
	    abort and device release */
524
	unsigned connected;
Miklos Szeredi's avatar
Miklos Szeredi committed
525

526
527
528
	/** Connection aborted via sysfs */
	bool aborted;

529
530
531
	/** 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
532
	unsigned conn_error:1;
533

534
	/** Connection successful.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
535
	unsigned conn_init:1;
536

537
	/** Do readpages asynchronously?  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
538
	unsigned async_read:1;
539

540
541
542
	/** Return an unique read error after abort.  Only set in INIT */
	unsigned abort_err:1;

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

546
	/** Filesystem supports NFS exporting.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
547
	unsigned export_support:1;
548

549
550
551
	/** write-back cache policy (default is write-through) */
	unsigned writeback_cache:1;

552
553
554
	/** allow parallel lookups and readdir (default is serialized) */
	unsigned parallel_dirops:1;

555
556
557
	/** handle fs handles killing suid/sgid/cap on write/chown/trunc */
	unsigned handle_killpriv:1;

558
559
560
561
562
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

563
564
565
	/** Is open/release not implemented by fs? */
	unsigned no_open:1;

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

569
	/** Is fsyncdir not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
570
	unsigned no_fsyncdir:1;
571

572
	/** Is flush not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
573
	unsigned no_flush:1;
574

575
	/** Is setxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
576
	unsigned no_setxattr:1;
577
578

	/** Is getxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
579
	unsigned no_getxattr:1;
580
581

	/** Is listxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
582
	unsigned no_listxattr:1;
583
584

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

Miklos Szeredi's avatar
Miklos Szeredi committed
587
	/** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
588
	unsigned no_lock:1;
589

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

593
	/** Is create not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
594
	unsigned no_create:1;
595

596
	/** Is interrupt not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
597
	unsigned no_interrupt:1;
598

599
	/** Is bmap not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
600
	unsigned no_bmap:1;
601

Tejun Heo's avatar
Tejun Heo committed
602
603
604
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

605
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
606
	unsigned big_writes:1;
607

608
609
610
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
611
612
613
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

614
615
616
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
617
618
619
	/** Is rename with flags implemented by fs? */
	unsigned no_rename2:1;

620
621
622
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

623
	/** Does the filesystem support readdirplus? */
624
625
	unsigned do_readdirplus:1;

626
627
628
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

629
630
631
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

632
633
634
	/** Is lseek not implemented by fs? */
	unsigned no_lseek:1;

Seth Forshee's avatar
Seth Forshee committed
635
636
637
	/** Does the filesystem support posix acls? */
	unsigned posix_acl:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
638
639
640
641
642
643
	/** 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;

644
645
646
	/** Does the filesystem support copy_file_range? */
	unsigned no_copy_file_range:1;

647
648
649
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

650
651
652
	/** Negotiated minor version */
	unsigned minor;

653
654
655
	/** Entry on the fuse_conn_list */
	struct list_head entry;

656
657
	/** Device ID from super block */
	dev_t dev;
658
659
660
661
662
663

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

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

665
666
	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
667
668
669

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
670
671
672

	/** Version counter for attribute changes */
	u64 attr_version;
Tejun Heo's avatar
Tejun Heo committed
673
674
675

	/** Called on final put */
	void (*release)(struct fuse_conn *);
John Muir's avatar
John Muir committed
676
677
678
679
680
681

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

	/** Read/write semaphore to hold when accessing sb. */
	struct rw_semaphore killsb;
682
683
684

	/** List of device instances belonging to this connection */
	struct list_head devices;
Miklos Szeredi's avatar
Miklos Szeredi committed
685
686
687
688
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
689
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
}

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
707
708
709
710
711
static inline int invalid_nodeid(u64 nodeid)
{
	return !nodeid || nodeid == FUSE_ROOT_ID;
}

712
/** Device operations */
713
extern const struct file_operations fuse_dev_operations;
714

Al Viro's avatar
Al Viro committed
715
extern const struct dentry_operations fuse_dentry_operations;
716
extern const struct dentry_operations fuse_root_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
717

John Muir's avatar
John Muir committed
718
719
720
721
722
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

723
724
725
/**
 * Get a filled in inode
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
726
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
727
728
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
729

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

733
734
735
/**
 * Send FORGET command
 */
736
737
738
739
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);
740

741
742
743
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

744
/**
745
 * Initialize READ or READDIR request
746
 */
747
void fuse_read_fill(struct fuse_req *req, struct file *file,
748
		    loff_t pos, size_t count, int opcode);
749
750
751
752

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

Tejun Heo's avatar
Tejun Heo committed
755
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
756
void fuse_file_free(struct fuse_file *ff);
757
void fuse_finish_open(struct inode *inode, struct file *file);
758

759
void fuse_sync_release(struct fuse_file *ff, int flags);
760

761
762
763
/**
 * Send RELEASE or RELEASEDIR request
 */
764
void fuse_release_common(struct file *file, int opcode);
765

766
767
768
/**
 * Send FSYNC or FSYNCDIR request
 */
769
770
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
771

Tejun Heo's avatar
Tejun Heo committed
772
773
774
775
776
777
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

778
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
779
 * Initialize file operations on a regular file
780
781
782
 */
void fuse_init_file_inode(struct inode *inode);

783
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
784
 * Initialize inode operations on regular files and special files
785
786
787
788
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
789
 * Initialize inode and file operations on a directory
790
791
792
793
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
794
 * Initialize inode operations on a symlink
795
796
797
798
799
800
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
801
802
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
803

Miklos Szeredi's avatar
Miklos Szeredi committed
804
805
806
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

807
808
809
810
811
812
813
814
815
816
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

817
int fuse_ctl_init(void);
818
void __exit fuse_ctl_cleanup(void);
819

820
821
822
/**
 * Allocate a request
 */
823
struct fuse_req *fuse_request_alloc(unsigned npages);
824

825
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
Miklos Szeredi's avatar
Miklos Szeredi committed
826

827
828
829
830
831
832
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
833
834
 * Get a request, may fail with -ENOMEM,
 * caller should specify # elements in req->pages[] explicitly
835
 */
836
struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
837
838
struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
					     unsigned npages);
839

840
841
842
843
844
/*
 * Increment reference count on request
 */
void __fuse_get_request(struct fuse_req *req);

845
846
847
/**
 * Gets a requests for a file operation, always succeeds
 */
848
849
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
850

851
/**
852
853
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
854
855
856
857
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
858
 * Send a request (synchronous)
859
 */
860
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
861

862
863
864
865
866
/**
 * Simple request sending that does request allocation and freeing
 */
ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);

867
868
869
/**
 * Send a request in the background
 */
870
void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
871
bool fuse_request_queue_background(struct fuse_conn *fc, struct fuse_req *req);
Miklos Szeredi's avatar
Miklos Szeredi committed
872

873
/* Abort all requests */
874
void fuse_abort_conn(struct fuse_conn *fc, bool is_abort);
875
void fuse_wait_aborted(struct fuse_conn *fc);
876

877
878
879
880
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
881

Miklos Szeredi's avatar
Miklos Szeredi committed
882
883
void fuse_invalidate_entry_cache(struct dentry *entry);

884
885
void fuse_invalidate_atime(struct inode *inode);

Miklos Szeredi's avatar
Miklos Szeredi committed
886
887
888
u64 entry_attr_timeout(struct fuse_entry_out *o);
void fuse_change_entry_timeout(struct dentry *entry, struct fuse_entry_out *o);

889
890
891
892
893
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

894
895
896
/**
 * Initialize fuse_conn
 */
897
void fuse_conn_init(struct fuse_conn *fc, struct user_namespace *user_ns);
898

899
900
901
902
903
/**
 * Release reference to fuse_conn
 */
void fuse_conn_put(struct fuse_conn *fc);

904
905
906
struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
void fuse_dev_free(struct fuse_dev *fud);

907
908
909
910
911
912
913
914
915
/**
 * 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);
916
917
918
919
920

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

/**
923
 * Is current process allowed to perform filesystem operation?
Miklos Szeredi's avatar
Miklos Szeredi committed
924
 */
925
int fuse_allow_current_process(struct fuse_conn *fc);
926
927

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

Seth Forshee's avatar
Seth Forshee committed
929
930
void fuse_update_ctime(struct inode *inode);

Miklos Szeredi's avatar
Miklos Szeredi committed
931
int fuse_update_attributes(struct inode *inode, struct file *file);
Miklos Szeredi's avatar
Miklos Szeredi committed
932
933
934
935
936

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
937
938

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

John Muir's avatar
John Muir committed
940
941
942
943
944
945
946
947
948
/**
 * 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.
949
950
951
952
953
954
 *
 * 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
955
956
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
957
			     u64 child_nodeid, struct qstr *name);
John Muir's avatar
John Muir committed
958

959
960
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
961
962
963
964
965
966
967
968
969
970
971

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

972
973
ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
		       loff_t *ppos, int flags);
974
975
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
976
977
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
Al Viro's avatar
Al Viro committed
978
__poll_t fuse_file_poll(struct file *file, poll_table *wait);
979
980
int fuse_dev_release(struct inode *inode, struct file *file);

981
982
bool fuse_write_update_size(struct inode *inode, loff_t pos);

983
int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
Miklos Szeredi's avatar
Miklos Szeredi committed
984
int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
Miklos Szeredi's avatar
Miklos Szeredi committed
985

986
int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
987
988
		    struct file *file);

989
990
void fuse_set_initialized(struct fuse_conn *fc);

991
992
void fuse_unlock_inode(struct inode *inode, bool locked);
bool fuse_lock_inode(struct inode *inode);
993

Seth Forshee's avatar
Seth Forshee committed
994
995
996
997
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
998
ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
Seth Forshee's avatar
Seth Forshee committed
999
int fuse_removexattr(struct inode *inode, const char *name);
Seth Forshee's avatar
Seth Forshee committed
1000
extern const struct xattr_handler *fuse_xattr_handlers[];
Seth Forshee's avatar
Seth Forshee committed
1001
extern const struct xattr_handler *fuse_acl_xattr_handlers[];
1002
extern const struct xattr_handler *fuse_no_acl_xattr_handlers[];
Seth Forshee's avatar
Seth Forshee committed
1003
1004
1005
1006

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
1007

Miklos Szeredi's avatar
Miklos Szeredi committed
1008
1009
1010
1011

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

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