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