include/linux/fuse.h

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