2 FUSE: Filesystem in Userspace
3 Copyright (C) 2001-2006 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
28 #include <asm/types.h>
29 #include <linux/major.h>
31 /** Version number of this interface */
32 #define FUSE_KERNEL_VERSION 7
34 /** Minor version number of this interface */
35 #define FUSE_KERNEL_MINOR_VERSION 10
37 /** The node ID of the root inode */
38 #define FUSE_ROOT_ID 1
40 /** The major number of the fuse character device */
41 #define FUSE_MAJOR MISC_MAJOR
43 /* Make sure all structures are padded to 64bit boundary, so 32bit
44 userspace works under 64bit kernels */
78 struct fuse_file_lock {
86 * Bitmasks for fuse_setattr_in.valid
88 #define FATTR_MODE (1 << 0)
89 #define FATTR_UID (1 << 1)
90 #define FATTR_GID (1 << 2)
91 #define FATTR_SIZE (1 << 3)
92 #define FATTR_ATIME (1 << 4)
93 #define FATTR_MTIME (1 << 5)
94 #define FATTR_FH (1 << 6)
95 #define FATTR_ATIME_NOW (1 << 7)
96 #define FATTR_MTIME_NOW (1 << 8)
97 #define FATTR_LOCKOWNER (1 << 9)
100 * Flags returned by the OPEN request
102 * FOPEN_DIRECT_IO: bypass page cache for this open file
103 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
104 * FOPEN_NONSEEKABLE: the file is not seekable
106 #define FOPEN_DIRECT_IO (1 << 0)
107 #define FOPEN_KEEP_CACHE (1 << 1)
108 #define FOPEN_NONSEEKABLE (1 << 2)
111 * INIT request/reply flags
113 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
115 #define FUSE_ASYNC_READ (1 << 0)
116 #define FUSE_POSIX_LOCKS (1 << 1)
117 #define FUSE_FILE_OPS (1 << 2)
118 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
119 #define FUSE_EXPORT_SUPPORT (1 << 4)
120 #define FUSE_BIG_WRITES (1 << 5)
125 #define FUSE_RELEASE_FLUSH (1 << 0)
130 #define FUSE_GETATTR_FH (1 << 0)
135 #define FUSE_LK_FLOCK (1 << 0)
140 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
141 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
143 #define FUSE_WRITE_CACHE (1 << 0)
144 #define FUSE_WRITE_LOCKOWNER (1 << 1)
149 #define FUSE_READ_LOCKOWNER (1 << 1)
154 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
155 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
156 * FUSE_IOCTL_RETRY: retry with new iovecs
158 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
160 #define FUSE_IOCTL_COMPAT (1 << 0)
161 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
162 #define FUSE_IOCTL_RETRY (1 << 2)
164 #define FUSE_IOCTL_MAX_IOV 256
168 FUSE_FORGET = 2, /* no reply */
188 FUSE_REMOVEXATTR = 24,
193 FUSE_RELEASEDIR = 29,
206 enum fuse_notify_code {
207 FUSE_NOTIFY_CODE_MAX,
210 /* The read buffer is required to be at least 8k, but may be much larger */
211 #define FUSE_MIN_READ_BUFFER 8192
213 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
215 struct fuse_entry_out {
216 __u64 nodeid; /* Inode ID */
217 __u64 generation; /* Inode generation: nodeid:gen must
218 be unique for the fs's lifetime */
219 __u64 entry_valid; /* Cache timeout for the name */
220 __u64 attr_valid; /* Cache timeout for the attributes */
221 __u32 entry_valid_nsec;
222 __u32 attr_valid_nsec;
223 struct fuse_attr attr;
226 struct fuse_forget_in {
230 struct fuse_getattr_in {
236 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
238 struct fuse_attr_out {
239 __u64 attr_valid; /* Cache timeout for the attributes */
240 __u32 attr_valid_nsec;
242 struct fuse_attr attr;
245 struct fuse_mknod_in {
250 struct fuse_mkdir_in {
255 struct fuse_rename_in {
259 struct fuse_link_in {
263 struct fuse_setattr_in {
282 struct fuse_open_in {
287 struct fuse_open_out {
293 struct fuse_release_in {
300 struct fuse_flush_in {
307 struct fuse_read_in {
317 #define FUSE_COMPAT_WRITE_IN_SIZE 24
319 struct fuse_write_in {
329 struct fuse_write_out {
334 #define FUSE_COMPAT_STATFS_SIZE 48
336 struct fuse_statfs_out {
337 struct fuse_kstatfs st;
340 struct fuse_fsync_in {
346 struct fuse_setxattr_in {
351 struct fuse_getxattr_in {
356 struct fuse_getxattr_out {
364 struct fuse_file_lock lk;
370 struct fuse_file_lock lk;
373 struct fuse_access_in {
378 struct fuse_init_in {
385 struct fuse_init_out {
394 struct fuse_interrupt_in {
398 struct fuse_bmap_in {
404 struct fuse_bmap_out {
408 struct fuse_ioctl_in {
417 struct fuse_ioctl_out {
424 struct fuse_in_header {
435 struct fuse_out_header {
449 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
450 #define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
451 #define FUSE_DIRENT_SIZE(d) \
452 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
454 #endif /* _LINUX_FUSE_H */