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