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     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
  78   EmitSourceFileHeader("Register Information Source Fragment", OS);
  79
  80   // Start out by emitting each of the register classes... to do this, we build
  81   // a set of registers which belong to a register class, this is to ensure that
  82   // each register is only in a single register class.
  83   //
  84   std::vector<Record*> RegisterClasses =
  85     Records.getAllDerivedDefinitions("RegisterClass");
  86
  87   std::vector<Record*> Registers = Records.getAllDerivedDefinitions("Register");
  88
  89   std::set<Record*> RegistersFound;
  90   std::vector<std::string> RegClassNames;
  91
  92   // Loop over all of the register classes... emitting each one.
  93   OS << "namespace {     // Register classes...\n";
  94
  95   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
  96     Record *RC = RegisterClasses[rc];
  97
  98     std::string Name = RC->getName();
  99     if (Name.size() > 9 && Name[9] == '.') {
 100       static unsigned AnonCounter = 0;
 101       Name = "AnonRegClass_"+utostr(AnonCounter++);
 102     }
 103
 104     RegClassNames.push_back(Name);
 105
 106     // Emit the register list now...
 107     OS << "  // " << Name << " Register Class...\n  const unsigned " << Name
 108        << "[] = {\n    ";
 109     ListInit *RegList = RC->getValueAsListInit("MemberList");
 110     for (unsigned i = 0, e = RegList->getSize(); i != e; ++i) {
 111       DefInit *RegDef = dynamic_cast<DefInit*>(RegList->getElement(i));
 112       if (!RegDef) throw "Register class member is not a record!";
 113       Record *Reg = RegDef->getDef();
 114       if (!Reg->isSubClassOf("Register"))
 115         throw "Register Class member '" + Reg->getName() +
 116               " does not derive from the Register class!";
 117       if (RegistersFound.count(Reg))
 118         throw "Register '" + Reg->getName() +
 119               "' included in multiple register classes!";
 120       RegistersFound.insert(Reg);
 121       OS << getQualifiedName(Reg) << ", ";
 122     }
 123     OS << "\n  };\n\n";
 124
 125     OS << "  struct " << Name << "Class : public TargetRegisterClass {\n"
 126        << "    " << Name << "Class() : TargetRegisterClass("
 127        << RC->getValueAsInt("Size")/8 << ", " << RC->getValueAsInt("Alignment")
 128        << ", " << Name << ", " << Name << " + " << RegList->getSize()
 129        << ") {}\n";
 130
 131     if (CodeInit *CI = dynamic_cast<CodeInit*>(RC->getValueInit("Methods")))
 132       OS << CI->getValue();
 133     else
 134       throw "Expected 'code' fragment for 'Methods' value in register class '"+
 135             RC->getName() + "'!";
 136
 137     OS << "  } " << Name << "Instance;\n\n";
 138   }
 139
 140   OS << "  const TargetRegisterClass* const RegisterClasses[] = {\n";
 141   for (unsigned i = 0, e = RegClassNames.size(); i != e; ++i)
 142     OS << "    &" << RegClassNames[i] << "Instance,\n";
 143   OS << "  };\n";
 144
 145   // Emit register class aliases...
 146   std::vector<Record*> RegisterAliasesRecs =
 147     Records.getAllDerivedDefinitions("RegisterAliases");
 148   std::map<Record*, std::set<Record*> > RegisterAliases;
 149
 150   for (unsigned i = 0, e = RegisterAliasesRecs.size(); i != e; ++i) {
 151     Record *AS = RegisterAliasesRecs[i];
 152     Record *R = AS->getValueAsDef("Reg");
 153     ListInit *LI = AS->getValueAsListInit("Aliases");
 154
 155     // Add information that R aliases all of the elements in the list... and
 156     // that everything in the list aliases R.
 157     for (unsigned j = 0, e = LI->getSize(); j != e; ++j) {
 158       DefInit *Reg = dynamic_cast<DefInit*>(LI->getElement(j));
 159       if (!Reg) throw "ERROR: Alias list element is not a def!";
 160       if (RegisterAliases[R].count(Reg->getDef()))
 161         std::cerr << "Warning: register alias between " << getQualifiedName(R)
 162                   << " and " << getQualifiedName(Reg->getDef())
 163                   << " specified multiple times!\n";
 164       RegisterAliases[R].insert(Reg->getDef());
 165
 166       if (RegisterAliases[Reg->getDef()].count(R))
 167         std::cerr << "Warning: register alias between " << getQualifiedName(R)
 168                   << " and " << getQualifiedName(Reg->getDef())
 169                   << " specified multiple times!\n";
 170       RegisterAliases[Reg->getDef()].insert(R);
 171     }
 172   }
 173
 174   if (!RegisterAliases.empty())
 175     OS << "\n\n  // Register Alias Sets...\n";
 176
 177   // Emit the empty alias list
 178   OS << "  const unsigned Empty_AliasSet[] = { 0 };\n";
 179   // Loop over all of the registers which have aliases, emitting the alias list
 180   // to memory.
 181   for (std::map<Record*, std::set<Record*> >::iterator
 182          I = RegisterAliases.begin(), E = RegisterAliases.end(); I != E; ++I) {
 183     OS << "  const unsigned " << I->first->getName() << "_AliasSet[] = { ";
 184     for (std::set<Record*>::iterator ASI = I->second.begin(),
 185            E = I->second.end(); ASI != E; ++ASI)
 186       OS << getQualifiedName(*ASI) << ", ";
 187     OS << "0 };\n";
 188   }
 189
 190   OS << "\n  const MRegisterDesc RegisterDescriptors[] = { // Descriptors\n";
 191   OS << "    { \"NOREG\",\t0,\t\t0,\t0 },\n";
 192   // Now that register alias sets have been emitted, emit the register
 193   // descriptors now.
 194   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
 195     Record *Reg = Registers[i];
 196     OS << "    { \"";
 197     if (!Reg->getValueAsString("Name").empty())
 198       OS << Reg->getValueAsString("Name");
 199     else
 200       OS << Reg->getName();
 201     OS << "\",\t";
 202     if (RegisterAliases.count(Reg))
 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 }