blob: 2f313eb872c8abda7cacba4ed2622463567f6fc0 [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,
Miklos Szeredi3ed84232004-03-30 15:17:26 +000070 FUSE_MKNOD = 8,
71 FUSE_MKDIR = 9,
72 FUSE_UNLINK = 10,
73 FUSE_RMDIR = 11,
74 FUSE_RENAME = 12,
75 FUSE_LINK = 13,
76 FUSE_OPEN = 14,
77 FUSE_READ = 15,
78 FUSE_WRITE = 16,
79 FUSE_STATFS = 17,
Miklos Szeredi72cf5c92004-11-20 16:10:30 +000080 FUSE_RELEASE = 18,
Miklos Szeredi3ed84232004-03-30 15:17:26 +000081 FUSE_FSYNC = 20,
82 FUSE_SETXATTR = 21,
83 FUSE_GETXATTR = 22,
84 FUSE_LISTXATTR = 23,
85 FUSE_REMOVEXATTR = 24,
Miklos Szeredie2e4ac22004-05-18 08:45:28 +000086 FUSE_FLUSH = 25,
Miklos Szeredi3ead28e2005-01-18 21:23:41 +000087 FUSE_INIT = 26,
88 FUSE_OPENDIR = 27,
89 FUSE_READDIR = 28,
Miklos Szeredi4283ee72005-03-21 12:09:04 +000090 FUSE_RELEASEDIR = 29,
91 FUSE_FSYNCDIR = 30
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000092};
93
94/* Conservative buffer size for the client */
95#define FUSE_MAX_IN 8192
96
Miklos Szeredic26c14d2004-04-09 17:48:32 +000097#define FUSE_NAME_MAX 1024
98#define FUSE_SYMLINK_MAX 4096
99#define FUSE_XATTR_SIZE_MAX 4096
100
Miklos Szeredi254d5ed2004-03-02 11:11:24 +0000101struct fuse_entry_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000102 __u64 nodeid; /* Inode ID */
103 __u64 generation; /* Inode generation: nodeid:gen must
104 be unique for the fs's lifetime */
105 __u64 entry_valid; /* Cache timeout for the name */
106 __u64 attr_valid; /* Cache timeout for the attributes */
107 __u32 entry_valid_nsec;
108 __u32 attr_valid_nsec;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000109 struct fuse_attr attr;
110};
111
Miklos Szeredia181e612001-11-06 12:03:23 +0000112struct fuse_forget_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000113 __u64 version;
Miklos Szeredia181e612001-11-06 12:03:23 +0000114};
115
Miklos Szeredi254d5ed2004-03-02 11:11:24 +0000116struct fuse_attr_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000117 __u64 attr_valid; /* Cache timeout for the attributes */
118 __u32 attr_valid_nsec;
119 __u32 dummy;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000120 struct fuse_attr attr;
121};
122
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000123struct fuse_mknod_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000124 __u32 mode;
125 __u32 rdev;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000126};
127
Miklos Szeredib483c932001-10-29 14:57:57 +0000128struct fuse_mkdir_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000129 __u32 mode;
Miklos Szeredib483c932001-10-29 14:57:57 +0000130};
131
Miklos Szeredib483c932001-10-29 14:57:57 +0000132struct fuse_rename_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000133 __u64 newdir;
Miklos Szeredi19dff1b2001-10-30 15:06:52 +0000134};
135
136struct fuse_link_in {
Miklos Szeredied6b5dd2005-01-26 17:07:59 +0000137 __u64 oldnodeid;
Miklos Szeredib483c932001-10-29 14:57:57 +0000138};
139
Miklos Szeredi5e183482001-10-31 14:52:35 +0000140struct fuse_setattr_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000141 __u32 valid;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000142 struct fuse_attr attr;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000143};
144
145struct fuse_open_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000146 __u32 flags;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000147};
148
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000149struct fuse_open_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000150 __u64 fh;
151 __u32 open_flags;
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000152};
153
154struct fuse_release_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000155 __u64 fh;
156 __u32 flags;
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000157};
158
159struct fuse_flush_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000160 __u64 fh;
161 __u32 flush_flags;
Miklos Szeredi209f5d02004-07-24 19:56:16 +0000162};
163
Miklos Szeredi5e183482001-10-31 14:52:35 +0000164struct fuse_read_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000165 __u64 fh;
166 __u64 offset;
167 __u32 size;
Miklos Szeredi5e183482001-10-31 14:52:35 +0000168};
169
Miklos Szeredia181e612001-11-06 12:03:23 +0000170struct fuse_write_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000171 __u64 fh;
172 __u64 offset;
173 __u32 size;
174 __u32 write_flags;
Miklos Szeredia181e612001-11-06 12:03:23 +0000175};
176
Miklos Szerediad051c32004-07-02 09:22:50 +0000177struct fuse_write_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000178 __u32 size;
Miklos Szerediad051c32004-07-02 09:22:50 +0000179};
180
Mark Glinesd84b39a2002-01-07 16:32:02 +0000181struct fuse_statfs_out {
Miklos Szeredi24ed9452002-10-07 10:24:26 +0000182 struct fuse_kstatfs st;
Mark Glinesd84b39a2002-01-07 16:32:02 +0000183};
184
Miklos Szeredi5e43f2c2003-12-12 14:06:41 +0000185struct fuse_fsync_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000186 __u64 fh;
187 __u32 fsync_flags;
Miklos Szeredi5e43f2c2003-12-12 14:06:41 +0000188};
189
Miklos Szeredi3ed84232004-03-30 15:17:26 +0000190struct fuse_setxattr_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000191 __u32 size;
192 __u32 flags;
Miklos Szeredi3ed84232004-03-30 15:17:26 +0000193};
194
Miklos Szeredi03cebae2004-03-31 10:19:18 +0000195struct fuse_getxattr_in {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000196 __u32 size;
Miklos Szeredi03cebae2004-03-31 10:19:18 +0000197};
198
199struct fuse_getxattr_out {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000200 __u32 size;
Miklos Szeredi3ed84232004-03-30 15:17:26 +0000201};
202
Miklos Szeredi3f0005f2005-01-04 19:24:31 +0000203struct fuse_init_in_out {
204 __u32 major;
205 __u32 minor;
206};
207
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000208struct fuse_in_header {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000209 __u32 len;
210 __u32 opcode;
211 __u64 unique;
212 __u64 nodeid;
213 __u32 uid;
214 __u32 gid;
215 __u32 pid;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000216};
217
218struct fuse_out_header {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000219 __u32 len;
220 __s32 error;
221 __u64 unique;
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000222};
223
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000224struct fuse_dirent {
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000225 __u64 ino;
226 __u32 namelen;
227 __u32 type;
228 char name[0];
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000229};
230
Miklos Szeredi0f62d722005-01-04 12:45:54 +0000231#define FUSE_NAME_OFFSET ((unsigned) ((struct fuse_dirent *) 0)->name)
232#define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(__u64) - 1) & ~(sizeof(__u64) - 1))
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000233#define FUSE_DIRENT_SIZE(d) \
234 FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen)