[deliverable/linux.git] / include / linux / fuse.h

/*
    FUSE: Filesystem in Userspace
    Copyright (C) 2001-2008  Miklos Szeredi <miklos@szeredi.hu>

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

/*
 * This file defines the kernel interface of FUSE
 *
 * Protocol changelog:
 *
 * 7.9:
 *  - new fuse_getattr_in input argument of GETATTR
 *  - add lk_flags in fuse_lk_in
 *  - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
 *  - add blksize field to fuse_attr
 *  - add file flags field to fuse_read_in and fuse_write_in
 *
 * 7.10
 *  - add nonseekable open flag
 *
 * 7.11
 *  - add IOCTL message
 *  - add unsolicited notification support
 *  - add POLL message and NOTIFY_POLL notification
 *
 * 7.12
 *  - add umask flag to input argument of open, mknod and mkdir
 *  - add notification messages for invalidation of inodes and
 *    directory entries
 *
 * 7.13
 *  - make max number of background requests and congestion threshold
 *    tunables
 *
 * 7.14
 *  - add splice support to fuse device
 *
 * 7.15
 *  - add store notify
 *  - add retrieve notify
 *
 * 7.16
 *  - add BATCH_FORGET request
 *  - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
 *    fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
 *  - add FUSE_IOCTL_32BIT flag
 *
 * 7.17
 *  - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
 *
 * 7.18
 *  - add FUSE_IOCTL_DIR flag
 *  - add FUSE_NOTIFY_DELETE
 *
 * 7.19
 *  - add FUSE_FALLOCATE
 */

#ifndef _LINUX_FUSE_H
#define _LINUX_FUSE_H

#include <linux/types.h>

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

/** Version number of this interface */
#define FUSE_KERNEL_VERSION 7

/** Minor version number of this interface */
#define FUSE_KERNEL_MINOR_VERSION 19

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

/* Make sure all structures are padded to 64bit boundary, so 32bit
   userspace works under 64bit kernels */

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;
	__u32	blksize;
	__u32	padding;
};

struct fuse_kstatfs {
	__u64	blocks;
	__u64	bfree;
	__u64	bavail;
	__u64	files;
	__u64	ffree;
	__u32	bsize;
	__u32	namelen;
	__u32	frsize;
	__u32	padding;
	__u32	spare[6];
};

struct fuse_file_lock {
	__u64	start;
	__u64	end;
	__u32	type;
	__u32	pid; /* tgid */
};

/**
 * Bitmasks for fuse_setattr_in.valid
 */
#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)
#define FATTR_FH	(1 << 6)
#define FATTR_ATIME_NOW	(1 << 7)
#define FATTR_MTIME_NOW	(1 << 8)
#define FATTR_LOCKOWNER	(1 << 9)

/**
 * 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
 * FOPEN_NONSEEKABLE: the file is not seekable
 */
#define FOPEN_DIRECT_IO		(1 << 0)
#define FOPEN_KEEP_CACHE	(1 << 1)
#define FOPEN_NONSEEKABLE	(1 << 2)

/**
 * INIT request/reply flags
 *
 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
 */
#define FUSE_ASYNC_READ		(1 << 0)
#define FUSE_POSIX_LOCKS	(1 << 1)
#define FUSE_FILE_OPS		(1 << 2)
#define FUSE_ATOMIC_O_TRUNC	(1 << 3)
#define FUSE_EXPORT_SUPPORT	(1 << 4)
#define FUSE_BIG_WRITES		(1 << 5)
#define FUSE_DONT_MASK		(1 << 6)
#define FUSE_FLOCK_LOCKS	(1 << 10)

/**
 * CUSE INIT request/reply flags
 *
 * CUSE_UNRESTRICTED_IOCTL:  use unrestricted ioctl
 */
#define CUSE_UNRESTRICTED_IOCTL	(1 << 0)

/**
 * Release flags
 */
#define FUSE_RELEASE_FLUSH	(1 << 0)
#define FUSE_RELEASE_FLOCK_UNLOCK	(1 << 1)

/**
 * Getattr flags
 */
#define FUSE_GETATTR_FH		(1 << 0)

/**
 * Lock flags
 */
#define FUSE_LK_FLOCK		(1 << 0)

/**
 * WRITE flags
 *
 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
 */
#define FUSE_WRITE_CACHE	(1 << 0)
#define FUSE_WRITE_LOCKOWNER	(1 << 1)

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

/**
 * 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
 * FUSE_IOCTL_32BIT: 32bit ioctl
 * FUSE_IOCTL_DIR: is a directory
 *
 * 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)
#define FUSE_IOCTL_32BIT	(1 << 3)
#define FUSE_IOCTL_DIR		(1 << 4)

#define FUSE_IOCTL_MAX_IOV	256

/**
 * Poll flags
 *
 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
 */
