Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 1 | /* |
| 2 | FUSE: Filesystem in Userspace |
Miklos Szeredi | 7142125 | 2006-06-25 05:48:52 -0700 | [diff] [blame] | 3 | Copyright (C) 2001-2006 Miklos Szeredi <miklos@szeredi.hu> |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [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 | |
| 11 | #include <asm/types.h> |
Jan Engelhardt | 3e8c54f | 2006-06-25 05:48:49 -0700 | [diff] [blame] | 12 | #include <linux/major.h> |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 13 | |
| 14 | /** Version number of this interface */ |
Miklos Szeredi | 9e6268d | 2005-09-09 13:10:29 -0700 | [diff] [blame] | 15 | #define FUSE_KERNEL_VERSION 7 |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 16 | |
| 17 | /** Minor version number of this interface */ |
Miklos Szeredi | e9168c1 | 2006-12-06 20:35:38 -0800 | [diff] [blame] | 18 | #define FUSE_KERNEL_MINOR_VERSION 8 |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 19 | |
| 20 | /** The node ID of the root inode */ |
| 21 | #define FUSE_ROOT_ID 1 |
| 22 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 23 | /** The major number of the fuse character device */ |
Jan Engelhardt | 3e8c54f | 2006-06-25 05:48:49 -0700 | [diff] [blame] | 24 | #define FUSE_MAJOR MISC_MAJOR |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 25 | |
| 26 | /** The minor number of the fuse character device */ |
| 27 | #define FUSE_MINOR 229 |
| 28 | |
Miklos Szeredi | 0666326 | 2005-09-09 13:10:32 -0700 | [diff] [blame] | 29 | /* Make sure all structures are padded to 64bit boundary, so 32bit |
| 30 | userspace works under 64bit kernels */ |
| 31 | |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 32 | struct fuse_attr { |
| 33 | __u64 ino; |
| 34 | __u64 size; |
| 35 | __u64 blocks; |
| 36 | __u64 atime; |
| 37 | __u64 mtime; |
| 38 | __u64 ctime; |
| 39 | __u32 atimensec; |
| 40 | __u32 mtimensec; |
| 41 | __u32 ctimensec; |
| 42 | __u32 mode; |
| 43 | __u32 nlink; |
| 44 | __u32 uid; |
| 45 | __u32 gid; |
| 46 | __u32 rdev; |
| 47 | }; |
| 48 | |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 49 | struct fuse_kstatfs { |
| 50 | __u64 blocks; |
| 51 | __u64 bfree; |
| 52 | __u64 bavail; |
| 53 | __u64 files; |
| 54 | __u64 ffree; |
| 55 | __u32 bsize; |
| 56 | __u32 namelen; |
Miklos Szeredi | de5f120 | 2006-01-06 00:19:37 -0800 | [diff] [blame] | 57 | __u32 frsize; |
| 58 | __u32 padding; |
| 59 | __u32 spare[6]; |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 60 | }; |
| 61 | |
Miklos Szeredi | 7142125 | 2006-06-25 05:48:52 -0700 | [diff] [blame] | 62 | struct fuse_file_lock { |
| 63 | __u64 start; |
| 64 | __u64 end; |
| 65 | __u32 type; |
| 66 | __u32 pid; /* tgid */ |
| 67 | }; |
| 68 | |
Miklos Szeredi | 9cd6845 | 2006-02-01 03:04:40 -0800 | [diff] [blame] | 69 | /** |
| 70 | * Bitmasks for fuse_setattr_in.valid |
| 71 | */ |
Miklos Szeredi | 9e6268d | 2005-09-09 13:10:29 -0700 | [diff] [blame] | 72 | #define FATTR_MODE (1 << 0) |
| 73 | #define FATTR_UID (1 << 1) |
| 74 | #define FATTR_GID (1 << 2) |
| 75 | #define FATTR_SIZE (1 << 3) |
| 76 | #define FATTR_ATIME (1 << 4) |
| 77 | #define FATTR_MTIME (1 << 5) |
Miklos Szeredi | befc649 | 2005-11-07 00:59:52 -0800 | [diff] [blame] | 78 | #define FATTR_FH (1 << 6) |
Miklos Szeredi | 9e6268d | 2005-09-09 13:10:29 -0700 | [diff] [blame] | 79 | |
Miklos Szeredi | 45323fb | 2005-09-09 13:10:37 -0700 | [diff] [blame] | 80 | /** |
| 81 | * Flags returned by the OPEN request |
| 82 | * |
| 83 | * FOPEN_DIRECT_IO: bypass page cache for this open file |
| 84 | * FOPEN_KEEP_CACHE: don't invalidate the data cache on open |
| 85 | */ |
| 86 | #define FOPEN_DIRECT_IO (1 << 0) |
| 87 | #define FOPEN_KEEP_CACHE (1 << 1) |
| 88 | |
Miklos Szeredi | 9cd6845 | 2006-02-01 03:04:40 -0800 | [diff] [blame] | 89 | /** |
| 90 | * INIT request/reply flags |
| 91 | */ |
| 92 | #define FUSE_ASYNC_READ (1 << 0) |
Miklos Szeredi | 7142125 | 2006-06-25 05:48:52 -0700 | [diff] [blame] | 93 | #define FUSE_POSIX_LOCKS (1 << 1) |
Miklos Szeredi | 9cd6845 | 2006-02-01 03:04:40 -0800 | [diff] [blame] | 94 | |
Miklos Szeredi | e9168c1 | 2006-12-06 20:35:38 -0800 | [diff] [blame] | 95 | /** |
| 96 | * Release flags |
| 97 | */ |
| 98 | #define FUSE_RELEASE_FLUSH (1 << 0) |
| 99 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 100 | enum fuse_opcode { |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 101 | FUSE_LOOKUP = 1, |
| 102 | FUSE_FORGET = 2, /* no reply */ |
| 103 | FUSE_GETATTR = 3, |
Miklos Szeredi | 9e6268d | 2005-09-09 13:10:29 -0700 | [diff] [blame] | 104 | FUSE_SETATTR = 4, |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 105 | FUSE_READLINK = 5, |
Miklos Szeredi | 9e6268d | 2005-09-09 13:10:29 -0700 | [diff] [blame] | 106 | FUSE_SYMLINK = 6, |
Miklos Szeredi | 9e6268d | 2005-09-09 13:10:29 -0700 | [diff] [blame] | 107 | FUSE_MKNOD = 8, |
| 108 | FUSE_MKDIR = 9, |
| 109 | FUSE_UNLINK = 10, |
| 110 | FUSE_RMDIR = 11, |
| 111 | FUSE_RENAME = 12, |
| 112 | FUSE_LINK = 13, |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 113 | FUSE_OPEN = 14, |
| 114 | FUSE_READ = 15, |
| 115 | FUSE_WRITE = 16, |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 116 | FUSE_STATFS = 17, |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 117 | FUSE_RELEASE = 18, |
| 118 | FUSE_FSYNC = 20, |
Miklos Szeredi | 92a8780 | 2005-09-09 13:10:31 -0700 | [diff] [blame] | 119 | FUSE_SETXATTR = 21, |
| 120 | FUSE_GETXATTR = 22, |
| 121 | FUSE_LISTXATTR = 23, |
| 122 | FUSE_REMOVEXATTR = 24, |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 123 | FUSE_FLUSH = 25, |
Miklos Szeredi | 04730fe | 2005-09-09 13:10:36 -0700 | [diff] [blame] | 124 | FUSE_INIT = 26, |
| 125 | FUSE_OPENDIR = 27, |
| 126 | FUSE_READDIR = 28, |
Miklos Szeredi | 8254798 | 2005-09-09 13:10:38 -0700 | [diff] [blame] | 127 | FUSE_RELEASEDIR = 29, |
Miklos Szeredi | 31d40d7 | 2005-11-07 00:59:50 -0800 | [diff] [blame] | 128 | FUSE_FSYNCDIR = 30, |
Miklos Szeredi | 7142125 | 2006-06-25 05:48:52 -0700 | [diff] [blame] | 129 | FUSE_GETLK = 31, |
| 130 | FUSE_SETLK = 32, |
| 131 | FUSE_SETLKW = 33, |
Miklos Szeredi | fd72faa | 2005-11-07 00:59:51 -0800 | [diff] [blame] | 132 | FUSE_ACCESS = 34, |
Miklos Szeredi | a4d27e7 | 2006-06-25 05:48:54 -0700 | [diff] [blame] | 133 | FUSE_CREATE = 35, |
| 134 | FUSE_INTERRUPT = 36, |
Miklos Szeredi | b2d2272 | 2006-12-06 20:35:51 -0800 | [diff] [blame^] | 135 | FUSE_BMAP = 37, |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 136 | }; |
| 137 | |
Miklos Szeredi | 1d3d752 | 2006-01-06 00:19:40 -0800 | [diff] [blame] | 138 | /* The read buffer is required to be at least 8k, but may be much larger */ |
| 139 | #define FUSE_MIN_READ_BUFFER 8192 |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 140 | |
| 141 | struct fuse_entry_out { |
| 142 | __u64 nodeid; /* Inode ID */ |
| 143 | __u64 generation; /* Inode generation: nodeid:gen must |
| 144 | be unique for the fs's lifetime */ |
| 145 | __u64 entry_valid; /* Cache timeout for the name */ |
| 146 | __u64 attr_valid; /* Cache timeout for the attributes */ |
| 147 | __u32 entry_valid_nsec; |
| 148 | __u32 attr_valid_nsec; |
| 149 | struct fuse_attr attr; |
| 150 | }; |
| 151 | |
| 152 | struct fuse_forget_in { |
Miklos Szeredi | 9e6268d | 2005-09-09 13:10:29 -0700 | [diff] [blame] | 153 | __u64 nlookup; |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 154 | }; |
| 155 | |
| 156 | struct fuse_attr_out { |
| 157 | __u64 attr_valid; /* Cache timeout for the attributes */ |
| 158 | __u32 attr_valid_nsec; |
| 159 | __u32 dummy; |
| 160 | struct fuse_attr attr; |
| 161 | }; |
| 162 | |
Miklos Szeredi | 9e6268d | 2005-09-09 13:10:29 -0700 | [diff] [blame] | 163 | struct fuse_mknod_in { |
| 164 | __u32 mode; |
| 165 | __u32 rdev; |
| 166 | }; |
| 167 | |
| 168 | struct fuse_mkdir_in { |
| 169 | __u32 mode; |
Miklos Szeredi | 0666326 | 2005-09-09 13:10:32 -0700 | [diff] [blame] | 170 | __u32 padding; |
Miklos Szeredi | 9e6268d | 2005-09-09 13:10:29 -0700 | [diff] [blame] | 171 | }; |
| 172 | |
| 173 | struct fuse_rename_in { |
| 174 | __u64 newdir; |
| 175 | }; |
| 176 | |
| 177 | struct fuse_link_in { |
| 178 | __u64 oldnodeid; |
| 179 | }; |
| 180 | |
| 181 | struct fuse_setattr_in { |
| 182 | __u32 valid; |
Miklos Szeredi | 0666326 | 2005-09-09 13:10:32 -0700 | [diff] [blame] | 183 | __u32 padding; |
Miklos Szeredi | befc649 | 2005-11-07 00:59:52 -0800 | [diff] [blame] | 184 | __u64 fh; |
| 185 | __u64 size; |
| 186 | __u64 unused1; |
| 187 | __u64 atime; |
| 188 | __u64 mtime; |
| 189 | __u64 unused2; |
| 190 | __u32 atimensec; |
| 191 | __u32 mtimensec; |
| 192 | __u32 unused3; |
| 193 | __u32 mode; |
| 194 | __u32 unused4; |
| 195 | __u32 uid; |
| 196 | __u32 gid; |
| 197 | __u32 unused5; |
Miklos Szeredi | 9e6268d | 2005-09-09 13:10:29 -0700 | [diff] [blame] | 198 | }; |
| 199 | |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 200 | struct fuse_open_in { |
| 201 | __u32 flags; |
Miklos Szeredi | fd72faa | 2005-11-07 00:59:51 -0800 | [diff] [blame] | 202 | __u32 mode; |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 203 | }; |
| 204 | |
| 205 | struct fuse_open_out { |
| 206 | __u64 fh; |
| 207 | __u32 open_flags; |
Miklos Szeredi | 0666326 | 2005-09-09 13:10:32 -0700 | [diff] [blame] | 208 | __u32 padding; |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 209 | }; |
| 210 | |
| 211 | struct fuse_release_in { |
| 212 | __u64 fh; |
| 213 | __u32 flags; |
Miklos Szeredi | e9168c1 | 2006-12-06 20:35:38 -0800 | [diff] [blame] | 214 | __u32 release_flags; |
| 215 | __u64 lock_owner; |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 216 | }; |
| 217 | |
| 218 | struct fuse_flush_in { |
| 219 | __u64 fh; |
Miklos Szeredi | e9168c1 | 2006-12-06 20:35:38 -0800 | [diff] [blame] | 220 | __u32 unused; |
Miklos Szeredi | 0666326 | 2005-09-09 13:10:32 -0700 | [diff] [blame] | 221 | __u32 padding; |
Miklos Szeredi | 7142125 | 2006-06-25 05:48:52 -0700 | [diff] [blame] | 222 | __u64 lock_owner; |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 223 | }; |
| 224 | |
| 225 | struct fuse_read_in { |
| 226 | __u64 fh; |
| 227 | __u64 offset; |
| 228 | __u32 size; |
Miklos Szeredi | 0666326 | 2005-09-09 13:10:32 -0700 | [diff] [blame] | 229 | __u32 padding; |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 230 | }; |
| 231 | |
| 232 | struct fuse_write_in { |
| 233 | __u64 fh; |
| 234 | __u64 offset; |
| 235 | __u32 size; |
| 236 | __u32 write_flags; |
| 237 | }; |
| 238 | |
| 239 | struct fuse_write_out { |
| 240 | __u32 size; |
Miklos Szeredi | 0666326 | 2005-09-09 13:10:32 -0700 | [diff] [blame] | 241 | __u32 padding; |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 242 | }; |
| 243 | |
Miklos Szeredi | de5f120 | 2006-01-06 00:19:37 -0800 | [diff] [blame] | 244 | #define FUSE_COMPAT_STATFS_SIZE 48 |
| 245 | |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 246 | struct fuse_statfs_out { |
| 247 | struct fuse_kstatfs st; |
| 248 | }; |
| 249 | |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 250 | struct fuse_fsync_in { |
| 251 | __u64 fh; |
| 252 | __u32 fsync_flags; |
Miklos Szeredi | 0666326 | 2005-09-09 13:10:32 -0700 | [diff] [blame] | 253 | __u32 padding; |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 254 | }; |
| 255 | |
Miklos Szeredi | 92a8780 | 2005-09-09 13:10:31 -0700 | [diff] [blame] | 256 | struct fuse_setxattr_in { |
| 257 | __u32 size; |
| 258 | __u32 flags; |
| 259 | }; |
| 260 | |
| 261 | struct fuse_getxattr_in { |
| 262 | __u32 size; |
Miklos Szeredi | 0666326 | 2005-09-09 13:10:32 -0700 | [diff] [blame] | 263 | __u32 padding; |
Miklos Szeredi | 92a8780 | 2005-09-09 13:10:31 -0700 | [diff] [blame] | 264 | }; |
| 265 | |
| 266 | struct fuse_getxattr_out { |
| 267 | __u32 size; |
Miklos Szeredi | 0666326 | 2005-09-09 13:10:32 -0700 | [diff] [blame] | 268 | __u32 padding; |
Miklos Szeredi | 92a8780 | 2005-09-09 13:10:31 -0700 | [diff] [blame] | 269 | }; |
| 270 | |
Miklos Szeredi | 7142125 | 2006-06-25 05:48:52 -0700 | [diff] [blame] | 271 | struct fuse_lk_in { |
| 272 | __u64 fh; |
| 273 | __u64 owner; |
| 274 | struct fuse_file_lock lk; |
| 275 | }; |
| 276 | |
| 277 | struct fuse_lk_out { |
| 278 | struct fuse_file_lock lk; |
| 279 | }; |
| 280 | |
Miklos Szeredi | 31d40d7 | 2005-11-07 00:59:50 -0800 | [diff] [blame] | 281 | struct fuse_access_in { |
| 282 | __u32 mask; |
| 283 | __u32 padding; |
| 284 | }; |
| 285 | |
Miklos Szeredi | 3ec870d | 2006-01-06 00:19:41 -0800 | [diff] [blame] | 286 | struct fuse_init_in { |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 287 | __u32 major; |
| 288 | __u32 minor; |
Miklos Szeredi | 9cd6845 | 2006-02-01 03:04:40 -0800 | [diff] [blame] | 289 | __u32 max_readahead; |
| 290 | __u32 flags; |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 291 | }; |
| 292 | |
Miklos Szeredi | 3ec870d | 2006-01-06 00:19:41 -0800 | [diff] [blame] | 293 | struct fuse_init_out { |
| 294 | __u32 major; |
| 295 | __u32 minor; |
Miklos Szeredi | 9cd6845 | 2006-02-01 03:04:40 -0800 | [diff] [blame] | 296 | __u32 max_readahead; |
| 297 | __u32 flags; |
| 298 | __u32 unused; |
Miklos Szeredi | 3ec870d | 2006-01-06 00:19:41 -0800 | [diff] [blame] | 299 | __u32 max_write; |
| 300 | }; |
| 301 | |
Miklos Szeredi | a4d27e7 | 2006-06-25 05:48:54 -0700 | [diff] [blame] | 302 | struct fuse_interrupt_in { |
| 303 | __u64 unique; |
| 304 | }; |
| 305 | |
Miklos Szeredi | b2d2272 | 2006-12-06 20:35:51 -0800 | [diff] [blame^] | 306 | struct fuse_bmap_in { |
| 307 | __u64 block; |
| 308 | __u32 blocksize; |
| 309 | __u32 padding; |
| 310 | }; |
| 311 | |
| 312 | struct fuse_bmap_out { |
| 313 | __u64 block; |
| 314 | }; |
| 315 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 316 | struct fuse_in_header { |
| 317 | __u32 len; |
| 318 | __u32 opcode; |
| 319 | __u64 unique; |
| 320 | __u64 nodeid; |
| 321 | __u32 uid; |
| 322 | __u32 gid; |
| 323 | __u32 pid; |
Miklos Szeredi | 0666326 | 2005-09-09 13:10:32 -0700 | [diff] [blame] | 324 | __u32 padding; |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 325 | }; |
| 326 | |
| 327 | struct fuse_out_header { |
| 328 | __u32 len; |
| 329 | __s32 error; |
| 330 | __u64 unique; |
| 331 | }; |
| 332 | |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 333 | struct fuse_dirent { |
| 334 | __u64 ino; |
| 335 | __u64 off; |
| 336 | __u32 namelen; |
| 337 | __u32 type; |
| 338 | char name[0]; |
| 339 | }; |
| 340 | |
| 341 | #define FUSE_NAME_OFFSET ((unsigned) ((struct fuse_dirent *) 0)->name) |
| 342 | #define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1)) |
| 343 | #define FUSE_DIRENT_SIZE(d) \ |
| 344 | FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen) |