Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 1 | /* |
| 2 | FUSE: Filesystem in Userspace |
Miklos Szeredi | 149f607 | 2005-01-10 12:29:28 +0000 | [diff] [blame] | 3 | Copyright (C) 2001-2005 Miklos Szeredi <miklos@szeredi.hu> |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 4 | |
| 5 | This program can be distributed under the terms of the GNU GPL. |
| 6 | See the file COPYING. |
| 7 | */ |
| 8 | |
| 9 | /* This file defines the kernel interface of FUSE */ |
| 10 | |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 11 | #include <asm/types.h> |
| 12 | |
Miklos Szeredi | 8cffdb9 | 2001-11-09 14:49:18 +0000 | [diff] [blame] | 13 | /** Version number of this interface */ |
Miklos Szeredi | 3800902 | 2005-05-08 19:47:22 +0000 | [diff] [blame] | 14 | #define FUSE_KERNEL_VERSION 7 |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 15 | |
Miklos Szeredi | 2f3d940 | 2003-12-15 12:11:33 +0000 | [diff] [blame] | 16 | /** Minor version number of this interface */ |
Miklos Szeredi | e3b8309 | 2005-07-22 17:24:30 +0000 | [diff] [blame] | 17 | #define FUSE_KERNEL_MINOR_VERSION 2 |
Miklos Szeredi | 2f3d940 | 2003-12-15 12:11:33 +0000 | [diff] [blame] | 18 | |
Miklos Szeredi | a13d900 | 2004-11-02 17:32:03 +0000 | [diff] [blame] | 19 | /** The node ID of the root inode */ |
| 20 | #define FUSE_ROOT_ID 1 |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 21 | |
Miklos Szeredi | a25d4c2 | 2004-11-23 22:32:16 +0000 | [diff] [blame] | 22 | /** The major number of the fuse character device */ |
| 23 | #define FUSE_MAJOR 10 |
| 24 | |
| 25 | /** The minor number of the fuse character device */ |
| 26 | #define FUSE_MINOR 229 |
| 27 | |
Miklos Szeredi | eab72ef | 2005-03-31 19:59:12 +0000 | [diff] [blame] | 28 | /* Make sure all structures are padded to 64bit boundary, so 32bit |
| 29 | userspace works under 64bit kernels */ |
| 30 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 31 | struct fuse_attr { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 32 | __u64 ino; |
| 33 | __u64 size; |
| 34 | __u64 blocks; |
| 35 | __u64 atime; |
| 36 | __u64 mtime; |
| 37 | __u64 ctime; |
| 38 | __u32 atimensec; |
| 39 | __u32 mtimensec; |
| 40 | __u32 ctimensec; |
| 41 | __u32 mode; |
| 42 | __u32 nlink; |
| 43 | __u32 uid; |
| 44 | __u32 gid; |
| 45 | __u32 rdev; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 46 | }; |
| 47 | |
Miklos Szeredi | 24ed945 | 2002-10-07 10:24:26 +0000 | [diff] [blame] | 48 | struct fuse_kstatfs { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 49 | __u64 blocks; |
| 50 | __u64 bfree; |
| 51 | __u64 bavail; |
| 52 | __u64 files; |
| 53 | __u64 ffree; |
| 54 | __u32 bsize; |
| 55 | __u32 namelen; |
Miklos Szeredi | 24ed945 | 2002-10-07 10:24:26 +0000 | [diff] [blame] | 56 | }; |
| 57 | |
Miklos Szeredi | e3b8309 | 2005-07-22 17:24:30 +0000 | [diff] [blame] | 58 | struct fuse_file_lock { |
| 59 | __u64 start; |
| 60 | __u64 end; |
| 61 | __u64 owner; |
| 62 | __u32 pid; |
| 63 | __u32 type; |
| 64 | }; |
| 65 | |
Miklos Szeredi | 5648781 | 2005-09-02 13:05:06 +0000 | [diff] [blame^] | 66 | /** Valid attribute mask used in the SETATTR request */ |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 67 | #define FATTR_MODE (1 << 0) |
| 68 | #define FATTR_UID (1 << 1) |
| 69 | #define FATTR_GID (1 << 2) |
| 70 | #define FATTR_SIZE (1 << 3) |
Miklos Szeredi | b595861 | 2004-02-20 14:10:49 +0000 | [diff] [blame] | 71 | #define FATTR_ATIME (1 << 4) |
| 72 | #define FATTR_MTIME (1 << 5) |
| 73 | #define FATTR_CTIME (1 << 6) |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 74 | |
Miklos Szeredi | 5648781 | 2005-09-02 13:05:06 +0000 | [diff] [blame^] | 75 | /** |
| 76 | * Flags returned by the OPEN request |
| 77 | * |
| 78 | * FOPEN_DIRECT_IO: bypass page cache for this open file |
| 79 | * FOPEN_KEEP_CACHE: don't invalidate the data cache on open |
| 80 | */ |
Miklos Szeredi | e77cc07 | 2005-08-01 11:58:51 +0000 | [diff] [blame] | 81 | #define FOPEN_DIRECT_IO (1 << 0) |
| 82 | #define FOPEN_KEEP_CACHE (1 << 1) |
| 83 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 84 | enum fuse_opcode { |
Miklos Szeredi | 3ed8423 | 2004-03-30 15:17:26 +0000 | [diff] [blame] | 85 | FUSE_LOOKUP = 1, |
| 86 | FUSE_FORGET = 2, /* no reply */ |
| 87 | FUSE_GETATTR = 3, |
| 88 | FUSE_SETATTR = 4, |
| 89 | FUSE_READLINK = 5, |
| 90 | FUSE_SYMLINK = 6, |
Miklos Szeredi | 3ed8423 | 2004-03-30 15:17:26 +0000 | [diff] [blame] | 91 | FUSE_MKNOD = 8, |
| 92 | FUSE_MKDIR = 9, |
| 93 | FUSE_UNLINK = 10, |
| 94 | FUSE_RMDIR = 11, |
| 95 | FUSE_RENAME = 12, |
| 96 | FUSE_LINK = 13, |
| 97 | FUSE_OPEN = 14, |
| 98 | FUSE_READ = 15, |
| 99 | FUSE_WRITE = 16, |
| 100 | FUSE_STATFS = 17, |
Miklos Szeredi | 72cf5c9 | 2004-11-20 16:10:30 +0000 | [diff] [blame] | 101 | FUSE_RELEASE = 18, |
Miklos Szeredi | 3ed8423 | 2004-03-30 15:17:26 +0000 | [diff] [blame] | 102 | FUSE_FSYNC = 20, |
| 103 | FUSE_SETXATTR = 21, |
| 104 | FUSE_GETXATTR = 22, |
| 105 | FUSE_LISTXATTR = 23, |
| 106 | FUSE_REMOVEXATTR = 24, |
Miklos Szeredi | e2e4ac2 | 2004-05-18 08:45:28 +0000 | [diff] [blame] | 107 | FUSE_FLUSH = 25, |
Miklos Szeredi | 3ead28e | 2005-01-18 21:23:41 +0000 | [diff] [blame] | 108 | FUSE_INIT = 26, |
| 109 | FUSE_OPENDIR = 27, |
| 110 | FUSE_READDIR = 28, |
Miklos Szeredi | 4283ee7 | 2005-03-21 12:09:04 +0000 | [diff] [blame] | 111 | FUSE_RELEASEDIR = 29, |
Miklos Szeredi | e3b8309 | 2005-07-22 17:24:30 +0000 | [diff] [blame] | 112 | FUSE_FSYNCDIR = 30, |
| 113 | FUSE_GETLK = 31, |
| 114 | FUSE_SETLK = 32, |
Miklos Szeredi | 7b28eae | 2005-08-01 12:48:30 +0000 | [diff] [blame] | 115 | FUSE_SETLKW = 33, |
Miklos Szeredi | b0c52c5 | 2005-08-23 15:39:43 +0000 | [diff] [blame] | 116 | FUSE_ACCESS = 34, |
Miklos Szeredi | ecce1bf | 2005-08-25 15:19:06 +0000 | [diff] [blame] | 117 | FUSE_CREATE = 35, |
| 118 | FUSE_FSETATTR = 36 |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 119 | }; |
| 120 | |
| 121 | /* Conservative buffer size for the client */ |
| 122 | #define FUSE_MAX_IN 8192 |
| 123 | |
Miklos Szeredi | c26c14d | 2004-04-09 17:48:32 +0000 | [diff] [blame] | 124 | #define FUSE_NAME_MAX 1024 |
| 125 | #define FUSE_SYMLINK_MAX 4096 |
| 126 | #define FUSE_XATTR_SIZE_MAX 4096 |
| 127 | |
Miklos Szeredi | 254d5ed | 2004-03-02 11:11:24 +0000 | [diff] [blame] | 128 | struct fuse_entry_out { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 129 | __u64 nodeid; /* Inode ID */ |
| 130 | __u64 generation; /* Inode generation: nodeid:gen must |
| 131 | be unique for the fs's lifetime */ |
| 132 | __u64 entry_valid; /* Cache timeout for the name */ |
| 133 | __u64 attr_valid; /* Cache timeout for the attributes */ |
| 134 | __u32 entry_valid_nsec; |
| 135 | __u32 attr_valid_nsec; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 136 | struct fuse_attr attr; |
| 137 | }; |
| 138 | |
Miklos Szeredi | a181e61 | 2001-11-06 12:03:23 +0000 | [diff] [blame] | 139 | struct fuse_forget_in { |
Miklos Szeredi | 3800902 | 2005-05-08 19:47:22 +0000 | [diff] [blame] | 140 | __u64 nlookup; |
Miklos Szeredi | a181e61 | 2001-11-06 12:03:23 +0000 | [diff] [blame] | 141 | }; |
| 142 | |
Miklos Szeredi | 254d5ed | 2004-03-02 11:11:24 +0000 | [diff] [blame] | 143 | struct fuse_attr_out { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 144 | __u64 attr_valid; /* Cache timeout for the attributes */ |
| 145 | __u32 attr_valid_nsec; |
| 146 | __u32 dummy; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 147 | struct fuse_attr attr; |
| 148 | }; |
| 149 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 150 | struct fuse_mknod_in { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 151 | __u32 mode; |
| 152 | __u32 rdev; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 153 | }; |
| 154 | |
Miklos Szeredi | b483c93 | 2001-10-29 14:57:57 +0000 | [diff] [blame] | 155 | struct fuse_mkdir_in { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 156 | __u32 mode; |
Miklos Szeredi | eab72ef | 2005-03-31 19:59:12 +0000 | [diff] [blame] | 157 | __u32 padding; |
Miklos Szeredi | b483c93 | 2001-10-29 14:57:57 +0000 | [diff] [blame] | 158 | }; |
| 159 | |
Miklos Szeredi | b483c93 | 2001-10-29 14:57:57 +0000 | [diff] [blame] | 160 | struct fuse_rename_in { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 161 | __u64 newdir; |
Miklos Szeredi | 19dff1b | 2001-10-30 15:06:52 +0000 | [diff] [blame] | 162 | }; |
| 163 | |
| 164 | struct fuse_link_in { |
Miklos Szeredi | ed6b5dd | 2005-01-26 17:07:59 +0000 | [diff] [blame] | 165 | __u64 oldnodeid; |
Miklos Szeredi | b483c93 | 2001-10-29 14:57:57 +0000 | [diff] [blame] | 166 | }; |
| 167 | |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 168 | struct fuse_setattr_in { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 169 | __u32 valid; |
Miklos Szeredi | eab72ef | 2005-03-31 19:59:12 +0000 | [diff] [blame] | 170 | __u32 padding; |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 171 | struct fuse_attr attr; |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 172 | }; |
| 173 | |
Miklos Szeredi | ecce1bf | 2005-08-25 15:19:06 +0000 | [diff] [blame] | 174 | struct fuse_fsetattr_in { |
| 175 | __u64 fh; |
| 176 | struct fuse_setattr_in setattr; |
| 177 | }; |
| 178 | |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 179 | struct fuse_open_in { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 180 | __u32 flags; |
Miklos Szeredi | b0c52c5 | 2005-08-23 15:39:43 +0000 | [diff] [blame] | 181 | __u32 mode; |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 182 | }; |
| 183 | |
Miklos Szeredi | 209f5d0 | 2004-07-24 19:56:16 +0000 | [diff] [blame] | 184 | struct fuse_open_out { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 185 | __u64 fh; |
| 186 | __u32 open_flags; |
Miklos Szeredi | eab72ef | 2005-03-31 19:59:12 +0000 | [diff] [blame] | 187 | __u32 padding; |
Miklos Szeredi | 209f5d0 | 2004-07-24 19:56:16 +0000 | [diff] [blame] | 188 | }; |
| 189 | |
| 190 | struct fuse_release_in { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 191 | __u64 fh; |
| 192 | __u32 flags; |
Miklos Szeredi | eab72ef | 2005-03-31 19:59:12 +0000 | [diff] [blame] | 193 | __u32 padding; |
Miklos Szeredi | 209f5d0 | 2004-07-24 19:56:16 +0000 | [diff] [blame] | 194 | }; |
| 195 | |
| 196 | struct fuse_flush_in { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 197 | __u64 fh; |
| 198 | __u32 flush_flags; |
Miklos Szeredi | eab72ef | 2005-03-31 19:59:12 +0000 | [diff] [blame] | 199 | __u32 padding; |
Miklos Szeredi | 209f5d0 | 2004-07-24 19:56:16 +0000 | [diff] [blame] | 200 | }; |
| 201 | |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 202 | struct fuse_read_in { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 203 | __u64 fh; |
| 204 | __u64 offset; |
| 205 | __u32 size; |
Miklos Szeredi | eab72ef | 2005-03-31 19:59:12 +0000 | [diff] [blame] | 206 | __u32 padding; |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 207 | }; |
| 208 | |
Miklos Szeredi | a181e61 | 2001-11-06 12:03:23 +0000 | [diff] [blame] | 209 | struct fuse_write_in { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 210 | __u64 fh; |
| 211 | __u64 offset; |
| 212 | __u32 size; |
| 213 | __u32 write_flags; |
Miklos Szeredi | a181e61 | 2001-11-06 12:03:23 +0000 | [diff] [blame] | 214 | }; |
| 215 | |
Miklos Szeredi | ad051c3 | 2004-07-02 09:22:50 +0000 | [diff] [blame] | 216 | struct fuse_write_out { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 217 | __u32 size; |
Miklos Szeredi | eab72ef | 2005-03-31 19:59:12 +0000 | [diff] [blame] | 218 | __u32 padding; |
Miklos Szeredi | ad051c3 | 2004-07-02 09:22:50 +0000 | [diff] [blame] | 219 | }; |
| 220 | |
Mark Glines | d84b39a | 2002-01-07 16:32:02 +0000 | [diff] [blame] | 221 | struct fuse_statfs_out { |
Miklos Szeredi | 24ed945 | 2002-10-07 10:24:26 +0000 | [diff] [blame] | 222 | struct fuse_kstatfs st; |
Mark Glines | d84b39a | 2002-01-07 16:32:02 +0000 | [diff] [blame] | 223 | }; |
| 224 | |
Miklos Szeredi | 5e43f2c | 2003-12-12 14:06:41 +0000 | [diff] [blame] | 225 | struct fuse_fsync_in { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 226 | __u64 fh; |
| 227 | __u32 fsync_flags; |
Miklos Szeredi | eab72ef | 2005-03-31 19:59:12 +0000 | [diff] [blame] | 228 | __u32 padding; |
Miklos Szeredi | 5e43f2c | 2003-12-12 14:06:41 +0000 | [diff] [blame] | 229 | }; |
| 230 | |
Miklos Szeredi | 3ed8423 | 2004-03-30 15:17:26 +0000 | [diff] [blame] | 231 | struct fuse_setxattr_in { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 232 | __u32 size; |
| 233 | __u32 flags; |
Miklos Szeredi | 3ed8423 | 2004-03-30 15:17:26 +0000 | [diff] [blame] | 234 | }; |
| 235 | |
Miklos Szeredi | 03cebae | 2004-03-31 10:19:18 +0000 | [diff] [blame] | 236 | struct fuse_getxattr_in { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 237 | __u32 size; |
Miklos Szeredi | eab72ef | 2005-03-31 19:59:12 +0000 | [diff] [blame] | 238 | __u32 padding; |
Miklos Szeredi | 03cebae | 2004-03-31 10:19:18 +0000 | [diff] [blame] | 239 | }; |
| 240 | |
| 241 | struct fuse_getxattr_out { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 242 | __u32 size; |
Miklos Szeredi | eab72ef | 2005-03-31 19:59:12 +0000 | [diff] [blame] | 243 | __u32 padding; |
Miklos Szeredi | 3ed8423 | 2004-03-30 15:17:26 +0000 | [diff] [blame] | 244 | }; |
| 245 | |
Miklos Szeredi | e3b8309 | 2005-07-22 17:24:30 +0000 | [diff] [blame] | 246 | struct fuse_lk_in_out { |
| 247 | struct fuse_file_lock lk; |
| 248 | }; |
| 249 | |
Miklos Szeredi | 7b28eae | 2005-08-01 12:48:30 +0000 | [diff] [blame] | 250 | struct fuse_access_in { |
| 251 | __u32 mask; |
| 252 | __u32 padding; |
| 253 | }; |
| 254 | |
Miklos Szeredi | 3f0005f | 2005-01-04 19:24:31 +0000 | [diff] [blame] | 255 | struct fuse_init_in_out { |
| 256 | __u32 major; |
| 257 | __u32 minor; |
| 258 | }; |
| 259 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 260 | struct fuse_in_header { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 261 | __u32 len; |
| 262 | __u32 opcode; |
| 263 | __u64 unique; |
| 264 | __u64 nodeid; |
| 265 | __u32 uid; |
| 266 | __u32 gid; |
| 267 | __u32 pid; |
Miklos Szeredi | eab72ef | 2005-03-31 19:59:12 +0000 | [diff] [blame] | 268 | __u32 padding; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 269 | }; |
| 270 | |
| 271 | struct fuse_out_header { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 272 | __u32 len; |
| 273 | __s32 error; |
| 274 | __u64 unique; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 275 | }; |
| 276 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 277 | struct fuse_dirent { |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 278 | __u64 ino; |
Miklos Szeredi | eab72ef | 2005-03-31 19:59:12 +0000 | [diff] [blame] | 279 | __u64 off; |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 280 | __u32 namelen; |
| 281 | __u32 type; |
| 282 | char name[0]; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 283 | }; |
| 284 | |
Miklos Szeredi | 0f62d72 | 2005-01-04 12:45:54 +0000 | [diff] [blame] | 285 | #define FUSE_NAME_OFFSET ((unsigned) ((struct fuse_dirent *) 0)->name) |
| 286 | #define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1)) |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 287 | #define FUSE_DIRENT_SIZE(d) \ |
| 288 | FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen) |