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
101 #ifndef _LINUX_FUSE_H
102 #define _LINUX_FUSE_H
105 #include <linux/types.h>
111 * Version negotiation:
113 * Both the kernel and userspace send the version they support in the
114 * INIT request and reply respectively.
116 * If the major versions match then both shall use the smallest
117 * of the two minor versions for communication.
119 * If the kernel supports a larger major version, then userspace shall
120 * reply with the major version it supports, ignore the rest of the
121 * INIT message and expect a new INIT message from the kernel with a
122 * matching major version.
124 * If the library supports a larger major version, then it shall fall
125 * back to the major protocol version sent by the kernel for
126 * communication and reply with that major version (and an arbitrary
127 * supported minor version).
130 /** Version number of this interface */
131 #define FUSE_KERNEL_VERSION 7
133 /** Minor version number of this interface */
134 #define FUSE_KERNEL_MINOR_VERSION 23
136 /** The node ID of the root inode */
137 #define FUSE_ROOT_ID 1
139 /* Make sure all structures are padded to 64bit boundary, so 32bit
140 userspace works under 64bit kernels */
161 struct fuse_kstatfs {
174 struct fuse_file_lock {
178 uint32_t pid; /* tgid */
182 * Bitmasks for fuse_setattr_in.valid
184 #define FATTR_MODE (1 << 0)
185 #define FATTR_UID (1 << 1)
186 #define FATTR_GID (1 << 2)
187 #define FATTR_SIZE (1 << 3)
188 #define FATTR_ATIME (1 << 4)
189 #define FATTR_MTIME (1 << 5)
190 #define FATTR_FH (1 << 6)
191 #define FATTR_ATIME_NOW (1 << 7)
192 #define FATTR_MTIME_NOW (1 << 8)
193 #define FATTR_LOCKOWNER (1 << 9)
196 * Flags returned by the OPEN request
198 * FOPEN_DIRECT_IO: bypass page cache for this open file
199 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
200 * FOPEN_NONSEEKABLE: the file is not seekable
202 #define FOPEN_DIRECT_IO (1 << 0)
203 #define FOPEN_KEEP_CACHE (1 << 1)
204 #define FOPEN_NONSEEKABLE (1 << 2)
207 * INIT request/reply flags
209 * FUSE_ASYNC_READ: asynchronous read requests
210 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
211 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
212 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
213 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
214 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
215 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
216 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
217 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
218 * FUSE_SPLICE_READ: kernel supports splice read on the device
219 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
220 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
221 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
222 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
223 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
224 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
225 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
227 #define FUSE_ASYNC_READ (1 << 0)
228 #define FUSE_POSIX_LOCKS (1 << 1)
229 #define FUSE_FILE_OPS (1 << 2)
230 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
231 #define FUSE_EXPORT_SUPPORT (1 << 4)
232 #define FUSE_BIG_WRITES (1 << 5)
233 #define FUSE_DONT_MASK (1 << 6)
234 #define FUSE_SPLICE_WRITE (1 << 7)
235 #define FUSE_SPLICE_MOVE (1 << 8)
236 #define FUSE_SPLICE_READ (1 << 9)
237 #define FUSE_FLOCK_LOCKS (1 << 10)
238 #define FUSE_HAS_IOCTL_DIR (1 << 11)
239 #define FUSE_AUTO_INVAL_DATA (1 << 12)
240 #define FUSE_DO_READDIRPLUS (1 << 13)
241 #define FUSE_READDIRPLUS_AUTO (1 << 14)
242 #define FUSE_ASYNC_DIO (1 << 15)
243 #define FUSE_WRITEBACK_CACHE (1 << 16)
246 * CUSE INIT request/reply flags
248 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
250 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
255 #define FUSE_RELEASE_FLUSH (1 << 0)
256 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
261 #define FUSE_GETATTR_FH (1 << 0)
266 #define FUSE_LK_FLOCK (1 << 0)
271 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
272 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
274 #define FUSE_WRITE_CACHE (1 << 0)
275 #define FUSE_WRITE_LOCKOWNER (1 << 1)
280 #define FUSE_READ_LOCKOWNER (1 << 1)
285 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
286 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
287 * FUSE_IOCTL_RETRY: retry with new iovecs
288 * FUSE_IOCTL_32BIT: 32bit ioctl
289 * FUSE_IOCTL_DIR: is a directory
291 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
293 #define FUSE_IOCTL_COMPAT (1 << 0)
294 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
295 #define FUSE_IOCTL_RETRY (1 << 2)
296 #define FUSE_IOCTL_32BIT (1 << 3)
297 #define FUSE_IOCTL_DIR (1 << 4)
299 #define FUSE_IOCTL_MAX_IOV 256
304 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
306 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
310 FUSE_FORGET = 2, /* no reply */
330 FUSE_REMOVEXATTR = 24,
335 FUSE_RELEASEDIR = 29,
347 FUSE_NOTIFY_REPLY = 41,
348 FUSE_BATCH_FORGET = 42,
350 FUSE_READDIRPLUS = 44,
352 /* CUSE specific operations */
356 enum fuse_notify_code {
357 FUSE_NOTIFY_POLL = 1,
358 FUSE_NOTIFY_INVAL_INODE = 2,
359 FUSE_NOTIFY_INVAL_ENTRY = 3,
360 FUSE_NOTIFY_STORE = 4,
361 FUSE_NOTIFY_RETRIEVE = 5,
362 FUSE_NOTIFY_DELETE = 6,
363 FUSE_NOTIFY_CODE_MAX,
366 /* The read buffer is required to be at least 8k, but may be much larger */
367 #define FUSE_MIN_READ_BUFFER 8192
369 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
371 struct fuse_entry_out {
372 uint64_t nodeid; /* Inode ID */
373 uint64_t generation; /* Inode generation: nodeid:gen must
374 be unique for the fs's lifetime */
375 uint64_t entry_valid; /* Cache timeout for the name */
376 uint64_t attr_valid; /* Cache timeout for the attributes */
377 uint32_t entry_valid_nsec;
378 uint32_t attr_valid_nsec;
379 struct fuse_attr attr;
382 struct fuse_forget_in {
386 struct fuse_forget_one {
391 struct fuse_batch_forget_in {
396 struct fuse_getattr_in {
397 uint32_t getattr_flags;
402 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
404 struct fuse_attr_out {
405 uint64_t attr_valid; /* Cache timeout for the attributes */
406 uint32_t attr_valid_nsec;
408 struct fuse_attr attr;
411 #define FUSE_COMPAT_MKNOD_IN_SIZE 8
413 struct fuse_mknod_in {
420 struct fuse_mkdir_in {
425 struct fuse_rename_in {
429 struct fuse_link_in {
433 struct fuse_setattr_in {
452 struct fuse_open_in {
457 struct fuse_create_in {
464 struct fuse_open_out {
470 struct fuse_release_in {
473 uint32_t release_flags;
477 struct fuse_flush_in {
484 struct fuse_read_in {
494 #define FUSE_COMPAT_WRITE_IN_SIZE 24
496 struct fuse_write_in {
500 uint32_t write_flags;
506 struct fuse_write_out {
511 #define FUSE_COMPAT_STATFS_SIZE 48
513 struct fuse_statfs_out {
514 struct fuse_kstatfs st;
517 struct fuse_fsync_in {
519 uint32_t fsync_flags;
523 struct fuse_setxattr_in {
528 struct fuse_getxattr_in {
533 struct fuse_getxattr_out {
541 struct fuse_file_lock lk;
547 struct fuse_file_lock lk;
550 struct fuse_access_in {
555 struct fuse_init_in {
558 uint32_t max_readahead;
562 struct fuse_init_out {
565 uint32_t max_readahead;
567 uint16_t max_background;
568 uint16_t congestion_threshold;
572 #define CUSE_INIT_INFO_MAX 4096
574 struct cuse_init_in {
581 struct cuse_init_out {
588 uint32_t dev_major; /* chardev major */
589 uint32_t dev_minor; /* chardev minor */
593 struct fuse_interrupt_in {
597 struct fuse_bmap_in {
603 struct fuse_bmap_out {
607 struct fuse_ioctl_in {
616 struct fuse_ioctl_iovec {
621 struct fuse_ioctl_out {
628 struct fuse_poll_in {
635 struct fuse_poll_out {
640 struct fuse_notify_poll_wakeup_out {
644 struct fuse_fallocate_in {
652 struct fuse_in_header {
663 struct fuse_out_header {
677 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
678 #define FUSE_DIRENT_ALIGN(x) \
679 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
680 #define FUSE_DIRENT_SIZE(d) \
681 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
683 struct fuse_direntplus {
684 struct fuse_entry_out entry_out;
685 struct fuse_dirent dirent;
688 #define FUSE_NAME_OFFSET_DIRENTPLUS \
689 offsetof(struct fuse_direntplus, dirent.name)
690 #define FUSE_DIRENTPLUS_SIZE(d) \
691 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
693 struct fuse_notify_inval_inode_out {
699 struct fuse_notify_inval_entry_out {
705 struct fuse_notify_delete_out {
712 struct fuse_notify_store_out {
719 struct fuse_notify_retrieve_out {
720 uint64_t notify_unique;
727 /* Matches the size of fuse_write_in */
728 struct fuse_notify_retrieve_in {
737 #endif /* _LINUX_FUSE_H */