fuse.h 22.7 KB
Newer Older
1
/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */
M
Miklos Szeredi 已提交
2
/*
3
    This file defines the kernel interface of FUSE
M
Miklos Szeredi 已提交
4
    Copyright (C) 2001-2008  Miklos Szeredi <miklos@szeredi.hu>
M
Miklos Szeredi 已提交
5 6 7

    This program can be distributed under the terms of the GNU GPL.
    See the file COPYING.
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33

    This -- and only this -- header file may also be distributed under
    the terms of the BSD Licence as follows:

    Copyright (C) 2001-2007 Miklos Szeredi. All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:
    1. Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.
    2. Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in the
       documentation and/or other materials provided with the distribution.

    THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
    ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    SUCH DAMAGE.
M
Miklos Szeredi 已提交
34 35
*/

36 37 38 39 40
/*
 * This file defines the kernel interface of FUSE
 *
 * Protocol changelog:
 *
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
 * 7.1:
 *  - add the following messages:
 *      FUSE_SETATTR, FUSE_SYMLINK, FUSE_MKNOD, FUSE_MKDIR, FUSE_UNLINK,
 *      FUSE_RMDIR, FUSE_RENAME, FUSE_LINK, FUSE_OPEN, FUSE_READ, FUSE_WRITE,
 *      FUSE_RELEASE, FUSE_FSYNC, FUSE_FLUSH, FUSE_SETXATTR, FUSE_GETXATTR,
 *      FUSE_LISTXATTR, FUSE_REMOVEXATTR, FUSE_OPENDIR, FUSE_READDIR,
 *      FUSE_RELEASEDIR
 *  - add padding to messages to accommodate 32-bit servers on 64-bit kernels
 *
 * 7.2:
 *  - add FOPEN_DIRECT_IO and FOPEN_KEEP_CACHE flags
 *  - add FUSE_FSYNCDIR message
 *
 * 7.3:
 *  - add FUSE_ACCESS message
 *  - add FUSE_CREATE message
 *  - add filehandle to fuse_setattr_in
 *
 * 7.4:
 *  - add frsize to fuse_kstatfs
 *  - clean up request size limit checking
 *
 * 7.5:
 *  - add flags and max_write to fuse_init_out
 *
 * 7.6:
 *  - add max_readahead to fuse_init_in and fuse_init_out
 *
 * 7.7:
 *  - add FUSE_INTERRUPT message
 *  - add POSIX file lock support
 *
 * 7.8:
 *  - add lock_owner and flags fields to fuse_release_in
 *  - add FUSE_BMAP message
 *  - add FUSE_DESTROY message
 *
78 79
 * 7.9:
 *  - new fuse_getattr_in input argument of GETATTR
80
 *  - add lk_flags in fuse_lk_in
81
 *  - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
82
 *  - add blksize field to fuse_attr
83
 *  - add file flags field to fuse_read_in and fuse_write_in
84
 *  - Add ATIME_NOW and MTIME_NOW flags to fuse_setattr_in
T
Tejun Heo 已提交
85 86 87
 *
 * 7.10
 *  - add nonseekable open flag
M
Miklos Szeredi 已提交
88 89 90 91 92
 *
 * 7.11
 *  - add IOCTL message
 *  - add unsolicited notification support
 *  - add POLL message and NOTIFY_POLL notification
93 94
 *
 * 7.12
95
 *  - add umask flag to input argument of create, mknod and mkdir
J
John Muir 已提交
96 97
 *  - add notification messages for invalidation of inodes and
 *    directory entries
98 99 100 101
 *
 * 7.13
 *  - make max number of background requests and congestion threshold
 *    tunables
102 103 104
 *
 * 7.14
 *  - add splice support to fuse device
M
Miklos Szeredi 已提交
105 106 107
 *
 * 7.15
 *  - add store notify
M
Miklos Szeredi 已提交
108
 *  - add retrieve notify
109 110 111
 *
 * 7.16
 *  - add BATCH_FORGET request
M
Miklos Szeredi 已提交
112 113 114
 *  - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
 *    fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
 *  - add FUSE_IOCTL_32BIT flag
M
Miklos Szeredi 已提交
115 116 117
 *
 * 7.17
 *  - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
118 119 120
 *
 * 7.18
 *  - add FUSE_IOCTL_DIR flag
121
 *  - add FUSE_NOTIFY_DELETE
A
Anatol Pomozov 已提交
122 123 124
 *
 * 7.19
 *  - add FUSE_FALLOCATE
125 126 127
 *
 * 7.20
 *  - add FUSE_AUTO_INVAL_DATA
128 129 130
 *
 * 7.21
 *  - add FUSE_READDIRPLUS
E
Enke Chen 已提交
131
 *  - send the requested events in POLL request
132 133 134
 *
 * 7.22
 *  - add FUSE_ASYNC_DIO
P
Pavel Emelyanov 已提交
135 136 137
 *
 * 7.23
 *  - add FUSE_WRITEBACK_CACHE
138 139
 *  - add time_gran to fuse_init_out
 *  - add reserved space to fuse_init_out
140 141
 *  - add FATTR_CTIME
 *  - add ctime and ctimensec to fuse_setattr_in
M
Miklos Szeredi 已提交
142
 *  - add FUSE_RENAME2 request
143
 *  - add FUSE_NO_OPEN_SUPPORT flag
144 145 146
 *
 *  7.24
 *  - add FUSE_LSEEK for SEEK_HOLE and SEEK_DATA support
147 148 149
 *
 *  7.25
 *  - add FUSE_PARALLEL_DIROPS
150 151 152
 *
 *  7.26
 *  - add FUSE_HANDLE_KILLPRIV
S
Seth Forshee 已提交
153
 *  - add FUSE_POSIX_ACL
154 155 156
 *
 *  7.27
 *  - add FUSE_ABORT_ERROR
157 158 159
 *
 *  7.28
 *  - add FUSE_COPY_FILE_RANGE
M
Miklos Szeredi 已提交
160
 *  - add FOPEN_CACHE_DIR
161
 *  - add FUSE_MAX_PAGES, add max_pages to init_out
D
Dan Schatzberg 已提交
162
 *  - add FUSE_CACHE_SYMLINKS
163 164 165
 *
 *  7.29
 *  - add FUSE_NO_OPENDIR_SUPPORT flag
166 167 168
 *
 *  7.30
 *  - add FUSE_EXPLICIT_INVAL_DATA
169
 *  - add FUSE_IOCTL_COMPAT_X32
M
Miklos Szeredi 已提交
170 171 172
 *
 *  7.31
 *  - add FUSE_WRITE_KILL_PRIV flag
173 174
 *  - add FUSE_SETUPMAPPING and FUSE_REMOVEMAPPING
 *  - add map_alignment to fuse_init_out, add FUSE_MAP_ALIGNMENT flag
175 176 177
 *
 *  7.32
 *  - add flags to fuse_attr, add FUSE_ATTR_SUBMOUNT, add FUSE_SUBMOUNTS
178 179
 *
 *  7.33
180
 *  - add FUSE_HANDLE_KILLPRIV_V2, FUSE_WRITE_KILL_SUIDGID, FATTR_KILL_SUIDGID
181
 *  - add FUSE_OPEN_KILL_SUIDGID
V
Vivek Goyal 已提交
182
 *  - extend fuse_setxattr_in, add FUSE_SETXATTR_EXT
183
 *  - add FUSE_SETXATTR_ACL_KILL_SGID
184 185 186
 *
 *  7.34
 *  - add FUSE_SYNCFS
A
Amir Goldstein 已提交
187 188 189
 *
 *  7.35
 *  - add FOPEN_NOFLUSH
190
 */
