blob: 044e9e211516acf2e1a8ea6bafbe8cc8581a7d6e [file] [log] [blame]
Hans Wennborgaa15bff2015-09-10 16:49:58 +00001//===- InstrInfoEmitter.cpp - Generate a Instruction Set Desc. --*- C++ -*-===//
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#include "CodeGenDAGPatterns.h"
Andrew Trick87255e32012-07-07 04:00:00 +000016#include "CodeGenSchedule.h"
Chris Lattnerfce96032004-08-01 04:04:35 +000017#include "CodeGenTarget.h"
Craig Topper91773ab2012-04-01 18:14:14 +000018#include "SequenceToOffsetTable.h"
Chandler Carruth91d19d82012-12-04 10:37:14 +000019#include "TableGenBackends.h"
Chris Lattner06fa1762009-08-24 03:52:50 +000020#include "llvm/ADT/StringExtras.h"
Joerg Sonnenberger635debe2012-10-25 20:33:17 +000021#include "llvm/TableGen/Error.h"
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +000022#include "llvm/TableGen/Record.h"
23#include "llvm/TableGen/TableGenBackend.h"
Jeff Cohen9e1784d2005-11-01 18:04:06 +000024#include <algorithm>
Benjamin Kramerb0640db2012-03-23 11:35:30 +000025#include <cstdio>
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +000026#include <map>
27#include <vector>
Hans Wennborgaa15bff2015-09-10 16:49:58 +000028
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 Topper28851b62016-02-01 01:33:42 +000062 ArrayRef<const CodeGenInstruction *> NumberedInstructions,
Craig Topper65efcb42014-02-05 07:27:49 +000063 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,
Craig Topper28851b62016-02-01 01:33:42 +000067 ArrayRef<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};
Hans Wennborgaa15bff2015-09-10 16:49:58 +000073} // end anonymous namespace
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +000074
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 Toppere5e035a32015-12-05 07:13:35 +000077 OS << "static const MCPhysReg ImplicitList" << Num << "[] = { ";
Craig Topper9cd0ff12016-02-16 02:48:30 +000078 for (Record *U : Uses)
79 OS << getQualifiedName(U) << ", ";
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();
Craig Topper8cc904d2016-01-17 20:38:18 +0000180 for (const CodeGenInstruction *Inst : Target.getInstructionsByEnumValue()) {
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000181 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/// Initialize data structures for generating operand name mappings.
194///
195/// \param Operands [out] A map used to generate the OpName enum with operand
196/// names as its keys and operand enum values as its values.
197/// \param OperandMap [out] A map for representing the operand name mappings for
198/// each instructions. This is used to generate the OperandMap table as
199/// well as the getNamedOperandIdx() function.
200void InstrInfoEmitter::initOperandMapData(
Craig Topper28851b62016-02-01 01:33:42 +0000201 ArrayRef<const CodeGenInstruction *> NumberedInstructions,
Tom Stellardb162d942013-06-25 21:22:09 +0000202 const std::string &Namespace,
203 std::map<std::string, unsigned> &Operands,
204 OpNameMapTy &OperandMap) {
205
206 unsigned NumOperands = 0;
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000207 for (const CodeGenInstruction *Inst : NumberedInstructions) {
208 if (!Inst->TheDef->getValueAsBit("UseNamedOperandTable"))
Tom Stellardb162d942013-06-25 21:22:09 +0000209 continue;
Tom Stellardb162d942013-06-25 21:22:09 +0000210 std::map<unsigned, unsigned> OpList;
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000211 for (const auto &Info : Inst->Operands) {
Tom Stellardb162d942013-06-25 21:22:09 +0000212 StrUintMapIter I = Operands.find(Info.Name);
213
214 if (I == Operands.end()) {
215 I = Operands.insert(Operands.begin(),
216 std::pair<std::string, unsigned>(Info.Name, NumOperands++));
217 }
218 OpList[I->second] = Info.MIOperandNo;
219 }
220 OperandMap[OpList].push_back(Namespace + "::" + Inst->TheDef->getName());
221 }
222}
223
224/// Generate a table and function for looking up the indices of operands by
225/// name.
226///
227/// This code generates:
228/// - An enum in the llvm::TargetNamespace::OpName namespace, with one entry
229/// for each operand name.
230/// - A 2-dimensional table called OperandMap for mapping OpName enum values to
231/// operand indices.
232/// - A function called getNamedOperandIdx(uint16_t Opcode, uint16_t NamedIdx)
233/// for looking up the operand index for an instruction, given a value from
234/// OpName enum
235void InstrInfoEmitter::emitOperandNameMappings(raw_ostream &OS,
236 const CodeGenTarget &Target,
Craig Topper28851b62016-02-01 01:33:42 +0000237 ArrayRef<const CodeGenInstruction*> NumberedInstructions) {
Tom Stellardb162d942013-06-25 21:22:09 +0000238
239 const std::string &Namespace = Target.getInstNamespace();
240 std::string OpNameNS = "OpName";
241 // Map of operand names to their enumeration value. This will be used to
242 // generate the OpName enum.
243 std::map<std::string, unsigned> Operands;
244 OpNameMapTy OperandMap;
245
246 initOperandMapData(NumberedInstructions, Namespace, Operands, OperandMap);
247
248 OS << "#ifdef GET_INSTRINFO_OPERAND_ENUM\n";
249 OS << "#undef GET_INSTRINFO_OPERAND_ENUM\n";
Eric Christopher69c0a7c2015-03-13 01:10:08 +0000250 OS << "namespace llvm {\n";
Tom Stellardb162d942013-06-25 21:22:09 +0000251 OS << "namespace " << Namespace << " {\n";
Craig Topperfc1b4d42016-02-11 07:39:25 +0000252 OS << "namespace " << OpNameNS << " {\n";
Tom Stellardb162d942013-06-25 21:22:09 +0000253 OS << "enum {\n";
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000254 for (const auto &Op : Operands)
255 OS << " " << Op.first << " = " << Op.second << ",\n";
Tom Stellardb162d942013-06-25 21:22:09 +0000256
257 OS << "OPERAND_LAST";
258 OS << "\n};\n";
Hans Wennborgaa15bff2015-09-10 16:49:58 +0000259 OS << "} // end namespace OpName\n";
260 OS << "} // end namespace " << Namespace << "\n";
261 OS << "} // end namespace llvm\n";
Craig Topperfc1b4d42016-02-11 07:39:25 +0000262 OS << "#endif //GET_INSTRINFO_OPERAND_ENUM\n\n";
Tom Stellardb162d942013-06-25 21:22:09 +0000263
264 OS << "#ifdef GET_INSTRINFO_NAMED_OPS\n";
265 OS << "#undef GET_INSTRINFO_NAMED_OPS\n";
Eric Christopher69c0a7c2015-03-13 01:10:08 +0000266 OS << "namespace llvm {\n";
Tom Stellardb162d942013-06-25 21:22:09 +0000267 OS << "namespace " << Namespace << " {\n";
Matt Arsenault41e14812014-08-01 17:00:27 +0000268 OS << "LLVM_READONLY\n";
Tom Stellardb162d942013-06-25 21:22:09 +0000269 OS << "int16_t getNamedOperandIdx(uint16_t Opcode, uint16_t NamedIdx) {\n";
Aaron Ballmane59e3582013-07-15 16:53:32 +0000270 if (!Operands.empty()) {
271 OS << " static const int16_t OperandMap [][" << Operands.size()
272 << "] = {\n";
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000273 for (const auto &Entry : OperandMap) {
274 const std::map<unsigned, unsigned> &OpList = Entry.first;
Aaron Ballmane59e3582013-07-15 16:53:32 +0000275 OS << "{";
Tom Stellardb162d942013-06-25 21:22:09 +0000276
Aaron Ballmane59e3582013-07-15 16:53:32 +0000277 // Emit a row of the OperandMap table
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000278 for (unsigned i = 0, e = Operands.size(); i != e; ++i)
279 OS << (OpList.count(i) == 0 ? -1 : (int)OpList.find(i)->second) << ", ";
Tom Stellardb162d942013-06-25 21:22:09 +0000280
Aaron Ballmane59e3582013-07-15 16:53:32 +0000281 OS << "},\n";
282 }
283 OS << "};\n";
284
285 OS << " switch(Opcode) {\n";
286 unsigned TableIndex = 0;
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000287 for (const auto &Entry : OperandMap) {
288 for (const std::string &Name : Entry.second)
289 OS << " case " << Name << ":\n";
Aaron Ballmane59e3582013-07-15 16:53:32 +0000290
291 OS << " return OperandMap[" << TableIndex++ << "][NamedIdx];\n";
292 }
293 OS << " default: return -1;\n";
294 OS << " }\n";
295 } else {
296 // There are no operands, so no need to emit anything
297 OS << " return -1;\n";
Tom Stellardb162d942013-06-25 21:22:09 +0000298 }
Tom Stellardb162d942013-06-25 21:22:09 +0000299 OS << "}\n";
Hans Wennborgaa15bff2015-09-10 16:49:58 +0000300 OS << "} // end namespace " << Namespace << "\n";
301 OS << "} // end namespace llvm\n";
Craig Topperfc1b4d42016-02-11 07:39:25 +0000302 OS << "#endif //GET_INSTRINFO_NAMED_OPS\n\n";
Tom Stellardb162d942013-06-25 21:22:09 +0000303
304}
305
Ahmed Bougacha31377592013-11-17 21:24:41 +0000306/// Generate an enum for all the operand types for this target, under the
307/// llvm::TargetNamespace::OpTypes namespace.
308/// Operand types are all definitions derived of the Operand Target.td class.
309void InstrInfoEmitter::emitOperandTypesEnum(raw_ostream &OS,
310 const CodeGenTarget &Target) {
311
312 const std::string &Namespace = Target.getInstNamespace();
313 std::vector<Record *> Operands = Records.getAllDerivedDefinitions("Operand");
314
Craig Topperfc1b4d42016-02-11 07:39:25 +0000315 OS << "#ifdef GET_INSTRINFO_OPERAND_TYPES_ENUM\n";
Ahmed Bougacha31377592013-11-17 21:24:41 +0000316 OS << "#undef GET_INSTRINFO_OPERAND_TYPES_ENUM\n";
Eric Christopher69c0a7c2015-03-13 01:10:08 +0000317 OS << "namespace llvm {\n";
Ahmed Bougacha31377592013-11-17 21:24:41 +0000318 OS << "namespace " << Namespace << " {\n";
Craig Topperfc1b4d42016-02-11 07:39:25 +0000319 OS << "namespace OpTypes {\n";
Ahmed Bougacha31377592013-11-17 21:24:41 +0000320 OS << "enum OperandType {\n";
321
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000322 unsigned EnumVal = 0;
323 for (const Record *Op : Operands) {
324 if (!Op->isAnonymous())
325 OS << " " << Op->getName() << " = " << EnumVal << ",\n";
326 ++EnumVal;
Ahmed Bougacha31377592013-11-17 21:24:41 +0000327 }
328
329 OS << " OPERAND_TYPE_LIST_END" << "\n};\n";
Hans Wennborgaa15bff2015-09-10 16:49:58 +0000330 OS << "} // end namespace OpTypes\n";
331 OS << "} // end namespace " << Namespace << "\n";
332 OS << "} // end namespace llvm\n";
Craig Topperfc1b4d42016-02-11 07:39:25 +0000333 OS << "#endif // GET_INSTRINFO_OPERAND_TYPES_ENUM\n\n";
Ahmed Bougacha31377592013-11-17 21:24:41 +0000334}
335
Chris Lattner626b89d2008-01-06 01:20:13 +0000336//===----------------------------------------------------------------------===//
337// Main Output.
338//===----------------------------------------------------------------------===//
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000339
340// run - Emit the main instruction description records for the target...
Daniel Dunbar38a22bf2009-07-03 00:10:29 +0000341void InstrInfoEmitter::run(raw_ostream &OS) {
Craig Toppera3ebc4f2016-02-11 07:39:27 +0000342 emitSourceFileHeader("Target Instruction Enum Values and Descriptors", OS);
Evan Cheng1e210d02011-06-28 20:07:07 +0000343 emitEnums(OS);
344
Craig Topperfc1b4d42016-02-11 07:39:25 +0000345 OS << "#ifdef GET_INSTRINFO_MC_DESC\n";
Evan Cheng1e210d02011-06-28 20:07:07 +0000346 OS << "#undef GET_INSTRINFO_MC_DESC\n";
347
Chris Lattnerc9d99ef2004-08-17 03:08:28 +0000348 OS << "namespace llvm {\n\n";
349
Dan Gohmanfc4ad7de2008-04-03 00:02:49 +0000350 CodeGenTarget &Target = CDP.getTargetInfo();
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000351 const std::string &TargetName = Target.getName();
352 Record *InstrInfo = Target.getInstructionSet();
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000353
Chris Lattner99df6682005-08-18 21:36:47 +0000354 // Keep track of all of the def lists we have emitted already.
355 std::map<std::vector<Record*>, unsigned> EmittedLists;
Chris Lattner99df6682005-08-18 21:36:47 +0000356 unsigned ListNumber = 0;
Owen Andersona84be6c2011-06-27 21:06:21 +0000357
Chris Lattner99df6682005-08-18 21:36:47 +0000358 // Emit all of the instruction's implicit uses and defs.
Craig Topper8cc904d2016-01-17 20:38:18 +0000359 for (const CodeGenInstruction *II : Target.getInstructionsByEnumValue()) {
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000360 Record *Inst = II->TheDef;
Chris Lattner742606a2005-10-28 22:59:53 +0000361 std::vector<Record*> Uses = Inst->getValueAsListOfDefs("Uses");
362 if (!Uses.empty()) {
Chris Lattner99df6682005-08-18 21:36:47 +0000363 unsigned &IL = EmittedLists[Uses];
Chris Lattner85467a12008-01-06 01:21:51 +0000364 if (!IL) PrintDefList(Uses, IL = ++ListNumber, OS);
Chris Lattner99df6682005-08-18 21:36:47 +0000365 }
Chris Lattner742606a2005-10-28 22:59:53 +0000366 std::vector<Record*> Defs = Inst->getValueAsListOfDefs("Defs");
367 if (!Defs.empty()) {
368 unsigned &IL = EmittedLists[Defs];
Chris Lattner85467a12008-01-06 01:21:51 +0000369 if (!IL) PrintDefList(Defs, IL = ++ListNumber, OS);
Chris Lattner99df6682005-08-18 21:36:47 +0000370 }
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000371 }
372
Chris Lattner626b89d2008-01-06 01:20:13 +0000373 OperandInfoMapTy OperandInfoIDs;
Owen Andersona84be6c2011-06-27 21:06:21 +0000374
Chris Lattner220d0012005-08-19 16:57:28 +0000375 // Emit all of the operand info records.
Chris Lattner626b89d2008-01-06 01:20:13 +0000376 EmitOperandInfo(OS, OperandInfoIDs);
Owen Andersona84be6c2011-06-27 21:06:21 +0000377
Evan Cheng6cc775f2011-06-28 19:10:37 +0000378 // Emit all of the MCInstrDesc records in their ENUM ordering.
Chris Lattner220d0012005-08-19 16:57:28 +0000379 //
Benjamin Kramer0d6d0982011-10-22 16:50:00 +0000380 OS << "\nextern const MCInstrDesc " << TargetName << "Insts[] = {\n";
Craig Topper28851b62016-02-01 01:33:42 +0000381 ArrayRef<const CodeGenInstruction*> NumberedInstructions =
Chris Lattner918be522010-03-19 00:34:35 +0000382 Target.getInstructionsByEnumValue();
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000383
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000384 SequenceToOffsetTable<std::string> InstrNames;
385 unsigned Num = 0;
386 for (const CodeGenInstruction *Inst : NumberedInstructions) {
387 // Keep a list of the instruction names.
388 InstrNames.add(Inst->TheDef->getName());
389 // Emit the record into the table.
390 emitRecord(*Inst, Num++, InstrInfo, EmittedLists, OperandInfoIDs, OS);
391 }
Evan Chengdf8974e2011-06-28 20:29:03 +0000392 OS << "};\n\n";
393
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000394 // Emit the array of instruction names.
Craig Topper91773ab2012-04-01 18:14:14 +0000395 InstrNames.layout();
396 OS << "extern const char " << TargetName << "InstrNameData[] = {\n";
397 InstrNames.emit(OS, printChar);
398 OS << "};\n\n";
399
400 OS << "extern const unsigned " << TargetName <<"InstrNameIndices[] = {";
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000401 Num = 0;
402 for (const CodeGenInstruction *Inst : NumberedInstructions) {
403 // Newline every eight entries.
404 if (Num % 8 == 0)
Benjamin Kramerbf152d52012-02-10 13:18:44 +0000405 OS << "\n ";
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000406 OS << InstrNames.get(Inst->TheDef->getName()) << "U, ";
407 ++Num;
Benjamin Kramerbf152d52012-02-10 13:18:44 +0000408 }
409
410 OS << "\n};\n\n";
411
Evan Chengdf8974e2011-06-28 20:29:03 +0000412 // MCInstrInfo initialization routine.
413 OS << "static inline void Init" << TargetName
414 << "MCInstrInfo(MCInstrInfo *II) {\n";
415 OS << " II->InitMCInstrInfo(" << TargetName << "Insts, "
Benjamin Kramerbf152d52012-02-10 13:18:44 +0000416 << TargetName << "InstrNameIndices, " << TargetName << "InstrNameData, "
Evan Chengdf8974e2011-06-28 20:29:03 +0000417 << NumberedInstructions.size() << ");\n}\n\n";
418
Craig Topperfc1b4d42016-02-11 07:39:25 +0000419 OS << "} // end llvm namespace\n";
Evan Cheng1e210d02011-06-28 20:07:07 +0000420
421 OS << "#endif // GET_INSTRINFO_MC_DESC\n\n";
Evan Cheng703a0fb2011-07-01 17:57:27 +0000422
423 // Create a TargetInstrInfo subclass to hide the MC layer initialization.
Craig Topperfc1b4d42016-02-11 07:39:25 +0000424 OS << "#ifdef GET_INSTRINFO_HEADER\n";
Evan Cheng703a0fb2011-07-01 17:57:27 +0000425 OS << "#undef GET_INSTRINFO_HEADER\n";
426
427 std::string ClassName = TargetName + "GenInstrInfo";
Evan Cheng54b68e32011-07-01 20:45:01 +0000428 OS << "namespace llvm {\n";
Jakob Stoklund Olesen9de596e2012-11-28 02:35:17 +0000429 OS << "struct " << ClassName << " : public TargetInstrInfo {\n"
Eric Christopher44fd4982015-03-13 01:26:39 +0000430 << " explicit " << ClassName
David Majnemerf828a0c2015-10-01 18:44:59 +0000431 << "(int CFSetupOpcode = -1, int CFDestroyOpcode = -1, int CatchRetOpcode = -1);\n"
Hans Wennborgaa15bff2015-09-10 16:49:58 +0000432 << " ~" << ClassName << "() override {}\n"
Evan Cheng703a0fb2011-07-01 17:57:27 +0000433 << "};\n";
Craig Topperfc1b4d42016-02-11 07:39:25 +0000434 OS << "} // end llvm namespace\n";
Evan Cheng703a0fb2011-07-01 17:57:27 +0000435
436 OS << "#endif // GET_INSTRINFO_HEADER\n\n";
437
Craig Topperfc1b4d42016-02-11 07:39:25 +0000438 OS << "#ifdef GET_INSTRINFO_CTOR_DTOR\n";
Juergen Ributzkad12ccbd2013-11-19 00:57:56 +0000439 OS << "#undef GET_INSTRINFO_CTOR_DTOR\n";
Evan Cheng703a0fb2011-07-01 17:57:27 +0000440
Evan Cheng54b68e32011-07-01 20:45:01 +0000441 OS << "namespace llvm {\n";
Benjamin Kramer0d6d0982011-10-22 16:50:00 +0000442 OS << "extern const MCInstrDesc " << TargetName << "Insts[];\n";
Jakob Stoklund Olesene3084892012-03-15 18:05:57 +0000443 OS << "extern const unsigned " << TargetName << "InstrNameIndices[];\n";
Craig Topper91773ab2012-04-01 18:14:14 +0000444 OS << "extern const char " << TargetName << "InstrNameData[];\n";
Eric Christopher44fd4982015-03-13 01:26:39 +0000445 OS << ClassName << "::" << ClassName
David Majnemerf828a0c2015-10-01 18:44:59 +0000446 << "(int CFSetupOpcode, int CFDestroyOpcode, int CatchRetOpcode)\n"
447 << " : TargetInstrInfo(CFSetupOpcode, CFDestroyOpcode, CatchRetOpcode) {\n"
Eric Christopher44fd4982015-03-13 01:26:39 +0000448 << " InitMCInstrInfo(" << TargetName << "Insts, " << TargetName
449 << "InstrNameIndices, " << TargetName << "InstrNameData, "
Hans Wennborgaa15bff2015-09-10 16:49:58 +0000450 << NumberedInstructions.size() << ");\n}\n";
Craig Topperfc1b4d42016-02-11 07:39:25 +0000451 OS << "} // end llvm namespace\n";
Evan Cheng703a0fb2011-07-01 17:57:27 +0000452
Juergen Ributzkad12ccbd2013-11-19 00:57:56 +0000453 OS << "#endif // GET_INSTRINFO_CTOR_DTOR\n\n";
Tom Stellardb162d942013-06-25 21:22:09 +0000454
455 emitOperandNameMappings(OS, Target, NumberedInstructions);
Ahmed Bougacha31377592013-11-17 21:24:41 +0000456
457 emitOperandTypesEnum(OS, Target);
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000458}
459
Chris Lattnerc860eca2004-08-01 05:04:00 +0000460void InstrInfoEmitter::emitRecord(const CodeGenInstruction &Inst, unsigned Num,
Chris Lattner99df6682005-08-18 21:36:47 +0000461 Record *InstrInfo,
Chris Lattner742606a2005-10-28 22:59:53 +0000462 std::map<std::vector<Record*>, unsigned> &EmittedLists,
Chris Lattner626b89d2008-01-06 01:20:13 +0000463 const OperandInfoMapTy &OpInfo,
Daniel Dunbar38a22bf2009-07-03 00:10:29 +0000464 raw_ostream &OS) {
Chris Lattner27a4c152008-01-06 01:53:37 +0000465 int MinOperands = 0;
Richard Trieu24489692012-10-12 17:57:35 +0000466 if (!Inst.Operands.empty())
Chris Lattner511ee682005-08-19 00:59:49 +0000467 // Each logical operand can be multiple MI operands.
Chris Lattnerd8adec72010-11-01 04:03:32 +0000468 MinOperands = Inst.Operands.back().MIOperandNo +
469 Inst.Operands.back().MINumOperands;
Dan Gohman6e582c42008-05-29 19:57:41 +0000470
Evan Cheng71adba62006-11-17 01:46:27 +0000471 OS << " { ";
Evan Chengc9de9ce2007-08-02 00:20:17 +0000472 OS << Num << ",\t" << MinOperands << ",\t"
Owen Anderson651b2302011-07-13 23:22:26 +0000473 << Inst.Operands.NumDefs << ",\t"
Owen Andersonca548002015-05-28 18:03:07 +0000474 << Inst.TheDef->getValueAsInt("Size") << ",\t"
475 << SchedModels.getSchedClassIdx(Inst) << ",\t0";
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000476
Eric Christopher834d6422015-02-26 00:00:33 +0000477 // Emit all of the target independent flags...
Owen Andersonabaa5232015-05-28 18:33:39 +0000478 if (Inst.isPseudo) OS << "|(1ULL<<MCID::Pseudo)";
479 if (Inst.isReturn) OS << "|(1ULL<<MCID::Return)";
480 if (Inst.isBranch) OS << "|(1ULL<<MCID::Branch)";
481 if (Inst.isIndirectBranch) OS << "|(1ULL<<MCID::IndirectBranch)";
482 if (Inst.isCompare) OS << "|(1ULL<<MCID::Compare)";
483 if (Inst.isMoveImm) OS << "|(1ULL<<MCID::MoveImm)";
484 if (Inst.isBitcast) OS << "|(1ULL<<MCID::Bitcast)";
485 if (Inst.isSelect) OS << "|(1ULL<<MCID::Select)";
486 if (Inst.isBarrier) OS << "|(1ULL<<MCID::Barrier)";
487 if (Inst.hasDelaySlot) OS << "|(1ULL<<MCID::DelaySlot)";
488 if (Inst.isCall) OS << "|(1ULL<<MCID::Call)";
489 if (Inst.canFoldAsLoad) OS << "|(1ULL<<MCID::FoldableAsLoad)";
490 if (Inst.mayLoad) OS << "|(1ULL<<MCID::MayLoad)";
491 if (Inst.mayStore) OS << "|(1ULL<<MCID::MayStore)";
492 if (Inst.isPredicable) OS << "|(1ULL<<MCID::Predicable)";
493 if (Inst.isConvertibleToThreeAddress) OS << "|(1ULL<<MCID::ConvertibleTo3Addr)";
494 if (Inst.isCommutable) OS << "|(1ULL<<MCID::Commutable)";
495 if (Inst.isTerminator) OS << "|(1ULL<<MCID::Terminator)";
496 if (Inst.isReMaterializable) OS << "|(1ULL<<MCID::Rematerializable)";
497 if (Inst.isNotDuplicable) OS << "|(1ULL<<MCID::NotDuplicable)";
498 if (Inst.Operands.hasOptionalDef) OS << "|(1ULL<<MCID::HasOptionalDef)";
499 if (Inst.usesCustomInserter) OS << "|(1ULL<<MCID::UsesCustomInserter)";
500 if (Inst.hasPostISelHook) OS << "|(1ULL<<MCID::HasPostISelHook)";
501 if (Inst.Operands.isVariadic)OS << "|(1ULL<<MCID::Variadic)";
502 if (Inst.hasSideEffects) OS << "|(1ULL<<MCID::UnmodeledSideEffects)";
503 if (Inst.isAsCheapAsAMove) OS << "|(1ULL<<MCID::CheapAsAMove)";
504 if (Inst.hasExtraSrcRegAllocReq) OS << "|(1ULL<<MCID::ExtraSrcRegAllocReq)";
505 if (Inst.hasExtraDefRegAllocReq) OS << "|(1ULL<<MCID::ExtraDefRegAllocReq)";
506 if (Inst.isRegSequence) OS << "|(1ULL<<MCID::RegSequence)";
507 if (Inst.isExtractSubreg) OS << "|(1ULL<<MCID::ExtractSubreg)";
508 if (Inst.isInsertSubreg) OS << "|(1ULL<<MCID::InsertSubreg)";
509 if (Inst.isConvergent) OS << "|(1ULL<<MCID::Convergent)";
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000510
511 // Emit all of the target-specific flags...
David Greeneaf8ee2c2011-07-29 22:43:06 +0000512 BitsInit *TSF = Inst.TheDef->getValueAsBitsInit("TSFlags");
Joerg Sonnenberger635debe2012-10-25 20:33:17 +0000513 if (!TSF)
514 PrintFatalError("no TSFlags?");
Jakob Stoklund Olesenb93331f2010-04-05 03:10:20 +0000515 uint64_t Value = 0;
516 for (unsigned i = 0, e = TSF->getNumBits(); i != e; ++i) {
Sean Silvafb509ed2012-10-10 20:24:43 +0000517 if (BitInit *Bit = dyn_cast<BitInit>(TSF->getBit(i)))
Jakob Stoklund Olesenb93331f2010-04-05 03:10:20 +0000518 Value |= uint64_t(Bit->getValue()) << i;
519 else
Joerg Sonnenberger635debe2012-10-25 20:33:17 +0000520 PrintFatalError("Invalid TSFlags bit in " + Inst.TheDef->getName());
Jakob Stoklund Olesenb93331f2010-04-05 03:10:20 +0000521 }
522 OS << ", 0x";
523 OS.write_hex(Value);
Eric Christopher223c4812010-06-09 16:16:48 +0000524 OS << "ULL, ";
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000525
526 // Emit the implicit uses and defs lists...
Chris Lattner742606a2005-10-28 22:59:53 +0000527 std::vector<Record*> UseList = Inst.TheDef->getValueAsListOfDefs("Uses");
528 if (UseList.empty())
Craig Topper948dfbf2014-04-30 05:53:35 +0000529 OS << "nullptr, ";
Misha Brukman650ba8e2005-04-22 00:00:37 +0000530 else
Chris Lattner742606a2005-10-28 22:59:53 +0000531 OS << "ImplicitList" << EmittedLists[UseList] << ", ";
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000532
Chris Lattner742606a2005-10-28 22:59:53 +0000533 std::vector<Record*> DefList = Inst.TheDef->getValueAsListOfDefs("Defs");
534 if (DefList.empty())
Craig Topper948dfbf2014-04-30 05:53:35 +0000535 OS << "nullptr, ";
Misha Brukman650ba8e2005-04-22 00:00:37 +0000536 else
Chris Lattner742606a2005-10-28 22:59:53 +0000537 OS << "ImplicitList" << EmittedLists[DefList] << ", ";
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000538
Chris Lattner220d0012005-08-19 16:57:28 +0000539 // Emit the operand info.
Chris Lattner33f5a512006-11-06 23:49:51 +0000540 std::vector<std::string> OperandInfo = GetOperandInfo(Inst);
Chris Lattnerd02bd5b2005-08-19 18:46:26 +0000541 if (OperandInfo.empty())
Craig Topper948dfbf2014-04-30 05:53:35 +0000542 OS << "nullptr";
Chris Lattner220d0012005-08-19 16:57:28 +0000543 else
Chris Lattner626b89d2008-01-06 01:20:13 +0000544 OS << "OperandInfo" << OpInfo.find(OperandInfo)->second;
Jakob Stoklund Olesenb93331f2010-04-05 03:10:20 +0000545
Joey Gouly0e76fa72013-09-12 10:28:05 +0000546 CodeGenTarget &Target = CDP.getTargetInfo();
547 if (Inst.HasComplexDeprecationPredicate)
548 // Emit a function pointer to the complex predicate method.
Michael Kupersteindb0712f2015-05-26 10:47:10 +0000549 OS << ", -1 "
Joey Gouly0e76fa72013-09-12 10:28:05 +0000550 << ",&get" << Inst.DeprecatedReason << "DeprecationInfo";
551 else if (!Inst.DeprecatedReason.empty())
552 // Emit the Subtarget feature.
Michael Kupersteindb0712f2015-05-26 10:47:10 +0000553 OS << ", " << Target.getInstNamespace() << "::" << Inst.DeprecatedReason
554 << " ,nullptr";
Joey Gouly0e76fa72013-09-12 10:28:05 +0000555 else
556 // Instruction isn't deprecated.
Michael Kupersteindb0712f2015-05-26 10:47:10 +0000557 OS << ", -1 ,nullptr";
Joey Gouly0e76fa72013-09-12 10:28:05 +0000558
Chris Lattnerc860eca2004-08-01 05:04:00 +0000559 OS << " }, // Inst #" << Num << " = " << Inst.TheDef->getName() << "\n";
Chris Lattnerf5bd1b72003-10-05 19:27:59 +0000560}
Evan Cheng1e210d02011-06-28 20:07:07 +0000561
562// emitEnums - Print out enum values for all of the instructions.
563void InstrInfoEmitter::emitEnums(raw_ostream &OS) {
Evan Cheng1e210d02011-06-28 20:07:07 +0000564
Craig Topperfc1b4d42016-02-11 07:39:25 +0000565 OS << "#ifdef GET_INSTRINFO_ENUM\n";
Evan Cheng1e210d02011-06-28 20:07:07 +0000566 OS << "#undef GET_INSTRINFO_ENUM\n";
567
568 OS << "namespace llvm {\n\n";
569
570 CodeGenTarget Target(Records);
571
572 // We must emit the PHI opcode first...
573 std::string Namespace = Target.getInstNamespace();
Jim Grosbachdac4a952012-04-11 21:02:30 +0000574
James Y Knighte452e272015-05-11 22:17:13 +0000575 if (Namespace.empty())
576 PrintFatalError("No instructions defined!");
Evan Cheng1e210d02011-06-28 20:07:07 +0000577
Evan Cheng1e210d02011-06-28 20:07:07 +0000578 OS << "namespace " << Namespace << " {\n";
579 OS << " enum {\n";
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000580 unsigned Num = 0;
Craig Toppere16efd92016-02-11 07:39:22 +0000581 for (const CodeGenInstruction *Inst : Target.getInstructionsByEnumValue())
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000582 OS << " " << Inst->TheDef->getName() << "\t= " << Num++ << ",\n";
Craig Toppere16efd92016-02-11 07:39:22 +0000583 OS << " INSTRUCTION_LIST_END = " << Num << "\n";
Craig Topperca331be2014-11-23 09:40:10 +0000584 OS << " };\n\n";
Vincent Lejeune7deccf02013-09-03 19:43:28 +0000585 OS << "namespace Sched {\n";
586 OS << " enum {\n";
Jim Grosbach5198f3e92014-04-18 02:09:07 +0000587 Num = 0;
588 for (const auto &Class : SchedModels.explicit_classes())
589 OS << " " << Class.Name << "\t= " << Num++ << ",\n";
Craig Toppere16efd92016-02-11 07:39:22 +0000590 OS << " SCHED_LIST_END = " << Num << "\n";
Craig Topperca331be2014-11-23 09:40:10 +0000591 OS << " };\n";
Hans Wennborgaa15bff2015-09-10 16:49:58 +0000592 OS << "} // end Sched namespace\n";
593 OS << "} // end " << Namespace << " namespace\n";
Craig Topperfc1b4d42016-02-11 07:39:25 +0000594 OS << "} // end llvm namespace\n";
Evan Cheng1e210d02011-06-28 20:07:07 +0000595
596 OS << "#endif // GET_INSTRINFO_ENUM\n\n";
597}
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +0000598
599namespace llvm {
600
601void EmitInstrInfo(RecordKeeper &RK, raw_ostream &OS) {
602 InstrInfoEmitter(RK).run(OS);
Sebastian Pop5c87daf2012-10-25 15:54:06 +0000603 EmitMapTable(RK, OS);
Jakob Stoklund Olesene6aed132012-06-11 15:37:55 +0000604}
605
Hans Wennborgaa15bff2015-09-10 16:49:58 +0000606} // end llvm namespace