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 "CodeGenTarget.h"
  18 #include "CodeGenRegisters.h"
  19 #include "Record.h"
  20 #include "llvm/ADT/StringExtras.h"
  21 #include "llvm/ADT/STLExtras.h"
  22 #include <set>
  23 using namespace llvm;
  24
  25 // runEnums - Print out enum values for all of the registers.
  26 void RegisterInfoEmitter::runEnums(std::ostream &OS) {
  27   CodeGenTarget Target;
  28   const std::vector<CodeGenRegister> &Registers = Target.getRegisters();
  29
  30   std::string Namespace = Registers[0].TheDef->getValueAsString("Namespace");
  31
  32   EmitSourceFileHeader("Target Register Enum Values", OS);
  33   OS << "namespace llvm {\n\n";
  34
  35   if (!Namespace.empty())
  36     OS << "namespace " << Namespace << " {\n";
  37   OS << "  enum {\n    NoRegister,\n";
  38
  39   for (unsigned i = 0, e = Registers.size(); i != e; ++i)
  40     OS << "    " << Registers[i].getName() << ", \t// " << i+1 << "\n";
  41
  42   OS << "  };\n";
  43   if (!Namespace.empty())
  44     OS << "}\n";
  45   OS << "} // End llvm namespace \n";
  46 }
  47
  48 void RegisterInfoEmitter::runHeader(std::ostream &OS) {
  49   EmitSourceFileHeader("Register Information Header Fragment", OS);
  50   CodeGenTarget Target;
  51   const std::string &TargetName = Target.getName();
  52   std::string ClassName = TargetName + "GenRegisterInfo";
  53
  54   OS << "#include \"llvm/Target/MRegisterInfo.h\"\n\n";
  55
  56   OS << "namespace llvm {\n\n";
  57
  58   OS << "struct " << ClassName << " : public MRegisterInfo {\n"
  59      << "  " << ClassName
  60      << "(int CallFrameSetupOpcode = -1, int CallFrameDestroyOpcode = -1);\n"
  61      << "  const unsigned* getCalleeSaveRegs() const;\n"
  62      << "const TargetRegisterClass* const *getCalleeSaveRegClasses() const;\n"
  63      << "};\n\n";
  64
  65   const std::vector<CodeGenRegisterClass> &RegisterClasses =
  66     Target.getRegisterClasses();
  67
  68   if (!RegisterClasses.empty()) {
  69     OS << "namespace " << RegisterClasses[0].Namespace
  70        << " { // Register classes\n";
  71     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
  72       const std::string &Name = RegisterClasses[i].getName();
  73
  74       // Output the register class definition.
  75       OS << "  struct " << Name << "Class : public TargetRegisterClass {\n"
  76          << "    " << Name << "Class();\n"
  77          << RegisterClasses[i].MethodProtos << "  };\n";
  78
  79       // Output the extern for the instance.
  80       OS << "  extern " << Name << "Class\t" << Name << "RegClass;\n";
  81       // Output the extern for the pointer to the instance (should remove).
  82       OS << "  static TargetRegisterClass * const "<< Name <<"RegisterClass = &"
  83          << Name << "RegClass;\n";
  84     }
  85     OS << "} // end of namespace " << TargetName << "\n\n";
  86   }
  87   OS << "} // End llvm namespace \n";
  88 }
  89
  90 // RegisterInfoEmitter::run - Main register file description emitter.
  91 //
  92 void RegisterInfoEmitter::run(std::ostream &OS) {
  93   CodeGenTarget Target;
  94   EmitSourceFileHeader("Register Information Source Fragment", OS);
  95
  96   OS << "namespace llvm {\n\n";
  97
  98   // Start out by emitting each of the register classes... to do this, we build
  99   // a set of registers which belong to a register class, this is to ensure that
 100   // each register is only in a single register class.
 101   //
 102   const std::vector<CodeGenRegisterClass> &RegisterClasses =
 103     Target.getRegisterClasses();
 104
 105   // Loop over all of the register classes... emitting each one.
 106   OS << "namespace {     // Register classes...\n";
 107
 108   // RegClassesBelongedTo - Keep track of which register classes each reg
 109   // belongs to.
 110   std::multimap<Record*, const CodeGenRegisterClass*> RegClassesBelongedTo;
 111
 112   // Emit the register enum value arrays for each RegisterClass
 113   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
 114     const CodeGenRegisterClass &RC = RegisterClasses[rc];
 115
 116     // Give the register class a legal C name if it's anonymous.
 117     std::string Name = RC.TheDef->getName();
 118
 119     // Emit the register list now.
 120     OS << "  // " << Name << " Register Class...\n  const unsigned " << Name
 121        << "[] = {\n    ";
 122     for (unsigned i = 0, e = RC.Elements.size(); i != e; ++i) {
 123       Record *Reg = RC.Elements[i];
 124       OS << getQualifiedName(Reg) << ", ";
 125
 126       // Keep track of which regclasses this register is in.
 127       RegClassesBelongedTo.insert(std::make_pair(Reg, &RC));
 128     }
 129     OS << "\n  };\n\n";
 130   }
 131
 132   // Emit the ValueType arrays for each RegisterClass
 133   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
 134     const CodeGenRegisterClass &RC = RegisterClasses[rc];
 135
 136     // Give the register class a legal C name if it's anonymous.
 137     std::string Name = RC.TheDef->getName() + "VTs";
 138
 139     // Emit the register list now.
 140     OS << "  // " << Name
 141       << " Register Class Value Types...\n  const MVT::ValueType " << Name
 142       << "[] = {\n    ";
 143     for (unsigned i = 0, e = RC.VTs.size(); i != e; ++i)
 144       OS << "MVT::" << RC.VTs[i] << ", ";
 145     OS << "MVT::Other\n  };\n\n";
 146   }
 147   OS << "}  // end anonymous namespace\n\n";
 148
 149   // Now that all of the structs have been emitted, emit the instances.
 150   if (!RegisterClasses.empty()) {
 151     OS << "namespace " << RegisterClasses[0].Namespace
 152        << " {   // Register class instances\n";
 153     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i)
 154       OS << "  " << RegisterClasses[i].getName()  << "Class\t"
 155          << RegisterClasses[i].getName() << "RegClass;\n";
 156
 157     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
 158       const CodeGenRegisterClass &RC = RegisterClasses[i];
 159       OS << RC.MethodBodies << "\n";
 160       OS << RC.getName() << "Class::" << RC.getName()
 161          << "Class()  : TargetRegisterClass(" << RC.getName() + "VTs" << ", "
 162          << RC.SpillSize/8 << ", "
 163          << RC.SpillAlignment/8 << ", " << RC.getName() << ", "
 164          << RC.getName() << " + " << RC.Elements.size() << ") {}\n";
 165     }
 166
 167     OS << "}\n";
 168   }
 169
 170   OS << "\nnamespace {\n";
 171   OS << "  const TargetRegisterClass* const RegisterClasses[] = {\n";
 172   for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i)
 173     OS << "    &" << getQualifiedName(RegisterClasses[i].TheDef)
 174        << "RegClass,\n";
 175   OS << "  };\n";
 176
 177   // Emit register class aliases...
 178   std::map<Record*, std::set<Record*> > RegisterAliases;
 179   const std::vector<CodeGenRegister> &Regs = Target.getRegisters();
 180
 181   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 182     Record *R = Regs[i].TheDef;
 183     std::vector<Record*> LI = Regs[i].TheDef->getValueAsListOfDefs("Aliases");
 184     // Add information that R aliases all of the elements in the list... and
 185     // that everything in the list aliases R.
 186     for (unsigned j = 0, e = LI.size(); j != e; ++j) {
 187       Record *Reg = LI[j];
 188       if (RegisterAliases[R].count(Reg))
 189         std::cerr << "Warning: register alias between " << getQualifiedName(R)
 190                   << " and " << getQualifiedName(Reg)
 191                   << " specified multiple times!\n";
 192       RegisterAliases[R].insert(Reg);
 193
 194       if (RegisterAliases[Reg].count(R))
 195         std::cerr << "Warning: register alias between " << getQualifiedName(R)
 196                   << " and " << getQualifiedName(Reg)
 197                   << " specified multiple times!\n";
 198       RegisterAliases[Reg].insert(R);
 199     }
 200   }
 201
 202   if (!RegisterAliases.empty())
 203     OS << "\n\n  // Register Alias Sets...\n";
 204
 205   // Emit the empty alias list
 206   OS << "  const unsigned Empty_AliasSet[] = { 0 };\n";
 207   // Loop over all of the registers which have aliases, emitting the alias list
 208   // to memory.
 209   for (std::map<Record*, std::set<Record*> >::iterator
 210          I = RegisterAliases.begin(), E = RegisterAliases.end(); I != E; ++I) {
 211     OS << "  const unsigned " << I->first->getName() << "_AliasSet[] = { ";
 212     for (std::set<Record*>::iterator ASI = I->second.begin(),
 213            E = I->second.end(); ASI != E; ++ASI)
 214       OS << getQualifiedName(*ASI) << ", ";
 215     OS << "0 };\n";
 216   }
 217
 218   OS<<"\n  const TargetRegisterDesc RegisterDescriptors[] = { // Descriptors\n";
 219   OS << "    { \"NOREG\",\t0 },\n";
 220
 221
 222   // Now that register alias sets have been emitted, emit the register
 223   // descriptors now.
 224   const std::vector<CodeGenRegister> &Registers = Target.getRegisters();
 225   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
 226     const CodeGenRegister &Reg = Registers[i];
 227     OS << "    { \"";
 228     if (!Reg.TheDef->getValueAsString("Name").empty())
 229       OS << Reg.TheDef->getValueAsString("Name");
 230     else
 231       OS << Reg.getName();
 232     OS << "\",\t";
 233     if (RegisterAliases.count(Reg.TheDef))
 234       OS << Reg.getName() << "_AliasSet },\n";
 235     else
 236       OS << "Empty_AliasSet },\n";
 237   }
 238   OS << "  };\n";      // End of register descriptors...
 239   OS << "}\n\n";       // End of anonymous namespace...
 240
 241   std::string ClassName = Target.getName() + "GenRegisterInfo";
 242
 243   // Emit the constructor of the class...
 244   OS << ClassName << "::" << ClassName
 245      << "(int CallFrameSetupOpcode, int CallFrameDestroyOpcode)\n"
 246      << "  : MRegisterInfo(RegisterDescriptors, " << Registers.size()+1
 247      << ", RegisterClasses, RegisterClasses+" << RegisterClasses.size() <<",\n "
 248      << "                 CallFrameSetupOpcode, CallFrameDestroyOpcode) {}\n\n";
 249
 250   // Emit the getCalleeSaveRegs method.
 251   OS << "const unsigned* " << ClassName << "::getCalleeSaveRegs() const {\n"
 252      << "  static const unsigned CalleeSaveRegs[] = {\n    ";
 253
 254   const std::vector<Record*> &CSR = Target.getCalleeSavedRegisters();
 255   for (unsigned i = 0, e = CSR.size(); i != e; ++i)
 256     OS << getQualifiedName(CSR[i]) << ", ";
 257   OS << " 0\n  };\n  return CalleeSaveRegs;\n}\n\n";
 258
 259   // Emit information about the callee saved register classes.
 260   OS << "const TargetRegisterClass* const*\n" << ClassName
 261      << "::getCalleeSaveRegClasses() const {\n"
 262      << "  static const TargetRegisterClass * const "
 263      << "CalleeSaveRegClasses[] = {\n    ";
 264
 265   for (unsigned i = 0, e = CSR.size(); i != e; ++i) {
 266     Record *R = CSR[i];
 267     std::multimap<Record*, const CodeGenRegisterClass*>::iterator I, E;
 268     tie(I, E) = RegClassesBelongedTo.equal_range(R);
 269     if (I == E)
 270       throw "Callee saved register '" + R->getName() +
 271             "' must belong to a register class for spilling.\n";
 272     const CodeGenRegisterClass *RC = (I++)->second;
 273     for (; I != E; ++I)
 274       if (RC->SpillSize < I->second->SpillSize)
 275         RC = I->second;
 276     OS << "&" << getQualifiedName(RC->TheDef) << "RegClass, ";
 277   }
 278   OS << " 0\n  };\n  return CalleeSaveRegClasses;\n}\n\n";
 279
 280   OS << "} // End llvm namespace \n";
 281 }