M
Miklos Szeredi 已提交
191

T
Tejun Heo 已提交
192 193 194
#ifndef _LINUX_FUSE_H
#define _LINUX_FUSE_H

195
#ifdef __KERNEL__
M
Miklos Szeredi 已提交
196
#include <linux/types.h>
197 198 199
#else
#include <stdint.h>
#endif
M
Miklos Szeredi 已提交
200

201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
/*
 * 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).
 */

M
Miklos Szeredi 已提交
221
/** Version number of this interface */
222
#define FUSE_KERNEL_VERSION 7
M
Miklos Szeredi 已提交
223 224

/** Minor version number of this interface */
A
Amir Goldstein 已提交
225
#define FUSE_KERNEL_MINOR_VERSION 35
M
Miklos Szeredi 已提交
226 227 228 229

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

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

M
Miklos Szeredi 已提交
233
struct fuse_attr {
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
	uint64_t	ino;
	uint64_t	size;
	uint64_t	blocks;
	uint64_t	atime;
	uint64_t	mtime;
	uint64_t	ctime;
	uint32_t	atimensec;
	uint32_t	mtimensec;
	uint32_t	ctimensec;
	uint32_t	mode;
	uint32_t	nlink;
	uint32_t	uid;
	uint32_t	gid;
	uint32_t	rdev;
	uint32_t	blksize;
249
	uint32_t	flags;
M
Miklos Szeredi 已提交
250 251
};

