fuse.h 7.1 KB
Newer Older
M
Miklos Szeredi 已提交
1 2
/*
    FUSE: Filesystem in Userspace
3
    Copyright (C) 2001-2006  Miklos Szeredi <miklos@szeredi.hu>
M
Miklos Szeredi 已提交
4 5 6 7 8

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

9 10 11 12 13 14 15
/*
 * This file defines the kernel interface of FUSE
 *
 * Protocol changelog:
 *
 * 7.9:
 *  - new fuse_getattr_in input argument of GETATTR
16
 *  - add lk_flags in fuse_lk_in
17
 *  - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
18
 *  - add blksize field to fuse_attr
19
 *  - add file flags field to fuse_read_in and fuse_write_in
20
 */
M
Miklos Szeredi 已提交
21 22

#include <asm/types.h>
J
Jan Engelhardt 已提交
23
#include <linux/major.h>
M
Miklos Szeredi 已提交
24 25

/** Version number of this interface */
26
#define FUSE_KERNEL_VERSION 7
M
Miklos Szeredi 已提交
27 28

/** Minor version number of this interface */
29
#define FUSE_KERNEL_MINOR_VERSION 9
M
Miklos Szeredi 已提交
30 31 32 33

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

M
Miklos Szeredi 已提交
34
/** The major number of the fuse character device */
J
Jan Engelhardt 已提交
35
#define FUSE_MAJOR MISC_MAJOR
M
Miklos Szeredi 已提交
36 37 38 39

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

M
Miklos Szeredi 已提交
40 41 42
/* Make sure all structures are padded to 64bit boundary, so 32bit
   userspace works under 64bit kernels */

M
Miklos Szeredi 已提交
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
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;
58 59
	__u32	blksize;
	__u32	padding;
M
Miklos Szeredi 已提交
60 61
};

62 63 64 65 66 67 68 69
struct fuse_kstatfs {
	__u64	blocks;
	__u64	bfree;
	__u64	bavail;
	__u64	files;
	__u64	ffree;
	__u32	bsize;
	__u32	namelen;
70 71 72
	__u32	frsize;
	__u32	padding;
	__u32	spare[6];
73 74
};

75 76 77 78 79 80 81
struct fuse_file_lock {
	__u64	start;
	__u64	end;
	__u32	type;
	__u32	pid; /* tgid */
};

82 83 84
/**
 * Bitmasks for fuse_setattr_in.valid
 */
85 86 87 88 89 90
#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)
91
#define FATTR_FH	(1 << 6)
M
Miklos Szeredi 已提交
92 93
#define FATTR_ATIME_NOW	(1 << 7)
#define FATTR_MTIME_NOW	(1 << 8)
94
#define FATTR_LOCKOWNER	(1 << 9)
95

96 97 98 99 100 101 102 103 104
/**
 * 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
 */
#define FOPEN_DIRECT_IO		(1 << 0)
#define FOPEN_KEEP_CACHE	(1 << 1)

105 106
/**
 * INIT request/reply flags
107 108
 *
 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
109 110
 */
#define FUSE_ASYNC_READ		(1 << 0)
111
#define FUSE_POSIX_LOCKS	(1 << 1)
112
#define FUSE_FILE_OPS		(1 << 2)
113
#define FUSE_ATOMIC_O_TRUNC	(1 << 3)
114
#define FUSE_EXPORT_SUPPORT	(1 << 4)
115
#define FUSE_BIG_WRITES		(1 << 5)
116

117 118 119 120 121
/**
 * Release flags
 */
#define FUSE_RELEASE_FLUSH	(1 << 0)

122 123 124 125 126
/**
 * Getattr flags
 */
#define FUSE_GETATTR_FH		(1 << 0)

127 128 129 130 131
/**
 * Lock flags
 */
#define FUSE_LK_FLOCK		(1 << 0)

132 133 134 135
/**
 * WRITE flags
 *
 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
136
 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
137 138
 */
#define FUSE_WRITE_CACHE	(1 << 0)
139 140 141 142 143 144
#define FUSE_WRITE_LOCKOWNER	(1 << 1)

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

