fuse.h 11.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.
*/

9 10 11 12 13 14 15
/*
 * This file defines the kernel interface of FUSE
 *
 * Protocol changelog:
 *
 * 7.9:
 *  - new fuse_getattr_in input argument of GETATTR
16
 *  - add lk_flags in fuse_lk_in
17
 *  - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
18
 *  - add blksize field to fuse_attr
19
 *  - add file flags field to fuse_read_in and fuse_write_in
T
Tejun Heo 已提交
20 21 22
 *
 * 7.10
 *  - add nonseekable open flag
M
Miklos Szeredi 已提交
23 24 25 26 27
 *
 * 7.11
 *  - add IOCTL message
 *  - add unsolicited notification support
 *  - add POLL message and NOTIFY_POLL notification
28 29 30
 *
 * 7.12
 *  - add umask flag to input argument of open, mknod and mkdir
J
John Muir 已提交
31 32
 *  - add notification messages for invalidation of inodes and
 *    directory entries
33 34 35 36
 *
 * 7.13
 *  - make max number of background requests and congestion threshold
 *    tunables
37 38 39
 *
 * 7.14
 *  - add splice support to fuse device
M
Miklos Szeredi 已提交
40 41 42
 *
 * 7.15
 *  - add store notify
M
Miklos Szeredi 已提交
43
 *  - add retrieve notify
44 45 46
 *
 * 7.16
 *  - add BATCH_FORGET request
M
Miklos Szeredi 已提交
47 48 49
 *  - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
 *    fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
 *  - add FUSE_IOCTL_32BIT flag
50
 */
M
Miklos Szeredi 已提交
51

T
Tejun Heo 已提交
52 53 54
#ifndef _LINUX_FUSE_H
#define _LINUX_FUSE_H

M
Miklos Szeredi 已提交
55
#include <linux/types.h>
M
Miklos Szeredi 已提交
56

57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
/*
 * Version negotiation:
 *
 * Both the kernel and userspace send the version they support in the
 * INIT request and reply respectively.
 *
 * If the major versions match then both shall use the smallest
 * of the two minor versions for communication.
 *
 * If the kernel supports a larger major version, then userspace shall
 * reply with the major version it supports, ignore the rest of the
 * INIT message and expect a new INIT message from the kernel with a
 * matching major version.
 *
 * If the library supports a larger major version, then it shall fall
 * back to the major protocol version sent by the kernel for
 * communication and reply with that major version (and an arbitrary
 * supported minor version).
 */

M
Miklos Szeredi 已提交
77
/** Version number of this interface */
78
#define FUSE_KERNEL_VERSION 7
M
Miklos Szeredi 已提交
79 80

/** Minor version number of this interface */
81
#define FUSE_KERNEL_MINOR_VERSION 16
M
Miklos Szeredi 已提交
82 83 84 85

/** The node ID of the root inode */
#define FUSE_ROOT_ID 1

M
Miklos Szeredi 已提交
86 87 88
/* Make sure all structures are padded to 64bit boundary, so 32bit
   userspace works under 64bit kernels */

M
Miklos Szeredi 已提交
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
struct fuse_attr {
	__u64	ino;
	__u64	size;
	__u64	blocks;
	__u64	atime;
	__u64	mtime;
	__u64	ctime;
	__u32	atimensec;
	__u32	mtimensec;
	__u32	ctimensec;
	__u32	mode;
	__u32	nlink;
	__u32	uid;
	__u32	gid;
	__u32	rdev;
104 105
	__u32	blksize;
	__u32	padding;
M
Miklos Szeredi 已提交
106 107
};

108 109 110 111 112 113 114 115
struct fuse_kstatfs {
	__u64	blocks;
	__u64	bfree;
	__u64	bavail;
	__u64	files;
	__u64	ffree;
	__u32	bsize;
	__u32	namelen;
116 117 118
	__u32	frsize;
	__u32	padding;
	__u32	spare[6];
119 120
};

121 122 123 124 125 126 127
struct fuse_file_lock {
	__u64	start;
	__u64	end;
	__u32	type;
	__u32	pid; /* tgid */
};

128 129 130
/**
 * Bitmasks for fuse_setattr_in.valid
 */
