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/SmallVector.h"
  18 #include "llvm/ADT/StringExtras.h"
  19
  20 using namespace llvm;
  21
  22 //===----------------------------------------------------------------------===//
  23 //                              CodeGenRegister
  24 //===----------------------------------------------------------------------===//
  25
  26 CodeGenRegister::CodeGenRegister(Record *R, unsigned Enum)
  27   : TheDef(R),
  28     EnumValue(Enum),
  29     CostPerUse(R->getValueAsInt("CostPerUse")),
  30     SubRegsComplete(false)
  31 {}
  32
  33 const std::string &CodeGenRegister::getName() const {
  34   return TheDef->getName();
  35 }
  36
  37 namespace {
  38   struct Orphan {
  39     CodeGenRegister *SubReg;
  40     Record *First, *Second;
  41     Orphan(CodeGenRegister *r, Record *a, Record *b)
  42       : SubReg(r), First(a), Second(b) {}
  43   };
  44 }
  45
  46 const CodeGenRegister::SubRegMap &
  47 CodeGenRegister::getSubRegs(CodeGenRegBank &RegBank) {
  48   // Only compute this map once.
  49   if (SubRegsComplete)
  50     return SubRegs;
  51   SubRegsComplete = true;
  52
  53   std::vector<Record*> SubList = TheDef->getValueAsListOfDefs("SubRegs");
  54   std::vector<Record*> Indices = TheDef->getValueAsListOfDefs("SubRegIndices");
  55   if (SubList.size() != Indices.size())
  56     throw TGError(TheDef->getLoc(), "Register " + getName() +
  57                   " SubRegIndices doesn't match SubRegs");
  58
  59   // First insert the direct subregs and make sure they are fully indexed.
  60   for (unsigned i = 0, e = SubList.size(); i != e; ++i) {
  61     CodeGenRegister *SR = RegBank.getReg(SubList[i]);
  62     if (!SubRegs.insert(std::make_pair(Indices[i], SR)).second)
  63       throw TGError(TheDef->getLoc(), "SubRegIndex " + Indices[i]->getName() +
  64                     " appears twice in Register " + getName());
  65   }
  66
  67   // Keep track of inherited subregs and how they can be reached.
  68   SmallVector<Orphan, 8> Orphans;
  69
  70   // Clone inherited subregs and place duplicate entries on Orphans.
  71   // Here the order is important - earlier subregs take precedence.
  72   for (unsigned i = 0, e = SubList.size(); i != e; ++i) {
  73     CodeGenRegister *SR = RegBank.getReg(SubList[i]);
  74     const SubRegMap &Map = SR->getSubRegs(RegBank);
  75
  76     // Add this as a super-register of SR now all sub-registers are in the list.
  77     // This creates a topological ordering, the exact order depends on the
  78     // order getSubRegs is called on all registers.
  79     SR->SuperRegs.push_back(this);
  80
  81     for (SubRegMap::const_iterator SI = Map.begin(), SE = Map.end(); SI != SE;
  82          ++SI) {
  83       if (!SubRegs.insert(*SI).second)
  84         Orphans.push_back(Orphan(SI->second, Indices[i], SI->first));
  85
  86       // Noop sub-register indexes are possible, so avoid duplicates.
  87       if (SI->second != SR)
  88         SI->second->SuperRegs.push_back(this);
  89     }
  90   }
  91
  92   // Process the composites.
  93   ListInit *Comps = TheDef->getValueAsListInit("CompositeIndices");
  94   for (unsigned i = 0, e = Comps->size(); i != e; ++i) {
  95     DagInit *Pat = dynamic_cast<DagInit*>(Comps->getElement(i));
  96     if (!Pat)
  97       throw TGError(TheDef->getLoc(), "Invalid dag '" +
  98                     Comps->getElement(i)->getAsString() +
  99                     "' in CompositeIndices");
 100     DefInit *BaseIdxInit = dynamic_cast<DefInit*>(Pat->getOperator());
 101     if (!BaseIdxInit || !BaseIdxInit->getDef()->isSubClassOf("SubRegIndex"))
 102       throw TGError(TheDef->getLoc(), "Invalid SubClassIndex in " +
 103                     Pat->getAsString());
 104
 105     // Resolve list of subreg indices into R2.
 106     CodeGenRegister *R2 = this;
 107     for (DagInit::const_arg_iterator di = Pat->arg_begin(),
 108          de = Pat->arg_end(); di != de; ++di) {
 109       DefInit *IdxInit = dynamic_cast<DefInit*>(*di);
 110       if (!IdxInit || !IdxInit->getDef()->isSubClassOf("SubRegIndex"))
 111         throw TGError(TheDef->getLoc(), "Invalid SubClassIndex in " +
 112                       Pat->getAsString());
 113       const SubRegMap &R2Subs = R2->getSubRegs(RegBank);
 114       SubRegMap::const_iterator ni = R2Subs.find(IdxInit->getDef());
 115       if (ni == R2Subs.end())
 116         throw TGError(TheDef->getLoc(), "Composite " + Pat->getAsString() +
 117                       " refers to bad index in " + R2->getName());
 118       R2 = ni->second;
 119     }
 120
 121     // Insert composite index. Allow overriding inherited indices etc.
 122     SubRegs[BaseIdxInit->getDef()] = R2;
 123
 124     // R2 is no longer an orphan.
 125     for (unsigned j = 0, je = Orphans.size(); j != je; ++j)
 126       if (Orphans[j].SubReg == R2)
 127           Orphans[j].SubReg = 0;
 128   }
 129
 130   // Now Orphans contains the inherited subregisters without a direct index.
 131   // Create inferred indexes for all missing entries.
 132   for (unsigned i = 0, e = Orphans.size(); i != e; ++i) {
 133     Orphan &O = Orphans[i];
 134     if (!O.SubReg)
 135       continue;
 136     SubRegs[RegBank.getCompositeSubRegIndex(O.First, O.Second, true)] =
 137       O.SubReg;
 138   }
 139   return SubRegs;
 140 }
 141
 142 void
 143 CodeGenRegister::addSubRegsPreOrder(SetVector<CodeGenRegister*> &OSet) const {
 144   assert(SubRegsComplete && "Must precompute sub-registers");
 145   std::vector<Record*> Indices = TheDef->getValueAsListOfDefs("SubRegIndices");
 146   for (unsigned i = 0, e = Indices.size(); i != e; ++i) {
 147     CodeGenRegister *SR = SubRegs.find(Indices[i])->second;
 148     if (OSet.insert(SR))
 149       SR->addSubRegsPreOrder(OSet);
 150   }
 151 }
 152
 153 //===----------------------------------------------------------------------===//
 154 //                            CodeGenRegisterClass
 155 //===----------------------------------------------------------------------===//
 156
 157 CodeGenRegisterClass::CodeGenRegisterClass(Record *R) : TheDef(R) {
 158   // Rename anonymous register classes.
 159   if (R->getName().size() > 9 && R->getName()[9] == '.') {
 160     static unsigned AnonCounter = 0;
 161     R->setName("AnonRegClass_"+utostr(AnonCounter++));
 162   }
 163
 164   std::vector<Record*> TypeList = R->getValueAsListOfDefs("RegTypes");
 165   for (unsigned i = 0, e = TypeList.size(); i != e; ++i) {
 166     Record *Type = TypeList[i];
 167     if (!Type->isSubClassOf("ValueType"))
 168       throw "RegTypes list member '" + Type->getName() +
 169         "' does not derive from the ValueType class!";
 170     VTs.push_back(getValueType(Type));
 171   }
 172   assert(!VTs.empty() && "RegisterClass must contain at least one ValueType!");
 173
 174   std::vector<Record*> RegList = R->getValueAsListOfDefs("MemberList");
 175   for (unsigned i = 0, e = RegList.size(); i != e; ++i) {
 176     Record *Reg = RegList[i];
 177     if (!Reg->isSubClassOf("Register"))
 178       throw "Register Class member '" + Reg->getName() +
 179             "' does not derive from the Register class!";
 180     Elements.push_back(Reg);
 181   }
 182
 183   // SubRegClasses is a list<dag> containing (RC, subregindex, ...) dags.
 184   ListInit *SRC = R->getValueAsListInit("SubRegClasses");
 185   for (ListInit::const_iterator i = SRC->begin(), e = SRC->end(); i != e; ++i) {
 186     DagInit *DAG = dynamic_cast<DagInit*>(*i);
 187     if (!DAG) throw "SubRegClasses must contain DAGs";
 188     DefInit *DAGOp = dynamic_cast<DefInit*>(DAG->getOperator());
 189     Record *RCRec;
 190     if (!DAGOp || !(RCRec = DAGOp->getDef())->isSubClassOf("RegisterClass"))
 191       throw "Operator '" + DAG->getOperator()->getAsString() +
 192         "' in SubRegClasses is not a RegisterClass";
 193     // Iterate over args, all SubRegIndex instances.
 194     for (DagInit::const_arg_iterator ai = DAG->arg_begin(), ae = DAG->arg_end();
 195          ai != ae; ++ai) {
 196       DefInit *Idx = dynamic_cast<DefInit*>(*ai);
 197       Record *IdxRec;
 198       if (!Idx || !(IdxRec = Idx->getDef())->isSubClassOf("SubRegIndex"))
 199         throw "Argument '" + (*ai)->getAsString() +
 200           "' in SubRegClasses is not a SubRegIndex";
 201       if (!SubRegClasses.insert(std::make_pair(IdxRec, RCRec)).second)
 202         throw "SubRegIndex '" + IdxRec->getName() + "' mentioned twice";
 203     }
 204   }
 205
 206   // Allow targets to override the size in bits of the RegisterClass.
 207   unsigned Size = R->getValueAsInt("Size");
 208
 209   Namespace = R->getValueAsString("Namespace");
 210   SpillSize = Size ? Size : EVT(VTs[0]).getSizeInBits();
 211   SpillAlignment = R->getValueAsInt("Alignment");
 212   CopyCost = R->getValueAsInt("CopyCost");
 213   Allocatable = R->getValueAsBit("isAllocatable");
 214   MethodBodies = R->getValueAsCode("MethodBodies");
 215   MethodProtos = R->getValueAsCode("MethodProtos");
 216 }
 217
 218 const std::string &CodeGenRegisterClass::getName() const {
 219   return TheDef->getName();
 220 }
 221
 222 //===----------------------------------------------------------------------===//
 223 //                               CodeGenRegBank
 224 //===----------------------------------------------------------------------===//
 225
 226 CodeGenRegBank::CodeGenRegBank(RecordKeeper &Records) : Records(Records) {
 227   // Read in the user-defined (named) sub-register indices.
 228   // More indices will be synthesized later.
 229   SubRegIndices = Records.getAllDerivedDefinitions("SubRegIndex");
 230   std::sort(SubRegIndices.begin(), SubRegIndices.end(), LessRecord());
 231   NumNamedIndices = SubRegIndices.size();
 232
 233   // Read in the register definitions.
 234   std::vector<Record*> Regs = Records.getAllDerivedDefinitions("Register");
 235   std::sort(Regs.begin(), Regs.end(), LessRecord());
 236   Registers.reserve(Regs.size());
 237   // Assign the enumeration values.
 238   for (unsigned i = 0, e = Regs.size(); i != e; ++i)
 239     Registers.push_back(CodeGenRegister(Regs[i], i + 1));
 240
 241   // Read in register class definitions.
 242   std::vector<Record*> RCs = Records.getAllDerivedDefinitions("RegisterClass");
 243   if (RCs.empty())
 244     throw std::string("No 'RegisterClass' subclasses defined!");
 245
 246   RegClasses.reserve(RCs.size());
 247   RegClasses.assign(RCs.begin(), RCs.end());
 248 }
 249
 250 CodeGenRegister *CodeGenRegBank::getReg(Record *Def) {
 251   if (Def2Reg.empty())
 252     for (unsigned i = 0, e = Registers.size(); i != e; ++i)
 253       Def2Reg[Registers[i].TheDef] = &Registers[i];
 254
 255   if (CodeGenRegister *Reg = Def2Reg[Def])
 256     return Reg;
 257
 258   throw TGError(Def->getLoc(), "Not a known Register!");
 259 }
 260
 261 CodeGenRegisterClass *CodeGenRegBank::getRegClass(Record *Def) {
 262   if (Def2RC.empty())
 263     for (unsigned i = 0, e = RegClasses.size(); i != e; ++i)
 264       Def2RC[RegClasses[i].TheDef] = &RegClasses[i];
 265
 266   if (CodeGenRegisterClass *RC = Def2RC[Def])
 267     return RC;
 268
 269   throw TGError(Def->getLoc(), "Not a known RegisterClass!");
 270 }
 271
 272 Record *CodeGenRegBank::getCompositeSubRegIndex(Record *A, Record *B,
 273                                                 bool create) {
 274   // Look for an existing entry.
 275   Record *&Comp = Composite[std::make_pair(A, B)];
 276   if (Comp || !create)
 277     return Comp;
 278
 279   // None exists, synthesize one.
 280   std::string Name = A->getName() + "_then_" + B->getName();
 281   Comp = new Record(Name, SMLoc(), Records);
 282   Records.addDef(Comp);
 283   SubRegIndices.push_back(Comp);
 284   return Comp;
 285 }
 286
 287 unsigned CodeGenRegBank::getSubRegIndexNo(Record *idx) {
 288   std::vector<Record*>::const_iterator i =
 289     std::find(SubRegIndices.begin(), SubRegIndices.end(), idx);
 290   assert(i != SubRegIndices.end() && "Not a SubRegIndex");
 291   return (i - SubRegIndices.begin()) + 1;
 292 }
 293
 294 void CodeGenRegBank::computeComposites() {
 295   // Precompute all sub-register maps. This will create Composite entries for
 296   // all inferred sub-register indices.
 297   for (unsigned i = 0, e = Registers.size(); i != e; ++i)
 298     Registers[i].getSubRegs(*this);
 299
 300   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
 301     CodeGenRegister *Reg1 = &Registers[i];
 302     const CodeGenRegister::SubRegMap &SRM1 = Reg1->getSubRegs();
 303     for (CodeGenRegister::SubRegMap::const_iterator i1 = SRM1.begin(),
 304          e1 = SRM1.end(); i1 != e1; ++i1) {
 305       Record *Idx1 = i1->first;
 306       CodeGenRegister *Reg2 = i1->second;
 307       // Ignore identity compositions.
 308       if (Reg1 == Reg2)
 309         continue;
 310       const CodeGenRegister::SubRegMap &SRM2 = Reg2->getSubRegs();
 311       // Try composing Idx1 with another SubRegIndex.
 312       for (CodeGenRegister::SubRegMap::const_iterator i2 = SRM2.begin(),
 313            e2 = SRM2.end(); i2 != e2; ++i2) {
 314         std::pair<Record*, Record*> IdxPair(Idx1, i2->first);
 315         CodeGenRegister *Reg3 = i2->second;
 316         // Ignore identity compositions.
 317         if (Reg2 == Reg3)
 318           continue;
 319         // OK Reg1:IdxPair == Reg3. Find the index with Reg:Idx == Reg3.
 320         for (CodeGenRegister::SubRegMap::const_iterator i1d = SRM1.begin(),
 321              e1d = SRM1.end(); i1d != e1d; ++i1d) {
 322           if (i1d->second == Reg3) {
 323             std::pair<CompositeMap::iterator, bool> Ins =
 324               Composite.insert(std::make_pair(IdxPair, i1d->first));
 325             // Conflicting composition? Emit a warning but allow it.
 326             if (!Ins.second && Ins.first->second != i1d->first) {
 327               errs() << "Warning: SubRegIndex " << getQualifiedName(Idx1)
 328                      << " and " << getQualifiedName(IdxPair.second)
 329                      << " compose ambiguously as "
 330                      << getQualifiedName(Ins.first->second) << " or "
 331                      << getQualifiedName(i1d->first) << "\n";
 332             }
 333           }
 334         }
 335       }
 336     }
 337   }
 338
 339   // We don't care about the difference between (Idx1, Idx2) -> Idx2 and invalid
 340   // compositions, so remove any mappings of that form.
 341   for (CompositeMap::iterator i = Composite.begin(), e = Composite.end();
 342        i != e;) {
 343     CompositeMap::iterator j = i;
 344     ++i;
 345     if (j->first.second == j->second)
 346       Composite.erase(j);
 347   }
 348 }
 349
 350 // Compute sets of overlapping registers.
 351 //
 352 // The standard set is all super-registers and all sub-registers, but the
 353 // target description can add arbitrary overlapping registers via the 'Aliases'
 354 // field. This complicates things, but we can compute overlapping sets using
 355 // the following rules:
 356 //
 357 // 1. The relation overlap(A, B) is reflexive and symmetric but not transitive.
 358 //
 359 // 2. overlap(A, B) implies overlap(A, S) for all S in supers(B).
 360 //
 361 // Alternatively:
 362 //
 363 //    overlap(A, B) iff there exists:
 364 //    A' in { A, subregs(A) } and B' in { B, subregs(B) } such that:
 365 //    A' = B' or A' in aliases(B') or B' in aliases(A').
 366 //
 367 // Here subregs(A) is the full flattened sub-register set returned by
 368 // A.getSubRegs() while aliases(A) is simply the special 'Aliases' field in the
 369 // description of register A.
 370 //
 371 // This also implies that registers with a common sub-register are considered
 372 // overlapping. This can happen when forming register pairs:
 373 //
 374 //    P0 = (R0, R1)
 375 //    P1 = (R1, R2)
 376 //    P2 = (R2, R3)
 377 //
 378 // In this case, we will infer an overlap between P0 and P1 because of the
 379 // shared sub-register R1. There is no overlap between P0 and P2.
 380 //
 381 void CodeGenRegBank::
 382 computeOverlaps(std::map<const CodeGenRegister*, CodeGenRegister::Set> &Map) {
 383   assert(Map.empty());
 384
 385   // Collect overlaps that don't follow from rule 2.
 386   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
 387     CodeGenRegister *Reg = &Registers[i];
 388     CodeGenRegister::Set &Overlaps = Map[Reg];
 389
 390     // Reg overlaps itself.
 391     Overlaps.insert(Reg);
 392
 393     // All super-registers overlap.
 394     const CodeGenRegister::SuperRegList &Supers = Reg->getSuperRegs();
 395     Overlaps.insert(Supers.begin(), Supers.end());
 396
 397     // Form symmetrical relations from the special Aliases[] lists.
 398     std::vector<Record*> RegList = Reg->TheDef->getValueAsListOfDefs("Aliases");
 399     for (unsigned i2 = 0, e2 = RegList.size(); i2 != e2; ++i2) {
 400       CodeGenRegister *Reg2 = getReg(RegList[i2]);
 401       CodeGenRegister::Set &Overlaps2 = Map[Reg2];
 402       const CodeGenRegister::SuperRegList &Supers2 = Reg2->getSuperRegs();
 403       // Reg overlaps Reg2 which implies it overlaps supers(Reg2).
 404       Overlaps.insert(Reg2);
 405       Overlaps.insert(Supers2.begin(), Supers2.end());
 406       Overlaps2.insert(Reg);
 407       Overlaps2.insert(Supers.begin(), Supers.end());
 408     }
 409   }
 410
 411   // Apply rule 2. and inherit all sub-register overlaps.
 412   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
 413     CodeGenRegister *Reg = &Registers[i];
 414     CodeGenRegister::Set &Overlaps = Map[Reg];
 415     const CodeGenRegister::SubRegMap &SRM = Reg->getSubRegs();
 416     for (CodeGenRegister::SubRegMap::const_iterator i2 = SRM.begin(),
 417          e2 = SRM.end(); i2 != e2; ++i2) {
 418       CodeGenRegister::Set &Overlaps2 = Map[i2->second];
 419       Overlaps.insert(Overlaps2.begin(), Overlaps2.end());
 420     }
 421   }
 422 }
 423
 424 void CodeGenRegBank::computeDerivedInfo() {
 425   computeComposites();
 426 }
 427
 428 /// getRegisterClassForRegister - Find the register class that contains the
 429 /// specified physical register.  If the register is not in a register class,
 430 /// return null. If the register is in multiple classes, and the classes have a
 431 /// superset-subset relationship and the same set of types, return the
 432 /// superclass.  Otherwise return null.
 433 const CodeGenRegisterClass*
 434 CodeGenRegBank::getRegClassForRegister(Record *R) {
 435   const std::vector<CodeGenRegisterClass> &RCs = getRegClasses();
 436   const CodeGenRegisterClass *FoundRC = 0;
 437   for (unsigned i = 0, e = RCs.size(); i != e; ++i) {
 438     const CodeGenRegisterClass &RC = RCs[i];
 439     if (!RC.containsRegister(R))
 440       continue;
 441
 442     // If this is the first class that contains the register,
 443     // make a note of it and go on to the next class.
 444     if (!FoundRC) {
 445       FoundRC = &RC;
 446       continue;
 447     }
 448
 449     // If a register's classes have different types, return null.
 450     if (RC.getValueTypes() != FoundRC->getValueTypes())
 451       return 0;
 452
 453     std::vector<Record *> Elements(RC.Elements);
 454     std::vector<Record *> FoundElements(FoundRC->Elements);
 455     std::sort(Elements.begin(), Elements.end());
 456     std::sort(FoundElements.begin(), FoundElements.end());
 457
 458     // Check to see if the previously found class that contains
 459     // the register is a subclass of the current class. If so,
 460     // prefer the superclass.
 461     if (std::includes(Elements.begin(), Elements.end(),
 462                       FoundElements.begin(), FoundElements.end())) {
 463       FoundRC = &RC;
 464       continue;
 465     }
 466
 467     // Check to see if the previously found class that contains
 468     // the register is a superclass of the current class. If so,
 469     // prefer the superclass.
 470     if (std::includes(FoundElements.begin(), FoundElements.end(),
 471                       Elements.begin(), Elements.end()))
 472       continue;
 473
 474     // Multiple classes, and neither is a superclass of the other.
 475     // Return null.
 476     return 0;
 477   }
 478   return FoundRC;
 479 }