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 {
38 const unsigned EnumValue;
41 CodeGenSubRegIndex(Record *R, unsigned Enum);
43 const std::string &getName() const;
44 std::string getNamespace() const;
45 std::string getQualifiedName() const;
47 // Order CodeGenSubRegIndex pointers by EnumValue.
49 bool operator()(const CodeGenSubRegIndex *A,
50 const CodeGenSubRegIndex *B) const {
52 return A->EnumValue < B->EnumValue;
56 // Map of composite subreg indices.
57 typedef std::map<CodeGenSubRegIndex*, CodeGenSubRegIndex*, Less> CompMap;
59 // Returns the subreg index that results from composing this with Idx.
60 // Returns NULL if this and Idx don't compose.
61 CodeGenSubRegIndex *compose(CodeGenSubRegIndex *Idx) const {
62 CompMap::const_iterator I = Composed.find(Idx);
63 return I == Composed.end() ? 0 : I->second;
66 // Add a composite subreg index: this+A = B.
67 // Return a conflicting composite, or NULL
68 CodeGenSubRegIndex *addComposite(CodeGenSubRegIndex *A,
69 CodeGenSubRegIndex *B) {
70 std::pair<CompMap::iterator, bool> Ins =
71 Composed.insert(std::make_pair(A, B));
72 return (Ins.second || Ins.first->second == B) ? 0 : Ins.first->second;
75 // Update the composite maps of components specified in 'ComposedOf'.
76 void updateComponents(CodeGenRegBank&);
78 // Clean out redundant composite mappings.
79 void cleanComposites();
81 // Return the map of composites.
82 const CompMap &getComposites() const { return Composed; }
88 /// CodeGenRegister - Represents a register definition.
89 struct CodeGenRegister {
93 bool CoveredBySubRegs;
95 // Map SubRegIndex -> Register.
96 typedef std::map<CodeGenSubRegIndex*, CodeGenRegister*,
97 CodeGenSubRegIndex::Less> SubRegMap;
99 CodeGenRegister(Record *R, unsigned Enum);
101 const std::string &getName() const;
103 // Get a map of sub-registers computed lazily.
104 // This includes unique entries for all sub-sub-registers.
105 const SubRegMap &getSubRegs(CodeGenRegBank&);
107 const SubRegMap &getSubRegs() const {
108 assert(SubRegsComplete && "Must precompute sub-registers");
112 // Add sub-registers to OSet following a pre-order defined by the .td file.
113 void addSubRegsPreOrder(SetVector<CodeGenRegister*> &OSet,
114 CodeGenRegBank&) const;
116 // List of super-registers in topological order, small to large.
117 typedef std::vector<CodeGenRegister*> SuperRegList;
119 // Get the list of super-registers.
120 // This is only valid after computeDerivedInfo has visited all registers.
121 const SuperRegList &getSuperRegs() const {
122 assert(SubRegsComplete && "Must precompute sub-registers");
126 // Order CodeGenRegister pointers by EnumValue.
128 bool operator()(const CodeGenRegister *A,
129 const CodeGenRegister *B) const {
131 return A->EnumValue < B->EnumValue;
135 // Canonically ordered set.
136 typedef std::set<const CodeGenRegister*, Less> Set;
139 bool SubRegsComplete;
141 SuperRegList SuperRegs;
145 class CodeGenRegisterClass {
146 CodeGenRegister::Set Members;
147 // Allocation orders. Order[0] always contains all registers in Members.
148 std::vector<SmallVector<Record*, 16> > Orders;
149 // Bit mask of sub-classes including this, indexed by their EnumValue.
150 BitVector SubClasses;
151 // List of super-classes, topologocally ordered to have the larger classes
152 // first. This is the same as sorting by EnumValue.
153 SmallVector<CodeGenRegisterClass*, 4> SuperClasses;
157 // For a synthesized class, inherit missing properties from the nearest
159 void inheritProperties(CodeGenRegBank&);
161 // Map SubRegIndex -> sub-class. This is the largest sub-class where all
162 // registers have a SubRegIndex sub-register.
163 DenseMap<CodeGenSubRegIndex*, CodeGenRegisterClass*> SubClassWithSubReg;
165 // Map SubRegIndex -> set of super-reg classes. This is all register
166 // classes SuperRC such that:
168 // R:SubRegIndex in this RC for all R in SuperRC.
170 DenseMap<CodeGenSubRegIndex*,
171 SmallPtrSet<CodeGenRegisterClass*, 8> > SuperRegClasses;
174 std::string Namespace;
175 std::vector<MVT::SimpleValueType> VTs;
177 unsigned SpillAlignment;
180 // Map SubRegIndex -> RegisterClass
181 DenseMap<Record*,Record*> SubRegClasses;
182 std::string AltOrderSelect;
184 // Return the Record that defined this class, or NULL if the class was
185 // created by TableGen.
186 Record *getDef() const { return TheDef; }
188 const std::string &getName() const { return Name; }
189 std::string getQualifiedName() const;
190 const std::vector<MVT::SimpleValueType> &getValueTypes() const {return VTs;}
191 unsigned getNumValueTypes() const { return VTs.size(); }
193 MVT::SimpleValueType getValueTypeNum(unsigned VTNum) const {
194 if (VTNum < VTs.size())
196 llvm_unreachable("VTNum greater than number of ValueTypes in RegClass!");
199 // Return true if this this class contains the register.
200 bool contains(const CodeGenRegister*) const;
202 // Returns true if RC is a subclass.
203 // RC is a sub-class of this class if it is a valid replacement for any
204 // instruction operand where a register of this classis required. It must
205 // satisfy these conditions:
207 // 1. All RC registers are also in this.
208 // 2. The RC spill size must not be smaller than our spill size.
209 // 3. RC spill alignment must be compatible with ours.
211 bool hasSubClass(const CodeGenRegisterClass *RC) const {
212 return SubClasses.test(RC->EnumValue);
215 // getSubClassWithSubReg - Returns the largest sub-class where all
216 // registers have a SubIdx sub-register.
217 CodeGenRegisterClass*
218 getSubClassWithSubReg(CodeGenSubRegIndex *SubIdx) const {
219 return SubClassWithSubReg.lookup(SubIdx);
222 void setSubClassWithSubReg(CodeGenSubRegIndex *SubIdx,
223 CodeGenRegisterClass *SubRC) {
224 SubClassWithSubReg[SubIdx] = SubRC;
227 // getSuperRegClasses - Returns a bit vector of all register classes
228 // containing only SubIdx super-registers of this class.
229 void getSuperRegClasses(CodeGenSubRegIndex *SubIdx, BitVector &Out) const;
231 // addSuperRegClass - Add a class containing only SudIdx super-registers.
232 void addSuperRegClass(CodeGenSubRegIndex *SubIdx,
233 CodeGenRegisterClass *SuperRC) {
234 SuperRegClasses[SubIdx].insert(SuperRC);
237 // getSubClasses - Returns a constant BitVector of subclasses indexed by
239 // The SubClasses vector includs an entry for this class.
240 const BitVector &getSubClasses() const { return SubClasses; }
242 // getSuperClasses - Returns a list of super classes ordered by EnumValue.
243 // The array does not include an entry for this class.
244 ArrayRef<CodeGenRegisterClass*> getSuperClasses() const {
248 // Returns an ordered list of class members.
249 // The order of registers is the same as in the .td file.
250 // No = 0 is the default allocation order, No = 1 is the first alternative.
251 ArrayRef<Record*> getOrder(unsigned No = 0) const {
255 // Return the total number of allocation orders available.
256 unsigned getNumOrders() const { return Orders.size(); }
258 // Get the set of registers. This set contains the same registers as
260 const CodeGenRegister::Set &getMembers() const { return Members; }
262 CodeGenRegisterClass(CodeGenRegBank&, Record *R);
264 // A key representing the parts of a register class used for forming
265 // sub-classes. Note the ordering provided by this key is not the same as
266 // the topological order used for the EnumValues.
268 const CodeGenRegister::Set *Members;
270 unsigned SpillAlignment;
273 : Members(O.Members),
274 SpillSize(O.SpillSize),
275 SpillAlignment(O.SpillAlignment) {}
277 Key(const CodeGenRegister::Set *M, unsigned S = 0, unsigned A = 0)
278 : Members(M), SpillSize(S), SpillAlignment(A) {}
280 Key(const CodeGenRegisterClass &RC)
281 : Members(&RC.getMembers()),
282 SpillSize(RC.SpillSize),
283 SpillAlignment(RC.SpillAlignment) {}
285 // Lexicographical order of (Members, SpillSize, SpillAlignment).
286 bool operator<(const Key&) const;
289 // Create a non-user defined register class.
290 CodeGenRegisterClass(StringRef Name, Key Props);
292 // Called by CodeGenRegBank::CodeGenRegBank().
293 static void computeSubClasses(CodeGenRegBank&);
296 // CodeGenRegBank - Represent a target's registers and the relations between
298 class CodeGenRegBank {
299 RecordKeeper &Records;
303 std::vector<CodeGenSubRegIndex*> SubRegIndices;
304 DenseMap<Record*, CodeGenSubRegIndex*> Def2SubRegIdx;
305 unsigned NumNamedIndices;
308 std::vector<CodeGenRegister*> Registers;
309 DenseMap<Record*, CodeGenRegister*> Def2Reg;
312 std::vector<CodeGenRegisterClass*> RegClasses;
313 DenseMap<Record*, CodeGenRegisterClass*> Def2RC;
314 typedef std::map<CodeGenRegisterClass::Key, CodeGenRegisterClass*> RCKeyMap;
317 // Add RC to *2RC maps.
318 void addToMaps(CodeGenRegisterClass*);
320 // Create a synthetic sub-class if it is missing.
321 CodeGenRegisterClass *getOrCreateSubClass(const CodeGenRegisterClass *RC,
322 const CodeGenRegister::Set *Membs,
325 // Infer missing register classes.
326 void computeInferredRegisterClasses();
327 void inferCommonSubClass(CodeGenRegisterClass *RC);
328 void inferSubClassWithSubReg(CodeGenRegisterClass *RC);
329 void inferMatchingSuperRegClass(CodeGenRegisterClass *RC,
330 unsigned FirstSubRegRC = 0);
332 // Populate the Composite map from sub-register relationships.
333 void computeComposites();
336 CodeGenRegBank(RecordKeeper&);
338 SetTheory &getSets() { return Sets; }
340 // Sub-register indices. The first NumNamedIndices are defined by the user
341 // in the .td files. The rest are synthesized such that all sub-registers
342 // have a unique name.
343 ArrayRef<CodeGenSubRegIndex*> getSubRegIndices() { return SubRegIndices; }
344 unsigned getNumNamedIndices() { return NumNamedIndices; }
346 // Find a SubRegIndex form its Record def.
347 CodeGenSubRegIndex *getSubRegIdx(Record*);
349 // Find or create a sub-register index representing the A+B composition.
350 CodeGenSubRegIndex *getCompositeSubRegIndex(CodeGenSubRegIndex *A,
351 CodeGenSubRegIndex *B);
353 const std::vector<CodeGenRegister*> &getRegisters() { return Registers; }
355 // Find a register from its Record def.
356 CodeGenRegister *getReg(Record*);
358 ArrayRef<CodeGenRegisterClass*> getRegClasses() const {
362 // Find a register class from its def.
363 CodeGenRegisterClass *getRegClass(Record*);
365 /// getRegisterClassForRegister - Find the register class that contains the
366 /// specified physical register. If the register is not in a register
367 /// class, return null. If the register is in multiple classes, and the
368 /// classes have a superset-subset relationship and the same set of types,
369 /// return the superclass. Otherwise return null.
370 const CodeGenRegisterClass* getRegClassForRegister(Record *R);
372 // Computed derived records such as missing sub-register indices.
373 void computeDerivedInfo();
375 // Compute full overlap sets for every register. These sets include the
376 // rarely used aliases that are neither sub nor super-registers.
378 // Map[R1].count(R2) is reflexive and symmetric, but not transitive.
380 // If R1 is a sub-register of R2, Map[R1] is a subset of Map[R2].
381 void computeOverlaps(std::map<const CodeGenRegister*,
382 CodeGenRegister::Set> &Map);
384 // Compute the set of registers completely covered by the registers in Regs.
385 // The returned BitVector will have a bit set for each register in Regs,
386 // all sub-registers, and all super-registers that are covered by the
387 // registers in Regs.
389 // This is used to compute the mask of call-preserved registers from a list
391 BitVector computeCoveredRegisters(ArrayRef<Record*> Regs);