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 /// An unsigned integer type large enough to represent all physical registers,
  26 /// but not necessarily virtual registers.
  27 typedef uint16_t MCPhysReg;
  28
  29 /// MCRegisterClass - Base class of TargetRegisterClass.
  30 class MCRegisterClass {
  31 public:
  32   typedef const MCPhysReg* iterator;
  33   typedef const MCPhysReg* const_iterator;
  34
  35   const char *Name;
  36   const iterator RegsBegin;
  37   const uint8_t *const RegSet;
  38   const uint16_t RegsSize;
  39   const uint16_t RegSetSize;
  40   const uint16_t ID;
  41   const uint16_t RegSize, Alignment; // Size & Alignment of register in bytes
  42   const int8_t CopyCost;
  43   const bool Allocatable;
  44
  45   /// getID() - Return the register class ID number.
  46   ///
  47   unsigned getID() const { return ID; }
  48
  49   /// getName() - Return the register class name for debugging.
  50   ///
  51   const char *getName() const { return Name; }
  52
  53   /// begin/end - Return all of the registers in this class.
  54   ///
  55   iterator       begin() const { return RegsBegin; }
  56   iterator         end() const { return RegsBegin + RegsSize; }
  57
  58   /// getNumRegs - Return the number of registers in this class.
  59   ///
  60   unsigned getNumRegs() const { return RegsSize; }
  61
  62   /// getRegister - Return the specified register in the class.
  63   ///
  64   unsigned getRegister(unsigned i) const {
  65     assert(i < getNumRegs() && "Register number out of range!");
  66     return RegsBegin[i];
  67   }
  68
  69   /// contains - Return true if the specified register is included in this
  70   /// register class.  This does not include virtual registers.
  71   bool contains(unsigned Reg) const {
  72     unsigned InByte = Reg % 8;
  73     unsigned Byte = Reg / 8;
  74     if (Byte >= RegSetSize)
  75       return false;
  76     return (RegSet[Byte] & (1 << InByte)) != 0;
  77   }
  78
  79   /// contains - Return true if both registers are in this class.
  80   bool contains(unsigned Reg1, unsigned Reg2) const {
  81     return contains(Reg1) && contains(Reg2);
  82   }
  83
  84   /// getSize - Return the size of the register in bytes, which is also the size
  85   /// of a stack slot allocated to hold a spilled copy of this register.
  86   unsigned getSize() const { return RegSize; }
  87
  88   /// getAlignment - Return the minimum required alignment for a register of
  89   /// this class.
  90   unsigned getAlignment() const { return Alignment; }
  91
  92   /// getCopyCost - Return the cost of copying a value between two registers in
  93   /// this class. A negative number means the register class is very expensive
  94   /// to copy e.g. status flag register classes.
  95   int getCopyCost() const { return CopyCost; }
  96
  97   /// isAllocatable - Return true if this register class may be used to create
  98   /// virtual registers.
  99   bool isAllocatable() const { return Allocatable; }
 100 };
 101
 102 /// MCRegisterDesc - This record contains information about a particular
 103 /// register.  The SubRegs field is a zero terminated array of registers that
 104 /// are sub-registers of the specific register, e.g. AL, AH are sub-registers
 105 /// of AX. The SuperRegs field is a zero terminated array of registers that are
 106 /// super-registers of the specific register, e.g. RAX, EAX, are
 107 /// super-registers of AX.
 108 ///
 109 struct MCRegisterDesc {
 110   uint32_t Name;      // Printable name for the reg (for debugging)
 111   uint32_t SubRegs;   // Sub-register set, described above
 112   uint32_t SuperRegs; // Super-register set, described above
 113
 114   // Offset into MCRI::SubRegIndices of a list of sub-register indices for each
 115   // sub-register in SubRegs.
 116   uint32_t SubRegIndices;
 117
 118   // RegUnits - Points to the list of register units. The low 4 bits holds the
 119   // Scale, the high bits hold an offset into DiffLists. See MCRegUnitIterator.
 120   uint32_t RegUnits;
 121 };
 122
 123 /// MCRegisterInfo base class - We assume that the target defines a static
 124 /// array of MCRegisterDesc objects that represent all of the machine
 125 /// registers that the target has.  As such, we simply have to track a pointer
 126 /// to this array so that we can turn register number into a register
 127 /// descriptor.
 128 ///
 129 /// Note this class is designed to be a base class of TargetRegisterInfo, which
 130 /// is the interface used by codegen. However, specific targets *should never*
 131 /// specialize this class. MCRegisterInfo should only contain getters to access
 132 /// TableGen generated physical register data. It must not be extended with
 133 /// virtual methods.
 134 ///
 135 class MCRegisterInfo {
 136 public:
 137   typedef const MCRegisterClass *regclass_iterator;
 138
 139   /// DwarfLLVMRegPair - Emitted by tablegen so Dwarf<->LLVM reg mappings can be
 140   /// performed with a binary search.
 141   struct DwarfLLVMRegPair {
 142     unsigned FromReg;
 143     unsigned ToReg;
 144
 145     bool operator<(DwarfLLVMRegPair RHS) const { return FromReg < RHS.FromReg; }
 146   };
 147 private:
 148   const MCRegisterDesc *Desc;                 // Pointer to the descriptor array
 149   unsigned NumRegs;                           // Number of entries in the array
 150   unsigned RAReg;                             // Return address register
 151   unsigned PCReg;                             // Program counter register
 152   const MCRegisterClass *Classes;             // Pointer to the regclass array
 153   unsigned NumClasses;                        // Number of entries in the array
 154   unsigned NumRegUnits;                       // Number of regunits.
 155   const uint16_t (*RegUnitRoots)[2];          // Pointer to regunit root table.
 156   const MCPhysReg *DiffLists;                 // Pointer to the difflists array
 157   const char *RegStrings;                     // Pointer to the string table.
 158   const uint16_t *SubRegIndices;              // Pointer to the subreg lookup
 159                                               // array.
 160   unsigned NumSubRegIndices;                  // Number of subreg indices.
 161   const uint16_t *RegEncodingTable;           // Pointer to array of register
 162                                               // encodings.
 163
 164   unsigned L2DwarfRegsSize;
 165   unsigned EHL2DwarfRegsSize;
 166   unsigned Dwarf2LRegsSize;
 167   unsigned EHDwarf2LRegsSize;
 168   const DwarfLLVMRegPair *L2DwarfRegs;        // LLVM to Dwarf regs mapping
 169   const DwarfLLVMRegPair *EHL2DwarfRegs;      // LLVM to Dwarf regs mapping EH
 170   const DwarfLLVMRegPair *Dwarf2LRegs;        // Dwarf to LLVM regs mapping
 171   const DwarfLLVMRegPair *EHDwarf2LRegs;      // Dwarf to LLVM regs mapping EH
 172   DenseMap<unsigned, int> L2SEHRegs;          // LLVM to SEH regs mapping
 173
 174 public:
 175   /// DiffListIterator - Base iterator class that can traverse the
 176   /// differentially encoded register and regunit lists in DiffLists.
 177   /// Don't use this class directly, use one of the specialized sub-classes
 178   /// defined below.
 179   class DiffListIterator {
 180     uint16_t Val;
 181     const MCPhysReg *List;
 182
 183   protected:
 184     /// Create an invalid iterator. Call init() to point to something useful.
 185     DiffListIterator() : Val(0), List(0) {}
 186
 187     /// init - Point the iterator to InitVal, decoding subsequent values from
 188     /// DiffList. The iterator will initially point to InitVal, sub-classes are
 189     /// responsible for skipping the seed value if it is not part of the list.
 190     void init(MCPhysReg InitVal, const MCPhysReg *DiffList) {
 191       Val = InitVal;
 192       List = DiffList;
 193     }
 194
 195     /// advance - Move to the next list position, return the applied
 196     /// differential. This function does not detect the end of the list, that
 197     /// is the caller's responsibility (by checking for a 0 return value).
 198     unsigned advance() {
 199       assert(isValid() && "Cannot move off the end of the list.");
 200       MCPhysReg D = *List++;
 201       Val += D;
 202       return D;
 203     }
 204
 205   public:
 206
 207     /// isValid - returns true if this iterator is not yet at the end.
 208     bool isValid() const { return List; }
 209
 210     /// Dereference the iterator to get the value at the current position.
 211     unsigned operator*() const { return Val; }
 212
 213     /// Pre-increment to move to the next position.
 214     void operator++() {
 215       // The end of the list is encoded as a 0 differential.
 216       if (!advance())
 217         List = 0;
 218     }
 219   };
 220
 221   // These iterators are allowed to sub-class DiffListIterator and access
 222   // internal list pointers.
 223   friend class MCSubRegIterator;
 224   friend class MCSuperRegIterator;
 225   friend class MCRegUnitIterator;
 226   friend class MCRegUnitRootIterator;
 227
 228   /// \brief Initialize MCRegisterInfo, called by TableGen
 229   /// auto-generated routines. *DO NOT USE*.
 230   void InitMCRegisterInfo(const MCRegisterDesc *D, unsigned NR, unsigned RA,
 231                           unsigned PC,
 232                           const MCRegisterClass *C, unsigned NC,
 233                           const uint16_t (*RURoots)[2],
 234                           unsigned NRU,
 235                           const MCPhysReg *DL,
 236                           const char *Strings,
 237                           const uint16_t *SubIndices,
 238                           unsigned NumIndices,
 239                           const uint16_t *RET) {
 240     Desc = D;
 241     NumRegs = NR;
 242     RAReg = RA;
 243     PCReg = PC;
 244     Classes = C;
 245     DiffLists = DL;
 246     RegStrings = Strings;
 247     NumClasses = NC;
 248     RegUnitRoots = RURoots;
 249     NumRegUnits = NRU;
 250     SubRegIndices = SubIndices;
 251     NumSubRegIndices = NumIndices;
 252     RegEncodingTable = RET;
 253   }
 254
 255   /// \brief Used to initialize LLVM register to Dwarf
 256   /// register number mapping. Called by TableGen auto-generated routines.
 257   /// *DO NOT USE*.
 258   void mapLLVMRegsToDwarfRegs(const DwarfLLVMRegPair *Map, unsigned Size,
 259                               bool isEH) {
 260     if (isEH) {
 261       EHL2DwarfRegs = Map;
 262       EHL2DwarfRegsSize = Size;
 263     } else {
 264       L2DwarfRegs = Map;
 265       L2DwarfRegsSize = Size;
 266     }
 267   }
 268
 269   /// \brief Used to initialize Dwarf register to LLVM
 270   /// register number mapping. Called by TableGen auto-generated routines.
 271   /// *DO NOT USE*.
 272   void mapDwarfRegsToLLVMRegs(const DwarfLLVMRegPair *Map, unsigned Size,
 273                               bool isEH) {
 274     if (isEH) {
 275       EHDwarf2LRegs = Map;
 276       EHDwarf2LRegsSize = Size;
 277     } else {
 278       Dwarf2LRegs = Map;
 279       Dwarf2LRegsSize = Size;
 280     }
 281   }
 282
 283   /// mapLLVMRegToSEHReg - Used to initialize LLVM register to SEH register
 284   /// number mapping. By default the SEH register number is just the same
 285   /// as the LLVM register number.
 286   /// FIXME: TableGen these numbers. Currently this requires target specific
 287   /// initialization code.
 288   void mapLLVMRegToSEHReg(unsigned LLVMReg, int SEHReg) {
 289     L2SEHRegs[LLVMReg] = SEHReg;
 290   }
 291
 292   /// \brief This method should return the register where the return
 293   /// address can be found.
 294   unsigned getRARegister() const {
 295     return RAReg;
 296   }
 297
 298   /// Return the register which is the program counter.
 299   unsigned getProgramCounter() const {
 300     return PCReg;
 301   }
 302
 303   const MCRegisterDesc &operator[](unsigned RegNo) const {
 304     assert(RegNo < NumRegs &&
 305            "Attempting to access record for invalid register number!");
 306     return Desc[RegNo];
 307   }
 308
 309   /// \brief Provide a get method, equivalent to [], but more useful with a
 310   /// pointer to this object.
 311   const MCRegisterDesc &get(unsigned RegNo) const {
 312     return operator[](RegNo);
 313   }
 314
 315   /// \brief Returns the physical register number of sub-register "Index"
 316   /// for physical register RegNo. Return zero if the sub-register does not
 317   /// exist.
 318   unsigned getSubReg(unsigned Reg, unsigned Idx) const;
 319
 320   /// \brief Return a super-register of the specified register
 321   /// Reg so its sub-register of index SubIdx is Reg.
 322   unsigned getMatchingSuperReg(unsigned Reg, unsigned SubIdx,
 323                                const MCRegisterClass *RC) const;
 324
 325   /// \brief For a given register pair, return the sub-register index
 326   /// if the second register is a sub-register of the first. Return zero
 327   /// otherwise.
 328   unsigned getSubRegIndex(unsigned RegNo, unsigned SubRegNo) const;
 329
 330   /// \brief Return the human-readable symbolic target-specific name for the
 331   /// specified physical register.
 332   const char *getName(unsigned RegNo) const {
 333     return RegStrings + get(RegNo).Name;
 334   }
 335
 336   /// \brief Return the number of registers this target has (useful for
 337   /// sizing arrays holding per register information)
 338   unsigned getNumRegs() const {
 339     return NumRegs;
 340   }
 341
 342   /// \brief Return the number of sub-register indices
 343   /// understood by the target. Index 0 is reserved for the no-op sub-register,
 344   /// while 1 to getNumSubRegIndices() - 1 represent real sub-registers.
 345   unsigned getNumSubRegIndices() const {
 346     return NumSubRegIndices;
 347   }
 348
 349   /// \brief Return the number of (native) register units in the
 350   /// target. Register units are numbered from 0 to getNumRegUnits() - 1. They
 351   /// can be accessed through MCRegUnitIterator defined below.
 352   unsigned getNumRegUnits() const {
 353     return NumRegUnits;
 354   }
 355
 356   /// \brief Map a target register to an equivalent dwarf register
 357   /// number.  Returns -1 if there is no equivalent value.  The second
 358   /// parameter allows targets to use different numberings for EH info and
 359   /// debugging info.
 360   int getDwarfRegNum(unsigned RegNum, bool isEH) const;
 361
 362   /// \brief Map a dwarf register back to a target register.
 363   int getLLVMRegNum(unsigned RegNum, bool isEH) const;
 364
 365   /// \brief Map a target register to an equivalent SEH register
 366   /// number.  Returns LLVM register number if there is no equivalent value.
 367   int getSEHRegNum(unsigned RegNum) const;
 368
 369   regclass_iterator regclass_begin() const { return Classes; }
 370   regclass_iterator regclass_end() const { return Classes+NumClasses; }
 371
 372   unsigned getNumRegClasses() const {
 373     return (unsigned)(regclass_end()-regclass_begin());
 374   }
 375
 376   /// \brief Returns the register class associated with the enumeration
 377   /// value.  See class MCOperandInfo.
 378   const MCRegisterClass& getRegClass(unsigned i) const {
 379     assert(i < getNumRegClasses() && "Register Class ID out of range");
 380     return Classes[i];
 381   }
 382
 383    /// \brief Returns the encoding for RegNo
 384   uint16_t getEncodingValue(unsigned RegNo) const {
 385     assert(RegNo < NumRegs &&
 386            "Attempting to get encoding for invalid register number!");
 387     return RegEncodingTable[RegNo];
 388   }
 389
 390   /// \brief Returns true if RegB is a sub-register of RegA.
 391   bool isSubRegister(unsigned RegA, unsigned RegB) const {
 392     return isSuperRegister(RegB, RegA);
 393   }
 394
 395   /// \brief Returns true if RegB is a super-register of RegA.
 396   bool isSuperRegister(unsigned RegA, unsigned RegB) const;
 397
 398   /// \brief Returns true if RegB is a sub-register of RegA or if RegB == RegA.
 399   bool isSubRegisterEq(unsigned RegA, unsigned RegB) const {
 400     return isSuperRegisterEq(RegB, RegA);
 401   }
 402
 403   /// \brief Returns true if RegB is a super-register of RegA or if
 404   /// RegB == RegA.
 405   bool isSuperRegisterEq(unsigned RegA, unsigned RegB) const {
 406     return RegA == RegB || isSuperRegister(RegA, RegB);
 407   }
 408
 409 };
 410
 411 //===----------------------------------------------------------------------===//
 412 //                          Register List Iterators
 413 //===----------------------------------------------------------------------===//
 414
 415 // MCRegisterInfo provides lists of super-registers, sub-registers, and
 416 // aliasing registers. Use these iterator classes to traverse the lists.
 417
 418 /// MCSubRegIterator enumerates all sub-registers of Reg.
 419 /// If IncludeSelf is set, Reg itself is included in the list.
 420 class MCSubRegIterator : public MCRegisterInfo::DiffListIterator {
 421 public:
 422   MCSubRegIterator(unsigned Reg, const MCRegisterInfo *MCRI,
 423                      bool IncludeSelf = false) {
 424     init(Reg, MCRI->DiffLists + MCRI->get(Reg).SubRegs);
 425     // Initially, the iterator points to Reg itself.
 426     if (!IncludeSelf)
 427       ++*this;
 428   }
 429 };
 430
 431 /// MCSuperRegIterator enumerates all super-registers of Reg.
 432 /// If IncludeSelf is set, Reg itself is included in the list.
 433 class MCSuperRegIterator : public MCRegisterInfo::DiffListIterator {
 434 public:
 435   MCSuperRegIterator() {}
 436   MCSuperRegIterator(unsigned Reg, const MCRegisterInfo *MCRI,
 437                      bool IncludeSelf = false) {
 438     init(Reg, MCRI->DiffLists + MCRI->get(Reg).SuperRegs);
 439     // Initially, the iterator points to Reg itself.
 440     if (!IncludeSelf)
 441       ++*this;
 442   }
 443 };
 444
 445 // Definition for isSuperRegister. Put it down here since it needs the
 446 // iterator defined above in addition to the MCRegisterInfo class itself.
 447 inline bool MCRegisterInfo::isSuperRegister(unsigned RegA, unsigned RegB) const{
 448   for (MCSuperRegIterator I(RegA, this); I.isValid(); ++I)
 449     if (*I == RegB)
 450       return true;
 451   return false;
 452 }
 453
 454 //===----------------------------------------------------------------------===//
 455 //                               Register Units
 456 //===----------------------------------------------------------------------===//
 457
 458 // Register units are used to compute register aliasing. Every register has at
 459 // least one register unit, but it can have more. Two registers overlap if and
 460 // only if they have a common register unit.
 461 //
 462 // A target with a complicated sub-register structure will typically have many
 463 // fewer register units than actual registers. MCRI::getNumRegUnits() returns
 464 // the number of register units in the target.
 465
 466 // MCRegUnitIterator enumerates a list of register units for Reg. The list is
 467 // in ascending numerical order.
 468 class MCRegUnitIterator : public MCRegisterInfo::DiffListIterator {
 469 public:
 470   /// MCRegUnitIterator - Create an iterator that traverses the register units
 471   /// in Reg.
 472   MCRegUnitIterator() {}
 473   MCRegUnitIterator(unsigned Reg, const MCRegisterInfo *MCRI) {
 474     assert(Reg && "Null register has no regunits");
 475     // Decode the RegUnits MCRegisterDesc field.
 476     unsigned RU = MCRI->get(Reg).RegUnits;
 477     unsigned Scale = RU & 15;
 478     unsigned Offset = RU >> 4;
 479
 480     // Initialize the iterator to Reg * Scale, and the List pointer to
 481     // DiffLists + Offset.
 482     init(Reg * Scale, MCRI->DiffLists + Offset);
 483
 484     // That may not be a valid unit, we need to advance by one to get the real
 485     // unit number. The first differential can be 0 which would normally
 486     // terminate the list, but since we know every register has at least one
 487     // unit, we can allow a 0 differential here.
 488     advance();
 489   }
 490 };
 491
 492 // Each register unit has one or two root registers. The complete set of
 493 // registers containing a register unit is the union of the roots and their
 494 // super-registers. All registers aliasing Unit can be visited like this:
 495 //
 496 //   for (MCRegUnitRootIterator RI(Unit, MCRI); RI.isValid(); ++RI) {
 497 //     for (MCSuperRegIterator SI(*RI, MCRI, true); SI.isValid(); ++SI)
 498 //       visit(*SI);
 499 //    }
 500
 501 /// MCRegUnitRootIterator enumerates the root registers of a register unit.
 502 class MCRegUnitRootIterator {
 503   uint16_t Reg0;
 504   uint16_t Reg1;
 505 public:
 506   MCRegUnitRootIterator() : Reg0(0), Reg1(0) {}
 507   MCRegUnitRootIterator(unsigned RegUnit, const MCRegisterInfo *MCRI) {
 508     assert(RegUnit < MCRI->getNumRegUnits() && "Invalid register unit");
 509     Reg0 = MCRI->RegUnitRoots[RegUnit][0];
 510     Reg1 = MCRI->RegUnitRoots[RegUnit][1];
 511   }
 512
 513   /// \brief Dereference to get the current root register.
 514   unsigned operator*() const {
 515     return Reg0;
 516   }
 517
 518   /// \brief Check if the iterator is at the end of the list.
 519   bool isValid() const {
 520     return Reg0;
 521   }
 522
 523   /// \brief Preincrement to move to the next root register.
 524   void operator++() {
 525     assert(isValid() && "Cannot move off the end of the list.");
 526     Reg0 = Reg1;
 527     Reg1 = 0;
 528   }
 529 };
 530
 531 /// MCRegAliasIterator enumerates all registers aliasing Reg.  If IncludeSelf is
 532 /// set, Reg itself is included in the list.  This iterator does not guarantee
 533 /// any ordering or that entries are unique.
 534 class MCRegAliasIterator {
 535 private:
 536   unsigned Reg;
 537   const MCRegisterInfo *MCRI;
 538   bool IncludeSelf;
 539
 540   MCRegUnitIterator RI;
 541   MCRegUnitRootIterator RRI;
 542   MCSuperRegIterator SI;
 543 public:
 544   MCRegAliasIterator(unsigned Reg, const MCRegisterInfo *MCRI,
 545                      bool IncludeSelf)
 546     : Reg(Reg), MCRI(MCRI), IncludeSelf(IncludeSelf) {
 547
 548     // Initialize the iterators.
 549     for (RI = MCRegUnitIterator(Reg, MCRI); RI.isValid(); ++RI) {
 550       for (RRI = MCRegUnitRootIterator(*RI, MCRI); RRI.isValid(); ++RRI) {
 551         for (SI = MCSuperRegIterator(*RRI, MCRI, true); SI.isValid(); ++SI) {
 552           if (!(!IncludeSelf && Reg == *SI))
 553             return;
 554         }
 555       }
 556     }
 557   }
 558
 559   bool isValid() const {
 560     return RI.isValid();
 561   }
 562
 563   unsigned operator*() const {
 564     assert (SI.isValid() && "Cannot dereference an invalid iterator.");
 565     return *SI;
 566   }
 567
 568   void advance() {
 569     // Assuming SI is valid.
 570     ++SI;
 571     if (SI.isValid()) return;
 572
 573     ++RRI;
 574     if (RRI.isValid()) {
 575       SI = MCSuperRegIterator(*RRI, MCRI, true);
 576       return;
 577     }
 578
 579     ++RI;
 580     if (RI.isValid()) {
 581       RRI = MCRegUnitRootIterator(*RI, MCRI);
 582       SI = MCSuperRegIterator(*RRI, MCRI, true);
 583     }
 584   }
 585
 586   void operator++() {
 587     assert(isValid() && "Cannot move off the end of the list.");
 588     do advance();
 589     while (!IncludeSelf && isValid() && *SI == Reg);
 590   }
 591 };
 592
 593 } // End llvm namespace
 594
 595 #endif