fuse_i.h 22.8 KB
Newer Older
M
Miklos Szeredi 已提交
1 2
/*
  FUSE: Filesystem in Userspace
M
Miklos Szeredi 已提交
3
  Copyright (C) 2001-2008  Miklos Szeredi <miklos@szeredi.hu>
M
Miklos Szeredi 已提交
4 5 6 7 8

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

T
Tejun Heo 已提交
9 10 11
#ifndef _FS_FUSE_I_H
#define _FS_FUSE_I_H

M
Miklos Szeredi 已提交
12 13
#include <linux/fuse.h>
#include <linux/fs.h>
14
#include <linux/mount.h>
M
Miklos Szeredi 已提交
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>
M
Miklos Szeredi 已提交
21
#include <linux/rwsem.h>
T
Tejun Heo 已提交
22 23
#include <linux/rbtree.h>
#include <linux/poll.h>
24
#include <linux/workqueue.h>
25
#include <linux/kref.h>
M
Miklos Szeredi 已提交
26

M
Miklos Szeredi 已提交
27 28 29
/** Max number of pages that can be used in a single read request */
#define FUSE_MAX_PAGES_PER_REQ 32

M
Miklos Szeredi 已提交
30 31 32
/** Bias for fi->writectr, meaning new writepages must not be sent */
#define FUSE_NOWRITE INT_MIN

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

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

M
Miklos Szeredi 已提交
39 40 41 42 43 44 45 46 47
/** 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)

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

51 52 53 54 55
/** 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;
M
Miklos Szeredi 已提交
56

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

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

M
Miklos Szeredi 已提交
67 68 69 70 71 72 73 74 75
/** FUSE inode */
struct fuse_inode {
	/** Inode data */
	struct inode inode;

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

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

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

M
Miklos Szeredi 已提交
82
	/** Time in jiffies until the file attributes are valid */
M
Miklos Szeredi 已提交
83
	u64 i_time;
84 85 86

	/** The sticky bit in inode->i_mode may have been removed, so
	    preserve the original mode */
A
Al Viro 已提交
87
	umode_t orig_i_mode;
88

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

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

	/** Files usable in writepage.  Protected by fc->lock */
	struct list_head write_files;
M
Miklos Szeredi 已提交
97 98 99 100 101 102 103 104 105 106 107 108 109

	/** 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;
110 111 112

	/** Miscellaneous bits describing inode state */
	unsigned long state;
113 114 115

	/** Lock for serializing lookup and readdir for back compatibility*/
	struct mutex mutex;
116 117 118 119 120 121
};

/** FUSE inode state bits */
enum {
	/** Advise readdirplus  */
	FUSE_I_ADVISE_RDPLUS,
M
Miklos Szeredi 已提交
122 123
	/** Initialized with readdirplus */
	FUSE_I_INIT_RDPLUS,
124 125
	/** An operation changing file size is in progress  */
	FUSE_I_SIZE_UNSTABLE,
M
Miklos Szeredi 已提交
126 127
};

128 129
struct fuse_conn;

M
Miklos Szeredi 已提交
130 131
/** FUSE specific file data */
struct fuse_file {
132 133 134
	/** Fuse connection for this file */
	struct fuse_conn *fc;

M
Miklos Szeredi 已提交
135
	/** Request reserved for flush and release */
136
	struct fuse_req *reserved_req;
M
Miklos Szeredi 已提交
137

T
Tejun Heo 已提交
138 139 140
	/** Kernel file handle guaranteed to be unique */
	u64 kh;

M
Miklos Szeredi 已提交
141 142
	/** File handle used by userspace */
	u64 fh;
143

144 145 146
	/** Node id of this file */
	u64 nodeid;

147 148
	/** Refcount */
	atomic_t count;
149

150 151 152
	/** FOPEN_* flags returned by open */
	u32 open_flags;

153 154
	/** Entry on inode's write_files list */
	struct list_head write_entry;
T
Tejun Heo 已提交
155 156 157 158 159 160

	/** 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;
M
Miklos Szeredi 已提交
161 162 163

	/** Has flock been performed on this file? */
	bool flock:1;
M
Miklos Szeredi 已提交
164 165
};

