fuse_i.h 19.3 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;
Miklos Szeredi's avatar
Miklos Szeredi committed
109
110
};

111
112
struct fuse_conn;

113
114
/** FUSE specific file data */
struct fuse_file {
115
116
117
	/** Fuse connection for this file */
	struct fuse_conn *fc;

118
	/** Request reserved for flush and release */
119
	struct fuse_req *reserved_req;
120

Tejun Heo's avatar
Tejun Heo committed
121
122
123
	/** Kernel file handle guaranteed to be unique */
	u64 kh;

124
125
	/** File handle used by userspace */
	u64 fh;
126

127
128
129
	/** Node id of this file */
	u64 nodeid;

130
131
	/** Refcount */
	atomic_t count;
132

133
134
135
	/** FOPEN_* flags returned by open */
	u32 open_flags;

136
137
	/** Entry on inode's write_files list */
	struct list_head write_entry;
Tejun Heo's avatar
Tejun Heo committed
138
139
140
141
142
143

	/** 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
144
145
146

	/** Has flock been performed on this file? */
	bool flock:1;
147
148
};

149
150
151
152
153
154
155
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
/** 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;

181
182
183
184
185
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

186
187
188
189
190
191
192
193
194
195
	/** 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;

196
197
198
	/** Pages may be replaced with new ones */
	unsigned page_replace:1;

199
200
201
202
203
204
205
	/** Number or arguments */
	unsigned numargs;

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

206
207
208
209
210
211
/** FUSE page descriptor */
struct fuse_page_desc {
	unsigned int length;
	unsigned int offset;
};

212
213
214
215
216
217
/** The request state */
enum fuse_req_state {
	FUSE_REQ_INIT = 0,
	FUSE_REQ_PENDING,
	FUSE_REQ_READING,
	FUSE_REQ_SENT,
218
	FUSE_REQ_WRITING,
219
220
221
	FUSE_REQ_FINISHED
};

222
223
224
225
/**
 * A request to the client
 */
struct fuse_req {
226
227
	/** This can be on either pending processing or io lists in
	    fuse_conn */
228
229
	struct list_head list;

230
231
232
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

233
234
235
	/** refcount */
	atomic_t count;

236
237
238
	/** Unique ID for the interrupt request */
	u64 intr_unique;

239
240
241
	/*
	 * The following bitfields are either set once before the
	 * request is queued or setting/clearing them is protected by
242
	 * fuse_conn->lock
243
244
	 */

245
246
247
	/** True if the request has reply */
	unsigned isreply:1;

248
249
250
	/** Force sending of the request even if interrupted */
	unsigned force:1;

251
252
	/** The request was aborted */
	unsigned aborted:1;
253
254
255
256

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

257
258
259
	/** The request has been interrupted */
	unsigned interrupted:1;

260
261
262
	/** Data is being copied to/from the request */
	unsigned locked:1;

263
264
265
	/** Request is counted as "waiting" */
	unsigned waiting:1;

266
267
	/** State of the request */
	enum fuse_req_state state;
268
269
270
271
272
273
274
275
276
277
278
279

	/** 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 {
280
		struct {
281
282
283
284
			union {
				struct fuse_release_in in;
				struct work_struct work;
			};
285
			struct path path;
286
		} release;
287
288
		struct fuse_init_in init_in;
		struct fuse_init_out init_out;
289
		struct cuse_init_in cuse_init_in;
290
291
292
293
		struct {
			struct fuse_read_in in;
			u64 attr_ver;
		} read;
294
295
296
297
		struct {
			struct fuse_write_in in;
			struct fuse_write_out out;
		} write;
Miklos Szeredi's avatar
Miklos Szeredi committed
298
		struct fuse_notify_retrieve_in retrieve_in;
299
		struct fuse_lk_in lk_in;
300
301
302
	} misc;

	/** page vector */
303
304
	struct page **pages;

305
306
307
	/** page-descriptor vector */
	struct fuse_page_desc *page_descs;

308
309
310
311
312
	/** size of the 'pages' array */
	unsigned max_pages;

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

314
315
316
	/** inline page-descriptor vector */
	struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];

317
318
319
320
	/** number of pages in vector */
	unsigned num_pages;

	/** File used in the request (or NULL) */
321
	struct fuse_file *ff;
322

Miklos Szeredi's avatar
Miklos Szeredi committed
323
324
325
326
327
328
	/** Inode used in the request or NULL */
	struct inode *inode;

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

329
330
	/** Request completion callback */
	void (*end)(struct fuse_conn *, struct fuse_req *);
