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