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