1 //===- CodeGenRegisters.h - Register and RegisterClass Info -----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines structures to encapsulate information gleaned from the
11 // target register and register class definitions.
13 //===----------------------------------------------------------------------===//
15 #ifndef CODEGEN_REGISTERS_H
16 #define CODEGEN_REGISTERS_H
18 #include "SetTheory.h"
19 #include "llvm/TableGen/Record.h"
20 #include "llvm/CodeGen/ValueTypes.h"
21 #include "llvm/ADT/ArrayRef.h"
22 #include "llvm/ADT/BitVector.h"
23 #include "llvm/ADT/DenseMap.h"
24 #include "llvm/ADT/SetVector.h"
25 #include "llvm/Support/ErrorHandling.h"
35 /// CodeGenSubRegIndex - Represents a sub-register index.
36 class CodeGenSubRegIndex {
39 std::string Namespace;
42 const unsigned EnumValue;
44 CodeGenSubRegIndex(Record *R, unsigned Enum);
45 CodeGenSubRegIndex(StringRef N, StringRef Nspace, unsigned Enum);
47 const std::string &getName() const { return Name; }
48 const std::string &getNamespace() const { return Namespace; }
49 std::string getQualifiedName() const;
51 // Order CodeGenSubRegIndex pointers by EnumValue.
53 bool operator()(const CodeGenSubRegIndex *A,
54 const CodeGenSubRegIndex *B) const {
56 return A->EnumValue < B->EnumValue;
60 // Map of composite subreg indices.
61 typedef std::map<CodeGenSubRegIndex*, CodeGenSubRegIndex*, Less> CompMap;
63 // Returns the subreg index that results from composing this with Idx.
64 // Returns NULL if this and Idx don't compose.
65 CodeGenSubRegIndex *compose(CodeGenSubRegIndex *Idx) const {
66 CompMap::const_iterator I = Composed.find(Idx);
67 return I == Composed.end() ? 0 : I->second;
70 // Add a composite subreg index: this+A = B.
71 // Return a conflicting composite, or NULL
72 CodeGenSubRegIndex *addComposite(CodeGenSubRegIndex *A,
73 CodeGenSubRegIndex *B) {
75 std::pair<CompMap::iterator, bool> Ins =
76 Composed.insert(std::make_pair(A, B));
77 return (Ins.second || Ins.first->second == B) ? 0 : Ins.first->second;
80 // Update the composite maps of components specified in 'ComposedOf'.
81 void updateComponents(CodeGenRegBank&);
83 // Return the map of composites.
84 const CompMap &getComposites() const { return Composed; }
90 /// CodeGenRegister - Represents a register definition.
91 struct CodeGenRegister {
95 bool CoveredBySubRegs;
97 // Map SubRegIndex -> Register.
98 typedef std::map<CodeGenSubRegIndex*, CodeGenRegister*,
99 CodeGenSubRegIndex::Less> SubRegMap;
101 CodeGenRegister(Record *R, unsigned Enum);
103 const std::string &getName() const;
105 // Extract more information from TheDef. This is used to build an object
106 // graph after all CodeGenRegister objects have been created.
107 void buildObjectGraph(CodeGenRegBank&);
109 // Lazily compute a map of all sub-registers.
110 // This includes unique entries for all sub-sub-registers.
111 const SubRegMap &computeSubRegs(CodeGenRegBank&);
113 // Compute extra sub-registers by combining the existing sub-registers.
114 void computeSecondarySubRegs(CodeGenRegBank&);
116 // Add this as a super-register to all sub-registers after the sub-register
117 // graph has been built.
118 void computeSuperRegs(CodeGenRegBank&);
120 const SubRegMap &getSubRegs() const {
121 assert(SubRegsComplete && "Must precompute sub-registers");
125 // Add sub-registers to OSet following a pre-order defined by the .td file.
126 void addSubRegsPreOrder(SetVector<const CodeGenRegister*> &OSet,
127 CodeGenRegBank&) const;
129 // Return the sub-register index naming Reg as a sub-register of this
130 // register. Returns NULL if Reg is not a sub-register.
131 CodeGenSubRegIndex *getSubRegIndex(const CodeGenRegister *Reg) const {
132 return SubReg2Idx.lookup(Reg);
135 typedef std::vector<const CodeGenRegister*> SuperRegList;
137 // Get the list of super-registers in topological order, small to large.
138 // This is valid after computeSubRegs visits all registers during RegBank
140 const SuperRegList &getSuperRegs() const {
141 assert(SubRegsComplete && "Must precompute sub-registers");
145 // Get the list of ad hoc aliases. The graph is symmetric, so the list
146 // contains all registers in 'Aliases', and all registers that mention this
147 // register in 'Aliases'.
148 ArrayRef<CodeGenRegister*> getExplicitAliases() const {
149 return ExplicitAliases;
152 // Get the topological signature of this register. This is a small integer
153 // less than RegBank.getNumTopoSigs(). Registers with the same TopoSig have
154 // identical sub-register structure. That is, they support the same set of
155 // sub-register indices mapping to the same kind of sub-registers
157 unsigned getTopoSig() const {
158 assert(SuperRegsComplete && "TopoSigs haven't been computed yet.");
162 // List of register units in ascending order.
163 typedef SmallVector<unsigned, 16> RegUnitList;
165 // How many entries in RegUnitList are native?
166 unsigned NumNativeRegUnits;
168 // Get the list of register units.
169 // This is only valid after computeSubRegs() completes.
170 const RegUnitList &getRegUnits() const { return RegUnits; }
172 // Get the native register units. This is a prefix of getRegUnits().
173 ArrayRef<unsigned> getNativeRegUnits() const {
174 return makeArrayRef(RegUnits).slice(0, NumNativeRegUnits);
177 // Inherit register units from subregisters.
178 // Return true if the RegUnits changed.
179 bool inheritRegUnits(CodeGenRegBank &RegBank);
181 // Adopt a register unit for pressure tracking.
182 // A unit is adopted iff its unit number is >= NumNativeRegUnits.
183 void adoptRegUnit(unsigned RUID) { RegUnits.push_back(RUID); }
185 // Get the sum of this register's register unit weights.
186 unsigned getWeight(const CodeGenRegBank &RegBank) const;
188 // Order CodeGenRegister pointers by EnumValue.
190 bool operator()(const CodeGenRegister *A,
191 const CodeGenRegister *B) const {
193 return A->EnumValue < B->EnumValue;
197 // Canonically ordered set.
198 typedef std::set<const CodeGenRegister*, Less> Set;
200 // Compute the set of registers overlapping this.
201 void computeOverlaps(Set &Overlaps, const CodeGenRegBank&) const;
204 bool SubRegsComplete;
205 bool SuperRegsComplete;
208 // The sub-registers explicit in the .td file form a tree.
209 SmallVector<CodeGenSubRegIndex*, 8> ExplicitSubRegIndices;
210 SmallVector<CodeGenRegister*, 8> ExplicitSubRegs;
212 // Explicit ad hoc aliases, symmetrized to form an undirected graph.
213 SmallVector<CodeGenRegister*, 8> ExplicitAliases;
215 // Super-registers where this is the first explicit sub-register.
216 SuperRegList LeadingSuperRegs;
219 SuperRegList SuperRegs;
220 DenseMap<const CodeGenRegister*, CodeGenSubRegIndex*> SubReg2Idx;
221 RegUnitList RegUnits;
225 class CodeGenRegisterClass {
226 CodeGenRegister::Set Members;
227 // Allocation orders. Order[0] always contains all registers in Members.
228 std::vector<SmallVector<Record*, 16> > Orders;
229 // Bit mask of sub-classes including this, indexed by their EnumValue.
230 BitVector SubClasses;
231 // List of super-classes, topologocally ordered to have the larger classes
232 // first. This is the same as sorting by EnumValue.
233 SmallVector<CodeGenRegisterClass*, 4> SuperClasses;
237 // For a synthesized class, inherit missing properties from the nearest
239 void inheritProperties(CodeGenRegBank&);
241 // Map SubRegIndex -> sub-class. This is the largest sub-class where all
242 // registers have a SubRegIndex sub-register.
243 DenseMap<CodeGenSubRegIndex*, CodeGenRegisterClass*> SubClassWithSubReg;
245 // Map SubRegIndex -> set of super-reg classes. This is all register
246 // classes SuperRC such that:
248 // R:SubRegIndex in this RC for all R in SuperRC.
250 DenseMap<CodeGenSubRegIndex*,
251 SmallPtrSet<CodeGenRegisterClass*, 8> > SuperRegClasses;
253 // Bit vector of TopoSigs for the registers in this class. This will be
254 // very sparse on regular architectures.
259 std::string Namespace;
260 std::vector<MVT::SimpleValueType> VTs;
262 unsigned SpillAlignment;
265 std::string AltOrderSelect;
267 // Return the Record that defined this class, or NULL if the class was
268 // created by TableGen.
269 Record *getDef() const { return TheDef; }
271 const std::string &getName() const { return Name; }
272 std::string getQualifiedName() const;
273 const std::vector<MVT::SimpleValueType> &getValueTypes() const {return VTs;}
274 unsigned getNumValueTypes() const { return VTs.size(); }
276 MVT::SimpleValueType getValueTypeNum(unsigned VTNum) const {
277 if (VTNum < VTs.size())
279 llvm_unreachable("VTNum greater than number of ValueTypes in RegClass!");
282 // Return true if this this class contains the register.
283 bool contains(const CodeGenRegister*) const;
285 // Returns true if RC is a subclass.
286 // RC is a sub-class of this class if it is a valid replacement for any
287 // instruction operand where a register of this classis required. It must
288 // satisfy these conditions:
290 // 1. All RC registers are also in this.
291 // 2. The RC spill size must not be smaller than our spill size.
292 // 3. RC spill alignment must be compatible with ours.
294 bool hasSubClass(const CodeGenRegisterClass *RC) const {
295 return SubClasses.test(RC->EnumValue);
298 // getSubClassWithSubReg - Returns the largest sub-class where all
299 // registers have a SubIdx sub-register.
300 CodeGenRegisterClass*
301 getSubClassWithSubReg(CodeGenSubRegIndex *SubIdx) const {
302 return SubClassWithSubReg.lookup(SubIdx);
305 void setSubClassWithSubReg(CodeGenSubRegIndex *SubIdx,
306 CodeGenRegisterClass *SubRC) {
307 SubClassWithSubReg[SubIdx] = SubRC;
310 // getSuperRegClasses - Returns a bit vector of all register classes
311 // containing only SubIdx super-registers of this class.
312 void getSuperRegClasses(CodeGenSubRegIndex *SubIdx, BitVector &Out) const;
314 // addSuperRegClass - Add a class containing only SudIdx super-registers.
315 void addSuperRegClass(CodeGenSubRegIndex *SubIdx,
316 CodeGenRegisterClass *SuperRC) {
317 SuperRegClasses[SubIdx].insert(SuperRC);
320 // getSubClasses - Returns a constant BitVector of subclasses indexed by
322 // The SubClasses vector includs an entry for this class.
323 const BitVector &getSubClasses() const { return SubClasses; }
325 // getSuperClasses - Returns a list of super classes ordered by EnumValue.
326 // The array does not include an entry for this class.
327 ArrayRef<CodeGenRegisterClass*> getSuperClasses() const {
331 // Returns an ordered list of class members.
332 // The order of registers is the same as in the .td file.
333 // No = 0 is the default allocation order, No = 1 is the first alternative.
334 ArrayRef<Record*> getOrder(unsigned No = 0) const {
338 // Return the total number of allocation orders available.
339 unsigned getNumOrders() const { return Orders.size(); }
341 // Get the set of registers. This set contains the same registers as
343 const CodeGenRegister::Set &getMembers() const { return Members; }
345 // Get a bit vector of TopoSigs present in this register class.
346 const BitVector &getTopoSigs() const { return TopoSigs; }
348 // Populate a unique sorted list of units from a register set.
349 void buildRegUnitSet(std::vector<unsigned> &RegUnits) const;
351 CodeGenRegisterClass(CodeGenRegBank&, Record *R);
353 // A key representing the parts of a register class used for forming
354 // sub-classes. Note the ordering provided by this key is not the same as
355 // the topological order used for the EnumValues.
357 const CodeGenRegister::Set *Members;
359 unsigned SpillAlignment;
362 : Members(O.Members),
363 SpillSize(O.SpillSize),
364 SpillAlignment(O.SpillAlignment) {}
366 Key(const CodeGenRegister::Set *M, unsigned S = 0, unsigned A = 0)
367 : Members(M), SpillSize(S), SpillAlignment(A) {}
369 Key(const CodeGenRegisterClass &RC)
370 : Members(&RC.getMembers()),
371 SpillSize(RC.SpillSize),
372 SpillAlignment(RC.SpillAlignment) {}
374 // Lexicographical order of (Members, SpillSize, SpillAlignment).
375 bool operator<(const Key&) const;
378 // Create a non-user defined register class.
379 CodeGenRegisterClass(CodeGenRegBank&, StringRef Name, Key Props);
381 // Called by CodeGenRegBank::CodeGenRegBank().
382 static void computeSubClasses(CodeGenRegBank&);
385 // Register units are used to model interference and register pressure.
386 // Every register is assigned one or more register units such that two
387 // registers overlap if and only if they have a register unit in common.
389 // Normally, one register unit is created per leaf register. Non-leaf
390 // registers inherit the units of their sub-registers.
392 // Weight assigned to this RegUnit for estimating register pressure.
393 // This is useful when equalizing weights in register classes with mixed
394 // register topologies.
397 // Each native RegUnit corresponds to one or two root registers. The full
398 // set of registers containing this unit can be computed as the union of
399 // these two registers and their super-registers.
400 const CodeGenRegister *Roots[2];
402 RegUnit() : Weight(0) { Roots[0] = Roots[1] = 0; }
404 ArrayRef<const CodeGenRegister*> getRoots() const {
405 assert(!(Roots[1] && !Roots[0]) && "Invalid roots array");
406 return makeArrayRef(Roots, !!Roots[0] + !!Roots[1]);
410 // Each RegUnitSet is a sorted vector with a name.
412 typedef std::vector<unsigned>::const_iterator iterator;
415 std::vector<unsigned> Units;
418 // Base vector for identifying TopoSigs. The contents uniquely identify a
419 // TopoSig, only computeSuperRegs needs to know how.
420 typedef SmallVector<unsigned, 16> TopoSigId;
422 // CodeGenRegBank - Represent a target's registers and the relations between
424 class CodeGenRegBank {
428 std::vector<CodeGenSubRegIndex*> SubRegIndices;
429 DenseMap<Record*, CodeGenSubRegIndex*> Def2SubRegIdx;
431 CodeGenSubRegIndex *createSubRegIndex(StringRef Name, StringRef NameSpace);
433 typedef std::map<SmallVector<CodeGenSubRegIndex*, 8>,
434 CodeGenSubRegIndex*> ConcatIdxMap;
435 ConcatIdxMap ConcatIdx;
438 std::vector<CodeGenRegister*> Registers;
439 DenseMap<Record*, CodeGenRegister*> Def2Reg;
440 unsigned NumNativeRegUnits;
442 std::map<TopoSigId, unsigned> TopoSigs;
444 // Includes native (0..NumNativeRegUnits-1) and adopted register units.
445 SmallVector<RegUnit, 8> RegUnits;
448 std::vector<CodeGenRegisterClass*> RegClasses;
449 DenseMap<Record*, CodeGenRegisterClass*> Def2RC;
450 typedef std::map<CodeGenRegisterClass::Key, CodeGenRegisterClass*> RCKeyMap;
453 // Remember each unique set of register units. Initially, this contains a
454 // unique set for each register class. Simliar sets are coalesced with
455 // pruneUnitSets and new supersets are inferred during computeRegUnitSets.
456 std::vector<RegUnitSet> RegUnitSets;
458 // Map RegisterClass index to the index of the RegUnitSet that contains the
459 // class's units and any inferred RegUnit supersets.
460 std::vector<std::vector<unsigned> > RegClassUnitSets;
462 // Add RC to *2RC maps.
463 void addToMaps(CodeGenRegisterClass*);
465 // Create a synthetic sub-class if it is missing.
466 CodeGenRegisterClass *getOrCreateSubClass(const CodeGenRegisterClass *RC,
467 const CodeGenRegister::Set *Membs,
470 // Infer missing register classes.
471 void computeInferredRegisterClasses();
472 void inferCommonSubClass(CodeGenRegisterClass *RC);
473 void inferSubClassWithSubReg(CodeGenRegisterClass *RC);
474 void inferMatchingSuperRegClass(CodeGenRegisterClass *RC,
475 unsigned FirstSubRegRC = 0);
477 // Iteratively prune unit sets.
478 void pruneUnitSets();
480 // Compute a weight for each register unit created during getSubRegs.
481 void computeRegUnitWeights();
483 // Create a RegUnitSet for each RegClass and infer superclasses.
484 void computeRegUnitSets();
486 // Populate the Composite map from sub-register relationships.
487 void computeComposites();
490 CodeGenRegBank(RecordKeeper&);
492 SetTheory &getSets() { return Sets; }
494 // Sub-register indices. The first NumNamedIndices are defined by the user
495 // in the .td files. The rest are synthesized such that all sub-registers
496 // have a unique name.
497 ArrayRef<CodeGenSubRegIndex*> getSubRegIndices() { return SubRegIndices; }
499 // Find a SubRegIndex form its Record def.
500 CodeGenSubRegIndex *getSubRegIdx(Record*);
502 // Find or create a sub-register index representing the A+B composition.
503 CodeGenSubRegIndex *getCompositeSubRegIndex(CodeGenSubRegIndex *A,
504 CodeGenSubRegIndex *B);
506 // Find or create a sub-register index representing the concatenation of
507 // non-overlapping sibling indices.
509 getConcatSubRegIndex(const SmallVector<CodeGenSubRegIndex*, 8>&);
512 addConcatSubRegIndex(const SmallVector<CodeGenSubRegIndex*, 8> &Parts,
513 CodeGenSubRegIndex *Idx) {
514 ConcatIdx.insert(std::make_pair(Parts, Idx));
517 const std::vector<CodeGenRegister*> &getRegisters() { return Registers; }
519 // Find a register from its Record def.
520 CodeGenRegister *getReg(Record*);
522 // Get a Register's index into the Registers array.
523 unsigned getRegIndex(const CodeGenRegister *Reg) const {
524 return Reg->EnumValue - 1;
527 // Return the number of allocated TopoSigs. The first TopoSig representing
528 // leaf registers is allocated number 0.
529 unsigned getNumTopoSigs() const {
530 return TopoSigs.size();
533 // Find or create a TopoSig for the given TopoSigId.
534 // This function is only for use by CodeGenRegister::computeSuperRegs().
535 // Others should simply use Reg->getTopoSig().
536 unsigned getTopoSig(const TopoSigId &Id) {
537 return TopoSigs.insert(std::make_pair(Id, TopoSigs.size())).first->second;
540 // Create a native register unit that is associated with one or two root
542 unsigned newRegUnit(CodeGenRegister *R0, CodeGenRegister *R1 = 0) {
543 RegUnits.resize(RegUnits.size() + 1);
544 RegUnits.back().Roots[0] = R0;
545 RegUnits.back().Roots[1] = R1;
546 return RegUnits.size() - 1;
549 // Create a new non-native register unit that can be adopted by a register
550 // to increase its pressure. Note that NumNativeRegUnits is not increased.
551 unsigned newRegUnit(unsigned Weight) {
552 RegUnits.resize(RegUnits.size() + 1);
553 RegUnits.back().Weight = Weight;
554 return RegUnits.size() - 1;
557 // Native units are the singular unit of a leaf register. Register aliasing
558 // is completely characterized by native units. Adopted units exist to give
559 // register additional weight but don't affect aliasing.
560 bool isNativeUnit(unsigned RUID) {
561 return RUID < NumNativeRegUnits;
564 unsigned getNumNativeRegUnits() const {
565 return NumNativeRegUnits;
568 RegUnit &getRegUnit(unsigned RUID) { return RegUnits[RUID]; }
569 const RegUnit &getRegUnit(unsigned RUID) const { return RegUnits[RUID]; }
571 ArrayRef<CodeGenRegisterClass*> getRegClasses() const {
575 // Find a register class from its def.
576 CodeGenRegisterClass *getRegClass(Record*);
578 /// getRegisterClassForRegister - Find the register class that contains the
579 /// specified physical register. If the register is not in a register
580 /// class, return null. If the register is in multiple classes, and the
581 /// classes have a superset-subset relationship and the same set of types,
582 /// return the superclass. Otherwise return null.
583 const CodeGenRegisterClass* getRegClassForRegister(Record *R);
585 // Get the sum of unit weights.
586 unsigned getRegUnitSetWeight(const std::vector<unsigned> &Units) const {
588 for (std::vector<unsigned>::const_iterator
589 I = Units.begin(), E = Units.end(); I != E; ++I)
590 Weight += getRegUnit(*I).Weight;
594 // Increase a RegUnitWeight.
595 void increaseRegUnitWeight(unsigned RUID, unsigned Inc) {
596 getRegUnit(RUID).Weight += Inc;
599 // Get the number of register pressure dimensions.
600 unsigned getNumRegPressureSets() const { return RegUnitSets.size(); }
602 // Get a set of register unit IDs for a given dimension of pressure.
603 RegUnitSet getRegPressureSet(unsigned Idx) const {
604 return RegUnitSets[Idx];
607 // Get a list of pressure set IDs for a register class. Liveness of a
608 // register in this class impacts each pressure set in this list by the
609 // weight of the register. An exact solution requires all registers in a
610 // class to have the same class, but it is not strictly guaranteed.
611 ArrayRef<unsigned> getRCPressureSetIDs(unsigned RCIdx) const {
612 return RegClassUnitSets[RCIdx];
615 // Computed derived records such as missing sub-register indices.
616 void computeDerivedInfo();
618 // Compute the set of registers completely covered by the registers in Regs.
619 // The returned BitVector will have a bit set for each register in Regs,
620 // all sub-registers, and all super-registers that are covered by the
621 // registers in Regs.
623 // This is used to compute the mask of call-preserved registers from a list
625 BitVector computeCoveredRegisters(ArrayRef<Record*> Regs);