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