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 /* This file defines the kernel interface of FUSE */
  10
  11 #include <asm/types.h>
  12 #include <linux/major.h>
  13
  14 /** Version number of this interface */
  15 #define FUSE_KERNEL_VERSION 7
  16
  17 /** Minor version number of this interface */
  18 #define FUSE_KERNEL_MINOR_VERSION 8
  19
  20 /** The node ID of the root inode */
  21 #define FUSE_ROOT_ID 1
  22
  23 /** The major number of the fuse character device */
  24 #define FUSE_MAJOR MISC_MAJOR
  25
  26 /** The minor number of the fuse character device */
  27 #define FUSE_MINOR 229
  28
  29 /* Make sure all structures are padded to 64bit boundary, so 32bit
  30    userspace works under 64bit kernels */
  31
  32 struct fuse_attr {
  33         __u64   ino;
  34         __u64   size;
  35         __u64   blocks;
  36         __u64   atime;
  37         __u64   mtime;
  38         __u64   ctime;
  39         __u32   atimensec;
  40         __u32   mtimensec;
  41         __u32   ctimensec;
  42         __u32   mode;
  43         __u32   nlink;
  44         __u32   uid;
  45         __u32   gid;
  46         __u32   rdev;
  47 };
  48
  49 struct fuse_kstatfs {
  50         __u64   blocks;
  51         __u64   bfree;
  52         __u64   bavail;
  53         __u64   files;
  54         __u64   ffree;
  55         __u32   bsize;
  56         __u32   namelen;
  57         __u32   frsize;
  58         __u32   padding;
  59         __u32   spare[6];
  60 };
  61
  62 struct fuse_file_lock {
  63         __u64   start;
  64         __u64   end;
  65         __u32   type;
  66         __u32   pid; /* tgid */
  67 };
  68
  69 /**
  70  * Bitmasks for fuse_setattr_in.valid
  71  */
  72 #define FATTR_MODE      (1 << 0)
  73 #define FATTR_UID       (1 << 1)
  74 #define FATTR_GID       (1 << 2)
  75 #define FATTR_SIZE      (1 << 3)
  76 #define FATTR_ATIME     (1 << 4)
  77 #define FATTR_MTIME     (1 << 5)
  78 #define FATTR_FH        (1 << 6)
  79
  80 /**
  81  * Flags returned by the OPEN request
  82  *
  83  * FOPEN_DIRECT_IO: bypass page cache for this open file
  84  * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
  85  */
  86 #define FOPEN_DIRECT_IO         (1 << 0)
  87 #define FOPEN_KEEP_CACHE        (1 << 1)
  88
  89 /**
  90  * INIT request/reply flags
  91  */
  92 #define FUSE_ASYNC_READ         (1 << 0)
  93 #define FUSE_POSIX_LOCKS        (1 << 1)
  94
  95 /**
  96  * Release flags
  97  */
  98 #define FUSE_RELEASE_FLUSH      (1 << 0)
  99
 100 enum fuse_opcode {
 101         FUSE_LOOKUP        = 1,
 102         FUSE_FORGET        = 2,  /* no reply */
 103         FUSE_GETATTR       = 3,
 104         FUSE_SETATTR       = 4,
 105         FUSE_READLINK      = 5,
 106         FUSE_SYMLINK       = 6,
 107         FUSE_MKNOD         = 8,
 108         FUSE_MKDIR         = 9,
 109         FUSE_UNLINK        = 10,
 110         FUSE_RMDIR         = 11,
 111         FUSE_RENAME        = 12,
 112         FUSE_LINK          = 13,
 113         FUSE_OPEN          = 14,
 114         FUSE_READ          = 15,
 115         FUSE_WRITE         = 16,
 116         FUSE_STATFS        = 17,
 117         FUSE_RELEASE       = 18,
 118         FUSE_FSYNC         = 20,
 119         FUSE_SETXATTR      = 21,
 120         FUSE_GETXATTR      = 22,
 121         FUSE_LISTXATTR     = 23,
 122         FUSE_REMOVEXATTR   = 24,
 123         FUSE_FLUSH         = 25,
 124         FUSE_INIT          = 26,
 125         FUSE_OPENDIR       = 27,
 126         FUSE_READDIR       = 28,
 127         FUSE_RELEASEDIR    = 29,
 128         FUSE_FSYNCDIR      = 30,
 129         FUSE_GETLK         = 31,
 130         FUSE_SETLK         = 32,
 131         FUSE_SETLKW        = 33,
 132         FUSE_ACCESS        = 34,
 133         FUSE_CREATE        = 35,
 134         FUSE_INTERRUPT     = 36,
 135 };
 136
 137 /* The read buffer is required to be at least 8k, but may be much larger */
 138 #define FUSE_MIN_READ_BUFFER 8192
 139
 140 struct fuse_entry_out {
 141         __u64   nodeid;         /* Inode ID */
 142         __u64   generation;     /* Inode generation: nodeid:gen must
 143                                    be unique for the fs's lifetime */
 144         __u64   entry_valid;    /* Cache timeout for the name */
 145         __u64   attr_valid;     /* Cache timeout for the attributes */
 146         __u32   entry_valid_nsec;
 147         __u32   attr_valid_nsec;
 148         struct fuse_attr attr;
 149 };
 150
 151 struct fuse_forget_in {
 152         __u64   nlookup;
 153 };
 154
 155 struct fuse_attr_out {
 156         __u64   attr_valid;     /* Cache timeout for the attributes */
 157         __u32   attr_valid_nsec;
 158         __u32   dummy;
 159         struct fuse_attr attr;
 160 };
 161
 162 struct fuse_mknod_in {
 163         __u32   mode;
 164         __u32   rdev;
 165 };
 166
 167 struct fuse_mkdir_in {
 168         __u32   mode;
 169         __u32   padding;
 170 };
 171
 172 struct fuse_rename_in {
 173         __u64   newdir;
 174 };
 175
 176 struct fuse_link_in {
 177         __u64   oldnodeid;
 178 };
 179
 180 struct fuse_setattr_in {
 181         __u32   valid;
 182         __u32   padding;
 183         __u64   fh;
 184         __u64   size;
 185         __u64   unused1;
 186         __u64   atime;
 187         __u64   mtime;
 188         __u64   unused2;
 189         __u32   atimensec;
 190         __u32   mtimensec;
 191         __u32   unused3;
 192         __u32   mode;
 193         __u32   unused4;
 194         __u32   uid;
 195         __u32   gid;
 196         __u32   unused5;
 197 };
 198
 199 struct fuse_open_in {
 200         __u32   flags;
 201         __u32   mode;
 202 };
 203
 204 struct fuse_open_out {
 205         __u64   fh;
 206         __u32   open_flags;
 207         __u32   padding;
 208 };
 209
 210 struct fuse_release_in {
 211         __u64   fh;
 212         __u32   flags;
 213         __u32   release_flags;
 214         __u64   lock_owner;
 215 };
 216
 217 struct fuse_flush_in {
 218         __u64   fh;
 219         __u32   unused;
 220         __u32   padding;
 221         __u64   lock_owner;
 222 };
 223
 224 struct fuse_read_in {
 225         __u64   fh;
 226         __u64   offset;
 227         __u32   size;
 228         __u32   padding;
 229 };
 230
 231 struct fuse_write_in {
 232         __u64   fh;
 233         __u64   offset;
 234         __u32   size;
 235         __u32   write_flags;
 236 };
 237
 238 struct fuse_write_out {
 239         __u32   size;
 240         __u32   padding;
 241 };
 242
 243 #define FUSE_COMPAT_STATFS_SIZE 48
 244
 245 struct fuse_statfs_out {
 246         struct fuse_kstatfs st;
 247 };
 248
 249 struct fuse_fsync_in {
 250         __u64   fh;
 251         __u32   fsync_flags;
 252         __u32   padding;
 253 };
 254
 255 struct fuse_setxattr_in {
 256         __u32   size;
 257         __u32   flags;
 258 };
 259
 260 struct fuse_getxattr_in {
 261         __u32   size;
 262         __u32   padding;
 263 };
 264
 265 struct fuse_getxattr_out {
 266         __u32   size;
 267         __u32   padding;
 268 };
 269
 270 struct fuse_lk_in {
 271         __u64   fh;
 272         __u64   owner;
 273         struct fuse_file_lock lk;
 274 };
 275
 276 struct fuse_lk_out {
 277         struct fuse_file_lock lk;
 278 };
 279
 280 struct fuse_access_in {
 281         __u32   mask;
 282         __u32   padding;
 283 };
 284
 285 struct fuse_init_in {
 286         __u32   major;
 287         __u32   minor;
 288         __u32   max_readahead;
 289         __u32   flags;
 290 };
 291
 292 struct fuse_init_out {
 293         __u32   major;
 294         __u32   minor;
 295         __u32   max_readahead;
 296         __u32   flags;
 297         __u32   unused;
 298         __u32   max_write;
 299 };
 300
 301 struct fuse_interrupt_in {
 302         __u64   unique;
 303 };
 304
 305 struct fuse_in_header {
 306         __u32   len;
 307         __u32   opcode;
 308         __u64   unique;
 309         __u64   nodeid;
 310         __u32   uid;
 311         __u32   gid;
 312         __u32   pid;
 313         __u32   padding;
 314 };
 315
 316 struct fuse_out_header {
 317         __u32   len;
 318         __s32   error;
 319         __u64   unique;
 320 };
 321
 322 struct fuse_dirent {
 323         __u64   ino;
 324         __u64   off;
 325         __u32   namelen;
 326         __u32   type;
 327         char name[0];
 328 };
 329
 330 #define FUSE_NAME_OFFSET ((unsigned) ((struct fuse_dirent *) 0)->name)
 331 #define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
 332 #define FUSE_DIRENT_SIZE(d) \
 333         FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)