| 1 | /*++ |
| 2 | |
| 3 | Copyright (c) Microsoft. All rights reserved. |
| 4 | |
| 5 | Module Name: |
| 6 | |
| 7 | p9data.h |
| 8 | |
| 9 | Abstract: |
| 10 | |
| 11 | This file contains the plan9 message types to size mapping logic. |
| 12 | |
| 13 | --*/ |
| 14 | |
| 15 | #pragma once |
| 16 | |
| 17 | namespace p9fs { |
| 18 | |
| 19 | // Gets the minimum message size for each Plan 9 message type. |
| 20 | // If the messages can be a dynamic length, this size is the minimum size of |
| 21 | // the message if all dynamic content is omitted. In the case of strings, the |
| 22 | // size of the two-byte length field is included, but the string length itself |
| 23 | // is not. The omitted components are listed with each message type, and the |
| 24 | // caller is responsible for adding the right values if necessary. |
| 25 | constexpr UINT32 GetMessageSize(MessageType messageType) |
| 26 | { |
| 27 | switch (messageType) |
| 28 | { |
| 29 | case MessageType::Tversion: |
| 30 | // size[4] Tversion tag[2] msize[4] version[s] |
| 31 | // Excludes: version string data |
| 32 | return HeaderSize + /*msize*/ 4 + /*version*/ 2; |
| 33 | |
| 34 | case MessageType::Rversion: |
| 35 | // size[4] Rversion tag[2] msize[4] version[s] |
| 36 | // Excludes: version string data |
| 37 | return HeaderSize + /*msize*/ 4 + /*version*/ 2; |
| 38 | |
| 39 | case MessageType::Tflush: |
| 40 | // size[4] Tflush tag[2] oldtag[2] |
| 41 | return HeaderSize + /*oldtag*/ 2; |
| 42 | |
| 43 | case MessageType::Rflush: |
| 44 | // size[4] Rflush tag[2] |
| 45 | return HeaderSize; |
| 46 | |
| 47 | case MessageType::Twalk: |
| 48 | // size[4] Twalk tag[2] fid[4] newfid[4] nwname[2] nwname*(wname[s]) |
| 49 | // Excludes: repeated elements |
| 50 | return HeaderSize + /*fid*/ 4 + /*newfid*/ 4 + /*nwname*/ 2; |
| 51 | |
| 52 | case MessageType::Rwalk: |
| 53 | // size[4] Rwalk tag[2] nwqid[2] nwqid*(wqid[13]) |
| 54 | // Excludes: repeated elements |
| 55 | return HeaderSize + /*nwqid*/ 2; |
| 56 | |
| 57 | case MessageType::Tread: |
| 58 | // size[4] Tread tag[2] fid[4] offset[8] count[4] |
| 59 | return HeaderSize + /*fid*/ 4 + /*offset*/ 8 + /*count*/ 4; |
| 60 | |
| 61 | case MessageType::Rread: |
| 62 | // size[4] Rread tag[2] count[4] data[count] |
| 63 | // Excludes: data |
| 64 | return HeaderSize + /*count*/ 4; |
| 65 | |
| 66 | case MessageType::Twrite: |
| 67 | // size[4] Twrite tag[2] fid[4] offset[8] count[4] data[count] |
| 68 | // Excludes: data |
| 69 | return HeaderSize + /*fid*/ 4 + /*offset*/ 8 + /*count*/ 4; |
| 70 | |
| 71 | case MessageType::Rwrite: |
| 72 | // size[4] Rwrite tag[2] count[4] |
| 73 | return HeaderSize + /*count*/ 4; |
| 74 | |
| 75 | case MessageType::Tclunk: |
| 76 | // size[4] Tclunk tag[2] fid[4] |
| 77 | return HeaderSize + /*fid*/ 4; |
| 78 | |
| 79 | case MessageType::Rclunk: |
| 80 | // size[4] Rclunk tag[2] |
| 81 | return HeaderSize; |
| 82 | |
| 83 | case MessageType::Tremove: |
| 84 | // size[4] Tremove tag[2] fid[4] |
| 85 | return HeaderSize + /*fid*/ 4; |
| 86 | |
| 87 | case MessageType::Rremove: |
| 88 | // size[4] Rremove tag[2] |
| 89 | return HeaderSize; |
| 90 | |
| 91 | case MessageType::Tauth: |
| 92 | // size[4] Tauth tag[2] afid[4] uname[s] aname[s] n_uname[4] |
| 93 | // Excludes: uname string data, aname string data |
| 94 | return HeaderSize + /*afid*/ 4 + /*uname*/ 2 + /*aname*/ 2 + /*n_uname*/ 4; |
| 95 | |
| 96 | case MessageType::Rauth: |
| 97 | // size[4] Rauth tag[2] aqid[13] |
| 98 | return HeaderSize + /*aqid*/ 13; |
| 99 | |
| 100 | case MessageType::Tattach: |
| 101 | // size[4] Tattach tag[2] fid[4] afid[4] uname[s] aname[s] n_uname[4] |
| 102 | // Excludes: uname string data, aname string data |
| 103 | return HeaderSize + /*fid*/ 4 + /*afid*/ 4 + /*uname*/ 2 + /*aname*/ 2 + /*n_uname*/ 4; |
| 104 | |
| 105 | case MessageType::Rattach: |
| 106 | // size[4] Rattach tag[2] qid[13] |
| 107 | return HeaderSize + /*qid*/ 13; |
| 108 | |
| 109 | case MessageType::Rlerror: |
| 110 | // size[4] Rlerror tag[2] ecode[4] |
| 111 | return HeaderSize + /*ecode*/ 4; |
| 112 | |
| 113 | case MessageType::Tstatfs: |
| 114 | // size[4] Tstatfs tag[2] fid[4] |
| 115 | return HeaderSize + /*fid*/ 4; |
| 116 | |
| 117 | case MessageType::Rstatfs: |
| 118 | // size[4] Rstatfs tag[2] type[4] bsize[4] blocks[8] bfree[8] bavail[8] files[8] ffree[8] fsid[8] namelen[4] |
| 119 | return HeaderSize + /*type*/ 4 + /*bsize*/ 4 + /*blocks*/ 8 + /*bfree*/ 8 + /*bavail*/ 8 + /*files*/ 8 + /*ffree*/ 8 + |
| 120 | /*fsid*/ 8 + /*namelen*/ 4; |
| 121 | |
| 122 | case MessageType::Tlopen: |
| 123 | // size[4] Tlopen tag[2] fid[4] flags[4] |
| 124 | return HeaderSize + /*fid*/ 4 + /*flags*/ 4; |
| 125 | |
| 126 | case MessageType::Rlopen: |
| 127 | // size[4] Rlopen tag[2] qid[13] iounit[4] |
| 128 | return HeaderSize + /*qid*/ 13 + /*iounit*/ 4; |
| 129 | |
| 130 | case MessageType::Tlcreate: |
| 131 | // size[4] Tlcreate tag[2] fid[4] name[s] flags[4] mode[4] gid[4] |
| 132 | // Excludes: name string data |
| 133 | return HeaderSize + /*fid*/ 4 + /*name*/ 2 + /*flags*/ 4 + /*mode*/ 4 + /*gid*/ 4; |
| 134 | |
| 135 | case MessageType::Rlcreate: |
| 136 | // size[4] Rlcreate tag[2] qid[13] iounit[4] |
| 137 | return HeaderSize + /*qid*/ 13 + /*iounit*/ 4; |
| 138 | |
| 139 | case MessageType::Tsymlink: |
| 140 | // size[4] Tsymlink tag[2] fid[4] name[s] symtgt[s] gid[4] |
| 141 | // Excludes: name string data, symtgt string data |
| 142 | return HeaderSize + /*fid*/ 4 + /*name*/ 2 + /*symtgt*/ 2 + /*gid*/ 4; |
| 143 | |
| 144 | case MessageType::Rsymlink: |
| 145 | // size[4] Rsymlink tag[2] qid[13] |
| 146 | return HeaderSize + /*qid*/ 13; |
| 147 | |
| 148 | case MessageType::Tmknod: |
| 149 | // size[4] Tmknod tag[2] dfid[4] name[s] mode[4] major[4] minor[4] gid[4] |
| 150 | // Excludes: name string data |
| 151 | return HeaderSize + /*dfid*/ 4 + /*name*/ 2 + /*mode*/ 4 + /*major*/ 4 + /*minor*/ 4 + /*gid*/ 4; |
| 152 | |
| 153 | case MessageType::Rmknod: |
| 154 | // size[4] Rmknod tag[2] qid[13] |
| 155 | return HeaderSize + /*qid*/ 13; |
| 156 | |
| 157 | case MessageType::Trename: |
| 158 | // size[4] Trename tag[2] fid[4] dfid[4] name[s] |
| 159 | // Excludes: name string data |
| 160 | return HeaderSize + /*fid*/ 4 + /*dfid*/ 4 + /*name*/ 2; |
| 161 | |
| 162 | case MessageType::Rrename: |
| 163 | // size[4] Rrename tag[2] |
| 164 | return HeaderSize; |
| 165 | |
| 166 | case MessageType::Treadlink: |
| 167 | // size[4] Treadlink tag[2] fid[4] |
| 168 | return HeaderSize + /*fid*/ 4; |
| 169 | |
| 170 | case MessageType::Rreadlink: |
| 171 | // size[4] Rreadlink tag[2] target[s] |
| 172 | // Excludes: target string data |
| 173 | return HeaderSize + /*target*/ 2; |
| 174 | |
| 175 | case MessageType::Tgetattr: |
| 176 | // size[4] Tgetattr tag[2] fid[4] request_mask[8] |
| 177 | return HeaderSize + /*fid*/ 4 + /*request_mask*/ 8; |
| 178 | |
| 179 | case MessageType::Rgetattr: |
| 180 | // size[4] Rgetattr tag[2] valid[8] qid[13] mode[4] uid[4] gid[4] nlink[8] rdev[8] size[8] blksize[8] blocks[8] atime_sec[8] atime_nsec[8] mtime_sec[8] mtime_nsec[8] ctime_sec[8] ctime_nsec[8] btime_sec[8] btime_nsec[8] gen[8] data_version[8] |
| 181 | return HeaderSize + /*valid*/ 8 + /*qid*/ 13 + /*mode*/ 4 + /*uid*/ 4 + /*gid*/ 4 + /*nlink*/ 8 + /*rdev*/ 8 + /*size*/ 8 + |
| 182 | /*blksize*/ 8 + /*blocks*/ 8 + /*atime_sec*/ 8 + /*atime_nsec*/ 8 + /*mtime_sec*/ 8 + /*mtime_nsec*/ 8 + |
| 183 | /*ctime_sec*/ 8 + /*ctime_nsec*/ 8 + /*btime_sec*/ 8 + /*btime_nsec*/ 8 + /*gen*/ 8 + /*data_version*/ 8; |
| 184 | |
| 185 | case MessageType::Tsetattr: |
| 186 | // size[4] Tsetattr tag[2] fid[4] valid[4] mode[4] uid[4] gid[4] size[8] atime_sec[8] atime_nsec[8] mtime_sec[8] mtime_nsec[8] |
| 187 | return HeaderSize + /*fid*/ 4 + /*valid*/ 4 + /*mode*/ 4 + /*uid*/ 4 + /*gid*/ 4 + /*size*/ 8 + /*atime_sec*/ 8 + |
| 188 | /*atime_nsec*/ 8 + /*mtime_sec*/ 8 + /*mtime_nsec*/ 8; |
| 189 | |
| 190 | case MessageType::Rsetattr: |
| 191 | // size[4] Rsetattr tag[2] |
| 192 | return HeaderSize; |
| 193 | |
| 194 | case MessageType::Txattrwalk: |
| 195 | // size[4] Txattrwalk tag[2] fid[4] newfid[4] name[s] |
| 196 | // Excludes: name string data |
| 197 | return HeaderSize + /*fid*/ 4 + /*newfid*/ 4 + /*name*/ 2; |
| 198 | |
| 199 | case MessageType::Rxattrwalk: |
| 200 | // size[4] Rxattrwalk tag[2] size[8] |
| 201 | return HeaderSize + /*size*/ 8; |
| 202 | |
| 203 | case MessageType::Txattrcreate: |
| 204 | // size[4] Txattrcreate tag[2] fid[4] name[s] attr_size[8] flags[4] |
| 205 | // Excludes: name string data |
| 206 | return HeaderSize + /*fid*/ 4 + /*name*/ 2 + /*attr_size*/ 8 + /*flags*/ 4; |
| 207 | |
| 208 | case MessageType::Rxattrcreate: |
| 209 | // size[4] Rxattrcreate tag[2] |
| 210 | return HeaderSize; |
| 211 | |
| 212 | case MessageType::Treaddir: |
| 213 | // size[4] Treaddir tag[2] fid[4] offset[8] count[4] |
| 214 | return HeaderSize + /*fid*/ 4 + /*offset*/ 8 + /*count*/ 4; |
| 215 | |
| 216 | case MessageType::Rreaddir: |
| 217 | // size[4] Rreaddir tag[2] count[4] data[count] |
| 218 | // Excludes: data |
| 219 | return HeaderSize + /*count*/ 4; |
| 220 | |
| 221 | case MessageType::Tfsync: |
| 222 | // size[4] Tfsync tag[2] fid[4] |
| 223 | return HeaderSize + /*fid*/ 4; |
| 224 | |
| 225 | case MessageType::Rfsync: |
| 226 | // size[4] Rfsync tag[2] |
| 227 | return HeaderSize; |
| 228 | |
| 229 | case MessageType::Tlock: |
| 230 | // size[4] Tlock tag[2] fid[4] type[1] flags[4] start[8] length[8] proc_id[4] client_id[s] |
| 231 | // Excludes: client_id string data |
| 232 | return HeaderSize + /*fid*/ 4 + /*type*/ 1 + /*flags*/ 4 + /*start*/ 8 + /*length*/ 8 + /*proc_id*/ 4 + /*client_id*/ 2; |
| 233 | |
| 234 | case MessageType::Rlock: |
| 235 | // size[4] Rlock tag[2] status[1] |
| 236 | return HeaderSize + /*status*/ 1; |
| 237 | |
| 238 | case MessageType::Tgetlock: |
| 239 | // size[4] Tgetlock tag[2] fid[4] type[1] start[8] length[8] proc_id[4] client_id[s] |
| 240 | // Excludes: client_id string data |
| 241 | return HeaderSize + /*fid*/ 4 + /*type*/ 1 + /*start*/ 8 + /*length*/ 8 + /*proc_id*/ 4 + /*client_id*/ 2; |
| 242 | |
| 243 | case MessageType::Rgetlock: |
| 244 | // size[4] Rgetlock tag[2] type[1] start[8] length[8] proc_id[4] client_id[s] |
| 245 | // Excludes: client_id string data |
| 246 | return HeaderSize + /*type*/ 1 + /*start*/ 8 + /*length*/ 8 + /*proc_id*/ 4 + /*client_id*/ 2; |
| 247 | |
| 248 | case MessageType::Tlink: |
| 249 | // size[4] Tlink tag[2] dfid[4] fid[4] name[s] |
| 250 | // Excludes: name string data |
| 251 | return HeaderSize + /*dfid*/ 4 + /*fid*/ 4 + /*name*/ 2; |
| 252 | |
| 253 | case MessageType::Rlink: |
| 254 | // size[4] Rlink tag[2] |
| 255 | return HeaderSize; |
| 256 | |
| 257 | case MessageType::Tmkdir: |
| 258 | // size[4] Tmkdir tag[2] dfid[4] name[s] mode[4] gid[4] |
| 259 | // Excludes: name string data |
| 260 | return HeaderSize + /*dfid*/ 4 + /*name*/ 2 + /*mode*/ 4 + /*gid*/ 4; |
| 261 | |
| 262 | case MessageType::Rmkdir: |
| 263 | // size[4] Rmkdir tag[2] qid[13] |
| 264 | return HeaderSize + /*qid*/ 13; |
| 265 | |
| 266 | case MessageType::Trenameat: |
| 267 | // size[4] Trenameat tag[2] olddirfid[4] oldname[s] newdirfid[4] newname[s] |
| 268 | // Excludes: oldname string data, newname string data |
| 269 | return HeaderSize + /*olddirfid*/ 4 + /*oldname*/ 2 + /*newdirfid*/ 4 + /*newname*/ 2; |
| 270 | |
| 271 | case MessageType::Rrenameat: |
| 272 | // size[4] Rrenameat tag[2] |
| 273 | return HeaderSize; |
| 274 | |
| 275 | case MessageType::Tunlinkat: |
| 276 | // size[4] Tunlinkat tag[2] dirfd[4] name[s] flags[4] |
| 277 | // Excludes: name string data |
| 278 | return HeaderSize + /*dirfd*/ 4 + /*name*/ 2 + /*flags*/ 4; |
| 279 | |
| 280 | case MessageType::Runlinkat: |
| 281 | // size[4] Runlinkat tag[2] |
| 282 | return HeaderSize; |
| 283 | |
| 284 | case MessageType::Taccess: |
| 285 | // size[4] Taccess tag[2] fid[4] flags[4] |
| 286 | return HeaderSize + /*fid*/ 4 + /*flags*/ 4; |
| 287 | |
| 288 | case MessageType::Raccess: |
| 289 | // size[4] Raccess tag[2] |
| 290 | return HeaderSize; |
| 291 | |
| 292 | case MessageType::Twreaddir: |
| 293 | // size[4] Twreaddir tag[2] fid[4] offset[8] count[4] |
| 294 | return HeaderSize + /*fid*/ 4 + /*offset*/ 8 + /*count*/ 4; |
| 295 | |
| 296 | case MessageType::Rwreaddir: |
| 297 | // size[4] Rwreaddir tag[2] count[4] data[count] |
| 298 | // Excludes: data |
| 299 | return HeaderSize + /*count*/ 4; |
| 300 | |
| 301 | case MessageType::Twopen: |
| 302 | // size[4] Twopen tag[2] fid[4] newfid[4] flags[4] wflags[4] mode[4] gid[4] attr_mask[8] nwname[2] nwname*(wname[s]) |
| 303 | // Excludes: repeated elements |
| 304 | return HeaderSize + /*fid*/ 4 + /*newfid*/ 4 + /*flags*/ 4 + /*wflags*/ 4 + /*mode*/ 4 + /*gid*/ 4 + /*attr_mask*/ 8 + /*nwname*/ 2; |
| 305 | |
| 306 | case MessageType::Rwopen: |
| 307 | // size[4] Rwopen tag[2] status[1] walked[2] qid[13] symlink_target[s] iounit[4] mode[4] uid[4] gid[4] nlink[8] rdev[8] |
| 308 | // size[8] blksize[8] blocks[8] atime_sec[8] atime_nsec[8] mtime_sec[8] mtime_nsec[8] ctime_sec[8] ctime_nsec[8] |
| 309 | // btime_sec[8] btime_nsec[8] gen[8] data_version[8] Excludes: symlink_target string data |
| 310 | return HeaderSize + /*status*/ 1 + /*walked*/ 2 + /*qid*/ 13 + /*symlink_target*/ 2 + /*iounit*/ 4 + /*mode*/ 4 + |
| 311 | /*uid*/ 4 + /*gid*/ 4 + /*nlink*/ 8 + /*rdev*/ 8 + /*size*/ 8 + /*blksize*/ 8 + /*blocks*/ 8 + /*atime_sec*/ 8 + |
| 312 | /*atime_nsec*/ 8 + /*mtime_sec*/ 8 + /*mtime_nsec*/ 8 + /*ctime_sec*/ 8 + /*ctime_nsec*/ 8 + /*btime_sec*/ 8 + |
| 313 | /*btime_nsec*/ 8 + /*gen*/ 8 + /*data_version*/ 8; |
| 314 | |
| 315 | default: |
| 316 | return 0; |
| 317 | } |
| 318 | } |
| 319 | |
| 320 | } // namespace p9fs |