include/llvm/Target/TargetRegInfo.h

   1 //===-- llvm/Target/RegInfo.h - Target Register Information ------*- C++ -*-==//
   2 //
   3 // This file is used to describe the register system of a target to the
   4 // register allocator.
   5 //
   6 //===----------------------------------------------------------------------===//
   7
   8 #ifndef LLVM_TARGET_MACHINEREGINFO_H
   9 #define LLVM_TARGET_MACHINEREGINFO_H
  10
  11 #include "Support/NonCopyable.h"
  12 #include <ext/hash_map>
  13 #include <string>
  14
  15 class TargetMachine;
  16 class IGNode;
  17 class Type;
  18 class Value;
  19 class LiveRangeInfo;
  20 class Function;
  21 class Instruction;
  22 class LiveRange;
  23 class AddedInstrns;
  24 class MachineInstr;
  25 class RegClass;
  26 class CallInst;
  27 class ReturnInst;
  28 class PhyRegAlloc;
  29 class BasicBlock;
  30
  31 //-----------------------------------------------------------------------------
  32 // class MachineRegClassInfo
  33 //
  34 // Purpose:
  35 //   Interface to description of machine register class (e.g., int reg class
  36 //   float reg class etc)
  37 //
  38 //--------------------------------------------------------------------------
  39
  40
  41 class MachineRegClassInfo {
  42 protected:
  43   const unsigned RegClassID;        // integer ID of a reg class
  44   const unsigned NumOfAvailRegs;    // # of avail for coloring -without SP etc.
  45   const unsigned NumOfAllRegs;      // # of all registers -including SP,g0 etc.
  46
  47 public:
  48   inline unsigned getRegClassID()     const { return RegClassID; }
  49   inline unsigned getNumOfAvailRegs() const { return NumOfAvailRegs; }
  50   inline unsigned getNumOfAllRegs()   const { return NumOfAllRegs; }
  51
  52   // This method should find a color which is not used by neighbors
  53   // (i.e., a false position in IsColorUsedArr) and
  54   virtual void colorIGNode(IGNode *Node, bool IsColorUsedArr[]) const = 0;
  55   virtual bool isRegVolatile(int Reg) const = 0;
  56
  57   MachineRegClassInfo(unsigned ID, unsigned NVR, unsigned NAR)
  58     : RegClassID(ID), NumOfAvailRegs(NVR), NumOfAllRegs(NAR) {}
  59 };
  60
  61
  62
  63 //---------------------------------------------------------------------------
  64 // class MachineRegInfo
  65 //
  66 // Purpose:
  67 //   Interface to register info of target machine
  68 //
  69 //--------------------------------------------------------------------------
  70
  71 class MachineRegInfo : public NonCopyableV {
  72 protected:
  73   // A vector of all machine register classes
  74   //
  75   std::vector<const MachineRegClassInfo *> MachineRegClassArr;
  76
  77 public:
  78   const TargetMachine &target;
  79
  80   MachineRegInfo(const TargetMachine& tgt) : target(tgt) { }
  81
  82
  83   // According the definition of a MachineOperand class, a Value in a
  84   // machine instruction can go into either a normal register or a
  85   // condition code register. If isCCReg is true below, the ID of the condition
  86   // code regiter class will be returned. Otherwise, the normal register
  87   // class (eg. int, float) must be returned.
  88   virtual unsigned getRegClassIDOfType  (const Type *type,
  89                                          bool isCCReg = false) const =0;
  90   virtual unsigned getRegClassIDOfValue (const Value *Val,
  91                                          bool isCCReg = false) const =0;
  92
  93
  94   inline unsigned int getNumOfRegClasses() const {
  95     return MachineRegClassArr.size();
  96   }
  97
  98   const MachineRegClassInfo *getMachineRegClass(unsigned i) const {
  99     return MachineRegClassArr[i];
 100   }
 101
 102   // returns the register that is hardwired to zero if any (-1 if none)
 103   //
 104   virtual int getZeroRegNum() const = 0;
 105
 106
 107   // The following methods are used to color special live ranges (e.g.
 108   // method args and return values etc.) with specific hardware registers
 109   // as required. See SparcRegInfo.cpp for the implementation for Sparc.
 110   //
 111   virtual void suggestRegs4MethodArgs(const Function *Func,
 112                          LiveRangeInfo &LRI) const = 0;
 113
 114   virtual void suggestRegs4CallArgs(const MachineInstr *CallI,
 115                         LiveRangeInfo &LRI, std::vector<RegClass *> RCL) const = 0;
 116
 117   virtual void suggestReg4RetValue(const MachineInstr *RetI,
 118                                    LiveRangeInfo &LRI) const = 0;
 119
 120   virtual void colorMethodArgs(const Function *Func,  LiveRangeInfo &LRI,
 121                                AddedInstrns *FirstAI) const = 0;
 122
 123   virtual void colorCallArgs(const MachineInstr *CalI,
 124                              LiveRangeInfo& LRI, AddedInstrns *CallAI,
 125                              PhyRegAlloc &PRA, const BasicBlock *BB) const = 0;
 126
 127   virtual void colorRetValue(const MachineInstr *RetI, LiveRangeInfo &LRI,
 128                              AddedInstrns *RetAI) const = 0;
 129
 130
 131
 132   // The following methods are used to generate "copy" machine instructions
 133   // for an architecture. Currently they are used in MachineRegClass
 134   // interface. However, they can be moved to MachineInstrInfo interface if
 135   // necessary.
 136   //
 137   virtual MachineInstr *cpReg2RegMI(unsigned SrcReg, unsigned DestReg,
 138                                     int RegType) const = 0;
 139
 140   virtual MachineInstr *cpReg2MemMI(unsigned SrcReg, unsigned DestPtrReg,
 141                                     int Offset, int RegType) const = 0;
 142
 143   virtual MachineInstr *cpMem2RegMI(unsigned SrcPtrReg, int Offset,
 144                                     unsigned DestReg, int RegType) const = 0;
 145
 146   virtual MachineInstr *cpValue2Value(Value *Src, Value *Dest) const = 0;
 147
 148   virtual bool isRegVolatile(int RegClassID, int Reg) const = 0;
 149
 150
 151
 152
 153   // Returns the reg used for pushing the address when a method is called.
 154   // This can be used for other purposes between calls
 155   //
 156   virtual unsigned getCallAddressReg() const = 0;
 157
 158   // Returns the register containing the return address.
 159   //It should be made sure that this
 160   // register contains the return value when a return instruction is reached.
 161   //
 162   virtual unsigned getReturnAddressReg() const = 0;
 163
 164
 165   // Each register class has a seperate space for register IDs. To convert
 166   // a regId in a register class to a common Id, we use the folloing method(s)
 167   //
 168   virtual int getUnifiedRegNum(int RegClassID, int reg) const = 0;
 169
 170   virtual const std::string getUnifiedRegName(int UnifiedRegNum) const = 0;
 171
 172
 173   // Gives the type of a register based on the type of the LR
 174   //
 175   virtual int getRegType(const LiveRange *LR) const = 0;
 176
 177   // To obtain the return value and the indirect call address (if any)
 178   // contained in a CALL machine instruction
 179   //
 180   virtual const Value *getCallInstRetVal(const MachineInstr *CallMI) const = 0;
 181   virtual const Value *getCallInstIndirectAddrVal(const MachineInstr *CallMI) const = 0;
 182
 183   // The following methods are used to get the frame/stack pointers
 184   //
 185   virtual unsigned getFramePointer() const = 0;
 186   virtual unsigned getStackPointer() const = 0;
 187
 188   // A register can be initialized to an invalid number. That number can
 189   // be obtained using this method.
 190   //
 191   virtual int getInvalidRegNum() const = 0;
 192
 193
 194   // Method for inserting caller saving code. The caller must save all the
 195   // volatile registers across a call based on the calling conventions of
 196   // an architecture. This must insert code for saving and restoring
 197   // such registers on
 198   //
 199   virtual void insertCallerSavingCode(const MachineInstr *MInst,
 200                                       const BasicBlock *BB,
 201                                       PhyRegAlloc &PRA) const = 0;
 202
 203   // This method gives the the number of bytes of stack spaceallocated
 204   // to a register when it is spilled to the stack.
 205   //
 206   virtual int getSpilledRegSize(int RegType) const = 0;
 207 };
 208
 209 #endif