include/uapi/linux/fuse.h

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