PPC32: Fix stack collision between FP and CR save areas.
[oota-llvm.git] / lib / Target / PowerPC / PPCFrameLowering.cpp
1 //===-- PPCFrameLowering.cpp - PPC Frame Information ----------------------===//
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 PPC implementation of TargetFrameLowering class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "PPCFrameLowering.h"
15 #include "PPCInstrBuilder.h"
16 #include "PPCInstrInfo.h"
17 #include "PPCMachineFunctionInfo.h"
18 #include "llvm/CodeGen/MachineFrameInfo.h"
19 #include "llvm/CodeGen/MachineFunction.h"
20 #include "llvm/CodeGen/MachineInstrBuilder.h"
21 #include "llvm/CodeGen/MachineModuleInfo.h"
22 #include "llvm/CodeGen/MachineRegisterInfo.h"
23 #include "llvm/CodeGen/RegisterScavenging.h"
24 #include "llvm/IR/Function.h"
25 #include "llvm/Target/TargetOptions.h"
26
27 using namespace llvm;
28
29 // FIXME This disables some code that aligns the stack to a boundary bigger than
30 // the default (16 bytes on Darwin) when there is a stack local of greater
31 // alignment.  This does not currently work, because the delta between old and
32 // new stack pointers is added to offsets that reference incoming parameters
33 // after the prolog is generated, and the code that does that doesn't handle a
34 // variable delta.  You don't want to do that anyway; a better approach is to
35 // reserve another register that retains to the incoming stack pointer, and
36 // reference parameters relative to that.
37 #define ALIGN_STACK 0
38
39
40 /// VRRegNo - Map from a numbered VR register to its enum value.
41 ///
42 static const uint16_t VRRegNo[] = {
43  PPC::V0 , PPC::V1 , PPC::V2 , PPC::V3 , PPC::V4 , PPC::V5 , PPC::V6 , PPC::V7 ,
44  PPC::V8 , PPC::V9 , PPC::V10, PPC::V11, PPC::V12, PPC::V13, PPC::V14, PPC::V15,
45  PPC::V16, PPC::V17, PPC::V18, PPC::V19, PPC::V20, PPC::V21, PPC::V22, PPC::V23,
46  PPC::V24, PPC::V25, PPC::V26, PPC::V27, PPC::V28, PPC::V29, PPC::V30, PPC::V31
47 };
48
49 /// RemoveVRSaveCode - We have found that this function does not need any code
50 /// to manipulate the VRSAVE register, even though it uses vector registers.
51 /// This can happen when the only registers used are known to be live in or out
52 /// of the function.  Remove all of the VRSAVE related code from the function.
53 /// FIXME: The removal of the code results in a compile failure at -O0 when the
54 /// function contains a function call, as the GPR containing original VRSAVE
55 /// contents is spilled and reloaded around the call.  Without the prolog code,
56 /// the spill instruction refers to an undefined register.  This code needs
57 /// to account for all uses of that GPR.
58 static void RemoveVRSaveCode(MachineInstr *MI) {
59   MachineBasicBlock *Entry = MI->getParent();
60   MachineFunction *MF = Entry->getParent();
61
62   // We know that the MTVRSAVE instruction immediately follows MI.  Remove it.
63   MachineBasicBlock::iterator MBBI = MI;
64   ++MBBI;
65   assert(MBBI != Entry->end() && MBBI->getOpcode() == PPC::MTVRSAVE);
66   MBBI->eraseFromParent();
67
68   bool RemovedAllMTVRSAVEs = true;
69   // See if we can find and remove the MTVRSAVE instruction from all of the
70   // epilog blocks.
71   for (MachineFunction::iterator I = MF->begin(), E = MF->end(); I != E; ++I) {
72     // If last instruction is a return instruction, add an epilogue
73     if (!I->empty() && I->back().isReturn()) {
74       bool FoundIt = false;
75       for (MBBI = I->end(); MBBI != I->begin(); ) {
76         --MBBI;
77         if (MBBI->getOpcode() == PPC::MTVRSAVE) {
78           MBBI->eraseFromParent();  // remove it.
79           FoundIt = true;
80           break;
81         }
82       }
83       RemovedAllMTVRSAVEs &= FoundIt;
84     }
85   }
86
87   // If we found and removed all MTVRSAVE instructions, remove the read of
88   // VRSAVE as well.
89   if (RemovedAllMTVRSAVEs) {
90     MBBI = MI;
91     assert(MBBI != Entry->begin() && "UPDATE_VRSAVE is first instr in block?");
92     --MBBI;
93     assert(MBBI->getOpcode() == PPC::MFVRSAVE && "VRSAVE instrs wandered?");
94     MBBI->eraseFromParent();
95   }
96
97   // Finally, nuke the UPDATE_VRSAVE.
98   MI->eraseFromParent();
99 }
100
101 // HandleVRSaveUpdate - MI is the UPDATE_VRSAVE instruction introduced by the
102 // instruction selector.  Based on the vector registers that have been used,
103 // transform this into the appropriate ORI instruction.
104 static void HandleVRSaveUpdate(MachineInstr *MI, const TargetInstrInfo &TII) {
105   MachineFunction *MF = MI->getParent()->getParent();
106   const TargetRegisterInfo *TRI = MF->getTarget().getRegisterInfo();
107   DebugLoc dl = MI->getDebugLoc();
108
109   unsigned UsedRegMask = 0;
110   for (unsigned i = 0; i != 32; ++i)
111     if (MF->getRegInfo().isPhysRegUsed(VRRegNo[i]))
112       UsedRegMask |= 1 << (31-i);
113
114   // Live in and live out values already must be in the mask, so don't bother
115   // marking them.
116   for (MachineRegisterInfo::livein_iterator
117        I = MF->getRegInfo().livein_begin(),
118        E = MF->getRegInfo().livein_end(); I != E; ++I) {
119     unsigned RegNo = TRI->getEncodingValue(I->first);
120     if (VRRegNo[RegNo] == I->first)        // If this really is a vector reg.
121       UsedRegMask &= ~(1 << (31-RegNo));   // Doesn't need to be marked.
122   }
123
124   // Live out registers appear as use operands on return instructions.
125   for (MachineFunction::const_iterator BI = MF->begin(), BE = MF->end();
126        UsedRegMask != 0 && BI != BE; ++BI) {
127     const MachineBasicBlock &MBB = *BI;
128     if (MBB.empty() || !MBB.back().isReturn())
129       continue;
130     const MachineInstr &Ret = MBB.back();
131     for (unsigned I = 0, E = Ret.getNumOperands(); I != E; ++I) {
132       const MachineOperand &MO = Ret.getOperand(I);
133       if (!MO.isReg() || !PPC::VRRCRegClass.contains(MO.getReg()))
134         continue;
135       unsigned RegNo = TRI->getEncodingValue(MO.getReg());
136       UsedRegMask &= ~(1 << (31-RegNo));
137     }
138   }
139
140   // If no registers are used, turn this into a copy.
141   if (UsedRegMask == 0) {
142     // Remove all VRSAVE code.
143     RemoveVRSaveCode(MI);
144     return;
145   }
146
147   unsigned SrcReg = MI->getOperand(1).getReg();
148   unsigned DstReg = MI->getOperand(0).getReg();
149
150   if ((UsedRegMask & 0xFFFF) == UsedRegMask) {
151     if (DstReg != SrcReg)
152       BuildMI(*MI->getParent(), MI, dl, TII.get(PPC::ORI), DstReg)
153         .addReg(SrcReg)
154         .addImm(UsedRegMask);
155     else
156       BuildMI(*MI->getParent(), MI, dl, TII.get(PPC::ORI), DstReg)
157         .addReg(SrcReg, RegState::Kill)
158         .addImm(UsedRegMask);
159   } else if ((UsedRegMask & 0xFFFF0000) == UsedRegMask) {
160     if (DstReg != SrcReg)
161       BuildMI(*MI->getParent(), MI, dl, TII.get(PPC::ORIS), DstReg)
162         .addReg(SrcReg)
163         .addImm(UsedRegMask >> 16);
164     else
165       BuildMI(*MI->getParent(), MI, dl, TII.get(PPC::ORIS), DstReg)
166         .addReg(SrcReg, RegState::Kill)
167         .addImm(UsedRegMask >> 16);
168   } else {
169     if (DstReg != SrcReg)
170       BuildMI(*MI->getParent(), MI, dl, TII.get(PPC::ORIS), DstReg)
171         .addReg(SrcReg)
172         .addImm(UsedRegMask >> 16);
173     else
174       BuildMI(*MI->getParent(), MI, dl, TII.get(PPC::ORIS), DstReg)
175         .addReg(SrcReg, RegState::Kill)
176         .addImm(UsedRegMask >> 16);
177
178     BuildMI(*MI->getParent(), MI, dl, TII.get(PPC::ORI), DstReg)
179       .addReg(DstReg, RegState::Kill)
180       .addImm(UsedRegMask & 0xFFFF);
181   }
182
183   // Remove the old UPDATE_VRSAVE instruction.
184   MI->eraseFromParent();
185 }
186
187 static bool spillsCR(const MachineFunction &MF) {
188   const PPCFunctionInfo *FuncInfo = MF.getInfo<PPCFunctionInfo>();
189   return FuncInfo->isCRSpilled();
190 }
191
192 static bool spillsVRSAVE(const MachineFunction &MF) {
193   const PPCFunctionInfo *FuncInfo = MF.getInfo<PPCFunctionInfo>();
194   return FuncInfo->isVRSAVESpilled();
195 }
196
197 static bool hasSpills(const MachineFunction &MF) {
198   const PPCFunctionInfo *FuncInfo = MF.getInfo<PPCFunctionInfo>();
199   return FuncInfo->hasSpills();
200 }
201
202 static bool hasNonRISpills(const MachineFunction &MF) {
203   const PPCFunctionInfo *FuncInfo = MF.getInfo<PPCFunctionInfo>();
204   return FuncInfo->hasNonRISpills();
205 }
206
207 /// determineFrameLayout - Determine the size of the frame and maximum call
208 /// frame size.
209 unsigned PPCFrameLowering::determineFrameLayout(MachineFunction &MF,
210                                                 bool UpdateMF,
211                                                 bool UseEstimate) const {
212   MachineFrameInfo *MFI = MF.getFrameInfo();
213
214   // Get the number of bytes to allocate from the FrameInfo
215   unsigned FrameSize =
216     UseEstimate ? MFI->estimateStackSize(MF) : MFI->getStackSize();
217
218   // Get the alignments provided by the target, and the maximum alignment
219   // (if any) of the fixed frame objects.
220   unsigned MaxAlign = MFI->getMaxAlignment();
221   unsigned TargetAlign = getStackAlignment();
222   unsigned AlignMask = TargetAlign - 1;  //
223
224   // If we are a leaf function, and use up to 224 bytes of stack space,
225   // don't have a frame pointer, calls, or dynamic alloca then we do not need
226   // to adjust the stack pointer (we fit in the Red Zone).
227   // The 32-bit SVR4 ABI has no Red Zone. However, it can still generate
228   // stackless code if all local vars are reg-allocated.
229   bool DisableRedZone = MF.getFunction()->getAttributes().
230     hasAttribute(AttributeSet::FunctionIndex, Attribute::NoRedZone);
231   if (!DisableRedZone &&
232       (Subtarget.isPPC64() ||                      // 32-bit SVR4, no stack-
233        !Subtarget.isSVR4ABI() ||                   //   allocated locals.
234         FrameSize == 0) &&
235       FrameSize <= 224 &&                          // Fits in red zone.
236       !MFI->hasVarSizedObjects() &&                // No dynamic alloca.
237       !MFI->adjustsStack() &&                      // No calls.
238       (!ALIGN_STACK || MaxAlign <= TargetAlign)) { // No special alignment.
239     // No need for frame
240     if (UpdateMF)
241       MFI->setStackSize(0);
242     return 0;
243   }
244
245   // Get the maximum call frame size of all the calls.
246   unsigned maxCallFrameSize = MFI->getMaxCallFrameSize();
247
248   // Maximum call frame needs to be at least big enough for linkage and 8 args.
249   unsigned minCallFrameSize = getMinCallFrameSize(Subtarget.isPPC64(),
250                                                   Subtarget.isDarwinABI());
251   maxCallFrameSize = std::max(maxCallFrameSize, minCallFrameSize);
252
253   // If we have dynamic alloca then maxCallFrameSize needs to be aligned so
254   // that allocations will be aligned.
255   if (MFI->hasVarSizedObjects())
256     maxCallFrameSize = (maxCallFrameSize + AlignMask) & ~AlignMask;
257
258   // Update maximum call frame size.
259   if (UpdateMF)
260     MFI->setMaxCallFrameSize(maxCallFrameSize);
261
262   // Include call frame size in total.
263   FrameSize += maxCallFrameSize;
264
265   // Make sure the frame is aligned.
266   FrameSize = (FrameSize + AlignMask) & ~AlignMask;
267
268   // Update frame info.
269   if (UpdateMF)
270     MFI->setStackSize(FrameSize);
271
272   return FrameSize;
273 }
274
275 // hasFP - Return true if the specified function actually has a dedicated frame
276 // pointer register.
277 bool PPCFrameLowering::hasFP(const MachineFunction &MF) const {
278   const MachineFrameInfo *MFI = MF.getFrameInfo();
279   // FIXME: This is pretty much broken by design: hasFP() might be called really
280   // early, before the stack layout was calculated and thus hasFP() might return
281   // true or false here depending on the time of call.
282   return (MFI->getStackSize()) && needsFP(MF);
283 }
284
285 // needsFP - Return true if the specified function should have a dedicated frame
286 // pointer register.  This is true if the function has variable sized allocas or
287 // if frame pointer elimination is disabled.
288 bool PPCFrameLowering::needsFP(const MachineFunction &MF) const {
289   const MachineFrameInfo *MFI = MF.getFrameInfo();
290
291   // Naked functions have no stack frame pushed, so we don't have a frame
292   // pointer.
293   if (MF.getFunction()->getAttributes().hasAttribute(AttributeSet::FunctionIndex,
294                                                      Attribute::Naked))
295     return false;
296
297   return MF.getTarget().Options.DisableFramePointerElim(MF) ||
298     MFI->hasVarSizedObjects() ||
299     (MF.getTarget().Options.GuaranteedTailCallOpt &&
300      MF.getInfo<PPCFunctionInfo>()->hasFastCall());
301 }
302
303 void PPCFrameLowering::replaceFPWithRealFP(MachineFunction &MF) const {
304   bool is31 = needsFP(MF);
305   unsigned FPReg  = is31 ? PPC::R31 : PPC::R1;
306   unsigned FP8Reg = is31 ? PPC::X31 : PPC::X1;
307
308   for (MachineFunction::iterator BI = MF.begin(), BE = MF.end();
309        BI != BE; ++BI)
310     for (MachineBasicBlock::iterator MBBI = BI->end(); MBBI != BI->begin(); ) {
311       --MBBI;
312       for (unsigned I = 0, E = MBBI->getNumOperands(); I != E; ++I) {
313         MachineOperand &MO = MBBI->getOperand(I);
314         if (!MO.isReg())
315           continue;
316
317         switch (MO.getReg()) {
318         case PPC::FP:
319           MO.setReg(FPReg);
320           break;
321         case PPC::FP8:
322           MO.setReg(FP8Reg);
323           break;
324         }
325       }
326     }
327 }
328
329 void PPCFrameLowering::emitPrologue(MachineFunction &MF) const {
330   MachineBasicBlock &MBB = MF.front();   // Prolog goes in entry BB
331   MachineBasicBlock::iterator MBBI = MBB.begin();
332   MachineFrameInfo *MFI = MF.getFrameInfo();
333   const PPCInstrInfo &TII =
334     *static_cast<const PPCInstrInfo*>(MF.getTarget().getInstrInfo());
335
336   MachineModuleInfo &MMI = MF.getMMI();
337   DebugLoc dl;
338   bool needsFrameMoves = MMI.hasDebugInfo() ||
339     MF.getFunction()->needsUnwindTableEntry();
340
341   // Prepare for frame info.
342   MCSymbol *FrameLabel = 0;
343
344   // Scan the prolog, looking for an UPDATE_VRSAVE instruction.  If we find it,
345   // process it.
346   if (!Subtarget.isSVR4ABI())
347     for (unsigned i = 0; MBBI != MBB.end(); ++i, ++MBBI) {
348       if (MBBI->getOpcode() == PPC::UPDATE_VRSAVE) {
349         HandleVRSaveUpdate(MBBI, TII);
350         break;
351       }
352     }
353
354   // Move MBBI back to the beginning of the function.
355   MBBI = MBB.begin();
356
357   // Work out frame sizes.
358   unsigned FrameSize = determineFrameLayout(MF);
359   int NegFrameSize = -FrameSize;
360
361   if (MFI->isFrameAddressTaken())
362     replaceFPWithRealFP(MF);
363
364   // Get processor type.
365   bool isPPC64 = Subtarget.isPPC64();
366   // Get operating system
367   bool isDarwinABI = Subtarget.isDarwinABI();
368   // Check if the link register (LR) must be saved.
369   PPCFunctionInfo *FI = MF.getInfo<PPCFunctionInfo>();
370   bool MustSaveLR = FI->mustSaveLR();
371   const SmallVector<unsigned, 3> &MustSaveCRs = FI->getMustSaveCRs();
372   // Do we have a frame pointer for this function?
373   bool HasFP = hasFP(MF);
374
375   int LROffset = PPCFrameLowering::getReturnSaveOffset(isPPC64, isDarwinABI);
376
377   int FPOffset = 0;
378   if (HasFP) {
379     if (Subtarget.isSVR4ABI()) {
380       MachineFrameInfo *FFI = MF.getFrameInfo();
381       int FPIndex = FI->getFramePointerSaveIndex();
382       assert(FPIndex && "No Frame Pointer Save Slot!");
383       FPOffset = FFI->getObjectOffset(FPIndex);
384     } else {
385       FPOffset = PPCFrameLowering::getFramePointerSaveOffset(isPPC64, isDarwinABI);
386     }
387   }
388
389   if (isPPC64) {
390     if (MustSaveLR)
391       BuildMI(MBB, MBBI, dl, TII.get(PPC::MFLR8), PPC::X0);
392
393     if (!MustSaveCRs.empty()) {
394       MachineInstrBuilder MIB =
395         BuildMI(MBB, MBBI, dl, TII.get(PPC::MFCR8), PPC::X12);
396       for (unsigned i = 0, e = MustSaveCRs.size(); i != e; ++i)
397         MIB.addReg(MustSaveCRs[i], RegState::ImplicitKill);
398     }
399
400     if (HasFP)
401       BuildMI(MBB, MBBI, dl, TII.get(PPC::STD))
402         .addReg(PPC::X31)
403         .addImm(FPOffset/4)
404         .addReg(PPC::X1);
405
406     if (MustSaveLR)
407       BuildMI(MBB, MBBI, dl, TII.get(PPC::STD))
408         .addReg(PPC::X0)
409         .addImm(LROffset / 4)
410         .addReg(PPC::X1);
411
412     if (!MustSaveCRs.empty())
413       BuildMI(MBB, MBBI, dl, TII.get(PPC::STW8))
414         .addReg(PPC::X12, getKillRegState(true))
415         .addImm(8)
416         .addReg(PPC::X1);
417   } else {
418     if (MustSaveLR)
419       BuildMI(MBB, MBBI, dl, TII.get(PPC::MFLR), PPC::R0);
420
421     if (HasFP)
422       // FIXME: On PPC32 SVR4, FPOffset is negative and access to negative
423       // offsets of R1 is not allowed.
424       BuildMI(MBB, MBBI, dl, TII.get(PPC::STW))
425         .addReg(PPC::R31)
426         .addImm(FPOffset)
427         .addReg(PPC::R1);
428
429     assert(MustSaveCRs.empty() &&
430            "Prologue CR saving supported only in 64-bit mode");
431
432     if (MustSaveLR)
433       BuildMI(MBB, MBBI, dl, TII.get(PPC::STW))
434         .addReg(PPC::R0)
435         .addImm(LROffset)
436         .addReg(PPC::R1);
437   }
438
439   // Skip if a leaf routine.
440   if (!FrameSize) return;
441
442   // Get stack alignments.
443   unsigned TargetAlign = getStackAlignment();
444   unsigned MaxAlign = MFI->getMaxAlignment();
445
446   // Adjust stack pointer: r1 += NegFrameSize.
447   // If there is a preferred stack alignment, align R1 now
448   if (!isPPC64) {
449     // PPC32.
450     if (ALIGN_STACK && MaxAlign > TargetAlign) {
451       assert(isPowerOf2_32(MaxAlign) && isInt<16>(MaxAlign) &&
452              "Invalid alignment!");
453       assert(isInt<16>(NegFrameSize) && "Unhandled stack size and alignment!");
454
455       BuildMI(MBB, MBBI, dl, TII.get(PPC::RLWINM), PPC::R0)
456         .addReg(PPC::R1)
457         .addImm(0)
458         .addImm(32 - Log2_32(MaxAlign))
459         .addImm(31);
460       BuildMI(MBB, MBBI, dl, TII.get(PPC::SUBFIC) ,PPC::R0)
461         .addReg(PPC::R0, RegState::Kill)
462         .addImm(NegFrameSize);
463       BuildMI(MBB, MBBI, dl, TII.get(PPC::STWUX), PPC::R1)
464         .addReg(PPC::R1, RegState::Kill)
465         .addReg(PPC::R1)
466         .addReg(PPC::R0);
467     } else if (isInt<16>(NegFrameSize)) {
468       BuildMI(MBB, MBBI, dl, TII.get(PPC::STWU), PPC::R1)
469         .addReg(PPC::R1)
470         .addImm(NegFrameSize)
471         .addReg(PPC::R1);
472     } else {
473       BuildMI(MBB, MBBI, dl, TII.get(PPC::LIS), PPC::R0)
474         .addImm(NegFrameSize >> 16);
475       BuildMI(MBB, MBBI, dl, TII.get(PPC::ORI), PPC::R0)
476         .addReg(PPC::R0, RegState::Kill)
477         .addImm(NegFrameSize & 0xFFFF);
478       BuildMI(MBB, MBBI, dl, TII.get(PPC::STWUX), PPC::R1)
479         .addReg(PPC::R1, RegState::Kill)
480         .addReg(PPC::R1)
481         .addReg(PPC::R0);
482     }
483   } else {    // PPC64.
484     if (ALIGN_STACK && MaxAlign > TargetAlign) {
485       assert(isPowerOf2_32(MaxAlign) && isInt<16>(MaxAlign) &&
486              "Invalid alignment!");
487       assert(isInt<16>(NegFrameSize) && "Unhandled stack size and alignment!");
488
489       BuildMI(MBB, MBBI, dl, TII.get(PPC::RLDICL), PPC::X0)
490         .addReg(PPC::X1)
491         .addImm(0)
492         .addImm(64 - Log2_32(MaxAlign));
493       BuildMI(MBB, MBBI, dl, TII.get(PPC::SUBFIC8), PPC::X0)
494         .addReg(PPC::X0)
495         .addImm(NegFrameSize);
496       BuildMI(MBB, MBBI, dl, TII.get(PPC::STDUX), PPC::X1)
497         .addReg(PPC::X1, RegState::Kill)
498         .addReg(PPC::X1)
499         .addReg(PPC::X0);
500     } else if (isInt<16>(NegFrameSize)) {
501       BuildMI(MBB, MBBI, dl, TII.get(PPC::STDU), PPC::X1)
502         .addReg(PPC::X1)
503         .addImm(NegFrameSize / 4)
504         .addReg(PPC::X1);
505     } else {
506       BuildMI(MBB, MBBI, dl, TII.get(PPC::LIS8), PPC::X0)
507         .addImm(NegFrameSize >> 16);
508       BuildMI(MBB, MBBI, dl, TII.get(PPC::ORI8), PPC::X0)
509         .addReg(PPC::X0, RegState::Kill)
510         .addImm(NegFrameSize & 0xFFFF);
511       BuildMI(MBB, MBBI, dl, TII.get(PPC::STDUX), PPC::X1)
512         .addReg(PPC::X1, RegState::Kill)
513         .addReg(PPC::X1)
514         .addReg(PPC::X0);
515     }
516   }
517
518   // Add the "machine moves" for the instructions we generated above, but in
519   // reverse order.
520   if (needsFrameMoves) {
521     // Mark effective beginning of when frame pointer becomes valid.
522     FrameLabel = MMI.getContext().CreateTempSymbol();
523     BuildMI(MBB, MBBI, dl, TII.get(PPC::PROLOG_LABEL)).addSym(FrameLabel);
524
525     // Show update of SP.
526     if (NegFrameSize) {
527       MachineLocation SPDst(MachineLocation::VirtualFP);
528       MachineLocation SPSrc(MachineLocation::VirtualFP, NegFrameSize);
529       MMI.addFrameMove(FrameLabel, SPDst, SPSrc);
530     } else {
531       MachineLocation SP(isPPC64 ? PPC::X31 : PPC::R31);
532       MMI.addFrameMove(FrameLabel, SP, SP);
533     }
534
535     if (HasFP) {
536       MachineLocation FPDst(MachineLocation::VirtualFP, FPOffset);
537       MachineLocation FPSrc(isPPC64 ? PPC::X31 : PPC::R31);
538       MMI.addFrameMove(FrameLabel, FPDst, FPSrc);
539     }
540
541     if (MustSaveLR) {
542       MachineLocation LRDst(MachineLocation::VirtualFP, LROffset);
543       MachineLocation LRSrc(isPPC64 ? PPC::LR8 : PPC::LR);
544       MMI.addFrameMove(FrameLabel, LRDst, LRSrc);
545     }
546   }
547
548   MCSymbol *ReadyLabel = 0;
549
550   // If there is a frame pointer, copy R1 into R31
551   if (HasFP) {
552     if (!isPPC64) {
553       BuildMI(MBB, MBBI, dl, TII.get(PPC::OR), PPC::R31)
554         .addReg(PPC::R1)
555         .addReg(PPC::R1);
556     } else {
557       BuildMI(MBB, MBBI, dl, TII.get(PPC::OR8), PPC::X31)
558         .addReg(PPC::X1)
559         .addReg(PPC::X1);
560     }
561
562     if (needsFrameMoves) {
563       ReadyLabel = MMI.getContext().CreateTempSymbol();
564
565       // Mark effective beginning of when frame pointer is ready.
566       BuildMI(MBB, MBBI, dl, TII.get(PPC::PROLOG_LABEL)).addSym(ReadyLabel);
567
568       MachineLocation FPDst(HasFP ? (isPPC64 ? PPC::X31 : PPC::R31) :
569                                     (isPPC64 ? PPC::X1 : PPC::R1));
570       MachineLocation FPSrc(MachineLocation::VirtualFP);
571       MMI.addFrameMove(ReadyLabel, FPDst, FPSrc);
572     }
573   }
574
575   if (needsFrameMoves) {
576     MCSymbol *Label = HasFP ? ReadyLabel : FrameLabel;
577
578     // Add callee saved registers to move list.
579     const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
580     for (unsigned I = 0, E = CSI.size(); I != E; ++I) {
581       unsigned Reg = CSI[I].getReg();
582       if (Reg == PPC::LR || Reg == PPC::LR8 || Reg == PPC::RM) continue;
583
584       // This is a bit of a hack: CR2LT, CR2GT, CR2EQ and CR2UN are just
585       // subregisters of CR2. We just need to emit a move of CR2.
586       if (PPC::CRBITRCRegClass.contains(Reg))
587         continue;
588
589       // For SVR4, don't emit a move for the CR spill slot if we haven't
590       // spilled CRs.
591       if (Subtarget.isSVR4ABI()
592           && (PPC::CR2 <= Reg && Reg <= PPC::CR4)
593           && MustSaveCRs.empty())
594         continue;
595
596       // For 64-bit SVR4 when we have spilled CRs, the spill location
597       // is SP+8, not a frame-relative slot.
598       if (Subtarget.isSVR4ABI()
599           && Subtarget.isPPC64()
600           && (PPC::CR2 <= Reg && Reg <= PPC::CR4)) {
601         MachineLocation CSDst(PPC::X1, 8);
602         MachineLocation CSSrc(PPC::CR2);
603         MMI.addFrameMove(Label, CSDst, CSSrc);
604         continue;
605       }
606
607       int Offset = MFI->getObjectOffset(CSI[I].getFrameIdx());
608       MachineLocation CSDst(MachineLocation::VirtualFP, Offset);
609       MachineLocation CSSrc(Reg);
610       MMI.addFrameMove(Label, CSDst, CSSrc);
611     }
612   }
613 }
614
615 void PPCFrameLowering::emitEpilogue(MachineFunction &MF,
616                                 MachineBasicBlock &MBB) const {
617   MachineBasicBlock::iterator MBBI = MBB.getLastNonDebugInstr();
618   assert(MBBI != MBB.end() && "Returning block has no terminator");
619   const PPCInstrInfo &TII =
620     *static_cast<const PPCInstrInfo*>(MF.getTarget().getInstrInfo());
621
622   unsigned RetOpcode = MBBI->getOpcode();
623   DebugLoc dl;
624
625   assert((RetOpcode == PPC::BLR ||
626           RetOpcode == PPC::TCRETURNri ||
627           RetOpcode == PPC::TCRETURNdi ||
628           RetOpcode == PPC::TCRETURNai ||
629           RetOpcode == PPC::TCRETURNri8 ||
630           RetOpcode == PPC::TCRETURNdi8 ||
631           RetOpcode == PPC::TCRETURNai8) &&
632          "Can only insert epilog into returning blocks");
633
634   // Get alignment info so we know how to restore r1
635   const MachineFrameInfo *MFI = MF.getFrameInfo();
636   unsigned TargetAlign = getStackAlignment();
637   unsigned MaxAlign = MFI->getMaxAlignment();
638
639   // Get the number of bytes allocated from the FrameInfo.
640   int FrameSize = MFI->getStackSize();
641
642   // Get processor type.
643   bool isPPC64 = Subtarget.isPPC64();
644   // Get operating system
645   bool isDarwinABI = Subtarget.isDarwinABI();
646   // Check if the link register (LR) has been saved.
647   PPCFunctionInfo *FI = MF.getInfo<PPCFunctionInfo>();
648   bool MustSaveLR = FI->mustSaveLR();
649   const SmallVector<unsigned, 3> &MustSaveCRs = FI->getMustSaveCRs();
650   // Do we have a frame pointer for this function?
651   bool HasFP = hasFP(MF);
652
653   int LROffset = PPCFrameLowering::getReturnSaveOffset(isPPC64, isDarwinABI);
654
655   int FPOffset = 0;
656   if (HasFP) {
657     if (Subtarget.isSVR4ABI()) {
658       MachineFrameInfo *FFI = MF.getFrameInfo();
659       int FPIndex = FI->getFramePointerSaveIndex();
660       assert(FPIndex && "No Frame Pointer Save Slot!");
661       FPOffset = FFI->getObjectOffset(FPIndex);
662     } else {
663       FPOffset = PPCFrameLowering::getFramePointerSaveOffset(isPPC64, isDarwinABI);
664     }
665   }
666
667   bool UsesTCRet =  RetOpcode == PPC::TCRETURNri ||
668     RetOpcode == PPC::TCRETURNdi ||
669     RetOpcode == PPC::TCRETURNai ||
670     RetOpcode == PPC::TCRETURNri8 ||
671     RetOpcode == PPC::TCRETURNdi8 ||
672     RetOpcode == PPC::TCRETURNai8;
673
674   if (UsesTCRet) {
675     int MaxTCRetDelta = FI->getTailCallSPDelta();
676     MachineOperand &StackAdjust = MBBI->getOperand(1);
677     assert(StackAdjust.isImm() && "Expecting immediate value.");
678     // Adjust stack pointer.
679     int StackAdj = StackAdjust.getImm();
680     int Delta = StackAdj - MaxTCRetDelta;
681     assert((Delta >= 0) && "Delta must be positive");
682     if (MaxTCRetDelta>0)
683       FrameSize += (StackAdj +Delta);
684     else
685       FrameSize += StackAdj;
686   }
687
688   if (FrameSize) {
689     // The loaded (or persistent) stack pointer value is offset by the 'stwu'
690     // on entry to the function.  Add this offset back now.
691     if (!isPPC64) {
692       // If this function contained a fastcc call and GuaranteedTailCallOpt is
693       // enabled (=> hasFastCall()==true) the fastcc call might contain a tail
694       // call which invalidates the stack pointer value in SP(0). So we use the
695       // value of R31 in this case.
696       if (FI->hasFastCall() && isInt<16>(FrameSize)) {
697         assert(hasFP(MF) && "Expecting a valid the frame pointer.");
698         BuildMI(MBB, MBBI, dl, TII.get(PPC::ADDI), PPC::R1)
699           .addReg(PPC::R31).addImm(FrameSize);
700       } else if(FI->hasFastCall()) {
701         BuildMI(MBB, MBBI, dl, TII.get(PPC::LIS), PPC::R0)
702           .addImm(FrameSize >> 16);
703         BuildMI(MBB, MBBI, dl, TII.get(PPC::ORI), PPC::R0)
704           .addReg(PPC::R0, RegState::Kill)
705           .addImm(FrameSize & 0xFFFF);
706         BuildMI(MBB, MBBI, dl, TII.get(PPC::ADD4))
707           .addReg(PPC::R1)
708           .addReg(PPC::R31)
709           .addReg(PPC::R0);
710       } else if (isInt<16>(FrameSize) &&
711                  (!ALIGN_STACK || TargetAlign >= MaxAlign) &&
712                  !MFI->hasVarSizedObjects()) {
713         BuildMI(MBB, MBBI, dl, TII.get(PPC::ADDI), PPC::R1)
714           .addReg(PPC::R1).addImm(FrameSize);
715       } else {
716         BuildMI(MBB, MBBI, dl, TII.get(PPC::LWZ),PPC::R1)
717           .addImm(0).addReg(PPC::R1);
718       }
719     } else {
720       if (FI->hasFastCall() && isInt<16>(FrameSize)) {
721         assert(hasFP(MF) && "Expecting a valid the frame pointer.");
722         BuildMI(MBB, MBBI, dl, TII.get(PPC::ADDI8), PPC::X1)
723           .addReg(PPC::X31).addImm(FrameSize);
724       } else if(FI->hasFastCall()) {
725         BuildMI(MBB, MBBI, dl, TII.get(PPC::LIS8), PPC::X0)
726           .addImm(FrameSize >> 16);
727         BuildMI(MBB, MBBI, dl, TII.get(PPC::ORI8), PPC::X0)
728           .addReg(PPC::X0, RegState::Kill)
729           .addImm(FrameSize & 0xFFFF);
730         BuildMI(MBB, MBBI, dl, TII.get(PPC::ADD8))
731           .addReg(PPC::X1)
732           .addReg(PPC::X31)
733           .addReg(PPC::X0);
734       } else if (isInt<16>(FrameSize) && TargetAlign >= MaxAlign &&
735             !MFI->hasVarSizedObjects()) {
736         BuildMI(MBB, MBBI, dl, TII.get(PPC::ADDI8), PPC::X1)
737            .addReg(PPC::X1).addImm(FrameSize);
738       } else {
739         BuildMI(MBB, MBBI, dl, TII.get(PPC::LD), PPC::X1)
740            .addImm(0).addReg(PPC::X1);
741       }
742     }
743   }
744
745   if (isPPC64) {
746     if (MustSaveLR)
747       BuildMI(MBB, MBBI, dl, TII.get(PPC::LD), PPC::X0)
748         .addImm(LROffset/4).addReg(PPC::X1);
749
750     if (!MustSaveCRs.empty())
751       BuildMI(MBB, MBBI, dl, TII.get(PPC::LWZ8), PPC::X12)
752         .addImm(8).addReg(PPC::X1);
753
754     if (HasFP)
755       BuildMI(MBB, MBBI, dl, TII.get(PPC::LD), PPC::X31)
756         .addImm(FPOffset/4).addReg(PPC::X1);
757
758     if (!MustSaveCRs.empty())
759       for (unsigned i = 0, e = MustSaveCRs.size(); i != e; ++i)
760         BuildMI(MBB, MBBI, dl, TII.get(PPC::MTCRF8), MustSaveCRs[i])
761           .addReg(PPC::X12, getKillRegState(i == e-1));
762
763     if (MustSaveLR)
764       BuildMI(MBB, MBBI, dl, TII.get(PPC::MTLR8)).addReg(PPC::X0);
765   } else {
766     if (MustSaveLR)
767       BuildMI(MBB, MBBI, dl, TII.get(PPC::LWZ), PPC::R0)
768           .addImm(LROffset).addReg(PPC::R1);
769
770     assert(MustSaveCRs.empty() &&
771            "Epilogue CR restoring supported only in 64-bit mode");
772
773     if (HasFP)
774       BuildMI(MBB, MBBI, dl, TII.get(PPC::LWZ), PPC::R31)
775           .addImm(FPOffset).addReg(PPC::R1);
776
777     if (MustSaveLR)
778       BuildMI(MBB, MBBI, dl, TII.get(PPC::MTLR)).addReg(PPC::R0);
779   }
780
781   // Callee pop calling convention. Pop parameter/linkage area. Used for tail
782   // call optimization
783   if (MF.getTarget().Options.GuaranteedTailCallOpt && RetOpcode == PPC::BLR &&
784       MF.getFunction()->getCallingConv() == CallingConv::Fast) {
785      PPCFunctionInfo *FI = MF.getInfo<PPCFunctionInfo>();
786      unsigned CallerAllocatedAmt = FI->getMinReservedArea();
787      unsigned StackReg = isPPC64 ? PPC::X1 : PPC::R1;
788      unsigned FPReg = isPPC64 ? PPC::X31 : PPC::R31;
789      unsigned TmpReg = isPPC64 ? PPC::X0 : PPC::R0;
790      unsigned ADDIInstr = isPPC64 ? PPC::ADDI8 : PPC::ADDI;
791      unsigned ADDInstr = isPPC64 ? PPC::ADD8 : PPC::ADD4;
792      unsigned LISInstr = isPPC64 ? PPC::LIS8 : PPC::LIS;
793      unsigned ORIInstr = isPPC64 ? PPC::ORI8 : PPC::ORI;
794
795      if (CallerAllocatedAmt && isInt<16>(CallerAllocatedAmt)) {
796        BuildMI(MBB, MBBI, dl, TII.get(ADDIInstr), StackReg)
797          .addReg(StackReg).addImm(CallerAllocatedAmt);
798      } else {
799        BuildMI(MBB, MBBI, dl, TII.get(LISInstr), TmpReg)
800           .addImm(CallerAllocatedAmt >> 16);
801        BuildMI(MBB, MBBI, dl, TII.get(ORIInstr), TmpReg)
802           .addReg(TmpReg, RegState::Kill)
803           .addImm(CallerAllocatedAmt & 0xFFFF);
804        BuildMI(MBB, MBBI, dl, TII.get(ADDInstr))
805           .addReg(StackReg)
806           .addReg(FPReg)
807           .addReg(TmpReg);
808      }
809   } else if (RetOpcode == PPC::TCRETURNdi) {
810     MBBI = MBB.getLastNonDebugInstr();
811     MachineOperand &JumpTarget = MBBI->getOperand(0);
812     BuildMI(MBB, MBBI, dl, TII.get(PPC::TAILB)).
813       addGlobalAddress(JumpTarget.getGlobal(), JumpTarget.getOffset());
814   } else if (RetOpcode == PPC::TCRETURNri) {
815     MBBI = MBB.getLastNonDebugInstr();
816     assert(MBBI->getOperand(0).isReg() && "Expecting register operand.");
817     BuildMI(MBB, MBBI, dl, TII.get(PPC::TAILBCTR));
818   } else if (RetOpcode == PPC::TCRETURNai) {
819     MBBI = MBB.getLastNonDebugInstr();
820     MachineOperand &JumpTarget = MBBI->getOperand(0);
821     BuildMI(MBB, MBBI, dl, TII.get(PPC::TAILBA)).addImm(JumpTarget.getImm());
822   } else if (RetOpcode == PPC::TCRETURNdi8) {
823     MBBI = MBB.getLastNonDebugInstr();
824     MachineOperand &JumpTarget = MBBI->getOperand(0);
825     BuildMI(MBB, MBBI, dl, TII.get(PPC::TAILB8)).
826       addGlobalAddress(JumpTarget.getGlobal(), JumpTarget.getOffset());
827   } else if (RetOpcode == PPC::TCRETURNri8) {
828     MBBI = MBB.getLastNonDebugInstr();
829     assert(MBBI->getOperand(0).isReg() && "Expecting register operand.");
830     BuildMI(MBB, MBBI, dl, TII.get(PPC::TAILBCTR8));
831   } else if (RetOpcode == PPC::TCRETURNai8) {
832     MBBI = MBB.getLastNonDebugInstr();
833     MachineOperand &JumpTarget = MBBI->getOperand(0);
834     BuildMI(MBB, MBBI, dl, TII.get(PPC::TAILBA8)).addImm(JumpTarget.getImm());
835   }
836 }
837
838 /// MustSaveLR - Return true if this function requires that we save the LR
839 /// register onto the stack in the prolog and restore it in the epilog of the
840 /// function.
841 static bool MustSaveLR(const MachineFunction &MF, unsigned LR) {
842   const PPCFunctionInfo *MFI = MF.getInfo<PPCFunctionInfo>();
843
844   // We need a save/restore of LR if there is any def of LR (which is
845   // defined by calls, including the PIC setup sequence), or if there is
846   // some use of the LR stack slot (e.g. for builtin_return_address).
847   // (LR comes in 32 and 64 bit versions.)
848   MachineRegisterInfo::def_iterator RI = MF.getRegInfo().def_begin(LR);
849   return RI !=MF.getRegInfo().def_end() || MFI->isLRStoreRequired();
850 }
851
852 void
853 PPCFrameLowering::processFunctionBeforeCalleeSavedScan(MachineFunction &MF,
854                                                    RegScavenger *) const {
855   const TargetRegisterInfo *RegInfo = MF.getTarget().getRegisterInfo();
856
857   //  Save and clear the LR state.
858   PPCFunctionInfo *FI = MF.getInfo<PPCFunctionInfo>();
859   unsigned LR = RegInfo->getRARegister();
860   FI->setMustSaveLR(MustSaveLR(MF, LR));
861   MachineRegisterInfo &MRI = MF.getRegInfo();
862   MRI.setPhysRegUnused(LR);
863
864   //  Save R31 if necessary
865   int FPSI = FI->getFramePointerSaveIndex();
866   bool isPPC64 = Subtarget.isPPC64();
867   bool isDarwinABI  = Subtarget.isDarwinABI();
868   MachineFrameInfo *MFI = MF.getFrameInfo();
869
870   // If the frame pointer save index hasn't been defined yet.
871   if (!FPSI && needsFP(MF)) {
872     // Find out what the fix offset of the frame pointer save area.
873     int FPOffset = getFramePointerSaveOffset(isPPC64, isDarwinABI);
874     // Allocate the frame index for frame pointer save area.
875     FPSI = MFI->CreateFixedObject(isPPC64? 8 : 4, FPOffset, true);
876     // Save the result.
877     FI->setFramePointerSaveIndex(FPSI);
878   }
879
880   // Reserve stack space to move the linkage area to in case of a tail call.
881   int TCSPDelta = 0;
882   if (MF.getTarget().Options.GuaranteedTailCallOpt &&
883       (TCSPDelta = FI->getTailCallSPDelta()) < 0) {
884     MFI->CreateFixedObject(-1 * TCSPDelta, TCSPDelta, true);
885   }
886
887   // For 32-bit SVR4, allocate the nonvolatile CR spill slot iff the 
888   // function uses CR 2, 3, or 4.
889   if (!isPPC64 && !isDarwinABI && 
890       (MRI.isPhysRegUsed(PPC::CR2) ||
891        MRI.isPhysRegUsed(PPC::CR3) ||
892        MRI.isPhysRegUsed(PPC::CR4))) {
893     int FrameIdx = MFI->CreateFixedObject((uint64_t)4, (int64_t)-4, true);
894     FI->setCRSpillFrameIndex(FrameIdx);
895   }
896 }
897
898 void PPCFrameLowering::processFunctionBeforeFrameFinalized(MachineFunction &MF,
899                                                        RegScavenger *RS) const {
900   // Early exit if not using the SVR4 ABI.
901   if (!Subtarget.isSVR4ABI()) {
902     addScavengingSpillSlot(MF, RS);
903     return;
904   }
905
906   // Get callee saved register information.
907   MachineFrameInfo *FFI = MF.getFrameInfo();
908   const std::vector<CalleeSavedInfo> &CSI = FFI->getCalleeSavedInfo();
909
910   // Early exit if no callee saved registers are modified!
911   if (CSI.empty() && !needsFP(MF)) {
912     addScavengingSpillSlot(MF, RS);
913     return;
914   }
915
916   unsigned MinGPR = PPC::R31;
917   unsigned MinG8R = PPC::X31;
918   unsigned MinFPR = PPC::F31;
919   unsigned MinVR = PPC::V31;
920
921   bool HasGPSaveArea = false;
922   bool HasG8SaveArea = false;
923   bool HasFPSaveArea = false;
924   bool HasVRSAVESaveArea = false;
925   bool HasVRSaveArea = false;
926
927   SmallVector<CalleeSavedInfo, 18> GPRegs;
928   SmallVector<CalleeSavedInfo, 18> G8Regs;
929   SmallVector<CalleeSavedInfo, 18> FPRegs;
930   SmallVector<CalleeSavedInfo, 18> VRegs;
931
932   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
933     unsigned Reg = CSI[i].getReg();
934     if (PPC::GPRCRegClass.contains(Reg)) {
935       HasGPSaveArea = true;
936
937       GPRegs.push_back(CSI[i]);
938
939       if (Reg < MinGPR) {
940         MinGPR = Reg;
941       }
942     } else if (PPC::G8RCRegClass.contains(Reg)) {
943       HasG8SaveArea = true;
944
945       G8Regs.push_back(CSI[i]);
946
947       if (Reg < MinG8R) {
948         MinG8R = Reg;
949       }
950     } else if (PPC::F8RCRegClass.contains(Reg)) {
951       HasFPSaveArea = true;
952
953       FPRegs.push_back(CSI[i]);
954
955       if (Reg < MinFPR) {
956         MinFPR = Reg;
957       }
958     } else if (PPC::CRBITRCRegClass.contains(Reg) ||
959                PPC::CRRCRegClass.contains(Reg)) {
960       ; // do nothing, as we already know whether CRs are spilled
961     } else if (PPC::VRSAVERCRegClass.contains(Reg)) {
962       HasVRSAVESaveArea = true;
963     } else if (PPC::VRRCRegClass.contains(Reg)) {
964       HasVRSaveArea = true;
965
966       VRegs.push_back(CSI[i]);
967
968       if (Reg < MinVR) {
969         MinVR = Reg;
970       }
971     } else {
972       llvm_unreachable("Unknown RegisterClass!");
973     }
974   }
975
976   PPCFunctionInfo *PFI = MF.getInfo<PPCFunctionInfo>();
977   const TargetRegisterInfo *TRI = MF.getTarget().getRegisterInfo();
978
979   int64_t LowerBound = 0;
980
981   // Take into account stack space reserved for tail calls.
982   int TCSPDelta = 0;
983   if (MF.getTarget().Options.GuaranteedTailCallOpt &&
984       (TCSPDelta = PFI->getTailCallSPDelta()) < 0) {
985     LowerBound = TCSPDelta;
986   }
987
988   // The Floating-point register save area is right below the back chain word
989   // of the previous stack frame.
990   if (HasFPSaveArea) {
991     for (unsigned i = 0, e = FPRegs.size(); i != e; ++i) {
992       int FI = FPRegs[i].getFrameIdx();
993
994       FFI->setObjectOffset(FI, LowerBound + FFI->getObjectOffset(FI));
995     }
996
997     LowerBound -= (31 - TRI->getEncodingValue(MinFPR) + 1) * 8;
998   }
999
1000   // Check whether the frame pointer register is allocated. If so, make sure it
1001   // is spilled to the correct offset.
1002   if (needsFP(MF)) {
1003     HasGPSaveArea = true;
1004
1005     int FI = PFI->getFramePointerSaveIndex();
1006     assert(FI && "No Frame Pointer Save Slot!");
1007
1008     FFI->setObjectOffset(FI, LowerBound + FFI->getObjectOffset(FI));
1009   }
1010
1011   // General register save area starts right below the Floating-point
1012   // register save area.
1013   if (HasGPSaveArea || HasG8SaveArea) {
1014     // Move general register save area spill slots down, taking into account
1015     // the size of the Floating-point register save area.
1016     for (unsigned i = 0, e = GPRegs.size(); i != e; ++i) {
1017       int FI = GPRegs[i].getFrameIdx();
1018
1019       FFI->setObjectOffset(FI, LowerBound + FFI->getObjectOffset(FI));
1020     }
1021
1022     // Move general register save area spill slots down, taking into account
1023     // the size of the Floating-point register save area.
1024     for (unsigned i = 0, e = G8Regs.size(); i != e; ++i) {
1025       int FI = G8Regs[i].getFrameIdx();
1026
1027       FFI->setObjectOffset(FI, LowerBound + FFI->getObjectOffset(FI));
1028     }
1029
1030     unsigned MinReg =
1031       std::min<unsigned>(TRI->getEncodingValue(MinGPR),
1032                          TRI->getEncodingValue(MinG8R));
1033
1034     if (Subtarget.isPPC64()) {
1035       LowerBound -= (31 - MinReg + 1) * 8;
1036     } else {
1037       LowerBound -= (31 - MinReg + 1) * 4;
1038     }
1039   }
1040
1041   // For 32-bit only, the CR save area is below the general register
1042   // save area.  For 64-bit SVR4, the CR save area is addressed relative
1043   // to the stack pointer and hence does not need an adjustment here.
1044   // Only CR2 (the first nonvolatile spilled) has an associated frame
1045   // index so that we have a single uniform save area.
1046   if (spillsCR(MF) && !(Subtarget.isPPC64() && Subtarget.isSVR4ABI())) {
1047     // Adjust the frame index of the CR spill slot.
1048     for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1049       unsigned Reg = CSI[i].getReg();
1050
1051       if ((Subtarget.isSVR4ABI() && Reg == PPC::CR2)
1052           // Leave Darwin logic as-is.
1053           || (!Subtarget.isSVR4ABI() &&
1054               (PPC::CRBITRCRegClass.contains(Reg) ||
1055                PPC::CRRCRegClass.contains(Reg)))) {
1056         int FI = CSI[i].getFrameIdx();
1057
1058         FFI->setObjectOffset(FI, LowerBound + FFI->getObjectOffset(FI));
1059       }
1060     }
1061
1062     LowerBound -= 4; // The CR save area is always 4 bytes long.
1063   }
1064
1065   if (HasVRSAVESaveArea) {
1066     // FIXME SVR4: Is it actually possible to have multiple elements in CSI
1067     //             which have the VRSAVE register class?
1068     // Adjust the frame index of the VRSAVE spill slot.
1069     for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1070       unsigned Reg = CSI[i].getReg();
1071
1072       if (PPC::VRSAVERCRegClass.contains(Reg)) {
1073         int FI = CSI[i].getFrameIdx();
1074
1075         FFI->setObjectOffset(FI, LowerBound + FFI->getObjectOffset(FI));
1076       }
1077     }
1078
1079     LowerBound -= 4; // The VRSAVE save area is always 4 bytes long.
1080   }
1081
1082   if (HasVRSaveArea) {
1083     // Insert alignment padding, we need 16-byte alignment.
1084     LowerBound = (LowerBound - 15) & ~(15);
1085
1086     for (unsigned i = 0, e = VRegs.size(); i != e; ++i) {
1087       int FI = VRegs[i].getFrameIdx();
1088
1089       FFI->setObjectOffset(FI, LowerBound + FFI->getObjectOffset(FI));
1090     }
1091   }
1092
1093   addScavengingSpillSlot(MF, RS);
1094 }
1095
1096 void
1097 PPCFrameLowering::addScavengingSpillSlot(MachineFunction &MF,
1098                                          RegScavenger *RS) const {
1099   // Reserve a slot closest to SP or frame pointer if we have a dynalloc or
1100   // a large stack, which will require scavenging a register to materialize a
1101   // large offset.
1102
1103   // We need to have a scavenger spill slot for spills if the frame size is
1104   // large. In case there is no free register for large-offset addressing,
1105   // this slot is used for the necessary emergency spill. Also, we need the
1106   // slot for dynamic stack allocations.
1107
1108   // The scavenger might be invoked if the frame offset does not fit into
1109   // the 16-bit immediate. We don't know the complete frame size here
1110   // because we've not yet computed callee-saved register spills or the
1111   // needed alignment padding.
1112   unsigned StackSize = determineFrameLayout(MF, false, true);
1113   MachineFrameInfo *MFI = MF.getFrameInfo();
1114   if (MFI->hasVarSizedObjects() || spillsCR(MF) || spillsVRSAVE(MF) ||
1115       hasNonRISpills(MF) || (hasSpills(MF) && !isInt<16>(StackSize))) {
1116     const TargetRegisterClass *GPRC = &PPC::GPRCRegClass;
1117     const TargetRegisterClass *G8RC = &PPC::G8RCRegClass;
1118     const TargetRegisterClass *RC = Subtarget.isPPC64() ? G8RC : GPRC;
1119     RS->addScavengingFrameIndex(MFI->CreateStackObject(RC->getSize(),
1120                                                        RC->getAlignment(),
1121                                                        false));
1122
1123     // These kinds of spills might need two registers.
1124     if (spillsCR(MF) || spillsVRSAVE(MF))
1125       RS->addScavengingFrameIndex(MFI->CreateStackObject(RC->getSize(),
1126                                                          RC->getAlignment(),
1127                                                          false));
1128
1129   }
1130 }
1131
1132 bool 
1133 PPCFrameLowering::spillCalleeSavedRegisters(MachineBasicBlock &MBB,
1134                                      MachineBasicBlock::iterator MI,
1135                                      const std::vector<CalleeSavedInfo> &CSI,
1136                                      const TargetRegisterInfo *TRI) const {
1137
1138   // Currently, this function only handles SVR4 32- and 64-bit ABIs.
1139   // Return false otherwise to maintain pre-existing behavior.
1140   if (!Subtarget.isSVR4ABI())
1141     return false;
1142
1143   MachineFunction *MF = MBB.getParent();
1144   const PPCInstrInfo &TII =
1145     *static_cast<const PPCInstrInfo*>(MF->getTarget().getInstrInfo());
1146   DebugLoc DL;
1147   bool CRSpilled = false;
1148   MachineInstrBuilder CRMIB;
1149   
1150   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1151     unsigned Reg = CSI[i].getReg();
1152     // CR2 through CR4 are the nonvolatile CR fields.
1153     bool IsCRField = PPC::CR2 <= Reg && Reg <= PPC::CR4;
1154
1155     // Add the callee-saved register as live-in; it's killed at the spill.
1156     MBB.addLiveIn(Reg);
1157
1158     if (CRSpilled && IsCRField) {
1159       CRMIB.addReg(Reg, RegState::ImplicitKill);
1160       continue;
1161     }
1162
1163     // Insert the spill to the stack frame.
1164     if (IsCRField) {
1165       PPCFunctionInfo *FuncInfo = MF->getInfo<PPCFunctionInfo>();
1166       if (Subtarget.isPPC64()) {
1167         // The actual spill will happen at the start of the prologue.
1168         FuncInfo->addMustSaveCR(Reg);
1169       } else {
1170         CRSpilled = true;
1171         FuncInfo->setSpillsCR();
1172
1173         // 32-bit:  FP-relative.  Note that we made sure CR2-CR4 all have
1174         // the same frame index in PPCRegisterInfo::hasReservedSpillSlot.
1175         CRMIB = BuildMI(*MF, DL, TII.get(PPC::MFCR), PPC::R12)
1176                   .addReg(Reg, RegState::ImplicitKill);
1177
1178         MBB.insert(MI, CRMIB);
1179         MBB.insert(MI, addFrameReference(BuildMI(*MF, DL, TII.get(PPC::STW))
1180                                          .addReg(PPC::R12,
1181                                                  getKillRegState(true)),
1182                                          CSI[i].getFrameIdx()));
1183       }
1184     } else {
1185       const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
1186       TII.storeRegToStackSlot(MBB, MI, Reg, true,
1187                               CSI[i].getFrameIdx(), RC, TRI);
1188     }
1189   }
1190   return true;
1191 }
1192
1193 static void
1194 restoreCRs(bool isPPC64, bool is31,
1195            bool CR2Spilled, bool CR3Spilled, bool CR4Spilled,
1196            MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
1197            const std::vector<CalleeSavedInfo> &CSI, unsigned CSIIndex) {
1198
1199   MachineFunction *MF = MBB.getParent();
1200   const PPCInstrInfo &TII =
1201     *static_cast<const PPCInstrInfo*>(MF->getTarget().getInstrInfo());
1202   DebugLoc DL;
1203   unsigned RestoreOp, MoveReg;
1204
1205   if (isPPC64)
1206     // This is handled during epilogue generation.
1207     return;
1208   else {
1209     // 32-bit:  FP-relative
1210     MBB.insert(MI, addFrameReference(BuildMI(*MF, DL, TII.get(PPC::LWZ),
1211                                              PPC::R12),
1212                                      CSI[CSIIndex].getFrameIdx()));
1213     RestoreOp = PPC::MTCRF;
1214     MoveReg = PPC::R12;
1215   }
1216   
1217   if (CR2Spilled)
1218     MBB.insert(MI, BuildMI(*MF, DL, TII.get(RestoreOp), PPC::CR2)
1219                .addReg(MoveReg, getKillRegState(!CR3Spilled && !CR4Spilled)));
1220
1221   if (CR3Spilled)
1222     MBB.insert(MI, BuildMI(*MF, DL, TII.get(RestoreOp), PPC::CR3)
1223                .addReg(MoveReg, getKillRegState(!CR4Spilled)));
1224
1225   if (CR4Spilled)
1226     MBB.insert(MI, BuildMI(*MF, DL, TII.get(RestoreOp), PPC::CR4)
1227                .addReg(MoveReg, getKillRegState(true)));
1228 }
1229
1230 void PPCFrameLowering::
1231 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
1232                               MachineBasicBlock::iterator I) const {
1233   const PPCInstrInfo &TII =
1234     *static_cast<const PPCInstrInfo*>(MF.getTarget().getInstrInfo());
1235   if (MF.getTarget().Options.GuaranteedTailCallOpt &&
1236       I->getOpcode() == PPC::ADJCALLSTACKUP) {
1237     // Add (actually subtract) back the amount the callee popped on return.
1238     if (int CalleeAmt =  I->getOperand(1).getImm()) {
1239       bool is64Bit = Subtarget.isPPC64();
1240       CalleeAmt *= -1;
1241       unsigned StackReg = is64Bit ? PPC::X1 : PPC::R1;
1242       unsigned TmpReg = is64Bit ? PPC::X0 : PPC::R0;
1243       unsigned ADDIInstr = is64Bit ? PPC::ADDI8 : PPC::ADDI;
1244       unsigned ADDInstr = is64Bit ? PPC::ADD8 : PPC::ADD4;
1245       unsigned LISInstr = is64Bit ? PPC::LIS8 : PPC::LIS;
1246       unsigned ORIInstr = is64Bit ? PPC::ORI8 : PPC::ORI;
1247       MachineInstr *MI = I;
1248       DebugLoc dl = MI->getDebugLoc();
1249
1250       if (isInt<16>(CalleeAmt)) {
1251         BuildMI(MBB, I, dl, TII.get(ADDIInstr), StackReg)
1252           .addReg(StackReg, RegState::Kill)
1253           .addImm(CalleeAmt);
1254       } else {
1255         MachineBasicBlock::iterator MBBI = I;
1256         BuildMI(MBB, MBBI, dl, TII.get(LISInstr), TmpReg)
1257           .addImm(CalleeAmt >> 16);
1258         BuildMI(MBB, MBBI, dl, TII.get(ORIInstr), TmpReg)
1259           .addReg(TmpReg, RegState::Kill)
1260           .addImm(CalleeAmt & 0xFFFF);
1261         BuildMI(MBB, MBBI, dl, TII.get(ADDInstr), StackReg)
1262           .addReg(StackReg, RegState::Kill)
1263           .addReg(TmpReg);
1264       }
1265     }
1266   }
1267   // Simply discard ADJCALLSTACKDOWN, ADJCALLSTACKUP instructions.
1268   MBB.erase(I);
1269 }
1270
1271 bool 
1272 PPCFrameLowering::restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
1273                                         MachineBasicBlock::iterator MI,
1274                                         const std::vector<CalleeSavedInfo> &CSI,
1275                                         const TargetRegisterInfo *TRI) const {
1276
1277   // Currently, this function only handles SVR4 32- and 64-bit ABIs.
1278   // Return false otherwise to maintain pre-existing behavior.
1279   if (!Subtarget.isSVR4ABI())
1280     return false;
1281
1282   MachineFunction *MF = MBB.getParent();
1283   const PPCInstrInfo &TII =
1284     *static_cast<const PPCInstrInfo*>(MF->getTarget().getInstrInfo());
1285   bool CR2Spilled = false;
1286   bool CR3Spilled = false;
1287   bool CR4Spilled = false;
1288   unsigned CSIIndex = 0;
1289
1290   // Initialize insertion-point logic; we will be restoring in reverse
1291   // order of spill.
1292   MachineBasicBlock::iterator I = MI, BeforeI = I;
1293   bool AtStart = I == MBB.begin();
1294
1295   if (!AtStart)
1296     --BeforeI;
1297
1298   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1299     unsigned Reg = CSI[i].getReg();
1300
1301     if (Reg == PPC::CR2) {
1302       CR2Spilled = true;
1303       // The spill slot is associated only with CR2, which is the
1304       // first nonvolatile spilled.  Save it here.
1305       CSIIndex = i;
1306       continue;
1307     } else if (Reg == PPC::CR3) {
1308       CR3Spilled = true;
1309       continue;
1310     } else if (Reg == PPC::CR4) {
1311       CR4Spilled = true;
1312       continue;
1313     } else {
1314       // When we first encounter a non-CR register after seeing at
1315       // least one CR register, restore all spilled CRs together.
1316       if ((CR2Spilled || CR3Spilled || CR4Spilled)
1317           && !(PPC::CR2 <= Reg && Reg <= PPC::CR4)) {
1318         bool is31 = needsFP(*MF);
1319         restoreCRs(Subtarget.isPPC64(), is31,
1320                    CR2Spilled, CR3Spilled, CR4Spilled,
1321                    MBB, I, CSI, CSIIndex);
1322         CR2Spilled = CR3Spilled = CR4Spilled = false;
1323       }
1324
1325       // Default behavior for non-CR saves.
1326       const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
1327       TII.loadRegFromStackSlot(MBB, I, Reg, CSI[i].getFrameIdx(),
1328                                RC, TRI);
1329       assert(I != MBB.begin() &&
1330              "loadRegFromStackSlot didn't insert any code!");
1331       }
1332
1333     // Insert in reverse order.
1334     if (AtStart)
1335       I = MBB.begin();
1336     else {
1337       I = BeforeI;
1338       ++I;
1339     }       
1340   }
1341
1342   // If we haven't yet spilled the CRs, do so now.
1343   if (CR2Spilled || CR3Spilled || CR4Spilled) {
1344     bool is31 = needsFP(*MF); 
1345     restoreCRs(Subtarget.isPPC64(), is31, CR2Spilled, CR3Spilled, CR4Spilled,
1346                MBB, I, CSI, CSIIndex);
1347   }
1348
1349   return true;
1350 }
1351