1 //===- EDEmitter.cpp - Generate instruction descriptions for ED -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
14 //===----------------------------------------------------------------------===//
16 #include "EDEmitter.h"
18 #include "AsmWriterInst.h"
19 #include "CodeGenTarget.h"
22 #include "llvm/Support/ErrorHandling.h"
23 #include "llvm/Support/Format.h"
24 #include "llvm/Support/raw_ostream.h"
29 #define MAX_OPERANDS 5
30 #define MAX_SYNTAXES 2
34 ///////////////////////////////////////////////////////////
35 // Support classes for emitting nested C data structures //
36 ///////////////////////////////////////////////////////////
43 std::vector<std::string> Entries;
45 EnumEmitter(const char *N) : Name(N) {
47 int addEntry(const char *e) {
48 Entries.push_back(std::string(e));
49 return Entries.size() - 1;
51 void emit(raw_ostream &o, unsigned int &i) {
52 o.indent(i) << "enum " << Name.c_str() << " {" << "\n";
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))
65 o.indent(i) << "};" << "\n";
68 void emitAsFlags(raw_ostream &o, unsigned int &i) {
69 o.indent(i) << "enum " << Name.c_str() << " {" << "\n";
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))
84 o.indent(i) << "};" << "\n";
91 std::vector<std::string> MemberTypes;
92 std::vector<std::string> MemberNames;
94 StructEmitter(const char *N) : Name(N) {
96 void addMember(const char *t, const char *n) {
97 MemberTypes.push_back(std::string(t));
98 MemberNames.push_back(std::string(n));
100 void emit(raw_ostream &o, unsigned int &i) {
101 o.indent(i) << "struct " << Name.c_str() << " {" << "\n";
104 unsigned int index = 0;
105 unsigned int numMembers = MemberTypes.size();
106 for (index = 0; index < numMembers; ++index) {
107 o.indent(i) << MemberTypes[index] << " " << MemberNames[index] << ";";
112 o.indent(i) << "};" << "\n";
116 class ConstantEmitter {
118 virtual ~ConstantEmitter() { }
119 virtual void emit(raw_ostream &o, unsigned int &i) = 0;
122 class LiteralConstantEmitter : public ConstantEmitter {
126 LiteralConstantEmitter(const char *literal) : Literal(literal) {
128 LiteralConstantEmitter(int literal) {
130 snprintf(buf, 256, "%d", literal);
133 void emit(raw_ostream &o, unsigned int &i) {
138 class CompoundConstantEmitter : public ConstantEmitter {
140 std::vector<ConstantEmitter*> Entries;
142 CompoundConstantEmitter() {
144 ~CompoundConstantEmitter() {
146 unsigned int numEntries = Entries.size();
147 for (index = 0; index < numEntries; ++index) {
148 delete Entries[index];
151 CompoundConstantEmitter &addEntry(ConstantEmitter *e) {
152 Entries.push_back(e);
155 void emit(raw_ostream &o, unsigned int &i) {
160 unsigned int numEntries = Entries.size();
161 for (index = 0; index < numEntries; ++index) {
163 Entries[index]->emit(o, i);
164 if (index < (numEntries - 1))
174 class FlagsConstantEmitter : public ConstantEmitter {
176 std::vector<std::string> Flags;
178 FlagsConstantEmitter() {
180 FlagsConstantEmitter &addEntry(const char *f) {
181 Flags.push_back(std::string(f));
184 void emit(raw_ostream &o, unsigned int &i) {
186 unsigned int numFlags = Flags.size();
190 for (index = 0; index < numFlags; ++index) {
191 o << Flags[index].c_str();
192 if (index < (numFlags - 1))
199 EDEmitter::EDEmitter(RecordKeeper &R) : Records(R) {
202 /// populateOperandOrder - Accepts a CodeGenInstruction and generates its
203 /// AsmWriterInst for the desired assembly syntax, giving an ordered list of
204 /// operands in the order they appear in the printed instruction. Then, for
205 /// each entry in that list, determines the index of the same operand in the
206 /// CodeGenInstruction, and emits the resulting mapping into an array, filling
207 /// in unused slots with -1.
209 /// @arg operandOrder - The array that will be populated with the operand
210 /// mapping. Each entry will contain -1 (invalid index
211 /// into the operands present in the AsmString) or a number
212 /// representing an index in the operand descriptor array.
213 /// @arg inst - The instruction to use when looking up the operands
214 /// @arg syntax - The syntax to use, according to LLVM's enumeration
215 void populateOperandOrder(CompoundConstantEmitter *operandOrder,
216 const CodeGenInstruction &inst,
218 unsigned int numArgs = 0;
220 AsmWriterInst awInst(inst, syntax, -1, -1);
222 std::vector<AsmWriterOperand>::iterator operandIterator;
224 for (operandIterator = awInst.Operands.begin();
225 operandIterator != awInst.Operands.end();
227 if (operandIterator->OperandType ==
228 AsmWriterOperand::isMachineInstrOperand) {
230 snprintf(buf, sizeof(buf), "%u", operandIterator->CGIOpNo);
231 operandOrder->addEntry(new LiteralConstantEmitter(buf));
236 for(; numArgs < MAX_OPERANDS; numArgs++) {
237 operandOrder->addEntry(new LiteralConstantEmitter("-1"));
241 /////////////////////////////////////////////////////
242 // Support functions for handling X86 instructions //
243 /////////////////////////////////////////////////////
245 #define ADDFLAG(flag) flags->addEntry(flag)
247 #define REG(str) if (name == str) { ADDFLAG("kOperandFlagRegister"); return 0; }
248 #define MEM(str) if (name == str) { ADDFLAG("kOperandFlagMemory"); return 0; }
249 #define LEA(str) if (name == str) { ADDFLAG("kOperandFlagEffectiveAddress"); \
251 #define IMM(str) if (name == str) { ADDFLAG("kOperandFlagImmediate"); \
253 #define PCR(str) if (name == str) { ADDFLAG("kOperandFlagMemory"); \
254 ADDFLAG("kOperandFlagPCRelative"); \
257 /// X86FlagFromOpName - Processes the name of a single X86 operand (which is
258 /// actually its type) and translates it into an operand flag
260 /// @arg flags - The flags object to add the flag to
261 /// @arg name - The name of the operand
262 static int X86FlagFromOpName(FlagsConstantEmitter *flags,
263 const std::string &name) {
280 REG("CONTROL_REG_32");
281 REG("CONTROL_REG_64");
313 IMM("i64i32imm_pcrel");
333 /// X86PopulateOperands - Handles all the operands in an X86 instruction, adding
334 /// the appropriate flags to their descriptors
336 /// @operandFlags - A reference the array of operand flag objects
337 /// @inst - The instruction to use as a source of information
338 static void X86PopulateOperands(
339 FlagsConstantEmitter *(&operandFlags)[MAX_OPERANDS],
340 const CodeGenInstruction &inst) {
341 if (!inst.TheDef->isSubClassOf("X86Inst"))
345 unsigned int numOperands = inst.OperandList.size();
347 for (index = 0; index < numOperands; ++index) {
348 const CodeGenInstruction::OperandInfo &operandInfo =
349 inst.OperandList[index];
350 Record &rec = *operandInfo.Rec;
352 if (X86FlagFromOpName(operandFlags[index], rec.getName())) {
353 errs() << "Operand type: " << rec.getName().c_str() << "\n";
354 errs() << "Operand name: " << operandInfo.Name.c_str() << "\n";
355 errs() << "Instruction mame: " << inst.TheDef->getName().c_str() << "\n";
356 llvm_unreachable("Unhandled type");
361 /// decorate1 - Decorates a named operand with a new flag
363 /// @operandFlags - The array of operand flag objects, which don't have names
364 /// @inst - The CodeGenInstruction, which provides a way to translate
365 /// between names and operand indices
366 /// @opName - The name of the operand
367 /// @flag - The name of the flag to add
368 static inline void decorate1(FlagsConstantEmitter *(&operandFlags)[MAX_OPERANDS],
369 const CodeGenInstruction &inst,
371 const char *opFlag) {
375 opIndex = inst.getOperandNamed(std::string(opName));
378 errs() << "Instruction: " << inst.TheDef->getName().c_str() << "\n";
379 errs() << "Operand name: " << opName << "\n";
380 llvm_unreachable("Couldn't find operand");
383 operandFlags[opIndex]->addEntry(opFlag);
386 #define DECORATE1(opName, opFlag) decorate1(operandFlags, inst, opName, opFlag)
388 #define MOV(source, target) { \
389 instFlags.addEntry("kInstructionFlagMove"); \
390 DECORATE1(source, "kOperandFlagSource"); \
391 DECORATE1(target, "kOperandFlagTarget"); \
394 #define BRANCH(target) { \
395 instFlags.addEntry("kInstructionFlagBranch"); \
396 DECORATE1(target, "kOperandFlagTarget"); \
399 #define PUSH(source) { \
400 instFlags.addEntry("kInstructionFlagPush"); \
401 DECORATE1(source, "kOperandFlagSource"); \
404 #define POP(target) { \
405 instFlags.addEntry("kInstructionFlagPop"); \
406 DECORATE1(target, "kOperandFlagTarget"); \
409 #define CALL(target) { \
410 instFlags.addEntry("kInstructionFlagCall"); \
411 DECORATE1(target, "kOperandFlagTarget"); \
415 instFlags.addEntry("kInstructionFlagReturn"); \
418 /// X86ExtractSemantics - Performs various checks on the name of an X86
419 /// instruction to determine what sort of an instruction it is and then adds
420 /// the appropriate flags to the instruction and its operands
422 /// @arg instFlags - A reference to the flags for the instruction as a whole
423 /// @arg operandFlags - A reference to the array of operand flag object pointers
424 /// @arg inst - A reference to the original instruction
425 static void X86ExtractSemantics(FlagsConstantEmitter &instFlags,
426 FlagsConstantEmitter *(&operandFlags)[MAX_OPERANDS],
427 const CodeGenInstruction &inst) {
428 const std::string &name = inst.TheDef->getName();
430 if (name.find("MOV") != name.npos) {
431 if (name.find("MOV_V") != name.npos) {
432 // ignore (this is a pseudoinstruction)
434 else if (name.find("MASK") != name.npos) {
435 // ignore (this is a masking move)
437 else if (name.find("r0") != name.npos) {
438 // ignore (this is a pseudoinstruction)
440 else if (name.find("PS") != name.npos ||
441 name.find("PD") != name.npos) {
442 // ignore (this is a shuffling move)
444 else if (name.find("MOVS") != name.npos) {
445 // ignore (this is a string move)
447 else if (name.find("_F") != name.npos) {
448 // TODO handle _F moves to ST(0)
450 else if (name.find("a") != name.npos) {
451 // TODO handle moves to/from %ax
453 else if (name.find("CMOV") != name.npos) {
456 else if (name.find("PC") != name.npos) {
464 if (name.find("JMP") != name.npos ||
465 name.find("J") == 0) {
466 if (name.find("FAR") != name.npos && name.find("i") != name.npos) {
474 if (name.find("PUSH") != name.npos) {
475 if (name.find("FS") != name.npos ||
476 name.find("GS") != name.npos) {
477 instFlags.addEntry("kInstructionFlagPush");
478 // TODO add support for fixed operands
480 else if (name.find("F") != name.npos) {
481 // ignore (this pushes onto the FP stack)
483 else if (name[name.length() - 1] == 'm') {
486 else if (name.find("i") != name.npos) {
494 if (name.find("POP") != name.npos) {
495 if (name.find("POPCNT") != name.npos) {
496 // ignore (not a real pop)
498 else if (name.find("FS") != name.npos ||
499 name.find("GS") != name.npos) {
500 instFlags.addEntry("kInstructionFlagPop");
501 // TODO add support for fixed operands
503 else if (name.find("F") != name.npos) {
504 // ignore (this pops from the FP stack)
506 else if (name[name.length() - 1] == 'm') {
514 if (name.find("CALL") != name.npos) {
515 if (name.find("ADJ") != name.npos) {
516 // ignore (not a call)
518 else if (name.find("SYSCALL") != name.npos) {
519 // ignore (doesn't go anywhere we know about)
521 else if (name.find("VMCALL") != name.npos) {
522 // ignore (rather different semantics than a regular call)
524 else if (name.find("FAR") != name.npos && name.find("i") != name.npos) {
532 if (name.find("RET") != name.npos) {
544 #undef COND_DECORATE_2
545 #undef COND_DECORATE_1
548 /// populateInstInfo - Fills an array of InstInfos with information about each
549 /// instruction in a target
551 /// @arg infoArray - The array of InstInfo objects to populate
552 /// @arg target - The CodeGenTarget to use as a source of instructions
553 static void populateInstInfo(CompoundConstantEmitter &infoArray,
554 CodeGenTarget &target) {
555 std::vector<const CodeGenInstruction*> numberedInstructions;
556 target.getInstructionsByEnumValue(numberedInstructions);
559 unsigned int numInstructions = numberedInstructions.size();
561 for (index = 0; index < numInstructions; ++index) {
562 const CodeGenInstruction& inst = *numberedInstructions[index];
564 CompoundConstantEmitter *infoStruct = new CompoundConstantEmitter;
565 infoArray.addEntry(infoStruct);
567 FlagsConstantEmitter *instFlags = new FlagsConstantEmitter;
568 infoStruct->addEntry(instFlags);
570 LiteralConstantEmitter *numOperandsEmitter =
571 new LiteralConstantEmitter(inst.OperandList.size());
572 infoStruct->addEntry(numOperandsEmitter);
574 CompoundConstantEmitter *operandFlagArray = new CompoundConstantEmitter;
575 infoStruct->addEntry(operandFlagArray);
577 FlagsConstantEmitter *operandFlags[MAX_OPERANDS];
579 for (unsigned operandIndex = 0; operandIndex < MAX_OPERANDS; ++operandIndex) {
580 operandFlags[operandIndex] = new FlagsConstantEmitter;
581 operandFlagArray->addEntry(operandFlags[operandIndex]);
584 unsigned numSyntaxes = 0;
586 if (target.getName() == "X86") {
587 X86PopulateOperands(operandFlags, inst);
588 X86ExtractSemantics(*instFlags, operandFlags, inst);
592 CompoundConstantEmitter *operandOrderArray = new CompoundConstantEmitter;
593 infoStruct->addEntry(operandOrderArray);
595 for (unsigned syntaxIndex = 0; syntaxIndex < MAX_SYNTAXES; ++syntaxIndex) {
596 CompoundConstantEmitter *operandOrder = new CompoundConstantEmitter;
597 operandOrderArray->addEntry(operandOrder);
599 if (syntaxIndex < numSyntaxes) {
600 populateOperandOrder(operandOrder, inst, syntaxIndex);
603 for (unsigned operandIndex = 0;
604 operandIndex < MAX_OPERANDS;
606 operandOrder->addEntry(new LiteralConstantEmitter("-1"));
613 void EDEmitter::run(raw_ostream &o) {
616 CompoundConstantEmitter infoArray;
617 CodeGenTarget target;
619 populateInstInfo(infoArray, target);
621 o << "InstInfo instInfo" << target.getName().c_str() << "[] = ";
622 infoArray.emit(o, i);
626 void EDEmitter::runHeader(raw_ostream &o) {
627 EmitSourceFileHeader("Enhanced Disassembly Info Header", o);
629 o << "#ifndef EDInfo_" << "\n";
630 o << "#define EDInfo_" << "\n";
632 o << "#include <inttypes.h>" << "\n";
634 o << "#define MAX_OPERANDS " << format("%d", MAX_OPERANDS) << "\n";
635 o << "#define MAX_SYNTAXES " << format("%d", MAX_SYNTAXES) << "\n";
640 EnumEmitter operandFlags("OperandFlags");
641 operandFlags.addEntry("kOperandFlagImmediate");
642 operandFlags.addEntry("kOperandFlagRegister");
643 operandFlags.addEntry("kOperandFlagMemory");
644 operandFlags.addEntry("kOperandFlagEffectiveAddress");
645 operandFlags.addEntry("kOperandFlagPCRelative");
646 operandFlags.addEntry("kOperandFlagSource");
647 operandFlags.addEntry("kOperandFlagTarget");
648 operandFlags.emitAsFlags(o, i);
652 EnumEmitter instructionFlags("InstructionFlags");
653 instructionFlags.addEntry("kInstructionFlagMove");
654 instructionFlags.addEntry("kInstructionFlagBranch");
655 instructionFlags.addEntry("kInstructionFlagPush");
656 instructionFlags.addEntry("kInstructionFlagPop");
657 instructionFlags.addEntry("kInstructionFlagCall");
658 instructionFlags.addEntry("kInstructionFlagReturn");
659 instructionFlags.emitAsFlags(o, i);
663 StructEmitter instInfo("InstInfo");
664 instInfo.addMember("uint32_t", "instructionFlags");
665 instInfo.addMember("uint8_t", "numOperands");
666 instInfo.addMember("uint8_t", "operandFlags[MAX_OPERANDS]");
667 instInfo.addMember("const char", "operandOrders[MAX_SYNTAXES][MAX_OPERANDS]");
671 o << "#endif" << "\n";