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 "Error.h"
  18 #include "llvm/ADT/SmallVector.h"
  19 #include "llvm/ADT/STLExtras.h"
  20 #include "llvm/ADT/StringExtras.h"
  21
  22 using namespace llvm;
  23
  24 //===----------------------------------------------------------------------===//
  25 //                              CodeGenRegister
  26 //===----------------------------------------------------------------------===//
  27
  28 CodeGenRegister::CodeGenRegister(Record *R, unsigned Enum)
  29   : TheDef(R),
  30     EnumValue(Enum),
  31     CostPerUse(R->getValueAsInt("CostPerUse")),
  32     SubRegsComplete(false)
  33 {}
  34
  35 const std::string &CodeGenRegister::getName() const {
  36   return TheDef->getName();
  37 }
  38
  39 namespace {
  40   struct Orphan {
  41     CodeGenRegister *SubReg;
  42     Record *First, *Second;
  43     Orphan(CodeGenRegister *r, Record *a, Record *b)
  44       : SubReg(r), First(a), Second(b) {}
  45   };
  46 }
  47
  48 const CodeGenRegister::SubRegMap &
  49 CodeGenRegister::getSubRegs(CodeGenRegBank &RegBank) {
  50   // Only compute this map once.
  51   if (SubRegsComplete)
  52     return SubRegs;
  53   SubRegsComplete = true;
  54
  55   std::vector<Record*> SubList = TheDef->getValueAsListOfDefs("SubRegs");
  56   std::vector<Record*> Indices = TheDef->getValueAsListOfDefs("SubRegIndices");
  57   if (SubList.size() != Indices.size())
  58     throw TGError(TheDef->getLoc(), "Register " + getName() +
  59                   " SubRegIndices doesn't match SubRegs");
  60
  61   // First insert the direct subregs and make sure they are fully indexed.
  62   for (unsigned i = 0, e = SubList.size(); i != e; ++i) {
  63     CodeGenRegister *SR = RegBank.getReg(SubList[i]);
  64     if (!SubRegs.insert(std::make_pair(Indices[i], SR)).second)
  65       throw TGError(TheDef->getLoc(), "SubRegIndex " + Indices[i]->getName() +
  66                     " appears twice in Register " + getName());
  67   }
  68
  69   // Keep track of inherited subregs and how they can be reached.
  70   SmallVector<Orphan, 8> Orphans;
  71
  72   // Clone inherited subregs and place duplicate entries on Orphans.
  73   // Here the order is important - earlier subregs take precedence.
  74   for (unsigned i = 0, e = SubList.size(); i != e; ++i) {
  75     CodeGenRegister *SR = RegBank.getReg(SubList[i]);
  76     const SubRegMap &Map = SR->getSubRegs(RegBank);
  77
  78     // Add this as a super-register of SR now all sub-registers are in the list.
  79     // This creates a topological ordering, the exact order depends on the
  80     // order getSubRegs is called on all registers.
  81     SR->SuperRegs.push_back(this);
  82
  83     for (SubRegMap::const_iterator SI = Map.begin(), SE = Map.end(); SI != SE;
  84          ++SI) {
  85       if (!SubRegs.insert(*SI).second)
  86         Orphans.push_back(Orphan(SI->second, Indices[i], SI->first));
  87
  88       // Noop sub-register indexes are possible, so avoid duplicates.
  89       if (SI->second != SR)
  90         SI->second->SuperRegs.push_back(this);
  91     }
  92   }
  93
  94   // Process the composites.
  95   ListInit *Comps = TheDef->getValueAsListInit("CompositeIndices");
  96   for (unsigned i = 0, e = Comps->size(); i != e; ++i) {
  97     DagInit *Pat = dynamic_cast<DagInit*>(Comps->getElement(i));
  98     if (!Pat)
  99       throw TGError(TheDef->getLoc(), "Invalid dag '" +
 100                     Comps->getElement(i)->getAsString() +
 101                     "' in CompositeIndices");
 102     DefInit *BaseIdxInit = dynamic_cast<DefInit*>(Pat->getOperator());
 103     if (!BaseIdxInit || !BaseIdxInit->getDef()->isSubClassOf("SubRegIndex"))
 104       throw TGError(TheDef->getLoc(), "Invalid SubClassIndex in " +
 105                     Pat->getAsString());
 106
 107     // Resolve list of subreg indices into R2.
 108     CodeGenRegister *R2 = this;
 109     for (DagInit::const_arg_iterator di = Pat->arg_begin(),
 110          de = Pat->arg_end(); di != de; ++di) {
 111       DefInit *IdxInit = dynamic_cast<DefInit*>(*di);
 112       if (!IdxInit || !IdxInit->getDef()->isSubClassOf("SubRegIndex"))
 113         throw TGError(TheDef->getLoc(), "Invalid SubClassIndex in " +
 114                       Pat->getAsString());
 115       const SubRegMap &R2Subs = R2->getSubRegs(RegBank);
 116       SubRegMap::const_iterator ni = R2Subs.find(IdxInit->getDef());
 117       if (ni == R2Subs.end())
 118         throw TGError(TheDef->getLoc(), "Composite " + Pat->getAsString() +
 119                       " refers to bad index in " + R2->getName());
 120       R2 = ni->second;
 121     }
 122
 123     // Insert composite index. Allow overriding inherited indices etc.
 124     SubRegs[BaseIdxInit->getDef()] = R2;
 125
 126     // R2 is no longer an orphan.
 127     for (unsigned j = 0, je = Orphans.size(); j != je; ++j)
 128       if (Orphans[j].SubReg == R2)
 129           Orphans[j].SubReg = 0;
 130   }
 131
 132   // Now Orphans contains the inherited subregisters without a direct index.
 133   // Create inferred indexes for all missing entries.
 134   for (unsigned i = 0, e = Orphans.size(); i != e; ++i) {
 135     Orphan &O = Orphans[i];
 136     if (!O.SubReg)
 137       continue;
 138     SubRegs[RegBank.getCompositeSubRegIndex(O.First, O.Second, true)] =
 139       O.SubReg;
 140   }
 141   return SubRegs;
 142 }
 143
 144 void
 145 CodeGenRegister::addSubRegsPreOrder(SetVector<CodeGenRegister*> &OSet) const {
 146   assert(SubRegsComplete && "Must precompute sub-registers");
 147   std::vector<Record*> Indices = TheDef->getValueAsListOfDefs("SubRegIndices");
 148   for (unsigned i = 0, e = Indices.size(); i != e; ++i) {
 149     CodeGenRegister *SR = SubRegs.find(Indices[i])->second;
 150     if (OSet.insert(SR))
 151       SR->addSubRegsPreOrder(OSet);
 152   }
 153 }
 154
 155 //===----------------------------------------------------------------------===//
 156 //                               RegisterTuples
 157 //===----------------------------------------------------------------------===//
 158
 159 // A RegisterTuples def is used to generate pseudo-registers from lists of
 160 // sub-registers. We provide a SetTheory expander class that returns the new
 161 // registers.
 162 namespace {
 163 struct TupleExpander : SetTheory::Expander {
 164   void expand(SetTheory &ST, Record *Def, SetTheory::RecSet &Elts) {
 165     std::vector<Record*> Indices = Def->getValueAsListOfDefs("SubRegIndices");
 166     unsigned Dim = Indices.size();
 167     ListInit *SubRegs = Def->getValueAsListInit("SubRegs");
 168     if (Dim != SubRegs->getSize())
 169       throw TGError(Def->getLoc(), "SubRegIndices and SubRegs size mismatch");
 170     if (Dim < 2)
 171       throw TGError(Def->getLoc(), "Tuples must have at least 2 sub-registers");
 172
 173     // Evaluate the sub-register lists to be zipped.
 174     unsigned Length = ~0u;
 175     SmallVector<SetTheory::RecSet, 4> Lists(Dim);
 176     for (unsigned i = 0; i != Dim; ++i) {
 177       ST.evaluate(SubRegs->getElement(i), Lists[i]);
 178       Length = std::min(Length, unsigned(Lists[i].size()));
 179     }
 180
 181     if (Length == 0)
 182       return;
 183
 184     // Precompute some types.
 185     Record *RegisterCl = Def->getRecords().getClass("Register");
 186     RecTy *RegisterRecTy = RecordRecTy::get(RegisterCl);
 187     StringInit *BlankName = StringInit::get("");
 188
 189     // Zip them up.
 190     for (unsigned n = 0; n != Length; ++n) {
 191       std::string Name;
 192       Record *Proto = Lists[0][n];
 193       std::vector<Init*> Tuple;
 194       unsigned CostPerUse = 0;
 195       for (unsigned i = 0; i != Dim; ++i) {
 196         Record *Reg = Lists[i][n];
 197         if (i) Name += '_';
 198         Name += Reg->getName();
 199         Tuple.push_back(DefInit::get(Reg));
 200         CostPerUse = std::max(CostPerUse,
 201                               unsigned(Reg->getValueAsInt("CostPerUse")));
 202       }
 203
 204       // Create a new Record representing the synthesized register. This record
 205       // is only for consumption by CodeGenRegister, it is not added to the
 206       // RecordKeeper.
 207       Record *NewReg = new Record(Name, Def->getLoc(), Def->getRecords());
 208       Elts.insert(NewReg);
 209
 210       // Copy Proto super-classes.
 211       for (unsigned i = 0, e = Proto->getSuperClasses().size(); i != e; ++i)
 212         NewReg->addSuperClass(Proto->getSuperClasses()[i]);
 213
 214       // Copy Proto fields.
 215       for (unsigned i = 0, e = Proto->getValues().size(); i != e; ++i) {
 216         RecordVal RV = Proto->getValues()[i];
 217
 218         // Replace the sub-register list with Tuple.
 219         if (RV.getName() == "SubRegs")
 220           RV.setValue(ListInit::get(Tuple, RegisterRecTy));
 221
 222         // Provide a blank AsmName. MC hacks are required anyway.
 223         if (RV.getName() == "AsmName")
 224           RV.setValue(BlankName);
 225
 226         // CostPerUse is aggregated from all Tuple members.
 227         if (RV.getName() == "CostPerUse")
 228           RV.setValue(IntInit::get(CostPerUse));
 229
 230         // Copy fields from the RegisterTuples def.
 231         if (RV.getName() == "SubRegIndices" ||
 232             RV.getName() == "CompositeIndices") {
 233           NewReg->addValue(*Def->getValue(RV.getName()));
 234           continue;
 235         }
 236
 237         // Some fields get their default uninitialized value.
 238         if (RV.getName() == "DwarfNumbers" ||
 239             RV.getName() == "DwarfAlias" ||
 240             RV.getName() == "Aliases") {
 241           if (const RecordVal *DefRV = RegisterCl->getValue(RV.getName()))
 242             NewReg->addValue(*DefRV);
 243           continue;
 244         }
 245
 246         // Everything else is copied from Proto.
 247         NewReg->addValue(RV);
 248       }
 249     }
 250   }
 251 };
 252 }
 253
 254 //===----------------------------------------------------------------------===//
 255 //                            CodeGenRegisterClass
 256 //===----------------------------------------------------------------------===//
 257
 258 CodeGenRegisterClass::CodeGenRegisterClass(CodeGenRegBank &RegBank, Record *R)
 259   : TheDef(R), EnumValue(-1) {
 260   // Rename anonymous register classes.
 261   if (R->getName().size() > 9 && R->getName()[9] == '.') {
 262     static unsigned AnonCounter = 0;
 263     R->setName("AnonRegClass_"+utostr(AnonCounter++));
 264   }
 265
 266   std::vector<Record*> TypeList = R->getValueAsListOfDefs("RegTypes");
 267   for (unsigned i = 0, e = TypeList.size(); i != e; ++i) {
 268     Record *Type = TypeList[i];
 269     if (!Type->isSubClassOf("ValueType"))
 270       throw "RegTypes list member '" + Type->getName() +
 271         "' does not derive from the ValueType class!";
 272     VTs.push_back(getValueType(Type));
 273   }
 274   assert(!VTs.empty() && "RegisterClass must contain at least one ValueType!");
 275
 276   // Default allocation order always contains all registers.
 277   Elements = RegBank.getSets().expand(R);
 278   for (unsigned i = 0, e = Elements->size(); i != e; ++i)
 279     Members.insert(RegBank.getReg((*Elements)[i]));
 280
 281   // Alternative allocation orders may be subsets.
 282   ListInit *Alts = R->getValueAsListInit("AltOrders");
 283   AltOrders.resize(Alts->size());
 284   SetTheory::RecSet Order;
 285   for (unsigned i = 0, e = Alts->size(); i != e; ++i) {
 286     RegBank.getSets().evaluate(Alts->getElement(i), Order);
 287     AltOrders[i].append(Order.begin(), Order.end());
 288     // Verify that all altorder members are regclass members.
 289     while (!Order.empty()) {
 290       CodeGenRegister *Reg = RegBank.getReg(Order.back());
 291       Order.pop_back();
 292       if (!contains(Reg))
 293         throw TGError(R->getLoc(), " AltOrder register " + Reg->getName() +
 294                       " is not a class member");
 295     }
 296   }
 297
 298   // SubRegClasses is a list<dag> containing (RC, subregindex, ...) dags.
 299   ListInit *SRC = R->getValueAsListInit("SubRegClasses");
 300   for (ListInit::const_iterator i = SRC->begin(), e = SRC->end(); i != e; ++i) {
 301     DagInit *DAG = dynamic_cast<DagInit*>(*i);
 302     if (!DAG) throw "SubRegClasses must contain DAGs";
 303     DefInit *DAGOp = dynamic_cast<DefInit*>(DAG->getOperator());
 304     Record *RCRec;
 305     if (!DAGOp || !(RCRec = DAGOp->getDef())->isSubClassOf("RegisterClass"))
 306       throw "Operator '" + DAG->getOperator()->getAsString() +
 307         "' in SubRegClasses is not a RegisterClass";
 308     // Iterate over args, all SubRegIndex instances.
 309     for (DagInit::const_arg_iterator ai = DAG->arg_begin(), ae = DAG->arg_end();
 310          ai != ae; ++ai) {
 311       DefInit *Idx = dynamic_cast<DefInit*>(*ai);
 312       Record *IdxRec;
 313       if (!Idx || !(IdxRec = Idx->getDef())->isSubClassOf("SubRegIndex"))
 314         throw "Argument '" + (*ai)->getAsString() +
 315           "' in SubRegClasses is not a SubRegIndex";
 316       if (!SubRegClasses.insert(std::make_pair(IdxRec, RCRec)).second)
 317         throw "SubRegIndex '" + IdxRec->getName() + "' mentioned twice";
 318     }
 319   }
 320
 321   // Allow targets to override the size in bits of the RegisterClass.
 322   unsigned Size = R->getValueAsInt("Size");
 323
 324   Namespace = R->getValueAsString("Namespace");
 325   SpillSize = Size ? Size : EVT(VTs[0]).getSizeInBits();
 326   SpillAlignment = R->getValueAsInt("Alignment");
 327   CopyCost = R->getValueAsInt("CopyCost");
 328   Allocatable = R->getValueAsBit("isAllocatable");
 329   AltOrderSelect = R->getValueAsCode("AltOrderSelect");
 330 }
 331
 332 bool CodeGenRegisterClass::contains(const CodeGenRegister *Reg) const {
 333   return Members.count(Reg);
 334 }
 335
 336 // Returns true if RC is a strict subclass.
 337 // RC is a sub-class of this class if it is a valid replacement for any
 338 // instruction operand where a register of this classis required. It must
 339 // satisfy these conditions:
 340 //
 341 // 1. All RC registers are also in this.
 342 // 2. The RC spill size must not be smaller than our spill size.
 343 // 3. RC spill alignment must be compatible with ours.
 344 //
 345 bool CodeGenRegisterClass::hasSubClass(const CodeGenRegisterClass *RC) const {
 346   return SpillAlignment && RC->SpillAlignment % SpillAlignment == 0 &&
 347     SpillSize <= RC->SpillSize &&
 348     std::includes(Members.begin(), Members.end(),
 349                   RC->Members.begin(), RC->Members.end(),
 350                   CodeGenRegister::Less());
 351 }
 352
 353 /// Sorting predicate for register classes.  This provides a topological
 354 /// ordering that arranges all register classes before their sub-classes.
 355 ///
 356 /// Register classes with the same registers, spill size, and alignment form a
 357 /// clique.  They will be ordered alphabetically.
 358 ///
 359 static int TopoOrderRC(const void *PA, const void *PB) {
 360   const CodeGenRegisterClass *A = *(const CodeGenRegisterClass* const*)PA;
 361   const CodeGenRegisterClass *B = *(const CodeGenRegisterClass* const*)PB;
 362   if (A == B)
 363     return 0;
 364
 365   // Order by descending set size.
 366   if (A->getOrder().size() > B->getOrder().size())
 367     return -1;
 368   if (A->getOrder().size() < B->getOrder().size())
 369     return 1;
 370
 371   // Order by ascending spill size.
 372   if (A->SpillSize < B->SpillSize)
 373     return -1;
 374   if (A->SpillSize > B->SpillSize)
 375     return 1;
 376
 377   // Order by ascending spill alignment.
 378   if (A->SpillAlignment < B->SpillAlignment)
 379     return -1;
 380   if (A->SpillAlignment > B->SpillAlignment)
 381     return 1;
 382
 383   // Finally order by name as a tie breaker.
 384   return A->getName() < B->getName();
 385 }
 386
 387 const std::string &CodeGenRegisterClass::getName() const {
 388   return TheDef->getName();
 389 }
 390
 391 //===----------------------------------------------------------------------===//
 392 //                               CodeGenRegBank
 393 //===----------------------------------------------------------------------===//
 394
 395 CodeGenRegBank::CodeGenRegBank(RecordKeeper &Records) : Records(Records) {
 396   // Configure register Sets to understand register classes and tuples.
 397   Sets.addFieldExpander("RegisterClass", "MemberList");
 398   Sets.addExpander("RegisterTuples", new TupleExpander());
 399
 400   // Read in the user-defined (named) sub-register indices.
 401   // More indices will be synthesized later.
 402   SubRegIndices = Records.getAllDerivedDefinitions("SubRegIndex");
 403   std::sort(SubRegIndices.begin(), SubRegIndices.end(), LessRecord());
 404   NumNamedIndices = SubRegIndices.size();
 405
 406   // Read in the register definitions.
 407   std::vector<Record*> Regs = Records.getAllDerivedDefinitions("Register");
 408   std::sort(Regs.begin(), Regs.end(), LessRecord());
 409   Registers.reserve(Regs.size());
 410   // Assign the enumeration values.
 411   for (unsigned i = 0, e = Regs.size(); i != e; ++i)
 412     getReg(Regs[i]);
 413
 414   // Expand tuples and number the new registers.
 415   std::vector<Record*> Tups =
 416     Records.getAllDerivedDefinitions("RegisterTuples");
 417   for (unsigned i = 0, e = Tups.size(); i != e; ++i) {
 418     const std::vector<Record*> *TupRegs = Sets.expand(Tups[i]);
 419     for (unsigned j = 0, je = TupRegs->size(); j != je; ++j)
 420       getReg((*TupRegs)[j]);
 421   }
 422
 423   // Read in register class definitions.
 424   std::vector<Record*> RCs = Records.getAllDerivedDefinitions("RegisterClass");
 425   if (RCs.empty())
 426     throw std::string("No 'RegisterClass' subclasses defined!");
 427
 428   RegClasses.reserve(RCs.size());
 429   for (unsigned i = 0, e = RCs.size(); i != e; ++i) {
 430     CodeGenRegisterClass *RC = new CodeGenRegisterClass(*this, RCs[i]);
 431     RegClasses.push_back(RC);
 432     Def2RC[RCs[i]] = RC;
 433   }
 434   // Order register classes topologically and assign enum values.
 435   array_pod_sort(RegClasses.begin(), RegClasses.end(), TopoOrderRC);
 436   for (unsigned i = 0, e = RegClasses.size(); i != e; ++i)
 437     RegClasses[i]->EnumValue = i;
 438 }
 439
 440 CodeGenRegister *CodeGenRegBank::getReg(Record *Def) {
 441   CodeGenRegister *&Reg = Def2Reg[Def];
 442   if (Reg)
 443     return Reg;
 444   Reg = new CodeGenRegister(Def, Registers.size() + 1);
 445   Registers.push_back(Reg);
 446   return Reg;
 447 }
 448
 449 CodeGenRegisterClass *CodeGenRegBank::getRegClass(Record *Def) {
 450   if (CodeGenRegisterClass *RC = Def2RC[Def])
 451     return RC;
 452
 453   throw TGError(Def->getLoc(), "Not a known RegisterClass!");
 454 }
 455
 456 Record *CodeGenRegBank::getCompositeSubRegIndex(Record *A, Record *B,
 457                                                 bool create) {
 458   // Look for an existing entry.
 459   Record *&Comp = Composite[std::make_pair(A, B)];
 460   if (Comp || !create)
 461     return Comp;
 462
 463   // None exists, synthesize one.
 464   std::string Name = A->getName() + "_then_" + B->getName();
 465   Comp = new Record(Name, SMLoc(), Records);
 466   Records.addDef(Comp);
 467   SubRegIndices.push_back(Comp);
 468   return Comp;
 469 }
 470
 471 unsigned CodeGenRegBank::getSubRegIndexNo(Record *idx) {
 472   std::vector<Record*>::const_iterator i =
 473     std::find(SubRegIndices.begin(), SubRegIndices.end(), idx);
 474   assert(i != SubRegIndices.end() && "Not a SubRegIndex");
 475   return (i - SubRegIndices.begin()) + 1;
 476 }
 477
 478 void CodeGenRegBank::computeComposites() {
 479   // Precompute all sub-register maps. This will create Composite entries for
 480   // all inferred sub-register indices.
 481   for (unsigned i = 0, e = Registers.size(); i != e; ++i)
 482     Registers[i]->getSubRegs(*this);
 483
 484   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
 485     CodeGenRegister *Reg1 = Registers[i];
 486     const CodeGenRegister::SubRegMap &SRM1 = Reg1->getSubRegs();
 487     for (CodeGenRegister::SubRegMap::const_iterator i1 = SRM1.begin(),
 488          e1 = SRM1.end(); i1 != e1; ++i1) {
 489       Record *Idx1 = i1->first;
 490       CodeGenRegister *Reg2 = i1->second;
 491       // Ignore identity compositions.
 492       if (Reg1 == Reg2)
 493         continue;
 494       const CodeGenRegister::SubRegMap &SRM2 = Reg2->getSubRegs();
 495       // Try composing Idx1 with another SubRegIndex.
 496       for (CodeGenRegister::SubRegMap::const_iterator i2 = SRM2.begin(),
 497            e2 = SRM2.end(); i2 != e2; ++i2) {
 498         std::pair<Record*, Record*> IdxPair(Idx1, i2->first);
 499         CodeGenRegister *Reg3 = i2->second;
 500         // Ignore identity compositions.
 501         if (Reg2 == Reg3)
 502           continue;
 503         // OK Reg1:IdxPair == Reg3. Find the index with Reg:Idx == Reg3.
 504         for (CodeGenRegister::SubRegMap::const_iterator i1d = SRM1.begin(),
 505              e1d = SRM1.end(); i1d != e1d; ++i1d) {
 506           if (i1d->second == Reg3) {
 507             std::pair<CompositeMap::iterator, bool> Ins =
 508               Composite.insert(std::make_pair(IdxPair, i1d->first));
 509             // Conflicting composition? Emit a warning but allow it.
 510             if (!Ins.second && Ins.first->second != i1d->first) {
 511               errs() << "Warning: SubRegIndex " << getQualifiedName(Idx1)
 512                      << " and " << getQualifiedName(IdxPair.second)
 513                      << " compose ambiguously as "
 514                      << getQualifiedName(Ins.first->second) << " or "
 515                      << getQualifiedName(i1d->first) << "\n";
 516             }
 517           }
 518         }
 519       }
 520     }
 521   }
 522
 523   // We don't care about the difference between (Idx1, Idx2) -> Idx2 and invalid
 524   // compositions, so remove any mappings of that form.
 525   for (CompositeMap::iterator i = Composite.begin(), e = Composite.end();
 526        i != e;) {
 527     CompositeMap::iterator j = i;
 528     ++i;
 529     if (j->first.second == j->second)
 530       Composite.erase(j);
 531   }
 532 }
 533
 534 // Compute sets of overlapping registers.
 535 //
 536 // The standard set is all super-registers and all sub-registers, but the
 537 // target description can add arbitrary overlapping registers via the 'Aliases'
 538 // field. This complicates things, but we can compute overlapping sets using
 539 // the following rules:
 540 //
 541 // 1. The relation overlap(A, B) is reflexive and symmetric but not transitive.
 542 //
 543 // 2. overlap(A, B) implies overlap(A, S) for all S in supers(B).
 544 //
 545 // Alternatively:
 546 //
 547 //    overlap(A, B) iff there exists:
 548 //    A' in { A, subregs(A) } and B' in { B, subregs(B) } such that:
 549 //    A' = B' or A' in aliases(B') or B' in aliases(A').
 550 //
 551 // Here subregs(A) is the full flattened sub-register set returned by
 552 // A.getSubRegs() while aliases(A) is simply the special 'Aliases' field in the
 553 // description of register A.
 554 //
 555 // This also implies that registers with a common sub-register are considered
 556 // overlapping. This can happen when forming register pairs:
 557 //
 558 //    P0 = (R0, R1)
 559 //    P1 = (R1, R2)
 560 //    P2 = (R2, R3)
 561 //
 562 // In this case, we will infer an overlap between P0 and P1 because of the
 563 // shared sub-register R1. There is no overlap between P0 and P2.
 564 //
 565 void CodeGenRegBank::
 566 computeOverlaps(std::map<const CodeGenRegister*, CodeGenRegister::Set> &Map) {
 567   assert(Map.empty());
 568
 569   // Collect overlaps that don't follow from rule 2.
 570   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
 571     CodeGenRegister *Reg = Registers[i];
 572     CodeGenRegister::Set &Overlaps = Map[Reg];
 573
 574     // Reg overlaps itself.
 575     Overlaps.insert(Reg);
 576
 577     // All super-registers overlap.
 578     const CodeGenRegister::SuperRegList &Supers = Reg->getSuperRegs();
 579     Overlaps.insert(Supers.begin(), Supers.end());
 580
 581     // Form symmetrical relations from the special Aliases[] lists.
 582     std::vector<Record*> RegList = Reg->TheDef->getValueAsListOfDefs("Aliases");
 583     for (unsigned i2 = 0, e2 = RegList.size(); i2 != e2; ++i2) {
 584       CodeGenRegister *Reg2 = getReg(RegList[i2]);
 585       CodeGenRegister::Set &Overlaps2 = Map[Reg2];
 586       const CodeGenRegister::SuperRegList &Supers2 = Reg2->getSuperRegs();
 587       // Reg overlaps Reg2 which implies it overlaps supers(Reg2).
 588       Overlaps.insert(Reg2);
 589       Overlaps.insert(Supers2.begin(), Supers2.end());
 590       Overlaps2.insert(Reg);
 591       Overlaps2.insert(Supers.begin(), Supers.end());
 592     }
 593   }
 594
 595   // Apply rule 2. and inherit all sub-register overlaps.
 596   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
 597     CodeGenRegister *Reg = Registers[i];
 598     CodeGenRegister::Set &Overlaps = Map[Reg];
 599     const CodeGenRegister::SubRegMap &SRM = Reg->getSubRegs();
 600     for (CodeGenRegister::SubRegMap::const_iterator i2 = SRM.begin(),
 601          e2 = SRM.end(); i2 != e2; ++i2) {
 602       CodeGenRegister::Set &Overlaps2 = Map[i2->second];
 603       Overlaps.insert(Overlaps2.begin(), Overlaps2.end());
 604     }
 605   }
 606 }
 607
 608 void CodeGenRegBank::computeDerivedInfo() {
 609   computeComposites();
 610 }
 611
 612 /// getRegisterClassForRegister - Find the register class that contains the
 613 /// specified physical register.  If the register is not in a register class,
 614 /// return null. If the register is in multiple classes, and the classes have a
 615 /// superset-subset relationship and the same set of types, return the
 616 /// superclass.  Otherwise return null.
 617 const CodeGenRegisterClass*
 618 CodeGenRegBank::getRegClassForRegister(Record *R) {
 619   const CodeGenRegister *Reg = getReg(R);
 620   ArrayRef<CodeGenRegisterClass*> RCs = getRegClasses();
 621   const CodeGenRegisterClass *FoundRC = 0;
 622   for (unsigned i = 0, e = RCs.size(); i != e; ++i) {
 623     const CodeGenRegisterClass &RC = *RCs[i];
 624     if (!RC.contains(Reg))
 625       continue;
 626
 627     // If this is the first class that contains the register,
 628     // make a note of it and go on to the next class.
 629     if (!FoundRC) {
 630       FoundRC = &RC;
 631       continue;
 632     }
 633
 634     // If a register's classes have different types, return null.
 635     if (RC.getValueTypes() != FoundRC->getValueTypes())
 636       return 0;
 637
 638     // Check to see if the previously found class that contains
 639     // the register is a subclass of the current class. If so,
 640     // prefer the superclass.
 641     if (RC.hasSubClass(FoundRC)) {
 642       FoundRC = &RC;
 643       continue;
 644     }
 645
 646     // Check to see if the previously found class that contains
 647     // the register is a superclass of the current class. If so,
 648     // prefer the superclass.
 649     if (FoundRC->hasSubClass(&RC))
 650       continue;
 651
 652     // Multiple classes, and neither is a superclass of the other.
 653     // Return null.
 654     return 0;
 655   }
 656   return FoundRC;
 657 }