Added support for fp callee saved registers.
[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/TargetFrameInfo.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/ADT/BitVector.h"
35 #include "llvm/ADT/STLExtras.h"
36
37 using namespace llvm;
38
39 MipsRegisterInfo::MipsRegisterInfo(const MipsSubtarget &ST, 
40                                    const TargetInstrInfo &tii)
41   : MipsGenRegisterInfo(Mips::ADJCALLSTACKDOWN, Mips::ADJCALLSTACKUP),
42     Subtarget(ST), TII(tii) {}
43
44 /// getRegisterNumbering - Given the enum value for some register, e.g.
45 /// Mips::RA, return the number that it corresponds to (e.g. 31).
46 unsigned MipsRegisterInfo::
47 getRegisterNumbering(unsigned RegEnum) 
48 {
49   switch (RegEnum) {
50     case Mips::ZERO : case Mips::F0 : case Mips::D0 : return 0;
51     case Mips::AT   : case Mips::F1 : return 1;
52     case Mips::V0   : case Mips::F2 : case Mips::D1 : return 2;
53     case Mips::V1   : case Mips::F3 : return 3;
54     case Mips::A0   : case Mips::F4 : case Mips::D2 : return 4;
55     case Mips::A1   : case Mips::F5 : return 5;
56     case Mips::A2   : case Mips::F6 : case Mips::D3 : return 6;
57     case Mips::A3   : case Mips::F7 : return 7;
58     case Mips::T0   : case Mips::F8 : case Mips::D4 : return 8;
59     case Mips::T1   : case Mips::F9 : return 9;
60     case Mips::T2   : case Mips::F10: case Mips::D5: return 10;
61     case Mips::T3   : case Mips::F11: return 11;
62     case Mips::T4   : case Mips::F12: case Mips::D6: return 12;
63     case Mips::T5   : case Mips::F13: return 13;
64     case Mips::T6   : case Mips::F14: case Mips::D7: return 14;
65     case Mips::T7   : case Mips::F15: return 15;
66     case Mips::T8   : case Mips::F16: case Mips::D8: return 16;
67     case Mips::T9   : case Mips::F17: return 17;
68     case Mips::S0   : case Mips::F18: case Mips::D9: return 18;
69     case Mips::S1   : case Mips::F19: return 19;
70     case Mips::S2   : case Mips::F20: case Mips::D10: return 20;
71     case Mips::S3   : case Mips::F21: return 21;
72     case Mips::S4   : case Mips::F22: case Mips::D11: return 22;
73     case Mips::S5   : case Mips::F23: return 23;
74     case Mips::S6   : case Mips::F24: case Mips::D12: return 24;
75     case Mips::S7   : case Mips::F25: return 25;
76     case Mips::K0   : case Mips::F26: case Mips::D13: return 26;
77     case Mips::K1   : case Mips::F27: return 27;
78     case Mips::GP   : case Mips::F28: case Mips::D14: return 28;
79     case Mips::SP   : case Mips::F29: return 29;
80     case Mips::FP   : case Mips::F30: case Mips::D15: return 30;
81     case Mips::RA   : case Mips::F31: return 31;
82     default: assert(0 && "Unknown register number!");
83   }    
84   return 0; // Not reached
85 }
86
87 unsigned MipsRegisterInfo::getPICCallReg(void) { return Mips::T9; }
88
89 //===----------------------------------------------------------------------===//
90 // Callee Saved Registers methods 
91 //===----------------------------------------------------------------------===//
92
93 /// Mips Callee Saved Registers
94 const unsigned* MipsRegisterInfo::
95 getCalleeSavedRegs(const MachineFunction *MF) const 
96 {
97   // Mips callee-save register range is $16-$23, $f20-$f30
98   static const unsigned SingleFloatOnlyCalleeSavedRegs[] = {
99     Mips::S0, Mips::S1, Mips::S2, Mips::S3, 
100     Mips::S4, Mips::S5, Mips::S6, Mips::S7,
101     Mips::F20, Mips::F21, Mips::F22, Mips::F23, Mips::F24, Mips::F25, 
102     Mips::F26, Mips::F27, Mips::F28, Mips::F29, Mips::F30, 0
103   };
104
105   static const unsigned BitMode32CalleeSavedRegs[] = {
106     Mips::S0, Mips::S1, Mips::S2, Mips::S3, 
107     Mips::S4, Mips::S5, Mips::S6, Mips::S7,
108     Mips::F20, Mips::F22, Mips::F24, Mips::F26, Mips::F28, Mips::F30, 
109     Mips::D10, Mips::D11, Mips::D12, Mips::D13, Mips::D14, Mips::D15,0
110   };
111
112   if (Subtarget.isSingleFloat())
113     return SingleFloatOnlyCalleeSavedRegs;
114   else
115     return BitMode32CalleeSavedRegs;
116 }
117
118 /// Mips Callee Saved Register Classes
119 const TargetRegisterClass* const* 
120 MipsRegisterInfo::getCalleeSavedRegClasses(const MachineFunction *MF) const 
121 {
122   static const TargetRegisterClass * const SingleFloatOnlyCalleeSavedRC[] = {
123     &Mips::CPURegsRegClass, &Mips::CPURegsRegClass, &Mips::CPURegsRegClass, 
124     &Mips::CPURegsRegClass, &Mips::CPURegsRegClass, &Mips::CPURegsRegClass,
125     &Mips::CPURegsRegClass, &Mips::CPURegsRegClass,
126     &Mips::FGR32RegClass, &Mips::FGR32RegClass, &Mips::FGR32RegClass, 
127     &Mips::FGR32RegClass, &Mips::FGR32RegClass, &Mips::FGR32RegClass, 
128     &Mips::FGR32RegClass, &Mips::FGR32RegClass, &Mips::FGR32RegClass, 
129     &Mips::FGR32RegClass, &Mips::FGR32RegClass, 0
130   };
131
132   static const TargetRegisterClass * const BitMode32CalleeSavedRC[] = {
133     &Mips::CPURegsRegClass, &Mips::CPURegsRegClass, &Mips::CPURegsRegClass, 
134     &Mips::CPURegsRegClass, &Mips::CPURegsRegClass, &Mips::CPURegsRegClass,
135     &Mips::CPURegsRegClass, &Mips::CPURegsRegClass,
136     &Mips::AFGR32RegClass, &Mips::AFGR32RegClass, &Mips::AFGR32RegClass, 
137     &Mips::AFGR32RegClass, &Mips::AFGR32RegClass, &Mips::AFGR32RegClass,
138     &Mips::AFGR64RegClass, &Mips::AFGR64RegClass, &Mips::AFGR64RegClass, 
139     &Mips::AFGR64RegClass, &Mips::AFGR64RegClass, &Mips::AFGR64RegClass, 0
140   };
141
142   if (Subtarget.isSingleFloat())
143     return SingleFloatOnlyCalleeSavedRC;
144   else
145     return BitMode32CalleeSavedRC;
146 }
147
148 BitVector MipsRegisterInfo::
149 getReservedRegs(const MachineFunction &MF) const
150 {
151   BitVector Reserved(getNumRegs());
152   Reserved.set(Mips::ZERO);
153   Reserved.set(Mips::AT);
154   Reserved.set(Mips::K0);
155   Reserved.set(Mips::K1);
156   Reserved.set(Mips::GP);
157   Reserved.set(Mips::SP);
158   Reserved.set(Mips::FP);
159   Reserved.set(Mips::RA);
160   return Reserved;
161 }
162
163 //===----------------------------------------------------------------------===//
164 //
165 // Stack Frame Processing methods
166 // +----------------------------+
167 //
168 // The stack is allocated decrementing the stack pointer on
169 // the first instruction of a function prologue. Once decremented,
170 // all stack referencesare are done thought a positive offset
171 // from the stack/frame pointer, so the stack is considering
172 // to grow up! Otherwise terrible hacks would have to be made
173 // to get this stack ABI compliant :)
174 //
175 //  The stack frame required by the ABI (after call):
176 //  Offset
177 //
178 //  0                 ----------
179 //  4                 Args to pass 
180 //  .                 saved $GP  (used in PIC)
181 //  .                 Alloca allocations
182 //  .                 Local Area
183 //  .                 CPU "Callee Saved" Registers
184 //  .                 saved FP
185 //  .                 saved RA
186 //  .                 FPU "Callee Saved" Registers
187 //  StackSize         -----------
188 //
189 // Offset - offset from sp after stack allocation on function prologue
190 //
191 // The sp is the stack pointer subtracted/added from the stack size
192 // at the Prologue/Epilogue
193 //
194 // References to the previous stack (to obtain arguments) are done
195 // with offsets that exceeds the stack size: (stacksize+(4*(num_arg-1))
196 //
197 // Examples:
198 // - reference to the actual stack frame
199 //   for any local area var there is smt like : FI >= 0, StackOffset: 4
200 //     sw REGX, 4(SP)
201 //
202 // - reference to previous stack frame
203 //   suppose there's a load to the 5th arguments : FI < 0, StackOffset: 16.
204 //   The emitted instruction will be something like:
205 //     lw REGX, 16+StackSize(SP)
206 //
207 // Since the total stack size is unknown on LowerFORMAL_ARGUMENTS, all
208 // stack references (ObjectOffset) created to reference the function 
209 // arguments, are negative numbers. This way, on eliminateFrameIndex it's
210 // possible to detect those references and the offsets are adjusted to
211 // their real location.
212 //
213 //===----------------------------------------------------------------------===//
214
215 void MipsRegisterInfo::adjustMipsStackFrame(MachineFunction &MF) const
216 {
217   MachineFrameInfo *MFI = MF.getFrameInfo();
218   MipsFunctionInfo *MipsFI = MF.getInfo<MipsFunctionInfo>();
219   const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
220   unsigned StackAlign = MF.getTarget().getFrameInfo()->getStackAlignment();
221
222   // Min and Max CSI FrameIndex.
223   int MinCSFI = -1, MaxCSFI = -1; 
224
225   // See the description at MipsMachineFunction.h
226   int TopCPUSavedRegOff = -1, TopFPUSavedRegOff = -1;
227
228   // Replace the dummy '0' SPOffset by the negative offsets, as explained on 
229   // LowerFORMAL_ARGUMENTS. Leaving '0' for while is necessary to avoid 
230   // the approach done by calculateFrameObjectOffsets to the stack frame.
231   MipsFI->adjustLoadArgsFI(MFI);
232   MipsFI->adjustStoreVarArgsFI(MFI); 
233
234   // It happens that the default stack frame allocation order does not directly 
235   // map to the convention used for mips. So we must fix it. We move the callee 
236   // save register slots after the local variables area, as described in the
237   // stack frame above.
238   unsigned CalleeSavedAreaSize = 0;
239   if (!CSI.empty()) {
240     MinCSFI = CSI[0].getFrameIdx();
241     MaxCSFI = CSI[CSI.size()-1].getFrameIdx();
242   }
243   for (unsigned i = 0, e = CSI.size(); i != e; ++i)
244     CalleeSavedAreaSize += MFI->getObjectAlignment(CSI[i].getFrameIdx());
245
246   // Adjust local variables. They should come on the stack right
247   // after the arguments.
248   int LastOffsetFI = -1;
249   for (int i = 0, e = MFI->getObjectIndexEnd(); i != e; ++i) {
250     if (i >= MinCSFI && i <= MaxCSFI)
251       continue;
252     unsigned Offset = MFI->getObjectOffset(i) - CalleeSavedAreaSize;
253     if (LastOffsetFI == -1)
254       LastOffsetFI = i;
255     if (Offset > MFI->getObjectOffset(LastOffsetFI))
256       LastOffsetFI = i;
257     MFI->setObjectOffset(i, Offset);
258   }
259
260   // Adjust CPU Callee Saved Registers Area. Registers RA and FP must
261   // be saved in this CPU Area there is the need. This whole Area must 
262   // be aligned to the default Stack Alignment requirements.
263   unsigned StackOffset = 0;
264   unsigned RegSize = Subtarget.isGP32bit() ? 4 : 8;
265
266   if (LastOffsetFI >= 0)
267     StackOffset = MFI->getObjectOffset(LastOffsetFI)+ 
268                   MFI->getObjectAlignment(LastOffsetFI);
269
270   for (unsigned i = 0, e = CSI.size(); i != e ; ++i) {
271     if (CSI[i].getRegClass() != Mips::CPURegsRegisterClass)
272       break;
273     MFI->setObjectOffset(CSI[i].getFrameIdx(), StackOffset);
274     TopCPUSavedRegOff = StackOffset;
275     StackOffset += MFI->getObjectAlignment(CSI[i].getFrameIdx());
276   }
277
278   if (hasFP(MF)) {
279     MFI->setObjectOffset(MFI->CreateStackObject(RegSize, RegSize), 
280                          StackOffset);
281     MipsFI->setFPStackOffset(StackOffset);
282     TopCPUSavedRegOff = StackOffset;
283     StackOffset += RegSize;
284   }
285
286   if (MFI->hasCalls()) {
287     MFI->setObjectOffset(MFI->CreateStackObject(RegSize, RegSize), 
288                          StackOffset);
289     MipsFI->setRAStackOffset(StackOffset);
290     TopCPUSavedRegOff = StackOffset;
291     StackOffset += RegSize;
292   }
293   StackOffset = ((StackOffset+StackAlign-1)/StackAlign*StackAlign);
294   
295   // Adjust FPU Callee Saved Registers Area. This Area must be 
296   // aligned to the default Stack Alignment requirements.
297   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
298     if (CSI[i].getRegClass() == Mips::CPURegsRegisterClass)
299       continue;
300     MFI->setObjectOffset(CSI[i].getFrameIdx(), StackOffset);
301     TopFPUSavedRegOff = StackOffset;
302     StackOffset += MFI->getObjectAlignment(CSI[i].getFrameIdx());
303   }
304   StackOffset = ((StackOffset+StackAlign-1)/StackAlign*StackAlign);
305
306   // Update frame info
307   MFI->setStackSize(StackOffset);
308
309   // Recalculate the final tops offset. The final values must be '0'
310   // if there isn't a callee saved register for CPU or FPU, otherwise
311   // a negative offset is needed.
312   if (TopCPUSavedRegOff >= 0)
313     MipsFI->setCPUTopSavedRegOff(TopCPUSavedRegOff-StackOffset);
314
315   if (TopFPUSavedRegOff >= 0)
316     MipsFI->setFPUTopSavedRegOff(TopFPUSavedRegOff-StackOffset);
317 }
318
319 // hasFP - Return true if the specified function should have a dedicated frame
320 // pointer register.  This is true if the function has variable sized allocas or
321 // if frame pointer elimination is disabled.
322 bool MipsRegisterInfo::
323 hasFP(const MachineFunction &MF) const {
324   return (NoFramePointerElim || MF.getFrameInfo()->hasVarSizedObjects());
325 }
326
327 // This function eliminate ADJCALLSTACKDOWN, 
328 // ADJCALLSTACKUP pseudo instructions
329 void MipsRegisterInfo::
330 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
331                               MachineBasicBlock::iterator I) const {
332   // Simply discard ADJCALLSTACKDOWN, ADJCALLSTACKUP instructions.
333   MBB.erase(I);
334 }
335
336 // FrameIndex represent objects inside a abstract stack.
337 // We must replace FrameIndex with an stack/frame pointer
338 // direct reference.
339 void MipsRegisterInfo::
340 eliminateFrameIndex(MachineBasicBlock::iterator II, int SPAdj, 
341                     RegScavenger *RS) const 
342 {
343   MachineInstr &MI = *II;
344   MachineFunction &MF = *MI.getParent()->getParent();
345
346   unsigned i = 0;
347   while (!MI.getOperand(i).isFrameIndex()) {
348     ++i;
349     assert(i < MI.getNumOperands() && 
350            "Instr doesn't have FrameIndex operand!");
351   }
352
353   #ifndef NDEBUG
354   DOUT << "\nFunction : " << MF.getFunction()->getName() << "\n";
355   DOUT << "<--------->\n";
356   MI.print(DOUT);
357   #endif
358
359   int FrameIndex = MI.getOperand(i).getIndex();
360   int stackSize  = MF.getFrameInfo()->getStackSize();
361   int spOffset   = MF.getFrameInfo()->getObjectOffset(FrameIndex);
362
363   #ifndef NDEBUG
364   DOUT << "FrameIndex : " << FrameIndex << "\n";
365   DOUT << "spOffset   : " << spOffset << "\n";
366   DOUT << "stackSize  : " << stackSize << "\n";
367   #endif
368
369   // as explained on LowerFORMAL_ARGUMENTS, detect negative offsets 
370   // and adjust SPOffsets considering the final stack size.
371   int Offset = ((spOffset < 0) ? (stackSize + (-(spOffset+4))) : (spOffset));
372   Offset    += MI.getOperand(i-1).getImm();
373
374   #ifndef NDEBUG
375   DOUT << "Offset     : " << Offset << "\n";
376   DOUT << "<--------->\n";
377   #endif
378
379   MI.getOperand(i-1).ChangeToImmediate(Offset);
380   MI.getOperand(i).ChangeToRegister(getFrameRegister(MF), false);
381 }
382
383 void MipsRegisterInfo::
384 emitPrologue(MachineFunction &MF) const 
385 {
386   MachineBasicBlock &MBB   = MF.front();
387   MachineFrameInfo *MFI    = MF.getFrameInfo();
388   MipsFunctionInfo *MipsFI = MF.getInfo<MipsFunctionInfo>();
389   MachineBasicBlock::iterator MBBI = MBB.begin();
390   bool isPIC = (MF.getTarget().getRelocationModel() == Reloc::PIC_);
391
392   // Get the right frame order for Mips.
393   adjustMipsStackFrame(MF);
394
395   // Get the number of bytes to allocate from the FrameInfo.
396   unsigned StackSize = MFI->getStackSize();
397
398   // No need to allocate space on the stack.
399   if (StackSize == 0 && !MFI->hasCalls()) return;
400
401   int FPOffset = MipsFI->getFPStackOffset();
402   int RAOffset = MipsFI->getRAStackOffset();
403
404   BuildMI(MBB, MBBI, TII.get(Mips::NOREORDER));
405   
406   // TODO: check need from GP here.
407   if (isPIC && Subtarget.isABI_O32()) 
408     BuildMI(MBB, MBBI, TII.get(Mips::CPLOAD)).addReg(getPICCallReg());
409   BuildMI(MBB, MBBI, TII.get(Mips::NOMACRO));
410
411   // Adjust stack : addi sp, sp, (-imm)
412   BuildMI(MBB, MBBI, TII.get(Mips::ADDiu), Mips::SP)
413       .addReg(Mips::SP).addImm(-StackSize);
414
415   // Save the return address only if the function isnt a leaf one.
416   // sw  $ra, stack_loc($sp)
417   if (MFI->hasCalls()) { 
418     BuildMI(MBB, MBBI, TII.get(Mips::SW))
419         .addReg(Mips::RA).addImm(RAOffset).addReg(Mips::SP);
420   }
421
422   // if framepointer enabled, save it and set it
423   // to point to the stack pointer
424   if (hasFP(MF)) {
425     // sw  $fp,stack_loc($sp)
426     BuildMI(MBB, MBBI, TII.get(Mips::SW))
427       .addReg(Mips::FP).addImm(FPOffset).addReg(Mips::SP);
428
429     // move $fp, $sp
430     BuildMI(MBB, MBBI, TII.get(Mips::ADDu), Mips::FP)
431       .addReg(Mips::SP).addReg(Mips::ZERO);
432   }
433
434   // PIC speficic function prologue
435   if ((isPIC) && (MFI->hasCalls())) {
436     BuildMI(MBB, MBBI, TII.get(Mips::CPRESTORE))
437       .addImm(MipsFI->getGPStackOffset());
438   }
439 }
440
441 void MipsRegisterInfo::
442 emitEpilogue(MachineFunction &MF, MachineBasicBlock &MBB) const 
443 {
444   MachineBasicBlock::iterator MBBI = prior(MBB.end());
445   MachineFrameInfo *MFI            = MF.getFrameInfo();
446   MipsFunctionInfo *MipsFI         = MF.getInfo<MipsFunctionInfo>();
447
448   // Get the number of bytes from FrameInfo
449   int NumBytes = (int) MFI->getStackSize();
450
451   // Get the FI's where RA and FP are saved.
452   int FPOffset = MipsFI->getFPStackOffset();
453   int RAOffset = MipsFI->getRAStackOffset();
454
455   // if framepointer enabled, restore it and restore the
456   // stack pointer
457   if (hasFP(MF)) {
458     // move $sp, $fp
459     BuildMI(MBB, MBBI, TII.get(Mips::ADDu), Mips::SP)
460       .addReg(Mips::FP).addReg(Mips::ZERO);
461
462     // lw  $fp,stack_loc($sp)
463     BuildMI(MBB, MBBI, TII.get(Mips::LW))
464       .addReg(Mips::FP).addImm(FPOffset).addReg(Mips::SP);
465   }
466
467   // Restore the return address only if the function isnt a leaf one.
468   // lw  $ra, stack_loc($sp)
469   if (MFI->hasCalls()) { 
470     BuildMI(MBB, MBBI, TII.get(Mips::LW))
471       .addReg(Mips::RA).addImm(RAOffset).addReg(Mips::SP);
472   }
473
474   // adjust stack  : insert addi sp, sp, (imm)
475   if (NumBytes) {
476     BuildMI(MBB, MBBI, TII.get(Mips::ADDiu), Mips::SP)
477       .addReg(Mips::SP).addImm(NumBytes);
478   }
479 }
480
481
482 void MipsRegisterInfo::
483 processFunctionBeforeFrameFinalized(MachineFunction &MF) const {
484   // Set the SPOffset on the FI where GP must be saved/loaded.
485   MachineFrameInfo *MFI = MF.getFrameInfo();
486   bool isPIC = (MF.getTarget().getRelocationModel() == Reloc::PIC_);
487   if (MFI->hasCalls() && isPIC) { 
488     MipsFunctionInfo *MipsFI = MF.getInfo<MipsFunctionInfo>();
489     MFI->setObjectOffset(MipsFI->getGPFI(), MipsFI->getGPStackOffset());
490   }    
491 }
492
493 unsigned MipsRegisterInfo::
494 getRARegister() const {
495   return Mips::RA;
496 }
497
498 unsigned MipsRegisterInfo::
499 getFrameRegister(MachineFunction &MF) const {
500   return hasFP(MF) ? Mips::FP : Mips::SP;
501 }
502
503 unsigned MipsRegisterInfo::
504 getEHExceptionRegister() const {
505   assert(0 && "What is the exception register");
506   return 0;
507 }
508
509 unsigned MipsRegisterInfo::
510 getEHHandlerRegister() const {
511   assert(0 && "What is the exception handler register");
512   return 0;
513 }
514
515 int MipsRegisterInfo::
516 getDwarfRegNum(unsigned RegNum, bool isEH) const {
517   assert(0 && "What is the dwarf register number");
518   return -1;
519 }
520
521 #include "MipsGenRegisterInfo.inc"
522