include/linux/fuse.h

   1 /*
   2     FUSE: Filesystem in Userspace
   3     Copyright (C) 2001-2005  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
  13 /** Version number of this interface */
  14 #define FUSE_KERNEL_VERSION 7
  15
  16 /** Minor version number of this interface */
  17 #define FUSE_KERNEL_MINOR_VERSION 2
  18
  19 /** The node ID of the root inode */
  20 #define FUSE_ROOT_ID 1
  21
  22 /** The major number of the fuse character device */
  23 #define FUSE_MAJOR 10
  24
  25 /** The minor number of the fuse character device */
  26 #define FUSE_MINOR 229
  27
  28 /* Make sure all structures are padded to 64bit boundary, so 32bit
  29    userspace works under 64bit kernels */
  30
  31 struct fuse_attr {
  32         __u64   ino;
  33         __u64   size;
  34         __u64   blocks;
  35         __u64   atime;
  36         __u64   mtime;
  37         __u64   ctime;
  38         __u32   atimensec;
  39         __u32   mtimensec;
  40         __u32   ctimensec;
  41         __u32   mode;
  42         __u32   nlink;
  43         __u32   uid;
  44         __u32   gid;
  45         __u32   rdev;
  46 };
  47
  48 struct fuse_kstatfs {
  49         __u64   blocks;
  50         __u64   bfree;
  51         __u64   bavail;
  52         __u64   files;
  53         __u64   ffree;
  54         __u32   bsize;
  55         __u32   namelen;
  56 };
  57
  58 #define FATTR_MODE      (1 << 0)
  59 #define FATTR_UID       (1 << 1)
  60 #define FATTR_GID       (1 << 2)
  61 #define FATTR_SIZE      (1 << 3)
  62 #define FATTR_ATIME     (1 << 4)
  63 #define FATTR_MTIME     (1 << 5)
  64 #define FATTR_CTIME     (1 << 6)
  65
  66 /**
  67  * Flags returned by the OPEN request
  68  *
  69  * FOPEN_DIRECT_IO: bypass page cache for this open file
  70  * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
  71  */
  72 #define FOPEN_DIRECT_IO         (1 << 0)
  73 #define FOPEN_KEEP_CACHE        (1 << 1)
  74
  75 enum fuse_opcode {
  76         FUSE_LOOKUP        = 1,
  77         FUSE_FORGET        = 2,  /* no reply */
  78         FUSE_GETATTR       = 3,
  79         FUSE_SETATTR       = 4,
  80         FUSE_READLINK      = 5,
  81         FUSE_SYMLINK       = 6,
  82         FUSE_MKNOD         = 8,
  83         FUSE_MKDIR         = 9,
  84         FUSE_UNLINK        = 10,
  85         FUSE_RMDIR         = 11,
  86         FUSE_RENAME        = 12,
  87         FUSE_LINK          = 13,
  88         FUSE_OPEN          = 14,
  89         FUSE_READ          = 15,
  90         FUSE_WRITE         = 16,
  91         FUSE_STATFS        = 17,
  92         FUSE_RELEASE       = 18,
  93         FUSE_FSYNC         = 20,
  94         FUSE_SETXATTR      = 21,
  95         FUSE_GETXATTR      = 22,
  96         FUSE_LISTXATTR     = 23,
  97         FUSE_REMOVEXATTR   = 24,
  98         FUSE_FLUSH         = 25,
  99         FUSE_INIT          = 26,
 100         FUSE_OPENDIR       = 27,
 101         FUSE_READDIR       = 28,
 102         FUSE_RELEASEDIR    = 29
 103 };
 104
 105 /* Conservative buffer size for the client */
 106 #define FUSE_MAX_IN 8192
 107
 108 #define FUSE_NAME_MAX 1024
 109 #define FUSE_SYMLINK_MAX 4096
 110 #define FUSE_XATTR_SIZE_MAX 4096
 111
 112 struct fuse_entry_out {
 113         __u64   nodeid;         /* Inode ID */
 114         __u64   generation;     /* Inode generation: nodeid:gen must
 115                                    be unique for the fs's lifetime */
 116         __u64   entry_valid;    /* Cache timeout for the name */
 117         __u64   attr_valid;     /* Cache timeout for the attributes */
 118         __u32   entry_valid_nsec;
 119         __u32   attr_valid_nsec;
 120         struct fuse_attr attr;
 121 };
 122
 123 struct fuse_forget_in {
 124         __u64   nlookup;
 125 };
 126
 127 struct fuse_attr_out {
 128         __u64   attr_valid;     /* Cache timeout for the attributes */
 129         __u32   attr_valid_nsec;
 130         __u32   dummy;
 131         struct fuse_attr attr;
 132 };
 133
 134 struct fuse_mknod_in {
 135         __u32   mode;
 136         __u32   rdev;
 137 };
 138
 139 struct fuse_mkdir_in {
 140         __u32   mode;
 141         __u32   padding;
 142 };
 143
 144 struct fuse_rename_in {
 145         __u64   newdir;
 146 };
 147
 148 struct fuse_link_in {
 149         __u64   oldnodeid;
 150 };
 151
 152 struct fuse_setattr_in {
 153         __u32   valid;
 154         __u32   padding;
 155         struct fuse_attr attr;
 156 };
 157
 158 struct fuse_open_in {
 159         __u32   flags;
 160         __u32   padding;
 161 };
 162
 163 struct fuse_open_out {
 164         __u64   fh;
 165         __u32   open_flags;
 166         __u32   padding;
 167 };
 168
 169 struct fuse_release_in {
 170         __u64   fh;
 171         __u32   flags;
 172         __u32   padding;
 173 };
 174
 175 struct fuse_flush_in {
 176         __u64   fh;
 177         __u32   flush_flags;
 178         __u32   padding;
 179 };
 180
 181 struct fuse_read_in {
 182         __u64   fh;
 183         __u64   offset;
 184         __u32   size;
 185         __u32   padding;
 186 };
 187
 188 struct fuse_write_in {
 189         __u64   fh;
 190         __u64   offset;
 191         __u32   size;
 192         __u32   write_flags;
 193 };
 194
 195 struct fuse_write_out {
 196         __u32   size;
 197         __u32   padding;
 198 };
 199
 200 struct fuse_statfs_out {
 201         struct fuse_kstatfs st;
 202 };
 203
 204 struct fuse_fsync_in {
 205         __u64   fh;
 206         __u32   fsync_flags;
 207         __u32   padding;
 208 };
 209
 210 struct fuse_setxattr_in {
 211         __u32   size;
 212         __u32   flags;
 213 };
 214
 215 struct fuse_getxattr_in {
 216         __u32   size;
 217         __u32   padding;
 218 };
 219
 220 struct fuse_getxattr_out {
 221         __u32   size;
 222         __u32   padding;
 223 };
 224
 225 struct fuse_init_in_out {
 226         __u32   major;
 227         __u32   minor;
 228 };
 229
 230 struct fuse_in_header {
 231         __u32   len;
 232         __u32   opcode;
 233         __u64   unique;
 234         __u64   nodeid;
 235         __u32   uid;
 236         __u32   gid;
 237         __u32   pid;
 238         __u32   padding;
 239 };
 240
 241 struct fuse_out_header {
 242         __u32   len;
 243         __s32   error;
 244         __u64   unique;
 245 };
 246
 247 struct fuse_dirent {
 248         __u64   ino;
 249         __u64   off;
 250         __u32   namelen;
 251         __u32   type;
 252         char name[0];
 253 };
 254
 255 #define FUSE_NAME_OFFSET ((unsigned) ((struct fuse_dirent *) 0)->name)
 256 #define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
 257 #define FUSE_DIRENT_SIZE(d) \
 258         FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)