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
102 #include <linux/types.h>
108 * Version negotiation:
110 * Both the kernel and userspace send the version they support in the
111 * INIT request and reply respectively.
113 * If the major versions match then both shall use the smallest
114 * of the two minor versions for communication.
116 * If the kernel supports a larger major version, then userspace shall
117 * reply with the major version it supports, ignore the rest of the
118 * INIT message and expect a new INIT message from the kernel with a
119 * matching major version.
121 * If the library supports a larger major version, then it shall fall
122 * back to the major protocol version sent by the kernel for
123 * communication and reply with that major version (and an arbitrary
124 * supported minor version).
127 /** Version number of this interface */
128 #define FUSE_KERNEL_VERSION 7
130 /** Minor version number of this interface */
131 #define FUSE_KERNEL_MINOR_VERSION 22
133 /** The node ID of the root inode */
134 #define FUSE_ROOT_ID 1
136 /* Make sure all structures are padded to 64bit boundary, so 32bit
137 userspace works under 64bit kernels */
158 struct fuse_kstatfs
{
171 struct fuse_file_lock
{
175 uint32_t pid
; /* tgid */
179 * Bitmasks for fuse_setattr_in.valid
181 #define FATTR_MODE (1 << 0)
182 #define FATTR_UID (1 << 1)
183 #define FATTR_GID (1 << 2)
184 #define FATTR_SIZE (1 << 3)
185 #define FATTR_ATIME (1 << 4)
186 #define FATTR_MTIME (1 << 5)
187 #define FATTR_FH (1 << 6)
188 #define FATTR_ATIME_NOW (1 << 7)
189 #define FATTR_MTIME_NOW (1 << 8)
190 #define FATTR_LOCKOWNER (1 << 9)
193 * Flags returned by the OPEN request
195 * FOPEN_DIRECT_IO: bypass page cache for this open file
196 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
197 * FOPEN_NONSEEKABLE: the file is not seekable
199 #define FOPEN_DIRECT_IO (1 << 0)
200 #define FOPEN_KEEP_CACHE (1 << 1)
201 #define FOPEN_NONSEEKABLE (1 << 2)
204 * INIT request/reply flags
206 * FUSE_ASYNC_READ: asynchronous read requests
207 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
208 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
209 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
210 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
211 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
212 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
213 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
214 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
215 * FUSE_SPLICE_READ: kernel supports splice read on the device
216 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
217 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
218 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
219 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
220 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
221 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
223 #define FUSE_ASYNC_READ (1 << 0)
224 #define FUSE_POSIX_LOCKS (1 << 1)
225 #define FUSE_FILE_OPS (1 << 2)
226 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
227 #define FUSE_EXPORT_SUPPORT (1 << 4)
228 #define FUSE_BIG_WRITES (1 << 5)
229 #define FUSE_DONT_MASK (1 << 6)
230 #define FUSE_SPLICE_WRITE (1 << 7)
231 #define FUSE_SPLICE_MOVE (1 << 8)
232 #define FUSE_SPLICE_READ (1 << 9)
233 #define FUSE_FLOCK_LOCKS (1 << 10)
234 #define FUSE_HAS_IOCTL_DIR (1 << 11)
235 #define FUSE_AUTO_INVAL_DATA (1 << 12)
236 #define FUSE_DO_READDIRPLUS (1 << 13)
237 #define FUSE_READDIRPLUS_AUTO (1 << 14)
238 #define FUSE_ASYNC_DIO (1 << 15)
241 * CUSE INIT request/reply flags
243 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
245 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
250 #define FUSE_RELEASE_FLUSH (1 << 0)
251 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
256 #define FUSE_GETATTR_FH (1 << 0)
261 #define FUSE_LK_FLOCK (1 << 0)
266 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
267 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
269 #define FUSE_WRITE_CACHE (1 << 0)
270 #define FUSE_WRITE_LOCKOWNER (1 << 1)
275 #define FUSE_READ_LOCKOWNER (1 << 1)
280 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
281 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
282 * FUSE_IOCTL_RETRY: retry with new iovecs
283 * FUSE_IOCTL_32BIT: 32bit ioctl
284 * FUSE_IOCTL_DIR: is a directory
286 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
288 #define FUSE_IOCTL_COMPAT (1 << 0)
289 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
290 #define FUSE_IOCTL_RETRY (1 << 2)
291 #define FUSE_IOCTL_32BIT (1 << 3)
292 #define FUSE_IOCTL_DIR (1 << 4)
294 #define FUSE_IOCTL_MAX_IOV 256
299 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
301 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
305 FUSE_FORGET
= 2, /* no reply */
325 FUSE_REMOVEXATTR
= 24,
330 FUSE_RELEASEDIR
= 29,
342 FUSE_NOTIFY_REPLY
= 41,
343 FUSE_BATCH_FORGET
= 42,
345 FUSE_READDIRPLUS
= 44,
347 /* CUSE specific operations */
351 enum fuse_notify_code
{
352 FUSE_NOTIFY_POLL
= 1,
353 FUSE_NOTIFY_INVAL_INODE
= 2,
354 FUSE_NOTIFY_INVAL_ENTRY
= 3,
355 FUSE_NOTIFY_STORE
= 4,
356 FUSE_NOTIFY_RETRIEVE
= 5,
357 FUSE_NOTIFY_DELETE
= 6,
358 FUSE_NOTIFY_CODE_MAX
,
361 /* The read buffer is required to be at least 8k, but may be much larger */
362 #define FUSE_MIN_READ_BUFFER 8192
364 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
366 struct fuse_entry_out
{
367 uint64_t nodeid
; /* Inode ID */
368 uint64_t generation
; /* Inode generation: nodeid:gen must
369 be unique for the fs's lifetime */
370 uint64_t entry_valid
; /* Cache timeout for the name */
371 uint64_t attr_valid
; /* Cache timeout for the attributes */
372 uint32_t entry_valid_nsec
;
373 uint32_t attr_valid_nsec
;
374 struct fuse_attr attr
;
377 struct fuse_forget_in
{
381 struct fuse_forget_one
{
386 struct fuse_batch_forget_in
{
391 struct fuse_getattr_in
{
392 uint32_t getattr_flags
;
397 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
399 struct fuse_attr_out
{
400 uint64_t attr_valid
; /* Cache timeout for the attributes */
401 uint32_t attr_valid_nsec
;
403 struct fuse_attr attr
;
406 #define FUSE_COMPAT_MKNOD_IN_SIZE 8
408 struct fuse_mknod_in
{
415 struct fuse_mkdir_in
{
420 struct fuse_rename_in
{
424 struct fuse_link_in
{
428 struct fuse_setattr_in
{
447 struct fuse_open_in
{
452 struct fuse_create_in
{
459 struct fuse_open_out
{
465 struct fuse_release_in
{
468 uint32_t release_flags
;
472 struct fuse_flush_in
{
479 struct fuse_read_in
{
489 #define FUSE_COMPAT_WRITE_IN_SIZE 24
491 struct fuse_write_in
{
495 uint32_t write_flags
;
501 struct fuse_write_out
{
506 #define FUSE_COMPAT_STATFS_SIZE 48
508 struct fuse_statfs_out
{
509 struct fuse_kstatfs st
;
512 struct fuse_fsync_in
{
514 uint32_t fsync_flags
;
518 struct fuse_setxattr_in
{
523 struct fuse_getxattr_in
{
528 struct fuse_getxattr_out
{
536 struct fuse_file_lock lk
;
542 struct fuse_file_lock lk
;
545 struct fuse_access_in
{
550 struct fuse_init_in
{
553 uint32_t max_readahead
;
557 struct fuse_init_out
{
560 uint32_t max_readahead
;
562 uint16_t max_background
;
563 uint16_t congestion_threshold
;
567 #define CUSE_INIT_INFO_MAX 4096
569 struct cuse_init_in
{
576 struct cuse_init_out
{
583 uint32_t dev_major
; /* chardev major */
584 uint32_t dev_minor
; /* chardev minor */
588 struct fuse_interrupt_in
{
592 struct fuse_bmap_in
{
598 struct fuse_bmap_out
{
602 struct fuse_ioctl_in
{
611 struct fuse_ioctl_iovec
{
616 struct fuse_ioctl_out
{
623 struct fuse_poll_in
{
630 struct fuse_poll_out
{
635 struct fuse_notify_poll_wakeup_out
{
639 struct fuse_fallocate_in
{
647 struct fuse_in_header
{
658 struct fuse_out_header
{
672 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
673 #define FUSE_DIRENT_ALIGN(x) \
674 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
675 #define FUSE_DIRENT_SIZE(d) \
676 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
678 struct fuse_direntplus
{
679 struct fuse_entry_out entry_out
;
680 struct fuse_dirent dirent
;
683 #define FUSE_NAME_OFFSET_DIRENTPLUS \
684 offsetof(struct fuse_direntplus, dirent.name)
685 #define FUSE_DIRENTPLUS_SIZE(d) \
686 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
688 struct fuse_notify_inval_inode_out
{
694 struct fuse_notify_inval_entry_out
{
700 struct fuse_notify_delete_out
{
707 struct fuse_notify_store_out
{
714 struct fuse_notify_retrieve_out
{
715 uint64_t notify_unique
;
722 /* Matches the size of fuse_write_in */
723 struct fuse_notify_retrieve_in
{
732 #endif /* _LINUX_FUSE_H */