Commit | Line | Data |
---|---|---|
e2be04c7 | 1 | /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */ |
d8a5ba45 | 2 | /* |
7e98d530 | 3 | This file defines the kernel interface of FUSE |
1f55ed06 | 4 | Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu> |
d8a5ba45 MS |
5 | |
6 | This program can be distributed under the terms of the GNU GPL. | |
7 | See the file COPYING. | |
7e98d530 MS |
8 | |
9 | This -- and only this -- header file may also be distributed under | |
10 | the terms of the BSD Licence as follows: | |
11 | ||
12 | Copyright (C) 2001-2007 Miklos Szeredi. All rights reserved. | |
13 | ||
14 | Redistribution and use in source and binary forms, with or without | |
15 | modification, are permitted provided that the following conditions | |
16 | are met: | |
17 | 1. Redistributions of source code must retain the above copyright | |
18 | notice, this list of conditions and the following disclaimer. | |
19 | 2. Redistributions in binary form must reproduce the above copyright | |
20 | notice, this list of conditions and the following disclaimer in the | |
21 | documentation and/or other materials provided with the distribution. | |
22 | ||
23 | THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND | |
24 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
25 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
26 | ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE | |
27 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
28 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
29 | OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
30 | HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
31 | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
32 | OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
33 | SUCH DAMAGE. | |
d8a5ba45 MS |
34 | */ |
35 | ||
c79e322f MS |
36 | /* |
37 | * This file defines the kernel interface of FUSE | |
38 | * | |
39 | * Protocol changelog: | |
40 | * | |
9de55a37 AS |
41 | * 7.1: |
42 | * - add the following messages: | |
43 | * FUSE_SETATTR, FUSE_SYMLINK, FUSE_MKNOD, FUSE_MKDIR, FUSE_UNLINK, | |
44 | * FUSE_RMDIR, FUSE_RENAME, FUSE_LINK, FUSE_OPEN, FUSE_READ, FUSE_WRITE, | |
45 | * FUSE_RELEASE, FUSE_FSYNC, FUSE_FLUSH, FUSE_SETXATTR, FUSE_GETXATTR, | |
46 | * FUSE_LISTXATTR, FUSE_REMOVEXATTR, FUSE_OPENDIR, FUSE_READDIR, | |
47 | * FUSE_RELEASEDIR | |
48 | * - add padding to messages to accommodate 32-bit servers on 64-bit kernels | |
49 | * | |
50 | * 7.2: | |
51 | * - add FOPEN_DIRECT_IO and FOPEN_KEEP_CACHE flags | |
52 | * - add FUSE_FSYNCDIR message | |
53 | * | |
54 | * 7.3: | |
55 | * - add FUSE_ACCESS message | |
56 | * - add FUSE_CREATE message | |
57 | * - add filehandle to fuse_setattr_in | |
58 | * | |
59 | * 7.4: | |
60 | * - add frsize to fuse_kstatfs | |
61 | * - clean up request size limit checking | |
62 | * | |
63 | * 7.5: | |
64 | * - add flags and max_write to fuse_init_out | |
65 | * | |
66 | * 7.6: | |
67 | * - add max_readahead to fuse_init_in and fuse_init_out | |
68 | * | |
69 | * 7.7: | |
70 | * - add FUSE_INTERRUPT message | |
71 | * - add POSIX file lock support | |
72 | * | |
73 | * 7.8: | |
74 | * - add lock_owner and flags fields to fuse_release_in | |
75 | * - add FUSE_BMAP message | |
76 | * - add FUSE_DESTROY message | |
77 | * | |
c79e322f MS |
78 | * 7.9: |
79 | * - new fuse_getattr_in input argument of GETATTR | |
a9ff4f87 | 80 | * - add lk_flags in fuse_lk_in |
f3332114 | 81 | * - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in |
0e9663ee | 82 | * - add blksize field to fuse_attr |
a6643094 | 83 | * - add file flags field to fuse_read_in and fuse_write_in |
7142fd1b | 84 | * - Add ATIME_NOW and MTIME_NOW flags to fuse_setattr_in |
a7c1b990 TH |
85 | * |
86 | * 7.10 | |
87 | * - add nonseekable open flag | |
1f55ed06 MS |
88 | * |
89 | * 7.11 | |
90 | * - add IOCTL message | |
91 | * - add unsolicited notification support | |
92 | * - add POLL message and NOTIFY_POLL notification | |
e0a43ddc MS |
93 | * |
94 | * 7.12 | |
68065b84 | 95 | * - add umask flag to input argument of create, mknod and mkdir |
3b463ae0 JM |
96 | * - add notification messages for invalidation of inodes and |
97 | * directory entries | |
7a6d3c8b CH |
98 | * |
99 | * 7.13 | |
100 | * - make max number of background requests and congestion threshold | |
101 | * tunables | |
dd3bb14f MS |
102 | * |
103 | * 7.14 | |
104 | * - add splice support to fuse device | |
a1d75f25 MS |
105 | * |
106 | * 7.15 | |
107 | * - add store notify | |
2d45ba38 | 108 | * - add retrieve notify |
02c048b9 MS |
109 | * |
110 | * 7.16 | |
111 | * - add BATCH_FORGET request | |
1baa26b2 MS |
112 | * - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct |
113 | * fuse_ioctl_iovec' instead of ambiguous 'struct iovec' | |
114 | * - add FUSE_IOCTL_32BIT flag | |
37fb3a30 MS |
115 | * |
116 | * 7.17 | |
117 | * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK | |
b18da0c5 MS |
118 | * |
119 | * 7.18 | |
120 | * - add FUSE_IOCTL_DIR flag | |
451d0f59 | 121 | * - add FUSE_NOTIFY_DELETE |
05ba1f08 AP |
122 | * |
123 | * 7.19 | |
124 | * - add FUSE_FALLOCATE | |
72d0d248 BF |
125 | * |
126 | * 7.20 | |
127 | * - add FUSE_AUTO_INVAL_DATA | |
23c153e5 MS |
128 | * |
129 | * 7.21 | |
130 | * - add FUSE_READDIRPLUS | |
0415d291 | 131 | * - send the requested events in POLL request |
60b9df7a MS |
132 | * |
133 | * 7.22 | |
134 | * - add FUSE_ASYNC_DIO | |
4d99ff8f PE |
135 | * |
136 | * 7.23 | |
137 | * - add FUSE_WRITEBACK_CACHE | |
e27c9d38 MS |
138 | * - add time_gran to fuse_init_out |
139 | * - add reserved space to fuse_init_out | |
ab9e13f7 MP |
140 | * - add FATTR_CTIME |
141 | * - add ctime and ctimensec to fuse_setattr_in | |
1560c974 | 142 | * - add FUSE_RENAME2 request |
d7afaec0 | 143 | * - add FUSE_NO_OPEN_SUPPORT flag |
0b5da8db R |
144 | * |
145 | * 7.24 | |
146 | * - add FUSE_LSEEK for SEEK_HOLE and SEEK_DATA support | |
5c672ab3 MS |
147 | * |
148 | * 7.25 | |
149 | * - add FUSE_PARALLEL_DIROPS | |
5e940c1d MS |
150 | * |
151 | * 7.26 | |
152 | * - add FUSE_HANDLE_KILLPRIV | |
60bcc88a | 153 | * - add FUSE_POSIX_ACL |
3b7008b2 SL |
154 | * |
155 | * 7.27 | |
156 | * - add FUSE_ABORT_ERROR | |
88bc7d50 NV |
157 | * |
158 | * 7.28 | |
159 | * - add FUSE_COPY_FILE_RANGE | |
6433b899 | 160 | * - add FOPEN_CACHE_DIR |
5da784cc | 161 | * - add FUSE_MAX_PAGES, add max_pages to init_out |
5571f1e6 | 162 | * - add FUSE_CACHE_SYMLINKS |
d9a9ea94 CA |
163 | * |
164 | * 7.29 | |
165 | * - add FUSE_NO_OPENDIR_SUPPORT flag | |
ad2ba64d KS |
166 | * |
167 | * 7.30 | |
168 | * - add FUSE_EXPLICIT_INVAL_DATA | |
6407f44a | 169 | * - add FUSE_IOCTL_COMPAT_X32 |
4a2abf99 MS |
170 | * |
171 | * 7.31 | |
172 | * - add FUSE_WRITE_KILL_PRIV flag | |
c4bb667e DDAG |
173 | * - add FUSE_SETUPMAPPING and FUSE_REMOVEMAPPING |
174 | * - add map_alignment to fuse_init_out, add FUSE_MAP_ALIGNMENT flag | |
c79e322f | 175 | */ |
d8a5ba45 | 176 | |
29d434b3 TH |
177 | #ifndef _LINUX_FUSE_H |
178 | #define _LINUX_FUSE_H | |
179 | ||
4c82456e | 180 | #ifdef __KERNEL__ |
1f55ed06 | 181 | #include <linux/types.h> |
7e98d530 MS |
182 | #else |
183 | #include <stdint.h> | |
7e98d530 | 184 | #endif |
d8a5ba45 | 185 | |
37d217f0 MS |
186 | /* |
187 | * Version negotiation: | |
188 | * | |
189 | * Both the kernel and userspace send the version they support in the | |
190 | * INIT request and reply respectively. | |
191 | * | |
192 | * If the major versions match then both shall use the smallest | |
193 | * of the two minor versions for communication. | |
194 | * | |
195 | * If the kernel supports a larger major version, then userspace shall | |
196 | * reply with the major version it supports, ignore the rest of the | |
197 | * INIT message and expect a new INIT message from the kernel with a | |
198 | * matching major version. | |
199 | * | |
200 | * If the library supports a larger major version, then it shall fall | |
201 | * back to the major protocol version sent by the kernel for | |
202 | * communication and reply with that major version (and an arbitrary | |
203 | * supported minor version). | |
204 | */ | |
205 | ||
d8a5ba45 | 206 | /** Version number of this interface */ |
9e6268db | 207 | #define FUSE_KERNEL_VERSION 7 |
d8a5ba45 MS |
208 | |
209 | /** Minor version number of this interface */ | |
4a2abf99 | 210 | #define FUSE_KERNEL_MINOR_VERSION 31 |
d8a5ba45 MS |
211 | |
212 | /** The node ID of the root inode */ | |
213 | #define FUSE_ROOT_ID 1 | |
214 | ||
06663267 MS |
215 | /* Make sure all structures are padded to 64bit boundary, so 32bit |
216 | userspace works under 64bit kernels */ | |
217 | ||
d8a5ba45 | 218 | struct fuse_attr { |
4c82456e MS |
219 | uint64_t ino; |
220 | uint64_t size; | |
221 | uint64_t blocks; | |
222 | uint64_t atime; | |
223 | uint64_t mtime; | |
224 | uint64_t ctime; | |
225 | uint32_t atimensec; | |
226 | uint32_t mtimensec; | |
227 | uint32_t ctimensec; | |
228 | uint32_t mode; | |
229 | uint32_t nlink; | |
230 | uint32_t uid; | |
231 | uint32_t gid; | |
232 | uint32_t rdev; | |
233 | uint32_t blksize; | |
234 | uint32_t padding; | |
d8a5ba45 MS |
235 | }; |
236 | ||
e5e5558e | 237 | struct fuse_kstatfs { |
4c82456e MS |
238 | uint64_t blocks; |
239 | uint64_t bfree; | |
240 | uint64_t bavail; | |
241 | uint64_t files; | |
242 | uint64_t ffree; | |
243 | uint32_t bsize; | |
244 | uint32_t namelen; | |
245 | uint32_t frsize; | |
246 | uint32_t padding; | |
247 | uint32_t spare[6]; | |
e5e5558e MS |
248 | }; |
249 | ||
71421259 | 250 | struct fuse_file_lock { |
4c82456e MS |
251 | uint64_t start; |
252 | uint64_t end; | |
253 | uint32_t type; | |
254 | uint32_t pid; /* tgid */ | |
71421259 MS |
255 | }; |
256 | ||
9cd68455 MS |
257 | /** |
258 | * Bitmasks for fuse_setattr_in.valid | |
259 | */ | |
9e6268db MS |
260 | #define FATTR_MODE (1 << 0) |
261 | #define FATTR_UID (1 << 1) | |
262 | #define FATTR_GID (1 << 2) | |
263 | #define FATTR_SIZE (1 << 3) | |
264 | #define FATTR_ATIME (1 << 4) | |
265 | #define FATTR_MTIME (1 << 5) | |
befc649c | 266 | #define FATTR_FH (1 << 6) |
17637cba MS |
267 | #define FATTR_ATIME_NOW (1 << 7) |
268 | #define FATTR_MTIME_NOW (1 << 8) | |
f3332114 | 269 | #define FATTR_LOCKOWNER (1 << 9) |
ab9e13f7 | 270 | #define FATTR_CTIME (1 << 10) |
9e6268db | 271 | |
45323fb7 MS |
272 | /** |
273 | * Flags returned by the OPEN request | |
274 | * | |
275 | * FOPEN_DIRECT_IO: bypass page cache for this open file | |
276 | * FOPEN_KEEP_CACHE: don't invalidate the data cache on open | |
a7c1b990 | 277 | * FOPEN_NONSEEKABLE: the file is not seekable |
6433b899 | 278 | * FOPEN_CACHE_DIR: allow caching this directory |
bbd84f33 | 279 | * FOPEN_STREAM: the file is stream-like (no file position at all) |
45323fb7 MS |
280 | */ |
281 | #define FOPEN_DIRECT_IO (1 << 0) | |
282 | #define FOPEN_KEEP_CACHE (1 << 1) | |
a7c1b990 | 283 | #define FOPEN_NONSEEKABLE (1 << 2) |
6433b899 | 284 | #define FOPEN_CACHE_DIR (1 << 3) |
bbd84f33 | 285 | #define FOPEN_STREAM (1 << 4) |
45323fb7 | 286 | |
9cd68455 MS |
287 | /** |
288 | * INIT request/reply flags | |
33670fa2 | 289 | * |
f3840dc0 | 290 | * FUSE_ASYNC_READ: asynchronous read requests |
37fb3a30 | 291 | * FUSE_POSIX_LOCKS: remote locking for POSIX file locks |
f3840dc0 MS |
292 | * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported) |
293 | * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem | |
33670fa2 | 294 | * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".." |
f3840dc0 | 295 | * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB |
e0a43ddc | 296 | * FUSE_DONT_MASK: don't apply umask to file mode on create operations |
69fe05c9 MS |
297 | * FUSE_SPLICE_WRITE: kernel supports splice write on the device |
298 | * FUSE_SPLICE_MOVE: kernel supports splice move on the device | |
299 | * FUSE_SPLICE_READ: kernel supports splice read on the device | |
37fb3a30 | 300 | * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks |
69fe05c9 | 301 | * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories |
72d0d248 | 302 | * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages |
634734b6 EW |
303 | * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one) |
304 | * FUSE_READDIRPLUS_AUTO: adaptive readdirplus | |
60b9df7a | 305 | * FUSE_ASYNC_DIO: asynchronous direct I/O submission |
4d99ff8f | 306 | * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes |
d7afaec0 | 307 | * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens |
5c672ab3 | 308 | * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir |
5e940c1d | 309 | * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc |
60bcc88a | 310 | * FUSE_POSIX_ACL: filesystem supports posix acls |
3b7008b2 | 311 | * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED |
5da784cc | 312 | * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages |
5571f1e6 | 313 | * FUSE_CACHE_SYMLINKS: cache READLINK responses |
d9a9ea94 | 314 | * FUSE_NO_OPENDIR_SUPPORT: kernel supports zero-message opendir |
ad2ba64d | 315 | * FUSE_EXPLICIT_INVAL_DATA: only invalidate cached pages on explicit request |
fd1a1dc6 SH |
316 | * FUSE_MAP_ALIGNMENT: init_out.map_alignment contains log2(byte alignment) for |
317 | * foffset and moffset fields in struct | |
318 | * fuse_setupmapping_out and fuse_removemapping_one. | |
9cd68455 MS |
319 | */ |
320 | #define FUSE_ASYNC_READ (1 << 0) | |
71421259 | 321 | #define FUSE_POSIX_LOCKS (1 << 1) |
c79e322f | 322 | #define FUSE_FILE_OPS (1 << 2) |
6ff958ed | 323 | #define FUSE_ATOMIC_O_TRUNC (1 << 3) |
33670fa2 | 324 | #define FUSE_EXPORT_SUPPORT (1 << 4) |
78bb6cb9 | 325 | #define FUSE_BIG_WRITES (1 << 5) |
e0a43ddc | 326 | #define FUSE_DONT_MASK (1 << 6) |
69fe05c9 MS |
327 | #define FUSE_SPLICE_WRITE (1 << 7) |
328 | #define FUSE_SPLICE_MOVE (1 << 8) | |
329 | #define FUSE_SPLICE_READ (1 << 9) | |
37fb3a30 | 330 | #define FUSE_FLOCK_LOCKS (1 << 10) |
69fe05c9 | 331 | #define FUSE_HAS_IOCTL_DIR (1 << 11) |
72d0d248 | 332 | #define FUSE_AUTO_INVAL_DATA (1 << 12) |
0b05b183 | 333 | #define FUSE_DO_READDIRPLUS (1 << 13) |
634734b6 | 334 | #define FUSE_READDIRPLUS_AUTO (1 << 14) |
60b9df7a | 335 | #define FUSE_ASYNC_DIO (1 << 15) |
4d99ff8f | 336 | #define FUSE_WRITEBACK_CACHE (1 << 16) |
d7afaec0 | 337 | #define FUSE_NO_OPEN_SUPPORT (1 << 17) |
5c672ab3 | 338 | #define FUSE_PARALLEL_DIROPS (1 << 18) |
5e940c1d | 339 | #define FUSE_HANDLE_KILLPRIV (1 << 19) |
60bcc88a | 340 | #define FUSE_POSIX_ACL (1 << 20) |
3b7008b2 | 341 | #define FUSE_ABORT_ERROR (1 << 21) |
5da784cc | 342 | #define FUSE_MAX_PAGES (1 << 22) |
5571f1e6 | 343 | #define FUSE_CACHE_SYMLINKS (1 << 23) |
d9a9ea94 | 344 | #define FUSE_NO_OPENDIR_SUPPORT (1 << 24) |
ad2ba64d | 345 | #define FUSE_EXPLICIT_INVAL_DATA (1 << 25) |
c4bb667e | 346 | #define FUSE_MAP_ALIGNMENT (1 << 26) |
9cd68455 | 347 | |
151060ac TH |
348 | /** |
349 | * CUSE INIT request/reply flags | |
350 | * | |
351 | * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl | |
352 | */ | |
353 | #define CUSE_UNRESTRICTED_IOCTL (1 << 0) | |
354 | ||
e9168c18 MS |
355 | /** |
356 | * Release flags | |
357 | */ | |
358 | #define FUSE_RELEASE_FLUSH (1 << 0) | |
37fb3a30 | 359 | #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1) |
e9168c18 | 360 | |
c79e322f MS |
361 | /** |
362 | * Getattr flags | |
363 | */ | |
364 | #define FUSE_GETATTR_FH (1 << 0) | |
365 | ||
a9ff4f87 MS |
366 | /** |
367 | * Lock flags | |
368 | */ | |
369 | #define FUSE_LK_FLOCK (1 << 0) | |
370 | ||
b25e82e5 MS |
371 | /** |
372 | * WRITE flags | |
373 | * | |
374 | * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed | |
f3332114 | 375 | * FUSE_WRITE_LOCKOWNER: lock_owner field is valid |
4a2abf99 | 376 | * FUSE_WRITE_KILL_PRIV: kill suid and sgid bits |
b25e82e5 MS |
377 | */ |
378 | #define FUSE_WRITE_CACHE (1 << 0) | |
f3332114 | 379 | #define FUSE_WRITE_LOCKOWNER (1 << 1) |
4a2abf99 | 380 | #define FUSE_WRITE_KILL_PRIV (1 << 2) |
f3332114 MS |
381 | |
382 | /** | |
383 | * Read flags | |
384 | */ | |
385 | #define FUSE_READ_LOCKOWNER (1 << 1) | |
b25e82e5 | 386 | |
59efec7b TH |
387 | /** |
388 | * Ioctl flags | |
389 | * | |
390 | * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine | |
391 | * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed | |
392 | * FUSE_IOCTL_RETRY: retry with new iovecs | |
1baa26b2 | 393 | * FUSE_IOCTL_32BIT: 32bit ioctl |
b18da0c5 | 394 | * FUSE_IOCTL_DIR: is a directory |
6407f44a | 395 | * FUSE_IOCTL_COMPAT_X32: x32 compat ioctl on 64bit machine (64bit time_t) |
59efec7b TH |
396 | * |
397 | * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs | |
398 | */ | |
399 | #define FUSE_IOCTL_COMPAT (1 << 0) | |
400 | #define FUSE_IOCTL_UNRESTRICTED (1 << 1) | |
401 | #define FUSE_IOCTL_RETRY (1 << 2) | |
1baa26b2 | 402 | #define FUSE_IOCTL_32BIT (1 << 3) |
b18da0c5 | 403 | #define FUSE_IOCTL_DIR (1 << 4) |
6407f44a | 404 | #define FUSE_IOCTL_COMPAT_X32 (1 << 5) |
59efec7b TH |
405 | |
406 | #define FUSE_IOCTL_MAX_IOV 256 | |
407 | ||
95668a69 TH |
408 | /** |
409 | * Poll flags | |
410 | * | |
411 | * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify | |
412 | */ | |
413 | #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0) | |
414 | ||
154603fe AS |
415 | /** |
416 | * Fsync flags | |
417 | * | |
418 | * FUSE_FSYNC_FDATASYNC: Sync data only, not metadata | |
419 | */ | |
420 | #define FUSE_FSYNC_FDATASYNC (1 << 0) | |
421 | ||
334f485d | 422 | enum fuse_opcode { |
88bc7d50 NV |
423 | FUSE_LOOKUP = 1, |
424 | FUSE_FORGET = 2, /* no reply */ | |
425 | FUSE_GETATTR = 3, | |
426 | FUSE_SETATTR = 4, | |
427 | FUSE_READLINK = 5, | |
428 | FUSE_SYMLINK = 6, | |
429 | FUSE_MKNOD = 8, | |
430 | FUSE_MKDIR = 9, | |
431 | FUSE_UNLINK = 10, | |
432 | FUSE_RMDIR = 11, | |
433 | FUSE_RENAME = 12, | |
434 | FUSE_LINK = 13, | |
435 | FUSE_OPEN = 14, | |
436 | FUSE_READ = 15, | |
437 | FUSE_WRITE = 16, | |
438 | FUSE_STATFS = 17, | |
439 | FUSE_RELEASE = 18, | |
440 | FUSE_FSYNC = 20, | |
441 | FUSE_SETXATTR = 21, | |
442 | FUSE_GETXATTR = 22, | |
443 | FUSE_LISTXATTR = 23, | |
444 | FUSE_REMOVEXATTR = 24, | |
445 | FUSE_FLUSH = 25, | |
446 | FUSE_INIT = 26, | |
447 | FUSE_OPENDIR = 27, | |
448 | FUSE_READDIR = 28, | |
449 | FUSE_RELEASEDIR = 29, | |
450 | FUSE_FSYNCDIR = 30, | |
451 | FUSE_GETLK = 31, | |
452 | FUSE_SETLK = 32, | |
453 | FUSE_SETLKW = 33, | |
454 | FUSE_ACCESS = 34, | |
455 | FUSE_CREATE = 35, | |
456 | FUSE_INTERRUPT = 36, | |
457 | FUSE_BMAP = 37, | |
458 | FUSE_DESTROY = 38, | |
459 | FUSE_IOCTL = 39, | |
460 | FUSE_POLL = 40, | |
461 | FUSE_NOTIFY_REPLY = 41, | |
462 | FUSE_BATCH_FORGET = 42, | |
463 | FUSE_FALLOCATE = 43, | |
464 | FUSE_READDIRPLUS = 44, | |
465 | FUSE_RENAME2 = 45, | |
466 | FUSE_LSEEK = 46, | |
467 | FUSE_COPY_FILE_RANGE = 47, | |
c4bb667e DDAG |
468 | FUSE_SETUPMAPPING = 48, |
469 | FUSE_REMOVEMAPPING = 49, | |
151060ac TH |
470 | |
471 | /* CUSE specific operations */ | |
88bc7d50 | 472 | CUSE_INIT = 4096, |
501ae8ec MT |
473 | |
474 | /* Reserved opcodes: helpful to detect structure endian-ness */ | |
475 | CUSE_INIT_BSWAP_RESERVED = 1048576, /* CUSE_INIT << 8 */ | |
476 | FUSE_INIT_BSWAP_RESERVED = 436207616, /* FUSE_INIT << 24 */ | |
334f485d MS |
477 | }; |
478 | ||
8599396b | 479 | enum fuse_notify_code { |
95668a69 | 480 | FUSE_NOTIFY_POLL = 1, |
3b463ae0 JM |
481 | FUSE_NOTIFY_INVAL_INODE = 2, |
482 | FUSE_NOTIFY_INVAL_ENTRY = 3, | |
a1d75f25 | 483 | FUSE_NOTIFY_STORE = 4, |
2d45ba38 | 484 | FUSE_NOTIFY_RETRIEVE = 5, |
451d0f59 | 485 | FUSE_NOTIFY_DELETE = 6, |
8599396b TH |
486 | FUSE_NOTIFY_CODE_MAX, |
487 | }; | |
488 | ||
1d3d752b MS |
489 | /* The read buffer is required to be at least 8k, but may be much larger */ |
490 | #define FUSE_MIN_READ_BUFFER 8192 | |
e5e5558e | 491 | |
0e9663ee MS |
492 | #define FUSE_COMPAT_ENTRY_OUT_SIZE 120 |
493 | ||
e5e5558e | 494 | struct fuse_entry_out { |
4c82456e MS |
495 | uint64_t nodeid; /* Inode ID */ |
496 | uint64_t generation; /* Inode generation: nodeid:gen must | |
497 | be unique for the fs's lifetime */ | |
498 | uint64_t entry_valid; /* Cache timeout for the name */ | |
499 | uint64_t attr_valid; /* Cache timeout for the attributes */ | |
500 | uint32_t entry_valid_nsec; | |
501 | uint32_t attr_valid_nsec; | |
e5e5558e MS |
502 | struct fuse_attr attr; |
503 | }; | |
504 | ||
505 | struct fuse_forget_in { | |
4c82456e | 506 | uint64_t nlookup; |
e5e5558e MS |
507 | }; |
508 | ||
02c048b9 | 509 | struct fuse_forget_one { |
4c82456e MS |
510 | uint64_t nodeid; |
511 | uint64_t nlookup; | |
02c048b9 MS |
512 | }; |
513 | ||
514 | struct fuse_batch_forget_in { | |
4c82456e MS |
515 | uint32_t count; |
516 | uint32_t dummy; | |
02c048b9 MS |
517 | }; |
518 | ||
c79e322f | 519 | struct fuse_getattr_in { |
4c82456e MS |
520 | uint32_t getattr_flags; |
521 | uint32_t dummy; | |
522 | uint64_t fh; | |
c79e322f MS |
523 | }; |
524 | ||
0e9663ee MS |
525 | #define FUSE_COMPAT_ATTR_OUT_SIZE 96 |
526 | ||
e5e5558e | 527 | struct fuse_attr_out { |
4c82456e MS |
528 | uint64_t attr_valid; /* Cache timeout for the attributes */ |
529 | uint32_t attr_valid_nsec; | |
530 | uint32_t dummy; | |
e5e5558e MS |
531 | struct fuse_attr attr; |
532 | }; | |
533 | ||
e0a43ddc MS |
534 | #define FUSE_COMPAT_MKNOD_IN_SIZE 8 |
535 | ||
9e6268db | 536 | struct fuse_mknod_in { |
4c82456e MS |
537 | uint32_t mode; |
538 | uint32_t rdev; | |
539 | uint32_t umask; | |
540 | uint32_t padding; | |
9e6268db MS |
541 | }; |
542 | ||
543 | struct fuse_mkdir_in { | |
4c82456e MS |
544 | uint32_t mode; |
545 | uint32_t umask; | |
9e6268db MS |
546 | }; |
547 | ||
548 | struct fuse_rename_in { | |
4c82456e | 549 | uint64_t newdir; |
9e6268db MS |
550 | }; |
551 | ||
1560c974 MS |
552 | struct fuse_rename2_in { |
553 | uint64_t newdir; | |
554 | uint32_t flags; | |
555 | uint32_t padding; | |
556 | }; | |
557 | ||
9e6268db | 558 | struct fuse_link_in { |
4c82456e | 559 | uint64_t oldnodeid; |
9e6268db MS |
560 | }; |
561 | ||
562 | struct fuse_setattr_in { | |
4c82456e MS |
563 | uint32_t valid; |
564 | uint32_t padding; | |
565 | uint64_t fh; | |
566 | uint64_t size; | |
567 | uint64_t lock_owner; | |
568 | uint64_t atime; | |
569 | uint64_t mtime; | |
ab9e13f7 | 570 | uint64_t ctime; |
4c82456e MS |
571 | uint32_t atimensec; |
572 | uint32_t mtimensec; | |
ab9e13f7 | 573 | uint32_t ctimensec; |
4c82456e MS |
574 | uint32_t mode; |
575 | uint32_t unused4; | |
576 | uint32_t uid; | |
577 | uint32_t gid; | |
578 | uint32_t unused5; | |
9e6268db MS |
579 | }; |
580 | ||
b6aeaded | 581 | struct fuse_open_in { |
4c82456e MS |
582 | uint32_t flags; |
583 | uint32_t unused; | |
e0a43ddc MS |
584 | }; |
585 | ||
586 | struct fuse_create_in { | |
4c82456e MS |
587 | uint32_t flags; |
588 | uint32_t mode; | |
589 | uint32_t umask; | |
590 | uint32_t padding; | |
b6aeaded MS |
591 | }; |
592 | ||
593 | struct fuse_open_out { | |
4c82456e MS |
594 | uint64_t fh; |
595 | uint32_t open_flags; | |
596 | uint32_t padding; | |
b6aeaded MS |
597 | }; |
598 | ||
599 | struct fuse_release_in { | |
4c82456e MS |
600 | uint64_t fh; |
601 | uint32_t flags; | |
602 | uint32_t release_flags; | |
603 | uint64_t lock_owner; | |
b6aeaded MS |
604 | }; |
605 | ||
606 | struct fuse_flush_in { | |
4c82456e MS |
607 | uint64_t fh; |
608 | uint32_t unused; | |
609 | uint32_t padding; | |
610 | uint64_t lock_owner; | |
b6aeaded MS |
611 | }; |
612 | ||
613 | struct fuse_read_in { | |
4c82456e MS |
614 | uint64_t fh; |
615 | uint64_t offset; | |
616 | uint32_t size; | |
617 | uint32_t read_flags; | |
618 | uint64_t lock_owner; | |
619 | uint32_t flags; | |
620 | uint32_t padding; | |
b6aeaded MS |
621 | }; |
622 | ||
f3332114 MS |
623 | #define FUSE_COMPAT_WRITE_IN_SIZE 24 |
624 | ||
b6aeaded | 625 | struct fuse_write_in { |
4c82456e MS |
626 | uint64_t fh; |
627 | uint64_t offset; | |
628 | uint32_t size; | |
629 | uint32_t write_flags; | |
630 | uint64_t lock_owner; | |
631 | uint32_t flags; | |
632 | uint32_t padding; | |
b6aeaded MS |
633 | }; |
634 | ||
635 | struct fuse_write_out { | |
4c82456e MS |
636 | uint32_t size; |
637 | uint32_t padding; | |
b6aeaded MS |
638 | }; |
639 | ||
de5f1202 MS |
640 | #define FUSE_COMPAT_STATFS_SIZE 48 |
641 | ||
e5e5558e MS |
642 | struct fuse_statfs_out { |
643 | struct fuse_kstatfs st; | |
644 | }; | |
645 | ||
b6aeaded | 646 | struct fuse_fsync_in { |
4c82456e MS |
647 | uint64_t fh; |
648 | uint32_t fsync_flags; | |
649 | uint32_t padding; | |
b6aeaded MS |
650 | }; |
651 | ||
92a8780e | 652 | struct fuse_setxattr_in { |
4c82456e MS |
653 | uint32_t size; |
654 | uint32_t flags; | |
92a8780e MS |
655 | }; |
656 | ||
657 | struct fuse_getxattr_in { | |
4c82456e MS |
658 | uint32_t size; |
659 | uint32_t padding; | |
92a8780e MS |
660 | }; |
661 | ||
662 | struct fuse_getxattr_out { | |
4c82456e MS |
663 | uint32_t size; |
664 | uint32_t padding; | |
92a8780e MS |
665 | }; |
666 | ||
71421259 | 667 | struct fuse_lk_in { |
4c82456e MS |
668 | uint64_t fh; |
669 | uint64_t owner; | |
71421259 | 670 | struct fuse_file_lock lk; |
4c82456e MS |
671 | uint32_t lk_flags; |
672 | uint32_t padding; | |
71421259 MS |
673 | }; |
674 | ||
675 | struct fuse_lk_out { | |
676 | struct fuse_file_lock lk; | |
677 | }; | |
678 | ||
31d40d74 | 679 | struct fuse_access_in { |
4c82456e MS |
680 | uint32_t mask; |
681 | uint32_t padding; | |
31d40d74 MS |
682 | }; |
683 | ||
3ec870d5 | 684 | struct fuse_init_in { |
4c82456e MS |
685 | uint32_t major; |
686 | uint32_t minor; | |
687 | uint32_t max_readahead; | |
688 | uint32_t flags; | |
334f485d MS |
689 | }; |
690 | ||
e27c9d38 MS |
691 | #define FUSE_COMPAT_INIT_OUT_SIZE 8 |
692 | #define FUSE_COMPAT_22_INIT_OUT_SIZE 24 | |
693 | ||
3ec870d5 | 694 | struct fuse_init_out { |
4c82456e MS |
695 | uint32_t major; |
696 | uint32_t minor; | |
697 | uint32_t max_readahead; | |
698 | uint32_t flags; | |
699 | uint16_t max_background; | |
700 | uint16_t congestion_threshold; | |
701 | uint32_t max_write; | |
e27c9d38 | 702 | uint32_t time_gran; |
5da784cc | 703 | uint16_t max_pages; |
c4bb667e | 704 | uint16_t map_alignment; |
5da784cc | 705 | uint32_t unused[8]; |
3ec870d5 MS |
706 | }; |
707 | ||
151060ac TH |
708 | #define CUSE_INIT_INFO_MAX 4096 |
709 | ||
710 | struct cuse_init_in { | |
4c82456e MS |
711 | uint32_t major; |
712 | uint32_t minor; | |
713 | uint32_t unused; | |
714 | uint32_t flags; | |
151060ac TH |
715 | }; |
716 | ||
717 | struct cuse_init_out { | |
4c82456e MS |
718 | uint32_t major; |
719 | uint32_t minor; | |
720 | uint32_t unused; | |
721 | uint32_t flags; | |
722 | uint32_t max_read; | |
723 | uint32_t max_write; | |
724 | uint32_t dev_major; /* chardev major */ | |
725 | uint32_t dev_minor; /* chardev minor */ | |
726 | uint32_t spare[10]; | |
151060ac TH |
727 | }; |
728 | ||
a4d27e75 | 729 | struct fuse_interrupt_in { |
4c82456e | 730 | uint64_t unique; |
a4d27e75 MS |
731 | }; |
732 | ||
b2d2272f | 733 | struct fuse_bmap_in { |
4c82456e MS |
734 | uint64_t block; |
735 | uint32_t blocksize; | |
736 | uint32_t padding; | |
b2d2272f MS |
737 | }; |
738 | ||
739 | struct fuse_bmap_out { | |
4c82456e | 740 | uint64_t block; |
b2d2272f MS |
741 | }; |
742 | ||
59efec7b | 743 | struct fuse_ioctl_in { |
4c82456e MS |
744 | uint64_t fh; |
745 | uint32_t flags; | |
746 | uint32_t cmd; | |
747 | uint64_t arg; | |
748 | uint32_t in_size; | |
749 | uint32_t out_size; | |
59efec7b TH |
750 | }; |
751 | ||
1baa26b2 | 752 | struct fuse_ioctl_iovec { |
4c82456e MS |
753 | uint64_t base; |
754 | uint64_t len; | |
1baa26b2 MS |
755 | }; |
756 | ||
59efec7b | 757 | struct fuse_ioctl_out { |
4c82456e MS |
758 | int32_t result; |
759 | uint32_t flags; | |
760 | uint32_t in_iovs; | |
761 | uint32_t out_iovs; | |
59efec7b TH |
762 | }; |
763 | ||
95668a69 | 764 | struct fuse_poll_in { |
4c82456e MS |
765 | uint64_t fh; |
766 | uint64_t kh; | |
767 | uint32_t flags; | |
768 | uint32_t events; | |
95668a69 TH |
769 | }; |
770 | ||
771 | struct fuse_poll_out { | |
4c82456e MS |
772 | uint32_t revents; |
773 | uint32_t padding; | |
95668a69 TH |
774 | }; |
775 | ||
776 | struct fuse_notify_poll_wakeup_out { | |
4c82456e | 777 | uint64_t kh; |
95668a69 TH |
778 | }; |
779 | ||
05ba1f08 | 780 | struct fuse_fallocate_in { |
4c82456e MS |
781 | uint64_t fh; |
782 | uint64_t offset; | |
783 | uint64_t length; | |
784 | uint32_t mode; | |
785 | uint32_t padding; | |
05ba1f08 AP |
786 | }; |
787 | ||
334f485d | 788 | struct fuse_in_header { |
4c82456e MS |
789 | uint32_t len; |
790 | uint32_t opcode; | |
791 | uint64_t unique; | |
792 | uint64_t nodeid; | |
793 | uint32_t uid; | |
794 | uint32_t gid; | |
795 | uint32_t pid; | |
796 | uint32_t padding; | |
334f485d MS |
797 | }; |
798 | ||
799 | struct fuse_out_header { | |
4c82456e MS |
800 | uint32_t len; |
801 | int32_t error; | |
802 | uint64_t unique; | |
334f485d MS |
803 | }; |
804 | ||
e5e5558e | 805 | struct fuse_dirent { |
4c82456e MS |
806 | uint64_t ino; |
807 | uint64_t off; | |
808 | uint32_t namelen; | |
809 | uint32_t type; | |
c628ee67 | 810 | char name[]; |
e5e5558e MS |
811 | }; |
812 | ||
21f3da95 | 813 | #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name) |
4c82456e MS |
814 | #define FUSE_DIRENT_ALIGN(x) \ |
815 | (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1)) | |
e5e5558e MS |
816 | #define FUSE_DIRENT_SIZE(d) \ |
817 | FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen) | |
29d434b3 | 818 | |
0b05b183 AA |
819 | struct fuse_direntplus { |
820 | struct fuse_entry_out entry_out; | |
821 | struct fuse_dirent dirent; | |
822 | }; | |
823 | ||
824 | #define FUSE_NAME_OFFSET_DIRENTPLUS \ | |
825 | offsetof(struct fuse_direntplus, dirent.name) | |
826 | #define FUSE_DIRENTPLUS_SIZE(d) \ | |
827 | FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen) | |
828 | ||
3b463ae0 | 829 | struct fuse_notify_inval_inode_out { |
4c82456e MS |
830 | uint64_t ino; |
831 | int64_t off; | |
832 | int64_t len; | |
3b463ae0 JM |
833 | }; |
834 | ||
835 | struct fuse_notify_inval_entry_out { | |
4c82456e MS |
836 | uint64_t parent; |
837 | uint32_t namelen; | |
838 | uint32_t padding; | |
3b463ae0 JM |
839 | }; |
840 | ||
451d0f59 | 841 | struct fuse_notify_delete_out { |
4c82456e MS |
842 | uint64_t parent; |
843 | uint64_t child; | |
844 | uint32_t namelen; | |
845 | uint32_t padding; | |
451d0f59 JM |
846 | }; |
847 | ||
a1d75f25 | 848 | struct fuse_notify_store_out { |
4c82456e MS |
849 | uint64_t nodeid; |
850 | uint64_t offset; | |
851 | uint32_t size; | |
852 | uint32_t padding; | |
a1d75f25 MS |
853 | }; |
854 | ||
2d45ba38 | 855 | struct fuse_notify_retrieve_out { |
4c82456e MS |
856 | uint64_t notify_unique; |
857 | uint64_t nodeid; | |
858 | uint64_t offset; | |
859 | uint32_t size; | |
860 | uint32_t padding; | |
2d45ba38 MS |
861 | }; |
862 | ||
863 | /* Matches the size of fuse_write_in */ | |
864 | struct fuse_notify_retrieve_in { | |
4c82456e MS |
865 | uint64_t dummy1; |
866 | uint64_t offset; | |
867 | uint32_t size; | |
868 | uint32_t dummy2; | |
869 | uint64_t dummy3; | |
870 | uint64_t dummy4; | |
2d45ba38 MS |
871 | }; |
872 | ||
00c570f4 MS |
873 | /* Device ioctls: */ |
874 | #define FUSE_DEV_IOC_CLONE _IOR(229, 0, uint32_t) | |
875 | ||
0b5da8db R |
876 | struct fuse_lseek_in { |
877 | uint64_t fh; | |
878 | uint64_t offset; | |
879 | uint32_t whence; | |
880 | uint32_t padding; | |
881 | }; | |
882 | ||
883 | struct fuse_lseek_out { | |
884 | uint64_t offset; | |
885 | }; | |
886 | ||
88bc7d50 NV |
887 | struct fuse_copy_file_range_in { |
888 | uint64_t fh_in; | |
889 | uint64_t off_in; | |
890 | uint64_t nodeid_out; | |
891 | uint64_t fh_out; | |
892 | uint64_t off_out; | |
893 | uint64_t len; | |
894 | uint64_t flags; | |
895 | }; | |
896 | ||
ceec02d4 | 897 | #define FUSE_SETUPMAPPING_FLAG_WRITE (1ull << 0) |
c2d0ad00 | 898 | #define FUSE_SETUPMAPPING_FLAG_READ (1ull << 1) |
ceec02d4 VG |
899 | struct fuse_setupmapping_in { |
900 | /* An already open handle */ | |
901 | uint64_t fh; | |
902 | /* Offset into the file to start the mapping */ | |
903 | uint64_t foffset; | |
904 | /* Length of mapping required */ | |
905 | uint64_t len; | |
906 | /* Flags, FUSE_SETUPMAPPING_FLAG_* */ | |
907 | uint64_t flags; | |
908 | /* Offset in Memory Window */ | |
909 | uint64_t moffset; | |
910 | }; | |
911 | ||
912 | struct fuse_removemapping_in { | |
913 | /* number of fuse_removemapping_one follows */ | |
914 | uint32_t count; | |
915 | }; | |
916 | ||
917 | struct fuse_removemapping_one { | |
918 | /* Offset into the dax window start the unmapping */ | |
919 | uint64_t moffset; | |
920 | /* Length of mapping required */ | |
921 | uint64_t len; | |
922 | }; | |
923 | ||
924 | #define FUSE_REMOVEMAPPING_MAX_ENTRY \ | |
925 | (PAGE_SIZE / sizeof(struct fuse_removemapping_one)) | |
926 | ||
29d434b3 | 927 | #endif /* _LINUX_FUSE_H */ |