blob: 88359da0365fd748158239d8eb6c9e427541a78c [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.
Rafael Espindola377b2272013-05-15 22:27:35 +0000766 assert(StackSize);
767 MachineLocation SPDst(MachineLocation::VirtualFP);
768 MachineLocation SPSrc(MachineLocation::VirtualFP, 2 * stackGrowth);
769 MMI.addFrameMove(FrameLabel, SPDst, SPSrc);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000770
771 // Change the rule for the FramePtr to be an "offset" rule.
772 MachineLocation FPDst(MachineLocation::VirtualFP, 2 * stackGrowth);
773 MachineLocation FPSrc(FramePtr);
Rafael Espindolad84ccfa2013-05-11 02:38:11 +0000774 MMI.addFrameMove(FrameLabel, FPDst, FPSrc);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000775 }
776
Bill Wendling09b02c82011-07-25 18:00:28 +0000777 // Update EBP with the new base value.
Anton Korobeynikov33464912010-11-15 00:06:54 +0000778 BuildMI(MBB, MBBI, DL,
779 TII.get(Is64Bit ? X86::MOV64rr : X86::MOV32rr), FramePtr)
Charles Davisaff232a2011-06-12 01:45:54 +0000780 .addReg(StackPtr)
781 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000782
783 if (needsFrameMoves) {
784 // Mark effective beginning of when frame pointer becomes valid.
785 MCSymbol *FrameLabel = MMI.getContext().CreateTempSymbol();
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000786 BuildMI(MBB, MBBI, DL, TII.get(X86::PROLOG_LABEL))
787 .addSym(FrameLabel);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000788
789 // Define the current CFA to use the EBP/RBP register.
790 MachineLocation FPDst(FramePtr);
791 MachineLocation FPSrc(MachineLocation::VirtualFP);
Rafael Espindolad84ccfa2013-05-11 02:38:11 +0000792 MMI.addFrameMove(FrameLabel, FPDst, FPSrc);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000793 }
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);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000799 } 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;
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000811 MBBI->setFlag(MachineInstr::FrameSetup);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000812 ++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.
Rafael Espindola0ed9f1f2013-05-16 04:59:17 +0000820 assert(StackSize);
821 unsigned Ptr = MachineLocation::VirtualFP;
Anton Korobeynikov33464912010-11-15 00:06:54 +0000822 MachineLocation SPDst(Ptr);
823 MachineLocation SPSrc(Ptr, StackOffset);
Rafael Espindolad84ccfa2013-05-11 02:38:11 +0000824 MMI.addFrameMove(Label, SPDst, SPSrc);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000825 StackOffset += stackGrowth;
826 }
827 }
828
Alexey Samsonov99a92f22012-07-16 06:54:09 +0000829 // Realign stack after we pushed callee-saved registers (so that we'll be
830 // able to calculate their offsets from the frame pointer).
831
832 // NOTE: We push the registers before realigning the stack, so
833 // vector callee-saved (xmm) registers may be saved w/o proper
834 // alignment in this way. However, currently these regs are saved in
835 // stack slots (see X86FrameLowering::spillCalleeSavedRegisters()), so
836 // this shouldn't be a problem.
837 if (RegInfo->needsStackRealignment(MF)) {
838 assert(HasFP && "There should be a frame pointer if stack is realigned.");
839 MachineInstr *MI =
840 BuildMI(MBB, MBBI, DL,
841 TII.get(Is64Bit ? X86::AND64ri32 : X86::AND32ri), StackPtr)
842 .addReg(StackPtr)
843 .addImm(-MaxAlign)
844 .setMIFlag(MachineInstr::FrameSetup);
845
846 // The EFLAGS implicit def is dead.
847 MI->getOperand(3).setIsDead();
848 }
849
Anton Korobeynikov33464912010-11-15 00:06:54 +0000850 // If there is an SUB32ri of ESP immediately before this instruction, merge
851 // the two. This can be the case when tail call elimination is enabled and
852 // the callee has more arguments then the caller.
853 NumBytes -= mergeSPUpdates(MBB, MBBI, StackPtr, true);
854
855 // If there is an ADD32ri or SUB32ri of ESP immediately after this
856 // instruction, merge the two instructions.
857 mergeSPUpdatesDown(MBB, MBBI, StackPtr, &NumBytes);
858
859 // Adjust stack pointer: ESP -= numbytes.
860
861 // Windows and cygwin/mingw require a prologue helper routine when allocating
862 // more than 4K bytes on the stack. Windows uses __chkstk and cygwin/mingw
863 // uses __alloca. __alloca and the 32-bit version of __chkstk will probe the
864 // stack and adjust the stack pointer in one go. The 64-bit version of
865 // __chkstk is only responsible for probing the stack. The 64-bit prologue is
866 // responsible for adjusting the stack pointer. Touching the stack at 4K
867 // increments is necessary to ensure that the guard pages used by the OS
868 // virtual memory manager are allocated in correct sequence.
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000869 if (NumBytes >= 4096 && STI.isTargetCOFF() && !STI.isTargetEnvMacho()) {
870 const char *StackProbeSymbol;
871 bool isSPUpdateNeeded = false;
872
873 if (Is64Bit) {
874 if (STI.isTargetCygMing())
875 StackProbeSymbol = "___chkstk";
876 else {
877 StackProbeSymbol = "__chkstk";
878 isSPUpdateNeeded = true;
879 }
880 } else if (STI.isTargetCygMing())
881 StackProbeSymbol = "_alloca";
882 else
883 StackProbeSymbol = "_chkstk";
884
Anton Korobeynikov33464912010-11-15 00:06:54 +0000885 // Check whether EAX is livein for this function.
886 bool isEAXAlive = isEAXLiveIn(MF);
887
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000888 if (isEAXAlive) {
889 // Sanity check that EAX is not livein for this function.
890 // It should not be, so throw an assert.
891 assert(!Is64Bit && "EAX is livein in x64 case!");
892
Anton Korobeynikov33464912010-11-15 00:06:54 +0000893 // Save EAX
894 BuildMI(MBB, MBBI, DL, TII.get(X86::PUSH32r))
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000895 .addReg(X86::EAX, RegState::Kill)
896 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000897 }
Anton Korobeynikov33464912010-11-15 00:06:54 +0000898
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000899 if (Is64Bit) {
900 // Handle the 64-bit Windows ABI case where we need to call __chkstk.
901 // Function prologue is responsible for adjusting the stack pointer.
902 BuildMI(MBB, MBBI, DL, TII.get(X86::MOV64ri), X86::RAX)
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000903 .addImm(NumBytes)
904 .setMIFlag(MachineInstr::FrameSetup);
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000905 } else {
906 // Allocate NumBytes-4 bytes on stack in case of isEAXAlive.
907 // We'll also use 4 already allocated bytes for EAX.
908 BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32ri), X86::EAX)
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000909 .addImm(isEAXAlive ? NumBytes - 4 : NumBytes)
910 .setMIFlag(MachineInstr::FrameSetup);
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000911 }
912
913 BuildMI(MBB, MBBI, DL,
914 TII.get(Is64Bit ? X86::W64ALLOCA : X86::CALLpcrel32))
915 .addExternalSymbol(StackProbeSymbol)
916 .addReg(StackPtr, RegState::Define | RegState::Implicit)
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000917 .addReg(X86::EFLAGS, RegState::Define | RegState::Implicit)
918 .setMIFlag(MachineInstr::FrameSetup);
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000919
920 // MSVC x64's __chkstk needs to adjust %rsp.
921 // FIXME: %rax preserves the offset and should be available.
922 if (isSPUpdateNeeded)
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000923 emitSPUpdate(MBB, MBBI, StackPtr, -(int64_t)NumBytes, Is64Bit, IsLP64,
Eric Christopher76ad43c2012-10-03 08:10:01 +0000924 UseLEA, TII, *RegInfo);
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000925
926 if (isEAXAlive) {
927 // Restore EAX
928 MachineInstr *MI = addRegOffset(BuildMI(MF, DL, TII.get(X86::MOV32rm),
929 X86::EAX),
930 StackPtr, false, NumBytes - 4);
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000931 MI->setFlag(MachineInstr::FrameSetup);
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000932 MBB.insert(MBBI, MI);
933 }
Anton Korobeynikov33464912010-11-15 00:06:54 +0000934 } else if (NumBytes)
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000935 emitSPUpdate(MBB, MBBI, StackPtr, -(int64_t)NumBytes, Is64Bit, IsLP64,
Eric Christopher76ad43c2012-10-03 08:10:01 +0000936 UseLEA, TII, *RegInfo);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000937
Chad Rosier3f0dbab2012-07-10 17:45:53 +0000938 // If we need a base pointer, set it up here. It's whatever the value
939 // of the stack pointer is at this point. Any variable size objects
940 // will be allocated after this, so we can still use the base pointer
941 // to reference locals.
942 if (RegInfo->hasBasePointer(MF)) {
943 // Update the frame pointer with the current stack pointer.
944 unsigned Opc = Is64Bit ? X86::MOV64rr : X86::MOV32rr;
945 BuildMI(MBB, MBBI, DL, TII.get(Opc), BasePtr)
946 .addReg(StackPtr)
947 .setMIFlag(MachineInstr::FrameSetup);
Chad Rosier3f0dbab2012-07-10 17:45:53 +0000948 }
949
Rafael Espindolaf0adba92011-04-15 15:11:06 +0000950 if (( (!HasFP && NumBytes) || PushedRegs) && needsFrameMoves) {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000951 // Mark end of stack pointer adjustment.
952 MCSymbol *Label = MMI.getContext().CreateTempSymbol();
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000953 BuildMI(MBB, MBBI, DL, TII.get(X86::PROLOG_LABEL))
954 .addSym(Label);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000955
956 if (!HasFP && NumBytes) {
957 // Define the current CFA rule to use the provided offset.
Rafael Espindola377b2272013-05-15 22:27:35 +0000958 assert(StackSize);
959 MachineLocation SPDst(MachineLocation::VirtualFP);
960 MachineLocation SPSrc(MachineLocation::VirtualFP,
961 -StackSize + stackGrowth);
962 MMI.addFrameMove(Label, SPDst, SPSrc);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000963 }
964
965 // Emit DWARF info specifying the offsets of the callee-saved registers.
966 if (PushedRegs)
967 emitCalleeSavedFrameMoves(MF, Label, HasFP ? FramePtr : StackPtr);
968 }
Bill Wendling09b02c82011-07-25 18:00:28 +0000969
970 // Darwin 10.7 and greater has support for compact unwind encoding.
Bill Wendlingc8725d12011-09-06 23:47:14 +0000971 if (STI.getTargetTriple().isMacOSX() &&
Eli Friedmanac86d432011-08-31 16:19:51 +0000972 !STI.getTargetTriple().isMacOSXVersionLT(10, 7))
Bill Wendling09b02c82011-07-25 18:00:28 +0000973 MMI.setCompactUnwindEncoding(getCompactUnwindEncoding(MF));
Anton Korobeynikov33464912010-11-15 00:06:54 +0000974}
975
Anton Korobeynikov16c29b52011-01-10 12:39:04 +0000976void X86FrameLowering::emitEpilogue(MachineFunction &MF,
Nick Lewycky3c2f0a12011-06-14 03:23:52 +0000977 MachineBasicBlock &MBB) const {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000978 const MachineFrameInfo *MFI = MF.getFrameInfo();
979 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
Anton Korobeynikovd9e33852010-11-18 23:25:52 +0000980 const X86RegisterInfo *RegInfo = TM.getRegisterInfo();
981 const X86InstrInfo &TII = *TM.getInstrInfo();
Jakob Stoklund Olesen4f28c1c2011-01-13 21:28:52 +0000982 MachineBasicBlock::iterator MBBI = MBB.getLastNonDebugInstr();
983 assert(MBBI != MBB.end() && "Returning block has no instructions");
Anton Korobeynikov33464912010-11-15 00:06:54 +0000984 unsigned RetOpcode = MBBI->getOpcode();
985 DebugLoc DL = MBBI->getDebugLoc();
986 bool Is64Bit = STI.is64Bit();
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000987 bool IsLP64 = STI.isTarget64BitLP64();
Evan Chengde1df102012-02-07 22:50:41 +0000988 bool UseLEA = STI.useLeaForSP();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000989 unsigned StackAlign = getStackAlignment();
990 unsigned SlotSize = RegInfo->getSlotSize();
991 unsigned FramePtr = RegInfo->getFrameRegister(MF);
992 unsigned StackPtr = RegInfo->getStackRegister();
993
994 switch (RetOpcode) {
995 default:
996 llvm_unreachable("Can only insert epilog into returning blocks");
997 case X86::RET:
998 case X86::RETI:
999 case X86::TCRETURNdi:
1000 case X86::TCRETURNri:
1001 case X86::TCRETURNmi:
1002 case X86::TCRETURNdi64:
1003 case X86::TCRETURNri64:
1004 case X86::TCRETURNmi64:
1005 case X86::EH_RETURN:
1006 case X86::EH_RETURN64:
1007 break; // These are ok
1008 }
1009
1010 // Get the number of bytes to allocate from the FrameInfo.
1011 uint64_t StackSize = MFI->getStackSize();
1012 uint64_t MaxAlign = MFI->getMaxAlignment();
1013 unsigned CSSize = X86FI->getCalleeSavedFrameSize();
1014 uint64_t NumBytes = 0;
1015
1016 // If we're forcing a stack realignment we can't rely on just the frame
1017 // info, we need to know the ABI stack alignment as well in case we
1018 // have a call out. Otherwise just make sure we have some alignment - we'll
1019 // go with the minimum.
1020 if (ForceStackAlign) {
1021 if (MFI->hasCalls())
1022 MaxAlign = (StackAlign > MaxAlign) ? StackAlign : MaxAlign;
1023 else
1024 MaxAlign = MaxAlign ? MaxAlign : 4;
1025 }
1026
Anton Korobeynikovd0c38172010-11-18 21:19:35 +00001027 if (hasFP(MF)) {
Anton Korobeynikov33464912010-11-15 00:06:54 +00001028 // Calculate required stack adjustment.
1029 uint64_t FrameSize = StackSize - SlotSize;
Alexey Samsonov99a92f22012-07-16 06:54:09 +00001030 if (RegInfo->needsStackRealignment(MF)) {
1031 // Callee-saved registers were pushed on stack before the stack
1032 // was realigned.
1033 FrameSize -= CSSize;
1034 NumBytes = (FrameSize + MaxAlign - 1) / MaxAlign * MaxAlign;
1035 } else {
1036 NumBytes = FrameSize - CSSize;
1037 }
Anton Korobeynikov33464912010-11-15 00:06:54 +00001038
1039 // Pop EBP.
1040 BuildMI(MBB, MBBI, DL,
1041 TII.get(Is64Bit ? X86::POP64r : X86::POP32r), FramePtr);
1042 } else {
1043 NumBytes = StackSize - CSSize;
1044 }
1045
1046 // Skip the callee-saved pop instructions.
Anton Korobeynikov33464912010-11-15 00:06:54 +00001047 while (MBBI != MBB.begin()) {
1048 MachineBasicBlock::iterator PI = prior(MBBI);
1049 unsigned Opc = PI->getOpcode();
1050
Jakob Stoklund Olesen4f28c1c2011-01-13 21:28:52 +00001051 if (Opc != X86::POP32r && Opc != X86::POP64r && Opc != X86::DBG_VALUE &&
Evan Cheng5a96b3d2011-12-07 07:15:52 +00001052 !PI->isTerminator())
Anton Korobeynikov33464912010-11-15 00:06:54 +00001053 break;
1054
1055 --MBBI;
1056 }
Alexey Samsonov99a92f22012-07-16 06:54:09 +00001057 MachineBasicBlock::iterator FirstCSPop = MBBI;
Anton Korobeynikov33464912010-11-15 00:06:54 +00001058
1059 DL = MBBI->getDebugLoc();
1060
1061 // If there is an ADD32ri or SUB32ri of ESP immediately before this
1062 // instruction, merge the two instructions.
1063 if (NumBytes || MFI->hasVarSizedObjects())
1064 mergeSPUpdatesUp(MBB, MBBI, StackPtr, &NumBytes);
1065
1066 // If dynamic alloca is used, then reset esp to point to the last callee-saved
1067 // slot before popping them off! Same applies for the case, when stack was
1068 // realigned.
Alexey Samsonov99a92f22012-07-16 06:54:09 +00001069 if (RegInfo->needsStackRealignment(MF) || MFI->hasVarSizedObjects()) {
1070 if (RegInfo->needsStackRealignment(MF))
1071 MBBI = FirstCSPop;
1072 if (CSSize != 0) {
Eli Bendersky16221a62013-02-06 20:43:57 +00001073 unsigned Opc = getLEArOpcode(IsLP64);
Alexey Samsonov99a92f22012-07-16 06:54:09 +00001074 addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr),
1075 FramePtr, false, -CSSize);
Anton Korobeynikov33464912010-11-15 00:06:54 +00001076 } else {
Alexey Samsonov99a92f22012-07-16 06:54:09 +00001077 unsigned Opc = (Is64Bit ? X86::MOV64rr : X86::MOV32rr);
1078 BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr)
Anton Korobeynikov33464912010-11-15 00:06:54 +00001079 .addReg(FramePtr);
1080 }
1081 } else if (NumBytes) {
1082 // Adjust stack pointer back: ESP += numbytes.
Eli Bendersky2a1b60d2013-02-05 21:53:29 +00001083 emitSPUpdate(MBB, MBBI, StackPtr, NumBytes, Is64Bit, IsLP64, UseLEA,
1084 TII, *RegInfo);
Anton Korobeynikov33464912010-11-15 00:06:54 +00001085 }
1086
1087 // We're returning from function via eh_return.
1088 if (RetOpcode == X86::EH_RETURN || RetOpcode == X86::EH_RETURN64) {
Jakob Stoklund Olesen4f28c1c2011-01-13 21:28:52 +00001089 MBBI = MBB.getLastNonDebugInstr();
Anton Korobeynikov33464912010-11-15 00:06:54 +00001090 MachineOperand &DestAddr = MBBI->getOperand(0);
1091 assert(DestAddr.isReg() && "Offset should be in register!");
1092 BuildMI(MBB, MBBI, DL,
1093 TII.get(Is64Bit ? X86::MOV64rr : X86::MOV32rr),
1094 StackPtr).addReg(DestAddr.getReg());
1095 } else if (RetOpcode == X86::TCRETURNri || RetOpcode == X86::TCRETURNdi ||
1096 RetOpcode == X86::TCRETURNmi ||
1097 RetOpcode == X86::TCRETURNri64 || RetOpcode == X86::TCRETURNdi64 ||
1098 RetOpcode == X86::TCRETURNmi64) {
1099 bool isMem = RetOpcode == X86::TCRETURNmi || RetOpcode == X86::TCRETURNmi64;
1100 // Tail call return: adjust the stack pointer and jump to callee.
Jakob Stoklund Olesenf7ca9762011-01-13 22:47:43 +00001101 MBBI = MBB.getLastNonDebugInstr();
Anton Korobeynikov33464912010-11-15 00:06:54 +00001102 MachineOperand &JumpTarget = MBBI->getOperand(0);
1103 MachineOperand &StackAdjust = MBBI->getOperand(isMem ? 5 : 1);
1104 assert(StackAdjust.isImm() && "Expecting immediate value.");
1105
1106 // Adjust stack pointer.
1107 int StackAdj = StackAdjust.getImm();
1108 int MaxTCDelta = X86FI->getTCReturnAddrDelta();
1109 int Offset = 0;
1110 assert(MaxTCDelta <= 0 && "MaxTCDelta should never be positive");
1111
1112 // Incoporate the retaddr area.
1113 Offset = StackAdj-MaxTCDelta;
1114 assert(Offset >= 0 && "Offset should never be negative");
1115
1116 if (Offset) {
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001117 // Check for possible merge with preceding ADD instruction.
Anton Korobeynikov33464912010-11-15 00:06:54 +00001118 Offset += mergeSPUpdates(MBB, MBBI, StackPtr, true);
Eli Bendersky2a1b60d2013-02-05 21:53:29 +00001119 emitSPUpdate(MBB, MBBI, StackPtr, Offset, Is64Bit, IsLP64,
1120 UseLEA, TII, *RegInfo);
Anton Korobeynikov33464912010-11-15 00:06:54 +00001121 }
1122
1123 // Jump to label or value in register.
1124 if (RetOpcode == X86::TCRETURNdi || RetOpcode == X86::TCRETURNdi64) {
Evan Cheng3d2125c2010-11-30 23:55:39 +00001125 MachineInstrBuilder MIB =
1126 BuildMI(MBB, MBBI, DL, TII.get((RetOpcode == X86::TCRETURNdi)
1127 ? X86::TAILJMPd : X86::TAILJMPd64));
1128 if (JumpTarget.isGlobal())
1129 MIB.addGlobalAddress(JumpTarget.getGlobal(), JumpTarget.getOffset(),
1130 JumpTarget.getTargetFlags());
1131 else {
1132 assert(JumpTarget.isSymbol());
1133 MIB.addExternalSymbol(JumpTarget.getSymbolName(),
1134 JumpTarget.getTargetFlags());
1135 }
Anton Korobeynikov33464912010-11-15 00:06:54 +00001136 } else if (RetOpcode == X86::TCRETURNmi || RetOpcode == X86::TCRETURNmi64) {
1137 MachineInstrBuilder MIB =
1138 BuildMI(MBB, MBBI, DL, TII.get((RetOpcode == X86::TCRETURNmi)
1139 ? X86::TAILJMPm : X86::TAILJMPm64));
1140 for (unsigned i = 0; i != 5; ++i)
1141 MIB.addOperand(MBBI->getOperand(i));
1142 } else if (RetOpcode == X86::TCRETURNri64) {
1143 BuildMI(MBB, MBBI, DL, TII.get(X86::TAILJMPr64)).
1144 addReg(JumpTarget.getReg(), RegState::Kill);
1145 } else {
1146 BuildMI(MBB, MBBI, DL, TII.get(X86::TAILJMPr)).
1147 addReg(JumpTarget.getReg(), RegState::Kill);
1148 }
1149
1150 MachineInstr *NewMI = prior(MBBI);
Jakob Stoklund Olesenbe06aac2012-12-20 22:54:02 +00001151 NewMI->copyImplicitOps(MF, MBBI);
Anton Korobeynikov33464912010-11-15 00:06:54 +00001152
1153 // Delete the pseudo instruction TCRETURN.
1154 MBB.erase(MBBI);
1155 } else if ((RetOpcode == X86::RET || RetOpcode == X86::RETI) &&
1156 (X86FI->getTCReturnAddrDelta() < 0)) {
1157 // Add the return addr area delta back since we are not tail calling.
1158 int delta = -1*X86FI->getTCReturnAddrDelta();
Jakob Stoklund Olesen4f28c1c2011-01-13 21:28:52 +00001159 MBBI = MBB.getLastNonDebugInstr();
Anton Korobeynikov33464912010-11-15 00:06:54 +00001160
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001161 // Check for possible merge with preceding ADD instruction.
Anton Korobeynikov33464912010-11-15 00:06:54 +00001162 delta += mergeSPUpdates(MBB, MBBI, StackPtr, true);
Eli Bendersky2a1b60d2013-02-05 21:53:29 +00001163 emitSPUpdate(MBB, MBBI, StackPtr, delta, Is64Bit, IsLP64, UseLEA, TII,
1164 *RegInfo);
Anton Korobeynikov33464912010-11-15 00:06:54 +00001165 }
1166}
Anton Korobeynikovd9e33852010-11-18 23:25:52 +00001167
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00001168int X86FrameLowering::getFrameIndexOffset(const MachineFunction &MF, int FI) const {
Chad Rosier3fb6eca2012-05-23 23:45:10 +00001169 const X86RegisterInfo *RegInfo =
Anton Korobeynikov82f58742010-11-20 15:59:32 +00001170 static_cast<const X86RegisterInfo*>(MF.getTarget().getRegisterInfo());
1171 const MachineFrameInfo *MFI = MF.getFrameInfo();
1172 int Offset = MFI->getObjectOffset(FI) - getOffsetOfLocalArea();
1173 uint64_t StackSize = MFI->getStackSize();
1174
Chad Rosier3f0dbab2012-07-10 17:45:53 +00001175 if (RegInfo->hasBasePointer(MF)) {
1176 assert (hasFP(MF) && "VLAs and dynamic stack realign, but no FP?!");
1177 if (FI < 0) {
1178 // Skip the saved EBP.
1179 return Offset + RegInfo->getSlotSize();
1180 } else {
1181 assert((-(Offset + StackSize)) % MFI->getObjectAlignment(FI) == 0);
1182 return Offset + StackSize;
1183 }
1184 } else if (RegInfo->needsStackRealignment(MF)) {
Anton Korobeynikov82f58742010-11-20 15:59:32 +00001185 if (FI < 0) {
1186 // Skip the saved EBP.
Chad Rosier3fb6eca2012-05-23 23:45:10 +00001187 return Offset + RegInfo->getSlotSize();
Anton Korobeynikov82f58742010-11-20 15:59:32 +00001188 } else {
Duncan Sands17001ce2011-10-18 12:44:00 +00001189 assert((-(Offset + StackSize)) % MFI->getObjectAlignment(FI) == 0);
Anton Korobeynikov82f58742010-11-20 15:59:32 +00001190 return Offset + StackSize;
1191 }
1192 // FIXME: Support tail calls
1193 } else {
1194 if (!hasFP(MF))
1195 return Offset + StackSize;
1196
1197 // Skip the saved EBP.
Chad Rosier3fb6eca2012-05-23 23:45:10 +00001198 Offset += RegInfo->getSlotSize();
Anton Korobeynikov82f58742010-11-20 15:59:32 +00001199
1200 // Skip the RETADDR move area
1201 const X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1202 int TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
1203 if (TailCallReturnAddrDelta < 0)
1204 Offset -= TailCallReturnAddrDelta;
1205 }
1206
1207 return Offset;
1208}
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001209
Alexey Samsonovd07d06c2012-05-01 15:16:06 +00001210int X86FrameLowering::getFrameIndexReference(const MachineFunction &MF, int FI,
1211 unsigned &FrameReg) const {
Chad Rosier3fb6eca2012-05-23 23:45:10 +00001212 const X86RegisterInfo *RegInfo =
Alexey Samsonovd07d06c2012-05-01 15:16:06 +00001213 static_cast<const X86RegisterInfo*>(MF.getTarget().getRegisterInfo());
1214 // We can't calculate offset from frame pointer if the stack is realigned,
Chad Rosier3f0dbab2012-07-10 17:45:53 +00001215 // so enforce usage of stack/base pointer. The base pointer is used when we
1216 // have dynamic allocas in addition to dynamic realignment.
1217 if (RegInfo->hasBasePointer(MF))
1218 FrameReg = RegInfo->getBaseRegister();
1219 else if (RegInfo->needsStackRealignment(MF))
1220 FrameReg = RegInfo->getStackRegister();
1221 else
1222 FrameReg = RegInfo->getFrameRegister(MF);
Alexey Samsonovd07d06c2012-05-01 15:16:06 +00001223 return getFrameIndexOffset(MF, FI);
1224}
1225
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00001226bool X86FrameLowering::spillCalleeSavedRegisters(MachineBasicBlock &MBB,
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001227 MachineBasicBlock::iterator MI,
1228 const std::vector<CalleeSavedInfo> &CSI,
1229 const TargetRegisterInfo *TRI) const {
1230 if (CSI.empty())
1231 return false;
1232
1233 DebugLoc DL = MBB.findDebugLoc(MI);
1234
1235 MachineFunction &MF = *MBB.getParent();
1236
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001237 unsigned SlotSize = STI.is64Bit() ? 8 : 4;
1238 unsigned FPReg = TRI->getFrameRegister(MF);
1239 unsigned CalleeFrameSize = 0;
1240
1241 const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
1242 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1243
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001244 // Push GPRs. It increases frame size.
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001245 unsigned Opc = STI.is64Bit() ? X86::PUSH64r : X86::PUSH32r;
1246 for (unsigned i = CSI.size(); i != 0; --i) {
1247 unsigned Reg = CSI[i-1].getReg();
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001248 if (!X86::GR64RegClass.contains(Reg) &&
1249 !X86::GR32RegClass.contains(Reg))
1250 continue;
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001251 // Add the callee-saved register as live-in. It's killed at the spill.
1252 MBB.addLiveIn(Reg);
1253 if (Reg == FPReg)
1254 // X86RegisterInfo::emitPrologue will handle spilling of frame register.
1255 continue;
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001256 CalleeFrameSize += SlotSize;
Charles Davisaff232a2011-06-12 01:45:54 +00001257 BuildMI(MBB, MI, DL, TII.get(Opc)).addReg(Reg, RegState::Kill)
1258 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001259 }
1260
1261 X86FI->setCalleeSavedFrameSize(CalleeFrameSize);
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001262
1263 // Make XMM regs spilled. X86 does not have ability of push/pop XMM.
1264 // It can be done by spilling XMMs to stack frame.
1265 // Note that only Win64 ABI might spill XMMs.
1266 for (unsigned i = CSI.size(); i != 0; --i) {
1267 unsigned Reg = CSI[i-1].getReg();
1268 if (X86::GR64RegClass.contains(Reg) ||
1269 X86::GR32RegClass.contains(Reg))
1270 continue;
1271 // Add the callee-saved register as live-in. It's killed at the spill.
1272 MBB.addLiveIn(Reg);
1273 const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
1274 TII.storeRegToStackSlot(MBB, MI, Reg, true, CSI[i-1].getFrameIdx(),
1275 RC, TRI);
1276 }
1277
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001278 return true;
1279}
1280
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00001281bool X86FrameLowering::restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001282 MachineBasicBlock::iterator MI,
1283 const std::vector<CalleeSavedInfo> &CSI,
1284 const TargetRegisterInfo *TRI) const {
1285 if (CSI.empty())
1286 return false;
1287
1288 DebugLoc DL = MBB.findDebugLoc(MI);
1289
1290 MachineFunction &MF = *MBB.getParent();
1291 const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001292
1293 // Reload XMMs from stack frame.
1294 for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1295 unsigned Reg = CSI[i].getReg();
1296 if (X86::GR64RegClass.contains(Reg) ||
1297 X86::GR32RegClass.contains(Reg))
1298 continue;
1299 const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
1300 TII.loadRegFromStackSlot(MBB, MI, Reg, CSI[i].getFrameIdx(),
1301 RC, TRI);
1302 }
1303
1304 // POP GPRs.
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001305 unsigned FPReg = TRI->getFrameRegister(MF);
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001306 unsigned Opc = STI.is64Bit() ? X86::POP64r : X86::POP32r;
1307 for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1308 unsigned Reg = CSI[i].getReg();
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001309 if (!X86::GR64RegClass.contains(Reg) &&
1310 !X86::GR32RegClass.contains(Reg))
1311 continue;
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001312 if (Reg == FPReg)
1313 // X86RegisterInfo::emitEpilogue will handle restoring of frame register.
1314 continue;
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001315 BuildMI(MBB, MI, DL, TII.get(Opc), Reg);
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001316 }
1317 return true;
1318}
Anton Korobeynikov94c5ae02010-11-27 23:05:25 +00001319
1320void
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00001321X86FrameLowering::processFunctionBeforeCalleeSavedScan(MachineFunction &MF,
Anton Korobeynikov94c5ae02010-11-27 23:05:25 +00001322 RegScavenger *RS) const {
1323 MachineFrameInfo *MFI = MF.getFrameInfo();
1324 const X86RegisterInfo *RegInfo = TM.getRegisterInfo();
1325 unsigned SlotSize = RegInfo->getSlotSize();
1326
1327 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1328 int32_t TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
1329
1330 if (TailCallReturnAddrDelta < 0) {
1331 // create RETURNADDR area
1332 // arg
1333 // arg
1334 // RETADDR
1335 // { ...
1336 // RETADDR area
1337 // ...
1338 // }
1339 // [EBP]
1340 MFI->CreateFixedObject(-TailCallReturnAddrDelta,
1341 (-1U*SlotSize)+TailCallReturnAddrDelta, true);
1342 }
1343
1344 if (hasFP(MF)) {
1345 assert((TailCallReturnAddrDelta <= 0) &&
1346 "The Delta should always be zero or negative");
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00001347 const TargetFrameLowering &TFI = *MF.getTarget().getFrameLowering();
Anton Korobeynikov94c5ae02010-11-27 23:05:25 +00001348
1349 // Create a frame entry for the EBP register that must be saved.
1350 int FrameIdx = MFI->CreateFixedObject(SlotSize,
1351 -(int)SlotSize +
1352 TFI.getOffsetOfLocalArea() +
1353 TailCallReturnAddrDelta,
1354 true);
1355 assert(FrameIdx == MFI->getObjectIndexBegin() &&
1356 "Slot for EBP register must be last in order to be found!");
Duncan Sands17001ce2011-10-18 12:44:00 +00001357 (void)FrameIdx;
Anton Korobeynikov94c5ae02010-11-27 23:05:25 +00001358 }
Chad Rosier3f0dbab2012-07-10 17:45:53 +00001359
1360 // Spill the BasePtr if it's used.
1361 if (RegInfo->hasBasePointer(MF))
1362 MF.getRegInfo().setPhysRegUsed(RegInfo->getBaseRegister());
Anton Korobeynikov94c5ae02010-11-27 23:05:25 +00001363}
Rafael Espindola76927d752011-08-30 19:39:58 +00001364
1365static bool
1366HasNestArgument(const MachineFunction *MF) {
1367 const Function *F = MF->getFunction();
1368 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1369 I != E; I++) {
1370 if (I->hasNestAttr())
1371 return true;
1372 }
1373 return false;
1374}
1375
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001376/// GetScratchRegister - Get a temp register for performing work in the
1377/// segmented stack and the Erlang/HiPE stack prologue. Depending on platform
1378/// and the properties of the function either one or two registers will be
1379/// needed. Set primary to true for the first register, false for the second.
Rafael Espindola76927d752011-08-30 19:39:58 +00001380static unsigned
Rafael Espindola2028b792012-01-11 19:00:37 +00001381GetScratchRegister(bool Is64Bit, const MachineFunction &MF, bool Primary) {
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001382 CallingConv::ID CallingConvention = MF.getFunction()->getCallingConv();
1383
1384 // Erlang stuff.
1385 if (CallingConvention == CallingConv::HiPE) {
1386 if (Is64Bit)
1387 return Primary ? X86::R14 : X86::R13;
1388 else
1389 return Primary ? X86::EBX : X86::EDI;
1390 }
1391
David Blaikie4d6ccb52012-01-20 21:51:11 +00001392 if (Is64Bit)
Rafael Espindola2028b792012-01-11 19:00:37 +00001393 return Primary ? X86::R11 : X86::R12;
Rafael Espindola76927d752011-08-30 19:39:58 +00001394
David Blaikie4d6ccb52012-01-20 21:51:11 +00001395 bool IsNested = HasNestArgument(&MF);
1396
1397 if (CallingConvention == CallingConv::X86_FastCall ||
1398 CallingConvention == CallingConv::Fast) {
1399 if (IsNested)
1400 report_fatal_error("Segmented stacks does not support fastcall with "
1401 "nested function.");
1402 return Primary ? X86::EAX : X86::ECX;
Rafael Espindola76927d752011-08-30 19:39:58 +00001403 }
David Blaikie4d6ccb52012-01-20 21:51:11 +00001404 if (IsNested)
1405 return Primary ? X86::EDX : X86::EAX;
1406 return Primary ? X86::ECX : X86::EAX;
Rafael Espindola76927d752011-08-30 19:39:58 +00001407}
1408
Sanjoy Das199ce332011-12-03 09:32:07 +00001409// The stack limit in the TCB is set to this many bytes above the actual stack
1410// limit.
1411static const uint64_t kSplitStackAvailable = 256;
1412
Rafael Espindola76927d752011-08-30 19:39:58 +00001413void
1414X86FrameLowering::adjustForSegmentedStacks(MachineFunction &MF) const {
1415 MachineBasicBlock &prologueMBB = MF.front();
1416 MachineFrameInfo *MFI = MF.getFrameInfo();
1417 const X86InstrInfo &TII = *TM.getInstrInfo();
1418 uint64_t StackSize;
1419 bool Is64Bit = STI.is64Bit();
1420 unsigned TlsReg, TlsOffset;
1421 DebugLoc DL;
Rafael Espindola76927d752011-08-30 19:39:58 +00001422
Rafael Espindola2028b792012-01-11 19:00:37 +00001423 unsigned ScratchReg = GetScratchRegister(Is64Bit, MF, true);
Rafael Espindola76927d752011-08-30 19:39:58 +00001424 assert(!MF.getRegInfo().isLiveIn(ScratchReg) &&
1425 "Scratch register is live-in");
1426
1427 if (MF.getFunction()->isVarArg())
1428 report_fatal_error("Segmented stacks do not support vararg functions.");
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001429 if (!STI.isTargetLinux() && !STI.isTargetDarwin() &&
1430 !STI.isTargetWin32() && !STI.isTargetFreeBSD())
Rafael Espindola85b9d432012-01-12 20:24:30 +00001431 report_fatal_error("Segmented stacks not supported on this platform.");
Rafael Espindola76927d752011-08-30 19:39:58 +00001432
1433 MachineBasicBlock *allocMBB = MF.CreateMachineBasicBlock();
1434 MachineBasicBlock *checkMBB = MF.CreateMachineBasicBlock();
1435 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1436 bool IsNested = false;
1437
1438 // We need to know if the function has a nest argument only in 64 bit mode.
1439 if (Is64Bit)
1440 IsNested = HasNestArgument(&MF);
1441
Bill Wendling4e680542011-10-13 08:24:19 +00001442 // The MOV R10, RAX needs to be in a different block, since the RET we emit in
1443 // allocMBB needs to be last (terminating) instruction.
Bill Wendling4e680542011-10-13 08:24:19 +00001444
Rafael Espindola76927d752011-08-30 19:39:58 +00001445 for (MachineBasicBlock::livein_iterator i = prologueMBB.livein_begin(),
1446 e = prologueMBB.livein_end(); i != e; i++) {
1447 allocMBB->addLiveIn(*i);
1448 checkMBB->addLiveIn(*i);
1449 }
1450
1451 if (IsNested)
Rafael Espindolae840e882011-10-26 21:12:27 +00001452 allocMBB->addLiveIn(X86::R10);
1453
Rafael Espindola76927d752011-08-30 19:39:58 +00001454 MF.push_front(allocMBB);
1455 MF.push_front(checkMBB);
1456
1457 // Eventually StackSize will be calculated by a link-time pass; which will
1458 // also decide whether checking code needs to be injected into this particular
1459 // prologue.
1460 StackSize = MFI->getStackSize();
1461
Rafael Espindola2028b792012-01-11 19:00:37 +00001462 // When the frame size is less than 256 we just compare the stack
1463 // boundary directly to the value of the stack pointer, per gcc.
1464 bool CompareStackPointer = StackSize < kSplitStackAvailable;
1465
Rafael Espindola76927d752011-08-30 19:39:58 +00001466 // Read the limit off the current stacklet off the stack_guard location.
1467 if (Is64Bit) {
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001468 if (STI.isTargetLinux()) {
Rafael Espindola2028b792012-01-11 19:00:37 +00001469 TlsReg = X86::FS;
1470 TlsOffset = 0x70;
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001471 } else if (STI.isTargetDarwin()) {
Rafael Espindola2028b792012-01-11 19:00:37 +00001472 TlsReg = X86::GS;
1473 TlsOffset = 0x60 + 90*8; // See pthread_machdep.h. Steal TLS slot 90.
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001474 } else if (STI.isTargetFreeBSD()) {
Rafael Espindola85b9d432012-01-12 20:24:30 +00001475 TlsReg = X86::FS;
1476 TlsOffset = 0x18;
Rafael Espindolae4d18de2012-01-12 20:22:08 +00001477 } else {
1478 report_fatal_error("Segmented stacks not supported on this platform.");
Rafael Espindola2028b792012-01-11 19:00:37 +00001479 }
Rafael Espindola76927d752011-08-30 19:39:58 +00001480
Rafael Espindola2028b792012-01-11 19:00:37 +00001481 if (CompareStackPointer)
Sanjoy Das199ce332011-12-03 09:32:07 +00001482 ScratchReg = X86::RSP;
1483 else
1484 BuildMI(checkMBB, DL, TII.get(X86::LEA64r), ScratchReg).addReg(X86::RSP)
Rafael Espindola014f7a32012-01-11 18:14:03 +00001485 .addImm(1).addReg(0).addImm(-StackSize).addReg(0);
Sanjoy Das199ce332011-12-03 09:32:07 +00001486
Rafael Espindola76927d752011-08-30 19:39:58 +00001487 BuildMI(checkMBB, DL, TII.get(X86::CMP64rm)).addReg(ScratchReg)
Rafael Espindola014f7a32012-01-11 18:14:03 +00001488 .addReg(0).addImm(1).addReg(0).addImm(TlsOffset).addReg(TlsReg);
Rafael Espindola76927d752011-08-30 19:39:58 +00001489 } else {
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001490 if (STI.isTargetLinux()) {
Rafael Espindolae4d18de2012-01-12 20:22:08 +00001491 TlsReg = X86::GS;
1492 TlsOffset = 0x30;
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001493 } else if (STI.isTargetDarwin()) {
Rafael Espindolae4d18de2012-01-12 20:22:08 +00001494 TlsReg = X86::GS;
1495 TlsOffset = 0x48 + 90*4;
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001496 } else if (STI.isTargetWin32()) {
Rafael Espindolae4d18de2012-01-12 20:22:08 +00001497 TlsReg = X86::FS;
1498 TlsOffset = 0x14; // pvArbitrary, reserved for application use
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001499 } else if (STI.isTargetFreeBSD()) {
Rafael Espindola85b9d432012-01-12 20:24:30 +00001500 report_fatal_error("Segmented stacks not supported on FreeBSD i386.");
Rafael Espindolae4d18de2012-01-12 20:22:08 +00001501 } else {
1502 report_fatal_error("Segmented stacks not supported on this platform.");
1503 }
Rafael Espindola76927d752011-08-30 19:39:58 +00001504
Rafael Espindola2028b792012-01-11 19:00:37 +00001505 if (CompareStackPointer)
Sanjoy Das199ce332011-12-03 09:32:07 +00001506 ScratchReg = X86::ESP;
1507 else
1508 BuildMI(checkMBB, DL, TII.get(X86::LEA32r), ScratchReg).addReg(X86::ESP)
Rafael Espindola014f7a32012-01-11 18:14:03 +00001509 .addImm(1).addReg(0).addImm(-StackSize).addReg(0);
Sanjoy Das199ce332011-12-03 09:32:07 +00001510
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001511 if (STI.isTargetLinux() || STI.isTargetWin32()) {
Rafael Espindola2028b792012-01-11 19:00:37 +00001512 BuildMI(checkMBB, DL, TII.get(X86::CMP32rm)).addReg(ScratchReg)
1513 .addReg(0).addImm(0).addReg(0).addImm(TlsOffset).addReg(TlsReg);
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001514 } else if (STI.isTargetDarwin()) {
Rafael Espindola2028b792012-01-11 19:00:37 +00001515
1516 // TlsOffset doesn't fit into a mod r/m byte so we need an extra register
1517 unsigned ScratchReg2;
1518 bool SaveScratch2;
1519 if (CompareStackPointer) {
1520 // The primary scratch register is available for holding the TLS offset
1521 ScratchReg2 = GetScratchRegister(Is64Bit, MF, true);
1522 SaveScratch2 = false;
1523 } else {
1524 // Need to use a second register to hold the TLS offset
1525 ScratchReg2 = GetScratchRegister(Is64Bit, MF, false);
1526
1527 // Unfortunately, with fastcc the second scratch register may hold an arg
1528 SaveScratch2 = MF.getRegInfo().isLiveIn(ScratchReg2);
1529 }
1530
1531 // If Scratch2 is live-in then it needs to be saved
1532 assert((!MF.getRegInfo().isLiveIn(ScratchReg2) || SaveScratch2) &&
1533 "Scratch register is live-in and not saved");
1534
1535 if (SaveScratch2)
1536 BuildMI(checkMBB, DL, TII.get(X86::PUSH32r))
1537 .addReg(ScratchReg2, RegState::Kill);
1538
1539 BuildMI(checkMBB, DL, TII.get(X86::MOV32ri), ScratchReg2)
1540 .addImm(TlsOffset);
1541 BuildMI(checkMBB, DL, TII.get(X86::CMP32rm))
1542 .addReg(ScratchReg)
1543 .addReg(ScratchReg2).addImm(1).addReg(0)
1544 .addImm(0)
1545 .addReg(TlsReg);
1546
1547 if (SaveScratch2)
1548 BuildMI(checkMBB, DL, TII.get(X86::POP32r), ScratchReg2);
1549 }
Rafael Espindola76927d752011-08-30 19:39:58 +00001550 }
1551
1552 // This jump is taken if SP >= (Stacklet Limit + Stack Space required).
1553 // It jumps to normal execution of the function body.
Rafael Espindola313c7032012-01-11 18:23:35 +00001554 BuildMI(checkMBB, DL, TII.get(X86::JA_4)).addMBB(&prologueMBB);
Rafael Espindola76927d752011-08-30 19:39:58 +00001555
1556 // On 32 bit we first push the arguments size and then the frame size. On 64
1557 // bit, we pass the stack frame size in r10 and the argument size in r11.
1558 if (Is64Bit) {
1559 // Functions with nested arguments use R10, so it needs to be saved across
1560 // the call to _morestack
1561
1562 if (IsNested)
1563 BuildMI(allocMBB, DL, TII.get(X86::MOV64rr), X86::RAX).addReg(X86::R10);
1564
1565 BuildMI(allocMBB, DL, TII.get(X86::MOV64ri), X86::R10)
1566 .addImm(StackSize);
1567 BuildMI(allocMBB, DL, TII.get(X86::MOV64ri), X86::R11)
1568 .addImm(X86FI->getArgumentStackSize());
1569 MF.getRegInfo().setPhysRegUsed(X86::R10);
1570 MF.getRegInfo().setPhysRegUsed(X86::R11);
1571 } else {
Rafael Espindola76927d752011-08-30 19:39:58 +00001572 BuildMI(allocMBB, DL, TII.get(X86::PUSHi32))
1573 .addImm(X86FI->getArgumentStackSize());
1574 BuildMI(allocMBB, DL, TII.get(X86::PUSHi32))
1575 .addImm(StackSize);
1576 }
1577
1578 // __morestack is in libgcc
1579 if (Is64Bit)
1580 BuildMI(allocMBB, DL, TII.get(X86::CALL64pcrel32))
1581 .addExternalSymbol("__morestack");
1582 else
1583 BuildMI(allocMBB, DL, TII.get(X86::CALLpcrel32))
1584 .addExternalSymbol("__morestack");
1585
Bill Wendling4e680542011-10-13 08:24:19 +00001586 if (IsNested)
Rafael Espindolae840e882011-10-26 21:12:27 +00001587 BuildMI(allocMBB, DL, TII.get(X86::MORESTACK_RET_RESTORE_R10));
1588 else
1589 BuildMI(allocMBB, DL, TII.get(X86::MORESTACK_RET));
Bill Wendling4e680542011-10-13 08:24:19 +00001590
Rafael Espindolae840e882011-10-26 21:12:27 +00001591 allocMBB->addSuccessor(&prologueMBB);
Bill Wendling4e680542011-10-13 08:24:19 +00001592
Rafael Espindola76927d752011-08-30 19:39:58 +00001593 checkMBB->addSuccessor(allocMBB);
1594 checkMBB->addSuccessor(&prologueMBB);
1595
Jakob Stoklund Olesen51f0c762011-09-24 01:11:19 +00001596#ifdef XDEBUG
Rafael Espindola76927d752011-08-30 19:39:58 +00001597 MF.verify();
1598#endif
1599}
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001600
Yiannis Tsiouris2d1035d2013-02-28 16:59:10 +00001601/// Erlang programs may need a special prologue to handle the stack size they
1602/// might need at runtime. That is because Erlang/OTP does not implement a C
1603/// stack but uses a custom implementation of hybrid stack/heap architecture.
1604/// (for more information see Eric Stenman's Ph.D. thesis:
1605/// http://publications.uu.se/uu/fulltext/nbn_se_uu_diva-2688.pdf)
1606///
1607/// CheckStack:
1608/// temp0 = sp - MaxStack
1609/// if( temp0 < SP_LIMIT(P) ) goto IncStack else goto OldStart
1610/// OldStart:
1611/// ...
1612/// IncStack:
1613/// call inc_stack # doubles the stack space
1614/// temp0 = sp - MaxStack
1615/// if( temp0 < SP_LIMIT(P) ) goto IncStack else goto OldStart
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001616void X86FrameLowering::adjustForHiPEPrologue(MachineFunction &MF) const {
1617 const X86InstrInfo &TII = *TM.getInstrInfo();
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001618 MachineFrameInfo *MFI = MF.getFrameInfo();
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001619 const unsigned SlotSize = TM.getRegisterInfo()->getSlotSize();
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001620 const bool Is64Bit = STI.is64Bit();
1621 DebugLoc DL;
1622 // HiPE-specific values
1623 const unsigned HipeLeafWords = 24;
1624 const unsigned CCRegisteredArgs = Is64Bit ? 6 : 5;
1625 const unsigned Guaranteed = HipeLeafWords * SlotSize;
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001626 unsigned CallerStkArity = MF.getFunction()->arg_size() > CCRegisteredArgs ?
1627 MF.getFunction()->arg_size() - CCRegisteredArgs : 0;
1628 unsigned MaxStack = MFI->getStackSize() + CallerStkArity*SlotSize + SlotSize;
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001629
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001630 assert(STI.isTargetLinux() &&
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001631 "HiPE prologue is only supported on Linux operating systems.");
1632
1633 // Compute the largest caller's frame that is needed to fit the callees'
1634 // frames. This 'MaxStack' is computed from:
1635 //
1636 // a) the fixed frame size, which is the space needed for all spilled temps,
1637 // b) outgoing on-stack parameter areas, and
1638 // c) the minimum stack space this function needs to make available for the
1639 // functions it calls (a tunable ABI property).
1640 if (MFI->hasCalls()) {
1641 unsigned MoreStackForCalls = 0;
1642
1643 for (MachineFunction::iterator MBBI = MF.begin(), MBBE = MF.end();
1644 MBBI != MBBE; ++MBBI)
1645 for (MachineBasicBlock::iterator MI = MBBI->begin(), ME = MBBI->end();
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001646 MI != ME; ++MI) {
1647 if (!MI->isCall())
1648 continue;
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001649
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001650 // Get callee operand.
1651 const MachineOperand &MO = MI->getOperand(0);
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001652
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001653 // Only take account of global function calls (no closures etc.).
1654 if (!MO.isGlobal())
1655 continue;
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001656
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001657 const Function *F = dyn_cast<Function>(MO.getGlobal());
1658 if (!F)
1659 continue;
1660
1661 // Do not update 'MaxStack' for primitive and built-in functions
1662 // (encoded with names either starting with "erlang."/"bif_" or not
1663 // having a ".", such as a simple <Module>.<Function>.<Arity>, or an
1664 // "_", such as the BIF "suspend_0") as they are executed on another
1665 // stack.
1666 if (F->getName().find("erlang.") != StringRef::npos ||
1667 F->getName().find("bif_") != StringRef::npos ||
1668 F->getName().find_first_of("._") == StringRef::npos)
1669 continue;
1670
1671 unsigned CalleeStkArity =
1672 F->arg_size() > CCRegisteredArgs ? F->arg_size()-CCRegisteredArgs : 0;
1673 if (HipeLeafWords - 1 > CalleeStkArity)
1674 MoreStackForCalls = std::max(MoreStackForCalls,
1675 (HipeLeafWords - 1 - CalleeStkArity) * SlotSize);
1676 }
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001677 MaxStack += MoreStackForCalls;
1678 }
1679
1680 // If the stack frame needed is larger than the guaranteed then runtime checks
1681 // and calls to "inc_stack_0" BIF should be inserted in the assembly prologue.
1682 if (MaxStack > Guaranteed) {
1683 MachineBasicBlock &prologueMBB = MF.front();
1684 MachineBasicBlock *stackCheckMBB = MF.CreateMachineBasicBlock();
1685 MachineBasicBlock *incStackMBB = MF.CreateMachineBasicBlock();
1686
1687 for (MachineBasicBlock::livein_iterator I = prologueMBB.livein_begin(),
1688 E = prologueMBB.livein_end(); I != E; I++) {
1689 stackCheckMBB->addLiveIn(*I);
1690 incStackMBB->addLiveIn(*I);
1691 }
1692
1693 MF.push_front(incStackMBB);
1694 MF.push_front(stackCheckMBB);
1695
1696 unsigned ScratchReg, SPReg, PReg, SPLimitOffset;
1697 unsigned LEAop, CMPop, CALLop;
1698 if (Is64Bit) {
1699 SPReg = X86::RSP;
1700 PReg = X86::RBP;
1701 LEAop = X86::LEA64r;
1702 CMPop = X86::CMP64rm;
1703 CALLop = X86::CALL64pcrel32;
1704 SPLimitOffset = 0x90;
1705 } else {
1706 SPReg = X86::ESP;
1707 PReg = X86::EBP;
1708 LEAop = X86::LEA32r;
1709 CMPop = X86::CMP32rm;
1710 CALLop = X86::CALLpcrel32;
1711 SPLimitOffset = 0x4c;
1712 }
1713
1714 ScratchReg = GetScratchRegister(Is64Bit, MF, true);
1715 assert(!MF.getRegInfo().isLiveIn(ScratchReg) &&
1716 "HiPE prologue scratch register is live-in");
1717
1718 // Create new MBB for StackCheck:
1719 addRegOffset(BuildMI(stackCheckMBB, DL, TII.get(LEAop), ScratchReg),
1720 SPReg, false, -MaxStack);
1721 // SPLimitOffset is in a fixed heap location (pointed by BP).
1722 addRegOffset(BuildMI(stackCheckMBB, DL, TII.get(CMPop))
1723 .addReg(ScratchReg), PReg, false, SPLimitOffset);
1724 BuildMI(stackCheckMBB, DL, TII.get(X86::JAE_4)).addMBB(&prologueMBB);
1725
1726 // Create new MBB for IncStack:
1727 BuildMI(incStackMBB, DL, TII.get(CALLop)).
1728 addExternalSymbol("inc_stack_0");
1729 addRegOffset(BuildMI(incStackMBB, DL, TII.get(LEAop), ScratchReg),
1730 SPReg, false, -MaxStack);
1731 addRegOffset(BuildMI(incStackMBB, DL, TII.get(CMPop))
1732 .addReg(ScratchReg), PReg, false, SPLimitOffset);
1733 BuildMI(incStackMBB, DL, TII.get(X86::JLE_4)).addMBB(incStackMBB);
1734
1735 stackCheckMBB->addSuccessor(&prologueMBB, 99);
1736 stackCheckMBB->addSuccessor(incStackMBB, 1);
1737 incStackMBB->addSuccessor(&prologueMBB, 99);
1738 incStackMBB->addSuccessor(incStackMBB, 1);
1739 }
1740#ifdef XDEBUG
1741 MF.verify();
1742#endif
1743}
Eli Bendersky700ed802013-02-21 20:05:00 +00001744
1745void X86FrameLowering::
1746eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
1747 MachineBasicBlock::iterator I) const {
1748 const X86InstrInfo &TII = *TM.getInstrInfo();
1749 const X86RegisterInfo &RegInfo = *TM.getRegisterInfo();
1750 unsigned StackPtr = RegInfo.getStackRegister();
1751 bool reseveCallFrame = hasReservedCallFrame(MF);
1752 int Opcode = I->getOpcode();
1753 bool isDestroy = Opcode == TII.getCallFrameDestroyOpcode();
1754 bool IsLP64 = STI.isTarget64BitLP64();
1755 DebugLoc DL = I->getDebugLoc();
1756 uint64_t Amount = !reseveCallFrame ? I->getOperand(0).getImm() : 0;
1757 uint64_t CalleeAmt = isDestroy ? I->getOperand(1).getImm() : 0;
1758 I = MBB.erase(I);
1759
1760 if (!reseveCallFrame) {
1761 // If the stack pointer can be changed after prologue, turn the
1762 // adjcallstackup instruction into a 'sub ESP, <amt>' and the
1763 // adjcallstackdown instruction into 'add ESP, <amt>'
1764 // TODO: consider using push / pop instead of sub + store / add
1765 if (Amount == 0)
1766 return;
1767
1768 // We need to keep the stack aligned properly. To do this, we round the
1769 // amount of space needed for the outgoing arguments up to the next
1770 // alignment boundary.
1771 unsigned StackAlign = TM.getFrameLowering()->getStackAlignment();
1772 Amount = (Amount + StackAlign - 1) / StackAlign * StackAlign;
1773
1774 MachineInstr *New = 0;
1775 if (Opcode == TII.getCallFrameSetupOpcode()) {
1776 New = BuildMI(MF, DL, TII.get(getSUBriOpcode(IsLP64, Amount)),
1777 StackPtr)
1778 .addReg(StackPtr)
1779 .addImm(Amount);
1780 } else {
1781 assert(Opcode == TII.getCallFrameDestroyOpcode());
1782
1783 // Factor out the amount the callee already popped.
1784 Amount -= CalleeAmt;
1785
1786 if (Amount) {
1787 unsigned Opc = getADDriOpcode(IsLP64, Amount);
1788 New = BuildMI(MF, DL, TII.get(Opc), StackPtr)
1789 .addReg(StackPtr).addImm(Amount);
1790 }
1791 }
1792
1793 if (New) {
1794 // The EFLAGS implicit def is dead.
1795 New->getOperand(3).setIsDead();
1796
1797 // Replace the pseudo instruction with a new instruction.
1798 MBB.insert(I, New);
1799 }
1800
1801 return;
1802 }
1803
1804 if (Opcode == TII.getCallFrameDestroyOpcode() && CalleeAmt) {
1805 // If we are performing frame pointer elimination and if the callee pops
1806 // something off the stack pointer, add it back. We do this until we have
1807 // more advanced stack pointer tracking ability.
1808 unsigned Opc = getSUBriOpcode(IsLP64, CalleeAmt);
1809 MachineInstr *New = BuildMI(MF, DL, TII.get(Opc), StackPtr)
1810 .addReg(StackPtr).addImm(CalleeAmt);
1811
1812 // The EFLAGS implicit def is dead.
1813 New->getOperand(3).setIsDead();
1814
1815 // We are not tracking the stack pointer adjustment by the callee, so make
1816 // sure we restore the stack pointer immediately after the call, there may
1817 // be spill code inserted between the CALL and ADJCALLSTACKUP instructions.
1818 MachineBasicBlock::iterator B = MBB.begin();
1819 while (I != B && !llvm::prior(I)->isCall())
1820 --I;
1821 MBB.insert(I, New);
1822 }
1823}
1824