xref: /llvm-project/llvm/lib/Target/ARM/ARMFrameLowering.cpp (revision 9aa6f010a4438d579016f84302311b9992d0a0e1)
1 //===-- ARMFrameLowering.cpp - ARM 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 ARM implementation of TargetFrameLowering class.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "ARMFrameLowering.h"
15 #include "ARMBaseInstrInfo.h"
16 #include "ARMBaseRegisterInfo.h"
17 #include "ARMConstantPoolValue.h"
18 #include "ARMMachineFunctionInfo.h"
19 #include "MCTargetDesc/ARMAddressingModes.h"
20 #include "llvm/CodeGen/MachineFrameInfo.h"
21 #include "llvm/CodeGen/MachineFunction.h"
22 #include "llvm/CodeGen/MachineInstrBuilder.h"
23 #include "llvm/CodeGen/MachineModuleInfo.h"
24 #include "llvm/CodeGen/MachineRegisterInfo.h"
25 #include "llvm/CodeGen/RegisterScavenging.h"
26 #include "llvm/MC/MCAsmInfo.h"
27 #include "llvm/IR/CallingConv.h"
28 #include "llvm/IR/Function.h"
29 #include "llvm/MC/MCContext.h"
30 #include "llvm/Support/CommandLine.h"
31 #include "llvm/Target/TargetOptions.h"
32 
33 using namespace llvm;
34 
35 static cl::opt<bool>
36 SpillAlignedNEONRegs("align-neon-spills", cl::Hidden, cl::init(true),
37                      cl::desc("Align ARM NEON spills in prolog and epilog"));
38 
39 static MachineBasicBlock::iterator
40 skipAlignedDPRCS2Spills(MachineBasicBlock::iterator MI,
41                         unsigned NumAlignedDPRCS2Regs);
42 
43 ARMFrameLowering::ARMFrameLowering(const ARMSubtarget &sti)
44     : TargetFrameLowering(StackGrowsDown, sti.getStackAlignment(), 0, 4),
45       STI(sti) {}
46 
47 bool ARMFrameLowering::noFramePointerElim(const MachineFunction &MF) const {
48   // iOS always has a FP for backtracking, force other targets to keep their FP
49   // when doing FastISel. The emitted code is currently superior, and in cases
50   // like test-suite's lencod FastISel isn't quite correct when FP is eliminated.
51   return TargetFrameLowering::noFramePointerElim(MF) ||
52          MF.getSubtarget<ARMSubtarget>().useFastISel();
53 }
54 
55 /// hasFP - Return true if the specified function should have a dedicated frame
56 /// pointer register.  This is true if the function has variable sized allocas
57 /// or if frame pointer elimination is disabled.
58 bool ARMFrameLowering::hasFP(const MachineFunction &MF) const {
59   const TargetRegisterInfo *RegInfo = MF.getSubtarget().getRegisterInfo();
60   const MachineFrameInfo &MFI = MF.getFrameInfo();
61 
62   // ABI-required frame pointer.
63   if (MF.getTarget().Options.DisableFramePointerElim(MF))
64     return true;
65 
66   // Frame pointer required for use within this function.
67   return (RegInfo->needsStackRealignment(MF) ||
68           MFI.hasVarSizedObjects() ||
69           MFI.isFrameAddressTaken());
70 }
71 
72 /// hasReservedCallFrame - Under normal circumstances, when a frame pointer is
73 /// not required, we reserve argument space for call sites in the function
74 /// immediately on entry to the current function.  This eliminates the need for
75 /// add/sub sp brackets around call sites.  Returns true if the call frame is
76 /// included as part of the stack frame.
77 bool ARMFrameLowering::hasReservedCallFrame(const MachineFunction &MF) const {
78   const MachineFrameInfo &MFI = MF.getFrameInfo();
79   unsigned CFSize = MFI.getMaxCallFrameSize();
80   // It's not always a good idea to include the call frame as part of the
81   // stack frame. ARM (especially Thumb) has small immediate offset to
82   // address the stack frame. So a large call frame can cause poor codegen
83   // and may even makes it impossible to scavenge a register.
84   if (CFSize >= ((1 << 12) - 1) / 2)  // Half of imm12
85     return false;
86 
87   return !MFI.hasVarSizedObjects();
88 }
89 
90 /// canSimplifyCallFramePseudos - If there is a reserved call frame, the
91 /// call frame pseudos can be simplified.  Unlike most targets, having a FP
92 /// is not sufficient here since we still may reference some objects via SP
93 /// even when FP is available in Thumb2 mode.
94 bool
95 ARMFrameLowering::canSimplifyCallFramePseudos(const MachineFunction &MF) const {
96   return hasReservedCallFrame(MF) || MF.getFrameInfo().hasVarSizedObjects();
97 }
98 
99 static bool isCSRestore(MachineInstr &MI, const ARMBaseInstrInfo &TII,
100                         const MCPhysReg *CSRegs) {
101   // Integer spill area is handled with "pop".
102   if (isPopOpcode(MI.getOpcode())) {
103     // The first two operands are predicates. The last two are
104     // imp-def and imp-use of SP. Check everything in between.
105     for (int i = 5, e = MI.getNumOperands(); i != e; ++i)
106       if (!isCalleeSavedRegister(MI.getOperand(i).getReg(), CSRegs))
107         return false;
108     return true;
109   }
110   if ((MI.getOpcode() == ARM::LDR_POST_IMM ||
111        MI.getOpcode() == ARM::LDR_POST_REG ||
112        MI.getOpcode() == ARM::t2LDR_POST) &&
113       isCalleeSavedRegister(MI.getOperand(0).getReg(), CSRegs) &&
114       MI.getOperand(1).getReg() == ARM::SP)
115     return true;
116 
117   return false;
118 }
119 
120 static void emitRegPlusImmediate(
121     bool isARM, MachineBasicBlock &MBB, MachineBasicBlock::iterator &MBBI,
122     const DebugLoc &dl, const ARMBaseInstrInfo &TII, unsigned DestReg,
123     unsigned SrcReg, int NumBytes, unsigned MIFlags = MachineInstr::NoFlags,
124     ARMCC::CondCodes Pred = ARMCC::AL, unsigned PredReg = 0) {
125   if (isARM)
126     emitARMRegPlusImmediate(MBB, MBBI, dl, DestReg, SrcReg, NumBytes,
127                             Pred, PredReg, TII, MIFlags);
128   else
129     emitT2RegPlusImmediate(MBB, MBBI, dl, DestReg, SrcReg, NumBytes,
130                            Pred, PredReg, TII, MIFlags);
131 }
132 
133 static void emitSPUpdate(bool isARM, MachineBasicBlock &MBB,
134                          MachineBasicBlock::iterator &MBBI, const DebugLoc &dl,
135                          const ARMBaseInstrInfo &TII, int NumBytes,
136                          unsigned MIFlags = MachineInstr::NoFlags,
137                          ARMCC::CondCodes Pred = ARMCC::AL,
138                          unsigned PredReg = 0) {
139   emitRegPlusImmediate(isARM, MBB, MBBI, dl, TII, ARM::SP, ARM::SP, NumBytes,
140                        MIFlags, Pred, PredReg);
141 }
142 
143 static int sizeOfSPAdjustment(const MachineInstr &MI) {
144   int RegSize;
145   switch (MI.getOpcode()) {
146   case ARM::VSTMDDB_UPD:
147     RegSize = 8;
148     break;
149   case ARM::STMDB_UPD:
150   case ARM::t2STMDB_UPD:
151     RegSize = 4;
152     break;
153   case ARM::t2STR_PRE:
154   case ARM::STR_PRE_IMM:
155     return 4;
156   default:
157     llvm_unreachable("Unknown push or pop like instruction");
158   }
159 
160   int count = 0;
161   // ARM and Thumb2 push/pop insts have explicit "sp, sp" operands (+
162   // pred) so the list starts at 4.
163   for (int i = MI.getNumOperands() - 1; i >= 4; --i)
164     count += RegSize;
165   return count;
166 }
167 
168 static bool WindowsRequiresStackProbe(const MachineFunction &MF,
169                                       size_t StackSizeInBytes) {
170   const MachineFrameInfo &MFI = MF.getFrameInfo();
171   const Function *F = MF.getFunction();
172   unsigned StackProbeSize = (MFI.getStackProtectorIndex() > 0) ? 4080 : 4096;
173   if (F->hasFnAttribute("stack-probe-size"))
174     F->getFnAttribute("stack-probe-size")
175         .getValueAsString()
176         .getAsInteger(0, StackProbeSize);
177   return StackSizeInBytes >= StackProbeSize;
178 }
179 
180 namespace {
181 struct StackAdjustingInsts {
182   struct InstInfo {
183     MachineBasicBlock::iterator I;
184     unsigned SPAdjust;
185     bool BeforeFPSet;
186   };
187 
188   SmallVector<InstInfo, 4> Insts;
189 
190   void addInst(MachineBasicBlock::iterator I, unsigned SPAdjust,
191                bool BeforeFPSet = false) {
192     InstInfo Info = {I, SPAdjust, BeforeFPSet};
193     Insts.push_back(Info);
194   }
195 
196   void addExtraBytes(const MachineBasicBlock::iterator I, unsigned ExtraBytes) {
197     auto Info = find_if(Insts, [&](InstInfo &Info) { return Info.I == I; });
198     assert(Info != Insts.end() && "invalid sp adjusting instruction");
199     Info->SPAdjust += ExtraBytes;
200   }
201 
202   void emitDefCFAOffsets(MachineModuleInfo &MMI, MachineBasicBlock &MBB,
203                          const DebugLoc &dl, const ARMBaseInstrInfo &TII,
204                          bool HasFP) {
205     unsigned CFAOffset = 0;
206     for (auto &Info : Insts) {
207       if (HasFP && !Info.BeforeFPSet)
208         return;
209 
210       CFAOffset -= Info.SPAdjust;
211       unsigned CFIIndex = MMI.addFrameInst(
212           MCCFIInstruction::createDefCfaOffset(nullptr, CFAOffset));
213       BuildMI(MBB, std::next(Info.I), dl,
214               TII.get(TargetOpcode::CFI_INSTRUCTION))
215               .addCFIIndex(CFIIndex)
216               .setMIFlags(MachineInstr::FrameSetup);
217     }
218   }
219 };
220 }
221 
222 /// Emit an instruction sequence that will align the address in
223 /// register Reg by zero-ing out the lower bits.  For versions of the
224 /// architecture that support Neon, this must be done in a single
225 /// instruction, since skipAlignedDPRCS2Spills assumes it is done in a
226 /// single instruction. That function only gets called when optimizing
227 /// spilling of D registers on a core with the Neon instruction set
228 /// present.
229 static void emitAligningInstructions(MachineFunction &MF, ARMFunctionInfo *AFI,
230                                      const TargetInstrInfo &TII,
231                                      MachineBasicBlock &MBB,
232                                      MachineBasicBlock::iterator MBBI,
233                                      const DebugLoc &DL, const unsigned Reg,
234                                      const unsigned Alignment,
235                                      const bool MustBeSingleInstruction) {
236   const ARMSubtarget &AST =
237       static_cast<const ARMSubtarget &>(MF.getSubtarget());
238   const bool CanUseBFC = AST.hasV6T2Ops() || AST.hasV7Ops();
239   const unsigned AlignMask = Alignment - 1;
240   const unsigned NrBitsToZero = countTrailingZeros(Alignment);
241   assert(!AFI->isThumb1OnlyFunction() && "Thumb1 not supported");
242   if (!AFI->isThumbFunction()) {
243     // if the BFC instruction is available, use that to zero the lower
244     // bits:
245     //   bfc Reg, #0, log2(Alignment)
246     // otherwise use BIC, if the mask to zero the required number of bits
247     // can be encoded in the bic immediate field
248     //   bic Reg, Reg, Alignment-1
249     // otherwise, emit
250     //   lsr Reg, Reg, log2(Alignment)
251     //   lsl Reg, Reg, log2(Alignment)
252     if (CanUseBFC) {
253       AddDefaultPred(BuildMI(MBB, MBBI, DL, TII.get(ARM::BFC), Reg)
254                          .addReg(Reg, RegState::Kill)
255                          .addImm(~AlignMask));
256     } else if (AlignMask <= 255) {
257       AddDefaultCC(
258           AddDefaultPred(BuildMI(MBB, MBBI, DL, TII.get(ARM::BICri), Reg)
259                              .addReg(Reg, RegState::Kill)
260                              .addImm(AlignMask)));
261     } else {
262       assert(!MustBeSingleInstruction &&
263              "Shouldn't call emitAligningInstructions demanding a single "
264              "instruction to be emitted for large stack alignment for a target "
265              "without BFC.");
266       AddDefaultCC(AddDefaultPred(
267           BuildMI(MBB, MBBI, DL, TII.get(ARM::MOVsi), Reg)
268               .addReg(Reg, RegState::Kill)
269               .addImm(ARM_AM::getSORegOpc(ARM_AM::lsr, NrBitsToZero))));
270       AddDefaultCC(AddDefaultPred(
271           BuildMI(MBB, MBBI, DL, TII.get(ARM::MOVsi), Reg)
272               .addReg(Reg, RegState::Kill)
273               .addImm(ARM_AM::getSORegOpc(ARM_AM::lsl, NrBitsToZero))));
274     }
275   } else {
276     // Since this is only reached for Thumb-2 targets, the BFC instruction
277     // should always be available.
278     assert(CanUseBFC);
279     AddDefaultPred(BuildMI(MBB, MBBI, DL, TII.get(ARM::t2BFC), Reg)
280                        .addReg(Reg, RegState::Kill)
281                        .addImm(~AlignMask));
282   }
283 }
284 
285 void ARMFrameLowering::emitPrologue(MachineFunction &MF,
286                                     MachineBasicBlock &MBB) const {
287   MachineBasicBlock::iterator MBBI = MBB.begin();
288   MachineFrameInfo  &MFI = MF.getFrameInfo();
289   ARMFunctionInfo *AFI = MF.getInfo<ARMFunctionInfo>();
290   MachineModuleInfo &MMI = MF.getMMI();
291   MCContext &Context = MMI.getContext();
292   const TargetMachine &TM = MF.getTarget();
293   const MCRegisterInfo *MRI = Context.getRegisterInfo();
294   const ARMBaseRegisterInfo *RegInfo = STI.getRegisterInfo();
295   const ARMBaseInstrInfo &TII = *STI.getInstrInfo();
296   assert(!AFI->isThumb1OnlyFunction() &&
297          "This emitPrologue does not support Thumb1!");
298   bool isARM = !AFI->isThumbFunction();
299   unsigned Align = STI.getFrameLowering()->getStackAlignment();
300   unsigned ArgRegsSaveSize = AFI->getArgRegsSaveSize();
301   unsigned NumBytes = MFI.getStackSize();
302   const std::vector<CalleeSavedInfo> &CSI = MFI.getCalleeSavedInfo();
303 
304   // Debug location must be unknown since the first debug location is used
305   // to determine the end of the prologue.
306   DebugLoc dl;
307 
308   unsigned FramePtr = RegInfo->getFrameRegister(MF);
309 
310   // Determine the sizes of each callee-save spill areas and record which frame
311   // belongs to which callee-save spill areas.
312   unsigned GPRCS1Size = 0, GPRCS2Size = 0, DPRCSSize = 0;
313   int FramePtrSpillFI = 0;
314   int D8SpillFI = 0;
315 
316   // All calls are tail calls in GHC calling conv, and functions have no
317   // prologue/epilogue.
318   if (MF.getFunction()->getCallingConv() == CallingConv::GHC)
319     return;
320 
321   StackAdjustingInsts DefCFAOffsetCandidates;
322   bool HasFP = hasFP(MF);
323 
324   // Allocate the vararg register save area.
325   if (ArgRegsSaveSize) {
326     emitSPUpdate(isARM, MBB, MBBI, dl, TII, -ArgRegsSaveSize,
327                  MachineInstr::FrameSetup);
328     DefCFAOffsetCandidates.addInst(std::prev(MBBI), ArgRegsSaveSize, true);
329   }
330 
331   if (!AFI->hasStackFrame() &&
332       (!STI.isTargetWindows() || !WindowsRequiresStackProbe(MF, NumBytes))) {
333     if (NumBytes - ArgRegsSaveSize != 0) {
334       emitSPUpdate(isARM, MBB, MBBI, dl, TII, -(NumBytes - ArgRegsSaveSize),
335                    MachineInstr::FrameSetup);
336       DefCFAOffsetCandidates.addInst(std::prev(MBBI),
337                                      NumBytes - ArgRegsSaveSize, true);
338     }
339     DefCFAOffsetCandidates.emitDefCFAOffsets(MMI, MBB, dl, TII, HasFP);
340     return;
341   }
342 
343   // Determine spill area sizes.
344   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
345     unsigned Reg = CSI[i].getReg();
346     int FI = CSI[i].getFrameIdx();
347     switch (Reg) {
348     case ARM::R8:
349     case ARM::R9:
350     case ARM::R10:
351     case ARM::R11:
352     case ARM::R12:
353       if (STI.splitFramePushPop(MF)) {
354         GPRCS2Size += 4;
355         break;
356       }
357       LLVM_FALLTHROUGH;
358     case ARM::R0:
359     case ARM::R1:
360     case ARM::R2:
361     case ARM::R3:
362     case ARM::R4:
363     case ARM::R5:
364     case ARM::R6:
365     case ARM::R7:
366     case ARM::LR:
367       if (Reg == FramePtr)
368         FramePtrSpillFI = FI;
369       GPRCS1Size += 4;
370       break;
371     default:
372       // This is a DPR. Exclude the aligned DPRCS2 spills.
373       if (Reg == ARM::D8)
374         D8SpillFI = FI;
375       if (Reg < ARM::D8 || Reg >= ARM::D8 + AFI->getNumAlignedDPRCS2Regs())
376         DPRCSSize += 8;
377     }
378   }
379 
380   // Move past area 1.
381   MachineBasicBlock::iterator LastPush = MBB.end(), GPRCS1Push, GPRCS2Push;
382   if (GPRCS1Size > 0) {
383     GPRCS1Push = LastPush = MBBI++;
384     DefCFAOffsetCandidates.addInst(LastPush, GPRCS1Size, true);
385   }
386 
387   // Determine starting offsets of spill areas.
388   unsigned GPRCS1Offset = NumBytes - ArgRegsSaveSize - GPRCS1Size;
389   unsigned GPRCS2Offset = GPRCS1Offset - GPRCS2Size;
390   unsigned DPRAlign = DPRCSSize ? std::min(8U, Align) : 4U;
391   unsigned DPRGapSize = (GPRCS1Size + GPRCS2Size + ArgRegsSaveSize) % DPRAlign;
392   unsigned DPRCSOffset = GPRCS2Offset - DPRGapSize - DPRCSSize;
393   int FramePtrOffsetInPush = 0;
394   if (HasFP) {
395     FramePtrOffsetInPush =
396         MFI.getObjectOffset(FramePtrSpillFI) + ArgRegsSaveSize;
397     AFI->setFramePtrSpillOffset(MFI.getObjectOffset(FramePtrSpillFI) +
398                                 NumBytes);
399   }
400   AFI->setGPRCalleeSavedArea1Offset(GPRCS1Offset);
401   AFI->setGPRCalleeSavedArea2Offset(GPRCS2Offset);
402   AFI->setDPRCalleeSavedAreaOffset(DPRCSOffset);
403 
404   // Move past area 2.
405   if (GPRCS2Size > 0) {
406     GPRCS2Push = LastPush = MBBI++;
407     DefCFAOffsetCandidates.addInst(LastPush, GPRCS2Size);
408   }
409 
410   // Prolog/epilog inserter assumes we correctly align DPRs on the stack, so our
411   // .cfi_offset operations will reflect that.
412   if (DPRGapSize) {
413     assert(DPRGapSize == 4 && "unexpected alignment requirements for DPRs");
414     if (LastPush != MBB.end() &&
415         tryFoldSPUpdateIntoPushPop(STI, MF, &*LastPush, DPRGapSize))
416       DefCFAOffsetCandidates.addExtraBytes(LastPush, DPRGapSize);
417     else {
418       emitSPUpdate(isARM, MBB, MBBI, dl, TII, -DPRGapSize,
419                    MachineInstr::FrameSetup);
420       DefCFAOffsetCandidates.addInst(std::prev(MBBI), DPRGapSize);
421     }
422   }
423 
424   // Move past area 3.
425   if (DPRCSSize > 0) {
426     // Since vpush register list cannot have gaps, there may be multiple vpush
427     // instructions in the prologue.
428     while (MBBI->getOpcode() == ARM::VSTMDDB_UPD) {
429       DefCFAOffsetCandidates.addInst(MBBI, sizeOfSPAdjustment(*MBBI));
430       LastPush = MBBI++;
431     }
432   }
433 
434   // Move past the aligned DPRCS2 area.
435   if (AFI->getNumAlignedDPRCS2Regs() > 0) {
436     MBBI = skipAlignedDPRCS2Spills(MBBI, AFI->getNumAlignedDPRCS2Regs());
437     // The code inserted by emitAlignedDPRCS2Spills realigns the stack, and
438     // leaves the stack pointer pointing to the DPRCS2 area.
439     //
440     // Adjust NumBytes to represent the stack slots below the DPRCS2 area.
441     NumBytes += MFI.getObjectOffset(D8SpillFI);
442   } else
443     NumBytes = DPRCSOffset;
444 
445   if (STI.isTargetWindows() && WindowsRequiresStackProbe(MF, NumBytes)) {
446     uint32_t NumWords = NumBytes >> 2;
447 
448     if (NumWords < 65536)
449       AddDefaultPred(BuildMI(MBB, MBBI, dl, TII.get(ARM::t2MOVi16), ARM::R4)
450                      .addImm(NumWords)
451                      .setMIFlags(MachineInstr::FrameSetup));
452     else
453       BuildMI(MBB, MBBI, dl, TII.get(ARM::t2MOVi32imm), ARM::R4)
454         .addImm(NumWords)
455         .setMIFlags(MachineInstr::FrameSetup);
456 
457     switch (TM.getCodeModel()) {
458     case CodeModel::Small:
459     case CodeModel::Medium:
460     case CodeModel::Default:
461     case CodeModel::Kernel:
462       BuildMI(MBB, MBBI, dl, TII.get(ARM::tBL))
463         .addImm((unsigned)ARMCC::AL).addReg(0)
464         .addExternalSymbol("__chkstk")
465         .addReg(ARM::R4, RegState::Implicit)
466         .setMIFlags(MachineInstr::FrameSetup);
467       break;
468     case CodeModel::Large:
469     case CodeModel::JITDefault:
470       BuildMI(MBB, MBBI, dl, TII.get(ARM::t2MOVi32imm), ARM::R12)
471         .addExternalSymbol("__chkstk")
472         .setMIFlags(MachineInstr::FrameSetup);
473 
474       BuildMI(MBB, MBBI, dl, TII.get(ARM::tBLXr))
475         .addImm((unsigned)ARMCC::AL).addReg(0)
476         .addReg(ARM::R12, RegState::Kill)
477         .addReg(ARM::R4, RegState::Implicit)
478         .setMIFlags(MachineInstr::FrameSetup);
479       break;
480     }
481 
482     AddDefaultCC(AddDefaultPred(BuildMI(MBB, MBBI, dl, TII.get(ARM::t2SUBrr),
483                                         ARM::SP)
484                                 .addReg(ARM::SP, RegState::Kill)
485                                 .addReg(ARM::R4, RegState::Kill)
486                                 .setMIFlags(MachineInstr::FrameSetup)));
487     NumBytes = 0;
488   }
489 
490   if (NumBytes) {
491     // Adjust SP after all the callee-save spills.
492     if (AFI->getNumAlignedDPRCS2Regs() == 0 &&
493         tryFoldSPUpdateIntoPushPop(STI, MF, &*LastPush, NumBytes))
494       DefCFAOffsetCandidates.addExtraBytes(LastPush, NumBytes);
495     else {
496       emitSPUpdate(isARM, MBB, MBBI, dl, TII, -NumBytes,
497                    MachineInstr::FrameSetup);
498       DefCFAOffsetCandidates.addInst(std::prev(MBBI), NumBytes);
499     }
500 
501     if (HasFP && isARM)
502       // Restore from fp only in ARM mode: e.g. sub sp, r7, #24
503       // Note it's not safe to do this in Thumb2 mode because it would have
504       // taken two instructions:
505       // mov sp, r7
506       // sub sp, #24
507       // If an interrupt is taken between the two instructions, then sp is in
508       // an inconsistent state (pointing to the middle of callee-saved area).
509       // The interrupt handler can end up clobbering the registers.
510       AFI->setShouldRestoreSPFromFP(true);
511   }
512 
513   // Set FP to point to the stack slot that contains the previous FP.
514   // For iOS, FP is R7, which has now been stored in spill area 1.
515   // Otherwise, if this is not iOS, all the callee-saved registers go
516   // into spill area 1, including the FP in R11.  In either case, it
517   // is in area one and the adjustment needs to take place just after
518   // that push.
519   if (HasFP) {
520     MachineBasicBlock::iterator AfterPush = std::next(GPRCS1Push);
521     unsigned PushSize = sizeOfSPAdjustment(*GPRCS1Push);
522     emitRegPlusImmediate(!AFI->isThumbFunction(), MBB, AfterPush,
523                          dl, TII, FramePtr, ARM::SP,
524                          PushSize + FramePtrOffsetInPush,
525                          MachineInstr::FrameSetup);
526     if (FramePtrOffsetInPush + PushSize != 0) {
527       unsigned CFIIndex = MMI.addFrameInst(MCCFIInstruction::createDefCfa(
528           nullptr, MRI->getDwarfRegNum(FramePtr, true),
529           -(ArgRegsSaveSize - FramePtrOffsetInPush)));
530       BuildMI(MBB, AfterPush, dl, TII.get(TargetOpcode::CFI_INSTRUCTION))
531           .addCFIIndex(CFIIndex)
532           .setMIFlags(MachineInstr::FrameSetup);
533     } else {
534       unsigned CFIIndex =
535           MMI.addFrameInst(MCCFIInstruction::createDefCfaRegister(
536               nullptr, MRI->getDwarfRegNum(FramePtr, true)));
537       BuildMI(MBB, AfterPush, dl, TII.get(TargetOpcode::CFI_INSTRUCTION))
538           .addCFIIndex(CFIIndex)
539           .setMIFlags(MachineInstr::FrameSetup);
540     }
541   }
542 
543   // Now that the prologue's actual instructions are finalised, we can insert
544   // the necessary DWARF cf instructions to describe the situation. Start by
545   // recording where each register ended up:
546   if (GPRCS1Size > 0) {
547     MachineBasicBlock::iterator Pos = std::next(GPRCS1Push);
548     int CFIIndex;
549     for (const auto &Entry : CSI) {
550       unsigned Reg = Entry.getReg();
551       int FI = Entry.getFrameIdx();
552       switch (Reg) {
553       case ARM::R8:
554       case ARM::R9:
555       case ARM::R10:
556       case ARM::R11:
557       case ARM::R12:
558         if (STI.splitFramePushPop(MF))
559           break;
560         LLVM_FALLTHROUGH;
561       case ARM::R0:
562       case ARM::R1:
563       case ARM::R2:
564       case ARM::R3:
565       case ARM::R4:
566       case ARM::R5:
567       case ARM::R6:
568       case ARM::R7:
569       case ARM::LR:
570         CFIIndex = MMI.addFrameInst(MCCFIInstruction::createOffset(
571             nullptr, MRI->getDwarfRegNum(Reg, true), MFI.getObjectOffset(FI)));
572         BuildMI(MBB, Pos, dl, TII.get(TargetOpcode::CFI_INSTRUCTION))
573             .addCFIIndex(CFIIndex)
574             .setMIFlags(MachineInstr::FrameSetup);
575         break;
576       }
577     }
578   }
579 
580   if (GPRCS2Size > 0) {
581     MachineBasicBlock::iterator Pos = std::next(GPRCS2Push);
582     for (const auto &Entry : CSI) {
583       unsigned Reg = Entry.getReg();
584       int FI = Entry.getFrameIdx();
585       switch (Reg) {
586       case ARM::R8:
587       case ARM::R9:
588       case ARM::R10:
589       case ARM::R11:
590       case ARM::R12:
591         if (STI.splitFramePushPop(MF)) {
592           unsigned DwarfReg =  MRI->getDwarfRegNum(Reg, true);
593           unsigned Offset = MFI.getObjectOffset(FI);
594           unsigned CFIIndex = MMI.addFrameInst(
595               MCCFIInstruction::createOffset(nullptr, DwarfReg, Offset));
596           BuildMI(MBB, Pos, dl, TII.get(TargetOpcode::CFI_INSTRUCTION))
597               .addCFIIndex(CFIIndex)
598               .setMIFlags(MachineInstr::FrameSetup);
599         }
600         break;
601       }
602     }
603   }
604 
605   if (DPRCSSize > 0) {
606     // Since vpush register list cannot have gaps, there may be multiple vpush
607     // instructions in the prologue.
608     MachineBasicBlock::iterator Pos = std::next(LastPush);
609     for (const auto &Entry : CSI) {
610       unsigned Reg = Entry.getReg();
611       int FI = Entry.getFrameIdx();
612       if ((Reg >= ARM::D0 && Reg <= ARM::D31) &&
613           (Reg < ARM::D8 || Reg >= ARM::D8 + AFI->getNumAlignedDPRCS2Regs())) {
614         unsigned DwarfReg = MRI->getDwarfRegNum(Reg, true);
615         unsigned Offset = MFI.getObjectOffset(FI);
616         unsigned CFIIndex = MMI.addFrameInst(
617             MCCFIInstruction::createOffset(nullptr, DwarfReg, Offset));
618         BuildMI(MBB, Pos, dl, TII.get(TargetOpcode::CFI_INSTRUCTION))
619             .addCFIIndex(CFIIndex)
620             .setMIFlags(MachineInstr::FrameSetup);
621       }
622     }
623   }
624 
625   // Now we can emit descriptions of where the canonical frame address was
626   // throughout the process. If we have a frame pointer, it takes over the job
627   // half-way through, so only the first few .cfi_def_cfa_offset instructions
628   // actually get emitted.
629   DefCFAOffsetCandidates.emitDefCFAOffsets(MMI, MBB, dl, TII, HasFP);
630 
631   if (STI.isTargetELF() && hasFP(MF))
632     MFI.setOffsetAdjustment(MFI.getOffsetAdjustment() -
633                             AFI->getFramePtrSpillOffset());
634 
635   AFI->setGPRCalleeSavedArea1Size(GPRCS1Size);
636   AFI->setGPRCalleeSavedArea2Size(GPRCS2Size);
637   AFI->setDPRCalleeSavedGapSize(DPRGapSize);
638   AFI->setDPRCalleeSavedAreaSize(DPRCSSize);
639 
640   // If we need dynamic stack realignment, do it here. Be paranoid and make
641   // sure if we also have VLAs, we have a base pointer for frame access.
642   // If aligned NEON registers were spilled, the stack has already been
643   // realigned.
644   if (!AFI->getNumAlignedDPRCS2Regs() && RegInfo->needsStackRealignment(MF)) {
645     unsigned MaxAlign = MFI.getMaxAlignment();
646     assert(!AFI->isThumb1OnlyFunction());
647     if (!AFI->isThumbFunction()) {
648       emitAligningInstructions(MF, AFI, TII, MBB, MBBI, dl, ARM::SP, MaxAlign,
649                                false);
650     } else {
651       // We cannot use sp as source/dest register here, thus we're using r4 to
652       // perform the calculations. We're emitting the following sequence:
653       // mov r4, sp
654       // -- use emitAligningInstructions to produce best sequence to zero
655       // -- out lower bits in r4
656       // mov sp, r4
657       // FIXME: It will be better just to find spare register here.
658       AddDefaultPred(BuildMI(MBB, MBBI, dl, TII.get(ARM::tMOVr), ARM::R4)
659                          .addReg(ARM::SP, RegState::Kill));
660       emitAligningInstructions(MF, AFI, TII, MBB, MBBI, dl, ARM::R4, MaxAlign,
661                                false);
662       AddDefaultPred(BuildMI(MBB, MBBI, dl, TII.get(ARM::tMOVr), ARM::SP)
663                          .addReg(ARM::R4, RegState::Kill));
664     }
665 
666     AFI->setShouldRestoreSPFromFP(true);
667   }
668 
669   // If we need a base pointer, set it up here. It's whatever the value
670   // of the stack pointer is at this point. Any variable size objects
671   // will be allocated after this, so we can still use the base pointer
672   // to reference locals.
673   // FIXME: Clarify FrameSetup flags here.
674   if (RegInfo->hasBasePointer(MF)) {
675     if (isARM)
676       BuildMI(MBB, MBBI, dl,
677               TII.get(ARM::MOVr), RegInfo->getBaseRegister())
678         .addReg(ARM::SP)
679         .addImm((unsigned)ARMCC::AL).addReg(0).addReg(0);
680     else
681       AddDefaultPred(BuildMI(MBB, MBBI, dl, TII.get(ARM::tMOVr),
682                              RegInfo->getBaseRegister())
683         .addReg(ARM::SP));
684   }
685 
686   // If the frame has variable sized objects then the epilogue must restore
687   // the sp from fp. We can assume there's an FP here since hasFP already
688   // checks for hasVarSizedObjects.
689   if (MFI.hasVarSizedObjects())
690     AFI->setShouldRestoreSPFromFP(true);
691 }
692 
693 void ARMFrameLowering::emitEpilogue(MachineFunction &MF,
694                                     MachineBasicBlock &MBB) const {
695   MachineFrameInfo &MFI = MF.getFrameInfo();
696   ARMFunctionInfo *AFI = MF.getInfo<ARMFunctionInfo>();
697   const TargetRegisterInfo *RegInfo = MF.getSubtarget().getRegisterInfo();
698   const ARMBaseInstrInfo &TII =
699       *static_cast<const ARMBaseInstrInfo *>(MF.getSubtarget().getInstrInfo());
700   assert(!AFI->isThumb1OnlyFunction() &&
701          "This emitEpilogue does not support Thumb1!");
702   bool isARM = !AFI->isThumbFunction();
703 
704   unsigned ArgRegsSaveSize = AFI->getArgRegsSaveSize();
705   int NumBytes = (int)MFI.getStackSize();
706   unsigned FramePtr = RegInfo->getFrameRegister(MF);
707 
708   // All calls are tail calls in GHC calling conv, and functions have no
709   // prologue/epilogue.
710   if (MF.getFunction()->getCallingConv() == CallingConv::GHC)
711     return;
712 
713   // First put ourselves on the first (from top) terminator instructions.
714   MachineBasicBlock::iterator MBBI = MBB.getFirstTerminator();
715   DebugLoc dl = MBBI != MBB.end() ? MBBI->getDebugLoc() : DebugLoc();
716 
717   if (!AFI->hasStackFrame()) {
718     if (NumBytes - ArgRegsSaveSize != 0)
719       emitSPUpdate(isARM, MBB, MBBI, dl, TII, NumBytes - ArgRegsSaveSize);
720   } else {
721     // Unwind MBBI to point to first LDR / VLDRD.
722     const MCPhysReg *CSRegs = RegInfo->getCalleeSavedRegs(&MF);
723     if (MBBI != MBB.begin()) {
724       do {
725         --MBBI;
726       } while (MBBI != MBB.begin() && isCSRestore(*MBBI, TII, CSRegs));
727       if (!isCSRestore(*MBBI, TII, CSRegs))
728         ++MBBI;
729     }
730 
731     // Move SP to start of FP callee save spill area.
732     NumBytes -= (ArgRegsSaveSize +
733                  AFI->getGPRCalleeSavedArea1Size() +
734                  AFI->getGPRCalleeSavedArea2Size() +
735                  AFI->getDPRCalleeSavedGapSize() +
736                  AFI->getDPRCalleeSavedAreaSize());
737 
738     // Reset SP based on frame pointer only if the stack frame extends beyond
739     // frame pointer stack slot or target is ELF and the function has FP.
740     if (AFI->shouldRestoreSPFromFP()) {
741       NumBytes = AFI->getFramePtrSpillOffset() - NumBytes;
742       if (NumBytes) {
743         if (isARM)
744           emitARMRegPlusImmediate(MBB, MBBI, dl, ARM::SP, FramePtr, -NumBytes,
745                                   ARMCC::AL, 0, TII);
746         else {
747           // It's not possible to restore SP from FP in a single instruction.
748           // For iOS, this looks like:
749           // mov sp, r7
750           // sub sp, #24
751           // This is bad, if an interrupt is taken after the mov, sp is in an
752           // inconsistent state.
753           // Use the first callee-saved register as a scratch register.
754           assert(!MFI.getPristineRegs(MF).test(ARM::R4) &&
755                  "No scratch register to restore SP from FP!");
756           emitT2RegPlusImmediate(MBB, MBBI, dl, ARM::R4, FramePtr, -NumBytes,
757                                  ARMCC::AL, 0, TII);
758           AddDefaultPred(BuildMI(MBB, MBBI, dl, TII.get(ARM::tMOVr),
759                                  ARM::SP)
760             .addReg(ARM::R4));
761         }
762       } else {
763         // Thumb2 or ARM.
764         if (isARM)
765           BuildMI(MBB, MBBI, dl, TII.get(ARM::MOVr), ARM::SP)
766             .addReg(FramePtr).addImm((unsigned)ARMCC::AL).addReg(0).addReg(0);
767         else
768           AddDefaultPred(BuildMI(MBB, MBBI, dl, TII.get(ARM::tMOVr),
769                                  ARM::SP)
770             .addReg(FramePtr));
771       }
772     } else if (NumBytes &&
773                !tryFoldSPUpdateIntoPushPop(STI, MF, &*MBBI, NumBytes))
774       emitSPUpdate(isARM, MBB, MBBI, dl, TII, NumBytes);
775 
776     // Increment past our save areas.
777     if (MBBI != MBB.end() && AFI->getDPRCalleeSavedAreaSize()) {
778       MBBI++;
779       // Since vpop register list cannot have gaps, there may be multiple vpop
780       // instructions in the epilogue.
781       while (MBBI != MBB.end() && MBBI->getOpcode() == ARM::VLDMDIA_UPD)
782         MBBI++;
783     }
784     if (AFI->getDPRCalleeSavedGapSize()) {
785       assert(AFI->getDPRCalleeSavedGapSize() == 4 &&
786              "unexpected DPR alignment gap");
787       emitSPUpdate(isARM, MBB, MBBI, dl, TII, AFI->getDPRCalleeSavedGapSize());
788     }
789 
790     if (AFI->getGPRCalleeSavedArea2Size()) MBBI++;
791     if (AFI->getGPRCalleeSavedArea1Size()) MBBI++;
792   }
793 
794   if (ArgRegsSaveSize)
795     emitSPUpdate(isARM, MBB, MBBI, dl, TII, ArgRegsSaveSize);
796 }
797 
798 /// getFrameIndexReference - Provide a base+offset reference to an FI slot for
799 /// debug info.  It's the same as what we use for resolving the code-gen
800 /// references for now.  FIXME: This can go wrong when references are
801 /// SP-relative and simple call frames aren't used.
802 int
803 ARMFrameLowering::getFrameIndexReference(const MachineFunction &MF, int FI,
804                                          unsigned &FrameReg) const {
805   return ResolveFrameIndexReference(MF, FI, FrameReg, 0);
806 }
807 
808 int
809 ARMFrameLowering::ResolveFrameIndexReference(const MachineFunction &MF,
810                                              int FI, unsigned &FrameReg,
811                                              int SPAdj) const {
812   const MachineFrameInfo &MFI = MF.getFrameInfo();
813   const ARMBaseRegisterInfo *RegInfo = static_cast<const ARMBaseRegisterInfo *>(
814       MF.getSubtarget().getRegisterInfo());
815   const ARMFunctionInfo *AFI = MF.getInfo<ARMFunctionInfo>();
816   int Offset = MFI.getObjectOffset(FI) + MFI.getStackSize();
817   int FPOffset = Offset - AFI->getFramePtrSpillOffset();
818   bool isFixed = MFI.isFixedObjectIndex(FI);
819 
820   FrameReg = ARM::SP;
821   Offset += SPAdj;
822 
823   // SP can move around if there are allocas.  We may also lose track of SP
824   // when emergency spilling inside a non-reserved call frame setup.
825   bool hasMovingSP = !hasReservedCallFrame(MF);
826 
827   // When dynamically realigning the stack, use the frame pointer for
828   // parameters, and the stack/base pointer for locals.
829   if (RegInfo->needsStackRealignment(MF)) {
830     assert (hasFP(MF) && "dynamic stack realignment without a FP!");
831     if (isFixed) {
832       FrameReg = RegInfo->getFrameRegister(MF);
833       Offset = FPOffset;
834     } else if (hasMovingSP) {
835       assert(RegInfo->hasBasePointer(MF) &&
836              "VLAs and dynamic stack alignment, but missing base pointer!");
837       FrameReg = RegInfo->getBaseRegister();
838     }
839     return Offset;
840   }
841 
842   // If there is a frame pointer, use it when we can.
843   if (hasFP(MF) && AFI->hasStackFrame()) {
844     // Use frame pointer to reference fixed objects. Use it for locals if
845     // there are VLAs (and thus the SP isn't reliable as a base).
846     if (isFixed || (hasMovingSP && !RegInfo->hasBasePointer(MF))) {
847       FrameReg = RegInfo->getFrameRegister(MF);
848       return FPOffset;
849     } else if (hasMovingSP) {
850       assert(RegInfo->hasBasePointer(MF) && "missing base pointer!");
851       if (AFI->isThumb2Function()) {
852         // Try to use the frame pointer if we can, else use the base pointer
853         // since it's available. This is handy for the emergency spill slot, in
854         // particular.
855         if (FPOffset >= -255 && FPOffset < 0) {
856           FrameReg = RegInfo->getFrameRegister(MF);
857           return FPOffset;
858         }
859       }
860     } else if (AFI->isThumb2Function()) {
861       // Use  add <rd>, sp, #<imm8>
862       //      ldr <rd>, [sp, #<imm8>]
863       // if at all possible to save space.
864       if (Offset >= 0 && (Offset & 3) == 0 && Offset <= 1020)
865         return Offset;
866       // In Thumb2 mode, the negative offset is very limited. Try to avoid
867       // out of range references. ldr <rt>,[<rn>, #-<imm8>]
868       if (FPOffset >= -255 && FPOffset < 0) {
869         FrameReg = RegInfo->getFrameRegister(MF);
870         return FPOffset;
871       }
872     } else if (Offset > (FPOffset < 0 ? -FPOffset : FPOffset)) {
873       // Otherwise, use SP or FP, whichever is closer to the stack slot.
874       FrameReg = RegInfo->getFrameRegister(MF);
875       return FPOffset;
876     }
877   }
878   // Use the base pointer if we have one.
879   if (RegInfo->hasBasePointer(MF))
880     FrameReg = RegInfo->getBaseRegister();
881   return Offset;
882 }
883 
884 void ARMFrameLowering::emitPushInst(MachineBasicBlock &MBB,
885                                     MachineBasicBlock::iterator MI,
886                                     const std::vector<CalleeSavedInfo> &CSI,
887                                     unsigned StmOpc, unsigned StrOpc,
888                                     bool NoGap,
889                                     bool(*Func)(unsigned, bool),
890                                     unsigned NumAlignedDPRCS2Regs,
891                                     unsigned MIFlags) const {
892   MachineFunction &MF = *MBB.getParent();
893   const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
894 
895   DebugLoc DL;
896 
897   SmallVector<std::pair<unsigned,bool>, 4> Regs;
898   unsigned i = CSI.size();
899   while (i != 0) {
900     unsigned LastReg = 0;
901     for (; i != 0; --i) {
902       unsigned Reg = CSI[i-1].getReg();
903       if (!(Func)(Reg, STI.splitFramePushPop(MF))) continue;
904 
905       // D-registers in the aligned area DPRCS2 are NOT spilled here.
906       if (Reg >= ARM::D8 && Reg < ARM::D8 + NumAlignedDPRCS2Regs)
907         continue;
908 
909       bool isLiveIn = MF.getRegInfo().isLiveIn(Reg);
910       if (!isLiveIn)
911         MBB.addLiveIn(Reg);
912       // If NoGap is true, push consecutive registers and then leave the rest
913       // for other instructions. e.g.
914       // vpush {d8, d10, d11} -> vpush {d8}, vpush {d10, d11}
915       if (NoGap && LastReg && LastReg != Reg-1)
916         break;
917       LastReg = Reg;
918       // Do not set a kill flag on values that are also marked as live-in. This
919       // happens with the @llvm-returnaddress intrinsic and with arguments
920       // passed in callee saved registers.
921       // Omitting the kill flags is conservatively correct even if the live-in
922       // is not used after all.
923       Regs.push_back(std::make_pair(Reg, /*isKill=*/!isLiveIn));
924     }
925 
926     if (Regs.empty())
927       continue;
928     if (Regs.size() > 1 || StrOpc== 0) {
929       MachineInstrBuilder MIB =
930         AddDefaultPred(BuildMI(MBB, MI, DL, TII.get(StmOpc), ARM::SP)
931                        .addReg(ARM::SP).setMIFlags(MIFlags));
932       for (unsigned i = 0, e = Regs.size(); i < e; ++i)
933         MIB.addReg(Regs[i].first, getKillRegState(Regs[i].second));
934     } else if (Regs.size() == 1) {
935       MachineInstrBuilder MIB = BuildMI(MBB, MI, DL, TII.get(StrOpc),
936                                         ARM::SP)
937         .addReg(Regs[0].first, getKillRegState(Regs[0].second))
938         .addReg(ARM::SP).setMIFlags(MIFlags)
939         .addImm(-4);
940       AddDefaultPred(MIB);
941     }
942     Regs.clear();
943 
944     // Put any subsequent vpush instructions before this one: they will refer to
945     // higher register numbers so need to be pushed first in order to preserve
946     // monotonicity.
947     if (MI != MBB.begin())
948       --MI;
949   }
950 }
951 
952 void ARMFrameLowering::emitPopInst(MachineBasicBlock &MBB,
953                                    MachineBasicBlock::iterator MI,
954                                    const std::vector<CalleeSavedInfo> &CSI,
955                                    unsigned LdmOpc, unsigned LdrOpc,
956                                    bool isVarArg, bool NoGap,
957                                    bool(*Func)(unsigned, bool),
958                                    unsigned NumAlignedDPRCS2Regs) const {
959   MachineFunction &MF = *MBB.getParent();
960   const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
961   ARMFunctionInfo *AFI = MF.getInfo<ARMFunctionInfo>();
962   DebugLoc DL;
963   bool isTailCall = false;
964   bool isInterrupt = false;
965   bool isTrap = false;
966   if (MBB.end() != MI) {
967     DL = MI->getDebugLoc();
968     unsigned RetOpcode = MI->getOpcode();
969     isTailCall = (RetOpcode == ARM::TCRETURNdi || RetOpcode == ARM::TCRETURNri);
970     isInterrupt =
971         RetOpcode == ARM::SUBS_PC_LR || RetOpcode == ARM::t2SUBS_PC_LR;
972     isTrap =
973         RetOpcode == ARM::TRAP || RetOpcode == ARM::TRAPNaCl ||
974         RetOpcode == ARM::tTRAP;
975   }
976 
977   SmallVector<unsigned, 4> Regs;
978   unsigned i = CSI.size();
979   while (i != 0) {
980     unsigned LastReg = 0;
981     bool DeleteRet = false;
982     for (; i != 0; --i) {
983       unsigned Reg = CSI[i-1].getReg();
984       if (!(Func)(Reg, STI.splitFramePushPop(MF))) continue;
985 
986       // The aligned reloads from area DPRCS2 are not inserted here.
987       if (Reg >= ARM::D8 && Reg < ARM::D8 + NumAlignedDPRCS2Regs)
988         continue;
989 
990       if (Reg == ARM::LR && !isTailCall && !isVarArg && !isInterrupt &&
991           !isTrap && STI.hasV5TOps()) {
992         if (MBB.succ_empty()) {
993           Reg = ARM::PC;
994           DeleteRet = true;
995           LdmOpc = AFI->isThumbFunction() ? ARM::t2LDMIA_RET : ARM::LDMIA_RET;
996         } else
997           LdmOpc = AFI->isThumbFunction() ? ARM::t2LDMIA_UPD : ARM::LDMIA_UPD;
998         // Fold the return instruction into the LDM.
999       }
1000 
1001       // If NoGap is true, pop consecutive registers and then leave the rest
1002       // for other instructions. e.g.
1003       // vpop {d8, d10, d11} -> vpop {d8}, vpop {d10, d11}
1004       if (NoGap && LastReg && LastReg != Reg-1)
1005         break;
1006 
1007       LastReg = Reg;
1008       Regs.push_back(Reg);
1009     }
1010 
1011     if (Regs.empty())
1012       continue;
1013     if (Regs.size() > 1 || LdrOpc == 0) {
1014       MachineInstrBuilder MIB =
1015         AddDefaultPred(BuildMI(MBB, MI, DL, TII.get(LdmOpc), ARM::SP)
1016                        .addReg(ARM::SP));
1017       for (unsigned i = 0, e = Regs.size(); i < e; ++i)
1018         MIB.addReg(Regs[i], getDefRegState(true));
1019       if (DeleteRet && MI != MBB.end()) {
1020         MIB.copyImplicitOps(*MI);
1021         MI->eraseFromParent();
1022       }
1023       MI = MIB;
1024     } else if (Regs.size() == 1) {
1025       // If we adjusted the reg to PC from LR above, switch it back here. We
1026       // only do that for LDM.
1027       if (Regs[0] == ARM::PC)
1028         Regs[0] = ARM::LR;
1029       MachineInstrBuilder MIB =
1030         BuildMI(MBB, MI, DL, TII.get(LdrOpc), Regs[0])
1031           .addReg(ARM::SP, RegState::Define)
1032           .addReg(ARM::SP);
1033       // ARM mode needs an extra reg0 here due to addrmode2. Will go away once
1034       // that refactoring is complete (eventually).
1035       if (LdrOpc == ARM::LDR_POST_REG || LdrOpc == ARM::LDR_POST_IMM) {
1036         MIB.addReg(0);
1037         MIB.addImm(ARM_AM::getAM2Opc(ARM_AM::add, 4, ARM_AM::no_shift));
1038       } else
1039         MIB.addImm(4);
1040       AddDefaultPred(MIB);
1041     }
1042     Regs.clear();
1043 
1044     // Put any subsequent vpop instructions after this one: they will refer to
1045     // higher register numbers so need to be popped afterwards.
1046     if (MI != MBB.end())
1047       ++MI;
1048   }
1049 }
1050 
1051 /// Emit aligned spill instructions for NumAlignedDPRCS2Regs D-registers
1052 /// starting from d8.  Also insert stack realignment code and leave the stack
1053 /// pointer pointing to the d8 spill slot.
1054 static void emitAlignedDPRCS2Spills(MachineBasicBlock &MBB,
1055                                     MachineBasicBlock::iterator MI,
1056                                     unsigned NumAlignedDPRCS2Regs,
1057                                     const std::vector<CalleeSavedInfo> &CSI,
1058                                     const TargetRegisterInfo *TRI) {
1059   MachineFunction &MF = *MBB.getParent();
1060   ARMFunctionInfo *AFI = MF.getInfo<ARMFunctionInfo>();
1061   DebugLoc DL = MI != MBB.end() ? MI->getDebugLoc() : DebugLoc();
1062   const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
1063   MachineFrameInfo &MFI = MF.getFrameInfo();
1064 
1065   // Mark the D-register spill slots as properly aligned.  Since MFI computes
1066   // stack slot layout backwards, this can actually mean that the d-reg stack
1067   // slot offsets can be wrong. The offset for d8 will always be correct.
1068   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1069     unsigned DNum = CSI[i].getReg() - ARM::D8;
1070     if (DNum > NumAlignedDPRCS2Regs - 1)
1071       continue;
1072     int FI = CSI[i].getFrameIdx();
1073     // The even-numbered registers will be 16-byte aligned, the odd-numbered
1074     // registers will be 8-byte aligned.
1075     MFI.setObjectAlignment(FI, DNum % 2 ? 8 : 16);
1076 
1077     // The stack slot for D8 needs to be maximally aligned because this is
1078     // actually the point where we align the stack pointer.  MachineFrameInfo
1079     // computes all offsets relative to the incoming stack pointer which is a
1080     // bit weird when realigning the stack.  Any extra padding for this
1081     // over-alignment is not realized because the code inserted below adjusts
1082     // the stack pointer by numregs * 8 before aligning the stack pointer.
1083     if (DNum == 0)
1084       MFI.setObjectAlignment(FI, MFI.getMaxAlignment());
1085   }
1086 
1087   // Move the stack pointer to the d8 spill slot, and align it at the same
1088   // time. Leave the stack slot address in the scratch register r4.
1089   //
1090   //   sub r4, sp, #numregs * 8
1091   //   bic r4, r4, #align - 1
1092   //   mov sp, r4
1093   //
1094   bool isThumb = AFI->isThumbFunction();
1095   assert(!AFI->isThumb1OnlyFunction() && "Can't realign stack for thumb1");
1096   AFI->setShouldRestoreSPFromFP(true);
1097 
1098   // sub r4, sp, #numregs * 8
1099   // The immediate is <= 64, so it doesn't need any special encoding.
1100   unsigned Opc = isThumb ? ARM::t2SUBri : ARM::SUBri;
1101   AddDefaultCC(AddDefaultPred(BuildMI(MBB, MI, DL, TII.get(Opc), ARM::R4)
1102                                   .addReg(ARM::SP)
1103                                   .addImm(8 * NumAlignedDPRCS2Regs)));
1104 
1105   unsigned MaxAlign = MF.getFrameInfo().getMaxAlignment();
1106   // We must set parameter MustBeSingleInstruction to true, since
1107   // skipAlignedDPRCS2Spills expects exactly 3 instructions to perform
1108   // stack alignment.  Luckily, this can always be done since all ARM
1109   // architecture versions that support Neon also support the BFC
1110   // instruction.
1111   emitAligningInstructions(MF, AFI, TII, MBB, MI, DL, ARM::R4, MaxAlign, true);
1112 
1113   // mov sp, r4
1114   // The stack pointer must be adjusted before spilling anything, otherwise
1115   // the stack slots could be clobbered by an interrupt handler.
1116   // Leave r4 live, it is used below.
1117   Opc = isThumb ? ARM::tMOVr : ARM::MOVr;
1118   MachineInstrBuilder MIB = BuildMI(MBB, MI, DL, TII.get(Opc), ARM::SP)
1119                             .addReg(ARM::R4);
1120   MIB = AddDefaultPred(MIB);
1121   if (!isThumb)
1122     AddDefaultCC(MIB);
1123 
1124   // Now spill NumAlignedDPRCS2Regs registers starting from d8.
1125   // r4 holds the stack slot address.
1126   unsigned NextReg = ARM::D8;
1127 
1128   // 16-byte aligned vst1.64 with 4 d-regs and address writeback.
1129   // The writeback is only needed when emitting two vst1.64 instructions.
1130   if (NumAlignedDPRCS2Regs >= 6) {
1131     unsigned SupReg = TRI->getMatchingSuperReg(NextReg, ARM::dsub_0,
1132                                                &ARM::QQPRRegClass);
1133     MBB.addLiveIn(SupReg);
1134     AddDefaultPred(BuildMI(MBB, MI, DL, TII.get(ARM::VST1d64Qwb_fixed),
1135                            ARM::R4)
1136                    .addReg(ARM::R4, RegState::Kill).addImm(16)
1137                    .addReg(NextReg)
1138                    .addReg(SupReg, RegState::ImplicitKill));
1139     NextReg += 4;
1140     NumAlignedDPRCS2Regs -= 4;
1141   }
1142 
1143   // We won't modify r4 beyond this point.  It currently points to the next
1144   // register to be spilled.
1145   unsigned R4BaseReg = NextReg;
1146 
1147   // 16-byte aligned vst1.64 with 4 d-regs, no writeback.
1148   if (NumAlignedDPRCS2Regs >= 4) {
1149     unsigned SupReg = TRI->getMatchingSuperReg(NextReg, ARM::dsub_0,
1150                                                &ARM::QQPRRegClass);
1151     MBB.addLiveIn(SupReg);
1152     AddDefaultPred(BuildMI(MBB, MI, DL, TII.get(ARM::VST1d64Q))
1153                    .addReg(ARM::R4).addImm(16).addReg(NextReg)
1154                    .addReg(SupReg, RegState::ImplicitKill));
1155     NextReg += 4;
1156     NumAlignedDPRCS2Regs -= 4;
1157   }
1158 
1159   // 16-byte aligned vst1.64 with 2 d-regs.
1160   if (NumAlignedDPRCS2Regs >= 2) {
1161     unsigned SupReg = TRI->getMatchingSuperReg(NextReg, ARM::dsub_0,
1162                                                &ARM::QPRRegClass);
1163     MBB.addLiveIn(SupReg);
1164     AddDefaultPred(BuildMI(MBB, MI, DL, TII.get(ARM::VST1q64))
1165                    .addReg(ARM::R4).addImm(16).addReg(SupReg));
1166     NextReg += 2;
1167     NumAlignedDPRCS2Regs -= 2;
1168   }
1169 
1170   // Finally, use a vanilla vstr.64 for the odd last register.
1171   if (NumAlignedDPRCS2Regs) {
1172     MBB.addLiveIn(NextReg);
1173     // vstr.64 uses addrmode5 which has an offset scale of 4.
1174     AddDefaultPred(BuildMI(MBB, MI, DL, TII.get(ARM::VSTRD))
1175                    .addReg(NextReg)
1176                    .addReg(ARM::R4).addImm((NextReg-R4BaseReg)*2));
1177   }
1178 
1179   // The last spill instruction inserted should kill the scratch register r4.
1180   std::prev(MI)->addRegisterKilled(ARM::R4, TRI);
1181 }
1182 
1183 /// Skip past the code inserted by emitAlignedDPRCS2Spills, and return an
1184 /// iterator to the following instruction.
1185 static MachineBasicBlock::iterator
1186 skipAlignedDPRCS2Spills(MachineBasicBlock::iterator MI,
1187                         unsigned NumAlignedDPRCS2Regs) {
1188   //   sub r4, sp, #numregs * 8
1189   //   bic r4, r4, #align - 1
1190   //   mov sp, r4
1191   ++MI; ++MI; ++MI;
1192   assert(MI->mayStore() && "Expecting spill instruction");
1193 
1194   // These switches all fall through.
1195   switch(NumAlignedDPRCS2Regs) {
1196   case 7:
1197     ++MI;
1198     assert(MI->mayStore() && "Expecting spill instruction");
1199   default:
1200     ++MI;
1201     assert(MI->mayStore() && "Expecting spill instruction");
1202   case 1:
1203   case 2:
1204   case 4:
1205     assert(MI->killsRegister(ARM::R4) && "Missed kill flag");
1206     ++MI;
1207   }
1208   return MI;
1209 }
1210 
1211 /// Emit aligned reload instructions for NumAlignedDPRCS2Regs D-registers
1212 /// starting from d8.  These instructions are assumed to execute while the
1213 /// stack is still aligned, unlike the code inserted by emitPopInst.
1214 static void emitAlignedDPRCS2Restores(MachineBasicBlock &MBB,
1215                                       MachineBasicBlock::iterator MI,
1216                                       unsigned NumAlignedDPRCS2Regs,
1217                                       const std::vector<CalleeSavedInfo> &CSI,
1218                                       const TargetRegisterInfo *TRI) {
1219   MachineFunction &MF = *MBB.getParent();
1220   ARMFunctionInfo *AFI = MF.getInfo<ARMFunctionInfo>();
1221   DebugLoc DL = MI != MBB.end() ? MI->getDebugLoc() : DebugLoc();
1222   const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
1223 
1224   // Find the frame index assigned to d8.
1225   int D8SpillFI = 0;
1226   for (unsigned i = 0, e = CSI.size(); i != e; ++i)
1227     if (CSI[i].getReg() == ARM::D8) {
1228       D8SpillFI = CSI[i].getFrameIdx();
1229       break;
1230     }
1231 
1232   // Materialize the address of the d8 spill slot into the scratch register r4.
1233   // This can be fairly complicated if the stack frame is large, so just use
1234   // the normal frame index elimination mechanism to do it.  This code runs as
1235   // the initial part of the epilog where the stack and base pointers haven't
1236   // been changed yet.
1237   bool isThumb = AFI->isThumbFunction();
1238   assert(!AFI->isThumb1OnlyFunction() && "Can't realign stack for thumb1");
1239 
1240   unsigned Opc = isThumb ? ARM::t2ADDri : ARM::ADDri;
1241   AddDefaultCC(AddDefaultPred(BuildMI(MBB, MI, DL, TII.get(Opc), ARM::R4)
1242                               .addFrameIndex(D8SpillFI).addImm(0)));
1243 
1244   // Now restore NumAlignedDPRCS2Regs registers starting from d8.
1245   unsigned NextReg = ARM::D8;
1246 
1247   // 16-byte aligned vld1.64 with 4 d-regs and writeback.
1248   if (NumAlignedDPRCS2Regs >= 6) {
1249     unsigned SupReg = TRI->getMatchingSuperReg(NextReg, ARM::dsub_0,
1250                                                &ARM::QQPRRegClass);
1251     AddDefaultPred(BuildMI(MBB, MI, DL, TII.get(ARM::VLD1d64Qwb_fixed), NextReg)
1252                    .addReg(ARM::R4, RegState::Define)
1253                    .addReg(ARM::R4, RegState::Kill).addImm(16)
1254                    .addReg(SupReg, RegState::ImplicitDefine));
1255     NextReg += 4;
1256     NumAlignedDPRCS2Regs -= 4;
1257   }
1258 
1259   // We won't modify r4 beyond this point.  It currently points to the next
1260   // register to be spilled.
1261   unsigned R4BaseReg = NextReg;
1262 
1263   // 16-byte aligned vld1.64 with 4 d-regs, no writeback.
1264   if (NumAlignedDPRCS2Regs >= 4) {
1265     unsigned SupReg = TRI->getMatchingSuperReg(NextReg, ARM::dsub_0,
1266                                                &ARM::QQPRRegClass);
1267     AddDefaultPred(BuildMI(MBB, MI, DL, TII.get(ARM::VLD1d64Q), NextReg)
1268                    .addReg(ARM::R4).addImm(16)
1269                    .addReg(SupReg, RegState::ImplicitDefine));
1270     NextReg += 4;
1271     NumAlignedDPRCS2Regs -= 4;
1272   }
1273 
1274   // 16-byte aligned vld1.64 with 2 d-regs.
1275   if (NumAlignedDPRCS2Regs >= 2) {
1276     unsigned SupReg = TRI->getMatchingSuperReg(NextReg, ARM::dsub_0,
1277                                                &ARM::QPRRegClass);
1278     AddDefaultPred(BuildMI(MBB, MI, DL, TII.get(ARM::VLD1q64), SupReg)
1279                    .addReg(ARM::R4).addImm(16));
1280     NextReg += 2;
1281     NumAlignedDPRCS2Regs -= 2;
1282   }
1283 
1284   // Finally, use a vanilla vldr.64 for the remaining odd register.
1285   if (NumAlignedDPRCS2Regs)
1286     AddDefaultPred(BuildMI(MBB, MI, DL, TII.get(ARM::VLDRD), NextReg)
1287                    .addReg(ARM::R4).addImm(2*(NextReg-R4BaseReg)));
1288 
1289   // Last store kills r4.
1290   std::prev(MI)->addRegisterKilled(ARM::R4, TRI);
1291 }
1292 
1293 bool ARMFrameLowering::spillCalleeSavedRegisters(MachineBasicBlock &MBB,
1294                                         MachineBasicBlock::iterator MI,
1295                                         const std::vector<CalleeSavedInfo> &CSI,
1296                                         const TargetRegisterInfo *TRI) const {
1297   if (CSI.empty())
1298     return false;
1299 
1300   MachineFunction &MF = *MBB.getParent();
1301   ARMFunctionInfo *AFI = MF.getInfo<ARMFunctionInfo>();
1302 
1303   unsigned PushOpc = AFI->isThumbFunction() ? ARM::t2STMDB_UPD : ARM::STMDB_UPD;
1304   unsigned PushOneOpc = AFI->isThumbFunction() ?
1305     ARM::t2STR_PRE : ARM::STR_PRE_IMM;
1306   unsigned FltOpc = ARM::VSTMDDB_UPD;
1307   unsigned NumAlignedDPRCS2Regs = AFI->getNumAlignedDPRCS2Regs();
1308   emitPushInst(MBB, MI, CSI, PushOpc, PushOneOpc, false, &isARMArea1Register, 0,
1309                MachineInstr::FrameSetup);
1310   emitPushInst(MBB, MI, CSI, PushOpc, PushOneOpc, false, &isARMArea2Register, 0,
1311                MachineInstr::FrameSetup);
1312   emitPushInst(MBB, MI, CSI, FltOpc, 0, true, &isARMArea3Register,
1313                NumAlignedDPRCS2Regs, MachineInstr::FrameSetup);
1314 
1315   // The code above does not insert spill code for the aligned DPRCS2 registers.
1316   // The stack realignment code will be inserted between the push instructions
1317   // and these spills.
1318   if (NumAlignedDPRCS2Regs)
1319     emitAlignedDPRCS2Spills(MBB, MI, NumAlignedDPRCS2Regs, CSI, TRI);
1320 
1321   return true;
1322 }
1323 
1324 bool ARMFrameLowering::restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
1325                                         MachineBasicBlock::iterator MI,
1326                                         const std::vector<CalleeSavedInfo> &CSI,
1327                                         const TargetRegisterInfo *TRI) const {
1328   if (CSI.empty())
1329     return false;
1330 
1331   MachineFunction &MF = *MBB.getParent();
1332   ARMFunctionInfo *AFI = MF.getInfo<ARMFunctionInfo>();
1333   bool isVarArg = AFI->getArgRegsSaveSize() > 0;
1334   unsigned NumAlignedDPRCS2Regs = AFI->getNumAlignedDPRCS2Regs();
1335 
1336   // The emitPopInst calls below do not insert reloads for the aligned DPRCS2
1337   // registers. Do that here instead.
1338   if (NumAlignedDPRCS2Regs)
1339     emitAlignedDPRCS2Restores(MBB, MI, NumAlignedDPRCS2Regs, CSI, TRI);
1340 
1341   unsigned PopOpc = AFI->isThumbFunction() ? ARM::t2LDMIA_UPD : ARM::LDMIA_UPD;
1342   unsigned LdrOpc = AFI->isThumbFunction() ? ARM::t2LDR_POST :ARM::LDR_POST_IMM;
1343   unsigned FltOpc = ARM::VLDMDIA_UPD;
1344   emitPopInst(MBB, MI, CSI, FltOpc, 0, isVarArg, true, &isARMArea3Register,
1345               NumAlignedDPRCS2Regs);
1346   emitPopInst(MBB, MI, CSI, PopOpc, LdrOpc, isVarArg, false,
1347               &isARMArea2Register, 0);
1348   emitPopInst(MBB, MI, CSI, PopOpc, LdrOpc, isVarArg, false,
1349               &isARMArea1Register, 0);
1350 
1351   return true;
1352 }
1353 
1354 // FIXME: Make generic?
1355 static unsigned GetFunctionSizeInBytes(const MachineFunction &MF,
1356                                        const ARMBaseInstrInfo &TII) {
1357   unsigned FnSize = 0;
1358   for (auto &MBB : MF) {
1359     for (auto &MI : MBB)
1360       FnSize += TII.getInstSizeInBytes(MI);
1361   }
1362   return FnSize;
1363 }
1364 
1365 /// estimateRSStackSizeLimit - Look at each instruction that references stack
1366 /// frames and return the stack size limit beyond which some of these
1367 /// instructions will require a scratch register during their expansion later.
1368 // FIXME: Move to TII?
1369 static unsigned estimateRSStackSizeLimit(MachineFunction &MF,
1370                                          const TargetFrameLowering *TFI) {
1371   const ARMFunctionInfo *AFI = MF.getInfo<ARMFunctionInfo>();
1372   unsigned Limit = (1 << 12) - 1;
1373   for (auto &MBB : MF) {
1374     for (auto &MI : MBB) {
1375       for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
1376         if (!MI.getOperand(i).isFI())
1377           continue;
1378 
1379         // When using ADDri to get the address of a stack object, 255 is the
1380         // largest offset guaranteed to fit in the immediate offset.
1381         if (MI.getOpcode() == ARM::ADDri) {
1382           Limit = std::min(Limit, (1U << 8) - 1);
1383           break;
1384         }
1385 
1386         // Otherwise check the addressing mode.
1387         switch (MI.getDesc().TSFlags & ARMII::AddrModeMask) {
1388         case ARMII::AddrMode3:
1389         case ARMII::AddrModeT2_i8:
1390           Limit = std::min(Limit, (1U << 8) - 1);
1391           break;
1392         case ARMII::AddrMode5:
1393         case ARMII::AddrModeT2_i8s4:
1394           Limit = std::min(Limit, ((1U << 8) - 1) * 4);
1395           break;
1396         case ARMII::AddrModeT2_i12:
1397           // i12 supports only positive offset so these will be converted to
1398           // i8 opcodes. See llvm::rewriteT2FrameIndex.
1399           if (TFI->hasFP(MF) && AFI->hasStackFrame())
1400             Limit = std::min(Limit, (1U << 8) - 1);
1401           break;
1402         case ARMII::AddrMode4:
1403         case ARMII::AddrMode6:
1404           // Addressing modes 4 & 6 (load/store) instructions can't encode an
1405           // immediate offset for stack references.
1406           return 0;
1407         default:
1408           break;
1409         }
1410         break; // At most one FI per instruction
1411       }
1412     }
1413   }
1414 
1415   return Limit;
1416 }
1417 
1418 // In functions that realign the stack, it can be an advantage to spill the
1419 // callee-saved vector registers after realigning the stack. The vst1 and vld1
1420 // instructions take alignment hints that can improve performance.
1421 //
1422 static void
1423 checkNumAlignedDPRCS2Regs(MachineFunction &MF, BitVector &SavedRegs) {
1424   MF.getInfo<ARMFunctionInfo>()->setNumAlignedDPRCS2Regs(0);
1425   if (!SpillAlignedNEONRegs)
1426     return;
1427 
1428   // Naked functions don't spill callee-saved registers.
1429   if (MF.getFunction()->hasFnAttribute(Attribute::Naked))
1430     return;
1431 
1432   // We are planning to use NEON instructions vst1 / vld1.
1433   if (!static_cast<const ARMSubtarget &>(MF.getSubtarget()).hasNEON())
1434     return;
1435 
1436   // Don't bother if the default stack alignment is sufficiently high.
1437   if (MF.getSubtarget().getFrameLowering()->getStackAlignment() >= 8)
1438     return;
1439 
1440   // Aligned spills require stack realignment.
1441   if (!static_cast<const ARMBaseRegisterInfo *>(
1442            MF.getSubtarget().getRegisterInfo())->canRealignStack(MF))
1443     return;
1444 
1445   // We always spill contiguous d-registers starting from d8. Count how many
1446   // needs spilling.  The register allocator will almost always use the
1447   // callee-saved registers in order, but it can happen that there are holes in
1448   // the range.  Registers above the hole will be spilled to the standard DPRCS
1449   // area.
1450   unsigned NumSpills = 0;
1451   for (; NumSpills < 8; ++NumSpills)
1452     if (!SavedRegs.test(ARM::D8 + NumSpills))
1453       break;
1454 
1455   // Don't do this for just one d-register. It's not worth it.
1456   if (NumSpills < 2)
1457     return;
1458 
1459   // Spill the first NumSpills D-registers after realigning the stack.
1460   MF.getInfo<ARMFunctionInfo>()->setNumAlignedDPRCS2Regs(NumSpills);
1461 
1462   // A scratch register is required for the vst1 / vld1 instructions.
1463   SavedRegs.set(ARM::R4);
1464 }
1465 
1466 void ARMFrameLowering::determineCalleeSaves(MachineFunction &MF,
1467                                             BitVector &SavedRegs,
1468                                             RegScavenger *RS) const {
1469   TargetFrameLowering::determineCalleeSaves(MF, SavedRegs, RS);
1470   // This tells PEI to spill the FP as if it is any other callee-save register
1471   // to take advantage the eliminateFrameIndex machinery. This also ensures it
1472   // is spilled in the order specified by getCalleeSavedRegs() to make it easier
1473   // to combine multiple loads / stores.
1474   bool CanEliminateFrame = true;
1475   bool CS1Spilled = false;
1476   bool LRSpilled = false;
1477   unsigned NumGPRSpills = 0;
1478   unsigned NumFPRSpills = 0;
1479   SmallVector<unsigned, 4> UnspilledCS1GPRs;
1480   SmallVector<unsigned, 4> UnspilledCS2GPRs;
1481   const ARMBaseRegisterInfo *RegInfo = static_cast<const ARMBaseRegisterInfo *>(
1482       MF.getSubtarget().getRegisterInfo());
1483   const ARMBaseInstrInfo &TII =
1484       *static_cast<const ARMBaseInstrInfo *>(MF.getSubtarget().getInstrInfo());
1485   ARMFunctionInfo *AFI = MF.getInfo<ARMFunctionInfo>();
1486   MachineFrameInfo &MFI = MF.getFrameInfo();
1487   MachineRegisterInfo &MRI = MF.getRegInfo();
1488   unsigned FramePtr = RegInfo->getFrameRegister(MF);
1489 
1490   // Spill R4 if Thumb2 function requires stack realignment - it will be used as
1491   // scratch register. Also spill R4 if Thumb2 function has varsized objects,
1492   // since it's not always possible to restore sp from fp in a single
1493   // instruction.
1494   // FIXME: It will be better just to find spare register here.
1495   if (AFI->isThumb2Function() &&
1496       (MFI.hasVarSizedObjects() || RegInfo->needsStackRealignment(MF)))
1497     SavedRegs.set(ARM::R4);
1498 
1499   if (AFI->isThumb1OnlyFunction()) {
1500     // Spill LR if Thumb1 function uses variable length argument lists.
1501     if (AFI->getArgRegsSaveSize() > 0)
1502       SavedRegs.set(ARM::LR);
1503 
1504     // Spill R4 if Thumb1 epilogue has to restore SP from FP. We don't know
1505     // for sure what the stack size will be, but for this, an estimate is good
1506     // enough. If there anything changes it, it'll be a spill, which implies
1507     // we've used all the registers and so R4 is already used, so not marking
1508     // it here will be OK.
1509     // FIXME: It will be better just to find spare register here.
1510     unsigned StackSize = MFI.estimateStackSize(MF);
1511     if (MFI.hasVarSizedObjects() || StackSize > 508)
1512       SavedRegs.set(ARM::R4);
1513   }
1514 
1515   // See if we can spill vector registers to aligned stack.
1516   checkNumAlignedDPRCS2Regs(MF, SavedRegs);
1517 
1518   // Spill the BasePtr if it's used.
1519   if (RegInfo->hasBasePointer(MF))
1520     SavedRegs.set(RegInfo->getBaseRegister());
1521 
1522   // Don't spill FP if the frame can be eliminated. This is determined
1523   // by scanning the callee-save registers to see if any is modified.
1524   const MCPhysReg *CSRegs = RegInfo->getCalleeSavedRegs(&MF);
1525   for (unsigned i = 0; CSRegs[i]; ++i) {
1526     unsigned Reg = CSRegs[i];
1527     bool Spilled = false;
1528     if (SavedRegs.test(Reg)) {
1529       Spilled = true;
1530       CanEliminateFrame = false;
1531     }
1532 
1533     if (!ARM::GPRRegClass.contains(Reg)) {
1534       if (Spilled) {
1535         if (ARM::SPRRegClass.contains(Reg))
1536           NumFPRSpills++;
1537         else if (ARM::DPRRegClass.contains(Reg))
1538           NumFPRSpills += 2;
1539         else if (ARM::QPRRegClass.contains(Reg))
1540           NumFPRSpills += 4;
1541       }
1542       continue;
1543     }
1544 
1545     if (Spilled) {
1546       NumGPRSpills++;
1547 
1548       if (!STI.splitFramePushPop(MF)) {
1549         if (Reg == ARM::LR)
1550           LRSpilled = true;
1551         CS1Spilled = true;
1552         continue;
1553       }
1554 
1555       // Keep track if LR and any of R4, R5, R6, and R7 is spilled.
1556       switch (Reg) {
1557       case ARM::LR:
1558         LRSpilled = true;
1559         LLVM_FALLTHROUGH;
1560       case ARM::R0: case ARM::R1:
1561       case ARM::R2: case ARM::R3:
1562       case ARM::R4: case ARM::R5:
1563       case ARM::R6: case ARM::R7:
1564         CS1Spilled = true;
1565         break;
1566       default:
1567         break;
1568       }
1569     } else {
1570       if (!STI.splitFramePushPop(MF)) {
1571         UnspilledCS1GPRs.push_back(Reg);
1572         continue;
1573       }
1574 
1575       switch (Reg) {
1576       case ARM::R0: case ARM::R1:
1577       case ARM::R2: case ARM::R3:
1578       case ARM::R4: case ARM::R5:
1579       case ARM::R6: case ARM::R7:
1580       case ARM::LR:
1581         UnspilledCS1GPRs.push_back(Reg);
1582         break;
1583       default:
1584         UnspilledCS2GPRs.push_back(Reg);
1585         break;
1586       }
1587     }
1588   }
1589 
1590   bool ForceLRSpill = false;
1591   if (!LRSpilled && AFI->isThumb1OnlyFunction()) {
1592     unsigned FnSize = GetFunctionSizeInBytes(MF, TII);
1593     // Force LR to be spilled if the Thumb function size is > 2048. This enables
1594     // use of BL to implement far jump. If it turns out that it's not needed
1595     // then the branch fix up path will undo it.
1596     if (FnSize >= (1 << 11)) {
1597       CanEliminateFrame = false;
1598       ForceLRSpill = true;
1599     }
1600   }
1601 
1602   // If any of the stack slot references may be out of range of an immediate
1603   // offset, make sure a register (or a spill slot) is available for the
1604   // register scavenger. Note that if we're indexing off the frame pointer, the
1605   // effective stack size is 4 bytes larger since the FP points to the stack
1606   // slot of the previous FP. Also, if we have variable sized objects in the
1607   // function, stack slot references will often be negative, and some of
1608   // our instructions are positive-offset only, so conservatively consider
1609   // that case to want a spill slot (or register) as well. Similarly, if
1610   // the function adjusts the stack pointer during execution and the
1611   // adjustments aren't already part of our stack size estimate, our offset
1612   // calculations may be off, so be conservative.
1613   // FIXME: We could add logic to be more precise about negative offsets
1614   //        and which instructions will need a scratch register for them. Is it
1615   //        worth the effort and added fragility?
1616   unsigned EstimatedStackSize =
1617       MFI.estimateStackSize(MF) + 4 * (NumGPRSpills + NumFPRSpills);
1618   if (hasFP(MF)) {
1619     if (AFI->hasStackFrame())
1620       EstimatedStackSize += 4;
1621   } else {
1622     // If FP is not used, SP will be used to access arguments, so count the
1623     // size of arguments into the estimation.
1624     EstimatedStackSize += MF.getInfo<ARMFunctionInfo>()->getArgumentStackSize();
1625   }
1626   EstimatedStackSize += 16; // For possible paddings.
1627 
1628   bool BigStack = EstimatedStackSize >= estimateRSStackSizeLimit(MF, this) ||
1629                   MFI.hasVarSizedObjects() ||
1630                   (MFI.adjustsStack() && !canSimplifyCallFramePseudos(MF));
1631   bool ExtraCSSpill = false;
1632   if (BigStack || !CanEliminateFrame || RegInfo->cannotEliminateFrame(MF)) {
1633     AFI->setHasStackFrame(true);
1634 
1635     if (hasFP(MF)) {
1636       SavedRegs.set(FramePtr);
1637       // If the frame pointer is required by the ABI, also spill LR so that we
1638       // emit a complete frame record.
1639       if (MF.getTarget().Options.DisableFramePointerElim(MF) && !LRSpilled) {
1640         SavedRegs.set(ARM::LR);
1641         LRSpilled = true;
1642         NumGPRSpills++;
1643       }
1644       auto FPPos = find(UnspilledCS1GPRs, FramePtr);
1645       if (FPPos != UnspilledCS1GPRs.end())
1646         UnspilledCS1GPRs.erase(FPPos);
1647       NumGPRSpills++;
1648       if (FramePtr == ARM::R7)
1649         CS1Spilled = true;
1650     }
1651 
1652     // If LR is not spilled, but at least one of R4, R5, R6, and R7 is spilled.
1653     // Spill LR as well so we can fold BX_RET to the registers restore (LDM).
1654     if (!LRSpilled && CS1Spilled) {
1655       SavedRegs.set(ARM::LR);
1656       NumGPRSpills++;
1657       SmallVectorImpl<unsigned>::iterator LRPos;
1658       LRPos = find(UnspilledCS1GPRs, (unsigned)ARM::LR);
1659       if (LRPos != UnspilledCS1GPRs.end())
1660         UnspilledCS1GPRs.erase(LRPos);
1661 
1662       ForceLRSpill = false;
1663       ExtraCSSpill = true;
1664     }
1665 
1666     // If stack and double are 8-byte aligned and we are spilling an odd number
1667     // of GPRs, spill one extra callee save GPR so we won't have to pad between
1668     // the integer and double callee save areas.
1669     unsigned TargetAlign = getStackAlignment();
1670     if (TargetAlign >= 8 && (NumGPRSpills & 1)) {
1671       if (CS1Spilled && !UnspilledCS1GPRs.empty()) {
1672         for (unsigned i = 0, e = UnspilledCS1GPRs.size(); i != e; ++i) {
1673           unsigned Reg = UnspilledCS1GPRs[i];
1674           // Don't spill high register if the function is thumb.  In the case of
1675           // Windows on ARM, accept R11 (frame pointer)
1676           if (!AFI->isThumbFunction() ||
1677               (STI.isTargetWindows() && Reg == ARM::R11) ||
1678               isARMLowRegister(Reg) || Reg == ARM::LR) {
1679             SavedRegs.set(Reg);
1680             if (!MRI.isReserved(Reg))
1681               ExtraCSSpill = true;
1682             break;
1683           }
1684         }
1685       } else if (!UnspilledCS2GPRs.empty() && !AFI->isThumb1OnlyFunction()) {
1686         unsigned Reg = UnspilledCS2GPRs.front();
1687         SavedRegs.set(Reg);
1688         if (!MRI.isReserved(Reg))
1689           ExtraCSSpill = true;
1690       }
1691     }
1692 
1693     // Estimate if we might need to scavenge a register at some point in order
1694     // to materialize a stack offset. If so, either spill one additional
1695     // callee-saved register or reserve a special spill slot to facilitate
1696     // register scavenging. Thumb1 needs a spill slot for stack pointer
1697     // adjustments also, even when the frame itself is small.
1698     if (BigStack && !ExtraCSSpill) {
1699       // If any non-reserved CS register isn't spilled, just spill one or two
1700       // extra. That should take care of it!
1701       unsigned NumExtras = TargetAlign / 4;
1702       SmallVector<unsigned, 2> Extras;
1703       while (NumExtras && !UnspilledCS1GPRs.empty()) {
1704         unsigned Reg = UnspilledCS1GPRs.back();
1705         UnspilledCS1GPRs.pop_back();
1706         if (!MRI.isReserved(Reg) &&
1707             (!AFI->isThumb1OnlyFunction() || isARMLowRegister(Reg) ||
1708              Reg == ARM::LR)) {
1709           Extras.push_back(Reg);
1710           NumExtras--;
1711         }
1712       }
1713       // For non-Thumb1 functions, also check for hi-reg CS registers
1714       if (!AFI->isThumb1OnlyFunction()) {
1715         while (NumExtras && !UnspilledCS2GPRs.empty()) {
1716           unsigned Reg = UnspilledCS2GPRs.back();
1717           UnspilledCS2GPRs.pop_back();
1718           if (!MRI.isReserved(Reg)) {
1719             Extras.push_back(Reg);
1720             NumExtras--;
1721           }
1722         }
1723       }
1724       if (Extras.size() && NumExtras == 0) {
1725         for (unsigned i = 0, e = Extras.size(); i != e; ++i) {
1726           SavedRegs.set(Extras[i]);
1727         }
1728       } else if (!AFI->isThumb1OnlyFunction()) {
1729         // note: Thumb1 functions spill to R12, not the stack.  Reserve a slot
1730         // closest to SP or frame pointer.
1731         assert(RS && "Register scavenging not provided");
1732         const TargetRegisterClass *RC = &ARM::GPRRegClass;
1733         RS->addScavengingFrameIndex(MFI.CreateStackObject(RC->getSize(),
1734                                                           RC->getAlignment(),
1735                                                           false));
1736       }
1737     }
1738   }
1739 
1740   if (ForceLRSpill) {
1741     SavedRegs.set(ARM::LR);
1742     AFI->setLRIsSpilledForFarJump(true);
1743   }
1744 }
1745 
1746 MachineBasicBlock::iterator ARMFrameLowering::eliminateCallFramePseudoInstr(
1747     MachineFunction &MF, MachineBasicBlock &MBB,
1748     MachineBasicBlock::iterator I) const {
1749   const ARMBaseInstrInfo &TII =
1750       *static_cast<const ARMBaseInstrInfo *>(MF.getSubtarget().getInstrInfo());
1751   if (!hasReservedCallFrame(MF)) {
1752     // If we have alloca, convert as follows:
1753     // ADJCALLSTACKDOWN -> sub, sp, sp, amount
1754     // ADJCALLSTACKUP   -> add, sp, sp, amount
1755     MachineInstr &Old = *I;
1756     DebugLoc dl = Old.getDebugLoc();
1757     unsigned Amount = Old.getOperand(0).getImm();
1758     if (Amount != 0) {
1759       // We need to keep the stack aligned properly.  To do this, we round the
1760       // amount of space needed for the outgoing arguments up to the next
1761       // alignment boundary.
1762       Amount = alignSPAdjust(Amount);
1763 
1764       ARMFunctionInfo *AFI = MF.getInfo<ARMFunctionInfo>();
1765       assert(!AFI->isThumb1OnlyFunction() &&
1766              "This eliminateCallFramePseudoInstr does not support Thumb1!");
1767       bool isARM = !AFI->isThumbFunction();
1768 
1769       // Replace the pseudo instruction with a new instruction...
1770       unsigned Opc = Old.getOpcode();
1771       int PIdx = Old.findFirstPredOperandIdx();
1772       ARMCC::CondCodes Pred =
1773           (PIdx == -1) ? ARMCC::AL
1774                        : (ARMCC::CondCodes)Old.getOperand(PIdx).getImm();
1775       if (Opc == ARM::ADJCALLSTACKDOWN || Opc == ARM::tADJCALLSTACKDOWN) {
1776         // Note: PredReg is operand 2 for ADJCALLSTACKDOWN.
1777         unsigned PredReg = Old.getOperand(2).getReg();
1778         emitSPUpdate(isARM, MBB, I, dl, TII, -Amount, MachineInstr::NoFlags,
1779                      Pred, PredReg);
1780       } else {
1781         // Note: PredReg is operand 3 for ADJCALLSTACKUP.
1782         unsigned PredReg = Old.getOperand(3).getReg();
1783         assert(Opc == ARM::ADJCALLSTACKUP || Opc == ARM::tADJCALLSTACKUP);
1784         emitSPUpdate(isARM, MBB, I, dl, TII, Amount, MachineInstr::NoFlags,
1785                      Pred, PredReg);
1786       }
1787     }
1788   }
1789   return MBB.erase(I);
1790 }
1791 
1792 /// Get the minimum constant for ARM that is greater than or equal to the
1793 /// argument. In ARM, constants can have any value that can be produced by
1794 /// rotating an 8-bit value to the right by an even number of bits within a
1795 /// 32-bit word.
1796 static uint32_t alignToARMConstant(uint32_t Value) {
1797   unsigned Shifted = 0;
1798 
1799   if (Value == 0)
1800       return 0;
1801 
1802   while (!(Value & 0xC0000000)) {
1803       Value = Value << 2;
1804       Shifted += 2;
1805   }
1806 
1807   bool Carry = (Value & 0x00FFFFFF);
1808   Value = ((Value & 0xFF000000) >> 24) + Carry;
1809 
1810   if (Value & 0x0000100)
1811       Value = Value & 0x000001FC;
1812 
1813   if (Shifted > 24)
1814       Value = Value >> (Shifted - 24);
1815   else
1816       Value = Value << (24 - Shifted);
1817 
1818   return Value;
1819 }
1820 
1821 // The stack limit in the TCB is set to this many bytes above the actual
1822 // stack limit.
1823 static const uint64_t kSplitStackAvailable = 256;
1824 
1825 // Adjust the function prologue to enable split stacks. This currently only
1826 // supports android and linux.
1827 //
1828 // The ABI of the segmented stack prologue is a little arbitrarily chosen, but
1829 // must be well defined in order to allow for consistent implementations of the
1830 // __morestack helper function. The ABI is also not a normal ABI in that it
1831 // doesn't follow the normal calling conventions because this allows the
1832 // prologue of each function to be optimized further.
1833 //
1834 // Currently, the ABI looks like (when calling __morestack)
1835 //
1836 //  * r4 holds the minimum stack size requested for this function call
1837 //  * r5 holds the stack size of the arguments to the function
1838 //  * the beginning of the function is 3 instructions after the call to
1839 //    __morestack
1840 //
1841 // Implementations of __morestack should use r4 to allocate a new stack, r5 to
1842 // place the arguments on to the new stack, and the 3-instruction knowledge to
1843 // jump directly to the body of the function when working on the new stack.
1844 //
1845 // An old (and possibly no longer compatible) implementation of __morestack for
1846 // ARM can be found at [1].
1847 //
1848 // [1] - https://github.com/mozilla/rust/blob/86efd9/src/rt/arch/arm/morestack.S
1849 void ARMFrameLowering::adjustForSegmentedStacks(
1850     MachineFunction &MF, MachineBasicBlock &PrologueMBB) const {
1851   unsigned Opcode;
1852   unsigned CFIIndex;
1853   const ARMSubtarget *ST = &MF.getSubtarget<ARMSubtarget>();
1854   bool Thumb = ST->isThumb();
1855 
1856   // Sadly, this currently doesn't support varargs, platforms other than
1857   // android/linux. Note that thumb1/thumb2 are support for android/linux.
1858   if (MF.getFunction()->isVarArg())
1859     report_fatal_error("Segmented stacks do not support vararg functions.");
1860   if (!ST->isTargetAndroid() && !ST->isTargetLinux())
1861     report_fatal_error("Segmented stacks not supported on this platform.");
1862 
1863   MachineFrameInfo &MFI = MF.getFrameInfo();
1864   MachineModuleInfo &MMI = MF.getMMI();
1865   MCContext &Context = MMI.getContext();
1866   const MCRegisterInfo *MRI = Context.getRegisterInfo();
1867   const ARMBaseInstrInfo &TII =
1868       *static_cast<const ARMBaseInstrInfo *>(MF.getSubtarget().getInstrInfo());
1869   ARMFunctionInfo *ARMFI = MF.getInfo<ARMFunctionInfo>();
1870   DebugLoc DL;
1871 
1872   uint64_t StackSize = MFI.getStackSize();
1873 
1874   // Do not generate a prologue for functions with a stack of size zero
1875   if (StackSize == 0)
1876     return;
1877 
1878   // Use R4 and R5 as scratch registers.
1879   // We save R4 and R5 before use and restore them before leaving the function.
1880   unsigned ScratchReg0 = ARM::R4;
1881   unsigned ScratchReg1 = ARM::R5;
1882   uint64_t AlignedStackSize;
1883 
1884   MachineBasicBlock *PrevStackMBB = MF.CreateMachineBasicBlock();
1885   MachineBasicBlock *PostStackMBB = MF.CreateMachineBasicBlock();
1886   MachineBasicBlock *AllocMBB = MF.CreateMachineBasicBlock();
1887   MachineBasicBlock *GetMBB = MF.CreateMachineBasicBlock();
1888   MachineBasicBlock *McrMBB = MF.CreateMachineBasicBlock();
1889 
1890   // Grab everything that reaches PrologueMBB to update there liveness as well.
1891   SmallPtrSet<MachineBasicBlock *, 8> BeforePrologueRegion;
1892   SmallVector<MachineBasicBlock *, 2> WalkList;
1893   WalkList.push_back(&PrologueMBB);
1894 
1895   do {
1896     MachineBasicBlock *CurMBB = WalkList.pop_back_val();
1897     for (MachineBasicBlock *PredBB : CurMBB->predecessors()) {
1898       if (BeforePrologueRegion.insert(PredBB).second)
1899         WalkList.push_back(PredBB);
1900     }
1901   } while (!WalkList.empty());
1902 
1903   // The order in that list is important.
1904   // The blocks will all be inserted before PrologueMBB using that order.
1905   // Therefore the block that should appear first in the CFG should appear
1906   // first in the list.
1907   MachineBasicBlock *AddedBlocks[] = {PrevStackMBB, McrMBB, GetMBB, AllocMBB,
1908                                       PostStackMBB};
1909 
1910   for (MachineBasicBlock *B : AddedBlocks)
1911     BeforePrologueRegion.insert(B);
1912 
1913   for (const auto &LI : PrologueMBB.liveins()) {
1914     for (MachineBasicBlock *PredBB : BeforePrologueRegion)
1915       PredBB->addLiveIn(LI);
1916   }
1917 
1918   // Remove the newly added blocks from the list, since we know
1919   // we do not have to do the following updates for them.
1920   for (MachineBasicBlock *B : AddedBlocks) {
1921     BeforePrologueRegion.erase(B);
1922     MF.insert(PrologueMBB.getIterator(), B);
1923   }
1924 
1925   for (MachineBasicBlock *MBB : BeforePrologueRegion) {
1926     // Make sure the LiveIns are still sorted and unique.
1927     MBB->sortUniqueLiveIns();
1928     // Replace the edges to PrologueMBB by edges to the sequences
1929     // we are about to add.
1930     MBB->ReplaceUsesOfBlockWith(&PrologueMBB, AddedBlocks[0]);
1931   }
1932 
1933   // The required stack size that is aligned to ARM constant criterion.
1934   AlignedStackSize = alignToARMConstant(StackSize);
1935 
1936   // When the frame size is less than 256 we just compare the stack
1937   // boundary directly to the value of the stack pointer, per gcc.
1938   bool CompareStackPointer = AlignedStackSize < kSplitStackAvailable;
1939 
1940   // We will use two of the callee save registers as scratch registers so we
1941   // need to save those registers onto the stack.
1942   // We will use SR0 to hold stack limit and SR1 to hold the stack size
1943   // requested and arguments for __morestack().
1944   // SR0: Scratch Register #0
1945   // SR1: Scratch Register #1
1946   // push {SR0, SR1}
1947   if (Thumb) {
1948     AddDefaultPred(BuildMI(PrevStackMBB, DL, TII.get(ARM::tPUSH)))
1949         .addReg(ScratchReg0).addReg(ScratchReg1);
1950   } else {
1951     AddDefaultPred(BuildMI(PrevStackMBB, DL, TII.get(ARM::STMDB_UPD))
1952                    .addReg(ARM::SP, RegState::Define).addReg(ARM::SP))
1953         .addReg(ScratchReg0).addReg(ScratchReg1);
1954   }
1955 
1956   // Emit the relevant DWARF information about the change in stack pointer as
1957   // well as where to find both r4 and r5 (the callee-save registers)
1958   CFIIndex =
1959       MMI.addFrameInst(MCCFIInstruction::createDefCfaOffset(nullptr, -8));
1960   BuildMI(PrevStackMBB, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
1961       .addCFIIndex(CFIIndex);
1962   CFIIndex = MMI.addFrameInst(MCCFIInstruction::createOffset(
1963       nullptr, MRI->getDwarfRegNum(ScratchReg1, true), -4));
1964   BuildMI(PrevStackMBB, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
1965       .addCFIIndex(CFIIndex);
1966   CFIIndex = MMI.addFrameInst(MCCFIInstruction::createOffset(
1967       nullptr, MRI->getDwarfRegNum(ScratchReg0, true), -8));
1968   BuildMI(PrevStackMBB, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
1969       .addCFIIndex(CFIIndex);
1970 
1971   // mov SR1, sp
1972   if (Thumb) {
1973     AddDefaultPred(BuildMI(McrMBB, DL, TII.get(ARM::tMOVr), ScratchReg1)
1974                       .addReg(ARM::SP));
1975   } else if (CompareStackPointer) {
1976     AddDefaultPred(BuildMI(McrMBB, DL, TII.get(ARM::MOVr), ScratchReg1)
1977                       .addReg(ARM::SP)).addReg(0);
1978   }
1979 
1980   // sub SR1, sp, #StackSize
1981   if (!CompareStackPointer && Thumb) {
1982     AddDefaultPred(
1983         AddDefaultCC(BuildMI(McrMBB, DL, TII.get(ARM::tSUBi8), ScratchReg1))
1984             .addReg(ScratchReg1).addImm(AlignedStackSize));
1985   } else if (!CompareStackPointer) {
1986     AddDefaultPred(BuildMI(McrMBB, DL, TII.get(ARM::SUBri), ScratchReg1)
1987                       .addReg(ARM::SP).addImm(AlignedStackSize)).addReg(0);
1988   }
1989 
1990   if (Thumb && ST->isThumb1Only()) {
1991     unsigned PCLabelId = ARMFI->createPICLabelUId();
1992     ARMConstantPoolValue *NewCPV = ARMConstantPoolSymbol::Create(
1993         MF.getFunction()->getContext(), "__STACK_LIMIT", PCLabelId, 0);
1994     MachineConstantPool *MCP = MF.getConstantPool();
1995     unsigned CPI = MCP->getConstantPoolIndex(NewCPV, 4);
1996 
1997     // ldr SR0, [pc, offset(STACK_LIMIT)]
1998     AddDefaultPred(BuildMI(GetMBB, DL, TII.get(ARM::tLDRpci), ScratchReg0)
1999                       .addConstantPoolIndex(CPI));
2000 
2001     // ldr SR0, [SR0]
2002     AddDefaultPred(BuildMI(GetMBB, DL, TII.get(ARM::tLDRi), ScratchReg0)
2003                       .addReg(ScratchReg0).addImm(0));
2004   } else {
2005     // Get TLS base address from the coprocessor
2006     // mrc p15, #0, SR0, c13, c0, #3
2007     AddDefaultPred(BuildMI(McrMBB, DL, TII.get(ARM::MRC), ScratchReg0)
2008                      .addImm(15)
2009                      .addImm(0)
2010                      .addImm(13)
2011                      .addImm(0)
2012                      .addImm(3));
2013 
2014     // Use the last tls slot on android and a private field of the TCP on linux.
2015     assert(ST->isTargetAndroid() || ST->isTargetLinux());
2016     unsigned TlsOffset = ST->isTargetAndroid() ? 63 : 1;
2017 
2018     // Get the stack limit from the right offset
2019     // ldr SR0, [sr0, #4 * TlsOffset]
2020     AddDefaultPred(BuildMI(GetMBB, DL, TII.get(ARM::LDRi12), ScratchReg0)
2021                       .addReg(ScratchReg0).addImm(4 * TlsOffset));
2022   }
2023 
2024   // Compare stack limit with stack size requested.
2025   // cmp SR0, SR1
2026   Opcode = Thumb ? ARM::tCMPr : ARM::CMPrr;
2027   AddDefaultPred(BuildMI(GetMBB, DL, TII.get(Opcode))
2028                     .addReg(ScratchReg0)
2029                     .addReg(ScratchReg1));
2030 
2031   // This jump is taken if StackLimit < SP - stack required.
2032   Opcode = Thumb ? ARM::tBcc : ARM::Bcc;
2033   BuildMI(GetMBB, DL, TII.get(Opcode)).addMBB(PostStackMBB)
2034        .addImm(ARMCC::LO)
2035        .addReg(ARM::CPSR);
2036 
2037 
2038   // Calling __morestack(StackSize, Size of stack arguments).
2039   // __morestack knows that the stack size requested is in SR0(r4)
2040   // and amount size of stack arguments is in SR1(r5).
2041 
2042   // Pass first argument for the __morestack by Scratch Register #0.
2043   //   The amount size of stack required
2044   if (Thumb) {
2045     AddDefaultPred(AddDefaultCC(BuildMI(AllocMBB, DL, TII.get(ARM::tMOVi8),
2046                                         ScratchReg0)).addImm(AlignedStackSize));
2047   } else {
2048     AddDefaultPred(BuildMI(AllocMBB, DL, TII.get(ARM::MOVi), ScratchReg0)
2049                       .addImm(AlignedStackSize)).addReg(0);
2050   }
2051   // Pass second argument for the __morestack by Scratch Register #1.
2052   //   The amount size of stack consumed to save function arguments.
2053   if (Thumb) {
2054     AddDefaultPred(
2055         AddDefaultCC(BuildMI(AllocMBB, DL, TII.get(ARM::tMOVi8), ScratchReg1))
2056             .addImm(alignToARMConstant(ARMFI->getArgumentStackSize())));
2057   } else {
2058     AddDefaultPred(BuildMI(AllocMBB, DL, TII.get(ARM::MOVi), ScratchReg1)
2059                    .addImm(alignToARMConstant(ARMFI->getArgumentStackSize())))
2060                    .addReg(0);
2061   }
2062 
2063   // push {lr} - Save return address of this function.
2064   if (Thumb) {
2065     AddDefaultPred(BuildMI(AllocMBB, DL, TII.get(ARM::tPUSH)))
2066         .addReg(ARM::LR);
2067   } else {
2068     AddDefaultPred(BuildMI(AllocMBB, DL, TII.get(ARM::STMDB_UPD))
2069                    .addReg(ARM::SP, RegState::Define)
2070                    .addReg(ARM::SP))
2071         .addReg(ARM::LR);
2072   }
2073 
2074   // Emit the DWARF info about the change in stack as well as where to find the
2075   // previous link register
2076   CFIIndex =
2077       MMI.addFrameInst(MCCFIInstruction::createDefCfaOffset(nullptr, -12));
2078   BuildMI(AllocMBB, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
2079       .addCFIIndex(CFIIndex);
2080   CFIIndex = MMI.addFrameInst(MCCFIInstruction::createOffset(
2081         nullptr, MRI->getDwarfRegNum(ARM::LR, true), -12));
2082   BuildMI(AllocMBB, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
2083       .addCFIIndex(CFIIndex);
2084 
2085   // Call __morestack().
2086   if (Thumb) {
2087     AddDefaultPred(BuildMI(AllocMBB, DL, TII.get(ARM::tBL)))
2088         .addExternalSymbol("__morestack");
2089   } else {
2090     BuildMI(AllocMBB, DL, TII.get(ARM::BL))
2091         .addExternalSymbol("__morestack");
2092   }
2093 
2094   // pop {lr} - Restore return address of this original function.
2095   if (Thumb) {
2096     if (ST->isThumb1Only()) {
2097       AddDefaultPred(BuildMI(AllocMBB, DL, TII.get(ARM::tPOP)))
2098                      .addReg(ScratchReg0);
2099       AddDefaultPred(BuildMI(AllocMBB, DL, TII.get(ARM::tMOVr), ARM::LR)
2100                      .addReg(ScratchReg0));
2101     } else {
2102       AddDefaultPred(BuildMI(AllocMBB, DL, TII.get(ARM::t2LDR_POST))
2103                      .addReg(ARM::LR, RegState::Define)
2104                      .addReg(ARM::SP, RegState::Define)
2105                      .addReg(ARM::SP)
2106                      .addImm(4));
2107     }
2108   } else {
2109     AddDefaultPred(BuildMI(AllocMBB, DL, TII.get(ARM::LDMIA_UPD))
2110                    .addReg(ARM::SP, RegState::Define)
2111                    .addReg(ARM::SP))
2112       .addReg(ARM::LR);
2113   }
2114 
2115   // Restore SR0 and SR1 in case of __morestack() was called.
2116   // __morestack() will skip PostStackMBB block so we need to restore
2117   // scratch registers from here.
2118   // pop {SR0, SR1}
2119   if (Thumb) {
2120     AddDefaultPred(BuildMI(AllocMBB, DL, TII.get(ARM::tPOP)))
2121       .addReg(ScratchReg0)
2122       .addReg(ScratchReg1);
2123   } else {
2124     AddDefaultPred(BuildMI(AllocMBB, DL, TII.get(ARM::LDMIA_UPD))
2125                    .addReg(ARM::SP, RegState::Define)
2126                    .addReg(ARM::SP))
2127       .addReg(ScratchReg0)
2128       .addReg(ScratchReg1);
2129   }
2130 
2131   // Update the CFA offset now that we've popped
2132   CFIIndex = MMI.addFrameInst(MCCFIInstruction::createDefCfaOffset(nullptr, 0));
2133   BuildMI(AllocMBB, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
2134       .addCFIIndex(CFIIndex);
2135 
2136   // bx lr - Return from this function.
2137   Opcode = Thumb ? ARM::tBX_RET : ARM::BX_RET;
2138   AddDefaultPred(BuildMI(AllocMBB, DL, TII.get(Opcode)));
2139 
2140   // Restore SR0 and SR1 in case of __morestack() was not called.
2141   // pop {SR0, SR1}
2142   if (Thumb) {
2143     AddDefaultPred(BuildMI(PostStackMBB, DL, TII.get(ARM::tPOP)))
2144       .addReg(ScratchReg0)
2145       .addReg(ScratchReg1);
2146   } else {
2147     AddDefaultPred(BuildMI(PostStackMBB, DL, TII.get(ARM::LDMIA_UPD))
2148                    .addReg(ARM::SP, RegState::Define)
2149                    .addReg(ARM::SP))
2150       .addReg(ScratchReg0)
2151       .addReg(ScratchReg1);
2152   }
2153 
2154   // Update the CFA offset now that we've popped
2155   CFIIndex = MMI.addFrameInst(MCCFIInstruction::createDefCfaOffset(nullptr, 0));
2156   BuildMI(PostStackMBB, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
2157       .addCFIIndex(CFIIndex);
2158 
2159   // Tell debuggers that r4 and r5 are now the same as they were in the
2160   // previous function, that they're the "Same Value".
2161   CFIIndex = MMI.addFrameInst(MCCFIInstruction::createSameValue(
2162       nullptr, MRI->getDwarfRegNum(ScratchReg0, true)));
2163   BuildMI(PostStackMBB, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
2164       .addCFIIndex(CFIIndex);
2165   CFIIndex = MMI.addFrameInst(MCCFIInstruction::createSameValue(
2166       nullptr, MRI->getDwarfRegNum(ScratchReg1, true)));
2167   BuildMI(PostStackMBB, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
2168       .addCFIIndex(CFIIndex);
2169 
2170   // Organizing MBB lists
2171   PostStackMBB->addSuccessor(&PrologueMBB);
2172 
2173   AllocMBB->addSuccessor(PostStackMBB);
2174 
2175   GetMBB->addSuccessor(PostStackMBB);
2176   GetMBB->addSuccessor(AllocMBB);
2177 
2178   McrMBB->addSuccessor(GetMBB);
2179 
2180   PrevStackMBB->addSuccessor(McrMBB);
2181 
2182 #ifdef EXPENSIVE_CHECKS
2183   MF.verify();
2184 #endif
2185 }
2186