fuse.h 8.2 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
T
Tejun Heo 已提交
20 21 22
 *
 * 7.10
 *  - add nonseekable open flag
23
 */
M
Miklos Szeredi 已提交
24

T
Tejun Heo 已提交
25 26 27
#ifndef _LINUX_FUSE_H
#define _LINUX_FUSE_H

M
Miklos Szeredi 已提交
28
#include <asm/types.h>
J
Jan Engelhardt 已提交
29
#include <linux/major.h>
M
Miklos Szeredi 已提交
30 31

/** Version number of this interface */
32
#define FUSE_KERNEL_VERSION 7
M
Miklos Szeredi 已提交
33 34

/** Minor version number of this interface */
T
Tejun Heo 已提交
35
#define FUSE_KERNEL_MINOR_VERSION 10
M
Miklos Szeredi 已提交
36 37 38 39

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

M
Miklos Szeredi 已提交
40
/** The major number of the fuse character device */
J
Jan Engelhardt 已提交
41
#define FUSE_MAJOR MISC_MAJOR
M
Miklos Szeredi 已提交
42

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

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

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

78 79 80 81 82 83 84
struct fuse_file_lock {
	__u64	start;
	__u64	end;
	__u32	type;
	__u32	pid; /* tgid */
};

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

99 100 101 102 103
/**
 * 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
T
Tejun Heo 已提交
104
 * FOPEN_NONSEEKABLE: the file is not seekable
105 106 107
 */
#define FOPEN_DIRECT_IO		(1 << 0)
#define FOPEN_KEEP_CACHE	(1 << 1)
T
Tejun Heo 已提交
108
#define FOPEN_NONSEEKABLE	(1 << 2)
109

110 111
/**
 * INIT request/reply flags
112 113
 *
 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
114 115
 */
#define FUSE_ASYNC_READ		(1 << 0)
116
#define FUSE_POSIX_LOCKS	(1 << 1)
117
#define FUSE_FILE_OPS		(1 << 2)
118
#define FUSE_ATOMIC_O_TRUNC	(1 << 3)
119
#define FUSE_EXPORT_SUPPORT	(1 << 4)
120
#define FUSE_BIG_WRITES		(1 << 5)
121

122 123 124 125 126
/**
 * Release flags
 */
#define FUSE_RELEASE_FLUSH	(1 << 0)

127 128 129 130 131
/**
 * Getattr flags
 */
#define FUSE_GETATTR_FH		(1 << 0)

132 133 134 135 136
/**
 * Lock flags
 */
#define FUSE_LK_FLOCK		(1 << 0)

137 138 139 140
/**
 * WRITE flags
 *
 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
141
 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
142 143
 */
#define FUSE_WRITE_CACHE	(1 << 0)
144 145 146 147 148 149
#define FUSE_WRITE_LOCKOWNER	(1 << 1)

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

T
Tejun Heo 已提交
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
/**
 * 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_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_MAX_IOV	256

T
Tejun Heo 已提交
166 167 168 169 170 171 172
/**
 * Poll flags
 *
 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
 */
#define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)

