fuse_i.h 23.3 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>
M
Miklos Szeredi 已提交
29

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

122 123
struct fuse_conn;

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

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

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

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

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

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

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

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

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

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

M
Miklos Szeredi 已提交
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
/** 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 已提交
192 193 194 195 196
	/*
	 * The following bitfields are not changed during the request
	 * processing
	 */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

469 470 471
	/** Maximum read size */
	unsigned max_read;

M
Miklos Szeredi 已提交
472 473 474
	/** Maximum write size */
	unsigned max_write;

M
Miklos Szeredi 已提交
475 476
	/** Input queue */
	struct fuse_iqueue iq;
M
Miklos Szeredi 已提交
477

T
Tejun Heo 已提交
478 479 480
	/** The next unique kernel file handle */
	u64 khctr;

T
Tejun Heo 已提交
481 482 483
	/** rbtree of fuse_files waiting for poll events indexed by ph */
	struct rb_root polled_files;

484 485 486 487 488 489
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

490 491 492
	/** Number of requests currently in the background */
	unsigned num_background;

493 494 495 496 497 498
	/** 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 已提交
499 500 501 502
	/** Flag indicating that INIT reply has been received. Allocating
	 * any fuse request will be suspended until the flag is set */
	int initialized;

503 504 505 506 507 508 509
	/** 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;
510 511 512

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

514 515
	/** Connection established, cleared on umount, connection
	    abort and device release */
M
Miklos Szeredi 已提交
516
	unsigned connected;
M
Miklos Szeredi 已提交
517

518 519 520
	/** Connection aborted via sysfs */
	bool aborted;

M
Miklos Szeredi 已提交
521 522 523
	/** 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 已提交
524
	unsigned conn_error:1;
M
Miklos Szeredi 已提交
525

526
	/** Connection successful.  Only set in INIT */
M
Miklos Szeredi 已提交
527
	unsigned conn_init:1;
528

529
	/** Do readpages asynchronously?  Only set in INIT */
M
Miklos Szeredi 已提交
530
	unsigned async_read:1;
531

532 533 534
	/** Return an unique read error after abort.  Only set in INIT */
	unsigned abort_err:1;

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

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

541 542 543
	/** write-back cache policy (default is write-through) */
	unsigned writeback_cache:1;

544 545 546
	/** allow parallel lookups and readdir (default is serialized) */
	unsigned parallel_dirops:1;

547 548 549
	/** handle fs handles killing suid/sgid/cap on write/chown/trunc */
	unsigned handle_killpriv:1;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

S
Seth Forshee 已提交
627 628 629
	/** Does the filesystem support posix acls? */
	unsigned posix_acl:1;

M
Miklos Szeredi 已提交
630 631 632 633 634 635
	/** 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;

636 637 638
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

639 640 641
	/** Negotiated minor version */
	unsigned minor;

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

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

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

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

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

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

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

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

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

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

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

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

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

A
Al Viro 已提交
699
extern const struct dentry_operations fuse_dentry_operations;
700
extern const struct dentry_operations fuse_root_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);
M
Miklos Szeredi 已提交
740
void fuse_file_free(struct fuse_file *ff);
741
void fuse_finish_open(struct inode *inode, struct file *file);
M
Miklos Szeredi 已提交
742

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

859
/* Abort all requests */
860
void fuse_abort_conn(struct fuse_conn *fc, bool is_abort);
861

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

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

869 870
void fuse_invalidate_atime(struct inode *inode);

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

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

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

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

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

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

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

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

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

M
Miklos Szeredi 已提交
913
int fuse_update_attributes(struct inode *inode, struct file *file);
M
Miklos Szeredi 已提交
914 915 916 917 918

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
919 920

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

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

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

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

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

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

968
int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
969 970
		    struct file *file);

971 972
void fuse_set_initialized(struct fuse_conn *fc);

973 974 975
void fuse_unlock_inode(struct inode *inode);
void fuse_lock_inode(struct inode *inode);

S
Seth Forshee 已提交
976 977 978 979
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 已提交
980
ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
S
Seth Forshee 已提交
981
int fuse_removexattr(struct inode *inode, const char *name);
S
Seth Forshee 已提交
982
extern const struct xattr_handler *fuse_xattr_handlers[];
S
Seth Forshee 已提交
983 984 985 986 987
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 已提交
988

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