fuse_i.h 23.2 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>
Miklos Szeredi's avatar
Miklos Szeredi committed
27

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

34
35
36
/** It could be as large as PATH_MAX, but would that have any uses? */
#define FUSE_NAME_MAX 1024

37
/** Number of dentries for each connection in the control filesystem */
38
#define FUSE_CTL_NUM_DENTRIES 5
39

40
41
42
/** Number of page pointers embedded in fuse_req */
#define FUSE_REQ_INLINE_PAGES 1

43
44
45
46
47
/** 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
48

49
50
51
52
/** Module parameters */
extern unsigned max_user_bgreq;
extern unsigned max_user_congthresh;

53
54
/* One forget request */
struct fuse_forget_link {
55
	struct fuse_forget_one forget_one;
56
57
58
	struct fuse_forget_link *next;
};

Miklos Szeredi's avatar
Miklos Szeredi committed
59
60
61
62
63
64
65
66
67
/** FUSE inode */
struct fuse_inode {
	/** Inode data */
	struct inode inode;

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

68
69
70
	/** Number of lookups on this inode */
	u64 nlookup;

71
	/** The request used for sending the FORGET message */
72
	struct fuse_forget_link *forget;
73

Miklos Szeredi's avatar
Miklos Szeredi committed
74
	/** Time in jiffies until the file attributes are valid */
Miklos Szeredi's avatar
Miklos Szeredi committed
75
	u64 i_time;
76
77
78

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

81
82
83
	/** 64 bit inode number */
	u64 orig_ino;

84
85
	/** Version of last attribute change */
	u64 attr_version;
86
87
88

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

	/** 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;
102
103
104

	/** Miscellaneous bits describing inode state */
	unsigned long state;
105
106
107

	/** Lock for serializing lookup and readdir for back compatibility*/
	struct mutex mutex;
108
109
110
111
112
113
};

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

120
121
struct fuse_conn;

122
123
/** FUSE specific file data */
struct fuse_file {
124
125
126
	/** Fuse connection for this file */
	struct fuse_conn *fc;

127
	/** Request reserved for flush and release */
128
	struct fuse_req *reserved_req;
129

Tejun Heo's avatar
Tejun Heo committed
130
131
132
	/** Kernel file handle guaranteed to be unique */
	u64 kh;

133
134
	/** File handle used by userspace */
	u64 fh;
135

136
137
138
	/** Node id of this file */
	u64 nodeid;

139
140
	/** Refcount */
	atomic_t count;
141

142
143
144
	/** FOPEN_* flags returned by open */
	u32 open_flags;

145
146
	/** Entry on inode's write_files list */
	struct list_head write_entry;
Tejun Heo's avatar
Tejun Heo committed
147
148
149
150
151
152

	/** 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
153
154
155

	/** Has flock been performed on this file? */
	bool flock:1;
156
157
};

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

190
191
192
193
194
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

195
196
197
198
199
200
201
202
203
204
	/** 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;

205
206
207
	/** Pages may be replaced with new ones */
	unsigned page_replace:1;

208
209
210
211
	/** Number or arguments */
	unsigned numargs;

	/** Array of arguments */
Miklos Szeredi's avatar
Miklos Szeredi committed
212
	struct fuse_arg args[2];
213
214
};

215
216
217
218
219
220
/** FUSE page descriptor */
struct fuse_page_desc {
	unsigned int length;
	unsigned int offset;
};

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

257
258
259
260
261
262
263
#define FUSE_IO_PRIV_SYNC(f) \
{					\
	.refcnt = { ATOMIC_INIT(1) },	\
	.async = 0,			\
	.file = f,			\
}

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

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

305
306
307
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

308
309
310
	/** refcount */
	atomic_t count;

