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

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

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

12 13 14 15
#ifndef pr_fmt
# define pr_fmt(fmt) "fuse: " fmt
#endif

Miklos Szeredi's avatar
Miklos Szeredi committed
16 17
#include <linux/fuse.h>
#include <linux/fs.h>
18
#include <linux/mount.h>
Miklos Szeredi's avatar
Miklos Szeredi committed
19 20 21 22 23
#include <linux/wait.h>
#include <linux/list.h>
#include <linux/spinlock.h>
#include <linux/mm.h>
#include <linux/backing-dev.h>
24
#include <linux/mutex.h>
Miklos Szeredi's avatar
Miklos Szeredi committed
25
#include <linux/rwsem.h>
Tejun Heo's avatar
Tejun Heo committed
26 27
#include <linux/rbtree.h>
#include <linux/poll.h>
28
#include <linux/workqueue.h>
29
#include <linux/kref.h>
Seth Forshee's avatar
Seth Forshee committed
30
#include <linux/xattr.h>
31
#include <linux/pid_namespace.h>
32
#include <linux/refcount.h>
33
#include <linux/user_namespace.h>
Miklos Szeredi's avatar
Miklos Szeredi committed
34

35 36 37 38 39
/** Default max number of pages that can be used in a single read request */
#define FUSE_DEFAULT_MAX_PAGES_PER_REQ 32

/** Maximum of max_pages received in init_out */
#define FUSE_MAX_MAX_PAGES 256
40

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

44 45 46
/** It could be as large as PATH_MAX, but would that have any uses? */
#define FUSE_NAME_MAX 1024

47
/** Number of dentries for each connection in the control filesystem */
48
#define FUSE_CTL_NUM_DENTRIES 5
49

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

53 54 55 56 57
/** List of active connections */
extern struct list_head fuse_conn_list;

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

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

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

Miklos Szeredi's avatar
Miklos Szeredi committed
69 70 71 72 73 74 75 76 77
/** FUSE inode */
struct fuse_inode {
	/** Inode data */
	struct inode inode;

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

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

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

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

87 88 89
	/* Which attributes are invalid */
	u32 inval_mask;

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

94 95 96
	/** 64 bit inode number */
	u64 orig_ino;

97 98
	/** Version of last attribute change */
	u64 attr_version;
99

100 101 102
	union {
		/* Write related fields (regular file only) */
		struct {
103
			/* Files usable in writepage.  Protected by fi->lock */
104
			struct list_head write_files;
Miklos Szeredi's avatar
Miklos Szeredi committed
105

106 107
			/* Writepages pending on truncate or fsync */
			struct list_head queued_writes;
Miklos Szeredi's avatar
Miklos Szeredi committed
108

109 110 111
			/* Number of sent writes, a negative bias
			 * (FUSE_NOWRITE) means more writes are blocked */
			int writectr;
Miklos Szeredi's avatar
Miklos Szeredi committed
112

113 114
			/* Waitq for writepage completion */
			wait_queue_head_t page_waitq;
Miklos Szeredi's avatar
Miklos Szeredi committed
115

116 117 118
			/* List of writepage requestst (pending or sent) */
			struct list_head writepages;
		};
119

120 121 122 123
		/* readdir cache (directory only) */
		struct {
			/* true if fully cached */
			bool cached;
124

125 126
			/* size of cache */
			loff_t size;
127

128 129
			/* position at end of cache (position of next entry) */
			loff_t pos;
130

131 132
			/* version of the cache */
			u64 version;
133

134 135 136
			/* modification time of directory when cache was
			 * started */
			struct timespec64 mtime;
137

138 139
			/* iversion of directory when cache was started */
			u64 iversion;
140

141 142 143 144
			/* protects above fields */
			spinlock_t lock;
		} rdc;
	};
145

146 147
	/** Miscellaneous bits describing inode state */
	unsigned long state;
148 149 150

	/** Lock for serializing lookup and readdir for back compatibility*/
	struct mutex mutex;
151 152 153

	/** Lock to protect write related fields */
	spinlock_t lock;
154 155 156 157 158 159
};

