fuse.h 24.2 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
M
Miklos Szeredi 已提交
190 191 192 193
 *
 *  7.36
 *  - extend fuse_init_in with reserved fields, add FUSE_INIT_EXT init flag
 *  - add flags2 to fuse_init_in and fuse_init_out
194 195
 *  - add FUSE_SECURITY_CTX init flag
 *  - add security context to create, mkdir, symlink, and mknod requests
196
 *  - add FUSE_HAS_INODE_DAX, FUSE_ATTR_DAX
M
Miklos Szeredi 已提交
197 198 199
 *
 *  7.37
 *  - add FUSE_TMPFILE
200
 */
M
Miklos Szeredi 已提交
201

T
Tejun Heo 已提交
202 203 204
#ifndef _LINUX_FUSE_H
#define _LINUX_FUSE_H

205
#ifdef __KERNEL__
M
Miklos Szeredi 已提交
206
#include <linux/types.h>
207 208 209
#else
#include <stdint.h>
#endif
M
Miklos Szeredi 已提交
210

211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
/*
 * 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 已提交
231
/** Version number of this interface */
232
#define FUSE_KERNEL_VERSION 7
M
Miklos Szeredi 已提交
233 234

/** Minor version number of this interface */
M
Miklos Szeredi 已提交
235
#define FUSE_KERNEL_MINOR_VERSION 37
M
Miklos Szeredi 已提交
236 237 238 239

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

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

M
Miklos Szeredi 已提交
243
struct fuse_attr {
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
	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;
259
	uint32_t	flags;
M
Miklos Szeredi 已提交
260 261
};

262
struct fuse_kstatfs {
263 264 265 266 267 268 269 270 271 272
	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];
273 274
};

275
struct fuse_file_lock {
276 277 278 279
	uint64_t	start;
	uint64_t	end;
	uint32_t	type;
	uint32_t	pid; /* tgid */
280 281
};

282 283 284
/**
 * Bitmasks for fuse_setattr_in.valid
 */
285 286 287 288 289 290
#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)
291
#define FATTR_FH	(1 << 6)
M
Miklos Szeredi 已提交
292 293
#define FATTR_ATIME_NOW	(1 << 7)
#define FATTR_MTIME_NOW	(1 << 8)
294
#define FATTR_LOCKOWNER	(1 << 9)
295
#define FATTR_CTIME	(1 << 10)
296
#define FATTR_KILL_SUIDGID	(1 << 11)
297

298 299 300 301 302
/**
 * 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 已提交
303
 * FOPEN_NONSEEKABLE: the file is not seekable
M
Miklos Szeredi 已提交
304
 * FOPEN_CACHE_DIR: allow caching this directory
305
 * FOPEN_STREAM: the file is stream-like (no file position at all)
A
Amir Goldstein 已提交
306
 * FOPEN_NOFLUSH: don't flush data cache on close (unless FUSE_WRITEBACK_CACHE)
307 308 309
 */
#define FOPEN_DIRECT_IO		(1 << 0)
#define FOPEN_KEEP_CACHE	(1 << 1)
T
Tejun Heo 已提交
310
#define FOPEN_NONSEEKABLE	(1 << 2)
M
Miklos Szeredi 已提交
311
#define FOPEN_CACHE_DIR		(1 << 3)
312
#define FOPEN_STREAM		(1 << 4)
A
Amir Goldstein 已提交
313
#define FOPEN_NOFLUSH		(1 << 5)
314

