blob: d9d23f83042e0668986692400e9f8d5778135fc8 [file] [log] [blame]
Jia Liub22310f2012-02-18 12:03:15 +00001//===-- X86FrameLowering.cpp - X86 Frame Information ----------------------===//
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
Anton Korobeynikov2f931282011-01-10 12:39:04 +000010// This file contains the X86 implementation of TargetFrameLowering class.
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +000011//
12//===----------------------------------------------------------------------===//
13
Anton Korobeynikov2f931282011-01-10 12:39:04 +000014#include "X86FrameLowering.h"
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +000015#include "X86InstrBuilder.h"
16#include "X86InstrInfo.h"
17#include "X86MachineFunctionInfo.h"
Rafael Espindolac2174212011-08-30 19:39:58 +000018#include "X86Subtarget.h"
Anton Korobeynikov14ee3442010-11-18 23:25:52 +000019#include "X86TargetMachine.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000020#include "llvm/ADT/SmallSet.h"
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +000021#include "llvm/CodeGen/MachineFrameInfo.h"
22#include "llvm/CodeGen/MachineFunction.h"
23#include "llvm/CodeGen/MachineInstrBuilder.h"
24#include "llvm/CodeGen/MachineModuleInfo.h"
25#include "llvm/CodeGen/MachineRegisterInfo.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000026#include "llvm/IR/DataLayout.h"
27#include "llvm/IR/Function.h"
Rafael Espindolaa01cdb02011-04-15 15:11:06 +000028#include "llvm/MC/MCAsmInfo.h"
Bill Wendlingb6adf462011-07-07 00:54:13 +000029#include "llvm/MC/MCSymbol.h"
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +000030#include "llvm/Support/CommandLine.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000031#include "llvm/Target/TargetOptions.h"
NAKAMURA Takumi1db59952014-06-25 12:41:52 +000032#include "llvm/Support/Debug.h"
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +000033
34using namespace llvm;
35
36// FIXME: completely move here.
37extern cl::opt<bool> ForceStackAlign;
38
Anton Korobeynikov2f931282011-01-10 12:39:04 +000039bool X86FrameLowering::hasReservedCallFrame(const MachineFunction &MF) const {
Anton Korobeynikov0eecf5d2010-11-18 21:19:35 +000040 return !MF.getFrameInfo()->hasVarSizedObjects();
41}
42
43/// hasFP - Return true if the specified function should have a dedicated frame
44/// pointer register. This is true if the function has variable sized allocas
45/// or if frame pointer elimination is disabled.
Anton Korobeynikov2f931282011-01-10 12:39:04 +000046bool X86FrameLowering::hasFP(const MachineFunction &MF) const {
Anton Korobeynikov0eecf5d2010-11-18 21:19:35 +000047 const MachineFrameInfo *MFI = MF.getFrameInfo();
48 const MachineModuleInfo &MMI = MF.getMMI();
Eric Christopherfc6de422014-08-05 02:39:49 +000049 const TargetRegisterInfo *RegInfo = MF.getSubtarget().getRegisterInfo();
Anton Korobeynikov0eecf5d2010-11-18 21:19:35 +000050
Nick Lewycky50f02cb2011-12-02 22:16:29 +000051 return (MF.getTarget().Options.DisableFramePointerElim(MF) ||
Chad Rosier20b79dc2012-05-23 23:45:10 +000052 RegInfo->needsStackRealignment(MF) ||
Anton Korobeynikov0eecf5d2010-11-18 21:19:35 +000053 MFI->hasVarSizedObjects() ||
Reid Kleckneree088972013-12-10 18:27:32 +000054 MFI->isFrameAddressTaken() || MFI->hasInlineAsmWithSPAdjust() ||
Anton Korobeynikov0eecf5d2010-11-18 21:19:35 +000055 MF.getInfo<X86MachineFunctionInfo>()->getForceFramePointer() ||
Jakob Stoklund Olesen321d41a2012-06-22 03:04:27 +000056 MMI.callsUnwindInit() || MMI.callsEHReturn());
Anton Korobeynikov0eecf5d2010-11-18 21:19:35 +000057}
58
Eli Bendersky8da87162013-02-21 20:05:00 +000059static unsigned getSUBriOpcode(unsigned IsLP64, int64_t Imm) {
60 if (IsLP64) {
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +000061 if (isInt<8>(Imm))
62 return X86::SUB64ri8;
63 return X86::SUB64ri32;
64 } else {
65 if (isInt<8>(Imm))
66 return X86::SUB32ri8;
67 return X86::SUB32ri;
68 }
69}
70
Eli Benderskyef4558a2013-02-06 20:43:57 +000071static unsigned getADDriOpcode(unsigned IsLP64, int64_t Imm) {
72 if (IsLP64) {
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +000073 if (isInt<8>(Imm))
74 return X86::ADD64ri8;
75 return X86::ADD64ri32;
76 } else {
77 if (isInt<8>(Imm))
78 return X86::ADD32ri8;
79 return X86::ADD32ri;
80 }
81}
82
Eli Benderskyef4558a2013-02-06 20:43:57 +000083static unsigned getLEArOpcode(unsigned IsLP64) {
84 return IsLP64 ? X86::LEA64r : X86::LEA32r;
Evan Cheng1b81fdd2012-02-07 22:50:41 +000085}
86
Evan Cheng65089fc2011-01-03 22:53:22 +000087/// findDeadCallerSavedReg - Return a caller-saved register that isn't live
88/// when it reaches the "return" instruction. We can then pop a stack object
89/// to this register without worry about clobbering it.
90static unsigned findDeadCallerSavedReg(MachineBasicBlock &MBB,
91 MachineBasicBlock::iterator &MBBI,
92 const TargetRegisterInfo &TRI,
93 bool Is64Bit) {
94 const MachineFunction *MF = MBB.getParent();
95 const Function *F = MF->getFunction();
96 if (!F || MF->getMMI().callsEHReturn())
97 return 0;
98
Craig Topper1d326582012-03-04 10:43:23 +000099 static const uint16_t CallerSavedRegs32Bit[] = {
Andrew Trick210bf832011-08-12 00:49:19 +0000100 X86::EAX, X86::EDX, X86::ECX, 0
Evan Cheng65089fc2011-01-03 22:53:22 +0000101 };
102
Craig Topper1d326582012-03-04 10:43:23 +0000103 static const uint16_t CallerSavedRegs64Bit[] = {
Evan Cheng65089fc2011-01-03 22:53:22 +0000104 X86::RAX, X86::RDX, X86::RCX, X86::RSI, X86::RDI,
Andrew Trick210bf832011-08-12 00:49:19 +0000105 X86::R8, X86::R9, X86::R10, X86::R11, 0
Evan Cheng65089fc2011-01-03 22:53:22 +0000106 };
107
108 unsigned Opc = MBBI->getOpcode();
109 switch (Opc) {
110 default: return 0;
David Woodhouse79dd5052014-01-08 12:58:07 +0000111 case X86::RETL:
112 case X86::RETQ:
David Woodhouse4e033b02014-01-13 14:05:59 +0000113 case X86::RETIL:
114 case X86::RETIQ:
Evan Cheng65089fc2011-01-03 22:53:22 +0000115 case X86::TCRETURNdi:
116 case X86::TCRETURNri:
117 case X86::TCRETURNmi:
118 case X86::TCRETURNdi64:
119 case X86::TCRETURNri64:
120 case X86::TCRETURNmi64:
121 case X86::EH_RETURN:
122 case X86::EH_RETURN64: {
Craig Topper1d326582012-03-04 10:43:23 +0000123 SmallSet<uint16_t, 8> Uses;
Evan Cheng65089fc2011-01-03 22:53:22 +0000124 for (unsigned i = 0, e = MBBI->getNumOperands(); i != e; ++i) {
125 MachineOperand &MO = MBBI->getOperand(i);
126 if (!MO.isReg() || MO.isDef())
127 continue;
128 unsigned Reg = MO.getReg();
129 if (!Reg)
130 continue;
Jakob Stoklund Olesen54038d72012-06-01 23:28:30 +0000131 for (MCRegAliasIterator AI(Reg, &TRI, true); AI.isValid(); ++AI)
132 Uses.insert(*AI);
Evan Cheng65089fc2011-01-03 22:53:22 +0000133 }
134
Craig Topper1d326582012-03-04 10:43:23 +0000135 const uint16_t *CS = Is64Bit ? CallerSavedRegs64Bit : CallerSavedRegs32Bit;
Evan Cheng65089fc2011-01-03 22:53:22 +0000136 for (; *CS; ++CS)
137 if (!Uses.count(*CS))
138 return *CS;
139 }
140 }
141
142 return 0;
143}
144
145
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000146/// emitSPUpdate - Emit a series of instructions to increment / decrement the
147/// stack pointer by a constant value.
148static
149void emitSPUpdate(MachineBasicBlock &MBB, MachineBasicBlock::iterator &MBBI,
Evan Cheng65089fc2011-01-03 22:53:22 +0000150 unsigned StackPtr, int64_t NumBytes,
Pavel Chupinf55eb452014-08-07 09:41:19 +0000151 bool Is64BitTarget, bool Is64BitStackPtr, bool UseLEA,
Eric Christopherf4fba5c2012-10-03 08:10:01 +0000152 const TargetInstrInfo &TII, const TargetRegisterInfo &TRI) {
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000153 bool isSub = NumBytes < 0;
154 uint64_t Offset = isSub ? -NumBytes : NumBytes;
Evan Cheng1b81fdd2012-02-07 22:50:41 +0000155 unsigned Opc;
156 if (UseLEA)
Pavel Chupinf55eb452014-08-07 09:41:19 +0000157 Opc = getLEArOpcode(Is64BitStackPtr);
Evan Cheng1b81fdd2012-02-07 22:50:41 +0000158 else
159 Opc = isSub
Pavel Chupinf55eb452014-08-07 09:41:19 +0000160 ? getSUBriOpcode(Is64BitStackPtr, Offset)
161 : getADDriOpcode(Is64BitStackPtr, Offset);
Evan Cheng1b81fdd2012-02-07 22:50:41 +0000162
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000163 uint64_t Chunk = (1LL << 31) - 1;
Eric Christopherf4fba5c2012-10-03 08:10:01 +0000164 DebugLoc DL = MBB.findDebugLoc(MBBI);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000165
166 while (Offset) {
167 uint64_t ThisVal = (Offset > Chunk) ? Chunk : Offset;
Pavel Chupinf55eb452014-08-07 09:41:19 +0000168 if (ThisVal == (Is64BitTarget ? 8 : 4)) {
Evan Cheng65089fc2011-01-03 22:53:22 +0000169 // Use push / pop instead.
170 unsigned Reg = isSub
Pavel Chupinf55eb452014-08-07 09:41:19 +0000171 ? (unsigned)(Is64BitTarget ? X86::RAX : X86::EAX)
172 : findDeadCallerSavedReg(MBB, MBBI, TRI, Is64BitTarget);
Evan Cheng65089fc2011-01-03 22:53:22 +0000173 if (Reg) {
174 Opc = isSub
Pavel Chupinf55eb452014-08-07 09:41:19 +0000175 ? (Is64BitTarget ? X86::PUSH64r : X86::PUSH32r)
176 : (Is64BitTarget ? X86::POP64r : X86::POP32r);
Charles Davis7ed40cb2011-06-12 01:45:54 +0000177 MachineInstr *MI = BuildMI(MBB, MBBI, DL, TII.get(Opc))
Evan Cheng65089fc2011-01-03 22:53:22 +0000178 .addReg(Reg, getDefRegState(!isSub) | getUndefRegState(isSub));
Charles Davis7ed40cb2011-06-12 01:45:54 +0000179 if (isSub)
180 MI->setFlag(MachineInstr::FrameSetup);
Evan Cheng65089fc2011-01-03 22:53:22 +0000181 Offset -= ThisVal;
182 continue;
183 }
184 }
185
Craig Topper062a2ba2014-04-25 05:30:21 +0000186 MachineInstr *MI = nullptr;
Evan Cheng1b81fdd2012-02-07 22:50:41 +0000187
188 if (UseLEA) {
189 MI = addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr),
190 StackPtr, false, isSub ? -ThisVal : ThisVal);
191 } else {
192 MI = BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr)
193 .addReg(StackPtr)
194 .addImm(ThisVal);
195 MI->getOperand(3).setIsDead(); // The EFLAGS implicit def is dead.
196 }
197
Charles Davis7ed40cb2011-06-12 01:45:54 +0000198 if (isSub)
199 MI->setFlag(MachineInstr::FrameSetup);
Evan Cheng1b81fdd2012-02-07 22:50:41 +0000200
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000201 Offset -= ThisVal;
202 }
203}
204
205/// mergeSPUpdatesUp - Merge two stack-manipulating instructions upper iterator.
206static
207void mergeSPUpdatesUp(MachineBasicBlock &MBB, MachineBasicBlock::iterator &MBBI,
Craig Topper062a2ba2014-04-25 05:30:21 +0000208 unsigned StackPtr, uint64_t *NumBytes = nullptr) {
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000209 if (MBBI == MBB.begin()) return;
210
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +0000211 MachineBasicBlock::iterator PI = std::prev(MBBI);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000212 unsigned Opc = PI->getOpcode();
213 if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
Evan Cheng1b81fdd2012-02-07 22:50:41 +0000214 Opc == X86::ADD32ri || Opc == X86::ADD32ri8 ||
215 Opc == X86::LEA32r || Opc == X86::LEA64_32r) &&
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000216 PI->getOperand(0).getReg() == StackPtr) {
217 if (NumBytes)
218 *NumBytes += PI->getOperand(2).getImm();
219 MBB.erase(PI);
220 } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
221 Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
222 PI->getOperand(0).getReg() == StackPtr) {
223 if (NumBytes)
224 *NumBytes -= PI->getOperand(2).getImm();
225 MBB.erase(PI);
226 }
227}
228
Eric Christopher4237bf12014-04-29 00:16:33 +0000229/// mergeSPUpdatesDown - Merge two stack-manipulating instructions lower
230/// iterator.
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000231static
232void mergeSPUpdatesDown(MachineBasicBlock &MBB,
233 MachineBasicBlock::iterator &MBBI,
Craig Topper062a2ba2014-04-25 05:30:21 +0000234 unsigned StackPtr, uint64_t *NumBytes = nullptr) {
Sanjoy Dasf60485c2011-12-01 19:15:08 +0000235 // FIXME: THIS ISN'T RUN!!!
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000236 return;
237
238 if (MBBI == MBB.end()) return;
239
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +0000240 MachineBasicBlock::iterator NI = std::next(MBBI);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000241 if (NI == MBB.end()) return;
242
243 unsigned Opc = NI->getOpcode();
244 if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
245 Opc == X86::ADD32ri || Opc == X86::ADD32ri8) &&
246 NI->getOperand(0).getReg() == StackPtr) {
247 if (NumBytes)
248 *NumBytes -= NI->getOperand(2).getImm();
249 MBB.erase(NI);
250 MBBI = NI;
251 } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
252 Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
253 NI->getOperand(0).getReg() == StackPtr) {
254 if (NumBytes)
255 *NumBytes += NI->getOperand(2).getImm();
256 MBB.erase(NI);
257 MBBI = NI;
258 }
259}
260
261/// mergeSPUpdates - Checks the instruction before/after the passed
Eric Christopher4237bf12014-04-29 00:16:33 +0000262/// instruction. If it is an ADD/SUB/LEA instruction it is deleted argument and
263/// the stack adjustment is returned as a positive value for ADD/LEA and a
264/// negative for SUB.
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000265static int mergeSPUpdates(MachineBasicBlock &MBB,
Eric Christopher4237bf12014-04-29 00:16:33 +0000266 MachineBasicBlock::iterator &MBBI, unsigned StackPtr,
267 bool doMergeWithPrevious) {
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000268 if ((doMergeWithPrevious && MBBI == MBB.begin()) ||
269 (!doMergeWithPrevious && MBBI == MBB.end()))
270 return 0;
271
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +0000272 MachineBasicBlock::iterator PI = doMergeWithPrevious ? std::prev(MBBI) : MBBI;
Craig Topper062a2ba2014-04-25 05:30:21 +0000273 MachineBasicBlock::iterator NI = doMergeWithPrevious ? nullptr
274 : std::next(MBBI);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000275 unsigned Opc = PI->getOpcode();
276 int Offset = 0;
277
278 if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
Evan Cheng1b81fdd2012-02-07 22:50:41 +0000279 Opc == X86::ADD32ri || Opc == X86::ADD32ri8 ||
280 Opc == X86::LEA32r || Opc == X86::LEA64_32r) &&
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000281 PI->getOperand(0).getReg() == StackPtr){
282 Offset += PI->getOperand(2).getImm();
283 MBB.erase(PI);
284 if (!doMergeWithPrevious) MBBI = NI;
285 } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
286 Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
287 PI->getOperand(0).getReg() == StackPtr) {
288 Offset -= PI->getOperand(2).getImm();
289 MBB.erase(PI);
290 if (!doMergeWithPrevious) MBBI = NI;
291 }
292
293 return Offset;
294}
295
296static bool isEAXLiveIn(MachineFunction &MF) {
297 for (MachineRegisterInfo::livein_iterator II = MF.getRegInfo().livein_begin(),
298 EE = MF.getRegInfo().livein_end(); II != EE; ++II) {
299 unsigned Reg = II->first;
300
301 if (Reg == X86::EAX || Reg == X86::AX ||
302 Reg == X86::AH || Reg == X86::AL)
303 return true;
304 }
305
306 return false;
307}
308
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000309void
310X86FrameLowering::emitCalleeSavedFrameMoves(MachineBasicBlock &MBB,
311 MachineBasicBlock::iterator MBBI,
312 DebugLoc DL) const {
Rafael Espindolab1f25f12014-03-07 06:08:31 +0000313 MachineFunction &MF = *MBB.getParent();
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000314 MachineFrameInfo *MFI = MF.getFrameInfo();
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000315 MachineModuleInfo &MMI = MF.getMMI();
Bill Wendlingbc07a892013-06-18 07:20:20 +0000316 const MCRegisterInfo *MRI = MMI.getContext().getRegisterInfo();
Eric Christopherfc6de422014-08-05 02:39:49 +0000317 const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000318
319 // Add callee saved registers to move list.
320 const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
321 if (CSI.empty()) return;
322
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000323 // Calculate offsets.
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000324 for (std::vector<CalleeSavedInfo>::const_iterator
325 I = CSI.begin(), E = CSI.end(); I != E; ++I) {
326 int64_t Offset = MFI->getObjectOffset(I->getFrameIdx());
327 unsigned Reg = I->getReg();
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000328
Bill Wendlingbc07a892013-06-18 07:20:20 +0000329 unsigned DwarfReg = MRI->getDwarfRegNum(Reg, true);
Rafael Espindolab1f25f12014-03-07 06:08:31 +0000330 unsigned CFIIndex =
Craig Topper062a2ba2014-04-25 05:30:21 +0000331 MMI.addFrameInst(MCCFIInstruction::createOffset(nullptr, DwarfReg,
332 Offset));
Eric Christopher612bb692014-04-29 00:16:46 +0000333 BuildMI(MBB, MBBI, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
334 .addCFIIndex(CFIIndex);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000335 }
336}
337
Nadav Rotem1bef5a02012-12-23 07:30:09 +0000338/// usesTheStack - This function checks if any of the users of EFLAGS
Nadav Rotemd5aae982012-12-21 23:48:49 +0000339/// copies the EFLAGS. We know that the code that lowers COPY of EFLAGS has
340/// to use the stack, and if we don't adjust the stack we clobber the first
341/// frame index.
Nadav Rotem1bef5a02012-12-23 07:30:09 +0000342/// See X86InstrInfo::copyPhysReg.
Bill Wendling28519072013-08-15 18:46:14 +0000343static bool usesTheStack(const MachineFunction &MF) {
344 const MachineRegisterInfo &MRI = MF.getRegInfo();
Nadav Rotemd5aae982012-12-21 23:48:49 +0000345
Owen Anderson16c6bf42014-03-13 23:12:04 +0000346 for (MachineRegisterInfo::reg_instr_iterator
347 ri = MRI.reg_instr_begin(X86::EFLAGS), re = MRI.reg_instr_end();
348 ri != re; ++ri)
Nadav Rotemd5aae982012-12-21 23:48:49 +0000349 if (ri->isCopy())
350 return true;
351
352 return false;
353}
354
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000355/// emitPrologue - Push callee-saved registers onto the stack, which
356/// automatically adjust the stack pointer. Adjust the stack pointer to allocate
357/// space for local variables. Also emit labels used by the exception handler to
358/// generate the exception handling frames.
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000359
360/*
361 Here's a gist of what gets emitted:
362
363 ; Establish frame pointer, if needed
364 [if needs FP]
365 push %rbp
366 .cfi_def_cfa_offset 16
367 .cfi_offset %rbp, -16
368 .seh_pushreg %rpb
369 mov %rsp, %rbp
370 .cfi_def_cfa_register %rbp
371
372 ; Spill general-purpose registers
373 [for all callee-saved GPRs]
374 pushq %<reg>
375 [if not needs FP]
376 .cfi_def_cfa_offset (offset from RETADDR)
377 .seh_pushreg %<reg>
378
379 ; If the required stack alignment > default stack alignment
380 ; rsp needs to be re-aligned. This creates a "re-alignment gap"
381 ; of unknown size in the stack frame.
382 [if stack needs re-alignment]
383 and $MASK, %rsp
384
385 ; Allocate space for locals
386 [if target is Windows and allocated space > 4096 bytes]
387 ; Windows needs special care for allocations larger
388 ; than one page.
389 mov $NNN, %rax
390 call ___chkstk_ms/___chkstk
391 sub %rax, %rsp
392 [else]
393 sub $NNN, %rsp
394
395 [if needs FP]
396 .seh_stackalloc (size of XMM spill slots)
397 .seh_setframe %rbp, SEHFrameOffset ; = size of all spill slots
398 [else]
399 .seh_stackalloc NNN
400
401 ; Spill XMMs
402 ; Note, that while only Windows 64 ABI specifies XMMs as callee-preserved,
403 ; they may get spilled on any platform, if the current function
404 ; calls @llvm.eh.unwind.init
405 [if needs FP]
406 [for all callee-saved XMM registers]
407 movaps %<xmm reg>, -MMM(%rbp)
408 [for all callee-saved XMM registers]
409 .seh_savexmm %<xmm reg>, (-MMM + SEHFrameOffset)
410 ; i.e. the offset relative to (%rbp - SEHFrameOffset)
411 [else]
412 [for all callee-saved XMM registers]
413 movaps %<xmm reg>, KKK(%rsp)
414 [for all callee-saved XMM registers]
415 .seh_savexmm %<xmm reg>, KKK
416
417 .seh_endprologue
418
419 [if needs base pointer]
420 mov %rsp, %rbx
421
422 ; Emit CFI info
423 [if needs FP]
424 [for all callee-saved registers]
425 .cfi_offset %<reg>, (offset from %rbp)
426 [else]
427 .cfi_def_cfa_offset (offset from RETADDR)
428 [for all callee-saved registers]
429 .cfi_offset %<reg>, (offset from %rsp)
430
431 Notes:
432 - .seh directives are emitted only for Windows 64 ABI
433 - .cfi directives are emitted for all other ABIs
434 - for 32-bit code, substitute %e?? registers for %r??
435*/
436
Anton Korobeynikov2f931282011-01-10 12:39:04 +0000437void X86FrameLowering::emitPrologue(MachineFunction &MF) const {
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000438 MachineBasicBlock &MBB = MF.front(); // Prologue goes in entry BB.
439 MachineBasicBlock::iterator MBBI = MBB.begin();
440 MachineFrameInfo *MFI = MF.getFrameInfo();
441 const Function *Fn = MF.getFunction();
Eric Christopherfc6de422014-08-05 02:39:49 +0000442 const X86RegisterInfo *RegInfo =
443 static_cast<const X86RegisterInfo *>(MF.getSubtarget().getRegisterInfo());
444 const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000445 MachineModuleInfo &MMI = MF.getMMI();
446 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000447 uint64_t MaxAlign = MFI->getMaxAlignment(); // Desired stack alignment.
448 uint64_t StackSize = MFI->getStackSize(); // Number of bytes to allocate.
Anton Korobeynikov0eecf5d2010-11-18 21:19:35 +0000449 bool HasFP = hasFP(MF);
Eric Christopherf4381642014-06-05 22:00:31 +0000450 const X86Subtarget &STI = MF.getTarget().getSubtarget<X86Subtarget>();
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000451 bool Is64Bit = STI.is64Bit();
Pavel Chupinf55eb452014-08-07 09:41:19 +0000452 // standard x86_64 and NaCl use 64-bit frame/stack pointers, x32 - 32-bit.
453 const bool Uses64BitFramePtr = STI.isTarget64BitLP64() || STI.isTargetNaCl64();
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000454 bool IsWin64 = STI.isTargetWin64();
Saleem Abdulrasool67b54812014-06-29 21:43:47 +0000455 bool IsWinEH =
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000456 MF.getTarget().getMCAsmInfo()->getExceptionHandlingType() ==
Saleem Abdulrasool67b54812014-06-29 21:43:47 +0000457 ExceptionHandling::WinEH; // Not necessarily synonymous with IsWin64.
458 bool NeedsWinEH = IsWinEH && Fn->needsUnwindTableEntry();
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000459 bool NeedsDwarfCFI =
Saleem Abdulrasool67b54812014-06-29 21:43:47 +0000460 !IsWinEH && (MMI.hasDebugInfo() || Fn->needsUnwindTableEntry());
Evan Cheng1b81fdd2012-02-07 22:50:41 +0000461 bool UseLEA = STI.useLeaForSP();
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000462 unsigned StackAlign = getStackAlignment();
463 unsigned SlotSize = RegInfo->getSlotSize();
464 unsigned FramePtr = RegInfo->getFrameRegister(MF);
Pavel Chupinf55eb452014-08-07 09:41:19 +0000465 const unsigned MachineFramePtr = STI.isTarget64BitILP32() ?
466 getX86SubSuperRegister(FramePtr, MVT::i64, false) : FramePtr;
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000467 unsigned StackPtr = RegInfo->getStackRegister();
Chad Rosierbdb08ac2012-07-10 17:45:53 +0000468 unsigned BasePtr = RegInfo->getBaseRegister();
Bill Wendlingf27e3312013-09-10 00:20:27 +0000469 DebugLoc DL;
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000470
471 // If we're forcing a stack realignment we can't rely on just the frame
472 // info, we need to know the ABI stack alignment as well in case we
473 // have a call out. Otherwise just make sure we have some alignment - we'll
474 // go with the minimum SlotSize.
475 if (ForceStackAlign) {
476 if (MFI->hasCalls())
477 MaxAlign = (StackAlign > MaxAlign) ? StackAlign : MaxAlign;
478 else if (MaxAlign < SlotSize)
479 MaxAlign = SlotSize;
480 }
481
482 // Add RETADDR move area to callee saved frame size.
483 int TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
484 if (TailCallReturnAddrDelta < 0)
485 X86FI->setCalleeSavedFrameSize(
486 X86FI->getCalleeSavedFrameSize() - TailCallReturnAddrDelta);
487
488 // If this is x86-64 and the Red Zone is not disabled, if we are a leaf
489 // function, and use up to 128 bytes of stack space, don't have a frame
490 // pointer, calls, or dynamic alloca then we do not need to adjust the
Nadav Rotemd5aae982012-12-21 23:48:49 +0000491 // stack pointer (we fit in the Red Zone). We also check that we don't
492 // push and pop from the stack.
Bill Wendling698e84f2012-12-30 10:32:01 +0000493 if (Is64Bit && !Fn->getAttributes().hasAttribute(AttributeSet::FunctionIndex,
494 Attribute::NoRedZone) &&
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000495 !RegInfo->needsStackRealignment(MF) &&
Nick Lewycky50f02cb2011-12-02 22:16:29 +0000496 !MFI->hasVarSizedObjects() && // No dynamic alloca.
497 !MFI->adjustsStack() && // No calls.
498 !IsWin64 && // Win64 has no Red Zone
Nadav Rotem1bef5a02012-12-23 07:30:09 +0000499 !usesTheStack(MF) && // Don't push and pop.
Reid Kleckner9c658212014-04-10 22:58:43 +0000500 !MF.shouldSplitStack()) { // Regular stack
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000501 uint64_t MinSize = X86FI->getCalleeSavedFrameSize();
502 if (HasFP) MinSize += SlotSize;
503 StackSize = std::max(MinSize, StackSize > 128 ? StackSize - 128 : 0);
504 MFI->setStackSize(StackSize);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000505 }
506
507 // Insert stack pointer adjustment for later moving of return addr. Only
508 // applies to tail call optimized functions where the callee argument stack
509 // size is bigger than the callers.
510 if (TailCallReturnAddrDelta < 0) {
511 MachineInstr *MI =
512 BuildMI(MBB, MBBI, DL,
Pavel Chupinf55eb452014-08-07 09:41:19 +0000513 TII.get(getSUBriOpcode(Uses64BitFramePtr, -TailCallReturnAddrDelta)),
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000514 StackPtr)
515 .addReg(StackPtr)
Charles Davis7ed40cb2011-06-12 01:45:54 +0000516 .addImm(-TailCallReturnAddrDelta)
517 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000518 MI->getOperand(3).setIsDead(); // The EFLAGS implicit def is dead.
519 }
520
521 // Mapping for machine moves:
522 //
523 // DST: VirtualFP AND
524 // SRC: VirtualFP => DW_CFA_def_cfa_offset
525 // ELSE => DW_CFA_def_cfa
526 //
527 // SRC: VirtualFP AND
528 // DST: Register => DW_CFA_def_cfa_register
529 //
530 // ELSE
531 // OFFSET < 0 => DW_CFA_offset_extended_sf
532 // REG < 64 => DW_CFA_offset + Reg
533 // ELSE => DW_CFA_offset_extended
534
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000535 uint64_t NumBytes = 0;
Michael Liao6d810bd2012-10-25 06:29:14 +0000536 int stackGrowth = -SlotSize;
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000537
538 if (HasFP) {
539 // Calculate required stack adjustment.
540 uint64_t FrameSize = StackSize - SlotSize;
Alexey Samsonovdcc12912012-07-16 06:54:09 +0000541 if (RegInfo->needsStackRealignment(MF)) {
542 // Callee-saved registers are pushed on stack before the stack
543 // is realigned.
544 FrameSize -= X86FI->getCalleeSavedFrameSize();
545 NumBytes = (FrameSize + MaxAlign - 1) / MaxAlign * MaxAlign;
546 } else {
547 NumBytes = FrameSize - X86FI->getCalleeSavedFrameSize();
548 }
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000549
550 // Get the offset of the stack slot for the EBP register, which is
551 // guaranteed to be the last slot by processFunctionBeforeFrameFinalized.
552 // Update the frame offset adjustment.
553 MFI->setOffsetAdjustment(-NumBytes);
554
555 // Save EBP/RBP into the appropriate stack slot.
556 BuildMI(MBB, MBBI, DL, TII.get(Is64Bit ? X86::PUSH64r : X86::PUSH32r))
Pavel Chupinf55eb452014-08-07 09:41:19 +0000557 .addReg(MachineFramePtr, RegState::Kill)
Charles Davis7ed40cb2011-06-12 01:45:54 +0000558 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000559
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000560 if (NeedsDwarfCFI) {
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000561 // Mark the place where EBP/RBP was saved.
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000562 // Define the current CFA rule to use the provided offset.
Rafael Espindola84ee6c42013-05-15 22:27:35 +0000563 assert(StackSize);
Rafael Espindolab1f25f12014-03-07 06:08:31 +0000564 unsigned CFIIndex = MMI.addFrameInst(
Craig Topper062a2ba2014-04-25 05:30:21 +0000565 MCCFIInstruction::createDefCfaOffset(nullptr, 2 * stackGrowth));
Eric Christopher612bb692014-04-29 00:16:46 +0000566 BuildMI(MBB, MBBI, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
Rafael Espindolab1f25f12014-03-07 06:08:31 +0000567 .addCFIIndex(CFIIndex);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000568
569 // Change the rule for the FramePtr to be an "offset" rule.
Pavel Chupinf55eb452014-08-07 09:41:19 +0000570 unsigned DwarfFramePtr = RegInfo->getDwarfRegNum(MachineFramePtr, true);
Rafael Espindolab1f25f12014-03-07 06:08:31 +0000571 CFIIndex = MMI.addFrameInst(
Craig Topper062a2ba2014-04-25 05:30:21 +0000572 MCCFIInstruction::createOffset(nullptr,
573 DwarfFramePtr, 2 * stackGrowth));
Eric Christopher612bb692014-04-29 00:16:46 +0000574 BuildMI(MBB, MBBI, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
Rafael Espindolab1f25f12014-03-07 06:08:31 +0000575 .addCFIIndex(CFIIndex);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000576 }
577
Saleem Abdulrasool67b54812014-06-29 21:43:47 +0000578 if (NeedsWinEH) {
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000579 BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_PushReg))
580 .addImm(FramePtr)
581 .setMIFlag(MachineInstr::FrameSetup);
582 }
583
Bill Wendlingb97270d2011-07-25 18:00:28 +0000584 // Update EBP with the new base value.
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000585 BuildMI(MBB, MBBI, DL,
Pavel Chupinf55eb452014-08-07 09:41:19 +0000586 TII.get(Uses64BitFramePtr ? X86::MOV64rr : X86::MOV32rr), FramePtr)
Charles Davis7ed40cb2011-06-12 01:45:54 +0000587 .addReg(StackPtr)
588 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000589
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000590 if (NeedsDwarfCFI) {
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000591 // Mark effective beginning of when frame pointer becomes valid.
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000592 // Define the current CFA to use the EBP/RBP register.
Pavel Chupinf55eb452014-08-07 09:41:19 +0000593 unsigned DwarfFramePtr = RegInfo->getDwarfRegNum(MachineFramePtr, true);
Rafael Espindolab1f25f12014-03-07 06:08:31 +0000594 unsigned CFIIndex = MMI.addFrameInst(
Craig Topper062a2ba2014-04-25 05:30:21 +0000595 MCCFIInstruction::createDefCfaRegister(nullptr, DwarfFramePtr));
Eric Christopher612bb692014-04-29 00:16:46 +0000596 BuildMI(MBB, MBBI, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
Rafael Espindolab1f25f12014-03-07 06:08:31 +0000597 .addCFIIndex(CFIIndex);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000598 }
599
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000600 // Mark the FramePtr as live-in in every block.
601 for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I)
Pavel Chupinf55eb452014-08-07 09:41:19 +0000602 I->addLiveIn(MachineFramePtr);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000603 } else {
604 NumBytes = StackSize - X86FI->getCalleeSavedFrameSize();
605 }
606
607 // Skip the callee-saved push instructions.
608 bool PushedRegs = false;
609 int StackOffset = 2 * stackGrowth;
610
611 while (MBBI != MBB.end() &&
612 (MBBI->getOpcode() == X86::PUSH32r ||
613 MBBI->getOpcode() == X86::PUSH64r)) {
614 PushedRegs = true;
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000615 unsigned Reg = MBBI->getOperand(0).getReg();
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000616 ++MBBI;
617
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000618 if (!HasFP && NeedsDwarfCFI) {
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000619 // Mark callee-saved push instruction.
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000620 // Define the current CFA rule to use the provided offset.
Rafael Espindola72421862013-05-16 04:59:17 +0000621 assert(StackSize);
Rafael Espindolab1f25f12014-03-07 06:08:31 +0000622 unsigned CFIIndex = MMI.addFrameInst(
623 MCCFIInstruction::createDefCfaOffset(nullptr, StackOffset));
Eric Christopher612bb692014-04-29 00:16:46 +0000624 BuildMI(MBB, MBBI, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
Rafael Espindolab1f25f12014-03-07 06:08:31 +0000625 .addCFIIndex(CFIIndex);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000626 StackOffset += stackGrowth;
627 }
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000628
Saleem Abdulrasool67b54812014-06-29 21:43:47 +0000629 if (NeedsWinEH) {
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000630 BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_PushReg)).addImm(Reg).setMIFlag(
631 MachineInstr::FrameSetup);
632 }
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000633 }
634
Alexey Samsonovdcc12912012-07-16 06:54:09 +0000635 // Realign stack after we pushed callee-saved registers (so that we'll be
636 // able to calculate their offsets from the frame pointer).
Alexey Samsonovdcc12912012-07-16 06:54:09 +0000637 if (RegInfo->needsStackRealignment(MF)) {
638 assert(HasFP && "There should be a frame pointer if stack is realigned.");
639 MachineInstr *MI =
640 BuildMI(MBB, MBBI, DL,
Pavel Chupinf55eb452014-08-07 09:41:19 +0000641 TII.get(Uses64BitFramePtr ? X86::AND64ri32 : X86::AND32ri), StackPtr)
Alexey Samsonovdcc12912012-07-16 06:54:09 +0000642 .addReg(StackPtr)
643 .addImm(-MaxAlign)
644 .setMIFlag(MachineInstr::FrameSetup);
645
646 // The EFLAGS implicit def is dead.
647 MI->getOperand(3).setIsDead();
648 }
649
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000650 // If there is an SUB32ri of ESP immediately before this instruction, merge
651 // the two. This can be the case when tail call elimination is enabled and
652 // the callee has more arguments then the caller.
653 NumBytes -= mergeSPUpdates(MBB, MBBI, StackPtr, true);
654
655 // If there is an ADD32ri or SUB32ri of ESP immediately after this
656 // instruction, merge the two instructions.
657 mergeSPUpdatesDown(MBB, MBBI, StackPtr, &NumBytes);
658
659 // Adjust stack pointer: ESP -= numbytes.
660
661 // Windows and cygwin/mingw require a prologue helper routine when allocating
662 // more than 4K bytes on the stack. Windows uses __chkstk and cygwin/mingw
663 // uses __alloca. __alloca and the 32-bit version of __chkstk will probe the
664 // stack and adjust the stack pointer in one go. The 64-bit version of
665 // __chkstk is only responsible for probing the stack. The 64-bit prologue is
666 // responsible for adjusting the stack pointer. Touching the stack at 4K
667 // increments is necessary to ensure that the guard pages used by the OS
668 // virtual memory manager are allocated in correct sequence.
Tim Northover9653eb52013-12-10 16:57:43 +0000669 if (NumBytes >= 4096 && STI.isOSWindows() && !STI.isTargetMacho()) {
NAKAMURA Takumi521eb7c2011-03-24 07:07:00 +0000670 const char *StackProbeSymbol;
NAKAMURA Takumi521eb7c2011-03-24 07:07:00 +0000671
672 if (Is64Bit) {
Kai Nacke87b23ae2013-12-13 05:37:05 +0000673 if (STI.isTargetCygMing()) {
674 StackProbeSymbol = "___chkstk_ms";
675 } else {
NAKAMURA Takumi521eb7c2011-03-24 07:07:00 +0000676 StackProbeSymbol = "__chkstk";
NAKAMURA Takumi521eb7c2011-03-24 07:07:00 +0000677 }
678 } else if (STI.isTargetCygMing())
679 StackProbeSymbol = "_alloca";
680 else
681 StackProbeSymbol = "_chkstk";
682
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000683 // Check whether EAX is livein for this function.
684 bool isEAXAlive = isEAXLiveIn(MF);
685
NAKAMURA Takumi521eb7c2011-03-24 07:07:00 +0000686 if (isEAXAlive) {
687 // Sanity check that EAX is not livein for this function.
688 // It should not be, so throw an assert.
689 assert(!Is64Bit && "EAX is livein in x64 case!");
690
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000691 // Save EAX
692 BuildMI(MBB, MBBI, DL, TII.get(X86::PUSH32r))
Bill Wendling28b6e122011-07-21 00:44:56 +0000693 .addReg(X86::EAX, RegState::Kill)
694 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000695 }
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000696
NAKAMURA Takumi521eb7c2011-03-24 07:07:00 +0000697 if (Is64Bit) {
698 // Handle the 64-bit Windows ABI case where we need to call __chkstk.
699 // Function prologue is responsible for adjusting the stack pointer.
700 BuildMI(MBB, MBBI, DL, TII.get(X86::MOV64ri), X86::RAX)
Bill Wendling28b6e122011-07-21 00:44:56 +0000701 .addImm(NumBytes)
702 .setMIFlag(MachineInstr::FrameSetup);
NAKAMURA Takumi521eb7c2011-03-24 07:07:00 +0000703 } else {
704 // Allocate NumBytes-4 bytes on stack in case of isEAXAlive.
705 // We'll also use 4 already allocated bytes for EAX.
706 BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32ri), X86::EAX)
Bill Wendling28b6e122011-07-21 00:44:56 +0000707 .addImm(isEAXAlive ? NumBytes - 4 : NumBytes)
708 .setMIFlag(MachineInstr::FrameSetup);
NAKAMURA Takumi521eb7c2011-03-24 07:07:00 +0000709 }
710
711 BuildMI(MBB, MBBI, DL,
712 TII.get(Is64Bit ? X86::W64ALLOCA : X86::CALLpcrel32))
713 .addExternalSymbol(StackProbeSymbol)
714 .addReg(StackPtr, RegState::Define | RegState::Implicit)
Bill Wendling28b6e122011-07-21 00:44:56 +0000715 .addReg(X86::EFLAGS, RegState::Define | RegState::Implicit)
716 .setMIFlag(MachineInstr::FrameSetup);
NAKAMURA Takumi521eb7c2011-03-24 07:07:00 +0000717
Kai Nacke87b23ae2013-12-13 05:37:05 +0000718 if (Is64Bit) {
719 // MSVC x64's __chkstk and cygwin/mingw's ___chkstk_ms do not adjust %rsp
720 // themself. It also does not clobber %rax so we can reuse it when
721 // adjusting %rsp.
Nico Rieck51969be2013-07-08 11:20:11 +0000722 BuildMI(MBB, MBBI, DL, TII.get(X86::SUB64rr), StackPtr)
723 .addReg(StackPtr)
724 .addReg(X86::RAX)
725 .setMIFlag(MachineInstr::FrameSetup);
726 }
NAKAMURA Takumi521eb7c2011-03-24 07:07:00 +0000727 if (isEAXAlive) {
728 // Restore EAX
729 MachineInstr *MI = addRegOffset(BuildMI(MF, DL, TII.get(X86::MOV32rm),
730 X86::EAX),
731 StackPtr, false, NumBytes - 4);
Bill Wendling28b6e122011-07-21 00:44:56 +0000732 MI->setFlag(MachineInstr::FrameSetup);
NAKAMURA Takumi521eb7c2011-03-24 07:07:00 +0000733 MBB.insert(MBBI, MI);
734 }
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000735 } else if (NumBytes) {
Pavel Chupinf55eb452014-08-07 09:41:19 +0000736 emitSPUpdate(MBB, MBBI, StackPtr, -(int64_t)NumBytes, Is64Bit, Uses64BitFramePtr,
Eric Christopherf4fba5c2012-10-03 08:10:01 +0000737 UseLEA, TII, *RegInfo);
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000738 }
739
740 int SEHFrameOffset = 0;
Saleem Abdulrasool67b54812014-06-29 21:43:47 +0000741 if (NeedsWinEH) {
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000742 if (HasFP) {
743 // We need to set frame base offset low enough such that all saved
744 // register offsets would be positive relative to it, but we can't
745 // just use NumBytes, because .seh_setframe offset must be <=240.
746 // So we pretend to have only allocated enough space to spill the
747 // non-volatile registers.
748 // We don't care about the rest of stack allocation, because unwinder
749 // will restore SP to (BP - SEHFrameOffset)
750 for (const CalleeSavedInfo &Info : MFI->getCalleeSavedInfo()) {
751 int offset = MFI->getObjectOffset(Info.getFrameIdx());
752 SEHFrameOffset = std::max(SEHFrameOffset, abs(offset));
753 }
754 SEHFrameOffset += SEHFrameOffset % 16; // ensure alignmant
755
756 // This only needs to account for XMM spill slots, GPR slots
Reid Klecknerb5dd9452014-07-01 00:42:47 +0000757 // are covered by the .seh_pushreg's emitted above.
758 unsigned Size = SEHFrameOffset - X86FI->getCalleeSavedFrameSize();
759 if (Size) {
760 BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_StackAlloc))
761 .addImm(Size)
762 .setMIFlag(MachineInstr::FrameSetup);
763 }
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000764
765 BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_SetFrame))
766 .addImm(FramePtr)
767 .addImm(SEHFrameOffset)
768 .setMIFlag(MachineInstr::FrameSetup);
769 } else {
770 // SP will be the base register for restoring XMMs
771 if (NumBytes) {
772 BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_StackAlloc))
773 .addImm(NumBytes)
774 .setMIFlag(MachineInstr::FrameSetup);
775 }
776 }
777 }
778
779 // Skip the rest of register spilling code
780 while (MBBI != MBB.end() && MBBI->getFlag(MachineInstr::FrameSetup))
781 ++MBBI;
782
783 // Emit SEH info for non-GPRs
Saleem Abdulrasool67b54812014-06-29 21:43:47 +0000784 if (NeedsWinEH) {
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000785 for (const CalleeSavedInfo &Info : MFI->getCalleeSavedInfo()) {
786 unsigned Reg = Info.getReg();
787 if (X86::GR64RegClass.contains(Reg) || X86::GR32RegClass.contains(Reg))
788 continue;
789 assert(X86::FR64RegClass.contains(Reg) && "Unexpected register class");
790
791 int Offset = getFrameIndexOffset(MF, Info.getFrameIdx());
792 Offset += SEHFrameOffset;
793
794 BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_SaveXMM))
795 .addImm(Reg)
796 .addImm(Offset)
797 .setMIFlag(MachineInstr::FrameSetup);
798 }
799
800 BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_EndPrologue))
801 .setMIFlag(MachineInstr::FrameSetup);
802 }
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000803
Chad Rosierbdb08ac2012-07-10 17:45:53 +0000804 // If we need a base pointer, set it up here. It's whatever the value
805 // of the stack pointer is at this point. Any variable size objects
806 // will be allocated after this, so we can still use the base pointer
807 // to reference locals.
808 if (RegInfo->hasBasePointer(MF)) {
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000809 // Update the base pointer with the current stack pointer.
Pavel Chupinf55eb452014-08-07 09:41:19 +0000810 unsigned Opc = Uses64BitFramePtr ? X86::MOV64rr : X86::MOV32rr;
Chad Rosierbdb08ac2012-07-10 17:45:53 +0000811 BuildMI(MBB, MBBI, DL, TII.get(Opc), BasePtr)
812 .addReg(StackPtr)
813 .setMIFlag(MachineInstr::FrameSetup);
Chad Rosierbdb08ac2012-07-10 17:45:53 +0000814 }
815
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000816 if (((!HasFP && NumBytes) || PushedRegs) && NeedsDwarfCFI) {
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000817 // Mark end of stack pointer adjustment.
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000818 if (!HasFP && NumBytes) {
819 // Define the current CFA rule to use the provided offset.
Rafael Espindola84ee6c42013-05-15 22:27:35 +0000820 assert(StackSize);
Rafael Espindolab1f25f12014-03-07 06:08:31 +0000821 unsigned CFIIndex = MMI.addFrameInst(
Craig Topper062a2ba2014-04-25 05:30:21 +0000822 MCCFIInstruction::createDefCfaOffset(nullptr,
823 -StackSize + stackGrowth));
Rafael Espindolab1f25f12014-03-07 06:08:31 +0000824
Eric Christopher612bb692014-04-29 00:16:46 +0000825 BuildMI(MBB, MBBI, DL, TII.get(TargetOpcode::CFI_INSTRUCTION))
Rafael Espindolab1f25f12014-03-07 06:08:31 +0000826 .addCFIIndex(CFIIndex);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000827 }
828
829 // Emit DWARF info specifying the offsets of the callee-saved registers.
830 if (PushedRegs)
NAKAMURA Takumi1db59952014-06-25 12:41:52 +0000831 emitCalleeSavedFrameMoves(MBB, MBBI, DL);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000832 }
833}
834
Anton Korobeynikov2f931282011-01-10 12:39:04 +0000835void X86FrameLowering::emitEpilogue(MachineFunction &MF,
Nick Lewycky34a425b2011-06-14 03:23:52 +0000836 MachineBasicBlock &MBB) const {
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000837 const MachineFrameInfo *MFI = MF.getFrameInfo();
838 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
Eric Christopherfc6de422014-08-05 02:39:49 +0000839 const X86RegisterInfo *RegInfo =
840 static_cast<const X86RegisterInfo *>(MF.getSubtarget().getRegisterInfo());
841 const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
Jakob Stoklund Olesen4bc5e382011-01-13 21:28:52 +0000842 MachineBasicBlock::iterator MBBI = MBB.getLastNonDebugInstr();
843 assert(MBBI != MBB.end() && "Returning block has no instructions");
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000844 unsigned RetOpcode = MBBI->getOpcode();
845 DebugLoc DL = MBBI->getDebugLoc();
Eric Christopherf4381642014-06-05 22:00:31 +0000846 const X86Subtarget &STI = MF.getTarget().getSubtarget<X86Subtarget>();
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000847 bool Is64Bit = STI.is64Bit();
Pavel Chupinf55eb452014-08-07 09:41:19 +0000848 // standard x86_64 and NaCl use 64-bit frame/stack pointers, x32 - 32-bit.
849 const bool Uses64BitFramePtr = STI.isTarget64BitLP64() || STI.isTargetNaCl64();
850 const bool Is64BitILP32 = STI.isTarget64BitILP32();
Evan Cheng1b81fdd2012-02-07 22:50:41 +0000851 bool UseLEA = STI.useLeaForSP();
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000852 unsigned StackAlign = getStackAlignment();
853 unsigned SlotSize = RegInfo->getSlotSize();
854 unsigned FramePtr = RegInfo->getFrameRegister(MF);
Pavel Chupinf55eb452014-08-07 09:41:19 +0000855 unsigned MachineFramePtr {Is64BitILP32 ?
856 getX86SubSuperRegister(FramePtr, MVT::i64, false) : FramePtr};
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000857 unsigned StackPtr = RegInfo->getStackRegister();
858
Reid Klecknere7040102014-08-04 21:05:27 +0000859 bool IsWinEH =
860 MF.getTarget().getMCAsmInfo()->getExceptionHandlingType() ==
861 ExceptionHandling::WinEH;
862 bool NeedsWinEH = IsWinEH && MF.getFunction()->needsUnwindTableEntry();
863
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000864 switch (RetOpcode) {
865 default:
866 llvm_unreachable("Can only insert epilog into returning blocks");
David Woodhouse79dd5052014-01-08 12:58:07 +0000867 case X86::RETQ:
868 case X86::RETL:
David Woodhouse4e033b02014-01-13 14:05:59 +0000869 case X86::RETIL:
870 case X86::RETIQ:
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000871 case X86::TCRETURNdi:
872 case X86::TCRETURNri:
873 case X86::TCRETURNmi:
874 case X86::TCRETURNdi64:
875 case X86::TCRETURNri64:
876 case X86::TCRETURNmi64:
877 case X86::EH_RETURN:
878 case X86::EH_RETURN64:
879 break; // These are ok
880 }
881
882 // Get the number of bytes to allocate from the FrameInfo.
883 uint64_t StackSize = MFI->getStackSize();
884 uint64_t MaxAlign = MFI->getMaxAlignment();
885 unsigned CSSize = X86FI->getCalleeSavedFrameSize();
886 uint64_t NumBytes = 0;
887
888 // If we're forcing a stack realignment we can't rely on just the frame
889 // info, we need to know the ABI stack alignment as well in case we
890 // have a call out. Otherwise just make sure we have some alignment - we'll
891 // go with the minimum.
892 if (ForceStackAlign) {
893 if (MFI->hasCalls())
894 MaxAlign = (StackAlign > MaxAlign) ? StackAlign : MaxAlign;
895 else
896 MaxAlign = MaxAlign ? MaxAlign : 4;
897 }
898
Anton Korobeynikov0eecf5d2010-11-18 21:19:35 +0000899 if (hasFP(MF)) {
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000900 // Calculate required stack adjustment.
901 uint64_t FrameSize = StackSize - SlotSize;
Alexey Samsonovdcc12912012-07-16 06:54:09 +0000902 if (RegInfo->needsStackRealignment(MF)) {
903 // Callee-saved registers were pushed on stack before the stack
904 // was realigned.
905 FrameSize -= CSSize;
906 NumBytes = (FrameSize + MaxAlign - 1) / MaxAlign * MaxAlign;
907 } else {
908 NumBytes = FrameSize - CSSize;
909 }
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000910
911 // Pop EBP.
912 BuildMI(MBB, MBBI, DL,
Pavel Chupinf55eb452014-08-07 09:41:19 +0000913 TII.get(Is64Bit ? X86::POP64r : X86::POP32r), MachineFramePtr);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000914 } else {
915 NumBytes = StackSize - CSSize;
916 }
917
918 // Skip the callee-saved pop instructions.
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000919 while (MBBI != MBB.begin()) {
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +0000920 MachineBasicBlock::iterator PI = std::prev(MBBI);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000921 unsigned Opc = PI->getOpcode();
922
Jakob Stoklund Olesen4bc5e382011-01-13 21:28:52 +0000923 if (Opc != X86::POP32r && Opc != X86::POP64r && Opc != X86::DBG_VALUE &&
Evan Cheng7f8e5632011-12-07 07:15:52 +0000924 !PI->isTerminator())
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000925 break;
926
927 --MBBI;
928 }
Alexey Samsonovdcc12912012-07-16 06:54:09 +0000929 MachineBasicBlock::iterator FirstCSPop = MBBI;
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000930
931 DL = MBBI->getDebugLoc();
932
933 // If there is an ADD32ri or SUB32ri of ESP immediately before this
934 // instruction, merge the two instructions.
935 if (NumBytes || MFI->hasVarSizedObjects())
936 mergeSPUpdatesUp(MBB, MBBI, StackPtr, &NumBytes);
937
938 // If dynamic alloca is used, then reset esp to point to the last callee-saved
939 // slot before popping them off! Same applies for the case, when stack was
940 // realigned.
Alexey Samsonovdcc12912012-07-16 06:54:09 +0000941 if (RegInfo->needsStackRealignment(MF) || MFI->hasVarSizedObjects()) {
942 if (RegInfo->needsStackRealignment(MF))
943 MBBI = FirstCSPop;
944 if (CSSize != 0) {
Pavel Chupinf55eb452014-08-07 09:41:19 +0000945 unsigned Opc = getLEArOpcode(Uses64BitFramePtr);
Alexey Samsonovdcc12912012-07-16 06:54:09 +0000946 addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr),
947 FramePtr, false, -CSSize);
Reid Klecknere7040102014-08-04 21:05:27 +0000948 --MBBI;
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000949 } else {
Pavel Chupinf55eb452014-08-07 09:41:19 +0000950 unsigned Opc = (Uses64BitFramePtr ? X86::MOV64rr : X86::MOV32rr);
Alexey Samsonovdcc12912012-07-16 06:54:09 +0000951 BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr)
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000952 .addReg(FramePtr);
Reid Klecknere7040102014-08-04 21:05:27 +0000953 --MBBI;
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000954 }
955 } else if (NumBytes) {
956 // Adjust stack pointer back: ESP += numbytes.
Pavel Chupinf55eb452014-08-07 09:41:19 +0000957 emitSPUpdate(MBB, MBBI, StackPtr, NumBytes, Is64Bit, Uses64BitFramePtr, UseLEA,
Eli Bendersky44a40ca2013-02-05 21:53:29 +0000958 TII, *RegInfo);
Reid Klecknere7040102014-08-04 21:05:27 +0000959 --MBBI;
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000960 }
961
Reid Klecknere7040102014-08-04 21:05:27 +0000962 // Windows unwinder will not invoke function's exception handler if IP is
963 // either in prologue or in epilogue. This behavior causes a problem when a
964 // call immediately precedes an epilogue, because the return address points
965 // into the epilogue. To cope with that, we insert an epilogue marker here,
966 // then replace it with a 'nop' if it ends up immediately after a CALL in the
967 // final emitted code.
968 if (NeedsWinEH)
969 BuildMI(MBB, MBBI, DL, TII.get(X86::SEH_Epilogue));
970
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000971 // We're returning from function via eh_return.
972 if (RetOpcode == X86::EH_RETURN || RetOpcode == X86::EH_RETURN64) {
Jakob Stoklund Olesen4bc5e382011-01-13 21:28:52 +0000973 MBBI = MBB.getLastNonDebugInstr();
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000974 MachineOperand &DestAddr = MBBI->getOperand(0);
975 assert(DestAddr.isReg() && "Offset should be in register!");
976 BuildMI(MBB, MBBI, DL,
Pavel Chupinf55eb452014-08-07 09:41:19 +0000977 TII.get(Uses64BitFramePtr ? X86::MOV64rr : X86::MOV32rr),
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000978 StackPtr).addReg(DestAddr.getReg());
979 } else if (RetOpcode == X86::TCRETURNri || RetOpcode == X86::TCRETURNdi ||
980 RetOpcode == X86::TCRETURNmi ||
981 RetOpcode == X86::TCRETURNri64 || RetOpcode == X86::TCRETURNdi64 ||
982 RetOpcode == X86::TCRETURNmi64) {
983 bool isMem = RetOpcode == X86::TCRETURNmi || RetOpcode == X86::TCRETURNmi64;
984 // Tail call return: adjust the stack pointer and jump to callee.
Jakob Stoklund Olesenbbb1a542011-01-13 22:47:43 +0000985 MBBI = MBB.getLastNonDebugInstr();
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +0000986 MachineOperand &JumpTarget = MBBI->getOperand(0);
987 MachineOperand &StackAdjust = MBBI->getOperand(isMem ? 5 : 1);
988 assert(StackAdjust.isImm() && "Expecting immediate value.");
989
990 // Adjust stack pointer.
991 int StackAdj = StackAdjust.getImm();
992 int MaxTCDelta = X86FI->getTCReturnAddrDelta();
993 int Offset = 0;
994 assert(MaxTCDelta <= 0 && "MaxTCDelta should never be positive");
995
996 // Incoporate the retaddr area.
997 Offset = StackAdj-MaxTCDelta;
998 assert(Offset >= 0 && "Offset should never be negative");
999
1000 if (Offset) {
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001001 // Check for possible merge with preceding ADD instruction.
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +00001002 Offset += mergeSPUpdates(MBB, MBBI, StackPtr, true);
Pavel Chupinf55eb452014-08-07 09:41:19 +00001003 emitSPUpdate(MBB, MBBI, StackPtr, Offset, Is64Bit, Uses64BitFramePtr,
Eli Bendersky44a40ca2013-02-05 21:53:29 +00001004 UseLEA, TII, *RegInfo);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +00001005 }
1006
1007 // Jump to label or value in register.
1008 if (RetOpcode == X86::TCRETURNdi || RetOpcode == X86::TCRETURNdi64) {
Evan Chengd4b08732010-11-30 23:55:39 +00001009 MachineInstrBuilder MIB =
1010 BuildMI(MBB, MBBI, DL, TII.get((RetOpcode == X86::TCRETURNdi)
1011 ? X86::TAILJMPd : X86::TAILJMPd64));
1012 if (JumpTarget.isGlobal())
1013 MIB.addGlobalAddress(JumpTarget.getGlobal(), JumpTarget.getOffset(),
1014 JumpTarget.getTargetFlags());
1015 else {
1016 assert(JumpTarget.isSymbol());
1017 MIB.addExternalSymbol(JumpTarget.getSymbolName(),
1018 JumpTarget.getTargetFlags());
1019 }
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +00001020 } else if (RetOpcode == X86::TCRETURNmi || RetOpcode == X86::TCRETURNmi64) {
1021 MachineInstrBuilder MIB =
1022 BuildMI(MBB, MBBI, DL, TII.get((RetOpcode == X86::TCRETURNmi)
1023 ? X86::TAILJMPm : X86::TAILJMPm64));
1024 for (unsigned i = 0; i != 5; ++i)
1025 MIB.addOperand(MBBI->getOperand(i));
1026 } else if (RetOpcode == X86::TCRETURNri64) {
1027 BuildMI(MBB, MBBI, DL, TII.get(X86::TAILJMPr64)).
1028 addReg(JumpTarget.getReg(), RegState::Kill);
1029 } else {
1030 BuildMI(MBB, MBBI, DL, TII.get(X86::TAILJMPr)).
1031 addReg(JumpTarget.getReg(), RegState::Kill);
1032 }
1033
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +00001034 MachineInstr *NewMI = std::prev(MBBI);
Jakob Stoklund Olesen33f5d142012-12-20 22:54:02 +00001035 NewMI->copyImplicitOps(MF, MBBI);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +00001036
1037 // Delete the pseudo instruction TCRETURN.
1038 MBB.erase(MBBI);
David Woodhouse4e033b02014-01-13 14:05:59 +00001039 } else if ((RetOpcode == X86::RETQ || RetOpcode == X86::RETL ||
1040 RetOpcode == X86::RETIQ || RetOpcode == X86::RETIL) &&
1041 (X86FI->getTCReturnAddrDelta() < 0)) {
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +00001042 // Add the return addr area delta back since we are not tail calling.
1043 int delta = -1*X86FI->getTCReturnAddrDelta();
Jakob Stoklund Olesen4bc5e382011-01-13 21:28:52 +00001044 MBBI = MBB.getLastNonDebugInstr();
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +00001045
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001046 // Check for possible merge with preceding ADD instruction.
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +00001047 delta += mergeSPUpdates(MBB, MBBI, StackPtr, true);
Pavel Chupinf55eb452014-08-07 09:41:19 +00001048 emitSPUpdate(MBB, MBBI, StackPtr, delta, Is64Bit, Uses64BitFramePtr, UseLEA, TII,
Eli Bendersky44a40ca2013-02-05 21:53:29 +00001049 *RegInfo);
Anton Korobeynikovf7183ed2010-11-15 00:06:54 +00001050 }
1051}
Anton Korobeynikov14ee3442010-11-18 23:25:52 +00001052
Eric Christopher4237bf12014-04-29 00:16:33 +00001053int X86FrameLowering::getFrameIndexOffset(const MachineFunction &MF,
1054 int FI) const {
Eric Christopherfc6de422014-08-05 02:39:49 +00001055 const X86RegisterInfo *RegInfo =
1056 static_cast<const X86RegisterInfo *>(MF.getSubtarget().getRegisterInfo());
Anton Korobeynikov46877782010-11-20 15:59:32 +00001057 const MachineFrameInfo *MFI = MF.getFrameInfo();
1058 int Offset = MFI->getObjectOffset(FI) - getOffsetOfLocalArea();
1059 uint64_t StackSize = MFI->getStackSize();
1060
Chad Rosierbdb08ac2012-07-10 17:45:53 +00001061 if (RegInfo->hasBasePointer(MF)) {
1062 assert (hasFP(MF) && "VLAs and dynamic stack realign, but no FP?!");
1063 if (FI < 0) {
1064 // Skip the saved EBP.
1065 return Offset + RegInfo->getSlotSize();
1066 } else {
1067 assert((-(Offset + StackSize)) % MFI->getObjectAlignment(FI) == 0);
1068 return Offset + StackSize;
1069 }
1070 } else if (RegInfo->needsStackRealignment(MF)) {
Anton Korobeynikov46877782010-11-20 15:59:32 +00001071 if (FI < 0) {
1072 // Skip the saved EBP.
Chad Rosier20b79dc2012-05-23 23:45:10 +00001073 return Offset + RegInfo->getSlotSize();
Anton Korobeynikov46877782010-11-20 15:59:32 +00001074 } else {
Duncan Sandsd278d352011-10-18 12:44:00 +00001075 assert((-(Offset + StackSize)) % MFI->getObjectAlignment(FI) == 0);
Anton Korobeynikov46877782010-11-20 15:59:32 +00001076 return Offset + StackSize;
1077 }
1078 // FIXME: Support tail calls
1079 } else {
1080 if (!hasFP(MF))
1081 return Offset + StackSize;
1082
1083 // Skip the saved EBP.
Chad Rosier20b79dc2012-05-23 23:45:10 +00001084 Offset += RegInfo->getSlotSize();
Anton Korobeynikov46877782010-11-20 15:59:32 +00001085
1086 // Skip the RETADDR move area
1087 const X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1088 int TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
1089 if (TailCallReturnAddrDelta < 0)
1090 Offset -= TailCallReturnAddrDelta;
1091 }
1092
1093 return Offset;
1094}
Anton Korobeynikovd08fbd12010-11-27 23:05:03 +00001095
Alexey Samsonovc4b3ad82012-05-01 15:16:06 +00001096int X86FrameLowering::getFrameIndexReference(const MachineFunction &MF, int FI,
1097 unsigned &FrameReg) const {
Eric Christopherfc6de422014-08-05 02:39:49 +00001098 const X86RegisterInfo *RegInfo =
1099 static_cast<const X86RegisterInfo *>(MF.getSubtarget().getRegisterInfo());
Alexey Samsonovc4b3ad82012-05-01 15:16:06 +00001100 // We can't calculate offset from frame pointer if the stack is realigned,
Chad Rosierbdb08ac2012-07-10 17:45:53 +00001101 // so enforce usage of stack/base pointer. The base pointer is used when we
1102 // have dynamic allocas in addition to dynamic realignment.
1103 if (RegInfo->hasBasePointer(MF))
1104 FrameReg = RegInfo->getBaseRegister();
1105 else if (RegInfo->needsStackRealignment(MF))
1106 FrameReg = RegInfo->getStackRegister();
1107 else
1108 FrameReg = RegInfo->getFrameRegister(MF);
Alexey Samsonovc4b3ad82012-05-01 15:16:06 +00001109 return getFrameIndexOffset(MF, FI);
1110}
1111
NAKAMURA Takumi1db59952014-06-25 12:41:52 +00001112bool X86FrameLowering::assignCalleeSavedSpillSlots(
1113 MachineFunction &MF, const TargetRegisterInfo *TRI,
1114 std::vector<CalleeSavedInfo> &CSI) const {
1115 MachineFrameInfo *MFI = MF.getFrameInfo();
Eric Christopherfc6de422014-08-05 02:39:49 +00001116 const X86RegisterInfo *RegInfo =
1117 static_cast<const X86RegisterInfo *>(MF.getSubtarget().getRegisterInfo());
NAKAMURA Takumi1db59952014-06-25 12:41:52 +00001118 unsigned SlotSize = RegInfo->getSlotSize();
1119 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
Anton Korobeynikovd08fbd12010-11-27 23:05:03 +00001120
NAKAMURA Takumi1db59952014-06-25 12:41:52 +00001121 unsigned CalleeSavedFrameSize = 0;
1122 int SpillSlotOffset = getOffsetOfLocalArea() + X86FI->getTCReturnAddrDelta();
1123
1124 if (hasFP(MF)) {
1125 // emitPrologue always spills frame register the first thing.
1126 SpillSlotOffset -= SlotSize;
1127 MFI->CreateFixedSpillStackObject(SlotSize, SpillSlotOffset);
1128
1129 // Since emitPrologue and emitEpilogue will handle spilling and restoring of
1130 // the frame register, we can delete it from CSI list and not have to worry
1131 // about avoiding it later.
1132 unsigned FPReg = RegInfo->getFrameRegister(MF);
1133 for (unsigned i = 0; i < CSI.size(); ++i) {
Pavel Chupinf55eb452014-08-07 09:41:19 +00001134 if (TRI->regsOverlap(CSI[i].getReg(),FPReg)) {
NAKAMURA Takumi1db59952014-06-25 12:41:52 +00001135 CSI.erase(CSI.begin() + i);
1136 break;
1137 }
1138 }
1139 }
1140
1141 // Assign slots for GPRs. It increases frame size.
1142 for (unsigned i = CSI.size(); i != 0; --i) {
1143 unsigned Reg = CSI[i - 1].getReg();
1144
1145 if (!X86::GR64RegClass.contains(Reg) && !X86::GR32RegClass.contains(Reg))
1146 continue;
1147
1148 SpillSlotOffset -= SlotSize;
1149 CalleeSavedFrameSize += SlotSize;
1150
1151 int SlotIndex = MFI->CreateFixedSpillStackObject(SlotSize, SpillSlotOffset);
1152 CSI[i - 1].setFrameIdx(SlotIndex);
1153 }
1154
1155 X86FI->setCalleeSavedFrameSize(CalleeSavedFrameSize);
1156
1157 // Assign slots for XMMs.
1158 for (unsigned i = CSI.size(); i != 0; --i) {
1159 unsigned Reg = CSI[i - 1].getReg();
1160 if (X86::GR64RegClass.contains(Reg) || X86::GR32RegClass.contains(Reg))
1161 continue;
1162
1163 const TargetRegisterClass *RC = RegInfo->getMinimalPhysRegClass(Reg);
1164 // ensure alignment
1165 SpillSlotOffset -= abs(SpillSlotOffset) % RC->getAlignment();
1166 // spill into slot
1167 SpillSlotOffset -= RC->getSize();
1168 int SlotIndex =
1169 MFI->CreateFixedSpillStackObject(RC->getSize(), SpillSlotOffset);
1170 CSI[i - 1].setFrameIdx(SlotIndex);
1171 MFI->ensureMaxAlignment(RC->getAlignment());
1172 }
1173
1174 return true;
1175}
1176
1177bool X86FrameLowering::spillCalleeSavedRegisters(
1178 MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
1179 const std::vector<CalleeSavedInfo> &CSI,
1180 const TargetRegisterInfo *TRI) const {
Anton Korobeynikovd08fbd12010-11-27 23:05:03 +00001181 DebugLoc DL = MBB.findDebugLoc(MI);
1182
1183 MachineFunction &MF = *MBB.getParent();
Eric Christopherfc6de422014-08-05 02:39:49 +00001184 const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
Eric Christopherf4381642014-06-05 22:00:31 +00001185 const X86Subtarget &STI = MF.getTarget().getSubtarget<X86Subtarget>();
Anton Korobeynikovd08fbd12010-11-27 23:05:03 +00001186
NAKAMURA Takumid4e50032011-02-27 08:47:19 +00001187 // Push GPRs. It increases frame size.
Anton Korobeynikovd08fbd12010-11-27 23:05:03 +00001188 unsigned Opc = STI.is64Bit() ? X86::PUSH64r : X86::PUSH32r;
1189 for (unsigned i = CSI.size(); i != 0; --i) {
NAKAMURA Takumic403be12014-06-25 12:40:56 +00001190 unsigned Reg = CSI[i - 1].getReg();
1191
1192 if (!X86::GR64RegClass.contains(Reg) && !X86::GR32RegClass.contains(Reg))
NAKAMURA Takumid4e50032011-02-27 08:47:19 +00001193 continue;
Anton Korobeynikovd08fbd12010-11-27 23:05:03 +00001194 // Add the callee-saved register as live-in. It's killed at the spill.
1195 MBB.addLiveIn(Reg);
NAKAMURA Takumi1db59952014-06-25 12:41:52 +00001196
Charles Davis7ed40cb2011-06-12 01:45:54 +00001197 BuildMI(MBB, MI, DL, TII.get(Opc)).addReg(Reg, RegState::Kill)
1198 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikovd08fbd12010-11-27 23:05:03 +00001199 }
1200
NAKAMURA Takumid4e50032011-02-27 08:47:19 +00001201 // Make XMM regs spilled. X86 does not have ability of push/pop XMM.
1202 // It can be done by spilling XMMs to stack frame.
NAKAMURA Takumid4e50032011-02-27 08:47:19 +00001203 for (unsigned i = CSI.size(); i != 0; --i) {
1204 unsigned Reg = CSI[i-1].getReg();
1205 if (X86::GR64RegClass.contains(Reg) ||
1206 X86::GR32RegClass.contains(Reg))
1207 continue;
1208 // Add the callee-saved register as live-in. It's killed at the spill.
1209 MBB.addLiveIn(Reg);
1210 const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
NAKAMURA Takumic403be12014-06-25 12:40:56 +00001211
1212 TII.storeRegToStackSlot(MBB, MI, Reg, true, CSI[i - 1].getFrameIdx(), RC,
1213 TRI);
NAKAMURA Takumi1db59952014-06-25 12:41:52 +00001214 --MI;
1215 MI->setFlag(MachineInstr::FrameSetup);
1216 ++MI;
NAKAMURA Takumid4e50032011-02-27 08:47:19 +00001217 }
1218
Anton Korobeynikovd08fbd12010-11-27 23:05:03 +00001219 return true;
1220}
1221
Anton Korobeynikov2f931282011-01-10 12:39:04 +00001222bool X86FrameLowering::restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
Anton Korobeynikovd08fbd12010-11-27 23:05:03 +00001223 MachineBasicBlock::iterator MI,
1224 const std::vector<CalleeSavedInfo> &CSI,
1225 const TargetRegisterInfo *TRI) const {
1226 if (CSI.empty())
1227 return false;
1228
1229 DebugLoc DL = MBB.findDebugLoc(MI);
1230
1231 MachineFunction &MF = *MBB.getParent();
Eric Christopherfc6de422014-08-05 02:39:49 +00001232 const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
Eric Christopherf4381642014-06-05 22:00:31 +00001233 const X86Subtarget &STI = MF.getTarget().getSubtarget<X86Subtarget>();
NAKAMURA Takumid4e50032011-02-27 08:47:19 +00001234
1235 // Reload XMMs from stack frame.
1236 for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1237 unsigned Reg = CSI[i].getReg();
1238 if (X86::GR64RegClass.contains(Reg) ||
1239 X86::GR32RegClass.contains(Reg))
1240 continue;
NAKAMURA Takumic403be12014-06-25 12:40:56 +00001241
NAKAMURA Takumid4e50032011-02-27 08:47:19 +00001242 const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
NAKAMURA Takumic403be12014-06-25 12:40:56 +00001243 TII.loadRegFromStackSlot(MBB, MI, Reg, CSI[i].getFrameIdx(), RC, TRI);
NAKAMURA Takumid4e50032011-02-27 08:47:19 +00001244 }
1245
1246 // POP GPRs.
Anton Korobeynikovd08fbd12010-11-27 23:05:03 +00001247 unsigned Opc = STI.is64Bit() ? X86::POP64r : X86::POP32r;
1248 for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1249 unsigned Reg = CSI[i].getReg();
NAKAMURA Takumid4e50032011-02-27 08:47:19 +00001250 if (!X86::GR64RegClass.contains(Reg) &&
1251 !X86::GR32RegClass.contains(Reg))
1252 continue;
NAKAMURA Takumi1db59952014-06-25 12:41:52 +00001253
NAKAMURA Takumid4e50032011-02-27 08:47:19 +00001254 BuildMI(MBB, MI, DL, TII.get(Opc), Reg);
Anton Korobeynikovd08fbd12010-11-27 23:05:03 +00001255 }
1256 return true;
1257}
Anton Korobeynikov7283b8d2010-11-27 23:05:25 +00001258
1259void
Anton Korobeynikov2f931282011-01-10 12:39:04 +00001260X86FrameLowering::processFunctionBeforeCalleeSavedScan(MachineFunction &MF,
Eric Christopher11b05cc2014-06-05 00:09:05 +00001261 RegScavenger *RS) const {
Anton Korobeynikov7283b8d2010-11-27 23:05:25 +00001262 MachineFrameInfo *MFI = MF.getFrameInfo();
Eric Christopherfc6de422014-08-05 02:39:49 +00001263 const X86RegisterInfo *RegInfo =
1264 static_cast<const X86RegisterInfo *>(MF.getSubtarget().getRegisterInfo());
Anton Korobeynikov7283b8d2010-11-27 23:05:25 +00001265 unsigned SlotSize = RegInfo->getSlotSize();
1266
1267 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
Tim Northoverecc018c2013-08-04 09:35:57 +00001268 int64_t TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
Anton Korobeynikov7283b8d2010-11-27 23:05:25 +00001269
1270 if (TailCallReturnAddrDelta < 0) {
1271 // create RETURNADDR area
1272 // arg
1273 // arg
1274 // RETADDR
1275 // { ...
1276 // RETADDR area
1277 // ...
1278 // }
1279 // [EBP]
1280 MFI->CreateFixedObject(-TailCallReturnAddrDelta,
Tim Northoverecc018c2013-08-04 09:35:57 +00001281 TailCallReturnAddrDelta - SlotSize, true);
Anton Korobeynikov7283b8d2010-11-27 23:05:25 +00001282 }
1283
Chad Rosierbdb08ac2012-07-10 17:45:53 +00001284 // Spill the BasePtr if it's used.
1285 if (RegInfo->hasBasePointer(MF))
1286 MF.getRegInfo().setPhysRegUsed(RegInfo->getBaseRegister());
Anton Korobeynikov7283b8d2010-11-27 23:05:25 +00001287}
Rafael Espindolac2174212011-08-30 19:39:58 +00001288
1289static bool
1290HasNestArgument(const MachineFunction *MF) {
1291 const Function *F = MF->getFunction();
1292 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1293 I != E; I++) {
1294 if (I->hasNestAttr())
1295 return true;
1296 }
1297 return false;
1298}
1299
Benjamin Kramer53bc37c2013-02-18 20:55:12 +00001300/// GetScratchRegister - Get a temp register for performing work in the
1301/// segmented stack and the Erlang/HiPE stack prologue. Depending on platform
1302/// and the properties of the function either one or two registers will be
1303/// needed. Set primary to true for the first register, false for the second.
Rafael Espindolac2174212011-08-30 19:39:58 +00001304static unsigned
Rafael Espindolad90466b2012-01-11 19:00:37 +00001305GetScratchRegister(bool Is64Bit, const MachineFunction &MF, bool Primary) {
Benjamin Kramer53bc37c2013-02-18 20:55:12 +00001306 CallingConv::ID CallingConvention = MF.getFunction()->getCallingConv();
1307
1308 // Erlang stuff.
1309 if (CallingConvention == CallingConv::HiPE) {
1310 if (Is64Bit)
1311 return Primary ? X86::R14 : X86::R13;
1312 else
1313 return Primary ? X86::EBX : X86::EDI;
1314 }
1315
David Blaikie46a9f012012-01-20 21:51:11 +00001316 if (Is64Bit)
Rafael Espindolad90466b2012-01-11 19:00:37 +00001317 return Primary ? X86::R11 : X86::R12;
Rafael Espindolac2174212011-08-30 19:39:58 +00001318
David Blaikie46a9f012012-01-20 21:51:11 +00001319 bool IsNested = HasNestArgument(&MF);
1320
1321 if (CallingConvention == CallingConv::X86_FastCall ||
1322 CallingConvention == CallingConv::Fast) {
1323 if (IsNested)
1324 report_fatal_error("Segmented stacks does not support fastcall with "
1325 "nested function.");
1326 return Primary ? X86::EAX : X86::ECX;
Rafael Espindolac2174212011-08-30 19:39:58 +00001327 }
David Blaikie46a9f012012-01-20 21:51:11 +00001328 if (IsNested)
1329 return Primary ? X86::EDX : X86::EAX;
1330 return Primary ? X86::ECX : X86::EAX;
Rafael Espindolac2174212011-08-30 19:39:58 +00001331}
1332
Sanjoy Das006e43b2011-12-03 09:32:07 +00001333// The stack limit in the TCB is set to this many bytes above the actual stack
1334// limit.
1335static const uint64_t kSplitStackAvailable = 256;
1336
Rafael Espindolac2174212011-08-30 19:39:58 +00001337void
1338X86FrameLowering::adjustForSegmentedStacks(MachineFunction &MF) const {
1339 MachineBasicBlock &prologueMBB = MF.front();
1340 MachineFrameInfo *MFI = MF.getFrameInfo();
Eric Christopherfc6de422014-08-05 02:39:49 +00001341 const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
Rafael Espindolac2174212011-08-30 19:39:58 +00001342 uint64_t StackSize;
Eric Christopherf4381642014-06-05 22:00:31 +00001343 const X86Subtarget &STI = MF.getTarget().getSubtarget<X86Subtarget>();
Rafael Espindolac2174212011-08-30 19:39:58 +00001344 bool Is64Bit = STI.is64Bit();
1345 unsigned TlsReg, TlsOffset;
1346 DebugLoc DL;
Rafael Espindolac2174212011-08-30 19:39:58 +00001347
Rafael Espindolad90466b2012-01-11 19:00:37 +00001348 unsigned ScratchReg = GetScratchRegister(Is64Bit, MF, true);
Rafael Espindolac2174212011-08-30 19:39:58 +00001349 assert(!MF.getRegInfo().isLiveIn(ScratchReg) &&
1350 "Scratch register is live-in");
1351
1352 if (MF.getFunction()->isVarArg())
1353 report_fatal_error("Segmented stacks do not support vararg functions.");
Benjamin Kramer1cb826b2013-02-19 17:32:57 +00001354 if (!STI.isTargetLinux() && !STI.isTargetDarwin() &&
Reid Kleckner10110272014-04-01 18:34:21 +00001355 !STI.isTargetWin32() && !STI.isTargetWin64() && !STI.isTargetFreeBSD())
Rafael Espindola00e861e2012-01-12 20:24:30 +00001356 report_fatal_error("Segmented stacks not supported on this platform.");
Rafael Espindolac2174212011-08-30 19:39:58 +00001357
Tim Northoverf9e798b2014-05-22 13:03:43 +00001358 // Eventually StackSize will be calculated by a link-time pass; which will
1359 // also decide whether checking code needs to be injected into this particular
1360 // prologue.
1361 StackSize = MFI->getStackSize();
1362
1363 // Do not generate a prologue for functions with a stack of size zero
1364 if (StackSize == 0)
1365 return;
1366
Rafael Espindolac2174212011-08-30 19:39:58 +00001367 MachineBasicBlock *allocMBB = MF.CreateMachineBasicBlock();
1368 MachineBasicBlock *checkMBB = MF.CreateMachineBasicBlock();
1369 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1370 bool IsNested = false;
1371
1372 // We need to know if the function has a nest argument only in 64 bit mode.
1373 if (Is64Bit)
1374 IsNested = HasNestArgument(&MF);
1375
Bill Wendling25f6d3e2011-10-13 08:24:19 +00001376 // The MOV R10, RAX needs to be in a different block, since the RET we emit in
1377 // allocMBB needs to be last (terminating) instruction.
Bill Wendling25f6d3e2011-10-13 08:24:19 +00001378
Rafael Espindolac2174212011-08-30 19:39:58 +00001379 for (MachineBasicBlock::livein_iterator i = prologueMBB.livein_begin(),
1380 e = prologueMBB.livein_end(); i != e; i++) {
1381 allocMBB->addLiveIn(*i);
1382 checkMBB->addLiveIn(*i);
1383 }
1384
1385 if (IsNested)
Rafael Espindola66393c12011-10-26 21:12:27 +00001386 allocMBB->addLiveIn(X86::R10);
1387
Rafael Espindolac2174212011-08-30 19:39:58 +00001388 MF.push_front(allocMBB);
1389 MF.push_front(checkMBB);
1390
Rafael Espindolad90466b2012-01-11 19:00:37 +00001391 // When the frame size is less than 256 we just compare the stack
1392 // boundary directly to the value of the stack pointer, per gcc.
1393 bool CompareStackPointer = StackSize < kSplitStackAvailable;
1394
Rafael Espindolac2174212011-08-30 19:39:58 +00001395 // Read the limit off the current stacklet off the stack_guard location.
1396 if (Is64Bit) {
Benjamin Kramer1cb826b2013-02-19 17:32:57 +00001397 if (STI.isTargetLinux()) {
Rafael Espindolad90466b2012-01-11 19:00:37 +00001398 TlsReg = X86::FS;
1399 TlsOffset = 0x70;
Benjamin Kramer1cb826b2013-02-19 17:32:57 +00001400 } else if (STI.isTargetDarwin()) {
Rafael Espindolad90466b2012-01-11 19:00:37 +00001401 TlsReg = X86::GS;
1402 TlsOffset = 0x60 + 90*8; // See pthread_machdep.h. Steal TLS slot 90.
Reid Kleckner10110272014-04-01 18:34:21 +00001403 } else if (STI.isTargetWin64()) {
1404 TlsReg = X86::GS;
1405 TlsOffset = 0x28; // pvArbitrary, reserved for application use
Benjamin Kramer1cb826b2013-02-19 17:32:57 +00001406 } else if (STI.isTargetFreeBSD()) {
Rafael Espindola00e861e2012-01-12 20:24:30 +00001407 TlsReg = X86::FS;
1408 TlsOffset = 0x18;
Rafael Espindola10745d32012-01-12 20:22:08 +00001409 } else {
1410 report_fatal_error("Segmented stacks not supported on this platform.");
Rafael Espindolad90466b2012-01-11 19:00:37 +00001411 }
Rafael Espindolac2174212011-08-30 19:39:58 +00001412
Rafael Espindolad90466b2012-01-11 19:00:37 +00001413 if (CompareStackPointer)
Sanjoy Das006e43b2011-12-03 09:32:07 +00001414 ScratchReg = X86::RSP;
1415 else
1416 BuildMI(checkMBB, DL, TII.get(X86::LEA64r), ScratchReg).addReg(X86::RSP)
Rafael Espindola6635ae12012-01-11 18:14:03 +00001417 .addImm(1).addReg(0).addImm(-StackSize).addReg(0);
Sanjoy Das006e43b2011-12-03 09:32:07 +00001418
Rafael Espindolac2174212011-08-30 19:39:58 +00001419 BuildMI(checkMBB, DL, TII.get(X86::CMP64rm)).addReg(ScratchReg)
Rafael Espindola6635ae12012-01-11 18:14:03 +00001420 .addReg(0).addImm(1).addReg(0).addImm(TlsOffset).addReg(TlsReg);
Rafael Espindolac2174212011-08-30 19:39:58 +00001421 } else {
Benjamin Kramer1cb826b2013-02-19 17:32:57 +00001422 if (STI.isTargetLinux()) {
Rafael Espindola10745d32012-01-12 20:22:08 +00001423 TlsReg = X86::GS;
1424 TlsOffset = 0x30;
Benjamin Kramer1cb826b2013-02-19 17:32:57 +00001425 } else if (STI.isTargetDarwin()) {
Rafael Espindola10745d32012-01-12 20:22:08 +00001426 TlsReg = X86::GS;
1427 TlsOffset = 0x48 + 90*4;
Benjamin Kramer1cb826b2013-02-19 17:32:57 +00001428 } else if (STI.isTargetWin32()) {
Rafael Espindola10745d32012-01-12 20:22:08 +00001429 TlsReg = X86::FS;
1430 TlsOffset = 0x14; // pvArbitrary, reserved for application use
Benjamin Kramer1cb826b2013-02-19 17:32:57 +00001431 } else if (STI.isTargetFreeBSD()) {
Rafael Espindola00e861e2012-01-12 20:24:30 +00001432 report_fatal_error("Segmented stacks not supported on FreeBSD i386.");
Rafael Espindola10745d32012-01-12 20:22:08 +00001433 } else {
1434 report_fatal_error("Segmented stacks not supported on this platform.");
1435 }
Rafael Espindolac2174212011-08-30 19:39:58 +00001436
Rafael Espindolad90466b2012-01-11 19:00:37 +00001437 if (CompareStackPointer)
Sanjoy Das006e43b2011-12-03 09:32:07 +00001438 ScratchReg = X86::ESP;
1439 else
1440 BuildMI(checkMBB, DL, TII.get(X86::LEA32r), ScratchReg).addReg(X86::ESP)
Rafael Espindola6635ae12012-01-11 18:14:03 +00001441 .addImm(1).addReg(0).addImm(-StackSize).addReg(0);
Sanjoy Das006e43b2011-12-03 09:32:07 +00001442
Reid Kleckner10110272014-04-01 18:34:21 +00001443 if (STI.isTargetLinux() || STI.isTargetWin32() || STI.isTargetWin64()) {
Rafael Espindolad90466b2012-01-11 19:00:37 +00001444 BuildMI(checkMBB, DL, TII.get(X86::CMP32rm)).addReg(ScratchReg)
1445 .addReg(0).addImm(0).addReg(0).addImm(TlsOffset).addReg(TlsReg);
Benjamin Kramer1cb826b2013-02-19 17:32:57 +00001446 } else if (STI.isTargetDarwin()) {
Rafael Espindolad90466b2012-01-11 19:00:37 +00001447
Eric Christopher4237bf12014-04-29 00:16:33 +00001448 // TlsOffset doesn't fit into a mod r/m byte so we need an extra register.
Rafael Espindolad90466b2012-01-11 19:00:37 +00001449 unsigned ScratchReg2;
1450 bool SaveScratch2;
1451 if (CompareStackPointer) {
Eric Christopher4237bf12014-04-29 00:16:33 +00001452 // The primary scratch register is available for holding the TLS offset.
Rafael Espindolad90466b2012-01-11 19:00:37 +00001453 ScratchReg2 = GetScratchRegister(Is64Bit, MF, true);
1454 SaveScratch2 = false;
1455 } else {
1456 // Need to use a second register to hold the TLS offset
1457 ScratchReg2 = GetScratchRegister(Is64Bit, MF, false);
1458
Eric Christopher4237bf12014-04-29 00:16:33 +00001459 // Unfortunately, with fastcc the second scratch register may hold an
1460 // argument.
Rafael Espindolad90466b2012-01-11 19:00:37 +00001461 SaveScratch2 = MF.getRegInfo().isLiveIn(ScratchReg2);
1462 }
1463
Eric Christopher4237bf12014-04-29 00:16:33 +00001464 // If Scratch2 is live-in then it needs to be saved.
Rafael Espindolad90466b2012-01-11 19:00:37 +00001465 assert((!MF.getRegInfo().isLiveIn(ScratchReg2) || SaveScratch2) &&
1466 "Scratch register is live-in and not saved");
1467
1468 if (SaveScratch2)
1469 BuildMI(checkMBB, DL, TII.get(X86::PUSH32r))
1470 .addReg(ScratchReg2, RegState::Kill);
1471
1472 BuildMI(checkMBB, DL, TII.get(X86::MOV32ri), ScratchReg2)
1473 .addImm(TlsOffset);
1474 BuildMI(checkMBB, DL, TII.get(X86::CMP32rm))
1475 .addReg(ScratchReg)
1476 .addReg(ScratchReg2).addImm(1).addReg(0)
1477 .addImm(0)
1478 .addReg(TlsReg);
1479
1480 if (SaveScratch2)
1481 BuildMI(checkMBB, DL, TII.get(X86::POP32r), ScratchReg2);
1482 }
Rafael Espindolac2174212011-08-30 19:39:58 +00001483 }
1484
1485 // This jump is taken if SP >= (Stacklet Limit + Stack Space required).
1486 // It jumps to normal execution of the function body.
Rafael Espindola2b894482012-01-11 18:23:35 +00001487 BuildMI(checkMBB, DL, TII.get(X86::JA_4)).addMBB(&prologueMBB);
Rafael Espindolac2174212011-08-30 19:39:58 +00001488
1489 // On 32 bit we first push the arguments size and then the frame size. On 64
1490 // bit, we pass the stack frame size in r10 and the argument size in r11.
1491 if (Is64Bit) {
1492 // Functions with nested arguments use R10, so it needs to be saved across
1493 // the call to _morestack
1494
1495 if (IsNested)
1496 BuildMI(allocMBB, DL, TII.get(X86::MOV64rr), X86::RAX).addReg(X86::R10);
1497
1498 BuildMI(allocMBB, DL, TII.get(X86::MOV64ri), X86::R10)
1499 .addImm(StackSize);
1500 BuildMI(allocMBB, DL, TII.get(X86::MOV64ri), X86::R11)
1501 .addImm(X86FI->getArgumentStackSize());
1502 MF.getRegInfo().setPhysRegUsed(X86::R10);
1503 MF.getRegInfo().setPhysRegUsed(X86::R11);
1504 } else {
Rafael Espindolac2174212011-08-30 19:39:58 +00001505 BuildMI(allocMBB, DL, TII.get(X86::PUSHi32))
1506 .addImm(X86FI->getArgumentStackSize());
1507 BuildMI(allocMBB, DL, TII.get(X86::PUSHi32))
1508 .addImm(StackSize);
1509 }
1510
1511 // __morestack is in libgcc
1512 if (Is64Bit)
1513 BuildMI(allocMBB, DL, TII.get(X86::CALL64pcrel32))
1514 .addExternalSymbol("__morestack");
1515 else
1516 BuildMI(allocMBB, DL, TII.get(X86::CALLpcrel32))
1517 .addExternalSymbol("__morestack");
1518
Bill Wendling25f6d3e2011-10-13 08:24:19 +00001519 if (IsNested)
Rafael Espindola66393c12011-10-26 21:12:27 +00001520 BuildMI(allocMBB, DL, TII.get(X86::MORESTACK_RET_RESTORE_R10));
1521 else
1522 BuildMI(allocMBB, DL, TII.get(X86::MORESTACK_RET));
Bill Wendling25f6d3e2011-10-13 08:24:19 +00001523
Rafael Espindola66393c12011-10-26 21:12:27 +00001524 allocMBB->addSuccessor(&prologueMBB);
Bill Wendling25f6d3e2011-10-13 08:24:19 +00001525
Rafael Espindolac2174212011-08-30 19:39:58 +00001526 checkMBB->addSuccessor(allocMBB);
1527 checkMBB->addSuccessor(&prologueMBB);
1528
Jakob Stoklund Olesen55cf2ed2011-09-24 01:11:19 +00001529#ifdef XDEBUG
Rafael Espindolac2174212011-08-30 19:39:58 +00001530 MF.verify();
1531#endif
1532}
Benjamin Kramer53bc37c2013-02-18 20:55:12 +00001533
Yiannis Tsiourisd4842e52013-02-28 16:59:10 +00001534/// Erlang programs may need a special prologue to handle the stack size they
1535/// might need at runtime. That is because Erlang/OTP does not implement a C
1536/// stack but uses a custom implementation of hybrid stack/heap architecture.
1537/// (for more information see Eric Stenman's Ph.D. thesis:
1538/// http://publications.uu.se/uu/fulltext/nbn_se_uu_diva-2688.pdf)
1539///
1540/// CheckStack:
Eric Christopher4237bf12014-04-29 00:16:33 +00001541/// temp0 = sp - MaxStack
1542/// if( temp0 < SP_LIMIT(P) ) goto IncStack else goto OldStart
Yiannis Tsiourisd4842e52013-02-28 16:59:10 +00001543/// OldStart:
Eric Christopher4237bf12014-04-29 00:16:33 +00001544/// ...
Yiannis Tsiourisd4842e52013-02-28 16:59:10 +00001545/// IncStack:
Eric Christopher4237bf12014-04-29 00:16:33 +00001546/// call inc_stack # doubles the stack space
1547/// temp0 = sp - MaxStack
1548/// if( temp0 < SP_LIMIT(P) ) goto IncStack else goto OldStart
Benjamin Kramer53bc37c2013-02-18 20:55:12 +00001549void X86FrameLowering::adjustForHiPEPrologue(MachineFunction &MF) const {
Eric Christopherfc6de422014-08-05 02:39:49 +00001550 const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
Benjamin Kramer53bc37c2013-02-18 20:55:12 +00001551 MachineFrameInfo *MFI = MF.getFrameInfo();
Eric Christopher11b05cc2014-06-05 00:09:05 +00001552 const unsigned SlotSize =
Eric Christopherfc6de422014-08-05 02:39:49 +00001553 static_cast<const X86RegisterInfo *>(MF.getSubtarget().getRegisterInfo())
1554 ->getSlotSize();
Eric Christopherf4381642014-06-05 22:00:31 +00001555 const X86Subtarget &STI = MF.getTarget().getSubtarget<X86Subtarget>();
Benjamin Kramer53bc37c2013-02-18 20:55:12 +00001556 const bool Is64Bit = STI.is64Bit();
1557 DebugLoc DL;
1558 // HiPE-specific values
1559 const unsigned HipeLeafWords = 24;
1560 const unsigned CCRegisteredArgs = Is64Bit ? 6 : 5;
1561 const unsigned Guaranteed = HipeLeafWords * SlotSize;
Benjamin Kramer1cb826b2013-02-19 17:32:57 +00001562 unsigned CallerStkArity = MF.getFunction()->arg_size() > CCRegisteredArgs ?
1563 MF.getFunction()->arg_size() - CCRegisteredArgs : 0;
1564 unsigned MaxStack = MFI->getStackSize() + CallerStkArity*SlotSize + SlotSize;
Benjamin Kramer53bc37c2013-02-18 20:55:12 +00001565
Benjamin Kramer1cb826b2013-02-19 17:32:57 +00001566 assert(STI.isTargetLinux() &&
Benjamin Kramer53bc37c2013-02-18 20:55:12 +00001567 "HiPE prologue is only supported on Linux operating systems.");
1568
1569 // Compute the largest caller's frame that is needed to fit the callees'
1570 // frames. This 'MaxStack' is computed from:
1571 //
1572 // a) the fixed frame size, which is the space needed for all spilled temps,
1573 // b) outgoing on-stack parameter areas, and
1574 // c) the minimum stack space this function needs to make available for the
1575 // functions it calls (a tunable ABI property).
1576 if (MFI->hasCalls()) {
1577 unsigned MoreStackForCalls = 0;
1578
1579 for (MachineFunction::iterator MBBI = MF.begin(), MBBE = MF.end();
1580 MBBI != MBBE; ++MBBI)
1581 for (MachineBasicBlock::iterator MI = MBBI->begin(), ME = MBBI->end();
Benjamin Kramer1cb826b2013-02-19 17:32:57 +00001582 MI != ME; ++MI) {
1583 if (!MI->isCall())
1584 continue;
Benjamin Kramer53bc37c2013-02-18 20:55:12 +00001585
Benjamin Kramer1cb826b2013-02-19 17:32:57 +00001586 // Get callee operand.
1587 const MachineOperand &MO = MI->getOperand(0);
Benjamin Kramer53bc37c2013-02-18 20:55:12 +00001588
Benjamin Kramer1cb826b2013-02-19 17:32:57 +00001589 // Only take account of global function calls (no closures etc.).
1590 if (!MO.isGlobal())
1591 continue;
Benjamin Kramer53bc37c2013-02-18 20:55:12 +00001592
Benjamin Kramer1cb826b2013-02-19 17:32:57 +00001593 const Function *F = dyn_cast<Function>(MO.getGlobal());
1594 if (!F)
1595 continue;
1596
1597 // Do not update 'MaxStack' for primitive and built-in functions
1598 // (encoded with names either starting with "erlang."/"bif_" or not
1599 // having a ".", such as a simple <Module>.<Function>.<Arity>, or an
1600 // "_", such as the BIF "suspend_0") as they are executed on another
1601 // stack.
1602 if (F->getName().find("erlang.") != StringRef::npos ||
1603 F->getName().find("bif_") != StringRef::npos ||
1604 F->getName().find_first_of("._") == StringRef::npos)
1605 continue;
1606
1607 unsigned CalleeStkArity =
1608 F->arg_size() > CCRegisteredArgs ? F->arg_size()-CCRegisteredArgs : 0;
1609 if (HipeLeafWords - 1 > CalleeStkArity)
1610 MoreStackForCalls = std::max(MoreStackForCalls,
1611 (HipeLeafWords - 1 - CalleeStkArity) * SlotSize);
1612 }
Benjamin Kramer53bc37c2013-02-18 20:55:12 +00001613 MaxStack += MoreStackForCalls;
1614 }
1615
1616 // If the stack frame needed is larger than the guaranteed then runtime checks
1617 // and calls to "inc_stack_0" BIF should be inserted in the assembly prologue.
1618 if (MaxStack > Guaranteed) {
1619 MachineBasicBlock &prologueMBB = MF.front();
1620 MachineBasicBlock *stackCheckMBB = MF.CreateMachineBasicBlock();
1621 MachineBasicBlock *incStackMBB = MF.CreateMachineBasicBlock();
1622
1623 for (MachineBasicBlock::livein_iterator I = prologueMBB.livein_begin(),
1624 E = prologueMBB.livein_end(); I != E; I++) {
1625 stackCheckMBB->addLiveIn(*I);
1626 incStackMBB->addLiveIn(*I);
1627 }
1628
1629 MF.push_front(incStackMBB);
1630 MF.push_front(stackCheckMBB);
1631
1632 unsigned ScratchReg, SPReg, PReg, SPLimitOffset;
1633 unsigned LEAop, CMPop, CALLop;
1634 if (Is64Bit) {
1635 SPReg = X86::RSP;
1636 PReg = X86::RBP;
1637 LEAop = X86::LEA64r;
1638 CMPop = X86::CMP64rm;
1639 CALLop = X86::CALL64pcrel32;
1640 SPLimitOffset = 0x90;
1641 } else {
1642 SPReg = X86::ESP;
1643 PReg = X86::EBP;
1644 LEAop = X86::LEA32r;
1645 CMPop = X86::CMP32rm;
1646 CALLop = X86::CALLpcrel32;
1647 SPLimitOffset = 0x4c;
1648 }
1649
1650 ScratchReg = GetScratchRegister(Is64Bit, MF, true);
1651 assert(!MF.getRegInfo().isLiveIn(ScratchReg) &&
1652 "HiPE prologue scratch register is live-in");
1653
1654 // Create new MBB for StackCheck:
1655 addRegOffset(BuildMI(stackCheckMBB, DL, TII.get(LEAop), ScratchReg),
1656 SPReg, false, -MaxStack);
1657 // SPLimitOffset is in a fixed heap location (pointed by BP).
1658 addRegOffset(BuildMI(stackCheckMBB, DL, TII.get(CMPop))
1659 .addReg(ScratchReg), PReg, false, SPLimitOffset);
1660 BuildMI(stackCheckMBB, DL, TII.get(X86::JAE_4)).addMBB(&prologueMBB);
1661
1662 // Create new MBB for IncStack:
1663 BuildMI(incStackMBB, DL, TII.get(CALLop)).
1664 addExternalSymbol("inc_stack_0");
1665 addRegOffset(BuildMI(incStackMBB, DL, TII.get(LEAop), ScratchReg),
1666 SPReg, false, -MaxStack);
1667 addRegOffset(BuildMI(incStackMBB, DL, TII.get(CMPop))
1668 .addReg(ScratchReg), PReg, false, SPLimitOffset);
1669 BuildMI(incStackMBB, DL, TII.get(X86::JLE_4)).addMBB(incStackMBB);
1670
1671 stackCheckMBB->addSuccessor(&prologueMBB, 99);
1672 stackCheckMBB->addSuccessor(incStackMBB, 1);
1673 incStackMBB->addSuccessor(&prologueMBB, 99);
1674 incStackMBB->addSuccessor(incStackMBB, 1);
1675 }
1676#ifdef XDEBUG
1677 MF.verify();
1678#endif
1679}
Eli Bendersky8da87162013-02-21 20:05:00 +00001680
1681void X86FrameLowering::
1682eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
1683 MachineBasicBlock::iterator I) const {
Eric Christopherfc6de422014-08-05 02:39:49 +00001684 const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
1685 const X86RegisterInfo &RegInfo = *static_cast<const X86RegisterInfo *>(
1686 MF.getSubtarget().getRegisterInfo());
Eli Bendersky8da87162013-02-21 20:05:00 +00001687 unsigned StackPtr = RegInfo.getStackRegister();
1688 bool reseveCallFrame = hasReservedCallFrame(MF);
1689 int Opcode = I->getOpcode();
1690 bool isDestroy = Opcode == TII.getCallFrameDestroyOpcode();
Eric Christopherf4381642014-06-05 22:00:31 +00001691 const X86Subtarget &STI = MF.getTarget().getSubtarget<X86Subtarget>();
Eli Bendersky8da87162013-02-21 20:05:00 +00001692 bool IsLP64 = STI.isTarget64BitLP64();
1693 DebugLoc DL = I->getDebugLoc();
1694 uint64_t Amount = !reseveCallFrame ? I->getOperand(0).getImm() : 0;
1695 uint64_t CalleeAmt = isDestroy ? I->getOperand(1).getImm() : 0;
1696 I = MBB.erase(I);
1697
1698 if (!reseveCallFrame) {
1699 // If the stack pointer can be changed after prologue, turn the
1700 // adjcallstackup instruction into a 'sub ESP, <amt>' and the
1701 // adjcallstackdown instruction into 'add ESP, <amt>'
1702 // TODO: consider using push / pop instead of sub + store / add
1703 if (Amount == 0)
1704 return;
1705
1706 // We need to keep the stack aligned properly. To do this, we round the
1707 // amount of space needed for the outgoing arguments up to the next
1708 // alignment boundary.
Eric Christopherd9134482014-08-04 21:25:23 +00001709 unsigned StackAlign = MF.getTarget()
1710 .getSubtargetImpl()
1711 ->getFrameLowering()
1712 ->getStackAlignment();
Eli Bendersky8da87162013-02-21 20:05:00 +00001713 Amount = (Amount + StackAlign - 1) / StackAlign * StackAlign;
1714
Craig Topper062a2ba2014-04-25 05:30:21 +00001715 MachineInstr *New = nullptr;
Eli Bendersky8da87162013-02-21 20:05:00 +00001716 if (Opcode == TII.getCallFrameSetupOpcode()) {
1717 New = BuildMI(MF, DL, TII.get(getSUBriOpcode(IsLP64, Amount)),
1718 StackPtr)
1719 .addReg(StackPtr)
1720 .addImm(Amount);
1721 } else {
1722 assert(Opcode == TII.getCallFrameDestroyOpcode());
1723
1724 // Factor out the amount the callee already popped.
1725 Amount -= CalleeAmt;
1726
1727 if (Amount) {
1728 unsigned Opc = getADDriOpcode(IsLP64, Amount);
1729 New = BuildMI(MF, DL, TII.get(Opc), StackPtr)
1730 .addReg(StackPtr).addImm(Amount);
1731 }
1732 }
1733
1734 if (New) {
1735 // The EFLAGS implicit def is dead.
1736 New->getOperand(3).setIsDead();
1737
1738 // Replace the pseudo instruction with a new instruction.
1739 MBB.insert(I, New);
1740 }
1741
1742 return;
1743 }
1744
1745 if (Opcode == TII.getCallFrameDestroyOpcode() && CalleeAmt) {
1746 // If we are performing frame pointer elimination and if the callee pops
1747 // something off the stack pointer, add it back. We do this until we have
1748 // more advanced stack pointer tracking ability.
1749 unsigned Opc = getSUBriOpcode(IsLP64, CalleeAmt);
1750 MachineInstr *New = BuildMI(MF, DL, TII.get(Opc), StackPtr)
1751 .addReg(StackPtr).addImm(CalleeAmt);
1752
1753 // The EFLAGS implicit def is dead.
1754 New->getOperand(3).setIsDead();
1755
1756 // We are not tracking the stack pointer adjustment by the callee, so make
1757 // sure we restore the stack pointer immediately after the call, there may
1758 // be spill code inserted between the CALL and ADJCALLSTACKUP instructions.
1759 MachineBasicBlock::iterator B = MBB.begin();
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +00001760 while (I != B && !std::prev(I)->isCall())
Eli Bendersky8da87162013-02-21 20:05:00 +00001761 --I;
1762 MBB.insert(I, New);
1763 }
1764}
1765