blob: bf3c62dd71123cac396ecd7b48eaef925511e406 [file] [log] [blame]
Greg Kroah-Hartmane2be04c2017-11-01 15:09:13 +01001/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */
Miklos Szeredid8a5ba42005-09-09 13:10:26 -07002/*
Miklos Szeredi7e98d532013-02-07 11:58:12 +01003 This file defines the kernel interface of FUSE
Miklos Szeredi1f55ed02008-12-01 19:14:02 +01004 Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu>
Miklos Szeredid8a5ba42005-09-09 13:10:26 -07005
6 This program can be distributed under the terms of the GNU GPL.
7 See the file COPYING.
Miklos Szeredi7e98d532013-02-07 11:58:12 +01008
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.
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070034*/
35
Miklos Szeredic79e3222007-10-18 03:06:59 -070036/*
37 * This file defines the kernel interface of FUSE
38 *
39 * Protocol changelog:
40 *
Alan Somers9de55a32019-08-19 11:10:30 -060041 * 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 *
Miklos Szeredic79e3222007-10-18 03:06:59 -070078 * 7.9:
79 * - new fuse_getattr_in input argument of GETATTR
Miklos Szeredia9ff4f82007-10-18 03:07:02 -070080 * - add lk_flags in fuse_lk_in
Miklos Szeredif3332112007-10-18 03:07:04 -070081 * - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
Miklos Szeredi0e9663e2007-10-18 03:07:05 -070082 * - add blksize field to fuse_attr
Miklos Szeredia6643092007-11-28 16:22:00 -080083 * - add file flags field to fuse_read_in and fuse_write_in
Alan Somers7142fd12019-04-19 15:42:46 -060084 * - Add ATIME_NOW and MTIME_NOW flags to fuse_setattr_in
Tejun Heoa7c1b992008-10-16 16:08:57 +020085 *
86 * 7.10
87 * - add nonseekable open flag
Miklos Szeredi1f55ed02008-12-01 19:14:02 +010088 *
89 * 7.11
90 * - add IOCTL message
91 * - add unsolicited notification support
92 * - add POLL message and NOTIFY_POLL notification
Miklos Szeredie0a43dd2009-06-30 20:12:23 +020093 *
94 * 7.12
Alan Somers68065b82019-04-19 15:42:45 -060095 * - add umask flag to input argument of create, mknod and mkdir
John Muir3b463ae2009-05-31 11:13:57 -040096 * - add notification messages for invalidation of inodes and
97 * directory entries
Csaba Henk7a6d3c82009-07-01 17:28:41 -070098 *
99 * 7.13
100 * - make max number of background requests and congestion threshold
101 * tunables
Miklos Szeredidd3bb142010-05-25 15:06:06 +0200102 *
103 * 7.14
104 * - add splice support to fuse device
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200105 *
106 * 7.15
107 * - add store notify
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200108 * - add retrieve notify
Miklos Szeredi02c048b2010-12-07 20:16:56 +0100109 *
110 * 7.16
111 * - add BATCH_FORGET request
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100112 * - 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
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200115 *
116 * 7.17
117 * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
Miklos Szeredib18da0c2011-12-13 11:58:49 +0100118 *
119 * 7.18
120 * - add FUSE_IOCTL_DIR flag
John Muir451d0f52011-12-06 21:50:06 +0100121 * - add FUSE_NOTIFY_DELETE
Anatol Pomozov05ba1f02012-04-22 18:45:24 -0700122 *
123 * 7.19
124 * - add FUSE_FALLOCATE
Brian Foster72d0d242012-07-16 15:23:48 -0400125 *
126 * 7.20
127 * - add FUSE_AUTO_INVAL_DATA
Miklos Szeredi23c153e2013-01-31 17:08:11 +0100128 *
129 * 7.21
130 * - add FUSE_READDIRPLUS
Enke Chen0415d292013-02-04 16:14:32 +0100131 * - send the requested events in POLL request
Miklos Szeredi60b9df72013-05-01 14:37:21 +0200132 *
133 * 7.22
134 * - add FUSE_ASYNC_DIO
Pavel Emelyanov4d99ff82013-10-10 17:12:18 +0400135 *
136 * 7.23
137 * - add FUSE_WRITEBACK_CACHE
Miklos Szeredie27c9d32014-04-28 14:19:23 +0200138 * - add time_gran to fuse_init_out
139 * - add reserved space to fuse_init_out
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200140 * - add FATTR_CTIME
141 * - add ctime and ctimensec to fuse_setattr_in
Miklos Szeredi1560c972014-04-28 16:43:44 +0200142 * - add FUSE_RENAME2 request
Andrew Gallagherd7afaec2014-07-22 16:37:43 +0200143 * - add FUSE_NO_OPEN_SUPPORT flag
Ravishankar N0b5da8d2015-06-30 23:40:22 +0530144 *
145 * 7.24
146 * - add FUSE_LSEEK for SEEK_HOLE and SEEK_DATA support
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200147 *
148 * 7.25
149 * - add FUSE_PARALLEL_DIROPS
Miklos Szeredi5e940c12016-10-01 07:32:32 +0200150 *
151 * 7.26
152 * - add FUSE_HANDLE_KILLPRIV
Seth Forshee60bcc882016-08-29 08:46:37 -0500153 * - add FUSE_POSIX_ACL
Szymon Lukasz3b7008b2017-11-09 21:23:35 +0100154 *
155 * 7.27
156 * - add FUSE_ABORT_ERROR
Niels de Vos88bc7d52018-08-21 14:36:31 +0200157 *
158 * 7.28
159 * - add FUSE_COPY_FILE_RANGE
Miklos Szeredi6433b892018-09-28 16:43:23 +0200160 * - add FOPEN_CACHE_DIR
Constantine Shulyupin5da784c2018-09-06 15:37:06 +0300161 * - add FUSE_MAX_PAGES, add max_pages to init_out
Dan Schatzberg5571f1e2018-10-11 08:17:00 -0700162 * - add FUSE_CACHE_SYMLINKS
Chad Austind9a9ea92019-01-07 16:53:17 -0800163 *
164 * 7.29
165 * - add FUSE_NO_OPENDIR_SUPPORT flag
Kirill Smelkovad2ba642019-03-27 11:14:15 +0000166 *
167 * 7.30
168 * - add FUSE_EXPLICIT_INVAL_DATA
Ian Abbott6407f442019-04-24 15:14:11 +0100169 * - add FUSE_IOCTL_COMPAT_X32
Miklos Szeredi4a2abf92019-05-27 09:08:12 +0200170 *
171 * 7.31
172 * - add FUSE_WRITE_KILL_PRIV flag
Dr. David Alan Gilbertc4bb6672019-08-02 18:15:19 +0100173 * - add FUSE_SETUPMAPPING and FUSE_REMOVEMAPPING
174 * - add map_alignment to fuse_init_out, add FUSE_MAP_ALIGNMENT flag
Max Reitzc6ff2132020-09-08 18:01:48 +0200175 *
176 * 7.32
177 * - add flags to fuse_attr, add FUSE_ATTR_SUBMOUNT, add FUSE_SUBMOUNTS
Miklos Szeredic79e3222007-10-18 03:06:59 -0700178 */
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700179
Tejun Heo29d434b2008-10-16 16:08:57 +0200180#ifndef _LINUX_FUSE_H
181#define _LINUX_FUSE_H
182
Miklos Szeredi4c824562013-04-17 12:30:40 +0200183#ifdef __KERNEL__
Miklos Szeredi1f55ed02008-12-01 19:14:02 +0100184#include <linux/types.h>
Miklos Szeredi7e98d532013-02-07 11:58:12 +0100185#else
186#include <stdint.h>
Miklos Szeredi7e98d532013-02-07 11:58:12 +0100187#endif
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700188
Miklos Szeredi37d217f2009-07-08 18:17:58 +0200189/*
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
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700209/** Version number of this interface */
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700210#define FUSE_KERNEL_VERSION 7
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700211
212/** Minor version number of this interface */
Max Reitzc6ff2132020-09-08 18:01:48 +0200213#define FUSE_KERNEL_MINOR_VERSION 32
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700214
215/** The node ID of the root inode */
216#define FUSE_ROOT_ID 1
217
Miklos Szeredi06663262005-09-09 13:10:32 -0700218/* Make sure all structures are padded to 64bit boundary, so 32bit
219 userspace works under 64bit kernels */
220
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700221struct fuse_attr {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200222 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;
Max Reitzc6ff2132020-09-08 18:01:48 +0200237 uint32_t flags;
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700238};
239
Miklos Szeredie5e55582005-09-09 13:10:28 -0700240struct fuse_kstatfs {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200241 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];
Miklos Szeredie5e55582005-09-09 13:10:28 -0700251};
252
Miklos Szeredi71421252006-06-25 05:48:52 -0700253struct fuse_file_lock {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200254 uint64_t start;
255 uint64_t end;
256 uint32_t type;
257 uint32_t pid; /* tgid */
Miklos Szeredi71421252006-06-25 05:48:52 -0700258};
259
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800260/**
261 * Bitmasks for fuse_setattr_in.valid
262 */
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700263#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)
Miklos Szeredibefc6492005-11-07 00:59:52 -0800269#define FATTR_FH (1 << 6)
Miklos Szeredi17637cb2007-10-18 03:07:01 -0700270#define FATTR_ATIME_NOW (1 << 7)
271#define FATTR_MTIME_NOW (1 << 8)
Miklos Szeredif3332112007-10-18 03:07:04 -0700272#define FATTR_LOCKOWNER (1 << 9)
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200273#define FATTR_CTIME (1 << 10)
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700274
Miklos Szeredi45323fb2005-09-09 13:10:37 -0700275/**
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
Tejun Heoa7c1b992008-10-16 16:08:57 +0200280 * FOPEN_NONSEEKABLE: the file is not seekable
Miklos Szeredi6433b892018-09-28 16:43:23 +0200281 * FOPEN_CACHE_DIR: allow caching this directory
Kirill Smelkovbbd84f32019-04-24 07:13:57 +0000282 * FOPEN_STREAM: the file is stream-like (no file position at all)
Miklos Szeredi45323fb2005-09-09 13:10:37 -0700283 */
284#define FOPEN_DIRECT_IO (1 << 0)
285#define FOPEN_KEEP_CACHE (1 << 1)
Tejun Heoa7c1b992008-10-16 16:08:57 +0200286#define FOPEN_NONSEEKABLE (1 << 2)
Miklos Szeredi6433b892018-09-28 16:43:23 +0200287#define FOPEN_CACHE_DIR (1 << 3)
Kirill Smelkovbbd84f32019-04-24 07:13:57 +0000288#define FOPEN_STREAM (1 << 4)
Miklos Szeredi45323fb2005-09-09 13:10:37 -0700289
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800290/**
291 * INIT request/reply flags
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700292 *
Miklos Szeredif3840dc2012-07-18 16:09:40 +0200293 * FUSE_ASYNC_READ: asynchronous read requests
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200294 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
Miklos Szeredif3840dc2012-07-18 16:09:40 +0200295 * 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
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700297 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
Miklos Szeredif3840dc2012-07-18 16:09:40 +0200298 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200299 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200300 * 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
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200303 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200304 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
Brian Foster72d0d242012-07-16 15:23:48 -0400305 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
Eric Wong634734b2013-02-06 22:29:01 +0000306 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
307 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
Miklos Szeredi60b9df72013-05-01 14:37:21 +0200308 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
Pavel Emelyanov4d99ff82013-10-10 17:12:18 +0400309 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
Andrew Gallagherd7afaec2014-07-22 16:37:43 +0200310 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200311 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
Miklos Szeredi5e940c12016-10-01 07:32:32 +0200312 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
Seth Forshee60bcc882016-08-29 08:46:37 -0500313 * FUSE_POSIX_ACL: filesystem supports posix acls
Szymon Lukasz3b7008b2017-11-09 21:23:35 +0100314 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED
Constantine Shulyupin5da784c2018-09-06 15:37:06 +0300315 * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages
Dan Schatzberg5571f1e2018-10-11 08:17:00 -0700316 * FUSE_CACHE_SYMLINKS: cache READLINK responses
Chad Austind9a9ea92019-01-07 16:53:17 -0800317 * FUSE_NO_OPENDIR_SUPPORT: kernel supports zero-message opendir
Kirill Smelkovad2ba642019-03-27 11:14:15 +0000318 * FUSE_EXPLICIT_INVAL_DATA: only invalidate cached pages on explicit request
Stefan Hajnoczifd1a1dc2020-08-19 18:19:49 -0400319 * 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.
Max Reitzc6ff2132020-09-08 18:01:48 +0200322 * FUSE_SUBMOUNTS: kernel supports auto-mounting directory submounts
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800323 */
324#define FUSE_ASYNC_READ (1 << 0)
Miklos Szeredi71421252006-06-25 05:48:52 -0700325#define FUSE_POSIX_LOCKS (1 << 1)
Miklos Szeredic79e3222007-10-18 03:06:59 -0700326#define FUSE_FILE_OPS (1 << 2)
Miklos Szeredi6ff958e2007-10-18 03:07:02 -0700327#define FUSE_ATOMIC_O_TRUNC (1 << 3)
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700328#define FUSE_EXPORT_SUPPORT (1 << 4)
Miklos Szeredi78bb6cb2008-05-12 14:02:32 -0700329#define FUSE_BIG_WRITES (1 << 5)
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200330#define FUSE_DONT_MASK (1 << 6)
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200331#define FUSE_SPLICE_WRITE (1 << 7)
332#define FUSE_SPLICE_MOVE (1 << 8)
333#define FUSE_SPLICE_READ (1 << 9)
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200334#define FUSE_FLOCK_LOCKS (1 << 10)
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200335#define FUSE_HAS_IOCTL_DIR (1 << 11)
Brian Foster72d0d242012-07-16 15:23:48 -0400336#define FUSE_AUTO_INVAL_DATA (1 << 12)
Anand V. Avati0b05b182012-08-19 08:53:23 -0400337#define FUSE_DO_READDIRPLUS (1 << 13)
Eric Wong634734b2013-02-06 22:29:01 +0000338#define FUSE_READDIRPLUS_AUTO (1 << 14)
Miklos Szeredi60b9df72013-05-01 14:37:21 +0200339#define FUSE_ASYNC_DIO (1 << 15)
Pavel Emelyanov4d99ff82013-10-10 17:12:18 +0400340#define FUSE_WRITEBACK_CACHE (1 << 16)
Andrew Gallagherd7afaec2014-07-22 16:37:43 +0200341#define FUSE_NO_OPEN_SUPPORT (1 << 17)
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200342#define FUSE_PARALLEL_DIROPS (1 << 18)
Miklos Szeredi5e940c12016-10-01 07:32:32 +0200343#define FUSE_HANDLE_KILLPRIV (1 << 19)
Seth Forshee60bcc882016-08-29 08:46:37 -0500344#define FUSE_POSIX_ACL (1 << 20)
Szymon Lukasz3b7008b2017-11-09 21:23:35 +0100345#define FUSE_ABORT_ERROR (1 << 21)
Constantine Shulyupin5da784c2018-09-06 15:37:06 +0300346#define FUSE_MAX_PAGES (1 << 22)
Dan Schatzberg5571f1e2018-10-11 08:17:00 -0700347#define FUSE_CACHE_SYMLINKS (1 << 23)
Chad Austind9a9ea92019-01-07 16:53:17 -0800348#define FUSE_NO_OPENDIR_SUPPORT (1 << 24)
Kirill Smelkovad2ba642019-03-27 11:14:15 +0000349#define FUSE_EXPLICIT_INVAL_DATA (1 << 25)
Dr. David Alan Gilbertc4bb6672019-08-02 18:15:19 +0100350#define FUSE_MAP_ALIGNMENT (1 << 26)
Max Reitzc6ff2132020-09-08 18:01:48 +0200351#define FUSE_SUBMOUNTS (1 << 27)
Alessio Balsini9634f0e2021-01-25 17:02:28 +0000352#define FUSE_PASSTHROUGH (1 << 31)
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800353
Miklos Szeredie9168c12006-12-06 20:35:38 -0800354/**
Tejun Heo151060a2009-04-14 10:54:54 +0900355 * CUSE INIT request/reply flags
356 *
357 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
358 */
359#define CUSE_UNRESTRICTED_IOCTL (1 << 0)
360
361/**
Miklos Szeredie9168c12006-12-06 20:35:38 -0800362 * Release flags
363 */
364#define FUSE_RELEASE_FLUSH (1 << 0)
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200365#define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
Miklos Szeredie9168c12006-12-06 20:35:38 -0800366
Miklos Szeredic79e3222007-10-18 03:06:59 -0700367/**
368 * Getattr flags
369 */
370#define FUSE_GETATTR_FH (1 << 0)
371
Miklos Szeredia9ff4f82007-10-18 03:07:02 -0700372/**
373 * Lock flags
374 */
375#define FUSE_LK_FLOCK (1 << 0)
376
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700377/**
378 * WRITE flags
379 *
380 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
Miklos Szeredif3332112007-10-18 03:07:04 -0700381 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
Miklos Szeredi4a2abf92019-05-27 09:08:12 +0200382 * FUSE_WRITE_KILL_PRIV: kill suid and sgid bits
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700383 */
384#define FUSE_WRITE_CACHE (1 << 0)
Miklos Szeredif3332112007-10-18 03:07:04 -0700385#define FUSE_WRITE_LOCKOWNER (1 << 1)
Miklos Szeredi4a2abf92019-05-27 09:08:12 +0200386#define FUSE_WRITE_KILL_PRIV (1 << 2)
Miklos Szeredif3332112007-10-18 03:07:04 -0700387
388/**
389 * Read flags
390 */
391#define FUSE_READ_LOCKOWNER (1 << 1)
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700392
Tejun Heo59efec72008-11-26 12:03:55 +0100393/**
394 * Ioctl flags
395 *
396 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
397 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
398 * FUSE_IOCTL_RETRY: retry with new iovecs
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100399 * FUSE_IOCTL_32BIT: 32bit ioctl
Miklos Szeredib18da0c2011-12-13 11:58:49 +0100400 * FUSE_IOCTL_DIR: is a directory
Ian Abbott6407f442019-04-24 15:14:11 +0100401 * FUSE_IOCTL_COMPAT_X32: x32 compat ioctl on 64bit machine (64bit time_t)
Tejun Heo59efec72008-11-26 12:03:55 +0100402 *
403 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
404 */
405#define FUSE_IOCTL_COMPAT (1 << 0)
406#define FUSE_IOCTL_UNRESTRICTED (1 << 1)
407#define FUSE_IOCTL_RETRY (1 << 2)
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100408#define FUSE_IOCTL_32BIT (1 << 3)
Miklos Szeredib18da0c2011-12-13 11:58:49 +0100409#define FUSE_IOCTL_DIR (1 << 4)
Ian Abbott6407f442019-04-24 15:14:11 +0100410#define FUSE_IOCTL_COMPAT_X32 (1 << 5)
Tejun Heo59efec72008-11-26 12:03:55 +0100411
412#define FUSE_IOCTL_MAX_IOV 256
413
Tejun Heo95668a62008-11-26 12:03:55 +0100414/**
415 * Poll flags
416 *
417 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
418 */
419#define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
420
Alan Somers154603f2019-04-19 15:42:44 -0600421/**
422 * Fsync flags
423 *
424 * FUSE_FSYNC_FDATASYNC: Sync data only, not metadata
425 */
426#define FUSE_FSYNC_FDATASYNC (1 << 0)
427
Max Reitzc6ff2132020-09-08 18:01:48 +0200428/**
429 * fuse_attr flags
430 *
431 * FUSE_ATTR_SUBMOUNT: Object is a submount root
432 */
433#define FUSE_ATTR_SUBMOUNT (1 << 0)
434
Miklos Szeredi334f4852005-09-09 13:10:27 -0700435enum fuse_opcode {
Niels de Vos88bc7d52018-08-21 14:36:31 +0200436 FUSE_LOOKUP = 1,
437 FUSE_FORGET = 2, /* no reply */
438 FUSE_GETATTR = 3,
439 FUSE_SETATTR = 4,
440 FUSE_READLINK = 5,
441 FUSE_SYMLINK = 6,
442 FUSE_MKNOD = 8,
443 FUSE_MKDIR = 9,
444 FUSE_UNLINK = 10,
445 FUSE_RMDIR = 11,
446 FUSE_RENAME = 12,
447 FUSE_LINK = 13,
448 FUSE_OPEN = 14,
449 FUSE_READ = 15,
450 FUSE_WRITE = 16,
451 FUSE_STATFS = 17,
452 FUSE_RELEASE = 18,
453 FUSE_FSYNC = 20,
454 FUSE_SETXATTR = 21,
455 FUSE_GETXATTR = 22,
456 FUSE_LISTXATTR = 23,
457 FUSE_REMOVEXATTR = 24,
458 FUSE_FLUSH = 25,
459 FUSE_INIT = 26,
460 FUSE_OPENDIR = 27,
461 FUSE_READDIR = 28,
462 FUSE_RELEASEDIR = 29,
463 FUSE_FSYNCDIR = 30,
464 FUSE_GETLK = 31,
465 FUSE_SETLK = 32,
466 FUSE_SETLKW = 33,
467 FUSE_ACCESS = 34,
468 FUSE_CREATE = 35,
469 FUSE_INTERRUPT = 36,
470 FUSE_BMAP = 37,
471 FUSE_DESTROY = 38,
472 FUSE_IOCTL = 39,
473 FUSE_POLL = 40,
474 FUSE_NOTIFY_REPLY = 41,
475 FUSE_BATCH_FORGET = 42,
476 FUSE_FALLOCATE = 43,
477 FUSE_READDIRPLUS = 44,
478 FUSE_RENAME2 = 45,
479 FUSE_LSEEK = 46,
480 FUSE_COPY_FILE_RANGE = 47,
Dr. David Alan Gilbertc4bb6672019-08-02 18:15:19 +0100481 FUSE_SETUPMAPPING = 48,
482 FUSE_REMOVEMAPPING = 49,
Daniel Rosenbergaca26512016-04-22 00:00:48 -0700483 FUSE_CANONICAL_PATH = 2016,
Tejun Heo151060a2009-04-14 10:54:54 +0900484
485 /* CUSE specific operations */
Niels de Vos88bc7d52018-08-21 14:36:31 +0200486 CUSE_INIT = 4096,
Michael S. Tsirkin501ae8e2019-09-04 08:36:33 -0400487
488 /* Reserved opcodes: helpful to detect structure endian-ness */
489 CUSE_INIT_BSWAP_RESERVED = 1048576, /* CUSE_INIT << 8 */
490 FUSE_INIT_BSWAP_RESERVED = 436207616, /* FUSE_INIT << 24 */
Miklos Szeredi334f4852005-09-09 13:10:27 -0700491};
492
Tejun Heo85993962008-11-26 12:03:55 +0100493enum fuse_notify_code {
Tejun Heo95668a62008-11-26 12:03:55 +0100494 FUSE_NOTIFY_POLL = 1,
John Muir3b463ae2009-05-31 11:13:57 -0400495 FUSE_NOTIFY_INVAL_INODE = 2,
496 FUSE_NOTIFY_INVAL_ENTRY = 3,
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200497 FUSE_NOTIFY_STORE = 4,
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200498 FUSE_NOTIFY_RETRIEVE = 5,
John Muir451d0f52011-12-06 21:50:06 +0100499 FUSE_NOTIFY_DELETE = 6,
Tejun Heo85993962008-11-26 12:03:55 +0100500 FUSE_NOTIFY_CODE_MAX,
501};
502
Miklos Szeredi1d3d7522006-01-06 00:19:40 -0800503/* The read buffer is required to be at least 8k, but may be much larger */
504#define FUSE_MIN_READ_BUFFER 8192
Miklos Szeredie5e55582005-09-09 13:10:28 -0700505
Miklos Szeredi0e9663e2007-10-18 03:07:05 -0700506#define FUSE_COMPAT_ENTRY_OUT_SIZE 120
507
Miklos Szeredie5e55582005-09-09 13:10:28 -0700508struct fuse_entry_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200509 uint64_t nodeid; /* Inode ID */
510 uint64_t generation; /* Inode generation: nodeid:gen must
511 be unique for the fs's lifetime */
512 uint64_t entry_valid; /* Cache timeout for the name */
513 uint64_t attr_valid; /* Cache timeout for the attributes */
514 uint32_t entry_valid_nsec;
515 uint32_t attr_valid_nsec;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700516 struct fuse_attr attr;
517};
518
519struct fuse_forget_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200520 uint64_t nlookup;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700521};
522
Miklos Szeredi02c048b2010-12-07 20:16:56 +0100523struct fuse_forget_one {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200524 uint64_t nodeid;
525 uint64_t nlookup;
Miklos Szeredi02c048b2010-12-07 20:16:56 +0100526};
527
528struct fuse_batch_forget_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200529 uint32_t count;
530 uint32_t dummy;
Miklos Szeredi02c048b2010-12-07 20:16:56 +0100531};
532
Miklos Szeredic79e3222007-10-18 03:06:59 -0700533struct fuse_getattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200534 uint32_t getattr_flags;
535 uint32_t dummy;
536 uint64_t fh;
Miklos Szeredic79e3222007-10-18 03:06:59 -0700537};
538
Miklos Szeredi0e9663e2007-10-18 03:07:05 -0700539#define FUSE_COMPAT_ATTR_OUT_SIZE 96
540
Miklos Szeredie5e55582005-09-09 13:10:28 -0700541struct fuse_attr_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200542 uint64_t attr_valid; /* Cache timeout for the attributes */
543 uint32_t attr_valid_nsec;
544 uint32_t dummy;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700545 struct fuse_attr attr;
546};
547
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200548#define FUSE_COMPAT_MKNOD_IN_SIZE 8
549
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700550struct fuse_mknod_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200551 uint32_t mode;
552 uint32_t rdev;
553 uint32_t umask;
554 uint32_t padding;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700555};
556
557struct fuse_mkdir_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200558 uint32_t mode;
559 uint32_t umask;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700560};
561
562struct fuse_rename_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200563 uint64_t newdir;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700564};
565
Miklos Szeredi1560c972014-04-28 16:43:44 +0200566struct fuse_rename2_in {
567 uint64_t newdir;
568 uint32_t flags;
569 uint32_t padding;
570};
571
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700572struct fuse_link_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200573 uint64_t oldnodeid;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700574};
575
576struct fuse_setattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200577 uint32_t valid;
578 uint32_t padding;
579 uint64_t fh;
580 uint64_t size;
581 uint64_t lock_owner;
582 uint64_t atime;
583 uint64_t mtime;
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200584 uint64_t ctime;
Miklos Szeredi4c824562013-04-17 12:30:40 +0200585 uint32_t atimensec;
586 uint32_t mtimensec;
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200587 uint32_t ctimensec;
Miklos Szeredi4c824562013-04-17 12:30:40 +0200588 uint32_t mode;
589 uint32_t unused4;
590 uint32_t uid;
591 uint32_t gid;
592 uint32_t unused5;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700593};
594
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700595struct fuse_open_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200596 uint32_t flags;
597 uint32_t unused;
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200598};
599
600struct fuse_create_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200601 uint32_t flags;
602 uint32_t mode;
603 uint32_t umask;
604 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700605};
606
607struct fuse_open_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200608 uint64_t fh;
609 uint32_t open_flags;
Alessio Balsini9634f0e2021-01-25 17:02:28 +0000610 uint32_t passthrough_fh;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700611};
612
613struct fuse_release_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200614 uint64_t fh;
615 uint32_t flags;
616 uint32_t release_flags;
617 uint64_t lock_owner;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700618};
619
620struct fuse_flush_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200621 uint64_t fh;
622 uint32_t unused;
623 uint32_t padding;
624 uint64_t lock_owner;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700625};
626
627struct fuse_read_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200628 uint64_t fh;
629 uint64_t offset;
630 uint32_t size;
631 uint32_t read_flags;
632 uint64_t lock_owner;
633 uint32_t flags;
634 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700635};
636
Miklos Szeredif3332112007-10-18 03:07:04 -0700637#define FUSE_COMPAT_WRITE_IN_SIZE 24
638
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700639struct fuse_write_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200640 uint64_t fh;
641 uint64_t offset;
642 uint32_t size;
643 uint32_t write_flags;
644 uint64_t lock_owner;
645 uint32_t flags;
646 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700647};
648
649struct fuse_write_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200650 uint32_t size;
651 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700652};
653
Miklos Szeredide5f1202006-01-06 00:19:37 -0800654#define FUSE_COMPAT_STATFS_SIZE 48
655
Miklos Szeredie5e55582005-09-09 13:10:28 -0700656struct fuse_statfs_out {
657 struct fuse_kstatfs st;
658};
659
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700660struct fuse_fsync_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200661 uint64_t fh;
662 uint32_t fsync_flags;
663 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700664};
665
Miklos Szeredi92a87802005-09-09 13:10:31 -0700666struct fuse_setxattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200667 uint32_t size;
668 uint32_t flags;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700669};
670
671struct fuse_getxattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200672 uint32_t size;
673 uint32_t padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700674};
675
676struct fuse_getxattr_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200677 uint32_t size;
678 uint32_t padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700679};
680
Miklos Szeredi71421252006-06-25 05:48:52 -0700681struct fuse_lk_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200682 uint64_t fh;
683 uint64_t owner;
Miklos Szeredi71421252006-06-25 05:48:52 -0700684 struct fuse_file_lock lk;
Miklos Szeredi4c824562013-04-17 12:30:40 +0200685 uint32_t lk_flags;
686 uint32_t padding;
Miklos Szeredi71421252006-06-25 05:48:52 -0700687};
688
689struct fuse_lk_out {
690 struct fuse_file_lock lk;
691};
692
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800693struct fuse_access_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200694 uint32_t mask;
695 uint32_t padding;
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800696};
697
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800698struct fuse_init_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200699 uint32_t major;
700 uint32_t minor;
701 uint32_t max_readahead;
702 uint32_t flags;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700703};
704
Miklos Szeredie27c9d32014-04-28 14:19:23 +0200705#define FUSE_COMPAT_INIT_OUT_SIZE 8
706#define FUSE_COMPAT_22_INIT_OUT_SIZE 24
707
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800708struct fuse_init_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200709 uint32_t major;
710 uint32_t minor;
711 uint32_t max_readahead;
712 uint32_t flags;
713 uint16_t max_background;
714 uint16_t congestion_threshold;
715 uint32_t max_write;
Miklos Szeredie27c9d32014-04-28 14:19:23 +0200716 uint32_t time_gran;
Constantine Shulyupin5da784c2018-09-06 15:37:06 +0300717 uint16_t max_pages;
Dr. David Alan Gilbertc4bb6672019-08-02 18:15:19 +0100718 uint16_t map_alignment;
Constantine Shulyupin5da784c2018-09-06 15:37:06 +0300719 uint32_t unused[8];
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800720};
721
Tejun Heo151060a2009-04-14 10:54:54 +0900722#define CUSE_INIT_INFO_MAX 4096
723
724struct cuse_init_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200725 uint32_t major;
726 uint32_t minor;
727 uint32_t unused;
728 uint32_t flags;
Tejun Heo151060a2009-04-14 10:54:54 +0900729};
730
731struct cuse_init_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200732 uint32_t major;
733 uint32_t minor;
734 uint32_t unused;
735 uint32_t flags;
736 uint32_t max_read;
737 uint32_t max_write;
738 uint32_t dev_major; /* chardev major */
739 uint32_t dev_minor; /* chardev minor */
740 uint32_t spare[10];
Tejun Heo151060a2009-04-14 10:54:54 +0900741};
742
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700743struct fuse_interrupt_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200744 uint64_t unique;
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700745};
746
Miklos Szeredib2d22722006-12-06 20:35:51 -0800747struct fuse_bmap_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200748 uint64_t block;
749 uint32_t blocksize;
750 uint32_t padding;
Miklos Szeredib2d22722006-12-06 20:35:51 -0800751};
752
753struct fuse_bmap_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200754 uint64_t block;
Miklos Szeredib2d22722006-12-06 20:35:51 -0800755};
756
Tejun Heo59efec72008-11-26 12:03:55 +0100757struct fuse_ioctl_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200758 uint64_t fh;
759 uint32_t flags;
760 uint32_t cmd;
761 uint64_t arg;
762 uint32_t in_size;
763 uint32_t out_size;
Tejun Heo59efec72008-11-26 12:03:55 +0100764};
765
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100766struct fuse_ioctl_iovec {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200767 uint64_t base;
768 uint64_t len;
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100769};
770
Tejun Heo59efec72008-11-26 12:03:55 +0100771struct fuse_ioctl_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200772 int32_t result;
773 uint32_t flags;
774 uint32_t in_iovs;
775 uint32_t out_iovs;
Tejun Heo59efec72008-11-26 12:03:55 +0100776};
777
Tejun Heo95668a62008-11-26 12:03:55 +0100778struct fuse_poll_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200779 uint64_t fh;
780 uint64_t kh;
781 uint32_t flags;
782 uint32_t events;
Tejun Heo95668a62008-11-26 12:03:55 +0100783};
784
785struct fuse_poll_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200786 uint32_t revents;
787 uint32_t padding;
Tejun Heo95668a62008-11-26 12:03:55 +0100788};
789
790struct fuse_notify_poll_wakeup_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200791 uint64_t kh;
Tejun Heo95668a62008-11-26 12:03:55 +0100792};
793
Anatol Pomozov05ba1f02012-04-22 18:45:24 -0700794struct fuse_fallocate_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200795 uint64_t fh;
796 uint64_t offset;
797 uint64_t length;
798 uint32_t mode;
799 uint32_t padding;
Anatol Pomozov05ba1f02012-04-22 18:45:24 -0700800};
801
Miklos Szeredi334f4852005-09-09 13:10:27 -0700802struct fuse_in_header {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200803 uint32_t len;
804 uint32_t opcode;
805 uint64_t unique;
806 uint64_t nodeid;
807 uint32_t uid;
808 uint32_t gid;
809 uint32_t pid;
810 uint32_t padding;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700811};
812
813struct fuse_out_header {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200814 uint32_t len;
815 int32_t error;
816 uint64_t unique;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700817};
818
Miklos Szeredie5e55582005-09-09 13:10:28 -0700819struct fuse_dirent {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200820 uint64_t ino;
821 uint64_t off;
822 uint32_t namelen;
823 uint32_t type;
Miklos Szeredic628ee62012-04-12 12:57:08 +0200824 char name[];
Miklos Szeredie5e55582005-09-09 13:10:28 -0700825};
826
Andrew Morton21f3da92007-07-15 23:39:50 -0700827#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
Miklos Szeredi4c824562013-04-17 12:30:40 +0200828#define FUSE_DIRENT_ALIGN(x) \
829 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
Miklos Szeredie5e55582005-09-09 13:10:28 -0700830#define FUSE_DIRENT_SIZE(d) \
831 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
Tejun Heo29d434b2008-10-16 16:08:57 +0200832
Anand V. Avati0b05b182012-08-19 08:53:23 -0400833struct fuse_direntplus {
834 struct fuse_entry_out entry_out;
835 struct fuse_dirent dirent;
836};
837
838#define FUSE_NAME_OFFSET_DIRENTPLUS \
839 offsetof(struct fuse_direntplus, dirent.name)
840#define FUSE_DIRENTPLUS_SIZE(d) \
841 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
842
John Muir3b463ae2009-05-31 11:13:57 -0400843struct fuse_notify_inval_inode_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200844 uint64_t ino;
845 int64_t off;
846 int64_t len;
John Muir3b463ae2009-05-31 11:13:57 -0400847};
848
849struct fuse_notify_inval_entry_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200850 uint64_t parent;
851 uint32_t namelen;
852 uint32_t padding;
John Muir3b463ae2009-05-31 11:13:57 -0400853};
854
John Muir451d0f52011-12-06 21:50:06 +0100855struct fuse_notify_delete_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200856 uint64_t parent;
857 uint64_t child;
858 uint32_t namelen;
859 uint32_t padding;
John Muir451d0f52011-12-06 21:50:06 +0100860};
861
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200862struct fuse_notify_store_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200863 uint64_t nodeid;
864 uint64_t offset;
865 uint32_t size;
866 uint32_t padding;
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200867};
868
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200869struct fuse_notify_retrieve_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200870 uint64_t notify_unique;
871 uint64_t nodeid;
872 uint64_t offset;
873 uint32_t size;
874 uint32_t padding;
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200875};
876
877/* Matches the size of fuse_write_in */
878struct fuse_notify_retrieve_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200879 uint64_t dummy1;
880 uint64_t offset;
881 uint32_t size;
882 uint32_t dummy2;
883 uint64_t dummy3;
884 uint64_t dummy4;
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200885};
886
Miklos Szeredi00c570f2015-07-01 16:26:08 +0200887/* Device ioctls: */
Alessio Balsini7fe32352021-01-25 17:01:30 +0000888#define FUSE_DEV_IOC_MAGIC 229
889#define FUSE_DEV_IOC_CLONE _IOR(FUSE_DEV_IOC_MAGIC, 0, uint32_t)
Alessio Balsini5e424f82021-05-13 11:58:16 +0100890/* 127 is reserved for the V1 interface implementation in Android (deprecated) */
891/* 126 is reserved for the V2 interface implementation in Android */
892#define FUSE_DEV_IOC_PASSTHROUGH_OPEN _IOW(FUSE_DEV_IOC_MAGIC, 126, __u32)
Miklos Szeredi00c570f2015-07-01 16:26:08 +0200893
Ravishankar N0b5da8d2015-06-30 23:40:22 +0530894struct fuse_lseek_in {
895 uint64_t fh;
896 uint64_t offset;
897 uint32_t whence;
898 uint32_t padding;
899};
900
901struct fuse_lseek_out {
902 uint64_t offset;
903};
904
Niels de Vos88bc7d52018-08-21 14:36:31 +0200905struct fuse_copy_file_range_in {
906 uint64_t fh_in;
907 uint64_t off_in;
908 uint64_t nodeid_out;
909 uint64_t fh_out;
910 uint64_t off_out;
911 uint64_t len;
912 uint64_t flags;
913};
914
Vivek Goyalceec02d2020-08-19 18:19:50 -0400915#define FUSE_SETUPMAPPING_FLAG_WRITE (1ull << 0)
Vivek Goyalc2d0ad02020-08-19 18:19:51 -0400916#define FUSE_SETUPMAPPING_FLAG_READ (1ull << 1)
Vivek Goyalceec02d2020-08-19 18:19:50 -0400917struct fuse_setupmapping_in {
918 /* An already open handle */
919 uint64_t fh;
920 /* Offset into the file to start the mapping */
921 uint64_t foffset;
922 /* Length of mapping required */
923 uint64_t len;
924 /* Flags, FUSE_SETUPMAPPING_FLAG_* */
925 uint64_t flags;
926 /* Offset in Memory Window */
927 uint64_t moffset;
928};
929
930struct fuse_removemapping_in {
931 /* number of fuse_removemapping_one follows */
932 uint32_t count;
933};
934
935struct fuse_removemapping_one {
936 /* Offset into the dax window start the unmapping */
937 uint64_t moffset;
938 /* Length of mapping required */
939 uint64_t len;
940};
941
942#define FUSE_REMOVEMAPPING_MAX_ENTRY \
943 (PAGE_SIZE / sizeof(struct fuse_removemapping_one))
944
Tejun Heo29d434b2008-10-16 16:08:57 +0200945#endif /* _LINUX_FUSE_H */