315 316
/**
 * INIT request/reply flags
317
 *
318
 * FUSE_ASYNC_READ: asynchronous read requests
M
Miklos Szeredi 已提交
319
 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
320 321
 * 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
322
 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
323
 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
324
 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
M
Miklos Szeredi 已提交
325 326 327
 * 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 已提交
328
 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
M
Miklos Szeredi 已提交
329
 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
330
 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
331 332
 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
333
 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
P
Pavel Emelyanov 已提交
334
 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
335
 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
336
 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
337
 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
S
Seth Forshee 已提交
338
 * FUSE_POSIX_ACL: filesystem supports posix acls
339
 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED
340
 * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages
D
Dan Schatzberg 已提交
341
 * FUSE_CACHE_SYMLINKS: cache READLINK responses
342
 * FUSE_NO_OPENDIR_SUPPORT: kernel supports zero-message opendir
343
 * FUSE_EXPLICIT_INVAL_DATA: only invalidate cached pages on explicit request
344 345 346
 * 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.
347
 * FUSE_SUBMOUNTS: kernel supports auto-mounting directory submounts
348 349 350 351 352
 * 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 已提交
353
 * FUSE_SETXATTR_EXT:	Server supports extended struct fuse_setxattr_in
M
Miklos Szeredi 已提交
354 355
 * FUSE_INIT_EXT: extended fuse_init_in request
 * FUSE_INIT_RESERVED: reserved, do not use
356 357
 * FUSE_SECURITY_CTX:	add security context to create, mkdir, symlink, and
 *			mknod
358
 * FUSE_HAS_INODE_DAX:  use per inode DAX
359 360
 */
#define FUSE_ASYNC_READ		(1 << 0)
361
#define FUSE_POSIX_LOCKS	(1 << 1)
362
#define FUSE_FILE_OPS		(1 << 2)
363
#define FUSE_ATOMIC_O_TRUNC	(1 << 3)
364
#define FUSE_EXPORT_SUPPORT	(1 << 4)
365
#define FUSE_BIG_WRITES		(1 << 5)
366
#define FUSE_DONT_MASK		(1 << 6)
M
Miklos Szeredi 已提交
367 368 369
#define FUSE_SPLICE_WRITE	(1 << 7)
#define FUSE_SPLICE_MOVE	(1 << 8)
#define FUSE_SPLICE_READ	(1 << 9)
M
Miklos Szeredi 已提交
370
#define FUSE_FLOCK_LOCKS	(1 << 10)
M
Miklos Szeredi 已提交
371
#define FUSE_HAS_IOCTL_DIR	(1 << 11)
372
#define FUSE_AUTO_INVAL_DATA	(1 << 12)
373
#define FUSE_DO_READDIRPLUS	(1 << 13)
374
#define FUSE_READDIRPLUS_AUTO	(1 << 14)
375
#define FUSE_ASYNC_DIO		(1 << 15)
P
Pavel Emelyanov 已提交
376
#define FUSE_WRITEBACK_CACHE	(1 << 16)
377
#define FUSE_NO_OPEN_SUPPORT	(1 << 17)
378
#define FUSE_PARALLEL_DIROPS    (1 << 18)
379
#define FUSE_HANDLE_KILLPRIV	(1 << 19)
S
Seth Forshee 已提交
380
#define FUSE_POSIX_ACL		(1 << 20)
381
#define FUSE_ABORT_ERROR	(1 << 21)
382
#define FUSE_MAX_PAGES		(1 << 22)
D
Dan Schatzberg 已提交
383
#define FUSE_CACHE_SYMLINKS	(1 << 23)
384
#define FUSE_NO_OPENDIR_SUPPORT (1 << 24)
385
#define FUSE_EXPLICIT_INVAL_DATA (1 << 25)
386
#define FUSE_MAP_ALIGNMENT	(1 << 26)
387
#define FUSE_SUBMOUNTS		(1 << 27)
388
#define FUSE_HANDLE_KILLPRIV_V2	(1 << 28)
V
Vivek Goyal 已提交
389
#define FUSE_SETXATTR_EXT	(1 << 29)
M
Miklos Szeredi 已提交
390 391 392
#define FUSE_INIT_EXT		(1 << 30)
#define FUSE_INIT_RESERVED	(1 << 31)
/* bits 32..63 get shifted down 32 bits into the flags2 field */
393
#define FUSE_SECURITY_CTX	(1ULL << 32)
394
#define FUSE_HAS_INODE_DAX	(1ULL << 33)
395

396 397 398 399 400 401 402
/**
 * CUSE INIT request/reply flags
 *
 * CUSE_UNRESTRICTED_IOCTL:  use unrestricted ioctl
 */
#define CUSE_UNRESTRICTED_IOCTL	(1 << 0)

403 404 405 406
/**
 * Release flags
 */
