Re-apply 132758 and 132768 which were speculatively reverted in 132777.
[oota-llvm.git] / lib / Target / Mips / MipsRegisterInfo.cpp
1 //===- MipsRegisterInfo.cpp - MIPS Register Information -== -----*- 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 MIPS implementation of the TargetRegisterInfo class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #define DEBUG_TYPE "mips-reg-info"
15
16 #include "Mips.h"
17 #include "MipsSubtarget.h"
18 #include "MipsRegisterInfo.h"
19 #include "MipsMachineFunction.h"
20 #include "llvm/Constants.h"
21 #include "llvm/Type.h"
22 #include "llvm/Function.h"
23 #include "llvm/CodeGen/ValueTypes.h"
24 #include "llvm/CodeGen/MachineInstrBuilder.h"
25 #include "llvm/CodeGen/MachineFunction.h"
26 #include "llvm/CodeGen/MachineFrameInfo.h"
27 #include "llvm/CodeGen/MachineLocation.h"
28 #include "llvm/Target/TargetFrameLowering.h"
29 #include "llvm/Target/TargetMachine.h"
30 #include "llvm/Target/TargetOptions.h"
31 #include "llvm/Target/TargetInstrInfo.h"
32 #include "llvm/Support/CommandLine.h"
33 #include "llvm/Support/Debug.h"
34 #include "llvm/Support/ErrorHandling.h"
35 #include "llvm/Support/raw_ostream.h"
36 #include "llvm/ADT/BitVector.h"
37 #include "llvm/ADT/STLExtras.h"
38
39 using namespace llvm;
40
41 MipsRegisterInfo::MipsRegisterInfo(const MipsSubtarget &ST,
42                                    const TargetInstrInfo &tii)
43   : MipsGenRegisterInfo(Mips::ADJCALLSTACKDOWN, Mips::ADJCALLSTACKUP),
44     Subtarget(ST), TII(tii) {}
45
46 /// getRegisterNumbering - Given the enum value for some register, e.g.
47 /// Mips::RA, return the number that it corresponds to (e.g. 31).
48 unsigned MipsRegisterInfo::
49 getRegisterNumbering(unsigned RegEnum)
50 {
51   switch (RegEnum) {
52     case Mips::ZERO : case Mips::F0 : case Mips::D0 : return 0;
53     case Mips::AT   : case Mips::F1 : return 1;
54     case Mips::V0   : case Mips::F2 : case Mips::D1 : return 2;
55     case Mips::V1   : case Mips::F3 : return 3;
56     case Mips::A0   : case Mips::F4 : case Mips::D2 : return 4;
57     case Mips::A1   : case Mips::F5 : return 5;
58     case Mips::A2   : case Mips::F6 : case Mips::D3 : return 6;
59     case Mips::A3   : case Mips::F7 : return 7;
60     case Mips::T0   : case Mips::F8 : case Mips::D4 : return 8;
61     case Mips::T1   : case Mips::F9 : return 9;
62     case Mips::T2   : case Mips::F10: case Mips::D5: return 10;
63     case Mips::T3   : case Mips::F11: return 11;
64     case Mips::T4   : case Mips::F12: case Mips::D6: return 12;
65     case Mips::T5   : case Mips::F13: return 13;
66     case Mips::T6   : case Mips::F14: case Mips::D7: return 14;
67     case Mips::T7   : case Mips::F15: return 15;
68     case Mips::S0   : case Mips::F16: case Mips::D8: return 16;
69     case Mips::S1   : case Mips::F17: return 17;
70     case Mips::S2   : case Mips::F18: case Mips::D9: return 18;
71     case Mips::S3   : case Mips::F19: return 19;
72     case Mips::S4   : case Mips::F20: case Mips::D10: return 20;
73     case Mips::S5   : case Mips::F21: return 21;
74     case Mips::S6   : case Mips::F22: case Mips::D11: return 22;
75     case Mips::S7   : case Mips::F23: return 23;
76     case Mips::T8   : case Mips::F24: case Mips::D12: return 24;
77     case Mips::T9   : case Mips::F25: return 25;
78     case Mips::K0   : case Mips::F26: case Mips::D13: return 26;
79     case Mips::K1   : case Mips::F27: return 27;
80     case Mips::GP   : case Mips::F28: case Mips::D14: return 28;
81     case Mips::SP   : case Mips::F29: return 29;
82     case Mips::FP   : case Mips::F30: case Mips::D15: return 30;
83     case Mips::RA   : case Mips::F31: return 31;
84     default: llvm_unreachable("Unknown register number!");
85   }
86   return 0; // Not reached
87 }
88
89 unsigned MipsRegisterInfo::getPICCallReg() { return Mips::T9; }
90
91 //===----------------------------------------------------------------------===//
92 // Callee Saved Registers methods
93 //===----------------------------------------------------------------------===//
94
95 /// Mips Callee Saved Registers
96 const unsigned* MipsRegisterInfo::
97 getCalleeSavedRegs(const MachineFunction *MF) const
98 {
99   // Mips callee-save register range is $16-$23, $f20-$f30
100   static const unsigned SingleFloatOnlyCalleeSavedRegs[] = {
101     Mips::F30, Mips::F29, Mips::F28, Mips::F27, Mips::F26,
102     Mips::F25, Mips::F24, Mips::F23, Mips::F22, Mips::F21, Mips::F20,
103     Mips::RA, Mips::FP, Mips::S7, Mips::S6, Mips::S5, Mips::S4,
104     Mips::S3, Mips::S2, Mips::S1, Mips::S0, 0
105   };
106
107   static const unsigned Mips32CalleeSavedRegs[] = {
108     Mips::D15, Mips::D14, Mips::D13, Mips::D12, Mips::D11, Mips::D10,
109     Mips::RA, Mips::FP, Mips::S7, Mips::S6, Mips::S5, Mips::S4,
110     Mips::S3, Mips::S2, Mips::S1, Mips::S0, 0
111   };
112
113   if (Subtarget.isSingleFloat())
114     return SingleFloatOnlyCalleeSavedRegs;
115   else
116     return Mips32CalleeSavedRegs;
117 }
118
119 BitVector MipsRegisterInfo::
120 getReservedRegs(const MachineFunction &MF) const {
121   BitVector Reserved(getNumRegs());
122   Reserved.set(Mips::ZERO);
123   Reserved.set(Mips::AT);
124   Reserved.set(Mips::K0);
125   Reserved.set(Mips::K1);
126   Reserved.set(Mips::GP);
127   Reserved.set(Mips::SP);
128   Reserved.set(Mips::FP);
129   Reserved.set(Mips::RA);
130   Reserved.set(Mips::F31);
131   Reserved.set(Mips::D15);
132
133   // SRV4 requires that odd register can't be used.
134   if (!Subtarget.isSingleFloat() && !Subtarget.isMips32())
135     for (unsigned FReg=(Mips::F0)+1; FReg < Mips::F30; FReg+=2)
136       Reserved.set(FReg);
137
138   return Reserved;
139 }
140
141 // This function eliminate ADJCALLSTACKDOWN,
142 // ADJCALLSTACKUP pseudo instructions
143 void MipsRegisterInfo::
144 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
145                               MachineBasicBlock::iterator I) const {
146   // Simply discard ADJCALLSTACKDOWN, ADJCALLSTACKUP instructions.
147   MBB.erase(I);
148 }
149
150 // FrameIndex represent objects inside a abstract stack.
151 // We must replace FrameIndex with an stack/frame pointer
152 // direct reference.
153 void MipsRegisterInfo::
154 eliminateFrameIndex(MachineBasicBlock::iterator II, int SPAdj,
155                     RegScavenger *RS) const {
156   MachineInstr &MI = *II;
157   MachineFunction &MF = *MI.getParent()->getParent();
158   MachineFrameInfo *MFI = MF.getFrameInfo();
159   MipsFunctionInfo *MipsFI = MF.getInfo<MipsFunctionInfo>();
160
161   unsigned i = 0;
162   while (!MI.getOperand(i).isFI()) {
163     ++i;
164     assert(i < MI.getNumOperands() &&
165            "Instr doesn't have FrameIndex operand!");
166   }
167
168   DEBUG(errs() << "\nFunction : " << MF.getFunction()->getName() << "\n";
169         errs() << "<--------->\n" << MI);
170
171   int FrameIndex = MI.getOperand(i).getIndex();
172   int stackSize  = MF.getFrameInfo()->getStackSize();
173   int spOffset   = MF.getFrameInfo()->getObjectOffset(FrameIndex);
174
175   DEBUG(errs() << "FrameIndex : " << FrameIndex << "\n"
176                << "spOffset   : " << spOffset << "\n"
177                << "stackSize  : " << stackSize << "\n");
178
179   int Offset;
180
181   // Calculate final offset.
182   // - There is no need to change the offset if the frame object is one of the
183   //   following: an outgoing argument, pointer to a dynamically allocated
184   //   stack space or a $gp restore location,
185   // - If the frame object is any of the following, its offset must be adjusted
186   //   by adding the size of the stack:
187   //   incoming argument, callee-saved register location or local variable.  
188   if (MipsFI->isOutArgFI(FrameIndex) || MipsFI->isGPFI(FrameIndex) ||
189       MipsFI->isDynAllocFI(FrameIndex))
190     Offset = spOffset;
191   else
192     Offset = spOffset + stackSize;
193
194   Offset    += MI.getOperand(i-1).getImm();
195
196   DEBUG(errs() << "Offset     : " << Offset << "\n" << "<--------->\n");
197
198   unsigned NewReg = 0;
199   int NewImm = 0;
200   MachineBasicBlock &MBB = *MI.getParent();
201   bool ATUsed;
202   unsigned FrameReg;
203   const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
204   int MinCSFI = 0;
205   int MaxCSFI = -1;
206
207   if (CSI.size()) {
208     MinCSFI = CSI[0].getFrameIdx();
209     MaxCSFI = CSI[CSI.size() - 1].getFrameIdx();
210   }
211
212   // The following stack frame objects are always referenced relative to $sp:
213   //  1. Outgoing arguments.
214   //  2. Pointer to dynamically allocated stack space.
215   //  3. Locations for callee-saved registers.
216   // Everything else is referenced relative to whatever register 
217   // getFrameRegister() returns.
218   if (MipsFI->isOutArgFI(FrameIndex) || MipsFI->isDynAllocFI(FrameIndex) ||
219       (FrameIndex >= MinCSFI && FrameIndex <= MaxCSFI))
220     FrameReg = Mips::SP;
221   else
222     FrameReg = getFrameRegister(MF); 
223   
224   // Offset fits in the 16-bit field
225   if (Offset < 0x8000 && Offset >= -0x8000) {
226     NewReg = FrameReg;
227     NewImm = Offset;
228     ATUsed = false;
229   }
230   else {
231     const TargetInstrInfo *TII = MF.getTarget().getInstrInfo();
232     DebugLoc DL = II->getDebugLoc();
233     int ImmLo = (short)(Offset & 0xffff);
234     int ImmHi = (((unsigned)Offset & 0xffff0000) >> 16) +
235                 ((Offset & 0x8000) != 0);
236
237     // FIXME: change this when mips goes MC".
238     BuildMI(MBB, II, DL, TII->get(Mips::NOAT));
239     BuildMI(MBB, II, DL, TII->get(Mips::LUi), Mips::AT).addImm(ImmHi);
240     BuildMI(MBB, II, DL, TII->get(Mips::ADDu), Mips::AT).addReg(FrameReg)
241                                                         .addReg(Mips::AT);
242     NewReg = Mips::AT;
243     NewImm = ImmLo;
244     
245     ATUsed = true;
246   }
247
248   // FIXME: change this when mips goes MC".
249   if (ATUsed)
250     BuildMI(MBB, ++II, MI.getDebugLoc(), TII.get(Mips::ATMACRO));
251
252   MI.getOperand(i).ChangeToRegister(NewReg, false);
253   MI.getOperand(i-1).ChangeToImmediate(NewImm);
254 }
255
256 unsigned MipsRegisterInfo::
257 getRARegister() const {
258   return Mips::RA;
259 }
260
261 unsigned MipsRegisterInfo::
262 getFrameRegister(const MachineFunction &MF) const {
263   const TargetFrameLowering *TFI = MF.getTarget().getFrameLowering();
264
265   return TFI->hasFP(MF) ? Mips::FP : Mips::SP;
266 }
267
268 unsigned MipsRegisterInfo::
269 getEHExceptionRegister() const {
270   llvm_unreachable("What is the exception register");
271   return 0;
272 }
273
274 unsigned MipsRegisterInfo::
275 getEHHandlerRegister() const {
276   llvm_unreachable("What is the exception handler register");
277   return 0;
278 }
279
280 int MipsRegisterInfo::
281 getDwarfRegNum(unsigned RegNum, bool isEH) const {
282   return MipsGenRegisterInfo::getDwarfRegNumFull(RegNum, 0);
283 }
284
285 int MipsRegisterInfo::getLLVMRegNum(unsigned DwarfRegNo, bool isEH) const {
286   return MipsGenRegisterInfo::getLLVMRegNumFull(DwarfRegNo,0);
287 }
288
289 #include "MipsGenRegisterInfo.inc"