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