#define FUSE_RELEASE_FLUSH	(1 << 0)
M
Miklos Szeredi 已提交
407
#define FUSE_RELEASE_FLOCK_UNLOCK	(1 << 1)
408

409 410 411 412 413
/**
 * Getattr flags
 */
#define FUSE_GETATTR_FH		(1 << 0)

414 415 416 417 418
/**
 * Lock flags
 */
#define FUSE_LK_FLOCK		(1 << 0)

419 420 421 422
/**
 * WRITE flags
 *
 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
423
 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
424
 * FUSE_WRITE_KILL_SUIDGID: kill suid and sgid bits
425 426
 */
#define FUSE_WRITE_CACHE	(1 << 0)
427
#define FUSE_WRITE_LOCKOWNER	(1 << 1)
428 429 430 431
#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
432 433 434 435 436

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

T
Tejun Heo 已提交
438 439 440 441 442 443
/**
 * 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 已提交
444
 * FUSE_IOCTL_32BIT: 32bit ioctl
445
 * FUSE_IOCTL_DIR: is a directory
446
 * FUSE_IOCTL_COMPAT_X32: x32 compat ioctl on 64bit machine (64bit time_t)
T
Tejun Heo 已提交
447 448 449 450 451 452
 *
 * 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 已提交
453
#define FUSE_IOCTL_32BIT	(1 << 3)
454
#define FUSE_IOCTL_DIR		(1 << 4)
455
#define FUSE_IOCTL_COMPAT_X32	(1 << 5)
T
Tejun Heo 已提交
456 457 458

#define FUSE_IOCTL_MAX_IOV	256

T
Tejun Heo 已提交
459 460 461 462 463 464 465
/**
 * Poll flags
 *
 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
 */
#define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)

466 467 468 469 470 471 472
/**
 * Fsync flags
 *
 * FUSE_FSYNC_FDATASYNC: Sync data only, not metadata
 */
#define FUSE_FSYNC_FDATASYNC	(1 << 0)

473 474 475 476
/**
 * fuse_attr flags
 *
 * FUSE_ATTR_SUBMOUNT: Object is a submount root
477
 * FUSE_ATTR_DAX: Enable DAX for this file in per inode DAX mode
478 479
 */
#define FUSE_ATTR_SUBMOUNT      (1 << 0)
480
#define FUSE_ATTR_DAX		(1 << 1)
481

482 483 484 485 486 487
/**
 * Open flags
 * FUSE_OPEN_KILL_SUIDGID: Kill suid and sgid if executable
 */
#define FUSE_OPEN_KILL_SUIDGID	(1 << 0)

488 489 490 491 492 493
/**
 * 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 已提交
494
enum fuse_opcode {
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
	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,
540 541
	FUSE_SETUPMAPPING	= 48,
	FUSE_REMOVEMAPPING	= 49,
542
	FUSE_SYNCFS		= 50,
M
Miklos Szeredi 已提交
543
	FUSE_TMPFILE		= 51,
544 545

	/* CUSE specific operations */
546
	CUSE_INIT		= 4096,
547 548 549 550

	/* 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 已提交
551 552
};

553
enum fuse_notify_code {
T
Tejun Heo 已提交
554
	FUSE_NOTIFY_POLL   = 1,
J
John Muir 已提交
555 556
	FUSE_NOTIFY_INVAL_INODE = 2,
	FUSE_NOTIFY_INVAL_ENTRY = 3,
M
Miklos Szeredi 已提交
557
	FUSE_NOTIFY_STORE = 4,
M
Miklos Szeredi 已提交
558
	FUSE_NOTIFY_RETRIEVE = 5,
559
	FUSE_NOTIFY_DELETE = 6,
560 561 562
	FUSE_NOTIFY_CODE_MAX,
};

563 564
/* The read buffer is required to be at least 8k, but may be much larger */
#define FUSE_MIN_READ_BUFFER 8192
565

566 567
#define FUSE_COMPAT_ENTRY_OUT_SIZE 120

568
struct fuse_entry_out {
569 570 571 572 573 574 575
	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;
576 577 578 579
	struct fuse_attr attr;
};

struct fuse_forget_in {
580
	uint64_t	nlookup;
581 582
};

