1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */
3 This file defines the kernel interface of FUSE
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 * - add flags to fuse_attr, add FUSE_ATTR_SUBMOUNT, add FUSE_SUBMOUNTS
180 #ifndef _LINUX_FUSE_H
181 #define _LINUX_FUSE_H
184 #include <linux/types.h>
190 * Version negotiation:
192 * Both the kernel and userspace send the version they support in the
193 * INIT request and reply respectively.
195 * If the major versions match then both shall use the smallest
196 * of the two minor versions for communication.
198 * If the kernel supports a larger major version, then userspace shall
199 * reply with the major version it supports, ignore the rest of the
200 * INIT message and expect a new INIT message from the kernel with a
201 * matching major version.
203 * If the library supports a larger major version, then it shall fall
204 * back to the major protocol version sent by the kernel for
205 * communication and reply with that major version (and an arbitrary
206 * supported minor version).
209 /** Version number of this interface */
210 #define FUSE_KERNEL_VERSION 7
212 /** Minor version number of this interface */
213 #define FUSE_KERNEL_MINOR_VERSION 32
215 /** The node ID of the root inode */
216 #define FUSE_ROOT_ID 1
218 /* Make sure all structures are padded to 64bit boundary, so 32bit
219 userspace works under 64bit kernels */
240 struct fuse_kstatfs {
253 struct fuse_file_lock {
257 uint32_t pid; /* tgid */
261 * Bitmasks for fuse_setattr_in.valid
263 #define FATTR_MODE (1 << 0)
264 #define FATTR_UID (1 << 1)
265 #define FATTR_GID (1 << 2)
266 #define FATTR_SIZE (1 << 3)
267 #define FATTR_ATIME (1 << 4)
268 #define FATTR_MTIME (1 << 5)
269 #define FATTR_FH (1 << 6)
270 #define FATTR_ATIME_NOW (1 << 7)
271 #define FATTR_MTIME_NOW (1 << 8)
272 #define FATTR_LOCKOWNER (1 << 9)
273 #define FATTR_CTIME (1 << 10)
276 * Flags returned by the OPEN request
278 * FOPEN_DIRECT_IO: bypass page cache for this open file
279 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
280 * FOPEN_NONSEEKABLE: the file is not seekable
281 * FOPEN_CACHE_DIR: allow caching this directory
282 * FOPEN_STREAM: the file is stream-like (no file position at all)
284 #define FOPEN_DIRECT_IO (1 << 0)
285 #define FOPEN_KEEP_CACHE (1 << 1)
286 #define FOPEN_NONSEEKABLE (1 << 2)
287 #define FOPEN_CACHE_DIR (1 << 3)
288 #define FOPEN_STREAM (1 << 4)
291 * INIT request/reply flags
293 * FUSE_ASYNC_READ: asynchronous read requests
294 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
295 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
296 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
297 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
298 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
299 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
300 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
301 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
302 * FUSE_SPLICE_READ: kernel supports splice read on the device
303 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
304 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
305 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
306 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
307 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
308 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
309 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
310 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
311 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
312 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
313 * FUSE_POSIX_ACL: filesystem supports posix acls
314 * FUSE_ABORT_ERROR: reading the device after abort returns ECONNABORTED
315 * FUSE_MAX_PAGES: init_out.max_pages contains the max number of req pages
316 * FUSE_CACHE_SYMLINKS: cache READLINK responses
317 * FUSE_NO_OPENDIR_SUPPORT: kernel supports zero-message opendir
318 * FUSE_EXPLICIT_INVAL_DATA: only invalidate cached pages on explicit request
319 * FUSE_MAP_ALIGNMENT: init_out.map_alignment contains log2(byte alignment) for
320 * foffset and moffset fields in struct
321 * fuse_setupmapping_out and fuse_removemapping_one.
322 * FUSE_SUBMOUNTS: kernel supports auto-mounting directory submounts
324 #define FUSE_ASYNC_READ (1 << 0)
325 #define FUSE_POSIX_LOCKS (1 << 1)
326 #define FUSE_FILE_OPS (1 << 2)
327 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
328 #define FUSE_EXPORT_SUPPORT (1 << 4)
329 #define FUSE_BIG_WRITES (1 << 5)
330 #define FUSE_DONT_MASK (1 << 6)
331 #define FUSE_SPLICE_WRITE (1 << 7)
332 #define FUSE_SPLICE_MOVE (1 << 8)
333 #define FUSE_SPLICE_READ (1 << 9)
334 #define FUSE_FLOCK_LOCKS (1 << 10)
335 #define FUSE_HAS_IOCTL_DIR (1 << 11)
336 #define FUSE_AUTO_INVAL_DATA (1 << 12)
337 #define FUSE_DO_READDIRPLUS (1 << 13)
338 #define FUSE_READDIRPLUS_AUTO (1 << 14)
339 #define FUSE_ASYNC_DIO (1 << 15)
340 #define FUSE_WRITEBACK_CACHE (1 << 16)
341 #define FUSE_NO_OPEN_SUPPORT (1 << 17)
342 #define FUSE_PARALLEL_DIROPS (1 << 18)
343 #define FUSE_HANDLE_KILLPRIV (1 << 19)
344 #define FUSE_POSIX_ACL (1 << 20)
345 #define FUSE_ABORT_ERROR (1 << 21)
346 #define FUSE_MAX_PAGES (1 << 22)
347 #define FUSE_CACHE_SYMLINKS (1 << 23)
348 #define FUSE_NO_OPENDIR_SUPPORT (1 << 24)
349 #define FUSE_EXPLICIT_INVAL_DATA (1 << 25)
350 #define FUSE_MAP_ALIGNMENT (1 << 26)
351 #define FUSE_SUBMOUNTS (1 << 27)
354 * CUSE INIT request/reply flags
356 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
358 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
363 #define FUSE_RELEASE_FLUSH (1 << 0)
364 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
369 #define FUSE_GETATTR_FH (1 << 0)
374 #define FUSE_LK_FLOCK (1 << 0)
379 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
380 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
381 * FUSE_WRITE_KILL_PRIV: kill suid and sgid bits
383 #define FUSE_WRITE_CACHE (1 << 0)
384 #define FUSE_WRITE_LOCKOWNER (1 << 1)
385 #define FUSE_WRITE_KILL_PRIV (1 << 2)
390 #define FUSE_READ_LOCKOWNER (1 << 1)
395 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
396 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
397 * FUSE_IOCTL_RETRY: retry with new iovecs
398 * FUSE_IOCTL_32BIT: 32bit ioctl
399 * FUSE_IOCTL_DIR: is a directory
400 * FUSE_IOCTL_COMPAT_X32: x32 compat ioctl on 64bit machine (64bit time_t)
402 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
404 #define FUSE_IOCTL_COMPAT (1 << 0)
405 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
406 #define FUSE_IOCTL_RETRY (1 << 2)
407 #define FUSE_IOCTL_32BIT (1 << 3)
408 #define FUSE_IOCTL_DIR (1 << 4)
409 #define FUSE_IOCTL_COMPAT_X32 (1 << 5)
411 #define FUSE_IOCTL_MAX_IOV 256
416 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
418 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
423 * FUSE_FSYNC_FDATASYNC: Sync data only, not metadata
425 #define FUSE_FSYNC_FDATASYNC (1 << 0)
430 * FUSE_ATTR_SUBMOUNT: Object is a submount root
432 #define FUSE_ATTR_SUBMOUNT (1 << 0)
436 FUSE_FORGET = 2, /* no reply */
456 FUSE_REMOVEXATTR = 24,
461 FUSE_RELEASEDIR = 29,
473 FUSE_NOTIFY_REPLY = 41,
474 FUSE_BATCH_FORGET = 42,
476 FUSE_READDIRPLUS = 44,
479 FUSE_COPY_FILE_RANGE = 47,
480 FUSE_SETUPMAPPING = 48,
481 FUSE_REMOVEMAPPING = 49,
483 /* CUSE specific operations */
486 /* Reserved opcodes: helpful to detect structure endian-ness */
487 CUSE_INIT_BSWAP_RESERVED = 1048576, /* CUSE_INIT << 8 */
488 FUSE_INIT_BSWAP_RESERVED = 436207616, /* FUSE_INIT << 24 */
491 enum fuse_notify_code {
492 FUSE_NOTIFY_POLL = 1,
493 FUSE_NOTIFY_INVAL_INODE = 2,
494 FUSE_NOTIFY_INVAL_ENTRY = 3,
495 FUSE_NOTIFY_STORE = 4,
496 FUSE_NOTIFY_RETRIEVE = 5,
497 FUSE_NOTIFY_DELETE = 6,
498 FUSE_NOTIFY_CODE_MAX,
501 /* The read buffer is required to be at least 8k, but may be much larger */
502 #define FUSE_MIN_READ_BUFFER 8192
504 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
506 struct fuse_entry_out {
507 uint64_t nodeid; /* Inode ID */
508 uint64_t generation; /* Inode generation: nodeid:gen must
509 be unique for the fs's lifetime */
510 uint64_t entry_valid; /* Cache timeout for the name */
511 uint64_t attr_valid; /* Cache timeout for the attributes */
512 uint32_t entry_valid_nsec;
513 uint32_t attr_valid_nsec;
514 struct fuse_attr attr;
517 struct fuse_forget_in {
521 struct fuse_forget_one {
526 struct fuse_batch_forget_in {
531 struct fuse_getattr_in {
532 uint32_t getattr_flags;
537 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
539 struct fuse_attr_out {
540 uint64_t attr_valid; /* Cache timeout for the attributes */
541 uint32_t attr_valid_nsec;
543 struct fuse_attr attr;
546 #define FUSE_COMPAT_MKNOD_IN_SIZE 8
548 struct fuse_mknod_in {
555 struct fuse_mkdir_in {
560 struct fuse_rename_in {
564 struct fuse_rename2_in {
570 struct fuse_link_in {
574 struct fuse_setattr_in {
593 struct fuse_open_in {
598 struct fuse_create_in {
605 struct fuse_open_out {
611 struct fuse_release_in {
614 uint32_t release_flags;
618 struct fuse_flush_in {
625 struct fuse_read_in {
635 #define FUSE_COMPAT_WRITE_IN_SIZE 24
637 struct fuse_write_in {
641 uint32_t write_flags;
647 struct fuse_write_out {
652 #define FUSE_COMPAT_STATFS_SIZE 48
654 struct fuse_statfs_out {
655 struct fuse_kstatfs st;
658 struct fuse_fsync_in {
660 uint32_t fsync_flags;
664 struct fuse_setxattr_in {
669 struct fuse_getxattr_in {
674 struct fuse_getxattr_out {
682 struct fuse_file_lock lk;
688 struct fuse_file_lock lk;
691 struct fuse_access_in {
696 struct fuse_init_in {
699 uint32_t max_readahead;
703 #define FUSE_COMPAT_INIT_OUT_SIZE 8
704 #define FUSE_COMPAT_22_INIT_OUT_SIZE 24
706 struct fuse_init_out {
709 uint32_t max_readahead;
711 uint16_t max_background;
712 uint16_t congestion_threshold;
716 uint16_t map_alignment;
720 #define CUSE_INIT_INFO_MAX 4096
722 struct cuse_init_in {
729 struct cuse_init_out {
736 uint32_t dev_major; /* chardev major */
737 uint32_t dev_minor; /* chardev minor */
741 struct fuse_interrupt_in {
745 struct fuse_bmap_in {
751 struct fuse_bmap_out {
755 struct fuse_ioctl_in {
764 struct fuse_ioctl_iovec {
769 struct fuse_ioctl_out {
776 struct fuse_poll_in {
783 struct fuse_poll_out {
788 struct fuse_notify_poll_wakeup_out {
792 struct fuse_fallocate_in {
800 struct fuse_in_header {
811 struct fuse_out_header {
825 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
826 #define FUSE_DIRENT_ALIGN(x) \
827 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
828 #define FUSE_DIRENT_SIZE(d) \
829 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
831 struct fuse_direntplus {
832 struct fuse_entry_out entry_out;
833 struct fuse_dirent dirent;
836 #define FUSE_NAME_OFFSET_DIRENTPLUS \
837 offsetof(struct fuse_direntplus, dirent.name)
838 #define FUSE_DIRENTPLUS_SIZE(d) \
839 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
841 struct fuse_notify_inval_inode_out {
847 struct fuse_notify_inval_entry_out {
853 struct fuse_notify_delete_out {
860 struct fuse_notify_store_out {
867 struct fuse_notify_retrieve_out {
868 uint64_t notify_unique;
875 /* Matches the size of fuse_write_in */
876 struct fuse_notify_retrieve_in {
886 #define FUSE_DEV_IOC_CLONE _IOR(229, 0, uint32_t)
888 struct fuse_lseek_in {
895 struct fuse_lseek_out {
899 struct fuse_copy_file_range_in {
909 #define FUSE_SETUPMAPPING_FLAG_WRITE (1ull << 0)
910 #define FUSE_SETUPMAPPING_FLAG_READ (1ull << 1)
911 struct fuse_setupmapping_in {
912 /* An already open handle */
914 /* Offset into the file to start the mapping */
916 /* Length of mapping required */
918 /* Flags, FUSE_SETUPMAPPING_FLAG_* */
920 /* Offset in Memory Window */
924 struct fuse_removemapping_in {
925 /* number of fuse_removemapping_one follows */
929 struct fuse_removemapping_one {
930 /* Offset into the dax window start the unmapping */
932 /* Length of mapping required */
936 #define FUSE_REMOVEMAPPING_MAX_ENTRY \
937 (PAGE_SIZE / sizeof(struct fuse_removemapping_one))
939 #endif /* _LINUX_FUSE_H */