blob: 7233502ea991fa9e0342d154d86fdd0068debfe0 [file] [log] [blame]
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001/* 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 Brazdil0f672f62019-12-10 10:32:29 +000041 * 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 Scullb4b6d4a2019-01-02 15:54:55 +000078 * 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 Brazdil0f672f62019-12-10 10:32:29 +000084 * - Add ATIME_NOW and MTIME_NOW flags to fuse_setattr_in
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000085 *
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 Brazdil0f672f62019-12-10 10:32:29 +000095 * - add umask flag to input argument of create, mknod and mkdir
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000096 * - 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 Brazdil0f672f62019-12-10 10:32:29 +0000157 *
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
Olivier Deprez157378f2022-04-04 15:47:50 +0200175 *
176 * 7.32
177 * - add flags to fuse_attr, add FUSE_ATTR_SUBMOUNT, add FUSE_SUBMOUNTS
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000178 */
179
180#ifndef _LINUX_FUSE_H
181#define _LINUX_FUSE_H
182
183#ifdef __KERNEL__
184#include <linux/types.h>
185#else
186#include <stdint.h>
187#endif
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 */
Olivier Deprez157378f2022-04-04 15:47:50 +0200213#define FUSE_KERNEL_MINOR_VERSION 32
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000214
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;
Olivier Deprez157378f2022-04-04 15:47:50 +0200237 uint32_t flags;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000238};
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
275/**
276 * Flags returned by the OPEN request
277 *
278 * FOPEN_DIRECT_IO: bypass page cache for this open file
279 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
280 * FOPEN_NONSEEKABLE: the file is not seekable
David Brazdil0f672f62019-12-10 10:32:29 +0000281 * FOPEN_CACHE_DIR: allow caching this directory
282 * FOPEN_STREAM: the file is stream-like (no file position at all)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000283 */
284#define FOPEN_DIRECT_IO (1 << 0)
285#define FOPEN_KEEP_CACHE (1 << 1)
286#define FOPEN_NONSEEKABLE (1 << 2)
David Brazdil0f672f62019-12-10 10:32:29 +0000287#define FOPEN_CACHE_DIR (1 << 3)
288#define FOPEN_STREAM (1 << 4)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000289
290/**
291 * INIT request/reply flags
292 *
293 * FUSE_ASYNC_READ: asynchronous read requests
294 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
295 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
296 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
297 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
298 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
299 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
300 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
301 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
302 * FUSE_SPLICE_READ: kernel supports splice read on the device
303 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
304 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
305 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
306 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
307 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
308 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
309 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
310 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
311 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
312 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
313 * FUSE_POSIX_ACL: filesystem supports posix acls
314 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED
David Brazdil0f672f62019-12-10 10:32:29 +0000315 * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages
316 * FUSE_CACHE_SYMLINKS: cache READLINK responses
317 * FUSE_NO_OPENDIR_SUPPORT: kernel supports zero-message opendir
318 * FUSE_EXPLICIT_INVAL_DATA: only invalidate cached pages on explicit request
Olivier Deprez157378f2022-04-04 15:47:50 +0200319 * FUSE_MAP_ALIGNMENT: init_out.map_alignment contains log2(byte alignment) for
320 * foffset and moffset fields in struct
321 * fuse_setupmapping_out and fuse_removemapping_one.
322 * FUSE_SUBMOUNTS: kernel supports auto-mounting directory submounts
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000323 */
324#define FUSE_ASYNC_READ (1 << 0)
325#define FUSE_POSIX_LOCKS (1 << 1)
326#define FUSE_FILE_OPS (1 << 2)
327#define FUSE_ATOMIC_O_TRUNC (1 << 3)
328#define FUSE_EXPORT_SUPPORT (1 << 4)
329#define FUSE_BIG_WRITES (1 << 5)
330#define FUSE_DONT_MASK (1 << 6)
331#define FUSE_SPLICE_WRITE (1 << 7)
332#define FUSE_SPLICE_MOVE (1 << 8)
333#define FUSE_SPLICE_READ (1 << 9)
334#define FUSE_FLOCK_LOCKS (1 << 10)
335#define FUSE_HAS_IOCTL_DIR (1 << 11)
336#define FUSE_AUTO_INVAL_DATA (1 << 12)
337#define FUSE_DO_READDIRPLUS (1 << 13)
338#define FUSE_READDIRPLUS_AUTO (1 << 14)
339#define FUSE_ASYNC_DIO (1 << 15)
340#define FUSE_WRITEBACK_CACHE (1 << 16)
341#define FUSE_NO_OPEN_SUPPORT (1 << 17)
342#define FUSE_PARALLEL_DIROPS (1 << 18)
343#define FUSE_HANDLE_KILLPRIV (1 << 19)
344#define FUSE_POSIX_ACL (1 << 20)
345#define FUSE_ABORT_ERROR (1 << 21)
David Brazdil0f672f62019-12-10 10:32:29 +0000346#define FUSE_MAX_PAGES (1 << 22)
347#define FUSE_CACHE_SYMLINKS (1 << 23)
348#define FUSE_NO_OPENDIR_SUPPORT (1 << 24)
349#define FUSE_EXPLICIT_INVAL_DATA (1 << 25)
350#define FUSE_MAP_ALIGNMENT (1 << 26)
Olivier Deprez157378f2022-04-04 15:47:50 +0200351#define FUSE_SUBMOUNTS (1 << 27)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000352
353/**
354 * CUSE INIT request/reply flags
355 *
356 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
357 */
358#define CUSE_UNRESTRICTED_IOCTL (1 << 0)
359
360/**
361 * Release flags
362 */
363#define FUSE_RELEASE_FLUSH (1 << 0)
364#define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
365
366/**
367 * Getattr flags
368 */
369#define FUSE_GETATTR_FH (1 << 0)
370
371/**
372 * Lock flags
373 */
374#define FUSE_LK_FLOCK (1 << 0)
375
376/**
377 * WRITE flags
378 *
379 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
380 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
David Brazdil0f672f62019-12-10 10:32:29 +0000381 * FUSE_WRITE_KILL_PRIV: kill suid and sgid bits
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000382 */
383#define FUSE_WRITE_CACHE (1 << 0)
384#define FUSE_WRITE_LOCKOWNER (1 << 1)
David Brazdil0f672f62019-12-10 10:32:29 +0000385#define FUSE_WRITE_KILL_PRIV (1 << 2)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000386
387/**
388 * Read flags
389 */
390#define FUSE_READ_LOCKOWNER (1 << 1)
391
392/**
393 * Ioctl flags
394 *
395 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
396 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
397 * FUSE_IOCTL_RETRY: retry with new iovecs
398 * FUSE_IOCTL_32BIT: 32bit ioctl
399 * FUSE_IOCTL_DIR: is a directory
David Brazdil0f672f62019-12-10 10:32:29 +0000400 * FUSE_IOCTL_COMPAT_X32: x32 compat ioctl on 64bit machine (64bit time_t)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000401 *
402 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
403 */
404#define FUSE_IOCTL_COMPAT (1 << 0)
405#define FUSE_IOCTL_UNRESTRICTED (1 << 1)
406#define FUSE_IOCTL_RETRY (1 << 2)
407#define FUSE_IOCTL_32BIT (1 << 3)
408#define FUSE_IOCTL_DIR (1 << 4)
David Brazdil0f672f62019-12-10 10:32:29 +0000409#define FUSE_IOCTL_COMPAT_X32 (1 << 5)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000410
411#define FUSE_IOCTL_MAX_IOV 256
412
413/**
414 * Poll flags
415 *
416 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
417 */
418#define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
419
David Brazdil0f672f62019-12-10 10:32:29 +0000420/**
421 * Fsync flags
422 *
423 * FUSE_FSYNC_FDATASYNC: Sync data only, not metadata
424 */
425#define FUSE_FSYNC_FDATASYNC (1 << 0)
426
Olivier Deprez157378f2022-04-04 15:47:50 +0200427/**
428 * fuse_attr flags
429 *
430 * FUSE_ATTR_SUBMOUNT: Object is a submount root
431 */
432#define FUSE_ATTR_SUBMOUNT (1 << 0)
433
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000434enum fuse_opcode {
David Brazdil0f672f62019-12-10 10:32:29 +0000435 FUSE_LOOKUP = 1,
436 FUSE_FORGET = 2, /* no reply */
437 FUSE_GETATTR = 3,
438 FUSE_SETATTR = 4,
439 FUSE_READLINK = 5,
440 FUSE_SYMLINK = 6,
441 FUSE_MKNOD = 8,
442 FUSE_MKDIR = 9,
443 FUSE_UNLINK = 10,
444 FUSE_RMDIR = 11,
445 FUSE_RENAME = 12,
446 FUSE_LINK = 13,
447 FUSE_OPEN = 14,
448 FUSE_READ = 15,
449 FUSE_WRITE = 16,
450 FUSE_STATFS = 17,
451 FUSE_RELEASE = 18,
452 FUSE_FSYNC = 20,
453 FUSE_SETXATTR = 21,
454 FUSE_GETXATTR = 22,
455 FUSE_LISTXATTR = 23,
456 FUSE_REMOVEXATTR = 24,
457 FUSE_FLUSH = 25,
458 FUSE_INIT = 26,
459 FUSE_OPENDIR = 27,
460 FUSE_READDIR = 28,
461 FUSE_RELEASEDIR = 29,
462 FUSE_FSYNCDIR = 30,
463 FUSE_GETLK = 31,
464 FUSE_SETLK = 32,
465 FUSE_SETLKW = 33,
466 FUSE_ACCESS = 34,
467 FUSE_CREATE = 35,
468 FUSE_INTERRUPT = 36,
469 FUSE_BMAP = 37,
470 FUSE_DESTROY = 38,
471 FUSE_IOCTL = 39,
472 FUSE_POLL = 40,
473 FUSE_NOTIFY_REPLY = 41,
474 FUSE_BATCH_FORGET = 42,
475 FUSE_FALLOCATE = 43,
476 FUSE_READDIRPLUS = 44,
477 FUSE_RENAME2 = 45,
478 FUSE_LSEEK = 46,
479 FUSE_COPY_FILE_RANGE = 47,
480 FUSE_SETUPMAPPING = 48,
481 FUSE_REMOVEMAPPING = 49,
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000482
483 /* CUSE specific operations */
David Brazdil0f672f62019-12-10 10:32:29 +0000484 CUSE_INIT = 4096,
485
486 /* Reserved opcodes: helpful to detect structure endian-ness */
487 CUSE_INIT_BSWAP_RESERVED = 1048576, /* CUSE_INIT << 8 */
488 FUSE_INIT_BSWAP_RESERVED = 436207616, /* FUSE_INIT << 24 */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000489};
490
491enum fuse_notify_code {
492 FUSE_NOTIFY_POLL = 1,
493 FUSE_NOTIFY_INVAL_INODE = 2,
494 FUSE_NOTIFY_INVAL_ENTRY = 3,
495 FUSE_NOTIFY_STORE = 4,
496 FUSE_NOTIFY_RETRIEVE = 5,
497 FUSE_NOTIFY_DELETE = 6,
498 FUSE_NOTIFY_CODE_MAX,
499};
500
501/* The read buffer is required to be at least 8k, but may be much larger */
502#define FUSE_MIN_READ_BUFFER 8192
503
504#define FUSE_COMPAT_ENTRY_OUT_SIZE 120
505
506struct fuse_entry_out {
507 uint64_t nodeid; /* Inode ID */
508 uint64_t generation; /* Inode generation: nodeid:gen must
509 be unique for the fs's lifetime */
510 uint64_t entry_valid; /* Cache timeout for the name */
511 uint64_t attr_valid; /* Cache timeout for the attributes */
512 uint32_t entry_valid_nsec;
513 uint32_t attr_valid_nsec;
514 struct fuse_attr attr;
515};
516
517struct fuse_forget_in {
518 uint64_t nlookup;
519};
520
521struct fuse_forget_one {
522 uint64_t nodeid;
523 uint64_t nlookup;
524};
525
526struct fuse_batch_forget_in {
527 uint32_t count;
528 uint32_t dummy;
529};
530
531struct fuse_getattr_in {
532 uint32_t getattr_flags;
533 uint32_t dummy;
534 uint64_t fh;
535};
536
537#define FUSE_COMPAT_ATTR_OUT_SIZE 96
538
539struct fuse_attr_out {
540 uint64_t attr_valid; /* Cache timeout for the attributes */
541 uint32_t attr_valid_nsec;
542 uint32_t dummy;
543 struct fuse_attr attr;
544};
545
546#define FUSE_COMPAT_MKNOD_IN_SIZE 8
547
548struct fuse_mknod_in {
549 uint32_t mode;
550 uint32_t rdev;
551 uint32_t umask;
552 uint32_t padding;
553};
554
555struct fuse_mkdir_in {
556 uint32_t mode;
557 uint32_t umask;
558};
559
560struct fuse_rename_in {
561 uint64_t newdir;
562};
563
564struct fuse_rename2_in {
565 uint64_t newdir;
566 uint32_t flags;
567 uint32_t padding;
568};
569
570struct fuse_link_in {
571 uint64_t oldnodeid;
572};
573
574struct fuse_setattr_in {
575 uint32_t valid;
576 uint32_t padding;
577 uint64_t fh;
578 uint64_t size;
579 uint64_t lock_owner;
580 uint64_t atime;
581 uint64_t mtime;
582 uint64_t ctime;
583 uint32_t atimensec;
584 uint32_t mtimensec;
585 uint32_t ctimensec;
586 uint32_t mode;
587 uint32_t unused4;
588 uint32_t uid;
589 uint32_t gid;
590 uint32_t unused5;
591};
592
593struct fuse_open_in {
594 uint32_t flags;
595 uint32_t unused;
596};
597
598struct fuse_create_in {
599 uint32_t flags;
600 uint32_t mode;
601 uint32_t umask;
602 uint32_t padding;
603};
604
605struct fuse_open_out {
606 uint64_t fh;
607 uint32_t open_flags;
608 uint32_t padding;
609};
610
611struct fuse_release_in {
612 uint64_t fh;
613 uint32_t flags;
614 uint32_t release_flags;
615 uint64_t lock_owner;
616};
617
618struct fuse_flush_in {
619 uint64_t fh;
620 uint32_t unused;
621 uint32_t padding;
622 uint64_t lock_owner;
623};
624
625struct fuse_read_in {
626 uint64_t fh;
627 uint64_t offset;
628 uint32_t size;
629 uint32_t read_flags;
630 uint64_t lock_owner;
631 uint32_t flags;
632 uint32_t padding;
633};
634
635#define FUSE_COMPAT_WRITE_IN_SIZE 24
636
637struct fuse_write_in {
638 uint64_t fh;
639 uint64_t offset;
640 uint32_t size;
641 uint32_t write_flags;
642 uint64_t lock_owner;
643 uint32_t flags;
644 uint32_t padding;
645};
646
647struct fuse_write_out {
648 uint32_t size;
649 uint32_t padding;
650};
651
652#define FUSE_COMPAT_STATFS_SIZE 48
653
654struct fuse_statfs_out {
655 struct fuse_kstatfs st;
656};
657
658struct fuse_fsync_in {
659 uint64_t fh;
660 uint32_t fsync_flags;
661 uint32_t padding;
662};
663
664struct fuse_setxattr_in {
665 uint32_t size;
666 uint32_t flags;
667};
668
669struct fuse_getxattr_in {
670 uint32_t size;
671 uint32_t padding;
672};
673
674struct fuse_getxattr_out {
675 uint32_t size;
676 uint32_t padding;
677};
678
679struct fuse_lk_in {
680 uint64_t fh;
681 uint64_t owner;
682 struct fuse_file_lock lk;
683 uint32_t lk_flags;
684 uint32_t padding;
685};
686
687struct fuse_lk_out {
688 struct fuse_file_lock lk;
689};
690
691struct fuse_access_in {
692 uint32_t mask;
693 uint32_t padding;
694};
695
696struct fuse_init_in {
697 uint32_t major;
698 uint32_t minor;
699 uint32_t max_readahead;
700 uint32_t flags;
701};
702
703#define FUSE_COMPAT_INIT_OUT_SIZE 8
704#define FUSE_COMPAT_22_INIT_OUT_SIZE 24
705
706struct fuse_init_out {
707 uint32_t major;
708 uint32_t minor;
709 uint32_t max_readahead;
710 uint32_t flags;
711 uint16_t max_background;
712 uint16_t congestion_threshold;
713 uint32_t max_write;
714 uint32_t time_gran;
David Brazdil0f672f62019-12-10 10:32:29 +0000715 uint16_t max_pages;
716 uint16_t map_alignment;
717 uint32_t unused[8];
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000718};
719
720#define CUSE_INIT_INFO_MAX 4096
721
722struct cuse_init_in {
723 uint32_t major;
724 uint32_t minor;
725 uint32_t unused;
726 uint32_t flags;
727};
728
729struct cuse_init_out {
730 uint32_t major;
731 uint32_t minor;
732 uint32_t unused;
733 uint32_t flags;
734 uint32_t max_read;
735 uint32_t max_write;
736 uint32_t dev_major; /* chardev major */
737 uint32_t dev_minor; /* chardev minor */
738 uint32_t spare[10];
739};
740
741struct fuse_interrupt_in {
742 uint64_t unique;
743};
744
745struct fuse_bmap_in {
746 uint64_t block;
747 uint32_t blocksize;
748 uint32_t padding;
749};
750
751struct fuse_bmap_out {
752 uint64_t block;
753};
754
755struct fuse_ioctl_in {
756 uint64_t fh;
757 uint32_t flags;
758 uint32_t cmd;
759 uint64_t arg;
760 uint32_t in_size;
761 uint32_t out_size;
762};
763
764struct fuse_ioctl_iovec {
765 uint64_t base;
766 uint64_t len;
767};
768
769struct fuse_ioctl_out {
770 int32_t result;
771 uint32_t flags;
772 uint32_t in_iovs;
773 uint32_t out_iovs;
774};
775
776struct fuse_poll_in {
777 uint64_t fh;
778 uint64_t kh;
779 uint32_t flags;
780 uint32_t events;
781};
782
783struct fuse_poll_out {
784 uint32_t revents;
785 uint32_t padding;
786};
787
788struct fuse_notify_poll_wakeup_out {
789 uint64_t kh;
790};
791
792struct fuse_fallocate_in {
793 uint64_t fh;
794 uint64_t offset;
795 uint64_t length;
796 uint32_t mode;
797 uint32_t padding;
798};
799
800struct fuse_in_header {
801 uint32_t len;
802 uint32_t opcode;
803 uint64_t unique;
804 uint64_t nodeid;
805 uint32_t uid;
806 uint32_t gid;
807 uint32_t pid;
808 uint32_t padding;
809};
810
811struct fuse_out_header {
812 uint32_t len;
813 int32_t error;
814 uint64_t unique;
815};
816
817struct fuse_dirent {
818 uint64_t ino;
819 uint64_t off;
820 uint32_t namelen;
821 uint32_t type;
822 char name[];
823};
824
825#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
826#define FUSE_DIRENT_ALIGN(x) \
827 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
828#define FUSE_DIRENT_SIZE(d) \
829 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
830
831struct fuse_direntplus {
832 struct fuse_entry_out entry_out;
833 struct fuse_dirent dirent;
834};
835
836#define FUSE_NAME_OFFSET_DIRENTPLUS \
837 offsetof(struct fuse_direntplus, dirent.name)
838#define FUSE_DIRENTPLUS_SIZE(d) \
839 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
840
841struct fuse_notify_inval_inode_out {
842 uint64_t ino;
843 int64_t off;
844 int64_t len;
845};
846
847struct fuse_notify_inval_entry_out {
848 uint64_t parent;
849 uint32_t namelen;
850 uint32_t padding;
851};
852
853struct fuse_notify_delete_out {
854 uint64_t parent;
855 uint64_t child;
856 uint32_t namelen;
857 uint32_t padding;
858};
859
860struct fuse_notify_store_out {
861 uint64_t nodeid;
862 uint64_t offset;
863 uint32_t size;
864 uint32_t padding;
865};
866
867struct fuse_notify_retrieve_out {
868 uint64_t notify_unique;
869 uint64_t nodeid;
870 uint64_t offset;
871 uint32_t size;
872 uint32_t padding;
873};
874
875/* Matches the size of fuse_write_in */
876struct fuse_notify_retrieve_in {
877 uint64_t dummy1;
878 uint64_t offset;
879 uint32_t size;
880 uint32_t dummy2;
881 uint64_t dummy3;
882 uint64_t dummy4;
883};
884
885/* Device ioctls: */
886#define FUSE_DEV_IOC_CLONE _IOR(229, 0, uint32_t)
887
888struct fuse_lseek_in {
889 uint64_t fh;
890 uint64_t offset;
891 uint32_t whence;
892 uint32_t padding;
893};
894
895struct fuse_lseek_out {
896 uint64_t offset;
897};
898
David Brazdil0f672f62019-12-10 10:32:29 +0000899struct fuse_copy_file_range_in {
900 uint64_t fh_in;
901 uint64_t off_in;
902 uint64_t nodeid_out;
903 uint64_t fh_out;
904 uint64_t off_out;
905 uint64_t len;
906 uint64_t flags;
907};
908
Olivier Deprez157378f2022-04-04 15:47:50 +0200909#define FUSE_SETUPMAPPING_FLAG_WRITE (1ull << 0)
910#define FUSE_SETUPMAPPING_FLAG_READ (1ull << 1)
911struct fuse_setupmapping_in {
912 /* An already open handle */
913 uint64_t fh;
914 /* Offset into the file to start the mapping */
915 uint64_t foffset;
916 /* Length of mapping required */
917 uint64_t len;
918 /* Flags, FUSE_SETUPMAPPING_FLAG_* */
919 uint64_t flags;
920 /* Offset in Memory Window */
921 uint64_t moffset;
922};
923
924struct fuse_removemapping_in {
925 /* number of fuse_removemapping_one follows */
926 uint32_t count;
927};
928
929struct fuse_removemapping_one {
930 /* Offset into the dax window start the unmapping */
931 uint64_t moffset;
932 /* Length of mapping required */
933 uint64_t len;
934};
935
936#define FUSE_REMOVEMAPPING_MAX_ENTRY \
937 (PAGE_SIZE / sizeof(struct fuse_removemapping_one))
938
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000939#endif /* _LINUX_FUSE_H */