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 * This file defines the kernel interface of FUSE
42 * - new fuse_getattr_in input argument of GETATTR
43 * - add lk_flags in fuse_lk_in
44 * - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
45 * - add blksize field to fuse_attr
46 * - add file flags field to fuse_read_in and fuse_write_in
47 * - Add ATIME_NOW and MTIME_NOW flags to fuse_setattr_in
50 * - add nonseekable open flag
54 * - add unsolicited notification support
55 * - add POLL message and NOTIFY_POLL notification
58 * - add umask flag to input argument of create, mknod and mkdir
59 * - add notification messages for invalidation of inodes and
63 * - make max number of background requests and congestion threshold
67 * - add splice support to fuse device
71 * - add retrieve notify
74 * - add BATCH_FORGET request
75 * - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
76 * fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
77 * - add FUSE_IOCTL_32BIT flag
80 * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
83 * - add FUSE_IOCTL_DIR flag
84 * - add FUSE_NOTIFY_DELETE
87 * - add FUSE_FALLOCATE
90 * - add FUSE_AUTO_INVAL_DATA
93 * - add FUSE_READDIRPLUS
94 * - send the requested events in POLL request
97 * - add FUSE_ASYNC_DIO
100 * - add FUSE_WRITEBACK_CACHE
101 * - add time_gran to fuse_init_out
102 * - add reserved space to fuse_init_out
104 * - add ctime and ctimensec to fuse_setattr_in
105 * - add FUSE_RENAME2 request
106 * - add FUSE_NO_OPEN_SUPPORT flag
109 * - add FUSE_LSEEK for SEEK_HOLE and SEEK_DATA support
112 * - add FUSE_PARALLEL_DIROPS
115 * - add FUSE_HANDLE_KILLPRIV
116 * - add FUSE_POSIX_ACL
119 * - add FUSE_ABORT_ERROR
122 * - add FUSE_COPY_FILE_RANGE
123 * - add FOPEN_CACHE_DIR
124 * - add FUSE_MAX_PAGES, add max_pages to init_out
125 * - add FUSE_CACHE_SYMLINKS
128 * - add FUSE_NO_OPENDIR_SUPPORT flag
131 * - add FUSE_EXPLICIT_INVAL_DATA
132 * - add FUSE_IOCTL_COMPAT_X32
135 * - add FUSE_WRITE_KILL_PRIV flag
136 * - add FUSE_SETUPMAPPING and FUSE_REMOVEMAPPING
137 * - add map_alignment to fuse_init_out, add FUSE_MAP_ALIGNMENT flag
140 #ifndef _LINUX_FUSE_H
141 #define _LINUX_FUSE_H
144 #include <linux/types.h>
150 * Version negotiation:
152 * Both the kernel and userspace send the version they support in the
153 * INIT request and reply respectively.
155 * If the major versions match then both shall use the smallest
156 * of the two minor versions for communication.
158 * If the kernel supports a larger major version, then userspace shall
159 * reply with the major version it supports, ignore the rest of the
160 * INIT message and expect a new INIT message from the kernel with a
161 * matching major version.
163 * If the library supports a larger major version, then it shall fall
164 * back to the major protocol version sent by the kernel for
165 * communication and reply with that major version (and an arbitrary
166 * supported minor version).
169 /** Version number of this interface */
170 #define FUSE_KERNEL_VERSION 7
172 /** Minor version number of this interface */
173 #define FUSE_KERNEL_MINOR_VERSION 31
175 /** The node ID of the root inode */
176 #define FUSE_ROOT_ID 1
178 /* Make sure all structures are padded to 64bit boundary, so 32bit
179 userspace works under 64bit kernels */
200 struct fuse_kstatfs {
213 struct fuse_file_lock {
217 uint32_t pid; /* tgid */
221 * Bitmasks for fuse_setattr_in.valid
223 #define FATTR_MODE (1 << 0)
224 #define FATTR_UID (1 << 1)
225 #define FATTR_GID (1 << 2)
226 #define FATTR_SIZE (1 << 3)
227 #define FATTR_ATIME (1 << 4)
228 #define FATTR_MTIME (1 << 5)
229 #define FATTR_FH (1 << 6)
230 #define FATTR_ATIME_NOW (1 << 7)
231 #define FATTR_MTIME_NOW (1 << 8)
232 #define FATTR_LOCKOWNER (1 << 9)
233 #define FATTR_CTIME (1 << 10)
236 * Flags returned by the OPEN request
238 * FOPEN_DIRECT_IO: bypass page cache for this open file
239 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
240 * FOPEN_NONSEEKABLE: the file is not seekable
241 * FOPEN_CACHE_DIR: allow caching this directory
242 * FOPEN_STREAM: the file is stream-like (no file position at all)
244 #define FOPEN_DIRECT_IO (1 << 0)
245 #define FOPEN_KEEP_CACHE (1 << 1)
246 #define FOPEN_NONSEEKABLE (1 << 2)
247 #define FOPEN_CACHE_DIR (1 << 3)
248 #define FOPEN_STREAM (1 << 4)
251 * INIT request/reply flags
253 * FUSE_ASYNC_READ: asynchronous read requests
254 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
255 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
256 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
257 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
258 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
259 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
260 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
261 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
262 * FUSE_SPLICE_READ: kernel supports splice read on the device
263 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
264 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
265 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
266 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
267 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
268 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
269 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
270 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
271 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
272 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
273 * FUSE_POSIX_ACL: filesystem supports posix acls
274 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED
275 * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages
276 * FUSE_CACHE_SYMLINKS: cache READLINK responses
277 * FUSE_NO_OPENDIR_SUPPORT: kernel supports zero-message opendir
278 * FUSE_EXPLICIT_INVAL_DATA: only invalidate cached pages on explicit request
279 * FUSE_MAP_ALIGNMENT: map_alignment field is valid
281 #define FUSE_ASYNC_READ (1 << 0)
282 #define FUSE_POSIX_LOCKS (1 << 1)
283 #define FUSE_FILE_OPS (1 << 2)
284 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
285 #define FUSE_EXPORT_SUPPORT (1 << 4)
286 #define FUSE_BIG_WRITES (1 << 5)
287 #define FUSE_DONT_MASK (1 << 6)
288 #define FUSE_SPLICE_WRITE (1 << 7)
289 #define FUSE_SPLICE_MOVE (1 << 8)
290 #define FUSE_SPLICE_READ (1 << 9)
291 #define FUSE_FLOCK_LOCKS (1 << 10)
292 #define FUSE_HAS_IOCTL_DIR (1 << 11)
293 #define FUSE_AUTO_INVAL_DATA (1 << 12)
294 #define FUSE_DO_READDIRPLUS (1 << 13)
295 #define FUSE_READDIRPLUS_AUTO (1 << 14)
296 #define FUSE_ASYNC_DIO (1 << 15)
297 #define FUSE_WRITEBACK_CACHE (1 << 16)
298 #define FUSE_NO_OPEN_SUPPORT (1 << 17)
299 #define FUSE_PARALLEL_DIROPS (1 << 18)
300 #define FUSE_HANDLE_KILLPRIV (1 << 19)
301 #define FUSE_POSIX_ACL (1 << 20)
302 #define FUSE_ABORT_ERROR (1 << 21)
303 #define FUSE_MAX_PAGES (1 << 22)
304 #define FUSE_CACHE_SYMLINKS (1 << 23)
305 #define FUSE_NO_OPENDIR_SUPPORT (1 << 24)
306 #define FUSE_EXPLICIT_INVAL_DATA (1 << 25)
307 #define FUSE_MAP_ALIGNMENT (1 << 26)
310 * CUSE INIT request/reply flags
312 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
314 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
319 #define FUSE_RELEASE_FLUSH (1 << 0)
320 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
325 #define FUSE_GETATTR_FH (1 << 0)
330 #define FUSE_LK_FLOCK (1 << 0)
335 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
336 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
337 * FUSE_WRITE_KILL_PRIV: kill suid and sgid bits
339 #define FUSE_WRITE_CACHE (1 << 0)
340 #define FUSE_WRITE_LOCKOWNER (1 << 1)
341 #define FUSE_WRITE_KILL_PRIV (1 << 2)
346 #define FUSE_READ_LOCKOWNER (1 << 1)
351 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
352 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
353 * FUSE_IOCTL_RETRY: retry with new iovecs
354 * FUSE_IOCTL_32BIT: 32bit ioctl
355 * FUSE_IOCTL_DIR: is a directory
356 * FUSE_IOCTL_COMPAT_X32: x32 compat ioctl on 64bit machine (64bit time_t)
358 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
360 #define FUSE_IOCTL_COMPAT (1 << 0)
361 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
362 #define FUSE_IOCTL_RETRY (1 << 2)
363 #define FUSE_IOCTL_32BIT (1 << 3)
364 #define FUSE_IOCTL_DIR (1 << 4)
365 #define FUSE_IOCTL_COMPAT_X32 (1 << 5)
367 #define FUSE_IOCTL_MAX_IOV 256
372 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
374 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
379 * FUSE_FSYNC_FDATASYNC: Sync data only, not metadata
381 #define FUSE_FSYNC_FDATASYNC (1 << 0)
385 FUSE_FORGET = 2, /* no reply */
405 FUSE_REMOVEXATTR = 24,
410 FUSE_RELEASEDIR = 29,
422 FUSE_NOTIFY_REPLY = 41,
423 FUSE_BATCH_FORGET = 42,
425 FUSE_READDIRPLUS = 44,
428 FUSE_COPY_FILE_RANGE = 47,
429 FUSE_SETUPMAPPING = 48,
430 FUSE_REMOVEMAPPING = 49,
432 /* CUSE specific operations */
435 /* Reserved opcodes: helpful to detect structure endian-ness */
436 CUSE_INIT_BSWAP_RESERVED = 1048576, /* CUSE_INIT << 8 */
437 FUSE_INIT_BSWAP_RESERVED = 436207616, /* FUSE_INIT << 24 */
440 enum fuse_notify_code {
441 FUSE_NOTIFY_POLL = 1,
442 FUSE_NOTIFY_INVAL_INODE = 2,
443 FUSE_NOTIFY_INVAL_ENTRY = 3,
444 FUSE_NOTIFY_STORE = 4,
445 FUSE_NOTIFY_RETRIEVE = 5,
446 FUSE_NOTIFY_DELETE = 6,
447 FUSE_NOTIFY_CODE_MAX,
450 /* The read buffer is required to be at least 8k, but may be much larger */
451 #define FUSE_MIN_READ_BUFFER 8192
453 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
455 struct fuse_entry_out {
456 uint64_t nodeid; /* Inode ID */
457 uint64_t generation; /* Inode generation: nodeid:gen must
458 be unique for the fs's lifetime */
459 uint64_t entry_valid; /* Cache timeout for the name */
460 uint64_t attr_valid; /* Cache timeout for the attributes */
461 uint32_t entry_valid_nsec;
462 uint32_t attr_valid_nsec;
463 struct fuse_attr attr;
466 struct fuse_forget_in {
470 struct fuse_forget_one {
475 struct fuse_batch_forget_in {
480 struct fuse_getattr_in {
481 uint32_t getattr_flags;
486 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
488 struct fuse_attr_out {
489 uint64_t attr_valid; /* Cache timeout for the attributes */
490 uint32_t attr_valid_nsec;
492 struct fuse_attr attr;
495 #define FUSE_COMPAT_MKNOD_IN_SIZE 8
497 struct fuse_mknod_in {
504 struct fuse_mkdir_in {
509 struct fuse_rename_in {
513 struct fuse_rename2_in {
519 struct fuse_link_in {
523 struct fuse_setattr_in {
542 struct fuse_open_in {
547 struct fuse_create_in {
554 struct fuse_open_out {
560 struct fuse_release_in {
563 uint32_t release_flags;
567 struct fuse_flush_in {
574 struct fuse_read_in {
584 #define FUSE_COMPAT_WRITE_IN_SIZE 24
586 struct fuse_write_in {
590 uint32_t write_flags;
596 struct fuse_write_out {
601 #define FUSE_COMPAT_STATFS_SIZE 48
603 struct fuse_statfs_out {
604 struct fuse_kstatfs st;
607 struct fuse_fsync_in {
609 uint32_t fsync_flags;
613 struct fuse_setxattr_in {
618 struct fuse_getxattr_in {
623 struct fuse_getxattr_out {
631 struct fuse_file_lock lk;
637 struct fuse_file_lock lk;
640 struct fuse_access_in {
645 struct fuse_init_in {
648 uint32_t max_readahead;
652 #define FUSE_COMPAT_INIT_OUT_SIZE 8
653 #define FUSE_COMPAT_22_INIT_OUT_SIZE 24
655 struct fuse_init_out {
658 uint32_t max_readahead;
660 uint16_t max_background;
661 uint16_t congestion_threshold;
665 uint16_t map_alignment;
669 #define CUSE_INIT_INFO_MAX 4096
671 struct cuse_init_in {
678 struct cuse_init_out {
685 uint32_t dev_major; /* chardev major */
686 uint32_t dev_minor; /* chardev minor */
690 struct fuse_interrupt_in {
694 struct fuse_bmap_in {
700 struct fuse_bmap_out {
704 struct fuse_ioctl_in {
713 struct fuse_ioctl_iovec {
718 struct fuse_ioctl_out {
725 struct fuse_poll_in {
732 struct fuse_poll_out {
737 struct fuse_notify_poll_wakeup_out {
741 struct fuse_fallocate_in {
749 struct fuse_in_header {
760 struct fuse_out_header {
774 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
775 #define FUSE_DIRENT_ALIGN(x) \
776 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
777 #define FUSE_DIRENT_SIZE(d) \
778 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
780 struct fuse_direntplus {
781 struct fuse_entry_out entry_out;
782 struct fuse_dirent dirent;
785 #define FUSE_NAME_OFFSET_DIRENTPLUS \
786 offsetof(struct fuse_direntplus, dirent.name)
787 #define FUSE_DIRENTPLUS_SIZE(d) \
788 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
790 struct fuse_notify_inval_inode_out {
796 struct fuse_notify_inval_entry_out {
802 struct fuse_notify_delete_out {
809 struct fuse_notify_store_out {
816 struct fuse_notify_retrieve_out {
817 uint64_t notify_unique;
824 /* Matches the size of fuse_write_in */
825 struct fuse_notify_retrieve_in {
835 #define FUSE_DEV_IOC_CLONE _IOR(229, 0, uint32_t)
837 struct fuse_lseek_in {
844 struct fuse_lseek_out {
848 struct fuse_copy_file_range_in {
858 #endif /* _LINUX_FUSE_H */