fuse_i.h 21 KB
Newer Older
Miklos Szeredi's avatar
Miklos Szeredi committed
1
2
/*
  FUSE: Filesystem in Userspace
Miklos Szeredi's avatar
Miklos Szeredi committed
3
  Copyright (C) 2001-2008  Miklos Szeredi <miklos@szeredi.hu>
Miklos Szeredi's avatar
Miklos Szeredi committed
4
5
6
7
8

  This program can be distributed under the terms of the GNU GPL.
  See the file COPYING.
*/

Tejun Heo's avatar
Tejun Heo committed
9
10
11
#ifndef _FS_FUSE_I_H
#define _FS_FUSE_I_H

Miklos Szeredi's avatar
Miklos Szeredi committed
12
13
#include <linux/fuse.h>
#include <linux/fs.h>
14
#include <linux/mount.h>
Miklos Szeredi's avatar
Miklos Szeredi committed
15
16
17
18
19
#include <linux/wait.h>
#include <linux/list.h>
#include <linux/spinlock.h>
#include <linux/mm.h>
#include <linux/backing-dev.h>
20
#include <linux/mutex.h>
Miklos Szeredi's avatar
Miklos Szeredi committed
21
#include <linux/rwsem.h>
Tejun Heo's avatar
Tejun Heo committed
22
23
#include <linux/rbtree.h>
#include <linux/poll.h>
24
#include <linux/workqueue.h>
Miklos Szeredi's avatar
Miklos Szeredi committed
25

26
27
28
/** Max number of pages that can be used in a single read request */
#define FUSE_MAX_PAGES_PER_REQ 32

Miklos Szeredi's avatar
Miklos Szeredi committed
29
30
31
/** Bias for fi->writectr, meaning new writepages must not be sent */
#define FUSE_NOWRITE INT_MIN

32
33
34
/** It could be as large as PATH_MAX, but would that have any uses? */
#define FUSE_NAME_MAX 1024

35
/** Number of dentries for each connection in the control filesystem */
36
#define FUSE_CTL_NUM_DENTRIES 5
37

Miklos Szeredi's avatar
Miklos Szeredi committed
38
39
40
41
42
43
44
45
46
/** If the FUSE_DEFAULT_PERMISSIONS flag is given, the filesystem
    module will check permissions based on the file mode.  Otherwise no
    permission checking is done in the kernel */
#define FUSE_DEFAULT_PERMISSIONS (1 << 0)

/** If the FUSE_ALLOW_OTHER flag is given, then not only the user
    doing the mount will be allowed to access the filesystem */
#define FUSE_ALLOW_OTHER         (1 << 1)

47
48
49
/** Number of page pointers embedded in fuse_req */
#define FUSE_REQ_INLINE_PAGES 1

50
51
52
53
54
/** List of active connections */
extern struct list_head fuse_conn_list;

/** Global mutex protecting fuse_conn_list and the control filesystem */
extern struct mutex fuse_mutex;
Miklos Szeredi's avatar
Miklos Szeredi committed
55

56
57
58
59
/** Module parameters */
extern unsigned max_user_bgreq;
extern unsigned max_user_congthresh;

60
61
/* One forget request */
struct fuse_forget_link {
62
	struct fuse_forget_one forget_one;
63
64
65
	struct fuse_forget_link *next;
};

Miklos Szeredi's avatar
Miklos Szeredi committed
66
67
68
69
70
71
72
73
74
/** FUSE inode */
struct fuse_inode {
	/** Inode data */
	struct inode inode;

	/** Unique ID, which identifies the inode between userspace
	 * and kernel */
	u64 nodeid;

75
76
77
	/** Number of lookups on this inode */
	u64 nlookup;

78
	/** The request used for sending the FORGET message */
79
	struct fuse_forget_link *forget;
80

Miklos Szeredi's avatar
Miklos Szeredi committed
81
	/** Time in jiffies until the file attributes are valid */
Miklos Szeredi's avatar
Miklos Szeredi committed
82
	u64 i_time;
83
84
85

