blob: 525fffb0ee2cdabea343ccfeeb7956bdfc2978fc [file] [log] [blame]
Sean Callanan95fcebd2010-01-29 00:21:04 +00001//===- 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 "EDEmitter.h"
17
Sean Callanand0bc7f02010-02-09 23:06:35 +000018#include "AsmWriterInst.h"
Sean Callanan95fcebd2010-01-29 00:21:04 +000019#include "CodeGenTarget.h"
20#include "Record.h"
21
Sean Callanan9899f702010-04-13 21:21:57 +000022#include "llvm/MC/EDInstInfo.h"
Sean Callanan95fcebd2010-01-29 00:21:04 +000023#include "llvm/Support/ErrorHandling.h"
24#include "llvm/Support/Format.h"
25#include "llvm/Support/raw_ostream.h"
26
Sean Callanan8f993b82010-04-08 00:48:21 +000027#include <map>
Sean Callanan95fcebd2010-01-29 00:21:04 +000028#include <string>
Sean Callanan8f993b82010-04-08 00:48:21 +000029#include <vector>
Sean Callanan95fcebd2010-01-29 00:21:04 +000030
Sean Callanan95fcebd2010-01-29 00:21:04 +000031using namespace llvm;
32
33///////////////////////////////////////////////////////////
34// Support classes for emitting nested C data structures //
35///////////////////////////////////////////////////////////
36
37namespace {
38
39 class EnumEmitter {
40 private:
41 std::string Name;
42 std::vector<std::string> Entries;
43 public:
44 EnumEmitter(const char *N) : Name(N) {
45 }
46 int addEntry(const char *e) {
47 Entries.push_back(std::string(e));
48 return Entries.size() - 1;
49 }
50 void emit(raw_ostream &o, unsigned int &i) {
51 o.indent(i) << "enum " << Name.c_str() << " {" << "\n";
52 i += 2;
53
54 unsigned int index = 0;
55 unsigned int numEntries = Entries.size();
Sean Callanan8f993b82010-04-08 00:48:21 +000056 for (index = 0; index < numEntries; ++index) {
Sean Callanan95fcebd2010-01-29 00:21:04 +000057 o.indent(i) << Entries[index];
Sean Callanan8f993b82010-04-08 00:48:21 +000058 if (index < (numEntries - 1))
Sean Callanan95fcebd2010-01-29 00:21:04 +000059 o << ",";
60 o << "\n";
61 }
62
63 i -= 2;
64 o.indent(i) << "};" << "\n";
65 }
66
67 void emitAsFlags(raw_ostream &o, unsigned int &i) {
68 o.indent(i) << "enum " << Name.c_str() << " {" << "\n";
69 i += 2;
70
71 unsigned int index = 0;
72 unsigned int numEntries = Entries.size();
73 unsigned int flag = 1;
74 for (index = 0; index < numEntries; ++index) {
75 o.indent(i) << Entries[index] << " = " << format("0x%x", flag);
76 if (index < (numEntries - 1))
77 o << ",";
78 o << "\n";
79 flag <<= 1;
80 }
81
82 i -= 2;
83 o.indent(i) << "};" << "\n";
84 }
85 };
86
Sean Callanan95fcebd2010-01-29 00:21:04 +000087 class ConstantEmitter {
88 public:
89 virtual ~ConstantEmitter() { }
90 virtual void emit(raw_ostream &o, unsigned int &i) = 0;
91 };
92
93 class LiteralConstantEmitter : public ConstantEmitter {
94 private:
Sean Callanan8f993b82010-04-08 00:48:21 +000095 bool IsNumber;
96 union {
97 int Number;
98 const char* String;
99 };
Sean Callanan95fcebd2010-01-29 00:21:04 +0000100 public:
Sean Callanan8f993b82010-04-08 00:48:21 +0000101 LiteralConstantEmitter(int number = 0) :
102 IsNumber(true),
103 Number(number) {
104 }
105 void set(const char *string) {
106 IsNumber = false;
107 Number = 0;
108 String = string;
109 }
Sean Callanan8f993b82010-04-08 00:48:21 +0000110 bool is(const char *string) {
111 return !strcmp(String, string);
Sean Callanan95fcebd2010-01-29 00:21:04 +0000112 }
113 void emit(raw_ostream &o, unsigned int &i) {
Sean Callanan8f993b82010-04-08 00:48:21 +0000114 if (IsNumber)
115 o << Number;
116 else
117 o << String;
Sean Callanan95fcebd2010-01-29 00:21:04 +0000118 }
119 };
120
121 class CompoundConstantEmitter : public ConstantEmitter {
122 private:
Sean Callanan8f993b82010-04-08 00:48:21 +0000123 unsigned int Padding;
124 std::vector<ConstantEmitter *> Entries;
Sean Callanan95fcebd2010-01-29 00:21:04 +0000125 public:
Sean Callanan8f993b82010-04-08 00:48:21 +0000126 CompoundConstantEmitter(unsigned int padding = 0) : Padding(padding) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000127 }
128 CompoundConstantEmitter &addEntry(ConstantEmitter *e) {
129 Entries.push_back(e);
Sean Callanan8f993b82010-04-08 00:48:21 +0000130
Sean Callanan95fcebd2010-01-29 00:21:04 +0000131 return *this;
132 }
Sean Callanan8f993b82010-04-08 00:48:21 +0000133 ~CompoundConstantEmitter() {
134 while (Entries.size()) {
135 ConstantEmitter *entry = Entries.back();
136 Entries.pop_back();
137 delete entry;
138 }
139 }
Sean Callanan95fcebd2010-01-29 00:21:04 +0000140 void emit(raw_ostream &o, unsigned int &i) {
141 o << "{" << "\n";
142 i += 2;
143
144 unsigned int index;
145 unsigned int numEntries = Entries.size();
Sean Callanan8f993b82010-04-08 00:48:21 +0000146
147 unsigned int numToPrint;
148
149 if (Padding) {
150 if (numEntries > Padding) {
151 fprintf(stderr, "%u entries but %u padding\n", numEntries, Padding);
152 llvm_unreachable("More entries than padding");
153 }
154 numToPrint = Padding;
155 } else {
156 numToPrint = numEntries;
157 }
158
159 for (index = 0; index < numToPrint; ++index) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000160 o.indent(i);
Sean Callanan8f993b82010-04-08 00:48:21 +0000161 if (index < numEntries)
162 Entries[index]->emit(o, i);
163 else
164 o << "-1";
165
166 if (index < (numToPrint - 1))
Sean Callanan95fcebd2010-01-29 00:21:04 +0000167 o << ",";
168 o << "\n";
169 }
170
171 i -= 2;
172 o.indent(i) << "}";
173 }
174 };
175
176 class FlagsConstantEmitter : public ConstantEmitter {
177 private:
178 std::vector<std::string> Flags;
179 public:
180 FlagsConstantEmitter() {
181 }
182 FlagsConstantEmitter &addEntry(const char *f) {
183 Flags.push_back(std::string(f));
184 return *this;
185 }
186 void emit(raw_ostream &o, unsigned int &i) {
187 unsigned int index;
188 unsigned int numFlags = Flags.size();
189 if (numFlags == 0)
190 o << "0";
191
192 for (index = 0; index < numFlags; ++index) {
193 o << Flags[index].c_str();
194 if (index < (numFlags - 1))
195 o << " | ";
196 }
197 }
198 };
199}
200
201EDEmitter::EDEmitter(RecordKeeper &R) : Records(R) {
202}
203
Sean Callanan2db6ff22010-02-10 02:47:08 +0000204/// populateOperandOrder - Accepts a CodeGenInstruction and generates its
205/// AsmWriterInst for the desired assembly syntax, giving an ordered list of
206/// operands in the order they appear in the printed instruction. Then, for
207/// each entry in that list, determines the index of the same operand in the
208/// CodeGenInstruction, and emits the resulting mapping into an array, filling
209/// in unused slots with -1.
Sean Callanan95fcebd2010-01-29 00:21:04 +0000210///
211/// @arg operandOrder - The array that will be populated with the operand
212/// mapping. Each entry will contain -1 (invalid index
213/// into the operands present in the AsmString) or a number
214/// representing an index in the operand descriptor array.
Sean Callanan2db6ff22010-02-10 02:47:08 +0000215/// @arg inst - The instruction to use when looking up the operands
216/// @arg syntax - The syntax to use, according to LLVM's enumeration
Sean Callanan95fcebd2010-01-29 00:21:04 +0000217void populateOperandOrder(CompoundConstantEmitter *operandOrder,
Sean Callanan2db6ff22010-02-10 02:47:08 +0000218 const CodeGenInstruction &inst,
219 unsigned syntax) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000220 unsigned int numArgs = 0;
221
Sean Callanan2db6ff22010-02-10 02:47:08 +0000222 AsmWriterInst awInst(inst, syntax, -1, -1);
Sean Callanan95fcebd2010-01-29 00:21:04 +0000223
Sean Callanan2db6ff22010-02-10 02:47:08 +0000224 std::vector<AsmWriterOperand>::iterator operandIterator;
Sean Callanan95fcebd2010-01-29 00:21:04 +0000225
Sean Callanan2db6ff22010-02-10 02:47:08 +0000226 for (operandIterator = awInst.Operands.begin();
227 operandIterator != awInst.Operands.end();
228 ++operandIterator) {
229 if (operandIterator->OperandType ==
230 AsmWriterOperand::isMachineInstrOperand) {
Sean Callanan8f993b82010-04-08 00:48:21 +0000231 operandOrder->addEntry(
232 new LiteralConstantEmitter(operandIterator->CGIOpNo));
Sean Callanan2db6ff22010-02-10 02:47:08 +0000233 numArgs++;
Sean Callanan95fcebd2010-01-29 00:21:04 +0000234 }
235 }
Sean Callanan95fcebd2010-01-29 00:21:04 +0000236}
237
238/////////////////////////////////////////////////////
239// Support functions for handling X86 instructions //
240/////////////////////////////////////////////////////
241
Sean Callanan8f993b82010-04-08 00:48:21 +0000242#define SET(flag) { type->set(flag); return 0; }
Sean Callanan95fcebd2010-01-29 00:21:04 +0000243
Sean Callanan8f993b82010-04-08 00:48:21 +0000244#define REG(str) if (name == str) SET("kOperandTypeRegister");
245#define MEM(str) if (name == str) SET("kOperandTypeX86Memory");
246#define LEA(str) if (name == str) SET("kOperandTypeX86EffectiveAddress");
247#define IMM(str) if (name == str) SET("kOperandTypeImmediate");
248#define PCR(str) if (name == str) SET("kOperandTypeX86PCRelative");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000249
Sean Callanan8f993b82010-04-08 00:48:21 +0000250/// X86TypeFromOpName - Processes the name of a single X86 operand (which is
251/// actually its type) and translates it into an operand type
Sean Callanan95fcebd2010-01-29 00:21:04 +0000252///
Sean Callanan8f993b82010-04-08 00:48:21 +0000253/// @arg flags - The type object to set
Sean Callanan95fcebd2010-01-29 00:21:04 +0000254/// @arg name - The name of the operand
Sean Callanan8f993b82010-04-08 00:48:21 +0000255static int X86TypeFromOpName(LiteralConstantEmitter *type,
Sean Callanan95fcebd2010-01-29 00:21:04 +0000256 const std::string &name) {
257 REG("GR8");
258 REG("GR8_NOREX");
259 REG("GR16");
260 REG("GR32");
261 REG("GR32_NOREX");
Evan Cheng5e817162010-03-14 05:15:39 +0000262 REG("GR32_TC");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000263 REG("FR32");
264 REG("RFP32");
265 REG("GR64");
Evan Cheng5e817162010-03-14 05:15:39 +0000266 REG("GR64_TC");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000267 REG("FR64");
268 REG("VR64");
269 REG("RFP64");
270 REG("RFP80");
271 REG("VR128");
Bruno Cardoso Lopese86b01c2010-07-09 18:27:43 +0000272 REG("VR256");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000273 REG("RST");
274 REG("SEGMENT_REG");
275 REG("DEBUG_REG");
Sean Callanan1a8b7892010-05-06 20:59:00 +0000276 REG("CONTROL_REG");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000277
Sean Callanan8f993b82010-04-08 00:48:21 +0000278 IMM("i8imm");
279 IMM("i16imm");
280 IMM("i16i8imm");
281 IMM("i32imm");
Sean Callanan8f993b82010-04-08 00:48:21 +0000282 IMM("i32i8imm");
283 IMM("i64imm");
284 IMM("i64i8imm");
285 IMM("i64i32imm");
Sean Callanan8f993b82010-04-08 00:48:21 +0000286 IMM("SSECC");
287
288 // all R, I, R, I, R
Sean Callanan95fcebd2010-01-29 00:21:04 +0000289 MEM("i8mem");
290 MEM("i8mem_NOREX");
291 MEM("i16mem");
292 MEM("i32mem");
Evan Cheng5e817162010-03-14 05:15:39 +0000293 MEM("i32mem_TC");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000294 MEM("f32mem");
295 MEM("ssmem");
296 MEM("opaque32mem");
297 MEM("opaque48mem");
298 MEM("i64mem");
Evan Cheng5e817162010-03-14 05:15:39 +0000299 MEM("i64mem_TC");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000300 MEM("f64mem");
301 MEM("sdmem");
302 MEM("f80mem");
303 MEM("opaque80mem");
304 MEM("i128mem");
Bruno Cardoso Lopes94143ee2010-07-19 23:32:44 +0000305 MEM("i256mem");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000306 MEM("f128mem");
Bruno Cardoso Lopese86b01c2010-07-09 18:27:43 +0000307 MEM("f256mem");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000308 MEM("opaque512mem");
309
Sean Callanan8f993b82010-04-08 00:48:21 +0000310 // all R, I, R, I
Sean Callanan95fcebd2010-01-29 00:21:04 +0000311 LEA("lea32mem");
312 LEA("lea64_32mem");
313 LEA("lea64mem");
314
Sean Callanan8f993b82010-04-08 00:48:21 +0000315 // all I
Chris Lattner9fc05222010-07-07 22:27:31 +0000316 PCR("i16imm_pcrel");
Sean Callanana0f914b2010-04-23 22:17:17 +0000317 PCR("i32imm_pcrel");
318 PCR("i64i32imm_pcrel");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000319 PCR("brtarget8");
320 PCR("offset8");
321 PCR("offset16");
322 PCR("offset32");
323 PCR("offset64");
324 PCR("brtarget");
325
326 return 1;
327}
328
329#undef REG
330#undef MEM
331#undef LEA
332#undef IMM
333#undef PCR
Sean Callanan8f993b82010-04-08 00:48:21 +0000334
335#undef SET
Sean Callanan95fcebd2010-01-29 00:21:04 +0000336
337/// X86PopulateOperands - Handles all the operands in an X86 instruction, adding
338/// the appropriate flags to their descriptors
339///
340/// @operandFlags - A reference the array of operand flag objects
341/// @inst - The instruction to use as a source of information
342static void X86PopulateOperands(
Sean Callanan9899f702010-04-13 21:21:57 +0000343 LiteralConstantEmitter *(&operandTypes)[EDIS_MAX_OPERANDS],
Sean Callanan95fcebd2010-01-29 00:21:04 +0000344 const CodeGenInstruction &inst) {
345 if (!inst.TheDef->isSubClassOf("X86Inst"))
346 return;
347
348 unsigned int index;
349 unsigned int numOperands = inst.OperandList.size();
350
351 for (index = 0; index < numOperands; ++index) {
352 const CodeGenInstruction::OperandInfo &operandInfo =
353 inst.OperandList[index];
354 Record &rec = *operandInfo.Rec;
355
Sean Callanan8f993b82010-04-08 00:48:21 +0000356 if (X86TypeFromOpName(operandTypes[index], rec.getName())) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000357 errs() << "Operand type: " << rec.getName().c_str() << "\n";
358 errs() << "Operand name: " << operandInfo.Name.c_str() << "\n";
359 errs() << "Instruction mame: " << inst.TheDef->getName().c_str() << "\n";
360 llvm_unreachable("Unhandled type");
361 }
362 }
363}
364
365/// decorate1 - Decorates a named operand with a new flag
366///
367/// @operandFlags - The array of operand flag objects, which don't have names
368/// @inst - The CodeGenInstruction, which provides a way to translate
369/// between names and operand indices
370/// @opName - The name of the operand
371/// @flag - The name of the flag to add
Sean Callanan8f993b82010-04-08 00:48:21 +0000372static inline void decorate1(
Sean Callanan9899f702010-04-13 21:21:57 +0000373 FlagsConstantEmitter *(&operandFlags)[EDIS_MAX_OPERANDS],
Sean Callanan8f993b82010-04-08 00:48:21 +0000374 const CodeGenInstruction &inst,
375 const char *opName,
376 const char *opFlag) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000377 unsigned opIndex;
378
Sean Callanancf57c702010-02-10 03:23:23 +0000379 opIndex = inst.getOperandNamed(std::string(opName));
Sean Callanan95fcebd2010-01-29 00:21:04 +0000380
381 operandFlags[opIndex]->addEntry(opFlag);
382}
383
384#define DECORATE1(opName, opFlag) decorate1(operandFlags, inst, opName, opFlag)
385
Sean Callanan8f993b82010-04-08 00:48:21 +0000386#define MOV(source, target) { \
387 instType.set("kInstructionTypeMove"); \
388 DECORATE1(source, "kOperandFlagSource"); \
389 DECORATE1(target, "kOperandFlagTarget"); \
Sean Callanan95fcebd2010-01-29 00:21:04 +0000390}
391
Sean Callanan8f993b82010-04-08 00:48:21 +0000392#define BRANCH(target) { \
393 instType.set("kInstructionTypeBranch"); \
394 DECORATE1(target, "kOperandFlagTarget"); \
Sean Callanan95fcebd2010-01-29 00:21:04 +0000395}
396
Sean Callanan8f993b82010-04-08 00:48:21 +0000397#define PUSH(source) { \
398 instType.set("kInstructionTypePush"); \
399 DECORATE1(source, "kOperandFlagSource"); \
Sean Callanan95fcebd2010-01-29 00:21:04 +0000400}
401
Sean Callanan8f993b82010-04-08 00:48:21 +0000402#define POP(target) { \
403 instType.set("kInstructionTypePop"); \
404 DECORATE1(target, "kOperandFlagTarget"); \
Sean Callanan95fcebd2010-01-29 00:21:04 +0000405}
406
Sean Callanan8f993b82010-04-08 00:48:21 +0000407#define CALL(target) { \
408 instType.set("kInstructionTypeCall"); \
409 DECORATE1(target, "kOperandFlagTarget"); \
Sean Callanan95fcebd2010-01-29 00:21:04 +0000410}
411
Sean Callanan8f993b82010-04-08 00:48:21 +0000412#define RETURN() { \
413 instType.set("kInstructionTypeReturn"); \
Sean Callanan95fcebd2010-01-29 00:21:04 +0000414}
415
416/// X86ExtractSemantics - Performs various checks on the name of an X86
417/// instruction to determine what sort of an instruction it is and then adds
418/// the appropriate flags to the instruction and its operands
419///
Sean Callanan8f993b82010-04-08 00:48:21 +0000420/// @arg instType - A reference to the type for the instruction as a whole
Sean Callanan95fcebd2010-01-29 00:21:04 +0000421/// @arg operandFlags - A reference to the array of operand flag object pointers
422/// @arg inst - A reference to the original instruction
Sean Callanan8f993b82010-04-08 00:48:21 +0000423static void X86ExtractSemantics(
424 LiteralConstantEmitter &instType,
Sean Callanan9899f702010-04-13 21:21:57 +0000425 FlagsConstantEmitter *(&operandFlags)[EDIS_MAX_OPERANDS],
Sean Callanan8f993b82010-04-08 00:48:21 +0000426 const CodeGenInstruction &inst) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000427 const std::string &name = inst.TheDef->getName();
428
429 if (name.find("MOV") != name.npos) {
430 if (name.find("MOV_V") != name.npos) {
431 // ignore (this is a pseudoinstruction)
Sean Callanan8f993b82010-04-08 00:48:21 +0000432 } else if (name.find("MASK") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000433 // ignore (this is a masking move)
Sean Callanan8f993b82010-04-08 00:48:21 +0000434 } else if (name.find("r0") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000435 // ignore (this is a pseudoinstruction)
Sean Callanan8f993b82010-04-08 00:48:21 +0000436 } else if (name.find("PS") != name.npos ||
Sean Callanan95fcebd2010-01-29 00:21:04 +0000437 name.find("PD") != name.npos) {
438 // ignore (this is a shuffling move)
Sean Callanan8f993b82010-04-08 00:48:21 +0000439 } else if (name.find("MOVS") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000440 // ignore (this is a string move)
Sean Callanan8f993b82010-04-08 00:48:21 +0000441 } else if (name.find("_F") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000442 // TODO handle _F moves to ST(0)
Sean Callanan8f993b82010-04-08 00:48:21 +0000443 } else if (name.find("a") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000444 // TODO handle moves to/from %ax
Sean Callanan8f993b82010-04-08 00:48:21 +0000445 } else if (name.find("CMOV") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000446 MOV("src2", "dst");
Sean Callanan8f993b82010-04-08 00:48:21 +0000447 } else if (name.find("PC") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000448 MOV("label", "reg")
Sean Callanan8f993b82010-04-08 00:48:21 +0000449 } else {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000450 MOV("src", "dst");
451 }
452 }
453
454 if (name.find("JMP") != name.npos ||
455 name.find("J") == 0) {
456 if (name.find("FAR") != name.npos && name.find("i") != name.npos) {
457 BRANCH("off");
Sean Callanan8f993b82010-04-08 00:48:21 +0000458 } else {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000459 BRANCH("dst");
460 }
461 }
462
463 if (name.find("PUSH") != name.npos) {
464 if (name.find("FS") != name.npos ||
465 name.find("GS") != name.npos) {
Sean Callanan8f993b82010-04-08 00:48:21 +0000466 instType.set("kInstructionTypePush");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000467 // TODO add support for fixed operands
Sean Callanan8f993b82010-04-08 00:48:21 +0000468 } else if (name.find("F") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000469 // ignore (this pushes onto the FP stack)
Nico Weber50b9efc2010-06-23 20:00:58 +0000470 } else if (name.find("A") != name.npos) {
471 // ignore (pushes all GP registoers onto the stack)
Sean Callanan8f993b82010-04-08 00:48:21 +0000472 } else if (name[name.length() - 1] == 'm') {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000473 PUSH("src");
Sean Callanan8f993b82010-04-08 00:48:21 +0000474 } else if (name.find("i") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000475 PUSH("imm");
Sean Callanan8f993b82010-04-08 00:48:21 +0000476 } else {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000477 PUSH("reg");
478 }
479 }
480
481 if (name.find("POP") != name.npos) {
482 if (name.find("POPCNT") != name.npos) {
483 // ignore (not a real pop)
Sean Callanan8f993b82010-04-08 00:48:21 +0000484 } else if (name.find("FS") != name.npos ||
Sean Callanan95fcebd2010-01-29 00:21:04 +0000485 name.find("GS") != name.npos) {
Sean Callanan8f993b82010-04-08 00:48:21 +0000486 instType.set("kInstructionTypePop");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000487 // TODO add support for fixed operands
Sean Callanan8f993b82010-04-08 00:48:21 +0000488 } else if (name.find("F") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000489 // ignore (this pops from the FP stack)
Nico Weber50b9efc2010-06-23 20:00:58 +0000490 } else if (name.find("A") != name.npos) {
491 // ignore (pushes all GP registoers onto the stack)
Sean Callanan8f993b82010-04-08 00:48:21 +0000492 } else if (name[name.length() - 1] == 'm') {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000493 POP("dst");
Sean Callanan8f993b82010-04-08 00:48:21 +0000494 } else {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000495 POP("reg");
496 }
497 }
498
499 if (name.find("CALL") != name.npos) {
500 if (name.find("ADJ") != name.npos) {
501 // ignore (not a call)
Sean Callanan8f993b82010-04-08 00:48:21 +0000502 } else if (name.find("SYSCALL") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000503 // ignore (doesn't go anywhere we know about)
Sean Callanan8f993b82010-04-08 00:48:21 +0000504 } else if (name.find("VMCALL") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000505 // ignore (rather different semantics than a regular call)
Sean Callanan8f993b82010-04-08 00:48:21 +0000506 } else if (name.find("FAR") != name.npos && name.find("i") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000507 CALL("off");
Sean Callanan8f993b82010-04-08 00:48:21 +0000508 } else {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000509 CALL("dst");
510 }
511 }
512
513 if (name.find("RET") != name.npos) {
514 RETURN();
515 }
516}
517
518#undef MOV
519#undef BRANCH
520#undef PUSH
521#undef POP
522#undef CALL
523#undef RETURN
524
Sean Callanan8f993b82010-04-08 00:48:21 +0000525/////////////////////////////////////////////////////
526// Support functions for handling ARM instructions //
527/////////////////////////////////////////////////////
528
529#define SET(flag) { type->set(flag); return 0; }
530
531#define REG(str) if (name == str) SET("kOperandTypeRegister");
532#define IMM(str) if (name == str) SET("kOperandTypeImmediate");
533
534#define MISC(str, type) if (name == str) SET(type);
535
536/// ARMFlagFromOpName - Processes the name of a single ARM operand (which is
537/// actually its type) and translates it into an operand type
538///
539/// @arg type - The type object to set
540/// @arg name - The name of the operand
541static int ARMFlagFromOpName(LiteralConstantEmitter *type,
542 const std::string &name) {
543 REG("GPR");
Jim Grosbach6ccfc502010-07-30 02:41:01 +0000544 REG("rGPR");
Dale Johannesen6470a112010-06-15 22:08:33 +0000545 REG("tcGPR");
Sean Callanan8f993b82010-04-08 00:48:21 +0000546 REG("cc_out");
547 REG("s_cc_out");
548 REG("tGPR");
549 REG("DPR");
Sean Callanan8f993b82010-04-08 00:48:21 +0000550 REG("DPR_VFP2");
551 REG("DPR_8");
Evan Chengb63387a2010-05-06 06:36:08 +0000552 REG("SPR");
553 REG("QPR");
554 REG("QQPR");
Evan Cheng22c687b2010-05-14 02:13:41 +0000555 REG("QQQQPR");
Sean Callanan8f993b82010-04-08 00:48:21 +0000556
557 IMM("i32imm");
558 IMM("bf_inv_mask_imm");
559 IMM("jtblock_operand");
560 IMM("nohash_imm");
561 IMM("cpinst_operand");
562 IMM("cps_opt");
563 IMM("vfp_f64imm");
564 IMM("vfp_f32imm");
Johnny Chen1adc40c2010-08-12 20:46:17 +0000565 IMM("memb_opt");
Sean Callanan8f993b82010-04-08 00:48:21 +0000566 IMM("msr_mask");
567 IMM("neg_zero");
568 IMM("imm0_31");
Bob Wilson1a913ed2010-06-11 21:34:50 +0000569 IMM("nModImm");
Sean Callanan8f993b82010-04-08 00:48:21 +0000570 IMM("imm0_4095");
571 IMM("jt2block_operand");
572 IMM("t_imm_s4");
573 IMM("pclabel");
Bob Wilson22f5dc72010-08-16 18:27:34 +0000574 IMM("shift_imm");
Sean Callanan8f993b82010-04-08 00:48:21 +0000575
576 MISC("brtarget", "kOperandTypeARMBranchTarget"); // ?
577 MISC("so_reg", "kOperandTypeARMSoReg"); // R, R, I
578 MISC("t2_so_reg", "kOperandTypeThumb2SoReg"); // R, I
579 MISC("so_imm", "kOperandTypeARMSoImm"); // I
580 MISC("t2_so_imm", "kOperandTypeThumb2SoImm"); // I
581 MISC("so_imm2part", "kOperandTypeARMSoImm2Part"); // I
582 MISC("pred", "kOperandTypeARMPredicate"); // I, R
583 MISC("it_pred", "kOperandTypeARMPredicate"); // I
584 MISC("addrmode2", "kOperandTypeARMAddrMode2"); // R, R, I
585 MISC("am2offset", "kOperandTypeARMAddrMode2Offset"); // R, I
586 MISC("addrmode3", "kOperandTypeARMAddrMode3"); // R, R, I
587 MISC("am3offset", "kOperandTypeARMAddrMode3Offset"); // R, I
588 MISC("addrmode4", "kOperandTypeARMAddrMode4"); // R, I
589 MISC("addrmode5", "kOperandTypeARMAddrMode5"); // R, I
590 MISC("addrmode6", "kOperandTypeARMAddrMode6"); // R, R, I, I
591 MISC("am6offset", "kOperandTypeARMAddrMode6Offset"); // R, I, I
592 MISC("addrmodepc", "kOperandTypeARMAddrModePC"); // R, I
593 MISC("reglist", "kOperandTypeARMRegisterList"); // I, R, ...
594 MISC("it_mask", "kOperandTypeThumbITMask"); // I
595 MISC("t2addrmode_imm8", "kOperandTypeThumb2AddrModeImm8"); // R, I
596 MISC("t2am_imm8_offset", "kOperandTypeThumb2AddrModeImm8Offset");//I
597 MISC("t2addrmode_imm12", "kOperandTypeThumb2AddrModeImm12"); // R, I
598 MISC("t2addrmode_so_reg", "kOperandTypeThumb2AddrModeSoReg"); // R, R, I
599 MISC("t2addrmode_imm8s4", "kOperandTypeThumb2AddrModeImm8s4"); // R, I
600 MISC("t2am_imm8s4_offset", "kOperandTypeThumb2AddrModeImm8s4Offset");
601 // R, I
602 MISC("tb_addrmode", "kOperandTypeARMTBAddrMode"); // I
603 MISC("t_addrmode_s1", "kOperandTypeThumbAddrModeS1"); // R, I, R
604 MISC("t_addrmode_s2", "kOperandTypeThumbAddrModeS2"); // R, I, R
605 MISC("t_addrmode_s4", "kOperandTypeThumbAddrModeS4"); // R, I, R
606 MISC("t_addrmode_rr", "kOperandTypeThumbAddrModeRR"); // R, R
607 MISC("t_addrmode_sp", "kOperandTypeThumbAddrModeSP"); // R, I
608
609 return 1;
610}
611
612#undef SOREG
613#undef SOIMM
614#undef PRED
615#undef REG
616#undef MEM
617#undef LEA
618#undef IMM
619#undef PCR
620
621#undef SET
622
623/// ARMPopulateOperands - Handles all the operands in an ARM instruction, adding
624/// the appropriate flags to their descriptors
625///
626/// @operandFlags - A reference the array of operand flag objects
627/// @inst - The instruction to use as a source of information
628static void ARMPopulateOperands(
Sean Callanan9899f702010-04-13 21:21:57 +0000629 LiteralConstantEmitter *(&operandTypes)[EDIS_MAX_OPERANDS],
Sean Callanan8f993b82010-04-08 00:48:21 +0000630 const CodeGenInstruction &inst) {
631 if (!inst.TheDef->isSubClassOf("InstARM") &&
632 !inst.TheDef->isSubClassOf("InstThumb"))
633 return;
634
635 unsigned int index;
636 unsigned int numOperands = inst.OperandList.size();
637
Sean Callanan9899f702010-04-13 21:21:57 +0000638 if (numOperands > EDIS_MAX_OPERANDS) {
639 errs() << "numOperands == " << numOperands << " > " <<
640 EDIS_MAX_OPERANDS << '\n';
Sean Callanan8f993b82010-04-08 00:48:21 +0000641 llvm_unreachable("Too many operands");
642 }
643
644 for (index = 0; index < numOperands; ++index) {
645 const CodeGenInstruction::OperandInfo &operandInfo =
646 inst.OperandList[index];
647 Record &rec = *operandInfo.Rec;
648
649 if (ARMFlagFromOpName(operandTypes[index], rec.getName())) {
Benjamin Kramer127dc5e2010-04-08 09:42:29 +0000650 errs() << "Operand type: " << rec.getName() << '\n';
651 errs() << "Operand name: " << operandInfo.Name << '\n';
652 errs() << "Instruction mame: " << inst.TheDef->getName() << '\n';
Sean Callanan8f993b82010-04-08 00:48:21 +0000653 llvm_unreachable("Unhandled type");
654 }
655 }
656}
657
658#define BRANCH(target) { \
659 instType.set("kInstructionTypeBranch"); \
660 DECORATE1(target, "kOperandFlagTarget"); \
661}
662
663/// ARMExtractSemantics - Performs various checks on the name of an ARM
664/// instruction to determine what sort of an instruction it is and then adds
665/// the appropriate flags to the instruction and its operands
666///
667/// @arg instType - A reference to the type for the instruction as a whole
668/// @arg operandTypes - A reference to the array of operand type object pointers
669/// @arg operandFlags - A reference to the array of operand flag object pointers
670/// @arg inst - A reference to the original instruction
671static void ARMExtractSemantics(
672 LiteralConstantEmitter &instType,
Sean Callanan9899f702010-04-13 21:21:57 +0000673 LiteralConstantEmitter *(&operandTypes)[EDIS_MAX_OPERANDS],
674 FlagsConstantEmitter *(&operandFlags)[EDIS_MAX_OPERANDS],
Sean Callanan8f993b82010-04-08 00:48:21 +0000675 const CodeGenInstruction &inst) {
676 const std::string &name = inst.TheDef->getName();
677
678 if (name == "tBcc" ||
679 name == "tB" ||
680 name == "t2Bcc" ||
681 name == "Bcc" ||
682 name == "tCBZ" ||
683 name == "tCBNZ") {
684 BRANCH("target");
685 }
686
687 if (name == "tBLr9" ||
688 name == "BLr9_pred" ||
689 name == "tBLXi_r9" ||
690 name == "tBLXr_r9" ||
691 name == "BLXr9" ||
692 name == "t2BXJ" ||
693 name == "BXJ") {
694 BRANCH("func");
695
696 unsigned opIndex;
697 opIndex = inst.getOperandNamed("func");
698 if (operandTypes[opIndex]->is("kOperandTypeImmediate"))
699 operandTypes[opIndex]->set("kOperandTypeARMBranchTarget");
700 }
701}
702
703#undef BRANCH
Sean Callanan95fcebd2010-01-29 00:21:04 +0000704
705/// populateInstInfo - Fills an array of InstInfos with information about each
706/// instruction in a target
707///
708/// @arg infoArray - The array of InstInfo objects to populate
709/// @arg target - The CodeGenTarget to use as a source of instructions
710static void populateInstInfo(CompoundConstantEmitter &infoArray,
711 CodeGenTarget &target) {
Chris Lattnerf6502782010-03-19 00:34:35 +0000712 const std::vector<const CodeGenInstruction*> &numberedInstructions =
713 target.getInstructionsByEnumValue();
Sean Callanan95fcebd2010-01-29 00:21:04 +0000714
715 unsigned int index;
716 unsigned int numInstructions = numberedInstructions.size();
717
718 for (index = 0; index < numInstructions; ++index) {
719 const CodeGenInstruction& inst = *numberedInstructions[index];
720
721 CompoundConstantEmitter *infoStruct = new CompoundConstantEmitter;
722 infoArray.addEntry(infoStruct);
723
Sean Callanan8f993b82010-04-08 00:48:21 +0000724 LiteralConstantEmitter *instType = new LiteralConstantEmitter;
725 infoStruct->addEntry(instType);
Sean Callanan95fcebd2010-01-29 00:21:04 +0000726
727 LiteralConstantEmitter *numOperandsEmitter =
728 new LiteralConstantEmitter(inst.OperandList.size());
729 infoStruct->addEntry(numOperandsEmitter);
Sean Callanan8f993b82010-04-08 00:48:21 +0000730
731 CompoundConstantEmitter *operandTypeArray = new CompoundConstantEmitter;
732 infoStruct->addEntry(operandTypeArray);
733
Sean Callanan9899f702010-04-13 21:21:57 +0000734 LiteralConstantEmitter *operandTypes[EDIS_MAX_OPERANDS];
Sean Callanan95fcebd2010-01-29 00:21:04 +0000735
736 CompoundConstantEmitter *operandFlagArray = new CompoundConstantEmitter;
737 infoStruct->addEntry(operandFlagArray);
738
Sean Callanan9899f702010-04-13 21:21:57 +0000739 FlagsConstantEmitter *operandFlags[EDIS_MAX_OPERANDS];
Sean Callanan95fcebd2010-01-29 00:21:04 +0000740
Sean Callanan8f993b82010-04-08 00:48:21 +0000741 for (unsigned operandIndex = 0;
Sean Callanan9899f702010-04-13 21:21:57 +0000742 operandIndex < EDIS_MAX_OPERANDS;
Sean Callanan8f993b82010-04-08 00:48:21 +0000743 ++operandIndex) {
744 operandTypes[operandIndex] = new LiteralConstantEmitter;
745 operandTypeArray->addEntry(operandTypes[operandIndex]);
746
Sean Callanan95fcebd2010-01-29 00:21:04 +0000747 operandFlags[operandIndex] = new FlagsConstantEmitter;
748 operandFlagArray->addEntry(operandFlags[operandIndex]);
749 }
750
751 unsigned numSyntaxes = 0;
752
753 if (target.getName() == "X86") {
Sean Callanan8f993b82010-04-08 00:48:21 +0000754 X86PopulateOperands(operandTypes, inst);
755 X86ExtractSemantics(*instType, operandFlags, inst);
Sean Callanan95fcebd2010-01-29 00:21:04 +0000756 numSyntaxes = 2;
757 }
Sean Callanan8f993b82010-04-08 00:48:21 +0000758 else if (target.getName() == "ARM") {
759 ARMPopulateOperands(operandTypes, inst);
760 ARMExtractSemantics(*instType, operandTypes, operandFlags, inst);
761 numSyntaxes = 1;
762 }
Sean Callanan95fcebd2010-01-29 00:21:04 +0000763
Sean Callanan8f993b82010-04-08 00:48:21 +0000764 CompoundConstantEmitter *operandOrderArray = new CompoundConstantEmitter;
765
Sean Callanan95fcebd2010-01-29 00:21:04 +0000766 infoStruct->addEntry(operandOrderArray);
767
Sean Callanan9899f702010-04-13 21:21:57 +0000768 for (unsigned syntaxIndex = 0;
769 syntaxIndex < EDIS_MAX_SYNTAXES;
770 ++syntaxIndex) {
Sean Callanan8f993b82010-04-08 00:48:21 +0000771 CompoundConstantEmitter *operandOrder =
Sean Callanan9899f702010-04-13 21:21:57 +0000772 new CompoundConstantEmitter(EDIS_MAX_OPERANDS);
Sean Callanan8f993b82010-04-08 00:48:21 +0000773
Sean Callanan95fcebd2010-01-29 00:21:04 +0000774 operandOrderArray->addEntry(operandOrder);
775
776 if (syntaxIndex < numSyntaxes) {
Sean Callanan2db6ff22010-02-10 02:47:08 +0000777 populateOperandOrder(operandOrder, inst, syntaxIndex);
Sean Callanan95fcebd2010-01-29 00:21:04 +0000778 }
Sean Callanan95fcebd2010-01-29 00:21:04 +0000779 }
Sean Callanan8f993b82010-04-08 00:48:21 +0000780
781 infoStruct = NULL;
Sean Callanan95fcebd2010-01-29 00:21:04 +0000782 }
783}
784
Sean Callanan9899f702010-04-13 21:21:57 +0000785static void emitCommonEnums(raw_ostream &o, unsigned int &i) {
Sean Callanan8f993b82010-04-08 00:48:21 +0000786 EnumEmitter operandTypes("OperandTypes");
787 operandTypes.addEntry("kOperandTypeNone");
788 operandTypes.addEntry("kOperandTypeImmediate");
789 operandTypes.addEntry("kOperandTypeRegister");
790 operandTypes.addEntry("kOperandTypeX86Memory");
791 operandTypes.addEntry("kOperandTypeX86EffectiveAddress");
792 operandTypes.addEntry("kOperandTypeX86PCRelative");
793 operandTypes.addEntry("kOperandTypeARMBranchTarget");
794 operandTypes.addEntry("kOperandTypeARMSoReg");
795 operandTypes.addEntry("kOperandTypeARMSoImm");
796 operandTypes.addEntry("kOperandTypeARMSoImm2Part");
797 operandTypes.addEntry("kOperandTypeARMPredicate");
798 operandTypes.addEntry("kOperandTypeARMAddrMode2");
799 operandTypes.addEntry("kOperandTypeARMAddrMode2Offset");
800 operandTypes.addEntry("kOperandTypeARMAddrMode3");
801 operandTypes.addEntry("kOperandTypeARMAddrMode3Offset");
802 operandTypes.addEntry("kOperandTypeARMAddrMode4");
803 operandTypes.addEntry("kOperandTypeARMAddrMode5");
804 operandTypes.addEntry("kOperandTypeARMAddrMode6");
805 operandTypes.addEntry("kOperandTypeARMAddrMode6Offset");
806 operandTypes.addEntry("kOperandTypeARMAddrModePC");
807 operandTypes.addEntry("kOperandTypeARMRegisterList");
808 operandTypes.addEntry("kOperandTypeARMTBAddrMode");
809 operandTypes.addEntry("kOperandTypeThumbITMask");
810 operandTypes.addEntry("kOperandTypeThumbAddrModeS1");
811 operandTypes.addEntry("kOperandTypeThumbAddrModeS2");
812 operandTypes.addEntry("kOperandTypeThumbAddrModeS4");
813 operandTypes.addEntry("kOperandTypeThumbAddrModeRR");
814 operandTypes.addEntry("kOperandTypeThumbAddrModeSP");
815 operandTypes.addEntry("kOperandTypeThumb2SoReg");
816 operandTypes.addEntry("kOperandTypeThumb2SoImm");
817 operandTypes.addEntry("kOperandTypeThumb2AddrModeImm8");
818 operandTypes.addEntry("kOperandTypeThumb2AddrModeImm8Offset");
819 operandTypes.addEntry("kOperandTypeThumb2AddrModeImm12");
820 operandTypes.addEntry("kOperandTypeThumb2AddrModeSoReg");
821 operandTypes.addEntry("kOperandTypeThumb2AddrModeImm8s4");
822 operandTypes.addEntry("kOperandTypeThumb2AddrModeImm8s4Offset");
Sean Callanan8f993b82010-04-08 00:48:21 +0000823 operandTypes.emit(o, i);
824
825 o << "\n";
826
Sean Callanan95fcebd2010-01-29 00:21:04 +0000827 EnumEmitter operandFlags("OperandFlags");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000828 operandFlags.addEntry("kOperandFlagSource");
829 operandFlags.addEntry("kOperandFlagTarget");
830 operandFlags.emitAsFlags(o, i);
831
832 o << "\n";
833
Sean Callanan8f993b82010-04-08 00:48:21 +0000834 EnumEmitter instructionTypes("InstructionTypes");
835 instructionTypes.addEntry("kInstructionTypeNone");
836 instructionTypes.addEntry("kInstructionTypeMove");
837 instructionTypes.addEntry("kInstructionTypeBranch");
838 instructionTypes.addEntry("kInstructionTypePush");
839 instructionTypes.addEntry("kInstructionTypePop");
840 instructionTypes.addEntry("kInstructionTypeCall");
841 instructionTypes.addEntry("kInstructionTypeReturn");
842 instructionTypes.emit(o, i);
Sean Callanan95fcebd2010-01-29 00:21:04 +0000843
844 o << "\n";
Sean Callanan9899f702010-04-13 21:21:57 +0000845}
846
847void EDEmitter::run(raw_ostream &o) {
848 unsigned int i = 0;
Sean Callanan95fcebd2010-01-29 00:21:04 +0000849
Sean Callanan9899f702010-04-13 21:21:57 +0000850 CompoundConstantEmitter infoArray;
851 CodeGenTarget target;
852
853 populateInstInfo(infoArray, target);
854
855 emitCommonEnums(o, i);
856
857 o << "namespace {\n";
858
859 o << "llvm::EDInstInfo instInfo" << target.getName().c_str() << "[] = ";
860 infoArray.emit(o, i);
861 o << ";" << "\n";
862
863 o << "}\n";
864}