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