blob: 7b69de56f9f746dba160c1b176e0184ebd719eb7 [file] [log] [blame]
Chris Lattnerf5bd1b72003-10-05 19:27:59 +00001//===- InstrInfoEmitter.cpp - Generate a Instruction Set Desc. ------------===//
Misha Brukman650ba8e2005-04-22 00:00:37 +00002//
John Criswelld3032032003-10-20 20:20:30 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner8adcd9f2007-12-29 20:37:13 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman650ba8e2005-04-22 00:00:37 +00007//
John Criswelld3032032003-10-20 20:20:30 +00008//===----------------------------------------------------------------------===//
Chris Lattnerf5bd1b72003-10-05 19:27:59 +00009//
10// This tablegen backend is responsible for emitting a description of the target
11// instruction set for the code generator.
12//
13//===----------------------------------------------------------------------===//
14
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +000015
16#include "CodeGenDAGPatterns.h"
Andrew Trick87255e32012-07-07 04:00:00 +000017#include "CodeGenSchedule.h"
Chris Lattnerfce96032004-08-01 04:04:35 +000018#include "CodeGenTarget.h"
Craig Topper91773ab2012-04-01 18:14:14 +000019#include "SequenceToOffsetTable.h"
Chandler Carruth91d19d82012-12-04 10:37:14 +000020#include "TableGenBackends.h"
Chris Lattner06fa1762009-08-24 03:52:50 +000021#include "llvm/ADT/StringExtras.h"
Joerg Sonnenberger635debe2012-10-25 20:33:17 +000022#include "llvm/TableGen/Error.h"
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +000023#include "llvm/TableGen/Record.h"
24#include "llvm/TableGen/TableGenBackend.h"
Jeff Cohen9e1784d2005-11-01 18:04:06 +000025#include <algorithm>
Benjamin Kramerb0640db2012-03-23 11:35:30 +000026#include <cstdio>
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +000027#include <map>
28#include <vector>
Chris Lattner68478662004-08-01 03:55:39 +000029using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000030
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +000031namespace {
32class InstrInfoEmitter {
33 RecordKeeper &Records;
34 CodeGenDAGPatterns CDP;
Andrew Trick87255e32012-07-07 04:00:00 +000035 const CodeGenSchedModels &SchedModels;
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +000036
37public:
Andrew Trick87255e32012-07-07 04:00:00 +000038 InstrInfoEmitter(RecordKeeper &R):
39 Records(R), CDP(R), SchedModels(CDP.getTargetInfo().getSchedModels()) {}
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +000040
41 // run - Output the instruction set description.
42 void run(raw_ostream &OS);
43
44private:
45 void emitEnums(raw_ostream &OS);
46
47 typedef std::map<std::vector<std::string>, unsigned> OperandInfoMapTy;
Tom Stellardb162d942013-06-25 21:22:09 +000048
49 /// The keys of this map are maps which have OpName enum values as their keys
50 /// and instruction operand indices as their values. The values of this map
51 /// are lists of instruction names.
52 typedef std::map<std::map<unsigned, unsigned>,
53 std::vector<std::string> > OpNameMapTy;
54 typedef std::map<std::string, unsigned>::iterator StrUintMapIter;
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +000055 void emitRecord(const CodeGenInstruction &Inst, unsigned Num,
56 Record *InstrInfo,
57 std::map<std::vector<Record*>, unsigned> &EL,
58 const OperandInfoMapTy &OpInfo,
59 raw_ostream &OS);
Ahmed Bougacha31377592013-11-17 21:24:41 +000060 void emitOperandTypesEnum(raw_ostream &OS, const CodeGenTarget &Target);
Tom Stellardb162d942013-06-25 21:22:09 +000061 void initOperandMapData(
Craig Topper65efcb42014-02-05 07:27:49 +000062 const std::vector<const CodeGenInstruction *> &NumberedInstructions,
63 const std::string &Namespace,
64 std::map<std::string, unsigned> &Operands,
65 OpNameMapTy &OperandMap);
Tom Stellardb162d942013-06-25 21:22:09 +000066 void emitOperandNameMappings(raw_ostream &OS, const CodeGenTarget &Target,
67 const std::vector<const CodeGenInstruction*> &NumberedInstructions);
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +000068
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +000069 // Operand information.
70 void EmitOperandInfo(raw_ostream &OS, OperandInfoMapTy &OperandInfoIDs);
71 std::vector<std::string> GetOperandInfo(const CodeGenInstruction &Inst);
72};
73} // End anonymous namespace
74
Chris Lattner85467a12008-01-06 01:21:51 +000075static void PrintDefList(const std::vector<Record*> &Uses,
Daniel Dunbar38a22bf2009-07-03 00:10:29 +000076 unsigned Num, raw_ostream &OS) {
Craig Topper5a4bcc72012-03-08 08:22:45 +000077 OS << "static const uint16_t ImplicitList" << Num << "[] = { ";
Chris Lattner99df6682005-08-18 21:36:47 +000078 for (unsigned i = 0, e = Uses.size(); i != e; ++i)
79 OS << getQualifiedName(Uses[i]) << ", ";
Chris Lattnerf5bd1b72003-10-05 19:27:59 +000080 OS << "0 };\n";
81}
82
Chris Lattner626b89d2008-01-06 01:20:13 +000083//===----------------------------------------------------------------------===//
Chris Lattner626b89d2008-01-06 01:20:13 +000084// Operand Info Emission.
85//===----------------------------------------------------------------------===//
86
Chris Lattner33f5a512006-11-06 23:49:51 +000087std::vector<std::string>
88InstrInfoEmitter::GetOperandInfo(const CodeGenInstruction &Inst) {
89 std::vector<std::string> Result;
Owen Andersona84be6c2011-06-27 21:06:21 +000090
Jim Grosbach5198f3e92014-04-18 02:09:07 +000091 for (auto &Op : Inst.Operands) {
Chris Lattnerba7b3672006-11-10 02:01:40 +000092 // Handle aggregate operands and normal operands the same way by expanding
93 // either case into a list of operands for this op.
Chris Lattnerd8adec72010-11-01 04:03:32 +000094 std::vector<CGIOperandList::OperandInfo> OperandList;
Chris Lattner33f5a512006-11-06 23:49:51 +000095
Chris Lattnerba7b3672006-11-10 02:01:40 +000096 // This might be a multiple operand thing. Targets like X86 have
97 // registers in their multi-operand operands. It may also be an anonymous
98 // operand, which has a single operand, but no declared class for the
99 // operand.
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000100 DagInit *MIOI = Op.MIOperandInfo;
Owen Andersona84be6c2011-06-27 21:06:21 +0000101
Chris Lattnerba7b3672006-11-10 02:01:40 +0000102 if (!MIOI || MIOI->getNumArgs() == 0) {
103 // Single, anonymous, operand.
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000104 OperandList.push_back(Op);
Chris Lattner6bc03042005-11-19 07:05:57 +0000105 } else {
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000106 for (unsigned j = 0, e = Op.MINumOperands; j != e; ++j) {
107 OperandList.push_back(Op);
Chris Lattner33f5a512006-11-06 23:49:51 +0000108
Sean Silva88eb8dd2012-10-10 20:24:47 +0000109 Record *OpR = cast<DefInit>(MIOI->getArg(j))->getDef();
Chris Lattnerba7b3672006-11-10 02:01:40 +0000110 OperandList.back().Rec = OpR;
Chris Lattner6bc03042005-11-19 07:05:57 +0000111 }
Chris Lattnerd02bd5b2005-08-19 18:46:26 +0000112 }
Chris Lattnerba7b3672006-11-10 02:01:40 +0000113
114 for (unsigned j = 0, e = OperandList.size(); j != e; ++j) {
115 Record *OpR = OperandList[j].Rec;
116 std::string Res;
Owen Andersona84be6c2011-06-27 21:06:21 +0000117
118 if (OpR->isSubClassOf("RegisterOperand"))
119 OpR = OpR->getValueAsDef("RegClass");
Chris Lattnerba7b3672006-11-10 02:01:40 +0000120 if (OpR->isSubClassOf("RegisterClass"))
121 Res += getQualifiedName(OpR) + "RegClassID, ";
Chris Lattnerf3239532009-07-29 21:10:12 +0000122 else if (OpR->isSubClassOf("PointerLikeRegClass"))
123 Res += utostr(OpR->getValueAsInt("RegClassKind")) + ", ";
Chris Lattnerba7b3672006-11-10 02:01:40 +0000124 else
Dan Gohman882bb292010-06-18 18:13:55 +0000125 // -1 means the operand does not have a fixed register class.
126 Res += "-1, ";
Owen Andersona84be6c2011-06-27 21:06:21 +0000127
Chris Lattnerba7b3672006-11-10 02:01:40 +0000128 // Fill in applicable flags.
129 Res += "0";
Owen Andersona84be6c2011-06-27 21:06:21 +0000130
Chris Lattnerba7b3672006-11-10 02:01:40 +0000131 // Ptr value whose register class is resolved via callback.
Chris Lattner426bc7c2009-07-29 20:43:05 +0000132 if (OpR->isSubClassOf("PointerLikeRegClass"))
Evan Cheng6cc775f2011-06-28 19:10:37 +0000133 Res += "|(1<<MCOI::LookupPtrRegClass)";
Chris Lattnerba7b3672006-11-10 02:01:40 +0000134
135 // Predicate operands. Check to see if the original unexpanded operand
Tim Northover42180442013-08-22 09:57:11 +0000136 // was of type PredicateOp.
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000137 if (Op.Rec->isSubClassOf("PredicateOp"))
Evan Cheng6cc775f2011-06-28 19:10:37 +0000138 Res += "|(1<<MCOI::Predicate)";
Owen Andersona84be6c2011-06-27 21:06:21 +0000139
Evan Cheng6e3c7052007-07-10 18:05:01 +0000140 // Optional def operands. Check to see if the original unexpanded operand
141 // was of type OptionalDefOperand.
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000142 if (Op.Rec->isSubClassOf("OptionalDefOperand"))
Evan Cheng6cc775f2011-06-28 19:10:37 +0000143 Res += "|(1<<MCOI::OptionalDef)";
Evan Cheng6e3c7052007-07-10 18:05:01 +0000144
Craig Topperb3584992012-03-11 01:57:56 +0000145 // Fill in operand type.
Tom Stellard89b26102015-01-12 19:33:09 +0000146 Res += ", ";
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000147 assert(!Op.OperandType.empty() && "Invalid operand type.");
148 Res += Op.OperandType;
Craig Topperb3584992012-03-11 01:57:56 +0000149
Chris Lattnerba7b3672006-11-10 02:01:40 +0000150 // Fill in constraint info.
Chris Lattnera9dfb1b2010-02-10 01:45:28 +0000151 Res += ", ";
Owen Andersona84be6c2011-06-27 21:06:21 +0000152
Chris Lattnerd8adec72010-11-01 04:03:32 +0000153 const CGIOperandList::ConstraintInfo &Constraint =
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000154 Op.Constraints[j];
Chris Lattnera9dfb1b2010-02-10 01:45:28 +0000155 if (Constraint.isNone())
156 Res += "0";
157 else if (Constraint.isEarlyClobber())
Evan Cheng6cc775f2011-06-28 19:10:37 +0000158 Res += "(1 << MCOI::EARLY_CLOBBER)";
Chris Lattnera9dfb1b2010-02-10 01:45:28 +0000159 else {
160 assert(Constraint.isTied());
161 Res += "((" + utostr(Constraint.getTiedOperand()) +
Evan Cheng6cc775f2011-06-28 19:10:37 +0000162 " << 16) | (1 << MCOI::TIED_TO))";
Chris Lattnera9dfb1b2010-02-10 01:45:28 +0000163 }
Owen Andersona84be6c2011-06-27 21:06:21 +0000164
Chris Lattnerba7b3672006-11-10 02:01:40 +0000165 Result.push_back(Res);
166 }
Chris Lattnerd02bd5b2005-08-19 18:46:26 +0000167 }
Evan Chengac79c7c2006-11-01 00:27:05 +0000168
Chris Lattnerd02bd5b2005-08-19 18:46:26 +0000169 return Result;
170}
171
Owen Andersona84be6c2011-06-27 21:06:21 +0000172void InstrInfoEmitter::EmitOperandInfo(raw_ostream &OS,
Chris Lattner626b89d2008-01-06 01:20:13 +0000173 OperandInfoMapTy &OperandInfoIDs) {
174 // ID #0 is for no operand info.
175 unsigned OperandListNum = 0;
176 OperandInfoIDs[std::vector<std::string>()] = ++OperandListNum;
Owen Andersona84be6c2011-06-27 21:06:21 +0000177
Chris Lattner626b89d2008-01-06 01:20:13 +0000178 OS << "\n";
179 const CodeGenTarget &Target = CDP.getTargetInfo();
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000180 for (const CodeGenInstruction *Inst : Target.instructions()) {
181 std::vector<std::string> OperandInfo = GetOperandInfo(*Inst);
Chris Lattner626b89d2008-01-06 01:20:13 +0000182 unsigned &N = OperandInfoIDs[OperandInfo];
183 if (N != 0) continue;
Owen Andersona84be6c2011-06-27 21:06:21 +0000184
Chris Lattner626b89d2008-01-06 01:20:13 +0000185 N = ++OperandListNum;
Evan Cheng6cc775f2011-06-28 19:10:37 +0000186 OS << "static const MCOperandInfo OperandInfo" << N << "[] = { ";
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000187 for (const std::string &Info : OperandInfo)
188 OS << "{ " << Info << " }, ";
Chris Lattner626b89d2008-01-06 01:20:13 +0000189 OS << "};\n";
190 }
191}
192
Tom Stellardb162d942013-06-25 21:22:09 +0000193
194/// Initialize data structures for generating operand name mappings.
195///
196/// \param Operands [out] A map used to generate the OpName enum with operand
197/// names as its keys and operand enum values as its values.
198/// \param OperandMap [out] A map for representing the operand name mappings for
199/// each instructions. This is used to generate the OperandMap table as
200/// well as the getNamedOperandIdx() function.
201void InstrInfoEmitter::initOperandMapData(
Craig Topper65efcb42014-02-05 07:27:49 +0000202 const std::vector<const CodeGenInstruction *> &NumberedInstructions,
Tom Stellardb162d942013-06-25 21:22:09 +0000203 const std::string &Namespace,
204 std::map<std::string, unsigned> &Operands,
205 OpNameMapTy &OperandMap) {
206
207 unsigned NumOperands = 0;
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000208 for (const CodeGenInstruction *Inst : NumberedInstructions) {
209 if (!Inst->TheDef->getValueAsBit("UseNamedOperandTable"))
Tom Stellardb162d942013-06-25 21:22:09 +0000210 continue;
Tom Stellardb162d942013-06-25 21:22:09 +0000211 std::map<unsigned, unsigned> OpList;
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000212 for (const auto &Info : Inst->Operands) {
Tom Stellardb162d942013-06-25 21:22:09 +0000213 StrUintMapIter I = Operands.find(Info.Name);
214
215 if (I == Operands.end()) {
216 I = Operands.insert(Operands.begin(),
217 std::pair<std::string, unsigned>(Info.Name, NumOperands++));
218 }
219 OpList[I->second] = Info.MIOperandNo;
220 }
221 OperandMap[OpList].push_back(Namespace + "::" + Inst->TheDef->getName());
222 }
223}
224
225/// Generate a table and function for looking up the indices of operands by
226/// name.
227///
228/// This code generates:
229/// - An enum in the llvm::TargetNamespace::OpName namespace, with one entry
230/// for each operand name.
231/// - A 2-dimensional table called OperandMap for mapping OpName enum values to
232/// operand indices.
233/// - A function called getNamedOperandIdx(uint16_t Opcode, uint16_t NamedIdx)
234/// for looking up the operand index for an instruction, given a value from
235/// OpName enum
236void InstrInfoEmitter::emitOperandNameMappings(raw_ostream &OS,
237 const CodeGenTarget &Target,
238 const std::vector<const CodeGenInstruction*> &NumberedInstructions) {
239
240 const std::string &Namespace = Target.getInstNamespace();
241 std::string OpNameNS = "OpName";
242 // Map of operand names to their enumeration value. This will be used to
243 // generate the OpName enum.
244 std::map<std::string, unsigned> Operands;
245 OpNameMapTy OperandMap;
246
247 initOperandMapData(NumberedInstructions, Namespace, Operands, OperandMap);
248
249 OS << "#ifdef GET_INSTRINFO_OPERAND_ENUM\n";
250 OS << "#undef GET_INSTRINFO_OPERAND_ENUM\n";
Eric Christopher69c0a7c2015-03-13 01:10:08 +0000251 OS << "namespace llvm {\n";
Tom Stellardb162d942013-06-25 21:22:09 +0000252 OS << "namespace " << Namespace << " {\n";
253 OS << "namespace " << OpNameNS << " { \n";
254 OS << "enum {\n";
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000255 for (const auto &Op : Operands)
256 OS << " " << Op.first << " = " << Op.second << ",\n";
Tom Stellardb162d942013-06-25 21:22:09 +0000257
258 OS << "OPERAND_LAST";
259 OS << "\n};\n";
260 OS << "} // End namespace OpName\n";
261 OS << "} // End namespace " << Namespace << "\n";
262 OS << "} // End namespace llvm\n";
263 OS << "#endif //GET_INSTRINFO_OPERAND_ENUM\n";
264
265 OS << "#ifdef GET_INSTRINFO_NAMED_OPS\n";
266 OS << "#undef GET_INSTRINFO_NAMED_OPS\n";
Eric Christopher69c0a7c2015-03-13 01:10:08 +0000267 OS << "namespace llvm {\n";
Tom Stellardb162d942013-06-25 21:22:09 +0000268 OS << "namespace " << Namespace << " {\n";
Matt Arsenault41e14812014-08-01 17:00:27 +0000269 OS << "LLVM_READONLY\n";
Tom Stellardb162d942013-06-25 21:22:09 +0000270 OS << "int16_t getNamedOperandIdx(uint16_t Opcode, uint16_t NamedIdx) {\n";
Aaron Ballmane59e3582013-07-15 16:53:32 +0000271 if (!Operands.empty()) {
272 OS << " static const int16_t OperandMap [][" << Operands.size()
273 << "] = {\n";
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000274 for (const auto &Entry : OperandMap) {
275 const std::map<unsigned, unsigned> &OpList = Entry.first;
Aaron Ballmane59e3582013-07-15 16:53:32 +0000276 OS << "{";
Tom Stellardb162d942013-06-25 21:22:09 +0000277
Aaron Ballmane59e3582013-07-15 16:53:32 +0000278 // Emit a row of the OperandMap table
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000279 for (unsigned i = 0, e = Operands.size(); i != e; ++i)
280 OS << (OpList.count(i) == 0 ? -1 : (int)OpList.find(i)->second) << ", ";
Tom Stellardb162d942013-06-25 21:22:09 +0000281
Aaron Ballmane59e3582013-07-15 16:53:32 +0000282 OS << "},\n";
283 }
284 OS << "};\n";
285
286 OS << " switch(Opcode) {\n";
287 unsigned TableIndex = 0;
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000288 for (const auto &Entry : OperandMap) {
289 for (const std::string &Name : Entry.second)
290 OS << " case " << Name << ":\n";
Aaron Ballmane59e3582013-07-15 16:53:32 +0000291
292 OS << " return OperandMap[" << TableIndex++ << "][NamedIdx];\n";
293 }
294 OS << " default: return -1;\n";
295 OS << " }\n";
296 } else {
297 // There are no operands, so no need to emit anything
298 OS << " return -1;\n";
Tom Stellardb162d942013-06-25 21:22:09 +0000299 }
Tom Stellardb162d942013-06-25 21:22:09 +0000300 OS << "}\n";
301 OS << "} // End namespace " << Namespace << "\n";
302 OS << "} // End namespace llvm\n";
303 OS << "#endif //GET_INSTRINFO_NAMED_OPS\n";
304
305}
306
Ahmed Bougacha31377592013-11-17 21:24:41 +0000307/// Generate an enum for all the operand types for this target, under the
308/// llvm::TargetNamespace::OpTypes namespace.
309/// Operand types are all definitions derived of the Operand Target.td class.
310void InstrInfoEmitter::emitOperandTypesEnum(raw_ostream &OS,
311 const CodeGenTarget &Target) {
312
313 const std::string &Namespace = Target.getInstNamespace();
314 std::vector<Record *> Operands = Records.getAllDerivedDefinitions("Operand");
315
316 OS << "\n#ifdef GET_INSTRINFO_OPERAND_TYPES_ENUM\n";
317 OS << "#undef GET_INSTRINFO_OPERAND_TYPES_ENUM\n";
Eric Christopher69c0a7c2015-03-13 01:10:08 +0000318 OS << "namespace llvm {\n";
Ahmed Bougacha31377592013-11-17 21:24:41 +0000319 OS << "namespace " << Namespace << " {\n";
320 OS << "namespace OpTypes { \n";
321 OS << "enum OperandType {\n";
322
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000323 unsigned EnumVal = 0;
324 for (const Record *Op : Operands) {
325 if (!Op->isAnonymous())
326 OS << " " << Op->getName() << " = " << EnumVal << ",\n";
327 ++EnumVal;
Ahmed Bougacha31377592013-11-17 21:24:41 +0000328 }
329
330 OS << " OPERAND_TYPE_LIST_END" << "\n};\n";
331 OS << "} // End namespace OpTypes\n";
332 OS << "} // End namespace " << Namespace << "\n";
333 OS << "} // End namespace llvm\n";
334 OS << "#endif // GET_INSTRINFO_OPERAND_TYPES_ENUM\n";
335}
336
Chris Lattner626b89d2008-01-06 01:20:13 +0000337//===----------------------------------------------------------------------===//
338// Main Output.
339//===----------------------------------------------------------------------===//
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000340
341// run - Emit the main instruction description records for the target...
Daniel Dunbar38a22bf2009-07-03 00:10:29 +0000342void InstrInfoEmitter::run(raw_ostream &OS) {
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +0000343 emitSourceFileHeader("Target Instruction Enum Values", OS);
Evan Cheng1e210d02011-06-28 20:07:07 +0000344 emitEnums(OS);
345
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +0000346 emitSourceFileHeader("Target Instruction Descriptors", OS);
Evan Cheng1e210d02011-06-28 20:07:07 +0000347
348 OS << "\n#ifdef GET_INSTRINFO_MC_DESC\n";
349 OS << "#undef GET_INSTRINFO_MC_DESC\n";
350
Chris Lattnerc9d99ef2004-08-17 03:08:28 +0000351 OS << "namespace llvm {\n\n";
352
Dan Gohmanfc4ad7de2008-04-03 00:02:49 +0000353 CodeGenTarget &Target = CDP.getTargetInfo();
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000354 const std::string &TargetName = Target.getName();
355 Record *InstrInfo = Target.getInstructionSet();
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000356
Chris Lattner99df6682005-08-18 21:36:47 +0000357 // Keep track of all of the def lists we have emitted already.
358 std::map<std::vector<Record*>, unsigned> EmittedLists;
Chris Lattner99df6682005-08-18 21:36:47 +0000359 unsigned ListNumber = 0;
Owen Andersona84be6c2011-06-27 21:06:21 +0000360
Chris Lattner99df6682005-08-18 21:36:47 +0000361 // Emit all of the instruction's implicit uses and defs.
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000362 for (const CodeGenInstruction *II : Target.instructions()) {
363 Record *Inst = II->TheDef;
Chris Lattner742606a2005-10-28 22:59:53 +0000364 std::vector<Record*> Uses = Inst->getValueAsListOfDefs("Uses");
365 if (!Uses.empty()) {
Chris Lattner99df6682005-08-18 21:36:47 +0000366 unsigned &IL = EmittedLists[Uses];
Chris Lattner85467a12008-01-06 01:21:51 +0000367 if (!IL) PrintDefList(Uses, IL = ++ListNumber, OS);
Chris Lattner99df6682005-08-18 21:36:47 +0000368 }
Chris Lattner742606a2005-10-28 22:59:53 +0000369 std::vector<Record*> Defs = Inst->getValueAsListOfDefs("Defs");
370 if (!Defs.empty()) {
371 unsigned &IL = EmittedLists[Defs];
Chris Lattner85467a12008-01-06 01:21:51 +0000372 if (!IL) PrintDefList(Defs, IL = ++ListNumber, OS);
Chris Lattner99df6682005-08-18 21:36:47 +0000373 }
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000374 }
375
Chris Lattner626b89d2008-01-06 01:20:13 +0000376 OperandInfoMapTy OperandInfoIDs;
Owen Andersona84be6c2011-06-27 21:06:21 +0000377
Chris Lattner220d0012005-08-19 16:57:28 +0000378 // Emit all of the operand info records.
Chris Lattner626b89d2008-01-06 01:20:13 +0000379 EmitOperandInfo(OS, OperandInfoIDs);
Owen Andersona84be6c2011-06-27 21:06:21 +0000380
Evan Cheng6cc775f2011-06-28 19:10:37 +0000381 // Emit all of the MCInstrDesc records in their ENUM ordering.
Chris Lattner220d0012005-08-19 16:57:28 +0000382 //
Benjamin Kramer0d6d0982011-10-22 16:50:00 +0000383 OS << "\nextern const MCInstrDesc " << TargetName << "Insts[] = {\n";
Chris Lattner918be522010-03-19 00:34:35 +0000384 const std::vector<const CodeGenInstruction*> &NumberedInstructions =
385 Target.getInstructionsByEnumValue();
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000386
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000387 SequenceToOffsetTable<std::string> InstrNames;
388 unsigned Num = 0;
389 for (const CodeGenInstruction *Inst : NumberedInstructions) {
390 // Keep a list of the instruction names.
391 InstrNames.add(Inst->TheDef->getName());
392 // Emit the record into the table.
393 emitRecord(*Inst, Num++, InstrInfo, EmittedLists, OperandInfoIDs, OS);
394 }
Evan Chengdf8974e2011-06-28 20:29:03 +0000395 OS << "};\n\n";
396
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000397 // Emit the array of instruction names.
Craig Topper91773ab2012-04-01 18:14:14 +0000398 InstrNames.layout();
399 OS << "extern const char " << TargetName << "InstrNameData[] = {\n";
400 InstrNames.emit(OS, printChar);
401 OS << "};\n\n";
402
403 OS << "extern const unsigned " << TargetName <<"InstrNameIndices[] = {";
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000404 Num = 0;
405 for (const CodeGenInstruction *Inst : NumberedInstructions) {
406 // Newline every eight entries.
407 if (Num % 8 == 0)
Benjamin Kramerbf152d52012-02-10 13:18:44 +0000408 OS << "\n ";
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000409 OS << InstrNames.get(Inst->TheDef->getName()) << "U, ";
410 ++Num;
Benjamin Kramerbf152d52012-02-10 13:18:44 +0000411 }
412
413 OS << "\n};\n\n";
414
Evan Chengdf8974e2011-06-28 20:29:03 +0000415 // MCInstrInfo initialization routine.
416 OS << "static inline void Init" << TargetName
417 << "MCInstrInfo(MCInstrInfo *II) {\n";
418 OS << " II->InitMCInstrInfo(" << TargetName << "Insts, "
Benjamin Kramerbf152d52012-02-10 13:18:44 +0000419 << TargetName << "InstrNameIndices, " << TargetName << "InstrNameData, "
Evan Chengdf8974e2011-06-28 20:29:03 +0000420 << NumberedInstructions.size() << ");\n}\n\n";
421
Chris Lattnerc9d99ef2004-08-17 03:08:28 +0000422 OS << "} // End llvm namespace \n";
Evan Cheng1e210d02011-06-28 20:07:07 +0000423
424 OS << "#endif // GET_INSTRINFO_MC_DESC\n\n";
Evan Cheng703a0fb2011-07-01 17:57:27 +0000425
426 // Create a TargetInstrInfo subclass to hide the MC layer initialization.
427 OS << "\n#ifdef GET_INSTRINFO_HEADER\n";
428 OS << "#undef GET_INSTRINFO_HEADER\n";
429
430 std::string ClassName = TargetName + "GenInstrInfo";
Evan Cheng54b68e32011-07-01 20:45:01 +0000431 OS << "namespace llvm {\n";
Jakob Stoklund Olesen9de596e2012-11-28 02:35:17 +0000432 OS << "struct " << ClassName << " : public TargetInstrInfo {\n"
Eric Christopher44fd4982015-03-13 01:26:39 +0000433 << " explicit " << ClassName
434 << "(int CFSetupOpcode = -1, int CFDestroyOpcode = -1);\n"
Juergen Ributzkad12ccbd2013-11-19 00:57:56 +0000435 << " virtual ~" << ClassName << "();\n"
Evan Cheng703a0fb2011-07-01 17:57:27 +0000436 << "};\n";
437 OS << "} // End llvm namespace \n";
438
439 OS << "#endif // GET_INSTRINFO_HEADER\n\n";
440
Juergen Ributzkad12ccbd2013-11-19 00:57:56 +0000441 OS << "\n#ifdef GET_INSTRINFO_CTOR_DTOR\n";
442 OS << "#undef GET_INSTRINFO_CTOR_DTOR\n";
Evan Cheng703a0fb2011-07-01 17:57:27 +0000443
Evan Cheng54b68e32011-07-01 20:45:01 +0000444 OS << "namespace llvm {\n";
Benjamin Kramer0d6d0982011-10-22 16:50:00 +0000445 OS << "extern const MCInstrDesc " << TargetName << "Insts[];\n";
Jakob Stoklund Olesene3084892012-03-15 18:05:57 +0000446 OS << "extern const unsigned " << TargetName << "InstrNameIndices[];\n";
Craig Topper91773ab2012-04-01 18:14:14 +0000447 OS << "extern const char " << TargetName << "InstrNameData[];\n";
Eric Christopher44fd4982015-03-13 01:26:39 +0000448 OS << ClassName << "::" << ClassName
449 << "(int CFSetupOpcode, int CFDestroyOpcode)\n"
450 << " : TargetInstrInfo(CFSetupOpcode, CFDestroyOpcode) {\n"
451 << " InitMCInstrInfo(" << TargetName << "Insts, " << TargetName
452 << "InstrNameIndices, " << TargetName << "InstrNameData, "
Juergen Ributzkad12ccbd2013-11-19 00:57:56 +0000453 << NumberedInstructions.size() << ");\n}\n"
454 << ClassName << "::~" << ClassName << "() {}\n";
Evan Cheng703a0fb2011-07-01 17:57:27 +0000455 OS << "} // End llvm namespace \n";
456
Juergen Ributzkad12ccbd2013-11-19 00:57:56 +0000457 OS << "#endif // GET_INSTRINFO_CTOR_DTOR\n\n";
Tom Stellardb162d942013-06-25 21:22:09 +0000458
459 emitOperandNameMappings(OS, Target, NumberedInstructions);
Ahmed Bougacha31377592013-11-17 21:24:41 +0000460
461 emitOperandTypesEnum(OS, Target);
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000462}
463
Chris Lattnerc860eca2004-08-01 05:04:00 +0000464void InstrInfoEmitter::emitRecord(const CodeGenInstruction &Inst, unsigned Num,
Chris Lattner99df6682005-08-18 21:36:47 +0000465 Record *InstrInfo,
Chris Lattner742606a2005-10-28 22:59:53 +0000466 std::map<std::vector<Record*>, unsigned> &EmittedLists,
Chris Lattner626b89d2008-01-06 01:20:13 +0000467 const OperandInfoMapTy &OpInfo,
Daniel Dunbar38a22bf2009-07-03 00:10:29 +0000468 raw_ostream &OS) {
Chris Lattner27a4c152008-01-06 01:53:37 +0000469 int MinOperands = 0;
Richard Trieu24489692012-10-12 17:57:35 +0000470 if (!Inst.Operands.empty())
Chris Lattner511ee682005-08-19 00:59:49 +0000471 // Each logical operand can be multiple MI operands.
Chris Lattnerd8adec72010-11-01 04:03:32 +0000472 MinOperands = Inst.Operands.back().MIOperandNo +
473 Inst.Operands.back().MINumOperands;
Dan Gohman6e582c42008-05-29 19:57:41 +0000474
Evan Cheng71adba62006-11-17 01:46:27 +0000475 OS << " { ";
Evan Chengc9de9ce2007-08-02 00:20:17 +0000476 OS << Num << ",\t" << MinOperands << ",\t"
Owen Anderson651b2302011-07-13 23:22:26 +0000477 << Inst.Operands.NumDefs << ",\t"
Andrew Tricka88f1bd2012-09-18 03:55:55 +0000478 << SchedModels.getSchedClassIdx(Inst) << ",\t"
Benjamin Kramer8e012f52012-02-09 11:25:09 +0000479 << Inst.TheDef->getValueAsInt("Size") << ",\t0";
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000480
Eric Christopher834d6422015-02-26 00:00:33 +0000481 // Emit all of the target independent flags...
Jakob Stoklund Olesendf977fe2011-09-25 19:21:35 +0000482 if (Inst.isPseudo) OS << "|(1<<MCID::Pseudo)";
Evan Cheng6cc775f2011-06-28 19:10:37 +0000483 if (Inst.isReturn) OS << "|(1<<MCID::Return)";
484 if (Inst.isBranch) OS << "|(1<<MCID::Branch)";
485 if (Inst.isIndirectBranch) OS << "|(1<<MCID::IndirectBranch)";
486 if (Inst.isCompare) OS << "|(1<<MCID::Compare)";
487 if (Inst.isMoveImm) OS << "|(1<<MCID::MoveImm)";
488 if (Inst.isBitcast) OS << "|(1<<MCID::Bitcast)";
Jakob Stoklund Olesen2382d322012-08-16 23:11:47 +0000489 if (Inst.isSelect) OS << "|(1<<MCID::Select)";
Evan Cheng6cc775f2011-06-28 19:10:37 +0000490 if (Inst.isBarrier) OS << "|(1<<MCID::Barrier)";
491 if (Inst.hasDelaySlot) OS << "|(1<<MCID::DelaySlot)";
492 if (Inst.isCall) OS << "|(1<<MCID::Call)";
493 if (Inst.canFoldAsLoad) OS << "|(1<<MCID::FoldableAsLoad)";
494 if (Inst.mayLoad) OS << "|(1<<MCID::MayLoad)";
495 if (Inst.mayStore) OS << "|(1<<MCID::MayStore)";
496 if (Inst.isPredicable) OS << "|(1<<MCID::Predicable)";
497 if (Inst.isConvertibleToThreeAddress) OS << "|(1<<MCID::ConvertibleTo3Addr)";
498 if (Inst.isCommutable) OS << "|(1<<MCID::Commutable)";
499 if (Inst.isTerminator) OS << "|(1<<MCID::Terminator)";
500 if (Inst.isReMaterializable) OS << "|(1<<MCID::Rematerializable)";
501 if (Inst.isNotDuplicable) OS << "|(1<<MCID::NotDuplicable)";
502 if (Inst.Operands.hasOptionalDef) OS << "|(1<<MCID::HasOptionalDef)";
503 if (Inst.usesCustomInserter) OS << "|(1<<MCID::UsesCustomInserter)";
Andrew Trick52363bd2011-09-20 18:22:31 +0000504 if (Inst.hasPostISelHook) OS << "|(1<<MCID::HasPostISelHook)";
Evan Cheng6cc775f2011-06-28 19:10:37 +0000505 if (Inst.Operands.isVariadic)OS << "|(1<<MCID::Variadic)";
506 if (Inst.hasSideEffects) OS << "|(1<<MCID::UnmodeledSideEffects)";
507 if (Inst.isAsCheapAsAMove) OS << "|(1<<MCID::CheapAsAMove)";
508 if (Inst.hasExtraSrcRegAllocReq) OS << "|(1<<MCID::ExtraSrcRegAllocReq)";
509 if (Inst.hasExtraDefRegAllocReq) OS << "|(1<<MCID::ExtraDefRegAllocReq)";
Quentin Colombetd533cdf2014-08-11 22:17:14 +0000510 if (Inst.isRegSequence) OS << "|(1<<MCID::RegSequence)";
Quentin Colombet7e75cba2014-08-20 21:51:26 +0000511 if (Inst.isExtractSubreg) OS << "|(1<<MCID::ExtractSubreg)";
Quentin Colombet7e3da662014-08-20 23:49:36 +0000512 if (Inst.isInsertSubreg) OS << "|(1<<MCID::InsertSubreg)";
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000513
514 // Emit all of the target-specific flags...
David Greeneaf8ee2c2011-07-29 22:43:06 +0000515 BitsInit *TSF = Inst.TheDef->getValueAsBitsInit("TSFlags");
Joerg Sonnenberger635debe2012-10-25 20:33:17 +0000516 if (!TSF)
517 PrintFatalError("no TSFlags?");
Jakob Stoklund Olesenb93331f2010-04-05 03:10:20 +0000518 uint64_t Value = 0;
519 for (unsigned i = 0, e = TSF->getNumBits(); i != e; ++i) {
Sean Silvafb509ed2012-10-10 20:24:43 +0000520 if (BitInit *Bit = dyn_cast<BitInit>(TSF->getBit(i)))
Jakob Stoklund Olesenb93331f2010-04-05 03:10:20 +0000521 Value |= uint64_t(Bit->getValue()) << i;
522 else
Joerg Sonnenberger635debe2012-10-25 20:33:17 +0000523 PrintFatalError("Invalid TSFlags bit in " + Inst.TheDef->getName());
Jakob Stoklund Olesenb93331f2010-04-05 03:10:20 +0000524 }
525 OS << ", 0x";
526 OS.write_hex(Value);
Eric Christopher223c4812010-06-09 16:16:48 +0000527 OS << "ULL, ";
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000528
529 // Emit the implicit uses and defs lists...
Chris Lattner742606a2005-10-28 22:59:53 +0000530 std::vector<Record*> UseList = Inst.TheDef->getValueAsListOfDefs("Uses");
531 if (UseList.empty())
Craig Topper948dfbf2014-04-30 05:53:35 +0000532 OS << "nullptr, ";
Misha Brukman650ba8e2005-04-22 00:00:37 +0000533 else
Chris Lattner742606a2005-10-28 22:59:53 +0000534 OS << "ImplicitList" << EmittedLists[UseList] << ", ";
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000535
Chris Lattner742606a2005-10-28 22:59:53 +0000536 std::vector<Record*> DefList = Inst.TheDef->getValueAsListOfDefs("Defs");
537 if (DefList.empty())
Craig Topper948dfbf2014-04-30 05:53:35 +0000538 OS << "nullptr, ";
Misha Brukman650ba8e2005-04-22 00:00:37 +0000539 else
Chris Lattner742606a2005-10-28 22:59:53 +0000540 OS << "ImplicitList" << EmittedLists[DefList] << ", ";
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000541
Chris Lattner220d0012005-08-19 16:57:28 +0000542 // Emit the operand info.
Chris Lattner33f5a512006-11-06 23:49:51 +0000543 std::vector<std::string> OperandInfo = GetOperandInfo(Inst);
Chris Lattnerd02bd5b2005-08-19 18:46:26 +0000544 if (OperandInfo.empty())
Craig Topper948dfbf2014-04-30 05:53:35 +0000545 OS << "nullptr";
Chris Lattner220d0012005-08-19 16:57:28 +0000546 else
Chris Lattner626b89d2008-01-06 01:20:13 +0000547 OS << "OperandInfo" << OpInfo.find(OperandInfo)->second;
Jakob Stoklund Olesenb93331f2010-04-05 03:10:20 +0000548
Joey Gouly0e76fa72013-09-12 10:28:05 +0000549 CodeGenTarget &Target = CDP.getTargetInfo();
550 if (Inst.HasComplexDeprecationPredicate)
551 // Emit a function pointer to the complex predicate method.
Michael Kupersteindb0712f2015-05-26 10:47:10 +0000552 OS << ", -1 "
Joey Gouly0e76fa72013-09-12 10:28:05 +0000553 << ",&get" << Inst.DeprecatedReason << "DeprecationInfo";
554 else if (!Inst.DeprecatedReason.empty())
555 // Emit the Subtarget feature.
Michael Kupersteindb0712f2015-05-26 10:47:10 +0000556 OS << ", " << Target.getInstNamespace() << "::" << Inst.DeprecatedReason
557 << " ,nullptr";
Joey Gouly0e76fa72013-09-12 10:28:05 +0000558 else
559 // Instruction isn't deprecated.
Michael Kupersteindb0712f2015-05-26 10:47:10 +0000560 OS << ", -1 ,nullptr";
Joey Gouly0e76fa72013-09-12 10:28:05 +0000561
Chris Lattnerc860eca2004-08-01 05:04:00 +0000562 OS << " }, // Inst #" << Num << " = " << Inst.TheDef->getName() << "\n";
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000563}
Evan Cheng1e210d02011-06-28 20:07:07 +0000564
565// emitEnums - Print out enum values for all of the instructions.
566void InstrInfoEmitter::emitEnums(raw_ostream &OS) {
Evan Cheng1e210d02011-06-28 20:07:07 +0000567
568 OS << "\n#ifdef GET_INSTRINFO_ENUM\n";
569 OS << "#undef GET_INSTRINFO_ENUM\n";
570
571 OS << "namespace llvm {\n\n";
572
573 CodeGenTarget Target(Records);
574
575 // We must emit the PHI opcode first...
576 std::string Namespace = Target.getInstNamespace();
Jim Grosbachdac4a952012-04-11 21:02:30 +0000577
James Y Knighte452e272015-05-11 22:17:13 +0000578 if (Namespace.empty())
579 PrintFatalError("No instructions defined!");
Evan Cheng1e210d02011-06-28 20:07:07 +0000580
581 const std::vector<const CodeGenInstruction*> &NumberedInstructions =
582 Target.getInstructionsByEnumValue();
583
584 OS << "namespace " << Namespace << " {\n";
585 OS << " enum {\n";
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000586 unsigned Num = 0;
587 for (const CodeGenInstruction *Inst : NumberedInstructions)
588 OS << " " << Inst->TheDef->getName() << "\t= " << Num++ << ",\n";
Evan Cheng1e210d02011-06-28 20:07:07 +0000589 OS << " INSTRUCTION_LIST_END = " << NumberedInstructions.size() << "\n";
Craig Topperca331be2014-11-23 09:40:10 +0000590 OS << " };\n\n";
Vincent Lejeune7deccf02013-09-03 19:43:28 +0000591 OS << "namespace Sched {\n";
592 OS << " enum {\n";
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000593 Num = 0;
594 for (const auto &Class : SchedModels.explicit_classes())
595 OS << " " << Class.Name << "\t= " << Num++ << ",\n";
Vincent Lejeune7deccf02013-09-03 19:43:28 +0000596 OS << " SCHED_LIST_END = " << SchedModels.numInstrSchedClasses() << "\n";
Craig Topperca331be2014-11-23 09:40:10 +0000597 OS << " };\n";
598 OS << "} // End Sched namespace\n";
599 OS << "} // End " << Namespace << " namespace\n";
Evan Cheng1e210d02011-06-28 20:07:07 +0000600 OS << "} // End llvm namespace \n";
601
602 OS << "#endif // GET_INSTRINFO_ENUM\n\n";
603}
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +0000604
605namespace llvm {
606
607void EmitInstrInfo(RecordKeeper &RK, raw_ostream &OS) {
608 InstrInfoEmitter(RK).run(OS);
Sebastian Pop5c87daf2012-10-25 15:54:06 +0000609 EmitMapTable(RK, OS);
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +0000610}
611
612} // End llvm namespace