331
332
333

	/** Request is stolen from fuse_file->reserved_req */
	struct file *stolen_file;
334
335
};

Miklos Szeredi's avatar
Miklos Szeredi committed
336
337
338
339
340
341
342
343
/**
 * 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 {
344
345
346
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

347
348
349
	/** Mutex protecting against directory alias creation */
	struct mutex inst_mutex;

350
351
352
	/** Refcount */
	atomic_t count;

Miklos Szeredi's avatar
Miklos Szeredi committed
353
	/** The user id for this mount */
354
	kuid_t user_id;
Miklos Szeredi's avatar
Miklos Szeredi committed
355

356
	/** The group id for this mount */
357
	kgid_t group_id;
358

Miklos Szeredi's avatar
Miklos Szeredi committed
359
360
361
	/** The fuse mount flags for this mount */
	unsigned flags;

362
363
364
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
365
366
367
	/** Maximum write size */
	unsigned max_write;

368
369
370
371
372
373
374
375
376
	/** 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;

377
378
379
	/** The list of requests under I/O */
	struct list_head io;

Tejun Heo's avatar
Tejun Heo committed
380
381
382
	/** The next unique kernel file handle */
	u64 khctr;

Tejun Heo's avatar
Tejun Heo committed
383
384
385
	/** rbtree of fuse_files waiting for poll events indexed by ph */
	struct rb_root polled_files;

386
387
388
389
390
391
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

392
393
394
	/** Number of requests currently in the background */
	unsigned num_background;

395
396
397
398
399
400
	/** 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;

401
402
403
	/** Pending interrupts */
	struct list_head interrupts;

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

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

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

422
423
424
	/** The next unique request id */
	u64 reqctr;

425
426
	/** Connection established, cleared on umount, connection
	    abort and device release */
427
	unsigned connected;
Miklos Szeredi's avatar
Miklos Szeredi committed
428

429
430
431
	/** 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
432
	unsigned conn_error:1;
433

434
	/** Connection successful.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
435
	unsigned conn_init:1;
436

437
	/** Do readpages asynchronously?  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
438
	unsigned async_read:1;
439

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

443
	/** Filesystem supports NFS exporting.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
444
	unsigned export_support:1;
445

446
447
448
	/** Set if bdi is valid */
	unsigned bdi_initialized:1;

449
450
451
452
453
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

454
	/** Is fsync not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
455
	unsigned no_fsync:1;
456

457
	/** Is fsyncdir not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
458
	unsigned no_fsyncdir:1;
459

460
	/** Is flush not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
461
	unsigned no_flush:1;
462

463
	/** Is setxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
464
	unsigned no_setxattr:1;
465
466

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

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

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

Miklos Szeredi's avatar
Miklos Szeredi committed
475
	/** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
476
	unsigned no_lock:1;
477

Miklos Szeredi's avatar
Miklos Szeredi committed
478
	/** Is access not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
479
	unsigned no_access:1;
Miklos Szeredi's avatar
Miklos Szeredi committed
480

481
	/** Is create not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
482
	unsigned no_create:1;
483

484
	/** Is interrupt not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
485
	unsigned no_interrupt:1;
486

487
	/** Is bmap not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
488
	unsigned no_bmap:1;
489

Tejun Heo's avatar
Tejun Heo committed
490
491
492
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

493
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
494
	unsigned big_writes:1;
495

496
497
498
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
499
500
501
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

502
503
504
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

505
506
507
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

508
509
510
	/** Does the filesystem support readdir-plus? */
	unsigned do_readdirplus:1;

511
512
513
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

514
515
516
	/** Negotiated minor version */
	unsigned minor;

Miklos Szeredi's avatar
Miklos Szeredi committed
517
518
	/** Backing dev info */
	struct backing_dev_info bdi;
519

520
521
522
	/** Entry on the fuse_conn_list */
	struct list_head entry;

523
524
	/** Device ID from super block */
	dev_t dev;
525
526
527
528
529
530

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

	/** number of dentries used in the above array */
	int ctl_ndents;
531
532
533

	/** O_ASYNC requests */
	struct fasync_struct *fasync;
534
535
536

	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
537
538
539

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
540
541
542

	/** Version counter for attribute changes */
	u64 attr_version;
Tejun Heo's avatar
Tejun Heo committed
543
544
545

	/** Called on final put */
	void (*release)(struct fuse_conn *);
John Muir's avatar
John Muir committed
546
547
548
549
550
551

	/** 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
552
553
554
555
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
556
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
}

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

574
/** Device operations */
575
extern const struct file_operations fuse_dev_operations;
576