#define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)

enum fuse_opcode {
	FUSE_LOOKUP	   = 1,
	FUSE_FORGET	   = 2,  /* no reply */
	FUSE_GETATTR	   = 3,
	FUSE_SETATTR	   = 4,
	FUSE_READLINK	   = 5,
	FUSE_SYMLINK	   = 6,
	FUSE_MKNOD	   = 8,
	FUSE_MKDIR	   = 9,
	FUSE_UNLINK	   = 10,
	FUSE_RMDIR	   = 11,
	FUSE_RENAME	   = 12,
	FUSE_LINK	   = 13,
	FUSE_OPEN	   = 14,
	FUSE_READ	   = 15,
	FUSE_WRITE	   = 16,
	FUSE_STATFS	   = 17,
	FUSE_RELEASE       = 18,
	FUSE_FSYNC         = 20,
	FUSE_SETXATTR      = 21,
	FUSE_GETXATTR      = 22,
	FUSE_LISTXATTR     = 23,
	FUSE_REMOVEXATTR   = 24,
	FUSE_FLUSH         = 25,
	FUSE_INIT          = 26,
	FUSE_OPENDIR       = 27,
	FUSE_READDIR       = 28,
	FUSE_RELEASEDIR    = 29,
	FUSE_FSYNCDIR      = 30,
	FUSE_GETLK         = 31,
	FUSE_SETLK         = 32,
	FUSE_SETLKW        = 33,
	FUSE_ACCESS        = 34,
	FUSE_CREATE        = 35,
	FUSE_INTERRUPT     = 36,
	FUSE_BMAP          = 37,
	FUSE_DESTROY       = 38,
	FUSE_IOCTL         = 39,
	FUSE_POLL          = 40,
	FUSE_NOTIFY_REPLY  = 41,
	FUSE_BATCH_FORGET  = 42,
	FUSE_FALLOCATE     = 43,

	/* CUSE specific operations */
	CUSE_INIT          = 4096,
};

enum fuse_notify_code {
	FUSE_NOTIFY_POLL   = 1,
	FUSE_NOTIFY_INVAL_INODE = 2,
	FUSE_NOTIFY_INVAL_ENTRY = 3,
	FUSE_NOTIFY_STORE = 4,
	FUSE_NOTIFY_RETRIEVE = 5,
	FUSE_NOTIFY_DELETE = 6,
	FUSE_NOTIFY_CODE_MAX,
};

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

#define FUSE_COMPAT_ENTRY_OUT_SIZE 120

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 {
	__u64	nlookup;
};

struct fuse_forget_one {
	__u64	nodeid;
	__u64	nlookup;
};

struct fuse_batch_forget_in {
	__u32	count;
	__u32	dummy;
};

struct fuse_getattr_in {
	__u32	getattr_flags;
	__u32	dummy;
	__u64	fh;
};

#define FUSE_COMPAT_ATTR_OUT_SIZE 96

struct fuse_attr_out {
	__u64	attr_valid;	/* Cache timeout for the attributes */
	__u32	attr_valid_nsec;
	__u32	dummy;
	struct fuse_attr attr;
};

#define FUSE_COMPAT_MKNOD_IN_SIZE 8

struct fuse_mknod_in {
	__u32	mode;
	__u32	rdev;
	__u32	umask;
	__u32	padding;
};

struct fuse_mkdir_in {
	__u32	mode;
	__u32	umask;
};

struct fuse_rename_in {
	__u64	newdir;
};

struct fuse_link_in {
	__u64	oldnodeid;
};

struct fuse_setattr_in {
	__u32	valid;
	__u32	padding;
	__u64	fh;
	__u64	size;
	__u64	lock_owner;
	__u64	atime;
	__u64	mtime;
	__u64	unused2;
	__u32	atimensec;
	__u32	mtimensec;
	__u32	unused3;
	__u32	mode;
	__u32	unused4;
	__u32	uid;
	__u32	gid;
	__u32	unused5;
};

struct fuse_open_in {
	__u32	flags;
	__u32	unused;
};

struct fuse_create_in {
	__u32	flags;
	__u32	mode;
	__u32	umask;
	__u32	padding;
};

struct fuse_open_out {
	__u64	fh;
	__u32	open_flags;
	__u32	padding;
};

struct fuse_release_in {
	__u64	fh;
	__u32	flags;
	__u32	release_flags;
	__u64	lock_owner;
};

struct fuse_flush_in {
	__u64	fh;
	__u32	unused;
	__u32	padding;
	__u64	lock_owner;
};

