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