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