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