[mirror_ubuntu-bionic-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

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

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_SETXATTR      = 21,
	FUSE_GETXATTR      = 22,
	FUSE_LISTXATTR     = 23,
	FUSE_REMOVEXATTR   = 24,
	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
#define FUSE_XATTR_SIZE_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;
	__u32	padding;
};

struct fuse_rename_in {
	__u64	newdir;
};

struct fuse_link_in {
	__u64	oldnodeid;
};

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

struct fuse_open_in {
	__u32	flags;
	__u32	padding;
};

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

struct fuse_release_in {
	__u64	fh;
	__u32	flags;
	__u32	padding;
};

struct fuse_flush_in {
	__u64	fh;
	__u32	flush_flags;
	__u32	padding;
};

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

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

struct fuse_write_out {
	__u32	size;
	__u32	padding;
};

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_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;
	__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 ((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
06663267 MS	28	/* Make sure all structures are padded to 64bit boundary, so 32bit
	29	userspace works under 64bit kernels */
	30
d8a5ba45 MS	31	struct fuse_attr {
	32	__u64 ino;
	33	__u64 size;
	34	__u64 blocks;
	35	__u64 atime;
	36	__u64 mtime;
	37	__u64 ctime;
	38	__u32 atimensec;
	39	__u32 mtimensec;
	40	__u32 ctimensec;
	41	__u32 mode;
	42	__u32 nlink;
	43	__u32 uid;
	44	__u32 gid;
	45	__u32 rdev;
	46	};
	47
e5e5558e MS	48	struct fuse_kstatfs {
	49	__u64 blocks;
	50	__u64 bfree;
	51	__u64 bavail;
	52	__u64 files;
	53	__u64 ffree;
	54	__u32 bsize;
	55	__u32 namelen;
	56	};
	57
9e6268db MS	58	#define FATTR_MODE (1 << 0)
	59	#define FATTR_UID (1 << 1)
	60	#define FATTR_GID (1 << 2)
	61	#define FATTR_SIZE (1 << 3)
	62	#define FATTR_ATIME (1 << 4)
	63	#define FATTR_MTIME (1 << 5)
	64	#define FATTR_CTIME (1 << 6)
	65
334f485d	66	enum fuse_opcode {
e5e5558e MS	67	FUSE_LOOKUP = 1,
	68	FUSE_FORGET = 2, /* no reply */
	69	FUSE_GETATTR = 3,
9e6268db	70	FUSE_SETATTR = 4,
e5e5558e	71	FUSE_READLINK = 5,
9e6268db	72	FUSE_SYMLINK = 6,
e5e5558e	73	FUSE_GETDIR = 7,
9e6268db MS	74	FUSE_MKNOD = 8,
	75	FUSE_MKDIR = 9,
	76	FUSE_UNLINK = 10,
	77	FUSE_RMDIR = 11,
	78	FUSE_RENAME = 12,
	79	FUSE_LINK = 13,
b6aeaded MS	80	FUSE_OPEN = 14,
	81	FUSE_READ = 15,
	82	FUSE_WRITE = 16,
e5e5558e	83	FUSE_STATFS = 17,
b6aeaded MS	84	FUSE_RELEASE = 18,
b6aeaded MS	85	FUSE_FSYNC = 20,
92a8780e MS	86	FUSE_SETXATTR = 21,
	87	FUSE_GETXATTR = 22,
	88	FUSE_LISTXATTR = 23,
	89	FUSE_REMOVEXATTR = 24,
b6aeaded	90	FUSE_FLUSH = 25,
334f485d MS	91	FUSE_INIT = 26
	92	};
	93
	94	/* Conservative buffer size for the client */
	95	#define FUSE_MAX_IN 8192
	96
e5e5558e	97	#define FUSE_NAME_MAX 1024
9e6268db	98	#define FUSE_SYMLINK_MAX 4096
92a8780e	99	#define FUSE_XATTR_SIZE_MAX 4096
e5e5558e MS	100
	101	struct fuse_entry_out {
	102	__u64 nodeid; /* Inode ID */
	103	__u64 generation; /* Inode generation: nodeid:gen must
	104	be unique for the fs's lifetime */
	105	__u64 entry_valid; /* Cache timeout for the name */
	106	__u64 attr_valid; /* Cache timeout for the attributes */
	107	__u32 entry_valid_nsec;
	108	__u32 attr_valid_nsec;
	109	struct fuse_attr attr;
	110	};
	111
	112	struct fuse_forget_in {
9e6268db	113	__u64 nlookup;
e5e5558e MS	114	};
	115
	116	struct fuse_attr_out {
	117	__u64 attr_valid; /* Cache timeout for the attributes */
	118	__u32 attr_valid_nsec;
	119	__u32 dummy;
	120	struct fuse_attr attr;
	121	};
	122
	123	struct fuse_getdir_out {
	124	__u32 fd;
	125	};
	126
9e6268db MS	127	struct fuse_mknod_in {
	128	__u32 mode;
	129	__u32 rdev;
	130	};
	131
	132	struct fuse_mkdir_in {
	133	__u32 mode;
06663267	134	__u32 padding;
9e6268db MS	135	};
	136
	137	struct fuse_rename_in {
	138	__u64 newdir;
	139	};
	140
	141	struct fuse_link_in {
	142	__u64 oldnodeid;
	143	};
	144
	145	struct fuse_setattr_in {
	146	__u32 valid;
06663267	147	__u32 padding;
9e6268db MS	148	struct fuse_attr attr;
	149	};
	150
b6aeaded MS	151	struct fuse_open_in {
b6aeaded MS	152	__u32 flags;
06663267	153	__u32 padding;
b6aeaded MS	154	};
	155
	156	struct fuse_open_out {
	157	__u64 fh;
	158	__u32 open_flags;
06663267	159	__u32 padding;
b6aeaded MS	160	};
	161
	162	struct fuse_release_in {
	163	__u64 fh;
	164	__u32 flags;
06663267	165	__u32 padding;
b6aeaded MS	166	};
	167
	168	struct fuse_flush_in {
	169	__u64 fh;
	170	__u32 flush_flags;
06663267	171	__u32 padding;
b6aeaded MS	172	};
	173
	174	struct fuse_read_in {
	175	__u64 fh;
	176	__u64 offset;
	177	__u32 size;
06663267	178	__u32 padding;
b6aeaded MS	179	};
	180
	181	struct fuse_write_in {
	182	__u64 fh;
	183	__u64 offset;
	184	__u32 size;
	185	__u32 write_flags;
	186	};
	187
	188	struct fuse_write_out {
	189	__u32 size;
06663267	190	__u32 padding;
b6aeaded MS	191	};
b6aeaded MS	192
e5e5558e MS	193	struct fuse_statfs_out {
	194	struct fuse_kstatfs st;
	195	};
	196
b6aeaded MS	197	struct fuse_fsync_in {
	198	__u64 fh;
	199	__u32 fsync_flags;
06663267	200	__u32 padding;
b6aeaded MS	201	};
b6aeaded MS	202
92a8780e MS	203	struct fuse_setxattr_in {
	204	__u32 size;
	205	__u32 flags;
	206	};
	207
	208	struct fuse_getxattr_in {
	209	__u32 size;
06663267	210	__u32 padding;
92a8780e MS	211	};
	212
	213	struct fuse_getxattr_out {
	214	__u32 size;
06663267	215	__u32 padding;
92a8780e MS	216	};
92a8780e MS	217
334f485d MS	218	struct fuse_init_in_out {
	219	__u32 major;
	220	__u32 minor;
	221	};
	222
	223	struct fuse_in_header {
	224	__u32 len;
	225	__u32 opcode;
	226	__u64 unique;
	227	__u64 nodeid;
	228	__u32 uid;
	229	__u32 gid;
	230	__u32 pid;
06663267	231	__u32 padding;
334f485d MS	232	};
	233
	234	struct fuse_out_header {
	235	__u32 len;
	236	__s32 error;
	237	__u64 unique;
	238	};
	239
e5e5558e MS	240	struct fuse_dirent {
	241	__u64 ino;
	242	__u64 off;
	243	__u32 namelen;
	244	__u32 type;
	245	char name[0];
	246	};
	247
	248	#define FUSE_NAME_OFFSET ((unsigned) ((struct fuse_dirent *) 0)->name)
	249	#define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
	250	#define FUSE_DIRENT_SIZE(d) \
	251	FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)