fuse_i.h 19.8 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,
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
212
213
214
	/** Number or arguments */
	unsigned numargs;

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

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

231
232
233
234
/**
 * A request to the client
 */
struct fuse_req {
235
236
	/** This can be on either pending processing or io lists in
	    fuse_conn */
237
238
	struct list_head list;

239
240
241
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

242
243
244
	/** refcount */
	atomic_t count;

245
246
247
	/** Unique ID for the interrupt request */
	u64 intr_unique;

248
249
250
	/*
	 * The following bitfields are either set once before the
	 * request is queued or setting/clearing them is protected by
251
	 * fuse_conn->lock
252
253
	 */

254
255
256
	/** True if the request has reply */
	unsigned isreply:1;

257
258
259
	/** Force sending of the request even if interrupted */
	unsigned force:1;

260
261
	/** The request was aborted */
	unsigned aborted:1;
262
263
264
265

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

266
267
268
	/** The request has been interrupted */
	unsigned interrupted:1;

269
270
271
	/** Data is being copied to/from the request */
	unsigned locked:1;

272
273
274
	/** Request is counted as "waiting" */
	unsigned waiting:1;

275
276
	/** State of the request */
	enum fuse_req_state state;
277
278
279
280
281
282
283
284
285
286
287
288

	/** 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 {
289
		struct {
290
291
292
293
			union {
				struct fuse_release_in in;
				struct work_struct work;
			};
294
			struct path path;
295
		} release;
296
297
		struct fuse_init_in init_in;
		struct fuse_init_out init_out;
298
		struct cuse_init_in cuse_init_in;
299
300
301
302
		struct {
			struct fuse_read_in in;
			u64 attr_ver;
		} read;
303
304
305
306
		struct {
			struct fuse_write_in in;
			struct fuse_write_out out;
		} write;
Miklos Szeredi's avatar
Miklos Szeredi committed
307
		struct fuse_notify_retrieve_in retrieve_in;
308
		struct fuse_lk_in lk_in;
309
310
311
	} misc;

	/** page vector */
312
313
	struct page **pages;

314
315
316
	/** page-descriptor vector */
	struct fuse_page_desc *page_descs;

317
318
319
320
321
	/** size of the 'pages' array */
	unsigned max_pages;

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

323
324
325
	/** inline page-descriptor vector */
	struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];

326
327
328
329
	/** number of pages in vector */
	unsigned num_pages;

	/** File used in the request (or NULL) */
330
	struct fuse_file *ff;
331

Miklos Szeredi's avatar
Miklos Szeredi committed
332
333
334
335
336
337
	/** Inode used in the request or NULL */
	struct inode *inode;

	/** Link on fi->writepages */
	struct list_head writepages_entry;

338
339
	/** Request completion callback */
	void (*end)(struct fuse_conn *, struct fuse_req *);
340
341
342

	/** Request is stolen from fuse_file->reserved_req */
	struct file *stolen_file;
343
344
};

Miklos Szeredi's avatar
Miklos Szeredi committed
345
346
347
348
349
350
351
352
/**
 * 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 {
353
354
355
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

356
357
358
	/** Mutex protecting against directory alias creation */
	struct mutex inst_mutex;

359
360
361
	/** Refcount */
	atomic_t count;

Miklos Szeredi's avatar
Miklos Szeredi committed
362
	/** The user id for this mount */
363
	kuid_t user_id;
Miklos Szeredi's avatar
Miklos Szeredi committed
364

365
	/** The group id for this mount */
366
	kgid_t group_id;
367

Miklos Szeredi's avatar
Miklos Szeredi committed
368
369
370
	/** The fuse mount flags for this mount */
	unsigned flags;

371
372
373
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
374
375
376
	/** Maximum write size */
	unsigned max_write;

377
378
379
380
381
382
383
384
385
	/** 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;

386
387
388
	/** The list of requests under I/O */
	struct list_head io;

Tejun Heo's avatar
Tejun Heo committed
389
390
391
	/** The next unique kernel file handle */
	u64 khctr;

Tejun Heo's avatar
Tejun Heo committed
392
393
394
	/** rbtree of fuse_files waiting for poll events indexed by ph */
	struct rb_root polled_files;

