1 //=== MC/MCRegisterInfo.h - Target Register Description ---------*- 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 describes an abstract interface used to get information about a
11 // target machines register file. This information is used for a variety of
12 // purposed, especially register allocation.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_MC_MCREGISTERINFO_H
17 #define LLVM_MC_MCREGISTERINFO_H
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/Support/ErrorHandling.h"
25 /// MCRegisterClass - Base class of TargetRegisterClass.
26 class MCRegisterClass {
28 typedef const uint16_t* iterator;
29 typedef const uint16_t* const_iterator;
32 const iterator RegsBegin;
33 const uint8_t *const RegSet;
34 const uint16_t RegsSize;
35 const uint16_t RegSetSize;
37 const uint16_t RegSize, Alignment; // Size & Alignment of register in bytes
38 const int8_t CopyCost;
39 const bool Allocatable;
41 /// getID() - Return the register class ID number.
43 unsigned getID() const { return ID; }
45 /// getName() - Return the register class name for debugging.
47 const char *getName() const { return Name; }
49 /// begin/end - Return all of the registers in this class.
51 iterator begin() const { return RegsBegin; }
52 iterator end() const { return RegsBegin + RegsSize; }
54 /// getNumRegs - Return the number of registers in this class.
56 unsigned getNumRegs() const { return RegsSize; }
58 /// getRegister - Return the specified register in the class.
60 unsigned getRegister(unsigned i) const {
61 assert(i < getNumRegs() && "Register number out of range!");
65 /// contains - Return true if the specified register is included in this
66 /// register class. This does not include virtual registers.
67 bool contains(unsigned Reg) const {
68 unsigned InByte = Reg % 8;
69 unsigned Byte = Reg / 8;
70 if (Byte >= RegSetSize)
72 return (RegSet[Byte] & (1 << InByte)) != 0;
75 /// contains - Return true if both registers are in this class.
76 bool contains(unsigned Reg1, unsigned Reg2) const {
77 return contains(Reg1) && contains(Reg2);
80 /// getSize - Return the size of the register in bytes, which is also the size
81 /// of a stack slot allocated to hold a spilled copy of this register.
82 unsigned getSize() const { return RegSize; }
84 /// getAlignment - Return the minimum required alignment for a register of
86 unsigned getAlignment() const { return Alignment; }
88 /// getCopyCost - Return the cost of copying a value between two registers in
89 /// this class. A negative number means the register class is very expensive
90 /// to copy e.g. status flag register classes.
91 int getCopyCost() const { return CopyCost; }
93 /// isAllocatable - Return true if this register class may be used to create
94 /// virtual registers.
95 bool isAllocatable() const { return Allocatable; }
98 /// MCRegisterDesc - This record contains all of the information known about
99 /// a particular register. The Overlaps field contains a pointer to a zero
100 /// terminated array of registers that this register aliases, starting with
101 /// itself. This is needed for architectures like X86 which have AL alias AX
102 /// alias EAX. The SubRegs field is a zero terminated array of registers that
103 /// are sub-registers of the specific register, e.g. AL, AH are sub-registers of
104 /// AX. The SuperRegs field is a zero terminated array of registers that are
105 /// super-registers of the specific register, e.g. RAX, EAX, are super-registers
108 struct MCRegisterDesc {
109 const char *Name; // Printable name for the reg (for debugging)
110 uint32_t Overlaps; // Overlapping registers, described above
111 uint32_t SubRegs; // Sub-register set, described above
112 uint32_t SuperRegs; // Super-register set, described above
115 /// MCRegisterInfo base class - We assume that the target defines a static
116 /// array of MCRegisterDesc objects that represent all of the machine
117 /// registers that the target has. As such, we simply have to track a pointer
118 /// to this array so that we can turn register number into a register
121 /// Note this class is designed to be a base class of TargetRegisterInfo, which
122 /// is the interface used by codegen. However, specific targets *should never*
123 /// specialize this class. MCRegisterInfo should only contain getters to access
124 /// TableGen generated physical register data. It must not be extended with
127 class MCRegisterInfo {
129 typedef const MCRegisterClass *regclass_iterator;
131 const MCRegisterDesc *Desc; // Pointer to the descriptor array
132 unsigned NumRegs; // Number of entries in the array
133 unsigned RAReg; // Return address register
134 const MCRegisterClass *Classes; // Pointer to the regclass array
135 unsigned NumClasses; // Number of entries in the array
136 const uint16_t *Overlaps; // Pointer to the overlaps array
137 const uint16_t *SubRegs; // Pointer to the subregs array
138 const uint16_t *SuperRegs; // Pointer to the superregs array
139 const uint16_t *SubRegIndices; // Pointer to the subreg lookup
141 unsigned NumSubRegIndices; // Number of subreg indices.
142 DenseMap<unsigned, int> L2DwarfRegs; // LLVM to Dwarf regs mapping
143 DenseMap<unsigned, int> EHL2DwarfRegs; // LLVM to Dwarf regs mapping EH
144 DenseMap<unsigned, unsigned> Dwarf2LRegs; // Dwarf to LLVM regs mapping
145 DenseMap<unsigned, unsigned> EHDwarf2LRegs; // Dwarf to LLVM regs mapping EH
146 DenseMap<unsigned, int> L2SEHRegs; // LLVM to SEH regs mapping
149 /// InitMCRegisterInfo - Initialize MCRegisterInfo, called by TableGen
150 /// auto-generated routines. *DO NOT USE*.
151 void InitMCRegisterInfo(const MCRegisterDesc *D, unsigned NR, unsigned RA,
152 const MCRegisterClass *C, unsigned NC,
153 const uint16_t *O, const uint16_t *Sub,
154 const uint16_t *Super,
155 const uint16_t *SubIndices,
156 unsigned NumIndices) {
165 SubRegIndices = SubIndices;
166 NumSubRegIndices = NumIndices;
169 /// mapLLVMRegToDwarfReg - Used to initialize LLVM register to Dwarf
170 /// register number mapping. Called by TableGen auto-generated routines.
172 void mapLLVMRegToDwarfReg(unsigned LLVMReg, int DwarfReg, bool isEH) {
174 EHL2DwarfRegs[LLVMReg] = DwarfReg;
176 L2DwarfRegs[LLVMReg] = DwarfReg;
179 /// mapDwarfRegToLLVMReg - Used to initialize Dwarf register to LLVM
180 /// register number mapping. Called by TableGen auto-generated routines.
182 void mapDwarfRegToLLVMReg(unsigned DwarfReg, unsigned LLVMReg, bool isEH) {
184 EHDwarf2LRegs[DwarfReg] = LLVMReg;
186 Dwarf2LRegs[DwarfReg] = LLVMReg;
189 /// mapLLVMRegToSEHReg - Used to initialize LLVM register to SEH register
190 /// number mapping. By default the SEH register number is just the same
191 /// as the LLVM register number.
192 /// FIXME: TableGen these numbers. Currently this requires target specific
193 /// initialization code.
194 void mapLLVMRegToSEHReg(unsigned LLVMReg, int SEHReg) {
195 L2SEHRegs[LLVMReg] = SEHReg;
198 /// getRARegister - This method should return the register where the return
199 /// address can be found.
200 unsigned getRARegister() const {
204 const MCRegisterDesc &operator[](unsigned RegNo) const {
205 assert(RegNo < NumRegs &&
206 "Attempting to access record for invalid register number!");
210 /// Provide a get method, equivalent to [], but more useful if we have a
211 /// pointer to this object.
213 const MCRegisterDesc &get(unsigned RegNo) const {
214 return operator[](RegNo);
217 /// getAliasSet - Return the set of registers aliased by the specified
218 /// register, or a null list of there are none. The list returned is zero
221 const uint16_t *getAliasSet(unsigned RegNo) const {
222 // The Overlaps set always begins with Reg itself.
223 return Overlaps + get(RegNo).Overlaps + 1;
226 /// getOverlaps - Return a list of registers that overlap Reg, including
227 /// itself. This is the same as the alias set except Reg is included in the
229 /// These are exactly the registers in { x | regsOverlap(x, Reg) }.
231 const uint16_t *getOverlaps(unsigned RegNo) const {
232 return Overlaps + get(RegNo).Overlaps;
235 /// getSubRegisters - Return the list of registers that are sub-registers of
236 /// the specified register, or a null list of there are none. The list
237 /// returned is zero terminated and sorted according to super-sub register
238 /// relations. e.g. X86::RAX's sub-register list is EAX, AX, AL, AH.
240 const uint16_t *getSubRegisters(unsigned RegNo) const {
241 return SubRegs + get(RegNo).SubRegs;
244 /// getSubReg - Returns the physical register number of sub-register "Index"
245 /// for physical register RegNo. Return zero if the sub-register does not
247 unsigned getSubReg(unsigned Reg, unsigned Idx) const {
248 return *(SubRegIndices + (Reg - 1) * NumSubRegIndices + Idx - 1);
251 /// getMatchingSuperReg - Return a super-register of the specified register
252 /// Reg so its sub-register of index SubIdx is Reg.
253 unsigned getMatchingSuperReg(unsigned Reg, unsigned SubIdx,
254 const MCRegisterClass *RC) const {
255 for (const uint16_t *SRs = getSuperRegisters(Reg); unsigned SR = *SRs;++SRs)
256 if (Reg == getSubReg(SR, SubIdx) && RC->contains(SR))
261 /// getSubRegIndex - For a given register pair, return the sub-register index
262 /// if the second register is a sub-register of the first. Return zero
264 unsigned getSubRegIndex(unsigned RegNo, unsigned SubRegNo) const {
265 for (unsigned I = 1; I <= NumSubRegIndices; ++I)
266 if (getSubReg(RegNo, I) == SubRegNo)
271 /// getSuperRegisters - Return the list of registers that are super-registers
272 /// of the specified register, or a null list of there are none. The list
273 /// returned is zero terminated and sorted according to super-sub register
274 /// relations. e.g. X86::AL's super-register list is AX, EAX, RAX.
276 const uint16_t *getSuperRegisters(unsigned RegNo) const {
277 return SuperRegs + get(RegNo).SuperRegs;
280 /// getName - Return the human-readable symbolic target-specific name for the
281 /// specified physical register.
282 const char *getName(unsigned RegNo) const {
283 return get(RegNo).Name;
286 /// getNumRegs - Return the number of registers this target has (useful for
287 /// sizing arrays holding per register information)
288 unsigned getNumRegs() const {
292 /// getDwarfRegNum - Map a target register to an equivalent dwarf register
293 /// number. Returns -1 if there is no equivalent value. The second
294 /// parameter allows targets to use different numberings for EH info and
296 int getDwarfRegNum(unsigned RegNum, bool isEH) const {
297 const DenseMap<unsigned, int> &M = isEH ? EHL2DwarfRegs : L2DwarfRegs;
298 const DenseMap<unsigned, int>::const_iterator I = M.find(RegNum);
299 if (I == M.end()) return -1;
303 /// getLLVMRegNum - Map a dwarf register back to a target register.
305 int getLLVMRegNum(unsigned RegNum, bool isEH) const {
306 const DenseMap<unsigned, unsigned> &M = isEH ? EHDwarf2LRegs : Dwarf2LRegs;
307 const DenseMap<unsigned, unsigned>::const_iterator I = M.find(RegNum);
309 llvm_unreachable("Invalid RegNum");
314 /// getSEHRegNum - Map a target register to an equivalent SEH register
315 /// number. Returns LLVM register number if there is no equivalent value.
316 int getSEHRegNum(unsigned RegNum) const {
317 const DenseMap<unsigned, int>::const_iterator I = L2SEHRegs.find(RegNum);
318 if (I == L2SEHRegs.end()) return (int)RegNum;
322 regclass_iterator regclass_begin() const { return Classes; }
323 regclass_iterator regclass_end() const { return Classes+NumClasses; }
325 unsigned getNumRegClasses() const {
326 return (unsigned)(regclass_end()-regclass_begin());
329 /// getRegClass - Returns the register class associated with the enumeration
330 /// value. See class MCOperandInfo.
331 const MCRegisterClass getRegClass(unsigned i) const {
332 assert(i < getNumRegClasses() && "Register Class ID out of range");
337 } // End llvm namespace