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
49 * - add nonseekable open flag
53 * - add unsolicited notification support
54 * - add POLL message and NOTIFY_POLL notification
57 * - add umask flag to input argument of open, mknod and mkdir
58 * - add notification messages for invalidation of inodes and
62 * - make max number of background requests and congestion threshold
66 * - add splice support to fuse device
70 * - add retrieve notify
73 * - add BATCH_FORGET request
74 * - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
75 * fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
76 * - add FUSE_IOCTL_32BIT flag
79 * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
82 * - add FUSE_IOCTL_DIR flag
83 * - add FUSE_NOTIFY_DELETE
86 * - add FUSE_FALLOCATE
89 * - add FUSE_AUTO_INVAL_DATA
92 * - add FUSE_READDIRPLUS
93 * - send the requested events in POLL request
96 * - add FUSE_ASYNC_DIO
99 * - add FUSE_WRITEBACK_CACHE
100 * - add time_gran to fuse_init_out
101 * - add reserved space to fuse_init_out
103 * - add ctime and ctimensec to fuse_setattr_in
104 * - add FUSE_RENAME2 request
105 * - add FUSE_NO_OPEN_SUPPORT flag
108 * - add FUSE_LSEEK for SEEK_HOLE and SEEK_DATA support
111 * - add FUSE_PARALLEL_DIROPS
114 * - add FUSE_HANDLE_KILLPRIV
115 * - add FUSE_POSIX_ACL
118 * - add FUSE_ABORT_ERROR
121 * - add FUSE_COPY_FILE_RANGE
122 * - add FOPEN_CACHE_DIR
123 * - add FUSE_MAX_PAGES, add max_pages to init_out
124 * - add FUSE_CACHE_SYMLINKS
127 #ifndef _LINUX_FUSE_H
128 #define _LINUX_FUSE_H
131 #include <linux/types.h>
137 * Version negotiation:
139 * Both the kernel and userspace send the version they support in the
140 * INIT request and reply respectively.
142 * If the major versions match then both shall use the smallest
143 * of the two minor versions for communication.
145 * If the kernel supports a larger major version, then userspace shall
146 * reply with the major version it supports, ignore the rest of the
147 * INIT message and expect a new INIT message from the kernel with a
148 * matching major version.
150 * If the library supports a larger major version, then it shall fall
151 * back to the major protocol version sent by the kernel for
152 * communication and reply with that major version (and an arbitrary
153 * supported minor version).
156 /** Version number of this interface */
157 #define FUSE_KERNEL_VERSION 7
159 /** Minor version number of this interface */
160 #define FUSE_KERNEL_MINOR_VERSION 28
162 /** The node ID of the root inode */
163 #define FUSE_ROOT_ID 1
165 /* Make sure all structures are padded to 64bit boundary, so 32bit
166 userspace works under 64bit kernels */
187 struct fuse_kstatfs {
200 struct fuse_file_lock {
204 uint32_t pid; /* tgid */
208 * Bitmasks for fuse_setattr_in.valid
210 #define FATTR_MODE (1 << 0)
211 #define FATTR_UID (1 << 1)
212 #define FATTR_GID (1 << 2)
213 #define FATTR_SIZE (1 << 3)
214 #define FATTR_ATIME (1 << 4)
215 #define FATTR_MTIME (1 << 5)
216 #define FATTR_FH (1 << 6)
217 #define FATTR_ATIME_NOW (1 << 7)
218 #define FATTR_MTIME_NOW (1 << 8)
219 #define FATTR_LOCKOWNER (1 << 9)
220 #define FATTR_CTIME (1 << 10)
223 * Flags returned by the OPEN request
225 * FOPEN_DIRECT_IO: bypass page cache for this open file
226 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
227 * FOPEN_NONSEEKABLE: the file is not seekable
228 * FOPEN_CACHE_DIR: allow caching this directory
230 #define FOPEN_DIRECT_IO (1 << 0)
231 #define FOPEN_KEEP_CACHE (1 << 1)
232 #define FOPEN_NONSEEKABLE (1 << 2)
233 #define FOPEN_CACHE_DIR (1 << 3)
236 * INIT request/reply flags
238 * FUSE_ASYNC_READ: asynchronous read requests
239 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
240 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
241 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
242 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
243 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
244 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
245 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
246 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
247 * FUSE_SPLICE_READ: kernel supports splice read on the device
248 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
249 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
250 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
251 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
252 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
253 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
254 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
255 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
256 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
257 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
258 * FUSE_POSIX_ACL: filesystem supports posix acls
259 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED
260 * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages
261 * FUSE_CACHE_SYMLINKS: cache READLINK responses
263 #define FUSE_ASYNC_READ (1 << 0)
264 #define FUSE_POSIX_LOCKS (1 << 1)
265 #define FUSE_FILE_OPS (1 << 2)
266 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
267 #define FUSE_EXPORT_SUPPORT (1 << 4)
268 #define FUSE_BIG_WRITES (1 << 5)
269 #define FUSE_DONT_MASK (1 << 6)
270 #define FUSE_SPLICE_WRITE (1 << 7)
271 #define FUSE_SPLICE_MOVE (1 << 8)
272 #define FUSE_SPLICE_READ (1 << 9)
273 #define FUSE_FLOCK_LOCKS (1 << 10)
274 #define FUSE_HAS_IOCTL_DIR (1 << 11)
275 #define FUSE_AUTO_INVAL_DATA (1 << 12)
276 #define FUSE_DO_READDIRPLUS (1 << 13)
277 #define FUSE_READDIRPLUS_AUTO (1 << 14)
278 #define FUSE_ASYNC_DIO (1 << 15)
279 #define FUSE_WRITEBACK_CACHE (1 << 16)
280 #define FUSE_NO_OPEN_SUPPORT (1 << 17)
281 #define FUSE_PARALLEL_DIROPS (1 << 18)
282 #define FUSE_HANDLE_KILLPRIV (1 << 19)
283 #define FUSE_POSIX_ACL (1 << 20)
284 #define FUSE_ABORT_ERROR (1 << 21)
285 #define FUSE_MAX_PAGES (1 << 22)
286 #define FUSE_CACHE_SYMLINKS (1 << 23)
289 * CUSE INIT request/reply flags
291 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
293 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
298 #define FUSE_RELEASE_FLUSH (1 << 0)
299 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
304 #define FUSE_GETATTR_FH (1 << 0)
309 #define FUSE_LK_FLOCK (1 << 0)
314 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
315 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
317 #define FUSE_WRITE_CACHE (1 << 0)
318 #define FUSE_WRITE_LOCKOWNER (1 << 1)
323 #define FUSE_READ_LOCKOWNER (1 << 1)
328 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
329 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
330 * FUSE_IOCTL_RETRY: retry with new iovecs
331 * FUSE_IOCTL_32BIT: 32bit ioctl
332 * FUSE_IOCTL_DIR: is a directory
334 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
336 #define FUSE_IOCTL_COMPAT (1 << 0)
337 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
338 #define FUSE_IOCTL_RETRY (1 << 2)
339 #define FUSE_IOCTL_32BIT (1 << 3)
340 #define FUSE_IOCTL_DIR (1 << 4)
342 #define FUSE_IOCTL_MAX_IOV 256
347 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
349 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
353 FUSE_FORGET = 2, /* no reply */
373 FUSE_REMOVEXATTR = 24,
378 FUSE_RELEASEDIR = 29,
390 FUSE_NOTIFY_REPLY = 41,
391 FUSE_BATCH_FORGET = 42,
393 FUSE_READDIRPLUS = 44,
396 FUSE_COPY_FILE_RANGE = 47,
398 /* CUSE specific operations */
402 enum fuse_notify_code {
403 FUSE_NOTIFY_POLL = 1,
404 FUSE_NOTIFY_INVAL_INODE = 2,
405 FUSE_NOTIFY_INVAL_ENTRY = 3,
406 FUSE_NOTIFY_STORE = 4,
407 FUSE_NOTIFY_RETRIEVE = 5,
408 FUSE_NOTIFY_DELETE = 6,
409 FUSE_NOTIFY_CODE_MAX,
412 /* The read buffer is required to be at least 8k, but may be much larger */
413 #define FUSE_MIN_READ_BUFFER 8192
415 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
417 struct fuse_entry_out {
418 uint64_t nodeid; /* Inode ID */
419 uint64_t generation; /* Inode generation: nodeid:gen must
420 be unique for the fs's lifetime */
421 uint64_t entry_valid; /* Cache timeout for the name */
422 uint64_t attr_valid; /* Cache timeout for the attributes */
423 uint32_t entry_valid_nsec;
424 uint32_t attr_valid_nsec;
425 struct fuse_attr attr;
428 struct fuse_forget_in {
432 struct fuse_forget_one {
437 struct fuse_batch_forget_in {
442 struct fuse_getattr_in {
443 uint32_t getattr_flags;
448 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
450 struct fuse_attr_out {
451 uint64_t attr_valid; /* Cache timeout for the attributes */
452 uint32_t attr_valid_nsec;
454 struct fuse_attr attr;
457 #define FUSE_COMPAT_MKNOD_IN_SIZE 8
459 struct fuse_mknod_in {
466 struct fuse_mkdir_in {
471 struct fuse_rename_in {
475 struct fuse_rename2_in {
481 struct fuse_link_in {
485 struct fuse_setattr_in {
504 struct fuse_open_in {
509 struct fuse_create_in {
516 struct fuse_open_out {
522 struct fuse_release_in {
525 uint32_t release_flags;
529 struct fuse_flush_in {
536 struct fuse_read_in {
546 #define FUSE_COMPAT_WRITE_IN_SIZE 24
548 struct fuse_write_in {
552 uint32_t write_flags;
558 struct fuse_write_out {
563 #define FUSE_COMPAT_STATFS_SIZE 48
565 struct fuse_statfs_out {
566 struct fuse_kstatfs st;
569 struct fuse_fsync_in {
571 uint32_t fsync_flags;
575 struct fuse_setxattr_in {
580 struct fuse_getxattr_in {
585 struct fuse_getxattr_out {
593 struct fuse_file_lock lk;
599 struct fuse_file_lock lk;
602 struct fuse_access_in {
607 struct fuse_init_in {
610 uint32_t max_readahead;
614 #define FUSE_COMPAT_INIT_OUT_SIZE 8
615 #define FUSE_COMPAT_22_INIT_OUT_SIZE 24
617 struct fuse_init_out {
620 uint32_t max_readahead;
622 uint16_t max_background;
623 uint16_t congestion_threshold;
631 #define CUSE_INIT_INFO_MAX 4096
633 struct cuse_init_in {
640 struct cuse_init_out {
647 uint32_t dev_major; /* chardev major */
648 uint32_t dev_minor; /* chardev minor */
652 struct fuse_interrupt_in {
656 struct fuse_bmap_in {
662 struct fuse_bmap_out {
666 struct fuse_ioctl_in {
675 struct fuse_ioctl_iovec {
680 struct fuse_ioctl_out {
687 struct fuse_poll_in {
694 struct fuse_poll_out {
699 struct fuse_notify_poll_wakeup_out {
703 struct fuse_fallocate_in {
711 struct fuse_in_header {
722 struct fuse_out_header {
736 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
737 #define FUSE_DIRENT_ALIGN(x) \
738 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
739 #define FUSE_DIRENT_SIZE(d) \
740 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
742 struct fuse_direntplus {
743 struct fuse_entry_out entry_out;
744 struct fuse_dirent dirent;
747 #define FUSE_NAME_OFFSET_DIRENTPLUS \
748 offsetof(struct fuse_direntplus, dirent.name)
749 #define FUSE_DIRENTPLUS_SIZE(d) \
750 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
752 struct fuse_notify_inval_inode_out {
758 struct fuse_notify_inval_entry_out {
764 struct fuse_notify_delete_out {
771 struct fuse_notify_store_out {
778 struct fuse_notify_retrieve_out {
779 uint64_t notify_unique;
786 /* Matches the size of fuse_write_in */
787 struct fuse_notify_retrieve_in {
797 #define FUSE_DEV_IOC_CLONE _IOR(229, 0, uint32_t)
799 struct fuse_lseek_in {
806 struct fuse_lseek_out {
810 struct fuse_copy_file_range_in {
820 #endif /* _LINUX_FUSE_H */