blob: 3c0696796ca6fef0999c0f765b0c60a4400fe1b2 [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 Szeredieab72ef2005-03-31 19:59:12 +000014#define FUSE_KERNEL_VERSION 6
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000015
Miklos Szeredi2f3d9402003-12-15 12:11:33 +000016/** Minor version number of this interface */
Miklos Szeredie56818b2004-12-12 11:45:24 +000017#define FUSE_KERNEL_MINOR_VERSION 1
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 Szeredi5e183482001-10-31 14:52:35 +000058#define FATTR_MODE (1 << 0)
59#define FATTR_UID (1 << 1)
60#define FATTR_GID (1 << 2)
61#define FATTR_SIZE (1 << 3)
Miklos Szeredib5958612004-02-20 14:10:49 +000062#define FATTR_ATIME (1 << 4)
63#define FATTR_MTIME (1 << 5)
64#define FATTR_CTIME (1 << 6)
Miklos Szeredi5e183482001-10-31 14:52:35 +000065
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000066enum fuse_opcode {
Miklos Szeredi3ed84232004-03-30 15:17:26 +000067 FUSE_LOOKUP = 1,
68 FUSE_FORGET = 2, /* no reply */
69 FUSE_GETATTR = 3,
70 FUSE_SETATTR = 4,
71 FUSE_READLINK = 5,
72 FUSE_SYMLINK = 6,
Miklos Szeredi3ed84232004-03-30 15:17:26 +000073 FUSE_MKNOD = 8,
74 FUSE_MKDIR = 9,
75 FUSE_UNLINK = 10,
76 FUSE_RMDIR = 11,
77 FUSE_RENAME = 12,
78 FUSE_LINK = 13,
79 FUSE_OPEN = 14,
80 FUSE_READ = 15,
81 FUSE_WRITE = 16,
82 FUSE_STATFS = 17,
Miklos Szeredi72cf5c92004-11-20 16:10:30 +000083 FUSE_RELEASE = 18,
Miklos Szeredi3ed84232004-03-30 15:17:26 +000084 FUSE_FSYNC = 20,
85 FUSE_SETXATTR = 21,
86 FUSE_GETXATTR = 22,
87 FUSE_LISTXATTR = 23,
88 FUSE_REMOVEXATTR = 24,
Miklos Szeredie2e4ac22004-05-18 08:45:28 +000089 FUSE_FLUSH = 25,
Miklos Szeredi3ead28e2005-01-18 21:23:41 +000090 FUSE_INIT = 26,
91 FUSE_OPENDIR = 27,
92 FUSE_READDIR = 28,
Miklos Szeredi4283ee72005-03-21 12:09:04 +000093 FUSE_RELEASEDIR = 29,
94 FUSE_FSYNCDIR = 30
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000095};
96
97/* Conservative buffer size for the client */
98#define FUSE_MAX_IN 8192
99
Miklos Szeredic26c14d2004-04-09 17:48:32 +0000100#define FUSE_NAME_MAX 1024
101#define FUSE_SYMLINK_MAX 4096
102#define FUSE_XATTR_SIZE_MAX 4096
103
Miklos Szeredi254d5ed2004-03-02 11:11:24 +0000104struct fuse_entry_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000105 __u64 nodeid; /* Inode ID */
106 __u64 generation; /* Inode generation: nodeid:gen must
107 be unique for the fs's lifetime */
108 __u64 entry_valid; /* Cache timeout for the name */
109 __u64 attr_valid; /* Cache timeout for the attributes */
110 __u32 entry_valid_nsec;
111 __u32 attr_valid_nsec;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000112 struct fuse_attr attr;
113};
114
Miklos Szeredia181e612001-11-06 12:03:23 +0000115struct fuse_forget_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000116 __u64 version;
Miklos Szeredia181e612001-11-06 12:03:23 +0000117};
118
Miklos Szeredi254d5ed2004-03-02 11:11:24 +0000119struct fuse_attr_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000120 __u64 attr_valid; /* Cache timeout for the attributes */
121 __u32 attr_valid_nsec;
122 __u32 dummy;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000123 struct fuse_attr attr;
124};
125
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000126struct fuse_mknod_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000127 __u32 mode;
128 __u32 rdev;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000129};
130
Miklos Szeredib483c932001-10-29 14:57:57 +0000131struct fuse_mkdir_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000132 __u32 mode;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000133 __u32 padding;
Miklos Szeredib483c932001-10-29 14:57:57 +0000134};
135
Miklos Szeredib483c932001-10-29 14:57:57 +0000136struct fuse_rename_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000137 __u64 newdir;
Miklos Szeredi19dff1b2001-10-30 15:06:52 +0000138};
139
140struct fuse_link_in {
Miklos Szeredied6b5dd2005-01-26 17:07:59 +0000141 __u64 oldnodeid;
Miklos Szeredib483c932001-10-29 14:57:57 +0000142};
143
Miklos Szeredi5e183482001-10-31 14:52:35 +0000144struct fuse_setattr_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000145 __u32 valid;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000146 __u32 padding;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000147 struct fuse_attr attr;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000148};
149
150struct fuse_open_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000151 __u32 flags;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000152 __u32 padding;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000153};
154
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000155struct fuse_open_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000156 __u64 fh;
157 __u32 open_flags;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000158 __u32 padding;
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000159};
160
161struct fuse_release_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000162 __u64 fh;
163 __u32 flags;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000164 __u32 padding;
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000165};
166
167struct fuse_flush_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000168 __u64 fh;
169 __u32 flush_flags;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000170 __u32 padding;
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000171};
172
Miklos Szeredi5e183482001-10-31 14:52:35 +0000173struct fuse_read_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000174 __u64 fh;
175 __u64 offset;
176 __u32 size;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000177 __u32 padding;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000178};
179
Miklos Szeredia181e612001-11-06 12:03:23 +0000180struct fuse_write_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000181 __u64 fh;
182 __u64 offset;
183 __u32 size;
184 __u32 write_flags;
Miklos Szeredia181e612001-11-06 12:03:23 +0000185};
186
Miklos Szerediad051c32004-07-02 09:22:50 +0000187struct fuse_write_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000188 __u32 size;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000189 __u32 padding;
Miklos Szerediad051c32004-07-02 09:22:50 +0000190};
191
Mark Glinesd84b39a2002-01-07 16:32:02 +0000192struct fuse_statfs_out {
Miklos Szeredi24ed9452002-10-07 10:24:26 +0000193 struct fuse_kstatfs st;
Mark Glinesd84b39a2002-01-07 16:32:02 +0000194};
195
Miklos Szeredi5e43f2c2003-12-12 14:06:41 +0000196struct fuse_fsync_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000197 __u64 fh;
198 __u32 fsync_flags;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000199 __u32 padding;
Miklos Szeredi5e43f2c2003-12-12 14:06:41 +0000200};
201
Miklos Szeredi3ed84232004-03-30 15:17:26 +0000202struct fuse_setxattr_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000203 __u32 size;
204 __u32 flags;
Miklos Szeredi3ed84232004-03-30 15:17:26 +0000205};
206
Miklos Szeredi03cebae2004-03-31 10:19:18 +0000207struct fuse_getxattr_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000208 __u32 size;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000209 __u32 padding;
Miklos Szeredi03cebae2004-03-31 10:19:18 +0000210};
211
212struct fuse_getxattr_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000213 __u32 size;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000214 __u32 padding;
Miklos Szeredi3ed84232004-03-30 15:17:26 +0000215};
216
Miklos Szeredi3f0005f2005-01-04 19:24:31 +0000217struct fuse_init_in_out {
218 __u32 major;
219 __u32 minor;
220};
221
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000222struct fuse_in_header {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000223 __u32 len;
224 __u32 opcode;
225 __u64 unique;
226 __u64 nodeid;
227 __u32 uid;
228 __u32 gid;
229 __u32 pid;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000230 __u32 padding;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000231};
232
233struct fuse_out_header {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000234 __u32 len;
235 __s32 error;
236 __u64 unique;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000237};
238
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000239struct fuse_dirent {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000240 __u64 ino;
Miklos Szeredieab72ef2005-03-31 19:59:12 +0000241 __u64 off;
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000242 __u32 namelen;
243 __u32 type;
244 char name[0];
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000245};
246
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000247#define FUSE_NAME_OFFSET ((unsigned) ((struct fuse_dirent *) 0)->name)
248#define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000249#define FUSE_DIRENT_SIZE(d) \
250 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)