M
Miklos Szeredi 已提交
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 194 195 196 197
/** 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;

M
Miklos Szeredi 已提交
198 199 200 201 202
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

M
Miklos Szeredi 已提交
203 204 205 206 207 208 209 210 211 212
	/** 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;

213 214 215
	/** Pages may be replaced with new ones */
	unsigned page_replace:1;

M
Miklos Szeredi 已提交
216 217 218 219
	/** Number or arguments */
	unsigned numargs;

	/** Array of arguments */
M
Miklos Szeredi 已提交
220
	struct fuse_arg args[2];
M
Miklos Szeredi 已提交
221 222
};

223 224 225 226 227 228
/** FUSE page descriptor */
struct fuse_page_desc {
	unsigned int length;
	unsigned int offset;
};

229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
struct fuse_args {
	struct {
		struct {
			uint32_t opcode;
			uint64_t nodeid;
		} h;
		unsigned numargs;
		struct fuse_in_arg args[3];

	} in;
	struct {
		unsigned argvar:1;
		unsigned numargs;
		struct fuse_arg args[2];
	} out;
};

#define FUSE_ARGS(args) struct fuse_args args = {}

M
Maxim Patlasov 已提交
248 249
/** The request IO state (for asynchronous processing) */
struct fuse_io_priv {
250
	struct kref refcnt;
M
Maxim Patlasov 已提交
251 252 253 254 255 256 257 258 259 260
	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;
261
	struct completion *done;
262
	bool blocking;
M
Maxim Patlasov 已提交
263 264
};

265 266 267 268 269 270 271
#define FUSE_IO_PRIV_SYNC(f) \
{					\
	.refcnt = { ATOMIC_INIT(1) },	\
	.async = 0,			\
	.file = f,			\
}

M
Miklos Szeredi 已提交
272 273 274 275 276 277 278 279 280 281
/**
 * Request flags
 *
 * FR_ISREPLY:		set if the request has reply
 * FR_FORCE:		force sending of the request even if interrupted
 * FR_BACKGROUND:	request is sent in the background
 * FR_WAITING:		request is counted as "waiting"
 * FR_ABORTED:		the request was aborted
 * FR_INTERRUPTED:	the request has been interrupted
 * FR_LOCKED:		data is being copied to/from the request
M
Miklos Szeredi 已提交
282 283 284
 * FR_PENDING:		request is not yet in userspace
 * FR_SENT:		request is in userspace, waiting for an answer
 * FR_FINISHED:		request is finished
285
 * FR_PRIVATE:		request is on private list
M
Miklos Szeredi 已提交
286 287 288 289 290 291 292 293 294
 */
enum fuse_req_flag {
	FR_ISREPLY,
	FR_FORCE,
	FR_BACKGROUND,
	FR_WAITING,
	FR_ABORTED,
	FR_INTERRUPTED,
	FR_LOCKED,
M
Miklos Szeredi 已提交
295 296 297
	FR_PENDING,
	FR_SENT,
	FR_FINISHED,
298
	FR_PRIVATE,
M
Miklos Szeredi 已提交
299 300
};

M
Miklos Szeredi 已提交
301 302
/**
 * A request to the client
303 304 305 306
 *
 * .waitq.lock protects the following fields:
 *   - FR_ABORTED
 *   - FR_LOCKED (may also be modified under fc->lock, tested under both)
M
Miklos Szeredi 已提交
307 308
 */
struct fuse_req {
309 310
	/** This can be on either pending processing or io lists in
	    fuse_conn */
M
Miklos Szeredi 已提交
311 312
	struct list_head list;

313 314 315
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

M
Miklos Szeredi 已提交
316 317 318
	/** refcount */
	atomic_t count;

319 320 321
	/** Unique ID for the interrupt request */
	u64 intr_unique;

M
Miklos Szeredi 已提交
322 323
	/* Request flags, updated with test/set/clear_bit() */
	unsigned long flags;
324

M
Miklos Szeredi 已提交
325 326 327 328 329 330 331 332 333 334 335
	/** 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 {
336
		struct {
337 338
			struct fuse_release_in in;
			struct inode *inode;
339
		} release;
340 341
		struct fuse_init_in init_in;
		struct fuse_init_out init_out;
342
		struct cuse_init_in cuse_init_in;
343 344 345 346
		struct {
			struct fuse_read_in in;
			u64 attr_ver;
		} read;
347 348 349
		struct {
			struct fuse_write_in in;
			struct fuse_write_out out;
350
			struct fuse_req *next;
351
		} write;
M
Miklos Szeredi 已提交
352
		struct fuse_notify_retrieve_in retrieve_in;
M
Miklos Szeredi 已提交
353 354 355
	} misc;

	/** page vector */
356 357
	struct page **pages;

358 359 360
	/** page-descriptor vector */
	struct fuse_page_desc *page_descs;

361 362 363 364 365
	/** size of the 'pages' array */
	unsigned max_pages;

