1 //===- InstrInfoEmitter.cpp - Generate a Instruction Set Desc. ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This tablegen backend is responsible for emitting a description of the target
11 // instruction set for the code generator.
13 //===----------------------------------------------------------------------===//
15 #include "InstrInfoEmitter.h"
16 #include "CodeGenTarget.h"
22 static void PrintDefList(const std::vector<Record*> &Uses,
23 unsigned Num, std::ostream &OS) {
24 OS << "static const unsigned ImplicitList" << Num << "[] = { ";
25 for (unsigned i = 0, e = Uses.size(); i != e; ++i)
26 OS << getQualifiedName(Uses[i]) << ", ";
30 //===----------------------------------------------------------------------===//
31 // Instruction Itinerary Information.
32 //===----------------------------------------------------------------------===//
34 struct RecordNameComparator {
35 bool operator()(const Record *Rec1, const Record *Rec2) const {
36 return Rec1->getName() < Rec2->getName();
40 void InstrInfoEmitter::GatherItinClasses() {
41 std::vector<Record*> DefList =
42 Records.getAllDerivedDefinitions("InstrItinClass");
43 std::sort(DefList.begin(), DefList.end(), RecordNameComparator());
45 for (unsigned i = 0, N = DefList.size(); i < N; i++)
46 ItinClassMap[DefList[i]->getName()] = i;
49 unsigned InstrInfoEmitter::getItinClassNumber(const Record *InstRec) {
50 return ItinClassMap[InstRec->getValueAsDef("Itinerary")->getName()];
53 //===----------------------------------------------------------------------===//
54 // Operand Info Emission.
55 //===----------------------------------------------------------------------===//
57 std::vector<std::string>
58 InstrInfoEmitter::GetOperandInfo(const CodeGenInstruction &Inst) {
59 std::vector<std::string> Result;
61 for (unsigned i = 0, e = Inst.OperandList.size(); i != e; ++i) {
62 // Handle aggregate operands and normal operands the same way by expanding
63 // either case into a list of operands for this op.
64 std::vector<CodeGenInstruction::OperandInfo> OperandList;
66 // This might be a multiple operand thing. Targets like X86 have
67 // registers in their multi-operand operands. It may also be an anonymous
68 // operand, which has a single operand, but no declared class for the
70 DagInit *MIOI = Inst.OperandList[i].MIOperandInfo;
72 if (!MIOI || MIOI->getNumArgs() == 0) {
73 // Single, anonymous, operand.
74 OperandList.push_back(Inst.OperandList[i]);
76 for (unsigned j = 0, e = Inst.OperandList[i].MINumOperands; j != e; ++j) {
77 OperandList.push_back(Inst.OperandList[i]);
79 Record *OpR = dynamic_cast<DefInit*>(MIOI->getArg(j))->getDef();
80 OperandList.back().Rec = OpR;
84 for (unsigned j = 0, e = OperandList.size(); j != e; ++j) {
85 Record *OpR = OperandList[j].Rec;
88 if (OpR->isSubClassOf("RegisterClass"))
89 Res += getQualifiedName(OpR) + "RegClassID, ";
92 // Fill in applicable flags.
95 // Ptr value whose register class is resolved via callback.
96 if (OpR->getName() == "ptr_rc")
97 Res += "|(1<<TOI::LookupPtrRegClass)";
99 // Predicate operands. Check to see if the original unexpanded operand
100 // was of type PredicateOperand.
101 if (Inst.OperandList[i].Rec->isSubClassOf("PredicateOperand"))
102 Res += "|(1<<TOI::Predicate)";
104 // Optional def operands. Check to see if the original unexpanded operand
105 // was of type OptionalDefOperand.
106 if (Inst.OperandList[i].Rec->isSubClassOf("OptionalDefOperand"))
107 Res += "|(1<<TOI::OptionalDef)";
109 // Fill in constraint info.
110 Res += ", " + Inst.OperandList[i].Constraints[j];
111 Result.push_back(Res);
118 void InstrInfoEmitter::EmitOperandInfo(std::ostream &OS,
119 OperandInfoMapTy &OperandInfoIDs) {
120 // ID #0 is for no operand info.
121 unsigned OperandListNum = 0;
122 OperandInfoIDs[std::vector<std::string>()] = ++OperandListNum;
125 const CodeGenTarget &Target = CDP.getTargetInfo();
126 for (CodeGenTarget::inst_iterator II = Target.inst_begin(),
127 E = Target.inst_end(); II != E; ++II) {
128 std::vector<std::string> OperandInfo = GetOperandInfo(II->second);
129 unsigned &N = OperandInfoIDs[OperandInfo];
130 if (N != 0) continue;
132 N = ++OperandListNum;
133 OS << "static const TargetOperandInfo OperandInfo" << N << "[] = { ";
134 for (unsigned i = 0, e = OperandInfo.size(); i != e; ++i)
135 OS << "{ " << OperandInfo[i] << " }, ";
140 //===----------------------------------------------------------------------===//
141 // Instruction Analysis
142 //===----------------------------------------------------------------------===//
145 const CodeGenDAGPatterns &CDP;
148 bool &NeverHasSideEffects;
150 InstAnalyzer(const CodeGenDAGPatterns &cdp,
151 bool &maystore, bool &isload, bool &nhse)
152 : CDP(cdp), mayStore(maystore), isLoad(isload), NeverHasSideEffects(nhse) {
155 void Analyze(Record *InstRecord) {
156 const TreePattern *Pattern = CDP.getInstruction(InstRecord).getPattern();
157 if (Pattern == 0) return; // No pattern.
159 // Assume there is no side-effect unless we see one.
160 NeverHasSideEffects = true;
162 // FIXME: Assume only the first tree is the pattern. The others are clobber
164 AnalyzeNode(Pattern->getTree(0));
168 void AnalyzeNode(const TreePatternNode *N) {
173 if (N->getOperator()->getName() != "set") {
174 // Get information about the SDNode for the operator.
175 const SDNodeInfo &OpInfo = CDP.getSDNodeInfo(N->getOperator());
177 // If node writes to memory, it obviously stores to memory.
178 if (OpInfo.hasProperty(SDNPMayStore)) {
180 } else if (const CodeGenIntrinsic *IntInfo = N->getIntrinsicInfo(CDP)) {
181 // If this is an intrinsic, analyze it.
182 if (IntInfo->ModRef >= CodeGenIntrinsic::WriteArgMem)
183 mayStore = true;// Intrinsics that can write to memory are 'mayStore'.
187 for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i)
188 AnalyzeNode(N->getChild(i));
193 void InstrInfoEmitter::InferFromPattern(const CodeGenInstruction &Inst,
194 bool &mayStore, bool &isLoad,
195 bool &NeverHasSideEffects) {
196 mayStore = isLoad = NeverHasSideEffects = false;
198 InstAnalyzer(CDP, mayStore, isLoad, NeverHasSideEffects).Analyze(Inst.TheDef);
200 // InstAnalyzer only correctly analyzes mayStore so far.
201 if (Inst.mayStore) { // If the .td file explicitly sets mayStore, use it.
202 // If we decided that this is a store from the pattern, then the .td file
203 // entry is redundant.
206 "Warning: mayStore flag explicitly set on instruction '%s'"
207 " but flag already inferred from pattern.\n",
208 Inst.TheDef->getName().c_str());
212 // These two override everything.
213 isLoad = Inst.isSimpleLoad;
214 NeverHasSideEffects = Inst.neverHasSideEffects;
217 // If the .td file explicitly says there is no side effect, believe it.
218 if (Inst.neverHasSideEffects)
219 NeverHasSideEffects = true;
224 //===----------------------------------------------------------------------===//
226 //===----------------------------------------------------------------------===//
228 // run - Emit the main instruction description records for the target...
229 void InstrInfoEmitter::run(std::ostream &OS) {
232 EmitSourceFileHeader("Target Instruction Descriptors", OS);
233 OS << "namespace llvm {\n\n";
235 CodeGenTarget Target;
236 const std::string &TargetName = Target.getName();
237 Record *InstrInfo = Target.getInstructionSet();
239 // Keep track of all of the def lists we have emitted already.
240 std::map<std::vector<Record*>, unsigned> EmittedLists;
241 unsigned ListNumber = 0;
243 // Emit all of the instruction's implicit uses and defs.
244 for (CodeGenTarget::inst_iterator II = Target.inst_begin(),
245 E = Target.inst_end(); II != E; ++II) {
246 Record *Inst = II->second.TheDef;
247 std::vector<Record*> Uses = Inst->getValueAsListOfDefs("Uses");
249 unsigned &IL = EmittedLists[Uses];
250 if (!IL) PrintDefList(Uses, IL = ++ListNumber, OS);
252 std::vector<Record*> Defs = Inst->getValueAsListOfDefs("Defs");
254 unsigned &IL = EmittedLists[Defs];
255 if (!IL) PrintDefList(Defs, IL = ++ListNumber, OS);
259 OperandInfoMapTy OperandInfoIDs;
261 // Emit all of the operand info records.
262 EmitOperandInfo(OS, OperandInfoIDs);
264 // Emit all of the TargetInstrDescriptor records in their ENUM ordering.
266 OS << "\nstatic const TargetInstrDescriptor " << TargetName
268 std::vector<const CodeGenInstruction*> NumberedInstructions;
269 Target.getInstructionsByEnumValue(NumberedInstructions);
271 for (unsigned i = 0, e = NumberedInstructions.size(); i != e; ++i)
272 emitRecord(*NumberedInstructions[i], i, InstrInfo, EmittedLists,
275 OS << "} // End llvm namespace \n";
278 void InstrInfoEmitter::emitRecord(const CodeGenInstruction &Inst, unsigned Num,
280 std::map<std::vector<Record*>, unsigned> &EmittedLists,
281 const OperandInfoMapTy &OpInfo,
283 // Determine properties of the instruction from its pattern.
284 bool mayStore, isSimpleLoad, NeverHasSideEffects;
285 InferFromPattern(Inst, mayStore, isSimpleLoad, NeverHasSideEffects);
287 if (NeverHasSideEffects && Inst.mayHaveSideEffects) {
288 std::cerr << "error: Instruction '" << Inst.TheDef->getName()
289 << "' is marked with 'mayHaveSideEffects', but it can never have them!\n";
294 if (!Inst.OperandList.empty())
295 // Each logical operand can be multiple MI operands.
296 MinOperands = Inst.OperandList.back().MIOperandNo +
297 Inst.OperandList.back().MINumOperands;
300 OS << Num << ",\t" << MinOperands << ",\t"
301 << Inst.NumDefs << ",\t" << getItinClassNumber(Inst.TheDef)
302 << ",\t\"" << Inst.TheDef->getName() << "\", 0";
304 // Emit all of the target indepedent flags...
305 if (Inst.isReturn) OS << "|(1<<TID::Return)";
306 if (Inst.isBranch) OS << "|(1<<TID::Branch)";
307 if (Inst.isIndirectBranch) OS << "|(1<<TID::IndirectBranch)";
308 if (Inst.isBarrier) OS << "|(1<<TID::Barrier)";
309 if (Inst.hasDelaySlot) OS << "|(1<<TID::DelaySlot)";
310 if (Inst.isCall) OS << "|(1<<TID::Call)";
311 if (isSimpleLoad) OS << "|(1<<TID::SimpleLoad)";
312 if (mayStore) OS << "|(1<<TID::MayStore)";
313 if (Inst.isImplicitDef)OS << "|(1<<TID::ImplicitDef)";
314 if (Inst.isPredicable) OS << "|(1<<TID::Predicable)";
315 if (Inst.isConvertibleToThreeAddress) OS << "|(1<<TID::ConvertibleTo3Addr)";
316 if (Inst.isCommutable) OS << "|(1<<TID::Commutable)";
317 if (Inst.isTerminator) OS << "|(1<<TID::Terminator)";
318 if (Inst.isReMaterializable) OS << "|(1<<TID::Rematerializable)";
319 if (Inst.isNotDuplicable) OS << "|(1<<TID::NotDuplicable)";
320 if (Inst.hasOptionalDef) OS << "|(1<<TID::HasOptionalDef)";
321 if (Inst.usesCustomDAGSchedInserter)
322 OS << "|(1<<TID::UsesCustomDAGSchedInserter)";
323 if (Inst.isVariadic) OS << "|(1<<TID::Variadic)";
324 if (Inst.mayHaveSideEffects) OS << "|(1<<TID::MayHaveSideEffects)";
325 if (NeverHasSideEffects) OS << "|(1<<TID::NeverHasSideEffects)";
328 // Emit all of the target-specific flags...
329 ListInit *LI = InstrInfo->getValueAsListInit("TSFlagsFields");
330 ListInit *Shift = InstrInfo->getValueAsListInit("TSFlagsShifts");
331 if (LI->getSize() != Shift->getSize())
332 throw "Lengths of " + InstrInfo->getName() +
333 ":(TargetInfoFields, TargetInfoPositions) must be equal!";
335 for (unsigned i = 0, e = LI->getSize(); i != e; ++i)
336 emitShiftedValue(Inst.TheDef, dynamic_cast<StringInit*>(LI->getElement(i)),
337 dynamic_cast<IntInit*>(Shift->getElement(i)), OS);
341 // Emit the implicit uses and defs lists...
342 std::vector<Record*> UseList = Inst.TheDef->getValueAsListOfDefs("Uses");
346 OS << "ImplicitList" << EmittedLists[UseList] << ", ";
348 std::vector<Record*> DefList = Inst.TheDef->getValueAsListOfDefs("Defs");
352 OS << "ImplicitList" << EmittedLists[DefList] << ", ";
354 // Emit the operand info.
355 std::vector<std::string> OperandInfo = GetOperandInfo(Inst);
356 if (OperandInfo.empty())
359 OS << "OperandInfo" << OpInfo.find(OperandInfo)->second;
361 OS << " }, // Inst #" << Num << " = " << Inst.TheDef->getName() << "\n";
365 void InstrInfoEmitter::emitShiftedValue(Record *R, StringInit *Val,
366 IntInit *ShiftInt, std::ostream &OS) {
367 if (Val == 0 || ShiftInt == 0)
368 throw std::string("Illegal value or shift amount in TargetInfo*!");
369 RecordVal *RV = R->getValue(Val->getValue());
370 int Shift = ShiftInt->getValue();
372 if (RV == 0 || RV->getValue() == 0) {
373 // This isn't an error if this is a builtin instruction.
374 if (R->getName() != "PHI" &&
375 R->getName() != "INLINEASM" &&
376 R->getName() != "LABEL" &&
377 R->getName() != "EXTRACT_SUBREG" &&
378 R->getName() != "INSERT_SUBREG")
379 throw R->getName() + " doesn't have a field named '" +
380 Val->getValue() + "'!";
384 Init *Value = RV->getValue();
385 if (BitInit *BI = dynamic_cast<BitInit*>(Value)) {
386 if (BI->getValue()) OS << "|(1<<" << Shift << ")";
388 } else if (BitsInit *BI = dynamic_cast<BitsInit*>(Value)) {
389 // Convert the Bits to an integer to print...
390 Init *I = BI->convertInitializerTo(new IntRecTy());
392 if (IntInit *II = dynamic_cast<IntInit*>(I)) {
393 if (II->getValue()) {
395 OS << "|(" << II->getValue() << "<<" << Shift << ")";
397 OS << "|" << II->getValue();
402 } else if (IntInit *II = dynamic_cast<IntInit*>(Value)) {
403 if (II->getValue()) {
405 OS << "|(" << II->getValue() << "<<" << Shift << ")";
407 OS << II->getValue();
412 std::cerr << "Unhandled initializer: " << *Val << "\n";
413 throw "In record '" + R->getName() + "' for TSFlag emission.";