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