include/linux/fuse.h

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