/** FUSE inode state bits */
enum {
	/** Advise readdirplus  */
	FUSE_I_ADVISE_RDPLUS,
160 161
	/** Initialized with readdirplus */
	FUSE_I_INIT_RDPLUS,
162 163
	/** An operation changing file size is in progress  */
	FUSE_I_SIZE_UNSTABLE,
Miklos Szeredi's avatar
Miklos Szeredi committed
164 165
};

166
struct fuse_conn;
167
struct fuse_release_args;
168

169 170
/** FUSE specific file data */
struct fuse_file {
171 172 173
	/** Fuse connection for this file */
	struct fuse_conn *fc;

174 175
	/* Argument space reserved for release */
	struct fuse_release_args *release_args;
176

Tejun Heo's avatar
Tejun Heo committed
177 178 179
	/** Kernel file handle guaranteed to be unique */
	u64 kh;

180 181
	/** File handle used by userspace */
	u64 fh;
182

183 184 185
	/** Node id of this file */
	u64 nodeid;

186
	/** Refcount */
187
	refcount_t count;
188

189 190 191
	/** FOPEN_* flags returned by open */
	u32 open_flags;

192 193
	/** Entry on inode's write_files list */
	struct list_head write_entry;
Tejun Heo's avatar
Tejun Heo committed
194

195 196 197 198 199 200 201 202 203 204 205 206 207
	/* Readdir related */
	struct {
		/*
		 * Protects below fields against (crazy) parallel readdir on
		 * same open file.  Uncontended in the normal case.
		 */
		struct mutex lock;

		/* Dir stream position */
		loff_t pos;

		/* Offset in cache */
		loff_t cache_off;
208 209 210 211

		/* Version of cache we are reading */
		u64 version;

212 213
	} readdir;

Tejun Heo's avatar
Tejun Heo committed
214 215 216 217 218
	/** RB node to be linked on fuse_conn->polled_files */
	struct rb_node polled_node;

	/** Wait queue head for poll */
	wait_queue_head_t poll_wait;
Miklos Szeredi's avatar
Miklos Szeredi committed
219 220 221

	/** Has flock been performed on this file? */
	bool flock:1;
222 223
};

224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
/** 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;

256 257 258 259 260
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

261 262 263 264 265 266 267 268 269 270
	/** 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;

271 272 273
	/** Pages may be replaced with new ones */
	unsigned page_replace:1;

274 275 276 277
	/** Number or arguments */
	unsigned numargs;

	/** Array of arguments */
Miklos Szeredi's avatar
Miklos Szeredi committed
278
	struct fuse_arg args[2];
279 280
};

281 282 283 284 285 286
/** FUSE page descriptor */
struct fuse_page_desc {
	unsigned int length;
	unsigned int offset;
};

287
struct fuse_args {
288
	uint64_t nodeid;
289 290 291
	uint32_t opcode;
	unsigned short in_numargs;
	unsigned short out_numargs;
292
	bool force:1;
293
	bool noreply:1;
294
	bool nocreds:1;
295 296
	bool in_pages:1;
	bool out_pages:1;
297
	bool out_argvar:1;
298 299
	bool page_zeroing:1;
	bool page_replace:1;
300 301
	struct fuse_in_arg in_args[3];
	struct fuse_arg out_args[2];
302
	void (*end)(struct fuse_conn *fc, struct fuse_args *args, int error);
303 304
};

305 306 307 308 309 310 311
struct fuse_args_pages {
	struct fuse_args args;
	struct page **pages;
	struct fuse_page_desc *descs;
	unsigned int num_pages;
};

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

314 315
/** The request IO state (for asynchronous processing) */
struct fuse_io_priv {
316
	struct kref refcnt;
317 318 319 320 321 322 323
	int async;
	spinlock_t lock;
	unsigned reqs;
	ssize_t bytes;
	size_t size;
	__u64 offset;
	bool write;
324
	bool should_dirty;
325 326
	int err;
	struct kiocb *iocb;
327
	struct completion *done;
328
	bool blocking;
329 330
};