M
Miklos Szeredi 已提交
173
enum fuse_opcode {
174 175 176
	FUSE_LOOKUP	   = 1,
	FUSE_FORGET	   = 2,  /* no reply */
	FUSE_GETATTR	   = 3,
177
	FUSE_SETATTR	   = 4,
178
	FUSE_READLINK	   = 5,
179 180 181 182 183 184 185
	FUSE_SYMLINK	   = 6,
	FUSE_MKNOD	   = 8,
	FUSE_MKDIR	   = 9,
	FUSE_UNLINK	   = 10,
	FUSE_RMDIR	   = 11,
	FUSE_RENAME	   = 12,
	FUSE_LINK	   = 13,
M
Miklos Szeredi 已提交
186 187 188
	FUSE_OPEN	   = 14,
	FUSE_READ	   = 15,
	FUSE_WRITE	   = 16,
189
	FUSE_STATFS	   = 17,
M
Miklos Szeredi 已提交
190 191
	FUSE_RELEASE       = 18,
	FUSE_FSYNC         = 20,
192 193 194 195
	FUSE_SETXATTR      = 21,
	FUSE_GETXATTR      = 22,
	FUSE_LISTXATTR     = 23,
	FUSE_REMOVEXATTR   = 24,
M
Miklos Szeredi 已提交
196
	FUSE_FLUSH         = 25,
197 198 199
	FUSE_INIT          = 26,
	FUSE_OPENDIR       = 27,
	FUSE_READDIR       = 28,
200
	FUSE_RELEASEDIR    = 29,
M
Miklos Szeredi 已提交
201
	FUSE_FSYNCDIR      = 30,
202 203 204
	FUSE_GETLK         = 31,
	FUSE_SETLK         = 32,
	FUSE_SETLKW        = 33,
M
Miklos Szeredi 已提交
205
	FUSE_ACCESS        = 34,
206 207
	FUSE_CREATE        = 35,
	FUSE_INTERRUPT     = 36,
M
Miklos Szeredi 已提交
208
	FUSE_BMAP          = 37,
209
	FUSE_DESTROY       = 38,
T
Tejun Heo 已提交
210
	FUSE_IOCTL         = 39,
T
Tejun Heo 已提交
211
	FUSE_POLL          = 40,
M
Miklos Szeredi 已提交
212 213
};

214
enum fuse_notify_code {
T
Tejun Heo 已提交
215
	FUSE_NOTIFY_POLL   = 1,
216 217 218
	FUSE_NOTIFY_CODE_MAX,
};

219 220
/* The read buffer is required to be at least 8k, but may be much larger */
#define FUSE_MIN_READ_BUFFER 8192
221

222 223
#define FUSE_COMPAT_ENTRY_OUT_SIZE 120

224 225 226 227 228 229 230 231 232 233 234 235
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 {
236
	__u64	nlookup;
237 238
};

239 240 241 242 243 244
struct fuse_getattr_in {
	__u32	getattr_flags;
	__u32	dummy;
	__u64	fh;
};

245 246
#define FUSE_COMPAT_ATTR_OUT_SIZE 96

247 248 249 250 251 252 253
struct fuse_attr_out {
	__u64	attr_valid;	/* Cache timeout for the attributes */
	__u32	attr_valid_nsec;
	__u32	dummy;
	struct fuse_attr attr;
};

254 255 256 257 258 259 260
struct fuse_mknod_in {
	__u32	mode;
	__u32	rdev;
};

struct fuse_mkdir_in {
	__u32	mode;
M
Miklos Szeredi 已提交
261
	__u32	padding;
262 263 264 265 266 267 268 269 270 271 272 273
};

struct fuse_rename_in {
	__u64	newdir;
};

struct fuse_link_in {
	__u64	oldnodeid;
};

struct fuse_setattr_in {
	__u32	valid;
M
Miklos Szeredi 已提交
274
	__u32	padding;
275 276
	__u64	fh;
	__u64	size;
277
	__u64	lock_owner;
278 279 280 281 282 283 284 285 286 287 288
	__u64	atime;
	__u64	mtime;
	__u64	unused2;
	__u32	atimensec;
	__u32	mtimensec;
	__u32	unused3;
	__u32	mode;
	__u32	unused4;
	__u32	uid;
	__u32	gid;
	__u32	unused5;
289 290
};

M
Miklos Szeredi 已提交
291 292
struct fuse_open_in {
	__u32	flags;
M
Miklos Szeredi 已提交
293
	__u32	mode;
M
Miklos Szeredi 已提交
294 295 296 297 298
};

struct fuse_open_out {
	__u64	fh;
	__u32	open_flags;
M
Miklos Szeredi 已提交
299
	__u32	padding;
M
Miklos Szeredi 已提交
300 301 302 303 304
};

struct fuse_release_in {
	__u64	fh;
	__u32	flags;
305 306
	__u32	release_flags;
	__u64	lock_owner;
M
Miklos Szeredi 已提交
307 308 309 310
};

struct fuse_flush_in {
	__u64	fh;
311
	__u32	unused;
M
Miklos Szeredi 已提交
312
	__u32	padding;
313
	__u64	lock_owner;
M
Miklos Szeredi 已提交
314 315 316 317 318 319
};