M
Miklos Szeredi 已提交
146
enum fuse_opcode {
147 148 149
	FUSE_LOOKUP	   = 1,
	FUSE_FORGET	   = 2,  /* no reply */
	FUSE_GETATTR	   = 3,
150
	FUSE_SETATTR	   = 4,
151
	FUSE_READLINK	   = 5,
152 153 154 155 156 157 158
	FUSE_SYMLINK	   = 6,
	FUSE_MKNOD	   = 8,
	FUSE_MKDIR	   = 9,
	FUSE_UNLINK	   = 10,
	FUSE_RMDIR	   = 11,
	FUSE_RENAME	   = 12,
	FUSE_LINK	   = 13,
M
Miklos Szeredi 已提交
159 160 161
	FUSE_OPEN	   = 14,
	FUSE_READ	   = 15,
	FUSE_WRITE	   = 16,
162
	FUSE_STATFS	   = 17,
M
Miklos Szeredi 已提交
163 164
	FUSE_RELEASE       = 18,
	FUSE_FSYNC         = 20,
165 166 167 168
	FUSE_SETXATTR      = 21,
	FUSE_GETXATTR      = 22,
	FUSE_LISTXATTR     = 23,
	FUSE_REMOVEXATTR   = 24,
M
Miklos Szeredi 已提交
169
	FUSE_FLUSH         = 25,
170 171 172
	FUSE_INIT          = 26,
	FUSE_OPENDIR       = 27,
	FUSE_READDIR       = 28,
173
	FUSE_RELEASEDIR    = 29,
M
Miklos Szeredi 已提交
174
	FUSE_FSYNCDIR      = 30,
175 176 177
	FUSE_GETLK         = 31,
	FUSE_SETLK         = 32,
	FUSE_SETLKW        = 33,
M
Miklos Szeredi 已提交
178
	FUSE_ACCESS        = 34,
179 180
	FUSE_CREATE        = 35,
	FUSE_INTERRUPT     = 36,
M
Miklos Szeredi 已提交
181
	FUSE_BMAP          = 37,
182
	FUSE_DESTROY       = 38,
M
Miklos Szeredi 已提交
183 184
};

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

188 189
#define FUSE_COMPAT_ENTRY_OUT_SIZE 120

190 191 192 193 194 195 196 197 198 199 200 201
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 {
202
	__u64	nlookup;
203 204
};

205 206 207 208 209 210
struct fuse_getattr_in {
	__u32	getattr_flags;
	__u32	dummy;
	__u64	fh;
};

211 212
#define FUSE_COMPAT_ATTR_OUT_SIZE 96

213 214 215 216 217 218 219
struct fuse_attr_out {
	__u64	attr_valid;	/* Cache timeout for the attributes */
	__u32	attr_valid_nsec;
	__u32	dummy;
	struct fuse_attr attr;
};

220 221 222 223 224 225 226
struct fuse_mknod_in {
	__u32	mode;
	__u32	rdev;
};

struct fuse_mkdir_in {
	__u32	mode;
M
Miklos Szeredi 已提交
227
	__u32	padding;
228 229 230 231 232 233 234 235 236 237 238 239
};

struct fuse_rename_in {
	__u64	newdir;
};

struct fuse_link_in {
	__u64	oldnodeid;
};

struct fuse_setattr_in {
	__u32	valid;
M
Miklos Szeredi 已提交
240
	__u32	padding;
241 242
	__u64	fh;
	__u64	size;
243
	__u64	lock_owner;
244 245 246 247 248 249 250 251 252 253 254
	__u64	atime;
	__u64	mtime;
	__u64	unused2;
	__u32	atimensec;
	__u32	mtimensec;
	__u32	unused3;
	__u32	mode;
	__u32	unused4;
	__u32	uid;
	__u32	gid;
	__u32	unused5;
255 256
};

M
Miklos Szeredi 已提交
257 258
struct fuse_open_in {
	__u32	flags;
M
Miklos Szeredi 已提交
259
	__u32	mode;
M
Miklos Szeredi 已提交
260 261 262 263 264
};

struct fuse_open_out {
	__u64	fh;
	__u32	open_flags;
M
Miklos Szeredi 已提交
265
	__u32	padding;
M
Miklos Szeredi 已提交
266 267 268 269 270
};

