fuse_i.h 23.4 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>
S
Seth Forshee 已提交
26
#include <linux/xattr.h>
M
Miklos Szeredi 已提交
27

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

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

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

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

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

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

52 53 54 55 56
/** 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 已提交
57

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

129 130
struct fuse_conn;

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

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

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

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

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

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

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

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

	/** 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 已提交
162 163 164

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

M
Miklos Szeredi 已提交
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 198
/** 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 已提交
199 200 201 202 203
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

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

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

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

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

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

230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
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 已提交
249 250
/** The request IO state (for asynchronous processing) */
struct fuse_io_priv {
251
	struct kref refcnt;
M
Maxim Patlasov 已提交
252 253 254 255 256 257 258 259 260 261
	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;
262
	struct completion *done;
263
	bool blocking;
M
Maxim Patlasov 已提交
264 265
};

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

M
Miklos Szeredi 已提交
273 274 275 276 277 278 279 280 281 282
/**
 * 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 已提交
283 284 285
 * FR_PENDING:		request is not yet in userspace
 * FR_SENT:		request is in userspace, waiting for an answer
 * FR_FINISHED:		request is finished
286
 * FR_PRIVATE:		request is on private list
M
Miklos Szeredi 已提交
287 288 289 290 291 292 293 294 295
 */
enum fuse_req_flag {
	FR_ISREPLY,
	FR_FORCE,
	FR_BACKGROUND,
	FR_WAITING,
	FR_ABORTED,
	FR_INTERRUPTED,
	FR_LOCKED,
M
Miklos Szeredi 已提交
296 297 298
	FR_PENDING,
	FR_SENT,
	FR_FINISHED,
299
	FR_PRIVATE,
M
Miklos Szeredi 已提交
300 301
};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

M
Miklos Szeredi 已提交
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
	/** 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;
};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

500 501 502 503 504 505
	/** 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 已提交
506 507 508 509
	/** Flag indicating that INIT reply has been received. Allocating
	 * any fuse request will be suspended until the flag is set */
	int initialized;

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

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

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

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

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

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

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

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

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

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

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

551 552 553
	/** handle fs handles killing suid/sgid/cap on write/chown/trunc */
	unsigned handle_killpriv:1;

M
Miklos Szeredi 已提交
554 555 556 557 558
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

559 560 561
	/** Is open/release not implemented by fs? */
	unsigned no_open:1;

M
Miklos Szeredi 已提交
562
	/** Is fsync not implemented by fs? */
M
Miklos Szeredi 已提交
563
	unsigned no_fsync:1;
M
Miklos Szeredi 已提交
564

565
	/** Is fsyncdir not implemented by fs? */
M
Miklos Szeredi 已提交
566
	unsigned no_fsyncdir:1;
567

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

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

	/** Is getxattr not implemented by fs? */
M
Miklos Szeredi 已提交
575
	unsigned no_getxattr:1;
576 577

	/** Is listxattr not implemented by fs? */
M
Miklos Szeredi 已提交
578
	unsigned no_listxattr:1;
579 580

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

M
Miklos Szeredi 已提交
583
	/** Are posix file locking primitives not implemented by fs? */
M
Miklos Szeredi 已提交
584
	unsigned no_lock:1;
585

M
Miklos Szeredi 已提交
586
	/** Is access not implemented by fs? */
M
Miklos Szeredi 已提交
587
	unsigned no_access:1;
M
Miklos Szeredi 已提交
588

M
Miklos Szeredi 已提交
589
	/** Is create not implemented by fs? */
M
Miklos Szeredi 已提交
590
	unsigned no_create:1;
M
Miklos Szeredi 已提交
591

592
	/** Is interrupt not implemented by fs? */
M
Miklos Szeredi 已提交
593
	unsigned no_interrupt:1;
594

M
Miklos Szeredi 已提交
595
	/** Is bmap not implemented by fs? */
M
Miklos Szeredi 已提交
596
	unsigned no_bmap:1;
M
Miklos Szeredi 已提交
597

T
Tejun Heo 已提交
598 599 600
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

601
	/** Do multi-page cached writes */
M
Miklos Szeredi 已提交
602
	unsigned big_writes:1;
603

604 605 606
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

M
Miklos Szeredi 已提交
607 608 609
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

610 611 612
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

M
Miklos Szeredi 已提交
613 614 615
	/** Is rename with flags implemented by fs? */
	unsigned no_rename2:1;

