fuse_i.h 20.4 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
	/** 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
142
	/** Refcount */
	atomic_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
214
215
216
	/** Number or arguments */
	unsigned numargs;

	/** Array of arguments */
	struct fuse_arg args[3];
};

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
/** The request state */
enum fuse_req_state {
	FUSE_REQ_INIT = 0,
	FUSE_REQ_PENDING,
	FUSE_REQ_READING,
	FUSE_REQ_SENT,
229
	FUSE_REQ_WRITING,
230
231
232
	FUSE_REQ_FINISHED
};

Maxim Patlasov's avatar
Maxim Patlasov committed
233
234
235
236
237
238
239
240
241
242
243
244
245
246
/** 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;
};

247
248
249
250
/**
 * A request to the client
 */
struct fuse_req {
251
252
	/** This can be on either pending processing or io lists in
	    fuse_conn */
253
254
	struct list_head list;

255
256
257
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

258
259
260
	/** refcount */
	atomic_t count;

261
262
263
	/** Unique ID for the interrupt request */
	u64 intr_unique;

264
265
266
	/*
	 * The following bitfields are either set once before the
	 * request is queued or setting/clearing them is protected by
267
	 * fuse_conn->lock
268
269
	 */

270
271
272
	/** True if the request has reply */
	unsigned isreply:1;

273
274
275
	/** Force sending of the request even if interrupted */
	unsigned force:1;

276
277
	/** The request was aborted */
	unsigned aborted:1;
278
279
280
281

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

282
283
284
	/** The request has been interrupted */
	unsigned interrupted:1;

285
286
287
	/** Data is being copied to/from the request */
	unsigned locked:1;

288
289
290
	/** Request is counted as "waiting" */
	unsigned waiting:1;

291
292
	/** State of the request */
	enum fuse_req_state state;
293
294
295
296
297
298
299
300
301
302
303
304

	/** 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 {
305
		struct {
306
307
308
309
			union {
				struct fuse_release_in in;
				struct work_struct work;
			};
310
			struct path path;
311
		} release;
312
313
		struct fuse_init_in init_in;
		struct fuse_init_out init_out;
314
		struct cuse_init_in cuse_init_in;
315
316
317
318
		struct {
			struct fuse_read_in in;
			u64 attr_ver;
		} read;
319
320
321
322
		struct {
			struct fuse_write_in in;
			struct fuse_write_out out;
		} write;
Miklos Szeredi's avatar
Miklos Szeredi committed
323
		struct fuse_notify_retrieve_in retrieve_in;
324
		struct fuse_lk_in lk_in;
325
326
327
	} misc;

	/** page vector */
328
329
	struct page **pages;

330
331
332
	/** page-descriptor vector */
	struct fuse_page_desc *page_descs;

333
334
335
336
337
	/** size of the 'pages' array */
	unsigned max_pages;

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

339
340
341
	/** inline page-descriptor vector */
	struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];

342
343
344
345
	/** number of pages in vector */
	unsigned num_pages;

	/** File used in the request (or NULL) */
346
	struct fuse_file *ff;
347

Miklos Szeredi's avatar
Miklos Szeredi committed
348
349
350
	/** Inode used in the request or NULL */
	struct inode *inode;

Maxim Patlasov's avatar
Maxim Patlasov committed
351
352
353
	/** AIO control block */
	struct fuse_io_priv *io;

Miklos Szeredi's avatar
Miklos Szeredi committed
354
355
356
	/** Link on fi->writepages */
	struct list_head writepages_entry;

357
358
	/** Request completion callback */
	void (*end)(struct fuse_conn *, struct fuse_req *);
359
360
361

	/** Request is stolen from fuse_file->reserved_req */
	struct file *stolen_file;
362
363
};

Miklos Szeredi's avatar
Miklos Szeredi committed
364
365
366
367
368
369
370
371
/**
 * 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 {
372
373
374
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

375
376
377
	/** Mutex protecting against directory alias creation */
	struct mutex inst_mutex;

378
379
380
	/** Refcount */
	atomic_t count;

Miklos Szeredi's avatar
Miklos Szeredi committed
381
	/** The user id for this mount */
382
	kuid_t user_id;
Miklos Szeredi's avatar
Miklos Szeredi committed
383

384
	/** The group id for this mount */
385
	kgid_t group_id;
386

Miklos Szeredi's avatar
Miklos Szeredi committed
387
388
389
	/** The fuse mount flags for this mount */
	unsigned flags;

390
391
392
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
393
394
395
	/** Maximum write size */
	unsigned max_write;

