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.
6 * See the file COPYING.
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
38 * This file defines the kernel interface of FUSE
43 * - new fuse_getattr_in input argument of GETATTR
44 * - add lk_flags in fuse_lk_in
45 * - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
46 * - add blksize field to fuse_attr
47 * - add file flags field to fuse_read_in and fuse_write_in
50 * - add nonseekable open flag
54 * - add unsolicited notification support
57 * - add umask flag to input argument of open, mknod and mkdir
58 * - add notification messages for invalidation of inodes and
62 * - make max number of background requests and congestion threshold
66 * - add splice support to fuse device
70 * - add retrieve notify
73 * - add BATCH_FORGET request
74 * - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
75 * fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
76 * - add FUSE_IOCTL_32BIT flag
79 * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
82 * - add FUSE_IOCTL_DIR flag
83 * - add FUSE_NOTIFY_DELETE
86 * - add FUSE_FALLOCATE
89 * - 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 #ifndef _FUSE_FUSE_KERNEL_H
108 #define _FUSE_FUSE_KERNEL_H
111 #include <linux/types.h>
113 #include <sys/types.h>
116 /** Version number of this interface */
117 #define FUSE_KERNEL_VERSION 7
119 /** Minor version number of this interface */
120 #define FUSE_KERNEL_MINOR_VERSION 23
122 /** The node ID of the root inode */
123 #define FUSE_ROOT_ID 1
125 /* Make sure all structures are padded to 64bit boundary, so 32bit
126 userspace works under 64bit kernels */
147 struct fuse_kstatfs {
160 struct fuse_file_lock {
164 uint32_t pid; /* tgid */
168 * Bitmasks for fuse_setattr_in.valid
170 #define FATTR_MODE (1 << 0)
171 #define FATTR_UID (1 << 1)
172 #define FATTR_GID (1 << 2)
173 #define FATTR_SIZE (1 << 3)
174 #define FATTR_ATIME (1 << 4)
175 #define FATTR_MTIME (1 << 5)
176 #define FATTR_FH (1 << 6)
177 #define FATTR_ATIME_NOW (1 << 7)
178 #define FATTR_MTIME_NOW (1 << 8)
179 #define FATTR_LOCKOWNER (1 << 9)
180 #define FATTR_CTIME (1 << 10)
183 * Flags returned by the OPEN request
185 * FOPEN_DIRECT_IO: bypass page cache for this open file
186 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
187 * FOPEN_NONSEEKABLE: the file is not seekable
189 #define FOPEN_DIRECT_IO (1 << 0)
190 #define FOPEN_KEEP_CACHE (1 << 1)
191 #define FOPEN_NONSEEKABLE (1 << 2)
194 * INIT request/reply flags
196 * FUSE_ASYNC_READ: asynchronous read requests
197 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
198 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported)
199 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem
200 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
201 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB
202 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
203 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
204 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
205 * FUSE_SPLICE_READ: kernel supports splice read on the device
206 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
207 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
208 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
209 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one)
210 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus
211 * FUSE_ASYNC_DIO: asynchronous direct I/O submission
212 * FUSE_WRITEBACK_CACHE: use writeback cache for buffered writes
213 * FUSE_NO_OPEN_SUPPORT: kernel supports zero-message opens
215 #define FUSE_ASYNC_READ (1 << 0)
216 #define FUSE_POSIX_LOCKS (1 << 1)
217 #define FUSE_FILE_OPS (1 << 2)
218 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
219 #define FUSE_EXPORT_SUPPORT (1 << 4)
220 #define FUSE_BIG_WRITES (1 << 5)
221 #define FUSE_DONT_MASK (1 << 6)
222 #define FUSE_SPLICE_WRITE (1 << 7)
223 #define FUSE_SPLICE_MOVE (1 << 8)
224 #define FUSE_SPLICE_READ (1 << 9)
225 #define FUSE_FLOCK_LOCKS (1 << 10)
226 #define FUSE_HAS_IOCTL_DIR (1 << 11)
227 #define FUSE_AUTO_INVAL_DATA (1 << 12)
228 #define FUSE_DO_READDIRPLUS (1 << 13)
229 #define FUSE_READDIRPLUS_AUTO (1 << 14)
230 #define FUSE_ASYNC_DIO (1 << 15)
231 #define FUSE_WRITEBACK_CACHE (1 << 16)
232 #define FUSE_NO_OPEN_SUPPORT (1 << 17)
236 * CUSE INIT request/reply flags
238 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
240 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
246 #define FUSE_RELEASE_FLUSH (1 << 0)
247 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
252 #define FUSE_GETATTR_FH (1 << 0)
257 #define FUSE_LK_FLOCK (1 << 0)
262 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
263 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
265 #define FUSE_WRITE_CACHE (1 << 0)
266 #define FUSE_WRITE_LOCKOWNER (1 << 1)
271 #define FUSE_READ_LOCKOWNER (1 << 1)
276 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
277 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
278 * FUSE_IOCTL_RETRY: retry with new iovecs
279 * FUSE_IOCTL_32BIT: 32bit ioctl
280 * FUSE_IOCTL_DIR: is a directory
282 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
284 #define FUSE_IOCTL_COMPAT (1 << 0)
285 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
286 #define FUSE_IOCTL_RETRY (1 << 2)
287 #define FUSE_IOCTL_32BIT (1 << 3)
288 #define FUSE_IOCTL_DIR (1 << 4)
290 #define FUSE_IOCTL_MAX_IOV 256
295 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
297 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
301 FUSE_FORGET = 2, /* no reply */
321 FUSE_REMOVEXATTR = 24,
326 FUSE_RELEASEDIR = 29,
338 FUSE_NOTIFY_REPLY = 41,
339 FUSE_BATCH_FORGET = 42,
341 FUSE_READDIRPLUS = 44,
345 /* CUSE specific operations */
350 enum fuse_notify_code {
351 FUSE_NOTIFY_POLL = 1,
352 FUSE_NOTIFY_INVAL_INODE = 2,
353 FUSE_NOTIFY_INVAL_ENTRY = 3,
354 FUSE_NOTIFY_STORE = 4,
355 FUSE_NOTIFY_RETRIEVE = 5,
356 FUSE_NOTIFY_DELETE = 6,
357 FUSE_NOTIFY_CODE_MAX,
360 /* The read buffer is required to be at least 8k, but may be much larger */
361 #define FUSE_MIN_READ_BUFFER 8192
363 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
365 struct fuse_entry_out {
366 uint64_t nodeid; /* Inode ID */
367 uint64_t generation; /* Inode generation: nodeid:gen must
368 be unique for the fs's lifetime */
369 uint64_t entry_valid; /* Cache timeout for the name */
370 uint64_t attr_valid; /* Cache timeout for the attributes */
371 uint32_t entry_valid_nsec;
372 uint32_t attr_valid_nsec;
373 struct fuse_attr attr;
376 struct fuse_forget_in {
380 struct fuse_forget_one {
385 struct fuse_batch_forget_in {
390 struct fuse_getattr_in {
391 uint32_t getattr_flags;
396 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
398 struct fuse_attr_out {
399 uint64_t attr_valid; /* Cache timeout for the attributes */
400 uint32_t attr_valid_nsec;
402 struct fuse_attr attr;
405 #define FUSE_COMPAT_MKNOD_IN_SIZE 8
407 struct fuse_mknod_in {
414 struct fuse_mkdir_in {
419 struct fuse_rename_in {
423 struct fuse_rename2_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_listxattr_in {
533 struct fuse_listxattr_out {
538 struct fuse_getxattr_in {
543 struct fuse_getxattr_out {
551 struct fuse_file_lock lk;
557 struct fuse_file_lock lk;
560 struct fuse_access_in {
565 struct fuse_init_in {
568 uint32_t max_readahead;
572 #define FUSE_COMPAT_INIT_OUT_SIZE 8
573 #define FUSE_COMPAT_22_INIT_OUT_SIZE 24
575 struct fuse_init_out {
578 uint32_t max_readahead;
580 uint16_t max_background;
581 uint16_t congestion_threshold;
588 #define CUSE_INIT_INFO_MAX 4096
590 struct cuse_init_in {
597 struct cuse_init_out {
604 uint32_t dev_major; /* chardev major */
605 uint32_t dev_minor; /* chardev minor */
610 struct fuse_interrupt_in {
614 struct fuse_bmap_in {
620 struct fuse_bmap_out {
624 struct fuse_ioctl_in {
633 struct fuse_ioctl_iovec {
638 struct fuse_ioctl_out {
645 struct fuse_poll_in {
652 struct fuse_poll_out {
657 struct fuse_notify_poll_wakeup_out {
661 struct fuse_fallocate_in {
669 struct fuse_in_header {
680 struct fuse_out_header {
694 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
695 #define FUSE_DIRENT_ALIGN(x) \
696 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
697 #define FUSE_DIRENT_SIZE(d) \
698 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
700 struct fuse_direntplus {
701 struct fuse_entry_out entry_out;
702 struct fuse_dirent dirent;
705 #define FUSE_NAME_OFFSET_DIRENTPLUS \
706 offsetof(struct fuse_direntplus, dirent.name)
707 #define FUSE_DIRENTPLUS_SIZE(d) \
708 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen)
710 struct fuse_notify_inval_inode_out {
716 struct fuse_notify_inval_entry_out {
722 struct fuse_notify_delete_out {
729 struct fuse_notify_store_out {
736 struct fuse_notify_retrieve_out {
737 uint64_t notify_unique;
744 /* Matches the size of fuse_write_in */
745 struct fuse_notify_retrieve_in {
754 #endif /* _FUSE_FUSE_KERNEL_H */