	/** The sticky bit in inode->i_mode may have been removed, so
	    preserve the original mode */
Al Viro's avatar
Al Viro committed
86
	umode_t orig_i_mode;
87

88
89
90
	/** 64 bit inode number */
	u64 orig_ino;

91
92
	/** Version of last attribute change */
	u64 attr_version;
93
94
95

	/** Files usable in writepage.  Protected by fc->lock */
	struct list_head write_files;
Miklos Szeredi's avatar
Miklos Szeredi committed
96
97
98
99
100
101
102
103
104
105
106
107
108

	/** Writepages pending on truncate or fsync */
	struct list_head queued_writes;

	/** Number of sent writes, a negative bias (FUSE_NOWRITE)
	 * means more writes are blocked */
	int writectr;

	/** Waitq for writepage completion */
	wait_queue_head_t page_waitq;

	/** List of writepage requestst (pending or sent) */
	struct list_head writepages;
109
110
111
112
113
114
115
116
117

	/** Miscellaneous bits describing inode state */
	unsigned long state;
};

/** FUSE inode state bits */
enum {
	/** Advise readdirplus  */
	FUSE_I_ADVISE_RDPLUS,
118
119
	/** Initialized with readdirplus */
	FUSE_I_INIT_RDPLUS,
120
121
	/** An operation changing file size is in progress  */
	FUSE_I_SIZE_UNSTABLE,
Miklos Szeredi's avatar
Miklos Szeredi committed
122
123
};

124
125
struct fuse_conn;

126
127
/** FUSE specific file data */
struct fuse_file {
128
129
130
	/** Fuse connection for this file */
	struct fuse_conn *fc;

131
	/** Request reserved for flush and release */
132
	struct fuse_req *reserved_req;
133

Tejun Heo's avatar
Tejun Heo committed
134
135
136
	/** Kernel file handle guaranteed to be unique */
	u64 kh;

137
138
	/** File handle used by userspace */
	u64 fh;
139

140
141
142
	/** Node id of this file */
	u64 nodeid;

143
144
	/** Refcount */
	atomic_t count;
145

146
147
148
	/** FOPEN_* flags returned by open */
	u32 open_flags;

149
150
	/** Entry on inode's write_files list */
	struct list_head write_entry;
Tejun Heo's avatar
Tejun Heo committed
151
152
153
154
155
156

	/** 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
157
158
159

	/** Has flock been performed on this file? */
	bool flock:1;
160
161
};

162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
/** 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;

194
195
196
197
198
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

199
200
201
202
203
204
205
206
207
208
	/** 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;

209
210
211
	/** Pages may be replaced with new ones */
	unsigned page_replace:1;

212
213
214
215
216
217
218
	/** Number or arguments */
	unsigned numargs;

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

219
220
221
222
223
224
/** FUSE page descriptor */
struct fuse_page_desc {
	unsigned int length;
	unsigned int offset;
};

225
226
227
228
229
230
/** The request state */
enum fuse_req_state {
	FUSE_REQ_INIT = 0,
	FUSE_REQ_PENDING,
	FUSE_REQ_READING,
	FUSE_REQ_SENT,
231
	FUSE_REQ_WRITING,
232
233
234
	FUSE_REQ_FINISHED
};

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

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

257
258
259
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

260
261
262
	/** refcount */
	atomic_t count;

263
264
265
	/** Unique ID for the interrupt request */
	u64 intr_unique;

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

272
273
274
	/** True if the request has reply */
	unsigned isreply:1;

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

278
279
	/** The request was aborted */
	unsigned aborted:1;
280
281
282
283

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

284
285
286
	/** The request has been interrupted */
	unsigned interrupted:1;

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

290
291
292
	/** Request is counted as "waiting" */
	unsigned waiting:1;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Miklos Szeredi's avatar
Miklos Szeredi committed
364
365
366
367
368
369
370
371
/**
 * A Fuse connection.
 *
 * This structure is created, when the filesystem is mounted, and is
 * destroyed, when the client device is closed and the filesystem is
 * unmounted.
 */
