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