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