struct fuse_conn {
372
373
374
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

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

Al Viro's avatar
Al Viro committed
378
379
	struct rcu_head rcu;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

480
481
482
	/** write-back cache policy (default is write-through) */
	unsigned writeback_cache:1;

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

488
489
490
	/** Is open/release not implemented by fs? */
	unsigned no_open:1;

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

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

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

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

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

	/** Is listxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
507
	unsigned no_listxattr:1;
508
509

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

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

Miklos Szeredi's avatar
Miklos Szeredi committed
515
	/** Is access not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
516
	unsigned no_access:1;
Miklos Szeredi's avatar
Miklos Szeredi committed
517

518
	/** Is create not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
519
	unsigned no_create:1;
520

521
	/** Is interrupt not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
522
	unsigned no_interrupt:1;
523

524
	/** Is bmap not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
525
	unsigned no_bmap:1;
526

Tejun Heo's avatar
Tejun Heo committed
527
528
529
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

530
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
531
	unsigned big_writes:1;
532

533
534
535
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
536
537
538
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

539
540
541
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
542
543
544
	/** Is rename with flags implemented by fs? */
	unsigned no_rename2:1;

545
546
547
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

548
	/** Does the filesystem support readdirplus? */
549
550
	unsigned do_readdirplus:1;

551
552
553
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

554
555
556
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

557
558
559
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

560
561
562
	/** Negotiated minor version */
	unsigned minor;

Miklos Szeredi's avatar
Miklos Szeredi committed
563
564
	/** Backing dev info */
	struct backing_dev_info bdi;
565

566
567
568
	/** Entry on the fuse_conn_list */
	struct list_head entry;

569
570
	/** Device ID from super block */
	dev_t dev;
571
572
573
574
575
576

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

	/** number of dentries used in the above array */
	int ctl_ndents;
577
578
579

	/** O_ASYNC requests */
	struct fasync_struct *fasync;
580
581
582

	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
583
584
585

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
586
587
588

	/** Version counter for attribute changes */
	u64 attr_version;
Tejun Heo's avatar
Tejun Heo committed
589
590
591

	/** Called on final put */
	void (*release)(struct fuse_conn *);
John Muir's avatar
John Muir committed
592
593
594
595
596
597

	/** 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
598
599
600
601
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
602
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
}

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

620
/** Device operations */
621
extern const struct file_operations fuse_dev_operations;
622

Al Viro's avatar
Al Viro committed
623
extern const struct dentry_operations fuse_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
624

John Muir's avatar
John Muir committed
625
626
627
628
629
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

630
631
632
/**
 * Get a filled in inode
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
633
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
634
635
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
636

637
638
639
int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
		     struct fuse_entry_out *outarg, struct inode **inode);

640
641
642
/**
 * Send FORGET command
 */
643
644
645
646
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);
647

648
649
650
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

651
/**
652
 * Initialize READ or READDIR request
653
 */
654
void fuse_read_fill(struct fuse_req *req, struct file *file,
655
		    loff_t pos, size_t count, int opcode);
656
657
658
659

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

Tejun Heo's avatar
Tejun Heo committed
662
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
663
struct fuse_file *fuse_file_get(struct fuse_file *ff);
664
void fuse_file_free(struct fuse_file *ff);
665
void fuse_finish_open(struct inode *inode, struct file *file);
666

667
void fuse_sync_release(struct fuse_file *ff, int flags);
668

669
670
671
/**
 * Send RELEASE or RELEASEDIR request
 */
672
void fuse_release_common(struct file *file, int opcode);
673

674
675
676
/**
 * Send FSYNC or FSYNCDIR request
 */
677
678
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
679

Tejun Heo's avatar
Tejun Heo committed
680
681
682
683
684
685
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

686
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
687
 * Initialize file operations on a regular file
688
689
690
 */
void fuse_init_file_inode(struct inode *inode);

691
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
692
 * Initialize inode operations on regular files and special files
693
694
695
696
 */