252
struct fuse_kstatfs {
253 254 255 256 257 258 259 260 261 262
	uint64_t	blocks;
	uint64_t	bfree;
	uint64_t	bavail;
	uint64_t	files;
	uint64_t	ffree;
	uint32_t	bsize;
	uint32_t	namelen;
	uint32_t	frsize;
	uint32_t	padding;
	uint32_t	spare[6];
263 264
};

265
struct fuse_file_lock {
266 267 268 269
	uint64_t	start;
	uint64_t	end;
	uint32_t	type;
	uint32_t	pid; /* tgid */
270 271
};

272 273 274
/**
 * Bitmasks for fuse_setattr_in.valid
 */
275 276 277 278 279 280
#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)
281
#define FATTR_FH	(1 << 6)
M
Miklos Szeredi 已提交
282 283
#define FATTR_ATIME_NOW	(1 << 7)
#define FATTR_MTIME_NOW	(1 << 8)
284
#define FATTR_LOCKOWNER	(1 << 9)
285
#define FATTR_CTIME	(1 << 10)
286
#define FATTR_KILL_SUIDGID	(1 << 11)
287

288 289 290 291 292
/**
 * 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 已提交
293
 * FOPEN_NONSEEKABLE: the file is not seekable
M
Miklos Szeredi 已提交
294
 * FOPEN_CACHE_DIR: allow caching this directory
295
 * FOPEN_STREAM: the file is stream-like (no file position at all)
A
Amir Goldstein 已提交
296
 * FOPEN_NOFLUSH: don't flush data cache on close (unless FUSE_WRITEBACK_CACHE)
297 298 299
 */
#define FOPEN_DIRECT_IO		(1 << 0)
#define FOPEN_KEEP_CACHE	(1 << 1)
T
Tejun Heo 已提交
300
#define FOPEN_NONSEEKABLE	(1 << 2)
M
Miklos Szeredi 已提交
301
#define FOPEN_CACHE_DIR		(1 << 3)
302
#define FOPEN_STREAM		(1 << 4)
A
Amir Goldstein 已提交
303
#define FOPEN_NOFLUSH		(1 << 5)
304

305 306
/**
 * INIT request/reply flags
307
 *
308
 * FUSE_ASYNC_READ: asynchronous read requests
M
Miklos Szeredi 已提交
309
 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
310 311
 * 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
312
 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
313
 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
314
 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
M
Miklos Szeredi 已提交
315 316 317
 * 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
M
Miklos Szeredi 已提交
318
 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
M
Miklos Szeredi 已提交
319
 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
320
 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
321 322
 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
323
 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
P
Pavel Emelyanov 已提交
324
 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
325
 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
326
 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
327
 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
S
Seth Forshee 已提交
328
 * FUSE_POSIX_ACL: filesystem supports posix acls
329
 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED
330
 * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages
D
Dan Schatzberg 已提交
331
 * FUSE_CACHE_SYMLINKS: cache READLINK responses
332
 * FUSE_NO_OPENDIR_SUPPORT: kernel supports zero-message opendir
333
 * FUSE_EXPLICIT_INVAL_DATA: only invalidate cached pages on explicit request
334 335 336
 * FUSE_MAP_ALIGNMENT: init_out.map_alignment contains log2(byte alignment) for
 *		       foffset and moffset fields in struct
 *		       fuse_setupmapping_out and fuse_removemapping_one.
337
 * FUSE_SUBMOUNTS: kernel supports auto-mounting directory submounts
338 339 340 341 342
 * FUSE_HANDLE_KILLPRIV_V2: fs kills suid/sgid/cap on write/chown/trunc.
 *			Upon write/truncate suid/sgid is only killed if caller
 *			does not have CAP_FSETID. Additionally upon
 *			write/truncate sgid is killed only if file has group
 *			execute permission. (Same as Linux VFS behavior).
V
Vivek Goyal 已提交
343
 * FUSE_SETXATTR_EXT:	Server supports extended struct fuse_setxattr_in
344 345
 */
