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