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_KZ       = Rec->getValueAsBit("hasEVEX_Z");
 248   HasEVEX_B        = Rec->getValueAsBit("hasEVEX_B");
 249   HasLockPrefix    = Rec->getValueAsBit("hasLockPrefix");
 250   IsCodeGenOnly    = Rec->getValueAsBit("isCodeGenOnly");
 251
 252   Name      = Rec->getName();
 253   AsmString = Rec->getValueAsString("AsmString");
 254
 255   Operands = &insn.Operands.OperandList;
 256
 257   IsSSE            = (HasOpSizePrefix && (Name.find("16") == Name.npos)) ||
 258                      (Name.find("CRC32") != Name.npos);
 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("Not64Bit") != Name.npos ||
 268         Predicates[i]->getName().find("In32Bit") != Name.npos) {
 269       Is32Bit = true;
 270       break;
 271     }
 272     if (Predicates[i]->getName().find("In64Bit") != Name.npos) {
 273       Is64Bit = true;
 274       break;
 275     }
 276   }
 277   // FIXME: These instructions aren't marked as 64-bit in any way
 278   Is64Bit |= Rec->getName() == "JMP64pcrel32" ||
 279              Rec->getName().find("MOV64") != Name.npos ||
 280              Rec->getName().find("PUSH64") != Name.npos ||
 281              Rec->getName().find("POP64") != Name.npos;
 282
 283   ShouldBeEmitted  = true;
 284 }
 285
 286 void RecognizableInstr::processInstr(DisassemblerTables &tables,
 287                                      const CodeGenInstruction &insn,
 288                                      InstrUID uid)
 289 {
 290   // Ignore "asm parser only" instructions.
 291   if (insn.TheDef->getValueAsBit("isAsmParserOnly"))
 292     return;
 293
 294   RecognizableInstr recogInstr(tables, insn, uid);
 295
 296   recogInstr.emitInstructionSpecifier();
 297
 298   if (recogInstr.shouldBeEmitted())
 299     recogInstr.emitDecodePath(tables);
 300 }
 301
 302 #define EVEX_KB(n) (HasEVEX_KZ && HasEVEX_B ? n##_KZ_B : \
 303                     (HasEVEX_K && HasEVEX_B ? n##_K_B : \
 304                     (HasEVEX_KZ ? n##_KZ : \
 305                     (HasEVEX_K? n##_K : (HasEVEX_B ? n##_B : n)))))
 306
 307 InstructionContext RecognizableInstr::insnContext() const {
 308   InstructionContext insnContext;
 309
 310   if (HasEVEXPrefix) {
 311     if (HasVEX_LPrefix && HasEVEX_L2Prefix) {
 312       errs() << "Don't support VEX.L if EVEX_L2 is enabled: " << Name << "\n";
 313       llvm_unreachable("Don't support VEX.L if EVEX_L2 is enabled");
 314     }
 315     // VEX_L & VEX_W
 316     if (HasVEX_LPrefix && HasVEX_WPrefix) {
 317       if (HasOpSizePrefix)
 318         insnContext = EVEX_KB(IC_EVEX_L_W_OPSIZE);
 319       else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 320         insnContext = EVEX_KB(IC_EVEX_L_W_XS);
 321       else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 322                Prefix == X86Local::TAXD)
 323         insnContext = EVEX_KB(IC_EVEX_L_W_XD);
 324       else
 325         insnContext = EVEX_KB(IC_EVEX_L_W);
 326     } else if (HasVEX_LPrefix) {
 327       // VEX_L
 328       if (HasOpSizePrefix)
 329         insnContext = EVEX_KB(IC_EVEX_L_OPSIZE);
 330       else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 331         insnContext = EVEX_KB(IC_EVEX_L_XS);
 332       else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 333                Prefix == X86Local::TAXD)
 334         insnContext = EVEX_KB(IC_EVEX_L_XD);
 335       else
 336         insnContext = EVEX_KB(IC_EVEX_L);
 337     }
 338     else if (HasEVEX_L2Prefix && HasVEX_WPrefix) {
 339       // EVEX_L2 & VEX_W
 340       if (HasOpSizePrefix)
 341         insnContext = EVEX_KB(IC_EVEX_L2_W_OPSIZE);
 342       else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 343         insnContext = EVEX_KB(IC_EVEX_L2_W_XS);
 344       else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 345                Prefix == X86Local::TAXD)
 346         insnContext = EVEX_KB(IC_EVEX_L2_W_XD);
 347       else
 348         insnContext = EVEX_KB(IC_EVEX_L2_W);
 349     } else if (HasEVEX_L2Prefix) {
 350       // EVEX_L2
 351       if (HasOpSizePrefix)
 352         insnContext = EVEX_KB(IC_EVEX_L2_OPSIZE);
 353       else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 354           Prefix == X86Local::TAXD)
 355         insnContext = EVEX_KB(IC_EVEX_L2_XD);
 356       else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 357         insnContext = EVEX_KB(IC_EVEX_L2_XS);
 358       else
 359         insnContext = EVEX_KB(IC_EVEX_L2);
 360     }
 361     else if (HasVEX_WPrefix) {
 362       // VEX_W
 363       if (HasOpSizePrefix)
 364         insnContext = EVEX_KB(IC_EVEX_W_OPSIZE);
 365       else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 366         insnContext = EVEX_KB(IC_EVEX_W_XS);
 367       else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 368                Prefix == X86Local::TAXD)
 369         insnContext = EVEX_KB(IC_EVEX_W_XD);
 370       else
 371         insnContext = EVEX_KB(IC_EVEX_W);
 372     }
 373     // No L, no W
 374     else if (HasOpSizePrefix)
 375       insnContext = EVEX_KB(IC_EVEX_OPSIZE);
 376     else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 377              Prefix == X86Local::TAXD)
 378       insnContext = EVEX_KB(IC_EVEX_XD);
 379     else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 380       insnContext = EVEX_KB(IC_EVEX_XS);
 381     else
 382       insnContext = EVEX_KB(IC_EVEX);
 383     /// eof EVEX
 384   } else if (HasVEX_4VPrefix || HasVEX_4VOp3Prefix|| HasVEXPrefix) {
 385     if (HasVEX_LPrefix && HasVEX_WPrefix) {
 386       if (HasOpSizePrefix)
 387         insnContext = IC_VEX_L_W_OPSIZE;
 388       else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 389         insnContext = IC_VEX_L_W_XS;
 390       else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 391                Prefix == X86Local::TAXD)
 392         insnContext = IC_VEX_L_W_XD;
 393       else
 394         insnContext = IC_VEX_L_W;
 395     } else if (HasOpSizePrefix && HasVEX_LPrefix)
 396       insnContext = IC_VEX_L_OPSIZE;
 397     else if (HasOpSizePrefix && HasVEX_WPrefix)
 398       insnContext = IC_VEX_W_OPSIZE;
 399     else if (HasOpSizePrefix)
 400       insnContext = IC_VEX_OPSIZE;
 401     else if (HasVEX_LPrefix &&
 402              (Prefix == X86Local::XS || Prefix == X86Local::T8XS))
 403       insnContext = IC_VEX_L_XS;
 404     else if (HasVEX_LPrefix && (Prefix == X86Local::XD ||
 405                                 Prefix == X86Local::T8XD ||
 406                                 Prefix == X86Local::TAXD))
 407       insnContext = IC_VEX_L_XD;
 408     else if (HasVEX_WPrefix &&
 409              (Prefix == X86Local::XS || Prefix == X86Local::T8XS))
 410       insnContext = IC_VEX_W_XS;
 411     else if (HasVEX_WPrefix && (Prefix == X86Local::XD ||
 412                                 Prefix == X86Local::T8XD ||
 413                                 Prefix == X86Local::TAXD))
 414       insnContext = IC_VEX_W_XD;
 415     else if (HasVEX_WPrefix)
 416       insnContext = IC_VEX_W;
 417     else if (HasVEX_LPrefix)
 418       insnContext = IC_VEX_L;
 419     else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 420              Prefix == X86Local::TAXD)
 421       insnContext = IC_VEX_XD;
 422     else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 423       insnContext = IC_VEX_XS;
 424     else
 425       insnContext = IC_VEX;
 426   } else if (Is64Bit || HasREX_WPrefix) {
 427     if (HasREX_WPrefix && HasOpSizePrefix)
 428       insnContext = IC_64BIT_REXW_OPSIZE;
 429     else if (HasOpSizePrefix && (Prefix == X86Local::XD ||
 430                                  Prefix == X86Local::T8XD ||
 431                                  Prefix == X86Local::TAXD))
 432       insnContext = IC_64BIT_XD_OPSIZE;
 433     else if (HasOpSizePrefix &&
 434              (Prefix == X86Local::XS || Prefix == X86Local::T8XS))
 435       insnContext = IC_64BIT_XS_OPSIZE;
 436     else if (HasOpSizePrefix)
 437       insnContext = IC_64BIT_OPSIZE;
 438     else if (HasAdSizePrefix)
 439       insnContext = IC_64BIT_ADSIZE;
 440     else if (HasREX_WPrefix &&
 441              (Prefix == X86Local::XS || Prefix == X86Local::T8XS))
 442       insnContext = IC_64BIT_REXW_XS;
 443     else if (HasREX_WPrefix && (Prefix == X86Local::XD ||
 444                                 Prefix == X86Local::T8XD ||
 445                                 Prefix == X86Local::TAXD))
 446       insnContext = IC_64BIT_REXW_XD;
 447     else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 448              Prefix == X86Local::TAXD)
 449       insnContext = IC_64BIT_XD;
 450     else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
 451       insnContext = IC_64BIT_XS;
 452     else if (HasREX_WPrefix)
 453       insnContext = IC_64BIT_REXW;
 454     else
 455       insnContext = IC_64BIT;
 456   } else {
 457     if (HasOpSizePrefix && (Prefix == X86Local::XD ||
 458                             Prefix == X86Local::T8XD ||
 459                             Prefix == X86Local::TAXD))
 460       insnContext = IC_XD_OPSIZE;
 461     else if (HasOpSizePrefix &&
 462              (Prefix == X86Local::XS || Prefix == X86Local::T8XS))
 463       insnContext = IC_XS_OPSIZE;
 464     else if (HasOpSizePrefix)
 465       insnContext = IC_OPSIZE;
 466     else if (HasAdSizePrefix)
 467       insnContext = IC_ADSIZE;
 468     else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
 469              Prefix == X86Local::TAXD)
 470       insnContext = IC_XD;
 471     else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS ||
 472              Prefix == X86Local::REP)
 473       insnContext = IC_XS;
 474     else
 475       insnContext = IC;
 476   }
 477
 478   return insnContext;
 479 }
 480
 481 RecognizableInstr::filter_ret RecognizableInstr::filter() const {
 482   ///////////////////
 483   // FILTER_STRONG
 484   //
 485
 486   // Filter out intrinsics
 487
 488   assert(Rec->isSubClassOf("X86Inst") && "Can only filter X86 instructions");
 489
 490   if (Form == X86Local::Pseudo ||
 491       (IsCodeGenOnly && Name.find("_REV") == Name.npos &&
 492        Name.find("INC32") == Name.npos && Name.find("DEC32") == Name.npos))
 493     return FILTER_STRONG;
 494
 495
 496   // Filter out artificial instructions but leave in the LOCK_PREFIX so it is
 497   // printed as a separate "instruction".
 498
 499   // Filter out instructions with segment override prefixes.
 500   // They're too messy to handle now and we'll special case them if needed.
 501
 502   if (SegOvr)
 503     return FILTER_STRONG;
 504
 505
 506   /////////////////
 507   // FILTER_WEAK
 508   //
 509
 510
 511   // Filter out instructions with a LOCK prefix;
 512   //   prefer forms that do not have the prefix
 513   if (HasLockPrefix)
 514     return FILTER_WEAK;
 515
 516   // Filter out alternate forms of AVX instructions
 517   if (Name.find("_alt") != Name.npos ||
 518       (Name.find("r64r") != Name.npos && Name.find("r64r64") == Name.npos && Name.find("r64r8") == Name.npos) ||
 519       Name.find("_64mr") != Name.npos ||
 520       Name.find("rr64") != Name.npos)
 521     return FILTER_WEAK;
 522
 523   // Special cases.
 524
 525   if (Name == "PUSH64i16"         ||
 526       Name == "MOVPQI2QImr"       ||
 527       Name == "VMOVPQI2QImr"      ||
 528       Name == "VMASKMOVDQU64")
 529     return FILTER_WEAK;
 530
 531   // XACQUIRE and XRELEASE reuse REPNE and REP respectively.
 532   // For now, just prefer the REP versions.
 533   if (Name == "XACQUIRE_PREFIX" ||
 534       Name == "XRELEASE_PREFIX")
 535     return FILTER_WEAK;
 536
 537   return FILTER_NORMAL;
 538 }
 539
 540 void RecognizableInstr::handleOperand(bool optional, unsigned &operandIndex,
 541                                       unsigned &physicalOperandIndex,
 542                                       unsigned &numPhysicalOperands,
 543                                       const unsigned *operandMapping,
 544                                       OperandEncoding (*encodingFromString)
 545                                         (const std::string&,
 546                                          bool hasOpSizePrefix)) {
 547   if (optional) {
 548     if (physicalOperandIndex >= numPhysicalOperands)
 549       return;
 550   } else {
 551     assert(physicalOperandIndex < numPhysicalOperands);
 552   }
 553
 554   while (operandMapping[operandIndex] != operandIndex) {
 555     Spec->operands[operandIndex].encoding = ENCODING_DUP;
 556     Spec->operands[operandIndex].type =
 557       (OperandType)(TYPE_DUP0 + operandMapping[operandIndex]);
 558     ++operandIndex;
 559   }
 560
 561   const std::string &typeName = (*Operands)[operandIndex].Rec->getName();
 562
 563   Spec->operands[operandIndex].encoding = encodingFromString(typeName,
 564                                                               HasOpSizePrefix);
 565   Spec->operands[operandIndex].type = typeFromString(typeName,
 566                                                      IsSSE,
 567                                                      HasREX_WPrefix,
 568                                                      HasOpSizePrefix);
 569
 570   ++operandIndex;
 571   ++physicalOperandIndex;
 572 }
 573
 574 void RecognizableInstr::emitInstructionSpecifier() {
 575   Spec->name       = Name;
 576
 577   if (!ShouldBeEmitted)
 578     return;
 579
 580   switch (filter()) {
 581   case FILTER_WEAK:
 582     Spec->filtered = true;
 583     break;
 584   case FILTER_STRONG:
 585     ShouldBeEmitted = false;
 586     return;
 587   case FILTER_NORMAL:
 588     break;
 589   }
 590
 591   Spec->insnContext = insnContext();
 592
 593   const std::vector<CGIOperandList::OperandInfo> &OperandList = *Operands;
 594
 595   unsigned numOperands = OperandList.size();
 596   unsigned numPhysicalOperands = 0;
 597
 598   // operandMapping maps from operands in OperandList to their originals.
 599   // If operandMapping[i] != i, then the entry is a duplicate.
 600   unsigned operandMapping[X86_MAX_OPERANDS];
 601   assert(numOperands <= X86_MAX_OPERANDS && "X86_MAX_OPERANDS is not large enough");
 602
 603   for (unsigned operandIndex = 0; operandIndex < numOperands; ++operandIndex) {
 604     if (OperandList[operandIndex].Constraints.size()) {
 605       const CGIOperandList::ConstraintInfo &Constraint =
 606         OperandList[operandIndex].Constraints[0];
 607       if (Constraint.isTied()) {
 608         operandMapping[operandIndex] = operandIndex;
 609         operandMapping[Constraint.getTiedOperand()] = operandIndex;
 610       } else {
 611         ++numPhysicalOperands;
 612         operandMapping[operandIndex] = operandIndex;
 613       }
 614     } else {
 615       ++numPhysicalOperands;
 616       operandMapping[operandIndex] = operandIndex;
 617     }
 618   }
 619
 620 #define HANDLE_OPERAND(class)               \
 621   handleOperand(false,                      \
 622                 operandIndex,               \
 623                 physicalOperandIndex,       \
 624                 numPhysicalOperands,        \
 625                 operandMapping,             \
 626                 class##EncodingFromString);
 627
 628 #define HANDLE_OPTIONAL(class)              \
 629   handleOperand(true,                       \
 630                 operandIndex,               \
 631                 physicalOperandIndex,       \
 632                 numPhysicalOperands,        \
 633                 operandMapping,             \
 634                 class##EncodingFromString);
 635
 636   // operandIndex should always be < numOperands
 637   unsigned operandIndex = 0;
 638   // physicalOperandIndex should always be < numPhysicalOperands
 639   unsigned physicalOperandIndex = 0;
 640
 641   switch (Form) {
 642   case X86Local::RawFrm:
 643     // Operand 1 (optional) is an address or immediate.
 644     // Operand 2 (optional) is an immediate.
 645     assert(numPhysicalOperands <= 2 &&
 646            "Unexpected number of operands for RawFrm");
 647     HANDLE_OPTIONAL(relocation)
 648     HANDLE_OPTIONAL(immediate)
 649     break;
 650   case X86Local::AddRegFrm:
 651     // Operand 1 is added to the opcode.
 652     // Operand 2 (optional) is an address.
 653     assert(numPhysicalOperands >= 1 && numPhysicalOperands <= 2 &&
 654            "Unexpected number of operands for AddRegFrm");
 655     HANDLE_OPERAND(opcodeModifier)
 656     HANDLE_OPTIONAL(relocation)
 657     break;
 658   case X86Local::MRMDestReg:
 659     // Operand 1 is a register operand in the R/M field.
 660     // Operand 2 is a register operand in the Reg/Opcode field.
 661     // - In AVX, there is a register operand in the VEX.vvvv field here -
 662     // Operand 3 (optional) is an immediate.
 663     if (HasVEX_4VPrefix)
 664       assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 4 &&
 665              "Unexpected number of operands for MRMDestRegFrm with VEX_4V");
 666     else
 667       assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
 668              "Unexpected number of operands for MRMDestRegFrm");
 669
 670     HANDLE_OPERAND(rmRegister)
 671
 672     if (HasVEX_4VPrefix)
 673       // FIXME: In AVX, the register below becomes the one encoded
 674       // in ModRMVEX and the one above the one in the VEX.VVVV field
 675       HANDLE_OPERAND(vvvvRegister)
 676
 677     HANDLE_OPERAND(roRegister)
 678     HANDLE_OPTIONAL(immediate)
 679     break;
 680   case X86Local::MRMDestMem:
 681     // Operand 1 is a memory operand (possibly SIB-extended)
 682     // Operand 2 is a register operand in the Reg/Opcode field.
 683     // - In AVX, there is a register operand in the VEX.vvvv field here -
 684     // Operand 3 (optional) is an immediate.
 685     if (HasVEX_4VPrefix)
 686       assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 4 &&
 687              "Unexpected number of operands for MRMDestMemFrm with VEX_4V");
 688     else
 689       assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
 690              "Unexpected number of operands for MRMDestMemFrm");
 691     HANDLE_OPERAND(memory)
 692
 693     if (HasEVEX_K)
 694       HANDLE_OPERAND(writemaskRegister)
 695
 696     if (HasVEX_4VPrefix)
 697       // FIXME: In AVX, the register below becomes the one encoded
 698       // in ModRMVEX and the one above the one in the VEX.VVVV field
 699       HANDLE_OPERAND(vvvvRegister)
 700
 701     HANDLE_OPERAND(roRegister)
 702     HANDLE_OPTIONAL(immediate)
 703     break;
 704   case X86Local::MRMSrcReg:
 705     // Operand 1 is a register operand in the Reg/Opcode field.
 706     // Operand 2 is a register operand in the R/M field.
 707     // - In AVX, there is a register operand in the VEX.vvvv field here -
 708     // Operand 3 (optional) is an immediate.
 709     // Operand 4 (optional) is an immediate.
 710
 711     if (HasVEX_4VPrefix || HasVEX_4VOp3Prefix)
 712       assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 5 &&
 713              "Unexpected number of operands for MRMSrcRegFrm with VEX_4V");
 714     else
 715       assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 4 &&
 716              "Unexpected number of operands for MRMSrcRegFrm");
 717
 718     HANDLE_OPERAND(roRegister)
 719
 720     if (HasEVEX_K)
 721       HANDLE_OPERAND(writemaskRegister)
 722
 723     if (HasVEX_4VPrefix)
 724       // FIXME: In AVX, the register below becomes the one encoded
 725       // in ModRMVEX and the one above the one in the VEX.VVVV field
 726       HANDLE_OPERAND(vvvvRegister)
 727
 728     if (HasMemOp4Prefix)
 729       HANDLE_OPERAND(immediate)
 730
 731     HANDLE_OPERAND(rmRegister)
 732
 733     if (HasVEX_4VOp3Prefix)
 734       HANDLE_OPERAND(vvvvRegister)
 735
 736     if (!HasMemOp4Prefix)
 737       HANDLE_OPTIONAL(immediate)
 738     HANDLE_OPTIONAL(immediate) // above might be a register in 7:4
 739     HANDLE_OPTIONAL(immediate)
 740     break;
 741   case X86Local::MRMSrcMem:
 742     // Operand 1 is a register operand in the Reg/Opcode field.
 743     // Operand 2 is a memory operand (possibly SIB-extended)
 744     // - In AVX, there is a register operand in the VEX.vvvv field here -
 745     // Operand 3 (optional) is an immediate.
 746
 747     if (HasVEX_4VPrefix || HasVEX_4VOp3Prefix)
 748       assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 5 &&
 749              "Unexpected number of operands for MRMSrcMemFrm with VEX_4V");
 750     else
 751       assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
 752              "Unexpected number of operands for MRMSrcMemFrm");
 753
 754     HANDLE_OPERAND(roRegister)
 755
 756     if (HasEVEX_K)
 757       HANDLE_OPERAND(writemaskRegister)
 758
 759     if (HasVEX_4VPrefix)
 760       // FIXME: In AVX, the register below becomes the one encoded
 761       // in ModRMVEX and the one above the one in the VEX.VVVV field
 762       HANDLE_OPERAND(vvvvRegister)
 763
 764     if (HasMemOp4Prefix)
 765       HANDLE_OPERAND(immediate)
 766
 767     HANDLE_OPERAND(memory)
 768
 769     if (HasVEX_4VOp3Prefix)
 770       HANDLE_OPERAND(vvvvRegister)
 771
 772     if (!HasMemOp4Prefix)
 773       HANDLE_OPTIONAL(immediate)
 774     HANDLE_OPTIONAL(immediate) // above might be a register in 7:4
 775     break;
 776   case X86Local::MRM0r:
 777   case X86Local::MRM1r:
 778   case X86Local::MRM2r:
 779   case X86Local::MRM3r:
 780   case X86Local::MRM4r:
 781   case X86Local::MRM5r:
 782   case X86Local::MRM6r:
 783   case X86Local::MRM7r:
 784     {
 785       // Operand 1 is a register operand in the R/M field.
 786       // Operand 2 (optional) is an immediate or relocation.
 787       // Operand 3 (optional) is an immediate.
 788       unsigned kOp = (HasEVEX_K) ? 1:0;
 789       unsigned Op4v = (HasVEX_4VPrefix) ? 1:0;
 790       if (numPhysicalOperands > 3 + kOp + Op4v)
 791         llvm_unreachable("Unexpected number of operands for MRMnr");
 792     }
 793     if (HasVEX_4VPrefix)
 794       HANDLE_OPERAND(vvvvRegister)
 795
 796     if (HasEVEX_K)
 797       HANDLE_OPERAND(writemaskRegister)
 798     HANDLE_OPTIONAL(rmRegister)
 799     HANDLE_OPTIONAL(relocation)
 800     HANDLE_OPTIONAL(immediate)
 801     break;
 802   case X86Local::MRM0m:
 803   case X86Local::MRM1m:
 804   case X86Local::MRM2m:
 805   case X86Local::MRM3m:
 806   case X86Local::MRM4m:
 807   case X86Local::MRM5m:
 808   case X86Local::MRM6m:
 809   case X86Local::MRM7m:
 810     {
 811       // Operand 1 is a memory operand (possibly SIB-extended)
 812       // Operand 2 (optional) is an immediate or relocation.
 813       unsigned kOp = (HasEVEX_K) ? 1:0;
 814       unsigned Op4v = (HasVEX_4VPrefix) ? 1:0;
 815       if (numPhysicalOperands < 1 + kOp + Op4v ||
 816           numPhysicalOperands > 2 + kOp + Op4v)
 817         llvm_unreachable("Unexpected number of operands for MRMnm");
 818     }
 819     if (HasVEX_4VPrefix)
 820       HANDLE_OPERAND(vvvvRegister)
 821     if (HasEVEX_K)
 822       HANDLE_OPERAND(writemaskRegister)
 823     HANDLE_OPERAND(memory)
 824     HANDLE_OPTIONAL(relocation)
 825     break;
 826   case X86Local::RawFrmImm8:
 827     // operand 1 is a 16-bit immediate
 828     // operand 2 is an 8-bit immediate
 829     assert(numPhysicalOperands == 2 &&
 830            "Unexpected number of operands for X86Local::RawFrmImm8");
 831     HANDLE_OPERAND(immediate)
 832     HANDLE_OPERAND(immediate)
 833     break;
 834   case X86Local::RawFrmImm16:
 835     // operand 1 is a 16-bit immediate
 836     // operand 2 is a 16-bit immediate
 837     HANDLE_OPERAND(immediate)
 838     HANDLE_OPERAND(immediate)
 839     break;
 840   case X86Local::MRM_F8:
 841     if (Opcode == 0xc6) {
 842       assert(numPhysicalOperands == 1 &&
 843              "Unexpected number of operands for X86Local::MRM_F8");
 844       HANDLE_OPERAND(immediate)
 845     } else if (Opcode == 0xc7) {
 846       assert(numPhysicalOperands == 1 &&
 847              "Unexpected number of operands for X86Local::MRM_F8");
 848       HANDLE_OPERAND(relocation)
 849     }
 850     break;
 851   case X86Local::MRMInitReg:
 852     // Ignored.
 853     break;
 854   }
 855
 856   #undef HANDLE_OPERAND
 857   #undef HANDLE_OPTIONAL
 858 }
 859
 860 void RecognizableInstr::emitDecodePath(DisassemblerTables &tables) const {
 861   // Special cases where the LLVM tables are not complete
 862
 863 #define MAP(from, to)                     \
 864   case X86Local::MRM_##from:              \
 865     filter = new ExactFilter(0x##from);   \
 866     break;
 867
 868   OpcodeType    opcodeType  = (OpcodeType)-1;
 869
 870   ModRMFilter*  filter      = NULL;
 871   uint8_t       opcodeToSet = 0;
 872
 873   switch (Prefix) {
 874   default: llvm_unreachable("Invalid prefix!");
 875   // Extended two-byte opcodes can start with f2 0f, f3 0f, or 0f
 876   case X86Local::XD:
 877   case X86Local::XS:
 878   case X86Local::TB:
 879     opcodeType = TWOBYTE;
 880
 881     switch (Opcode) {
 882     default:
 883       if (needsModRMForDecode(Form))
 884         filter = new ModFilter(isRegFormat(Form));
 885       else
 886         filter = new DumbFilter();
 887       break;
 888 #define EXTENSION_TABLE(n) case 0x##n:
 889     TWO_BYTE_EXTENSION_TABLES
 890 #undef EXTENSION_TABLE
 891       switch (Form) {
 892       default:
 893         llvm_unreachable("Unhandled two-byte extended opcode");
 894       case X86Local::MRM0r:
 895       case X86Local::MRM1r:
 896       case X86Local::MRM2r:
 897       case X86Local::MRM3r:
 898       case X86Local::MRM4r:
 899       case X86Local::MRM5r:
 900       case X86Local::MRM6r:
 901       case X86Local::MRM7r:
 902         filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
 903         break;
 904       case X86Local::MRM0m:
 905       case X86Local::MRM1m:
 906       case X86Local::MRM2m:
 907       case X86Local::MRM3m:
 908       case X86Local::MRM4m:
 909       case X86Local::MRM5m:
 910       case X86Local::MRM6m:
 911       case X86Local::MRM7m:
 912         filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
 913         break;
 914       MRM_MAPPING
 915       } // switch (Form)
 916       break;
 917     } // switch (Opcode)
 918     opcodeToSet = Opcode;
 919     break;
 920   case X86Local::T8:
 921   case X86Local::T8XD:
 922   case X86Local::T8XS:
 923     opcodeType = THREEBYTE_38;
 924     switch (Opcode) {
 925     default:
 926       if (needsModRMForDecode(Form))
 927         filter = new ModFilter(isRegFormat(Form));
 928       else
 929         filter = new DumbFilter();
 930       break;
 931 #define EXTENSION_TABLE(n) case 0x##n:
 932     THREE_BYTE_38_EXTENSION_TABLES
 933 #undef EXTENSION_TABLE
 934       switch (Form) {
 935       default:
 936         llvm_unreachable("Unhandled two-byte extended opcode");
 937       case X86Local::MRM0r:
 938       case X86Local::MRM1r:
 939       case X86Local::MRM2r:
 940       case X86Local::MRM3r:
 941       case X86Local::MRM4r:
 942       case X86Local::MRM5r:
 943       case X86Local::MRM6r:
 944       case X86Local::MRM7r:
 945         filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
 946         break;
 947       case X86Local::MRM0m:
 948       case X86Local::MRM1m:
 949       case X86Local::MRM2m:
 950       case X86Local::MRM3m:
 951       case X86Local::MRM4m:
 952       case X86Local::MRM5m:
 953       case X86Local::MRM6m:
 954       case X86Local::MRM7m:
 955         filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
 956         break;
 957       MRM_MAPPING
 958       } // switch (Form)
 959       break;
 960     } // switch (Opcode)
 961     opcodeToSet = Opcode;
 962     break;
 963   case X86Local::P_TA:
 964   case X86Local::TAXD:
 965     opcodeType = THREEBYTE_3A;
 966     if (needsModRMForDecode(Form))
 967       filter = new ModFilter(isRegFormat(Form));
 968     else
 969       filter = new DumbFilter();
 970     opcodeToSet = Opcode;
 971     break;
 972   case X86Local::A6:
 973     opcodeType = THREEBYTE_A6;
 974     if (needsModRMForDecode(Form))
 975       filter = new ModFilter(isRegFormat(Form));
 976     else
 977       filter = new DumbFilter();
 978     opcodeToSet = Opcode;
 979     break;
 980   case X86Local::A7:
 981     opcodeType = THREEBYTE_A7;
 982     if (needsModRMForDecode(Form))
 983       filter = new ModFilter(isRegFormat(Form));
 984     else
 985       filter = new DumbFilter();
 986     opcodeToSet = Opcode;
 987     break;
 988   case X86Local::XOP8:
 989     opcodeType = XOP8_MAP;
 990     if (needsModRMForDecode(Form))
 991       filter = new ModFilter(isRegFormat(Form));
 992     else
 993       filter = new DumbFilter();
 994     opcodeToSet = Opcode;
 995     break;
 996   case X86Local::XOP9:
 997     opcodeType = XOP9_MAP;
 998     switch (Opcode) {
 999     default:
1000       if (needsModRMForDecode(Form))
1001         filter = new ModFilter(isRegFormat(Form));
1002       else
1003         filter = new DumbFilter();
1004       break;
1005 #define EXTENSION_TABLE(n) case 0x##n:
1006     XOP9_MAP_EXTENSION_TABLES
1007 #undef EXTENSION_TABLE
1008       switch (Form) {
1009       default:
1010         llvm_unreachable("Unhandled XOP9 extended opcode");
1011       case X86Local::MRM0r:
1012       case X86Local::MRM1r:
1013       case X86Local::MRM2r:
1014       case X86Local::MRM3r:
1015       case X86Local::MRM4r:
1016       case X86Local::MRM5r:
1017       case X86Local::MRM6r:
1018       case X86Local::MRM7r:
1019         filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
1020         break;
1021       case X86Local::MRM0m:
1022       case X86Local::MRM1m:
1023       case X86Local::MRM2m:
1024       case X86Local::MRM3m:
1025       case X86Local::MRM4m:
1026       case X86Local::MRM5m:
1027       case X86Local::MRM6m:
1028       case X86Local::MRM7m:
1029         filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
1030         break;
1031       MRM_MAPPING
1032       } // switch (Form)
1033       break;
1034     } // switch (Opcode)
1035     opcodeToSet = Opcode;
1036     break;
1037   case X86Local::XOPA:
1038     opcodeType = XOPA_MAP;
1039     if (needsModRMForDecode(Form))
1040       filter = new ModFilter(isRegFormat(Form));
1041     else
1042       filter = new DumbFilter();
1043     opcodeToSet = Opcode;
1044     break;
1045   case X86Local::D8:
1046   case X86Local::D9:
1047   case X86Local::DA:
1048   case X86Local::DB:
1049   case X86Local::DC:
1050   case X86Local::DD:
1051   case X86Local::DE:
1052   case X86Local::DF:
1053     assert(Opcode >= 0xc0 && "Unexpected opcode for an escape opcode");
1054     assert(Form == X86Local::RawFrm);
1055     opcodeType = ONEBYTE;
1056     filter = new ExactFilter(Opcode);
1057     opcodeToSet = 0xd8 + (Prefix - X86Local::D8);
1058     break;
1059   case X86Local::REP:
1060   case 0:
1061     opcodeType = ONEBYTE;
1062     switch (Opcode) {
1063 #define EXTENSION_TABLE(n) case 0x##n:
1064     ONE_BYTE_EXTENSION_TABLES
1065 #undef EXTENSION_TABLE
1066       switch (Form) {
1067       default:
1068         llvm_unreachable("Fell through the cracks of a single-byte "
1069                          "extended opcode");
1070       case X86Local::MRM0r:
1071       case X86Local::MRM1r:
1072       case X86Local::MRM2r:
1073       case X86Local::MRM3r:
1074       case X86Local::MRM4r:
1075       case X86Local::MRM5r:
1076       case X86Local::MRM6r:
1077       case X86Local::MRM7r:
1078         filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
1079         break;
1080       case X86Local::MRM0m:
1081       case X86Local::MRM1m:
1082       case X86Local::MRM2m:
1083       case X86Local::MRM3m:
1084       case X86Local::MRM4m:
1085       case X86Local::MRM5m:
1086       case X86Local::MRM6m:
1087       case X86Local::MRM7m:
1088         filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
1089         break;
1090       MRM_MAPPING
1091       } // switch (Form)
1092       break;
1093     case 0xd8:
1094     case 0xd9:
1095     case 0xda:
1096     case 0xdb:
1097     case 0xdc:
1098     case 0xdd:
1099     case 0xde:
1100     case 0xdf:
1101       switch (Form) {
1102       default:
1103         llvm_unreachable("Unhandled escape opcode form");
1104       case X86Local::MRM0r:
1105       case X86Local::MRM1r:
1106       case X86Local::MRM2r:
1107       case X86Local::MRM3r:
1108       case X86Local::MRM4r:
1109       case X86Local::MRM5r:
1110       case X86Local::MRM6r:
1111       case X86Local::MRM7r:
1112         filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
1113         break;
1114       case X86Local::MRM0m:
1115       case X86Local::MRM1m:
1116       case X86Local::MRM2m:
1117       case X86Local::MRM3m:
1118       case X86Local::MRM4m:
1119       case X86Local::MRM5m:
1120       case X86Local::MRM6m:
1121       case X86Local::MRM7m:
1122         filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
1123         break;
1124       } // switch (Form)
1125       break;
1126     default:
1127       if (needsModRMForDecode(Form))
1128         filter = new ModFilter(isRegFormat(Form));
1129       else
1130         filter = new DumbFilter();
1131       break;
1132     } // switch (Opcode)
1133     opcodeToSet = Opcode;
1134   } // switch (Prefix)
1135
1136   assert(opcodeType != (OpcodeType)-1 &&
1137          "Opcode type not set");
1138   assert(filter && "Filter not set");
1139
1140   if (Form == X86Local::AddRegFrm) {
1141     assert(((opcodeToSet & 7) == 0) &&
1142            "ADDREG_FRM opcode not aligned");
1143
1144     uint8_t currentOpcode;
1145
1146     for (currentOpcode = opcodeToSet;
1147          currentOpcode < opcodeToSet + 8;
1148          ++currentOpcode)
1149       tables.setTableFields(opcodeType,
1150                             insnContext(),
1151                             currentOpcode,
1152                             *filter,
1153                             UID, Is32Bit, IgnoresVEX_L);
1154   } else {
1155     tables.setTableFields(opcodeType,
1156                           insnContext(),
1157                           opcodeToSet,
1158                           *filter,
1159                           UID, Is32Bit, IgnoresVEX_L);
1160   }
1161
1162   delete filter;
1163
1164 #undef MAP
1165 }
1166
1167 #define TYPE(str, type) if (s == str) return type;
1168 OperandType RecognizableInstr::typeFromString(const std::string &s,
1169                                               bool isSSE,
1170                                               bool hasREX_WPrefix,
1171                                               bool hasOpSizePrefix) {
1172   if (isSSE) {
1173     // For SSE instructions, we ignore the OpSize prefix and force operand
1174     // sizes.
1175     TYPE("GR16",              TYPE_R16)
1176     TYPE("GR32",              TYPE_R32)
1177     TYPE("GR64",              TYPE_R64)
1178   }
1179   if(hasREX_WPrefix) {
1180     // For instructions with a REX_W prefix, a declared 32-bit register encoding
1181     // is special.
1182     TYPE("GR32",              TYPE_R32)
1183   }
1184   if(!hasOpSizePrefix) {
1185     // For instructions without an OpSize prefix, a declared 16-bit register or
1186     // immediate encoding is special.
1187     TYPE("GR16",              TYPE_R16)
1188     TYPE("i16imm",            TYPE_IMM16)
1189   }
1190   TYPE("i16mem",              TYPE_Mv)
1191   TYPE("i16imm",              TYPE_IMMv)
1192   TYPE("i16i8imm",            TYPE_IMMv)
1193   TYPE("GR16",                TYPE_Rv)
1194   TYPE("i32mem",              TYPE_Mv)
1195   TYPE("i32imm",              TYPE_IMMv)
1196   TYPE("i32i8imm",            TYPE_IMM32)
1197   TYPE("u32u8imm",            TYPE_IMM32)
1198   TYPE("GR32",                TYPE_Rv)
1199   TYPE("GR32orGR64",          TYPE_R32)
1200   TYPE("i64mem",              TYPE_Mv)
1201   TYPE("i64i32imm",           TYPE_IMM64)
1202   TYPE("i64i8imm",            TYPE_IMM64)
1203   TYPE("GR64",                TYPE_R64)
1204   TYPE("i8mem",               TYPE_M8)
1205   TYPE("i8imm",               TYPE_IMM8)
1206   TYPE("GR8",                 TYPE_R8)
1207   TYPE("VR128",               TYPE_XMM128)
1208   TYPE("VR128X",              TYPE_XMM128)
1209   TYPE("f128mem",             TYPE_M128)
1210   TYPE("f256mem",             TYPE_M256)
1211   TYPE("f512mem",             TYPE_M512)
1212   TYPE("FR64",                TYPE_XMM64)
1213   TYPE("FR64X",               TYPE_XMM64)
1214   TYPE("f64mem",              TYPE_M64FP)
1215   TYPE("sdmem",               TYPE_M64FP)
1216   TYPE("FR32",                TYPE_XMM32)
1217   TYPE("FR32X",               TYPE_XMM32)
1218   TYPE("f32mem",              TYPE_M32FP)
1219   TYPE("ssmem",               TYPE_M32FP)
1220   TYPE("RST",                 TYPE_ST)
1221   TYPE("i128mem",             TYPE_M128)
1222   TYPE("i256mem",             TYPE_M256)
1223   TYPE("i512mem",             TYPE_M512)
1224   TYPE("i64i32imm_pcrel",     TYPE_REL64)
1225   TYPE("i16imm_pcrel",        TYPE_REL16)
1226   TYPE("i32imm_pcrel",        TYPE_REL32)
1227   TYPE("SSECC",               TYPE_IMM3)
1228   TYPE("AVXCC",               TYPE_IMM5)
1229   TYPE("AVX512RC",            TYPE_IMM32)
1230   TYPE("brtarget",            TYPE_RELv)
1231   TYPE("uncondbrtarget",      TYPE_RELv)
1232   TYPE("brtarget8",           TYPE_REL8)
1233   TYPE("f80mem",              TYPE_M80FP)
1234   TYPE("lea32mem",            TYPE_LEA)
1235   TYPE("lea64_32mem",         TYPE_LEA)
1236   TYPE("lea64mem",            TYPE_LEA)
1237   TYPE("VR64",                TYPE_MM64)
1238   TYPE("i64imm",              TYPE_IMMv)
1239   TYPE("opaque32mem",         TYPE_M1616)
1240   TYPE("opaque48mem",         TYPE_M1632)
1241   TYPE("opaque80mem",         TYPE_M1664)
1242   TYPE("opaque512mem",        TYPE_M512)
1243   TYPE("SEGMENT_REG",         TYPE_SEGMENTREG)
1244   TYPE("DEBUG_REG",           TYPE_DEBUGREG)
1245   TYPE("CONTROL_REG",         TYPE_CONTROLREG)
1246   TYPE("offset8",             TYPE_MOFFS8)
1247   TYPE("offset16",            TYPE_MOFFS16)
1248   TYPE("offset32",            TYPE_MOFFS32)
1249   TYPE("offset64",            TYPE_MOFFS64)
1250   TYPE("VR256",               TYPE_XMM256)
1251   TYPE("VR256X",              TYPE_XMM256)
1252   TYPE("VR512",               TYPE_XMM512)
1253   TYPE("VK1",                 TYPE_VK1)
1254   TYPE("VK1WM",               TYPE_VK1)
1255   TYPE("VK8",                 TYPE_VK8)
1256   TYPE("VK8WM",               TYPE_VK8)
1257   TYPE("VK16",                TYPE_VK16)
1258   TYPE("VK16WM",              TYPE_VK16)
1259   TYPE("GR16_NOAX",           TYPE_Rv)
1260   TYPE("GR32_NOAX",           TYPE_Rv)
1261   TYPE("GR64_NOAX",           TYPE_R64)
1262   TYPE("vx32mem",             TYPE_M32)
1263   TYPE("vy32mem",             TYPE_M32)
1264   TYPE("vz32mem",             TYPE_M32)
1265   TYPE("vx64mem",             TYPE_M64)
1266   TYPE("vy64mem",             TYPE_M64)
1267   TYPE("vy64xmem",            TYPE_M64)
1268   TYPE("vz64mem",             TYPE_M64)
1269   errs() << "Unhandled type string " << s << "\n";
1270   llvm_unreachable("Unhandled type string");
1271 }
1272 #undef TYPE
1273
1274 #define ENCODING(str, encoding) if (s == str) return encoding;
1275 OperandEncoding RecognizableInstr::immediateEncodingFromString
1276   (const std::string &s,
1277    bool hasOpSizePrefix) {
1278   if(!hasOpSizePrefix) {
1279     // For instructions without an OpSize prefix, a declared 16-bit register or
1280     // immediate encoding is special.
1281     ENCODING("i16imm",        ENCODING_IW)
1282   }
1283   ENCODING("i32i8imm",        ENCODING_IB)
1284   ENCODING("u32u8imm",        ENCODING_IB)
1285   ENCODING("SSECC",           ENCODING_IB)
1286   ENCODING("AVXCC",           ENCODING_IB)
1287   ENCODING("AVX512RC",        ENCODING_IB)
1288   ENCODING("i16imm",          ENCODING_Iv)
1289   ENCODING("i16i8imm",        ENCODING_IB)
1290   ENCODING("i32imm",          ENCODING_Iv)
1291   ENCODING("i64i32imm",       ENCODING_ID)
1292   ENCODING("i64i8imm",        ENCODING_IB)
1293   ENCODING("i8imm",           ENCODING_IB)
1294   // This is not a typo.  Instructions like BLENDVPD put
1295   // register IDs in 8-bit immediates nowadays.
1296   ENCODING("FR32",            ENCODING_IB)
1297   ENCODING("FR64",            ENCODING_IB)
1298   ENCODING("VR128",           ENCODING_IB)
1299   ENCODING("VR256",           ENCODING_IB)
1300   ENCODING("FR32X",           ENCODING_IB)
1301   ENCODING("FR64X",           ENCODING_IB)
1302   ENCODING("VR128X",          ENCODING_IB)
1303   ENCODING("VR256X",          ENCODING_IB)
1304   ENCODING("VR512",           ENCODING_IB)
1305   errs() << "Unhandled immediate encoding " << s << "\n";
1306   llvm_unreachable("Unhandled immediate encoding");
1307 }
1308
1309 OperandEncoding RecognizableInstr::rmRegisterEncodingFromString
1310   (const std::string &s,
1311    bool hasOpSizePrefix) {
1312   ENCODING("RST",             ENCODING_FP)
1313   ENCODING("GR16",            ENCODING_RM)
1314   ENCODING("GR32",            ENCODING_RM)
1315   ENCODING("GR32orGR64",      ENCODING_RM)
1316   ENCODING("GR64",            ENCODING_RM)
1317   ENCODING("GR8",             ENCODING_RM)
1318   ENCODING("VR128",           ENCODING_RM)
1319   ENCODING("VR128X",          ENCODING_RM)
1320   ENCODING("FR64",            ENCODING_RM)
1321   ENCODING("FR32",            ENCODING_RM)
1322   ENCODING("FR64X",           ENCODING_RM)
1323   ENCODING("FR32X",           ENCODING_RM)
1324   ENCODING("VR64",            ENCODING_RM)
1325   ENCODING("VR256",           ENCODING_RM)
1326   ENCODING("VR256X",          ENCODING_RM)
1327   ENCODING("VR512",           ENCODING_RM)
1328   ENCODING("VK1",             ENCODING_RM)
1329   ENCODING("VK8",             ENCODING_RM)
1330   ENCODING("VK16",            ENCODING_RM)
1331   errs() << "Unhandled R/M register encoding " << s << "\n";
1332   llvm_unreachable("Unhandled R/M register encoding");
1333 }
1334
1335 OperandEncoding RecognizableInstr::roRegisterEncodingFromString
1336   (const std::string &s,
1337    bool hasOpSizePrefix) {
1338   ENCODING("GR16",            ENCODING_REG)
1339   ENCODING("GR32",            ENCODING_REG)
1340   ENCODING("GR32orGR64",      ENCODING_REG)
1341   ENCODING("GR64",            ENCODING_REG)
1342   ENCODING("GR8",             ENCODING_REG)
1343   ENCODING("VR128",           ENCODING_REG)
1344   ENCODING("FR64",            ENCODING_REG)
1345   ENCODING("FR32",            ENCODING_REG)
1346   ENCODING("VR64",            ENCODING_REG)
1347   ENCODING("SEGMENT_REG",     ENCODING_REG)
1348   ENCODING("DEBUG_REG",       ENCODING_REG)
1349   ENCODING("CONTROL_REG",     ENCODING_REG)
1350   ENCODING("VR256",           ENCODING_REG)
1351   ENCODING("VR256X",          ENCODING_REG)
1352   ENCODING("VR128X",          ENCODING_REG)
1353   ENCODING("FR64X",           ENCODING_REG)
1354   ENCODING("FR32X",           ENCODING_REG)
1355   ENCODING("VR512",           ENCODING_REG)
1356   ENCODING("VK1",             ENCODING_REG)
1357   ENCODING("VK8",             ENCODING_REG)
1358   ENCODING("VK16",            ENCODING_REG)
1359   ENCODING("VK1WM",           ENCODING_REG)
1360   ENCODING("VK8WM",           ENCODING_REG)
1361   ENCODING("VK16WM",          ENCODING_REG)
1362   errs() << "Unhandled reg/opcode register encoding " << s << "\n";
1363   llvm_unreachable("Unhandled reg/opcode register encoding");
1364 }
1365
1366 OperandEncoding RecognizableInstr::vvvvRegisterEncodingFromString
1367   (const std::string &s,
1368    bool hasOpSizePrefix) {
1369   ENCODING("GR32",            ENCODING_VVVV)
1370   ENCODING("GR64",            ENCODING_VVVV)
1371   ENCODING("FR32",            ENCODING_VVVV)
1372   ENCODING("FR64",            ENCODING_VVVV)
1373   ENCODING("VR128",           ENCODING_VVVV)
1374   ENCODING("VR256",           ENCODING_VVVV)
1375   ENCODING("FR32X",           ENCODING_VVVV)
1376   ENCODING("FR64X",           ENCODING_VVVV)
1377   ENCODING("VR128X",          ENCODING_VVVV)
1378   ENCODING("VR256X",          ENCODING_VVVV)
1379   ENCODING("VR512",           ENCODING_VVVV)
1380   ENCODING("VK1",             ENCODING_VVVV)
1381   ENCODING("VK8",             ENCODING_VVVV)
1382   ENCODING("VK16",            ENCODING_VVVV)
1383   errs() << "Unhandled VEX.vvvv register encoding " << s << "\n";
1384   llvm_unreachable("Unhandled VEX.vvvv register encoding");
1385 }
1386
1387 OperandEncoding RecognizableInstr::writemaskRegisterEncodingFromString
1388   (const std::string &s,
1389    bool hasOpSizePrefix) {
1390   ENCODING("VK1WM",           ENCODING_WRITEMASK)
1391   ENCODING("VK8WM",           ENCODING_WRITEMASK)
1392   ENCODING("VK16WM",          ENCODING_WRITEMASK)
1393   errs() << "Unhandled mask register encoding " << s << "\n";
1394   llvm_unreachable("Unhandled mask register encoding");
1395 }
1396
1397 OperandEncoding RecognizableInstr::memoryEncodingFromString
1398   (const std::string &s,
1399    bool hasOpSizePrefix) {
1400   ENCODING("i16mem",          ENCODING_RM)
1401   ENCODING("i32mem",          ENCODING_RM)
1402   ENCODING("i64mem",          ENCODING_RM)
1403   ENCODING("i8mem",           ENCODING_RM)
1404   ENCODING("ssmem",           ENCODING_RM)
1405   ENCODING("sdmem",           ENCODING_RM)
1406   ENCODING("f128mem",         ENCODING_RM)
1407   ENCODING("f256mem",         ENCODING_RM)
1408   ENCODING("f512mem",         ENCODING_RM)
1409   ENCODING("f64mem",          ENCODING_RM)
1410   ENCODING("f32mem",          ENCODING_RM)
1411   ENCODING("i128mem",         ENCODING_RM)
1412   ENCODING("i256mem",         ENCODING_RM)
1413   ENCODING("i512mem",         ENCODING_RM)
1414   ENCODING("f80mem",          ENCODING_RM)
1415   ENCODING("lea32mem",        ENCODING_RM)
1416   ENCODING("lea64_32mem",     ENCODING_RM)
1417   ENCODING("lea64mem",        ENCODING_RM)
1418   ENCODING("opaque32mem",     ENCODING_RM)
1419   ENCODING("opaque48mem",     ENCODING_RM)
1420   ENCODING("opaque80mem",     ENCODING_RM)
1421   ENCODING("opaque512mem",    ENCODING_RM)
1422   ENCODING("vx32mem",         ENCODING_RM)
1423   ENCODING("vy32mem",         ENCODING_RM)
1424   ENCODING("vz32mem",         ENCODING_RM)
1425   ENCODING("vx64mem",         ENCODING_RM)
1426   ENCODING("vy64mem",         ENCODING_RM)
1427   ENCODING("vy64xmem",        ENCODING_RM)
1428   ENCODING("vz64mem",         ENCODING_RM)
1429   errs() << "Unhandled memory encoding " << s << "\n";
1430   llvm_unreachable("Unhandled memory encoding");
1431 }
1432
1433 OperandEncoding RecognizableInstr::relocationEncodingFromString
1434   (const std::string &s,
1435    bool hasOpSizePrefix) {
1436   if(!hasOpSizePrefix) {
1437     // For instructions without an OpSize prefix, a declared 16-bit register or
1438     // immediate encoding is special.
1439     ENCODING("i16imm",        ENCODING_IW)
1440   }
1441   ENCODING("i16imm",          ENCODING_Iv)
1442   ENCODING("i16i8imm",        ENCODING_IB)
1443   ENCODING("i32imm",          ENCODING_Iv)
1444   ENCODING("i32i8imm",        ENCODING_IB)
1445   ENCODING("i64i32imm",       ENCODING_ID)
1446   ENCODING("i64i8imm",        ENCODING_IB)
1447   ENCODING("i8imm",           ENCODING_IB)
1448   ENCODING("i64i32imm_pcrel", ENCODING_ID)
1449   ENCODING("i16imm_pcrel",    ENCODING_IW)
1450   ENCODING("i32imm_pcrel",    ENCODING_ID)
1451   ENCODING("brtarget",        ENCODING_Iv)
1452   ENCODING("brtarget8",       ENCODING_IB)
1453   ENCODING("i64imm",          ENCODING_IO)
1454   ENCODING("offset8",         ENCODING_Ia)
1455   ENCODING("offset16",        ENCODING_Ia)
1456   ENCODING("offset32",        ENCODING_Ia)
1457   ENCODING("offset64",        ENCODING_Ia)
1458   errs() << "Unhandled relocation encoding " << s << "\n";
1459   llvm_unreachable("Unhandled relocation encoding");
1460 }
1461
1462 OperandEncoding RecognizableInstr::opcodeModifierEncodingFromString
1463   (const std::string &s,
1464    bool hasOpSizePrefix) {
1465   ENCODING("GR32",            ENCODING_Rv)
1466   ENCODING("GR64",            ENCODING_RO)
1467   ENCODING("GR16",            ENCODING_Rv)
1468   ENCODING("GR8",             ENCODING_RB)
1469   ENCODING("GR16_NOAX",       ENCODING_Rv)
1470   ENCODING("GR32_NOAX",       ENCODING_Rv)
1471   ENCODING("GR64_NOAX",       ENCODING_RO)
1472   errs() << "Unhandled opcode modifier encoding " << s << "\n";
1473   llvm_unreachable("Unhandled opcode modifier encoding");
1474 }
1475 #undef ENCODING