1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */
3 This file defines the kernel interface of FUSE
4 Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu>
6 This program can be distributed under the terms of the GNU GPL.
9 This -- and only this -- header file may also be distributed under
10 the terms of the BSD Licence as follows:
12 Copyright (C) 2001-2007 Miklos Szeredi. All rights reserved.
14 Redistribution and use in source and binary forms, with or without
15 modification, are permitted provided that the following conditions
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.
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
37 * XXX Note: Don't edit this file. Keep it unchanged from Linux kernel.
40 * This file defines the kernel interface of FUSE
45 * - new fuse_getattr_in input argument of GETATTR
46 * - add lk_flags in fuse_lk_in
47 * - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
48 * - add blksize field to fuse_attr
49 * - add file flags field to fuse_read_in and fuse_write_in
52 * - add nonseekable open flag
56 * - add unsolicited notification support
57 * - add POLL message and NOTIFY_POLL notification
60 * - add umask flag to input argument of open, mknod and mkdir
61 * - add notification messages for invalidation of inodes and
65 * - make max number of background requests and congestion threshold
69 * - add splice support to fuse device
73 * - add retrieve notify
76 * - add BATCH_FORGET request
77 * - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
78 * fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
79 * - add FUSE_IOCTL_32BIT flag
82 * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
85 * - add FUSE_IOCTL_DIR flag
86 * - add FUSE_NOTIFY_DELETE
89 * - add FUSE_FALLOCATE
92 * - add FUSE_AUTO_INVAL_DATA
95 * - add FUSE_READDIRPLUS
96 * - send the requested events in POLL request
99 * - add FUSE_ASYNC_DIO
102 * - add FUSE_WRITEBACK_CACHE
103 * - add time_gran to fuse_init_out
104 * - add reserved space to fuse_init_out
106 * - add ctime and ctimensec to fuse_setattr_in
107 * - add FUSE_RENAME2 request
108 * - add FUSE_NO_OPEN_SUPPORT flag
111 * - add FUSE_LSEEK for SEEK_HOLE and SEEK_DATA support
114 * - add FUSE_PARALLEL_DIROPS
117 * - add FUSE_HANDLE_KILLPRIV
118 * - add FUSE_POSIX_ACL
121 * - add FUSE_ABORT_ERROR
124 * - add FUSE_COPY_FILE_RANGE
125 * - add FOPEN_CACHE_DIR
126 * - add FUSE_MAX_PAGES, add max_pages to init_out
127 * - add FUSE_CACHE_SYMLINKS
130 #ifndef _LINUX_FUSE_H
131 #define _LINUX_FUSE_H
134 #include <sys/stdint.h>
135 #elif defined(__KERNEL__)
136 #include <linux/types.h>
142 * Version negotiation:
144 * Both the kernel and userspace send the version they support in the
145 * INIT request and reply respectively.
147 * If the major versions match then both shall use the smallest
148 * of the two minor versions for communication.
150 * If the kernel supports a larger major version, then userspace shall
151 * reply with the major version it supports, ignore the rest of the
152 * INIT message and expect a new INIT message from the kernel with a
153 * matching major version.
155 * If the library supports a larger major version, then it shall fall
156 * back to the major protocol version sent by the kernel for
157 * communication and reply with that major version (and an arbitrary
158 * supported minor version).
161 /** Version number of this interface */
162 #define FUSE_KERNEL_VERSION 7
164 /** Minor version number of this interface */
165 #define FUSE_KERNEL_MINOR_VERSION 28
167 /** The node ID of the root inode */
168 #define FUSE_ROOT_ID 1
170 /* Make sure all structures are padded to 64bit boundary, so 32bit
171 userspace works under 64bit kernels */
192 struct fuse_kstatfs
{
205 struct fuse_file_lock
{
209 uint32_t pid
; /* tgid */
213 * Bitmasks for fuse_setattr_in.valid
215 #define FATTR_MODE (1 << 0)
216 #define FATTR_UID (1 << 1)
217 #define FATTR_GID (1 << 2)
218 #define FATTR_SIZE (1 << 3)
219 #define FATTR_ATIME (1 << 4)
220 #define FATTR_MTIME (1 << 5)
221 #define FATTR_FH (1 << 6)
222 #define FATTR_ATIME_NOW (1 << 7)
223 #define FATTR_MTIME_NOW (1 << 8)
224 #define FATTR_LOCKOWNER (1 << 9)
225 #define FATTR_CTIME (1 << 10)
228 * Flags returned by the OPEN request
230 * FOPEN_DIRECT_IO: bypass page cache for this open file
231 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
232 * FOPEN_NONSEEKABLE: the file is not seekable
233 * FOPEN_CACHE_DIR: allow caching this directory
235 #define FOPEN_DIRECT_IO (1 << 0)
236 #define FOPEN_KEEP_CACHE (1 << 1)
237 #define FOPEN_NONSEEKABLE (1 << 2)
238 #define FOPEN_CACHE_DIR (1 << 3)
241 * INIT request/reply flags
243 * FUSE_ASYNC_READ: asynchronous read requests
244 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
245 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
246 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
247 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
248 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
249 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
250 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
251 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
252 * FUSE_SPLICE_READ: kernel supports splice read on the device
253 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
254 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
255 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
256 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
257 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
258 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
259 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
260 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
261 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
262 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
263 * FUSE_POSIX_ACL: filesystem supports posix acls
264 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED
265 * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages
266 * FUSE_CACHE_SYMLINKS: cache READLINK responses
268 #define FUSE_ASYNC_READ (1 << 0)
269 #define FUSE_POSIX_LOCKS (1 << 1)
270 #define FUSE_FILE_OPS (1 << 2)
271 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
272 #define FUSE_EXPORT_SUPPORT (1 << 4)
273 #define FUSE_BIG_WRITES (1 << 5)
274 #define FUSE_DONT_MASK (1 << 6)
275 #define FUSE_SPLICE_WRITE (1 << 7)
276 #define FUSE_SPLICE_MOVE (1 << 8)
277 #define FUSE_SPLICE_READ (1 << 9)
278 #define FUSE_FLOCK_LOCKS (1 << 10)
279 #define FUSE_HAS_IOCTL_DIR (1 << 11)
280 #define FUSE_AUTO_INVAL_DATA (1 << 12)
281 #define FUSE_DO_READDIRPLUS (1 << 13)
282 #define FUSE_READDIRPLUS_AUTO (1 << 14)
283 #define FUSE_ASYNC_DIO (1 << 15)
284 #define FUSE_WRITEBACK_CACHE (1 << 16)
285 #define FUSE_NO_OPEN_SUPPORT (1 << 17)
286 #define FUSE_PARALLEL_DIROPS (1 << 18)
287 #define FUSE_HANDLE_KILLPRIV (1 << 19)
288 #define FUSE_POSIX_ACL (1 << 20)
289 #define FUSE_ABORT_ERROR (1 << 21)
290 #define FUSE_MAX_PAGES (1 << 22)
291 #define FUSE_CACHE_SYMLINKS (1 << 23)
294 * CUSE INIT request/reply flags
296 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
298 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
303 #define FUSE_RELEASE_FLUSH (1 << 0)
304 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
309 #define FUSE_GETATTR_FH (1 << 0)
314 #define FUSE_LK_FLOCK (1 << 0)
319 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
320 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
322 #define FUSE_WRITE_CACHE (1 << 0)
323 #define FUSE_WRITE_LOCKOWNER (1 << 1)
328 #define FUSE_READ_LOCKOWNER (1 << 1)
333 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
334 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
335 * FUSE_IOCTL_RETRY: retry with new iovecs
336 * FUSE_IOCTL_32BIT: 32bit ioctl
337 * FUSE_IOCTL_DIR: is a directory
339 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
341 #define FUSE_IOCTL_COMPAT (1 << 0)
342 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
343 #define FUSE_IOCTL_RETRY (1 << 2)
344 #define FUSE_IOCTL_32BIT (1 << 3)
345 #define FUSE_IOCTL_DIR (1 << 4)
347 #define FUSE_IOCTL_MAX_IOV 256
352 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
354 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
358 FUSE_FORGET
= 2, /* no reply */
378 FUSE_REMOVEXATTR
= 24,
383 FUSE_RELEASEDIR
= 29,
395 FUSE_NOTIFY_REPLY
= 41,
396 FUSE_BATCH_FORGET
= 42,
398 FUSE_READDIRPLUS
= 44,
401 FUSE_COPY_FILE_RANGE
= 47,
403 /* CUSE specific operations */
407 enum fuse_notify_code
{
408 FUSE_NOTIFY_POLL
= 1,
409 FUSE_NOTIFY_INVAL_INODE
= 2,
410 FUSE_NOTIFY_INVAL_ENTRY
= 3,
411 FUSE_NOTIFY_STORE
= 4,
412 FUSE_NOTIFY_RETRIEVE
= 5,
413 FUSE_NOTIFY_DELETE
= 6,
414 FUSE_NOTIFY_CODE_MAX
,
417 /* The read buffer is required to be at least 8k, but may be much larger */
418 #define FUSE_MIN_READ_BUFFER 8192
420 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
422 struct fuse_entry_out
{
423 uint64_t nodeid
; /* Inode ID */
424 uint64_t generation
; /* Inode generation: nodeid:gen must
425 be unique for the fs's lifetime */
426 uint64_t entry_valid
; /* Cache timeout for the name */
427 uint64_t attr_valid
; /* Cache timeout for the attributes */
428 uint32_t entry_valid_nsec
;
429 uint32_t attr_valid_nsec
;
430 struct fuse_attr attr
;
433 struct fuse_forget_in
{
437 struct fuse_forget_one
{
442 struct fuse_batch_forget_in
{
447 struct fuse_getattr_in
{
448 uint32_t getattr_flags
;
453 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
455 struct fuse_attr_out
{
456 uint64_t attr_valid
; /* Cache timeout for the attributes */
457 uint32_t attr_valid_nsec
;
459 struct fuse_attr attr
;
462 #define FUSE_COMPAT_MKNOD_IN_SIZE 8
464 struct fuse_mknod_in
{
471 struct fuse_mkdir_in
{
476 struct fuse_rename_in
{
480 struct fuse_rename2_in
{
486 struct fuse_link_in
{
490 struct fuse_setattr_in
{
509 struct fuse_open_in
{
514 struct fuse_create_in
{
521 struct fuse_open_out
{
527 struct fuse_release_in
{
530 uint32_t release_flags
;
534 struct fuse_flush_in
{
541 struct fuse_read_in
{
551 #define FUSE_COMPAT_WRITE_IN_SIZE 24
553 struct fuse_write_in
{
557 uint32_t write_flags
;
563 struct fuse_write_out
{
568 #define FUSE_COMPAT_STATFS_SIZE 48
570 struct fuse_statfs_out
{
571 struct fuse_kstatfs st
;
574 struct fuse_fsync_in
{
576 uint32_t fsync_flags
;
580 struct fuse_setxattr_in
{
585 struct fuse_getxattr_in
{
590 struct fuse_getxattr_out
{
598 struct fuse_file_lock lk
;
604 struct fuse_file_lock lk
;
607 struct fuse_access_in
{
612 struct fuse_init_in
{
615 uint32_t max_readahead
;
619 #define FUSE_COMPAT_INIT_OUT_SIZE 8
620 #define FUSE_COMPAT_22_INIT_OUT_SIZE 24
622 struct fuse_init_out
{
625 uint32_t max_readahead
;
627 uint16_t max_background
;
628 uint16_t congestion_threshold
;
636 #define CUSE_INIT_INFO_MAX 4096
638 struct cuse_init_in
{
645 struct cuse_init_out
{
652 uint32_t dev_major
; /* chardev major */
653 uint32_t dev_minor
; /* chardev minor */
657 struct fuse_interrupt_in
{
661 struct fuse_bmap_in
{
667 struct fuse_bmap_out
{
671 struct fuse_ioctl_in
{
680 struct fuse_ioctl_iovec
{
685 struct fuse_ioctl_out
{
692 struct fuse_poll_in
{
699 struct fuse_poll_out
{
704 struct fuse_notify_poll_wakeup_out
{
708 struct fuse_fallocate_in
{
716 struct fuse_in_header
{
727 struct fuse_out_header
{
741 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
742 #define FUSE_DIRENT_ALIGN(x) \
743 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
744 #define FUSE_DIRENT_SIZE(d) \
745 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
747 struct fuse_direntplus
{
748 struct fuse_entry_out entry_out
;
749 struct fuse_dirent dirent
;
752 #define FUSE_NAME_OFFSET_DIRENTPLUS \
753 offsetof(struct fuse_direntplus, dirent.name)
754 #define FUSE_DIRENTPLUS_SIZE(d) \
755 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
757 struct fuse_notify_inval_inode_out
{
763 struct fuse_notify_inval_entry_out
{
769 struct fuse_notify_delete_out
{
776 struct fuse_notify_store_out
{
783 struct fuse_notify_retrieve_out
{
784 uint64_t notify_unique
;
791 /* Matches the size of fuse_write_in */
792 struct fuse_notify_retrieve_in
{
802 #define FUSE_DEV_IOC_CLONE _IOR(229, 0, uint32_t)
804 struct fuse_lseek_in
{
811 struct fuse_lseek_out
{
815 struct fuse_copy_file_range_in
{
825 #endif /* _LINUX_FUSE_H */