Canonicalize header guards into a common format.
[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 LLVM_LIB_TARGET_ARM_ARMBASEREGISTERINFO_H
15 #define LLVM_LIB_TARGET_ARM_ARMBASEREGISTERINFO_H
16
17 #include "MCTargetDesc/ARMBaseInfo.h"
18 #include "llvm/Target/TargetRegisterInfo.h"
19
20 #define GET_REGINFO_HEADER
21 #include "ARMGenRegisterInfo.inc"
22
23 namespace llvm {
24   class ARMSubtarget;
25   class ARMBaseInstrInfo;
26   class Type;
27
28 /// Register allocation hints.
29 namespace ARMRI {
30   enum {
31     RegPairOdd  = 1,
32     RegPairEven = 2
33   };
34 }
35
36 /// isARMArea1Register - Returns true if the register is a low register (r0-r7)
37 /// or a stack/pc register that we should push/pop.
38 static inline bool isARMArea1Register(unsigned Reg, bool isIOS) {
39   using namespace ARM;
40   switch (Reg) {
41     case R0:  case R1:  case R2:  case R3:
42     case R4:  case R5:  case R6:  case R7:
43     case LR:  case SP:  case PC:
44       return true;
45     case R8:  case R9:  case R10: case R11: case R12:
46       // For iOS we want r7 and lr to be next to each other.
47       return !isIOS;
48     default:
49       return false;
50   }
51 }
52
53 static inline bool isARMArea2Register(unsigned Reg, bool isIOS) {
54   using namespace ARM;
55   switch (Reg) {
56     case R8: case R9: case R10: case R11: case R12:
57       // iOS has this second area.
58       return isIOS;
59     default:
60       return false;
61   }
62 }
63
64 static inline bool isARMArea3Register(unsigned Reg, bool isIOS) {
65   using namespace ARM;
66   switch (Reg) {
67     case D15: case D14: case D13: case D12:
68     case D11: case D10: case D9:  case D8:
69       return true;
70     default:
71       return false;
72   }
73 }
74
75 static inline bool isCalleeSavedRegister(unsigned Reg,
76                                          const MCPhysReg *CSRegs) {
77   for (unsigned i = 0; CSRegs[i]; ++i)
78     if (Reg == CSRegs[i])
79       return true;
80   return false;
81 }
82
83 class ARMBaseRegisterInfo : public ARMGenRegisterInfo {
84 protected:
85   const ARMSubtarget &STI;
86
87   /// FramePtr - ARM physical register used as frame ptr.
88   unsigned FramePtr;
89
90   /// BasePtr - ARM physical register used as a base ptr in complex stack
91   /// frames. I.e., when we need a 3rd base, not just SP and FP, due to
92   /// variable size stack objects.
93   unsigned BasePtr;
94
95   // Can be only subclassed.
96   explicit ARMBaseRegisterInfo(const ARMSubtarget &STI);
97
98   // Return the opcode that implements 'Op', or 0 if no opcode
99   unsigned getOpcode(int Op) const;
100
101 public:
102   /// Code Generation virtual methods...
103   const MCPhysReg *
104   getCalleeSavedRegs(const MachineFunction *MF = nullptr) const override;
105   const uint32_t *getCallPreservedMask(CallingConv::ID) const override;
106   const uint32_t *getNoPreservedMask() const;
107
108   /// getThisReturnPreservedMask - Returns a call preserved mask specific to the
109   /// case that 'returned' is on an i32 first argument if the calling convention
110   /// is one that can (partially) model this attribute with a preserved mask
111   /// (i.e. it is a calling convention that uses the same register for the first
112   /// i32 argument and an i32 return value)
113   ///
114   /// Should return NULL in the case that the calling convention does not have
115   /// this property
116   const uint32_t *getThisReturnPreservedMask(CallingConv::ID) const;
117
118   BitVector getReservedRegs(const MachineFunction &MF) const override;
119
120   const TargetRegisterClass *
121   getPointerRegClass(const MachineFunction &MF,
122                      unsigned Kind = 0) const override;
123   const TargetRegisterClass *
124   getCrossCopyRegClass(const TargetRegisterClass *RC) const override;
125
126   const TargetRegisterClass *
127   getLargestLegalSuperClass(const TargetRegisterClass *RC) const override;
128
129   unsigned getRegPressureLimit(const TargetRegisterClass *RC,
130                                MachineFunction &MF) const override;
131
132   void getRegAllocationHints(unsigned VirtReg,
133                              ArrayRef<MCPhysReg> Order,
134                              SmallVectorImpl<MCPhysReg> &Hints,
135                              const MachineFunction &MF,
136                              const VirtRegMap *VRM) const override;
137
138   void UpdateRegAllocHint(unsigned Reg, unsigned NewReg,
139                           MachineFunction &MF) const override;
140
141   bool avoidWriteAfterWrite(const TargetRegisterClass *RC) const override;
142
143   bool hasBasePointer(const MachineFunction &MF) const;
144
145   bool canRealignStack(const MachineFunction &MF) const;
146   bool needsStackRealignment(const MachineFunction &MF) const override;
147   int64_t getFrameIndexInstrOffset(const MachineInstr *MI,
148                                    int Idx) const override;
149   bool needsFrameBaseReg(MachineInstr *MI, int64_t Offset) const override;
150   void materializeFrameBaseRegister(MachineBasicBlock *MBB,
151                                     unsigned BaseReg, int FrameIdx,
152                                     int64_t Offset) const override;
153   void resolveFrameIndex(MachineInstr &MI, unsigned BaseReg,
154                          int64_t Offset) const override;
155   bool isFrameOffsetLegal(const MachineInstr *MI,
156                           int64_t Offset) const override;
157
158   bool cannotEliminateFrame(const MachineFunction &MF) const;
159
160   // Debug information queries.
161   unsigned getFrameRegister(const MachineFunction &MF) const override;
162   unsigned getBaseRegister() const { return BasePtr; }
163
164   bool isLowRegister(unsigned Reg) const;
165
166
167   /// emitLoadConstPool - Emits a load from constpool to materialize the
168   /// specified immediate.
169   virtual void emitLoadConstPool(MachineBasicBlock &MBB,
170                                  MachineBasicBlock::iterator &MBBI,
171                                  DebugLoc dl, unsigned DestReg, unsigned SubIdx,
172                                  int Val, ARMCC::CondCodes Pred = ARMCC::AL,
173                                  unsigned PredReg = 0,
174                                  unsigned MIFlags = MachineInstr::NoFlags)const;
175
176   /// Code Generation virtual methods...
177   bool mayOverrideLocalAssignment() const override;
178
179   bool requiresRegisterScavenging(const MachineFunction &MF) const override;
180
181   bool trackLivenessAfterRegAlloc(const MachineFunction &MF) const override;
182
183   bool requiresFrameIndexScavenging(const MachineFunction &MF) const override;
184
185   bool requiresVirtualBaseRegisters(const MachineFunction &MF) const override;
186
187   void eliminateFrameIndex(MachineBasicBlock::iterator II,
188                            int SPAdj, unsigned FIOperandNum,
189                            RegScavenger *RS = nullptr) const override;
190
191   /// \brief SrcRC and DstRC will be morphed into NewRC if this returns true
192   bool shouldCoalesce(MachineInstr *MI,
193                       const TargetRegisterClass *SrcRC,
194                       unsigned SubReg,
195                       const TargetRegisterClass *DstRC,
196                       unsigned DstSubReg,
197                       const TargetRegisterClass *NewRC) const override;
198 };
199
200 } // end namespace llvm
201
202 #endif