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 struct fuse_attr {
  29         __u64   ino;
  30         __u64   size;
  31         __u64   blocks;
  32         __u64   atime;
  33         __u64   mtime;
  34         __u64   ctime;
  35         __u32   atimensec;
  36         __u32   mtimensec;
  37         __u32   ctimensec;
  38         __u32   mode;
  39         __u32   nlink;
  40         __u32   uid;
  41         __u32   gid;
  42         __u32   rdev;
  43 };
  44
  45 struct fuse_kstatfs {
  46         __u64   blocks;
  47         __u64   bfree;
  48         __u64   bavail;
  49         __u64   files;
  50         __u64   ffree;
  51         __u32   bsize;
  52         __u32   namelen;
  53 };
  54
  55 #define FATTR_MODE      (1 << 0)
  56 #define FATTR_UID       (1 << 1)
  57 #define FATTR_GID       (1 << 2)
  58 #define FATTR_SIZE      (1 << 3)
  59 #define FATTR_ATIME     (1 << 4)
  60 #define FATTR_MTIME     (1 << 5)
  61 #define FATTR_CTIME     (1 << 6)
  62
  63 enum fuse_opcode {
  64         FUSE_LOOKUP        = 1,
  65         FUSE_FORGET        = 2,  /* no reply */
  66         FUSE_GETATTR       = 3,
  67         FUSE_SETATTR       = 4,
  68         FUSE_READLINK      = 5,
  69         FUSE_SYMLINK       = 6,
  70         FUSE_GETDIR        = 7,
  71         FUSE_MKNOD         = 8,
  72         FUSE_MKDIR         = 9,
  73         FUSE_UNLINK        = 10,
  74         FUSE_RMDIR         = 11,
  75         FUSE_RENAME        = 12,
  76         FUSE_LINK          = 13,
  77         FUSE_STATFS        = 17,
  78         FUSE_INIT          = 26
  79 };
  80
  81 /* Conservative buffer size for the client */
  82 #define FUSE_MAX_IN 8192
  83
  84 #define FUSE_NAME_MAX 1024
  85 #define FUSE_SYMLINK_MAX 4096
  86
  87 struct fuse_entry_out {
  88         __u64   nodeid;         /* Inode ID */
  89         __u64   generation;     /* Inode generation: nodeid:gen must
  90                                    be unique for the fs's lifetime */
  91         __u64   entry_valid;    /* Cache timeout for the name */
  92         __u64   attr_valid;     /* Cache timeout for the attributes */
  93         __u32   entry_valid_nsec;
  94         __u32   attr_valid_nsec;
  95         struct fuse_attr attr;
  96 };
  97
  98 struct fuse_forget_in {
  99         __u64   nlookup;
 100 };
 101
 102 struct fuse_attr_out {
 103         __u64   attr_valid;     /* Cache timeout for the attributes */
 104         __u32   attr_valid_nsec;
 105         __u32   dummy;
 106         struct fuse_attr attr;
 107 };
 108
 109 struct fuse_getdir_out {
 110         __u32   fd;
 111 };
 112
 113 struct fuse_mknod_in {
 114         __u32   mode;
 115         __u32   rdev;
 116 };
 117
 118 struct fuse_mkdir_in {
 119         __u32   mode;
 120 };
 121
 122 struct fuse_rename_in {
 123         __u64   newdir;
 124 };
 125
 126 struct fuse_link_in {
 127         __u64   oldnodeid;
 128 };
 129
 130 struct fuse_setattr_in {
 131         __u32   valid;
 132         struct fuse_attr attr;
 133 };
 134
 135 struct fuse_statfs_out {
 136         struct fuse_kstatfs st;
 137 };
 138
 139 struct fuse_init_in_out {
 140         __u32   major;
 141         __u32   minor;
 142 };
 143
 144 struct fuse_in_header {
 145         __u32   len;
 146         __u32   opcode;
 147         __u64   unique;
 148         __u64   nodeid;
 149         __u32   uid;
 150         __u32   gid;
 151         __u32   pid;
 152 };
 153
 154 struct fuse_out_header {
 155         __u32   len;
 156         __s32   error;
 157         __u64   unique;
 158 };
 159
 160 struct fuse_dirent {
 161         __u64   ino;
 162         __u64   off;
 163         __u32   namelen;
 164         __u32   type;
 165         char name[0];
 166 };
 167
 168 #define FUSE_NAME_OFFSET ((unsigned) ((struct fuse_dirent *) 0)->name)
 169 #define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
 170 #define FUSE_DIRENT_SIZE(d) \
 171         FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)