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 */ 220 221 #ifndef _LINUX_FUSE_H 222 #define _LINUX_FUSE_H 223 224 #ifdef __KERNEL__ 225 #include <linux/types.h> 226 #else 227 #include <stdint.h> 228 #endif 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 40 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 */ 422 #define FUSE_ASYNC_READ (1 << 0) 423 #define FUSE_POSIX_LOCKS (1 << 1) 424 #define FUSE_FILE_OPS (1 << 2) 425 #define FUSE_ATOMIC_O_TRUNC (1 << 3) 426 #define FUSE_EXPORT_SUPPORT (1 << 4) 427 #define FUSE_BIG_WRITES (1 << 5) 428 #define FUSE_DONT_MASK (1 << 6) 429 #define FUSE_SPLICE_WRITE (1 << 7) 430 #define FUSE_SPLICE_MOVE (1 << 8) 431 #define FUSE_SPLICE_READ (1 << 9) 432 #define FUSE_FLOCK_LOCKS (1 << 10) 433 #define FUSE_HAS_IOCTL_DIR (1 << 11) 434 #define FUSE_AUTO_INVAL_DATA (1 << 12) 435 #define FUSE_DO_READDIRPLUS (1 << 13) 436 #define FUSE_READDIRPLUS_AUTO (1 << 14) 437 #define FUSE_ASYNC_DIO (1 << 15) 438 #define FUSE_WRITEBACK_CACHE (1 << 16) 439 #define FUSE_NO_OPEN_SUPPORT (1 << 17) 440 #define FUSE_PARALLEL_DIROPS (1 << 18) 441 #define FUSE_HANDLE_KILLPRIV (1 << 19) 442 #define FUSE_POSIX_ACL (1 << 20) 443 #define FUSE_ABORT_ERROR (1 << 21) 444 #define FUSE_MAX_PAGES (1 << 22) 445 #define FUSE_CACHE_SYMLINKS (1 << 23) 446 #define FUSE_NO_OPENDIR_SUPPORT (1 << 24) 447 #define FUSE_EXPLICIT_INVAL_DATA (1 << 25) 448 #define FUSE_MAP_ALIGNMENT (1 << 26) 449 #define FUSE_SUBMOUNTS (1 << 27) 450 #define FUSE_HANDLE_KILLPRIV_V2 (1 << 28) 451 #define FUSE_SETXATTR_EXT (1 << 29) 452 #define FUSE_INIT_EXT (1 << 30) 453 #define FUSE_INIT_RESERVED (1 << 31) 454 /* bits 32..63 get shifted down 32 bits into the flags2 field */ 455 #define FUSE_SECURITY_CTX (1ULL << 32) 456 #define FUSE_HAS_INODE_DAX (1ULL << 33) 457 #define FUSE_CREATE_SUPP_GROUP (1ULL << 34) 458 #define FUSE_HAS_EXPIRE_ONLY (1ULL << 35) 459 #define FUSE_DIRECT_IO_ALLOW_MMAP (1ULL << 36) 460 #define FUSE_PASSTHROUGH (1ULL << 37) 461 #define FUSE_NO_EXPORT_SUPPORT (1ULL << 38) 462 463 /* Obsolete alias for FUSE_DIRECT_IO_ALLOW_MMAP */ 464 #define FUSE_DIRECT_IO_RELAX FUSE_DIRECT_IO_ALLOW_MMAP 465 466 /** 467 * CUSE INIT request/reply flags 468 * 469 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl 470 */ 471 #define CUSE_UNRESTRICTED_IOCTL (1 << 0) 472 473 /** 474 * Release flags 475 */ 476 #define FUSE_RELEASE_FLUSH (1 << 0) 477 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1) 478 479 /** 480 * Getattr flags 481 */ 482 #define FUSE_GETATTR_FH (1 << 0) 483 484 /** 485 * Lock flags 486 */ 487 #define FUSE_LK_FLOCK (1 << 0) 488 489 /** 490 * WRITE flags 491 * 492 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed 493 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid 494 * FUSE_WRITE_KILL_SUIDGID: kill suid and sgid bits 495 */ 496 #define FUSE_WRITE_CACHE (1 << 0) 497 #define FUSE_WRITE_LOCKOWNER (1 << 1) 498 #define FUSE_WRITE_KILL_SUIDGID (1 << 2) 499 500 /* Obsolete alias; this flag implies killing suid/sgid only. */ 501 #define FUSE_WRITE_KILL_PRIV FUSE_WRITE_KILL_SUIDGID 502 503 /** 504 * Read flags 505 */ 506 #define FUSE_READ_LOCKOWNER (1 << 1) 507 508 /** 509 * Ioctl flags 510 * 511 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine 512 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed 513 * FUSE_IOCTL_RETRY: retry with new iovecs 514 * FUSE_IOCTL_32BIT: 32bit ioctl 515 * FUSE_IOCTL_DIR: is a directory 516 * FUSE_IOCTL_COMPAT_X32: x32 compat ioctl on 64bit machine (64bit time_t) 517 * 518 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs 519 */ 520 #define FUSE_IOCTL_COMPAT (1 << 0) 521 #define FUSE_IOCTL_UNRESTRICTED (1 << 1) 522 #define FUSE_IOCTL_RETRY (1 << 2) 523 #define FUSE_IOCTL_32BIT (1 << 3) 524 #define FUSE_IOCTL_DIR (1 << 4) 525 #define FUSE_IOCTL_COMPAT_X32 (1 << 5) 526 527 #define FUSE_IOCTL_MAX_IOV 256 528 529 /** 530 * Poll flags 531 * 532 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify 533 */ 534 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0) 535 536 /** 537 * Fsync flags 538 * 539 * FUSE_FSYNC_FDATASYNC: Sync data only, not metadata 540 */ 541 #define FUSE_FSYNC_FDATASYNC (1 << 0) 542 543 /** 544 * fuse_attr flags 545 * 546 * FUSE_ATTR_SUBMOUNT: Object is a submount root 547 * FUSE_ATTR_DAX: Enable DAX for this file in per inode DAX mode 548 */ 549 #define FUSE_ATTR_SUBMOUNT (1 << 0) 550 #define FUSE_ATTR_DAX (1 << 1) 551 552 /** 553 * Open flags 554 * FUSE_OPEN_KILL_SUIDGID: Kill suid and sgid if executable 555 */ 556 #define FUSE_OPEN_KILL_SUIDGID (1 << 0) 557 558 /** 559 * setxattr flags 560 * FUSE_SETXATTR_ACL_KILL_SGID: Clear SGID when system.posix_acl_access is set 561 */ 562 #define FUSE_SETXATTR_ACL_KILL_SGID (1 << 0) 563 564 /** 565 * notify_inval_entry flags 566 * FUSE_EXPIRE_ONLY 567 */ 568 #define FUSE_EXPIRE_ONLY (1 << 0) 569 570 /** 571 * extension type 572 * FUSE_MAX_NR_SECCTX: maximum value of &fuse_secctx_header.nr_secctx 573 * FUSE_EXT_GROUPS: &fuse_supp_groups extension 574 */ 575 enum fuse_ext_type { 576 /* Types 0..31 are reserved for fuse_secctx_header */ 577 FUSE_MAX_NR_SECCTX = 31, 578 FUSE_EXT_GROUPS = 32, 579 }; 580 581 enum fuse_opcode { 582 FUSE_LOOKUP = 1, 583 FUSE_FORGET = 2, /* no reply */ 584 FUSE_GETATTR = 3, 585 FUSE_SETATTR = 4, 586 FUSE_READLINK = 5, 587 FUSE_SYMLINK = 6, 588 FUSE_MKNOD = 8, 589 FUSE_MKDIR = 9, 590 FUSE_UNLINK = 10, 591 FUSE_RMDIR = 11, 592 FUSE_RENAME = 12, 593 FUSE_LINK = 13, 594 FUSE_OPEN = 14, 595 FUSE_READ = 15, 596 FUSE_WRITE = 16, 597 FUSE_STATFS = 17, 598 FUSE_RELEASE = 18, 599 FUSE_FSYNC = 20, 600 FUSE_SETXATTR = 21, 601 FUSE_GETXATTR = 22, 602 FUSE_LISTXATTR = 23, 603 FUSE_REMOVEXATTR = 24, 604 FUSE_FLUSH = 25, 605 FUSE_INIT = 26, 606 FUSE_OPENDIR = 27, 607 FUSE_READDIR = 28, 608 FUSE_RELEASEDIR = 29, 609 FUSE_FSYNCDIR = 30, 610 FUSE_GETLK = 31, 611 FUSE_SETLK = 32, 612 FUSE_SETLKW = 33, 613 FUSE_ACCESS = 34, 614 FUSE_CREATE = 35, 615 FUSE_INTERRUPT = 36, 616 FUSE_BMAP = 37, 617 FUSE_DESTROY = 38, 618 FUSE_IOCTL = 39, 619 FUSE_POLL = 40, 620 FUSE_NOTIFY_REPLY = 41, 621 FUSE_BATCH_FORGET = 42, 622 FUSE_FALLOCATE = 43, 623 FUSE_READDIRPLUS = 44, 624 FUSE_RENAME2 = 45, 625 FUSE_LSEEK = 46, 626 FUSE_COPY_FILE_RANGE = 47, 627 FUSE_SETUPMAPPING = 48, 628 FUSE_REMOVEMAPPING = 49, 629 FUSE_SYNCFS = 50, 630 FUSE_TMPFILE = 51, 631 FUSE_STATX = 52, 632 633 /* CUSE specific operations */ 634 CUSE_INIT = 4096, 635 636 /* Reserved opcodes: helpful to detect structure endian-ness */ 637 CUSE_INIT_BSWAP_RESERVED = 1048576, /* CUSE_INIT << 8 */ 638 FUSE_INIT_BSWAP_RESERVED = 436207616, /* FUSE_INIT << 24 */ 639 }; 640 641 enum fuse_notify_code { 642 FUSE_NOTIFY_POLL = 1, 643 FUSE_NOTIFY_INVAL_INODE = 2, 644 FUSE_NOTIFY_INVAL_ENTRY = 3, 645 FUSE_NOTIFY_STORE = 4, 646 FUSE_NOTIFY_RETRIEVE = 5, 647 FUSE_NOTIFY_DELETE = 6, 648 FUSE_NOTIFY_CODE_MAX, 649 }; 650 651 /* The read buffer is required to be at least 8k, but may be much larger */ 652 #define FUSE_MIN_READ_BUFFER 8192 653 654 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120 655 656 struct fuse_entry_out { 657 uint64_t nodeid; /* Inode ID */ 658 uint64_t generation; /* Inode generation: nodeid:gen must 659 be unique for the fs's lifetime */ 660 uint64_t entry_valid; /* Cache timeout for the name */ 661 uint64_t attr_valid; /* Cache timeout for the attributes */ 662 uint32_t entry_valid_nsec; 663 uint32_t attr_valid_nsec; 664 struct fuse_attr attr; 665 }; 666 667 struct fuse_forget_in { 668 uint64_t nlookup; 669 }; 670 671 struct fuse_forget_one { 672 uint64_t nodeid; 673 uint64_t nlookup; 674 }; 675 676 struct fuse_batch_forget_in { 677 uint32_t count; 678 uint32_t dummy; 679 }; 680 681 struct fuse_getattr_in { 682 uint32_t getattr_flags; 683 uint32_t dummy; 684 uint64_t fh; 685 }; 686 687 #define FUSE_COMPAT_ATTR_OUT_SIZE 96 688 689 struct fuse_attr_out { 690 uint64_t attr_valid; /* Cache timeout for the attributes */ 691 uint32_t attr_valid_nsec; 692 uint32_t dummy; 693 struct fuse_attr attr; 694 }; 695 696 struct fuse_statx_in { 697 uint32_t getattr_flags; 698 uint32_t reserved; 699 uint64_t fh; 700 uint32_t sx_flags; 701 uint32_t sx_mask; 702 }; 703 704 struct fuse_statx_out { 705 uint64_t attr_valid; /* Cache timeout for the attributes */ 706 uint32_t attr_valid_nsec; 707 uint32_t flags; 708 uint64_t spare[2]; 709 struct fuse_statx stat; 710 }; 711 712 #define FUSE_COMPAT_MKNOD_IN_SIZE 8 713 714 struct fuse_mknod_in { 715 uint32_t mode; 716 uint32_t rdev; 717 uint32_t umask; 718 uint32_t padding; 719 }; 720 721 struct fuse_mkdir_in { 722 uint32_t mode; 723 uint32_t umask; 724 }; 725 726 struct fuse_rename_in { 727 uint64_t newdir; 728 }; 729 730 struct fuse_rename2_in { 731 uint64_t newdir; 732 uint32_t flags; 733 uint32_t padding; 734 }; 735 736 struct fuse_link_in { 737 uint64_t oldnodeid; 738 }; 739 740 struct fuse_setattr_in { 741 uint32_t valid; 742 uint32_t padding; 743 uint64_t fh; 744 uint64_t size; 745 uint64_t lock_owner; 746 uint64_t atime; 747 uint64_t mtime; 748 uint64_t ctime; 749 uint32_t atimensec; 750 uint32_t mtimensec; 751 uint32_t ctimensec; 752 uint32_t mode; 753 uint32_t unused4; 754 uint32_t uid; 755 uint32_t gid; 756 uint32_t unused5; 757 }; 758 759 struct fuse_open_in { 760 uint32_t flags; 761 uint32_t open_flags; /* FUSE_OPEN_... */ 762 }; 763 764 struct fuse_create_in { 765 uint32_t flags; 766 uint32_t mode; 767 uint32_t umask; 768 uint32_t open_flags; /* FUSE_OPEN_... */ 769 }; 770 771 struct fuse_open_out { 772 uint64_t fh; 773 uint32_t open_flags; 774 int32_t backing_id; 775 }; 776 777 struct fuse_release_in { 778 uint64_t fh; 779 uint32_t flags; 780 uint32_t release_flags; 781 uint64_t lock_owner; 782 }; 783 784 struct fuse_flush_in { 785 uint64_t fh; 786 uint32_t unused; 787 uint32_t padding; 788 uint64_t lock_owner; 789 }; 790 791 struct fuse_read_in { 792 uint64_t fh; 793 uint64_t offset; 794 uint32_t size; 795 uint32_t read_flags; 796 uint64_t lock_owner; 797 uint32_t flags; 798 uint32_t padding; 799 }; 800 801 #define FUSE_COMPAT_WRITE_IN_SIZE 24 802 803 struct fuse_write_in { 804 uint64_t fh; 805 uint64_t offset; 806 uint32_t size; 807 uint32_t write_flags; 808 uint64_t lock_owner; 809 uint32_t flags; 810 uint32_t padding; 811 }; 812 813 struct fuse_write_out { 814 uint32_t size; 815 uint32_t padding; 816 }; 817 818 #define FUSE_COMPAT_STATFS_SIZE 48 819 820 struct fuse_statfs_out { 821 struct fuse_kstatfs st; 822 }; 823 824 struct fuse_fsync_in { 825 uint64_t fh; 826 uint32_t fsync_flags; 827 uint32_t padding; 828 }; 829 830 #define FUSE_COMPAT_SETXATTR_IN_SIZE 8 831 832 struct fuse_setxattr_in { 833 uint32_t size; 834 uint32_t flags; 835 uint32_t setxattr_flags; 836 uint32_t padding; 837 }; 838 839 struct fuse_getxattr_in { 840 uint32_t size; 841 uint32_t padding; 842 }; 843 844 struct fuse_getxattr_out { 845 uint32_t size; 846 uint32_t padding; 847 }; 848 849 struct fuse_lk_in { 850 uint64_t fh; 851 uint64_t owner; 852 struct fuse_file_lock lk; 853 uint32_t lk_flags; 854 uint32_t padding; 855 }; 856 857 struct fuse_lk_out { 858 struct fuse_file_lock lk; 859 }; 860 861 struct fuse_access_in { 862 uint32_t mask; 863 uint32_t padding; 864 }; 865 866 struct fuse_init_in { 867 uint32_t major; 868 uint32_t minor; 869 uint32_t max_readahead; 870 uint32_t flags; 871 uint32_t flags2; 872 uint32_t unused[11]; 873 }; 874 875 #define FUSE_COMPAT_INIT_OUT_SIZE 8 876 #define FUSE_COMPAT_22_INIT_OUT_SIZE 24 877 878 struct fuse_init_out { 879 uint32_t major; 880 uint32_t minor; 881 uint32_t max_readahead; 882 uint32_t flags; 883 uint16_t max_background; 884 uint16_t congestion_threshold; 885 uint32_t max_write; 886 uint32_t time_gran; 887 uint16_t max_pages; 888 uint16_t map_alignment; 889 uint32_t flags2; 890 uint32_t max_stack_depth; 891 uint32_t unused[6]; 892 }; 893 894 #define CUSE_INIT_INFO_MAX 4096 895 896 struct cuse_init_in { 897 uint32_t major; 898 uint32_t minor; 899 uint32_t unused; 900 uint32_t flags; 901 }; 902 903 struct cuse_init_out { 904 uint32_t major; 905 uint32_t minor; 906 uint32_t unused; 907 uint32_t flags; 908 uint32_t max_read; 909 uint32_t max_write; 910 uint32_t dev_major; /* chardev major */ 911 uint32_t dev_minor; /* chardev minor */ 912 uint32_t spare[10]; 913 }; 914 915 struct fuse_interrupt_in { 916 uint64_t unique; 917 }; 918 919 struct fuse_bmap_in { 920 uint64_t block; 921 uint32_t blocksize; 922 uint32_t padding; 923 }; 924 925 struct fuse_bmap_out { 926 uint64_t block; 927 }; 928 929 struct fuse_ioctl_in { 930 uint64_t fh; 931 uint32_t flags; 932 uint32_t cmd; 933 uint64_t arg; 934 uint32_t in_size; 935 uint32_t out_size; 936 }; 937 938 struct fuse_ioctl_iovec { 939 uint64_t base; 940 uint64_t len; 941 }; 942 943 struct fuse_ioctl_out { 944 int32_t result; 945 uint32_t flags; 946 uint32_t in_iovs; 947 uint32_t out_iovs; 948 }; 949 950 struct fuse_poll_in { 951 uint64_t fh; 952 uint64_t kh; 953 uint32_t flags; 954 uint32_t events; 955 }; 956 957 struct fuse_poll_out { 958 uint32_t revents; 959 uint32_t padding; 960 }; 961 962 struct fuse_notify_poll_wakeup_out { 963 uint64_t kh; 964 }; 965 966 struct fuse_fallocate_in { 967 uint64_t fh; 968 uint64_t offset; 969 uint64_t length; 970 uint32_t mode; 971 uint32_t padding; 972 }; 973 974 struct fuse_in_header { 975 uint32_t len; 976 uint32_t opcode; 977 uint64_t unique; 978 uint64_t nodeid; 979 uint32_t uid; 980 uint32_t gid; 981 uint32_t pid; 982 uint16_t total_extlen; /* length of extensions in 8byte units */ 983 uint16_t padding; 984 }; 985 986 struct fuse_out_header { 987 uint32_t len; 988 int32_t error; 989 uint64_t unique; 990 }; 991 992 struct fuse_dirent { 993 uint64_t ino; 994 uint64_t off; 995 uint32_t namelen; 996 uint32_t type; 997 char name[]; 998 }; 999 1000 /* Align variable length records to 64bit boundary */ 1001 #define FUSE_REC_ALIGN(x) \ 1002 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1)) 1003 1004 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name) 1005 #define FUSE_DIRENT_ALIGN(x) FUSE_REC_ALIGN(x) 1006 #define FUSE_DIRENT_SIZE(d) \ 1007 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen) 1008 1009 struct fuse_direntplus { 1010 struct fuse_entry_out entry_out; 1011 struct fuse_dirent dirent; 1012 }; 1013 1014 #define FUSE_NAME_OFFSET_DIRENTPLUS \ 1015 offsetof(struct fuse_direntplus, dirent.name) 1016 #define FUSE_DIRENTPLUS_SIZE(d) \ 1017 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen) 1018 1019 struct fuse_notify_inval_inode_out { 1020 uint64_t ino; 1021 int64_t off; 1022 int64_t len; 1023 }; 1024 1025 struct fuse_notify_inval_entry_out { 1026 uint64_t parent; 1027 uint32_t namelen; 1028 uint32_t flags; 1029 }; 1030 1031 struct fuse_notify_delete_out { 1032 uint64_t parent; 1033 uint64_t child; 1034 uint32_t namelen; 1035 uint32_t padding; 1036 }; 1037 1038 struct fuse_notify_store_out { 1039 uint64_t nodeid; 1040 uint64_t offset; 1041 uint32_t size; 1042 uint32_t padding; 1043 }; 1044 1045 struct fuse_notify_retrieve_out { 1046 uint64_t notify_unique; 1047 uint64_t nodeid; 1048 uint64_t offset; 1049 uint32_t size; 1050 uint32_t padding; 1051 }; 1052 1053 /* Matches the size of fuse_write_in */ 1054 struct fuse_notify_retrieve_in { 1055 uint64_t dummy1; 1056 uint64_t offset; 1057 uint32_t size; 1058 uint32_t dummy2; 1059 uint64_t dummy3; 1060 uint64_t dummy4; 1061 }; 1062 1063 struct fuse_backing_map { 1064 int32_t fd; 1065 uint32_t flags; 1066 uint64_t padding; 1067 }; 1068 1069 /* Device ioctls: */ 1070 #define FUSE_DEV_IOC_MAGIC 229 1071 #define FUSE_DEV_IOC_CLONE _IOR(FUSE_DEV_IOC_MAGIC, 0, uint32_t) 1072 #define FUSE_DEV_IOC_BACKING_OPEN _IOW(FUSE_DEV_IOC_MAGIC, 1, \ 1073 struct fuse_backing_map) 1074 #define FUSE_DEV_IOC_BACKING_CLOSE _IOW(FUSE_DEV_IOC_MAGIC, 2, uint32_t) 1075 1076 struct fuse_lseek_in { 1077 uint64_t fh; 1078 uint64_t offset; 1079 uint32_t whence; 1080 uint32_t padding; 1081 }; 1082 1083 struct fuse_lseek_out { 1084 uint64_t offset; 1085 }; 1086 1087 struct fuse_copy_file_range_in { 1088 uint64_t fh_in; 1089 uint64_t off_in; 1090 uint64_t nodeid_out; 1091 uint64_t fh_out; 1092 uint64_t off_out; 1093 uint64_t len; 1094 uint64_t flags; 1095 }; 1096 1097 #define FUSE_SETUPMAPPING_FLAG_WRITE (1ull << 0) 1098 #define FUSE_SETUPMAPPING_FLAG_READ (1ull << 1) 1099 struct fuse_setupmapping_in { 1100 /* An already open handle */ 1101 uint64_t fh; 1102 /* Offset into the file to start the mapping */ 1103 uint64_t foffset; 1104 /* Length of mapping required */ 1105 uint64_t len; 1106 /* Flags, FUSE_SETUPMAPPING_FLAG_* */ 1107 uint64_t flags; 1108 /* Offset in Memory Window */ 1109 uint64_t moffset; 1110 }; 1111 1112 struct fuse_removemapping_in { 1113 /* number of fuse_removemapping_one follows */ 1114 uint32_t count; 1115 }; 1116 1117 struct fuse_removemapping_one { 1118 /* Offset into the dax window start the unmapping */ 1119 uint64_t moffset; 1120 /* Length of mapping required */ 1121 uint64_t len; 1122 }; 1123 1124 #define FUSE_REMOVEMAPPING_MAX_ENTRY \ 1125 (PAGE_SIZE / sizeof(struct fuse_removemapping_one)) 1126 1127 struct fuse_syncfs_in { 1128 uint64_t padding; 1129 }; 1130 1131 /* 1132 * For each security context, send fuse_secctx with size of security context 1133 * fuse_secctx will be followed by security context name and this in turn 1134 * will be followed by actual context label. 1135 * fuse_secctx, name, context 1136 */ 1137 struct fuse_secctx { 1138 uint32_t size; 1139 uint32_t padding; 1140 }; 1141 1142 /* 1143 * Contains the information about how many fuse_secctx structures are being 1144 * sent and what's the total size of all security contexts (including 1145 * size of fuse_secctx_header). 1146 * 1147 */ 1148 struct fuse_secctx_header { 1149 uint32_t size; 1150 uint32_t nr_secctx; 1151 }; 1152 1153 /** 1154 * struct fuse_ext_header - extension header 1155 * @size: total size of this extension including this header 1156 * @type: type of extension 1157 * 1158 * This is made compatible with fuse_secctx_header by using type values > 1159 * FUSE_MAX_NR_SECCTX 1160 */ 1161 struct fuse_ext_header { 1162 uint32_t size; 1163 uint32_t type; 1164 }; 1165 1166 /** 1167 * struct fuse_supp_groups - Supplementary group extension 1168 * @nr_groups: number of supplementary groups 1169 * @groups: flexible array of group IDs 1170 */ 1171 struct fuse_supp_groups { 1172 uint32_t nr_groups; 1173 uint32_t groups[]; 1174 }; 1175 1176 #endif /* _LINUX_FUSE_H */ 1177