#define FUSE_ASYNC_READ		(1 << 0)
346
#define FUSE_POSIX_LOCKS	(1 << 1)
347
#define FUSE_FILE_OPS		(1 << 2)
348
#define FUSE_ATOMIC_O_TRUNC	(1 << 3)
349
#define FUSE_EXPORT_SUPPORT	(1 << 4)
350
#define FUSE_BIG_WRITES		(1 << 5)
351
#define FUSE_DONT_MASK		(1 << 6)
M
Miklos Szeredi 已提交
352 353 354
#define FUSE_SPLICE_WRITE	(1 << 7)
#define FUSE_SPLICE_MOVE	(1 << 8)
#define FUSE_SPLICE_READ	(1 << 9)
M
Miklos Szeredi 已提交
355
#define FUSE_FLOCK_LOCKS	(1 << 10)
M
Miklos Szeredi 已提交
356
#define FUSE_HAS_IOCTL_DIR	(1 << 11)
357
#define FUSE_AUTO_INVAL_DATA	(1 << 12)
358
#define FUSE_DO_READDIRPLUS	(1 << 13)
359
#define FUSE_READDIRPLUS_AUTO	(1 << 14)
360
#define FUSE_ASYNC_DIO		(1 << 15)
P
Pavel Emelyanov 已提交
361
#define FUSE_WRITEBACK_CACHE	(1 << 16)
362
#define FUSE_NO_OPEN_SUPPORT	(1 << 17)
363
#define FUSE_PARALLEL_DIROPS    (1 << 18)
364
#define FUSE_HANDLE_KILLPRIV	(1 << 19)
S
Seth Forshee 已提交
365
#define FUSE_POSIX_ACL		(1 << 20)
366
#define FUSE_ABORT_ERROR	(1 << 21)
367
#define FUSE_MAX_PAGES		(1 << 22)
D
Dan Schatzberg 已提交
368
#define FUSE_CACHE_SYMLINKS	(1 << 23)
369
#define FUSE_NO_OPENDIR_SUPPORT (1 << 24)
370
#define FUSE_EXPLICIT_INVAL_DATA (1 << 25)
371
#define FUSE_MAP_ALIGNMENT	(1 << 26)
372
#define FUSE_SUBMOUNTS		(1 << 27)
373
#define FUSE_HANDLE_KILLPRIV_V2	(1 << 28)
V
Vivek Goyal 已提交
374
#define FUSE_SETXATTR_EXT	(1 << 29)
375

376 377 378 379 380 381 382
/**
 * CUSE INIT request/reply flags
 *
 * CUSE_UNRESTRICTED_IOCTL:  use unrestricted ioctl
 */
#define CUSE_UNRESTRICTED_IOCTL	(1 << 0)

383 384 385 386
/**
 * Release flags
 */
#define FUSE_RELEASE_FLUSH	(1 << 0)
M
Miklos Szeredi 已提交
387
#define FUSE_RELEASE_FLOCK_UNLOCK	(1 << 1)
388

389 390 391 392 393
/**
 * Getattr flags
 */
#define FUSE_GETATTR_FH		(1 << 0)

394 395 396 397 398
/**
 * Lock flags
 */
#define FUSE_LK_FLOCK		(1 << 0)

399 400 401 402
/**
 * WRITE flags
 *
 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
403
 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
404
 * FUSE_WRITE_KILL_SUIDGID: kill suid and sgid bits
405 406
 */
#define FUSE_WRITE_CACHE	(1 << 0)
407
#define FUSE_WRITE_LOCKOWNER	(1 << 1)
408 409 410 411
#define FUSE_WRITE_KILL_SUIDGID (1 << 2)

/* Obsolete alias; this flag implies killing suid/sgid only. */
#define FUSE_WRITE_KILL_PRIV	FUSE_WRITE_KILL_SUIDGID
412 413 414 415 416

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

T
Tejun Heo 已提交
418 419 420 421 422 423
/**
 * 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
M
Miklos Szeredi 已提交
424
 * FUSE_IOCTL_32BIT: 32bit ioctl
425
 * FUSE_IOCTL_DIR: is a directory
426
 * FUSE_IOCTL_COMPAT_X32: x32 compat ioctl on 64bit machine (64bit time_t)
T
Tejun Heo 已提交
427 428 429 430 431 432
 *
 * 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)
M
Miklos Szeredi 已提交
433
#define FUSE_IOCTL_32BIT	(1 << 3)
434
#define FUSE_IOCTL_DIR		(1 << 4)
435
#define FUSE_IOCTL_COMPAT_X32	(1 << 5)
T
Tejun Heo 已提交
436 437 438

#define FUSE_IOCTL_MAX_IOV	256

T
Tejun Heo 已提交
439 440 441 442 443 444 445
/**
 * Poll flags
 *
 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
 */