583
struct fuse_forget_one {
584 585
	uint64_t	nodeid;
	uint64_t	nlookup;
586 587 588
};

struct fuse_batch_forget_in {
589 590
	uint32_t	count;
	uint32_t	dummy;
591 592
};

593
struct fuse_getattr_in {
594 595 596
	uint32_t	getattr_flags;
	uint32_t	dummy;
	uint64_t	fh;
597 598
};

599 600
#define FUSE_COMPAT_ATTR_OUT_SIZE 96

601
struct fuse_attr_out {
602 603 604
	uint64_t	attr_valid;	/* Cache timeout for the attributes */
	uint32_t	attr_valid_nsec;
	uint32_t	dummy;
605 606 607
	struct fuse_attr attr;
};

608 609
#define FUSE_COMPAT_MKNOD_IN_SIZE 8

610
struct fuse_mknod_in {
611 612 613 614
	uint32_t	mode;
	uint32_t	rdev;
	uint32_t	umask;
	uint32_t	padding;
615 616 617
};

struct fuse_mkdir_in {
618 619
	uint32_t	mode;
	uint32_t	umask;
620 621 622
};

struct fuse_rename_in {
623
	uint64_t	newdir;
624 625
};

M
Miklos Szeredi 已提交
626 627 628 629 630 631
struct fuse_rename2_in {
	uint64_t	newdir;
	uint32_t	flags;
	uint32_t	padding;
};

632
struct fuse_link_in {
633
	uint64_t	oldnodeid;
634 635 636
};

struct fuse_setattr_in {
637 638 639 640 641 642 643
	uint32_t	valid;
	uint32_t	padding;
	uint64_t	fh;
	uint64_t	size;
	uint64_t	lock_owner;
	uint64_t	atime;
	uint64_t	mtime;
644
	uint64_t	ctime;
645 646
	uint32_t	atimensec;
	uint32_t	mtimensec;
647
	uint32_t	ctimensec;
648 649 650 651 652
	uint32_t	mode;
	uint32_t	unused4;
	uint32_t	uid;
	uint32_t	gid;
	uint32_t	unused5;
653 654
};

M
Miklos Szeredi 已提交
655
struct fuse_open_in {
656
	uint32_t	flags;
657
	uint32_t	open_flags;	/* FUSE_OPEN_... */
658 659 660
};

struct fuse_create_in {
661 662 663
	uint32_t	flags;
	uint32_t	mode;
	uint32_t	umask;
664
	uint32_t	open_flags;	/* FUSE_OPEN_... */
M
Miklos Szeredi 已提交
665 666 667
};

struct fuse_open_out {
668 669 670
	uint64_t	fh;
	uint32_t	open_flags;
	uint32_t	padding;
M
Miklos Szeredi 已提交
671 672 673
};

struct fuse_release_in {
674 675 676 677
	uint64_t	fh;
	uint32_t	flags;
	uint32_t	release_flags;
	uint64_t	lock_owner;
M
Miklos Szeredi 已提交
678 679 680
};

struct fuse_flush_in {
681 682 683 684
	uint64_t	fh;
	uint32_t	unused;
	uint32_t	padding;
	uint64_t	lock_owner;
M
Miklos Szeredi 已提交
685 686 687
};

struct fuse_read_in {
688 689 690 691 692 693 694
	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 已提交
695 696
};

697 698
#define FUSE_COMPAT_WRITE_IN_SIZE 24

M
Miklos Szeredi 已提交
699
struct fuse_write_in {
700 701 702 703 704 705 706
	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 已提交
707 708 709
};

struct fuse_write_out {
710 711
	uint32_t	size;
	uint32_t	padding;
M
Miklos Szeredi 已提交
712 713
};

714 715
#define FUSE_COMPAT_STATFS_SIZE 48

716 717 718 719
struct fuse_statfs_out {
	struct fuse_kstatfs st;
};

M
Miklos Szeredi 已提交
720
struct fuse_fsync_in {
721 722 723
	uint64_t	fh;
	uint32_t	fsync_flags;
	uint32_t	padding;
M
Miklos Szeredi 已提交
724 725
};