331
#define FUSE_IO_PRIV_SYNC(i) \
332
{					\
333
	.refcnt = KREF_INIT(1),		\
334
	.async = 0,			\
335
	.iocb = i,			\
336 337
}

Miklos Szeredi's avatar
Miklos Szeredi committed
338 339 340 341 342 343 344 345 346 347
/**
 * 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
Miklos Szeredi's avatar
Miklos Szeredi committed
348 349 350
 * FR_PENDING:		request is not yet in userspace
 * FR_SENT:		request is in userspace, waiting for an answer
 * FR_FINISHED:		request is finished
351
 * FR_PRIVATE:		request is on private list
Miklos Szeredi's avatar
Miklos Szeredi committed
352 353 354 355 356 357 358 359 360
 */
enum fuse_req_flag {
	FR_ISREPLY,
	FR_FORCE,
	FR_BACKGROUND,
	FR_WAITING,
	FR_ABORTED,
	FR_INTERRUPTED,
	FR_LOCKED,
Miklos Szeredi's avatar
Miklos Szeredi committed
361 362 363
	FR_PENDING,
	FR_SENT,
	FR_FINISHED,
364
	FR_PRIVATE,
Miklos Szeredi's avatar
Miklos Szeredi committed
365 366
};

367 368
/**
 * A request to the client
369 370 371 372
 *
 * .waitq.lock protects the following fields:
 *   - FR_ABORTED
 *   - FR_LOCKED (may also be modified under fc->lock, tested under both)
373 374
 */
struct fuse_req {
375 376
	/** This can be on either pending processing or io lists in
	    fuse_conn */
377 378
	struct list_head list;

379 380 381
	/** Entry on the interrupts list  */
	struct list_head intr_entry;

382 383 384
	/* Input/output arguments */
	struct fuse_args *args;

385
	/** refcount */
386
	refcount_t count;
387

Miklos Szeredi's avatar
Miklos Szeredi committed
388 389
	/* Request flags, updated with test/set/clear_bit() */
	unsigned long flags;
390

391 392 393 394 395 396 397 398 399 400 401
	/** 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 {
402
		struct {
403 404
			struct fuse_release_in in;
			struct inode *inode;
405
		} release;
406 407
		struct fuse_init_in init_in;
		struct fuse_init_out init_out;
408
		struct cuse_init_in cuse_init_in;
409 410 411 412
		struct {
			struct fuse_read_in in;
			u64 attr_ver;
		} read;
413 414 415
		struct {
			struct fuse_write_in in;
			struct fuse_write_out out;
416
			struct fuse_req *next;
417
		} write;
Miklos Szeredi's avatar
Miklos Szeredi committed
418
		struct fuse_notify_retrieve_in retrieve_in;
419 420 421
	} misc;

	/** page vector */
422 423
	struct page **pages;

424 425 426
	/** page-descriptor vector */
	struct fuse_page_desc *page_descs;

427 428 429 430 431
	/** size of the 'pages' array */
	unsigned max_pages;

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

433 434 435
	/** inline page-descriptor vector */
	struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];

436 437 438 439
	/** number of pages in vector */
	unsigned num_pages;

	/** File used in the request (or NULL) */
440
	struct fuse_file *ff;
441

Miklos Szeredi's avatar
Miklos Szeredi committed
442 443 444
	/** Inode used in the request or NULL */
	struct inode *inode;

445 446 447
	/** AIO control block */
	struct fuse_io_priv *io;

Miklos Szeredi's avatar
Miklos Szeredi committed
448 449 450
	/** Link on fi->writepages */
	struct list_head writepages_entry;

451 452
	/** Request completion callback */
	void (*end)(struct fuse_conn *, struct fuse_req *);
453

454 455
};

