utils/TableGen/X86RecognizableInstr.cpp

   1 //===- X86RecognizableInstr.cpp - Disassembler instruction spec --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file is part of the X86 Disassembler Emitter.
  11 // It contains the implementation of a single recognizable instruction.
  12 // Documentation for the disassembler emitter in general can be found in
  13 //  X86DisasemblerEmitter.h.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "X86DisassemblerShared.h"
  18 #include "X86RecognizableInstr.h"
  19 #include "X86ModRMFilters.h"
  20
  21 #include "llvm/Support/ErrorHandling.h"
  22
  23 #include <string>
  24
  25 using namespace llvm;
  26
  27 #define MRM_MAPPING     \
  28   MAP(C1, 33)           \
  29   MAP(C2, 34)           \
  30   MAP(C3, 35)           \
  31   MAP(C4, 36)           \
  32   MAP(C8, 37)           \
  33   MAP(C9, 38)           \
  34   MAP(E8, 39)           \
  35   MAP(F0, 40)           \
  36   MAP(F8, 41)
  37
  38 // A clone of X86 since we can't depend on something that is generated.
  39 namespace X86Local {
  40   enum {
  41     Pseudo      = 0,
  42     RawFrm      = 1,
  43     AddRegFrm   = 2,
  44     MRMDestReg  = 3,
  45     MRMDestMem  = 4,
  46     MRMSrcReg   = 5,
  47     MRMSrcMem   = 6,
  48     MRM0r = 16, MRM1r = 17, MRM2r = 18, MRM3r = 19,
  49     MRM4r = 20, MRM5r = 21, MRM6r = 22, MRM7r = 23,
  50     MRM0m = 24, MRM1m = 25, MRM2m = 26, MRM3m = 27,
  51     MRM4m = 28, MRM5m = 29, MRM6m = 30, MRM7m = 31,
  52     MRMInitReg  = 32,
  53
  54 #define MAP(from, to) MRM_##from = to,
  55     MRM_MAPPING
  56 #undef MAP
  57     lastMRM
  58   };
  59
  60   enum {
  61     TB  = 1,
  62     REP = 2,
  63     D8 = 3, D9 = 4, DA = 5, DB = 6,
  64     DC = 7, DD = 8, DE = 9, DF = 10,
  65     XD = 11,  XS = 12,
  66     T8 = 13,  P_TA = 14,
  67     P_0F_AE = 16, P_0F_01 = 17
  68   };
  69 }
  70
  71 // If rows are added to the opcode extension tables, then corresponding entries
  72 // must be added here.
  73 //
  74 // If the row corresponds to a single byte (i.e., 8f), then add an entry for
  75 // that byte to ONE_BYTE_EXTENSION_TABLES.
  76 //
  77 // If the row corresponds to two bytes where the first is 0f, add an entry for
  78 // the second byte to TWO_BYTE_EXTENSION_TABLES.
  79 //
  80 // If the row corresponds to some other set of bytes, you will need to modify
  81 // the code in RecognizableInstr::emitDecodePath() as well, and add new prefixes
  82 // to the X86 TD files, except in two cases: if the first two bytes of such a
  83 // new combination are 0f 38 or 0f 3a, you just have to add maps called
  84 // THREE_BYTE_38_EXTENSION_TABLES and THREE_BYTE_3A_EXTENSION_TABLES and add a
  85 // switch(Opcode) just below the case X86Local::T8: or case X86Local::TA: line
  86 // in RecognizableInstr::emitDecodePath().
  87
  88 #define ONE_BYTE_EXTENSION_TABLES \
  89   EXTENSION_TABLE(80)             \
  90   EXTENSION_TABLE(81)             \
  91   EXTENSION_TABLE(82)             \
  92   EXTENSION_TABLE(83)             \
  93   EXTENSION_TABLE(8f)             \
  94   EXTENSION_TABLE(c0)             \
  95   EXTENSION_TABLE(c1)             \
  96   EXTENSION_TABLE(c6)             \
  97   EXTENSION_TABLE(c7)             \
  98   EXTENSION_TABLE(d0)             \
  99   EXTENSION_TABLE(d1)             \
 100   EXTENSION_TABLE(d2)             \
 101   EXTENSION_TABLE(d3)             \
 102   EXTENSION_TABLE(f6)             \
 103   EXTENSION_TABLE(f7)             \
 104   EXTENSION_TABLE(fe)             \
 105   EXTENSION_TABLE(ff)
 106
 107 #define TWO_BYTE_EXTENSION_TABLES \
 108   EXTENSION_TABLE(00)             \
 109   EXTENSION_TABLE(01)             \
 110   EXTENSION_TABLE(18)             \
 111   EXTENSION_TABLE(71)             \
 112   EXTENSION_TABLE(72)             \
 113   EXTENSION_TABLE(73)             \
 114   EXTENSION_TABLE(ae)             \
 115   EXTENSION_TABLE(b9)             \
 116   EXTENSION_TABLE(ba)             \
 117   EXTENSION_TABLE(c7)
 118
 119 using namespace X86Disassembler;
 120
 121 /// needsModRMForDecode - Indicates whether a particular instruction requires a
 122 ///   ModR/M byte for the instruction to be properly decoded.  For example, a
 123 ///   MRMDestReg instruction needs the Mod field in the ModR/M byte to be set to
 124 ///   0b11.
 125 ///
 126 /// @param form - The form of the instruction.
 127 /// @return     - true if the form implies that a ModR/M byte is required, false
 128 ///               otherwise.
 129 static bool needsModRMForDecode(uint8_t form) {
 130   if (form == X86Local::MRMDestReg    ||
 131      form == X86Local::MRMDestMem    ||
 132      form == X86Local::MRMSrcReg     ||
 133      form == X86Local::MRMSrcMem     ||
 134      (form >= X86Local::MRM0r && form <= X86Local::MRM7r) ||
 135      (form >= X86Local::MRM0m && form <= X86Local::MRM7m))
 136     return true;
 137   else
 138     return false;
 139 }
 140
 141 /// isRegFormat - Indicates whether a particular form requires the Mod field of
 142 ///   the ModR/M byte to be 0b11.
 143 ///
 144 /// @param form - The form of the instruction.
 145 /// @return     - true if the form implies that Mod must be 0b11, false
 146 ///               otherwise.
 147 static bool isRegFormat(uint8_t form) {
 148   if (form == X86Local::MRMDestReg ||
 149      form == X86Local::MRMSrcReg  ||
 150      (form >= X86Local::MRM0r && form <= X86Local::MRM7r))
 151     return true;
 152   else
 153     return false;
 154 }
 155
 156 /// byteFromBitsInit - Extracts a value at most 8 bits in width from a BitsInit.
 157 ///   Useful for switch statements and the like.
 158 ///
 159 /// @param init - A reference to the BitsInit to be decoded.
 160 /// @return     - The field, with the first bit in the BitsInit as the lowest
 161 ///               order bit.
 162 static uint8_t byteFromBitsInit(BitsInit &init) {
 163   int width = init.getNumBits();
 164
 165   assert(width <= 8 && "Field is too large for uint8_t!");
 166
 167   int     index;
 168   uint8_t mask = 0x01;
 169
 170   uint8_t ret = 0;
 171
 172   for (index = 0; index < width; index++) {
 173     if (static_cast<BitInit*>(init.getBit(index))->getValue())
 174       ret |= mask;
 175
 176     mask <<= 1;
 177   }
 178
 179   return ret;
 180 }
 181
 182 /// byteFromRec - Extract a value at most 8 bits in with from a Record given the
 183 ///   name of the field.
 184 ///
 185 /// @param rec  - The record from which to extract the value.
 186 /// @param name - The name of the field in the record.
 187 /// @return     - The field, as translated by byteFromBitsInit().
 188 static uint8_t byteFromRec(const Record* rec, const std::string &name) {
 189   BitsInit* bits = rec->getValueAsBitsInit(name);
 190   return byteFromBitsInit(*bits);
 191 }
 192
 193 RecognizableInstr::RecognizableInstr(DisassemblerTables &tables,
 194                                      const CodeGenInstruction &insn,
 195                                      InstrUID uid) {
 196   UID = uid;
 197
 198   Rec = insn.TheDef;
 199   Name = Rec->getName();
 200   Spec = &tables.specForUID(UID);
 201
 202   if (!Rec->isSubClassOf("X86Inst")) {
 203     ShouldBeEmitted = false;
 204     return;
 205   }
 206
 207   Prefix   = byteFromRec(Rec, "Prefix");
 208   Opcode   = byteFromRec(Rec, "Opcode");
 209   Form     = byteFromRec(Rec, "FormBits");
 210   SegOvr   = byteFromRec(Rec, "SegOvrBits");
 211
 212   HasOpSizePrefix  = Rec->getValueAsBit("hasOpSizePrefix");
 213   HasREX_WPrefix   = Rec->getValueAsBit("hasREX_WPrefix");
 214   HasLockPrefix    = Rec->getValueAsBit("hasLockPrefix");
 215   IsCodeGenOnly    = Rec->getValueAsBit("isCodeGenOnly");
 216
 217   Name      = Rec->getName();
 218   AsmString = Rec->getValueAsString("AsmString");
 219
 220   Operands = &insn.OperandList;
 221
 222   IsSSE            = HasOpSizePrefix && (Name.find("16") == Name.npos);
 223   HasFROperands    = false;
 224
 225   ShouldBeEmitted  = true;
 226 }
 227
 228 void RecognizableInstr::processInstr(DisassemblerTables &tables,
 229                                    const CodeGenInstruction &insn,
 230                                    InstrUID uid)
 231 {
 232   RecognizableInstr recogInstr(tables, insn, uid);
 233
 234   recogInstr.emitInstructionSpecifier(tables);
 235
 236   if (recogInstr.shouldBeEmitted())
 237     recogInstr.emitDecodePath(tables);
 238 }
 239
 240 InstructionContext RecognizableInstr::insnContext() const {
 241   InstructionContext insnContext;
 242
 243   if (Name.find("64") != Name.npos || HasREX_WPrefix) {
 244     if (HasREX_WPrefix && HasOpSizePrefix)
 245       insnContext = IC_64BIT_REXW_OPSIZE;
 246     else if (HasOpSizePrefix)
 247       insnContext = IC_64BIT_OPSIZE;
 248     else if (HasREX_WPrefix && Prefix == X86Local::XS)
 249       insnContext = IC_64BIT_REXW_XS;
 250     else if (HasREX_WPrefix && Prefix == X86Local::XD)
 251       insnContext = IC_64BIT_REXW_XD;
 252     else if (Prefix == X86Local::XD)
 253       insnContext = IC_64BIT_XD;
 254     else if (Prefix == X86Local::XS)
 255       insnContext = IC_64BIT_XS;
 256     else if (HasREX_WPrefix)
 257       insnContext = IC_64BIT_REXW;
 258     else
 259       insnContext = IC_64BIT;
 260   } else {
 261     if (HasOpSizePrefix)
 262       insnContext = IC_OPSIZE;
 263     else if (Prefix == X86Local::XD)
 264       insnContext = IC_XD;
 265     else if (Prefix == X86Local::XS)
 266       insnContext = IC_XS;
 267     else
 268       insnContext = IC;
 269   }
 270
 271   return insnContext;
 272 }
 273
 274 RecognizableInstr::filter_ret RecognizableInstr::filter() const {
 275   // Filter out intrinsics
 276
 277   if (!Rec->isSubClassOf("X86Inst"))
 278     return FILTER_STRONG;
 279
 280   if (Form == X86Local::Pseudo ||
 281       IsCodeGenOnly)
 282     return FILTER_STRONG;
 283
 284   // Filter out instructions with a LOCK prefix;
 285   //   prefer forms that do not have the prefix
 286   if (HasLockPrefix)
 287     return FILTER_WEAK;
 288
 289   // Filter out artificial instructions
 290
 291   if (Name.find("TAILJMP") != Name.npos    ||
 292      Name.find("_Int") != Name.npos       ||
 293      Name.find("_int") != Name.npos       ||
 294      Name.find("Int_") != Name.npos       ||
 295      Name.find("_NOREX") != Name.npos     ||
 296      Name.find("EH_RETURN") != Name.npos  ||
 297      Name.find("V_SET") != Name.npos      ||
 298      Name.find("LOCK_") != Name.npos      ||
 299      Name.find("WIN") != Name.npos)
 300     return FILTER_STRONG;
 301
 302   // Special cases.
 303
 304   if (Name.find("PCMPISTRI") != Name.npos && Name != "PCMPISTRI")
 305     return FILTER_WEAK;
 306   if (Name.find("PCMPESTRI") != Name.npos && Name != "PCMPESTRI")
 307     return FILTER_WEAK;
 308
 309   if (Name.find("MOV") != Name.npos && Name.find("r0") != Name.npos)
 310     return FILTER_WEAK;
 311   if (Name.find("MOVZ") != Name.npos && Name.find("MOVZX") == Name.npos)
 312     return FILTER_WEAK;
 313   if (Name.find("Fs") != Name.npos)
 314     return FILTER_WEAK;
 315   if (Name == "MOVLPDrr"          ||
 316       Name == "MOVLPSrr"          ||
 317       Name == "PUSHFQ"            ||
 318       Name == "BSF16rr"           ||
 319       Name == "BSF16rm"           ||
 320       Name == "BSR16rr"           ||
 321       Name == "BSR16rm"           ||
 322       Name == "MOVSX16rm8"        ||
 323       Name == "MOVSX16rr8"        ||
 324       Name == "MOVZX16rm8"        ||
 325       Name == "MOVZX16rr8"        ||
 326       Name == "PUSH32i16"         ||
 327       Name == "PUSH64i16"         ||
 328       Name == "MOVPQI2QImr"       ||
 329       Name == "MOVSDmr"           ||
 330       Name == "MOVSDrm"           ||
 331       Name == "MOVSSmr"           ||
 332       Name == "MOVSSrm"           ||
 333       Name == "MMX_MOVD64rrv164"  ||
 334       Name == "CRC32m16"          ||
 335       Name == "MOV64ri64i32"      ||
 336       Name == "CRC32r16")
 337     return FILTER_WEAK;
 338
 339   // Filter out instructions with segment override prefixes.
 340   // They're too messy to handle now and we'll special case them if needed.
 341
 342   if (SegOvr)
 343     return FILTER_STRONG;
 344
 345   // Filter out instructions that can't be printed.
 346
 347   if (AsmString.size() == 0)
 348     return FILTER_STRONG;
 349
 350   // Filter out instructions with subreg operands.
 351
 352   if (AsmString.find("subreg") != AsmString.npos)
 353     return FILTER_STRONG;
 354
 355   assert(Form != X86Local::MRMInitReg &&
 356          "FORMAT_MRMINITREG instruction not skipped");
 357
 358   if (HasFROperands && Name.find("MOV") != Name.npos &&
 359      ((Name.find("2") != Name.npos && Name.find("32") == Name.npos) ||
 360       (Name.find("to") != Name.npos)))
 361     return FILTER_WEAK;
 362
 363   return FILTER_NORMAL;
 364 }
 365
 366 void RecognizableInstr::handleOperand(
 367   bool optional,
 368   unsigned &operandIndex,
 369   unsigned &physicalOperandIndex,
 370   unsigned &numPhysicalOperands,
 371   unsigned *operandMapping,
 372   OperandEncoding (*encodingFromString)(const std::string&, bool hasOpSizePrefix)) {
 373   if (optional) {
 374     if (physicalOperandIndex >= numPhysicalOperands)
 375       return;
 376   } else {
 377     assert(physicalOperandIndex < numPhysicalOperands);
 378   }
 379
 380   while (operandMapping[operandIndex] != operandIndex) {
 381     Spec->operands[operandIndex].encoding = ENCODING_DUP;
 382     Spec->operands[operandIndex].type =
 383       (OperandType)(TYPE_DUP0 + operandMapping[operandIndex]);
 384     ++operandIndex;
 385   }
 386
 387   const std::string &typeName = (*Operands)[operandIndex].Rec->getName();
 388
 389   Spec->operands[operandIndex].encoding = encodingFromString(typeName,
 390                                                               HasOpSizePrefix);
 391   Spec->operands[operandIndex].type = typeFromString(typeName,
 392                                                       IsSSE,
 393                                                       HasREX_WPrefix,
 394                                                       HasOpSizePrefix);
 395
 396   ++operandIndex;
 397   ++physicalOperandIndex;
 398 }
 399
 400 void RecognizableInstr::emitInstructionSpecifier(DisassemblerTables &tables) {
 401   Spec->name       = Name;
 402
 403   if (!Rec->isSubClassOf("X86Inst"))
 404     return;
 405
 406   switch (filter()) {
 407   case FILTER_WEAK:
 408     Spec->filtered = true;
 409     break;
 410   case FILTER_STRONG:
 411     ShouldBeEmitted = false;
 412     return;
 413   case FILTER_NORMAL:
 414     break;
 415   }
 416
 417   Spec->insnContext = insnContext();
 418
 419   const std::vector<CodeGenInstruction::OperandInfo> &OperandList = *Operands;
 420
 421   unsigned operandIndex;
 422   unsigned numOperands = OperandList.size();
 423   unsigned numPhysicalOperands = 0;
 424
 425   // operandMapping maps from operands in OperandList to their originals.
 426   // If operandMapping[i] != i, then the entry is a duplicate.
 427   unsigned operandMapping[X86_MAX_OPERANDS];
 428
 429   bool hasFROperands = false;
 430
 431   assert(numOperands < X86_MAX_OPERANDS && "X86_MAX_OPERANDS is not large enough");
 432
 433   for (operandIndex = 0; operandIndex < numOperands; ++operandIndex) {
 434     if (OperandList[operandIndex].Constraints.size()) {
 435       const CodeGenInstruction::ConstraintInfo &Constraint =
 436         OperandList[operandIndex].Constraints[0];
 437       if (Constraint.isTied()) {
 438         operandMapping[operandIndex] = Constraint.getTiedOperand();
 439       } else {
 440         ++numPhysicalOperands;
 441         operandMapping[operandIndex] = operandIndex;
 442       }
 443     } else {
 444       ++numPhysicalOperands;
 445       operandMapping[operandIndex] = operandIndex;
 446     }
 447
 448     const std::string &recName = OperandList[operandIndex].Rec->getName();
 449
 450     if (recName.find("FR") != recName.npos)
 451       hasFROperands = true;
 452   }
 453
 454   if (hasFROperands && Name.find("MOV") != Name.npos &&
 455      ((Name.find("2") != Name.npos && Name.find("32") == Name.npos) ||
 456       (Name.find("to") != Name.npos)))
 457     ShouldBeEmitted = false;
 458
 459   if (!ShouldBeEmitted)
 460     return;
 461
 462 #define HANDLE_OPERAND(class)               \
 463   handleOperand(false,                      \
 464                 operandIndex,               \
 465                 physicalOperandIndex,       \
 466                 numPhysicalOperands,        \
 467                 operandMapping,             \
 468                 class##EncodingFromString);
 469
 470 #define HANDLE_OPTIONAL(class)              \
 471   handleOperand(true,                       \
 472                 operandIndex,               \
 473                 physicalOperandIndex,       \
 474                 numPhysicalOperands,        \
 475                 operandMapping,             \
 476                 class##EncodingFromString);
 477
 478   // operandIndex should always be < numOperands
 479   operandIndex = 0;
 480   // physicalOperandIndex should always be < numPhysicalOperands
 481   unsigned physicalOperandIndex = 0;
 482
 483   switch (Form) {
 484   case X86Local::RawFrm:
 485     // Operand 1 (optional) is an address or immediate.
 486     // Operand 2 (optional) is an immediate.
 487     assert(numPhysicalOperands <= 2 &&
 488            "Unexpected number of operands for RawFrm");
 489     HANDLE_OPTIONAL(relocation)
 490     HANDLE_OPTIONAL(immediate)
 491     break;
 492   case X86Local::AddRegFrm:
 493     // Operand 1 is added to the opcode.
 494     // Operand 2 (optional) is an address.
 495     assert(numPhysicalOperands >= 1 && numPhysicalOperands <= 2 &&
 496            "Unexpected number of operands for AddRegFrm");
 497     HANDLE_OPERAND(opcodeModifier)
 498     HANDLE_OPTIONAL(relocation)
 499     break;
 500   case X86Local::MRMDestReg:
 501     // Operand 1 is a register operand in the R/M field.
 502     // Operand 2 is a register operand in the Reg/Opcode field.
 503     // Operand 3 (optional) is an immediate.
 504     assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
 505            "Unexpected number of operands for MRMDestRegFrm");
 506     HANDLE_OPERAND(rmRegister)
 507     HANDLE_OPERAND(roRegister)
 508     HANDLE_OPTIONAL(immediate)
 509     break;
 510   case X86Local::MRMDestMem:
 511     // Operand 1 is a memory operand (possibly SIB-extended)
 512     // Operand 2 is a register operand in the Reg/Opcode field.
 513     // Operand 3 (optional) is an immediate.
 514     assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
 515            "Unexpected number of operands for MRMDestMemFrm");
 516     HANDLE_OPERAND(memory)
 517     HANDLE_OPERAND(roRegister)
 518     HANDLE_OPTIONAL(immediate)
 519     break;
 520   case X86Local::MRMSrcReg:
 521     // Operand 1 is a register operand in the Reg/Opcode field.
 522     // Operand 2 is a register operand in the R/M field.
 523     // Operand 3 (optional) is an immediate.
 524     assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
 525            "Unexpected number of operands for MRMSrcRegFrm");
 526     HANDLE_OPERAND(roRegister)
 527     HANDLE_OPERAND(rmRegister)
 528     HANDLE_OPTIONAL(immediate)
 529     break;
 530   case X86Local::MRMSrcMem:
 531     // Operand 1 is a register operand in the Reg/Opcode field.
 532     // Operand 2 is a memory operand (possibly SIB-extended)
 533     // Operand 3 (optional) is an immediate.
 534     assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
 535            "Unexpected number of operands for MRMSrcMemFrm");
 536     HANDLE_OPERAND(roRegister)
 537     HANDLE_OPERAND(memory)
 538     HANDLE_OPTIONAL(immediate)
 539     break;
 540   case X86Local::MRM0r:
 541   case X86Local::MRM1r:
 542   case X86Local::MRM2r:
 543   case X86Local::MRM3r:
 544   case X86Local::MRM4r:
 545   case X86Local::MRM5r:
 546   case X86Local::MRM6r:
 547   case X86Local::MRM7r:
 548     // Operand 1 is a register operand in the R/M field.
 549     // Operand 2 (optional) is an immediate or relocation.
 550     assert(numPhysicalOperands <= 2 &&
 551            "Unexpected number of operands for MRMnRFrm");
 552     HANDLE_OPTIONAL(rmRegister)
 553     HANDLE_OPTIONAL(relocation)
 554     break;
 555   case X86Local::MRM0m:
 556   case X86Local::MRM1m:
 557   case X86Local::MRM2m:
 558   case X86Local::MRM3m:
 559   case X86Local::MRM4m:
 560   case X86Local::MRM5m:
 561   case X86Local::MRM6m:
 562   case X86Local::MRM7m:
 563     // Operand 1 is a memory operand (possibly SIB-extended)
 564     // Operand 2 (optional) is an immediate or relocation.
 565     assert(numPhysicalOperands >= 1 && numPhysicalOperands <= 2 &&
 566            "Unexpected number of operands for MRMnMFrm");
 567     HANDLE_OPERAND(memory)
 568     HANDLE_OPTIONAL(relocation)
 569     break;
 570   case X86Local::MRMInitReg:
 571     // Ignored.
 572     break;
 573   }
 574
 575   #undef HANDLE_OPERAND
 576   #undef HANDLE_OPTIONAL
 577 }
 578
 579 void RecognizableInstr::emitDecodePath(DisassemblerTables &tables) const {
 580   // Special cases where the LLVM tables are not complete
 581
 582 #define MAP(from, to)                     \
 583   case X86Local::MRM_##from:              \
 584     filter = new ExactFilter(0x##from);   \
 585     break;
 586
 587   OpcodeType    opcodeType  = (OpcodeType)-1;
 588
 589   ModRMFilter*  filter      = NULL;
 590   uint8_t       opcodeToSet = 0;
 591
 592   switch (Prefix) {
 593   // Extended two-byte opcodes can start with f2 0f, f3 0f, or 0f
 594   case X86Local::XD:
 595   case X86Local::XS:
 596   case X86Local::TB:
 597     opcodeType = TWOBYTE;
 598
 599     switch (Opcode) {
 600     default:
 601       if (needsModRMForDecode(Form))
 602         filter = new ModFilter(isRegFormat(Form));
 603       else
 604         filter = new DumbFilter();
 605       break;
 606 #define EXTENSION_TABLE(n) case 0x##n:
 607     TWO_BYTE_EXTENSION_TABLES
 608 #undef EXTENSION_TABLE
 609       switch (Form) {
 610       default:
 611         llvm_unreachable("Unhandled two-byte extended opcode");
 612       case X86Local::MRM0r:
 613       case X86Local::MRM1r:
 614       case X86Local::MRM2r:
 615       case X86Local::MRM3r:
 616       case X86Local::MRM4r:
 617       case X86Local::MRM5r:
 618       case X86Local::MRM6r:
 619       case X86Local::MRM7r:
 620         filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
 621         break;
 622       case X86Local::MRM0m:
 623       case X86Local::MRM1m:
 624       case X86Local::MRM2m:
 625       case X86Local::MRM3m:
 626       case X86Local::MRM4m:
 627       case X86Local::MRM5m:
 628       case X86Local::MRM6m:
 629       case X86Local::MRM7m:
 630         filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
 631         break;
 632       MRM_MAPPING
 633       } // switch (Form)
 634       break;
 635     } // switch (Opcode)
 636     opcodeToSet = Opcode;
 637     break;
 638   case X86Local::T8:
 639     opcodeType = THREEBYTE_38;
 640     if (needsModRMForDecode(Form))
 641       filter = new ModFilter(isRegFormat(Form));
 642     else
 643       filter = new DumbFilter();
 644     opcodeToSet = Opcode;
 645     break;
 646   case X86Local::P_TA:
 647     opcodeType = THREEBYTE_3A;
 648     if (needsModRMForDecode(Form))
 649       filter = new ModFilter(isRegFormat(Form));
 650     else
 651       filter = new DumbFilter();
 652     opcodeToSet = Opcode;
 653     break;
 654   case X86Local::D8:
 655   case X86Local::D9:
 656   case X86Local::DA:
 657   case X86Local::DB:
 658   case X86Local::DC:
 659   case X86Local::DD:
 660   case X86Local::DE:
 661   case X86Local::DF:
 662     assert(Opcode >= 0xc0 && "Unexpected opcode for an escape opcode");
 663     opcodeType = ONEBYTE;
 664     if (Form == X86Local::AddRegFrm) {
 665       Spec->modifierType = MODIFIER_MODRM;
 666       Spec->modifierBase = Opcode;
 667       filter = new AddRegEscapeFilter(Opcode);
 668     } else {
 669       filter = new EscapeFilter(true, Opcode);
 670     }
 671     opcodeToSet = 0xd8 + (Prefix - X86Local::D8);
 672     break;
 673   default:
 674     opcodeType = ONEBYTE;
 675     switch (Opcode) {
 676 #define EXTENSION_TABLE(n) case 0x##n:
 677     ONE_BYTE_EXTENSION_TABLES
 678 #undef EXTENSION_TABLE
 679       switch (Form) {
 680       default:
 681         llvm_unreachable("Fell through the cracks of a single-byte "
 682                          "extended opcode");
 683       case X86Local::MRM0r:
 684       case X86Local::MRM1r:
 685       case X86Local::MRM2r:
 686       case X86Local::MRM3r:
 687       case X86Local::MRM4r:
 688       case X86Local::MRM5r:
 689       case X86Local::MRM6r:
 690       case X86Local::MRM7r:
 691         filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
 692         break;
 693       case X86Local::MRM0m:
 694       case X86Local::MRM1m:
 695       case X86Local::MRM2m:
 696       case X86Local::MRM3m:
 697       case X86Local::MRM4m:
 698       case X86Local::MRM5m:
 699       case X86Local::MRM6m:
 700       case X86Local::MRM7m:
 701         filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
 702         break;
 703       MRM_MAPPING
 704       } // switch (Form)
 705       break;
 706     case 0xd8:
 707     case 0xd9:
 708     case 0xda:
 709     case 0xdb:
 710     case 0xdc:
 711     case 0xdd:
 712     case 0xde:
 713     case 0xdf:
 714       filter = new EscapeFilter(false, Form - X86Local::MRM0m);
 715       break;
 716     default:
 717       if (needsModRMForDecode(Form))
 718         filter = new ModFilter(isRegFormat(Form));
 719       else
 720         filter = new DumbFilter();
 721       break;
 722     } // switch (Opcode)
 723     opcodeToSet = Opcode;
 724   } // switch (Prefix)
 725
 726   assert(opcodeType != (OpcodeType)-1 &&
 727          "Opcode type not set");
 728   assert(filter && "Filter not set");
 729
 730   if (Form == X86Local::AddRegFrm) {
 731     if(Spec->modifierType != MODIFIER_MODRM) {
 732       assert(opcodeToSet < 0xf9 &&
 733              "Not enough room for all ADDREG_FRM operands");
 734
 735       uint8_t currentOpcode;
 736
 737       for (currentOpcode = opcodeToSet;
 738            currentOpcode < opcodeToSet + 8;
 739            ++currentOpcode)
 740         tables.setTableFields(opcodeType,
 741                               insnContext(),
 742                               currentOpcode,
 743                               *filter,
 744                               UID);
 745
 746       Spec->modifierType = MODIFIER_OPCODE;
 747       Spec->modifierBase = opcodeToSet;
 748     } else {
 749       // modifierBase was set where MODIFIER_MODRM was set
 750       tables.setTableFields(opcodeType,
 751                             insnContext(),
 752                             opcodeToSet,
 753                             *filter,
 754                             UID);
 755     }
 756   } else {
 757     tables.setTableFields(opcodeType,
 758                           insnContext(),
 759                           opcodeToSet,
 760                           *filter,
 761                           UID);
 762
 763     Spec->modifierType = MODIFIER_NONE;
 764     Spec->modifierBase = opcodeToSet;
 765   }
 766
 767   delete filter;
 768
 769 #undef MAP
 770 }
 771
 772 #define TYPE(str, type) if (s == str) return type;
 773 OperandType RecognizableInstr::typeFromString(const std::string &s,
 774                                               bool isSSE,
 775                                               bool hasREX_WPrefix,
 776                                               bool hasOpSizePrefix) {
 777   if (isSSE) {
 778     // For SSE instructions, we ignore the OpSize prefix and force operand
 779     // sizes.
 780     TYPE("GR16",              TYPE_R16)
 781     TYPE("GR32",              TYPE_R32)
 782     TYPE("GR64",              TYPE_R64)
 783   }
 784   if(hasREX_WPrefix) {
 785     // For instructions with a REX_W prefix, a declared 32-bit register encoding
 786     // is special.
 787     TYPE("GR32",              TYPE_R32)
 788   }
 789   if(!hasOpSizePrefix) {
 790     // For instructions without an OpSize prefix, a declared 16-bit register or
 791     // immediate encoding is special.
 792     TYPE("GR16",              TYPE_R16)
 793     TYPE("i16imm",            TYPE_IMM16)
 794   }
 795   TYPE("i16mem",              TYPE_Mv)
 796   TYPE("i16imm",              TYPE_IMMv)
 797   TYPE("i16i8imm",            TYPE_IMMv)
 798   TYPE("GR16",                TYPE_Rv)
 799   TYPE("i32mem",              TYPE_Mv)
 800   TYPE("i32imm",              TYPE_IMMv)
 801   TYPE("i32i8imm",            TYPE_IMM32)
 802   TYPE("GR32",                TYPE_Rv)
 803   TYPE("i64mem",              TYPE_Mv)
 804   TYPE("i64i32imm",           TYPE_IMM64)
 805   TYPE("i64i8imm",            TYPE_IMM64)
 806   TYPE("GR64",                TYPE_R64)
 807   TYPE("i8mem",               TYPE_M8)
 808   TYPE("i8imm",               TYPE_IMM8)
 809   TYPE("GR8",                 TYPE_R8)
 810   TYPE("VR128",               TYPE_XMM128)
 811   TYPE("f128mem",             TYPE_M128)
 812   TYPE("FR64",                TYPE_XMM64)
 813   TYPE("f64mem",              TYPE_M64FP)
 814   TYPE("FR32",                TYPE_XMM32)
 815   TYPE("f32mem",              TYPE_M32FP)
 816   TYPE("RST",                 TYPE_ST)
 817   TYPE("i128mem",             TYPE_M128)
 818   TYPE("i64i32imm_pcrel",     TYPE_REL64)
 819   TYPE("i32imm_pcrel",        TYPE_REL32)
 820   TYPE("SSECC",               TYPE_IMM8)
 821   TYPE("brtarget",            TYPE_RELv)
 822   TYPE("brtarget8",           TYPE_REL8)
 823   TYPE("f80mem",              TYPE_M80FP)
 824   TYPE("lea32mem",            TYPE_LEA)
 825   TYPE("lea64_32mem",         TYPE_LEA)
 826   TYPE("lea64mem",            TYPE_LEA)
 827   TYPE("VR64",                TYPE_MM64)
 828   TYPE("i64imm",              TYPE_IMMv)
 829   TYPE("opaque32mem",         TYPE_M1616)
 830   TYPE("opaque48mem",         TYPE_M1632)
 831   TYPE("opaque80mem",         TYPE_M1664)
 832   TYPE("opaque512mem",        TYPE_M512)
 833   TYPE("SEGMENT_REG",         TYPE_SEGMENTREG)
 834   TYPE("DEBUG_REG",           TYPE_DEBUGREG)
 835   TYPE("CONTROL_REG_32",      TYPE_CR32)
 836   TYPE("CONTROL_REG_64",      TYPE_CR64)
 837   TYPE("offset8",             TYPE_MOFFS8)
 838   TYPE("offset16",            TYPE_MOFFS16)
 839   TYPE("offset32",            TYPE_MOFFS32)
 840   TYPE("offset64",            TYPE_MOFFS64)
 841   errs() << "Unhandled type string " << s << "\n";
 842   llvm_unreachable("Unhandled type string");
 843 }
 844 #undef TYPE
 845
 846 #define ENCODING(str, encoding) if (s == str) return encoding;
 847 OperandEncoding RecognizableInstr::immediateEncodingFromString
 848   (const std::string &s,
 849    bool hasOpSizePrefix) {
 850   if(!hasOpSizePrefix) {
 851     // For instructions without an OpSize prefix, a declared 16-bit register or
 852     // immediate encoding is special.
 853     ENCODING("i16imm",        ENCODING_IW)
 854   }
 855   ENCODING("i32i8imm",        ENCODING_IB)
 856   ENCODING("SSECC",           ENCODING_IB)
 857   ENCODING("i16imm",          ENCODING_Iv)
 858   ENCODING("i16i8imm",        ENCODING_IB)
 859   ENCODING("i32imm",          ENCODING_Iv)
 860   ENCODING("i64i32imm",       ENCODING_ID)
 861   ENCODING("i64i8imm",        ENCODING_IB)
 862   ENCODING("i8imm",           ENCODING_IB)
 863   errs() << "Unhandled immediate encoding " << s << "\n";
 864   llvm_unreachable("Unhandled immediate encoding");
 865 }
 866
 867 OperandEncoding RecognizableInstr::rmRegisterEncodingFromString
 868   (const std::string &s,
 869    bool hasOpSizePrefix) {
 870   ENCODING("GR16",            ENCODING_RM)
 871   ENCODING("GR32",            ENCODING_RM)
 872   ENCODING("GR64",            ENCODING_RM)
 873   ENCODING("GR8",             ENCODING_RM)
 874   ENCODING("VR128",           ENCODING_RM)
 875   ENCODING("FR64",            ENCODING_RM)
 876   ENCODING("FR32",            ENCODING_RM)
 877   ENCODING("VR64",            ENCODING_RM)
 878   errs() << "Unhandled R/M register encoding " << s << "\n";
 879   llvm_unreachable("Unhandled R/M register encoding");
 880 }
 881
 882 OperandEncoding RecognizableInstr::roRegisterEncodingFromString
 883   (const std::string &s,
 884    bool hasOpSizePrefix) {
 885   ENCODING("GR16",            ENCODING_REG)
 886   ENCODING("GR32",            ENCODING_REG)
 887   ENCODING("GR64",            ENCODING_REG)
 888   ENCODING("GR8",             ENCODING_REG)
 889   ENCODING("VR128",           ENCODING_REG)
 890   ENCODING("FR64",            ENCODING_REG)
 891   ENCODING("FR32",            ENCODING_REG)
 892   ENCODING("VR64",            ENCODING_REG)
 893   ENCODING("SEGMENT_REG",     ENCODING_REG)
 894   ENCODING("DEBUG_REG",       ENCODING_REG)
 895   ENCODING("CONTROL_REG_32",  ENCODING_REG)
 896   ENCODING("CONTROL_REG_64",  ENCODING_REG)
 897   errs() << "Unhandled reg/opcode register encoding " << s << "\n";
 898   llvm_unreachable("Unhandled reg/opcode register encoding");
 899 }
 900
 901 OperandEncoding RecognizableInstr::memoryEncodingFromString
 902   (const std::string &s,
 903    bool hasOpSizePrefix) {
 904   ENCODING("i16mem",          ENCODING_RM)
 905   ENCODING("i32mem",          ENCODING_RM)
 906   ENCODING("i64mem",          ENCODING_RM)
 907   ENCODING("i8mem",           ENCODING_RM)
 908   ENCODING("f128mem",         ENCODING_RM)
 909   ENCODING("f64mem",          ENCODING_RM)
 910   ENCODING("f32mem",          ENCODING_RM)
 911   ENCODING("i128mem",         ENCODING_RM)
 912   ENCODING("f80mem",          ENCODING_RM)
 913   ENCODING("lea32mem",        ENCODING_RM)
 914   ENCODING("lea64_32mem",     ENCODING_RM)
 915   ENCODING("lea64mem",        ENCODING_RM)
 916   ENCODING("opaque32mem",     ENCODING_RM)
 917   ENCODING("opaque48mem",     ENCODING_RM)
 918   ENCODING("opaque80mem",     ENCODING_RM)
 919   ENCODING("opaque512mem",    ENCODING_RM)
 920   errs() << "Unhandled memory encoding " << s << "\n";
 921   llvm_unreachable("Unhandled memory encoding");
 922 }
 923
 924 OperandEncoding RecognizableInstr::relocationEncodingFromString
 925   (const std::string &s,
 926    bool hasOpSizePrefix) {
 927   if(!hasOpSizePrefix) {
 928     // For instructions without an OpSize prefix, a declared 16-bit register or
 929     // immediate encoding is special.
 930     ENCODING("i16imm",        ENCODING_IW)
 931   }
 932   ENCODING("i16imm",          ENCODING_Iv)
 933   ENCODING("i16i8imm",        ENCODING_IB)
 934   ENCODING("i32imm",          ENCODING_Iv)
 935   ENCODING("i32i8imm",        ENCODING_IB)
 936   ENCODING("i64i32imm",       ENCODING_ID)
 937   ENCODING("i64i8imm",        ENCODING_IB)
 938   ENCODING("i8imm",           ENCODING_IB)
 939   ENCODING("i64i32imm_pcrel", ENCODING_ID)
 940   ENCODING("i32imm_pcrel",    ENCODING_ID)
 941   ENCODING("brtarget",        ENCODING_Iv)
 942   ENCODING("brtarget8",       ENCODING_IB)
 943   ENCODING("i64imm",          ENCODING_IO)
 944   ENCODING("offset8",         ENCODING_Ia)
 945   ENCODING("offset16",        ENCODING_Ia)
 946   ENCODING("offset32",        ENCODING_Ia)
 947   ENCODING("offset64",        ENCODING_Ia)
 948   errs() << "Unhandled relocation encoding " << s << "\n";
 949   llvm_unreachable("Unhandled relocation encoding");
 950 }
 951
 952 OperandEncoding RecognizableInstr::opcodeModifierEncodingFromString
 953   (const std::string &s,
 954    bool hasOpSizePrefix) {
 955   ENCODING("RST",             ENCODING_I)
 956   ENCODING("GR32",            ENCODING_Rv)
 957   ENCODING("GR64",            ENCODING_RO)
 958   ENCODING("GR16",            ENCODING_Rv)
 959   ENCODING("GR8",             ENCODING_RB)
 960   errs() << "Unhandled opcode modifier encoding " << s << "\n";
 961   llvm_unreachable("Unhandled opcode modifier encoding");
 962 }
 963 #undef ENCODING