utils/TableGen/RegisterInfoEmitter.cpp

   1 //===- RegisterInfoEmitter.cpp - Generate a Register File Desc. -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // 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 <algorithm>
  23 #include <set>
  24 using namespace llvm;
  25
  26 // runEnums - Print out enum values for all of the registers.
  27 void RegisterInfoEmitter::runEnums(raw_ostream &OS) {
  28   CodeGenTarget Target(Records);
  29   const std::vector<CodeGenRegister> &Registers = Target.getRegisters();
  30
  31   std::string Namespace = Registers[0].TheDef->getValueAsString("Namespace");
  32
  33   EmitSourceFileHeader("Target Register Enum Values", OS);
  34   OS << "namespace llvm {\n\n";
  35
  36   if (!Namespace.empty())
  37     OS << "namespace " << Namespace << " {\n";
  38   OS << "enum {\n  NoRegister,\n";
  39
  40   for (unsigned i = 0, e = Registers.size(); i != e; ++i)
  41     OS << "  " << Registers[i].getName() << " = " <<
  42       Registers[i].EnumValue << ",\n";
  43   assert(Registers.size() == Registers[Registers.size()-1].EnumValue &&
  44          "Register enum value mismatch!");
  45   OS << "  NUM_TARGET_REGS \t// " << Registers.size()+1 << "\n";
  46   OS << "};\n";
  47   if (!Namespace.empty())
  48     OS << "}\n";
  49
  50   const std::vector<Record*> SubRegIndices = Target.getSubRegIndices();
  51   if (!SubRegIndices.empty()) {
  52     OS << "\n// Subregister indices\n";
  53     Namespace = SubRegIndices[0]->getValueAsString("Namespace");
  54     if (!Namespace.empty())
  55       OS << "namespace " << Namespace << " {\n";
  56     OS << "enum {\n  NoSubRegister,\n";
  57     for (unsigned i = 0, e = SubRegIndices.size(); i != e; ++i)
  58       OS << "  " << SubRegIndices[i]->getName() << ",\t// " << i+1 << "\n";
  59     OS << "  NUM_TARGET_NAMED_SUBREGS = " << SubRegIndices.size()+1 << "\n";
  60     OS << "};\n";
  61     if (!Namespace.empty())
  62       OS << "}\n";
  63   }
  64   OS << "} // End llvm namespace \n";
  65 }
  66
  67 void RegisterInfoEmitter::runHeader(raw_ostream &OS) {
  68   EmitSourceFileHeader("Register Information Header Fragment", OS);
  69   CodeGenTarget Target(Records);
  70   const std::string &TargetName = Target.getName();
  71   std::string ClassName = TargetName + "GenRegisterInfo";
  72
  73   OS << "#include \"llvm/Target/TargetRegisterInfo.h\"\n";
  74   OS << "#include <string>\n\n";
  75
  76   OS << "namespace llvm {\n\n";
  77
  78   OS << "struct " << ClassName << " : public TargetRegisterInfo {\n"
  79      << "  explicit " << ClassName
  80      << "(int CallFrameSetupOpcode = -1, int CallFrameDestroyOpcode = -1);\n"
  81      << "  virtual int getDwarfRegNumFull(unsigned RegNum, "
  82      << "unsigned Flavour) const;\n"
  83      << "  virtual int getDwarfRegNum(unsigned RegNum, bool isEH) const = 0;\n"
  84      << "  virtual bool needsStackRealignment(const MachineFunction &) const\n"
  85      << "     { return false; }\n"
  86      << "  unsigned getSubReg(unsigned RegNo, unsigned Index) const;\n"
  87      << "  unsigned getSubRegIndex(unsigned RegNo, unsigned SubRegNo) const;\n"
  88      << "  unsigned composeSubRegIndices(unsigned, unsigned) const;\n"
  89      << "};\n\n";
  90
  91   const std::vector<CodeGenRegisterClass> &RegisterClasses =
  92     Target.getRegisterClasses();
  93
  94   if (!RegisterClasses.empty()) {
  95     OS << "namespace " << RegisterClasses[0].Namespace
  96        << " { // Register classes\n";
  97
  98     OS << "  enum {\n";
  99     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
 100       if (i) OS << ",\n";
 101       OS << "    " << RegisterClasses[i].getName() << "RegClassID";
 102       OS << " = " << i;
 103     }
 104     OS << "\n  };\n\n";
 105
 106     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
 107       const std::string &Name = RegisterClasses[i].getName();
 108
 109       // Output the register class definition.
 110       OS << "  struct " << Name << "Class : public TargetRegisterClass {\n"
 111          << "    " << Name << "Class();\n"
 112          << RegisterClasses[i].MethodProtos << "  };\n";
 113
 114       // Output the extern for the instance.
 115       OS << "  extern " << Name << "Class\t" << Name << "RegClass;\n";
 116       // Output the extern for the pointer to the instance (should remove).
 117       OS << "  static TargetRegisterClass * const "<< Name <<"RegisterClass = &"
 118          << Name << "RegClass;\n";
 119     }
 120     OS << "} // end of namespace " << TargetName << "\n\n";
 121   }
 122   OS << "} // End llvm namespace \n";
 123 }
 124
 125 static void addSuperReg(Record *R, Record *S,
 126                   std::map<Record*, std::set<Record*>, LessRecord> &SubRegs,
 127                   std::map<Record*, std::set<Record*>, LessRecord> &SuperRegs,
 128                   std::map<Record*, std::set<Record*>, LessRecord> &Aliases) {
 129   if (R == S) {
 130     errs() << "Error: recursive sub-register relationship between"
 131            << " register " << getQualifiedName(R)
 132            << " and its sub-registers?\n";
 133     abort();
 134   }
 135   if (!SuperRegs[R].insert(S).second)
 136     return;
 137   SubRegs[S].insert(R);
 138   Aliases[R].insert(S);
 139   Aliases[S].insert(R);
 140   if (SuperRegs.count(S))
 141     for (std::set<Record*>::iterator I = SuperRegs[S].begin(),
 142            E = SuperRegs[S].end(); I != E; ++I)
 143       addSuperReg(R, *I, SubRegs, SuperRegs, Aliases);
 144 }
 145
 146 static void addSubSuperReg(Record *R, Record *S,
 147                    std::map<Record*, std::set<Record*>, LessRecord> &SubRegs,
 148                    std::map<Record*, std::set<Record*>, LessRecord> &SuperRegs,
 149                    std::map<Record*, std::set<Record*>, LessRecord> &Aliases) {
 150   if (R == S) {
 151     errs() << "Error: recursive sub-register relationship between"
 152            << " register " << getQualifiedName(R)
 153            << " and its sub-registers?\n";
 154     abort();
 155   }
 156
 157   if (!SubRegs[R].insert(S).second)
 158     return;
 159   addSuperReg(S, R, SubRegs, SuperRegs, Aliases);
 160   Aliases[R].insert(S);
 161   Aliases[S].insert(R);
 162   if (SubRegs.count(S))
 163     for (std::set<Record*>::iterator I = SubRegs[S].begin(),
 164            E = SubRegs[S].end(); I != E; ++I)
 165       addSubSuperReg(R, *I, SubRegs, SuperRegs, Aliases);
 166 }
 167
 168 struct RegisterMaps {
 169   // Map SubRegIndex -> Register
 170   typedef std::map<Record*, Record*, LessRecord> SubRegMap;
 171   // Map Register -> SubRegMap
 172   typedef std::map<Record*, SubRegMap> SubRegMaps;
 173
 174   SubRegMaps SubReg;
 175   SubRegMap &inferSubRegIndices(Record *Reg, CodeGenTarget &);
 176
 177   // Composite SubRegIndex instances.
 178   // Map (SubRegIndex,SubRegIndex) -> SubRegIndex
 179   typedef DenseMap<std::pair<Record*,Record*>,Record*> CompositeMap;
 180   CompositeMap Composite;
 181
 182   // Compute SubRegIndex compositions after inferSubRegIndices has run on all
 183   // registers.
 184   void computeComposites();
 185 };
 186
 187 // Calculate all subregindices for Reg. Loopy subregs cause infinite recursion.
 188 RegisterMaps::SubRegMap &RegisterMaps::inferSubRegIndices(Record *Reg,
 189                                                         CodeGenTarget &Target) {
 190   SubRegMap &SRM = SubReg[Reg];
 191   if (!SRM.empty())
 192     return SRM;
 193   std::vector<Record*> SubRegs = Reg->getValueAsListOfDefs("SubRegs");
 194   std::vector<Record*> Indices = Reg->getValueAsListOfDefs("SubRegIndices");
 195   if (SubRegs.size() != Indices.size())
 196     throw "Register " + Reg->getName() + " SubRegIndices doesn't match SubRegs";
 197
 198   // First insert the direct subregs and make sure they are fully indexed.
 199   for (unsigned i = 0, e = SubRegs.size(); i != e; ++i) {
 200     if (!SRM.insert(std::make_pair(Indices[i], SubRegs[i])).second)
 201       throw "SubRegIndex " + Indices[i]->getName()
 202         + " appears twice in Register " + Reg->getName();
 203     inferSubRegIndices(SubRegs[i], Target);
 204   }
 205
 206   // Keep track of inherited subregs and how they can be reached.
 207   // Register -> (SubRegIndex, SubRegIndex)
 208   typedef std::map<Record*, std::pair<Record*,Record*>, LessRecord> OrphanMap;
 209   OrphanMap Orphans;
 210
 211   // Clone inherited subregs. Here the order is important - earlier subregs take
 212   // precedence.
 213   for (unsigned i = 0, e = SubRegs.size(); i != e; ++i) {
 214     SubRegMap &M = SubReg[SubRegs[i]];
 215     for (SubRegMap::iterator si = M.begin(), se = M.end(); si != se; ++si)
 216       if (!SRM.insert(*si).second)
 217         Orphans[si->second] = std::make_pair(Indices[i], si->first);
 218   }
 219
 220   // Finally process the composites.
 221   ListInit *Comps = Reg->getValueAsListInit("CompositeIndices");
 222   for (unsigned i = 0, e = Comps->size(); i != e; ++i) {
 223     DagInit *Pat = dynamic_cast<DagInit*>(Comps->getElement(i));
 224     if (!Pat)
 225       throw "Invalid dag '" + Comps->getElement(i)->getAsString()
 226         + "' in CompositeIndices";
 227     DefInit *BaseIdxInit = dynamic_cast<DefInit*>(Pat->getOperator());
 228     if (!BaseIdxInit || !BaseIdxInit->getDef()->isSubClassOf("SubRegIndex"))
 229       throw "Invalid SubClassIndex in " + Pat->getAsString();
 230
 231     // Resolve list of subreg indices into R2.
 232     Record *R2 = Reg;
 233     for (DagInit::const_arg_iterator di = Pat->arg_begin(),
 234          de = Pat->arg_end(); di != de; ++di) {
 235       DefInit *IdxInit = dynamic_cast<DefInit*>(*di);
 236       if (!IdxInit || !IdxInit->getDef()->isSubClassOf("SubRegIndex"))
 237         throw "Invalid SubClassIndex in " + Pat->getAsString();
 238       SubRegMap::const_iterator ni = SubReg[R2].find(IdxInit->getDef());
 239       if (ni == SubReg[R2].end())
 240         throw "Composite " + Pat->getAsString() + " refers to bad index in "
 241           + R2->getName();
 242       R2 = ni->second;
 243     }
 244
 245     // Insert composite index. Allow overriding inherited indices etc.
 246     SRM[BaseIdxInit->getDef()] = R2;
 247
 248     // R2 is now directly addressable, no longer an orphan.
 249     Orphans.erase(R2);
 250   }
 251
 252   // Now Orphans contains the inherited subregisters without a direct index.
 253   // Create inferred indexes for all missing entries.
 254   for (OrphanMap::iterator I = Orphans.begin(), E = Orphans.end(); I != E;
 255        ++I) {
 256     Record *&Comp = Composite[I->second];
 257     if (!Comp)
 258       Comp = Target.createSubRegIndex(I->second.first->getName() + "_then_" +
 259                                       I->second.second->getName());
 260     SRM[Comp] = I->first;
 261   }
 262
 263   return SRM;
 264 }
 265
 266 void RegisterMaps::computeComposites() {
 267   for (SubRegMaps::const_iterator sri = SubReg.begin(), sre = SubReg.end();
 268        sri != sre; ++sri) {
 269     Record *Reg1 = sri->first;
 270     const SubRegMap &SRM1 = sri->second;
 271     for (SubRegMap::const_iterator i1 = SRM1.begin(), e1 = SRM1.end();
 272          i1 != e1; ++i1) {
 273       Record *Idx1 = i1->first;
 274       Record *Reg2 = i1->second;
 275       // Ignore identity compositions.
 276       if (Reg1 == Reg2)
 277         continue;
 278       // If Reg2 has no subregs, Idx1 doesn't compose.
 279       if (!SubReg.count(Reg2))
 280         continue;
 281       const SubRegMap &SRM2 = SubReg[Reg2];
 282       // Try composing Idx1 with another SubRegIndex.
 283       for (SubRegMap::const_iterator i2 = SRM2.begin(), e2 = SRM2.end();
 284            i2 != e2; ++i2) {
 285         std::pair<Record*,Record*> IdxPair(Idx1, i2->first);
 286         Record *Reg3 = i2->second;
 287         // OK Reg1:IdxPair == Reg3. Find the index with Reg:Idx == Reg3.
 288         for (SubRegMap::const_iterator i1d = SRM1.begin(), e1d = SRM1.end();
 289              i1d != e1d; ++i1d) {
 290           // Ignore identity compositions.
 291           if (Reg2 == Reg3)
 292             continue;
 293           if (i1d->second == Reg3) {
 294             std::pair<CompositeMap::iterator,bool> Ins =
 295               Composite.insert(std::make_pair(IdxPair, i1d->first));
 296             // Conflicting composition?
 297             if (!Ins.second && Ins.first->second != i1d->first) {
 298               errs() << "Error: SubRegIndex " << getQualifiedName(Idx1)
 299                      << " and " << getQualifiedName(IdxPair.second)
 300                      << " compose ambiguously as "
 301                      << getQualifiedName(Ins.first->second) << " or "
 302                      << getQualifiedName(i1d->first) << "\n";
 303               abort();
 304             }
 305           }
 306         }
 307       }
 308     }
 309   }
 310
 311   // We don't care about the difference between (Idx1, Idx2) -> Idx2 and invalid
 312   // compositions, so remove any mappings of that form.
 313   for (CompositeMap::iterator i = Composite.begin(), e = Composite.end();
 314        i != e;) {
 315     CompositeMap::iterator j = i;
 316     ++i;
 317     if (j->first.second == j->second)
 318       Composite.erase(j);
 319   }
 320 }
 321
 322 class RegisterSorter {
 323 private:
 324   std::map<Record*, std::set<Record*>, LessRecord> &RegisterSubRegs;
 325
 326 public:
 327   RegisterSorter(std::map<Record*, std::set<Record*>, LessRecord> &RS)
 328     : RegisterSubRegs(RS) {}
 329
 330   bool operator()(Record *RegA, Record *RegB) {
 331     // B is sub-register of A.
 332     return RegisterSubRegs.count(RegA) && RegisterSubRegs[RegA].count(RegB);
 333   }
 334 };
 335
 336 // RegisterInfoEmitter::run - Main register file description emitter.
 337 //
 338 void RegisterInfoEmitter::run(raw_ostream &OS) {
 339   CodeGenTarget Target(Records);
 340   EmitSourceFileHeader("Register Information Source Fragment", OS);
 341
 342   OS << "namespace llvm {\n\n";
 343
 344   // Start out by emitting each of the register classes... to do this, we build
 345   // a set of registers which belong to a register class, this is to ensure that
 346   // each register is only in a single register class.
 347   //
 348   const std::vector<CodeGenRegisterClass> &RegisterClasses =
 349     Target.getRegisterClasses();
 350
 351   // Loop over all of the register classes... emitting each one.
 352   OS << "namespace {     // Register classes...\n";
 353
 354   // RegClassesBelongedTo - Keep track of which register classes each reg
 355   // belongs to.
 356   std::multimap<Record*, const CodeGenRegisterClass*> RegClassesBelongedTo;
 357
 358   // Emit the register enum value arrays for each RegisterClass
 359   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
 360     const CodeGenRegisterClass &RC = RegisterClasses[rc];
 361
 362     // Give the register class a legal C name if it's anonymous.
 363     std::string Name = RC.TheDef->getName();
 364
 365     // Emit the register list now.
 366     OS << "  // " << Name << " Register Class...\n"
 367        << "  static const unsigned " << Name
 368        << "[] = {\n    ";
 369     for (unsigned i = 0, e = RC.Elements.size(); i != e; ++i) {
 370       Record *Reg = RC.Elements[i];
 371       OS << getQualifiedName(Reg) << ", ";
 372
 373       // Keep track of which regclasses this register is in.
 374       RegClassesBelongedTo.insert(std::make_pair(Reg, &RC));
 375     }
 376     OS << "\n  };\n\n";
 377   }
 378
 379   // Emit the ValueType arrays for each RegisterClass
 380   for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
 381     const CodeGenRegisterClass &RC = RegisterClasses[rc];
 382
 383     // Give the register class a legal C name if it's anonymous.
 384     std::string Name = RC.TheDef->getName() + "VTs";
 385
 386     // Emit the register list now.
 387     OS << "  // " << Name
 388        << " Register Class Value Types...\n"
 389        << "  static const EVT " << Name
 390        << "[] = {\n    ";
 391     for (unsigned i = 0, e = RC.VTs.size(); i != e; ++i)
 392       OS << getEnumName(RC.VTs[i]) << ", ";
 393     OS << "MVT::Other\n  };\n\n";
 394   }
 395   OS << "}  // end anonymous namespace\n\n";
 396
 397   // Now that all of the structs have been emitted, emit the instances.
 398   if (!RegisterClasses.empty()) {
 399     OS << "namespace " << RegisterClasses[0].Namespace
 400        << " {   // Register class instances\n";
 401     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i)
 402       OS << "  " << RegisterClasses[i].getName()  << "Class\t"
 403          << RegisterClasses[i].getName() << "RegClass;\n";
 404
 405     std::map<unsigned, std::set<unsigned> > SuperClassMap;
 406     std::map<unsigned, std::set<unsigned> > SuperRegClassMap;
 407     OS << "\n";
 408
 409     unsigned NumSubRegIndices = Target.getSubRegIndices().size();
 410
 411     if (NumSubRegIndices) {
 412       // Emit the sub-register classes for each RegisterClass
 413       for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
 414         const CodeGenRegisterClass &RC = RegisterClasses[rc];
 415         std::vector<Record*> SRC(NumSubRegIndices);
 416         for (DenseMap<Record*,Record*>::const_iterator
 417              i = RC.SubRegClasses.begin(),
 418              e = RC.SubRegClasses.end(); i != e; ++i) {
 419           // Build SRC array.
 420           unsigned idx = Target.getSubRegIndexNo(i->first);
 421           SRC.at(idx-1) = i->second;
 422
 423           // Find the register class number of i->second for SuperRegClassMap.
 424           for (unsigned rc2 = 0, e2 = RegisterClasses.size(); rc2 != e2; ++rc2) {
 425             const CodeGenRegisterClass &RC2 =  RegisterClasses[rc2];
 426             if (RC2.TheDef == i->second) {
 427               SuperRegClassMap[rc2].insert(rc);
 428               break;
 429             }
 430           }
 431         }
 432
 433         // Give the register class a legal C name if it's anonymous.
 434         std::string Name = RC.TheDef->getName();
 435
 436         OS << "  // " << Name
 437            << " Sub-register Classes...\n"
 438            << "  static const TargetRegisterClass* const "
 439            << Name << "SubRegClasses[] = {\n    ";
 440
 441         for (unsigned idx = 0; idx != NumSubRegIndices; ++idx) {
 442           if (idx)
 443             OS << ", ";
 444           if (SRC[idx])
 445             OS << "&" << getQualifiedName(SRC[idx]) << "RegClass";
 446           else
 447             OS << "0";
 448         }
 449         OS << "\n  };\n\n";
 450       }
 451
 452       // Emit the super-register classes for each RegisterClass
 453       for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
 454         const CodeGenRegisterClass &RC = RegisterClasses[rc];
 455
 456         // Give the register class a legal C name if it's anonymous.
 457         std::string Name = RC.TheDef->getName();
 458
 459         OS << "  // " << Name
 460            << " Super-register Classes...\n"
 461            << "  static const TargetRegisterClass* const "
 462            << Name << "SuperRegClasses[] = {\n    ";
 463
 464         bool Empty = true;
 465         std::map<unsigned, std::set<unsigned> >::iterator I =
 466           SuperRegClassMap.find(rc);
 467         if (I != SuperRegClassMap.end()) {
 468           for (std::set<unsigned>::iterator II = I->second.begin(),
 469                  EE = I->second.end(); II != EE; ++II) {
 470             const CodeGenRegisterClass &RC2 = RegisterClasses[*II];
 471             if (!Empty)
 472               OS << ", ";
 473             OS << "&" << getQualifiedName(RC2.TheDef) << "RegClass";
 474             Empty = false;
 475           }
 476         }
 477
 478         OS << (!Empty ? ", " : "") << "NULL";
 479         OS << "\n  };\n\n";
 480       }
 481     } else {
 482       // No subregindices in this target
 483       OS << "  static const TargetRegisterClass* const "
 484          << "NullRegClasses[] = { NULL };\n\n";
 485     }
 486
 487     // Emit the sub-classes array for each RegisterClass
 488     for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
 489       const CodeGenRegisterClass &RC = RegisterClasses[rc];
 490
 491       // Give the register class a legal C name if it's anonymous.
 492       std::string Name = RC.TheDef->getName();
 493
 494       OS << "  // " << Name
 495          << " Register Class sub-classes...\n"
 496          << "  static const TargetRegisterClass* const "
 497          << Name << "Subclasses[] = {\n    ";
 498
 499       bool Empty = true;
 500       for (unsigned rc2 = 0, e2 = RegisterClasses.size(); rc2 != e2; ++rc2) {
 501         const CodeGenRegisterClass &RC2 = RegisterClasses[rc2];
 502
 503         // Sub-classes are used to determine if a virtual register can be used
 504         // as an instruction operand, or if it must be copied first.
 505         if (rc == rc2 || !RC.hasSubClass(&RC2)) continue;
 506
 507         if (!Empty) OS << ", ";
 508         OS << "&" << getQualifiedName(RC2.TheDef) << "RegClass";
 509         Empty = false;
 510
 511         std::map<unsigned, std::set<unsigned> >::iterator SCMI =
 512           SuperClassMap.find(rc2);
 513         if (SCMI == SuperClassMap.end()) {
 514           SuperClassMap.insert(std::make_pair(rc2, std::set<unsigned>()));
 515           SCMI = SuperClassMap.find(rc2);
 516         }
 517         SCMI->second.insert(rc);
 518       }
 519
 520       OS << (!Empty ? ", " : "") << "NULL";
 521       OS << "\n  };\n\n";
 522     }
 523
 524     for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
 525       const CodeGenRegisterClass &RC = RegisterClasses[rc];
 526
 527       // Give the register class a legal C name if it's anonymous.
 528       std::string Name = RC.TheDef->getName();
 529
 530       OS << "  // " << Name
 531          << " Register Class super-classes...\n"
 532          << "  static const TargetRegisterClass* const "
 533          << Name << "Superclasses[] = {\n    ";
 534
 535       bool Empty = true;
 536       std::map<unsigned, std::set<unsigned> >::iterator I =
 537         SuperClassMap.find(rc);
 538       if (I != SuperClassMap.end()) {
 539         for (std::set<unsigned>::iterator II = I->second.begin(),
 540                EE = I->second.end(); II != EE; ++II) {
 541           const CodeGenRegisterClass &RC2 = RegisterClasses[*II];
 542           if (!Empty) OS << ", ";
 543           OS << "&" << getQualifiedName(RC2.TheDef) << "RegClass";
 544           Empty = false;
 545         }
 546       }
 547
 548       OS << (!Empty ? ", " : "") << "NULL";
 549       OS << "\n  };\n\n";
 550     }
 551
 552
 553     for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
 554       const CodeGenRegisterClass &RC = RegisterClasses[i];
 555       OS << RC.MethodBodies << "\n";
 556       OS << RC.getName() << "Class::" << RC.getName()
 557          << "Class()  : TargetRegisterClass("
 558          << RC.getName() + "RegClassID" << ", "
 559          << '\"' << RC.getName() << "\", "
 560          << RC.getName() + "VTs" << ", "
 561          << RC.getName() + "Subclasses" << ", "
 562          << RC.getName() + "Superclasses" << ", "
 563          << (NumSubRegIndices ? RC.getName() + "Sub" : std::string("Null"))
 564          << "RegClasses, "
 565          << (NumSubRegIndices ? RC.getName() + "Super" : std::string("Null"))
 566          << "RegClasses, "
 567          << RC.SpillSize/8 << ", "
 568          << RC.SpillAlignment/8 << ", "
 569          << RC.CopyCost << ", "
 570          << RC.getName() << ", " << RC.getName() << " + " << RC.Elements.size()
 571          << ") {}\n";
 572     }
 573
 574     OS << "}\n";
 575   }
 576
 577   OS << "\nnamespace {\n";
 578   OS << "  const TargetRegisterClass* const RegisterClasses[] = {\n";
 579   for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i)
 580     OS << "    &" << getQualifiedName(RegisterClasses[i].TheDef)
 581        << "RegClass,\n";
 582   OS << "  };\n";
 583
 584   // Emit register sub-registers / super-registers, aliases...
 585   std::map<Record*, std::set<Record*>, LessRecord> RegisterSubRegs;
 586   std::map<Record*, std::set<Record*>, LessRecord> RegisterSuperRegs;
 587   std::map<Record*, std::set<Record*>, LessRecord> RegisterAliases;
 588   typedef std::map<Record*, std::vector<int64_t>, LessRecord> DwarfRegNumsMapTy;
 589   DwarfRegNumsMapTy DwarfRegNums;
 590
 591   const std::vector<CodeGenRegister> &Regs = Target.getRegisters();
 592
 593   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 594     Record *R = Regs[i].TheDef;
 595     std::vector<Record*> LI = Regs[i].TheDef->getValueAsListOfDefs("Aliases");
 596     // Add information that R aliases all of the elements in the list... and
 597     // that everything in the list aliases R.
 598     for (unsigned j = 0, e = LI.size(); j != e; ++j) {
 599       Record *Reg = LI[j];
 600       if (RegisterAliases[R].count(Reg))
 601         errs() << "Warning: register alias between " << getQualifiedName(R)
 602                << " and " << getQualifiedName(Reg)
 603                << " specified multiple times!\n";
 604       RegisterAliases[R].insert(Reg);
 605
 606       if (RegisterAliases[Reg].count(R))
 607         errs() << "Warning: register alias between " << getQualifiedName(R)
 608                << " and " << getQualifiedName(Reg)
 609                << " specified multiple times!\n";
 610       RegisterAliases[Reg].insert(R);
 611     }
 612   }
 613
 614   // Process sub-register sets.
 615   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 616     Record *R = Regs[i].TheDef;
 617     std::vector<Record*> LI = Regs[i].TheDef->getValueAsListOfDefs("SubRegs");
 618     // Process sub-register set and add aliases information.
 619     for (unsigned j = 0, e = LI.size(); j != e; ++j) {
 620       Record *SubReg = LI[j];
 621       if (RegisterSubRegs[R].count(SubReg))
 622         errs() << "Warning: register " << getQualifiedName(SubReg)
 623                << " specified as a sub-register of " << getQualifiedName(R)
 624                << " multiple times!\n";
 625       addSubSuperReg(R, SubReg, RegisterSubRegs, RegisterSuperRegs,
 626                      RegisterAliases);
 627     }
 628   }
 629
 630   // Print the SubregHashTable, a simple quadratically probed
 631   // hash table for determining if a register is a subregister
 632   // of another register.
 633   unsigned NumSubRegs = 0;
 634   std::map<Record*, unsigned> RegNo;
 635   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 636     RegNo[Regs[i].TheDef] = i;
 637     NumSubRegs += RegisterSubRegs[Regs[i].TheDef].size();
 638   }
 639
 640   unsigned SubregHashTableSize = 2 * NextPowerOf2(2 * NumSubRegs);
 641   unsigned* SubregHashTable = new unsigned[2 * SubregHashTableSize];
 642   std::fill(SubregHashTable, SubregHashTable + 2 * SubregHashTableSize, ~0U);
 643
 644   unsigned hashMisses = 0;
 645
 646   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 647     Record* R = Regs[i].TheDef;
 648     for (std::set<Record*>::iterator I = RegisterSubRegs[R].begin(),
 649          E = RegisterSubRegs[R].end(); I != E; ++I) {
 650       Record* RJ = *I;
 651       // We have to increase the indices of both registers by one when
 652       // computing the hash because, in the generated code, there
 653       // will be an extra empty slot at register 0.
 654       size_t index = ((i+1) + (RegNo[RJ]+1) * 37) & (SubregHashTableSize-1);
 655       unsigned ProbeAmt = 2;
 656       while (SubregHashTable[index*2] != ~0U &&
 657              SubregHashTable[index*2+1] != ~0U) {
 658         index = (index + ProbeAmt) & (SubregHashTableSize-1);
 659         ProbeAmt += 2;
 660
 661         hashMisses++;
 662       }
 663
 664       SubregHashTable[index*2] = i;
 665       SubregHashTable[index*2+1] = RegNo[RJ];
 666     }
 667   }
 668
 669   OS << "\n\n  // Number of hash collisions: " << hashMisses << "\n";
 670
 671   if (SubregHashTableSize) {
 672     std::string Namespace = Regs[0].TheDef->getValueAsString("Namespace");
 673
 674     OS << "  const unsigned SubregHashTable[] = { ";
 675     for (unsigned i = 0; i < SubregHashTableSize - 1; ++i) {
 676       if (i != 0)
 677         // Insert spaces for nice formatting.
 678         OS << "                                       ";
 679
 680       if (SubregHashTable[2*i] != ~0U) {
 681         OS << getQualifiedName(Regs[SubregHashTable[2*i]].TheDef) << ", "
 682            << getQualifiedName(Regs[SubregHashTable[2*i+1]].TheDef) << ", \n";
 683       } else {
 684         OS << Namespace << "::NoRegister, " << Namespace << "::NoRegister, \n";
 685       }
 686     }
 687
 688     unsigned Idx = SubregHashTableSize*2-2;
 689     if (SubregHashTable[Idx] != ~0U) {
 690       OS << "                                       "
 691          << getQualifiedName(Regs[SubregHashTable[Idx]].TheDef) << ", "
 692          << getQualifiedName(Regs[SubregHashTable[Idx+1]].TheDef) << " };\n";
 693     } else {
 694       OS << Namespace << "::NoRegister, " << Namespace << "::NoRegister };\n";
 695     }
 696
 697     OS << "  const unsigned SubregHashTableSize = "
 698        << SubregHashTableSize << ";\n";
 699   } else {
 700     OS << "  const unsigned SubregHashTable[] = { ~0U, ~0U };\n"
 701        << "  const unsigned SubregHashTableSize = 1;\n";
 702   }
 703
 704   delete [] SubregHashTable;
 705
 706
 707   // Print the AliasHashTable, a simple quadratically probed
 708   // hash table for determining if a register aliases another register.
 709   unsigned NumAliases = 0;
 710   RegNo.clear();
 711   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 712     RegNo[Regs[i].TheDef] = i;
 713     NumAliases += RegisterAliases[Regs[i].TheDef].size();
 714   }
 715
 716   unsigned AliasesHashTableSize = 2 * NextPowerOf2(2 * NumAliases);
 717   unsigned* AliasesHashTable = new unsigned[2 * AliasesHashTableSize];
 718   std::fill(AliasesHashTable, AliasesHashTable + 2 * AliasesHashTableSize, ~0U);
 719
 720   hashMisses = 0;
 721
 722   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 723     Record* R = Regs[i].TheDef;
 724     for (std::set<Record*>::iterator I = RegisterAliases[R].begin(),
 725          E = RegisterAliases[R].end(); I != E; ++I) {
 726       Record* RJ = *I;
 727       // We have to increase the indices of both registers by one when
 728       // computing the hash because, in the generated code, there
 729       // will be an extra empty slot at register 0.
 730       size_t index = ((i+1) + (RegNo[RJ]+1) * 37) & (AliasesHashTableSize-1);
 731       unsigned ProbeAmt = 2;
 732       while (AliasesHashTable[index*2] != ~0U &&
 733              AliasesHashTable[index*2+1] != ~0U) {
 734         index = (index + ProbeAmt) & (AliasesHashTableSize-1);
 735         ProbeAmt += 2;
 736
 737         hashMisses++;
 738       }
 739
 740       AliasesHashTable[index*2] = i;
 741       AliasesHashTable[index*2+1] = RegNo[RJ];
 742     }
 743   }
 744
 745   OS << "\n\n  // Number of hash collisions: " << hashMisses << "\n";
 746
 747   if (AliasesHashTableSize) {
 748     std::string Namespace = Regs[0].TheDef->getValueAsString("Namespace");
 749
 750     OS << "  const unsigned AliasesHashTable[] = { ";
 751     for (unsigned i = 0; i < AliasesHashTableSize - 1; ++i) {
 752       if (i != 0)
 753         // Insert spaces for nice formatting.
 754         OS << "                                       ";
 755
 756       if (AliasesHashTable[2*i] != ~0U) {
 757         OS << getQualifiedName(Regs[AliasesHashTable[2*i]].TheDef) << ", "
 758            << getQualifiedName(Regs[AliasesHashTable[2*i+1]].TheDef) << ", \n";
 759       } else {
 760         OS << Namespace << "::NoRegister, " << Namespace << "::NoRegister, \n";
 761       }
 762     }
 763
 764     unsigned Idx = AliasesHashTableSize*2-2;
 765     if (AliasesHashTable[Idx] != ~0U) {
 766       OS << "                                       "
 767          << getQualifiedName(Regs[AliasesHashTable[Idx]].TheDef) << ", "
 768          << getQualifiedName(Regs[AliasesHashTable[Idx+1]].TheDef) << " };\n";
 769     } else {
 770       OS << Namespace << "::NoRegister, " << Namespace << "::NoRegister };\n";
 771     }
 772
 773     OS << "  const unsigned AliasesHashTableSize = "
 774        << AliasesHashTableSize << ";\n";
 775   } else {
 776     OS << "  const unsigned AliasesHashTable[] = { ~0U, ~0U };\n"
 777        << "  const unsigned AliasesHashTableSize = 1;\n";
 778   }
 779
 780   delete [] AliasesHashTable;
 781
 782   if (!RegisterAliases.empty())
 783     OS << "\n\n  // Register Overlap Lists...\n";
 784
 785   // Emit an overlap list for all registers.
 786   for (std::map<Record*, std::set<Record*>, LessRecord >::iterator
 787          I = RegisterAliases.begin(), E = RegisterAliases.end(); I != E; ++I) {
 788     OS << "  const unsigned " << I->first->getName() << "_Overlaps[] = { "
 789        << getQualifiedName(I->first) << ", ";
 790     for (std::set<Record*>::iterator ASI = I->second.begin(),
 791            E = I->second.end(); ASI != E; ++ASI)
 792       OS << getQualifiedName(*ASI) << ", ";
 793     OS << "0 };\n";
 794   }
 795
 796   if (!RegisterSubRegs.empty())
 797     OS << "\n\n  // Register Sub-registers Sets...\n";
 798
 799   // Emit the empty sub-registers list
 800   OS << "  const unsigned Empty_SubRegsSet[] = { 0 };\n";
 801   // Loop over all of the registers which have sub-registers, emitting the
 802   // sub-registers list to memory.
 803   for (std::map<Record*, std::set<Record*>, LessRecord>::iterator
 804          I = RegisterSubRegs.begin(), E = RegisterSubRegs.end(); I != E; ++I) {
 805    if (I->second.empty())
 806      continue;
 807     OS << "  const unsigned " << I->first->getName() << "_SubRegsSet[] = { ";
 808     std::vector<Record*> SubRegsVector;
 809     for (std::set<Record*>::iterator ASI = I->second.begin(),
 810            E = I->second.end(); ASI != E; ++ASI)
 811       SubRegsVector.push_back(*ASI);
 812     RegisterSorter RS(RegisterSubRegs);
 813     std::stable_sort(SubRegsVector.begin(), SubRegsVector.end(), RS);
 814     for (unsigned i = 0, e = SubRegsVector.size(); i != e; ++i)
 815       OS << getQualifiedName(SubRegsVector[i]) << ", ";
 816     OS << "0 };\n";
 817   }
 818
 819   if (!RegisterSuperRegs.empty())
 820     OS << "\n\n  // Register Super-registers Sets...\n";
 821
 822   // Emit the empty super-registers list
 823   OS << "  const unsigned Empty_SuperRegsSet[] = { 0 };\n";
 824   // Loop over all of the registers which have super-registers, emitting the
 825   // super-registers list to memory.
 826   for (std::map<Record*, std::set<Record*>, LessRecord >::iterator
 827          I = RegisterSuperRegs.begin(), E = RegisterSuperRegs.end(); I != E; ++I) {
 828     if (I->second.empty())
 829       continue;
 830     OS << "  const unsigned " << I->first->getName() << "_SuperRegsSet[] = { ";
 831
 832     std::vector<Record*> SuperRegsVector;
 833     for (std::set<Record*>::iterator ASI = I->second.begin(),
 834            E = I->second.end(); ASI != E; ++ASI)
 835       SuperRegsVector.push_back(*ASI);
 836     RegisterSorter RS(RegisterSubRegs);
 837     std::stable_sort(SuperRegsVector.begin(), SuperRegsVector.end(), RS);
 838     for (unsigned i = 0, e = SuperRegsVector.size(); i != e; ++i)
 839       OS << getQualifiedName(SuperRegsVector[i]) << ", ";
 840     OS << "0 };\n";
 841   }
 842
 843   OS<<"\n  const TargetRegisterDesc RegisterDescriptors[] = { // Descriptors\n";
 844   OS << "    { \"NOREG\",\t0,\t0,\t0,\t0 },\n";
 845
 846   // Now that register alias and sub-registers sets have been emitted, emit the
 847   // register descriptors now.
 848   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 849     const CodeGenRegister &Reg = Regs[i];
 850     OS << "    { \"";
 851     OS << Reg.getName() << "\",\t" << Reg.getName() << "_Overlaps,\t";
 852     if (!RegisterSubRegs[Reg.TheDef].empty())
 853       OS << Reg.getName() << "_SubRegsSet,\t";
 854     else
 855       OS << "Empty_SubRegsSet,\t";
 856     if (!RegisterSuperRegs[Reg.TheDef].empty())
 857       OS << Reg.getName() << "_SuperRegsSet,\t";
 858     else
 859       OS << "Empty_SuperRegsSet,\t";
 860     OS << Reg.CostPerUse << " },\n";
 861   }
 862   OS << "  };\n";      // End of register descriptors...
 863
 864   // Calculate the mapping of subregister+index pairs to physical registers.
 865   // This will also create further anonymous indexes.
 866   unsigned NamedIndices = Target.getSubRegIndices().size();
 867   RegisterMaps RegMaps;
 868   for (unsigned i = 0, e = Regs.size(); i != e; ++i)
 869     RegMaps.inferSubRegIndices(Regs[i].TheDef, Target);
 870
 871   // Emit SubRegIndex names, skipping 0
 872   const std::vector<Record*> SubRegIndices = Target.getSubRegIndices();
 873   OS << "\n  const char *const SubRegIndexTable[] = { \"";
 874   for (unsigned i = 0, e = SubRegIndices.size(); i != e; ++i) {
 875     OS << SubRegIndices[i]->getName();
 876     if (i+1 != e)
 877       OS << "\", \"";
 878   }
 879   OS << "\" };\n\n";
 880
 881   // Emit names of the anonymus subreg indexes.
 882   if (SubRegIndices.size() > NamedIndices) {
 883     OS << "  enum {";
 884     for (unsigned i = NamedIndices, e = SubRegIndices.size(); i != e; ++i) {
 885       OS << "\n    " << SubRegIndices[i]->getName() << " = " << i+1;
 886       if (i+1 != e)
 887         OS << ',';
 888     }
 889     OS << "\n  };\n\n";
 890   }
 891   OS << "}\n\n";       // End of anonymous namespace...
 892
 893   std::string ClassName = Target.getName() + "GenRegisterInfo";
 894
 895   // Emit the subregister + index mapping function based on the information
 896   // calculated above.
 897   OS << "unsigned " << ClassName
 898      << "::getSubReg(unsigned RegNo, unsigned Index) const {\n"
 899      << "  switch (RegNo) {\n"
 900      << "  default:\n    return 0;\n";
 901   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 902     RegisterMaps::SubRegMap &SRM = RegMaps.SubReg[Regs[i].TheDef];
 903     if (SRM.empty())
 904       continue;
 905     OS << "  case " << getQualifiedName(Regs[i].TheDef) << ":\n";
 906     OS << "    switch (Index) {\n";
 907     OS << "    default: return 0;\n";
 908     for (RegisterMaps::SubRegMap::const_iterator ii = SRM.begin(),
 909          ie = SRM.end(); ii != ie; ++ii)
 910       OS << "    case " << getQualifiedName(ii->first)
 911          << ": return " << getQualifiedName(ii->second) << ";\n";
 912     OS << "    };\n" << "    break;\n";
 913   }
 914   OS << "  };\n";
 915   OS << "  return 0;\n";
 916   OS << "}\n\n";
 917
 918   OS << "unsigned " << ClassName
 919      << "::getSubRegIndex(unsigned RegNo, unsigned SubRegNo) const {\n"
 920      << "  switch (RegNo) {\n"
 921      << "  default:\n    return 0;\n";
 922    for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 923      RegisterMaps::SubRegMap &SRM = RegMaps.SubReg[Regs[i].TheDef];
 924      if (SRM.empty())
 925        continue;
 926     OS << "  case " << getQualifiedName(Regs[i].TheDef) << ":\n";
 927     for (RegisterMaps::SubRegMap::const_iterator ii = SRM.begin(),
 928          ie = SRM.end(); ii != ie; ++ii)
 929       OS << "    if (SubRegNo == " << getQualifiedName(ii->second)
 930          << ")  return " << getQualifiedName(ii->first) << ";\n";
 931     OS << "    return 0;\n";
 932   }
 933   OS << "  };\n";
 934   OS << "  return 0;\n";
 935   OS << "}\n\n";
 936
 937   // Emit composeSubRegIndices
 938   RegMaps.computeComposites();
 939   OS << "unsigned " << ClassName
 940      << "::composeSubRegIndices(unsigned IdxA, unsigned IdxB) const {\n"
 941      << "  switch (IdxA) {\n"
 942      << "  default:\n    return IdxB;\n";
 943   for (unsigned i = 0, e = SubRegIndices.size(); i != e; ++i) {
 944     bool Open = false;
 945     for (unsigned j = 0; j != e; ++j) {
 946       if (Record *Comp = RegMaps.Composite.lookup(
 947                           std::make_pair(SubRegIndices[i], SubRegIndices[j]))) {
 948         if (!Open) {
 949           OS << "  case " << getQualifiedName(SubRegIndices[i])
 950              << ": switch(IdxB) {\n    default: return IdxB;\n";
 951           Open = true;
 952         }
 953         OS << "    case " << getQualifiedName(SubRegIndices[j])
 954            << ": return " << getQualifiedName(Comp) << ";\n";
 955       }
 956     }
 957     if (Open)
 958       OS << "    }\n";
 959   }
 960   OS << "  }\n}\n\n";
 961
 962   // Emit the constructor of the class...
 963   OS << ClassName << "::" << ClassName
 964      << "(int CallFrameSetupOpcode, int CallFrameDestroyOpcode)\n"
 965      << "  : TargetRegisterInfo(RegisterDescriptors, " << Regs.size()+1
 966      << ", RegisterClasses, RegisterClasses+" << RegisterClasses.size() <<",\n"
 967      << "                 SubRegIndexTable,\n"
 968      << "                 CallFrameSetupOpcode, CallFrameDestroyOpcode,\n"
 969      << "                 SubregHashTable, SubregHashTableSize,\n"
 970      << "                 AliasesHashTable, AliasesHashTableSize) {\n"
 971      << "}\n\n";
 972
 973   // Collect all information about dwarf register numbers
 974
 975   // First, just pull all provided information to the map
 976   unsigned maxLength = 0;
 977   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
 978     Record *Reg = Regs[i].TheDef;
 979     std::vector<int64_t> RegNums = Reg->getValueAsListOfInts("DwarfNumbers");
 980     maxLength = std::max((size_t)maxLength, RegNums.size());
 981     if (DwarfRegNums.count(Reg))
 982       errs() << "Warning: DWARF numbers for register " << getQualifiedName(Reg)
 983              << "specified multiple times\n";
 984     DwarfRegNums[Reg] = RegNums;
 985   }
 986
 987   // Now we know maximal length of number list. Append -1's, where needed
 988   for (DwarfRegNumsMapTy::iterator
 989        I = DwarfRegNums.begin(), E = DwarfRegNums.end(); I != E; ++I)
 990     for (unsigned i = I->second.size(), e = maxLength; i != e; ++i)
 991       I->second.push_back(-1);
 992
 993   // Emit information about the dwarf register numbers.
 994   OS << "int " << ClassName << "::getDwarfRegNumFull(unsigned RegNum, "
 995      << "unsigned Flavour) const {\n"
 996      << "  switch (Flavour) {\n"
 997      << "  default:\n"
 998      << "    assert(0 && \"Unknown DWARF flavour\");\n"
 999      << "    return -1;\n";
1000
1001   for (unsigned i = 0, e = maxLength; i != e; ++i) {
1002     OS << "  case " << i << ":\n"
1003        << "    switch (RegNum) {\n"
1004        << "    default:\n"
1005        << "      assert(0 && \"Invalid RegNum\");\n"
1006        << "      return -1;\n";
1007
1008     // Sort by name to get a stable order.
1009
1010
1011     for (DwarfRegNumsMapTy::iterator
1012            I = DwarfRegNums.begin(), E = DwarfRegNums.end(); I != E; ++I) {
1013       int RegNo = I->second[i];
1014       if (RegNo != -2)
1015         OS << "    case " << getQualifiedName(I->first) << ":\n"
1016            << "      return " << RegNo << ";\n";
1017       else
1018         OS << "    case " << getQualifiedName(I->first) << ":\n"
1019            << "      assert(0 && \"Invalid register for this mode\");\n"
1020            << "      return -1;\n";
1021     }
1022     OS << "    };\n";
1023   }
1024
1025   OS << "  };\n}\n\n";
1026
1027   OS << "} // End llvm namespace \n";
1028 }