Al Viro's avatar
Al Viro committed
577
extern const struct dentry_operations fuse_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
578

John Muir's avatar
John Muir committed
579
580
581
582
583
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

584
585
586
/**
 * Get a filled in inode
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
587
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
588
589
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
590

591
592
593
int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
		     struct fuse_entry_out *outarg, struct inode **inode);

594
595
596
/**
 * Send FORGET command
 */
597
598
599
600
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);
601

602
603
604
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

605
/**
606
 * Initialize READ or READDIR request
607
 */
608
void fuse_read_fill(struct fuse_req *req, struct file *file,
609
		    loff_t pos, size_t count, int opcode);
610
611
612
613

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

Tejun Heo's avatar
Tejun Heo committed
616
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
617
struct fuse_file *fuse_file_get(struct fuse_file *ff);
618
void fuse_file_free(struct fuse_file *ff);
619
void fuse_finish_open(struct inode *inode, struct file *file);
620

621
void fuse_sync_release(struct fuse_file *ff, int flags);
622

623
624
625
/**
 * Send RELEASE or RELEASEDIR request
 */
626
void fuse_release_common(struct file *file, int opcode);
627

628
629
630
/**
 * Send FSYNC or FSYNCDIR request
 */
631
632
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
633

Tejun Heo's avatar
Tejun Heo committed
634
635
636
637
638
639
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

640
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
641
 * Initialize file operations on a regular file
642
643
644
 */
void fuse_init_file_inode(struct inode *inode);

645
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
646
 * Initialize inode operations on regular files and special files
647
648
649
650
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
651
 * Initialize inode and file operations on a directory
652
653
654
655
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
656
 * Initialize inode operations on a symlink
657
658
659
660
661
662
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
663
664
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
665

Miklos Szeredi's avatar
Miklos Szeredi committed
666
667
668
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

669
670
671
672
673
674
675
676
677
678
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

679
680
681
int fuse_ctl_init(void);
void fuse_ctl_cleanup(void);

682
683
684
/**
 * Allocate a request
 */
685
struct fuse_req *fuse_request_alloc(unsigned npages);
686

687
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
Miklos Szeredi's avatar
Miklos Szeredi committed
688

689
690
691
692
693
694
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
695
696
 * Get a request, may fail with -ENOMEM,
 * caller should specify # elements in req->pages[] explicitly
697
 */
698
699
700
701
702
703
704
705
706
707
struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);

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

709
710
711
/**
 * Gets a requests for a file operation, always succeeds
 */
712
713
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
714

715
/**
716
717
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
718
719
720
721
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
722
 * Send a request (synchronous)
723
 */
724
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
725
726
727
728

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

731
732
void fuse_request_send_background_locked(struct fuse_conn *fc,
					 struct fuse_req *req);
Miklos Szeredi's avatar
Miklos Szeredi committed
733

734
/* Abort all requests */
735
736
void fuse_abort_conn(struct fuse_conn *fc);

737
738
739
740
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
741

Miklos Szeredi's avatar
Miklos Szeredi committed
742
743
void fuse_invalidate_entry_cache(struct dentry *entry);

744
745
746
747
748
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

749
750
void fuse_conn_kill(struct fuse_conn *fc);

751
752
753
/**
 * Initialize fuse_conn
 */
754
void fuse_conn_init(struct fuse_conn *fc);
755

756
757
758
759
760
761
762
763
764
765
766
767
768
769
/**
 * 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);
770
771
772
773
774

/**
 * Is file type valid?
 */
int fuse_valid_type(int m);
Miklos Szeredi's avatar
Miklos Szeredi committed
775
776
777
778
779

/**
 * Is task allowed to perform filesystem operation?
 */
int fuse_allow_task(struct fuse_conn *fc, struct task_struct *task);
780
781

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

int fuse_update_attributes(struct inode *inode, struct kstat *stat,
			   struct file *file, bool *refreshed);
Miklos Szeredi's avatar
Miklos Szeredi committed
785
786
787
788
789

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
790
791

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

John Muir's avatar
John Muir committed
793
794
795
796
797
798
799
800
801
/**
 * 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.
802
803
804
805
806
807
 *
 * 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
808
809
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
810
			     u64 child_nodeid, struct qstr *name);
John Muir's avatar
John Muir committed
811

812
813
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
814
815
816
ssize_t fuse_direct_io(struct file *file, const struct iovec *iov,
		       unsigned long nr_segs, size_t count, loff_t *ppos,
		       int write);
817
818
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
819
820
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
821
822
823
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
824
825
void fuse_write_update_size(struct inode *inode, loff_t pos);

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