struct fuse_read_in {
	__u64	fh;
	__u64	offset;
	__u32	size;
	__u32	read_flags;
	__u64	lock_owner;
	__u32	flags;
	__u32	padding;
};

#define FUSE_COMPAT_WRITE_IN_SIZE 24

struct fuse_write_in {
	__u64	fh;
	__u64	offset;
	__u32	size;
	__u32	write_flags;
	__u64	lock_owner;
	__u32	flags;
	__u32	padding;
};

struct fuse_write_out {
	__u32	size;
	__u32	padding;
};

#define FUSE_COMPAT_STATFS_SIZE 48

struct fuse_statfs_out {
	struct fuse_kstatfs st;
};

struct fuse_fsync_in {
	__u64	fh;
	__u32	fsync_flags;
	__u32	padding;
};

struct fuse_setxattr_in {
	__u32	size;
	__u32	flags;
};

struct fuse_getxattr_in {
	__u32	size;
	__u32	padding;
};

struct fuse_getxattr_out {
	__u32	size;
	__u32	padding;
};

struct fuse_lk_in {
	__u64	fh;
	__u64	owner;
	struct fuse_file_lock lk;
	__u32	lk_flags;
	__u32	padding;
};

struct fuse_lk_out {
	struct fuse_file_lock lk;
};

struct fuse_access_in {
	__u32	mask;
	__u32	padding;
};

struct fuse_init_in {
	__u32	major;
	__u32	minor;
	__u32	max_readahead;
	__u32	flags;
};

struct fuse_init_out {
	__u32	major;
	__u32	minor;
	__u32	max_readahead;
	__u32	flags;
	__u16   max_background;
	__u16   congestion_threshold;
	__u32	max_write;
};

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

struct fuse_interrupt_in {
	__u64	unique;
};

struct fuse_bmap_in {
	__u64	block;
	__u32	blocksize;
	__u32	padding;
};

struct fuse_bmap_out {
	__u64	block;
};

struct fuse_ioctl_in {
	__u64	fh;
	__u32	flags;
	__u32	cmd;
	__u64	arg;
	__u32	in_size;
	__u32	out_size;
};

struct fuse_ioctl_iovec {
	__u64	base;
	__u64	len;
};

struct fuse_ioctl_out {
	__s32	result;
	__u32	flags;
	__u32	in_iovs;
	__u32	out_iovs;
};

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

struct fuse_fallocate_in {
	__u64	fh;
	__u64	offset;
	__u64	length;
	__u32	mode;
	__u32	padding;
};

struct fuse_in_header {
	__u32	len;
	__u32	opcode;
	__u64	unique;
	__u64	nodeid;
	__u32	uid;
	__u32	gid;
	__u32	pid;
	__u32	padding;
};

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

struct fuse_dirent {
	__u64	ino;
	__u64	off;
	__u32	namelen;
	__u32	type;
	char name[];
};

#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
#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)

struct fuse_notify_inval_inode_out {
	__u64	ino;
	__s64	off;
	__s64	len;
};

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

struct fuse_notify_delete_out {
	__u64	parent;
	__u64	child;
	__u32	namelen;
	__u32	padding;
};

struct fuse_notify_store_out {
	__u64	nodeid;
	__u64	offset;
	__u32	size;
	__u32	padding;
};

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

#endif /* _LINUX_FUSE_H */
Commit	Line	Data
d8a5ba45 MS	1	/*
d8a5ba45 MS	2	FUSE: Filesystem in Userspace
1f55ed06	3	Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu>
d8a5ba45 MS	4
	5	This program can be distributed under the terms of the GNU GPL.
	6	See the file COPYING.
	7	*/
	8
