2 * SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause)
4 * This file defines the kernel interface of FUSE
5 * Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu>
7 * This program can be distributed under the terms of the GNU GPL.
8 * See the file COPYING.
10 * This -- and only this -- header file may also be distributed under
11 * the terms of the BSD Licence as follows:
13 * Copyright (C) 2001-2007 Miklos Szeredi. All rights reserved.
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
24 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
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
59 * - add umask flag to input argument of open, mknod and mkdir
60 * - add notification messages for invalidation of inodes and
64 * - make max number of background requests and congestion threshold
68 * - add splice support to fuse device
72 * - add retrieve notify
75 * - add BATCH_FORGET request
76 * - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
77 * fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
78 * - add FUSE_IOCTL_32BIT flag
81 * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
84 * - add FUSE_IOCTL_DIR flag
85 * - add FUSE_NOTIFY_DELETE
88 * - add FUSE_FALLOCATE
91 * - 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 #ifndef _FUSE_FUSE_KERNEL_H
129 #define _FUSE_FUSE_KERNEL_H
132 #include <linux/types.h>
134 #include <sys/types.h>
137 /** Version number of this interface */
138 #define FUSE_KERNEL_VERSION 7
140 /** Minor version number of this interface */
141 #define FUSE_KERNEL_MINOR_VERSION 28
143 /** The node ID of the root inode */
144 #define FUSE_ROOT_ID 1
146 /* Make sure all structures are padded to 64bit boundary, so 32bit
147 userspace works under 64bit kernels */
168 struct fuse_kstatfs {
181 struct fuse_file_lock {
185 uint32_t pid; /* tgid */
189 * Bitmasks for fuse_setattr_in.valid
191 #define FATTR_MODE (1 << 0)
192 #define FATTR_UID (1 << 1)
193 #define FATTR_GID (1 << 2)
194 #define FATTR_SIZE (1 << 3)
195 #define FATTR_ATIME (1 << 4)
196 #define FATTR_MTIME (1 << 5)
197 #define FATTR_FH (1 << 6)
198 #define FATTR_ATIME_NOW (1 << 7)
199 #define FATTR_MTIME_NOW (1 << 8)
200 #define FATTR_LOCKOWNER (1 << 9)
201 #define FATTR_CTIME (1 << 10)
204 * Flags returned by the OPEN request
206 * FOPEN_DIRECT_IO: bypass page cache for this open file
207 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
208 * FOPEN_NONSEEKABLE: the file is not seekable
209 * FOPEN_CACHE_DIR: allow caching this directory
211 #define FOPEN_DIRECT_IO (1 << 0)
212 #define FOPEN_KEEP_CACHE (1 << 1)
213 #define FOPEN_NONSEEKABLE (1 << 2)
214 #define FOPEN_CACHE_DIR (1 << 3)
217 * INIT request/reply flags
219 * FUSE_ASYNC_READ: asynchronous read requests
220 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
221 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
222 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
223 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
224 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
225 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
226 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
227 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
228 * FUSE_SPLICE_READ: kernel supports splice read on the device
229 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
230 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
231 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
232 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
233 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
234 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
235 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
236 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
237 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
238 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
239 * FUSE_POSIX_ACL: filesystem supports posix acls
240 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED
241 * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages
242 * FUSE_CACHE_SYMLINKS: cache READLINK responses
244 #define FUSE_ASYNC_READ (1 << 0)
245 #define FUSE_POSIX_LOCKS (1 << 1)
246 #define FUSE_FILE_OPS (1 << 2)
247 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
248 #define FUSE_EXPORT_SUPPORT (1 << 4)
249 #define FUSE_BIG_WRITES (1 << 5)
250 #define FUSE_DONT_MASK (1 << 6)
251 #define FUSE_SPLICE_WRITE (1 << 7)
252 #define FUSE_SPLICE_MOVE (1 << 8)
253 #define FUSE_SPLICE_READ (1 << 9)
254 #define FUSE_FLOCK_LOCKS (1 << 10)
255 #define FUSE_HAS_IOCTL_DIR (1 << 11)
256 #define FUSE_AUTO_INVAL_DATA (1 << 12)
257 #define FUSE_DO_READDIRPLUS (1 << 13)
258 #define FUSE_READDIRPLUS_AUTO (1 << 14)
259 #define FUSE_ASYNC_DIO (1 << 15)
260 #define FUSE_WRITEBACK_CACHE (1 << 16)
261 #define FUSE_NO_OPEN_SUPPORT (1 << 17)
262 #define FUSE_PARALLEL_DIROPS (1 << 18)
263 #define FUSE_HANDLE_KILLPRIV (1 << 19)
264 #define FUSE_POSIX_ACL (1 << 20)
265 #define FUSE_ABORT_ERROR (1 << 21)
266 #define FUSE_MAX_PAGES (1 << 22)
267 #define FUSE_CACHE_SYMLINKS (1 << 23)
271 * CUSE INIT request/reply flags
273 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
275 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
281 #define FUSE_RELEASE_FLUSH (1 << 0)
282 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
287 #define FUSE_GETATTR_FH (1 << 0)
292 #define FUSE_LK_FLOCK (1 << 0)
297 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
298 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
300 #define FUSE_WRITE_CACHE (1 << 0)
301 #define FUSE_WRITE_LOCKOWNER (1 << 1)
306 #define FUSE_READ_LOCKOWNER (1 << 1)
311 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
312 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
313 * FUSE_IOCTL_RETRY: retry with new iovecs
314 * FUSE_IOCTL_32BIT: 32bit ioctl
315 * FUSE_IOCTL_DIR: is a directory
317 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
319 #define FUSE_IOCTL_COMPAT (1 << 0)
320 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
321 #define FUSE_IOCTL_RETRY (1 << 2)
322 #define FUSE_IOCTL_32BIT (1 << 3)
323 #define FUSE_IOCTL_DIR (1 << 4)
325 #define FUSE_IOCTL_MAX_IOV 256
330 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
332 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
336 FUSE_FORGET = 2, /* no reply */
356 FUSE_REMOVEXATTR = 24,
361 FUSE_RELEASEDIR = 29,
373 FUSE_NOTIFY_REPLY = 41,
374 FUSE_BATCH_FORGET = 42,
376 FUSE_READDIRPLUS = 44,
379 FUSE_COPY_FILE_RANGE = 47,
382 /* CUSE specific operations */
387 enum fuse_notify_code {
388 FUSE_NOTIFY_POLL = 1,
389 FUSE_NOTIFY_INVAL_INODE = 2,
390 FUSE_NOTIFY_INVAL_ENTRY = 3,
391 FUSE_NOTIFY_STORE = 4,
392 FUSE_NOTIFY_RETRIEVE = 5,
393 FUSE_NOTIFY_DELETE = 6,
394 FUSE_NOTIFY_CODE_MAX,
397 /* The read buffer is required to be at least 8k, but may be much larger */
398 #define FUSE_MIN_READ_BUFFER 8192
400 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
402 struct fuse_entry_out {
403 uint64_t nodeid; /* Inode ID */
404 uint64_t generation; /* Inode generation: nodeid:gen must
405 be unique for the fs's lifetime */
406 uint64_t entry_valid; /* Cache timeout for the name */
407 uint64_t attr_valid; /* Cache timeout for the attributes */
408 uint32_t entry_valid_nsec;
409 uint32_t attr_valid_nsec;
410 struct fuse_attr attr;
413 struct fuse_forget_in {
417 struct fuse_forget_one {
422 struct fuse_batch_forget_in {
427 struct fuse_getattr_in {
428 uint32_t getattr_flags;
433 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
435 struct fuse_attr_out {
436 uint64_t attr_valid; /* Cache timeout for the attributes */
437 uint32_t attr_valid_nsec;
439 struct fuse_attr attr;
442 #define FUSE_COMPAT_MKNOD_IN_SIZE 8
444 struct fuse_mknod_in {
451 struct fuse_mkdir_in {
456 struct fuse_rename_in {
460 struct fuse_rename2_in {
466 struct fuse_link_in {
470 struct fuse_setattr_in {
489 struct fuse_open_in {
494 struct fuse_create_in {
501 struct fuse_open_out {
507 struct fuse_release_in {
510 uint32_t release_flags;
514 struct fuse_flush_in {
521 struct fuse_read_in {
531 #define FUSE_COMPAT_WRITE_IN_SIZE 24
533 struct fuse_write_in {
537 uint32_t write_flags;
543 struct fuse_write_out {
548 #define FUSE_COMPAT_STATFS_SIZE 48
550 struct fuse_statfs_out {
551 struct fuse_kstatfs st;
554 struct fuse_fsync_in {
556 uint32_t fsync_flags;
560 struct fuse_setxattr_in {
565 struct fuse_listxattr_in {
570 struct fuse_listxattr_out {
575 struct fuse_getxattr_in {
580 struct fuse_getxattr_out {
588 struct fuse_file_lock lk;
594 struct fuse_file_lock lk;
597 struct fuse_access_in {
602 struct fuse_init_in {
605 uint32_t max_readahead;
609 #define FUSE_COMPAT_INIT_OUT_SIZE 8
610 #define FUSE_COMPAT_22_INIT_OUT_SIZE 24
612 struct fuse_init_out {
615 uint32_t max_readahead;
617 uint16_t max_background;
618 uint16_t congestion_threshold;
627 #define CUSE_INIT_INFO_MAX 4096
629 struct cuse_init_in {
636 struct cuse_init_out {
643 uint32_t dev_major; /* chardev major */
644 uint32_t dev_minor; /* chardev minor */
649 struct fuse_interrupt_in {
653 struct fuse_bmap_in {
659 struct fuse_bmap_out {
663 struct fuse_ioctl_in {
672 struct fuse_ioctl_iovec {
677 struct fuse_ioctl_out {
684 struct fuse_poll_in {
691 struct fuse_poll_out {
696 struct fuse_notify_poll_wakeup_out {
700 struct fuse_fallocate_in {
708 struct fuse_in_header {
719 struct fuse_out_header {
733 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
734 #define FUSE_DIRENT_ALIGN(x) \
735 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
736 #define FUSE_DIRENT_SIZE(d) \
737 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
739 struct fuse_direntplus {
740 struct fuse_entry_out entry_out;
741 struct fuse_dirent dirent;
744 #define FUSE_NAME_OFFSET_DIRENTPLUS \
745 offsetof(struct fuse_direntplus, dirent.name)
746 #define FUSE_DIRENTPLUS_SIZE(d) \
747 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
749 struct fuse_notify_inval_inode_out {
755 struct fuse_notify_inval_entry_out {
761 struct fuse_notify_delete_out {
768 struct fuse_notify_store_out {
775 struct fuse_notify_retrieve_out {
776 uint64_t notify_unique;
783 /* Matches the size of fuse_write_in */
784 struct fuse_notify_retrieve_in {
793 struct fuse_lseek_in {
800 struct fuse_lseek_out {
804 struct fuse_copy_file_range_in {
814 #endif /* _FUSE_FUSE_KERNEL_H */