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