616 617 618
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

619
	/** Does the filesystem support readdirplus? */
620 621
	unsigned do_readdirplus:1;

622 623 624
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

625 626 627
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

628 629 630
	/** Is lseek not implemented by fs? */
	unsigned no_lseek:1;

S
Seth Forshee 已提交
631 632 633
	/** Does the filesystem support posix acls? */
	unsigned posix_acl:1;

634 635 636
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

637 638 639
	/** Negotiated minor version */
	unsigned minor;

M
Miklos Szeredi 已提交
640 641
	/** Backing dev info */
	struct backing_dev_info bdi;
642

643 644 645
	/** Entry on the fuse_conn_list */
	struct list_head entry;

646 647
	/** Device ID from super block */
	dev_t dev;
648 649 650 651 652 653

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

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

655 656
	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
657 658 659

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
660 661 662

	/** Version counter for attribute changes */
	u64 attr_version;
T
Tejun Heo 已提交
663 664 665

	/** Called on final put */
	void (*release)(struct fuse_conn *);
J
John Muir 已提交
666 667 668 669 670 671

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

	/** Read/write semaphore to hold when accessing sb. */
	struct rw_semaphore killsb;
672 673 674

	/** List of device instances belonging to this connection */
	struct list_head devices;
M
Miklos Szeredi 已提交
675 676 677 678
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
679
	return sb->s_fs_info;
M
Miklos Szeredi 已提交
680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
}

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 已提交
697
/** Device operations */
698
extern const struct file_operations fuse_dev_operations;
M
Miklos Szeredi 已提交
699

A
Al Viro 已提交
700
extern const struct dentry_operations fuse_dentry_operations;
M
Miklos Szeredi 已提交
701

J
John Muir 已提交
702 703 704 705 706
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

707 708 709
/**
 * Get a filled in inode
 */
M
Miklos Szeredi 已提交
710
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
711 712
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
713

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

717 718 719
/**
 * Send FORGET command
 */
720 721 722 723
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);
724

725 726 727
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

728
/**
729
 * Initialize READ or READDIR request
730
 */
731
void fuse_read_fill(struct fuse_req *req, struct file *file,
732
		    loff_t pos, size_t count, int opcode);
733 734 735 736

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

T
Tejun Heo 已提交
739
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
740
struct fuse_file *fuse_file_get(struct fuse_file *ff);
M
Miklos Szeredi 已提交
741
void fuse_file_free(struct fuse_file *ff);
742
void fuse_finish_open(struct inode *inode, struct file *file);
M
Miklos Szeredi 已提交
743

744
void fuse_sync_release(struct fuse_file *ff, int flags);
745

746 747 748
/**
 * Send RELEASE or RELEASEDIR request
 */
749
void fuse_release_common(struct file *file, int opcode);
750

751 752 753
/**
 * Send FSYNC or FSYNCDIR request
 */
754 755
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
756

T
Tejun Heo 已提交
757 758 759 760 761 762
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

M
Miklos Szeredi 已提交
763
/**
M
Miklos Szeredi 已提交
764
 * Initialize file operations on a regular file
M
Miklos Szeredi 已提交
765 766 767
 */
void fuse_init_file_inode(struct inode *inode);

768
/**
M
Miklos Szeredi 已提交
769
 * Initialize inode operations on regular files and special files
770 771 772 773
 */
void fuse_init_common(struct inode *inode);

/**
M
Miklos Szeredi 已提交
774
 * Initialize inode and file operations on a directory
775 776 777 778
 */
void fuse_init_dir(struct inode *inode);

/**
M
Miklos Szeredi 已提交
779
 * Initialize inode operations on a symlink
780 781 782 783 784 785
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
786 787
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
788

M
Miklos Szeredi 已提交
789 790 791
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

M
Miklos Szeredi 已提交
792 793 794 795 796 797 798 799 800 801
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

802
int fuse_ctl_init(void);
803
void __exit fuse_ctl_cleanup(void);
804

M
Miklos Szeredi 已提交
805 806 807
/**
 * Allocate a request
 */
808
struct fuse_req *fuse_request_alloc(unsigned npages);
M
Miklos Szeredi 已提交
809

810
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
M
Miklos Szeredi 已提交
811

M
Miklos Szeredi 已提交
812 813 814 815 816 817
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
M
Maxim Patlasov 已提交
818 819
 * Get a request, may fail with -ENOMEM,
 * caller should specify # elements in req->pages[] explicitly
