blob: 093237817ed0b2b710d0dcf6a9f740460d7cf180 [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
Miklos Szeredi45323fb2005-09-09 13:10:37 -0700218 */
219#define FOPEN_DIRECT_IO (1 << 0)
220#define FOPEN_KEEP_CACHE (1 << 1)
Tejun Heoa7c1b992008-10-16 16:08:57 +0200221#define FOPEN_NONSEEKABLE (1 << 2)
Miklos Szeredi45323fb2005-09-09 13:10:37 -0700222
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800223/**
224 * INIT request/reply flags
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700225 *
Miklos Szeredif3840dc2012-07-18 16:09:40 +0200226 * FUSE_ASYNC_READ: asynchronous read requests
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200227 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
Miklos Szeredif3840dc2012-07-18 16:09:40 +0200228 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
229 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700230 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
Miklos Szeredif3840dc2012-07-18 16:09:40 +0200231 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200232 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200233 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
234 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
235 * FUSE_SPLICE_READ: kernel supports splice read on the device
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200236 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200237 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
Brian Foster72d0d242012-07-16 15:23:48 -0400238 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
Eric Wong634734b2013-02-06 22:29:01 +0000239 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
240 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
Miklos Szeredi60b9df72013-05-01 14:37:21 +0200241 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
Pavel Emelyanov4d99ff82013-10-10 17:12:18 +0400242 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
Andrew Gallagherd7afaec2014-07-22 16:37:43 +0200243 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200244 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
Miklos Szeredi5e940c12016-10-01 07:32:32 +0200245 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
Seth Forshee60bcc882016-08-29 08:46:37 -0500246 * FUSE_POSIX_ACL: filesystem supports posix acls
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800247 */
248#define FUSE_ASYNC_READ (1 << 0)
Miklos Szeredi71421252006-06-25 05:48:52 -0700249#define FUSE_POSIX_LOCKS (1 << 1)
Miklos Szeredic79e3222007-10-18 03:06:59 -0700250#define FUSE_FILE_OPS (1 << 2)
Miklos Szeredi6ff958e2007-10-18 03:07:02 -0700251#define FUSE_ATOMIC_O_TRUNC (1 << 3)
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700252#define FUSE_EXPORT_SUPPORT (1 << 4)
Miklos Szeredi78bb6cb2008-05-12 14:02:32 -0700253#define FUSE_BIG_WRITES (1 << 5)
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200254#define FUSE_DONT_MASK (1 << 6)
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200255#define FUSE_SPLICE_WRITE (1 << 7)
256#define FUSE_SPLICE_MOVE (1 << 8)
257#define FUSE_SPLICE_READ (1 << 9)
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200258#define FUSE_FLOCK_LOCKS (1 << 10)
Miklos Szeredi69fe05c2012-07-18 16:09:40 +0200259#define FUSE_HAS_IOCTL_DIR (1 << 11)
Brian Foster72d0d242012-07-16 15:23:48 -0400260#define FUSE_AUTO_INVAL_DATA (1 << 12)
Anand V. Avati0b05b182012-08-19 08:53:23 -0400261#define FUSE_DO_READDIRPLUS (1 << 13)
Eric Wong634734b2013-02-06 22:29:01 +0000262#define FUSE_READDIRPLUS_AUTO (1 << 14)
Miklos Szeredi60b9df72013-05-01 14:37:21 +0200263#define FUSE_ASYNC_DIO (1 << 15)
Pavel Emelyanov4d99ff82013-10-10 17:12:18 +0400264#define FUSE_WRITEBACK_CACHE (1 << 16)
Andrew Gallagherd7afaec2014-07-22 16:37:43 +0200265#define FUSE_NO_OPEN_SUPPORT (1 << 17)
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200266#define FUSE_PARALLEL_DIROPS (1 << 18)
Miklos Szeredi5e940c12016-10-01 07:32:32 +0200267#define FUSE_HANDLE_KILLPRIV (1 << 19)
Seth Forshee60bcc882016-08-29 08:46:37 -0500268#define FUSE_POSIX_ACL (1 << 20)
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800269
Miklos Szeredie9168c12006-12-06 20:35:38 -0800270/**
Tejun Heo151060a2009-04-14 10:54:54 +0900271 * CUSE INIT request/reply flags
272 *
273 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
274 */
275#define CUSE_UNRESTRICTED_IOCTL (1 << 0)
276
277/**
Miklos Szeredie9168c12006-12-06 20:35:38 -0800278 * Release flags
279 */
280#define FUSE_RELEASE_FLUSH (1 << 0)
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200281#define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
Miklos Szeredie9168c12006-12-06 20:35:38 -0800282
Miklos Szeredic79e3222007-10-18 03:06:59 -0700283/**
284 * Getattr flags
285 */
286#define FUSE_GETATTR_FH (1 << 0)
287
Miklos Szeredia9ff4f82007-10-18 03:07:02 -0700288/**
289 * Lock flags
290 */
291#define FUSE_LK_FLOCK (1 << 0)
292
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700293/**
294 * WRITE flags
295 *
296 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
Miklos Szeredif3332112007-10-18 03:07:04 -0700297 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700298 */
299#define FUSE_WRITE_CACHE (1 << 0)
Miklos Szeredif3332112007-10-18 03:07:04 -0700300#define FUSE_WRITE_LOCKOWNER (1 << 1)
301
302/**
303 * Read flags
304 */
305#define FUSE_READ_LOCKOWNER (1 << 1)
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700306
Tejun Heo59efec72008-11-26 12:03:55 +0100307/**
308 * Ioctl flags
309 *
310 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
311 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
312 * FUSE_IOCTL_RETRY: retry with new iovecs
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100313 * FUSE_IOCTL_32BIT: 32bit ioctl
Miklos Szeredib18da0c2011-12-13 11:58:49 +0100314 * FUSE_IOCTL_DIR: is a directory
Tejun Heo59efec72008-11-26 12:03:55 +0100315 *
316 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
317 */
318#define FUSE_IOCTL_COMPAT (1 << 0)
319#define FUSE_IOCTL_UNRESTRICTED (1 << 1)
320#define FUSE_IOCTL_RETRY (1 << 2)
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100321#define FUSE_IOCTL_32BIT (1 << 3)
Miklos Szeredib18da0c2011-12-13 11:58:49 +0100322#define FUSE_IOCTL_DIR (1 << 4)
Tejun Heo59efec72008-11-26 12:03:55 +0100323
324#define FUSE_IOCTL_MAX_IOV 256
325
Tejun Heo95668a62008-11-26 12:03:55 +0100326/**
327 * Poll flags
328 *
329 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
330 */
331#define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
332
Miklos Szeredi334f4852005-09-09 13:10:27 -0700333enum fuse_opcode {
Miklos Szeredie5e55582005-09-09 13:10:28 -0700334 FUSE_LOOKUP = 1,
335 FUSE_FORGET = 2, /* no reply */
336 FUSE_GETATTR = 3,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700337 FUSE_SETATTR = 4,
Miklos Szeredie5e55582005-09-09 13:10:28 -0700338 FUSE_READLINK = 5,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700339 FUSE_SYMLINK = 6,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700340 FUSE_MKNOD = 8,
341 FUSE_MKDIR = 9,
342 FUSE_UNLINK = 10,
343 FUSE_RMDIR = 11,
344 FUSE_RENAME = 12,
345 FUSE_LINK = 13,
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700346 FUSE_OPEN = 14,
347 FUSE_READ = 15,
348 FUSE_WRITE = 16,
Miklos Szeredie5e55582005-09-09 13:10:28 -0700349 FUSE_STATFS = 17,
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700350 FUSE_RELEASE = 18,
351 FUSE_FSYNC = 20,
Miklos Szeredi92a87802005-09-09 13:10:31 -0700352 FUSE_SETXATTR = 21,
353 FUSE_GETXATTR = 22,
354 FUSE_LISTXATTR = 23,
355 FUSE_REMOVEXATTR = 24,
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700356 FUSE_FLUSH = 25,
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700357 FUSE_INIT = 26,
358 FUSE_OPENDIR = 27,
359 FUSE_READDIR = 28,
Miklos Szeredi82547982005-09-09 13:10:38 -0700360 FUSE_RELEASEDIR = 29,
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800361 FUSE_FSYNCDIR = 30,
Miklos Szeredi71421252006-06-25 05:48:52 -0700362 FUSE_GETLK = 31,
363 FUSE_SETLK = 32,
364 FUSE_SETLKW = 33,
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800365 FUSE_ACCESS = 34,
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700366 FUSE_CREATE = 35,
367 FUSE_INTERRUPT = 36,
Miklos Szeredib2d22722006-12-06 20:35:51 -0800368 FUSE_BMAP = 37,
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800369 FUSE_DESTROY = 38,
Tejun Heo59efec72008-11-26 12:03:55 +0100370 FUSE_IOCTL = 39,
Tejun Heo95668a62008-11-26 12:03:55 +0100371 FUSE_POLL = 40,
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200372 FUSE_NOTIFY_REPLY = 41,
Miklos Szeredi02c048b2010-12-07 20:16:56 +0100373 FUSE_BATCH_FORGET = 42,
Anatol Pomozov05ba1f02012-04-22 18:45:24 -0700374 FUSE_FALLOCATE = 43,
Anand V. Avati0b05b182012-08-19 08:53:23 -0400375 FUSE_READDIRPLUS = 44,
Miklos Szeredi1560c972014-04-28 16:43:44 +0200376 FUSE_RENAME2 = 45,
Ravishankar N0b5da8d2015-06-30 23:40:22 +0530377 FUSE_LSEEK = 46,
Daniel Rosenbergfac99a72016-04-22 00:00:48 -0700378 FUSE_CANONICAL_PATH= 2016,
Tejun Heo151060a2009-04-14 10:54:54 +0900379
380 /* CUSE specific operations */
381 CUSE_INIT = 4096,
Miklos Szeredi334f4852005-09-09 13:10:27 -0700382};
383
Tejun Heo85993962008-11-26 12:03:55 +0100384enum fuse_notify_code {
Tejun Heo95668a62008-11-26 12:03:55 +0100385 FUSE_NOTIFY_POLL = 1,
John Muir3b463ae2009-05-31 11:13:57 -0400386 FUSE_NOTIFY_INVAL_INODE = 2,
387 FUSE_NOTIFY_INVAL_ENTRY = 3,
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200388 FUSE_NOTIFY_STORE = 4,
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200389 FUSE_NOTIFY_RETRIEVE = 5,
John Muir451d0f52011-12-06 21:50:06 +0100390 FUSE_NOTIFY_DELETE = 6,
Tejun Heo85993962008-11-26 12:03:55 +0100391 FUSE_NOTIFY_CODE_MAX,
392};
393
Miklos Szeredi1d3d7522006-01-06 00:19:40 -0800394/* The read buffer is required to be at least 8k, but may be much larger */
395#define FUSE_MIN_READ_BUFFER 8192
Miklos Szeredie5e55582005-09-09 13:10:28 -0700396
Miklos Szeredi0e9663e2007-10-18 03:07:05 -0700397#define FUSE_COMPAT_ENTRY_OUT_SIZE 120
398
Miklos Szeredie5e55582005-09-09 13:10:28 -0700399struct fuse_entry_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200400 uint64_t nodeid; /* Inode ID */
401 uint64_t generation; /* Inode generation: nodeid:gen must
402 be unique for the fs's lifetime */
403 uint64_t entry_valid; /* Cache timeout for the name */
404 uint64_t attr_valid; /* Cache timeout for the attributes */
405 uint32_t entry_valid_nsec;
406 uint32_t attr_valid_nsec;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700407 struct fuse_attr attr;
408};
409
410struct fuse_forget_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200411 uint64_t nlookup;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700412};
413
Miklos Szeredi02c048b2010-12-07 20:16:56 +0100414struct fuse_forget_one {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200415 uint64_t nodeid;
416 uint64_t nlookup;
Miklos Szeredi02c048b2010-12-07 20:16:56 +0100417};
418
419struct fuse_batch_forget_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200420 uint32_t count;
421 uint32_t dummy;
Miklos Szeredi02c048b2010-12-07 20:16:56 +0100422};
423
Miklos Szeredic79e3222007-10-18 03:06:59 -0700424struct fuse_getattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200425 uint32_t getattr_flags;
426 uint32_t dummy;
427 uint64_t fh;
Miklos Szeredic79e3222007-10-18 03:06:59 -0700428};
429
Miklos Szeredi0e9663e2007-10-18 03:07:05 -0700430#define FUSE_COMPAT_ATTR_OUT_SIZE 96
431
Miklos Szeredie5e55582005-09-09 13:10:28 -0700432struct fuse_attr_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200433 uint64_t attr_valid; /* Cache timeout for the attributes */
434 uint32_t attr_valid_nsec;
435 uint32_t dummy;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700436 struct fuse_attr attr;
437};
438
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200439#define FUSE_COMPAT_MKNOD_IN_SIZE 8
440
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700441struct fuse_mknod_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200442 uint32_t mode;
443 uint32_t rdev;
444 uint32_t umask;
445 uint32_t padding;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700446};
447
448struct fuse_mkdir_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200449 uint32_t mode;
450 uint32_t umask;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700451};
452
453struct fuse_rename_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200454 uint64_t newdir;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700455};
456
Miklos Szeredi1560c972014-04-28 16:43:44 +0200457struct fuse_rename2_in {
458 uint64_t newdir;
459 uint32_t flags;
460 uint32_t padding;
461};
462
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700463struct fuse_link_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200464 uint64_t oldnodeid;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700465};
466
467struct fuse_setattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200468 uint32_t valid;
469 uint32_t padding;
470 uint64_t fh;
471 uint64_t size;
472 uint64_t lock_owner;
473 uint64_t atime;
474 uint64_t mtime;
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200475 uint64_t ctime;
Miklos Szeredi4c824562013-04-17 12:30:40 +0200476 uint32_t atimensec;
477 uint32_t mtimensec;
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200478 uint32_t ctimensec;
Miklos Szeredi4c824562013-04-17 12:30:40 +0200479 uint32_t mode;
480 uint32_t unused4;
481 uint32_t uid;
482 uint32_t gid;
483 uint32_t unused5;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700484};
485
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700486struct fuse_open_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200487 uint32_t flags;
488 uint32_t unused;
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200489};
490
491struct fuse_create_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200492 uint32_t flags;
493 uint32_t mode;
494 uint32_t umask;
495 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700496};
497
498struct fuse_open_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200499 uint64_t fh;
500 uint32_t open_flags;
501 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700502};
503
504struct fuse_release_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200505 uint64_t fh;
506 uint32_t flags;
507 uint32_t release_flags;
508 uint64_t lock_owner;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700509};
510
511struct fuse_flush_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200512 uint64_t fh;
513 uint32_t unused;
514 uint32_t padding;
515 uint64_t lock_owner;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700516};
517
518struct fuse_read_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200519 uint64_t fh;
520 uint64_t offset;
521 uint32_t size;
522 uint32_t read_flags;
523 uint64_t lock_owner;
524 uint32_t flags;
525 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700526};
527
Miklos Szeredif3332112007-10-18 03:07:04 -0700528#define FUSE_COMPAT_WRITE_IN_SIZE 24
529
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700530struct fuse_write_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200531 uint64_t fh;
532 uint64_t offset;
533 uint32_t size;
534 uint32_t write_flags;
535 uint64_t lock_owner;
536 uint32_t flags;
537 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700538};
539
540struct fuse_write_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200541 uint32_t size;
542 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700543};
544
Miklos Szeredide5f1202006-01-06 00:19:37 -0800545#define FUSE_COMPAT_STATFS_SIZE 48
546
Miklos Szeredie5e55582005-09-09 13:10:28 -0700547struct fuse_statfs_out {
548 struct fuse_kstatfs st;
549};
550
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700551struct fuse_fsync_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200552 uint64_t fh;
553 uint32_t fsync_flags;
554 uint32_t padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700555};
556
Miklos Szeredi92a87802005-09-09 13:10:31 -0700557struct fuse_setxattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200558 uint32_t size;
559 uint32_t flags;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700560};
561
562struct fuse_getxattr_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200563 uint32_t size;
564 uint32_t padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700565};
566
567struct fuse_getxattr_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200568 uint32_t size;
569 uint32_t padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700570};
571
Miklos Szeredi71421252006-06-25 05:48:52 -0700572struct fuse_lk_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200573 uint64_t fh;
574 uint64_t owner;
Miklos Szeredi71421252006-06-25 05:48:52 -0700575 struct fuse_file_lock lk;
Miklos Szeredi4c824562013-04-17 12:30:40 +0200576 uint32_t lk_flags;
577 uint32_t padding;
Miklos Szeredi71421252006-06-25 05:48:52 -0700578};
579
580struct fuse_lk_out {
581 struct fuse_file_lock lk;
582};
583
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800584struct fuse_access_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200585 uint32_t mask;
586 uint32_t padding;
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800587};
588
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800589struct fuse_init_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200590 uint32_t major;
591 uint32_t minor;
592 uint32_t max_readahead;
593 uint32_t flags;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700594};
595
Miklos Szeredie27c9d32014-04-28 14:19:23 +0200596#define FUSE_COMPAT_INIT_OUT_SIZE 8
597#define FUSE_COMPAT_22_INIT_OUT_SIZE 24
598
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800599struct fuse_init_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200600 uint32_t major;
601 uint32_t minor;
602 uint32_t max_readahead;
603 uint32_t flags;
604 uint16_t max_background;
605 uint16_t congestion_threshold;
606 uint32_t max_write;
Miklos Szeredie27c9d32014-04-28 14:19:23 +0200607 uint32_t time_gran;
608 uint32_t unused[9];
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800609};
610
Tejun Heo151060a2009-04-14 10:54:54 +0900611#define CUSE_INIT_INFO_MAX 4096
612
613struct cuse_init_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200614 uint32_t major;
615 uint32_t minor;
616 uint32_t unused;
617 uint32_t flags;
Tejun Heo151060a2009-04-14 10:54:54 +0900618};
619
620struct cuse_init_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200621 uint32_t major;
622 uint32_t minor;
623 uint32_t unused;
624 uint32_t flags;
625 uint32_t max_read;
626 uint32_t max_write;
627 uint32_t dev_major; /* chardev major */
628 uint32_t dev_minor; /* chardev minor */
629 uint32_t spare[10];
Tejun Heo151060a2009-04-14 10:54:54 +0900630};
631
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700632struct fuse_interrupt_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200633 uint64_t unique;
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700634};
635
Miklos Szeredib2d22722006-12-06 20:35:51 -0800636struct fuse_bmap_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200637 uint64_t block;
638 uint32_t blocksize;
639 uint32_t padding;
Miklos Szeredib2d22722006-12-06 20:35:51 -0800640};
641
642struct fuse_bmap_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200643 uint64_t block;
Miklos Szeredib2d22722006-12-06 20:35:51 -0800644};
645
Tejun Heo59efec72008-11-26 12:03:55 +0100646struct fuse_ioctl_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200647 uint64_t fh;
648 uint32_t flags;
649 uint32_t cmd;
650 uint64_t arg;
651 uint32_t in_size;
652 uint32_t out_size;
Tejun Heo59efec72008-11-26 12:03:55 +0100653};
654
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100655struct fuse_ioctl_iovec {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200656 uint64_t base;
657 uint64_t len;
Miklos Szeredi1baa26b2010-12-07 20:16:56 +0100658};
659
Tejun Heo59efec72008-11-26 12:03:55 +0100660struct fuse_ioctl_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200661 int32_t result;
662 uint32_t flags;
663 uint32_t in_iovs;
664 uint32_t out_iovs;
Tejun Heo59efec72008-11-26 12:03:55 +0100665};
666
Tejun Heo95668a62008-11-26 12:03:55 +0100667struct fuse_poll_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200668 uint64_t fh;
669 uint64_t kh;
670 uint32_t flags;
671 uint32_t events;
Tejun Heo95668a62008-11-26 12:03:55 +0100672};
673
674struct fuse_poll_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200675 uint32_t revents;
676 uint32_t padding;
Tejun Heo95668a62008-11-26 12:03:55 +0100677};
678
679struct fuse_notify_poll_wakeup_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200680 uint64_t kh;
Tejun Heo95668a62008-11-26 12:03:55 +0100681};
682
Anatol Pomozov05ba1f02012-04-22 18:45:24 -0700683struct fuse_fallocate_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200684 uint64_t fh;
685 uint64_t offset;
686 uint64_t length;
687 uint32_t mode;
688 uint32_t padding;
Anatol Pomozov05ba1f02012-04-22 18:45:24 -0700689};
690
Miklos Szeredi334f4852005-09-09 13:10:27 -0700691struct fuse_in_header {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200692 uint32_t len;
693 uint32_t opcode;
694 uint64_t unique;
695 uint64_t nodeid;
696 uint32_t uid;
697 uint32_t gid;
698 uint32_t pid;
699 uint32_t padding;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700700};
701
702struct fuse_out_header {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200703 uint32_t len;
704 int32_t error;
705 uint64_t unique;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700706};
707
Miklos Szeredie5e55582005-09-09 13:10:28 -0700708struct fuse_dirent {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200709 uint64_t ino;
710 uint64_t off;
711 uint32_t namelen;
712 uint32_t type;
Miklos Szeredic628ee62012-04-12 12:57:08 +0200713 char name[];
Miklos Szeredie5e55582005-09-09 13:10:28 -0700714};
715
Andrew Morton21f3da92007-07-15 23:39:50 -0700716#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
Miklos Szeredi4c824562013-04-17 12:30:40 +0200717#define FUSE_DIRENT_ALIGN(x) \
718 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
Miklos Szeredie5e55582005-09-09 13:10:28 -0700719#define FUSE_DIRENT_SIZE(d) \
720 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
Tejun Heo29d434b2008-10-16 16:08:57 +0200721
Anand V. Avati0b05b182012-08-19 08:53:23 -0400722struct fuse_direntplus {
723 struct fuse_entry_out entry_out;
724 struct fuse_dirent dirent;
725};
726
727#define FUSE_NAME_OFFSET_DIRENTPLUS \
728 offsetof(struct fuse_direntplus, dirent.name)
729#define FUSE_DIRENTPLUS_SIZE(d) \
730 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
731
John Muir3b463ae2009-05-31 11:13:57 -0400732struct fuse_notify_inval_inode_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200733 uint64_t ino;
734 int64_t off;
735 int64_t len;
John Muir3b463ae2009-05-31 11:13:57 -0400736};
737
738struct fuse_notify_inval_entry_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200739 uint64_t parent;
740 uint32_t namelen;
741 uint32_t padding;
John Muir3b463ae2009-05-31 11:13:57 -0400742};
743
John Muir451d0f52011-12-06 21:50:06 +0100744struct fuse_notify_delete_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200745 uint64_t parent;
746 uint64_t child;
747 uint32_t namelen;
748 uint32_t padding;
John Muir451d0f52011-12-06 21:50:06 +0100749};
750
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200751struct fuse_notify_store_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200752 uint64_t nodeid;
753 uint64_t offset;
754 uint32_t size;
755 uint32_t padding;
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200756};
757
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200758struct fuse_notify_retrieve_out {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200759 uint64_t notify_unique;
760 uint64_t nodeid;
761 uint64_t offset;
762 uint32_t size;
763 uint32_t padding;
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200764};
765
766/* Matches the size of fuse_write_in */
767struct fuse_notify_retrieve_in {
Miklos Szeredi4c824562013-04-17 12:30:40 +0200768 uint64_t dummy1;
769 uint64_t offset;
770 uint32_t size;
771 uint32_t dummy2;
772 uint64_t dummy3;
773 uint64_t dummy4;
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200774};
775
Miklos Szeredi00c570f2015-07-01 16:26:08 +0200776/* Device ioctls: */
777#define FUSE_DEV_IOC_CLONE _IOR(229, 0, uint32_t)
778
Ravishankar N0b5da8d2015-06-30 23:40:22 +0530779struct fuse_lseek_in {
780 uint64_t fh;
781 uint64_t offset;
782 uint32_t whence;
783 uint32_t padding;
784};
785
786struct fuse_lseek_out {
787 uint64_t offset;
788};
789
Tejun Heo29d434b2008-10-16 16:08:57 +0200790#endif /* _LINUX_FUSE_H */