fuse_i.h 23.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>
S
Seth Forshee 已提交
26
#include <linux/xattr.h>
27
#include <linux/pid_namespace.h>
28
#include <linux/refcount.h>
29
#include <linux/user_namespace.h>
M
Miklos Szeredi 已提交
30

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

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

37 38 39
/** It could be as large as PATH_MAX, but would that have any uses? */
#define FUSE_NAME_MAX 1024

40
/** Number of dentries for each connection in the control filesystem */
41
#define FUSE_CTL_NUM_DENTRIES 5
42

43 44 45
/** Number of page pointers embedded in fuse_req */
#define FUSE_REQ_INLINE_PAGES 1

46 47 48 49 50
/** 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 已提交
51

52 53 54 55
/** Module parameters */
extern unsigned max_user_bgreq;
extern unsigned max_user_congthresh;

56 57
/* One forget request */
struct fuse_forget_link {
58
	struct fuse_forget_one forget_one;
59 60 61
	struct fuse_forget_link *next;
};

M
Miklos Szeredi 已提交
62 63 64 65 66 67 68 69 70
/** FUSE inode */
struct fuse_inode {
	/** Inode data */
	struct inode inode;

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

71 72 73
	/** Number of lookups on this inode */
	u64 nlookup;

74
	/** The request used for sending the FORGET message */
75
	struct fuse_forget_link *forget;
76

M
Miklos Szeredi 已提交
77
	/** Time in jiffies until the file attributes are valid */
M
Miklos Szeredi 已提交
78
	u64 i_time;
79 80 81

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

84 85 86
	/** 64 bit inode number */
	u64 orig_ino;

87 88
	/** Version of last attribute change */
	u64 attr_version;
89 90 91

	/** Files usable in writepage.  Protected by fc->lock */
	struct list_head write_files;
M
Miklos Szeredi 已提交
92 93 94 95 96 97 98 99 100 101 102 103 104

	/** 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;
105 106 107

	/** Miscellaneous bits describing inode state */
	unsigned long state;
108 109 110

	/** Lock for serializing lookup and readdir for back compatibility*/
	struct mutex mutex;
111 112 113 114 115 116
};

/** FUSE inode state bits */
enum {
	/** Advise readdirplus  */
	FUSE_I_ADVISE_RDPLUS,
M
Miklos Szeredi 已提交
117 118
	/** Initialized with readdirplus */
	FUSE_I_INIT_RDPLUS,
119 120
	/** An operation changing file size is in progress  */
	FUSE_I_SIZE_UNSTABLE,
M
Miklos Szeredi 已提交
121 122
};

123 124
struct fuse_conn;

M
Miklos Szeredi 已提交
125 126
/** FUSE specific file data */
struct fuse_file {
127 128 129
	/** Fuse connection for this file */
	struct fuse_conn *fc;

M
Miklos Szeredi 已提交
130
	/** Request reserved for flush and release */
131
	struct fuse_req *reserved_req;
M
Miklos Szeredi 已提交
132

T
Tejun Heo 已提交
133 134 135
	/** Kernel file handle guaranteed to be unique */
	u64 kh;

M
Miklos Szeredi 已提交
136 137
	/** File handle used by userspace */
	u64 fh;
138

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

142
	/** Refcount */
143
	refcount_t count;
144

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

148 149
	/** Entry on inode's write_files list */
	struct list_head write_entry;
T
Tejun Heo 已提交
150 151 152 153 154 155

	/** 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 已提交
156 157 158

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

M
Miklos Szeredi 已提交
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
/** 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 已提交
193 194 195 196 197
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

M
Miklos Szeredi 已提交
198 199 200 201 202 203 204 205 206 207
	/** 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;

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

M
Miklos Szeredi 已提交
211 212 213 214
	/** Number or arguments */
	unsigned numargs;

	/** Array of arguments */
M
Miklos Szeredi 已提交
215
	struct fuse_arg args[2];
M
Miklos Szeredi 已提交
216 217
};

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

