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