1 //===- RegisterInfoEmitter.cpp - Generate a Register File Desc. -*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This tablegen backend is responsible for emitting a description of a target
10 // register file for a code generator.  It uses instances of the Register,
11 // RegisterAliases, and RegisterClass classes to gather this information.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "CodeGenRegisters.h"
16 #include "CodeGenTarget.h"
17 #include "SequenceToOffsetTable.h"
18 #include "Types.h"
19 #include "llvm/ADT/ArrayRef.h"
20 #include "llvm/ADT/BitVector.h"
21 #include "llvm/ADT/STLExtras.h"
22 #include "llvm/ADT/SetVector.h"
23 #include "llvm/ADT/SmallVector.h"
24 #include "llvm/ADT/SparseBitVector.h"
25 #include "llvm/ADT/Twine.h"
26 #include "llvm/Support/Casting.h"
27 #include "llvm/Support/CommandLine.h"
28 #include "llvm/Support/Format.h"
29 #include "llvm/Support/MachineValueType.h"
30 #include "llvm/Support/raw_ostream.h"
31 #include "llvm/TableGen/Error.h"
32 #include "llvm/TableGen/Record.h"
33 #include "llvm/TableGen/SetTheory.h"
34 #include "llvm/TableGen/TableGenBackend.h"
35 #include <algorithm>
36 #include <cassert>
37 #include <cstddef>
38 #include <cstdint>
39 #include <deque>
40 #include <iterator>
41 #include <set>
42 #include <string>
43 #include <vector>
44 
45 using namespace llvm;
46 
47 cl::OptionCategory RegisterInfoCat("Options for -gen-register-info");
48 
49 static cl::opt<bool>
50     RegisterInfoDebug("register-info-debug", cl::init(false),
51                       cl::desc("Dump register information to help debugging"),
52                       cl::cat(RegisterInfoCat));
53 
54 namespace {
55 
56 class RegisterInfoEmitter {
57   CodeGenTarget Target;
58   RecordKeeper &Records;
59 
60 public:
61   RegisterInfoEmitter(RecordKeeper &R) : Target(R), Records(R) {
62     CodeGenRegBank &RegBank = Target.getRegBank();
63     RegBank.computeDerivedInfo();
64   }
65 
66   // runEnums - Print out enum values for all of the registers.
67   void runEnums(raw_ostream &o, CodeGenTarget &Target, CodeGenRegBank &Bank);
68 
69   // runMCDesc - Print out MC register descriptions.
70   void runMCDesc(raw_ostream &o, CodeGenTarget &Target, CodeGenRegBank &Bank);
71 
72   // runTargetHeader - Emit a header fragment for the register info emitter.
73   void runTargetHeader(raw_ostream &o, CodeGenTarget &Target,
74                        CodeGenRegBank &Bank);
75 
76   // runTargetDesc - Output the target register and register file descriptions.
77   void runTargetDesc(raw_ostream &o, CodeGenTarget &Target,
78                      CodeGenRegBank &Bank);
79 
80   // run - Output the register file description.
81   void run(raw_ostream &o);
82 
83   void debugDump(raw_ostream &OS);
84 
85 private:
86   void EmitRegMapping(raw_ostream &o, const std::deque<CodeGenRegister> &Regs,
87                       bool isCtor);
88   void EmitRegMappingTables(raw_ostream &o,
89                             const std::deque<CodeGenRegister> &Regs,
90                             bool isCtor);
91   void EmitRegUnitPressure(raw_ostream &OS, const CodeGenRegBank &RegBank,
92                            const std::string &ClassName);
93   void emitComposeSubRegIndices(raw_ostream &OS, CodeGenRegBank &RegBank,
94                                 const std::string &ClassName);
95   void emitComposeSubRegIndexLaneMask(raw_ostream &OS, CodeGenRegBank &RegBank,
96                                       const std::string &ClassName);
97 };
98 
99 } // end anonymous namespace
100 
101 // runEnums - Print out enum values for all of the registers.
102 void RegisterInfoEmitter::runEnums(raw_ostream &OS,
103                                    CodeGenTarget &Target, CodeGenRegBank &Bank) {
104   const auto &Registers = Bank.getRegisters();
105 
106   // Register enums are stored as uint16_t in the tables. Make sure we'll fit.
107   assert(Registers.size() <= 0xffff && "Too many regs to fit in tables");
108 
109   StringRef Namespace = Registers.front().TheDef->getValueAsString("Namespace");
110 
111   emitSourceFileHeader("Target Register Enum Values", OS);
112 
113   OS << "\n#ifdef GET_REGINFO_ENUM\n";
114   OS << "#undef GET_REGINFO_ENUM\n\n";
115 
116   OS << "namespace llvm {\n\n";
117 
118   OS << "class MCRegisterClass;\n"
119      << "extern const MCRegisterClass " << Target.getName()
120      << "MCRegisterClasses[];\n\n";
121 
122   if (!Namespace.empty())
123     OS << "namespace " << Namespace << " {\n";
124   OS << "enum {\n  NoRegister,\n";
125 
126   for (const auto &Reg : Registers)
127     OS << "  " << Reg.getName() << " = " << Reg.EnumValue << ",\n";
128   assert(Registers.size() == Registers.back().EnumValue &&
129          "Register enum value mismatch!");
130   OS << "  NUM_TARGET_REGS // " << Registers.size()+1 << "\n";
131   OS << "};\n";
132   if (!Namespace.empty())
133     OS << "} // end namespace " << Namespace << "\n";
134 
135   const auto &RegisterClasses = Bank.getRegClasses();
136   if (!RegisterClasses.empty()) {
137 
138     // RegisterClass enums are stored as uint16_t in the tables.
139     assert(RegisterClasses.size() <= 0xffff &&
140            "Too many register classes to fit in tables");
141 
142     OS << "\n// Register classes\n\n";
143     if (!Namespace.empty())
144       OS << "namespace " << Namespace << " {\n";
145     OS << "enum {\n";
146     for (const auto &RC : RegisterClasses)
147       OS << "  " << RC.getName() << "RegClassID"
148          << " = " << RC.EnumValue << ",\n";
149     OS << "\n};\n";
150     if (!Namespace.empty())
151       OS << "} // end namespace " << Namespace << "\n\n";
152   }
153 
154   const std::vector<Record*> &RegAltNameIndices = Target.getRegAltNameIndices();
155   // If the only definition is the default NoRegAltName, we don't need to
156   // emit anything.
157   if (RegAltNameIndices.size() > 1) {
158     OS << "\n// Register alternate name indices\n\n";
159     if (!Namespace.empty())
160       OS << "namespace " << Namespace << " {\n";
161     OS << "enum {\n";
162     for (unsigned i = 0, e = RegAltNameIndices.size(); i != e; ++i)
163       OS << "  " << RegAltNameIndices[i]->getName() << ",\t// " << i << "\n";
164     OS << "  NUM_TARGET_REG_ALT_NAMES = " << RegAltNameIndices.size() << "\n";
165     OS << "};\n";
166     if (!Namespace.empty())
167       OS << "} // end namespace " << Namespace << "\n\n";
168   }
169 
170   auto &SubRegIndices = Bank.getSubRegIndices();
171   if (!SubRegIndices.empty()) {
172     OS << "\n// Subregister indices\n\n";
173     std::string Namespace = SubRegIndices.front().getNamespace();
174     if (!Namespace.empty())
175       OS << "namespace " << Namespace << " {\n";
176     OS << "enum : uint16_t {\n  NoSubRegister,\n";
177     unsigned i = 0;
178     for (const auto &Idx : SubRegIndices)
179       OS << "  " << Idx.getName() << ",\t// " << ++i << "\n";
180     OS << "  NUM_TARGET_SUBREGS\n};\n";
181     if (!Namespace.empty())
182       OS << "} // end namespace " << Namespace << "\n\n";
183   }
184 
185   OS << "// Register pressure sets enum.\n";
186   if (!Namespace.empty())
187     OS << "namespace " << Namespace << " {\n";
188   OS << "enum RegisterPressureSets {\n";
189   unsigned NumSets = Bank.getNumRegPressureSets();
190   for (unsigned i = 0; i < NumSets; ++i ) {
191     const RegUnitSet &RegUnits = Bank.getRegSetAt(i);
192     OS << "  " << RegUnits.Name << " = " << i << ",\n";
193   }
194   OS << "};\n";
195   if (!Namespace.empty())
196     OS << "} // end namespace " << Namespace << '\n';
197   OS << '\n';
198 
199   OS << "} // end namespace llvm\n\n";
200   OS << "#endif // GET_REGINFO_ENUM\n\n";
201 }
202 
203 static void printInt(raw_ostream &OS, int Val) {
204   OS << Val;
205 }
206 
207 void RegisterInfoEmitter::
208 EmitRegUnitPressure(raw_ostream &OS, const CodeGenRegBank &RegBank,
209                     const std::string &ClassName) {
210   unsigned NumRCs = RegBank.getRegClasses().size();
211   unsigned NumSets = RegBank.getNumRegPressureSets();
212 
213   OS << "/// Get the weight in units of pressure for this register class.\n"
214      << "const RegClassWeight &" << ClassName << "::\n"
215      << "getRegClassWeight(const TargetRegisterClass *RC) const {\n"
216      << "  static const RegClassWeight RCWeightTable[] = {\n";
217   for (const auto &RC : RegBank.getRegClasses()) {
218     const CodeGenRegister::Vec &Regs = RC.getMembers();
219     OS << "    {" << RC.getWeight(RegBank) << ", ";
220     if (Regs.empty() || RC.Artificial)
221       OS << '0';
222     else {
223       std::vector<unsigned> RegUnits;
224       RC.buildRegUnitSet(RegBank, RegUnits);
225       OS << RegBank.getRegUnitSetWeight(RegUnits);
226     }
227     OS << "},  \t// " << RC.getName() << "\n";
228   }
229   OS << "  };\n"
230      << "  return RCWeightTable[RC->getID()];\n"
231      << "}\n\n";
232 
233   // Reasonable targets (not ARMv7) have unit weight for all units, so don't
234   // bother generating a table.
235   bool RegUnitsHaveUnitWeight = true;
236   for (unsigned UnitIdx = 0, UnitEnd = RegBank.getNumNativeRegUnits();
237        UnitIdx < UnitEnd; ++UnitIdx) {
238     if (RegBank.getRegUnit(UnitIdx).Weight > 1)
239       RegUnitsHaveUnitWeight = false;
240   }
241   OS << "/// Get the weight in units of pressure for this register unit.\n"
242      << "unsigned " << ClassName << "::\n"
243      << "getRegUnitWeight(unsigned RegUnit) const {\n"
244      << "  assert(RegUnit < " << RegBank.getNumNativeRegUnits()
245      << " && \"invalid register unit\");\n";
246   if (!RegUnitsHaveUnitWeight) {
247     OS << "  static const uint8_t RUWeightTable[] = {\n    ";
248     for (unsigned UnitIdx = 0, UnitEnd = RegBank.getNumNativeRegUnits();
249          UnitIdx < UnitEnd; ++UnitIdx) {
250       const RegUnit &RU = RegBank.getRegUnit(UnitIdx);
251       assert(RU.Weight < 256 && "RegUnit too heavy");
252       OS << RU.Weight << ", ";
253     }
254     OS << "};\n"
255        << "  return RUWeightTable[RegUnit];\n";
256   }
257   else {
258     OS << "  // All register units have unit weight.\n"
259        << "  return 1;\n";
260   }
261   OS << "}\n\n";
262 
263   OS << "\n"
264      << "// Get the number of dimensions of register pressure.\n"
265      << "unsigned " << ClassName << "::getNumRegPressureSets() const {\n"
266      << "  return " << NumSets << ";\n}\n\n";
267 
268   OS << "// Get the name of this register unit pressure set.\n"
269      << "const char *" << ClassName << "::\n"
270      << "getRegPressureSetName(unsigned Idx) const {\n"
271      << "  static const char *const PressureNameTable[] = {\n";
272   unsigned MaxRegUnitWeight = 0;
273   for (unsigned i = 0; i < NumSets; ++i ) {
274     const RegUnitSet &RegUnits = RegBank.getRegSetAt(i);
275     MaxRegUnitWeight = std::max(MaxRegUnitWeight, RegUnits.Weight);
276     OS << "    \"" << RegUnits.Name << "\",\n";
277   }
278   OS << "  };\n"
279      << "  return PressureNameTable[Idx];\n"
280      << "}\n\n";
281 
282   OS << "// Get the register unit pressure limit for this dimension.\n"
283      << "// This limit must be adjusted dynamically for reserved registers.\n"
284      << "unsigned " << ClassName << "::\n"
285      << "getRegPressureSetLimit(const MachineFunction &MF, unsigned Idx) const "
286         "{\n"
287      << "  static const " << getMinimalTypeForRange(MaxRegUnitWeight, 32)
288      << " PressureLimitTable[] = {\n";
289   for (unsigned i = 0; i < NumSets; ++i ) {
290     const RegUnitSet &RegUnits = RegBank.getRegSetAt(i);
291     OS << "    " << RegUnits.Weight << ",  \t// " << i << ": "
292        << RegUnits.Name << "\n";
293   }
294   OS << "  };\n"
295      << "  return PressureLimitTable[Idx];\n"
296      << "}\n\n";
297 
298   SequenceToOffsetTable<std::vector<int>> PSetsSeqs;
299 
300   // This table may be larger than NumRCs if some register units needed a list
301   // of unit sets that did not correspond to a register class.
302   unsigned NumRCUnitSets = RegBank.getNumRegClassPressureSetLists();
303   std::vector<std::vector<int>> PSets(NumRCUnitSets);
304 
305   for (unsigned i = 0, e = NumRCUnitSets; i != e; ++i) {
306     ArrayRef<unsigned> PSetIDs = RegBank.getRCPressureSetIDs(i);
307     PSets[i].reserve(PSetIDs.size());
308     for (ArrayRef<unsigned>::iterator PSetI = PSetIDs.begin(),
309            PSetE = PSetIDs.end(); PSetI != PSetE; ++PSetI) {
310       PSets[i].push_back(RegBank.getRegPressureSet(*PSetI).Order);
311     }
312     llvm::sort(PSets[i]);
313     PSetsSeqs.add(PSets[i]);
314   }
315 
316   PSetsSeqs.layout();
317 
318   OS << "/// Table of pressure sets per register class or unit.\n"
319      << "static const int RCSetsTable[] = {\n";
320   PSetsSeqs.emit(OS, printInt, "-1");
321   OS << "};\n\n";
322 
323   OS << "/// Get the dimensions of register pressure impacted by this "
324      << "register class.\n"
325      << "/// Returns a -1 terminated array of pressure set IDs\n"
326      << "const int *" << ClassName << "::\n"
327      << "getRegClassPressureSets(const TargetRegisterClass *RC) const {\n";
328   OS << "  static const " << getMinimalTypeForRange(PSetsSeqs.size() - 1, 32)
329      << " RCSetStartTable[] = {\n    ";
330   for (unsigned i = 0, e = NumRCs; i != e; ++i) {
331     OS << PSetsSeqs.get(PSets[i]) << ",";
332   }
333   OS << "};\n"
334      << "  return &RCSetsTable[RCSetStartTable[RC->getID()]];\n"
335      << "}\n\n";
336 
337   OS << "/// Get the dimensions of register pressure impacted by this "
338      << "register unit.\n"
339      << "/// Returns a -1 terminated array of pressure set IDs\n"
340      << "const int *" << ClassName << "::\n"
341      << "getRegUnitPressureSets(unsigned RegUnit) const {\n"
342      << "  assert(RegUnit < " << RegBank.getNumNativeRegUnits()
343      << " && \"invalid register unit\");\n";
344   OS << "  static const " << getMinimalTypeForRange(PSetsSeqs.size() - 1, 32)
345      << " RUSetStartTable[] = {\n    ";
346   for (unsigned UnitIdx = 0, UnitEnd = RegBank.getNumNativeRegUnits();
347        UnitIdx < UnitEnd; ++UnitIdx) {
348     OS << PSetsSeqs.get(PSets[RegBank.getRegUnit(UnitIdx).RegClassUnitSetsIdx])
349        << ",";
350   }
351   OS << "};\n"
352      << "  return &RCSetsTable[RUSetStartTable[RegUnit]];\n"
353      << "}\n\n";
354 }
355 
356 using DwarfRegNumsMapPair = std::pair<Record*, std::vector<int64_t>>;
357 using DwarfRegNumsVecTy = std::vector<DwarfRegNumsMapPair>;
358 
359 static void finalizeDwarfRegNumsKeys(DwarfRegNumsVecTy &DwarfRegNums) {
360   // Sort and unique to get a map-like vector. We want the last assignment to
361   // match previous behaviour.
362   llvm::stable_sort(DwarfRegNums, on_first<LessRecordRegister>());
363   // Warn about duplicate assignments.
364   const Record *LastSeenReg = nullptr;
365   for (const auto &X : DwarfRegNums) {
366     const auto &Reg = X.first;
367     // The only way LessRecordRegister can return equal is if they're the same
368     // string. Use simple equality instead.
369     if (LastSeenReg && Reg->getName() == LastSeenReg->getName())
370       PrintWarning(Reg->getLoc(), Twine("DWARF numbers for register ") +
371                                       getQualifiedName(Reg) +
372                                       "specified multiple times");
373     LastSeenReg = Reg;
374   }
375   auto Last = std::unique(
376       DwarfRegNums.begin(), DwarfRegNums.end(),
377       [](const DwarfRegNumsMapPair &A, const DwarfRegNumsMapPair &B) {
378         return A.first->getName() == B.first->getName();
379       });
380   DwarfRegNums.erase(Last, DwarfRegNums.end());
381 }
382 
383 void RegisterInfoEmitter::EmitRegMappingTables(
384     raw_ostream &OS, const std::deque<CodeGenRegister> &Regs, bool isCtor) {
385   // Collect all information about dwarf register numbers
386   DwarfRegNumsVecTy DwarfRegNums;
387 
388   // First, just pull all provided information to the map
389   unsigned maxLength = 0;
390   for (auto &RE : Regs) {
391     Record *Reg = RE.TheDef;
392     std::vector<int64_t> RegNums = Reg->getValueAsListOfInts("DwarfNumbers");
393     maxLength = std::max((size_t)maxLength, RegNums.size());
394     DwarfRegNums.emplace_back(Reg, std::move(RegNums));
395   }
396   finalizeDwarfRegNumsKeys(DwarfRegNums);
397 
398   if (!maxLength)
399     return;
400 
401   // Now we know maximal length of number list. Append -1's, where needed
402   for (DwarfRegNumsVecTy::iterator I = DwarfRegNums.begin(),
403                                    E = DwarfRegNums.end();
404        I != E; ++I)
405     for (unsigned i = I->second.size(), e = maxLength; i != e; ++i)
406       I->second.push_back(-1);
407 
408   StringRef Namespace = Regs.front().TheDef->getValueAsString("Namespace");
409 
410   OS << "// " << Namespace << " Dwarf<->LLVM register mappings.\n";
411 
412   // Emit reverse information about the dwarf register numbers.
413   for (unsigned j = 0; j < 2; ++j) {
414     for (unsigned i = 0, e = maxLength; i != e; ++i) {
415       OS << "extern const MCRegisterInfo::DwarfLLVMRegPair " << Namespace;
416       OS << (j == 0 ? "DwarfFlavour" : "EHFlavour");
417       OS << i << "Dwarf2L[]";
418 
419       if (!isCtor) {
420         OS << " = {\n";
421 
422         // Store the mapping sorted by the LLVM reg num so lookup can be done
423         // with a binary search.
424         std::map<uint64_t, Record*> Dwarf2LMap;
425         for (DwarfRegNumsVecTy::iterator
426                I = DwarfRegNums.begin(), E = DwarfRegNums.end(); I != E; ++I) {
427           int DwarfRegNo = I->second[i];
428           if (DwarfRegNo < 0)
429             continue;
430           Dwarf2LMap[DwarfRegNo] = I->first;
431         }
432 
433         for (std::map<uint64_t, Record*>::iterator
434                I = Dwarf2LMap.begin(), E = Dwarf2LMap.end(); I != E; ++I)
435           OS << "  { " << I->first << "U, " << getQualifiedName(I->second)
436              << " },\n";
437 
438         OS << "};\n";
439       } else {
440         OS << ";\n";
441       }
442 
443       // We have to store the size in a const global, it's used in multiple
444       // places.
445       OS << "extern const unsigned " << Namespace
446          << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i << "Dwarf2LSize";
447       if (!isCtor)
448         OS << " = array_lengthof(" << Namespace
449            << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i
450            << "Dwarf2L);\n\n";
451       else
452         OS << ";\n\n";
453     }
454   }
455 
456   for (auto &RE : Regs) {
457     Record *Reg = RE.TheDef;
458     const RecordVal *V = Reg->getValue("DwarfAlias");
459     if (!V || !V->getValue())
460       continue;
461 
462     DefInit *DI = cast<DefInit>(V->getValue());
463     Record *Alias = DI->getDef();
464     const auto &AliasIter = llvm::lower_bound(
465         DwarfRegNums, Alias, [](const DwarfRegNumsMapPair &A, const Record *B) {
466           return LessRecordRegister()(A.first, B);
467         });
468     assert(AliasIter != DwarfRegNums.end() && AliasIter->first == Alias &&
469            "Expected Alias to be present in map");
470     const auto &RegIter = llvm::lower_bound(
471         DwarfRegNums, Reg, [](const DwarfRegNumsMapPair &A, const Record *B) {
472           return LessRecordRegister()(A.first, B);
473         });
474     assert(RegIter != DwarfRegNums.end() && RegIter->first == Reg &&
475            "Expected Reg to be present in map");
476     RegIter->second = AliasIter->second;
477   }
478 
479   // Emit information about the dwarf register numbers.
480   for (unsigned j = 0; j < 2; ++j) {
481     for (unsigned i = 0, e = maxLength; i != e; ++i) {
482       OS << "extern const MCRegisterInfo::DwarfLLVMRegPair " << Namespace;
483       OS << (j == 0 ? "DwarfFlavour" : "EHFlavour");
484       OS << i << "L2Dwarf[]";
485       if (!isCtor) {
486         OS << " = {\n";
487         // Store the mapping sorted by the Dwarf reg num so lookup can be done
488         // with a binary search.
489         for (DwarfRegNumsVecTy::iterator
490                I = DwarfRegNums.begin(), E = DwarfRegNums.end(); I != E; ++I) {
491           int RegNo = I->second[i];
492           if (RegNo == -1) // -1 is the default value, don't emit a mapping.
493             continue;
494 
495           OS << "  { " << getQualifiedName(I->first) << ", " << RegNo
496              << "U },\n";
497         }
498         OS << "};\n";
499       } else {
500         OS << ";\n";
501       }
502 
503       // We have to store the size in a const global, it's used in multiple
504       // places.
505       OS << "extern const unsigned " << Namespace
506          << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i << "L2DwarfSize";
507       if (!isCtor)
508         OS << " = array_lengthof(" << Namespace
509            << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i << "L2Dwarf);\n\n";
510       else
511         OS << ";\n\n";
512     }
513   }
514 }
515 
516 void RegisterInfoEmitter::EmitRegMapping(
517     raw_ostream &OS, const std::deque<CodeGenRegister> &Regs, bool isCtor) {
518   // Emit the initializer so the tables from EmitRegMappingTables get wired up
519   // to the MCRegisterInfo object.
520   unsigned maxLength = 0;
521   for (auto &RE : Regs) {
522     Record *Reg = RE.TheDef;
523     maxLength = std::max((size_t)maxLength,
524                          Reg->getValueAsListOfInts("DwarfNumbers").size());
525   }
526 
527   if (!maxLength)
528     return;
529 
530   StringRef Namespace = Regs.front().TheDef->getValueAsString("Namespace");
531 
532   // Emit reverse information about the dwarf register numbers.
533   for (unsigned j = 0; j < 2; ++j) {
534     OS << "  switch (";
535     if (j == 0)
536       OS << "DwarfFlavour";
537     else
538       OS << "EHFlavour";
539     OS << ") {\n"
540      << "  default:\n"
541      << "    llvm_unreachable(\"Unknown DWARF flavour\");\n";
542 
543     for (unsigned i = 0, e = maxLength; i != e; ++i) {
544       OS << "  case " << i << ":\n";
545       OS << "    ";
546       if (!isCtor)
547         OS << "RI->";
548       std::string Tmp;
549       raw_string_ostream(Tmp) << Namespace
550                               << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i
551                               << "Dwarf2L";
552       OS << "mapDwarfRegsToLLVMRegs(" << Tmp << ", " << Tmp << "Size, ";
553       if (j == 0)
554           OS << "false";
555         else
556           OS << "true";
557       OS << ");\n";
558       OS << "    break;\n";
559     }
560     OS << "  }\n";
561   }
562 
563   // Emit information about the dwarf register numbers.
564   for (unsigned j = 0; j < 2; ++j) {
565     OS << "  switch (";
566     if (j == 0)
567       OS << "DwarfFlavour";
568     else
569       OS << "EHFlavour";
570     OS << ") {\n"
571        << "  default:\n"
572        << "    llvm_unreachable(\"Unknown DWARF flavour\");\n";
573 
574     for (unsigned i = 0, e = maxLength; i != e; ++i) {
575       OS << "  case " << i << ":\n";
576       OS << "    ";
577       if (!isCtor)
578         OS << "RI->";
579       std::string Tmp;
580       raw_string_ostream(Tmp) << Namespace
581                               << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i
582                               << "L2Dwarf";
583       OS << "mapLLVMRegsToDwarfRegs(" << Tmp << ", " << Tmp << "Size, ";
584       if (j == 0)
585           OS << "false";
586         else
587           OS << "true";
588       OS << ");\n";
589       OS << "    break;\n";
590     }
591     OS << "  }\n";
592   }
593 }
594 
595 // Print a BitVector as a sequence of hex numbers using a little-endian mapping.
596 // Width is the number of bits per hex number.
597 static void printBitVectorAsHex(raw_ostream &OS,
598                                 const BitVector &Bits,
599                                 unsigned Width) {
600   assert(Width <= 32 && "Width too large");
601   unsigned Digits = (Width + 3) / 4;
602   for (unsigned i = 0, e = Bits.size(); i < e; i += Width) {
603     unsigned Value = 0;
604     for (unsigned j = 0; j != Width && i + j != e; ++j)
605       Value |= Bits.test(i + j) << j;
606     OS << format("0x%0*x, ", Digits, Value);
607   }
608 }
609 
610 // Helper to emit a set of bits into a constant byte array.
611 class BitVectorEmitter {
612   BitVector Values;
613 public:
614   void add(unsigned v) {
615     if (v >= Values.size())
616       Values.resize(((v/8)+1)*8); // Round up to the next byte.
617     Values[v] = true;
618   }
619 
620   void print(raw_ostream &OS) {
621     printBitVectorAsHex(OS, Values, 8);
622   }
623 };
624 
625 static void printSimpleValueType(raw_ostream &OS, MVT::SimpleValueType VT) {
626   OS << getEnumName(VT);
627 }
628 
629 static void printSubRegIndex(raw_ostream &OS, const CodeGenSubRegIndex *Idx) {
630   OS << Idx->EnumValue;
631 }
632 
633 // Differentially encoded register and regunit lists allow for better
634 // compression on regular register banks. The sequence is computed from the
635 // differential list as:
636 //
637 //   out[0] = InitVal;
638 //   out[n+1] = out[n] + diff[n]; // n = 0, 1, ...
639 //
640 // The initial value depends on the specific list. The list is terminated by a
641 // 0 differential which means we can't encode repeated elements.
642 
643 typedef SmallVector<uint16_t, 4> DiffVec;
644 typedef SmallVector<LaneBitmask, 4> MaskVec;
645 
646 // Differentially encode a sequence of numbers into V. The starting value and
647 // terminating 0 are not added to V, so it will have the same size as List.
648 static
649 DiffVec &diffEncode(DiffVec &V, unsigned InitVal, SparseBitVector<> List) {
650   assert(V.empty() && "Clear DiffVec before diffEncode.");
651   uint16_t Val = uint16_t(InitVal);
652 
653   for (uint16_t Cur : List) {
654     V.push_back(Cur - Val);
655     Val = Cur;
656   }
657   return V;
658 }
659 
660 template<typename Iter>
661 static
662 DiffVec &diffEncode(DiffVec &V, unsigned InitVal, Iter Begin, Iter End) {
663   assert(V.empty() && "Clear DiffVec before diffEncode.");
664   uint16_t Val = uint16_t(InitVal);
665   for (Iter I = Begin; I != End; ++I) {
666     uint16_t Cur = (*I)->EnumValue;
667     V.push_back(Cur - Val);
668     Val = Cur;
669   }
670   return V;
671 }
672 
673 static void printDiff16(raw_ostream &OS, uint16_t Val) {
674   OS << Val;
675 }
676 
677 static void printMask(raw_ostream &OS, LaneBitmask Val) {
678   OS << "LaneBitmask(0x" << PrintLaneMask(Val) << ')';
679 }
680 
681 // Try to combine Idx's compose map into Vec if it is compatible.
682 // Return false if it's not possible.
683 static bool combine(const CodeGenSubRegIndex *Idx,
684                     SmallVectorImpl<CodeGenSubRegIndex*> &Vec) {
685   const CodeGenSubRegIndex::CompMap &Map = Idx->getComposites();
686   for (const auto &I : Map) {
687     CodeGenSubRegIndex *&Entry = Vec[I.first->EnumValue - 1];
688     if (Entry && Entry != I.second)
689       return false;
690   }
691 
692   // All entries are compatible. Make it so.
693   for (const auto &I : Map) {
694     auto *&Entry = Vec[I.first->EnumValue - 1];
695     assert((!Entry || Entry == I.second) &&
696            "Expected EnumValue to be unique");
697     Entry = I.second;
698   }
699   return true;
700 }
701 
702 void
703 RegisterInfoEmitter::emitComposeSubRegIndices(raw_ostream &OS,
704                                               CodeGenRegBank &RegBank,
705                                               const std::string &ClName) {
706   const auto &SubRegIndices = RegBank.getSubRegIndices();
707   OS << "unsigned " << ClName
708      << "::composeSubRegIndicesImpl(unsigned IdxA, unsigned IdxB) const {\n";
709 
710   // Many sub-register indexes are composition-compatible, meaning that
711   //
712   //   compose(IdxA, IdxB) == compose(IdxA', IdxB)
713   //
714   // for many IdxA, IdxA' pairs. Not all sub-register indexes can be composed.
715   // The illegal entries can be use as wildcards to compress the table further.
716 
717   // Map each Sub-register index to a compatible table row.
718   SmallVector<unsigned, 4> RowMap;
719   SmallVector<SmallVector<CodeGenSubRegIndex*, 4>, 4> Rows;
720 
721   auto SubRegIndicesSize =
722       std::distance(SubRegIndices.begin(), SubRegIndices.end());
723   for (const auto &Idx : SubRegIndices) {
724     unsigned Found = ~0u;
725     for (unsigned r = 0, re = Rows.size(); r != re; ++r) {
726       if (combine(&Idx, Rows[r])) {
727         Found = r;
728         break;
729       }
730     }
731     if (Found == ~0u) {
732       Found = Rows.size();
733       Rows.resize(Found + 1);
734       Rows.back().resize(SubRegIndicesSize);
735       combine(&Idx, Rows.back());
736     }
737     RowMap.push_back(Found);
738   }
739 
740   // Output the row map if there is multiple rows.
741   if (Rows.size() > 1) {
742     OS << "  static const " << getMinimalTypeForRange(Rows.size(), 32)
743        << " RowMap[" << SubRegIndicesSize << "] = {\n    ";
744     for (unsigned i = 0, e = SubRegIndicesSize; i != e; ++i)
745       OS << RowMap[i] << ", ";
746     OS << "\n  };\n";
747   }
748 
749   // Output the rows.
750   OS << "  static const " << getMinimalTypeForRange(SubRegIndicesSize + 1, 32)
751      << " Rows[" << Rows.size() << "][" << SubRegIndicesSize << "] = {\n";
752   for (unsigned r = 0, re = Rows.size(); r != re; ++r) {
753     OS << "    { ";
754     for (unsigned i = 0, e = SubRegIndicesSize; i != e; ++i)
755       if (Rows[r][i])
756         OS << Rows[r][i]->getQualifiedName() << ", ";
757       else
758         OS << "0, ";
759     OS << "},\n";
760   }
761   OS << "  };\n\n";
762 
763   OS << "  --IdxA; assert(IdxA < " << SubRegIndicesSize << ");\n"
764      << "  --IdxB; assert(IdxB < " << SubRegIndicesSize << ");\n";
765   if (Rows.size() > 1)
766     OS << "  return Rows[RowMap[IdxA]][IdxB];\n";
767   else
768     OS << "  return Rows[0][IdxB];\n";
769   OS << "}\n\n";
770 }
771 
772 void
773 RegisterInfoEmitter::emitComposeSubRegIndexLaneMask(raw_ostream &OS,
774                                                     CodeGenRegBank &RegBank,
775                                                     const std::string &ClName) {
776   // See the comments in computeSubRegLaneMasks() for our goal here.
777   const auto &SubRegIndices = RegBank.getSubRegIndices();
778 
779   // Create a list of Mask+Rotate operations, with equivalent entries merged.
780   SmallVector<unsigned, 4> SubReg2SequenceIndexMap;
781   SmallVector<SmallVector<MaskRolPair, 1>, 4> Sequences;
782   for (const auto &Idx : SubRegIndices) {
783     const SmallVector<MaskRolPair, 1> &IdxSequence
784       = Idx.CompositionLaneMaskTransform;
785 
786     unsigned Found = ~0u;
787     unsigned SIdx = 0;
788     unsigned NextSIdx;
789     for (size_t s = 0, se = Sequences.size(); s != se; ++s, SIdx = NextSIdx) {
790       SmallVectorImpl<MaskRolPair> &Sequence = Sequences[s];
791       NextSIdx = SIdx + Sequence.size() + 1;
792       if (Sequence == IdxSequence) {
793         Found = SIdx;
794         break;
795       }
796     }
797     if (Found == ~0u) {
798       Sequences.push_back(IdxSequence);
799       Found = SIdx;
800     }
801     SubReg2SequenceIndexMap.push_back(Found);
802   }
803 
804   OS << "  struct MaskRolOp {\n"
805         "    LaneBitmask Mask;\n"
806         "    uint8_t  RotateLeft;\n"
807         "  };\n"
808         "  static const MaskRolOp LaneMaskComposeSequences[] = {\n";
809   unsigned Idx = 0;
810   for (size_t s = 0, se = Sequences.size(); s != se; ++s) {
811     OS << "    ";
812     const SmallVectorImpl<MaskRolPair> &Sequence = Sequences[s];
813     for (size_t p = 0, pe = Sequence.size(); p != pe; ++p) {
814       const MaskRolPair &P = Sequence[p];
815       printMask(OS << "{ ", P.Mask);
816       OS << format(", %2u }, ", P.RotateLeft);
817     }
818     OS << "{ LaneBitmask::getNone(), 0 }";
819     if (s+1 != se)
820       OS << ", ";
821     OS << "  // Sequence " << Idx << "\n";
822     Idx += Sequence.size() + 1;
823   }
824   OS << "  };\n"
825         "  static const MaskRolOp *const CompositeSequences[] = {\n";
826   for (size_t i = 0, e = SubRegIndices.size(); i != e; ++i) {
827     OS << "    ";
828     unsigned Idx = SubReg2SequenceIndexMap[i];
829     OS << format("&LaneMaskComposeSequences[%u]", Idx);
830     if (i+1 != e)
831       OS << ",";
832     OS << " // to " << SubRegIndices[i].getName() << "\n";
833   }
834   OS << "  };\n\n";
835 
836   OS << "LaneBitmask " << ClName
837      << "::composeSubRegIndexLaneMaskImpl(unsigned IdxA, LaneBitmask LaneMask)"
838         " const {\n"
839         "  --IdxA; assert(IdxA < " << SubRegIndices.size()
840      << " && \"Subregister index out of bounds\");\n"
841         "  LaneBitmask Result;\n"
842         "  for (const MaskRolOp *Ops = CompositeSequences[IdxA]; Ops->Mask.any(); ++Ops) {\n"
843         "    LaneBitmask::Type M = LaneMask.getAsInteger() & Ops->Mask.getAsInteger();\n"
844         "    if (unsigned S = Ops->RotateLeft)\n"
845         "      Result |= LaneBitmask((M << S) | (M >> (LaneBitmask::BitWidth - S)));\n"
846         "    else\n"
847         "      Result |= LaneBitmask(M);\n"
848         "  }\n"
849         "  return Result;\n"
850         "}\n\n";
851 
852   OS << "LaneBitmask " << ClName
853      << "::reverseComposeSubRegIndexLaneMaskImpl(unsigned IdxA, "
854         " LaneBitmask LaneMask) const {\n"
855         "  LaneMask &= getSubRegIndexLaneMask(IdxA);\n"
856         "  --IdxA; assert(IdxA < " << SubRegIndices.size()
857      << " && \"Subregister index out of bounds\");\n"
858         "  LaneBitmask Result;\n"
859         "  for (const MaskRolOp *Ops = CompositeSequences[IdxA]; Ops->Mask.any(); ++Ops) {\n"
860         "    LaneBitmask::Type M = LaneMask.getAsInteger();\n"
861         "    if (unsigned S = Ops->RotateLeft)\n"
862         "      Result |= LaneBitmask((M >> S) | (M << (LaneBitmask::BitWidth - S)));\n"
863         "    else\n"
864         "      Result |= LaneBitmask(M);\n"
865         "  }\n"
866         "  return Result;\n"
867         "}\n\n";
868 }
869 
870 //
871 // runMCDesc - Print out MC register descriptions.
872 //
873 void
874 RegisterInfoEmitter::runMCDesc(raw_ostream &OS, CodeGenTarget &Target,
875                                CodeGenRegBank &RegBank) {
876   emitSourceFileHeader("MC Register Information", OS);
877 
878   OS << "\n#ifdef GET_REGINFO_MC_DESC\n";
879   OS << "#undef GET_REGINFO_MC_DESC\n\n";
880 
881   const auto &Regs = RegBank.getRegisters();
882 
883   auto &SubRegIndices = RegBank.getSubRegIndices();
884   // The lists of sub-registers and super-registers go in the same array.  That
885   // allows us to share suffixes.
886   typedef std::vector<const CodeGenRegister*> RegVec;
887 
888   // Differentially encoded lists.
889   SequenceToOffsetTable<DiffVec> DiffSeqs;
890   SmallVector<DiffVec, 4> SubRegLists(Regs.size());
891   SmallVector<DiffVec, 4> SuperRegLists(Regs.size());
892   SmallVector<DiffVec, 4> RegUnitLists(Regs.size());
893   SmallVector<unsigned, 4> RegUnitInitScale(Regs.size());
894 
895   // List of lane masks accompanying register unit sequences.
896   SequenceToOffsetTable<MaskVec> LaneMaskSeqs;
897   SmallVector<MaskVec, 4> RegUnitLaneMasks(Regs.size());
898 
899   // Keep track of sub-register names as well. These are not differentially
900   // encoded.
901   typedef SmallVector<const CodeGenSubRegIndex*, 4> SubRegIdxVec;
902   SequenceToOffsetTable<SubRegIdxVec, deref<std::less<>>> SubRegIdxSeqs;
903   SmallVector<SubRegIdxVec, 4> SubRegIdxLists(Regs.size());
904 
905   SequenceToOffsetTable<std::string> RegStrings;
906 
907   // Precompute register lists for the SequenceToOffsetTable.
908   unsigned i = 0;
909   for (auto I = Regs.begin(), E = Regs.end(); I != E; ++I, ++i) {
910     const auto &Reg = *I;
911     RegStrings.add(std::string(Reg.getName()));
912 
913     // Compute the ordered sub-register list.
914     SetVector<const CodeGenRegister*> SR;
915     Reg.addSubRegsPreOrder(SR, RegBank);
916     diffEncode(SubRegLists[i], Reg.EnumValue, SR.begin(), SR.end());
917     DiffSeqs.add(SubRegLists[i]);
918 
919     // Compute the corresponding sub-register indexes.
920     SubRegIdxVec &SRIs = SubRegIdxLists[i];
921     for (const CodeGenRegister *S : SR)
922       SRIs.push_back(Reg.getSubRegIndex(S));
923     SubRegIdxSeqs.add(SRIs);
924 
925     // Super-registers are already computed.
926     const RegVec &SuperRegList = Reg.getSuperRegs();
927     diffEncode(SuperRegLists[i], Reg.EnumValue, SuperRegList.begin(),
928                SuperRegList.end());
929     DiffSeqs.add(SuperRegLists[i]);
930 
931     // Differentially encode the register unit list, seeded by register number.
932     // First compute a scale factor that allows more diff-lists to be reused:
933     //
934     //   D0 -> (S0, S1)
935     //   D1 -> (S2, S3)
936     //
937     // A scale factor of 2 allows D0 and D1 to share a diff-list. The initial
938     // value for the differential decoder is the register number multiplied by
939     // the scale.
940     //
941     // Check the neighboring registers for arithmetic progressions.
942     unsigned ScaleA = ~0u, ScaleB = ~0u;
943     SparseBitVector<> RUs = Reg.getNativeRegUnits();
944     if (I != Regs.begin() &&
945         std::prev(I)->getNativeRegUnits().count() == RUs.count())
946       ScaleB = *RUs.begin() - *std::prev(I)->getNativeRegUnits().begin();
947     if (std::next(I) != Regs.end() &&
948         std::next(I)->getNativeRegUnits().count() == RUs.count())
949       ScaleA = *std::next(I)->getNativeRegUnits().begin() - *RUs.begin();
950     unsigned Scale = std::min(ScaleB, ScaleA);
951     // Default the scale to 0 if it can't be encoded in 4 bits.
952     if (Scale >= 16)
953       Scale = 0;
954     RegUnitInitScale[i] = Scale;
955     DiffSeqs.add(diffEncode(RegUnitLists[i], Scale * Reg.EnumValue, RUs));
956 
957     const auto &RUMasks = Reg.getRegUnitLaneMasks();
958     MaskVec &LaneMaskVec = RegUnitLaneMasks[i];
959     assert(LaneMaskVec.empty());
960     llvm::append_range(LaneMaskVec, RUMasks);
961     // Terminator mask should not be used inside of the list.
962 #ifndef NDEBUG
963     for (LaneBitmask M : LaneMaskVec) {
964       assert(!M.all() && "terminator mask should not be part of the list");
965     }
966 #endif
967     LaneMaskSeqs.add(LaneMaskVec);
968   }
969 
970   // Compute the final layout of the sequence table.
971   DiffSeqs.layout();
972   LaneMaskSeqs.layout();
973   SubRegIdxSeqs.layout();
974 
975   OS << "namespace llvm {\n\n";
976 
977   const std::string &TargetName = std::string(Target.getName());
978 
979   // Emit the shared table of differential lists.
980   OS << "extern const MCPhysReg " << TargetName << "RegDiffLists[] = {\n";
981   DiffSeqs.emit(OS, printDiff16);
982   OS << "};\n\n";
983 
984   // Emit the shared table of regunit lane mask sequences.
985   OS << "extern const LaneBitmask " << TargetName << "LaneMaskLists[] = {\n";
986   LaneMaskSeqs.emit(OS, printMask, "LaneBitmask::getAll()");
987   OS << "};\n\n";
988 
989   // Emit the table of sub-register indexes.
990   OS << "extern const uint16_t " << TargetName << "SubRegIdxLists[] = {\n";
991   SubRegIdxSeqs.emit(OS, printSubRegIndex);
992   OS << "};\n\n";
993 
994   // Emit the table of sub-register index sizes.
995   OS << "extern const MCRegisterInfo::SubRegCoveredBits "
996      << TargetName << "SubRegIdxRanges[] = {\n";
997   OS << "  { " << (uint16_t)-1 << ", " << (uint16_t)-1 << " },\n";
998   for (const auto &Idx : SubRegIndices) {
999     OS << "  { " << Idx.Offset << ", " << Idx.Size << " },\t// "
1000        << Idx.getName() << "\n";
1001   }
1002   OS << "};\n\n";
1003 
1004   // Emit the string table.
1005   RegStrings.layout();
1006   RegStrings.emitStringLiteralDef(OS, Twine("extern const char ") + TargetName +
1007                                           "RegStrings[]");
1008 
1009   OS << "extern const MCRegisterDesc " << TargetName
1010      << "RegDesc[] = { // Descriptors\n";
1011   OS << "  { " << RegStrings.get("") << ", 0, 0, 0, 0, 0 },\n";
1012 
1013   // Emit the register descriptors now.
1014   i = 0;
1015   for (const auto &Reg : Regs) {
1016     OS << "  { " << RegStrings.get(std::string(Reg.getName())) << ", "
1017        << DiffSeqs.get(SubRegLists[i]) << ", " << DiffSeqs.get(SuperRegLists[i])
1018        << ", " << SubRegIdxSeqs.get(SubRegIdxLists[i]) << ", "
1019        << (DiffSeqs.get(RegUnitLists[i]) * 16 + RegUnitInitScale[i]) << ", "
1020        << LaneMaskSeqs.get(RegUnitLaneMasks[i]) << " },\n";
1021     ++i;
1022   }
1023   OS << "};\n\n";      // End of register descriptors...
1024 
1025   // Emit the table of register unit roots. Each regunit has one or two root
1026   // registers.
1027   OS << "extern const MCPhysReg " << TargetName << "RegUnitRoots[][2] = {\n";
1028   for (unsigned i = 0, e = RegBank.getNumNativeRegUnits(); i != e; ++i) {
1029     ArrayRef<const CodeGenRegister*> Roots = RegBank.getRegUnit(i).getRoots();
1030     assert(!Roots.empty() && "All regunits must have a root register.");
1031     assert(Roots.size() <= 2 && "More than two roots not supported yet.");
1032     OS << "  { ";
1033     ListSeparator LS;
1034     for (const CodeGenRegister *R : Roots)
1035       OS << LS << getQualifiedName(R->TheDef);
1036     OS << " },\n";
1037   }
1038   OS << "};\n\n";
1039 
1040   const auto &RegisterClasses = RegBank.getRegClasses();
1041 
1042   // Loop over all of the register classes... emitting each one.
1043   OS << "namespace {     // Register classes...\n";
1044 
1045   SequenceToOffsetTable<std::string> RegClassStrings;
1046 
1047   // Emit the register enum value arrays for each RegisterClass
1048   for (const auto &RC : RegisterClasses) {
1049     ArrayRef<Record*> Order = RC.getOrder();
1050 
1051     // Give the register class a legal C name if it's anonymous.
1052     const std::string &Name = RC.getName();
1053 
1054     RegClassStrings.add(Name);
1055 
1056     // Emit the register list now.
1057     OS << "  // " << Name << " Register Class...\n"
1058        << "  const MCPhysReg " << Name
1059        << "[] = {\n    ";
1060     for (Record *Reg : Order) {
1061       OS << getQualifiedName(Reg) << ", ";
1062     }
1063     OS << "\n  };\n\n";
1064 
1065     OS << "  // " << Name << " Bit set.\n"
1066        << "  const uint8_t " << Name
1067        << "Bits[] = {\n    ";
1068     BitVectorEmitter BVE;
1069     for (Record *Reg : Order) {
1070       BVE.add(Target.getRegBank().getReg(Reg)->EnumValue);
1071     }
1072     BVE.print(OS);
1073     OS << "\n  };\n\n";
1074 
1075   }
1076   OS << "} // end anonymous namespace\n\n";
1077 
1078   RegClassStrings.layout();
1079   RegClassStrings.emitStringLiteralDef(
1080       OS, Twine("extern const char ") + TargetName + "RegClassStrings[]");
1081 
1082   OS << "extern const MCRegisterClass " << TargetName
1083      << "MCRegisterClasses[] = {\n";
1084 
1085   for (const auto &RC : RegisterClasses) {
1086     assert(isInt<8>(RC.CopyCost) && "Copy cost too large.");
1087     uint32_t RegSize = 0;
1088     if (RC.RSI.isSimple())
1089       RegSize = RC.RSI.getSimple().RegSize;
1090     OS << "  { " << RC.getName() << ", " << RC.getName() << "Bits, "
1091        << RegClassStrings.get(RC.getName()) << ", " << RC.getOrder().size()
1092        << ", sizeof(" << RC.getName() << "Bits), "
1093        << RC.getQualifiedName() + "RegClassID"
1094        << ", " << RegSize << ", " << RC.CopyCost << ", "
1095        << (RC.Allocatable ? "true" : "false") << " },\n";
1096   }
1097 
1098   OS << "};\n\n";
1099 
1100   EmitRegMappingTables(OS, Regs, false);
1101 
1102   // Emit Reg encoding table
1103   OS << "extern const uint16_t " << TargetName;
1104   OS << "RegEncodingTable[] = {\n";
1105   // Add entry for NoRegister
1106   OS << "  0,\n";
1107   for (const auto &RE : Regs) {
1108     Record *Reg = RE.TheDef;
1109     BitsInit *BI = Reg->getValueAsBitsInit("HWEncoding");
1110     uint64_t Value = 0;
1111     for (unsigned b = 0, be = BI->getNumBits(); b != be; ++b) {
1112       if (BitInit *B = dyn_cast<BitInit>(BI->getBit(b)))
1113         Value |= (uint64_t)B->getValue() << b;
1114     }
1115     OS << "  " << Value << ",\n";
1116   }
1117   OS << "};\n";       // End of HW encoding table
1118 
1119   // MCRegisterInfo initialization routine.
1120   OS << "static inline void Init" << TargetName
1121      << "MCRegisterInfo(MCRegisterInfo *RI, unsigned RA, "
1122      << "unsigned DwarfFlavour = 0, unsigned EHFlavour = 0, unsigned PC = 0) "
1123         "{\n"
1124      << "  RI->InitMCRegisterInfo(" << TargetName << "RegDesc, "
1125      << Regs.size() + 1 << ", RA, PC, " << TargetName << "MCRegisterClasses, "
1126      << RegisterClasses.size() << ", " << TargetName << "RegUnitRoots, "
1127      << RegBank.getNumNativeRegUnits() << ", " << TargetName << "RegDiffLists, "
1128      << TargetName << "LaneMaskLists, " << TargetName << "RegStrings, "
1129      << TargetName << "RegClassStrings, " << TargetName << "SubRegIdxLists, "
1130      << (std::distance(SubRegIndices.begin(), SubRegIndices.end()) + 1) << ",\n"
1131      << TargetName << "SubRegIdxRanges, " << TargetName
1132      << "RegEncodingTable);\n\n";
1133 
1134   EmitRegMapping(OS, Regs, false);
1135 
1136   OS << "}\n\n";
1137 
1138   OS << "} // end namespace llvm\n\n";
1139   OS << "#endif // GET_REGINFO_MC_DESC\n\n";
1140 }
1141 
1142 void
1143 RegisterInfoEmitter::runTargetHeader(raw_ostream &OS, CodeGenTarget &Target,
1144                                      CodeGenRegBank &RegBank) {
1145   emitSourceFileHeader("Register Information Header Fragment", OS);
1146 
1147   OS << "\n#ifdef GET_REGINFO_HEADER\n";
1148   OS << "#undef GET_REGINFO_HEADER\n\n";
1149 
1150   const std::string &TargetName = std::string(Target.getName());
1151   std::string ClassName = TargetName + "GenRegisterInfo";
1152 
1153   OS << "#include \"llvm/CodeGen/TargetRegisterInfo.h\"\n\n";
1154 
1155   OS << "namespace llvm {\n\n";
1156 
1157   OS << "class " << TargetName << "FrameLowering;\n\n";
1158 
1159   OS << "struct " << ClassName << " : public TargetRegisterInfo {\n"
1160      << "  explicit " << ClassName
1161      << "(unsigned RA, unsigned D = 0, unsigned E = 0,\n"
1162      << "      unsigned PC = 0, unsigned HwMode = 0);\n";
1163   if (!RegBank.getSubRegIndices().empty()) {
1164     OS << "  unsigned composeSubRegIndicesImpl"
1165        << "(unsigned, unsigned) const override;\n"
1166        << "  LaneBitmask composeSubRegIndexLaneMaskImpl"
1167        << "(unsigned, LaneBitmask) const override;\n"
1168        << "  LaneBitmask reverseComposeSubRegIndexLaneMaskImpl"
1169        << "(unsigned, LaneBitmask) const override;\n"
1170        << "  const TargetRegisterClass *getSubClassWithSubReg"
1171        << "(const TargetRegisterClass *, unsigned) const override;\n";
1172   }
1173   OS << "  const RegClassWeight &getRegClassWeight("
1174      << "const TargetRegisterClass *RC) const override;\n"
1175      << "  unsigned getRegUnitWeight(unsigned RegUnit) const override;\n"
1176      << "  unsigned getNumRegPressureSets() const override;\n"
1177      << "  const char *getRegPressureSetName(unsigned Idx) const override;\n"
1178      << "  unsigned getRegPressureSetLimit(const MachineFunction &MF, unsigned "
1179         "Idx) const override;\n"
1180      << "  const int *getRegClassPressureSets("
1181      << "const TargetRegisterClass *RC) const override;\n"
1182      << "  const int *getRegUnitPressureSets("
1183      << "unsigned RegUnit) const override;\n"
1184      << "  ArrayRef<const char *> getRegMaskNames() const override;\n"
1185      << "  ArrayRef<const uint32_t *> getRegMasks() const override;\n"
1186      << "  /// Devirtualized TargetFrameLowering.\n"
1187      << "  static const " << TargetName << "FrameLowering *getFrameLowering(\n"
1188      << "      const MachineFunction &MF);\n"
1189      << "};\n\n";
1190 
1191   const auto &RegisterClasses = RegBank.getRegClasses();
1192 
1193   if (!RegisterClasses.empty()) {
1194     OS << "namespace " << RegisterClasses.front().Namespace
1195        << " { // Register classes\n";
1196 
1197     for (const auto &RC : RegisterClasses) {
1198       const std::string &Name = RC.getName();
1199 
1200       // Output the extern for the instance.
1201       OS << "  extern const TargetRegisterClass " << Name << "RegClass;\n";
1202     }
1203     OS << "} // end namespace " << RegisterClasses.front().Namespace << "\n\n";
1204   }
1205   OS << "} // end namespace llvm\n\n";
1206   OS << "#endif // GET_REGINFO_HEADER\n\n";
1207 }
1208 
1209 //
1210 // runTargetDesc - Output the target register and register file descriptions.
1211 //
1212 void
1213 RegisterInfoEmitter::runTargetDesc(raw_ostream &OS, CodeGenTarget &Target,
1214                                    CodeGenRegBank &RegBank){
1215   emitSourceFileHeader("Target Register and Register Classes Information", OS);
1216 
1217   OS << "\n#ifdef GET_REGINFO_TARGET_DESC\n";
1218   OS << "#undef GET_REGINFO_TARGET_DESC\n\n";
1219 
1220   OS << "namespace llvm {\n\n";
1221 
1222   // Get access to MCRegisterClass data.
1223   OS << "extern const MCRegisterClass " << Target.getName()
1224      << "MCRegisterClasses[];\n";
1225 
1226   // Start out by emitting each of the register classes.
1227   const auto &RegisterClasses = RegBank.getRegClasses();
1228   const auto &SubRegIndices = RegBank.getSubRegIndices();
1229 
1230   // Collect all registers belonging to any allocatable class.
1231   std::set<Record*> AllocatableRegs;
1232 
1233   // Collect allocatable registers.
1234   for (const auto &RC : RegisterClasses) {
1235     ArrayRef<Record*> Order = RC.getOrder();
1236 
1237     if (RC.Allocatable)
1238       AllocatableRegs.insert(Order.begin(), Order.end());
1239   }
1240 
1241   const CodeGenHwModes &CGH = Target.getHwModes();
1242   unsigned NumModes = CGH.getNumModeIds();
1243 
1244   // Build a shared array of value types.
1245   SequenceToOffsetTable<std::vector<MVT::SimpleValueType>> VTSeqs;
1246   for (unsigned M = 0; M < NumModes; ++M) {
1247     for (const auto &RC : RegisterClasses) {
1248       std::vector<MVT::SimpleValueType> S;
1249       for (const ValueTypeByHwMode &VVT : RC.VTs)
1250         S.push_back(VVT.get(M).SimpleTy);
1251       VTSeqs.add(S);
1252     }
1253   }
1254   VTSeqs.layout();
1255   OS << "\nstatic const MVT::SimpleValueType VTLists[] = {\n";
1256   VTSeqs.emit(OS, printSimpleValueType, "MVT::Other");
1257   OS << "};\n";
1258 
1259   // Emit SubRegIndex names, skipping 0.
1260   OS << "\nstatic const char *const SubRegIndexNameTable[] = { \"";
1261 
1262   for (const auto &Idx : SubRegIndices) {
1263     OS << Idx.getName();
1264     OS << "\", \"";
1265   }
1266   OS << "\" };\n\n";
1267 
1268   // Emit SubRegIndex lane masks, including 0.
1269   OS << "\nstatic const LaneBitmask SubRegIndexLaneMaskTable[] = {\n  "
1270         "LaneBitmask::getAll(),\n";
1271   for (const auto &Idx : SubRegIndices) {
1272     printMask(OS << "  ", Idx.LaneMask);
1273     OS << ", // " << Idx.getName() << '\n';
1274   }
1275   OS << " };\n\n";
1276 
1277   OS << "\n";
1278 
1279   // Now that all of the structs have been emitted, emit the instances.
1280   if (!RegisterClasses.empty()) {
1281     OS << "\nstatic const TargetRegisterInfo::RegClassInfo RegClassInfos[]"
1282        << " = {\n";
1283     for (unsigned M = 0; M < NumModes; ++M) {
1284       unsigned EV = 0;
1285       OS << "  // Mode = " << M << " (";
1286       if (M == 0)
1287         OS << "Default";
1288       else
1289         OS << CGH.getMode(M).Name;
1290       OS << ")\n";
1291       for (const auto &RC : RegisterClasses) {
1292         assert(RC.EnumValue == EV && "Unexpected order of register classes");
1293         ++EV;
1294         (void)EV;
1295         const RegSizeInfo &RI = RC.RSI.get(M);
1296         OS << "  { " << RI.RegSize << ", " << RI.SpillSize << ", "
1297            << RI.SpillAlignment;
1298         std::vector<MVT::SimpleValueType> VTs;
1299         for (const ValueTypeByHwMode &VVT : RC.VTs)
1300           VTs.push_back(VVT.get(M).SimpleTy);
1301         OS << ", VTLists+" << VTSeqs.get(VTs) << " },    // "
1302            << RC.getName() << '\n';
1303       }
1304     }
1305     OS << "};\n";
1306 
1307 
1308     OS << "\nstatic const TargetRegisterClass *const "
1309        << "NullRegClasses[] = { nullptr };\n\n";
1310 
1311     // Emit register class bit mask tables. The first bit mask emitted for a
1312     // register class, RC, is the set of sub-classes, including RC itself.
1313     //
1314     // If RC has super-registers, also create a list of subreg indices and bit
1315     // masks, (Idx, Mask). The bit mask has a bit for every superreg regclass,
1316     // SuperRC, that satisfies:
1317     //
1318     //   For all SuperReg in SuperRC: SuperReg:Idx in RC
1319     //
1320     // The 0-terminated list of subreg indices starts at:
1321     //
1322     //   RC->getSuperRegIndices() = SuperRegIdxSeqs + ...
1323     //
1324     // The corresponding bitmasks follow the sub-class mask in memory. Each
1325     // mask has RCMaskWords uint32_t entries.
1326     //
1327     // Every bit mask present in the list has at least one bit set.
1328 
1329     // Compress the sub-reg index lists.
1330     typedef std::vector<const CodeGenSubRegIndex*> IdxList;
1331     SmallVector<IdxList, 8> SuperRegIdxLists(RegisterClasses.size());
1332     SequenceToOffsetTable<IdxList, deref<std::less<>>> SuperRegIdxSeqs;
1333     BitVector MaskBV(RegisterClasses.size());
1334 
1335     for (const auto &RC : RegisterClasses) {
1336       OS << "static const uint32_t " << RC.getName()
1337          << "SubClassMask[] = {\n  ";
1338       printBitVectorAsHex(OS, RC.getSubClasses(), 32);
1339 
1340       // Emit super-reg class masks for any relevant SubRegIndices that can
1341       // project into RC.
1342       IdxList &SRIList = SuperRegIdxLists[RC.EnumValue];
1343       for (auto &Idx : SubRegIndices) {
1344         MaskBV.reset();
1345         RC.getSuperRegClasses(&Idx, MaskBV);
1346         if (MaskBV.none())
1347           continue;
1348         SRIList.push_back(&Idx);
1349         OS << "\n  ";
1350         printBitVectorAsHex(OS, MaskBV, 32);
1351         OS << "// " << Idx.getName();
1352       }
1353       SuperRegIdxSeqs.add(SRIList);
1354       OS << "\n};\n\n";
1355     }
1356 
1357     OS << "static const uint16_t SuperRegIdxSeqs[] = {\n";
1358     SuperRegIdxSeqs.layout();
1359     SuperRegIdxSeqs.emit(OS, printSubRegIndex);
1360     OS << "};\n\n";
1361 
1362     // Emit NULL terminated super-class lists.
1363     for (const auto &RC : RegisterClasses) {
1364       ArrayRef<CodeGenRegisterClass*> Supers = RC.getSuperClasses();
1365 
1366       // Skip classes without supers.  We can reuse NullRegClasses.
1367       if (Supers.empty())
1368         continue;
1369 
1370       OS << "static const TargetRegisterClass *const "
1371          << RC.getName() << "Superclasses[] = {\n";
1372       for (const auto *Super : Supers)
1373         OS << "  &" << Super->getQualifiedName() << "RegClass,\n";
1374       OS << "  nullptr\n};\n\n";
1375     }
1376 
1377     // Emit methods.
1378     for (const auto &RC : RegisterClasses) {
1379       if (!RC.AltOrderSelect.empty()) {
1380         OS << "\nstatic inline unsigned " << RC.getName()
1381            << "AltOrderSelect(const MachineFunction &MF) {"
1382            << RC.AltOrderSelect << "}\n\n"
1383            << "static ArrayRef<MCPhysReg> " << RC.getName()
1384            << "GetRawAllocationOrder(const MachineFunction &MF) {\n";
1385         for (unsigned oi = 1 , oe = RC.getNumOrders(); oi != oe; ++oi) {
1386           ArrayRef<Record*> Elems = RC.getOrder(oi);
1387           if (!Elems.empty()) {
1388             OS << "  static const MCPhysReg AltOrder" << oi << "[] = {";
1389             for (unsigned elem = 0; elem != Elems.size(); ++elem)
1390               OS << (elem ? ", " : " ") << getQualifiedName(Elems[elem]);
1391             OS << " };\n";
1392           }
1393         }
1394         OS << "  const MCRegisterClass &MCR = " << Target.getName()
1395            << "MCRegisterClasses[" << RC.getQualifiedName() + "RegClassID];\n"
1396            << "  const ArrayRef<MCPhysReg> Order[] = {\n"
1397            << "    makeArrayRef(MCR.begin(), MCR.getNumRegs()";
1398         for (unsigned oi = 1, oe = RC.getNumOrders(); oi != oe; ++oi)
1399           if (RC.getOrder(oi).empty())
1400             OS << "),\n    ArrayRef<MCPhysReg>(";
1401           else
1402             OS << "),\n    makeArrayRef(AltOrder" << oi;
1403         OS << ")\n  };\n  const unsigned Select = " << RC.getName()
1404            << "AltOrderSelect(MF);\n  assert(Select < " << RC.getNumOrders()
1405            << ");\n  return Order[Select];\n}\n";
1406       }
1407     }
1408 
1409     // Now emit the actual value-initialized register class instances.
1410     OS << "\nnamespace " << RegisterClasses.front().Namespace
1411        << " {   // Register class instances\n";
1412 
1413     for (const auto &RC : RegisterClasses) {
1414       OS << "  extern const TargetRegisterClass " << RC.getName()
1415          << "RegClass = {\n    " << '&' << Target.getName()
1416          << "MCRegisterClasses[" << RC.getName() << "RegClassID],\n    "
1417          << RC.getName() << "SubClassMask,\n    SuperRegIdxSeqs + "
1418          << SuperRegIdxSeqs.get(SuperRegIdxLists[RC.EnumValue]) << ",\n    ";
1419       printMask(OS, RC.LaneMask);
1420       OS << ",\n    " << (unsigned)RC.AllocationPriority << ",\n    "
1421          << (RC.HasDisjunctSubRegs?"true":"false")
1422          << ", /* HasDisjunctSubRegs */\n    "
1423          << (RC.CoveredBySubRegs?"true":"false")
1424          << ", /* CoveredBySubRegs */\n    ";
1425       if (RC.getSuperClasses().empty())
1426         OS << "NullRegClasses,\n    ";
1427       else
1428         OS << RC.getName() << "Superclasses,\n    ";
1429       if (RC.AltOrderSelect.empty())
1430         OS << "nullptr\n";
1431       else
1432         OS << RC.getName() << "GetRawAllocationOrder\n";
1433       OS << "  };\n\n";
1434     }
1435 
1436     OS << "} // end namespace " << RegisterClasses.front().Namespace << "\n";
1437   }
1438 
1439   OS << "\nnamespace {\n";
1440   OS << "  const TargetRegisterClass *const RegisterClasses[] = {\n";
1441   for (const auto &RC : RegisterClasses)
1442     OS << "    &" << RC.getQualifiedName() << "RegClass,\n";
1443   OS << "  };\n";
1444   OS << "} // end anonymous namespace\n";
1445 
1446   // Emit extra information about registers.
1447   const std::string &TargetName = std::string(Target.getName());
1448   const auto &Regs = RegBank.getRegisters();
1449   unsigned NumRegCosts = 1;
1450   for (const auto &Reg : Regs)
1451     NumRegCosts = std::max((size_t)NumRegCosts, Reg.CostPerUse.size());
1452 
1453   std::vector<unsigned> AllRegCostPerUse;
1454   llvm::BitVector InAllocClass(Regs.size() + 1, false);
1455   AllRegCostPerUse.insert(AllRegCostPerUse.end(), NumRegCosts, 0);
1456 
1457   // Populate the vector RegCosts with the CostPerUse list of the registers
1458   // in the order they are read. Have at most NumRegCosts entries for
1459   // each register. Fill with zero for values which are not explicitly given.
1460   for (const auto &Reg : Regs) {
1461     auto Costs = Reg.CostPerUse;
1462     AllRegCostPerUse.insert(AllRegCostPerUse.end(), Costs.begin(), Costs.end());
1463     if (NumRegCosts > Costs.size())
1464       AllRegCostPerUse.insert(AllRegCostPerUse.end(),
1465                               NumRegCosts - Costs.size(), 0);
1466 
1467     if (AllocatableRegs.count(Reg.TheDef))
1468       InAllocClass.set(Reg.EnumValue);
1469   }
1470 
1471   // Emit the cost values as a 1D-array after grouping them by their indices,
1472   // i.e. the costs for all registers corresponds to index 0, 1, 2, etc.
1473   // Size of the emitted array should be NumRegCosts * (Regs.size() + 1).
1474   OS << "\nstatic const uint8_t "
1475      << "CostPerUseTable[] = { \n";
1476   for (unsigned int I = 0; I < NumRegCosts; ++I) {
1477     for (unsigned J = I, E = AllRegCostPerUse.size(); J < E; J += NumRegCosts)
1478       OS << AllRegCostPerUse[J] << ", ";
1479   }
1480   OS << "};\n\n";
1481 
1482   OS << "\nstatic const bool "
1483      << "InAllocatableClassTable[] = { \n";
1484   for (unsigned I = 0, E = InAllocClass.size(); I < E; ++I) {
1485     OS << (InAllocClass[I] ? "true" : "false") << ", ";
1486   }
1487   OS << "};\n\n";
1488 
1489   OS << "\nstatic const TargetRegisterInfoDesc " << TargetName
1490      << "RegInfoDesc = { // Extra Descriptors\n";
1491   OS << "CostPerUseTable, " << NumRegCosts << ", "
1492      << "InAllocatableClassTable";
1493   OS << "};\n\n"; // End of register descriptors...
1494 
1495   std::string ClassName = Target.getName().str() + "GenRegisterInfo";
1496 
1497   auto SubRegIndicesSize =
1498       std::distance(SubRegIndices.begin(), SubRegIndices.end());
1499 
1500   if (!SubRegIndices.empty()) {
1501     emitComposeSubRegIndices(OS, RegBank, ClassName);
1502     emitComposeSubRegIndexLaneMask(OS, RegBank, ClassName);
1503   }
1504 
1505   // Emit getSubClassWithSubReg.
1506   if (!SubRegIndices.empty()) {
1507     OS << "const TargetRegisterClass *" << ClassName
1508        << "::getSubClassWithSubReg(const TargetRegisterClass *RC, unsigned Idx)"
1509        << " const {\n";
1510     // Use the smallest type that can hold a regclass ID with room for a
1511     // sentinel.
1512     if (RegisterClasses.size() < UINT8_MAX)
1513       OS << "  static const uint8_t Table[";
1514     else if (RegisterClasses.size() < UINT16_MAX)
1515       OS << "  static const uint16_t Table[";
1516     else
1517       PrintFatalError("Too many register classes.");
1518     OS << RegisterClasses.size() << "][" << SubRegIndicesSize << "] = {\n";
1519     for (const auto &RC : RegisterClasses) {
1520       OS << "    {\t// " << RC.getName() << "\n";
1521       for (auto &Idx : SubRegIndices) {
1522         if (CodeGenRegisterClass *SRC = RC.getSubClassWithSubReg(&Idx))
1523           OS << "      " << SRC->EnumValue + 1 << ",\t// " << Idx.getName()
1524              << " -> " << SRC->getName() << "\n";
1525         else
1526           OS << "      0,\t// " << Idx.getName() << "\n";
1527       }
1528       OS << "    },\n";
1529     }
1530     OS << "  };\n  assert(RC && \"Missing regclass\");\n"
1531        << "  if (!Idx) return RC;\n  --Idx;\n"
1532        << "  assert(Idx < " << SubRegIndicesSize << " && \"Bad subreg\");\n"
1533        << "  unsigned TV = Table[RC->getID()][Idx];\n"
1534        << "  return TV ? getRegClass(TV - 1) : nullptr;\n}\n\n";
1535   }
1536 
1537   EmitRegUnitPressure(OS, RegBank, ClassName);
1538 
1539   // Emit the constructor of the class...
1540   OS << "extern const MCRegisterDesc " << TargetName << "RegDesc[];\n";
1541   OS << "extern const MCPhysReg " << TargetName << "RegDiffLists[];\n";
1542   OS << "extern const LaneBitmask " << TargetName << "LaneMaskLists[];\n";
1543   OS << "extern const char " << TargetName << "RegStrings[];\n";
1544   OS << "extern const char " << TargetName << "RegClassStrings[];\n";
1545   OS << "extern const MCPhysReg " << TargetName << "RegUnitRoots[][2];\n";
1546   OS << "extern const uint16_t " << TargetName << "SubRegIdxLists[];\n";
1547   OS << "extern const MCRegisterInfo::SubRegCoveredBits "
1548      << TargetName << "SubRegIdxRanges[];\n";
1549   OS << "extern const uint16_t " << TargetName << "RegEncodingTable[];\n";
1550 
1551   EmitRegMappingTables(OS, Regs, true);
1552 
1553   OS << ClassName << "::\n"
1554      << ClassName
1555      << "(unsigned RA, unsigned DwarfFlavour, unsigned EHFlavour,\n"
1556         "      unsigned PC, unsigned HwMode)\n"
1557      << "  : TargetRegisterInfo(&" << TargetName << "RegInfoDesc"
1558      << ", RegisterClasses, RegisterClasses+" << RegisterClasses.size() << ",\n"
1559      << "             SubRegIndexNameTable, SubRegIndexLaneMaskTable,\n"
1560      << "             ";
1561   printMask(OS, RegBank.CoveringLanes);
1562   OS << ", RegClassInfos, HwMode) {\n"
1563      << "  InitMCRegisterInfo(" << TargetName << "RegDesc, " << Regs.size() + 1
1564      << ", RA, PC,\n                     " << TargetName
1565      << "MCRegisterClasses, " << RegisterClasses.size() << ",\n"
1566      << "                     " << TargetName << "RegUnitRoots,\n"
1567      << "                     " << RegBank.getNumNativeRegUnits() << ",\n"
1568      << "                     " << TargetName << "RegDiffLists,\n"
1569      << "                     " << TargetName << "LaneMaskLists,\n"
1570      << "                     " << TargetName << "RegStrings,\n"
1571      << "                     " << TargetName << "RegClassStrings,\n"
1572      << "                     " << TargetName << "SubRegIdxLists,\n"
1573      << "                     " << SubRegIndicesSize + 1 << ",\n"
1574      << "                     " << TargetName << "SubRegIdxRanges,\n"
1575      << "                     " << TargetName << "RegEncodingTable);\n\n";
1576 
1577   EmitRegMapping(OS, Regs, true);
1578 
1579   OS << "}\n\n";
1580 
1581   // Emit CalleeSavedRegs information.
1582   std::vector<Record*> CSRSets =
1583     Records.getAllDerivedDefinitions("CalleeSavedRegs");
1584   for (unsigned i = 0, e = CSRSets.size(); i != e; ++i) {
1585     Record *CSRSet = CSRSets[i];
1586     const SetTheory::RecVec *Regs = RegBank.getSets().expand(CSRSet);
1587     assert(Regs && "Cannot expand CalleeSavedRegs instance");
1588 
1589     // Emit the *_SaveList list of callee-saved registers.
1590     OS << "static const MCPhysReg " << CSRSet->getName()
1591        << "_SaveList[] = { ";
1592     for (unsigned r = 0, re = Regs->size(); r != re; ++r)
1593       OS << getQualifiedName((*Regs)[r]) << ", ";
1594     OS << "0 };\n";
1595 
1596     // Emit the *_RegMask bit mask of call-preserved registers.
1597     BitVector Covered = RegBank.computeCoveredRegisters(*Regs);
1598 
1599     // Check for an optional OtherPreserved set.
1600     // Add those registers to RegMask, but not to SaveList.
1601     if (DagInit *OPDag =
1602         dyn_cast<DagInit>(CSRSet->getValueInit("OtherPreserved"))) {
1603       SetTheory::RecSet OPSet;
1604       RegBank.getSets().evaluate(OPDag, OPSet, CSRSet->getLoc());
1605       Covered |= RegBank.computeCoveredRegisters(
1606         ArrayRef<Record*>(OPSet.begin(), OPSet.end()));
1607     }
1608 
1609     OS << "static const uint32_t " << CSRSet->getName()
1610        << "_RegMask[] = { ";
1611     printBitVectorAsHex(OS, Covered, 32);
1612     OS << "};\n";
1613   }
1614   OS << "\n\n";
1615 
1616   OS << "ArrayRef<const uint32_t *> " << ClassName
1617      << "::getRegMasks() const {\n";
1618   if (!CSRSets.empty()) {
1619     OS << "  static const uint32_t *const Masks[] = {\n";
1620     for (Record *CSRSet : CSRSets)
1621       OS << "    " << CSRSet->getName() << "_RegMask,\n";
1622     OS << "  };\n";
1623     OS << "  return makeArrayRef(Masks);\n";
1624   } else {
1625     OS << "  return None;\n";
1626   }
1627   OS << "}\n\n";
1628 
1629   OS << "ArrayRef<const char *> " << ClassName
1630      << "::getRegMaskNames() const {\n";
1631   if (!CSRSets.empty()) {
1632   OS << "  static const char *const Names[] = {\n";
1633     for (Record *CSRSet : CSRSets)
1634       OS << "    " << '"' << CSRSet->getName() << '"' << ",\n";
1635     OS << "  };\n";
1636     OS << "  return makeArrayRef(Names);\n";
1637   } else {
1638     OS << "  return None;\n";
1639   }
1640   OS << "}\n\n";
1641 
1642   OS << "const " << TargetName << "FrameLowering *\n" << TargetName
1643      << "GenRegisterInfo::getFrameLowering(const MachineFunction &MF) {\n"
1644      << "  return static_cast<const " << TargetName << "FrameLowering *>(\n"
1645      << "      MF.getSubtarget().getFrameLowering());\n"
1646      << "}\n\n";
1647 
1648   OS << "} // end namespace llvm\n\n";
1649   OS << "#endif // GET_REGINFO_TARGET_DESC\n\n";
1650 }
1651 
1652 void RegisterInfoEmitter::run(raw_ostream &OS) {
1653   CodeGenRegBank &RegBank = Target.getRegBank();
1654   Records.startTimer("Print enums");
1655   runEnums(OS, Target, RegBank);
1656 
1657   Records.startTimer("Print MC registers");
1658   runMCDesc(OS, Target, RegBank);
1659 
1660   Records.startTimer("Print header fragment");
1661   runTargetHeader(OS, Target, RegBank);
1662 
1663   Records.startTimer("Print target registers");
1664   runTargetDesc(OS, Target, RegBank);
1665 
1666   if (RegisterInfoDebug)
1667     debugDump(errs());
1668 }
1669 
1670 void RegisterInfoEmitter::debugDump(raw_ostream &OS) {
1671   CodeGenRegBank &RegBank = Target.getRegBank();
1672   const CodeGenHwModes &CGH = Target.getHwModes();
1673   unsigned NumModes = CGH.getNumModeIds();
1674   auto getModeName = [CGH] (unsigned M) -> StringRef {
1675     if (M == 0)
1676       return "Default";
1677     return CGH.getMode(M).Name;
1678   };
1679 
1680   for (const CodeGenRegisterClass &RC : RegBank.getRegClasses()) {
1681     OS << "RegisterClass " << RC.getName() << ":\n";
1682     OS << "\tSpillSize: {";
1683     for (unsigned M = 0; M != NumModes; ++M)
1684       OS << ' ' << getModeName(M) << ':' << RC.RSI.get(M).SpillSize;
1685     OS << " }\n\tSpillAlignment: {";
1686     for (unsigned M = 0; M != NumModes; ++M)
1687       OS << ' ' << getModeName(M) << ':' << RC.RSI.get(M).SpillAlignment;
1688     OS << " }\n\tNumRegs: " << RC.getMembers().size() << '\n';
1689     OS << "\tLaneMask: " << PrintLaneMask(RC.LaneMask) << '\n';
1690     OS << "\tHasDisjunctSubRegs: " << RC.HasDisjunctSubRegs << '\n';
1691     OS << "\tCoveredBySubRegs: " << RC.CoveredBySubRegs << '\n';
1692     OS << "\tRegs:";
1693     for (const CodeGenRegister *R : RC.getMembers()) {
1694       OS << " " << R->getName();
1695     }
1696     OS << '\n';
1697     OS << "\tSubClasses:";
1698     const BitVector &SubClasses = RC.getSubClasses();
1699     for (const CodeGenRegisterClass &SRC : RegBank.getRegClasses()) {
1700       if (!SubClasses.test(SRC.EnumValue))
1701         continue;
1702       OS << " " << SRC.getName();
1703     }
1704     OS << '\n';
1705     OS << "\tSuperClasses:";
1706     for (const CodeGenRegisterClass *SRC : RC.getSuperClasses()) {
1707       OS << " " << SRC->getName();
1708     }
1709     OS << '\n';
1710   }
1711 
1712   for (const CodeGenSubRegIndex &SRI : RegBank.getSubRegIndices()) {
1713     OS << "SubRegIndex " << SRI.getName() << ":\n";
1714     OS << "\tLaneMask: " << PrintLaneMask(SRI.LaneMask) << '\n';
1715     OS << "\tAllSuperRegsCovered: " << SRI.AllSuperRegsCovered << '\n';
1716   }
1717 
1718   for (const CodeGenRegister &R : RegBank.getRegisters()) {
1719     OS << "Register " << R.getName() << ":\n";
1720     OS << "\tCostPerUse: ";
1721     for (const auto &Cost : R.CostPerUse)
1722       OS << Cost << " ";
1723     OS << '\n';
1724     OS << "\tCoveredBySubregs: " << R.CoveredBySubRegs << '\n';
1725     OS << "\tHasDisjunctSubRegs: " << R.HasDisjunctSubRegs << '\n';
1726     for (std::pair<CodeGenSubRegIndex*,CodeGenRegister*> P : R.getSubRegs()) {
1727       OS << "\tSubReg " << P.first->getName()
1728          << " = " << P.second->getName() << '\n';
1729     }
1730   }
1731 }
1732 
1733 namespace llvm {
1734 
1735 void EmitRegisterInfo(RecordKeeper &RK, raw_ostream &OS) {
1736   RegisterInfoEmitter(RK).run(OS);
1737 }
1738 
1739 } // end namespace llvm
1740