224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
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 已提交
243 244
/** The request IO state (for asynchronous processing) */
struct fuse_io_priv {
245
	struct kref refcnt;
M
Maxim Patlasov 已提交
246 247 248 249 250 251 252
	int async;
	spinlock_t lock;
	unsigned reqs;
	ssize_t bytes;
	size_t size;
	__u64 offset;
	bool write;
253
	bool should_dirty;
M
Maxim Patlasov 已提交
254 255
	int err;
	struct kiocb *iocb;
256
	struct completion *done;
257
	bool blocking;
M
Maxim Patlasov 已提交
258 259
};

260
#define FUSE_IO_PRIV_SYNC(i) \
261
{					\
262
	.refcnt = KREF_INIT(1),		\
263
	.async = 0,			\
264
	.iocb = i,			\
265 266
}

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

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

308 309 310
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

M
Miklos Szeredi 已提交
311
	/** refcount */
312
	refcount_t count;
M
Miklos Szeredi 已提交
313

314 315 316
	/** Unique ID for the interrupt request */
	u64 intr_unique;

M
Miklos Szeredi 已提交
317 318
	/* Request flags, updated with test/set/clear_bit() */
	unsigned long flags;
319

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

	/** page vector */
351 352
	struct page **pages;

353 354 355
	/** page-descriptor vector */
	struct fuse_page_desc *page_descs;

356 357 358 359 360
	/** size of the 'pages' array */
	unsigned max_pages;

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

362 363 364
	/** inline page-descriptor vector */
	struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];

M
Miklos Szeredi 已提交
365 366 367 368
	/** number of pages in vector */
	unsigned num_pages;

	/** File used in the request (or NULL) */
369
	struct fuse_file *ff;
370

M
Miklos Szeredi 已提交
371 372 373
	/** Inode used in the request or NULL */
	struct inode *inode;

M
Maxim Patlasov 已提交
374 375 376
	/** AIO control block */
	struct fuse_io_priv *io;

M
Miklos Szeredi 已提交
377 378 379
	/** Link on fi->writepages */
	struct list_head writepages_entry;

380 381
	/** Request completion callback */
	void (*end)(struct fuse_conn *, struct fuse_req *);
382 383 384

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

