utils/TableGen/CodeGenRegisters.cpp

   1 //===- CodeGenRegisters.cpp - Register and RegisterClass Info -------------===//
   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 file defines structures to encapsulate information gleaned from the
  11 // target register and register class definitions.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "CodeGenRegisters.h"
  16 #include "CodeGenTarget.h"
  17 #include "llvm/ADT/IntEqClasses.h"
  18 #include "llvm/ADT/STLExtras.h"
  19 #include "llvm/ADT/SmallVector.h"
  20 #include "llvm/ADT/StringExtras.h"
  21 #include "llvm/ADT/Twine.h"
  22 #include "llvm/Support/Debug.h"
  23 #include "llvm/TableGen/Error.h"
  24
  25 using namespace llvm;
  26
  27 #define DEBUG_TYPE "regalloc-emitter"
  28
  29 //===----------------------------------------------------------------------===//
  30 //                             CodeGenSubRegIndex
  31 //===----------------------------------------------------------------------===//
  32
  33 CodeGenSubRegIndex::CodeGenSubRegIndex(Record *R, unsigned Enum)
  34   : TheDef(R), EnumValue(Enum), LaneMask(0), AllSuperRegsCovered(true) {
  35   Name = R->getName();
  36   if (R->getValue("Namespace"))
  37     Namespace = R->getValueAsString("Namespace");
  38   Size = R->getValueAsInt("Size");
  39   Offset = R->getValueAsInt("Offset");
  40 }
  41
  42 CodeGenSubRegIndex::CodeGenSubRegIndex(StringRef N, StringRef Nspace,
  43                                        unsigned Enum)
  44   : TheDef(nullptr), Name(N), Namespace(Nspace), Size(-1), Offset(-1),
  45     EnumValue(Enum), LaneMask(0), AllSuperRegsCovered(true) {
  46 }
  47
  48 std::string CodeGenSubRegIndex::getQualifiedName() const {
  49   std::string N = getNamespace();
  50   if (!N.empty())
  51     N += "::";
  52   N += getName();
  53   return N;
  54 }
  55
  56 void CodeGenSubRegIndex::updateComponents(CodeGenRegBank &RegBank) {
  57   if (!TheDef)
  58     return;
  59
  60   std::vector<Record*> Comps = TheDef->getValueAsListOfDefs("ComposedOf");
  61   if (!Comps.empty()) {
  62     if (Comps.size() != 2)
  63       PrintFatalError(TheDef->getLoc(),
  64                       "ComposedOf must have exactly two entries");
  65     CodeGenSubRegIndex *A = RegBank.getSubRegIdx(Comps[0]);
  66     CodeGenSubRegIndex *B = RegBank.getSubRegIdx(Comps[1]);
  67     CodeGenSubRegIndex *X = A->addComposite(B, this);
  68     if (X)
  69       PrintFatalError(TheDef->getLoc(), "Ambiguous ComposedOf entries");
  70   }
  71
  72   std::vector<Record*> Parts =
  73     TheDef->getValueAsListOfDefs("CoveringSubRegIndices");
  74   if (!Parts.empty()) {
  75     if (Parts.size() < 2)
  76       PrintFatalError(TheDef->getLoc(),
  77                       "CoveredBySubRegs must have two or more entries");
  78     SmallVector<CodeGenSubRegIndex*, 8> IdxParts;
  79     for (unsigned i = 0, e = Parts.size(); i != e; ++i)
  80       IdxParts.push_back(RegBank.getSubRegIdx(Parts[i]));
  81     RegBank.addConcatSubRegIndex(IdxParts, this);
  82   }
  83 }
  84
  85 unsigned CodeGenSubRegIndex::computeLaneMask() {
  86   // Already computed?
  87   if (LaneMask)
  88     return LaneMask;
  89
  90   // Recursion guard, shouldn't be required.
  91   LaneMask = ~0u;
  92
  93   // The lane mask is simply the union of all sub-indices.
  94   unsigned M = 0;
  95   for (CompMap::iterator I = Composed.begin(), E = Composed.end(); I != E; ++I)
  96     M |= I->second->computeLaneMask();
  97   assert(M && "Missing lane mask, sub-register cycle?");
  98   LaneMask = M;
  99   return LaneMask;
 100 }
 101
 102 //===----------------------------------------------------------------------===//
 103 //                              CodeGenRegister
 104 //===----------------------------------------------------------------------===//
 105
 106 CodeGenRegister::CodeGenRegister(Record *R, unsigned Enum)
 107   : TheDef(R),
 108     EnumValue(Enum),
 109     CostPerUse(R->getValueAsInt("CostPerUse")),
 110     CoveredBySubRegs(R->getValueAsBit("CoveredBySubRegs")),
 111     NumNativeRegUnits(0),
 112     SubRegsComplete(false),
 113     SuperRegsComplete(false),
 114     TopoSig(~0u)
 115 {}
 116
 117 void CodeGenRegister::buildObjectGraph(CodeGenRegBank &RegBank) {
 118   std::vector<Record*> SRIs = TheDef->getValueAsListOfDefs("SubRegIndices");
 119   std::vector<Record*> SRs = TheDef->getValueAsListOfDefs("SubRegs");
 120
 121   if (SRIs.size() != SRs.size())
 122     PrintFatalError(TheDef->getLoc(),
 123                     "SubRegs and SubRegIndices must have the same size");
 124
 125   for (unsigned i = 0, e = SRIs.size(); i != e; ++i) {
 126     ExplicitSubRegIndices.push_back(RegBank.getSubRegIdx(SRIs[i]));
 127     ExplicitSubRegs.push_back(RegBank.getReg(SRs[i]));
 128   }
 129
 130   // Also compute leading super-registers. Each register has a list of
 131   // covered-by-subregs super-registers where it appears as the first explicit
 132   // sub-register.
 133   //
 134   // This is used by computeSecondarySubRegs() to find candidates.
 135   if (CoveredBySubRegs && !ExplicitSubRegs.empty())
 136     ExplicitSubRegs.front()->LeadingSuperRegs.push_back(this);
 137
 138   // Add ad hoc alias links. This is a symmetric relationship between two
 139   // registers, so build a symmetric graph by adding links in both ends.
 140   std::vector<Record*> Aliases = TheDef->getValueAsListOfDefs("Aliases");
 141   for (unsigned i = 0, e = Aliases.size(); i != e; ++i) {
 142     CodeGenRegister *Reg = RegBank.getReg(Aliases[i]);
 143     ExplicitAliases.push_back(Reg);
 144     Reg->ExplicitAliases.push_back(this);
 145   }
 146 }
 147
 148 const std::string &CodeGenRegister::getName() const {
 149   return TheDef->getName();
 150 }
 151
 152 namespace {
 153 // Iterate over all register units in a set of registers.
 154 class RegUnitIterator {
 155   CodeGenRegister::Set::const_iterator RegI, RegE;
 156   CodeGenRegister::RegUnitList::const_iterator UnitI, UnitE;
 157
 158 public:
 159   RegUnitIterator(const CodeGenRegister::Set &Regs):
 160     RegI(Regs.begin()), RegE(Regs.end()), UnitI(), UnitE() {
 161
 162     if (RegI != RegE) {
 163       UnitI = (*RegI)->getRegUnits().begin();
 164       UnitE = (*RegI)->getRegUnits().end();
 165       advance();
 166     }
 167   }
 168
 169   bool isValid() const { return UnitI != UnitE; }
 170
 171   unsigned operator* () const { assert(isValid()); return *UnitI; }
 172
 173   const CodeGenRegister *getReg() const { assert(isValid()); return *RegI; }
 174
 175   /// Preincrement.  Move to the next unit.
 176   void operator++() {
 177     assert(isValid() && "Cannot advance beyond the last operand");
 178     ++UnitI;
 179     advance();
 180   }
 181
 182 protected:
 183   void advance() {
 184     while (UnitI == UnitE) {
 185       if (++RegI == RegE)
 186         break;
 187       UnitI = (*RegI)->getRegUnits().begin();
 188       UnitE = (*RegI)->getRegUnits().end();
 189     }
 190   }
 191 };
 192 } // namespace
 193
 194 // Merge two RegUnitLists maintaining the order and removing duplicates.
 195 // Overwrites MergedRU in the process.
 196 static void mergeRegUnits(CodeGenRegister::RegUnitList &MergedRU,
 197                           const CodeGenRegister::RegUnitList &RRU) {
 198   CodeGenRegister::RegUnitList LRU = MergedRU;
 199   MergedRU.clear();
 200   std::set_union(LRU.begin(), LRU.end(), RRU.begin(), RRU.end(),
 201                  std::back_inserter(MergedRU));
 202 }
 203
 204 // Return true of this unit appears in RegUnits.
 205 static bool hasRegUnit(CodeGenRegister::RegUnitList &RegUnits, unsigned Unit) {
 206   return std::count(RegUnits.begin(), RegUnits.end(), Unit);
 207 }
 208
 209 // Inherit register units from subregisters.
 210 // Return true if the RegUnits changed.
 211 bool CodeGenRegister::inheritRegUnits(CodeGenRegBank &RegBank) {
 212   unsigned OldNumUnits = RegUnits.size();
 213   for (SubRegMap::const_iterator I = SubRegs.begin(), E = SubRegs.end();
 214        I != E; ++I) {
 215     CodeGenRegister *SR = I->second;
 216     // Merge the subregister's units into this register's RegUnits.
 217     mergeRegUnits(RegUnits, SR->RegUnits);
 218   }
 219   return OldNumUnits != RegUnits.size();
 220 }
 221
 222 const CodeGenRegister::SubRegMap &
 223 CodeGenRegister::computeSubRegs(CodeGenRegBank &RegBank) {
 224   // Only compute this map once.
 225   if (SubRegsComplete)
 226     return SubRegs;
 227   SubRegsComplete = true;
 228
 229   // First insert the explicit subregs and make sure they are fully indexed.
 230   for (unsigned i = 0, e = ExplicitSubRegs.size(); i != e; ++i) {
 231     CodeGenRegister *SR = ExplicitSubRegs[i];
 232     CodeGenSubRegIndex *Idx = ExplicitSubRegIndices[i];
 233     if (!SubRegs.insert(std::make_pair(Idx, SR)).second)
 234       PrintFatalError(TheDef->getLoc(), "SubRegIndex " + Idx->getName() +
 235                       " appears twice in Register " + getName());
 236     // Map explicit sub-registers first, so the names take precedence.
 237     // The inherited sub-registers are mapped below.
 238     SubReg2Idx.insert(std::make_pair(SR, Idx));
 239   }
 240
 241   // Keep track of inherited subregs and how they can be reached.
 242   SmallPtrSet<CodeGenRegister*, 8> Orphans;
 243
 244   // Clone inherited subregs and place duplicate entries in Orphans.
 245   // Here the order is important - earlier subregs take precedence.
 246   for (unsigned i = 0, e = ExplicitSubRegs.size(); i != e; ++i) {
 247     CodeGenRegister *SR = ExplicitSubRegs[i];
 248     const SubRegMap &Map = SR->computeSubRegs(RegBank);
 249
 250     for (SubRegMap::const_iterator SI = Map.begin(), SE = Map.end(); SI != SE;
 251          ++SI) {
 252       if (!SubRegs.insert(*SI).second)
 253         Orphans.insert(SI->second);
 254     }
 255   }
 256
 257   // Expand any composed subreg indices.
 258   // If dsub_2 has ComposedOf = [qsub_1, dsub_0], and this register has a
 259   // qsub_1 subreg, add a dsub_2 subreg.  Keep growing Indices and process
 260   // expanded subreg indices recursively.
 261   SmallVector<CodeGenSubRegIndex*, 8> Indices = ExplicitSubRegIndices;
 262   for (unsigned i = 0; i != Indices.size(); ++i) {
 263     CodeGenSubRegIndex *Idx = Indices[i];
 264     const CodeGenSubRegIndex::CompMap &Comps = Idx->getComposites();
 265     CodeGenRegister *SR = SubRegs[Idx];
 266     const SubRegMap &Map = SR->computeSubRegs(RegBank);
 267
 268     // Look at the possible compositions of Idx.
 269     // They may not all be supported by SR.
 270     for (CodeGenSubRegIndex::CompMap::const_iterator I = Comps.begin(),
 271            E = Comps.end(); I != E; ++I) {
 272       SubRegMap::const_iterator SRI = Map.find(I->first);
 273       if (SRI == Map.end())
 274         continue; // Idx + I->first doesn't exist in SR.
 275       // Add I->second as a name for the subreg SRI->second, assuming it is
 276       // orphaned, and the name isn't already used for something else.
 277       if (SubRegs.count(I->second) || !Orphans.erase(SRI->second))
 278         continue;
 279       // We found a new name for the orphaned sub-register.
 280       SubRegs.insert(std::make_pair(I->second, SRI->second));
 281       Indices.push_back(I->second);
 282     }
 283   }
 284
 285   // Now Orphans contains the inherited subregisters without a direct index.
 286   // Create inferred indexes for all missing entries.
 287   // Work backwards in the Indices vector in order to compose subregs bottom-up.
 288   // Consider this subreg sequence:
 289   //
 290   //   qsub_1 -> dsub_0 -> ssub_0
 291   //
 292   // The qsub_1 -> dsub_0 composition becomes dsub_2, so the ssub_0 register
 293   // can be reached in two different ways:
 294   //
 295   //   qsub_1 -> ssub_0
 296   //   dsub_2 -> ssub_0
 297   //
 298   // We pick the latter composition because another register may have [dsub_0,
 299   // dsub_1, dsub_2] subregs without necessarily having a qsub_1 subreg.  The
 300   // dsub_2 -> ssub_0 composition can be shared.
 301   while (!Indices.empty() && !Orphans.empty()) {
 302     CodeGenSubRegIndex *Idx = Indices.pop_back_val();
 303     CodeGenRegister *SR = SubRegs[Idx];
 304     const SubRegMap &Map = SR->computeSubRegs(RegBank);
 305     for (SubRegMap::const_iterator SI = Map.begin(), SE = Map.end(); SI != SE;
 306          ++SI)
 307       if (Orphans.erase(SI->second))
 308         SubRegs[RegBank.getCompositeSubRegIndex(Idx, SI->first)] = SI->second;
 309   }
 310
 311   // Compute the inverse SubReg -> Idx map.
 312   for (SubRegMap::const_iterator SI = SubRegs.begin(), SE = SubRegs.end();
 313        SI != SE; ++SI) {
 314     if (SI->second == this) {
 315       ArrayRef<SMLoc> Loc;
 316       if (TheDef)
 317         Loc = TheDef->getLoc();
 318       PrintFatalError(Loc, "Register " + getName() +
 319                       " has itself as a sub-register");
 320     }
 321
 322     // Compute AllSuperRegsCovered.
 323     if (!CoveredBySubRegs)
 324       SI->first->AllSuperRegsCovered = false;
 325
 326     // Ensure that every sub-register has a unique name.
 327     DenseMap<const CodeGenRegister*, CodeGenSubRegIndex*>::iterator Ins =
 328       SubReg2Idx.insert(std::make_pair(SI->second, SI->first)).first;
 329     if (Ins->second == SI->first)
 330       continue;
 331     // Trouble: Two different names for SI->second.
 332     ArrayRef<SMLoc> Loc;
 333     if (TheDef)
 334       Loc = TheDef->getLoc();
 335     PrintFatalError(Loc, "Sub-register can't have two names: " +
 336                   SI->second->getName() + " available as " +
 337                   SI->first->getName() + " and " + Ins->second->getName());
 338   }
 339
 340   // Derive possible names for sub-register concatenations from any explicit
 341   // sub-registers. By doing this before computeSecondarySubRegs(), we ensure
 342   // that getConcatSubRegIndex() won't invent any concatenated indices that the
 343   // user already specified.
 344   for (unsigned i = 0, e = ExplicitSubRegs.size(); i != e; ++i) {
 345     CodeGenRegister *SR = ExplicitSubRegs[i];
 346     if (!SR->CoveredBySubRegs || SR->ExplicitSubRegs.size() <= 1)
 347       continue;
 348
 349     // SR is composed of multiple sub-regs. Find their names in this register.
 350     SmallVector<CodeGenSubRegIndex*, 8> Parts;
 351     for (unsigned j = 0, e = SR->ExplicitSubRegs.size(); j != e; ++j)
 352       Parts.push_back(getSubRegIndex(SR->ExplicitSubRegs[j]));
 353
 354     // Offer this as an existing spelling for the concatenation of Parts.
 355     RegBank.addConcatSubRegIndex(Parts, ExplicitSubRegIndices[i]);
 356   }
 357
 358   // Initialize RegUnitList. Because getSubRegs is called recursively, this
 359   // processes the register hierarchy in postorder.
 360   //
 361   // Inherit all sub-register units. It is good enough to look at the explicit
 362   // sub-registers, the other registers won't contribute any more units.
 363   for (unsigned i = 0, e = ExplicitSubRegs.size(); i != e; ++i) {
 364     CodeGenRegister *SR = ExplicitSubRegs[i];
 365     // Explicit sub-registers are usually disjoint, so this is a good way of
 366     // computing the union. We may pick up a few duplicates that will be
 367     // eliminated below.
 368     unsigned N = RegUnits.size();
 369     RegUnits.append(SR->RegUnits.begin(), SR->RegUnits.end());
 370     std::inplace_merge(RegUnits.begin(), RegUnits.begin() + N, RegUnits.end());
 371   }
 372   RegUnits.erase(std::unique(RegUnits.begin(), RegUnits.end()), RegUnits.end());
 373
 374   // Absent any ad hoc aliasing, we create one register unit per leaf register.
 375   // These units correspond to the maximal cliques in the register overlap
 376   // graph which is optimal.
 377   //
 378   // When there is ad hoc aliasing, we simply create one unit per edge in the
 379   // undirected ad hoc aliasing graph. Technically, we could do better by
 380   // identifying maximal cliques in the ad hoc graph, but cliques larger than 2
 381   // are extremely rare anyway (I've never seen one), so we don't bother with
 382   // the added complexity.
 383   for (unsigned i = 0, e = ExplicitAliases.size(); i != e; ++i) {
 384     CodeGenRegister *AR = ExplicitAliases[i];
 385     // Only visit each edge once.
 386     if (AR->SubRegsComplete)
 387       continue;
 388     // Create a RegUnit representing this alias edge, and add it to both
 389     // registers.
 390     unsigned Unit = RegBank.newRegUnit(this, AR);
 391     RegUnits.push_back(Unit);
 392     AR->RegUnits.push_back(Unit);
 393   }
 394
 395   // Finally, create units for leaf registers without ad hoc aliases. Note that
 396   // a leaf register with ad hoc aliases doesn't get its own unit - it isn't
 397   // necessary. This means the aliasing leaf registers can share a single unit.
 398   if (RegUnits.empty())
 399     RegUnits.push_back(RegBank.newRegUnit(this));
 400
 401   // We have now computed the native register units. More may be adopted later
 402   // for balancing purposes.
 403   NumNativeRegUnits = RegUnits.size();
 404
 405   return SubRegs;
 406 }
 407
 408 // In a register that is covered by its sub-registers, try to find redundant
 409 // sub-registers. For example:
 410 //
 411 //   QQ0 = {Q0, Q1}
 412 //   Q0 = {D0, D1}
 413 //   Q1 = {D2, D3}
 414 //
 415 // We can infer that D1_D2 is also a sub-register, even if it wasn't named in
 416 // the register definition.
 417 //
 418 // The explicitly specified registers form a tree. This function discovers
 419 // sub-register relationships that would force a DAG.
 420 //
 421 void CodeGenRegister::computeSecondarySubRegs(CodeGenRegBank &RegBank) {
 422   // Collect new sub-registers first, add them later.
 423   SmallVector<SubRegMap::value_type, 8> NewSubRegs;
 424
 425   // Look at the leading super-registers of each sub-register. Those are the
 426   // candidates for new sub-registers, assuming they are fully contained in
 427   // this register.
 428   for (SubRegMap::iterator I = SubRegs.begin(), E = SubRegs.end(); I != E; ++I){
 429     const CodeGenRegister *SubReg = I->second;
 430     const CodeGenRegister::SuperRegList &Leads = SubReg->LeadingSuperRegs;
 431     for (unsigned i = 0, e = Leads.size(); i != e; ++i) {
 432       CodeGenRegister *Cand = const_cast<CodeGenRegister*>(Leads[i]);
 433       // Already got this sub-register?
 434       if (Cand == this || getSubRegIndex(Cand))
 435         continue;
 436       // Check if each component of Cand is already a sub-register.
 437       // We know that the first component is I->second, and is present with the
 438       // name I->first.
 439       SmallVector<CodeGenSubRegIndex*, 8> Parts(1, I->first);
 440       assert(!Cand->ExplicitSubRegs.empty() &&
 441              "Super-register has no sub-registers");
 442       for (unsigned j = 1, e = Cand->ExplicitSubRegs.size(); j != e; ++j) {
 443         if (CodeGenSubRegIndex *Idx = getSubRegIndex(Cand->ExplicitSubRegs[j]))
 444           Parts.push_back(Idx);
 445         else {
 446           // Sub-register doesn't exist.
 447           Parts.clear();
 448           break;
 449         }
 450       }
 451       // If some Cand sub-register is not part of this register, or if Cand only
 452       // has one sub-register, there is nothing to do.
 453       if (Parts.size() <= 1)
 454         continue;
 455
 456       // Each part of Cand is a sub-register of this. Make the full Cand also
 457       // a sub-register with a concatenated sub-register index.
 458       CodeGenSubRegIndex *Concat= RegBank.getConcatSubRegIndex(Parts);
 459       NewSubRegs.push_back(std::make_pair(Concat, Cand));
 460     }
 461   }
 462
 463   // Now add all the new sub-registers.
 464   for (unsigned i = 0, e = NewSubRegs.size(); i != e; ++i) {
 465     // Don't add Cand if another sub-register is already using the index.
 466     if (!SubRegs.insert(NewSubRegs[i]).second)
 467       continue;
 468
 469     CodeGenSubRegIndex *NewIdx = NewSubRegs[i].first;
 470     CodeGenRegister *NewSubReg = NewSubRegs[i].second;
 471     SubReg2Idx.insert(std::make_pair(NewSubReg, NewIdx));
 472   }
 473
 474   // Create sub-register index composition maps for the synthesized indices.
 475   for (unsigned i = 0, e = NewSubRegs.size(); i != e; ++i) {
 476     CodeGenSubRegIndex *NewIdx = NewSubRegs[i].first;
 477     CodeGenRegister *NewSubReg = NewSubRegs[i].second;
 478     for (SubRegMap::const_iterator SI = NewSubReg->SubRegs.begin(),
 479            SE = NewSubReg->SubRegs.end(); SI != SE; ++SI) {
 480       CodeGenSubRegIndex *SubIdx = getSubRegIndex(SI->second);
 481       if (!SubIdx)
 482         PrintFatalError(TheDef->getLoc(), "No SubRegIndex for " +
 483                         SI->second->getName() + " in " + getName());
 484       NewIdx->addComposite(SI->first, SubIdx);
 485     }
 486   }
 487 }
 488
 489 void CodeGenRegister::computeSuperRegs(CodeGenRegBank &RegBank) {
 490   // Only visit each register once.
 491   if (SuperRegsComplete)
 492     return;
 493   SuperRegsComplete = true;
 494
 495   // Make sure all sub-registers have been visited first, so the super-reg
 496   // lists will be topologically ordered.
 497   for (SubRegMap::const_iterator I = SubRegs.begin(), E = SubRegs.end();
 498        I != E; ++I)
 499     I->second->computeSuperRegs(RegBank);
 500
 501   // Now add this as a super-register on all sub-registers.
 502   // Also compute the TopoSigId in post-order.
 503   TopoSigId Id;
 504   for (SubRegMap::const_iterator I = SubRegs.begin(), E = SubRegs.end();
 505        I != E; ++I) {
 506     // Topological signature computed from SubIdx, TopoId(SubReg).
 507     // Loops and idempotent indices have TopoSig = ~0u.
 508     Id.push_back(I->first->EnumValue);
 509     Id.push_back(I->second->TopoSig);
 510
 511     // Don't add duplicate entries.
 512     if (!I->second->SuperRegs.empty() && I->second->SuperRegs.back() == this)
 513       continue;
 514     I->second->SuperRegs.push_back(this);
 515   }
 516   TopoSig = RegBank.getTopoSig(Id);
 517 }
 518
 519 void
 520 CodeGenRegister::addSubRegsPreOrder(SetVector<const CodeGenRegister*> &OSet,
 521                                     CodeGenRegBank &RegBank) const {
 522   assert(SubRegsComplete && "Must precompute sub-registers");
 523   for (unsigned i = 0, e = ExplicitSubRegs.size(); i != e; ++i) {
 524     CodeGenRegister *SR = ExplicitSubRegs[i];
 525     if (OSet.insert(SR))
 526       SR->addSubRegsPreOrder(OSet, RegBank);
 527   }
 528   // Add any secondary sub-registers that weren't part of the explicit tree.
 529   for (SubRegMap::const_iterator I = SubRegs.begin(), E = SubRegs.end();
 530        I != E; ++I)
 531     OSet.insert(I->second);
 532 }
 533
 534 // Get the sum of this register's unit weights.
 535 unsigned CodeGenRegister::getWeight(const CodeGenRegBank &RegBank) const {
 536   unsigned Weight = 0;
 537   for (RegUnitList::const_iterator I = RegUnits.begin(), E = RegUnits.end();
 538        I != E; ++I) {
 539     Weight += RegBank.getRegUnit(*I).Weight;
 540   }
 541   return Weight;
 542 }
 543
 544 //===----------------------------------------------------------------------===//
 545 //                               RegisterTuples
 546 //===----------------------------------------------------------------------===//
 547
 548 // A RegisterTuples def is used to generate pseudo-registers from lists of
 549 // sub-registers. We provide a SetTheory expander class that returns the new
 550 // registers.
 551 namespace {
 552 struct TupleExpander : SetTheory::Expander {
 553   void expand(SetTheory &ST, Record *Def, SetTheory::RecSet &Elts) override {
 554     std::vector<Record*> Indices = Def->getValueAsListOfDefs("SubRegIndices");
 555     unsigned Dim = Indices.size();
 556     ListInit *SubRegs = Def->getValueAsListInit("SubRegs");
 557     if (Dim != SubRegs->getSize())
 558       PrintFatalError(Def->getLoc(), "SubRegIndices and SubRegs size mismatch");
 559     if (Dim < 2)
 560       PrintFatalError(Def->getLoc(),
 561                       "Tuples must have at least 2 sub-registers");
 562
 563     // Evaluate the sub-register lists to be zipped.
 564     unsigned Length = ~0u;
 565     SmallVector<SetTheory::RecSet, 4> Lists(Dim);
 566     for (unsigned i = 0; i != Dim; ++i) {
 567       ST.evaluate(SubRegs->getElement(i), Lists[i], Def->getLoc());
 568       Length = std::min(Length, unsigned(Lists[i].size()));
 569     }
 570
 571     if (Length == 0)
 572       return;
 573
 574     // Precompute some types.
 575     Record *RegisterCl = Def->getRecords().getClass("Register");
 576     RecTy *RegisterRecTy = RecordRecTy::get(RegisterCl);
 577     StringInit *BlankName = StringInit::get("");
 578
 579     // Zip them up.
 580     for (unsigned n = 0; n != Length; ++n) {
 581       std::string Name;
 582       Record *Proto = Lists[0][n];
 583       std::vector<Init*> Tuple;
 584       unsigned CostPerUse = 0;
 585       for (unsigned i = 0; i != Dim; ++i) {
 586         Record *Reg = Lists[i][n];
 587         if (i) Name += '_';
 588         Name += Reg->getName();
 589         Tuple.push_back(DefInit::get(Reg));
 590         CostPerUse = std::max(CostPerUse,
 591                               unsigned(Reg->getValueAsInt("CostPerUse")));
 592       }
 593
 594       // Create a new Record representing the synthesized register. This record
 595       // is only for consumption by CodeGenRegister, it is not added to the
 596       // RecordKeeper.
 597       Record *NewReg = new Record(Name, Def->getLoc(), Def->getRecords());
 598       Elts.insert(NewReg);
 599
 600       // Copy Proto super-classes.
 601       ArrayRef<Record *> Supers = Proto->getSuperClasses();
 602       ArrayRef<SMRange> Ranges = Proto->getSuperClassRanges();
 603       for (unsigned i = 0, e = Supers.size(); i != e; ++i)
 604         NewReg->addSuperClass(Supers[i], Ranges[i]);
 605
 606       // Copy Proto fields.
 607       for (unsigned i = 0, e = Proto->getValues().size(); i != e; ++i) {
 608         RecordVal RV = Proto->getValues()[i];
 609
 610         // Skip existing fields, like NAME.
 611         if (NewReg->getValue(RV.getNameInit()))
 612           continue;
 613
 614         StringRef Field = RV.getName();
 615
 616         // Replace the sub-register list with Tuple.
 617         if (Field == "SubRegs")
 618           RV.setValue(ListInit::get(Tuple, RegisterRecTy));
 619
 620         // Provide a blank AsmName. MC hacks are required anyway.
 621         if (Field == "AsmName")
 622           RV.setValue(BlankName);
 623
 624         // CostPerUse is aggregated from all Tuple members.
 625         if (Field == "CostPerUse")
 626           RV.setValue(IntInit::get(CostPerUse));
 627
 628         // Composite registers are always covered by sub-registers.
 629         if (Field == "CoveredBySubRegs")
 630           RV.setValue(BitInit::get(true));
 631
 632         // Copy fields from the RegisterTuples def.
 633         if (Field == "SubRegIndices" ||
 634             Field == "CompositeIndices") {
 635           NewReg->addValue(*Def->getValue(Field));
 636           continue;
 637         }
 638
 639         // Some fields get their default uninitialized value.
 640         if (Field == "DwarfNumbers" ||
 641             Field == "DwarfAlias" ||
 642             Field == "Aliases") {
 643           if (const RecordVal *DefRV = RegisterCl->getValue(Field))
 644             NewReg->addValue(*DefRV);
 645           continue;
 646         }
 647
 648         // Everything else is copied from Proto.
 649         NewReg->addValue(RV);
 650       }
 651     }
 652   }
 653 };
 654 }
 655
 656 //===----------------------------------------------------------------------===//
 657 //                            CodeGenRegisterClass
 658 //===----------------------------------------------------------------------===//
 659
 660 CodeGenRegisterClass::CodeGenRegisterClass(CodeGenRegBank &RegBank, Record *R)
 661   : TheDef(R),
 662     Name(R->getName()),
 663     TopoSigs(RegBank.getNumTopoSigs()),
 664     EnumValue(-1) {
 665   // Rename anonymous register classes.
 666   if (R->getName().size() > 9 && R->getName()[9] == '.') {
 667     static unsigned AnonCounter = 0;
 668     R->setName("AnonRegClass_" + utostr(AnonCounter));
 669     // MSVC2012 ICEs if AnonCounter++ is directly passed to utostr.
 670     ++AnonCounter;
 671   }
 672
 673   std::vector<Record*> TypeList = R->getValueAsListOfDefs("RegTypes");
 674   for (unsigned i = 0, e = TypeList.size(); i != e; ++i) {
 675     Record *Type = TypeList[i];
 676     if (!Type->isSubClassOf("ValueType"))
 677       PrintFatalError("RegTypes list member '" + Type->getName() +
 678         "' does not derive from the ValueType class!");
 679     VTs.push_back(getValueType(Type));
 680   }
 681   assert(!VTs.empty() && "RegisterClass must contain at least one ValueType!");
 682
 683   // Allocation order 0 is the full set. AltOrders provides others.
 684   const SetTheory::RecVec *Elements = RegBank.getSets().expand(R);
 685   ListInit *AltOrders = R->getValueAsListInit("AltOrders");
 686   Orders.resize(1 + AltOrders->size());
 687
 688   // Default allocation order always contains all registers.
 689   for (unsigned i = 0, e = Elements->size(); i != e; ++i) {
 690     Orders[0].push_back((*Elements)[i]);
 691     const CodeGenRegister *Reg = RegBank.getReg((*Elements)[i]);
 692     Members.insert(Reg);
 693     TopoSigs.set(Reg->getTopoSig());
 694   }
 695
 696   // Alternative allocation orders may be subsets.
 697   SetTheory::RecSet Order;
 698   for (unsigned i = 0, e = AltOrders->size(); i != e; ++i) {
 699     RegBank.getSets().evaluate(AltOrders->getElement(i), Order, R->getLoc());
 700     Orders[1 + i].append(Order.begin(), Order.end());
 701     // Verify that all altorder members are regclass members.
 702     while (!Order.empty()) {
 703       CodeGenRegister *Reg = RegBank.getReg(Order.back());
 704       Order.pop_back();
 705       if (!contains(Reg))
 706         PrintFatalError(R->getLoc(), " AltOrder register " + Reg->getName() +
 707                       " is not a class member");
 708     }
 709   }
 710
 711   // Allow targets to override the size in bits of the RegisterClass.
 712   unsigned Size = R->getValueAsInt("Size");
 713
 714   Namespace = R->getValueAsString("Namespace");
 715   SpillSize = Size ? Size : MVT(VTs[0]).getSizeInBits();
 716   SpillAlignment = R->getValueAsInt("Alignment");
 717   CopyCost = R->getValueAsInt("CopyCost");
 718   Allocatable = R->getValueAsBit("isAllocatable");
 719   AltOrderSelect = R->getValueAsString("AltOrderSelect");
 720 }
 721
 722 // Create an inferred register class that was missing from the .td files.
 723 // Most properties will be inherited from the closest super-class after the
 724 // class structure has been computed.
 725 CodeGenRegisterClass::CodeGenRegisterClass(CodeGenRegBank &RegBank,
 726                                            StringRef Name, Key Props)
 727   : Members(*Props.Members),
 728     TheDef(nullptr),
 729     Name(Name),
 730     TopoSigs(RegBank.getNumTopoSigs()),
 731     EnumValue(-1),
 732     SpillSize(Props.SpillSize),
 733     SpillAlignment(Props.SpillAlignment),
 734     CopyCost(0),
 735     Allocatable(true) {
 736   for (CodeGenRegister::Set::iterator I = Members.begin(), E = Members.end();
 737        I != E; ++I)
 738     TopoSigs.set((*I)->getTopoSig());
 739 }
 740
 741 // Compute inherited propertied for a synthesized register class.
 742 void CodeGenRegisterClass::inheritProperties(CodeGenRegBank &RegBank) {
 743   assert(!getDef() && "Only synthesized classes can inherit properties");
 744   assert(!SuperClasses.empty() && "Synthesized class without super class");
 745
 746   // The last super-class is the smallest one.
 747   CodeGenRegisterClass &Super = *SuperClasses.back();
 748
 749   // Most properties are copied directly.
 750   // Exceptions are members, size, and alignment
 751   Namespace = Super.Namespace;
 752   VTs = Super.VTs;
 753   CopyCost = Super.CopyCost;
 754   Allocatable = Super.Allocatable;
 755   AltOrderSelect = Super.AltOrderSelect;
 756
 757   // Copy all allocation orders, filter out foreign registers from the larger
 758   // super-class.
 759   Orders.resize(Super.Orders.size());
 760   for (unsigned i = 0, ie = Super.Orders.size(); i != ie; ++i)
 761     for (unsigned j = 0, je = Super.Orders[i].size(); j != je; ++j)
 762       if (contains(RegBank.getReg(Super.Orders[i][j])))
 763         Orders[i].push_back(Super.Orders[i][j]);
 764 }
 765
 766 bool CodeGenRegisterClass::contains(const CodeGenRegister *Reg) const {
 767   return Members.count(Reg);
 768 }
 769
 770 namespace llvm {
 771   raw_ostream &operator<<(raw_ostream &OS, const CodeGenRegisterClass::Key &K) {
 772     OS << "{ S=" << K.SpillSize << ", A=" << K.SpillAlignment;
 773     for (CodeGenRegister::Set::const_iterator I = K.Members->begin(),
 774          E = K.Members->end(); I != E; ++I)
 775       OS << ", " << (*I)->getName();
 776     return OS << " }";
 777   }
 778 }
 779
 780 // This is a simple lexicographical order that can be used to search for sets.
 781 // It is not the same as the topological order provided by TopoOrderRC.
 782 bool CodeGenRegisterClass::Key::
 783 operator<(const CodeGenRegisterClass::Key &B) const {
 784   assert(Members && B.Members);
 785   return std::tie(*Members, SpillSize, SpillAlignment) <
 786          std::tie(*B.Members, B.SpillSize, B.SpillAlignment);
 787 }
 788
 789 // Returns true if RC is a strict subclass.
 790 // RC is a sub-class of this class if it is a valid replacement for any
 791 // instruction operand where a register of this classis required. It must
 792 // satisfy these conditions:
 793 //
 794 // 1. All RC registers are also in this.
 795 // 2. The RC spill size must not be smaller than our spill size.
 796 // 3. RC spill alignment must be compatible with ours.
 797 //
 798 static bool testSubClass(const CodeGenRegisterClass *A,
 799                          const CodeGenRegisterClass *B) {
 800   return A->SpillAlignment && B->SpillAlignment % A->SpillAlignment == 0 &&
 801     A->SpillSize <= B->SpillSize &&
 802     std::includes(A->getMembers().begin(), A->getMembers().end(),
 803                   B->getMembers().begin(), B->getMembers().end(),
 804                   CodeGenRegister::Less());
 805 }
 806
 807 /// Sorting predicate for register classes.  This provides a topological
 808 /// ordering that arranges all register classes before their sub-classes.
 809 ///
 810 /// Register classes with the same registers, spill size, and alignment form a
 811 /// clique.  They will be ordered alphabetically.
 812 ///
 813 static int TopoOrderRC(CodeGenRegisterClass *const *PA,
 814                        CodeGenRegisterClass *const *PB) {
 815   const CodeGenRegisterClass *A = *PA;
 816   const CodeGenRegisterClass *B = *PB;
 817   if (A == B)
 818     return 0;
 819
 820   // Order by ascending spill size.
 821   if (A->SpillSize < B->SpillSize)
 822     return -1;
 823   if (A->SpillSize > B->SpillSize)
 824     return 1;
 825
 826   // Order by ascending spill alignment.
 827   if (A->SpillAlignment < B->SpillAlignment)
 828     return -1;
 829   if (A->SpillAlignment > B->SpillAlignment)
 830     return 1;
 831
 832   // Order by descending set size.  Note that the classes' allocation order may
 833   // not have been computed yet.  The Members set is always vaild.
 834   if (A->getMembers().size() > B->getMembers().size())
 835     return -1;
 836   if (A->getMembers().size() < B->getMembers().size())
 837     return 1;
 838
 839   // Finally order by name as a tie breaker.
 840   return StringRef(A->getName()).compare(B->getName());
 841 }
 842
 843 std::string CodeGenRegisterClass::getQualifiedName() const {
 844   if (Namespace.empty())
 845     return getName();
 846   else
 847     return Namespace + "::" + getName();
 848 }
 849
 850 // Compute sub-classes of all register classes.
 851 // Assume the classes are ordered topologically.
 852 void CodeGenRegisterClass::computeSubClasses(CodeGenRegBank &RegBank) {
 853   ArrayRef<CodeGenRegisterClass*> RegClasses = RegBank.getRegClasses();
 854
 855   // Visit backwards so sub-classes are seen first.
 856   for (unsigned rci = RegClasses.size(); rci; --rci) {
 857     CodeGenRegisterClass &RC = *RegClasses[rci - 1];
 858     RC.SubClasses.resize(RegClasses.size());
 859     RC.SubClasses.set(RC.EnumValue);
 860
 861     // Normally, all subclasses have IDs >= rci, unless RC is part of a clique.
 862     for (unsigned s = rci; s != RegClasses.size(); ++s) {
 863       if (RC.SubClasses.test(s))
 864         continue;
 865       CodeGenRegisterClass *SubRC = RegClasses[s];
 866       if (!testSubClass(&RC, SubRC))
 867         continue;
 868       // SubRC is a sub-class. Grap all its sub-classes so we won't have to
 869       // check them again.
 870       RC.SubClasses |= SubRC->SubClasses;
 871     }
 872
 873     // Sweep up missed clique members.  They will be immediately preceding RC.
 874     for (unsigned s = rci - 1; s && testSubClass(&RC, RegClasses[s - 1]); --s)
 875       RC.SubClasses.set(s - 1);
 876   }
 877
 878   // Compute the SuperClasses lists from the SubClasses vectors.
 879   for (unsigned rci = 0; rci != RegClasses.size(); ++rci) {
 880     const BitVector &SC = RegClasses[rci]->getSubClasses();
 881     for (int s = SC.find_first(); s >= 0; s = SC.find_next(s)) {
 882       if (unsigned(s) == rci)
 883         continue;
 884       RegClasses[s]->SuperClasses.push_back(RegClasses[rci]);
 885     }
 886   }
 887
 888   // With the class hierarchy in place, let synthesized register classes inherit
 889   // properties from their closest super-class. The iteration order here can
 890   // propagate properties down multiple levels.
 891   for (unsigned rci = 0; rci != RegClasses.size(); ++rci)
 892     if (!RegClasses[rci]->getDef())
 893       RegClasses[rci]->inheritProperties(RegBank);
 894 }
 895
 896 void
 897 CodeGenRegisterClass::getSuperRegClasses(CodeGenSubRegIndex *SubIdx,
 898                                          BitVector &Out) const {
 899   DenseMap<CodeGenSubRegIndex*,
 900            SmallPtrSet<CodeGenRegisterClass*, 8> >::const_iterator
 901     FindI = SuperRegClasses.find(SubIdx);
 902   if (FindI == SuperRegClasses.end())
 903     return;
 904   for (CodeGenRegisterClass *RC : FindI->second)
 905     Out.set(RC->EnumValue);
 906 }
 907
 908 // Populate a unique sorted list of units from a register set.
 909 void CodeGenRegisterClass::buildRegUnitSet(
 910   std::vector<unsigned> &RegUnits) const {
 911   std::vector<unsigned> TmpUnits;
 912   for (RegUnitIterator UnitI(Members); UnitI.isValid(); ++UnitI)
 913     TmpUnits.push_back(*UnitI);
 914   std::sort(TmpUnits.begin(), TmpUnits.end());
 915   std::unique_copy(TmpUnits.begin(), TmpUnits.end(),
 916                    std::back_inserter(RegUnits));
 917 }
 918
 919 //===----------------------------------------------------------------------===//
 920 //                               CodeGenRegBank
 921 //===----------------------------------------------------------------------===//
 922
 923 CodeGenRegBank::CodeGenRegBank(RecordKeeper &Records) {
 924   // Configure register Sets to understand register classes and tuples.
 925   Sets.addFieldExpander("RegisterClass", "MemberList");
 926   Sets.addFieldExpander("CalleeSavedRegs", "SaveList");
 927   Sets.addExpander("RegisterTuples", new TupleExpander());
 928
 929   // Read in the user-defined (named) sub-register indices.
 930   // More indices will be synthesized later.
 931   std::vector<Record*> SRIs = Records.getAllDerivedDefinitions("SubRegIndex");
 932   std::sort(SRIs.begin(), SRIs.end(), LessRecord());
 933   for (unsigned i = 0, e = SRIs.size(); i != e; ++i)
 934     getSubRegIdx(SRIs[i]);
 935   // Build composite maps from ComposedOf fields.
 936   for (unsigned i = 0, e = SubRegIndices.size(); i != e; ++i)
 937     SubRegIndices[i]->updateComponents(*this);
 938
 939   // Read in the register definitions.
 940   std::vector<Record*> Regs = Records.getAllDerivedDefinitions("Register");
 941   std::sort(Regs.begin(), Regs.end(), LessRecordRegister());
 942   Registers.reserve(Regs.size());
 943   // Assign the enumeration values.
 944   for (unsigned i = 0, e = Regs.size(); i != e; ++i)
 945     getReg(Regs[i]);
 946
 947   // Expand tuples and number the new registers.
 948   std::vector<Record*> Tups =
 949     Records.getAllDerivedDefinitions("RegisterTuples");
 950
 951   std::vector<Record*> TupRegsCopy;
 952   for (unsigned i = 0, e = Tups.size(); i != e; ++i) {
 953     const std::vector<Record*> *TupRegs = Sets.expand(Tups[i]);
 954     TupRegsCopy.reserve(TupRegs->size());
 955     TupRegsCopy.assign(TupRegs->begin(), TupRegs->end());
 956     std::sort(TupRegsCopy.begin(), TupRegsCopy.end(), LessRecordRegister());
 957     for (unsigned j = 0, je = TupRegsCopy.size(); j != je; ++j)
 958       getReg((TupRegsCopy)[j]);
 959     TupRegsCopy.clear();
 960   }
 961
 962   // Now all the registers are known. Build the object graph of explicit
 963   // register-register references.
 964   for (unsigned i = 0, e = Registers.size(); i != e; ++i)
 965     Registers[i]->buildObjectGraph(*this);
 966
 967   // Compute register name map.
 968   for (unsigned i = 0, e = Registers.size(); i != e; ++i)
 969     RegistersByName.GetOrCreateValue(
 970                        Registers[i]->TheDef->getValueAsString("AsmName"),
 971                        Registers[i]);
 972
 973   // Precompute all sub-register maps.
 974   // This will create Composite entries for all inferred sub-register indices.
 975   for (unsigned i = 0, e = Registers.size(); i != e; ++i)
 976     Registers[i]->computeSubRegs(*this);
 977
 978   // Infer even more sub-registers by combining leading super-registers.
 979   for (unsigned i = 0, e = Registers.size(); i != e; ++i)
 980     if (Registers[i]->CoveredBySubRegs)
 981       Registers[i]->computeSecondarySubRegs(*this);
 982
 983   // After the sub-register graph is complete, compute the topologically
 984   // ordered SuperRegs list.
 985   for (unsigned i = 0, e = Registers.size(); i != e; ++i)
 986     Registers[i]->computeSuperRegs(*this);
 987
 988   // Native register units are associated with a leaf register. They've all been
 989   // discovered now.
 990   NumNativeRegUnits = RegUnits.size();
 991
 992   // Read in register class definitions.
 993   std::vector<Record*> RCs = Records.getAllDerivedDefinitions("RegisterClass");
 994   if (RCs.empty())
 995     PrintFatalError("No 'RegisterClass' subclasses defined!");
 996
 997   // Allocate user-defined register classes.
 998   RegClasses.reserve(RCs.size());
 999   for (unsigned i = 0, e = RCs.size(); i != e; ++i)
1000     addToMaps(new CodeGenRegisterClass(*this, RCs[i]));
1001
1002   // Infer missing classes to create a full algebra.
1003   computeInferredRegisterClasses();
1004
1005   // Order register classes topologically and assign enum values.
1006   array_pod_sort(RegClasses.begin(), RegClasses.end(), TopoOrderRC);
1007   for (unsigned i = 0, e = RegClasses.size(); i != e; ++i)
1008     RegClasses[i]->EnumValue = i;
1009   CodeGenRegisterClass::computeSubClasses(*this);
1010 }
1011
1012 // Create a synthetic CodeGenSubRegIndex without a corresponding Record.
1013 CodeGenSubRegIndex*
1014 CodeGenRegBank::createSubRegIndex(StringRef Name, StringRef Namespace) {
1015   CodeGenSubRegIndex *Idx = new CodeGenSubRegIndex(Name, Namespace,
1016                                                    SubRegIndices.size() + 1);
1017   SubRegIndices.push_back(Idx);
1018   return Idx;
1019 }
1020
1021 CodeGenSubRegIndex *CodeGenRegBank::getSubRegIdx(Record *Def) {
1022   CodeGenSubRegIndex *&Idx = Def2SubRegIdx[Def];
1023   if (Idx)
1024     return Idx;
1025   Idx = new CodeGenSubRegIndex(Def, SubRegIndices.size() + 1);
1026   SubRegIndices.push_back(Idx);
1027   return Idx;
1028 }
1029
1030 CodeGenRegister *CodeGenRegBank::getReg(Record *Def) {
1031   CodeGenRegister *&Reg = Def2Reg[Def];
1032   if (Reg)
1033     return Reg;
1034   Reg = new CodeGenRegister(Def, Registers.size() + 1);
1035   Registers.push_back(Reg);
1036   return Reg;
1037 }
1038
1039 void CodeGenRegBank::addToMaps(CodeGenRegisterClass *RC) {
1040   RegClasses.push_back(RC);
1041
1042   if (Record *Def = RC->getDef())
1043     Def2RC.insert(std::make_pair(Def, RC));
1044
1045   // Duplicate classes are rejected by insert().
1046   // That's OK, we only care about the properties handled by CGRC::Key.
1047   CodeGenRegisterClass::Key K(*RC);
1048   Key2RC.insert(std::make_pair(K, RC));
1049 }
1050
1051 // Create a synthetic sub-class if it is missing.
1052 CodeGenRegisterClass*
1053 CodeGenRegBank::getOrCreateSubClass(const CodeGenRegisterClass *RC,
1054                                     const CodeGenRegister::Set *Members,
1055                                     StringRef Name) {
1056   // Synthetic sub-class has the same size and alignment as RC.
1057   CodeGenRegisterClass::Key K(Members, RC->SpillSize, RC->SpillAlignment);
1058   RCKeyMap::const_iterator FoundI = Key2RC.find(K);
1059   if (FoundI != Key2RC.end())
1060     return FoundI->second;
1061
1062   // Sub-class doesn't exist, create a new one.
1063   CodeGenRegisterClass *NewRC = new CodeGenRegisterClass(*this, Name, K);
1064   addToMaps(NewRC);
1065   return NewRC;
1066 }
1067
1068 CodeGenRegisterClass *CodeGenRegBank::getRegClass(Record *Def) {
1069   if (CodeGenRegisterClass *RC = Def2RC[Def])
1070     return RC;
1071
1072   PrintFatalError(Def->getLoc(), "Not a known RegisterClass!");
1073 }
1074
1075 CodeGenSubRegIndex*
1076 CodeGenRegBank::getCompositeSubRegIndex(CodeGenSubRegIndex *A,
1077                                         CodeGenSubRegIndex *B) {
1078   // Look for an existing entry.
1079   CodeGenSubRegIndex *Comp = A->compose(B);
1080   if (Comp)
1081     return Comp;
1082
1083   // None exists, synthesize one.
1084   std::string Name = A->getName() + "_then_" + B->getName();
1085   Comp = createSubRegIndex(Name, A->getNamespace());
1086   A->addComposite(B, Comp);
1087   return Comp;
1088 }
1089
1090 CodeGenSubRegIndex *CodeGenRegBank::
1091 getConcatSubRegIndex(const SmallVector<CodeGenSubRegIndex *, 8> &Parts) {
1092   assert(Parts.size() > 1 && "Need two parts to concatenate");
1093
1094   // Look for an existing entry.
1095   CodeGenSubRegIndex *&Idx = ConcatIdx[Parts];
1096   if (Idx)
1097     return Idx;
1098
1099   // None exists, synthesize one.
1100   std::string Name = Parts.front()->getName();
1101   // Determine whether all parts are contiguous.
1102   bool isContinuous = true;
1103   unsigned Size = Parts.front()->Size;
1104   unsigned LastOffset = Parts.front()->Offset;
1105   unsigned LastSize = Parts.front()->Size;
1106   for (unsigned i = 1, e = Parts.size(); i != e; ++i) {
1107     Name += '_';
1108     Name += Parts[i]->getName();
1109     Size += Parts[i]->Size;
1110     if (Parts[i]->Offset != (LastOffset + LastSize))
1111       isContinuous = false;
1112     LastOffset = Parts[i]->Offset;
1113     LastSize = Parts[i]->Size;
1114   }
1115   Idx = createSubRegIndex(Name, Parts.front()->getNamespace());
1116   Idx->Size = Size;
1117   Idx->Offset = isContinuous ? Parts.front()->Offset : -1;
1118   return Idx;
1119 }
1120
1121 void CodeGenRegBank::computeComposites() {
1122   // Keep track of TopoSigs visited. We only need to visit each TopoSig once,
1123   // and many registers will share TopoSigs on regular architectures.
1124   BitVector TopoSigs(getNumTopoSigs());
1125
1126   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
1127     CodeGenRegister *Reg1 = Registers[i];
1128
1129     // Skip identical subreg structures already processed.
1130     if (TopoSigs.test(Reg1->getTopoSig()))
1131       continue;
1132     TopoSigs.set(Reg1->getTopoSig());
1133
1134     const CodeGenRegister::SubRegMap &SRM1 = Reg1->getSubRegs();
1135     for (CodeGenRegister::SubRegMap::const_iterator i1 = SRM1.begin(),
1136          e1 = SRM1.end(); i1 != e1; ++i1) {
1137       CodeGenSubRegIndex *Idx1 = i1->first;
1138       CodeGenRegister *Reg2 = i1->second;
1139       // Ignore identity compositions.
1140       if (Reg1 == Reg2)
1141         continue;
1142       const CodeGenRegister::SubRegMap &SRM2 = Reg2->getSubRegs();
1143       // Try composing Idx1 with another SubRegIndex.
1144       for (CodeGenRegister::SubRegMap::const_iterator i2 = SRM2.begin(),
1145            e2 = SRM2.end(); i2 != e2; ++i2) {
1146         CodeGenSubRegIndex *Idx2 = i2->first;
1147         CodeGenRegister *Reg3 = i2->second;
1148         // Ignore identity compositions.
1149         if (Reg2 == Reg3)
1150           continue;
1151         // OK Reg1:IdxPair == Reg3. Find the index with Reg:Idx == Reg3.
1152         CodeGenSubRegIndex *Idx3 = Reg1->getSubRegIndex(Reg3);
1153         assert(Idx3 && "Sub-register doesn't have an index");
1154
1155         // Conflicting composition? Emit a warning but allow it.
1156         if (CodeGenSubRegIndex *Prev = Idx1->addComposite(Idx2, Idx3))
1157           PrintWarning(Twine("SubRegIndex ") + Idx1->getQualifiedName() +
1158                        " and " + Idx2->getQualifiedName() +
1159                        " compose ambiguously as " + Prev->getQualifiedName() +
1160                        " or " + Idx3->getQualifiedName());
1161       }
1162     }
1163   }
1164 }
1165
1166 // Compute lane masks. This is similar to register units, but at the
1167 // sub-register index level. Each bit in the lane mask is like a register unit
1168 // class, and two lane masks will have a bit in common if two sub-register
1169 // indices overlap in some register.
1170 //
1171 // Conservatively share a lane mask bit if two sub-register indices overlap in
1172 // some registers, but not in others. That shouldn't happen a lot.
1173 void CodeGenRegBank::computeSubRegIndexLaneMasks() {
1174   // First assign individual bits to all the leaf indices.
1175   unsigned Bit = 0;
1176   // Determine mask of lanes that cover their registers.
1177   CoveringLanes = ~0u;
1178   for (unsigned i = 0, e = SubRegIndices.size(); i != e; ++i) {
1179     CodeGenSubRegIndex *Idx = SubRegIndices[i];
1180     if (Idx->getComposites().empty()) {
1181       Idx->LaneMask = 1u << Bit;
1182       // Share bit 31 in the unlikely case there are more than 32 leafs.
1183       //
1184       // Sharing bits is harmless; it allows graceful degradation in targets
1185       // with more than 32 vector lanes. They simply get a limited resolution
1186       // view of lanes beyond the 32nd.
1187       //
1188       // See also the comment for getSubRegIndexLaneMask().
1189       if (Bit < 31)
1190         ++Bit;
1191       else
1192         // Once bit 31 is shared among multiple leafs, the 'lane' it represents
1193         // is no longer covering its registers.
1194         CoveringLanes &= ~(1u << Bit);
1195     } else {
1196       Idx->LaneMask = 0;
1197     }
1198   }
1199
1200   // FIXME: What if ad-hoc aliasing introduces overlaps that aren't represented
1201   // by the sub-register graph? This doesn't occur in any known targets.
1202
1203   // Inherit lanes from composites.
1204   for (unsigned i = 0, e = SubRegIndices.size(); i != e; ++i) {
1205     unsigned Mask = SubRegIndices[i]->computeLaneMask();
1206     // If some super-registers without CoveredBySubRegs use this index, we can
1207     // no longer assume that the lanes are covering their registers.
1208     if (!SubRegIndices[i]->AllSuperRegsCovered)
1209       CoveringLanes &= ~Mask;
1210   }
1211 }
1212
1213 namespace {
1214 // UberRegSet is a helper class for computeRegUnitWeights. Each UberRegSet is
1215 // the transitive closure of the union of overlapping register
1216 // classes. Together, the UberRegSets form a partition of the registers. If we
1217 // consider overlapping register classes to be connected, then each UberRegSet
1218 // is a set of connected components.
1219 //
1220 // An UberRegSet will likely be a horizontal slice of register names of
1221 // the same width. Nontrivial subregisters should then be in a separate
1222 // UberRegSet. But this property isn't required for valid computation of
1223 // register unit weights.
1224 //
1225 // A Weight field caches the max per-register unit weight in each UberRegSet.
1226 //
1227 // A set of SingularDeterminants flags single units of some register in this set
1228 // for which the unit weight equals the set weight. These units should not have
1229 // their weight increased.
1230 struct UberRegSet {
1231   CodeGenRegister::Set Regs;
1232   unsigned Weight;
1233   CodeGenRegister::RegUnitList SingularDeterminants;
1234
1235   UberRegSet(): Weight(0) {}
1236 };
1237 } // namespace
1238
1239 // Partition registers into UberRegSets, where each set is the transitive
1240 // closure of the union of overlapping register classes.
1241 //
1242 // UberRegSets[0] is a special non-allocatable set.
1243 static void computeUberSets(std::vector<UberRegSet> &UberSets,
1244                             std::vector<UberRegSet*> &RegSets,
1245                             CodeGenRegBank &RegBank) {
1246
1247   const std::vector<CodeGenRegister*> &Registers = RegBank.getRegisters();
1248
1249   // The Register EnumValue is one greater than its index into Registers.
1250   assert(Registers.size() == Registers[Registers.size()-1]->EnumValue &&
1251          "register enum value mismatch");
1252
1253   // For simplicitly make the SetID the same as EnumValue.
1254   IntEqClasses UberSetIDs(Registers.size()+1);
1255   std::set<unsigned> AllocatableRegs;
1256   for (unsigned i = 0, e = RegBank.getRegClasses().size(); i != e; ++i) {
1257
1258     CodeGenRegisterClass *RegClass = RegBank.getRegClasses()[i];
1259     if (!RegClass->Allocatable)
1260       continue;
1261
1262     const CodeGenRegister::Set &Regs = RegClass->getMembers();
1263     if (Regs.empty())
1264       continue;
1265
1266     unsigned USetID = UberSetIDs.findLeader((*Regs.begin())->EnumValue);
1267     assert(USetID && "register number 0 is invalid");
1268
1269     AllocatableRegs.insert((*Regs.begin())->EnumValue);
1270     for (CodeGenRegister::Set::const_iterator I = std::next(Regs.begin()),
1271            E = Regs.end(); I != E; ++I) {
1272       AllocatableRegs.insert((*I)->EnumValue);
1273       UberSetIDs.join(USetID, (*I)->EnumValue);
1274     }
1275   }
1276   // Combine non-allocatable regs.
1277   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
1278     unsigned RegNum = Registers[i]->EnumValue;
1279     if (AllocatableRegs.count(RegNum))
1280       continue;
1281
1282     UberSetIDs.join(0, RegNum);
1283   }
1284   UberSetIDs.compress();
1285
1286   // Make the first UberSet a special unallocatable set.
1287   unsigned ZeroID = UberSetIDs[0];
1288
1289   // Insert Registers into the UberSets formed by union-find.
1290   // Do not resize after this.
1291   UberSets.resize(UberSetIDs.getNumClasses());
1292   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
1293     const CodeGenRegister *Reg = Registers[i];
1294     unsigned USetID = UberSetIDs[Reg->EnumValue];
1295     if (!USetID)
1296       USetID = ZeroID;
1297     else if (USetID == ZeroID)
1298       USetID = 0;
1299
1300     UberRegSet *USet = &UberSets[USetID];
1301     USet->Regs.insert(Reg);
1302     RegSets[i] = USet;
1303   }
1304 }
1305
1306 // Recompute each UberSet weight after changing unit weights.
1307 static void computeUberWeights(std::vector<UberRegSet> &UberSets,
1308                                CodeGenRegBank &RegBank) {
1309   // Skip the first unallocatable set.
1310   for (std::vector<UberRegSet>::iterator I = std::next(UberSets.begin()),
1311          E = UberSets.end(); I != E; ++I) {
1312
1313     // Initialize all unit weights in this set, and remember the max units/reg.
1314     const CodeGenRegister *Reg = nullptr;
1315     unsigned MaxWeight = 0, Weight = 0;
1316     for (RegUnitIterator UnitI(I->Regs); UnitI.isValid(); ++UnitI) {
1317       if (Reg != UnitI.getReg()) {
1318         if (Weight > MaxWeight)
1319           MaxWeight = Weight;
1320         Reg = UnitI.getReg();
1321         Weight = 0;
1322       }
1323       unsigned UWeight = RegBank.getRegUnit(*UnitI).Weight;
1324       if (!UWeight) {
1325         UWeight = 1;
1326         RegBank.increaseRegUnitWeight(*UnitI, UWeight);
1327       }
1328       Weight += UWeight;
1329     }
1330     if (Weight > MaxWeight)
1331       MaxWeight = Weight;
1332     if (I->Weight != MaxWeight) {
1333       DEBUG(
1334         dbgs() << "UberSet " << I - UberSets.begin() << " Weight " << MaxWeight;
1335         for (CodeGenRegister::Set::iterator
1336                UnitI = I->Regs.begin(), UnitE = I->Regs.end();
1337              UnitI != UnitE; ++UnitI) {
1338           dbgs() << " " << (*UnitI)->getName();
1339         }
1340         dbgs() << "\n");
1341       // Update the set weight.
1342       I->Weight = MaxWeight;
1343     }
1344
1345     // Find singular determinants.
1346     for (CodeGenRegister::Set::iterator RegI = I->Regs.begin(),
1347            RegE = I->Regs.end(); RegI != RegE; ++RegI) {
1348       if ((*RegI)->getRegUnits().size() == 1
1349           && (*RegI)->getWeight(RegBank) == I->Weight)
1350         mergeRegUnits(I->SingularDeterminants, (*RegI)->getRegUnits());
1351     }
1352   }
1353 }
1354
1355 // normalizeWeight is a computeRegUnitWeights helper that adjusts the weight of
1356 // a register and its subregisters so that they have the same weight as their
1357 // UberSet. Self-recursion processes the subregister tree in postorder so
1358 // subregisters are normalized first.
1359 //
1360 // Side effects:
1361 // - creates new adopted register units
1362 // - causes superregisters to inherit adopted units
1363 // - increases the weight of "singular" units
1364 // - induces recomputation of UberWeights.
1365 static bool normalizeWeight(CodeGenRegister *Reg,
1366                             std::vector<UberRegSet> &UberSets,
1367                             std::vector<UberRegSet*> &RegSets,
1368                             std::set<unsigned> &NormalRegs,
1369                             CodeGenRegister::RegUnitList &NormalUnits,
1370                             CodeGenRegBank &RegBank) {
1371   bool Changed = false;
1372   if (!NormalRegs.insert(Reg->EnumValue).second)
1373     return Changed;
1374
1375   const CodeGenRegister::SubRegMap &SRM = Reg->getSubRegs();
1376   for (CodeGenRegister::SubRegMap::const_iterator SRI = SRM.begin(),
1377          SRE = SRM.end(); SRI != SRE; ++SRI) {
1378     if (SRI->second == Reg)
1379       continue; // self-cycles happen
1380
1381     Changed |= normalizeWeight(SRI->second, UberSets, RegSets,
1382                                NormalRegs, NormalUnits, RegBank);
1383   }
1384   // Postorder register normalization.
1385
1386   // Inherit register units newly adopted by subregisters.
1387   if (Reg->inheritRegUnits(RegBank))
1388     computeUberWeights(UberSets, RegBank);
1389
1390   // Check if this register is too skinny for its UberRegSet.
1391   UberRegSet *UberSet = RegSets[RegBank.getRegIndex(Reg)];
1392
1393   unsigned RegWeight = Reg->getWeight(RegBank);
1394   if (UberSet->Weight > RegWeight) {
1395     // A register unit's weight can be adjusted only if it is the singular unit
1396     // for this register, has not been used to normalize a subregister's set,
1397     // and has not already been used to singularly determine this UberRegSet.
1398     unsigned AdjustUnit = Reg->getRegUnits().front();
1399     if (Reg->getRegUnits().size() != 1
1400         || hasRegUnit(NormalUnits, AdjustUnit)
1401         || hasRegUnit(UberSet->SingularDeterminants, AdjustUnit)) {
1402       // We don't have an adjustable unit, so adopt a new one.
1403       AdjustUnit = RegBank.newRegUnit(UberSet->Weight - RegWeight);
1404       Reg->adoptRegUnit(AdjustUnit);
1405       // Adopting a unit does not immediately require recomputing set weights.
1406     }
1407     else {
1408       // Adjust the existing single unit.
1409       RegBank.increaseRegUnitWeight(AdjustUnit, UberSet->Weight - RegWeight);
1410       // The unit may be shared among sets and registers within this set.
1411       computeUberWeights(UberSets, RegBank);
1412     }
1413     Changed = true;
1414   }
1415
1416   // Mark these units normalized so superregisters can't change their weights.
1417   mergeRegUnits(NormalUnits, Reg->getRegUnits());
1418
1419   return Changed;
1420 }
1421
1422 // Compute a weight for each register unit created during getSubRegs.
1423 //
1424 // The goal is that two registers in the same class will have the same weight,
1425 // where each register's weight is defined as sum of its units' weights.
1426 void CodeGenRegBank::computeRegUnitWeights() {
1427   std::vector<UberRegSet> UberSets;
1428   std::vector<UberRegSet*> RegSets(Registers.size());
1429   computeUberSets(UberSets, RegSets, *this);
1430   // UberSets and RegSets are now immutable.
1431
1432   computeUberWeights(UberSets, *this);
1433
1434   // Iterate over each Register, normalizing the unit weights until reaching
1435   // a fix point.
1436   unsigned NumIters = 0;
1437   for (bool Changed = true; Changed; ++NumIters) {
1438     assert(NumIters <= NumNativeRegUnits && "Runaway register unit weights");
1439     Changed = false;
1440     for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
1441       CodeGenRegister::RegUnitList NormalUnits;
1442       std::set<unsigned> NormalRegs;
1443       Changed |= normalizeWeight(Registers[i], UberSets, RegSets,
1444                                  NormalRegs, NormalUnits, *this);
1445     }
1446   }
1447 }
1448
1449 // Find a set in UniqueSets with the same elements as Set.
1450 // Return an iterator into UniqueSets.
1451 static std::vector<RegUnitSet>::const_iterator
1452 findRegUnitSet(const std::vector<RegUnitSet> &UniqueSets,
1453                const RegUnitSet &Set) {
1454   std::vector<RegUnitSet>::const_iterator
1455     I = UniqueSets.begin(), E = UniqueSets.end();
1456   for(;I != E; ++I) {
1457     if (I->Units == Set.Units)
1458       break;
1459   }
1460   return I;
1461 }
1462
1463 // Return true if the RUSubSet is a subset of RUSuperSet.
1464 static bool isRegUnitSubSet(const std::vector<unsigned> &RUSubSet,
1465                             const std::vector<unsigned> &RUSuperSet) {
1466   return std::includes(RUSuperSet.begin(), RUSuperSet.end(),
1467                        RUSubSet.begin(), RUSubSet.end());
1468 }
1469
1470 /// Iteratively prune unit sets. Prune subsets that are close to the superset,
1471 /// but with one or two registers removed. We occasionally have registers like
1472 /// APSR and PC thrown in with the general registers. We also see many
1473 /// special-purpose register subsets, such as tail-call and Thumb
1474 /// encodings. Generating all possible overlapping sets is combinatorial and
1475 /// overkill for modeling pressure. Ideally we could fix this statically in
1476 /// tablegen by (1) having the target define register classes that only include
1477 /// the allocatable registers and marking other classes as non-allocatable and
1478 /// (2) having a way to mark special purpose classes as "don't-care" classes for
1479 /// the purpose of pressure.  However, we make an attempt to handle targets that
1480 /// are not nicely defined by merging nearly identical register unit sets
1481 /// statically. This generates smaller tables. Then, dynamically, we adjust the
1482 /// set limit by filtering the reserved registers.
1483 ///
1484 /// Merge sets only if the units have the same weight. For example, on ARM,
1485 /// Q-tuples with ssub index 0 include all S regs but also include D16+. We
1486 /// should not expand the S set to include D regs.
1487 void CodeGenRegBank::pruneUnitSets() {
1488   assert(RegClassUnitSets.empty() && "this invalidates RegClassUnitSets");
1489
1490   // Form an equivalence class of UnitSets with no significant difference.
1491   std::vector<unsigned> SuperSetIDs;
1492   for (unsigned SubIdx = 0, EndIdx = RegUnitSets.size();
1493        SubIdx != EndIdx; ++SubIdx) {
1494     const RegUnitSet &SubSet = RegUnitSets[SubIdx];
1495     unsigned SuperIdx = 0;
1496     for (; SuperIdx != EndIdx; ++SuperIdx) {
1497       if (SuperIdx == SubIdx)
1498         continue;
1499
1500       unsigned UnitWeight = RegUnits[SubSet.Units[0]].Weight;
1501       const RegUnitSet &SuperSet = RegUnitSets[SuperIdx];
1502       if (isRegUnitSubSet(SubSet.Units, SuperSet.Units)
1503           && (SubSet.Units.size() + 3 > SuperSet.Units.size())
1504           && UnitWeight == RegUnits[SuperSet.Units[0]].Weight
1505           && UnitWeight == RegUnits[SuperSet.Units.back()].Weight) {
1506         DEBUG(dbgs() << "UnitSet " << SubIdx << " subsumed by " << SuperIdx
1507               << "\n");
1508         break;
1509       }
1510     }
1511     if (SuperIdx == EndIdx)
1512       SuperSetIDs.push_back(SubIdx);
1513   }
1514   // Populate PrunedUnitSets with each equivalence class's superset.
1515   std::vector<RegUnitSet> PrunedUnitSets(SuperSetIDs.size());
1516   for (unsigned i = 0, e = SuperSetIDs.size(); i != e; ++i) {
1517     unsigned SuperIdx = SuperSetIDs[i];
1518     PrunedUnitSets[i].Name = RegUnitSets[SuperIdx].Name;
1519     PrunedUnitSets[i].Units.swap(RegUnitSets[SuperIdx].Units);
1520   }
1521   RegUnitSets.swap(PrunedUnitSets);
1522 }
1523
1524 // Create a RegUnitSet for each RegClass that contains all units in the class
1525 // including adopted units that are necessary to model register pressure. Then
1526 // iteratively compute RegUnitSets such that the union of any two overlapping
1527 // RegUnitSets is repreresented.
1528 //
1529 // RegisterInfoEmitter will map each RegClass to its RegUnitClass and any
1530 // RegUnitSet that is a superset of that RegUnitClass.
1531 void CodeGenRegBank::computeRegUnitSets() {
1532   assert(RegUnitSets.empty() && "dirty RegUnitSets");
1533
1534   // Compute a unique RegUnitSet for each RegClass.
1535   ArrayRef<CodeGenRegisterClass*> RegClasses = getRegClasses();
1536   unsigned NumRegClasses = RegClasses.size();
1537   for (unsigned RCIdx = 0, RCEnd = NumRegClasses; RCIdx != RCEnd; ++RCIdx) {
1538     if (!RegClasses[RCIdx]->Allocatable)
1539       continue;
1540
1541     // Speculatively grow the RegUnitSets to hold the new set.
1542     RegUnitSets.resize(RegUnitSets.size() + 1);
1543     RegUnitSets.back().Name = RegClasses[RCIdx]->getName();
1544
1545     // Compute a sorted list of units in this class.
1546     RegClasses[RCIdx]->buildRegUnitSet(RegUnitSets.back().Units);
1547
1548     // Find an existing RegUnitSet.
1549     std::vector<RegUnitSet>::const_iterator SetI =
1550       findRegUnitSet(RegUnitSets, RegUnitSets.back());
1551     if (SetI != std::prev(RegUnitSets.end()))
1552       RegUnitSets.pop_back();
1553   }
1554
1555   DEBUG(dbgs() << "\nBefore pruning:\n";
1556         for (unsigned USIdx = 0, USEnd = RegUnitSets.size();
1557              USIdx < USEnd; ++USIdx) {
1558           dbgs() << "UnitSet " << USIdx << " " << RegUnitSets[USIdx].Name
1559                  << ":";
1560           ArrayRef<unsigned> Units = RegUnitSets[USIdx].Units;
1561           for (unsigned i = 0, e = Units.size(); i < e; ++i)
1562             dbgs() << " " << RegUnits[Units[i]].Roots[0]->getName();
1563           dbgs() << "\n";
1564         });
1565
1566   // Iteratively prune unit sets.
1567   pruneUnitSets();
1568
1569   DEBUG(dbgs() << "\nBefore union:\n";
1570         for (unsigned USIdx = 0, USEnd = RegUnitSets.size();
1571              USIdx < USEnd; ++USIdx) {
1572           dbgs() << "UnitSet " << USIdx << " " << RegUnitSets[USIdx].Name
1573                  << ":";
1574           ArrayRef<unsigned> Units = RegUnitSets[USIdx].Units;
1575           for (unsigned i = 0, e = Units.size(); i < e; ++i)
1576             dbgs() << " " << RegUnits[Units[i]].Roots[0]->getName();
1577           dbgs() << "\n";
1578         }
1579         dbgs() << "\nUnion sets:\n");
1580
1581   // Iterate over all unit sets, including new ones added by this loop.
1582   unsigned NumRegUnitSubSets = RegUnitSets.size();
1583   for (unsigned Idx = 0, EndIdx = RegUnitSets.size(); Idx != EndIdx; ++Idx) {
1584     // In theory, this is combinatorial. In practice, it needs to be bounded
1585     // by a small number of sets for regpressure to be efficient.
1586     // If the assert is hit, we need to implement pruning.
1587     assert(Idx < (2*NumRegUnitSubSets) && "runaway unit set inference");
1588
1589     // Compare new sets with all original classes.
1590     for (unsigned SearchIdx = (Idx >= NumRegUnitSubSets) ? 0 : Idx+1;
1591          SearchIdx != EndIdx; ++SearchIdx) {
1592       std::set<unsigned> Intersection;
1593       std::set_intersection(RegUnitSets[Idx].Units.begin(),
1594                             RegUnitSets[Idx].Units.end(),
1595                             RegUnitSets[SearchIdx].Units.begin(),
1596                             RegUnitSets[SearchIdx].Units.end(),
1597                             std::inserter(Intersection, Intersection.begin()));
1598       if (Intersection.empty())
1599         continue;
1600
1601       // Speculatively grow the RegUnitSets to hold the new set.
1602       RegUnitSets.resize(RegUnitSets.size() + 1);
1603       RegUnitSets.back().Name =
1604         RegUnitSets[Idx].Name + "+" + RegUnitSets[SearchIdx].Name;
1605
1606       std::set_union(RegUnitSets[Idx].Units.begin(),
1607                      RegUnitSets[Idx].Units.end(),
1608                      RegUnitSets[SearchIdx].Units.begin(),
1609                      RegUnitSets[SearchIdx].Units.end(),
1610                      std::inserter(RegUnitSets.back().Units,
1611                                    RegUnitSets.back().Units.begin()));
1612
1613       // Find an existing RegUnitSet, or add the union to the unique sets.
1614       std::vector<RegUnitSet>::const_iterator SetI =
1615         findRegUnitSet(RegUnitSets, RegUnitSets.back());
1616       if (SetI != std::prev(RegUnitSets.end()))
1617         RegUnitSets.pop_back();
1618       else {
1619         DEBUG(dbgs() << "UnitSet " << RegUnitSets.size()-1
1620               << " " << RegUnitSets.back().Name << ":";
1621               ArrayRef<unsigned> Units = RegUnitSets.back().Units;
1622               for (unsigned i = 0, e = Units.size(); i < e; ++i)
1623                 dbgs() << " " << RegUnits[Units[i]].Roots[0]->getName();
1624               dbgs() << "\n";);
1625       }
1626     }
1627   }
1628
1629   // Iteratively prune unit sets after inferring supersets.
1630   pruneUnitSets();
1631
1632   DEBUG(dbgs() << "\n";
1633         for (unsigned USIdx = 0, USEnd = RegUnitSets.size();
1634              USIdx < USEnd; ++USIdx) {
1635           dbgs() << "UnitSet " << USIdx << " " << RegUnitSets[USIdx].Name
1636                  << ":";
1637           ArrayRef<unsigned> Units = RegUnitSets[USIdx].Units;
1638           for (unsigned i = 0, e = Units.size(); i < e; ++i)
1639             dbgs() << " " << RegUnits[Units[i]].Roots[0]->getName();
1640           dbgs() << "\n";
1641         });
1642
1643   // For each register class, list the UnitSets that are supersets.
1644   RegClassUnitSets.resize(NumRegClasses);
1645   for (unsigned RCIdx = 0, RCEnd = NumRegClasses; RCIdx != RCEnd; ++RCIdx) {
1646     if (!RegClasses[RCIdx]->Allocatable)
1647       continue;
1648
1649     // Recompute the sorted list of units in this class.
1650     std::vector<unsigned> RCRegUnits;
1651     RegClasses[RCIdx]->buildRegUnitSet(RCRegUnits);
1652
1653     // Don't increase pressure for unallocatable regclasses.
1654     if (RCRegUnits.empty())
1655       continue;
1656
1657     DEBUG(dbgs() << "RC " << RegClasses[RCIdx]->getName() << " Units: \n";
1658           for (unsigned i = 0, e = RCRegUnits.size(); i < e; ++i)
1659             dbgs() << RegUnits[RCRegUnits[i]].getRoots()[0]->getName() << " ";
1660           dbgs() << "\n  UnitSetIDs:");
1661
1662     // Find all supersets.
1663     for (unsigned USIdx = 0, USEnd = RegUnitSets.size();
1664          USIdx != USEnd; ++USIdx) {
1665       if (isRegUnitSubSet(RCRegUnits, RegUnitSets[USIdx].Units)) {
1666         DEBUG(dbgs() << " " << USIdx);
1667         RegClassUnitSets[RCIdx].push_back(USIdx);
1668       }
1669     }
1670     DEBUG(dbgs() << "\n");
1671     assert(!RegClassUnitSets[RCIdx].empty() && "missing unit set for regclass");
1672   }
1673
1674   // For each register unit, ensure that we have the list of UnitSets that
1675   // contain the unit. Normally, this matches an existing list of UnitSets for a
1676   // register class. If not, we create a new entry in RegClassUnitSets as a
1677   // "fake" register class.
1678   for (unsigned UnitIdx = 0, UnitEnd = NumNativeRegUnits;
1679        UnitIdx < UnitEnd; ++UnitIdx) {
1680     std::vector<unsigned> RUSets;
1681     for (unsigned i = 0, e = RegUnitSets.size(); i != e; ++i) {
1682       RegUnitSet &RUSet = RegUnitSets[i];
1683       if (std::find(RUSet.Units.begin(), RUSet.Units.end(), UnitIdx)
1684           == RUSet.Units.end())
1685         continue;
1686       RUSets.push_back(i);
1687     }
1688     unsigned RCUnitSetsIdx = 0;
1689     for (unsigned e = RegClassUnitSets.size();
1690          RCUnitSetsIdx != e; ++RCUnitSetsIdx) {
1691       if (RegClassUnitSets[RCUnitSetsIdx] == RUSets) {
1692         break;
1693       }
1694     }
1695     RegUnits[UnitIdx].RegClassUnitSetsIdx = RCUnitSetsIdx;
1696     if (RCUnitSetsIdx == RegClassUnitSets.size()) {
1697       // Create a new list of UnitSets as a "fake" register class.
1698       RegClassUnitSets.resize(RCUnitSetsIdx + 1);
1699       RegClassUnitSets[RCUnitSetsIdx].swap(RUSets);
1700     }
1701   }
1702 }
1703
1704 void CodeGenRegBank::computeDerivedInfo() {
1705   computeComposites();
1706   computeSubRegIndexLaneMasks();
1707
1708   // Compute a weight for each register unit created during getSubRegs.
1709   // This may create adopted register units (with unit # >= NumNativeRegUnits).
1710   computeRegUnitWeights();
1711
1712   // Compute a unique set of RegUnitSets. One for each RegClass and inferred
1713   // supersets for the union of overlapping sets.
1714   computeRegUnitSets();
1715
1716   // Get the weight of each set.
1717   for (unsigned Idx = 0, EndIdx = RegUnitSets.size(); Idx != EndIdx; ++Idx)
1718     RegUnitSets[Idx].Weight = getRegUnitSetWeight(RegUnitSets[Idx].Units);
1719
1720   // Find the order of each set.
1721   RegUnitSetOrder.reserve(RegUnitSets.size());
1722   for (unsigned Idx = 0, EndIdx = RegUnitSets.size(); Idx != EndIdx; ++Idx)
1723     RegUnitSetOrder.push_back(Idx);
1724
1725   std::stable_sort(RegUnitSetOrder.begin(), RegUnitSetOrder.end(),
1726                    [this](unsigned ID1, unsigned ID2) {
1727     return getRegPressureSet(ID1).Units.size() <
1728            getRegPressureSet(ID2).Units.size();
1729   });
1730   for (unsigned Idx = 0, EndIdx = RegUnitSets.size(); Idx != EndIdx; ++Idx) {
1731     RegUnitSets[RegUnitSetOrder[Idx]].Order = Idx;
1732   }
1733 }
1734
1735 //
1736 // Synthesize missing register class intersections.
1737 //
1738 // Make sure that sub-classes of RC exists such that getCommonSubClass(RC, X)
1739 // returns a maximal register class for all X.
1740 //
1741 void CodeGenRegBank::inferCommonSubClass(CodeGenRegisterClass *RC) {
1742   for (unsigned rci = 0, rce = RegClasses.size(); rci != rce; ++rci) {
1743     CodeGenRegisterClass *RC1 = RC;
1744     CodeGenRegisterClass *RC2 = RegClasses[rci];
1745     if (RC1 == RC2)
1746       continue;
1747
1748     // Compute the set intersection of RC1 and RC2.
1749     const CodeGenRegister::Set &Memb1 = RC1->getMembers();
1750     const CodeGenRegister::Set &Memb2 = RC2->getMembers();
1751     CodeGenRegister::Set Intersection;
1752     std::set_intersection(Memb1.begin(), Memb1.end(),
1753                           Memb2.begin(), Memb2.end(),
1754                           std::inserter(Intersection, Intersection.begin()),
1755                           CodeGenRegister::Less());
1756
1757     // Skip disjoint class pairs.
1758     if (Intersection.empty())
1759       continue;
1760
1761     // If RC1 and RC2 have different spill sizes or alignments, use the
1762     // larger size for sub-classing.  If they are equal, prefer RC1.
1763     if (RC2->SpillSize > RC1->SpillSize ||
1764         (RC2->SpillSize == RC1->SpillSize &&
1765          RC2->SpillAlignment > RC1->SpillAlignment))
1766       std::swap(RC1, RC2);
1767
1768     getOrCreateSubClass(RC1, &Intersection,
1769                         RC1->getName() + "_and_" + RC2->getName());
1770   }
1771 }
1772
1773 //
1774 // Synthesize missing sub-classes for getSubClassWithSubReg().
1775 //
1776 // Make sure that the set of registers in RC with a given SubIdx sub-register
1777 // form a register class.  Update RC->SubClassWithSubReg.
1778 //
1779 void CodeGenRegBank::inferSubClassWithSubReg(CodeGenRegisterClass *RC) {
1780   // Map SubRegIndex to set of registers in RC supporting that SubRegIndex.
1781   typedef std::map<CodeGenSubRegIndex*, CodeGenRegister::Set,
1782                    CodeGenSubRegIndex::Less> SubReg2SetMap;
1783
1784   // Compute the set of registers supporting each SubRegIndex.
1785   SubReg2SetMap SRSets;
1786   for (CodeGenRegister::Set::const_iterator RI = RC->getMembers().begin(),
1787        RE = RC->getMembers().end(); RI != RE; ++RI) {
1788     const CodeGenRegister::SubRegMap &SRM = (*RI)->getSubRegs();
1789     for (CodeGenRegister::SubRegMap::const_iterator I = SRM.begin(),
1790          E = SRM.end(); I != E; ++I)
1791       SRSets[I->first].insert(*RI);
1792   }
1793
1794   // Find matching classes for all SRSets entries.  Iterate in SubRegIndex
1795   // numerical order to visit synthetic indices last.
1796   for (unsigned sri = 0, sre = SubRegIndices.size(); sri != sre; ++sri) {
1797     CodeGenSubRegIndex *SubIdx = SubRegIndices[sri];
1798     SubReg2SetMap::const_iterator I = SRSets.find(SubIdx);
1799     // Unsupported SubRegIndex. Skip it.
1800     if (I == SRSets.end())
1801       continue;
1802     // In most cases, all RC registers support the SubRegIndex.
1803     if (I->second.size() == RC->getMembers().size()) {
1804       RC->setSubClassWithSubReg(SubIdx, RC);
1805       continue;
1806     }
1807     // This is a real subset.  See if we have a matching class.
1808     CodeGenRegisterClass *SubRC =
1809       getOrCreateSubClass(RC, &I->second,
1810                           RC->getName() + "_with_" + I->first->getName());
1811     RC->setSubClassWithSubReg(SubIdx, SubRC);
1812   }
1813 }
1814
1815 //
1816 // Synthesize missing sub-classes of RC for getMatchingSuperRegClass().
1817 //
1818 // Create sub-classes of RC such that getMatchingSuperRegClass(RC, SubIdx, X)
1819 // has a maximal result for any SubIdx and any X >= FirstSubRegRC.
1820 //
1821
1822 void CodeGenRegBank::inferMatchingSuperRegClass(CodeGenRegisterClass *RC,
1823                                                 unsigned FirstSubRegRC) {
1824   SmallVector<std::pair<const CodeGenRegister*,
1825                         const CodeGenRegister*>, 16> SSPairs;
1826   BitVector TopoSigs(getNumTopoSigs());
1827
1828   // Iterate in SubRegIndex numerical order to visit synthetic indices last.
1829   for (unsigned sri = 0, sre = SubRegIndices.size(); sri != sre; ++sri) {
1830     CodeGenSubRegIndex *SubIdx = SubRegIndices[sri];
1831     // Skip indexes that aren't fully supported by RC's registers. This was
1832     // computed by inferSubClassWithSubReg() above which should have been
1833     // called first.
1834     if (RC->getSubClassWithSubReg(SubIdx) != RC)
1835       continue;
1836
1837     // Build list of (Super, Sub) pairs for this SubIdx.
1838     SSPairs.clear();
1839     TopoSigs.reset();
1840     for (CodeGenRegister::Set::const_iterator RI = RC->getMembers().begin(),
1841          RE = RC->getMembers().end(); RI != RE; ++RI) {
1842       const CodeGenRegister *Super = *RI;
1843       const CodeGenRegister *Sub = Super->getSubRegs().find(SubIdx)->second;
1844       assert(Sub && "Missing sub-register");
1845       SSPairs.push_back(std::make_pair(Super, Sub));
1846       TopoSigs.set(Sub->getTopoSig());
1847     }
1848
1849     // Iterate over sub-register class candidates.  Ignore classes created by
1850     // this loop. They will never be useful.
1851     for (unsigned rci = FirstSubRegRC, rce = RegClasses.size(); rci != rce;
1852          ++rci) {
1853       CodeGenRegisterClass *SubRC = RegClasses[rci];
1854       // Topological shortcut: SubRC members have the wrong shape.
1855       if (!TopoSigs.anyCommon(SubRC->getTopoSigs()))
1856         continue;
1857       // Compute the subset of RC that maps into SubRC.
1858       CodeGenRegister::Set SubSet;
1859       for (unsigned i = 0, e = SSPairs.size(); i != e; ++i)
1860         if (SubRC->contains(SSPairs[i].second))
1861           SubSet.insert(SSPairs[i].first);
1862       if (SubSet.empty())
1863         continue;
1864       // RC injects completely into SubRC.
1865       if (SubSet.size() == SSPairs.size()) {
1866         SubRC->addSuperRegClass(SubIdx, RC);
1867         continue;
1868       }
1869       // Only a subset of RC maps into SubRC. Make sure it is represented by a
1870       // class.
1871       getOrCreateSubClass(RC, &SubSet, RC->getName() +
1872                           "_with_" + SubIdx->getName() +
1873                           "_in_" + SubRC->getName());
1874     }
1875   }
1876 }
1877
1878
1879 //
1880 // Infer missing register classes.
1881 //
1882 void CodeGenRegBank::computeInferredRegisterClasses() {
1883   // When this function is called, the register classes have not been sorted
1884   // and assigned EnumValues yet.  That means getSubClasses(),
1885   // getSuperClasses(), and hasSubClass() functions are defunct.
1886   unsigned FirstNewRC = RegClasses.size();
1887
1888   // Visit all register classes, including the ones being added by the loop.
1889   for (unsigned rci = 0; rci != RegClasses.size(); ++rci) {
1890     CodeGenRegisterClass *RC = RegClasses[rci];
1891
1892     // Synthesize answers for getSubClassWithSubReg().
1893     inferSubClassWithSubReg(RC);
1894
1895     // Synthesize answers for getCommonSubClass().
1896     inferCommonSubClass(RC);
1897
1898     // Synthesize answers for getMatchingSuperRegClass().
1899     inferMatchingSuperRegClass(RC);
1900
1901     // New register classes are created while this loop is running, and we need
1902     // to visit all of them.  I  particular, inferMatchingSuperRegClass needs
1903     // to match old super-register classes with sub-register classes created
1904     // after inferMatchingSuperRegClass was called.  At this point,
1905     // inferMatchingSuperRegClass has checked SuperRC = [0..rci] with SubRC =
1906     // [0..FirstNewRC).  We need to cover SubRC = [FirstNewRC..rci].
1907     if (rci + 1 == FirstNewRC) {
1908       unsigned NextNewRC = RegClasses.size();
1909       for (unsigned rci2 = 0; rci2 != FirstNewRC; ++rci2)
1910         inferMatchingSuperRegClass(RegClasses[rci2], FirstNewRC);
1911       FirstNewRC = NextNewRC;
1912     }
1913   }
1914 }
1915
1916 /// getRegisterClassForRegister - Find the register class that contains the
1917 /// specified physical register.  If the register is not in a register class,
1918 /// return null. If the register is in multiple classes, and the classes have a
1919 /// superset-subset relationship and the same set of types, return the
1920 /// superclass.  Otherwise return null.
1921 const CodeGenRegisterClass*
1922 CodeGenRegBank::getRegClassForRegister(Record *R) {
1923   const CodeGenRegister *Reg = getReg(R);
1924   ArrayRef<CodeGenRegisterClass*> RCs = getRegClasses();
1925   const CodeGenRegisterClass *FoundRC = nullptr;
1926   for (unsigned i = 0, e = RCs.size(); i != e; ++i) {
1927     const CodeGenRegisterClass &RC = *RCs[i];
1928     if (!RC.contains(Reg))
1929       continue;
1930
1931     // If this is the first class that contains the register,
1932     // make a note of it and go on to the next class.
1933     if (!FoundRC) {
1934       FoundRC = &RC;
1935       continue;
1936     }
1937
1938     // If a register's classes have different types, return null.
1939     if (RC.getValueTypes() != FoundRC->getValueTypes())
1940       return nullptr;
1941
1942     // Check to see if the previously found class that contains
1943     // the register is a subclass of the current class. If so,
1944     // prefer the superclass.
1945     if (RC.hasSubClass(FoundRC)) {
1946       FoundRC = &RC;
1947       continue;
1948     }
1949
1950     // Check to see if the previously found class that contains
1951     // the register is a superclass of the current class. If so,
1952     // prefer the superclass.
1953     if (FoundRC->hasSubClass(&RC))
1954       continue;
1955
1956     // Multiple classes, and neither is a superclass of the other.
1957     // Return null.
1958     return nullptr;
1959   }
1960   return FoundRC;
1961 }
1962
1963 BitVector CodeGenRegBank::computeCoveredRegisters(ArrayRef<Record*> Regs) {
1964   SetVector<const CodeGenRegister*> Set;
1965
1966   // First add Regs with all sub-registers.
1967   for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
1968     CodeGenRegister *Reg = getReg(Regs[i]);
1969     if (Set.insert(Reg))
1970       // Reg is new, add all sub-registers.
1971       // The pre-ordering is not important here.
1972       Reg->addSubRegsPreOrder(Set, *this);
1973   }
1974
1975   // Second, find all super-registers that are completely covered by the set.
1976   for (unsigned i = 0; i != Set.size(); ++i) {
1977     const CodeGenRegister::SuperRegList &SR = Set[i]->getSuperRegs();
1978     for (unsigned j = 0, e = SR.size(); j != e; ++j) {
1979       const CodeGenRegister *Super = SR[j];
1980       if (!Super->CoveredBySubRegs || Set.count(Super))
1981         continue;
1982       // This new super-register is covered by its sub-registers.
1983       bool AllSubsInSet = true;
1984       const CodeGenRegister::SubRegMap &SRM = Super->getSubRegs();
1985       for (CodeGenRegister::SubRegMap::const_iterator I = SRM.begin(),
1986              E = SRM.end(); I != E; ++I)
1987         if (!Set.count(I->second)) {
1988           AllSubsInSet = false;
1989           break;
1990         }
1991       // All sub-registers in Set, add Super as well.
1992       // We will visit Super later to recheck its super-registers.
1993       if (AllSubsInSet)
1994         Set.insert(Super);
1995     }
1996   }
1997
1998   // Convert to BitVector.
1999   BitVector BV(Registers.size() + 1);
2000   for (unsigned i = 0, e = Set.size(); i != e; ++i)
2001     BV.set(Set[i]->EnumValue);
2002   return BV;
2003 }