[mirror_ubuntu-zesty-kernel.git] / include / linux / fuse.h

/*
    FUSE: Filesystem in Userspace
    Copyright (C) 2001-2005  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 */

#include <asm/types.h>

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

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

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

/** The major number of the fuse character device */
#define FUSE_MAJOR 10

/** The minor number of the fuse character device */
#define FUSE_MINOR 229

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

struct fuse_kstatfs {
	__u64	blocks;
	__u64	bfree;
	__u64	bavail;
	__u64	files;
	__u64	ffree;
	__u32	bsize;
	__u32	namelen;
};

#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_CTIME	(1 << 6)

enum fuse_opcode {
	FUSE_LOOKUP	   = 1,
	FUSE_FORGET	   = 2,  /* no reply */
	FUSE_GETATTR	   = 3,
	FUSE_SETATTR	   = 4,
	FUSE_READLINK	   = 5,
	FUSE_SYMLINK	   = 6,
	FUSE_GETDIR	   = 7,
	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_FLUSH         = 25,
	FUSE_INIT          = 26
};

/* Conservative buffer size for the client */
#define FUSE_MAX_IN 8192

#define FUSE_NAME_MAX 1024
#define FUSE_SYMLINK_MAX 4096

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_attr_out {
	__u64	attr_valid;	/* Cache timeout for the attributes */
	__u32	attr_valid_nsec;
	__u32	dummy;
	struct fuse_attr attr;
};

struct fuse_getdir_out {
	__u32	fd;
};

struct fuse_mknod_in {
	__u32	mode;
	__u32	rdev;
};

struct fuse_mkdir_in {
	__u32	mode;
};

struct fuse_rename_in {
	__u64	newdir;
};

struct fuse_link_in {
	__u64	oldnodeid;
};

struct fuse_setattr_in {
	__u32	valid;
	struct fuse_attr attr;
};

struct fuse_open_in {
	__u32	flags;
};

struct fuse_open_out {
	__u64	fh;
	__u32	open_flags;
};

struct fuse_release_in {
	__u64	fh;
	__u32	flags;
};

struct fuse_flush_in {
	__u64	fh;
	__u32	flush_flags;
};

struct fuse_read_in {
	__u64	fh;
	__u64	offset;
	__u32	size;
};

struct fuse_write_in {
	__u64	fh;
	__u64	offset;
	__u32	size;
	__u32	write_flags;
};

struct fuse_write_out {
	__u32	size;
};

struct fuse_statfs_out {
	struct fuse_kstatfs st;
};

struct fuse_fsync_in {
	__u64	fh;
	__u32	fsync_flags;
};

struct fuse_init_in_out {
	__u32	major;
	__u32	minor;
};

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

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 ((unsigned) ((struct fuse_dirent *) 0)->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)
Commit	Line	Data
d8a5ba45 MS	1	/*
	2	FUSE: Filesystem in Userspace
	3	Copyright (C) 2001-2005 Miklos Szeredi <miklos@szeredi.hu>
	4
	5	This program can be distributed under the terms of the GNU GPL.
	6	See the file COPYING.
	7	*/
	8
	9	/* This file defines the kernel interface of FUSE */
	10
	11	#include <asm/types.h>
	12
	13	/** Version number of this interface */
9e6268db	14	#define FUSE_KERNEL_VERSION 7
d8a5ba45 MS	15
	16	/** Minor version number of this interface */
	17	#define FUSE_KERNEL_MINOR_VERSION 1
	18
	19	/** The node ID of the root inode */
	20	#define FUSE_ROOT_ID 1
	21
334f485d MS	22	/** The major number of the fuse character device */
	23	#define FUSE_MAJOR 10
	24
	25	/** The minor number of the fuse character device */
	26	#define FUSE_MINOR 229
	27
d8a5ba45 MS	28	struct fuse_attr {
	29	__u64 ino;
	30	__u64 size;
	31	__u64 blocks;
	32	__u64 atime;
	33	__u64 mtime;
	34	__u64 ctime;
	35	__u32 atimensec;
	36	__u32 mtimensec;
	37	__u32 ctimensec;
	38	__u32 mode;
	39	__u32 nlink;
	40	__u32 uid;
	41	__u32 gid;
	42	__u32 rdev;
	43	};
	44
e5e5558e MS	45	struct fuse_kstatfs {
	46	__u64 blocks;
	47	__u64 bfree;
	48	__u64 bavail;
	49	__u64 files;
	50	__u64 ffree;
	51	__u32 bsize;
	52	__u32 namelen;
	53	};
	54
9e6268db MS	55	#define FATTR_MODE (1 << 0)
	56	#define FATTR_UID (1 << 1)
	57	#define FATTR_GID (1 << 2)
	58	#define FATTR_SIZE (1 << 3)
	59	#define FATTR_ATIME (1 << 4)
	60	#define FATTR_MTIME (1 << 5)
	61	#define FATTR_CTIME (1 << 6)
	62
