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