blob: e1d8a0c8638fffbb2adbe2ac441c19a1041a47f1 [file] [log] [blame]
Miklos Szeredi85c74fc2001-10-28 19:44:14 +00001/*
2 FUSE: Filesystem in Userspace
Miklos Szeredi149f6072005-01-10 12:29:28 +00003 Copyright (C) 2001-2005 Miklos Szeredi <miklos@szeredi.hu>
Miklos Szeredi85c74fc2001-10-28 19:44:14 +00004
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 Szeredi0f62d722005-01-04 12:45:54 +000011#include <asm/types.h>
12
Miklos Szeredi8cffdb92001-11-09 14:49:18 +000013/** Version number of this interface */
Miklos Szeredi38009022005-05-08 19:47:22 +000014#define FUSE_KERNEL_VERSION 7
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000015
Miklos Szeredi2f3d9402003-12-15 12:11:33 +000016/** Minor version number of this interface */
Miklos Szeredie3b83092005-07-22 17:24:30 +000017#define FUSE_KERNEL_MINOR_VERSION 2
Miklos Szeredi2f3d9402003-12-15 12:11:33 +000018
Miklos Szeredia13d9002004-11-02 17:32:03 +000019/** The node ID of the root inode */
20#define FUSE_ROOT_ID 1
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000021
Miklos Szeredia25d4c22004-11-23 22:32:16 +000022/** 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 Szeredieab72ef2005-03-31 19:59:12 +000028/* Make sure all structures are padded to 64bit boundary, so 32bit
29 userspace works under 64bit kernels */
30
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000031struct fuse_attr {
Miklos Szeredi0f62d722005-01-04 12:45:54 +000032 __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;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000046};
47
Miklos Szeredi24ed9452002-10-07 10:24:26 +000048struct fuse_kstatfs {
Miklos Szeredi0f62d722005-01-04 12:45:54 +000049 __u64 blocks;
50 __u64 bfree;
51 __u64 bavail;
52 __u64 files;
53 __u64 ffree;
54 __u32 bsize;
55 __u32 namelen;
Miklos Szeredi24ed9452002-10-07 10:24:26 +000056};
57
Miklos Szeredie3b83092005-07-22 17:24:30 +000058struct fuse_file_lock {
59 __u64 start;
60 __u64 end;
61 __u64 owner;
62 __u32 pid;
63 __u32 type;
64};
65
Miklos Szeredi5e183482001-10-31 14:52:35 +000066#define FATTR_MODE (1 << 0)
67#define FATTR_UID (1 << 1)
68#define FATTR_GID (1 << 2)
69#define FATTR_SIZE (1 << 3)
Miklos Szeredib5958612004-02-20 14:10:49 +000070#define FATTR_ATIME (1 << 4)
71#define FATTR_MTIME (1 << 5)
72#define FATTR_CTIME (1 << 6)
Miklos Szeredi5e183482001-10-31 14:52:35 +000073
Miklos Szeredie77cc072005-08-01 11:58:51 +000074#define FOPEN_DIRECT_IO (1 << 0)
75#define FOPEN_KEEP_CACHE (1 << 1)
76
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000077enum fuse_opcode {
Miklos Szeredi3ed84232004-03-30 15:17:26 +000078 FUSE_LOOKUP = 1,
79 FUSE_FORGET = 2, /* no reply */
80 FUSE_GETATTR = 3,
81 FUSE_SETATTR = 4,
82 FUSE_READLINK = 5,
83 FUSE_SYMLINK = 6,
Miklos Szeredi3ed84232004-03-30 15:17:26 +000084 FUSE_MKNOD = 8,
85 FUSE_MKDIR = 9,
86 FUSE_UNLINK = 10,
87 FUSE_RMDIR = 11,
88 FUSE_RENAME = 12,
89 FUSE_LINK = 13,
90 FUSE_OPEN = 14,
91 FUSE_READ = 15,
92 FUSE_WRITE = 16,
93 FUSE_STATFS = 17,
Miklos Szeredi72cf5c92004-11-20 16:10:30 +000094 FUSE_RELEASE = 18,
Miklos Szeredi3ed84232004-03-30 15:17:26 +000095 FUSE_FSYNC = 20,
96 FUSE_SETXATTR = 21,
97 FUSE_GETXATTR = 22,
98 FUSE_LISTXATTR = 23,
99 FUSE_REMOVEXATTR = 24,
Miklos Szeredie2e4ac22004-05-18 08:45:28 +0000100 FUSE_FLUSH = 25,
Miklos Szeredi3ead28e2005-01-18 21:23:41 +0000101 FUSE_INIT = 26,
102 FUSE_OPENDIR = 27,
103 FUSE_READDIR = 28,
Miklos Szeredi4283ee72005-03-21 12:09:04 +0000104 FUSE_RELEASEDIR = 29,
Miklos Szeredie3b83092005-07-22 17:24:30 +0000105 FUSE_FSYNCDIR = 30,
106 FUSE_GETLK = 31,
107 FUSE_SETLK = 32,
Miklos Szeredi7b28eae2005-08-01 12:48:30 +0000108 FUSE_SETLKW = 33,
Miklos Szeredib0c52c52005-08-23 15:39:43 +0000109 FUSE_ACCESS = 34,
Miklos Szerediecce1bf2005-08-25 15:19:06 +0000110 FUSE_CREATE = 35,
111 FUSE_FSETATTR = 36
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000112};
113
114/* Conservative buffer size for the client */
115#define FUSE_MAX_IN 8192
116
Miklos Szeredic26c14d2004-04-09 17:48:32 +0000117#define FUSE_NAME_MAX 1024
118#define FUSE_SYMLINK_MAX 4096
119#define FUSE_XATTR_SIZE_MAX 4096
120
Miklos Szeredi254d5ed2004-03-02 11:11:24 +0000121struct fuse_entry_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000122 __u64 nodeid; /* Inode ID */
123 __u64 generation; /* Inode generation: nodeid:gen must
124 be unique for the fs's lifetime */
125 __u64 entry_valid; /* Cache timeout for the name */
126 __u64 attr_valid; /* Cache timeout for the attributes */
127 __u32 entry_valid_nsec;
128 __u32 attr_valid_nsec;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000129 struct fuse_attr attr;
130};
131
Miklos Szeredia181e612001-11-06 12:03:23 +0000132struct fuse_forget_in {
Miklos Szeredi38009022005-05-08 19:47:22 +0000133 __u64 nlookup;
Miklos Szeredia181e612001-11-06 12:03:23 +0000134};
135
Miklos Szeredi254d5ed2004-03-02 11:11:24 +0000136struct fuse_attr_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000137 __u64 attr_valid; /* Cache timeout for the attributes */
138 __u32 attr_valid_nsec;
139 __u32 dummy;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000140 struct fuse_attr attr;
141};
142
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000143struct fuse_mknod_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000144 __u32 mode;
145 __u32 rdev;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000146};
147
Miklos Szeredib483c932001-10-29 14:57:57 +0000148struct fuse_mkdir_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000149 __u32 mode;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000150 __u32 padding;
Miklos Szeredib483c932001-10-29 14:57:57 +0000151};
152
Miklos Szeredib483c932001-10-29 14:57:57 +0000153struct fuse_rename_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000154 __u64 newdir;
Miklos Szeredi19dff1b2001-10-30 15:06:52 +0000155};
156
157struct fuse_link_in {
Miklos Szeredied6b5dd2005-01-26 17:07:59 +0000158 __u64 oldnodeid;
Miklos Szeredib483c932001-10-29 14:57:57 +0000159};
160
Miklos Szeredi5e183482001-10-31 14:52:35 +0000161struct fuse_setattr_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000162 __u32 valid;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000163 __u32 padding;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000164 struct fuse_attr attr;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000165};
166
Miklos Szerediecce1bf2005-08-25 15:19:06 +0000167struct fuse_fsetattr_in {
168 __u64 fh;
169 struct fuse_setattr_in setattr;
170};
171
Miklos Szeredi5e183482001-10-31 14:52:35 +0000172struct fuse_open_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000173 __u32 flags;
Miklos Szeredib0c52c52005-08-23 15:39:43 +0000174 __u32 mode;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000175};
176
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000177struct fuse_open_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000178 __u64 fh;
179 __u32 open_flags;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000180 __u32 padding;
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000181};
182
183struct fuse_release_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000184 __u64 fh;
185 __u32 flags;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000186 __u32 padding;
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000187};
188
189struct fuse_flush_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000190 __u64 fh;
191 __u32 flush_flags;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000192 __u32 padding;
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000193};
194
Miklos Szeredi5e183482001-10-31 14:52:35 +0000195struct fuse_read_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000196 __u64 fh;
197 __u64 offset;
198 __u32 size;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000199 __u32 padding;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000200};
201
Miklos Szeredia181e612001-11-06 12:03:23 +0000202struct fuse_write_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000203 __u64 fh;
204 __u64 offset;
205 __u32 size;
206 __u32 write_flags;
Miklos Szeredia181e612001-11-06 12:03:23 +0000207};
208
Miklos Szerediad051c32004-07-02 09:22:50 +0000209struct fuse_write_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000210 __u32 size;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000211 __u32 padding;
Miklos Szerediad051c32004-07-02 09:22:50 +0000212};
213
Mark Glinesd84b39a2002-01-07 16:32:02 +0000214struct fuse_statfs_out {
Miklos Szeredi24ed9452002-10-07 10:24:26 +0000215 struct fuse_kstatfs st;
Mark Glinesd84b39a2002-01-07 16:32:02 +0000216};
217
Miklos Szeredi5e43f2c2003-12-12 14:06:41 +0000218struct fuse_fsync_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000219 __u64 fh;
220 __u32 fsync_flags;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000221 __u32 padding;
Miklos Szeredi5e43f2c2003-12-12 14:06:41 +0000222};
223
Miklos Szeredi3ed84232004-03-30 15:17:26 +0000224struct fuse_setxattr_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000225 __u32 size;
226 __u32 flags;
Miklos Szeredi3ed84232004-03-30 15:17:26 +0000227};
228
Miklos Szeredi03cebae2004-03-31 10:19:18 +0000229struct fuse_getxattr_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000230 __u32 size;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000231 __u32 padding;
Miklos Szeredi03cebae2004-03-31 10:19:18 +0000232};
233
234struct fuse_getxattr_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000235 __u32 size;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000236 __u32 padding;
Miklos Szeredi3ed84232004-03-30 15:17:26 +0000237};
238
Miklos Szeredie3b83092005-07-22 17:24:30 +0000239struct fuse_lk_in_out {
240 struct fuse_file_lock lk;
241};
242
Miklos Szeredi7b28eae2005-08-01 12:48:30 +0000243struct fuse_access_in {
244 __u32 mask;
245 __u32 padding;
246};
247
Miklos Szeredi3f0005f2005-01-04 19:24:31 +0000248struct fuse_init_in_out {
249 __u32 major;
250 __u32 minor;
251};
252
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000253struct fuse_in_header {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000254 __u32 len;
255 __u32 opcode;
256 __u64 unique;
257 __u64 nodeid;
258 __u32 uid;
259 __u32 gid;
260 __u32 pid;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000261 __u32 padding;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000262};
263
264struct fuse_out_header {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000265 __u32 len;
266 __s32 error;
267 __u64 unique;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000268};
269
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000270struct fuse_dirent {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000271 __u64 ino;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000272 __u64 off;
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000273 __u32 namelen;
274 __u32 type;
275 char name[0];
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000276};
277
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000278#define FUSE_NAME_OFFSET ((unsigned) ((struct fuse_dirent *) 0)->name)
279#define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000280#define FUSE_DIRENT_SIZE(d) \
281 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)