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 "CodeGenRegisters.h"
  17 #include "CodeGenTarget.h"
  18 #include "SequenceToOffsetTable.h"
  19 #include "llvm/ADT/BitVector.h"
  20 #include "llvm/ADT/STLExtras.h"
  21 #include "llvm/ADT/StringExtras.h"
  22 #include "llvm/ADT/Twine.h"
  23 #include "llvm/Support/Format.h"
  24 #include "llvm/TableGen/Error.h"
  25 #include "llvm/TableGen/Record.h"
  26 #include "llvm/TableGen/TableGenBackend.h"
  27 #include <algorithm>
  28 #include <set>
  29 #include <vector>
  30 using namespace llvm;
  31
  32 namespace {
  33 class RegisterInfoEmitter {
  34   RecordKeeper &Records;
  35 public:
  36   RegisterInfoEmitter(RecordKeeper &R) : Records(R) {}
  37
  38   // runEnums - Print out enum values for all of the registers.
  39   void runEnums(raw_ostream &o, CodeGenTarget &Target, CodeGenRegBank &Bank);
  40
  41   // runMCDesc - Print out MC register descriptions.
  42   void runMCDesc(raw_ostream &o, CodeGenTarget &Target, CodeGenRegBank &Bank);
  43
  44   // runTargetHeader - Emit a header fragment for the register info emitter.
  45   void runTargetHeader(raw_ostream &o, CodeGenTarget &Target,
  46                        CodeGenRegBank &Bank);
  47
  48   // runTargetDesc - Output the target register and register file descriptions.
  49   void runTargetDesc(raw_ostream &o, CodeGenTarget &Target,
  50                      CodeGenRegBank &Bank);
  51
  52   // run - Output the register file description.
  53   void run(raw_ostream &o);
  54
  55 private:
  56   void EmitRegMapping(raw_ostream &o,
  57                       const std::vector<CodeGenRegister*> &Regs, bool isCtor);
  58   void EmitRegMappingTables(raw_ostream &o,
  59                             const std::vector<CodeGenRegister*> &Regs,
  60                             bool isCtor);
  61   void EmitRegUnitPressure(raw_ostream &OS, const CodeGenRegBank &RegBank,
  62                            const std::string &ClassName);
  63   void emitComposeSubRegIndices(raw_ostream &OS, CodeGenRegBank &RegBank,
  64                                 const std::string &ClassName);
  65 };
  66 } // End anonymous namespace
  67
  68 // runEnums - Print out enum values for all of the registers.
  69 void RegisterInfoEmitter::runEnums(raw_ostream &OS,
  70                                    CodeGenTarget &Target, CodeGenRegBank &Bank) {
  71   const std::vector<CodeGenRegister*> &Registers = Bank.getRegisters();
  72
  73   // Register enums are stored as uint16_t in the tables. Make sure we'll fit.
  74   assert(Registers.size() <= 0xffff && "Too many regs to fit in tables");
  75
  76   std::string Namespace = Registers[0]->TheDef->getValueAsString("Namespace");
  77
  78   emitSourceFileHeader("Target Register Enum Values", OS);
  79
  80   OS << "\n#ifdef GET_REGINFO_ENUM\n";
  81   OS << "#undef GET_REGINFO_ENUM\n";
  82
  83   OS << "namespace llvm {\n\n";
  84
  85   OS << "class MCRegisterClass;\n"
  86      << "extern const MCRegisterClass " << Namespace
  87      << "MCRegisterClasses[];\n\n";
  88
  89   if (!Namespace.empty())
  90     OS << "namespace " << Namespace << " {\n";
  91   OS << "enum {\n  NoRegister,\n";
  92
  93   for (unsigned i = 0, e = Registers.size(); i != e; ++i)
  94     OS << "  " << Registers[i]->getName() << " = " <<
  95       Registers[i]->EnumValue << ",\n";
  96   assert(Registers.size() == Registers[Registers.size()-1]->EnumValue &&
  97          "Register enum value mismatch!");
  98   OS << "  NUM_TARGET_REGS \t// " << Registers.size()+1 << "\n";
  99   OS << "};\n";
 100   if (!Namespace.empty())
 101     OS << "}\n";
 102
 103   ArrayRef<CodeGenRegisterClass*> RegisterClasses = Bank.getRegClasses();
 104   if (!RegisterClasses.empty()) {
 105
 106     // RegisterClass enums are stored as uint16_t in the tables.
 107     assert(RegisterClasses.size() <= 0xffff &&
 108            "Too many register classes to fit in tables");
 109
 110     OS << "\n// Register classes\n";
 111     if (!Namespace.empty())
 112       OS << "namespace " << Namespace << " {\n";
 113     OS << "enum {\n";
 114     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
 115       if (i) OS << ",\n";
 116       OS << "  " << RegisterClasses[i]->getName() << "RegClassID";
 117       OS << " = " << i;
 118     }
 119     OS << "\n  };\n";
 120     if (!Namespace.empty())
 121       OS << "}\n";
 122   }
 123
 124   const std::vector<Record*> &RegAltNameIndices = Target.getRegAltNameIndices();
 125   // If the only definition is the default NoRegAltName, we don't need to
 126   // emit anything.
 127   if (RegAltNameIndices.size() > 1) {
 128     OS << "\n// Register alternate name indices\n";
 129     if (!Namespace.empty())
 130       OS << "namespace " << Namespace << " {\n";
 131     OS << "enum {\n";
 132     for (unsigned i = 0, e = RegAltNameIndices.size(); i != e; ++i)
 133       OS << "  " << RegAltNameIndices[i]->getName() << ",\t// " << i << "\n";
 134     OS << "  NUM_TARGET_REG_ALT_NAMES = " << RegAltNameIndices.size() << "\n";
 135     OS << "};\n";
 136     if (!Namespace.empty())
 137       OS << "}\n";
 138   }
 139
 140   auto &SubRegIndices = Bank.getSubRegIndices();
 141   if (!SubRegIndices.empty()) {
 142     OS << "\n// Subregister indices\n";
 143     std::string Namespace = SubRegIndices.front()->getNamespace();
 144     if (!Namespace.empty())
 145       OS << "namespace " << Namespace << " {\n";
 146     OS << "enum {\n  NoSubRegister,\n";
 147     unsigned i = 0;
 148     for (const auto &Idx : SubRegIndices)
 149       OS << "  " << Idx->getName() << ",\t// " << ++i << "\n";
 150     OS << "  NUM_TARGET_SUBREGS\n};\n";
 151     if (!Namespace.empty())
 152       OS << "}\n";
 153   }
 154
 155   OS << "} // End llvm namespace\n";
 156   OS << "#endif // GET_REGINFO_ENUM\n\n";
 157 }
 158
 159 static void printInt(raw_ostream &OS, int Val) {
 160   OS << Val;
 161 }
 162
 163 static const char *getMinimalTypeForRange(uint64_t Range) {
 164   assert(Range < 0xFFFFFFFFULL && "Enum too large");
 165   if (Range > 0xFFFF)
 166     return "uint32_t";
 167   if (Range > 0xFF)
 168     return "uint16_t";
 169   return "uint8_t";
 170 }
 171
 172 void RegisterInfoEmitter::
 173 EmitRegUnitPressure(raw_ostream &OS, const CodeGenRegBank &RegBank,
 174                     const std::string &ClassName) {
 175   unsigned NumRCs = RegBank.getRegClasses().size();
 176   unsigned NumSets = RegBank.getNumRegPressureSets();
 177
 178   OS << "/// Get the weight in units of pressure for this register class.\n"
 179      << "const RegClassWeight &" << ClassName << "::\n"
 180      << "getRegClassWeight(const TargetRegisterClass *RC) const {\n"
 181      << "  static const RegClassWeight RCWeightTable[] = {\n";
 182   for (unsigned i = 0, e = NumRCs; i != e; ++i) {
 183     const CodeGenRegisterClass &RC = *RegBank.getRegClasses()[i];
 184     const CodeGenRegister::Set &Regs = RC.getMembers();
 185     if (Regs.empty())
 186       OS << "    {0, 0";
 187     else {
 188       std::vector<unsigned> RegUnits;
 189       RC.buildRegUnitSet(RegUnits);
 190       OS << "    {" << (*Regs.begin())->getWeight(RegBank)
 191          << ", " << RegBank.getRegUnitSetWeight(RegUnits);
 192     }
 193     OS << "},  \t// " << RC.getName() << "\n";
 194   }
 195   OS << "  };\n"
 196      << "  return RCWeightTable[RC->getID()];\n"
 197      << "}\n\n";
 198
 199   // Reasonable targets (not ARMv7) have unit weight for all units, so don't
 200   // bother generating a table.
 201   bool RegUnitsHaveUnitWeight = true;
 202   for (unsigned UnitIdx = 0, UnitEnd = RegBank.getNumNativeRegUnits();
 203        UnitIdx < UnitEnd; ++UnitIdx) {
 204     if (RegBank.getRegUnit(UnitIdx).Weight > 1)
 205       RegUnitsHaveUnitWeight = false;
 206   }
 207   OS << "/// Get the weight in units of pressure for this register unit.\n"
 208      << "unsigned " << ClassName << "::\n"
 209      << "getRegUnitWeight(unsigned RegUnit) const {\n"
 210      << "  assert(RegUnit < " << RegBank.getNumNativeRegUnits()
 211      << " && \"invalid register unit\");\n";
 212   if (!RegUnitsHaveUnitWeight) {
 213     OS << "  static const uint8_t RUWeightTable[] = {\n    ";
 214     for (unsigned UnitIdx = 0, UnitEnd = RegBank.getNumNativeRegUnits();
 215          UnitIdx < UnitEnd; ++UnitIdx) {
 216       const RegUnit &RU = RegBank.getRegUnit(UnitIdx);
 217       assert(RU.Weight < 256 && "RegUnit too heavy");
 218       OS << RU.Weight << ", ";
 219     }
 220     OS << "};\n"
 221        << "  return RUWeightTable[RegUnit];\n";
 222   }
 223   else {
 224     OS << "  // All register units have unit weight.\n"
 225        << "  return 1;\n";
 226   }
 227   OS << "}\n\n";
 228
 229   OS << "\n"
 230      << "// Get the number of dimensions of register pressure.\n"
 231      << "unsigned " << ClassName << "::getNumRegPressureSets() const {\n"
 232      << "  return " << NumSets << ";\n}\n\n";
 233
 234   OS << "// Get the name of this register unit pressure set.\n"
 235      << "const char *" << ClassName << "::\n"
 236      << "getRegPressureSetName(unsigned Idx) const {\n"
 237      << "  static const char *PressureNameTable[] = {\n";
 238   unsigned MaxRegUnitWeight = 0;
 239   for (unsigned i = 0; i < NumSets; ++i ) {
 240     const RegUnitSet &RegUnits = RegBank.getRegSetAt(i);
 241     MaxRegUnitWeight = std::max(MaxRegUnitWeight, RegUnits.Weight);
 242     OS << "    \"" << RegUnits.Name << "\",\n";
 243   }
 244   OS << "    nullptr };\n"
 245      << "  return PressureNameTable[Idx];\n"
 246      << "}\n\n";
 247
 248   OS << "// Get the register unit pressure limit for this dimension.\n"
 249      << "// This limit must be adjusted dynamically for reserved registers.\n"
 250      << "unsigned " << ClassName << "::\n"
 251      << "getRegPressureSetLimit(unsigned Idx) const {\n"
 252      << "  static const " << getMinimalTypeForRange(MaxRegUnitWeight)
 253      << " PressureLimitTable[] = {\n";
 254   for (unsigned i = 0; i < NumSets; ++i ) {
 255     const RegUnitSet &RegUnits = RegBank.getRegSetAt(i);
 256     OS << "    " << RegUnits.Weight << ",  \t// " << i << ": "
 257        << RegUnits.Name << "\n";
 258   }
 259   OS << "  };\n"
 260      << "  return PressureLimitTable[Idx];\n"
 261      << "}\n\n";
 262
 263   SequenceToOffsetTable<std::vector<int>> PSetsSeqs;
 264
 265   // This table may be larger than NumRCs if some register units needed a list
 266   // of unit sets that did not correspond to a register class.
 267   unsigned NumRCUnitSets = RegBank.getNumRegClassPressureSetLists();
 268   std::vector<std::vector<int>> PSets(NumRCUnitSets);
 269
 270   for (unsigned i = 0, e = NumRCUnitSets; i != e; ++i) {
 271     ArrayRef<unsigned> PSetIDs = RegBank.getRCPressureSetIDs(i);
 272     PSets[i].reserve(PSetIDs.size());
 273     for (ArrayRef<unsigned>::iterator PSetI = PSetIDs.begin(),
 274            PSetE = PSetIDs.end(); PSetI != PSetE; ++PSetI) {
 275       PSets[i].push_back(RegBank.getRegPressureSet(*PSetI).Order);
 276     }
 277     std::sort(PSets[i].begin(), PSets[i].end());
 278     PSetsSeqs.add(PSets[i]);
 279   }
 280
 281   PSetsSeqs.layout();
 282
 283   OS << "/// Table of pressure sets per register class or unit.\n"
 284      << "static const int RCSetsTable[] = {\n";
 285   PSetsSeqs.emit(OS, printInt, "-1");
 286   OS << "};\n\n";
 287
 288   OS << "/// Get the dimensions of register pressure impacted by this "
 289      << "register class.\n"
 290      << "/// Returns a -1 terminated array of pressure set IDs\n"
 291      << "const int* " << ClassName << "::\n"
 292      << "getRegClassPressureSets(const TargetRegisterClass *RC) const {\n";
 293   OS << "  static const " << getMinimalTypeForRange(PSetsSeqs.size()-1)
 294      << " RCSetStartTable[] = {\n    ";
 295   for (unsigned i = 0, e = NumRCs; i != e; ++i) {
 296     OS << PSetsSeqs.get(PSets[i]) << ",";
 297   }
 298   OS << "};\n"
 299      << "  return &RCSetsTable[RCSetStartTable[RC->getID()]];\n"
 300      << "}\n\n";
 301
 302   OS << "/// Get the dimensions of register pressure impacted by this "
 303      << "register unit.\n"
 304      << "/// Returns a -1 terminated array of pressure set IDs\n"
 305      << "const int* " << ClassName << "::\n"
 306      << "getRegUnitPressureSets(unsigned RegUnit) const {\n"
 307      << "  assert(RegUnit < " << RegBank.getNumNativeRegUnits()
 308      << " && \"invalid register unit\");\n";
 309   OS << "  static const " << getMinimalTypeForRange(PSetsSeqs.size()-1)
 310      << " RUSetStartTable[] = {\n    ";
 311   for (unsigned UnitIdx = 0, UnitEnd = RegBank.getNumNativeRegUnits();
 312        UnitIdx < UnitEnd; ++UnitIdx) {
 313     OS << PSetsSeqs.get(PSets[RegBank.getRegUnit(UnitIdx).RegClassUnitSetsIdx])
 314        << ",";
 315   }
 316   OS << "};\n"
 317      << "  return &RCSetsTable[RUSetStartTable[RegUnit]];\n"
 318      << "}\n\n";
 319 }
 320
 321 void
 322 RegisterInfoEmitter::EmitRegMappingTables(raw_ostream &OS,
 323                                        const std::vector<CodeGenRegister*> &Regs,
 324                                           bool isCtor) {
 325   // Collect all information about dwarf register numbers
 326   typedef std::map<Record*, std::vector<int64_t>, LessRecordRegister> DwarfRegNumsMapTy;
 327   DwarfRegNumsMapTy DwarfRegNums;
 328
 329   // First, just pull all provided information to the map
 330   unsigned maxLength = 0;
 331   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 332     Record *Reg = Regs[i]->TheDef;
 333     std::vector<int64_t> RegNums = Reg->getValueAsListOfInts("DwarfNumbers");
 334     maxLength = std::max((size_t)maxLength, RegNums.size());
 335     if (DwarfRegNums.count(Reg))
 336       PrintWarning(Reg->getLoc(), Twine("DWARF numbers for register ") +
 337                    getQualifiedName(Reg) + "specified multiple times");
 338     DwarfRegNums[Reg] = RegNums;
 339   }
 340
 341   if (!maxLength)
 342     return;
 343
 344   // Now we know maximal length of number list. Append -1's, where needed
 345   for (DwarfRegNumsMapTy::iterator
 346        I = DwarfRegNums.begin(), E = DwarfRegNums.end(); I != E; ++I)
 347     for (unsigned i = I->second.size(), e = maxLength; i != e; ++i)
 348       I->second.push_back(-1);
 349
 350   std::string Namespace = Regs[0]->TheDef->getValueAsString("Namespace");
 351
 352   OS << "// " << Namespace << " Dwarf<->LLVM register mappings.\n";
 353
 354   // Emit reverse information about the dwarf register numbers.
 355   for (unsigned j = 0; j < 2; ++j) {
 356     for (unsigned i = 0, e = maxLength; i != e; ++i) {
 357       OS << "extern const MCRegisterInfo::DwarfLLVMRegPair " << Namespace;
 358       OS << (j == 0 ? "DwarfFlavour" : "EHFlavour");
 359       OS << i << "Dwarf2L[]";
 360
 361       if (!isCtor) {
 362         OS << " = {\n";
 363
 364         // Store the mapping sorted by the LLVM reg num so lookup can be done
 365         // with a binary search.
 366         std::map<uint64_t, Record*> Dwarf2LMap;
 367         for (DwarfRegNumsMapTy::iterator
 368                I = DwarfRegNums.begin(), E = DwarfRegNums.end(); I != E; ++I) {
 369           int DwarfRegNo = I->second[i];
 370           if (DwarfRegNo < 0)
 371             continue;
 372           Dwarf2LMap[DwarfRegNo] = I->first;
 373         }
 374
 375         for (std::map<uint64_t, Record*>::iterator
 376                I = Dwarf2LMap.begin(), E = Dwarf2LMap.end(); I != E; ++I)
 377           OS << "  { " << I->first << "U, " << getQualifiedName(I->second)
 378              << " },\n";
 379
 380         OS << "};\n";
 381       } else {
 382         OS << ";\n";
 383       }
 384
 385       // We have to store the size in a const global, it's used in multiple
 386       // places.
 387       OS << "extern const unsigned " << Namespace
 388          << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i << "Dwarf2LSize";
 389       if (!isCtor)
 390         OS << " = array_lengthof(" << Namespace
 391            << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i
 392            << "Dwarf2L);\n\n";
 393       else
 394         OS << ";\n\n";
 395     }
 396   }
 397
 398   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 399     Record *Reg = Regs[i]->TheDef;
 400     const RecordVal *V = Reg->getValue("DwarfAlias");
 401     if (!V || !V->getValue())
 402       continue;
 403
 404     DefInit *DI = cast<DefInit>(V->getValue());
 405     Record *Alias = DI->getDef();
 406     DwarfRegNums[Reg] = DwarfRegNums[Alias];
 407   }
 408
 409   // Emit information about the dwarf register numbers.
 410   for (unsigned j = 0; j < 2; ++j) {
 411     for (unsigned i = 0, e = maxLength; i != e; ++i) {
 412       OS << "extern const MCRegisterInfo::DwarfLLVMRegPair " << Namespace;
 413       OS << (j == 0 ? "DwarfFlavour" : "EHFlavour");
 414       OS << i << "L2Dwarf[]";
 415       if (!isCtor) {
 416         OS << " = {\n";
 417         // Store the mapping sorted by the Dwarf reg num so lookup can be done
 418         // with a binary search.
 419         for (DwarfRegNumsMapTy::iterator
 420                I = DwarfRegNums.begin(), E = DwarfRegNums.end(); I != E; ++I) {
 421           int RegNo = I->second[i];
 422           if (RegNo == -1) // -1 is the default value, don't emit a mapping.
 423             continue;
 424
 425           OS << "  { " << getQualifiedName(I->first) << ", " << RegNo
 426              << "U },\n";
 427         }
 428         OS << "};\n";
 429       } else {
 430         OS << ";\n";
 431       }
 432
 433       // We have to store the size in a const global, it's used in multiple
 434       // places.
 435       OS << "extern const unsigned " << Namespace
 436          << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i << "L2DwarfSize";
 437       if (!isCtor)
 438         OS << " = array_lengthof(" << Namespace
 439            << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i << "L2Dwarf);\n\n";
 440       else
 441         OS << ";\n\n";
 442     }
 443   }
 444 }
 445
 446 void
 447 RegisterInfoEmitter::EmitRegMapping(raw_ostream &OS,
 448                                     const std::vector<CodeGenRegister*> &Regs,
 449                                     bool isCtor) {
 450   // Emit the initializer so the tables from EmitRegMappingTables get wired up
 451   // to the MCRegisterInfo object.
 452   unsigned maxLength = 0;
 453   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 454     Record *Reg = Regs[i]->TheDef;
 455     maxLength = std::max((size_t)maxLength,
 456                          Reg->getValueAsListOfInts("DwarfNumbers").size());
 457   }
 458
 459   if (!maxLength)
 460     return;
 461
 462   std::string Namespace = Regs[0]->TheDef->getValueAsString("Namespace");
 463
 464   // Emit reverse information about the dwarf register numbers.
 465   for (unsigned j = 0; j < 2; ++j) {
 466     OS << "  switch (";
 467     if (j == 0)
 468       OS << "DwarfFlavour";
 469     else
 470       OS << "EHFlavour";
 471     OS << ") {\n"
 472      << "  default:\n"
 473      << "    llvm_unreachable(\"Unknown DWARF flavour\");\n";
 474
 475     for (unsigned i = 0, e = maxLength; i != e; ++i) {
 476       OS << "  case " << i << ":\n";
 477       OS << "    ";
 478       if (!isCtor)
 479         OS << "RI->";
 480       std::string Tmp;
 481       raw_string_ostream(Tmp) << Namespace
 482                               << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i
 483                               << "Dwarf2L";
 484       OS << "mapDwarfRegsToLLVMRegs(" << Tmp << ", " << Tmp << "Size, ";
 485       if (j == 0)
 486           OS << "false";
 487         else
 488           OS << "true";
 489       OS << ");\n";
 490       OS << "    break;\n";
 491     }
 492     OS << "  }\n";
 493   }
 494
 495   // Emit information about the dwarf register numbers.
 496   for (unsigned j = 0; j < 2; ++j) {
 497     OS << "  switch (";
 498     if (j == 0)
 499       OS << "DwarfFlavour";
 500     else
 501       OS << "EHFlavour";
 502     OS << ") {\n"
 503        << "  default:\n"
 504        << "    llvm_unreachable(\"Unknown DWARF flavour\");\n";
 505
 506     for (unsigned i = 0, e = maxLength; i != e; ++i) {
 507       OS << "  case " << i << ":\n";
 508       OS << "    ";
 509       if (!isCtor)
 510         OS << "RI->";
 511       std::string Tmp;
 512       raw_string_ostream(Tmp) << Namespace
 513                               << (j == 0 ? "DwarfFlavour" : "EHFlavour") << i
 514                               << "L2Dwarf";
 515       OS << "mapLLVMRegsToDwarfRegs(" << Tmp << ", " << Tmp << "Size, ";
 516       if (j == 0)
 517           OS << "false";
 518         else
 519           OS << "true";
 520       OS << ");\n";
 521       OS << "    break;\n";
 522     }
 523     OS << "  }\n";
 524   }
 525 }
 526
 527 // Print a BitVector as a sequence of hex numbers using a little-endian mapping.
 528 // Width is the number of bits per hex number.
 529 static void printBitVectorAsHex(raw_ostream &OS,
 530                                 const BitVector &Bits,
 531                                 unsigned Width) {
 532   assert(Width <= 32 && "Width too large");
 533   unsigned Digits = (Width + 3) / 4;
 534   for (unsigned i = 0, e = Bits.size(); i < e; i += Width) {
 535     unsigned Value = 0;
 536     for (unsigned j = 0; j != Width && i + j != e; ++j)
 537       Value |= Bits.test(i + j) << j;
 538     OS << format("0x%0*x, ", Digits, Value);
 539   }
 540 }
 541
 542 // Helper to emit a set of bits into a constant byte array.
 543 class BitVectorEmitter {
 544   BitVector Values;
 545 public:
 546   void add(unsigned v) {
 547     if (v >= Values.size())
 548       Values.resize(((v/8)+1)*8); // Round up to the next byte.
 549     Values[v] = true;
 550   }
 551
 552   void print(raw_ostream &OS) {
 553     printBitVectorAsHex(OS, Values, 8);
 554   }
 555 };
 556
 557 static void printSimpleValueType(raw_ostream &OS, MVT::SimpleValueType VT) {
 558   OS << getEnumName(VT);
 559 }
 560
 561 static void printSubRegIndex(raw_ostream &OS, const CodeGenSubRegIndex *Idx) {
 562   OS << Idx->EnumValue;
 563 }
 564
 565 // Differentially encoded register and regunit lists allow for better
 566 // compression on regular register banks. The sequence is computed from the
 567 // differential list as:
 568 //
 569 //   out[0] = InitVal;
 570 //   out[n+1] = out[n] + diff[n]; // n = 0, 1, ...
 571 //
 572 // The initial value depends on the specific list. The list is terminated by a
 573 // 0 differential which means we can't encode repeated elements.
 574
 575 typedef SmallVector<uint16_t, 4> DiffVec;
 576
 577 // Differentially encode a sequence of numbers into V. The starting value and
 578 // terminating 0 are not added to V, so it will have the same size as List.
 579 static
 580 DiffVec &diffEncode(DiffVec &V, unsigned InitVal, ArrayRef<unsigned> List) {
 581   assert(V.empty() && "Clear DiffVec before diffEncode.");
 582   uint16_t Val = uint16_t(InitVal);
 583   for (unsigned i = 0; i != List.size(); ++i) {
 584     uint16_t Cur = List[i];
 585     V.push_back(Cur - Val);
 586     Val = Cur;
 587   }
 588   return V;
 589 }
 590
 591 template<typename Iter>
 592 static
 593 DiffVec &diffEncode(DiffVec &V, unsigned InitVal, Iter Begin, Iter End) {
 594   assert(V.empty() && "Clear DiffVec before diffEncode.");
 595   uint16_t Val = uint16_t(InitVal);
 596   for (Iter I = Begin; I != End; ++I) {
 597     uint16_t Cur = (*I)->EnumValue;
 598     V.push_back(Cur - Val);
 599     Val = Cur;
 600   }
 601   return V;
 602 }
 603
 604 static void printDiff16(raw_ostream &OS, uint16_t Val) {
 605   OS << Val;
 606 }
 607
 608 // Try to combine Idx's compose map into Vec if it is compatible.
 609 // Return false if it's not possible.
 610 static bool combine(const CodeGenSubRegIndex *Idx,
 611                     SmallVectorImpl<CodeGenSubRegIndex*> &Vec) {
 612   const CodeGenSubRegIndex::CompMap &Map = Idx->getComposites();
 613   for (CodeGenSubRegIndex::CompMap::const_iterator
 614        I = Map.begin(), E = Map.end(); I != E; ++I) {
 615     CodeGenSubRegIndex *&Entry = Vec[I->first->EnumValue - 1];
 616     if (Entry && Entry != I->second)
 617       return false;
 618   }
 619
 620   // All entries are compatible. Make it so.
 621   for (CodeGenSubRegIndex::CompMap::const_iterator
 622        I = Map.begin(), E = Map.end(); I != E; ++I)
 623     Vec[I->first->EnumValue - 1] = I->second;
 624   return true;
 625 }
 626
 627 void
 628 RegisterInfoEmitter::emitComposeSubRegIndices(raw_ostream &OS,
 629                                               CodeGenRegBank &RegBank,
 630                                               const std::string &ClName) {
 631   const auto &SubRegIndices = RegBank.getSubRegIndices();
 632   OS << "unsigned " << ClName
 633      << "::composeSubRegIndicesImpl(unsigned IdxA, unsigned IdxB) const {\n";
 634
 635   // Many sub-register indexes are composition-compatible, meaning that
 636   //
 637   //   compose(IdxA, IdxB) == compose(IdxA', IdxB)
 638   //
 639   // for many IdxA, IdxA' pairs. Not all sub-register indexes can be composed.
 640   // The illegal entries can be use as wildcards to compress the table further.
 641
 642   // Map each Sub-register index to a compatible table row.
 643   SmallVector<unsigned, 4> RowMap;
 644   SmallVector<SmallVector<CodeGenSubRegIndex*, 4>, 4> Rows;
 645
 646   auto SubRegIndicesSize =
 647       std::distance(SubRegIndices.begin(), SubRegIndices.end());
 648   for (const auto &Idx : SubRegIndices) {
 649     unsigned Found = ~0u;
 650     for (unsigned r = 0, re = Rows.size(); r != re; ++r) {
 651       if (combine(Idx, Rows[r])) {
 652         Found = r;
 653         break;
 654       }
 655     }
 656     if (Found == ~0u) {
 657       Found = Rows.size();
 658       Rows.resize(Found + 1);
 659       Rows.back().resize(SubRegIndicesSize);
 660       combine(Idx, Rows.back());
 661     }
 662     RowMap.push_back(Found);
 663   }
 664
 665   // Output the row map if there is multiple rows.
 666   if (Rows.size() > 1) {
 667     OS << "  static const " << getMinimalTypeForRange(Rows.size()) << " RowMap["
 668        << SubRegIndicesSize << "] = {\n    ";
 669     for (unsigned i = 0, e = SubRegIndicesSize; i != e; ++i)
 670       OS << RowMap[i] << ", ";
 671     OS << "\n  };\n";
 672   }
 673
 674   // Output the rows.
 675   OS << "  static const " << getMinimalTypeForRange(SubRegIndicesSize + 1)
 676      << " Rows[" << Rows.size() << "][" << SubRegIndicesSize << "] = {\n";
 677   for (unsigned r = 0, re = Rows.size(); r != re; ++r) {
 678     OS << "    { ";
 679     for (unsigned i = 0, e = SubRegIndicesSize; i != e; ++i)
 680       if (Rows[r][i])
 681         OS << Rows[r][i]->EnumValue << ", ";
 682       else
 683         OS << "0, ";
 684     OS << "},\n";
 685   }
 686   OS << "  };\n\n";
 687
 688   OS << "  --IdxA; assert(IdxA < " << SubRegIndicesSize << ");\n"
 689      << "  --IdxB; assert(IdxB < " << SubRegIndicesSize << ");\n";
 690   if (Rows.size() > 1)
 691     OS << "  return Rows[RowMap[IdxA]][IdxB];\n";
 692   else
 693     OS << "  return Rows[0][IdxB];\n";
 694   OS << "}\n\n";
 695 }
 696
 697 //
 698 // runMCDesc - Print out MC register descriptions.
 699 //
 700 void
 701 RegisterInfoEmitter::runMCDesc(raw_ostream &OS, CodeGenTarget &Target,
 702                                CodeGenRegBank &RegBank) {
 703   emitSourceFileHeader("MC Register Information", OS);
 704
 705   OS << "\n#ifdef GET_REGINFO_MC_DESC\n";
 706   OS << "#undef GET_REGINFO_MC_DESC\n";
 707
 708   const std::vector<CodeGenRegister*> &Regs = RegBank.getRegisters();
 709
 710   auto &SubRegIndices = RegBank.getSubRegIndices();
 711   // The lists of sub-registers and super-registers go in the same array.  That
 712   // allows us to share suffixes.
 713   typedef std::vector<const CodeGenRegister*> RegVec;
 714
 715   // Differentially encoded lists.
 716   SequenceToOffsetTable<DiffVec> DiffSeqs;
 717   SmallVector<DiffVec, 4> SubRegLists(Regs.size());
 718   SmallVector<DiffVec, 4> SuperRegLists(Regs.size());
 719   SmallVector<DiffVec, 4> RegUnitLists(Regs.size());
 720   SmallVector<unsigned, 4> RegUnitInitScale(Regs.size());
 721
 722   // Keep track of sub-register names as well. These are not differentially
 723   // encoded.
 724   typedef SmallVector<const CodeGenSubRegIndex*, 4> SubRegIdxVec;
 725   SequenceToOffsetTable<SubRegIdxVec, CodeGenSubRegIndex::Less> SubRegIdxSeqs;
 726   SmallVector<SubRegIdxVec, 4> SubRegIdxLists(Regs.size());
 727
 728   SequenceToOffsetTable<std::string> RegStrings;
 729
 730   // Precompute register lists for the SequenceToOffsetTable.
 731   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 732     const CodeGenRegister *Reg = Regs[i];
 733
 734     RegStrings.add(Reg->getName());
 735
 736     // Compute the ordered sub-register list.
 737     SetVector<const CodeGenRegister*> SR;
 738     Reg->addSubRegsPreOrder(SR, RegBank);
 739     diffEncode(SubRegLists[i], Reg->EnumValue, SR.begin(), SR.end());
 740     DiffSeqs.add(SubRegLists[i]);
 741
 742     // Compute the corresponding sub-register indexes.
 743     SubRegIdxVec &SRIs = SubRegIdxLists[i];
 744     for (unsigned j = 0, je = SR.size(); j != je; ++j)
 745       SRIs.push_back(Reg->getSubRegIndex(SR[j]));
 746     SubRegIdxSeqs.add(SRIs);
 747
 748     // Super-registers are already computed.
 749     const RegVec &SuperRegList = Reg->getSuperRegs();
 750     diffEncode(SuperRegLists[i], Reg->EnumValue,
 751                SuperRegList.begin(), SuperRegList.end());
 752     DiffSeqs.add(SuperRegLists[i]);
 753
 754     // Differentially encode the register unit list, seeded by register number.
 755     // First compute a scale factor that allows more diff-lists to be reused:
 756     //
 757     //   D0 -> (S0, S1)
 758     //   D1 -> (S2, S3)
 759     //
 760     // A scale factor of 2 allows D0 and D1 to share a diff-list. The initial
 761     // value for the differential decoder is the register number multiplied by
 762     // the scale.
 763     //
 764     // Check the neighboring registers for arithmetic progressions.
 765     unsigned ScaleA = ~0u, ScaleB = ~0u;
 766     ArrayRef<unsigned> RUs = Reg->getNativeRegUnits();
 767     if (i > 0 && Regs[i-1]->getNativeRegUnits().size() == RUs.size())
 768       ScaleB = RUs.front() - Regs[i-1]->getNativeRegUnits().front();
 769     if (i+1 != Regs.size() &&
 770         Regs[i+1]->getNativeRegUnits().size() == RUs.size())
 771       ScaleA = Regs[i+1]->getNativeRegUnits().front() - RUs.front();
 772     unsigned Scale = std::min(ScaleB, ScaleA);
 773     // Default the scale to 0 if it can't be encoded in 4 bits.
 774     if (Scale >= 16)
 775       Scale = 0;
 776     RegUnitInitScale[i] = Scale;
 777     DiffSeqs.add(diffEncode(RegUnitLists[i], Scale * Reg->EnumValue, RUs));
 778   }
 779
 780   // Compute the final layout of the sequence table.
 781   DiffSeqs.layout();
 782   SubRegIdxSeqs.layout();
 783
 784   OS << "namespace llvm {\n\n";
 785
 786   const std::string &TargetName = Target.getName();
 787
 788   // Emit the shared table of differential lists.
 789   OS << "extern const MCPhysReg " << TargetName << "RegDiffLists[] = {\n";
 790   DiffSeqs.emit(OS, printDiff16);
 791   OS << "};\n\n";
 792
 793   // Emit the table of sub-register indexes.
 794   OS << "extern const uint16_t " << TargetName << "SubRegIdxLists[] = {\n";
 795   SubRegIdxSeqs.emit(OS, printSubRegIndex);
 796   OS << "};\n\n";
 797
 798   // Emit the table of sub-register index sizes.
 799   OS << "extern const MCRegisterInfo::SubRegCoveredBits "
 800      << TargetName << "SubRegIdxRanges[] = {\n";
 801   OS << "  { " << (uint16_t)-1 << ", " << (uint16_t)-1 << " },\n";
 802   for (const auto &Idx : SubRegIndices) {
 803     OS << "  { " << Idx->Offset << ", "
 804                  << Idx->Size
 805        << " },\t// " << Idx->getName() << "\n";
 806   }
 807   OS << "};\n\n";
 808
 809   // Emit the string table.
 810   RegStrings.layout();
 811   OS << "extern const char " << TargetName << "RegStrings[] = {\n";
 812   RegStrings.emit(OS, printChar);
 813   OS << "};\n\n";
 814
 815   OS << "extern const MCRegisterDesc " << TargetName
 816      << "RegDesc[] = { // Descriptors\n";
 817   OS << "  { " << RegStrings.get("") << ", 0, 0, 0, 0 },\n";
 818
 819   // Emit the register descriptors now.
 820   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 821     const CodeGenRegister *Reg = Regs[i];
 822     OS << "  { " << RegStrings.get(Reg->getName()) << ", "
 823        << DiffSeqs.get(SubRegLists[i]) << ", "
 824        << DiffSeqs.get(SuperRegLists[i]) << ", "
 825        << SubRegIdxSeqs.get(SubRegIdxLists[i]) << ", "
 826        << (DiffSeqs.get(RegUnitLists[i])*16 + RegUnitInitScale[i]) << " },\n";
 827   }
 828   OS << "};\n\n";      // End of register descriptors...
 829
 830   // Emit the table of register unit roots. Each regunit has one or two root
 831   // registers.
 832   OS << "extern const MCPhysReg " << TargetName << "RegUnitRoots[][2] = {\n";
 833   for (unsigned i = 0, e = RegBank.getNumNativeRegUnits(); i != e; ++i) {
 834     ArrayRef<const CodeGenRegister*> Roots = RegBank.getRegUnit(i).getRoots();
 835     assert(!Roots.empty() && "All regunits must have a root register.");
 836     assert(Roots.size() <= 2 && "More than two roots not supported yet.");
 837     OS << "  { " << getQualifiedName(Roots.front()->TheDef);
 838     for (unsigned r = 1; r != Roots.size(); ++r)
 839       OS << ", " << getQualifiedName(Roots[r]->TheDef);
 840     OS << " },\n";
 841   }
 842   OS << "};\n\n";
 843
 844   ArrayRef<CodeGenRegisterClass*> RegisterClasses = RegBank.getRegClasses();
 845
 846   // Loop over all of the register classes... emitting each one.
 847   OS << "namespace {     // Register classes...\n";
 848
 849   SequenceToOffsetTable<std::string> RegClassStrings;
 850
 851   // Emit the register enum value arrays for each RegisterClass
 852   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
 853     const CodeGenRegisterClass &RC = *RegisterClasses[rc];
 854     ArrayRef<Record*> Order = RC.getOrder();
 855
 856     // Give the register class a legal C name if it's anonymous.
 857     std::string Name = RC.getName();
 858
 859     RegClassStrings.add(Name);
 860
 861     // Emit the register list now.
 862     OS << "  // " << Name << " Register Class...\n"
 863        << "  const MCPhysReg " << Name
 864        << "[] = {\n    ";
 865     for (unsigned i = 0, e = Order.size(); i != e; ++i) {
 866       Record *Reg = Order[i];
 867       OS << getQualifiedName(Reg) << ", ";
 868     }
 869     OS << "\n  };\n\n";
 870
 871     OS << "  // " << Name << " Bit set.\n"
 872        << "  const uint8_t " << Name
 873        << "Bits[] = {\n    ";
 874     BitVectorEmitter BVE;
 875     for (unsigned i = 0, e = Order.size(); i != e; ++i) {
 876       Record *Reg = Order[i];
 877       BVE.add(Target.getRegBank().getReg(Reg)->EnumValue);
 878     }
 879     BVE.print(OS);
 880     OS << "\n  };\n\n";
 881
 882   }
 883   OS << "}\n\n";
 884
 885   RegClassStrings.layout();
 886   OS << "extern const char " << TargetName << "RegClassStrings[] = {\n";
 887   RegClassStrings.emit(OS, printChar);
 888   OS << "};\n\n";
 889
 890   OS << "extern const MCRegisterClass " << TargetName
 891      << "MCRegisterClasses[] = {\n";
 892
 893   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
 894     const CodeGenRegisterClass &RC = *RegisterClasses[rc];
 895
 896     // Asserts to make sure values will fit in table assuming types from
 897     // MCRegisterInfo.h
 898     assert((RC.SpillSize/8) <= 0xffff && "SpillSize too large.");
 899     assert((RC.SpillAlignment/8) <= 0xffff && "SpillAlignment too large.");
 900     assert(RC.CopyCost >= -128 && RC.CopyCost <= 127 && "Copy cost too large.");
 901
 902     OS << "  { " << RC.getName() << ", " << RC.getName() << "Bits, "
 903        << RegClassStrings.get(RC.getName()) << ", "
 904        << RC.getOrder().size() << ", sizeof(" << RC.getName() << "Bits), "
 905        << RC.getQualifiedName() + "RegClassID" << ", "
 906        << RC.SpillSize/8 << ", "
 907        << RC.SpillAlignment/8 << ", "
 908        << RC.CopyCost << ", "
 909        << RC.Allocatable << " },\n";
 910   }
 911
 912   OS << "};\n\n";
 913
 914   EmitRegMappingTables(OS, Regs, false);
 915
 916   // Emit Reg encoding table
 917   OS << "extern const uint16_t " << TargetName;
 918   OS << "RegEncodingTable[] = {\n";
 919   // Add entry for NoRegister
 920   OS << "  0,\n";
 921   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 922     Record *Reg = Regs[i]->TheDef;
 923     BitsInit *BI = Reg->getValueAsBitsInit("HWEncoding");
 924     uint64_t Value = 0;
 925     for (unsigned b = 0, be = BI->getNumBits(); b != be; ++b) {
 926       if (BitInit *B = dyn_cast<BitInit>(BI->getBit(b)))
 927         Value |= (uint64_t)B->getValue() << b;
 928     }
 929     OS << "  " << Value << ",\n";
 930   }
 931   OS << "};\n";       // End of HW encoding table
 932
 933   // MCRegisterInfo initialization routine.
 934   OS << "static inline void Init" << TargetName
 935      << "MCRegisterInfo(MCRegisterInfo *RI, unsigned RA, "
 936      << "unsigned DwarfFlavour = 0, unsigned EHFlavour = 0, unsigned PC = 0) "
 937         "{\n"
 938      << "  RI->InitMCRegisterInfo(" << TargetName << "RegDesc, "
 939      << Regs.size() + 1 << ", RA, PC, " << TargetName << "MCRegisterClasses, "
 940      << RegisterClasses.size() << ", " << TargetName << "RegUnitRoots, "
 941      << RegBank.getNumNativeRegUnits() << ", " << TargetName << "RegDiffLists, "
 942      << TargetName << "RegStrings, " << TargetName << "RegClassStrings, "
 943      << TargetName << "SubRegIdxLists, "
 944      << (std::distance(SubRegIndices.begin(), SubRegIndices.end()) + 1) << ",\n"
 945      << TargetName << "SubRegIdxRanges, " << TargetName
 946      << "RegEncodingTable);\n\n";
 947
 948   EmitRegMapping(OS, Regs, false);
 949
 950   OS << "}\n\n";
 951
 952   OS << "} // End llvm namespace\n";
 953   OS << "#endif // GET_REGINFO_MC_DESC\n\n";
 954 }
 955
 956 void
 957 RegisterInfoEmitter::runTargetHeader(raw_ostream &OS, CodeGenTarget &Target,
 958                                      CodeGenRegBank &RegBank) {
 959   emitSourceFileHeader("Register Information Header Fragment", OS);
 960
 961   OS << "\n#ifdef GET_REGINFO_HEADER\n";
 962   OS << "#undef GET_REGINFO_HEADER\n";
 963
 964   const std::string &TargetName = Target.getName();
 965   std::string ClassName = TargetName + "GenRegisterInfo";
 966
 967   OS << "#include \"llvm/Target/TargetRegisterInfo.h\"\n\n";
 968
 969   OS << "namespace llvm {\n\n";
 970
 971   OS << "struct " << ClassName << " : public TargetRegisterInfo {\n"
 972      << "  explicit " << ClassName
 973      << "(unsigned RA, unsigned D = 0, unsigned E = 0, unsigned PC = 0);\n"
 974      << "  bool needsStackRealignment(const MachineFunction &) const override\n"
 975      << "     { return false; }\n";
 976   if (!RegBank.getSubRegIndices().empty()) {
 977     OS << "  unsigned composeSubRegIndicesImpl"
 978        << "(unsigned, unsigned) const override;\n"
 979        << "  const TargetRegisterClass *getSubClassWithSubReg"
 980        << "(const TargetRegisterClass*, unsigned) const override;\n";
 981   }
 982   OS << "  const RegClassWeight &getRegClassWeight("
 983      << "const TargetRegisterClass *RC) const override;\n"
 984      << "  unsigned getRegUnitWeight(unsigned RegUnit) const override;\n"
 985      << "  unsigned getNumRegPressureSets() const override;\n"
 986      << "  const char *getRegPressureSetName(unsigned Idx) const override;\n"
 987      << "  unsigned getRegPressureSetLimit(unsigned Idx) const override;\n"
 988      << "  const int *getRegClassPressureSets("
 989      << "const TargetRegisterClass *RC) const override;\n"
 990      << "  const int *getRegUnitPressureSets("
 991      << "unsigned RegUnit) const override;\n"
 992      << "};\n\n";
 993
 994   ArrayRef<CodeGenRegisterClass*> RegisterClasses = RegBank.getRegClasses();
 995
 996   if (!RegisterClasses.empty()) {
 997     OS << "namespace " << RegisterClasses[0]->Namespace
 998        << " { // Register classes\n";
 999
1000     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
1001       const CodeGenRegisterClass &RC = *RegisterClasses[i];
1002       const std::string &Name = RC.getName();
1003
1004       // Output the extern for the instance.
1005       OS << "  extern const TargetRegisterClass " << Name << "RegClass;\n";
1006     }
1007     OS << "} // end of namespace " << TargetName << "\n\n";
1008   }
1009   OS << "} // End llvm namespace\n";
1010   OS << "#endif // GET_REGINFO_HEADER\n\n";
1011 }
1012
1013 //
1014 // runTargetDesc - Output the target register and register file descriptions.
1015 //
1016 void
1017 RegisterInfoEmitter::runTargetDesc(raw_ostream &OS, CodeGenTarget &Target,
1018                                    CodeGenRegBank &RegBank){
1019   emitSourceFileHeader("Target Register and Register Classes Information", OS);
1020
1021   OS << "\n#ifdef GET_REGINFO_TARGET_DESC\n";
1022   OS << "#undef GET_REGINFO_TARGET_DESC\n";
1023
1024   OS << "namespace llvm {\n\n";
1025
1026   // Get access to MCRegisterClass data.
1027   OS << "extern const MCRegisterClass " << Target.getName()
1028      << "MCRegisterClasses[];\n";
1029
1030   // Start out by emitting each of the register classes.
1031   ArrayRef<CodeGenRegisterClass*> RegisterClasses = RegBank.getRegClasses();
1032   const auto &SubRegIndices = RegBank.getSubRegIndices();
1033
1034   // Collect all registers belonging to any allocatable class.
1035   std::set<Record*> AllocatableRegs;
1036
1037   // Collect allocatable registers.
1038   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
1039     const CodeGenRegisterClass &RC = *RegisterClasses[rc];
1040     ArrayRef<Record*> Order = RC.getOrder();
1041
1042     if (RC.Allocatable)
1043       AllocatableRegs.insert(Order.begin(), Order.end());
1044   }
1045
1046   // Build a shared array of value types.
1047   SequenceToOffsetTable<SmallVector<MVT::SimpleValueType, 4> > VTSeqs;
1048   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc)
1049     VTSeqs.add(RegisterClasses[rc]->VTs);
1050   VTSeqs.layout();
1051   OS << "\nstatic const MVT::SimpleValueType VTLists[] = {\n";
1052   VTSeqs.emit(OS, printSimpleValueType, "MVT::Other");
1053   OS << "};\n";
1054
1055   // Emit SubRegIndex names, skipping 0.
1056   OS << "\nstatic const char *const SubRegIndexNameTable[] = { \"";
1057
1058   for (const auto &Idx : SubRegIndices) {
1059     OS << Idx->getName();
1060     OS << "\", \"";
1061   }
1062   OS << "\" };\n\n";
1063
1064   // Emit SubRegIndex lane masks, including 0.
1065   OS << "\nstatic const unsigned SubRegIndexLaneMaskTable[] = {\n  ~0u,\n";
1066   for (const auto &Idx : SubRegIndices) {
1067     OS << format("  0x%08x, // ", Idx->LaneMask)
1068        << Idx->getName() << '\n';
1069   }
1070   OS << " };\n\n";
1071
1072   OS << "\n";
1073
1074   // Now that all of the structs have been emitted, emit the instances.
1075   if (!RegisterClasses.empty()) {
1076     OS << "\nstatic const TargetRegisterClass *const "
1077        << "NullRegClasses[] = { nullptr };\n\n";
1078
1079     // Emit register class bit mask tables. The first bit mask emitted for a
1080     // register class, RC, is the set of sub-classes, including RC itself.
1081     //
1082     // If RC has super-registers, also create a list of subreg indices and bit
1083     // masks, (Idx, Mask). The bit mask has a bit for every superreg regclass,
1084     // SuperRC, that satisfies:
1085     //
1086     //   For all SuperReg in SuperRC: SuperReg:Idx in RC
1087     //
1088     // The 0-terminated list of subreg indices starts at:
1089     //
1090     //   RC->getSuperRegIndices() = SuperRegIdxSeqs + ...
1091     //
1092     // The corresponding bitmasks follow the sub-class mask in memory. Each
1093     // mask has RCMaskWords uint32_t entries.
1094     //
1095     // Every bit mask present in the list has at least one bit set.
1096
1097     // Compress the sub-reg index lists.
1098     typedef std::vector<const CodeGenSubRegIndex*> IdxList;
1099     SmallVector<IdxList, 8> SuperRegIdxLists(RegisterClasses.size());
1100     SequenceToOffsetTable<IdxList, CodeGenSubRegIndex::Less> SuperRegIdxSeqs;
1101     BitVector MaskBV(RegisterClasses.size());
1102
1103     for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
1104       const CodeGenRegisterClass &RC = *RegisterClasses[rc];
1105       OS << "static const uint32_t " << RC.getName() << "SubClassMask[] = {\n  ";
1106       printBitVectorAsHex(OS, RC.getSubClasses(), 32);
1107
1108       // Emit super-reg class masks for any relevant SubRegIndices that can
1109       // project into RC.
1110       IdxList &SRIList = SuperRegIdxLists[rc];
1111       for (auto &Idx : SubRegIndices) {
1112         MaskBV.reset();
1113         RC.getSuperRegClasses(Idx, MaskBV);
1114         if (MaskBV.none())
1115           continue;
1116         SRIList.push_back(Idx);
1117         OS << "\n  ";
1118         printBitVectorAsHex(OS, MaskBV, 32);
1119         OS << "// " << Idx->getName();
1120       }
1121       SuperRegIdxSeqs.add(SRIList);
1122       OS << "\n};\n\n";
1123     }
1124
1125     OS << "static const uint16_t SuperRegIdxSeqs[] = {\n";
1126     SuperRegIdxSeqs.layout();
1127     SuperRegIdxSeqs.emit(OS, printSubRegIndex);
1128     OS << "};\n\n";
1129
1130     // Emit NULL terminated super-class lists.
1131     for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
1132       const CodeGenRegisterClass &RC = *RegisterClasses[rc];
1133       ArrayRef<CodeGenRegisterClass*> Supers = RC.getSuperClasses();
1134
1135       // Skip classes without supers.  We can reuse NullRegClasses.
1136       if (Supers.empty())
1137         continue;
1138
1139       OS << "static const TargetRegisterClass *const "
1140          << RC.getName() << "Superclasses[] = {\n";
1141       for (unsigned i = 0; i != Supers.size(); ++i)
1142         OS << "  &" << Supers[i]->getQualifiedName() << "RegClass,\n";
1143       OS << "  nullptr\n};\n\n";
1144     }
1145
1146     // Emit methods.
1147     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
1148       const CodeGenRegisterClass &RC = *RegisterClasses[i];
1149       if (!RC.AltOrderSelect.empty()) {
1150         OS << "\nstatic inline unsigned " << RC.getName()
1151            << "AltOrderSelect(const MachineFunction &MF) {"
1152            << RC.AltOrderSelect << "}\n\n"
1153            << "static ArrayRef<MCPhysReg> " << RC.getName()
1154            << "GetRawAllocationOrder(const MachineFunction &MF) {\n";
1155         for (unsigned oi = 1 , oe = RC.getNumOrders(); oi != oe; ++oi) {
1156           ArrayRef<Record*> Elems = RC.getOrder(oi);
1157           if (!Elems.empty()) {
1158             OS << "  static const MCPhysReg AltOrder" << oi << "[] = {";
1159             for (unsigned elem = 0; elem != Elems.size(); ++elem)
1160               OS << (elem ? ", " : " ") << getQualifiedName(Elems[elem]);
1161             OS << " };\n";
1162           }
1163         }
1164         OS << "  const MCRegisterClass &MCR = " << Target.getName()
1165            << "MCRegisterClasses[" << RC.getQualifiedName() + "RegClassID];\n"
1166            << "  const ArrayRef<MCPhysReg> Order[] = {\n"
1167            << "    makeArrayRef(MCR.begin(), MCR.getNumRegs()";
1168         for (unsigned oi = 1, oe = RC.getNumOrders(); oi != oe; ++oi)
1169           if (RC.getOrder(oi).empty())
1170             OS << "),\n    ArrayRef<MCPhysReg>(";
1171           else
1172             OS << "),\n    makeArrayRef(AltOrder" << oi;
1173         OS << ")\n  };\n  const unsigned Select = " << RC.getName()
1174            << "AltOrderSelect(MF);\n  assert(Select < " << RC.getNumOrders()
1175            << ");\n  return Order[Select];\n}\n";
1176         }
1177     }
1178
1179     // Now emit the actual value-initialized register class instances.
1180     OS << "\nnamespace " << RegisterClasses[0]->Namespace
1181        << " {   // Register class instances\n";
1182
1183     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
1184       const CodeGenRegisterClass &RC = *RegisterClasses[i];
1185       OS << "  extern const TargetRegisterClass "
1186          << RegisterClasses[i]->getName() << "RegClass = {\n    "
1187          << '&' << Target.getName() << "MCRegisterClasses[" << RC.getName()
1188          << "RegClassID],\n    "
1189          << "VTLists + " << VTSeqs.get(RC.VTs) << ",\n    "
1190          << RC.getName() << "SubClassMask,\n    SuperRegIdxSeqs + "
1191          << SuperRegIdxSeqs.get(SuperRegIdxLists[i]) << ",\n    ";
1192       if (RC.getSuperClasses().empty())
1193         OS << "NullRegClasses,\n    ";
1194       else
1195         OS << RC.getName() << "Superclasses,\n    ";
1196       if (RC.AltOrderSelect.empty())
1197         OS << "nullptr\n";
1198       else
1199         OS << RC.getName() << "GetRawAllocationOrder\n";
1200       OS << "  };\n\n";
1201     }
1202
1203     OS << "}\n";
1204   }
1205
1206   OS << "\nnamespace {\n";
1207   OS << "  const TargetRegisterClass* const RegisterClasses[] = {\n";
1208   for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i)
1209     OS << "    &" << RegisterClasses[i]->getQualifiedName()
1210        << "RegClass,\n";
1211   OS << "  };\n";
1212   OS << "}\n";       // End of anonymous namespace...
1213
1214   // Emit extra information about registers.
1215   const std::string &TargetName = Target.getName();
1216   OS << "\nstatic const TargetRegisterInfoDesc "
1217      << TargetName << "RegInfoDesc[] = { // Extra Descriptors\n";
1218   OS << "  { 0, 0 },\n";
1219
1220   const std::vector<CodeGenRegister*> &Regs = RegBank.getRegisters();
1221   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
1222     const CodeGenRegister &Reg = *Regs[i];
1223     OS << "  { ";
1224     OS << Reg.CostPerUse << ", "
1225        << int(AllocatableRegs.count(Reg.TheDef)) << " },\n";
1226   }
1227   OS << "};\n";      // End of register descriptors...
1228
1229
1230   std::string ClassName = Target.getName() + "GenRegisterInfo";
1231
1232   auto SubRegIndicesSize =
1233       std::distance(SubRegIndices.begin(), SubRegIndices.end());
1234
1235   if (!SubRegIndices.empty())
1236     emitComposeSubRegIndices(OS, RegBank, ClassName);
1237
1238   // Emit getSubClassWithSubReg.
1239   if (!SubRegIndices.empty()) {
1240     OS << "const TargetRegisterClass *" << ClassName
1241        << "::getSubClassWithSubReg(const TargetRegisterClass *RC, unsigned Idx)"
1242        << " const {\n";
1243     // Use the smallest type that can hold a regclass ID with room for a
1244     // sentinel.
1245     if (RegisterClasses.size() < UINT8_MAX)
1246       OS << "  static const uint8_t Table[";
1247     else if (RegisterClasses.size() < UINT16_MAX)
1248       OS << "  static const uint16_t Table[";
1249     else
1250       PrintFatalError("Too many register classes.");
1251     OS << RegisterClasses.size() << "][" << SubRegIndicesSize << "] = {\n";
1252     for (unsigned rci = 0, rce = RegisterClasses.size(); rci != rce; ++rci) {
1253       const CodeGenRegisterClass &RC = *RegisterClasses[rci];
1254       OS << "    {\t// " << RC.getName() << "\n";
1255       for (auto &Idx : SubRegIndices) {
1256         if (CodeGenRegisterClass *SRC = RC.getSubClassWithSubReg(Idx))
1257           OS << "      " << SRC->EnumValue + 1 << ",\t// " << Idx->getName()
1258              << " -> " << SRC->getName() << "\n";
1259         else
1260           OS << "      0,\t// " << Idx->getName() << "\n";
1261       }
1262       OS << "    },\n";
1263     }
1264     OS << "  };\n  assert(RC && \"Missing regclass\");\n"
1265        << "  if (!Idx) return RC;\n  --Idx;\n"
1266        << "  assert(Idx < " << SubRegIndicesSize << " && \"Bad subreg\");\n"
1267        << "  unsigned TV = Table[RC->getID()][Idx];\n"
1268        << "  return TV ? getRegClass(TV - 1) : nullptr;\n}\n\n";
1269   }
1270
1271   EmitRegUnitPressure(OS, RegBank, ClassName);
1272
1273   // Emit the constructor of the class...
1274   OS << "extern const MCRegisterDesc " << TargetName << "RegDesc[];\n";
1275   OS << "extern const MCPhysReg " << TargetName << "RegDiffLists[];\n";
1276   OS << "extern const char " << TargetName << "RegStrings[];\n";
1277   OS << "extern const char " << TargetName << "RegClassStrings[];\n";
1278   OS << "extern const MCPhysReg " << TargetName << "RegUnitRoots[][2];\n";
1279   OS << "extern const uint16_t " << TargetName << "SubRegIdxLists[];\n";
1280   OS << "extern const MCRegisterInfo::SubRegCoveredBits "
1281      << TargetName << "SubRegIdxRanges[];\n";
1282   OS << "extern const uint16_t " << TargetName << "RegEncodingTable[];\n";
1283
1284   EmitRegMappingTables(OS, Regs, true);
1285
1286   OS << ClassName << "::\n" << ClassName
1287      << "(unsigned RA, unsigned DwarfFlavour, unsigned EHFlavour, unsigned PC)\n"
1288      << "  : TargetRegisterInfo(" << TargetName << "RegInfoDesc"
1289      << ", RegisterClasses, RegisterClasses+" << RegisterClasses.size() <<",\n"
1290      << "             SubRegIndexNameTable, SubRegIndexLaneMaskTable, 0x";
1291   OS.write_hex(RegBank.CoveringLanes);
1292   OS << ") {\n"
1293      << "  InitMCRegisterInfo(" << TargetName << "RegDesc, " << Regs.size() + 1
1294      << ", RA, PC,\n                     " << TargetName
1295      << "MCRegisterClasses, " << RegisterClasses.size() << ",\n"
1296      << "                     " << TargetName << "RegUnitRoots,\n"
1297      << "                     " << RegBank.getNumNativeRegUnits() << ",\n"
1298      << "                     " << TargetName << "RegDiffLists,\n"
1299      << "                     " << TargetName << "RegStrings,\n"
1300      << "                     " << TargetName << "RegClassStrings,\n"
1301      << "                     " << TargetName << "SubRegIdxLists,\n"
1302      << "                     " << SubRegIndicesSize + 1 << ",\n"
1303      << "                     " << TargetName << "SubRegIdxRanges,\n"
1304      << "                     " << TargetName << "RegEncodingTable);\n\n";
1305
1306   EmitRegMapping(OS, Regs, true);
1307
1308   OS << "}\n\n";
1309
1310
1311   // Emit CalleeSavedRegs information.
1312   std::vector<Record*> CSRSets =
1313     Records.getAllDerivedDefinitions("CalleeSavedRegs");
1314   for (unsigned i = 0, e = CSRSets.size(); i != e; ++i) {
1315     Record *CSRSet = CSRSets[i];
1316     const SetTheory::RecVec *Regs = RegBank.getSets().expand(CSRSet);
1317     assert(Regs && "Cannot expand CalleeSavedRegs instance");
1318
1319     // Emit the *_SaveList list of callee-saved registers.
1320     OS << "static const MCPhysReg " << CSRSet->getName()
1321        << "_SaveList[] = { ";
1322     for (unsigned r = 0, re = Regs->size(); r != re; ++r)
1323       OS << getQualifiedName((*Regs)[r]) << ", ";
1324     OS << "0 };\n";
1325
1326     // Emit the *_RegMask bit mask of call-preserved registers.
1327     BitVector Covered = RegBank.computeCoveredRegisters(*Regs);
1328
1329     // Check for an optional OtherPreserved set.
1330     // Add those registers to RegMask, but not to SaveList.
1331     if (DagInit *OPDag =
1332         dyn_cast<DagInit>(CSRSet->getValueInit("OtherPreserved"))) {
1333       SetTheory::RecSet OPSet;
1334       RegBank.getSets().evaluate(OPDag, OPSet, CSRSet->getLoc());
1335       Covered |= RegBank.computeCoveredRegisters(
1336         ArrayRef<Record*>(OPSet.begin(), OPSet.end()));
1337     }
1338
1339     OS << "static const uint32_t " << CSRSet->getName()
1340        << "_RegMask[] = { ";
1341     printBitVectorAsHex(OS, Covered, 32);
1342     OS << "};\n";
1343   }
1344   OS << "\n\n";
1345
1346   OS << "} // End llvm namespace\n";
1347   OS << "#endif // GET_REGINFO_TARGET_DESC\n\n";
1348 }
1349
1350 void RegisterInfoEmitter::run(raw_ostream &OS) {
1351   CodeGenTarget Target(Records);
1352   CodeGenRegBank &RegBank = Target.getRegBank();
1353   RegBank.computeDerivedInfo();
1354
1355   runEnums(OS, Target, RegBank);
1356   runMCDesc(OS, Target, RegBank);
1357   runTargetHeader(OS, Target, RegBank);
1358   runTargetDesc(OS, Target, RegBank);
1359 }
1360
1361 namespace llvm {
1362
1363 void EmitRegisterInfo(RecordKeeper &RK, raw_ostream &OS) {
1364   RegisterInfoEmitter(RK).run(OS);
1365 }
1366
1367 } // End llvm namespace