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
30 * - add umask flag to input argument of open, mknod and mkdir
31 * - add notification messages for invalidation of inodes and
35 * - make max number of background requests and congestion threshold
39 * - add splice support to fuse device
43 * - add retrieve notify
46 * - add BATCH_FORGET request
47 * - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct
48 * fuse_ioctl_iovec' instead of ambiguous 'struct iovec'
49 * - add FUSE_IOCTL_32BIT flag
52 * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK
55 * - add FUSE_IOCTL_DIR flag
56 * - add FUSE_NOTIFY_DELETE
59 * - add FUSE_FALLOCATE
65 #include <linux/types.h>
68 * Version negotiation:
70 * Both the kernel and userspace send the version they support in the
71 * INIT request and reply respectively.
73 * If the major versions match then both shall use the smallest
74 * of the two minor versions for communication.
76 * If the kernel supports a larger major version, then userspace shall
77 * reply with the major version it supports, ignore the rest of the
78 * INIT message and expect a new INIT message from the kernel with a
79 * matching major version.
81 * If the library supports a larger major version, then it shall fall
82 * back to the major protocol version sent by the kernel for
83 * communication and reply with that major version (and an arbitrary
84 * supported minor version).
87 /** Version number of this interface */
88 #define FUSE_KERNEL_VERSION 7
90 /** Minor version number of this interface */
91 #define FUSE_KERNEL_MINOR_VERSION 19
93 /** The node ID of the root inode */
94 #define FUSE_ROOT_ID 1
96 /* Make sure all structures are padded to 64bit boundary, so 32bit
97 userspace works under 64bit kernels */
118 struct fuse_kstatfs
{
131 struct fuse_file_lock
{
135 __u32 pid
; /* tgid */
139 * Bitmasks for fuse_setattr_in.valid
141 #define FATTR_MODE (1 << 0)
142 #define FATTR_UID (1 << 1)
143 #define FATTR_GID (1 << 2)
144 #define FATTR_SIZE (1 << 3)
145 #define FATTR_ATIME (1 << 4)
146 #define FATTR_MTIME (1 << 5)
147 #define FATTR_FH (1 << 6)
148 #define FATTR_ATIME_NOW (1 << 7)
149 #define FATTR_MTIME_NOW (1 << 8)
150 #define FATTR_LOCKOWNER (1 << 9)
153 * Flags returned by the OPEN request
155 * FOPEN_DIRECT_IO: bypass page cache for this open file
156 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
157 * FOPEN_NONSEEKABLE: the file is not seekable
159 #define FOPEN_DIRECT_IO (1 << 0)
160 #define FOPEN_KEEP_CACHE (1 << 1)
161 #define FOPEN_NONSEEKABLE (1 << 2)
164 * INIT request/reply flags
166 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
167 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
168 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
169 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
171 #define FUSE_ASYNC_READ (1 << 0)
172 #define FUSE_POSIX_LOCKS (1 << 1)
173 #define FUSE_FILE_OPS (1 << 2)
174 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
175 #define FUSE_EXPORT_SUPPORT (1 << 4)
176 #define FUSE_BIG_WRITES (1 << 5)
177 #define FUSE_DONT_MASK (1 << 6)
178 #define FUSE_FLOCK_LOCKS (1 << 10)
181 * CUSE INIT request/reply flags
183 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
185 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
190 #define FUSE_RELEASE_FLUSH (1 << 0)
191 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
196 #define FUSE_GETATTR_FH (1 << 0)
201 #define FUSE_LK_FLOCK (1 << 0)
206 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
207 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
209 #define FUSE_WRITE_CACHE (1 << 0)
210 #define FUSE_WRITE_LOCKOWNER (1 << 1)
215 #define FUSE_READ_LOCKOWNER (1 << 1)
220 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
221 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
222 * FUSE_IOCTL_RETRY: retry with new iovecs
223 * FUSE_IOCTL_32BIT: 32bit ioctl
224 * FUSE_IOCTL_DIR: is a directory
226 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
228 #define FUSE_IOCTL_COMPAT (1 << 0)
229 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
230 #define FUSE_IOCTL_RETRY (1 << 2)
231 #define FUSE_IOCTL_32BIT (1 << 3)
232 #define FUSE_IOCTL_DIR (1 << 4)
234 #define FUSE_IOCTL_MAX_IOV 256
239 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
241 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
245 FUSE_FORGET
= 2, /* no reply */
265 FUSE_REMOVEXATTR
= 24,
270 FUSE_RELEASEDIR
= 29,
282 FUSE_NOTIFY_REPLY
= 41,
283 FUSE_BATCH_FORGET
= 42,
286 /* CUSE specific operations */
290 enum fuse_notify_code
{
291 FUSE_NOTIFY_POLL
= 1,
292 FUSE_NOTIFY_INVAL_INODE
= 2,
293 FUSE_NOTIFY_INVAL_ENTRY
= 3,
294 FUSE_NOTIFY_STORE
= 4,
295 FUSE_NOTIFY_RETRIEVE
= 5,
296 FUSE_NOTIFY_DELETE
= 6,
297 FUSE_NOTIFY_CODE_MAX
,
300 /* The read buffer is required to be at least 8k, but may be much larger */
301 #define FUSE_MIN_READ_BUFFER 8192
303 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
305 struct fuse_entry_out
{
306 __u64 nodeid
; /* Inode ID */
307 __u64 generation
; /* Inode generation: nodeid:gen must
308 be unique for the fs's lifetime */
309 __u64 entry_valid
; /* Cache timeout for the name */
310 __u64 attr_valid
; /* Cache timeout for the attributes */
311 __u32 entry_valid_nsec
;
312 __u32 attr_valid_nsec
;
313 struct fuse_attr attr
;
316 struct fuse_forget_in
{
320 struct fuse_forget_one
{
325 struct fuse_batch_forget_in
{
330 struct fuse_getattr_in
{
336 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
338 struct fuse_attr_out
{
339 __u64 attr_valid
; /* Cache timeout for the attributes */
340 __u32 attr_valid_nsec
;
342 struct fuse_attr attr
;
345 #define FUSE_COMPAT_MKNOD_IN_SIZE 8
347 struct fuse_mknod_in
{
354 struct fuse_mkdir_in
{
359 struct fuse_rename_in
{
363 struct fuse_link_in
{
367 struct fuse_setattr_in
{
386 struct fuse_open_in
{
391 struct fuse_create_in
{
398 struct fuse_open_out
{
404 struct fuse_release_in
{
411 struct fuse_flush_in
{
418 struct fuse_read_in
{
428 #define FUSE_COMPAT_WRITE_IN_SIZE 24
430 struct fuse_write_in
{
440 struct fuse_write_out
{
445 #define FUSE_COMPAT_STATFS_SIZE 48
447 struct fuse_statfs_out
{
448 struct fuse_kstatfs st
;
451 struct fuse_fsync_in
{
457 struct fuse_setxattr_in
{
462 struct fuse_getxattr_in
{
467 struct fuse_getxattr_out
{
475 struct fuse_file_lock lk
;
481 struct fuse_file_lock lk
;
484 struct fuse_access_in
{
489 struct fuse_init_in
{
496 struct fuse_init_out
{
501 __u16 max_background
;
502 __u16 congestion_threshold
;
506 #define CUSE_INIT_INFO_MAX 4096
508 struct cuse_init_in
{
515 struct cuse_init_out
{
522 __u32 dev_major
; /* chardev major */
523 __u32 dev_minor
; /* chardev minor */
527 struct fuse_interrupt_in
{
531 struct fuse_bmap_in
{
537 struct fuse_bmap_out
{
541 struct fuse_ioctl_in
{
550 struct fuse_ioctl_iovec
{
555 struct fuse_ioctl_out
{
562 struct fuse_poll_in
{
569 struct fuse_poll_out
{
574 struct fuse_notify_poll_wakeup_out
{
578 struct fuse_fallocate_in
{
586 struct fuse_in_header
{
597 struct fuse_out_header
{
611 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
612 #define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
613 #define FUSE_DIRENT_SIZE(d) \
614 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
616 struct fuse_notify_inval_inode_out
{
622 struct fuse_notify_inval_entry_out
{
628 struct fuse_notify_delete_out
{
635 struct fuse_notify_store_out
{
642 struct fuse_notify_retrieve_out
{
650 /* Matches the size of fuse_write_in */
651 struct fuse_notify_retrieve_in
{
660 #endif /* _LINUX_FUSE_H */