V
Vivek Goyal 已提交
726 727
#define FUSE_COMPAT_SETXATTR_IN_SIZE 8

728
struct fuse_setxattr_in {
729 730
	uint32_t	size;
	uint32_t	flags;
V
Vivek Goyal 已提交
731 732
	uint32_t	setxattr_flags;
	uint32_t	padding;
733 734 735
};

struct fuse_getxattr_in {
736 737
	uint32_t	size;
	uint32_t	padding;
738 739 740
};

struct fuse_getxattr_out {
741 742
	uint32_t	size;
	uint32_t	padding;
743 744
};

745
struct fuse_lk_in {
746 747
	uint64_t	fh;
	uint64_t	owner;
748
	struct fuse_file_lock lk;
749 750
	uint32_t	lk_flags;
	uint32_t	padding;
751 752 753 754 755 756
};

struct fuse_lk_out {
	struct fuse_file_lock lk;
};

M
Miklos Szeredi 已提交
757
struct fuse_access_in {
758 759
	uint32_t	mask;
	uint32_t	padding;
M
Miklos Szeredi 已提交
760 761
};

762
struct fuse_init_in {
763 764 765 766
	uint32_t	major;
	uint32_t	minor;
	uint32_t	max_readahead;
	uint32_t	flags;
M
Miklos Szeredi 已提交
767 768
	uint32_t	flags2;
	uint32_t	unused[11];
M
Miklos Szeredi 已提交
769 770
};

771 772 773
#define FUSE_COMPAT_INIT_OUT_SIZE 8
#define FUSE_COMPAT_22_INIT_OUT_SIZE 24

774
struct fuse_init_out {
775 776 777 778 779 780 781
	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;
782
	uint32_t	time_gran;
783
	uint16_t	max_pages;
784
	uint16_t	map_alignment;
M
Miklos Szeredi 已提交
785 786
	uint32_t	flags2;
	uint32_t	unused[7];
787 788
};

789 790 791
#define CUSE_INIT_INFO_MAX 4096

struct cuse_init_in {
792 793 794 795
	uint32_t	major;
	uint32_t	minor;
	uint32_t	unused;
	uint32_t	flags;
796 797 798
};

struct cuse_init_out {
799 800 801 802 803 804 805 806 807
	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];
808 809
};

810
struct fuse_interrupt_in {
811
	uint64_t	unique;
812 813
};

M
Miklos Szeredi 已提交
814
struct fuse_bmap_in {
815 816 817
	uint64_t	block;
	uint32_t	blocksize;
	uint32_t	padding;
M
Miklos Szeredi 已提交
818 819 820
};

struct fuse_bmap_out {
821
	uint64_t	block;
M
Miklos Szeredi 已提交
822 823
};

T
Tejun Heo 已提交
824
struct fuse_ioctl_in {
825 826 827 828 829 830
	uint64_t	fh;
	uint32_t	flags;
	uint32_t	cmd;
	uint64_t	arg;
	uint32_t	in_size;
	uint32_t	out_size;
T
Tejun Heo 已提交
831 832
};

M
Miklos Szeredi 已提交
833
struct fuse_ioctl_iovec {
834 835
	uint64_t	base;
	uint64_t	len;
M
Miklos Szeredi 已提交
836 837
};

T
Tejun Heo 已提交
838
struct fuse_ioctl_out {
839 840 841 842
	int32_t		result;
	uint32_t	flags;
	uint32_t	in_iovs;
	uint32_t	out_iovs;
T
Tejun Heo 已提交
843 844
};

T
Tejun Heo 已提交
845
struct fuse_poll_in {
846 847 848 849
	uint64_t	fh;
	uint64_t	kh;
	uint32_t	flags;
	uint32_t	events;
T
Tejun Heo 已提交
850 851 852
};

struct fuse_poll_out {
853 854
	uint32_t	revents;
	uint32_t	padding;
T
Tejun Heo 已提交
855 856 857
};

struct fuse_notify_poll_wakeup_out {
858
	uint64_t	kh;
T
Tejun Heo 已提交
859 860
};

