1 /* 2 This file defines the kernel interface of FUSE 3 Copyright (C) 2001-2008 Miklos Szeredi <[email protected]> 4 5 This program can be distributed under the terms of the GNU GPL. 6 See the file COPYING. 7 8 This -- and only this -- header file may also be distributed under 9 the terms of the BSD Licence as follows: 10 11 Copyright (C) 2001-2007 Miklos Szeredi. All rights reserved. 12 13 Redistribution and use in source and binary forms, with or without 14 modification, are permitted provided that the following conditions 15 are met: 16 1. Redistributions of source code must retain the above copyright 17 notice, this list of conditions and the following disclaimer. 18 2. Redistributions in binary form must reproduce the above copyright 19 notice, this list of conditions and the following disclaimer in the 20 documentation and/or other materials provided with the distribution. 21 22 THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 23 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 26 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 SUCH DAMAGE. 33 */ 34 35 /* 36 * This file defines the kernel interface of FUSE 37 * 38 * Protocol changelog: 39 * 40 * 7.9: 41 * - new fuse_getattr_in input argument of GETATTR 42 * - add lk_flags in fuse_lk_in 43 * - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in 44 * - add blksize field to fuse_attr 45 * - add file flags field to fuse_read_in and fuse_write_in 46 * 47 * 7.10 48 * - add nonseekable open flag 49 * 50 * 7.11 51 * - add IOCTL message 52 * - add unsolicited notification support 53 * - add POLL message and NOTIFY_POLL notification 54 * 55 * 7.12 56 * - add umask flag to input argument of open, mknod and mkdir 57 * - add notification messages for invalidation of inodes and 58 * directory entries 59 * 60 * 7.13 61 * - make max number of background requests and congestion threshold 62 * tunables 63 * 64 * 7.14 65 * - add splice support to fuse device 66 * 67 * 7.15 68 * - add store notify 69 * - add retrieve notify 70 * 71 * 7.16 72 * - add BATCH_FORGET request 73 * - FUSE_IOCTL_UNRESTRICTED shall now return with array of 'struct 74 * fuse_ioctl_iovec' instead of ambiguous 'struct iovec' 75 * - add FUSE_IOCTL_32BIT flag 76 * 77 * 7.17 78 * - add FUSE_FLOCK_LOCKS and FUSE_RELEASE_FLOCK_UNLOCK 79 * 80 * 7.18 81 * - add FUSE_IOCTL_DIR flag 82 * - add FUSE_NOTIFY_DELETE 83 * 84 * 7.19 85 * - add FUSE_FALLOCATE 86 * 87 * 7.20 88 * - add FUSE_AUTO_INVAL_DATA 89 * 90 * 7.21 91 * - add FUSE_READDIRPLUS 92 * - send the requested events in POLL request 93 */ 94 95 #ifndef _LINUX_FUSE_H 96 #define _LINUX_FUSE_H 97 98 #ifdef __KERNEL__ 99 #include <linux/types.h> 100 #else 101 #include <stdint.h> 102 #endif 103 104 /* 105 * Version negotiation: 106 * 107 * Both the kernel and userspace send the version they support in the 108 * INIT request and reply respectively. 109 * 110 * If the major versions match then both shall use the smallest 111 * of the two minor versions for communication. 112 * 113 * If the kernel supports a larger major version, then userspace shall 114 * reply with the major version it supports, ignore the rest of the 115 * INIT message and expect a new INIT message from the kernel with a 116 * matching major version. 117 * 118 * If the library supports a larger major version, then it shall fall 119 * back to the major protocol version sent by the kernel for 120 * communication and reply with that major version (and an arbitrary 121 * supported minor version). 122 */ 123 124 /** Version number of this interface */ 125 #define FUSE_KERNEL_VERSION 7 126 127 /** Minor version number of this interface */ 128 #define FUSE_KERNEL_MINOR_VERSION 21 129 130 /** The node ID of the root inode */ 131 #define FUSE_ROOT_ID 1 132 133 /* Make sure all structures are padded to 64bit boundary, so 32bit 134 userspace works under 64bit kernels */ 135 136 struct fuse_attr { 137 uint64_t ino; 138 uint64_t size; 139 uint64_t blocks; 140 uint64_t atime; 141 uint64_t mtime; 142 uint64_t ctime; 143 uint32_t atimensec; 144 uint32_t mtimensec; 145 uint32_t ctimensec; 146 uint32_t mode; 147 uint32_t nlink; 148 uint32_t uid; 149 uint32_t gid; 150 uint32_t rdev; 151 uint32_t blksize; 152 uint32_t padding; 153 }; 154 155 struct fuse_kstatfs { 156 uint64_t blocks; 157 uint64_t bfree; 158 uint64_t bavail; 159 uint64_t files; 160 uint64_t ffree; 161 uint32_t bsize; 162 uint32_t namelen; 163 uint32_t frsize; 164 uint32_t padding; 165 uint32_t spare[6]; 166 }; 167 168 struct fuse_file_lock { 169 uint64_t start; 170 uint64_t end; 171 uint32_t type; 172 uint32_t pid; /* tgid */ 173 }; 174 175 /** 176 * Bitmasks for fuse_setattr_in.valid 177 */ 178 #define FATTR_MODE (1 << 0) 179 #define FATTR_UID (1 << 1) 180 #define FATTR_GID (1 << 2) 181 #define FATTR_SIZE (1 << 3) 182 #define FATTR_ATIME (1 << 4) 183 #define FATTR_MTIME (1 << 5) 184 #define FATTR_FH (1 << 6) 185 #define FATTR_ATIME_NOW (1 << 7) 186 #define FATTR_MTIME_NOW (1 << 8) 187 #define FATTR_LOCKOWNER (1 << 9) 188 189 /** 190 * Flags returned by the OPEN request 191 * 192 * FOPEN_DIRECT_IO: bypass page cache for this open file 193 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open 194 * FOPEN_NONSEEKABLE: the file is not seekable 195 */ 196 #define FOPEN_DIRECT_IO (1 << 0) 197 #define FOPEN_KEEP_CACHE (1 << 1) 198 #define FOPEN_NONSEEKABLE (1 << 2) 199 200 /** 201 * INIT request/reply flags 202 * 203 * FUSE_ASYNC_READ: asynchronous read requests 204 * FUSE_POSIX_LOCKS: remote locking for POSIX file locks 205 * FUSE_FILE_OPS: kernel sends file handle for fstat, etc... (not yet supported) 206 * FUSE_ATOMIC_O_TRUNC: handles the O_TRUNC open flag in the filesystem 207 * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".." 208 * FUSE_BIG_WRITES: filesystem can handle write size larger than 4kB 209 * FUSE_DONT_MASK: don't apply umask to file mode on create operations 210 * FUSE_SPLICE_WRITE: kernel supports splice write on the device 211 * FUSE_SPLICE_MOVE: kernel supports splice move on the device 212 * FUSE_SPLICE_READ: kernel supports splice read on the device 213 * FUSE_FLOCK_LOCKS: remote locking for BSD style file locks 214 * FUSE_HAS_IOCTL_DIR: kernel supports ioctl on directories 215 * FUSE_AUTO_INVAL_DATA: automatically invalidate cached pages 216 * FUSE_DO_READDIRPLUS: do READDIRPLUS (READDIR+LOOKUP in one) 217 * FUSE_READDIRPLUS_AUTO: adaptive readdirplus 218 */ 219 #define FUSE_ASYNC_READ (1 << 0) 220 #define FUSE_POSIX_LOCKS (1 << 1) 221 #define FUSE_FILE_OPS (1 << 2) 222 #define FUSE_ATOMIC_O_TRUNC (1 << 3) 223 #define FUSE_EXPORT_SUPPORT (1 << 4) 224 #define FUSE_BIG_WRITES (1 << 5) 225 #define FUSE_DONT_MASK (1 << 6) 226 #define FUSE_SPLICE_WRITE (1 << 7) 227 #define FUSE_SPLICE_MOVE (1 << 8) 228 #define FUSE_SPLICE_READ (1 << 9) 229 #define FUSE_FLOCK_LOCKS (1 << 10) 230 #define FUSE_HAS_IOCTL_DIR (1 << 11) 231 #define FUSE_AUTO_INVAL_DATA (1 << 12) 232 #define FUSE_DO_READDIRPLUS (1 << 13) 233 #define FUSE_READDIRPLUS_AUTO (1 << 14) 234 235 /** 236 * CUSE INIT request/reply flags 237 * 238 * CUSE_UNRESTRICTED_IOCTL: use unrestricted ioctl 239 */ 240 #define CUSE_UNRESTRICTED_IOCTL (1 << 0) 241 242 /** 243 * Release flags 244 */ 245 #define FUSE_RELEASE_FLUSH (1 << 0) 246 #define FUSE_RELEASE_FLOCK_UNLOCK (1 << 1) 247 248 /** 249 * Getattr flags 250 */ 251 #define FUSE_GETATTR_FH (1 << 0) 252 253 /** 254 * Lock flags 255 */ 256 #define FUSE_LK_FLOCK (1 << 0) 257 258 /** 259 * WRITE flags 260 * 261 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed 262 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid 263 */ 264 #define FUSE_WRITE_CACHE (1 << 0) 265 #define FUSE_WRITE_LOCKOWNER (1 << 1) 266 267 /** 268 * Read flags 269 */ 270 #define FUSE_READ_LOCKOWNER (1 << 1) 271 272 /** 273 * Ioctl flags 274 * 275 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine 276 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed 277 * FUSE_IOCTL_RETRY: retry with new iovecs 278 * FUSE_IOCTL_32BIT: 32bit ioctl 279 * FUSE_IOCTL_DIR: is a directory 280 * 281 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs 282 */ 283 #define FUSE_IOCTL_COMPAT (1 << 0) 284 #define FUSE_IOCTL_UNRESTRICTED (1 << 1) 285 #define FUSE_IOCTL_RETRY (1 << 2) 286 #define FUSE_IOCTL_32BIT (1 << 3) 287 #define FUSE_IOCTL_DIR (1 << 4) 288 289 #define FUSE_IOCTL_MAX_IOV 256 290 291 /** 292 * Poll flags 293 * 294 * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify 295 */ 296 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0) 297 298 enum fuse_opcode { 299 FUSE_LOOKUP = 1, 300 FUSE_FORGET = 2, /* no reply */ 301 FUSE_GETATTR = 3, 302 FUSE_SETATTR = 4, 303 FUSE_READLINK = 5, 304 FUSE_SYMLINK = 6, 305 FUSE_MKNOD = 8, 306 FUSE_MKDIR = 9, 307 FUSE_UNLINK = 10, 308 FUSE_RMDIR = 11, 309 FUSE_RENAME = 12, 310 FUSE_LINK = 13, 311 FUSE_OPEN = 14, 312 FUSE_READ = 15, 313 FUSE_WRITE = 16, 314 FUSE_STATFS = 17, 315 FUSE_RELEASE = 18, 316 FUSE_FSYNC = 20, 317 FUSE_SETXATTR = 21, 318 FUSE_GETXATTR = 22, 319 FUSE_LISTXATTR = 23, 320 FUSE_REMOVEXATTR = 24, 321 FUSE_FLUSH = 25, 322 FUSE_INIT = 26, 323 FUSE_OPENDIR = 27, 324 FUSE_READDIR = 28, 325 FUSE_RELEASEDIR = 29, 326 FUSE_FSYNCDIR = 30, 327 FUSE_GETLK = 31, 328 FUSE_SETLK = 32, 329 FUSE_SETLKW = 33, 330 FUSE_ACCESS = 34, 331 FUSE_CREATE = 35, 332 FUSE_INTERRUPT = 36, 333 FUSE_BMAP = 37, 334 FUSE_DESTROY = 38, 335 FUSE_IOCTL = 39, 336 FUSE_POLL = 40, 337 FUSE_NOTIFY_REPLY = 41, 338 FUSE_BATCH_FORGET = 42, 339 FUSE_FALLOCATE = 43, 340 FUSE_READDIRPLUS = 44, 341 342 /* CUSE specific operations */ 343 CUSE_INIT = 4096, 344 }; 345 346 enum fuse_notify_code { 347 FUSE_NOTIFY_POLL = 1, 348 FUSE_NOTIFY_INVAL_INODE = 2, 349 FUSE_NOTIFY_INVAL_ENTRY = 3, 350 FUSE_NOTIFY_STORE = 4, 351 FUSE_NOTIFY_RETRIEVE = 5, 352 FUSE_NOTIFY_DELETE = 6, 353 FUSE_NOTIFY_CODE_MAX, 354 }; 355 356 /* The read buffer is required to be at least 8k, but may be much larger */ 357 #define FUSE_MIN_READ_BUFFER 8192 358 359 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120 360 361 struct fuse_entry_out { 362 uint64_t nodeid; /* Inode ID */ 363 uint64_t generation; /* Inode generation: nodeid:gen must 364 be unique for the fs's lifetime */ 365 uint64_t entry_valid; /* Cache timeout for the name */ 366 uint64_t attr_valid; /* Cache timeout for the attributes */ 367 uint32_t entry_valid_nsec; 368 uint32_t attr_valid_nsec; 369 struct fuse_attr attr; 370 }; 371 372 struct fuse_forget_in { 373 uint64_t nlookup; 374 }; 375 376 struct fuse_forget_one { 377 uint64_t nodeid; 378 uint64_t nlookup; 379 }; 380 381 struct fuse_batch_forget_in { 382 uint32_t count; 383 uint32_t dummy; 384 }; 385 386 struct fuse_getattr_in { 387 uint32_t getattr_flags; 388 uint32_t dummy; 389 uint64_t fh; 390 }; 391 392 #define FUSE_COMPAT_ATTR_OUT_SIZE 96 393 394 struct fuse_attr_out { 395 uint64_t attr_valid; /* Cache timeout for the attributes */ 396 uint32_t attr_valid_nsec; 397 uint32_t dummy; 398 struct fuse_attr attr; 399 }; 400 401 #define FUSE_COMPAT_MKNOD_IN_SIZE 8 402 403 struct fuse_mknod_in { 404 uint32_t mode; 405 uint32_t rdev; 406 uint32_t umask; 407 uint32_t padding; 408 }; 409 410 struct fuse_mkdir_in { 411 uint32_t mode; 412 uint32_t umask; 413 }; 414 415 struct fuse_rename_in { 416 uint64_t newdir; 417 }; 418 419 struct fuse_link_in { 420 uint64_t oldnodeid; 421 }; 422 423 struct fuse_setattr_in { 424 uint32_t valid; 425 uint32_t padding; 426 uint64_t fh; 427 uint64_t size; 428 uint64_t lock_owner; 429 uint64_t atime; 430 uint64_t mtime; 431 uint64_t unused2; 432 uint32_t atimensec; 433 uint32_t mtimensec; 434 uint32_t unused3; 435 uint32_t mode; 436 uint32_t unused4; 437 uint32_t uid; 438 uint32_t gid; 439 uint32_t unused5; 440 }; 441 442 struct fuse_open_in { 443 uint32_t flags; 444 uint32_t unused; 445 }; 446 447 struct fuse_create_in { 448 uint32_t flags; 449 uint32_t mode; 450 uint32_t umask; 451 uint32_t padding; 452 }; 453 454 struct fuse_open_out { 455 uint64_t fh; 456 uint32_t open_flags; 457 uint32_t padding; 458 }; 459 460 struct fuse_release_in { 461 uint64_t fh; 462 uint32_t flags; 463 uint32_t release_flags; 464 uint64_t lock_owner; 465 }; 466 467 struct fuse_flush_in { 468 uint64_t fh; 469 uint32_t unused; 470 uint32_t padding; 471 uint64_t lock_owner; 472 }; 473 474 struct fuse_read_in { 475 uint64_t fh; 476 uint64_t offset; 477 uint32_t size; 478 uint32_t read_flags; 479 uint64_t lock_owner; 480 uint32_t flags; 481 uint32_t padding; 482 }; 483 484 #define FUSE_COMPAT_WRITE_IN_SIZE 24 485 486 struct fuse_write_in { 487 uint64_t fh; 488 uint64_t offset; 489 uint32_t size; 490 uint32_t write_flags; 491 uint64_t lock_owner; 492 uint32_t flags; 493 uint32_t padding; 494 }; 495 496 struct fuse_write_out { 497 uint32_t size; 498 uint32_t padding; 499 }; 500 501 #define FUSE_COMPAT_STATFS_SIZE 48 502 503 struct fuse_statfs_out { 504 struct fuse_kstatfs st; 505 }; 506 507 struct fuse_fsync_in { 508 uint64_t fh; 509 uint32_t fsync_flags; 510 uint32_t padding; 511 }; 512 513 struct fuse_setxattr_in { 514 uint32_t size; 515 uint32_t flags; 516 }; 517 518 struct fuse_getxattr_in { 519 uint32_t size; 520 uint32_t padding; 521 }; 522 523 struct fuse_getxattr_out { 524 uint32_t size; 525 uint32_t padding; 526 }; 527 528 struct fuse_lk_in { 529 uint64_t fh; 530 uint64_t owner; 531 struct fuse_file_lock lk; 532 uint32_t lk_flags; 533 uint32_t padding; 534 }; 535 536 struct fuse_lk_out { 537 struct fuse_file_lock lk; 538 }; 539 540 struct fuse_access_in { 541 uint32_t mask; 542 uint32_t padding; 543 }; 544 545 struct fuse_init_in { 546 uint32_t major; 547 uint32_t minor; 548 uint32_t max_readahead; 549 uint32_t flags; 550 }; 551 552 struct fuse_init_out { 553 uint32_t major; 554 uint32_t minor; 555 uint32_t max_readahead; 556 uint32_t flags; 557 uint16_t max_background; 558 uint16_t congestion_threshold; 559 uint32_t max_write; 560 }; 561 562 #define CUSE_INIT_INFO_MAX 4096 563 564 struct cuse_init_in { 565 uint32_t major; 566 uint32_t minor; 567 uint32_t unused; 568 uint32_t flags; 569 }; 570 571 struct cuse_init_out { 572 uint32_t major; 573 uint32_t minor; 574 uint32_t unused; 575 uint32_t flags; 576 uint32_t max_read; 577 uint32_t max_write; 578 uint32_t dev_major; /* chardev major */ 579 uint32_t dev_minor; /* chardev minor */ 580 uint32_t spare[10]; 581 }; 582 583 struct fuse_interrupt_in { 584 uint64_t unique; 585 }; 586 587 struct fuse_bmap_in { 588 uint64_t block; 589 uint32_t blocksize; 590 uint32_t padding; 591 }; 592 593 struct fuse_bmap_out { 594 uint64_t block; 595 }; 596 597 struct fuse_ioctl_in { 598 uint64_t fh; 599 uint32_t flags; 600 uint32_t cmd; 601 uint64_t arg; 602 uint32_t in_size; 603 uint32_t out_size; 604 }; 605 606 struct fuse_ioctl_iovec { 607 uint64_t base; 608 uint64_t len; 609 }; 610 611 struct fuse_ioctl_out { 612 int32_t result; 613 uint32_t flags; 614 uint32_t in_iovs; 615 uint32_t out_iovs; 616 }; 617 618 struct fuse_poll_in { 619 uint64_t fh; 620 uint64_t kh; 621 uint32_t flags; 622 uint32_t events; 623 }; 624 625 struct fuse_poll_out { 626 uint32_t revents; 627 uint32_t padding; 628 }; 629 630 struct fuse_notify_poll_wakeup_out { 631 uint64_t kh; 632 }; 633 634 struct fuse_fallocate_in { 635 uint64_t fh; 636 uint64_t offset; 637 uint64_t length; 638 uint32_t mode; 639 uint32_t padding; 640 }; 641 642 struct fuse_in_header { 643 uint32_t len; 644 uint32_t opcode; 645 uint64_t unique; 646 uint64_t nodeid; 647 uint32_t uid; 648 uint32_t gid; 649 uint32_t pid; 650 uint32_t padding; 651 }; 652 653 struct fuse_out_header { 654 uint32_t len; 655 int32_t error; 656 uint64_t unique; 657 }; 658 659 struct fuse_dirent { 660 uint64_t ino; 661 uint64_t off; 662 uint32_t namelen; 663 uint32_t type; 664 char name[]; 665 }; 666 667 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name) 668 #define FUSE_DIRENT_ALIGN(x) \ 669 (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1)) 670 #define FUSE_DIRENT_SIZE(d) \ 671 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen) 672 673 struct fuse_direntplus { 674 struct fuse_entry_out entry_out; 675 struct fuse_dirent dirent; 676 }; 677 678 #define FUSE_NAME_OFFSET_DIRENTPLUS \ 679 offsetof(struct fuse_direntplus, dirent.name) 680 #define FUSE_DIRENTPLUS_SIZE(d) \ 681 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET_DIRENTPLUS + (d)->dirent.namelen) 682 683 struct fuse_notify_inval_inode_out { 684 uint64_t ino; 685 int64_t off; 686 int64_t len; 687 }; 688 689 struct fuse_notify_inval_entry_out { 690 uint64_t parent; 691 uint32_t namelen; 692 uint32_t padding; 693 }; 694 695 struct fuse_notify_delete_out { 696 uint64_t parent; 697 uint64_t child; 698 uint32_t namelen; 699 uint32_t padding; 700 }; 701 702 struct fuse_notify_store_out { 703 uint64_t nodeid; 704 uint64_t offset; 705 uint32_t size; 706 uint32_t padding; 707 }; 708 709 struct fuse_notify_retrieve_out { 710 uint64_t notify_unique; 711 uint64_t nodeid; 712 uint64_t offset; 713 uint32_t size; 714 uint32_t padding; 715 }; 716 717 /* Matches the size of fuse_write_in */ 718 struct fuse_notify_retrieve_in { 719 uint64_t dummy1; 720 uint64_t offset; 721 uint32_t size; 722 uint32_t dummy2; 723 uint64_t dummy3; 724 uint64_t dummy4; 725 }; 726 727 #endif /* _LINUX_FUSE_H */ 728