OSDN Git Service

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