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