131 132 133 134 135 136
#define FATTR_MODE	(1 << 0)
#define FATTR_UID	(1 << 1)
#define FATTR_GID	(1 << 2)
#define FATTR_SIZE	(1 << 3)
#define FATTR_ATIME	(1 << 4)
#define FATTR_MTIME	(1 << 5)
137
#define FATTR_FH	(1 << 6)
M
Miklos Szeredi 已提交
138 139
#define FATTR_ATIME_NOW	(1 << 7)
#define FATTR_MTIME_NOW	(1 << 8)
140
#define FATTR_LOCKOWNER	(1 << 9)
141

142 143 144 145 146
/**
 * Flags returned by the OPEN request
 *
 * FOPEN_DIRECT_IO: bypass page cache for this open file
 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
T
Tejun Heo 已提交
147
 * FOPEN_NONSEEKABLE: the file is not seekable
148 149 150
 */
#define FOPEN_DIRECT_IO		(1 << 0)
#define FOPEN_KEEP_CACHE	(1 << 1)
T
Tejun Heo 已提交
151
#define FOPEN_NONSEEKABLE	(1 << 2)
152

153 154
/**
 * INIT request/reply flags
155 156
 *
 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
157
 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
158 159
 */
#define FUSE_ASYNC_READ		(1 << 0)
160
#define FUSE_POSIX_LOCKS	(1 << 1)
161
#define FUSE_FILE_OPS		(1 << 2)
162
#define FUSE_ATOMIC_O_TRUNC	(1 << 3)
163
#define FUSE_EXPORT_SUPPORT	(1 << 4)
164
#define FUSE_BIG_WRITES		(1 << 5)
165
#define FUSE_DONT_MASK		(1 << 6)
166

167 168 169 170 171 172 173
/**
 * CUSE INIT request/reply flags
 *
 * CUSE_UNRESTRICTED_IOCTL:  use unrestricted ioctl
 */
#define CUSE_UNRESTRICTED_IOCTL	(1 << 0)

174 175 176 177 178
/**
 * Release flags
 */
#define FUSE_RELEASE_FLUSH	(1 << 0)

179 180 181 182 183
/**
 * Getattr flags
 */
#define FUSE_GETATTR_FH		(1 << 0)

184 185 186 187 188
/**
 * Lock flags
 */
#define FUSE_LK_FLOCK		(1 << 0)

189 190 191 192
/**
 * WRITE flags
 *
 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
193
 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
194 195
 */
#define FUSE_WRITE_CACHE	(1 << 0)
196 197 198 199 200 201
#define FUSE_WRITE_LOCKOWNER	(1 << 1)

/**
 * Read flags
 */
#define FUSE_READ_LOCKOWNER	(1 << 1)
202

T
Tejun Heo 已提交
203 204 205 206 207 208
/**
 * Ioctl flags
 *
 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
 * FUSE_IOCTL_RETRY: retry with new iovecs
M
Miklos Szeredi 已提交
209
 * FUSE_IOCTL_32BIT: 32bit ioctl
T
Tejun Heo 已提交
210 211 212 213 214 215
 *
 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
 */
#define FUSE_IOCTL_COMPAT	(1 << 0)
#define FUSE_IOCTL_UNRESTRICTED	(1 << 1)
#define FUSE_IOCTL_RETRY	(1 << 2)
M
Miklos Szeredi 已提交
216
#define FUSE_IOCTL_32BIT	(1 << 3)
T
Tejun Heo 已提交
217 218 219

#define FUSE_IOCTL_MAX_IOV	256

T
Tejun Heo 已提交
220 221 222 223 224 225 226
/**
 * Poll flags
 *
 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
 */
#define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)

