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 <cassert>
  21 #include <functional>
  22
  23 namespace llvm {
  24
  25 class Type;
  26 class MachineFunction;
  27 class MachineInstr;
  28
  29 /// MRegisterDesc - This record contains all of the information known about a
  30 /// particular register.  The AliasSet field (if not null) contains a pointer to
  31 /// a Zero terminated array of registers that this register aliases.  This is
  32 /// needed for architectures like X86 which have AL alias AX alias EAX.
  33 /// Registers that this does not apply to simply should set this to null.
  34 ///
  35 struct MRegisterDesc {
  36   const char     *Name;         // Assembly language name for the register
  37   const unsigned *AliasSet;     // Register Alias Set, described above
  38   unsigned char SpillSize;      // Size of this register in bytes
  39   unsigned char SpillAlignment; // Alignment of stack slot for this reg
  40 };
  41
  42 class TargetRegisterClass {
  43 public:
  44   typedef const unsigned* iterator;
  45   typedef const unsigned* const_iterator;
  46
  47 private:
  48   const unsigned RegSize, Alignment;    // Size & Alignment of register in bytes
  49   const iterator RegsBegin, RegsEnd;
  50 public:
  51   TargetRegisterClass(unsigned RS, unsigned Al, iterator RB, iterator RE)
  52     : RegSize(RS), Alignment(Al), RegsBegin(RB), RegsEnd(RE) {}
  53   virtual ~TargetRegisterClass() {}     // Allow subclasses
  54
  55   // begin/end - Return all of the registers in this class.
  56   iterator       begin() const { return RegsBegin; }
  57   iterator         end() const { return RegsEnd; }
  58
  59   // getNumRegs - Return the number of registers in this class
  60   unsigned getNumRegs() const { return RegsEnd-RegsBegin; }
  61
  62   // getRegister - Return the specified register in the class
  63   unsigned getRegister(unsigned i) const {
  64     assert(i < getNumRegs() && "Register number out of range!");
  65     return RegsBegin[i];
  66   }
  67
  68   /// contains - Return true if the specified register is included in this
  69   /// register class.
  70   bool contains(unsigned Reg) const {
  71     for (iterator I = begin(), E = end(); I != E; ++I)
  72       if (*I == Reg) return true;
  73     return false;
  74   }
  75
  76   /// allocation_order_begin/end - These methods define a range of registers
  77   /// which specify the registers in this class that are valid to register
  78   /// allocate, and the preferred order to allocate them in.  For example,
  79   /// callee saved registers should be at the end of the list, because it is
  80   /// cheaper to allocate caller saved registers.
  81   ///
  82   /// These methods take a MachineFunction argument, which can be used to tune
  83   /// the allocatable registers based on the characteristics of the function.
  84   /// One simple example is that the frame pointer register can be used if
  85   /// frame-pointer-elimination is performed.
  86   ///
  87   /// By default, these methods return all registers in the class.
  88   ///
  89   virtual iterator allocation_order_begin(MachineFunction &MF) const {
  90     return begin();
  91   }
  92   virtual iterator allocation_order_end(MachineFunction &MF)   const {
  93     return end();
  94   }
  95
  96
  97
  98   /// getSize - Return the size of the register in bytes, which is also the size
  99   /// of a stack slot allocated to hold a spilled copy of this register.
 100   unsigned getSize() const { return RegSize; }
 101
 102   /// getAlignment - Return the minimum required alignment for a register of
 103   /// this class.
 104   unsigned getAlignment() const { return Alignment; }
 105 };
 106
 107
 108 /// MRegisterInfo base class - We assume that the target defines a static array
 109 /// of MRegisterDesc objects that represent all of the machine registers that
 110 /// the target has.  As such, we simply have to track a pointer to this array so
 111 /// that we can turn register number into a register descriptor.
 112 ///
 113 class MRegisterInfo {
 114 public:
 115   typedef const TargetRegisterClass * const * regclass_iterator;
 116 private:
 117   const MRegisterDesc *Desc;                  // Pointer to the descriptor array
 118   unsigned NumRegs;                           // Number of entries in the array
 119
 120   regclass_iterator RegClassBegin, RegClassEnd;   // List of regclasses
 121
 122   const TargetRegisterClass **PhysRegClasses; // Reg class for each register
 123   int CallFrameSetupOpcode, CallFrameDestroyOpcode;
 124 protected:
 125   MRegisterInfo(const MRegisterDesc *D, unsigned NR,
 126                 regclass_iterator RegClassBegin, regclass_iterator RegClassEnd,
 127                 int CallFrameSetupOpcode = -1, int CallFrameDestroyOpcode = -1);
 128   virtual ~MRegisterInfo();
 129 public:
 130
 131   enum {                        // Define some target independent constants
 132     /// NoRegister - This 'hard' register is a 'noop' register for all backends.
 133     /// This is used as the destination register for instructions that do not
 134     /// produce a value.  Some frontends may use this as an operand register to
 135     /// mean special things, for example, the Sparc backend uses R0 to mean %g0
 136     /// which always PRODUCES the value 0.  The X86 backend does not use this
 137     /// value as an operand register, except for memory references.
 138     ///
 139     NoRegister = 0,
 140
 141     /// FirstVirtualRegister - This is the first register number that is
 142     /// considered to be a 'virtual' register, which is part of the SSA
 143     /// namespace.  This must be the same for all targets, which means that each
 144     /// target is limited to 1024 registers.
 145     ///
 146     FirstVirtualRegister = 1024,
 147   };
 148
 149   /// isPhysicalRegister - Return true if the specified register number is in
 150   /// the physical register namespace.
 151   static bool isPhysicalRegister(unsigned Reg) {
 152     assert(Reg && "this is not a register!");
 153     return Reg < FirstVirtualRegister;
 154   }
 155
 156   /// isVirtualRegister - Return true if the specified register number is in
 157   /// the virtual register namespace.
 158   static bool isVirtualRegister(unsigned Reg) {
 159     assert(Reg && "this is not a register!");
 160     return Reg >= FirstVirtualRegister;
 161   }
 162
 163   const MRegisterDesc &operator[](unsigned RegNo) const {
 164     assert(RegNo < NumRegs &&
 165            "Attempting to access record for invalid register number!");
 166     return Desc[RegNo];
 167   }
 168
 169   /// Provide a get method, equivalent to [], but more useful if we have a
 170   /// pointer to this object.
 171   ///
 172   const MRegisterDesc &get(unsigned RegNo) const { return operator[](RegNo); }
 173
 174   /// getRegClass - Return the register class for the specified physical
 175   /// register.
 176   ///
 177   const TargetRegisterClass *getRegClass(unsigned RegNo) const {
 178     assert(RegNo < NumRegs && "Register number out of range!");
 179     assert(PhysRegClasses[RegNo] && "Register is not in a class!");
 180     return PhysRegClasses[RegNo];
 181   }
 182
 183   /// getAliasSet - Return the set of registers aliased by the specified
 184   /// register, or a null list of there are none.  The list returned is zero
 185   /// terminated.
 186   ///
 187   const unsigned *getAliasSet(unsigned RegNo) const {
 188     return get(RegNo).AliasSet;
 189   }
 190
 191   /// getName - Return the symbolic target specific name for the specified
 192   /// physical register.
 193   const char *getName(unsigned RegNo) const {
 194     return get(RegNo).Name;
 195   }
 196
 197   /// getSpillSize - Return the size required of a stack slot used to spill
 198   /// register into.
 199   unsigned getSpillSize(unsigned RegNo) const {
 200     return get(RegNo).SpillSize;
 201   }
 202
 203   /// getSpillAlignment - Return the alignment required by a stack slot used to
 204   /// spill register into.
 205   unsigned getSpillAlignment(unsigned RegNo) const {
 206     return get(RegNo).SpillAlignment;
 207   }
 208
 209   /// getNumRegs - Return the number of registers this target has
 210   /// (useful for sizing arrays holding per register information)
 211   unsigned getNumRegs() const {
 212     return NumRegs;
 213   }
 214
 215   /// areAliases - Returns true if the two registers alias each other,
 216   /// false otherwise
 217   bool areAliases(unsigned regA, unsigned regB) const {
 218     for (const unsigned *Alias = getAliasSet(regA); *Alias; ++Alias)
 219       if (*Alias == regB) return true;
 220     return false;
 221   }
 222
 223   virtual const unsigned* getCalleeSaveRegs() const = 0;
 224
 225
 226   //===--------------------------------------------------------------------===//
 227   // Register Class Information
 228   //
 229
 230   /// Register class iterators
 231   ///
 232   regclass_iterator regclass_begin() const { return RegClassBegin; }
 233   regclass_iterator regclass_end() const { return RegClassEnd; }
 234
 235   unsigned getNumRegClasses() const {
 236     return regclass_end()-regclass_begin();
 237   }
 238
 239   //===--------------------------------------------------------------------===//
 240   // Interfaces used by the register allocator and stack frame
 241   // manipulation passes to move data around between registers,
 242   // immediates and memory.  The return value is the number of
 243   // instructions added to (negative if removed from) the basic block.
 244   //
 245
 246   virtual void storeRegToStackSlot(MachineBasicBlock &MBB,
 247                                    MachineBasicBlock::iterator MI,
 248                                    unsigned SrcReg, int FrameIndex) const = 0;
 249
 250   virtual void loadRegFromStackSlot(MachineBasicBlock &MBB,
 251                                     MachineBasicBlock::iterator MI,
 252                                     unsigned DestReg, int FrameIndex) const = 0;
 253
 254   virtual void copyRegToReg(MachineBasicBlock &MBB,
 255                             MachineBasicBlock::iterator MI,
 256                             unsigned DestReg, unsigned SrcReg,
 257                             const TargetRegisterClass *RC) const = 0;
 258
 259
 260   /// foldMemoryOperand - Attempt to fold a load or store of the
 261   /// specified stack slot into the specified machine instruction for
 262   /// the specified operand.  If this is possible, a new instruction
 263   /// is returned with the specified operand folded, otherwise NULL is
 264   /// returned. The client is responsible for removing the old
 265   /// instruction and adding the new one in the instruction stream
 266   virtual MachineInstr* foldMemoryOperand(MachineInstr* MI,
 267                                           unsigned OpNum,
 268                                           int FrameIndex) const {
 269     return 0;
 270   }
 271
 272   /// getCallFrameSetup/DestroyOpcode - These methods return the opcode of the
 273   /// frame setup/destroy instructions if they exist (-1 otherwise).  Some
 274   /// targets use pseudo instructions in order to abstract away the difference
 275   /// between operating with a frame pointer and operating without, through the
 276   /// use of these two instructions.
 277   ///
 278   int getCallFrameSetupOpcode() const { return CallFrameSetupOpcode; }
 279   int getCallFrameDestroyOpcode() const { return CallFrameDestroyOpcode; }
 280
 281
 282   /// eliminateCallFramePseudoInstr - This method is called during prolog/epilog
 283   /// code insertion to eliminate call frame setup and destroy pseudo
 284   /// instructions (but only if the Target is using them).  It is responsible
 285   /// for eliminating these instructions, replacing them with concrete
 286   /// instructions.  This method need only be implemented if using call frame
 287   /// setup/destroy pseudo instructions.
 288   ///
 289   virtual void
 290   eliminateCallFramePseudoInstr(MachineFunction &MF,
 291                                 MachineBasicBlock &MBB,
 292                                 MachineBasicBlock::iterator MI) const {
 293     assert(getCallFrameSetupOpcode()== -1 && getCallFrameDestroyOpcode()== -1 &&
 294            "eliminateCallFramePseudoInstr must be implemented if using"
 295            " call frame setup/destroy pseudo instructions!");
 296     assert(0 && "Call Frame Pseudo Instructions do not exist on this target!");
 297   }
 298
 299   /// processFunctionBeforeFrameFinalized - This method is called immediately
 300   /// before the specified functions frame layout (MF.getFrameInfo()) is
 301   /// finalized.  Once the frame is finalized, MO_FrameIndex operands are
 302   /// replaced with direct constants.  This method is optional. The return value
 303   /// is the number of instructions added to (negative if removed from) the
 304   /// basic block
 305   ///
 306   virtual void processFunctionBeforeFrameFinalized(MachineFunction &MF) const {
 307   }
 308
 309   /// eliminateFrameIndex - This method must be overriden to eliminate abstract
 310   /// frame indices from instructions which may use them.  The instruction
 311   /// referenced by the iterator contains an MO_FrameIndex operand which must be
 312   /// eliminated by this method.  This method may modify or replace the
 313   /// specified instruction, as long as it keeps the iterator pointing the the
 314   /// finished product. The return value is the number of instructions
 315   /// added to (negative if removed from) the basic block.
 316   ///
 317   virtual void eliminateFrameIndex(MachineBasicBlock::iterator MI) const = 0;
 318
 319   /// emitProlog/emitEpilog - These methods insert prolog and epilog code into
 320   /// the function. The return value is the number of instructions
 321   /// added to (negative if removed from) the basic block (entry for prologue).
 322   ///
 323   virtual void emitPrologue(MachineFunction &MF) const = 0;
 324   virtual void emitEpilogue(MachineFunction &MF,
 325                             MachineBasicBlock &MBB) const = 0;
 326 };
 327
 328 // This is useful when building DenseMaps keyed on virtual registers
 329 struct VirtReg2IndexFunctor : std::unary_function<unsigned, unsigned> {
 330   unsigned operator()(unsigned Reg) const {
 331     return Reg - MRegisterInfo::FirstVirtualRegister;
 332   }
 333 };
 334
 335 } // End llvm namespace
 336
 337 #endif