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