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