utils/TableGen/EDEmitter.cpp

   1 //===- EDEmitter.cpp - Generate instruction descriptions for ED -*- 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 tablegen backend is responsible for emitting a description of each
  11 // instruction in a format that the enhanced disassembler can use to tokenize
  12 // and parse instructions.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "AsmWriterInst.h"
  17 #include "CodeGenTarget.h"
  18 #include "llvm/MC/EDInstInfo.h"
  19 #include "llvm/Support/ErrorHandling.h"
  20 #include "llvm/Support/Format.h"
  21 #include "llvm/Support/raw_ostream.h"
  22 #include "llvm/TableGen/Record.h"
  23 #include "llvm/TableGen/TableGenBackend.h"
  24 #include <string>
  25 #include <vector>
  26
  27 using namespace llvm;
  28
  29 // TODO: There's a suspiciously large amount of "table" data in this
  30 // backend which should probably be in the TableGen file itself.
  31
  32 ///////////////////////////////////////////////////////////
  33 // Support classes for emitting nested C data structures //
  34 ///////////////////////////////////////////////////////////
  35
  36 // TODO: These classes are probably generally useful to other backends;
  37 // add them to TableGen's "helper" API's.
  38
  39 namespace {
  40 class EnumEmitter {
  41 private:
  42   std::string Name;
  43   std::vector<std::string> Entries;
  44 public:
  45   EnumEmitter(const char *N) : Name(N) {
  46   }
  47   int addEntry(const char *e) {
  48     Entries.push_back(std::string(e));
  49     return Entries.size() - 1;
  50   }
  51   void emit(raw_ostream &o, unsigned int &i) {
  52     o.indent(i) << "enum " << Name.c_str() << " {" << "\n";
  53     i += 2;
  54
  55     unsigned int index = 0;
  56     unsigned int numEntries = Entries.size();
  57     for (index = 0; index < numEntries; ++index) {
  58       o.indent(i) << Entries[index];
  59       if (index < (numEntries - 1))
  60         o << ",";
  61       o << "\n";
  62     }
  63
  64     i -= 2;
  65     o.indent(i) << "};" << "\n";
  66   }
  67
  68   void emitAsFlags(raw_ostream &o, unsigned int &i) {
  69     o.indent(i) << "enum " << Name.c_str() << " {" << "\n";
  70     i += 2;
  71
  72     unsigned int index = 0;
  73     unsigned int numEntries = Entries.size();
  74     unsigned int flag = 1;
  75     for (index = 0; index < numEntries; ++index) {
  76       o.indent(i) << Entries[index] << " = " << format("0x%x", flag);
  77       if (index < (numEntries - 1))
  78         o << ",";
  79       o << "\n";
  80       flag <<= 1;
  81     }
  82
  83     i -= 2;
  84     o.indent(i) << "};" << "\n";
  85   }
  86 };
  87 } // End anonymous namespace
  88
  89 namespace {
  90 class ConstantEmitter {
  91 public:
  92   virtual ~ConstantEmitter() { }
  93   virtual void emit(raw_ostream &o, unsigned int &i) = 0;
  94 };
  95 } // End anonymous namespace
  96
  97 namespace {
  98 class LiteralConstantEmitter : public ConstantEmitter {
  99 private:
 100   bool IsNumber;
 101   union {
 102     int Number;
 103     const char* String;
 104   };
 105 public:
 106   LiteralConstantEmitter(int number = 0) :
 107     IsNumber(true),
 108     Number(number) {
 109   }
 110   void set(const char *string) {
 111     IsNumber = false;
 112     Number = 0;
 113     String = string;
 114   }
 115   bool is(const char *string) {
 116     return !strcmp(String, string);
 117   }
 118   void emit(raw_ostream &o, unsigned int &i) {
 119     if (IsNumber)
 120       o << Number;
 121     else
 122       o << String;
 123   }
 124 };
 125 } // End anonymous namespace
 126
 127 namespace {
 128 class CompoundConstantEmitter : public ConstantEmitter {
 129 private:
 130   unsigned int Padding;
 131   std::vector<ConstantEmitter *> Entries;
 132 public:
 133   CompoundConstantEmitter(unsigned int padding = 0) : Padding(padding) {
 134   }
 135   CompoundConstantEmitter &addEntry(ConstantEmitter *e) {
 136     Entries.push_back(e);
 137
 138     return *this;
 139   }
 140   ~CompoundConstantEmitter() {
 141     while (Entries.size()) {
 142       ConstantEmitter *entry = Entries.back();
 143       Entries.pop_back();
 144       delete entry;
 145     }
 146   }
 147   void emit(raw_ostream &o, unsigned int &i) {
 148     o << "{" << "\n";
 149     i += 2;
 150
 151     unsigned int index;
 152     unsigned int numEntries = Entries.size();
 153
 154     unsigned int numToPrint;
 155
 156     if (Padding) {
 157       if (numEntries > Padding) {
 158         fprintf(stderr, "%u entries but %u padding\n", numEntries, Padding);
 159         llvm_unreachable("More entries than padding");
 160       }
 161       numToPrint = Padding;
 162     } else {
 163       numToPrint = numEntries;
 164     }
 165
 166     for (index = 0; index < numToPrint; ++index) {
 167       o.indent(i);
 168       if (index < numEntries)
 169         Entries[index]->emit(o, i);
 170       else
 171         o << "-1";
 172
 173       if (index < (numToPrint - 1))
 174         o << ",";
 175       o << "\n";
 176     }
 177
 178     i -= 2;
 179     o.indent(i) << "}";
 180   }
 181 };
 182 } // End anonymous namespace
 183
 184 namespace {
 185 class FlagsConstantEmitter : public ConstantEmitter {
 186 private:
 187   std::vector<std::string> Flags;
 188 public:
 189   FlagsConstantEmitter() {
 190   }
 191   FlagsConstantEmitter &addEntry(const char *f) {
 192     Flags.push_back(std::string(f));
 193     return *this;
 194   }
 195   void emit(raw_ostream &o, unsigned int &i) {
 196     unsigned int index;
 197     unsigned int numFlags = Flags.size();
 198     if (numFlags == 0)
 199       o << "0";
 200
 201     for (index = 0; index < numFlags; ++index) {
 202       o << Flags[index].c_str();
 203       if (index < (numFlags - 1))
 204         o << " | ";
 205     }
 206   }
 207 };
 208 } // End anonymous namespace
 209
 210 /// populateOperandOrder - Accepts a CodeGenInstruction and generates its
 211 ///   AsmWriterInst for the desired assembly syntax, giving an ordered list of
 212 ///   operands in the order they appear in the printed instruction.  Then, for
 213 ///   each entry in that list, determines the index of the same operand in the
 214 ///   CodeGenInstruction, and emits the resulting mapping into an array, filling
 215 ///   in unused slots with -1.
 216 ///
 217 /// @arg operandOrder - The array that will be populated with the operand
 218 ///                     mapping.  Each entry will contain -1 (invalid index
 219 ///                     into the operands present in the AsmString) or a number
 220 ///                     representing an index in the operand descriptor array.
 221 /// @arg inst         - The instruction to use when looking up the operands
 222 /// @arg syntax       - The syntax to use, according to LLVM's enumeration
 223 static void populateOperandOrder(CompoundConstantEmitter *operandOrder,
 224                                  const CodeGenInstruction &inst,
 225                                  unsigned syntax) {
 226   unsigned int numArgs = 0;
 227
 228   AsmWriterInst awInst(inst, syntax, -1, -1);
 229
 230   std::vector<AsmWriterOperand>::iterator operandIterator;
 231
 232   for (operandIterator = awInst.Operands.begin();
 233        operandIterator != awInst.Operands.end();
 234        ++operandIterator) {
 235     if (operandIterator->OperandType ==
 236         AsmWriterOperand::isMachineInstrOperand) {
 237       operandOrder->addEntry(
 238         new LiteralConstantEmitter(operandIterator->CGIOpNo));
 239       numArgs++;
 240     }
 241   }
 242 }
 243
 244 /////////////////////////////////////////////////////
 245 // Support functions for handling X86 instructions //
 246 /////////////////////////////////////////////////////
 247
 248 #define SET(flag) { type->set(flag); return 0; }
 249
 250 #define REG(str) if (name == str) SET("kOperandTypeRegister");
 251 #define MEM(str) if (name == str) SET("kOperandTypeX86Memory");
 252 #define LEA(str) if (name == str) SET("kOperandTypeX86EffectiveAddress");
 253 #define IMM(str) if (name == str) SET("kOperandTypeImmediate");
 254 #define PCR(str) if (name == str) SET("kOperandTypeX86PCRelative");
 255
 256 /// X86TypeFromOpName - Processes the name of a single X86 operand (which is
 257 ///   actually its type) and translates it into an operand type
 258 ///
 259 /// @arg flags    - The type object to set
 260 /// @arg name     - The name of the operand
 261 static int X86TypeFromOpName(LiteralConstantEmitter *type,
 262                              const std::string &name) {
 263   REG("GR8");
 264   REG("GR8_NOREX");
 265   REG("GR16");
 266   REG("GR16_NOAX");
 267   REG("GR32");
 268   REG("GR32_NOAX");
 269   REG("GR32_NOREX");
 270   REG("GR32_TC");
 271   REG("FR32");
 272   REG("RFP32");
 273   REG("GR64");
 274   REG("GR64_NOAX");
 275   REG("GR64_TC");
 276   REG("FR64");
 277   REG("VR64");
 278   REG("RFP64");
 279   REG("RFP80");
 280   REG("VR128");
 281   REG("VR256");
 282   REG("RST");
 283   REG("SEGMENT_REG");
 284   REG("DEBUG_REG");
 285   REG("CONTROL_REG");
 286
 287   IMM("i8imm");
 288   IMM("i16imm");
 289   IMM("i16i8imm");
 290   IMM("i32imm");
 291   IMM("i32i8imm");
 292   IMM("u32u8imm");
 293   IMM("i64imm");
 294   IMM("i64i8imm");
 295   IMM("i64i32imm");
 296   IMM("SSECC");
 297   IMM("AVXCC");
 298
 299   // all R, I, R, I, R
 300   MEM("i8mem");
 301   MEM("i8mem_NOREX");
 302   MEM("i16mem");
 303   MEM("i32mem");
 304   MEM("i32mem_TC");
 305   MEM("f32mem");
 306   MEM("ssmem");
 307   MEM("opaque32mem");
 308   MEM("opaque48mem");
 309   MEM("i64mem");
 310   MEM("i64mem_TC");
 311   MEM("f64mem");
 312   MEM("sdmem");
 313   MEM("f80mem");
 314   MEM("opaque80mem");
 315   MEM("i128mem");
 316   MEM("i256mem");
 317   MEM("f128mem");
 318   MEM("f256mem");
 319   MEM("opaque512mem");
 320
 321   // all R, I, R, I
 322   LEA("lea32mem");
 323   LEA("lea64_32mem");
 324   LEA("lea64mem");
 325
 326   // all I
 327   PCR("i16imm_pcrel");
 328   PCR("i32imm_pcrel");
 329   PCR("i64i32imm_pcrel");
 330   PCR("brtarget8");
 331   PCR("offset8");
 332   PCR("offset16");
 333   PCR("offset32");
 334   PCR("offset64");
 335   PCR("brtarget");
 336   PCR("uncondbrtarget");
 337   PCR("bltarget");
 338
 339   // all I, ARM mode only, conditional/unconditional
 340   PCR("br_target");
 341   PCR("bl_target");
 342   return 1;
 343 }
 344
 345 #undef REG
 346 #undef MEM
 347 #undef LEA
 348 #undef IMM
 349 #undef PCR
 350
 351 #undef SET
 352
 353 /// X86PopulateOperands - Handles all the operands in an X86 instruction, adding
 354 ///   the appropriate flags to their descriptors
 355 ///
 356 /// @operandFlags - A reference the array of operand flag objects
 357 /// @inst         - The instruction to use as a source of information
 358 static void X86PopulateOperands(
 359   LiteralConstantEmitter *(&operandTypes)[EDIS_MAX_OPERANDS],
 360   const CodeGenInstruction &inst) {
 361   if (!inst.TheDef->isSubClassOf("X86Inst"))
 362     return;
 363
 364   unsigned int index;
 365   unsigned int numOperands = inst.Operands.size();
 366
 367   for (index = 0; index < numOperands; ++index) {
 368     const CGIOperandList::OperandInfo &operandInfo = inst.Operands[index];
 369     Record &rec = *operandInfo.Rec;
 370
 371     if (X86TypeFromOpName(operandTypes[index], rec.getName()) &&
 372         !rec.isSubClassOf("PointerLikeRegClass")) {
 373       errs() << "Operand type: " << rec.getName().c_str() << "\n";
 374       errs() << "Operand name: " << operandInfo.Name.c_str() << "\n";
 375       errs() << "Instruction name: " << inst.TheDef->getName().c_str() << "\n";
 376       llvm_unreachable("Unhandled type");
 377     }
 378   }
 379 }
 380
 381 /// decorate1 - Decorates a named operand with a new flag
 382 ///
 383 /// @operandFlags - The array of operand flag objects, which don't have names
 384 /// @inst         - The CodeGenInstruction, which provides a way to translate
 385 ///                 between names and operand indices
 386 /// @opName       - The name of the operand
 387 /// @flag         - The name of the flag to add
 388 static inline void decorate1(
 389   FlagsConstantEmitter *(&operandFlags)[EDIS_MAX_OPERANDS],
 390   const CodeGenInstruction &inst,
 391   const char *opName,
 392   const char *opFlag) {
 393   unsigned opIndex;
 394
 395   opIndex = inst.Operands.getOperandNamed(std::string(opName));
 396
 397   operandFlags[opIndex]->addEntry(opFlag);
 398 }
 399
 400 #define DECORATE1(opName, opFlag) decorate1(operandFlags, inst, opName, opFlag)
 401
 402 #define MOV(source, target) {               \
 403   instType.set("kInstructionTypeMove");     \
 404   DECORATE1(source, "kOperandFlagSource");  \
 405   DECORATE1(target, "kOperandFlagTarget");  \
 406 }
 407
 408 #define BRANCH(target) {                    \
 409   instType.set("kInstructionTypeBranch");   \
 410   DECORATE1(target, "kOperandFlagTarget");  \
 411 }
 412
 413 #define PUSH(source) {                      \
 414   instType.set("kInstructionTypePush");     \
 415   DECORATE1(source, "kOperandFlagSource");  \
 416 }
 417
 418 #define POP(target) {                       \
 419   instType.set("kInstructionTypePop");      \
 420   DECORATE1(target, "kOperandFlagTarget");  \
 421 }
 422
 423 #define CALL(target) {                      \
 424   instType.set("kInstructionTypeCall");     \
 425   DECORATE1(target, "kOperandFlagTarget");  \
 426 }
 427
 428 #define RETURN() {                          \
 429   instType.set("kInstructionTypeReturn");   \
 430 }
 431
 432 /// X86ExtractSemantics - Performs various checks on the name of an X86
 433 ///   instruction to determine what sort of an instruction it is and then adds
 434 ///   the appropriate flags to the instruction and its operands
 435 ///
 436 /// @arg instType     - A reference to the type for the instruction as a whole
 437 /// @arg operandFlags - A reference to the array of operand flag object pointers
 438 /// @arg inst         - A reference to the original instruction
 439 static void X86ExtractSemantics(
 440   LiteralConstantEmitter &instType,
 441   FlagsConstantEmitter *(&operandFlags)[EDIS_MAX_OPERANDS],
 442   const CodeGenInstruction &inst) {
 443   const std::string &name = inst.TheDef->getName();
 444
 445   if (name.find("MOV") != name.npos) {
 446     if (name.find("MOV_V") != name.npos) {
 447       // ignore (this is a pseudoinstruction)
 448     } else if (name.find("MASK") != name.npos) {
 449       // ignore (this is a masking move)
 450     } else if (name.find("r0") != name.npos) {
 451       // ignore (this is a pseudoinstruction)
 452     } else if (name.find("PS") != name.npos ||
 453              name.find("PD") != name.npos) {
 454       // ignore (this is a shuffling move)
 455     } else if (name.find("MOVS") != name.npos) {
 456       // ignore (this is a string move)
 457     } else if (name.find("_F") != name.npos) {
 458       // TODO handle _F moves to ST(0)
 459     } else if (name.find("a") != name.npos) {
 460       // TODO handle moves to/from %ax
 461     } else if (name.find("CMOV") != name.npos) {
 462       MOV("src2", "dst");
 463     } else if (name.find("PC") != name.npos) {
 464       MOV("label", "reg")
 465     } else {
 466       MOV("src", "dst");
 467     }
 468   }
 469
 470   if (name.find("JMP") != name.npos ||
 471       name.find("J") == 0) {
 472     if (name.find("FAR") != name.npos && name.find("i") != name.npos) {
 473       BRANCH("off");
 474     } else {
 475       BRANCH("dst");
 476     }
 477   }
 478
 479   if (name.find("PUSH") != name.npos) {
 480     if (name.find("CS") != name.npos ||
 481         name.find("DS") != name.npos ||
 482         name.find("ES") != name.npos ||
 483         name.find("FS") != name.npos ||
 484         name.find("GS") != name.npos ||
 485         name.find("SS") != name.npos) {
 486       instType.set("kInstructionTypePush");
 487       // TODO add support for fixed operands
 488     } else if (name.find("F") != name.npos) {
 489       // ignore (this pushes onto the FP stack)
 490     } else if (name.find("A") != name.npos) {
 491       // ignore (pushes all GP registoers onto the stack)
 492     } else if (name[name.length() - 1] == 'm') {
 493       PUSH("src");
 494     } else if (name.find("i") != name.npos) {
 495       PUSH("imm");
 496     } else {
 497       PUSH("reg");
 498     }
 499   }
 500
 501   if (name.find("POP") != name.npos) {
 502     if (name.find("POPCNT") != name.npos) {
 503       // ignore (not a real pop)
 504     } else if (name.find("CS") != name.npos ||
 505                name.find("DS") != name.npos ||
 506                name.find("ES") != name.npos ||
 507                name.find("FS") != name.npos ||
 508                name.find("GS") != name.npos ||
 509                name.find("SS") != name.npos) {
 510       instType.set("kInstructionTypePop");
 511       // TODO add support for fixed operands
 512     } else if (name.find("F") != name.npos) {
 513       // ignore (this pops from the FP stack)
 514     } else if (name.find("A") != name.npos) {
 515       // ignore (pushes all GP registoers onto the stack)
 516     } else if (name[name.length() - 1] == 'm') {
 517       POP("dst");
 518     } else {
 519       POP("reg");
 520     }
 521   }
 522
 523   if (name.find("CALL") != name.npos) {
 524     if (name.find("ADJ") != name.npos) {
 525       // ignore (not a call)
 526     } else if (name.find("SYSCALL") != name.npos) {
 527       // ignore (doesn't go anywhere we know about)
 528     } else if (name.find("VMCALL") != name.npos) {
 529       // ignore (rather different semantics than a regular call)
 530     } else if (name.find("VMMCALL") != name.npos) {
 531       // ignore (rather different semantics than a regular call)
 532     } else if (name.find("FAR") != name.npos && name.find("i") != name.npos) {
 533       CALL("off");
 534     } else {
 535       CALL("dst");
 536     }
 537   }
 538
 539   if (name.find("RET") != name.npos) {
 540     RETURN();
 541   }
 542 }
 543
 544 #undef MOV
 545 #undef BRANCH
 546 #undef PUSH
 547 #undef POP
 548 #undef CALL
 549 #undef RETURN
 550
 551 /////////////////////////////////////////////////////
 552 // Support functions for handling ARM instructions //
 553 /////////////////////////////////////////////////////
 554
 555 #define SET(flag) { type->set(flag); return 0; }
 556
 557 #define REG(str)    if (name == str) SET("kOperandTypeRegister");
 558 #define IMM(str)    if (name == str) SET("kOperandTypeImmediate");
 559
 560 #define MISC(str, type)   if (name == str) SET(type);
 561
 562 /// ARMFlagFromOpName - Processes the name of a single ARM operand (which is
 563 ///   actually its type) and translates it into an operand type
 564 ///
 565 /// @arg type     - The type object to set
 566 /// @arg name     - The name of the operand
 567 static int ARMFlagFromOpName(LiteralConstantEmitter *type,
 568                              const std::string &name) {
 569   REG("GPR");
 570   REG("rGPR");
 571   REG("GPRnopc");
 572   REG("GPRsp");
 573   REG("tcGPR");
 574   REG("cc_out");
 575   REG("s_cc_out");
 576   REG("tGPR");
 577   REG("DPR");
 578   REG("DPR_VFP2");
 579   REG("DPR_8");
 580   REG("DPair");
 581   REG("SPR");
 582   REG("QPR");
 583   REG("QQPR");
 584   REG("QQQQPR");
 585   REG("VecListOneD");
 586   REG("VecListDPair");
 587   REG("VecListDPairSpaced");
 588   REG("VecListThreeD");
 589   REG("VecListFourD");
 590   REG("VecListOneDAllLanes");
 591   REG("VecListDPairAllLanes");
 592   REG("VecListDPairSpacedAllLanes");
 593
 594   IMM("i32imm");
 595   IMM("fbits16");
 596   IMM("fbits32");
 597   IMM("i32imm_hilo16");
 598   IMM("bf_inv_mask_imm");
 599   IMM("lsb_pos_imm");
 600   IMM("width_imm");
 601   IMM("jtblock_operand");
 602   IMM("nohash_imm");
 603   IMM("p_imm");
 604   IMM("pf_imm");
 605   IMM("c_imm");
 606   IMM("coproc_option_imm");
 607   IMM("imod_op");
 608   IMM("iflags_op");
 609   IMM("cpinst_operand");
 610   IMM("setend_op");
 611   IMM("cps_opt");
 612   IMM("vfp_f64imm");
 613   IMM("vfp_f32imm");
 614   IMM("memb_opt");
 615   IMM("msr_mask");
 616   IMM("neg_zero");
 617   IMM("imm0_31");
 618   IMM("imm0_31_m1");
 619   IMM("imm1_16");
 620   IMM("imm1_32");
 621   IMM("nModImm");
 622   IMM("nImmSplatI8");
 623   IMM("nImmSplatI16");
 624   IMM("nImmSplatI32");
 625   IMM("nImmSplatI64");
 626   IMM("nImmVMOVI32");
 627   IMM("nImmVMOVF32");
 628   IMM("imm8");
 629   IMM("imm16");
 630   IMM("imm32");
 631   IMM("imm1_7");
 632   IMM("imm1_15");
 633   IMM("imm1_31");
 634   IMM("imm0_1");
 635   IMM("imm0_3");
 636   IMM("imm0_7");
 637   IMM("imm0_15");
 638   IMM("imm0_255");
 639   IMM("imm0_4095");
 640   IMM("imm0_65535");
 641   IMM("imm0_65535_expr");
 642   IMM("imm24b");
 643   IMM("pkh_lsl_amt");
 644   IMM("pkh_asr_amt");
 645   IMM("jt2block_operand");
 646   IMM("t_imm0_1020s4");
 647   IMM("t_imm0_508s4");
 648   IMM("pclabel");
 649   IMM("adrlabel");
 650   IMM("t_adrlabel");
 651   IMM("t2adrlabel");
 652   IMM("shift_imm");
 653   IMM("t2_shift_imm");
 654   IMM("neon_vcvt_imm32");
 655   IMM("shr_imm8");
 656   IMM("shr_imm16");
 657   IMM("shr_imm32");
 658   IMM("shr_imm64");
 659   IMM("t2ldrlabel");
 660   IMM("postidx_imm8");
 661   IMM("postidx_imm8s4");
 662   IMM("imm_sr");
 663   IMM("imm1_31");
 664   IMM("VectorIndex8");
 665   IMM("VectorIndex16");
 666   IMM("VectorIndex32");
 667
 668   MISC("brtarget", "kOperandTypeARMBranchTarget");                // ?
 669   MISC("uncondbrtarget", "kOperandTypeARMBranchTarget");           // ?
 670   MISC("t_brtarget", "kOperandTypeARMBranchTarget");              // ?
 671   MISC("t_bcctarget", "kOperandTypeARMBranchTarget");             // ?
 672   MISC("t_cbtarget", "kOperandTypeARMBranchTarget");              // ?
 673   MISC("bltarget", "kOperandTypeARMBranchTarget");                // ?
 674
 675   MISC("br_target", "kOperandTypeARMBranchTarget");                // ?
 676   MISC("bl_target", "kOperandTypeARMBranchTarget");                // ?
 677   MISC("blx_target", "kOperandTypeARMBranchTarget");                // ?
 678
 679   MISC("t_bltarget", "kOperandTypeARMBranchTarget");              // ?
 680   MISC("t_blxtarget", "kOperandTypeARMBranchTarget");             // ?
 681   MISC("so_reg_imm", "kOperandTypeARMSoRegReg");                         // R, R, I
 682   MISC("so_reg_reg", "kOperandTypeARMSoRegImm");                         // R, R, I
 683   MISC("shift_so_reg_reg", "kOperandTypeARMSoRegReg");                   // R, R, I
 684   MISC("shift_so_reg_imm", "kOperandTypeARMSoRegImm");                   // R, R, I
 685   MISC("t2_so_reg", "kOperandTypeThumb2SoReg");                   // R, I
 686   MISC("so_imm", "kOperandTypeARMSoImm");                         // I
 687   MISC("rot_imm", "kOperandTypeARMRotImm");                       // I
 688   MISC("t2_so_imm", "kOperandTypeThumb2SoImm");                   // I
 689   MISC("so_imm2part", "kOperandTypeARMSoImm2Part");               // I
 690   MISC("pred", "kOperandTypeARMPredicate");                       // I, R
 691   MISC("it_pred", "kOperandTypeARMPredicate");                    // I
 692   MISC("addrmode_imm12", "kOperandTypeAddrModeImm12");            // R, I
 693   MISC("ldst_so_reg", "kOperandTypeLdStSOReg");                   // R, R, I
 694   MISC("postidx_reg", "kOperandTypeARMAddrMode3Offset");          // R, I
 695   MISC("addrmode2", "kOperandTypeARMAddrMode2");                  // R, R, I
 696   MISC("am2offset_reg", "kOperandTypeARMAddrMode2Offset");        // R, I
 697   MISC("am2offset_imm", "kOperandTypeARMAddrMode2Offset");        // R, I
 698   MISC("addrmode3", "kOperandTypeARMAddrMode3");                  // R, R, I
 699   MISC("am3offset", "kOperandTypeARMAddrMode3Offset");            // R, I
 700   MISC("ldstm_mode", "kOperandTypeARMLdStmMode");                 // I
 701   MISC("addrmode5", "kOperandTypeARMAddrMode5");                  // R, I
 702   MISC("addrmode6", "kOperandTypeARMAddrMode6");                  // R, R, I, I
 703   MISC("am6offset", "kOperandTypeARMAddrMode6Offset");            // R, I, I
 704   MISC("addrmode6dup", "kOperandTypeARMAddrMode6");               // R, R, I, I
 705   MISC("addrmode6oneL32", "kOperandTypeARMAddrMode6");            // R, R, I, I
 706   MISC("addrmodepc", "kOperandTypeARMAddrModePC");                // R, I
 707   MISC("addr_offset_none", "kOperandTypeARMAddrMode7");           // R
 708   MISC("reglist", "kOperandTypeARMRegisterList");                 // I, R, ...
 709   MISC("dpr_reglist", "kOperandTypeARMDPRRegisterList");          // I, R, ...
 710   MISC("spr_reglist", "kOperandTypeARMSPRRegisterList");          // I, R, ...
 711   MISC("it_mask", "kOperandTypeThumbITMask");                     // I
 712   MISC("t2addrmode_reg", "kOperandTypeThumb2AddrModeReg");        // R
 713   MISC("t2addrmode_posimm8", "kOperandTypeThumb2AddrModeImm8");   // R, I
 714   MISC("t2addrmode_negimm8", "kOperandTypeThumb2AddrModeImm8");   // R, I
 715   MISC("t2addrmode_imm8", "kOperandTypeThumb2AddrModeImm8");      // R, I
 716   MISC("t2am_imm8_offset", "kOperandTypeThumb2AddrModeImm8Offset");//I
 717   MISC("t2addrmode_imm12", "kOperandTypeThumb2AddrModeImm12");    // R, I
 718   MISC("t2addrmode_so_reg", "kOperandTypeThumb2AddrModeSoReg");   // R, R, I
 719   MISC("t2addrmode_imm8s4", "kOperandTypeThumb2AddrModeImm8s4");  // R, I
 720   MISC("t2addrmode_imm0_1020s4", "kOperandTypeThumb2AddrModeImm8s4");  // R, I
 721   MISC("t2am_imm8s4_offset", "kOperandTypeThumb2AddrModeImm8s4Offset");
 722                                                                   // R, I
 723   MISC("tb_addrmode", "kOperandTypeARMTBAddrMode");               // I
 724   MISC("t_addrmode_rrs1", "kOperandTypeThumbAddrModeRegS1");      // R, R
 725   MISC("t_addrmode_rrs2", "kOperandTypeThumbAddrModeRegS2");      // R, R
 726   MISC("t_addrmode_rrs4", "kOperandTypeThumbAddrModeRegS4");      // R, R
 727   MISC("t_addrmode_is1", "kOperandTypeThumbAddrModeImmS1");       // R, I
 728   MISC("t_addrmode_is2", "kOperandTypeThumbAddrModeImmS2");       // R, I
 729   MISC("t_addrmode_is4", "kOperandTypeThumbAddrModeImmS4");       // R, I
 730   MISC("t_addrmode_rr", "kOperandTypeThumbAddrModeRR");           // R, R
 731   MISC("t_addrmode_sp", "kOperandTypeThumbAddrModeSP");           // R, I
 732   MISC("t_addrmode_pc", "kOperandTypeThumbAddrModePC");           // R, I
 733   MISC("addrmode_tbb", "kOperandTypeThumbAddrModeRR");            // R, R
 734   MISC("addrmode_tbh", "kOperandTypeThumbAddrModeRR");            // R, R
 735
 736   return 1;
 737 }
 738
 739 #undef REG
 740 #undef MEM
 741 #undef MISC
 742
 743 #undef SET
 744
 745 /// ARMPopulateOperands - Handles all the operands in an ARM instruction, adding
 746 ///   the appropriate flags to their descriptors
 747 ///
 748 /// @operandFlags - A reference the array of operand flag objects
 749 /// @inst         - The instruction to use as a source of information
 750 static void ARMPopulateOperands(
 751   LiteralConstantEmitter *(&operandTypes)[EDIS_MAX_OPERANDS],
 752   const CodeGenInstruction &inst) {
 753   if (!inst.TheDef->isSubClassOf("InstARM") &&
 754       !inst.TheDef->isSubClassOf("InstThumb"))
 755     return;
 756
 757   unsigned int index;
 758   unsigned int numOperands = inst.Operands.size();
 759
 760   if (numOperands > EDIS_MAX_OPERANDS) {
 761     errs() << "numOperands == " << numOperands << " > " <<
 762       EDIS_MAX_OPERANDS << '\n';
 763     llvm_unreachable("Too many operands");
 764   }
 765
 766   for (index = 0; index < numOperands; ++index) {
 767     const CGIOperandList::OperandInfo &operandInfo = inst.Operands[index];
 768     Record &rec = *operandInfo.Rec;
 769
 770     if (ARMFlagFromOpName(operandTypes[index], rec.getName())) {
 771       errs() << "Operand type: " << rec.getName() << '\n';
 772       errs() << "Operand name: " << operandInfo.Name << '\n';
 773       errs() << "Instruction name: " << inst.TheDef->getName() << '\n';
 774       throw("Unhandled type in EDEmitter");
 775     }
 776   }
 777 }
 778
 779 #define BRANCH(target) {                    \
 780   instType.set("kInstructionTypeBranch");   \
 781   DECORATE1(target, "kOperandFlagTarget");  \
 782 }
 783
 784 /// ARMExtractSemantics - Performs various checks on the name of an ARM
 785 ///   instruction to determine what sort of an instruction it is and then adds
 786 ///   the appropriate flags to the instruction and its operands
 787 ///
 788 /// @arg instType     - A reference to the type for the instruction as a whole
 789 /// @arg operandTypes - A reference to the array of operand type object pointers
 790 /// @arg operandFlags - A reference to the array of operand flag object pointers
 791 /// @arg inst         - A reference to the original instruction
 792 static void ARMExtractSemantics(
 793   LiteralConstantEmitter &instType,
 794   LiteralConstantEmitter *(&operandTypes)[EDIS_MAX_OPERANDS],
 795   FlagsConstantEmitter *(&operandFlags)[EDIS_MAX_OPERANDS],
 796   const CodeGenInstruction &inst) {
 797   const std::string &name = inst.TheDef->getName();
 798
 799   if (name == "tBcc"   ||
 800       name == "tB"     ||
 801       name == "t2Bcc"  ||
 802       name == "Bcc"    ||
 803       name == "tCBZ"   ||
 804       name == "tCBNZ") {
 805     BRANCH("target");
 806   }
 807
 808   if (name == "tBLr9"      ||
 809       name == "BLr9_pred"  ||
 810       name == "tBLXi_r9"   ||
 811       name == "tBLXr_r9"   ||
 812       name == "BLXr9"      ||
 813       name == "t2BXJ"      ||
 814       name == "BXJ") {
 815     BRANCH("func");
 816
 817     unsigned opIndex;
 818     opIndex = inst.Operands.getOperandNamed("func");
 819     if (operandTypes[opIndex]->is("kOperandTypeImmediate"))
 820       operandTypes[opIndex]->set("kOperandTypeARMBranchTarget");
 821   }
 822 }
 823
 824 #undef BRANCH
 825
 826 /// populateInstInfo - Fills an array of InstInfos with information about each
 827 ///   instruction in a target
 828 ///
 829 /// @arg infoArray  - The array of InstInfo objects to populate
 830 /// @arg target     - The CodeGenTarget to use as a source of instructions
 831 static void populateInstInfo(CompoundConstantEmitter &infoArray,
 832                              CodeGenTarget &target) {
 833   const std::vector<const CodeGenInstruction*> &numberedInstructions =
 834     target.getInstructionsByEnumValue();
 835
 836   unsigned int index;
 837   unsigned int numInstructions = numberedInstructions.size();
 838
 839   for (index = 0; index < numInstructions; ++index) {
 840     const CodeGenInstruction& inst = *numberedInstructions[index];
 841
 842     CompoundConstantEmitter *infoStruct = new CompoundConstantEmitter;
 843     infoArray.addEntry(infoStruct);
 844
 845     LiteralConstantEmitter *instType = new LiteralConstantEmitter;
 846     infoStruct->addEntry(instType);
 847
 848     LiteralConstantEmitter *numOperandsEmitter =
 849       new LiteralConstantEmitter(inst.Operands.size());
 850     infoStruct->addEntry(numOperandsEmitter);
 851
 852     CompoundConstantEmitter *operandTypeArray = new CompoundConstantEmitter;
 853     infoStruct->addEntry(operandTypeArray);
 854
 855     LiteralConstantEmitter *operandTypes[EDIS_MAX_OPERANDS];
 856
 857     CompoundConstantEmitter *operandFlagArray = new CompoundConstantEmitter;
 858     infoStruct->addEntry(operandFlagArray);
 859
 860     FlagsConstantEmitter *operandFlags[EDIS_MAX_OPERANDS];
 861
 862     for (unsigned operandIndex = 0;
 863          operandIndex < EDIS_MAX_OPERANDS;
 864          ++operandIndex) {
 865       operandTypes[operandIndex] = new LiteralConstantEmitter;
 866       operandTypeArray->addEntry(operandTypes[operandIndex]);
 867
 868       operandFlags[operandIndex] = new FlagsConstantEmitter;
 869       operandFlagArray->addEntry(operandFlags[operandIndex]);
 870     }
 871
 872     unsigned numSyntaxes = 0;
 873
 874     // We don't need to do anything for pseudo-instructions, as we'll never
 875     // see them here. We'll only see real instructions.
 876     // We still need to emit null initializers for everything.
 877     if (!inst.isPseudo) {
 878       if (target.getName() == "X86") {
 879         X86PopulateOperands(operandTypes, inst);
 880         X86ExtractSemantics(*instType, operandFlags, inst);
 881         numSyntaxes = 2;
 882       }
 883       else if (target.getName() == "ARM") {
 884         ARMPopulateOperands(operandTypes, inst);
 885         ARMExtractSemantics(*instType, operandTypes, operandFlags, inst);
 886         numSyntaxes = 1;
 887       }
 888     }
 889
 890     CompoundConstantEmitter *operandOrderArray = new CompoundConstantEmitter;
 891
 892     infoStruct->addEntry(operandOrderArray);
 893
 894     for (unsigned syntaxIndex = 0;
 895          syntaxIndex < EDIS_MAX_SYNTAXES;
 896          ++syntaxIndex) {
 897       CompoundConstantEmitter *operandOrder =
 898         new CompoundConstantEmitter(EDIS_MAX_OPERANDS);
 899
 900       operandOrderArray->addEntry(operandOrder);
 901
 902       if (syntaxIndex < numSyntaxes) {
 903         populateOperandOrder(operandOrder, inst, syntaxIndex);
 904       }
 905     }
 906
 907     infoStruct = NULL;
 908   }
 909 }
 910
 911 static void emitCommonEnums(raw_ostream &o, unsigned int &i) {
 912   EnumEmitter operandTypes("OperandTypes");
 913   operandTypes.addEntry("kOperandTypeNone");
 914   operandTypes.addEntry("kOperandTypeImmediate");
 915   operandTypes.addEntry("kOperandTypeRegister");
 916   operandTypes.addEntry("kOperandTypeX86Memory");
 917   operandTypes.addEntry("kOperandTypeX86EffectiveAddress");
 918   operandTypes.addEntry("kOperandTypeX86PCRelative");
 919   operandTypes.addEntry("kOperandTypeARMBranchTarget");
 920   operandTypes.addEntry("kOperandTypeARMSoRegReg");
 921   operandTypes.addEntry("kOperandTypeARMSoRegImm");
 922   operandTypes.addEntry("kOperandTypeARMSoImm");
 923   operandTypes.addEntry("kOperandTypeARMRotImm");
 924   operandTypes.addEntry("kOperandTypeARMSoImm2Part");
 925   operandTypes.addEntry("kOperandTypeARMPredicate");
 926   operandTypes.addEntry("kOperandTypeAddrModeImm12");
 927   operandTypes.addEntry("kOperandTypeLdStSOReg");
 928   operandTypes.addEntry("kOperandTypeARMAddrMode2");
 929   operandTypes.addEntry("kOperandTypeARMAddrMode2Offset");
 930   operandTypes.addEntry("kOperandTypeARMAddrMode3");
 931   operandTypes.addEntry("kOperandTypeARMAddrMode3Offset");
 932   operandTypes.addEntry("kOperandTypeARMLdStmMode");
 933   operandTypes.addEntry("kOperandTypeARMAddrMode5");
 934   operandTypes.addEntry("kOperandTypeARMAddrMode6");
 935   operandTypes.addEntry("kOperandTypeARMAddrMode6Offset");
 936   operandTypes.addEntry("kOperandTypeARMAddrMode7");
 937   operandTypes.addEntry("kOperandTypeARMAddrModePC");
 938   operandTypes.addEntry("kOperandTypeARMRegisterList");
 939   operandTypes.addEntry("kOperandTypeARMDPRRegisterList");
 940   operandTypes.addEntry("kOperandTypeARMSPRRegisterList");
 941   operandTypes.addEntry("kOperandTypeARMTBAddrMode");
 942   operandTypes.addEntry("kOperandTypeThumbITMask");
 943   operandTypes.addEntry("kOperandTypeThumbAddrModeImmS1");
 944   operandTypes.addEntry("kOperandTypeThumbAddrModeImmS2");
 945   operandTypes.addEntry("kOperandTypeThumbAddrModeImmS4");
 946   operandTypes.addEntry("kOperandTypeThumbAddrModeRegS1");
 947   operandTypes.addEntry("kOperandTypeThumbAddrModeRegS2");
 948   operandTypes.addEntry("kOperandTypeThumbAddrModeRegS4");
 949   operandTypes.addEntry("kOperandTypeThumbAddrModeRR");
 950   operandTypes.addEntry("kOperandTypeThumbAddrModeSP");
 951   operandTypes.addEntry("kOperandTypeThumbAddrModePC");
 952   operandTypes.addEntry("kOperandTypeThumb2AddrModeReg");
 953   operandTypes.addEntry("kOperandTypeThumb2SoReg");
 954   operandTypes.addEntry("kOperandTypeThumb2SoImm");
 955   operandTypes.addEntry("kOperandTypeThumb2AddrModeImm8");
 956   operandTypes.addEntry("kOperandTypeThumb2AddrModeImm8Offset");
 957   operandTypes.addEntry("kOperandTypeThumb2AddrModeImm12");
 958   operandTypes.addEntry("kOperandTypeThumb2AddrModeSoReg");
 959   operandTypes.addEntry("kOperandTypeThumb2AddrModeImm8s4");
 960   operandTypes.addEntry("kOperandTypeThumb2AddrModeImm8s4Offset");
 961   operandTypes.emit(o, i);
 962
 963   o << "\n";
 964
 965   EnumEmitter operandFlags("OperandFlags");
 966   operandFlags.addEntry("kOperandFlagSource");
 967   operandFlags.addEntry("kOperandFlagTarget");
 968   operandFlags.emitAsFlags(o, i);
 969
 970   o << "\n";
 971
 972   EnumEmitter instructionTypes("InstructionTypes");
 973   instructionTypes.addEntry("kInstructionTypeNone");
 974   instructionTypes.addEntry("kInstructionTypeMove");
 975   instructionTypes.addEntry("kInstructionTypeBranch");
 976   instructionTypes.addEntry("kInstructionTypePush");
 977   instructionTypes.addEntry("kInstructionTypePop");
 978   instructionTypes.addEntry("kInstructionTypeCall");
 979   instructionTypes.addEntry("kInstructionTypeReturn");
 980   instructionTypes.emit(o, i);
 981
 982   o << "\n";
 983 }
 984
 985 namespace llvm {
 986
 987 void EmitEnhancedDisassemblerInfo(RecordKeeper &RK, raw_ostream &OS) {
 988   emitSourceFileHeader("Enhanced Disassembler Info", OS);
 989   unsigned int i = 0;
 990
 991   CompoundConstantEmitter infoArray;
 992   CodeGenTarget target(RK);
 993
 994   populateInstInfo(infoArray, target);
 995
 996   emitCommonEnums(OS, i);
 997
 998   OS << "static const llvm::EDInstInfo instInfo"
 999      << target.getName() << "[] = ";
1000   infoArray.emit(OS, i);
1001   OS << ";" << "\n";
1002 }
1003
1004 } // End llvm namespace