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