395
396
397
398
399
400
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

401
402
403
	/** Number of requests currently in the background */
	unsigned num_background;

404
405
406
407
408
409
	/** 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;

410
411
412
	/** Pending interrupts */
	struct list_head interrupts;

413
414
415
416
417
418
419
	/** 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;

420
421
422
423
	/** Flag indicating that INIT reply has been received. Allocating
	 * any fuse request will be suspended until the flag is set */
	int initialized;

424
425
426
427
428
429
430
	/** 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;
431
432
433

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

435
436
437
	/** The next unique request id */
	u64 reqctr;

438
439
	/** Connection established, cleared on umount, connection
	    abort and device release */
440
	unsigned connected;
Miklos Szeredi's avatar
Miklos Szeredi committed
441

442
443
444
	/** 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
445
	unsigned conn_error:1;
446

447
	/** Connection successful.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
448
	unsigned conn_init:1;
449

450
	/** Do readpages asynchronously?  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
451
	unsigned async_read:1;
452

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

456
	/** Filesystem supports NFS exporting.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
457
	unsigned export_support:1;
458

459
460
461
	/** Set if bdi is valid */
	unsigned bdi_initialized:1;

462
463
464
465
466
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

467
	/** Is fsync not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
468
	unsigned no_fsync:1;
469

470
	/** Is fsyncdir not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
471
	unsigned no_fsyncdir:1;
472

473
	/** Is flush not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
474
	unsigned no_flush:1;
475

476
	/** Is setxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
477
	unsigned no_setxattr:1;
478
479

	/** Is getxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
480
	unsigned no_getxattr:1;
481
482

	/** Is listxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
483
	unsigned no_listxattr:1;
484
485

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

Miklos Szeredi's avatar
Miklos Szeredi committed
488
	/** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
489
	unsigned no_lock:1;
490

Miklos Szeredi's avatar
Miklos Szeredi committed
491
	/** Is access not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
492
	unsigned no_access:1;
Miklos Szeredi's avatar
Miklos Szeredi committed
493

494
	/** Is create not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
495
	unsigned no_create:1;
496

497
	/** Is interrupt not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
498
	unsigned no_interrupt:1;
499

500
	/** Is bmap not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
501
	unsigned no_bmap:1;
502

Tejun Heo's avatar
Tejun Heo committed
503
504
505
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

506
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
507
	unsigned big_writes:1;
508

509
510
511
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
512
513
514
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

515
516
517
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

518
519
520
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

521
	/** Does the filesystem support readdirplus? */
522
523
	unsigned do_readdirplus:1;

524
525
526
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

527
528
529
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

530
531
532
	/** Negotiated minor version */
	unsigned minor;

Miklos Szeredi's avatar
Miklos Szeredi committed
533
534
	/** Backing dev info */
	struct backing_dev_info bdi;
535

536
537
538
	/** Entry on the fuse_conn_list */
	struct list_head entry;

539
540
	/** Device ID from super block */
	dev_t dev;
541
542
543
544
545
546

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

	/** number of dentries used in the above array */
	int ctl_ndents;
547
548
549

	/** O_ASYNC requests */
	struct fasync_struct *fasync;
550
551
552

	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
553
554
555

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
556
557
558

	/** Version counter for attribute changes */
	u64 attr_version;
Tejun Heo's avatar
Tejun Heo committed
559
560
561

	/** Called on final put */
	void (*release)(struct fuse_conn *);
John Muir's avatar
John Muir committed
562
563
564
565
566
567

	/** 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
568
569
570
571
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
572
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
}

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

590
/** Device operations */
591
extern const struct file_operations fuse_dev_operations;
592

Al Viro's avatar
Al Viro committed
593
extern const struct dentry_operations fuse_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
594

John Muir's avatar
John Muir committed
595
596
597
598
599
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

600
601
602
/**
 * Get a filled in inode
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
603
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
604
605
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
606

607
608
609
int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
		     struct fuse_entry_out *outarg, struct inode **inode);

610
611
612
/**
 * Send FORGET command
 */
613
614
615
616
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);
617

618
619
620
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

