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 #ifndef _LINUX_FUSE_H
111 #define _LINUX_FUSE_H
114 #include <linux/types.h>
120 * Version negotiation:
122 * Both the kernel and userspace send the version they support in the
123 * INIT request and reply respectively.
125 * If the major versions match then both shall use the smallest
126 * of the two minor versions for communication.
128 * If the kernel supports a larger major version, then userspace shall
129 * reply with the major version it supports, ignore the rest of the
130 * INIT message and expect a new INIT message from the kernel with a
131 * matching major version.
133 * If the library supports a larger major version, then it shall fall
134 * back to the major protocol version sent by the kernel for
135 * communication and reply with that major version (and an arbitrary
136 * supported minor version).
139 /** Version number of this interface */
140 #define FUSE_KERNEL_VERSION 7
142 /** Minor version number of this interface */
143 #define FUSE_KERNEL_MINOR_VERSION 24
145 /** The node ID of the root inode */
146 #define FUSE_ROOT_ID 1
148 /* Make sure all structures are padded to 64bit boundary, so 32bit
149 userspace works under 64bit kernels */
170 struct fuse_kstatfs {
183 struct fuse_file_lock {
187 uint32_t pid; /* tgid */
191 * Bitmasks for fuse_setattr_in.valid
193 #define FATTR_MODE (1 << 0)
194 #define FATTR_UID (1 << 1)
195 #define FATTR_GID (1 << 2)
196 #define FATTR_SIZE (1 << 3)
197 #define FATTR_ATIME (1 << 4)
198 #define FATTR_MTIME (1 << 5)
199 #define FATTR_FH (1 << 6)
200 #define FATTR_ATIME_NOW (1 << 7)
201 #define FATTR_MTIME_NOW (1 << 8)
202 #define FATTR_LOCKOWNER (1 << 9)
203 #define FATTR_CTIME (1 << 10)
206 * Flags returned by the OPEN request
208 * FOPEN_DIRECT_IO: bypass page cache for this open file
209 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
210 * FOPEN_NONSEEKABLE: the file is not seekable
212 #define FOPEN_DIRECT_IO (1 << 0)
213 #define FOPEN_KEEP_CACHE (1 << 1)
214 #define FOPEN_NONSEEKABLE (1 << 2)
217 * INIT request/reply flags
219 * FUSE_ASYNC_READ: asynchronous read requests
220 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
221 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
222 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
223 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
224 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
225 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
226 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
227 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
228 * FUSE_SPLICE_READ: kernel supports splice read on the device
229 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
230 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
231 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
232 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
233 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
234 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
235 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
236 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
238 #define FUSE_ASYNC_READ (1 << 0)
239 #define FUSE_POSIX_LOCKS (1 << 1)
240 #define FUSE_FILE_OPS (1 << 2)
241 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
242 #define FUSE_EXPORT_SUPPORT (1 << 4)
243 #define FUSE_BIG_WRITES (1 << 5)
244 #define FUSE_DONT_MASK (1 << 6)
245 #define FUSE_SPLICE_WRITE (1 << 7)
246 #define FUSE_SPLICE_MOVE (1 << 8)
247 #define FUSE_SPLICE_READ (1 << 9)
248 #define FUSE_FLOCK_LOCKS (1 << 10)
249 #define FUSE_HAS_IOCTL_DIR (1 << 11)
250 #define FUSE_AUTO_INVAL_DATA (1 << 12)
251 #define FUSE_DO_READDIRPLUS (1 << 13)
252 #define FUSE_READDIRPLUS_AUTO (1 << 14)
253 #define FUSE_ASYNC_DIO (1 << 15)
254 #define FUSE_WRITEBACK_CACHE (1 << 16)
255 #define FUSE_NO_OPEN_SUPPORT (1 << 17)
258 * CUSE INIT request/reply flags
260 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
262 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
267 #define FUSE_RELEASE_FLUSH (1 << 0)
268 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
273 #define FUSE_GETATTR_FH (1 << 0)
278 #define FUSE_LK_FLOCK (1 << 0)
283 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
284 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
286 #define FUSE_WRITE_CACHE (1 << 0)
287 #define FUSE_WRITE_LOCKOWNER (1 << 1)
292 #define FUSE_READ_LOCKOWNER (1 << 1)
297 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
298 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
299 * FUSE_IOCTL_RETRY: retry with new iovecs
300 * FUSE_IOCTL_32BIT: 32bit ioctl
301 * FUSE_IOCTL_DIR: is a directory
303 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
305 #define FUSE_IOCTL_COMPAT (1 << 0)
306 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
307 #define FUSE_IOCTL_RETRY (1 << 2)
308 #define FUSE_IOCTL_32BIT (1 << 3)
309 #define FUSE_IOCTL_DIR (1 << 4)
311 #define FUSE_IOCTL_MAX_IOV 256
316 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
318 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
322 FUSE_FORGET = 2, /* no reply */
342 FUSE_REMOVEXATTR = 24,
347 FUSE_RELEASEDIR = 29,
359 FUSE_NOTIFY_REPLY = 41,
360 FUSE_BATCH_FORGET = 42,
362 FUSE_READDIRPLUS = 44,
366 /* CUSE specific operations */
370 enum fuse_notify_code {
371 FUSE_NOTIFY_POLL = 1,
372 FUSE_NOTIFY_INVAL_INODE = 2,
373 FUSE_NOTIFY_INVAL_ENTRY = 3,
374 FUSE_NOTIFY_STORE = 4,
375 FUSE_NOTIFY_RETRIEVE = 5,
376 FUSE_NOTIFY_DELETE = 6,
377 FUSE_NOTIFY_CODE_MAX,
380 /* The read buffer is required to be at least 8k, but may be much larger */
381 #define FUSE_MIN_READ_BUFFER 8192
383 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
385 struct fuse_entry_out {
386 uint64_t nodeid; /* Inode ID */
387 uint64_t generation; /* Inode generation: nodeid:gen must
388 be unique for the fs's lifetime */
389 uint64_t entry_valid; /* Cache timeout for the name */
390 uint64_t attr_valid; /* Cache timeout for the attributes */
391 uint32_t entry_valid_nsec;
392 uint32_t attr_valid_nsec;
393 struct fuse_attr attr;
396 struct fuse_forget_in {
400 struct fuse_forget_one {
405 struct fuse_batch_forget_in {
410 struct fuse_getattr_in {
411 uint32_t getattr_flags;
416 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
418 struct fuse_attr_out {
419 uint64_t attr_valid; /* Cache timeout for the attributes */
420 uint32_t attr_valid_nsec;
422 struct fuse_attr attr;
425 #define FUSE_COMPAT_MKNOD_IN_SIZE 8
427 struct fuse_mknod_in {
434 struct fuse_mkdir_in {
439 struct fuse_rename_in {
443 struct fuse_rename2_in {
449 struct fuse_link_in {
453 struct fuse_setattr_in {
472 struct fuse_open_in {
477 struct fuse_create_in {
484 struct fuse_open_out {
490 struct fuse_release_in {
493 uint32_t release_flags;
497 struct fuse_flush_in {
504 struct fuse_read_in {
514 #define FUSE_COMPAT_WRITE_IN_SIZE 24
516 struct fuse_write_in {
520 uint32_t write_flags;
526 struct fuse_write_out {
531 #define FUSE_COMPAT_STATFS_SIZE 48
533 struct fuse_statfs_out {
534 struct fuse_kstatfs st;
537 struct fuse_fsync_in {
539 uint32_t fsync_flags;
543 struct fuse_setxattr_in {
548 struct fuse_getxattr_in {
553 struct fuse_getxattr_out {
561 struct fuse_file_lock lk;
567 struct fuse_file_lock lk;
570 struct fuse_access_in {
575 struct fuse_init_in {
578 uint32_t max_readahead;
582 #define FUSE_COMPAT_INIT_OUT_SIZE 8
583 #define FUSE_COMPAT_22_INIT_OUT_SIZE 24
585 struct fuse_init_out {
588 uint32_t max_readahead;
590 uint16_t max_background;
591 uint16_t congestion_threshold;
597 #define CUSE_INIT_INFO_MAX 4096
599 struct cuse_init_in {
606 struct cuse_init_out {
613 uint32_t dev_major; /* chardev major */
614 uint32_t dev_minor; /* chardev minor */
618 struct fuse_interrupt_in {
622 struct fuse_bmap_in {
628 struct fuse_bmap_out {
632 struct fuse_ioctl_in {
641 struct fuse_ioctl_iovec {
646 struct fuse_ioctl_out {
653 struct fuse_poll_in {
660 struct fuse_poll_out {
665 struct fuse_notify_poll_wakeup_out {
669 struct fuse_fallocate_in {
677 struct fuse_in_header {
688 struct fuse_out_header {
702 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
703 #define FUSE_DIRENT_ALIGN(x) \
704 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
705 #define FUSE_DIRENT_SIZE(d) \
706 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
708 struct fuse_direntplus {
709 struct fuse_entry_out entry_out;
710 struct fuse_dirent dirent;
713 #define FUSE_NAME_OFFSET_DIRENTPLUS \
714 offsetof(struct fuse_direntplus, dirent.name)
715 #define FUSE_DIRENTPLUS_SIZE(d) \
716 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
718 struct fuse_notify_inval_inode_out {
724 struct fuse_notify_inval_entry_out {
730 struct fuse_notify_delete_out {
737 struct fuse_notify_store_out {
744 struct fuse_notify_retrieve_out {
745 uint64_t notify_unique;
752 /* Matches the size of fuse_write_in */
753 struct fuse_notify_retrieve_in {
763 #define FUSE_DEV_IOC_CLONE _IOR(229, 0, uint32_t)
765 struct fuse_lseek_in {
772 struct fuse_lseek_out {
776 #endif /* _LINUX_FUSE_H */