M
Miklos Szeredi 已提交
227
enum fuse_opcode {
228 229 230
	FUSE_LOOKUP	   = 1,
	FUSE_FORGET	   = 2,  /* no reply */
	FUSE_GETATTR	   = 3,
231
	FUSE_SETATTR	   = 4,
232
	FUSE_READLINK	   = 5,
233 234 235 236 237 238 239
	FUSE_SYMLINK	   = 6,
	FUSE_MKNOD	   = 8,
	FUSE_MKDIR	   = 9,
	FUSE_UNLINK	   = 10,
	FUSE_RMDIR	   = 11,
	FUSE_RENAME	   = 12,
	FUSE_LINK	   = 13,
M
Miklos Szeredi 已提交
240 241 242
	FUSE_OPEN	   = 14,
	FUSE_READ	   = 15,
	FUSE_WRITE	   = 16,
243
	FUSE_STATFS	   = 17,
M
Miklos Szeredi 已提交
244 245
	FUSE_RELEASE       = 18,
	FUSE_FSYNC         = 20,
246 247 248 249
	FUSE_SETXATTR      = 21,
	FUSE_GETXATTR      = 22,
	FUSE_LISTXATTR     = 23,
	FUSE_REMOVEXATTR   = 24,
M
Miklos Szeredi 已提交
250
	FUSE_FLUSH         = 25,
251 252 253
	FUSE_INIT          = 26,
	FUSE_OPENDIR       = 27,
	FUSE_READDIR       = 28,
254
	FUSE_RELEASEDIR    = 29,
M
Miklos Szeredi 已提交
255
	FUSE_FSYNCDIR      = 30,
256 257 258
	FUSE_GETLK         = 31,
	FUSE_SETLK         = 32,
	FUSE_SETLKW        = 33,
M
Miklos Szeredi 已提交
259
	FUSE_ACCESS        = 34,
260 261
	FUSE_CREATE        = 35,
	FUSE_INTERRUPT     = 36,
M
Miklos Szeredi 已提交
262
	FUSE_BMAP          = 37,
263
	FUSE_DESTROY       = 38,
T
Tejun Heo 已提交
264
	FUSE_IOCTL         = 39,
T
Tejun Heo 已提交
265
	FUSE_POLL          = 40,
M
Miklos Szeredi 已提交
266
	FUSE_NOTIFY_REPLY  = 41,
267
	FUSE_BATCH_FORGET  = 42,
268 269 270

	/* CUSE specific operations */
	CUSE_INIT          = 4096,
M
Miklos Szeredi 已提交
271 272
};

273
enum fuse_notify_code {
T
Tejun Heo 已提交
274
	FUSE_NOTIFY_POLL   = 1,
J
John Muir 已提交
275 276
	FUSE_NOTIFY_INVAL_INODE = 2,
	FUSE_NOTIFY_INVAL_ENTRY = 3,
M
Miklos Szeredi 已提交
277
	FUSE_NOTIFY_STORE = 4,
M
Miklos Szeredi 已提交
278
	FUSE_NOTIFY_RETRIEVE = 5,
279 280 281
	FUSE_NOTIFY_CODE_MAX,
};

282 283
/* The read buffer is required to be at least 8k, but may be much larger */
#define FUSE_MIN_READ_BUFFER 8192
284

285 286
#define FUSE_COMPAT_ENTRY_OUT_SIZE 120

287 288 289 290 291 292 293 294 295 296 297 298
struct fuse_entry_out {
	__u64	nodeid;		/* Inode ID */
	__u64	generation;	/* Inode generation: nodeid:gen must
				   be unique for the fs's lifetime */
	__u64	entry_valid;	/* Cache timeout for the name */
	__u64	attr_valid;	/* Cache timeout for the attributes */
	__u32	entry_valid_nsec;
	__u32	attr_valid_nsec;
	struct fuse_attr attr;
};

struct fuse_forget_in {
299
	__u64	nlookup;
300 301
};

302 303 304 305 306 307 308 309 310 311
struct fuse_forget_one {
	__u64	nodeid;
	__u64	nlookup;
};

struct fuse_batch_forget_in {
	__u32	count;
	__u32	dummy;
};

312 313 314 315 316 317
struct fuse_getattr_in {
	__u32	getattr_flags;
	__u32	dummy;
	__u64	fh;
};

318 319
#define FUSE_COMPAT_ATTR_OUT_SIZE 96

320 321 322 323 324 325 326
struct fuse_attr_out {
	__u64	attr_valid;	/* Cache timeout for the attributes */
	__u32	attr_valid_nsec;
	__u32	dummy;
	struct fuse_attr attr;
};

327 328
#define FUSE_COMPAT_MKNOD_IN_SIZE 8