621
/**
622
 * Initialize READ or READDIR request
623
 */
624
void fuse_read_fill(struct fuse_req *req, struct file *file,
625
		    loff_t pos, size_t count, int opcode);
626
627
628
629

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

Tejun Heo's avatar
Tejun Heo committed
632
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
633
struct fuse_file *fuse_file_get(struct fuse_file *ff);
634
void fuse_file_free(struct fuse_file *ff);
635
void fuse_finish_open(struct inode *inode, struct file *file);
636

637
void fuse_sync_release(struct fuse_file *ff, int flags);
638

639
640
641
/**
 * Send RELEASE or RELEASEDIR request
 */
642
void fuse_release_common(struct file *file, int opcode);
643

644
645
646
/**
 * Send FSYNC or FSYNCDIR request
 */
647
648
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
649

Tejun Heo's avatar
Tejun Heo committed
650
651
652
653
654
655
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

656
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
657
 * Initialize file operations on a regular file
658
659
660
 */
void fuse_init_file_inode(struct inode *inode);

661
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
662
 * Initialize inode operations on regular files and special files
663
664
665
666
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
667
 * Initialize inode and file operations on a directory
668
669
670
671
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
672
 * Initialize inode operations on a symlink
673
674
675
676
677
678
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
679
680
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
681

Miklos Szeredi's avatar
Miklos Szeredi committed
682
683
684
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

685
686
687
688
689
690
691
692
693
694
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

695
696
697
int fuse_ctl_init(void);
void fuse_ctl_cleanup(void);

698
699
700
/**
 * Allocate a request
 */
701
struct fuse_req *fuse_request_alloc(unsigned npages);
702

703
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
Miklos Szeredi's avatar
Miklos Szeredi committed
704

705
706
707
708
709
710
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
711
712
 * Get a request, may fail with -ENOMEM,
 * caller should specify # elements in req->pages[] explicitly
713
 */
714
struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
715
716
struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
					     unsigned npages);
717
718
719
720
721
722
723
724
725

/**
 * 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);
}
726

727
728
729
/**
 * Gets a requests for a file operation, always succeeds
 */
730
731
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
732

733
/**
734
735
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
736
737
738
739
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
740
 * Send a request (synchronous)
741
 */
742
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
743
744
745
746

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

749
750
void fuse_request_send_background_locked(struct fuse_conn *fc,
					 struct fuse_req *req);
Miklos Szeredi's avatar
Miklos Szeredi committed
751

752
/* Abort all requests */
753
754
void fuse_abort_conn(struct fuse_conn *fc);

755
756
757
758
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
759

Miklos Szeredi's avatar
Miklos Szeredi committed
760
761
void fuse_invalidate_entry_cache(struct dentry *entry);

762
763
764
765
766
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

767
768
void fuse_conn_kill(struct fuse_conn *fc);

769
770
771
/**
 * Initialize fuse_conn
 */
772
void fuse_conn_init(struct fuse_conn *fc);
773

774
775
776
777
778
779
780
781
782
783
784
785
786
787
/**
 * 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);
788
789
790
791
792

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

/**
795
 * Is current process allowed to perform filesystem operation?
Miklos Szeredi's avatar
Miklos Szeredi committed
796
 */
797
int fuse_allow_current_process(struct fuse_conn *fc);
798
799

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

int fuse_update_attributes(struct inode *inode, struct kstat *stat,
			   struct file *file, bool *refreshed);
Miklos Szeredi's avatar
Miklos Szeredi committed
803
804
805
806
807

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
808
809

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

John Muir's avatar
John Muir committed
811
812
813
814
815
816
817
818
819
/**
 * 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.
820
821
822
823
824
825
 *
 * 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
826
827
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
828
			     u64 child_nodeid, struct qstr *name);
John Muir's avatar
John Muir committed
829

830
831
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
832
833
834
ssize_t fuse_direct_io(struct file *file, const struct iovec *iov,
		       unsigned long nr_segs, size_t count, loff_t *ppos,
		       int write);
835
836
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
837
838
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
839
840
841
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
842
843
void fuse_write_update_size(struct inode *inode, loff_t pos);

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