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