c79e322f MS	9	/*
	10	* This file defines the kernel interface of FUSE
	11	*
	12	* Protocol changelog:
	13	*
	14	* 7.9:
	15	* - new fuse_getattr_in input argument of GETATTR
a9ff4f87	16	* - add lk_flags in fuse_lk_in
f3332114	17	* - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
0e9663ee	18	* - add blksize field to fuse_attr
a6643094	19	* - add file flags field to fuse_read_in and fuse_write_in
a7c1b990 TH	20	*
	21	* 7.10
	22	* - add nonseekable open flag
1f55ed06 MS	23	*
	24	* 7.11
	25	* - add IOCTL message
	26	* - add unsolicited notification support
	27	* - add POLL message and NOTIFY_POLL notification
e0a43ddc MS	28	*
	29	* 7.12
	30	* - add umask flag to input argument of open, mknod and mkdir
3b463ae0 JM	31	* - add notification messages for invalidation of inodes and
3b463ae0 JM	32	* directory entries
7a6d3c8b CH	33	*
	34	* 7.13
	35	* - make max number of background requests and congestion threshold
	36	* tunables
dd3bb14f MS	37	*
	38	* 7.14
	39	* - add splice support to fuse device
a1d75f25 MS	40	*
	41	* 7.15
	42	* - add store notify
2d45ba38	43	* - add retrieve notify
02c048b9 MS	44	*
	45	* 7.16
	46	* - add BATCH_FORGET request
1baa26b2 MS	47	* - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
	48	* fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
	49	* - add FUSE_IOCTL_32BIT flag
37fb3a30 MS	50	*
	51	* 7.17
	52	* - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
b18da0c5 MS	53	*
	54	* 7.18
	55	* - add FUSE_IOCTL_DIR flag
451d0f59	56	* - add FUSE_NOTIFY_DELETE
05ba1f08 AP	57	*
	58	* 7.19
	59	* - add FUSE_FALLOCATE
c79e322f	60	*/
d8a5ba45	61
29d434b3 TH	62	#ifndef _LINUX_FUSE_H
	63	#define _LINUX_FUSE_H
	64
1f55ed06	65	#include <linux/types.h>
d8a5ba45	66
37d217f0 MS	67	/*
	68	* Version negotiation:
	69	*
	70	* Both the kernel and userspace send the version they support in the
	71	* INIT request and reply respectively.
	72	*
	73	* If the major versions match then both shall use the smallest
	74	* of the two minor versions for communication.
	75	*
	76	* If the kernel supports a larger major version, then userspace shall
	77	* reply with the major version it supports, ignore the rest of the
	78	* INIT message and expect a new INIT message from the kernel with a
	79	* matching major version.
	80	*
	81	* If the library supports a larger major version, then it shall fall
	82	* back to the major protocol version sent by the kernel for
	83	* communication and reply with that major version (and an arbitrary
	84	* supported minor version).
	85	*/
	86
d8a5ba45	87	/** Version number of this interface */
9e6268db	88	#define FUSE_KERNEL_VERSION 7
d8a5ba45 MS	89
d8a5ba45 MS	90	/** Minor version number of this interface */
05ba1f08	91	#define FUSE_KERNEL_MINOR_VERSION 19
d8a5ba45 MS	92
	93	/** The node ID of the root inode */
	94	#define FUSE_ROOT_ID 1
	95
06663267 MS	96	/* Make sure all structures are padded to 64bit boundary, so 32bit
	97	userspace works under 64bit kernels */
	98
d8a5ba45 MS	99	struct fuse_attr {
	100	__u64 ino;
	101	__u64 size;
	102	__u64 blocks;
	103	__u64 atime;
	104	__u64 mtime;
	105	__u64 ctime;
	106	__u32 atimensec;
	107	__u32 mtimensec;
	108	__u32 ctimensec;
	109	__u32 mode;
	110	__u32 nlink;
	111	__u32 uid;
	112	__u32 gid;
	113	__u32 rdev;
0e9663ee MS	114	__u32 blksize;
0e9663ee MS	115	__u32 padding;
d8a5ba45 MS	116	};
d8a5ba45 MS	117
e5e5558e MS	118	struct fuse_kstatfs {
	119	__u64 blocks;
	120	__u64 bfree;
	121	__u64 bavail;
	122	__u64 files;
	123	__u64 ffree;
	124	__u32 bsize;
	125	__u32 namelen;
de5f1202 MS	126	__u32 frsize;
	127	__u32 padding;
	128	__u32 spare[6];
e5e5558e MS	129	};
e5e5558e MS	130
71421259 MS	131	struct fuse_file_lock {
	132	__u64 start;
	133	__u64 end;
	134	__u32 type;
	135	__u32 pid; /* tgid */
	136	};
	137
9cd68455 MS	138	/**
	139	* Bitmasks for fuse_setattr_in.valid
	140	*/
9e6268db MS	141	#define FATTR_MODE (1 << 0)
	142	#define FATTR_UID (1 << 1)
	143	#define FATTR_GID (1 << 2)
	144	#define FATTR_SIZE (1 << 3)
	145	#define FATTR_ATIME (1 << 4)
	146	#define FATTR_MTIME (1 << 5)
befc649c	147	#define FATTR_FH (1 << 6)
17637cba MS	148	#define FATTR_ATIME_NOW (1 << 7)
17637cba MS	149	#define FATTR_MTIME_NOW (1 << 8)
f3332114	150	#define FATTR_LOCKOWNER (1 << 9)
9e6268db	151
45323fb7 MS	152	/**
	153	* Flags returned by the OPEN request
	154	*
	155	* FOPEN_DIRECT_IO: bypass page cache for this open file
	156	* FOPEN_KEEP_CACHE: don't invalidate the data cache on open
a7c1b990	157	* FOPEN_NONSEEKABLE: the file is not seekable
45323fb7 MS	158	*/
	159	#define FOPEN_DIRECT_IO (1 << 0)
	160	#define FOPEN_KEEP_CACHE (1 << 1)