M
Miklos Szeredi 已提交
387
struct fuse_iqueue {
388 389 390
	/** Connection established */
	unsigned connected;

M
Miklos Szeredi 已提交
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
	/** 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;
};

414
struct fuse_pqueue {
415 416 417
	/** Connection established */
	unsigned connected;

M
Miklos Szeredi 已提交
418 419 420
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

421 422 423 424 425 426 427
	/** The list of requests being processed */
	struct list_head processing;

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

428 429 430 431 432 433 434
/**
 * Fuse device instance
 */
struct fuse_dev {
	/** Fuse connection for this device */
	struct fuse_conn *fc;

435 436 437
	/** Processing queue */
	struct fuse_pqueue pq;

438 439 440 441
	/** list entry on fc->devices */
	struct list_head entry;
};

M
Miklos Szeredi 已提交
442 443 444 445 446 447 448 449
/**
 * 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 {
450 451 452
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

453
	/** Refcount */
454
	refcount_t count;
455

456 457 458
	/** Number of fuse_dev's */
	atomic_t dev_count;

A
Al Viro 已提交
459 460
	struct rcu_head rcu;

M
Miklos Szeredi 已提交
461
	/** The user id for this mount */
462
	kuid_t user_id;
M
Miklos Szeredi 已提交
463

464
	/** The group id for this mount */
465
	kgid_t group_id;
466

467 468 469
	/** The pid namespace for this mount */
	struct pid_namespace *pid_ns;

470 471 472
	/** The user namespace for this mount */
	struct user_namespace *user_ns;

473 474 475
	/** Maximum read size */
	unsigned max_read;

M
Miklos Szeredi 已提交
476 477 478
	/** Maximum write size */
	unsigned max_write;

M
Miklos Szeredi 已提交
479 480
	/** Input queue */
	struct fuse_iqueue iq;
M
Miklos Szeredi 已提交
481

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

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

488 489 490 491 492 493
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

494 495 496
	/** Number of requests currently in the background */
	unsigned num_background;

497 498 499 500 501 502
	/** 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;

K
Kirill Tkhai 已提交
503 504 505 506
	/** Protects: max_background, congestion_threshold, num_background,
	 * active_background, bg_queue, blocked */
	spinlock_t bg_lock;

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

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

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

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

526 527 528
	/** Connection aborted via sysfs */
	bool aborted;

M
Miklos Szeredi 已提交
529 530 531
	/** 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 已提交
532
	unsigned conn_error:1;
M
Miklos Szeredi 已提交
533

534
	/** Connection successful.  Only set in INIT */
M
Miklos Szeredi 已提交
535
	unsigned conn_init:1;
536

537
	/** Do readpages asynchronously?  Only set in INIT */
M
Miklos Szeredi 已提交
538
	unsigned async_read:1;
539

540 541 542
	/** Return an unique read error after abort.  Only set in INIT */
	unsigned abort_err:1;

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

546
	/** Filesystem supports NFS exporting.  Only set in INIT */
M
Miklos Szeredi 已提交
547
	unsigned export_support:1;
548

549 550 551
	/** write-back cache policy (default is write-through) */
	unsigned writeback_cache:1;

552 553 554
	/** allow parallel lookups and readdir (default is serialized) */
	unsigned parallel_dirops:1;

555 556 557
	/** handle fs handles killing suid/sgid/cap on write/chown/trunc */
	unsigned handle_killpriv:1;

M
Miklos Szeredi 已提交
558 559 560 561 562
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

563 564 565
	/** Is open/release not implemented by fs? */
	unsigned no_open:1;

M
Miklos Szeredi 已提交
566
	/** Is fsync not implemented by fs? */
M
Miklos Szeredi 已提交
567
	unsigned no_fsync:1;
M
Miklos Szeredi 已提交
568

569
	/** Is fsyncdir not implemented by fs? */
M
Miklos Szeredi 已提交
570
	unsigned no_fsyncdir:1;
571

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

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

	/** Is getxattr not implemented by fs? */
M
Miklos Szeredi 已提交
579
	unsigned no_getxattr:1;
580 581

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

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

M
Miklos Szeredi 已提交
587
	/** Are posix file locking primitives not implemented by fs? */
M
Miklos Szeredi 已提交
588
	unsigned no_lock:1;
589

M
Miklos Szeredi 已提交
590
	/** Is access not implemented by fs? */
M
Miklos Szeredi 已提交
591
	unsigned no_access:1;
M
Miklos Szeredi 已提交
592

M
Miklos Szeredi 已提交
593
	/** Is create not implemented by fs? */
M
Miklos Szeredi 已提交
594
	unsigned no_create:1;
M
Miklos Szeredi 已提交
595

596
	/** Is interrupt not implemented by fs? */
M
Miklos Szeredi 已提交
597
	unsigned no_interrupt:1;
598

M
Miklos Szeredi 已提交
599
	/** Is bmap not implemented by fs? */
M
Miklos Szeredi 已提交
600
	unsigned no_bmap:1;
M
Miklos Szeredi 已提交
601

T
Tejun Heo 已提交
602 603 604
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

605
	/** Do multi-page cached writes */
M
Miklos Szeredi 已提交
606
	unsigned big_writes:1;
607

608 609 610
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

M
Miklos Szeredi 已提交
611 612 613
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

614 615 616
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

M
Miklos Szeredi 已提交
617 618 619
	/** Is rename with flags implemented by fs? */
	unsigned no_rename2:1;

620 621 622
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

623
	/** Does the filesystem support readdirplus? */
624 625
	unsigned do_readdirplus:1;

626 627 628
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

629 630 631
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

632 633 634
	/** Is lseek not implemented by fs? */
	unsigned no_lseek:1;

S
Seth Forshee 已提交
635 636 637
	/** Does the filesystem support posix acls? */
	unsigned posix_acl:1;

M
Miklos Szeredi 已提交
638 639 640 641 642 643
	/** Check permissions based on the file mode or not? */
	unsigned default_permissions:1;

