blob: 507913b65af02e61e59a551eba68818a4bc66cc3 [file] [log] [blame]
Miklos Szeredid8a5ba42005-09-09 13:10:26 -07001/*
2 FUSE: Filesystem in Userspace
3 Copyright (C) 2001-2005 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/* This file defines the kernel interface of FUSE */
10
11#include <asm/types.h>
12
13/** Version number of this interface */
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070014#define FUSE_KERNEL_VERSION 7
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070015
16/** Minor version number of this interface */
Miklos Szeredi5b620732005-11-07 00:59:49 -080017#define FUSE_KERNEL_MINOR_VERSION 3
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070018
19/** The node ID of the root inode */
20#define FUSE_ROOT_ID 1
21
Miklos Szeredi334f4852005-09-09 13:10:27 -070022/** The major number of the fuse character device */
23#define FUSE_MAJOR 10
24
25/** The minor number of the fuse character device */
26#define FUSE_MINOR 229
27
Miklos Szeredi06663262005-09-09 13:10:32 -070028/* Make sure all structures are padded to 64bit boundary, so 32bit
29 userspace works under 64bit kernels */
30
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070031struct fuse_attr {
32 __u64 ino;
33 __u64 size;
34 __u64 blocks;
35 __u64 atime;
36 __u64 mtime;
37 __u64 ctime;
38 __u32 atimensec;
39 __u32 mtimensec;
40 __u32 ctimensec;
41 __u32 mode;
42 __u32 nlink;
43 __u32 uid;
44 __u32 gid;
45 __u32 rdev;
46};
47
Miklos Szeredie5e55582005-09-09 13:10:28 -070048struct fuse_kstatfs {
49 __u64 blocks;
50 __u64 bfree;
51 __u64 bavail;
52 __u64 files;
53 __u64 ffree;
54 __u32 bsize;
55 __u32 namelen;
56};
57
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070058#define FATTR_MODE (1 << 0)
59#define FATTR_UID (1 << 1)
60#define FATTR_GID (1 << 2)
61#define FATTR_SIZE (1 << 3)
62#define FATTR_ATIME (1 << 4)
63#define FATTR_MTIME (1 << 5)
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070064
Miklos Szeredi45323fb2005-09-09 13:10:37 -070065/**
66 * Flags returned by the OPEN request
67 *
68 * FOPEN_DIRECT_IO: bypass page cache for this open file
69 * FOPEN_KEEP_CACHE: don't invalidate the data cache on open
70 */
71#define FOPEN_DIRECT_IO (1 << 0)
72#define FOPEN_KEEP_CACHE (1 << 1)
73
Miklos Szeredi334f4852005-09-09 13:10:27 -070074enum fuse_opcode {
Miklos Szeredie5e55582005-09-09 13:10:28 -070075 FUSE_LOOKUP = 1,
76 FUSE_FORGET = 2, /* no reply */
77 FUSE_GETATTR = 3,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070078 FUSE_SETATTR = 4,
Miklos Szeredie5e55582005-09-09 13:10:28 -070079 FUSE_READLINK = 5,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070080 FUSE_SYMLINK = 6,
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070081 FUSE_MKNOD = 8,
82 FUSE_MKDIR = 9,
83 FUSE_UNLINK = 10,
84 FUSE_RMDIR = 11,
85 FUSE_RENAME = 12,
86 FUSE_LINK = 13,
Miklos Szeredib6aeade2005-09-09 13:10:30 -070087 FUSE_OPEN = 14,
88 FUSE_READ = 15,
89 FUSE_WRITE = 16,
Miklos Szeredie5e55582005-09-09 13:10:28 -070090 FUSE_STATFS = 17,
Miklos Szeredib6aeade2005-09-09 13:10:30 -070091 FUSE_RELEASE = 18,
92 FUSE_FSYNC = 20,
Miklos Szeredi92a87802005-09-09 13:10:31 -070093 FUSE_SETXATTR = 21,
94 FUSE_GETXATTR = 22,
95 FUSE_LISTXATTR = 23,
96 FUSE_REMOVEXATTR = 24,
Miklos Szeredib6aeade2005-09-09 13:10:30 -070097 FUSE_FLUSH = 25,
Miklos Szeredi04730fe2005-09-09 13:10:36 -070098 FUSE_INIT = 26,
99 FUSE_OPENDIR = 27,
100 FUSE_READDIR = 28,
Miklos Szeredi82547982005-09-09 13:10:38 -0700101 FUSE_RELEASEDIR = 29,
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800102 FUSE_FSYNCDIR = 30,
103 FUSE_ACCESS = 34
Miklos Szeredi334f4852005-09-09 13:10:27 -0700104};
105
106/* Conservative buffer size for the client */
107#define FUSE_MAX_IN 8192
108
Miklos Szeredie5e55582005-09-09 13:10:28 -0700109#define FUSE_NAME_MAX 1024
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700110#define FUSE_SYMLINK_MAX 4096
Miklos Szeredi92a87802005-09-09 13:10:31 -0700111#define FUSE_XATTR_SIZE_MAX 4096
Miklos Szeredie5e55582005-09-09 13:10:28 -0700112
113struct fuse_entry_out {
114 __u64 nodeid; /* Inode ID */
115 __u64 generation; /* Inode generation: nodeid:gen must
116 be unique for the fs's lifetime */
117 __u64 entry_valid; /* Cache timeout for the name */
118 __u64 attr_valid; /* Cache timeout for the attributes */
119 __u32 entry_valid_nsec;
120 __u32 attr_valid_nsec;
121 struct fuse_attr attr;
122};
123
124struct fuse_forget_in {
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700125 __u64 nlookup;
Miklos Szeredie5e55582005-09-09 13:10:28 -0700126};
127
128struct fuse_attr_out {
129 __u64 attr_valid; /* Cache timeout for the attributes */
130 __u32 attr_valid_nsec;
131 __u32 dummy;
132 struct fuse_attr attr;
133};
134
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700135struct fuse_mknod_in {
136 __u32 mode;
137 __u32 rdev;
138};
139
140struct fuse_mkdir_in {
141 __u32 mode;
Miklos Szeredi06663262005-09-09 13:10:32 -0700142 __u32 padding;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700143};
144
145struct fuse_rename_in {
146 __u64 newdir;
147};
148
149struct fuse_link_in {
150 __u64 oldnodeid;
151};
152
153struct fuse_setattr_in {
154 __u32 valid;
Miklos Szeredi06663262005-09-09 13:10:32 -0700155 __u32 padding;
Miklos Szeredi9e6268d2005-09-09 13:10:29 -0700156 struct fuse_attr attr;
157};
158
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700159struct fuse_open_in {
160 __u32 flags;
Miklos Szeredi06663262005-09-09 13:10:32 -0700161 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700162};
163
164struct fuse_open_out {
165 __u64 fh;
166 __u32 open_flags;
Miklos Szeredi06663262005-09-09 13:10:32 -0700167 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700168};
169
170struct fuse_release_in {
171 __u64 fh;
172 __u32 flags;
Miklos Szeredi06663262005-09-09 13:10:32 -0700173 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700174};
175
176struct fuse_flush_in {
177 __u64 fh;
178 __u32 flush_flags;
Miklos Szeredi06663262005-09-09 13:10:32 -0700179 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700180};
181
182struct fuse_read_in {
183 __u64 fh;
184 __u64 offset;
185 __u32 size;
Miklos Szeredi06663262005-09-09 13:10:32 -0700186 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700187};
188
189struct fuse_write_in {
190 __u64 fh;
191 __u64 offset;
192 __u32 size;
193 __u32 write_flags;
194};
195
196struct fuse_write_out {
197 __u32 size;
Miklos Szeredi06663262005-09-09 13:10:32 -0700198 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700199};
200
Miklos Szeredie5e55582005-09-09 13:10:28 -0700201struct fuse_statfs_out {
202 struct fuse_kstatfs st;
203};
204
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700205struct fuse_fsync_in {
206 __u64 fh;
207 __u32 fsync_flags;
Miklos Szeredi06663262005-09-09 13:10:32 -0700208 __u32 padding;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700209};
210
Miklos Szeredi92a87802005-09-09 13:10:31 -0700211struct fuse_setxattr_in {
212 __u32 size;
213 __u32 flags;
214};
215
216struct fuse_getxattr_in {
217 __u32 size;
Miklos Szeredi06663262005-09-09 13:10:32 -0700218 __u32 padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700219};
220
221struct fuse_getxattr_out {
222 __u32 size;
Miklos Szeredi06663262005-09-09 13:10:32 -0700223 __u32 padding;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700224};
225
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800226struct fuse_access_in {
227 __u32 mask;
228 __u32 padding;
229};
230
Miklos Szeredi334f4852005-09-09 13:10:27 -0700231struct fuse_init_in_out {
232 __u32 major;
233 __u32 minor;
234};
235
236struct fuse_in_header {
237 __u32 len;
238 __u32 opcode;
239 __u64 unique;
240 __u64 nodeid;
241 __u32 uid;
242 __u32 gid;
243 __u32 pid;
Miklos Szeredi06663262005-09-09 13:10:32 -0700244 __u32 padding;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700245};
246
247struct fuse_out_header {
248 __u32 len;
249 __s32 error;
250 __u64 unique;
251};
252
Miklos Szeredie5e55582005-09-09 13:10:28 -0700253struct fuse_dirent {
254 __u64 ino;
255 __u64 off;
256 __u32 namelen;
257 __u32 type;
258 char name[0];
259};
260
261#define FUSE_NAME_OFFSET ((unsigned) ((struct fuse_dirent *) 0)->name)
262#define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
263#define FUSE_DIRENT_SIZE(d) \
264 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)