blob: b9254d2ce3d0442109c68c8eb75d3bc1439be9e5 [file] [log] [blame]
Jia Liu31d157a2012-02-18 12:03:15 +00001//===-- X86FrameLowering.cpp - X86 Frame Information ----------------------===//
Anton Korobeynikov33464912010-11-15 00:06:54 +00002//
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//
Anton Korobeynikov16c29b52011-01-10 12:39:04 +000010// This file contains the X86 implementation of TargetFrameLowering class.
Anton Korobeynikov33464912010-11-15 00:06:54 +000011//
12//===----------------------------------------------------------------------===//
13
Anton Korobeynikov16c29b52011-01-10 12:39:04 +000014#include "X86FrameLowering.h"
Anton Korobeynikov33464912010-11-15 00:06:54 +000015#include "X86InstrBuilder.h"
16#include "X86InstrInfo.h"
17#include "X86MachineFunctionInfo.h"
Rafael Espindola76927d752011-08-30 19:39:58 +000018#include "X86Subtarget.h"
Anton Korobeynikovd9e33852010-11-18 23:25:52 +000019#include "X86TargetMachine.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000020#include "llvm/ADT/SmallSet.h"
Anton Korobeynikov33464912010-11-15 00:06:54 +000021#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"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000026#include "llvm/IR/DataLayout.h"
27#include "llvm/IR/Function.h"
Rafael Espindolaf0adba92011-04-15 15:11:06 +000028#include "llvm/MC/MCAsmInfo.h"
Bill Wendling6a6b8c32011-07-07 00:54:13 +000029#include "llvm/MC/MCSymbol.h"
Anton Korobeynikov33464912010-11-15 00:06:54 +000030#include "llvm/Support/CommandLine.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000031#include "llvm/Target/TargetOptions.h"
Anton Korobeynikov33464912010-11-15 00:06:54 +000032
33using namespace llvm;
34
35// FIXME: completely move here.
36extern cl::opt<bool> ForceStackAlign;
37
Anton Korobeynikov16c29b52011-01-10 12:39:04 +000038bool X86FrameLowering::hasReservedCallFrame(const MachineFunction &MF) const {
Anton Korobeynikovd0c38172010-11-18 21:19:35 +000039 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.
Anton Korobeynikov16c29b52011-01-10 12:39:04 +000045bool X86FrameLowering::hasFP(const MachineFunction &MF) const {
Anton Korobeynikovd0c38172010-11-18 21:19:35 +000046 const MachineFrameInfo *MFI = MF.getFrameInfo();
47 const MachineModuleInfo &MMI = MF.getMMI();
Chad Rosier3fb6eca2012-05-23 23:45:10 +000048 const TargetRegisterInfo *RegInfo = TM.getRegisterInfo();
Anton Korobeynikovd0c38172010-11-18 21:19:35 +000049
Nick Lewycky8a8d4792011-12-02 22:16:29 +000050 return (MF.getTarget().Options.DisableFramePointerElim(MF) ||
Chad Rosier3fb6eca2012-05-23 23:45:10 +000051 RegInfo->needsStackRealignment(MF) ||
Anton Korobeynikovd0c38172010-11-18 21:19:35 +000052 MFI->hasVarSizedObjects() ||
Chad Rosierb5660622013-02-16 01:25:28 +000053 MFI->isFrameAddressTaken() || MF.hasMSInlineAsm() ||
Anton Korobeynikovd0c38172010-11-18 21:19:35 +000054 MF.getInfo<X86MachineFunctionInfo>()->getForceFramePointer() ||
Jakob Stoklund Olesene208c492012-06-22 03:04:27 +000055 MMI.callsUnwindInit() || MMI.callsEHReturn());
Anton Korobeynikovd0c38172010-11-18 21:19:35 +000056}
57
Eli Bendersky700ed802013-02-21 20:05:00 +000058static unsigned getSUBriOpcode(unsigned IsLP64, int64_t Imm) {
59 if (IsLP64) {
Anton Korobeynikov33464912010-11-15 00:06:54 +000060 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
Eli Bendersky16221a62013-02-06 20:43:57 +000070static unsigned getADDriOpcode(unsigned IsLP64, int64_t Imm) {
71 if (IsLP64) {
Anton Korobeynikov33464912010-11-15 00:06:54 +000072 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
Eli Bendersky16221a62013-02-06 20:43:57 +000082static unsigned getLEArOpcode(unsigned IsLP64) {
83 return IsLP64 ? X86::LEA64r : X86::LEA32r;
Evan Chengde1df102012-02-07 22:50:41 +000084}
85
Evan Cheng7158e082011-01-03 22:53:22 +000086/// 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.
89static 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
Craig Toppere4fd9072012-03-04 10:43:23 +000098 static const uint16_t CallerSavedRegs32Bit[] = {
Andrew Trick32a183c2011-08-12 00:49:19 +000099 X86::EAX, X86::EDX, X86::ECX, 0
Evan Cheng7158e082011-01-03 22:53:22 +0000100 };
101
Craig Toppere4fd9072012-03-04 10:43:23 +0000102 static const uint16_t CallerSavedRegs64Bit[] = {
Evan Cheng7158e082011-01-03 22:53:22 +0000103 X86::RAX, X86::RDX, X86::RCX, X86::RSI, X86::RDI,
Andrew Trick32a183c2011-08-12 00:49:19 +0000104 X86::R8, X86::R9, X86::R10, X86::R11, 0
Evan Cheng7158e082011-01-03 22:53:22 +0000105 };
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: {
Craig Toppere4fd9072012-03-04 10:43:23 +0000120 SmallSet<uint16_t, 8> Uses;
Evan Cheng7158e082011-01-03 22:53:22 +0000121 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;
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +0000128 for (MCRegAliasIterator AI(Reg, &TRI, true); AI.isValid(); ++AI)
129 Uses.insert(*AI);
Evan Cheng7158e082011-01-03 22:53:22 +0000130 }
131
Craig Toppere4fd9072012-03-04 10:43:23 +0000132 const uint16_t *CS = Is64Bit ? CallerSavedRegs64Bit : CallerSavedRegs32Bit;
Evan Cheng7158e082011-01-03 22:53:22 +0000133 for (; *CS; ++CS)
134 if (!Uses.count(*CS))
135 return *CS;
136 }
137 }
138
139 return 0;
140}
141
142
Anton Korobeynikov33464912010-11-15 00:06:54 +0000143/// emitSPUpdate - Emit a series of instructions to increment / decrement the
144/// stack pointer by a constant value.
145static
146void emitSPUpdate(MachineBasicBlock &MBB, MachineBasicBlock::iterator &MBBI,
Evan Cheng7158e082011-01-03 22:53:22 +0000147 unsigned StackPtr, int64_t NumBytes,
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000148 bool Is64Bit, bool IsLP64, bool UseLEA,
Eric Christopher76ad43c2012-10-03 08:10:01 +0000149 const TargetInstrInfo &TII, const TargetRegisterInfo &TRI) {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000150 bool isSub = NumBytes < 0;
151 uint64_t Offset = isSub ? -NumBytes : NumBytes;
Evan Chengde1df102012-02-07 22:50:41 +0000152 unsigned Opc;
153 if (UseLEA)
Eli Bendersky16221a62013-02-06 20:43:57 +0000154 Opc = getLEArOpcode(IsLP64);
Evan Chengde1df102012-02-07 22:50:41 +0000155 else
156 Opc = isSub
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000157 ? getSUBriOpcode(IsLP64, Offset)
158 : getADDriOpcode(IsLP64, Offset);
Evan Chengde1df102012-02-07 22:50:41 +0000159
Anton Korobeynikov33464912010-11-15 00:06:54 +0000160 uint64_t Chunk = (1LL << 31) - 1;
Eric Christopher76ad43c2012-10-03 08:10:01 +0000161 DebugLoc DL = MBB.findDebugLoc(MBBI);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000162
163 while (Offset) {
164 uint64_t ThisVal = (Offset > Chunk) ? Chunk : Offset;
Evan Cheng7158e082011-01-03 22:53:22 +0000165 if (ThisVal == (Is64Bit ? 8 : 4)) {
166 // Use push / pop instead.
167 unsigned Reg = isSub
Dale Johannesen1e08cd12011-01-04 19:31:24 +0000168 ? (unsigned)(Is64Bit ? X86::RAX : X86::EAX)
Evan Cheng7158e082011-01-03 22:53:22 +0000169 : findDeadCallerSavedReg(MBB, MBBI, TRI, Is64Bit);
170 if (Reg) {
171 Opc = isSub
172 ? (Is64Bit ? X86::PUSH64r : X86::PUSH32r)
173 : (Is64Bit ? X86::POP64r : X86::POP32r);
Charles Davisaff232a2011-06-12 01:45:54 +0000174 MachineInstr *MI = BuildMI(MBB, MBBI, DL, TII.get(Opc))
Evan Cheng7158e082011-01-03 22:53:22 +0000175 .addReg(Reg, getDefRegState(!isSub) | getUndefRegState(isSub));
Charles Davisaff232a2011-06-12 01:45:54 +0000176 if (isSub)
177 MI->setFlag(MachineInstr::FrameSetup);
Evan Cheng7158e082011-01-03 22:53:22 +0000178 Offset -= ThisVal;
179 continue;
180 }
181 }
182
Evan Chengde1df102012-02-07 22:50:41 +0000183 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
Charles Davisaff232a2011-06-12 01:45:54 +0000195 if (isSub)
196 MI->setFlag(MachineInstr::FrameSetup);
Evan Chengde1df102012-02-07 22:50:41 +0000197
Anton Korobeynikov33464912010-11-15 00:06:54 +0000198 Offset -= ThisVal;
199 }
200}
201
202/// mergeSPUpdatesUp - Merge two stack-manipulating instructions upper iterator.
203static
204void 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 ||
Evan Chengde1df102012-02-07 22:50:41 +0000211 Opc == X86::ADD32ri || Opc == X86::ADD32ri8 ||
212 Opc == X86::LEA32r || Opc == X86::LEA64_32r) &&
Anton Korobeynikov33464912010-11-15 00:06:54 +0000213 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.
227static
228void mergeSPUpdatesDown(MachineBasicBlock &MBB,
229 MachineBasicBlock::iterator &MBBI,
230 unsigned StackPtr, uint64_t *NumBytes = NULL) {
Sanjoy Dasfc926122011-12-01 19:15:08 +0000231 // FIXME: THIS ISN'T RUN!!!
Anton Korobeynikov33464912010-11-15 00:06:54 +0000232 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
Evan Chengde1df102012-02-07 22:50:41 +0000258/// 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
Anton Korobeynikov33464912010-11-15 00:06:54 +0000260/// SUB.
261static 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 ||
Evan Chengde1df102012-02-07 22:50:41 +0000275 Opc == X86::ADD32ri || Opc == X86::ADD32ri8 ||
276 Opc == X86::LEA32r || Opc == X86::LEA64_32r) &&
Anton Korobeynikov33464912010-11-15 00:06:54 +0000277 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
292static 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
Anton Korobeynikov16c29b52011-01-10 12:39:04 +0000305void X86FrameLowering::emitCalleeSavedFrameMoves(MachineFunction &MF,
Bill Wendling09b02c82011-07-25 18:00:28 +0000306 MCSymbol *Label,
307 unsigned FramePtr) const {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000308 MachineFrameInfo *MFI = MF.getFrameInfo();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000309 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
Michael Liaoaa3c2c02012-10-25 06:29:14 +0000315 const X86RegisterInfo *RegInfo = TM.getRegisterInfo();
Anton Korobeynikovd0c38172010-11-18 21:19:35 +0000316 bool HasFP = hasFP(MF);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000317
318 // Calculate amount of bytes used for return address storing.
Michael Liaoaa3c2c02012-10-25 06:29:14 +0000319 int stackGrowth = -RegInfo->getSlotSize();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000320
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
Chris Lattner7a2bdde2011-04-15 05:18:47 +0000324 // Determine maximum offset (minimum due to stack growth).
Anton Korobeynikov33464912010-11-15 00:06:54 +0000325 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.
NAKAMURA Takumi27635382011-02-05 15:10:54 +0000346 //
Anton Korobeynikov33464912010-11-15 00:06:54 +0000347 // 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);
Rafael Espindolad84ccfa2013-05-11 02:38:11 +0000364 MMI.addFrameMove(Label, CSDst, CSSrc);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000365 }
366}
367
Bill Wendling09b02c82011-07-25 18:00:28 +0000368/// getCompactUnwindRegNum - Get the compact unwind number for a given
369/// register. The number corresponds to the enum lists in
370/// compact_unwind_encoding.h.
Bill Wendling1f4b7962013-05-09 18:21:45 +0000371static 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;
Bill Wendling10e412e2011-12-14 23:53:24 +0000379 for (int Idx = 1; *CURegs; ++CURegs, ++Idx)
Bill Wendling09b02c82011-07-25 18:00:28 +0000380 if (*CURegs == Reg)
381 return Idx;
382
383 return -1;
384}
385
Bill Wendling57a3cd22011-12-06 21:23:42 +0000386// Number of registers that can be saved in a compact unwind encoding.
387#define CU_NUM_SAVED_REGS 6
388
Bill Wendling09b02c82011-07-25 18:00:28 +0000389/// 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.
Bill Wendling57a3cd22011-12-06 21:23:42 +0000392static uint32_t
393encodeCompactUnwindRegistersWithoutFrame(unsigned SavedRegs[CU_NUM_SAVED_REGS],
394 unsigned RegCount, bool Is64Bit) {
Bill Wendling09b02c82011-07-25 18:00:28 +0000395 // 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 //
Bill Wendling10e412e2011-12-14 23:53:24 +0000407 for (unsigned i = 0; i != CU_NUM_SAVED_REGS; ++i) {
Bill Wendling1f4b7962013-05-09 18:21:45 +0000408 int CUReg = getCompactUnwindRegNum(SavedRegs[i], Is64Bit);
Bill Wendling09b02c82011-07-25 18:00:28 +0000409 if (CUReg == -1) return ~0U;
410 SavedRegs[i] = CUReg;
Bill Wendling79df9862011-12-06 01:26:14 +0000411 }
Bill Wendling09b02c82011-07-25 18:00:28 +0000412
Bill Wendling10e412e2011-12-14 23:53:24 +0000413 // 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
Bill Wendling57a3cd22011-12-06 21:23:42 +0000418 uint32_t RenumRegs[CU_NUM_SAVED_REGS];
419 for (unsigned i = CU_NUM_SAVED_REGS - RegCount; i < CU_NUM_SAVED_REGS; ++i) {
Bill Wendling09b02c82011-07-25 18:00:28 +0000420 unsigned Countless = 0;
Bill Wendling57a3cd22011-12-06 21:23:42 +0000421 for (unsigned j = CU_NUM_SAVED_REGS - RegCount; j < i; ++j)
Bill Wendling09b02c82011-07-25 18:00:28 +0000422 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.
Bill Wendling57a3cd22011-12-06 21:23:42 +0000464static uint32_t
465encodeCompactUnwindRegistersWithFrame(unsigned SavedRegs[CU_NUM_SAVED_REGS],
466 bool Is64Bit) {
Bill Wendling09b02c82011-07-25 18:00:28 +0000467 // Encode the registers in the order they were saved, 3-bits per register. The
Bill Wendling86b1a7d2012-01-12 23:05:03 +0000468 // registers are numbered from 1 to CU_NUM_SAVED_REGS.
Bill Wendling09b02c82011-07-25 18:00:28 +0000469 uint32_t RegEnc = 0;
Bill Wendlingb4ee5162012-01-13 00:41:53 +0000470 for (int I = CU_NUM_SAVED_REGS - 1, Idx = 0; I != -1; --I) {
Bill Wendling09b02c82011-07-25 18:00:28 +0000471 unsigned Reg = SavedRegs[I];
Bill Wendling86b1a7d2012-01-12 23:05:03 +0000472 if (Reg == 0) continue;
473
Bill Wendling1f4b7962013-05-09 18:21:45 +0000474 int CURegNum = getCompactUnwindRegNum(Reg, Is64Bit);
Bill Wendling86b1a7d2012-01-12 23:05:03 +0000475 if (CURegNum == -1) return ~0U;
Bill Wendling80caf9c2011-12-06 01:57:48 +0000476
477 // Encode the 3-bit register number in order, skipping over 3-bits for each
478 // register.
Bill Wendling86b1a7d2012-01-12 23:05:03 +0000479 RegEnc |= (CURegNum & 0x7) << (Idx++ * 3);
Bill Wendling09b02c82011-07-25 18:00:28 +0000480 }
481
Jakob Stoklund Olesendec1f992012-01-11 09:08:04 +0000482 assert((RegEnc & 0x3FFFF) == RegEnc && "Invalid compact register encoding!");
Bill Wendling09b02c82011-07-25 18:00:28 +0000483 return RegEnc;
484}
485
486uint32_t X86FrameLowering::getCompactUnwindEncoding(MachineFunction &MF) const {
487 const X86RegisterInfo *RegInfo = TM.getRegisterInfo();
488 unsigned FramePtr = RegInfo->getFrameRegister(MF);
489 unsigned StackPtr = RegInfo->getStackRegister();
490
Bill Wendling09b02c82011-07-25 18:00:28 +0000491 bool Is64Bit = STI.is64Bit();
492 bool HasFP = hasFP(MF);
493
Bill Wendling57a3cd22011-12-06 21:23:42 +0000494 unsigned SavedRegs[CU_NUM_SAVED_REGS] = { 0, 0, 0, 0, 0, 0 };
Bill Wendling10e412e2011-12-14 23:53:24 +0000495 unsigned SavedRegIdx = 0;
Bill Wendling09b02c82011-07-25 18:00:28 +0000496
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);
Bill Wendling09b02c82011-07-25 18:00:28 +0000503 unsigned SubtractInstrIdx = (Is64Bit ? 3 : 2);
504
Bill Wendlingde770552011-07-26 08:03:49 +0000505 unsigned StackDivide = (Is64Bit ? 8 : 4);
506
Bill Wendling09b02c82011-07-25 18:00:28 +0000507 unsigned InstrOffset = 0;
Bill Wendling09b02c82011-07-25 18:00:28 +0000508 unsigned StackAdjust = 0;
Bill Wendling57a3cd22011-12-06 21:23:42 +0000509 unsigned StackSize = 0;
Bill Wendling09b02c82011-07-25 18:00:28 +0000510
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.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000521 if (ExpectEnd) return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000522
523 if (Opc == PushInstr) {
524 // If there are too many saved registers, we cannot use compact encoding.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000525 if (SavedRegIdx >= CU_NUM_SAVED_REGS) return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000526
Bill Wendlingedfef3b2013-05-09 20:10:38 +0000527 unsigned Reg = MI.getOperand(0).getReg();
528 if (Reg == (Is64Bit ? X86::RAX : X86::EAX)) {
529 ExpectEnd = true;
530 continue;
531 }
532
Bill Wendling10e412e2011-12-14 23:53:24 +0000533 SavedRegs[SavedRegIdx++] = MI.getOperand(0).getReg();
Bill Wendling57a3cd22011-12-06 21:23:42 +0000534 StackAdjust += OffsetSize;
Bill Wendling09b02c82011-07-25 18:00:28 +0000535 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)
Bill Wendling89ec1c52013-04-19 00:05:59 +0000541 return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000542
Bill Wendling57a3cd22011-12-06 21:23:42 +0000543 StackAdjust = 0;
Bill Wendling09b02c82011-07-25 18:00:28 +0000544 memset(SavedRegs, 0, sizeof(SavedRegs));
Bill Wendling10e412e2011-12-14 23:53:24 +0000545 SavedRegIdx = 0;
Bill Wendling09b02c82011-07-25 18:00:28 +0000546 InstrOffset += MoveInstrSize;
Bill Wendling84d518a2011-12-06 22:14:27 +0000547 } else if (Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
548 Opc == X86::SUB32ri || Opc == X86::SUB32ri8) {
Bill Wendling57a3cd22011-12-06 21:23:42 +0000549 if (StackSize)
550 // We already have a stack size.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000551 return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000552
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
Bill Wendling89ec1c52013-04-19 00:05:59 +0000559 return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000560
Bill Wendling57a3cd22011-12-06 21:23:42 +0000561 StackSize = MI.getOperand(2).getImm() / StackDivide;
Bill Wendling09b02c82011-07-25 18:00:28 +0000562 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;
Bill Wendling57a3cd22011-12-06 21:23:42 +0000569 StackAdjust /= StackDivide;
Bill Wendling09b02c82011-07-25 18:00:28 +0000570 if (HasFP) {
Bill Wendling57a3cd22011-12-06 21:23:42 +0000571 if ((StackAdjust & 0xFF) != StackAdjust)
Bill Wendling09b02c82011-07-25 18:00:28 +0000572 // Offset was too big for compact encoding.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000573 return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000574
575 // Get the encoding of the saved registers when we have a frame pointer.
576 uint32_t RegEnc = encodeCompactUnwindRegistersWithFrame(SavedRegs, Is64Bit);
Bill Wendling89ec1c52013-04-19 00:05:59 +0000577 if (RegEnc == ~0U) return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000578
Bill Wendling89ec1c52013-04-19 00:05:59 +0000579 CompactUnwindEncoding |= CU::UNWIND_MODE_BP_FRAME;
Bill Wendling57a3cd22011-12-06 21:23:42 +0000580 CompactUnwindEncoding |= (StackAdjust & 0xFF) << 16;
Bill Wendling89ec1c52013-04-19 00:05:59 +0000581 CompactUnwindEncoding |= RegEnc & CU::UNWIND_BP_FRAME_REGISTERS;
Bill Wendling09b02c82011-07-25 18:00:28 +0000582 } else {
Bill Wendlingb3ec3292011-12-07 07:58:55 +0000583 ++StackAdjust;
584 uint32_t TotalStackSize = StackAdjust + StackSize;
Bill Wendling581ac272011-12-06 21:34:01 +0000585 if ((TotalStackSize & 0xFF) == TotalStackSize) {
Bill Wendling5b2c4972011-12-06 19:16:17 +0000586 // Frameless stack with a small stack size.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000587 CompactUnwindEncoding |= CU::UNWIND_MODE_STACK_IMMD;
Bill Wendling5b2c4972011-12-06 19:16:17 +0000588
589 // Encode the stack size.
Bill Wendling581ac272011-12-06 21:34:01 +0000590 CompactUnwindEncoding |= (TotalStackSize & 0xFF) << 16;
Bill Wendling09b02c82011-07-25 18:00:28 +0000591 } else {
Bill Wendling57a3cd22011-12-06 21:23:42 +0000592 if ((StackAdjust & 0x7) != StackAdjust)
Bill Wendling09b02c82011-07-25 18:00:28 +0000593 // The extra stack adjustments are too big for us to handle.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000594 return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000595
596 // Frameless stack with an offset too large for us to encode compactly.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000597 CompactUnwindEncoding |= CU::UNWIND_MODE_STACK_IND;
Bill Wendling09b02c82011-07-25 18:00:28 +0000598
599 // Encode the offset to the nnnnnn value in the 'subl $nnnnnn, ESP'
600 // instruction.
601 CompactUnwindEncoding |= (SubtractInstrIdx & 0xFF) << 16;
602
Bill Wendling57a3cd22011-12-06 21:23:42 +0000603 // Encode any extra stack stack adjustments (done via push instructions).
604 CompactUnwindEncoding |= (StackAdjust & 0x7) << 13;
Bill Wendling09b02c82011-07-25 18:00:28 +0000605 }
606
Bill Wendling5b2c4972011-12-06 19:16:17 +0000607 // Encode the number of registers saved.
Bill Wendling10e412e2011-12-14 23:53:24 +0000608 CompactUnwindEncoding |= (SavedRegIdx & 0x7) << 10;
Bill Wendling75e14e02011-12-06 19:09:06 +0000609
Bill Wendling09b02c82011-07-25 18:00:28 +0000610 // Get the encoding of the saved registers when we don't have a frame
611 // pointer.
Bill Wendling57a3cd22011-12-06 21:23:42 +0000612 uint32_t RegEnc =
Bill Wendling10e412e2011-12-14 23:53:24 +0000613 encodeCompactUnwindRegistersWithoutFrame(SavedRegs, SavedRegIdx,
Bill Wendling57a3cd22011-12-06 21:23:42 +0000614 Is64Bit);
Bill Wendling89ec1c52013-04-19 00:05:59 +0000615 if (RegEnc == ~0U) return CU::UNWIND_MODE_DWARF;
Bill Wendling5b2c4972011-12-06 19:16:17 +0000616
617 // Encode the register encoding.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000618 CompactUnwindEncoding |=
619 RegEnc & CU::UNWIND_FRAMELESS_STACK_REG_PERMUTATION;
Bill Wendling09b02c82011-07-25 18:00:28 +0000620 }
621
622 return CompactUnwindEncoding;
623}
624
Nadav Rotem677689c2012-12-23 07:30:09 +0000625/// usesTheStack - This function checks if any of the users of EFLAGS
Nadav Rotemd0696ef2012-12-21 23:48:49 +0000626/// 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.
Nadav Rotem677689c2012-12-23 07:30:09 +0000629/// See X86InstrInfo::copyPhysReg.
630static bool usesTheStack(MachineFunction &MF) {
Nadav Rotemd0696ef2012-12-21 23:48:49 +0000631 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
Anton Korobeynikov33464912010-11-15 00:06:54 +0000641/// 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.
Anton Korobeynikov16c29b52011-01-10 12:39:04 +0000645void X86FrameLowering::emitPrologue(MachineFunction &MF) const {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000646 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();
Anton Korobeynikovd9e33852010-11-18 23:25:52 +0000650 const X86RegisterInfo *RegInfo = TM.getRegisterInfo();
651 const X86InstrInfo &TII = *TM.getInstrInfo();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000652 MachineModuleInfo &MMI = MF.getMMI();
653 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
654 bool needsFrameMoves = MMI.hasDebugInfo() ||
Rafael Espindolafc2bb8c2011-05-25 03:44:17 +0000655 Fn->needsUnwindTableEntry();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000656 uint64_t MaxAlign = MFI->getMaxAlignment(); // Desired stack alignment.
657 uint64_t StackSize = MFI->getStackSize(); // Number of bytes to allocate.
Anton Korobeynikovd0c38172010-11-18 21:19:35 +0000658 bool HasFP = hasFP(MF);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000659 bool Is64Bit = STI.is64Bit();
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000660 bool IsLP64 = STI.isTarget64BitLP64();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000661 bool IsWin64 = STI.isTargetWin64();
Evan Chengde1df102012-02-07 22:50:41 +0000662 bool UseLEA = STI.useLeaForSP();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000663 unsigned StackAlign = getStackAlignment();
664 unsigned SlotSize = RegInfo->getSlotSize();
665 unsigned FramePtr = RegInfo->getFrameRegister(MF);
666 unsigned StackPtr = RegInfo->getStackRegister();
Chad Rosier3f0dbab2012-07-10 17:45:53 +0000667 unsigned BasePtr = RegInfo->getBaseRegister();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000668 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
Nadav Rotemd0696ef2012-12-21 23:48:49 +0000690 // stack pointer (we fit in the Red Zone). We also check that we don't
691 // push and pop from the stack.
Bill Wendling831737d2012-12-30 10:32:01 +0000692 if (Is64Bit && !Fn->getAttributes().hasAttribute(AttributeSet::FunctionIndex,
693 Attribute::NoRedZone) &&
Anton Korobeynikov33464912010-11-15 00:06:54 +0000694 !RegInfo->needsStackRealignment(MF) &&
Nick Lewycky8a8d4792011-12-02 22:16:29 +0000695 !MFI->hasVarSizedObjects() && // No dynamic alloca.
696 !MFI->adjustsStack() && // No calls.
697 !IsWin64 && // Win64 has no Red Zone
Nadav Rotem677689c2012-12-23 07:30:09 +0000698 !usesTheStack(MF) && // Don't push and pop.
Nick Lewycky8a8d4792011-12-02 22:16:29 +0000699 !MF.getTarget().Options.EnableSegmentedStacks) { // Regular stack
Anton Korobeynikov33464912010-11-15 00:06:54 +0000700 uint64_t MinSize = X86FI->getCalleeSavedFrameSize();
701 if (HasFP) MinSize += SlotSize;
702 StackSize = std::max(MinSize, StackSize > 128 ? StackSize - 128 : 0);
703 MFI->setStackSize(StackSize);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000704 }
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,
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000712 TII.get(getSUBriOpcode(IsLP64, -TailCallReturnAddrDelta)),
Anton Korobeynikov33464912010-11-15 00:06:54 +0000713 StackPtr)
714 .addReg(StackPtr)
Charles Davisaff232a2011-06-12 01:45:54 +0000715 .addImm(-TailCallReturnAddrDelta)
716 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000717 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
Anton Korobeynikov33464912010-11-15 00:06:54 +0000734 uint64_t NumBytes = 0;
Michael Liaoaa3c2c02012-10-25 06:29:14 +0000735 int stackGrowth = -SlotSize;
Anton Korobeynikov33464912010-11-15 00:06:54 +0000736
737 if (HasFP) {
738 // Calculate required stack adjustment.
739 uint64_t FrameSize = StackSize - SlotSize;
Alexey Samsonov99a92f22012-07-16 06:54:09 +0000740 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 }
Anton Korobeynikov33464912010-11-15 00:06:54 +0000748
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))
Charles Davisaff232a2011-06-12 01:45:54 +0000756 .addReg(FramePtr, RegState::Kill)
757 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000758
759 if (needsFrameMoves) {
760 // Mark the place where EBP/RBP was saved.
761 MCSymbol *FrameLabel = MMI.getContext().CreateTempSymbol();
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000762 BuildMI(MBB, MBBI, DL, TII.get(X86::PROLOG_LABEL))
763 .addSym(FrameLabel);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000764
765 // Define the current CFA rule to use the provided offset.
766 if (StackSize) {
767 MachineLocation SPDst(MachineLocation::VirtualFP);
768 MachineLocation SPSrc(MachineLocation::VirtualFP, 2 * stackGrowth);
Rafael Espindolad84ccfa2013-05-11 02:38:11 +0000769 MMI.addFrameMove(FrameLabel, SPDst, SPSrc);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000770 } else {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000771 MachineLocation SPDst(StackPtr);
772 MachineLocation SPSrc(StackPtr, stackGrowth);
Rafael Espindolad84ccfa2013-05-11 02:38:11 +0000773 MMI.addFrameMove(FrameLabel, SPDst, SPSrc);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000774 }
775
776 // Change the rule for the FramePtr to be an "offset" rule.
777 MachineLocation FPDst(MachineLocation::VirtualFP, 2 * stackGrowth);
778 MachineLocation FPSrc(FramePtr);
Rafael Espindolad84ccfa2013-05-11 02:38:11 +0000779 MMI.addFrameMove(FrameLabel, FPDst, FPSrc);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000780 }
781
Bill Wendling09b02c82011-07-25 18:00:28 +0000782 // Update EBP with the new base value.
Anton Korobeynikov33464912010-11-15 00:06:54 +0000783 BuildMI(MBB, MBBI, DL,
784 TII.get(Is64Bit ? X86::MOV64rr : X86::MOV32rr), FramePtr)
Charles Davisaff232a2011-06-12 01:45:54 +0000785 .addReg(StackPtr)
786 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000787
788 if (needsFrameMoves) {
789 // Mark effective beginning of when frame pointer becomes valid.
790 MCSymbol *FrameLabel = MMI.getContext().CreateTempSymbol();
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000791 BuildMI(MBB, MBBI, DL, TII.get(X86::PROLOG_LABEL))
792 .addSym(FrameLabel);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000793
794 // Define the current CFA to use the EBP/RBP register.
795 MachineLocation FPDst(FramePtr);
796 MachineLocation FPSrc(MachineLocation::VirtualFP);
Rafael Espindolad84ccfa2013-05-11 02:38:11 +0000797 MMI.addFrameMove(FrameLabel, FPDst, FPSrc);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000798 }
799
800 // Mark the FramePtr as live-in in every block except the entry.
801 for (MachineFunction::iterator I = llvm::next(MF.begin()), E = MF.end();
802 I != E; ++I)
803 I->addLiveIn(FramePtr);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000804 } else {
805 NumBytes = StackSize - X86FI->getCalleeSavedFrameSize();
806 }
807
808 // Skip the callee-saved push instructions.
809 bool PushedRegs = false;
810 int StackOffset = 2 * stackGrowth;
811
812 while (MBBI != MBB.end() &&
813 (MBBI->getOpcode() == X86::PUSH32r ||
814 MBBI->getOpcode() == X86::PUSH64r)) {
815 PushedRegs = true;
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000816 MBBI->setFlag(MachineInstr::FrameSetup);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000817 ++MBBI;
818
819 if (!HasFP && needsFrameMoves) {
820 // Mark callee-saved push instruction.
821 MCSymbol *Label = MMI.getContext().CreateTempSymbol();
822 BuildMI(MBB, MBBI, DL, TII.get(X86::PROLOG_LABEL)).addSym(Label);
823
824 // Define the current CFA rule to use the provided offset.
Bill Wendling09b02c82011-07-25 18:00:28 +0000825 unsigned Ptr = StackSize ? MachineLocation::VirtualFP : StackPtr;
Anton Korobeynikov33464912010-11-15 00:06:54 +0000826 MachineLocation SPDst(Ptr);
827 MachineLocation SPSrc(Ptr, StackOffset);
Rafael Espindolad84ccfa2013-05-11 02:38:11 +0000828 MMI.addFrameMove(Label, SPDst, SPSrc);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000829 StackOffset += stackGrowth;
830 }
831 }
832
Alexey Samsonov99a92f22012-07-16 06:54:09 +0000833 // Realign stack after we pushed callee-saved registers (so that we'll be
834 // able to calculate their offsets from the frame pointer).
835
836 // NOTE: We push the registers before realigning the stack, so
837 // vector callee-saved (xmm) registers may be saved w/o proper
838 // alignment in this way. However, currently these regs are saved in
839 // stack slots (see X86FrameLowering::spillCalleeSavedRegisters()), so
840 // this shouldn't be a problem.
841 if (RegInfo->needsStackRealignment(MF)) {
842 assert(HasFP && "There should be a frame pointer if stack is realigned.");
843 MachineInstr *MI =
844 BuildMI(MBB, MBBI, DL,
845 TII.get(Is64Bit ? X86::AND64ri32 : X86::AND32ri), StackPtr)
846 .addReg(StackPtr)
847 .addImm(-MaxAlign)
848 .setMIFlag(MachineInstr::FrameSetup);
849
850 // The EFLAGS implicit def is dead.
851 MI->getOperand(3).setIsDead();
852 }
853
Anton Korobeynikov33464912010-11-15 00:06:54 +0000854 // If there is an SUB32ri of ESP immediately before this instruction, merge
855 // the two. This can be the case when tail call elimination is enabled and
856 // the callee has more arguments then the caller.
857 NumBytes -= mergeSPUpdates(MBB, MBBI, StackPtr, true);
858
859 // If there is an ADD32ri or SUB32ri of ESP immediately after this
860 // instruction, merge the two instructions.
861 mergeSPUpdatesDown(MBB, MBBI, StackPtr, &NumBytes);
862
863 // Adjust stack pointer: ESP -= numbytes.
864
865 // Windows and cygwin/mingw require a prologue helper routine when allocating
866 // more than 4K bytes on the stack. Windows uses __chkstk and cygwin/mingw
867 // uses __alloca. __alloca and the 32-bit version of __chkstk will probe the
868 // stack and adjust the stack pointer in one go. The 64-bit version of
869 // __chkstk is only responsible for probing the stack. The 64-bit prologue is
870 // responsible for adjusting the stack pointer. Touching the stack at 4K
871 // increments is necessary to ensure that the guard pages used by the OS
872 // virtual memory manager are allocated in correct sequence.
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000873 if (NumBytes >= 4096 && STI.isTargetCOFF() && !STI.isTargetEnvMacho()) {
874 const char *StackProbeSymbol;
875 bool isSPUpdateNeeded = false;
876
877 if (Is64Bit) {
878 if (STI.isTargetCygMing())
879 StackProbeSymbol = "___chkstk";
880 else {
881 StackProbeSymbol = "__chkstk";
882 isSPUpdateNeeded = true;
883 }
884 } else if (STI.isTargetCygMing())
885 StackProbeSymbol = "_alloca";
886 else
887 StackProbeSymbol = "_chkstk";
888
Anton Korobeynikov33464912010-11-15 00:06:54 +0000889 // Check whether EAX is livein for this function.
890 bool isEAXAlive = isEAXLiveIn(MF);
891
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000892 if (isEAXAlive) {
893 // Sanity check that EAX is not livein for this function.
894 // It should not be, so throw an assert.
895 assert(!Is64Bit && "EAX is livein in x64 case!");
896
Anton Korobeynikov33464912010-11-15 00:06:54 +0000897 // Save EAX
898 BuildMI(MBB, MBBI, DL, TII.get(X86::PUSH32r))
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000899 .addReg(X86::EAX, RegState::Kill)
900 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000901 }
Anton Korobeynikov33464912010-11-15 00:06:54 +0000902
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000903 if (Is64Bit) {
904 // Handle the 64-bit Windows ABI case where we need to call __chkstk.
905 // Function prologue is responsible for adjusting the stack pointer.
906 BuildMI(MBB, MBBI, DL, TII.get(X86::MOV64ri), X86::RAX)
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000907 .addImm(NumBytes)
908 .setMIFlag(MachineInstr::FrameSetup);
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000909 } else {
910 // Allocate NumBytes-4 bytes on stack in case of isEAXAlive.
911 // We'll also use 4 already allocated bytes for EAX.
912 BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32ri), X86::EAX)
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000913 .addImm(isEAXAlive ? NumBytes - 4 : NumBytes)
914 .setMIFlag(MachineInstr::FrameSetup);
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000915 }
916
917 BuildMI(MBB, MBBI, DL,
918 TII.get(Is64Bit ? X86::W64ALLOCA : X86::CALLpcrel32))
919 .addExternalSymbol(StackProbeSymbol)
920 .addReg(StackPtr, RegState::Define | RegState::Implicit)
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000921 .addReg(X86::EFLAGS, RegState::Define | RegState::Implicit)
922 .setMIFlag(MachineInstr::FrameSetup);
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000923
924 // MSVC x64's __chkstk needs to adjust %rsp.
925 // FIXME: %rax preserves the offset and should be available.
926 if (isSPUpdateNeeded)
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000927 emitSPUpdate(MBB, MBBI, StackPtr, -(int64_t)NumBytes, Is64Bit, IsLP64,
Eric Christopher76ad43c2012-10-03 08:10:01 +0000928 UseLEA, TII, *RegInfo);
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000929
930 if (isEAXAlive) {
931 // Restore EAX
932 MachineInstr *MI = addRegOffset(BuildMI(MF, DL, TII.get(X86::MOV32rm),
933 X86::EAX),
934 StackPtr, false, NumBytes - 4);
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000935 MI->setFlag(MachineInstr::FrameSetup);
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000936 MBB.insert(MBBI, MI);
937 }
Anton Korobeynikov33464912010-11-15 00:06:54 +0000938 } else if (NumBytes)
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000939 emitSPUpdate(MBB, MBBI, StackPtr, -(int64_t)NumBytes, Is64Bit, IsLP64,
Eric Christopher76ad43c2012-10-03 08:10:01 +0000940 UseLEA, TII, *RegInfo);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000941
Chad Rosier3f0dbab2012-07-10 17:45:53 +0000942 // If we need a base pointer, set it up here. It's whatever the value
943 // of the stack pointer is at this point. Any variable size objects
944 // will be allocated after this, so we can still use the base pointer
945 // to reference locals.
946 if (RegInfo->hasBasePointer(MF)) {
947 // Update the frame pointer with the current stack pointer.
948 unsigned Opc = Is64Bit ? X86::MOV64rr : X86::MOV32rr;
949 BuildMI(MBB, MBBI, DL, TII.get(Opc), BasePtr)
950 .addReg(StackPtr)
951 .setMIFlag(MachineInstr::FrameSetup);
Chad Rosier3f0dbab2012-07-10 17:45:53 +0000952 }
953
Rafael Espindolaf0adba92011-04-15 15:11:06 +0000954 if (( (!HasFP && NumBytes) || PushedRegs) && needsFrameMoves) {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000955 // Mark end of stack pointer adjustment.
956 MCSymbol *Label = MMI.getContext().CreateTempSymbol();
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000957 BuildMI(MBB, MBBI, DL, TII.get(X86::PROLOG_LABEL))
958 .addSym(Label);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000959
960 if (!HasFP && NumBytes) {
961 // Define the current CFA rule to use the provided offset.
962 if (StackSize) {
963 MachineLocation SPDst(MachineLocation::VirtualFP);
964 MachineLocation SPSrc(MachineLocation::VirtualFP,
965 -StackSize + stackGrowth);
Rafael Espindolad84ccfa2013-05-11 02:38:11 +0000966 MMI.addFrameMove(Label, SPDst, SPSrc);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000967 } else {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000968 MachineLocation SPDst(StackPtr);
969 MachineLocation SPSrc(StackPtr, stackGrowth);
Rafael Espindolad84ccfa2013-05-11 02:38:11 +0000970 MMI.addFrameMove(Label, SPDst, SPSrc);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000971 }
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 }
Bill Wendling09b02c82011-07-25 18:00:28 +0000978
979 // Darwin 10.7 and greater has support for compact unwind encoding.
Bill Wendlingc8725d12011-09-06 23:47:14 +0000980 if (STI.getTargetTriple().isMacOSX() &&
Eli Friedmanac86d432011-08-31 16:19:51 +0000981 !STI.getTargetTriple().isMacOSXVersionLT(10, 7))
Bill Wendling09b02c82011-07-25 18:00:28 +0000982 MMI.setCompactUnwindEncoding(getCompactUnwindEncoding(MF));
Anton Korobeynikov33464912010-11-15 00:06:54 +0000983}
984
Anton Korobeynikov16c29b52011-01-10 12:39:04 +0000985void X86FrameLowering::emitEpilogue(MachineFunction &MF,
Nick Lewycky3c2f0a12011-06-14 03:23:52 +0000986 MachineBasicBlock &MBB) const {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000987 const MachineFrameInfo *MFI = MF.getFrameInfo();
988 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
Anton Korobeynikovd9e33852010-11-18 23:25:52 +0000989 const X86RegisterInfo *RegInfo = TM.getRegisterInfo();
990 const X86InstrInfo &TII = *TM.getInstrInfo();
Jakob Stoklund Olesen4f28c1c2011-01-13 21:28:52 +0000991 MachineBasicBlock::iterator MBBI = MBB.getLastNonDebugInstr();
992 assert(MBBI != MBB.end() && "Returning block has no instructions");
Anton Korobeynikov33464912010-11-15 00:06:54 +0000993 unsigned RetOpcode = MBBI->getOpcode();
994 DebugLoc DL = MBBI->getDebugLoc();
995 bool Is64Bit = STI.is64Bit();
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000996 bool IsLP64 = STI.isTarget64BitLP64();
Evan Chengde1df102012-02-07 22:50:41 +0000997 bool UseLEA = STI.useLeaForSP();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000998 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
Anton Korobeynikovd0c38172010-11-18 21:19:35 +00001036 if (hasFP(MF)) {
Anton Korobeynikov33464912010-11-15 00:06:54 +00001037 // Calculate required stack adjustment.
1038 uint64_t FrameSize = StackSize - SlotSize;
Alexey Samsonov99a92f22012-07-16 06:54:09 +00001039 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 }
Anton Korobeynikov33464912010-11-15 00:06:54 +00001047
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.
Anton Korobeynikov33464912010-11-15 00:06:54 +00001056 while (MBBI != MBB.begin()) {
1057 MachineBasicBlock::iterator PI = prior(MBBI);
1058 unsigned Opc = PI->getOpcode();
1059
Jakob Stoklund Olesen4f28c1c2011-01-13 21:28:52 +00001060 if (Opc != X86::POP32r && Opc != X86::POP64r && Opc != X86::DBG_VALUE &&
Evan Cheng5a96b3d2011-12-07 07:15:52 +00001061 !PI->isTerminator())
Anton Korobeynikov33464912010-11-15 00:06:54 +00001062 break;
1063
1064 --MBBI;
1065 }
Alexey Samsonov99a92f22012-07-16 06:54:09 +00001066 MachineBasicBlock::iterator FirstCSPop = MBBI;
Anton Korobeynikov33464912010-11-15 00:06:54 +00001067
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.
Alexey Samsonov99a92f22012-07-16 06:54:09 +00001078 if (RegInfo->needsStackRealignment(MF) || MFI->hasVarSizedObjects()) {
1079 if (RegInfo->needsStackRealignment(MF))
1080 MBBI = FirstCSPop;
1081 if (CSSize != 0) {
Eli Bendersky16221a62013-02-06 20:43:57 +00001082 unsigned Opc = getLEArOpcode(IsLP64);
Alexey Samsonov99a92f22012-07-16 06:54:09 +00001083 addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr),
1084 FramePtr, false, -CSSize);
Anton Korobeynikov33464912010-11-15 00:06:54 +00001085 } else {
Alexey Samsonov99a92f22012-07-16 06:54:09 +00001086 unsigned Opc = (Is64Bit ? X86::MOV64rr : X86::MOV32rr);
1087 BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr)
Anton Korobeynikov33464912010-11-15 00:06:54 +00001088 .addReg(FramePtr);
1089 }
1090 } else if (NumBytes) {
1091 // Adjust stack pointer back: ESP += numbytes.
Eli Bendersky2a1b60d2013-02-05 21:53:29 +00001092 emitSPUpdate(MBB, MBBI, StackPtr, NumBytes, Is64Bit, IsLP64, UseLEA,
1093 TII, *RegInfo);
Anton Korobeynikov33464912010-11-15 00:06:54 +00001094 }
1095
1096 // We're returning from function via eh_return.
1097 if (RetOpcode == X86::EH_RETURN || RetOpcode == X86::EH_RETURN64) {
Jakob Stoklund Olesen4f28c1c2011-01-13 21:28:52 +00001098 MBBI = MBB.getLastNonDebugInstr();
Anton Korobeynikov33464912010-11-15 00:06:54 +00001099 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.
Jakob Stoklund Olesenf7ca9762011-01-13 22:47:43 +00001110 MBBI = MBB.getLastNonDebugInstr();
Anton Korobeynikov33464912010-11-15 00:06:54 +00001111 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) {
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001126 // Check for possible merge with preceding ADD instruction.
Anton Korobeynikov33464912010-11-15 00:06:54 +00001127 Offset += mergeSPUpdates(MBB, MBBI, StackPtr, true);
Eli Bendersky2a1b60d2013-02-05 21:53:29 +00001128 emitSPUpdate(MBB, MBBI, StackPtr, Offset, Is64Bit, IsLP64,
1129 UseLEA, TII, *RegInfo);
Anton Korobeynikov33464912010-11-15 00:06:54 +00001130 }
1131
1132 // Jump to label or value in register.
1133 if (RetOpcode == X86::TCRETURNdi || RetOpcode == X86::TCRETURNdi64) {
Evan Cheng3d2125c2010-11-30 23:55:39 +00001134 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 }
Anton Korobeynikov33464912010-11-15 00:06:54 +00001145 } 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);
Jakob Stoklund Olesenbe06aac2012-12-20 22:54:02 +00001160 NewMI->copyImplicitOps(MF, MBBI);
Anton Korobeynikov33464912010-11-15 00:06:54 +00001161
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();
Jakob Stoklund Olesen4f28c1c2011-01-13 21:28:52 +00001168 MBBI = MBB.getLastNonDebugInstr();
Anton Korobeynikov33464912010-11-15 00:06:54 +00001169
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001170 // Check for possible merge with preceding ADD instruction.
Anton Korobeynikov33464912010-11-15 00:06:54 +00001171 delta += mergeSPUpdates(MBB, MBBI, StackPtr, true);
Eli Bendersky2a1b60d2013-02-05 21:53:29 +00001172 emitSPUpdate(MBB, MBBI, StackPtr, delta, Is64Bit, IsLP64, UseLEA, TII,
1173 *RegInfo);
Anton Korobeynikov33464912010-11-15 00:06:54 +00001174 }
1175}
Anton Korobeynikovd9e33852010-11-18 23:25:52 +00001176
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00001177int X86FrameLowering::getFrameIndexOffset(const MachineFunction &MF, int FI) const {
Chad Rosier3fb6eca2012-05-23 23:45:10 +00001178 const X86RegisterInfo *RegInfo =
Anton Korobeynikov82f58742010-11-20 15:59:32 +00001179 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
Chad Rosier3f0dbab2012-07-10 17:45:53 +00001184 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)) {
Anton Korobeynikov82f58742010-11-20 15:59:32 +00001194 if (FI < 0) {
1195 // Skip the saved EBP.
Chad Rosier3fb6eca2012-05-23 23:45:10 +00001196 return Offset + RegInfo->getSlotSize();
Anton Korobeynikov82f58742010-11-20 15:59:32 +00001197 } else {
Duncan Sands17001ce2011-10-18 12:44:00 +00001198 assert((-(Offset + StackSize)) % MFI->getObjectAlignment(FI) == 0);
Anton Korobeynikov82f58742010-11-20 15:59:32 +00001199 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.
Chad Rosier3fb6eca2012-05-23 23:45:10 +00001207 Offset += RegInfo->getSlotSize();
Anton Korobeynikov82f58742010-11-20 15:59:32 +00001208
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}
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001218
Alexey Samsonovd07d06c2012-05-01 15:16:06 +00001219int X86FrameLowering::getFrameIndexReference(const MachineFunction &MF, int FI,
1220 unsigned &FrameReg) const {
Chad Rosier3fb6eca2012-05-23 23:45:10 +00001221 const X86RegisterInfo *RegInfo =
Alexey Samsonovd07d06c2012-05-01 15:16:06 +00001222 static_cast<const X86RegisterInfo*>(MF.getTarget().getRegisterInfo());
1223 // We can't calculate offset from frame pointer if the stack is realigned,
Chad Rosier3f0dbab2012-07-10 17:45:53 +00001224 // 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);
Alexey Samsonovd07d06c2012-05-01 15:16:06 +00001232 return getFrameIndexOffset(MF, FI);
1233}
1234
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00001235bool X86FrameLowering::spillCalleeSavedRegisters(MachineBasicBlock &MBB,
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001236 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
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001246 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
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001253 // Push GPRs. It increases frame size.
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001254 unsigned Opc = STI.is64Bit() ? X86::PUSH64r : X86::PUSH32r;
1255 for (unsigned i = CSI.size(); i != 0; --i) {
1256 unsigned Reg = CSI[i-1].getReg();
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001257 if (!X86::GR64RegClass.contains(Reg) &&
1258 !X86::GR32RegClass.contains(Reg))
1259 continue;
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001260 // 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;
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001265 CalleeFrameSize += SlotSize;
Charles Davisaff232a2011-06-12 01:45:54 +00001266 BuildMI(MBB, MI, DL, TII.get(Opc)).addReg(Reg, RegState::Kill)
1267 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001268 }
1269
1270 X86FI->setCalleeSavedFrameSize(CalleeFrameSize);
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001271
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
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001287 return true;
1288}
1289
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00001290bool X86FrameLowering::restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001291 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();
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001301
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.
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001314 unsigned FPReg = TRI->getFrameRegister(MF);
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001315 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();
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001318 if (!X86::GR64RegClass.contains(Reg) &&
1319 !X86::GR32RegClass.contains(Reg))
1320 continue;
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001321 if (Reg == FPReg)
1322 // X86RegisterInfo::emitEpilogue will handle restoring of frame register.
1323 continue;
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001324 BuildMI(MBB, MI, DL, TII.get(Opc), Reg);
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001325 }
1326 return true;
1327}
Anton Korobeynikov94c5ae02010-11-27 23:05:25 +00001328
1329void
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00001330X86FrameLowering::processFunctionBeforeCalleeSavedScan(MachineFunction &MF,
Anton Korobeynikov94c5ae02010-11-27 23:05:25 +00001331 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 int32_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 (-1U*SlotSize)+TailCallReturnAddrDelta, true);
1351 }
1352
1353 if (hasFP(MF)) {
1354 assert((TailCallReturnAddrDelta <= 0) &&
1355 "The Delta should always be zero or negative");
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00001356 const TargetFrameLowering &TFI = *MF.getTarget().getFrameLowering();
Anton Korobeynikov94c5ae02010-11-27 23:05:25 +00001357
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!");
Duncan Sands17001ce2011-10-18 12:44:00 +00001366 (void)FrameIdx;
Anton Korobeynikov94c5ae02010-11-27 23:05:25 +00001367 }
Chad Rosier3f0dbab2012-07-10 17:45:53 +00001368
1369 // Spill the BasePtr if it's used.
1370 if (RegInfo->hasBasePointer(MF))
1371 MF.getRegInfo().setPhysRegUsed(RegInfo->getBaseRegister());
Anton Korobeynikov94c5ae02010-11-27 23:05:25 +00001372}
Rafael Espindola76927d752011-08-30 19:39:58 +00001373
1374static bool
1375HasNestArgument(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
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001385/// 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.
Rafael Espindola76927d752011-08-30 19:39:58 +00001389static unsigned
Rafael Espindola2028b792012-01-11 19:00:37 +00001390GetScratchRegister(bool Is64Bit, const MachineFunction &MF, bool Primary) {
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001391 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
David Blaikie4d6ccb52012-01-20 21:51:11 +00001401 if (Is64Bit)
Rafael Espindola2028b792012-01-11 19:00:37 +00001402 return Primary ? X86::R11 : X86::R12;
Rafael Espindola76927d752011-08-30 19:39:58 +00001403
David Blaikie4d6ccb52012-01-20 21:51:11 +00001404 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;
Rafael Espindola76927d752011-08-30 19:39:58 +00001412 }
David Blaikie4d6ccb52012-01-20 21:51:11 +00001413 if (IsNested)
1414 return Primary ? X86::EDX : X86::EAX;
1415 return Primary ? X86::ECX : X86::EAX;
Rafael Espindola76927d752011-08-30 19:39:58 +00001416}
1417
Sanjoy Das199ce332011-12-03 09:32:07 +00001418// The stack limit in the TCB is set to this many bytes above the actual stack
1419// limit.
1420static const uint64_t kSplitStackAvailable = 256;
1421
Rafael Espindola76927d752011-08-30 19:39:58 +00001422void
1423X86FrameLowering::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;
Rafael Espindola76927d752011-08-30 19:39:58 +00001431
Rafael Espindola2028b792012-01-11 19:00:37 +00001432 unsigned ScratchReg = GetScratchRegister(Is64Bit, MF, true);
Rafael Espindola76927d752011-08-30 19:39:58 +00001433 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.");
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001438 if (!STI.isTargetLinux() && !STI.isTargetDarwin() &&
1439 !STI.isTargetWin32() && !STI.isTargetFreeBSD())
Rafael Espindola85b9d432012-01-12 20:24:30 +00001440 report_fatal_error("Segmented stacks not supported on this platform.");
Rafael Espindola76927d752011-08-30 19:39:58 +00001441
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
Bill Wendling4e680542011-10-13 08:24:19 +00001451 // 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.
Bill Wendling4e680542011-10-13 08:24:19 +00001453
Rafael Espindola76927d752011-08-30 19:39:58 +00001454 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)
Rafael Espindolae840e882011-10-26 21:12:27 +00001461 allocMBB->addLiveIn(X86::R10);
1462
Rafael Espindola76927d752011-08-30 19:39:58 +00001463 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
Rafael Espindola2028b792012-01-11 19:00:37 +00001471 // 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
Rafael Espindola76927d752011-08-30 19:39:58 +00001475 // Read the limit off the current stacklet off the stack_guard location.
1476 if (Is64Bit) {
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001477 if (STI.isTargetLinux()) {
Rafael Espindola2028b792012-01-11 19:00:37 +00001478 TlsReg = X86::FS;
1479 TlsOffset = 0x70;
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001480 } else if (STI.isTargetDarwin()) {
Rafael Espindola2028b792012-01-11 19:00:37 +00001481 TlsReg = X86::GS;
1482 TlsOffset = 0x60 + 90*8; // See pthread_machdep.h. Steal TLS slot 90.
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001483 } else if (STI.isTargetFreeBSD()) {
Rafael Espindola85b9d432012-01-12 20:24:30 +00001484 TlsReg = X86::FS;
1485 TlsOffset = 0x18;
Rafael Espindolae4d18de2012-01-12 20:22:08 +00001486 } else {
1487 report_fatal_error("Segmented stacks not supported on this platform.");
Rafael Espindola2028b792012-01-11 19:00:37 +00001488 }
Rafael Espindola76927d752011-08-30 19:39:58 +00001489
Rafael Espindola2028b792012-01-11 19:00:37 +00001490 if (CompareStackPointer)
Sanjoy Das199ce332011-12-03 09:32:07 +00001491 ScratchReg = X86::RSP;
1492 else
1493 BuildMI(checkMBB, DL, TII.get(X86::LEA64r), ScratchReg).addReg(X86::RSP)
Rafael Espindola014f7a32012-01-11 18:14:03 +00001494 .addImm(1).addReg(0).addImm(-StackSize).addReg(0);
Sanjoy Das199ce332011-12-03 09:32:07 +00001495
Rafael Espindola76927d752011-08-30 19:39:58 +00001496 BuildMI(checkMBB, DL, TII.get(X86::CMP64rm)).addReg(ScratchReg)
Rafael Espindola014f7a32012-01-11 18:14:03 +00001497 .addReg(0).addImm(1).addReg(0).addImm(TlsOffset).addReg(TlsReg);
Rafael Espindola76927d752011-08-30 19:39:58 +00001498 } else {
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001499 if (STI.isTargetLinux()) {
Rafael Espindolae4d18de2012-01-12 20:22:08 +00001500 TlsReg = X86::GS;
1501 TlsOffset = 0x30;
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001502 } else if (STI.isTargetDarwin()) {
Rafael Espindolae4d18de2012-01-12 20:22:08 +00001503 TlsReg = X86::GS;
1504 TlsOffset = 0x48 + 90*4;
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001505 } else if (STI.isTargetWin32()) {
Rafael Espindolae4d18de2012-01-12 20:22:08 +00001506 TlsReg = X86::FS;
1507 TlsOffset = 0x14; // pvArbitrary, reserved for application use
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001508 } else if (STI.isTargetFreeBSD()) {
Rafael Espindola85b9d432012-01-12 20:24:30 +00001509 report_fatal_error("Segmented stacks not supported on FreeBSD i386.");
Rafael Espindolae4d18de2012-01-12 20:22:08 +00001510 } else {
1511 report_fatal_error("Segmented stacks not supported on this platform.");
1512 }
Rafael Espindola76927d752011-08-30 19:39:58 +00001513
Rafael Espindola2028b792012-01-11 19:00:37 +00001514 if (CompareStackPointer)
Sanjoy Das199ce332011-12-03 09:32:07 +00001515 ScratchReg = X86::ESP;
1516 else
1517 BuildMI(checkMBB, DL, TII.get(X86::LEA32r), ScratchReg).addReg(X86::ESP)
Rafael Espindola014f7a32012-01-11 18:14:03 +00001518 .addImm(1).addReg(0).addImm(-StackSize).addReg(0);
Sanjoy Das199ce332011-12-03 09:32:07 +00001519
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001520 if (STI.isTargetLinux() || STI.isTargetWin32()) {
Rafael Espindola2028b792012-01-11 19:00:37 +00001521 BuildMI(checkMBB, DL, TII.get(X86::CMP32rm)).addReg(ScratchReg)
1522 .addReg(0).addImm(0).addReg(0).addImm(TlsOffset).addReg(TlsReg);
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001523 } else if (STI.isTargetDarwin()) {
Rafael Espindola2028b792012-01-11 19:00:37 +00001524
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 }
Rafael Espindola76927d752011-08-30 19:39:58 +00001559 }
1560
1561 // This jump is taken if SP >= (Stacklet Limit + Stack Space required).
1562 // It jumps to normal execution of the function body.
Rafael Espindola313c7032012-01-11 18:23:35 +00001563 BuildMI(checkMBB, DL, TII.get(X86::JA_4)).addMBB(&prologueMBB);
Rafael Espindola76927d752011-08-30 19:39:58 +00001564
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 {
Rafael Espindola76927d752011-08-30 19:39:58 +00001581 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
Bill Wendling4e680542011-10-13 08:24:19 +00001595 if (IsNested)
Rafael Espindolae840e882011-10-26 21:12:27 +00001596 BuildMI(allocMBB, DL, TII.get(X86::MORESTACK_RET_RESTORE_R10));
1597 else
1598 BuildMI(allocMBB, DL, TII.get(X86::MORESTACK_RET));
Bill Wendling4e680542011-10-13 08:24:19 +00001599
Rafael Espindolae840e882011-10-26 21:12:27 +00001600 allocMBB->addSuccessor(&prologueMBB);
Bill Wendling4e680542011-10-13 08:24:19 +00001601
Rafael Espindola76927d752011-08-30 19:39:58 +00001602 checkMBB->addSuccessor(allocMBB);
1603 checkMBB->addSuccessor(&prologueMBB);
1604
Jakob Stoklund Olesen51f0c762011-09-24 01:11:19 +00001605#ifdef XDEBUG
Rafael Espindola76927d752011-08-30 19:39:58 +00001606 MF.verify();
1607#endif
1608}
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001609
Yiannis Tsiouris2d1035d2013-02-28 16:59:10 +00001610/// 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
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001625void X86FrameLowering::adjustForHiPEPrologue(MachineFunction &MF) const {
1626 const X86InstrInfo &TII = *TM.getInstrInfo();
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001627 MachineFrameInfo *MFI = MF.getFrameInfo();
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001628 const unsigned SlotSize = TM.getRegisterInfo()->getSlotSize();
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001629 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;
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001635 unsigned CallerStkArity = MF.getFunction()->arg_size() > CCRegisteredArgs ?
1636 MF.getFunction()->arg_size() - CCRegisteredArgs : 0;
1637 unsigned MaxStack = MFI->getStackSize() + CallerStkArity*SlotSize + SlotSize;
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001638
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001639 assert(STI.isTargetLinux() &&
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001640 "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();
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001655 MI != ME; ++MI) {
1656 if (!MI->isCall())
1657 continue;
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001658
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001659 // Get callee operand.
1660 const MachineOperand &MO = MI->getOperand(0);
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001661
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001662 // Only take account of global function calls (no closures etc.).
1663 if (!MO.isGlobal())
1664 continue;
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001665
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001666 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 }
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001686 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}
Eli Bendersky700ed802013-02-21 20:05:00 +00001753
1754void X86FrameLowering::
1755eliminateCallFramePseudoInstr(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