	/** inline page vector */
	struct page *inline_pages[FUSE_REQ_INLINE_PAGES];
M
Miklos Szeredi 已提交
366

367 368 369
	/** inline page-descriptor vector */
	struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];

M
Miklos Szeredi 已提交
370 371 372 373
	/** number of pages in vector */
	unsigned num_pages;

	/** File used in the request (or NULL) */
374
	struct fuse_file *ff;
375

M
Miklos Szeredi 已提交
376 377 378
	/** Inode used in the request or NULL */
	struct inode *inode;

M
Maxim Patlasov 已提交
379 380 381
	/** AIO control block */
	struct fuse_io_priv *io;

M
Miklos Szeredi 已提交
382 383 384
	/** Link on fi->writepages */
	struct list_head writepages_entry;

385 386
	/** Request completion callback */
	void (*end)(struct fuse_conn *, struct fuse_req *);
387 388 389

	/** Request is stolen from fuse_file->reserved_req */
	struct file *stolen_file;
M
Miklos Szeredi 已提交
390 391
};

M
Miklos Szeredi 已提交
392
struct fuse_iqueue {
393 394 395
	/** Connection established */
	unsigned connected;

M
Miklos Szeredi 已提交
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
	/** Readers of the connection are waiting on this */
	wait_queue_head_t waitq;

	/** The next unique request id */
	u64 reqctr;

	/** The list of pending requests */
	struct list_head pending;

	/** Pending interrupts */
	struct list_head interrupts;

	/** 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;

	/** O_ASYNC requests */
	struct fasync_struct *fasync;
};

419
struct fuse_pqueue {
420 421 422
	/** Connection established */
	unsigned connected;

M
Miklos Szeredi 已提交
423 424 425
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

426 427 428 429 430 431 432
	/** The list of requests being processed */
	struct list_head processing;

	/** The list of requests under I/O */
	struct list_head io;
};

433 434 435 436 437 438 439
/**
 * Fuse device instance
 */
struct fuse_dev {
	/** Fuse connection for this device */
	struct fuse_conn *fc;

440 441 442
	/** Processing queue */
	struct fuse_pqueue pq;

443 444 445 446
	/** list entry on fc->devices */
	struct list_head entry;
};

M
Miklos Szeredi 已提交
447 448 449 450 451 452 453 454
/**
 * 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 {
455 456 457
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

458 459 460
	/** Refcount */
	atomic_t count;

461 462 463
	/** Number of fuse_dev's */
	atomic_t dev_count;

A
Al Viro 已提交
464 465
	struct rcu_head rcu;

M
Miklos Szeredi 已提交
466
	/** The user id for this mount */
467
	kuid_t user_id;
M
Miklos Szeredi 已提交
468

469
	/** The group id for this mount */
470
	kgid_t group_id;
471

M
Miklos Szeredi 已提交
472 473 474
	/** The fuse mount flags for this mount */
	unsigned flags;

475 476 477
	/** Maximum read size */
	unsigned max_read;

M
Miklos Szeredi 已提交
478 479 480
	/** Maximum write size */
	unsigned max_write;

M
Miklos Szeredi 已提交
481 482
	/** Input queue */
	struct fuse_iqueue iq;
M
Miklos Szeredi 已提交
483

T
Tejun Heo 已提交
484 485 486
	/** The next unique kernel file handle */
	u64 khctr;

T
Tejun Heo 已提交
487 488 489
	/** rbtree of fuse_files waiting for poll events indexed by ph */
	struct rb_root polled_files;

490 491 492 493 494 495
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

496 497 498
	/** Number of requests currently in the background */
	unsigned num_background;

499 500 501 502 503 504
	/** 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;

M
Maxim Patlasov 已提交
505 506 507 508
	/** Flag indicating that INIT reply has been received. Allocating
	 * any fuse request will be suspended until the flag is set */
	int initialized;

