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