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