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 180 #ifndef _LINUX_FUSE_H 181 #define _LINUX_FUSE_H 182 183 #ifdef __KERNEL__ 184 #include <linux/types.h> 185 #else 186 #include <stdint.h> 187 #endif 188 189 /* 190 * Version negotiation: 191 * 192 * Both the kernel and userspace send the version they support in the 193 * INIT request and reply respectively. 194 * 195 * If the major versions match then both shall use the smallest 196 * of the two minor versions for communication. 197 * 198 * If the kernel supports a larger major version, then userspace shall 199 * reply with the major version it supports, ignore the rest of the 200 * INIT message and expect a new INIT message from the kernel with a 201 * matching major version. 202 * 203 * If the library supports a larger major version, then it shall fall 204 * back to the major protocol version sent by the kernel for 205 * communication and reply with that major version (and an arbitrary 206 * supported minor version). 207 */ 208 209 /** Version number of this interface */ 210 #define FUSE_KERNEL_VERSION 7 211 212 /** Minor version number of this interface */ 213 #define FUSE_KERNEL_MINOR_VERSION 32 214 215 /** The node ID of the root inode */ 216 #define FUSE_ROOT_ID 1 217 218 /* Make sure all structures are padded to 64bit boundary, so 32bit 219 userspace works under 64bit kernels */ 220 221 struct fuse_attr { 222 uint64_t ino; 223 uint64_t size; 224 uint64_t blocks; 225 uint64_t atime; 226 uint64_t mtime; 227 uint64_t ctime; 228 uint32_t atimensec; 229 uint32_t mtimensec; 230 uint32_t ctimensec; 231 uint32_t mode; 232 uint32_t nlink; 233 uint32_t uid; 234 uint32_t gid; 235 uint32_t rdev; 236 uint32_t blksize; 237 uint32_t flags; 238 }; 239 240 struct fuse_kstatfs { 241 uint64_t blocks; 242 uint64_t bfree; 243 uint64_t bavail; 244 uint64_t files; 245 uint64_t ffree; 246 uint32_t bsize; 247 uint32_t namelen; 248 uint32_t frsize; 249 uint32_t padding; 250 uint32_t spare[6]; 251 }; 252 253 struct fuse_file_lock { 254 uint64_t start; 255 uint64_t end; 256 uint32_t type; 257 uint32_t pid; /* tgid */ 258 }; 259 260 /** 261 * Bitmasks for fuse_setattr_in.valid 262 */ 263 #define FATTR_MODE (1 << 0) 264 #define FATTR_UID (1 << 1) 265 #define FATTR_GID (1 << 2) 266 #define FATTR_SIZE (1 << 3) 267 #define FATTR_ATIME (1 << 4) 268 #define FATTR_MTIME (1 << 5) 269 #define FATTR_FH (1 << 6) 270 #define FATTR_ATIME_NOW (1 << 7) 271 #define FATTR_MTIME_NOW (1 << 8) 272 #define FATTR_LOCKOWNER (1 << 9) 273 #define FATTR_CTIME (1 << 10) 274 275 /** 276 * Flags returned by the OPEN request 277 * 278 * FOPEN_DIRECT_IO: bypass page cache for this open file 279 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open 280 * FOPEN_NONSEEKABLE: the file is not seekable 281 * FOPEN_CACHE_DIR: allow caching this directory 282 * FOPEN_STREAM: the file is stream-like (no file position at all) 283 */ 284 #define FOPEN_DIRECT_IO (1 << 0) 285 #define FOPEN_KEEP_CACHE (1 << 1) 286 #define FOPEN_NONSEEKABLE (1 << 2) 287 #define FOPEN_CACHE_DIR (1 << 3) 288 #define FOPEN_STREAM (1 << 4) 289 290 /** 291 * INIT request/reply flags 292 * 293 * FUSE_ASYNC_READ: asynchronous read requests 294 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks 295 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported) 296 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem 297 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".." 298 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB 299 * FUSE_DONT_MASK: don't apply umask to file mode on create operations 300 * FUSE_SPLICE_WRITE: kernel supports splice write on the device 301 * FUSE_SPLICE_MOVE: kernel supports splice move on the device 302 * FUSE_SPLICE_READ: kernel supports splice read on the device 303 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks 304 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories 305 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages 306 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one) 307 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus 308 * FUSE_ASYNC_DIO: asynchronous direct I/O submission 309 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes 310 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens 311 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir 312 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc 313 * FUSE_POSIX_ACL: filesystem supports posix acls 314 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED 315 * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages 316 * FUSE_CACHE_SYMLINKS: cache READLINK responses 317 * FUSE_NO_OPENDIR_SUPPORT: kernel supports zero-message opendir 318 * FUSE_EXPLICIT_INVAL_DATA: only invalidate cached pages on explicit request 319 * FUSE_MAP_ALIGNMENT: init_out.map_alignment contains log2(byte alignment) for 320 * foffset and moffset fields in struct 321 * fuse_setupmapping_out and fuse_removemapping_one. 322 * FUSE_SUBMOUNTS: kernel supports auto-mounting directory submounts 323 */ 324 #define FUSE_ASYNC_READ (1 << 0) 325 #define FUSE_POSIX_LOCKS (1 << 1) 326 #define FUSE_FILE_OPS (1 << 2) 327 #define FUSE_ATOMIC_O_TRUNC (1 << 3) 328 #define FUSE_EXPORT_SUPPORT (1 << 4) 329 #define FUSE_BIG_WRITES (1 << 5) 330 #define FUSE_DONT_MASK (1 << 6) 331 #define FUSE_SPLICE_WRITE (1 << 7) 332 #define FUSE_SPLICE_MOVE (1 << 8) 333 #define FUSE_SPLICE_READ (1 << 9) 334 #define FUSE_FLOCK_LOCKS (1 << 10) 335 #define FUSE_HAS_IOCTL_DIR (1 << 11) 336 #define FUSE_AUTO_INVAL_DATA (1 << 12) 337 #define FUSE_DO_READDIRPLUS (1 << 13) 338 #define FUSE_READDIRPLUS_AUTO (1 << 14) 339 #define FUSE_ASYNC_DIO (1 << 15) 340 #define FUSE_WRITEBACK_CACHE (1 << 16) 341 #define FUSE_NO_OPEN_SUPPORT (1 << 17) 342 #define FUSE_PARALLEL_DIROPS (1 << 18) 343 #define FUSE_HANDLE_KILLPRIV (1 << 19) 344 #define FUSE_POSIX_ACL (1 << 20) 345 #define FUSE_ABORT_ERROR (1 << 21) 346 #define FUSE_MAX_PAGES (1 << 22) 347 #define FUSE_CACHE_SYMLINKS (1 << 23) 348 #define FUSE_NO_OPENDIR_SUPPORT (1 << 24) 349 #define FUSE_EXPLICIT_INVAL_DATA (1 << 25) 350 #define FUSE_MAP_ALIGNMENT (1 << 26) 351 #define FUSE_SUBMOUNTS (1 << 27) 352 #define FUSE_PASSTHROUGH (1 << 31) 353 354 /** 355 * CUSE INIT request/reply flags 356 * 357 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl 358 */ 359 #define CUSE_UNRESTRICTED_IOCTL (1 << 0) 360 361 /** 362 * Release flags 363 */ 364 #define FUSE_RELEASE_FLUSH (1 << 0) 365 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1) 366 367 /** 368 * Getattr flags 369 */ 370 #define FUSE_GETATTR_FH (1 << 0) 371 372 /** 373 * Lock flags 374 */ 375 #define FUSE_LK_FLOCK (1 << 0) 376 377 /** 378 * WRITE flags 379 * 380 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed 381 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid 382 * FUSE_WRITE_KILL_PRIV: kill suid and sgid bits 383 */ 384 #define FUSE_WRITE_CACHE (1 << 0) 385 #define FUSE_WRITE_LOCKOWNER (1 << 1) 386 #define FUSE_WRITE_KILL_PRIV (1 << 2) 387 388 /** 389 * Read flags 390 */ 391 #define FUSE_READ_LOCKOWNER (1 << 1) 392 393 /** 394 * Ioctl flags 395 * 396 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine 397 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed 398 * FUSE_IOCTL_RETRY: retry with new iovecs 399 * FUSE_IOCTL_32BIT: 32bit ioctl 400 * FUSE_IOCTL_DIR: is a directory 401 * FUSE_IOCTL_COMPAT_X32: x32 compat ioctl on 64bit machine (64bit time_t) 402 * 403 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs 404 */ 405 #define FUSE_IOCTL_COMPAT (1 << 0) 406 #define FUSE_IOCTL_UNRESTRICTED (1 << 1) 407 #define FUSE_IOCTL_RETRY (1 << 2) 408 #define FUSE_IOCTL_32BIT (1 << 3) 409 #define FUSE_IOCTL_DIR (1 << 4) 410 #define FUSE_IOCTL_COMPAT_X32 (1 << 5) 411 412 #define FUSE_IOCTL_MAX_IOV 256 413 414 /** 415 * Poll flags 416 * 417 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify 418 */ 419 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0) 420 421 /** 422 * Fsync flags 423 * 424 * FUSE_FSYNC_FDATASYNC: Sync data only, not metadata 425 */ 426 #define FUSE_FSYNC_FDATASYNC (1 << 0) 427 428 /** 429 * fuse_attr flags 430 * 431 * FUSE_ATTR_SUBMOUNT: Object is a submount root 432 */ 433 #define FUSE_ATTR_SUBMOUNT (1 << 0) 434 435 enum fuse_opcode { 436 FUSE_LOOKUP = 1, 437 FUSE_FORGET = 2, /* no reply */ 438 FUSE_GETATTR = 3, 439 FUSE_SETATTR = 4, 440 FUSE_READLINK = 5, 441 FUSE_SYMLINK = 6, 442 FUSE_MKNOD = 8, 443 FUSE_MKDIR = 9, 444 FUSE_UNLINK = 10, 445 FUSE_RMDIR = 11, 446 FUSE_RENAME = 12, 447 FUSE_LINK = 13, 448 FUSE_OPEN = 14, 449 FUSE_READ = 15, 450 FUSE_WRITE = 16, 451 FUSE_STATFS = 17, 452 FUSE_RELEASE = 18, 453 FUSE_FSYNC = 20, 454 FUSE_SETXATTR = 21, 455 FUSE_GETXATTR = 22, 456 FUSE_LISTXATTR = 23, 457 FUSE_REMOVEXATTR = 24, 458 FUSE_FLUSH = 25, 459 FUSE_INIT = 26, 460 FUSE_OPENDIR = 27, 461 FUSE_READDIR = 28, 462 FUSE_RELEASEDIR = 29, 463 FUSE_FSYNCDIR = 30, 464 FUSE_GETLK = 31, 465 FUSE_SETLK = 32, 466 FUSE_SETLKW = 33, 467 FUSE_ACCESS = 34, 468 FUSE_CREATE = 35, 469 FUSE_INTERRUPT = 36, 470 FUSE_BMAP = 37, 471 FUSE_DESTROY = 38, 472 FUSE_IOCTL = 39, 473 FUSE_POLL = 40, 474 FUSE_NOTIFY_REPLY = 41, 475 FUSE_BATCH_FORGET = 42, 476 FUSE_FALLOCATE = 43, 477 FUSE_READDIRPLUS = 44, 478 FUSE_RENAME2 = 45, 479 FUSE_LSEEK = 46, 480 FUSE_COPY_FILE_RANGE = 47, 481 FUSE_SETUPMAPPING = 48, 482 FUSE_REMOVEMAPPING = 49, 483 FUSE_CANONICAL_PATH = 2016, 484 485 /* CUSE specific operations */ 486 CUSE_INIT = 4096, 487 488 /* Reserved opcodes: helpful to detect structure endian-ness */ 489 CUSE_INIT_BSWAP_RESERVED = 1048576, /* CUSE_INIT << 8 */ 490 FUSE_INIT_BSWAP_RESERVED = 436207616, /* FUSE_INIT << 24 */ 491 }; 492 493 enum fuse_notify_code { 494 FUSE_NOTIFY_POLL = 1, 495 FUSE_NOTIFY_INVAL_INODE = 2, 496 FUSE_NOTIFY_INVAL_ENTRY = 3, 497 FUSE_NOTIFY_STORE = 4, 498 FUSE_NOTIFY_RETRIEVE = 5, 499 FUSE_NOTIFY_DELETE = 6, 500 FUSE_NOTIFY_CODE_MAX, 501 }; 502 503 /* The read buffer is required to be at least 8k, but may be much larger */ 504 #define FUSE_MIN_READ_BUFFER 8192 505 506 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120 507 508 struct fuse_entry_out { 509 uint64_t nodeid; /* Inode ID */ 510 uint64_t generation; /* Inode generation: nodeid:gen must 511 be unique for the fs's lifetime */ 512 uint64_t entry_valid; /* Cache timeout for the name */ 513 uint64_t attr_valid; /* Cache timeout for the attributes */ 514 uint32_t entry_valid_nsec; 515 uint32_t attr_valid_nsec; 516 struct fuse_attr attr; 517 }; 518 519 #define FUSE_ACTION_KEEP 0 520 #define FUSE_ACTION_REMOVE 1 521 #define FUSE_ACTION_REPLACE 2 522 523 struct fuse_entry_bpf_out { 524 uint64_t backing_action; 525 uint64_t backing_fd; 526 uint64_t bpf_action; 527 uint64_t bpf_fd; 528 }; 529 530 struct fuse_entry_bpf { 531 struct fuse_entry_bpf_out out; 532 struct file *backing_file; 533 struct file *bpf_file; 534 }; 535 536 struct fuse_forget_in { 537 uint64_t nlookup; 538 }; 539 540 struct fuse_forget_one { 541 uint64_t nodeid; 542 uint64_t nlookup; 543 }; 544 545 struct fuse_batch_forget_in { 546 uint32_t count; 547 uint32_t dummy; 548 }; 549 550 struct fuse_getattr_in { 551 uint32_t getattr_flags; 552 uint32_t dummy; 553 uint64_t fh; 554 }; 555 556 #define FUSE_COMPAT_ATTR_OUT_SIZE 96 557 558 struct fuse_attr_out { 559 uint64_t attr_valid; /* Cache timeout for the attributes */ 560 uint32_t attr_valid_nsec; 561 uint32_t dummy; 562 struct fuse_attr attr; 563 }; 564 565 #define FUSE_COMPAT_MKNOD_IN_SIZE 8 566 567 struct fuse_mknod_in { 568 uint32_t mode; 569 uint32_t rdev; 570 uint32_t umask; 571 uint32_t padding; 572 }; 573 574 struct fuse_mkdir_in { 575 uint32_t mode; 576 uint32_t umask; 577 }; 578 579 struct fuse_rename_in { 580 uint64_t newdir; 581 }; 582 583 struct fuse_rename2_in { 584 uint64_t newdir; 585 uint32_t flags; 586 uint32_t padding; 587 }; 588 589 struct fuse_link_in { 590 uint64_t oldnodeid; 591 }; 592 593 struct fuse_setattr_in { 594 uint32_t valid; 595 uint32_t padding; 596 uint64_t fh; 597 uint64_t size; 598 uint64_t lock_owner; 599 uint64_t atime; 600 uint64_t mtime; 601 uint64_t ctime; 602 uint32_t atimensec; 603 uint32_t mtimensec; 604 uint32_t ctimensec; 605 uint32_t mode; 606 uint32_t unused4; 607 uint32_t uid; 608 uint32_t gid; 609 uint32_t unused5; 610 }; 611 612 struct fuse_open_in { 613 uint32_t flags; 614 uint32_t unused; 615 }; 616 617 struct fuse_create_in { 618 uint32_t flags; 619 uint32_t mode; 620 uint32_t umask; 621 uint32_t padding; 622 }; 623 624 struct fuse_open_out { 625 uint64_t fh; 626 uint32_t open_flags; 627 uint32_t passthrough_fh; 628 }; 629 630 struct fuse_release_in { 631 uint64_t fh; 632 uint32_t flags; 633 uint32_t release_flags; 634 uint64_t lock_owner; 635 }; 636 637 struct fuse_flush_in { 638 uint64_t fh; 639 uint32_t unused; 640 uint32_t padding; 641 uint64_t lock_owner; 642 }; 643 644 struct fuse_read_in { 645 uint64_t fh; 646 uint64_t offset; 647 uint32_t size; 648 uint32_t read_flags; 649 uint64_t lock_owner; 650 uint32_t flags; 651 uint32_t padding; 652 }; 653 654 struct fuse_read_out { 655 uint64_t offset; 656 uint32_t again; 657 uint32_t padding; 658 }; 659 660 #define FUSE_COMPAT_WRITE_IN_SIZE 24 661 662 struct fuse_write_in { 663 uint64_t fh; 664 uint64_t offset; 665 uint32_t size; 666 uint32_t write_flags; 667 uint64_t lock_owner; 668 uint32_t flags; 669 uint32_t padding; 670 }; 671 672 struct fuse_write_out { 673 uint32_t size; 674 uint32_t padding; 675 }; 676 677 #define FUSE_COMPAT_STATFS_SIZE 48 678 679 struct fuse_statfs_out { 680 struct fuse_kstatfs st; 681 }; 682 683 struct fuse_fsync_in { 684 uint64_t fh; 685 uint32_t fsync_flags; 686 uint32_t padding; 687 }; 688 689 struct fuse_setxattr_in { 690 uint32_t size; 691 uint32_t flags; 692 }; 693 694 struct fuse_getxattr_in { 695 uint32_t size; 696 uint32_t padding; 697 }; 698 699 struct fuse_getxattr_out { 700 uint32_t size; 701 uint32_t padding; 702 }; 703 704 struct fuse_lk_in { 705 uint64_t fh; 706 uint64_t owner; 707 struct fuse_file_lock lk; 708 uint32_t lk_flags; 709 uint32_t padding; 710 }; 711 712 struct fuse_lk_out { 713 struct fuse_file_lock lk; 714 }; 715 716 struct fuse_access_in { 717 uint32_t mask; 718 uint32_t padding; 719 }; 720 721 struct fuse_init_in { 722 uint32_t major; 723 uint32_t minor; 724 uint32_t max_readahead; 725 uint32_t flags; 726 }; 727 728 #define FUSE_COMPAT_INIT_OUT_SIZE 8 729 #define FUSE_COMPAT_22_INIT_OUT_SIZE 24 730 731 struct fuse_init_out { 732 uint32_t major; 733 uint32_t minor; 734 uint32_t max_readahead; 735 uint32_t flags; 736 uint16_t max_background; 737 uint16_t congestion_threshold; 738 uint32_t max_write; 739 uint32_t time_gran; 740 uint16_t max_pages; 741 uint16_t map_alignment; 742 uint32_t unused[8]; 743 }; 744 745 #define CUSE_INIT_INFO_MAX 4096 746 747 struct cuse_init_in { 748 uint32_t major; 749 uint32_t minor; 750 uint32_t unused; 751 uint32_t flags; 752 }; 753 754 struct cuse_init_out { 755 uint32_t major; 756 uint32_t minor; 757 uint32_t unused; 758 uint32_t flags; 759 uint32_t max_read; 760 uint32_t max_write; 761 uint32_t dev_major; /* chardev major */ 762 uint32_t dev_minor; /* chardev minor */ 763 uint32_t spare[10]; 764 }; 765 766 struct fuse_interrupt_in { 767 uint64_t unique; 768 }; 769 770 struct fuse_bmap_in { 771 uint64_t block; 772 uint32_t blocksize; 773 uint32_t padding; 774 }; 775 776 struct fuse_bmap_out { 777 uint64_t block; 778 }; 779 780 struct fuse_ioctl_in { 781 uint64_t fh; 782 uint32_t flags; 783 uint32_t cmd; 784 uint64_t arg; 785 uint32_t in_size; 786 uint32_t out_size; 787 }; 788 789 struct fuse_ioctl_iovec { 790 uint64_t base; 791 uint64_t len; 792 }; 793 794 struct fuse_ioctl_out { 795 int32_t result; 796 uint32_t flags; 797 uint32_t in_iovs; 798 uint32_t out_iovs; 799 }; 800 801 struct fuse_poll_in { 802 uint64_t fh; 803 uint64_t kh; 804 uint32_t flags; 805 uint32_t events; 806 }; 807 808 struct fuse_poll_out { 809 uint32_t revents; 810 uint32_t padding; 811 }; 812 813 struct fuse_notify_poll_wakeup_out { 814 uint64_t kh; 815 }; 816 817 struct fuse_fallocate_in { 818 uint64_t fh; 819 uint64_t offset; 820 uint64_t length; 821 uint32_t mode; 822 uint32_t padding; 823 }; 824 825 struct fuse_in_header { 826 uint32_t len; 827 uint32_t opcode; 828 uint64_t unique; 829 uint64_t nodeid; 830 uint32_t uid; 831 uint32_t gid; 832 uint32_t pid; 833 uint32_t error_in; 834 }; 835 836 struct fuse_out_header { 837 uint32_t len; 838 int32_t error; 839 uint64_t unique; 840 }; 841 842 struct fuse_dirent { 843 uint64_t ino; 844 uint64_t off; 845 uint32_t namelen; 846 uint32_t type; 847 char name[]; 848 }; 849 850 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name) 851 #define FUSE_DIRENT_ALIGN(x) \ 852 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1)) 853 #define FUSE_DIRENT_SIZE(d) \ 854 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen) 855 856 struct fuse_direntplus { 857 struct fuse_entry_out entry_out; 858 struct fuse_dirent dirent; 859 }; 860 861 #define FUSE_NAME_OFFSET_DIRENTPLUS \ 862 offsetof(struct fuse_direntplus, dirent.name) 863 #define FUSE_DIRENTPLUS_SIZE(d) \ 864 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen) 865 866 struct fuse_notify_inval_inode_out { 867 uint64_t ino; 868 int64_t off; 869 int64_t len; 870 }; 871 872 struct fuse_notify_inval_entry_out { 873 uint64_t parent; 874 uint32_t namelen; 875 uint32_t padding; 876 }; 877 878 struct fuse_notify_delete_out { 879 uint64_t parent; 880 uint64_t child; 881 uint32_t namelen; 882 uint32_t padding; 883 }; 884 885 struct fuse_notify_store_out { 886 uint64_t nodeid; 887 uint64_t offset; 888 uint32_t size; 889 uint32_t padding; 890 }; 891 892 struct fuse_notify_retrieve_out { 893 uint64_t notify_unique; 894 uint64_t nodeid; 895 uint64_t offset; 896 uint32_t size; 897 uint32_t padding; 898 }; 899 900 /* Matches the size of fuse_write_in */ 901 struct fuse_notify_retrieve_in { 902 uint64_t dummy1; 903 uint64_t offset; 904 uint32_t size; 905 uint32_t dummy2; 906 uint64_t dummy3; 907 uint64_t dummy4; 908 }; 909 910 /* Device ioctls: */ 911 #define FUSE_DEV_IOC_MAGIC 229 912 #define FUSE_DEV_IOC_CLONE _IOR(FUSE_DEV_IOC_MAGIC, 0, uint32_t) 913 /* 127 is reserved for the V1 interface implementation in Android (deprecated) */ 914 /* 126 is reserved for the V2 interface implementation in Android */ 915 #define FUSE_DEV_IOC_PASSTHROUGH_OPEN _IOW(FUSE_DEV_IOC_MAGIC, 126, __u32) 916 917 struct fuse_lseek_in { 918 uint64_t fh; 919 uint64_t offset; 920 uint32_t whence; 921 uint32_t padding; 922 }; 923 924 struct fuse_lseek_out { 925 uint64_t offset; 926 }; 927 928 struct fuse_copy_file_range_in { 929 uint64_t fh_in; 930 uint64_t off_in; 931 uint64_t nodeid_out; 932 uint64_t fh_out; 933 uint64_t off_out; 934 uint64_t len; 935 uint64_t flags; 936 }; 937 938 #define FUSE_SETUPMAPPING_FLAG_WRITE (1ull << 0) 939 #define FUSE_SETUPMAPPING_FLAG_READ (1ull << 1) 940 struct fuse_setupmapping_in { 941 /* An already open handle */ 942 uint64_t fh; 943 /* Offset into the file to start the mapping */ 944 uint64_t foffset; 945 /* Length of mapping required */ 946 uint64_t len; 947 /* Flags, FUSE_SETUPMAPPING_FLAG_* */ 948 uint64_t flags; 949 /* Offset in Memory Window */ 950 uint64_t moffset; 951 }; 952 953 struct fuse_removemapping_in { 954 /* number of fuse_removemapping_one follows */ 955 uint32_t count; 956 }; 957 958 struct fuse_removemapping_one { 959 /* Offset into the dax window start the unmapping */ 960 uint64_t moffset; 961 /* Length of mapping required */ 962 uint64_t len; 963 }; 964 965 #define FUSE_REMOVEMAPPING_MAX_ENTRY \ 966 (PAGE_SIZE / sizeof(struct fuse_removemapping_one)) 967 968 /* 969 * Fuse BPF Args 970 * 971 * Used to communicate with bpf programs to allow checking or altering certain values. 972 * The end_offset allows the bpf verifier to check boundaries statically. This reflects 973 * the ends of the buffer. size shows the length that was actually used. 974 * 975 */ 976 977 /** One input argument of a request */ 978 struct fuse_bpf_in_arg { 979 uint32_t size; 980 uint32_t padding; 981 union { 982 const void *value; 983 uint64_t padding2; 984 }; 985 union { 986 const void *end_offset; 987 uint64_t padding3; 988 }; 989 }; 990 991 /** One output argument of a request */ 992 struct fuse_bpf_arg { 993 uint32_t size; 994 uint32_t padding; 995 union { 996 void *value; 997 uint64_t padding2; 998 }; 999 union { 1000 void *end_offset; 1001 uint64_t padding3; 1002 }; 1003 }; 1004 1005 #define FUSE_MAX_IN_ARGS 5 1006 #define FUSE_MAX_OUT_ARGS 3 1007 1008 #define FUSE_BPF_FORCE (1 << 0) 1009 #define FUSE_BPF_OUT_ARGVAR (1 << 6) 1010 1011 struct fuse_bpf_args { 1012 uint64_t nodeid; 1013 uint32_t opcode; 1014 uint32_t error_in; 1015 uint32_t in_numargs; 1016 uint32_t out_numargs; 1017 uint32_t flags; 1018 uint32_t padding; 1019 struct fuse_bpf_in_arg in_args[FUSE_MAX_IN_ARGS]; 1020 struct fuse_bpf_arg out_args[FUSE_MAX_OUT_ARGS]; 1021 }; 1022 1023 #define FUSE_BPF_USER_FILTER 1 1024 #define FUSE_BPF_BACKING 2 1025 #define FUSE_BPF_POST_FILTER 4 1026 1027 #define FUSE_OPCODE_FILTER 0x0ffff 1028 #define FUSE_PREFILTER 0x10000 1029 #define FUSE_POSTFILTER 0x20000 1030 1031 #endif /* _LINUX_FUSE_H */ 1032