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() << (i != (e-1) ? ", \t// " : "  \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";
  55   OS << "#include <string>\n\n";
  56
  57   OS << "namespace llvm {\n\n";
  58
  59   OS << "struct " << ClassName << " : public MRegisterInfo {\n"
  60      << "  " << ClassName
  61      << "(int CallFrameSetupOpcode = -1, int CallFrameDestroyOpcode = -1);\n"
  62      << "  int getDwarfRegNum(unsigned RegNum) 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 bool isSubRegisterClass(const CodeGenRegisterClass &RC,
  91                         std::set<Record*> &RegSet) {
  92   for (unsigned i = 0, e = RC.Elements.size(); i != e; ++i) {
  93     Record *Reg = RC.Elements[i];
  94     if (!RegSet.count(Reg))
  95       return false;
  96   }
  97   return true;
  98 }
  99
 100 // RegisterInfoEmitter::run - Main register file description emitter.
 101 //
 102 void RegisterInfoEmitter::run(std::ostream &OS) {
 103   CodeGenTarget Target;
 104   EmitSourceFileHeader("Register Information Source Fragment", OS);
 105
 106   OS << "namespace llvm {\n\n";
 107
 108   // Start out by emitting each of the register classes... to do this, we build
 109   // a set of registers which belong to a register class, this is to ensure that
 110   // each register is only in a single register class.
 111   //
 112   const std::vector<CodeGenRegisterClass> &RegisterClasses =
 113     Target.getRegisterClasses();
 114
 115   // Loop over all of the register classes... emitting each one.
 116   OS << "namespace {     // Register classes...\n";
 117
 118   // RegClassesBelongedTo - Keep track of which register classes each reg
 119   // belongs to.
 120   std::multimap<Record*, const CodeGenRegisterClass*> RegClassesBelongedTo;
 121
 122   // Emit the register enum value arrays for each RegisterClass
 123   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
 124     const CodeGenRegisterClass &RC = RegisterClasses[rc];
 125
 126     // Give the register class a legal C name if it's anonymous.
 127     std::string Name = RC.TheDef->getName();
 128
 129     // Emit the register list now.
 130     OS << "  // " << Name << " Register Class...\n  const unsigned " << Name
 131        << "[] = {\n    ";
 132     for (unsigned i = 0, e = RC.Elements.size(); i != e; ++i) {
 133       Record *Reg = RC.Elements[i];
 134       OS << getQualifiedName(Reg) << ", ";
 135
 136       // Keep track of which regclasses this register is in.
 137       RegClassesBelongedTo.insert(std::make_pair(Reg, &RC));
 138     }
 139     OS << "\n  };\n\n";
 140   }
 141
 142   // Emit the ValueType arrays for each RegisterClass
 143   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
 144     const CodeGenRegisterClass &RC = RegisterClasses[rc];
 145
 146     // Give the register class a legal C name if it's anonymous.
 147     std::string Name = RC.TheDef->getName() + "VTs";
 148
 149     // Emit the register list now.
 150     OS << "  // " << Name
 151       << " Register Class Value Types...\n  const MVT::ValueType " << Name
 152       << "[] = {\n    ";
 153     for (unsigned i = 0, e = RC.VTs.size(); i != e; ++i)
 154       OS << RC.VTs[i] << ", ";
 155     OS << "MVT::Other\n  };\n\n";
 156   }
 157   OS << "}  // end anonymous namespace\n\n";
 158
 159   // Now that all of the structs have been emitted, emit the instances.
 160   if (!RegisterClasses.empty()) {
 161     OS << "namespace " << RegisterClasses[0].Namespace
 162        << " {   // Register class instances\n";
 163     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i)
 164       OS << "  " << RegisterClasses[i].getName()  << "Class\t"
 165          << RegisterClasses[i].getName() << "RegClass;\n";
 166
 167     std::map<unsigned, std::set<unsigned> > SuperClassMap;
 168     OS << "\n";
 169     // Emit the sub-classes array for each RegisterClass
 170     for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
 171       const CodeGenRegisterClass &RC = RegisterClasses[rc];
 172
 173       // Give the register class a legal C name if it's anonymous.
 174       std::string Name = RC.TheDef->getName();
 175
 176       std::set<Record*> RegSet;
 177       for (unsigned i = 0, e = RC.Elements.size(); i != e; ++i) {
 178         Record *Reg = RC.Elements[i];
 179         RegSet.insert(Reg);
 180       }
 181
 182       OS << "  // " << Name
 183          << " Register Class sub-classes...\n  const TargetRegisterClass* "
 184          << Name << "Subclasses [] = {\n    ";
 185
 186       bool Empty = true;
 187       for (unsigned rc2 = 0, e2 = RegisterClasses.size(); rc2 != e2; ++rc2) {
 188         const CodeGenRegisterClass &RC2 = RegisterClasses[rc2];
 189         if (rc == rc2 || RC2.Elements.size() > RC.Elements.size() ||
 190             RC.SpillSize != RC2.SpillSize || !isSubRegisterClass(RC2, RegSet))
 191           continue;
 192
 193         if (!Empty) OS << ", ";
 194         OS << "&" << getQualifiedName(RC2.TheDef) << "RegClass";
 195         Empty = false;
 196
 197         std::map<unsigned, std::set<unsigned> >::iterator SCMI =
 198           SuperClassMap.find(rc2);
 199         if (SCMI == SuperClassMap.end()) {
 200           SuperClassMap.insert(std::make_pair(rc2, std::set<unsigned>()));
 201           SCMI = SuperClassMap.find(rc2);
 202         }
 203         SCMI->second.insert(rc);
 204       }
 205
 206       OS << (!Empty ? ", " : "") << "NULL";
 207       OS << "\n  };\n\n";
 208     }
 209
 210     for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
 211       const CodeGenRegisterClass &RC = RegisterClasses[rc];
 212
 213       // Give the register class a legal C name if it's anonymous.
 214       std::string Name = RC.TheDef->getName();
 215
 216       OS << "  // " << Name
 217          << " Register Class super-classes...\n  const TargetRegisterClass* "
 218          << Name << "Superclasses [] = {\n    ";
 219
 220       bool Empty = true;
 221       std::map<unsigned, std::set<unsigned> >::iterator I =
 222         SuperClassMap.find(rc);
 223       if (I != SuperClassMap.end()) {
 224         for (std::set<unsigned>::iterator II = I->second.begin(),
 225                EE = I->second.end(); II != EE; ++II) {
 226           const CodeGenRegisterClass &RC2 = RegisterClasses[*II];
 227           if (!Empty) OS << ", ";
 228           OS << "&" << getQualifiedName(RC2.TheDef) << "RegClass";
 229           Empty = false;
 230         }
 231       }
 232
 233       OS << (!Empty ? ", " : "") << "NULL";
 234       OS << "\n  };\n\n";
 235     }
 236
 237
 238     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
 239       const CodeGenRegisterClass &RC = RegisterClasses[i];
 240       OS << RC.MethodBodies << "\n";
 241       OS << RC.getName() << "Class::" << RC.getName()
 242          << "Class()  : TargetRegisterClass("
 243          << RC.getName() + "VTs" << ", "
 244          << RC.getName() + "Subclasses" << ", "
 245          << RC.getName() + "Superclasses" << ", "
 246          << RC.SpillSize/8 << ", "
 247          << RC.SpillAlignment/8 << ", " << RC.getName() << ", "
 248          << RC.getName() << " + " << RC.Elements.size() << ") {}\n";
 249     }
 250
 251     OS << "}\n";
 252   }
 253
 254   OS << "\nnamespace {\n";
 255   OS << "  const TargetRegisterClass* const RegisterClasses[] = {\n";
 256   for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i)
 257     OS << "    &" << getQualifiedName(RegisterClasses[i].TheDef)
 258        << "RegClass,\n";
 259   OS << "  };\n";
 260
 261   // Emit register class aliases...
 262   std::map<Record*, std::set<Record*> > RegisterAliases;
 263   const std::vector<CodeGenRegister> &Regs = Target.getRegisters();
 264
 265   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 266     Record *R = Regs[i].TheDef;
 267     std::vector<Record*> LI = Regs[i].TheDef->getValueAsListOfDefs("Aliases");
 268     // Add information that R aliases all of the elements in the list... and
 269     // that everything in the list aliases R.
 270     for (unsigned j = 0, e = LI.size(); j != e; ++j) {
 271       Record *Reg = LI[j];
 272       if (RegisterAliases[R].count(Reg))
 273         std::cerr << "Warning: register alias between " << getQualifiedName(R)
 274                   << " and " << getQualifiedName(Reg)
 275                   << " specified multiple times!\n";
 276       RegisterAliases[R].insert(Reg);
 277
 278       if (RegisterAliases[Reg].count(R))
 279         std::cerr << "Warning: register alias between " << getQualifiedName(R)
 280                   << " and " << getQualifiedName(Reg)
 281                   << " specified multiple times!\n";
 282       RegisterAliases[Reg].insert(R);
 283     }
 284   }
 285
 286   if (!RegisterAliases.empty())
 287     OS << "\n\n  // Register Alias Sets...\n";
 288
 289   // Emit the empty alias list
 290   OS << "  const unsigned Empty_AliasSet[] = { 0 };\n";
 291   // Loop over all of the registers which have aliases, emitting the alias list
 292   // to memory.
 293   for (std::map<Record*, std::set<Record*> >::iterator
 294          I = RegisterAliases.begin(), E = RegisterAliases.end(); I != E; ++I) {
 295     OS << "  const unsigned " << I->first->getName() << "_AliasSet[] = { ";
 296     for (std::set<Record*>::iterator ASI = I->second.begin(),
 297            E = I->second.end(); ASI != E; ++ASI)
 298       OS << getQualifiedName(*ASI) << ", ";
 299     OS << "0 };\n";
 300   }
 301
 302   OS<<"\n  const TargetRegisterDesc RegisterDescriptors[] = { // Descriptors\n";
 303   OS << "    { \"NOREG\",\t0 },\n";
 304
 305
 306   // Now that register alias sets have been emitted, emit the register
 307   // descriptors now.
 308   const std::vector<CodeGenRegister> &Registers = Target.getRegisters();
 309   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
 310     const CodeGenRegister &Reg = Registers[i];
 311     OS << "    { \"";
 312     if (!Reg.TheDef->getValueAsString("Name").empty())
 313       OS << Reg.TheDef->getValueAsString("Name");
 314     else
 315       OS << Reg.getName();
 316     OS << "\",\t";
 317     if (RegisterAliases.count(Reg.TheDef))
 318       OS << Reg.getName() << "_AliasSet },\n";
 319     else
 320       OS << "Empty_AliasSet },\n";
 321   }
 322   OS << "  };\n";      // End of register descriptors...
 323   OS << "}\n\n";       // End of anonymous namespace...
 324
 325   std::string ClassName = Target.getName() + "GenRegisterInfo";
 326
 327   // Emit the constructor of the class...
 328   OS << ClassName << "::" << ClassName
 329      << "(int CallFrameSetupOpcode, int CallFrameDestroyOpcode)\n"
 330      << "  : MRegisterInfo(RegisterDescriptors, " << Registers.size()+1
 331      << ", RegisterClasses, RegisterClasses+" << RegisterClasses.size() <<",\n "
 332      << "                 CallFrameSetupOpcode, CallFrameDestroyOpcode) {}\n\n";
 333
 334   // Emit information about the dwarf register numbers.
 335   OS << "int " << ClassName << "::getDwarfRegNum(unsigned RegNum) const {\n";
 336   OS << "  static const int DwarfRegNums[] = { -1, // NoRegister";
 337   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
 338     if (!(i % 16)) OS << "\n    ";
 339     const CodeGenRegister &Reg = Registers[i];
 340     int DwarfRegNum = Reg.TheDef->getValueAsInt("DwarfNumber");
 341     OS << DwarfRegNum;
 342     if ((i + 1) != e)  OS << ", ";
 343   }
 344   OS << "\n  };\n";
 345   OS << "  assert(RegNum < (sizeof(DwarfRegNums)/sizeof(int)) &&\n";
 346   OS << "         \"RegNum exceeds number of registers\");\n";
 347   OS << "  return DwarfRegNums[RegNum];\n";
 348   OS << "}\n\n";
 349
 350   OS << "} // End llvm namespace \n";
 351 }