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