blob: 8706ed5426e46e5fae952d84bf9b3655fe9bf884 [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
87 class StructEmitter {
88 private:
89 std::string Name;
Sean Callanan8f993b82010-04-08 00:48:21 +000090 typedef std::pair<const char*, const char*> member;
91 std::vector< member > Members;
Sean Callanan95fcebd2010-01-29 00:21:04 +000092 public:
93 StructEmitter(const char *N) : Name(N) {
94 }
95 void addMember(const char *t, const char *n) {
Sean Callanan8f993b82010-04-08 00:48:21 +000096 member m(t, n);
97 Members.push_back(m);
Sean Callanan95fcebd2010-01-29 00:21:04 +000098 }
99 void emit(raw_ostream &o, unsigned int &i) {
100 o.indent(i) << "struct " << Name.c_str() << " {" << "\n";
101 i += 2;
102
103 unsigned int index = 0;
Sean Callanan8f993b82010-04-08 00:48:21 +0000104 unsigned int numMembers = Members.size();
Sean Callanan95fcebd2010-01-29 00:21:04 +0000105 for (index = 0; index < numMembers; ++index) {
Sean Callanan8f993b82010-04-08 00:48:21 +0000106 o.indent(i) << Members[index].first << " ";
107 o.indent(i) << Members[index].second << ";" << "\n";
Sean Callanan95fcebd2010-01-29 00:21:04 +0000108 }
109
110 i -= 2;
111 o.indent(i) << "};" << "\n";
112 }
113 };
114
115 class ConstantEmitter {
116 public:
117 virtual ~ConstantEmitter() { }
118 virtual void emit(raw_ostream &o, unsigned int &i) = 0;
119 };
120
121 class LiteralConstantEmitter : public ConstantEmitter {
122 private:
Sean Callanan8f993b82010-04-08 00:48:21 +0000123 bool IsNumber;
124 union {
125 int Number;
126 const char* String;
127 };
Sean Callanan95fcebd2010-01-29 00:21:04 +0000128 public:
Sean Callanan8f993b82010-04-08 00:48:21 +0000129 LiteralConstantEmitter(const char *string) :
130 IsNumber(false),
131 String(string) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000132 }
Sean Callanan8f993b82010-04-08 00:48:21 +0000133 LiteralConstantEmitter(int number = 0) :
134 IsNumber(true),
135 Number(number) {
136 }
137 void set(const char *string) {
138 IsNumber = false;
139 Number = 0;
140 String = string;
141 }
142 void set(int number) {
143 IsNumber = true;
144 String = NULL;
145 Number = number;
146 }
147 bool is(const char *string) {
148 return !strcmp(String, string);
Sean Callanan95fcebd2010-01-29 00:21:04 +0000149 }
150 void emit(raw_ostream &o, unsigned int &i) {
Sean Callanan8f993b82010-04-08 00:48:21 +0000151 if (IsNumber)
152 o << Number;
153 else
154 o << String;
Sean Callanan95fcebd2010-01-29 00:21:04 +0000155 }
156 };
157
158 class CompoundConstantEmitter : public ConstantEmitter {
159 private:
Sean Callanan8f993b82010-04-08 00:48:21 +0000160 unsigned int Padding;
161 std::vector<ConstantEmitter *> Entries;
Sean Callanan95fcebd2010-01-29 00:21:04 +0000162 public:
Sean Callanan8f993b82010-04-08 00:48:21 +0000163 CompoundConstantEmitter(unsigned int padding = 0) : Padding(padding) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000164 }
165 CompoundConstantEmitter &addEntry(ConstantEmitter *e) {
166 Entries.push_back(e);
Sean Callanan8f993b82010-04-08 00:48:21 +0000167
Sean Callanan95fcebd2010-01-29 00:21:04 +0000168 return *this;
169 }
Sean Callanan8f993b82010-04-08 00:48:21 +0000170 ~CompoundConstantEmitter() {
171 while (Entries.size()) {
172 ConstantEmitter *entry = Entries.back();
173 Entries.pop_back();
174 delete entry;
175 }
176 }
Sean Callanan95fcebd2010-01-29 00:21:04 +0000177 void emit(raw_ostream &o, unsigned int &i) {
178 o << "{" << "\n";
179 i += 2;
180
181 unsigned int index;
182 unsigned int numEntries = Entries.size();
Sean Callanan8f993b82010-04-08 00:48:21 +0000183
184 unsigned int numToPrint;
185
186 if (Padding) {
187 if (numEntries > Padding) {
188 fprintf(stderr, "%u entries but %u padding\n", numEntries, Padding);
189 llvm_unreachable("More entries than padding");
190 }
191 numToPrint = Padding;
192 } else {
193 numToPrint = numEntries;
194 }
195
196 for (index = 0; index < numToPrint; ++index) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000197 o.indent(i);
Sean Callanan8f993b82010-04-08 00:48:21 +0000198 if (index < numEntries)
199 Entries[index]->emit(o, i);
200 else
201 o << "-1";
202
203 if (index < (numToPrint - 1))
Sean Callanan95fcebd2010-01-29 00:21:04 +0000204 o << ",";
205 o << "\n";
206 }
207
208 i -= 2;
209 o.indent(i) << "}";
210 }
211 };
212
213 class FlagsConstantEmitter : public ConstantEmitter {
214 private:
215 std::vector<std::string> Flags;
216 public:
217 FlagsConstantEmitter() {
218 }
219 FlagsConstantEmitter &addEntry(const char *f) {
220 Flags.push_back(std::string(f));
221 return *this;
222 }
223 void emit(raw_ostream &o, unsigned int &i) {
224 unsigned int index;
225 unsigned int numFlags = Flags.size();
226 if (numFlags == 0)
227 o << "0";
228
229 for (index = 0; index < numFlags; ++index) {
230 o << Flags[index].c_str();
231 if (index < (numFlags - 1))
232 o << " | ";
233 }
234 }
235 };
236}
237
238EDEmitter::EDEmitter(RecordKeeper &R) : Records(R) {
239}
240
Sean Callanan2db6ff22010-02-10 02:47:08 +0000241/// populateOperandOrder - Accepts a CodeGenInstruction and generates its
242/// AsmWriterInst for the desired assembly syntax, giving an ordered list of
243/// operands in the order they appear in the printed instruction. Then, for
244/// each entry in that list, determines the index of the same operand in the
245/// CodeGenInstruction, and emits the resulting mapping into an array, filling
246/// in unused slots with -1.
Sean Callanan95fcebd2010-01-29 00:21:04 +0000247///
248/// @arg operandOrder - The array that will be populated with the operand
249/// mapping. Each entry will contain -1 (invalid index
250/// into the operands present in the AsmString) or a number
251/// representing an index in the operand descriptor array.
Sean Callanan2db6ff22010-02-10 02:47:08 +0000252/// @arg inst - The instruction to use when looking up the operands
253/// @arg syntax - The syntax to use, according to LLVM's enumeration
Sean Callanan95fcebd2010-01-29 00:21:04 +0000254void populateOperandOrder(CompoundConstantEmitter *operandOrder,
Sean Callanan2db6ff22010-02-10 02:47:08 +0000255 const CodeGenInstruction &inst,
256 unsigned syntax) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000257 unsigned int numArgs = 0;
258
Sean Callanan2db6ff22010-02-10 02:47:08 +0000259 AsmWriterInst awInst(inst, syntax, -1, -1);
Sean Callanan95fcebd2010-01-29 00:21:04 +0000260
Sean Callanan2db6ff22010-02-10 02:47:08 +0000261 std::vector<AsmWriterOperand>::iterator operandIterator;
Sean Callanan95fcebd2010-01-29 00:21:04 +0000262
Sean Callanan2db6ff22010-02-10 02:47:08 +0000263 for (operandIterator = awInst.Operands.begin();
264 operandIterator != awInst.Operands.end();
265 ++operandIterator) {
266 if (operandIterator->OperandType ==
267 AsmWriterOperand::isMachineInstrOperand) {
Sean Callanan8f993b82010-04-08 00:48:21 +0000268 operandOrder->addEntry(
269 new LiteralConstantEmitter(operandIterator->CGIOpNo));
Sean Callanan2db6ff22010-02-10 02:47:08 +0000270 numArgs++;
Sean Callanan95fcebd2010-01-29 00:21:04 +0000271 }
272 }
Sean Callanan95fcebd2010-01-29 00:21:04 +0000273}
274
275/////////////////////////////////////////////////////
276// Support functions for handling X86 instructions //
277/////////////////////////////////////////////////////
278
Sean Callanan8f993b82010-04-08 00:48:21 +0000279#define SET(flag) { type->set(flag); return 0; }
Sean Callanan95fcebd2010-01-29 00:21:04 +0000280
Sean Callanan8f993b82010-04-08 00:48:21 +0000281#define REG(str) if (name == str) SET("kOperandTypeRegister");
282#define MEM(str) if (name == str) SET("kOperandTypeX86Memory");
283#define LEA(str) if (name == str) SET("kOperandTypeX86EffectiveAddress");
284#define IMM(str) if (name == str) SET("kOperandTypeImmediate");
285#define PCR(str) if (name == str) SET("kOperandTypeX86PCRelative");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000286
Sean Callanan8f993b82010-04-08 00:48:21 +0000287/// X86TypeFromOpName - Processes the name of a single X86 operand (which is
288/// actually its type) and translates it into an operand type
Sean Callanan95fcebd2010-01-29 00:21:04 +0000289///
Sean Callanan8f993b82010-04-08 00:48:21 +0000290/// @arg flags - The type object to set
Sean Callanan95fcebd2010-01-29 00:21:04 +0000291/// @arg name - The name of the operand
Sean Callanan8f993b82010-04-08 00:48:21 +0000292static int X86TypeFromOpName(LiteralConstantEmitter *type,
Sean Callanan95fcebd2010-01-29 00:21:04 +0000293 const std::string &name) {
294 REG("GR8");
295 REG("GR8_NOREX");
296 REG("GR16");
297 REG("GR32");
298 REG("GR32_NOREX");
Evan Cheng5e817162010-03-14 05:15:39 +0000299 REG("GR32_TC");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000300 REG("FR32");
301 REG("RFP32");
302 REG("GR64");
Evan Cheng5e817162010-03-14 05:15:39 +0000303 REG("GR64_TC");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000304 REG("FR64");
305 REG("VR64");
306 REG("RFP64");
307 REG("RFP80");
308 REG("VR128");
Bruno Cardoso Lopese86b01c2010-07-09 18:27:43 +0000309 REG("VR256");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000310 REG("RST");
311 REG("SEGMENT_REG");
312 REG("DEBUG_REG");
Sean Callanan1a8b7892010-05-06 20:59:00 +0000313 REG("CONTROL_REG");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000314
Sean Callanan8f993b82010-04-08 00:48:21 +0000315 IMM("i8imm");
316 IMM("i16imm");
317 IMM("i16i8imm");
318 IMM("i32imm");
Sean Callanan8f993b82010-04-08 00:48:21 +0000319 IMM("i32i8imm");
320 IMM("i64imm");
321 IMM("i64i8imm");
322 IMM("i64i32imm");
Sean Callanan8f993b82010-04-08 00:48:21 +0000323 IMM("SSECC");
324
325 // all R, I, R, I, R
Sean Callanan95fcebd2010-01-29 00:21:04 +0000326 MEM("i8mem");
327 MEM("i8mem_NOREX");
328 MEM("i16mem");
329 MEM("i32mem");
Evan Cheng5e817162010-03-14 05:15:39 +0000330 MEM("i32mem_TC");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000331 MEM("f32mem");
332 MEM("ssmem");
333 MEM("opaque32mem");
334 MEM("opaque48mem");
335 MEM("i64mem");
Evan Cheng5e817162010-03-14 05:15:39 +0000336 MEM("i64mem_TC");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000337 MEM("f64mem");
338 MEM("sdmem");
339 MEM("f80mem");
340 MEM("opaque80mem");
341 MEM("i128mem");
Bruno Cardoso Lopes94143ee2010-07-19 23:32:44 +0000342 MEM("i256mem");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000343 MEM("f128mem");
Bruno Cardoso Lopese86b01c2010-07-09 18:27:43 +0000344 MEM("f256mem");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000345 MEM("opaque512mem");
346
Sean Callanan8f993b82010-04-08 00:48:21 +0000347 // all R, I, R, I
Sean Callanan95fcebd2010-01-29 00:21:04 +0000348 LEA("lea32mem");
349 LEA("lea64_32mem");
350 LEA("lea64mem");
351
Sean Callanan8f993b82010-04-08 00:48:21 +0000352 // all I
Chris Lattner9fc05222010-07-07 22:27:31 +0000353 PCR("i16imm_pcrel");
Sean Callanana0f914b2010-04-23 22:17:17 +0000354 PCR("i32imm_pcrel");
355 PCR("i64i32imm_pcrel");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000356 PCR("brtarget8");
357 PCR("offset8");
358 PCR("offset16");
359 PCR("offset32");
360 PCR("offset64");
361 PCR("brtarget");
362
363 return 1;
364}
365
366#undef REG
367#undef MEM
368#undef LEA
369#undef IMM
370#undef PCR
Sean Callanan8f993b82010-04-08 00:48:21 +0000371
372#undef SET
Sean Callanan95fcebd2010-01-29 00:21:04 +0000373
374/// X86PopulateOperands - Handles all the operands in an X86 instruction, adding
375/// the appropriate flags to their descriptors
376///
377/// @operandFlags - A reference the array of operand flag objects
378/// @inst - The instruction to use as a source of information
379static void X86PopulateOperands(
Sean Callanan9899f702010-04-13 21:21:57 +0000380 LiteralConstantEmitter *(&operandTypes)[EDIS_MAX_OPERANDS],
Sean Callanan95fcebd2010-01-29 00:21:04 +0000381 const CodeGenInstruction &inst) {
382 if (!inst.TheDef->isSubClassOf("X86Inst"))
383 return;
384
385 unsigned int index;
386 unsigned int numOperands = inst.OperandList.size();
387
388 for (index = 0; index < numOperands; ++index) {
389 const CodeGenInstruction::OperandInfo &operandInfo =
390 inst.OperandList[index];
391 Record &rec = *operandInfo.Rec;
392
Sean Callanan8f993b82010-04-08 00:48:21 +0000393 if (X86TypeFromOpName(operandTypes[index], rec.getName())) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000394 errs() << "Operand type: " << rec.getName().c_str() << "\n";
395 errs() << "Operand name: " << operandInfo.Name.c_str() << "\n";
396 errs() << "Instruction mame: " << inst.TheDef->getName().c_str() << "\n";
397 llvm_unreachable("Unhandled type");
398 }
399 }
400}
401
402/// decorate1 - Decorates a named operand with a new flag
403///
404/// @operandFlags - The array of operand flag objects, which don't have names
405/// @inst - The CodeGenInstruction, which provides a way to translate
406/// between names and operand indices
407/// @opName - The name of the operand
408/// @flag - The name of the flag to add
Sean Callanan8f993b82010-04-08 00:48:21 +0000409static inline void decorate1(
Sean Callanan9899f702010-04-13 21:21:57 +0000410 FlagsConstantEmitter *(&operandFlags)[EDIS_MAX_OPERANDS],
Sean Callanan8f993b82010-04-08 00:48:21 +0000411 const CodeGenInstruction &inst,
412 const char *opName,
413 const char *opFlag) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000414 unsigned opIndex;
415
Sean Callanancf57c702010-02-10 03:23:23 +0000416 opIndex = inst.getOperandNamed(std::string(opName));
Sean Callanan95fcebd2010-01-29 00:21:04 +0000417
418 operandFlags[opIndex]->addEntry(opFlag);
419}
420
421#define DECORATE1(opName, opFlag) decorate1(operandFlags, inst, opName, opFlag)
422
Sean Callanan8f993b82010-04-08 00:48:21 +0000423#define MOV(source, target) { \
424 instType.set("kInstructionTypeMove"); \
425 DECORATE1(source, "kOperandFlagSource"); \
426 DECORATE1(target, "kOperandFlagTarget"); \
Sean Callanan95fcebd2010-01-29 00:21:04 +0000427}
428
Sean Callanan8f993b82010-04-08 00:48:21 +0000429#define BRANCH(target) { \
430 instType.set("kInstructionTypeBranch"); \
431 DECORATE1(target, "kOperandFlagTarget"); \
Sean Callanan95fcebd2010-01-29 00:21:04 +0000432}
433
Sean Callanan8f993b82010-04-08 00:48:21 +0000434#define PUSH(source) { \
435 instType.set("kInstructionTypePush"); \
436 DECORATE1(source, "kOperandFlagSource"); \
Sean Callanan95fcebd2010-01-29 00:21:04 +0000437}
438
Sean Callanan8f993b82010-04-08 00:48:21 +0000439#define POP(target) { \
440 instType.set("kInstructionTypePop"); \
441 DECORATE1(target, "kOperandFlagTarget"); \
Sean Callanan95fcebd2010-01-29 00:21:04 +0000442}
443
Sean Callanan8f993b82010-04-08 00:48:21 +0000444#define CALL(target) { \
445 instType.set("kInstructionTypeCall"); \
446 DECORATE1(target, "kOperandFlagTarget"); \
Sean Callanan95fcebd2010-01-29 00:21:04 +0000447}
448
Sean Callanan8f993b82010-04-08 00:48:21 +0000449#define RETURN() { \
450 instType.set("kInstructionTypeReturn"); \
Sean Callanan95fcebd2010-01-29 00:21:04 +0000451}
452
453/// X86ExtractSemantics - Performs various checks on the name of an X86
454/// instruction to determine what sort of an instruction it is and then adds
455/// the appropriate flags to the instruction and its operands
456///
Sean Callanan8f993b82010-04-08 00:48:21 +0000457/// @arg instType - A reference to the type for the instruction as a whole
Sean Callanan95fcebd2010-01-29 00:21:04 +0000458/// @arg operandFlags - A reference to the array of operand flag object pointers
459/// @arg inst - A reference to the original instruction
Sean Callanan8f993b82010-04-08 00:48:21 +0000460static void X86ExtractSemantics(
461 LiteralConstantEmitter &instType,
Sean Callanan9899f702010-04-13 21:21:57 +0000462 FlagsConstantEmitter *(&operandFlags)[EDIS_MAX_OPERANDS],
Sean Callanan8f993b82010-04-08 00:48:21 +0000463 const CodeGenInstruction &inst) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000464 const std::string &name = inst.TheDef->getName();
465
466 if (name.find("MOV") != name.npos) {
467 if (name.find("MOV_V") != name.npos) {
468 // ignore (this is a pseudoinstruction)
Sean Callanan8f993b82010-04-08 00:48:21 +0000469 } else if (name.find("MASK") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000470 // ignore (this is a masking move)
Sean Callanan8f993b82010-04-08 00:48:21 +0000471 } else if (name.find("r0") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000472 // ignore (this is a pseudoinstruction)
Sean Callanan8f993b82010-04-08 00:48:21 +0000473 } else if (name.find("PS") != name.npos ||
Sean Callanan95fcebd2010-01-29 00:21:04 +0000474 name.find("PD") != name.npos) {
475 // ignore (this is a shuffling move)
Sean Callanan8f993b82010-04-08 00:48:21 +0000476 } else if (name.find("MOVS") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000477 // ignore (this is a string move)
Sean Callanan8f993b82010-04-08 00:48:21 +0000478 } else if (name.find("_F") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000479 // TODO handle _F moves to ST(0)
Sean Callanan8f993b82010-04-08 00:48:21 +0000480 } else if (name.find("a") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000481 // TODO handle moves to/from %ax
Sean Callanan8f993b82010-04-08 00:48:21 +0000482 } else if (name.find("CMOV") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000483 MOV("src2", "dst");
Sean Callanan8f993b82010-04-08 00:48:21 +0000484 } else if (name.find("PC") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000485 MOV("label", "reg")
Sean Callanan8f993b82010-04-08 00:48:21 +0000486 } else {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000487 MOV("src", "dst");
488 }
489 }
490
491 if (name.find("JMP") != name.npos ||
492 name.find("J") == 0) {
493 if (name.find("FAR") != name.npos && name.find("i") != name.npos) {
494 BRANCH("off");
Sean Callanan8f993b82010-04-08 00:48:21 +0000495 } else {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000496 BRANCH("dst");
497 }
498 }
499
500 if (name.find("PUSH") != name.npos) {
501 if (name.find("FS") != name.npos ||
502 name.find("GS") != name.npos) {
Sean Callanan8f993b82010-04-08 00:48:21 +0000503 instType.set("kInstructionTypePush");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000504 // TODO add support for fixed operands
Sean Callanan8f993b82010-04-08 00:48:21 +0000505 } else if (name.find("F") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000506 // ignore (this pushes onto the FP stack)
Nico Weber50b9efc2010-06-23 20:00:58 +0000507 } else if (name.find("A") != name.npos) {
508 // ignore (pushes all GP registoers onto the stack)
Sean Callanan8f993b82010-04-08 00:48:21 +0000509 } else if (name[name.length() - 1] == 'm') {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000510 PUSH("src");
Sean Callanan8f993b82010-04-08 00:48:21 +0000511 } else if (name.find("i") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000512 PUSH("imm");
Sean Callanan8f993b82010-04-08 00:48:21 +0000513 } else {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000514 PUSH("reg");
515 }
516 }
517
518 if (name.find("POP") != name.npos) {
519 if (name.find("POPCNT") != name.npos) {
520 // ignore (not a real pop)
Sean Callanan8f993b82010-04-08 00:48:21 +0000521 } else if (name.find("FS") != name.npos ||
Sean Callanan95fcebd2010-01-29 00:21:04 +0000522 name.find("GS") != name.npos) {
Sean Callanan8f993b82010-04-08 00:48:21 +0000523 instType.set("kInstructionTypePop");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000524 // TODO add support for fixed operands
Sean Callanan8f993b82010-04-08 00:48:21 +0000525 } else if (name.find("F") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000526 // ignore (this pops from the FP stack)
Nico Weber50b9efc2010-06-23 20:00:58 +0000527 } else if (name.find("A") != name.npos) {
528 // ignore (pushes all GP registoers onto the stack)
Sean Callanan8f993b82010-04-08 00:48:21 +0000529 } else if (name[name.length() - 1] == 'm') {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000530 POP("dst");
Sean Callanan8f993b82010-04-08 00:48:21 +0000531 } else {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000532 POP("reg");
533 }
534 }
535
536 if (name.find("CALL") != name.npos) {
537 if (name.find("ADJ") != name.npos) {
538 // ignore (not a call)
Sean Callanan8f993b82010-04-08 00:48:21 +0000539 } else if (name.find("SYSCALL") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000540 // ignore (doesn't go anywhere we know about)
Sean Callanan8f993b82010-04-08 00:48:21 +0000541 } else if (name.find("VMCALL") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000542 // ignore (rather different semantics than a regular call)
Sean Callanan8f993b82010-04-08 00:48:21 +0000543 } else if (name.find("FAR") != name.npos && name.find("i") != name.npos) {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000544 CALL("off");
Sean Callanan8f993b82010-04-08 00:48:21 +0000545 } else {
Sean Callanan95fcebd2010-01-29 00:21:04 +0000546 CALL("dst");
547 }
548 }
549
550 if (name.find("RET") != name.npos) {
551 RETURN();
552 }
553}
554
555#undef MOV
556#undef BRANCH
557#undef PUSH
558#undef POP
559#undef CALL
560#undef RETURN
561
Sean Callanan8f993b82010-04-08 00:48:21 +0000562/////////////////////////////////////////////////////
563// Support functions for handling ARM instructions //
564/////////////////////////////////////////////////////
565
566#define SET(flag) { type->set(flag); return 0; }
567
568#define REG(str) if (name == str) SET("kOperandTypeRegister");
569#define IMM(str) if (name == str) SET("kOperandTypeImmediate");
570
571#define MISC(str, type) if (name == str) SET(type);
572
573/// ARMFlagFromOpName - Processes the name of a single ARM operand (which is
574/// actually its type) and translates it into an operand type
575///
576/// @arg type - The type object to set
577/// @arg name - The name of the operand
578static int ARMFlagFromOpName(LiteralConstantEmitter *type,
579 const std::string &name) {
580 REG("GPR");
Jim Grosbach6ccfc502010-07-30 02:41:01 +0000581 REG("rGPR");
Dale Johannesen6470a112010-06-15 22:08:33 +0000582 REG("tcGPR");
Sean Callanan8f993b82010-04-08 00:48:21 +0000583 REG("cc_out");
584 REG("s_cc_out");
585 REG("tGPR");
586 REG("DPR");
Sean Callanan8f993b82010-04-08 00:48:21 +0000587 REG("DPR_VFP2");
588 REG("DPR_8");
Evan Chengb63387a2010-05-06 06:36:08 +0000589 REG("SPR");
590 REG("QPR");
591 REG("QQPR");
Evan Cheng22c687b2010-05-14 02:13:41 +0000592 REG("QQQQPR");
Sean Callanan8f993b82010-04-08 00:48:21 +0000593
594 IMM("i32imm");
595 IMM("bf_inv_mask_imm");
596 IMM("jtblock_operand");
597 IMM("nohash_imm");
598 IMM("cpinst_operand");
599 IMM("cps_opt");
600 IMM("vfp_f64imm");
601 IMM("vfp_f32imm");
Johnny Chen1adc40c2010-08-12 20:46:17 +0000602 IMM("memb_opt");
Sean Callanan8f993b82010-04-08 00:48:21 +0000603 IMM("msr_mask");
604 IMM("neg_zero");
605 IMM("imm0_31");
Bob Wilson1a913ed2010-06-11 21:34:50 +0000606 IMM("nModImm");
Sean Callanan8f993b82010-04-08 00:48:21 +0000607 IMM("imm0_4095");
608 IMM("jt2block_operand");
609 IMM("t_imm_s4");
610 IMM("pclabel");
Bob Wilsoneaf1c982010-08-11 23:10:46 +0000611 IMM("sat_shift");
Sean Callanan8f993b82010-04-08 00:48:21 +0000612
613 MISC("brtarget", "kOperandTypeARMBranchTarget"); // ?
614 MISC("so_reg", "kOperandTypeARMSoReg"); // R, R, I
615 MISC("t2_so_reg", "kOperandTypeThumb2SoReg"); // R, I
616 MISC("so_imm", "kOperandTypeARMSoImm"); // I
617 MISC("t2_so_imm", "kOperandTypeThumb2SoImm"); // I
618 MISC("so_imm2part", "kOperandTypeARMSoImm2Part"); // I
619 MISC("pred", "kOperandTypeARMPredicate"); // I, R
620 MISC("it_pred", "kOperandTypeARMPredicate"); // I
621 MISC("addrmode2", "kOperandTypeARMAddrMode2"); // R, R, I
622 MISC("am2offset", "kOperandTypeARMAddrMode2Offset"); // R, I
623 MISC("addrmode3", "kOperandTypeARMAddrMode3"); // R, R, I
624 MISC("am3offset", "kOperandTypeARMAddrMode3Offset"); // R, I
625 MISC("addrmode4", "kOperandTypeARMAddrMode4"); // R, I
626 MISC("addrmode5", "kOperandTypeARMAddrMode5"); // R, I
627 MISC("addrmode6", "kOperandTypeARMAddrMode6"); // R, R, I, I
628 MISC("am6offset", "kOperandTypeARMAddrMode6Offset"); // R, I, I
629 MISC("addrmodepc", "kOperandTypeARMAddrModePC"); // R, I
630 MISC("reglist", "kOperandTypeARMRegisterList"); // I, R, ...
631 MISC("it_mask", "kOperandTypeThumbITMask"); // I
632 MISC("t2addrmode_imm8", "kOperandTypeThumb2AddrModeImm8"); // R, I
633 MISC("t2am_imm8_offset", "kOperandTypeThumb2AddrModeImm8Offset");//I
634 MISC("t2addrmode_imm12", "kOperandTypeThumb2AddrModeImm12"); // R, I
635 MISC("t2addrmode_so_reg", "kOperandTypeThumb2AddrModeSoReg"); // R, R, I
636 MISC("t2addrmode_imm8s4", "kOperandTypeThumb2AddrModeImm8s4"); // R, I
637 MISC("t2am_imm8s4_offset", "kOperandTypeThumb2AddrModeImm8s4Offset");
638 // R, I
639 MISC("tb_addrmode", "kOperandTypeARMTBAddrMode"); // I
640 MISC("t_addrmode_s1", "kOperandTypeThumbAddrModeS1"); // R, I, R
641 MISC("t_addrmode_s2", "kOperandTypeThumbAddrModeS2"); // R, I, R
642 MISC("t_addrmode_s4", "kOperandTypeThumbAddrModeS4"); // R, I, R
643 MISC("t_addrmode_rr", "kOperandTypeThumbAddrModeRR"); // R, R
644 MISC("t_addrmode_sp", "kOperandTypeThumbAddrModeSP"); // R, I
645
646 return 1;
647}
648
649#undef SOREG
650#undef SOIMM
651#undef PRED
652#undef REG
653#undef MEM
654#undef LEA
655#undef IMM
656#undef PCR
657
658#undef SET
659
660/// ARMPopulateOperands - Handles all the operands in an ARM instruction, adding
661/// the appropriate flags to their descriptors
662///
663/// @operandFlags - A reference the array of operand flag objects
664/// @inst - The instruction to use as a source of information
665static void ARMPopulateOperands(
Sean Callanan9899f702010-04-13 21:21:57 +0000666 LiteralConstantEmitter *(&operandTypes)[EDIS_MAX_OPERANDS],
Sean Callanan8f993b82010-04-08 00:48:21 +0000667 const CodeGenInstruction &inst) {
668 if (!inst.TheDef->isSubClassOf("InstARM") &&
669 !inst.TheDef->isSubClassOf("InstThumb"))
670 return;
671
672 unsigned int index;
673 unsigned int numOperands = inst.OperandList.size();
674
Sean Callanan9899f702010-04-13 21:21:57 +0000675 if (numOperands > EDIS_MAX_OPERANDS) {
676 errs() << "numOperands == " << numOperands << " > " <<
677 EDIS_MAX_OPERANDS << '\n';
Sean Callanan8f993b82010-04-08 00:48:21 +0000678 llvm_unreachable("Too many operands");
679 }
680
681 for (index = 0; index < numOperands; ++index) {
682 const CodeGenInstruction::OperandInfo &operandInfo =
683 inst.OperandList[index];
684 Record &rec = *operandInfo.Rec;
685
686 if (ARMFlagFromOpName(operandTypes[index], rec.getName())) {
Benjamin Kramer127dc5e2010-04-08 09:42:29 +0000687 errs() << "Operand type: " << rec.getName() << '\n';
688 errs() << "Operand name: " << operandInfo.Name << '\n';
689 errs() << "Instruction mame: " << inst.TheDef->getName() << '\n';
Sean Callanan8f993b82010-04-08 00:48:21 +0000690 llvm_unreachable("Unhandled type");
691 }
692 }
693}
694
695#define BRANCH(target) { \
696 instType.set("kInstructionTypeBranch"); \
697 DECORATE1(target, "kOperandFlagTarget"); \
698}
699
700/// ARMExtractSemantics - Performs various checks on the name of an ARM
701/// instruction to determine what sort of an instruction it is and then adds
702/// the appropriate flags to the instruction and its operands
703///
704/// @arg instType - A reference to the type for the instruction as a whole
705/// @arg operandTypes - A reference to the array of operand type object pointers
706/// @arg operandFlags - A reference to the array of operand flag object pointers
707/// @arg inst - A reference to the original instruction
708static void ARMExtractSemantics(
709 LiteralConstantEmitter &instType,
Sean Callanan9899f702010-04-13 21:21:57 +0000710 LiteralConstantEmitter *(&operandTypes)[EDIS_MAX_OPERANDS],
711 FlagsConstantEmitter *(&operandFlags)[EDIS_MAX_OPERANDS],
Sean Callanan8f993b82010-04-08 00:48:21 +0000712 const CodeGenInstruction &inst) {
713 const std::string &name = inst.TheDef->getName();
714
715 if (name == "tBcc" ||
716 name == "tB" ||
717 name == "t2Bcc" ||
718 name == "Bcc" ||
719 name == "tCBZ" ||
720 name == "tCBNZ") {
721 BRANCH("target");
722 }
723
724 if (name == "tBLr9" ||
725 name == "BLr9_pred" ||
726 name == "tBLXi_r9" ||
727 name == "tBLXr_r9" ||
728 name == "BLXr9" ||
729 name == "t2BXJ" ||
730 name == "BXJ") {
731 BRANCH("func");
732
733 unsigned opIndex;
734 opIndex = inst.getOperandNamed("func");
735 if (operandTypes[opIndex]->is("kOperandTypeImmediate"))
736 operandTypes[opIndex]->set("kOperandTypeARMBranchTarget");
737 }
738}
739
740#undef BRANCH
Sean Callanan95fcebd2010-01-29 00:21:04 +0000741
742/// populateInstInfo - Fills an array of InstInfos with information about each
743/// instruction in a target
744///
745/// @arg infoArray - The array of InstInfo objects to populate
746/// @arg target - The CodeGenTarget to use as a source of instructions
747static void populateInstInfo(CompoundConstantEmitter &infoArray,
748 CodeGenTarget &target) {
Chris Lattnerf6502782010-03-19 00:34:35 +0000749 const std::vector<const CodeGenInstruction*> &numberedInstructions =
750 target.getInstructionsByEnumValue();
Sean Callanan95fcebd2010-01-29 00:21:04 +0000751
752 unsigned int index;
753 unsigned int numInstructions = numberedInstructions.size();
754
755 for (index = 0; index < numInstructions; ++index) {
756 const CodeGenInstruction& inst = *numberedInstructions[index];
757
758 CompoundConstantEmitter *infoStruct = new CompoundConstantEmitter;
759 infoArray.addEntry(infoStruct);
760
Sean Callanan8f993b82010-04-08 00:48:21 +0000761 LiteralConstantEmitter *instType = new LiteralConstantEmitter;
762 infoStruct->addEntry(instType);
Sean Callanan95fcebd2010-01-29 00:21:04 +0000763
764 LiteralConstantEmitter *numOperandsEmitter =
765 new LiteralConstantEmitter(inst.OperandList.size());
766 infoStruct->addEntry(numOperandsEmitter);
Sean Callanan8f993b82010-04-08 00:48:21 +0000767
768 CompoundConstantEmitter *operandTypeArray = new CompoundConstantEmitter;
769 infoStruct->addEntry(operandTypeArray);
770
Sean Callanan9899f702010-04-13 21:21:57 +0000771 LiteralConstantEmitter *operandTypes[EDIS_MAX_OPERANDS];
Sean Callanan95fcebd2010-01-29 00:21:04 +0000772
773 CompoundConstantEmitter *operandFlagArray = new CompoundConstantEmitter;
774 infoStruct->addEntry(operandFlagArray);
775
Sean Callanan9899f702010-04-13 21:21:57 +0000776 FlagsConstantEmitter *operandFlags[EDIS_MAX_OPERANDS];
Sean Callanan95fcebd2010-01-29 00:21:04 +0000777
Sean Callanan8f993b82010-04-08 00:48:21 +0000778 for (unsigned operandIndex = 0;
Sean Callanan9899f702010-04-13 21:21:57 +0000779 operandIndex < EDIS_MAX_OPERANDS;
Sean Callanan8f993b82010-04-08 00:48:21 +0000780 ++operandIndex) {
781 operandTypes[operandIndex] = new LiteralConstantEmitter;
782 operandTypeArray->addEntry(operandTypes[operandIndex]);
783
Sean Callanan95fcebd2010-01-29 00:21:04 +0000784 operandFlags[operandIndex] = new FlagsConstantEmitter;
785 operandFlagArray->addEntry(operandFlags[operandIndex]);
786 }
787
788 unsigned numSyntaxes = 0;
789
790 if (target.getName() == "X86") {
Sean Callanan8f993b82010-04-08 00:48:21 +0000791 X86PopulateOperands(operandTypes, inst);
792 X86ExtractSemantics(*instType, operandFlags, inst);
Sean Callanan95fcebd2010-01-29 00:21:04 +0000793 numSyntaxes = 2;
794 }
Sean Callanan8f993b82010-04-08 00:48:21 +0000795 else if (target.getName() == "ARM") {
796 ARMPopulateOperands(operandTypes, inst);
797 ARMExtractSemantics(*instType, operandTypes, operandFlags, inst);
798 numSyntaxes = 1;
799 }
Sean Callanan95fcebd2010-01-29 00:21:04 +0000800
Sean Callanan8f993b82010-04-08 00:48:21 +0000801 CompoundConstantEmitter *operandOrderArray = new CompoundConstantEmitter;
802
Sean Callanan95fcebd2010-01-29 00:21:04 +0000803 infoStruct->addEntry(operandOrderArray);
804
Sean Callanan9899f702010-04-13 21:21:57 +0000805 for (unsigned syntaxIndex = 0;
806 syntaxIndex < EDIS_MAX_SYNTAXES;
807 ++syntaxIndex) {
Sean Callanan8f993b82010-04-08 00:48:21 +0000808 CompoundConstantEmitter *operandOrder =
Sean Callanan9899f702010-04-13 21:21:57 +0000809 new CompoundConstantEmitter(EDIS_MAX_OPERANDS);
Sean Callanan8f993b82010-04-08 00:48:21 +0000810
Sean Callanan95fcebd2010-01-29 00:21:04 +0000811 operandOrderArray->addEntry(operandOrder);
812
813 if (syntaxIndex < numSyntaxes) {
Sean Callanan2db6ff22010-02-10 02:47:08 +0000814 populateOperandOrder(operandOrder, inst, syntaxIndex);
Sean Callanan95fcebd2010-01-29 00:21:04 +0000815 }
Sean Callanan95fcebd2010-01-29 00:21:04 +0000816 }
Sean Callanan8f993b82010-04-08 00:48:21 +0000817
818 infoStruct = NULL;
Sean Callanan95fcebd2010-01-29 00:21:04 +0000819 }
820}
821
Sean Callanan9899f702010-04-13 21:21:57 +0000822static void emitCommonEnums(raw_ostream &o, unsigned int &i) {
Sean Callanan8f993b82010-04-08 00:48:21 +0000823 EnumEmitter operandTypes("OperandTypes");
824 operandTypes.addEntry("kOperandTypeNone");
825 operandTypes.addEntry("kOperandTypeImmediate");
826 operandTypes.addEntry("kOperandTypeRegister");
827 operandTypes.addEntry("kOperandTypeX86Memory");
828 operandTypes.addEntry("kOperandTypeX86EffectiveAddress");
829 operandTypes.addEntry("kOperandTypeX86PCRelative");
830 operandTypes.addEntry("kOperandTypeARMBranchTarget");
831 operandTypes.addEntry("kOperandTypeARMSoReg");
832 operandTypes.addEntry("kOperandTypeARMSoImm");
833 operandTypes.addEntry("kOperandTypeARMSoImm2Part");
834 operandTypes.addEntry("kOperandTypeARMPredicate");
835 operandTypes.addEntry("kOperandTypeARMAddrMode2");
836 operandTypes.addEntry("kOperandTypeARMAddrMode2Offset");
837 operandTypes.addEntry("kOperandTypeARMAddrMode3");
838 operandTypes.addEntry("kOperandTypeARMAddrMode3Offset");
839 operandTypes.addEntry("kOperandTypeARMAddrMode4");
840 operandTypes.addEntry("kOperandTypeARMAddrMode5");
841 operandTypes.addEntry("kOperandTypeARMAddrMode6");
842 operandTypes.addEntry("kOperandTypeARMAddrMode6Offset");
843 operandTypes.addEntry("kOperandTypeARMAddrModePC");
844 operandTypes.addEntry("kOperandTypeARMRegisterList");
845 operandTypes.addEntry("kOperandTypeARMTBAddrMode");
846 operandTypes.addEntry("kOperandTypeThumbITMask");
847 operandTypes.addEntry("kOperandTypeThumbAddrModeS1");
848 operandTypes.addEntry("kOperandTypeThumbAddrModeS2");
849 operandTypes.addEntry("kOperandTypeThumbAddrModeS4");
850 operandTypes.addEntry("kOperandTypeThumbAddrModeRR");
851 operandTypes.addEntry("kOperandTypeThumbAddrModeSP");
852 operandTypes.addEntry("kOperandTypeThumb2SoReg");
853 operandTypes.addEntry("kOperandTypeThumb2SoImm");
854 operandTypes.addEntry("kOperandTypeThumb2AddrModeImm8");
855 operandTypes.addEntry("kOperandTypeThumb2AddrModeImm8Offset");
856 operandTypes.addEntry("kOperandTypeThumb2AddrModeImm12");
857 operandTypes.addEntry("kOperandTypeThumb2AddrModeSoReg");
858 operandTypes.addEntry("kOperandTypeThumb2AddrModeImm8s4");
859 operandTypes.addEntry("kOperandTypeThumb2AddrModeImm8s4Offset");
Sean Callanan8f993b82010-04-08 00:48:21 +0000860 operandTypes.emit(o, i);
861
862 o << "\n";
863
Sean Callanan95fcebd2010-01-29 00:21:04 +0000864 EnumEmitter operandFlags("OperandFlags");
Sean Callanan95fcebd2010-01-29 00:21:04 +0000865 operandFlags.addEntry("kOperandFlagSource");
866 operandFlags.addEntry("kOperandFlagTarget");
867 operandFlags.emitAsFlags(o, i);
868
869 o << "\n";
870
Sean Callanan8f993b82010-04-08 00:48:21 +0000871 EnumEmitter instructionTypes("InstructionTypes");
872 instructionTypes.addEntry("kInstructionTypeNone");
873 instructionTypes.addEntry("kInstructionTypeMove");
874 instructionTypes.addEntry("kInstructionTypeBranch");
875 instructionTypes.addEntry("kInstructionTypePush");
876 instructionTypes.addEntry("kInstructionTypePop");
877 instructionTypes.addEntry("kInstructionTypeCall");
878 instructionTypes.addEntry("kInstructionTypeReturn");
879 instructionTypes.emit(o, i);
Sean Callanan95fcebd2010-01-29 00:21:04 +0000880
881 o << "\n";
Sean Callanan9899f702010-04-13 21:21:57 +0000882}
883
884void EDEmitter::run(raw_ostream &o) {
885 unsigned int i = 0;
Sean Callanan95fcebd2010-01-29 00:21:04 +0000886
Sean Callanan9899f702010-04-13 21:21:57 +0000887 CompoundConstantEmitter infoArray;
888 CodeGenTarget target;
889
890 populateInstInfo(infoArray, target);
891
892 emitCommonEnums(o, i);
893
894 o << "namespace {\n";
895
896 o << "llvm::EDInstInfo instInfo" << target.getName().c_str() << "[] = ";
897 infoArray.emit(o, i);
898 o << ";" << "\n";
899
900 o << "}\n";
901}