fuse_i.h 23.2 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/refcount.h>
M
Miklos Szeredi 已提交
28

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

121 122
struct fuse_conn;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

258 259
#define FUSE_IO_PRIV_SYNC(f) \
{					\
260
	.refcnt = KREF_INIT(1),		\
261 262 263 264
	.async = 0,			\
	.file = f,			\
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

451 452 453
	/** Refcount */
	atomic_t count;

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

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

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

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

465 466 467
	/** Maximum read size */
	unsigned max_read;

M
Miklos Szeredi 已提交
468 469 470
	/** Maximum write size */
	unsigned max_write;

M
Miklos Szeredi 已提交
471 472
	/** Input queue */
	struct fuse_iqueue iq;
M
Miklos Szeredi 已提交
473

T
Tejun Heo 已提交
474 475 476
	/** The next unique kernel file handle */
	u64 khctr;

T
Tejun Heo 已提交
477 478 479
	/** rbtree of fuse_files waiting for poll events indexed by ph */
	struct rb_root polled_files;

480 481 482 483 484 485
	/** Maximum number of outstanding background requests */
	unsigned max_background;

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

486 487 488
	/** Number of requests currently in the background */
	unsigned num_background;

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

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

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

510 511
	/** Connection established, cleared on umount, connection
	    abort and device release */
M
Miklos Szeredi 已提交
512
	unsigned connected;
M
Miklos Szeredi 已提交
513

M
Miklos Szeredi 已提交
514 515 516
	/** 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 已提交
517
	unsigned conn_error:1;
M
Miklos Szeredi 已提交
518

519
	/** Connection successful.  Only set in INIT */
M
Miklos Szeredi 已提交
520
	unsigned conn_init:1;
521

522
	/** Do readpages asynchronously?  Only set in INIT */
M
Miklos Szeredi 已提交
523
	unsigned async_read:1;
524

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

528
	/** Filesystem supports NFS exporting.  Only set in INIT */
M
Miklos Szeredi 已提交
529
	unsigned export_support:1;
530

531 532 533
	/** Set if bdi is valid */
	unsigned bdi_initialized:1;

534 535 536
	/** write-back cache policy (default is write-through) */
	unsigned writeback_cache:1;

537 538 539
	/** allow parallel lookups and readdir (default is serialized) */
	unsigned parallel_dirops:1;

540 541 542
	/** handle fs handles killing suid/sgid/cap on write/chown/trunc */
	unsigned handle_killpriv:1;

M
Miklos Szeredi 已提交
543 544 545 546 547
	/*
	 * The following bitfields are only for optimization purposes
	 * and hence races in setting them will not cause malfunction
	 */

548 549 550
	/** Is open/release not implemented by fs? */
	unsigned no_open:1;

M
Miklos Szeredi 已提交
551
	/** Is fsync not implemented by fs? */
M
Miklos Szeredi 已提交
552
	unsigned no_fsync:1;
M
Miklos Szeredi 已提交
553

554
	/** Is fsyncdir not implemented by fs? */
M
Miklos Szeredi 已提交
555
	unsigned no_fsyncdir:1;
556

M
Miklos Szeredi 已提交
557
	/** Is flush not implemented by fs? */
M
Miklos Szeredi 已提交
558
	unsigned no_flush:1;
M
Miklos Szeredi 已提交
559

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

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

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

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

M
Miklos Szeredi 已提交
572
	/** Are posix file locking primitives not implemented by fs? */
M
Miklos Szeredi 已提交
573
	unsigned no_lock:1;
574

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

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

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

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

T
Tejun Heo 已提交
587 588 589
	/** Is poll not implemented by fs? */
	unsigned no_poll:1;

590
	/** Do multi-page cached writes */
M
Miklos Szeredi 已提交
591
	unsigned big_writes:1;
592

593 594 595
	/** Don't apply umask to creation modes */
	unsigned dont_mask:1;

M
Miklos Szeredi 已提交
596 597 598
	/** Are BSD file locking primitives not implemented by fs? */
	unsigned no_flock:1;

599 600 601
	/** Is fallocate not implemented by fs? */
	unsigned no_fallocate:1;

M
Miklos Szeredi 已提交
602 603 604
	/** Is rename with flags implemented by fs? */
	unsigned no_rename2:1;

605 606 607
	/** Use enhanced/automatic page cache invalidation. */
	unsigned auto_inval_data:1;

608
	/** Does the filesystem support readdirplus? */
609 610
	unsigned do_readdirplus:1;

611 612 613
	/** Does the filesystem want adaptive readdirplus? */
	unsigned readdirplus_auto:1;

614 615 616
	/** Does the filesystem support asynchronous direct-IO submission? */
	unsigned async_dio:1;

617 618 619
	/** Is lseek not implemented by fs? */
	unsigned no_lseek:1;

S
Seth Forshee 已提交
620 621 622
	/** Does the filesystem support posix acls? */
	unsigned posix_acl:1;

M
Miklos Szeredi 已提交
623 624 625 626 627 628
	/** 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;

629 630 631
	/** The number of requests waiting for completion */
	atomic_t num_waiting;

632 633 634
	/** Negotiated minor version */
	unsigned minor;

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

638 639 640
	/** Entry on the fuse_conn_list */
	struct list_head entry;

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

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

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

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

	/** Reserved request for the DESTROY message */
	struct fuse_req *destroy_req;
655 656 657

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

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

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

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

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

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

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

A
Al Viro 已提交
695
extern const struct dentry_operations fuse_dentry_operations;
696
extern const struct dentry_operations fuse_root_dentry_operations;
M
Miklos Szeredi 已提交
697

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

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

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

713 714 715
/**
 * Send FORGET command
 */
716 717 718 719
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);
720

721 722 723
/* Used by READDIRPLUS */
void fuse_force_forget(struct file *file, u64 nodeid);

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

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

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

739
void fuse_sync_release(struct fuse_file *ff, int flags);
740

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

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

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

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

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

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

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

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

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

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

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

797
int fuse_ctl_init(void);
798
void __exit fuse_ctl_cleanup(void);
799

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

805
struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
M
Miklos Szeredi 已提交
806

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

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

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

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

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

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

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

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

855
/* Abort all requests */
856 857
void fuse_abort_conn(struct fuse_conn *fc);

858 859 860 861
/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);
862

M
Miklos Szeredi 已提交
863 864
void fuse_invalidate_entry_cache(struct dentry *entry);

865 866
void fuse_invalidate_atime(struct inode *inode);

867 868 869 870 871
/**
 * Acquire reference to fuse_conn
 */
struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);

872 873 874
/**
 * Initialize fuse_conn
 */
875
void fuse_conn_init(struct fuse_conn *fc);
876

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

882 883 884
struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
void fuse_dev_free(struct fuse_dev *fud);

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

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

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

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

S
Seth Forshee 已提交
907 908
void fuse_update_ctime(struct inode *inode);

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

void fuse_flush_writepages(struct inode *inode);

void fuse_set_nowrite(struct inode *inode);
void fuse_release_nowrite(struct inode *inode);
916 917

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

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

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

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

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

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

965
int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
966 967
		    struct file *file);

968 969
void fuse_set_initialized(struct fuse_conn *fc);

970 971 972
void fuse_unlock_inode(struct inode *inode);
void fuse_lock_inode(struct inode *inode);

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

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