	/** Allow other than the mounter user to access the filesystem ? */
	unsigned allow_other:1;

644 645 646
	/** Does the filesystem support copy_file_range? */
	unsigned no_copy_file_range:1;

647 648 649
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

650 651 652
	/** Negotiated minor version */
	unsigned minor;

653 654 655
	/** Entry on the fuse_conn_list */
	struct list_head entry;

656 657
	/** Device ID from super block */
	dev_t dev;
658 659 660 661 662 663

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

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

665 666
	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
667 668 669

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
670 671 672

	/** Version counter for attribute changes */
	u64 attr_version;
T
Tejun Heo 已提交
673 674 675

	/** Called on final put */
	void (*release)(struct fuse_conn *);
J
John Muir 已提交
676 677 678 679 680 681

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

	/** Read/write semaphore to hold when accessing sb. */
	struct rw_semaphore killsb;
682 683 684

	/** List of device instances belonging to this connection */
	struct list_head devices;
M
Miklos Szeredi 已提交
685 686 687 688
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
689
	return sb->s_fs_info;
M
Miklos Szeredi 已提交
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
}

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

A
Al Viro 已提交
710
extern const struct dentry_operations fuse_dentry_operations;
711
extern const struct dentry_operations fuse_root_dentry_operations;
M
Miklos Szeredi 已提交
712

J
John Muir 已提交
713 714 715 716 717
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

718 719 720
/**
 * Get a filled in inode
 */
M
Miklos Szeredi 已提交
721
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
722 723
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
724

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

728 729 730
/**
 * Send FORGET command
 */
731 732 733 734
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);
735

736 737 738
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

739
/**
740
 * Initialize READ or READDIR request
741
 */
742
void fuse_read_fill(struct fuse_req *req, struct file *file,
743
		    loff_t pos, size_t count, int opcode);
744 745 746 747

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

T
Tejun Heo 已提交
750
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
M
Miklos Szeredi 已提交
751
void fuse_file_free(struct fuse_file *ff);
752
void fuse_finish_open(struct inode *inode, struct file *file);
M
Miklos Szeredi 已提交
753

754
void fuse_sync_release(struct fuse_file *ff, int flags);
755

756 757 758
/**
 * Send RELEASE or RELEASEDIR request
 */
759
void fuse_release_common(struct file *file, int opcode);
760

761 762 763
/**
 * Send FSYNC or FSYNCDIR request
 */
764 765
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
		      int datasync, int isdir);
766

T
Tejun Heo 已提交
767 768 769 770 771 772
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

M
Miklos Szeredi 已提交
773
/**
M
Miklos Szeredi 已提交
774
 * Initialize file operations on a regular file
M
Miklos Szeredi 已提交
775 776 777
 */
void fuse_init_file_inode(struct inode *inode);

778
/**
M
Miklos Szeredi 已提交
779
 * Initialize inode operations on regular files and special files
780 781 782 783
 */
void fuse_init_common(struct inode *inode);

/**
M
Miklos Szeredi 已提交
784
 * Initialize inode and file operations on a directory
785 786 787 788
 */
void fuse_init_dir(struct inode *inode);

/**
M
Miklos Szeredi 已提交
789
 * Initialize inode operations on a symlink
790 791 792 793 794 795
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
796 797
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
798

M
Miklos Szeredi 已提交
799 800 801
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

M
Miklos Szeredi 已提交
802 803 804 805 806 807 808 809 810 811
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

812
int fuse_ctl_init(void);
813
void __exit fuse_ctl_cleanup(void);
814

M
Miklos Szeredi 已提交
815 816 817
/**
 * Allocate a request
 */
818
struct fuse_req *fuse_request_alloc(unsigned npages);
M
Miklos Szeredi 已提交
819

820
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
M
Miklos Szeredi 已提交
821

M
Miklos Szeredi 已提交
822 823 824 825 826 827
/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
M
Maxim Patlasov 已提交
828 829
 * Get a request, may fail with -ENOMEM,
 * caller should specify # elements in req->pages[] explicitly
M
Miklos Szeredi 已提交
830
 */
