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