396
397
398
399
400
401
402
403
404
	/** 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;

405
406
407
	/** The list of requests under I/O */
	struct list_head io;

Tejun Heo's avatar
Tejun Heo committed
408
409
410
	/** The next unique kernel file handle */
	u64 khctr;

Tejun Heo's avatar
Tejun Heo committed
411
412
413
	/** rbtree of fuse_files waiting for poll events indexed by ph */
	struct rb_root polled_files;

414
415
416
417
418
419
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

420
421
422
	/** Number of requests currently in the background */
	unsigned num_background;

423
424
425
426
427
428
	/** 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;

429
430
431
	/** Pending interrupts */
	struct list_head interrupts;

432
433
434
435
436
437
438
	/** 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;

439
440
441
442
	/** Flag indicating that INIT reply has been received. Allocating
	 * any fuse request will be suspended until the flag is set */
	int initialized;

443
444
445
446
447
448
449
	/** 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;
450
451
452

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

454
455
456
	/** The next unique request id */
	u64 reqctr;

457
458
	/** Connection established, cleared on umount, connection
	    abort and device release */
459
	unsigned connected;
Miklos Szeredi's avatar
Miklos Szeredi committed
460

461
462
463
	/** 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
464
	unsigned conn_error:1;
465

466
	/** Connection successful.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
467
	unsigned conn_init:1;
468

469
	/** Do readpages asynchronously?  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
470
	unsigned async_read:1;
471

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

475
	/** Filesystem supports NFS exporting.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
476
	unsigned export_support:1;
477

478
479
480
	/** Set if bdi is valid */
	unsigned bdi_initialized:1;

481
482
483
484
485
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

486
	/** Is fsync not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
487
	unsigned no_fsync:1;
488

489
	/** Is fsyncdir not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
490
	unsigned no_fsyncdir:1;
491

492
	/** Is flush not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
493
	unsigned no_flush:1;
494

495
	/** Is setxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
496
	unsigned no_setxattr:1;
497
498

	/** Is getxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
499
	unsigned no_getxattr:1;
500
501

	/** Is listxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
502
	unsigned no_listxattr:1;
503
504

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

Miklos Szeredi's avatar
Miklos Szeredi committed
507
	/** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
508
	unsigned no_lock:1;
509

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

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

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

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

Tejun Heo's avatar
Tejun Heo committed
522
523
524
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

525
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
526
	unsigned big_writes:1;
527

528
529
530
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

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

534
535
536
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

537
538
539
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

540
	/** Does the filesystem support readdirplus? */
541
542
	unsigned do_readdirplus:1;

543
544
545
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

546
547
548
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

549
550
551
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

552
553
554
	/** Negotiated minor version */
	unsigned minor;

Miklos Szeredi's avatar
Miklos Szeredi committed
555
556
	/** Backing dev info */
	struct backing_dev_info bdi;
557

558
559
560
	/** Entry on the fuse_conn_list */
	struct list_head entry;

561
562
	/** Device ID from super block */
	dev_t dev;
563
564
565
566
567
568

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

	/** number of dentries used in the above array */
	int ctl_ndents;
569
570
571

	/** O_ASYNC requests */
	struct fasync_struct *fasync;
572
573
574

	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
575
576
577

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
578
579
580

	/** Version counter for attribute changes */
	u64 attr_version;
Tejun Heo's avatar
Tejun Heo committed
581
582
583

	/** Called on final put */
	void (*release)(struct fuse_conn *);
John Muir's avatar
John Muir committed
584
585
586
587
588
589

	/** 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
590
591
592
593
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
594
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
}

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

612
/** Device operations */
613
extern const struct file_operations fuse_dev_operations;
614

Al Viro's avatar
Al Viro committed
615
extern const struct dentry_operations fuse_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
616

John Muir's avatar
John Muir committed
617
618
619
620
621
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

622
623
624
/**
 * Get a filled in inode
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
625
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
626
627
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
628

629
630
631
int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
		     struct fuse_entry_out *outarg, struct inode **inode);

632
633
634
/**
 * Send FORGET command
 */
635
636
637
638
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);
639

640
641
642
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

643
/**
644
 * Initialize READ or READDIR request
645
 */
646
void fuse_read_fill(struct fuse_req *req, struct file *file,
647
		    loff_t pos, size_t count, int opcode);
648
649
650
651

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

