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