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