Tejun Heo's avatar
Tejun Heo committed
654
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
655
struct fuse_file *fuse_file_get(struct fuse_file *ff);
656
void fuse_file_free(struct fuse_file *ff);
657
void fuse_finish_open(struct inode *inode, struct file *file);
658

659
void fuse_sync_release(struct fuse_file *ff, int flags);
660

661
662
663
/**
 * Send RELEASE or RELEASEDIR request
 */
664
void fuse_release_common(struct file *file, int opcode);
665

666
667
668
/**
 * Send FSYNC or FSYNCDIR request
 */
669
670
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
671

Tejun Heo's avatar
Tejun Heo committed
672
673
674
675
676
677
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

678
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
679
 * Initialize file operations on a regular file
680
681
682
 */
void fuse_init_file_inode(struct inode *inode);

683
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
684
 * Initialize inode operations on regular files and special files
685
686
687
688
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
689
 * Initialize inode and file operations on a directory
690
691
692
693
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
694
 * Initialize inode operations on a symlink
695
696
697
698
699
700
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
701
702
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
703

Miklos Szeredi's avatar
Miklos Szeredi committed
704
705
706
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

707
708
709
710
711
712
713
714
715
716
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

717
718
719
int fuse_ctl_init(void);
void fuse_ctl_cleanup(void);

720
721
722
/**
 * Allocate a request
 */
723
struct fuse_req *fuse_request_alloc(unsigned npages);
724

725
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
Miklos Szeredi's avatar
Miklos Szeredi committed
726

727
728
729
730
731
732
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
733
734
 * Get a request, may fail with -ENOMEM,
 * caller should specify # elements in req->pages[] explicitly
735
 */
736
struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
737
738
struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
					     unsigned npages);
739

740
741
742
743
744
/*
 * Increment reference count on request
 */
void __fuse_get_request(struct fuse_req *req);

745
746
747
748
749
750
751
752
/**
 * Get a request, may fail with -ENOMEM,
 * useful for callers who doesn't use req->pages[]
 */
static inline struct fuse_req *fuse_get_req_nopages(struct fuse_conn *fc)
{
	return fuse_get_req(fc, 0);
}
753

754
755
756
/**
 * Gets a requests for a file operation, always succeeds
 */
757
758
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
759

760
/**
761
762
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
763
764
765
766
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
767
 * Send a request (synchronous)
768
 */
769
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
770
771
772
773

/**
 * Send a request in the background
 */
774
void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
775

776
777
void fuse_request_send_background_locked(struct fuse_conn *fc,
					 struct fuse_req *req);
Miklos Szeredi's avatar
Miklos Szeredi committed
778

779
/* Abort all requests */
780
781
void fuse_abort_conn(struct fuse_conn *fc);

782
783
784
785
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
786

Miklos Szeredi's avatar
Miklos Szeredi committed
787
788
void fuse_invalidate_entry_cache(struct dentry *entry);

789
790
791
792
793
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

794
795
void fuse_conn_kill(struct fuse_conn *fc);

796
797
798
/**
 * Initialize fuse_conn
 */
799
void fuse_conn_init(struct fuse_conn *fc);
800

801
802
803
804
805
806
807
808
809
810
811
812
813
814
/**
 * 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);
815
816
817
818
819

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

/**
822
 * Is current process allowed to perform filesystem operation?
Miklos Szeredi's avatar
Miklos Szeredi committed
823
 */
824
int fuse_allow_current_process(struct fuse_conn *fc);
825
826

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

int fuse_update_attributes(struct inode *inode, struct kstat *stat,
			   struct file *file, bool *refreshed);
Miklos Szeredi's avatar
Miklos Szeredi committed
830
831
832
833
834

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
835
836

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

John Muir's avatar
John Muir committed
838
839
840
841
842
843
844
845
846
/**
 * 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.
847
848
849
850
851
852
 *
 * 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
853
854
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
855
			     u64 child_nodeid, struct qstr *name);
John Muir's avatar
John Muir committed
856

857
858
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
859
ssize_t fuse_direct_io(struct fuse_io_priv *io, const struct iovec *iov,
860
861
		       unsigned long nr_segs, size_t count, loff_t *ppos,
		       int write);
862
863
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
864
865
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
866
867
868
unsigned fuse_file_poll(struct file *file, poll_table *wait);
int fuse_dev_release(struct inode *inode, struct file *file);

Miklos Szeredi's avatar
Miklos Szeredi committed
869
870
void fuse_write_update_size(struct inode *inode, loff_t pos);

871
872
873
int fuse_do_setattr(struct inode *inode, struct iattr *attr,
		    struct file *file);

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