1 //===- RegisterInfoEmitter.cpp - Generate a Register File Desc. -*- C++ -*-===//
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 a target
11 // register file for a code generator. It uses instances of the Register,
12 // RegisterAliases, and RegisterClass classes to gather this information.
14 //===----------------------------------------------------------------------===//
16 #include "CodeGenRegisters.h"
17 #include "CodeGenTarget.h"
18 #include "SequenceToOffsetTable.h"
19 #include "llvm/ADT/BitVector.h"
20 #include "llvm/ADT/STLExtras.h"
21 #include "llvm/ADT/StringExtras.h"
22 #include "llvm/ADT/Twine.h"
23 #include "llvm/Support/Format.h"
24 #include "llvm/TableGen/Error.h"
25 #include "llvm/TableGen/Record.h"
26 #include "llvm/TableGen/TableGenBackend.h"
33 class RegisterInfoEmitter {
34 RecordKeeper &Records;
36 RegisterInfoEmitter(RecordKeeper &R) : Records(R) {}
38 // runEnums - Print out enum values for all of the registers.
39 void runEnums(raw_ostream &o, CodeGenTarget &Target, CodeGenRegBank &Bank);
41 // runMCDesc - Print out MC register descriptions.
42 void runMCDesc(raw_ostream &o, CodeGenTarget &Target, CodeGenRegBank &Bank);
44 // runTargetHeader - Emit a header fragment for the register info emitter.
45 void runTargetHeader(raw_ostream &o, CodeGenTarget &Target,
46 CodeGenRegBank &Bank);
48 // runTargetDesc - Output the target register and register file descriptions.
49 void runTargetDesc(raw_ostream &o, CodeGenTarget &Target,
50 CodeGenRegBank &Bank);
52 // run - Output the register file description.
53 void run(raw_ostream &o);
56 void EmitRegMapping(raw_ostream &o,
57 const std::vector<CodeGenRegister*> &Regs, bool isCtor);
58 void EmitRegMappingTables(raw_ostream &o,
59 const std::vector<CodeGenRegister*> &Regs,
61 void EmitRegClasses(raw_ostream &OS, CodeGenTarget &Target);
63 void EmitRegUnitPressure(raw_ostream &OS, const CodeGenRegBank &RegBank,
64 const std::string &ClassName);
66 } // End anonymous namespace
68 // runEnums - Print out enum values for all of the registers.
69 void RegisterInfoEmitter::runEnums(raw_ostream &OS,
70 CodeGenTarget &Target, CodeGenRegBank &Bank) {
71 const std::vector<CodeGenRegister*> &Registers = Bank.getRegisters();
73 // Register enums are stored as uint16_t in the tables. Make sure we'll fit.
74 assert(Registers.size() <= 0xffff && "Too many regs to fit in tables");
76 std::string Namespace = Registers[0]->TheDef->getValueAsString("Namespace");
78 emitSourceFileHeader("Target Register Enum Values", OS);
80 OS << "\n#ifdef GET_REGINFO_ENUM\n";
81 OS << "#undef GET_REGINFO_ENUM\n";
83 OS << "namespace llvm {\n\n";
85 OS << "class MCRegisterClass;\n"
86 << "extern const MCRegisterClass " << Namespace
87 << "MCRegisterClasses[];\n\n";
89 if (!Namespace.empty())
90 OS << "namespace " << Namespace << " {\n";
91 OS << "enum {\n NoRegister,\n";
93 for (unsigned i = 0, e = Registers.size(); i != e; ++i)
94 OS << " " << Registers[i]->getName() << " = " <<
95 Registers[i]->EnumValue << ",\n";
96 assert(Registers.size() == Registers[Registers.size()-1]->EnumValue &&
97 "Register enum value mismatch!");
98 OS << " NUM_TARGET_REGS \t// " << Registers.size()+1 << "\n";
100 if (!Namespace.empty())
103 ArrayRef<CodeGenRegisterClass*> RegisterClasses = Bank.getRegClasses();
104 if (!RegisterClasses.empty()) {
106 // RegisterClass enums are stored as uint16_t in the tables.
107 assert(RegisterClasses.size() <= 0xffff &&
108 "Too many register classes to fit in tables");
110 OS << "\n// Register classes\n";
111 if (!Namespace.empty())
112 OS << "namespace " << Namespace << " {\n";
114 for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
116 OS << " " << RegisterClasses[i]->getName() << "RegClassID";
120 if (!Namespace.empty())
124 const std::vector<Record*> RegAltNameIndices = Target.getRegAltNameIndices();
125 // If the only definition is the default NoRegAltName, we don't need to
127 if (RegAltNameIndices.size() > 1) {
128 OS << "\n// Register alternate name indices\n";
129 if (!Namespace.empty())
130 OS << "namespace " << Namespace << " {\n";
132 for (unsigned i = 0, e = RegAltNameIndices.size(); i != e; ++i)
133 OS << " " << RegAltNameIndices[i]->getName() << ",\t// " << i << "\n";
134 OS << " NUM_TARGET_REG_ALT_NAMES = " << RegAltNameIndices.size() << "\n";
136 if (!Namespace.empty())
140 ArrayRef<CodeGenSubRegIndex*> SubRegIndices = Bank.getSubRegIndices();
141 if (!SubRegIndices.empty()) {
142 OS << "\n// Subregister indices\n";
143 std::string Namespace =
144 SubRegIndices[0]->getNamespace();
145 if (!Namespace.empty())
146 OS << "namespace " << Namespace << " {\n";
147 OS << "enum {\n NoSubRegister,\n";
148 for (unsigned i = 0, e = Bank.getNumNamedIndices(); i != e; ++i)
149 OS << " " << SubRegIndices[i]->getName() << ",\t// " << i+1 << "\n";
150 OS << " NUM_TARGET_NAMED_SUBREGS\n};\n";
151 if (!Namespace.empty())
155 OS << "} // End llvm namespace \n";
156 OS << "#endif // GET_REGINFO_ENUM\n\n";
159 void RegisterInfoEmitter::
160 EmitRegUnitPressure(raw_ostream &OS, const CodeGenRegBank &RegBank,
161 const std::string &ClassName) {
162 unsigned NumRCs = RegBank.getRegClasses().size();
163 unsigned NumSets = RegBank.getNumRegPressureSets();
165 OS << "/// Get the weight in units of pressure for this register class.\n"
166 << "const RegClassWeight &" << ClassName << "::\n"
167 << "getRegClassWeight(const TargetRegisterClass *RC) const {\n"
168 << " static const RegClassWeight RCWeightTable[] = {\n";
169 for (unsigned i = 0, e = NumRCs; i != e; ++i) {
170 const CodeGenRegisterClass &RC = *RegBank.getRegClasses()[i];
171 const CodeGenRegister::Set &Regs = RC.getMembers();
175 std::vector<unsigned> RegUnits;
176 RC.buildRegUnitSet(RegUnits);
177 OS << " {" << (*Regs.begin())->getWeight(RegBank)
178 << ", " << RegBank.getRegUnitSetWeight(RegUnits);
180 OS << "}, \t// " << RC.getName() << "\n";
183 << " return RCWeightTable[RC->getID()];\n"
187 << "// Get the number of dimensions of register pressure.\n"
188 << "unsigned " << ClassName << "::getNumRegPressureSets() const {\n"
189 << " return " << NumSets << ";\n}\n\n";
191 OS << "// Get the name of this register unit pressure set.\n"
192 << "const char *" << ClassName << "::\n"
193 << "getRegPressureSetName(unsigned Idx) const {\n"
194 << " static const char *PressureNameTable[] = {\n";
195 for (unsigned i = 0; i < NumSets; ++i ) {
196 OS << " \"" << RegBank.getRegPressureSet(i).Name << "\",\n";
199 << " return PressureNameTable[Idx];\n"
202 OS << "// Get the register unit pressure limit for this dimension.\n"
203 << "// This limit must be adjusted dynamically for reserved registers.\n"
204 << "unsigned " << ClassName << "::\n"
205 << "getRegPressureSetLimit(unsigned Idx) const {\n"
206 << " static const unsigned PressureLimitTable[] = {\n";
207 for (unsigned i = 0; i < NumSets; ++i ) {
208 const RegUnitSet &RegUnits = RegBank.getRegPressureSet(i);
209 OS << " " << RegBank.getRegUnitSetWeight(RegUnits.Units)
210 << ", \t// " << i << ": " << RegUnits.Name << "\n";
213 << " return PressureLimitTable[Idx];\n"
216 OS << "/// Get the dimensions of register pressure "
217 << "impacted by this register class.\n"
218 << "/// Returns a -1 terminated array of pressure set IDs\n"
219 << "const int* " << ClassName << "::\n"
220 << "getRegClassPressureSets(const TargetRegisterClass *RC) const {\n"
221 << " static const int RCSetsTable[] = {\n ";
222 std::vector<unsigned> RCSetStarts(NumRCs);
223 for (unsigned i = 0, StartIdx = 0, e = NumRCs; i != e; ++i) {
224 RCSetStarts[i] = StartIdx;
225 ArrayRef<unsigned> PSetIDs = RegBank.getRCPressureSetIDs(i);
226 for (ArrayRef<unsigned>::iterator PSetI = PSetIDs.begin(),
227 PSetE = PSetIDs.end(); PSetI != PSetE; ++PSetI) {
228 OS << *PSetI << ", ";
231 OS << "-1, \t// " << RegBank.getRegClasses()[i]->getName() << "\n ";
235 OS << " static const unsigned RCSetStartTable[] = {\n ";
236 for (unsigned i = 0, e = NumRCs; i != e; ++i) {
237 OS << RCSetStarts[i] << ",";
240 << " unsigned SetListStart = RCSetStartTable[RC->getID()];\n"
241 << " return &RCSetsTable[SetListStart];\n"
246 RegisterInfoEmitter::EmitRegMappingTables(raw_ostream &OS,
247 const std::vector<CodeGenRegister*> &Regs,
249 // Collect all information about dwarf register numbers
250 typedef std::map<Record*, std::vector<int64_t>, LessRecord> DwarfRegNumsMapTy;
251 DwarfRegNumsMapTy DwarfRegNums;
253 // First, just pull all provided information to the map
254 unsigned maxLength = 0;
255 for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
256 Record *Reg = Regs[i]->TheDef;
257 std::vector<int64_t> RegNums = Reg->getValueAsListOfInts("DwarfNumbers");
258 maxLength = std::max((size_t)maxLength, RegNums.size());
259 if (DwarfRegNums.count(Reg))
260 PrintWarning(Reg->getLoc(), Twine("DWARF numbers for register ") +
261 getQualifiedName(Reg) + "specified multiple times");
262 DwarfRegNums[Reg] = RegNums;
268 // Now we know maximal length of number list. Append -1's, where needed
269 for (DwarfRegNumsMapTy::iterator
270 I = DwarfRegNums.begin(), E = DwarfRegNums.end(); I != E; ++I)
271 for (unsigned i = I->second.size(), e = maxLength; i != e; ++i)
272 I->second.push_back(-1);
274 std::string Namespace = Regs[0]->TheDef->getValueAsString("Namespace");
276 OS << "// " << Namespace << " Dwarf<->LLVM register mappings.\n";
278 // Emit reverse information about the dwarf register numbers.
279 for (unsigned j = 0; j < 2; ++j) {
280 for (unsigned i = 0, e = maxLength; i != e; ++i) {
281 OS << "extern const MCRegisterInfo::DwarfLLVMRegPair " << Namespace;
282 OS << (j == 0 ? "DwarfFlavour" : "EHFlavour");
283 OS << i << "Dwarf2L[]";
288 // Store the mapping sorted by the LLVM reg num so lookup can be done
289 // with a binary search.
290 std::map<uint64_t, Record*> Dwarf2LMap;
291 for (DwarfRegNumsMapTy::iterator
292 I = DwarfRegNums.begin(), E = DwarfRegNums.end(); I != E; ++I) {
293 int DwarfRegNo = I->second[i];
296 Dwarf2LMap[DwarfRegNo] = I->first;
299 for (std::map<uint64_t, Record*>::iterator
300 I = Dwarf2LMap.begin(), E = Dwarf2LMap.end(); I != E; ++I)
301 OS << " { " << I->first << "U, " << getQualifiedName(I->second)
309 // We have to store the size in a const global, it's used in multiple
311 OS << "extern const unsigned " << Namespace
312 << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i << "Dwarf2LSize";
314 OS << " = sizeof(" << Namespace
315 << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i
316 << "Dwarf2L)/sizeof(MCRegisterInfo::DwarfLLVMRegPair);\n\n";
322 for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
323 Record *Reg = Regs[i]->TheDef;
324 const RecordVal *V = Reg->getValue("DwarfAlias");
325 if (!V || !V->getValue())
328 DefInit *DI = dynamic_cast<DefInit*>(V->getValue());
329 Record *Alias = DI->getDef();
330 DwarfRegNums[Reg] = DwarfRegNums[Alias];
333 // Emit information about the dwarf register numbers.
334 for (unsigned j = 0; j < 2; ++j) {
335 for (unsigned i = 0, e = maxLength; i != e; ++i) {
336 OS << "extern const MCRegisterInfo::DwarfLLVMRegPair " << Namespace;
337 OS << (j == 0 ? "DwarfFlavour" : "EHFlavour");
338 OS << i << "L2Dwarf[]";
341 // Store the mapping sorted by the Dwarf reg num so lookup can be done
342 // with a binary search.
343 for (DwarfRegNumsMapTy::iterator
344 I = DwarfRegNums.begin(), E = DwarfRegNums.end(); I != E; ++I) {
345 int RegNo = I->second[i];
346 if (RegNo == -1) // -1 is the default value, don't emit a mapping.
349 OS << " { " << getQualifiedName(I->first) << ", " << RegNo
357 // We have to store the size in a const global, it's used in multiple
359 OS << "extern const unsigned " << Namespace
360 << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i << "L2DwarfSize";
362 OS << " = sizeof(" << Namespace
363 << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i
364 << "L2Dwarf)/sizeof(MCRegisterInfo::DwarfLLVMRegPair);\n\n";
372 RegisterInfoEmitter::EmitRegMapping(raw_ostream &OS,
373 const std::vector<CodeGenRegister*> &Regs,
375 // Emit the initializer so the tables from EmitRegMappingTables get wired up
376 // to the MCRegisterInfo object.
377 unsigned maxLength = 0;
378 for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
379 Record *Reg = Regs[i]->TheDef;
380 maxLength = std::max((size_t)maxLength,
381 Reg->getValueAsListOfInts("DwarfNumbers").size());
387 std::string Namespace = Regs[0]->TheDef->getValueAsString("Namespace");
389 // Emit reverse information about the dwarf register numbers.
390 for (unsigned j = 0; j < 2; ++j) {
393 OS << "DwarfFlavour";
398 << " llvm_unreachable(\"Unknown DWARF flavour\");\n";
400 for (unsigned i = 0, e = maxLength; i != e; ++i) {
401 OS << " case " << i << ":\n";
406 raw_string_ostream(Tmp) << Namespace
407 << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i
409 OS << "mapDwarfRegsToLLVMRegs(" << Tmp << ", " << Tmp << "Size, ";
420 // Emit information about the dwarf register numbers.
421 for (unsigned j = 0; j < 2; ++j) {
424 OS << "DwarfFlavour";
429 << " llvm_unreachable(\"Unknown DWARF flavour\");\n";
431 for (unsigned i = 0, e = maxLength; i != e; ++i) {
432 OS << " case " << i << ":\n";
437 raw_string_ostream(Tmp) << Namespace
438 << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i
440 OS << "mapLLVMRegsToDwarfRegs(" << Tmp << ", " << Tmp << "Size, ";
452 // Print a BitVector as a sequence of hex numbers using a little-endian mapping.
453 // Width is the number of bits per hex number.
454 static void printBitVectorAsHex(raw_ostream &OS,
455 const BitVector &Bits,
457 assert(Width <= 32 && "Width too large");
458 unsigned Digits = (Width + 3) / 4;
459 for (unsigned i = 0, e = Bits.size(); i < e; i += Width) {
461 for (unsigned j = 0; j != Width && i + j != e; ++j)
462 Value |= Bits.test(i + j) << j;
463 OS << format("0x%0*x, ", Digits, Value);
467 // Helper to emit a set of bits into a constant byte array.
468 class BitVectorEmitter {
471 void add(unsigned v) {
472 if (v >= Values.size())
473 Values.resize(((v/8)+1)*8); // Round up to the next byte.
477 void print(raw_ostream &OS) {
478 printBitVectorAsHex(OS, Values, 8);
482 static void printSimpleValueType(raw_ostream &OS, MVT::SimpleValueType VT) {
483 OS << getEnumName(VT);
486 static void printSubRegIndex(raw_ostream &OS, const CodeGenSubRegIndex *Idx) {
487 OS << Idx->EnumValue;
490 // Differentially encoded register and regunit lists allow for better
491 // compression on regular register banks. The sequence is computed from the
492 // differential list as:
495 // out[n+1] = out[n] + diff[n]; // n = 0, 1, ...
497 // The initial value depends on the specific list. The list is terminated by a
498 // 0 differential which means we can't encode repeated elements.
500 typedef SmallVector<uint16_t, 4> DiffVec;
502 // Differentially encode a sequence of numbers into V. The starting value and
503 // terminating 0 are not added to V, so it will have the same size as List.
505 DiffVec &diffEncode(DiffVec &V, unsigned InitVal, ArrayRef<unsigned> List) {
506 assert(V.empty() && "Clear DiffVec before diffEncode.");
507 uint16_t Val = uint16_t(InitVal);
508 for (unsigned i = 0; i != List.size(); ++i) {
509 uint16_t Cur = List[i];
510 V.push_back(Cur - Val);
516 template<typename Iter>
518 DiffVec &diffEncode(DiffVec &V, unsigned InitVal, Iter Begin, Iter End) {
519 assert(V.empty() && "Clear DiffVec before diffEncode.");
520 uint16_t Val = uint16_t(InitVal);
521 for (Iter I = Begin; I != End; ++I) {
522 uint16_t Cur = (*I)->EnumValue;
523 V.push_back(Cur - Val);
529 static void printDiff16(raw_ostream &OS, uint16_t Val) {
534 // runMCDesc - Print out MC register descriptions.
537 RegisterInfoEmitter::runMCDesc(raw_ostream &OS, CodeGenTarget &Target,
538 CodeGenRegBank &RegBank) {
539 emitSourceFileHeader("MC Register Information", OS);
541 OS << "\n#ifdef GET_REGINFO_MC_DESC\n";
542 OS << "#undef GET_REGINFO_MC_DESC\n";
544 const std::vector<CodeGenRegister*> &Regs = RegBank.getRegisters();
546 // The lists of sub-registers, super-registers, and overlaps all go in the
547 // same array. That allows us to share suffixes.
548 typedef std::vector<const CodeGenRegister*> RegVec;
550 // Differentially encoded lists.
551 SequenceToOffsetTable<DiffVec> DiffSeqs;
552 SmallVector<DiffVec, 4> SubRegLists(Regs.size());
553 SmallVector<DiffVec, 4> SuperRegLists(Regs.size());
554 SmallVector<DiffVec, 4> OverlapLists(Regs.size());
555 SmallVector<DiffVec, 4> RegUnitLists(Regs.size());
556 SmallVector<unsigned, 4> RegUnitInitScale(Regs.size());
558 // Keep track of sub-register names as well. These are not differentially
560 typedef SmallVector<const CodeGenSubRegIndex*, 4> SubRegIdxVec;
561 SequenceToOffsetTable<SubRegIdxVec> SubRegIdxSeqs;
562 SmallVector<SubRegIdxVec, 4> SubRegIdxLists(Regs.size());
564 SequenceToOffsetTable<std::string> RegStrings;
566 // Precompute register lists for the SequenceToOffsetTable.
567 for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
568 const CodeGenRegister *Reg = Regs[i];
570 RegStrings.add(Reg->getName());
572 // Compute the ordered sub-register list.
573 SetVector<const CodeGenRegister*> SR;
574 Reg->addSubRegsPreOrder(SR, RegBank);
575 diffEncode(SubRegLists[i], Reg->EnumValue, SR.begin(), SR.end());
576 DiffSeqs.add(SubRegLists[i]);
578 // Compute the corresponding sub-register indexes.
579 SubRegIdxVec &SRIs = SubRegIdxLists[i];
580 for (unsigned j = 0, je = SR.size(); j != je; ++j)
581 SRIs.push_back(Reg->getSubRegIndex(SR[j]));
582 SubRegIdxSeqs.add(SRIs);
584 // Super-registers are already computed.
585 const RegVec &SuperRegList = Reg->getSuperRegs();
586 diffEncode(SuperRegLists[i], Reg->EnumValue,
587 SuperRegList.begin(), SuperRegList.end());
588 DiffSeqs.add(SuperRegLists[i]);
590 // The list of overlaps doesn't need to have any particular order, and Reg
591 // itself must be omitted.
592 DiffVec &OverlapList = OverlapLists[i];
593 CodeGenRegister::Set OSet;
594 Reg->computeOverlaps(OSet, RegBank);
596 diffEncode(OverlapList, Reg->EnumValue, OSet.begin(), OSet.end());
597 DiffSeqs.add(OverlapList);
599 // Differentially encode the register unit list, seeded by register number.
600 // First compute a scale factor that allows more diff-lists to be reused:
605 // A scale factor of 2 allows D0 and D1 to share a diff-list. The initial
606 // value for the differential decoder is the register number multiplied by
609 // Check the neighboring registers for arithmetic progressions.
610 unsigned ScaleA = ~0u, ScaleB = ~0u;
611 ArrayRef<unsigned> RUs = Reg->getNativeRegUnits();
612 if (i > 0 && Regs[i-1]->getNativeRegUnits().size() == RUs.size())
613 ScaleB = RUs.front() - Regs[i-1]->getNativeRegUnits().front();
614 if (i+1 != Regs.size() &&
615 Regs[i+1]->getNativeRegUnits().size() == RUs.size())
616 ScaleA = Regs[i+1]->getNativeRegUnits().front() - RUs.front();
617 unsigned Scale = std::min(ScaleB, ScaleA);
618 // Default the scale to 0 if it can't be encoded in 4 bits.
621 RegUnitInitScale[i] = Scale;
622 DiffSeqs.add(diffEncode(RegUnitLists[i], Scale * Reg->EnumValue, RUs));
625 // Compute the final layout of the sequence table.
627 SubRegIdxSeqs.layout();
629 OS << "namespace llvm {\n\n";
631 const std::string &TargetName = Target.getName();
633 // Emit the shared table of differential lists.
634 OS << "extern const uint16_t " << TargetName << "RegDiffLists[] = {\n";
635 DiffSeqs.emit(OS, printDiff16);
638 // Emit the table of sub-register indexes.
639 OS << "extern const uint16_t " << TargetName << "SubRegIdxLists[] = {\n";
640 SubRegIdxSeqs.emit(OS, printSubRegIndex);
643 // Emit the string table.
645 OS << "extern const char " << TargetName << "RegStrings[] = {\n";
646 RegStrings.emit(OS, printChar);
649 OS << "extern const MCRegisterDesc " << TargetName
650 << "RegDesc[] = { // Descriptors\n";
651 OS << " { " << RegStrings.get("") << ", 0, 0, 0, 0, 0 },\n";
653 // Emit the register descriptors now.
654 for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
655 const CodeGenRegister *Reg = Regs[i];
656 OS << " { " << RegStrings.get(Reg->getName()) << ", "
657 << DiffSeqs.get(OverlapLists[i]) << ", "
658 << DiffSeqs.get(SubRegLists[i]) << ", "
659 << DiffSeqs.get(SuperRegLists[i]) << ", "
660 << SubRegIdxSeqs.get(SubRegIdxLists[i]) << ", "
661 << (DiffSeqs.get(RegUnitLists[i])*16 + RegUnitInitScale[i]) << " },\n";
663 OS << "};\n\n"; // End of register descriptors...
665 // Emit the table of register unit roots. Each regunit has one or two root
667 OS << "extern const uint16_t " << TargetName << "RegUnitRoots[][2] = {\n";
668 for (unsigned i = 0, e = RegBank.getNumNativeRegUnits(); i != e; ++i) {
669 ArrayRef<const CodeGenRegister*> Roots = RegBank.getRegUnit(i).getRoots();
670 assert(!Roots.empty() && "All regunits must have a root register.");
671 assert(Roots.size() <= 2 && "More than two roots not supported yet.");
672 OS << " { " << getQualifiedName(Roots.front()->TheDef);
673 for (unsigned r = 1; r != Roots.size(); ++r)
674 OS << ", " << getQualifiedName(Roots[r]->TheDef);
679 ArrayRef<CodeGenRegisterClass*> RegisterClasses = RegBank.getRegClasses();
681 // Loop over all of the register classes... emitting each one.
682 OS << "namespace { // Register classes...\n";
684 // Emit the register enum value arrays for each RegisterClass
685 for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
686 const CodeGenRegisterClass &RC = *RegisterClasses[rc];
687 ArrayRef<Record*> Order = RC.getOrder();
689 // Give the register class a legal C name if it's anonymous.
690 std::string Name = RC.getName();
692 // Emit the register list now.
693 OS << " // " << Name << " Register Class...\n"
694 << " const uint16_t " << Name
696 for (unsigned i = 0, e = Order.size(); i != e; ++i) {
697 Record *Reg = Order[i];
698 OS << getQualifiedName(Reg) << ", ";
702 OS << " // " << Name << " Bit set.\n"
703 << " const uint8_t " << Name
705 BitVectorEmitter BVE;
706 for (unsigned i = 0, e = Order.size(); i != e; ++i) {
707 Record *Reg = Order[i];
708 BVE.add(Target.getRegBank().getReg(Reg)->EnumValue);
716 OS << "extern const MCRegisterClass " << TargetName
717 << "MCRegisterClasses[] = {\n";
719 for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
720 const CodeGenRegisterClass &RC = *RegisterClasses[rc];
722 // Asserts to make sure values will fit in table assuming types from
724 assert((RC.SpillSize/8) <= 0xffff && "SpillSize too large.");
725 assert((RC.SpillAlignment/8) <= 0xffff && "SpillAlignment too large.");
726 assert(RC.CopyCost >= -128 && RC.CopyCost <= 127 && "Copy cost too large.");
728 OS << " { " << '\"' << RC.getName() << "\", "
729 << RC.getName() << ", " << RC.getName() << "Bits, "
730 << RC.getOrder().size() << ", sizeof(" << RC.getName() << "Bits), "
731 << RC.getQualifiedName() + "RegClassID" << ", "
732 << RC.SpillSize/8 << ", "
733 << RC.SpillAlignment/8 << ", "
734 << RC.CopyCost << ", "
735 << RC.Allocatable << " },\n";
740 ArrayRef<CodeGenSubRegIndex*> SubRegIndices = RegBank.getSubRegIndices();
742 EmitRegMappingTables(OS, Regs, false);
744 // Emit Reg encoding table
745 OS << "extern const uint16_t " << TargetName;
746 OS << "RegEncodingTable[] = {\n";
747 // Add entry for NoRegister
749 for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
750 Record *Reg = Regs[i]->TheDef;
751 BitsInit *BI = Reg->getValueAsBitsInit("HWEncoding");
753 for (unsigned b = 0, be = BI->getNumBits(); b != be; ++b) {
754 if (BitInit *B = dynamic_cast<BitInit*>(BI->getBit(b)))
755 Value |= (uint64_t)B->getValue() << b;
757 OS << " " << Value << ",\n";
759 OS << "};\n"; // End of HW encoding table
761 // MCRegisterInfo initialization routine.
762 OS << "static inline void Init" << TargetName
763 << "MCRegisterInfo(MCRegisterInfo *RI, unsigned RA, "
764 << "unsigned DwarfFlavour = 0, unsigned EHFlavour = 0) {\n"
765 << " RI->InitMCRegisterInfo(" << TargetName << "RegDesc, "
766 << Regs.size()+1 << ", RA, " << TargetName << "MCRegisterClasses, "
767 << RegisterClasses.size() << ", "
768 << TargetName << "RegUnitRoots, "
769 << RegBank.getNumNativeRegUnits() << ", "
770 << TargetName << "RegDiffLists, "
771 << TargetName << "RegStrings, "
772 << TargetName << "SubRegIdxLists, "
773 << SubRegIndices.size() << ",\n"
774 << " " << TargetName << "RegEncodingTable);\n\n";
776 EmitRegMapping(OS, Regs, false);
780 OS << "} // End llvm namespace \n";
781 OS << "#endif // GET_REGINFO_MC_DESC\n\n";
785 RegisterInfoEmitter::runTargetHeader(raw_ostream &OS, CodeGenTarget &Target,
786 CodeGenRegBank &RegBank) {
787 emitSourceFileHeader("Register Information Header Fragment", OS);
789 OS << "\n#ifdef GET_REGINFO_HEADER\n";
790 OS << "#undef GET_REGINFO_HEADER\n";
792 const std::string &TargetName = Target.getName();
793 std::string ClassName = TargetName + "GenRegisterInfo";
795 OS << "#include \"llvm/Target/TargetRegisterInfo.h\"\n\n";
797 OS << "namespace llvm {\n\n";
799 OS << "struct " << ClassName << " : public TargetRegisterInfo {\n"
800 << " explicit " << ClassName
801 << "(unsigned RA, unsigned D = 0, unsigned E = 0);\n"
802 << " virtual bool needsStackRealignment(const MachineFunction &) const\n"
803 << " { return false; }\n";
804 if (!RegBank.getSubRegIndices().empty()) {
805 OS << " unsigned composeSubRegIndices(unsigned, unsigned) const;\n"
806 << " const TargetRegisterClass *"
807 "getSubClassWithSubReg(const TargetRegisterClass*, unsigned) const;\n";
809 OS << " const RegClassWeight &getRegClassWeight("
810 << "const TargetRegisterClass *RC) const;\n"
811 << " unsigned getNumRegPressureSets() const;\n"
812 << " const char *getRegPressureSetName(unsigned Idx) const;\n"
813 << " unsigned getRegPressureSetLimit(unsigned Idx) const;\n"
814 << " const int *getRegClassPressureSets("
815 << "const TargetRegisterClass *RC) const;\n"
818 ArrayRef<CodeGenRegisterClass*> RegisterClasses = RegBank.getRegClasses();
820 if (!RegisterClasses.empty()) {
821 OS << "namespace " << RegisterClasses[0]->Namespace
822 << " { // Register classes\n";
824 for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
825 const CodeGenRegisterClass &RC = *RegisterClasses[i];
826 const std::string &Name = RC.getName();
828 // Output the extern for the instance.
829 OS << " extern const TargetRegisterClass " << Name << "RegClass;\n";
831 OS << "} // end of namespace " << TargetName << "\n\n";
833 OS << "} // End llvm namespace \n";
834 OS << "#endif // GET_REGINFO_HEADER\n\n";
838 // runTargetDesc - Output the target register and register file descriptions.
841 RegisterInfoEmitter::runTargetDesc(raw_ostream &OS, CodeGenTarget &Target,
842 CodeGenRegBank &RegBank){
843 emitSourceFileHeader("Target Register and Register Classes Information", OS);
845 OS << "\n#ifdef GET_REGINFO_TARGET_DESC\n";
846 OS << "#undef GET_REGINFO_TARGET_DESC\n";
848 OS << "namespace llvm {\n\n";
850 // Get access to MCRegisterClass data.
851 OS << "extern const MCRegisterClass " << Target.getName()
852 << "MCRegisterClasses[];\n";
854 // Start out by emitting each of the register classes.
855 ArrayRef<CodeGenRegisterClass*> RegisterClasses = RegBank.getRegClasses();
856 ArrayRef<CodeGenSubRegIndex*> SubRegIndices = RegBank.getSubRegIndices();
858 // Collect all registers belonging to any allocatable class.
859 std::set<Record*> AllocatableRegs;
861 // Collect allocatable registers.
862 for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
863 const CodeGenRegisterClass &RC = *RegisterClasses[rc];
864 ArrayRef<Record*> Order = RC.getOrder();
867 AllocatableRegs.insert(Order.begin(), Order.end());
870 // Build a shared array of value types.
871 SequenceToOffsetTable<std::vector<MVT::SimpleValueType> > VTSeqs;
872 for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc)
873 VTSeqs.add(RegisterClasses[rc]->VTs);
875 OS << "\nstatic const MVT::SimpleValueType VTLists[] = {\n";
876 VTSeqs.emit(OS, printSimpleValueType, "MVT::Other");
879 // Emit SubRegIndex names, skipping 0
880 OS << "\nstatic const char *const SubRegIndexTable[] = { \"";
881 for (unsigned i = 0, e = SubRegIndices.size(); i != e; ++i) {
882 OS << SubRegIndices[i]->getName();
888 // Emit names of the anonymous subreg indices.
889 unsigned NamedIndices = RegBank.getNumNamedIndices();
890 if (SubRegIndices.size() > NamedIndices) {
892 for (unsigned i = NamedIndices, e = SubRegIndices.size(); i != e; ++i) {
893 OS << "\n " << SubRegIndices[i]->getName() << " = " << i+1;
901 // Now that all of the structs have been emitted, emit the instances.
902 if (!RegisterClasses.empty()) {
903 OS << "\nstatic const TargetRegisterClass *const "
904 << "NullRegClasses[] = { NULL };\n\n";
906 // Emit register class bit mask tables. The first bit mask emitted for a
907 // register class, RC, is the set of sub-classes, including RC itself.
909 // If RC has super-registers, also create a list of subreg indices and bit
910 // masks, (Idx, Mask). The bit mask has a bit for every superreg regclass,
911 // SuperRC, that satisfies:
913 // For all SuperReg in SuperRC: SuperReg:Idx in RC
915 // The 0-terminated list of subreg indices starts at:
917 // RC->getSuperRegIndices() = SuperRegIdxSeqs + ...
919 // The corresponding bitmasks follow the sub-class mask in memory. Each
920 // mask has RCMaskWords uint32_t entries.
922 // Every bit mask present in the list has at least one bit set.
924 // Compress the sub-reg index lists.
925 typedef std::vector<const CodeGenSubRegIndex*> IdxList;
926 SmallVector<IdxList, 8> SuperRegIdxLists(RegisterClasses.size());
927 SequenceToOffsetTable<IdxList> SuperRegIdxSeqs;
928 BitVector MaskBV(RegisterClasses.size());
930 for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
931 const CodeGenRegisterClass &RC = *RegisterClasses[rc];
932 OS << "static const uint32_t " << RC.getName() << "SubClassMask[] = {\n ";
933 printBitVectorAsHex(OS, RC.getSubClasses(), 32);
935 // Emit super-reg class masks for any relevant SubRegIndices that can
937 IdxList &SRIList = SuperRegIdxLists[rc];
938 for (unsigned sri = 0, sre = SubRegIndices.size(); sri != sre; ++sri) {
939 CodeGenSubRegIndex *Idx = SubRegIndices[sri];
941 RC.getSuperRegClasses(Idx, MaskBV);
944 SRIList.push_back(Idx);
946 printBitVectorAsHex(OS, MaskBV, 32);
947 OS << "// " << Idx->getName();
949 SuperRegIdxSeqs.add(SRIList);
953 OS << "static const uint16_t SuperRegIdxSeqs[] = {\n";
954 SuperRegIdxSeqs.layout();
955 SuperRegIdxSeqs.emit(OS, printSubRegIndex);
958 // Emit NULL terminated super-class lists.
959 for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
960 const CodeGenRegisterClass &RC = *RegisterClasses[rc];
961 ArrayRef<CodeGenRegisterClass*> Supers = RC.getSuperClasses();
963 // Skip classes without supers. We can reuse NullRegClasses.
967 OS << "static const TargetRegisterClass *const "
968 << RC.getName() << "Superclasses[] = {\n";
969 for (unsigned i = 0; i != Supers.size(); ++i)
970 OS << " &" << Supers[i]->getQualifiedName() << "RegClass,\n";
971 OS << " NULL\n};\n\n";
975 for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
976 const CodeGenRegisterClass &RC = *RegisterClasses[i];
977 if (!RC.AltOrderSelect.empty()) {
978 OS << "\nstatic inline unsigned " << RC.getName()
979 << "AltOrderSelect(const MachineFunction &MF) {"
980 << RC.AltOrderSelect << "}\n\n"
981 << "static ArrayRef<uint16_t> " << RC.getName()
982 << "GetRawAllocationOrder(const MachineFunction &MF) {\n";
983 for (unsigned oi = 1 , oe = RC.getNumOrders(); oi != oe; ++oi) {
984 ArrayRef<Record*> Elems = RC.getOrder(oi);
985 if (!Elems.empty()) {
986 OS << " static const uint16_t AltOrder" << oi << "[] = {";
987 for (unsigned elem = 0; elem != Elems.size(); ++elem)
988 OS << (elem ? ", " : " ") << getQualifiedName(Elems[elem]);
992 OS << " const MCRegisterClass &MCR = " << Target.getName()
993 << "MCRegisterClasses[" << RC.getQualifiedName() + "RegClassID];\n"
994 << " const ArrayRef<uint16_t> Order[] = {\n"
995 << " makeArrayRef(MCR.begin(), MCR.getNumRegs()";
996 for (unsigned oi = 1, oe = RC.getNumOrders(); oi != oe; ++oi)
997 if (RC.getOrder(oi).empty())
998 OS << "),\n ArrayRef<uint16_t>(";
1000 OS << "),\n makeArrayRef(AltOrder" << oi;
1001 OS << ")\n };\n const unsigned Select = " << RC.getName()
1002 << "AltOrderSelect(MF);\n assert(Select < " << RC.getNumOrders()
1003 << ");\n return Order[Select];\n}\n";
1007 // Now emit the actual value-initialized register class instances.
1008 OS << "namespace " << RegisterClasses[0]->Namespace
1009 << " { // Register class instances\n";
1011 for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
1012 const CodeGenRegisterClass &RC = *RegisterClasses[i];
1013 OS << " extern const TargetRegisterClass "
1014 << RegisterClasses[i]->getName() << "RegClass = {\n "
1015 << '&' << Target.getName() << "MCRegisterClasses[" << RC.getName()
1016 << "RegClassID],\n "
1017 << "VTLists + " << VTSeqs.get(RC.VTs) << ",\n "
1018 << RC.getName() << "SubClassMask,\n SuperRegIdxSeqs + "
1019 << SuperRegIdxSeqs.get(SuperRegIdxLists[i]) << ",\n ";
1020 if (RC.getSuperClasses().empty())
1021 OS << "NullRegClasses,\n ";
1023 OS << RC.getName() << "Superclasses,\n ";
1024 if (RC.AltOrderSelect.empty())
1027 OS << RC.getName() << "GetRawAllocationOrder\n";
1034 OS << "\nnamespace {\n";
1035 OS << " const TargetRegisterClass* const RegisterClasses[] = {\n";
1036 for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i)
1037 OS << " &" << RegisterClasses[i]->getQualifiedName()
1040 OS << "}\n"; // End of anonymous namespace...
1042 // Emit extra information about registers.
1043 const std::string &TargetName = Target.getName();
1044 OS << "\nstatic const TargetRegisterInfoDesc "
1045 << TargetName << "RegInfoDesc[] = { // Extra Descriptors\n";
1046 OS << " { 0, 0 },\n";
1048 const std::vector<CodeGenRegister*> &Regs = RegBank.getRegisters();
1049 for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
1050 const CodeGenRegister &Reg = *Regs[i];
1052 OS << Reg.CostPerUse << ", "
1053 << int(AllocatableRegs.count(Reg.TheDef)) << " },\n";
1055 OS << "};\n"; // End of register descriptors...
1058 std::string ClassName = Target.getName() + "GenRegisterInfo";
1060 // Emit composeSubRegIndices
1061 if (!SubRegIndices.empty()) {
1062 OS << "unsigned " << ClassName
1063 << "::composeSubRegIndices(unsigned IdxA, unsigned IdxB) const {\n"
1064 << " switch (IdxA) {\n"
1065 << " default:\n return IdxB;\n";
1066 for (unsigned i = 0, e = SubRegIndices.size(); i != e; ++i) {
1068 for (unsigned j = 0; j != e; ++j) {
1069 if (CodeGenSubRegIndex *Comp =
1070 SubRegIndices[i]->compose(SubRegIndices[j])) {
1072 OS << " case " << SubRegIndices[i]->getQualifiedName()
1073 << ": switch(IdxB) {\n default: return IdxB;\n";
1076 OS << " case " << SubRegIndices[j]->getQualifiedName()
1077 << ": return " << Comp->getQualifiedName() << ";\n";
1086 // Emit getSubClassWithSubReg.
1087 if (!SubRegIndices.empty()) {
1088 OS << "const TargetRegisterClass *" << ClassName
1089 << "::getSubClassWithSubReg(const TargetRegisterClass *RC, unsigned Idx)"
1091 // Use the smallest type that can hold a regclass ID with room for a
1093 if (RegisterClasses.size() < UINT8_MAX)
1094 OS << " static const uint8_t Table[";
1095 else if (RegisterClasses.size() < UINT16_MAX)
1096 OS << " static const uint16_t Table[";
1098 throw "Too many register classes.";
1099 OS << RegisterClasses.size() << "][" << SubRegIndices.size() << "] = {\n";
1100 for (unsigned rci = 0, rce = RegisterClasses.size(); rci != rce; ++rci) {
1101 const CodeGenRegisterClass &RC = *RegisterClasses[rci];
1102 OS << " {\t// " << RC.getName() << "\n";
1103 for (unsigned sri = 0, sre = SubRegIndices.size(); sri != sre; ++sri) {
1104 CodeGenSubRegIndex *Idx = SubRegIndices[sri];
1105 if (CodeGenRegisterClass *SRC = RC.getSubClassWithSubReg(Idx))
1106 OS << " " << SRC->EnumValue + 1 << ",\t// " << Idx->getName()
1107 << " -> " << SRC->getName() << "\n";
1109 OS << " 0,\t// " << Idx->getName() << "\n";
1113 OS << " };\n assert(RC && \"Missing regclass\");\n"
1114 << " if (!Idx) return RC;\n --Idx;\n"
1115 << " assert(Idx < " << SubRegIndices.size() << " && \"Bad subreg\");\n"
1116 << " unsigned TV = Table[RC->getID()][Idx];\n"
1117 << " return TV ? getRegClass(TV - 1) : 0;\n}\n\n";
1120 EmitRegUnitPressure(OS, RegBank, ClassName);
1122 // Emit the constructor of the class...
1123 OS << "extern const MCRegisterDesc " << TargetName << "RegDesc[];\n";
1124 OS << "extern const uint16_t " << TargetName << "RegDiffLists[];\n";
1125 OS << "extern const char " << TargetName << "RegStrings[];\n";
1126 OS << "extern const uint16_t " << TargetName << "RegUnitRoots[][2];\n";
1127 OS << "extern const uint16_t " << TargetName << "SubRegIdxLists[];\n";
1128 OS << "extern const uint16_t " << TargetName << "RegEncodingTable[];\n";
1130 EmitRegMappingTables(OS, Regs, true);
1132 OS << ClassName << "::\n" << ClassName
1133 << "(unsigned RA, unsigned DwarfFlavour, unsigned EHFlavour)\n"
1134 << " : TargetRegisterInfo(" << TargetName << "RegInfoDesc"
1135 << ", RegisterClasses, RegisterClasses+" << RegisterClasses.size() <<",\n"
1136 << " SubRegIndexTable) {\n"
1137 << " InitMCRegisterInfo(" << TargetName << "RegDesc, "
1138 << Regs.size()+1 << ", RA,\n " << TargetName
1139 << "MCRegisterClasses, " << RegisterClasses.size() << ",\n"
1140 << " " << TargetName << "RegUnitRoots,\n"
1141 << " " << RegBank.getNumNativeRegUnits() << ",\n"
1142 << " " << TargetName << "RegDiffLists,\n"
1143 << " " << TargetName << "RegStrings,\n"
1144 << " " << TargetName << "SubRegIdxLists,\n"
1145 << " " << SubRegIndices.size() << ",\n"
1146 << " " << TargetName << "RegEncodingTable);\n\n";
1148 EmitRegMapping(OS, Regs, true);
1153 // Emit CalleeSavedRegs information.
1154 std::vector<Record*> CSRSets =
1155 Records.getAllDerivedDefinitions("CalleeSavedRegs");
1156 for (unsigned i = 0, e = CSRSets.size(); i != e; ++i) {
1157 Record *CSRSet = CSRSets[i];
1158 const SetTheory::RecVec *Regs = RegBank.getSets().expand(CSRSet);
1159 assert(Regs && "Cannot expand CalleeSavedRegs instance");
1161 // Emit the *_SaveList list of callee-saved registers.
1162 OS << "static const uint16_t " << CSRSet->getName()
1163 << "_SaveList[] = { ";
1164 for (unsigned r = 0, re = Regs->size(); r != re; ++r)
1165 OS << getQualifiedName((*Regs)[r]) << ", ";
1168 // Emit the *_RegMask bit mask of call-preserved registers.
1169 OS << "static const uint32_t " << CSRSet->getName()
1170 << "_RegMask[] = { ";
1171 printBitVectorAsHex(OS, RegBank.computeCoveredRegisters(*Regs), 32);
1176 OS << "} // End llvm namespace \n";
1177 OS << "#endif // GET_REGINFO_TARGET_DESC\n\n";
1180 void RegisterInfoEmitter::run(raw_ostream &OS) {
1181 CodeGenTarget Target(Records);
1182 CodeGenRegBank &RegBank = Target.getRegBank();
1183 RegBank.computeDerivedInfo();
1185 runEnums(OS, Target, RegBank);
1186 runMCDesc(OS, Target, RegBank);
1187 runTargetHeader(OS, Target, RegBank);
1188 runTargetDesc(OS, Target, RegBank);
1193 void EmitRegisterInfo(RecordKeeper &RK, raw_ostream &OS) {
1194 RegisterInfoEmitter(RK).run(OS);
1197 } // End llvm namespace