fuse_i.h 19.7 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
424
425
426
	/** 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;
427
428
429

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

431
432
433
	/** The next unique request id */
	u64 reqctr;

434
435
	/** Connection established, cleared on umount, connection
	    abort and device release */
436
	unsigned connected;
Miklos Szeredi's avatar
Miklos Szeredi committed
437

438
439
440
	/** 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
441
	unsigned conn_error:1;
442

443
	/** Connection successful.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
444
	unsigned conn_init:1;
445

446
	/** Do readpages asynchronously?  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
447
	unsigned async_read:1;
448

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

452
	/** Filesystem supports NFS exporting.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
453
	unsigned export_support:1;
454

455
456
457
	/** Set if bdi is valid */
	unsigned bdi_initialized:1;

458
459
460
461
462
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

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

466
	/** Is fsyncdir not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
467
	unsigned no_fsyncdir:1;
468

469
	/** Is flush not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
470
	unsigned no_flush:1;
471

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

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

	/** Is listxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
479
	unsigned no_listxattr:1;
480
481

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

Miklos Szeredi's avatar
Miklos Szeredi committed
484
	/** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
485
	unsigned no_lock:1;
486

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

490
	/** Is create not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
491
	unsigned no_create:1;
492

493
	/** Is interrupt not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
494
	unsigned no_interrupt:1;
495

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

Tejun Heo's avatar
Tejun Heo committed
499
500
501
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

502
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
503
	unsigned big_writes:1;
504

505
506
507
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
508
509
510
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

511
512
513
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

514
515
516
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

517
	/** Does the filesystem support readdirplus? */
518
519
	unsigned do_readdirplus:1;

520
521
522
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

523
524
525
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

526
527
528
	/** Negotiated minor version */
	unsigned minor;

Miklos Szeredi's avatar
Miklos Szeredi committed
529
530
	/** Backing dev info */
	struct backing_dev_info bdi;
531

532
533
534
	/** Entry on the fuse_conn_list */
	struct list_head entry;

535
536
	/** Device ID from super block */
	dev_t dev;
537
538
539
540
541
542

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

	/** number of dentries used in the above array */
	int ctl_ndents;
543
544
545

	/** O_ASYNC requests */
	struct fasync_struct *fasync;
546
547
548

	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
549
550
551

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
552
553
554

	/** Version counter for attribute changes */
	u64 attr_version;
Tejun Heo's avatar
Tejun Heo committed
555
556
557

	/** Called on final put */
	void (*release)(struct fuse_conn *);
John Muir's avatar
John Muir committed
558
559
560
561
562
563

	/** 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
564
565
566
567
};

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

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

586
/** Device operations */
587
extern const struct file_operations fuse_dev_operations;
588

Al Viro's avatar
Al Viro committed
589
extern const struct dentry_operations fuse_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
590

John Muir's avatar
John Muir committed
591
592
593
594
595
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

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

603
604
605
int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
		     struct fuse_entry_out *outarg, struct inode **inode);

606
607
608
/**
 * Send FORGET command
 */
609
610
611
612
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);
613

614
615
616
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

617
/**
618
 * Initialize READ or READDIR request
619
 */
620
void fuse_read_fill(struct fuse_req *req, struct file *file,
621
		    loff_t pos, size_t count, int opcode);
622
623
624
625

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

Tejun Heo's avatar
Tejun Heo committed
628
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
629
struct fuse_file *fuse_file_get(struct fuse_file *ff);
630
void fuse_file_free(struct fuse_file *ff);
631
void fuse_finish_open(struct inode *inode, struct file *file);
632

633
void fuse_sync_release(struct fuse_file *ff, int flags);
634

635
636
637
/**
 * Send RELEASE or RELEASEDIR request
 */
638
void fuse_release_common(struct file *file, int opcode);
639

640
641
642
/**
 * Send FSYNC or FSYNCDIR request
 */
643
644
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
645

Tejun Heo's avatar
Tejun Heo committed
646
647
648
649
650
651
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

652
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
653
 * Initialize file operations on a regular file
654
655
656
 */
void fuse_init_file_inode(struct inode *inode);

657
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
658
 * Initialize inode operations on regular files and special files
659
660
661
662
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
663
 * Initialize inode and file operations on a directory
664
665
666
667
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
668
 * Initialize inode operations on a symlink
669
670
671
672
673
674
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
675
676
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
677

Miklos Szeredi's avatar
Miklos Szeredi committed
678
679
680
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

681
682
683
684
685
686
687
688
689
690
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

691
692
693
int fuse_ctl_init(void);
void fuse_ctl_cleanup(void);

694
695
696
/**
 * Allocate a request
 */
697
struct fuse_req *fuse_request_alloc(unsigned npages);
698

699
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
Miklos Szeredi's avatar
Miklos Szeredi committed
700

701
702
703
704
705
706
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

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

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

723
724
725
/**
 * Gets a requests for a file operation, always succeeds
 */
726
727
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
728

729
/**
730
731
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
732
733
734
735
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
736
 * Send a request (synchronous)
737
 */
738
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
739
740
741
742

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

745
746
void fuse_request_send_background_locked(struct fuse_conn *fc,
					 struct fuse_req *req);
Miklos Szeredi's avatar
Miklos Szeredi committed
747

748
/* Abort all requests */
749
750
void fuse_abort_conn(struct fuse_conn *fc);

751
752
753
754
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
755

Miklos Szeredi's avatar
Miklos Szeredi committed
756
757
void fuse_invalidate_entry_cache(struct dentry *entry);

758
759
760
761
762
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

763
764
void fuse_conn_kill(struct fuse_conn *fc);

765
766
767
/**
 * Initialize fuse_conn
 */
768
void fuse_conn_init(struct fuse_conn *fc);
769

770
771
772
773
774
775
776
777
778
779
780
781
782
783
/**
 * 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);
784
785
786
787
788

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

/**
791
 * Is current process allowed to perform filesystem operation?
Miklos Szeredi's avatar
Miklos Szeredi committed
792
 */
793
int fuse_allow_current_process(struct fuse_conn *fc);
794
795

u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
Miklos Szeredi's avatar
Miklos Szeredi committed
796
797
798

int fuse_update_attributes(struct inode *inode, struct kstat *stat,
			   struct file *file, bool *refreshed);
Miklos Szeredi's avatar
Miklos Szeredi committed
799
800
801
802
803

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
804
805

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

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

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

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