a7c1b990	161	#define FOPEN_NONSEEKABLE (1 << 2)
45323fb7	162
9cd68455 MS	163	/**
9cd68455 MS	164	* INIT request/reply flags
33670fa2	165	*
37fb3a30	166	* FUSE_POSIX_LOCKS: remote locking for POSIX file locks
33670fa2	167	* FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
e0a43ddc	168	* FUSE_DONT_MASK: don't apply umask to file mode on create operations
37fb3a30	169	* FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
9cd68455 MS	170	*/
9cd68455 MS	171	#define FUSE_ASYNC_READ (1 << 0)
71421259	172	#define FUSE_POSIX_LOCKS (1 << 1)
c79e322f	173	#define FUSE_FILE_OPS (1 << 2)
6ff958ed	174	#define FUSE_ATOMIC_O_TRUNC (1 << 3)
33670fa2	175	#define FUSE_EXPORT_SUPPORT (1 << 4)
78bb6cb9	176	#define FUSE_BIG_WRITES (1 << 5)
e0a43ddc	177	#define FUSE_DONT_MASK (1 << 6)
37fb3a30	178	#define FUSE_FLOCK_LOCKS (1 << 10)
9cd68455	179
151060ac TH	180	/**
	181	* CUSE INIT request/reply flags
	182	*
	183	* CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
	184	*/
	185	#define CUSE_UNRESTRICTED_IOCTL (1 << 0)
	186
e9168c18 MS	187	/**
	188	* Release flags
	189	*/
	190	#define FUSE_RELEASE_FLUSH (1 << 0)
37fb3a30	191	#define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
e9168c18	192
c79e322f MS	193	/**
	194	* Getattr flags
	195	*/
	196	#define FUSE_GETATTR_FH (1 << 0)
	197
a9ff4f87 MS	198	/**
	199	* Lock flags
	200	*/
	201	#define FUSE_LK_FLOCK (1 << 0)
	202
b25e82e5 MS	203	/**
	204	* WRITE flags
	205	*
	206	* FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
f3332114	207	* FUSE_WRITE_LOCKOWNER: lock_owner field is valid
b25e82e5 MS	208	*/
b25e82e5 MS	209	#define FUSE_WRITE_CACHE (1 << 0)
f3332114 MS	210	#define FUSE_WRITE_LOCKOWNER (1 << 1)
	211
	212	/**
	213	* Read flags
	214	*/
	215	#define FUSE_READ_LOCKOWNER (1 << 1)
b25e82e5	216
59efec7b TH	217	/**
	218	* Ioctl flags
	219	*
	220	* FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
	221	* FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
	222	* FUSE_IOCTL_RETRY: retry with new iovecs
1baa26b2	223	* FUSE_IOCTL_32BIT: 32bit ioctl
b18da0c5	224	* FUSE_IOCTL_DIR: is a directory
59efec7b TH	225	*
	226	* FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
	227	*/
	228	#define FUSE_IOCTL_COMPAT (1 << 0)
	229	#define FUSE_IOCTL_UNRESTRICTED (1 << 1)
	230	#define FUSE_IOCTL_RETRY (1 << 2)
1baa26b2	231	#define FUSE_IOCTL_32BIT (1 << 3)
b18da0c5	232	#define FUSE_IOCTL_DIR (1 << 4)
59efec7b TH	233
	234	#define FUSE_IOCTL_MAX_IOV 256
	235
95668a69 TH	236	/**
	237	* Poll flags
	238	*
	239	* FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
	240	*/
	241	#define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
	242
