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