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
38 * This file defines the kernel interface of FUSE
43 * - add the following messages:
44 * FUSE_SETATTR, FUSE_SYMLINK, FUSE_MKNOD, FUSE_MKDIR, FUSE_UNLINK,
45 * FUSE_RMDIR, FUSE_RENAME, FUSE_LINK, FUSE_OPEN, FUSE_READ, FUSE_WRITE,
46 * FUSE_RELEASE, FUSE_FSYNC, FUSE_FLUSH, FUSE_SETXATTR, FUSE_GETXATTR,
47 * FUSE_LISTXATTR, FUSE_REMOVEXATTR, FUSE_OPENDIR, FUSE_READDIR,
49 * - add padding to messages to accommodate 32-bit servers on 64-bit kernels
52 * - add FOPEN_DIRECT_IO and FOPEN_KEEP_CACHE flags
53 * - add FUSE_FSYNCDIR message
56 * - add FUSE_ACCESS message
57 * - add FUSE_CREATE message
58 * - add filehandle to fuse_setattr_in
61 * - add frsize to fuse_kstatfs
62 * - clean up request size limit checking
65 * - add flags and max_write to fuse_init_out
68 * - add max_readahead to fuse_init_in and fuse_init_out
71 * - add FUSE_INTERRUPT message
72 * - add POSIX file lock support
75 * - add lock_owner and flags fields to fuse_release_in
76 * - add FUSE_BMAP message
77 * - add FUSE_DESTROY message
80 * - new fuse_getattr_in input argument of GETATTR
81 * - add lk_flags in fuse_lk_in
82 * - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
83 * - add blksize field to fuse_attr
84 * - add file flags field to fuse_read_in and fuse_write_in
85 * - Add ATIME_NOW and MTIME_NOW flags to fuse_setattr_in
88 * - add nonseekable open flag
92 * - add unsolicited notification support
93 * - add POLL message and NOTIFY_POLL notification
96 * - add umask flag to input argument of create, mknod and mkdir
97 * - add notification messages for invalidation of inodes and
101 * - make max number of background requests and congestion threshold
105 * - add splice support to fuse device
109 * - add retrieve notify
112 * - add BATCH_FORGET request
113 * - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
114 * fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
115 * - add FUSE_IOCTL_32BIT flag
118 * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
121 * - add FUSE_IOCTL_DIR flag
122 * - add FUSE_NOTIFY_DELETE
125 * - add FUSE_FALLOCATE
128 * - add FUSE_AUTO_INVAL_DATA
131 * - add FUSE_READDIRPLUS
132 * - send the requested events in POLL request
135 * - add FUSE_ASYNC_DIO
138 * - add FUSE_WRITEBACK_CACHE
139 * - add time_gran to fuse_init_out
140 * - add reserved space to fuse_init_out
142 * - add ctime and ctimensec to fuse_setattr_in
143 * - add FUSE_RENAME2 request
144 * - add FUSE_NO_OPEN_SUPPORT flag
147 * - add FUSE_LSEEK for SEEK_HOLE and SEEK_DATA support
150 * - add FUSE_PARALLEL_DIROPS
153 * - add FUSE_HANDLE_KILLPRIV
154 * - add FUSE_POSIX_ACL
157 * - add FUSE_ABORT_ERROR
160 * - add FUSE_COPY_FILE_RANGE
161 * - add FOPEN_CACHE_DIR
162 * - add FUSE_MAX_PAGES, add max_pages to init_out
163 * - add FUSE_CACHE_SYMLINKS
166 #ifndef _FUSE_FUSE_KERNEL_H
167 #define _FUSE_FUSE_KERNEL_H
170 #include <linux/types.h>
172 #include <sys/types.h>
176 * Version negotiation:
178 * Both the kernel and userspace send the version they support in the
179 * INIT request and reply respectively.
181 * If the major versions match then both shall use the smallest
182 * of the two minor versions for communication.
184 * If the kernel supports a larger major version, then userspace shall
185 * reply with the major version it supports, ignore the rest of the
186 * INIT message and expect a new INIT message from the kernel with a
187 * matching major version.
189 * If the library supports a larger major version, then it shall fall
190 * back to the major protocol version sent by the kernel for
191 * communication and reply with that major version (and an arbitrary
192 * supported minor version).
195 /** Version number of this interface */
196 #define FUSE_KERNEL_VERSION 7
198 /** Minor version number of this interface */
199 #define FUSE_KERNEL_MINOR_VERSION 29
201 /** The node ID of the root inode */
202 #define FUSE_ROOT_ID 1
204 /* Make sure all structures are padded to 64bit boundary, so 32bit
205 userspace works under 64bit kernels */
226 struct fuse_kstatfs {
239 struct fuse_file_lock {
243 uint32_t pid; /* tgid */
247 * Bitmasks for fuse_setattr_in.valid
249 #define FATTR_MODE (1 << 0)
250 #define FATTR_UID (1 << 1)
251 #define FATTR_GID (1 << 2)
252 #define FATTR_SIZE (1 << 3)
253 #define FATTR_ATIME (1 << 4)
254 #define FATTR_MTIME (1 << 5)
255 #define FATTR_FH (1 << 6)
256 #define FATTR_ATIME_NOW (1 << 7)
257 #define FATTR_MTIME_NOW (1 << 8)
258 #define FATTR_LOCKOWNER (1 << 9)
259 #define FATTR_CTIME (1 << 10)
262 * Flags returned by the OPEN request
264 * FOPEN_DIRECT_IO: bypass page cache for this open file
265 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
266 * FOPEN_NONSEEKABLE: the file is not seekable
267 * FOPEN_CACHE_DIR: allow caching this directory
269 #define FOPEN_DIRECT_IO (1 << 0)
270 #define FOPEN_KEEP_CACHE (1 << 1)
271 #define FOPEN_NONSEEKABLE (1 << 2)
272 #define FOPEN_CACHE_DIR (1 << 3)
275 * INIT request/reply flags
277 * FUSE_ASYNC_READ: asynchronous read requests
278 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
279 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
280 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
281 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
282 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
283 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
284 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
285 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
286 * FUSE_SPLICE_READ: kernel supports splice read on the device
287 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
288 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
289 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
290 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
291 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
292 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
293 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
294 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
295 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
296 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
297 * FUSE_POSIX_ACL: filesystem supports posix acls
298 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED
299 * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages
300 * FUSE_CACHE_SYMLINKS: cache READLINK responses
301 * FUSE_NO_OPENDIR_SUPPORT: kernel supports zero-message opendir
303 #define FUSE_ASYNC_READ (1 << 0)
304 #define FUSE_POSIX_LOCKS (1 << 1)
305 #define FUSE_FILE_OPS (1 << 2)
306 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
307 #define FUSE_EXPORT_SUPPORT (1 << 4)
308 #define FUSE_BIG_WRITES (1 << 5)
309 #define FUSE_DONT_MASK (1 << 6)
310 #define FUSE_SPLICE_WRITE (1 << 7)
311 #define FUSE_SPLICE_MOVE (1 << 8)
312 #define FUSE_SPLICE_READ (1 << 9)
313 #define FUSE_FLOCK_LOCKS (1 << 10)
314 #define FUSE_HAS_IOCTL_DIR (1 << 11)
315 #define FUSE_AUTO_INVAL_DATA (1 << 12)
316 #define FUSE_DO_READDIRPLUS (1 << 13)
317 #define FUSE_READDIRPLUS_AUTO (1 << 14)
318 #define FUSE_ASYNC_DIO (1 << 15)
319 #define FUSE_WRITEBACK_CACHE (1 << 16)
320 #define FUSE_NO_OPEN_SUPPORT (1 << 17)
321 #define FUSE_PARALLEL_DIROPS (1 << 18)
322 #define FUSE_HANDLE_KILLPRIV (1 << 19)
323 #define FUSE_POSIX_ACL (1 << 20)
324 #define FUSE_ABORT_ERROR (1 << 21)
325 #define FUSE_MAX_PAGES (1 << 22)
326 #define FUSE_CACHE_SYMLINKS (1 << 23)
327 #define FUSE_NO_OPENDIR_SUPPORT (1 << 24)
331 * CUSE INIT request/reply flags
333 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
335 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
341 #define FUSE_RELEASE_FLUSH (1 << 0)
342 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
347 #define FUSE_GETATTR_FH (1 << 0)
352 #define FUSE_LK_FLOCK (1 << 0)
357 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
358 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
360 #define FUSE_WRITE_CACHE (1 << 0)
361 #define FUSE_WRITE_LOCKOWNER (1 << 1)
366 #define FUSE_READ_LOCKOWNER (1 << 1)
371 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
372 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
373 * FUSE_IOCTL_RETRY: retry with new iovecs
374 * FUSE_IOCTL_32BIT: 32bit ioctl
375 * FUSE_IOCTL_DIR: is a directory
377 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
379 #define FUSE_IOCTL_COMPAT (1 << 0)
380 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
381 #define FUSE_IOCTL_RETRY (1 << 2)
382 #define FUSE_IOCTL_32BIT (1 << 3)
383 #define FUSE_IOCTL_DIR (1 << 4)
385 #define FUSE_IOCTL_MAX_IOV 256
390 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
392 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
397 * FUSE_FSYNC_FDATASYNC: Sync data only, not metadata
399 #define FUSE_FSYNC_FDATASYNC (1 << 0)
404 #define FUSE_FALLOC_FL_KEEP_SIZE 0x1
405 #define FUSE_FALLOC_FL_PUNCH_HOLE 0x2
409 FUSE_FORGET = 2, /* no reply */
429 FUSE_REMOVEXATTR = 24,
434 FUSE_RELEASEDIR = 29,
446 FUSE_NOTIFY_REPLY = 41,
447 FUSE_BATCH_FORGET = 42,
449 FUSE_READDIRPLUS = 44,
452 FUSE_COPY_FILE_RANGE = 47,
455 /* CUSE specific operations */
460 enum fuse_notify_code {
461 FUSE_NOTIFY_POLL = 1,
462 FUSE_NOTIFY_INVAL_INODE = 2,
463 FUSE_NOTIFY_INVAL_ENTRY = 3,
464 FUSE_NOTIFY_STORE = 4,
465 FUSE_NOTIFY_RETRIEVE = 5,
466 FUSE_NOTIFY_DELETE = 6,
467 FUSE_NOTIFY_CODE_MAX,
470 /* The read buffer is required to be at least 8k, but may be much larger */
471 #define FUSE_MIN_READ_BUFFER 8192
473 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
475 struct fuse_entry_out {
476 uint64_t nodeid; /* Inode ID */
477 uint64_t generation; /* Inode generation: nodeid:gen must
478 be unique for the fs's lifetime */
479 uint64_t entry_valid; /* Cache timeout for the name */
480 uint64_t attr_valid; /* Cache timeout for the attributes */
481 uint32_t entry_valid_nsec;
482 uint32_t attr_valid_nsec;
483 struct fuse_attr attr;
486 struct fuse_forget_in {
490 struct fuse_forget_one {
495 struct fuse_batch_forget_in {
500 struct fuse_getattr_in {
501 uint32_t getattr_flags;
506 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
508 struct fuse_attr_out {
509 uint64_t attr_valid; /* Cache timeout for the attributes */
510 uint32_t attr_valid_nsec;
512 struct fuse_attr attr;
515 #define FUSE_COMPAT_MKNOD_IN_SIZE 8
517 struct fuse_mknod_in {
524 struct fuse_mkdir_in {
529 struct fuse_rename_in {
533 struct fuse_rename2_in {
539 struct fuse_link_in {
543 struct fuse_setattr_in {
562 struct fuse_open_in {
567 struct fuse_create_in {
574 struct fuse_open_out {
580 struct fuse_release_in {
583 uint32_t release_flags;
587 struct fuse_flush_in {
594 struct fuse_read_in {
604 #define FUSE_COMPAT_WRITE_IN_SIZE 24
606 struct fuse_write_in {
610 uint32_t write_flags;
616 struct fuse_write_out {
621 #define FUSE_COMPAT_STATFS_SIZE 48
623 struct fuse_statfs_out {
624 struct fuse_kstatfs st;
627 struct fuse_fsync_in {
629 uint32_t fsync_flags;
633 struct fuse_setxattr_in {
638 struct fuse_listxattr_in {
643 struct fuse_listxattr_out {
648 struct fuse_getxattr_in {
653 struct fuse_getxattr_out {
661 struct fuse_file_lock lk;
667 struct fuse_file_lock lk;
670 struct fuse_access_in {
675 struct fuse_init_in {
678 uint32_t max_readahead;
682 #define FUSE_COMPAT_INIT_OUT_SIZE 8
683 #define FUSE_COMPAT_22_INIT_OUT_SIZE 24
685 struct fuse_init_out {
688 uint32_t max_readahead;
690 uint16_t max_background;
691 uint16_t congestion_threshold;
700 #define CUSE_INIT_INFO_MAX 4096
702 struct cuse_init_in {
709 struct cuse_init_out {
716 uint32_t dev_major; /* chardev major */
717 uint32_t dev_minor; /* chardev minor */
722 struct fuse_interrupt_in {
726 struct fuse_bmap_in {
732 struct fuse_bmap_out {
736 struct fuse_ioctl_in {
745 struct fuse_ioctl_iovec {
750 struct fuse_ioctl_out {
757 struct fuse_poll_in {
764 struct fuse_poll_out {
769 struct fuse_notify_poll_wakeup_out {
773 struct fuse_fallocate_in {
781 struct fuse_in_header {
792 struct fuse_out_header {
806 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
807 #define FUSE_DIRENT_ALIGN(x) \
808 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
809 #define FUSE_DIRENT_SIZE(d) \
810 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
812 struct fuse_direntplus {
813 struct fuse_entry_out entry_out;
814 struct fuse_dirent dirent;
817 #define FUSE_NAME_OFFSET_DIRENTPLUS \
818 offsetof(struct fuse_direntplus, dirent.name)
819 #define FUSE_DIRENTPLUS_SIZE(d) \
820 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
822 struct fuse_notify_inval_inode_out {
828 struct fuse_notify_inval_entry_out {
834 struct fuse_notify_delete_out {
841 struct fuse_notify_store_out {
848 struct fuse_notify_retrieve_out {
849 uint64_t notify_unique;
856 /* Matches the size of fuse_write_in */
857 struct fuse_notify_retrieve_in {
866 struct fuse_lseek_in {
873 struct fuse_lseek_out {
877 struct fuse_copy_file_range_in {
887 #endif /* _FUSE_FUSE_KERNEL_H */