329 330 331
struct fuse_mknod_in {
	__u32	mode;
	__u32	rdev;
332 333
	__u32	umask;
	__u32	padding;
334 335 336 337
};

struct fuse_mkdir_in {
	__u32	mode;
338
	__u32	umask;
339 340 341 342 343 344 345 346 347 348 349 350
};

struct fuse_rename_in {
	__u64	newdir;
};

struct fuse_link_in {
	__u64	oldnodeid;
};

struct fuse_setattr_in {
	__u32	valid;
M
Miklos Szeredi 已提交
351
	__u32	padding;
352 353
	__u64	fh;
	__u64	size;
354
	__u64	lock_owner;
355 356 357 358 359 360 361 362 363 364 365
	__u64	atime;
	__u64	mtime;
	__u64	unused2;
	__u32	atimensec;
	__u32	mtimensec;
	__u32	unused3;
	__u32	mode;
	__u32	unused4;
	__u32	uid;
	__u32	gid;
	__u32	unused5;
366 367
};

M
Miklos Szeredi 已提交
368
struct fuse_open_in {
369 370 371 372 373
	__u32	flags;
	__u32	unused;
};

struct fuse_create_in {
M
Miklos Szeredi 已提交
374
	__u32	flags;
M
Miklos Szeredi 已提交
375
	__u32	mode;
376 377
	__u32	umask;
	__u32	padding;
M
Miklos Szeredi 已提交
378 379 380 381 382
};

struct fuse_open_out {
	__u64	fh;
	__u32	open_flags;
M
Miklos Szeredi 已提交
383
	__u32	padding;
M
Miklos Szeredi 已提交
384 385 386 387 388
};

struct fuse_release_in {
	__u64	fh;
	__u32	flags;
389 390
	__u32	release_flags;
	__u64	lock_owner;
M
Miklos Szeredi 已提交
391 392 393 394
};

struct fuse_flush_in {
	__u64	fh;
395
	__u32	unused;
M
Miklos Szeredi 已提交
396
	__u32	padding;
397
	__u64	lock_owner;
M
Miklos Szeredi 已提交
398 399 400 401 402 403
};

struct fuse_read_in {
	__u64	fh;
	__u64	offset;
	__u32	size;
404 405
	__u32	read_flags;
	__u64	lock_owner;
406 407
	__u32	flags;
	__u32	padding;
M
Miklos Szeredi 已提交
408 409
};

410 411
#define FUSE_COMPAT_WRITE_IN_SIZE 24

M
Miklos Szeredi 已提交
412 413 414 415 416
struct fuse_write_in {
	__u64	fh;
	__u64	offset;
	__u32	size;
	__u32	write_flags;
417
	__u64	lock_owner;
418 419
	__u32	flags;
	__u32	padding;
M
Miklos Szeredi 已提交
420 421 422 423
};

struct fuse_write_out {
	__u32	size;
M
Miklos Szeredi 已提交
424
	__u32	padding;
M
Miklos Szeredi 已提交
425 426
};

427 428
#define FUSE_COMPAT_STATFS_SIZE 48

429 430 431 432
struct fuse_statfs_out {
	struct fuse_kstatfs st;
};

M
Miklos Szeredi 已提交
433 434 435
struct fuse_fsync_in {
	__u64	fh;
	__u32	fsync_flags;
M
Miklos Szeredi 已提交
436
	__u32	padding;
M
Miklos Szeredi 已提交
437 438
};

439 440 441 442 443 444 445
struct fuse_setxattr_in {
	__u32	size;
	__u32	flags;
};

struct fuse_getxattr_in {
	__u32	size;
M
Miklos Szeredi 已提交
446
	__u32	padding;
447 448 449 450
};

struct fuse_getxattr_out {
	__u32	size;
M
Miklos Szeredi 已提交
451
	__u32	padding;
452 453
};

454 455 456 457
struct fuse_lk_in {
	__u64	fh;
	__u64	owner;
	struct fuse_file_lock lk;
458 459
	__u32	lk_flags;
	__u32	padding;
460 461 462 463 464 465
};

struct fuse_lk_out {
	struct fuse_file_lock lk;
};

M
Miklos Szeredi 已提交
466 467 468 469 470
struct fuse_access_in {
	__u32	mask;
	__u32	padding;
};

