lib/Target/X86/X86FrameLowering.cpp

   1 //===-- X86FrameLowering.cpp - X86 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 X86 implementation of TargetFrameLowering class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "X86FrameLowering.h"
  15 #include "X86InstrBuilder.h"
  16 #include "X86InstrInfo.h"
  17 #include "X86MachineFunctionInfo.h"
  18 #include "X86Subtarget.h"
  19 #include "X86TargetMachine.h"
  20 #include "llvm/ADT/SmallSet.h"
  21 #include "llvm/Analysis/LibCallSemantics.h"
  22 #include "llvm/CodeGen/MachineFrameInfo.h"
  23 #include "llvm/CodeGen/MachineFunction.h"
  24 #include "llvm/CodeGen/MachineInstrBuilder.h"
  25 #include "llvm/CodeGen/MachineModuleInfo.h"
  26 #include "llvm/CodeGen/MachineRegisterInfo.h"
  27 #include "llvm/CodeGen/WinEHFuncInfo.h"
  28 #include "llvm/IR/DataLayout.h"
  29 #include "llvm/IR/Function.h"
  30 #include "llvm/MC/MCAsmInfo.h"
  31 #include "llvm/MC/MCSymbol.h"
  32 #include "llvm/Target/TargetOptions.h"
  33 #include "llvm/Support/Debug.h"
  34 #include <cstdlib>
  35
  36 using namespace llvm;
  37
  38 X86FrameLowering::X86FrameLowering(const X86Subtarget &STI,
  39                                    unsigned StackAlignOverride)
  40     : TargetFrameLowering(StackGrowsDown, StackAlignOverride,
  41                           STI.is64Bit() ? -8 : -4),
  42       STI(STI), TII(*STI.getInstrInfo()), TRI(STI.getRegisterInfo()) {
  43   // Cache a bunch of frame-related predicates for this subtarget.
  44   SlotSize = TRI->getSlotSize();
  45   Is64Bit = STI.is64Bit();
  46   IsLP64 = STI.isTarget64BitLP64();
  47   // standard x86_64 and NaCl use 64-bit frame/stack pointers, x32 - 32-bit.
  48   Uses64BitFramePtr = STI.isTarget64BitLP64() || STI.isTargetNaCl64();
  49   StackPtr = TRI->getStackRegister();
  50 }
  51
  52 bool X86FrameLowering::hasReservedCallFrame(const MachineFunction &MF) const {
  53   return !MF.getFrameInfo()->hasVarSizedObjects() &&
  54          !MF.getInfo<X86MachineFunctionInfo>()->getHasPushSequences();
  55 }
  56
  57 /// canSimplifyCallFramePseudos - If there is a reserved call frame, the
  58 /// call frame pseudos can be simplified.  Having a FP, as in the default
  59 /// implementation, is not sufficient here since we can't always use it.
  60 /// Use a more nuanced condition.
  61 bool
  62 X86FrameLowering::canSimplifyCallFramePseudos(const MachineFunction &MF) const {
  63   return hasReservedCallFrame(MF) ||
  64          (hasFP(MF) && !TRI->needsStackRealignment(MF)) ||
  65          TRI->hasBasePointer(MF);
  66 }
  67
  68 // needsFrameIndexResolution - Do we need to perform FI resolution for
  69 // this function. Normally, this is required only when the function
  70 // has any stack objects. However, FI resolution actually has another job,
  71 // not apparent from the title - it resolves callframesetup/destroy
  72 // that were not simplified earlier.
  73 // So, this is required for x86 functions that have push sequences even
  74 // when there are no stack objects.
  75 bool
  76 X86FrameLowering::needsFrameIndexResolution(const MachineFunction &MF) const {
  77   return MF.getFrameInfo()->hasStackObjects() ||
  78          MF.getInfo<X86MachineFunctionInfo>()->getHasPushSequences();
  79 }
  80
  81 /// hasFP - Return true if the specified function should have a dedicated frame
  82 /// pointer register.  This is true if the function has variable sized allocas
  83 /// or if frame pointer elimination is disabled.
  84 bool X86FrameLowering::hasFP(const MachineFunction &MF) const {
  85   const MachineFrameInfo *MFI = MF.getFrameInfo();
  86   const MachineModuleInfo &MMI = MF.getMMI();
  87
  88   return (MF.getTarget().Options.DisableFramePointerElim(MF) ||
  89           TRI->needsStackRealignment(MF) ||
  90           MFI->hasVarSizedObjects() ||
  91           MFI->isFrameAddressTaken() || MFI->hasOpaqueSPAdjustment() ||
  92           MF.getInfo<X86MachineFunctionInfo>()->getForceFramePointer() ||
  93           MMI.callsUnwindInit() || MMI.hasEHFunclets() || MMI.callsEHReturn() ||
  94           MFI->hasStackMap() || MFI->hasPatchPoint());
  95 }
  96
  97 static unsigned getSUBriOpcode(unsigned IsLP64, int64_t Imm) {
  98   if (IsLP64) {
  99     if (isInt<8>(Imm))
 100       return X86::SUB64ri8;
 101     return X86::SUB64ri32;
 102   } else {
 103     if (isInt<8>(Imm))
 104       return X86::SUB32ri8;
 105     return X86::SUB32ri;
 106   }
 107 }
 108
 109 static unsigned getADDriOpcode(unsigned IsLP64, int64_t Imm) {
 110   if (IsLP64) {
 111     if (isInt<8>(Imm))
 112       return X86::ADD64ri8;
 113     return X86::ADD64ri32;
 114   } else {
 115     if (isInt<8>(Imm))
 116       return X86::ADD32ri8;
 117     return X86::ADD32ri;
 118   }
 119 }
 120
 121 static unsigned getSUBrrOpcode(unsigned isLP64) {
 122   return isLP64 ? X86::SUB64rr : X86::SUB32rr;
 123 }
 124
 125 static unsigned getADDrrOpcode(unsigned isLP64) {
 126   return isLP64 ? X86::ADD64rr : X86::ADD32rr;
 127 }
 128
 129 static unsigned getANDriOpcode(bool IsLP64, int64_t Imm) {
 130   if (IsLP64) {
 131     if (isInt<8>(Imm))
 132       return X86::AND64ri8;
 133     return X86::AND64ri32;
 134   }
 135   if (isInt<8>(Imm))
 136     return X86::AND32ri8;
 137   return X86::AND32ri;
 138 }
 139
 140 static unsigned getLEArOpcode(unsigned IsLP64) {
 141   return IsLP64 ? X86::LEA64r : X86::LEA32r;
 142 }
 143
 144 /// findDeadCallerSavedReg - Return a caller-saved register that isn't live
 145 /// when it reaches the "return" instruction. We can then pop a stack object
 146 /// to this register without worry about clobbering it.
 147 static unsigned findDeadCallerSavedReg(MachineBasicBlock &MBB,
 148                                        MachineBasicBlock::iterator &MBBI,
 149                                        const TargetRegisterInfo *TRI,
 150                                        bool Is64Bit) {
 151   const MachineFunction *MF = MBB.getParent();
 152   const Function *F = MF->getFunction();
 153   if (!F || MF->getMMI().callsEHReturn())
 154     return 0;
 155
 156   static const uint16_t CallerSavedRegs32Bit[] = {
 157     X86::EAX, X86::EDX, X86::ECX, 0
 158   };
 159
 160   static const uint16_t CallerSavedRegs64Bit[] = {
 161     X86::RAX, X86::RDX, X86::RCX, X86::RSI, X86::RDI,
 162     X86::R8,  X86::R9,  X86::R10, X86::R11, 0
 163   };
 164
 165   unsigned Opc = MBBI->getOpcode();
 166   switch (Opc) {
 167   default: return 0;
 168   case X86::RETL:
 169   case X86::RETQ:
 170   case X86::RETIL:
 171   case X86::RETIQ:
 172   case X86::TCRETURNdi:
 173   case X86::TCRETURNri:
 174   case X86::TCRETURNmi:
 175   case X86::TCRETURNdi64:
 176   case X86::TCRETURNri64:
 177   case X86::TCRETURNmi64:
 178   case X86::EH_RETURN:
 179   case X86::EH_RETURN64: {
 180     SmallSet<uint16_t, 8> Uses;
 181     for (unsigned i = 0, e = MBBI->getNumOperands(); i != e; ++i) {
 182       MachineOperand &MO = MBBI->getOperand(i);
 183       if (!MO.isReg() || MO.isDef())
 184         continue;
 185       unsigned Reg = MO.getReg();
 186       if (!Reg)
 187         continue;
 188       for (MCRegAliasIterator AI(Reg, TRI, true); AI.isValid(); ++AI)
 189         Uses.insert(*AI);
 190     }
 191
 192     const uint16_t *CS = Is64Bit ? CallerSavedRegs64Bit : CallerSavedRegs32Bit;
 193     for (; *CS; ++CS)
 194       if (!Uses.count(*CS))
 195         return *CS;
 196   }
 197   }
 198
 199   return 0;
 200 }
 201
 202 static bool isEAXLiveIn(MachineFunction &MF) {
 203   for (MachineRegisterInfo::livein_iterator II = MF.getRegInfo().livein_begin(),
 204        EE = MF.getRegInfo().livein_end(); II != EE; ++II) {
 205     unsigned Reg = II->first;
 206
 207     if (Reg == X86::RAX || Reg == X86::EAX || Reg == X86::AX ||
 208         Reg == X86::AH || Reg == X86::AL)
 209       return true;
 210   }
 211
 212   return false;
 213 }
 214
 215 /// Check whether or not the terminators of \p MBB needs to read EFLAGS.
 216 static bool terminatorsNeedFlagsAsInput(const MachineBasicBlock &MBB) {
 217   for (const MachineInstr &MI : MBB.terminators()) {
 218     bool BreakNext = false;
 219     for (const MachineOperand &MO : MI.operands()) {
 220       if (!MO.isReg())
 221         continue;
 222       unsigned Reg = MO.getReg();
 223       if (Reg != X86::EFLAGS)
 224         continue;
 225
 226       // This terminator needs an eflag that is not defined
 227       // by a previous terminator.
 228       if (!MO.isDef())
 229         return true;
 230       BreakNext = true;
 231     }
 232     if (BreakNext)
 233       break;
 234   }
 235   return false;
 236 }
 237
 238 /// emitSPUpdate - Emit a series of instructions to increment / decrement the
 239 /// stack pointer by a constant value.
 240 void X86FrameLowering::emitSPUpdate(MachineBasicBlock &MBB,
 241                                     MachineBasicBlock::iterator &MBBI,
 242                                     int64_t NumBytes, bool InEpilogue) const {
 243   bool isSub = NumBytes < 0;
 244   uint64_t Offset = isSub ? -NumBytes : NumBytes;
 245
 246   uint64_t Chunk = (1LL << 31) - 1;
 247   DebugLoc DL = MBB.findDebugLoc(MBBI);
 248
 249   while (Offset) {
 250     if (Offset > Chunk) {
 251       // Rather than emit a long series of instructions for large offsets,
 252       // load the offset into a register and do one sub/add
 253       unsigned Reg = 0;
 254
 255       if (isSub && !isEAXLiveIn(*MBB.getParent()))
 256         Reg = (unsigned)(Is64Bit ? X86::RAX : X86::EAX);
 257       else
 258         Reg = findDeadCallerSavedReg(MBB, MBBI, TRI, Is64Bit);
 259
 260       if (Reg) {
 261         unsigned Opc = Is64Bit ? X86::MOV64ri : X86::MOV32ri;
 262         BuildMI(MBB, MBBI, DL, TII.get(Opc), Reg)
 263           .addImm(Offset);
 264         Opc = isSub
 265           ? getSUBrrOpcode(Is64Bit)
 266           : getADDrrOpcode(Is64Bit);
 267         MachineInstr *MI = BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr)
 268           .addReg(StackPtr)
 269           .addReg(Reg);
 270         MI->getOperand(3).setIsDead(); // The EFLAGS implicit def is dead.
 271         Offset = 0;
 272         continue;
 273       }
 274     }
 275
 276     uint64_t ThisVal = std::min(Offset, Chunk);
 277     if (ThisVal == (Is64Bit ? 8 : 4)) {
 278       // Use push / pop instead.
 279       unsigned Reg = isSub
 280         ? (unsigned)(Is64Bit ? X86::RAX : X86::EAX)
 281         : findDeadCallerSavedReg(MBB, MBBI, TRI, Is64Bit);
 282       if (Reg) {
 283         unsigned Opc = isSub
 284           ? (Is64Bit ? X86::PUSH64r : X86::PUSH32r)
 285           : (Is64Bit ? X86::POP64r  : X86::POP32r);
 286         MachineInstr *MI = BuildMI(MBB, MBBI, DL, TII.get(Opc))
 287           .addReg(Reg, getDefRegState(!isSub) | getUndefRegState(isSub));
 288         if (isSub)
 289           MI->setFlag(MachineInstr::FrameSetup);
 290         else
 291           MI->setFlag(MachineInstr::FrameDestroy);
 292         Offset -= ThisVal;
 293         continue;
 294       }
 295     }
 296
 297     MachineInstrBuilder MI = BuildStackAdjustment(
 298         MBB, MBBI, DL, isSub ? -ThisVal : ThisVal, InEpilogue);
 299     if (isSub)
 300       MI.setMIFlag(MachineInstr::FrameSetup);
 301     else
 302       MI.setMIFlag(MachineInstr::FrameDestroy);
 303
 304     Offset -= ThisVal;
 305   }
 306 }
 307
 308 MachineInstrBuilder X86FrameLowering::BuildStackAdjustment(
 309     MachineBasicBlock &MBB, MachineBasicBlock::iterator MBBI, DebugLoc DL,
 310     int64_t Offset, bool InEpilogue) const {
 311   assert(Offset != 0 && "zero offset stack adjustment requested");
 312
 313   // On Atom, using LEA to adjust SP is preferred, but using it in the epilogue
 314   // is tricky.
 315   bool UseLEA;
 316   if (!InEpilogue) {
 317     UseLEA = STI.useLeaForSP();
 318   } else {
 319     // If we can use LEA for SP but we shouldn't, check that none
 320     // of the terminators uses the eflags. Otherwise we will insert
 321     // a ADD that will redefine the eflags and break the condition.
 322     // Alternatively, we could move the ADD, but this may not be possible
 323     // and is an optimization anyway.
 324     UseLEA = canUseLEAForSPInEpilogue(*MBB.getParent());
 325     if (UseLEA && !STI.useLeaForSP())
 326       UseLEA = terminatorsNeedFlagsAsInput(MBB);
 327     // If that assert breaks, that means we do not do the right thing
 328     // in canUseAsEpilogue.
 329     assert((UseLEA || !terminatorsNeedFlagsAsInput(MBB)) &&
 330            "We shouldn't have allowed this insertion point");
 331   }
 332
 333   MachineInstrBuilder MI;
 334   if (UseLEA) {
 335     MI = addRegOffset(BuildMI(MBB, MBBI, DL,
 336                               TII.get(getLEArOpcode(Uses64BitFramePtr)),
 337                               StackPtr),
 338                       StackPtr, false, Offset);
 339   } else {
 340     bool IsSub = Offset < 0;
 341     uint64_t AbsOffset = IsSub ? -Offset : Offset;
 342     unsigned Opc = IsSub ? getSUBriOpcode(Uses64BitFramePtr, AbsOffset)
 343                          : getADDriOpcode(Uses64BitFramePtr, AbsOffset);
 344     MI = BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr)
 345              .addReg(StackPtr)
 346              .addImm(AbsOffset);
 347     MI->getOperand(3).setIsDead(); // The EFLAGS implicit def is dead.
 348   }
 349   return MI;
 350 }
 351
 352 int X86FrameLowering::mergeSPUpdates(MachineBasicBlock &MBB,
 353                                      MachineBasicBlock::iterator &MBBI,
 354                                      bool doMergeWithPrevious) const {
 355   if ((doMergeWithPrevious && MBBI == MBB.begin()) ||
 356       (!doMergeWithPrevious && MBBI == MBB.end()))
 357     return 0;
 358
 359   MachineBasicBlock::iterator PI = doMergeWithPrevious ? std::prev(MBBI) : MBBI;
 360   MachineBasicBlock::iterator NI = doMergeWithPrevious ? nullptr
 361                                                        : std::next(MBBI);
 362   unsigned Opc = PI->getOpcode();
 363   int Offset = 0;
 364
 365   if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
 366        Opc == X86::ADD32ri || Opc == X86::ADD32ri8 ||
 367        Opc == X86::LEA32r || Opc == X86::LEA64_32r) &&
 368       PI->getOperand(0).getReg() == StackPtr){
 369     Offset += PI->getOperand(2).getImm();
 370     MBB.erase(PI);
 371     if (!doMergeWithPrevious) MBBI = NI;
 372   } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
 373               Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
 374              PI->getOperand(0).getReg() == StackPtr) {
 375     Offset -= PI->getOperand(2).getImm();
 376     MBB.erase(PI);
 377     if (!doMergeWithPrevious) MBBI = NI;
 378   }
 379
 380   return Offset;
 381 }
 382
 383 void X86FrameLowering::BuildCFI(MachineBasicBlock &MBB,
 384                                 MachineBasicBlock::iterator MBBI, DebugLoc DL,
 385                                 MCCFIInstruction CFIInst) const {
 386   MachineFunction &MF = *MBB.getParent();
 387   unsigned CFIIndex = MF.getMMI().addFrameInst(CFIInst);
 388   BuildMI(MBB, MBBI, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
 389       .addCFIIndex(CFIIndex);
 390 }
 391
 392 void
 393 X86FrameLowering::emitCalleeSavedFrameMoves(MachineBasicBlock &MBB,
 394                                             MachineBasicBlock::iterator MBBI,
 395                                             DebugLoc DL) const {
 396   MachineFunction &MF = *MBB.getParent();
 397   MachineFrameInfo *MFI = MF.getFrameInfo();
 398   MachineModuleInfo &MMI = MF.getMMI();
 399   const MCRegisterInfo *MRI = MMI.getContext().getRegisterInfo();
 400
 401   // Add callee saved registers to move list.
 402   const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
 403   if (CSI.empty()) return;
 404
 405   // Calculate offsets.
 406   for (std::vector<CalleeSavedInfo>::const_iterator
 407          I = CSI.begin(), E = CSI.end(); I != E; ++I) {
 408     int64_t Offset = MFI->getObjectOffset(I->getFrameIdx());
 409     unsigned Reg = I->getReg();
 410
 411     unsigned DwarfReg = MRI->getDwarfRegNum(Reg, true);
 412     BuildCFI(MBB, MBBI, DL,
 413              MCCFIInstruction::createOffset(nullptr, DwarfReg, Offset));
 414   }
 415 }
 416
 417 /// usesTheStack - This function checks if any of the users of EFLAGS
 418 /// copies the EFLAGS. We know that the code that lowers COPY of EFLAGS has
 419 /// to use the stack, and if we don't adjust the stack we clobber the first
 420 /// frame index.
 421 /// See X86InstrInfo::copyPhysReg.
 422 static bool usesTheStack(const MachineFunction &MF) {
 423   const MachineRegisterInfo &MRI = MF.getRegInfo();
 424
 425   for (MachineRegisterInfo::reg_instr_iterator
 426        ri = MRI.reg_instr_begin(X86::EFLAGS), re = MRI.reg_instr_end();
 427        ri != re; ++ri)
 428     if (ri->isCopy())
 429       return true;
 430
 431   return false;
 432 }
 433
 434 MachineInstr *X86FrameLowering::emitStackProbe(MachineFunction &MF,
 435                                                MachineBasicBlock &MBB,
 436                                                MachineBasicBlock::iterator MBBI,
 437                                                DebugLoc DL,
 438                                                bool InProlog) const {
 439   const X86Subtarget &STI = MF.getSubtarget<X86Subtarget>();
 440   if (STI.isTargetWindowsCoreCLR()) {
 441     if (InProlog) {
 442       return emitStackProbeInlineStub(MF, MBB, MBBI, DL, true);
 443     } else {
 444       return emitStackProbeInline(MF, MBB, MBBI, DL, false);
 445     }
 446   } else {
 447     return emitStackProbeCall(MF, MBB, MBBI, DL, InProlog);
 448   }
 449 }
 450
 451 void X86FrameLowering::inlineStackProbe(MachineFunction &MF,
 452                                         MachineBasicBlock &PrologMBB) const {
 453   const StringRef ChkStkStubSymbol = "__chkstk_stub";
 454   MachineInstr *ChkStkStub = nullptr;
 455
 456   for (MachineInstr &MI : PrologMBB) {
 457     if (MI.isCall() && MI.getOperand(0).isSymbol() &&
 458         ChkStkStubSymbol == MI.getOperand(0).getSymbolName()) {
 459       ChkStkStub = &MI;
 460       break;
 461     }
 462   }
 463
 464   if (ChkStkStub != nullptr) {
 465     MachineBasicBlock::iterator MBBI = std::next(ChkStkStub->getIterator());
 466     assert(std::prev(MBBI).operator==(ChkStkStub) &&
 467       "MBBI expected after __chkstk_stub.");
 468     DebugLoc DL = PrologMBB.findDebugLoc(MBBI);
 469     emitStackProbeInline(MF, PrologMBB, MBBI, DL, true);
 470     ChkStkStub->eraseFromParent();
 471   }
 472 }
 473
 474 MachineInstr *X86FrameLowering::emitStackProbeInline(
 475   MachineFunction &MF, MachineBasicBlock &MBB,
 476   MachineBasicBlock::iterator MBBI, DebugLoc DL, bool InProlog) const {
 477   const X86Subtarget &STI = MF.getSubtarget<X86Subtarget>();
 478   assert(STI.is64Bit() && "different expansion needed for 32 bit");
 479   assert(STI.isTargetWindowsCoreCLR() && "custom expansion expects CoreCLR");
 480   const TargetInstrInfo &TII = *STI.getInstrInfo();
 481   const BasicBlock *LLVM_BB = MBB.getBasicBlock();
 482
 483   // RAX contains the number of bytes of desired stack adjustment.
 484   // The handling here assumes this value has already been updated so as to
 485   // maintain stack alignment.
 486   //
 487   // We need to exit with RSP modified by this amount and execute suitable
 488   // page touches to notify the OS that we're growing the stack responsibly.
 489   // All stack probing must be done without modifying RSP.
 490   //
 491   // MBB:
 492   //    SizeReg = RAX;
 493   //    ZeroReg = 0
 494   //    CopyReg = RSP
 495   //    Flags, TestReg = CopyReg - SizeReg
 496   //    FinalReg = !Flags.Ovf ? TestReg : ZeroReg
 497   //    LimitReg = gs magic thread env access
 498   //    if FinalReg >= LimitReg goto ContinueMBB
 499   // RoundBB:
 500   //    RoundReg = page address of FinalReg
 501   // LoopMBB:
 502   //    LoopReg = PHI(LimitReg,ProbeReg)
 503   //    ProbeReg = LoopReg - PageSize
 504   //    [ProbeReg] = 0
 505   //    if (ProbeReg > RoundReg) goto LoopMBB
 506   // ContinueMBB:
 507   //    RSP = RSP - RAX
 508   //    [rest of original MBB]
 509
 510   // Set up the new basic blocks
 511   MachineBasicBlock *RoundMBB = MF.CreateMachineBasicBlock(LLVM_BB);
 512   MachineBasicBlock *LoopMBB = MF.CreateMachineBasicBlock(LLVM_BB);
 513   MachineBasicBlock *ContinueMBB = MF.CreateMachineBasicBlock(LLVM_BB);
 514
 515   MachineFunction::iterator MBBIter = std::next(MBB.getIterator());
 516   MF.insert(MBBIter, RoundMBB);
 517   MF.insert(MBBIter, LoopMBB);
 518   MF.insert(MBBIter, ContinueMBB);
 519
 520   // Split MBB and move the tail portion down to ContinueMBB.
 521   MachineBasicBlock::iterator BeforeMBBI = std::prev(MBBI);
 522   ContinueMBB->splice(ContinueMBB->begin(), &MBB, MBBI, MBB.end());
 523   ContinueMBB->transferSuccessorsAndUpdatePHIs(&MBB);
 524
 525   // Some useful constants
 526   const int64_t ThreadEnvironmentStackLimit = 0x10;
 527   const int64_t PageSize = 0x1000;
 528   const int64_t PageMask = ~(PageSize - 1);
 529
 530   // Registers we need. For the normal case we use virtual
 531   // registers. For the prolog expansion we use RAX, RCX and RDX.
 532   MachineRegisterInfo &MRI = MF.getRegInfo();
 533   const TargetRegisterClass *RegClass = &X86::GR64RegClass;
 534   const unsigned SizeReg = InProlog ? (unsigned)X86::RAX
 535                                     : MRI.createVirtualRegister(RegClass),
 536                  ZeroReg = InProlog ? (unsigned)X86::RCX
 537                                     : MRI.createVirtualRegister(RegClass),
 538                  CopyReg = InProlog ? (unsigned)X86::RDX
 539                                     : MRI.createVirtualRegister(RegClass),
 540                  TestReg = InProlog ? (unsigned)X86::RDX
 541                                     : MRI.createVirtualRegister(RegClass),
 542                  FinalReg = InProlog ? (unsigned)X86::RDX
 543                                      : MRI.createVirtualRegister(RegClass),
 544                  RoundedReg = InProlog ? (unsigned)X86::RDX
 545                                        : MRI.createVirtualRegister(RegClass),
 546                  LimitReg = InProlog ? (unsigned)X86::RCX
 547                                      : MRI.createVirtualRegister(RegClass),
 548                  JoinReg = InProlog ? (unsigned)X86::RCX
 549                                     : MRI.createVirtualRegister(RegClass),
 550                  ProbeReg = InProlog ? (unsigned)X86::RCX
 551                                      : MRI.createVirtualRegister(RegClass);
 552
 553   // SP-relative offsets where we can save RCX and RDX.
 554   int64_t RCXShadowSlot = 0;
 555   int64_t RDXShadowSlot = 0;
 556
 557   // If inlining in the prolog, save RCX and RDX.
 558   // Future optimization: don't save or restore if not live in.
 559   if (InProlog) {
 560     // Compute the offsets. We need to account for things already
 561     // pushed onto the stack at this point: return address, frame
 562     // pointer (if used), and callee saves.
 563     X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
 564     const int64_t CalleeSaveSize = X86FI->getCalleeSavedFrameSize();
 565     const bool HasFP = hasFP(MF);
 566     RCXShadowSlot = 8 + CalleeSaveSize + (HasFP ? 8 : 0);
 567     RDXShadowSlot = RCXShadowSlot + 8;
 568     // Emit the saves.
 569     addRegOffset(BuildMI(&MBB, DL, TII.get(X86::MOV64mr)), X86::RSP, false,
 570                  RCXShadowSlot)
 571         .addReg(X86::RCX);
 572     addRegOffset(BuildMI(&MBB, DL, TII.get(X86::MOV64mr)), X86::RSP, false,
 573                  RDXShadowSlot)
 574         .addReg(X86::RDX);
 575   } else {
 576     // Not in the prolog. Copy RAX to a virtual reg.
 577     BuildMI(&MBB, DL, TII.get(X86::MOV64rr), SizeReg).addReg(X86::RAX);
 578   }
 579
 580   // Add code to MBB to check for overflow and set the new target stack pointer
 581   // to zero if so.
 582   BuildMI(&MBB, DL, TII.get(X86::XOR64rr), ZeroReg)
 583       .addReg(ZeroReg, RegState::Undef)
 584       .addReg(ZeroReg, RegState::Undef);
 585   BuildMI(&MBB, DL, TII.get(X86::MOV64rr), CopyReg).addReg(X86::RSP);
 586   BuildMI(&MBB, DL, TII.get(X86::SUB64rr), TestReg)
 587       .addReg(CopyReg)
 588       .addReg(SizeReg);
 589   BuildMI(&MBB, DL, TII.get(X86::CMOVB64rr), FinalReg)
 590       .addReg(TestReg)
 591       .addReg(ZeroReg);
 592
 593   // FinalReg now holds final stack pointer value, or zero if
 594   // allocation would overflow. Compare against the current stack
 595   // limit from the thread environment block. Note this limit is the
 596   // lowest touched page on the stack, not the point at which the OS
 597   // will cause an overflow exception, so this is just an optimization
 598   // to avoid unnecessarily touching pages that are below the current
 599   // SP but already commited to the stack by the OS.
 600   BuildMI(&MBB, DL, TII.get(X86::MOV64rm), LimitReg)
 601       .addReg(0)
 602       .addImm(1)
 603       .addReg(0)
 604       .addImm(ThreadEnvironmentStackLimit)
 605       .addReg(X86::GS);
 606   BuildMI(&MBB, DL, TII.get(X86::CMP64rr)).addReg(FinalReg).addReg(LimitReg);
 607   // Jump if the desired stack pointer is at or above the stack limit.
 608   BuildMI(&MBB, DL, TII.get(X86::JAE_1)).addMBB(ContinueMBB);
 609
 610   // Add code to roundMBB to round the final stack pointer to a page boundary.
 611   BuildMI(RoundMBB, DL, TII.get(X86::AND64ri32), RoundedReg)
 612       .addReg(FinalReg)
 613       .addImm(PageMask);
 614   BuildMI(RoundMBB, DL, TII.get(X86::JMP_1)).addMBB(LoopMBB);
 615
 616   // LimitReg now holds the current stack limit, RoundedReg page-rounded
 617   // final RSP value. Add code to loopMBB to decrement LimitReg page-by-page
 618   // and probe until we reach RoundedReg.
 619   if (!InProlog) {
 620     BuildMI(LoopMBB, DL, TII.get(X86::PHI), JoinReg)
 621         .addReg(LimitReg)
 622         .addMBB(RoundMBB)
 623         .addReg(ProbeReg)
 624         .addMBB(LoopMBB);
 625   }
 626
 627   addRegOffset(BuildMI(LoopMBB, DL, TII.get(X86::LEA64r), ProbeReg), JoinReg,
 628                false, -PageSize);
 629
 630   // Probe by storing a byte onto the stack.
 631   BuildMI(LoopMBB, DL, TII.get(X86::MOV8mi))
 632       .addReg(ProbeReg)
 633       .addImm(1)
 634       .addReg(0)
 635       .addImm(0)
 636       .addReg(0)
 637       .addImm(0);
 638   BuildMI(LoopMBB, DL, TII.get(X86::CMP64rr))
 639       .addReg(RoundedReg)
 640       .addReg(ProbeReg);
 641   BuildMI(LoopMBB, DL, TII.get(X86::JNE_1)).addMBB(LoopMBB);
 642
 643   MachineBasicBlock::iterator ContinueMBBI = ContinueMBB->getFirstNonPHI();
 644
 645   // If in prolog, restore RDX and RCX.
 646   if (InProlog) {
 647     addRegOffset(BuildMI(*ContinueMBB, ContinueMBBI, DL, TII.get(X86::MOV64rm),
 648                          X86::RCX),
 649                  X86::RSP, false, RCXShadowSlot);
 650     addRegOffset(BuildMI(*ContinueMBB, ContinueMBBI, DL, TII.get(X86::MOV64rm),
 651                          X86::RDX),
 652                  X86::RSP, false, RDXShadowSlot);
 653   }
 654
 655   // Now that the probing is done, add code to continueMBB to update
 656   // the stack pointer for real.
 657   BuildMI(*ContinueMBB, ContinueMBBI, DL, TII.get(X86::SUB64rr), X86::RSP)
 658       .addReg(X86::RSP)
 659       .addReg(SizeReg);
 660
 661   // Add the control flow edges we need.
 662   MBB.addSuccessor(ContinueMBB);
 663   MBB.addSuccessor(RoundMBB);
 664   RoundMBB->addSuccessor(LoopMBB);
 665   LoopMBB->addSuccessor(ContinueMBB);
 666   LoopMBB->addSuccessor(LoopMBB);
 667
 668   // Mark all the instructions added to the prolog as frame setup.
 669   if (InProlog) {
 670     for (++BeforeMBBI; BeforeMBBI != MBB.end(); ++BeforeMBBI) {
 671       BeforeMBBI->setFlag(MachineInstr::FrameSetup);
 672     }
 673     for (MachineInstr &MI : *RoundMBB) {
 674       MI.setFlag(MachineInstr::FrameSetup);
 675     }
 676     for (MachineInstr &MI : *LoopMBB) {
 677       MI.setFlag(MachineInstr::FrameSetup);
 678     }
 679     for (MachineBasicBlock::iterator CMBBI = ContinueMBB->begin();
 680          CMBBI != ContinueMBBI; ++CMBBI) {
 681       CMBBI->setFlag(MachineInstr::FrameSetup);
 682     }
 683   }
 684
 685   // Possible TODO: physreg liveness for InProlog case.
 686
 687   return ContinueMBBI;
 688 }
 689
 690 MachineInstr *X86FrameLowering::emitStackProbeCall(
 691     MachineFunction &MF, MachineBasicBlock &MBB,
 692     MachineBasicBlock::iterator MBBI, DebugLoc DL, bool InProlog) const {
 693   bool IsLargeCodeModel = MF.getTarget().getCodeModel() == CodeModel::Large;
 694
 695   unsigned CallOp;
 696   if (Is64Bit)
 697     CallOp = IsLargeCodeModel ? X86::CALL64r : X86::CALL64pcrel32;
 698   else
 699     CallOp = X86::CALLpcrel32;
 700
 701   const char *Symbol;
 702   if (Is64Bit) {
 703     if (STI.isTargetCygMing()) {
 704       Symbol = "___chkstk_ms";
 705     } else {
 706       Symbol = "__chkstk";
 707     }
 708   } else if (STI.isTargetCygMing())
 709     Symbol = "_alloca";
 710   else
 711     Symbol = "_chkstk";
 712
 713   MachineInstrBuilder CI;
 714   MachineBasicBlock::iterator ExpansionMBBI = std::prev(MBBI);
 715
 716   // All current stack probes take AX and SP as input, clobber flags, and
 717   // preserve all registers. x86_64 probes leave RSP unmodified.
 718   if (Is64Bit && MF.getTarget().getCodeModel() == CodeModel::Large) {
 719     // For the large code model, we have to call through a register. Use R11,
 720     // as it is scratch in all supported calling conventions.
 721     BuildMI(MBB, MBBI, DL, TII.get(X86::MOV64ri), X86::R11)
 722         .addExternalSymbol(Symbol);
 723     CI = BuildMI(MBB, MBBI, DL, TII.get(CallOp)).addReg(X86::R11);
 724   } else {
 725     CI = BuildMI(MBB, MBBI, DL, TII.get(CallOp)).addExternalSymbol(Symbol);
 726   }
 727
 728   unsigned AX = Is64Bit ? X86::RAX : X86::EAX;
 729   unsigned SP = Is64Bit ? X86::RSP : X86::ESP;
 730   CI.addReg(AX, RegState::Implicit)
 731       .addReg(SP, RegState::Implicit)
 732       .addReg(AX, RegState::Define | RegState::Implicit)
 733       .addReg(SP, RegState::Define | RegState::Implicit)
 734       .addReg(X86::EFLAGS, RegState::Define | RegState::Implicit);
 735
 736   if (Is64Bit) {
 737     // MSVC x64's __chkstk and cygwin/mingw's ___chkstk_ms do not adjust %rsp
 738     // themselves. It also does not clobber %rax so we can reuse it when
 739     // adjusting %rsp.
 740     BuildMI(MBB, MBBI, DL, TII.get(X86::SUB64rr), X86::RSP)
 741         .addReg(X86::RSP)
 742         .addReg(X86::RAX);
 743   }
 744
 745   if (InProlog) {
 746     // Apply the frame setup flag to all inserted instrs.
 747     for (++ExpansionMBBI; ExpansionMBBI != MBBI; ++ExpansionMBBI)
 748       ExpansionMBBI->setFlag(MachineInstr::FrameSetup);
 749   }
 750
 751   return MBBI;
 752 }
 753
 754 MachineInstr *X86FrameLowering::emitStackProbeInlineStub(
 755     MachineFunction &MF, MachineBasicBlock &MBB,
 756     MachineBasicBlock::iterator MBBI, DebugLoc DL, bool InProlog) const {
 757
 758   assert(InProlog && "ChkStkStub called outside prolog!");
 759
 760   BuildMI(MBB, MBBI, DL, TII.get(X86::CALLpcrel32))
 761       .addExternalSymbol("__chkstk_stub");
 762
 763   return MBBI;
 764 }
 765
 766 static unsigned calculateSetFPREG(uint64_t SPAdjust) {
 767   // Win64 ABI has a less restrictive limitation of 240; 128 works equally well
 768   // and might require smaller successive adjustments.
 769   const uint64_t Win64MaxSEHOffset = 128;
 770   uint64_t SEHFrameOffset = std::min(SPAdjust, Win64MaxSEHOffset);
 771   // Win64 ABI requires 16-byte alignment for the UWOP_SET_FPREG opcode.
 772   return SEHFrameOffset & -16;
 773 }
 774
 775 // If we're forcing a stack realignment we can't rely on just the frame
 776 // info, we need to know the ABI stack alignment as well in case we
 777 // have a call out.  Otherwise just make sure we have some alignment - we'll
 778 // go with the minimum SlotSize.
 779 uint64_t X86FrameLowering::calculateMaxStackAlign(const MachineFunction &MF) const {
 780   const MachineFrameInfo *MFI = MF.getFrameInfo();
 781   uint64_t MaxAlign = MFI->getMaxAlignment(); // Desired stack alignment.
 782   unsigned StackAlign = getStackAlignment();
 783   if (MF.getFunction()->hasFnAttribute("stackrealign")) {
 784     if (MFI->hasCalls())
 785       MaxAlign = (StackAlign > MaxAlign) ? StackAlign : MaxAlign;
 786     else if (MaxAlign < SlotSize)
 787       MaxAlign = SlotSize;
 788   }
 789   return MaxAlign;
 790 }
 791
 792 void X86FrameLowering::BuildStackAlignAND(MachineBasicBlock &MBB,
 793                                           MachineBasicBlock::iterator MBBI,
 794                                           DebugLoc DL, unsigned Reg,
 795                                           uint64_t MaxAlign) const {
 796   uint64_t Val = -MaxAlign;
 797   unsigned AndOp = getANDriOpcode(Uses64BitFramePtr, Val);
 798   MachineInstr *MI = BuildMI(MBB, MBBI, DL, TII.get(AndOp), Reg)
 799                          .addReg(Reg)
 800                          .addImm(Val)
 801                          .setMIFlag(MachineInstr::FrameSetup);
 802
 803   // The EFLAGS implicit def is dead.
 804   MI->getOperand(3).setIsDead();
 805 }
 806
 807 /// emitPrologue - Push callee-saved registers onto the stack, which
 808 /// automatically adjust the stack pointer. Adjust the stack pointer to allocate
 809 /// space for local variables. Also emit labels used by the exception handler to
 810 /// generate the exception handling frames.
 811
 812 /*
 813   Here's a gist of what gets emitted:
 814
 815   ; Establish frame pointer, if needed
 816   [if needs FP]
 817       push  %rbp
 818       .cfi_def_cfa_offset 16
 819       .cfi_offset %rbp, -16
 820       .seh_pushreg %rpb
 821       mov  %rsp, %rbp
 822       .cfi_def_cfa_register %rbp
 823
 824   ; Spill general-purpose registers
 825   [for all callee-saved GPRs]
 826       pushq %<reg>
 827       [if not needs FP]
 828          .cfi_def_cfa_offset (offset from RETADDR)
 829       .seh_pushreg %<reg>
 830
 831   ; If the required stack alignment > default stack alignment
 832   ; rsp needs to be re-aligned.  This creates a "re-alignment gap"
 833   ; of unknown size in the stack frame.
 834   [if stack needs re-alignment]
 835       and  $MASK, %rsp
 836
 837   ; Allocate space for locals
 838   [if target is Windows and allocated space > 4096 bytes]
 839       ; Windows needs special care for allocations larger
 840       ; than one page.
 841       mov $NNN, %rax
 842       call ___chkstk_ms/___chkstk
 843       sub  %rax, %rsp
 844   [else]
 845       sub  $NNN, %rsp
 846
 847   [if needs FP]
 848       .seh_stackalloc (size of XMM spill slots)
 849       .seh_setframe %rbp, SEHFrameOffset ; = size of all spill slots
 850   [else]
 851       .seh_stackalloc NNN
 852
 853   ; Spill XMMs
 854   ; Note, that while only Windows 64 ABI specifies XMMs as callee-preserved,
 855   ; they may get spilled on any platform, if the current function
 856   ; calls @llvm.eh.unwind.init
 857   [if needs FP]
 858       [for all callee-saved XMM registers]
 859           movaps  %<xmm reg>, -MMM(%rbp)
 860       [for all callee-saved XMM registers]
 861           .seh_savexmm %<xmm reg>, (-MMM + SEHFrameOffset)
 862               ; i.e. the offset relative to (%rbp - SEHFrameOffset)
 863   [else]
 864       [for all callee-saved XMM registers]
 865           movaps  %<xmm reg>, KKK(%rsp)
 866       [for all callee-saved XMM registers]
 867           .seh_savexmm %<xmm reg>, KKK
 868
 869   .seh_endprologue
 870
 871   [if needs base pointer]
 872       mov  %rsp, %rbx
 873       [if needs to restore base pointer]
 874           mov %rsp, -MMM(%rbp)
 875
 876   ; Emit CFI info
 877   [if needs FP]
 878       [for all callee-saved registers]
 879           .cfi_offset %<reg>, (offset from %rbp)
 880   [else]
 881        .cfi_def_cfa_offset (offset from RETADDR)
 882       [for all callee-saved registers]
 883           .cfi_offset %<reg>, (offset from %rsp)
 884
 885   Notes:
 886   - .seh directives are emitted only for Windows 64 ABI
 887   - .cfi directives are emitted for all other ABIs
 888   - for 32-bit code, substitute %e?? registers for %r??
 889 */
 890
 891 void X86FrameLowering::emitPrologue(MachineFunction &MF,
 892                                     MachineBasicBlock &MBB) const {
 893   assert(&STI == &MF.getSubtarget<X86Subtarget>() &&
 894          "MF used frame lowering for wrong subtarget");
 895   MachineBasicBlock::iterator MBBI = MBB.begin();
 896   MachineFrameInfo *MFI = MF.getFrameInfo();
 897   const Function *Fn = MF.getFunction();
 898   MachineModuleInfo &MMI = MF.getMMI();
 899   X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
 900   uint64_t MaxAlign = calculateMaxStackAlign(MF); // Desired stack alignment.
 901   uint64_t StackSize = MFI->getStackSize();    // Number of bytes to allocate.
 902   bool IsFunclet = MBB.isEHFuncletEntry();
 903   bool IsClrFunclet =
 904       IsFunclet &&
 905       classifyEHPersonality(Fn->getPersonalityFn()) == EHPersonality::CoreCLR;
 906   bool HasFP = hasFP(MF);
 907   bool IsWin64CC = STI.isCallingConvWin64(Fn->getCallingConv());
 908   bool IsWin64Prologue = MF.getTarget().getMCAsmInfo()->usesWindowsCFI();
 909   bool NeedsWinCFI = IsWin64Prologue && Fn->needsUnwindTableEntry();
 910   bool NeedsDwarfCFI =
 911       !IsWin64Prologue && (MMI.hasDebugInfo() || Fn->needsUnwindTableEntry());
 912   unsigned FramePtr = TRI->getFrameRegister(MF);
 913   const unsigned MachineFramePtr =
 914       STI.isTarget64BitILP32()
 915           ? getX86SubSuperRegister(FramePtr, MVT::i64, false)
 916           : FramePtr;
 917   unsigned BasePtr = TRI->getBaseRegister();
 918
 919   // Debug location must be unknown since the first debug location is used
 920   // to determine the end of the prologue.
 921   DebugLoc DL;
 922
 923   // Add RETADDR move area to callee saved frame size.
 924   int TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
 925   if (TailCallReturnAddrDelta && IsWin64Prologue)
 926     report_fatal_error("Can't handle guaranteed tail call under win64 yet");
 927
 928   if (TailCallReturnAddrDelta < 0)
 929     X86FI->setCalleeSavedFrameSize(
 930       X86FI->getCalleeSavedFrameSize() - TailCallReturnAddrDelta);
 931
 932   bool UseStackProbe = (STI.isOSWindows() && !STI.isTargetMachO());
 933
 934   // The default stack probe size is 4096 if the function has no stackprobesize
 935   // attribute.
 936   unsigned StackProbeSize = 4096;
 937   if (Fn->hasFnAttribute("stack-probe-size"))
 938     Fn->getFnAttribute("stack-probe-size")
 939         .getValueAsString()
 940         .getAsInteger(0, StackProbeSize);
 941
 942   // If this is x86-64 and the Red Zone is not disabled, if we are a leaf
 943   // function, and use up to 128 bytes of stack space, don't have a frame
 944   // pointer, calls, or dynamic alloca then we do not need to adjust the
 945   // stack pointer (we fit in the Red Zone). We also check that we don't
 946   // push and pop from the stack.
 947   if (Is64Bit && !Fn->hasFnAttribute(Attribute::NoRedZone) &&
 948       !TRI->needsStackRealignment(MF) &&
 949       !MFI->hasVarSizedObjects() && // No dynamic alloca.
 950       !MFI->adjustsStack() &&       // No calls.
 951       !IsWin64CC &&                 // Win64 has no Red Zone
 952       !usesTheStack(MF) &&          // Don't push and pop.
 953       !MF.shouldSplitStack()) {     // Regular stack
 954     uint64_t MinSize = X86FI->getCalleeSavedFrameSize();
 955     if (HasFP) MinSize += SlotSize;
 956     StackSize = std::max(MinSize, StackSize > 128 ? StackSize - 128 : 0);
 957     MFI->setStackSize(StackSize);
 958   }
 959
 960   // Insert stack pointer adjustment for later moving of return addr.  Only
 961   // applies to tail call optimized functions where the callee argument stack
 962   // size is bigger than the callers.
 963   if (TailCallReturnAddrDelta < 0) {
 964     BuildStackAdjustment(MBB, MBBI, DL, TailCallReturnAddrDelta,
 965                          /*InEpilogue=*/false)
 966         .setMIFlag(MachineInstr::FrameSetup);
 967   }
 968
 969   // Mapping for machine moves:
 970   //
 971   //   DST: VirtualFP AND
 972   //        SRC: VirtualFP              => DW_CFA_def_cfa_offset
 973   //        ELSE                        => DW_CFA_def_cfa
 974   //
 975   //   SRC: VirtualFP AND
 976   //        DST: Register               => DW_CFA_def_cfa_register
 977   //
 978   //   ELSE
 979   //        OFFSET < 0                  => DW_CFA_offset_extended_sf
 980   //        REG < 64                    => DW_CFA_offset + Reg
 981   //        ELSE                        => DW_CFA_offset_extended
 982
 983   uint64_t NumBytes = 0;
 984   int stackGrowth = -SlotSize;
 985
 986   // Find the funclet establisher parameter
 987   unsigned Establisher = X86::NoRegister;
 988   if (IsClrFunclet)
 989     Establisher = Uses64BitFramePtr ? X86::RCX : X86::ECX;
 990   else if (IsFunclet)
 991     Establisher = Uses64BitFramePtr ? X86::RDX : X86::EDX;
 992
 993   if (IsWin64Prologue && IsFunclet & !IsClrFunclet) {
 994     // Immediately spill establisher into the home slot.
 995     // The runtime cares about this.
 996     // MOV64mr %rdx, 16(%rsp)
 997     unsigned MOVmr = Uses64BitFramePtr ? X86::MOV64mr : X86::MOV32mr;
 998     addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(MOVmr)), StackPtr, true, 16)
 999         .addReg(Establisher)
1000         .setMIFlag(MachineInstr::FrameSetup);
1001     MBB.addLiveIn(Establisher);
1002   }
1003
1004   if (HasFP) {
1005     // Calculate required stack adjustment.
1006     uint64_t FrameSize = StackSize - SlotSize;
1007     // If required, include space for extra hidden slot for stashing base pointer.
1008     if (X86FI->getRestoreBasePointer())
1009       FrameSize += SlotSize;
1010
1011     NumBytes = FrameSize - X86FI->getCalleeSavedFrameSize();
1012
1013     // Callee-saved registers are pushed on stack before the stack is realigned.
1014     if (TRI->needsStackRealignment(MF) && !IsWin64Prologue)
1015       NumBytes = RoundUpToAlignment(NumBytes, MaxAlign);
1016
1017     // Get the offset of the stack slot for the EBP register, which is
1018     // guaranteed to be the last slot by processFunctionBeforeFrameFinalized.
1019     // Update the frame offset adjustment.
1020     if (!IsFunclet)
1021       MFI->setOffsetAdjustment(-NumBytes);
1022     else
1023       assert(MFI->getOffsetAdjustment() == -(int)NumBytes &&
1024              "should calculate same local variable offset for funclets");
1025
1026     // Save EBP/RBP into the appropriate stack slot.
1027     BuildMI(MBB, MBBI, DL, TII.get(Is64Bit ? X86::PUSH64r : X86::PUSH32r))
1028       .addReg(MachineFramePtr, RegState::Kill)
1029       .setMIFlag(MachineInstr::FrameSetup);
1030
1031     if (NeedsDwarfCFI) {
1032       // Mark the place where EBP/RBP was saved.
1033       // Define the current CFA rule to use the provided offset.
1034       assert(StackSize);
1035       BuildCFI(MBB, MBBI, DL,
1036                MCCFIInstruction::createDefCfaOffset(nullptr, 2 * stackGrowth));
1037
1038       // Change the rule for the FramePtr to be an "offset" rule.
1039       unsigned DwarfFramePtr = TRI->getDwarfRegNum(MachineFramePtr, true);
1040       BuildCFI(MBB, MBBI, DL, MCCFIInstruction::createOffset(
1041                                   nullptr, DwarfFramePtr, 2 * stackGrowth));
1042     }
1043
1044     if (NeedsWinCFI) {
1045       BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_PushReg))
1046           .addImm(FramePtr)
1047           .setMIFlag(MachineInstr::FrameSetup);
1048     }
1049
1050     if (!IsWin64Prologue && !IsFunclet) {
1051       // Update EBP with the new base value.
1052       BuildMI(MBB, MBBI, DL,
1053               TII.get(Uses64BitFramePtr ? X86::MOV64rr : X86::MOV32rr),
1054               FramePtr)
1055           .addReg(StackPtr)
1056           .setMIFlag(MachineInstr::FrameSetup);
1057
1058       if (NeedsDwarfCFI) {
1059         // Mark effective beginning of when frame pointer becomes valid.
1060         // Define the current CFA to use the EBP/RBP register.
1061         unsigned DwarfFramePtr = TRI->getDwarfRegNum(MachineFramePtr, true);
1062         BuildCFI(MBB, MBBI, DL, MCCFIInstruction::createDefCfaRegister(
1063                                     nullptr, DwarfFramePtr));
1064       }
1065     }
1066
1067     // Mark the FramePtr as live-in in every block. Don't do this again for
1068     // funclet prologues.
1069     if (!IsFunclet) {
1070       for (MachineBasicBlock &EveryMBB : MF)
1071         EveryMBB.addLiveIn(MachineFramePtr);
1072     }
1073   } else {
1074     assert(!IsFunclet && "funclets without FPs not yet implemented");
1075     NumBytes = StackSize - X86FI->getCalleeSavedFrameSize();
1076   }
1077
1078   // For EH funclets, only allocate enough space for outgoing calls. Save the
1079   // NumBytes value that we would've used for the parent frame.
1080   unsigned ParentFrameNumBytes = NumBytes;
1081   if (IsFunclet)
1082     NumBytes = getWinEHFuncletFrameSize(MF);
1083
1084   // Skip the callee-saved push instructions.
1085   bool PushedRegs = false;
1086   int StackOffset = 2 * stackGrowth;
1087
1088   while (MBBI != MBB.end() &&
1089          MBBI->getFlag(MachineInstr::FrameSetup) &&
1090          (MBBI->getOpcode() == X86::PUSH32r ||
1091           MBBI->getOpcode() == X86::PUSH64r)) {
1092     PushedRegs = true;
1093     unsigned Reg = MBBI->getOperand(0).getReg();
1094     ++MBBI;
1095
1096     if (!HasFP && NeedsDwarfCFI) {
1097       // Mark callee-saved push instruction.
1098       // Define the current CFA rule to use the provided offset.
1099       assert(StackSize);
1100       BuildCFI(MBB, MBBI, DL,
1101                MCCFIInstruction::createDefCfaOffset(nullptr, StackOffset));
1102       StackOffset += stackGrowth;
1103     }
1104
1105     if (NeedsWinCFI) {
1106       BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_PushReg)).addImm(Reg).setMIFlag(
1107           MachineInstr::FrameSetup);
1108     }
1109   }
1110
1111   // Realign stack after we pushed callee-saved registers (so that we'll be
1112   // able to calculate their offsets from the frame pointer).
1113   // Don't do this for Win64, it needs to realign the stack after the prologue.
1114   if (!IsWin64Prologue && !IsFunclet && TRI->needsStackRealignment(MF)) {
1115     assert(HasFP && "There should be a frame pointer if stack is realigned.");
1116     BuildStackAlignAND(MBB, MBBI, DL, StackPtr, MaxAlign);
1117   }
1118
1119   // If there is an SUB32ri of ESP immediately before this instruction, merge
1120   // the two. This can be the case when tail call elimination is enabled and
1121   // the callee has more arguments then the caller.
1122   NumBytes -= mergeSPUpdates(MBB, MBBI, true);
1123
1124   // Adjust stack pointer: ESP -= numbytes.
1125
1126   // Windows and cygwin/mingw require a prologue helper routine when allocating
1127   // more than 4K bytes on the stack.  Windows uses __chkstk and cygwin/mingw
1128   // uses __alloca.  __alloca and the 32-bit version of __chkstk will probe the
1129   // stack and adjust the stack pointer in one go.  The 64-bit version of
1130   // __chkstk is only responsible for probing the stack.  The 64-bit prologue is
1131   // responsible for adjusting the stack pointer.  Touching the stack at 4K
1132   // increments is necessary to ensure that the guard pages used by the OS
1133   // virtual memory manager are allocated in correct sequence.
1134   uint64_t AlignedNumBytes = NumBytes;
1135   if (IsWin64Prologue && !IsFunclet && TRI->needsStackRealignment(MF))
1136     AlignedNumBytes = RoundUpToAlignment(AlignedNumBytes, MaxAlign);
1137   if (AlignedNumBytes >= StackProbeSize && UseStackProbe) {
1138     // Check whether EAX is livein for this function.
1139     bool isEAXAlive = isEAXLiveIn(MF);
1140
1141     if (isEAXAlive) {
1142       // Sanity check that EAX is not livein for this function.
1143       // It should not be, so throw an assert.
1144       assert(!Is64Bit && "EAX is livein in x64 case!");
1145
1146       // Save EAX
1147       BuildMI(MBB, MBBI, DL, TII.get(X86::PUSH32r))
1148         .addReg(X86::EAX, RegState::Kill)
1149         .setMIFlag(MachineInstr::FrameSetup);
1150     }
1151
1152     if (Is64Bit) {
1153       // Handle the 64-bit Windows ABI case where we need to call __chkstk.
1154       // Function prologue is responsible for adjusting the stack pointer.
1155       if (isUInt<32>(NumBytes)) {
1156         BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32ri), X86::EAX)
1157             .addImm(NumBytes)
1158             .setMIFlag(MachineInstr::FrameSetup);
1159       } else if (isInt<32>(NumBytes)) {
1160         BuildMI(MBB, MBBI, DL, TII.get(X86::MOV64ri32), X86::RAX)
1161             .addImm(NumBytes)
1162             .setMIFlag(MachineInstr::FrameSetup);
1163       } else {
1164         BuildMI(MBB, MBBI, DL, TII.get(X86::MOV64ri), X86::RAX)
1165             .addImm(NumBytes)
1166             .setMIFlag(MachineInstr::FrameSetup);
1167       }
1168     } else {
1169       // Allocate NumBytes-4 bytes on stack in case of isEAXAlive.
1170       // We'll also use 4 already allocated bytes for EAX.
1171       BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32ri), X86::EAX)
1172           .addImm(isEAXAlive ? NumBytes - 4 : NumBytes)
1173           .setMIFlag(MachineInstr::FrameSetup);
1174     }
1175
1176     // Call __chkstk, __chkstk_ms, or __alloca.
1177     emitStackProbe(MF, MBB, MBBI, DL, true);
1178
1179     if (isEAXAlive) {
1180       // Restore EAX
1181       MachineInstr *MI =
1182           addRegOffset(BuildMI(MF, DL, TII.get(X86::MOV32rm), X86::EAX),
1183                        StackPtr, false, NumBytes - 4);
1184       MI->setFlag(MachineInstr::FrameSetup);
1185       MBB.insert(MBBI, MI);
1186     }
1187   } else if (NumBytes) {
1188     emitSPUpdate(MBB, MBBI, -(int64_t)NumBytes, /*InEpilogue=*/false);
1189   }
1190
1191   if (NeedsWinCFI && NumBytes)
1192     BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_StackAlloc))
1193         .addImm(NumBytes)
1194         .setMIFlag(MachineInstr::FrameSetup);
1195
1196   int SEHFrameOffset = 0;
1197   unsigned SPOrEstablisher = IsFunclet ? Establisher : StackPtr;
1198   if (IsWin64Prologue && HasFP) {
1199     // Set RBP to a small fixed offset from RSP. In the funclet case, we base
1200     // this calculation on the incoming establisher, which holds the value of
1201     // RSP from the parent frame at the end of the prologue.
1202     SEHFrameOffset = calculateSetFPREG(ParentFrameNumBytes);
1203     if (SEHFrameOffset)
1204       addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(X86::LEA64r), FramePtr),
1205                    SPOrEstablisher, false, SEHFrameOffset);
1206     else
1207       BuildMI(MBB, MBBI, DL, TII.get(X86::MOV64rr), FramePtr)
1208           .addReg(SPOrEstablisher);
1209
1210     // If this is not a funclet, emit the CFI describing our frame pointer.
1211     if (NeedsWinCFI && !IsFunclet)
1212       BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_SetFrame))
1213           .addImm(FramePtr)
1214           .addImm(SEHFrameOffset)
1215           .setMIFlag(MachineInstr::FrameSetup);
1216   } else if (IsFunclet && STI.is32Bit()) {
1217     // Reset EBP / ESI to something good for funclets.
1218     MBBI = restoreWin32EHStackPointers(MBB, MBBI, DL);
1219   }
1220
1221   while (MBBI != MBB.end() && MBBI->getFlag(MachineInstr::FrameSetup)) {
1222     const MachineInstr *FrameInstr = &*MBBI;
1223     ++MBBI;
1224
1225     if (NeedsWinCFI) {
1226       int FI;
1227       if (unsigned Reg = TII.isStoreToStackSlot(FrameInstr, FI)) {
1228         if (X86::FR64RegClass.contains(Reg)) {
1229           unsigned IgnoredFrameReg;
1230           int Offset = getFrameIndexReference(MF, FI, IgnoredFrameReg);
1231           Offset += SEHFrameOffset;
1232
1233           BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_SaveXMM))
1234               .addImm(Reg)
1235               .addImm(Offset)
1236               .setMIFlag(MachineInstr::FrameSetup);
1237         }
1238       }
1239     }
1240   }
1241
1242   if (NeedsWinCFI)
1243     BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_EndPrologue))
1244         .setMIFlag(MachineInstr::FrameSetup);
1245
1246   // Realign stack after we spilled callee-saved registers (so that we'll be
1247   // able to calculate their offsets from the frame pointer).
1248   // Win64 requires aligning the stack after the prologue.
1249   if (IsWin64Prologue && TRI->needsStackRealignment(MF)) {
1250     assert(HasFP && "There should be a frame pointer if stack is realigned.");
1251     BuildStackAlignAND(MBB, MBBI, DL, SPOrEstablisher, MaxAlign);
1252   }
1253
1254   // We already dealt with stack realignment and funclets above.
1255   if (IsFunclet && STI.is32Bit())
1256     return;
1257
1258   // If we need a base pointer, set it up here. It's whatever the value
1259   // of the stack pointer is at this point. Any variable size objects
1260   // will be allocated after this, so we can still use the base pointer
1261   // to reference locals.
1262   if (TRI->hasBasePointer(MF)) {
1263     // Update the base pointer with the current stack pointer.
1264     unsigned Opc = Uses64BitFramePtr ? X86::MOV64rr : X86::MOV32rr;
1265     BuildMI(MBB, MBBI, DL, TII.get(Opc), BasePtr)
1266       .addReg(SPOrEstablisher)
1267       .setMIFlag(MachineInstr::FrameSetup);
1268     if (X86FI->getRestoreBasePointer()) {
1269       // Stash value of base pointer.  Saving RSP instead of EBP shortens
1270       // dependence chain. Used by SjLj EH.
1271       unsigned Opm = Uses64BitFramePtr ? X86::MOV64mr : X86::MOV32mr;
1272       addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(Opm)),
1273                    FramePtr, true, X86FI->getRestoreBasePointerOffset())
1274         .addReg(SPOrEstablisher)
1275         .setMIFlag(MachineInstr::FrameSetup);
1276     }
1277
1278     if (X86FI->getHasSEHFramePtrSave() && !IsFunclet) {
1279       // Stash the value of the frame pointer relative to the base pointer for
1280       // Win32 EH. This supports Win32 EH, which does the inverse of the above:
1281       // it recovers the frame pointer from the base pointer rather than the
1282       // other way around.
1283       unsigned Opm = Uses64BitFramePtr ? X86::MOV64mr : X86::MOV32mr;
1284       unsigned UsedReg;
1285       int Offset =
1286           getFrameIndexReference(MF, X86FI->getSEHFramePtrSaveIndex(), UsedReg);
1287       assert(UsedReg == BasePtr);
1288       addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(Opm)), UsedReg, true, Offset)
1289           .addReg(FramePtr)
1290           .setMIFlag(MachineInstr::FrameSetup);
1291     }
1292   }
1293
1294   if (((!HasFP && NumBytes) || PushedRegs) && NeedsDwarfCFI) {
1295     // Mark end of stack pointer adjustment.
1296     if (!HasFP && NumBytes) {
1297       // Define the current CFA rule to use the provided offset.
1298       assert(StackSize);
1299       BuildCFI(MBB, MBBI, DL, MCCFIInstruction::createDefCfaOffset(
1300                                   nullptr, -StackSize + stackGrowth));
1301     }
1302
1303     // Emit DWARF info specifying the offsets of the callee-saved registers.
1304     if (PushedRegs)
1305       emitCalleeSavedFrameMoves(MBB, MBBI, DL);
1306   }
1307 }
1308
1309 bool X86FrameLowering::canUseLEAForSPInEpilogue(
1310     const MachineFunction &MF) const {
1311   // We can't use LEA instructions for adjusting the stack pointer if this is a
1312   // leaf function in the Win64 ABI.  Only ADD instructions may be used to
1313   // deallocate the stack.
1314   // This means that we can use LEA for SP in two situations:
1315   // 1. We *aren't* using the Win64 ABI which means we are free to use LEA.
1316   // 2. We *have* a frame pointer which means we are permitted to use LEA.
1317   return !MF.getTarget().getMCAsmInfo()->usesWindowsCFI() || hasFP(MF);
1318 }
1319
1320 static bool isFuncletReturnInstr(MachineInstr *MI) {
1321   switch (MI->getOpcode()) {
1322   case X86::CATCHRET:
1323   case X86::CLEANUPRET:
1324     return true;
1325   default:
1326     return false;
1327   }
1328   llvm_unreachable("impossible");
1329 }
1330
1331 unsigned X86FrameLowering::getWinEHFuncletFrameSize(const MachineFunction &MF) const {
1332   // This is the size of the pushed CSRs.
1333   unsigned CSSize =
1334       MF.getInfo<X86MachineFunctionInfo>()->getCalleeSavedFrameSize();
1335   // This is the amount of stack a funclet needs to allocate.
1336   unsigned MaxCallSize = MF.getFrameInfo()->getMaxCallFrameSize();
1337   // RBP is not included in the callee saved register block. After pushing RBP,
1338   // everything is 16 byte aligned. Everything we allocate before an outgoing
1339   // call must also be 16 byte aligned.
1340   unsigned FrameSizeMinusRBP =
1341       RoundUpToAlignment(CSSize + MaxCallSize, getStackAlignment());
1342   // Subtract out the size of the callee saved registers. This is how much stack
1343   // each funclet will allocate.
1344   return FrameSizeMinusRBP - CSSize;
1345 }
1346
1347 void X86FrameLowering::emitEpilogue(MachineFunction &MF,
1348                                     MachineBasicBlock &MBB) const {
1349   const MachineFrameInfo *MFI = MF.getFrameInfo();
1350   X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1351   MachineBasicBlock::iterator MBBI = MBB.getFirstTerminator();
1352   DebugLoc DL;
1353   if (MBBI != MBB.end())
1354     DL = MBBI->getDebugLoc();
1355   // standard x86_64 and NaCl use 64-bit frame/stack pointers, x32 - 32-bit.
1356   const bool Is64BitILP32 = STI.isTarget64BitILP32();
1357   unsigned FramePtr = TRI->getFrameRegister(MF);
1358   unsigned MachineFramePtr =
1359       Is64BitILP32 ? getX86SubSuperRegister(FramePtr, MVT::i64, false)
1360                    : FramePtr;
1361
1362   bool IsWin64Prologue = MF.getTarget().getMCAsmInfo()->usesWindowsCFI();
1363   bool NeedsWinCFI =
1364       IsWin64Prologue && MF.getFunction()->needsUnwindTableEntry();
1365   bool IsFunclet = isFuncletReturnInstr(MBBI);
1366   MachineBasicBlock *TargetMBB = nullptr;
1367
1368   // Get the number of bytes to allocate from the FrameInfo.
1369   uint64_t StackSize = MFI->getStackSize();
1370   uint64_t MaxAlign = calculateMaxStackAlign(MF);
1371   unsigned CSSize = X86FI->getCalleeSavedFrameSize();
1372   uint64_t NumBytes = 0;
1373
1374   if (MBBI->getOpcode() == X86::CATCHRET) {
1375     // SEH shouldn't use catchret.
1376     assert(!isAsynchronousEHPersonality(
1377                classifyEHPersonality(MF.getFunction()->getPersonalityFn())) &&
1378            "SEH should not use CATCHRET");
1379
1380     NumBytes = getWinEHFuncletFrameSize(MF);
1381     assert(hasFP(MF) && "EH funclets without FP not yet implemented");
1382     TargetMBB = MBBI->getOperand(0).getMBB();
1383
1384     // Pop EBP.
1385     BuildMI(MBB, MBBI, DL, TII.get(Is64Bit ? X86::POP64r : X86::POP32r),
1386             MachineFramePtr)
1387         .setMIFlag(MachineInstr::FrameDestroy);
1388   } else if (MBBI->getOpcode() == X86::CLEANUPRET) {
1389     NumBytes = getWinEHFuncletFrameSize(MF);
1390     assert(hasFP(MF) && "EH funclets without FP not yet implemented");
1391     BuildMI(MBB, MBBI, DL, TII.get(Is64Bit ? X86::POP64r : X86::POP32r),
1392             MachineFramePtr)
1393         .setMIFlag(MachineInstr::FrameDestroy);
1394   } else if (hasFP(MF)) {
1395     // Calculate required stack adjustment.
1396     uint64_t FrameSize = StackSize - SlotSize;
1397     NumBytes = FrameSize - CSSize;
1398
1399     // Callee-saved registers were pushed on stack before the stack was
1400     // realigned.
1401     if (TRI->needsStackRealignment(MF) && !IsWin64Prologue)
1402       NumBytes = RoundUpToAlignment(FrameSize, MaxAlign);
1403
1404     // Pop EBP.
1405     BuildMI(MBB, MBBI, DL,
1406             TII.get(Is64Bit ? X86::POP64r : X86::POP32r), MachineFramePtr)
1407         .setMIFlag(MachineInstr::FrameDestroy);
1408   } else {
1409     NumBytes = StackSize - CSSize;
1410   }
1411   uint64_t SEHStackAllocAmt = NumBytes;
1412
1413   // Skip the callee-saved pop instructions.
1414   while (MBBI != MBB.begin()) {
1415     MachineBasicBlock::iterator PI = std::prev(MBBI);
1416     unsigned Opc = PI->getOpcode();
1417
1418     if ((Opc != X86::POP32r || !PI->getFlag(MachineInstr::FrameDestroy)) &&
1419         (Opc != X86::POP64r || !PI->getFlag(MachineInstr::FrameDestroy)) &&
1420         Opc != X86::DBG_VALUE && !PI->isTerminator())
1421       break;
1422
1423     --MBBI;
1424   }
1425   MachineBasicBlock::iterator FirstCSPop = MBBI;
1426
1427   if (TargetMBB) {
1428     // Fill EAX/RAX with the address of the target block.
1429     unsigned ReturnReg = STI.is64Bit() ? X86::RAX : X86::EAX;
1430     if (STI.is64Bit()) {
1431       // LEA64r TargetMBB(%rip), %rax
1432       BuildMI(MBB, FirstCSPop, DL, TII.get(X86::LEA64r), ReturnReg)
1433           .addReg(X86::RIP)
1434           .addImm(0)
1435           .addReg(0)
1436           .addMBB(TargetMBB)
1437           .addReg(0);
1438     } else {
1439       // MOV32ri $TargetMBB, %eax
1440       BuildMI(MBB, FirstCSPop, DL, TII.get(X86::MOV32ri), ReturnReg)
1441           .addMBB(TargetMBB);
1442     }
1443     // Record that we've taken the address of TargetMBB and no longer just
1444     // reference it in a terminator.
1445     TargetMBB->setHasAddressTaken();
1446   }
1447
1448   if (MBBI != MBB.end())
1449     DL = MBBI->getDebugLoc();
1450
1451   // If there is an ADD32ri or SUB32ri of ESP immediately before this
1452   // instruction, merge the two instructions.
1453   if (NumBytes || MFI->hasVarSizedObjects())
1454     NumBytes += mergeSPUpdates(MBB, MBBI, true);
1455
1456   // If dynamic alloca is used, then reset esp to point to the last callee-saved
1457   // slot before popping them off! Same applies for the case, when stack was
1458   // realigned. Don't do this if this was a funclet epilogue, since the funclets
1459   // will not do realignment or dynamic stack allocation.
1460   if ((TRI->needsStackRealignment(MF) || MFI->hasVarSizedObjects()) &&
1461       !IsFunclet) {
1462     if (TRI->needsStackRealignment(MF))
1463       MBBI = FirstCSPop;
1464     unsigned SEHFrameOffset = calculateSetFPREG(SEHStackAllocAmt);
1465     uint64_t LEAAmount =
1466         IsWin64Prologue ? SEHStackAllocAmt - SEHFrameOffset : -CSSize;
1467
1468     // There are only two legal forms of epilogue:
1469     // - add SEHAllocationSize, %rsp
1470     // - lea SEHAllocationSize(%FramePtr), %rsp
1471     //
1472     // 'mov %FramePtr, %rsp' will not be recognized as an epilogue sequence.
1473     // However, we may use this sequence if we have a frame pointer because the
1474     // effects of the prologue can safely be undone.
1475     if (LEAAmount != 0) {
1476       unsigned Opc = getLEArOpcode(Uses64BitFramePtr);
1477       addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr),
1478                    FramePtr, false, LEAAmount);
1479       --MBBI;
1480     } else {
1481       unsigned Opc = (Uses64BitFramePtr ? X86::MOV64rr : X86::MOV32rr);
1482       BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr)
1483         .addReg(FramePtr);
1484       --MBBI;
1485     }
1486   } else if (NumBytes) {
1487     // Adjust stack pointer back: ESP += numbytes.
1488     emitSPUpdate(MBB, MBBI, NumBytes, /*InEpilogue=*/true);
1489     --MBBI;
1490   }
1491
1492   // Windows unwinder will not invoke function's exception handler if IP is
1493   // either in prologue or in epilogue.  This behavior causes a problem when a
1494   // call immediately precedes an epilogue, because the return address points
1495   // into the epilogue.  To cope with that, we insert an epilogue marker here,
1496   // then replace it with a 'nop' if it ends up immediately after a CALL in the
1497   // final emitted code.
1498   if (NeedsWinCFI)
1499     BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_Epilogue));
1500
1501   // Add the return addr area delta back since we are not tail calling.
1502   int Offset = -1 * X86FI->getTCReturnAddrDelta();
1503   assert(Offset >= 0 && "TCDelta should never be positive");
1504   if (Offset) {
1505     MBBI = MBB.getFirstTerminator();
1506
1507     // Check for possible merge with preceding ADD instruction.
1508     Offset += mergeSPUpdates(MBB, MBBI, true);
1509     emitSPUpdate(MBB, MBBI, Offset, /*InEpilogue=*/true);
1510   }
1511 }
1512
1513 // NOTE: this only has a subset of the full frame index logic. In
1514 // particular, the FI < 0 and AfterFPPop logic is handled in
1515 // X86RegisterInfo::eliminateFrameIndex, but not here. Possibly
1516 // (probably?) it should be moved into here.
1517 int X86FrameLowering::getFrameIndexReference(const MachineFunction &MF, int FI,
1518                                              unsigned &FrameReg) const {
1519   const MachineFrameInfo *MFI = MF.getFrameInfo();
1520
1521   // We can't calculate offset from frame pointer if the stack is realigned,
1522   // so enforce usage of stack/base pointer.  The base pointer is used when we
1523   // have dynamic allocas in addition to dynamic realignment.
1524   if (TRI->hasBasePointer(MF))
1525     FrameReg = TRI->getBaseRegister();
1526   else if (TRI->needsStackRealignment(MF))
1527     FrameReg = TRI->getStackRegister();
1528   else
1529     FrameReg = TRI->getFrameRegister(MF);
1530
1531   // Offset will hold the offset from the stack pointer at function entry to the
1532   // object.
1533   // We need to factor in additional offsets applied during the prologue to the
1534   // frame, base, and stack pointer depending on which is used.
1535   int Offset = MFI->getObjectOffset(FI) - getOffsetOfLocalArea();
1536   const X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1537   unsigned CSSize = X86FI->getCalleeSavedFrameSize();
1538   uint64_t StackSize = MFI->getStackSize();
1539   bool HasFP = hasFP(MF);
1540   bool IsWin64Prologue = MF.getTarget().getMCAsmInfo()->usesWindowsCFI();
1541   int64_t FPDelta = 0;
1542
1543   if (IsWin64Prologue) {
1544     assert(!MFI->hasCalls() || (StackSize % 16) == 8);
1545
1546     // Calculate required stack adjustment.
1547     uint64_t FrameSize = StackSize - SlotSize;
1548     // If required, include space for extra hidden slot for stashing base pointer.
1549     if (X86FI->getRestoreBasePointer())
1550       FrameSize += SlotSize;
1551     uint64_t NumBytes = FrameSize - CSSize;
1552
1553     uint64_t SEHFrameOffset = calculateSetFPREG(NumBytes);
1554     if (FI && FI == X86FI->getFAIndex())
1555       return -SEHFrameOffset;
1556
1557     // FPDelta is the offset from the "traditional" FP location of the old base
1558     // pointer followed by return address and the location required by the
1559     // restricted Win64 prologue.
1560     // Add FPDelta to all offsets below that go through the frame pointer.
1561     FPDelta = FrameSize - SEHFrameOffset;
1562     assert((!MFI->hasCalls() || (FPDelta % 16) == 0) &&
1563            "FPDelta isn't aligned per the Win64 ABI!");
1564   }
1565
1566
1567   if (TRI->hasBasePointer(MF)) {
1568     assert(HasFP && "VLAs and dynamic stack realign, but no FP?!");
1569     if (FI < 0) {
1570       // Skip the saved EBP.
1571       return Offset + SlotSize + FPDelta;
1572     } else {
1573       assert((-(Offset + StackSize)) % MFI->getObjectAlignment(FI) == 0);
1574       return Offset + StackSize;
1575     }
1576   } else if (TRI->needsStackRealignment(MF)) {
1577     if (FI < 0) {
1578       // Skip the saved EBP.
1579       return Offset + SlotSize + FPDelta;
1580     } else {
1581       assert((-(Offset + StackSize)) % MFI->getObjectAlignment(FI) == 0);
1582       return Offset + StackSize;
1583     }
1584     // FIXME: Support tail calls
1585   } else {
1586     if (!HasFP)
1587       return Offset + StackSize;
1588
1589     // Skip the saved EBP.
1590     Offset += SlotSize;
1591
1592     // Skip the RETADDR move area
1593     int TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
1594     if (TailCallReturnAddrDelta < 0)
1595       Offset -= TailCallReturnAddrDelta;
1596   }
1597
1598   return Offset + FPDelta;
1599 }
1600
1601 // Simplified from getFrameIndexReference keeping only StackPointer cases
1602 int X86FrameLowering::getFrameIndexReferenceFromSP(const MachineFunction &MF,
1603                                                    int FI,
1604                                                    unsigned &FrameReg) const {
1605   const MachineFrameInfo *MFI = MF.getFrameInfo();
1606   // Does not include any dynamic realign.
1607   const uint64_t StackSize = MFI->getStackSize();
1608   {
1609 #ifndef NDEBUG
1610     // LLVM arranges the stack as follows:
1611     //   ...
1612     //   ARG2
1613     //   ARG1
1614     //   RETADDR
1615     //   PUSH RBP   <-- RBP points here
1616     //   PUSH CSRs
1617     //   ~~~~~~~    <-- optional stack realignment dynamic adjustment
1618     //   ...
1619     //   STACK OBJECTS
1620     //   ...        <-- RSP after prologue points here
1621     //
1622     // if (hasVarSizedObjects()):
1623     //   ...        <-- "base pointer" (ESI/RBX) points here
1624     //   DYNAMIC ALLOCAS
1625     //   ...        <-- RSP points here
1626     //
1627     // Case 1: In the simple case of no stack realignment and no dynamic
1628     // allocas, both "fixed" stack objects (arguments and CSRs) are addressable
1629     // with fixed offsets from RSP.
1630     //
1631     // Case 2: In the case of stack realignment with no dynamic allocas, fixed
1632     // stack objects are addressed with RBP and regular stack objects with RSP.
1633     //
1634     // Case 3: In the case of dynamic allocas and stack realignment, RSP is used
1635     // to address stack arguments for outgoing calls and nothing else. The "base
1636     // pointer" points to local variables, and RBP points to fixed objects.
1637     //
1638     // In cases 2 and 3, we can only answer for non-fixed stack objects, and the
1639     // answer we give is relative to the SP after the prologue, and not the
1640     // SP in the middle of the function.
1641
1642     assert((!TRI->needsStackRealignment(MF) || !MFI->isFixedObjectIndex(FI)) &&
1643            "offset from fixed object to SP is not static");
1644
1645     // We don't handle tail calls, and shouldn't be seeing them either.
1646     int TailCallReturnAddrDelta =
1647         MF.getInfo<X86MachineFunctionInfo>()->getTCReturnAddrDelta();
1648     assert(!(TailCallReturnAddrDelta < 0) && "we don't handle this case!");
1649 #endif
1650   }
1651
1652   // Fill in FrameReg output argument.
1653   FrameReg = TRI->getStackRegister();
1654
1655   // This is how the math works out:
1656   //
1657   //  %rsp grows (i.e. gets lower) left to right. Each box below is
1658   //  one word (eight bytes).  Obj0 is the stack slot we're trying to
1659   //  get to.
1660   //
1661   //    ----------------------------------
1662   //    | BP | Obj0 | Obj1 | ... | ObjN |
1663   //    ----------------------------------
1664   //    ^    ^      ^                   ^
1665   //    A    B      C                   E
1666   //
1667   // A is the incoming stack pointer.
1668   // (B - A) is the local area offset (-8 for x86-64) [1]
1669   // (C - A) is the Offset returned by MFI->getObjectOffset for Obj0 [2]
1670   //
1671   // |(E - B)| is the StackSize (absolute value, positive).  For a
1672   // stack that grown down, this works out to be (B - E). [3]
1673   //
1674   // E is also the value of %rsp after stack has been set up, and we
1675   // want (C - E) -- the value we can add to %rsp to get to Obj0.  Now
1676   // (C - E) == (C - A) - (B - A) + (B - E)
1677   //            { Using [1], [2] and [3] above }
1678   //         == getObjectOffset - LocalAreaOffset + StackSize
1679   //
1680
1681   // Get the Offset from the StackPointer
1682   int Offset = MFI->getObjectOffset(FI) - getOffsetOfLocalArea();
1683
1684   return Offset + StackSize;
1685 }
1686
1687 bool X86FrameLowering::assignCalleeSavedSpillSlots(
1688     MachineFunction &MF, const TargetRegisterInfo *TRI,
1689     std::vector<CalleeSavedInfo> &CSI) const {
1690   MachineFrameInfo *MFI = MF.getFrameInfo();
1691   X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1692
1693   unsigned CalleeSavedFrameSize = 0;
1694   int SpillSlotOffset = getOffsetOfLocalArea() + X86FI->getTCReturnAddrDelta();
1695
1696   if (hasFP(MF)) {
1697     // emitPrologue always spills frame register the first thing.
1698     SpillSlotOffset -= SlotSize;
1699     MFI->CreateFixedSpillStackObject(SlotSize, SpillSlotOffset);
1700
1701     // Since emitPrologue and emitEpilogue will handle spilling and restoring of
1702     // the frame register, we can delete it from CSI list and not have to worry
1703     // about avoiding it later.
1704     unsigned FPReg = TRI->getFrameRegister(MF);
1705     for (unsigned i = 0; i < CSI.size(); ++i) {
1706       if (TRI->regsOverlap(CSI[i].getReg(),FPReg)) {
1707         CSI.erase(CSI.begin() + i);
1708         break;
1709       }
1710     }
1711   }
1712
1713   // Assign slots for GPRs. It increases frame size.
1714   for (unsigned i = CSI.size(); i != 0; --i) {
1715     unsigned Reg = CSI[i - 1].getReg();
1716
1717     if (!X86::GR64RegClass.contains(Reg) && !X86::GR32RegClass.contains(Reg))
1718       continue;
1719
1720     SpillSlotOffset -= SlotSize;
1721     CalleeSavedFrameSize += SlotSize;
1722
1723     int SlotIndex = MFI->CreateFixedSpillStackObject(SlotSize, SpillSlotOffset);
1724     CSI[i - 1].setFrameIdx(SlotIndex);
1725   }
1726
1727   X86FI->setCalleeSavedFrameSize(CalleeSavedFrameSize);
1728
1729   // Assign slots for XMMs.
1730   for (unsigned i = CSI.size(); i != 0; --i) {
1731     unsigned Reg = CSI[i - 1].getReg();
1732     if (X86::GR64RegClass.contains(Reg) || X86::GR32RegClass.contains(Reg))
1733       continue;
1734
1735     const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
1736     // ensure alignment
1737     SpillSlotOffset -= std::abs(SpillSlotOffset) % RC->getAlignment();
1738     // spill into slot
1739     SpillSlotOffset -= RC->getSize();
1740     int SlotIndex =
1741         MFI->CreateFixedSpillStackObject(RC->getSize(), SpillSlotOffset);
1742     CSI[i - 1].setFrameIdx(SlotIndex);
1743     MFI->ensureMaxAlignment(RC->getAlignment());
1744   }
1745
1746   return true;
1747 }
1748
1749 bool X86FrameLowering::spillCalleeSavedRegisters(
1750     MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
1751     const std::vector<CalleeSavedInfo> &CSI,
1752     const TargetRegisterInfo *TRI) const {
1753   DebugLoc DL = MBB.findDebugLoc(MI);
1754
1755   // Don't save CSRs in 32-bit EH funclets. The caller saves EBX, EBP, ESI, EDI
1756   // for us, and there are no XMM CSRs on Win32.
1757   if (MBB.isEHFuncletEntry() && STI.is32Bit() && STI.isOSWindows())
1758     return true;
1759
1760   // Push GPRs. It increases frame size.
1761   unsigned Opc = STI.is64Bit() ? X86::PUSH64r : X86::PUSH32r;
1762   for (unsigned i = CSI.size(); i != 0; --i) {
1763     unsigned Reg = CSI[i - 1].getReg();
1764
1765     if (!X86::GR64RegClass.contains(Reg) && !X86::GR32RegClass.contains(Reg))
1766       continue;
1767     // Add the callee-saved register as live-in. It's killed at the spill.
1768     MBB.addLiveIn(Reg);
1769
1770     BuildMI(MBB, MI, DL, TII.get(Opc)).addReg(Reg, RegState::Kill)
1771       .setMIFlag(MachineInstr::FrameSetup);
1772   }
1773
1774   // Make XMM regs spilled. X86 does not have ability of push/pop XMM.
1775   // It can be done by spilling XMMs to stack frame.
1776   for (unsigned i = CSI.size(); i != 0; --i) {
1777     unsigned Reg = CSI[i-1].getReg();
1778     if (X86::GR64RegClass.contains(Reg) || X86::GR32RegClass.contains(Reg))
1779       continue;
1780     // Add the callee-saved register as live-in. It's killed at the spill.
1781     MBB.addLiveIn(Reg);
1782     const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
1783
1784     TII.storeRegToStackSlot(MBB, MI, Reg, true, CSI[i - 1].getFrameIdx(), RC,
1785                             TRI);
1786     --MI;
1787     MI->setFlag(MachineInstr::FrameSetup);
1788     ++MI;
1789   }
1790
1791   return true;
1792 }
1793
1794 bool X86FrameLowering::restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
1795                                                MachineBasicBlock::iterator MI,
1796                                         const std::vector<CalleeSavedInfo> &CSI,
1797                                           const TargetRegisterInfo *TRI) const {
1798   if (CSI.empty())
1799     return false;
1800
1801   if (isFuncletReturnInstr(MI) && STI.isOSWindows()) {
1802     // Don't restore CSRs in 32-bit EH funclets. Matches
1803     // spillCalleeSavedRegisters.
1804     if (STI.is32Bit())
1805       return true;
1806     // Don't restore CSRs before an SEH catchret. SEH except blocks do not form
1807     // funclets. emitEpilogue transforms these to normal jumps.
1808     if (MI->getOpcode() == X86::CATCHRET) {
1809       const Function *Func = MBB.getParent()->getFunction();
1810       bool IsSEH = isAsynchronousEHPersonality(
1811           classifyEHPersonality(Func->getPersonalityFn()));
1812       if (IsSEH)
1813         return true;
1814     }
1815   }
1816
1817   DebugLoc DL = MBB.findDebugLoc(MI);
1818
1819   // Reload XMMs from stack frame.
1820   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1821     unsigned Reg = CSI[i].getReg();
1822     if (X86::GR64RegClass.contains(Reg) ||
1823         X86::GR32RegClass.contains(Reg))
1824       continue;
1825
1826     const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
1827     TII.loadRegFromStackSlot(MBB, MI, Reg, CSI[i].getFrameIdx(), RC, TRI);
1828   }
1829
1830   // POP GPRs.
1831   unsigned Opc = STI.is64Bit() ? X86::POP64r : X86::POP32r;
1832   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1833     unsigned Reg = CSI[i].getReg();
1834     if (!X86::GR64RegClass.contains(Reg) &&
1835         !X86::GR32RegClass.contains(Reg))
1836       continue;
1837
1838     BuildMI(MBB, MI, DL, TII.get(Opc), Reg)
1839         .setMIFlag(MachineInstr::FrameDestroy);
1840   }
1841   return true;
1842 }
1843
1844 void X86FrameLowering::determineCalleeSaves(MachineFunction &MF,
1845                                             BitVector &SavedRegs,
1846                                             RegScavenger *RS) const {
1847   TargetFrameLowering::determineCalleeSaves(MF, SavedRegs, RS);
1848
1849   MachineFrameInfo *MFI = MF.getFrameInfo();
1850
1851   X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1852   int64_t TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
1853
1854   if (TailCallReturnAddrDelta < 0) {
1855     // create RETURNADDR area
1856     //   arg
1857     //   arg
1858     //   RETADDR
1859     //   { ...
1860     //     RETADDR area
1861     //     ...
1862     //   }
1863     //   [EBP]
1864     MFI->CreateFixedObject(-TailCallReturnAddrDelta,
1865                            TailCallReturnAddrDelta - SlotSize, true);
1866   }
1867
1868   // Spill the BasePtr if it's used.
1869   if (TRI->hasBasePointer(MF)) {
1870     SavedRegs.set(TRI->getBaseRegister());
1871
1872     // Allocate a spill slot for EBP if we have a base pointer and EH funclets.
1873     if (MF.getMMI().hasEHFunclets()) {
1874       int FI = MFI->CreateSpillStackObject(SlotSize, SlotSize);
1875       X86FI->setHasSEHFramePtrSave(true);
1876       X86FI->setSEHFramePtrSaveIndex(FI);
1877     }
1878   }
1879 }
1880
1881 static bool
1882 HasNestArgument(const MachineFunction *MF) {
1883   const Function *F = MF->getFunction();
1884   for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1885        I != E; I++) {
1886     if (I->hasNestAttr())
1887       return true;
1888   }
1889   return false;
1890 }
1891
1892 /// GetScratchRegister - Get a temp register for performing work in the
1893 /// segmented stack and the Erlang/HiPE stack prologue. Depending on platform
1894 /// and the properties of the function either one or two registers will be
1895 /// needed. Set primary to true for the first register, false for the second.
1896 static unsigned
1897 GetScratchRegister(bool Is64Bit, bool IsLP64, const MachineFunction &MF, bool Primary) {
1898   CallingConv::ID CallingConvention = MF.getFunction()->getCallingConv();
1899
1900   // Erlang stuff.
1901   if (CallingConvention == CallingConv::HiPE) {
1902     if (Is64Bit)
1903       return Primary ? X86::R14 : X86::R13;
1904     else
1905       return Primary ? X86::EBX : X86::EDI;
1906   }
1907
1908   if (Is64Bit) {
1909     if (IsLP64)
1910       return Primary ? X86::R11 : X86::R12;
1911     else
1912       return Primary ? X86::R11D : X86::R12D;
1913   }
1914
1915   bool IsNested = HasNestArgument(&MF);
1916
1917   if (CallingConvention == CallingConv::X86_FastCall ||
1918       CallingConvention == CallingConv::Fast) {
1919     if (IsNested)
1920       report_fatal_error("Segmented stacks does not support fastcall with "
1921                          "nested function.");
1922     return Primary ? X86::EAX : X86::ECX;
1923   }
1924   if (IsNested)
1925     return Primary ? X86::EDX : X86::EAX;
1926   return Primary ? X86::ECX : X86::EAX;
1927 }
1928
1929 // The stack limit in the TCB is set to this many bytes above the actual stack
1930 // limit.
1931 static const uint64_t kSplitStackAvailable = 256;
1932
1933 void X86FrameLowering::adjustForSegmentedStacks(
1934     MachineFunction &MF, MachineBasicBlock &PrologueMBB) const {
1935   MachineFrameInfo *MFI = MF.getFrameInfo();
1936   uint64_t StackSize;
1937   unsigned TlsReg, TlsOffset;
1938   DebugLoc DL;
1939
1940   unsigned ScratchReg = GetScratchRegister(Is64Bit, IsLP64, MF, true);
1941   assert(!MF.getRegInfo().isLiveIn(ScratchReg) &&
1942          "Scratch register is live-in");
1943
1944   if (MF.getFunction()->isVarArg())
1945     report_fatal_error("Segmented stacks do not support vararg functions.");
1946   if (!STI.isTargetLinux() && !STI.isTargetDarwin() && !STI.isTargetWin32() &&
1947       !STI.isTargetWin64() && !STI.isTargetFreeBSD() &&
1948       !STI.isTargetDragonFly())
1949     report_fatal_error("Segmented stacks not supported on this platform.");
1950
1951   // Eventually StackSize will be calculated by a link-time pass; which will
1952   // also decide whether checking code needs to be injected into this particular
1953   // prologue.
1954   StackSize = MFI->getStackSize();
1955
1956   // Do not generate a prologue for functions with a stack of size zero
1957   if (StackSize == 0)
1958     return;
1959
1960   MachineBasicBlock *allocMBB = MF.CreateMachineBasicBlock();
1961   MachineBasicBlock *checkMBB = MF.CreateMachineBasicBlock();
1962   X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1963   bool IsNested = false;
1964
1965   // We need to know if the function has a nest argument only in 64 bit mode.
1966   if (Is64Bit)
1967     IsNested = HasNestArgument(&MF);
1968
1969   // The MOV R10, RAX needs to be in a different block, since the RET we emit in
1970   // allocMBB needs to be last (terminating) instruction.
1971
1972   for (const auto &LI : PrologueMBB.liveins()) {
1973     allocMBB->addLiveIn(LI);
1974     checkMBB->addLiveIn(LI);
1975   }
1976
1977   if (IsNested)
1978     allocMBB->addLiveIn(IsLP64 ? X86::R10 : X86::R10D);
1979
1980   MF.push_front(allocMBB);
1981   MF.push_front(checkMBB);
1982
1983   // When the frame size is less than 256 we just compare the stack
1984   // boundary directly to the value of the stack pointer, per gcc.
1985   bool CompareStackPointer = StackSize < kSplitStackAvailable;
1986
1987   // Read the limit off the current stacklet off the stack_guard location.
1988   if (Is64Bit) {
1989     if (STI.isTargetLinux()) {
1990       TlsReg = X86::FS;
1991       TlsOffset = IsLP64 ? 0x70 : 0x40;
1992     } else if (STI.isTargetDarwin()) {
1993       TlsReg = X86::GS;
1994       TlsOffset = 0x60 + 90*8; // See pthread_machdep.h. Steal TLS slot 90.
1995     } else if (STI.isTargetWin64()) {
1996       TlsReg = X86::GS;
1997       TlsOffset = 0x28; // pvArbitrary, reserved for application use
1998     } else if (STI.isTargetFreeBSD()) {
1999       TlsReg = X86::FS;
2000       TlsOffset = 0x18;
2001     } else if (STI.isTargetDragonFly()) {
2002       TlsReg = X86::FS;
2003       TlsOffset = 0x20; // use tls_tcb.tcb_segstack
2004     } else {
2005       report_fatal_error("Segmented stacks not supported on this platform.");
2006     }
2007
2008     if (CompareStackPointer)
2009       ScratchReg = IsLP64 ? X86::RSP : X86::ESP;
2010     else
2011       BuildMI(checkMBB, DL, TII.get(IsLP64 ? X86::LEA64r : X86::LEA64_32r), ScratchReg).addReg(X86::RSP)
2012         .addImm(1).addReg(0).addImm(-StackSize).addReg(0);
2013
2014     BuildMI(checkMBB, DL, TII.get(IsLP64 ? X86::CMP64rm : X86::CMP32rm)).addReg(ScratchReg)
2015       .addReg(0).addImm(1).addReg(0).addImm(TlsOffset).addReg(TlsReg);
2016   } else {
2017     if (STI.isTargetLinux()) {
2018       TlsReg = X86::GS;
2019       TlsOffset = 0x30;
2020     } else if (STI.isTargetDarwin()) {
2021       TlsReg = X86::GS;
2022       TlsOffset = 0x48 + 90*4;
2023     } else if (STI.isTargetWin32()) {
2024       TlsReg = X86::FS;
2025       TlsOffset = 0x14; // pvArbitrary, reserved for application use
2026     } else if (STI.isTargetDragonFly()) {
2027       TlsReg = X86::FS;
2028       TlsOffset = 0x10; // use tls_tcb.tcb_segstack
2029     } else if (STI.isTargetFreeBSD()) {
2030       report_fatal_error("Segmented stacks not supported on FreeBSD i386.");
2031     } else {
2032       report_fatal_error("Segmented stacks not supported on this platform.");
2033     }
2034
2035     if (CompareStackPointer)
2036       ScratchReg = X86::ESP;
2037     else
2038       BuildMI(checkMBB, DL, TII.get(X86::LEA32r), ScratchReg).addReg(X86::ESP)
2039         .addImm(1).addReg(0).addImm(-StackSize).addReg(0);
2040
2041     if (STI.isTargetLinux() || STI.isTargetWin32() || STI.isTargetWin64() ||
2042         STI.isTargetDragonFly()) {
2043       BuildMI(checkMBB, DL, TII.get(X86::CMP32rm)).addReg(ScratchReg)
2044         .addReg(0).addImm(0).addReg(0).addImm(TlsOffset).addReg(TlsReg);
2045     } else if (STI.isTargetDarwin()) {
2046
2047       // TlsOffset doesn't fit into a mod r/m byte so we need an extra register.
2048       unsigned ScratchReg2;
2049       bool SaveScratch2;
2050       if (CompareStackPointer) {
2051         // The primary scratch register is available for holding the TLS offset.
2052         ScratchReg2 = GetScratchRegister(Is64Bit, IsLP64, MF, true);
2053         SaveScratch2 = false;
2054       } else {
2055         // Need to use a second register to hold the TLS offset
2056         ScratchReg2 = GetScratchRegister(Is64Bit, IsLP64, MF, false);
2057
2058         // Unfortunately, with fastcc the second scratch register may hold an
2059         // argument.
2060         SaveScratch2 = MF.getRegInfo().isLiveIn(ScratchReg2);
2061       }
2062
2063       // If Scratch2 is live-in then it needs to be saved.
2064       assert((!MF.getRegInfo().isLiveIn(ScratchReg2) || SaveScratch2) &&
2065              "Scratch register is live-in and not saved");
2066
2067       if (SaveScratch2)
2068         BuildMI(checkMBB, DL, TII.get(X86::PUSH32r))
2069           .addReg(ScratchReg2, RegState::Kill);
2070
2071       BuildMI(checkMBB, DL, TII.get(X86::MOV32ri), ScratchReg2)
2072         .addImm(TlsOffset);
2073       BuildMI(checkMBB, DL, TII.get(X86::CMP32rm))
2074         .addReg(ScratchReg)
2075         .addReg(ScratchReg2).addImm(1).addReg(0)
2076         .addImm(0)
2077         .addReg(TlsReg);
2078
2079       if (SaveScratch2)
2080         BuildMI(checkMBB, DL, TII.get(X86::POP32r), ScratchReg2);
2081     }
2082   }
2083
2084   // This jump is taken if SP >= (Stacklet Limit + Stack Space required).
2085   // It jumps to normal execution of the function body.
2086   BuildMI(checkMBB, DL, TII.get(X86::JA_1)).addMBB(&PrologueMBB);
2087
2088   // On 32 bit we first push the arguments size and then the frame size. On 64
2089   // bit, we pass the stack frame size in r10 and the argument size in r11.
2090   if (Is64Bit) {
2091     // Functions with nested arguments use R10, so it needs to be saved across
2092     // the call to _morestack
2093
2094     const unsigned RegAX = IsLP64 ? X86::RAX : X86::EAX;
2095     const unsigned Reg10 = IsLP64 ? X86::R10 : X86::R10D;
2096     const unsigned Reg11 = IsLP64 ? X86::R11 : X86::R11D;
2097     const unsigned MOVrr = IsLP64 ? X86::MOV64rr : X86::MOV32rr;
2098     const unsigned MOVri = IsLP64 ? X86::MOV64ri : X86::MOV32ri;
2099
2100     if (IsNested)
2101       BuildMI(allocMBB, DL, TII.get(MOVrr), RegAX).addReg(Reg10);
2102
2103     BuildMI(allocMBB, DL, TII.get(MOVri), Reg10)
2104       .addImm(StackSize);
2105     BuildMI(allocMBB, DL, TII.get(MOVri), Reg11)
2106       .addImm(X86FI->getArgumentStackSize());
2107   } else {
2108     BuildMI(allocMBB, DL, TII.get(X86::PUSHi32))
2109       .addImm(X86FI->getArgumentStackSize());
2110     BuildMI(allocMBB, DL, TII.get(X86::PUSHi32))
2111       .addImm(StackSize);
2112   }
2113
2114   // __morestack is in libgcc
2115   if (Is64Bit && MF.getTarget().getCodeModel() == CodeModel::Large) {
2116     // Under the large code model, we cannot assume that __morestack lives
2117     // within 2^31 bytes of the call site, so we cannot use pc-relative
2118     // addressing. We cannot perform the call via a temporary register,
2119     // as the rax register may be used to store the static chain, and all
2120     // other suitable registers may be either callee-save or used for
2121     // parameter passing. We cannot use the stack at this point either
2122     // because __morestack manipulates the stack directly.
2123     //
2124     // To avoid these issues, perform an indirect call via a read-only memory
2125     // location containing the address.
2126     //
2127     // This solution is not perfect, as it assumes that the .rodata section
2128     // is laid out within 2^31 bytes of each function body, but this seems
2129     // to be sufficient for JIT.
2130     BuildMI(allocMBB, DL, TII.get(X86::CALL64m))
2131         .addReg(X86::RIP)
2132         .addImm(0)
2133         .addReg(0)
2134         .addExternalSymbol("__morestack_addr")
2135         .addReg(0);
2136     MF.getMMI().setUsesMorestackAddr(true);
2137   } else {
2138     if (Is64Bit)
2139       BuildMI(allocMBB, DL, TII.get(X86::CALL64pcrel32))
2140         .addExternalSymbol("__morestack");
2141     else
2142       BuildMI(allocMBB, DL, TII.get(X86::CALLpcrel32))
2143         .addExternalSymbol("__morestack");
2144   }
2145
2146   if (IsNested)
2147     BuildMI(allocMBB, DL, TII.get(X86::MORESTACK_RET_RESTORE_R10));
2148   else
2149     BuildMI(allocMBB, DL, TII.get(X86::MORESTACK_RET));
2150
2151   allocMBB->addSuccessor(&PrologueMBB);
2152
2153   checkMBB->addSuccessor(allocMBB);
2154   checkMBB->addSuccessor(&PrologueMBB);
2155
2156 #ifdef XDEBUG
2157   MF.verify();
2158 #endif
2159 }
2160
2161 /// Erlang programs may need a special prologue to handle the stack size they
2162 /// might need at runtime. That is because Erlang/OTP does not implement a C
2163 /// stack but uses a custom implementation of hybrid stack/heap architecture.
2164 /// (for more information see Eric Stenman's Ph.D. thesis:
2165 /// http://publications.uu.se/uu/fulltext/nbn_se_uu_diva-2688.pdf)
2166 ///
2167 /// CheckStack:
2168 ///       temp0 = sp - MaxStack
2169 ///       if( temp0 < SP_LIMIT(P) ) goto IncStack else goto OldStart
2170 /// OldStart:
2171 ///       ...
2172 /// IncStack:
2173 ///       call inc_stack   # doubles the stack space
2174 ///       temp0 = sp - MaxStack
2175 ///       if( temp0 < SP_LIMIT(P) ) goto IncStack else goto OldStart
2176 void X86FrameLowering::adjustForHiPEPrologue(
2177     MachineFunction &MF, MachineBasicBlock &PrologueMBB) const {
2178   MachineFrameInfo *MFI = MF.getFrameInfo();
2179   DebugLoc DL;
2180   // HiPE-specific values
2181   const unsigned HipeLeafWords = 24;
2182   const unsigned CCRegisteredArgs = Is64Bit ? 6 : 5;
2183   const unsigned Guaranteed = HipeLeafWords * SlotSize;
2184   unsigned CallerStkArity = MF.getFunction()->arg_size() > CCRegisteredArgs ?
2185                             MF.getFunction()->arg_size() - CCRegisteredArgs : 0;
2186   unsigned MaxStack = MFI->getStackSize() + CallerStkArity*SlotSize + SlotSize;
2187
2188   assert(STI.isTargetLinux() &&
2189          "HiPE prologue is only supported on Linux operating systems.");
2190
2191   // Compute the largest caller's frame that is needed to fit the callees'
2192   // frames. This 'MaxStack' is computed from:
2193   //
2194   // a) the fixed frame size, which is the space needed for all spilled temps,
2195   // b) outgoing on-stack parameter areas, and
2196   // c) the minimum stack space this function needs to make available for the
2197   //    functions it calls (a tunable ABI property).
2198   if (MFI->hasCalls()) {
2199     unsigned MoreStackForCalls = 0;
2200
2201     for (MachineFunction::iterator MBBI = MF.begin(), MBBE = MF.end();
2202          MBBI != MBBE; ++MBBI)
2203       for (MachineBasicBlock::iterator MI = MBBI->begin(), ME = MBBI->end();
2204            MI != ME; ++MI) {
2205         if (!MI->isCall())
2206           continue;
2207
2208         // Get callee operand.
2209         const MachineOperand &MO = MI->getOperand(0);
2210
2211         // Only take account of global function calls (no closures etc.).
2212         if (!MO.isGlobal())
2213           continue;
2214
2215         const Function *F = dyn_cast<Function>(MO.getGlobal());
2216         if (!F)
2217           continue;
2218
2219         // Do not update 'MaxStack' for primitive and built-in functions
2220         // (encoded with names either starting with "erlang."/"bif_" or not
2221         // having a ".", such as a simple <Module>.<Function>.<Arity>, or an
2222         // "_", such as the BIF "suspend_0") as they are executed on another
2223         // stack.
2224         if (F->getName().find("erlang.") != StringRef::npos ||
2225             F->getName().find("bif_") != StringRef::npos ||
2226             F->getName().find_first_of("._") == StringRef::npos)
2227           continue;
2228
2229         unsigned CalleeStkArity =
2230           F->arg_size() > CCRegisteredArgs ? F->arg_size()-CCRegisteredArgs : 0;
2231         if (HipeLeafWords - 1 > CalleeStkArity)
2232           MoreStackForCalls = std::max(MoreStackForCalls,
2233                                (HipeLeafWords - 1 - CalleeStkArity) * SlotSize);
2234       }
2235     MaxStack += MoreStackForCalls;
2236   }
2237
2238   // If the stack frame needed is larger than the guaranteed then runtime checks
2239   // and calls to "inc_stack_0" BIF should be inserted in the assembly prologue.
2240   if (MaxStack > Guaranteed) {
2241     MachineBasicBlock *stackCheckMBB = MF.CreateMachineBasicBlock();
2242     MachineBasicBlock *incStackMBB = MF.CreateMachineBasicBlock();
2243
2244     for (const auto &LI : PrologueMBB.liveins()) {
2245       stackCheckMBB->addLiveIn(LI);
2246       incStackMBB->addLiveIn(LI);
2247     }
2248
2249     MF.push_front(incStackMBB);
2250     MF.push_front(stackCheckMBB);
2251
2252     unsigned ScratchReg, SPReg, PReg, SPLimitOffset;
2253     unsigned LEAop, CMPop, CALLop;
2254     if (Is64Bit) {
2255       SPReg = X86::RSP;
2256       PReg  = X86::RBP;
2257       LEAop = X86::LEA64r;
2258       CMPop = X86::CMP64rm;
2259       CALLop = X86::CALL64pcrel32;
2260       SPLimitOffset = 0x90;
2261     } else {
2262       SPReg = X86::ESP;
2263       PReg  = X86::EBP;
2264       LEAop = X86::LEA32r;
2265       CMPop = X86::CMP32rm;
2266       CALLop = X86::CALLpcrel32;
2267       SPLimitOffset = 0x4c;
2268     }
2269
2270     ScratchReg = GetScratchRegister(Is64Bit, IsLP64, MF, true);
2271     assert(!MF.getRegInfo().isLiveIn(ScratchReg) &&
2272            "HiPE prologue scratch register is live-in");
2273
2274     // Create new MBB for StackCheck:
2275     addRegOffset(BuildMI(stackCheckMBB, DL, TII.get(LEAop), ScratchReg),
2276                  SPReg, false, -MaxStack);
2277     // SPLimitOffset is in a fixed heap location (pointed by BP).
2278     addRegOffset(BuildMI(stackCheckMBB, DL, TII.get(CMPop))
2279                  .addReg(ScratchReg), PReg, false, SPLimitOffset);
2280     BuildMI(stackCheckMBB, DL, TII.get(X86::JAE_1)).addMBB(&PrologueMBB);
2281
2282     // Create new MBB for IncStack:
2283     BuildMI(incStackMBB, DL, TII.get(CALLop)).
2284       addExternalSymbol("inc_stack_0");
2285     addRegOffset(BuildMI(incStackMBB, DL, TII.get(LEAop), ScratchReg),
2286                  SPReg, false, -MaxStack);
2287     addRegOffset(BuildMI(incStackMBB, DL, TII.get(CMPop))
2288                  .addReg(ScratchReg), PReg, false, SPLimitOffset);
2289     BuildMI(incStackMBB, DL, TII.get(X86::JLE_1)).addMBB(incStackMBB);
2290
2291     stackCheckMBB->addSuccessor(&PrologueMBB, 99);
2292     stackCheckMBB->addSuccessor(incStackMBB, 1);
2293     incStackMBB->addSuccessor(&PrologueMBB, 99);
2294     incStackMBB->addSuccessor(incStackMBB, 1);
2295   }
2296 #ifdef XDEBUG
2297   MF.verify();
2298 #endif
2299 }
2300
2301 bool X86FrameLowering::adjustStackWithPops(MachineBasicBlock &MBB,
2302     MachineBasicBlock::iterator MBBI, DebugLoc DL, int Offset) const {
2303
2304   if (Offset <= 0)
2305     return false;
2306
2307   if (Offset % SlotSize)
2308     return false;
2309
2310   int NumPops = Offset / SlotSize;
2311   // This is only worth it if we have at most 2 pops.
2312   if (NumPops != 1 && NumPops != 2)
2313     return false;
2314
2315   // Handle only the trivial case where the adjustment directly follows
2316   // a call. This is the most common one, anyway.
2317   if (MBBI == MBB.begin())
2318     return false;
2319   MachineBasicBlock::iterator Prev = std::prev(MBBI);
2320   if (!Prev->isCall() || !Prev->getOperand(1).isRegMask())
2321     return false;
2322
2323   unsigned Regs[2];
2324   unsigned FoundRegs = 0;
2325
2326   auto RegMask = Prev->getOperand(1);
2327
2328   auto &RegClass =
2329       Is64Bit ? X86::GR64_NOREX_NOSPRegClass : X86::GR32_NOREX_NOSPRegClass;
2330   // Try to find up to NumPops free registers.
2331   for (auto Candidate : RegClass) {
2332
2333     // Poor man's liveness:
2334     // Since we're immediately after a call, any register that is clobbered
2335     // by the call and not defined by it can be considered dead.
2336     if (!RegMask.clobbersPhysReg(Candidate))
2337       continue;
2338
2339     bool IsDef = false;
2340     for (const MachineOperand &MO : Prev->implicit_operands()) {
2341       if (MO.isReg() && MO.isDef() && MO.getReg() == Candidate) {
2342         IsDef = true;
2343         break;
2344       }
2345     }
2346
2347     if (IsDef)
2348       continue;
2349
2350     Regs[FoundRegs++] = Candidate;
2351     if (FoundRegs == (unsigned)NumPops)
2352       break;
2353   }
2354
2355   if (FoundRegs == 0)
2356     return false;
2357
2358   // If we found only one free register, but need two, reuse the same one twice.
2359   while (FoundRegs < (unsigned)NumPops)
2360     Regs[FoundRegs++] = Regs[0];
2361
2362   for (int i = 0; i < NumPops; ++i)
2363     BuildMI(MBB, MBBI, DL,
2364             TII.get(STI.is64Bit() ? X86::POP64r : X86::POP32r), Regs[i]);
2365
2366   return true;
2367 }
2368
2369 void X86FrameLowering::
2370 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
2371                               MachineBasicBlock::iterator I) const {
2372   bool reserveCallFrame = hasReservedCallFrame(MF);
2373   unsigned Opcode = I->getOpcode();
2374   bool isDestroy = Opcode == TII.getCallFrameDestroyOpcode();
2375   DebugLoc DL = I->getDebugLoc();
2376   uint64_t Amount = !reserveCallFrame ? I->getOperand(0).getImm() : 0;
2377   uint64_t InternalAmt = (isDestroy || Amount) ? I->getOperand(1).getImm() : 0;
2378   I = MBB.erase(I);
2379
2380   if (!reserveCallFrame) {
2381     // If the stack pointer can be changed after prologue, turn the
2382     // adjcallstackup instruction into a 'sub ESP, <amt>' and the
2383     // adjcallstackdown instruction into 'add ESP, <amt>'
2384
2385     // We need to keep the stack aligned properly.  To do this, we round the
2386     // amount of space needed for the outgoing arguments up to the next
2387     // alignment boundary.
2388     unsigned StackAlign = getStackAlignment();
2389     Amount = RoundUpToAlignment(Amount, StackAlign);
2390
2391     MachineModuleInfo &MMI = MF.getMMI();
2392     const Function *Fn = MF.getFunction();
2393     bool WindowsCFI = MF.getTarget().getMCAsmInfo()->usesWindowsCFI();
2394     bool DwarfCFI = !WindowsCFI &&
2395                     (MMI.hasDebugInfo() || Fn->needsUnwindTableEntry());
2396
2397     // If we have any exception handlers in this function, and we adjust
2398     // the SP before calls, we may need to indicate this to the unwinder
2399     // using GNU_ARGS_SIZE. Note that this may be necessary even when
2400     // Amount == 0, because the preceding function may have set a non-0
2401     // GNU_ARGS_SIZE.
2402     // TODO: We don't need to reset this between subsequent functions,
2403     // if it didn't change.
2404     bool HasDwarfEHHandlers = !WindowsCFI &&
2405                               !MF.getMMI().getLandingPads().empty();
2406
2407     if (HasDwarfEHHandlers && !isDestroy &&
2408         MF.getInfo<X86MachineFunctionInfo>()->getHasPushSequences())
2409       BuildCFI(MBB, I, DL,
2410                MCCFIInstruction::createGnuArgsSize(nullptr, Amount));
2411
2412     if (Amount == 0)
2413       return;
2414
2415     // Factor out the amount that gets handled inside the sequence
2416     // (Pushes of argument for frame setup, callee pops for frame destroy)
2417     Amount -= InternalAmt;
2418
2419     // If this is a callee-pop calling convention, and we're emitting precise
2420     // SP-based CFI, emit a CFA adjust for the amount the callee popped.
2421     if (isDestroy && InternalAmt && DwarfCFI && !hasFP(MF) &&
2422         MMI.usePreciseUnwindInfo())
2423       BuildCFI(MBB, I, DL,
2424                MCCFIInstruction::createAdjustCfaOffset(nullptr, -InternalAmt));
2425
2426     if (Amount) {
2427       // Add Amount to SP to destroy a frame, and subtract to setup.
2428       int Offset = isDestroy ? Amount : -Amount;
2429
2430       if (!(Fn->optForMinSize() &&
2431             adjustStackWithPops(MBB, I, DL, Offset)))
2432         BuildStackAdjustment(MBB, I, DL, Offset, /*InEpilogue=*/false);
2433     }
2434
2435     if (DwarfCFI && !hasFP(MF)) {
2436       // If we don't have FP, but need to generate unwind information,
2437       // we need to set the correct CFA offset after the stack adjustment.
2438       // How much we adjust the CFA offset depends on whether we're emitting
2439       // CFI only for EH purposes or for debugging. EH only requires the CFA
2440       // offset to be correct at each call site, while for debugging we want
2441       // it to be more precise.
2442       int CFAOffset = Amount;
2443       if (!MMI.usePreciseUnwindInfo())
2444         CFAOffset += InternalAmt;
2445       CFAOffset = isDestroy ? -CFAOffset : CFAOffset;
2446       BuildCFI(MBB, I, DL,
2447                MCCFIInstruction::createAdjustCfaOffset(nullptr, CFAOffset));
2448     }
2449
2450     return;
2451   }
2452
2453   if (isDestroy && InternalAmt) {
2454     // If we are performing frame pointer elimination and if the callee pops
2455     // something off the stack pointer, add it back.  We do this until we have
2456     // more advanced stack pointer tracking ability.
2457     // We are not tracking the stack pointer adjustment by the callee, so make
2458     // sure we restore the stack pointer immediately after the call, there may
2459     // be spill code inserted between the CALL and ADJCALLSTACKUP instructions.
2460     MachineBasicBlock::iterator B = MBB.begin();
2461     while (I != B && !std::prev(I)->isCall())
2462       --I;
2463     BuildStackAdjustment(MBB, I, DL, -InternalAmt, /*InEpilogue=*/false);
2464   }
2465 }
2466
2467 bool X86FrameLowering::canUseAsEpilogue(const MachineBasicBlock &MBB) const {
2468   assert(MBB.getParent() && "Block is not attached to a function!");
2469
2470   // Win64 has strict requirements in terms of epilogue and we are
2471   // not taking a chance at messing with them.
2472   // I.e., unless this block is already an exit block, we can't use
2473   // it as an epilogue.
2474   if (MBB.getParent()->getSubtarget<X86Subtarget>().isTargetWin64() &&
2475       !MBB.succ_empty() && !MBB.isReturnBlock())
2476     return false;
2477
2478   if (canUseLEAForSPInEpilogue(*MBB.getParent()))
2479     return true;
2480
2481   // If we cannot use LEA to adjust SP, we may need to use ADD, which
2482   // clobbers the EFLAGS. Check that none of the terminators reads the
2483   // EFLAGS, and if one uses it, conservatively assume this is not
2484   // safe to insert the epilogue here.
2485   return !terminatorsNeedFlagsAsInput(MBB);
2486 }
2487
2488 MachineBasicBlock::iterator X86FrameLowering::restoreWin32EHStackPointers(
2489     MachineBasicBlock &MBB, MachineBasicBlock::iterator MBBI,
2490     DebugLoc DL, bool RestoreSP) const {
2491   assert(STI.isTargetWindowsMSVC() && "funclets only supported in MSVC env");
2492   assert(STI.isTargetWin32() && "EBP/ESI restoration only required on win32");
2493   assert(STI.is32Bit() && !Uses64BitFramePtr &&
2494          "restoring EBP/ESI on non-32-bit target");
2495
2496   MachineFunction &MF = *MBB.getParent();
2497   unsigned FramePtr = TRI->getFrameRegister(MF);
2498   unsigned BasePtr = TRI->getBaseRegister();
2499   MachineModuleInfo &MMI = MF.getMMI();
2500   const Function *Fn = MF.getFunction();
2501   WinEHFuncInfo &FuncInfo = MMI.getWinEHFuncInfo(Fn);
2502   X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
2503   MachineFrameInfo *MFI = MF.getFrameInfo();
2504
2505   // FIXME: Don't set FrameSetup flag in catchret case.
2506
2507   int FI = FuncInfo.EHRegNodeFrameIndex;
2508   int EHRegSize = MFI->getObjectSize(FI);
2509
2510   if (RestoreSP) {
2511     // MOV32rm -EHRegSize(%ebp), %esp
2512     addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32rm), X86::ESP),
2513                  X86::EBP, true, -EHRegSize)
2514         .setMIFlag(MachineInstr::FrameSetup);
2515   }
2516
2517   unsigned UsedReg;
2518   int EHRegOffset = getFrameIndexReference(MF, FI, UsedReg);
2519   int EndOffset = -EHRegOffset - EHRegSize;
2520   FuncInfo.EHRegNodeEndOffset = EndOffset;
2521
2522   if (UsedReg == FramePtr) {
2523     // ADD $offset, %ebp
2524     unsigned ADDri = getADDriOpcode(false, EndOffset);
2525     BuildMI(MBB, MBBI, DL, TII.get(ADDri), FramePtr)
2526         .addReg(FramePtr)
2527         .addImm(EndOffset)
2528         .setMIFlag(MachineInstr::FrameSetup)
2529         ->getOperand(3)
2530         .setIsDead();
2531     assert(EndOffset >= 0 &&
2532            "end of registration object above normal EBP position!");
2533   } else if (UsedReg == BasePtr) {
2534     // LEA offset(%ebp), %esi
2535     addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(X86::LEA32r), BasePtr),
2536                  FramePtr, false, EndOffset)
2537         .setMIFlag(MachineInstr::FrameSetup);
2538     // MOV32rm SavedEBPOffset(%esi), %ebp
2539     assert(X86FI->getHasSEHFramePtrSave());
2540     int Offset =
2541         getFrameIndexReference(MF, X86FI->getSEHFramePtrSaveIndex(), UsedReg);
2542     assert(UsedReg == BasePtr);
2543     addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32rm), FramePtr),
2544                  UsedReg, true, Offset)
2545         .setMIFlag(MachineInstr::FrameSetup);
2546   } else {
2547     llvm_unreachable("32-bit frames with WinEH must use FramePtr or BasePtr");
2548   }
2549   return MBBI;
2550 }
2551
2552 unsigned X86FrameLowering::getWinEHParentFrameOffset(const MachineFunction &MF) const {
2553   // RDX, the parent frame pointer, is homed into 16(%rsp) in the prologue.
2554   unsigned Offset = 16;
2555   // RBP is immediately pushed.
2556   Offset += SlotSize;
2557   // All callee-saved registers are then pushed.
2558   Offset += MF.getInfo<X86MachineFunctionInfo>()->getCalleeSavedFrameSize();
2559   // Every funclet allocates enough stack space for the largest outgoing call.
2560   Offset += getWinEHFuncletFrameSize(MF);
2561   return Offset;
2562 }