456
struct fuse_iqueue {
457 458 459
	/** Connection established */
	unsigned connected;

460 461 462
	/** Lock protecting accesses to members of this structure */
	spinlock_t lock;

463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
	/** 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;
};

486 487 488
#define FUSE_PQ_HASH_BITS 8
#define FUSE_PQ_HASH_SIZE (1 << FUSE_PQ_HASH_BITS)

489
struct fuse_pqueue {
490 491 492
	/** Connection established */
	unsigned connected;

Miklos Szeredi's avatar
Miklos Szeredi committed
493 494 495
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

496 497
	/** Hash table of requests being processed */
	struct list_head *processing;
498 499 500 501 502

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

503 504 505 506 507 508 509
/**
 * Fuse device instance
 */
struct fuse_dev {
	/** Fuse connection for this device */
	struct fuse_conn *fc;

510 511 512
	/** Processing queue */
	struct fuse_pqueue pq;

513 514 515 516
	/** list entry on fc->devices */
	struct list_head entry;
};

Miklos Szeredi's avatar
Miklos Szeredi committed
517 518 519 520 521 522 523 524
/**
 * 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 {
525 526 527
	/** Lock protecting accessess to  members of this structure */
	spinlock_t lock;

528
	/** Refcount */
529
	refcount_t count;
530

531 532 533
	/** Number of fuse_dev's */
	atomic_t dev_count;

Al Viro's avatar
Al Viro committed
534 535
	struct rcu_head rcu;

Miklos Szeredi's avatar
Miklos Szeredi committed
536
	/** The user id for this mount */
537
	kuid_t user_id;
Miklos Szeredi's avatar
Miklos Szeredi committed
538

539
	/** The group id for this mount */
540
	kgid_t group_id;
541

542 543 544
	/** The pid namespace for this mount */
	struct pid_namespace *pid_ns;

545 546 547
	/** The user namespace for this mount */
	struct user_namespace *user_ns;

548 549 550
	/** Maximum read size */
	unsigned max_read;

Miklos Szeredi's avatar
Miklos Szeredi committed
551 552 553
	/** Maximum write size */
	unsigned max_write;

554 555 556
	/** Maxmum number of pages that can be used in a single request */
	unsigned int max_pages;

557 558
	/** Input queue */
	struct fuse_iqueue iq;
559

Tejun Heo's avatar
Tejun Heo committed
560
	/** The next unique kernel file handle */
561
	atomic64_t khctr;
Tejun Heo's avatar
Tejun Heo committed
562

Tejun Heo's avatar
Tejun Heo committed
563 564 565
	/** rbtree of fuse_files waiting for poll events indexed by ph */
	struct rb_root polled_files;

566 567 568 569 570 571
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

572 573 574
	/** Number of requests currently in the background */
	unsigned num_background;

575 576 577 578 579 580
	/** 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;

Kirill Tkhai's avatar
Kirill Tkhai committed
581 582 583 584
	/** Protects: max_background, congestion_threshold, num_background,
	 * active_background, bg_queue, blocked */
	spinlock_t bg_lock;

585 586 587 588
	/** Flag indicating that INIT reply has been received. Allocating
	 * any fuse request will be suspended until the flag is set */
	int initialized;

589 590 591 592 593 594 595
	/** 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;
596

597 598
	/** Connection established, cleared on umount, connection
	    abort and device release */
599
	unsigned connected;
600

601 602 603
	/** Connection aborted via sysfs */
	bool aborted;

604 605 606
	/** Connection failed (version mismatch).  Cannot race with
	    setting other bitfields since it is only set once in INIT
	    reply, before any other request, and never cleared */
Miklos Szeredi's avatar
Miklos Szeredi committed
607
	unsigned conn_error:1;
608

609
	/** Connection successful.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
610
	unsigned conn_init:1;
611

612
	/** Do readpages asynchronously?  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
613
	unsigned async_read:1;
614

615 616 617
	/** Return an unique read error after abort.  Only set in INIT */
	unsigned abort_err:1;

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

621
	/** Filesystem supports NFS exporting.  Only set in INIT */
Miklos Szeredi's avatar
Miklos Szeredi committed
622
	unsigned export_support:1;
623

624 625 626
	/** write-back cache policy (default is write-through) */
	unsigned writeback_cache:1;

627 628 629
	/** allow parallel lookups and readdir (default is serialized) */
	unsigned parallel_dirops:1;

630 631 632
	/** handle fs handles killing suid/sgid/cap on write/chown/trunc */
	unsigned handle_killpriv:1;

633 634 635
	/** cache READLINK responses in page cache */
	unsigned cache_symlinks:1;

636 637 638 639 640
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

641 642 643
	/** Is open/release not implemented by fs? */
	unsigned no_open:1;

644 645 646
	/** Is opendir/releasedir not implemented by fs? */
	unsigned no_opendir:1;

647
	/** Is fsync not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
648
	unsigned no_fsync:1;
649

650
	/** Is fsyncdir not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
651
	unsigned no_fsyncdir:1;
652

653
	/** Is flush not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
654
	unsigned no_flush:1;
655

656
	/** Is setxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
657
	unsigned no_setxattr:1;
658 659

	/** Is getxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
660
	unsigned no_getxattr:1;
661 662

	/** Is listxattr not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
663
	unsigned no_listxattr:1;
664 665

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

Miklos Szeredi's avatar
Miklos Szeredi committed
668
	/** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
669
	unsigned no_lock:1;
670

671
	/** Is access not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
672
	unsigned no_access:1;
673

674
	/** Is create not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
675
	unsigned no_create:1;
676

677
	/** Is interrupt not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
678
	unsigned no_interrupt:1;
679

680
	/** Is bmap not implemented by fs? */
Miklos Szeredi's avatar
Miklos Szeredi committed
681
	unsigned no_bmap:1;
682

Tejun Heo's avatar
Tejun Heo committed
683 684 685
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

686
	/** Do multi-page cached writes */
Miklos Szeredi's avatar
Miklos Szeredi committed
687
	unsigned big_writes:1;
688

689 690 691
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
692 693 694
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

695 696 697
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

Miklos Szeredi's avatar
Miklos Szeredi committed
698 699 700
	/** Is rename with flags implemented by fs? */
	unsigned no_rename2:1;

701 702 703
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

704 705 706
	/** Filesystem is fully reponsible for page cache invalidation. */
	unsigned explicit_inval_data:1;

707
	/** Does the filesystem support readdirplus? */
708 709
	unsigned do_readdirplus:1;

710 711 712
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

713 714 715
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

716 717 718
	/** Is lseek not implemented by fs? */
	unsigned no_lseek:1;

Seth Forshee's avatar
Seth Forshee committed
719 720 721
	/** Does the filesystem support posix acls? */
	unsigned posix_acl:1;

722 723 724 725 726 727
	/** 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;

728 729 730
	/** Does the filesystem support copy_file_range? */
	unsigned no_copy_file_range:1;

731 732 733
	/* Send DESTROY request */
	unsigned int destroy:1;

734 735 736
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

737 738 739
	/** Negotiated minor version */
	unsigned minor;

740 741 742
	/** Entry on the fuse_conn_list */
	struct list_head entry;

743 744
	/** Device ID from super block */
	dev_t dev;
745 746 747 748 749 750

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

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

752 753
	/** Key for lock owner ID scrambling */
	u32 scramble_key[4];
754

755
	/** Version counter for attribute changes */
756
	atomic64_t attr_version;
Tejun Heo's avatar
Tejun Heo committed
757 758 759

