Move getInitialFrameState from TargetFrameInfo to MCAsmInfo (suggestions for
[oota-llvm.git] / lib / Target / MBlaze / MBlazeRegisterInfo.cpp
1 //===- MBlazeRegisterInfo.cpp - MBlaze 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 MBlaze implementation of the TargetRegisterInfo
11 // class.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #define DEBUG_TYPE "mblaze-frame-info"
16
17 #include "MBlaze.h"
18 #include "MBlazeSubtarget.h"
19 #include "MBlazeRegisterInfo.h"
20 #include "MBlazeMachineFunction.h"
21 #include "llvm/Constants.h"
22 #include "llvm/Type.h"
23 #include "llvm/Function.h"
24 #include "llvm/CodeGen/ValueTypes.h"
25 #include "llvm/CodeGen/MachineInstrBuilder.h"
26 #include "llvm/CodeGen/MachineFunction.h"
27 #include "llvm/CodeGen/MachineFrameInfo.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 #define GET_REGINFO_TARGET_DESC
40 #include "MBlazeGenRegisterInfo.inc"
41
42 using namespace llvm;
43
44 MBlazeRegisterInfo::
45 MBlazeRegisterInfo(const MBlazeSubtarget &ST, const TargetInstrInfo &tii)
46   : MBlazeGenRegisterInfo(MBlaze::R15), Subtarget(ST), TII(tii) {}
47
48 /// getRegisterNumbering - Given the enum value for some register, e.g.
49 /// MBlaze::R0, return the number that it corresponds to (e.g. 0).
50 unsigned MBlazeRegisterInfo::getRegisterNumbering(unsigned RegEnum) {
51   switch (RegEnum) {
52     case MBlaze::R0     : return 0;
53     case MBlaze::R1     : return 1;
54     case MBlaze::R2     : return 2;
55     case MBlaze::R3     : return 3;
56     case MBlaze::R4     : return 4;
57     case MBlaze::R5     : return 5;
58     case MBlaze::R6     : return 6;
59     case MBlaze::R7     : return 7;
60     case MBlaze::R8     : return 8;
61     case MBlaze::R9     : return 9;
62     case MBlaze::R10    : return 10;
63     case MBlaze::R11    : return 11;
64     case MBlaze::R12    : return 12;
65     case MBlaze::R13    : return 13;
66     case MBlaze::R14    : return 14;
67     case MBlaze::R15    : return 15;
68     case MBlaze::R16    : return 16;
69     case MBlaze::R17    : return 17;
70     case MBlaze::R18    : return 18;
71     case MBlaze::R19    : return 19;
72     case MBlaze::R20    : return 20;
73     case MBlaze::R21    : return 21;
74     case MBlaze::R22    : return 22;
75     case MBlaze::R23    : return 23;
76     case MBlaze::R24    : return 24;
77     case MBlaze::R25    : return 25;
78     case MBlaze::R26    : return 26;
79     case MBlaze::R27    : return 27;
80     case MBlaze::R28    : return 28;
81     case MBlaze::R29    : return 29;
82     case MBlaze::R30    : return 30;
83     case MBlaze::R31    : return 31;
84     case MBlaze::RPC    : return 0x0000;
85     case MBlaze::RMSR   : return 0x0001;
86     case MBlaze::REAR   : return 0x0003;
87     case MBlaze::RESR   : return 0x0005;
88     case MBlaze::RFSR   : return 0x0007;
89     case MBlaze::RBTR   : return 0x000B;
90     case MBlaze::REDR   : return 0x000D;
91     case MBlaze::RPID   : return 0x1000;
92     case MBlaze::RZPR   : return 0x1001;
93     case MBlaze::RTLBX  : return 0x1002;
94     case MBlaze::RTLBLO : return 0x1003;
95     case MBlaze::RTLBHI : return 0x1004;
96     case MBlaze::RPVR0  : return 0x2000;
97     case MBlaze::RPVR1  : return 0x2001;
98     case MBlaze::RPVR2  : return 0x2002;
99     case MBlaze::RPVR3  : return 0x2003;
100     case MBlaze::RPVR4  : return 0x2004;
101     case MBlaze::RPVR5  : return 0x2005;
102     case MBlaze::RPVR6  : return 0x2006;
103     case MBlaze::RPVR7  : return 0x2007;
104     case MBlaze::RPVR8  : return 0x2008;
105     case MBlaze::RPVR9  : return 0x2009;
106     case MBlaze::RPVR10 : return 0x200A;
107     case MBlaze::RPVR11 : return 0x200B;
108     default: llvm_unreachable("Unknown register number!");
109   }
110   return 0; // Not reached
111 }
112
113 /// getRegisterFromNumbering - Given the enum value for some register, e.g.
114 /// MBlaze::R0, return the number that it corresponds to (e.g. 0).
115 unsigned MBlazeRegisterInfo::getRegisterFromNumbering(unsigned Reg) {
116   switch (Reg) {
117     case 0  : return MBlaze::R0;
118     case 1  : return MBlaze::R1;
119     case 2  : return MBlaze::R2;
120     case 3  : return MBlaze::R3;
121     case 4  : return MBlaze::R4;
122     case 5  : return MBlaze::R5;
123     case 6  : return MBlaze::R6;
124     case 7  : return MBlaze::R7;
125     case 8  : return MBlaze::R8;
126     case 9  : return MBlaze::R9;
127     case 10 : return MBlaze::R10;
128     case 11 : return MBlaze::R11;
129     case 12 : return MBlaze::R12;
130     case 13 : return MBlaze::R13;
131     case 14 : return MBlaze::R14;
132     case 15 : return MBlaze::R15;
133     case 16 : return MBlaze::R16;
134     case 17 : return MBlaze::R17;
135     case 18 : return MBlaze::R18;
136     case 19 : return MBlaze::R19;
137     case 20 : return MBlaze::R20;
138     case 21 : return MBlaze::R21;
139     case 22 : return MBlaze::R22;
140     case 23 : return MBlaze::R23;
141     case 24 : return MBlaze::R24;
142     case 25 : return MBlaze::R25;
143     case 26 : return MBlaze::R26;
144     case 27 : return MBlaze::R27;
145     case 28 : return MBlaze::R28;
146     case 29 : return MBlaze::R29;
147     case 30 : return MBlaze::R30;
148     case 31 : return MBlaze::R31;
149     default: llvm_unreachable("Unknown register number!");
150   }
151   return 0; // Not reached
152 }
153
154 unsigned MBlazeRegisterInfo::getSpecialRegisterFromNumbering(unsigned Reg) {
155   switch (Reg) {
156     case 0x0000 : return MBlaze::RPC;
157     case 0x0001 : return MBlaze::RMSR;
158     case 0x0003 : return MBlaze::REAR;
159     case 0x0005 : return MBlaze::RESR;
160     case 0x0007 : return MBlaze::RFSR;
161     case 0x000B : return MBlaze::RBTR;
162     case 0x000D : return MBlaze::REDR;
163     case 0x1000 : return MBlaze::RPID;
164     case 0x1001 : return MBlaze::RZPR;
165     case 0x1002 : return MBlaze::RTLBX;
166     case 0x1003 : return MBlaze::RTLBLO;
167     case 0x1004 : return MBlaze::RTLBHI;
168     case 0x2000 : return MBlaze::RPVR0;
169     case 0x2001 : return MBlaze::RPVR1;
170     case 0x2002 : return MBlaze::RPVR2;
171     case 0x2003 : return MBlaze::RPVR3;
172     case 0x2004 : return MBlaze::RPVR4;
173     case 0x2005 : return MBlaze::RPVR5;
174     case 0x2006 : return MBlaze::RPVR6;
175     case 0x2007 : return MBlaze::RPVR7;
176     case 0x2008 : return MBlaze::RPVR8;
177     case 0x2009 : return MBlaze::RPVR9;
178     case 0x200A : return MBlaze::RPVR10;
179     case 0x200B : return MBlaze::RPVR11;
180     default: llvm_unreachable("Unknown register number!");
181   }
182   return 0; // Not reached
183 }
184
185 bool MBlazeRegisterInfo::isRegister(unsigned Reg) {
186   return Reg <= 31;
187 }
188
189 bool MBlazeRegisterInfo::isSpecialRegister(unsigned Reg) {
190   switch (Reg) {
191     case 0x0000 : case 0x0001 : case 0x0003 : case 0x0005 : 
192     case 0x0007 : case 0x000B : case 0x000D : case 0x1000 : 
193     case 0x1001 : case 0x1002 : case 0x1003 : case 0x1004 : 
194     case 0x2000 : case 0x2001 : case 0x2002 : case 0x2003 : 
195     case 0x2004 : case 0x2005 : case 0x2006 : case 0x2007 : 
196     case 0x2008 : case 0x2009 : case 0x200A : case 0x200B : 
197       return true;
198
199     default:
200       return false;
201   }
202   return false; // Not reached
203 }
204
205 unsigned MBlazeRegisterInfo::getPICCallReg() {
206   return MBlaze::R20;
207 }
208
209 //===----------------------------------------------------------------------===//
210 // Callee Saved Registers methods
211 //===----------------------------------------------------------------------===//
212
213 /// MBlaze Callee Saved Registers
214 const unsigned* MBlazeRegisterInfo::
215 getCalleeSavedRegs(const MachineFunction *MF) const {
216   // MBlaze callee-save register range is R20 - R31
217   static const unsigned CalleeSavedRegs[] = {
218     MBlaze::R20, MBlaze::R21, MBlaze::R22, MBlaze::R23,
219     MBlaze::R24, MBlaze::R25, MBlaze::R26, MBlaze::R27,
220     MBlaze::R28, MBlaze::R29, MBlaze::R30, MBlaze::R31,
221     0
222   };
223
224   return CalleeSavedRegs;
225 }
226
227 BitVector MBlazeRegisterInfo::
228 getReservedRegs(const MachineFunction &MF) const {
229   BitVector Reserved(getNumRegs());
230   Reserved.set(MBlaze::R0);
231   Reserved.set(MBlaze::R1);
232   Reserved.set(MBlaze::R2);
233   Reserved.set(MBlaze::R13);
234   Reserved.set(MBlaze::R14);
235   Reserved.set(MBlaze::R15);
236   Reserved.set(MBlaze::R16);
237   Reserved.set(MBlaze::R17);
238   Reserved.set(MBlaze::R18);
239   Reserved.set(MBlaze::R19);
240   return Reserved;
241 }
242
243 // This function eliminate ADJCALLSTACKDOWN/ADJCALLSTACKUP pseudo instructions
244 void MBlazeRegisterInfo::
245 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
246                               MachineBasicBlock::iterator I) const {
247   const TargetFrameLowering *TFI = MF.getTarget().getFrameLowering();
248
249   if (!TFI->hasReservedCallFrame(MF)) {
250     // If we have a frame pointer, turn the adjcallstackup instruction into a
251     // 'addi r1, r1, -<amt>' and the adjcallstackdown instruction into
252     // 'addi r1, r1, <amt>'
253     MachineInstr *Old = I;
254     int Amount = Old->getOperand(0).getImm() + 4;
255     if (Amount != 0) {
256       // We need to keep the stack aligned properly.  To do this, we round the
257       // amount of space needed for the outgoing arguments up to the next
258       // alignment boundary.
259       unsigned Align = TFI->getStackAlignment();
260       Amount = (Amount+Align-1)/Align*Align;
261
262       MachineInstr *New;
263       if (Old->getOpcode() == MBlaze::ADJCALLSTACKDOWN) {
264         New = BuildMI(MF,Old->getDebugLoc(),TII.get(MBlaze::ADDIK),MBlaze::R1)
265                 .addReg(MBlaze::R1).addImm(-Amount);
266       } else {
267         assert(Old->getOpcode() == MBlaze::ADJCALLSTACKUP);
268         New = BuildMI(MF,Old->getDebugLoc(),TII.get(MBlaze::ADDIK),MBlaze::R1)
269                 .addReg(MBlaze::R1).addImm(Amount);
270       }
271
272       // Replace the pseudo instruction with a new instruction...
273       MBB.insert(I, New);
274     }
275   }
276
277   // Simply discard ADJCALLSTACKDOWN, ADJCALLSTACKUP instructions.
278   MBB.erase(I);
279 }
280
281 // FrameIndex represent objects inside a abstract stack.
282 // We must replace FrameIndex with an stack/frame pointer
283 // direct reference.
284 void MBlazeRegisterInfo::
285 eliminateFrameIndex(MachineBasicBlock::iterator II, int SPAdj,
286                     RegScavenger *RS) const {
287   MachineInstr &MI = *II;
288   MachineFunction &MF = *MI.getParent()->getParent();
289   MachineFrameInfo *MFI = MF.getFrameInfo();
290
291   unsigned i = 0;
292   while (!MI.getOperand(i).isFI()) {
293     ++i;
294     assert(i < MI.getNumOperands() &&
295            "Instr doesn't have FrameIndex operand!");
296   }
297
298   unsigned oi = i == 2 ? 1 : 2;
299
300   DEBUG(dbgs() << "\nFunction : " << MF.getFunction()->getName() << "\n";
301         dbgs() << "<--------->\n" << MI);
302
303   int FrameIndex = MI.getOperand(i).getIndex();
304   int stackSize  = MFI->getStackSize();
305   int spOffset   = MFI->getObjectOffset(FrameIndex);
306
307   DEBUG(MBlazeFunctionInfo *MBlazeFI = MF.getInfo<MBlazeFunctionInfo>();
308         dbgs() << "FrameIndex : " << FrameIndex << "\n"
309                << "spOffset   : " << spOffset << "\n"
310                << "stackSize  : " << stackSize << "\n"
311                << "isFixed    : " << MFI->isFixedObjectIndex(FrameIndex) << "\n"
312                << "isLiveIn   : " << MBlazeFI->isLiveIn(FrameIndex) << "\n"
313                << "isSpill    : " << MFI->isSpillSlotObjectIndex(FrameIndex)
314                << "\n" );
315
316   // as explained on LowerFormalArguments, detect negative offsets
317   // and adjust SPOffsets considering the final stack size.
318   int Offset = (spOffset < 0) ? (stackSize - spOffset) : spOffset;
319   Offset += MI.getOperand(oi).getImm();
320
321   DEBUG(dbgs() << "Offset     : " << Offset << "\n" << "<--------->\n");
322
323   MI.getOperand(oi).ChangeToImmediate(Offset);
324   MI.getOperand(i).ChangeToRegister(getFrameRegister(MF), false);
325 }
326
327 void MBlazeRegisterInfo::
328 processFunctionBeforeFrameFinalized(MachineFunction &MF) const {
329   // Set the stack offset where GP must be saved/loaded from.
330   MachineFrameInfo *MFI = MF.getFrameInfo();
331   MBlazeFunctionInfo *MBlazeFI = MF.getInfo<MBlazeFunctionInfo>();
332   if (MBlazeFI->needGPSaveRestore())
333     MFI->setObjectOffset(MBlazeFI->getGPFI(), MBlazeFI->getGPStackOffset());
334 }
335
336 unsigned MBlazeRegisterInfo::getFrameRegister(const MachineFunction &MF) const {
337   const TargetFrameLowering *TFI = MF.getTarget().getFrameLowering();
338
339   return TFI->hasFP(MF) ? MBlaze::R19 : MBlaze::R1;
340 }
341
342 unsigned MBlazeRegisterInfo::getEHExceptionRegister() const {
343   llvm_unreachable("What is the exception register");
344   return 0;
345 }
346
347 unsigned MBlazeRegisterInfo::getEHHandlerRegister() const {
348   llvm_unreachable("What is the exception handler register");
349   return 0;
350 }