98bb611126e9150c87bb13a3ef496b154fbd52a6
[oota-llvm.git] / utils / TableGen / RegisterInfoEmitter.cpp
1 //===- RegisterInfoEmitter.cpp - Generate a Register File Desc. -*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
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.
13 //
14 //===----------------------------------------------------------------------===//
15
16 #include "RegisterInfoEmitter.h"
17 #include "CodeGenTarget.h"
18 #include "CodeGenRegisters.h"
19 #include "SequenceToOffsetTable.h"
20 #include "llvm/TableGen/Error.h"
21 #include "llvm/TableGen/Record.h"
22 #include "llvm/ADT/BitVector.h"
23 #include "llvm/ADT/StringExtras.h"
24 #include "llvm/ADT/STLExtras.h"
25 #include "llvm/ADT/Twine.h"
26 #include "llvm/Support/Format.h"
27 #include <algorithm>
28 #include <set>
29 using namespace llvm;
30
31 // runEnums - Print out enum values for all of the registers.
32 void RegisterInfoEmitter::runEnums(raw_ostream &OS,
33                                    CodeGenTarget &Target, CodeGenRegBank &Bank) {
34   const std::vector<CodeGenRegister*> &Registers = Bank.getRegisters();
35
36   // Register enums are stored as uint16_t in the tables. Make sure we'll fit.
37   assert(Registers.size() <= 0xffff && "Too many regs to fit in tables");
38
39   std::string Namespace = Registers[0]->TheDef->getValueAsString("Namespace");
40
41   EmitSourceFileHeader("Target Register Enum Values", OS);
42
43   OS << "\n#ifdef GET_REGINFO_ENUM\n";
44   OS << "#undef GET_REGINFO_ENUM\n";
45
46   OS << "namespace llvm {\n\n";
47
48   OS << "class MCRegisterClass;\n"
49      << "extern const MCRegisterClass " << Namespace
50      << "MCRegisterClasses[];\n\n";
51
52   if (!Namespace.empty())
53     OS << "namespace " << Namespace << " {\n";
54   OS << "enum {\n  NoRegister,\n";
55
56   for (unsigned i = 0, e = Registers.size(); i != e; ++i)
57     OS << "  " << Registers[i]->getName() << " = " <<
58       Registers[i]->EnumValue << ",\n";
59   assert(Registers.size() == Registers[Registers.size()-1]->EnumValue &&
60          "Register enum value mismatch!");
61   OS << "  NUM_TARGET_REGS \t// " << Registers.size()+1 << "\n";
62   OS << "};\n";
63   if (!Namespace.empty())
64     OS << "}\n";
65
66   ArrayRef<CodeGenRegisterClass*> RegisterClasses = Bank.getRegClasses();
67   if (!RegisterClasses.empty()) {
68
69     // RegisterClass enums are stored as uint16_t in the tables.
70     assert(RegisterClasses.size() <= 0xffff &&
71            "Too many register classes to fit in tables");
72
73     OS << "\n// Register classes\n";
74     if (!Namespace.empty())
75       OS << "namespace " << Namespace << " {\n";
76     OS << "enum {\n";
77     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
78       if (i) OS << ",\n";
79       OS << "  " << RegisterClasses[i]->getName() << "RegClassID";
80       OS << " = " << i;
81     }
82     OS << "\n  };\n";
83     if (!Namespace.empty())
84       OS << "}\n";
85   }
86
87   const std::vector<Record*> RegAltNameIndices = Target.getRegAltNameIndices();
88   // If the only definition is the default NoRegAltName, we don't need to
89   // emit anything.
90   if (RegAltNameIndices.size() > 1) {
91     OS << "\n// Register alternate name indices\n";
92     if (!Namespace.empty())
93       OS << "namespace " << Namespace << " {\n";
94     OS << "enum {\n";
95     for (unsigned i = 0, e = RegAltNameIndices.size(); i != e; ++i)
96       OS << "  " << RegAltNameIndices[i]->getName() << ",\t// " << i << "\n";
97     OS << "  NUM_TARGET_REG_ALT_NAMES = " << RegAltNameIndices.size() << "\n";
98     OS << "};\n";
99     if (!Namespace.empty())
100       OS << "}\n";
101   }
102
103   ArrayRef<CodeGenSubRegIndex*> SubRegIndices = Bank.getSubRegIndices();
104   if (!SubRegIndices.empty()) {
105     OS << "\n// Subregister indices\n";
106     std::string Namespace =
107       SubRegIndices[0]->getNamespace();
108     if (!Namespace.empty())
109       OS << "namespace " << Namespace << " {\n";
110     OS << "enum {\n  NoSubRegister,\n";
111     for (unsigned i = 0, e = Bank.getNumNamedIndices(); i != e; ++i)
112       OS << "  " << SubRegIndices[i]->getName() << ",\t// " << i+1 << "\n";
113     OS << "  NUM_TARGET_NAMED_SUBREGS\n};\n";
114     if (!Namespace.empty())
115       OS << "}\n";
116   }
117
118   OS << "} // End llvm namespace \n";
119   OS << "#endif // GET_REGINFO_ENUM\n\n";
120 }
121
122 void RegisterInfoEmitter::
123 EmitRegUnitPressure(raw_ostream &OS, const CodeGenRegBank &RegBank,
124                     const std::string &ClassName) {
125   unsigned NumRCs = RegBank.getRegClasses().size();
126   unsigned NumSets = RegBank.getNumRegPressureSets();
127
128   OS << "/// Get the weight in units of pressure for this register class.\n"
129      << "const RegClassWeight &" << ClassName << "::\n"
130      << "getRegClassWeight(const TargetRegisterClass *RC) const {\n"
131      << "  static const RegClassWeight RCWeightTable[] = {\n";
132   for (unsigned i = 0, e = NumRCs; i != e; ++i) {
133     const CodeGenRegisterClass &RC = *RegBank.getRegClasses()[i];
134     const CodeGenRegister::Set &Regs = RC.getMembers();
135     if (Regs.empty())
136       OS << "    {0, 0";
137     else {
138       std::vector<unsigned> RegUnits;
139       RC.buildRegUnitSet(RegUnits);
140       OS << "    {" << (*Regs.begin())->getWeight(RegBank)
141          << ", " << RegBank.getRegUnitSetWeight(RegUnits);
142     }
143     OS << "},  \t// " << RC.getName() << "\n";
144   }
145   OS << "    {0, 0} };\n"
146      << "  return RCWeightTable[RC->getID()];\n"
147      << "}\n\n";
148
149   OS << "\n"
150      << "// Get the number of dimensions of register pressure.\n"
151      << "unsigned " << ClassName << "::getNumRegPressureSets() const {\n"
152      << "  return " << NumSets << ";\n}\n\n";
153
154   OS << "// Get the name of this register unit pressure set.\n"
155      << "const char *" << ClassName << "::\n"
156      << "getRegPressureSetName(unsigned Idx) const {\n"
157      << "  static const char *PressureNameTable[] = {\n";
158   for (unsigned i = 0; i < NumSets; ++i ) {
159     OS << "    \"" << RegBank.getRegPressureSet(i).Name << "\",\n";
160   }
161   OS << "    0 };\n"
162      << "  return PressureNameTable[Idx];\n"
163      << "}\n\n";
164
165   OS << "// Get the register unit pressure limit for this dimension.\n"
166      << "// This limit must be adjusted dynamically for reserved registers.\n"
167      << "unsigned " << ClassName << "::\n"
168      << "getRegPressureSetLimit(unsigned Idx) const {\n"
169      << "  static const unsigned PressureLimitTable[] = {\n";
170   for (unsigned i = 0; i < NumSets; ++i ) {
171     const RegUnitSet &RegUnits = RegBank.getRegPressureSet(i);
172     OS << "    " << RegBank.getRegUnitSetWeight(RegUnits.Units)
173        << ",  \t// " << i << ": " << RegUnits.Name << "\n";
174   }
175   OS << "    0 };\n"
176      << "  return PressureLimitTable[Idx];\n"
177      << "}\n\n";
178
179   OS << "/// Get the dimensions of register pressure "
180      << "impacted by this register class.\n"
181      << "/// Returns a -1 terminated array of pressure set IDs\n"
182      << "const int* " << ClassName << "::\n"
183      << "getRegClassPressureSets(const TargetRegisterClass *RC) const {\n"
184      << "  static const int RCSetsTable[] = {\n    ";
185   std::vector<unsigned> RCSetStarts(NumRCs);
186   for (unsigned i = 0, StartIdx = 0, e = NumRCs; i != e; ++i) {
187     RCSetStarts[i] = StartIdx;
188     ArrayRef<unsigned> PSetIDs = RegBank.getRCPressureSetIDs(i);
189     for (ArrayRef<unsigned>::iterator PSetI = PSetIDs.begin(),
190            PSetE = PSetIDs.end(); PSetI != PSetE; ++PSetI) {
191       OS << *PSetI << ",  ";
192       ++StartIdx;
193     }
194     OS << "-1,  \t// " << RegBank.getRegClasses()[i]->getName() << "\n    ";
195     ++StartIdx;
196   }
197   OS << "-1 };\n";
198   OS << "  static const unsigned RCSetStartTable[] = {\n    ";
199   for (unsigned i = 0, e = NumRCs; i != e; ++i) {
200     OS << RCSetStarts[i] << ",";
201   }
202   OS << "0 };\n"
203      << "  unsigned SetListStart = RCSetStartTable[RC->getID()];\n"
204      << "  return &RCSetsTable[SetListStart];\n"
205      << "}\n\n";
206 }
207
208 void
209 RegisterInfoEmitter::EmitRegMappingTables(raw_ostream &OS,
210                                        const std::vector<CodeGenRegister*> &Regs,
211                                           bool isCtor) {
212   // Collect all information about dwarf register numbers
213   typedef std::map<Record*, std::vector<int64_t>, LessRecord> DwarfRegNumsMapTy;
214   DwarfRegNumsMapTy DwarfRegNums;
215
216   // First, just pull all provided information to the map
217   unsigned maxLength = 0;
218   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
219     Record *Reg = Regs[i]->TheDef;
220     std::vector<int64_t> RegNums = Reg->getValueAsListOfInts("DwarfNumbers");
221     maxLength = std::max((size_t)maxLength, RegNums.size());
222     if (DwarfRegNums.count(Reg))
223       PrintWarning(Reg->getLoc(), Twine("DWARF numbers for register ") +
224                    getQualifiedName(Reg) + "specified multiple times");
225     DwarfRegNums[Reg] = RegNums;
226   }
227
228   if (!maxLength)
229     return;
230
231   // Now we know maximal length of number list. Append -1's, where needed
232   for (DwarfRegNumsMapTy::iterator
233        I = DwarfRegNums.begin(), E = DwarfRegNums.end(); I != E; ++I)
234     for (unsigned i = I->second.size(), e = maxLength; i != e; ++i)
235       I->second.push_back(-1);
236
237   std::string Namespace = Regs[0]->TheDef->getValueAsString("Namespace");
238
239   OS << "// " << Namespace << " Dwarf<->LLVM register mappings.\n";
240
241   // Emit reverse information about the dwarf register numbers.
242   for (unsigned j = 0; j < 2; ++j) {
243     for (unsigned i = 0, e = maxLength; i != e; ++i) {
244       OS << "extern const MCRegisterInfo::DwarfLLVMRegPair " << Namespace;
245       OS << (j == 0 ? "DwarfFlavour" : "EHFlavour");
246       OS << i << "Dwarf2L[]";
247
248       if (!isCtor) {
249         OS << " = {\n";
250
251         // Store the mapping sorted by the LLVM reg num so lookup can be done
252         // with a binary search.
253         std::map<uint64_t, Record*> Dwarf2LMap;
254         for (DwarfRegNumsMapTy::iterator
255                I = DwarfRegNums.begin(), E = DwarfRegNums.end(); I != E; ++I) {
256           int DwarfRegNo = I->second[i];
257           if (DwarfRegNo < 0)
258             continue;
259           Dwarf2LMap[DwarfRegNo] = I->first;
260         }
261
262         for (std::map<uint64_t, Record*>::iterator
263                I = Dwarf2LMap.begin(), E = Dwarf2LMap.end(); I != E; ++I)
264           OS << "  { " << I->first << "U, " << getQualifiedName(I->second)
265              << " },\n";
266
267         OS << "};\n";
268       } else {
269         OS << ";\n";
270       }
271
272       // We have to store the size in a const global, it's used in multiple
273       // places.
274       OS << "extern const unsigned " << Namespace
275          << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i << "Dwarf2LSize";
276       if (!isCtor)
277         OS << " = sizeof(" << Namespace
278            << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i
279            << "Dwarf2L)/sizeof(MCRegisterInfo::DwarfLLVMRegPair);\n\n";
280       else
281         OS << ";\n\n";
282     }
283   }
284
285   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
286     Record *Reg = Regs[i]->TheDef;
287     const RecordVal *V = Reg->getValue("DwarfAlias");
288     if (!V || !V->getValue())
289       continue;
290
291     DefInit *DI = dynamic_cast<DefInit*>(V->getValue());
292     Record *Alias = DI->getDef();
293     DwarfRegNums[Reg] = DwarfRegNums[Alias];
294   }
295
296   // Emit information about the dwarf register numbers.
297   for (unsigned j = 0; j < 2; ++j) {
298     for (unsigned i = 0, e = maxLength; i != e; ++i) {
299       OS << "extern const MCRegisterInfo::DwarfLLVMRegPair " << Namespace;
300       OS << (j == 0 ? "DwarfFlavour" : "EHFlavour");
301       OS << i << "L2Dwarf[]";
302       if (!isCtor) {
303         OS << " = {\n";
304         // Store the mapping sorted by the Dwarf reg num so lookup can be done
305         // with a binary search.
306         for (DwarfRegNumsMapTy::iterator
307                I = DwarfRegNums.begin(), E = DwarfRegNums.end(); I != E; ++I) {
308           int RegNo = I->second[i];
309           if (RegNo == -1) // -1 is the default value, don't emit a mapping.
310             continue;
311
312           OS << "  { " << getQualifiedName(I->first) << ", " << RegNo
313              << "U },\n";
314         }
315         OS << "};\n";
316       } else {
317         OS << ";\n";
318       }
319
320       // We have to store the size in a const global, it's used in multiple
321       // places.
322       OS << "extern const unsigned " << Namespace
323          << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i << "L2DwarfSize";
324       if (!isCtor)
325         OS << " = sizeof(" << Namespace
326            << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i
327            << "L2Dwarf)/sizeof(MCRegisterInfo::DwarfLLVMRegPair);\n\n";
328       else
329         OS << ";\n\n";
330     }
331   }
332 }
333
334 void
335 RegisterInfoEmitter::EmitRegMapping(raw_ostream &OS,
336                                     const std::vector<CodeGenRegister*> &Regs,
337                                     bool isCtor) {
338   // Emit the initializer so the tables from EmitRegMappingTables get wired up
339   // to the MCRegisterInfo object.
340   unsigned maxLength = 0;
341   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
342     Record *Reg = Regs[i]->TheDef;
343     maxLength = std::max((size_t)maxLength,
344                          Reg->getValueAsListOfInts("DwarfNumbers").size());
345   }
346
347   if (!maxLength)
348     return;
349
350   std::string Namespace = Regs[0]->TheDef->getValueAsString("Namespace");
351
352   // Emit reverse information about the dwarf register numbers.
353   for (unsigned j = 0; j < 2; ++j) {
354     OS << "  switch (";
355     if (j == 0)
356       OS << "DwarfFlavour";
357     else
358       OS << "EHFlavour";
359     OS << ") {\n"
360      << "  default:\n"
361      << "    llvm_unreachable(\"Unknown DWARF flavour\");\n";
362
363     for (unsigned i = 0, e = maxLength; i != e; ++i) {
364       OS << "  case " << i << ":\n";
365       OS << "    ";
366       if (!isCtor)
367         OS << "RI->";
368       std::string Tmp;
369       raw_string_ostream(Tmp) << Namespace
370                               << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i
371                               << "Dwarf2L";
372       OS << "mapDwarfRegsToLLVMRegs(" << Tmp << ", " << Tmp << "Size, ";
373       if (j == 0)
374           OS << "false";
375         else
376           OS << "true";
377       OS << ");\n";
378       OS << "    break;\n";
379     }
380     OS << "  }\n";
381   }
382
383   // Emit information about the dwarf register numbers.
384   for (unsigned j = 0; j < 2; ++j) {
385     OS << "  switch (";
386     if (j == 0)
387       OS << "DwarfFlavour";
388     else
389       OS << "EHFlavour";
390     OS << ") {\n"
391        << "  default:\n"
392        << "    llvm_unreachable(\"Unknown DWARF flavour\");\n";
393
394     for (unsigned i = 0, e = maxLength; i != e; ++i) {
395       OS << "  case " << i << ":\n";
396       OS << "    ";
397       if (!isCtor)
398         OS << "RI->";
399       std::string Tmp;
400       raw_string_ostream(Tmp) << Namespace
401                               << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i
402                               << "L2Dwarf";
403       OS << "mapLLVMRegsToDwarfRegs(" << Tmp << ", " << Tmp << "Size, ";
404       if (j == 0)
405           OS << "false";
406         else
407           OS << "true";
408       OS << ");\n";
409       OS << "    break;\n";
410     }
411     OS << "  }\n";
412   }
413 }
414
415 // Print a BitVector as a sequence of hex numbers using a little-endian mapping.
416 // Width is the number of bits per hex number.
417 static void printBitVectorAsHex(raw_ostream &OS,
418                                 const BitVector &Bits,
419                                 unsigned Width) {
420   assert(Width <= 32 && "Width too large");
421   unsigned Digits = (Width + 3) / 4;
422   for (unsigned i = 0, e = Bits.size(); i < e; i += Width) {
423     unsigned Value = 0;
424     for (unsigned j = 0; j != Width && i + j != e; ++j)
425       Value |= Bits.test(i + j) << j;
426     OS << format("0x%0*x, ", Digits, Value);
427   }
428 }
429
430 // Helper to emit a set of bits into a constant byte array.
431 class BitVectorEmitter {
432   BitVector Values;
433 public:
434   void add(unsigned v) {
435     if (v >= Values.size())
436       Values.resize(((v/8)+1)*8); // Round up to the next byte.
437     Values[v] = true;
438   }
439
440   void print(raw_ostream &OS) {
441     printBitVectorAsHex(OS, Values, 8);
442   }
443 };
444
445 static void printRegister(raw_ostream &OS, const CodeGenRegister *Reg) {
446   OS << getQualifiedName(Reg->TheDef);
447 }
448
449 static void printSimpleValueType(raw_ostream &OS, MVT::SimpleValueType VT) {
450   OS << getEnumName(VT);
451 }
452
453 static void printSubRegIndex(raw_ostream &OS, const CodeGenSubRegIndex *Idx) {
454   OS << Idx->getQualifiedName();
455 }
456
457 //
458 // runMCDesc - Print out MC register descriptions.
459 //
460 void
461 RegisterInfoEmitter::runMCDesc(raw_ostream &OS, CodeGenTarget &Target,
462                                CodeGenRegBank &RegBank) {
463   EmitSourceFileHeader("MC Register Information", OS);
464
465   OS << "\n#ifdef GET_REGINFO_MC_DESC\n";
466   OS << "#undef GET_REGINFO_MC_DESC\n";
467
468   const std::vector<CodeGenRegister*> &Regs = RegBank.getRegisters();
469   std::map<const CodeGenRegister*, CodeGenRegister::Set> Overlaps;
470   RegBank.computeOverlaps(Overlaps);
471
472   // The lists of sub-registers, super-registers, and overlaps all go in the
473   // same array. That allows us to share suffixes.
474   typedef std::vector<const CodeGenRegister*> RegVec;
475   SmallVector<RegVec, 4> SubRegLists(Regs.size());
476   SmallVector<RegVec, 4> OverlapLists(Regs.size());
477   SequenceToOffsetTable<RegVec, CodeGenRegister::Less> RegSeqs;
478
479   // Precompute register lists for the SequenceToOffsetTable.
480   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
481     const CodeGenRegister *Reg = Regs[i];
482
483     // Compute the ordered sub-register list.
484     SetVector<const CodeGenRegister*> SR;
485     Reg->addSubRegsPreOrder(SR, RegBank);
486     RegVec &SubRegList = SubRegLists[i];
487     SubRegList.assign(SR.begin(), SR.end());
488     RegSeqs.add(SubRegList);
489
490     // Super-registers are already computed.
491     const RegVec &SuperRegList = Reg->getSuperRegs();
492     RegSeqs.add(SuperRegList);
493
494     // The list of overlaps doesn't need to have any particular order, except
495     // Reg itself must be the first element. Pick an ordering that has one of
496     // the other lists as a suffix.
497     RegVec &OverlapList = OverlapLists[i];
498     const RegVec &Suffix = SubRegList.size() > SuperRegList.size() ?
499                            SubRegList : SuperRegList;
500     CodeGenRegister::Set Omit(Suffix.begin(), Suffix.end());
501
502     // First element is Reg itself.
503     OverlapList.push_back(Reg);
504     Omit.insert(Reg);
505
506     // Any elements not in Suffix.
507     const CodeGenRegister::Set &OSet = Overlaps[Reg];
508     std::set_difference(OSet.begin(), OSet.end(),
509                         Omit.begin(), Omit.end(),
510                         std::back_inserter(OverlapList),
511                         CodeGenRegister::Less());
512
513     // Finally, Suffix itself.
514     OverlapList.insert(OverlapList.end(), Suffix.begin(), Suffix.end());
515     RegSeqs.add(OverlapList);
516   }
517
518   // Compute the final layout of the sequence table.
519   RegSeqs.layout();
520
521   OS << "namespace llvm {\n\n";
522
523   const std::string &TargetName = Target.getName();
524
525   // Emit the shared table of register lists.
526   OS << "extern const uint16_t " << TargetName << "RegLists[] = {\n";
527   RegSeqs.emit(OS, printRegister);
528   OS << "};\n\n";
529
530   OS << "extern const MCRegisterDesc " << TargetName
531      << "RegDesc[] = { // Descriptors\n";
532   OS << "  { \"NOREG\", 0, 0, 0 },\n";
533
534   // Emit the register descriptors now.
535   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
536     const CodeGenRegister *Reg = Regs[i];
537     OS << "  { \"" << Reg->getName() << "\", "
538        << RegSeqs.get(OverlapLists[i]) << ", "
539        << RegSeqs.get(SubRegLists[i]) << ", "
540        << RegSeqs.get(Reg->getSuperRegs()) << " },\n";
541   }
542   OS << "};\n\n";      // End of register descriptors...
543
544   ArrayRef<CodeGenRegisterClass*> RegisterClasses = RegBank.getRegClasses();
545
546   // Loop over all of the register classes... emitting each one.
547   OS << "namespace {     // Register classes...\n";
548
549   // Emit the register enum value arrays for each RegisterClass
550   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
551     const CodeGenRegisterClass &RC = *RegisterClasses[rc];
552     ArrayRef<Record*> Order = RC.getOrder();
553
554     // Give the register class a legal C name if it's anonymous.
555     std::string Name = RC.getName();
556
557     // Emit the register list now.
558     OS << "  // " << Name << " Register Class...\n"
559        << "  const uint16_t " << Name
560        << "[] = {\n    ";
561     for (unsigned i = 0, e = Order.size(); i != e; ++i) {
562       Record *Reg = Order[i];
563       OS << getQualifiedName(Reg) << ", ";
564     }
565     OS << "\n  };\n\n";
566
567     OS << "  // " << Name << " Bit set.\n"
568        << "  const uint8_t " << Name
569        << "Bits[] = {\n    ";
570     BitVectorEmitter BVE;
571     for (unsigned i = 0, e = Order.size(); i != e; ++i) {
572       Record *Reg = Order[i];
573       BVE.add(Target.getRegBank().getReg(Reg)->EnumValue);
574     }
575     BVE.print(OS);
576     OS << "\n  };\n\n";
577
578   }
579   OS << "}\n\n";
580
581   OS << "extern const MCRegisterClass " << TargetName
582      << "MCRegisterClasses[] = {\n";
583
584   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
585     const CodeGenRegisterClass &RC = *RegisterClasses[rc];
586
587     // Asserts to make sure values will fit in table assuming types from
588     // MCRegisterInfo.h
589     assert((RC.SpillSize/8) <= 0xffff && "SpillSize too large.");
590     assert((RC.SpillAlignment/8) <= 0xffff && "SpillAlignment too large.");
591     assert(RC.CopyCost >= -128 && RC.CopyCost <= 127 && "Copy cost too large.");
592
593     OS << "  { " << '\"' << RC.getName() << "\", "
594        << RC.getName() << ", " << RC.getName() << "Bits, "
595        << RC.getOrder().size() << ", sizeof(" << RC.getName() << "Bits), "
596        << RC.getQualifiedName() + "RegClassID" << ", "
597        << RC.SpillSize/8 << ", "
598        << RC.SpillAlignment/8 << ", "
599        << RC.CopyCost << ", "
600        << RC.Allocatable << " },\n";
601   }
602
603   OS << "};\n\n";
604
605   // Emit the data table for getSubReg().
606   ArrayRef<CodeGenSubRegIndex*> SubRegIndices = RegBank.getSubRegIndices();
607   if (SubRegIndices.size()) {
608     OS << "const uint16_t " << TargetName << "SubRegTable[]["
609        << SubRegIndices.size() << "] = {\n";
610     for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
611       const CodeGenRegister::SubRegMap &SRM = Regs[i]->getSubRegs();
612       OS << "  /* " << Regs[i]->TheDef->getName() << " */\n";
613       if (SRM.empty()) {
614         OS << "  {0},\n";
615         continue;
616       }
617       OS << "  {";
618       for (unsigned j = 0, je = SubRegIndices.size(); j != je; ++j) {
619         // FIXME: We really should keep this to 80 columns...
620         CodeGenRegister::SubRegMap::const_iterator SubReg =
621           SRM.find(SubRegIndices[j]);
622         if (SubReg != SRM.end())
623           OS << getQualifiedName(SubReg->second->TheDef);
624         else
625           OS << "0";
626         if (j != je - 1)
627           OS << ", ";
628       }
629       OS << "}" << (i != e ? "," : "") << "\n";
630     }
631     OS << "};\n\n";
632     OS << "const uint16_t *get" << TargetName
633        << "SubRegTable() {\n  return (const uint16_t *)" << TargetName
634        << "SubRegTable;\n}\n\n";
635   }
636
637   EmitRegMappingTables(OS, Regs, false);
638
639   // Emit Reg encoding table
640   OS << "extern const uint16_t " << TargetName;
641   OS << "RegEncodingTable[] = {\n";
642   // Add entry for NoRegister
643   OS << "  0,\n";
644   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
645     Record *Reg = Regs[i]->TheDef;
646     BitsInit *BI = Reg->getValueAsBitsInit("HWEncoding");
647     uint64_t Value = 0;
648     for (unsigned b = 0, be = BI->getNumBits(); b != be; ++b) {
649       if (BitInit *B = dynamic_cast<BitInit*>(BI->getBit(b)))
650       Value |= (uint64_t)B->getValue() << b;
651     }
652     OS << "  " << Value << ",\n";
653   }
654   OS << "};\n";       // End of HW encoding table
655
656   // MCRegisterInfo initialization routine.
657   OS << "static inline void Init" << TargetName
658      << "MCRegisterInfo(MCRegisterInfo *RI, unsigned RA, "
659      << "unsigned DwarfFlavour = 0, unsigned EHFlavour = 0) {\n";
660   OS << "  RI->InitMCRegisterInfo(" << TargetName << "RegDesc, "
661      << Regs.size()+1 << ", RA, " << TargetName << "MCRegisterClasses, "
662      << RegisterClasses.size() << ", " << TargetName << "RegLists, ";
663   if (SubRegIndices.size() != 0)
664     OS << "(uint16_t*)" << TargetName << "SubRegTable, "
665        << SubRegIndices.size() << ",\n";
666   else
667     OS << "NULL, 0,\n";
668
669   OS << "  " << TargetName << "RegEncodingTable);\n\n";
670
671   EmitRegMapping(OS, Regs, false);
672
673   OS << "}\n\n";
674
675   OS << "} // End llvm namespace \n";
676   OS << "#endif // GET_REGINFO_MC_DESC\n\n";
677 }
678
679 void
680 RegisterInfoEmitter::runTargetHeader(raw_ostream &OS, CodeGenTarget &Target,
681                                      CodeGenRegBank &RegBank) {
682   EmitSourceFileHeader("Register Information Header Fragment", OS);
683
684   OS << "\n#ifdef GET_REGINFO_HEADER\n";
685   OS << "#undef GET_REGINFO_HEADER\n";
686
687   const std::string &TargetName = Target.getName();
688   std::string ClassName = TargetName + "GenRegisterInfo";
689
690   OS << "#include \"llvm/Target/TargetRegisterInfo.h\"\n\n";
691
692   OS << "namespace llvm {\n\n";
693
694   OS << "struct " << ClassName << " : public TargetRegisterInfo {\n"
695      << "  explicit " << ClassName
696      << "(unsigned RA, unsigned D = 0, unsigned E = 0);\n"
697      << "  virtual bool needsStackRealignment(const MachineFunction &) const\n"
698      << "     { return false; }\n";
699   if (!RegBank.getSubRegIndices().empty()) {
700     OS << "  unsigned composeSubRegIndices(unsigned, unsigned) const;\n"
701       << "  const TargetRegisterClass *"
702       "getSubClassWithSubReg(const TargetRegisterClass*, unsigned) const;\n";
703   }
704   OS << "  const RegClassWeight &getRegClassWeight("
705      << "const TargetRegisterClass *RC) const;\n"
706      << "  unsigned getNumRegPressureSets() const;\n"
707      << "  const char *getRegPressureSetName(unsigned Idx) const;\n"
708      << "  unsigned getRegPressureSetLimit(unsigned Idx) const;\n"
709      << "  const int *getRegClassPressureSets("
710      << "const TargetRegisterClass *RC) const;\n"
711      << "};\n\n";
712
713   ArrayRef<CodeGenRegisterClass*> RegisterClasses = RegBank.getRegClasses();
714
715   if (!RegisterClasses.empty()) {
716     OS << "namespace " << RegisterClasses[0]->Namespace
717        << " { // Register classes\n";
718
719     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
720       const CodeGenRegisterClass &RC = *RegisterClasses[i];
721       const std::string &Name = RC.getName();
722
723       // Output the extern for the instance.
724       OS << "  extern const TargetRegisterClass " << Name << "RegClass;\n";
725     }
726     OS << "} // end of namespace " << TargetName << "\n\n";
727   }
728   OS << "} // End llvm namespace \n";
729   OS << "#endif // GET_REGINFO_HEADER\n\n";
730 }
731
732 //
733 // runTargetDesc - Output the target register and register file descriptions.
734 //
735 void
736 RegisterInfoEmitter::runTargetDesc(raw_ostream &OS, CodeGenTarget &Target,
737                                    CodeGenRegBank &RegBank){
738   EmitSourceFileHeader("Target Register and Register Classes Information", OS);
739
740   OS << "\n#ifdef GET_REGINFO_TARGET_DESC\n";
741   OS << "#undef GET_REGINFO_TARGET_DESC\n";
742
743   OS << "namespace llvm {\n\n";
744
745   // Get access to MCRegisterClass data.
746   OS << "extern const MCRegisterClass " << Target.getName()
747      << "MCRegisterClasses[];\n";
748
749   // Start out by emitting each of the register classes.
750   ArrayRef<CodeGenRegisterClass*> RegisterClasses = RegBank.getRegClasses();
751   ArrayRef<CodeGenSubRegIndex*> SubRegIndices = RegBank.getSubRegIndices();
752
753   // Collect all registers belonging to any allocatable class.
754   std::set<Record*> AllocatableRegs;
755
756   // Collect allocatable registers.
757   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
758     const CodeGenRegisterClass &RC = *RegisterClasses[rc];
759     ArrayRef<Record*> Order = RC.getOrder();
760
761     if (RC.Allocatable)
762       AllocatableRegs.insert(Order.begin(), Order.end());
763   }
764
765   // Build a shared array of value types.
766   SequenceToOffsetTable<std::vector<MVT::SimpleValueType> > VTSeqs;
767   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc)
768     VTSeqs.add(RegisterClasses[rc]->VTs);
769   VTSeqs.layout();
770   OS << "\nstatic const MVT::SimpleValueType VTLists[] = {\n";
771   VTSeqs.emit(OS, printSimpleValueType, "MVT::Other");
772   OS << "};\n";
773
774   // Emit SubRegIndex names, skipping 0
775   OS << "\nstatic const char *const SubRegIndexTable[] = { \"";
776   for (unsigned i = 0, e = SubRegIndices.size(); i != e; ++i) {
777     OS << SubRegIndices[i]->getName();
778     if (i+1 != e)
779       OS << "\", \"";
780   }
781   OS << "\" };\n\n";
782
783   // Emit names of the anonymous subreg indices.
784   unsigned NamedIndices = RegBank.getNumNamedIndices();
785   if (SubRegIndices.size() > NamedIndices) {
786     OS << "  enum {";
787     for (unsigned i = NamedIndices, e = SubRegIndices.size(); i != e; ++i) {
788       OS << "\n    " << SubRegIndices[i]->getName() << " = " << i+1;
789       if (i+1 != e)
790         OS << ',';
791     }
792     OS << "\n  };\n\n";
793   }
794   OS << "\n";
795
796   // Now that all of the structs have been emitted, emit the instances.
797   if (!RegisterClasses.empty()) {
798     OS << "\nstatic const TargetRegisterClass *const "
799        << "NullRegClasses[] = { NULL };\n\n";
800
801     // Emit register class bit mask tables. The first bit mask emitted for a
802     // register class, RC, is the set of sub-classes, including RC itself.
803     //
804     // If RC has super-registers, also create a list of subreg indices and bit
805     // masks, (Idx, Mask). The bit mask has a bit for every superreg regclass,
806     // SuperRC, that satisfies:
807     //
808     //   For all SuperReg in SuperRC: SuperReg:Idx in RC
809     //
810     // The 0-terminated list of subreg indices starts at:
811     //
812     //   RC->getSuperRegIndices() = SuperRegIdxSeqs + ...
813     //
814     // The corresponding bitmasks follow the sub-class mask in memory. Each
815     // mask has RCMaskWords uint32_t entries.
816     //
817     // Every bit mask present in the list has at least one bit set.
818
819     // Compress the sub-reg index lists.
820     typedef std::vector<const CodeGenSubRegIndex*> IdxList;
821     SmallVector<IdxList, 8> SuperRegIdxLists(RegisterClasses.size());
822     SequenceToOffsetTable<IdxList> SuperRegIdxSeqs;
823     BitVector MaskBV(RegisterClasses.size());
824
825     for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
826       const CodeGenRegisterClass &RC = *RegisterClasses[rc];
827       OS << "static const uint32_t " << RC.getName() << "SubClassMask[] = {\n  ";
828       printBitVectorAsHex(OS, RC.getSubClasses(), 32);
829
830       // Emit super-reg class masks for any relevant SubRegIndices that can
831       // project into RC.
832       IdxList &SRIList = SuperRegIdxLists[rc];
833       for (unsigned sri = 0, sre = SubRegIndices.size(); sri != sre; ++sri) {
834         CodeGenSubRegIndex *Idx = SubRegIndices[sri];
835         MaskBV.reset();
836         RC.getSuperRegClasses(Idx, MaskBV);
837         if (MaskBV.none())
838           continue;
839         SRIList.push_back(Idx);
840         OS << "\n  ";
841         printBitVectorAsHex(OS, MaskBV, 32);
842         OS << "// " << Idx->getName();
843       }
844       SuperRegIdxSeqs.add(SRIList);
845       OS << "\n};\n\n";
846     }
847
848     OS << "static const uint16_t SuperRegIdxSeqs[] = {\n";
849     SuperRegIdxSeqs.layout();
850     SuperRegIdxSeqs.emit(OS, printSubRegIndex);
851     OS << "};\n\n";
852
853     // Emit NULL terminated super-class lists.
854     for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
855       const CodeGenRegisterClass &RC = *RegisterClasses[rc];
856       ArrayRef<CodeGenRegisterClass*> Supers = RC.getSuperClasses();
857
858       // Skip classes without supers.  We can reuse NullRegClasses.
859       if (Supers.empty())
860         continue;
861
862       OS << "static const TargetRegisterClass *const "
863          << RC.getName() << "Superclasses[] = {\n";
864       for (unsigned i = 0; i != Supers.size(); ++i)
865         OS << "  &" << Supers[i]->getQualifiedName() << "RegClass,\n";
866       OS << "  NULL\n};\n\n";
867     }
868
869     // Emit methods.
870     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
871       const CodeGenRegisterClass &RC = *RegisterClasses[i];
872       if (!RC.AltOrderSelect.empty()) {
873         OS << "\nstatic inline unsigned " << RC.getName()
874            << "AltOrderSelect(const MachineFunction &MF) {"
875            << RC.AltOrderSelect << "}\n\n"
876            << "static ArrayRef<uint16_t> " << RC.getName()
877            << "GetRawAllocationOrder(const MachineFunction &MF) {\n";
878         for (unsigned oi = 1 , oe = RC.getNumOrders(); oi != oe; ++oi) {
879           ArrayRef<Record*> Elems = RC.getOrder(oi);
880           if (!Elems.empty()) {
881             OS << "  static const uint16_t AltOrder" << oi << "[] = {";
882             for (unsigned elem = 0; elem != Elems.size(); ++elem)
883               OS << (elem ? ", " : " ") << getQualifiedName(Elems[elem]);
884             OS << " };\n";
885           }
886         }
887         OS << "  const MCRegisterClass &MCR = " << Target.getName()
888            << "MCRegisterClasses[" << RC.getQualifiedName() + "RegClassID];\n"
889            << "  const ArrayRef<uint16_t> Order[] = {\n"
890            << "    makeArrayRef(MCR.begin(), MCR.getNumRegs()";
891         for (unsigned oi = 1, oe = RC.getNumOrders(); oi != oe; ++oi)
892           if (RC.getOrder(oi).empty())
893             OS << "),\n    ArrayRef<uint16_t>(";
894           else
895             OS << "),\n    makeArrayRef(AltOrder" << oi;
896         OS << ")\n  };\n  const unsigned Select = " << RC.getName()
897            << "AltOrderSelect(MF);\n  assert(Select < " << RC.getNumOrders()
898            << ");\n  return Order[Select];\n}\n";
899         }
900     }
901
902     // Now emit the actual value-initialized register class instances.
903     OS << "namespace " << RegisterClasses[0]->Namespace
904        << " {   // Register class instances\n";
905
906     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
907       const CodeGenRegisterClass &RC = *RegisterClasses[i];
908       OS << "  extern const TargetRegisterClass "
909          << RegisterClasses[i]->getName() << "RegClass = {\n    "
910          << '&' << Target.getName() << "MCRegisterClasses[" << RC.getName()
911          << "RegClassID],\n    "
912          << "VTLists + " << VTSeqs.get(RC.VTs) << ",\n    "
913          << RC.getName() << "SubClassMask,\n    SuperRegIdxSeqs + "
914          << SuperRegIdxSeqs.get(SuperRegIdxLists[i]) << ",\n    ";
915       if (RC.getSuperClasses().empty())
916         OS << "NullRegClasses,\n    ";
917       else
918         OS << RC.getName() << "Superclasses,\n    ";
919       if (RC.AltOrderSelect.empty())
920         OS << "0\n";
921       else
922         OS << RC.getName() << "GetRawAllocationOrder\n";
923       OS << "  };\n\n";
924     }
925
926     OS << "}\n";
927   }
928
929   OS << "\nnamespace {\n";
930   OS << "  const TargetRegisterClass* const RegisterClasses[] = {\n";
931   for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i)
932     OS << "    &" << RegisterClasses[i]->getQualifiedName()
933        << "RegClass,\n";
934   OS << "  };\n";
935   OS << "}\n";       // End of anonymous namespace...
936
937   // Emit extra information about registers.
938   const std::string &TargetName = Target.getName();
939   OS << "\nstatic const TargetRegisterInfoDesc "
940      << TargetName << "RegInfoDesc[] = { // Extra Descriptors\n";
941   OS << "  { 0, 0 },\n";
942
943   const std::vector<CodeGenRegister*> &Regs = RegBank.getRegisters();
944   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
945     const CodeGenRegister &Reg = *Regs[i];
946     OS << "  { ";
947     OS << Reg.CostPerUse << ", "
948        << int(AllocatableRegs.count(Reg.TheDef)) << " },\n";
949   }
950   OS << "};\n";      // End of register descriptors...
951
952
953   std::string ClassName = Target.getName() + "GenRegisterInfo";
954
955   // Emit composeSubRegIndices
956   if (!SubRegIndices.empty()) {
957     OS << "unsigned " << ClassName
958       << "::composeSubRegIndices(unsigned IdxA, unsigned IdxB) const {\n"
959       << "  switch (IdxA) {\n"
960       << "  default:\n    return IdxB;\n";
961     for (unsigned i = 0, e = SubRegIndices.size(); i != e; ++i) {
962       bool Open = false;
963       for (unsigned j = 0; j != e; ++j) {
964         if (CodeGenSubRegIndex *Comp =
965             SubRegIndices[i]->compose(SubRegIndices[j])) {
966           if (!Open) {
967             OS << "  case " << SubRegIndices[i]->getQualifiedName()
968               << ": switch(IdxB) {\n    default: return IdxB;\n";
969             Open = true;
970           }
971           OS << "    case " << SubRegIndices[j]->getQualifiedName()
972             << ": return " << Comp->getQualifiedName() << ";\n";
973         }
974       }
975       if (Open)
976         OS << "    }\n";
977     }
978     OS << "  }\n}\n\n";
979   }
980
981   // Emit getSubClassWithSubReg.
982   if (!SubRegIndices.empty()) {
983     OS << "const TargetRegisterClass *" << ClassName
984        << "::getSubClassWithSubReg(const TargetRegisterClass *RC, unsigned Idx)"
985        << " const {\n";
986     // Use the smallest type that can hold a regclass ID with room for a
987     // sentinel.
988     if (RegisterClasses.size() < UINT8_MAX)
989       OS << "  static const uint8_t Table[";
990     else if (RegisterClasses.size() < UINT16_MAX)
991       OS << "  static const uint16_t Table[";
992     else
993       throw "Too many register classes.";
994     OS << RegisterClasses.size() << "][" << SubRegIndices.size() << "] = {\n";
995     for (unsigned rci = 0, rce = RegisterClasses.size(); rci != rce; ++rci) {
996       const CodeGenRegisterClass &RC = *RegisterClasses[rci];
997       OS << "    {\t// " << RC.getName() << "\n";
998       for (unsigned sri = 0, sre = SubRegIndices.size(); sri != sre; ++sri) {
999         CodeGenSubRegIndex *Idx = SubRegIndices[sri];
1000         if (CodeGenRegisterClass *SRC = RC.getSubClassWithSubReg(Idx))
1001           OS << "      " << SRC->EnumValue + 1 << ",\t// " << Idx->getName()
1002              << " -> " << SRC->getName() << "\n";
1003         else
1004           OS << "      0,\t// " << Idx->getName() << "\n";
1005       }
1006       OS << "    },\n";
1007     }
1008     OS << "  };\n  assert(RC && \"Missing regclass\");\n"
1009        << "  if (!Idx) return RC;\n  --Idx;\n"
1010        << "  assert(Idx < " << SubRegIndices.size() << " && \"Bad subreg\");\n"
1011        << "  unsigned TV = Table[RC->getID()][Idx];\n"
1012        << "  return TV ? getRegClass(TV - 1) : 0;\n}\n\n";
1013   }
1014
1015   EmitRegUnitPressure(OS, RegBank, ClassName);
1016
1017   // Emit the constructor of the class...
1018   OS << "extern const MCRegisterDesc " << TargetName << "RegDesc[];\n";
1019   OS << "extern const uint16_t " << TargetName << "RegLists[];\n";
1020   if (SubRegIndices.size() != 0)
1021     OS << "extern const uint16_t *get" << TargetName
1022        << "SubRegTable();\n";
1023   OS << "extern const uint16_t " << TargetName << "RegEncodingTable[];\n";
1024
1025   EmitRegMappingTables(OS, Regs, true);
1026
1027   OS << ClassName << "::\n" << ClassName
1028      << "(unsigned RA, unsigned DwarfFlavour, unsigned EHFlavour)\n"
1029      << "  : TargetRegisterInfo(" << TargetName << "RegInfoDesc"
1030      << ", RegisterClasses, RegisterClasses+" << RegisterClasses.size() <<",\n"
1031      << "             SubRegIndexTable) {\n"
1032      << "  InitMCRegisterInfo(" << TargetName << "RegDesc, "
1033      << Regs.size()+1 << ", RA,\n                     " << TargetName
1034      << "MCRegisterClasses, " << RegisterClasses.size() << ",\n"
1035      << "                     " << TargetName << "RegLists,\n"
1036      << "                     ";
1037   if (SubRegIndices.size() != 0)
1038     OS << "get" << TargetName << "SubRegTable(), "
1039        << SubRegIndices.size() << ",\n";
1040   else
1041     OS << "NULL, 0,\n";
1042
1043   OS << "                     " << TargetName << "RegEncodingTable);\n\n";
1044
1045   EmitRegMapping(OS, Regs, true);
1046
1047   OS << "}\n\n";
1048
1049
1050   // Emit CalleeSavedRegs information.
1051   std::vector<Record*> CSRSets =
1052     Records.getAllDerivedDefinitions("CalleeSavedRegs");
1053   for (unsigned i = 0, e = CSRSets.size(); i != e; ++i) {
1054     Record *CSRSet = CSRSets[i];
1055     const SetTheory::RecVec *Regs = RegBank.getSets().expand(CSRSet);
1056     assert(Regs && "Cannot expand CalleeSavedRegs instance");
1057
1058     // Emit the *_SaveList list of callee-saved registers.
1059     OS << "static const uint16_t " << CSRSet->getName()
1060        << "_SaveList[] = { ";
1061     for (unsigned r = 0, re = Regs->size(); r != re; ++r)
1062       OS << getQualifiedName((*Regs)[r]) << ", ";
1063     OS << "0 };\n";
1064
1065     // Emit the *_RegMask bit mask of call-preserved registers.
1066     OS << "static const uint32_t " << CSRSet->getName()
1067        << "_RegMask[] = { ";
1068     printBitVectorAsHex(OS, RegBank.computeCoveredRegisters(*Regs), 32);
1069     OS << "};\n";
1070   }
1071   OS << "\n\n";
1072
1073   OS << "} // End llvm namespace \n";
1074   OS << "#endif // GET_REGINFO_TARGET_DESC\n\n";
1075 }
1076
1077 void RegisterInfoEmitter::run(raw_ostream &OS) {
1078   CodeGenTarget Target(Records);
1079   CodeGenRegBank &RegBank = Target.getRegBank();
1080   RegBank.computeDerivedInfo();
1081
1082   runEnums(OS, Target, RegBank);
1083   runMCDesc(OS, Target, RegBank);
1084   runTargetHeader(OS, Target, RegBank);
1085   runTargetDesc(OS, Target, RegBank);
1086 }