Add hook for re-using virtual base registers for local stack slot access.
[oota-llvm.git] / lib / Target / ARM / ARMBaseRegisterInfo.h
1 //===- ARMBaseRegisterInfo.h - ARM Register Information Impl ----*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains the base ARM implementation of TargetRegisterInfo class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef ARMBASEREGISTERINFO_H
15 #define ARMBASEREGISTERINFO_H
16
17 #include "ARM.h"
18 #include "llvm/Target/TargetRegisterInfo.h"
19 #include "ARMGenRegisterInfo.h.inc"
20
21 namespace llvm {
22   class ARMSubtarget;
23   class ARMBaseInstrInfo;
24   class Type;
25
26 /// Register allocation hints.
27 namespace ARMRI {
28   enum {
29     RegPairOdd  = 1,
30     RegPairEven = 2
31   };
32 }
33
34 /// isARMLowRegister - Returns true if the register is low register r0-r7.
35 ///
36 static inline bool isARMLowRegister(unsigned Reg) {
37   using namespace ARM;
38   switch (Reg) {
39   case R0:  case R1:  case R2:  case R3:
40   case R4:  case R5:  case R6:  case R7:
41     return true;
42   default:
43     return false;
44   }
45 }
46
47 class ARMBaseRegisterInfo : public ARMGenRegisterInfo {
48 protected:
49   const ARMBaseInstrInfo &TII;
50   const ARMSubtarget &STI;
51
52   /// FramePtr - ARM physical register used as frame ptr.
53   unsigned FramePtr;
54
55   // Can be only subclassed.
56   explicit ARMBaseRegisterInfo(const ARMBaseInstrInfo &tii,
57                                const ARMSubtarget &STI);
58
59   // Return the opcode that implements 'Op', or 0 if no opcode
60   unsigned getOpcode(int Op) const;
61
62 public:
63   /// getRegisterNumbering - Given the enum value for some register, e.g.
64   /// ARM::LR, return the number that it corresponds to (e.g. 14). It
65   /// also returns true in isSPVFP if the register is a single precision
66   /// VFP register.
67   static unsigned getRegisterNumbering(unsigned RegEnum, bool *isSPVFP = 0);
68
69   /// Code Generation virtual methods...
70   const unsigned *getCalleeSavedRegs(const MachineFunction *MF = 0) const;
71
72   BitVector getReservedRegs(const MachineFunction &MF) const;
73
74   /// getMatchingSuperRegClass - Return a subclass of the specified register
75   /// class A so that each register in it has a sub-register of the
76   /// specified sub-register index which is in the specified register class B.
77   virtual const TargetRegisterClass *
78   getMatchingSuperRegClass(const TargetRegisterClass *A,
79                            const TargetRegisterClass *B, unsigned Idx) const;
80
81   /// canCombineSubRegIndices - Given a register class and a list of
82   /// subregister indices, return true if it's possible to combine the
83   /// subregister indices into one that corresponds to a larger
84   /// subregister. Return the new subregister index by reference. Note the
85   /// new index may be zero if the given subregisters can be combined to
86   /// form the whole register.
87   virtual bool canCombineSubRegIndices(const TargetRegisterClass *RC,
88                                        SmallVectorImpl<unsigned> &SubIndices,
89                                        unsigned &NewSubIdx) const;
90
91   const TargetRegisterClass *getPointerRegClass(unsigned Kind = 0) const;
92
93   std::pair<TargetRegisterClass::iterator,TargetRegisterClass::iterator>
94   getAllocationOrder(const TargetRegisterClass *RC,
95                      unsigned HintType, unsigned HintReg,
96                      const MachineFunction &MF) const;
97
98   unsigned ResolveRegAllocHint(unsigned Type, unsigned Reg,
99                                const MachineFunction &MF) const;
100
101   void UpdateRegAllocHint(unsigned Reg, unsigned NewReg,
102                           MachineFunction &MF) const;
103
104   bool hasFP(const MachineFunction &MF) const;
105
106   bool canRealignStack(const MachineFunction &MF) const;
107   bool needsStackRealignment(const MachineFunction &MF) const;
108   bool needsFrameBaseReg(MachineInstr *MI, unsigned operand) const;
109   void materializeFrameBaseRegister(MachineBasicBlock::iterator I,
110                                     unsigned BaseReg, int FrameIdx) const;
111   void resolveFrameIndex(MachineBasicBlock::iterator I,
112                          unsigned BaseReg, int64_t Offset) const;
113   bool isBaseRegInRange(const MachineInstr *MI, unsigned Reg,
114                         int64_t Offset) const;
115
116   bool cannotEliminateFrame(const MachineFunction &MF) const;
117
118   void processFunctionBeforeCalleeSavedScan(MachineFunction &MF,
119                                             RegScavenger *RS = NULL) const;
120
121   // Debug information queries.
122   unsigned getRARegister() const;
123   unsigned getFrameRegister(const MachineFunction &MF) const;
124   int getFrameIndexReference(const MachineFunction &MF, int FI,
125                              unsigned &FrameReg) const;
126   int ResolveFrameIndexReference(const MachineFunction &MF, int FI,
127                                  unsigned &FrameReg, int SPAdj) const;
128   int getFrameIndexOffset(const MachineFunction &MF, int FI) const;
129
130   // Exception handling queries.
131   unsigned getEHExceptionRegister() const;
132   unsigned getEHHandlerRegister() const;
133
134   int getDwarfRegNum(unsigned RegNum, bool isEH) const;
135
136   bool isLowRegister(unsigned Reg) const;
137
138
139   /// emitLoadConstPool - Emits a load from constpool to materialize the
140   /// specified immediate.
141   virtual void emitLoadConstPool(MachineBasicBlock &MBB,
142                                  MachineBasicBlock::iterator &MBBI,
143                                  DebugLoc dl,
144                                  unsigned DestReg, unsigned SubIdx,
145                                  int Val,
146                                  ARMCC::CondCodes Pred = ARMCC::AL,
147                                  unsigned PredReg = 0) const;
148
149   /// Code Generation virtual methods...
150   virtual bool isReservedReg(const MachineFunction &MF, unsigned Reg) const;
151
152   virtual bool requiresRegisterScavenging(const MachineFunction &MF) const;
153
154   virtual bool requiresFrameIndexScavenging(const MachineFunction &MF) const;
155
156   virtual bool hasReservedCallFrame(const MachineFunction &MF) const;
157   virtual bool canSimplifyCallFramePseudos(const MachineFunction &MF) const;
158
159   virtual void eliminateCallFramePseudoInstr(MachineFunction &MF,
160                                            MachineBasicBlock &MBB,
161                                            MachineBasicBlock::iterator I) const;
162
163   virtual unsigned eliminateFrameIndex(MachineBasicBlock::iterator II,
164                                        int SPAdj, FrameIndexValue *Value = NULL,
165                                        RegScavenger *RS = NULL) const;
166
167   virtual void emitPrologue(MachineFunction &MF) const;
168   virtual void emitEpilogue(MachineFunction &MF, MachineBasicBlock &MBB) const;
169
170 private:
171   unsigned estimateRSStackSizeLimit(MachineFunction &MF) const;
172
173   unsigned getRegisterPairEven(unsigned Reg, const MachineFunction &MF) const;
174
175   unsigned getRegisterPairOdd(unsigned Reg, const MachineFunction &MF) const;
176 };
177
178 } // end namespace llvm
179
180 #endif