utils/TableGen/RegisterInfoEmitter.cpp

   1 //===- RegisterInfoEmitter.cpp - Generate a Register File Desc. -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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 "Record.h"
  19 #include "Support/StringExtras.h"
  20 #include <set>
  21 using namespace llvm;
  22
  23 // runEnums - Print out enum values for all of the registers.
  24 void RegisterInfoEmitter::runEnums(std::ostream &OS) {
  25   std::vector<Record*> Registers = Records.getAllDerivedDefinitions("Register");
  26
  27   if (Registers.size() == 0)
  28     throw std::string("No 'Register' subclasses defined!");
  29
  30   std::string Namespace = Registers[0]->getValueAsString("Namespace");
  31
  32   EmitSourceFileHeader("Target Register Enum Values", OS);
  33
  34   if (!Namespace.empty())
  35     OS << "namespace " << Namespace << " {\n";
  36   OS << "  enum {\n    NoRegister,\n";
  37
  38   for (unsigned i = 0, e = Registers.size(); i != e; ++i)
  39     OS << "    " << Registers[i]->getName() << ", \t// " << i+1 << "\n";
  40
  41   OS << "  };\n";
  42   if (!Namespace.empty())
  43     OS << "}\n";
  44   EmitSourceFileTail(OS);
  45 }
  46
  47 void RegisterInfoEmitter::runHeader(std::ostream &OS) {
  48   EmitSourceFileHeader("Register Information Header Fragment", OS);
  49   const std::string &TargetName = CodeGenTarget().getName();
  50   std::string ClassName = TargetName + "GenRegisterInfo";
  51
  52   OS << "#include \"llvm/Target/MRegisterInfo.h\"\n\n";
  53
  54   OS << "struct " << ClassName << " : public MRegisterInfo {\n"
  55      << "  " << ClassName
  56      << "(int CallFrameSetupOpcode = -1, int CallFrameDestroyOpcode = -1);\n"
  57      << "  const unsigned* getCalleeSaveRegs() const;\n"
  58      << "};\n\n";
  59
  60   std::vector<Record*> RegisterClasses =
  61     Records.getAllDerivedDefinitions("RegisterClass");
  62
  63   OS << "namespace " << TargetName << " { // Register classes\n";
  64   for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
  65     if (RegisterClasses[i]->getValueAsBit("isDummyClass"))
  66       continue; // Ignore dummies
  67
  68     const std::string &Name = RegisterClasses[i]->getName();
  69     if (Name.size() < 9 || Name[9] != '.')       // Ignore anonymous classes
  70       OS << "  extern TargetRegisterClass *" << Name << "RegisterClass;\n";
  71   }
  72   OS << "} // end of namespace " << TargetName << "\n\n";
  73   EmitSourceFileTail(OS);
  74 }
  75
  76 // RegisterInfoEmitter::run - Main register file description emitter.
  77 //
  78 void RegisterInfoEmitter::run(std::ostream &OS) {
  79   EmitSourceFileHeader("Register Information Source Fragment", OS);
  80
  81   // Start out by emitting each of the register classes... to do this, we build
  82   // a set of registers which belong to a register class, this is to ensure that
  83   // each register is only in a single register class.
  84   //
  85   std::vector<Record*> RegisterClasses =
  86     Records.getAllDerivedDefinitions("RegisterClass");
  87
  88   std::vector<Record*> Registers = Records.getAllDerivedDefinitions("Register");
  89
  90   std::set<Record*> RegistersFound;
  91   std::vector<std::string> RegClassNames;
  92
  93   // Loop over all of the register classes... emitting each one.
  94   OS << "namespace {     // Register classes...\n";
  95
  96   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
  97     Record *RC = RegisterClasses[rc];
  98     if (RC->getValueAsBit("isDummyClass")) continue; // Ignore dummies
  99
 100     std::string Name = RC->getName();
 101     if (Name.size() > 9 && Name[9] == '.') {
 102       static unsigned AnonCounter = 0;
 103       Name = "AnonRegClass_"+utostr(AnonCounter++);
 104     }
 105
 106     RegClassNames.push_back(Name);
 107
 108     // Emit the register list now...
 109     OS << "  // " << Name << " Register Class...\n  const unsigned " << Name
 110        << "[] = {\n    ";
 111     ListInit *RegList = RC->getValueAsListInit("MemberList");
 112     for (unsigned i = 0, e = RegList->getSize(); i != e; ++i) {
 113       DefInit *RegDef = dynamic_cast<DefInit*>(RegList->getElement(i));
 114       if (!RegDef) throw "Register class member is not a record!";
 115       Record *Reg = RegDef->getDef();
 116       if (!Reg->isSubClassOf("Register"))
 117         throw "Register Class member '" + Reg->getName() +
 118               " does not derive from the Register class!";
 119       if (RegistersFound.count(Reg))
 120         throw "Register '" + Reg->getName() +
 121               "' included in multiple register classes!";
 122       RegistersFound.insert(Reg);
 123       OS << getQualifiedName(Reg) << ", ";
 124     }
 125     OS << "\n  };\n\n";
 126
 127     OS << "  struct " << Name << "Class : public TargetRegisterClass {\n"
 128        << "    " << Name << "Class() : TargetRegisterClass("
 129        << RC->getValueAsInt("Size")/8 << ", " << RC->getValueAsInt("Alignment")
 130        << ", " << Name << ", " << Name << " + " << RegList->getSize()
 131        << ") {}\n";
 132
 133     if (CodeInit *CI = dynamic_cast<CodeInit*>(RC->getValueInit("Methods")))
 134       OS << CI->getValue();
 135     else
 136       throw "Expected 'code' fragment for 'Methods' value in register class '"+
 137             RC->getName() + "'!";
 138
 139     OS << "  } " << Name << "Instance;\n\n";
 140   }
 141
 142   OS << "  const TargetRegisterClass* const RegisterClasses[] = {\n";
 143   for (unsigned i = 0, e = RegClassNames.size(); i != e; ++i)
 144     OS << "    &" << RegClassNames[i] << "Instance,\n";
 145   OS << "  };\n";
 146
 147   // Emit register class aliases...
 148   std::vector<Record*> RegisterAliasesRecs =
 149     Records.getAllDerivedDefinitions("RegisterAliases");
 150   std::map<Record*, std::set<Record*> > RegisterAliases;
 151
 152   for (unsigned i = 0, e = RegisterAliasesRecs.size(); i != e; ++i) {
 153     Record *AS = RegisterAliasesRecs[i];
 154     Record *R = AS->getValueAsDef("Reg");
 155     ListInit *LI = AS->getValueAsListInit("Aliases");
 156
 157     // Add information that R aliases all of the elements in the list... and
 158     // that everything in the list aliases R.
 159     for (unsigned j = 0, e = LI->getSize(); j != e; ++j) {
 160       DefInit *Reg = dynamic_cast<DefInit*>(LI->getElement(j));
 161       if (!Reg) throw "ERROR: Alias list element is not a def!";
 162       if (RegisterAliases[R].count(Reg->getDef()))
 163         std::cerr << "Warning: register alias between " << getQualifiedName(R)
 164                   << " and " << getQualifiedName(Reg->getDef())
 165                   << " specified multiple times!\n";
 166       RegisterAliases[R].insert(Reg->getDef());
 167
 168       if (RegisterAliases[Reg->getDef()].count(R))
 169         std::cerr << "Warning: register alias between " << getQualifiedName(R)
 170                   << " and " << getQualifiedName(Reg->getDef())
 171                   << " specified multiple times!\n";
 172       RegisterAliases[Reg->getDef()].insert(R);
 173     }
 174   }
 175
 176   if (!RegisterAliases.empty())
 177     OS << "\n\n  // Register Alias Sets...\n";
 178
 179   // Emit the empty alias list
 180   OS << "  const unsigned Empty_AliasSet[] = { 0 };\n";
 181   // Loop over all of the registers which have aliases, emitting the alias list
 182   // to memory.
 183   for (std::map<Record*, std::set<Record*> >::iterator
 184          I = RegisterAliases.begin(), E = RegisterAliases.end(); I != E; ++I) {
 185     OS << "  const unsigned " << I->first->getName() << "_AliasSet[] = { ";
 186     for (std::set<Record*>::iterator ASI = I->second.begin(),
 187            E = I->second.end(); ASI != E; ++ASI)
 188       OS << getQualifiedName(*ASI) << ", ";
 189     OS << "0 };\n";
 190   }
 191
 192   OS << "\n  const MRegisterDesc RegisterDescriptors[] = { // Descriptors\n";
 193   OS << "    { \"NOREG\",\t0,\t\t0,\t0 },\n";
 194   // Now that register alias sets have been emitted, emit the register
 195   // descriptors now.
 196   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
 197     Record *Reg = Registers[i];
 198     OS << "    { \"";
 199     if (!Reg->getValueAsString("Name").empty())
 200       OS << Reg->getValueAsString("Name");
 201     else
 202       OS << Reg->getName();
 203     OS << "\",\t";
 204     if (RegisterAliases.count(Reg))
 205       OS << Reg->getName() << "_AliasSet,\t";
 206     else
 207       OS << "Empty_AliasSet,\t";
 208     OS << "0, 0 },\n";
 209   }
 210   OS << "  };\n";      // End of register descriptors...
 211   OS << "}\n\n";       // End of anonymous namespace...
 212
 213   CodeGenTarget Target;
 214
 215   OS << "namespace " << Target.getName() << " { // Register classes\n";
 216   for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
 217     if (RegisterClasses[i]->getValueAsBit("isDummyClass"))
 218       continue; // Ignore dummies
 219
 220     const std::string &Name = RegisterClasses[i]->getName();
 221     if (Name.size() < 9 || Name[9] != '.')    // Ignore anonymous classes
 222       OS << "  TargetRegisterClass *" << Name << "RegisterClass = &"
 223          << Name << "Instance;\n";
 224   }
 225   OS << "} // end of namespace " << Target.getName() << "\n\n";
 226
 227
 228
 229   std::string ClassName = Target.getName() + "GenRegisterInfo";
 230
 231   // Emit the constructor of the class...
 232   OS << ClassName << "::" << ClassName
 233      << "(int CallFrameSetupOpcode, int CallFrameDestroyOpcode)\n"
 234      << "  : MRegisterInfo(RegisterDescriptors, " << Registers.size()+1
 235      << ", RegisterClasses, RegisterClasses+" << RegClassNames.size() << ",\n "
 236      << "                 CallFrameSetupOpcode, CallFrameDestroyOpcode) {}\n\n";
 237
 238   // Emit the getCalleeSaveRegs method...
 239   OS << "const unsigned* " << ClassName << "::getCalleeSaveRegs() const {\n"
 240      << "  static const unsigned CalleeSaveRegs[] = {\n    ";
 241
 242   const std::vector<Record*> &CSR = Target.getCalleeSavedRegisters();
 243   for (unsigned i = 0, e = CSR.size(); i != e; ++i)
 244     OS << getQualifiedName(CSR[i]) << ", ";
 245   OS << " 0\n  };\n  return CalleeSaveRegs;\n}\n\n";
 246   EmitSourceFileTail(OS);
 247 }