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