1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */ 2 /* 3 This file defines the kernel interface of FUSE 4 Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu> 5 6 This program can be distributed under the terms of the GNU GPL. 7 See the file COPYING. 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. 34 */ 35 36 /* 37 * This file defines the kernel interface of FUSE 38 * 39 * Protocol changelog: 40 * 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 * 78 * 7.9: 79 * - 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 85 * 86 * 7.10 87 * - add nonseekable open flag 88 * 89 * 7.11 90 * - add IOCTL message 91 * - add unsolicited notification support 92 * - add POLL message and NOTIFY_POLL notification 93 * 94 * 7.12 95 * - add umask flag to input argument of create, mknod and mkdir 96 * - add notification messages for invalidation of inodes and 97 * directory entries 98 * 99 * 7.13 100 * - make max number of background requests and congestion threshold 101 * tunables 102 * 103 * 7.14 104 * - add splice support to fuse device 105 * 106 * 7.15 107 * - add store notify 108 * - add retrieve notify 109 * 110 * 7.16 111 * - add BATCH_FORGET request 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 115 * 116 * 7.17 117 * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK 118 * 119 * 7.18 120 * - add FUSE_IOCTL_DIR flag 121 * - add FUSE_NOTIFY_DELETE 122 * 123 * 7.19 124 * - add FUSE_FALLOCATE 125 * 126 * 7.20 127 * - add FUSE_AUTO_INVAL_DATA 128 * 129 * 7.21 130 * - add FUSE_READDIRPLUS 131 * - send the requested events in POLL request 132 * 133 * 7.22 134 * - add FUSE_ASYNC_DIO 135 * 136 * 7.23 137 * - add FUSE_WRITEBACK_CACHE 138 * - add time_gran to fuse_init_out 139 * - add reserved space to fuse_init_out 140 * - add FATTR_CTIME 141 * - add ctime and ctimensec to fuse_setattr_in 142 * - add FUSE_RENAME2 request 143 * - add FUSE_NO_OPEN_SUPPORT flag 144 * 145 * 7.24 146 * - add FUSE_LSEEK for SEEK_HOLE and SEEK_DATA support 147 * 148 * 7.25 149 * - add FUSE_PARALLEL_DIROPS 150 * 151 * 7.26 152 * - add FUSE_HANDLE_KILLPRIV 153 * - add FUSE_POSIX_ACL 154 * 155 * 7.27 156 * - add FUSE_ABORT_ERROR 157 * 158 * 7.28 159 * - add FUSE_COPY_FILE_RANGE 160 * - add FOPEN_CACHE_DIR 161 * - add FUSE_MAX_PAGES, add max_pages to init_out 162 * - add FUSE_CACHE_SYMLINKS 163 * 164 * 7.29 165 * - add FUSE_NO_OPENDIR_SUPPORT flag 166 * 167 * 7.30 168 * - add FUSE_EXPLICIT_INVAL_DATA 169 * - add FUSE_IOCTL_COMPAT_X32 170 * 171 * 7.31 172 * - add FUSE_WRITE_KILL_PRIV flag 173 * - add FUSE_SETUPMAPPING and FUSE_REMOVEMAPPING 174 * - add map_alignment to fuse_init_out, add FUSE_MAP_ALIGNMENT flag 175 * 176 * 7.32 177 * - 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 182 * - extend fuse_setxattr_in, add FUSE_SETXATTR_EXT 183 * - add FUSE_SETXATTR_ACL_KILL_SGID 184 * 185 * 7.34 186 * - add FUSE_SYNCFS 187 * 188 * 7.35 189 * - add FOPEN_NOFLUSH 190 * 191 * 7.36 192 * - extend fuse_init_in with reserved fields, add FUSE_INIT_EXT init flag 193 * - add flags2 to fuse_init_in and fuse_init_out 194 * - add FUSE_SECURITY_CTX init flag 195 * - add security context to create, mkdir, symlink, and mknod requests 196 * - add FUSE_HAS_INODE_DAX, FUSE_ATTR_DAX 197 * 198 * 7.37 199 * - add FUSE_TMPFILE 200 * 201 * 7.38 202 * - add FUSE_EXPIRE_ONLY flag to fuse_notify_inval_entry 203 * - add FOPEN_PARALLEL_DIRECT_WRITES 204 * - add total_extlen to fuse_in_header 205 * - add FUSE_MAX_NR_SECCTX 206 * - add extension header 207 * - add FUSE_EXT_GROUPS 208 * - add FUSE_CREATE_SUPP_GROUP 209 * - add FUSE_HAS_EXPIRE_ONLY 210 * 211 * 7.39 212 * - add FUSE_DIRECT_IO_ALLOW_MMAP 213 * - add FUSE_STATX and related structures 214 * 215 * 7.40 216 * - add max_stack_depth to fuse_init_out, add FUSE_PASSTHROUGH init flag 217 * - add backing_id to fuse_open_out, add FOPEN_PASSTHROUGH open flag 218 * - add FUSE_NO_EXPORT_SUPPORT init flag 219 * - add FUSE_NOTIFY_RESEND, add FUSE_HAS_RESEND init flag 220 * 221 * 7.41 222 * - add FUSE_ALLOW_IDMAP 223 * 7.42 224 * - Add FUSE_OVER_IO_URING and all other io-uring related flags and data 225 * structures: 226 * - struct fuse_uring_ent_in_out 227 * - struct fuse_uring_req_header 228 * - struct fuse_uring_cmd_req 229 * - FUSE_URING_IN_OUT_HEADER_SZ 230 * - FUSE_URING_OP_IN_OUT_SZ 231 * - enum fuse_uring_cmd 232 * 233 * 7.43 234 * - add FUSE_REQUEST_TIMEOUT 235 */ 236 237 #ifndef _LINUX_FUSE_H 238 #define _LINUX_FUSE_H 239 240 #include <stdint.h> 241 242 /* 243 * Version negotiation: 244 * 245 * Both the kernel and userspace send the version they support in the 246 * INIT request and reply respectively. 247 * 248 * If the major versions match then both shall use the smallest 249 * of the two minor versions for communication. 250 * 251 * If the kernel supports a larger major version, then userspace shall 252 * reply with the major version it supports, ignore the rest of the 253 * INIT message and expect a new INIT message from the kernel with a 254 * matching major version. 255 * 256 * If the library supports a larger major version, then it shall fall 257 * back to the major protocol version sent by the kernel for 258 * communication and reply with that major version (and an arbitrary 259 * supported minor version). 260 */ 261 262 /** Version number of this interface */ 263 #define FUSE_KERNEL_VERSION 7 264 265 /** Minor version number of this interface */ 266 #define FUSE_KERNEL_MINOR_VERSION 43 267 268 /** The node ID of the root inode */ 269 #define FUSE_ROOT_ID 1 270 271 /* Make sure all structures are padded to 64bit boundary, so 32bit 272 userspace works under 64bit kernels */ 273 274 struct fuse_attr { 275 uint64_t ino; 276 uint64_t size; 277 uint64_t blocks; 278 uint64_t atime; 279 uint64_t mtime; 280 uint64_t ctime; 281 uint32_t atimensec; 282 uint32_t mtimensec; 283 uint32_t ctimensec; 284 uint32_t mode; 285 uint32_t nlink; 286 uint32_t uid; 287 uint32_t gid; 288 uint32_t rdev; 289 uint32_t blksize; 290 uint32_t flags; 291 }; 292 293 /* 294 * The following structures are bit-for-bit compatible with the statx(2) ABI in 295 * Linux. 296 */ 297 struct fuse_sx_time { 298 int64_t tv_sec; 299 uint32_t tv_nsec; 300 int32_t __reserved; 301 }; 302 303 struct fuse_statx { 304 uint32_t mask; 305 uint32_t blksize; 306 uint64_t attributes; 307 uint32_t nlink; 308 uint32_t uid; 309 uint32_t gid; 310 uint16_t mode; 311 uint16_t __spare0[1]; 312 uint64_t ino; 313 uint64_t size; 314 uint64_t blocks; 315 uint64_t attributes_mask; 316 struct fuse_sx_time atime; 317 struct fuse_sx_time btime; 318 struct fuse_sx_time ctime; 319 struct fuse_sx_time mtime; 320 uint32_t rdev_major; 321 uint32_t rdev_minor; 322 uint32_t dev_major; 323 uint32_t dev_minor; 324 uint64_t __spare2[14]; 325 }; 326 327 struct fuse_kstatfs { 328 uint64_t blocks; 329 uint64_t bfree; 330 uint64_t bavail; 331 uint64_t files; 332 uint64_t ffree; 333 uint32_t bsize; 334 uint32_t namelen; 335 uint32_t frsize; 336 uint32_t padding; 337 uint32_t spare[6]; 338 }; 339 340 struct fuse_file_lock { 341 uint64_t start; 342 uint64_t end; 343 uint32_t type; 344 uint32_t pid; /* tgid */ 345 }; 346 347 /** 348 * Bitmasks for fuse_setattr_in.valid 349 */ 350 #define FATTR_MODE (1 << 0) 351 #define FATTR_UID (1 << 1) 352 #define FATTR_GID (1 << 2) 353 #define FATTR_SIZE (1 << 3) 354 #define FATTR_ATIME (1 << 4) 355 #define FATTR_MTIME (1 << 5) 356 #define FATTR_FH (1 << 6) 357 #define FATTR_ATIME_NOW (1 << 7) 358 #define FATTR_MTIME_NOW (1 << 8) 359 #define FATTR_LOCKOWNER (1 << 9) 360 #define FATTR_CTIME (1 << 10) 361 #define FATTR_KILL_SUIDGID (1 << 11) 362 363 /** 364 * Flags returned by the OPEN request 365 * 366 * FOPEN_DIRECT_IO: bypass page cache for this open file 367 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open 368 * FOPEN_NONSEEKABLE: the file is not seekable 369 * FOPEN_CACHE_DIR: allow caching this directory 370 * FOPEN_STREAM: the file is stream-like (no file position at all) 371 * FOPEN_NOFLUSH: don't flush data cache on close (unless FUSE_WRITEBACK_CACHE) 372 * FOPEN_PARALLEL_DIRECT_WRITES: Allow concurrent direct writes on the same inode 373 * FOPEN_PASSTHROUGH: passthrough read/write io for this open file 374 */ 375 #define FOPEN_DIRECT_IO (1 << 0) 376 #define FOPEN_KEEP_CACHE (1 << 1) 377 #define FOPEN_NONSEEKABLE (1 << 2) 378 #define FOPEN_CACHE_DIR (1 << 3) 379 #define FOPEN_STREAM (1 << 4) 380 #define FOPEN_NOFLUSH (1 << 5) 381 #define FOPEN_PARALLEL_DIRECT_WRITES (1 << 6) 382 #define FOPEN_PASSTHROUGH (1 << 7) 383 384 /** 385 * INIT request/reply flags 386 * 387 * FUSE_ASYNC_READ: asynchronous read requests 388 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks 389 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported) 390 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem 391 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".." 392 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB 393 * FUSE_DONT_MASK: don't apply umask to file mode on create operations 394 * FUSE_SPLICE_WRITE: kernel supports splice write on the device 395 * FUSE_SPLICE_MOVE: kernel supports splice move on the device 396 * FUSE_SPLICE_READ: kernel supports splice read on the device 397 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks 398 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories 399 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages 400 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one) 401 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus 402 * FUSE_ASYNC_DIO: asynchronous direct I/O submission 403 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes 404 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens 405 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir 406 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc 407 * FUSE_POSIX_ACL: filesystem supports posix acls 408 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED 409 * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages 410 * FUSE_CACHE_SYMLINKS: cache READLINK responses 411 * FUSE_NO_OPENDIR_SUPPORT: kernel supports zero-message opendir 412 * FUSE_EXPLICIT_INVAL_DATA: only invalidate cached pages on explicit request 413 * FUSE_MAP_ALIGNMENT: init_out.map_alignment contains log2(byte alignment) for 414 * foffset and moffset fields in struct 415 * fuse_setupmapping_out and fuse_removemapping_one. 416 * FUSE_SUBMOUNTS: kernel supports auto-mounting directory submounts 417 * FUSE_HANDLE_KILLPRIV_V2: fs kills suid/sgid/cap on write/chown/trunc. 418 * Upon write/truncate suid/sgid is only killed if caller 419 * does not have CAP_FSETID. Additionally upon 420 * write/truncate sgid is killed only if file has group 421 * execute permission. (Same as Linux VFS behavior). 422 * FUSE_SETXATTR_EXT: Server supports extended struct fuse_setxattr_in 423 * FUSE_INIT_EXT: extended fuse_init_in request 424 * FUSE_INIT_RESERVED: reserved, do not use 425 * FUSE_SECURITY_CTX: add security context to create, mkdir, symlink, and 426 * mknod 427 * FUSE_HAS_INODE_DAX: use per inode DAX 428 * FUSE_CREATE_SUPP_GROUP: add supplementary group info to create, mkdir, 429 * symlink and mknod (single group that matches parent) 430 * FUSE_HAS_EXPIRE_ONLY: kernel supports expiry-only entry invalidation 431 * FUSE_DIRECT_IO_ALLOW_MMAP: allow shared mmap in FOPEN_DIRECT_IO mode. 432 * FUSE_NO_EXPORT_SUPPORT: explicitly disable export support 433 * FUSE_HAS_RESEND: kernel supports resending pending requests, and the high bit 434 * of the request ID indicates resend requests 435 * FUSE_ALLOW_IDMAP: allow creation of idmapped mounts 436 * FUSE_OVER_IO_URING: Indicate that client supports io-uring 437 * FUSE_REQUEST_TIMEOUT: kernel supports timing out requests. 438 * init_out.request_timeout contains the timeout (in secs) 439 */ 440 #define FUSE_ASYNC_READ (1 << 0) 441 #define FUSE_POSIX_LOCKS (1 << 1) 442 #define FUSE_FILE_OPS (1 << 2) 443 #define FUSE_ATOMIC_O_TRUNC (1 << 3) 444 #define FUSE_EXPORT_SUPPORT (1 << 4) 445 #define FUSE_BIG_WRITES (1 << 5) 446 #define FUSE_DONT_MASK (1 << 6) 447 #define FUSE_SPLICE_WRITE (1 << 7) 448 #define FUSE_SPLICE_MOVE (1 << 8) 449 #define FUSE_SPLICE_READ (1 << 9) 450 #define FUSE_FLOCK_LOCKS (1 << 10) 451 #define FUSE_HAS_IOCTL_DIR (1 << 11) 452 #define FUSE_AUTO_INVAL_DATA (1 << 12) 453 #define FUSE_DO_READDIRPLUS (1 << 13) 454 #define FUSE_READDIRPLUS_AUTO (1 << 14) 455 #define FUSE_ASYNC_DIO (1 << 15) 456 #define FUSE_WRITEBACK_CACHE (1 << 16) 457 #define FUSE_NO_OPEN_SUPPORT (1 << 17) 458 #define FUSE_PARALLEL_DIROPS (1 << 18) 459 #define FUSE_HANDLE_KILLPRIV (1 << 19) 460 #define FUSE_POSIX_ACL (1 << 20) 461 #define FUSE_ABORT_ERROR (1 << 21) 462 #define FUSE_MAX_PAGES (1 << 22) 463 #define FUSE_CACHE_SYMLINKS (1 << 23) 464 #define FUSE_NO_OPENDIR_SUPPORT (1 << 24) 465 #define FUSE_EXPLICIT_INVAL_DATA (1 << 25) 466 #define FUSE_MAP_ALIGNMENT (1 << 26) 467 #define FUSE_SUBMOUNTS (1 << 27) 468 #define FUSE_HANDLE_KILLPRIV_V2 (1 << 28) 469 #define FUSE_SETXATTR_EXT (1 << 29) 470 #define FUSE_INIT_EXT (1 << 30) 471 #define FUSE_INIT_RESERVED (1 << 31) 472 /* bits 32..63 get shifted down 32 bits into the flags2 field */ 473 #define FUSE_SECURITY_CTX (1ULL << 32) 474 #define FUSE_HAS_INODE_DAX (1ULL << 33) 475 #define FUSE_CREATE_SUPP_GROUP (1ULL << 34) 476 #define FUSE_HAS_EXPIRE_ONLY (1ULL << 35) 477 #define FUSE_DIRECT_IO_ALLOW_MMAP (1ULL << 36) 478 #define FUSE_PASSTHROUGH (1ULL << 37) 479 #define FUSE_NO_EXPORT_SUPPORT (1ULL << 38) 480 #define FUSE_HAS_RESEND (1ULL << 39) 481 /* Obsolete alias for FUSE_DIRECT_IO_ALLOW_MMAP */ 482 #define FUSE_DIRECT_IO_RELAX FUSE_DIRECT_IO_ALLOW_MMAP 483 #define FUSE_ALLOW_IDMAP (1ULL << 40) 484 #define FUSE_OVER_IO_URING (1ULL << 41) 485 #define FUSE_REQUEST_TIMEOUT (1ULL << 42) 486 487 /** 488 * CUSE INIT request/reply flags 489 * 490 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl 491 */ 492 #define CUSE_UNRESTRICTED_IOCTL (1 << 0) 493 494 /** 495 * Release flags 496 */ 497 #define FUSE_RELEASE_FLUSH (1 << 0) 498 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1) 499 500 /** 501 * Getattr flags 502 */ 503 #define FUSE_GETATTR_FH (1 << 0) 504 505 /** 506 * Lock flags 507 */ 508 #define FUSE_LK_FLOCK (1 << 0) 509 510 /** 511 * WRITE flags 512 * 513 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed 514 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid 515 * FUSE_WRITE_KILL_SUIDGID: kill suid and sgid bits 516 */ 517 #define FUSE_WRITE_CACHE (1 << 0) 518 #define FUSE_WRITE_LOCKOWNER (1 << 1) 519 #define FUSE_WRITE_KILL_SUIDGID (1 << 2) 520 521 /* Obsolete alias; this flag implies killing suid/sgid only. */ 522 #define FUSE_WRITE_KILL_PRIV FUSE_WRITE_KILL_SUIDGID 523 524 /** 525 * Read flags 526 */ 527 #define FUSE_READ_LOCKOWNER (1 << 1) 528 529 /** 530 * Ioctl flags 531 * 532 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine 533 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed 534 * FUSE_IOCTL_RETRY: retry with new iovecs 535 * FUSE_IOCTL_32BIT: 32bit ioctl 536 * FUSE_IOCTL_DIR: is a directory 537 * FUSE_IOCTL_COMPAT_X32: x32 compat ioctl on 64bit machine (64bit time_t) 538 * 539 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs 540 */ 541 #define FUSE_IOCTL_COMPAT (1 << 0) 542 #define FUSE_IOCTL_UNRESTRICTED (1 << 1) 543 #define FUSE_IOCTL_RETRY (1 << 2) 544 #define FUSE_IOCTL_32BIT (1 << 3) 545 #define FUSE_IOCTL_DIR (1 << 4) 546 #define FUSE_IOCTL_COMPAT_X32 (1 << 5) 547 548 #define FUSE_IOCTL_MAX_IOV 256 549 550 /** 551 * Poll flags 552 * 553 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify 554 */ 555 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0) 556 557 /** 558 * Fsync flags 559 * 560 * FUSE_FSYNC_FDATASYNC: Sync data only, not metadata 561 */ 562 #define FUSE_FSYNC_FDATASYNC (1 << 0) 563 564 /** 565 * fuse_attr flags 566 * 567 * FUSE_ATTR_SUBMOUNT: Object is a submount root 568 * FUSE_ATTR_DAX: Enable DAX for this file in per inode DAX mode 569 */ 570 #define FUSE_ATTR_SUBMOUNT (1 << 0) 571 #define FUSE_ATTR_DAX (1 << 1) 572 573 /** 574 * Open flags 575 * FUSE_OPEN_KILL_SUIDGID: Kill suid and sgid if executable 576 */ 577 #define FUSE_OPEN_KILL_SUIDGID (1 << 0) 578 579 /** 580 * setxattr flags 581 * FUSE_SETXATTR_ACL_KILL_SGID: Clear SGID when system.posix_acl_access is set 582 */ 583 #define FUSE_SETXATTR_ACL_KILL_SGID (1 << 0) 584 585 /** 586 * notify_inval_entry flags 587 * FUSE_EXPIRE_ONLY 588 */ 589 #define FUSE_EXPIRE_ONLY (1 << 0) 590 591 /** 592 * extension type 593 * FUSE_MAX_NR_SECCTX: maximum value of &fuse_secctx_header.nr_secctx 594 * FUSE_EXT_GROUPS: &fuse_supp_groups extension 595 */ 596 enum fuse_ext_type { 597 /* Types 0..31 are reserved for fuse_secctx_header */ 598 FUSE_MAX_NR_SECCTX = 31, 599 FUSE_EXT_GROUPS = 32, 600 }; 601 602 enum fuse_opcode { 603 FUSE_LOOKUP = 1, 604 FUSE_FORGET = 2, /* no reply */ 605 FUSE_GETATTR = 3, 606 FUSE_SETATTR = 4, 607 FUSE_READLINK = 5, 608 FUSE_SYMLINK = 6, 609 FUSE_MKNOD = 8, 610 FUSE_MKDIR = 9, 611 FUSE_UNLINK = 10, 612 FUSE_RMDIR = 11, 613 FUSE_RENAME = 12, 614 FUSE_LINK = 13, 615 FUSE_OPEN = 14, 616 FUSE_READ = 15, 617 FUSE_WRITE = 16, 618 FUSE_STATFS = 17, 619 FUSE_RELEASE = 18, 620 FUSE_FSYNC = 20, 621 FUSE_SETXATTR = 21, 622 FUSE_GETXATTR = 22, 623 FUSE_LISTXATTR = 23, 624 FUSE_REMOVEXATTR = 24, 625 FUSE_FLUSH = 25, 626 FUSE_INIT = 26, 627 FUSE_OPENDIR = 27, 628 FUSE_READDIR = 28, 629 FUSE_RELEASEDIR = 29, 630 FUSE_FSYNCDIR = 30, 631 FUSE_GETLK = 31, 632 FUSE_SETLK = 32, 633 FUSE_SETLKW = 33, 634 FUSE_ACCESS = 34, 635 FUSE_CREATE = 35, 636 FUSE_INTERRUPT = 36, 637 FUSE_BMAP = 37, 638 FUSE_DESTROY = 38, 639 FUSE_IOCTL = 39, 640 FUSE_POLL = 40, 641 FUSE_NOTIFY_REPLY = 41, 642 FUSE_BATCH_FORGET = 42, 643 FUSE_FALLOCATE = 43, 644 FUSE_READDIRPLUS = 44, 645 FUSE_RENAME2 = 45, 646 FUSE_LSEEK = 46, 647 FUSE_COPY_FILE_RANGE = 47, 648 FUSE_SETUPMAPPING = 48, 649 FUSE_REMOVEMAPPING = 49, 650 FUSE_SYNCFS = 50, 651 FUSE_TMPFILE = 51, 652 FUSE_STATX = 52, 653 654 /* CUSE specific operations */ 655 CUSE_INIT = 4096, 656 657 /* Reserved opcodes: helpful to detect structure endian-ness */ 658 CUSE_INIT_BSWAP_RESERVED = 1048576, /* CUSE_INIT << 8 */ 659 FUSE_INIT_BSWAP_RESERVED = 436207616, /* FUSE_INIT << 24 */ 660 }; 661 662 enum fuse_notify_code { 663 FUSE_NOTIFY_POLL = 1, 664 FUSE_NOTIFY_INVAL_INODE = 2, 665 FUSE_NOTIFY_INVAL_ENTRY = 3, 666 FUSE_NOTIFY_STORE = 4, 667 FUSE_NOTIFY_RETRIEVE = 5, 668 FUSE_NOTIFY_DELETE = 6, 669 FUSE_NOTIFY_RESEND = 7, 670 FUSE_NOTIFY_CODE_MAX, 671 }; 672 673 /* The read buffer is required to be at least 8k, but may be much larger */ 674 #define FUSE_MIN_READ_BUFFER 8192 675 676 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120 677 678 struct fuse_entry_out { 679 uint64_t nodeid; /* Inode ID */ 680 uint64_t generation; /* Inode generation: nodeid:gen must 681 be unique for the fs's lifetime */ 682 uint64_t entry_valid; /* Cache timeout for the name */ 683 uint64_t attr_valid; /* Cache timeout for the attributes */ 684 uint32_t entry_valid_nsec; 685 uint32_t attr_valid_nsec; 686 struct fuse_attr attr; 687 }; 688 689 struct fuse_forget_in { 690 uint64_t nlookup; 691 }; 692 693 struct fuse_forget_one { 694 uint64_t nodeid; 695 uint64_t nlookup; 696 }; 697 698 struct fuse_batch_forget_in { 699 uint32_t count; 700 uint32_t dummy; 701 }; 702 703 struct fuse_getattr_in { 704 uint32_t getattr_flags; 705 uint32_t dummy; 706 uint64_t fh; 707 }; 708 709 #define FUSE_COMPAT_ATTR_OUT_SIZE 96 710 711 struct fuse_attr_out { 712 uint64_t attr_valid; /* Cache timeout for the attributes */ 713 uint32_t attr_valid_nsec; 714 uint32_t dummy; 715 struct fuse_attr attr; 716 }; 717 718 struct fuse_statx_in { 719 uint32_t getattr_flags; 720 uint32_t reserved; 721 uint64_t fh; 722 uint32_t sx_flags; 723 uint32_t sx_mask; 724 }; 725 726 struct fuse_statx_out { 727 uint64_t attr_valid; /* Cache timeout for the attributes */ 728 uint32_t attr_valid_nsec; 729 uint32_t flags; 730 uint64_t spare[2]; 731 struct fuse_statx stat; 732 }; 733 734 #define FUSE_COMPAT_MKNOD_IN_SIZE 8 735 736 struct fuse_mknod_in { 737 uint32_t mode; 738 uint32_t rdev; 739 uint32_t umask; 740 uint32_t padding; 741 }; 742 743 struct fuse_mkdir_in { 744 uint32_t mode; 745 uint32_t umask; 746 }; 747 748 struct fuse_rename_in { 749 uint64_t newdir; 750 }; 751 752 struct fuse_rename2_in { 753 uint64_t newdir; 754 uint32_t flags; 755 uint32_t padding; 756 }; 757 758 struct fuse_link_in { 759 uint64_t oldnodeid; 760 }; 761 762 struct fuse_setattr_in { 763 uint32_t valid; 764 uint32_t padding; 765 uint64_t fh; 766 uint64_t size; 767 uint64_t lock_owner; 768 uint64_t atime; 769 uint64_t mtime; 770 uint64_t ctime; 771 uint32_t atimensec; 772 uint32_t mtimensec; 773 uint32_t ctimensec; 774 uint32_t mode; 775 uint32_t unused4; 776 uint32_t uid; 777 uint32_t gid; 778 uint32_t unused5; 779 }; 780 781 struct fuse_open_in { 782 uint32_t flags; 783 uint32_t open_flags; /* FUSE_OPEN_... */ 784 }; 785 786 struct fuse_create_in { 787 uint32_t flags; 788 uint32_t mode; 789 uint32_t umask; 790 uint32_t open_flags; /* FUSE_OPEN_... */ 791 }; 792 793 struct fuse_open_out { 794 uint64_t fh; 795 uint32_t open_flags; 796 int32_t backing_id; 797 }; 798 799 struct fuse_release_in { 800 uint64_t fh; 801 uint32_t flags; 802 uint32_t release_flags; 803 uint64_t lock_owner; 804 }; 805 806 struct fuse_flush_in { 807 uint64_t fh; 808 uint32_t unused; 809 uint32_t padding; 810 uint64_t lock_owner; 811 }; 812 813 struct fuse_read_in { 814 uint64_t fh; 815 uint64_t offset; 816 uint32_t size; 817 uint32_t read_flags; 818 uint64_t lock_owner; 819 uint32_t flags; 820 uint32_t padding; 821 }; 822 823 #define FUSE_COMPAT_WRITE_IN_SIZE 24 824 825 struct fuse_write_in { 826 uint64_t fh; 827 uint64_t offset; 828 uint32_t size; 829 uint32_t write_flags; 830 uint64_t lock_owner; 831 uint32_t flags; 832 uint32_t padding; 833 }; 834 835 struct fuse_write_out { 836 uint32_t size; 837 uint32_t padding; 838 }; 839 840 #define FUSE_COMPAT_STATFS_SIZE 48 841 842 struct fuse_statfs_out { 843 struct fuse_kstatfs st; 844 }; 845 846 struct fuse_fsync_in { 847 uint64_t fh; 848 uint32_t fsync_flags; 849 uint32_t padding; 850 }; 851 852 #define FUSE_COMPAT_SETXATTR_IN_SIZE 8 853 854 struct fuse_setxattr_in { 855 uint32_t size; 856 uint32_t flags; 857 uint32_t setxattr_flags; 858 uint32_t padding; 859 }; 860 861 struct fuse_getxattr_in { 862 uint32_t size; 863 uint32_t padding; 864 }; 865 866 struct fuse_getxattr_out { 867 uint32_t size; 868 uint32_t padding; 869 }; 870 871 struct fuse_lk_in { 872 uint64_t fh; 873 uint64_t owner; 874 struct fuse_file_lock lk; 875 uint32_t lk_flags; 876 uint32_t padding; 877 }; 878 879 struct fuse_lk_out { 880 struct fuse_file_lock lk; 881 }; 882 883 struct fuse_access_in { 884 uint32_t mask; 885 uint32_t padding; 886 }; 887 888 struct fuse_init_in { 889 uint32_t major; 890 uint32_t minor; 891 uint32_t max_readahead; 892 uint32_t flags; 893 uint32_t flags2; 894 uint32_t unused[11]; 895 }; 896 897 #define FUSE_COMPAT_INIT_OUT_SIZE 8 898 #define FUSE_COMPAT_22_INIT_OUT_SIZE 24 899 900 struct fuse_init_out { 901 uint32_t major; 902 uint32_t minor; 903 uint32_t max_readahead; 904 uint32_t flags; 905 uint16_t max_background; 906 uint16_t congestion_threshold; 907 uint32_t max_write; 908 uint32_t time_gran; 909 uint16_t max_pages; 910 uint16_t map_alignment; 911 uint32_t flags2; 912 uint32_t max_stack_depth; 913 uint16_t request_timeout; 914 uint16_t unused[11]; 915 }; 916 917 #define CUSE_INIT_INFO_MAX 4096 918 919 struct cuse_init_in { 920 uint32_t major; 921 uint32_t minor; 922 uint32_t unused; 923 uint32_t flags; 924 }; 925 926 struct cuse_init_out { 927 uint32_t major; 928 uint32_t minor; 929 uint32_t unused; 930 uint32_t flags; 931 uint32_t max_read; 932 uint32_t max_write; 933 uint32_t dev_major; /* chardev major */ 934 uint32_t dev_minor; /* chardev minor */ 935 uint32_t spare[10]; 936 }; 937 938 struct fuse_interrupt_in { 939 uint64_t unique; 940 }; 941 942 struct fuse_bmap_in { 943 uint64_t block; 944 uint32_t blocksize; 945 uint32_t padding; 946 }; 947 948 struct fuse_bmap_out { 949 uint64_t block; 950 }; 951 952 struct fuse_ioctl_in { 953 uint64_t fh; 954 uint32_t flags; 955 uint32_t cmd; 956 uint64_t arg; 957 uint32_t in_size; 958 uint32_t out_size; 959 }; 960 961 struct fuse_ioctl_iovec { 962 uint64_t base; 963 uint64_t len; 964 }; 965 966 struct fuse_ioctl_out { 967 int32_t result; 968 uint32_t flags; 969 uint32_t in_iovs; 970 uint32_t out_iovs; 971 }; 972 973 struct fuse_poll_in { 974 uint64_t fh; 975 uint64_t kh; 976 uint32_t flags; 977 uint32_t events; 978 }; 979 980 struct fuse_poll_out { 981 uint32_t revents; 982 uint32_t padding; 983 }; 984 985 struct fuse_notify_poll_wakeup_out { 986 uint64_t kh; 987 }; 988 989 struct fuse_fallocate_in { 990 uint64_t fh; 991 uint64_t offset; 992 uint64_t length; 993 uint32_t mode; 994 uint32_t padding; 995 }; 996 997 /** 998 * FUSE request unique ID flag 999 * 1000 * Indicates whether this is a resend request. The receiver should handle this 1001 * request accordingly. 1002 */ 1003 #define FUSE_UNIQUE_RESEND (1ULL << 63) 1004 1005 /** 1006 * This value will be set by the kernel to 1007 * (struct fuse_in_header).{uid,gid} fields in 1008 * case when: 1009 * - fuse daemon enabled FUSE_ALLOW_IDMAP 1010 * - idmapping information is not available and uid/gid 1011 * can not be mapped in accordance with an idmapping. 1012 * 1013 * Note: an idmapping information always available 1014 * for inode creation operations like: 1015 * FUSE_MKNOD, FUSE_SYMLINK, FUSE_MKDIR, FUSE_TMPFILE, 1016 * FUSE_CREATE and FUSE_RENAME2 (with RENAME_WHITEOUT). 1017 */ 1018 #define FUSE_INVALID_UIDGID ((uint32_t)(-1)) 1019 1020 struct fuse_in_header { 1021 uint32_t len; 1022 uint32_t opcode; 1023 uint64_t unique; 1024 uint64_t nodeid; 1025 uint32_t uid; 1026 uint32_t gid; 1027 uint32_t pid; 1028 uint16_t total_extlen; /* length of extensions in 8byte units */ 1029 uint16_t padding; 1030 }; 1031 1032 struct fuse_out_header { 1033 uint32_t len; 1034 int32_t error; 1035 uint64_t unique; 1036 }; 1037 1038 struct fuse_dirent { 1039 uint64_t ino; 1040 uint64_t off; 1041 uint32_t namelen; 1042 uint32_t type; 1043 char name[]; 1044 }; 1045 1046 /* Align variable length records to 64bit boundary */ 1047 #define FUSE_REC_ALIGN(x) \ 1048 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1)) 1049 1050 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name) 1051 #define FUSE_DIRENT_ALIGN(x) FUSE_REC_ALIGN(x) 1052 #define FUSE_DIRENT_SIZE(d) \ 1053 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen) 1054 1055 struct fuse_direntplus { 1056 struct fuse_entry_out entry_out; 1057 struct fuse_dirent dirent; 1058 }; 1059 1060 #define FUSE_NAME_OFFSET_DIRENTPLUS \ 1061 offsetof(struct fuse_direntplus, dirent.name) 1062 #define FUSE_DIRENTPLUS_SIZE(d) \ 1063 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen) 1064 1065 struct fuse_notify_inval_inode_out { 1066 uint64_t ino; 1067 int64_t off; 1068 int64_t len; 1069 }; 1070 1071 struct fuse_notify_inval_entry_out { 1072 uint64_t parent; 1073 uint32_t namelen; 1074 uint32_t flags; 1075 }; 1076 1077 struct fuse_notify_delete_out { 1078 uint64_t parent; 1079 uint64_t child; 1080 uint32_t namelen; 1081 uint32_t padding; 1082 }; 1083 1084 struct fuse_notify_store_out { 1085 uint64_t nodeid; 1086 uint64_t offset; 1087 uint32_t size; 1088 uint32_t padding; 1089 }; 1090 1091 struct fuse_notify_retrieve_out { 1092 uint64_t notify_unique; 1093 uint64_t nodeid; 1094 uint64_t offset; 1095 uint32_t size; 1096 uint32_t padding; 1097 }; 1098 1099 /* Matches the size of fuse_write_in */ 1100 struct fuse_notify_retrieve_in { 1101 uint64_t dummy1; 1102 uint64_t offset; 1103 uint32_t size; 1104 uint32_t dummy2; 1105 uint64_t dummy3; 1106 uint64_t dummy4; 1107 }; 1108 1109 struct fuse_backing_map { 1110 int32_t fd; 1111 uint32_t flags; 1112 uint64_t padding; 1113 }; 1114 1115 /* Device ioctls: */ 1116 #define FUSE_DEV_IOC_MAGIC 229 1117 #define FUSE_DEV_IOC_CLONE _IOR(FUSE_DEV_IOC_MAGIC, 0, uint32_t) 1118 #define FUSE_DEV_IOC_BACKING_OPEN _IOW(FUSE_DEV_IOC_MAGIC, 1, \ 1119 struct fuse_backing_map) 1120 #define FUSE_DEV_IOC_BACKING_CLOSE _IOW(FUSE_DEV_IOC_MAGIC, 2, uint32_t) 1121 1122 struct fuse_lseek_in { 1123 uint64_t fh; 1124 uint64_t offset; 1125 uint32_t whence; 1126 uint32_t padding; 1127 }; 1128 1129 struct fuse_lseek_out { 1130 uint64_t offset; 1131 }; 1132 1133 struct fuse_copy_file_range_in { 1134 uint64_t fh_in; 1135 uint64_t off_in; 1136 uint64_t nodeid_out; 1137 uint64_t fh_out; 1138 uint64_t off_out; 1139 uint64_t len; 1140 uint64_t flags; 1141 }; 1142 1143 #define FUSE_SETUPMAPPING_FLAG_WRITE (1ull << 0) 1144 #define FUSE_SETUPMAPPING_FLAG_READ (1ull << 1) 1145 struct fuse_setupmapping_in { 1146 /* An already open handle */ 1147 uint64_t fh; 1148 /* Offset into the file to start the mapping */ 1149 uint64_t foffset; 1150 /* Length of mapping required */ 1151 uint64_t len; 1152 /* Flags, FUSE_SETUPMAPPING_FLAG_* */ 1153 uint64_t flags; 1154 /* Offset in Memory Window */ 1155 uint64_t moffset; 1156 }; 1157 1158 struct fuse_removemapping_in { 1159 /* number of fuse_removemapping_one follows */ 1160 uint32_t count; 1161 }; 1162 1163 struct fuse_removemapping_one { 1164 /* Offset into the dax window start the unmapping */ 1165 uint64_t moffset; 1166 /* Length of mapping required */ 1167 uint64_t len; 1168 }; 1169 1170 #define FUSE_REMOVEMAPPING_MAX_ENTRY \ 1171 (PAGE_SIZE / sizeof(struct fuse_removemapping_one)) 1172 1173 struct fuse_syncfs_in { 1174 uint64_t padding; 1175 }; 1176 1177 /* 1178 * For each security context, send fuse_secctx with size of security context 1179 * fuse_secctx will be followed by security context name and this in turn 1180 * will be followed by actual context label. 1181 * fuse_secctx, name, context 1182 */ 1183 struct fuse_secctx { 1184 uint32_t size; 1185 uint32_t padding; 1186 }; 1187 1188 /* 1189 * Contains the information about how many fuse_secctx structures are being 1190 * sent and what's the total size of all security contexts (including 1191 * size of fuse_secctx_header). 1192 * 1193 */ 1194 struct fuse_secctx_header { 1195 uint32_t size; 1196 uint32_t nr_secctx; 1197 }; 1198 1199 /** 1200 * struct fuse_ext_header - extension header 1201 * @size: total size of this extension including this header 1202 * @type: type of extension 1203 * 1204 * This is made compatible with fuse_secctx_header by using type values > 1205 * FUSE_MAX_NR_SECCTX 1206 */ 1207 struct fuse_ext_header { 1208 uint32_t size; 1209 uint32_t type; 1210 }; 1211 1212 /** 1213 * struct fuse_supp_groups - Supplementary group extension 1214 * @nr_groups: number of supplementary groups 1215 * @groups: flexible array of group IDs 1216 */ 1217 struct fuse_supp_groups { 1218 uint32_t nr_groups; 1219 uint32_t groups[]; 1220 }; 1221 1222 /** 1223 * Size of the ring buffer header 1224 */ 1225 #define FUSE_URING_IN_OUT_HEADER_SZ 128 1226 #define FUSE_URING_OP_IN_OUT_SZ 128 1227 1228 /* Used as part of the fuse_uring_req_header */ 1229 struct fuse_uring_ent_in_out { 1230 uint64_t flags; 1231 1232 /* 1233 * commit ID to be used in a reply to a ring request (see also 1234 * struct fuse_uring_cmd_req) 1235 */ 1236 uint64_t commit_id; 1237 1238 /* size of user payload buffer */ 1239 uint32_t payload_sz; 1240 uint32_t padding; 1241 1242 uint64_t reserved; 1243 }; 1244 1245 /** 1246 * Header for all fuse-io-uring requests 1247 */ 1248 struct fuse_uring_req_header { 1249 /* struct fuse_in_header / struct fuse_out_header */ 1250 char in_out[FUSE_URING_IN_OUT_HEADER_SZ]; 1251 1252 /* per op code header */ 1253 char op_in[FUSE_URING_OP_IN_OUT_SZ]; 1254 1255 struct fuse_uring_ent_in_out ring_ent_in_out; 1256 }; 1257 1258 /** 1259 * sqe commands to the kernel 1260 */ 1261 enum fuse_uring_cmd { 1262 FUSE_IO_URING_CMD_INVALID = 0, 1263 1264 /* register the request buffer and fetch a fuse request */ 1265 FUSE_IO_URING_CMD_REGISTER = 1, 1266 1267 /* commit fuse request result and fetch next request */ 1268 FUSE_IO_URING_CMD_COMMIT_AND_FETCH = 2, 1269 }; 1270 1271 /** 1272 * In the 80B command area of the SQE. 1273 */ 1274 struct fuse_uring_cmd_req { 1275 uint64_t flags; 1276 1277 /* entry identifier for commits */ 1278 uint64_t commit_id; 1279 1280 /* queue the command is for (queue index) */ 1281 uint16_t qid; 1282 uint8_t padding[6]; 1283 }; 1284 1285 #endif /* _LINUX_FUSE_H */ 1286