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