blob: 21b912603be86fca978abbbdffd478547e40ef6d [file] [log] [blame]
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001//===-- X86FrameLowering.cpp - X86 Frame Information ----------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains the X86 implementation of TargetFrameLowering class.
11//
12//===----------------------------------------------------------------------===//
13
14#include "X86FrameLowering.h"
15#include "X86InstrBuilder.h"
16#include "X86InstrInfo.h"
17#include "X86MachineFunctionInfo.h"
18#include "X86Subtarget.h"
19#include "X86TargetMachine.h"
20#include "llvm/ADT/SmallSet.h"
Joseph Tremoulet6afccf62015-11-05 02:20:07 +000021#include "llvm/Analysis/LibCallSemantics.h"
Michael Kupersteine86aa9a2015-02-01 16:15:07 +000022#include "llvm/CodeGen/MachineFrameInfo.h"
23#include "llvm/CodeGen/MachineFunction.h"
24#include "llvm/CodeGen/MachineInstrBuilder.h"
25#include "llvm/CodeGen/MachineModuleInfo.h"
26#include "llvm/CodeGen/MachineRegisterInfo.h"
Reid Klecknerdf129512015-09-08 22:44:41 +000027#include "llvm/CodeGen/WinEHFuncInfo.h"
Michael Kupersteine86aa9a2015-02-01 16:15:07 +000028#include "llvm/IR/DataLayout.h"
29#include "llvm/IR/Function.h"
30#include "llvm/MC/MCAsmInfo.h"
31#include "llvm/MC/MCSymbol.h"
Michael Kupersteine86aa9a2015-02-01 16:15:07 +000032#include "llvm/Target/TargetOptions.h"
33#include "llvm/Support/Debug.h"
34#include <cstdlib>
35
36using namespace llvm;
37
Reid Klecknerf9977bf2015-06-17 21:50:02 +000038X86FrameLowering::X86FrameLowering(const X86Subtarget &STI,
39 unsigned StackAlignOverride)
40 : TargetFrameLowering(StackGrowsDown, StackAlignOverride,
41 STI.is64Bit() ? -8 : -4),
Reid Kleckner034ea962015-06-18 20:32:02 +000042 STI(STI), TII(*STI.getInstrInfo()), TRI(STI.getRegisterInfo()) {
Reid Klecknerf9977bf2015-06-17 21:50:02 +000043 // Cache a bunch of frame-related predicates for this subtarget.
Reid Kleckner034ea962015-06-18 20:32:02 +000044 SlotSize = TRI->getSlotSize();
Reid Klecknerf9977bf2015-06-17 21:50:02 +000045 Is64Bit = STI.is64Bit();
46 IsLP64 = STI.isTarget64BitLP64();
47 // standard x86_64 and NaCl use 64-bit frame/stack pointers, x32 - 32-bit.
48 Uses64BitFramePtr = STI.isTarget64BitLP64() || STI.isTargetNaCl64();
Reid Kleckner034ea962015-06-18 20:32:02 +000049 StackPtr = TRI->getStackRegister();
Reid Klecknerf9977bf2015-06-17 21:50:02 +000050}
51
Michael Kupersteine86aa9a2015-02-01 16:15:07 +000052bool X86FrameLowering::hasReservedCallFrame(const MachineFunction &MF) const {
Michael Kuperstein13fbd452015-02-01 16:56:04 +000053 return !MF.getFrameInfo()->hasVarSizedObjects() &&
54 !MF.getInfo<X86MachineFunctionInfo>()->getHasPushSequences();
55}
56
57/// canSimplifyCallFramePseudos - If there is a reserved call frame, the
58/// call frame pseudos can be simplified. Having a FP, as in the default
59/// implementation, is not sufficient here since we can't always use it.
60/// Use a more nuanced condition.
61bool
62X86FrameLowering::canSimplifyCallFramePseudos(const MachineFunction &MF) const {
Michael Kuperstein13fbd452015-02-01 16:56:04 +000063 return hasReservedCallFrame(MF) ||
Reid Kleckner034ea962015-06-18 20:32:02 +000064 (hasFP(MF) && !TRI->needsStackRealignment(MF)) ||
65 TRI->hasBasePointer(MF);
Michael Kuperstein13fbd452015-02-01 16:56:04 +000066}
67
68// needsFrameIndexResolution - Do we need to perform FI resolution for
69// this function. Normally, this is required only when the function
70// has any stack objects. However, FI resolution actually has another job,
71// not apparent from the title - it resolves callframesetup/destroy
72// that were not simplified earlier.
73// So, this is required for x86 functions that have push sequences even
74// when there are no stack objects.
75bool
76X86FrameLowering::needsFrameIndexResolution(const MachineFunction &MF) const {
77 return MF.getFrameInfo()->hasStackObjects() ||
78 MF.getInfo<X86MachineFunctionInfo>()->getHasPushSequences();
Michael Kupersteine86aa9a2015-02-01 16:15:07 +000079}
80
81/// hasFP - Return true if the specified function should have a dedicated frame
82/// pointer register. This is true if the function has variable sized allocas
83/// or if frame pointer elimination is disabled.
84bool X86FrameLowering::hasFP(const MachineFunction &MF) const {
85 const MachineFrameInfo *MFI = MF.getFrameInfo();
86 const MachineModuleInfo &MMI = MF.getMMI();
Michael Kupersteine86aa9a2015-02-01 16:15:07 +000087
88 return (MF.getTarget().Options.DisableFramePointerElim(MF) ||
Reid Kleckner034ea962015-06-18 20:32:02 +000089 TRI->needsStackRealignment(MF) ||
Michael Kupersteine86aa9a2015-02-01 16:15:07 +000090 MFI->hasVarSizedObjects() ||
Reid Klecknere69bdb82015-07-07 23:45:58 +000091 MFI->isFrameAddressTaken() || MFI->hasOpaqueSPAdjustment() ||
Michael Kupersteine86aa9a2015-02-01 16:15:07 +000092 MF.getInfo<X86MachineFunctionInfo>()->getForceFramePointer() ||
Reid Klecknerdf129512015-09-08 22:44:41 +000093 MMI.callsUnwindInit() || MMI.hasEHFunclets() || MMI.callsEHReturn() ||
Michael Kupersteine86aa9a2015-02-01 16:15:07 +000094 MFI->hasStackMap() || MFI->hasPatchPoint());
95}
96
97static unsigned getSUBriOpcode(unsigned IsLP64, int64_t Imm) {
98 if (IsLP64) {
99 if (isInt<8>(Imm))
100 return X86::SUB64ri8;
101 return X86::SUB64ri32;
102 } else {
103 if (isInt<8>(Imm))
104 return X86::SUB32ri8;
105 return X86::SUB32ri;
106 }
107}
108
109static unsigned getADDriOpcode(unsigned IsLP64, int64_t Imm) {
110 if (IsLP64) {
111 if (isInt<8>(Imm))
112 return X86::ADD64ri8;
113 return X86::ADD64ri32;
114 } else {
115 if (isInt<8>(Imm))
116 return X86::ADD32ri8;
117 return X86::ADD32ri;
118 }
119}
120
121static unsigned getSUBrrOpcode(unsigned isLP64) {
122 return isLP64 ? X86::SUB64rr : X86::SUB32rr;
123}
124
125static unsigned getADDrrOpcode(unsigned isLP64) {
126 return isLP64 ? X86::ADD64rr : X86::ADD32rr;
127}
128
129static unsigned getANDriOpcode(bool IsLP64, int64_t Imm) {
130 if (IsLP64) {
131 if (isInt<8>(Imm))
132 return X86::AND64ri8;
133 return X86::AND64ri32;
134 }
135 if (isInt<8>(Imm))
136 return X86::AND32ri8;
137 return X86::AND32ri;
138}
139
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000140static unsigned getLEArOpcode(unsigned IsLP64) {
141 return IsLP64 ? X86::LEA64r : X86::LEA32r;
142}
143
144/// findDeadCallerSavedReg - Return a caller-saved register that isn't live
145/// when it reaches the "return" instruction. We can then pop a stack object
146/// to this register without worry about clobbering it.
147static unsigned findDeadCallerSavedReg(MachineBasicBlock &MBB,
148 MachineBasicBlock::iterator &MBBI,
Reid Kleckner034ea962015-06-18 20:32:02 +0000149 const TargetRegisterInfo *TRI,
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000150 bool Is64Bit) {
151 const MachineFunction *MF = MBB.getParent();
152 const Function *F = MF->getFunction();
153 if (!F || MF->getMMI().callsEHReturn())
154 return 0;
155
156 static const uint16_t CallerSavedRegs32Bit[] = {
157 X86::EAX, X86::EDX, X86::ECX, 0
158 };
159
160 static const uint16_t CallerSavedRegs64Bit[] = {
161 X86::RAX, X86::RDX, X86::RCX, X86::RSI, X86::RDI,
162 X86::R8, X86::R9, X86::R10, X86::R11, 0
163 };
164
165 unsigned Opc = MBBI->getOpcode();
166 switch (Opc) {
167 default: return 0;
168 case X86::RETL:
169 case X86::RETQ:
170 case X86::RETIL:
171 case X86::RETIQ:
172 case X86::TCRETURNdi:
173 case X86::TCRETURNri:
174 case X86::TCRETURNmi:
175 case X86::TCRETURNdi64:
176 case X86::TCRETURNri64:
177 case X86::TCRETURNmi64:
178 case X86::EH_RETURN:
179 case X86::EH_RETURN64: {
180 SmallSet<uint16_t, 8> Uses;
181 for (unsigned i = 0, e = MBBI->getNumOperands(); i != e; ++i) {
182 MachineOperand &MO = MBBI->getOperand(i);
183 if (!MO.isReg() || MO.isDef())
184 continue;
185 unsigned Reg = MO.getReg();
186 if (!Reg)
187 continue;
Reid Kleckner034ea962015-06-18 20:32:02 +0000188 for (MCRegAliasIterator AI(Reg, TRI, true); AI.isValid(); ++AI)
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000189 Uses.insert(*AI);
190 }
191
192 const uint16_t *CS = Is64Bit ? CallerSavedRegs64Bit : CallerSavedRegs32Bit;
193 for (; *CS; ++CS)
194 if (!Uses.count(*CS))
195 return *CS;
196 }
197 }
198
199 return 0;
200}
201
202static bool isEAXLiveIn(MachineFunction &MF) {
203 for (MachineRegisterInfo::livein_iterator II = MF.getRegInfo().livein_begin(),
204 EE = MF.getRegInfo().livein_end(); II != EE; ++II) {
205 unsigned Reg = II->first;
206
207 if (Reg == X86::RAX || Reg == X86::EAX || Reg == X86::AX ||
208 Reg == X86::AH || Reg == X86::AL)
209 return true;
210 }
211
212 return false;
213}
214
Reid Kleckner98d78032015-06-18 20:22:12 +0000215/// Check whether or not the terminators of \p MBB needs to read EFLAGS.
216static bool terminatorsNeedFlagsAsInput(const MachineBasicBlock &MBB) {
217 for (const MachineInstr &MI : MBB.terminators()) {
218 bool BreakNext = false;
219 for (const MachineOperand &MO : MI.operands()) {
220 if (!MO.isReg())
221 continue;
222 unsigned Reg = MO.getReg();
223 if (Reg != X86::EFLAGS)
224 continue;
225
226 // This terminator needs an eflag that is not defined
227 // by a previous terminator.
228 if (!MO.isDef())
229 return true;
230 BreakNext = true;
231 }
232 if (BreakNext)
233 break;
234 }
235 return false;
236}
237
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000238/// emitSPUpdate - Emit a series of instructions to increment / decrement the
239/// stack pointer by a constant value.
Quentin Colombet494eb602015-05-22 18:10:47 +0000240void X86FrameLowering::emitSPUpdate(MachineBasicBlock &MBB,
241 MachineBasicBlock::iterator &MBBI,
Reid Kleckner98d78032015-06-18 20:22:12 +0000242 int64_t NumBytes, bool InEpilogue) const {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000243 bool isSub = NumBytes < 0;
244 uint64_t Offset = isSub ? -NumBytes : NumBytes;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000245
246 uint64_t Chunk = (1LL << 31) - 1;
247 DebugLoc DL = MBB.findDebugLoc(MBBI);
248
249 while (Offset) {
250 if (Offset > Chunk) {
251 // Rather than emit a long series of instructions for large offsets,
252 // load the offset into a register and do one sub/add
253 unsigned Reg = 0;
254
255 if (isSub && !isEAXLiveIn(*MBB.getParent()))
Reid Kleckner3854f7b2015-06-18 18:03:25 +0000256 Reg = (unsigned)(Is64Bit ? X86::RAX : X86::EAX);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000257 else
Reid Kleckner034ea962015-06-18 20:32:02 +0000258 Reg = findDeadCallerSavedReg(MBB, MBBI, TRI, Is64Bit);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000259
260 if (Reg) {
Reid Kleckner98d78032015-06-18 20:22:12 +0000261 unsigned Opc = Is64Bit ? X86::MOV64ri : X86::MOV32ri;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000262 BuildMI(MBB, MBBI, DL, TII.get(Opc), Reg)
263 .addImm(Offset);
264 Opc = isSub
Reid Kleckner3854f7b2015-06-18 18:03:25 +0000265 ? getSUBrrOpcode(Is64Bit)
266 : getADDrrOpcode(Is64Bit);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000267 MachineInstr *MI = BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr)
268 .addReg(StackPtr)
269 .addReg(Reg);
270 MI->getOperand(3).setIsDead(); // The EFLAGS implicit def is dead.
271 Offset = 0;
272 continue;
273 }
274 }
275
David Majnemer3aa0bd82015-02-24 00:11:32 +0000276 uint64_t ThisVal = std::min(Offset, Chunk);
Reid Kleckner3854f7b2015-06-18 18:03:25 +0000277 if (ThisVal == (Is64Bit ? 8 : 4)) {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000278 // Use push / pop instead.
279 unsigned Reg = isSub
Reid Kleckner3854f7b2015-06-18 18:03:25 +0000280 ? (unsigned)(Is64Bit ? X86::RAX : X86::EAX)
Reid Kleckner034ea962015-06-18 20:32:02 +0000281 : findDeadCallerSavedReg(MBB, MBBI, TRI, Is64Bit);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000282 if (Reg) {
Reid Kleckner98d78032015-06-18 20:22:12 +0000283 unsigned Opc = isSub
Reid Kleckner3854f7b2015-06-18 18:03:25 +0000284 ? (Is64Bit ? X86::PUSH64r : X86::PUSH32r)
285 : (Is64Bit ? X86::POP64r : X86::POP32r);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000286 MachineInstr *MI = BuildMI(MBB, MBBI, DL, TII.get(Opc))
287 .addReg(Reg, getDefRegState(!isSub) | getUndefRegState(isSub));
288 if (isSub)
289 MI->setFlag(MachineInstr::FrameSetup);
Michael Kuperstein098cd9f2015-09-16 11:18:25 +0000290 else
291 MI->setFlag(MachineInstr::FrameDestroy);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000292 Offset -= ThisVal;
293 continue;
294 }
295 }
296
Reid Kleckner98d78032015-06-18 20:22:12 +0000297 MachineInstrBuilder MI = BuildStackAdjustment(
298 MBB, MBBI, DL, isSub ? -ThisVal : ThisVal, InEpilogue);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000299 if (isSub)
Reid Kleckner98d78032015-06-18 20:22:12 +0000300 MI.setMIFlag(MachineInstr::FrameSetup);
Michael Kuperstein098cd9f2015-09-16 11:18:25 +0000301 else
302 MI.setMIFlag(MachineInstr::FrameDestroy);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000303
304 Offset -= ThisVal;
305 }
306}
307
Reid Kleckner98d78032015-06-18 20:22:12 +0000308MachineInstrBuilder X86FrameLowering::BuildStackAdjustment(
309 MachineBasicBlock &MBB, MachineBasicBlock::iterator MBBI, DebugLoc DL,
310 int64_t Offset, bool InEpilogue) const {
311 assert(Offset != 0 && "zero offset stack adjustment requested");
312
313 // On Atom, using LEA to adjust SP is preferred, but using it in the epilogue
314 // is tricky.
315 bool UseLEA;
316 if (!InEpilogue) {
317 UseLEA = STI.useLeaForSP();
318 } else {
319 // If we can use LEA for SP but we shouldn't, check that none
320 // of the terminators uses the eflags. Otherwise we will insert
321 // a ADD that will redefine the eflags and break the condition.
322 // Alternatively, we could move the ADD, but this may not be possible
323 // and is an optimization anyway.
324 UseLEA = canUseLEAForSPInEpilogue(*MBB.getParent());
325 if (UseLEA && !STI.useLeaForSP())
326 UseLEA = terminatorsNeedFlagsAsInput(MBB);
327 // If that assert breaks, that means we do not do the right thing
328 // in canUseAsEpilogue.
329 assert((UseLEA || !terminatorsNeedFlagsAsInput(MBB)) &&
330 "We shouldn't have allowed this insertion point");
331 }
332
333 MachineInstrBuilder MI;
334 if (UseLEA) {
335 MI = addRegOffset(BuildMI(MBB, MBBI, DL,
336 TII.get(getLEArOpcode(Uses64BitFramePtr)),
337 StackPtr),
338 StackPtr, false, Offset);
339 } else {
340 bool IsSub = Offset < 0;
341 uint64_t AbsOffset = IsSub ? -Offset : Offset;
342 unsigned Opc = IsSub ? getSUBriOpcode(Uses64BitFramePtr, AbsOffset)
343 : getADDriOpcode(Uses64BitFramePtr, AbsOffset);
344 MI = BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr)
345 .addReg(StackPtr)
346 .addImm(AbsOffset);
347 MI->getOperand(3).setIsDead(); // The EFLAGS implicit def is dead.
348 }
349 return MI;
350}
351
Quentin Colombet494eb602015-05-22 18:10:47 +0000352int X86FrameLowering::mergeSPUpdates(MachineBasicBlock &MBB,
353 MachineBasicBlock::iterator &MBBI,
Reid Klecknerf9977bf2015-06-17 21:50:02 +0000354 bool doMergeWithPrevious) const {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000355 if ((doMergeWithPrevious && MBBI == MBB.begin()) ||
356 (!doMergeWithPrevious && MBBI == MBB.end()))
357 return 0;
358
359 MachineBasicBlock::iterator PI = doMergeWithPrevious ? std::prev(MBBI) : MBBI;
360 MachineBasicBlock::iterator NI = doMergeWithPrevious ? nullptr
361 : std::next(MBBI);
362 unsigned Opc = PI->getOpcode();
363 int Offset = 0;
364
365 if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
366 Opc == X86::ADD32ri || Opc == X86::ADD32ri8 ||
367 Opc == X86::LEA32r || Opc == X86::LEA64_32r) &&
368 PI->getOperand(0).getReg() == StackPtr){
369 Offset += PI->getOperand(2).getImm();
370 MBB.erase(PI);
371 if (!doMergeWithPrevious) MBBI = NI;
372 } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
373 Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
374 PI->getOperand(0).getReg() == StackPtr) {
375 Offset -= PI->getOperand(2).getImm();
376 MBB.erase(PI);
377 if (!doMergeWithPrevious) MBBI = NI;
378 }
379
380 return Offset;
381}
382
Reid Kleckner3854f7b2015-06-18 18:03:25 +0000383void X86FrameLowering::BuildCFI(MachineBasicBlock &MBB,
384 MachineBasicBlock::iterator MBBI, DebugLoc DL,
385 MCCFIInstruction CFIInst) const {
Reid Kleckner7f189f82015-06-15 23:45:08 +0000386 MachineFunction &MF = *MBB.getParent();
387 unsigned CFIIndex = MF.getMMI().addFrameInst(CFIInst);
388 BuildMI(MBB, MBBI, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
389 .addCFIIndex(CFIIndex);
390}
391
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000392void
393X86FrameLowering::emitCalleeSavedFrameMoves(MachineBasicBlock &MBB,
394 MachineBasicBlock::iterator MBBI,
395 DebugLoc DL) const {
396 MachineFunction &MF = *MBB.getParent();
397 MachineFrameInfo *MFI = MF.getFrameInfo();
398 MachineModuleInfo &MMI = MF.getMMI();
399 const MCRegisterInfo *MRI = MMI.getContext().getRegisterInfo();
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000400
401 // Add callee saved registers to move list.
402 const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
403 if (CSI.empty()) return;
404
405 // Calculate offsets.
406 for (std::vector<CalleeSavedInfo>::const_iterator
407 I = CSI.begin(), E = CSI.end(); I != E; ++I) {
408 int64_t Offset = MFI->getObjectOffset(I->getFrameIdx());
409 unsigned Reg = I->getReg();
410
411 unsigned DwarfReg = MRI->getDwarfRegNum(Reg, true);
Reid Kleckner3854f7b2015-06-18 18:03:25 +0000412 BuildCFI(MBB, MBBI, DL,
Reid Kleckner7f189f82015-06-15 23:45:08 +0000413 MCCFIInstruction::createOffset(nullptr, DwarfReg, Offset));
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000414 }
415}
416
417/// usesTheStack - This function checks if any of the users of EFLAGS
418/// copies the EFLAGS. We know that the code that lowers COPY of EFLAGS has
419/// to use the stack, and if we don't adjust the stack we clobber the first
420/// frame index.
421/// See X86InstrInfo::copyPhysReg.
422static bool usesTheStack(const MachineFunction &MF) {
423 const MachineRegisterInfo &MRI = MF.getRegInfo();
424
425 for (MachineRegisterInfo::reg_instr_iterator
426 ri = MRI.reg_instr_begin(X86::EFLAGS), re = MRI.reg_instr_end();
427 ri != re; ++ri)
428 if (ri->isCopy())
429 return true;
430
431 return false;
432}
433
Andy Ayers809cbe92015-11-10 01:50:49 +0000434MachineInstr *X86FrameLowering::emitStackProbe(MachineFunction &MF,
435 MachineBasicBlock &MBB,
436 MachineBasicBlock::iterator MBBI,
437 DebugLoc DL,
438 bool InProlog) const {
439 const X86Subtarget &STI = MF.getSubtarget<X86Subtarget>();
440 if (STI.isTargetWindowsCoreCLR()) {
441 if (InProlog) {
442 return emitStackProbeInlineStub(MF, MBB, MBBI, DL, true);
443 } else {
444 return emitStackProbeInline(MF, MBB, MBBI, DL, false);
445 }
446 } else {
447 return emitStackProbeCall(MF, MBB, MBBI, DL, InProlog);
448 }
449}
450
451void X86FrameLowering::inlineStackProbe(MachineFunction &MF,
452 MachineBasicBlock &PrologMBB) const {
453 const StringRef ChkStkStubSymbol = "__chkstk_stub";
454 MachineInstr *ChkStkStub = nullptr;
455
456 for (MachineInstr &MI : PrologMBB) {
457 if (MI.isCall() && MI.getOperand(0).isSymbol() &&
458 ChkStkStubSymbol == MI.getOperand(0).getSymbolName()) {
459 ChkStkStub = &MI;
460 break;
461 }
462 }
463
464 if (ChkStkStub != nullptr) {
465 MachineBasicBlock::iterator MBBI = std::next(ChkStkStub->getIterator());
466 assert(std::prev(MBBI).operator==(ChkStkStub) &&
467 "MBBI expected after __chkstk_stub.");
468 DebugLoc DL = PrologMBB.findDebugLoc(MBBI);
469 emitStackProbeInline(MF, PrologMBB, MBBI, DL, true);
470 ChkStkStub->eraseFromParent();
471 }
472}
473
474MachineInstr *X86FrameLowering::emitStackProbeInline(
475 MachineFunction &MF, MachineBasicBlock &MBB,
476 MachineBasicBlock::iterator MBBI, DebugLoc DL, bool InProlog) const {
477 const X86Subtarget &STI = MF.getSubtarget<X86Subtarget>();
478 assert(STI.is64Bit() && "different expansion needed for 32 bit");
479 assert(STI.isTargetWindowsCoreCLR() && "custom expansion expects CoreCLR");
480 const TargetInstrInfo &TII = *STI.getInstrInfo();
481 const BasicBlock *LLVM_BB = MBB.getBasicBlock();
482
483 // RAX contains the number of bytes of desired stack adjustment.
484 // The handling here assumes this value has already been updated so as to
485 // maintain stack alignment.
486 //
487 // We need to exit with RSP modified by this amount and execute suitable
488 // page touches to notify the OS that we're growing the stack responsibly.
489 // All stack probing must be done without modifying RSP.
490 //
491 // MBB:
492 // SizeReg = RAX;
493 // ZeroReg = 0
494 // CopyReg = RSP
495 // Flags, TestReg = CopyReg - SizeReg
496 // FinalReg = !Flags.Ovf ? TestReg : ZeroReg
497 // LimitReg = gs magic thread env access
498 // if FinalReg >= LimitReg goto ContinueMBB
499 // RoundBB:
500 // RoundReg = page address of FinalReg
501 // LoopMBB:
502 // LoopReg = PHI(LimitReg,ProbeReg)
503 // ProbeReg = LoopReg - PageSize
504 // [ProbeReg] = 0
505 // if (ProbeReg > RoundReg) goto LoopMBB
506 // ContinueMBB:
507 // RSP = RSP - RAX
508 // [rest of original MBB]
509
510 // Set up the new basic blocks
511 MachineBasicBlock *RoundMBB = MF.CreateMachineBasicBlock(LLVM_BB);
512 MachineBasicBlock *LoopMBB = MF.CreateMachineBasicBlock(LLVM_BB);
513 MachineBasicBlock *ContinueMBB = MF.CreateMachineBasicBlock(LLVM_BB);
514
515 MachineFunction::iterator MBBIter = std::next(MBB.getIterator());
516 MF.insert(MBBIter, RoundMBB);
517 MF.insert(MBBIter, LoopMBB);
518 MF.insert(MBBIter, ContinueMBB);
519
520 // Split MBB and move the tail portion down to ContinueMBB.
521 MachineBasicBlock::iterator BeforeMBBI = std::prev(MBBI);
522 ContinueMBB->splice(ContinueMBB->begin(), &MBB, MBBI, MBB.end());
523 ContinueMBB->transferSuccessorsAndUpdatePHIs(&MBB);
524
525 // Some useful constants
526 const int64_t ThreadEnvironmentStackLimit = 0x10;
527 const int64_t PageSize = 0x1000;
528 const int64_t PageMask = ~(PageSize - 1);
529
530 // Registers we need. For the normal case we use virtual
531 // registers. For the prolog expansion we use RAX, RCX and RDX.
532 MachineRegisterInfo &MRI = MF.getRegInfo();
533 const TargetRegisterClass *RegClass = &X86::GR64RegClass;
534 const unsigned
535 SizeReg = InProlog ? X86::RAX : MRI.createVirtualRegister(RegClass),
536 ZeroReg = InProlog ? X86::RCX : MRI.createVirtualRegister(RegClass),
537 CopyReg = InProlog ? X86::RDX : MRI.createVirtualRegister(RegClass),
538 TestReg = InProlog ? X86::RDX : MRI.createVirtualRegister(RegClass),
539 FinalReg = InProlog ? X86::RDX : MRI.createVirtualRegister(RegClass),
540 RoundedReg = InProlog ? X86::RDX : MRI.createVirtualRegister(RegClass),
541 LimitReg = InProlog ? X86::RCX : MRI.createVirtualRegister(RegClass),
542 JoinReg = InProlog ? X86::RCX : MRI.createVirtualRegister(RegClass),
543 ProbeReg = InProlog ? X86::RCX : MRI.createVirtualRegister(RegClass);
544
545 // SP-relative offsets where we can save RCX and RDX.
546 int64_t RCXShadowSlot = 0;
547 int64_t RDXShadowSlot = 0;
548
549 // If inlining in the prolog, save RCX and RDX.
550 // Future optimization: don't save or restore if not live in.
551 if (InProlog) {
552 // Compute the offsets. We need to account for things already
553 // pushed onto the stack at this point: return address, frame
554 // pointer (if used), and callee saves.
555 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
556 const int64_t CalleeSaveSize = X86FI->getCalleeSavedFrameSize();
557 const bool HasFP = hasFP(MF);
558 RCXShadowSlot = 8 + CalleeSaveSize + (HasFP ? 8 : 0);
559 RDXShadowSlot = RCXShadowSlot + 8;
560 // Emit the saves.
561 addRegOffset(BuildMI(&MBB, DL, TII.get(X86::MOV64mr)), X86::RSP, false,
562 RCXShadowSlot)
563 .addReg(X86::RCX);
564 addRegOffset(BuildMI(&MBB, DL, TII.get(X86::MOV64mr)), X86::RSP, false,
565 RDXShadowSlot)
566 .addReg(X86::RDX);
567 } else {
568 // Not in the prolog. Copy RAX to a virtual reg.
569 BuildMI(&MBB, DL, TII.get(X86::MOV64rr), SizeReg).addReg(X86::RAX);
570 }
571
572 // Add code to MBB to check for overflow and set the new target stack pointer
573 // to zero if so.
574 BuildMI(&MBB, DL, TII.get(X86::XOR64rr), ZeroReg)
575 .addReg(ZeroReg, RegState::Undef)
576 .addReg(ZeroReg, RegState::Undef);
577 BuildMI(&MBB, DL, TII.get(X86::MOV64rr), CopyReg).addReg(X86::RSP);
578 BuildMI(&MBB, DL, TII.get(X86::SUB64rr), TestReg)
579 .addReg(CopyReg)
580 .addReg(SizeReg);
581 BuildMI(&MBB, DL, TII.get(X86::CMOVB64rr), FinalReg)
582 .addReg(TestReg)
583 .addReg(ZeroReg);
584
585 // FinalReg now holds final stack pointer value, or zero if
586 // allocation would overflow. Compare against the current stack
587 // limit from the thread environment block. Note this limit is the
588 // lowest touched page on the stack, not the point at which the OS
589 // will cause an overflow exception, so this is just an optimization
590 // to avoid unnecessarily touching pages that are below the current
591 // SP but already commited to the stack by the OS.
592 BuildMI(&MBB, DL, TII.get(X86::MOV64rm), LimitReg)
593 .addReg(0)
594 .addImm(1)
595 .addReg(0)
596 .addImm(ThreadEnvironmentStackLimit)
597 .addReg(X86::GS);
598 BuildMI(&MBB, DL, TII.get(X86::CMP64rr)).addReg(FinalReg).addReg(LimitReg);
599 // Jump if the desired stack pointer is at or above the stack limit.
600 BuildMI(&MBB, DL, TII.get(X86::JAE_1)).addMBB(ContinueMBB);
601
602 // Add code to roundMBB to round the final stack pointer to a page boundary.
603 BuildMI(RoundMBB, DL, TII.get(X86::AND64ri32), RoundedReg)
604 .addReg(FinalReg)
605 .addImm(PageMask);
606 BuildMI(RoundMBB, DL, TII.get(X86::JMP_1)).addMBB(LoopMBB);
607
608 // LimitReg now holds the current stack limit, RoundedReg page-rounded
609 // final RSP value. Add code to loopMBB to decrement LimitReg page-by-page
610 // and probe until we reach RoundedReg.
611 if (!InProlog) {
612 BuildMI(LoopMBB, DL, TII.get(X86::PHI), JoinReg)
613 .addReg(LimitReg)
614 .addMBB(RoundMBB)
615 .addReg(ProbeReg)
616 .addMBB(LoopMBB);
617 }
618
619 addRegOffset(BuildMI(LoopMBB, DL, TII.get(X86::LEA64r), ProbeReg), JoinReg,
620 false, -PageSize);
621
622 // Probe by storing a byte onto the stack.
623 BuildMI(LoopMBB, DL, TII.get(X86::MOV8mi))
624 .addReg(ProbeReg)
625 .addImm(1)
626 .addReg(0)
627 .addImm(0)
628 .addReg(0)
629 .addImm(0);
630 BuildMI(LoopMBB, DL, TII.get(X86::CMP64rr))
631 .addReg(RoundedReg)
632 .addReg(ProbeReg);
633 BuildMI(LoopMBB, DL, TII.get(X86::JNE_1)).addMBB(LoopMBB);
634
635 MachineBasicBlock::iterator ContinueMBBI = ContinueMBB->getFirstNonPHI();
636
637 // If in prolog, restore RDX and RCX.
638 if (InProlog) {
639 addRegOffset(BuildMI(*ContinueMBB, ContinueMBBI, DL, TII.get(X86::MOV64rm),
640 X86::RCX),
641 X86::RSP, false, RCXShadowSlot);
642 addRegOffset(BuildMI(*ContinueMBB, ContinueMBBI, DL, TII.get(X86::MOV64rm),
643 X86::RDX),
644 X86::RSP, false, RDXShadowSlot);
645 }
646
647 // Now that the probing is done, add code to continueMBB to update
648 // the stack pointer for real.
649 BuildMI(*ContinueMBB, ContinueMBBI, DL, TII.get(X86::SUB64rr), X86::RSP)
650 .addReg(X86::RSP)
651 .addReg(SizeReg);
652
653 // Add the control flow edges we need.
654 MBB.addSuccessor(ContinueMBB);
655 MBB.addSuccessor(RoundMBB);
656 RoundMBB->addSuccessor(LoopMBB);
657 LoopMBB->addSuccessor(ContinueMBB);
658 LoopMBB->addSuccessor(LoopMBB);
659
660 // Mark all the instructions added to the prolog as frame setup.
661 if (InProlog) {
662 for (++BeforeMBBI; BeforeMBBI != MBB.end(); ++BeforeMBBI) {
663 BeforeMBBI->setFlag(MachineInstr::FrameSetup);
664 }
665 for (MachineInstr &MI : *RoundMBB) {
666 MI.setFlag(MachineInstr::FrameSetup);
667 }
668 for (MachineInstr &MI : *LoopMBB) {
669 MI.setFlag(MachineInstr::FrameSetup);
670 }
671 for (MachineBasicBlock::iterator CMBBI = ContinueMBB->begin();
672 CMBBI != ContinueMBBI; ++CMBBI) {
673 CMBBI->setFlag(MachineInstr::FrameSetup);
674 }
675 }
676
677 // Possible TODO: physreg liveness for InProlog case.
678
679 return ContinueMBBI;
680}
681
682MachineInstr *X86FrameLowering::emitStackProbeCall(
683 MachineFunction &MF, MachineBasicBlock &MBB,
684 MachineBasicBlock::iterator MBBI, DebugLoc DL, bool InProlog) const {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000685 bool IsLargeCodeModel = MF.getTarget().getCodeModel() == CodeModel::Large;
686
687 unsigned CallOp;
688 if (Is64Bit)
689 CallOp = IsLargeCodeModel ? X86::CALL64r : X86::CALL64pcrel32;
690 else
691 CallOp = X86::CALLpcrel32;
692
693 const char *Symbol;
694 if (Is64Bit) {
695 if (STI.isTargetCygMing()) {
696 Symbol = "___chkstk_ms";
697 } else {
698 Symbol = "__chkstk";
699 }
700 } else if (STI.isTargetCygMing())
701 Symbol = "_alloca";
702 else
703 Symbol = "_chkstk";
704
705 MachineInstrBuilder CI;
Andy Ayers809cbe92015-11-10 01:50:49 +0000706 MachineBasicBlock::iterator ExpansionMBBI = std::prev(MBBI);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000707
708 // All current stack probes take AX and SP as input, clobber flags, and
709 // preserve all registers. x86_64 probes leave RSP unmodified.
710 if (Is64Bit && MF.getTarget().getCodeModel() == CodeModel::Large) {
711 // For the large code model, we have to call through a register. Use R11,
712 // as it is scratch in all supported calling conventions.
713 BuildMI(MBB, MBBI, DL, TII.get(X86::MOV64ri), X86::R11)
714 .addExternalSymbol(Symbol);
715 CI = BuildMI(MBB, MBBI, DL, TII.get(CallOp)).addReg(X86::R11);
716 } else {
717 CI = BuildMI(MBB, MBBI, DL, TII.get(CallOp)).addExternalSymbol(Symbol);
718 }
719
720 unsigned AX = Is64Bit ? X86::RAX : X86::EAX;
721 unsigned SP = Is64Bit ? X86::RSP : X86::ESP;
722 CI.addReg(AX, RegState::Implicit)
723 .addReg(SP, RegState::Implicit)
724 .addReg(AX, RegState::Define | RegState::Implicit)
725 .addReg(SP, RegState::Define | RegState::Implicit)
726 .addReg(X86::EFLAGS, RegState::Define | RegState::Implicit);
727
728 if (Is64Bit) {
729 // MSVC x64's __chkstk and cygwin/mingw's ___chkstk_ms do not adjust %rsp
730 // themselves. It also does not clobber %rax so we can reuse it when
731 // adjusting %rsp.
732 BuildMI(MBB, MBBI, DL, TII.get(X86::SUB64rr), X86::RSP)
733 .addReg(X86::RSP)
734 .addReg(X86::RAX);
735 }
Andy Ayers809cbe92015-11-10 01:50:49 +0000736
737 if (InProlog) {
738 // Apply the frame setup flag to all inserted instrs.
739 for (++ExpansionMBBI; ExpansionMBBI != MBBI; ++ExpansionMBBI)
740 ExpansionMBBI->setFlag(MachineInstr::FrameSetup);
741 }
742
743 return MBBI;
744}
745
746MachineInstr *X86FrameLowering::emitStackProbeInlineStub(
747 MachineFunction &MF, MachineBasicBlock &MBB,
748 MachineBasicBlock::iterator MBBI, DebugLoc DL, bool InProlog) const {
749
750 assert(InProlog && "ChkStkStub called outside prolog!");
751
David Blaikiee35168f2015-11-10 03:16:28 +0000752 BuildMI(MBB, MBBI, DL, TII.get(X86::CALLpcrel32))
753 .addExternalSymbol("__chkstk_stub");
Andy Ayers809cbe92015-11-10 01:50:49 +0000754
755 return MBBI;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000756}
757
David Majnemer93c22a42015-02-10 00:57:42 +0000758static unsigned calculateSetFPREG(uint64_t SPAdjust) {
759 // Win64 ABI has a less restrictive limitation of 240; 128 works equally well
760 // and might require smaller successive adjustments.
761 const uint64_t Win64MaxSEHOffset = 128;
762 uint64_t SEHFrameOffset = std::min(SPAdjust, Win64MaxSEHOffset);
763 // Win64 ABI requires 16-byte alignment for the UWOP_SET_FPREG opcode.
David Majnemer89d05642015-02-21 01:04:47 +0000764 return SEHFrameOffset & -16;
David Majnemer93c22a42015-02-10 00:57:42 +0000765}
766
767// If we're forcing a stack realignment we can't rely on just the frame
768// info, we need to know the ABI stack alignment as well in case we
769// have a call out. Otherwise just make sure we have some alignment - we'll
770// go with the minimum SlotSize.
Reid Klecknerf9977bf2015-06-17 21:50:02 +0000771uint64_t X86FrameLowering::calculateMaxStackAlign(const MachineFunction &MF) const {
David Majnemer93c22a42015-02-10 00:57:42 +0000772 const MachineFrameInfo *MFI = MF.getFrameInfo();
773 uint64_t MaxAlign = MFI->getMaxAlignment(); // Desired stack alignment.
Reid Klecknerf9977bf2015-06-17 21:50:02 +0000774 unsigned StackAlign = getStackAlignment();
Akira Hatanakabc497c92015-09-11 18:54:38 +0000775 if (MF.getFunction()->hasFnAttribute("stackrealign")) {
David Majnemer93c22a42015-02-10 00:57:42 +0000776 if (MFI->hasCalls())
777 MaxAlign = (StackAlign > MaxAlign) ? StackAlign : MaxAlign;
778 else if (MaxAlign < SlotSize)
779 MaxAlign = SlotSize;
780 }
781 return MaxAlign;
782}
783
Reid Kleckner3854f7b2015-06-18 18:03:25 +0000784void X86FrameLowering::BuildStackAlignAND(MachineBasicBlock &MBB,
785 MachineBasicBlock::iterator MBBI,
Reid Kleckner6ddae312015-11-05 21:09:49 +0000786 DebugLoc DL, unsigned Reg,
Reid Kleckner3854f7b2015-06-18 18:03:25 +0000787 uint64_t MaxAlign) const {
788 uint64_t Val = -MaxAlign;
Reid Kleckner6ddae312015-11-05 21:09:49 +0000789 unsigned AndOp = getANDriOpcode(Uses64BitFramePtr, Val);
790 MachineInstr *MI = BuildMI(MBB, MBBI, DL, TII.get(AndOp), Reg)
791 .addReg(Reg)
792 .addImm(Val)
793 .setMIFlag(MachineInstr::FrameSetup);
Reid Kleckner3854f7b2015-06-18 18:03:25 +0000794
795 // The EFLAGS implicit def is dead.
796 MI->getOperand(3).setIsDead();
797}
798
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000799/// emitPrologue - Push callee-saved registers onto the stack, which
800/// automatically adjust the stack pointer. Adjust the stack pointer to allocate
801/// space for local variables. Also emit labels used by the exception handler to
802/// generate the exception handling frames.
803
804/*
805 Here's a gist of what gets emitted:
806
807 ; Establish frame pointer, if needed
808 [if needs FP]
809 push %rbp
810 .cfi_def_cfa_offset 16
811 .cfi_offset %rbp, -16
812 .seh_pushreg %rpb
813 mov %rsp, %rbp
814 .cfi_def_cfa_register %rbp
815
816 ; Spill general-purpose registers
817 [for all callee-saved GPRs]
818 pushq %<reg>
819 [if not needs FP]
820 .cfi_def_cfa_offset (offset from RETADDR)
821 .seh_pushreg %<reg>
822
823 ; If the required stack alignment > default stack alignment
824 ; rsp needs to be re-aligned. This creates a "re-alignment gap"
825 ; of unknown size in the stack frame.
826 [if stack needs re-alignment]
827 and $MASK, %rsp
828
829 ; Allocate space for locals
830 [if target is Windows and allocated space > 4096 bytes]
831 ; Windows needs special care for allocations larger
832 ; than one page.
833 mov $NNN, %rax
834 call ___chkstk_ms/___chkstk
835 sub %rax, %rsp
836 [else]
837 sub $NNN, %rsp
838
839 [if needs FP]
840 .seh_stackalloc (size of XMM spill slots)
841 .seh_setframe %rbp, SEHFrameOffset ; = size of all spill slots
842 [else]
843 .seh_stackalloc NNN
844
845 ; Spill XMMs
846 ; Note, that while only Windows 64 ABI specifies XMMs as callee-preserved,
847 ; they may get spilled on any platform, if the current function
848 ; calls @llvm.eh.unwind.init
849 [if needs FP]
850 [for all callee-saved XMM registers]
851 movaps %<xmm reg>, -MMM(%rbp)
852 [for all callee-saved XMM registers]
853 .seh_savexmm %<xmm reg>, (-MMM + SEHFrameOffset)
854 ; i.e. the offset relative to (%rbp - SEHFrameOffset)
855 [else]
856 [for all callee-saved XMM registers]
857 movaps %<xmm reg>, KKK(%rsp)
858 [for all callee-saved XMM registers]
859 .seh_savexmm %<xmm reg>, KKK
860
861 .seh_endprologue
862
863 [if needs base pointer]
864 mov %rsp, %rbx
865 [if needs to restore base pointer]
866 mov %rsp, -MMM(%rbp)
867
868 ; Emit CFI info
869 [if needs FP]
870 [for all callee-saved registers]
871 .cfi_offset %<reg>, (offset from %rbp)
872 [else]
873 .cfi_def_cfa_offset (offset from RETADDR)
874 [for all callee-saved registers]
875 .cfi_offset %<reg>, (offset from %rsp)
876
877 Notes:
878 - .seh directives are emitted only for Windows 64 ABI
879 - .cfi directives are emitted for all other ABIs
880 - for 32-bit code, substitute %e?? registers for %r??
881*/
882
Quentin Colombet61b305e2015-05-05 17:38:16 +0000883void X86FrameLowering::emitPrologue(MachineFunction &MF,
884 MachineBasicBlock &MBB) const {
Reid Klecknerf9977bf2015-06-17 21:50:02 +0000885 assert(&STI == &MF.getSubtarget<X86Subtarget>() &&
886 "MF used frame lowering for wrong subtarget");
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000887 MachineBasicBlock::iterator MBBI = MBB.begin();
888 MachineFrameInfo *MFI = MF.getFrameInfo();
889 const Function *Fn = MF.getFunction();
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000890 MachineModuleInfo &MMI = MF.getMMI();
891 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
David Majnemer93c22a42015-02-10 00:57:42 +0000892 uint64_t MaxAlign = calculateMaxStackAlign(MF); // Desired stack alignment.
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000893 uint64_t StackSize = MFI->getStackSize(); // Number of bytes to allocate.
Reid Klecknera13dfd52015-09-29 23:32:01 +0000894 bool IsFunclet = MBB.isEHFuncletEntry();
Joseph Tremoulet6afccf62015-11-05 02:20:07 +0000895 bool IsClrFunclet =
896 IsFunclet &&
897 classifyEHPersonality(Fn->getPersonalityFn()) == EHPersonality::CoreCLR;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000898 bool HasFP = hasFP(MF);
Reid Kleckner1c140bd2015-06-16 18:08:57 +0000899 bool IsWin64CC = STI.isCallingConvWin64(Fn->getCallingConv());
Reid Kleckner1c140bd2015-06-16 18:08:57 +0000900 bool IsWin64Prologue = MF.getTarget().getMCAsmInfo()->usesWindowsCFI();
901 bool NeedsWinCFI = IsWin64Prologue && Fn->needsUnwindTableEntry();
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000902 bool NeedsDwarfCFI =
Reid Kleckner1c140bd2015-06-16 18:08:57 +0000903 !IsWin64Prologue && (MMI.hasDebugInfo() || Fn->needsUnwindTableEntry());
Reid Kleckner034ea962015-06-18 20:32:02 +0000904 unsigned FramePtr = TRI->getFrameRegister(MF);
Eric Christopher05b81972015-02-02 17:38:43 +0000905 const unsigned MachineFramePtr =
906 STI.isTarget64BitILP32()
Tim Northover775aaeb2015-11-05 21:54:58 +0000907 ? getX86SubSuperRegister(FramePtr, MVT::i64, false)
908 : FramePtr;
909 unsigned BasePtr = TRI->getBaseRegister();
910
911 // Debug location must be unknown since the first debug location is used
912 // to determine the end of the prologue.
913 DebugLoc DL;
914
915 // Add RETADDR move area to callee saved frame size.
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000916 int TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
Reid Kleckner1c140bd2015-06-16 18:08:57 +0000917 if (TailCallReturnAddrDelta && IsWin64Prologue)
David Majnemer93c22a42015-02-10 00:57:42 +0000918 report_fatal_error("Can't handle guaranteed tail call under win64 yet");
919
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000920 if (TailCallReturnAddrDelta < 0)
921 X86FI->setCalleeSavedFrameSize(
922 X86FI->getCalleeSavedFrameSize() - TailCallReturnAddrDelta);
923
924 bool UseStackProbe = (STI.isOSWindows() && !STI.isTargetMachO());
925
926 // The default stack probe size is 4096 if the function has no stackprobesize
927 // attribute.
928 unsigned StackProbeSize = 4096;
929 if (Fn->hasFnAttribute("stack-probe-size"))
930 Fn->getFnAttribute("stack-probe-size")
931 .getValueAsString()
932 .getAsInteger(0, StackProbeSize);
933
934 // If this is x86-64 and the Red Zone is not disabled, if we are a leaf
935 // function, and use up to 128 bytes of stack space, don't have a frame
936 // pointer, calls, or dynamic alloca then we do not need to adjust the
937 // stack pointer (we fit in the Red Zone). We also check that we don't
938 // push and pop from the stack.
Duncan P. N. Exon Smith5975a702015-02-14 01:59:52 +0000939 if (Is64Bit && !Fn->hasFnAttribute(Attribute::NoRedZone) &&
Reid Kleckner034ea962015-06-18 20:32:02 +0000940 !TRI->needsStackRealignment(MF) &&
Duncan P. N. Exon Smith5975a702015-02-14 01:59:52 +0000941 !MFI->hasVarSizedObjects() && // No dynamic alloca.
942 !MFI->adjustsStack() && // No calls.
Reid Kleckner1c140bd2015-06-16 18:08:57 +0000943 !IsWin64CC && // Win64 has no Red Zone
Duncan P. N. Exon Smith5975a702015-02-14 01:59:52 +0000944 !usesTheStack(MF) && // Don't push and pop.
945 !MF.shouldSplitStack()) { // Regular stack
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000946 uint64_t MinSize = X86FI->getCalleeSavedFrameSize();
947 if (HasFP) MinSize += SlotSize;
948 StackSize = std::max(MinSize, StackSize > 128 ? StackSize - 128 : 0);
949 MFI->setStackSize(StackSize);
950 }
951
952 // Insert stack pointer adjustment for later moving of return addr. Only
953 // applies to tail call optimized functions where the callee argument stack
954 // size is bigger than the callers.
955 if (TailCallReturnAddrDelta < 0) {
Reid Kleckner98d78032015-06-18 20:22:12 +0000956 BuildStackAdjustment(MBB, MBBI, DL, TailCallReturnAddrDelta,
957 /*InEpilogue=*/false)
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000958 .setMIFlag(MachineInstr::FrameSetup);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000959 }
960
961 // Mapping for machine moves:
962 //
963 // DST: VirtualFP AND
964 // SRC: VirtualFP => DW_CFA_def_cfa_offset
965 // ELSE => DW_CFA_def_cfa
966 //
967 // SRC: VirtualFP AND
968 // DST: Register => DW_CFA_def_cfa_register
969 //
970 // ELSE
971 // OFFSET < 0 => DW_CFA_offset_extended_sf
972 // REG < 64 => DW_CFA_offset + Reg
973 // ELSE => DW_CFA_offset_extended
974
975 uint64_t NumBytes = 0;
976 int stackGrowth = -SlotSize;
977
Joseph Tremoulet6afccf62015-11-05 02:20:07 +0000978 // Find the funclet establisher parameter
979 unsigned Establisher = X86::NoRegister;
980 if (IsClrFunclet)
981 Establisher = Uses64BitFramePtr ? X86::RCX : X86::ECX;
982 else if (IsFunclet)
983 Establisher = Uses64BitFramePtr ? X86::RDX : X86::EDX;
984
985 if (IsWin64Prologue && IsFunclet & !IsClrFunclet) {
986 // Immediately spill establisher into the home slot.
987 // The runtime cares about this.
Reid Klecknera13dfd52015-09-29 23:32:01 +0000988 // MOV64mr %rdx, 16(%rsp)
989 unsigned MOVmr = Uses64BitFramePtr ? X86::MOV64mr : X86::MOV32mr;
990 addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(MOVmr)), StackPtr, true, 16)
Joseph Tremoulet6afccf62015-11-05 02:20:07 +0000991 .addReg(Establisher)
Reid Klecknerdf129512015-09-08 22:44:41 +0000992 .setMIFlag(MachineInstr::FrameSetup);
Reid Kleckner64b003f2015-11-09 21:04:00 +0000993 MBB.addLiveIn(Establisher);
Reid Klecknera13dfd52015-09-29 23:32:01 +0000994 }
Reid Klecknerdf129512015-09-08 22:44:41 +0000995
Reid Klecknera13dfd52015-09-29 23:32:01 +0000996 if (HasFP) {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +0000997 // Calculate required stack adjustment.
998 uint64_t FrameSize = StackSize - SlotSize;
999 // If required, include space for extra hidden slot for stashing base pointer.
1000 if (X86FI->getRestoreBasePointer())
1001 FrameSize += SlotSize;
David Majnemer89d05642015-02-21 01:04:47 +00001002
1003 NumBytes = FrameSize - X86FI->getCalleeSavedFrameSize();
1004
1005 // Callee-saved registers are pushed on stack before the stack is realigned.
Reid Kleckner034ea962015-06-18 20:32:02 +00001006 if (TRI->needsStackRealignment(MF) && !IsWin64Prologue)
David Majnemer89d05642015-02-21 01:04:47 +00001007 NumBytes = RoundUpToAlignment(NumBytes, MaxAlign);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001008
1009 // Get the offset of the stack slot for the EBP register, which is
1010 // guaranteed to be the last slot by processFunctionBeforeFrameFinalized.
1011 // Update the frame offset adjustment.
Reid Klecknera13dfd52015-09-29 23:32:01 +00001012 if (!IsFunclet)
1013 MFI->setOffsetAdjustment(-NumBytes);
1014 else
David Blaikie757908e2015-09-30 20:37:48 +00001015 assert(MFI->getOffsetAdjustment() == -(int)NumBytes &&
Reid Klecknera13dfd52015-09-29 23:32:01 +00001016 "should calculate same local variable offset for funclets");
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001017
1018 // Save EBP/RBP into the appropriate stack slot.
1019 BuildMI(MBB, MBBI, DL, TII.get(Is64Bit ? X86::PUSH64r : X86::PUSH32r))
1020 .addReg(MachineFramePtr, RegState::Kill)
1021 .setMIFlag(MachineInstr::FrameSetup);
1022
1023 if (NeedsDwarfCFI) {
1024 // Mark the place where EBP/RBP was saved.
1025 // Define the current CFA rule to use the provided offset.
1026 assert(StackSize);
Reid Kleckner3854f7b2015-06-18 18:03:25 +00001027 BuildCFI(MBB, MBBI, DL,
Reid Kleckner7f189f82015-06-15 23:45:08 +00001028 MCCFIInstruction::createDefCfaOffset(nullptr, 2 * stackGrowth));
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001029
1030 // Change the rule for the FramePtr to be an "offset" rule.
Reid Kleckner034ea962015-06-18 20:32:02 +00001031 unsigned DwarfFramePtr = TRI->getDwarfRegNum(MachineFramePtr, true);
Reid Kleckner3854f7b2015-06-18 18:03:25 +00001032 BuildCFI(MBB, MBBI, DL, MCCFIInstruction::createOffset(
1033 nullptr, DwarfFramePtr, 2 * stackGrowth));
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001034 }
1035
Reid Kleckner1c140bd2015-06-16 18:08:57 +00001036 if (NeedsWinCFI) {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001037 BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_PushReg))
1038 .addImm(FramePtr)
1039 .setMIFlag(MachineInstr::FrameSetup);
1040 }
1041
Reid Klecknera13dfd52015-09-29 23:32:01 +00001042 if (!IsWin64Prologue && !IsFunclet) {
David Majnemer93c22a42015-02-10 00:57:42 +00001043 // Update EBP with the new base value.
1044 BuildMI(MBB, MBBI, DL,
1045 TII.get(Uses64BitFramePtr ? X86::MOV64rr : X86::MOV32rr),
1046 FramePtr)
1047 .addReg(StackPtr)
1048 .setMIFlag(MachineInstr::FrameSetup);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001049
Reid Klecknera13dfd52015-09-29 23:32:01 +00001050 if (NeedsDwarfCFI) {
1051 // Mark effective beginning of when frame pointer becomes valid.
1052 // Define the current CFA to use the EBP/RBP register.
1053 unsigned DwarfFramePtr = TRI->getDwarfRegNum(MachineFramePtr, true);
1054 BuildCFI(MBB, MBBI, DL, MCCFIInstruction::createDefCfaRegister(
1055 nullptr, DwarfFramePtr));
1056 }
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001057 }
1058
Reid Kleckner64b003f2015-11-09 21:04:00 +00001059 // Mark the FramePtr as live-in in every block. Don't do this again for
1060 // funclet prologues.
1061 if (!IsFunclet) {
1062 for (MachineBasicBlock &EveryMBB : MF)
1063 EveryMBB.addLiveIn(MachineFramePtr);
1064 }
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001065 } else {
Reid Klecknera13dfd52015-09-29 23:32:01 +00001066 assert(!IsFunclet && "funclets without FPs not yet implemented");
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001067 NumBytes = StackSize - X86FI->getCalleeSavedFrameSize();
1068 }
1069
Reid Klecknera13dfd52015-09-29 23:32:01 +00001070 // For EH funclets, only allocate enough space for outgoing calls. Save the
1071 // NumBytes value that we would've used for the parent frame.
1072 unsigned ParentFrameNumBytes = NumBytes;
1073 if (IsFunclet)
Reid Kleckner28e49032015-10-16 23:43:27 +00001074 NumBytes = getWinEHFuncletFrameSize(MF);
Reid Klecknera13dfd52015-09-29 23:32:01 +00001075
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001076 // Skip the callee-saved push instructions.
1077 bool PushedRegs = false;
1078 int StackOffset = 2 * stackGrowth;
1079
1080 while (MBBI != MBB.end() &&
Michael Kupersteine1ea4e7d2015-07-16 12:27:59 +00001081 MBBI->getFlag(MachineInstr::FrameSetup) &&
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001082 (MBBI->getOpcode() == X86::PUSH32r ||
1083 MBBI->getOpcode() == X86::PUSH64r)) {
1084 PushedRegs = true;
1085 unsigned Reg = MBBI->getOperand(0).getReg();
1086 ++MBBI;
1087
1088 if (!HasFP && NeedsDwarfCFI) {
1089 // Mark callee-saved push instruction.
1090 // Define the current CFA rule to use the provided offset.
1091 assert(StackSize);
Reid Kleckner3854f7b2015-06-18 18:03:25 +00001092 BuildCFI(MBB, MBBI, DL,
Reid Kleckner7f189f82015-06-15 23:45:08 +00001093 MCCFIInstruction::createDefCfaOffset(nullptr, StackOffset));
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001094 StackOffset += stackGrowth;
1095 }
1096
Reid Kleckner1c140bd2015-06-16 18:08:57 +00001097 if (NeedsWinCFI) {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001098 BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_PushReg)).addImm(Reg).setMIFlag(
1099 MachineInstr::FrameSetup);
1100 }
1101 }
1102
1103 // Realign stack after we pushed callee-saved registers (so that we'll be
1104 // able to calculate their offsets from the frame pointer).
David Majnemer93c22a42015-02-10 00:57:42 +00001105 // Don't do this for Win64, it needs to realign the stack after the prologue.
Reid Klecknera13dfd52015-09-29 23:32:01 +00001106 if (!IsWin64Prologue && !IsFunclet && TRI->needsStackRealignment(MF)) {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001107 assert(HasFP && "There should be a frame pointer if stack is realigned.");
Reid Kleckner6ddae312015-11-05 21:09:49 +00001108 BuildStackAlignAND(MBB, MBBI, DL, StackPtr, MaxAlign);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001109 }
1110
1111 // If there is an SUB32ri of ESP immediately before this instruction, merge
1112 // the two. This can be the case when tail call elimination is enabled and
1113 // the callee has more arguments then the caller.
Reid Kleckner3854f7b2015-06-18 18:03:25 +00001114 NumBytes -= mergeSPUpdates(MBB, MBBI, true);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001115
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001116 // Adjust stack pointer: ESP -= numbytes.
1117
1118 // Windows and cygwin/mingw require a prologue helper routine when allocating
1119 // more than 4K bytes on the stack. Windows uses __chkstk and cygwin/mingw
1120 // uses __alloca. __alloca and the 32-bit version of __chkstk will probe the
1121 // stack and adjust the stack pointer in one go. The 64-bit version of
1122 // __chkstk is only responsible for probing the stack. The 64-bit prologue is
1123 // responsible for adjusting the stack pointer. Touching the stack at 4K
1124 // increments is necessary to ensure that the guard pages used by the OS
1125 // virtual memory manager are allocated in correct sequence.
David Majnemer89d05642015-02-21 01:04:47 +00001126 uint64_t AlignedNumBytes = NumBytes;
Reid Klecknera13dfd52015-09-29 23:32:01 +00001127 if (IsWin64Prologue && !IsFunclet && TRI->needsStackRealignment(MF))
David Majnemer89d05642015-02-21 01:04:47 +00001128 AlignedNumBytes = RoundUpToAlignment(AlignedNumBytes, MaxAlign);
1129 if (AlignedNumBytes >= StackProbeSize && UseStackProbe) {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001130 // Check whether EAX is livein for this function.
1131 bool isEAXAlive = isEAXLiveIn(MF);
1132
1133 if (isEAXAlive) {
1134 // Sanity check that EAX is not livein for this function.
1135 // It should not be, so throw an assert.
1136 assert(!Is64Bit && "EAX is livein in x64 case!");
1137
1138 // Save EAX
1139 BuildMI(MBB, MBBI, DL, TII.get(X86::PUSH32r))
1140 .addReg(X86::EAX, RegState::Kill)
1141 .setMIFlag(MachineInstr::FrameSetup);
1142 }
1143
1144 if (Is64Bit) {
1145 // Handle the 64-bit Windows ABI case where we need to call __chkstk.
1146 // Function prologue is responsible for adjusting the stack pointer.
David Majnemer006c4902015-02-23 21:50:30 +00001147 if (isUInt<32>(NumBytes)) {
1148 BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32ri), X86::EAX)
1149 .addImm(NumBytes)
1150 .setMIFlag(MachineInstr::FrameSetup);
1151 } else if (isInt<32>(NumBytes)) {
1152 BuildMI(MBB, MBBI, DL, TII.get(X86::MOV64ri32), X86::RAX)
1153 .addImm(NumBytes)
1154 .setMIFlag(MachineInstr::FrameSetup);
1155 } else {
1156 BuildMI(MBB, MBBI, DL, TII.get(X86::MOV64ri), X86::RAX)
1157 .addImm(NumBytes)
1158 .setMIFlag(MachineInstr::FrameSetup);
1159 }
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001160 } else {
1161 // Allocate NumBytes-4 bytes on stack in case of isEAXAlive.
1162 // We'll also use 4 already allocated bytes for EAX.
1163 BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32ri), X86::EAX)
Andy Ayers809cbe92015-11-10 01:50:49 +00001164 .addImm(isEAXAlive ? NumBytes - 4 : NumBytes)
1165 .setMIFlag(MachineInstr::FrameSetup);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001166 }
1167
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001168 // Call __chkstk, __chkstk_ms, or __alloca.
Andy Ayers809cbe92015-11-10 01:50:49 +00001169 emitStackProbe(MF, MBB, MBBI, DL, true);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001170
1171 if (isEAXAlive) {
1172 // Restore EAX
Andy Ayers809cbe92015-11-10 01:50:49 +00001173 MachineInstr *MI =
1174 addRegOffset(BuildMI(MF, DL, TII.get(X86::MOV32rm), X86::EAX),
1175 StackPtr, false, NumBytes - 4);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001176 MI->setFlag(MachineInstr::FrameSetup);
1177 MBB.insert(MBBI, MI);
1178 }
1179 } else if (NumBytes) {
Reid Kleckner98d78032015-06-18 20:22:12 +00001180 emitSPUpdate(MBB, MBBI, -(int64_t)NumBytes, /*InEpilogue=*/false);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001181 }
1182
Reid Kleckner1c140bd2015-06-16 18:08:57 +00001183 if (NeedsWinCFI && NumBytes)
David Majnemer93c22a42015-02-10 00:57:42 +00001184 BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_StackAlloc))
1185 .addImm(NumBytes)
1186 .setMIFlag(MachineInstr::FrameSetup);
1187
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001188 int SEHFrameOffset = 0;
Reid Kleckner6ddae312015-11-05 21:09:49 +00001189 unsigned SPOrEstablisher = IsFunclet ? Establisher : StackPtr;
Reid Kleckner1c140bd2015-06-16 18:08:57 +00001190 if (IsWin64Prologue && HasFP) {
Reid Klecknera13dfd52015-09-29 23:32:01 +00001191 // Set RBP to a small fixed offset from RSP. In the funclet case, we base
Joseph Tremoulet6afccf62015-11-05 02:20:07 +00001192 // this calculation on the incoming establisher, which holds the value of
1193 // RSP from the parent frame at the end of the prologue.
Reid Klecknera13dfd52015-09-29 23:32:01 +00001194 SEHFrameOffset = calculateSetFPREG(ParentFrameNumBytes);
David Majnemer31d868b2015-02-23 21:50:27 +00001195 if (SEHFrameOffset)
1196 addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(X86::LEA64r), FramePtr),
Joseph Tremoulet6afccf62015-11-05 02:20:07 +00001197 SPOrEstablisher, false, SEHFrameOffset);
David Majnemer31d868b2015-02-23 21:50:27 +00001198 else
Reid Klecknera13dfd52015-09-29 23:32:01 +00001199 BuildMI(MBB, MBBI, DL, TII.get(X86::MOV64rr), FramePtr)
Joseph Tremoulet6afccf62015-11-05 02:20:07 +00001200 .addReg(SPOrEstablisher);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001201
Reid Klecknera13dfd52015-09-29 23:32:01 +00001202 // If this is not a funclet, emit the CFI describing our frame pointer.
1203 if (NeedsWinCFI && !IsFunclet)
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001204 BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_SetFrame))
1205 .addImm(FramePtr)
1206 .addImm(SEHFrameOffset)
1207 .setMIFlag(MachineInstr::FrameSetup);
Reid Klecknera13dfd52015-09-29 23:32:01 +00001208 } else if (IsFunclet && STI.is32Bit()) {
1209 // Reset EBP / ESI to something good for funclets.
1210 MBBI = restoreWin32EHStackPointers(MBB, MBBI, DL);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001211 }
1212
David Majnemera7d908e2015-02-10 19:01:47 +00001213 while (MBBI != MBB.end() && MBBI->getFlag(MachineInstr::FrameSetup)) {
1214 const MachineInstr *FrameInstr = &*MBBI;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001215 ++MBBI;
1216
Reid Kleckner1c140bd2015-06-16 18:08:57 +00001217 if (NeedsWinCFI) {
David Majnemera7d908e2015-02-10 19:01:47 +00001218 int FI;
1219 if (unsigned Reg = TII.isStoreToStackSlot(FrameInstr, FI)) {
1220 if (X86::FR64RegClass.contains(Reg)) {
James Y Knight5567baf2015-08-15 02:32:35 +00001221 unsigned IgnoredFrameReg;
1222 int Offset = getFrameIndexReference(MF, FI, IgnoredFrameReg);
David Majnemera7d908e2015-02-10 19:01:47 +00001223 Offset += SEHFrameOffset;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001224
David Majnemera7d908e2015-02-10 19:01:47 +00001225 BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_SaveXMM))
1226 .addImm(Reg)
1227 .addImm(Offset)
1228 .setMIFlag(MachineInstr::FrameSetup);
1229 }
1230 }
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001231 }
David Majnemera7d908e2015-02-10 19:01:47 +00001232 }
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001233
Reid Kleckner1c140bd2015-06-16 18:08:57 +00001234 if (NeedsWinCFI)
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001235 BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_EndPrologue))
1236 .setMIFlag(MachineInstr::FrameSetup);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001237
David Majnemer93c22a42015-02-10 00:57:42 +00001238 // Realign stack after we spilled callee-saved registers (so that we'll be
1239 // able to calculate their offsets from the frame pointer).
1240 // Win64 requires aligning the stack after the prologue.
Reid Kleckner034ea962015-06-18 20:32:02 +00001241 if (IsWin64Prologue && TRI->needsStackRealignment(MF)) {
David Majnemer93c22a42015-02-10 00:57:42 +00001242 assert(HasFP && "There should be a frame pointer if stack is realigned.");
Reid Kleckner6ddae312015-11-05 21:09:49 +00001243 BuildStackAlignAND(MBB, MBBI, DL, SPOrEstablisher, MaxAlign);
David Majnemer93c22a42015-02-10 00:57:42 +00001244 }
1245
Reid Kleckner6ddae312015-11-05 21:09:49 +00001246 // We already dealt with stack realignment and funclets above.
1247 if (IsFunclet && STI.is32Bit())
1248 return;
1249
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001250 // If we need a base pointer, set it up here. It's whatever the value
1251 // of the stack pointer is at this point. Any variable size objects
1252 // will be allocated after this, so we can still use the base pointer
1253 // to reference locals.
Reid Kleckner034ea962015-06-18 20:32:02 +00001254 if (TRI->hasBasePointer(MF)) {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001255 // Update the base pointer with the current stack pointer.
1256 unsigned Opc = Uses64BitFramePtr ? X86::MOV64rr : X86::MOV32rr;
1257 BuildMI(MBB, MBBI, DL, TII.get(Opc), BasePtr)
Reid Kleckner6ddae312015-11-05 21:09:49 +00001258 .addReg(SPOrEstablisher)
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001259 .setMIFlag(MachineInstr::FrameSetup);
1260 if (X86FI->getRestoreBasePointer()) {
Reid Klecknere69bdb82015-07-07 23:45:58 +00001261 // Stash value of base pointer. Saving RSP instead of EBP shortens
1262 // dependence chain. Used by SjLj EH.
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001263 unsigned Opm = Uses64BitFramePtr ? X86::MOV64mr : X86::MOV32mr;
1264 addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(Opm)),
1265 FramePtr, true, X86FI->getRestoreBasePointerOffset())
Reid Kleckner6ddae312015-11-05 21:09:49 +00001266 .addReg(SPOrEstablisher)
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001267 .setMIFlag(MachineInstr::FrameSetup);
1268 }
Reid Klecknere69bdb82015-07-07 23:45:58 +00001269
Reid Kleckner6ddae312015-11-05 21:09:49 +00001270 if (X86FI->getHasSEHFramePtrSave() && !IsFunclet) {
Reid Klecknere69bdb82015-07-07 23:45:58 +00001271 // Stash the value of the frame pointer relative to the base pointer for
1272 // Win32 EH. This supports Win32 EH, which does the inverse of the above:
1273 // it recovers the frame pointer from the base pointer rather than the
1274 // other way around.
1275 unsigned Opm = Uses64BitFramePtr ? X86::MOV64mr : X86::MOV32mr;
Reid Klecknerdf129512015-09-08 22:44:41 +00001276 unsigned UsedReg;
1277 int Offset =
1278 getFrameIndexReference(MF, X86FI->getSEHFramePtrSaveIndex(), UsedReg);
1279 assert(UsedReg == BasePtr);
1280 addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(Opm)), UsedReg, true, Offset)
Reid Klecknere69bdb82015-07-07 23:45:58 +00001281 .addReg(FramePtr)
1282 .setMIFlag(MachineInstr::FrameSetup);
1283 }
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001284 }
1285
1286 if (((!HasFP && NumBytes) || PushedRegs) && NeedsDwarfCFI) {
1287 // Mark end of stack pointer adjustment.
1288 if (!HasFP && NumBytes) {
1289 // Define the current CFA rule to use the provided offset.
1290 assert(StackSize);
Reid Kleckner3854f7b2015-06-18 18:03:25 +00001291 BuildCFI(MBB, MBBI, DL, MCCFIInstruction::createDefCfaOffset(
1292 nullptr, -StackSize + stackGrowth));
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001293 }
1294
1295 // Emit DWARF info specifying the offsets of the callee-saved registers.
1296 if (PushedRegs)
1297 emitCalleeSavedFrameMoves(MBB, MBBI, DL);
1298 }
1299}
1300
Quentin Colombetaa8020752015-05-27 06:28:41 +00001301bool X86FrameLowering::canUseLEAForSPInEpilogue(
1302 const MachineFunction &MF) const {
Quentin Colombet494eb602015-05-22 18:10:47 +00001303 // We can't use LEA instructions for adjusting the stack pointer if this is a
1304 // leaf function in the Win64 ABI. Only ADD instructions may be used to
1305 // deallocate the stack.
1306 // This means that we can use LEA for SP in two situations:
1307 // 1. We *aren't* using the Win64 ABI which means we are free to use LEA.
1308 // 2. We *have* a frame pointer which means we are permitted to use LEA.
Quentin Colombetaa8020752015-05-27 06:28:41 +00001309 return !MF.getTarget().getMCAsmInfo()->usesWindowsCFI() || hasFP(MF);
1310}
1311
Reid Klecknerdf129512015-09-08 22:44:41 +00001312static bool isFuncletReturnInstr(MachineInstr *MI) {
1313 switch (MI->getOpcode()) {
1314 case X86::CATCHRET:
Reid Kleckner78783912015-09-10 00:25:23 +00001315 case X86::CLEANUPRET:
Reid Klecknerdf129512015-09-08 22:44:41 +00001316 return true;
1317 default:
1318 return false;
1319 }
1320 llvm_unreachable("impossible");
1321}
1322
Reid Kleckner28e49032015-10-16 23:43:27 +00001323unsigned X86FrameLowering::getWinEHFuncletFrameSize(const MachineFunction &MF) const {
1324 // This is the size of the pushed CSRs.
1325 unsigned CSSize =
1326 MF.getInfo<X86MachineFunctionInfo>()->getCalleeSavedFrameSize();
1327 // This is the amount of stack a funclet needs to allocate.
1328 unsigned MaxCallSize = MF.getFrameInfo()->getMaxCallFrameSize();
1329 // RBP is not included in the callee saved register block. After pushing RBP,
1330 // everything is 16 byte aligned. Everything we allocate before an outgoing
1331 // call must also be 16 byte aligned.
1332 unsigned FrameSizeMinusRBP =
1333 RoundUpToAlignment(CSSize + MaxCallSize, getStackAlignment());
1334 // Subtract out the size of the callee saved registers. This is how much stack
1335 // each funclet will allocate.
1336 return FrameSizeMinusRBP - CSSize;
1337}
1338
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001339void X86FrameLowering::emitEpilogue(MachineFunction &MF,
1340 MachineBasicBlock &MBB) const {
1341 const MachineFrameInfo *MFI = MF.getFrameInfo();
1342 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
Quentin Colombetaa8020752015-05-27 06:28:41 +00001343 MachineBasicBlock::iterator MBBI = MBB.getFirstTerminator();
1344 DebugLoc DL;
1345 if (MBBI != MBB.end())
1346 DL = MBBI->getDebugLoc();
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001347 // standard x86_64 and NaCl use 64-bit frame/stack pointers, x32 - 32-bit.
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001348 const bool Is64BitILP32 = STI.isTarget64BitILP32();
Reid Kleckner034ea962015-06-18 20:32:02 +00001349 unsigned FramePtr = TRI->getFrameRegister(MF);
Eric Christopher05b81972015-02-02 17:38:43 +00001350 unsigned MachineFramePtr =
1351 Is64BitILP32 ? getX86SubSuperRegister(FramePtr, MVT::i64, false)
1352 : FramePtr;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001353
Reid Kleckner1c140bd2015-06-16 18:08:57 +00001354 bool IsWin64Prologue = MF.getTarget().getMCAsmInfo()->usesWindowsCFI();
1355 bool NeedsWinCFI =
1356 IsWin64Prologue && MF.getFunction()->needsUnwindTableEntry();
Reid Kleckner97797412015-10-07 23:55:01 +00001357 bool IsFunclet = isFuncletReturnInstr(MBBI);
Reid Kleckner51460c12015-11-06 01:49:05 +00001358 MachineBasicBlock *TargetMBB = nullptr;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001359
1360 // Get the number of bytes to allocate from the FrameInfo.
1361 uint64_t StackSize = MFI->getStackSize();
David Majnemer93c22a42015-02-10 00:57:42 +00001362 uint64_t MaxAlign = calculateMaxStackAlign(MF);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001363 unsigned CSSize = X86FI->getCalleeSavedFrameSize();
1364 uint64_t NumBytes = 0;
1365
Reid Kleckner5b8a46e2015-09-17 20:43:47 +00001366 if (MBBI->getOpcode() == X86::CATCHRET) {
Reid Kleckner51460c12015-11-06 01:49:05 +00001367 // SEH shouldn't use catchret.
1368 assert(!isAsynchronousEHPersonality(
1369 classifyEHPersonality(MF.getFunction()->getPersonalityFn())) &&
1370 "SEH should not use CATCHRET");
1371
Reid Kleckner28e49032015-10-16 23:43:27 +00001372 NumBytes = getWinEHFuncletFrameSize(MF);
Reid Kleckner5b8a46e2015-09-17 20:43:47 +00001373 assert(hasFP(MF) && "EH funclets without FP not yet implemented");
Reid Kleckner51460c12015-11-06 01:49:05 +00001374 TargetMBB = MBBI->getOperand(0).getMBB();
David Majnemer91b0ab92015-09-29 22:33:36 +00001375
Reid Klecknerda6dcc52015-09-10 22:00:02 +00001376 // Pop EBP.
1377 BuildMI(MBB, MBBI, DL, TII.get(Is64Bit ? X86::POP64r : X86::POP32r),
Reid Kleckner5b8a46e2015-09-17 20:43:47 +00001378 MachineFramePtr)
1379 .setMIFlag(MachineInstr::FrameDestroy);
David Majnemer91b0ab92015-09-29 22:33:36 +00001380 } else if (MBBI->getOpcode() == X86::CLEANUPRET) {
Reid Kleckner28e49032015-10-16 23:43:27 +00001381 NumBytes = getWinEHFuncletFrameSize(MF);
Reid Kleckner5b8a46e2015-09-17 20:43:47 +00001382 assert(hasFP(MF) && "EH funclets without FP not yet implemented");
1383 BuildMI(MBB, MBBI, DL, TII.get(Is64Bit ? X86::POP64r : X86::POP32r),
1384 MachineFramePtr)
1385 .setMIFlag(MachineInstr::FrameDestroy);
Reid Klecknerdf129512015-09-08 22:44:41 +00001386 } else if (hasFP(MF)) {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001387 // Calculate required stack adjustment.
1388 uint64_t FrameSize = StackSize - SlotSize;
David Majnemer89d05642015-02-21 01:04:47 +00001389 NumBytes = FrameSize - CSSize;
1390
1391 // Callee-saved registers were pushed on stack before the stack was
1392 // realigned.
Reid Kleckner034ea962015-06-18 20:32:02 +00001393 if (TRI->needsStackRealignment(MF) && !IsWin64Prologue)
David Majnemer89d05642015-02-21 01:04:47 +00001394 NumBytes = RoundUpToAlignment(FrameSize, MaxAlign);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001395
1396 // Pop EBP.
1397 BuildMI(MBB, MBBI, DL,
Michael Kuperstein098cd9f2015-09-16 11:18:25 +00001398 TII.get(Is64Bit ? X86::POP64r : X86::POP32r), MachineFramePtr)
1399 .setMIFlag(MachineInstr::FrameDestroy);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001400 } else {
1401 NumBytes = StackSize - CSSize;
1402 }
David Majnemer93c22a42015-02-10 00:57:42 +00001403 uint64_t SEHStackAllocAmt = NumBytes;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001404
1405 // Skip the callee-saved pop instructions.
1406 while (MBBI != MBB.begin()) {
1407 MachineBasicBlock::iterator PI = std::prev(MBBI);
1408 unsigned Opc = PI->getOpcode();
1409
Michael Kuperstein098cd9f2015-09-16 11:18:25 +00001410 if ((Opc != X86::POP32r || !PI->getFlag(MachineInstr::FrameDestroy)) &&
1411 (Opc != X86::POP64r || !PI->getFlag(MachineInstr::FrameDestroy)) &&
1412 Opc != X86::DBG_VALUE && !PI->isTerminator())
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001413 break;
1414
1415 --MBBI;
1416 }
1417 MachineBasicBlock::iterator FirstCSPop = MBBI;
1418
Reid Kleckner51460c12015-11-06 01:49:05 +00001419 if (TargetMBB) {
David Majnemer35d27b22015-10-09 22:18:45 +00001420 // Fill EAX/RAX with the address of the target block.
1421 unsigned ReturnReg = STI.is64Bit() ? X86::RAX : X86::EAX;
1422 if (STI.is64Bit()) {
Reid Kleckner51460c12015-11-06 01:49:05 +00001423 // LEA64r TargetMBB(%rip), %rax
David Majnemer35d27b22015-10-09 22:18:45 +00001424 BuildMI(MBB, FirstCSPop, DL, TII.get(X86::LEA64r), ReturnReg)
1425 .addReg(X86::RIP)
1426 .addImm(0)
1427 .addReg(0)
Reid Kleckner51460c12015-11-06 01:49:05 +00001428 .addMBB(TargetMBB)
David Majnemer35d27b22015-10-09 22:18:45 +00001429 .addReg(0);
1430 } else {
Reid Kleckner51460c12015-11-06 01:49:05 +00001431 // MOV32ri $TargetMBB, %eax
Reid Kleckner64b003f2015-11-09 21:04:00 +00001432 BuildMI(MBB, FirstCSPop, DL, TII.get(X86::MOV32ri), ReturnReg)
Reid Kleckner51460c12015-11-06 01:49:05 +00001433 .addMBB(TargetMBB);
David Majnemer35d27b22015-10-09 22:18:45 +00001434 }
Reid Kleckner51460c12015-11-06 01:49:05 +00001435 // Record that we've taken the address of TargetMBB and no longer just
Joseph Tremoulet3d0fbf12015-10-23 15:06:05 +00001436 // reference it in a terminator.
Reid Kleckner51460c12015-11-06 01:49:05 +00001437 TargetMBB->setHasAddressTaken();
David Majnemer35d27b22015-10-09 22:18:45 +00001438 }
1439
Quentin Colombetaa8020752015-05-27 06:28:41 +00001440 if (MBBI != MBB.end())
1441 DL = MBBI->getDebugLoc();
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001442
1443 // If there is an ADD32ri or SUB32ri of ESP immediately before this
1444 // instruction, merge the two instructions.
1445 if (NumBytes || MFI->hasVarSizedObjects())
Michael Kupersteincba308c2015-07-28 08:56:13 +00001446 NumBytes += mergeSPUpdates(MBB, MBBI, true);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001447
1448 // If dynamic alloca is used, then reset esp to point to the last callee-saved
1449 // slot before popping them off! Same applies for the case, when stack was
Reid Kleckner97797412015-10-07 23:55:01 +00001450 // realigned. Don't do this if this was a funclet epilogue, since the funclets
1451 // will not do realignment or dynamic stack allocation.
1452 if ((TRI->needsStackRealignment(MF) || MFI->hasVarSizedObjects()) &&
1453 !IsFunclet) {
Reid Kleckner034ea962015-06-18 20:32:02 +00001454 if (TRI->needsStackRealignment(MF))
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001455 MBBI = FirstCSPop;
David Majnemere1bbad92015-02-25 21:13:37 +00001456 unsigned SEHFrameOffset = calculateSetFPREG(SEHStackAllocAmt);
Reid Kleckner1c140bd2015-06-16 18:08:57 +00001457 uint64_t LEAAmount =
1458 IsWin64Prologue ? SEHStackAllocAmt - SEHFrameOffset : -CSSize;
David Majnemere1bbad92015-02-25 21:13:37 +00001459
1460 // There are only two legal forms of epilogue:
1461 // - add SEHAllocationSize, %rsp
1462 // - lea SEHAllocationSize(%FramePtr), %rsp
1463 //
1464 // 'mov %FramePtr, %rsp' will not be recognized as an epilogue sequence.
1465 // However, we may use this sequence if we have a frame pointer because the
1466 // effects of the prologue can safely be undone.
1467 if (LEAAmount != 0) {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001468 unsigned Opc = getLEArOpcode(Uses64BitFramePtr);
1469 addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr),
David Majnemere1bbad92015-02-25 21:13:37 +00001470 FramePtr, false, LEAAmount);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001471 --MBBI;
1472 } else {
1473 unsigned Opc = (Uses64BitFramePtr ? X86::MOV64rr : X86::MOV32rr);
1474 BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr)
1475 .addReg(FramePtr);
1476 --MBBI;
1477 }
1478 } else if (NumBytes) {
1479 // Adjust stack pointer back: ESP += numbytes.
Reid Kleckner98d78032015-06-18 20:22:12 +00001480 emitSPUpdate(MBB, MBBI, NumBytes, /*InEpilogue=*/true);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001481 --MBBI;
1482 }
1483
1484 // Windows unwinder will not invoke function's exception handler if IP is
1485 // either in prologue or in epilogue. This behavior causes a problem when a
1486 // call immediately precedes an epilogue, because the return address points
1487 // into the epilogue. To cope with that, we insert an epilogue marker here,
1488 // then replace it with a 'nop' if it ends up immediately after a CALL in the
1489 // final emitted code.
Reid Kleckner1c140bd2015-06-16 18:08:57 +00001490 if (NeedsWinCFI)
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001491 BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_Epilogue));
1492
Quentin Colombet494eb602015-05-22 18:10:47 +00001493 // Add the return addr area delta back since we are not tail calling.
1494 int Offset = -1 * X86FI->getTCReturnAddrDelta();
1495 assert(Offset >= 0 && "TCDelta should never be positive");
1496 if (Offset) {
1497 MBBI = MBB.getFirstTerminator();
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001498
1499 // Check for possible merge with preceding ADD instruction.
Reid Kleckner3854f7b2015-06-18 18:03:25 +00001500 Offset += mergeSPUpdates(MBB, MBBI, true);
Reid Kleckner98d78032015-06-18 20:22:12 +00001501 emitSPUpdate(MBB, MBBI, Offset, /*InEpilogue=*/true);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001502 }
1503}
1504
James Y Knight5567baf2015-08-15 02:32:35 +00001505// NOTE: this only has a subset of the full frame index logic. In
1506// particular, the FI < 0 and AfterFPPop logic is handled in
1507// X86RegisterInfo::eliminateFrameIndex, but not here. Possibly
1508// (probably?) it should be moved into here.
1509int X86FrameLowering::getFrameIndexReference(const MachineFunction &MF, int FI,
1510 unsigned &FrameReg) const {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001511 const MachineFrameInfo *MFI = MF.getFrameInfo();
James Y Knight5567baf2015-08-15 02:32:35 +00001512
1513 // We can't calculate offset from frame pointer if the stack is realigned,
1514 // so enforce usage of stack/base pointer. The base pointer is used when we
1515 // have dynamic allocas in addition to dynamic realignment.
1516 if (TRI->hasBasePointer(MF))
1517 FrameReg = TRI->getBaseRegister();
1518 else if (TRI->needsStackRealignment(MF))
1519 FrameReg = TRI->getStackRegister();
1520 else
1521 FrameReg = TRI->getFrameRegister(MF);
1522
David Majnemer93c22a42015-02-10 00:57:42 +00001523 // Offset will hold the offset from the stack pointer at function entry to the
1524 // object.
1525 // We need to factor in additional offsets applied during the prologue to the
1526 // frame, base, and stack pointer depending on which is used.
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001527 int Offset = MFI->getObjectOffset(FI) - getOffsetOfLocalArea();
David Majnemer93c22a42015-02-10 00:57:42 +00001528 const X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1529 unsigned CSSize = X86FI->getCalleeSavedFrameSize();
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001530 uint64_t StackSize = MFI->getStackSize();
David Majnemer93c22a42015-02-10 00:57:42 +00001531 bool HasFP = hasFP(MF);
Reid Kleckner1c140bd2015-06-16 18:08:57 +00001532 bool IsWin64Prologue = MF.getTarget().getMCAsmInfo()->usesWindowsCFI();
David Majnemer93c22a42015-02-10 00:57:42 +00001533 int64_t FPDelta = 0;
1534
Reid Kleckner1c140bd2015-06-16 18:08:57 +00001535 if (IsWin64Prologue) {
David Majnemer89d05642015-02-21 01:04:47 +00001536 assert(!MFI->hasCalls() || (StackSize % 16) == 8);
1537
David Majnemer93c22a42015-02-10 00:57:42 +00001538 // Calculate required stack adjustment.
1539 uint64_t FrameSize = StackSize - SlotSize;
1540 // If required, include space for extra hidden slot for stashing base pointer.
1541 if (X86FI->getRestoreBasePointer())
1542 FrameSize += SlotSize;
David Majnemer89d05642015-02-21 01:04:47 +00001543 uint64_t NumBytes = FrameSize - CSSize;
David Majnemer93c22a42015-02-10 00:57:42 +00001544
David Majnemer93c22a42015-02-10 00:57:42 +00001545 uint64_t SEHFrameOffset = calculateSetFPREG(NumBytes);
David Majnemer13d0b112015-02-10 21:22:05 +00001546 if (FI && FI == X86FI->getFAIndex())
1547 return -SEHFrameOffset;
1548
David Majnemer93c22a42015-02-10 00:57:42 +00001549 // FPDelta is the offset from the "traditional" FP location of the old base
1550 // pointer followed by return address and the location required by the
1551 // restricted Win64 prologue.
1552 // Add FPDelta to all offsets below that go through the frame pointer.
David Majnemer89d05642015-02-21 01:04:47 +00001553 FPDelta = FrameSize - SEHFrameOffset;
1554 assert((!MFI->hasCalls() || (FPDelta % 16) == 0) &&
1555 "FPDelta isn't aligned per the Win64 ABI!");
David Majnemer93c22a42015-02-10 00:57:42 +00001556 }
1557
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001558
Reid Kleckner034ea962015-06-18 20:32:02 +00001559 if (TRI->hasBasePointer(MF)) {
David Majnemer93c22a42015-02-10 00:57:42 +00001560 assert(HasFP && "VLAs and dynamic stack realign, but no FP?!");
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001561 if (FI < 0) {
1562 // Skip the saved EBP.
David Majnemer93c22a42015-02-10 00:57:42 +00001563 return Offset + SlotSize + FPDelta;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001564 } else {
1565 assert((-(Offset + StackSize)) % MFI->getObjectAlignment(FI) == 0);
1566 return Offset + StackSize;
1567 }
Reid Kleckner034ea962015-06-18 20:32:02 +00001568 } else if (TRI->needsStackRealignment(MF)) {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001569 if (FI < 0) {
1570 // Skip the saved EBP.
David Majnemer93c22a42015-02-10 00:57:42 +00001571 return Offset + SlotSize + FPDelta;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001572 } else {
1573 assert((-(Offset + StackSize)) % MFI->getObjectAlignment(FI) == 0);
1574 return Offset + StackSize;
1575 }
1576 // FIXME: Support tail calls
1577 } else {
David Majnemer93c22a42015-02-10 00:57:42 +00001578 if (!HasFP)
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001579 return Offset + StackSize;
1580
1581 // Skip the saved EBP.
David Majnemer93c22a42015-02-10 00:57:42 +00001582 Offset += SlotSize;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001583
1584 // Skip the RETADDR move area
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001585 int TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
1586 if (TailCallReturnAddrDelta < 0)
1587 Offset -= TailCallReturnAddrDelta;
1588 }
1589
David Majnemer89d05642015-02-21 01:04:47 +00001590 return Offset + FPDelta;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001591}
1592
James Y Knight5567baf2015-08-15 02:32:35 +00001593// Simplified from getFrameIndexReference keeping only StackPointer cases
1594int X86FrameLowering::getFrameIndexReferenceFromSP(const MachineFunction &MF,
1595 int FI,
1596 unsigned &FrameReg) const {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001597 const MachineFrameInfo *MFI = MF.getFrameInfo();
1598 // Does not include any dynamic realign.
1599 const uint64_t StackSize = MFI->getStackSize();
1600 {
1601#ifndef NDEBUG
Reid Kleckner6ddae312015-11-05 21:09:49 +00001602 // LLVM arranges the stack as follows:
1603 // ...
1604 // ARG2
1605 // ARG1
1606 // RETADDR
1607 // PUSH RBP <-- RBP points here
1608 // PUSH CSRs
1609 // ~~~~~~~ <-- optional stack realignment dynamic adjustment
1610 // ...
1611 // STACK OBJECTS
1612 // ... <-- RSP after prologue points here
1613 //
1614 // if (hasVarSizedObjects()):
1615 // ... <-- "base pointer" (ESI/RBX) points here
1616 // DYNAMIC ALLOCAS
1617 // ... <-- RSP points here
1618 //
1619 // Case 1: In the simple case of no stack realignment and no dynamic
1620 // allocas, both "fixed" stack objects (arguments and CSRs) are addressable
1621 // with fixed offsets from RSP.
1622 //
1623 // Case 2: In the case of stack realignment with no dynamic allocas, fixed
1624 // stack objects are addressed with RBP and regular stack objects with RSP.
1625 //
1626 // Case 3: In the case of dynamic allocas and stack realignment, RSP is used
1627 // to address stack arguments for outgoing calls and nothing else. The "base
1628 // pointer" points to local variables, and RBP points to fixed objects.
1629 //
1630 // In cases 2 and 3, we can only answer for non-fixed stack objects, and the
1631 // answer we give is relative to the SP after the prologue, and not the
1632 // SP in the middle of the function.
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001633
Reid Kleckner6ddae312015-11-05 21:09:49 +00001634 assert((!TRI->needsStackRealignment(MF) || !MFI->isFixedObjectIndex(FI)) &&
1635 "offset from fixed object to SP is not static");
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001636
Reid Kleckner6ddae312015-11-05 21:09:49 +00001637 // We don't handle tail calls, and shouldn't be seeing them either.
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001638 int TailCallReturnAddrDelta =
1639 MF.getInfo<X86MachineFunctionInfo>()->getTCReturnAddrDelta();
1640 assert(!(TailCallReturnAddrDelta < 0) && "we don't handle this case!");
1641#endif
1642 }
1643
James Y Knight5567baf2015-08-15 02:32:35 +00001644 // Fill in FrameReg output argument.
1645 FrameReg = TRI->getStackRegister();
1646
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001647 // This is how the math works out:
1648 //
1649 // %rsp grows (i.e. gets lower) left to right. Each box below is
1650 // one word (eight bytes). Obj0 is the stack slot we're trying to
1651 // get to.
1652 //
1653 // ----------------------------------
1654 // | BP | Obj0 | Obj1 | ... | ObjN |
1655 // ----------------------------------
1656 // ^ ^ ^ ^
1657 // A B C E
1658 //
1659 // A is the incoming stack pointer.
1660 // (B - A) is the local area offset (-8 for x86-64) [1]
1661 // (C - A) is the Offset returned by MFI->getObjectOffset for Obj0 [2]
1662 //
1663 // |(E - B)| is the StackSize (absolute value, positive). For a
1664 // stack that grown down, this works out to be (B - E). [3]
1665 //
1666 // E is also the value of %rsp after stack has been set up, and we
1667 // want (C - E) -- the value we can add to %rsp to get to Obj0. Now
1668 // (C - E) == (C - A) - (B - A) + (B - E)
1669 // { Using [1], [2] and [3] above }
1670 // == getObjectOffset - LocalAreaOffset + StackSize
1671 //
1672
1673 // Get the Offset from the StackPointer
1674 int Offset = MFI->getObjectOffset(FI) - getOffsetOfLocalArea();
1675
1676 return Offset + StackSize;
1677}
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001678
1679bool X86FrameLowering::assignCalleeSavedSpillSlots(
1680 MachineFunction &MF, const TargetRegisterInfo *TRI,
1681 std::vector<CalleeSavedInfo> &CSI) const {
1682 MachineFrameInfo *MFI = MF.getFrameInfo();
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001683 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1684
1685 unsigned CalleeSavedFrameSize = 0;
1686 int SpillSlotOffset = getOffsetOfLocalArea() + X86FI->getTCReturnAddrDelta();
1687
1688 if (hasFP(MF)) {
1689 // emitPrologue always spills frame register the first thing.
1690 SpillSlotOffset -= SlotSize;
1691 MFI->CreateFixedSpillStackObject(SlotSize, SpillSlotOffset);
1692
1693 // Since emitPrologue and emitEpilogue will handle spilling and restoring of
1694 // the frame register, we can delete it from CSI list and not have to worry
1695 // about avoiding it later.
Reid Kleckner034ea962015-06-18 20:32:02 +00001696 unsigned FPReg = TRI->getFrameRegister(MF);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001697 for (unsigned i = 0; i < CSI.size(); ++i) {
1698 if (TRI->regsOverlap(CSI[i].getReg(),FPReg)) {
1699 CSI.erase(CSI.begin() + i);
1700 break;
1701 }
1702 }
1703 }
1704
1705 // Assign slots for GPRs. It increases frame size.
1706 for (unsigned i = CSI.size(); i != 0; --i) {
1707 unsigned Reg = CSI[i - 1].getReg();
1708
1709 if (!X86::GR64RegClass.contains(Reg) && !X86::GR32RegClass.contains(Reg))
1710 continue;
1711
1712 SpillSlotOffset -= SlotSize;
1713 CalleeSavedFrameSize += SlotSize;
1714
1715 int SlotIndex = MFI->CreateFixedSpillStackObject(SlotSize, SpillSlotOffset);
1716 CSI[i - 1].setFrameIdx(SlotIndex);
1717 }
1718
1719 X86FI->setCalleeSavedFrameSize(CalleeSavedFrameSize);
1720
1721 // Assign slots for XMMs.
1722 for (unsigned i = CSI.size(); i != 0; --i) {
1723 unsigned Reg = CSI[i - 1].getReg();
1724 if (X86::GR64RegClass.contains(Reg) || X86::GR32RegClass.contains(Reg))
1725 continue;
1726
Reid Kleckner034ea962015-06-18 20:32:02 +00001727 const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001728 // ensure alignment
1729 SpillSlotOffset -= std::abs(SpillSlotOffset) % RC->getAlignment();
1730 // spill into slot
1731 SpillSlotOffset -= RC->getSize();
1732 int SlotIndex =
1733 MFI->CreateFixedSpillStackObject(RC->getSize(), SpillSlotOffset);
1734 CSI[i - 1].setFrameIdx(SlotIndex);
1735 MFI->ensureMaxAlignment(RC->getAlignment());
1736 }
1737
1738 return true;
1739}
1740
1741bool X86FrameLowering::spillCalleeSavedRegisters(
1742 MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
1743 const std::vector<CalleeSavedInfo> &CSI,
1744 const TargetRegisterInfo *TRI) const {
1745 DebugLoc DL = MBB.findDebugLoc(MI);
1746
Reid Klecknerdf129512015-09-08 22:44:41 +00001747 // Don't save CSRs in 32-bit EH funclets. The caller saves EBX, EBP, ESI, EDI
1748 // for us, and there are no XMM CSRs on Win32.
1749 if (MBB.isEHFuncletEntry() && STI.is32Bit() && STI.isOSWindows())
1750 return true;
1751
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001752 // Push GPRs. It increases frame size.
1753 unsigned Opc = STI.is64Bit() ? X86::PUSH64r : X86::PUSH32r;
1754 for (unsigned i = CSI.size(); i != 0; --i) {
1755 unsigned Reg = CSI[i - 1].getReg();
1756
1757 if (!X86::GR64RegClass.contains(Reg) && !X86::GR32RegClass.contains(Reg))
1758 continue;
1759 // Add the callee-saved register as live-in. It's killed at the spill.
1760 MBB.addLiveIn(Reg);
1761
1762 BuildMI(MBB, MI, DL, TII.get(Opc)).addReg(Reg, RegState::Kill)
1763 .setMIFlag(MachineInstr::FrameSetup);
1764 }
1765
1766 // Make XMM regs spilled. X86 does not have ability of push/pop XMM.
1767 // It can be done by spilling XMMs to stack frame.
1768 for (unsigned i = CSI.size(); i != 0; --i) {
1769 unsigned Reg = CSI[i-1].getReg();
David Majnemera7d908e2015-02-10 19:01:47 +00001770 if (X86::GR64RegClass.contains(Reg) || X86::GR32RegClass.contains(Reg))
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001771 continue;
1772 // Add the callee-saved register as live-in. It's killed at the spill.
1773 MBB.addLiveIn(Reg);
1774 const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
1775
1776 TII.storeRegToStackSlot(MBB, MI, Reg, true, CSI[i - 1].getFrameIdx(), RC,
1777 TRI);
1778 --MI;
1779 MI->setFlag(MachineInstr::FrameSetup);
1780 ++MI;
1781 }
1782
1783 return true;
1784}
1785
1786bool X86FrameLowering::restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
1787 MachineBasicBlock::iterator MI,
1788 const std::vector<CalleeSavedInfo> &CSI,
1789 const TargetRegisterInfo *TRI) const {
1790 if (CSI.empty())
1791 return false;
1792
Reid Klecknerfc64fae2015-10-01 21:38:24 +00001793 if (isFuncletReturnInstr(MI) && STI.isOSWindows()) {
1794 // Don't restore CSRs in 32-bit EH funclets. Matches
1795 // spillCalleeSavedRegisters.
1796 if (STI.is32Bit())
1797 return true;
1798 // Don't restore CSRs before an SEH catchret. SEH except blocks do not form
1799 // funclets. emitEpilogue transforms these to normal jumps.
1800 if (MI->getOpcode() == X86::CATCHRET) {
1801 const Function *Func = MBB.getParent()->getFunction();
1802 bool IsSEH = isAsynchronousEHPersonality(
1803 classifyEHPersonality(Func->getPersonalityFn()));
1804 if (IsSEH)
1805 return true;
1806 }
1807 }
Reid Klecknerdf129512015-09-08 22:44:41 +00001808
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001809 DebugLoc DL = MBB.findDebugLoc(MI);
1810
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001811 // Reload XMMs from stack frame.
1812 for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1813 unsigned Reg = CSI[i].getReg();
1814 if (X86::GR64RegClass.contains(Reg) ||
1815 X86::GR32RegClass.contains(Reg))
1816 continue;
1817
1818 const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
1819 TII.loadRegFromStackSlot(MBB, MI, Reg, CSI[i].getFrameIdx(), RC, TRI);
1820 }
1821
1822 // POP GPRs.
1823 unsigned Opc = STI.is64Bit() ? X86::POP64r : X86::POP32r;
1824 for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1825 unsigned Reg = CSI[i].getReg();
1826 if (!X86::GR64RegClass.contains(Reg) &&
1827 !X86::GR32RegClass.contains(Reg))
1828 continue;
1829
Michael Kuperstein098cd9f2015-09-16 11:18:25 +00001830 BuildMI(MBB, MI, DL, TII.get(Opc), Reg)
1831 .setMIFlag(MachineInstr::FrameDestroy);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001832 }
1833 return true;
1834}
1835
Matthias Braun02564862015-07-14 17:17:13 +00001836void X86FrameLowering::determineCalleeSaves(MachineFunction &MF,
1837 BitVector &SavedRegs,
1838 RegScavenger *RS) const {
1839 TargetFrameLowering::determineCalleeSaves(MF, SavedRegs, RS);
1840
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001841 MachineFrameInfo *MFI = MF.getFrameInfo();
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001842
1843 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1844 int64_t TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
1845
1846 if (TailCallReturnAddrDelta < 0) {
1847 // create RETURNADDR area
1848 // arg
1849 // arg
1850 // RETADDR
1851 // { ...
1852 // RETADDR area
1853 // ...
1854 // }
1855 // [EBP]
1856 MFI->CreateFixedObject(-TailCallReturnAddrDelta,
1857 TailCallReturnAddrDelta - SlotSize, true);
1858 }
1859
1860 // Spill the BasePtr if it's used.
Reid Klecknerdf129512015-09-08 22:44:41 +00001861 if (TRI->hasBasePointer(MF)) {
Matthias Braun02564862015-07-14 17:17:13 +00001862 SavedRegs.set(TRI->getBaseRegister());
Reid Klecknerdf129512015-09-08 22:44:41 +00001863
1864 // Allocate a spill slot for EBP if we have a base pointer and EH funclets.
1865 if (MF.getMMI().hasEHFunclets()) {
1866 int FI = MFI->CreateSpillStackObject(SlotSize, SlotSize);
1867 X86FI->setHasSEHFramePtrSave(true);
1868 X86FI->setSEHFramePtrSaveIndex(FI);
1869 }
1870 }
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001871}
1872
1873static bool
1874HasNestArgument(const MachineFunction *MF) {
1875 const Function *F = MF->getFunction();
1876 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1877 I != E; I++) {
1878 if (I->hasNestAttr())
1879 return true;
1880 }
1881 return false;
1882}
1883
1884/// GetScratchRegister - Get a temp register for performing work in the
1885/// segmented stack and the Erlang/HiPE stack prologue. Depending on platform
1886/// and the properties of the function either one or two registers will be
1887/// needed. Set primary to true for the first register, false for the second.
1888static unsigned
1889GetScratchRegister(bool Is64Bit, bool IsLP64, const MachineFunction &MF, bool Primary) {
1890 CallingConv::ID CallingConvention = MF.getFunction()->getCallingConv();
1891
1892 // Erlang stuff.
1893 if (CallingConvention == CallingConv::HiPE) {
1894 if (Is64Bit)
1895 return Primary ? X86::R14 : X86::R13;
1896 else
1897 return Primary ? X86::EBX : X86::EDI;
1898 }
1899
1900 if (Is64Bit) {
1901 if (IsLP64)
1902 return Primary ? X86::R11 : X86::R12;
1903 else
1904 return Primary ? X86::R11D : X86::R12D;
1905 }
1906
1907 bool IsNested = HasNestArgument(&MF);
1908
1909 if (CallingConvention == CallingConv::X86_FastCall ||
1910 CallingConvention == CallingConv::Fast) {
1911 if (IsNested)
1912 report_fatal_error("Segmented stacks does not support fastcall with "
1913 "nested function.");
1914 return Primary ? X86::EAX : X86::ECX;
1915 }
1916 if (IsNested)
1917 return Primary ? X86::EDX : X86::EAX;
1918 return Primary ? X86::ECX : X86::EAX;
1919}
1920
1921// The stack limit in the TCB is set to this many bytes above the actual stack
1922// limit.
1923static const uint64_t kSplitStackAvailable = 256;
1924
Quentin Colombet61b305e2015-05-05 17:38:16 +00001925void X86FrameLowering::adjustForSegmentedStacks(
1926 MachineFunction &MF, MachineBasicBlock &PrologueMBB) const {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001927 MachineFrameInfo *MFI = MF.getFrameInfo();
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001928 uint64_t StackSize;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001929 unsigned TlsReg, TlsOffset;
1930 DebugLoc DL;
1931
1932 unsigned ScratchReg = GetScratchRegister(Is64Bit, IsLP64, MF, true);
1933 assert(!MF.getRegInfo().isLiveIn(ScratchReg) &&
1934 "Scratch register is live-in");
1935
1936 if (MF.getFunction()->isVarArg())
1937 report_fatal_error("Segmented stacks do not support vararg functions.");
1938 if (!STI.isTargetLinux() && !STI.isTargetDarwin() && !STI.isTargetWin32() &&
1939 !STI.isTargetWin64() && !STI.isTargetFreeBSD() &&
1940 !STI.isTargetDragonFly())
1941 report_fatal_error("Segmented stacks not supported on this platform.");
1942
1943 // Eventually StackSize will be calculated by a link-time pass; which will
1944 // also decide whether checking code needs to be injected into this particular
1945 // prologue.
1946 StackSize = MFI->getStackSize();
1947
1948 // Do not generate a prologue for functions with a stack of size zero
1949 if (StackSize == 0)
1950 return;
1951
1952 MachineBasicBlock *allocMBB = MF.CreateMachineBasicBlock();
1953 MachineBasicBlock *checkMBB = MF.CreateMachineBasicBlock();
1954 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1955 bool IsNested = false;
1956
1957 // We need to know if the function has a nest argument only in 64 bit mode.
1958 if (Is64Bit)
1959 IsNested = HasNestArgument(&MF);
1960
1961 // The MOV R10, RAX needs to be in a different block, since the RET we emit in
1962 // allocMBB needs to be last (terminating) instruction.
1963
Matthias Braund9da1622015-09-09 18:08:03 +00001964 for (const auto &LI : PrologueMBB.liveins()) {
Matthias Braunb2b7ef12015-08-24 22:59:52 +00001965 allocMBB->addLiveIn(LI);
1966 checkMBB->addLiveIn(LI);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00001967 }
1968
1969 if (IsNested)
1970 allocMBB->addLiveIn(IsLP64 ? X86::R10 : X86::R10D);
1971
1972 MF.push_front(allocMBB);
1973 MF.push_front(checkMBB);
1974
1975 // When the frame size is less than 256 we just compare the stack
1976 // boundary directly to the value of the stack pointer, per gcc.
1977 bool CompareStackPointer = StackSize < kSplitStackAvailable;
1978
1979 // Read the limit off the current stacklet off the stack_guard location.
1980 if (Is64Bit) {
1981 if (STI.isTargetLinux()) {
1982 TlsReg = X86::FS;
1983 TlsOffset = IsLP64 ? 0x70 : 0x40;
1984 } else if (STI.isTargetDarwin()) {
1985 TlsReg = X86::GS;
1986 TlsOffset = 0x60 + 90*8; // See pthread_machdep.h. Steal TLS slot 90.
1987 } else if (STI.isTargetWin64()) {
1988 TlsReg = X86::GS;
1989 TlsOffset = 0x28; // pvArbitrary, reserved for application use
1990 } else if (STI.isTargetFreeBSD()) {
1991 TlsReg = X86::FS;
1992 TlsOffset = 0x18;
1993 } else if (STI.isTargetDragonFly()) {
1994 TlsReg = X86::FS;
1995 TlsOffset = 0x20; // use tls_tcb.tcb_segstack
1996 } else {
1997 report_fatal_error("Segmented stacks not supported on this platform.");
1998 }
1999
2000 if (CompareStackPointer)
2001 ScratchReg = IsLP64 ? X86::RSP : X86::ESP;
2002 else
2003 BuildMI(checkMBB, DL, TII.get(IsLP64 ? X86::LEA64r : X86::LEA64_32r), ScratchReg).addReg(X86::RSP)
2004 .addImm(1).addReg(0).addImm(-StackSize).addReg(0);
2005
2006 BuildMI(checkMBB, DL, TII.get(IsLP64 ? X86::CMP64rm : X86::CMP32rm)).addReg(ScratchReg)
2007 .addReg(0).addImm(1).addReg(0).addImm(TlsOffset).addReg(TlsReg);
2008 } else {
2009 if (STI.isTargetLinux()) {
2010 TlsReg = X86::GS;
2011 TlsOffset = 0x30;
2012 } else if (STI.isTargetDarwin()) {
2013 TlsReg = X86::GS;
2014 TlsOffset = 0x48 + 90*4;
2015 } else if (STI.isTargetWin32()) {
2016 TlsReg = X86::FS;
2017 TlsOffset = 0x14; // pvArbitrary, reserved for application use
2018 } else if (STI.isTargetDragonFly()) {
2019 TlsReg = X86::FS;
2020 TlsOffset = 0x10; // use tls_tcb.tcb_segstack
2021 } else if (STI.isTargetFreeBSD()) {
2022 report_fatal_error("Segmented stacks not supported on FreeBSD i386.");
2023 } else {
2024 report_fatal_error("Segmented stacks not supported on this platform.");
2025 }
2026
2027 if (CompareStackPointer)
2028 ScratchReg = X86::ESP;
2029 else
2030 BuildMI(checkMBB, DL, TII.get(X86::LEA32r), ScratchReg).addReg(X86::ESP)
2031 .addImm(1).addReg(0).addImm(-StackSize).addReg(0);
2032
2033 if (STI.isTargetLinux() || STI.isTargetWin32() || STI.isTargetWin64() ||
2034 STI.isTargetDragonFly()) {
2035 BuildMI(checkMBB, DL, TII.get(X86::CMP32rm)).addReg(ScratchReg)
2036 .addReg(0).addImm(0).addReg(0).addImm(TlsOffset).addReg(TlsReg);
2037 } else if (STI.isTargetDarwin()) {
2038
2039 // TlsOffset doesn't fit into a mod r/m byte so we need an extra register.
2040 unsigned ScratchReg2;
2041 bool SaveScratch2;
2042 if (CompareStackPointer) {
2043 // The primary scratch register is available for holding the TLS offset.
2044 ScratchReg2 = GetScratchRegister(Is64Bit, IsLP64, MF, true);
2045 SaveScratch2 = false;
2046 } else {
2047 // Need to use a second register to hold the TLS offset
2048 ScratchReg2 = GetScratchRegister(Is64Bit, IsLP64, MF, false);
2049
2050 // Unfortunately, with fastcc the second scratch register may hold an
2051 // argument.
2052 SaveScratch2 = MF.getRegInfo().isLiveIn(ScratchReg2);
2053 }
2054
2055 // If Scratch2 is live-in then it needs to be saved.
2056 assert((!MF.getRegInfo().isLiveIn(ScratchReg2) || SaveScratch2) &&
2057 "Scratch register is live-in and not saved");
2058
2059 if (SaveScratch2)
2060 BuildMI(checkMBB, DL, TII.get(X86::PUSH32r))
2061 .addReg(ScratchReg2, RegState::Kill);
2062
2063 BuildMI(checkMBB, DL, TII.get(X86::MOV32ri), ScratchReg2)
2064 .addImm(TlsOffset);
2065 BuildMI(checkMBB, DL, TII.get(X86::CMP32rm))
2066 .addReg(ScratchReg)
2067 .addReg(ScratchReg2).addImm(1).addReg(0)
2068 .addImm(0)
2069 .addReg(TlsReg);
2070
2071 if (SaveScratch2)
2072 BuildMI(checkMBB, DL, TII.get(X86::POP32r), ScratchReg2);
2073 }
2074 }
2075
2076 // This jump is taken if SP >= (Stacklet Limit + Stack Space required).
2077 // It jumps to normal execution of the function body.
Quentin Colombet61b305e2015-05-05 17:38:16 +00002078 BuildMI(checkMBB, DL, TII.get(X86::JA_1)).addMBB(&PrologueMBB);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002079
2080 // On 32 bit we first push the arguments size and then the frame size. On 64
2081 // bit, we pass the stack frame size in r10 and the argument size in r11.
2082 if (Is64Bit) {
2083 // Functions with nested arguments use R10, so it needs to be saved across
2084 // the call to _morestack
2085
2086 const unsigned RegAX = IsLP64 ? X86::RAX : X86::EAX;
2087 const unsigned Reg10 = IsLP64 ? X86::R10 : X86::R10D;
2088 const unsigned Reg11 = IsLP64 ? X86::R11 : X86::R11D;
2089 const unsigned MOVrr = IsLP64 ? X86::MOV64rr : X86::MOV32rr;
2090 const unsigned MOVri = IsLP64 ? X86::MOV64ri : X86::MOV32ri;
2091
2092 if (IsNested)
2093 BuildMI(allocMBB, DL, TII.get(MOVrr), RegAX).addReg(Reg10);
2094
2095 BuildMI(allocMBB, DL, TII.get(MOVri), Reg10)
2096 .addImm(StackSize);
2097 BuildMI(allocMBB, DL, TII.get(MOVri), Reg11)
2098 .addImm(X86FI->getArgumentStackSize());
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002099 } else {
2100 BuildMI(allocMBB, DL, TII.get(X86::PUSHi32))
2101 .addImm(X86FI->getArgumentStackSize());
2102 BuildMI(allocMBB, DL, TII.get(X86::PUSHi32))
2103 .addImm(StackSize);
2104 }
2105
2106 // __morestack is in libgcc
2107 if (Is64Bit && MF.getTarget().getCodeModel() == CodeModel::Large) {
2108 // Under the large code model, we cannot assume that __morestack lives
2109 // within 2^31 bytes of the call site, so we cannot use pc-relative
2110 // addressing. We cannot perform the call via a temporary register,
2111 // as the rax register may be used to store the static chain, and all
2112 // other suitable registers may be either callee-save or used for
2113 // parameter passing. We cannot use the stack at this point either
2114 // because __morestack manipulates the stack directly.
2115 //
2116 // To avoid these issues, perform an indirect call via a read-only memory
2117 // location containing the address.
2118 //
2119 // This solution is not perfect, as it assumes that the .rodata section
2120 // is laid out within 2^31 bytes of each function body, but this seems
2121 // to be sufficient for JIT.
2122 BuildMI(allocMBB, DL, TII.get(X86::CALL64m))
2123 .addReg(X86::RIP)
2124 .addImm(0)
2125 .addReg(0)
2126 .addExternalSymbol("__morestack_addr")
2127 .addReg(0);
2128 MF.getMMI().setUsesMorestackAddr(true);
2129 } else {
2130 if (Is64Bit)
2131 BuildMI(allocMBB, DL, TII.get(X86::CALL64pcrel32))
2132 .addExternalSymbol("__morestack");
2133 else
2134 BuildMI(allocMBB, DL, TII.get(X86::CALLpcrel32))
2135 .addExternalSymbol("__morestack");
2136 }
2137
2138 if (IsNested)
2139 BuildMI(allocMBB, DL, TII.get(X86::MORESTACK_RET_RESTORE_R10));
2140 else
2141 BuildMI(allocMBB, DL, TII.get(X86::MORESTACK_RET));
2142
Quentin Colombet61b305e2015-05-05 17:38:16 +00002143 allocMBB->addSuccessor(&PrologueMBB);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002144
2145 checkMBB->addSuccessor(allocMBB);
Quentin Colombet61b305e2015-05-05 17:38:16 +00002146 checkMBB->addSuccessor(&PrologueMBB);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002147
2148#ifdef XDEBUG
2149 MF.verify();
2150#endif
2151}
2152
2153/// Erlang programs may need a special prologue to handle the stack size they
2154/// might need at runtime. That is because Erlang/OTP does not implement a C
2155/// stack but uses a custom implementation of hybrid stack/heap architecture.
2156/// (for more information see Eric Stenman's Ph.D. thesis:
2157/// http://publications.uu.se/uu/fulltext/nbn_se_uu_diva-2688.pdf)
2158///
2159/// CheckStack:
2160/// temp0 = sp - MaxStack
2161/// if( temp0 < SP_LIMIT(P) ) goto IncStack else goto OldStart
2162/// OldStart:
2163/// ...
2164/// IncStack:
2165/// call inc_stack # doubles the stack space
2166/// temp0 = sp - MaxStack
2167/// if( temp0 < SP_LIMIT(P) ) goto IncStack else goto OldStart
Quentin Colombet61b305e2015-05-05 17:38:16 +00002168void X86FrameLowering::adjustForHiPEPrologue(
2169 MachineFunction &MF, MachineBasicBlock &PrologueMBB) const {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002170 MachineFrameInfo *MFI = MF.getFrameInfo();
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002171 DebugLoc DL;
2172 // HiPE-specific values
2173 const unsigned HipeLeafWords = 24;
2174 const unsigned CCRegisteredArgs = Is64Bit ? 6 : 5;
2175 const unsigned Guaranteed = HipeLeafWords * SlotSize;
2176 unsigned CallerStkArity = MF.getFunction()->arg_size() > CCRegisteredArgs ?
2177 MF.getFunction()->arg_size() - CCRegisteredArgs : 0;
2178 unsigned MaxStack = MFI->getStackSize() + CallerStkArity*SlotSize + SlotSize;
2179
2180 assert(STI.isTargetLinux() &&
2181 "HiPE prologue is only supported on Linux operating systems.");
2182
2183 // Compute the largest caller's frame that is needed to fit the callees'
2184 // frames. This 'MaxStack' is computed from:
2185 //
2186 // a) the fixed frame size, which is the space needed for all spilled temps,
2187 // b) outgoing on-stack parameter areas, and
2188 // c) the minimum stack space this function needs to make available for the
2189 // functions it calls (a tunable ABI property).
2190 if (MFI->hasCalls()) {
2191 unsigned MoreStackForCalls = 0;
2192
2193 for (MachineFunction::iterator MBBI = MF.begin(), MBBE = MF.end();
2194 MBBI != MBBE; ++MBBI)
2195 for (MachineBasicBlock::iterator MI = MBBI->begin(), ME = MBBI->end();
2196 MI != ME; ++MI) {
2197 if (!MI->isCall())
2198 continue;
2199
2200 // Get callee operand.
2201 const MachineOperand &MO = MI->getOperand(0);
2202
2203 // Only take account of global function calls (no closures etc.).
2204 if (!MO.isGlobal())
2205 continue;
2206
2207 const Function *F = dyn_cast<Function>(MO.getGlobal());
2208 if (!F)
2209 continue;
2210
2211 // Do not update 'MaxStack' for primitive and built-in functions
2212 // (encoded with names either starting with "erlang."/"bif_" or not
2213 // having a ".", such as a simple <Module>.<Function>.<Arity>, or an
2214 // "_", such as the BIF "suspend_0") as they are executed on another
2215 // stack.
2216 if (F->getName().find("erlang.") != StringRef::npos ||
2217 F->getName().find("bif_") != StringRef::npos ||
2218 F->getName().find_first_of("._") == StringRef::npos)
2219 continue;
2220
2221 unsigned CalleeStkArity =
2222 F->arg_size() > CCRegisteredArgs ? F->arg_size()-CCRegisteredArgs : 0;
2223 if (HipeLeafWords - 1 > CalleeStkArity)
2224 MoreStackForCalls = std::max(MoreStackForCalls,
2225 (HipeLeafWords - 1 - CalleeStkArity) * SlotSize);
2226 }
2227 MaxStack += MoreStackForCalls;
2228 }
2229
2230 // If the stack frame needed is larger than the guaranteed then runtime checks
2231 // and calls to "inc_stack_0" BIF should be inserted in the assembly prologue.
2232 if (MaxStack > Guaranteed) {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002233 MachineBasicBlock *stackCheckMBB = MF.CreateMachineBasicBlock();
2234 MachineBasicBlock *incStackMBB = MF.CreateMachineBasicBlock();
2235
Matthias Braund9da1622015-09-09 18:08:03 +00002236 for (const auto &LI : PrologueMBB.liveins()) {
Matthias Braunb2b7ef12015-08-24 22:59:52 +00002237 stackCheckMBB->addLiveIn(LI);
2238 incStackMBB->addLiveIn(LI);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002239 }
2240
2241 MF.push_front(incStackMBB);
2242 MF.push_front(stackCheckMBB);
2243
2244 unsigned ScratchReg, SPReg, PReg, SPLimitOffset;
2245 unsigned LEAop, CMPop, CALLop;
2246 if (Is64Bit) {
2247 SPReg = X86::RSP;
2248 PReg = X86::RBP;
2249 LEAop = X86::LEA64r;
2250 CMPop = X86::CMP64rm;
2251 CALLop = X86::CALL64pcrel32;
2252 SPLimitOffset = 0x90;
2253 } else {
2254 SPReg = X86::ESP;
2255 PReg = X86::EBP;
2256 LEAop = X86::LEA32r;
2257 CMPop = X86::CMP32rm;
2258 CALLop = X86::CALLpcrel32;
2259 SPLimitOffset = 0x4c;
2260 }
2261
2262 ScratchReg = GetScratchRegister(Is64Bit, IsLP64, MF, true);
2263 assert(!MF.getRegInfo().isLiveIn(ScratchReg) &&
2264 "HiPE prologue scratch register is live-in");
2265
2266 // Create new MBB for StackCheck:
2267 addRegOffset(BuildMI(stackCheckMBB, DL, TII.get(LEAop), ScratchReg),
2268 SPReg, false, -MaxStack);
2269 // SPLimitOffset is in a fixed heap location (pointed by BP).
2270 addRegOffset(BuildMI(stackCheckMBB, DL, TII.get(CMPop))
2271 .addReg(ScratchReg), PReg, false, SPLimitOffset);
Quentin Colombet61b305e2015-05-05 17:38:16 +00002272 BuildMI(stackCheckMBB, DL, TII.get(X86::JAE_1)).addMBB(&PrologueMBB);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002273
2274 // Create new MBB for IncStack:
2275 BuildMI(incStackMBB, DL, TII.get(CALLop)).
2276 addExternalSymbol("inc_stack_0");
2277 addRegOffset(BuildMI(incStackMBB, DL, TII.get(LEAop), ScratchReg),
2278 SPReg, false, -MaxStack);
2279 addRegOffset(BuildMI(incStackMBB, DL, TII.get(CMPop))
2280 .addReg(ScratchReg), PReg, false, SPLimitOffset);
2281 BuildMI(incStackMBB, DL, TII.get(X86::JLE_1)).addMBB(incStackMBB);
2282
Quentin Colombet61b305e2015-05-05 17:38:16 +00002283 stackCheckMBB->addSuccessor(&PrologueMBB, 99);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002284 stackCheckMBB->addSuccessor(incStackMBB, 1);
Quentin Colombet61b305e2015-05-05 17:38:16 +00002285 incStackMBB->addSuccessor(&PrologueMBB, 99);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002286 incStackMBB->addSuccessor(incStackMBB, 1);
2287 }
2288#ifdef XDEBUG
2289 MF.verify();
2290#endif
2291}
2292
Michael Kuperstein7337ee22015-08-11 08:48:48 +00002293bool X86FrameLowering::adjustStackWithPops(MachineBasicBlock &MBB,
2294 MachineBasicBlock::iterator MBBI, DebugLoc DL, int Offset) const {
2295
Michael Kupersteind9264652015-09-16 11:27:20 +00002296 if (Offset <= 0)
2297 return false;
2298
Michael Kuperstein7337ee22015-08-11 08:48:48 +00002299 if (Offset % SlotSize)
2300 return false;
2301
2302 int NumPops = Offset / SlotSize;
2303 // This is only worth it if we have at most 2 pops.
2304 if (NumPops != 1 && NumPops != 2)
2305 return false;
2306
2307 // Handle only the trivial case where the adjustment directly follows
2308 // a call. This is the most common one, anyway.
2309 if (MBBI == MBB.begin())
2310 return false;
2311 MachineBasicBlock::iterator Prev = std::prev(MBBI);
2312 if (!Prev->isCall() || !Prev->getOperand(1).isRegMask())
2313 return false;
2314
2315 unsigned Regs[2];
2316 unsigned FoundRegs = 0;
2317
2318 auto RegMask = Prev->getOperand(1);
Michael Kupersteind9264652015-09-16 11:27:20 +00002319
2320 auto &RegClass =
2321 Is64Bit ? X86::GR64_NOREX_NOSPRegClass : X86::GR32_NOREX_NOSPRegClass;
2322 // Try to find up to NumPops free registers.
2323 for (auto Candidate : RegClass) {
Michael Kuperstein7337ee22015-08-11 08:48:48 +00002324
2325 // Poor man's liveness:
2326 // Since we're immediately after a call, any register that is clobbered
2327 // by the call and not defined by it can be considered dead.
2328 if (!RegMask.clobbersPhysReg(Candidate))
2329 continue;
2330
2331 bool IsDef = false;
2332 for (const MachineOperand &MO : Prev->implicit_operands()) {
2333 if (MO.isReg() && MO.isDef() && MO.getReg() == Candidate) {
2334 IsDef = true;
2335 break;
2336 }
2337 }
2338
2339 if (IsDef)
2340 continue;
2341
2342 Regs[FoundRegs++] = Candidate;
2343 if (FoundRegs == (unsigned)NumPops)
2344 break;
2345 }
2346
2347 if (FoundRegs == 0)
2348 return false;
2349
2350 // If we found only one free register, but need two, reuse the same one twice.
2351 while (FoundRegs < (unsigned)NumPops)
2352 Regs[FoundRegs++] = Regs[0];
2353
2354 for (int i = 0; i < NumPops; ++i)
2355 BuildMI(MBB, MBBI, DL,
2356 TII.get(STI.is64Bit() ? X86::POP64r : X86::POP32r), Regs[i]);
2357
2358 return true;
2359}
2360
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002361void X86FrameLowering::
2362eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
2363 MachineBasicBlock::iterator I) const {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002364 bool reserveCallFrame = hasReservedCallFrame(MF);
Matthias Braunfa3872e2015-05-18 20:27:55 +00002365 unsigned Opcode = I->getOpcode();
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002366 bool isDestroy = Opcode == TII.getCallFrameDestroyOpcode();
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002367 DebugLoc DL = I->getDebugLoc();
2368 uint64_t Amount = !reserveCallFrame ? I->getOperand(0).getImm() : 0;
Michael Kuperstein13fbd452015-02-01 16:56:04 +00002369 uint64_t InternalAmt = (isDestroy || Amount) ? I->getOperand(1).getImm() : 0;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002370 I = MBB.erase(I);
2371
2372 if (!reserveCallFrame) {
2373 // If the stack pointer can be changed after prologue, turn the
2374 // adjcallstackup instruction into a 'sub ESP, <amt>' and the
2375 // adjcallstackdown instruction into 'add ESP, <amt>'
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002376
2377 // We need to keep the stack aligned properly. To do this, we round the
2378 // amount of space needed for the outgoing arguments up to the next
2379 // alignment boundary.
David Majnemer93c22a42015-02-10 00:57:42 +00002380 unsigned StackAlign = getStackAlignment();
2381 Amount = RoundUpToAlignment(Amount, StackAlign);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002382
Michael Kuperstein73dc8522015-11-03 08:17:25 +00002383 MachineModuleInfo &MMI = MF.getMMI();
2384 const Function *Fn = MF.getFunction();
2385 bool WindowsCFI = MF.getTarget().getMCAsmInfo()->usesWindowsCFI();
2386 bool DwarfCFI = !WindowsCFI &&
2387 (MMI.hasDebugInfo() || Fn->needsUnwindTableEntry());
2388
Michael Kuperstein259f1502015-10-07 07:01:31 +00002389 // If we have any exception handlers in this function, and we adjust
Michael Kuperstein73dc8522015-11-03 08:17:25 +00002390 // the SP before calls, we may need to indicate this to the unwinder
2391 // using GNU_ARGS_SIZE. Note that this may be necessary even when
2392 // Amount == 0, because the preceding function may have set a non-0
2393 // GNU_ARGS_SIZE.
Michael Kuperstein259f1502015-10-07 07:01:31 +00002394 // TODO: We don't need to reset this between subsequent functions,
2395 // if it didn't change.
Michael Kuperstein73dc8522015-11-03 08:17:25 +00002396 bool HasDwarfEHHandlers = !WindowsCFI &&
2397 !MF.getMMI().getLandingPads().empty();
Michael Kuperstein259f1502015-10-07 07:01:31 +00002398
Michael Kuperstein73dc8522015-11-03 08:17:25 +00002399 if (HasDwarfEHHandlers && !isDestroy &&
Michael Kuperstein259f1502015-10-07 07:01:31 +00002400 MF.getInfo<X86MachineFunctionInfo>()->getHasPushSequences())
Michael Kupersteinaf22daf2015-10-13 06:22:30 +00002401 BuildCFI(MBB, I, DL,
2402 MCCFIInstruction::createGnuArgsSize(nullptr, Amount));
Michael Kuperstein259f1502015-10-07 07:01:31 +00002403
2404 if (Amount == 0)
2405 return;
2406
Michael Kuperstein13fbd452015-02-01 16:56:04 +00002407 // Factor out the amount that gets handled inside the sequence
2408 // (Pushes of argument for frame setup, callee pops for frame destroy)
2409 Amount -= InternalAmt;
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002410
Michael Kuperstein73dc8522015-11-03 08:17:25 +00002411 // If this is a callee-pop calling convention, and we're emitting precise
2412 // SP-based CFI, emit a CFA adjust for the amount the callee popped.
2413 if (isDestroy && InternalAmt && DwarfCFI && !hasFP(MF) &&
2414 MMI.usePreciseUnwindInfo())
2415 BuildCFI(MBB, I, DL,
2416 MCCFIInstruction::createAdjustCfaOffset(nullptr, -InternalAmt));
2417
Michael Kuperstein13fbd452015-02-01 16:56:04 +00002418 if (Amount) {
Reid Kleckner98d78032015-06-18 20:22:12 +00002419 // Add Amount to SP to destroy a frame, and subtract to setup.
2420 int Offset = isDestroy ? Amount : -Amount;
Michael Kuperstein7337ee22015-08-11 08:48:48 +00002421
Michael Kuperstein73dc8522015-11-03 08:17:25 +00002422 if (!(Fn->optForMinSize() &&
Michael Kuperstein7337ee22015-08-11 08:48:48 +00002423 adjustStackWithPops(MBB, I, DL, Offset)))
2424 BuildStackAdjustment(MBB, I, DL, Offset, /*InEpilogue=*/false);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002425 }
Michael Kuperstein7337ee22015-08-11 08:48:48 +00002426
Michael Kuperstein73dc8522015-11-03 08:17:25 +00002427 if (DwarfCFI && !hasFP(MF)) {
2428 // If we don't have FP, but need to generate unwind information,
2429 // we need to set the correct CFA offset after the stack adjustment.
2430 // How much we adjust the CFA offset depends on whether we're emitting
2431 // CFI only for EH purposes or for debugging. EH only requires the CFA
2432 // offset to be correct at each call site, while for debugging we want
2433 // it to be more precise.
2434 int CFAOffset = Amount;
2435 if (!MMI.usePreciseUnwindInfo())
2436 CFAOffset += InternalAmt;
2437 CFAOffset = isDestroy ? -CFAOffset : CFAOffset;
2438 BuildCFI(MBB, I, DL,
2439 MCCFIInstruction::createAdjustCfaOffset(nullptr, CFAOffset));
2440 }
2441
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002442 return;
2443 }
2444
Reid Kleckner98d78032015-06-18 20:22:12 +00002445 if (isDestroy && InternalAmt) {
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002446 // If we are performing frame pointer elimination and if the callee pops
2447 // something off the stack pointer, add it back. We do this until we have
2448 // more advanced stack pointer tracking ability.
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002449 // We are not tracking the stack pointer adjustment by the callee, so make
2450 // sure we restore the stack pointer immediately after the call, there may
2451 // be spill code inserted between the CALL and ADJCALLSTACKUP instructions.
2452 MachineBasicBlock::iterator B = MBB.begin();
2453 while (I != B && !std::prev(I)->isCall())
2454 --I;
Reid Kleckner98d78032015-06-18 20:22:12 +00002455 BuildStackAdjustment(MBB, I, DL, -InternalAmt, /*InEpilogue=*/false);
Michael Kupersteine86aa9a2015-02-01 16:15:07 +00002456 }
2457}
2458
Quentin Colombetaa8020752015-05-27 06:28:41 +00002459bool X86FrameLowering::canUseAsEpilogue(const MachineBasicBlock &MBB) const {
2460 assert(MBB.getParent() && "Block is not attached to a function!");
2461
Quentin Colombet421723c2015-11-04 22:37:28 +00002462 // Win64 has strict requirements in terms of epilogue and we are
2463 // not taking a chance at messing with them.
2464 // I.e., unless this block is already an exit block, we can't use
2465 // it as an epilogue.
2466 if (MBB.getParent()->getSubtarget<X86Subtarget>().isTargetWin64() &&
2467 !MBB.succ_empty() && !MBB.isReturnBlock())
2468 return false;
2469
Quentin Colombetaa8020752015-05-27 06:28:41 +00002470 if (canUseLEAForSPInEpilogue(*MBB.getParent()))
2471 return true;
2472
2473 // If we cannot use LEA to adjust SP, we may need to use ADD, which
2474 // clobbers the EFLAGS. Check that none of the terminators reads the
2475 // EFLAGS, and if one uses it, conservatively assume this is not
2476 // safe to insert the epilogue here.
2477 return !terminatorsNeedFlagsAsInput(MBB);
2478}
Reid Klecknerdf129512015-09-08 22:44:41 +00002479
Reid Kleckner5b8a46e2015-09-17 20:43:47 +00002480MachineBasicBlock::iterator X86FrameLowering::restoreWin32EHStackPointers(
Reid Klecknerdf129512015-09-08 22:44:41 +00002481 MachineBasicBlock &MBB, MachineBasicBlock::iterator MBBI,
Reid Kleckner5b8a46e2015-09-17 20:43:47 +00002482 DebugLoc DL, bool RestoreSP) const {
Reid Klecknerdf129512015-09-08 22:44:41 +00002483 assert(STI.isTargetWindowsMSVC() && "funclets only supported in MSVC env");
2484 assert(STI.isTargetWin32() && "EBP/ESI restoration only required on win32");
2485 assert(STI.is32Bit() && !Uses64BitFramePtr &&
2486 "restoring EBP/ESI on non-32-bit target");
2487
2488 MachineFunction &MF = *MBB.getParent();
2489 unsigned FramePtr = TRI->getFrameRegister(MF);
2490 unsigned BasePtr = TRI->getBaseRegister();
2491 MachineModuleInfo &MMI = MF.getMMI();
2492 const Function *Fn = MF.getFunction();
2493 WinEHFuncInfo &FuncInfo = MMI.getWinEHFuncInfo(Fn);
2494 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
2495 MachineFrameInfo *MFI = MF.getFrameInfo();
2496
2497 // FIXME: Don't set FrameSetup flag in catchret case.
2498
2499 int FI = FuncInfo.EHRegNodeFrameIndex;
Reid Kleckner5b8a46e2015-09-17 20:43:47 +00002500 int EHRegSize = MFI->getObjectSize(FI);
2501
2502 if (RestoreSP) {
2503 // MOV32rm -EHRegSize(%ebp), %esp
2504 addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32rm), X86::ESP),
2505 X86::EBP, true, -EHRegSize)
2506 .setMIFlag(MachineInstr::FrameSetup);
2507 }
2508
Reid Klecknerdf129512015-09-08 22:44:41 +00002509 unsigned UsedReg;
2510 int EHRegOffset = getFrameIndexReference(MF, FI, UsedReg);
Reid Klecknerdf129512015-09-08 22:44:41 +00002511 int EndOffset = -EHRegOffset - EHRegSize;
Reid Klecknerb005d282015-09-16 20:16:27 +00002512 FuncInfo.EHRegNodeEndOffset = EndOffset;
Reid Kleckner5b8a46e2015-09-17 20:43:47 +00002513
Reid Klecknerdf129512015-09-08 22:44:41 +00002514 if (UsedReg == FramePtr) {
2515 // ADD $offset, %ebp
Reid Klecknerdf129512015-09-08 22:44:41 +00002516 unsigned ADDri = getADDriOpcode(false, EndOffset);
2517 BuildMI(MBB, MBBI, DL, TII.get(ADDri), FramePtr)
2518 .addReg(FramePtr)
2519 .addImm(EndOffset)
2520 .setMIFlag(MachineInstr::FrameSetup)
2521 ->getOperand(3)
2522 .setIsDead();
Reid Klecknerb2244cb2015-10-08 18:41:52 +00002523 assert(EndOffset >= 0 &&
2524 "end of registration object above normal EBP position!");
2525 } else if (UsedReg == BasePtr) {
Reid Klecknerdf129512015-09-08 22:44:41 +00002526 // LEA offset(%ebp), %esi
2527 addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(X86::LEA32r), BasePtr),
2528 FramePtr, false, EndOffset)
2529 .setMIFlag(MachineInstr::FrameSetup);
Reid Kleckner5b8a46e2015-09-17 20:43:47 +00002530 // MOV32rm SavedEBPOffset(%esi), %ebp
Reid Klecknerdf129512015-09-08 22:44:41 +00002531 assert(X86FI->getHasSEHFramePtrSave());
2532 int Offset =
2533 getFrameIndexReference(MF, X86FI->getSEHFramePtrSaveIndex(), UsedReg);
2534 assert(UsedReg == BasePtr);
Reid Kleckner5b8a46e2015-09-17 20:43:47 +00002535 addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32rm), FramePtr),
2536 UsedReg, true, Offset)
Reid Klecknerdf129512015-09-08 22:44:41 +00002537 .setMIFlag(MachineInstr::FrameSetup);
Reid Klecknerb2244cb2015-10-08 18:41:52 +00002538 } else {
2539 llvm_unreachable("32-bit frames with WinEH must use FramePtr or BasePtr");
Reid Klecknerdf129512015-09-08 22:44:41 +00002540 }
2541 return MBBI;
2542}
Reid Kleckner28e49032015-10-16 23:43:27 +00002543
2544unsigned X86FrameLowering::getWinEHParentFrameOffset(const MachineFunction &MF) const {
2545 // RDX, the parent frame pointer, is homed into 16(%rsp) in the prologue.
2546 unsigned Offset = 16;
2547 // RBP is immediately pushed.
2548 Offset += SlotSize;
2549 // All callee-saved registers are then pushed.
2550 Offset += MF.getInfo<X86MachineFunctionInfo>()->getCalleeSavedFrameSize();
2551 // Every funclet allocates enough stack space for the largest outgoing call.
2552 Offset += getWinEHFuncletFrameSize(MF);
2553 return Offset;
2554}