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