334f485d	243	enum fuse_opcode {
e5e5558e MS	244	FUSE_LOOKUP = 1,
	245	FUSE_FORGET = 2, /* no reply */
	246	FUSE_GETATTR = 3,
9e6268db	247	FUSE_SETATTR = 4,
e5e5558e	248	FUSE_READLINK = 5,
9e6268db	249	FUSE_SYMLINK = 6,
9e6268db MS	250	FUSE_MKNOD = 8,
	251	FUSE_MKDIR = 9,
	252	FUSE_UNLINK = 10,
	253	FUSE_RMDIR = 11,
	254	FUSE_RENAME = 12,
	255	FUSE_LINK = 13,
b6aeaded MS	256	FUSE_OPEN = 14,
	257	FUSE_READ = 15,
	258	FUSE_WRITE = 16,
e5e5558e	259	FUSE_STATFS = 17,
b6aeaded MS	260	FUSE_RELEASE = 18,
b6aeaded MS	261	FUSE_FSYNC = 20,
92a8780e MS	262	FUSE_SETXATTR = 21,
	263	FUSE_GETXATTR = 22,
	264	FUSE_LISTXATTR = 23,
	265	FUSE_REMOVEXATTR = 24,
b6aeaded	266	FUSE_FLUSH = 25,
04730fef MS	267	FUSE_INIT = 26,
	268	FUSE_OPENDIR = 27,
	269	FUSE_READDIR = 28,
82547981	270	FUSE_RELEASEDIR = 29,
31d40d74	271	FUSE_FSYNCDIR = 30,
71421259 MS	272	FUSE_GETLK = 31,
	273	FUSE_SETLK = 32,
	274	FUSE_SETLKW = 33,
fd72faac	275	FUSE_ACCESS = 34,
a4d27e75 MS	276	FUSE_CREATE = 35,
a4d27e75 MS	277	FUSE_INTERRUPT = 36,
b2d2272f	278	FUSE_BMAP = 37,
0ec7ca41	279	FUSE_DESTROY = 38,
59efec7b	280	FUSE_IOCTL = 39,
95668a69	281	FUSE_POLL = 40,
2d45ba38	282	FUSE_NOTIFY_REPLY = 41,
02c048b9	283	FUSE_BATCH_FORGET = 42,
05ba1f08	284	FUSE_FALLOCATE = 43,
151060ac TH	285
	286	/* CUSE specific operations */
	287	CUSE_INIT = 4096,
334f485d MS	288	};
334f485d MS	289
8599396b	290	enum fuse_notify_code {
95668a69	291	FUSE_NOTIFY_POLL = 1,
3b463ae0 JM	292	FUSE_NOTIFY_INVAL_INODE = 2,
3b463ae0 JM	293	FUSE_NOTIFY_INVAL_ENTRY = 3,
a1d75f25	294	FUSE_NOTIFY_STORE = 4,
2d45ba38	295	FUSE_NOTIFY_RETRIEVE = 5,
451d0f59	296	FUSE_NOTIFY_DELETE = 6,
8599396b TH	297	FUSE_NOTIFY_CODE_MAX,
	298	};
	299
1d3d752b MS	300	/* The read buffer is required to be at least 8k, but may be much larger */
1d3d752b MS	301	#define FUSE_MIN_READ_BUFFER 8192
e5e5558e	302
0e9663ee MS	303	#define FUSE_COMPAT_ENTRY_OUT_SIZE 120
0e9663ee MS	304
e5e5558e MS	305	struct fuse_entry_out {
	306	__u64 nodeid; /* Inode ID */
	307	__u64 generation; /* Inode generation: nodeid:gen must
	308	be unique for the fs's lifetime */
	309	__u64 entry_valid; /* Cache timeout for the name */
	310	__u64 attr_valid; /* Cache timeout for the attributes */
	311	__u32 entry_valid_nsec;
	312	__u32 attr_valid_nsec;
	313	struct fuse_attr attr;
	314	};
	315
	316	struct fuse_forget_in {
9e6268db	317	__u64 nlookup;
e5e5558e MS	318	};
e5e5558e MS	319
02c048b9 MS	320	struct fuse_forget_one {
	321	__u64 nodeid;
	322	__u64 nlookup;
	323	};
	324
	325	struct fuse_batch_forget_in {
	326	__u32 count;
	327	__u32 dummy;
	328	};
	329
c79e322f MS	330	struct fuse_getattr_in {
	331	__u32 getattr_flags;
	332	__u32 dummy;
	333	__u64 fh;
	334	};
	335
0e9663ee MS	336	#define FUSE_COMPAT_ATTR_OUT_SIZE 96
0e9663ee MS	337
e5e5558e MS	338	struct fuse_attr_out {
	339	__u64 attr_valid; /* Cache timeout for the attributes */
	340	__u32 attr_valid_nsec;
	341	__u32 dummy;
	342	struct fuse_attr attr;
	343	};
	344
