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

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

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

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

Miklos Szeredi's avatar
Miklos Szeredi committed
38
39
40
41
42
43
44
45
46
/** If the FUSE_DEFAULT_PERMISSIONS flag is given, the filesystem
    module will check permissions based on the file mode.  Otherwise no
    permission checking is done in the kernel */
#define FUSE_DEFAULT_PERMISSIONS (1 << 0)

/** If the FUSE_ALLOW_OTHER flag is given, then not only the user
    doing the mount will be allowed to access the filesystem */
#define FUSE_ALLOW_OTHER         (1 << 1)

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

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

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

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

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

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

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

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

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

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

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

91
92
	/** Version of last attribute change */
	u64 attr_version;
93
94
95

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

	/** 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;
109
110
111
112
113
114
115
116
117

	/** Miscellaneous bits describing inode state */
	unsigned long state;
};

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

124
125
struct fuse_conn;

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

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

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

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

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

143
144
	/** Refcount */
	atomic_t count;
145

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

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

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

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

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

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

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

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

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

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

225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
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 = {}

244
245
246
247
248
249
/** The request state */
enum fuse_req_state {
	FUSE_REQ_INIT = 0,
	FUSE_REQ_PENDING,
	FUSE_REQ_READING,
	FUSE_REQ_SENT,
250
	FUSE_REQ_WRITING,
251
252
253
	FUSE_REQ_FINISHED
};

Maxim Patlasov's avatar
Maxim Patlasov committed
254
255
256
257
258
259
260
261
262
263
264
265
/** The request IO state (for asynchronous processing) */
struct fuse_io_priv {
	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;
266
	struct completion *done;
Maxim Patlasov's avatar
Maxim Patlasov committed
267
268
};

269
270
271
272
/**
 * A request to the client
 */
struct fuse_req {
273
274
	/** This can be on either pending processing or io lists in
	    fuse_conn */
275
276
	struct list_head list;

277
278
279
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

280
281
282
	/** refcount */
	atomic_t count;

283
284
285
	/** Unique ID for the interrupt request */
	u64 intr_unique;

286
287
288
	/*
	 * The following bitfields are either set once before the
	 * request is queued or setting/clearing them is protected by
289
	 * fuse_conn->lock
290
291
	 */

292
293
294
	/** True if the request has reply */
	unsigned isreply:1;

295
296
297
	/** Force sending of the request even if interrupted */
	unsigned force:1;

298
299
	/** The request was aborted */
	unsigned aborted:1;
300
301
302
303

	/** Request is sent in the background */
	unsigned background:1;

304
305
306
	/** The request has been interrupted */
	unsigned interrupted:1;

307
308
309
	/** Data is being copied to/from the request */
	unsigned locked:1;

310
311
312
	/** Request is counted as "waiting" */
	unsigned waiting:1;

313
314
	/** State of the request */
	enum fuse_req_state state;
315
316
317
318
319
320
321
322
323
324
325
326

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

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

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

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

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

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

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

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

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

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

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

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

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

Miklos Szeredi's avatar
Miklos Szeredi committed
383
384
385
386
387
388
389
390
/**
 * 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 {
391
392
393
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

394
395
396
	/** Refcount */
	atomic_t count;

Al Viro's avatar
Al Viro committed
397
398
	struct rcu_head rcu;

Miklos Szeredi's avatar
Miklos Szeredi committed
399
	/** The user id for this mount */
400
	kuid_t user_id;
Miklos Szeredi's avatar
Miklos Szeredi committed
401

402
	/** The group id for this mount */
403
	kgid_t group_id;
404

Miklos Szeredi's avatar
Miklos Szeredi committed
405
406
407
	/** The fuse mount flags for this mount */
	unsigned flags;

408
409
410
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
411
412
413
	/** Maximum write size */
	unsigned max_write;

414
415
416
417
418
419
420
421
422
	/** Readers of the connection are waiting on this */
	wait_queue_head_t waitq;

	/** The list of pending requests */
	struct list_head pending;

