fuse: set FUSE_WRITE_KILL_SUIDGID in cached write path
[linux-block.git] / include / uapi / linux / fuse.h
CommitLineData
e2be04c7 1/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */
d8a5ba45 2/*
7e98d530 3 This file defines the kernel interface of FUSE
1f55ed06 4 Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu>
d8a5ba45
MS
5
6 This program can be distributed under the terms of the GNU GPL.
7 See the file COPYING.
7e98d530
MS
8
9 This -- and only this -- header file may also be distributed under
10 the terms of the BSD Licence as follows:
11
12 Copyright (C) 2001-2007 Miklos Szeredi. All rights reserved.
13
14 Redistribution and use in source and binary forms, with or without
15 modification, are permitted provided that the following conditions
16 are met:
17 1. Redistributions of source code must retain the above copyright
18 notice, this list of conditions and the following disclaimer.
19 2. Redistributions in binary form must reproduce the above copyright
20 notice, this list of conditions and the following disclaimer in the
21 documentation and/or other materials provided with the distribution.
22
23 THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
27 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 SUCH DAMAGE.
d8a5ba45
MS
34*/
35
c79e322f
MS
36/*
37 * This file defines the kernel interface of FUSE
38 *
39 * Protocol changelog:
40 *
9de55a37
AS
41 * 7.1:
42 * - add the following messages:
43 * FUSE_SETATTR, FUSE_SYMLINK, FUSE_MKNOD, FUSE_MKDIR, FUSE_UNLINK,
44 * FUSE_RMDIR, FUSE_RENAME, FUSE_LINK, FUSE_OPEN, FUSE_READ, FUSE_WRITE,
45 * FUSE_RELEASE, FUSE_FSYNC, FUSE_FLUSH, FUSE_SETXATTR, FUSE_GETXATTR,
46 * FUSE_LISTXATTR, FUSE_REMOVEXATTR, FUSE_OPENDIR, FUSE_READDIR,
47 * FUSE_RELEASEDIR
48 * - add padding to messages to accommodate 32-bit servers on 64-bit kernels
49 *
50 * 7.2:
51 * - add FOPEN_DIRECT_IO and FOPEN_KEEP_CACHE flags
52 * - add FUSE_FSYNCDIR message
53 *
54 * 7.3:
55 * - add FUSE_ACCESS message
56 * - add FUSE_CREATE message
57 * - add filehandle to fuse_setattr_in
58 *
59 * 7.4:
60 * - add frsize to fuse_kstatfs
61 * - clean up request size limit checking
62 *
63 * 7.5:
64 * - add flags and max_write to fuse_init_out
65 *
66 * 7.6:
67 * - add max_readahead to fuse_init_in and fuse_init_out
68 *
69 * 7.7:
70 * - add FUSE_INTERRUPT message
71 * - add POSIX file lock support
72 *
73 * 7.8:
74 * - add lock_owner and flags fields to fuse_release_in
75 * - add FUSE_BMAP message
76 * - add FUSE_DESTROY message
77 *
c79e322f
MS
78 * 7.9:
79 * - new fuse_getattr_in input argument of GETATTR
a9ff4f87 80 * - add lk_flags in fuse_lk_in
f3332114 81 * - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
0e9663ee 82 * - add blksize field to fuse_attr
a6643094 83 * - add file flags field to fuse_read_in and fuse_write_in
7142fd1b 84 * - Add ATIME_NOW and MTIME_NOW flags to fuse_setattr_in
a7c1b990
TH
85 *
86 * 7.10
87 * - add nonseekable open flag
1f55ed06
MS
88 *
89 * 7.11
90 * - add IOCTL message
91 * - add unsolicited notification support
92 * - add POLL message and NOTIFY_POLL notification
e0a43ddc
MS
93 *
94 * 7.12
68065b84 95 * - add umask flag to input argument of create, mknod and mkdir
3b463ae0
JM
96 * - add notification messages for invalidation of inodes and
97 * directory entries
7a6d3c8b
CH
98 *
99 * 7.13
100 * - make max number of background requests and congestion threshold
101 * tunables
dd3bb14f
MS
102 *
103 * 7.14
104 * - add splice support to fuse device
a1d75f25
MS
105 *
106 * 7.15
107 * - add store notify
2d45ba38 108 * - add retrieve notify
02c048b9
MS
109 *
110 * 7.16
111 * - add BATCH_FORGET request
1baa26b2
MS
112 * - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
113 * fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
114 * - add FUSE_IOCTL_32BIT flag
37fb3a30
MS
115 *
116 * 7.17
117 * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
b18da0c5
MS
118 *
119 * 7.18
120 * - add FUSE_IOCTL_DIR flag
451d0f59 121 * - add FUSE_NOTIFY_DELETE
05ba1f08
AP
122 *
123 * 7.19
124 * - add FUSE_FALLOCATE
72d0d248
BF
125 *
126 * 7.20
127 * - add FUSE_AUTO_INVAL_DATA
23c153e5
MS
128 *
129 * 7.21
130 * - add FUSE_READDIRPLUS
0415d291 131 * - send the requested events in POLL request
60b9df7a
MS
132 *
133 * 7.22
134 * - add FUSE_ASYNC_DIO
4d99ff8f
PE
135 *
136 * 7.23
137 * - add FUSE_WRITEBACK_CACHE
e27c9d38
MS
138 * - add time_gran to fuse_init_out
139 * - add reserved space to fuse_init_out
ab9e13f7
MP
140 * - add FATTR_CTIME
141 * - add ctime and ctimensec to fuse_setattr_in
1560c974 142 * - add FUSE_RENAME2 request
d7afaec0 143 * - add FUSE_NO_OPEN_SUPPORT flag
0b5da8db
R
144 *
145 * 7.24
146 * - add FUSE_LSEEK for SEEK_HOLE and SEEK_DATA support
5c672ab3
MS
147 *
148 * 7.25
149 * - add FUSE_PARALLEL_DIROPS
5e940c1d
MS
150 *
151 * 7.26
152 * - add FUSE_HANDLE_KILLPRIV
60bcc88a 153 * - add FUSE_POSIX_ACL
3b7008b2
SL
154 *
155 * 7.27
156 * - add FUSE_ABORT_ERROR
88bc7d50
NV
157 *
158 * 7.28
159 * - add FUSE_COPY_FILE_RANGE
6433b899 160 * - add FOPEN_CACHE_DIR
5da784cc 161 * - add FUSE_MAX_PAGES, add max_pages to init_out
5571f1e6 162 * - add FUSE_CACHE_SYMLINKS
d9a9ea94
CA
163 *
164 * 7.29
165 * - add FUSE_NO_OPENDIR_SUPPORT flag
ad2ba64d
KS
166 *
167 * 7.30
168 * - add FUSE_EXPLICIT_INVAL_DATA
6407f44a 169 * - add FUSE_IOCTL_COMPAT_X32
4a2abf99
MS
170 *
171 * 7.31
172 * - add FUSE_WRITE_KILL_PRIV flag
c4bb667e
DDAG
173 * - add FUSE_SETUPMAPPING and FUSE_REMOVEMAPPING
174 * - add map_alignment to fuse_init_out, add FUSE_MAP_ALIGNMENT flag
c6ff213f
MR
175 *
176 * 7.32
177 * - add flags to fuse_attr, add FUSE_ATTR_SUBMOUNT, add FUSE_SUBMOUNTS
63f9909f
VG
178 *
179 * 7.33
10c52c84 180 * - add FUSE_HANDLE_KILLPRIV_V2, FUSE_WRITE_KILL_SUIDGID
c79e322f 181 */
d8a5ba45 182
29d434b3
TH
183#ifndef _LINUX_FUSE_H
184#define _LINUX_FUSE_H
185
4c82456e 186#ifdef __KERNEL__
1f55ed06 187#include <linux/types.h>
7e98d530
MS
188#else
189#include <stdint.h>
7e98d530 190#endif
d8a5ba45 191
37d217f0
MS
192/*
193 * Version negotiation:
194 *
195 * Both the kernel and userspace send the version they support in the
196 * INIT request and reply respectively.
197 *
198 * If the major versions match then both shall use the smallest
199 * of the two minor versions for communication.
200 *
201 * If the kernel supports a larger major version, then userspace shall
202 * reply with the major version it supports, ignore the rest of the
203 * INIT message and expect a new INIT message from the kernel with a
204 * matching major version.
205 *
206 * If the library supports a larger major version, then it shall fall
207 * back to the major protocol version sent by the kernel for
208 * communication and reply with that major version (and an arbitrary
209 * supported minor version).
210 */
211
d8a5ba45 212/** Version number of this interface */
9e6268db 213#define FUSE_KERNEL_VERSION 7
d8a5ba45
MS
214
215/** Minor version number of this interface */
63f9909f 216#define FUSE_KERNEL_MINOR_VERSION 33
d8a5ba45
MS
217
218/** The node ID of the root inode */
219#define FUSE_ROOT_ID 1
220
06663267
MS
221/* Make sure all structures are padded to 64bit boundary, so 32bit
222 userspace works under 64bit kernels */
223
d8a5ba45 224struct fuse_attr {
4c82456e
MS
225 uint64_t ino;
226 uint64_t size;
227 uint64_t blocks;
228 uint64_t atime;
229 uint64_t mtime;
230 uint64_t ctime;
231 uint32_t atimensec;
232 uint32_t mtimensec;
233 uint32_t ctimensec;
234 uint32_t mode;
235 uint32_t nlink;
236 uint32_t uid;
237 uint32_t gid;
238 uint32_t rdev;
239 uint32_t blksize;
c6ff213f 240 uint32_t flags;
d8a5ba45
MS
241};
242
e5e5558e 243struct fuse_kstatfs {
4c82456e
MS
244 uint64_t blocks;
245 uint64_t bfree;
246 uint64_t bavail;
247 uint64_t files;
248 uint64_t ffree;
249 uint32_t bsize;
250 uint32_t namelen;
251 uint32_t frsize;
252 uint32_t padding;
253 uint32_t spare[6];
e5e5558e
MS
254};
255
71421259 256struct fuse_file_lock {
4c82456e
MS
257 uint64_t start;
258 uint64_t end;
259 uint32_t type;
260 uint32_t pid; /* tgid */
71421259
MS
261};
262
9cd68455
MS
263/**
264 * Bitmasks for fuse_setattr_in.valid
265 */
9e6268db
MS
266#define FATTR_MODE (1 << 0)
267#define FATTR_UID (1 << 1)
268#define FATTR_GID (1 << 2)
269#define FATTR_SIZE (1 << 3)
270#define FATTR_ATIME (1 << 4)
271#define FATTR_MTIME (1 << 5)
befc649c 272#define FATTR_FH (1 << 6)
17637cba
MS
273#define FATTR_ATIME_NOW (1 << 7)
274#define FATTR_MTIME_NOW (1 << 8)
f3332114 275#define FATTR_LOCKOWNER (1 << 9)
ab9e13f7 276#define FATTR_CTIME (1 << 10)
9e6268db 277
45323fb7
MS
278/**
279 * Flags returned by the OPEN request
280 *
281 * FOPEN_DIRECT_IO: bypass page cache for this open file
282 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
a7c1b990 283 * FOPEN_NONSEEKABLE: the file is not seekable
6433b899 284 * FOPEN_CACHE_DIR: allow caching this directory
bbd84f33 285 * FOPEN_STREAM: the file is stream-like (no file position at all)
45323fb7
MS
286 */
287#define FOPEN_DIRECT_IO (1 << 0)
288#define FOPEN_KEEP_CACHE (1 << 1)
a7c1b990 289#define FOPEN_NONSEEKABLE (1 << 2)
6433b899 290#define FOPEN_CACHE_DIR (1 << 3)
bbd84f33 291#define FOPEN_STREAM (1 << 4)
45323fb7 292
9cd68455
MS
293/**
294 * INIT request/reply flags
33670fa2 295 *
f3840dc0 296 * FUSE_ASYNC_READ: asynchronous read requests
37fb3a30 297 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
f3840dc0
MS
298 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
299 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
33670fa2 300 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
f3840dc0 301 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
e0a43ddc 302 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
69fe05c9
MS
303 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
304 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
305 * FUSE_SPLICE_READ: kernel supports splice read on the device
37fb3a30 306 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
69fe05c9 307 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
72d0d248 308 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
634734b6
EW
309 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
310 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
60b9df7a 311 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
4d99ff8f 312 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
d7afaec0 313 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
5c672ab3 314 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
5e940c1d 315 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
60bcc88a 316 * FUSE_POSIX_ACL: filesystem supports posix acls
3b7008b2 317 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED
5da784cc 318 * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages
5571f1e6 319 * FUSE_CACHE_SYMLINKS: cache READLINK responses
d9a9ea94 320 * FUSE_NO_OPENDIR_SUPPORT: kernel supports zero-message opendir
ad2ba64d 321 * FUSE_EXPLICIT_INVAL_DATA: only invalidate cached pages on explicit request
fd1a1dc6
SH
322 * FUSE_MAP_ALIGNMENT: init_out.map_alignment contains log2(byte alignment) for
323 * foffset and moffset fields in struct
324 * fuse_setupmapping_out and fuse_removemapping_one.
c6ff213f 325 * FUSE_SUBMOUNTS: kernel supports auto-mounting directory submounts
63f9909f
VG
326 * FUSE_HANDLE_KILLPRIV_V2: fs kills suid/sgid/cap on write/chown/trunc.
327 * Upon write/truncate suid/sgid is only killed if caller
328 * does not have CAP_FSETID. Additionally upon
329 * write/truncate sgid is killed only if file has group
330 * execute permission. (Same as Linux VFS behavior).
9cd68455
MS
331 */
332#define FUSE_ASYNC_READ (1 << 0)
71421259 333#define FUSE_POSIX_LOCKS (1 << 1)
c79e322f 334#define FUSE_FILE_OPS (1 << 2)
6ff958ed 335#define FUSE_ATOMIC_O_TRUNC (1 << 3)
33670fa2 336#define FUSE_EXPORT_SUPPORT (1 << 4)
78bb6cb9 337#define FUSE_BIG_WRITES (1 << 5)
e0a43ddc 338#define FUSE_DONT_MASK (1 << 6)
69fe05c9
MS
339#define FUSE_SPLICE_WRITE (1 << 7)
340#define FUSE_SPLICE_MOVE (1 << 8)
341#define FUSE_SPLICE_READ (1 << 9)
37fb3a30 342#define FUSE_FLOCK_LOCKS (1 << 10)
69fe05c9 343#define FUSE_HAS_IOCTL_DIR (1 << 11)
72d0d248 344#define FUSE_AUTO_INVAL_DATA (1 << 12)
0b05b183 345#define FUSE_DO_READDIRPLUS (1 << 13)
634734b6 346#define FUSE_READDIRPLUS_AUTO (1 << 14)
60b9df7a 347#define FUSE_ASYNC_DIO (1 << 15)
4d99ff8f 348#define FUSE_WRITEBACK_CACHE (1 << 16)
d7afaec0 349#define FUSE_NO_OPEN_SUPPORT (1 << 17)
5c672ab3 350#define FUSE_PARALLEL_DIROPS (1 << 18)
5e940c1d 351#define FUSE_HANDLE_KILLPRIV (1 << 19)
60bcc88a 352#define FUSE_POSIX_ACL (1 << 20)
3b7008b2 353#define FUSE_ABORT_ERROR (1 << 21)
5da784cc 354#define FUSE_MAX_PAGES (1 << 22)
5571f1e6 355#define FUSE_CACHE_SYMLINKS (1 << 23)
d9a9ea94 356#define FUSE_NO_OPENDIR_SUPPORT (1 << 24)
ad2ba64d 357#define FUSE_EXPLICIT_INVAL_DATA (1 << 25)
c4bb667e 358#define FUSE_MAP_ALIGNMENT (1 << 26)
c6ff213f 359#define FUSE_SUBMOUNTS (1 << 27)
63f9909f 360#define FUSE_HANDLE_KILLPRIV_V2 (1 << 28)
9cd68455 361
151060ac
TH
362/**
363 * CUSE INIT request/reply flags
364 *
365 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
366 */
367#define CUSE_UNRESTRICTED_IOCTL (1 << 0)
368
e9168c18
MS
369/**
370 * Release flags
371 */
372#define FUSE_RELEASE_FLUSH (1 << 0)
37fb3a30 373#define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
e9168c18 374
c79e322f
MS
375/**
376 * Getattr flags
377 */
378#define FUSE_GETATTR_FH (1 << 0)
379
a9ff4f87
MS
380/**
381 * Lock flags
382 */
383#define FUSE_LK_FLOCK (1 << 0)
384
b25e82e5
MS
385/**
386 * WRITE flags
387 *
388 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
f3332114 389 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
10c52c84 390 * FUSE_WRITE_KILL_SUIDGID: kill suid and sgid bits
b25e82e5
MS
391 */
392#define FUSE_WRITE_CACHE (1 << 0)
f3332114 393#define FUSE_WRITE_LOCKOWNER (1 << 1)
10c52c84
MS
394#define FUSE_WRITE_KILL_SUIDGID (1 << 2)
395
396/* Obsolete alias; this flag implies killing suid/sgid only. */
397#define FUSE_WRITE_KILL_PRIV FUSE_WRITE_KILL_SUIDGID
f3332114
MS
398
399/**
400 * Read flags
401 */
402#define FUSE_READ_LOCKOWNER (1 << 1)
b25e82e5 403
59efec7b
TH
404/**
405 * Ioctl flags
406 *
407 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
408 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
409 * FUSE_IOCTL_RETRY: retry with new iovecs
1baa26b2 410 * FUSE_IOCTL_32BIT: 32bit ioctl
b18da0c5 411 * FUSE_IOCTL_DIR: is a directory
6407f44a 412 * FUSE_IOCTL_COMPAT_X32: x32 compat ioctl on 64bit machine (64bit time_t)
59efec7b
TH
413 *
414 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
415 */
416#define FUSE_IOCTL_COMPAT (1 << 0)
417#define FUSE_IOCTL_UNRESTRICTED (1 << 1)
418#define FUSE_IOCTL_RETRY (1 << 2)
1baa26b2 419#define FUSE_IOCTL_32BIT (1 << 3)
b18da0c5 420#define FUSE_IOCTL_DIR (1 << 4)
6407f44a 421#define FUSE_IOCTL_COMPAT_X32 (1 << 5)
59efec7b
TH
422
423#define FUSE_IOCTL_MAX_IOV 256
424
95668a69
TH
425/**
426 * Poll flags
427 *
428 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
429 */
430#define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
431
154603fe
AS
432/**
433 * Fsync flags
434 *
435 * FUSE_FSYNC_FDATASYNC: Sync data only, not metadata
436 */
437#define FUSE_FSYNC_FDATASYNC (1 << 0)
438
c6ff213f
MR
439/**
440 * fuse_attr flags
441 *
442 * FUSE_ATTR_SUBMOUNT: Object is a submount root
443 */
444#define FUSE_ATTR_SUBMOUNT (1 << 0)
445
334f485d 446enum fuse_opcode {
88bc7d50
NV
447 FUSE_LOOKUP = 1,
448 FUSE_FORGET = 2, /* no reply */
449 FUSE_GETATTR = 3,
450 FUSE_SETATTR = 4,
451 FUSE_READLINK = 5,
452 FUSE_SYMLINK = 6,
453 FUSE_MKNOD = 8,
454 FUSE_MKDIR = 9,
455 FUSE_UNLINK = 10,
456 FUSE_RMDIR = 11,
457 FUSE_RENAME = 12,
458 FUSE_LINK = 13,
459 FUSE_OPEN = 14,
460 FUSE_READ = 15,
461 FUSE_WRITE = 16,
462 FUSE_STATFS = 17,
463 FUSE_RELEASE = 18,
464 FUSE_FSYNC = 20,
465 FUSE_SETXATTR = 21,
466 FUSE_GETXATTR = 22,
467 FUSE_LISTXATTR = 23,
468 FUSE_REMOVEXATTR = 24,
469 FUSE_FLUSH = 25,
470 FUSE_INIT = 26,
471 FUSE_OPENDIR = 27,
472 FUSE_READDIR = 28,
473 FUSE_RELEASEDIR = 29,
474 FUSE_FSYNCDIR = 30,
475 FUSE_GETLK = 31,
476 FUSE_SETLK = 32,
477 FUSE_SETLKW = 33,
478 FUSE_ACCESS = 34,
479 FUSE_CREATE = 35,
480 FUSE_INTERRUPT = 36,
481 FUSE_BMAP = 37,
482 FUSE_DESTROY = 38,
483 FUSE_IOCTL = 39,
484 FUSE_POLL = 40,
485 FUSE_NOTIFY_REPLY = 41,
486 FUSE_BATCH_FORGET = 42,
487 FUSE_FALLOCATE = 43,
488 FUSE_READDIRPLUS = 44,
489 FUSE_RENAME2 = 45,
490 FUSE_LSEEK = 46,
491 FUSE_COPY_FILE_RANGE = 47,
c4bb667e
DDAG
492 FUSE_SETUPMAPPING = 48,
493 FUSE_REMOVEMAPPING = 49,
151060ac
TH
494
495 /* CUSE specific operations */
88bc7d50 496 CUSE_INIT = 4096,
501ae8ec
MT
497
498 /* Reserved opcodes: helpful to detect structure endian-ness */
499 CUSE_INIT_BSWAP_RESERVED = 1048576, /* CUSE_INIT << 8 */
500 FUSE_INIT_BSWAP_RESERVED = 436207616, /* FUSE_INIT << 24 */
334f485d
MS
501};
502
8599396b 503enum fuse_notify_code {
95668a69 504 FUSE_NOTIFY_POLL = 1,
3b463ae0
JM
505 FUSE_NOTIFY_INVAL_INODE = 2,
506 FUSE_NOTIFY_INVAL_ENTRY = 3,
a1d75f25 507 FUSE_NOTIFY_STORE = 4,
2d45ba38 508 FUSE_NOTIFY_RETRIEVE = 5,
451d0f59 509 FUSE_NOTIFY_DELETE = 6,
8599396b
TH
510 FUSE_NOTIFY_CODE_MAX,
511};
512
1d3d752b
MS
513/* The read buffer is required to be at least 8k, but may be much larger */
514#define FUSE_MIN_READ_BUFFER 8192
e5e5558e 515
0e9663ee
MS
516#define FUSE_COMPAT_ENTRY_OUT_SIZE 120
517
e5e5558e 518struct fuse_entry_out {
4c82456e
MS
519 uint64_t nodeid; /* Inode ID */
520 uint64_t generation; /* Inode generation: nodeid:gen must
521 be unique for the fs's lifetime */
522 uint64_t entry_valid; /* Cache timeout for the name */
523 uint64_t attr_valid; /* Cache timeout for the attributes */
524 uint32_t entry_valid_nsec;
525 uint32_t attr_valid_nsec;
e5e5558e
MS
526 struct fuse_attr attr;
527};
528
529struct fuse_forget_in {
4c82456e 530 uint64_t nlookup;
e5e5558e
MS
531};
532
02c048b9 533struct fuse_forget_one {
4c82456e
MS
534 uint64_t nodeid;
535 uint64_t nlookup;
02c048b9
MS
536};
537
538struct fuse_batch_forget_in {
4c82456e
MS
539 uint32_t count;
540 uint32_t dummy;
02c048b9
MS
541};
542
c79e322f 543struct fuse_getattr_in {
4c82456e
MS
544 uint32_t getattr_flags;
545 uint32_t dummy;
546 uint64_t fh;
c79e322f
MS
547};
548
0e9663ee
MS
549#define FUSE_COMPAT_ATTR_OUT_SIZE 96
550
e5e5558e 551struct fuse_attr_out {
4c82456e
MS
552 uint64_t attr_valid; /* Cache timeout for the attributes */
553 uint32_t attr_valid_nsec;
554 uint32_t dummy;
e5e5558e
MS
555 struct fuse_attr attr;
556};
557
e0a43ddc
MS
558#define FUSE_COMPAT_MKNOD_IN_SIZE 8
559
9e6268db 560struct fuse_mknod_in {
4c82456e
MS
561 uint32_t mode;
562 uint32_t rdev;
563 uint32_t umask;
564 uint32_t padding;
9e6268db
MS
565};
566
567struct fuse_mkdir_in {
4c82456e
MS
568 uint32_t mode;
569 uint32_t umask;
9e6268db
MS
570};
571
572struct fuse_rename_in {
4c82456e 573 uint64_t newdir;
9e6268db
MS
574};
575
1560c974
MS
576struct fuse_rename2_in {
577 uint64_t newdir;
578 uint32_t flags;
579 uint32_t padding;
580};
581
9e6268db 582struct fuse_link_in {
4c82456e 583 uint64_t oldnodeid;
9e6268db
MS
584};
585
586struct fuse_setattr_in {
4c82456e
MS
587 uint32_t valid;
588 uint32_t padding;
589 uint64_t fh;
590 uint64_t size;
591 uint64_t lock_owner;
592 uint64_t atime;
593 uint64_t mtime;
ab9e13f7 594 uint64_t ctime;
4c82456e
MS
595 uint32_t atimensec;
596 uint32_t mtimensec;
ab9e13f7 597 uint32_t ctimensec;
4c82456e
MS
598 uint32_t mode;
599 uint32_t unused4;
600 uint32_t uid;
601 uint32_t gid;
602 uint32_t unused5;
9e6268db
MS
603};
604
b6aeaded 605struct fuse_open_in {
4c82456e
MS
606 uint32_t flags;
607 uint32_t unused;
e0a43ddc
MS
608};
609
610struct fuse_create_in {
4c82456e
MS
611 uint32_t flags;
612 uint32_t mode;
613 uint32_t umask;
614 uint32_t padding;
b6aeaded
MS
615};
616
617struct fuse_open_out {
4c82456e
MS
618 uint64_t fh;
619 uint32_t open_flags;
620 uint32_t padding;
b6aeaded
MS
621};
622
623struct fuse_release_in {
4c82456e
MS
624 uint64_t fh;
625 uint32_t flags;
626 uint32_t release_flags;
627 uint64_t lock_owner;
b6aeaded
MS
628};
629
630struct fuse_flush_in {
4c82456e
MS
631 uint64_t fh;
632 uint32_t unused;
633 uint32_t padding;
634 uint64_t lock_owner;
b6aeaded
MS
635};
636
637struct fuse_read_in {
4c82456e
MS
638 uint64_t fh;
639 uint64_t offset;
640 uint32_t size;
641 uint32_t read_flags;
642 uint64_t lock_owner;
643 uint32_t flags;
644 uint32_t padding;
b6aeaded
MS
645};
646
f3332114
MS
647#define FUSE_COMPAT_WRITE_IN_SIZE 24
648
b6aeaded 649struct fuse_write_in {
4c82456e
MS
650 uint64_t fh;
651 uint64_t offset;
652 uint32_t size;
653 uint32_t write_flags;
654 uint64_t lock_owner;
655 uint32_t flags;
656 uint32_t padding;
b6aeaded
MS
657};
658
659struct fuse_write_out {
4c82456e
MS
660 uint32_t size;
661 uint32_t padding;
b6aeaded
MS
662};
663
de5f1202
MS
664#define FUSE_COMPAT_STATFS_SIZE 48
665
e5e5558e
MS
666struct fuse_statfs_out {
667 struct fuse_kstatfs st;
668};
669
b6aeaded 670struct fuse_fsync_in {
4c82456e
MS
671 uint64_t fh;
672 uint32_t fsync_flags;
673 uint32_t padding;
b6aeaded
MS
674};
675
92a8780e 676struct fuse_setxattr_in {
4c82456e
MS
677 uint32_t size;
678 uint32_t flags;
92a8780e
MS
679};
680
681struct fuse_getxattr_in {
4c82456e
MS
682 uint32_t size;
683 uint32_t padding;
92a8780e
MS
684};
685
686struct fuse_getxattr_out {
4c82456e
MS
687 uint32_t size;
688 uint32_t padding;
92a8780e
MS
689};
690
71421259 691struct fuse_lk_in {
4c82456e
MS
692 uint64_t fh;
693 uint64_t owner;
71421259 694 struct fuse_file_lock lk;
4c82456e
MS
695 uint32_t lk_flags;
696 uint32_t padding;
71421259
MS
697};
698
699struct fuse_lk_out {
700 struct fuse_file_lock lk;
701};
702
31d40d74 703struct fuse_access_in {
4c82456e
MS
704 uint32_t mask;
705 uint32_t padding;
31d40d74
MS
706};
707
3ec870d5 708struct fuse_init_in {
4c82456e
MS
709 uint32_t major;
710 uint32_t minor;
711 uint32_t max_readahead;
712 uint32_t flags;
334f485d
MS
713};
714
e27c9d38
MS
715#define FUSE_COMPAT_INIT_OUT_SIZE 8
716#define FUSE_COMPAT_22_INIT_OUT_SIZE 24
717
3ec870d5 718struct fuse_init_out {
4c82456e
MS
719 uint32_t major;
720 uint32_t minor;
721 uint32_t max_readahead;
722 uint32_t flags;
723 uint16_t max_background;
724 uint16_t congestion_threshold;
725 uint32_t max_write;
e27c9d38 726 uint32_t time_gran;
5da784cc 727 uint16_t max_pages;
c4bb667e 728 uint16_t map_alignment;
5da784cc 729 uint32_t unused[8];
3ec870d5
MS
730};
731
151060ac
TH
732#define CUSE_INIT_INFO_MAX 4096
733
734struct cuse_init_in {
4c82456e
MS
735 uint32_t major;
736 uint32_t minor;
737 uint32_t unused;
738 uint32_t flags;
151060ac
TH
739};
740
741struct cuse_init_out {
4c82456e
MS
742 uint32_t major;
743 uint32_t minor;
744 uint32_t unused;
745 uint32_t flags;
746 uint32_t max_read;
747 uint32_t max_write;
748 uint32_t dev_major; /* chardev major */
749 uint32_t dev_minor; /* chardev minor */
750 uint32_t spare[10];
151060ac
TH
751};
752
a4d27e75 753struct fuse_interrupt_in {
4c82456e 754 uint64_t unique;
a4d27e75
MS
755};
756
b2d2272f 757struct fuse_bmap_in {
4c82456e
MS
758 uint64_t block;
759 uint32_t blocksize;
760 uint32_t padding;
b2d2272f
MS
761};
762
763struct fuse_bmap_out {
4c82456e 764 uint64_t block;
b2d2272f
MS
765};
766
59efec7b 767struct fuse_ioctl_in {
4c82456e
MS
768 uint64_t fh;
769 uint32_t flags;
770 uint32_t cmd;
771 uint64_t arg;
772 uint32_t in_size;
773 uint32_t out_size;
59efec7b
TH
774};
775
1baa26b2 776struct fuse_ioctl_iovec {
4c82456e
MS
777 uint64_t base;
778 uint64_t len;
1baa26b2
MS
779};
780
59efec7b 781struct fuse_ioctl_out {
4c82456e
MS
782 int32_t result;
783 uint32_t flags;
784 uint32_t in_iovs;
785 uint32_t out_iovs;
59efec7b
TH
786};
787
95668a69 788struct fuse_poll_in {
4c82456e
MS
789 uint64_t fh;
790 uint64_t kh;
791 uint32_t flags;
792 uint32_t events;
95668a69
TH
793};
794
795struct fuse_poll_out {
4c82456e
MS
796 uint32_t revents;
797 uint32_t padding;
95668a69
TH
798};
799
800struct fuse_notify_poll_wakeup_out {
4c82456e 801 uint64_t kh;
95668a69
TH
802};
803
05ba1f08 804struct fuse_fallocate_in {
4c82456e
MS
805 uint64_t fh;
806 uint64_t offset;
807 uint64_t length;
808 uint32_t mode;
809 uint32_t padding;
05ba1f08
AP
810};
811
334f485d 812struct fuse_in_header {
4c82456e
MS
813 uint32_t len;
814 uint32_t opcode;
815 uint64_t unique;
816 uint64_t nodeid;
817 uint32_t uid;
818 uint32_t gid;
819 uint32_t pid;
820 uint32_t padding;
334f485d
MS
821};
822
823struct fuse_out_header {
4c82456e
MS
824 uint32_t len;
825 int32_t error;
826 uint64_t unique;
334f485d
MS
827};
828
e5e5558e 829struct fuse_dirent {
4c82456e
MS
830 uint64_t ino;
831 uint64_t off;
832 uint32_t namelen;
833 uint32_t type;
c628ee67 834 char name[];
e5e5558e
MS
835};
836
21f3da95 837#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
4c82456e
MS
838#define FUSE_DIRENT_ALIGN(x) \
839 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
e5e5558e
MS
840#define FUSE_DIRENT_SIZE(d) \
841 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
29d434b3 842
0b05b183
AA
843struct fuse_direntplus {
844 struct fuse_entry_out entry_out;
845 struct fuse_dirent dirent;
846};
847
848#define FUSE_NAME_OFFSET_DIRENTPLUS \
849 offsetof(struct fuse_direntplus, dirent.name)
850#define FUSE_DIRENTPLUS_SIZE(d) \
851 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
852
3b463ae0 853struct fuse_notify_inval_inode_out {
4c82456e
MS
854 uint64_t ino;
855 int64_t off;
856 int64_t len;
3b463ae0
JM
857};
858
859struct fuse_notify_inval_entry_out {
4c82456e
MS
860 uint64_t parent;
861 uint32_t namelen;
862 uint32_t padding;
3b463ae0
JM
863};
864
451d0f59 865struct fuse_notify_delete_out {
4c82456e
MS
866 uint64_t parent;
867 uint64_t child;
868 uint32_t namelen;
869 uint32_t padding;
451d0f59
JM
870};
871
a1d75f25 872struct fuse_notify_store_out {
4c82456e
MS
873 uint64_t nodeid;
874 uint64_t offset;
875 uint32_t size;
876 uint32_t padding;
a1d75f25
MS
877};
878
2d45ba38 879struct fuse_notify_retrieve_out {
4c82456e
MS
880 uint64_t notify_unique;
881 uint64_t nodeid;
882 uint64_t offset;
883 uint32_t size;
884 uint32_t padding;
2d45ba38
MS
885};
886
887/* Matches the size of fuse_write_in */
888struct fuse_notify_retrieve_in {
4c82456e
MS
889 uint64_t dummy1;
890 uint64_t offset;
891 uint32_t size;
892 uint32_t dummy2;
893 uint64_t dummy3;
894 uint64_t dummy4;
2d45ba38
MS
895};
896
00c570f4
MS
897/* Device ioctls: */
898#define FUSE_DEV_IOC_CLONE _IOR(229, 0, uint32_t)
899
0b5da8db
R
900struct fuse_lseek_in {
901 uint64_t fh;
902 uint64_t offset;
903 uint32_t whence;
904 uint32_t padding;
905};
906
907struct fuse_lseek_out {
908 uint64_t offset;
909};
910
88bc7d50
NV
911struct fuse_copy_file_range_in {
912 uint64_t fh_in;
913 uint64_t off_in;
914 uint64_t nodeid_out;
915 uint64_t fh_out;
916 uint64_t off_out;
917 uint64_t len;
918 uint64_t flags;
919};
920
ceec02d4 921#define FUSE_SETUPMAPPING_FLAG_WRITE (1ull << 0)
c2d0ad00 922#define FUSE_SETUPMAPPING_FLAG_READ (1ull << 1)
ceec02d4
VG
923struct fuse_setupmapping_in {
924 /* An already open handle */
925 uint64_t fh;
926 /* Offset into the file to start the mapping */
927 uint64_t foffset;
928 /* Length of mapping required */
929 uint64_t len;
930 /* Flags, FUSE_SETUPMAPPING_FLAG_* */
931 uint64_t flags;
932 /* Offset in Memory Window */
933 uint64_t moffset;
934};
935
936struct fuse_removemapping_in {
937 /* number of fuse_removemapping_one follows */
938 uint32_t count;
939};
940
941struct fuse_removemapping_one {
942 /* Offset into the dax window start the unmapping */
943 uint64_t moffset;
944 /* Length of mapping required */
945 uint64_t len;
946};
947
948#define FUSE_REMOVEMAPPING_MAX_ENTRY \
949 (PAGE_SIZE / sizeof(struct fuse_removemapping_one))
950
29d434b3 951#endif /* _LINUX_FUSE_H */