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 * - add the following messages:
43 * FUSE_SETATTR, FUSE_SYMLINK, FUSE_MKNOD, FUSE_MKDIR, FUSE_UNLINK,
44 * FUSE_RMDIR, FUSE_RENAME, FUSE_LINK, FUSE_OPEN, FUSE_READ, FUSE_WRITE,
45 * FUSE_RELEASE, FUSE_FSYNC, FUSE_FLUSH, FUSE_SETXATTR, FUSE_GETXATTR,
46 * FUSE_LISTXATTR, FUSE_REMOVEXATTR, FUSE_OPENDIR, FUSE_READDIR,
48 * - add padding to messages to accommodate 32-bit servers on 64-bit kernels
51 * - add FOPEN_DIRECT_IO and FOPEN_KEEP_CACHE flags
52 * - add FUSE_FSYNCDIR message
55 * - add FUSE_ACCESS message
56 * - add FUSE_CREATE message
57 * - add filehandle to fuse_setattr_in
60 * - add frsize to fuse_kstatfs
61 * - clean up request size limit checking
64 * - add flags and max_write to fuse_init_out
67 * - add max_readahead to fuse_init_in and fuse_init_out
70 * - add FUSE_INTERRUPT message
71 * - add POSIX file lock support
74 * - add lock_owner and flags fields to fuse_release_in
75 * - add FUSE_BMAP message
76 * - add FUSE_DESTROY message
79 * - new fuse_getattr_in input argument of GETATTR
80 * - add lk_flags in fuse_lk_in
81 * - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
82 * - add blksize field to fuse_attr
83 * - add file flags field to fuse_read_in and fuse_write_in
84 * - Add ATIME_NOW and MTIME_NOW flags to fuse_setattr_in
87 * - add nonseekable open flag
91 * - add unsolicited notification support
92 * - add POLL message and NOTIFY_POLL notification
95 * - add umask flag to input argument of create, mknod and mkdir
96 * - add notification messages for invalidation of inodes and
100 * - make max number of background requests and congestion threshold
104 * - add splice support to fuse device
108 * - add retrieve notify
111 * - add BATCH_FORGET request
112 * - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
113 * fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
114 * - add FUSE_IOCTL_32BIT flag
117 * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
120 * - add FUSE_IOCTL_DIR flag
121 * - add FUSE_NOTIFY_DELETE
124 * - add FUSE_FALLOCATE
127 * - add FUSE_AUTO_INVAL_DATA
130 * - add FUSE_READDIRPLUS
131 * - send the requested events in POLL request
134 * - add FUSE_ASYNC_DIO
137 * - add FUSE_WRITEBACK_CACHE
138 * - add time_gran to fuse_init_out
139 * - add reserved space to fuse_init_out
141 * - add ctime and ctimensec to fuse_setattr_in
142 * - add FUSE_RENAME2 request
143 * - add FUSE_NO_OPEN_SUPPORT flag
146 * - add FUSE_LSEEK for SEEK_HOLE and SEEK_DATA support
149 * - add FUSE_PARALLEL_DIROPS
152 * - add FUSE_HANDLE_KILLPRIV
153 * - add FUSE_POSIX_ACL
156 * - add FUSE_ABORT_ERROR
159 * - add FUSE_COPY_FILE_RANGE
160 * - add FOPEN_CACHE_DIR
161 * - add FUSE_MAX_PAGES, add max_pages to init_out
162 * - add FUSE_CACHE_SYMLINKS
165 * - add FUSE_NO_OPENDIR_SUPPORT flag
168 * - add FUSE_EXPLICIT_INVAL_DATA
169 * - add FUSE_IOCTL_COMPAT_X32
172 * - add FUSE_WRITE_KILL_PRIV flag
173 * - add FUSE_SETUPMAPPING and FUSE_REMOVEMAPPING
174 * - add map_alignment to fuse_init_out, add FUSE_MAP_ALIGNMENT flag
177 #ifndef _LINUX_FUSE_H
178 #define _LINUX_FUSE_H
181 #include <linux/types.h>
187 * Version negotiation:
189 * Both the kernel and userspace send the version they support in the
190 * INIT request and reply respectively.
192 * If the major versions match then both shall use the smallest
193 * of the two minor versions for communication.
195 * If the kernel supports a larger major version, then userspace shall
196 * reply with the major version it supports, ignore the rest of the
197 * INIT message and expect a new INIT message from the kernel with a
198 * matching major version.
200 * If the library supports a larger major version, then it shall fall
201 * back to the major protocol version sent by the kernel for
202 * communication and reply with that major version (and an arbitrary
203 * supported minor version).
206 /** Version number of this interface */
207 #define FUSE_KERNEL_VERSION 7
209 /** Minor version number of this interface */
210 #define FUSE_KERNEL_MINOR_VERSION 31
212 /** The node ID of the root inode */
213 #define FUSE_ROOT_ID 1
215 /* Make sure all structures are padded to 64bit boundary, so 32bit
216 userspace works under 64bit kernels */
237 struct fuse_kstatfs {
250 struct fuse_file_lock {
254 uint32_t pid; /* tgid */
258 * Bitmasks for fuse_setattr_in.valid
260 #define FATTR_MODE (1 << 0)
261 #define FATTR_UID (1 << 1)
262 #define FATTR_GID (1 << 2)
263 #define FATTR_SIZE (1 << 3)
264 #define FATTR_ATIME (1 << 4)
265 #define FATTR_MTIME (1 << 5)
266 #define FATTR_FH (1 << 6)
267 #define FATTR_ATIME_NOW (1 << 7)
268 #define FATTR_MTIME_NOW (1 << 8)
269 #define FATTR_LOCKOWNER (1 << 9)
270 #define FATTR_CTIME (1 << 10)
273 * Flags returned by the OPEN request
275 * FOPEN_DIRECT_IO: bypass page cache for this open file
276 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
277 * FOPEN_NONSEEKABLE: the file is not seekable
278 * FOPEN_CACHE_DIR: allow caching this directory
279 * FOPEN_STREAM: the file is stream-like (no file position at all)
281 #define FOPEN_DIRECT_IO (1 << 0)
282 #define FOPEN_KEEP_CACHE (1 << 1)
283 #define FOPEN_NONSEEKABLE (1 << 2)
284 #define FOPEN_CACHE_DIR (1 << 3)
285 #define FOPEN_STREAM (1 << 4)
288 * INIT request/reply flags
290 * FUSE_ASYNC_READ: asynchronous read requests
291 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
292 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
293 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
294 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
295 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
296 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
297 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
298 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
299 * FUSE_SPLICE_READ: kernel supports splice read on the device
300 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
301 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
302 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
303 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
304 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
305 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
306 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
307 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
308 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
309 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
310 * FUSE_POSIX_ACL: filesystem supports posix acls
311 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED
312 * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages
313 * FUSE_CACHE_SYMLINKS: cache READLINK responses
314 * FUSE_NO_OPENDIR_SUPPORT: kernel supports zero-message opendir
315 * FUSE_EXPLICIT_INVAL_DATA: only invalidate cached pages on explicit request
316 * FUSE_MAP_ALIGNMENT: map_alignment field is valid
318 #define FUSE_ASYNC_READ (1 << 0)
319 #define FUSE_POSIX_LOCKS (1 << 1)
320 #define FUSE_FILE_OPS (1 << 2)
321 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
322 #define FUSE_EXPORT_SUPPORT (1 << 4)
323 #define FUSE_BIG_WRITES (1 << 5)
324 #define FUSE_DONT_MASK (1 << 6)
325 #define FUSE_SPLICE_WRITE (1 << 7)
326 #define FUSE_SPLICE_MOVE (1 << 8)
327 #define FUSE_SPLICE_READ (1 << 9)
328 #define FUSE_FLOCK_LOCKS (1 << 10)
329 #define FUSE_HAS_IOCTL_DIR (1 << 11)
330 #define FUSE_AUTO_INVAL_DATA (1 << 12)
331 #define FUSE_DO_READDIRPLUS (1 << 13)
332 #define FUSE_READDIRPLUS_AUTO (1 << 14)
333 #define FUSE_ASYNC_DIO (1 << 15)
334 #define FUSE_WRITEBACK_CACHE (1 << 16)
335 #define FUSE_NO_OPEN_SUPPORT (1 << 17)
336 #define FUSE_PARALLEL_DIROPS (1 << 18)
337 #define FUSE_HANDLE_KILLPRIV (1 << 19)
338 #define FUSE_POSIX_ACL (1 << 20)
339 #define FUSE_ABORT_ERROR (1 << 21)
340 #define FUSE_MAX_PAGES (1 << 22)
341 #define FUSE_CACHE_SYMLINKS (1 << 23)
342 #define FUSE_NO_OPENDIR_SUPPORT (1 << 24)
343 #define FUSE_EXPLICIT_INVAL_DATA (1 << 25)
344 #define FUSE_MAP_ALIGNMENT (1 << 26)
347 * CUSE INIT request/reply flags
349 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
351 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
356 #define FUSE_RELEASE_FLUSH (1 << 0)
357 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
362 #define FUSE_GETATTR_FH (1 << 0)
367 #define FUSE_LK_FLOCK (1 << 0)
372 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
373 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
374 * FUSE_WRITE_KILL_PRIV: kill suid and sgid bits
376 #define FUSE_WRITE_CACHE (1 << 0)
377 #define FUSE_WRITE_LOCKOWNER (1 << 1)
378 #define FUSE_WRITE_KILL_PRIV (1 << 2)
383 #define FUSE_READ_LOCKOWNER (1 << 1)
388 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
389 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
390 * FUSE_IOCTL_RETRY: retry with new iovecs
391 * FUSE_IOCTL_32BIT: 32bit ioctl
392 * FUSE_IOCTL_DIR: is a directory
393 * FUSE_IOCTL_COMPAT_X32: x32 compat ioctl on 64bit machine (64bit time_t)
395 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
397 #define FUSE_IOCTL_COMPAT (1 << 0)
398 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
399 #define FUSE_IOCTL_RETRY (1 << 2)
400 #define FUSE_IOCTL_32BIT (1 << 3)
401 #define FUSE_IOCTL_DIR (1 << 4)
402 #define FUSE_IOCTL_COMPAT_X32 (1 << 5)
404 #define FUSE_IOCTL_MAX_IOV 256
409 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
411 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
416 * FUSE_FSYNC_FDATASYNC: Sync data only, not metadata
418 #define FUSE_FSYNC_FDATASYNC (1 << 0)
422 FUSE_FORGET = 2, /* no reply */
442 FUSE_REMOVEXATTR = 24,
447 FUSE_RELEASEDIR = 29,
459 FUSE_NOTIFY_REPLY = 41,
460 FUSE_BATCH_FORGET = 42,
462 FUSE_READDIRPLUS = 44,
465 FUSE_COPY_FILE_RANGE = 47,
466 FUSE_SETUPMAPPING = 48,
467 FUSE_REMOVEMAPPING = 49,
469 /* CUSE specific operations */
472 /* Reserved opcodes: helpful to detect structure endian-ness */
473 CUSE_INIT_BSWAP_RESERVED = 1048576, /* CUSE_INIT << 8 */
474 FUSE_INIT_BSWAP_RESERVED = 436207616, /* FUSE_INIT << 24 */
477 enum fuse_notify_code {
478 FUSE_NOTIFY_POLL = 1,
479 FUSE_NOTIFY_INVAL_INODE = 2,
480 FUSE_NOTIFY_INVAL_ENTRY = 3,
481 FUSE_NOTIFY_STORE = 4,
482 FUSE_NOTIFY_RETRIEVE = 5,
483 FUSE_NOTIFY_DELETE = 6,
484 FUSE_NOTIFY_CODE_MAX,
487 /* The read buffer is required to be at least 8k, but may be much larger */
488 #define FUSE_MIN_READ_BUFFER 8192
490 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
492 struct fuse_entry_out {
493 uint64_t nodeid; /* Inode ID */
494 uint64_t generation; /* Inode generation: nodeid:gen must
495 be unique for the fs's lifetime */
496 uint64_t entry_valid; /* Cache timeout for the name */
497 uint64_t attr_valid; /* Cache timeout for the attributes */
498 uint32_t entry_valid_nsec;
499 uint32_t attr_valid_nsec;
500 struct fuse_attr attr;
503 struct fuse_forget_in {
507 struct fuse_forget_one {
512 struct fuse_batch_forget_in {
517 struct fuse_getattr_in {
518 uint32_t getattr_flags;
523 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
525 struct fuse_attr_out {
526 uint64_t attr_valid; /* Cache timeout for the attributes */
527 uint32_t attr_valid_nsec;
529 struct fuse_attr attr;
532 #define FUSE_COMPAT_MKNOD_IN_SIZE 8
534 struct fuse_mknod_in {
541 struct fuse_mkdir_in {
546 struct fuse_rename_in {
550 struct fuse_rename2_in {
556 struct fuse_link_in {
560 struct fuse_setattr_in {
579 struct fuse_open_in {
584 struct fuse_create_in {
591 struct fuse_open_out {
597 struct fuse_release_in {
600 uint32_t release_flags;
604 struct fuse_flush_in {
611 struct fuse_read_in {
621 #define FUSE_COMPAT_WRITE_IN_SIZE 24
623 struct fuse_write_in {
627 uint32_t write_flags;
633 struct fuse_write_out {
638 #define FUSE_COMPAT_STATFS_SIZE 48
640 struct fuse_statfs_out {
641 struct fuse_kstatfs st;
644 struct fuse_fsync_in {
646 uint32_t fsync_flags;
650 struct fuse_setxattr_in {
655 struct fuse_getxattr_in {
660 struct fuse_getxattr_out {
668 struct fuse_file_lock lk;
674 struct fuse_file_lock lk;
677 struct fuse_access_in {
682 struct fuse_init_in {
685 uint32_t max_readahead;
689 #define FUSE_COMPAT_INIT_OUT_SIZE 8
690 #define FUSE_COMPAT_22_INIT_OUT_SIZE 24
692 struct fuse_init_out {
695 uint32_t max_readahead;
697 uint16_t max_background;
698 uint16_t congestion_threshold;
702 uint16_t map_alignment;
706 #define CUSE_INIT_INFO_MAX 4096
708 struct cuse_init_in {
715 struct cuse_init_out {
722 uint32_t dev_major; /* chardev major */
723 uint32_t dev_minor; /* chardev minor */
727 struct fuse_interrupt_in {
731 struct fuse_bmap_in {
737 struct fuse_bmap_out {
741 struct fuse_ioctl_in {
750 struct fuse_ioctl_iovec {
755 struct fuse_ioctl_out {
762 struct fuse_poll_in {
769 struct fuse_poll_out {
774 struct fuse_notify_poll_wakeup_out {
778 struct fuse_fallocate_in {
786 struct fuse_in_header {
797 struct fuse_out_header {
811 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
812 #define FUSE_DIRENT_ALIGN(x) \
813 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
814 #define FUSE_DIRENT_SIZE(d) \
815 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
817 struct fuse_direntplus {
818 struct fuse_entry_out entry_out;
819 struct fuse_dirent dirent;
822 #define FUSE_NAME_OFFSET_DIRENTPLUS \
823 offsetof(struct fuse_direntplus, dirent.name)
824 #define FUSE_DIRENTPLUS_SIZE(d) \
825 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
827 struct fuse_notify_inval_inode_out {
833 struct fuse_notify_inval_entry_out {
839 struct fuse_notify_delete_out {
846 struct fuse_notify_store_out {
853 struct fuse_notify_retrieve_out {
854 uint64_t notify_unique;
861 /* Matches the size of fuse_write_in */
862 struct fuse_notify_retrieve_in {
872 #define FUSE_DEV_IOC_CLONE _IOR(229, 0, uint32_t)
874 struct fuse_lseek_in {
881 struct fuse_lseek_out {
885 struct fuse_copy_file_range_in {
895 #endif /* _LINUX_FUSE_H */