sys/fs/fuse/fuse_kernel.h

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