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