include/llvm/Target/MRegisterInfo.h

   1 //===- Target/MRegisterInfo.h - Target Register Information -----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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_TARGET_MREGISTERINFO_H
  17 #define LLVM_TARGET_MREGISTERINFO_H
  18
  19 #include "llvm/CodeGen/MachineBasicBlock.h"
  20 #include "llvm/CodeGen/ValueTypes.h"
  21 #include <cassert>
  22 #include <functional>
  23
  24 namespace llvm {
  25
  26 class BitVector;
  27 class CalleeSavedInfo;
  28 class MachineFunction;
  29 class MachineInstr;
  30 class MachineLocation;
  31 class MachineMove;
  32 class RegScavenger;
  33 class TargetRegisterClass;
  34 class Type;
  35
  36 /// TargetRegisterDesc - This record contains all of the information known about
  37 /// a particular register.  The AliasSet field (if not null) contains a pointer
  38 /// to a Zero terminated array of registers that this register aliases.  This is
  39 /// needed for architectures like X86 which have AL alias AX alias EAX.
  40 /// Registers that this does not apply to simply should set this to null.
  41 /// The SubRegs field is a zero terminated array of registers that are
  42 /// sub-registers of the specific register, e.g. AL, AH are sub-registers of AX.
  43 /// The SuperRegs field is a zero terminated array of registers that are
  44 /// super-registers of the specific register, e.g. RAX, EAX, are sub-registers
  45 /// of AX.
  46 ///
  47 struct TargetRegisterDesc {
  48   const char     *Name;         // Assembly language name for the register
  49   const unsigned *AliasSet;     // Register Alias Set, described above
  50   const unsigned *SubRegs;      // Sub-register set, described above
  51   const unsigned *SuperRegs;    // Super-register set, described above
  52 };
  53
  54 class TargetRegisterClass {
  55 public:
  56   typedef const unsigned* iterator;
  57   typedef const unsigned* const_iterator;
  58
  59   typedef const MVT::ValueType* vt_iterator;
  60   typedef const TargetRegisterClass* const * sc_iterator;
  61 private:
  62   unsigned ID;
  63   bool  isSubClass;
  64   const vt_iterator VTs;
  65   const sc_iterator SubClasses;
  66   const sc_iterator SuperClasses;
  67   const unsigned RegSize, Alignment;    // Size & Alignment of register in bytes
  68   const iterator RegsBegin, RegsEnd;
  69 public:
  70   TargetRegisterClass(unsigned id,
  71                       const MVT::ValueType *vts,
  72                       const TargetRegisterClass * const *subcs,
  73                       const TargetRegisterClass * const *supcs,
  74                       unsigned RS, unsigned Al, iterator RB, iterator RE)
  75     : ID(id), VTs(vts), SubClasses(subcs), SuperClasses(supcs),
  76     RegSize(RS), Alignment(Al), RegsBegin(RB), RegsEnd(RE) {}
  77   virtual ~TargetRegisterClass() {}     // Allow subclasses
  78
  79   /// getID() - Return the register class ID number.
  80   ///
  81   unsigned getID() const { return ID; }
  82
  83   /// begin/end - Return all of the registers in this class.
  84   ///
  85   iterator       begin() const { return RegsBegin; }
  86   iterator         end() const { return RegsEnd; }
  87
  88   /// getNumRegs - Return the number of registers in this class.
  89   ///
  90   unsigned getNumRegs() const { return RegsEnd-RegsBegin; }
  91
  92   /// getRegister - Return the specified register in the class.
  93   ///
  94   unsigned getRegister(unsigned i) const {
  95     assert(i < getNumRegs() && "Register number out of range!");
  96     return RegsBegin[i];
  97   }
  98
  99   /// contains - Return true if the specified register is included in this
 100   /// register class.
 101   bool contains(unsigned Reg) const {
 102     for (iterator I = begin(), E = end(); I != E; ++I)
 103       if (*I == Reg) return true;
 104     return false;
 105   }
 106
 107   /// hasType - return true if this TargetRegisterClass has the ValueType vt.
 108   ///
 109   bool hasType(MVT::ValueType vt) const {
 110     for(int i = 0; VTs[i] != MVT::Other; ++i)
 111       if (VTs[i] == vt)
 112         return true;
 113     return false;
 114   }
 115
 116   /// vt_begin / vt_end - Loop over all of the value types that can be
 117   /// represented by values in this register class.
 118   vt_iterator vt_begin() const {
 119     return VTs;
 120   }
 121
 122   vt_iterator vt_end() const {
 123     vt_iterator I = VTs;
 124     while (*I != MVT::Other) ++I;
 125     return I;
 126   }
 127
 128   /// hasSubRegClass - return true if the specified TargetRegisterClass is a
 129   /// sub-register class of this TargetRegisterClass.
 130   bool hasSubRegClass(const TargetRegisterClass *cs) const {
 131     for (int i = 0; SubClasses[i] != NULL; ++i)
 132       if (SubClasses[i] == cs)
 133         return true;
 134     return false;
 135   }
 136
 137   /// subclasses_begin / subclasses_end - Loop over all of the sub-classes of
 138   /// this register class.
 139   sc_iterator subclasses_begin() const {
 140     return SubClasses;
 141   }
 142
 143   sc_iterator subclasses_end() const {
 144     sc_iterator I = SubClasses;
 145     while (*I != NULL) ++I;
 146     return I;
 147   }
 148
 149   /// hasSuperRegClass - return true if the specified TargetRegisterClass is a
 150   /// super-register class of this TargetRegisterClass.
 151   bool hasSuperRegClass(const TargetRegisterClass *cs) const {
 152     for (int i = 0; SuperClasses[i] != NULL; ++i)
 153       if (SuperClasses[i] == cs)
 154         return true;
 155     return false;
 156   }
 157
 158   /// superclasses_begin / superclasses_end - Loop over all of the super-classes
 159   /// of this register class.
 160   sc_iterator superclasses_begin() const {
 161     return SuperClasses;
 162   }
 163
 164   sc_iterator superclasses_end() const {
 165     sc_iterator I = SuperClasses;
 166     while (*I != NULL) ++I;
 167     return I;
 168   }
 169
 170   /// allocation_order_begin/end - These methods define a range of registers
 171   /// which specify the registers in this class that are valid to register
 172   /// allocate, and the preferred order to allocate them in.  For example,
 173   /// callee saved registers should be at the end of the list, because it is
 174   /// cheaper to allocate caller saved registers.
 175   ///
 176   /// These methods take a MachineFunction argument, which can be used to tune
 177   /// the allocatable registers based on the characteristics of the function.
 178   /// One simple example is that the frame pointer register can be used if
 179   /// frame-pointer-elimination is performed.
 180   ///
 181   /// By default, these methods return all registers in the class.
 182   ///
 183   virtual iterator allocation_order_begin(const MachineFunction &MF) const {
 184     return begin();
 185   }
 186   virtual iterator allocation_order_end(const MachineFunction &MF)   const {
 187     return end();
 188   }
 189
 190
 191
 192   /// getSize - Return the size of the register in bytes, which is also the size
 193   /// of a stack slot allocated to hold a spilled copy of this register.
 194   unsigned getSize() const { return RegSize; }
 195
 196   /// getAlignment - Return the minimum required alignment for a register of
 197   /// this class.
 198   unsigned getAlignment() const { return Alignment; }
 199 };
 200
 201
 202 /// MRegisterInfo base class - We assume that the target defines a static array
 203 /// of TargetRegisterDesc objects that represent all of the machine registers
 204 /// that the target has.  As such, we simply have to track a pointer to this
 205 /// array so that we can turn register number into a register descriptor.
 206 ///
 207 class MRegisterInfo {
 208 public:
 209   typedef const TargetRegisterClass * const * regclass_iterator;
 210 private:
 211   const TargetRegisterDesc *Desc;             // Pointer to the descriptor array
 212   unsigned NumRegs;                           // Number of entries in the array
 213
 214   regclass_iterator RegClassBegin, RegClassEnd;   // List of regclasses
 215
 216   int CallFrameSetupOpcode, CallFrameDestroyOpcode;
 217 protected:
 218   MRegisterInfo(const TargetRegisterDesc *D, unsigned NR,
 219                 regclass_iterator RegClassBegin, regclass_iterator RegClassEnd,
 220                 int CallFrameSetupOpcode = -1, int CallFrameDestroyOpcode = -1);
 221   virtual ~MRegisterInfo();
 222 public:
 223
 224   enum {                        // Define some target independent constants
 225     /// NoRegister - This physical register is not a real target register.  It
 226     /// is useful as a sentinal.
 227     NoRegister = 0,
 228
 229     /// FirstVirtualRegister - This is the first register number that is
 230     /// considered to be a 'virtual' register, which is part of the SSA
 231     /// namespace.  This must be the same for all targets, which means that each
 232     /// target is limited to 1024 registers.
 233     FirstVirtualRegister = 1024
 234   };
 235
 236   /// isPhysicalRegister - Return true if the specified register number is in
 237   /// the physical register namespace.
 238   static bool isPhysicalRegister(unsigned Reg) {
 239     assert(Reg && "this is not a register!");
 240     return Reg < FirstVirtualRegister;
 241   }
 242
 243   /// isVirtualRegister - Return true if the specified register number is in
 244   /// the virtual register namespace.
 245   static bool isVirtualRegister(unsigned Reg) {
 246     assert(Reg && "this is not a register!");
 247     return Reg >= FirstVirtualRegister;
 248   }
 249
 250   /// getAllocatableSet - Returns a bitset indexed by register number
 251   /// indicating if a register is allocatable or not. If a register class is
 252   /// specified, returns the subset for the class.
 253   BitVector getAllocatableSet(MachineFunction &MF,
 254                               const TargetRegisterClass *RC = NULL) const;
 255
 256   const TargetRegisterDesc &operator[](unsigned RegNo) const {
 257     assert(RegNo < NumRegs &&
 258            "Attempting to access record for invalid register number!");
 259     return Desc[RegNo];
 260   }
 261
 262   /// Provide a get method, equivalent to [], but more useful if we have a
 263   /// pointer to this object.
 264   ///
 265   const TargetRegisterDesc &get(unsigned RegNo) const {
 266     return operator[](RegNo);
 267   }
 268
 269   /// getAliasSet - Return the set of registers aliased by the specified
 270   /// register, or a null list of there are none.  The list returned is zero
 271   /// terminated.
 272   ///
 273   const unsigned *getAliasSet(unsigned RegNo) const {
 274     return get(RegNo).AliasSet;
 275   }
 276
 277   /// getSubRegisters - Return the set of registers that are sub-registers of
 278   /// the specified register, or a null list of there are none. The list
 279   /// returned is zero terminated.
 280   ///
 281   const unsigned *getSubRegisters(unsigned RegNo) const {
 282     return get(RegNo).SubRegs;
 283   }
 284
 285   /// getSuperRegisters - Return the set of registers that are super-registers
 286   /// of the specified register, or a null list of there are none. The list
 287   /// returned is zero terminated.
 288   ///
 289   const unsigned *getSuperRegisters(unsigned RegNo) const {
 290     return get(RegNo).SuperRegs;
 291   }
 292
 293   /// getName - Return the symbolic target specific name for the specified
 294   /// physical register.
 295   const char *getName(unsigned RegNo) const {
 296     return get(RegNo).Name;
 297   }
 298
 299   /// getNumRegs - Return the number of registers this target has
 300   /// (useful for sizing arrays holding per register information)
 301   unsigned getNumRegs() const {
 302     return NumRegs;
 303   }
 304
 305   /// areAliases - Returns true if the two registers alias each other,
 306   /// false otherwise
 307   bool areAliases(unsigned regA, unsigned regB) const {
 308     for (const unsigned *Alias = getAliasSet(regA); *Alias; ++Alias)
 309       if (*Alias == regB) return true;
 310     return false;
 311   }
 312
 313   /// regsOverlap - Returns true if the two registers are equal or alias
 314   /// each other. The registers may be virtual register.
 315   bool regsOverlap(unsigned regA, unsigned regB) const {
 316     if (regA == regB)
 317       return true;
 318
 319     if (isVirtualRegister(regA) || isVirtualRegister(regB))
 320       return false;
 321     return areAliases(regA, regB);
 322   }
 323
 324   /// isSubRegister - Returns true if regB is a sub-register of regA.
 325   ///
 326   bool isSubRegister(unsigned regA, unsigned regB) const {
 327     for (const unsigned *SR = getSubRegisters(regA); *SR; ++SR)
 328       if (*SR == regB) return true;
 329     return false;
 330   }
 331
 332   /// isSuperRegister - Returns true if regB is a super-register of regA.
 333   ///
 334   bool isSuperRegister(unsigned regA, unsigned regB) const {
 335     for (const unsigned *SR = getSuperRegisters(regA); *SR; ++SR)
 336       if (*SR == regB) return true;
 337     return false;
 338   }
 339
 340   /// getCalleeSavedRegs - Return a null-terminated list of all of the
 341   /// callee saved registers on this target. The register should be in the
 342   /// order of desired callee-save stack frame offset. The first register is
 343   /// closed to the incoming stack pointer if stack grows down, and vice versa.
 344   virtual const unsigned* getCalleeSavedRegs() const = 0;
 345
 346   /// getCalleeSavedRegClasses - Return a null-terminated list of the preferred
 347   /// register classes to spill each callee saved register with.  The order and
 348   /// length of this list match the getCalleeSaveRegs() list.
 349   virtual const TargetRegisterClass* const *getCalleeSavedRegClasses() const =0;
 350
 351   /// getReservedRegs - Returns a bitset indexed by physical register number
 352   /// indicating if a register is a special register that has particular uses and
 353   /// should be considered unavailable at all times, e.g. SP, RA. This is used by
 354   /// register scavenger to determine what registers are free.
 355   virtual BitVector getReservedRegs(const MachineFunction &MF) const = 0;
 356
 357   //===--------------------------------------------------------------------===//
 358   // Register Class Information
 359   //
 360
 361   /// Register class iterators
 362   ///
 363   regclass_iterator regclass_begin() const { return RegClassBegin; }
 364   regclass_iterator regclass_end() const { return RegClassEnd; }
 365
 366   unsigned getNumRegClasses() const {
 367     return regclass_end()-regclass_begin();
 368   }
 369
 370   /// getRegClass - Returns the register class associated with the enumeration
 371   /// value.  See class TargetOperandInfo.
 372   const TargetRegisterClass *getRegClass(unsigned i) const {
 373     assert(i <= getNumRegClasses() && "Register Class ID out of range");
 374     return i ? RegClassBegin[i - 1] : NULL;
 375   }
 376
 377   //===--------------------------------------------------------------------===//
 378   // Interfaces used by the register allocator and stack frame
 379   // manipulation passes to move data around between registers,
 380   // immediates and memory.  FIXME: Move these to TargetInstrInfo.h.
 381   //
 382
 383   /// spillCalleeSavedRegisters - Issues instruction(s) to spill all callee saved
 384   /// registers and returns true if it isn't possible / profitable to do so by
 385   /// issuing a series of store instructions via storeRegToStackSlot(). Returns
 386   /// false otherwise.
 387   virtual bool spillCalleeSavedRegisters(MachineBasicBlock &MBB,
 388                                          MachineBasicBlock::iterator MI,
 389                                 const std::vector<CalleeSavedInfo> &CSI) const {
 390     return false;
 391   }
 392
 393   /// restoreCalleeSavedRegisters - Issues instruction(s) to restore all callee
 394   /// saved registers and returns true if it isn't possible / profitable to do
 395   /// so by issuing a series of load instructions via loadRegToStackSlot().
 396   /// Returns false otherwise.
 397   virtual bool restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
 398                                            MachineBasicBlock::iterator MI,
 399                                 const std::vector<CalleeSavedInfo> &CSI) const {
 400     return false;
 401   }
 402
 403   virtual void storeRegToStackSlot(MachineBasicBlock &MBB,
 404                                    MachineBasicBlock::iterator MI,
 405                                    unsigned SrcReg, int FrameIndex,
 406                                    const TargetRegisterClass *RC) const = 0;
 407
 408   virtual void loadRegFromStackSlot(MachineBasicBlock &MBB,
 409                                     MachineBasicBlock::iterator MI,
 410                                     unsigned DestReg, int FrameIndex,
 411                                     const TargetRegisterClass *RC) const = 0;
 412
 413   virtual void copyRegToReg(MachineBasicBlock &MBB,
 414                             MachineBasicBlock::iterator MI,
 415                             unsigned DestReg, unsigned SrcReg,
 416                             const TargetRegisterClass *RC) const = 0;
 417
 418   /// reMaterialize - Re-issue the specified 'original' instruction at the
 419   /// specific location targeting a new destination register.
 420   virtual void reMaterialize(MachineBasicBlock &MBB,
 421                              MachineBasicBlock::iterator MI,
 422                              unsigned DestReg,
 423                              const MachineInstr *Orig) const = 0;
 424
 425   /// foldMemoryOperand - Attempt to fold a load or store of the
 426   /// specified stack slot into the specified machine instruction for
 427   /// the specified operand.  If this is possible, a new instruction
 428   /// is returned with the specified operand folded, otherwise NULL is
 429   /// returned. The client is responsible for removing the old
 430   /// instruction and adding the new one in the instruction stream
 431   virtual MachineInstr* foldMemoryOperand(MachineInstr* MI,
 432                                           unsigned OpNum,
 433                                           int FrameIndex) const {
 434     return 0;
 435   }
 436
 437   /// targetHandlesStackFrameRounding - Returns true if the target is responsible
 438   /// for rounding up the stack frame (probably at emitPrologue time).
 439   virtual bool targetHandlesStackFrameRounding() const {
 440     return false;
 441   }
 442
 443   /// requiresRegisterScavenging - returns true if the target requires (and
 444   /// can make use of) the register scavenger.
 445   virtual bool requiresRegisterScavenging(const MachineFunction &MF) const {
 446     return false;
 447   }
 448
 449   /// hasFP - Return true if the specified function should have a dedicated frame
 450   /// pointer register. For most targets this is true only if the function has
 451   /// variable sized allocas or if frame pointer elimination is disabled.
 452   virtual bool hasFP(const MachineFunction &MF) const = 0;
 453
 454   /// getCallFrameSetup/DestroyOpcode - These methods return the opcode of the
 455   /// frame setup/destroy instructions if they exist (-1 otherwise).  Some
 456   /// targets use pseudo instructions in order to abstract away the difference
 457   /// between operating with a frame pointer and operating without, through the
 458   /// use of these two instructions.
 459   ///
 460   int getCallFrameSetupOpcode() const { return CallFrameSetupOpcode; }
 461   int getCallFrameDestroyOpcode() const { return CallFrameDestroyOpcode; }
 462
 463
 464   /// eliminateCallFramePseudoInstr - This method is called during prolog/epilog
 465   /// code insertion to eliminate call frame setup and destroy pseudo
 466   /// instructions (but only if the Target is using them).  It is responsible
 467   /// for eliminating these instructions, replacing them with concrete
 468   /// instructions.  This method need only be implemented if using call frame
 469   /// setup/destroy pseudo instructions.
 470   ///
 471   virtual void
 472   eliminateCallFramePseudoInstr(MachineFunction &MF,
 473                                 MachineBasicBlock &MBB,
 474                                 MachineBasicBlock::iterator MI) const {
 475     assert(getCallFrameSetupOpcode()== -1 && getCallFrameDestroyOpcode()== -1 &&
 476            "eliminateCallFramePseudoInstr must be implemented if using"
 477            " call frame setup/destroy pseudo instructions!");
 478     assert(0 && "Call Frame Pseudo Instructions do not exist on this target!");
 479   }
 480
 481   /// processFunctionBeforeCalleeSavedScan - This method is called immediately
 482   /// before PrologEpilogInserter scans the physical registers used to determine
 483   /// what callee saved registers should be spilled. This method is optional.
 484   virtual void processFunctionBeforeCalleeSavedScan(MachineFunction &MF,
 485                                                 RegScavenger *RS = NULL) const {
 486
 487   }
 488
 489   /// processFunctionBeforeFrameFinalized - This method is called immediately
 490   /// before the specified functions frame layout (MF.getFrameInfo()) is
 491   /// finalized.  Once the frame is finalized, MO_FrameIndex operands are
 492   /// replaced with direct constants.  This method is optional.
 493   ///
 494   virtual void processFunctionBeforeFrameFinalized(MachineFunction &MF) const {
 495   }
 496
 497   /// eliminateFrameIndex - This method must be overriden to eliminate abstract
 498   /// frame indices from instructions which may use them.  The instruction
 499   /// referenced by the iterator contains an MO_FrameIndex operand which must be
 500   /// eliminated by this method.  This method may modify or replace the
 501   /// specified instruction, as long as it keeps the iterator pointing the the
 502   /// finished product. The return value is the number of instructions
 503   /// added to (negative if removed from) the basic block.
 504   ///
 505   virtual void eliminateFrameIndex(MachineBasicBlock::iterator MI,
 506                                    RegScavenger *RS = NULL) const = 0;
 507
 508   /// emitProlog/emitEpilog - These methods insert prolog and epilog code into
 509   /// the function. The return value is the number of instructions
 510   /// added to (negative if removed from) the basic block (entry for prologue).
 511   ///
 512   virtual void emitPrologue(MachineFunction &MF) const = 0;
 513   virtual void emitEpilogue(MachineFunction &MF,
 514                             MachineBasicBlock &MBB) const = 0;
 515
 516   //===--------------------------------------------------------------------===//
 517   /// Debug information queries.
 518
 519   /// getDwarfRegNum - Map a target register to an equivalent dwarf register
 520   /// number.  Returns -1 if there is no equivalent value.
 521   virtual int getDwarfRegNum(unsigned RegNum) const = 0;
 522
 523   /// getFrameRegister - This method should return the register used as a base
 524   /// for values allocated in the current stack frame.
 525   virtual unsigned getFrameRegister(MachineFunction &MF) const = 0;
 526
 527   /// getRARegister - This method should return the register where the return
 528   /// address can be found.
 529   virtual unsigned getRARegister() const = 0;
 530
 531   /// getLocation - This method should return the actual location of a frame
 532   /// variable given the frame index.  The location is returned in ML.
 533   /// Subclasses should override this method for special handling of frame
 534   /// variables and call MRegisterInfo::getLocation for the default action.
 535   virtual void getLocation(MachineFunction &MF, unsigned Index,
 536                            MachineLocation &ML) const;
 537
 538   /// getInitialFrameState - Returns a list of machine moves that are assumed
 539   /// on entry to all functions.  Note that LabelID is ignored (assumed to be
 540   /// the beginning of the function.)
 541   virtual void getInitialFrameState(std::vector<MachineMove> &Moves) const;
 542 };
 543
 544 // This is useful when building IndexedMaps keyed on virtual registers
 545 struct VirtReg2IndexFunctor : std::unary_function<unsigned, unsigned> {
 546   unsigned operator()(unsigned Reg) const {
 547     return Reg - MRegisterInfo::FirstVirtualRegister;
 548   }
 549 };
 550
 551 } // End llvm namespace
 552
 553 #endif