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