Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 1 | /* |
| 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 Szeredi | 8cffdb9 | 2001-11-09 14:49:18 +0000 | [diff] [blame] | 11 | /** Version number of this interface */ |
Miklos Szeredi | 18e75e4 | 2004-02-19 14:23:27 +0000 | [diff] [blame] | 12 | #define FUSE_KERNEL_VERSION 3 |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 13 | |
Miklos Szeredi | 2f3d940 | 2003-12-15 12:11:33 +0000 | [diff] [blame] | 14 | /** Minor version number of this interface */ |
Miklos Szeredi | 18e75e4 | 2004-02-19 14:23:27 +0000 | [diff] [blame] | 15 | #define FUSE_KERNEL_MINOR_VERSION 1 |
Miklos Szeredi | 2f3d940 | 2003-12-15 12:11:33 +0000 | [diff] [blame] | 16 | |
Miklos Szeredi | 8cffdb9 | 2001-11-09 14:49:18 +0000 | [diff] [blame] | 17 | /** The inode number of the root indode */ |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 18 | #define FUSE_ROOT_INO 1 |
| 19 | |
Miklos Szeredi | 8cffdb9 | 2001-11-09 14:49:18 +0000 | [diff] [blame] | 20 | /** Opening this will yield a new control file */ |
| 21 | #define FUSE_DEV "/proc/fs/fuse/dev" |
| 22 | |
Miklos Szeredi | c40748a | 2004-02-20 16:38:45 +0000 | [diff] [blame] | 23 | /** The file containing the version in the form MAJOR.MINOR */ |
| 24 | #define FUSE_VERSION_FILE "/proc/fs/fuse/version" |
| 25 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 26 | struct fuse_attr { |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 27 | unsigned int mode; |
| 28 | unsigned int nlink; |
| 29 | unsigned int uid; |
| 30 | unsigned int gid; |
| 31 | unsigned int rdev; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 32 | unsigned long long size; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 33 | unsigned long blocks; |
| 34 | unsigned long atime; |
Miklos Szeredi | b595861 | 2004-02-20 14:10:49 +0000 | [diff] [blame] | 35 | unsigned long atimensec; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 36 | unsigned long mtime; |
Miklos Szeredi | b595861 | 2004-02-20 14:10:49 +0000 | [diff] [blame] | 37 | unsigned long mtimensec; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 38 | unsigned long ctime; |
Miklos Szeredi | b595861 | 2004-02-20 14:10:49 +0000 | [diff] [blame] | 39 | unsigned long ctimensec; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 40 | }; |
| 41 | |
Miklos Szeredi | 24ed945 | 2002-10-07 10:24:26 +0000 | [diff] [blame] | 42 | struct fuse_kstatfs { |
Miklos Szeredi | 18e75e4 | 2004-02-19 14:23:27 +0000 | [diff] [blame] | 43 | 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 Szeredi | 24ed945 | 2002-10-07 10:24:26 +0000 | [diff] [blame] | 50 | }; |
| 51 | |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 52 | #define FATTR_MODE (1 << 0) |
| 53 | #define FATTR_UID (1 << 1) |
| 54 | #define FATTR_GID (1 << 2) |
| 55 | #define FATTR_SIZE (1 << 3) |
Miklos Szeredi | b595861 | 2004-02-20 14:10:49 +0000 | [diff] [blame] | 56 | #define FATTR_ATIME (1 << 4) |
| 57 | #define FATTR_MTIME (1 << 5) |
| 58 | #define FATTR_CTIME (1 << 6) |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 59 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 60 | enum fuse_opcode { |
Miklos Szeredi | 3ed8423 | 2004-03-30 15:17:26 +0000 | [diff] [blame] | 61 | 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 Szeredi | e2e4ac2 | 2004-05-18 08:45:28 +0000 | [diff] [blame] | 85 | FUSE_FLUSH = 25, |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 86 | }; |
| 87 | |
| 88 | /* Conservative buffer size for the client */ |
| 89 | #define FUSE_MAX_IN 8192 |
| 90 | |
Miklos Szeredi | c26c14d | 2004-04-09 17:48:32 +0000 | [diff] [blame] | 91 | #define FUSE_NAME_MAX 1024 |
| 92 | #define FUSE_SYMLINK_MAX 4096 |
| 93 | #define FUSE_XATTR_SIZE_MAX 4096 |
| 94 | |
Miklos Szeredi | 254d5ed | 2004-03-02 11:11:24 +0000 | [diff] [blame] | 95 | struct 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 Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 103 | struct fuse_attr attr; |
| 104 | }; |
| 105 | |
Miklos Szeredi | a181e61 | 2001-11-06 12:03:23 +0000 | [diff] [blame] | 106 | struct fuse_forget_in { |
| 107 | int version; |
| 108 | }; |
| 109 | |
Miklos Szeredi | 254d5ed | 2004-03-02 11:11:24 +0000 | [diff] [blame] | 110 | struct fuse_attr_out { |
| 111 | unsigned long attr_valid; /* Cache timeout for the attributes */ |
| 112 | unsigned long attr_valid_nsec; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 113 | struct fuse_attr attr; |
| 114 | }; |
| 115 | |
| 116 | struct fuse_getdir_out { |
| 117 | int fd; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 118 | }; |
| 119 | |
| 120 | struct fuse_mknod_in { |
Miklos Szeredi | 76f6578 | 2004-02-19 16:55:40 +0000 | [diff] [blame] | 121 | unsigned int mode; |
| 122 | unsigned int rdev; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 123 | }; |
| 124 | |
Miklos Szeredi | b483c93 | 2001-10-29 14:57:57 +0000 | [diff] [blame] | 125 | struct fuse_mkdir_in { |
Miklos Szeredi | 76f6578 | 2004-02-19 16:55:40 +0000 | [diff] [blame] | 126 | unsigned int mode; |
Miklos Szeredi | b483c93 | 2001-10-29 14:57:57 +0000 | [diff] [blame] | 127 | }; |
| 128 | |
Miklos Szeredi | b483c93 | 2001-10-29 14:57:57 +0000 | [diff] [blame] | 129 | struct fuse_rename_in { |
| 130 | unsigned long newdir; |
Miklos Szeredi | 19dff1b | 2001-10-30 15:06:52 +0000 | [diff] [blame] | 131 | }; |
| 132 | |
| 133 | struct fuse_link_in { |
| 134 | unsigned long newdir; |
Miklos Szeredi | b483c93 | 2001-10-29 14:57:57 +0000 | [diff] [blame] | 135 | }; |
| 136 | |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 137 | struct fuse_setattr_in { |
| 138 | struct fuse_attr attr; |
| 139 | unsigned int valid; |
| 140 | }; |
| 141 | |
| 142 | struct fuse_open_in { |
| 143 | unsigned int flags; |
| 144 | }; |
| 145 | |
| 146 | struct fuse_read_in { |
| 147 | unsigned long long offset; |
| 148 | unsigned int size; |
| 149 | }; |
| 150 | |
Miklos Szeredi | a181e61 | 2001-11-06 12:03:23 +0000 | [diff] [blame] | 151 | struct fuse_write_in { |
| 152 | unsigned long long offset; |
| 153 | unsigned int size; |
Miklos Szeredi | a181e61 | 2001-11-06 12:03:23 +0000 | [diff] [blame] | 154 | }; |
| 155 | |
Miklos Szeredi | ad051c3 | 2004-07-02 09:22:50 +0000 | [diff] [blame^] | 156 | struct fuse_write_out { |
| 157 | unsigned int size; |
| 158 | }; |
| 159 | |
Mark Glines | d84b39a | 2002-01-07 16:32:02 +0000 | [diff] [blame] | 160 | struct fuse_statfs_out { |
Miklos Szeredi | 24ed945 | 2002-10-07 10:24:26 +0000 | [diff] [blame] | 161 | struct fuse_kstatfs st; |
Mark Glines | d84b39a | 2002-01-07 16:32:02 +0000 | [diff] [blame] | 162 | }; |
| 163 | |
Miklos Szeredi | 5e43f2c | 2003-12-12 14:06:41 +0000 | [diff] [blame] | 164 | struct fuse_fsync_in { |
| 165 | int datasync; |
| 166 | }; |
| 167 | |
Miklos Szeredi | 3ed8423 | 2004-03-30 15:17:26 +0000 | [diff] [blame] | 168 | struct fuse_setxattr_in { |
| 169 | unsigned int size; |
| 170 | unsigned int flags; |
| 171 | }; |
| 172 | |
Miklos Szeredi | 03cebae | 2004-03-31 10:19:18 +0000 | [diff] [blame] | 173 | struct fuse_getxattr_in { |
| 174 | unsigned int size; |
| 175 | }; |
| 176 | |
| 177 | struct fuse_getxattr_out { |
Miklos Szeredi | 3ed8423 | 2004-03-30 15:17:26 +0000 | [diff] [blame] | 178 | unsigned int size; |
| 179 | }; |
| 180 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 181 | struct fuse_in_header { |
| 182 | int unique; |
| 183 | enum fuse_opcode opcode; |
Miklos Szeredi | b483c93 | 2001-10-29 14:57:57 +0000 | [diff] [blame] | 184 | unsigned long ino; |
Miklos Szeredi | fe25def | 2001-12-20 15:38:05 +0000 | [diff] [blame] | 185 | unsigned int uid; |
| 186 | unsigned int gid; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 187 | }; |
| 188 | |
| 189 | struct fuse_out_header { |
| 190 | int unique; |
Miklos Szeredi | 19dff1b | 2001-10-30 15:06:52 +0000 | [diff] [blame] | 191 | int error; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 192 | }; |
| 193 | |
Miklos Szeredi | da4e486 | 2003-09-08 11:14:11 +0000 | [diff] [blame] | 194 | struct fuse_user_header { |
| 195 | int unique; /* zero */ |
| 196 | enum fuse_opcode opcode; |
| 197 | unsigned long ino; |
| 198 | }; |
| 199 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 200 | struct 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 | */ |