A
Anatol Pomozov 已提交
861
struct fuse_fallocate_in {
862 863 864 865 866
	uint64_t	fh;
	uint64_t	offset;
	uint64_t	length;
	uint32_t	mode;
	uint32_t	padding;
A
Anatol Pomozov 已提交
867 868
};

M
Miklos Szeredi 已提交
869
struct fuse_in_header {
870 871 872 873 874 875 876 877
	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 已提交
878 879 880
};

struct fuse_out_header {
881 882 883
	uint32_t	len;
	int32_t		error;
	uint64_t	unique;
M
Miklos Szeredi 已提交
884 885
};

886
struct fuse_dirent {
887 888 889 890
	uint64_t	ino;
	uint64_t	off;
	uint32_t	namelen;
	uint32_t	type;
891
	char name[];
892 893
};

894 895
/* Align variable length records to 64bit boundary */
#define FUSE_REC_ALIGN(x) \
896
	(((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
897 898 899

#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
#define FUSE_DIRENT_ALIGN(x) FUSE_REC_ALIGN(x)
900 901
#define FUSE_DIRENT_SIZE(d) \
	FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
T
Tejun Heo 已提交
902

903 904 905 906 907 908 909 910 911 912
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 已提交
913
struct fuse_notify_inval_inode_out {
914 915 916
	uint64_t	ino;
	int64_t		off;
	int64_t		len;
J
John Muir 已提交
917 918 919
};

struct fuse_notify_inval_entry_out {
920 921 922
	uint64_t	parent;
	uint32_t	namelen;
	uint32_t	padding;
J
John Muir 已提交
923 924
};

925
struct fuse_notify_delete_out {
926 927 928 929
	uint64_t	parent;
	uint64_t	child;
	uint32_t	namelen;
	uint32_t	padding;
930 931
};

M
Miklos Szeredi 已提交
932
struct fuse_notify_store_out {
933 934 935 936
	uint64_t	nodeid;
	uint64_t	offset;
	uint32_t	size;
	uint32_t	padding;
M
Miklos Szeredi 已提交
937 938
};

M
Miklos Szeredi 已提交
939
struct fuse_notify_retrieve_out {
940 941 942 943 944
	uint64_t	notify_unique;
	uint64_t	nodeid;
	uint64_t	offset;
	uint32_t	size;
	uint32_t	padding;
M
Miklos Szeredi 已提交
945 946 947 948
};

/* Matches the size of fuse_write_in */
struct fuse_notify_retrieve_in {
949 950 951 952 953 954
	uint64_t	dummy1;
	uint64_t	offset;
	uint32_t	size;
	uint32_t	dummy2;
	uint64_t	dummy3;
	uint64_t	dummy4;
M
Miklos Szeredi 已提交
955 956
};

M
Miklos Szeredi 已提交
957
/* Device ioctls: */
958 959
#define FUSE_DEV_IOC_MAGIC		229
#define FUSE_DEV_IOC_CLONE		_IOR(FUSE_DEV_IOC_MAGIC, 0, uint32_t)
M
Miklos Szeredi 已提交
960

961 962 963 964 965 966 967 968 969 970 971
struct fuse_lseek_in {
	uint64_t	fh;
	uint64_t	offset;
	uint32_t	whence;
	uint32_t	padding;
};

struct fuse_lseek_out {
	uint64_t	offset;
};

972 973 974 975 976 977 978 979 980 981
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;
};

982
#define FUSE_SETUPMAPPING_FLAG_WRITE (1ull << 0)
983
#define FUSE_SETUPMAPPING_FLAG_READ (1ull << 1)
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
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))

1012 1013 1014 1015
struct fuse_syncfs_in {
	uint64_t	padding;
};

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
/*
 * For each security context, send fuse_secctx with size of security context
 * fuse_secctx will be followed by security context name and this in turn
 * will be followed by actual context label.
 * fuse_secctx, name, context
 */
struct fuse_secctx {
	uint32_t	size;
	uint32_t	padding;
};

/*
 * Contains the information about how many fuse_secctx structures are being
 * sent and what's the total size of all security contexts (including
 * size of fuse_secctx_header).
 *
 */
struct fuse_secctx_header {
	uint32_t	size;
	uint32_t	nr_secctx;
};

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