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 "X86RecognizableInstr.h"
  18 #include "X86DisassemblerShared.h"
  19 #include "X86ModRMFilters.h"
  20 #include "llvm/Support/ErrorHandling.h"
  21 #include <string>
  22
  23 using namespace llvm;
  24
  25 #define MRM_MAPPING     \
  26   MAP(C1, 33)           \
  27   MAP(C2, 34)           \
  28   MAP(C3, 35)           \
  29   MAP(C4, 36)           \
  30   MAP(C8, 37)           \
  31   MAP(C9, 38)           \
  32   MAP(CA, 39)           \
  33   MAP(CB, 40)           \
  34   MAP(E8, 41)           \
  35   MAP(F0, 42)           \
  36   MAP(F8, 45)           \
  37   MAP(F9, 46)           \
  38   MAP(D0, 47)           \
  39   MAP(D1, 48)           \
  40   MAP(D4, 49)           \
  41   MAP(D5, 50)           \
  42   MAP(D6, 51)           \
  43   MAP(D8, 52)           \
  44   MAP(D9, 53)           \
  45   MAP(DA, 54)           \
  46   MAP(DB, 55)           \
  47   MAP(DC, 56)           \
  48   MAP(DD, 57)           \
  49   MAP(DE, 58)           \
  50   MAP(DF, 59)
  51
  52 // A clone of X86 since we can't depend on something that is generated.
  53 namespace X86Local {
  54   enum {
  55     Pseudo      = 0,
  56     RawFrm      = 1,
  57     AddRegFrm   = 2,
  58     MRMDestReg  = 3,
  59     MRMDestMem  = 4,
  60     MRMSrcReg   = 5,
  61     MRMSrcMem   = 6,
  62     MRM0r = 16, MRM1r = 17, MRM2r = 18, MRM3r = 19,
  63     MRM4r = 20, MRM5r = 21, MRM6r = 22, MRM7r = 23,
  64     MRM0m = 24, MRM1m = 25, MRM2m = 26, MRM3m = 27,
  65     MRM4m = 28, MRM5m = 29, MRM6m = 30, MRM7m = 31,
  66     MRMInitReg  = 32,
  67     RawFrmImm8  = 43,
  68     RawFrmImm16 = 44,
  69 #define MAP(from, to) MRM_##from = to,
  70     MRM_MAPPING
  71 #undef MAP
  72     lastMRM
  73   };
  74
  75   enum {
  76     TB  = 1,
  77     REP = 2,
  78     D8 = 3, D9 = 4, DA = 5, DB = 6,
  79     DC = 7, DD = 8, DE = 9, DF = 10,
  80     XD = 11,  XS = 12,
  81     T8 = 13,  P_TA = 14,
  82     A6 = 15,  A7 = 16, T8XD = 17, T8XS = 18, TAXD = 19,
  83     XOP8 = 20, XOP9 = 21, XOPA = 22
  84   };
  85 }
  86
  87 // If rows are added to the opcode extension tables, then corresponding entries
  88 // must be added here.
  89 //
  90 // If the row corresponds to a single byte (i.e., 8f), then add an entry for
  91 // that byte to ONE_BYTE_EXTENSION_TABLES.
  92 //
  93 // If the row corresponds to two bytes where the first is 0f, add an entry for
  94 // the second byte to TWO_BYTE_EXTENSION_TABLES.
  95 //
  96 // If the row corresponds to some other set of bytes, you will need to modify
  97 // the code in RecognizableInstr::emitDecodePath() as well, and add new prefixes
  98 // to the X86 TD files, except in two cases: if the first two bytes of such a
  99 // new combination are 0f 38 or 0f 3a, you just have to add maps called
 100 // THREE_BYTE_38_EXTENSION_TABLES and THREE_BYTE_3A_EXTENSION_TABLES and add a
 101 // switch(Opcode) just below the case X86Local::T8: or case X86Local::TA: line
 102 // in RecognizableInstr::emitDecodePath().
 103
 104 #define ONE_BYTE_EXTENSION_TABLES \
 105   EXTENSION_TABLE(80)             \
 106   EXTENSION_TABLE(81)             \
 107   EXTENSION_TABLE(82)             \
 108   EXTENSION_TABLE(83)             \
 109   EXTENSION_TABLE(8f)             \
 110   EXTENSION_TABLE(c0)             \
 111   EXTENSION_TABLE(c1)             \
 112   EXTENSION_TABLE(c6)             \
 113   EXTENSION_TABLE(c7)             \
 114   EXTENSION_TABLE(d0)             \
 115   EXTENSION_TABLE(d1)             \
 116   EXTENSION_TABLE(d2)             \
 117   EXTENSION_TABLE(d3)             \
 118   EXTENSION_TABLE(f6)             \
 119   EXTENSION_TABLE(f7)             \
 120   EXTENSION_TABLE(fe)             \
 121   EXTENSION_TABLE(ff)
 122
 123 #define TWO_BYTE_EXTENSION_TABLES \
 124   EXTENSION_TABLE(00)             \
 125   EXTENSION_TABLE(01)             \
 126   EXTENSION_TABLE(0d)             \
 127   EXTENSION_TABLE(18)             \
 128   EXTENSION_TABLE(71)             \
 129   EXTENSION_TABLE(72)             \
 130   EXTENSION_TABLE(73)             \
 131   EXTENSION_TABLE(ae)             \
 132   EXTENSION_TABLE(ba)             \
 133   EXTENSION_TABLE(c7)
 134
 135 #define THREE_BYTE_38_EXTENSION_TABLES \
 136   EXTENSION_TABLE(F3)
 137
 138 #define XOP9_MAP_EXTENSION_TABLES \
 139   EXTENSION_TABLE(01)             \
 140   EXTENSION_TABLE(02)
 141
 142 using namespace X86Disassembler;
 143
 144 /// needsModRMForDecode - Indicates whether a particular instruction requires a
 145 ///   ModR/M byte for the instruction to be properly decoded.  For example, a
 146 ///   MRMDestReg instruction needs the Mod field in the ModR/M byte to be set to
 147 ///   0b11.
 148 ///
 149 /// @param form - The form of the instruction.
 150 /// @return     - true if the form implies that a ModR/M byte is required, false
 151 ///               otherwise.
 152 static bool needsModRMForDecode(uint8_t form) {
 153   if (form == X86Local::MRMDestReg    ||
 154      form == X86Local::MRMDestMem    ||
 155      form == X86Local::MRMSrcReg     ||
 156      form == X86Local::MRMSrcMem     ||
 157      (form >= X86Local::MRM0r && form <= X86Local::MRM7r) ||
 158      (form >= X86Local::MRM0m && form <= X86Local::MRM7m))
 159     return true;
 160   else
 161     return false;
 162 }
 163
 164 /// isRegFormat - Indicates whether a particular form requires the Mod field of
 165 ///   the ModR/M byte to be 0b11.
 166 ///
 167 /// @param form - The form of the instruction.
 168 /// @return     - true if the form implies that Mod must be 0b11, false
 169 ///               otherwise.
 170 static bool isRegFormat(uint8_t form) {
 171   if (form == X86Local::MRMDestReg ||
 172      form == X86Local::MRMSrcReg  ||
 173      (form >= X86Local::MRM0r && form <= X86Local::MRM7r))
 174     return true;
 175   else
 176     return false;
 177 }
 178
 179 /// byteFromBitsInit - Extracts a value at most 8 bits in width from a BitsInit.
 180 ///   Useful for switch statements and the like.
 181 ///
 182 /// @param init - A reference to the BitsInit to be decoded.
 183 /// @return     - The field, with the first bit in the BitsInit as the lowest
 184 ///               order bit.
 185 static uint8_t byteFromBitsInit(BitsInit &init) {
 186   int width = init.getNumBits();
 187
 188   assert(width <= 8 && "Field is too large for uint8_t!");
 189
 190   int     index;
 191   uint8_t mask = 0x01;
 192
 193   uint8_t ret = 0;
 194
 195   for (index = 0; index < width; index++) {
 196     if (static_cast<BitInit*>(init.getBit(index))->getValue())
 197       ret |= mask;
 198
 199     mask <<= 1;
 200   }
 201
 202   return ret;
 203 }
 204
 205 /// byteFromRec - Extract a value at most 8 bits in with from a Record given the
 206 ///   name of the field.
 207 ///
 208 /// @param rec  - The record from which to extract the value.
 209 /// @param name - The name of the field in the record.
 210 /// @return     - The field, as translated by byteFromBitsInit().
 211 static uint8_t byteFromRec(const Record* rec, const std::string &name) {
 212   BitsInit* bits = rec->getValueAsBitsInit(name);
 213   return byteFromBitsInit(*bits);
 214 }
 215
 216 RecognizableInstr::RecognizableInstr(DisassemblerTables &tables,
 217                                      const CodeGenInstruction &insn,
 218                                      InstrUID uid) {
 219   UID = uid;
 220
 221   Rec = insn.TheDef;
 222   Name = Rec->getName();
 223   Spec = &tables.specForUID(UID);
 224
 225   if (!Rec->isSubClassOf("X86Inst")) {
 226     ShouldBeEmitted = false;
 227     return;
 228   }
 229
 230   Prefix   = byteFromRec(Rec, "Prefix");
 231   Opcode   = byteFromRec(Rec, "Opcode");
 232   Form     = byteFromRec(Rec, "FormBits");
 233   SegOvr   = byteFromRec(Rec, "SegOvrBits");
 234
 235   HasOpSizePrefix  = Rec->getValueAsBit("hasOpSizePrefix");
 236   HasAdSizePrefix  = Rec->getValueAsBit("hasAdSizePrefix");
 237   HasREX_WPrefix   = Rec->getValueAsBit("hasREX_WPrefix");
 238   HasVEXPrefix     = Rec->getValueAsBit("hasVEXPrefix");
 239   HasVEX_4VPrefix  = Rec->getValueAsBit("hasVEX_4VPrefix");
 240   HasVEX_4VOp3Prefix = Rec->getValueAsBit("hasVEX_4VOp3Prefix");
 241   HasVEX_WPrefix   = Rec->getValueAsBit("hasVEX_WPrefix");
 242   HasMemOp4Prefix  = Rec->getValueAsBit("hasMemOp4Prefix");
 243   IgnoresVEX_L     = Rec->getValueAsBit("ignoresVEX_L");
 244   HasEVEXPrefix    = Rec->getValueAsBit("hasEVEXPrefix");
 245   HasEVEX_L2Prefix = Rec->getValueAsBit("hasEVEX_L2");
 246   HasEVEX_K        = Rec->getValueAsBit("hasEVEX_K");
 247   HasEVEX_B        = Rec->getValueAsBit("hasEVEX_B");
 248   HasLockPrefix    = Rec->getValueAsBit("hasLockPrefix");
 249   IsCodeGenOnly    = Rec->getValueAsBit("isCodeGenOnly");
 250
 251   Name      = Rec->getName();
 252   AsmString = Rec->getValueAsString("AsmString");
 253
 254   Operands = &insn.Operands.OperandList;
 255
 256   IsSSE            = (HasOpSizePrefix && (Name.find("16") == Name.npos)) ||
 257                      (Name.find("CRC32") != Name.npos);
 258   HasFROperands    = hasFROperands();
 259   HasVEX_LPrefix   = Rec->getValueAsBit("hasVEX_L");
 260
 261   // Check for 64-bit inst which does not require REX
 262   Is32Bit = false;
 263   Is64Bit = false;
 264   // FIXME: Is there some better way to check for In64BitMode?
 265   std::vector<Record*> Predicates = Rec->getValueAsListOfDefs("Predicates");
 266   for (unsigned i = 0, e = Predicates.size(); i != e; ++i) {
 267     if (Predicates[i]->getName().find("32Bit") != Name.npos) {
 268       Is32Bit = true;
 269       break;
 270     }
 271     if (Predicates[i]->getName().find("64Bit") != Name.npos) {
 272       Is64Bit = true;
 273       break;
 274     }
 275   }
 276   // FIXME: These instructions aren't marked as 64-bit in any way
 277   Is64Bit |= Rec->getName() == "JMP64pcrel32" ||
 278              Rec->getName() == "MASKMOVDQU64" ||
 279              Rec->getName() == "POPFS64" ||
 280              Rec->getName() == "POPGS64" ||
 281              Rec->getName() == "PUSHFS64" ||
 282              Rec->getName() == "PUSHGS64" ||
 283              Rec->getName() == "REX64_PREFIX" ||
 284              Rec->getName().find("MOV64") != Name.npos ||
 285              Rec->getName().find("PUSH64") != Name.npos ||
 286              Rec->getName().find("POP64") != Name.npos;
 287
 288   ShouldBeEmitted  = true;
 289 }
 290
 291 void RecognizableInstr::processInstr(DisassemblerTables &tables,
 292                                      const CodeGenInstruction &insn,
 293                                      InstrUID uid)
 294 {
 295   // Ignore "asm parser only" instructions.
 296   if (insn.TheDef->getValueAsBit("isAsmParserOnly"))
 297     return;
 298
 299   RecognizableInstr recogInstr(tables, insn, uid);
 300
 301   recogInstr.emitInstructionSpecifier(tables);
 302
 303   if (recogInstr.shouldBeEmitted())
 304     recogInstr.emitDecodePath(tables);
 305 }
 306
 307 #define EVEX_KB(n) (HasEVEX_K && HasEVEX_B? n##_K_B : \
 308                     (HasEVEX_K? n##_K : (HasEVEX_B ? n##_B : n)))
 309
 310 InstructionContext RecognizableInstr::insnContext() const {
 311   InstructionContext insnContext;
 312
 313   if (HasEVEXPrefix) {
 314     if (HasVEX_LPrefix && HasEVEX_L2Prefix) {
 315       errs() << "Don't support VEX.L if EVEX_L2 is enabled: " << Name << "\n";
 316       llvm_unreachable("Don't support VEX.L if EVEX_L2 is enabled");
 317     }
 318     // VEX_L & VEX_W
 319     if (HasVEX_LPrefix && HasVEX_WPrefix) {
 320       if (HasOpSizePrefix)
 321         insnContext = EVEX_KB(IC_EVEX_L_W_OPSIZE);
 322       else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 323         insnContext = EVEX_KB(IC_EVEX_L_W_XS);
 324       else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 325                Prefix == X86Local::TAXD)
 326         insnContext = EVEX_KB(IC_EVEX_L_W_XD);
 327       else
 328         insnContext = EVEX_KB(IC_EVEX_L_W);
 329     } else if (HasVEX_LPrefix) {
 330       // VEX_L
 331       if (HasOpSizePrefix)
 332         insnContext = EVEX_KB(IC_EVEX_L_OPSIZE);
 333       else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 334         insnContext = EVEX_KB(IC_EVEX_L_XS);
 335       else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 336                Prefix == X86Local::TAXD)
 337         insnContext = EVEX_KB(IC_EVEX_L_XD);
 338       else
 339         insnContext = EVEX_KB(IC_EVEX_L);
 340     }
 341     else if (HasEVEX_L2Prefix && HasVEX_WPrefix) {
 342       // EVEX_L2 & VEX_W
 343       if (HasOpSizePrefix)
 344         insnContext = EVEX_KB(IC_EVEX_L2_W_OPSIZE);
 345       else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 346         insnContext = EVEX_KB(IC_EVEX_L2_W_XS);
 347       else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 348                Prefix == X86Local::TAXD)
 349         insnContext = EVEX_KB(IC_EVEX_L2_W_XD);
 350       else
 351         insnContext = EVEX_KB(IC_EVEX_L2_W);
 352     } else if (HasEVEX_L2Prefix) {
 353       // EVEX_L2
 354       if (HasOpSizePrefix)
 355         insnContext = EVEX_KB(IC_EVEX_L2_OPSIZE);
 356       else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 357           Prefix == X86Local::TAXD)
 358         insnContext = EVEX_KB(IC_EVEX_L2_XD);
 359       else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 360         insnContext = EVEX_KB(IC_EVEX_L2_XS);
 361       else
 362         insnContext = EVEX_KB(IC_EVEX_L2);
 363     }
 364     else if (HasVEX_WPrefix) {
 365       // VEX_W
 366       if (HasOpSizePrefix)
 367         insnContext = EVEX_KB(IC_EVEX_W_OPSIZE);
 368       else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 369         insnContext = EVEX_KB(IC_EVEX_W_XS);
 370       else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 371                Prefix == X86Local::TAXD)
 372         insnContext = EVEX_KB(IC_EVEX_W_XD);
 373       else
 374         insnContext = EVEX_KB(IC_EVEX_W);
 375     }
 376     // No L, no W
 377     else if (HasOpSizePrefix)
 378       insnContext = EVEX_KB(IC_EVEX_OPSIZE);
 379     else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 380              Prefix == X86Local::TAXD)
 381       insnContext = EVEX_KB(IC_EVEX_XD);
 382     else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 383       insnContext = EVEX_KB(IC_EVEX_XS);
 384     else
 385       insnContext = EVEX_KB(IC_EVEX);
 386     /// eof EVEX
 387   } else if (HasVEX_4VPrefix || HasVEX_4VOp3Prefix|| HasVEXPrefix) {
 388     if (HasVEX_LPrefix && HasVEX_WPrefix) {
 389       if (HasOpSizePrefix)
 390         insnContext = IC_VEX_L_W_OPSIZE;
 391       else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 392         insnContext = IC_VEX_L_W_XS;
 393       else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 394                Prefix == X86Local::TAXD)
 395         insnContext = IC_VEX_L_W_XD;
 396       else
 397         insnContext = IC_VEX_L_W;
 398     } else if (HasOpSizePrefix && HasVEX_LPrefix)
 399       insnContext = IC_VEX_L_OPSIZE;
 400     else if (HasOpSizePrefix && HasVEX_WPrefix)
 401       insnContext = IC_VEX_W_OPSIZE;
 402     else if (HasOpSizePrefix)
 403       insnContext = IC_VEX_OPSIZE;
 404     else if (HasVEX_LPrefix &&
 405              (Prefix == X86Local::XS || Prefix == X86Local::T8XS))
 406       insnContext = IC_VEX_L_XS;
 407     else if (HasVEX_LPrefix && (Prefix == X86Local::XD ||
 408                                 Prefix == X86Local::T8XD ||
 409                                 Prefix == X86Local::TAXD))
 410       insnContext = IC_VEX_L_XD;
 411     else if (HasVEX_WPrefix &&
 412              (Prefix == X86Local::XS || Prefix == X86Local::T8XS))
 413       insnContext = IC_VEX_W_XS;
 414     else if (HasVEX_WPrefix && (Prefix == X86Local::XD ||
 415                                 Prefix == X86Local::T8XD ||
 416                                 Prefix == X86Local::TAXD))
 417       insnContext = IC_VEX_W_XD;
 418     else if (HasVEX_WPrefix)
 419       insnContext = IC_VEX_W;
 420     else if (HasVEX_LPrefix)
 421       insnContext = IC_VEX_L;
 422     else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 423              Prefix == X86Local::TAXD)
 424       insnContext = IC_VEX_XD;
 425     else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 426       insnContext = IC_VEX_XS;
 427     else
 428       insnContext = IC_VEX;
 429   } else if (Is64Bit || HasREX_WPrefix) {
 430     if (HasREX_WPrefix && HasOpSizePrefix)
 431       insnContext = IC_64BIT_REXW_OPSIZE;
 432     else if (HasOpSizePrefix && (Prefix == X86Local::XD ||
 433                                  Prefix == X86Local::T8XD ||
 434                                  Prefix == X86Local::TAXD))
 435       insnContext = IC_64BIT_XD_OPSIZE;
 436     else if (HasOpSizePrefix &&
 437              (Prefix == X86Local::XS || Prefix == X86Local::T8XS))
 438       insnContext = IC_64BIT_XS_OPSIZE;
 439     else if (HasOpSizePrefix)
 440       insnContext = IC_64BIT_OPSIZE;
 441     else if (HasAdSizePrefix)
 442       insnContext = IC_64BIT_ADSIZE;
 443     else if (HasREX_WPrefix &&
 444              (Prefix == X86Local::XS || Prefix == X86Local::T8XS))
 445       insnContext = IC_64BIT_REXW_XS;
 446     else if (HasREX_WPrefix && (Prefix == X86Local::XD ||
 447                                 Prefix == X86Local::T8XD ||
 448                                 Prefix == X86Local::TAXD))
 449       insnContext = IC_64BIT_REXW_XD;
 450     else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 451              Prefix == X86Local::TAXD)
 452       insnContext = IC_64BIT_XD;
 453     else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 454       insnContext = IC_64BIT_XS;
 455     else if (HasREX_WPrefix)
 456       insnContext = IC_64BIT_REXW;
 457     else
 458       insnContext = IC_64BIT;
 459   } else {
 460     if (HasOpSizePrefix && (Prefix == X86Local::XD ||
 461                             Prefix == X86Local::T8XD ||
 462                             Prefix == X86Local::TAXD))
 463       insnContext = IC_XD_OPSIZE;
 464     else if (HasOpSizePrefix &&
 465              (Prefix == X86Local::XS || Prefix == X86Local::T8XS))
 466       insnContext = IC_XS_OPSIZE;
 467     else if (HasOpSizePrefix)
 468       insnContext = IC_OPSIZE;
 469     else if (HasAdSizePrefix)
 470       insnContext = IC_ADSIZE;
 471     else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 472              Prefix == X86Local::TAXD)
 473       insnContext = IC_XD;
 474     else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS ||
 475              Prefix == X86Local::REP)
 476       insnContext = IC_XS;
 477     else
 478       insnContext = IC;
 479   }
 480
 481   return insnContext;
 482 }
 483
 484 RecognizableInstr::filter_ret RecognizableInstr::filter() const {
 485   ///////////////////
 486   // FILTER_STRONG
 487   //
 488
 489   // Filter out intrinsics
 490
 491   assert(Rec->isSubClassOf("X86Inst") && "Can only filter X86 instructions");
 492
 493   if (Form == X86Local::Pseudo ||
 494       (IsCodeGenOnly && Name.find("_REV") == Name.npos &&
 495        Name.find("INC32") == Name.npos && Name.find("DEC32") == Name.npos))
 496     return FILTER_STRONG;
 497
 498
 499   // Filter out artificial instructions but leave in the LOCK_PREFIX so it is
 500   // printed as a separate "instruction".
 501
 502   if (Name.find("_Int") != Name.npos       ||
 503       Name.find("Int_") != Name.npos)
 504     return FILTER_STRONG;
 505
 506   // Filter out instructions with segment override prefixes.
 507   // They're too messy to handle now and we'll special case them if needed.
 508
 509   if (SegOvr)
 510     return FILTER_STRONG;
 511
 512
 513   /////////////////
 514   // FILTER_WEAK
 515   //
 516
 517
 518   // Filter out instructions with a LOCK prefix;
 519   //   prefer forms that do not have the prefix
 520   if (HasLockPrefix)
 521     return FILTER_WEAK;
 522
 523   // Filter out alternate forms of AVX instructions
 524   if (Name.find("_alt") != Name.npos ||
 525       Name.find("XrYr") != Name.npos ||
 526       (Name.find("r64r") != Name.npos && Name.find("r64r64") == Name.npos) ||
 527       Name.find("_64mr") != Name.npos ||
 528       Name.find("Xrr") != Name.npos ||
 529       Name.find("rr64") != Name.npos)
 530     return FILTER_WEAK;
 531
 532   // Special cases.
 533
 534   if (Name.find("PCMPISTRI") != Name.npos && Name != "PCMPISTRI")
 535     return FILTER_WEAK;
 536   if (Name.find("PCMPESTRI") != Name.npos && Name != "PCMPESTRI")
 537     return FILTER_WEAK;
 538
 539   if (Name.find("MOV") != Name.npos && Name.find("r0") != Name.npos)
 540     return FILTER_WEAK;
 541   if (Name.find("MOVZ") != Name.npos && Name.find("MOVZX") == Name.npos &&
 542       Name != "MOVZPQILo2PQIrr")
 543     return FILTER_WEAK;
 544   if (Name.find("Fs") != Name.npos)
 545     return FILTER_WEAK;
 546   if (Name == "PUSH64i16"         ||
 547       Name == "MOVPQI2QImr"       ||
 548       Name == "VMOVPQI2QImr"      ||
 549       Name == "MOV64ri64i32"      ||
 550       Name == "VMASKMOVDQU64"     ||
 551       Name == "VEXTRACTPSrr64")
 552     return FILTER_WEAK;
 553
 554   // XACQUIRE and XRELEASE reuse REPNE and REP respectively.
 555   // For now, just prefer the REP versions.
 556   if (Name == "XACQUIRE_PREFIX" ||
 557       Name == "XRELEASE_PREFIX")
 558     return FILTER_WEAK;
 559
 560   if (HasFROperands && Name.find("MOV") != Name.npos &&
 561      ((Name.find("2") != Name.npos && Name.find("32") == Name.npos) ||
 562       (Name.find("to") != Name.npos)))
 563     return FILTER_STRONG;
 564
 565   return FILTER_NORMAL;
 566 }
 567
 568 bool RecognizableInstr::hasFROperands() const {
 569   const std::vector<CGIOperandList::OperandInfo> &OperandList = *Operands;
 570   unsigned numOperands = OperandList.size();
 571
 572   for (unsigned operandIndex = 0; operandIndex < numOperands; ++operandIndex) {
 573     const std::string &recName = OperandList[operandIndex].Rec->getName();
 574
 575     if (recName.find("FR") != recName.npos)
 576       return true;
 577   }
 578   return false;
 579 }
 580
 581 void RecognizableInstr::handleOperand(bool optional, unsigned &operandIndex,
 582                                       unsigned &physicalOperandIndex,
 583                                       unsigned &numPhysicalOperands,
 584                                       const unsigned *operandMapping,
 585                                       OperandEncoding (*encodingFromString)
 586                                         (const std::string&,
 587                                          bool hasOpSizePrefix)) {
 588   if (optional) {
 589     if (physicalOperandIndex >= numPhysicalOperands)
 590       return;
 591   } else {
 592     assert(physicalOperandIndex < numPhysicalOperands);
 593   }
 594
 595   while (operandMapping[operandIndex] != operandIndex) {
 596     Spec->operands[operandIndex].encoding = ENCODING_DUP;
 597     Spec->operands[operandIndex].type =
 598       (OperandType)(TYPE_DUP0 + operandMapping[operandIndex]);
 599     ++operandIndex;
 600   }
 601
 602   const std::string &typeName = (*Operands)[operandIndex].Rec->getName();
 603
 604   Spec->operands[operandIndex].encoding = encodingFromString(typeName,
 605                                                               HasOpSizePrefix);
 606   Spec->operands[operandIndex].type = typeFromString(typeName,
 607                                                      IsSSE,
 608                                                      HasREX_WPrefix,
 609                                                      HasOpSizePrefix);
 610
 611   ++operandIndex;
 612   ++physicalOperandIndex;
 613 }
 614
 615 void RecognizableInstr::emitInstructionSpecifier(DisassemblerTables &tables) {
 616   Spec->name       = Name;
 617
 618   if (!ShouldBeEmitted)
 619     return;
 620
 621   switch (filter()) {
 622   case FILTER_WEAK:
 623     Spec->filtered = true;
 624     break;
 625   case FILTER_STRONG:
 626     ShouldBeEmitted = false;
 627     return;
 628   case FILTER_NORMAL:
 629     break;
 630   }
 631
 632   Spec->insnContext = insnContext();
 633
 634   const std::vector<CGIOperandList::OperandInfo> &OperandList = *Operands;
 635
 636   unsigned numOperands = OperandList.size();
 637   unsigned numPhysicalOperands = 0;
 638
 639   // operandMapping maps from operands in OperandList to their originals.
 640   // If operandMapping[i] != i, then the entry is a duplicate.
 641   unsigned operandMapping[X86_MAX_OPERANDS];
 642   assert(numOperands <= X86_MAX_OPERANDS && "X86_MAX_OPERANDS is not large enough");
 643
 644   for (unsigned operandIndex = 0; operandIndex < numOperands; ++operandIndex) {
 645     if (OperandList[operandIndex].Constraints.size()) {
 646       const CGIOperandList::ConstraintInfo &Constraint =
 647         OperandList[operandIndex].Constraints[0];
 648       if (Constraint.isTied()) {
 649         operandMapping[operandIndex] = operandIndex;
 650         operandMapping[Constraint.getTiedOperand()] = operandIndex;
 651       } else {
 652         ++numPhysicalOperands;
 653         operandMapping[operandIndex] = operandIndex;
 654       }
 655     } else {
 656       ++numPhysicalOperands;
 657       operandMapping[operandIndex] = operandIndex;
 658     }
 659   }
 660
 661 #define HANDLE_OPERAND(class)               \
 662   handleOperand(false,                      \
 663                 operandIndex,               \
 664                 physicalOperandIndex,       \
 665                 numPhysicalOperands,        \
 666                 operandMapping,             \
 667                 class##EncodingFromString);
 668
 669 #define HANDLE_OPTIONAL(class)              \
 670   handleOperand(true,                       \
 671                 operandIndex,               \
 672                 physicalOperandIndex,       \
 673                 numPhysicalOperands,        \
 674                 operandMapping,             \
 675                 class##EncodingFromString);
 676
 677   // operandIndex should always be < numOperands
 678   unsigned operandIndex = 0;
 679   // physicalOperandIndex should always be < numPhysicalOperands
 680   unsigned physicalOperandIndex = 0;
 681
 682   switch (Form) {
 683   case X86Local::RawFrm:
 684     // Operand 1 (optional) is an address or immediate.
 685     // Operand 2 (optional) is an immediate.
 686     assert(numPhysicalOperands <= 2 &&
 687            "Unexpected number of operands for RawFrm");
 688     HANDLE_OPTIONAL(relocation)
 689     HANDLE_OPTIONAL(immediate)
 690     break;
 691   case X86Local::AddRegFrm:
 692     // Operand 1 is added to the opcode.
 693     // Operand 2 (optional) is an address.
 694     assert(numPhysicalOperands >= 1 && numPhysicalOperands <= 2 &&
 695            "Unexpected number of operands for AddRegFrm");
 696     HANDLE_OPERAND(opcodeModifier)
 697     HANDLE_OPTIONAL(relocation)
 698     break;
 699   case X86Local::MRMDestReg:
 700     // Operand 1 is a register operand in the R/M field.
 701     // Operand 2 is a register operand in the Reg/Opcode field.
 702     // - In AVX, there is a register operand in the VEX.vvvv field here -
 703     // Operand 3 (optional) is an immediate.
 704     if (HasVEX_4VPrefix)
 705       assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 4 &&
 706              "Unexpected number of operands for MRMDestRegFrm with VEX_4V");
 707     else
 708       assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
 709              "Unexpected number of operands for MRMDestRegFrm");
 710
 711     HANDLE_OPERAND(rmRegister)
 712
 713     if (HasVEX_4VPrefix)
 714       // FIXME: In AVX, the register below becomes the one encoded
 715       // in ModRMVEX and the one above the one in the VEX.VVVV field
 716       HANDLE_OPERAND(vvvvRegister)
 717
 718     HANDLE_OPERAND(roRegister)
 719     HANDLE_OPTIONAL(immediate)
 720     break;
 721   case X86Local::MRMDestMem:
 722     // Operand 1 is a memory operand (possibly SIB-extended)
 723     // Operand 2 is a register operand in the Reg/Opcode field.
 724     // - In AVX, there is a register operand in the VEX.vvvv field here -
 725     // Operand 3 (optional) is an immediate.
 726     if (HasVEX_4VPrefix)
 727       assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 4 &&
 728              "Unexpected number of operands for MRMDestMemFrm with VEX_4V");
 729     else
 730       assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
 731              "Unexpected number of operands for MRMDestMemFrm");
 732     HANDLE_OPERAND(memory)
 733
 734     if (HasEVEX_K)
 735       HANDLE_OPERAND(writemaskRegister)
 736
 737     if (HasVEX_4VPrefix)
 738       // FIXME: In AVX, the register below becomes the one encoded
 739       // in ModRMVEX and the one above the one in the VEX.VVVV field
 740       HANDLE_OPERAND(vvvvRegister)
 741
 742     HANDLE_OPERAND(roRegister)
 743     HANDLE_OPTIONAL(immediate)
 744     break;
 745   case X86Local::MRMSrcReg:
 746     // Operand 1 is a register operand in the Reg/Opcode field.
 747     // Operand 2 is a register operand in the R/M field.
 748     // - In AVX, there is a register operand in the VEX.vvvv field here -
 749     // Operand 3 (optional) is an immediate.
 750     // Operand 4 (optional) is an immediate.
 751
 752     if (HasVEX_4VPrefix || HasVEX_4VOp3Prefix)
 753       assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 5 &&
 754              "Unexpected number of operands for MRMSrcRegFrm with VEX_4V");
 755     else
 756       assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 4 &&
 757              "Unexpected number of operands for MRMSrcRegFrm");
 758
 759     HANDLE_OPERAND(roRegister)
 760
 761     if (HasEVEX_K)
 762       HANDLE_OPERAND(writemaskRegister)
 763
 764     if (HasVEX_4VPrefix)
 765       // FIXME: In AVX, the register below becomes the one encoded
 766       // in ModRMVEX and the one above the one in the VEX.VVVV field
 767       HANDLE_OPERAND(vvvvRegister)
 768
 769     if (HasMemOp4Prefix)
 770       HANDLE_OPERAND(immediate)
 771
 772     HANDLE_OPERAND(rmRegister)
 773
 774     if (HasVEX_4VOp3Prefix)
 775       HANDLE_OPERAND(vvvvRegister)
 776
 777     if (!HasMemOp4Prefix)
 778       HANDLE_OPTIONAL(immediate)
 779     HANDLE_OPTIONAL(immediate) // above might be a register in 7:4
 780     HANDLE_OPTIONAL(immediate)
 781     break;
 782   case X86Local::MRMSrcMem:
 783     // Operand 1 is a register operand in the Reg/Opcode field.
 784     // Operand 2 is a memory operand (possibly SIB-extended)
 785     // - In AVX, there is a register operand in the VEX.vvvv field here -
 786     // Operand 3 (optional) is an immediate.
 787
 788     if (HasVEX_4VPrefix || HasVEX_4VOp3Prefix)
 789       assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 5 &&
 790              "Unexpected number of operands for MRMSrcMemFrm with VEX_4V");
 791     else
 792       assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
 793              "Unexpected number of operands for MRMSrcMemFrm");
 794
 795     HANDLE_OPERAND(roRegister)
 796
 797     if (HasEVEX_K)
 798       HANDLE_OPERAND(writemaskRegister)
 799
 800     if (HasVEX_4VPrefix)
 801       // FIXME: In AVX, the register below becomes the one encoded
 802       // in ModRMVEX and the one above the one in the VEX.VVVV field
 803       HANDLE_OPERAND(vvvvRegister)
 804
 805     if (HasMemOp4Prefix)
 806       HANDLE_OPERAND(immediate)
 807
 808     HANDLE_OPERAND(memory)
 809
 810     if (HasVEX_4VOp3Prefix)
 811       HANDLE_OPERAND(vvvvRegister)
 812
 813     if (!HasMemOp4Prefix)
 814       HANDLE_OPTIONAL(immediate)
 815     HANDLE_OPTIONAL(immediate) // above might be a register in 7:4
 816     break;
 817   case X86Local::MRM0r:
 818   case X86Local::MRM1r:
 819   case X86Local::MRM2r:
 820   case X86Local::MRM3r:
 821   case X86Local::MRM4r:
 822   case X86Local::MRM5r:
 823   case X86Local::MRM6r:
 824   case X86Local::MRM7r:
 825     {
 826       // Operand 1 is a register operand in the R/M field.
 827       // Operand 2 (optional) is an immediate or relocation.
 828       // Operand 3 (optional) is an immediate.
 829       unsigned kOp = (HasEVEX_K) ? 1:0;
 830       unsigned Op4v = (HasVEX_4VPrefix) ? 1:0;
 831       if (numPhysicalOperands > 3 + kOp + Op4v)
 832         llvm_unreachable("Unexpected number of operands for MRMnr");
 833     }
 834     if (HasVEX_4VPrefix)
 835       HANDLE_OPERAND(vvvvRegister)
 836
 837     if (HasEVEX_K)
 838       HANDLE_OPERAND(writemaskRegister)
 839     HANDLE_OPTIONAL(rmRegister)
 840     HANDLE_OPTIONAL(relocation)
 841     HANDLE_OPTIONAL(immediate)
 842     break;
 843   case X86Local::MRM0m:
 844   case X86Local::MRM1m:
 845   case X86Local::MRM2m:
 846   case X86Local::MRM3m:
 847   case X86Local::MRM4m:
 848   case X86Local::MRM5m:
 849   case X86Local::MRM6m:
 850   case X86Local::MRM7m:
 851     {
 852       // Operand 1 is a memory operand (possibly SIB-extended)
 853       // Operand 2 (optional) is an immediate or relocation.
 854       unsigned kOp = (HasEVEX_K) ? 1:0;
 855       unsigned Op4v = (HasVEX_4VPrefix) ? 1:0;
 856       if (numPhysicalOperands < 1 + kOp + Op4v ||
 857           numPhysicalOperands > 2 + kOp + Op4v)
 858         llvm_unreachable("Unexpected number of operands for MRMnm");
 859     }
 860     if (HasVEX_4VPrefix)
 861       HANDLE_OPERAND(vvvvRegister)
 862     if (HasEVEX_K)
 863       HANDLE_OPERAND(writemaskRegister)
 864     HANDLE_OPERAND(memory)
 865     HANDLE_OPTIONAL(relocation)
 866     break;
 867   case X86Local::RawFrmImm8:
 868     // operand 1 is a 16-bit immediate
 869     // operand 2 is an 8-bit immediate
 870     assert(numPhysicalOperands == 2 &&
 871            "Unexpected number of operands for X86Local::RawFrmImm8");
 872     HANDLE_OPERAND(immediate)
 873     HANDLE_OPERAND(immediate)
 874     break;
 875   case X86Local::RawFrmImm16:
 876     // operand 1 is a 16-bit immediate
 877     // operand 2 is a 16-bit immediate
 878     HANDLE_OPERAND(immediate)
 879     HANDLE_OPERAND(immediate)
 880     break;
 881   case X86Local::MRM_F8:
 882     if (Opcode == 0xc6) {
 883       assert(numPhysicalOperands == 1 &&
 884              "Unexpected number of operands for X86Local::MRM_F8");
 885       HANDLE_OPERAND(immediate)
 886     } else if (Opcode == 0xc7) {
 887       assert(numPhysicalOperands == 1 &&
 888              "Unexpected number of operands for X86Local::MRM_F8");
 889       HANDLE_OPERAND(relocation)
 890     }
 891     break;
 892   case X86Local::MRMInitReg:
 893     // Ignored.
 894     break;
 895   }
 896
 897   #undef HANDLE_OPERAND
 898   #undef HANDLE_OPTIONAL
 899 }
 900
 901 void RecognizableInstr::emitDecodePath(DisassemblerTables &tables) const {
 902   // Special cases where the LLVM tables are not complete
 903
 904 #define MAP(from, to)                     \
 905   case X86Local::MRM_##from:              \
 906     filter = new ExactFilter(0x##from);   \
 907     break;
 908
 909   OpcodeType    opcodeType  = (OpcodeType)-1;
 910
 911   ModRMFilter*  filter      = NULL;
 912   uint8_t       opcodeToSet = 0;
 913
 914   switch (Prefix) {
 915   default: llvm_unreachable("Invalid prefix!");
 916   // Extended two-byte opcodes can start with f2 0f, f3 0f, or 0f
 917   case X86Local::XD:
 918   case X86Local::XS:
 919   case X86Local::TB:
 920     opcodeType = TWOBYTE;
 921
 922     switch (Opcode) {
 923     default:
 924       if (needsModRMForDecode(Form))
 925         filter = new ModFilter(isRegFormat(Form));
 926       else
 927         filter = new DumbFilter();
 928       break;
 929 #define EXTENSION_TABLE(n) case 0x##n:
 930     TWO_BYTE_EXTENSION_TABLES
 931 #undef EXTENSION_TABLE
 932       switch (Form) {
 933       default:
 934         llvm_unreachable("Unhandled two-byte extended opcode");
 935       case X86Local::MRM0r:
 936       case X86Local::MRM1r:
 937       case X86Local::MRM2r:
 938       case X86Local::MRM3r:
 939       case X86Local::MRM4r:
 940       case X86Local::MRM5r:
 941       case X86Local::MRM6r:
 942       case X86Local::MRM7r:
 943         filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
 944         break;
 945       case X86Local::MRM0m:
 946       case X86Local::MRM1m:
 947       case X86Local::MRM2m:
 948       case X86Local::MRM3m:
 949       case X86Local::MRM4m:
 950       case X86Local::MRM5m:
 951       case X86Local::MRM6m:
 952       case X86Local::MRM7m:
 953         filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
 954         break;
 955       MRM_MAPPING
 956       } // switch (Form)
 957       break;
 958     } // switch (Opcode)
 959     opcodeToSet = Opcode;
 960     break;
 961   case X86Local::T8:
 962   case X86Local::T8XD:
 963   case X86Local::T8XS:
 964     opcodeType = THREEBYTE_38;
 965     switch (Opcode) {
 966     default:
 967       if (needsModRMForDecode(Form))
 968         filter = new ModFilter(isRegFormat(Form));
 969       else
 970         filter = new DumbFilter();
 971       break;
 972 #define EXTENSION_TABLE(n) case 0x##n:
 973     THREE_BYTE_38_EXTENSION_TABLES
 974 #undef EXTENSION_TABLE
 975       switch (Form) {
 976       default:
 977         llvm_unreachable("Unhandled two-byte extended opcode");
 978       case X86Local::MRM0r:
 979       case X86Local::MRM1r:
 980       case X86Local::MRM2r:
 981       case X86Local::MRM3r:
 982       case X86Local::MRM4r:
 983       case X86Local::MRM5r:
 984       case X86Local::MRM6r:
 985       case X86Local::MRM7r:
 986         filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
 987         break;
 988       case X86Local::MRM0m:
 989       case X86Local::MRM1m:
 990       case X86Local::MRM2m:
 991       case X86Local::MRM3m:
 992       case X86Local::MRM4m:
 993       case X86Local::MRM5m:
 994       case X86Local::MRM6m:
 995       case X86Local::MRM7m:
 996         filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
 997         break;
 998       MRM_MAPPING
 999       } // switch (Form)
1000       break;
1001     } // switch (Opcode)
1002     opcodeToSet = Opcode;
1003     break;
1004   case X86Local::P_TA:
1005   case X86Local::TAXD:
1006     opcodeType = THREEBYTE_3A;
1007     if (needsModRMForDecode(Form))
1008       filter = new ModFilter(isRegFormat(Form));
1009     else
1010       filter = new DumbFilter();
1011     opcodeToSet = Opcode;
1012     break;
1013   case X86Local::A6:
1014     opcodeType = THREEBYTE_A6;
1015     if (needsModRMForDecode(Form))
1016       filter = new ModFilter(isRegFormat(Form));
1017     else
1018       filter = new DumbFilter();
1019     opcodeToSet = Opcode;
1020     break;
1021   case X86Local::A7:
1022     opcodeType = THREEBYTE_A7;
1023     if (needsModRMForDecode(Form))
1024       filter = new ModFilter(isRegFormat(Form));
1025     else
1026       filter = new DumbFilter();
1027     opcodeToSet = Opcode;
1028     break;
1029   case X86Local::XOP8:
1030     opcodeType = XOP8_MAP;
1031     if (needsModRMForDecode(Form))
1032       filter = new ModFilter(isRegFormat(Form));
1033     else
1034       filter = new DumbFilter();
1035     opcodeToSet = Opcode;
1036     break;
1037   case X86Local::XOP9:
1038     opcodeType = XOP9_MAP;
1039     switch (Opcode) {
1040     default:
1041       if (needsModRMForDecode(Form))
1042         filter = new ModFilter(isRegFormat(Form));
1043       else
1044         filter = new DumbFilter();
1045       break;
1046 #define EXTENSION_TABLE(n) case 0x##n:
1047     XOP9_MAP_EXTENSION_TABLES
1048 #undef EXTENSION_TABLE
1049       switch (Form) {
1050       default:
1051         llvm_unreachable("Unhandled XOP9 extended opcode");
1052       case X86Local::MRM0r:
1053       case X86Local::MRM1r:
1054       case X86Local::MRM2r:
1055       case X86Local::MRM3r:
1056       case X86Local::MRM4r:
1057       case X86Local::MRM5r:
1058       case X86Local::MRM6r:
1059       case X86Local::MRM7r:
1060         filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
1061         break;
1062       case X86Local::MRM0m:
1063       case X86Local::MRM1m:
1064       case X86Local::MRM2m:
1065       case X86Local::MRM3m:
1066       case X86Local::MRM4m:
1067       case X86Local::MRM5m:
1068       case X86Local::MRM6m:
1069       case X86Local::MRM7m:
1070         filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
1071         break;
1072       MRM_MAPPING
1073       } // switch (Form)
1074       break;
1075     } // switch (Opcode)
1076     opcodeToSet = Opcode;
1077     break;
1078   case X86Local::XOPA:
1079     opcodeType = XOPA_MAP;
1080     if (needsModRMForDecode(Form))
1081       filter = new ModFilter(isRegFormat(Form));
1082     else
1083       filter = new DumbFilter();
1084     opcodeToSet = Opcode;
1085     break;
1086   case X86Local::D8:
1087   case X86Local::D9:
1088   case X86Local::DA:
1089   case X86Local::DB:
1090   case X86Local::DC:
1091   case X86Local::DD:
1092   case X86Local::DE:
1093   case X86Local::DF:
1094     assert(Opcode >= 0xc0 && "Unexpected opcode for an escape opcode");
1095     opcodeType = ONEBYTE;
1096     if (Form == X86Local::AddRegFrm) {
1097       Spec->modifierType = MODIFIER_MODRM;
1098       Spec->modifierBase = Opcode;
1099       filter = new AddRegEscapeFilter(Opcode);
1100     } else {
1101       filter = new EscapeFilter(true, Opcode);
1102     }
1103     opcodeToSet = 0xd8 + (Prefix - X86Local::D8);
1104     break;
1105   case X86Local::REP:
1106   case 0:
1107     opcodeType = ONEBYTE;
1108     switch (Opcode) {
1109 #define EXTENSION_TABLE(n) case 0x##n:
1110     ONE_BYTE_EXTENSION_TABLES
1111 #undef EXTENSION_TABLE
1112       switch (Form) {
1113       default:
1114         llvm_unreachable("Fell through the cracks of a single-byte "
1115                          "extended opcode");
1116       case X86Local::MRM0r:
1117       case X86Local::MRM1r:
1118       case X86Local::MRM2r:
1119       case X86Local::MRM3r:
1120       case X86Local::MRM4r:
1121       case X86Local::MRM5r:
1122       case X86Local::MRM6r:
1123       case X86Local::MRM7r:
1124         filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
1125         break;
1126       case X86Local::MRM0m:
1127       case X86Local::MRM1m:
1128       case X86Local::MRM2m:
1129       case X86Local::MRM3m:
1130       case X86Local::MRM4m:
1131       case X86Local::MRM5m:
1132       case X86Local::MRM6m:
1133       case X86Local::MRM7m:
1134         filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
1135         break;
1136       MRM_MAPPING
1137       } // switch (Form)
1138       break;
1139     case 0xd8:
1140     case 0xd9:
1141     case 0xda:
1142     case 0xdb:
1143     case 0xdc:
1144     case 0xdd:
1145     case 0xde:
1146     case 0xdf:
1147       filter = new EscapeFilter(false, Form - X86Local::MRM0m);
1148       break;
1149     default:
1150       if (needsModRMForDecode(Form))
1151         filter = new ModFilter(isRegFormat(Form));
1152       else
1153         filter = new DumbFilter();
1154       break;
1155     } // switch (Opcode)
1156     opcodeToSet = Opcode;
1157   } // switch (Prefix)
1158
1159   assert(opcodeType != (OpcodeType)-1 &&
1160          "Opcode type not set");
1161   assert(filter && "Filter not set");
1162
1163   if (Form == X86Local::AddRegFrm) {
1164     if(Spec->modifierType != MODIFIER_MODRM) {
1165       assert(opcodeToSet < 0xf9 &&
1166              "Not enough room for all ADDREG_FRM operands");
1167
1168       uint8_t currentOpcode;
1169
1170       for (currentOpcode = opcodeToSet;
1171            currentOpcode < opcodeToSet + 8;
1172            ++currentOpcode)
1173         tables.setTableFields(opcodeType,
1174                               insnContext(),
1175                               currentOpcode,
1176                               *filter,
1177                               UID, Is32Bit, IgnoresVEX_L);
1178
1179       Spec->modifierType = MODIFIER_OPCODE;
1180       Spec->modifierBase = opcodeToSet;
1181     } else {
1182       // modifierBase was set where MODIFIER_MODRM was set
1183       tables.setTableFields(opcodeType,
1184                             insnContext(),
1185                             opcodeToSet,
1186                             *filter,
1187                             UID, Is32Bit, IgnoresVEX_L);
1188     }
1189   } else {
1190     tables.setTableFields(opcodeType,
1191                           insnContext(),
1192                           opcodeToSet,
1193                           *filter,
1194                           UID, Is32Bit, IgnoresVEX_L);
1195
1196     Spec->modifierType = MODIFIER_NONE;
1197     Spec->modifierBase = opcodeToSet;
1198   }
1199
1200   delete filter;
1201
1202 #undef MAP
1203 }
1204
1205 #define TYPE(str, type) if (s == str) return type;
1206 OperandType RecognizableInstr::typeFromString(const std::string &s,
1207                                               bool isSSE,
1208                                               bool hasREX_WPrefix,
1209                                               bool hasOpSizePrefix) {
1210   if (isSSE) {
1211     // For SSE instructions, we ignore the OpSize prefix and force operand
1212     // sizes.
1213     TYPE("GR16",              TYPE_R16)
1214     TYPE("GR32",              TYPE_R32)
1215     TYPE("GR64",              TYPE_R64)
1216   }
1217   if(hasREX_WPrefix) {
1218     // For instructions with a REX_W prefix, a declared 32-bit register encoding
1219     // is special.
1220     TYPE("GR32",              TYPE_R32)
1221   }
1222   if(!hasOpSizePrefix) {
1223     // For instructions without an OpSize prefix, a declared 16-bit register or
1224     // immediate encoding is special.
1225     TYPE("GR16",              TYPE_R16)
1226     TYPE("i16imm",            TYPE_IMM16)
1227   }
1228   TYPE("i16mem",              TYPE_Mv)
1229   TYPE("i16imm",              TYPE_IMMv)
1230   TYPE("i16i8imm",            TYPE_IMMv)
1231   TYPE("GR16",                TYPE_Rv)
1232   TYPE("i32mem",              TYPE_Mv)
1233   TYPE("i32imm",              TYPE_IMMv)
1234   TYPE("i32i8imm",            TYPE_IMM32)
1235   TYPE("u32u8imm",            TYPE_IMM32)
1236   TYPE("GR32",                TYPE_Rv)
1237   TYPE("i64mem",              TYPE_Mv)
1238   TYPE("i64i32imm",           TYPE_IMM64)
1239   TYPE("i64i8imm",            TYPE_IMM64)
1240   TYPE("GR64",                TYPE_R64)
1241   TYPE("i8mem",               TYPE_M8)
1242   TYPE("i8imm",               TYPE_IMM8)
1243   TYPE("GR8",                 TYPE_R8)
1244   TYPE("VR128",               TYPE_XMM128)
1245   TYPE("VR128X",              TYPE_XMM128)
1246   TYPE("f128mem",             TYPE_M128)
1247   TYPE("f256mem",             TYPE_M256)
1248   TYPE("f512mem",             TYPE_M512)
1249   TYPE("FR64",                TYPE_XMM64)
1250   TYPE("FR64X",               TYPE_XMM64)
1251   TYPE("f64mem",              TYPE_M64FP)
1252   TYPE("sdmem",               TYPE_M64FP)
1253   TYPE("FR32",                TYPE_XMM32)
1254   TYPE("FR32X",               TYPE_XMM32)
1255   TYPE("f32mem",              TYPE_M32FP)
1256   TYPE("ssmem",               TYPE_M32FP)
1257   TYPE("RST",                 TYPE_ST)
1258   TYPE("i128mem",             TYPE_M128)
1259   TYPE("i256mem",             TYPE_M256)
1260   TYPE("i512mem",             TYPE_M512)
1261   TYPE("i64i32imm_pcrel",     TYPE_REL64)
1262   TYPE("i16imm_pcrel",        TYPE_REL16)
1263   TYPE("i32imm_pcrel",        TYPE_REL32)
1264   TYPE("SSECC",               TYPE_IMM3)
1265   TYPE("AVXCC",               TYPE_IMM5)
1266   TYPE("brtarget",            TYPE_RELv)
1267   TYPE("uncondbrtarget",      TYPE_RELv)
1268   TYPE("brtarget8",           TYPE_REL8)
1269   TYPE("f80mem",              TYPE_M80FP)
1270   TYPE("lea32mem",            TYPE_LEA)
1271   TYPE("lea64_32mem",         TYPE_LEA)
1272   TYPE("lea64mem",            TYPE_LEA)
1273   TYPE("VR64",                TYPE_MM64)
1274   TYPE("i64imm",              TYPE_IMMv)
1275   TYPE("opaque32mem",         TYPE_M1616)
1276   TYPE("opaque48mem",         TYPE_M1632)
1277   TYPE("opaque80mem",         TYPE_M1664)
1278   TYPE("opaque512mem",        TYPE_M512)
1279   TYPE("SEGMENT_REG",         TYPE_SEGMENTREG)
1280   TYPE("DEBUG_REG",           TYPE_DEBUGREG)
1281   TYPE("CONTROL_REG",         TYPE_CONTROLREG)
1282   TYPE("offset8",             TYPE_MOFFS8)
1283   TYPE("offset16",            TYPE_MOFFS16)
1284   TYPE("offset32",            TYPE_MOFFS32)
1285   TYPE("offset64",            TYPE_MOFFS64)
1286   TYPE("VR256",               TYPE_XMM256)
1287   TYPE("VR256X",              TYPE_XMM256)
1288   TYPE("VR512",               TYPE_XMM512)
1289   TYPE("VK8",                 TYPE_VK8)
1290   TYPE("VK8WM",               TYPE_VK8)
1291   TYPE("VK16",                TYPE_VK16)
1292   TYPE("VK16WM",              TYPE_VK16)
1293   TYPE("GR16_NOAX",           TYPE_Rv)
1294   TYPE("GR32_NOAX",           TYPE_Rv)
1295   TYPE("GR64_NOAX",           TYPE_R64)
1296   TYPE("vx32mem",             TYPE_M32)
1297   TYPE("vy32mem",             TYPE_M32)
1298   TYPE("vz32mem",             TYPE_M32)
1299   TYPE("vx64mem",             TYPE_M64)
1300   TYPE("vy64mem",             TYPE_M64)
1301   TYPE("vy64xmem",            TYPE_M64)
1302   TYPE("vz64mem",             TYPE_M64)
1303   errs() << "Unhandled type string " << s << "\n";
1304   llvm_unreachable("Unhandled type string");
1305 }
1306 #undef TYPE
1307
1308 #define ENCODING(str, encoding) if (s == str) return encoding;
1309 OperandEncoding RecognizableInstr::immediateEncodingFromString
1310   (const std::string &s,
1311    bool hasOpSizePrefix) {
1312   if(!hasOpSizePrefix) {
1313     // For instructions without an OpSize prefix, a declared 16-bit register or
1314     // immediate encoding is special.
1315     ENCODING("i16imm",        ENCODING_IW)
1316   }
1317   ENCODING("i32i8imm",        ENCODING_IB)
1318   ENCODING("u32u8imm",        ENCODING_IB)
1319   ENCODING("SSECC",           ENCODING_IB)
1320   ENCODING("AVXCC",           ENCODING_IB)
1321   ENCODING("i16imm",          ENCODING_Iv)
1322   ENCODING("i16i8imm",        ENCODING_IB)
1323   ENCODING("i32imm",          ENCODING_Iv)
1324   ENCODING("i64i32imm",       ENCODING_ID)
1325   ENCODING("i64i8imm",        ENCODING_IB)
1326   ENCODING("i8imm",           ENCODING_IB)
1327   // This is not a typo.  Instructions like BLENDVPD put
1328   // register IDs in 8-bit immediates nowadays.
1329   ENCODING("FR32",            ENCODING_IB)
1330   ENCODING("FR64",            ENCODING_IB)
1331   ENCODING("VR128",           ENCODING_IB)
1332   ENCODING("VR256",           ENCODING_IB)
1333   ENCODING("FR32X",           ENCODING_IB)
1334   ENCODING("FR64X",           ENCODING_IB)
1335   ENCODING("VR128X",          ENCODING_IB)
1336   ENCODING("VR256X",          ENCODING_IB)
1337   ENCODING("VR512",           ENCODING_IB)
1338   errs() << "Unhandled immediate encoding " << s << "\n";
1339   llvm_unreachable("Unhandled immediate encoding");
1340 }
1341
1342 OperandEncoding RecognizableInstr::rmRegisterEncodingFromString
1343   (const std::string &s,
1344    bool hasOpSizePrefix) {
1345   ENCODING("GR16",            ENCODING_RM)
1346   ENCODING("GR32",            ENCODING_RM)
1347   ENCODING("GR64",            ENCODING_RM)
1348   ENCODING("GR8",             ENCODING_RM)
1349   ENCODING("VR128",           ENCODING_RM)
1350   ENCODING("VR128X",          ENCODING_RM)
1351   ENCODING("FR64",            ENCODING_RM)
1352   ENCODING("FR32",            ENCODING_RM)
1353   ENCODING("FR64X",           ENCODING_RM)
1354   ENCODING("FR32X",           ENCODING_RM)
1355   ENCODING("VR64",            ENCODING_RM)
1356   ENCODING("VR256",           ENCODING_RM)
1357   ENCODING("VR256X",          ENCODING_RM)
1358   ENCODING("VR512",           ENCODING_RM)
1359   ENCODING("VK8",             ENCODING_RM)
1360   ENCODING("VK16",            ENCODING_RM)
1361   errs() << "Unhandled R/M register encoding " << s << "\n";
1362   llvm_unreachable("Unhandled R/M register encoding");
1363 }
1364
1365 OperandEncoding RecognizableInstr::roRegisterEncodingFromString
1366   (const std::string &s,
1367    bool hasOpSizePrefix) {
1368   ENCODING("GR16",            ENCODING_REG)
1369   ENCODING("GR32",            ENCODING_REG)
1370   ENCODING("GR64",            ENCODING_REG)
1371   ENCODING("GR8",             ENCODING_REG)
1372   ENCODING("VR128",           ENCODING_REG)
1373   ENCODING("FR64",            ENCODING_REG)
1374   ENCODING("FR32",            ENCODING_REG)
1375   ENCODING("VR64",            ENCODING_REG)
1376   ENCODING("SEGMENT_REG",     ENCODING_REG)
1377   ENCODING("DEBUG_REG",       ENCODING_REG)
1378   ENCODING("CONTROL_REG",     ENCODING_REG)
1379   ENCODING("VR256",           ENCODING_REG)
1380   ENCODING("VR256X",          ENCODING_REG)
1381   ENCODING("VR128X",          ENCODING_REG)
1382   ENCODING("FR64X",           ENCODING_REG)
1383   ENCODING("FR32X",           ENCODING_REG)
1384   ENCODING("VR512",           ENCODING_REG)
1385   ENCODING("VK8",             ENCODING_REG)
1386   ENCODING("VK16",            ENCODING_REG)
1387   ENCODING("VK8WM",           ENCODING_REG)
1388   ENCODING("VK16WM",          ENCODING_REG)
1389   errs() << "Unhandled reg/opcode register encoding " << s << "\n";
1390   llvm_unreachable("Unhandled reg/opcode register encoding");
1391 }
1392
1393 OperandEncoding RecognizableInstr::vvvvRegisterEncodingFromString
1394   (const std::string &s,
1395    bool hasOpSizePrefix) {
1396   ENCODING("GR32",            ENCODING_VVVV)
1397   ENCODING("GR64",            ENCODING_VVVV)
1398   ENCODING("FR32",            ENCODING_VVVV)
1399   ENCODING("FR64",            ENCODING_VVVV)
1400   ENCODING("VR128",           ENCODING_VVVV)
1401   ENCODING("VR256",           ENCODING_VVVV)
1402   ENCODING("FR32X",           ENCODING_VVVV)
1403   ENCODING("FR64X",           ENCODING_VVVV)
1404   ENCODING("VR128X",          ENCODING_VVVV)
1405   ENCODING("VR256X",          ENCODING_VVVV)
1406   ENCODING("VR512",           ENCODING_VVVV)
1407   ENCODING("VK8",             ENCODING_VVVV)
1408   ENCODING("VK16",            ENCODING_VVVV)
1409   errs() << "Unhandled VEX.vvvv register encoding " << s << "\n";
1410   llvm_unreachable("Unhandled VEX.vvvv register encoding");
1411 }
1412
1413 OperandEncoding RecognizableInstr::writemaskRegisterEncodingFromString
1414   (const std::string &s,
1415    bool hasOpSizePrefix) {
1416   ENCODING("VK8WM",           ENCODING_WRITEMASK)
1417   ENCODING("VK16WM",          ENCODING_WRITEMASK)
1418   errs() << "Unhandled mask register encoding " << s << "\n";
1419   llvm_unreachable("Unhandled mask register encoding");
1420 }
1421
1422 OperandEncoding RecognizableInstr::memoryEncodingFromString
1423   (const std::string &s,
1424    bool hasOpSizePrefix) {
1425   ENCODING("i16mem",          ENCODING_RM)
1426   ENCODING("i32mem",          ENCODING_RM)
1427   ENCODING("i64mem",          ENCODING_RM)
1428   ENCODING("i8mem",           ENCODING_RM)
1429   ENCODING("ssmem",           ENCODING_RM)
1430   ENCODING("sdmem",           ENCODING_RM)
1431   ENCODING("f128mem",         ENCODING_RM)
1432   ENCODING("f256mem",         ENCODING_RM)
1433   ENCODING("f512mem",         ENCODING_RM)
1434   ENCODING("f64mem",          ENCODING_RM)
1435   ENCODING("f32mem",          ENCODING_RM)
1436   ENCODING("i128mem",         ENCODING_RM)
1437   ENCODING("i256mem",         ENCODING_RM)
1438   ENCODING("i512mem",         ENCODING_RM)
1439   ENCODING("f80mem",          ENCODING_RM)
1440   ENCODING("lea32mem",        ENCODING_RM)
1441   ENCODING("lea64_32mem",     ENCODING_RM)
1442   ENCODING("lea64mem",        ENCODING_RM)
1443   ENCODING("opaque32mem",     ENCODING_RM)
1444   ENCODING("opaque48mem",     ENCODING_RM)
1445   ENCODING("opaque80mem",     ENCODING_RM)
1446   ENCODING("opaque512mem",    ENCODING_RM)
1447   ENCODING("vx32mem",         ENCODING_RM)
1448   ENCODING("vy32mem",         ENCODING_RM)
1449   ENCODING("vz32mem",         ENCODING_RM)
1450   ENCODING("vx64mem",         ENCODING_RM)
1451   ENCODING("vy64mem",         ENCODING_RM)
1452   ENCODING("vy64xmem",        ENCODING_RM)
1453   ENCODING("vz64mem",         ENCODING_RM)
1454   errs() << "Unhandled memory encoding " << s << "\n";
1455   llvm_unreachable("Unhandled memory encoding");
1456 }
1457
1458 OperandEncoding RecognizableInstr::relocationEncodingFromString
1459   (const std::string &s,
1460    bool hasOpSizePrefix) {
1461   if(!hasOpSizePrefix) {
1462     // For instructions without an OpSize prefix, a declared 16-bit register or
1463     // immediate encoding is special.
1464     ENCODING("i16imm",        ENCODING_IW)
1465   }
1466   ENCODING("i16imm",          ENCODING_Iv)
1467   ENCODING("i16i8imm",        ENCODING_IB)
1468   ENCODING("i32imm",          ENCODING_Iv)
1469   ENCODING("i32i8imm",        ENCODING_IB)
1470   ENCODING("i64i32imm",       ENCODING_ID)
1471   ENCODING("i64i8imm",        ENCODING_IB)
1472   ENCODING("i8imm",           ENCODING_IB)
1473   ENCODING("i64i32imm_pcrel", ENCODING_ID)
1474   ENCODING("i16imm_pcrel",    ENCODING_IW)
1475   ENCODING("i32imm_pcrel",    ENCODING_ID)
1476   ENCODING("brtarget",        ENCODING_Iv)
1477   ENCODING("brtarget8",       ENCODING_IB)
1478   ENCODING("i64imm",          ENCODING_IO)
1479   ENCODING("offset8",         ENCODING_Ia)
1480   ENCODING("offset16",        ENCODING_Ia)
1481   ENCODING("offset32",        ENCODING_Ia)
1482   ENCODING("offset64",        ENCODING_Ia)
1483   errs() << "Unhandled relocation encoding " << s << "\n";
1484   llvm_unreachable("Unhandled relocation encoding");
1485 }
1486
1487 OperandEncoding RecognizableInstr::opcodeModifierEncodingFromString
1488   (const std::string &s,
1489    bool hasOpSizePrefix) {
1490   ENCODING("RST",             ENCODING_I)
1491   ENCODING("GR32",            ENCODING_Rv)
1492   ENCODING("GR64",            ENCODING_RO)
1493   ENCODING("GR16",            ENCODING_Rv)
1494   ENCODING("GR8",             ENCODING_RB)
1495   ENCODING("GR16_NOAX",       ENCODING_Rv)
1496   ENCODING("GR32_NOAX",       ENCODING_Rv)
1497   ENCODING("GR64_NOAX",       ENCODING_RO)
1498   errs() << "Unhandled opcode modifier encoding " << s << "\n";
1499   llvm_unreachable("Unhandled opcode modifier encoding");
1500 }
1501 #undef ENCODING