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