blob: 015a8b15a388789da2d571fbe45fdd5da61af009 [file] [log] [blame]
Miklos Szeredid8a5ba42005-09-09 13:10:26 -07001/*
2 FUSE: Filesystem in Userspace
Miklos Szeredi71421252006-06-25 05:48:52 -07003 Copyright (C) 2001-2006 Miklos Szeredi <miklos@szeredi.hu>
Miklos Szeredid8a5ba42005-09-09 13:10:26 -07004
5 This program can be distributed under the terms of the GNU GPL.
6 See the file COPYING.
7*/
8
Miklos Szeredic79e3222007-10-18 03:06:59 -07009/*
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
Miklos Szeredia9ff4f82007-10-18 03:07:02 -070016 * - add lk_flags in fuse_lk_in
Miklos Szeredic79e3222007-10-18 03:06:59 -070017 */
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070018
19#include <asm/types.h>
Jan Engelhardt3e8c54f2006-06-25 05:48:49 -070020#include <linux/major.h>
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070021
22/** Version number of this interface */
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070023#define FUSE_KERNEL_VERSION 7
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070024
25/** Minor version number of this interface */
Miklos Szeredic79e3222007-10-18 03:06:59 -070026#define FUSE_KERNEL_MINOR_VERSION 9
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070027
28/** The node ID of the root inode */
29#define FUSE_ROOT_ID 1
30
Miklos Szeredi334f4852005-09-09 13:10:27 -070031/** The major number of the fuse character device */
Jan Engelhardt3e8c54f2006-06-25 05:48:49 -070032#define FUSE_MAJOR MISC_MAJOR
Miklos Szeredi334f4852005-09-09 13:10:27 -070033
34/** The minor number of the fuse character device */
35#define FUSE_MINOR 229
36
Miklos Szeredi06663262005-09-09 13:10:32 -070037/* Make sure all structures are padded to 64bit boundary, so 32bit
38 userspace works under 64bit kernels */
39
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070040struct 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
Miklos Szeredie5e55582005-09-09 13:10:28 -070057struct fuse_kstatfs {
58 __u64 blocks;
59 __u64 bfree;
60 __u64 bavail;
61 __u64 files;
62 __u64 ffree;
63 __u32 bsize;
64 __u32 namelen;
Miklos Szeredide5f1202006-01-06 00:19:37 -080065 __u32 frsize;
66 __u32 padding;
67 __u32 spare[6];
Miklos Szeredie5e55582005-09-09 13:10:28 -070068};
69
Miklos Szeredi71421252006-06-25 05:48:52 -070070struct fuse_file_lock {
71 __u64 start;
72 __u64 end;
73 __u32 type;
74 __u32 pid; /* tgid */
75};
76
Miklos Szeredi9cd68452006-02-01 03:04:40 -080077/**
78 * Bitmasks for fuse_setattr_in.valid
79 */
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070080#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)
Miklos Szeredibefc6492005-11-07 00:59:52 -080086#define FATTR_FH (1 << 6)
Miklos Szeredi17637cb2007-10-18 03:07:01 -070087#define FATTR_ATIME_NOW (1 << 7)
88#define FATTR_MTIME_NOW (1 << 8)
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070089
Miklos Szeredi45323fb2005-09-09 13:10:37 -070090/**
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
Miklos Szeredi9cd68452006-02-01 03:04:40 -080099/**
100 * INIT request/reply flags
101 */
102#define FUSE_ASYNC_READ (1 << 0)
Miklos Szeredi71421252006-06-25 05:48:52 -0700103#define FUSE_POSIX_LOCKS (1 << 1)
Miklos Szeredic79e3222007-10-18 03:06:59 -0700104#define FUSE_FILE_OPS (1 << 2)
Miklos Szeredi6ff958e2007-10-18 03:07:02 -0700105#define FUSE_ATOMIC_O_TRUNC (1 << 3)
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800106
Miklos Szeredie9168c12006-12-06 20:35:38 -0800107/**
108 * Release flags
109 */
110#define FUSE_RELEASE_FLUSH (1 << 0)
111
Miklos Szeredic79e3222007-10-18 03:06:59 -0700112/**
113 * Getattr flags
114 */
115#define FUSE_GETATTR_FH (1 << 0)
116
Miklos Szeredia9ff4f82007-10-18 03:07:02 -0700117/**
118 * Lock flags
119 */
120#define FUSE_LK_FLOCK (1 << 0)
121
Miklos Szeredi334f4852005-09-09 13:10:27 -0700122enum fuse_opcode {
Miklos Szeredie5e55582005-09-09 13:10:28 -0700123 FUSE_LOOKUP = 1,
124 FUSE_FORGET = 2, /* no reply */
125 FUSE_GETATTR = 3,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700126 FUSE_SETATTR = 4,
Miklos Szeredie5e55582005-09-09 13:10:28 -0700127 FUSE_READLINK = 5,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700128 FUSE_SYMLINK = 6,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700129 FUSE_MKNOD = 8,
130 FUSE_MKDIR = 9,
131 FUSE_UNLINK = 10,
132 FUSE_RMDIR = 11,
133 FUSE_RENAME = 12,
134 FUSE_LINK = 13,
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700135 FUSE_OPEN = 14,
136 FUSE_READ = 15,
137 FUSE_WRITE = 16,
Miklos Szeredie5e55582005-09-09 13:10:28 -0700138 FUSE_STATFS = 17,
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700139 FUSE_RELEASE = 18,
140 FUSE_FSYNC = 20,
Miklos Szeredi92a87802005-09-09 13:10:31 -0700141 FUSE_SETXATTR = 21,
142 FUSE_GETXATTR = 22,
143 FUSE_LISTXATTR = 23,
144 FUSE_REMOVEXATTR = 24,
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700145 FUSE_FLUSH = 25,
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700146 FUSE_INIT = 26,
147 FUSE_OPENDIR = 27,
148 FUSE_READDIR = 28,
Miklos Szeredi82547982005-09-09 13:10:38 -0700149 FUSE_RELEASEDIR = 29,
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800150 FUSE_FSYNCDIR = 30,
Miklos Szeredi71421252006-06-25 05:48:52 -0700151 FUSE_GETLK = 31,
152 FUSE_SETLK = 32,
153 FUSE_SETLKW = 33,
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800154 FUSE_ACCESS = 34,
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700155 FUSE_CREATE = 35,
156 FUSE_INTERRUPT = 36,
Miklos Szeredib2d22722006-12-06 20:35:51 -0800157 FUSE_BMAP = 37,
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800158 FUSE_DESTROY = 38,
Miklos Szeredi334f4852005-09-09 13:10:27 -0700159};
160
Miklos Szeredi1d3d7522006-01-06 00:19:40 -0800161/* The read buffer is required to be at least 8k, but may be much larger */
162#define FUSE_MIN_READ_BUFFER 8192
Miklos Szeredie5e55582005-09-09 13:10:28 -0700163
164struct fuse_entry_out {
165 __u64 nodeid; /* Inode ID */
166 __u64 generation; /* Inode generation: nodeid:gen must
167 be unique for the fs's lifetime */
168 __u64 entry_valid; /* Cache timeout for the name */
169 __u64 attr_valid; /* Cache timeout for the attributes */
170 __u32 entry_valid_nsec;
171 __u32 attr_valid_nsec;
172 struct fuse_attr attr;
173};
174
175struct fuse_forget_in {
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700176 __u64 nlookup;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700177};
178
Miklos Szeredic79e3222007-10-18 03:06:59 -0700179struct fuse_getattr_in {
180 __u32 getattr_flags;
181 __u32 dummy;
182 __u64 fh;
183};
184
Miklos Szeredie5e55582005-09-09 13:10:28 -0700185struct fuse_attr_out {
186 __u64 attr_valid; /* Cache timeout for the attributes */
187 __u32 attr_valid_nsec;
188 __u32 dummy;
189 struct fuse_attr attr;
190};
191
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700192struct fuse_mknod_in {
193 __u32 mode;
194 __u32 rdev;
195};
196
197struct fuse_mkdir_in {
198 __u32 mode;
Miklos Szeredi06663262005-09-09 13:10:32 -0700199 __u32 padding;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700200};
201
202struct fuse_rename_in {
203 __u64 newdir;
204};
205
206struct fuse_link_in {
207 __u64 oldnodeid;
208};
209
210struct fuse_setattr_in {
211 __u32 valid;
Miklos Szeredi06663262005-09-09 13:10:32 -0700212 __u32 padding;
Miklos Szeredibefc6492005-11-07 00:59:52 -0800213 __u64 fh;
214 __u64 size;
215 __u64 unused1;
216 __u64 atime;
217 __u64 mtime;
218 __u64 unused2;
219 __u32 atimensec;
220 __u32 mtimensec;
221 __u32 unused3;
222 __u32 mode;
223 __u32 unused4;
224 __u32 uid;
225 __u32 gid;
226 __u32 unused5;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700227};
228
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700229struct fuse_open_in {
230 __u32 flags;
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800231 __u32 mode;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700232};
233
234struct fuse_open_out {
235 __u64 fh;
236 __u32 open_flags;
Miklos Szeredi06663262005-09-09 13:10:32 -0700237 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700238};
239
240struct fuse_release_in {
241 __u64 fh;
242 __u32 flags;
Miklos Szeredie9168c12006-12-06 20:35:38 -0800243 __u32 release_flags;
244 __u64 lock_owner;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700245};
246
247struct fuse_flush_in {
248 __u64 fh;
Miklos Szeredie9168c12006-12-06 20:35:38 -0800249 __u32 unused;
Miklos Szeredi06663262005-09-09 13:10:32 -0700250 __u32 padding;
Miklos Szeredi71421252006-06-25 05:48:52 -0700251 __u64 lock_owner;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700252};
253
254struct fuse_read_in {
255 __u64 fh;
256 __u64 offset;
257 __u32 size;
Miklos Szeredi06663262005-09-09 13:10:32 -0700258 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700259};
260
261struct fuse_write_in {
262 __u64 fh;
263 __u64 offset;
264 __u32 size;
265 __u32 write_flags;
266};
267
268struct fuse_write_out {
269 __u32 size;
Miklos Szeredi06663262005-09-09 13:10:32 -0700270 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700271};
272
Miklos Szeredide5f1202006-01-06 00:19:37 -0800273#define FUSE_COMPAT_STATFS_SIZE 48
274
Miklos Szeredie5e55582005-09-09 13:10:28 -0700275struct fuse_statfs_out {
276 struct fuse_kstatfs st;
277};
278
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700279struct fuse_fsync_in {
280 __u64 fh;
281 __u32 fsync_flags;
Miklos Szeredi06663262005-09-09 13:10:32 -0700282 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700283};
284
Miklos Szeredi92a87802005-09-09 13:10:31 -0700285struct fuse_setxattr_in {
286 __u32 size;
287 __u32 flags;
288};
289
290struct fuse_getxattr_in {
291 __u32 size;
Miklos Szeredi06663262005-09-09 13:10:32 -0700292 __u32 padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700293};
294
295struct fuse_getxattr_out {
296 __u32 size;
Miklos Szeredi06663262005-09-09 13:10:32 -0700297 __u32 padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700298};
299
Miklos Szeredi71421252006-06-25 05:48:52 -0700300struct fuse_lk_in {
301 __u64 fh;
302 __u64 owner;
303 struct fuse_file_lock lk;
Miklos Szeredia9ff4f82007-10-18 03:07:02 -0700304 __u32 lk_flags;
305 __u32 padding;
Miklos Szeredi71421252006-06-25 05:48:52 -0700306};
307
308struct fuse_lk_out {
309 struct fuse_file_lock lk;
310};
311
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800312struct fuse_access_in {
313 __u32 mask;
314 __u32 padding;
315};
316
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800317struct fuse_init_in {
Miklos Szeredi334f4852005-09-09 13:10:27 -0700318 __u32 major;
319 __u32 minor;
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800320 __u32 max_readahead;
321 __u32 flags;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700322};
323
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800324struct fuse_init_out {
325 __u32 major;
326 __u32 minor;
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800327 __u32 max_readahead;
328 __u32 flags;
329 __u32 unused;
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800330 __u32 max_write;
331};
332
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700333struct fuse_interrupt_in {
334 __u64 unique;
335};
336
Miklos Szeredib2d22722006-12-06 20:35:51 -0800337struct fuse_bmap_in {
338 __u64 block;
339 __u32 blocksize;
340 __u32 padding;
341};
342
343struct fuse_bmap_out {
344 __u64 block;
345};
346
Miklos Szeredi334f4852005-09-09 13:10:27 -0700347struct fuse_in_header {
348 __u32 len;
349 __u32 opcode;
350 __u64 unique;
351 __u64 nodeid;
352 __u32 uid;
353 __u32 gid;
354 __u32 pid;
Miklos Szeredi06663262005-09-09 13:10:32 -0700355 __u32 padding;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700356};
357
358struct fuse_out_header {
359 __u32 len;
360 __s32 error;
361 __u64 unique;
362};
363
Miklos Szeredie5e55582005-09-09 13:10:28 -0700364struct fuse_dirent {
365 __u64 ino;
366 __u64 off;
367 __u32 namelen;
368 __u32 type;
369 char name[0];
370};
371
Andrew Morton21f3da92007-07-15 23:39:50 -0700372#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
Miklos Szeredie5e55582005-09-09 13:10:28 -0700373#define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
374#define FUSE_DIRENT_SIZE(d) \
375 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)