509 510 511 512 513 514 515
	/** 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;
516 517 518

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

520 521
	/** Connection established, cleared on umount, connection
	    abort and device release */
M
Miklos Szeredi 已提交
522
	unsigned connected;
M
Miklos Szeredi 已提交
523

M
Miklos Szeredi 已提交
524 525 526
	/** 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 */
M
Miklos Szeredi 已提交
527
	unsigned conn_error:1;
M
Miklos Szeredi 已提交
528

529
	/** Connection successful.  Only set in INIT */
M
Miklos Szeredi 已提交
530
	unsigned conn_init:1;
531

532
	/** Do readpages asynchronously?  Only set in INIT */
M
Miklos Szeredi 已提交
533
	unsigned async_read:1;
534

535
	/** Do not send separate SETATTR request before open(O_TRUNC)  */
M
Miklos Szeredi 已提交
536
	unsigned atomic_o_trunc:1;
537

538
	/** Filesystem supports NFS exporting.  Only set in INIT */
M
Miklos Szeredi 已提交
539
	unsigned export_support:1;
540

541 542 543
	/** Set if bdi is valid */
	unsigned bdi_initialized:1;

544 545 546
	/** write-back cache policy (default is write-through) */
	unsigned writeback_cache:1;

547 548 549
	/** allow parallel lookups and readdir (default is serialized) */
	unsigned parallel_dirops:1;

M
Miklos Szeredi 已提交
550 551 552 553 554
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

555 556 557
	/** Is open/release not implemented by fs? */
	unsigned no_open:1;

M
Miklos Szeredi 已提交
558
	/** Is fsync not implemented by fs? */
M
Miklos Szeredi 已提交
559
	unsigned no_fsync:1;
M
Miklos Szeredi 已提交
560

561
	/** Is fsyncdir not implemented by fs? */
M
Miklos Szeredi 已提交
562
	unsigned no_fsyncdir:1;
563

M
Miklos Szeredi 已提交
564
	/** Is flush not implemented by fs? */
M
Miklos Szeredi 已提交
565
	unsigned no_flush:1;
M
Miklos Szeredi 已提交
566

567
	/** Is setxattr not implemented by fs? */
M
Miklos Szeredi 已提交
568
	unsigned no_setxattr:1;
569 570

	/** Is getxattr not implemented by fs? */
M
Miklos Szeredi 已提交
571
	unsigned no_getxattr:1;
572 573

	/** Is listxattr not implemented by fs? */
M
Miklos Szeredi 已提交
574
	unsigned no_listxattr:1;
575 576

	/** Is removexattr not implemented by fs? */
M
Miklos Szeredi 已提交
577
	unsigned no_removexattr:1;
578

M
Miklos Szeredi 已提交
579
	/** Are posix file locking primitives not implemented by fs? */
M
Miklos Szeredi 已提交
580
	unsigned no_lock:1;
581

M
Miklos Szeredi 已提交
582
	/** Is access not implemented by fs? */
M
Miklos Szeredi 已提交
583
	unsigned no_access:1;
M
Miklos Szeredi 已提交
584

M
Miklos Szeredi 已提交
585
	/** Is create not implemented by fs? */
M
Miklos Szeredi 已提交
586
	unsigned no_create:1;
M
Miklos Szeredi 已提交
587

588
	/** Is interrupt not implemented by fs? */
M
Miklos Szeredi 已提交
589
	unsigned no_interrupt:1;
590

M
Miklos Szeredi 已提交
591
	/** Is bmap not implemented by fs? */
M
Miklos Szeredi 已提交
592
	unsigned no_bmap:1;
M
Miklos Szeredi 已提交
593

T
Tejun Heo 已提交
594 595 596
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

597
	/** Do multi-page cached writes */
M
Miklos Szeredi 已提交
598
	unsigned big_writes:1;
599

600 601 602
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

M
Miklos Szeredi 已提交
603 604 605
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

606 607 608
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

M
Miklos Szeredi 已提交
609 610 611
	/** Is rename with flags implemented by fs? */
	unsigned no_rename2:1;

612 613 614
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

615
	/** Does the filesystem support readdirplus? */
616 617
	unsigned do_readdirplus:1;

618 619 620
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

621 622 623
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