e0a43ddc MS	345	#define FUSE_COMPAT_MKNOD_IN_SIZE 8
e0a43ddc MS	346
9e6268db MS	347	struct fuse_mknod_in {
	348	__u32 mode;
	349	__u32 rdev;
e0a43ddc MS	350	__u32 umask;
e0a43ddc MS	351	__u32 padding;
9e6268db MS	352	};
	353
	354	struct fuse_mkdir_in {
	355	__u32 mode;
e0a43ddc	356	__u32 umask;
9e6268db MS	357	};
	358
	359	struct fuse_rename_in {
	360	__u64 newdir;
	361	};
	362
	363	struct fuse_link_in {
	364	__u64 oldnodeid;
	365	};
	366
	367	struct fuse_setattr_in {
	368	__u32 valid;
06663267	369	__u32 padding;
befc649c MS	370	__u64 fh;
befc649c MS	371	__u64 size;
f3332114	372	__u64 lock_owner;
befc649c MS	373	__u64 atime;
	374	__u64 mtime;
	375	__u64 unused2;
	376	__u32 atimensec;
	377	__u32 mtimensec;
	378	__u32 unused3;
	379	__u32 mode;
	380	__u32 unused4;
	381	__u32 uid;
	382	__u32 gid;
	383	__u32 unused5;
9e6268db MS	384	};
9e6268db MS	385
b6aeaded	386	struct fuse_open_in {
e0a43ddc MS	387	__u32 flags;
	388	__u32 unused;
	389	};
	390
	391	struct fuse_create_in {
b6aeaded	392	__u32 flags;
fd72faac	393	__u32 mode;
e0a43ddc MS	394	__u32 umask;
e0a43ddc MS	395	__u32 padding;
b6aeaded MS	396	};
	397
	398	struct fuse_open_out {
	399	__u64 fh;
	400	__u32 open_flags;
06663267	401	__u32 padding;
b6aeaded MS	402	};
	403
	404	struct fuse_release_in {
	405	__u64 fh;
	406	__u32 flags;
e9168c18 MS	407	__u32 release_flags;
e9168c18 MS	408	__u64 lock_owner;
b6aeaded MS	409	};
	410
	411	struct fuse_flush_in {
	412	__u64 fh;
e9168c18	413	__u32 unused;
06663267	414	__u32 padding;
71421259	415	__u64 lock_owner;
b6aeaded MS	416	};
	417
	418	struct fuse_read_in {
	419	__u64 fh;
	420	__u64 offset;
	421	__u32 size;
f3332114 MS	422	__u32 read_flags;
f3332114 MS	423	__u64 lock_owner;
a6643094 MS	424	__u32 flags;
a6643094 MS	425	__u32 padding;
b6aeaded MS	426	};
b6aeaded MS	427
f3332114 MS	428	#define FUSE_COMPAT_WRITE_IN_SIZE 24
f3332114 MS	429
b6aeaded MS	430	struct fuse_write_in {
	431	__u64 fh;
	432	__u64 offset;
	433	__u32 size;
	434	__u32 write_flags;
f3332114	435	__u64 lock_owner;
a6643094 MS	436	__u32 flags;
a6643094 MS	437	__u32 padding;
b6aeaded MS	438	};
	439
	440	struct fuse_write_out {
	441	__u32 size;
06663267	442	__u32 padding;
b6aeaded MS	443	};
b6aeaded MS	444
de5f1202 MS	445	#define FUSE_COMPAT_STATFS_SIZE 48
de5f1202 MS	446
e5e5558e MS	447	struct fuse_statfs_out {
	448	struct fuse_kstatfs st;
	449	};
	450
b6aeaded MS	451	struct fuse_fsync_in {
	452	__u64 fh;
	453	__u32 fsync_flags;
06663267	454	__u32 padding;
b6aeaded MS	455	};
b6aeaded MS	456
92a8780e MS	457	struct fuse_setxattr_in {
	458	__u32 size;
	459	__u32 flags;
	460	};
	461
	462	struct fuse_getxattr_in {
	463	__u32 size;
06663267	464	__u32 padding;
92a8780e MS	465	};
	466
	467	struct fuse_getxattr_out {
	468	__u32 size;
06663267	469	__u32 padding;
92a8780e MS	470	};
92a8780e MS	471
71421259 MS	472	struct fuse_lk_in {
	473	__u64 fh;
	474	__u64 owner;
	475	struct fuse_file_lock lk;
a9ff4f87 MS	476	__u32 lk_flags;
a9ff4f87 MS	477	__u32 padding;
71421259 MS	478	};
	479
	480	struct fuse_lk_out {
	481	struct fuse_file_lock lk;
	482	};
	483
31d40d74 MS	484	struct fuse_access_in {
	485	__u32 mask;
	486	__u32 padding;
	487	};
	488
3ec870d5	489	struct fuse_init_in {
334f485d MS	490	__u32 major;
334f485d MS	491	__u32 minor;
9cd68455 MS	492	__u32 max_readahead;
9cd68455 MS	493	__u32 flags;
334f485d MS	494	};
334f485d MS	495
3ec870d5 MS	496	struct fuse_init_out {
	497	__u32 major;
	498	__u32 minor;
9cd68455 MS	499	__u32 max_readahead;
9cd68455 MS	500	__u32 flags;
7a6d3c8b CH	501	__u16 max_background;
7a6d3c8b CH	502	__u16 congestion_threshold;
3ec870d5 MS	503	__u32 max_write;
	504	};
	505