M
Miklos Szeredi 已提交
820
 */
M
Maxim Patlasov 已提交
821
struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
822 823
struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
					     unsigned npages);
M
Maxim Patlasov 已提交
824

825 826 827 828 829
/*
 * Increment reference count on request
 */
void __fuse_get_request(struct fuse_req *req);

830 831 832
/**
 * Gets a requests for a file operation, always succeeds
 */
M
Maxim Patlasov 已提交
833 834
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
835

M
Miklos Szeredi 已提交
836
/**
837 838
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
M
Miklos Szeredi 已提交
839 840 841 842
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
843
 * Send a request (synchronous)
M
Miklos Szeredi 已提交
844
 */
845
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
M
Miklos Szeredi 已提交
846

847 848 849 850 851
/**
 * 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 已提交
852 853 854
/**
 * Send a request in the background
 */
855
void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
M
Miklos Szeredi 已提交
856

857 858
void fuse_request_send_background_locked(struct fuse_conn *fc,
					 struct fuse_req *req);
M
Miklos Szeredi 已提交
859

860
/* Abort all requests */
861 862
void fuse_abort_conn(struct fuse_conn *fc);

863 864 865 866
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
867

M
Miklos Szeredi 已提交
868 869
void fuse_invalidate_entry_cache(struct dentry *entry);

870 871
void fuse_invalidate_atime(struct inode *inode);

872 873 874 875 876
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

877 878 879
/**
 * Initialize fuse_conn
 */
880
void fuse_conn_init(struct fuse_conn *fc);
881

882 883 884 885 886
/**
 * Release reference to fuse_conn
 */
void fuse_conn_put(struct fuse_conn *fc);

887 888 889
struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
void fuse_dev_free(struct fuse_dev *fud);

890 891 892 893 894 895 896 897 898
/**
 * 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);
899 900 901 902 903

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

/**
906
 * Is current process allowed to perform filesystem operation?
M
Miklos Szeredi 已提交
907
 */
908
int fuse_allow_current_process(struct fuse_conn *fc);
909 910

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

S
Seth Forshee 已提交
912 913
void fuse_update_ctime(struct inode *inode);

M
Miklos Szeredi 已提交
914 915
int fuse_update_attributes(struct inode *inode, struct kstat *stat,
			   struct file *file, bool *refreshed);
M
Miklos Szeredi 已提交
916 917 918 919 920

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
921 922

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

J
John Muir 已提交
924 925 926 927 928 929 930 931 932
/**
 * 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.
933 934 935 936 937 938
 *
 * 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 已提交
939 940
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
941
			     u64 child_nodeid, struct qstr *name);
J
John Muir 已提交
942

943 944
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
945 946 947 948 949 950 951 952 953 954 955

/**
 * 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 已提交
956 957
ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
		       loff_t *ppos, int flags);
958 959
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
960 961
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
962 963 964
unsigned fuse_file_poll(struct file *file, poll_table *wait);
int fuse_dev_release(struct inode *inode, struct file *file);

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

967
int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
M
Miklos Szeredi 已提交
968
int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
M
Miklos Szeredi 已提交
969

970 971 972
int fuse_do_setattr(struct inode *inode, struct iattr *attr,
		    struct file *file);

973 974
void fuse_set_initialized(struct fuse_conn *fc);

975 976 977
void fuse_unlock_inode(struct inode *inode);
void fuse_lock_inode(struct inode *inode);

S
Seth Forshee 已提交
978 979 980 981
int fuse_setxattr(struct inode *inode, const char *name, const void *value,
		  size_t size, int flags);
ssize_t fuse_getxattr(struct inode *inode, const char *name, void *value,
		      size_t size);
S
Seth Forshee 已提交
982
ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
S
Seth Forshee 已提交
983
int fuse_removexattr(struct inode *inode, const char *name);
S
Seth Forshee 已提交
984
extern const struct xattr_handler *fuse_xattr_handlers[];
S
Seth Forshee 已提交
985 986 987 988 989
extern const struct xattr_handler *fuse_acl_xattr_handlers[];

struct posix_acl;
struct posix_acl *fuse_get_acl(struct inode *inode, int type);
int fuse_set_acl(struct inode *inode, struct posix_acl *acl, int type);
S
Seth Forshee 已提交
990

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