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