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