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