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