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