Remove indirection of vector<T*> in favor of deque<T>
[oota-llvm.git] / utils / TableGen / CodeGenRegisters.h
1 //===- CodeGenRegisters.h - Register and RegisterClass Info -----*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines structures to encapsulate information gleaned from the
11 // target register and register class definitions.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef LLVM_UTILS_TABLEGEN_CODEGENREGISTERS_H
16 #define LLVM_UTILS_TABLEGEN_CODEGENREGISTERS_H
17
18 #include "llvm/ADT/ArrayRef.h"
19 #include "llvm/ADT/BitVector.h"
20 #include "llvm/ADT/DenseMap.h"
21 #include "llvm/ADT/SetVector.h"
22 #include "llvm/CodeGen/MachineValueType.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/TableGen/Record.h"
25 #include "llvm/TableGen/SetTheory.h"
26 #include <cstdlib>
27 #include <map>
28 #include <set>
29 #include <string>
30 #include <vector>
31 #include <deque>
32
33 namespace llvm {
34   class CodeGenRegBank;
35
36   /// CodeGenSubRegIndex - Represents a sub-register index.
37   class CodeGenSubRegIndex {
38     Record *const TheDef;
39     std::string Name;
40     std::string Namespace;
41
42   public:
43     uint16_t Size;
44     uint16_t Offset;
45     const unsigned EnumValue;
46     mutable unsigned LaneMask;
47
48     // Are all super-registers containing this SubRegIndex covered by their
49     // sub-registers?
50     bool AllSuperRegsCovered;
51
52     CodeGenSubRegIndex(Record *R, unsigned Enum);
53     CodeGenSubRegIndex(StringRef N, StringRef Nspace, unsigned Enum);
54
55     const std::string &getName() const { return Name; }
56     const std::string &getNamespace() const { return Namespace; }
57     std::string getQualifiedName() const;
58
59     // Order CodeGenSubRegIndex pointers by EnumValue.
60     struct Less {
61       bool operator()(const CodeGenSubRegIndex *A,
62                       const CodeGenSubRegIndex *B) const {
63         assert(A && B);
64         return A->EnumValue < B->EnumValue;
65       }
66     };
67
68     // Map of composite subreg indices.
69     typedef std::map<CodeGenSubRegIndex*, CodeGenSubRegIndex*, Less> CompMap;
70
71     // Returns the subreg index that results from composing this with Idx.
72     // Returns NULL if this and Idx don't compose.
73     CodeGenSubRegIndex *compose(CodeGenSubRegIndex *Idx) const {
74       CompMap::const_iterator I = Composed.find(Idx);
75       return I == Composed.end() ? nullptr : I->second;
76     }
77
78     // Add a composite subreg index: this+A = B.
79     // Return a conflicting composite, or NULL
80     CodeGenSubRegIndex *addComposite(CodeGenSubRegIndex *A,
81                                      CodeGenSubRegIndex *B) {
82       assert(A && B);
83       std::pair<CompMap::iterator, bool> Ins =
84         Composed.insert(std::make_pair(A, B));
85       // Synthetic subreg indices that aren't contiguous (for instance ARM
86       // register tuples) don't have a bit range, so it's OK to let
87       // B->Offset == -1. For the other cases, accumulate the offset and set
88       // the size here. Only do so if there is no offset yet though.
89       if ((Offset != (uint16_t)-1 && A->Offset != (uint16_t)-1) &&
90           (B->Offset == (uint16_t)-1)) {
91         B->Offset = Offset + A->Offset;
92         B->Size = A->Size;
93       }
94       return (Ins.second || Ins.first->second == B) ? nullptr
95                                                     : Ins.first->second;
96     }
97
98     // Update the composite maps of components specified in 'ComposedOf'.
99     void updateComponents(CodeGenRegBank&);
100
101     // Return the map of composites.
102     const CompMap &getComposites() const { return Composed; }
103
104     // Compute LaneMask from Composed. Return LaneMask.
105     unsigned computeLaneMask() const;
106
107   private:
108     CompMap Composed;
109   };
110
111   /// CodeGenRegister - Represents a register definition.
112   struct CodeGenRegister {
113     Record *TheDef;
114     unsigned EnumValue;
115     unsigned CostPerUse;
116     bool CoveredBySubRegs;
117
118     // Map SubRegIndex -> Register.
119     typedef std::map<CodeGenSubRegIndex*, CodeGenRegister*,
120                      CodeGenSubRegIndex::Less> SubRegMap;
121
122     CodeGenRegister(Record *R, unsigned Enum);
123
124     const std::string &getName() const;
125
126     // Extract more information from TheDef. This is used to build an object
127     // graph after all CodeGenRegister objects have been created.
128     void buildObjectGraph(CodeGenRegBank&);
129
130     // Lazily compute a map of all sub-registers.
131     // This includes unique entries for all sub-sub-registers.
132     const SubRegMap &computeSubRegs(CodeGenRegBank&);
133
134     // Compute extra sub-registers by combining the existing sub-registers.
135     void computeSecondarySubRegs(CodeGenRegBank&);
136
137     // Add this as a super-register to all sub-registers after the sub-register
138     // graph has been built.
139     void computeSuperRegs(CodeGenRegBank&);
140
141     const SubRegMap &getSubRegs() const {
142       assert(SubRegsComplete && "Must precompute sub-registers");
143       return SubRegs;
144     }
145
146     // Add sub-registers to OSet following a pre-order defined by the .td file.
147     void addSubRegsPreOrder(SetVector<const CodeGenRegister*> &OSet,
148                             CodeGenRegBank&) const;
149
150     // Return the sub-register index naming Reg as a sub-register of this
151     // register. Returns NULL if Reg is not a sub-register.
152     CodeGenSubRegIndex *getSubRegIndex(const CodeGenRegister *Reg) const {
153       return SubReg2Idx.lookup(Reg);
154     }
155
156     typedef std::vector<const CodeGenRegister*> SuperRegList;
157
158     // Get the list of super-registers in topological order, small to large.
159     // This is valid after computeSubRegs visits all registers during RegBank
160     // construction.
161     const SuperRegList &getSuperRegs() const {
162       assert(SubRegsComplete && "Must precompute sub-registers");
163       return SuperRegs;
164     }
165
166     // Get the list of ad hoc aliases. The graph is symmetric, so the list
167     // contains all registers in 'Aliases', and all registers that mention this
168     // register in 'Aliases'.
169     ArrayRef<CodeGenRegister*> getExplicitAliases() const {
170       return ExplicitAliases;
171     }
172
173     // Get the topological signature of this register. This is a small integer
174     // less than RegBank.getNumTopoSigs(). Registers with the same TopoSig have
175     // identical sub-register structure. That is, they support the same set of
176     // sub-register indices mapping to the same kind of sub-registers
177     // (TopoSig-wise).
178     unsigned getTopoSig() const {
179       assert(SuperRegsComplete && "TopoSigs haven't been computed yet.");
180       return TopoSig;
181     }
182
183     // List of register units in ascending order.
184     typedef SmallVector<unsigned, 16> RegUnitList;
185
186     // How many entries in RegUnitList are native?
187     unsigned NumNativeRegUnits;
188
189     // Get the list of register units.
190     // This is only valid after computeSubRegs() completes.
191     const RegUnitList &getRegUnits() const { return RegUnits; }
192
193     // Get the native register units. This is a prefix of getRegUnits().
194     ArrayRef<unsigned> getNativeRegUnits() const {
195       return makeArrayRef(RegUnits).slice(0, NumNativeRegUnits);
196     }
197
198     // Inherit register units from subregisters.
199     // Return true if the RegUnits changed.
200     bool inheritRegUnits(CodeGenRegBank &RegBank);
201
202     // Adopt a register unit for pressure tracking.
203     // A unit is adopted iff its unit number is >= NumNativeRegUnits.
204     void adoptRegUnit(unsigned RUID) { RegUnits.push_back(RUID); }
205
206     // Get the sum of this register's register unit weights.
207     unsigned getWeight(const CodeGenRegBank &RegBank) const;
208
209     // Order CodeGenRegister pointers by EnumValue.
210     struct Less {
211       bool operator()(const CodeGenRegister *A,
212                       const CodeGenRegister *B) const {
213         assert(A && B);
214         return A->EnumValue < B->EnumValue;
215       }
216     };
217
218     // Canonically ordered set.
219     typedef std::set<const CodeGenRegister*, Less> Set;
220
221   private:
222     bool SubRegsComplete;
223     bool SuperRegsComplete;
224     unsigned TopoSig;
225
226     // The sub-registers explicit in the .td file form a tree.
227     SmallVector<CodeGenSubRegIndex*, 8> ExplicitSubRegIndices;
228     SmallVector<CodeGenRegister*, 8> ExplicitSubRegs;
229
230     // Explicit ad hoc aliases, symmetrized to form an undirected graph.
231     SmallVector<CodeGenRegister*, 8> ExplicitAliases;
232
233     // Super-registers where this is the first explicit sub-register.
234     SuperRegList LeadingSuperRegs;
235
236     SubRegMap SubRegs;
237     SuperRegList SuperRegs;
238     DenseMap<const CodeGenRegister*, CodeGenSubRegIndex*> SubReg2Idx;
239     RegUnitList RegUnits;
240   };
241
242
243   class CodeGenRegisterClass {
244     CodeGenRegister::Set Members;
245     // Allocation orders. Order[0] always contains all registers in Members.
246     std::vector<SmallVector<Record*, 16> > Orders;
247     // Bit mask of sub-classes including this, indexed by their EnumValue.
248     BitVector SubClasses;
249     // List of super-classes, topologocally ordered to have the larger classes
250     // first.  This is the same as sorting by EnumValue.
251     SmallVector<CodeGenRegisterClass*, 4> SuperClasses;
252     Record *TheDef;
253     std::string Name;
254
255     // For a synthesized class, inherit missing properties from the nearest
256     // super-class.
257     void inheritProperties(CodeGenRegBank&);
258
259     // Map SubRegIndex -> sub-class.  This is the largest sub-class where all
260     // registers have a SubRegIndex sub-register.
261     DenseMap<const CodeGenSubRegIndex *, CodeGenRegisterClass *>
262         SubClassWithSubReg;
263
264     // Map SubRegIndex -> set of super-reg classes.  This is all register
265     // classes SuperRC such that:
266     //
267     //   R:SubRegIndex in this RC for all R in SuperRC.
268     //
269     DenseMap<const CodeGenSubRegIndex *, SmallPtrSet<CodeGenRegisterClass *, 8>>
270         SuperRegClasses;
271
272     // Bit vector of TopoSigs for the registers in this class. This will be
273     // very sparse on regular architectures.
274     BitVector TopoSigs;
275
276   public:
277     unsigned EnumValue;
278     std::string Namespace;
279     SmallVector<MVT::SimpleValueType, 4> VTs;
280     unsigned SpillSize;
281     unsigned SpillAlignment;
282     int CopyCost;
283     bool Allocatable;
284     std::string AltOrderSelect;
285
286     // Return the Record that defined this class, or NULL if the class was
287     // created by TableGen.
288     Record *getDef() const { return TheDef; }
289
290     const std::string &getName() const { return Name; }
291     std::string getQualifiedName() const;
292     ArrayRef<MVT::SimpleValueType> getValueTypes() const {return VTs;}
293     unsigned getNumValueTypes() const { return VTs.size(); }
294
295     MVT::SimpleValueType getValueTypeNum(unsigned VTNum) const {
296       if (VTNum < VTs.size())
297         return VTs[VTNum];
298       llvm_unreachable("VTNum greater than number of ValueTypes in RegClass!");
299     }
300
301     // Return true if this this class contains the register.
302     bool contains(const CodeGenRegister*) const;
303
304     // Returns true if RC is a subclass.
305     // RC is a sub-class of this class if it is a valid replacement for any
306     // instruction operand where a register of this classis required. It must
307     // satisfy these conditions:
308     //
309     // 1. All RC registers are also in this.
310     // 2. The RC spill size must not be smaller than our spill size.
311     // 3. RC spill alignment must be compatible with ours.
312     //
313     bool hasSubClass(const CodeGenRegisterClass *RC) const {
314       return SubClasses.test(RC->EnumValue);
315     }
316
317     // getSubClassWithSubReg - Returns the largest sub-class where all
318     // registers have a SubIdx sub-register.
319     CodeGenRegisterClass *
320     getSubClassWithSubReg(const CodeGenSubRegIndex *SubIdx) const {
321       return SubClassWithSubReg.lookup(SubIdx);
322     }
323
324     void setSubClassWithSubReg(const CodeGenSubRegIndex *SubIdx,
325                                CodeGenRegisterClass *SubRC) {
326       SubClassWithSubReg[SubIdx] = SubRC;
327     }
328
329     // getSuperRegClasses - Returns a bit vector of all register classes
330     // containing only SubIdx super-registers of this class.
331     void getSuperRegClasses(const CodeGenSubRegIndex *SubIdx,
332                             BitVector &Out) const;
333
334     // addSuperRegClass - Add a class containing only SudIdx super-registers.
335     void addSuperRegClass(CodeGenSubRegIndex *SubIdx,
336                           CodeGenRegisterClass *SuperRC) {
337       SuperRegClasses[SubIdx].insert(SuperRC);
338     }
339
340     // getSubClasses - Returns a constant BitVector of subclasses indexed by
341     // EnumValue.
342     // The SubClasses vector includes an entry for this class.
343     const BitVector &getSubClasses() const { return SubClasses; }
344
345     // getSuperClasses - Returns a list of super classes ordered by EnumValue.
346     // The array does not include an entry for this class.
347     ArrayRef<CodeGenRegisterClass*> getSuperClasses() const {
348       return SuperClasses;
349     }
350
351     // Returns an ordered list of class members.
352     // The order of registers is the same as in the .td file.
353     // No = 0 is the default allocation order, No = 1 is the first alternative.
354     ArrayRef<Record*> getOrder(unsigned No = 0) const {
355         return Orders[No];
356     }
357
358     // Return the total number of allocation orders available.
359     unsigned getNumOrders() const { return Orders.size(); }
360
361     // Get the set of registers.  This set contains the same registers as
362     // getOrder(0).
363     const CodeGenRegister::Set &getMembers() const { return Members; }
364
365     // Get a bit vector of TopoSigs present in this register class.
366     const BitVector &getTopoSigs() const { return TopoSigs; }
367
368     // Populate a unique sorted list of units from a register set.
369     void buildRegUnitSet(std::vector<unsigned> &RegUnits) const;
370
371     CodeGenRegisterClass(CodeGenRegBank&, Record *R);
372
373     // A key representing the parts of a register class used for forming
374     // sub-classes.  Note the ordering provided by this key is not the same as
375     // the topological order used for the EnumValues.
376     struct Key {
377       const CodeGenRegister::Set *Members;
378       unsigned SpillSize;
379       unsigned SpillAlignment;
380
381       Key(const CodeGenRegister::Set *M, unsigned S = 0, unsigned A = 0)
382         : Members(M), SpillSize(S), SpillAlignment(A) {}
383
384       Key(const CodeGenRegisterClass &RC)
385         : Members(&RC.getMembers()),
386           SpillSize(RC.SpillSize),
387           SpillAlignment(RC.SpillAlignment) {}
388
389       // Lexicographical order of (Members, SpillSize, SpillAlignment).
390       bool operator<(const Key&) const;
391     };
392
393     // Create a non-user defined register class.
394     CodeGenRegisterClass(CodeGenRegBank&, StringRef Name, Key Props);
395
396     // Called by CodeGenRegBank::CodeGenRegBank().
397     static void computeSubClasses(CodeGenRegBank&);
398   };
399
400   // Register units are used to model interference and register pressure.
401   // Every register is assigned one or more register units such that two
402   // registers overlap if and only if they have a register unit in common.
403   //
404   // Normally, one register unit is created per leaf register. Non-leaf
405   // registers inherit the units of their sub-registers.
406   struct RegUnit {
407     // Weight assigned to this RegUnit for estimating register pressure.
408     // This is useful when equalizing weights in register classes with mixed
409     // register topologies.
410     unsigned Weight;
411
412     // Each native RegUnit corresponds to one or two root registers. The full
413     // set of registers containing this unit can be computed as the union of
414     // these two registers and their super-registers.
415     const CodeGenRegister *Roots[2];
416
417     // Index into RegClassUnitSets where we can find the list of UnitSets that
418     // contain this unit.
419     unsigned RegClassUnitSetsIdx;
420
421     RegUnit() : Weight(0), RegClassUnitSetsIdx(0) {
422       Roots[0] = Roots[1] = nullptr;
423     }
424
425     ArrayRef<const CodeGenRegister*> getRoots() const {
426       assert(!(Roots[1] && !Roots[0]) && "Invalid roots array");
427       return makeArrayRef(Roots, !!Roots[0] + !!Roots[1]);
428     }
429   };
430
431   // Each RegUnitSet is a sorted vector with a name.
432   struct RegUnitSet {
433     typedef std::vector<unsigned>::const_iterator iterator;
434
435     std::string Name;
436     std::vector<unsigned> Units;
437     unsigned Weight; // Cache the sum of all unit weights.
438     unsigned Order;  // Cache the sort key.
439
440     RegUnitSet() : Weight(0), Order(0) {}
441   };
442
443   // Base vector for identifying TopoSigs. The contents uniquely identify a
444   // TopoSig, only computeSuperRegs needs to know how.
445   typedef SmallVector<unsigned, 16> TopoSigId;
446
447   // CodeGenRegBank - Represent a target's registers and the relations between
448   // them.
449   class CodeGenRegBank {
450     SetTheory Sets;
451
452     std::deque<CodeGenSubRegIndex> SubRegIndices;
453     DenseMap<Record*, CodeGenSubRegIndex*> Def2SubRegIdx;
454
455     CodeGenSubRegIndex *createSubRegIndex(StringRef Name, StringRef NameSpace);
456
457     typedef std::map<SmallVector<CodeGenSubRegIndex*, 8>,
458                      CodeGenSubRegIndex*> ConcatIdxMap;
459     ConcatIdxMap ConcatIdx;
460
461     // Registers.
462     std::deque<CodeGenRegister> Registers;
463     StringMap<CodeGenRegister*> RegistersByName;
464     DenseMap<Record*, CodeGenRegister*> Def2Reg;
465     unsigned NumNativeRegUnits;
466
467     std::map<TopoSigId, unsigned> TopoSigs;
468
469     // Includes native (0..NumNativeRegUnits-1) and adopted register units.
470     SmallVector<RegUnit, 8> RegUnits;
471
472     // Register classes.
473     std::vector<CodeGenRegisterClass*> RegClasses;
474     DenseMap<Record*, CodeGenRegisterClass*> Def2RC;
475     typedef std::map<CodeGenRegisterClass::Key, CodeGenRegisterClass*> RCKeyMap;
476     RCKeyMap Key2RC;
477
478     // Remember each unique set of register units. Initially, this contains a
479     // unique set for each register class. Simliar sets are coalesced with
480     // pruneUnitSets and new supersets are inferred during computeRegUnitSets.
481     std::vector<RegUnitSet> RegUnitSets;
482
483     // Map RegisterClass index to the index of the RegUnitSet that contains the
484     // class's units and any inferred RegUnit supersets.
485     //
486     // NOTE: This could grow beyond the number of register classes when we map
487     // register units to lists of unit sets. If the list of unit sets does not
488     // already exist for a register class, we create a new entry in this vector.
489     std::vector<std::vector<unsigned> > RegClassUnitSets;
490
491     // Give each register unit set an order based on sorting criteria.
492     std::vector<unsigned> RegUnitSetOrder;
493
494     // Add RC to *2RC maps.
495     void addToMaps(CodeGenRegisterClass*);
496
497     // Create a synthetic sub-class if it is missing.
498     CodeGenRegisterClass *getOrCreateSubClass(const CodeGenRegisterClass *RC,
499                                               const CodeGenRegister::Set *Membs,
500                                               StringRef Name);
501
502     // Infer missing register classes.
503     void computeInferredRegisterClasses();
504     void inferCommonSubClass(CodeGenRegisterClass *RC);
505     void inferSubClassWithSubReg(CodeGenRegisterClass *RC);
506     void inferMatchingSuperRegClass(CodeGenRegisterClass *RC,
507                                     unsigned FirstSubRegRC = 0);
508
509     // Iteratively prune unit sets.
510     void pruneUnitSets();
511
512     // Compute a weight for each register unit created during getSubRegs.
513     void computeRegUnitWeights();
514
515     // Create a RegUnitSet for each RegClass and infer superclasses.
516     void computeRegUnitSets();
517
518     // Populate the Composite map from sub-register relationships.
519     void computeComposites();
520
521     // Compute a lane mask for each sub-register index.
522     void computeSubRegIndexLaneMasks();
523
524   public:
525     CodeGenRegBank(RecordKeeper&);
526     ~CodeGenRegBank();
527
528     SetTheory &getSets() { return Sets; }
529
530     // Sub-register indices. The first NumNamedIndices are defined by the user
531     // in the .td files. The rest are synthesized such that all sub-registers
532     // have a unique name.
533     const std::deque<CodeGenSubRegIndex> &getSubRegIndices() const {
534       return SubRegIndices;
535     }
536
537     // Find a SubRegIndex form its Record def.
538     CodeGenSubRegIndex *getSubRegIdx(Record*);
539
540     // Find or create a sub-register index representing the A+B composition.
541     CodeGenSubRegIndex *getCompositeSubRegIndex(CodeGenSubRegIndex *A,
542                                                 CodeGenSubRegIndex *B);
543
544     // Find or create a sub-register index representing the concatenation of
545     // non-overlapping sibling indices.
546     CodeGenSubRegIndex *
547       getConcatSubRegIndex(const SmallVector<CodeGenSubRegIndex *, 8>&);
548
549     void
550     addConcatSubRegIndex(const SmallVector<CodeGenSubRegIndex *, 8> &Parts,
551                          CodeGenSubRegIndex *Idx) {
552       ConcatIdx.insert(std::make_pair(Parts, Idx));
553     }
554
555     const std::deque<CodeGenRegister> &getRegisters() { return Registers; }
556     const StringMap<CodeGenRegister*> &getRegistersByName() {
557       return RegistersByName;
558     }
559
560     // Find a register from its Record def.
561     CodeGenRegister *getReg(Record*);
562
563     // Get a Register's index into the Registers array.
564     unsigned getRegIndex(const CodeGenRegister *Reg) const {
565       return Reg->EnumValue - 1;
566     }
567
568     // Return the number of allocated TopoSigs. The first TopoSig representing
569     // leaf registers is allocated number 0.
570     unsigned getNumTopoSigs() const {
571       return TopoSigs.size();
572     }
573
574     // Find or create a TopoSig for the given TopoSigId.
575     // This function is only for use by CodeGenRegister::computeSuperRegs().
576     // Others should simply use Reg->getTopoSig().
577     unsigned getTopoSig(const TopoSigId &Id) {
578       return TopoSigs.insert(std::make_pair(Id, TopoSigs.size())).first->second;
579     }
580
581     // Create a native register unit that is associated with one or two root
582     // registers.
583     unsigned newRegUnit(CodeGenRegister *R0, CodeGenRegister *R1 = nullptr) {
584       RegUnits.resize(RegUnits.size() + 1);
585       RegUnits.back().Roots[0] = R0;
586       RegUnits.back().Roots[1] = R1;
587       return RegUnits.size() - 1;
588     }
589
590     // Create a new non-native register unit that can be adopted by a register
591     // to increase its pressure. Note that NumNativeRegUnits is not increased.
592     unsigned newRegUnit(unsigned Weight) {
593       RegUnits.resize(RegUnits.size() + 1);
594       RegUnits.back().Weight = Weight;
595       return RegUnits.size() - 1;
596     }
597
598     // Native units are the singular unit of a leaf register. Register aliasing
599     // is completely characterized by native units. Adopted units exist to give
600     // register additional weight but don't affect aliasing.
601     bool isNativeUnit(unsigned RUID) {
602       return RUID < NumNativeRegUnits;
603     }
604
605     unsigned getNumNativeRegUnits() const {
606       return NumNativeRegUnits;
607     }
608
609     RegUnit &getRegUnit(unsigned RUID) { return RegUnits[RUID]; }
610     const RegUnit &getRegUnit(unsigned RUID) const { return RegUnits[RUID]; }
611
612     ArrayRef<CodeGenRegisterClass*> getRegClasses() const {
613       return RegClasses;
614     }
615
616     // Find a register class from its def.
617     CodeGenRegisterClass *getRegClass(Record*);
618
619     /// getRegisterClassForRegister - Find the register class that contains the
620     /// specified physical register.  If the register is not in a register
621     /// class, return null. If the register is in multiple classes, and the
622     /// classes have a superset-subset relationship and the same set of types,
623     /// return the superclass.  Otherwise return null.
624     const CodeGenRegisterClass* getRegClassForRegister(Record *R);
625
626     // Get the sum of unit weights.
627     unsigned getRegUnitSetWeight(const std::vector<unsigned> &Units) const {
628       unsigned Weight = 0;
629       for (std::vector<unsigned>::const_iterator
630              I = Units.begin(), E = Units.end(); I != E; ++I)
631         Weight += getRegUnit(*I).Weight;
632       return Weight;
633     }
634
635     unsigned getRegSetIDAt(unsigned Order) const {
636       return RegUnitSetOrder[Order];
637     }
638     const RegUnitSet &getRegSetAt(unsigned Order) const {
639       return RegUnitSets[RegUnitSetOrder[Order]];
640     }
641
642     // Increase a RegUnitWeight.
643     void increaseRegUnitWeight(unsigned RUID, unsigned Inc) {
644       getRegUnit(RUID).Weight += Inc;
645     }
646
647     // Get the number of register pressure dimensions.
648     unsigned getNumRegPressureSets() const { return RegUnitSets.size(); }
649
650     // Get a set of register unit IDs for a given dimension of pressure.
651     const RegUnitSet &getRegPressureSet(unsigned Idx) const {
652       return RegUnitSets[Idx];
653     }
654
655     // The number of pressure set lists may be larget than the number of
656     // register classes if some register units appeared in a list of sets that
657     // did not correspond to an existing register class.
658     unsigned getNumRegClassPressureSetLists() const {
659       return RegClassUnitSets.size();
660     }
661
662     // Get a list of pressure set IDs for a register class. Liveness of a
663     // register in this class impacts each pressure set in this list by the
664     // weight of the register. An exact solution requires all registers in a
665     // class to have the same class, but it is not strictly guaranteed.
666     ArrayRef<unsigned> getRCPressureSetIDs(unsigned RCIdx) const {
667       return RegClassUnitSets[RCIdx];
668     }
669
670     // Computed derived records such as missing sub-register indices.
671     void computeDerivedInfo();
672
673     // Compute the set of registers completely covered by the registers in Regs.
674     // The returned BitVector will have a bit set for each register in Regs,
675     // all sub-registers, and all super-registers that are covered by the
676     // registers in Regs.
677     //
678     // This is used to compute the mask of call-preserved registers from a list
679     // of callee-saves.
680     BitVector computeCoveredRegisters(ArrayRef<Record*> Regs);
681
682     // Bit mask of lanes that cover their registers. A sub-register index whose
683     // LaneMask is contained in CoveringLanes will be completely covered by
684     // another sub-register with the same or larger lane mask.
685     unsigned CoveringLanes;
686   };
687 }
688
689 #endif