Blame view
include/linux/fuse.h
10.8 KB
d8a5ba454
|
1 2 |
/* FUSE: Filesystem in Userspace |
1f55ed06c
|
3 |
Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu> |
d8a5ba454
|
4 5 6 7 |
This program can be distributed under the terms of the GNU GPL. See the file COPYING. */ |
c79e322f6
|
8 9 10 11 12 13 14 |
/* * This file defines the kernel interface of FUSE * * Protocol changelog: * * 7.9: * - new fuse_getattr_in input argument of GETATTR |
a9ff4f870
|
15 |
* - add lk_flags in fuse_lk_in |
f33321141
|
16 |
* - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in |
0e9663ee4
|
17 |
* - add blksize field to fuse_attr |
a6643094e
|
18 |
* - add file flags field to fuse_read_in and fuse_write_in |
a7c1b990f
|
19 20 21 |
* * 7.10 * - add nonseekable open flag |
1f55ed06c
|
22 23 24 25 26 |
* * 7.11 * - add IOCTL message * - add unsolicited notification support * - add POLL message and NOTIFY_POLL notification |
e0a43ddcc
|
27 28 29 |
* * 7.12 * - add umask flag to input argument of open, mknod and mkdir |
3b463ae0c
|
30 31 |
* - add notification messages for invalidation of inodes and * directory entries |
7a6d3c8b3
|
32 33 34 35 |
* * 7.13 * - make max number of background requests and congestion threshold * tunables |
dd3bb14f4
|
36 37 38 |
* * 7.14 * - add splice support to fuse device |
a1d75f258
|
39 40 41 |
* * 7.15 * - add store notify |
2d45ba381
|
42 |
* - add retrieve notify |
c79e322f6
|
43 |
*/ |
d8a5ba454
|
44 |
|
29d434b39
|
45 46 |
#ifndef _LINUX_FUSE_H #define _LINUX_FUSE_H |
1f55ed06c
|
47 |
#include <linux/types.h> |
d8a5ba454
|
48 |
|
37d217f02
|
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
/* * Version negotiation: * * Both the kernel and userspace send the version they support in the * INIT request and reply respectively. * * If the major versions match then both shall use the smallest * of the two minor versions for communication. * * If the kernel supports a larger major version, then userspace shall * reply with the major version it supports, ignore the rest of the * INIT message and expect a new INIT message from the kernel with a * matching major version. * * If the library supports a larger major version, then it shall fall * back to the major protocol version sent by the kernel for * communication and reply with that major version (and an arbitrary * supported minor version). */ |
d8a5ba454
|
68 |
/** Version number of this interface */ |
9e6268db4
|
69 |
#define FUSE_KERNEL_VERSION 7 |
d8a5ba454
|
70 71 |
/** Minor version number of this interface */ |
a1d75f258
|
72 |
#define FUSE_KERNEL_MINOR_VERSION 15 |
d8a5ba454
|
73 74 75 |
/** The node ID of the root inode */ #define FUSE_ROOT_ID 1 |
06663267b
|
76 77 |
/* Make sure all structures are padded to 64bit boundary, so 32bit userspace works under 64bit kernels */ |
d8a5ba454
|
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
struct fuse_attr { __u64 ino; __u64 size; __u64 blocks; __u64 atime; __u64 mtime; __u64 ctime; __u32 atimensec; __u32 mtimensec; __u32 ctimensec; __u32 mode; __u32 nlink; __u32 uid; __u32 gid; __u32 rdev; |
0e9663ee4
|
93 94 |
__u32 blksize; __u32 padding; |
d8a5ba454
|
95 |
}; |
e5e5558e9
|
96 97 98 99 100 101 102 103 |
struct fuse_kstatfs { __u64 blocks; __u64 bfree; __u64 bavail; __u64 files; __u64 ffree; __u32 bsize; __u32 namelen; |
de5f12025
|
104 105 106 |
__u32 frsize; __u32 padding; __u32 spare[6]; |
e5e5558e9
|
107 |
}; |
714212593
|
108 109 110 111 112 113 |
struct fuse_file_lock { __u64 start; __u64 end; __u32 type; __u32 pid; /* tgid */ }; |
9cd684551
|
114 115 116 |
/** * Bitmasks for fuse_setattr_in.valid */ |
9e6268db4
|
117 118 119 120 121 122 |
#define FATTR_MODE (1 << 0) #define FATTR_UID (1 << 1) #define FATTR_GID (1 << 2) #define FATTR_SIZE (1 << 3) #define FATTR_ATIME (1 << 4) #define FATTR_MTIME (1 << 5) |
befc649c2
|
123 |
#define FATTR_FH (1 << 6) |
17637cbab
|
124 125 |
#define FATTR_ATIME_NOW (1 << 7) #define FATTR_MTIME_NOW (1 << 8) |
f33321141
|
126 |
#define FATTR_LOCKOWNER (1 << 9) |
9e6268db4
|
127 |
|
45323fb76
|
128 129 130 131 132 |
/** * Flags returned by the OPEN request * * FOPEN_DIRECT_IO: bypass page cache for this open file * FOPEN_KEEP_CACHE: don't invalidate the data cache on open |
a7c1b990f
|
133 |
* FOPEN_NONSEEKABLE: the file is not seekable |
45323fb76
|
134 135 136 |
*/ #define FOPEN_DIRECT_IO (1 << 0) #define FOPEN_KEEP_CACHE (1 << 1) |
a7c1b990f
|
137 |
#define FOPEN_NONSEEKABLE (1 << 2) |
45323fb76
|
138 |
|
9cd684551
|
139 140 |
/** * INIT request/reply flags |
33670fa29
|
141 142 |
* * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".." |
e0a43ddcc
|
143 |
* FUSE_DONT_MASK: don't apply umask to file mode on create operations |
9cd684551
|
144 145 |
*/ #define FUSE_ASYNC_READ (1 << 0) |
714212593
|
146 |
#define FUSE_POSIX_LOCKS (1 << 1) |
c79e322f6
|
147 |
#define FUSE_FILE_OPS (1 << 2) |
6ff958edb
|
148 |
#define FUSE_ATOMIC_O_TRUNC (1 << 3) |
33670fa29
|
149 |
#define FUSE_EXPORT_SUPPORT (1 << 4) |
78bb6cb9a
|
150 |
#define FUSE_BIG_WRITES (1 << 5) |
e0a43ddcc
|
151 |
#define FUSE_DONT_MASK (1 << 6) |
9cd684551
|
152 |
|
e9168c189
|
153 |
/** |
151060ac1
|
154 155 156 157 158 159 160 |
* CUSE INIT request/reply flags * * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl */ #define CUSE_UNRESTRICTED_IOCTL (1 << 0) /** |
e9168c189
|
161 162 163 |
* Release flags */ #define FUSE_RELEASE_FLUSH (1 << 0) |
c79e322f6
|
164 165 166 167 |
/** * Getattr flags */ #define FUSE_GETATTR_FH (1 << 0) |
a9ff4f870
|
168 169 170 171 |
/** * Lock flags */ #define FUSE_LK_FLOCK (1 << 0) |
b25e82e56
|
172 173 174 175 |
/** * WRITE flags * * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed |
f33321141
|
176 |
* FUSE_WRITE_LOCKOWNER: lock_owner field is valid |
b25e82e56
|
177 178 |
*/ #define FUSE_WRITE_CACHE (1 << 0) |
f33321141
|
179 180 181 182 183 184 |
#define FUSE_WRITE_LOCKOWNER (1 << 1) /** * Read flags */ #define FUSE_READ_LOCKOWNER (1 << 1) |
b25e82e56
|
185 |
|
59efec7b9
|
186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
/** * Ioctl flags * * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed * FUSE_IOCTL_RETRY: retry with new iovecs * * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs */ #define FUSE_IOCTL_COMPAT (1 << 0) #define FUSE_IOCTL_UNRESTRICTED (1 << 1) #define FUSE_IOCTL_RETRY (1 << 2) #define FUSE_IOCTL_MAX_IOV 256 |
95668a69a
|
200 201 202 203 204 205 |
/** * Poll flags * * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify */ #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0) |
334f485df
|
206 |
enum fuse_opcode { |
e5e5558e9
|
207 208 209 |
FUSE_LOOKUP = 1, FUSE_FORGET = 2, /* no reply */ FUSE_GETATTR = 3, |
9e6268db4
|
210 |
FUSE_SETATTR = 4, |
e5e5558e9
|
211 |
FUSE_READLINK = 5, |
9e6268db4
|
212 |
FUSE_SYMLINK = 6, |
9e6268db4
|
213 214 215 216 217 218 |
FUSE_MKNOD = 8, FUSE_MKDIR = 9, FUSE_UNLINK = 10, FUSE_RMDIR = 11, FUSE_RENAME = 12, FUSE_LINK = 13, |
b6aeadeda
|
219 220 221 |
FUSE_OPEN = 14, FUSE_READ = 15, FUSE_WRITE = 16, |
e5e5558e9
|
222 |
FUSE_STATFS = 17, |
b6aeadeda
|
223 224 |
FUSE_RELEASE = 18, FUSE_FSYNC = 20, |
92a8780e1
|
225 226 227 228 |
FUSE_SETXATTR = 21, FUSE_GETXATTR = 22, FUSE_LISTXATTR = 23, FUSE_REMOVEXATTR = 24, |
b6aeadeda
|
229 |
FUSE_FLUSH = 25, |
04730fef1
|
230 231 232 |
FUSE_INIT = 26, FUSE_OPENDIR = 27, FUSE_READDIR = 28, |
825479819
|
233 |
FUSE_RELEASEDIR = 29, |
31d40d74b
|
234 |
FUSE_FSYNCDIR = 30, |
714212593
|
235 236 237 |
FUSE_GETLK = 31, FUSE_SETLK = 32, FUSE_SETLKW = 33, |
fd72faac9
|
238 |
FUSE_ACCESS = 34, |
a4d27e75f
|
239 240 |
FUSE_CREATE = 35, FUSE_INTERRUPT = 36, |
b2d2272fa
|
241 |
FUSE_BMAP = 37, |
0ec7ca41f
|
242 |
FUSE_DESTROY = 38, |
59efec7b9
|
243 |
FUSE_IOCTL = 39, |
95668a69a
|
244 |
FUSE_POLL = 40, |
2d45ba381
|
245 |
FUSE_NOTIFY_REPLY = 41, |
151060ac1
|
246 247 248 |
/* CUSE specific operations */ CUSE_INIT = 4096, |
334f485df
|
249 |
}; |
8599396b5
|
250 |
enum fuse_notify_code { |
95668a69a
|
251 |
FUSE_NOTIFY_POLL = 1, |
3b463ae0c
|
252 253 |
FUSE_NOTIFY_INVAL_INODE = 2, FUSE_NOTIFY_INVAL_ENTRY = 3, |
a1d75f258
|
254 |
FUSE_NOTIFY_STORE = 4, |
2d45ba381
|
255 |
FUSE_NOTIFY_RETRIEVE = 5, |
8599396b5
|
256 257 |
FUSE_NOTIFY_CODE_MAX, }; |
1d3d752b4
|
258 259 |
/* The read buffer is required to be at least 8k, but may be much larger */ #define FUSE_MIN_READ_BUFFER 8192 |
e5e5558e9
|
260 |
|
0e9663ee4
|
261 |
#define FUSE_COMPAT_ENTRY_OUT_SIZE 120 |
e5e5558e9
|
262 263 264 265 266 267 268 269 270 271 272 273 |
struct fuse_entry_out { __u64 nodeid; /* Inode ID */ __u64 generation; /* Inode generation: nodeid:gen must be unique for the fs's lifetime */ __u64 entry_valid; /* Cache timeout for the name */ __u64 attr_valid; /* Cache timeout for the attributes */ __u32 entry_valid_nsec; __u32 attr_valid_nsec; struct fuse_attr attr; }; struct fuse_forget_in { |
9e6268db4
|
274 |
__u64 nlookup; |
e5e5558e9
|
275 |
}; |
c79e322f6
|
276 277 278 279 280 |
struct fuse_getattr_in { __u32 getattr_flags; __u32 dummy; __u64 fh; }; |
0e9663ee4
|
281 |
#define FUSE_COMPAT_ATTR_OUT_SIZE 96 |
e5e5558e9
|
282 283 284 285 286 287 |
struct fuse_attr_out { __u64 attr_valid; /* Cache timeout for the attributes */ __u32 attr_valid_nsec; __u32 dummy; struct fuse_attr attr; }; |
e0a43ddcc
|
288 |
#define FUSE_COMPAT_MKNOD_IN_SIZE 8 |
9e6268db4
|
289 290 291 |
struct fuse_mknod_in { __u32 mode; __u32 rdev; |
e0a43ddcc
|
292 293 |
__u32 umask; __u32 padding; |
9e6268db4
|
294 295 296 297 |
}; struct fuse_mkdir_in { __u32 mode; |
e0a43ddcc
|
298 |
__u32 umask; |
9e6268db4
|
299 300 301 302 303 304 305 306 307 308 309 310 |
}; struct fuse_rename_in { __u64 newdir; }; struct fuse_link_in { __u64 oldnodeid; }; struct fuse_setattr_in { __u32 valid; |
06663267b
|
311 |
__u32 padding; |
befc649c2
|
312 313 |
__u64 fh; __u64 size; |
f33321141
|
314 |
__u64 lock_owner; |
befc649c2
|
315 316 317 318 319 320 321 322 323 324 325 |
__u64 atime; __u64 mtime; __u64 unused2; __u32 atimensec; __u32 mtimensec; __u32 unused3; __u32 mode; __u32 unused4; __u32 uid; __u32 gid; __u32 unused5; |
9e6268db4
|
326 |
}; |
b6aeadeda
|
327 328 |
struct fuse_open_in { __u32 flags; |
e0a43ddcc
|
329 330 331 332 333 |
__u32 unused; }; struct fuse_create_in { __u32 flags; |
fd72faac9
|
334 |
__u32 mode; |
e0a43ddcc
|
335 336 |
__u32 umask; __u32 padding; |
b6aeadeda
|
337 338 339 340 341 |
}; struct fuse_open_out { __u64 fh; __u32 open_flags; |
06663267b
|
342 |
__u32 padding; |
b6aeadeda
|
343 344 345 346 347 |
}; struct fuse_release_in { __u64 fh; __u32 flags; |
e9168c189
|
348 349 |
__u32 release_flags; __u64 lock_owner; |
b6aeadeda
|
350 351 352 353 |
}; struct fuse_flush_in { __u64 fh; |
e9168c189
|
354 |
__u32 unused; |
06663267b
|
355 |
__u32 padding; |
714212593
|
356 |
__u64 lock_owner; |
b6aeadeda
|
357 358 359 360 361 362 |
}; struct fuse_read_in { __u64 fh; __u64 offset; __u32 size; |
f33321141
|
363 364 |
__u32 read_flags; __u64 lock_owner; |
a6643094e
|
365 366 |
__u32 flags; __u32 padding; |
b6aeadeda
|
367 |
}; |
f33321141
|
368 |
#define FUSE_COMPAT_WRITE_IN_SIZE 24 |
b6aeadeda
|
369 370 371 372 373 |
struct fuse_write_in { __u64 fh; __u64 offset; __u32 size; __u32 write_flags; |
f33321141
|
374 |
__u64 lock_owner; |
a6643094e
|
375 376 |
__u32 flags; __u32 padding; |
b6aeadeda
|
377 378 379 380 |
}; struct fuse_write_out { __u32 size; |
06663267b
|
381 |
__u32 padding; |
b6aeadeda
|
382 |
}; |
de5f12025
|
383 |
#define FUSE_COMPAT_STATFS_SIZE 48 |
e5e5558e9
|
384 385 386 |
struct fuse_statfs_out { struct fuse_kstatfs st; }; |
b6aeadeda
|
387 388 389 |
struct fuse_fsync_in { __u64 fh; __u32 fsync_flags; |
06663267b
|
390 |
__u32 padding; |
b6aeadeda
|
391 |
}; |
92a8780e1
|
392 393 394 395 396 397 398 |
struct fuse_setxattr_in { __u32 size; __u32 flags; }; struct fuse_getxattr_in { __u32 size; |
06663267b
|
399 |
__u32 padding; |
92a8780e1
|
400 401 402 403 |
}; struct fuse_getxattr_out { __u32 size; |
06663267b
|
404 |
__u32 padding; |
92a8780e1
|
405 |
}; |
714212593
|
406 407 408 409 |
struct fuse_lk_in { __u64 fh; __u64 owner; struct fuse_file_lock lk; |
a9ff4f870
|
410 411 |
__u32 lk_flags; __u32 padding; |
714212593
|
412 413 414 415 416 |
}; struct fuse_lk_out { struct fuse_file_lock lk; }; |
31d40d74b
|
417 418 419 420 |
struct fuse_access_in { __u32 mask; __u32 padding; }; |
3ec870d52
|
421 |
struct fuse_init_in { |
334f485df
|
422 423 |
__u32 major; __u32 minor; |
9cd684551
|
424 425 |
__u32 max_readahead; __u32 flags; |
334f485df
|
426 |
}; |
3ec870d52
|
427 428 429 |
struct fuse_init_out { __u32 major; __u32 minor; |
9cd684551
|
430 431 |
__u32 max_readahead; __u32 flags; |
7a6d3c8b3
|
432 433 |
__u16 max_background; __u16 congestion_threshold; |
3ec870d52
|
434 435 |
__u32 max_write; }; |
151060ac1
|
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
#define CUSE_INIT_INFO_MAX 4096 struct cuse_init_in { __u32 major; __u32 minor; __u32 unused; __u32 flags; }; struct cuse_init_out { __u32 major; __u32 minor; __u32 unused; __u32 flags; __u32 max_read; __u32 max_write; __u32 dev_major; /* chardev major */ __u32 dev_minor; /* chardev minor */ __u32 spare[10]; }; |
a4d27e75f
|
456 457 458 |
struct fuse_interrupt_in { __u64 unique; }; |
b2d2272fa
|
459 460 461 462 463 464 465 466 467 |
struct fuse_bmap_in { __u64 block; __u32 blocksize; __u32 padding; }; struct fuse_bmap_out { __u64 block; }; |
59efec7b9
|
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 |
struct fuse_ioctl_in { __u64 fh; __u32 flags; __u32 cmd; __u64 arg; __u32 in_size; __u32 out_size; }; struct fuse_ioctl_out { __s32 result; __u32 flags; __u32 in_iovs; __u32 out_iovs; }; |
95668a69a
|
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 |
struct fuse_poll_in { __u64 fh; __u64 kh; __u32 flags; __u32 padding; }; struct fuse_poll_out { __u32 revents; __u32 padding; }; struct fuse_notify_poll_wakeup_out { __u64 kh; }; |
334f485df
|
498 499 500 501 502 503 504 505 |
struct fuse_in_header { __u32 len; __u32 opcode; __u64 unique; __u64 nodeid; __u32 uid; __u32 gid; __u32 pid; |
06663267b
|
506 |
__u32 padding; |
334f485df
|
507 508 509 510 511 512 513 |
}; struct fuse_out_header { __u32 len; __s32 error; __u64 unique; }; |
e5e5558e9
|
514 515 516 517 518 519 520 |
struct fuse_dirent { __u64 ino; __u64 off; __u32 namelen; __u32 type; char name[0]; }; |
21f3da95d
|
521 |
#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name) |
e5e5558e9
|
522 523 524 |
#define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1)) #define FUSE_DIRENT_SIZE(d) \ FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen) |
29d434b39
|
525 |
|
3b463ae0c
|
526 527 528 529 530 531 532 533 534 535 536 |
struct fuse_notify_inval_inode_out { __u64 ino; __s64 off; __s64 len; }; struct fuse_notify_inval_entry_out { __u64 parent; __u32 namelen; __u32 padding; }; |
a1d75f258
|
537 538 539 540 541 542 |
struct fuse_notify_store_out { __u64 nodeid; __u64 offset; __u32 size; __u32 padding; }; |
2d45ba381
|
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 |
struct fuse_notify_retrieve_out { __u64 notify_unique; __u64 nodeid; __u64 offset; __u32 size; __u32 padding; }; /* Matches the size of fuse_write_in */ struct fuse_notify_retrieve_in { __u64 dummy1; __u64 offset; __u32 size; __u32 dummy2; __u64 dummy3; __u64 dummy4; }; |
29d434b39
|
560 |
#endif /* _LINUX_FUSE_H */ |