334f485d	63	enum fuse_opcode {
e5e5558e MS	64	FUSE_LOOKUP = 1,
	65	FUSE_FORGET = 2, /* no reply */
	66	FUSE_GETATTR = 3,
9e6268db	67	FUSE_SETATTR = 4,
e5e5558e	68	FUSE_READLINK = 5,
9e6268db	69	FUSE_SYMLINK = 6,
e5e5558e	70	FUSE_GETDIR = 7,
9e6268db MS	71	FUSE_MKNOD = 8,
	72	FUSE_MKDIR = 9,
	73	FUSE_UNLINK = 10,
	74	FUSE_RMDIR = 11,
	75	FUSE_RENAME = 12,
	76	FUSE_LINK = 13,
b6aeaded MS	77	FUSE_OPEN = 14,
	78	FUSE_READ = 15,
	79	FUSE_WRITE = 16,
e5e5558e	80	FUSE_STATFS = 17,
b6aeaded MS	81	FUSE_RELEASE = 18,
	82	FUSE_FSYNC = 20,
	83	FUSE_FLUSH = 25,
334f485d MS	84	FUSE_INIT = 26
	85	};
	86
	87	/* Conservative buffer size for the client */
	88	#define FUSE_MAX_IN 8192
	89
e5e5558e	90	#define FUSE_NAME_MAX 1024
9e6268db	91	#define FUSE_SYMLINK_MAX 4096
e5e5558e MS	92
	93	struct fuse_entry_out {
	94	__u64 nodeid; /* Inode ID */
	95	__u64 generation; /* Inode generation: nodeid:gen must
	96	be unique for the fs's lifetime */
	97	__u64 entry_valid; /* Cache timeout for the name */
	98	__u64 attr_valid; /* Cache timeout for the attributes */
	99	__u32 entry_valid_nsec;
	100	__u32 attr_valid_nsec;
	101	struct fuse_attr attr;
	102	};
	103
	104	struct fuse_forget_in {
9e6268db	105	__u64 nlookup;
e5e5558e MS	106	};
	107
	108	struct fuse_attr_out {
	109	__u64 attr_valid; /* Cache timeout for the attributes */
	110	__u32 attr_valid_nsec;
	111	__u32 dummy;
	112	struct fuse_attr attr;
	113	};
	114
	115	struct fuse_getdir_out {
	116	__u32 fd;
	117	};
	118
9e6268db MS	119	struct fuse_mknod_in {
	120	__u32 mode;
	121	__u32 rdev;
	122	};
	123
	124	struct fuse_mkdir_in {
	125	__u32 mode;
	126	};
	127
	128	struct fuse_rename_in {
	129	__u64 newdir;
	130	};
	131
	132	struct fuse_link_in {
	133	__u64 oldnodeid;
	134	};
	135
	136	struct fuse_setattr_in {
	137	__u32 valid;
	138	struct fuse_attr attr;
	139	};
	140
b6aeaded MS	141	struct fuse_open_in {
	142	__u32 flags;
	143	};
	144
	145	struct fuse_open_out {
	146	__u64 fh;
	147	__u32 open_flags;
	148	};
	149
	150	struct fuse_release_in {
	151	__u64 fh;
	152	__u32 flags;
	153	};
	154
	155	struct fuse_flush_in {
	156	__u64 fh;
	157	__u32 flush_flags;
	158	};
	159
	160	struct fuse_read_in {
	161	__u64 fh;
	162	__u64 offset;
	163	__u32 size;
	164	};
	165
	166	struct fuse_write_in {
	167	__u64 fh;
	168	__u64 offset;
	169	__u32 size;
	170	__u32 write_flags;
	171	};
	172
	173	struct fuse_write_out {
	174	__u32 size;
	175	};
	176
e5e5558e MS	177	struct fuse_statfs_out {
	178	struct fuse_kstatfs st;
	179	};
	180
b6aeaded MS	181	struct fuse_fsync_in {
	182	__u64 fh;
	183	__u32 fsync_flags;
	184	};
	185
334f485d MS	186	struct fuse_init_in_out {
	187	__u32 major;
	188	__u32 minor;
	189	};
	190
	191	struct fuse_in_header {
	192	__u32 len;
	193	__u32 opcode;
	194	__u64 unique;
	195	__u64 nodeid;
	196	__u32 uid;
	197	__u32 gid;
	198	__u32 pid;
	199	};
	200
	201	struct fuse_out_header {
	202	__u32 len;
	203	__s32 error;
	204	__u64 unique;
	205	};
	206
e5e5558e MS	207	struct fuse_dirent {
	208	__u64 ino;
	209	__u64 off;
	210	__u32 namelen;
	211	__u32 type;
	212	char name[0];
	213	};
	214
	215	#define FUSE_NAME_OFFSET ((unsigned) ((struct fuse_dirent *) 0)->name)
	216	#define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
	217	#define FUSE_DIRENT_SIZE(d) \
	218	FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)