#define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)

446 447 448 449 450 451 452
/**
 * Fsync flags
 *
 * FUSE_FSYNC_FDATASYNC: Sync data only, not metadata
 */
#define FUSE_FSYNC_FDATASYNC	(1 << 0)

453 454 455 456 457 458 459
/**
 * fuse_attr flags
 *
 * FUSE_ATTR_SUBMOUNT: Object is a submount root
 */
#define FUSE_ATTR_SUBMOUNT      (1 << 0)

460 461 462 463 464 465
/**
 * Open flags
 * FUSE_OPEN_KILL_SUIDGID: Kill suid and sgid if executable
 */
#define FUSE_OPEN_KILL_SUIDGID	(1 << 0)

466 467 468 469 470 471
/**
 * setxattr flags
 * FUSE_SETXATTR_ACL_KILL_SGID: Clear SGID when system.posix_acl_access is set
 */
#define FUSE_SETXATTR_ACL_KILL_SGID	(1 << 0)

M
Miklos Szeredi 已提交
472
enum fuse_opcode {
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
	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,
	FUSE_READDIRPLUS	= 44,
	FUSE_RENAME2		= 45,
	FUSE_LSEEK		= 46,
	FUSE_COPY_FILE_RANGE	= 47,
518 519
	FUSE_SETUPMAPPING	= 48,
	FUSE_REMOVEMAPPING	= 49,
520
	FUSE_SYNCFS		= 50,
521 522

	/* CUSE specific operations */
523
	CUSE_INIT		= 4096,
524 525 526 527

	/* Reserved opcodes: helpful to detect structure endian-ness */
	CUSE_INIT_BSWAP_RESERVED	= 1048576,	/* CUSE_INIT << 8 */
	FUSE_INIT_BSWAP_RESERVED	= 436207616,	/* FUSE_INIT << 24 */
M
Miklos Szeredi 已提交
528 529
};

530
enum fuse_notify_code {
T
Tejun Heo 已提交
531
	FUSE_NOTIFY_POLL   = 1,
J
John Muir 已提交
532 533
	FUSE_NOTIFY_INVAL_INODE = 2,
	FUSE_NOTIFY_INVAL_ENTRY = 3,
M
Miklos Szeredi 已提交
534
	FUSE_NOTIFY_STORE = 4,
M
Miklos Szeredi 已提交
535
	FUSE_NOTIFY_RETRIEVE = 5,
536
	FUSE_NOTIFY_DELETE = 6,
537 538 539
	FUSE_NOTIFY_CODE_MAX,
};

540 541
/* The read buffer is required to be at least 8k, but may be much larger */
#define FUSE_MIN_READ_BUFFER 8192
542

543 544
#define FUSE_COMPAT_ENTRY_OUT_SIZE 120

545
struct fuse_entry_out {
546 547 548 549 550 551 552
	uint64_t	nodeid;		/* Inode ID */
	uint64_t	generation;	/* Inode generation: nodeid:gen must
					   be unique for the fs's lifetime */
	uint64_t	entry_valid;	/* Cache timeout for the name */
	uint64_t	attr_valid;	/* Cache timeout for the attributes */
	uint32_t	entry_valid_nsec;
	uint32_t	attr_valid_nsec;
553 554 555 556
	struct fuse_attr attr;
};

struct fuse_forget_in {
557
	uint64_t	nlookup;
558 559
};

560
struct fuse_forget_one {
561 562
	uint64_t	nodeid;
	uint64_t	nlookup;
563 564 565
};

struct fuse_batch_forget_in {
566 567
	uint32_t	count;
	uint32_t	dummy;
568 569
};

570
struct fuse_getattr_in {
571 572 573
	uint32_t	getattr_flags;
	uint32_t	dummy;
	uint64_t	fh;
574 575
};

576 577
#define FUSE_COMPAT_ATTR_OUT_SIZE 96

578
struct fuse_attr_out {
579 580 581
	uint64_t	attr_valid;	/* Cache timeout for the attributes */
	uint32_t	attr_valid_nsec;
	uint32_t	dummy;
582 583 584
	struct fuse_attr attr;
};

585 586
#define FUSE_COMPAT_MKNOD_IN_SIZE 8