M
Maxim Patlasov 已提交
831
struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
832 833
struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
					     unsigned npages);
M
Maxim Patlasov 已提交
834

835 836 837 838 839
/*
 * Increment reference count on request
 */
void __fuse_get_request(struct fuse_req *req);

840 841 842
/**
 * Gets a requests for a file operation, always succeeds
 */
M
Maxim Patlasov 已提交
843 844
struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
					     struct file *file);
845

M
Miklos Szeredi 已提交
846
/**
847 848
 * Decrement reference count of a request.  If count goes to zero free
 * the request.
M
Miklos Szeredi 已提交
849 850 851 852
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
853
 * Send a request (synchronous)
M
Miklos Szeredi 已提交
854
 */
855
void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
M
Miklos Szeredi 已提交
856

857 858 859 860 861
/**
 * 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 已提交
862 863 864
/**
 * Send a request in the background
 */
865
void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
M
Miklos Szeredi 已提交
866

K
Kirill Tkhai 已提交
867 868
void fuse_request_send_background_nocheck(struct fuse_conn *fc,
					  struct fuse_req *req);
M
Miklos Szeredi 已提交
869

870
/* Abort all requests */
871
void fuse_abort_conn(struct fuse_conn *fc, bool is_abort);
872
void fuse_wait_aborted(struct fuse_conn *fc);
873

874 875 876 877
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
878

M
Miklos Szeredi 已提交
879 880
void fuse_invalidate_entry_cache(struct dentry *entry);

881 882
void fuse_invalidate_atime(struct inode *inode);

883 884 885 886 887
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

888 889 890
/**
 * Initialize fuse_conn
 */
891
void fuse_conn_init(struct fuse_conn *fc, struct user_namespace *user_ns);
892

893 894 895 896 897
/**
 * Release reference to fuse_conn
 */
void fuse_conn_put(struct fuse_conn *fc);

898 899 900
struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
void fuse_dev_free(struct fuse_dev *fud);

901 902 903 904 905 906 907 908 909
/**
 * 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);
910 911 912 913 914

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

/**
917
 * Is current process allowed to perform filesystem operation?
M
Miklos Szeredi 已提交
918
 */
919
int fuse_allow_current_process(struct fuse_conn *fc);
920 921

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

S
Seth Forshee 已提交
923 924
void fuse_update_ctime(struct inode *inode);

M
Miklos Szeredi 已提交
925
int fuse_update_attributes(struct inode *inode, struct file *file);
M
Miklos Szeredi 已提交
926 927 928 929 930

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
931 932

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

J
John Muir 已提交
934 935 936 937 938 939 940 941 942
/**
 * 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.
943 944 945 946 947 948
 *
 * 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 已提交
949 950
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
951
			     u64 child_nodeid, struct qstr *name);
J
John Muir 已提交
952

953 954
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
955 956 957 958 959 960 961 962 963 964 965

/**
 * 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 已提交
966 967
ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
		       loff_t *ppos, int flags);
968 969
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
970 971
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
A
Al Viro 已提交
972
__poll_t fuse_file_poll(struct file *file, poll_table *wait);
973 974
int fuse_dev_release(struct inode *inode, struct file *file);

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

977
int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
M
Miklos Szeredi 已提交
978
int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
M
Miklos Szeredi 已提交
979

980
int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
981 982
		    struct file *file);

983 984
void fuse_set_initialized(struct fuse_conn *fc);

985 986
void fuse_unlock_inode(struct inode *inode, bool locked);
bool fuse_lock_inode(struct inode *inode);
987

S
Seth Forshee 已提交
988 989 990 991
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 已提交
992
ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
S
Seth Forshee 已提交
993
int fuse_removexattr(struct inode *inode, const char *name);
S
Seth Forshee 已提交
994
extern const struct xattr_handler *fuse_xattr_handlers[];
S
Seth Forshee 已提交
995
extern const struct xattr_handler *fuse_acl_xattr_handlers[];
996
extern const struct xattr_handler *fuse_no_acl_xattr_handlers[];
S
Seth Forshee 已提交
997 998 999 1000

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 已提交
1001

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