311
312
313
	/** Unique ID for the interrupt request */
	u64 intr_unique;

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
struct fuse_pqueue {
412
413
414
	/** Connection established */
	unsigned connected;

Miklos Szeredi's avatar
Miklos Szeredi committed
415
416
417
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

418
419
420
421
422
423
424
	/** The list of requests being processed */
	struct list_head processing;

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

425
426
427
428
429
430
431
/**
 * Fuse device instance
 */
struct fuse_dev {
	/** Fuse connection for this device */
	struct fuse_conn *fc;

432
433
434
	/** Processing queue */
	struct fuse_pqueue pq;

435
436
437
438
	/** list entry on fc->devices */
	struct list_head entry;
};

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

450
451
452
	/** Refcount */
	atomic_t count;

453
454
455
	/** Number of fuse_dev's */
	atomic_t dev_count;

Al Viro's avatar
Al Viro committed
456
457
	struct rcu_head rcu;

Miklos Szeredi's avatar
Miklos Szeredi committed
458
	/** The user id for this mount */
459
	kuid_t user_id;
Miklos Szeredi's avatar
Miklos Szeredi committed
460

461
	/** The group id for this mount */
462
	kgid_t group_id;
463

464
465
466
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
467
468
469
	/** Maximum write size */
	unsigned max_write;

470
471
	/** Input queue */
	struct fuse_iqueue iq;
472

Tejun Heo's avatar
Tejun Heo committed
473
474
475
	/** The next unique kernel file handle */
	u64 khctr;

Tejun Heo's avatar
Tejun Heo committed
476
477
478
	/** rbtree of fuse_files waiting for poll events indexed by ph */
	struct rb_root polled_files;

479
480
481
482
483
484
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

485
486
487
	/** Number of requests currently in the background */
	unsigned num_background;

488
489
490
491
492
493
	/** 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;

494
495
496
497
	/** Flag indicating that INIT reply has been received. Allocating
	 * any fuse request will be suspended until the flag is set */
	int initialized;

498
499
500
501
502
503
504
	/** 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;
505
506
507

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

509
510
	/** Connection established, cleared on umount, connection
	    abort and device release */
511
	unsigned connected;
Miklos Szeredi's avatar
Miklos Szeredi committed
512

513
514
515
	/** 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
516
	unsigned conn_error:1;
517

518
	/** Connection successful.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
519
	unsigned conn_init:1;
520

521
	/** Do readpages asynchronously?  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
522
	unsigned async_read:1;
523

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

527
	/** Filesystem supports NFS exporting.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
528
	unsigned export_support:1;
529

530
531
532
	/** Set if bdi is valid */
	unsigned bdi_initialized:1;

533
534
535
	/** write-back cache policy (default is write-through) */
	unsigned writeback_cache:1;

536
537
538
	/** allow parallel lookups and readdir (default is serialized) */
	unsigned parallel_dirops:1;

539
540
541
	/** handle fs handles killing suid/sgid/cap on write/chown/trunc */
	unsigned handle_killpriv:1;

542
543
544
545
546
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

547
548
549
	/** Is open/release not implemented by fs? */
	unsigned no_open:1;

550
	/** Is fsync not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
551
	unsigned no_fsync:1;
552

553
	/** Is fsyncdir not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
554
	unsigned no_fsyncdir:1;
555

556
	/** Is flush not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
557
	unsigned no_flush:1;
558

559
	/** Is setxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
560
	unsigned no_setxattr:1;
561
562

	/** Is getxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
563
	unsigned no_getxattr:1;
564
565

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

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

Miklos Szeredi's avatar
Miklos Szeredi committed
571
	/** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
572
	unsigned no_lock:1;
573

Miklos Szeredi's avatar
Miklos Szeredi committed
574
	/** Is access not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
575
	unsigned no_access:1;
Miklos Szeredi's avatar
Miklos Szeredi committed
576

577
	/** Is create not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
578
	unsigned no_create:1;
579

580
	/** Is interrupt not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
581
	unsigned no_interrupt:1;
582

583
	/** Is bmap not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
584
	unsigned no_bmap:1;
585

Tejun Heo's avatar
Tejun Heo committed
586
587
588
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

589
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
590
	unsigned big_writes:1;
591

592
593
594
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
595
596
597
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

598
599
600
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
601
602
603
	/** Is rename with flags implemented by fs? */
	unsigned no_rename2:1;

604
605
606
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

607
	/** Does the filesystem support readdirplus? */
608
609
	unsigned do_readdirplus:1;

610
611
612
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

613
614
615
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

616
617
618
	/** Is lseek not implemented by fs? */
	unsigned no_lseek:1;

Seth Forshee's avatar
Seth Forshee committed
619
620
621
	/** Does the filesystem support posix acls? */
	unsigned posix_acl:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
622
623
624
625
626
627
	/** 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;

628
629
630
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

631
632
633
	/** Negotiated minor version */
	unsigned minor;

Miklos Szeredi's avatar
Miklos Szeredi committed
634
635
	/** Backing dev info */
	struct backing_dev_info bdi;
636

637
638
639
	/** Entry on the fuse_conn_list */
	struct list_head entry;

640
641
	/** Device ID from super block */
	dev_t dev;
642
643
644
645
646
647

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

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

649
650
	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
651
652
653

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
654
655
656

