blob: 54d9bbba8f2a361c8c9a198d81763c4f98dd5719 [file] [log] [blame]
Miklos Szeredid8a5ba42005-09-09 13:10:26 -07001/*
Miklos Szeredi7e98d532013-02-07 11:58:12 +01002 This file defines the kernel interface of FUSE
Miklos Szeredi1f55ed02008-12-01 19:14:02 +01003 Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu>
Miklos Szeredid8a5ba42005-09-09 13:10:26 -07004
5 This program can be distributed under the terms of the GNU GPL.
6 See the file COPYING.
Miklos Szeredi7e98d532013-02-07 11:58:12 +01007
8 This -- and only this -- header file may also be distributed under
9 the terms of the BSD Licence as follows:
10
11 Copyright (C) 2001-2007 Miklos Szeredi. All rights reserved.
12
13 Redistribution and use in source and binary forms, with or without
14 modification, are permitted provided that the following conditions
15 are met:
16 1. Redistributions of source code must retain the above copyright
17 notice, this list of conditions and the following disclaimer.
18 2. Redistributions in binary form must reproduce the above copyright
19 notice, this list of conditions and the following disclaimer in the
20 documentation and/or other materials provided with the distribution.
21
22 THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
26 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 SUCH DAMAGE.
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070033*/
34
Miklos Szeredic79e3222007-10-18 03:06:59 -070035/*
36 * This file defines the kernel interface of FUSE
37 *
38 * Protocol changelog:
39 *
40 * 7.9:
41 * - new fuse_getattr_in input argument of GETATTR
Miklos Szeredia9ff4f82007-10-18 03:07:02 -070042 * - add lk_flags in fuse_lk_in
Miklos Szeredif3332112007-10-18 03:07:04 -070043 * - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
Miklos Szeredi0e9663e2007-10-18 03:07:05 -070044 * - add blksize field to fuse_attr
Miklos Szeredia6643092007-11-28 16:22:00 -080045 * - add file flags field to fuse_read_in and fuse_write_in
Tejun Heoa7c1b992008-10-16 16:08:57 +020046 *
47 * 7.10
48 * - add nonseekable open flag
Miklos Szeredi1f55ed02008-12-01 19:14:02 +010049 *
50 * 7.11
51 * - add IOCTL message
52 * - add unsolicited notification support
53 * - add POLL message and NOTIFY_POLL notification
Miklos Szeredie0a43dd2009-06-30 20:12:23 +020054 *
55 * 7.12
56 * - add umask flag to input argument of open, mknod and mkdir
John Muir3b463ae2009-05-31 11:13:57 -040057 * - add notification messages for invalidation of inodes and
58 * directory entries
Csaba Henk7a6d3c82009-07-01 17:28:41 -070059 *
60 * 7.13
61 * - make max number of background requests and congestion threshold
62 * tunables
Miklos Szeredidd3bb142010-05-25 15:06:06 +020063 *
64 * 7.14
65 * - add splice support to fuse device
Miklos Szeredia1d75f22010-07-12 14:41:40 +020066 *
67 * 7.15
68 * - add store notify
Miklos Szeredi2d45ba32010-07-12 14:41:40 +020069 * - add retrieve notify
Miklos Szeredi02c048b2010-12-07 20:16:56 +010070 *
71 * 7.16
72 * - add BATCH_FORGET request
Miklos Szeredi1baa26b2010-12-07 20:16:56 +010073 * - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
74 * fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
75 * - add FUSE_IOCTL_32BIT flag
Miklos Szeredi37fb3a32011-08-08 16:08:08 +020076 *
77 * 7.17
78 * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
Miklos Szeredib18da0c2011-12-13 11:58:49 +010079 *
80 * 7.18
81 * - add FUSE_IOCTL_DIR flag
John Muir451d0f52011-12-06 21:50:06 +010082 * - add FUSE_NOTIFY_DELETE
Anatol Pomozov05ba1f02012-04-22 18:45:24 -070083 *
84 * 7.19
85 * - add FUSE_FALLOCATE
Brian Foster72d0d242012-07-16 15:23:48 -040086 *
87 * 7.20
88 * - add FUSE_AUTO_INVAL_DATA
Miklos Szeredi23c153e2013-01-31 17:08:11 +010089 *
90 * 7.21
91 * - add FUSE_READDIRPLUS
Enke Chen0415d292013-02-04 16:14:32 +010092 * - send the requested events in POLL request
Miklos Szeredi60b9df72013-05-01 14:37:21 +020093 *
94 * 7.22
95 * - add FUSE_ASYNC_DIO
Pavel Emelyanov4d99ff82013-10-10 17:12:18 +040096 *
97 * 7.23
98 * - add FUSE_WRITEBACK_CACHE
Miklos Szeredie27c9d32014-04-28 14:19:23 +020099 * - add time_gran to fuse_init_out
100 * - add reserved space to fuse_init_out
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200101 * - add FATTR_CTIME
102 * - add ctime and ctimensec to fuse_setattr_in
Miklos Szeredi1560c972014-04-28 16:43:44 +0200103 * - add FUSE_RENAME2 request
Andrew Gallagherd7afaec2014-07-22 16:37:43 +0200104 * - add FUSE_NO_OPEN_SUPPORT flag
Ravishankar N0b5da8d2015-06-30 23:40:22 +0530105 *
106 * 7.24
107 * - add FUSE_LSEEK for SEEK_HOLE and SEEK_DATA support
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200108 *
109 * 7.25
110 * - add FUSE_PARALLEL_DIROPS
Miklos Szeredi5e940c12016-10-01 07:32:32 +0200111 *
112 * 7.26
113 * - add FUSE_HANDLE_KILLPRIV
Seth Forshee60bcc882016-08-29 08:46:37 -0500114 * - add FUSE_POSIX_ACL
Miklos Szeredic79e3222007-10-18 03:06:59 -0700115 */
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700116
Tejun Heo29d434b2008-10-16 16:08:57 +0200117#ifndef _LINUX_FUSE_H
118#define _LINUX_FUSE_H
119
Miklos Szeredi4c824562013-04-17 12:30:40 +0200120#ifdef __KERNEL__
Miklos Szeredi1f55ed02008-12-01 19:14:02 +0100121#include <linux/types.h>
Miklos Szeredi7e98d532013-02-07 11:58:12 +0100122#else
123#include <stdint.h>
Miklos Szeredi7e98d532013-02-07 11:58:12 +0100124#endif
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700125
Miklos Szeredi37d217f2009-07-08 18:17:58 +0200126/*
127 * Version negotiation:
128 *
129 * Both the kernel and userspace send the version they support in the
130 * INIT request and reply respectively.
131 *
132 * If the major versions match then both shall use the smallest
133 * of the two minor versions for communication.
134 *
135 * If the kernel supports a larger major version, then userspace shall
136 * reply with the major version it supports, ignore the rest of the
137 * INIT message and expect a new INIT message from the kernel with a
138 * matching major version.
139 *
140 * If the library supports a larger major version, then it shall fall
141 * back to the major protocol version sent by the kernel for
142 * communication and reply with that major version (and an arbitrary
143 * supported minor version).
144 */
145
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700146/** Version number of this interface */
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700147#define FUSE_KERNEL_VERSION 7
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700148
149/** Minor version number of this interface */
Miklos Szeredi5e940c12016-10-01 07:32:32 +0200150#define FUSE_KERNEL_MINOR_VERSION 26
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700151
152/** The node ID of the root inode */
153#define FUSE_ROOT_ID 1
154
Miklos Szeredi06663262005-09-09 13:10:32 -0700155/* Make sure all structures are padded to 64bit boundary, so 32bit
156 userspace works under 64bit kernels */
157
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700158struct fuse_attr {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200159 uint64_t ino;
160 uint64_t size;
161 uint64_t blocks;
162 uint64_t atime;
163 uint64_t mtime;
164 uint64_t ctime;
165 uint32_t atimensec;
166 uint32_t mtimensec;
167 uint32_t ctimensec;
168 uint32_t mode;
169 uint32_t nlink;
170 uint32_t uid;
171 uint32_t gid;
172 uint32_t rdev;
173 uint32_t blksize;
174 uint32_t padding;
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700175};
176
Miklos Szeredie5e55582005-09-09 13:10:28 -0700177struct fuse_kstatfs {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200178 uint64_t blocks;
179 uint64_t bfree;
180 uint64_t bavail;
181 uint64_t files;
182 uint64_t ffree;
183 uint32_t bsize;
184 uint32_t namelen;
185 uint32_t frsize;
186 uint32_t padding;
187 uint32_t spare[6];
Miklos Szeredie5e55582005-09-09 13:10:28 -0700188};
189
Miklos Szeredi71421252006-06-25 05:48:52 -0700190struct fuse_file_lock {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200191 uint64_t start;
192 uint64_t end;
193 uint32_t type;
194 uint32_t pid; /* tgid */
Miklos Szeredi71421252006-06-25 05:48:52 -0700195};
196
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800197/**
198 * Bitmasks for fuse_setattr_in.valid
199 */
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700200#define FATTR_MODE (1 << 0)
201#define FATTR_UID (1 << 1)
202#define FATTR_GID (1 << 2)
203#define FATTR_SIZE (1 << 3)
204#define FATTR_ATIME (1 << 4)
205#define FATTR_MTIME (1 << 5)
Miklos Szeredibefc6492005-11-07 00:59:52 -0800206#define FATTR_FH (1 << 6)
Miklos Szeredi17637cb2007-10-18 03:07:01 -0700207#define FATTR_ATIME_NOW (1 << 7)
208#define FATTR_MTIME_NOW (1 << 8)
Miklos Szeredif3332112007-10-18 03:07:04 -0700209#define FATTR_LOCKOWNER (1 << 9)
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200210#define FATTR_CTIME (1 << 10)
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700211
Miklos Szeredi45323fb2005-09-09 13:10:37 -0700212/**
213 * Flags returned by the OPEN request
214 *
215 * FOPEN_DIRECT_IO: bypass page cache for this open file
216 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
Tejun Heoa7c1b992008-10-16 16:08:57 +0200217 * FOPEN_NONSEEKABLE: the file is not seekable
Kirill Smelkovcfd8d2e2019-04-24 07:13:57 +0000218 * FOPEN_STREAM: the file is stream-like (no file position at all)
Miklos Szeredi45323fb2005-09-09 13:10:37 -0700219 */
220#define FOPEN_DIRECT_IO (1 << 0)
221#define FOPEN_KEEP_CACHE (1 << 1)
Tejun Heoa7c1b992008-10-16 16:08:57 +0200222#define FOPEN_NONSEEKABLE (1 << 2)
Kirill Smelkovcfd8d2e2019-04-24 07:13:57 +0000223#define FOPEN_STREAM (1 << 4)
Miklos Szeredi45323fb2005-09-09 13:10:37 -0700224
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800225/**
226 * INIT request/reply flags
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700227 *
Miklos Szeredif3840dc2012-07-18 16:09:40 +0200228 * FUSE_ASYNC_READ: asynchronous read requests
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200229 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
Miklos Szeredif3840dc2012-07-18 16:09:40 +0200230 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
231 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700232 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
Miklos Szeredif3840dc2012-07-18 16:09:40 +0200233 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200234 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200235 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
236 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
237 * FUSE_SPLICE_READ: kernel supports splice read on the device
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200238 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200239 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
Brian Foster72d0d242012-07-16 15:23:48 -0400240 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
Eric Wong634734b2013-02-06 22:29:01 +0000241 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
242 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
Miklos Szeredi60b9df72013-05-01 14:37:21 +0200243 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
Pavel Emelyanov4d99ff82013-10-10 17:12:18 +0400244 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
Andrew Gallagherd7afaec2014-07-22 16:37:43 +0200245 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200246 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
Miklos Szeredi5e940c12016-10-01 07:32:32 +0200247 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
Seth Forshee60bcc882016-08-29 08:46:37 -0500248 * FUSE_POSIX_ACL: filesystem supports posix acls
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800249 */
250#define FUSE_ASYNC_READ (1 << 0)
Miklos Szeredi71421252006-06-25 05:48:52 -0700251#define FUSE_POSIX_LOCKS (1 << 1)
Miklos Szeredic79e3222007-10-18 03:06:59 -0700252#define FUSE_FILE_OPS (1 << 2)
Miklos Szeredi6ff958e2007-10-18 03:07:02 -0700253#define FUSE_ATOMIC_O_TRUNC (1 << 3)
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700254#define FUSE_EXPORT_SUPPORT (1 << 4)
Miklos Szeredi78bb6cb2008-05-12 14:02:32 -0700255#define FUSE_BIG_WRITES (1 << 5)
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200256#define FUSE_DONT_MASK (1 << 6)
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200257#define FUSE_SPLICE_WRITE (1 << 7)
258#define FUSE_SPLICE_MOVE (1 << 8)
259#define FUSE_SPLICE_READ (1 << 9)
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200260#define FUSE_FLOCK_LOCKS (1 << 10)
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200261#define FUSE_HAS_IOCTL_DIR (1 << 11)
Brian Foster72d0d242012-07-16 15:23:48 -0400262#define FUSE_AUTO_INVAL_DATA (1 << 12)
Anand V. Avati0b05b182012-08-19 08:53:23 -0400263#define FUSE_DO_READDIRPLUS (1 << 13)
Eric Wong634734b2013-02-06 22:29:01 +0000264#define FUSE_READDIRPLUS_AUTO (1 << 14)
Miklos Szeredi60b9df72013-05-01 14:37:21 +0200265#define FUSE_ASYNC_DIO (1 << 15)
Pavel Emelyanov4d99ff82013-10-10 17:12:18 +0400266#define FUSE_WRITEBACK_CACHE (1 << 16)
Andrew Gallagherd7afaec2014-07-22 16:37:43 +0200267#define FUSE_NO_OPEN_SUPPORT (1 << 17)
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200268#define FUSE_PARALLEL_DIROPS (1 << 18)
Miklos Szeredi5e940c12016-10-01 07:32:32 +0200269#define FUSE_HANDLE_KILLPRIV (1 << 19)
Seth Forshee60bcc882016-08-29 08:46:37 -0500270#define FUSE_POSIX_ACL (1 << 20)
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800271
Miklos Szeredie9168c12006-12-06 20:35:38 -0800272/**
Tejun Heo151060a2009-04-14 10:54:54 +0900273 * CUSE INIT request/reply flags
274 *
275 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
276 */
277#define CUSE_UNRESTRICTED_IOCTL (1 << 0)
278
279/**
Miklos Szeredie9168c12006-12-06 20:35:38 -0800280 * Release flags
281 */
282#define FUSE_RELEASE_FLUSH (1 << 0)
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200283#define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
Miklos Szeredie9168c12006-12-06 20:35:38 -0800284
Miklos Szeredic79e3222007-10-18 03:06:59 -0700285/**
286 * Getattr flags
287 */
288#define FUSE_GETATTR_FH (1 << 0)
289
Miklos Szeredia9ff4f82007-10-18 03:07:02 -0700290/**
291 * Lock flags
292 */
293#define FUSE_LK_FLOCK (1 << 0)
294
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700295/**
296 * WRITE flags
297 *
298 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
Miklos Szeredif3332112007-10-18 03:07:04 -0700299 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700300 */
301#define FUSE_WRITE_CACHE (1 << 0)
Miklos Szeredif3332112007-10-18 03:07:04 -0700302#define FUSE_WRITE_LOCKOWNER (1 << 1)
303
304/**
305 * Read flags
306 */
307#define FUSE_READ_LOCKOWNER (1 << 1)
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700308
Tejun Heo59efec72008-11-26 12:03:55 +0100309/**
310 * Ioctl flags
311 *
312 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
313 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
314 * FUSE_IOCTL_RETRY: retry with new iovecs
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100315 * FUSE_IOCTL_32BIT: 32bit ioctl
Miklos Szeredib18da0c2011-12-13 11:58:49 +0100316 * FUSE_IOCTL_DIR: is a directory
Tejun Heo59efec72008-11-26 12:03:55 +0100317 *
318 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
319 */
320#define FUSE_IOCTL_COMPAT (1 << 0)
321#define FUSE_IOCTL_UNRESTRICTED (1 << 1)
322#define FUSE_IOCTL_RETRY (1 << 2)
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100323#define FUSE_IOCTL_32BIT (1 << 3)
Miklos Szeredib18da0c2011-12-13 11:58:49 +0100324#define FUSE_IOCTL_DIR (1 << 4)
Tejun Heo59efec72008-11-26 12:03:55 +0100325
326#define FUSE_IOCTL_MAX_IOV 256
327
Tejun Heo95668a62008-11-26 12:03:55 +0100328/**
329 * Poll flags
330 *
331 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
332 */
333#define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
334
Miklos Szeredi334f4852005-09-09 13:10:27 -0700335enum fuse_opcode {
Miklos Szeredie5e55582005-09-09 13:10:28 -0700336 FUSE_LOOKUP = 1,
337 FUSE_FORGET = 2, /* no reply */
338 FUSE_GETATTR = 3,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700339 FUSE_SETATTR = 4,
Miklos Szeredie5e55582005-09-09 13:10:28 -0700340 FUSE_READLINK = 5,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700341 FUSE_SYMLINK = 6,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700342 FUSE_MKNOD = 8,
343 FUSE_MKDIR = 9,
344 FUSE_UNLINK = 10,
345 FUSE_RMDIR = 11,
346 FUSE_RENAME = 12,
347 FUSE_LINK = 13,
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700348 FUSE_OPEN = 14,
349 FUSE_READ = 15,
350 FUSE_WRITE = 16,
Miklos Szeredie5e55582005-09-09 13:10:28 -0700351 FUSE_STATFS = 17,
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700352 FUSE_RELEASE = 18,
353 FUSE_FSYNC = 20,
Miklos Szeredi92a87802005-09-09 13:10:31 -0700354 FUSE_SETXATTR = 21,
355 FUSE_GETXATTR = 22,
356 FUSE_LISTXATTR = 23,
357 FUSE_REMOVEXATTR = 24,
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700358 FUSE_FLUSH = 25,
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700359 FUSE_INIT = 26,
360 FUSE_OPENDIR = 27,
361 FUSE_READDIR = 28,
Miklos Szeredi82547982005-09-09 13:10:38 -0700362 FUSE_RELEASEDIR = 29,
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800363 FUSE_FSYNCDIR = 30,
Miklos Szeredi71421252006-06-25 05:48:52 -0700364 FUSE_GETLK = 31,
365 FUSE_SETLK = 32,
366 FUSE_SETLKW = 33,
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800367 FUSE_ACCESS = 34,
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700368 FUSE_CREATE = 35,
369 FUSE_INTERRUPT = 36,
Miklos Szeredib2d22722006-12-06 20:35:51 -0800370 FUSE_BMAP = 37,
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800371 FUSE_DESTROY = 38,
Tejun Heo59efec72008-11-26 12:03:55 +0100372 FUSE_IOCTL = 39,
Tejun Heo95668a62008-11-26 12:03:55 +0100373 FUSE_POLL = 40,
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200374 FUSE_NOTIFY_REPLY = 41,
Miklos Szeredi02c048b2010-12-07 20:16:56 +0100375 FUSE_BATCH_FORGET = 42,
Anatol Pomozov05ba1f02012-04-22 18:45:24 -0700376 FUSE_FALLOCATE = 43,
Anand V. Avati0b05b182012-08-19 08:53:23 -0400377 FUSE_READDIRPLUS = 44,
Miklos Szeredi1560c972014-04-28 16:43:44 +0200378 FUSE_RENAME2 = 45,
Ravishankar N0b5da8d2015-06-30 23:40:22 +0530379 FUSE_LSEEK = 46,
Daniel Rosenbergfac99a72016-04-22 00:00:48 -0700380 FUSE_CANONICAL_PATH= 2016,
Tejun Heo151060a2009-04-14 10:54:54 +0900381
382 /* CUSE specific operations */
383 CUSE_INIT = 4096,
Miklos Szeredi334f4852005-09-09 13:10:27 -0700384};
385
Tejun Heo85993962008-11-26 12:03:55 +0100386enum fuse_notify_code {
Tejun Heo95668a62008-11-26 12:03:55 +0100387 FUSE_NOTIFY_POLL = 1,
John Muir3b463ae2009-05-31 11:13:57 -0400388 FUSE_NOTIFY_INVAL_INODE = 2,
389 FUSE_NOTIFY_INVAL_ENTRY = 3,
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200390 FUSE_NOTIFY_STORE = 4,
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200391 FUSE_NOTIFY_RETRIEVE = 5,
John Muir451d0f52011-12-06 21:50:06 +0100392 FUSE_NOTIFY_DELETE = 6,
Tejun Heo85993962008-11-26 12:03:55 +0100393 FUSE_NOTIFY_CODE_MAX,
394};
395
Miklos Szeredi1d3d7522006-01-06 00:19:40 -0800396/* The read buffer is required to be at least 8k, but may be much larger */
397#define FUSE_MIN_READ_BUFFER 8192
Miklos Szeredie5e55582005-09-09 13:10:28 -0700398
Miklos Szeredi0e9663e2007-10-18 03:07:05 -0700399#define FUSE_COMPAT_ENTRY_OUT_SIZE 120
400
Miklos Szeredie5e55582005-09-09 13:10:28 -0700401struct fuse_entry_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200402 uint64_t nodeid; /* Inode ID */
403 uint64_t generation; /* Inode generation: nodeid:gen must
404 be unique for the fs's lifetime */
405 uint64_t entry_valid; /* Cache timeout for the name */
406 uint64_t attr_valid; /* Cache timeout for the attributes */
407 uint32_t entry_valid_nsec;
408 uint32_t attr_valid_nsec;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700409 struct fuse_attr attr;
410};
411
412struct fuse_forget_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200413 uint64_t nlookup;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700414};
415
Miklos Szeredi02c048b2010-12-07 20:16:56 +0100416struct fuse_forget_one {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200417 uint64_t nodeid;
418 uint64_t nlookup;
Miklos Szeredi02c048b2010-12-07 20:16:56 +0100419};
420
421struct fuse_batch_forget_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200422 uint32_t count;
423 uint32_t dummy;
Miklos Szeredi02c048b2010-12-07 20:16:56 +0100424};
425
Miklos Szeredic79e3222007-10-18 03:06:59 -0700426struct fuse_getattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200427 uint32_t getattr_flags;
428 uint32_t dummy;
429 uint64_t fh;
Miklos Szeredic79e3222007-10-18 03:06:59 -0700430};
431
Miklos Szeredi0e9663e2007-10-18 03:07:05 -0700432#define FUSE_COMPAT_ATTR_OUT_SIZE 96
433
Miklos Szeredie5e55582005-09-09 13:10:28 -0700434struct fuse_attr_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200435 uint64_t attr_valid; /* Cache timeout for the attributes */
436 uint32_t attr_valid_nsec;
437 uint32_t dummy;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700438 struct fuse_attr attr;
439};
440
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200441#define FUSE_COMPAT_MKNOD_IN_SIZE 8
442
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700443struct fuse_mknod_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200444 uint32_t mode;
445 uint32_t rdev;
446 uint32_t umask;
447 uint32_t padding;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700448};
449
450struct fuse_mkdir_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200451 uint32_t mode;
452 uint32_t umask;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700453};
454
455struct fuse_rename_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200456 uint64_t newdir;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700457};
458
Miklos Szeredi1560c972014-04-28 16:43:44 +0200459struct fuse_rename2_in {
460 uint64_t newdir;
461 uint32_t flags;
462 uint32_t padding;
463};
464
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700465struct fuse_link_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200466 uint64_t oldnodeid;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700467};
468
469struct fuse_setattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200470 uint32_t valid;
471 uint32_t padding;
472 uint64_t fh;
473 uint64_t size;
474 uint64_t lock_owner;
475 uint64_t atime;
476 uint64_t mtime;
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200477 uint64_t ctime;
Miklos Szeredi4c824562013-04-17 12:30:40 +0200478 uint32_t atimensec;
479 uint32_t mtimensec;
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200480 uint32_t ctimensec;
Miklos Szeredi4c824562013-04-17 12:30:40 +0200481 uint32_t mode;
482 uint32_t unused4;
483 uint32_t uid;
484 uint32_t gid;
485 uint32_t unused5;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700486};
487
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700488struct fuse_open_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200489 uint32_t flags;
490 uint32_t unused;
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200491};
492
493struct fuse_create_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200494 uint32_t flags;
495 uint32_t mode;
496 uint32_t umask;
497 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700498};
499
500struct fuse_open_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200501 uint64_t fh;
502 uint32_t open_flags;
503 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700504};
505
506struct fuse_release_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200507 uint64_t fh;
508 uint32_t flags;
509 uint32_t release_flags;
510 uint64_t lock_owner;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700511};
512
513struct fuse_flush_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200514 uint64_t fh;
515 uint32_t unused;
516 uint32_t padding;
517 uint64_t lock_owner;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700518};
519
520struct fuse_read_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200521 uint64_t fh;
522 uint64_t offset;
523 uint32_t size;
524 uint32_t read_flags;
525 uint64_t lock_owner;
526 uint32_t flags;
527 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700528};
529
Miklos Szeredif3332112007-10-18 03:07:04 -0700530#define FUSE_COMPAT_WRITE_IN_SIZE 24
531
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700532struct fuse_write_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200533 uint64_t fh;
534 uint64_t offset;
535 uint32_t size;
536 uint32_t write_flags;
537 uint64_t lock_owner;
538 uint32_t flags;
539 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700540};
541
542struct fuse_write_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200543 uint32_t size;
544 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700545};
546
Miklos Szeredide5f1202006-01-06 00:19:37 -0800547#define FUSE_COMPAT_STATFS_SIZE 48
548
Miklos Szeredie5e55582005-09-09 13:10:28 -0700549struct fuse_statfs_out {
550 struct fuse_kstatfs st;
551};
552
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700553struct fuse_fsync_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200554 uint64_t fh;
555 uint32_t fsync_flags;
556 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700557};
558
Miklos Szeredi92a87802005-09-09 13:10:31 -0700559struct fuse_setxattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200560 uint32_t size;
561 uint32_t flags;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700562};
563
564struct fuse_getxattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200565 uint32_t size;
566 uint32_t padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700567};
568
569struct fuse_getxattr_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200570 uint32_t size;
571 uint32_t padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700572};
573
Miklos Szeredi71421252006-06-25 05:48:52 -0700574struct fuse_lk_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200575 uint64_t fh;
576 uint64_t owner;
Miklos Szeredi71421252006-06-25 05:48:52 -0700577 struct fuse_file_lock lk;
Miklos Szeredi4c824562013-04-17 12:30:40 +0200578 uint32_t lk_flags;
579 uint32_t padding;
Miklos Szeredi71421252006-06-25 05:48:52 -0700580};
581
582struct fuse_lk_out {
583 struct fuse_file_lock lk;
584};
585
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800586struct fuse_access_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200587 uint32_t mask;
588 uint32_t padding;
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800589};
590
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800591struct fuse_init_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200592 uint32_t major;
593 uint32_t minor;
594 uint32_t max_readahead;
595 uint32_t flags;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700596};
597
Miklos Szeredie27c9d32014-04-28 14:19:23 +0200598#define FUSE_COMPAT_INIT_OUT_SIZE 8
599#define FUSE_COMPAT_22_INIT_OUT_SIZE 24
600
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800601struct fuse_init_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200602 uint32_t major;
603 uint32_t minor;
604 uint32_t max_readahead;
605 uint32_t flags;
606 uint16_t max_background;
607 uint16_t congestion_threshold;
608 uint32_t max_write;
Miklos Szeredie27c9d32014-04-28 14:19:23 +0200609 uint32_t time_gran;
610 uint32_t unused[9];
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800611};
612
Tejun Heo151060a2009-04-14 10:54:54 +0900613#define CUSE_INIT_INFO_MAX 4096
614
615struct cuse_init_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200616 uint32_t major;
617 uint32_t minor;
618 uint32_t unused;
619 uint32_t flags;
Tejun Heo151060a2009-04-14 10:54:54 +0900620};
621
622struct cuse_init_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200623 uint32_t major;
624 uint32_t minor;
625 uint32_t unused;
626 uint32_t flags;
627 uint32_t max_read;
628 uint32_t max_write;
629 uint32_t dev_major; /* chardev major */
630 uint32_t dev_minor; /* chardev minor */
631 uint32_t spare[10];
Tejun Heo151060a2009-04-14 10:54:54 +0900632};
633
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700634struct fuse_interrupt_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200635 uint64_t unique;
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700636};
637
Miklos Szeredib2d22722006-12-06 20:35:51 -0800638struct fuse_bmap_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200639 uint64_t block;
640 uint32_t blocksize;
641 uint32_t padding;
Miklos Szeredib2d22722006-12-06 20:35:51 -0800642};
643
644struct fuse_bmap_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200645 uint64_t block;
Miklos Szeredib2d22722006-12-06 20:35:51 -0800646};
647
Tejun Heo59efec72008-11-26 12:03:55 +0100648struct fuse_ioctl_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200649 uint64_t fh;
650 uint32_t flags;
651 uint32_t cmd;
652 uint64_t arg;
653 uint32_t in_size;
654 uint32_t out_size;
Tejun Heo59efec72008-11-26 12:03:55 +0100655};
656
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100657struct fuse_ioctl_iovec {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200658 uint64_t base;
659 uint64_t len;
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100660};
661
Tejun Heo59efec72008-11-26 12:03:55 +0100662struct fuse_ioctl_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200663 int32_t result;
664 uint32_t flags;
665 uint32_t in_iovs;
666 uint32_t out_iovs;
Tejun Heo59efec72008-11-26 12:03:55 +0100667};
668
Tejun Heo95668a62008-11-26 12:03:55 +0100669struct fuse_poll_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200670 uint64_t fh;
671 uint64_t kh;
672 uint32_t flags;
673 uint32_t events;
Tejun Heo95668a62008-11-26 12:03:55 +0100674};
675
676struct fuse_poll_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200677 uint32_t revents;
678 uint32_t padding;
Tejun Heo95668a62008-11-26 12:03:55 +0100679};
680
681struct fuse_notify_poll_wakeup_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200682 uint64_t kh;
Tejun Heo95668a62008-11-26 12:03:55 +0100683};
684
Anatol Pomozov05ba1f02012-04-22 18:45:24 -0700685struct fuse_fallocate_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200686 uint64_t fh;
687 uint64_t offset;
688 uint64_t length;
689 uint32_t mode;
690 uint32_t padding;
Anatol Pomozov05ba1f02012-04-22 18:45:24 -0700691};
692
Miklos Szeredi334f4852005-09-09 13:10:27 -0700693struct fuse_in_header {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200694 uint32_t len;
695 uint32_t opcode;
696 uint64_t unique;
697 uint64_t nodeid;
698 uint32_t uid;
699 uint32_t gid;
700 uint32_t pid;
701 uint32_t padding;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700702};
703
704struct fuse_out_header {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200705 uint32_t len;
706 int32_t error;
707 uint64_t unique;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700708};
709
Miklos Szeredie5e55582005-09-09 13:10:28 -0700710struct fuse_dirent {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200711 uint64_t ino;
712 uint64_t off;
713 uint32_t namelen;
714 uint32_t type;
Miklos Szeredic628ee62012-04-12 12:57:08 +0200715 char name[];
Miklos Szeredie5e55582005-09-09 13:10:28 -0700716};
717
Andrew Morton21f3da92007-07-15 23:39:50 -0700718#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
Miklos Szeredi4c824562013-04-17 12:30:40 +0200719#define FUSE_DIRENT_ALIGN(x) \
720 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
Miklos Szeredie5e55582005-09-09 13:10:28 -0700721#define FUSE_DIRENT_SIZE(d) \
722 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
Tejun Heo29d434b2008-10-16 16:08:57 +0200723
Anand V. Avati0b05b182012-08-19 08:53:23 -0400724struct fuse_direntplus {
725 struct fuse_entry_out entry_out;
726 struct fuse_dirent dirent;
727};
728
729#define FUSE_NAME_OFFSET_DIRENTPLUS \
730 offsetof(struct fuse_direntplus, dirent.name)
731#define FUSE_DIRENTPLUS_SIZE(d) \
732 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
733
John Muir3b463ae2009-05-31 11:13:57 -0400734struct fuse_notify_inval_inode_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200735 uint64_t ino;
736 int64_t off;
737 int64_t len;
John Muir3b463ae2009-05-31 11:13:57 -0400738};
739
740struct fuse_notify_inval_entry_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200741 uint64_t parent;
742 uint32_t namelen;
743 uint32_t padding;
John Muir3b463ae2009-05-31 11:13:57 -0400744};
745
John Muir451d0f52011-12-06 21:50:06 +0100746struct fuse_notify_delete_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200747 uint64_t parent;
748 uint64_t child;
749 uint32_t namelen;
750 uint32_t padding;
John Muir451d0f52011-12-06 21:50:06 +0100751};
752
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200753struct fuse_notify_store_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200754 uint64_t nodeid;
755 uint64_t offset;
756 uint32_t size;
757 uint32_t padding;
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200758};
759
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200760struct fuse_notify_retrieve_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200761 uint64_t notify_unique;
762 uint64_t nodeid;
763 uint64_t offset;
764 uint32_t size;
765 uint32_t padding;
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200766};
767
768/* Matches the size of fuse_write_in */
769struct fuse_notify_retrieve_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200770 uint64_t dummy1;
771 uint64_t offset;
772 uint32_t size;
773 uint32_t dummy2;
774 uint64_t dummy3;
775 uint64_t dummy4;
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200776};
777
Miklos Szeredi00c570f2015-07-01 16:26:08 +0200778/* Device ioctls: */
779#define FUSE_DEV_IOC_CLONE _IOR(229, 0, uint32_t)
780
Ravishankar N0b5da8d2015-06-30 23:40:22 +0530781struct fuse_lseek_in {
782 uint64_t fh;
783 uint64_t offset;
784 uint32_t whence;
785 uint32_t padding;
786};
787
788struct fuse_lseek_out {
789 uint64_t offset;
790};
791
Tejun Heo29d434b2008-10-16 16:08:57 +0200792#endif /* _LINUX_FUSE_H */