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 | fe25def | 2001-12-20 15:38:05 +0000 | [diff] [blame] | 12 | #define FUSE_KERNEL_VERSION 2 |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 13 | |
Miklos Szeredi | 8cffdb9 | 2001-11-09 14:49:18 +0000 | [diff] [blame] | 14 | /** The inode number of the root indode */ |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 15 | #define FUSE_ROOT_INO 1 |
| 16 | |
Miklos Szeredi | 8cffdb9 | 2001-11-09 14:49:18 +0000 | [diff] [blame] | 17 | /** Opening this will yield a new control file */ |
| 18 | #define FUSE_DEV "/proc/fs/fuse/dev" |
| 19 | |
Miklos Szeredi | 36ca556 | 2003-11-03 19:32:14 +0000 | [diff] [blame] | 20 | /** Read combining parameters */ |
| 21 | #define FUSE_BLOCK_SHIFT 16 |
| 22 | #define FUSE_BLOCK_SIZE 65536 |
| 23 | #define FUSE_BLOCK_MASK 0xffff0000 |
| 24 | |
Miklos Szeredi | 8cffdb9 | 2001-11-09 14:49:18 +0000 | [diff] [blame] | 25 | /** Data passed to mount */ |
| 26 | struct fuse_mount_data { |
| 27 | /** Must be set to FUSE_KERNEL_VERSION */ |
| 28 | int version; |
| 29 | |
| 30 | /** The control file descriptor */ |
| 31 | int fd; |
| 32 | |
| 33 | /** The file type of the root inode */ |
| 34 | unsigned int rootmode; |
| 35 | |
| 36 | /** The user ID of the user initiating this mount */ |
| 37 | unsigned int uid; |
| 38 | |
| 39 | /** FUSE specific mount flags */ |
| 40 | unsigned int flags; |
| 41 | }; |
| 42 | |
Miklos Szeredi | fe25def | 2001-12-20 15:38:05 +0000 | [diff] [blame] | 43 | /* FUSE mount flags: */ |
| 44 | |
| 45 | /** If the FUSE_DEFAULT_PERMISSIONS flag is given, the filesystem |
| 46 | module will check permissions based on the file mode. Otherwise no |
| 47 | permission checking is done in the kernel */ |
| 48 | #define FUSE_DEFAULT_PERMISSIONS (1 << 0) |
| 49 | |
| 50 | /** If the FUSE_ALLOW_OTHER flag is given, then not only the user |
| 51 | doing the mount will be allowed to access the filesystem */ |
| 52 | #define FUSE_ALLOW_OTHER (1 << 1) |
| 53 | |
Miklos Szeredi | da4e486 | 2003-09-08 11:14:11 +0000 | [diff] [blame] | 54 | /** If the FUSE_KERNEL_CACHE flag is given, then files will be cached |
| 55 | until the INVALIDATE operation is invoked */ |
| 56 | #define FUSE_KERNEL_CACHE (1 << 2) |
| 57 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 58 | struct fuse_attr { |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 59 | unsigned int mode; |
| 60 | unsigned int nlink; |
| 61 | unsigned int uid; |
| 62 | unsigned int gid; |
| 63 | unsigned int rdev; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 64 | unsigned long long size; |
Miklos Szeredi | 0503304 | 2001-11-13 16:11:35 +0000 | [diff] [blame] | 65 | unsigned long _dummy; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 66 | unsigned long blocks; |
| 67 | unsigned long atime; |
| 68 | unsigned long mtime; |
| 69 | unsigned long ctime; |
| 70 | }; |
| 71 | |
Miklos Szeredi | 24ed945 | 2002-10-07 10:24:26 +0000 | [diff] [blame] | 72 | struct fuse_kstatfs { |
| 73 | long block_size; |
| 74 | long blocks; |
| 75 | long blocks_free; |
| 76 | long files; |
| 77 | long files_free; |
| 78 | long namelen; |
| 79 | }; |
| 80 | |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 81 | #define FATTR_MODE (1 << 0) |
| 82 | #define FATTR_UID (1 << 1) |
| 83 | #define FATTR_GID (1 << 2) |
| 84 | #define FATTR_SIZE (1 << 3) |
| 85 | #define FATTR_UTIME (1 << 4) |
| 86 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 87 | enum fuse_opcode { |
Miklos Szeredi | 4369643 | 2001-11-18 19:15:05 +0000 | [diff] [blame] | 88 | FUSE_LOOKUP = 1, |
Miklos Szeredi | da4e486 | 2003-09-08 11:14:11 +0000 | [diff] [blame] | 89 | FUSE_FORGET = 2, /* no reply */ |
Miklos Szeredi | 4369643 | 2001-11-18 19:15:05 +0000 | [diff] [blame] | 90 | FUSE_GETATTR = 3, |
| 91 | FUSE_SETATTR = 4, |
| 92 | FUSE_READLINK = 5, |
| 93 | FUSE_SYMLINK = 6, |
| 94 | FUSE_GETDIR = 7, |
| 95 | FUSE_MKNOD = 8, |
| 96 | FUSE_MKDIR = 9, |
| 97 | FUSE_UNLINK = 10, |
| 98 | FUSE_RMDIR = 11, |
| 99 | FUSE_RENAME = 12, |
| 100 | FUSE_LINK = 13, |
| 101 | FUSE_OPEN = 14, |
| 102 | FUSE_READ = 15, |
| 103 | FUSE_WRITE = 16, |
Mark Glines | d84b39a | 2002-01-07 16:32:02 +0000 | [diff] [blame] | 104 | FUSE_STATFS = 17, |
Miklos Szeredi | da4e486 | 2003-09-08 11:14:11 +0000 | [diff] [blame] | 105 | FUSE_RELEASE = 18, /* no reply */ |
Miklos Szeredi | 5e43f2c | 2003-12-12 14:06:41 +0000 | [diff] [blame^] | 106 | FUSE_INVALIDATE = 19, /* user initiated */ |
| 107 | FUSE_FSYNC = 20 |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 108 | }; |
| 109 | |
| 110 | /* Conservative buffer size for the client */ |
| 111 | #define FUSE_MAX_IN 8192 |
| 112 | |
| 113 | struct fuse_lookup_out { |
| 114 | unsigned long ino; |
| 115 | struct fuse_attr attr; |
| 116 | }; |
| 117 | |
Miklos Szeredi | a181e61 | 2001-11-06 12:03:23 +0000 | [diff] [blame] | 118 | struct fuse_forget_in { |
| 119 | int version; |
| 120 | }; |
| 121 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 122 | struct fuse_getattr_out { |
| 123 | struct fuse_attr attr; |
| 124 | }; |
| 125 | |
| 126 | struct fuse_getdir_out { |
| 127 | int fd; |
| 128 | void *file; /* Used by kernel only */ |
| 129 | }; |
| 130 | |
| 131 | struct fuse_mknod_in { |
| 132 | unsigned short mode; |
| 133 | unsigned short rdev; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 134 | }; |
| 135 | |
| 136 | struct fuse_mknod_out { |
| 137 | unsigned long ino; |
| 138 | struct fuse_attr attr; |
| 139 | }; |
| 140 | |
Miklos Szeredi | b483c93 | 2001-10-29 14:57:57 +0000 | [diff] [blame] | 141 | struct fuse_mkdir_in { |
| 142 | unsigned short mode; |
Miklos Szeredi | b483c93 | 2001-10-29 14:57:57 +0000 | [diff] [blame] | 143 | }; |
| 144 | |
Miklos Szeredi | b483c93 | 2001-10-29 14:57:57 +0000 | [diff] [blame] | 145 | struct fuse_rename_in { |
| 146 | unsigned long newdir; |
Miklos Szeredi | 19dff1b | 2001-10-30 15:06:52 +0000 | [diff] [blame] | 147 | }; |
| 148 | |
| 149 | struct fuse_link_in { |
| 150 | unsigned long newdir; |
Miklos Szeredi | b483c93 | 2001-10-29 14:57:57 +0000 | [diff] [blame] | 151 | }; |
| 152 | |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 153 | struct fuse_setattr_in { |
| 154 | struct fuse_attr attr; |
| 155 | unsigned int valid; |
| 156 | }; |
| 157 | |
Miklos Szeredi | a181e61 | 2001-11-06 12:03:23 +0000 | [diff] [blame] | 158 | struct fuse_setattr_out { |
Miklos Szeredi | f3ea83b | 2001-11-07 14:55:16 +0000 | [diff] [blame] | 159 | struct fuse_attr attr; |
Miklos Szeredi | a181e61 | 2001-11-06 12:03:23 +0000 | [diff] [blame] | 160 | }; |
| 161 | |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 162 | struct fuse_open_in { |
| 163 | unsigned int flags; |
| 164 | }; |
| 165 | |
| 166 | struct fuse_read_in { |
| 167 | unsigned long long offset; |
| 168 | unsigned int size; |
| 169 | }; |
| 170 | |
Miklos Szeredi | a181e61 | 2001-11-06 12:03:23 +0000 | [diff] [blame] | 171 | struct fuse_write_in { |
| 172 | unsigned long long offset; |
| 173 | unsigned int size; |
Miklos Szeredi | a181e61 | 2001-11-06 12:03:23 +0000 | [diff] [blame] | 174 | }; |
| 175 | |
Mark Glines | d84b39a | 2002-01-07 16:32:02 +0000 | [diff] [blame] | 176 | struct fuse_statfs_out { |
Miklos Szeredi | 24ed945 | 2002-10-07 10:24:26 +0000 | [diff] [blame] | 177 | struct fuse_kstatfs st; |
Mark Glines | d84b39a | 2002-01-07 16:32:02 +0000 | [diff] [blame] | 178 | }; |
| 179 | |
Miklos Szeredi | 5e43f2c | 2003-12-12 14:06:41 +0000 | [diff] [blame^] | 180 | struct fuse_fsync_in { |
| 181 | int datasync; |
| 182 | }; |
| 183 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 184 | struct fuse_in_header { |
| 185 | int unique; |
| 186 | enum fuse_opcode opcode; |
Miklos Szeredi | b483c93 | 2001-10-29 14:57:57 +0000 | [diff] [blame] | 187 | unsigned long ino; |
Miklos Szeredi | fe25def | 2001-12-20 15:38:05 +0000 | [diff] [blame] | 188 | unsigned int uid; |
| 189 | unsigned int gid; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 190 | }; |
| 191 | |
| 192 | struct fuse_out_header { |
| 193 | int unique; |
Miklos Szeredi | 19dff1b | 2001-10-30 15:06:52 +0000 | [diff] [blame] | 194 | int error; |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 195 | }; |
| 196 | |
Miklos Szeredi | da4e486 | 2003-09-08 11:14:11 +0000 | [diff] [blame] | 197 | struct fuse_user_header { |
| 198 | int unique; /* zero */ |
| 199 | enum fuse_opcode opcode; |
| 200 | unsigned long ino; |
| 201 | }; |
| 202 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 203 | struct fuse_dirent { |
| 204 | unsigned long ino; |
| 205 | unsigned short namelen; |
| 206 | unsigned char type; |
| 207 | char name[256]; |
| 208 | }; |
| 209 | |
| 210 | #define FUSE_NAME_OFFSET ((unsigned int) ((struct fuse_dirent *) 0)->name) |
| 211 | #define FUSE_DIRENT_ALIGN(x) (((x) + sizeof(long) - 1) & ~(sizeof(long) - 1)) |
| 212 | #define FUSE_DIRENT_SIZE(d) \ |
| 213 | FUSE_DIRENT_ALIGN(FUSE_NAME_OFFSET + (d)->namelen) |
| 214 | |
| 215 | /* |
| 216 | * Local Variables: |
| 217 | * indent-tabs-mode: t |
| 218 | * c-basic-offset: 8 |
| 219 | * End: |
| 220 | */ |