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
  33 using namespace llvm;
  34
  35 // FIXME: completely move here.
  36 extern cl::opt<bool> ForceStackAlign;
  37
  38 bool X86FrameLowering::hasReservedCallFrame(const MachineFunction &MF) const {
  39   return !MF.getFrameInfo()->hasVarSizedObjects();
  40 }
  41
  42 /// hasFP - Return true if the specified function should have a dedicated frame
  43 /// pointer register.  This is true if the function has variable sized allocas
  44 /// or if frame pointer elimination is disabled.
  45 bool X86FrameLowering::hasFP(const MachineFunction &MF) const {
  46   const MachineFrameInfo *MFI = MF.getFrameInfo();
  47   const MachineModuleInfo &MMI = MF.getMMI();
  48   const TargetRegisterInfo *RegInfo = MF.getTarget().getRegisterInfo();
  49
  50   return (MF.getTarget().Options.DisableFramePointerElim(MF) ||
  51           RegInfo->needsStackRealignment(MF) ||
  52           MFI->hasVarSizedObjects() ||
  53           MFI->isFrameAddressTaken() || MFI->hasInlineAsmWithSPAdjust() ||
  54           MF.getInfo<X86MachineFunctionInfo>()->getForceFramePointer() ||
  55           MMI.callsUnwindInit() || MMI.callsEHReturn());
  56 }
  57
  58 static unsigned getSUBriOpcode(unsigned IsLP64, int64_t Imm) {
  59   if (IsLP64) {
  60     if (isInt<8>(Imm))
  61       return X86::SUB64ri8;
  62     return X86::SUB64ri32;
  63   } else {
  64     if (isInt<8>(Imm))
  65       return X86::SUB32ri8;
  66     return X86::SUB32ri;
  67   }
  68 }
  69
  70 static unsigned getADDriOpcode(unsigned IsLP64, int64_t Imm) {
  71   if (IsLP64) {
  72     if (isInt<8>(Imm))
  73       return X86::ADD64ri8;
  74     return X86::ADD64ri32;
  75   } else {
  76     if (isInt<8>(Imm))
  77       return X86::ADD32ri8;
  78     return X86::ADD32ri;
  79   }
  80 }
  81
  82 static unsigned getLEArOpcode(unsigned IsLP64) {
  83   return IsLP64 ? X86::LEA64r : X86::LEA32r;
  84 }
  85
  86 /// findDeadCallerSavedReg - Return a caller-saved register that isn't live
  87 /// when it reaches the "return" instruction. We can then pop a stack object
  88 /// to this register without worry about clobbering it.
  89 static unsigned findDeadCallerSavedReg(MachineBasicBlock &MBB,
  90                                        MachineBasicBlock::iterator &MBBI,
  91                                        const TargetRegisterInfo &TRI,
  92                                        bool Is64Bit) {
  93   const MachineFunction *MF = MBB.getParent();
  94   const Function *F = MF->getFunction();
  95   if (!F || MF->getMMI().callsEHReturn())
  96     return 0;
  97
  98   static const uint16_t CallerSavedRegs32Bit[] = {
  99     X86::EAX, X86::EDX, X86::ECX, 0
 100   };
 101
 102   static const uint16_t CallerSavedRegs64Bit[] = {
 103     X86::RAX, X86::RDX, X86::RCX, X86::RSI, X86::RDI,
 104     X86::R8,  X86::R9,  X86::R10, X86::R11, 0
 105   };
 106
 107   unsigned Opc = MBBI->getOpcode();
 108   switch (Opc) {
 109   default: return 0;
 110   case X86::RETL:
 111   case X86::RETQ:
 112   case X86::RETIL:
 113   case X86::RETIQ:
 114   case X86::TCRETURNdi:
 115   case X86::TCRETURNri:
 116   case X86::TCRETURNmi:
 117   case X86::TCRETURNdi64:
 118   case X86::TCRETURNri64:
 119   case X86::TCRETURNmi64:
 120   case X86::EH_RETURN:
 121   case X86::EH_RETURN64: {
 122     SmallSet<uint16_t, 8> Uses;
 123     for (unsigned i = 0, e = MBBI->getNumOperands(); i != e; ++i) {
 124       MachineOperand &MO = MBBI->getOperand(i);
 125       if (!MO.isReg() || MO.isDef())
 126         continue;
 127       unsigned Reg = MO.getReg();
 128       if (!Reg)
 129         continue;
 130       for (MCRegAliasIterator AI(Reg, &TRI, true); AI.isValid(); ++AI)
 131         Uses.insert(*AI);
 132     }
 133
 134     const uint16_t *CS = Is64Bit ? CallerSavedRegs64Bit : CallerSavedRegs32Bit;
 135     for (; *CS; ++CS)
 136       if (!Uses.count(*CS))
 137         return *CS;
 138   }
 139   }
 140
 141   return 0;
 142 }
 143
 144
 145 /// emitSPUpdate - Emit a series of instructions to increment / decrement the
 146 /// stack pointer by a constant value.
 147 static
 148 void emitSPUpdate(MachineBasicBlock &MBB, MachineBasicBlock::iterator &MBBI,
 149                   unsigned StackPtr, int64_t NumBytes,
 150                   bool Is64Bit, bool IsLP64, bool UseLEA,
 151                   const TargetInstrInfo &TII, const TargetRegisterInfo &TRI) {
 152   bool isSub = NumBytes < 0;
 153   uint64_t Offset = isSub ? -NumBytes : NumBytes;
 154   unsigned Opc;
 155   if (UseLEA)
 156     Opc = getLEArOpcode(IsLP64);
 157   else
 158     Opc = isSub
 159       ? getSUBriOpcode(IsLP64, Offset)
 160       : getADDriOpcode(IsLP64, Offset);
 161
 162   uint64_t Chunk = (1LL << 31) - 1;
 163   DebugLoc DL = MBB.findDebugLoc(MBBI);
 164
 165   while (Offset) {
 166     uint64_t ThisVal = (Offset > Chunk) ? Chunk : Offset;
 167     if (ThisVal == (Is64Bit ? 8 : 4)) {
 168       // Use push / pop instead.
 169       unsigned Reg = isSub
 170         ? (unsigned)(Is64Bit ? X86::RAX : X86::EAX)
 171         : findDeadCallerSavedReg(MBB, MBBI, TRI, Is64Bit);
 172       if (Reg) {
 173         Opc = isSub
 174           ? (Is64Bit ? X86::PUSH64r : X86::PUSH32r)
 175           : (Is64Bit ? X86::POP64r  : X86::POP32r);
 176         MachineInstr *MI = BuildMI(MBB, MBBI, DL, TII.get(Opc))
 177           .addReg(Reg, getDefRegState(!isSub) | getUndefRegState(isSub));
 178         if (isSub)
 179           MI->setFlag(MachineInstr::FrameSetup);
 180         Offset -= ThisVal;
 181         continue;
 182       }
 183     }
 184
 185     MachineInstr *MI = nullptr;
 186
 187     if (UseLEA) {
 188       MI =  addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr),
 189                           StackPtr, false, isSub ? -ThisVal : ThisVal);
 190     } else {
 191       MI = BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr)
 192             .addReg(StackPtr)
 193             .addImm(ThisVal);
 194       MI->getOperand(3).setIsDead(); // The EFLAGS implicit def is dead.
 195     }
 196
 197     if (isSub)
 198       MI->setFlag(MachineInstr::FrameSetup);
 199
 200     Offset -= ThisVal;
 201   }
 202 }
 203
 204 /// mergeSPUpdatesUp - Merge two stack-manipulating instructions upper iterator.
 205 static
 206 void mergeSPUpdatesUp(MachineBasicBlock &MBB, MachineBasicBlock::iterator &MBBI,
 207                       unsigned StackPtr, uint64_t *NumBytes = nullptr) {
 208   if (MBBI == MBB.begin()) return;
 209
 210   MachineBasicBlock::iterator PI = std::prev(MBBI);
 211   unsigned Opc = PI->getOpcode();
 212   if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
 213        Opc == X86::ADD32ri || Opc == X86::ADD32ri8 ||
 214        Opc == X86::LEA32r || Opc == X86::LEA64_32r) &&
 215       PI->getOperand(0).getReg() == StackPtr) {
 216     if (NumBytes)
 217       *NumBytes += PI->getOperand(2).getImm();
 218     MBB.erase(PI);
 219   } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
 220               Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
 221              PI->getOperand(0).getReg() == StackPtr) {
 222     if (NumBytes)
 223       *NumBytes -= PI->getOperand(2).getImm();
 224     MBB.erase(PI);
 225   }
 226 }
 227
 228 /// mergeSPUpdatesDown - Merge two stack-manipulating instructions lower
 229 /// iterator.
 230 static
 231 void mergeSPUpdatesDown(MachineBasicBlock &MBB,
 232                         MachineBasicBlock::iterator &MBBI,
 233                         unsigned StackPtr, uint64_t *NumBytes = nullptr) {
 234   // FIXME:  THIS ISN'T RUN!!!
 235   return;
 236
 237   if (MBBI == MBB.end()) return;
 238
 239   MachineBasicBlock::iterator NI = std::next(MBBI);
 240   if (NI == MBB.end()) return;
 241
 242   unsigned Opc = NI->getOpcode();
 243   if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
 244        Opc == X86::ADD32ri || Opc == X86::ADD32ri8) &&
 245       NI->getOperand(0).getReg() == StackPtr) {
 246     if (NumBytes)
 247       *NumBytes -= NI->getOperand(2).getImm();
 248     MBB.erase(NI);
 249     MBBI = NI;
 250   } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
 251               Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
 252              NI->getOperand(0).getReg() == StackPtr) {
 253     if (NumBytes)
 254       *NumBytes += NI->getOperand(2).getImm();
 255     MBB.erase(NI);
 256     MBBI = NI;
 257   }
 258 }
 259
 260 /// mergeSPUpdates - Checks the instruction before/after the passed
 261 /// instruction. If it is an ADD/SUB/LEA instruction it is deleted argument and
 262 /// the stack adjustment is returned as a positive value for ADD/LEA and a
 263 /// negative for SUB.
 264 static int mergeSPUpdates(MachineBasicBlock &MBB,
 265                           MachineBasicBlock::iterator &MBBI, unsigned StackPtr,
 266                           bool doMergeWithPrevious) {
 267   if ((doMergeWithPrevious && MBBI == MBB.begin()) ||
 268       (!doMergeWithPrevious && MBBI == MBB.end()))
 269     return 0;
 270
 271   MachineBasicBlock::iterator PI = doMergeWithPrevious ? std::prev(MBBI) : MBBI;
 272   MachineBasicBlock::iterator NI = doMergeWithPrevious ? nullptr
 273                                                        : std::next(MBBI);
 274   unsigned Opc = PI->getOpcode();
 275   int Offset = 0;
 276
 277   if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
 278        Opc == X86::ADD32ri || Opc == X86::ADD32ri8 ||
 279        Opc == X86::LEA32r || Opc == X86::LEA64_32r) &&
 280       PI->getOperand(0).getReg() == StackPtr){
 281     Offset += PI->getOperand(2).getImm();
 282     MBB.erase(PI);
 283     if (!doMergeWithPrevious) MBBI = NI;
 284   } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
 285               Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
 286              PI->getOperand(0).getReg() == StackPtr) {
 287     Offset -= PI->getOperand(2).getImm();
 288     MBB.erase(PI);
 289     if (!doMergeWithPrevious) MBBI = NI;
 290   }
 291
 292   return Offset;
 293 }
 294
 295 static bool isEAXLiveIn(MachineFunction &MF) {
 296   for (MachineRegisterInfo::livein_iterator II = MF.getRegInfo().livein_begin(),
 297        EE = MF.getRegInfo().livein_end(); II != EE; ++II) {
 298     unsigned Reg = II->first;
 299
 300     if (Reg == X86::EAX || Reg == X86::AX ||
 301         Reg == X86::AH || Reg == X86::AL)
 302       return true;
 303   }
 304
 305   return false;
 306 }
 307
 308 void X86FrameLowering::emitCalleeSavedFrameMoves(
 309     MachineBasicBlock &MBB, MachineBasicBlock::iterator MBBI, DebugLoc DL,
 310     unsigned FramePtr) const {
 311   MachineFunction &MF = *MBB.getParent();
 312   MachineFrameInfo *MFI = MF.getFrameInfo();
 313   MachineModuleInfo &MMI = MF.getMMI();
 314   const MCRegisterInfo *MRI = MMI.getContext().getRegisterInfo();
 315   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 316
 317   // Add callee saved registers to move list.
 318   const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
 319   if (CSI.empty()) return;
 320
 321   const X86RegisterInfo *RegInfo =
 322       static_cast<const X86RegisterInfo *>(MF.getTarget().getRegisterInfo());
 323   bool HasFP = hasFP(MF);
 324
 325   // Calculate amount of bytes used for return address storing.
 326   int stackGrowth = -RegInfo->getSlotSize();
 327
 328   // FIXME: This is dirty hack. The code itself is pretty mess right now.
 329   // It should be rewritten from scratch and generalized sometimes.
 330
 331   // Determine maximum offset (minimum due to stack growth).
 332   int64_t MaxOffset = 0;
 333   for (std::vector<CalleeSavedInfo>::const_iterator
 334          I = CSI.begin(), E = CSI.end(); I != E; ++I)
 335     MaxOffset = std::min(MaxOffset,
 336                          MFI->getObjectOffset(I->getFrameIdx()));
 337
 338   // Calculate offsets.
 339   int64_t saveAreaOffset = (HasFP ? 3 : 2) * stackGrowth;
 340   for (std::vector<CalleeSavedInfo>::const_iterator
 341          I = CSI.begin(), E = CSI.end(); I != E; ++I) {
 342     int64_t Offset = MFI->getObjectOffset(I->getFrameIdx());
 343     unsigned Reg = I->getReg();
 344     Offset = MaxOffset - Offset + saveAreaOffset;
 345
 346     // Don't output a new machine move if we're re-saving the frame
 347     // pointer. This happens when the PrologEpilogInserter has inserted an extra
 348     // "PUSH" of the frame pointer -- the "emitPrologue" method automatically
 349     // generates one when frame pointers are used. If we generate a "machine
 350     // move" for this extra "PUSH", the linker will lose track of the fact that
 351     // the frame pointer should have the value of the first "PUSH" when it's
 352     // trying to unwind.
 353     //
 354     // FIXME: This looks inelegant. It's possibly correct, but it's covering up
 355     //        another bug. I.e., one where we generate a prolog like this:
 356     //
 357     //          pushl  %ebp
 358     //          movl   %esp, %ebp
 359     //          pushl  %ebp
 360     //          pushl  %esi
 361     //           ...
 362     //
 363     //        The immediate re-push of EBP is unnecessary. At the least, it's an
 364     //        optimization bug. EBP can be used as a scratch register in certain
 365     //        cases, but probably not when we have a frame pointer.
 366     if (HasFP && FramePtr == Reg)
 367       continue;
 368
 369     unsigned DwarfReg = MRI->getDwarfRegNum(Reg, true);
 370     unsigned CFIIndex =
 371         MMI.addFrameInst(MCCFIInstruction::createOffset(nullptr, DwarfReg,
 372                                                         Offset));
 373     BuildMI(MBB, MBBI, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
 374         .addCFIIndex(CFIIndex);
 375   }
 376 }
 377
 378 /// usesTheStack - This function checks if any of the users of EFLAGS
 379 /// copies the EFLAGS. We know that the code that lowers COPY of EFLAGS has
 380 /// to use the stack, and if we don't adjust the stack we clobber the first
 381 /// frame index.
 382 /// See X86InstrInfo::copyPhysReg.
 383 static bool usesTheStack(const MachineFunction &MF) {
 384   const MachineRegisterInfo &MRI = MF.getRegInfo();
 385
 386   for (MachineRegisterInfo::reg_instr_iterator
 387        ri = MRI.reg_instr_begin(X86::EFLAGS), re = MRI.reg_instr_end();
 388        ri != re; ++ri)
 389     if (ri->isCopy())
 390       return true;
 391
 392   return false;
 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 void X86FrameLowering::emitPrologue(MachineFunction &MF) const {
 400   MachineBasicBlock &MBB = MF.front(); // Prologue goes in entry BB.
 401   MachineBasicBlock::iterator MBBI = MBB.begin();
 402   MachineFrameInfo *MFI = MF.getFrameInfo();
 403   const Function *Fn = MF.getFunction();
 404   const X86RegisterInfo *RegInfo =
 405       static_cast<const X86RegisterInfo *>(MF.getTarget().getRegisterInfo());
 406   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 407   MachineModuleInfo &MMI = MF.getMMI();
 408   X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
 409   bool needsFrameMoves = MMI.hasDebugInfo() ||
 410     Fn->needsUnwindTableEntry();
 411   uint64_t MaxAlign  = MFI->getMaxAlignment(); // Desired stack alignment.
 412   uint64_t StackSize = MFI->getStackSize();    // Number of bytes to allocate.
 413   bool HasFP = hasFP(MF);
 414   bool Is64Bit = STI.is64Bit();
 415   bool IsLP64 = STI.isTarget64BitLP64();
 416   bool IsWin64 = STI.isTargetWin64();
 417   bool UseLEA = STI.useLeaForSP();
 418   unsigned StackAlign = getStackAlignment();
 419   unsigned SlotSize = RegInfo->getSlotSize();
 420   unsigned FramePtr = RegInfo->getFrameRegister(MF);
 421   unsigned StackPtr = RegInfo->getStackRegister();
 422   unsigned BasePtr = RegInfo->getBaseRegister();
 423   DebugLoc DL;
 424
 425   // If we're forcing a stack realignment we can't rely on just the frame
 426   // info, we need to know the ABI stack alignment as well in case we
 427   // have a call out.  Otherwise just make sure we have some alignment - we'll
 428   // go with the minimum SlotSize.
 429   if (ForceStackAlign) {
 430     if (MFI->hasCalls())
 431       MaxAlign = (StackAlign > MaxAlign) ? StackAlign : MaxAlign;
 432     else if (MaxAlign < SlotSize)
 433       MaxAlign = SlotSize;
 434   }
 435
 436   // Add RETADDR move area to callee saved frame size.
 437   int TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
 438   if (TailCallReturnAddrDelta < 0)
 439     X86FI->setCalleeSavedFrameSize(
 440       X86FI->getCalleeSavedFrameSize() - TailCallReturnAddrDelta);
 441
 442   // If this is x86-64 and the Red Zone is not disabled, if we are a leaf
 443   // function, and use up to 128 bytes of stack space, don't have a frame
 444   // pointer, calls, or dynamic alloca then we do not need to adjust the
 445   // stack pointer (we fit in the Red Zone). We also check that we don't
 446   // push and pop from the stack.
 447   if (Is64Bit && !Fn->getAttributes().hasAttribute(AttributeSet::FunctionIndex,
 448                                                    Attribute::NoRedZone) &&
 449       !RegInfo->needsStackRealignment(MF) &&
 450       !MFI->hasVarSizedObjects() &&                     // No dynamic alloca.
 451       !MFI->adjustsStack() &&                           // No calls.
 452       !IsWin64 &&                                       // Win64 has no Red Zone
 453       !usesTheStack(MF) &&                              // Don't push and pop.
 454       !MF.shouldSplitStack()) {                         // Regular stack
 455     uint64_t MinSize = X86FI->getCalleeSavedFrameSize();
 456     if (HasFP) MinSize += SlotSize;
 457     StackSize = std::max(MinSize, StackSize > 128 ? StackSize - 128 : 0);
 458     MFI->setStackSize(StackSize);
 459   }
 460
 461   // Insert stack pointer adjustment for later moving of return addr.  Only
 462   // applies to tail call optimized functions where the callee argument stack
 463   // size is bigger than the callers.
 464   if (TailCallReturnAddrDelta < 0) {
 465     MachineInstr *MI =
 466       BuildMI(MBB, MBBI, DL,
 467               TII.get(getSUBriOpcode(IsLP64, -TailCallReturnAddrDelta)),
 468               StackPtr)
 469         .addReg(StackPtr)
 470         .addImm(-TailCallReturnAddrDelta)
 471         .setMIFlag(MachineInstr::FrameSetup);
 472     MI->getOperand(3).setIsDead(); // The EFLAGS implicit def is dead.
 473   }
 474
 475   // Mapping for machine moves:
 476   //
 477   //   DST: VirtualFP AND
 478   //        SRC: VirtualFP              => DW_CFA_def_cfa_offset
 479   //        ELSE                        => DW_CFA_def_cfa
 480   //
 481   //   SRC: VirtualFP AND
 482   //        DST: Register               => DW_CFA_def_cfa_register
 483   //
 484   //   ELSE
 485   //        OFFSET < 0                  => DW_CFA_offset_extended_sf
 486   //        REG < 64                    => DW_CFA_offset + Reg
 487   //        ELSE                        => DW_CFA_offset_extended
 488
 489   uint64_t NumBytes = 0;
 490   int stackGrowth = -SlotSize;
 491
 492   if (HasFP) {
 493     // Calculate required stack adjustment.
 494     uint64_t FrameSize = StackSize - SlotSize;
 495     if (RegInfo->needsStackRealignment(MF)) {
 496       // Callee-saved registers are pushed on stack before the stack
 497       // is realigned.
 498       FrameSize -= X86FI->getCalleeSavedFrameSize();
 499       NumBytes = (FrameSize + MaxAlign - 1) / MaxAlign * MaxAlign;
 500     } else {
 501       NumBytes = FrameSize - X86FI->getCalleeSavedFrameSize();
 502     }
 503
 504     // Get the offset of the stack slot for the EBP register, which is
 505     // guaranteed to be the last slot by processFunctionBeforeFrameFinalized.
 506     // Update the frame offset adjustment.
 507     MFI->setOffsetAdjustment(-NumBytes);
 508
 509     // Save EBP/RBP into the appropriate stack slot.
 510     BuildMI(MBB, MBBI, DL, TII.get(Is64Bit ? X86::PUSH64r : X86::PUSH32r))
 511       .addReg(FramePtr, RegState::Kill)
 512       .setMIFlag(MachineInstr::FrameSetup);
 513
 514     if (needsFrameMoves) {
 515       // Mark the place where EBP/RBP was saved.
 516       // Define the current CFA rule to use the provided offset.
 517       assert(StackSize);
 518       unsigned CFIIndex = MMI.addFrameInst(
 519           MCCFIInstruction::createDefCfaOffset(nullptr, 2 * stackGrowth));
 520       BuildMI(MBB, MBBI, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
 521           .addCFIIndex(CFIIndex);
 522
 523       // Change the rule for the FramePtr to be an "offset" rule.
 524       unsigned DwarfFramePtr = RegInfo->getDwarfRegNum(FramePtr, true);
 525       CFIIndex = MMI.addFrameInst(
 526           MCCFIInstruction::createOffset(nullptr,
 527                                          DwarfFramePtr, 2 * stackGrowth));
 528       BuildMI(MBB, MBBI, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
 529           .addCFIIndex(CFIIndex);
 530     }
 531
 532     // Update EBP with the new base value.
 533     BuildMI(MBB, MBBI, DL,
 534             TII.get(Is64Bit ? X86::MOV64rr : X86::MOV32rr), FramePtr)
 535         .addReg(StackPtr)
 536         .setMIFlag(MachineInstr::FrameSetup);
 537
 538     if (needsFrameMoves) {
 539       // Mark effective beginning of when frame pointer becomes valid.
 540       // Define the current CFA to use the EBP/RBP register.
 541       unsigned DwarfFramePtr = RegInfo->getDwarfRegNum(FramePtr, true);
 542       unsigned CFIIndex = MMI.addFrameInst(
 543           MCCFIInstruction::createDefCfaRegister(nullptr, DwarfFramePtr));
 544       BuildMI(MBB, MBBI, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
 545           .addCFIIndex(CFIIndex);
 546     }
 547
 548     // Mark the FramePtr as live-in in every block except the entry.
 549     for (MachineFunction::iterator I = std::next(MF.begin()), E = MF.end();
 550          I != E; ++I)
 551       I->addLiveIn(FramePtr);
 552   } else {
 553     NumBytes = StackSize - X86FI->getCalleeSavedFrameSize();
 554   }
 555
 556   // Skip the callee-saved push instructions.
 557   bool PushedRegs = false;
 558   int StackOffset = 2 * stackGrowth;
 559
 560   while (MBBI != MBB.end() &&
 561          (MBBI->getOpcode() == X86::PUSH32r ||
 562           MBBI->getOpcode() == X86::PUSH64r)) {
 563     PushedRegs = true;
 564     MBBI->setFlag(MachineInstr::FrameSetup);
 565     ++MBBI;
 566
 567     if (!HasFP && needsFrameMoves) {
 568       // Mark callee-saved push instruction.
 569       // Define the current CFA rule to use the provided offset.
 570       assert(StackSize);
 571       unsigned CFIIndex = MMI.addFrameInst(
 572           MCCFIInstruction::createDefCfaOffset(nullptr, StackOffset));
 573       BuildMI(MBB, MBBI, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
 574           .addCFIIndex(CFIIndex);
 575       StackOffset += stackGrowth;
 576     }
 577   }
 578
 579   // Realign stack after we pushed callee-saved registers (so that we'll be
 580   // able to calculate their offsets from the frame pointer).
 581
 582   // NOTE: We push the registers before realigning the stack, so
 583   // vector callee-saved (xmm) registers may be saved w/o proper
 584   // alignment in this way. However, currently these regs are saved in
 585   // stack slots (see X86FrameLowering::spillCalleeSavedRegisters()), so
 586   // this shouldn't be a problem.
 587   if (RegInfo->needsStackRealignment(MF)) {
 588     assert(HasFP && "There should be a frame pointer if stack is realigned.");
 589     MachineInstr *MI =
 590       BuildMI(MBB, MBBI, DL,
 591               TII.get(Is64Bit ? X86::AND64ri32 : X86::AND32ri), StackPtr)
 592       .addReg(StackPtr)
 593       .addImm(-MaxAlign)
 594       .setMIFlag(MachineInstr::FrameSetup);
 595
 596     // The EFLAGS implicit def is dead.
 597     MI->getOperand(3).setIsDead();
 598   }
 599
 600   // If there is an SUB32ri of ESP immediately before this instruction, merge
 601   // the two. This can be the case when tail call elimination is enabled and
 602   // the callee has more arguments then the caller.
 603   NumBytes -= mergeSPUpdates(MBB, MBBI, StackPtr, true);
 604
 605   // If there is an ADD32ri or SUB32ri of ESP immediately after this
 606   // instruction, merge the two instructions.
 607   mergeSPUpdatesDown(MBB, MBBI, StackPtr, &NumBytes);
 608
 609   // Adjust stack pointer: ESP -= numbytes.
 610
 611   // Windows and cygwin/mingw require a prologue helper routine when allocating
 612   // more than 4K bytes on the stack.  Windows uses __chkstk and cygwin/mingw
 613   // uses __alloca.  __alloca and the 32-bit version of __chkstk will probe the
 614   // stack and adjust the stack pointer in one go.  The 64-bit version of
 615   // __chkstk is only responsible for probing the stack.  The 64-bit prologue is
 616   // responsible for adjusting the stack pointer.  Touching the stack at 4K
 617   // increments is necessary to ensure that the guard pages used by the OS
 618   // virtual memory manager are allocated in correct sequence.
 619   if (NumBytes >= 4096 && STI.isOSWindows() && !STI.isTargetMacho()) {
 620     const char *StackProbeSymbol;
 621
 622     if (Is64Bit) {
 623       if (STI.isTargetCygMing()) {
 624         StackProbeSymbol = "___chkstk_ms";
 625       } else {
 626         StackProbeSymbol = "__chkstk";
 627       }
 628     } else if (STI.isTargetCygMing())
 629       StackProbeSymbol = "_alloca";
 630     else
 631       StackProbeSymbol = "_chkstk";
 632
 633     // Check whether EAX is livein for this function.
 634     bool isEAXAlive = isEAXLiveIn(MF);
 635
 636     if (isEAXAlive) {
 637       // Sanity check that EAX is not livein for this function.
 638       // It should not be, so throw an assert.
 639       assert(!Is64Bit && "EAX is livein in x64 case!");
 640
 641       // Save EAX
 642       BuildMI(MBB, MBBI, DL, TII.get(X86::PUSH32r))
 643         .addReg(X86::EAX, RegState::Kill)
 644         .setMIFlag(MachineInstr::FrameSetup);
 645     }
 646
 647     if (Is64Bit) {
 648       // Handle the 64-bit Windows ABI case where we need to call __chkstk.
 649       // Function prologue is responsible for adjusting the stack pointer.
 650       BuildMI(MBB, MBBI, DL, TII.get(X86::MOV64ri), X86::RAX)
 651         .addImm(NumBytes)
 652         .setMIFlag(MachineInstr::FrameSetup);
 653     } else {
 654       // Allocate NumBytes-4 bytes on stack in case of isEAXAlive.
 655       // We'll also use 4 already allocated bytes for EAX.
 656       BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32ri), X86::EAX)
 657         .addImm(isEAXAlive ? NumBytes - 4 : NumBytes)
 658         .setMIFlag(MachineInstr::FrameSetup);
 659     }
 660
 661     BuildMI(MBB, MBBI, DL,
 662             TII.get(Is64Bit ? X86::W64ALLOCA : X86::CALLpcrel32))
 663       .addExternalSymbol(StackProbeSymbol)
 664       .addReg(StackPtr,    RegState::Define | RegState::Implicit)
 665       .addReg(X86::EFLAGS, RegState::Define | RegState::Implicit)
 666       .setMIFlag(MachineInstr::FrameSetup);
 667
 668     if (Is64Bit) {
 669       // MSVC x64's __chkstk and cygwin/mingw's ___chkstk_ms do not adjust %rsp
 670       // themself. It also does not clobber %rax so we can reuse it when
 671       // adjusting %rsp.
 672       BuildMI(MBB, MBBI, DL, TII.get(X86::SUB64rr), StackPtr)
 673         .addReg(StackPtr)
 674         .addReg(X86::RAX)
 675         .setMIFlag(MachineInstr::FrameSetup);
 676     }
 677     if (isEAXAlive) {
 678         // Restore EAX
 679         MachineInstr *MI = addRegOffset(BuildMI(MF, DL, TII.get(X86::MOV32rm),
 680                                                 X86::EAX),
 681                                         StackPtr, false, NumBytes - 4);
 682         MI->setFlag(MachineInstr::FrameSetup);
 683         MBB.insert(MBBI, MI);
 684     }
 685   } else if (NumBytes)
 686     emitSPUpdate(MBB, MBBI, StackPtr, -(int64_t)NumBytes, Is64Bit, IsLP64,
 687                  UseLEA, TII, *RegInfo);
 688
 689   // If we need a base pointer, set it up here. It's whatever the value
 690   // of the stack pointer is at this point. Any variable size objects
 691   // will be allocated after this, so we can still use the base pointer
 692   // to reference locals.
 693   if (RegInfo->hasBasePointer(MF)) {
 694     // Update the frame pointer with the current stack pointer.
 695     unsigned Opc = Is64Bit ? X86::MOV64rr : X86::MOV32rr;
 696     BuildMI(MBB, MBBI, DL, TII.get(Opc), BasePtr)
 697       .addReg(StackPtr)
 698       .setMIFlag(MachineInstr::FrameSetup);
 699   }
 700
 701   if (( (!HasFP && NumBytes) || PushedRegs) && needsFrameMoves) {
 702     // Mark end of stack pointer adjustment.
 703     if (!HasFP && NumBytes) {
 704       // Define the current CFA rule to use the provided offset.
 705       assert(StackSize);
 706       unsigned CFIIndex = MMI.addFrameInst(
 707           MCCFIInstruction::createDefCfaOffset(nullptr,
 708                                                -StackSize + stackGrowth));
 709
 710       BuildMI(MBB, MBBI, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
 711           .addCFIIndex(CFIIndex);
 712     }
 713
 714     // Emit DWARF info specifying the offsets of the callee-saved registers.
 715     if (PushedRegs)
 716       emitCalleeSavedFrameMoves(MBB, MBBI, DL, HasFP ? FramePtr : StackPtr);
 717   }
 718 }
 719
 720 void X86FrameLowering::emitEpilogue(MachineFunction &MF,
 721                                     MachineBasicBlock &MBB) const {
 722   const MachineFrameInfo *MFI = MF.getFrameInfo();
 723   X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
 724   const X86RegisterInfo *RegInfo =
 725       static_cast<const X86RegisterInfo *>(MF.getTarget().getRegisterInfo());
 726   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 727   MachineBasicBlock::iterator MBBI = MBB.getLastNonDebugInstr();
 728   assert(MBBI != MBB.end() && "Returning block has no instructions");
 729   unsigned RetOpcode = MBBI->getOpcode();
 730   DebugLoc DL = MBBI->getDebugLoc();
 731   bool Is64Bit = STI.is64Bit();
 732   bool IsLP64 = STI.isTarget64BitLP64();
 733   bool UseLEA = STI.useLeaForSP();
 734   unsigned StackAlign = getStackAlignment();
 735   unsigned SlotSize = RegInfo->getSlotSize();
 736   unsigned FramePtr = RegInfo->getFrameRegister(MF);
 737   unsigned StackPtr = RegInfo->getStackRegister();
 738
 739   switch (RetOpcode) {
 740   default:
 741     llvm_unreachable("Can only insert epilog into returning blocks");
 742   case X86::RETQ:
 743   case X86::RETL:
 744   case X86::RETIL:
 745   case X86::RETIQ:
 746   case X86::TCRETURNdi:
 747   case X86::TCRETURNri:
 748   case X86::TCRETURNmi:
 749   case X86::TCRETURNdi64:
 750   case X86::TCRETURNri64:
 751   case X86::TCRETURNmi64:
 752   case X86::EH_RETURN:
 753   case X86::EH_RETURN64:
 754     break;  // These are ok
 755   }
 756
 757   // Get the number of bytes to allocate from the FrameInfo.
 758   uint64_t StackSize = MFI->getStackSize();
 759   uint64_t MaxAlign  = MFI->getMaxAlignment();
 760   unsigned CSSize = X86FI->getCalleeSavedFrameSize();
 761   uint64_t NumBytes = 0;
 762
 763   // If we're forcing a stack realignment we can't rely on just the frame
 764   // info, we need to know the ABI stack alignment as well in case we
 765   // have a call out.  Otherwise just make sure we have some alignment - we'll
 766   // go with the minimum.
 767   if (ForceStackAlign) {
 768     if (MFI->hasCalls())
 769       MaxAlign = (StackAlign > MaxAlign) ? StackAlign : MaxAlign;
 770     else
 771       MaxAlign = MaxAlign ? MaxAlign : 4;
 772   }
 773
 774   if (hasFP(MF)) {
 775     // Calculate required stack adjustment.
 776     uint64_t FrameSize = StackSize - SlotSize;
 777     if (RegInfo->needsStackRealignment(MF)) {
 778       // Callee-saved registers were pushed on stack before the stack
 779       // was realigned.
 780       FrameSize -= CSSize;
 781       NumBytes = (FrameSize + MaxAlign - 1) / MaxAlign * MaxAlign;
 782     } else {
 783       NumBytes = FrameSize - CSSize;
 784     }
 785
 786     // Pop EBP.
 787     BuildMI(MBB, MBBI, DL,
 788             TII.get(Is64Bit ? X86::POP64r : X86::POP32r), FramePtr);
 789   } else {
 790     NumBytes = StackSize - CSSize;
 791   }
 792
 793   // Skip the callee-saved pop instructions.
 794   while (MBBI != MBB.begin()) {
 795     MachineBasicBlock::iterator PI = std::prev(MBBI);
 796     unsigned Opc = PI->getOpcode();
 797
 798     if (Opc != X86::POP32r && Opc != X86::POP64r && Opc != X86::DBG_VALUE &&
 799         !PI->isTerminator())
 800       break;
 801
 802     --MBBI;
 803   }
 804   MachineBasicBlock::iterator FirstCSPop = MBBI;
 805
 806   DL = MBBI->getDebugLoc();
 807
 808   // If there is an ADD32ri or SUB32ri of ESP immediately before this
 809   // instruction, merge the two instructions.
 810   if (NumBytes || MFI->hasVarSizedObjects())
 811     mergeSPUpdatesUp(MBB, MBBI, StackPtr, &NumBytes);
 812
 813   // If dynamic alloca is used, then reset esp to point to the last callee-saved
 814   // slot before popping them off! Same applies for the case, when stack was
 815   // realigned.
 816   if (RegInfo->needsStackRealignment(MF) || MFI->hasVarSizedObjects()) {
 817     if (RegInfo->needsStackRealignment(MF))
 818       MBBI = FirstCSPop;
 819     if (CSSize != 0) {
 820       unsigned Opc = getLEArOpcode(IsLP64);
 821       addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr),
 822                    FramePtr, false, -CSSize);
 823     } else {
 824       unsigned Opc = (Is64Bit ? X86::MOV64rr : X86::MOV32rr);
 825       BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr)
 826         .addReg(FramePtr);
 827     }
 828   } else if (NumBytes) {
 829     // Adjust stack pointer back: ESP += numbytes.
 830     emitSPUpdate(MBB, MBBI, StackPtr, NumBytes, Is64Bit, IsLP64, UseLEA,
 831                  TII, *RegInfo);
 832   }
 833
 834   // We're returning from function via eh_return.
 835   if (RetOpcode == X86::EH_RETURN || RetOpcode == X86::EH_RETURN64) {
 836     MBBI = MBB.getLastNonDebugInstr();
 837     MachineOperand &DestAddr  = MBBI->getOperand(0);
 838     assert(DestAddr.isReg() && "Offset should be in register!");
 839     BuildMI(MBB, MBBI, DL,
 840             TII.get(Is64Bit ? X86::MOV64rr : X86::MOV32rr),
 841             StackPtr).addReg(DestAddr.getReg());
 842   } else if (RetOpcode == X86::TCRETURNri || RetOpcode == X86::TCRETURNdi ||
 843              RetOpcode == X86::TCRETURNmi ||
 844              RetOpcode == X86::TCRETURNri64 || RetOpcode == X86::TCRETURNdi64 ||
 845              RetOpcode == X86::TCRETURNmi64) {
 846     bool isMem = RetOpcode == X86::TCRETURNmi || RetOpcode == X86::TCRETURNmi64;
 847     // Tail call return: adjust the stack pointer and jump to callee.
 848     MBBI = MBB.getLastNonDebugInstr();
 849     MachineOperand &JumpTarget = MBBI->getOperand(0);
 850     MachineOperand &StackAdjust = MBBI->getOperand(isMem ? 5 : 1);
 851     assert(StackAdjust.isImm() && "Expecting immediate value.");
 852
 853     // Adjust stack pointer.
 854     int StackAdj = StackAdjust.getImm();
 855     int MaxTCDelta = X86FI->getTCReturnAddrDelta();
 856     int Offset = 0;
 857     assert(MaxTCDelta <= 0 && "MaxTCDelta should never be positive");
 858
 859     // Incoporate the retaddr area.
 860     Offset = StackAdj-MaxTCDelta;
 861     assert(Offset >= 0 && "Offset should never be negative");
 862
 863     if (Offset) {
 864       // Check for possible merge with preceding ADD instruction.
 865       Offset += mergeSPUpdates(MBB, MBBI, StackPtr, true);
 866       emitSPUpdate(MBB, MBBI, StackPtr, Offset, Is64Bit, IsLP64,
 867                    UseLEA, TII, *RegInfo);
 868     }
 869
 870     // Jump to label or value in register.
 871     if (RetOpcode == X86::TCRETURNdi || RetOpcode == X86::TCRETURNdi64) {
 872       MachineInstrBuilder MIB =
 873         BuildMI(MBB, MBBI, DL, TII.get((RetOpcode == X86::TCRETURNdi)
 874                                        ? X86::TAILJMPd : X86::TAILJMPd64));
 875       if (JumpTarget.isGlobal())
 876         MIB.addGlobalAddress(JumpTarget.getGlobal(), JumpTarget.getOffset(),
 877                              JumpTarget.getTargetFlags());
 878       else {
 879         assert(JumpTarget.isSymbol());
 880         MIB.addExternalSymbol(JumpTarget.getSymbolName(),
 881                               JumpTarget.getTargetFlags());
 882       }
 883     } else if (RetOpcode == X86::TCRETURNmi || RetOpcode == X86::TCRETURNmi64) {
 884       MachineInstrBuilder MIB =
 885         BuildMI(MBB, MBBI, DL, TII.get((RetOpcode == X86::TCRETURNmi)
 886                                        ? X86::TAILJMPm : X86::TAILJMPm64));
 887       for (unsigned i = 0; i != 5; ++i)
 888         MIB.addOperand(MBBI->getOperand(i));
 889     } else if (RetOpcode == X86::TCRETURNri64) {
 890       BuildMI(MBB, MBBI, DL, TII.get(X86::TAILJMPr64)).
 891         addReg(JumpTarget.getReg(), RegState::Kill);
 892     } else {
 893       BuildMI(MBB, MBBI, DL, TII.get(X86::TAILJMPr)).
 894         addReg(JumpTarget.getReg(), RegState::Kill);
 895     }
 896
 897     MachineInstr *NewMI = std::prev(MBBI);
 898     NewMI->copyImplicitOps(MF, MBBI);
 899
 900     // Delete the pseudo instruction TCRETURN.
 901     MBB.erase(MBBI);
 902   } else if ((RetOpcode == X86::RETQ || RetOpcode == X86::RETL ||
 903               RetOpcode == X86::RETIQ || RetOpcode == X86::RETIL) &&
 904              (X86FI->getTCReturnAddrDelta() < 0)) {
 905     // Add the return addr area delta back since we are not tail calling.
 906     int delta = -1*X86FI->getTCReturnAddrDelta();
 907     MBBI = MBB.getLastNonDebugInstr();
 908
 909     // Check for possible merge with preceding ADD instruction.
 910     delta += mergeSPUpdates(MBB, MBBI, StackPtr, true);
 911     emitSPUpdate(MBB, MBBI, StackPtr, delta, Is64Bit, IsLP64, UseLEA, TII,
 912                  *RegInfo);
 913   }
 914 }
 915
 916 int X86FrameLowering::getFrameIndexOffset(const MachineFunction &MF,
 917                                           int FI) const {
 918   const X86RegisterInfo *RegInfo =
 919     static_cast<const X86RegisterInfo*>(MF.getTarget().getRegisterInfo());
 920   const MachineFrameInfo *MFI = MF.getFrameInfo();
 921   int Offset = MFI->getObjectOffset(FI) - getOffsetOfLocalArea();
 922   uint64_t StackSize = MFI->getStackSize();
 923
 924   if (RegInfo->hasBasePointer(MF)) {
 925     assert (hasFP(MF) && "VLAs and dynamic stack realign, but no FP?!");
 926     if (FI < 0) {
 927       // Skip the saved EBP.
 928       return Offset + RegInfo->getSlotSize();
 929     } else {
 930       assert((-(Offset + StackSize)) % MFI->getObjectAlignment(FI) == 0);
 931       return Offset + StackSize;
 932     }
 933   } else if (RegInfo->needsStackRealignment(MF)) {
 934     if (FI < 0) {
 935       // Skip the saved EBP.
 936       return Offset + RegInfo->getSlotSize();
 937     } else {
 938       assert((-(Offset + StackSize)) % MFI->getObjectAlignment(FI) == 0);
 939       return Offset + StackSize;
 940     }
 941     // FIXME: Support tail calls
 942   } else {
 943     if (!hasFP(MF))
 944       return Offset + StackSize;
 945
 946     // Skip the saved EBP.
 947     Offset += RegInfo->getSlotSize();
 948
 949     // Skip the RETADDR move area
 950     const X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
 951     int TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
 952     if (TailCallReturnAddrDelta < 0)
 953       Offset -= TailCallReturnAddrDelta;
 954   }
 955
 956   return Offset;
 957 }
 958
 959 int X86FrameLowering::getFrameIndexReference(const MachineFunction &MF, int FI,
 960                                              unsigned &FrameReg) const {
 961   const X86RegisterInfo *RegInfo =
 962       static_cast<const X86RegisterInfo*>(MF.getTarget().getRegisterInfo());
 963   // We can't calculate offset from frame pointer if the stack is realigned,
 964   // so enforce usage of stack/base pointer.  The base pointer is used when we
 965   // have dynamic allocas in addition to dynamic realignment.
 966   if (RegInfo->hasBasePointer(MF))
 967     FrameReg = RegInfo->getBaseRegister();
 968   else if (RegInfo->needsStackRealignment(MF))
 969     FrameReg = RegInfo->getStackRegister();
 970   else
 971     FrameReg = RegInfo->getFrameRegister(MF);
 972   return getFrameIndexOffset(MF, FI);
 973 }
 974
 975 bool X86FrameLowering::spillCalleeSavedRegisters(MachineBasicBlock &MBB,
 976                                              MachineBasicBlock::iterator MI,
 977                                         const std::vector<CalleeSavedInfo> &CSI,
 978                                           const TargetRegisterInfo *TRI) const {
 979   if (CSI.empty())
 980     return false;
 981
 982   DebugLoc DL = MBB.findDebugLoc(MI);
 983
 984   MachineFunction &MF = *MBB.getParent();
 985
 986   unsigned SlotSize = STI.is64Bit() ? 8 : 4;
 987   unsigned FPReg = TRI->getFrameRegister(MF);
 988   unsigned CalleeFrameSize = 0;
 989
 990   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 991   X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
 992
 993   // Push GPRs. It increases frame size.
 994   unsigned Opc = STI.is64Bit() ? X86::PUSH64r : X86::PUSH32r;
 995   for (unsigned i = CSI.size(); i != 0; --i) {
 996     unsigned Reg = CSI[i-1].getReg();
 997     if (!X86::GR64RegClass.contains(Reg) &&
 998         !X86::GR32RegClass.contains(Reg))
 999       continue;
1000     // Add the callee-saved register as live-in. It's killed at the spill.
1001     MBB.addLiveIn(Reg);
1002     if (Reg == FPReg)
1003       // X86RegisterInfo::emitPrologue will handle spilling of frame register.
1004       continue;
1005     CalleeFrameSize += SlotSize;
1006     BuildMI(MBB, MI, DL, TII.get(Opc)).addReg(Reg, RegState::Kill)
1007       .setMIFlag(MachineInstr::FrameSetup);
1008   }
1009
1010   X86FI->setCalleeSavedFrameSize(CalleeFrameSize);
1011
1012   // Make XMM regs spilled. X86 does not have ability of push/pop XMM.
1013   // It can be done by spilling XMMs to stack frame.
1014   // Note that only Win64 ABI might spill XMMs.
1015   for (unsigned i = CSI.size(); i != 0; --i) {
1016     unsigned Reg = CSI[i-1].getReg();
1017     if (X86::GR64RegClass.contains(Reg) ||
1018         X86::GR32RegClass.contains(Reg))
1019       continue;
1020     // Add the callee-saved register as live-in. It's killed at the spill.
1021     MBB.addLiveIn(Reg);
1022     const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
1023     TII.storeRegToStackSlot(MBB, MI, Reg, true, CSI[i-1].getFrameIdx(),
1024                             RC, TRI);
1025   }
1026
1027   return true;
1028 }
1029
1030 bool X86FrameLowering::restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
1031                                                MachineBasicBlock::iterator MI,
1032                                         const std::vector<CalleeSavedInfo> &CSI,
1033                                           const TargetRegisterInfo *TRI) const {
1034   if (CSI.empty())
1035     return false;
1036
1037   DebugLoc DL = MBB.findDebugLoc(MI);
1038
1039   MachineFunction &MF = *MBB.getParent();
1040   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
1041
1042   // Reload XMMs from stack frame.
1043   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1044     unsigned Reg = CSI[i].getReg();
1045     if (X86::GR64RegClass.contains(Reg) ||
1046         X86::GR32RegClass.contains(Reg))
1047       continue;
1048     const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
1049     TII.loadRegFromStackSlot(MBB, MI, Reg, CSI[i].getFrameIdx(),
1050                              RC, TRI);
1051   }
1052
1053   // POP GPRs.
1054   unsigned FPReg = TRI->getFrameRegister(MF);
1055   unsigned Opc = STI.is64Bit() ? X86::POP64r : X86::POP32r;
1056   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1057     unsigned Reg = CSI[i].getReg();
1058     if (!X86::GR64RegClass.contains(Reg) &&
1059         !X86::GR32RegClass.contains(Reg))
1060       continue;
1061     if (Reg == FPReg)
1062       // X86RegisterInfo::emitEpilogue will handle restoring of frame register.
1063       continue;
1064     BuildMI(MBB, MI, DL, TII.get(Opc), Reg);
1065   }
1066   return true;
1067 }
1068
1069 void
1070 X86FrameLowering::processFunctionBeforeCalleeSavedScan(MachineFunction &MF,
1071                                                        RegScavenger *RS) const {
1072   MachineFrameInfo *MFI = MF.getFrameInfo();
1073   const X86RegisterInfo *RegInfo =
1074       static_cast<const X86RegisterInfo *>(MF.getTarget().getRegisterInfo());
1075   unsigned SlotSize = RegInfo->getSlotSize();
1076
1077   X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1078   int64_t TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
1079
1080   if (TailCallReturnAddrDelta < 0) {
1081     // create RETURNADDR area
1082     //   arg
1083     //   arg
1084     //   RETADDR
1085     //   { ...
1086     //     RETADDR area
1087     //     ...
1088     //   }
1089     //   [EBP]
1090     MFI->CreateFixedObject(-TailCallReturnAddrDelta,
1091                            TailCallReturnAddrDelta - SlotSize, true);
1092   }
1093
1094   if (hasFP(MF)) {
1095     assert((TailCallReturnAddrDelta <= 0) &&
1096            "The Delta should always be zero or negative");
1097     const TargetFrameLowering &TFI = *MF.getTarget().getFrameLowering();
1098
1099     // Create a frame entry for the EBP register that must be saved.
1100     int FrameIdx = MFI->CreateFixedObject(SlotSize,
1101                                           -(int)SlotSize +
1102                                           TFI.getOffsetOfLocalArea() +
1103                                           TailCallReturnAddrDelta,
1104                                           true);
1105     assert(FrameIdx == MFI->getObjectIndexBegin() &&
1106            "Slot for EBP register must be last in order to be found!");
1107     (void)FrameIdx;
1108   }
1109
1110   // Spill the BasePtr if it's used.
1111   if (RegInfo->hasBasePointer(MF))
1112     MF.getRegInfo().setPhysRegUsed(RegInfo->getBaseRegister());
1113 }
1114
1115 static bool
1116 HasNestArgument(const MachineFunction *MF) {
1117   const Function *F = MF->getFunction();
1118   for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1119        I != E; I++) {
1120     if (I->hasNestAttr())
1121       return true;
1122   }
1123   return false;
1124 }
1125
1126 /// GetScratchRegister - Get a temp register for performing work in the
1127 /// segmented stack and the Erlang/HiPE stack prologue. Depending on platform
1128 /// and the properties of the function either one or two registers will be
1129 /// needed. Set primary to true for the first register, false for the second.
1130 static unsigned
1131 GetScratchRegister(bool Is64Bit, const MachineFunction &MF, bool Primary) {
1132   CallingConv::ID CallingConvention = MF.getFunction()->getCallingConv();
1133
1134   // Erlang stuff.
1135   if (CallingConvention == CallingConv::HiPE) {
1136     if (Is64Bit)
1137       return Primary ? X86::R14 : X86::R13;
1138     else
1139       return Primary ? X86::EBX : X86::EDI;
1140   }
1141
1142   if (Is64Bit)
1143     return Primary ? X86::R11 : X86::R12;
1144
1145   bool IsNested = HasNestArgument(&MF);
1146
1147   if (CallingConvention == CallingConv::X86_FastCall ||
1148       CallingConvention == CallingConv::Fast) {
1149     if (IsNested)
1150       report_fatal_error("Segmented stacks does not support fastcall with "
1151                          "nested function.");
1152     return Primary ? X86::EAX : X86::ECX;
1153   }
1154   if (IsNested)
1155     return Primary ? X86::EDX : X86::EAX;
1156   return Primary ? X86::ECX : X86::EAX;
1157 }
1158
1159 // The stack limit in the TCB is set to this many bytes above the actual stack
1160 // limit.
1161 static const uint64_t kSplitStackAvailable = 256;
1162
1163 void
1164 X86FrameLowering::adjustForSegmentedStacks(MachineFunction &MF) const {
1165   MachineBasicBlock &prologueMBB = MF.front();
1166   MachineFrameInfo *MFI = MF.getFrameInfo();
1167   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
1168   uint64_t StackSize;
1169   bool Is64Bit = STI.is64Bit();
1170   unsigned TlsReg, TlsOffset;
1171   DebugLoc DL;
1172
1173   unsigned ScratchReg = GetScratchRegister(Is64Bit, MF, true);
1174   assert(!MF.getRegInfo().isLiveIn(ScratchReg) &&
1175          "Scratch register is live-in");
1176
1177   if (MF.getFunction()->isVarArg())
1178     report_fatal_error("Segmented stacks do not support vararg functions.");
1179   if (!STI.isTargetLinux() && !STI.isTargetDarwin() &&
1180       !STI.isTargetWin32() && !STI.isTargetWin64() && !STI.isTargetFreeBSD())
1181     report_fatal_error("Segmented stacks not supported on this platform.");
1182
1183   // Eventually StackSize will be calculated by a link-time pass; which will
1184   // also decide whether checking code needs to be injected into this particular
1185   // prologue.
1186   StackSize = MFI->getStackSize();
1187
1188   // Do not generate a prologue for functions with a stack of size zero
1189   if (StackSize == 0)
1190     return;
1191
1192   MachineBasicBlock *allocMBB = MF.CreateMachineBasicBlock();
1193   MachineBasicBlock *checkMBB = MF.CreateMachineBasicBlock();
1194   X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1195   bool IsNested = false;
1196
1197   // We need to know if the function has a nest argument only in 64 bit mode.
1198   if (Is64Bit)
1199     IsNested = HasNestArgument(&MF);
1200
1201   // The MOV R10, RAX needs to be in a different block, since the RET we emit in
1202   // allocMBB needs to be last (terminating) instruction.
1203
1204   for (MachineBasicBlock::livein_iterator i = prologueMBB.livein_begin(),
1205          e = prologueMBB.livein_end(); i != e; i++) {
1206     allocMBB->addLiveIn(*i);
1207     checkMBB->addLiveIn(*i);
1208   }
1209
1210   if (IsNested)
1211     allocMBB->addLiveIn(X86::R10);
1212
1213   MF.push_front(allocMBB);
1214   MF.push_front(checkMBB);
1215
1216   // When the frame size is less than 256 we just compare the stack
1217   // boundary directly to the value of the stack pointer, per gcc.
1218   bool CompareStackPointer = StackSize < kSplitStackAvailable;
1219
1220   // Read the limit off the current stacklet off the stack_guard location.
1221   if (Is64Bit) {
1222     if (STI.isTargetLinux()) {
1223       TlsReg = X86::FS;
1224       TlsOffset = 0x70;
1225     } else if (STI.isTargetDarwin()) {
1226       TlsReg = X86::GS;
1227       TlsOffset = 0x60 + 90*8; // See pthread_machdep.h. Steal TLS slot 90.
1228     } else if (STI.isTargetWin64()) {
1229       TlsReg = X86::GS;
1230       TlsOffset = 0x28; // pvArbitrary, reserved for application use
1231     } else if (STI.isTargetFreeBSD()) {
1232       TlsReg = X86::FS;
1233       TlsOffset = 0x18;
1234     } else {
1235       report_fatal_error("Segmented stacks not supported on this platform.");
1236     }
1237
1238     if (CompareStackPointer)
1239       ScratchReg = X86::RSP;
1240     else
1241       BuildMI(checkMBB, DL, TII.get(X86::LEA64r), ScratchReg).addReg(X86::RSP)
1242         .addImm(1).addReg(0).addImm(-StackSize).addReg(0);
1243
1244     BuildMI(checkMBB, DL, TII.get(X86::CMP64rm)).addReg(ScratchReg)
1245       .addReg(0).addImm(1).addReg(0).addImm(TlsOffset).addReg(TlsReg);
1246   } else {
1247     if (STI.isTargetLinux()) {
1248       TlsReg = X86::GS;
1249       TlsOffset = 0x30;
1250     } else if (STI.isTargetDarwin()) {
1251       TlsReg = X86::GS;
1252       TlsOffset = 0x48 + 90*4;
1253     } else if (STI.isTargetWin32()) {
1254       TlsReg = X86::FS;
1255       TlsOffset = 0x14; // pvArbitrary, reserved for application use
1256     } else if (STI.isTargetFreeBSD()) {
1257       report_fatal_error("Segmented stacks not supported on FreeBSD i386.");
1258     } else {
1259       report_fatal_error("Segmented stacks not supported on this platform.");
1260     }
1261
1262     if (CompareStackPointer)
1263       ScratchReg = X86::ESP;
1264     else
1265       BuildMI(checkMBB, DL, TII.get(X86::LEA32r), ScratchReg).addReg(X86::ESP)
1266         .addImm(1).addReg(0).addImm(-StackSize).addReg(0);
1267
1268     if (STI.isTargetLinux() || STI.isTargetWin32() || STI.isTargetWin64()) {
1269       BuildMI(checkMBB, DL, TII.get(X86::CMP32rm)).addReg(ScratchReg)
1270         .addReg(0).addImm(0).addReg(0).addImm(TlsOffset).addReg(TlsReg);
1271     } else if (STI.isTargetDarwin()) {
1272
1273       // TlsOffset doesn't fit into a mod r/m byte so we need an extra register.
1274       unsigned ScratchReg2;
1275       bool SaveScratch2;
1276       if (CompareStackPointer) {
1277         // The primary scratch register is available for holding the TLS offset.
1278         ScratchReg2 = GetScratchRegister(Is64Bit, MF, true);
1279         SaveScratch2 = false;
1280       } else {
1281         // Need to use a second register to hold the TLS offset
1282         ScratchReg2 = GetScratchRegister(Is64Bit, MF, false);
1283
1284         // Unfortunately, with fastcc the second scratch register may hold an
1285         // argument.
1286         SaveScratch2 = MF.getRegInfo().isLiveIn(ScratchReg2);
1287       }
1288
1289       // If Scratch2 is live-in then it needs to be saved.
1290       assert((!MF.getRegInfo().isLiveIn(ScratchReg2) || SaveScratch2) &&
1291              "Scratch register is live-in and not saved");
1292
1293       if (SaveScratch2)
1294         BuildMI(checkMBB, DL, TII.get(X86::PUSH32r))
1295           .addReg(ScratchReg2, RegState::Kill);
1296
1297       BuildMI(checkMBB, DL, TII.get(X86::MOV32ri), ScratchReg2)
1298         .addImm(TlsOffset);
1299       BuildMI(checkMBB, DL, TII.get(X86::CMP32rm))
1300         .addReg(ScratchReg)
1301         .addReg(ScratchReg2).addImm(1).addReg(0)
1302         .addImm(0)
1303         .addReg(TlsReg);
1304
1305       if (SaveScratch2)
1306         BuildMI(checkMBB, DL, TII.get(X86::POP32r), ScratchReg2);
1307     }
1308   }
1309
1310   // This jump is taken if SP >= (Stacklet Limit + Stack Space required).
1311   // It jumps to normal execution of the function body.
1312   BuildMI(checkMBB, DL, TII.get(X86::JA_4)).addMBB(&prologueMBB);
1313
1314   // On 32 bit we first push the arguments size and then the frame size. On 64
1315   // bit, we pass the stack frame size in r10 and the argument size in r11.
1316   if (Is64Bit) {
1317     // Functions with nested arguments use R10, so it needs to be saved across
1318     // the call to _morestack
1319
1320     if (IsNested)
1321       BuildMI(allocMBB, DL, TII.get(X86::MOV64rr), X86::RAX).addReg(X86::R10);
1322
1323     BuildMI(allocMBB, DL, TII.get(X86::MOV64ri), X86::R10)
1324       .addImm(StackSize);
1325     BuildMI(allocMBB, DL, TII.get(X86::MOV64ri), X86::R11)
1326       .addImm(X86FI->getArgumentStackSize());
1327     MF.getRegInfo().setPhysRegUsed(X86::R10);
1328     MF.getRegInfo().setPhysRegUsed(X86::R11);
1329   } else {
1330     BuildMI(allocMBB, DL, TII.get(X86::PUSHi32))
1331       .addImm(X86FI->getArgumentStackSize());
1332     BuildMI(allocMBB, DL, TII.get(X86::PUSHi32))
1333       .addImm(StackSize);
1334   }
1335
1336   // __morestack is in libgcc
1337   if (Is64Bit)
1338     BuildMI(allocMBB, DL, TII.get(X86::CALL64pcrel32))
1339       .addExternalSymbol("__morestack");
1340   else
1341     BuildMI(allocMBB, DL, TII.get(X86::CALLpcrel32))
1342       .addExternalSymbol("__morestack");
1343
1344   if (IsNested)
1345     BuildMI(allocMBB, DL, TII.get(X86::MORESTACK_RET_RESTORE_R10));
1346   else
1347     BuildMI(allocMBB, DL, TII.get(X86::MORESTACK_RET));
1348
1349   allocMBB->addSuccessor(&prologueMBB);
1350
1351   checkMBB->addSuccessor(allocMBB);
1352   checkMBB->addSuccessor(&prologueMBB);
1353
1354 #ifdef XDEBUG
1355   MF.verify();
1356 #endif
1357 }
1358
1359 /// Erlang programs may need a special prologue to handle the stack size they
1360 /// might need at runtime. That is because Erlang/OTP does not implement a C
1361 /// stack but uses a custom implementation of hybrid stack/heap architecture.
1362 /// (for more information see Eric Stenman's Ph.D. thesis:
1363 /// http://publications.uu.se/uu/fulltext/nbn_se_uu_diva-2688.pdf)
1364 ///
1365 /// CheckStack:
1366 ///       temp0 = sp - MaxStack
1367 ///       if( temp0 < SP_LIMIT(P) ) goto IncStack else goto OldStart
1368 /// OldStart:
1369 ///       ...
1370 /// IncStack:
1371 ///       call inc_stack   # doubles the stack space
1372 ///       temp0 = sp - MaxStack
1373 ///       if( temp0 < SP_LIMIT(P) ) goto IncStack else goto OldStart
1374 void X86FrameLowering::adjustForHiPEPrologue(MachineFunction &MF) const {
1375   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
1376   MachineFrameInfo *MFI = MF.getFrameInfo();
1377   const unsigned SlotSize =
1378       static_cast<const X86RegisterInfo *>(MF.getTarget().getRegisterInfo())
1379           ->getSlotSize();
1380   const bool Is64Bit = STI.is64Bit();
1381   DebugLoc DL;
1382   // HiPE-specific values
1383   const unsigned HipeLeafWords = 24;
1384   const unsigned CCRegisteredArgs = Is64Bit ? 6 : 5;
1385   const unsigned Guaranteed = HipeLeafWords * SlotSize;
1386   unsigned CallerStkArity = MF.getFunction()->arg_size() > CCRegisteredArgs ?
1387                             MF.getFunction()->arg_size() - CCRegisteredArgs : 0;
1388   unsigned MaxStack = MFI->getStackSize() + CallerStkArity*SlotSize + SlotSize;
1389
1390   assert(STI.isTargetLinux() &&
1391          "HiPE prologue is only supported on Linux operating systems.");
1392
1393   // Compute the largest caller's frame that is needed to fit the callees'
1394   // frames. This 'MaxStack' is computed from:
1395   //
1396   // a) the fixed frame size, which is the space needed for all spilled temps,
1397   // b) outgoing on-stack parameter areas, and
1398   // c) the minimum stack space this function needs to make available for the
1399   //    functions it calls (a tunable ABI property).
1400   if (MFI->hasCalls()) {
1401     unsigned MoreStackForCalls = 0;
1402
1403     for (MachineFunction::iterator MBBI = MF.begin(), MBBE = MF.end();
1404          MBBI != MBBE; ++MBBI)
1405       for (MachineBasicBlock::iterator MI = MBBI->begin(), ME = MBBI->end();
1406            MI != ME; ++MI) {
1407         if (!MI->isCall())
1408           continue;
1409
1410         // Get callee operand.
1411         const MachineOperand &MO = MI->getOperand(0);
1412
1413         // Only take account of global function calls (no closures etc.).
1414         if (!MO.isGlobal())
1415           continue;
1416
1417         const Function *F = dyn_cast<Function>(MO.getGlobal());
1418         if (!F)
1419           continue;
1420
1421         // Do not update 'MaxStack' for primitive and built-in functions
1422         // (encoded with names either starting with "erlang."/"bif_" or not
1423         // having a ".", such as a simple <Module>.<Function>.<Arity>, or an
1424         // "_", such as the BIF "suspend_0") as they are executed on another
1425         // stack.
1426         if (F->getName().find("erlang.") != StringRef::npos ||
1427             F->getName().find("bif_") != StringRef::npos ||
1428             F->getName().find_first_of("._") == StringRef::npos)
1429           continue;
1430
1431         unsigned CalleeStkArity =
1432           F->arg_size() > CCRegisteredArgs ? F->arg_size()-CCRegisteredArgs : 0;
1433         if (HipeLeafWords - 1 > CalleeStkArity)
1434           MoreStackForCalls = std::max(MoreStackForCalls,
1435                                (HipeLeafWords - 1 - CalleeStkArity) * SlotSize);
1436       }
1437     MaxStack += MoreStackForCalls;
1438   }
1439
1440   // If the stack frame needed is larger than the guaranteed then runtime checks
1441   // and calls to "inc_stack_0" BIF should be inserted in the assembly prologue.
1442   if (MaxStack > Guaranteed) {
1443     MachineBasicBlock &prologueMBB = MF.front();
1444     MachineBasicBlock *stackCheckMBB = MF.CreateMachineBasicBlock();
1445     MachineBasicBlock *incStackMBB = MF.CreateMachineBasicBlock();
1446
1447     for (MachineBasicBlock::livein_iterator I = prologueMBB.livein_begin(),
1448            E = prologueMBB.livein_end(); I != E; I++) {
1449       stackCheckMBB->addLiveIn(*I);
1450       incStackMBB->addLiveIn(*I);
1451     }
1452
1453     MF.push_front(incStackMBB);
1454     MF.push_front(stackCheckMBB);
1455
1456     unsigned ScratchReg, SPReg, PReg, SPLimitOffset;
1457     unsigned LEAop, CMPop, CALLop;
1458     if (Is64Bit) {
1459       SPReg = X86::RSP;
1460       PReg  = X86::RBP;
1461       LEAop = X86::LEA64r;
1462       CMPop = X86::CMP64rm;
1463       CALLop = X86::CALL64pcrel32;
1464       SPLimitOffset = 0x90;
1465     } else {
1466       SPReg = X86::ESP;
1467       PReg  = X86::EBP;
1468       LEAop = X86::LEA32r;
1469       CMPop = X86::CMP32rm;
1470       CALLop = X86::CALLpcrel32;
1471       SPLimitOffset = 0x4c;
1472     }
1473
1474     ScratchReg = GetScratchRegister(Is64Bit, MF, true);
1475     assert(!MF.getRegInfo().isLiveIn(ScratchReg) &&
1476            "HiPE prologue scratch register is live-in");
1477
1478     // Create new MBB for StackCheck:
1479     addRegOffset(BuildMI(stackCheckMBB, DL, TII.get(LEAop), ScratchReg),
1480                  SPReg, false, -MaxStack);
1481     // SPLimitOffset is in a fixed heap location (pointed by BP).
1482     addRegOffset(BuildMI(stackCheckMBB, DL, TII.get(CMPop))
1483                  .addReg(ScratchReg), PReg, false, SPLimitOffset);
1484     BuildMI(stackCheckMBB, DL, TII.get(X86::JAE_4)).addMBB(&prologueMBB);
1485
1486     // Create new MBB for IncStack:
1487     BuildMI(incStackMBB, DL, TII.get(CALLop)).
1488       addExternalSymbol("inc_stack_0");
1489     addRegOffset(BuildMI(incStackMBB, DL, TII.get(LEAop), ScratchReg),
1490                  SPReg, false, -MaxStack);
1491     addRegOffset(BuildMI(incStackMBB, DL, TII.get(CMPop))
1492                  .addReg(ScratchReg), PReg, false, SPLimitOffset);
1493     BuildMI(incStackMBB, DL, TII.get(X86::JLE_4)).addMBB(incStackMBB);
1494
1495     stackCheckMBB->addSuccessor(&prologueMBB, 99);
1496     stackCheckMBB->addSuccessor(incStackMBB, 1);
1497     incStackMBB->addSuccessor(&prologueMBB, 99);
1498     incStackMBB->addSuccessor(incStackMBB, 1);
1499   }
1500 #ifdef XDEBUG
1501   MF.verify();
1502 #endif
1503 }
1504
1505 void X86FrameLowering::
1506 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
1507                               MachineBasicBlock::iterator I) const {
1508   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
1509   const X86RegisterInfo &RegInfo =
1510       *static_cast<const X86RegisterInfo *>(MF.getTarget().getRegisterInfo());
1511   unsigned StackPtr = RegInfo.getStackRegister();
1512   bool reseveCallFrame = hasReservedCallFrame(MF);
1513   int Opcode = I->getOpcode();
1514   bool isDestroy = Opcode == TII.getCallFrameDestroyOpcode();
1515   bool IsLP64 = STI.isTarget64BitLP64();
1516   DebugLoc DL = I->getDebugLoc();
1517   uint64_t Amount = !reseveCallFrame ? I->getOperand(0).getImm() : 0;
1518   uint64_t CalleeAmt = isDestroy ? I->getOperand(1).getImm() : 0;
1519   I = MBB.erase(I);
1520
1521   if (!reseveCallFrame) {
1522     // If the stack pointer can be changed after prologue, turn the
1523     // adjcallstackup instruction into a 'sub ESP, <amt>' and the
1524     // adjcallstackdown instruction into 'add ESP, <amt>'
1525     // TODO: consider using push / pop instead of sub + store / add
1526     if (Amount == 0)
1527       return;
1528
1529     // We need to keep the stack aligned properly.  To do this, we round the
1530     // amount of space needed for the outgoing arguments up to the next
1531     // alignment boundary.
1532     unsigned StackAlign = MF.getTarget().getFrameLowering()->getStackAlignment();
1533     Amount = (Amount + StackAlign - 1) / StackAlign * StackAlign;
1534
1535     MachineInstr *New = nullptr;
1536     if (Opcode == TII.getCallFrameSetupOpcode()) {
1537       New = BuildMI(MF, DL, TII.get(getSUBriOpcode(IsLP64, Amount)),
1538                     StackPtr)
1539         .addReg(StackPtr)
1540         .addImm(Amount);
1541     } else {
1542       assert(Opcode == TII.getCallFrameDestroyOpcode());
1543
1544       // Factor out the amount the callee already popped.
1545       Amount -= CalleeAmt;
1546
1547       if (Amount) {
1548         unsigned Opc = getADDriOpcode(IsLP64, Amount);
1549         New = BuildMI(MF, DL, TII.get(Opc), StackPtr)
1550           .addReg(StackPtr).addImm(Amount);
1551       }
1552     }
1553
1554     if (New) {
1555       // The EFLAGS implicit def is dead.
1556       New->getOperand(3).setIsDead();
1557
1558       // Replace the pseudo instruction with a new instruction.
1559       MBB.insert(I, New);
1560     }
1561
1562     return;
1563   }
1564
1565   if (Opcode == TII.getCallFrameDestroyOpcode() && CalleeAmt) {
1566     // If we are performing frame pointer elimination and if the callee pops
1567     // something off the stack pointer, add it back.  We do this until we have
1568     // more advanced stack pointer tracking ability.
1569     unsigned Opc = getSUBriOpcode(IsLP64, CalleeAmt);
1570     MachineInstr *New = BuildMI(MF, DL, TII.get(Opc), StackPtr)
1571       .addReg(StackPtr).addImm(CalleeAmt);
1572
1573     // The EFLAGS implicit def is dead.
1574     New->getOperand(3).setIsDead();
1575
1576     // We are not tracking the stack pointer adjustment by the callee, so make
1577     // sure we restore the stack pointer immediately after the call, there may
1578     // be spill code inserted between the CALL and ADJCALLSTACKUP instructions.
1579     MachineBasicBlock::iterator B = MBB.begin();
1580     while (I != B && !std::prev(I)->isCall())
1581       --I;
1582     MBB.insert(I, New);
1583   }
1584 }
1585