blob: 9fbe9d258e2259b196fc752213dd84ea03a2f5d4 [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
9/* This file defines the kernel interface of FUSE */
10
11#include <asm/types.h>
Jan Engelhardt3e8c54f2006-06-25 05:48:49 -070012#include <linux/major.h>
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070013
14/** Version number of this interface */
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070015#define FUSE_KERNEL_VERSION 7
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070016
17/** Minor version number of this interface */
Miklos Szeredie9168c12006-12-06 20:35:38 -080018#define FUSE_KERNEL_MINOR_VERSION 8
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070019
20/** The node ID of the root inode */
21#define FUSE_ROOT_ID 1
22
Miklos Szeredi334f4852005-09-09 13:10:27 -070023/** The major number of the fuse character device */
Jan Engelhardt3e8c54f2006-06-25 05:48:49 -070024#define FUSE_MAJOR MISC_MAJOR
Miklos Szeredi334f4852005-09-09 13:10:27 -070025
26/** The minor number of the fuse character device */
27#define FUSE_MINOR 229
28
Miklos Szeredi06663262005-09-09 13:10:32 -070029/* Make sure all structures are padded to 64bit boundary, so 32bit
30 userspace works under 64bit kernels */
31
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070032struct fuse_attr {
33 __u64 ino;
34 __u64 size;
35 __u64 blocks;
36 __u64 atime;
37 __u64 mtime;
38 __u64 ctime;
39 __u32 atimensec;
40 __u32 mtimensec;
41 __u32 ctimensec;
42 __u32 mode;
43 __u32 nlink;
44 __u32 uid;
45 __u32 gid;
46 __u32 rdev;
47};
48
Miklos Szeredie5e55582005-09-09 13:10:28 -070049struct fuse_kstatfs {
50 __u64 blocks;
51 __u64 bfree;
52 __u64 bavail;
53 __u64 files;
54 __u64 ffree;
55 __u32 bsize;
56 __u32 namelen;
Miklos Szeredide5f1202006-01-06 00:19:37 -080057 __u32 frsize;
58 __u32 padding;
59 __u32 spare[6];
Miklos Szeredie5e55582005-09-09 13:10:28 -070060};
61
Miklos Szeredi71421252006-06-25 05:48:52 -070062struct fuse_file_lock {
63 __u64 start;
64 __u64 end;
65 __u32 type;
66 __u32 pid; /* tgid */
67};
68
Miklos Szeredi9cd68452006-02-01 03:04:40 -080069/**
70 * Bitmasks for fuse_setattr_in.valid
71 */
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070072#define FATTR_MODE (1 << 0)
73#define FATTR_UID (1 << 1)
74#define FATTR_GID (1 << 2)
75#define FATTR_SIZE (1 << 3)
76#define FATTR_ATIME (1 << 4)
77#define FATTR_MTIME (1 << 5)
Miklos Szeredibefc6492005-11-07 00:59:52 -080078#define FATTR_FH (1 << 6)
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070079
Miklos Szeredi45323fb2005-09-09 13:10:37 -070080/**
81 * Flags returned by the OPEN request
82 *
83 * FOPEN_DIRECT_IO: bypass page cache for this open file
84 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
85 */
86#define FOPEN_DIRECT_IO (1 << 0)
87#define FOPEN_KEEP_CACHE (1 << 1)
88
Miklos Szeredi9cd68452006-02-01 03:04:40 -080089/**
90 * INIT request/reply flags
91 */
92#define FUSE_ASYNC_READ (1 << 0)
Miklos Szeredi71421252006-06-25 05:48:52 -070093#define FUSE_POSIX_LOCKS (1 << 1)
Miklos Szeredi9cd68452006-02-01 03:04:40 -080094
Miklos Szeredie9168c12006-12-06 20:35:38 -080095/**
96 * Release flags
97 */
98#define FUSE_RELEASE_FLUSH (1 << 0)
99
Miklos Szeredi334f4852005-09-09 13:10:27 -0700100enum fuse_opcode {
Miklos Szeredie5e55582005-09-09 13:10:28 -0700101 FUSE_LOOKUP = 1,
102 FUSE_FORGET = 2, /* no reply */
103 FUSE_GETATTR = 3,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700104 FUSE_SETATTR = 4,
Miklos Szeredie5e55582005-09-09 13:10:28 -0700105 FUSE_READLINK = 5,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700106 FUSE_SYMLINK = 6,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700107 FUSE_MKNOD = 8,
108 FUSE_MKDIR = 9,
109 FUSE_UNLINK = 10,
110 FUSE_RMDIR = 11,
111 FUSE_RENAME = 12,
112 FUSE_LINK = 13,
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700113 FUSE_OPEN = 14,
114 FUSE_READ = 15,
115 FUSE_WRITE = 16,
Miklos Szeredie5e55582005-09-09 13:10:28 -0700116 FUSE_STATFS = 17,
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700117 FUSE_RELEASE = 18,
118 FUSE_FSYNC = 20,
Miklos Szeredi92a87802005-09-09 13:10:31 -0700119 FUSE_SETXATTR = 21,
120 FUSE_GETXATTR = 22,
121 FUSE_LISTXATTR = 23,
122 FUSE_REMOVEXATTR = 24,
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700123 FUSE_FLUSH = 25,
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700124 FUSE_INIT = 26,
125 FUSE_OPENDIR = 27,
126 FUSE_READDIR = 28,
Miklos Szeredi82547982005-09-09 13:10:38 -0700127 FUSE_RELEASEDIR = 29,
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800128 FUSE_FSYNCDIR = 30,
Miklos Szeredi71421252006-06-25 05:48:52 -0700129 FUSE_GETLK = 31,
130 FUSE_SETLK = 32,
131 FUSE_SETLKW = 33,
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800132 FUSE_ACCESS = 34,
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700133 FUSE_CREATE = 35,
134 FUSE_INTERRUPT = 36,
Miklos Szeredib2d22722006-12-06 20:35:51 -0800135 FUSE_BMAP = 37,
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800136 FUSE_DESTROY = 38,
Miklos Szeredi334f4852005-09-09 13:10:27 -0700137};
138
Miklos Szeredi1d3d7522006-01-06 00:19:40 -0800139/* The read buffer is required to be at least 8k, but may be much larger */
140#define FUSE_MIN_READ_BUFFER 8192
Miklos Szeredie5e55582005-09-09 13:10:28 -0700141
142struct fuse_entry_out {
143 __u64 nodeid; /* Inode ID */
144 __u64 generation; /* Inode generation: nodeid:gen must
145 be unique for the fs's lifetime */
146 __u64 entry_valid; /* Cache timeout for the name */
147 __u64 attr_valid; /* Cache timeout for the attributes */
148 __u32 entry_valid_nsec;
149 __u32 attr_valid_nsec;
150 struct fuse_attr attr;
151};
152
153struct fuse_forget_in {
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700154 __u64 nlookup;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700155};
156
157struct fuse_attr_out {
158 __u64 attr_valid; /* Cache timeout for the attributes */
159 __u32 attr_valid_nsec;
160 __u32 dummy;
161 struct fuse_attr attr;
162};
163
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700164struct fuse_mknod_in {
165 __u32 mode;
166 __u32 rdev;
167};
168
169struct fuse_mkdir_in {
170 __u32 mode;
Miklos Szeredi06663262005-09-09 13:10:32 -0700171 __u32 padding;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700172};
173
174struct fuse_rename_in {
175 __u64 newdir;
176};
177
178struct fuse_link_in {
179 __u64 oldnodeid;
180};
181
182struct fuse_setattr_in {
183 __u32 valid;
Miklos Szeredi06663262005-09-09 13:10:32 -0700184 __u32 padding;
Miklos Szeredibefc6492005-11-07 00:59:52 -0800185 __u64 fh;
186 __u64 size;
187 __u64 unused1;
188 __u64 atime;
189 __u64 mtime;
190 __u64 unused2;
191 __u32 atimensec;
192 __u32 mtimensec;
193 __u32 unused3;
194 __u32 mode;
195 __u32 unused4;
196 __u32 uid;
197 __u32 gid;
198 __u32 unused5;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700199};
200
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700201struct fuse_open_in {
202 __u32 flags;
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800203 __u32 mode;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700204};
205
206struct fuse_open_out {
207 __u64 fh;
208 __u32 open_flags;
Miklos Szeredi06663262005-09-09 13:10:32 -0700209 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700210};
211
212struct fuse_release_in {
213 __u64 fh;
214 __u32 flags;
Miklos Szeredie9168c12006-12-06 20:35:38 -0800215 __u32 release_flags;
216 __u64 lock_owner;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700217};
218
219struct fuse_flush_in {
220 __u64 fh;
Miklos Szeredie9168c12006-12-06 20:35:38 -0800221 __u32 unused;
Miklos Szeredi06663262005-09-09 13:10:32 -0700222 __u32 padding;
Miklos Szeredi71421252006-06-25 05:48:52 -0700223 __u64 lock_owner;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700224};
225
226struct fuse_read_in {
227 __u64 fh;
228 __u64 offset;
229 __u32 size;
Miklos Szeredi06663262005-09-09 13:10:32 -0700230 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700231};
232
233struct fuse_write_in {
234 __u64 fh;
235 __u64 offset;
236 __u32 size;
237 __u32 write_flags;
238};
239
240struct fuse_write_out {
241 __u32 size;
Miklos Szeredi06663262005-09-09 13:10:32 -0700242 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700243};
244
Miklos Szeredide5f1202006-01-06 00:19:37 -0800245#define FUSE_COMPAT_STATFS_SIZE 48
246
Miklos Szeredie5e55582005-09-09 13:10:28 -0700247struct fuse_statfs_out {
248 struct fuse_kstatfs st;
249};
250
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700251struct fuse_fsync_in {
252 __u64 fh;
253 __u32 fsync_flags;
Miklos Szeredi06663262005-09-09 13:10:32 -0700254 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700255};
256
Miklos Szeredi92a87802005-09-09 13:10:31 -0700257struct fuse_setxattr_in {
258 __u32 size;
259 __u32 flags;
260};
261
262struct fuse_getxattr_in {
263 __u32 size;
Miklos Szeredi06663262005-09-09 13:10:32 -0700264 __u32 padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700265};
266
267struct fuse_getxattr_out {
268 __u32 size;
Miklos Szeredi06663262005-09-09 13:10:32 -0700269 __u32 padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700270};
271
Miklos Szeredi71421252006-06-25 05:48:52 -0700272struct fuse_lk_in {
273 __u64 fh;
274 __u64 owner;
275 struct fuse_file_lock lk;
276};
277
278struct fuse_lk_out {
279 struct fuse_file_lock lk;
280};
281
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800282struct fuse_access_in {
283 __u32 mask;
284 __u32 padding;
285};
286
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800287struct fuse_init_in {
Miklos Szeredi334f4852005-09-09 13:10:27 -0700288 __u32 major;
289 __u32 minor;
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800290 __u32 max_readahead;
291 __u32 flags;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700292};
293
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800294struct fuse_init_out {
295 __u32 major;
296 __u32 minor;
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800297 __u32 max_readahead;
298 __u32 flags;
299 __u32 unused;
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800300 __u32 max_write;
301};
302
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700303struct fuse_interrupt_in {
304 __u64 unique;
305};
306
Miklos Szeredib2d22722006-12-06 20:35:51 -0800307struct fuse_bmap_in {
308 __u64 block;
309 __u32 blocksize;
310 __u32 padding;
311};
312
313struct fuse_bmap_out {
314 __u64 block;
315};
316
Miklos Szeredi334f4852005-09-09 13:10:27 -0700317struct fuse_in_header {
318 __u32 len;
319 __u32 opcode;
320 __u64 unique;
321 __u64 nodeid;
322 __u32 uid;
323 __u32 gid;
324 __u32 pid;
Miklos Szeredi06663262005-09-09 13:10:32 -0700325 __u32 padding;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700326};
327
328struct fuse_out_header {
329 __u32 len;
330 __s32 error;
331 __u64 unique;
332};
333
Miklos Szeredie5e55582005-09-09 13:10:28 -0700334struct fuse_dirent {
335 __u64 ino;
336 __u64 off;
337 __u32 namelen;
338 __u32 type;
339 char name[0];
340};
341
Andrew Morton21f3da92007-07-15 23:39:50 -0700342#define FUSE_NAME_OFFSET offsetof(struct fuse_dirent, name)
Miklos Szeredie5e55582005-09-09 13:10:28 -0700343#define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
344#define FUSE_DIRENT_SIZE(d) \
345 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)