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