e15176eb06bec8d17df01adbf3e2a387233a69be
[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-reg-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/CodeGen/MachineLocation.h"
29 #include "llvm/Target/TargetFrameInfo.h"
30 #include "llvm/Target/TargetMachine.h"
31 #include "llvm/Target/TargetOptions.h"
32 #include "llvm/Target/TargetInstrInfo.h"
33 #include "llvm/Support/CommandLine.h"
34 #include "llvm/Support/Debug.h"
35 #include "llvm/Support/ErrorHandling.h"
36 #include "llvm/Support/raw_ostream.h"
37 #include "llvm/ADT/BitVector.h"
38 #include "llvm/ADT/STLExtras.h"
39
40 using namespace llvm;
41
42 MBlazeRegisterInfo::
43 MBlazeRegisterInfo(const MBlazeSubtarget &ST, const TargetInstrInfo &tii)
44   : MBlazeGenRegisterInfo(MBlaze::ADJCALLSTACKDOWN, MBlaze::ADJCALLSTACKUP),
45     Subtarget(ST), TII(tii) {}
46
47 /// getRegisterNumbering - Given the enum value for some register, e.g.
48 /// MBlaze::R0, return the number that it corresponds to (e.g. 0).
49 unsigned MBlazeRegisterInfo::getRegisterNumbering(unsigned RegEnum) {
50   switch (RegEnum) {
51     case MBlaze::R0  : case MBlaze::F0  : return 0;
52     case MBlaze::R1  : case MBlaze::F1  : return 1;
53     case MBlaze::R2  : case MBlaze::F2  : return 2;
54     case MBlaze::R3  : case MBlaze::F3  : return 3;
55     case MBlaze::R4  : case MBlaze::F4  : return 4;
56     case MBlaze::R5  : case MBlaze::F5  : return 5;
57     case MBlaze::R6  : case MBlaze::F6  : return 6;
58     case MBlaze::R7  : case MBlaze::F7  : return 7;
59     case MBlaze::R8  : case MBlaze::F8  : return 8;
60     case MBlaze::R9  : case MBlaze::F9  : return 9;
61     case MBlaze::R10 : case MBlaze::F10 : return 10;
62     case MBlaze::R11 : case MBlaze::F11 : return 11;
63     case MBlaze::R12 : case MBlaze::F12 : return 12;
64     case MBlaze::R13 : case MBlaze::F13 : return 13;
65     case MBlaze::R14 : case MBlaze::F14 : return 14;
66     case MBlaze::R15 : case MBlaze::F15 : return 15;
67     case MBlaze::R16 : case MBlaze::F16 : return 16;
68     case MBlaze::R17 : case MBlaze::F17 : return 17;
69     case MBlaze::R18 : case MBlaze::F18 : return 18;
70     case MBlaze::R19 : case MBlaze::F19 : return 19;
71     case MBlaze::R20 : case MBlaze::F20 : return 20;
72     case MBlaze::R21 : case MBlaze::F21 : return 21;
73     case MBlaze::R22 : case MBlaze::F22 : return 22;
74     case MBlaze::R23 : case MBlaze::F23 : return 23;
75     case MBlaze::R24 : case MBlaze::F24 : return 24;
76     case MBlaze::R25 : case MBlaze::F25 : return 25;
77     case MBlaze::R26 : case MBlaze::F26 : return 26;
78     case MBlaze::R27 : case MBlaze::F27 : return 27;
79     case MBlaze::R28 : case MBlaze::F28 : return 28;
80     case MBlaze::R29 : case MBlaze::F29 : return 29;
81     case MBlaze::R30 : case MBlaze::F30 : return 30;
82     case MBlaze::R31 : case MBlaze::F31 : return 31;
83     default: llvm_unreachable("Unknown register number!");
84   }
85   return 0; // Not reached
86 }
87
88 /// getRegisterFromNumbering - Given the enum value for some register, e.g.
89 /// MBlaze::R0, return the number that it corresponds to (e.g. 0).
90 unsigned MBlazeRegisterInfo::getRegisterFromNumbering(unsigned Reg) {
91   switch (Reg) {
92     case 0  : return MBlaze::R0;
93     case 1  : return MBlaze::R1;
94     case 2  : return MBlaze::R2;
95     case 3  : return MBlaze::R3;
96     case 4  : return MBlaze::R4;
97     case 5  : return MBlaze::R5;
98     case 6  : return MBlaze::R6;
99     case 7  : return MBlaze::R7;
100     case 8  : return MBlaze::R8;
101     case 9  : return MBlaze::R9;
102     case 10 : return MBlaze::R10;
103     case 11 : return MBlaze::R11;
104     case 12 : return MBlaze::R12;
105     case 13 : return MBlaze::R13;
106     case 14 : return MBlaze::R14;
107     case 15 : return MBlaze::R15;
108     case 16 : return MBlaze::R16;
109     case 17 : return MBlaze::R17;
110     case 18 : return MBlaze::R18;
111     case 19 : return MBlaze::R19;
112     case 20 : return MBlaze::R20;
113     case 21 : return MBlaze::R21;
114     case 22 : return MBlaze::R22;
115     case 23 : return MBlaze::R23;
116     case 24 : return MBlaze::R24;
117     case 25 : return MBlaze::R25;
118     case 26 : return MBlaze::R26;
119     case 27 : return MBlaze::R27;
120     case 28 : return MBlaze::R28;
121     case 29 : return MBlaze::R29;
122     case 30 : return MBlaze::R30;
123     case 31 : return MBlaze::R31;
124     default: llvm_unreachable("Unknown register number!");
125   }
126   return 0; // Not reached
127 }
128
129 unsigned MBlazeRegisterInfo::getPICCallReg() {
130   return MBlaze::R20;
131 }
132
133 //===----------------------------------------------------------------------===//
134 // Callee Saved Registers methods
135 //===----------------------------------------------------------------------===//
136
137 /// MBlaze Callee Saved Registers
138 const unsigned* MBlazeRegisterInfo::
139 getCalleeSavedRegs(const MachineFunction *MF) const {
140   // MBlaze callee-save register range is R20 - R31
141   static const unsigned CalleeSavedRegs[] = {
142     MBlaze::R20, MBlaze::R21, MBlaze::R22, MBlaze::R23,
143     MBlaze::R24, MBlaze::R25, MBlaze::R26, MBlaze::R27,
144     MBlaze::R28, MBlaze::R29, MBlaze::R30, MBlaze::R31,
145     0
146   };
147
148   return CalleeSavedRegs;
149 }
150
151 /// MBlaze Callee Saved Register Classes
152 const TargetRegisterClass* const* MBlazeRegisterInfo::
153 getCalleeSavedRegClasses(const MachineFunction *MF) const {
154   static const TargetRegisterClass * const CalleeSavedRC[] = {
155     &MBlaze::CPURegsRegClass, &MBlaze::CPURegsRegClass,
156     &MBlaze::CPURegsRegClass, &MBlaze::CPURegsRegClass,
157     &MBlaze::CPURegsRegClass, &MBlaze::CPURegsRegClass,
158     &MBlaze::CPURegsRegClass, &MBlaze::CPURegsRegClass,
159     &MBlaze::CPURegsRegClass, &MBlaze::CPURegsRegClass,
160     &MBlaze::CPURegsRegClass, &MBlaze::CPURegsRegClass,
161     0
162   };
163
164   return CalleeSavedRC;
165 }
166
167 BitVector MBlazeRegisterInfo::
168 getReservedRegs(const MachineFunction &MF) const {
169   BitVector Reserved(getNumRegs());
170   Reserved.set(MBlaze::R0);
171   Reserved.set(MBlaze::R1);
172   Reserved.set(MBlaze::R2);
173   Reserved.set(MBlaze::R13);
174   Reserved.set(MBlaze::R14);
175   Reserved.set(MBlaze::R15);
176   Reserved.set(MBlaze::R16);
177   Reserved.set(MBlaze::R17);
178   Reserved.set(MBlaze::R18);
179   Reserved.set(MBlaze::R19);
180   return Reserved;
181 }
182
183 //===----------------------------------------------------------------------===//
184 //
185 // Stack Frame Processing methods
186 // +----------------------------+
187 //
188 // The stack is allocated decrementing the stack pointer on
189 // the first instruction of a function prologue. Once decremented,
190 // all stack references are are done through a positive offset
191 // from the stack/frame pointer, so the stack is considered
192 // to grow up.
193 //
194 //===----------------------------------------------------------------------===//
195
196 void MBlazeRegisterInfo::adjustMBlazeStackFrame(MachineFunction &MF) const {
197   MachineFrameInfo *MFI = MF.getFrameInfo();
198   MBlazeFunctionInfo *MBlazeFI = MF.getInfo<MBlazeFunctionInfo>();
199
200   // See the description at MicroBlazeMachineFunction.h
201   int TopCPUSavedRegOff = -1;
202
203   // Adjust CPU Callee Saved Registers Area. Registers RA and FP must
204   // be saved in this CPU Area there is the need. This whole Area must
205   // be aligned to the default Stack Alignment requirements.
206   unsigned StackOffset = MFI->getStackSize();
207   unsigned RegSize = 4;
208
209   // Replace the dummy '0' SPOffset by the negative offsets, as explained on
210   // LowerFORMAL_ARGUMENTS. Leaving '0' for while is necessary to avoid
211   // the approach done by calculateFrameObjectOffsets to the stack frame.
212   MBlazeFI->adjustLoadArgsFI(MFI);
213   MBlazeFI->adjustStoreVarArgsFI(MFI);
214
215   if (hasFP(MF)) {
216     MFI->setObjectOffset(MFI->CreateStackObject(RegSize, RegSize, true),
217                          StackOffset);
218     MBlazeFI->setFPStackOffset(StackOffset);
219     TopCPUSavedRegOff = StackOffset;
220     StackOffset += RegSize;
221   }
222
223   if (MFI->hasCalls()) {
224     MBlazeFI->setRAStackOffset(0);
225     MFI->setObjectOffset(MFI->CreateStackObject(RegSize, RegSize, true),
226                          StackOffset);
227     TopCPUSavedRegOff = StackOffset;
228     StackOffset += RegSize;
229   }
230
231   // Update frame info
232   MFI->setStackSize(StackOffset);
233
234   // Recalculate the final tops offset. The final values must be '0'
235   // if there isn't a callee saved register for CPU or FPU, otherwise
236   // a negative offset is needed.
237   if (TopCPUSavedRegOff >= 0)
238     MBlazeFI->setCPUTopSavedRegOff(TopCPUSavedRegOff-StackOffset);
239 }
240
241 // hasFP - Return true if the specified function should have a dedicated frame
242 // pointer register.  This is true if the function has variable sized allocas or
243 // if frame pointer elimination is disabled.
244 bool MBlazeRegisterInfo::hasFP(const MachineFunction &MF) const {
245   const MachineFrameInfo *MFI = MF.getFrameInfo();
246   return DisableFramePointerElim(MF) || MFI->hasVarSizedObjects();
247 }
248
249 // This function eliminate ADJCALLSTACKDOWN,
250 // ADJCALLSTACKUP pseudo instructions
251 void MBlazeRegisterInfo::
252 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
253                               MachineBasicBlock::iterator I) const {
254   // Simply discard ADJCALLSTACKDOWN, ADJCALLSTACKUP instructions.
255   MBB.erase(I);
256 }
257
258 // FrameIndex represent objects inside a abstract stack.
259 // We must replace FrameIndex with an stack/frame pointer
260 // direct reference.
261 unsigned MBlazeRegisterInfo::
262 eliminateFrameIndex(MachineBasicBlock::iterator II, int SPAdj,
263                     FrameIndexValue *Value, RegScavenger *RS) const {
264   MachineInstr &MI = *II;
265   MachineFunction &MF = *MI.getParent()->getParent();
266
267   unsigned i = 0;
268   while (!MI.getOperand(i).isFI()) {
269     ++i;
270     assert(i < MI.getNumOperands() &&
271            "Instr doesn't have FrameIndex operand!");
272   }
273
274   unsigned oi = i == 2 ? 1 : 2;
275
276   DEBUG(errs() << "\nFunction : " << MF.getFunction()->getName() << "\n";
277         errs() << "<--------->\n" << MI);
278
279   int FrameIndex = MI.getOperand(i).getIndex();
280   int stackSize  = MF.getFrameInfo()->getStackSize();
281   int spOffset   = MF.getFrameInfo()->getObjectOffset(FrameIndex);
282
283   DEBUG(errs() << "FrameIndex : " << FrameIndex << "\n"
284                << "spOffset   : " << spOffset << "\n"
285                << "stackSize  : " << stackSize << "\n");
286
287   // as explained on LowerFormalArguments, detect negative offsets
288   // and adjust SPOffsets considering the final stack size.
289   int Offset = (spOffset < 0) ? (stackSize - spOffset) : (spOffset + 4);
290   Offset    += MI.getOperand(oi).getImm();
291
292   DEBUG(errs() << "Offset     : " << Offset << "\n" << "<--------->\n");
293
294   MI.getOperand(oi).ChangeToImmediate(Offset);
295   MI.getOperand(i).ChangeToRegister(getFrameRegister(MF), false);
296   return 0;
297 }
298
299 void MBlazeRegisterInfo::
300 emitPrologue(MachineFunction &MF) const {
301   MachineBasicBlock &MBB   = MF.front();
302   MachineFrameInfo *MFI    = MF.getFrameInfo();
303   MBlazeFunctionInfo *MBlazeFI = MF.getInfo<MBlazeFunctionInfo>();
304   MachineBasicBlock::iterator MBBI = MBB.begin();
305   DebugLoc DL = MBBI != MBB.end() ? MBBI->getDebugLoc() : DebugLoc();
306
307   // Get the right frame order for MBlaze.
308   adjustMBlazeStackFrame(MF);
309
310   // Get the number of bytes to allocate from the FrameInfo.
311   unsigned StackSize = MFI->getStackSize();
312
313   // No need to allocate space on the stack.
314   if (StackSize == 0 && !MFI->hasCalls()) return;
315   if (StackSize < 28 && MFI->hasCalls()) StackSize = 28;
316
317   int FPOffset = MBlazeFI->getFPStackOffset();
318   int RAOffset = MBlazeFI->getRAStackOffset();
319
320   // Adjust stack : addi R1, R1, -imm
321   BuildMI(MBB, MBBI, DL, TII.get(MBlaze::ADDI), MBlaze::R1)
322       .addReg(MBlaze::R1).addImm(-StackSize);
323
324   // Save the return address only if the function isnt a leaf one.
325   // swi  R15, R1, stack_loc
326   if (MFI->hasCalls()) {
327     BuildMI(MBB, MBBI, DL, TII.get(MBlaze::SWI))
328         .addReg(MBlaze::R15).addImm(RAOffset).addReg(MBlaze::R1);
329   }
330
331   // if framepointer enabled, save it and set it
332   // to point to the stack pointer
333   if (hasFP(MF)) {
334     // swi  R19, R1, stack_loc
335     BuildMI(MBB, MBBI, DL, TII.get(MBlaze::SWI))
336       .addReg(MBlaze::R19).addImm(FPOffset).addReg(MBlaze::R1);
337
338     // add R19, R1, R0
339     BuildMI(MBB, MBBI, DL, TII.get(MBlaze::ADD), MBlaze::R19)
340       .addReg(MBlaze::R1).addReg(MBlaze::R0);
341   }
342 }
343
344 void MBlazeRegisterInfo::
345 emitEpilogue(MachineFunction &MF, MachineBasicBlock &MBB) const {
346   MachineBasicBlock::iterator MBBI = prior(MBB.end());
347   MachineFrameInfo *MFI            = MF.getFrameInfo();
348   MBlazeFunctionInfo *MBlazeFI         = MF.getInfo<MBlazeFunctionInfo>();
349   DebugLoc dl = MBBI->getDebugLoc();
350
351   // Get the FI's where RA and FP are saved.
352   int FPOffset = MBlazeFI->getFPStackOffset();
353   int RAOffset = MBlazeFI->getRAStackOffset();
354
355   // if framepointer enabled, restore it and restore the
356   // stack pointer
357   if (hasFP(MF)) {
358     // add R1, R19, R0
359     BuildMI(MBB, MBBI, dl, TII.get(MBlaze::ADD), MBlaze::R1)
360       .addReg(MBlaze::R19).addReg(MBlaze::R0);
361
362     // lwi  R19, R1, stack_loc
363     BuildMI(MBB, MBBI, dl, TII.get(MBlaze::LWI), MBlaze::R19)
364       .addImm(FPOffset).addReg(MBlaze::R1);
365   }
366
367   // Restore the return address only if the function isnt a leaf one.
368   // lwi R15, R1, stack_loc
369   if (MFI->hasCalls()) {
370     BuildMI(MBB, MBBI, dl, TII.get(MBlaze::LWI), MBlaze::R15)
371       .addImm(RAOffset).addReg(MBlaze::R1);
372   }
373
374   // Get the number of bytes from FrameInfo
375   int StackSize = (int) MFI->getStackSize();
376   if (StackSize < 28 && MFI->hasCalls()) StackSize = 28;
377
378   // adjust stack.
379   // addi R1, R1, imm
380   if (StackSize) {
381     BuildMI(MBB, MBBI, dl, TII.get(MBlaze::ADDI), MBlaze::R1)
382       .addReg(MBlaze::R1).addImm(StackSize);
383   }
384 }
385
386
387 void MBlazeRegisterInfo::
388 processFunctionBeforeFrameFinalized(MachineFunction &MF) const {
389   // Set the stack offset where GP must be saved/loaded from.
390   MachineFrameInfo *MFI = MF.getFrameInfo();
391   MBlazeFunctionInfo *MBlazeFI = MF.getInfo<MBlazeFunctionInfo>();
392   if (MBlazeFI->needGPSaveRestore())
393     MFI->setObjectOffset(MBlazeFI->getGPFI(), MBlazeFI->getGPStackOffset());
394 }
395
396 unsigned MBlazeRegisterInfo::getRARegister() const {
397   return MBlaze::R15;
398 }
399
400 unsigned MBlazeRegisterInfo::getFrameRegister(const MachineFunction &MF) const {
401   return hasFP(MF) ? MBlaze::R19 : MBlaze::R1;
402 }
403
404 unsigned MBlazeRegisterInfo::getEHExceptionRegister() const {
405   llvm_unreachable("What is the exception register");
406   return 0;
407 }
408
409 unsigned MBlazeRegisterInfo::getEHHandlerRegister() const {
410   llvm_unreachable("What is the exception handler register");
411   return 0;
412 }
413
414 int MBlazeRegisterInfo::getDwarfRegNum(unsigned RegNum, bool isEH) const {
415   llvm_unreachable("What is the dwarf register number");
416   return -1;
417 }
418
419 #include "MBlazeGenRegisterInfo.inc"
420