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
62 * - add FUSE_AUTO_INVAL_DATA
68 #include <linux/types.h>
71 * Version negotiation:
73 * Both the kernel and userspace send the version they support in the
74 * INIT request and reply respectively.
76 * If the major versions match then both shall use the smallest
77 * of the two minor versions for communication.
79 * If the kernel supports a larger major version, then userspace shall
80 * reply with the major version it supports, ignore the rest of the
81 * INIT message and expect a new INIT message from the kernel with a
82 * matching major version.
84 * If the library supports a larger major version, then it shall fall
85 * back to the major protocol version sent by the kernel for
86 * communication and reply with that major version (and an arbitrary
87 * supported minor version).
90 /** Version number of this interface */
91 #define FUSE_KERNEL_VERSION 7
93 /** Minor version number of this interface */
94 #define FUSE_KERNEL_MINOR_VERSION 20
96 /** The node ID of the root inode */
97 #define FUSE_ROOT_ID 1
99 /* Make sure all structures are padded to 64bit boundary, so 32bit
100 userspace works under 64bit kernels */
121 struct fuse_kstatfs {
134 struct fuse_file_lock {
138 __u32 pid; /* tgid */
142 * Bitmasks for fuse_setattr_in.valid
144 #define FATTR_MODE (1 << 0)
145 #define FATTR_UID (1 << 1)
146 #define FATTR_GID (1 << 2)
147 #define FATTR_SIZE (1 << 3)
148 #define FATTR_ATIME (1 << 4)
149 #define FATTR_MTIME (1 << 5)
150 #define FATTR_FH (1 << 6)
151 #define FATTR_ATIME_NOW (1 << 7)
152 #define FATTR_MTIME_NOW (1 << 8)
153 #define FATTR_LOCKOWNER (1 << 9)
156 * Flags returned by the OPEN request
158 * FOPEN_DIRECT_IO: bypass page cache for this open file
159 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
160 * FOPEN_NONSEEKABLE: the file is not seekable
162 #define FOPEN_DIRECT_IO (1 << 0)
163 #define FOPEN_KEEP_CACHE (1 << 1)
164 #define FOPEN_NONSEEKABLE (1 << 2)
167 * INIT request/reply flags
169 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks
170 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
171 * FUSE_DONT_MASK: don't apply umask to file mode on create operations
172 * FUSE_SPLICE_WRITE: kernel supports splice write on the device
173 * FUSE_SPLICE_MOVE: kernel supports splice move on the device
174 * FUSE_SPLICE_READ: kernel supports splice read on the device
175 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks
176 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories
177 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages
179 #define FUSE_ASYNC_READ (1 << 0)
180 #define FUSE_POSIX_LOCKS (1 << 1)
181 #define FUSE_FILE_OPS (1 << 2)
182 #define FUSE_ATOMIC_O_TRUNC (1 << 3)
183 #define FUSE_EXPORT_SUPPORT (1 << 4)
184 #define FUSE_BIG_WRITES (1 << 5)
185 #define FUSE_DONT_MASK (1 << 6)
186 #define FUSE_SPLICE_WRITE (1 << 7)
187 #define FUSE_SPLICE_MOVE (1 << 8)
188 #define FUSE_SPLICE_READ (1 << 9)
189 #define FUSE_FLOCK_LOCKS (1 << 10)
190 #define FUSE_HAS_IOCTL_DIR (1 << 11)
191 #define FUSE_AUTO_INVAL_DATA (1 << 12)
194 * CUSE INIT request/reply flags
196 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl
198 #define CUSE_UNRESTRICTED_IOCTL (1 << 0)
203 #define FUSE_RELEASE_FLUSH (1 << 0)
204 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1)
209 #define FUSE_GETATTR_FH (1 << 0)
214 #define FUSE_LK_FLOCK (1 << 0)
219 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
220 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
222 #define FUSE_WRITE_CACHE (1 << 0)
223 #define FUSE_WRITE_LOCKOWNER (1 << 1)
228 #define FUSE_READ_LOCKOWNER (1 << 1)
233 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
234 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
235 * FUSE_IOCTL_RETRY: retry with new iovecs
236 * FUSE_IOCTL_32BIT: 32bit ioctl
237 * FUSE_IOCTL_DIR: is a directory
239 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
241 #define FUSE_IOCTL_COMPAT (1 << 0)
242 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
243 #define FUSE_IOCTL_RETRY (1 << 2)
244 #define FUSE_IOCTL_32BIT (1 << 3)
245 #define FUSE_IOCTL_DIR (1 << 4)
247 #define FUSE_IOCTL_MAX_IOV 256
252 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
254 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
258 FUSE_FORGET = 2, /* no reply */
278 FUSE_REMOVEXATTR = 24,
283 FUSE_RELEASEDIR = 29,
295 FUSE_NOTIFY_REPLY = 41,
296 FUSE_BATCH_FORGET = 42,
299 /* CUSE specific operations */
303 enum fuse_notify_code {
304 FUSE_NOTIFY_POLL = 1,
305 FUSE_NOTIFY_INVAL_INODE = 2,
306 FUSE_NOTIFY_INVAL_ENTRY = 3,
307 FUSE_NOTIFY_STORE = 4,
308 FUSE_NOTIFY_RETRIEVE = 5,
309 FUSE_NOTIFY_DELETE = 6,
310 FUSE_NOTIFY_CODE_MAX,
313 /* The read buffer is required to be at least 8k, but may be much larger */
314 #define FUSE_MIN_READ_BUFFER 8192
316 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
318 struct fuse_entry_out {
319 __u64 nodeid; /* Inode ID */
320 __u64 generation; /* Inode generation: nodeid:gen must
321 be unique for the fs's lifetime */
322 __u64 entry_valid; /* Cache timeout for the name */
323 __u64 attr_valid; /* Cache timeout for the attributes */
324 __u32 entry_valid_nsec;
325 __u32 attr_valid_nsec;
326 struct fuse_attr attr;
329 struct fuse_forget_in {
333 struct fuse_forget_one {
338 struct fuse_batch_forget_in {
343 struct fuse_getattr_in {
349 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
351 struct fuse_attr_out {
352 __u64 attr_valid; /* Cache timeout for the attributes */
353 __u32 attr_valid_nsec;
355 struct fuse_attr attr;
358 #define FUSE_COMPAT_MKNOD_IN_SIZE 8
360 struct fuse_mknod_in {
367 struct fuse_mkdir_in {
372 struct fuse_rename_in {
376 struct fuse_link_in {
380 struct fuse_setattr_in {
399 struct fuse_open_in {
404 struct fuse_create_in {
411 struct fuse_open_out {
417 struct fuse_release_in {
424 struct fuse_flush_in {
431 struct fuse_read_in {
441 #define FUSE_COMPAT_WRITE_IN_SIZE 24
443 struct fuse_write_in {
453 struct fuse_write_out {
458 #define FUSE_COMPAT_STATFS_SIZE 48
460 struct fuse_statfs_out {
461 struct fuse_kstatfs st;
464 struct fuse_fsync_in {
470 struct fuse_setxattr_in {
475 struct fuse_getxattr_in {
480 struct fuse_getxattr_out {
488 struct fuse_file_lock lk;
494 struct fuse_file_lock lk;
497 struct fuse_access_in {
502 struct fuse_init_in {
509 struct fuse_init_out {
514 __u16 max_background;
515 __u16 congestion_threshold;
519 #define CUSE_INIT_INFO_MAX 4096
521 struct cuse_init_in {
528 struct cuse_init_out {
535 __u32 dev_major; /* chardev major */
536 __u32 dev_minor; /* chardev minor */
540 struct fuse_interrupt_in {
544 struct fuse_bmap_in {
550 struct fuse_bmap_out {
554 struct fuse_ioctl_in {
563 struct fuse_ioctl_iovec {
568 struct fuse_ioctl_out {
575 struct fuse_poll_in {
582 struct fuse_poll_out {
587 struct fuse_notify_poll_wakeup_out {
591 struct fuse_fallocate_in {
599 struct fuse_in_header {
610 struct fuse_out_header {
624 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
625 #define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
626 #define FUSE_DIRENT_SIZE(d) \
627 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
629 struct fuse_notify_inval_inode_out {
635 struct fuse_notify_inval_entry_out {
641 struct fuse_notify_delete_out {
648 struct fuse_notify_store_out {
655 struct fuse_notify_retrieve_out {
663 /* Matches the size of fuse_write_in */
664 struct fuse_notify_retrieve_in {
673 #endif /* _LINUX_FUSE_H */