	/** The list of requests being processed */
	struct list_head processing;

423
424
425
	/** The list of requests under I/O */
	struct list_head io;

Tejun Heo's avatar
Tejun Heo committed
426
427
428
	/** The next unique kernel file handle */
	u64 khctr;

Tejun Heo's avatar
Tejun Heo committed
429
430
431
	/** rbtree of fuse_files waiting for poll events indexed by ph */
	struct rb_root polled_files;

432
433
434
435
436
437
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

438
439
440
	/** Number of requests currently in the background */
	unsigned num_background;

441
442
443
444
445
446
	/** 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;

447
448
449
	/** Pending interrupts */
	struct list_head interrupts;

450
451
452
453
454
455
456
	/** 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;

457
458
459
460
	/** Flag indicating that INIT reply has been received. Allocating
	 * any fuse request will be suspended until the flag is set */
	int initialized;

461
462
463
464
465
466
467
	/** 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;
468
469
470

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

472
473
474
	/** The next unique request id */
	u64 reqctr;

475
476
	/** Connection established, cleared on umount, connection
	    abort and device release */
477
	unsigned connected;
Miklos Szeredi's avatar
Miklos Szeredi committed
478

479
480
481
	/** 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
482
	unsigned conn_error:1;
483

484
	/** Connection successful.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
485
	unsigned conn_init:1;
486

487
	/** Do readpages asynchronously?  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
488
	unsigned async_read:1;
489

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

493
	/** Filesystem supports NFS exporting.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
494
	unsigned export_support:1;
495

496
497
498
	/** Set if bdi is valid */
	unsigned bdi_initialized:1;

499
500
501
	/** write-back cache policy (default is write-through) */
	unsigned writeback_cache:1;

502
503
504
505
506
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

507
508
509
	/** Is open/release not implemented by fs? */
	unsigned no_open:1;

510
	/** Is fsync not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
511
	unsigned no_fsync:1;
512

513
	/** Is fsyncdir not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
514
	unsigned no_fsyncdir:1;
515

516
	/** Is flush not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
517
	unsigned no_flush:1;
518

519
	/** Is setxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
520
	unsigned no_setxattr:1;
521
522

	/** Is getxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
523
	unsigned no_getxattr:1;
524
525

	/** Is listxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
526
	unsigned no_listxattr:1;
527
528

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

Miklos Szeredi's avatar
Miklos Szeredi committed
531
	/** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
532
	unsigned no_lock:1;
533

Miklos Szeredi's avatar
Miklos Szeredi committed
534
	/** Is access not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
535
	unsigned no_access:1;
Miklos Szeredi's avatar
Miklos Szeredi committed
536

537
	/** Is create not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
538
	unsigned no_create:1;
539

540
	/** Is interrupt not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
541
	unsigned no_interrupt:1;
542

543
	/** Is bmap not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
544
	unsigned no_bmap:1;
545

Tejun Heo's avatar
Tejun Heo committed
546
547
548
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

549
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
550
	unsigned big_writes:1;
551

552
553
554
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
555
556
557
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

558
559
560
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
561
562
563
	/** Is rename with flags implemented by fs? */
	unsigned no_rename2:1;

564
565
566
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

567
	/** Does the filesystem support readdirplus? */
568
569
	unsigned do_readdirplus:1;

570
571
572
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

573
574
575
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

576
577
578
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

579
580
581
	/** Negotiated minor version */
	unsigned minor;

Miklos Szeredi's avatar
Miklos Szeredi committed
582
583
	/** Backing dev info */
	struct backing_dev_info bdi;
584

585
586
587
	/** Entry on the fuse_conn_list */
	struct list_head entry;

588
589
	/** Device ID from super block */
	dev_t dev;
590
591
592
593
594
595

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

	/** number of dentries used in the above array */
	int ctl_ndents;
596
597
598

	/** O_ASYNC requests */
	struct fasync_struct *fasync;
599
600
601

	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
602
603
604

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
605
606
607

	/** Version counter for attribute changes */
	u64 attr_version;
Tejun Heo's avatar
Tejun Heo committed
608
609
610

	/** Called on final put */
	void (*release)(struct fuse_conn *);
John Muir's avatar
John Muir committed
611
612
613
614
615
616

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

	/** Read/write semaphore to hold when accessing sb. */
	struct rw_semaphore killsb;
Miklos Szeredi's avatar
Miklos Szeredi committed
617
618
619
620
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
621
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
}

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

639
/** Device operations */
640
extern const struct file_operations fuse_dev_operations;
641

Al Viro's avatar
Al Viro committed
642
extern const struct dentry_operations fuse_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
643

John Muir's avatar
John Muir committed
644
645
646
647
648
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

649
650
651
/**
 * Get a filled in inode
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
652
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
653
654
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
655

656
657
658
int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
		     struct fuse_entry_out *outarg, struct inode **inode);

659
660
661
/**
 * Send FORGET command
 */
662
663
664
665
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);
666

667
668
669
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

670
/**
671
 * Initialize READ or READDIR request
672
 */
673
void fuse_read_fill(struct fuse_req *req, struct file *file,
674
		    loff_t pos, size_t count, int opcode);
675
676
677
678

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

