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 1
  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 enum fuse_opcode {
  67         FUSE_LOOKUP        = 1,
  68         FUSE_FORGET        = 2,  /* no reply */
  69         FUSE_GETATTR       = 3,
  70         FUSE_SETATTR       = 4,
  71         FUSE_READLINK      = 5,
  72         FUSE_SYMLINK       = 6,
  73         FUSE_GETDIR        = 7,
  74         FUSE_MKNOD         = 8,
  75         FUSE_MKDIR         = 9,
  76         FUSE_UNLINK        = 10,
  77         FUSE_RMDIR         = 11,
  78         FUSE_RENAME        = 12,
  79         FUSE_LINK          = 13,
  80         FUSE_OPEN          = 14,
  81         FUSE_READ          = 15,
  82         FUSE_WRITE         = 16,
  83         FUSE_STATFS        = 17,
  84         FUSE_RELEASE       = 18,
  85         FUSE_FSYNC         = 20,
  86         FUSE_SETXATTR      = 21,
  87         FUSE_GETXATTR      = 22,
  88         FUSE_LISTXATTR     = 23,
  89         FUSE_REMOVEXATTR   = 24,
  90         FUSE_FLUSH         = 25,
  91         FUSE_INIT          = 26
  92 };
  93
  94 /* Conservative buffer size for the client */
  95 #define FUSE_MAX_IN 8192
  96
  97 #define FUSE_NAME_MAX 1024
  98 #define FUSE_SYMLINK_MAX 4096
  99 #define FUSE_XATTR_SIZE_MAX 4096
 100
 101 struct fuse_entry_out {
 102         __u64   nodeid;         /* Inode ID */
 103         __u64   generation;     /* Inode generation: nodeid:gen must
 104                                    be unique for the fs's lifetime */
 105         __u64   entry_valid;    /* Cache timeout for the name */
 106         __u64   attr_valid;     /* Cache timeout for the attributes */
 107         __u32   entry_valid_nsec;
 108         __u32   attr_valid_nsec;
 109         struct fuse_attr attr;
 110 };
 111
 112 struct fuse_forget_in {
 113         __u64   nlookup;
 114 };
 115
 116 struct fuse_attr_out {
 117         __u64   attr_valid;     /* Cache timeout for the attributes */
 118         __u32   attr_valid_nsec;
 119         __u32   dummy;
 120         struct fuse_attr attr;
 121 };
 122
 123 struct fuse_getdir_out {
 124         __u32   fd;
 125 };
 126
 127 struct fuse_mknod_in {
 128         __u32   mode;
 129         __u32   rdev;
 130 };
 131
 132 struct fuse_mkdir_in {
 133         __u32   mode;
 134         __u32   padding;
 135 };
 136
 137 struct fuse_rename_in {
 138         __u64   newdir;
 139 };
 140
 141 struct fuse_link_in {
 142         __u64   oldnodeid;
 143 };
 144
 145 struct fuse_setattr_in {
 146         __u32   valid;
 147         __u32   padding;
 148         struct fuse_attr attr;
 149 };
 150
 151 struct fuse_open_in {
 152         __u32   flags;
 153         __u32   padding;
 154 };
 155
 156 struct fuse_open_out {
 157         __u64   fh;
 158         __u32   open_flags;
 159         __u32   padding;
 160 };
 161
 162 struct fuse_release_in {
 163         __u64   fh;
 164         __u32   flags;
 165         __u32   padding;
 166 };
 167
 168 struct fuse_flush_in {
 169         __u64   fh;
 170         __u32   flush_flags;
 171         __u32   padding;
 172 };
 173
 174 struct fuse_read_in {
 175         __u64   fh;
 176         __u64   offset;
 177         __u32   size;
 178         __u32   padding;
 179 };
 180
 181 struct fuse_write_in {
 182         __u64   fh;
 183         __u64   offset;
 184         __u32   size;
 185         __u32   write_flags;
 186 };
 187
 188 struct fuse_write_out {
 189         __u32   size;
 190         __u32   padding;
 191 };
 192
 193 struct fuse_statfs_out {
 194         struct fuse_kstatfs st;
 195 };
 196
 197 struct fuse_fsync_in {
 198         __u64   fh;
 199         __u32   fsync_flags;
 200         __u32   padding;
 201 };
 202
 203 struct fuse_setxattr_in {
 204         __u32   size;
 205         __u32   flags;
 206 };
 207
 208 struct fuse_getxattr_in {
 209         __u32   size;
 210         __u32   padding;
 211 };
 212
 213 struct fuse_getxattr_out {
 214         __u32   size;
 215         __u32   padding;
 216 };
 217
 218 struct fuse_init_in_out {
 219         __u32   major;
 220         __u32   minor;
 221 };
 222
 223 struct fuse_in_header {
 224         __u32   len;
 225         __u32   opcode;
 226         __u64   unique;
 227         __u64   nodeid;
 228         __u32   uid;
 229         __u32   gid;
 230         __u32   pid;
 231         __u32   padding;
 232 };
 233
 234 struct fuse_out_header {
 235         __u32   len;
 236         __s32   error;
 237         __u64   unique;
 238 };
 239
 240 struct fuse_dirent {
 241         __u64   ino;
 242         __u64   off;
 243         __u32   namelen;
 244         __u32   type;
 245         char name[0];
 246 };
 247
 248 #define FUSE_NAME_OFFSET ((unsigned) ((struct fuse_dirent *) 0)->name)
 249 #define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
 250 #define FUSE_DIRENT_SIZE(d) \
 251         FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)