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