[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
 *
 * 7.20
 *  - add FUSE_AUTO_INVAL_DATA
 */

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

/** 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_ASYNC_READ: asynchronous read requests
 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
 * FUSE_SPLICE_READ: kernel supports splice read on the device
 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
 */
#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_SPLICE_WRITE	(1 << 7)
#define FUSE_SPLICE_MOVE	(1 << 8)
#define FUSE_SPLICE_READ	(1 << 9)
#define FUSE_FLOCK_LOCKS	(1 << 10)
#define FUSE_HAS_IOCTL_DIR	(1 << 11)
#define FUSE_AUTO_INVAL_DATA	(1 << 12)

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