support/tools/TableGen/RegisterInfoEmitter.cpp

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