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