[mirror_ubuntu-artful-kernel.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
 */

#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 17

/** 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_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_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,

	/* 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_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_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[0];
};

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