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