	/** Called on final put */
	void (*release)(struct fuse_conn *);
John Muir's avatar
John Muir committed
760 761 762 763 764 765

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

	/** Read/write semaphore to hold when accessing sb. */
	struct rw_semaphore killsb;
766 767 768

	/** List of device instances belonging to this connection */
	struct list_head devices;
Miklos Szeredi's avatar
Miklos Szeredi committed
769 770 771 772
};

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
773
	return sb->s_fs_info;
Miklos Szeredi's avatar
Miklos Szeredi committed
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
}

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

Miklos Szeredi's avatar
Miklos Szeredi committed
791 792 793 794 795
static inline int invalid_nodeid(u64 nodeid)
{
	return !nodeid || nodeid == FUSE_ROOT_ID;
}

796 797 798 799 800
static inline u64 fuse_get_attr_version(struct fuse_conn *fc)
{
	return atomic64_read(&fc->attr_version);
}

801
/** Device operations */
802
extern const struct file_operations fuse_dev_operations;
803

Al Viro's avatar
Al Viro committed
804
extern const struct dentry_operations fuse_dentry_operations;
805
extern const struct dentry_operations fuse_root_dentry_operations;
Miklos Szeredi's avatar
Miklos Szeredi committed
806

John Muir's avatar
John Muir committed
807 808 809 810 811
/**
 * Inode to nodeid comparison.
 */