Tejun Heo's avatar
Tejun Heo committed
681
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
682
struct fuse_file *fuse_file_get(struct fuse_file *ff);
683
void fuse_file_free(struct fuse_file *ff);
684
void fuse_finish_open(struct inode *inode, struct file *file);
685

686
void fuse_sync_release(struct fuse_file *ff, int flags);
687

688
689
690
/**
 * Send RELEASE or RELEASEDIR request
 */
691
void fuse_release_common(struct file *file, int opcode);
692

693
694
695
/**
 * Send FSYNC or FSYNCDIR request
 */
696
697
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
698

Tejun Heo's avatar
Tejun Heo committed
699
700
701
702
703
704
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

705
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
706
 * Initialize file operations on a regular file
707
708
709
 */
void fuse_init_file_inode(struct inode *inode);

710
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
711
 * Initialize inode operations on regular files and special files
712
713
714
715
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
716
 * Initialize inode and file operations on a directory
717
718
719
720
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
721
 * Initialize inode operations on a symlink
722
723
724
725
726
727
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
728
729
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
730

Miklos Szeredi's avatar
Miklos Szeredi committed
731
732
733
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

734
735
736
737
738
739
740
741
742
743
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

744
int fuse_ctl_init(void);
745
void __exit fuse_ctl_cleanup(void);
746

747
748
749
/**
 * Allocate a request
 */
750
struct fuse_req *fuse_request_alloc(unsigned npages);
751

752
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
Miklos Szeredi's avatar
Miklos Szeredi committed
753

754
755
756
757
758
759
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
760
761
 * Get a request, may fail with -ENOMEM,
 * caller should specify # elements in req->pages[] explicitly
762
 */
763
struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
764
765
struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
					     unsigned npages);
766

767
768
769
770
771
/*
 * Increment reference count on request
 */
void __fuse_get_request(struct fuse_req *req);

772
773
774
/**
 * Gets a requests for a file operation, always succeeds
 */
775
776
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
777

778
/**
779
780
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
781
782
783
784
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
785
 * Send a request (synchronous)
786
 */
787
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
788

789
790
791
792
793
/**
 * Simple request sending that does request allocation and freeing
 */
ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);

794
795
796
/**
 * Send a request in the background
 */
797
void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
798

799
800
void fuse_request_send_background_locked(struct fuse_conn *fc,
					 struct fuse_req *req);
Miklos Szeredi's avatar
Miklos Szeredi committed
801

802
/* Abort all requests */
803
804
void fuse_abort_conn(struct fuse_conn *fc);

805
806
807
808
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
809

Miklos Szeredi's avatar
Miklos Szeredi committed
810
811
void fuse_invalidate_entry_cache(struct dentry *entry);

812
813
void fuse_invalidate_atime(struct inode *inode);

814
815
816
817
818
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

819
820
821
/**
 * Initialize fuse_conn
 */
822
void fuse_conn_init(struct fuse_conn *fc);
823

824
825
826
827
828
829
830
831
832
833
834
835
836
837
/**
 * Release reference to fuse_conn
 */
void fuse_conn_put(struct fuse_conn *fc);

/**
 * 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);
838
839
840
841
842

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

/**
845
 * Is current process allowed to perform filesystem operation?
Miklos Szeredi's avatar
Miklos Szeredi committed
846
 */
847
int fuse_allow_current_process(struct fuse_conn *fc);
848
849

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

int fuse_update_attributes(struct inode *inode, struct kstat *stat,
			   struct file *file, bool *refreshed);
Miklos Szeredi's avatar
Miklos Szeredi committed
853
854
855
856
857

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
858
859

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

John Muir's avatar
John Muir committed
861
862
863
864
865
866
867
868
869
/**
 * 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.
870
871
872
873
874
875
 *
 * 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
876
877
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
878
			     u64 child_nodeid, struct qstr *name);
John Muir's avatar
John Muir committed
879

880
881
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
882
883
884
885
886
887
888
889
890
891
892

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

893
894
ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
		       loff_t *ppos, int flags);
895
896
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
897
898
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
899
900
901
unsigned fuse_file_poll(struct file *file, poll_table *wait);
int fuse_dev_release(struct inode *inode, struct file *file);

902
903
bool fuse_write_update_size(struct inode *inode, loff_t pos);

904
int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
Miklos Szeredi's avatar
Miklos Szeredi committed
905
int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
Miklos Szeredi's avatar
Miklos Szeredi committed
906

907
908
909
int fuse_do_setattr(struct inode *inode, struct iattr *attr,
		    struct file *file);

910
911
void fuse_set_initialized(struct fuse_conn *fc);

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