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