471
struct fuse_init_in {
M
Miklos Szeredi 已提交
472 473
	__u32	major;
	__u32	minor;
474 475
	__u32	max_readahead;
	__u32	flags;
M
Miklos Szeredi 已提交
476 477
};

478 479 480
struct fuse_init_out {
	__u32	major;
	__u32	minor;
481 482
	__u32	max_readahead;
	__u32	flags;
483 484
	__u16   max_background;
	__u16   congestion_threshold;
485 486 487
	__u32	max_write;
};

488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
#define CUSE_INIT_INFO_MAX 4096

struct cuse_init_in {
	__u32	major;
	__u32	minor;
	__u32	unused;
	__u32	flags;
};

struct cuse_init_out {
	__u32	major;
	__u32	minor;
	__u32	unused;
	__u32	flags;
	__u32	max_read;
	__u32	max_write;
	__u32	dev_major;		/* chardev major */
	__u32	dev_minor;		/* chardev minor */
	__u32	spare[10];
};

509 510 511 512
struct fuse_interrupt_in {
	__u64	unique;
};

M
Miklos Szeredi 已提交
513 514 515 516 517 518 519 520 521 522
struct fuse_bmap_in {
	__u64	block;
	__u32	blocksize;
	__u32	padding;
};

struct fuse_bmap_out {
	__u64	block;
};

T
Tejun Heo 已提交
523 524 525 526 527 528 529 530 531
struct fuse_ioctl_in {
	__u64	fh;
	__u32	flags;
	__u32	cmd;
	__u64	arg;
	__u32	in_size;
	__u32	out_size;
};

M
Miklos Szeredi 已提交
532 533 534 535 536
struct fuse_ioctl_iovec {
	__u64	base;
	__u64	len;
};

T
Tejun Heo 已提交
537 538 539 540 541 542 543
struct fuse_ioctl_out {
	__s32	result;
	__u32	flags;
	__u32	in_iovs;
	__u32	out_iovs;
};

T
Tejun Heo 已提交
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
struct fuse_poll_in {
	__u64	fh;
	__u64	kh;
	__u32	flags;
	__u32   padding;
};

struct fuse_poll_out {
	__u32	revents;
	__u32	padding;
};

struct fuse_notify_poll_wakeup_out {
	__u64	kh;
};

M
Miklos Szeredi 已提交
560 561 562 563 564 565 566 567
struct fuse_in_header {
	__u32	len;
	__u32	opcode;
	__u64	unique;
	__u64	nodeid;
	__u32	uid;
	__u32	gid;
	__u32	pid;
M
Miklos Szeredi 已提交
568
	__u32	padding;
M
Miklos Szeredi 已提交
569 570 571 572 573 574 575 576
};

struct fuse_out_header {
	__u32	len;
	__s32	error;
	__u64	unique;
};

577 578 579 580 581 582 583 584
struct fuse_dirent {
	__u64	ino;
	__u64	off;
	__u32	namelen;
	__u32	type;
	char name[0];
};

A
Andrew Morton 已提交
585
#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
586 587 588
#define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
#define FUSE_DIRENT_SIZE(d) \
	FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
T
Tejun Heo 已提交
589

J
John Muir 已提交
590 591 592 593 594 595 596 597 598 599 600 601
struct fuse_notify_inval_inode_out {
	__u64	ino;
	__s64	off;
	__s64	len;
};

struct fuse_notify_inval_entry_out {
	__u64	parent;
	__u32	namelen;
	__u32	padding;
};

M
Miklos Szeredi 已提交
602 603 604 605 606 607 608
struct fuse_notify_store_out {
	__u64	nodeid;
	__u64	offset;
	__u32	size;
	__u32	padding;
};

M
Miklos Szeredi 已提交
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
struct fuse_notify_retrieve_out {
	__u64	notify_unique;
	__u64	nodeid;
	__u64	offset;
	__u32	size;
	__u32	padding;
};

/* Matches the size of fuse_write_in */
struct fuse_notify_retrieve_in {
	__u64	dummy1;
	__u64	offset;
	__u32	size;
	__u32	dummy2;
	__u64	dummy3;
	__u64	dummy4;
};

T
Tejun Heo 已提交
627
#endif /* _LINUX_FUSE_H */