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>
27
#include <linux/pid_namespace.h>
28
#include <linux/refcount.h>
Miklos Szeredi's avatar
Miklos Szeredi committed
29

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

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

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

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

45
46
47
48
49
/** 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
50

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

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

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

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

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

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

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

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

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

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

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

	/** 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;
104
105
106

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

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

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

122
123
struct fuse_conn;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

314
315
316
	/** Unique ID for the interrupt request */
	u64 intr_unique;

Miklos Szeredi's avatar
Miklos Szeredi committed
317
318
	/* Request flags, updated with test/set/clear_bit() */
	unsigned long flags;
319

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

	/** page vector */
351
352
	struct page **pages;

353
354
355
	/** page-descriptor vector */
	struct fuse_page_desc *page_descs;

356
357
358
359
360
	/** size of the 'pages' array */
	unsigned max_pages;

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

362
363
364
	/** inline page-descriptor vector */
	struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];

365
366
367
368
	/** number of pages in vector */
	unsigned num_pages;

	/** File used in the request (or NULL) */
369
	struct fuse_file *ff;
370

Miklos Szeredi's avatar
Miklos Szeredi committed
371
372
373
	/** Inode used in the request or NULL */
	struct inode *inode;

Maxim Patlasov's avatar
Maxim Patlasov committed
374
375
376
	/** AIO control block */
	struct fuse_io_priv *io;

Miklos Szeredi's avatar
Miklos Szeredi committed
377
378
379
	/** Link on fi->writepages */
	struct list_head writepages_entry;

380
381
	/** Request completion callback */
	void (*end)(struct fuse_conn *, struct fuse_req *);
382
383
384

	/** Request is stolen from fuse_file->reserved_req */
	struct file *stolen_file;
385
386
};

387
struct fuse_iqueue {
388
389
390
	/** Connection established */
	unsigned connected;

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

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
423
424
425
426
427
	/** The list of requests being processed */
	struct list_head processing;

	/** 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
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
473
474
475
	/** Maximum write size */
	unsigned max_write;

476
477
	/** Input queue */
	struct fuse_iqueue iq;
478

Tejun Heo's avatar
Tejun Heo committed
479
480
481
	/** The next unique kernel file handle */
	u64 khctr;

Tejun Heo's avatar
Tejun Heo committed
482
483
484
	/** rbtree of fuse_files waiting for poll events indexed by ph */
	struct rb_root polled_files;

485
486
487
488
489
490
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

491
492
493
	/** Number of requests currently in the background */
	unsigned num_background;

494
495
496
497
498
499
	/** 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;

500
501
502
503
	/** Flag indicating that INIT reply has been received. Allocating
	 * any fuse request will be suspended until the flag is set */
	int initialized;

504
505
506
507
508
509
510
	/** 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;
511
512
513

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

515
516
	/** Connection established, cleared on umount, connection
	    abort and device release */
517
	unsigned connected;
Miklos Szeredi's avatar
Miklos Szeredi committed
518

519
520
521
	/** 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
522
	unsigned conn_error:1;
523

524
	/** Connection successful.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
525
	unsigned conn_init:1;
526

527
	/** Do readpages asynchronously?  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
528
	unsigned async_read:1;
529

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

533
	/** Filesystem supports NFS exporting.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
534
	unsigned export_support:1;
535

536
537
538
	/** write-back cache policy (default is write-through) */
	unsigned writeback_cache:1;

539
540
541
	/** allow parallel lookups and readdir (default is serialized) */
	unsigned parallel_dirops:1;

542
543
544
	/** handle fs handles killing suid/sgid/cap on write/chown/trunc */
	unsigned handle_killpriv:1;

545
546
547
548
549
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

550
551
552
	/** Is open/release not implemented by fs? */
	unsigned no_open:1;

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

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

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

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

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

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

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

Miklos Szeredi's avatar
Miklos Szeredi committed
574
	/** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
575
	unsigned no_lock:1;
576

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

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

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

586
	/** Is bmap not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
587
	unsigned no_bmap:1;
588

Tejun Heo's avatar
Tejun Heo committed
589
590
591
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

592
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
593
	unsigned big_writes:1;
594

595
596
597
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
598
599
600
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

601
602
603
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
604
605
606
	/** Is rename with flags implemented by fs? */
	unsigned no_rename2:1;

607
608
609
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

610
	/** Does the filesystem support readdirplus? */
611
612
	unsigned do_readdirplus:1;

613
614
615
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

616
617
618
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

619
620
621
	/** Is lseek not implemented by fs? */
	unsigned no_lseek:1;

Seth Forshee's avatar
Seth Forshee committed
622
623
624
	/** Does the filesystem support posix acls? */
	unsigned posix_acl:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
625
626
627
628
629
630
	/** 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;

631
632
633
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

634
635
636
	/** Negotiated minor version */
	unsigned minor;

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