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 enum fuse_opcode {
 152         FUSE_LOOKUP        = 1,
 153         FUSE_FORGET        = 2,  /* no reply */
 154         FUSE_GETATTR       = 3,
 155         FUSE_SETATTR       = 4,
 156         FUSE_READLINK      = 5,
 157         FUSE_SYMLINK       = 6,
 158         FUSE_MKNOD         = 8,
 159         FUSE_MKDIR         = 9,
 160         FUSE_UNLINK        = 10,
 161         FUSE_RMDIR         = 11,
 162         FUSE_RENAME        = 12,
 163         FUSE_LINK          = 13,
 164         FUSE_OPEN          = 14,
 165         FUSE_READ          = 15,
 166         FUSE_WRITE         = 16,
 167         FUSE_STATFS        = 17,
 168         FUSE_RELEASE       = 18,
 169         FUSE_FSYNC         = 20,
 170         FUSE_SETXATTR      = 21,
 171         FUSE_GETXATTR      = 22,
 172         FUSE_LISTXATTR     = 23,
 173         FUSE_REMOVEXATTR   = 24,
 174         FUSE_FLUSH         = 25,
 175         FUSE_INIT          = 26,
 176         FUSE_OPENDIR       = 27,
 177         FUSE_READDIR       = 28,
 178         FUSE_RELEASEDIR    = 29,
 179         FUSE_FSYNCDIR      = 30,
 180         FUSE_GETLK         = 31,
 181         FUSE_SETLK         = 32,
 182         FUSE_SETLKW        = 33,
 183         FUSE_ACCESS        = 34,
 184         FUSE_CREATE        = 35,
 185         FUSE_INTERRUPT     = 36,
 186         FUSE_BMAP          = 37,
 187         FUSE_DESTROY       = 38,
 188 };
 189
 190 /* The read buffer is required to be at least 8k, but may be much larger */
 191 #define FUSE_MIN_READ_BUFFER 8192
 192
 193 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
 194
 195 struct fuse_entry_out {
 196         __u64   nodeid;         /* Inode ID */
 197         __u64   generation;     /* Inode generation: nodeid:gen must
 198                                    be unique for the fs's lifetime */
 199         __u64   entry_valid;    /* Cache timeout for the name */
 200         __u64   attr_valid;     /* Cache timeout for the attributes */
 201         __u32   entry_valid_nsec;
 202         __u32   attr_valid_nsec;
 203         struct fuse_attr attr;
 204 };
 205
 206 struct fuse_forget_in {
 207         __u64   nlookup;
 208 };
 209
 210 struct fuse_getattr_in {
 211         __u32   getattr_flags;
 212         __u32   dummy;
 213         __u64   fh;
 214 };
 215
 216 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
 217
 218 struct fuse_attr_out {
 219         __u64   attr_valid;     /* Cache timeout for the attributes */
 220         __u32   attr_valid_nsec;
 221         __u32   dummy;
 222         struct fuse_attr attr;
 223 };
 224
 225 struct fuse_mknod_in {
 226         __u32   mode;
 227         __u32   rdev;
 228 };
 229
 230 struct fuse_mkdir_in {
 231         __u32   mode;
 232         __u32   padding;
 233 };
 234
 235 struct fuse_rename_in {
 236         __u64   newdir;
 237 };
 238
 239 struct fuse_link_in {
 240         __u64   oldnodeid;
 241 };
 242
 243 struct fuse_setattr_in {
 244         __u32   valid;
 245         __u32   padding;
 246         __u64   fh;
 247         __u64   size;
 248         __u64   lock_owner;
 249         __u64   atime;
 250         __u64   mtime;
 251         __u64   unused2;
 252         __u32   atimensec;
 253         __u32   mtimensec;
 254         __u32   unused3;
 255         __u32   mode;
 256         __u32   unused4;
 257         __u32   uid;
 258         __u32   gid;
 259         __u32   unused5;
 260 };
 261
 262 struct fuse_open_in {
 263         __u32   flags;
 264         __u32   mode;
 265 };
 266
 267 struct fuse_open_out {
 268         __u64   fh;
 269         __u32   open_flags;
 270         __u32   padding;
 271 };
 272
 273 struct fuse_release_in {
 274         __u64   fh;
 275         __u32   flags;
 276         __u32   release_flags;
 277         __u64   lock_owner;
 278 };
 279
 280 struct fuse_flush_in {
 281         __u64   fh;
 282         __u32   unused;
 283         __u32   padding;
 284         __u64   lock_owner;
 285 };
 286
 287 struct fuse_read_in {
 288         __u64   fh;
 289         __u64   offset;
 290         __u32   size;
 291         __u32   read_flags;
 292         __u64   lock_owner;
 293         __u32   flags;
 294         __u32   padding;
 295 };
 296
 297 #define FUSE_COMPAT_WRITE_IN_SIZE 24
 298
 299 struct fuse_write_in {
 300         __u64   fh;
 301         __u64   offset;
 302         __u32   size;
 303         __u32   write_flags;
 304         __u64   lock_owner;
 305         __u32   flags;
 306         __u32   padding;
 307 };
 308
 309 struct fuse_write_out {
 310         __u32   size;
 311         __u32   padding;
 312 };
 313
 314 #define FUSE_COMPAT_STATFS_SIZE 48
 315
 316 struct fuse_statfs_out {
 317         struct fuse_kstatfs st;
 318 };
 319
 320 struct fuse_fsync_in {
 321         __u64   fh;
 322         __u32   fsync_flags;
 323         __u32   padding;
 324 };
 325
 326 struct fuse_setxattr_in {
 327         __u32   size;
 328         __u32   flags;
 329 };
 330
 331 struct fuse_getxattr_in {
 332         __u32   size;
 333         __u32   padding;
 334 };
 335
 336 struct fuse_getxattr_out {
 337         __u32   size;
 338         __u32   padding;
 339 };
 340
 341 struct fuse_lk_in {
 342         __u64   fh;
 343         __u64   owner;
 344         struct fuse_file_lock lk;
 345         __u32   lk_flags;
 346         __u32   padding;
 347 };
 348
 349 struct fuse_lk_out {
 350         struct fuse_file_lock lk;
 351 };
 352
 353 struct fuse_access_in {
 354         __u32   mask;
 355         __u32   padding;
 356 };
 357
 358 struct fuse_init_in {
 359         __u32   major;
 360         __u32   minor;
 361         __u32   max_readahead;
 362         __u32   flags;
 363 };
 364
 365 struct fuse_init_out {
 366         __u32   major;
 367         __u32   minor;
 368         __u32   max_readahead;
 369         __u32   flags;
 370         __u32   unused;
 371         __u32   max_write;
 372 };
 373
 374 struct fuse_interrupt_in {
 375         __u64   unique;
 376 };
 377
 378 struct fuse_bmap_in {
 379         __u64   block;
 380         __u32   blocksize;
 381         __u32   padding;
 382 };
 383
 384 struct fuse_bmap_out {
 385         __u64   block;
 386 };
 387
 388 struct fuse_in_header {
 389         __u32   len;
 390         __u32   opcode;
 391         __u64   unique;
 392         __u64   nodeid;
 393         __u32   uid;
 394         __u32   gid;
 395         __u32   pid;
 396         __u32   padding;
 397 };
 398
 399 struct fuse_out_header {
 400         __u32   len;
 401         __s32   error;
 402         __u64   unique;
 403 };
 404
 405 struct fuse_dirent {
 406         __u64   ino;
 407         __u64   off;
 408         __u32   namelen;
 409         __u32   type;
 410         char name[0];
 411 };
 412
 413 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
 414 #define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
 415 #define FUSE_DIRENT_SIZE(d) \
 416         FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
 417
 418 #endif /* _LINUX_FUSE_H */