blob: d48282197696fdf1644820a121ce75cd5571bd67 [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 Szeredif3332112007-10-18 03:07:04 -070017 * - add lock_owner field to fuse_setattr_in, fuse_read_in and fuse_write_in
Miklos Szeredi0e9663e2007-10-18 03:07:05 -070018 * - add blksize field to fuse_attr
Miklos Szeredia6643092007-11-28 16:22:00 -080019 * - add file flags field to fuse_read_in and fuse_write_in
Miklos Szeredic79e3222007-10-18 03:06:59 -070020 */
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070021
22#include <asm/types.h>
Jan Engelhardt3e8c54f2006-06-25 05:48:49 -070023#include <linux/major.h>
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070024
25/** Version number of this interface */
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070026#define FUSE_KERNEL_VERSION 7
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070027
28/** Minor version number of this interface */
Miklos Szeredic79e3222007-10-18 03:06:59 -070029#define FUSE_KERNEL_MINOR_VERSION 9
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070030
31/** The node ID of the root inode */
32#define FUSE_ROOT_ID 1
33
Miklos Szeredi334f4852005-09-09 13:10:27 -070034/** The major number of the fuse character device */
Jan Engelhardt3e8c54f2006-06-25 05:48:49 -070035#define FUSE_MAJOR MISC_MAJOR
Miklos Szeredi334f4852005-09-09 13:10:27 -070036
37/** The minor number of the fuse character device */
38#define FUSE_MINOR 229
39
Miklos Szeredi06663262005-09-09 13:10:32 -070040/* Make sure all structures are padded to 64bit boundary, so 32bit
41 userspace works under 64bit kernels */
42
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070043struct fuse_attr {
44 __u64 ino;
45 __u64 size;
46 __u64 blocks;
47 __u64 atime;
48 __u64 mtime;
49 __u64 ctime;
50 __u32 atimensec;
51 __u32 mtimensec;
52 __u32 ctimensec;
53 __u32 mode;
54 __u32 nlink;
55 __u32 uid;
56 __u32 gid;
57 __u32 rdev;
Miklos Szeredi0e9663e2007-10-18 03:07:05 -070058 __u32 blksize;
59 __u32 padding;
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070060};
61
Miklos Szeredie5e55582005-09-09 13:10:28 -070062struct fuse_kstatfs {
63 __u64 blocks;
64 __u64 bfree;
65 __u64 bavail;
66 __u64 files;
67 __u64 ffree;
68 __u32 bsize;
69 __u32 namelen;
Miklos Szeredide5f1202006-01-06 00:19:37 -080070 __u32 frsize;
71 __u32 padding;
72 __u32 spare[6];
Miklos Szeredie5e55582005-09-09 13:10:28 -070073};
74
Miklos Szeredi71421252006-06-25 05:48:52 -070075struct fuse_file_lock {
76 __u64 start;
77 __u64 end;
78 __u32 type;
79 __u32 pid; /* tgid */
80};
81
Miklos Szeredi9cd68452006-02-01 03:04:40 -080082/**
83 * Bitmasks for fuse_setattr_in.valid
84 */
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070085#define FATTR_MODE (1 << 0)
86#define FATTR_UID (1 << 1)
87#define FATTR_GID (1 << 2)
88#define FATTR_SIZE (1 << 3)
89#define FATTR_ATIME (1 << 4)
90#define FATTR_MTIME (1 << 5)
Miklos Szeredibefc6492005-11-07 00:59:52 -080091#define FATTR_FH (1 << 6)
Miklos Szeredi17637cb2007-10-18 03:07:01 -070092#define FATTR_ATIME_NOW (1 << 7)
93#define FATTR_MTIME_NOW (1 << 8)
Miklos Szeredif3332112007-10-18 03:07:04 -070094#define FATTR_LOCKOWNER (1 << 9)
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070095
Miklos Szeredi45323fb2005-09-09 13:10:37 -070096/**
97 * Flags returned by the OPEN request
98 *
99 * FOPEN_DIRECT_IO: bypass page cache for this open file
100 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
101 */
102#define FOPEN_DIRECT_IO (1 << 0)
103#define FOPEN_KEEP_CACHE (1 << 1)
104
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800105/**
106 * INIT request/reply flags
107 */
108#define FUSE_ASYNC_READ (1 << 0)
Miklos Szeredi71421252006-06-25 05:48:52 -0700109#define FUSE_POSIX_LOCKS (1 << 1)
Miklos Szeredic79e3222007-10-18 03:06:59 -0700110#define FUSE_FILE_OPS (1 << 2)
Miklos Szeredi6ff958e2007-10-18 03:07:02 -0700111#define FUSE_ATOMIC_O_TRUNC (1 << 3)
Miklos Szeredi78bb6cb2008-05-12 14:02:32 -0700112#define FUSE_BIG_WRITES (1 << 5)
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800113
Miklos Szeredie9168c12006-12-06 20:35:38 -0800114/**
115 * Release flags
116 */
117#define FUSE_RELEASE_FLUSH (1 << 0)
118
Miklos Szeredic79e3222007-10-18 03:06:59 -0700119/**
120 * Getattr flags
121 */
122#define FUSE_GETATTR_FH (1 << 0)
123
Miklos Szeredia9ff4f82007-10-18 03:07:02 -0700124/**
125 * Lock flags
126 */
127#define FUSE_LK_FLOCK (1 << 0)
128
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700129/**
130 * WRITE flags
131 *
132 * FUSE_WRITE_CACHE: delayed write from page cache, file handle is guessed
Miklos Szeredif3332112007-10-18 03:07:04 -0700133 * FUSE_WRITE_LOCKOWNER: lock_owner field is valid
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700134 */
135#define FUSE_WRITE_CACHE (1 << 0)
Miklos Szeredif3332112007-10-18 03:07:04 -0700136#define FUSE_WRITE_LOCKOWNER (1 << 1)
137
138/**
139 * Read flags
140 */
141#define FUSE_READ_LOCKOWNER (1 << 1)
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700142
Miklos Szeredi334f4852005-09-09 13:10:27 -0700143enum fuse_opcode {
Miklos Szeredie5e55582005-09-09 13:10:28 -0700144 FUSE_LOOKUP = 1,
145 FUSE_FORGET = 2, /* no reply */
146 FUSE_GETATTR = 3,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700147 FUSE_SETATTR = 4,
Miklos Szeredie5e55582005-09-09 13:10:28 -0700148 FUSE_READLINK = 5,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700149 FUSE_SYMLINK = 6,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700150 FUSE_MKNOD = 8,
151 FUSE_MKDIR = 9,
152 FUSE_UNLINK = 10,
153 FUSE_RMDIR = 11,
154 FUSE_RENAME = 12,
155 FUSE_LINK = 13,
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700156 FUSE_OPEN = 14,
157 FUSE_READ = 15,
158 FUSE_WRITE = 16,
Miklos Szeredie5e55582005-09-09 13:10:28 -0700159 FUSE_STATFS = 17,
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700160 FUSE_RELEASE = 18,
161 FUSE_FSYNC = 20,
Miklos Szeredi92a87802005-09-09 13:10:31 -0700162 FUSE_SETXATTR = 21,
163 FUSE_GETXATTR = 22,
164 FUSE_LISTXATTR = 23,
165 FUSE_REMOVEXATTR = 24,
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700166 FUSE_FLUSH = 25,
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700167 FUSE_INIT = 26,
168 FUSE_OPENDIR = 27,
169 FUSE_READDIR = 28,
Miklos Szeredi82547982005-09-09 13:10:38 -0700170 FUSE_RELEASEDIR = 29,
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800171 FUSE_FSYNCDIR = 30,
Miklos Szeredi71421252006-06-25 05:48:52 -0700172 FUSE_GETLK = 31,
173 FUSE_SETLK = 32,
174 FUSE_SETLKW = 33,
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800175 FUSE_ACCESS = 34,
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700176 FUSE_CREATE = 35,
177 FUSE_INTERRUPT = 36,
Miklos Szeredib2d22722006-12-06 20:35:51 -0800178 FUSE_BMAP = 37,
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800179 FUSE_DESTROY = 38,
Miklos Szeredi334f4852005-09-09 13:10:27 -0700180};
181
Miklos Szeredi1d3d7522006-01-06 00:19:40 -0800182/* The read buffer is required to be at least 8k, but may be much larger */
183#define FUSE_MIN_READ_BUFFER 8192
Miklos Szeredie5e55582005-09-09 13:10:28 -0700184
Miklos Szeredi0e9663e2007-10-18 03:07:05 -0700185#define FUSE_COMPAT_ENTRY_OUT_SIZE 120
186
Miklos Szeredie5e55582005-09-09 13:10:28 -0700187struct fuse_entry_out {
188 __u64 nodeid; /* Inode ID */
189 __u64 generation; /* Inode generation: nodeid:gen must
190 be unique for the fs's lifetime */
191 __u64 entry_valid; /* Cache timeout for the name */
192 __u64 attr_valid; /* Cache timeout for the attributes */
193 __u32 entry_valid_nsec;
194 __u32 attr_valid_nsec;
195 struct fuse_attr attr;
196};
197
198struct fuse_forget_in {
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700199 __u64 nlookup;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700200};
201
Miklos Szeredic79e3222007-10-18 03:06:59 -0700202struct fuse_getattr_in {
203 __u32 getattr_flags;
204 __u32 dummy;
205 __u64 fh;
206};
207
Miklos Szeredi0e9663e2007-10-18 03:07:05 -0700208#define FUSE_COMPAT_ATTR_OUT_SIZE 96
209
Miklos Szeredie5e55582005-09-09 13:10:28 -0700210struct fuse_attr_out {
211 __u64 attr_valid; /* Cache timeout for the attributes */
212 __u32 attr_valid_nsec;
213 __u32 dummy;
214 struct fuse_attr attr;
215};
216
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700217struct fuse_mknod_in {
218 __u32 mode;
219 __u32 rdev;
220};
221
222struct fuse_mkdir_in {
223 __u32 mode;
Miklos Szeredi06663262005-09-09 13:10:32 -0700224 __u32 padding;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700225};
226
227struct fuse_rename_in {
228 __u64 newdir;
229};
230
231struct fuse_link_in {
232 __u64 oldnodeid;
233};
234
235struct fuse_setattr_in {
236 __u32 valid;
Miklos Szeredi06663262005-09-09 13:10:32 -0700237 __u32 padding;
Miklos Szeredibefc6492005-11-07 00:59:52 -0800238 __u64 fh;
239 __u64 size;
Miklos Szeredif3332112007-10-18 03:07:04 -0700240 __u64 lock_owner;
Miklos Szeredibefc6492005-11-07 00:59:52 -0800241 __u64 atime;
242 __u64 mtime;
243 __u64 unused2;
244 __u32 atimensec;
245 __u32 mtimensec;
246 __u32 unused3;
247 __u32 mode;
248 __u32 unused4;
249 __u32 uid;
250 __u32 gid;
251 __u32 unused5;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700252};
253
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700254struct fuse_open_in {
255 __u32 flags;
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800256 __u32 mode;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700257};
258
259struct fuse_open_out {
260 __u64 fh;
261 __u32 open_flags;
Miklos Szeredi06663262005-09-09 13:10:32 -0700262 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700263};
264
265struct fuse_release_in {
266 __u64 fh;
267 __u32 flags;
Miklos Szeredie9168c12006-12-06 20:35:38 -0800268 __u32 release_flags;
269 __u64 lock_owner;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700270};
271
272struct fuse_flush_in {
273 __u64 fh;
Miklos Szeredie9168c12006-12-06 20:35:38 -0800274 __u32 unused;
Miklos Szeredi06663262005-09-09 13:10:32 -0700275 __u32 padding;
Miklos Szeredi71421252006-06-25 05:48:52 -0700276 __u64 lock_owner;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700277};
278
279struct fuse_read_in {
280 __u64 fh;
281 __u64 offset;
282 __u32 size;
Miklos Szeredif3332112007-10-18 03:07:04 -0700283 __u32 read_flags;
284 __u64 lock_owner;
Miklos Szeredia6643092007-11-28 16:22:00 -0800285 __u32 flags;
286 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700287};
288
Miklos Szeredif3332112007-10-18 03:07:04 -0700289#define FUSE_COMPAT_WRITE_IN_SIZE 24
290
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700291struct fuse_write_in {
292 __u64 fh;
293 __u64 offset;
294 __u32 size;
295 __u32 write_flags;
Miklos Szeredif3332112007-10-18 03:07:04 -0700296 __u64 lock_owner;
Miklos Szeredia6643092007-11-28 16:22:00 -0800297 __u32 flags;
298 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700299};
300
301struct fuse_write_out {
302 __u32 size;
Miklos Szeredi06663262005-09-09 13:10:32 -0700303 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700304};
305
Miklos Szeredide5f1202006-01-06 00:19:37 -0800306#define FUSE_COMPAT_STATFS_SIZE 48
307
Miklos Szeredie5e55582005-09-09 13:10:28 -0700308struct fuse_statfs_out {
309 struct fuse_kstatfs st;
310};
311
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700312struct fuse_fsync_in {
313 __u64 fh;
314 __u32 fsync_flags;
Miklos Szeredi06663262005-09-09 13:10:32 -0700315 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700316};
317
Miklos Szeredi92a87802005-09-09 13:10:31 -0700318struct fuse_setxattr_in {
319 __u32 size;
320 __u32 flags;
321};
322
323struct fuse_getxattr_in {
324 __u32 size;
Miklos Szeredi06663262005-09-09 13:10:32 -0700325 __u32 padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700326};
327
328struct fuse_getxattr_out {
329 __u32 size;
Miklos Szeredi06663262005-09-09 13:10:32 -0700330 __u32 padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700331};
332
Miklos Szeredi71421252006-06-25 05:48:52 -0700333struct fuse_lk_in {
334 __u64 fh;
335 __u64 owner;
336 struct fuse_file_lock lk;
Miklos Szeredia9ff4f82007-10-18 03:07:02 -0700337 __u32 lk_flags;
338 __u32 padding;
Miklos Szeredi71421252006-06-25 05:48:52 -0700339};
340
341struct fuse_lk_out {
342 struct fuse_file_lock lk;
343};
344
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800345struct fuse_access_in {
346 __u32 mask;
347 __u32 padding;
348};
349
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800350struct fuse_init_in {
Miklos Szeredi334f4852005-09-09 13:10:27 -0700351 __u32 major;
352 __u32 minor;
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800353 __u32 max_readahead;
354 __u32 flags;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700355};
356
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800357struct fuse_init_out {
358 __u32 major;
359 __u32 minor;
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800360 __u32 max_readahead;
361 __u32 flags;
362 __u32 unused;
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800363 __u32 max_write;
364};
365
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700366struct fuse_interrupt_in {
367 __u64 unique;
368};
369
Miklos Szeredib2d22722006-12-06 20:35:51 -0800370struct fuse_bmap_in {
371 __u64 block;
372 __u32 blocksize;
373 __u32 padding;
374};
375
376struct fuse_bmap_out {
377 __u64 block;
378};
379
Miklos Szeredi334f4852005-09-09 13:10:27 -0700380struct fuse_in_header {
381 __u32 len;
382 __u32 opcode;
383 __u64 unique;
384 __u64 nodeid;
385 __u32 uid;
386 __u32 gid;
387 __u32 pid;
Miklos Szeredi06663262005-09-09 13:10:32 -0700388 __u32 padding;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700389};
390
391struct fuse_out_header {
392 __u32 len;
393 __s32 error;
394 __u64 unique;
395};
396
Miklos Szeredie5e55582005-09-09 13:10:28 -0700397struct fuse_dirent {
398 __u64 ino;
399 __u64 off;
400 __u32 namelen;
401 __u32 type;
402 char name[0];
403};
404
Andrew Morton21f3da92007-07-15 23:39:50 -0700405#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
Miklos Szeredie5e55582005-09-09 13:10:28 -0700406#define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
407#define FUSE_DIRENT_SIZE(d) \
408 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)