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