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