2 FUSE: Filesystem in Userspace
3 Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu>
5 This program can be distributed under the terms of the GNU GPL.
10 * This file defines the kernel interface of FUSE
15 * - new fuse_getattr_in input argument of GETATTR
16 * - add lk_flags in fuse_lk_in
17 * - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
18 * - add blksize field to fuse_attr
19 * - add file flags field to fuse_read_in and fuse_write_in
22 * - add nonseekable open flag
26 * - add unsolicited notification support
27 * - add POLL message and NOTIFY_POLL notification
33 #include <linux/types.h>
35 /** Version number of this interface */
36 #define FUSE_KERNEL_VERSION 7
38 /** Minor version number of this interface */
39 #define FUSE_KERNEL_MINOR_VERSION 11
41 /** The node ID of the root inode */
42 #define FUSE_ROOT_ID 1
44 /* Make sure all structures are padded to 64bit boundary, so 32bit
45 userspace works under 64bit kernels */
79 struct fuse_file_lock
{
87 * Bitmasks for fuse_setattr_in.valid
89 #define FATTR_MODE (1 << 0)
90 #define FATTR_UID (1 << 1)
91 #define FATTR_GID (1 << 2)
92 #define FATTR_SIZE (1 << 3)
93 #define FATTR_ATIME (1 << 4)
94 #define FATTR_MTIME (1 << 5)
95 #define FATTR_FH (1 << 6)
96 #define FATTR_ATIME_NOW (1 << 7)
97 #define FATTR_MTIME_NOW (1 << 8)
98 #define FATTR_LOCKOWNER (1 << 9)
101 * Flags returned by the OPEN request
103 * FOPEN_DIRECT_IO: bypass page cache for this open file
104 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
105 * FOPEN_NONSEEKABLE: the file is not seekable
107 #define FOPEN_DIRECT_IO (1 << 0)
108 #define FOPEN_KEEP_CACHE (1 << 1)
109 #define FOPEN_NONSEEKABLE (1 << 2)
112 * INIT request/reply flags
114 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
116 #define FUSE_ASYNC_READ (1 << 0)
117 #define FUSE_POSIX_LOCKS (1 << 1)
118 #define FUSE_FILE_OPS (1 << 2)
119 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
120 #define FUSE_EXPORT_SUPPORT (1 << 4)
121 #define FUSE_BIG_WRITES (1 << 5)
124 * CUSE INIT request/reply flags
126 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
128 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
133 #define FUSE_RELEASE_FLUSH (1 << 0)
138 #define FUSE_GETATTR_FH (1 << 0)
143 #define FUSE_LK_FLOCK (1 << 0)
148 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
149 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
151 #define FUSE_WRITE_CACHE (1 << 0)
152 #define FUSE_WRITE_LOCKOWNER (1 << 1)
157 #define FUSE_READ_LOCKOWNER (1 << 1)
162 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
163 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
164 * FUSE_IOCTL_RETRY: retry with new iovecs
166 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
168 #define FUSE_IOCTL_COMPAT (1 << 0)
169 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
170 #define FUSE_IOCTL_RETRY (1 << 2)
172 #define FUSE_IOCTL_MAX_IOV 256
177 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
179 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
183 FUSE_FORGET
= 2, /* no reply */
203 FUSE_REMOVEXATTR
= 24,
208 FUSE_RELEASEDIR
= 29,
221 /* CUSE specific operations */
225 enum fuse_notify_code
{
226 FUSE_NOTIFY_POLL
= 1,
227 FUSE_NOTIFY_CODE_MAX
,
230 /* The read buffer is required to be at least 8k, but may be much larger */
231 #define FUSE_MIN_READ_BUFFER 8192
233 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
235 struct fuse_entry_out
{
236 __u64 nodeid
; /* Inode ID */
237 __u64 generation
; /* Inode generation: nodeid:gen must
238 be unique for the fs's lifetime */
239 __u64 entry_valid
; /* Cache timeout for the name */
240 __u64 attr_valid
; /* Cache timeout for the attributes */
241 __u32 entry_valid_nsec
;
242 __u32 attr_valid_nsec
;
243 struct fuse_attr attr
;
246 struct fuse_forget_in
{
250 struct fuse_getattr_in
{
256 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
258 struct fuse_attr_out
{
259 __u64 attr_valid
; /* Cache timeout for the attributes */
260 __u32 attr_valid_nsec
;
262 struct fuse_attr attr
;
265 struct fuse_mknod_in
{
270 struct fuse_mkdir_in
{
275 struct fuse_rename_in
{
279 struct fuse_link_in
{
283 struct fuse_setattr_in
{
302 struct fuse_open_in
{
307 struct fuse_open_out
{
313 struct fuse_release_in
{
320 struct fuse_flush_in
{
327 struct fuse_read_in
{
337 #define FUSE_COMPAT_WRITE_IN_SIZE 24
339 struct fuse_write_in
{
349 struct fuse_write_out
{
354 #define FUSE_COMPAT_STATFS_SIZE 48
356 struct fuse_statfs_out
{
357 struct fuse_kstatfs st
;
360 struct fuse_fsync_in
{
366 struct fuse_setxattr_in
{
371 struct fuse_getxattr_in
{
376 struct fuse_getxattr_out
{
384 struct fuse_file_lock lk
;
390 struct fuse_file_lock lk
;
393 struct fuse_access_in
{
398 struct fuse_init_in
{
405 struct fuse_init_out
{
414 #define CUSE_INIT_INFO_MAX 4096
416 struct cuse_init_in
{
423 struct cuse_init_out
{
430 __u32 dev_major
; /* chardev major */
431 __u32 dev_minor
; /* chardev minor */
435 struct fuse_interrupt_in
{
439 struct fuse_bmap_in
{
445 struct fuse_bmap_out
{
449 struct fuse_ioctl_in
{
458 struct fuse_ioctl_out
{
465 struct fuse_poll_in
{
472 struct fuse_poll_out
{
477 struct fuse_notify_poll_wakeup_out
{
481 struct fuse_in_header
{
492 struct fuse_out_header
{
506 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
507 #define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
508 #define FUSE_DIRENT_SIZE(d) \
509 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
511 #endif /* _LINUX_FUSE_H */