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