blob: 7f241e6a6052d427215a988c3a7c086f786bda73 [file] [log] [blame]
Miklos Szeredi85c74fc2001-10-28 19:44:14 +00001/*
2 FUSE: Filesystem in Userspace
3 Copyright (C) 2001 Miklos Szeredi (mszeredi@inf.bme.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
Miklos Szeredi8cffdb92001-11-09 14:49:18 +000011/** Version number of this interface */
Miklos Szeredi18e75e42004-02-19 14:23:27 +000012#define FUSE_KERNEL_VERSION 3
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000013
Miklos Szeredi2f3d9402003-12-15 12:11:33 +000014/** Minor version number of this interface */
Miklos Szeredi18e75e42004-02-19 14:23:27 +000015#define FUSE_KERNEL_MINOR_VERSION 1
Miklos Szeredi2f3d9402003-12-15 12:11:33 +000016
Miklos Szeredi8cffdb92001-11-09 14:49:18 +000017/** The inode number of the root indode */
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000018#define FUSE_ROOT_INO 1
19
Miklos Szeredi8cffdb92001-11-09 14:49:18 +000020/** Opening this will yield a new control file */
21#define FUSE_DEV "/proc/fs/fuse/dev"
22
Miklos Szeredic40748a2004-02-20 16:38:45 +000023/** The file containing the version in the form MAJOR.MINOR */
24#define FUSE_VERSION_FILE "/proc/fs/fuse/version"
25
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000026struct fuse_attr {
Miklos Szeredi5e183482001-10-31 14:52:35 +000027 unsigned int mode;
28 unsigned int nlink;
29 unsigned int uid;
30 unsigned int gid;
31 unsigned int rdev;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000032 unsigned long long size;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000033 unsigned long blocks;
34 unsigned long atime;
Miklos Szeredib5958612004-02-20 14:10:49 +000035 unsigned long atimensec;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000036 unsigned long mtime;
Miklos Szeredib5958612004-02-20 14:10:49 +000037 unsigned long mtimensec;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000038 unsigned long ctime;
Miklos Szeredib5958612004-02-20 14:10:49 +000039 unsigned long ctimensec;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000040};
41
Miklos Szeredi24ed9452002-10-07 10:24:26 +000042struct fuse_kstatfs {
Miklos Szeredi18e75e42004-02-19 14:23:27 +000043 unsigned int bsize;
44 unsigned long long blocks;
45 unsigned long long bfree;
46 unsigned long long bavail;
47 unsigned long long files;
48 unsigned long long ffree;
49 unsigned int namelen;
Miklos Szeredi24ed9452002-10-07 10:24:26 +000050};
51
Miklos Szeredi5e183482001-10-31 14:52:35 +000052#define FATTR_MODE (1 << 0)
53#define FATTR_UID (1 << 1)
54#define FATTR_GID (1 << 2)
55#define FATTR_SIZE (1 << 3)
Miklos Szeredib5958612004-02-20 14:10:49 +000056#define FATTR_ATIME (1 << 4)
57#define FATTR_MTIME (1 << 5)
58#define FATTR_CTIME (1 << 6)
Miklos Szeredi5e183482001-10-31 14:52:35 +000059
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000060enum fuse_opcode {
Miklos Szeredi3ed84232004-03-30 15:17:26 +000061 FUSE_LOOKUP = 1,
62 FUSE_FORGET = 2, /* no reply */
63 FUSE_GETATTR = 3,
64 FUSE_SETATTR = 4,
65 FUSE_READLINK = 5,
66 FUSE_SYMLINK = 6,
67 FUSE_GETDIR = 7,
68 FUSE_MKNOD = 8,
69 FUSE_MKDIR = 9,
70 FUSE_UNLINK = 10,
71 FUSE_RMDIR = 11,
72 FUSE_RENAME = 12,
73 FUSE_LINK = 13,
74 FUSE_OPEN = 14,
75 FUSE_READ = 15,
76 FUSE_WRITE = 16,
77 FUSE_STATFS = 17,
78 FUSE_RELEASE = 18, /* no reply */
79 FUSE_INVALIDATE = 19, /* user initiated */
80 FUSE_FSYNC = 20,
81 FUSE_SETXATTR = 21,
82 FUSE_GETXATTR = 22,
83 FUSE_LISTXATTR = 23,
84 FUSE_REMOVEXATTR = 24,
Miklos Szeredie2e4ac22004-05-18 08:45:28 +000085 FUSE_FLUSH = 25,
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000086};
87
88/* Conservative buffer size for the client */
89#define FUSE_MAX_IN 8192
90
Miklos Szeredic26c14d2004-04-09 17:48:32 +000091#define FUSE_NAME_MAX 1024
92#define FUSE_SYMLINK_MAX 4096
93#define FUSE_XATTR_SIZE_MAX 4096
94
Miklos Szeredi254d5ed2004-03-02 11:11:24 +000095struct fuse_entry_out {
96 unsigned long ino; /* Inode number */
97 unsigned long generation; /* Inode generation: ino:gen must
98 be unique for the fs's lifetime */
99 unsigned long entry_valid; /* Cache timeout for the name */
100 unsigned long entry_valid_nsec;
101 unsigned long attr_valid; /* Cache timeout for the attributes */
102 unsigned long attr_valid_nsec;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000103 struct fuse_attr attr;
104};
105
Miklos Szeredia181e612001-11-06 12:03:23 +0000106struct fuse_forget_in {
107 int version;
108};
109
Miklos Szeredi254d5ed2004-03-02 11:11:24 +0000110struct fuse_attr_out {
111 unsigned long attr_valid; /* Cache timeout for the attributes */
112 unsigned long attr_valid_nsec;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000113 struct fuse_attr attr;
114};
115
116struct fuse_getdir_out {
117 int fd;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000118};
119
120struct fuse_mknod_in {
Miklos Szeredi76f65782004-02-19 16:55:40 +0000121 unsigned int mode;
122 unsigned int rdev;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000123};
124
Miklos Szeredib483c932001-10-29 14:57:57 +0000125struct fuse_mkdir_in {
Miklos Szeredi76f65782004-02-19 16:55:40 +0000126 unsigned int mode;
Miklos Szeredib483c932001-10-29 14:57:57 +0000127};
128
Miklos Szeredib483c932001-10-29 14:57:57 +0000129struct fuse_rename_in {
130 unsigned long newdir;
Miklos Szeredi19dff1b2001-10-30 15:06:52 +0000131};
132
133struct fuse_link_in {
134 unsigned long newdir;
Miklos Szeredib483c932001-10-29 14:57:57 +0000135};
136
Miklos Szeredi5e183482001-10-31 14:52:35 +0000137struct fuse_setattr_in {
138 struct fuse_attr attr;
139 unsigned int valid;
140};
141
142struct fuse_open_in {
143 unsigned int flags;
144};
145
146struct fuse_read_in {
147 unsigned long long offset;
148 unsigned int size;
149};
150
Miklos Szeredia181e612001-11-06 12:03:23 +0000151struct fuse_write_in {
152 unsigned long long offset;
153 unsigned int size;
Miklos Szeredia181e612001-11-06 12:03:23 +0000154};
155
Miklos Szerediad051c32004-07-02 09:22:50 +0000156struct fuse_write_out {
157 unsigned int size;
158};
159
Mark Glinesd84b39a2002-01-07 16:32:02 +0000160struct fuse_statfs_out {
Miklos Szeredi24ed9452002-10-07 10:24:26 +0000161 struct fuse_kstatfs st;
Mark Glinesd84b39a2002-01-07 16:32:02 +0000162};
163
Miklos Szeredi5e43f2c2003-12-12 14:06:41 +0000164struct fuse_fsync_in {
165 int datasync;
166};
167
Miklos Szeredi3ed84232004-03-30 15:17:26 +0000168struct fuse_setxattr_in {
169 unsigned int size;
170 unsigned int flags;
171};
172
Miklos Szeredi03cebae2004-03-31 10:19:18 +0000173struct fuse_getxattr_in {
174 unsigned int size;
175};
176
177struct fuse_getxattr_out {
Miklos Szeredi3ed84232004-03-30 15:17:26 +0000178 unsigned int size;
179};
180
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000181struct fuse_in_header {
182 int unique;
183 enum fuse_opcode opcode;
Miklos Szeredib483c932001-10-29 14:57:57 +0000184 unsigned long ino;
Miklos Szeredife25def2001-12-20 15:38:05 +0000185 unsigned int uid;
186 unsigned int gid;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000187};
188
189struct fuse_out_header {
190 int unique;
Miklos Szeredi19dff1b2001-10-30 15:06:52 +0000191 int error;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000192};
193
Miklos Szeredida4e4862003-09-08 11:14:11 +0000194struct fuse_user_header {
195 int unique; /* zero */
196 enum fuse_opcode opcode;
197 unsigned long ino;
198};
199
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000200struct fuse_dirent {
201 unsigned long ino;
202 unsigned short namelen;
203 unsigned char type;
204 char name[256];
205};
206
207#define FUSE_NAME_OFFSET ((unsigned int) ((struct fuse_dirent *) 0)->name)
208#define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(long) - 1) & ~(sizeof(long) - 1))
209#define FUSE_DIRENT_SIZE(d) \
210 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)
211
212/*
213 * Local Variables:
214 * indent-tabs-mode: t
215 * c-basic-offset: 8
216 * End:
217 */