	/** Version counter for attribute changes */
	u64 attr_version;
Tejun Heo's avatar
Tejun Heo committed
657
658
659

	/** Called on final put */
	void (*release)(struct fuse_conn *);
John Muir's avatar
John Muir committed
660
661
662
663
664
665

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

	/** Read/write semaphore to hold when accessing sb. */
	struct rw_semaphore killsb;
666
667
668

	/** List of device instances belonging to this connection */
	struct list_head devices;
Miklos Szeredi's avatar
Miklos Szeredi committed
669
670
671
672
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
673
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
}

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

691
/** Device operations */
692
extern const struct file_operations fuse_dev_operations;
693

Al Viro's avatar
Al Viro committed
694
extern const struct dentry_operations fuse_dentry_operations;
695
extern const struct dentry_operations fuse_root_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
696

John Muir's avatar
John Muir committed
697
698
699
700
701
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

702
703
704
/**
 * Get a filled in inode
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
705
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
706
707
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
708

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

712
713
714
/**
 * Send FORGET command
 */
715
716
717
718
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);
719

720
721
722
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

723
/**
724
 * Initialize READ or READDIR request
725
 */
726
void fuse_read_fill(struct fuse_req *req, struct file *file,
727
		    loff_t pos, size_t count, int opcode);
728
729
730
731

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

Tejun Heo's avatar
Tejun Heo committed
734
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
735
void fuse_file_free(struct fuse_file *ff);
736
void fuse_finish_open(struct inode *inode, struct file *file);
737

738
void fuse_sync_release(struct fuse_file *ff, int flags);
739

740
741
742
/**
 * Send RELEASE or RELEASEDIR request
 */
743
void fuse_release_common(struct file *file, int opcode);
744

745
746
747
/**
 * Send FSYNC or FSYNCDIR request
 */
748
749
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
750

Tejun Heo's avatar
Tejun Heo committed
751
752
753
754
755
756
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

757
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
758
 * Initialize file operations on a regular file
759
760
761
 */
void fuse_init_file_inode(struct inode *inode);

762
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
763
 * Initialize inode operations on regular files and special files
764
765
766
767
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
768
 * Initialize inode and file operations on a directory
769
770
771
772
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
773
 * Initialize inode operations on a symlink
774
775
776
777
778
779
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
780
781
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
782

Miklos Szeredi's avatar
Miklos Szeredi committed
783
784
785
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

786
787
788
789
790
791
792
793
794
795
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

796
int fuse_ctl_init(void);
797
void __exit fuse_ctl_cleanup(void);
798

799
800
801
/**
 * Allocate a request
 */
802
struct fuse_req *fuse_request_alloc(unsigned npages);
803

804
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
Miklos Szeredi's avatar
Miklos Szeredi committed
805

