fuse: implement poll support
[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  *  - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
18  *  - add blksize field to fuse_attr
19  *  - add file flags field to fuse_read_in and fuse_write_in
20  *
21  * 7.10
22  *  - add nonseekable open flag
23  */
24
25 #ifndef _LINUX_FUSE_H
26 #define _LINUX_FUSE_H
27
28 #include <asm/types.h>
29 #include <linux/major.h>
30
31 /** Version number of this interface */
32 #define FUSE_KERNEL_VERSION 7
33
34 /** Minor version number of this interface */
35 #define FUSE_KERNEL_MINOR_VERSION 10
36
37 /** The node ID of the root inode */
38 #define FUSE_ROOT_ID 1
39
40 /** The major number of the fuse character device */
41 #define FUSE_MAJOR MISC_MAJOR
42
43 /* Make sure all structures are padded to 64bit boundary, so 32bit
44    userspace works under 64bit kernels */
45
46 struct fuse_attr {
47         __u64   ino;
48         __u64   size;
49         __u64   blocks;
50         __u64   atime;
51         __u64   mtime;
52         __u64   ctime;
53         __u32   atimensec;
54         __u32   mtimensec;
55         __u32   ctimensec;
56         __u32   mode;
57         __u32   nlink;
58         __u32   uid;
59         __u32   gid;
60         __u32   rdev;
61         __u32   blksize;
62         __u32   padding;
63 };
64
65 struct fuse_kstatfs {
66         __u64   blocks;
67         __u64   bfree;
68         __u64   bavail;
69         __u64   files;
70         __u64   ffree;
71         __u32   bsize;
72         __u32   namelen;
73         __u32   frsize;
74         __u32   padding;
75         __u32   spare[6];
76 };
77
78 struct fuse_file_lock {
79         __u64   start;
80         __u64   end;
81         __u32   type;
82         __u32   pid; /* tgid */
83 };
84
85 /**
86  * Bitmasks for fuse_setattr_in.valid
87  */
88 #define FATTR_MODE      (1 << 0)
89 #define FATTR_UID       (1 << 1)
90 #define FATTR_GID       (1 << 2)
91 #define FATTR_SIZE      (1 << 3)
92 #define FATTR_ATIME     (1 << 4)
93 #define FATTR_MTIME     (1 << 5)
94 #define FATTR_FH        (1 << 6)
95 #define FATTR_ATIME_NOW (1 << 7)
96 #define FATTR_MTIME_NOW (1 << 8)
97 #define FATTR_LOCKOWNER (1 << 9)
98
99 /**
100  * Flags returned by the OPEN request
101  *
102  * FOPEN_DIRECT_IO: bypass page cache for this open file
103  * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
104  * FOPEN_NONSEEKABLE: the file is not seekable
105  */
106 #define FOPEN_DIRECT_IO         (1 << 0)
107 #define FOPEN_KEEP_CACHE        (1 << 1)
108 #define FOPEN_NONSEEKABLE       (1 << 2)
109
110 /**
111  * INIT request/reply flags
112  *
113  * FUSE_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
114  */
115 #define FUSE_ASYNC_READ         (1 << 0)
116 #define FUSE_POSIX_LOCKS        (1 << 1)
117 #define FUSE_FILE_OPS           (1 << 2)
118 #define FUSE_ATOMIC_O_TRUNC     (1 << 3)
119 #define FUSE_EXPORT_SUPPORT     (1 << 4)
120 #define FUSE_BIG_WRITES         (1 << 5)
121
122 /**
123  * Release flags
124  */
125 #define FUSE_RELEASE_FLUSH      (1 << 0)
126
127 /**
128  * Getattr flags
129  */
130 #define FUSE_GETATTR_FH         (1 << 0)
131
132 /**
133  * Lock flags
134  */
135 #define FUSE_LK_FLOCK           (1 << 0)
136
137 /**
138  * WRITE flags
139  *
140  * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
141  * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
142  */
143 #define FUSE_WRITE_CACHE        (1 << 0)
144 #define FUSE_WRITE_LOCKOWNER    (1 << 1)
145
146 /**
147  * Read flags
148  */
149 #define FUSE_READ_LOCKOWNER     (1 << 1)
150
151 /**
152  * Ioctl flags
153  *
154  * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
155  * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
156  * FUSE_IOCTL_RETRY: retry with new iovecs
157  *
158  * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
159  */
160 #define FUSE_IOCTL_COMPAT       (1 << 0)
161 #define FUSE_IOCTL_UNRESTRICTED (1 << 1)
162 #define FUSE_IOCTL_RETRY        (1 << 2)
163
164 #define FUSE_IOCTL_MAX_IOV      256
165
166 /**
167  * Poll flags
168  *
169  * FUSE_POLL_SCHEDULE_NOTIFY: request poll notify
170  */
171 #define FUSE_POLL_SCHEDULE_NOTIFY (1 << 0)
172
173 enum fuse_opcode {
174         FUSE_LOOKUP        = 1,
175         FUSE_FORGET        = 2,  /* no reply */
176         FUSE_GETATTR       = 3,
177         FUSE_SETATTR       = 4,
178         FUSE_READLINK      = 5,
179         FUSE_SYMLINK       = 6,
180         FUSE_MKNOD         = 8,
181         FUSE_MKDIR         = 9,
182         FUSE_UNLINK        = 10,
183         FUSE_RMDIR         = 11,
184         FUSE_RENAME        = 12,
185         FUSE_LINK          = 13,
186         FUSE_OPEN          = 14,
187         FUSE_READ          = 15,
188         FUSE_WRITE         = 16,
189         FUSE_STATFS        = 17,
190         FUSE_RELEASE       = 18,
191         FUSE_FSYNC         = 20,
192         FUSE_SETXATTR      = 21,
193         FUSE_GETXATTR      = 22,
194         FUSE_LISTXATTR     = 23,
195         FUSE_REMOVEXATTR   = 24,
196         FUSE_FLUSH         = 25,
197         FUSE_INIT          = 26,
198         FUSE_OPENDIR       = 27,
199         FUSE_READDIR       = 28,
200         FUSE_RELEASEDIR    = 29,
201         FUSE_FSYNCDIR      = 30,
202         FUSE_GETLK         = 31,
203         FUSE_SETLK         = 32,
204         FUSE_SETLKW        = 33,
205         FUSE_ACCESS        = 34,
206         FUSE_CREATE        = 35,
207         FUSE_INTERRUPT     = 36,
208         FUSE_BMAP          = 37,
209         FUSE_DESTROY       = 38,
210         FUSE_IOCTL         = 39,
211         FUSE_POLL          = 40,
212 };
213
214 enum fuse_notify_code {
215         FUSE_NOTIFY_POLL   = 1,
216         FUSE_NOTIFY_CODE_MAX,
217 };
218
219 /* The read buffer is required to be at least 8k, but may be much larger */
220 #define FUSE_MIN_READ_BUFFER 8192
221
222 #define FUSE_COMPAT_ENTRY_OUT_SIZE 120
223
224 struct fuse_entry_out {
225         __u64   nodeid;         /* Inode ID */
226         __u64   generation;     /* Inode generation: nodeid:gen must
227                                    be unique for the fs's lifetime */
228         __u64   entry_valid;    /* Cache timeout for the name */
229         __u64   attr_valid;     /* Cache timeout for the attributes */
230         __u32   entry_valid_nsec;
231         __u32   attr_valid_nsec;
232         struct fuse_attr attr;
233 };
234
235 struct fuse_forget_in {
236         __u64   nlookup;
237 };
238
239 struct fuse_getattr_in {
240         __u32   getattr_flags;
241         __u32   dummy;
242         __u64   fh;
243 };
244
245 #define FUSE_COMPAT_ATTR_OUT_SIZE 96
246
247 struct fuse_attr_out {
248         __u64   attr_valid;     /* Cache timeout for the attributes */
249         __u32   attr_valid_nsec;
250         __u32   dummy;
251         struct fuse_attr attr;
252 };
253
254 struct fuse_mknod_in {
255         __u32   mode;
256         __u32   rdev;
257 };
258
259 struct fuse_mkdir_in {
260         __u32   mode;
261         __u32   padding;
262 };
263
264 struct fuse_rename_in {
265         __u64   newdir;
266 };
267
268 struct fuse_link_in {
269         __u64   oldnodeid;
270 };
271
272 struct fuse_setattr_in {
273         __u32   valid;
274         __u32   padding;
275         __u64   fh;
276         __u64   size;
277         __u64   lock_owner;
278         __u64   atime;
279         __u64   mtime;
280         __u64   unused2;
281         __u32   atimensec;
282         __u32   mtimensec;
283         __u32   unused3;
284         __u32   mode;
285         __u32   unused4;
286         __u32   uid;
287         __u32   gid;
288         __u32   unused5;
289 };
290
291 struct fuse_open_in {
292         __u32   flags;
293         __u32   mode;
294 };
295
296 struct fuse_open_out {
297         __u64   fh;
298         __u32   open_flags;
299         __u32   padding;
300 };
301
302 struct fuse_release_in {
303         __u64   fh;
304         __u32   flags;
305         __u32   release_flags;
306         __u64   lock_owner;
307 };
308
309 struct fuse_flush_in {
310         __u64   fh;
311         __u32   unused;
312         __u32   padding;
313         __u64   lock_owner;
314 };
315
316 struct fuse_read_in {
317         __u64   fh;
318         __u64   offset;
319         __u32   size;
320         __u32   read_flags;
321         __u64   lock_owner;
322         __u32   flags;
323         __u32   padding;
324 };
325
326 #define FUSE_COMPAT_WRITE_IN_SIZE 24
327
328 struct fuse_write_in {
329         __u64   fh;
330         __u64   offset;
331         __u32   size;
332         __u32   write_flags;
333         __u64   lock_owner;
334         __u32   flags;
335         __u32   padding;
336 };
337
338 struct fuse_write_out {
339         __u32   size;
340         __u32   padding;
341 };
342
343 #define FUSE_COMPAT_STATFS_SIZE 48
344
345 struct fuse_statfs_out {
346         struct fuse_kstatfs st;
347 };
348
349 struct fuse_fsync_in {
350         __u64   fh;
351         __u32   fsync_flags;
352         __u32   padding;
353 };
354
355 struct fuse_setxattr_in {
356         __u32   size;
357         __u32   flags;
358 };
359
360 struct fuse_getxattr_in {
361         __u32   size;
362         __u32   padding;
363 };
364
365 struct fuse_getxattr_out {
366         __u32   size;
367         __u32   padding;
368 };
369
370 struct fuse_lk_in {
371         __u64   fh;
372         __u64   owner;
373         struct fuse_file_lock lk;
374         __u32   lk_flags;
375         __u32   padding;
376 };
377
378 struct fuse_lk_out {
379         struct fuse_file_lock lk;
380 };
381
382 struct fuse_access_in {
383         __u32   mask;
384         __u32   padding;
385 };
386
387 struct fuse_init_in {
388         __u32   major;
389         __u32   minor;
390         __u32   max_readahead;
391         __u32   flags;
392 };
393
394 struct fuse_init_out {
395         __u32   major;
396         __u32   minor;
397         __u32   max_readahead;
398         __u32   flags;
399         __u32   unused;
400         __u32   max_write;
401 };
402
403 struct fuse_interrupt_in {
404         __u64   unique;
405 };
406
407 struct fuse_bmap_in {
408         __u64   block;
409         __u32   blocksize;
410         __u32   padding;
411 };
412
413 struct fuse_bmap_out {
414         __u64   block;
415 };
416
417 struct fuse_ioctl_in {
418         __u64   fh;
419         __u32   flags;
420         __u32   cmd;
421         __u64   arg;
422         __u32   in_size;
423         __u32   out_size;
424 };
425
426 struct fuse_ioctl_out {
427         __s32   result;
428         __u32   flags;
429         __u32   in_iovs;
430         __u32   out_iovs;
431 };
432
433 struct fuse_poll_in {
434         __u64   fh;
435         __u64   kh;
436         __u32   flags;
437         __u32   padding;
438 };
439
440 struct fuse_poll_out {
441         __u32   revents;
442         __u32   padding;
443 };
444
445 struct fuse_notify_poll_wakeup_out {
446         __u64   kh;
447 };
448
449 struct fuse_in_header {
450         __u32   len;
451         __u32   opcode;
452         __u64   unique;
453         __u64   nodeid;
454         __u32   uid;
455         __u32   gid;
456         __u32   pid;
457         __u32   padding;
458 };
459
460 struct fuse_out_header {
461         __u32   len;
462         __s32   error;
463         __u64   unique;
464 };
465
466 struct fuse_dirent {
467         __u64   ino;
468         __u64   off;
469         __u32   namelen;
470         __u32   type;
471         char name[0];
472 };
473
474 #define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
475 #define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
476 #define FUSE_DIRENT_SIZE(d) \
477         FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
478
479 #endif /* _LINUX_FUSE_H */