int fuse_inode_eq(struct inode *inode, void *_nodeidp);

812 813 814
/**
 * Get a filled in inode
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
815
struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
816 817
			int generation, struct fuse_attr *attr,
			u64 attr_valid, u64 attr_version);
818

Al Viro's avatar
Al Viro committed
819
int fuse_lookup_name(struct super_block *sb, u64 nodeid, const struct qstr *name,
820 821
		     struct fuse_entry_out *outarg, struct inode **inode);

822 823 824
/**
 * Send FORGET command
 */
825 826 827 828
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);
829

830
/*
831
 * Initialize READ or READDIR request
832
 */
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
struct fuse_io_args {
	union {
		struct {
			struct fuse_read_in in;
			u64 attr_ver;
		} read;
		struct {
			struct fuse_write_in in;
			struct fuse_write_out out;
		} write;
	};
	struct fuse_args_pages ap;
	struct fuse_io_priv *io;
	struct fuse_file *ff;
};

void fuse_read_args_fill(struct fuse_io_args *ia, struct file *file, loff_t pos,
			 size_t count, int opcode);

852 853 854 855

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

Tejun Heo's avatar
Tejun Heo committed
858
struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
859
void fuse_file_free(struct fuse_file *ff);
860
void fuse_finish_open(struct inode *inode, struct file *file);
861

862
void fuse_sync_release(struct fuse_inode *fi, struct fuse_file *ff, int flags);
863

864 865 866
/**
 * Send RELEASE or RELEASEDIR request
 */
867
void fuse_release_common(struct file *file, bool isdir);
868

869 870 871
/**
 * Send FSYNC or FSYNCDIR request
 */
872
int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
873
		      int datasync, int opcode);
874

Tejun Heo's avatar
Tejun Heo committed
875 876 877 878 879 880
/**
 * Notify poll wakeup
 */
int fuse_notify_poll_wakeup(struct fuse_conn *fc,
			    struct fuse_notify_poll_wakeup_out *outarg);

881
/**
882
 * Initialize file operations on a regular file
883 884 885
 */
void fuse_init_file_inode(struct inode *inode);

886
/**
887
 * Initialize inode operations on regular files and special files
888 889 890 891
 */
void fuse_init_common(struct inode *inode);

/**
892
 * Initialize inode and file operations on a directory
893 894 895 896
 */
void fuse_init_dir(struct inode *inode);

/**
897
 * Initialize inode operations on a symlink
898 899 900 901 902 903
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
904 905
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
			    u64 attr_valid, u64 attr_version);
906

Miklos Szeredi's avatar
Miklos Szeredi committed
907 908 909
void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
				   u64 attr_valid);

910 911 912 913 914 915 916 917 918 919
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

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

920
int fuse_ctl_init(void);
921
void __exit fuse_ctl_cleanup(void);
922

923 924 925 926
/**
 * Simple request sending that does request allocation and freeing
 */
ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);
927 928
int fuse_simple_background(struct fuse_conn *fc, struct fuse_args *args,
			   gfp_t gfp_flags);
929

930
/* Abort all requests */
Miklos Szeredi's avatar
Miklos Szeredi committed
931
void fuse_abort_conn(struct fuse_conn *fc);
932
void fuse_wait_aborted(struct fuse_conn *fc);
933

934 935 936 937
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
938

Miklos Szeredi's avatar
Miklos Szeredi committed
939 940
void fuse_invalidate_entry_cache(struct dentry *entry);