587
struct fuse_mknod_in {
588 589 590 591
	uint32_t	mode;
	uint32_t	rdev;
	uint32_t	umask;
	uint32_t	padding;
592 593 594
};

struct fuse_mkdir_in {
595 596
	uint32_t	mode;
	uint32_t	umask;
597 598 599
};

struct fuse_rename_in {
600
	uint64_t	newdir;
601 602
};

M
Miklos Szeredi 已提交
603 604 605 606 607 608
struct fuse_rename2_in {
	uint64_t	newdir;
	uint32_t	flags;
	uint32_t	padding;
};

609
struct fuse_link_in {
610
	uint64_t	oldnodeid;
611 612 613
};

struct fuse_setattr_in {
614 615 616 617 618 619 620
	uint32_t	valid;
	uint32_t	padding;
	uint64_t	fh;
	uint64_t	size;
	uint64_t	lock_owner;
	uint64_t	atime;
	uint64_t	mtime;
621
	uint64_t	ctime;
622 623
	uint32_t	atimensec;
	uint32_t	mtimensec;
624
	uint32_t	ctimensec;
625 626 627 628 629
	uint32_t	mode;
	uint32_t	unused4;
	uint32_t	uid;
	uint32_t	gid;
	uint32_t	unused5;
630 631
};

M
Miklos Szeredi 已提交
632
struct fuse_open_in {
633
	uint32_t	flags;
634
	uint32_t	open_flags;	/* FUSE_OPEN_... */
635 636 637
};

struct fuse_create_in {
638 639 640
	uint32_t	flags;
	uint32_t	mode;
	uint32_t	umask;
641
	uint32_t	open_flags;	/* FUSE_OPEN_... */
M
Miklos Szeredi 已提交
642 643 644
};

struct fuse_open_out {
645 646 647
	uint64_t	fh;
	uint32_t	open_flags;
	uint32_t	padding;
M
Miklos Szeredi 已提交
648 649 650
};

struct fuse_release_in {
651 652 653 654
	uint64_t	fh;
	uint32_t	flags;
	uint32_t	release_flags;
	uint64_t	lock_owner;
M
Miklos Szeredi 已提交
655 656 657
};

struct fuse_flush_in {
658 659 660 661
	uint64_t	fh;
	uint32_t	unused;
	uint32_t	padding;
	uint64_t	lock_owner;
M
Miklos Szeredi 已提交
662 663 664
};

struct fuse_read_in {
665 666 667 668 669 670 671
	uint64_t	fh;
	uint64_t	offset;
	uint32_t	size;
	uint32_t	read_flags;
	uint64_t	lock_owner;
	uint32_t	flags;
	uint32_t	padding;
M
Miklos Szeredi 已提交
672 673
};

674 675
#define FUSE_COMPAT_WRITE_IN_SIZE 24

M
Miklos Szeredi 已提交
676
struct fuse_write_in {
677 678 679 680 681 682 683
	uint64_t	fh;
	uint64_t	offset;
	uint32_t	size;
	uint32_t	write_flags;
	uint64_t	lock_owner;
	uint32_t	flags;
	uint32_t	padding;
M
Miklos Szeredi 已提交
684 685 686
};

struct fuse_write_out {
687 688
	uint32_t	size;
	uint32_t	padding;
M
Miklos Szeredi 已提交
689 690
};

691 692
#define FUSE_COMPAT_STATFS_SIZE 48

693 694 695 696
struct fuse_statfs_out {
	struct fuse_kstatfs st;
};

M
Miklos Szeredi 已提交
697
struct fuse_fsync_in {
698 699 700
	uint64_t	fh;
	uint32_t	fsync_flags;
	uint32_t	padding;
M
Miklos Szeredi 已提交
701 702
};

V
Vivek Goyal 已提交
703 704
#define FUSE_COMPAT_SETXATTR_IN_SIZE 8

705
struct fuse_setxattr_in {
706 707
	uint32_t	size;
	uint32_t	flags;
V
Vivek Goyal 已提交
708 709
	uint32_t	setxattr_flags;
	uint32_t	padding;
710 711 712
};

struct fuse_getxattr_in {
713 714
	uint32_t	size;
	uint32_t	padding;
715 716 717
};

struct fuse_getxattr_out {
718 719
	uint32_t	size;
	uint32_t	padding;
720 721
};

722
struct fuse_lk_in {
723 724
	uint64_t	fh;
	uint64_t	owner;
725
	struct fuse_file_lock lk;
726 727
	uint32_t	lk_flags;
	uint32_t	padding;
728 729 730 731 732 733
};

