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