struct fuse_release_in {
	__u64	fh;
	__u32	flags;
271 272
	__u32	release_flags;
	__u64	lock_owner;
M
Miklos Szeredi 已提交
273 274 275 276
};

struct fuse_flush_in {
	__u64	fh;
277
	__u32	unused;
M
Miklos Szeredi 已提交
278
	__u32	padding;
279
	__u64	lock_owner;
M
Miklos Szeredi 已提交
280 281 282 283 284 285
};

struct fuse_read_in {
	__u64	fh;
	__u64	offset;
	__u32	size;
286 287
	__u32	read_flags;
	__u64	lock_owner;
288 289
	__u32	flags;
	__u32	padding;
M
Miklos Szeredi 已提交
290 291
};

292 293
#define FUSE_COMPAT_WRITE_IN_SIZE 24

M
Miklos Szeredi 已提交
294 295 296 297 298
struct fuse_write_in {
	__u64	fh;
	__u64	offset;
	__u32	size;
	__u32	write_flags;
299
	__u64	lock_owner;
300 301
	__u32	flags;
	__u32	padding;
M
Miklos Szeredi 已提交
302 303 304 305
};

struct fuse_write_out {
	__u32	size;
M
Miklos Szeredi 已提交
306
	__u32	padding;
M
Miklos Szeredi 已提交
307 308
};

309 310
#define FUSE_COMPAT_STATFS_SIZE 48

311 312 313 314
struct fuse_statfs_out {
	struct fuse_kstatfs st;
};

M
Miklos Szeredi 已提交
315 316 317
struct fuse_fsync_in {
	__u64	fh;
	__u32	fsync_flags;
M
Miklos Szeredi 已提交
318
	__u32	padding;
M
Miklos Szeredi 已提交
319 320
};

321 322 323 324 325 326 327
struct fuse_setxattr_in {
	__u32	size;
	__u32	flags;
};

struct fuse_getxattr_in {
	__u32	size;
M
Miklos Szeredi 已提交
328
	__u32	padding;
329 330 331 332
};

struct fuse_getxattr_out {
	__u32	size;
M
Miklos Szeredi 已提交
333
	__u32	padding;
334 335
};

336 337 338 339
struct fuse_lk_in {
	__u64	fh;
	__u64	owner;
	struct fuse_file_lock lk;
340 341
	__u32	lk_flags;
	__u32	padding;
342 343 344 345 346 347
};

struct fuse_lk_out {
	struct fuse_file_lock lk;
};

M
Miklos Szeredi 已提交
348 349 350 351 352
struct fuse_access_in {
	__u32	mask;
	__u32	padding;
};

353
struct fuse_init_in {
M
Miklos Szeredi 已提交
354 355
	__u32	major;
	__u32	minor;
356 357
	__u32	max_readahead;
	__u32	flags;
M
Miklos Szeredi 已提交
358 359
};

360 361 362
struct fuse_init_out {
	__u32	major;
	__u32	minor;
363 364 365
	__u32	max_readahead;
	__u32	flags;
	__u32	unused;
366 367 368
	__u32	max_write;
};

369 370 371 372
struct fuse_interrupt_in {
	__u64	unique;
};

M
Miklos Szeredi 已提交
373 374 375 376 377 378 379 380 381 382
struct fuse_bmap_in {
	__u64	block;
	__u32	blocksize;
	__u32	padding;
};

struct fuse_bmap_out {
	__u64	block;
};

M
Miklos Szeredi 已提交
383 384 385 386 387 388 389 390
struct fuse_in_header {
	__u32	len;
	__u32	opcode;
	__u64	unique;
	__u64	nodeid;
	__u32	uid;
	__u32	gid;
	__u32	pid;
M
Miklos Szeredi 已提交
391
	__u32	padding;
M
Miklos Szeredi 已提交
392 393 394 395 396 397 398 399
};

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

400 401 402 403 404 405 406 407
struct fuse_dirent {
	__u64	ino;
	__u64	off;
	__u32	namelen;
	__u32	type;
	char name[0];
};

A
Andrew Morton 已提交
408
#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
409 410 411
#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)