XCore target: Enable frames larger than 65535 to be lowered
[oota-llvm.git] / lib / Target / XCore / XCoreFrameLowering.cpp
1 //===-- XCoreFrameLowering.cpp - Frame info for XCore Target --------------===//
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 XCore frame information that doesn't fit anywhere else
11 // cleanly...
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "XCoreFrameLowering.h"
16 #include "XCore.h"
17 #include "XCoreInstrInfo.h"
18 #include "XCoreMachineFunctionInfo.h"
19 #include "llvm/CodeGen/MachineFrameInfo.h"
20 #include "llvm/CodeGen/MachineFunction.h"
21 #include "llvm/CodeGen/MachineInstrBuilder.h"
22 #include "llvm/CodeGen/MachineModuleInfo.h"
23 #include "llvm/CodeGen/MachineRegisterInfo.h"
24 #include "llvm/CodeGen/RegisterScavenging.h"
25 #include "llvm/IR/DataLayout.h"
26 #include "llvm/IR/Function.h"
27 #include "llvm/Support/ErrorHandling.h"
28 #include "llvm/Target/TargetOptions.h"
29
30 using namespace llvm;
31
32 static const unsigned FramePtr = XCore::R10;
33 static const int MaxImmU16 = (1<<16) - 1;
34
35 // helper functions. FIXME: Eliminate.
36 static inline bool isImmU6(unsigned val) {
37   return val < (1 << 6);
38 }
39
40 static inline bool isImmU16(unsigned val) {
41   return val < (1 << 16);
42 }
43
44 static void EmitDefCfaRegister(MachineBasicBlock &MBB,
45                                MachineBasicBlock::iterator MBBI, DebugLoc dl,
46                                const TargetInstrInfo &TII,
47                                MachineModuleInfo *MMI, unsigned DRegNum) {
48   MCSymbol *Label = MMI->getContext().CreateTempSymbol();
49   BuildMI(MBB, MBBI, dl, TII.get(XCore::PROLOG_LABEL)).addSym(Label);
50   MMI->addFrameInst(MCCFIInstruction::createDefCfaRegister(Label, DRegNum));
51 }
52
53 static void EmitDefCfaOffset(MachineBasicBlock &MBB,
54                              MachineBasicBlock::iterator MBBI, DebugLoc dl,
55                              const TargetInstrInfo &TII,
56                              MachineModuleInfo *MMI, int Offset) {
57   MCSymbol *Label = MMI->getContext().CreateTempSymbol();
58   BuildMI(MBB, MBBI, dl, TII.get(XCore::PROLOG_LABEL)).addSym(Label);
59   MMI->addFrameInst(MCCFIInstruction::createDefCfaOffset(Label, -Offset));
60 }
61
62 static void EmitCfiOffset(MachineBasicBlock &MBB,
63                           MachineBasicBlock::iterator MBBI, DebugLoc dl,
64                           const TargetInstrInfo &TII, MachineModuleInfo *MMI,
65                           unsigned DRegNum, int Offset, MCSymbol *Label) {
66   if (!Label) {
67     Label = MMI->getContext().CreateTempSymbol();
68     BuildMI(MBB, MBBI, dl, TII.get(XCore::PROLOG_LABEL)).addSym(Label);
69   }
70   MMI->addFrameInst(MCCFIInstruction::createOffset(Label, DRegNum, Offset));
71 }
72
73 /// The SP register is moved in steps of 'MaxImmU16' towards the bottom of the
74 /// frame. During these steps, it may be necessary to spill registers.
75 /// IfNeededExtSP emits the necessary EXTSP instructions to move the SP only
76 /// as far as to make 'OffsetFromBottom' reachable using an STWSP_lru6.
77 /// \param OffsetFromTop the spill offset from the top of the frame.
78 /// \param [in] [out] Adjusted the current SP offset from the top of the frame.
79 static void IfNeededExtSP(MachineBasicBlock &MBB,
80                           MachineBasicBlock::iterator MBBI, DebugLoc dl,
81                           const TargetInstrInfo &TII, MachineModuleInfo *MMI,
82                           int OffsetFromTop, int &Adjusted, int FrameSize,
83                           bool emitFrameMoves) {
84   while (OffsetFromTop > Adjusted) {
85     assert(Adjusted < FrameSize && "OffsetFromTop is beyond FrameSize");
86     int remaining = FrameSize - Adjusted;
87     int OpImm = (remaining > MaxImmU16) ? MaxImmU16 : remaining;
88     int Opcode = isImmU6(OpImm) ? XCore::EXTSP_u6 : XCore::EXTSP_lu6;
89     BuildMI(MBB, MBBI, dl, TII.get(Opcode)).addImm(OpImm);
90     Adjusted += OpImm;
91     if (emitFrameMoves)
92       EmitDefCfaOffset(MBB, MBBI, dl, TII, MMI, Adjusted*4);
93   }
94 }
95
96 /// The SP register is moved in steps of 'MaxImmU16' towards the top of the
97 /// frame. During these steps, it may be necessary to re-load registers.
98 /// IfNeededLDAWSP emits the necessary LDAWSP instructions to move the SP only
99 /// as far as to make 'OffsetFromTop' reachable using an LDAWSP_lru6.
100 /// \param OffsetFromTop the spill offset from the top of the frame.
101 /// \param [in] [out] RemainingAdj the current SP offset from the top of the frame.
102 static void IfNeededLDAWSP(MachineBasicBlock &MBB,
103                            MachineBasicBlock::iterator MBBI, DebugLoc dl,
104                            const TargetInstrInfo &TII, int OffsetFromTop,
105                            int &RemainingAdj) {
106   while (OffsetFromTop < RemainingAdj - MaxImmU16) {
107     assert(RemainingAdj && "OffsetFromTop is beyond FrameSize");
108     int OpImm = (RemainingAdj > MaxImmU16) ? MaxImmU16 : RemainingAdj;
109     int Opcode = isImmU6(OpImm) ? XCore::LDAWSP_ru6 : XCore::LDAWSP_lru6;
110     BuildMI(MBB, MBBI, dl, TII.get(Opcode), XCore::SP).addImm(OpImm);
111     RemainingAdj -= OpImm;
112   }
113 }
114
115 /// Creates an ordered list of registers that are spilled
116 /// during the emitPrologue/emitEpilogue.
117 /// Registers are ordered according to their frame offset.
118 static void GetSpillList(SmallVectorImpl<std::pair<unsigned,int> > &SpillList,
119                          MachineFrameInfo *MFI, XCoreFunctionInfo *XFI,
120                          bool fetchLR, bool fetchFP) {
121   int LRSpillOffset = fetchLR? MFI->getObjectOffset(XFI->getLRSpillSlot()) : 0;
122   int FPSpillOffset = fetchFP? MFI->getObjectOffset(XFI->getFPSpillSlot()) : 0;
123   if (fetchLR && fetchFP && LRSpillOffset > FPSpillOffset) {
124     SpillList.push_back(std::make_pair<unsigned,int>(XCore::LR,LRSpillOffset));
125     fetchLR = false;
126   }
127   if (fetchFP)
128     SpillList.push_back(std::make_pair<unsigned,int>(FramePtr, FPSpillOffset));
129   if (fetchLR)
130     SpillList.push_back(std::make_pair<unsigned,int>(XCore::LR,LRSpillOffset));
131 }
132
133
134 //===----------------------------------------------------------------------===//
135 // XCoreFrameLowering:
136 //===----------------------------------------------------------------------===//
137
138 XCoreFrameLowering::XCoreFrameLowering(const XCoreSubtarget &sti)
139   : TargetFrameLowering(TargetFrameLowering::StackGrowsDown, 4, 0) {
140   // Do nothing
141 }
142
143 bool XCoreFrameLowering::hasFP(const MachineFunction &MF) const {
144   return MF.getTarget().Options.DisableFramePointerElim(MF) ||
145          MF.getFrameInfo()->hasVarSizedObjects();
146 }
147
148 void XCoreFrameLowering::emitPrologue(MachineFunction &MF) const {
149   MachineBasicBlock &MBB = MF.front();   // Prolog goes in entry BB
150   MachineBasicBlock::iterator MBBI = MBB.begin();
151   MachineFrameInfo *MFI = MF.getFrameInfo();
152   MachineModuleInfo *MMI = &MF.getMMI();
153   const MCRegisterInfo *MRI = MMI->getContext().getRegisterInfo();
154   const XCoreInstrInfo &TII =
155     *static_cast<const XCoreInstrInfo*>(MF.getTarget().getInstrInfo());
156   XCoreFunctionInfo *XFI = MF.getInfo<XCoreFunctionInfo>();
157   DebugLoc dl = MBBI != MBB.end() ? MBBI->getDebugLoc() : DebugLoc();
158
159   if (MFI->getMaxAlignment() > getStackAlignment())
160     report_fatal_error("emitPrologue unsupported alignment: "
161                        + Twine(MFI->getMaxAlignment()));
162
163   const AttributeSet &PAL = MF.getFunction()->getAttributes();
164   if (PAL.hasAttrSomewhere(Attribute::Nest))
165     BuildMI(MBB, MBBI, dl, TII.get(XCore::LDWSP_ru6), XCore::R11).addImm(0);
166
167   // Work out frame sizes.
168   // We will adjust the SP in stages towards the final FrameSize.
169   assert(MFI->getStackSize()%4 == 0 && "Misaligned frame size");
170   const int FrameSize = MFI->getStackSize() / 4;
171   int Adjusted = 0;
172
173   bool saveLR = XFI->getUsesLR();
174   bool UseENTSP = saveLR && FrameSize
175                   && (MFI->getObjectOffset(XFI->getLRSpillSlot()) == 0);
176   if (UseENTSP)
177     saveLR = false;
178   bool FP = hasFP(MF);
179   bool emitFrameMoves = XCoreRegisterInfo::needsFrameMoves(MF);
180
181   if (UseENTSP) {
182     // Allocate space on the stack at the same time as saving LR.
183     Adjusted = (FrameSize > MaxImmU16) ? MaxImmU16 : FrameSize;
184     int Opcode = isImmU6(Adjusted) ? XCore::ENTSP_u6 : XCore::ENTSP_lu6;
185     BuildMI(MBB, MBBI, dl, TII.get(Opcode)).addImm(Adjusted);
186     MBB.addLiveIn(XCore::LR);
187     if (emitFrameMoves) {
188       EmitDefCfaOffset(MBB, MBBI, dl, TII, MMI, Adjusted*4);
189       unsigned DRegNum = MRI->getDwarfRegNum(XCore::LR, true);
190       EmitCfiOffset(MBB, MBBI, dl, TII, MMI, DRegNum, 0, NULL);
191     }
192   }
193
194   // If necessary, save LR and FP to the stack, as we EXTSP.
195   SmallVector<std::pair<unsigned,int>,2> SpillList;
196   GetSpillList(SpillList, MFI, XFI, saveLR, FP);
197   for (unsigned i = 0, e = SpillList.size(); i != e; ++i) {
198     unsigned SpillReg = SpillList[i].first;
199     int SpillOffset = SpillList[i].second;
200     assert(SpillOffset % 4 == 0 && "Misaligned stack offset");
201     assert(SpillOffset <= 0 && "Unexpected positive stack offset");
202     int OffsetFromTop = - SpillOffset/4;
203     IfNeededExtSP(MBB, MBBI, dl, TII, MMI, OffsetFromTop, Adjusted, FrameSize,
204                   emitFrameMoves);
205     int Offset = Adjusted - OffsetFromTop;
206     int Opcode = isImmU6(Offset) ? XCore::STWSP_ru6 : XCore::STWSP_lru6;
207     BuildMI(MBB, MBBI, dl, TII.get(Opcode)).addReg(SpillReg).addImm(Offset);
208     MBB.addLiveIn(SpillReg);
209     if (emitFrameMoves) {
210       unsigned DRegNum = MRI->getDwarfRegNum(SpillReg, true);
211       EmitCfiOffset(MBB, MBBI, dl, TII, MMI, DRegNum, SpillOffset, NULL);
212     }
213   }
214
215   // Complete any remaining Stack adjustment.
216   IfNeededExtSP(MBB, MBBI, dl, TII, MMI, FrameSize, Adjusted, FrameSize,
217                 emitFrameMoves);
218   assert(Adjusted==FrameSize && "IfNeededExtSP has not completed adjustment");
219
220   if (FP) {
221     // Set the FP from the SP.
222     BuildMI(MBB, MBBI, dl, TII.get(XCore::LDAWSP_ru6), FramePtr).addImm(0);
223     if (emitFrameMoves)
224       EmitDefCfaRegister(MBB, MBBI, dl, TII, MMI,
225                          MRI->getDwarfRegNum(FramePtr, true));
226   }
227
228   if (emitFrameMoves) {
229     // Frame moves for callee saved.
230     std::vector<std::pair<MCSymbol*, CalleeSavedInfo> >&SpillLabels =
231         XFI->getSpillLabels();
232     for (unsigned I = 0, E = SpillLabels.size(); I != E; ++I) {
233       MCSymbol *SpillLabel = SpillLabels[I].first;
234       CalleeSavedInfo &CSI = SpillLabels[I].second;
235       int Offset = MFI->getObjectOffset(CSI.getFrameIdx());
236       unsigned DRegNum = MRI->getDwarfRegNum(CSI.getReg(), true);
237       EmitCfiOffset(MBB, MBBI, dl, TII, MMI, DRegNum, Offset, SpillLabel);
238     }
239   }
240 }
241
242 void XCoreFrameLowering::emitEpilogue(MachineFunction &MF,
243                                      MachineBasicBlock &MBB) const {
244   MachineFrameInfo *MFI            = MF.getFrameInfo();
245   MachineBasicBlock::iterator MBBI = MBB.getLastNonDebugInstr();
246   const XCoreInstrInfo &TII =
247     *static_cast<const XCoreInstrInfo*>(MF.getTarget().getInstrInfo());
248   XCoreFunctionInfo *XFI = MF.getInfo<XCoreFunctionInfo>();
249   DebugLoc dl = MBBI->getDebugLoc();
250
251   // Work out frame sizes.
252   // We will adjust the SP in stages towards the final FrameSize.
253   int RemainingAdj = MFI->getStackSize();
254   assert(RemainingAdj%4 == 0 && "Misaligned frame size");
255   RemainingAdj /= 4;
256
257   bool restoreLR = XFI->getUsesLR();
258   bool UseRETSP = restoreLR && RemainingAdj
259                   && (MFI->getObjectOffset(XFI->getLRSpillSlot()) == 0);
260   if (UseRETSP)
261     restoreLR = false;
262   bool FP = hasFP(MF);
263
264   if (FP) // Restore the stack pointer.
265     BuildMI(MBB, MBBI, dl, TII.get(XCore::SETSP_1r)).addReg(FramePtr);
266
267   // If necessary, restore LR and FP from the stack, as we EXTSP.
268   SmallVector<std::pair<unsigned,int>,2> SpillList;
269   GetSpillList(SpillList, MFI, XFI, restoreLR, FP);
270   unsigned i = SpillList.size();
271   while (i--) {
272     unsigned SpilledReg = SpillList[i].first;
273     int SpillOffset = SpillList[i].second;
274     assert(SpillOffset % 4 == 0 && "Misaligned stack offset");
275     assert(SpillOffset <= 0 && "Unexpected positive stack offset");
276     int OffsetFromTop = - SpillOffset/4;
277     IfNeededLDAWSP(MBB, MBBI, dl, TII, OffsetFromTop, RemainingAdj);
278     int Offset = RemainingAdj - OffsetFromTop;
279     int Opcode = isImmU6(Offset) ? XCore::LDWSP_ru6 : XCore::LDWSP_lru6;
280     BuildMI(MBB, MBBI, dl, TII.get(Opcode), SpilledReg).addImm(Offset);
281   }
282
283   if (RemainingAdj) {
284     // Complete all but one of the remaining Stack adjustments.
285     IfNeededLDAWSP(MBB, MBBI, dl, TII, 0, RemainingAdj);
286     if (UseRETSP) {
287       // Fold prologue into return instruction
288       assert(MBBI->getOpcode() == XCore::RETSP_u6
289              || MBBI->getOpcode() == XCore::RETSP_lu6);
290       int Opcode = isImmU6(RemainingAdj) ? XCore::RETSP_u6 : XCore::RETSP_lu6;
291       MachineInstrBuilder MIB = BuildMI(MBB, MBBI, dl, TII.get(Opcode))
292                                   .addImm(RemainingAdj);
293       for (unsigned i = 3, e = MBBI->getNumOperands(); i < e; ++i)
294         MIB->addOperand(MBBI->getOperand(i)); // copy any variadic operands
295       MBB.erase(MBBI);  // Erase the previous return instruction.
296     } else {
297       int Opcode = isImmU6(RemainingAdj) ? XCore::LDAWSP_ru6 :
298                                            XCore::LDAWSP_lru6;
299       BuildMI(MBB, MBBI, dl, TII.get(Opcode), XCore::SP).addImm(RemainingAdj);
300       // Don't erase the return instruction.
301     }
302   } // else Don't erase the return instruction.
303 }
304
305 bool XCoreFrameLowering::spillCalleeSavedRegisters(MachineBasicBlock &MBB,
306                                                MachineBasicBlock::iterator MI,
307                                         const std::vector<CalleeSavedInfo> &CSI,
308                                           const TargetRegisterInfo *TRI) const {
309   if (CSI.empty())
310     return true;
311
312   MachineFunction *MF = MBB.getParent();
313   const TargetInstrInfo &TII = *MF->getTarget().getInstrInfo();
314
315   XCoreFunctionInfo *XFI = MF->getInfo<XCoreFunctionInfo>();
316   bool emitFrameMoves = XCoreRegisterInfo::needsFrameMoves(*MF);
317
318   DebugLoc DL;
319   if (MI != MBB.end())
320     DL = MI->getDebugLoc();
321
322   for (std::vector<CalleeSavedInfo>::const_iterator it = CSI.begin();
323                                                     it != CSI.end(); ++it) {
324     // Add the callee-saved register as live-in. It's killed at the spill.
325     MBB.addLiveIn(it->getReg());
326
327     unsigned Reg = it->getReg();
328     const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
329     TII.storeRegToStackSlot(MBB, MI, Reg, true,
330                             it->getFrameIdx(), RC, TRI);
331     if (emitFrameMoves) {
332       MCSymbol *SaveLabel = MF->getContext().CreateTempSymbol();
333       BuildMI(MBB, MI, DL, TII.get(XCore::PROLOG_LABEL)).addSym(SaveLabel);
334       XFI->getSpillLabels().push_back(std::make_pair(SaveLabel, *it));
335     }
336   }
337   return true;
338 }
339
340 bool XCoreFrameLowering::restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
341                                                  MachineBasicBlock::iterator MI,
342                                         const std::vector<CalleeSavedInfo> &CSI,
343                                             const TargetRegisterInfo *TRI) const{
344   MachineFunction *MF = MBB.getParent();
345   const TargetInstrInfo &TII = *MF->getTarget().getInstrInfo();
346
347   bool AtStart = MI == MBB.begin();
348   MachineBasicBlock::iterator BeforeI = MI;
349   if (!AtStart)
350     --BeforeI;
351   for (std::vector<CalleeSavedInfo>::const_iterator it = CSI.begin();
352                                                     it != CSI.end(); ++it) {
353     unsigned Reg = it->getReg();
354     const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
355     TII.loadRegFromStackSlot(MBB, MI, it->getReg(), it->getFrameIdx(),
356                              RC, TRI);
357     assert(MI != MBB.begin() &&
358            "loadRegFromStackSlot didn't insert any code!");
359     // Insert in reverse order.  loadRegFromStackSlot can insert multiple
360     // instructions.
361     if (AtStart)
362       MI = MBB.begin();
363     else {
364       MI = BeforeI;
365       ++MI;
366     }
367   }
368   return true;
369 }
370
371 // This function eliminates ADJCALLSTACKDOWN,
372 // ADJCALLSTACKUP pseudo instructions
373 void XCoreFrameLowering::
374 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
375                               MachineBasicBlock::iterator I) const {
376   const XCoreInstrInfo &TII =
377     *static_cast<const XCoreInstrInfo*>(MF.getTarget().getInstrInfo());
378   if (!hasReservedCallFrame(MF)) {
379     // Turn the adjcallstackdown instruction into 'extsp <amt>' and the
380     // adjcallstackup instruction into 'ldaw sp, sp[<amt>]'
381     MachineInstr *Old = I;
382     uint64_t Amount = Old->getOperand(0).getImm();
383     if (Amount != 0) {
384       // We need to keep the stack aligned properly.  To do this, we round the
385       // amount of space needed for the outgoing arguments up to the next
386       // alignment boundary.
387       unsigned Align = getStackAlignment();
388       Amount = (Amount+Align-1)/Align*Align;
389
390       assert(Amount%4 == 0);
391       Amount /= 4;
392
393       bool isU6 = isImmU6(Amount);
394       if (!isU6 && !isImmU16(Amount)) {
395         // FIX could emit multiple instructions in this case.
396 #ifndef NDEBUG
397         errs() << "eliminateCallFramePseudoInstr size too big: "
398                << Amount << "\n";
399 #endif
400         llvm_unreachable(0);
401       }
402
403       MachineInstr *New;
404       if (Old->getOpcode() == XCore::ADJCALLSTACKDOWN) {
405         int Opcode = isU6 ? XCore::EXTSP_u6 : XCore::EXTSP_lu6;
406         New=BuildMI(MF, Old->getDebugLoc(), TII.get(Opcode))
407           .addImm(Amount);
408       } else {
409         assert(Old->getOpcode() == XCore::ADJCALLSTACKUP);
410         int Opcode = isU6 ? XCore::LDAWSP_ru6 : XCore::LDAWSP_lru6;
411         New=BuildMI(MF, Old->getDebugLoc(), TII.get(Opcode), XCore::SP)
412           .addImm(Amount);
413       }
414
415       // Replace the pseudo instruction with a new instruction...
416       MBB.insert(I, New);
417     }
418   }
419   
420   MBB.erase(I);
421 }
422
423 void
424 XCoreFrameLowering::processFunctionBeforeCalleeSavedScan(MachineFunction &MF,
425                                                      RegScavenger *RS) const {
426   MachineFrameInfo *MFI = MF.getFrameInfo();
427   const TargetRegisterInfo *RegInfo = MF.getTarget().getRegisterInfo();
428   bool LRUsed = MF.getRegInfo().isPhysRegUsed(XCore::LR);
429   const TargetRegisterClass *RC = &XCore::GRRegsRegClass;
430   XCoreFunctionInfo *XFI = MF.getInfo<XCoreFunctionInfo>();
431   if (LRUsed) {
432     MF.getRegInfo().setPhysRegUnused(XCore::LR);
433
434     bool isVarArg = MF.getFunction()->isVarArg();
435     int FrameIdx;
436     if (! isVarArg) {
437       // A fixed offset of 0 allows us to save / restore LR using entsp / retsp.
438       FrameIdx = MFI->CreateFixedObject(RC->getSize(), 0, true);
439     } else {
440       FrameIdx = MFI->CreateStackObject(RC->getSize(), RC->getAlignment(),
441                                         false);
442     }
443     XFI->setUsesLR(FrameIdx);
444     XFI->setLRSpillSlot(FrameIdx);
445   }
446   if (RegInfo->requiresRegisterScavenging(MF)) {
447     // Reserve a slot close to SP or frame pointer.
448     RS->addScavengingFrameIndex(MFI->CreateStackObject(RC->getSize(),
449                                                        RC->getAlignment(),
450                                                        false));
451   }
452   if (hasFP(MF)) {
453     // A callee save register is used to hold the FP.
454     // This needs saving / restoring in the epilogue / prologue.
455     XFI->setFPSpillSlot(MFI->CreateStackObject(RC->getSize(),
456                                                RC->getAlignment(),
457                                                false));
458   }
459 }