include/llvm/MC/MCRegisterInfo.h

   1 //=== MC/MCRegisterInfo.h - Target Register Description ---------*- 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 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.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_MC_MCREGISTERINFO_H
  17 #define LLVM_MC_MCREGISTERINFO_H
  18
  19 #include "llvm/ADT/DenseMap.h"
  20 #include "llvm/Support/ErrorHandling.h"
  21 #include <cassert>
  22
  23 namespace llvm {
  24
  25 /// MCRegisterClass - Base class of TargetRegisterClass.
  26 class MCRegisterClass {
  27 public:
  28   typedef const uint16_t* iterator;
  29   typedef const uint16_t* const_iterator;
  30
  31   const char *Name;
  32   const iterator RegsBegin;
  33   const uint8_t *const RegSet;
  34   const uint16_t RegsSize;
  35   const uint16_t RegSetSize;
  36   const uint16_t ID;
  37   const uint16_t RegSize, Alignment; // Size & Alignment of register in bytes
  38   const int8_t CopyCost;
  39   const bool Allocatable;
  40
  41   /// getID() - Return the register class ID number.
  42   ///
  43   unsigned getID() const { return ID; }
  44
  45   /// getName() - Return the register class name for debugging.
  46   ///
  47   const char *getName() const { return Name; }
  48
  49   /// begin/end - Return all of the registers in this class.
  50   ///
  51   iterator       begin() const { return RegsBegin; }
  52   iterator         end() const { return RegsBegin + RegsSize; }
  53
  54   /// getNumRegs - Return the number of registers in this class.
  55   ///
  56   unsigned getNumRegs() const { return RegsSize; }
  57
  58   /// getRegister - Return the specified register in the class.
  59   ///
  60   unsigned getRegister(unsigned i) const {
  61     assert(i < getNumRegs() && "Register number out of range!");
  62     return RegsBegin[i];
  63   }
  64
  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)
  71       return false;
  72     return (RegSet[Byte] & (1 << InByte)) != 0;
  73   }
  74
  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);
  78   }
  79
  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; }
  83
  84   /// getAlignment - Return the minimum required alignment for a register of
  85   /// this class.
  86   unsigned getAlignment() const { return Alignment; }
  87
  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; }
  92
  93   /// isAllocatable - Return true if this register class may be used to create
  94   /// virtual registers.
  95   bool isAllocatable() const { return Allocatable; }
  96 };
  97
  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
 106 /// of AX.
 107 ///
 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
 113 };
 114
 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
 119 /// descriptor.
 120 ///
 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
 125 /// virtual methods.
 126 ///
 127 class MCRegisterInfo {
 128 public:
 129   typedef const MCRegisterClass *regclass_iterator;
 130
 131   /// DwarfLLVMRegPair - Emitted by tablegen so Dwarf<->LLVM reg mappings can be
 132   /// performed with a binary search.
 133   struct DwarfLLVMRegPair {
 134     unsigned FromReg;
 135     unsigned ToReg;
 136
 137     bool operator<(DwarfLLVMRegPair RHS) const { return FromReg < RHS.FromReg; }
 138   };
 139 private:
 140   const MCRegisterDesc *Desc;                 // Pointer to the descriptor array
 141   unsigned NumRegs;                           // Number of entries in the array
 142   unsigned RAReg;                             // Return address register
 143   const MCRegisterClass *Classes;             // Pointer to the regclass array
 144   unsigned NumClasses;                        // Number of entries in the array
 145   const uint16_t *RegLists;                   // Pointer to the reglists array
 146   const uint16_t *SubRegIndices;              // Pointer to the subreg lookup
 147                                               // array.
 148   unsigned NumSubRegIndices;                  // Number of subreg indices.
 149   const uint16_t *RegEncodingTable;           // Pointer to array of register
 150                                               // encodings.
 151
 152   unsigned L2DwarfRegsSize;
 153   unsigned EHL2DwarfRegsSize;
 154   unsigned Dwarf2LRegsSize;
 155   unsigned EHDwarf2LRegsSize;
 156   const DwarfLLVMRegPair *L2DwarfRegs;        // LLVM to Dwarf regs mapping
 157   const DwarfLLVMRegPair *EHL2DwarfRegs;      // LLVM to Dwarf regs mapping EH
 158   const DwarfLLVMRegPair *Dwarf2LRegs;        // Dwarf to LLVM regs mapping
 159   const DwarfLLVMRegPair *EHDwarf2LRegs;      // Dwarf to LLVM regs mapping EH
 160   DenseMap<unsigned, int> L2SEHRegs;          // LLVM to SEH regs mapping
 161
 162 public:
 163   /// InitMCRegisterInfo - Initialize MCRegisterInfo, called by TableGen
 164   /// auto-generated routines. *DO NOT USE*.
 165   void InitMCRegisterInfo(const MCRegisterDesc *D, unsigned NR, unsigned RA,
 166                           const MCRegisterClass *C, unsigned NC,
 167                           const uint16_t *RL,
 168                           const uint16_t *SubIndices,
 169                           unsigned NumIndices,
 170                           const uint16_t *RET) {
 171     Desc = D;
 172     NumRegs = NR;
 173     RAReg = RA;
 174     Classes = C;
 175     RegLists = RL;
 176     NumClasses = NC;
 177     SubRegIndices = SubIndices;
 178     NumSubRegIndices = NumIndices;
 179     RegEncodingTable = RET;
 180   }
 181
 182   /// mapLLVMRegsToDwarfRegs - Used to initialize LLVM register to Dwarf
 183   /// register number mapping. Called by TableGen auto-generated routines.
 184   /// *DO NOT USE*.
 185   void mapLLVMRegsToDwarfRegs(const DwarfLLVMRegPair *Map, unsigned Size,
 186                               bool isEH) {
 187     if (isEH) {
 188       EHL2DwarfRegs = Map;
 189       EHL2DwarfRegsSize = Size;
 190     } else {
 191       L2DwarfRegs = Map;
 192       L2DwarfRegsSize = Size;
 193     }
 194   }
 195
 196   /// mapDwarfRegsToLLVMRegs - Used to initialize Dwarf register to LLVM
 197   /// register number mapping. Called by TableGen auto-generated routines.
 198   /// *DO NOT USE*.
 199   void mapDwarfRegsToLLVMRegs(const DwarfLLVMRegPair *Map, unsigned Size,
 200                               bool isEH) {
 201     if (isEH) {
 202       EHDwarf2LRegs = Map;
 203       EHDwarf2LRegsSize = Size;
 204     } else {
 205       Dwarf2LRegs = Map;
 206       Dwarf2LRegsSize = Size;
 207     }
 208   }
 209
 210   /// mapLLVMRegToSEHReg - Used to initialize LLVM register to SEH register
 211   /// number mapping. By default the SEH register number is just the same
 212   /// as the LLVM register number.
 213   /// FIXME: TableGen these numbers. Currently this requires target specific
 214   /// initialization code.
 215   void mapLLVMRegToSEHReg(unsigned LLVMReg, int SEHReg) {
 216     L2SEHRegs[LLVMReg] = SEHReg;
 217   }
 218
 219   /// getRARegister - This method should return the register where the return
 220   /// address can be found.
 221   unsigned getRARegister() const {
 222     return RAReg;
 223   }
 224
 225   const MCRegisterDesc &operator[](unsigned RegNo) const {
 226     assert(RegNo < NumRegs &&
 227            "Attempting to access record for invalid register number!");
 228     return Desc[RegNo];
 229   }
 230
 231   /// Provide a get method, equivalent to [], but more useful if we have a
 232   /// pointer to this object.
 233   ///
 234   const MCRegisterDesc &get(unsigned RegNo) const {
 235     return operator[](RegNo);
 236   }
 237
 238   /// getAliasSet - Return the set of registers aliased by the specified
 239   /// register, or a null list of there are none.  The list returned is zero
 240   /// terminated.
 241   ///
 242   const uint16_t *getAliasSet(unsigned RegNo) const {
 243     // The Overlaps set always begins with Reg itself.
 244     return RegLists + get(RegNo).Overlaps + 1;
 245   }
 246
 247   /// getOverlaps - Return a list of registers that overlap Reg, including
 248   /// itself. This is the same as the alias set except Reg is included in the
 249   /// list.
 250   /// These are exactly the registers in { x | regsOverlap(x, Reg) }.
 251   ///
 252   const uint16_t *getOverlaps(unsigned RegNo) const {
 253     return RegLists + get(RegNo).Overlaps;
 254   }
 255
 256   /// getSubRegisters - Return the list of registers that are sub-registers of
 257   /// the specified register, or a null list of there are none. The list
 258   /// returned is zero terminated and sorted according to super-sub register
 259   /// relations. e.g. X86::RAX's sub-register list is EAX, AX, AL, AH.
 260   ///
 261   const uint16_t *getSubRegisters(unsigned RegNo) const {
 262     return RegLists + get(RegNo).SubRegs;
 263   }
 264
 265   /// getSubReg - Returns the physical register number of sub-register "Index"
 266   /// for physical register RegNo. Return zero if the sub-register does not
 267   /// exist.
 268   unsigned getSubReg(unsigned Reg, unsigned Idx) const {
 269     return *(SubRegIndices + (Reg - 1) * NumSubRegIndices + Idx - 1);
 270   }
 271
 272   /// getMatchingSuperReg - Return a super-register of the specified register
 273   /// Reg so its sub-register of index SubIdx is Reg.
 274   unsigned getMatchingSuperReg(unsigned Reg, unsigned SubIdx,
 275                                const MCRegisterClass *RC) const {
 276     for (const uint16_t *SRs = getSuperRegisters(Reg); unsigned SR = *SRs;++SRs)
 277       if (Reg == getSubReg(SR, SubIdx) && RC->contains(SR))
 278         return SR;
 279     return 0;
 280   }
 281
 282   /// getSubRegIndex - For a given register pair, return the sub-register index
 283   /// if the second register is a sub-register of the first. Return zero
 284   /// otherwise.
 285   unsigned getSubRegIndex(unsigned RegNo, unsigned SubRegNo) const {
 286     for (unsigned I = 1; I <= NumSubRegIndices; ++I)
 287       if (getSubReg(RegNo, I) == SubRegNo)
 288         return I;
 289     return 0;
 290   }
 291
 292   /// getSuperRegisters - Return the list of registers that are super-registers
 293   /// of the specified register, or a null list of there are none. The list
 294   /// returned is zero terminated and sorted according to super-sub register
 295   /// relations. e.g. X86::AL's super-register list is AX, EAX, RAX.
 296   ///
 297   const uint16_t *getSuperRegisters(unsigned RegNo) const {
 298     return RegLists + get(RegNo).SuperRegs;
 299   }
 300
 301   /// getName - Return the human-readable symbolic target-specific name for the
 302   /// specified physical register.
 303   const char *getName(unsigned RegNo) const {
 304     return get(RegNo).Name;
 305   }
 306
 307   /// getNumRegs - Return the number of registers this target has (useful for
 308   /// sizing arrays holding per register information)
 309   unsigned getNumRegs() const {
 310     return NumRegs;
 311   }
 312
 313   /// getDwarfRegNum - Map a target register to an equivalent dwarf register
 314   /// number.  Returns -1 if there is no equivalent value.  The second
 315   /// parameter allows targets to use different numberings for EH info and
 316   /// debugging info.
 317   int getDwarfRegNum(unsigned RegNum, bool isEH) const {
 318     const DwarfLLVMRegPair *M = isEH ? EHL2DwarfRegs : L2DwarfRegs;
 319     unsigned Size = isEH ? EHL2DwarfRegsSize : L2DwarfRegsSize;
 320
 321     DwarfLLVMRegPair Key = { RegNum, 0 };
 322     const DwarfLLVMRegPair *I = std::lower_bound(M, M+Size, Key);
 323     if (I == M+Size || I->FromReg != RegNum)
 324       return -1;
 325     return I->ToReg;
 326   }
 327
 328   /// getLLVMRegNum - Map a dwarf register back to a target register.
 329   ///
 330   int getLLVMRegNum(unsigned RegNum, bool isEH) const {
 331     const DwarfLLVMRegPair *M = isEH ? EHDwarf2LRegs : Dwarf2LRegs;
 332     unsigned Size = isEH ? EHDwarf2LRegsSize : Dwarf2LRegsSize;
 333
 334     DwarfLLVMRegPair Key = { RegNum, 0 };
 335     const DwarfLLVMRegPair *I = std::lower_bound(M, M+Size, Key);
 336     assert(I != M+Size && I->FromReg == RegNum && "Invalid RegNum");
 337     return I->ToReg;
 338   }
 339
 340   /// getSEHRegNum - Map a target register to an equivalent SEH register
 341   /// number.  Returns LLVM register number if there is no equivalent value.
 342   int getSEHRegNum(unsigned RegNum) const {
 343     const DenseMap<unsigned, int>::const_iterator I = L2SEHRegs.find(RegNum);
 344     if (I == L2SEHRegs.end()) return (int)RegNum;
 345     return I->second;
 346   }
 347
 348   regclass_iterator regclass_begin() const { return Classes; }
 349   regclass_iterator regclass_end() const { return Classes+NumClasses; }
 350
 351   unsigned getNumRegClasses() const {
 352     return (unsigned)(regclass_end()-regclass_begin());
 353   }
 354
 355   /// getRegClass - Returns the register class associated with the enumeration
 356   /// value.  See class MCOperandInfo.
 357   const MCRegisterClass getRegClass(unsigned i) const {
 358     assert(i < getNumRegClasses() && "Register Class ID out of range");
 359     return Classes[i];
 360   }
 361
 362    /// getEncodingValue - Returns the encoding for RegNo
 363   uint16_t getEncodingValue(unsigned RegNo) const {
 364     assert(RegNo < NumRegs &&
 365            "Attempting to get encoding for invalid register number!");
 366     return RegEncodingTable[RegNo];
 367   }
 368
 369 };
 370
 371 } // End llvm namespace
 372
 373 #endif