624 625 626
	/** Is lseek not implemented by fs? */
	unsigned no_lseek:1;

627 628 629
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

630 631 632
	/** Negotiated minor version */
	unsigned minor;

M
Miklos Szeredi 已提交
633 634
	/** Backing dev info */
	struct backing_dev_info bdi;
635

636 637 638
	/** Entry on the fuse_conn_list */
	struct list_head entry;

639 640
	/** Device ID from super block */
	dev_t dev;
641 642 643 644 645 646

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

	/** number of dentries used in the above array */
	int ctl_ndents;
647

648 649
	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
650 651 652

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
653 654 655

	/** Version counter for attribute changes */
	u64 attr_version;
T
Tejun Heo 已提交
656 657 658

	/** Called on final put */
	void (*release)(struct fuse_conn *);
J
John Muir 已提交
659 660 661 662 663 664

	/** Super block for this connection. */
	struct super_block *sb;

	/** Read/write semaphore to hold when accessing sb. */
	struct rw_semaphore killsb;
665 666 667

	/** List of device instances belonging to this connection */
	struct list_head devices;
M
Miklos Szeredi 已提交
668 669 670 671
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
672
	return sb->s_fs_info;
M
Miklos Szeredi 已提交
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
}

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

M
Miklos Szeredi 已提交
690
/** Device operations */
691
extern const struct file_operations fuse_dev_operations;
M
Miklos Szeredi 已提交
692

A
Al Viro 已提交
693
extern const struct dentry_operations fuse_dentry_operations;
M
Miklos Szeredi 已提交
694

J
John Muir 已提交
695 696 697 698 699
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

700 701 702
/**
 * Get a filled in inode
 */
M
Miklos Szeredi 已提交
703
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
704 705
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
706

A
Al Viro 已提交
707
int fuse_lookup_name(struct super_block *sb, u64 nodeid, const struct qstr *name,
708 709
		     struct fuse_entry_out *outarg, struct inode **inode);

710 711 712
/**
 * Send FORGET command
 */
713 714 715 716
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);
717

718 719 720
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

721
/**
722
 * Initialize READ or READDIR request
723
 */
724
void fuse_read_fill(struct fuse_req *req, struct file *file,
725
		    loff_t pos, size_t count, int opcode);
726 727 728 729

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

T
Tejun Heo 已提交
732
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
733
struct fuse_file *fuse_file_get(struct fuse_file *ff);
M
Miklos Szeredi 已提交
734
void fuse_file_free(struct fuse_file *ff);
735
void fuse_finish_open(struct inode *inode, struct file *file);
M
Miklos Szeredi 已提交
736

737
void fuse_sync_release(struct fuse_file *ff, int flags);
738

739 740 741
/**
 * Send RELEASE or RELEASEDIR request
 */
742
void fuse_release_common(struct file *file, int opcode);
743

744 745 746
/**
 * Send FSYNC or FSYNCDIR request
 */
747 748
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
749

T
Tejun Heo 已提交
750 751 752 753 754 755
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

M
Miklos Szeredi 已提交
756
/**
M
Miklos Szeredi 已提交
757
 * Initialize file operations on a regular file
M
Miklos Szeredi 已提交
758 759 760
 */
void fuse_init_file_inode(struct inode *inode);

761
/**
M
Miklos Szeredi 已提交
762
 * Initialize inode operations on regular files and special files
763 764 765 766
 */
void fuse_init_common(struct inode *inode);

/**
M
Miklos Szeredi 已提交
767
 * Initialize inode and file operations on a directory
768 769 770 771
 */
void fuse_init_dir(struct inode *inode);

/**
M
Miklos Szeredi 已提交
772
 * Initialize inode operations on a symlink
773 774 775 776 777 778
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
779 780
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
781

M
Miklos Szeredi 已提交
782 783 784
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

M
Miklos Szeredi 已提交
785 786 787 788 789 790 791 792 793 794
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

795
int fuse_ctl_init(void);
796
void __exit fuse_ctl_cleanup(void);
797

M
Miklos Szeredi 已提交
798 799 800
/**
 * Allocate a request
 */
801
struct fuse_req *fuse_request_alloc(unsigned npages);
M
Miklos Szeredi 已提交
802

803
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
M
Miklos Szeredi 已提交
804

