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