struct fuse_lk_out {
	struct fuse_file_lock lk;
};

M
Miklos Szeredi 已提交
734
struct fuse_access_in {
735 736
	uint32_t	mask;
	uint32_t	padding;
M
Miklos Szeredi 已提交
737 738
};

739
struct fuse_init_in {
740 741 742 743
	uint32_t	major;
	uint32_t	minor;
	uint32_t	max_readahead;
	uint32_t	flags;
M
Miklos Szeredi 已提交
744 745
};

746 747 748
#define FUSE_COMPAT_INIT_OUT_SIZE 8
#define FUSE_COMPAT_22_INIT_OUT_SIZE 24

749
struct fuse_init_out {
750 751 752 753 754 755 756
	uint32_t	major;
	uint32_t	minor;
	uint32_t	max_readahead;
	uint32_t	flags;
	uint16_t	max_background;
	uint16_t	congestion_threshold;
	uint32_t	max_write;
757
	uint32_t	time_gran;
758
	uint16_t	max_pages;
759
	uint16_t	map_alignment;
760
	uint32_t	unused[8];
761 762
};

763 764 765
#define CUSE_INIT_INFO_MAX 4096

struct cuse_init_in {
766 767 768 769
	uint32_t	major;
	uint32_t	minor;
	uint32_t	unused;
	uint32_t	flags;
770 771 772
};

struct cuse_init_out {
773 774 775 776 777 778 779 780 781
	uint32_t	major;
	uint32_t	minor;
	uint32_t	unused;
	uint32_t	flags;
	uint32_t	max_read;
	uint32_t	max_write;
	uint32_t	dev_major;		/* chardev major */
	uint32_t	dev_minor;		/* chardev minor */
	uint32_t	spare[10];
782 783
};

784
struct fuse_interrupt_in {
785
	uint64_t	unique;
786 787
};

M
Miklos Szeredi 已提交
788
struct fuse_bmap_in {
789 790 791
	uint64_t	block;
	uint32_t	blocksize;
	uint32_t	padding;
M
Miklos Szeredi 已提交
792 793 794
};

struct fuse_bmap_out {
795
	uint64_t	block;
M
Miklos Szeredi 已提交
796 797
};

T
Tejun Heo 已提交
798
struct fuse_ioctl_in {
799 800 801 802 803 804
	uint64_t	fh;
	uint32_t	flags;
	uint32_t	cmd;
	uint64_t	arg;
	uint32_t	in_size;
	uint32_t	out_size;
T
Tejun Heo 已提交
805 806
};

M
Miklos Szeredi 已提交
807
struct fuse_ioctl_iovec {
808 809
	uint64_t	base;
	uint64_t	len;
M
Miklos Szeredi 已提交
810 811
};

T
Tejun Heo 已提交
812
struct fuse_ioctl_out {
813 814 815 816
	int32_t		result;
	uint32_t	flags;
	uint32_t	in_iovs;
	uint32_t	out_iovs;
T
Tejun Heo 已提交
817 818
};

T
Tejun Heo 已提交
819
struct fuse_poll_in {
820 821 822 823
	uint64_t	fh;
	uint64_t	kh;
	uint32_t	flags;
	uint32_t	events;
T
Tejun Heo 已提交
824 825 826
};

struct fuse_poll_out {
827 828
	uint32_t	revents;
	uint32_t	padding;
T
Tejun Heo 已提交
829 830 831
};

struct fuse_notify_poll_wakeup_out {
832
	uint64_t	kh;
T
Tejun Heo 已提交
833 834
};

A
Anatol Pomozov 已提交
835
struct fuse_fallocate_in {
836 837 838 839 840
	uint64_t	fh;
	uint64_t	offset;
	uint64_t	length;
	uint32_t	mode;
	uint32_t	padding;
A
Anatol Pomozov 已提交
841 842
};

M
Miklos Szeredi 已提交
843
struct fuse_in_header {
844 845 846 847 848 849 850 851
	uint32_t	len;
	uint32_t	opcode;
	uint64_t	unique;
	uint64_t	nodeid;
	uint32_t	uid;
	uint32_t	gid;
	uint32_t	pid;
	uint32_t	padding;
M
Miklos Szeredi 已提交
852 853 854
};

struct fuse_out_header {
855 856 857
	uint32_t	len;
	int32_t		error;
	uint64_t	unique;
M
Miklos Szeredi 已提交
858 859
};

