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