M
Miklos Szeredi 已提交
805 806 807 808 809 810
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
M
Maxim Patlasov 已提交
811 812
 * Get a request, may fail with -ENOMEM,
 * caller should specify # elements in req->pages[] explicitly
M
Miklos Szeredi 已提交
813
 */
M
Maxim Patlasov 已提交
814
struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
815 816
struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
					     unsigned npages);
M
Maxim Patlasov 已提交
817

818 819 820 821 822
/*
 * Increment reference count on request
 */
void __fuse_get_request(struct fuse_req *req);

823 824 825
/**
 * Gets a requests for a file operation, always succeeds
 */
M
Maxim Patlasov 已提交
826 827
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
828

M
Miklos Szeredi 已提交
829
/**
830 831
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
M
Miklos Szeredi 已提交
832 833 834 835
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
836
 * Send a request (synchronous)
M
Miklos Szeredi 已提交
837
 */
838
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
M
Miklos Szeredi 已提交
839

840 841 842 843 844
/**
 * Simple request sending that does request allocation and freeing
 */
ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);

M
Miklos Szeredi 已提交
845 846 847
/**
 * Send a request in the background
 */
848
void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
M
Miklos Szeredi 已提交
849

850 851
void fuse_request_send_background_locked(struct fuse_conn *fc,
					 struct fuse_req *req);
M
Miklos Szeredi 已提交
852

853
/* Abort all requests */
854 855
void fuse_abort_conn(struct fuse_conn *fc);

856 857 858 859
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
860

M
Miklos Szeredi 已提交
861 862
void fuse_invalidate_entry_cache(struct dentry *entry);

863 864
void fuse_invalidate_atime(struct inode *inode);

865 866 867 868 869
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

870 871 872
/**
 * Initialize fuse_conn
 */
873
void fuse_conn_init(struct fuse_conn *fc);
874

875 876 877 878 879
/**
 * Release reference to fuse_conn
 */
void fuse_conn_put(struct fuse_conn *fc);

880 881 882
struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
void fuse_dev_free(struct fuse_dev *fud);

883 884 885 886 887 888 889 890 891
/**
 * 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);
892 893 894 895 896

/**
 * Is file type valid?
 */
int fuse_valid_type(int m);
M
Miklos Szeredi 已提交
897 898

/**
899
 * Is current process allowed to perform filesystem operation?
M
Miklos Szeredi 已提交
900
 */
901
int fuse_allow_current_process(struct fuse_conn *fc);
902 903

u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
M
Miklos Szeredi 已提交
904

S
Seth Forshee 已提交
905 906
void fuse_update_ctime(struct inode *inode);

M
Miklos Szeredi 已提交
907 908
int fuse_update_attributes(struct inode *inode, struct kstat *stat,
			   struct file *file, bool *refreshed);
M
Miklos Szeredi 已提交
909 910 911 912 913

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
914 915

u64 fuse_get_attr_version(struct fuse_conn *fc);
T
Tejun Heo 已提交
916

J
John Muir 已提交
917 918 919 920 921 922 923 924 925
/**
 * 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.
926 927 928 929 930 931
 *
 * 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()).
J
John Muir 已提交
932 933
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
934
			     u64 child_nodeid, struct qstr *name);
J
John Muir 已提交
935

936 937
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
938 939 940 941 942 943 944 945 946 947 948

/**
 * 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)

A
Al Viro 已提交
949 950
ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
		       loff_t *ppos, int flags);
951 952
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
953 954
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
955 956 957
unsigned fuse_file_poll(struct file *file, poll_table *wait);
int fuse_dev_release(struct inode *inode, struct file *file);

M
Maxim Patlasov 已提交
958 959
bool fuse_write_update_size(struct inode *inode, loff_t pos);

960
int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
M
Miklos Szeredi 已提交
961
int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
M
Miklos Szeredi 已提交
962

963 964 965
int fuse_do_setattr(struct inode *inode, struct iattr *attr,
		    struct file *file);

966 967
void fuse_set_initialized(struct fuse_conn *fc);

968 969 970
void fuse_unlock_inode(struct inode *inode);
void fuse_lock_inode(struct inode *inode);

S
Seth Forshee 已提交
971 972 973
ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
extern const struct xattr_handler *fuse_xattr_handlers[];

T
Tejun Heo 已提交
974
#endif /* _FS_FUSE_I_H */