806
807
808
809
810
811
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
812
813
 * Get a request, may fail with -ENOMEM,
 * caller should specify # elements in req->pages[] explicitly
814
 */
815
struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
816
817
struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
					     unsigned npages);
818

819
820
821
822
823
/*
 * Increment reference count on request
 */
void __fuse_get_request(struct fuse_req *req);

824
825
826
/**
 * Gets a requests for a file operation, always succeeds
 */
827
828
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
829

830
/**
831
832
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
833
834
835
836
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
837
 * Send a request (synchronous)
838
 */
839
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
840

841
842
843
844
845
/**
 * Simple request sending that does request allocation and freeing
 */
ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);

846
847
848
/**
 * Send a request in the background
 */
849
void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
850

851
852
void fuse_request_send_background_locked(struct fuse_conn *fc,
					 struct fuse_req *req);
Miklos Szeredi's avatar
Miklos Szeredi committed
853

854
/* Abort all requests */
855
856
void fuse_abort_conn(struct fuse_conn *fc);

857
858
859
860
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
861

Miklos Szeredi's avatar
Miklos Szeredi committed
862
863
void fuse_invalidate_entry_cache(struct dentry *entry);

864
865
void fuse_invalidate_atime(struct inode *inode);

866
867
868
869
870
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

871
872
873
/**
 * Initialize fuse_conn
 */
874
void fuse_conn_init(struct fuse_conn *fc);
875

876
877
878
879
880
/**
 * Release reference to fuse_conn
 */
void fuse_conn_put(struct fuse_conn *fc);

881
882
883
struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
void fuse_dev_free(struct fuse_dev *fud);

884
885
886
887
888
889
890
891
892
/**
 * 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);
893
894
895
896
897

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

/**
900
 * Is current process allowed to perform filesystem operation?
Miklos Szeredi's avatar
Miklos Szeredi committed
901
 */
902
int fuse_allow_current_process(struct fuse_conn *fc);
903
904

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

Seth Forshee's avatar
Seth Forshee committed
906
907
void fuse_update_ctime(struct inode *inode);

Miklos Szeredi's avatar
Miklos Szeredi committed
908
909
int fuse_update_attributes(struct inode *inode, struct kstat *stat,
			   struct file *file, bool *refreshed);
Miklos Szeredi's avatar
Miklos Szeredi committed
910
911
912
913
914

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
915
916

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

John Muir's avatar
John Muir committed
918
919
920
921
922
923
924
925
926
/**
 * 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.
927
928
929
930
931
932
 *
 * 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
933
934
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
935
			     u64 child_nodeid, struct qstr *name);
John Muir's avatar
John Muir committed
936

937
938
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
939
940
941
942
943
944
945
946
947
948
949

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

950
951
ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
		       loff_t *ppos, int flags);
952
953
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
954
955
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
956
957
958
unsigned fuse_file_poll(struct file *file, poll_table *wait);
int fuse_dev_release(struct inode *inode, struct file *file);

959
960
bool fuse_write_update_size(struct inode *inode, loff_t pos);

961
int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
Miklos Szeredi's avatar
Miklos Szeredi committed
962
int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
Miklos Szeredi's avatar
Miklos Szeredi committed
963

964
int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
965
966
		    struct file *file);

967
968
void fuse_set_initialized(struct fuse_conn *fc);

969
970
971
void fuse_unlock_inode(struct inode *inode);
void fuse_lock_inode(struct inode *inode);

Seth Forshee's avatar
Seth Forshee committed
972
973
974
975
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
976
ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
Seth Forshee's avatar
Seth Forshee committed
977
int fuse_removexattr(struct inode *inode, const char *name);
Seth Forshee's avatar
Seth Forshee committed
978
extern const struct xattr_handler *fuse_xattr_handlers[];
Seth Forshee's avatar
Seth Forshee committed
979
980
981
982
983
extern const struct xattr_handler *fuse_acl_xattr_handlers[];

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
984

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