blob: 2ac598614a8fc7a8db337168c32bf1a4c376519c [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 *
41 * 7.9:
42 * - new fuse_getattr_in input argument of GETATTR
Miklos Szeredia9ff4f82007-10-18 03:07:02 -070043 * - add lk_flags in fuse_lk_in
Miklos Szeredif3332112007-10-18 03:07:04 -070044 * - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
Miklos Szeredi0e9663e2007-10-18 03:07:05 -070045 * - add blksize field to fuse_attr
Miklos Szeredia6643092007-11-28 16:22:00 -080046 * - add file flags field to fuse_read_in and fuse_write_in
Tejun Heoa7c1b992008-10-16 16:08:57 +020047 *
48 * 7.10
49 * - add nonseekable open flag
Miklos Szeredi1f55ed02008-12-01 19:14:02 +010050 *
51 * 7.11
52 * - add IOCTL message
53 * - add unsolicited notification support
54 * - add POLL message and NOTIFY_POLL notification
Miklos Szeredie0a43dd2009-06-30 20:12:23 +020055 *
56 * 7.12
57 * - add umask flag to input argument of open, mknod and mkdir
John Muir3b463ae2009-05-31 11:13:57 -040058 * - add notification messages for invalidation of inodes and
59 * directory entries
Csaba Henk7a6d3c82009-07-01 17:28:41 -070060 *
61 * 7.13
62 * - make max number of background requests and congestion threshold
63 * tunables
Miklos Szeredidd3bb142010-05-25 15:06:06 +020064 *
65 * 7.14
66 * - add splice support to fuse device
Miklos Szeredia1d75f22010-07-12 14:41:40 +020067 *
68 * 7.15
69 * - add store notify
Miklos Szeredi2d45ba32010-07-12 14:41:40 +020070 * - add retrieve notify
Miklos Szeredi02c048b2010-12-07 20:16:56 +010071 *
72 * 7.16
73 * - add BATCH_FORGET request
Miklos Szeredi1baa26b2010-12-07 20:16:56 +010074 * - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
75 * fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
76 * - add FUSE_IOCTL_32BIT flag
Miklos Szeredi37fb3a32011-08-08 16:08:08 +020077 *
78 * 7.17
79 * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
Miklos Szeredib18da0c2011-12-13 11:58:49 +010080 *
81 * 7.18
82 * - add FUSE_IOCTL_DIR flag
John Muir451d0f52011-12-06 21:50:06 +010083 * - add FUSE_NOTIFY_DELETE
Anatol Pomozov05ba1f02012-04-22 18:45:24 -070084 *
85 * 7.19
86 * - add FUSE_FALLOCATE
Brian Foster72d0d242012-07-16 15:23:48 -040087 *
88 * 7.20
89 * - add FUSE_AUTO_INVAL_DATA
Miklos Szeredi23c153e2013-01-31 17:08:11 +010090 *
91 * 7.21
92 * - add FUSE_READDIRPLUS
Enke Chen0415d292013-02-04 16:14:32 +010093 * - send the requested events in POLL request
Miklos Szeredi60b9df72013-05-01 14:37:21 +020094 *
95 * 7.22
96 * - add FUSE_ASYNC_DIO
Pavel Emelyanov4d99ff82013-10-10 17:12:18 +040097 *
98 * 7.23
99 * - add FUSE_WRITEBACK_CACHE
Miklos Szeredie27c9d32014-04-28 14:19:23 +0200100 * - add time_gran to fuse_init_out
101 * - add reserved space to fuse_init_out
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200102 * - add FATTR_CTIME
103 * - add ctime and ctimensec to fuse_setattr_in
Miklos Szeredi1560c972014-04-28 16:43:44 +0200104 * - add FUSE_RENAME2 request
Andrew Gallagherd7afaec2014-07-22 16:37:43 +0200105 * - add FUSE_NO_OPEN_SUPPORT flag
Ravishankar N0b5da8d2015-06-30 23:40:22 +0530106 *
107 * 7.24
108 * - add FUSE_LSEEK for SEEK_HOLE and SEEK_DATA support
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200109 *
110 * 7.25
111 * - add FUSE_PARALLEL_DIROPS
Miklos Szeredi5e940c12016-10-01 07:32:32 +0200112 *
113 * 7.26
114 * - add FUSE_HANDLE_KILLPRIV
Seth Forshee60bcc882016-08-29 08:46:37 -0500115 * - add FUSE_POSIX_ACL
Szymon Lukasz3b7008b2017-11-09 21:23:35 +0100116 *
117 * 7.27
118 * - add FUSE_ABORT_ERROR
Niels de Vos88bc7d52018-08-21 14:36:31 +0200119 *
120 * 7.28
121 * - add FUSE_COPY_FILE_RANGE
Miklos Szeredi6433b892018-09-28 16:43:23 +0200122 * - add FOPEN_CACHE_DIR
Constantine Shulyupin5da784c2018-09-06 15:37:06 +0300123 * - add FUSE_MAX_PAGES, add max_pages to init_out
Dan Schatzberg5571f1e2018-10-11 08:17:00 -0700124 * - add FUSE_CACHE_SYMLINKS
Chad Austind9a9ea92019-01-07 16:53:17 -0800125 *
126 * 7.29
127 * - add FUSE_NO_OPENDIR_SUPPORT flag
Miklos Szeredic79e3222007-10-18 03:06:59 -0700128 */
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700129
Tejun Heo29d434b2008-10-16 16:08:57 +0200130#ifndef _LINUX_FUSE_H
131#define _LINUX_FUSE_H
132
Miklos Szeredi4c824562013-04-17 12:30:40 +0200133#ifdef __KERNEL__
Miklos Szeredi1f55ed02008-12-01 19:14:02 +0100134#include <linux/types.h>
Miklos Szeredi7e98d532013-02-07 11:58:12 +0100135#else
136#include <stdint.h>
Miklos Szeredi7e98d532013-02-07 11:58:12 +0100137#endif
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700138
Miklos Szeredi37d217f2009-07-08 18:17:58 +0200139/*
140 * Version negotiation:
141 *
142 * Both the kernel and userspace send the version they support in the
143 * INIT request and reply respectively.
144 *
145 * If the major versions match then both shall use the smallest
146 * of the two minor versions for communication.
147 *
148 * If the kernel supports a larger major version, then userspace shall
149 * reply with the major version it supports, ignore the rest of the
150 * INIT message and expect a new INIT message from the kernel with a
151 * matching major version.
152 *
153 * If the library supports a larger major version, then it shall fall
154 * back to the major protocol version sent by the kernel for
155 * communication and reply with that major version (and an arbitrary
156 * supported minor version).
157 */
158
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700159/** Version number of this interface */
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700160#define FUSE_KERNEL_VERSION 7
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700161
162/** Minor version number of this interface */
Chad Austind9a9ea92019-01-07 16:53:17 -0800163#define FUSE_KERNEL_MINOR_VERSION 29
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700164
165/** The node ID of the root inode */
166#define FUSE_ROOT_ID 1
167
Miklos Szeredi06663262005-09-09 13:10:32 -0700168/* Make sure all structures are padded to 64bit boundary, so 32bit
169 userspace works under 64bit kernels */
170
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700171struct fuse_attr {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200172 uint64_t ino;
173 uint64_t size;
174 uint64_t blocks;
175 uint64_t atime;
176 uint64_t mtime;
177 uint64_t ctime;
178 uint32_t atimensec;
179 uint32_t mtimensec;
180 uint32_t ctimensec;
181 uint32_t mode;
182 uint32_t nlink;
183 uint32_t uid;
184 uint32_t gid;
185 uint32_t rdev;
186 uint32_t blksize;
187 uint32_t padding;
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700188};
189
Miklos Szeredie5e55582005-09-09 13:10:28 -0700190struct fuse_kstatfs {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200191 uint64_t blocks;
192 uint64_t bfree;
193 uint64_t bavail;
194 uint64_t files;
195 uint64_t ffree;
196 uint32_t bsize;
197 uint32_t namelen;
198 uint32_t frsize;
199 uint32_t padding;
200 uint32_t spare[6];
Miklos Szeredie5e55582005-09-09 13:10:28 -0700201};
202
Miklos Szeredi71421252006-06-25 05:48:52 -0700203struct fuse_file_lock {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200204 uint64_t start;
205 uint64_t end;
206 uint32_t type;
207 uint32_t pid; /* tgid */
Miklos Szeredi71421252006-06-25 05:48:52 -0700208};
209
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800210/**
211 * Bitmasks for fuse_setattr_in.valid
212 */
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700213#define FATTR_MODE (1 << 0)
214#define FATTR_UID (1 << 1)
215#define FATTR_GID (1 << 2)
216#define FATTR_SIZE (1 << 3)
217#define FATTR_ATIME (1 << 4)
218#define FATTR_MTIME (1 << 5)
Miklos Szeredibefc6492005-11-07 00:59:52 -0800219#define FATTR_FH (1 << 6)
Miklos Szeredi17637cb2007-10-18 03:07:01 -0700220#define FATTR_ATIME_NOW (1 << 7)
221#define FATTR_MTIME_NOW (1 << 8)
Miklos Szeredif3332112007-10-18 03:07:04 -0700222#define FATTR_LOCKOWNER (1 << 9)
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200223#define FATTR_CTIME (1 << 10)
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700224
Miklos Szeredi45323fb2005-09-09 13:10:37 -0700225/**
226 * Flags returned by the OPEN request
227 *
228 * FOPEN_DIRECT_IO: bypass page cache for this open file
229 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
Tejun Heoa7c1b992008-10-16 16:08:57 +0200230 * FOPEN_NONSEEKABLE: the file is not seekable
Miklos Szeredi6433b892018-09-28 16:43:23 +0200231 * FOPEN_CACHE_DIR: allow caching this directory
Miklos Szeredi45323fb2005-09-09 13:10:37 -0700232 */
233#define FOPEN_DIRECT_IO (1 << 0)
234#define FOPEN_KEEP_CACHE (1 << 1)
Tejun Heoa7c1b992008-10-16 16:08:57 +0200235#define FOPEN_NONSEEKABLE (1 << 2)
Miklos Szeredi6433b892018-09-28 16:43:23 +0200236#define FOPEN_CACHE_DIR (1 << 3)
Miklos Szeredi45323fb2005-09-09 13:10:37 -0700237
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800238/**
239 * INIT request/reply flags
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700240 *
Miklos Szeredif3840dc2012-07-18 16:09:40 +0200241 * FUSE_ASYNC_READ: asynchronous read requests
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200242 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
Miklos Szeredif3840dc2012-07-18 16:09:40 +0200243 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
244 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700245 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
Miklos Szeredif3840dc2012-07-18 16:09:40 +0200246 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200247 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200248 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
249 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
250 * FUSE_SPLICE_READ: kernel supports splice read on the device
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200251 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200252 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
Brian Foster72d0d242012-07-16 15:23:48 -0400253 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
Eric Wong634734b2013-02-06 22:29:01 +0000254 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
255 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
Miklos Szeredi60b9df72013-05-01 14:37:21 +0200256 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
Pavel Emelyanov4d99ff82013-10-10 17:12:18 +0400257 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
Andrew Gallagherd7afaec2014-07-22 16:37:43 +0200258 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200259 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
Miklos Szeredi5e940c12016-10-01 07:32:32 +0200260 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
Seth Forshee60bcc882016-08-29 08:46:37 -0500261 * FUSE_POSIX_ACL: filesystem supports posix acls
Szymon Lukasz3b7008b2017-11-09 21:23:35 +0100262 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED
Constantine Shulyupin5da784c2018-09-06 15:37:06 +0300263 * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages
Dan Schatzberg5571f1e2018-10-11 08:17:00 -0700264 * FUSE_CACHE_SYMLINKS: cache READLINK responses
Chad Austind9a9ea92019-01-07 16:53:17 -0800265 * FUSE_NO_OPENDIR_SUPPORT: kernel supports zero-message opendir
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800266 */
267#define FUSE_ASYNC_READ (1 << 0)
Miklos Szeredi71421252006-06-25 05:48:52 -0700268#define FUSE_POSIX_LOCKS (1 << 1)
Miklos Szeredic79e3222007-10-18 03:06:59 -0700269#define FUSE_FILE_OPS (1 << 2)
Miklos Szeredi6ff958e2007-10-18 03:07:02 -0700270#define FUSE_ATOMIC_O_TRUNC (1 << 3)
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700271#define FUSE_EXPORT_SUPPORT (1 << 4)
Miklos Szeredi78bb6cb2008-05-12 14:02:32 -0700272#define FUSE_BIG_WRITES (1 << 5)
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200273#define FUSE_DONT_MASK (1 << 6)
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200274#define FUSE_SPLICE_WRITE (1 << 7)
275#define FUSE_SPLICE_MOVE (1 << 8)
276#define FUSE_SPLICE_READ (1 << 9)
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200277#define FUSE_FLOCK_LOCKS (1 << 10)
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200278#define FUSE_HAS_IOCTL_DIR (1 << 11)
Brian Foster72d0d242012-07-16 15:23:48 -0400279#define FUSE_AUTO_INVAL_DATA (1 << 12)
Anand V. Avati0b05b182012-08-19 08:53:23 -0400280#define FUSE_DO_READDIRPLUS (1 << 13)
Eric Wong634734b2013-02-06 22:29:01 +0000281#define FUSE_READDIRPLUS_AUTO (1 << 14)
Miklos Szeredi60b9df72013-05-01 14:37:21 +0200282#define FUSE_ASYNC_DIO (1 << 15)
Pavel Emelyanov4d99ff82013-10-10 17:12:18 +0400283#define FUSE_WRITEBACK_CACHE (1 << 16)
Andrew Gallagherd7afaec2014-07-22 16:37:43 +0200284#define FUSE_NO_OPEN_SUPPORT (1 << 17)
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200285#define FUSE_PARALLEL_DIROPS (1 << 18)
Miklos Szeredi5e940c12016-10-01 07:32:32 +0200286#define FUSE_HANDLE_KILLPRIV (1 << 19)
Seth Forshee60bcc882016-08-29 08:46:37 -0500287#define FUSE_POSIX_ACL (1 << 20)
Szymon Lukasz3b7008b2017-11-09 21:23:35 +0100288#define FUSE_ABORT_ERROR (1 << 21)
Constantine Shulyupin5da784c2018-09-06 15:37:06 +0300289#define FUSE_MAX_PAGES (1 << 22)
Dan Schatzberg5571f1e2018-10-11 08:17:00 -0700290#define FUSE_CACHE_SYMLINKS (1 << 23)
Chad Austind9a9ea92019-01-07 16:53:17 -0800291#define FUSE_NO_OPENDIR_SUPPORT (1 << 24)
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800292
Miklos Szeredie9168c12006-12-06 20:35:38 -0800293/**
Tejun Heo151060a2009-04-14 10:54:54 +0900294 * CUSE INIT request/reply flags
295 *
296 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
297 */
298#define CUSE_UNRESTRICTED_IOCTL (1 << 0)
299
300/**
Miklos Szeredie9168c12006-12-06 20:35:38 -0800301 * Release flags
302 */
303#define FUSE_RELEASE_FLUSH (1 << 0)
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200304#define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
Miklos Szeredie9168c12006-12-06 20:35:38 -0800305
Miklos Szeredic79e3222007-10-18 03:06:59 -0700306/**
307 * Getattr flags
308 */
309#define FUSE_GETATTR_FH (1 << 0)
310
Miklos Szeredia9ff4f82007-10-18 03:07:02 -0700311/**
312 * Lock flags
313 */
314#define FUSE_LK_FLOCK (1 << 0)
315
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700316/**
317 * WRITE flags
318 *
319 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
Miklos Szeredif3332112007-10-18 03:07:04 -0700320 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700321 */
322#define FUSE_WRITE_CACHE (1 << 0)
Miklos Szeredif3332112007-10-18 03:07:04 -0700323#define FUSE_WRITE_LOCKOWNER (1 << 1)
324
325/**
326 * Read flags
327 */
328#define FUSE_READ_LOCKOWNER (1 << 1)
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700329
Tejun Heo59efec72008-11-26 12:03:55 +0100330/**
331 * Ioctl flags
332 *
333 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
334 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
335 * FUSE_IOCTL_RETRY: retry with new iovecs
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100336 * FUSE_IOCTL_32BIT: 32bit ioctl
Miklos Szeredib18da0c2011-12-13 11:58:49 +0100337 * FUSE_IOCTL_DIR: is a directory
Tejun Heo59efec72008-11-26 12:03:55 +0100338 *
339 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
340 */
341#define FUSE_IOCTL_COMPAT (1 << 0)
342#define FUSE_IOCTL_UNRESTRICTED (1 << 1)
343#define FUSE_IOCTL_RETRY (1 << 2)
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100344#define FUSE_IOCTL_32BIT (1 << 3)
Miklos Szeredib18da0c2011-12-13 11:58:49 +0100345#define FUSE_IOCTL_DIR (1 << 4)
Tejun Heo59efec72008-11-26 12:03:55 +0100346
347#define FUSE_IOCTL_MAX_IOV 256
348
Tejun Heo95668a62008-11-26 12:03:55 +0100349/**
350 * Poll flags
351 *
352 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
353 */
354#define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
355
Miklos Szeredi334f4852005-09-09 13:10:27 -0700356enum fuse_opcode {
Niels de Vos88bc7d52018-08-21 14:36:31 +0200357 FUSE_LOOKUP = 1,
358 FUSE_FORGET = 2, /* no reply */
359 FUSE_GETATTR = 3,
360 FUSE_SETATTR = 4,
361 FUSE_READLINK = 5,
362 FUSE_SYMLINK = 6,
363 FUSE_MKNOD = 8,
364 FUSE_MKDIR = 9,
365 FUSE_UNLINK = 10,
366 FUSE_RMDIR = 11,
367 FUSE_RENAME = 12,
368 FUSE_LINK = 13,
369 FUSE_OPEN = 14,
370 FUSE_READ = 15,
371 FUSE_WRITE = 16,
372 FUSE_STATFS = 17,
373 FUSE_RELEASE = 18,
374 FUSE_FSYNC = 20,
375 FUSE_SETXATTR = 21,
376 FUSE_GETXATTR = 22,
377 FUSE_LISTXATTR = 23,
378 FUSE_REMOVEXATTR = 24,
379 FUSE_FLUSH = 25,
380 FUSE_INIT = 26,
381 FUSE_OPENDIR = 27,
382 FUSE_READDIR = 28,
383 FUSE_RELEASEDIR = 29,
384 FUSE_FSYNCDIR = 30,
385 FUSE_GETLK = 31,
386 FUSE_SETLK = 32,
387 FUSE_SETLKW = 33,
388 FUSE_ACCESS = 34,
389 FUSE_CREATE = 35,
390 FUSE_INTERRUPT = 36,
391 FUSE_BMAP = 37,
392 FUSE_DESTROY = 38,
393 FUSE_IOCTL = 39,
394 FUSE_POLL = 40,
395 FUSE_NOTIFY_REPLY = 41,
396 FUSE_BATCH_FORGET = 42,
397 FUSE_FALLOCATE = 43,
398 FUSE_READDIRPLUS = 44,
399 FUSE_RENAME2 = 45,
400 FUSE_LSEEK = 46,
401 FUSE_COPY_FILE_RANGE = 47,
Tejun Heo151060a2009-04-14 10:54:54 +0900402
403 /* CUSE specific operations */
Niels de Vos88bc7d52018-08-21 14:36:31 +0200404 CUSE_INIT = 4096,
Miklos Szeredi334f4852005-09-09 13:10:27 -0700405};
406
Tejun Heo85993962008-11-26 12:03:55 +0100407enum fuse_notify_code {
Tejun Heo95668a62008-11-26 12:03:55 +0100408 FUSE_NOTIFY_POLL = 1,
John Muir3b463ae2009-05-31 11:13:57 -0400409 FUSE_NOTIFY_INVAL_INODE = 2,
410 FUSE_NOTIFY_INVAL_ENTRY = 3,
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200411 FUSE_NOTIFY_STORE = 4,
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200412 FUSE_NOTIFY_RETRIEVE = 5,
John Muir451d0f52011-12-06 21:50:06 +0100413 FUSE_NOTIFY_DELETE = 6,
Tejun Heo85993962008-11-26 12:03:55 +0100414 FUSE_NOTIFY_CODE_MAX,
415};
416
Miklos Szeredi1d3d7522006-01-06 00:19:40 -0800417/* The read buffer is required to be at least 8k, but may be much larger */
418#define FUSE_MIN_READ_BUFFER 8192
Miklos Szeredie5e55582005-09-09 13:10:28 -0700419
Miklos Szeredi0e9663e2007-10-18 03:07:05 -0700420#define FUSE_COMPAT_ENTRY_OUT_SIZE 120
421
Miklos Szeredie5e55582005-09-09 13:10:28 -0700422struct fuse_entry_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200423 uint64_t nodeid; /* Inode ID */
424 uint64_t generation; /* Inode generation: nodeid:gen must
425 be unique for the fs's lifetime */
426 uint64_t entry_valid; /* Cache timeout for the name */
427 uint64_t attr_valid; /* Cache timeout for the attributes */
428 uint32_t entry_valid_nsec;
429 uint32_t attr_valid_nsec;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700430 struct fuse_attr attr;
431};
432
433struct fuse_forget_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200434 uint64_t nlookup;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700435};
436
Miklos Szeredi02c048b2010-12-07 20:16:56 +0100437struct fuse_forget_one {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200438 uint64_t nodeid;
439 uint64_t nlookup;
Miklos Szeredi02c048b2010-12-07 20:16:56 +0100440};
441
442struct fuse_batch_forget_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200443 uint32_t count;
444 uint32_t dummy;
Miklos Szeredi02c048b2010-12-07 20:16:56 +0100445};
446
Miklos Szeredic79e3222007-10-18 03:06:59 -0700447struct fuse_getattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200448 uint32_t getattr_flags;
449 uint32_t dummy;
450 uint64_t fh;
Miklos Szeredic79e3222007-10-18 03:06:59 -0700451};
452
Miklos Szeredi0e9663e2007-10-18 03:07:05 -0700453#define FUSE_COMPAT_ATTR_OUT_SIZE 96
454
Miklos Szeredie5e55582005-09-09 13:10:28 -0700455struct fuse_attr_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200456 uint64_t attr_valid; /* Cache timeout for the attributes */
457 uint32_t attr_valid_nsec;
458 uint32_t dummy;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700459 struct fuse_attr attr;
460};
461
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200462#define FUSE_COMPAT_MKNOD_IN_SIZE 8
463
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700464struct fuse_mknod_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200465 uint32_t mode;
466 uint32_t rdev;
467 uint32_t umask;
468 uint32_t padding;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700469};
470
471struct fuse_mkdir_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200472 uint32_t mode;
473 uint32_t umask;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700474};
475
476struct fuse_rename_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200477 uint64_t newdir;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700478};
479
Miklos Szeredi1560c972014-04-28 16:43:44 +0200480struct fuse_rename2_in {
481 uint64_t newdir;
482 uint32_t flags;
483 uint32_t padding;
484};
485
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700486struct fuse_link_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200487 uint64_t oldnodeid;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700488};
489
490struct fuse_setattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200491 uint32_t valid;
492 uint32_t padding;
493 uint64_t fh;
494 uint64_t size;
495 uint64_t lock_owner;
496 uint64_t atime;
497 uint64_t mtime;
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200498 uint64_t ctime;
Miklos Szeredi4c824562013-04-17 12:30:40 +0200499 uint32_t atimensec;
500 uint32_t mtimensec;
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200501 uint32_t ctimensec;
Miklos Szeredi4c824562013-04-17 12:30:40 +0200502 uint32_t mode;
503 uint32_t unused4;
504 uint32_t uid;
505 uint32_t gid;
506 uint32_t unused5;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700507};
508
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700509struct fuse_open_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200510 uint32_t flags;
511 uint32_t unused;
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200512};
513
514struct fuse_create_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200515 uint32_t flags;
516 uint32_t mode;
517 uint32_t umask;
518 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700519};
520
521struct fuse_open_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200522 uint64_t fh;
523 uint32_t open_flags;
524 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700525};
526
527struct fuse_release_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200528 uint64_t fh;
529 uint32_t flags;
530 uint32_t release_flags;
531 uint64_t lock_owner;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700532};
533
534struct fuse_flush_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200535 uint64_t fh;
536 uint32_t unused;
537 uint32_t padding;
538 uint64_t lock_owner;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700539};
540
541struct fuse_read_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200542 uint64_t fh;
543 uint64_t offset;
544 uint32_t size;
545 uint32_t read_flags;
546 uint64_t lock_owner;
547 uint32_t flags;
548 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700549};
550
Miklos Szeredif3332112007-10-18 03:07:04 -0700551#define FUSE_COMPAT_WRITE_IN_SIZE 24
552
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700553struct fuse_write_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200554 uint64_t fh;
555 uint64_t offset;
556 uint32_t size;
557 uint32_t write_flags;
558 uint64_t lock_owner;
559 uint32_t flags;
560 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700561};
562
563struct fuse_write_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200564 uint32_t size;
565 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700566};
567
Miklos Szeredide5f1202006-01-06 00:19:37 -0800568#define FUSE_COMPAT_STATFS_SIZE 48
569
Miklos Szeredie5e55582005-09-09 13:10:28 -0700570struct fuse_statfs_out {
571 struct fuse_kstatfs st;
572};
573
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700574struct fuse_fsync_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200575 uint64_t fh;
576 uint32_t fsync_flags;
577 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700578};
579
Miklos Szeredi92a87802005-09-09 13:10:31 -0700580struct fuse_setxattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200581 uint32_t size;
582 uint32_t flags;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700583};
584
585struct fuse_getxattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200586 uint32_t size;
587 uint32_t padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700588};
589
590struct fuse_getxattr_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200591 uint32_t size;
592 uint32_t padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700593};
594
Miklos Szeredi71421252006-06-25 05:48:52 -0700595struct fuse_lk_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200596 uint64_t fh;
597 uint64_t owner;
Miklos Szeredi71421252006-06-25 05:48:52 -0700598 struct fuse_file_lock lk;
Miklos Szeredi4c824562013-04-17 12:30:40 +0200599 uint32_t lk_flags;
600 uint32_t padding;
Miklos Szeredi71421252006-06-25 05:48:52 -0700601};
602
603struct fuse_lk_out {
604 struct fuse_file_lock lk;
605};
606
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800607struct fuse_access_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200608 uint32_t mask;
609 uint32_t padding;
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800610};
611
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800612struct fuse_init_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200613 uint32_t major;
614 uint32_t minor;
615 uint32_t max_readahead;
616 uint32_t flags;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700617};
618
Miklos Szeredie27c9d32014-04-28 14:19:23 +0200619#define FUSE_COMPAT_INIT_OUT_SIZE 8
620#define FUSE_COMPAT_22_INIT_OUT_SIZE 24
621
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800622struct fuse_init_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200623 uint32_t major;
624 uint32_t minor;
625 uint32_t max_readahead;
626 uint32_t flags;
627 uint16_t max_background;
628 uint16_t congestion_threshold;
629 uint32_t max_write;
Miklos Szeredie27c9d32014-04-28 14:19:23 +0200630 uint32_t time_gran;
Constantine Shulyupin5da784c2018-09-06 15:37:06 +0300631 uint16_t max_pages;
632 uint16_t padding;
633 uint32_t unused[8];
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800634};
635
Tejun Heo151060a2009-04-14 10:54:54 +0900636#define CUSE_INIT_INFO_MAX 4096
637
638struct cuse_init_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200639 uint32_t major;
640 uint32_t minor;
641 uint32_t unused;
642 uint32_t flags;
Tejun Heo151060a2009-04-14 10:54:54 +0900643};
644
645struct cuse_init_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200646 uint32_t major;
647 uint32_t minor;
648 uint32_t unused;
649 uint32_t flags;
650 uint32_t max_read;
651 uint32_t max_write;
652 uint32_t dev_major; /* chardev major */
653 uint32_t dev_minor; /* chardev minor */
654 uint32_t spare[10];
Tejun Heo151060a2009-04-14 10:54:54 +0900655};
656
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700657struct fuse_interrupt_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200658 uint64_t unique;
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700659};
660
Miklos Szeredib2d22722006-12-06 20:35:51 -0800661struct fuse_bmap_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200662 uint64_t block;
663 uint32_t blocksize;
664 uint32_t padding;
Miklos Szeredib2d22722006-12-06 20:35:51 -0800665};
666
667struct fuse_bmap_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200668 uint64_t block;
Miklos Szeredib2d22722006-12-06 20:35:51 -0800669};
670
Tejun Heo59efec72008-11-26 12:03:55 +0100671struct fuse_ioctl_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200672 uint64_t fh;
673 uint32_t flags;
674 uint32_t cmd;
675 uint64_t arg;
676 uint32_t in_size;
677 uint32_t out_size;
Tejun Heo59efec72008-11-26 12:03:55 +0100678};
679
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100680struct fuse_ioctl_iovec {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200681 uint64_t base;
682 uint64_t len;
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100683};
684
Tejun Heo59efec72008-11-26 12:03:55 +0100685struct fuse_ioctl_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200686 int32_t result;
687 uint32_t flags;
688 uint32_t in_iovs;
689 uint32_t out_iovs;
Tejun Heo59efec72008-11-26 12:03:55 +0100690};
691
Tejun Heo95668a62008-11-26 12:03:55 +0100692struct fuse_poll_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200693 uint64_t fh;
694 uint64_t kh;
695 uint32_t flags;
696 uint32_t events;
Tejun Heo95668a62008-11-26 12:03:55 +0100697};
698
699struct fuse_poll_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200700 uint32_t revents;
701 uint32_t padding;
Tejun Heo95668a62008-11-26 12:03:55 +0100702};
703
704struct fuse_notify_poll_wakeup_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200705 uint64_t kh;
Tejun Heo95668a62008-11-26 12:03:55 +0100706};
707
Anatol Pomozov05ba1f02012-04-22 18:45:24 -0700708struct fuse_fallocate_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200709 uint64_t fh;
710 uint64_t offset;
711 uint64_t length;
712 uint32_t mode;
713 uint32_t padding;
Anatol Pomozov05ba1f02012-04-22 18:45:24 -0700714};
715
Miklos Szeredi334f4852005-09-09 13:10:27 -0700716struct fuse_in_header {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200717 uint32_t len;
718 uint32_t opcode;
719 uint64_t unique;
720 uint64_t nodeid;
721 uint32_t uid;
722 uint32_t gid;
723 uint32_t pid;
724 uint32_t padding;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700725};
726
727struct fuse_out_header {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200728 uint32_t len;
729 int32_t error;
730 uint64_t unique;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700731};
732
Miklos Szeredie5e55582005-09-09 13:10:28 -0700733struct fuse_dirent {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200734 uint64_t ino;
735 uint64_t off;
736 uint32_t namelen;
737 uint32_t type;
Miklos Szeredic628ee62012-04-12 12:57:08 +0200738 char name[];
Miklos Szeredie5e55582005-09-09 13:10:28 -0700739};
740
Andrew Morton21f3da92007-07-15 23:39:50 -0700741#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
Miklos Szeredi4c824562013-04-17 12:30:40 +0200742#define FUSE_DIRENT_ALIGN(x) \
743 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
Miklos Szeredie5e55582005-09-09 13:10:28 -0700744#define FUSE_DIRENT_SIZE(d) \
745 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
Tejun Heo29d434b2008-10-16 16:08:57 +0200746
Anand V. Avati0b05b182012-08-19 08:53:23 -0400747struct fuse_direntplus {
748 struct fuse_entry_out entry_out;
749 struct fuse_dirent dirent;
750};
751
752#define FUSE_NAME_OFFSET_DIRENTPLUS \
753 offsetof(struct fuse_direntplus, dirent.name)
754#define FUSE_DIRENTPLUS_SIZE(d) \
755 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
756
John Muir3b463ae2009-05-31 11:13:57 -0400757struct fuse_notify_inval_inode_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200758 uint64_t ino;
759 int64_t off;
760 int64_t len;
John Muir3b463ae2009-05-31 11:13:57 -0400761};
762
763struct fuse_notify_inval_entry_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200764 uint64_t parent;
765 uint32_t namelen;
766 uint32_t padding;
John Muir3b463ae2009-05-31 11:13:57 -0400767};
768
John Muir451d0f52011-12-06 21:50:06 +0100769struct fuse_notify_delete_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200770 uint64_t parent;
771 uint64_t child;
772 uint32_t namelen;
773 uint32_t padding;
John Muir451d0f52011-12-06 21:50:06 +0100774};
775
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200776struct fuse_notify_store_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200777 uint64_t nodeid;
778 uint64_t offset;
779 uint32_t size;
780 uint32_t padding;
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200781};
782
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200783struct fuse_notify_retrieve_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200784 uint64_t notify_unique;
785 uint64_t nodeid;
786 uint64_t offset;
787 uint32_t size;
788 uint32_t padding;
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200789};
790
791/* Matches the size of fuse_write_in */
792struct fuse_notify_retrieve_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200793 uint64_t dummy1;
794 uint64_t offset;
795 uint32_t size;
796 uint32_t dummy2;
797 uint64_t dummy3;
798 uint64_t dummy4;
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200799};
800
Miklos Szeredi00c570f2015-07-01 16:26:08 +0200801/* Device ioctls: */
802#define FUSE_DEV_IOC_CLONE _IOR(229, 0, uint32_t)
803
Ravishankar N0b5da8d2015-06-30 23:40:22 +0530804struct fuse_lseek_in {
805 uint64_t fh;
806 uint64_t offset;
807 uint32_t whence;
808 uint32_t padding;
809};
810
811struct fuse_lseek_out {
812 uint64_t offset;
813};
814
Niels de Vos88bc7d52018-08-21 14:36:31 +0200815struct fuse_copy_file_range_in {
816 uint64_t fh_in;
817 uint64_t off_in;
818 uint64_t nodeid_out;
819 uint64_t fh_out;
820 uint64_t off_out;
821 uint64_t len;
822 uint64_t flags;
823};
824
Tejun Heo29d434b2008-10-16 16:08:57 +0200825#endif /* _LINUX_FUSE_H */