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