lib/Target/X86/X86FrameLowering.cpp

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