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