1 //===- X86DisassemblerTables.cpp - Disassembler tables ----------*- C++ -*-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // This file is part of the X86 Disassembler Emitter. 10 // It contains the implementation of the disassembler tables. 11 // Documentation for the disassembler emitter in general can be found in 12 // X86DisassemblerEmitter.h. 13 // 14 //===----------------------------------------------------------------------===// 15 16 #include "X86DisassemblerTables.h" 17 #include "X86DisassemblerShared.h" 18 #include "X86ModRMFilters.h" 19 #include "llvm/ADT/SmallVector.h" 20 #include "llvm/Support/ErrorHandling.h" 21 #include "llvm/Support/Format.h" 22 #include "llvm/Support/raw_ostream.h" 23 #include <map> 24 25 using namespace llvm; 26 using namespace X86Disassembler; 27 28 /// stringForContext - Returns a string containing the name of a particular 29 /// InstructionContext, usually for diagnostic purposes. 30 /// 31 /// @param insnContext - The instruction class to transform to a string. 32 /// @return - A statically-allocated string constant that contains the 33 /// name of the instruction class. 34 static inline const char *stringForContext(InstructionContext insnContext) { 35 switch (insnContext) { 36 default: 37 llvm_unreachable("Unhandled instruction class"); 38 #define ENUM_ENTRY(n, r, d) \ 39 case n: \ 40 return #n; \ 41 break; 42 #define ENUM_ENTRY_K_B(n, r, d) \ 43 ENUM_ENTRY(n, r, d) \ 44 ENUM_ENTRY(n##_K_B, r, d) \ 45 ENUM_ENTRY(n##_KZ, r, d) \ 46 ENUM_ENTRY(n##_K, r, d) ENUM_ENTRY(n##_B, r, d) ENUM_ENTRY(n##_KZ_B, r, d) 47 INSTRUCTION_CONTEXTS 48 #undef ENUM_ENTRY 49 #undef ENUM_ENTRY_K_B 50 } 51 } 52 53 /// stringForOperandType - Like stringForContext, but for OperandTypes. 54 static inline const char *stringForOperandType(OperandType type) { 55 switch (type) { 56 default: 57 llvm_unreachable("Unhandled type"); 58 #define ENUM_ENTRY(i, d) \ 59 case i: \ 60 return #i; 61 TYPES 62 #undef ENUM_ENTRY 63 } 64 } 65 66 /// stringForOperandEncoding - like stringForContext, but for 67 /// OperandEncodings. 68 static inline const char *stringForOperandEncoding(OperandEncoding encoding) { 69 switch (encoding) { 70 default: 71 llvm_unreachable("Unhandled encoding"); 72 #define ENUM_ENTRY(i, d) \ 73 case i: \ 74 return #i; 75 ENCODINGS 76 #undef ENUM_ENTRY 77 } 78 } 79 80 /// inheritsFrom - Indicates whether all instructions in one class also belong 81 /// to another class. 82 /// 83 /// @param child - The class that may be the subset 84 /// @param parent - The class that may be the superset 85 /// @return - True if child is a subset of parent, false otherwise. 86 static inline bool inheritsFrom(InstructionContext child, 87 InstructionContext parent, bool noPrefix = true, 88 bool VEX_LIG = false, bool WIG = false, 89 bool AdSize64 = false) { 90 if (child == parent) 91 return true; 92 93 switch (parent) { 94 case IC: 95 return (inheritsFrom(child, IC_64BIT, AdSize64) || 96 (noPrefix && inheritsFrom(child, IC_OPSIZE, noPrefix)) || 97 inheritsFrom(child, IC_ADSIZE) || 98 (noPrefix && inheritsFrom(child, IC_XD, noPrefix)) || 99 (noPrefix && inheritsFrom(child, IC_XS, noPrefix))); 100 case IC_64BIT: 101 return (inheritsFrom(child, IC_64BIT_REXW) || 102 (noPrefix && inheritsFrom(child, IC_64BIT_OPSIZE, noPrefix)) || 103 (!AdSize64 && inheritsFrom(child, IC_64BIT_ADSIZE)) || 104 (noPrefix && inheritsFrom(child, IC_64BIT_XD, noPrefix)) || 105 (noPrefix && inheritsFrom(child, IC_64BIT_XS, noPrefix))); 106 case IC_OPSIZE: 107 return inheritsFrom(child, IC_64BIT_OPSIZE) || 108 inheritsFrom(child, IC_OPSIZE_ADSIZE); 109 case IC_ADSIZE: 110 return (noPrefix && inheritsFrom(child, IC_OPSIZE_ADSIZE, noPrefix)); 111 case IC_OPSIZE_ADSIZE: 112 return false; 113 case IC_64BIT_ADSIZE: 114 return (noPrefix && inheritsFrom(child, IC_64BIT_OPSIZE_ADSIZE, noPrefix)); 115 case IC_64BIT_OPSIZE_ADSIZE: 116 return false; 117 case IC_XD: 118 return inheritsFrom(child, IC_64BIT_XD); 119 case IC_XS: 120 return inheritsFrom(child, IC_64BIT_XS); 121 case IC_XD_OPSIZE: 122 return inheritsFrom(child, IC_64BIT_XD_OPSIZE); 123 case IC_XS_OPSIZE: 124 return inheritsFrom(child, IC_64BIT_XS_OPSIZE); 125 case IC_XD_ADSIZE: 126 return inheritsFrom(child, IC_64BIT_XD_ADSIZE); 127 case IC_XS_ADSIZE: 128 return inheritsFrom(child, IC_64BIT_XS_ADSIZE); 129 case IC_64BIT_REXW: 130 return ((noPrefix && inheritsFrom(child, IC_64BIT_REXW_XS, noPrefix)) || 131 (noPrefix && inheritsFrom(child, IC_64BIT_REXW_XD, noPrefix)) || 132 (noPrefix && inheritsFrom(child, IC_64BIT_REXW_OPSIZE, noPrefix)) || 133 (!AdSize64 && inheritsFrom(child, IC_64BIT_REXW_ADSIZE))); 134 case IC_64BIT_OPSIZE: 135 return inheritsFrom(child, IC_64BIT_REXW_OPSIZE) || 136 (!AdSize64 && inheritsFrom(child, IC_64BIT_OPSIZE_ADSIZE)) || 137 (!AdSize64 && inheritsFrom(child, IC_64BIT_REXW_ADSIZE)); 138 case IC_64BIT_XD: 139 return (inheritsFrom(child, IC_64BIT_REXW_XD) || 140 (!AdSize64 && inheritsFrom(child, IC_64BIT_XD_ADSIZE))); 141 case IC_64BIT_XS: 142 return (inheritsFrom(child, IC_64BIT_REXW_XS) || 143 (!AdSize64 && inheritsFrom(child, IC_64BIT_XS_ADSIZE))); 144 case IC_64BIT_XD_OPSIZE: 145 case IC_64BIT_XS_OPSIZE: 146 return false; 147 case IC_64BIT_XD_ADSIZE: 148 case IC_64BIT_XS_ADSIZE: 149 return false; 150 case IC_64BIT_REXW_XD: 151 case IC_64BIT_REXW_XS: 152 case IC_64BIT_REXW_OPSIZE: 153 case IC_64BIT_REXW_ADSIZE: 154 case IC_64BIT_REX2: 155 return false; 156 case IC_VEX: 157 return (VEX_LIG && WIG && inheritsFrom(child, IC_VEX_L_W)) || 158 (WIG && inheritsFrom(child, IC_VEX_W)) || 159 (VEX_LIG && inheritsFrom(child, IC_VEX_L)); 160 case IC_VEX_XS: 161 return (VEX_LIG && WIG && inheritsFrom(child, IC_VEX_L_W_XS)) || 162 (WIG && inheritsFrom(child, IC_VEX_W_XS)) || 163 (VEX_LIG && inheritsFrom(child, IC_VEX_L_XS)); 164 case IC_VEX_XD: 165 return (VEX_LIG && WIG && inheritsFrom(child, IC_VEX_L_W_XD)) || 166 (WIG && inheritsFrom(child, IC_VEX_W_XD)) || 167 (VEX_LIG && inheritsFrom(child, IC_VEX_L_XD)); 168 case IC_VEX_OPSIZE: 169 return (VEX_LIG && WIG && inheritsFrom(child, IC_VEX_L_W_OPSIZE)) || 170 (WIG && inheritsFrom(child, IC_VEX_W_OPSIZE)) || 171 (VEX_LIG && inheritsFrom(child, IC_VEX_L_OPSIZE)); 172 case IC_VEX_W: 173 return VEX_LIG && inheritsFrom(child, IC_VEX_L_W); 174 case IC_VEX_W_XS: 175 return VEX_LIG && inheritsFrom(child, IC_VEX_L_W_XS); 176 case IC_VEX_W_XD: 177 return VEX_LIG && inheritsFrom(child, IC_VEX_L_W_XD); 178 case IC_VEX_W_OPSIZE: 179 return VEX_LIG && inheritsFrom(child, IC_VEX_L_W_OPSIZE); 180 case IC_VEX_L: 181 return WIG && inheritsFrom(child, IC_VEX_L_W); 182 case IC_VEX_L_XS: 183 return WIG && inheritsFrom(child, IC_VEX_L_W_XS); 184 case IC_VEX_L_XD: 185 return WIG && inheritsFrom(child, IC_VEX_L_W_XD); 186 case IC_VEX_L_OPSIZE: 187 return WIG && inheritsFrom(child, IC_VEX_L_W_OPSIZE); 188 case IC_VEX_L_W: 189 case IC_VEX_L_W_XS: 190 case IC_VEX_L_W_XD: 191 case IC_VEX_L_W_OPSIZE: 192 return false; 193 case IC_EVEX: 194 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W)) || 195 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W)) || 196 (WIG && inheritsFrom(child, IC_EVEX_W)) || 197 (VEX_LIG && inheritsFrom(child, IC_EVEX_L)) || 198 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2)); 199 case IC_EVEX_XS: 200 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_XS)) || 201 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_XS)) || 202 (WIG && inheritsFrom(child, IC_EVEX_W_XS)) || 203 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_XS)) || 204 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_XS)); 205 case IC_EVEX_XD: 206 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_XD)) || 207 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_XD)) || 208 (WIG && inheritsFrom(child, IC_EVEX_W_XD)) || 209 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_XD)) || 210 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_XD)); 211 case IC_EVEX_OPSIZE: 212 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE)) || 213 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE)) || 214 (WIG && inheritsFrom(child, IC_EVEX_W_OPSIZE)) || 215 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_OPSIZE)) || 216 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_OPSIZE)); 217 case IC_EVEX_OPSIZE_ADSIZE: 218 case IC_EVEX_XS_ADSIZE: 219 case IC_EVEX_XD_ADSIZE: 220 return false; 221 case IC_EVEX_K: 222 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_K)) || 223 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_K)) || 224 (WIG && inheritsFrom(child, IC_EVEX_W_K)) || 225 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_K)) || 226 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_K)); 227 case IC_EVEX_XS_K: 228 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_XS_K)) || 229 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_XS_K)) || 230 (WIG && inheritsFrom(child, IC_EVEX_W_XS_K)) || 231 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_XS_K)) || 232 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_XS_K)); 233 case IC_EVEX_XD_K: 234 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_XD_K)) || 235 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_XD_K)) || 236 (WIG && inheritsFrom(child, IC_EVEX_W_XD_K)) || 237 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_XD_K)) || 238 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_XD_K)); 239 case IC_EVEX_OPSIZE_K: 240 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE_K)) || 241 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE_K)) || 242 (WIG && inheritsFrom(child, IC_EVEX_W_OPSIZE_K)) || 243 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_OPSIZE_K)) || 244 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_OPSIZE_K)); 245 case IC_EVEX_KZ: 246 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_KZ)) || 247 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_KZ)) || 248 (WIG && inheritsFrom(child, IC_EVEX_W_KZ)) || 249 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_KZ)) || 250 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_KZ)); 251 case IC_EVEX_XS_KZ: 252 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_XS_KZ)) || 253 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_XS_KZ)) || 254 (WIG && inheritsFrom(child, IC_EVEX_W_XS_KZ)) || 255 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_XS_KZ)) || 256 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_XS_KZ)); 257 case IC_EVEX_XD_KZ: 258 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_XD_KZ)) || 259 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_XD_KZ)) || 260 (WIG && inheritsFrom(child, IC_EVEX_W_XD_KZ)) || 261 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_XD_KZ)) || 262 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_XD_KZ)); 263 case IC_EVEX_OPSIZE_KZ: 264 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE_KZ)) || 265 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE_KZ)) || 266 (WIG && inheritsFrom(child, IC_EVEX_W_OPSIZE_KZ)) || 267 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_OPSIZE_KZ)) || 268 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_OPSIZE_KZ)); 269 case IC_EVEX_W: 270 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W)) || 271 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W)); 272 case IC_EVEX_W_XS: 273 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_XS)) || 274 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_XS)); 275 case IC_EVEX_W_XD: 276 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_XD)) || 277 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_XD)); 278 case IC_EVEX_W_OPSIZE: 279 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE)) || 280 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE)); 281 case IC_EVEX_W_K: 282 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_K)) || 283 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_K)); 284 case IC_EVEX_W_XS_K: 285 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_XS_K)) || 286 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_XS_K)); 287 case IC_EVEX_W_XD_K: 288 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_XD_K)) || 289 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_XD_K)); 290 case IC_EVEX_W_OPSIZE_K: 291 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE_K)) || 292 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE_K)); 293 case IC_EVEX_W_KZ: 294 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_KZ)) || 295 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_KZ)); 296 case IC_EVEX_W_XS_KZ: 297 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_XS_KZ)) || 298 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_XS_KZ)); 299 case IC_EVEX_W_XD_KZ: 300 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_XD_KZ)) || 301 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_XD_KZ)); 302 case IC_EVEX_W_OPSIZE_KZ: 303 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE_KZ)) || 304 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE_KZ)); 305 case IC_EVEX_L: 306 return WIG && inheritsFrom(child, IC_EVEX_L_W); 307 case IC_EVEX_L_XS: 308 return WIG && inheritsFrom(child, IC_EVEX_L_W_XS); 309 case IC_EVEX_L_XD: 310 return WIG && inheritsFrom(child, IC_EVEX_L_W_XD); 311 case IC_EVEX_L_OPSIZE: 312 return WIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE); 313 case IC_EVEX_L_K: 314 return WIG && inheritsFrom(child, IC_EVEX_L_W_K); 315 case IC_EVEX_L_XS_K: 316 return WIG && inheritsFrom(child, IC_EVEX_L_W_XS_K); 317 case IC_EVEX_L_XD_K: 318 return WIG && inheritsFrom(child, IC_EVEX_L_W_XD_K); 319 case IC_EVEX_L_OPSIZE_K: 320 return WIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE_K); 321 case IC_EVEX_L_KZ: 322 return WIG && inheritsFrom(child, IC_EVEX_L_W_KZ); 323 case IC_EVEX_L_XS_KZ: 324 return WIG && inheritsFrom(child, IC_EVEX_L_W_XS_KZ); 325 case IC_EVEX_L_XD_KZ: 326 return WIG && inheritsFrom(child, IC_EVEX_L_W_XD_KZ); 327 case IC_EVEX_L_OPSIZE_KZ: 328 return WIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE_KZ); 329 case IC_EVEX_L_W: 330 case IC_EVEX_L_W_XS: 331 case IC_EVEX_L_W_XD: 332 case IC_EVEX_L_W_OPSIZE: 333 return false; 334 case IC_EVEX_L_W_K: 335 case IC_EVEX_L_W_XS_K: 336 case IC_EVEX_L_W_XD_K: 337 case IC_EVEX_L_W_OPSIZE_K: 338 return false; 339 case IC_EVEX_L_W_KZ: 340 case IC_EVEX_L_W_XS_KZ: 341 case IC_EVEX_L_W_XD_KZ: 342 case IC_EVEX_L_W_OPSIZE_KZ: 343 return false; 344 case IC_EVEX_L2: 345 return WIG && inheritsFrom(child, IC_EVEX_L2_W); 346 case IC_EVEX_L2_XS: 347 return WIG && inheritsFrom(child, IC_EVEX_L2_W_XS); 348 case IC_EVEX_L2_XD: 349 return WIG && inheritsFrom(child, IC_EVEX_L2_W_XD); 350 case IC_EVEX_L2_OPSIZE: 351 return WIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE); 352 case IC_EVEX_L2_K: 353 return WIG && inheritsFrom(child, IC_EVEX_L2_W_K); 354 case IC_EVEX_L2_XS_K: 355 return WIG && inheritsFrom(child, IC_EVEX_L2_W_XS_K); 356 case IC_EVEX_L2_XD_K: 357 return WIG && inheritsFrom(child, IC_EVEX_L2_W_XD_K); 358 case IC_EVEX_L2_OPSIZE_K: 359 return WIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE_K); 360 case IC_EVEX_L2_KZ: 361 return WIG && inheritsFrom(child, IC_EVEX_L2_W_KZ); 362 case IC_EVEX_L2_XS_KZ: 363 return WIG && inheritsFrom(child, IC_EVEX_L2_W_XS_KZ); 364 case IC_EVEX_L2_XD_KZ: 365 return WIG && inheritsFrom(child, IC_EVEX_L2_W_XD_KZ); 366 case IC_EVEX_L2_OPSIZE_KZ: 367 return WIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE_KZ); 368 case IC_EVEX_L2_W: 369 case IC_EVEX_L2_W_XS: 370 case IC_EVEX_L2_W_XD: 371 case IC_EVEX_L2_W_OPSIZE: 372 return false; 373 case IC_EVEX_L2_W_K: 374 case IC_EVEX_L2_W_XS_K: 375 case IC_EVEX_L2_W_XD_K: 376 case IC_EVEX_L2_W_OPSIZE_K: 377 return false; 378 case IC_EVEX_L2_W_KZ: 379 case IC_EVEX_L2_W_XS_KZ: 380 case IC_EVEX_L2_W_XD_KZ: 381 case IC_EVEX_L2_W_OPSIZE_KZ: 382 return false; 383 case IC_EVEX_B: 384 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_B)) || 385 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_B)) || 386 (WIG && inheritsFrom(child, IC_EVEX_W_B)) || 387 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_B)) || 388 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_B)); 389 case IC_EVEX_XS_B: 390 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_XS_B)) || 391 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_XS_B)) || 392 (WIG && inheritsFrom(child, IC_EVEX_W_XS_B)) || 393 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_XS_B)) || 394 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_XS_B)); 395 case IC_EVEX_XD_B: 396 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_XD_B)) || 397 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_XD_B)) || 398 (WIG && inheritsFrom(child, IC_EVEX_W_XD_B)) || 399 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_XD_B)) || 400 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_XD_B)); 401 case IC_EVEX_OPSIZE_B: 402 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE_B)) || 403 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE_B)) || 404 (WIG && inheritsFrom(child, IC_EVEX_W_OPSIZE_B)) || 405 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_OPSIZE_B)) || 406 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_OPSIZE_B)); 407 case IC_EVEX_K_B: 408 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_K_B)) || 409 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_K_B)) || 410 (WIG && inheritsFrom(child, IC_EVEX_W_K_B)) || 411 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_K_B)) || 412 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_K_B)); 413 case IC_EVEX_XS_K_B: 414 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_XS_K_B)) || 415 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_XS_K_B)) || 416 (WIG && inheritsFrom(child, IC_EVEX_W_XS_K_B)) || 417 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_XS_K_B)) || 418 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_XS_K_B)); 419 case IC_EVEX_XD_K_B: 420 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_XD_K_B)) || 421 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_XD_K_B)) || 422 (WIG && inheritsFrom(child, IC_EVEX_W_XD_K_B)) || 423 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_XD_K_B)) || 424 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_XD_K_B)); 425 case IC_EVEX_OPSIZE_K_B: 426 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE_K_B)) || 427 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE_K_B)) || 428 (WIG && inheritsFrom(child, IC_EVEX_W_OPSIZE_K_B)) || 429 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_OPSIZE_K_B)) || 430 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_OPSIZE_K_B)); 431 case IC_EVEX_KZ_B: 432 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_KZ_B)) || 433 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_KZ_B)) || 434 (WIG && inheritsFrom(child, IC_EVEX_W_KZ_B)) || 435 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_KZ_B)) || 436 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_KZ_B)); 437 case IC_EVEX_XS_KZ_B: 438 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_XS_KZ_B)) || 439 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_XS_KZ_B)) || 440 (WIG && inheritsFrom(child, IC_EVEX_W_XS_KZ_B)) || 441 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_XS_KZ_B)) || 442 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_XS_KZ_B)); 443 case IC_EVEX_XD_KZ_B: 444 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_XD_KZ_B)) || 445 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_XD_KZ_B)) || 446 (WIG && inheritsFrom(child, IC_EVEX_W_XD_KZ_B)) || 447 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_XD_KZ_B)) || 448 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_XD_KZ_B)); 449 case IC_EVEX_OPSIZE_KZ_B: 450 return (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE_KZ_B)) || 451 (VEX_LIG && WIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE_KZ_B)) || 452 (WIG && inheritsFrom(child, IC_EVEX_W_OPSIZE_KZ_B)) || 453 (VEX_LIG && inheritsFrom(child, IC_EVEX_L_OPSIZE_KZ_B)) || 454 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_OPSIZE_KZ_B)); 455 case IC_EVEX_W_B: 456 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_B)) || 457 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_B)); 458 case IC_EVEX_W_XS_B: 459 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_XS_B)) || 460 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_XS_B)); 461 case IC_EVEX_W_XD_B: 462 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_XD_B)) || 463 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_XD_B)); 464 case IC_EVEX_W_OPSIZE_B: 465 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE_B)) || 466 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE_B)); 467 case IC_EVEX_W_K_B: 468 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_K_B)) || 469 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_K_B)); 470 case IC_EVEX_W_XS_K_B: 471 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_XS_K_B)) || 472 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_XS_K_B)); 473 case IC_EVEX_W_XD_K_B: 474 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_XD_K_B)) || 475 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_XD_K_B)); 476 case IC_EVEX_W_OPSIZE_K_B: 477 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE_K_B)) || 478 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE_K_B)); 479 case IC_EVEX_W_KZ_B: 480 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_KZ_B)) || 481 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_KZ_B)); 482 case IC_EVEX_W_XS_KZ_B: 483 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_XS_KZ_B)) || 484 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_XS_KZ_B)); 485 case IC_EVEX_W_XD_KZ_B: 486 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_XD_KZ_B)) || 487 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_XD_KZ_B)); 488 case IC_EVEX_W_OPSIZE_KZ_B: 489 return (VEX_LIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE_KZ_B)) || 490 (VEX_LIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE_KZ_B)); 491 case IC_EVEX_L_B: 492 return WIG && inheritsFrom(child, IC_EVEX_L_W_B); 493 case IC_EVEX_L_XS_B: 494 return WIG && inheritsFrom(child, IC_EVEX_L_W_XS_B); 495 case IC_EVEX_L_XD_B: 496 return WIG && inheritsFrom(child, IC_EVEX_L_W_XD_B); 497 case IC_EVEX_L_OPSIZE_B: 498 return WIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE_B); 499 case IC_EVEX_L_K_B: 500 return WIG && inheritsFrom(child, IC_EVEX_L_W_K_B); 501 case IC_EVEX_L_XS_K_B: 502 return WIG && inheritsFrom(child, IC_EVEX_L_W_XS_K_B); 503 case IC_EVEX_L_XD_K_B: 504 return WIG && inheritsFrom(child, IC_EVEX_L_W_XD_K_B); 505 case IC_EVEX_L_OPSIZE_K_B: 506 return WIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE_K_B); 507 case IC_EVEX_L_KZ_B: 508 return WIG && inheritsFrom(child, IC_EVEX_L_W_KZ_B); 509 case IC_EVEX_L_XS_KZ_B: 510 return WIG && inheritsFrom(child, IC_EVEX_L_W_XS_KZ_B); 511 case IC_EVEX_L_XD_KZ_B: 512 return WIG && inheritsFrom(child, IC_EVEX_L_W_XD_KZ_B); 513 case IC_EVEX_L_OPSIZE_KZ_B: 514 return WIG && inheritsFrom(child, IC_EVEX_L_W_OPSIZE_KZ_B); 515 case IC_EVEX_L_W_B: 516 case IC_EVEX_L_W_XS_B: 517 case IC_EVEX_L_W_XD_B: 518 case IC_EVEX_L_W_OPSIZE_B: 519 return false; 520 case IC_EVEX_L_W_K_B: 521 case IC_EVEX_L_W_XS_K_B: 522 case IC_EVEX_L_W_XD_K_B: 523 case IC_EVEX_L_W_OPSIZE_K_B: 524 return false; 525 case IC_EVEX_L_W_KZ_B: 526 case IC_EVEX_L_W_XS_KZ_B: 527 case IC_EVEX_L_W_XD_KZ_B: 528 case IC_EVEX_L_W_OPSIZE_KZ_B: 529 return false; 530 case IC_EVEX_L2_B: 531 return WIG && inheritsFrom(child, IC_EVEX_L2_W_B); 532 case IC_EVEX_L2_XS_B: 533 return WIG && inheritsFrom(child, IC_EVEX_L2_W_XS_B); 534 case IC_EVEX_L2_XD_B: 535 return WIG && inheritsFrom(child, IC_EVEX_L2_W_XD_B); 536 case IC_EVEX_L2_OPSIZE_B: 537 return WIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE_B); 538 case IC_EVEX_L2_K_B: 539 return WIG && inheritsFrom(child, IC_EVEX_L2_W_K_B); 540 case IC_EVEX_L2_XS_K_B: 541 return WIG && inheritsFrom(child, IC_EVEX_L2_W_XS_K_B); 542 case IC_EVEX_L2_XD_K_B: 543 return WIG && inheritsFrom(child, IC_EVEX_L2_W_XD_K_B); 544 case IC_EVEX_L2_OPSIZE_K_B: 545 return WIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE_K_B); 546 case IC_EVEX_L2_KZ_B: 547 return WIG && inheritsFrom(child, IC_EVEX_L2_W_KZ_B); 548 case IC_EVEX_L2_XS_KZ_B: 549 return WIG && inheritsFrom(child, IC_EVEX_L2_W_XS_KZ_B); 550 case IC_EVEX_L2_XD_KZ_B: 551 return WIG && inheritsFrom(child, IC_EVEX_L2_W_XD_KZ_B); 552 case IC_EVEX_L2_OPSIZE_KZ_B: 553 return WIG && inheritsFrom(child, IC_EVEX_L2_W_OPSIZE_KZ_B); 554 case IC_EVEX_L2_W_B: 555 case IC_EVEX_L2_W_XS_B: 556 case IC_EVEX_L2_W_XD_B: 557 case IC_EVEX_L2_W_OPSIZE_B: 558 return false; 559 case IC_EVEX_L2_W_K_B: 560 case IC_EVEX_L2_W_XS_K_B: 561 case IC_EVEX_L2_W_XD_K_B: 562 case IC_EVEX_L2_W_OPSIZE_K_B: 563 return false; 564 case IC_EVEX_L2_W_KZ_B: 565 case IC_EVEX_L2_W_XS_KZ_B: 566 case IC_EVEX_L2_W_XD_KZ_B: 567 case IC_EVEX_L2_W_OPSIZE_KZ_B: 568 return false; 569 case IC_EVEX_NF: 570 return WIG && inheritsFrom(child, IC_EVEX_W_NF); 571 case IC_EVEX_B_NF: 572 return WIG && inheritsFrom(child, IC_EVEX_W_B_NF); 573 case IC_EVEX_OPSIZE_NF: 574 case IC_EVEX_OPSIZE_B_NF: 575 case IC_EVEX_W_NF: 576 case IC_EVEX_W_B_NF: 577 return false; 578 case IC_EVEX_B_U: 579 case IC_EVEX_XS_B_U: 580 case IC_EVEX_XD_B_U: 581 case IC_EVEX_OPSIZE_B_U: 582 case IC_EVEX_W_B_U: 583 case IC_EVEX_W_XS_B_U: 584 case IC_EVEX_W_XD_B_U: 585 case IC_EVEX_W_OPSIZE_B_U: 586 case IC_EVEX_K_B_U: 587 case IC_EVEX_XS_K_B_U: 588 case IC_EVEX_XD_K_B_U: 589 case IC_EVEX_OPSIZE_K_B_U: 590 case IC_EVEX_W_K_B_U: 591 case IC_EVEX_W_XS_K_B_U: 592 case IC_EVEX_W_XD_K_B_U: 593 case IC_EVEX_W_OPSIZE_K_B_U: 594 case IC_EVEX_KZ_B_U: 595 case IC_EVEX_XS_KZ_B_U: 596 case IC_EVEX_XD_KZ_B_U: 597 case IC_EVEX_OPSIZE_KZ_B_U: 598 case IC_EVEX_W_KZ_B_U: 599 case IC_EVEX_W_XS_KZ_B_U: 600 case IC_EVEX_W_XD_KZ_B_U: 601 case IC_EVEX_W_OPSIZE_KZ_B_U: 602 return false; 603 default: 604 errs() << "Unknown instruction class: " 605 << stringForContext((InstructionContext)parent) << "\n"; 606 llvm_unreachable("Unknown instruction class"); 607 } 608 } 609 610 /// outranks - Indicates whether, if an instruction has two different applicable 611 /// classes, which class should be preferred when performing decode. This 612 /// imposes a total ordering (ties are resolved toward "lower") 613 /// 614 /// @param upper - The class that may be preferable 615 /// @param lower - The class that may be less preferable 616 /// @return - True if upper is to be preferred, false otherwise. 617 static inline bool outranks(InstructionContext upper, 618 InstructionContext lower) { 619 assert(upper < IC_max); 620 assert(lower < IC_max); 621 622 #define ENUM_ENTRY(n, r, d) r, 623 #define ENUM_ENTRY_K_B(n, r, d) \ 624 ENUM_ENTRY(n, r, d) \ 625 ENUM_ENTRY(n##_K_B, r, d) \ 626 ENUM_ENTRY(n##_KZ_B, r, d) \ 627 ENUM_ENTRY(n##_KZ, r, d) ENUM_ENTRY(n##_K, r, d) ENUM_ENTRY(n##_B, r, d) 628 static int ranks[IC_max] = {INSTRUCTION_CONTEXTS}; 629 #undef ENUM_ENTRY 630 #undef ENUM_ENTRY_K_B 631 632 return (ranks[upper] > ranks[lower]); 633 } 634 635 /// getDecisionType - Determines whether a ModRM decision with 255 entries can 636 /// be compacted by eliminating redundant information. 637 /// 638 /// @param decision - The decision to be compacted. 639 /// @return - The compactest available representation for the decision. 640 static ModRMDecisionType getDecisionType(ModRMDecision &decision) { 641 bool satisfiesOneEntry = true; 642 bool satisfiesSplitRM = true; 643 bool satisfiesSplitReg = true; 644 bool satisfiesSplitMisc = true; 645 646 for (unsigned index = 0; index < 256; ++index) { 647 if (decision.instructionIDs[index] != decision.instructionIDs[0]) 648 satisfiesOneEntry = false; 649 650 if (((index & 0xc0) == 0xc0) && 651 (decision.instructionIDs[index] != decision.instructionIDs[0xc0])) 652 satisfiesSplitRM = false; 653 654 if (((index & 0xc0) != 0xc0) && 655 (decision.instructionIDs[index] != decision.instructionIDs[0x00])) 656 satisfiesSplitRM = false; 657 658 if (((index & 0xc0) == 0xc0) && (decision.instructionIDs[index] != 659 decision.instructionIDs[index & 0xf8])) 660 satisfiesSplitReg = false; 661 662 if (((index & 0xc0) != 0xc0) && (decision.instructionIDs[index] != 663 decision.instructionIDs[index & 0x38])) 664 satisfiesSplitMisc = false; 665 } 666 667 if (satisfiesOneEntry) 668 return MODRM_ONEENTRY; 669 670 if (satisfiesSplitRM) 671 return MODRM_SPLITRM; 672 673 if (satisfiesSplitReg && satisfiesSplitMisc) 674 return MODRM_SPLITREG; 675 676 if (satisfiesSplitMisc) 677 return MODRM_SPLITMISC; 678 679 return MODRM_FULL; 680 } 681 682 /// stringForDecisionType - Returns a statically-allocated string corresponding 683 /// to a particular decision type. 684 /// 685 /// @param dt - The decision type. 686 /// @return - A pointer to the statically-allocated string (e.g., 687 /// "MODRM_ONEENTRY" for MODRM_ONEENTRY). 688 static const char *stringForDecisionType(ModRMDecisionType dt) { 689 #define ENUM_ENTRY(n) \ 690 case n: \ 691 return #n; 692 switch (dt) { 693 default: 694 llvm_unreachable("Unknown decision type"); 695 MODRMTYPES 696 }; 697 #undef ENUM_ENTRY 698 } 699 700 DisassemblerTables::DisassemblerTables() { 701 for (unsigned i = 0; i < std::size(Tables); i++) 702 Tables[i] = std::make_unique<ContextDecision>(); 703 704 HasConflicts = false; 705 } 706 707 DisassemblerTables::~DisassemblerTables() {} 708 709 void DisassemblerTables::emitModRMDecision(raw_ostream &o1, raw_ostream &o2, 710 unsigned &i1, unsigned &i2, 711 unsigned &ModRMTableNum, 712 ModRMDecision &decision) const { 713 static uint32_t sEntryNumber = 1; 714 ModRMDecisionType dt = getDecisionType(decision); 715 716 if (dt == MODRM_ONEENTRY && decision.instructionIDs[0] == 0) { 717 // Empty table. 718 o2 << "{" << stringForDecisionType(dt) << ", 0}"; 719 return; 720 } 721 722 std::vector<unsigned> ModRMDecision; 723 724 switch (dt) { 725 default: 726 llvm_unreachable("Unknown decision type"); 727 case MODRM_ONEENTRY: 728 ModRMDecision.push_back(decision.instructionIDs[0]); 729 break; 730 case MODRM_SPLITRM: 731 ModRMDecision.push_back(decision.instructionIDs[0x00]); 732 ModRMDecision.push_back(decision.instructionIDs[0xc0]); 733 break; 734 case MODRM_SPLITREG: 735 for (unsigned index = 0; index < 64; index += 8) 736 ModRMDecision.push_back(decision.instructionIDs[index]); 737 for (unsigned index = 0xc0; index < 256; index += 8) 738 ModRMDecision.push_back(decision.instructionIDs[index]); 739 break; 740 case MODRM_SPLITMISC: 741 for (unsigned index = 0; index < 64; index += 8) 742 ModRMDecision.push_back(decision.instructionIDs[index]); 743 for (unsigned index = 0xc0; index < 256; ++index) 744 ModRMDecision.push_back(decision.instructionIDs[index]); 745 break; 746 case MODRM_FULL: 747 for (unsigned short InstructionID : decision.instructionIDs) 748 ModRMDecision.push_back(InstructionID); 749 break; 750 } 751 752 unsigned &EntryNumber = ModRMTable[ModRMDecision]; 753 if (EntryNumber == 0) { 754 EntryNumber = ModRMTableNum; 755 756 ModRMTableNum += ModRMDecision.size(); 757 o1 << "/*Table" << EntryNumber << "*/\n"; 758 i1++; 759 for (unsigned I : ModRMDecision) { 760 o1.indent(i1 * 2) << format("0x%hx", I) << ", /*" 761 << InstructionSpecifiers[I].name << "*/\n"; 762 } 763 i1--; 764 } 765 766 o2 << "{" << stringForDecisionType(dt) << ", " << EntryNumber << "}"; 767 768 switch (dt) { 769 default: 770 llvm_unreachable("Unknown decision type"); 771 case MODRM_ONEENTRY: 772 sEntryNumber += 1; 773 break; 774 case MODRM_SPLITRM: 775 sEntryNumber += 2; 776 break; 777 case MODRM_SPLITREG: 778 sEntryNumber += 16; 779 break; 780 case MODRM_SPLITMISC: 781 sEntryNumber += 8 + 64; 782 break; 783 case MODRM_FULL: 784 sEntryNumber += 256; 785 break; 786 } 787 788 // We assume that the index can fit into uint16_t. 789 assert(sEntryNumber < 65536U && 790 "Index into ModRMDecision is too large for uint16_t!"); 791 (void)sEntryNumber; 792 } 793 794 void DisassemblerTables::emitOpcodeDecision(raw_ostream &o1, raw_ostream &o2, 795 unsigned &i1, unsigned &i2, 796 unsigned &ModRMTableNum, 797 OpcodeDecision &opDecision) const { 798 o2 << "{"; 799 ++i2; 800 801 unsigned index; 802 for (index = 0; index < 256; ++index) { 803 auto &decision = opDecision.modRMDecisions[index]; 804 ModRMDecisionType dt = getDecisionType(decision); 805 if (!(dt == MODRM_ONEENTRY && decision.instructionIDs[0] == 0)) 806 break; 807 } 808 if (index == 256) { 809 // If all 256 entries are MODRM_ONEENTRY, omit output. 810 static_assert(MODRM_ONEENTRY == 0); 811 --i2; 812 o2 << "},\n"; 813 } else { 814 o2 << " /* struct OpcodeDecision */ {\n"; 815 for (index = 0; index < 256; ++index) { 816 o2.indent(i2); 817 818 o2 << "/*0x" << format("%02hhx", index) << "*/"; 819 820 emitModRMDecision(o1, o2, i1, i2, ModRMTableNum, 821 opDecision.modRMDecisions[index]); 822 823 if (index < 255) 824 o2 << ","; 825 826 o2 << "\n"; 827 } 828 o2.indent(i2) << "}\n"; 829 --i2; 830 o2.indent(i2) << "},\n"; 831 } 832 } 833 834 void DisassemblerTables::emitContextDecision(raw_ostream &o1, raw_ostream &o2, 835 unsigned &i1, unsigned &i2, 836 unsigned &ModRMTableNum, 837 ContextDecision &decision, 838 const char *name) const { 839 o2.indent(i2) << "static const struct ContextDecision " << name 840 << " = {{/* opcodeDecisions */\n"; 841 i2++; 842 843 for (unsigned index = 0; index < IC_max; ++index) { 844 o2.indent(i2) << "/*"; 845 o2 << stringForContext((InstructionContext)index); 846 o2 << "*/ "; 847 848 emitOpcodeDecision(o1, o2, i1, i2, ModRMTableNum, 849 decision.opcodeDecisions[index]); 850 } 851 852 i2--; 853 o2.indent(i2) << "}};" 854 << "\n"; 855 } 856 857 void DisassemblerTables::emitInstructionInfo(raw_ostream &o, 858 unsigned &i) const { 859 unsigned NumInstructions = InstructionSpecifiers.size(); 860 861 o << "static const struct OperandSpecifier x86OperandSets[][" 862 << X86_MAX_OPERANDS << "] = {\n"; 863 864 typedef SmallVector<std::pair<OperandEncoding, OperandType>, X86_MAX_OPERANDS> 865 OperandListTy; 866 std::map<OperandListTy, unsigned> OperandSets; 867 868 unsigned OperandSetNum = 0; 869 for (unsigned Index = 0; Index < NumInstructions; ++Index) { 870 OperandListTy OperandList; 871 872 for (auto Operand : InstructionSpecifiers[Index].operands) { 873 OperandEncoding Encoding = (OperandEncoding)Operand.encoding; 874 OperandType Type = (OperandType)Operand.type; 875 OperandList.push_back(std::pair(Encoding, Type)); 876 } 877 unsigned &N = OperandSets[OperandList]; 878 if (N != 0) 879 continue; 880 881 N = ++OperandSetNum; 882 883 o << " { /* " << (OperandSetNum - 1) << " */\n"; 884 for (unsigned i = 0, e = OperandList.size(); i != e; ++i) { 885 const char *Encoding = stringForOperandEncoding(OperandList[i].first); 886 const char *Type = stringForOperandType(OperandList[i].second); 887 o << " { " << Encoding << ", " << Type << " },\n"; 888 } 889 o << " },\n"; 890 } 891 o << "};" 892 << "\n\n"; 893 894 o.indent(i * 2) << "static const struct InstructionSpecifier "; 895 o << INSTRUCTIONS_STR "[" << InstructionSpecifiers.size() << "] = {\n"; 896 897 i++; 898 899 for (unsigned index = 0; index < NumInstructions; ++index) { 900 o.indent(i * 2) << "{ /* " << index << " */\n"; 901 i++; 902 903 OperandListTy OperandList; 904 for (auto Operand : InstructionSpecifiers[index].operands) { 905 OperandEncoding Encoding = (OperandEncoding)Operand.encoding; 906 OperandType Type = (OperandType)Operand.type; 907 OperandList.push_back(std::pair(Encoding, Type)); 908 } 909 o.indent(i * 2) << (OperandSets[OperandList] - 1) << ",\n"; 910 911 o.indent(i * 2) << "/* " << InstructionSpecifiers[index].name << " */\n"; 912 913 i--; 914 o.indent(i * 2) << "},\n"; 915 } 916 917 i--; 918 o.indent(i * 2) << "};" 919 << "\n"; 920 } 921 922 void DisassemblerTables::emitContextTable(raw_ostream &o, unsigned &i) const { 923 o.indent(i * 2) << "static const uint8_t " CONTEXTS_STR "[" << ATTR_max 924 << "] = {\n"; 925 i++; 926 927 for (unsigned index = 0; index < ATTR_max; ++index) { 928 o.indent(i * 2); 929 930 if ((index & ATTR_EVEX) && (index & ATTR_ADSIZE) && (index & ATTR_OPSIZE)) 931 o << "IC_EVEX_OPSIZE_ADSIZE"; 932 else if ((index & ATTR_EVEX) && (index & ATTR_ADSIZE) && (index & ATTR_XD)) 933 o << "IC_EVEX_XD_ADSIZE"; 934 else if ((index & ATTR_EVEX) && (index & ATTR_ADSIZE) && (index & ATTR_XS)) 935 o << "IC_EVEX_XS_ADSIZE"; 936 else if (index & ATTR_EVEXNF) { 937 o << "IC_EVEX"; 938 if (index & ATTR_REXW) 939 o << "_W"; 940 else if (index & ATTR_OPSIZE) 941 o << "_OPSIZE"; 942 943 if (index & ATTR_EVEXB) 944 o << "_B"; 945 946 o << "_NF"; 947 } else if ((index & ATTR_EVEX) || (index & ATTR_VEX) || 948 (index & ATTR_VEXL)) { 949 if (index & ATTR_EVEX) 950 o << "IC_EVEX"; 951 else 952 o << "IC_VEX"; 953 954 if ((index & ATTR_EVEXB) && (index & ATTR_EVEXU)) 955 ; // Ignore ATTR_VEXL and ATTR_EVEXL2 under YMM rounding. 956 else if ((index & ATTR_EVEX) && (index & ATTR_EVEXL2)) 957 o << "_L2"; 958 else if (index & ATTR_VEXL) 959 o << "_L"; 960 961 if (index & ATTR_REXW) 962 o << "_W"; 963 964 if (index & ATTR_OPSIZE) 965 o << "_OPSIZE"; 966 else if (index & ATTR_XD) 967 o << "_XD"; 968 else if (index & ATTR_XS) 969 o << "_XS"; 970 971 if (index & ATTR_EVEX) { 972 if (index & ATTR_EVEXKZ) 973 o << "_KZ"; 974 else if (index & ATTR_EVEXK) 975 o << "_K"; 976 977 if (index & ATTR_EVEXB) 978 o << "_B"; 979 980 if ((index & ATTR_EVEXB) && (index & ATTR_EVEXU)) 981 o << "_U"; 982 } 983 } else if ((index & ATTR_64BIT) && (index & ATTR_REX2)) 984 o << "IC_64BIT_REX2"; 985 else if ((index & ATTR_64BIT) && (index & ATTR_REXW) && (index & ATTR_XS)) 986 o << "IC_64BIT_REXW_XS"; 987 else if ((index & ATTR_64BIT) && (index & ATTR_REXW) && (index & ATTR_XD)) 988 o << "IC_64BIT_REXW_XD"; 989 else if ((index & ATTR_64BIT) && (index & ATTR_REXW) && 990 (index & ATTR_OPSIZE)) 991 o << "IC_64BIT_REXW_OPSIZE"; 992 else if ((index & ATTR_64BIT) && (index & ATTR_REXW) && 993 (index & ATTR_ADSIZE)) 994 o << "IC_64BIT_REXW_ADSIZE"; 995 else if ((index & ATTR_64BIT) && (index & ATTR_XD) && (index & ATTR_OPSIZE)) 996 o << "IC_64BIT_XD_OPSIZE"; 997 else if ((index & ATTR_64BIT) && (index & ATTR_XD) && (index & ATTR_ADSIZE)) 998 o << "IC_64BIT_XD_ADSIZE"; 999 else if ((index & ATTR_64BIT) && (index & ATTR_XS) && (index & ATTR_OPSIZE)) 1000 o << "IC_64BIT_XS_OPSIZE"; 1001 else if ((index & ATTR_64BIT) && (index & ATTR_XS) && (index & ATTR_ADSIZE)) 1002 o << "IC_64BIT_XS_ADSIZE"; 1003 else if ((index & ATTR_64BIT) && (index & ATTR_XS)) 1004 o << "IC_64BIT_XS"; 1005 else if ((index & ATTR_64BIT) && (index & ATTR_XD)) 1006 o << "IC_64BIT_XD"; 1007 else if ((index & ATTR_64BIT) && (index & ATTR_OPSIZE) && 1008 (index & ATTR_ADSIZE)) 1009 o << "IC_64BIT_OPSIZE_ADSIZE"; 1010 else if ((index & ATTR_64BIT) && (index & ATTR_OPSIZE)) 1011 o << "IC_64BIT_OPSIZE"; 1012 else if ((index & ATTR_64BIT) && (index & ATTR_ADSIZE)) 1013 o << "IC_64BIT_ADSIZE"; 1014 else if ((index & ATTR_64BIT) && (index & ATTR_REXW)) 1015 o << "IC_64BIT_REXW"; 1016 else if ((index & ATTR_64BIT)) 1017 o << "IC_64BIT"; 1018 else if ((index & ATTR_XS) && (index & ATTR_OPSIZE)) 1019 o << "IC_XS_OPSIZE"; 1020 else if ((index & ATTR_XD) && (index & ATTR_OPSIZE)) 1021 o << "IC_XD_OPSIZE"; 1022 else if ((index & ATTR_XS) && (index & ATTR_ADSIZE)) 1023 o << "IC_XS_ADSIZE"; 1024 else if ((index & ATTR_XD) && (index & ATTR_ADSIZE)) 1025 o << "IC_XD_ADSIZE"; 1026 else if (index & ATTR_XS) 1027 o << "IC_XS"; 1028 else if (index & ATTR_XD) 1029 o << "IC_XD"; 1030 else if ((index & ATTR_OPSIZE) && (index & ATTR_ADSIZE)) 1031 o << "IC_OPSIZE_ADSIZE"; 1032 else if (index & ATTR_OPSIZE) 1033 o << "IC_OPSIZE"; 1034 else if (index & ATTR_ADSIZE) 1035 o << "IC_ADSIZE"; 1036 else 1037 o << "IC"; 1038 1039 o << ", // " << index << "\n"; 1040 } 1041 1042 i--; 1043 o.indent(i * 2) << "};" 1044 << "\n"; 1045 } 1046 1047 void DisassemblerTables::emitContextDecisions(raw_ostream &o1, raw_ostream &o2, 1048 unsigned &i1, unsigned &i2, 1049 unsigned &ModRMTableNum) const { 1050 emitContextDecision(o1, o2, i1, i2, ModRMTableNum, *Tables[0], ONEBYTE_STR); 1051 emitContextDecision(o1, o2, i1, i2, ModRMTableNum, *Tables[1], TWOBYTE_STR); 1052 emitContextDecision(o1, o2, i1, i2, ModRMTableNum, *Tables[2], 1053 THREEBYTE38_STR); 1054 emitContextDecision(o1, o2, i1, i2, ModRMTableNum, *Tables[3], 1055 THREEBYTE3A_STR); 1056 emitContextDecision(o1, o2, i1, i2, ModRMTableNum, *Tables[4], XOP8_MAP_STR); 1057 emitContextDecision(o1, o2, i1, i2, ModRMTableNum, *Tables[5], XOP9_MAP_STR); 1058 emitContextDecision(o1, o2, i1, i2, ModRMTableNum, *Tables[6], XOPA_MAP_STR); 1059 emitContextDecision(o1, o2, i1, i2, ModRMTableNum, *Tables[7], 1060 THREEDNOW_MAP_STR); 1061 emitContextDecision(o1, o2, i1, i2, ModRMTableNum, *Tables[8], MAP4_STR); 1062 emitContextDecision(o1, o2, i1, i2, ModRMTableNum, *Tables[9], MAP5_STR); 1063 emitContextDecision(o1, o2, i1, i2, ModRMTableNum, *Tables[10], MAP6_STR); 1064 emitContextDecision(o1, o2, i1, i2, ModRMTableNum, *Tables[11], MAP7_STR); 1065 } 1066 1067 void DisassemblerTables::emit(raw_ostream &o) const { 1068 unsigned i1 = 0; 1069 unsigned i2 = 0; 1070 1071 std::string s1; 1072 std::string s2; 1073 1074 raw_string_ostream o1(s1); 1075 raw_string_ostream o2(s2); 1076 1077 emitInstructionInfo(o, i2); 1078 o << "\n"; 1079 1080 emitContextTable(o, i2); 1081 o << "\n"; 1082 1083 unsigned ModRMTableNum = 0; 1084 1085 o << "static const InstrUID modRMTable[] = {\n"; 1086 i1++; 1087 std::vector<unsigned> EmptyTable(1, 0); 1088 ModRMTable[EmptyTable] = ModRMTableNum; 1089 ModRMTableNum += EmptyTable.size(); 1090 o1 << "/*EmptyTable*/\n"; 1091 o1.indent(i1 * 2) << "0x0,\n"; 1092 i1--; 1093 emitContextDecisions(o1, o2, i1, i2, ModRMTableNum); 1094 1095 o << s1; 1096 o << " 0x0\n"; 1097 o << "};\n"; 1098 o << "\n"; 1099 o << s2; 1100 o << "\n"; 1101 o << "\n"; 1102 } 1103 1104 void DisassemblerTables::setTableFields(ModRMDecision &decision, 1105 const ModRMFilter &filter, InstrUID uid, 1106 uint8_t opcode) { 1107 for (unsigned index = 0; index < 256; ++index) { 1108 if (filter.accepts(index)) { 1109 if (decision.instructionIDs[index] == uid) 1110 continue; 1111 1112 if (decision.instructionIDs[index] != 0) { 1113 InstructionSpecifier &newInfo = InstructionSpecifiers[uid]; 1114 InstructionSpecifier &previousInfo = 1115 InstructionSpecifiers[decision.instructionIDs[index]]; 1116 1117 if (previousInfo.name == "NOOP" && 1118 (newInfo.name == "XCHG16ar" || newInfo.name == "XCHG32ar" || 1119 newInfo.name == "XCHG64ar")) 1120 continue; // special case for XCHG*ar and NOOP 1121 1122 if (outranks(previousInfo.insnContext, newInfo.insnContext)) 1123 continue; 1124 1125 if (previousInfo.insnContext == newInfo.insnContext) { 1126 errs() << "Error: Primary decode conflict: "; 1127 errs() << newInfo.name << " would overwrite " << previousInfo.name; 1128 errs() << "\n"; 1129 errs() << "ModRM " << index << "\n"; 1130 errs() << "Opcode " << (uint16_t)opcode << "\n"; 1131 errs() << "Context " << stringForContext(newInfo.insnContext) << "\n"; 1132 HasConflicts = true; 1133 } 1134 } 1135 1136 decision.instructionIDs[index] = uid; 1137 } 1138 } 1139 } 1140 1141 void DisassemblerTables::setTableFields( 1142 OpcodeType type, InstructionContext insnContext, uint8_t opcode, 1143 const ModRMFilter &filter, InstrUID uid, bool is32bit, bool noPrefix, 1144 bool ignoresVEX_L, bool ignoresW, unsigned addressSize) { 1145 ContextDecision &decision = *Tables[type]; 1146 1147 for (unsigned index = 0; index < IC_max; ++index) { 1148 if ((is32bit || addressSize == 16) && 1149 inheritsFrom((InstructionContext)index, IC_64BIT)) 1150 continue; 1151 1152 bool adSize64 = addressSize == 64; 1153 if (inheritsFrom((InstructionContext)index, 1154 InstructionSpecifiers[uid].insnContext, noPrefix, 1155 ignoresVEX_L, ignoresW, adSize64)) 1156 setTableFields(decision.opcodeDecisions[index].modRMDecisions[opcode], 1157 filter, uid, opcode); 1158 } 1159 } 1160