860
struct fuse_dirent {
861 862 863 864
	uint64_t	ino;
	uint64_t	off;
	uint32_t	namelen;
	uint32_t	type;
865
	char name[];
866 867
};

A
Andrew Morton 已提交
868
#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
869 870
#define FUSE_DIRENT_ALIGN(x) \
	(((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
871 872
#define FUSE_DIRENT_SIZE(d) \
	FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
T
Tejun Heo 已提交
873

874 875 876 877 878 879 880 881 882 883
struct fuse_direntplus {
	struct fuse_entry_out entry_out;
	struct fuse_dirent dirent;
};

#define FUSE_NAME_OFFSET_DIRENTPLUS \
	offsetof(struct fuse_direntplus, dirent.name)
#define FUSE_DIRENTPLUS_SIZE(d) \
	FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)

J
John Muir 已提交
884
struct fuse_notify_inval_inode_out {
885 886 887
	uint64_t	ino;
	int64_t		off;
	int64_t		len;
J
John Muir 已提交
888 889 890
};

struct fuse_notify_inval_entry_out {
891 892 893
	uint64_t	parent;
	uint32_t	namelen;
	uint32_t	padding;
J
John Muir 已提交
894 895
};

896
struct fuse_notify_delete_out {
897 898 899 900
	uint64_t	parent;
	uint64_t	child;
	uint32_t	namelen;
	uint32_t	padding;
901 902
};

M
Miklos Szeredi 已提交
903
struct fuse_notify_store_out {
904 905 906 907
	uint64_t	nodeid;
	uint64_t	offset;
	uint32_t	size;
	uint32_t	padding;
M
Miklos Szeredi 已提交
908 909
};

M
Miklos Szeredi 已提交
910
struct fuse_notify_retrieve_out {
911 912 913 914 915
	uint64_t	notify_unique;
	uint64_t	nodeid;
	uint64_t	offset;
	uint32_t	size;
	uint32_t	padding;
M
Miklos Szeredi 已提交
916 917 918 919
};

/* Matches the size of fuse_write_in */
struct fuse_notify_retrieve_in {
920 921 922 923 924 925
	uint64_t	dummy1;
	uint64_t	offset;
	uint32_t	size;
	uint32_t	dummy2;
	uint64_t	dummy3;
	uint64_t	dummy4;
M
Miklos Szeredi 已提交
926 927
};

M
Miklos Szeredi 已提交
928
/* Device ioctls: */
929 930
#define FUSE_DEV_IOC_MAGIC		229
#define FUSE_DEV_IOC_CLONE		_IOR(FUSE_DEV_IOC_MAGIC, 0, uint32_t)
M
Miklos Szeredi 已提交
931

932 933 934 935 936 937 938 939 940 941 942
struct fuse_lseek_in {
	uint64_t	fh;
	uint64_t	offset;
	uint32_t	whence;
	uint32_t	padding;
};

struct fuse_lseek_out {
	uint64_t	offset;
};

943 944 945 946 947 948 949 950 951 952
struct fuse_copy_file_range_in {
	uint64_t	fh_in;
	uint64_t	off_in;
	uint64_t	nodeid_out;
	uint64_t	fh_out;
	uint64_t	off_out;
	uint64_t	len;
	uint64_t	flags;
};

953
#define FUSE_SETUPMAPPING_FLAG_WRITE (1ull << 0)
954
#define FUSE_SETUPMAPPING_FLAG_READ (1ull << 1)
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
struct fuse_setupmapping_in {
	/* An already open handle */
	uint64_t	fh;
	/* Offset into the file to start the mapping */
	uint64_t	foffset;
	/* Length of mapping required */
	uint64_t	len;
	/* Flags, FUSE_SETUPMAPPING_FLAG_* */
	uint64_t	flags;
	/* Offset in Memory Window */
	uint64_t	moffset;
};

struct fuse_removemapping_in {
	/* number of fuse_removemapping_one follows */
	uint32_t        count;
};

struct fuse_removemapping_one {
	/* Offset into the dax window start the unmapping */
	uint64_t        moffset;
	/* Length of mapping required */
	uint64_t	len;
};

#define FUSE_REMOVEMAPPING_MAX_ENTRY   \
		(PAGE_SIZE / sizeof(struct fuse_removemapping_one))

983 984 985 986
struct fuse_syncfs_in {
	uint64_t	padding;
};

T
Tejun Heo 已提交
987
#endif /* _LINUX_FUSE_H */