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 #ifndef _LINUX_FUSE_H
122 #define _LINUX_FUSE_H
127 * Version negotiation:
129 * Both the kernel and userspace send the version they support in the
130 * INIT request and reply respectively.
132 * If the major versions match then both shall use the smallest
133 * of the two minor versions for communication.
135 * If the kernel supports a larger major version, then userspace shall
136 * reply with the major version it supports, ignore the rest of the
137 * INIT message and expect a new INIT message from the kernel with a
138 * matching major version.
140 * If the library supports a larger major version, then it shall fall
141 * back to the major protocol version sent by the kernel for
142 * communication and reply with that major version (and an arbitrary
143 * supported minor version).
146 /** Version number of this interface */
147 #define FUSE_KERNEL_VERSION 7
149 /** Minor version number of this interface */
150 #define FUSE_KERNEL_MINOR_VERSION 27
152 /** The node ID of the root inode */
153 #define FUSE_ROOT_ID 1
155 /* Make sure all structures are padded to 64bit boundary, so 32bit
156 userspace works under 64bit kernels */
177 struct fuse_kstatfs {
190 struct fuse_file_lock {
194 uint32_t pid; /* tgid */
198 * Bitmasks for fuse_setattr_in.valid
200 #define FATTR_MODE (1 << 0)
201 #define FATTR_UID (1 << 1)
202 #define FATTR_GID (1 << 2)
203 #define FATTR_SIZE (1 << 3)
204 #define FATTR_ATIME (1 << 4)
205 #define FATTR_MTIME (1 << 5)
206 #define FATTR_FH (1 << 6)
207 #define FATTR_ATIME_NOW (1 << 7)
208 #define FATTR_MTIME_NOW (1 << 8)
209 #define FATTR_LOCKOWNER (1 << 9)
210 #define FATTR_CTIME (1 << 10)
213 * Flags returned by the OPEN request
215 * FOPEN_DIRECT_IO: bypass page cache for this open file
216 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
217 * FOPEN_NONSEEKABLE: the file is not seekable
218 * FOPEN_STREAM: the file is stream-like (no file position at all)
220 #define FOPEN_DIRECT_IO (1 << 0)
221 #define FOPEN_KEEP_CACHE (1 << 1)
222 #define FOPEN_NONSEEKABLE (1 << 2)
223 #define FOPEN_STREAM (1 << 4)
226 * INIT request/reply flags
228 * FUSE_ASYNC_READ: asynchronous read requests
229 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
230 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
231 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
232 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
233 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
234 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
235 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
236 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
237 * FUSE_SPLICE_READ: kernel supports splice read on the device
238 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
239 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
240 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
241 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
242 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
243 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
244 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
245 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
246 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
247 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
248 * FUSE_POSIX_ACL: filesystem supports posix acls
249 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED
251 #define FUSE_ASYNC_READ (1 << 0)
252 #define FUSE_POSIX_LOCKS (1 << 1)
253 #define FUSE_FILE_OPS (1 << 2)
254 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
255 #define FUSE_EXPORT_SUPPORT (1 << 4)
256 #define FUSE_BIG_WRITES (1 << 5)
257 #define FUSE_DONT_MASK (1 << 6)
258 #define FUSE_SPLICE_WRITE (1 << 7)
259 #define FUSE_SPLICE_MOVE (1 << 8)
260 #define FUSE_SPLICE_READ (1 << 9)
261 #define FUSE_FLOCK_LOCKS (1 << 10)
262 #define FUSE_HAS_IOCTL_DIR (1 << 11)
263 #define FUSE_AUTO_INVAL_DATA (1 << 12)
264 #define FUSE_DO_READDIRPLUS (1 << 13)
265 #define FUSE_READDIRPLUS_AUTO (1 << 14)
266 #define FUSE_ASYNC_DIO (1 << 15)
267 #define FUSE_WRITEBACK_CACHE (1 << 16)
268 #define FUSE_NO_OPEN_SUPPORT (1 << 17)
269 #define FUSE_PARALLEL_DIROPS (1 << 18)
270 #define FUSE_HANDLE_KILLPRIV (1 << 19)
271 #define FUSE_POSIX_ACL (1 << 20)
272 #define FUSE_ABORT_ERROR (1 << 21)
275 * CUSE INIT request/reply flags
277 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
279 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
284 #define FUSE_RELEASE_FLUSH (1 << 0)
285 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
290 #define FUSE_GETATTR_FH (1 << 0)
295 #define FUSE_LK_FLOCK (1 << 0)
300 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
301 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
303 #define FUSE_WRITE_CACHE (1 << 0)
304 #define FUSE_WRITE_LOCKOWNER (1 << 1)
309 #define FUSE_READ_LOCKOWNER (1 << 1)
314 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
315 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
316 * FUSE_IOCTL_RETRY: retry with new iovecs
317 * FUSE_IOCTL_32BIT: 32bit ioctl
318 * FUSE_IOCTL_DIR: is a directory
320 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
322 #define FUSE_IOCTL_COMPAT (1 << 0)
323 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
324 #define FUSE_IOCTL_RETRY (1 << 2)
325 #define FUSE_IOCTL_32BIT (1 << 3)
326 #define FUSE_IOCTL_DIR (1 << 4)
328 #define FUSE_IOCTL_MAX_IOV 256
333 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
335 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
339 FUSE_FORGET = 2, /* no reply */
359 FUSE_REMOVEXATTR = 24,
364 FUSE_RELEASEDIR = 29,
376 FUSE_NOTIFY_REPLY = 41,
377 FUSE_BATCH_FORGET = 42,
379 FUSE_READDIRPLUS = 44,
383 /* 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_getxattr_in {
570 struct fuse_getxattr_out {
578 struct fuse_file_lock lk;
584 struct fuse_file_lock lk;
587 struct fuse_access_in {
592 struct fuse_init_in {
595 uint32_t max_readahead;
599 #define FUSE_COMPAT_INIT_OUT_SIZE 8
600 #define FUSE_COMPAT_22_INIT_OUT_SIZE 24
602 struct fuse_init_out {
605 uint32_t max_readahead;
607 uint16_t max_background;
608 uint16_t congestion_threshold;
614 #define CUSE_INIT_INFO_MAX 4096
616 struct cuse_init_in {
623 struct cuse_init_out {
630 uint32_t dev_major; /* chardev major */
631 uint32_t dev_minor; /* chardev minor */
635 struct fuse_interrupt_in {
639 struct fuse_bmap_in {
645 struct fuse_bmap_out {
649 struct fuse_ioctl_in {
658 struct fuse_ioctl_iovec {
663 struct fuse_ioctl_out {
670 struct fuse_poll_in {
677 struct fuse_poll_out {
682 struct fuse_notify_poll_wakeup_out {
686 struct fuse_fallocate_in {
694 struct fuse_in_header {
705 struct fuse_out_header {
719 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
720 #define FUSE_DIRENT_ALIGN(x) \
721 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
722 #define FUSE_DIRENT_SIZE(d) \
723 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
725 struct fuse_direntplus {
726 struct fuse_entry_out entry_out;
727 struct fuse_dirent dirent;
730 #define FUSE_NAME_OFFSET_DIRENTPLUS \
731 offsetof(struct fuse_direntplus, dirent.name)
732 #define FUSE_DIRENTPLUS_SIZE(d) \
733 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
735 struct fuse_notify_inval_inode_out {
741 struct fuse_notify_inval_entry_out {
747 struct fuse_notify_delete_out {
754 struct fuse_notify_store_out {
761 struct fuse_notify_retrieve_out {
762 uint64_t notify_unique;
769 /* Matches the size of fuse_write_in */
770 struct fuse_notify_retrieve_in {
780 #define FUSE_DEV_IOC_CLONE _IOR(229, 0, uint32_t)
782 struct fuse_lseek_in {
789 struct fuse_lseek_out {
793 #endif /* _LINUX_FUSE_H */