151060ac TH	506	#define CUSE_INIT_INFO_MAX 4096
	507
	508	struct cuse_init_in {
	509	__u32 major;
	510	__u32 minor;
	511	__u32 unused;
	512	__u32 flags;
	513	};
	514
	515	struct cuse_init_out {
	516	__u32 major;
	517	__u32 minor;
	518	__u32 unused;
	519	__u32 flags;
	520	__u32 max_read;
	521	__u32 max_write;
	522	__u32 dev_major; /* chardev major */
	523	__u32 dev_minor; /* chardev minor */
	524	__u32 spare[10];
	525	};
	526
a4d27e75 MS	527	struct fuse_interrupt_in {
	528	__u64 unique;
	529	};
	530
b2d2272f MS	531	struct fuse_bmap_in {
	532	__u64 block;
	533	__u32 blocksize;
	534	__u32 padding;
	535	};
	536
	537	struct fuse_bmap_out {
	538	__u64 block;
	539	};
	540
59efec7b TH	541	struct fuse_ioctl_in {
	542	__u64 fh;
	543	__u32 flags;
	544	__u32 cmd;
	545	__u64 arg;
	546	__u32 in_size;
	547	__u32 out_size;
	548	};
	549
1baa26b2 MS	550	struct fuse_ioctl_iovec {
	551	__u64 base;
	552	__u64 len;
	553	};
	554
59efec7b TH	555	struct fuse_ioctl_out {
	556	__s32 result;
	557	__u32 flags;
	558	__u32 in_iovs;
	559	__u32 out_iovs;
	560	};
	561
95668a69 TH	562	struct fuse_poll_in {
	563	__u64 fh;
	564	__u64 kh;
	565	__u32 flags;
	566	__u32 padding;
	567	};
	568
	569	struct fuse_poll_out {
	570	__u32 revents;
	571	__u32 padding;
	572	};
	573
	574	struct fuse_notify_poll_wakeup_out {
	575	__u64 kh;
	576	};
	577
05ba1f08 AP	578	struct fuse_fallocate_in {
	579	__u64 fh;
	580	__u64 offset;
	581	__u64 length;
	582	__u32 mode;
	583	__u32 padding;
	584	};
	585
334f485d MS	586	struct fuse_in_header {
	587	__u32 len;
	588	__u32 opcode;
	589	__u64 unique;
	590	__u64 nodeid;
	591	__u32 uid;
	592	__u32 gid;
	593	__u32 pid;
06663267	594	__u32 padding;
334f485d MS	595	};
	596
	597	struct fuse_out_header {
	598	__u32 len;
	599	__s32 error;
	600	__u64 unique;
	601	};
	602
e5e5558e MS	603	struct fuse_dirent {
	604	__u64 ino;
	605	__u64 off;
	606	__u32 namelen;
	607	__u32 type;
c628ee67	608	char name[];
e5e5558e MS	609	};
e5e5558e MS	610
21f3da95	611	#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
e5e5558e MS	612	#define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
	613	#define FUSE_DIRENT_SIZE(d) \
	614	FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
29d434b3	615
3b463ae0 JM	616	struct fuse_notify_inval_inode_out {
	617	__u64 ino;
	618	__s64 off;
	619	__s64 len;
	620	};
	621
	622	struct fuse_notify_inval_entry_out {
	623	__u64 parent;
	624	__u32 namelen;
	625	__u32 padding;
	626	};
	627
451d0f59 JM	628	struct fuse_notify_delete_out {
	629	__u64 parent;
	630	__u64 child;
	631	__u32 namelen;
	632	__u32 padding;
	633	};
	634
a1d75f25 MS	635	struct fuse_notify_store_out {
	636	__u64 nodeid;
	637	__u64 offset;
	638	__u32 size;
	639	__u32 padding;
	640	};
	641
2d45ba38 MS	642	struct fuse_notify_retrieve_out {
	643	__u64 notify_unique;
	644	__u64 nodeid;
	645	__u64 offset;
	646	__u32 size;
	647	__u32 padding;
	648	};
	649
	650	/* Matches the size of fuse_write_in */
	651	struct fuse_notify_retrieve_in {
	652	__u64 dummy1;
	653	__u64 offset;
	654	__u32 size;
	655	__u32 dummy2;
	656	__u64 dummy3;
	657	__u64 dummy4;
	658	};
	659
29d434b3	660	#endif /* _LINUX_FUSE_H */