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