941 942
void fuse_invalidate_atime(struct inode *inode);

Miklos Szeredi's avatar
Miklos Szeredi committed
943 944 945
u64 entry_attr_timeout(struct fuse_entry_out *o);
void fuse_change_entry_timeout(struct dentry *entry, struct fuse_entry_out *o);

946 947 948 949 950
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

951 952 953
/**
 * Initialize fuse_conn
 */
954
void fuse_conn_init(struct fuse_conn *fc, struct user_namespace *user_ns);
955

956 957 958 959 960
/**
 * Release reference to fuse_conn
 */
void fuse_conn_put(struct fuse_conn *fc);

961 962 963
struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
void fuse_dev_free(struct fuse_dev *fud);

964 965 966 967 968 969 970 971 972
/**
 * 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);
973 974 975 976 977

/**
 * Is file type valid?
 */
int fuse_valid_type(int m);
978 979

/**
980
 * Is current process allowed to perform filesystem operation?
981
 */
982
int fuse_allow_current_process(struct fuse_conn *fc);
983 984

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

Seth Forshee's avatar
Seth Forshee committed
986 987
void fuse_update_ctime(struct inode *inode);

Miklos Szeredi's avatar
Miklos Szeredi committed
988
int fuse_update_attributes(struct inode *inode, struct file *file);
Miklos Szeredi's avatar
Miklos Szeredi committed
989 990 991 992 993

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
994

John Muir's avatar
John Muir committed
995 996 997 998 999 1000 1001 1002 1003
/**
 * 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.
1004 1005 1006 1007 1008 1009
 *
 * If the child_nodeid is non-zero and:
 *    - matches the inode number for the dentry matching parent/name,
 *    - is not a mount point
 *    - is a file or oan empty directory
 * then the dentry is unhashed (d_delete()).
John Muir's avatar
John Muir committed
1010 1011
 */
int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
1012
			     u64 child_nodeid, struct qstr *name);
John Muir's avatar
John Muir committed
1013

1014 1015
int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
		 bool isdir);
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026

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

1027 1028
ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
		       loff_t *ppos, int flags);
1029 1030
long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
		   unsigned int flags);
1031 1032
long fuse_ioctl_common(struct file *file, unsigned int cmd,
		       unsigned long arg, unsigned int flags);
Al Viro's avatar
Al Viro committed
1033
__poll_t fuse_file_poll(struct file *file, poll_table *wait);
1034 1035
int fuse_dev_release(struct inode *inode, struct file *file);

1036 1037
bool fuse_write_update_size(struct inode *inode, loff_t pos);

1038
int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
Miklos Szeredi's avatar
Miklos Szeredi committed
1039
int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
Miklos Szeredi's avatar
Miklos Szeredi committed
1040

1041
int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
1042 1043
		    struct file *file);

1044 1045
void fuse_set_initialized(struct fuse_conn *fc);

1046 1047
void fuse_unlock_inode(struct inode *inode, bool locked);
bool fuse_lock_inode(struct inode *inode);
1048

Seth Forshee's avatar
Seth Forshee committed
1049 1050 1051 1052
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);
Seth Forshee's avatar
Seth Forshee committed
1053
ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
Seth Forshee's avatar
Seth Forshee committed
1054
int fuse_removexattr(struct inode *inode, const char *name);
Seth Forshee's avatar
Seth Forshee committed
1055
extern const struct xattr_handler *fuse_xattr_handlers[];
Seth Forshee's avatar
Seth Forshee committed
1056
extern const struct xattr_handler *fuse_acl_xattr_handlers[];
1057
extern const struct xattr_handler *fuse_no_acl_xattr_handlers[];
Seth Forshee's avatar
Seth Forshee committed
1058 1059 1060 1061

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);
Seth Forshee's avatar
Seth Forshee committed
1062

Miklos Szeredi's avatar
Miklos Szeredi committed
1063 1064 1065 1066

/* readdir.c */
int fuse_readdir(struct file *file, struct dir_context *ctx);

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