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