Make $fp and $ra callee-saved registers and let PrologEpilogInserter handle
[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::S0, Mips::S1, Mips::S2, Mips::S3,
102     Mips::S4, Mips::S5, Mips::S6, Mips::S7, Mips::FP, Mips::RA,
103     Mips::F20, Mips::F21, Mips::F22, Mips::F23, Mips::F24, Mips::F25,
104     Mips::F26, Mips::F27, Mips::F28, Mips::F29, Mips::F30, 0
105   };
106
107   static const unsigned BitMode32CalleeSavedRegs[] = {
108     Mips::S0, Mips::S1, Mips::S2, Mips::S3,
109     Mips::S4, Mips::S5, Mips::S6, Mips::S7, Mips::FP, Mips::RA,
110     Mips::F20, Mips::F22, Mips::F24, Mips::F26, Mips::F28, Mips::F30, 0
111   };
112
113   static const unsigned Mips32CalleeSavedRegs[] = {
114     Mips::S0, Mips::S1, Mips::S2, Mips::S3,
115     Mips::S4, Mips::S5, Mips::S6, Mips::S7, Mips::FP, Mips::RA,
116     Mips::D10, Mips::D11, Mips::D12, Mips::D13, Mips::D14, Mips::D15, 0
117   };
118
119   if (Subtarget.isSingleFloat())
120     return SingleFloatOnlyCalleeSavedRegs;
121   else if (Subtarget.isMips32())
122     return Mips32CalleeSavedRegs;
123   else
124     return BitMode32CalleeSavedRegs;
125 }
126
127 BitVector MipsRegisterInfo::
128 getReservedRegs(const MachineFunction &MF) const {
129   BitVector Reserved(getNumRegs());
130   Reserved.set(Mips::ZERO);
131   Reserved.set(Mips::AT);
132   Reserved.set(Mips::K0);
133   Reserved.set(Mips::K1);
134   Reserved.set(Mips::GP);
135   Reserved.set(Mips::SP);
136   Reserved.set(Mips::FP);
137   Reserved.set(Mips::RA);
138
139   // SRV4 requires that odd register can't be used.
140   if (!Subtarget.isSingleFloat() && !Subtarget.isMips32())
141     for (unsigned FReg=(Mips::F0)+1; FReg < Mips::F30; FReg+=2)
142       Reserved.set(FReg);
143
144   return Reserved;
145 }
146
147 // This function eliminate ADJCALLSTACKDOWN,
148 // ADJCALLSTACKUP pseudo instructions
149 void MipsRegisterInfo::
150 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
151                               MachineBasicBlock::iterator I) const {
152   // Simply discard ADJCALLSTACKDOWN, ADJCALLSTACKUP instructions.
153   MBB.erase(I);
154 }
155
156 // FrameIndex represent objects inside a abstract stack.
157 // We must replace FrameIndex with an stack/frame pointer
158 // direct reference.
159 void MipsRegisterInfo::
160 eliminateFrameIndex(MachineBasicBlock::iterator II, int SPAdj,
161                     RegScavenger *RS) const {
162   MachineInstr &MI = *II;
163   MachineFunction &MF = *MI.getParent()->getParent();
164
165   unsigned i = 0;
166   while (!MI.getOperand(i).isFI()) {
167     ++i;
168     assert(i < MI.getNumOperands() &&
169            "Instr doesn't have FrameIndex operand!");
170   }
171
172   DEBUG(errs() << "\nFunction : " << MF.getFunction()->getName() << "\n";
173         errs() << "<--------->\n" << MI);
174
175   int FrameIndex = MI.getOperand(i).getIndex();
176   int stackSize  = MF.getFrameInfo()->getStackSize();
177   int spOffset   = MF.getFrameInfo()->getObjectOffset(FrameIndex);
178
179   DEBUG(errs() << "FrameIndex : " << FrameIndex << "\n"
180                << "spOffset   : " << spOffset << "\n"
181                << "stackSize  : " << stackSize << "\n");
182
183   // as explained on LowerFormalArguments, detect negative offsets
184   // and adjust SPOffsets considering the final stack size.
185   int Offset = ((spOffset < 0) ? (stackSize + (-(spOffset+4))) : (spOffset));
186   Offset    += MI.getOperand(i-1).getImm();
187
188   DEBUG(errs() << "Offset     : " << Offset << "\n" << "<--------->\n");
189
190   unsigned NewReg = 0;
191   int NewImm = 0;
192   MachineBasicBlock &MBB = *MI.getParent();
193   bool ATUsed;
194   unsigned OrigReg = getFrameRegister(MF);
195   int OrigImm = Offset;
196
197   // OrigImm fits in the 16-bit field
198   if (OrigImm < 0x8000 && OrigImm >= -0x8000) {
199     NewReg = OrigReg;
200     NewImm = OrigImm;
201     ATUsed = false;
202   }
203   else {
204     const TargetInstrInfo *TII = MF.getTarget().getInstrInfo();
205     DebugLoc DL = II->getDebugLoc();
206     int ImmLo = OrigImm & 0xffff;
207     int ImmHi = (((unsigned)OrigImm & 0xffff0000) >> 16) +
208                 ((OrigImm & 0x8000) != 0);
209
210     // FIXME: change this when mips goes MC".
211     BuildMI(MBB, II, DL, TII->get(Mips::NOAT));
212     BuildMI(MBB, II, DL, TII->get(Mips::LUi), Mips::AT).addImm(ImmHi);
213     BuildMI(MBB, II, DL, TII->get(Mips::ADDu), Mips::AT).addReg(OrigReg)
214                                                         .addReg(Mips::AT);
215     NewReg = Mips::AT;
216     NewImm = ImmLo;
217     
218     ATUsed = true;
219   }
220
221   // FIXME: change this when mips goes MC".
222   if (ATUsed)
223     BuildMI(MBB, ++II, MI.getDebugLoc(), TII.get(Mips::ATMACRO));
224
225   MI.getOperand(i).ChangeToRegister(NewReg, false);
226   MI.getOperand(i-1).ChangeToImmediate(NewImm);
227 }
228
229 void MipsRegisterInfo::
230 processFunctionBeforeFrameFinalized(MachineFunction &MF) const {
231   // Set the stack offset where GP must be saved/loaded from.
232   MachineFrameInfo *MFI = MF.getFrameInfo();
233   MipsFunctionInfo *MipsFI = MF.getInfo<MipsFunctionInfo>();
234   if (MipsFI->needGPSaveRestore())
235     MFI->setObjectOffset(MipsFI->getGPFI(), MipsFI->getGPStackOffset());
236 }
237
238 unsigned MipsRegisterInfo::
239 getRARegister() const {
240   return Mips::RA;
241 }
242
243 unsigned MipsRegisterInfo::
244 getFrameRegister(const MachineFunction &MF) const {
245   const TargetFrameLowering *TFI = MF.getTarget().getFrameLowering();
246
247   return TFI->hasFP(MF) ? Mips::FP : Mips::SP;
248 }
249
250 unsigned MipsRegisterInfo::
251 getEHExceptionRegister() const {
252   llvm_unreachable("What is the exception register");
253   return 0;
254 }
255
256 unsigned MipsRegisterInfo::
257 getEHHandlerRegister() const {
258   llvm_unreachable("What is the exception handler register");
259   return 0;
260 }
261
262 int MipsRegisterInfo::
263 getDwarfRegNum(unsigned RegNum, bool isEH) const {
264   llvm_unreachable("What is the dwarf register number");
265   return -1;
266 }
267
268 #include "MipsGenRegisterInfo.inc"