struct fuse_read_in {
	__u64	fh;
	__u64	offset;
	__u32	size;
320 321
	__u32	read_flags;
	__u64	lock_owner;
322 323
	__u32	flags;
	__u32	padding;
M
Miklos Szeredi 已提交
324 325
};

326 327
#define FUSE_COMPAT_WRITE_IN_SIZE 24

M
Miklos Szeredi 已提交
328 329 330 331 332
struct fuse_write_in {
	__u64	fh;
	__u64	offset;
	__u32	size;
	__u32	write_flags;
333
	__u64	lock_owner;
334 335
	__u32	flags;
	__u32	padding;
M
Miklos Szeredi 已提交
336 337 338 339
};

struct fuse_write_out {
	__u32	size;
M
Miklos Szeredi 已提交
340
	__u32	padding;
M
Miklos Szeredi 已提交
341 342
};

343 344
#define FUSE_COMPAT_STATFS_SIZE 48

345 346 347 348
struct fuse_statfs_out {
	struct fuse_kstatfs st;
};

M
Miklos Szeredi 已提交
349 350 351
struct fuse_fsync_in {
	__u64	fh;
	__u32	fsync_flags;
M
Miklos Szeredi 已提交
352
	__u32	padding;
M
Miklos Szeredi 已提交
353 354
};

355 356 357 358 359 360 361
struct fuse_setxattr_in {
	__u32	size;
	__u32	flags;
};

struct fuse_getxattr_in {
	__u32	size;
M
Miklos Szeredi 已提交
362
	__u32	padding;
363 364 365 366
};

struct fuse_getxattr_out {
	__u32	size;
M
Miklos Szeredi 已提交
367
	__u32	padding;
368 369
};

370 371 372 373
struct fuse_lk_in {
	__u64	fh;
	__u64	owner;
	struct fuse_file_lock lk;
374 375
	__u32	lk_flags;
	__u32	padding;
376 377 378 379 380 381
};

struct fuse_lk_out {
	struct fuse_file_lock lk;
};

M
Miklos Szeredi 已提交
382 383 384 385 386
struct fuse_access_in {
	__u32	mask;
	__u32	padding;
};

387
struct fuse_init_in {
M
Miklos Szeredi 已提交
388 389
	__u32	major;
	__u32	minor;
390 391
	__u32	max_readahead;
	__u32	flags;
M
Miklos Szeredi 已提交
392 393
};

394 395 396
struct fuse_init_out {
	__u32	major;
	__u32	minor;
397 398 399
	__u32	max_readahead;
	__u32	flags;
	__u32	unused;
400 401 402
	__u32	max_write;
};

403 404 405 406
struct fuse_interrupt_in {
	__u64	unique;
};

M
Miklos Szeredi 已提交
407 408 409 410 411 412 413 414 415 416
struct fuse_bmap_in {
	__u64	block;
	__u32	blocksize;
	__u32	padding;
};

struct fuse_bmap_out {
	__u64	block;
};

T
Tejun Heo 已提交
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
struct fuse_ioctl_in {
	__u64	fh;
	__u32	flags;
	__u32	cmd;
	__u64	arg;
	__u32	in_size;
	__u32	out_size;
};

struct fuse_ioctl_out {
	__s32	result;
	__u32	flags;
	__u32	in_iovs;
	__u32	out_iovs;
};

T
Tejun Heo 已提交
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
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;
};

M
Miklos Szeredi 已提交
449 450 451 452 453 454 455 456
struct fuse_in_header {
	__u32	len;
	__u32	opcode;
	__u64	unique;
	__u64	nodeid;
	__u32	uid;
	__u32	gid;
	__u32	pid;
M
Miklos Szeredi 已提交
457
	__u32	padding;
M
Miklos Szeredi 已提交
458 459 460 461 462 463 464 465
};

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

466 467 468 469 470 471 472 473
struct fuse_dirent {
	__u64	ino;
	__u64	off;
	__u32	namelen;
	__u32	type;
	char name[0];
};

A
Andrew Morton 已提交
474
#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
475 476 477
#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)
T
Tejun Heo 已提交
478 479

#endif /* _LINUX_FUSE_H */