blob: 378791b47dc734c960811a5023a3accb71604b35 [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 Szeredie56818b2004-12-12 11:45:24 +000014#define FUSE_KERNEL_VERSION 5
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 Szeredi85c74fc2001-10-28 19:44:14 +000028struct fuse_attr {
Miklos Szeredi0f62d722005-01-04 12:45:54 +000029 __u64 ino;
30 __u64 size;
31 __u64 blocks;
32 __u64 atime;
33 __u64 mtime;
34 __u64 ctime;
35 __u32 atimensec;
36 __u32 mtimensec;
37 __u32 ctimensec;
38 __u32 mode;
39 __u32 nlink;
40 __u32 uid;
41 __u32 gid;
42 __u32 rdev;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000043};
44
Miklos Szeredi24ed9452002-10-07 10:24:26 +000045struct fuse_kstatfs {
Miklos Szeredi0f62d722005-01-04 12:45:54 +000046 __u64 blocks;
47 __u64 bfree;
48 __u64 bavail;
49 __u64 files;
50 __u64 ffree;
51 __u32 bsize;
52 __u32 namelen;
Miklos Szeredi24ed9452002-10-07 10:24:26 +000053};
54
Miklos Szeredi5e183482001-10-31 14:52:35 +000055#define FATTR_MODE (1 << 0)
56#define FATTR_UID (1 << 1)
57#define FATTR_GID (1 << 2)
58#define FATTR_SIZE (1 << 3)
Miklos Szeredib5958612004-02-20 14:10:49 +000059#define FATTR_ATIME (1 << 4)
60#define FATTR_MTIME (1 << 5)
61#define FATTR_CTIME (1 << 6)
Miklos Szeredi5e183482001-10-31 14:52:35 +000062
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000063enum fuse_opcode {
Miklos Szeredi3ed84232004-03-30 15:17:26 +000064 FUSE_LOOKUP = 1,
65 FUSE_FORGET = 2, /* no reply */
66 FUSE_GETATTR = 3,
67 FUSE_SETATTR = 4,
68 FUSE_READLINK = 5,
69 FUSE_SYMLINK = 6,
70 FUSE_GETDIR = 7,
71 FUSE_MKNOD = 8,
72 FUSE_MKDIR = 9,
73 FUSE_UNLINK = 10,
74 FUSE_RMDIR = 11,
75 FUSE_RENAME = 12,
76 FUSE_LINK = 13,
77 FUSE_OPEN = 14,
78 FUSE_READ = 15,
79 FUSE_WRITE = 16,
80 FUSE_STATFS = 17,
Miklos Szeredi72cf5c92004-11-20 16:10:30 +000081 FUSE_RELEASE = 18,
Miklos Szeredi3ed84232004-03-30 15:17:26 +000082 FUSE_FSYNC = 20,
83 FUSE_SETXATTR = 21,
84 FUSE_GETXATTR = 22,
85 FUSE_LISTXATTR = 23,
86 FUSE_REMOVEXATTR = 24,
Miklos Szeredie2e4ac22004-05-18 08:45:28 +000087 FUSE_FLUSH = 25,
Miklos Szeredi3f0005f2005-01-04 19:24:31 +000088 FUSE_INIT = 26
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000089};
90
91/* Conservative buffer size for the client */
92#define FUSE_MAX_IN 8192
93
Miklos Szeredic26c14d2004-04-09 17:48:32 +000094#define FUSE_NAME_MAX 1024
95#define FUSE_SYMLINK_MAX 4096
96#define FUSE_XATTR_SIZE_MAX 4096
97
Miklos Szeredi254d5ed2004-03-02 11:11:24 +000098struct fuse_entry_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +000099 __u64 nodeid; /* Inode ID */
100 __u64 generation; /* Inode generation: nodeid:gen must
101 be unique for the fs's lifetime */
102 __u64 entry_valid; /* Cache timeout for the name */
103 __u64 attr_valid; /* Cache timeout for the attributes */
104 __u32 entry_valid_nsec;
105 __u32 attr_valid_nsec;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000106 struct fuse_attr attr;
107};
108
Miklos Szeredia181e612001-11-06 12:03:23 +0000109struct fuse_forget_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000110 __u64 version;
Miklos Szeredia181e612001-11-06 12:03:23 +0000111};
112
Miklos Szeredi254d5ed2004-03-02 11:11:24 +0000113struct fuse_attr_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000114 __u64 attr_valid; /* Cache timeout for the attributes */
115 __u32 attr_valid_nsec;
116 __u32 dummy;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000117 struct fuse_attr attr;
118};
119
120struct fuse_getdir_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000121 __u32 fd;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000122};
123
124struct fuse_mknod_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000125 __u32 mode;
126 __u32 rdev;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000127};
128
Miklos Szeredib483c932001-10-29 14:57:57 +0000129struct fuse_mkdir_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000130 __u32 mode;
Miklos Szeredib483c932001-10-29 14:57:57 +0000131};
132
Miklos Szeredib483c932001-10-29 14:57:57 +0000133struct fuse_rename_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000134 __u64 newdir;
Miklos Szeredi19dff1b2001-10-30 15:06:52 +0000135};
136
137struct fuse_link_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000138 __u64 newdir;
Miklos Szeredib483c932001-10-29 14:57:57 +0000139};
140
Miklos Szeredi5e183482001-10-31 14:52:35 +0000141struct fuse_setattr_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000142 __u32 valid;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000143 struct fuse_attr attr;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000144};
145
146struct fuse_open_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000147 __u32 flags;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000148};
149
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000150struct fuse_open_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000151 __u64 fh;
152 __u32 open_flags;
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000153};
154
155struct fuse_release_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000156 __u64 fh;
157 __u32 flags;
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000158};
159
160struct fuse_flush_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000161 __u64 fh;
162 __u32 flush_flags;
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000163};
164
Miklos Szeredi5e183482001-10-31 14:52:35 +0000165struct fuse_read_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000166 __u64 fh;
167 __u64 offset;
168 __u32 size;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000169};
170
Miklos Szeredia181e612001-11-06 12:03:23 +0000171struct fuse_write_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000172 __u64 fh;
173 __u64 offset;
174 __u32 size;
175 __u32 write_flags;
Miklos Szeredia181e612001-11-06 12:03:23 +0000176};
177
Miklos Szerediad051c32004-07-02 09:22:50 +0000178struct fuse_write_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000179 __u32 size;
Miklos Szerediad051c32004-07-02 09:22:50 +0000180};
181
Mark Glinesd84b39a2002-01-07 16:32:02 +0000182struct fuse_statfs_out {
Miklos Szeredi24ed9452002-10-07 10:24:26 +0000183 struct fuse_kstatfs st;
Mark Glinesd84b39a2002-01-07 16:32:02 +0000184};
185
Miklos Szeredi5e43f2c2003-12-12 14:06:41 +0000186struct fuse_fsync_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000187 __u64 fh;
188 __u32 fsync_flags;
Miklos Szeredi5e43f2c2003-12-12 14:06:41 +0000189};
190
Miklos Szeredi3ed84232004-03-30 15:17:26 +0000191struct fuse_setxattr_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000192 __u32 size;
193 __u32 flags;
Miklos Szeredi3ed84232004-03-30 15:17:26 +0000194};
195
Miklos Szeredi03cebae2004-03-31 10:19:18 +0000196struct fuse_getxattr_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000197 __u32 size;
Miklos Szeredi03cebae2004-03-31 10:19:18 +0000198};
199
200struct fuse_getxattr_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000201 __u32 size;
Miklos Szeredi3ed84232004-03-30 15:17:26 +0000202};
203
Miklos Szeredi3f0005f2005-01-04 19:24:31 +0000204struct fuse_init_in_out {
205 __u32 major;
206 __u32 minor;
207};
208
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000209struct fuse_in_header {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000210 __u32 len;
211 __u32 opcode;
212 __u64 unique;
213 __u64 nodeid;
214 __u32 uid;
215 __u32 gid;
216 __u32 pid;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000217};
218
219struct fuse_out_header {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000220 __u32 len;
221 __s32 error;
222 __u64 unique;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000223};
224
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000225struct fuse_dirent {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000226 __u64 ino;
227 __u32 namelen;
228 __u32 type;
229 char name[0];
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000230};
231
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000232#define FUSE_NAME_OFFSET ((unsigned) ((struct fuse_dirent *) 0)->name)
233#define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000234#define FUSE_DIRENT_SIZE(d) \
235 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)