lib/Target/X86/X86FrameLowering.cpp

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