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