void fuse_init_common(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
697
 * Initialize inode and file operations on a directory
698
699
700
701
 */
void fuse_init_dir(struct inode *inode);

/**
Miklos Szeredi's avatar
Miklos Szeredi committed
702
 * Initialize inode operations on a symlink
703
704
705
706
707
708
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
709
710
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
711

Miklos Szeredi's avatar
Miklos Szeredi committed
712
713
714
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

715
716
717
718
719
720
721
722
723
724
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

725
int fuse_ctl_init(void);
726
void __exit fuse_ctl_cleanup(void);
727

728
729
730
/**
 * Allocate a request
 */
731
struct fuse_req *fuse_request_alloc(unsigned npages);
732

733
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
Miklos Szeredi's avatar
Miklos Szeredi committed
734

735
736
737
738
739
740
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
741
742
 * Get a request, may fail with -ENOMEM,
 * caller should specify # elements in req->pages[] explicitly
743
 */
744
struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
745
746
struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
					     unsigned npages);
747

748
749
750
751
752
/*
 * Increment reference count on request
 */
void __fuse_get_request(struct fuse_req *req);

753
754
755
756
757
758
759
760
/**
 * 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);
}
761

762
763
764
/**
 * Gets a requests for a file operation, always succeeds
 */
765
766
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
767

768
/**
769
770
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
771
772
773
774
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
775
 * Send a request (synchronous)
776
 */
777
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
778
779
780
781

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

784
785
void fuse_request_send_background_locked(struct fuse_conn *fc,
					 struct fuse_req *req);
Miklos Szeredi's avatar
Miklos Szeredi committed
786

787
/* Abort all requests */
788
789
void fuse_abort_conn(struct fuse_conn *fc);

790
791
792
793
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
794

Miklos Szeredi's avatar
Miklos Szeredi committed
795
796
void fuse_invalidate_entry_cache(struct dentry *entry);

797
798
void fuse_invalidate_atime(struct inode *inode);

799
800
801
802
803
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

804
805
806
/**
 * Initialize fuse_conn
 */
807
void fuse_conn_init(struct fuse_conn *fc);
808

809
810
811
812
813
814
815
816
817
818
819
820
821
822
/**
 * 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);
823
824
825
826
827

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

/**
830
 * Is current process allowed to perform filesystem operation?
Miklos Szeredi's avatar
Miklos Szeredi committed
831
 */
832
int fuse_allow_current_process(struct fuse_conn *fc);
833
834

u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
Miklos Szeredi's avatar
Miklos Szeredi committed
835
836
837

int fuse_update_attributes(struct inode *inode, struct kstat *stat,
			   struct file *file, bool *refreshed);
Miklos Szeredi's avatar
Miklos Szeredi committed
838
839
840
841
842

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
843
844

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

John Muir's avatar
John Muir committed
846
847
848
849
850
851
852
853
854
/**
 * 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.
855
856
857
858
859
860
 *
 * 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
861
862
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
863
			     u64 child_nodeid, struct qstr *name);
John Muir's avatar
John Muir committed
864

865
866
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
867
868
869
870
871
872
873
874
875
876
877

/**
 * fuse_direct_io() flags
 */

/** If set, it is WRITE; otherwise - READ */
#define FUSE_DIO_WRITE (1 << 0)

/** CUSE pass fuse_direct_io() a file which f_mapping->host is not from FUSE */
#define FUSE_DIO_CUSE  (1 << 1)

878
879
ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
		       loff_t *ppos, int flags);
880
881
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
882
883
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
884
885
886
unsigned fuse_file_poll(struct file *file, poll_table *wait);
int fuse_dev_release(struct inode *inode, struct file *file);

887
888
bool fuse_write_update_size(struct inode *inode, loff_t pos);

889
int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
Miklos Szeredi's avatar
Miklos Szeredi committed
890
int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
Miklos Szeredi's avatar
Miklos Szeredi committed
891

892
893
894
int fuse_do_setattr(struct inode *inode, struct iattr *attr,
		    struct file *file);

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