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

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

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

253
254
255
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

256
257
258
	/** refcount */
	atomic_t count;

259
260
261
	/** Unique ID for the interrupt request */
	u64 intr_unique;

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

268
269
270
	/** True if the request has reply */
	unsigned isreply:1;

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

274
275
	/** The request was aborted */
	unsigned aborted:1;
276
277
278
279

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

280
281
282
	/** The request has been interrupted */
	unsigned interrupted:1;

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

286
287
288
	/** Request is counted as "waiting" */
	unsigned waiting:1;

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

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

	/** page vector */
326
327
	struct page **pages;

328
329
330
	/** page-descriptor vector */
	struct fuse_page_desc *page_descs;

331
332
333
334
335
	/** size of the 'pages' array */
	unsigned max_pages;

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

337
338
339
	/** inline page-descriptor vector */
	struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];

340
341
342
343
	/** number of pages in vector */
	unsigned num_pages;

	/** File used in the request (or NULL) */
344
	struct fuse_file *ff;
345

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

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

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

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

	/** Request is stolen from fuse_file->reserved_req */
	struct file *stolen_file;
360
361
};

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

373
374
375
	/** Mutex protecting against directory alias creation */
	struct mutex inst_mutex;

376
377
378
	/** Refcount */
	atomic_t count;

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

382
	/** The group id for this mount */
383
	kgid_t group_id;
384

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

388
389
390
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
391
392
393
	/** Maximum write size */
	unsigned max_write;

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

403
404
405
	/** The list of requests under I/O */
	struct list_head io;

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

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

412
413
414
415
416
417
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

418
419
420
	/** Number of requests currently in the background */
	unsigned num_background;

421
422
423
424
425
426
	/** 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;

427
428
429
	/** Pending interrupts */
	struct list_head interrupts;

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

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

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

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

452
453
454
	/** The next unique request id */
	u64 reqctr;

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

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

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

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

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

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

476
477
478
	/** Set if bdi is valid */
	unsigned bdi_initialized:1;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

532
533
534
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

535
536
537
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

538
	/** Does the filesystem support readdirplus? */
539
540
	unsigned do_readdirplus:1;

541
542
543
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

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

547
548
549
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

550
551
552
	/** Negotiated minor version */
	unsigned minor;

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

556
557
558
	/** Entry on the fuse_conn_list */
	struct list_head entry;

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

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

	/** number of dentries used in the above array */
	int ctl_ndents;
567
568
569

	/** O_ASYNC requests */
	struct fasync_struct *fasync;
570
571
572

	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
573
574
575

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
576
577
578

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

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

	/** 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
588
589
590
591
};

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

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

610
/** Device operations */
611
extern const struct file_operations fuse_dev_operations;
612

Al Viro's avatar
Al Viro committed
613
extern const struct dentry_operations fuse_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
614

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

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

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

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

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

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

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

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

657
void fuse_sync_release(struct fuse_file *ff, int flags);
658

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

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

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

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

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

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

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

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

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

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

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

715
716
717
int fuse_ctl_init(void);
void fuse_ctl_cleanup(void);

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

723
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
Miklos Szeredi's avatar
Miklos Szeredi committed
724

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

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

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

743
744
745
746
747
748
749
750
/**
 * 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);
}
751

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

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

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

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

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

777
/* Abort all requests */
778
779
void fuse_abort_conn(struct fuse_conn *fc);

780
781
782
783
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
784

Miklos Szeredi's avatar
Miklos Szeredi committed
785
786
void fuse_invalidate_entry_cache(struct dentry *entry);

787
788
789
790
791
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

792
793
void fuse_conn_kill(struct fuse_conn *fc);

794
795
796
/**
 * Initialize fuse_conn
 */
797
void fuse_conn_init(struct fuse_conn *fc);
798

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

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

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

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

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

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
833
834

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

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

855
856
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
857
ssize_t fuse_direct_io(struct fuse_io_priv *io, const struct iovec *iov,
858
859
		       unsigned long nr_segs, size_t count, loff_t *ppos,
		       int write);
860
861
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
862
863
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
864
865
866
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
867
868
void fuse_write_update_size(struct inode *inode, loff_t pos);

869
870
871
int fuse_do_setattr(struct inode *inode, struct iattr *attr,
		    struct file *file);

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