2 This file defines the kernel interface of FUSE
3 Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu>
5 This program can be distributed under the terms of the GNU GPL.
8 This -- and only this -- header file may also be distributed under
9 the terms of the BSD Licence as follows:
11 Copyright (C) 2001-2007 Miklos Szeredi. All rights reserved.
13 Redistribution and use in source and binary forms, with or without
14 modification, are permitted provided that the following conditions
16 1. Redistributions of source code must retain the above copyright
17 notice, this list of conditions and the following disclaimer.
18 2. Redistributions in binary form must reproduce the above copyright
19 notice, this list of conditions and the following disclaimer in the
20 documentation and/or other materials provided with the distribution.
22 THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
26 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * This file defines the kernel interface of FUSE
41 * - new fuse_getattr_in input argument of GETATTR
42 * - add lk_flags in fuse_lk_in
43 * - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
44 * - add blksize field to fuse_attr
45 * - add file flags field to fuse_read_in and fuse_write_in
48 * - add nonseekable open flag
52 * - add unsolicited notification support
53 * - add POLL message and NOTIFY_POLL notification
56 * - add umask flag to input argument of open, mknod and mkdir
57 * - add notification messages for invalidation of inodes and
61 * - make max number of background requests and congestion threshold
65 * - add splice support to fuse device
69 * - add retrieve notify
72 * - add BATCH_FORGET request
73 * - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
74 * fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
75 * - add FUSE_IOCTL_32BIT flag
78 * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
81 * - add FUSE_IOCTL_DIR flag
82 * - add FUSE_NOTIFY_DELETE
85 * - add FUSE_FALLOCATE
88 * - add FUSE_AUTO_INVAL_DATA
91 * - add FUSE_READDIRPLUS
92 * - send the requested events in POLL request
95 * - add FUSE_ASYNC_DIO
98 * - add FUSE_WRITEBACK_CACHE
99 * - add time_gran to fuse_init_out
100 * - add reserved space to fuse_init_out
102 * - add ctime and ctimensec to fuse_setattr_in
103 * - add FUSE_RENAME2 request
104 * - add FUSE_NO_OPEN_SUPPORT flag
107 * - add FUSE_LSEEK for SEEK_HOLE and SEEK_DATA support
110 * - add FUSE_PARALLEL_DIROPS
113 * - add FUSE_HANDLE_KILLPRIV
114 * - add FUSE_POSIX_ACL
117 #ifndef _LINUX_FUSE_H
118 #define _LINUX_FUSE_H
121 #include <linux/types.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 26
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
219 #define FOPEN_DIRECT_IO (1 << 0)
220 #define FOPEN_KEEP_CACHE (1 << 1)
221 #define FOPEN_NONSEEKABLE (1 << 2)
224 * INIT request/reply flags
226 * FUSE_ASYNC_READ: asynchronous read requests
227 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
228 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
229 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
230 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
231 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
232 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
233 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
234 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
235 * FUSE_SPLICE_READ: kernel supports splice read on the device
236 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
237 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
238 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
239 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
240 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
241 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
242 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
243 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
244 * FUSE_PARALLEL_DIROPS: allow parallel lookups and readdir
245 * FUSE_HANDLE_KILLPRIV: fs handles killing suid/sgid/cap on write/chown/trunc
246 * FUSE_POSIX_ACL: filesystem supports posix acls
248 #define FUSE_ASYNC_READ (1 << 0)
249 #define FUSE_POSIX_LOCKS (1 << 1)
250 #define FUSE_FILE_OPS (1 << 2)
251 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
252 #define FUSE_EXPORT_SUPPORT (1 << 4)
253 #define FUSE_BIG_WRITES (1 << 5)
254 #define FUSE_DONT_MASK (1 << 6)
255 #define FUSE_SPLICE_WRITE (1 << 7)
256 #define FUSE_SPLICE_MOVE (1 << 8)
257 #define FUSE_SPLICE_READ (1 << 9)
258 #define FUSE_FLOCK_LOCKS (1 << 10)
259 #define FUSE_HAS_IOCTL_DIR (1 << 11)
260 #define FUSE_AUTO_INVAL_DATA (1 << 12)
261 #define FUSE_DO_READDIRPLUS (1 << 13)
262 #define FUSE_READDIRPLUS_AUTO (1 << 14)
263 #define FUSE_ASYNC_DIO (1 << 15)
264 #define FUSE_WRITEBACK_CACHE (1 << 16)
265 #define FUSE_NO_OPEN_SUPPORT (1 << 17)
266 #define FUSE_PARALLEL_DIROPS (1 << 18)
267 #define FUSE_HANDLE_KILLPRIV (1 << 19)
268 #define FUSE_POSIX_ACL (1 << 20)
271 * CUSE INIT request/reply flags
273 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
275 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
280 #define FUSE_RELEASE_FLUSH (1 << 0)
281 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
286 #define FUSE_GETATTR_FH (1 << 0)
291 #define FUSE_LK_FLOCK (1 << 0)
296 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
297 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
299 #define FUSE_WRITE_CACHE (1 << 0)
300 #define FUSE_WRITE_LOCKOWNER (1 << 1)
305 #define FUSE_READ_LOCKOWNER (1 << 1)
310 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
311 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
312 * FUSE_IOCTL_RETRY: retry with new iovecs
313 * FUSE_IOCTL_32BIT: 32bit ioctl
314 * FUSE_IOCTL_DIR: is a directory
316 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
318 #define FUSE_IOCTL_COMPAT (1 << 0)
319 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
320 #define FUSE_IOCTL_RETRY (1 << 2)
321 #define FUSE_IOCTL_32BIT (1 << 3)
322 #define FUSE_IOCTL_DIR (1 << 4)
324 #define FUSE_IOCTL_MAX_IOV 256
329 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
331 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
335 FUSE_FORGET
= 2, /* no reply */
355 FUSE_REMOVEXATTR
= 24,
360 FUSE_RELEASEDIR
= 29,
372 FUSE_NOTIFY_REPLY
= 41,
373 FUSE_BATCH_FORGET
= 42,
375 FUSE_READDIRPLUS
= 44,
379 /* CUSE specific operations */
383 enum fuse_notify_code
{
384 FUSE_NOTIFY_POLL
= 1,
385 FUSE_NOTIFY_INVAL_INODE
= 2,
386 FUSE_NOTIFY_INVAL_ENTRY
= 3,
387 FUSE_NOTIFY_STORE
= 4,
388 FUSE_NOTIFY_RETRIEVE
= 5,
389 FUSE_NOTIFY_DELETE
= 6,
390 FUSE_NOTIFY_CODE_MAX
,
393 /* The read buffer is required to be at least 8k, but may be much larger */
394 #define FUSE_MIN_READ_BUFFER 8192
396 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
398 struct fuse_entry_out
{
399 uint64_t nodeid
; /* Inode ID */
400 uint64_t generation
; /* Inode generation: nodeid:gen must
401 be unique for the fs's lifetime */
402 uint64_t entry_valid
; /* Cache timeout for the name */
403 uint64_t attr_valid
; /* Cache timeout for the attributes */
404 uint32_t entry_valid_nsec
;
405 uint32_t attr_valid_nsec
;
406 struct fuse_attr attr
;
409 struct fuse_forget_in
{
413 struct fuse_forget_one
{
418 struct fuse_batch_forget_in
{
423 struct fuse_getattr_in
{
424 uint32_t getattr_flags
;
429 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
431 struct fuse_attr_out
{
432 uint64_t attr_valid
; /* Cache timeout for the attributes */
433 uint32_t attr_valid_nsec
;
435 struct fuse_attr attr
;
438 #define FUSE_COMPAT_MKNOD_IN_SIZE 8
440 struct fuse_mknod_in
{
447 struct fuse_mkdir_in
{
452 struct fuse_rename_in
{
456 struct fuse_rename2_in
{
462 struct fuse_link_in
{
466 struct fuse_setattr_in
{
485 struct fuse_open_in
{
490 struct fuse_create_in
{
497 struct fuse_open_out
{
503 struct fuse_release_in
{
506 uint32_t release_flags
;
510 struct fuse_flush_in
{
517 struct fuse_read_in
{
527 #define FUSE_COMPAT_WRITE_IN_SIZE 24
529 struct fuse_write_in
{
533 uint32_t write_flags
;
539 struct fuse_write_out
{
544 #define FUSE_COMPAT_STATFS_SIZE 48
546 struct fuse_statfs_out
{
547 struct fuse_kstatfs st
;
550 struct fuse_fsync_in
{
552 uint32_t fsync_flags
;
556 struct fuse_setxattr_in
{
561 struct fuse_getxattr_in
{
566 struct fuse_getxattr_out
{
574 struct fuse_file_lock lk
;
580 struct fuse_file_lock lk
;
583 struct fuse_access_in
{
588 struct fuse_init_in
{
591 uint32_t max_readahead
;
595 #define FUSE_COMPAT_INIT_OUT_SIZE 8
596 #define FUSE_COMPAT_22_INIT_OUT_SIZE 24
598 struct fuse_init_out
{
601 uint32_t max_readahead
;
603 uint16_t max_background
;
604 uint16_t congestion_threshold
;
610 #define CUSE_INIT_INFO_MAX 4096
612 struct cuse_init_in
{
619 struct cuse_init_out
{
626 uint32_t dev_major
; /* chardev major */
627 uint32_t dev_minor
; /* chardev minor */
631 struct fuse_interrupt_in
{
635 struct fuse_bmap_in
{
641 struct fuse_bmap_out
{
645 struct fuse_ioctl_in
{
654 struct fuse_ioctl_iovec
{
659 struct fuse_ioctl_out
{
666 struct fuse_poll_in
{
673 struct fuse_poll_out
{
678 struct fuse_notify_poll_wakeup_out
{
682 struct fuse_fallocate_in
{
690 struct fuse_in_header
{
701 struct fuse_out_header
{
715 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
716 #define FUSE_DIRENT_ALIGN(x) \
717 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
718 #define FUSE_DIRENT_SIZE(d) \
719 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
721 struct fuse_direntplus
{
722 struct fuse_entry_out entry_out
;
723 struct fuse_dirent dirent
;
726 #define FUSE_NAME_OFFSET_DIRENTPLUS \
727 offsetof(struct fuse_direntplus, dirent.name)
728 #define FUSE_DIRENTPLUS_SIZE(d) \
729 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
731 struct fuse_notify_inval_inode_out
{
737 struct fuse_notify_inval_entry_out
{
743 struct fuse_notify_delete_out
{
750 struct fuse_notify_store_out
{
757 struct fuse_notify_retrieve_out
{
758 uint64_t notify_unique
;
765 /* Matches the size of fuse_write_in */
766 struct fuse_notify_retrieve_in
{
776 #define FUSE_DEV_IOC_CLONE _IOR(229, 0, uint32_t)
778 struct fuse_lseek_in
{
785 struct fuse_lseek_out
{
789 #endif /* _LINUX_FUSE_H */