blob: 16e1e42c501dbcc1298877b1dda121cb3a6d2e24 [file] [log] [blame]
Jia Liu31d157a2012-02-18 12:03:15 +00001//===-- X86FrameLowering.cpp - X86 Frame Information ----------------------===//
Anton Korobeynikov33464912010-11-15 00:06:54 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
Anton Korobeynikov16c29b52011-01-10 12:39:04 +000010// This file contains the X86 implementation of TargetFrameLowering class.
Anton Korobeynikov33464912010-11-15 00:06:54 +000011//
12//===----------------------------------------------------------------------===//
13
Anton Korobeynikov16c29b52011-01-10 12:39:04 +000014#include "X86FrameLowering.h"
Anton Korobeynikov33464912010-11-15 00:06:54 +000015#include "X86InstrBuilder.h"
16#include "X86InstrInfo.h"
17#include "X86MachineFunctionInfo.h"
Rafael Espindola76927d752011-08-30 19:39:58 +000018#include "X86Subtarget.h"
Anton Korobeynikovd9e33852010-11-18 23:25:52 +000019#include "X86TargetMachine.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000020#include "llvm/ADT/SmallSet.h"
Anton Korobeynikov33464912010-11-15 00:06:54 +000021#include "llvm/CodeGen/MachineFrameInfo.h"
22#include "llvm/CodeGen/MachineFunction.h"
23#include "llvm/CodeGen/MachineInstrBuilder.h"
24#include "llvm/CodeGen/MachineModuleInfo.h"
25#include "llvm/CodeGen/MachineRegisterInfo.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000026#include "llvm/IR/DataLayout.h"
27#include "llvm/IR/Function.h"
Rafael Espindolaf0adba92011-04-15 15:11:06 +000028#include "llvm/MC/MCAsmInfo.h"
Bill Wendling6a6b8c32011-07-07 00:54:13 +000029#include "llvm/MC/MCSymbol.h"
Anton Korobeynikov33464912010-11-15 00:06:54 +000030#include "llvm/Support/CommandLine.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000031#include "llvm/Target/TargetOptions.h"
Anton Korobeynikov33464912010-11-15 00:06:54 +000032
33using namespace llvm;
34
35// FIXME: completely move here.
36extern cl::opt<bool> ForceStackAlign;
37
Anton Korobeynikov16c29b52011-01-10 12:39:04 +000038bool X86FrameLowering::hasReservedCallFrame(const MachineFunction &MF) const {
Anton Korobeynikovd0c38172010-11-18 21:19:35 +000039 return !MF.getFrameInfo()->hasVarSizedObjects();
40}
41
42/// hasFP - Return true if the specified function should have a dedicated frame
43/// pointer register. This is true if the function has variable sized allocas
44/// or if frame pointer elimination is disabled.
Anton Korobeynikov16c29b52011-01-10 12:39:04 +000045bool X86FrameLowering::hasFP(const MachineFunction &MF) const {
Anton Korobeynikovd0c38172010-11-18 21:19:35 +000046 const MachineFrameInfo *MFI = MF.getFrameInfo();
47 const MachineModuleInfo &MMI = MF.getMMI();
Chad Rosier3fb6eca2012-05-23 23:45:10 +000048 const TargetRegisterInfo *RegInfo = TM.getRegisterInfo();
Anton Korobeynikovd0c38172010-11-18 21:19:35 +000049
Nick Lewycky8a8d4792011-12-02 22:16:29 +000050 return (MF.getTarget().Options.DisableFramePointerElim(MF) ||
Chad Rosier3fb6eca2012-05-23 23:45:10 +000051 RegInfo->needsStackRealignment(MF) ||
Anton Korobeynikovd0c38172010-11-18 21:19:35 +000052 MFI->hasVarSizedObjects() ||
Chad Rosierb5660622013-02-16 01:25:28 +000053 MFI->isFrameAddressTaken() || MF.hasMSInlineAsm() ||
Anton Korobeynikovd0c38172010-11-18 21:19:35 +000054 MF.getInfo<X86MachineFunctionInfo>()->getForceFramePointer() ||
Jakob Stoklund Olesene208c492012-06-22 03:04:27 +000055 MMI.callsUnwindInit() || MMI.callsEHReturn());
Anton Korobeynikovd0c38172010-11-18 21:19:35 +000056}
57
Eli Bendersky700ed802013-02-21 20:05:00 +000058static unsigned getSUBriOpcode(unsigned IsLP64, int64_t Imm) {
59 if (IsLP64) {
Anton Korobeynikov33464912010-11-15 00:06:54 +000060 if (isInt<8>(Imm))
61 return X86::SUB64ri8;
62 return X86::SUB64ri32;
63 } else {
64 if (isInt<8>(Imm))
65 return X86::SUB32ri8;
66 return X86::SUB32ri;
67 }
68}
69
Eli Bendersky16221a62013-02-06 20:43:57 +000070static unsigned getADDriOpcode(unsigned IsLP64, int64_t Imm) {
71 if (IsLP64) {
Anton Korobeynikov33464912010-11-15 00:06:54 +000072 if (isInt<8>(Imm))
73 return X86::ADD64ri8;
74 return X86::ADD64ri32;
75 } else {
76 if (isInt<8>(Imm))
77 return X86::ADD32ri8;
78 return X86::ADD32ri;
79 }
80}
81
Eli Bendersky16221a62013-02-06 20:43:57 +000082static unsigned getLEArOpcode(unsigned IsLP64) {
83 return IsLP64 ? X86::LEA64r : X86::LEA32r;
Evan Chengde1df102012-02-07 22:50:41 +000084}
85
Evan Cheng7158e082011-01-03 22:53:22 +000086/// findDeadCallerSavedReg - Return a caller-saved register that isn't live
87/// when it reaches the "return" instruction. We can then pop a stack object
88/// to this register without worry about clobbering it.
89static unsigned findDeadCallerSavedReg(MachineBasicBlock &MBB,
90 MachineBasicBlock::iterator &MBBI,
91 const TargetRegisterInfo &TRI,
92 bool Is64Bit) {
93 const MachineFunction *MF = MBB.getParent();
94 const Function *F = MF->getFunction();
95 if (!F || MF->getMMI().callsEHReturn())
96 return 0;
97
Craig Toppere4fd9072012-03-04 10:43:23 +000098 static const uint16_t CallerSavedRegs32Bit[] = {
Andrew Trick32a183c2011-08-12 00:49:19 +000099 X86::EAX, X86::EDX, X86::ECX, 0
Evan Cheng7158e082011-01-03 22:53:22 +0000100 };
101
Craig Toppere4fd9072012-03-04 10:43:23 +0000102 static const uint16_t CallerSavedRegs64Bit[] = {
Evan Cheng7158e082011-01-03 22:53:22 +0000103 X86::RAX, X86::RDX, X86::RCX, X86::RSI, X86::RDI,
Andrew Trick32a183c2011-08-12 00:49:19 +0000104 X86::R8, X86::R9, X86::R10, X86::R11, 0
Evan Cheng7158e082011-01-03 22:53:22 +0000105 };
106
107 unsigned Opc = MBBI->getOpcode();
108 switch (Opc) {
109 default: return 0;
110 case X86::RET:
111 case X86::RETI:
112 case X86::TCRETURNdi:
113 case X86::TCRETURNri:
114 case X86::TCRETURNmi:
115 case X86::TCRETURNdi64:
116 case X86::TCRETURNri64:
117 case X86::TCRETURNmi64:
118 case X86::EH_RETURN:
119 case X86::EH_RETURN64: {
Craig Toppere4fd9072012-03-04 10:43:23 +0000120 SmallSet<uint16_t, 8> Uses;
Evan Cheng7158e082011-01-03 22:53:22 +0000121 for (unsigned i = 0, e = MBBI->getNumOperands(); i != e; ++i) {
122 MachineOperand &MO = MBBI->getOperand(i);
123 if (!MO.isReg() || MO.isDef())
124 continue;
125 unsigned Reg = MO.getReg();
126 if (!Reg)
127 continue;
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +0000128 for (MCRegAliasIterator AI(Reg, &TRI, true); AI.isValid(); ++AI)
129 Uses.insert(*AI);
Evan Cheng7158e082011-01-03 22:53:22 +0000130 }
131
Craig Toppere4fd9072012-03-04 10:43:23 +0000132 const uint16_t *CS = Is64Bit ? CallerSavedRegs64Bit : CallerSavedRegs32Bit;
Evan Cheng7158e082011-01-03 22:53:22 +0000133 for (; *CS; ++CS)
134 if (!Uses.count(*CS))
135 return *CS;
136 }
137 }
138
139 return 0;
140}
141
142
Anton Korobeynikov33464912010-11-15 00:06:54 +0000143/// emitSPUpdate - Emit a series of instructions to increment / decrement the
144/// stack pointer by a constant value.
145static
146void emitSPUpdate(MachineBasicBlock &MBB, MachineBasicBlock::iterator &MBBI,
Evan Cheng7158e082011-01-03 22:53:22 +0000147 unsigned StackPtr, int64_t NumBytes,
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000148 bool Is64Bit, bool IsLP64, bool UseLEA,
Eric Christopher76ad43c2012-10-03 08:10:01 +0000149 const TargetInstrInfo &TII, const TargetRegisterInfo &TRI) {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000150 bool isSub = NumBytes < 0;
151 uint64_t Offset = isSub ? -NumBytes : NumBytes;
Evan Chengde1df102012-02-07 22:50:41 +0000152 unsigned Opc;
153 if (UseLEA)
Eli Bendersky16221a62013-02-06 20:43:57 +0000154 Opc = getLEArOpcode(IsLP64);
Evan Chengde1df102012-02-07 22:50:41 +0000155 else
156 Opc = isSub
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000157 ? getSUBriOpcode(IsLP64, Offset)
158 : getADDriOpcode(IsLP64, Offset);
Evan Chengde1df102012-02-07 22:50:41 +0000159
Anton Korobeynikov33464912010-11-15 00:06:54 +0000160 uint64_t Chunk = (1LL << 31) - 1;
Eric Christopher76ad43c2012-10-03 08:10:01 +0000161 DebugLoc DL = MBB.findDebugLoc(MBBI);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000162
163 while (Offset) {
164 uint64_t ThisVal = (Offset > Chunk) ? Chunk : Offset;
Evan Cheng7158e082011-01-03 22:53:22 +0000165 if (ThisVal == (Is64Bit ? 8 : 4)) {
166 // Use push / pop instead.
167 unsigned Reg = isSub
Dale Johannesen1e08cd12011-01-04 19:31:24 +0000168 ? (unsigned)(Is64Bit ? X86::RAX : X86::EAX)
Evan Cheng7158e082011-01-03 22:53:22 +0000169 : findDeadCallerSavedReg(MBB, MBBI, TRI, Is64Bit);
170 if (Reg) {
171 Opc = isSub
172 ? (Is64Bit ? X86::PUSH64r : X86::PUSH32r)
173 : (Is64Bit ? X86::POP64r : X86::POP32r);
Charles Davisaff232a2011-06-12 01:45:54 +0000174 MachineInstr *MI = BuildMI(MBB, MBBI, DL, TII.get(Opc))
Evan Cheng7158e082011-01-03 22:53:22 +0000175 .addReg(Reg, getDefRegState(!isSub) | getUndefRegState(isSub));
Charles Davisaff232a2011-06-12 01:45:54 +0000176 if (isSub)
177 MI->setFlag(MachineInstr::FrameSetup);
Evan Cheng7158e082011-01-03 22:53:22 +0000178 Offset -= ThisVal;
179 continue;
180 }
181 }
182
Evan Chengde1df102012-02-07 22:50:41 +0000183 MachineInstr *MI = NULL;
184
185 if (UseLEA) {
186 MI = addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr),
187 StackPtr, false, isSub ? -ThisVal : ThisVal);
188 } else {
189 MI = BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr)
190 .addReg(StackPtr)
191 .addImm(ThisVal);
192 MI->getOperand(3).setIsDead(); // The EFLAGS implicit def is dead.
193 }
194
Charles Davisaff232a2011-06-12 01:45:54 +0000195 if (isSub)
196 MI->setFlag(MachineInstr::FrameSetup);
Evan Chengde1df102012-02-07 22:50:41 +0000197
Anton Korobeynikov33464912010-11-15 00:06:54 +0000198 Offset -= ThisVal;
199 }
200}
201
202/// mergeSPUpdatesUp - Merge two stack-manipulating instructions upper iterator.
203static
204void mergeSPUpdatesUp(MachineBasicBlock &MBB, MachineBasicBlock::iterator &MBBI,
205 unsigned StackPtr, uint64_t *NumBytes = NULL) {
206 if (MBBI == MBB.begin()) return;
207
208 MachineBasicBlock::iterator PI = prior(MBBI);
209 unsigned Opc = PI->getOpcode();
210 if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
Evan Chengde1df102012-02-07 22:50:41 +0000211 Opc == X86::ADD32ri || Opc == X86::ADD32ri8 ||
212 Opc == X86::LEA32r || Opc == X86::LEA64_32r) &&
Anton Korobeynikov33464912010-11-15 00:06:54 +0000213 PI->getOperand(0).getReg() == StackPtr) {
214 if (NumBytes)
215 *NumBytes += PI->getOperand(2).getImm();
216 MBB.erase(PI);
217 } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
218 Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
219 PI->getOperand(0).getReg() == StackPtr) {
220 if (NumBytes)
221 *NumBytes -= PI->getOperand(2).getImm();
222 MBB.erase(PI);
223 }
224}
225
226/// mergeSPUpdatesDown - Merge two stack-manipulating instructions lower iterator.
227static
228void mergeSPUpdatesDown(MachineBasicBlock &MBB,
229 MachineBasicBlock::iterator &MBBI,
230 unsigned StackPtr, uint64_t *NumBytes = NULL) {
Sanjoy Dasfc926122011-12-01 19:15:08 +0000231 // FIXME: THIS ISN'T RUN!!!
Anton Korobeynikov33464912010-11-15 00:06:54 +0000232 return;
233
234 if (MBBI == MBB.end()) return;
235
236 MachineBasicBlock::iterator NI = llvm::next(MBBI);
237 if (NI == MBB.end()) return;
238
239 unsigned Opc = NI->getOpcode();
240 if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
241 Opc == X86::ADD32ri || Opc == X86::ADD32ri8) &&
242 NI->getOperand(0).getReg() == StackPtr) {
243 if (NumBytes)
244 *NumBytes -= NI->getOperand(2).getImm();
245 MBB.erase(NI);
246 MBBI = NI;
247 } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
248 Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
249 NI->getOperand(0).getReg() == StackPtr) {
250 if (NumBytes)
251 *NumBytes += NI->getOperand(2).getImm();
252 MBB.erase(NI);
253 MBBI = NI;
254 }
255}
256
257/// mergeSPUpdates - Checks the instruction before/after the passed
Evan Chengde1df102012-02-07 22:50:41 +0000258/// instruction. If it is an ADD/SUB/LEA instruction it is deleted argument and the
259/// stack adjustment is returned as a positive value for ADD/LEA and a negative for
Anton Korobeynikov33464912010-11-15 00:06:54 +0000260/// SUB.
261static int mergeSPUpdates(MachineBasicBlock &MBB,
262 MachineBasicBlock::iterator &MBBI,
263 unsigned StackPtr,
264 bool doMergeWithPrevious) {
265 if ((doMergeWithPrevious && MBBI == MBB.begin()) ||
266 (!doMergeWithPrevious && MBBI == MBB.end()))
267 return 0;
268
269 MachineBasicBlock::iterator PI = doMergeWithPrevious ? prior(MBBI) : MBBI;
270 MachineBasicBlock::iterator NI = doMergeWithPrevious ? 0 : llvm::next(MBBI);
271 unsigned Opc = PI->getOpcode();
272 int Offset = 0;
273
274 if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
Evan Chengde1df102012-02-07 22:50:41 +0000275 Opc == X86::ADD32ri || Opc == X86::ADD32ri8 ||
276 Opc == X86::LEA32r || Opc == X86::LEA64_32r) &&
Anton Korobeynikov33464912010-11-15 00:06:54 +0000277 PI->getOperand(0).getReg() == StackPtr){
278 Offset += PI->getOperand(2).getImm();
279 MBB.erase(PI);
280 if (!doMergeWithPrevious) MBBI = NI;
281 } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
282 Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
283 PI->getOperand(0).getReg() == StackPtr) {
284 Offset -= PI->getOperand(2).getImm();
285 MBB.erase(PI);
286 if (!doMergeWithPrevious) MBBI = NI;
287 }
288
289 return Offset;
290}
291
292static bool isEAXLiveIn(MachineFunction &MF) {
293 for (MachineRegisterInfo::livein_iterator II = MF.getRegInfo().livein_begin(),
294 EE = MF.getRegInfo().livein_end(); II != EE; ++II) {
295 unsigned Reg = II->first;
296
297 if (Reg == X86::EAX || Reg == X86::AX ||
298 Reg == X86::AH || Reg == X86::AL)
299 return true;
300 }
301
302 return false;
303}
304
Anton Korobeynikov16c29b52011-01-10 12:39:04 +0000305void X86FrameLowering::emitCalleeSavedFrameMoves(MachineFunction &MF,
Bill Wendling09b02c82011-07-25 18:00:28 +0000306 MCSymbol *Label,
307 unsigned FramePtr) const {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000308 MachineFrameInfo *MFI = MF.getFrameInfo();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000309 MachineModuleInfo &MMI = MF.getMMI();
310
311 // Add callee saved registers to move list.
312 const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
313 if (CSI.empty()) return;
314
315 std::vector<MachineMove> &Moves = MMI.getFrameMoves();
Michael Liaoaa3c2c02012-10-25 06:29:14 +0000316 const X86RegisterInfo *RegInfo = TM.getRegisterInfo();
Anton Korobeynikovd0c38172010-11-18 21:19:35 +0000317 bool HasFP = hasFP(MF);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000318
319 // Calculate amount of bytes used for return address storing.
Michael Liaoaa3c2c02012-10-25 06:29:14 +0000320 int stackGrowth = -RegInfo->getSlotSize();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000321
322 // FIXME: This is dirty hack. The code itself is pretty mess right now.
323 // It should be rewritten from scratch and generalized sometimes.
324
Chris Lattner7a2bdde2011-04-15 05:18:47 +0000325 // Determine maximum offset (minimum due to stack growth).
Anton Korobeynikov33464912010-11-15 00:06:54 +0000326 int64_t MaxOffset = 0;
327 for (std::vector<CalleeSavedInfo>::const_iterator
328 I = CSI.begin(), E = CSI.end(); I != E; ++I)
329 MaxOffset = std::min(MaxOffset,
330 MFI->getObjectOffset(I->getFrameIdx()));
331
332 // Calculate offsets.
333 int64_t saveAreaOffset = (HasFP ? 3 : 2) * stackGrowth;
334 for (std::vector<CalleeSavedInfo>::const_iterator
335 I = CSI.begin(), E = CSI.end(); I != E; ++I) {
336 int64_t Offset = MFI->getObjectOffset(I->getFrameIdx());
337 unsigned Reg = I->getReg();
338 Offset = MaxOffset - Offset + saveAreaOffset;
339
340 // Don't output a new machine move if we're re-saving the frame
341 // pointer. This happens when the PrologEpilogInserter has inserted an extra
342 // "PUSH" of the frame pointer -- the "emitPrologue" method automatically
343 // generates one when frame pointers are used. If we generate a "machine
344 // move" for this extra "PUSH", the linker will lose track of the fact that
345 // the frame pointer should have the value of the first "PUSH" when it's
346 // trying to unwind.
NAKAMURA Takumi27635382011-02-05 15:10:54 +0000347 //
Anton Korobeynikov33464912010-11-15 00:06:54 +0000348 // FIXME: This looks inelegant. It's possibly correct, but it's covering up
349 // another bug. I.e., one where we generate a prolog like this:
350 //
351 // pushl %ebp
352 // movl %esp, %ebp
353 // pushl %ebp
354 // pushl %esi
355 // ...
356 //
357 // The immediate re-push of EBP is unnecessary. At the least, it's an
358 // optimization bug. EBP can be used as a scratch register in certain
359 // cases, but probably not when we have a frame pointer.
360 if (HasFP && FramePtr == Reg)
361 continue;
362
363 MachineLocation CSDst(MachineLocation::VirtualFP, Offset);
364 MachineLocation CSSrc(Reg);
365 Moves.push_back(MachineMove(Label, CSDst, CSSrc));
366 }
367}
368
Bill Wendling09b02c82011-07-25 18:00:28 +0000369/// getCompactUnwindRegNum - Get the compact unwind number for a given
370/// register. The number corresponds to the enum lists in
371/// compact_unwind_encoding.h.
Craig Topper53146a22012-05-24 05:55:47 +0000372static int getCompactUnwindRegNum(const uint16_t *CURegs, unsigned Reg) {
Bill Wendling10e412e2011-12-14 23:53:24 +0000373 for (int Idx = 1; *CURegs; ++CURegs, ++Idx)
Bill Wendling09b02c82011-07-25 18:00:28 +0000374 if (*CURegs == Reg)
375 return Idx;
376
377 return -1;
378}
379
Bill Wendling57a3cd22011-12-06 21:23:42 +0000380// Number of registers that can be saved in a compact unwind encoding.
381#define CU_NUM_SAVED_REGS 6
382
Bill Wendling09b02c82011-07-25 18:00:28 +0000383/// encodeCompactUnwindRegistersWithoutFrame - Create the permutation encoding
384/// used with frameless stacks. It is passed the number of registers to be saved
385/// and an array of the registers saved.
Bill Wendling57a3cd22011-12-06 21:23:42 +0000386static uint32_t
387encodeCompactUnwindRegistersWithoutFrame(unsigned SavedRegs[CU_NUM_SAVED_REGS],
388 unsigned RegCount, bool Is64Bit) {
Bill Wendling09b02c82011-07-25 18:00:28 +0000389 // The saved registers are numbered from 1 to 6. In order to encode the order
390 // in which they were saved, we re-number them according to their place in the
391 // register order. The re-numbering is relative to the last re-numbered
392 // register. E.g., if we have registers {6, 2, 4, 5} saved in that order:
393 //
394 // Orig Re-Num
395 // ---- ------
396 // 6 6
397 // 2 2
398 // 4 3
399 // 5 3
400 //
Craig Topper53146a22012-05-24 05:55:47 +0000401 static const uint16_t CU32BitRegs[] = {
Bill Wendling09b02c82011-07-25 18:00:28 +0000402 X86::EBX, X86::ECX, X86::EDX, X86::EDI, X86::ESI, X86::EBP, 0
403 };
Craig Topper53146a22012-05-24 05:55:47 +0000404 static const uint16_t CU64BitRegs[] = {
Bill Wendling09b02c82011-07-25 18:00:28 +0000405 X86::RBX, X86::R12, X86::R13, X86::R14, X86::R15, X86::RBP, 0
406 };
Craig Topper53146a22012-05-24 05:55:47 +0000407 const uint16_t *CURegs = (Is64Bit ? CU64BitRegs : CU32BitRegs);
Bill Wendling09b02c82011-07-25 18:00:28 +0000408
Bill Wendling10e412e2011-12-14 23:53:24 +0000409 for (unsigned i = 0; i != CU_NUM_SAVED_REGS; ++i) {
Bill Wendling09b02c82011-07-25 18:00:28 +0000410 int CUReg = getCompactUnwindRegNum(CURegs, SavedRegs[i]);
411 if (CUReg == -1) return ~0U;
412 SavedRegs[i] = CUReg;
Bill Wendling79df9862011-12-06 01:26:14 +0000413 }
Bill Wendling09b02c82011-07-25 18:00:28 +0000414
Bill Wendling10e412e2011-12-14 23:53:24 +0000415 // Reverse the list.
416 std::swap(SavedRegs[0], SavedRegs[5]);
417 std::swap(SavedRegs[1], SavedRegs[4]);
418 std::swap(SavedRegs[2], SavedRegs[3]);
419
Bill Wendling57a3cd22011-12-06 21:23:42 +0000420 uint32_t RenumRegs[CU_NUM_SAVED_REGS];
421 for (unsigned i = CU_NUM_SAVED_REGS - RegCount; i < CU_NUM_SAVED_REGS; ++i) {
Bill Wendling09b02c82011-07-25 18:00:28 +0000422 unsigned Countless = 0;
Bill Wendling57a3cd22011-12-06 21:23:42 +0000423 for (unsigned j = CU_NUM_SAVED_REGS - RegCount; j < i; ++j)
Bill Wendling09b02c82011-07-25 18:00:28 +0000424 if (SavedRegs[j] < SavedRegs[i])
425 ++Countless;
426
427 RenumRegs[i] = SavedRegs[i] - Countless - 1;
428 }
429
430 // Take the renumbered values and encode them into a 10-bit number.
431 uint32_t permutationEncoding = 0;
432 switch (RegCount) {
433 case 6:
434 permutationEncoding |= 120 * RenumRegs[0] + 24 * RenumRegs[1]
435 + 6 * RenumRegs[2] + 2 * RenumRegs[3]
436 + RenumRegs[4];
437 break;
438 case 5:
439 permutationEncoding |= 120 * RenumRegs[1] + 24 * RenumRegs[2]
440 + 6 * RenumRegs[3] + 2 * RenumRegs[4]
441 + RenumRegs[5];
442 break;
443 case 4:
444 permutationEncoding |= 60 * RenumRegs[2] + 12 * RenumRegs[3]
445 + 3 * RenumRegs[4] + RenumRegs[5];
446 break;
447 case 3:
448 permutationEncoding |= 20 * RenumRegs[3] + 4 * RenumRegs[4]
449 + RenumRegs[5];
450 break;
451 case 2:
452 permutationEncoding |= 5 * RenumRegs[4] + RenumRegs[5];
453 break;
454 case 1:
455 permutationEncoding |= RenumRegs[5];
456 break;
457 }
458
459 assert((permutationEncoding & 0x3FF) == permutationEncoding &&
460 "Invalid compact register encoding!");
461 return permutationEncoding;
462}
463
464/// encodeCompactUnwindRegistersWithFrame - Return the registers encoded for a
465/// compact encoding with a frame pointer.
Bill Wendling57a3cd22011-12-06 21:23:42 +0000466static uint32_t
467encodeCompactUnwindRegistersWithFrame(unsigned SavedRegs[CU_NUM_SAVED_REGS],
468 bool Is64Bit) {
Craig Topper53146a22012-05-24 05:55:47 +0000469 static const uint16_t CU32BitRegs[] = {
Bill Wendling09b02c82011-07-25 18:00:28 +0000470 X86::EBX, X86::ECX, X86::EDX, X86::EDI, X86::ESI, X86::EBP, 0
471 };
Craig Topper53146a22012-05-24 05:55:47 +0000472 static const uint16_t CU64BitRegs[] = {
Bill Wendling09b02c82011-07-25 18:00:28 +0000473 X86::RBX, X86::R12, X86::R13, X86::R14, X86::R15, X86::RBP, 0
474 };
Craig Topper53146a22012-05-24 05:55:47 +0000475 const uint16_t *CURegs = (Is64Bit ? CU64BitRegs : CU32BitRegs);
Bill Wendling09b02c82011-07-25 18:00:28 +0000476
477 // Encode the registers in the order they were saved, 3-bits per register. The
Bill Wendling86b1a7d2012-01-12 23:05:03 +0000478 // registers are numbered from 1 to CU_NUM_SAVED_REGS.
Bill Wendling09b02c82011-07-25 18:00:28 +0000479 uint32_t RegEnc = 0;
Bill Wendlingb4ee5162012-01-13 00:41:53 +0000480 for (int I = CU_NUM_SAVED_REGS - 1, Idx = 0; I != -1; --I) {
Bill Wendling09b02c82011-07-25 18:00:28 +0000481 unsigned Reg = SavedRegs[I];
Bill Wendling86b1a7d2012-01-12 23:05:03 +0000482 if (Reg == 0) continue;
483
Bill Wendling09b02c82011-07-25 18:00:28 +0000484 int CURegNum = getCompactUnwindRegNum(CURegs, Reg);
Bill Wendling86b1a7d2012-01-12 23:05:03 +0000485 if (CURegNum == -1) return ~0U;
Bill Wendling80caf9c2011-12-06 01:57:48 +0000486
487 // Encode the 3-bit register number in order, skipping over 3-bits for each
488 // register.
Bill Wendling86b1a7d2012-01-12 23:05:03 +0000489 RegEnc |= (CURegNum & 0x7) << (Idx++ * 3);
Bill Wendling09b02c82011-07-25 18:00:28 +0000490 }
491
Jakob Stoklund Olesendec1f992012-01-11 09:08:04 +0000492 assert((RegEnc & 0x3FFFF) == RegEnc && "Invalid compact register encoding!");
Bill Wendling09b02c82011-07-25 18:00:28 +0000493 return RegEnc;
494}
495
496uint32_t X86FrameLowering::getCompactUnwindEncoding(MachineFunction &MF) const {
497 const X86RegisterInfo *RegInfo = TM.getRegisterInfo();
498 unsigned FramePtr = RegInfo->getFrameRegister(MF);
499 unsigned StackPtr = RegInfo->getStackRegister();
500
Bill Wendling09b02c82011-07-25 18:00:28 +0000501 bool Is64Bit = STI.is64Bit();
502 bool HasFP = hasFP(MF);
503
Bill Wendling57a3cd22011-12-06 21:23:42 +0000504 unsigned SavedRegs[CU_NUM_SAVED_REGS] = { 0, 0, 0, 0, 0, 0 };
Bill Wendling10e412e2011-12-14 23:53:24 +0000505 unsigned SavedRegIdx = 0;
Bill Wendling09b02c82011-07-25 18:00:28 +0000506
507 unsigned OffsetSize = (Is64Bit ? 8 : 4);
508
509 unsigned PushInstr = (Is64Bit ? X86::PUSH64r : X86::PUSH32r);
510 unsigned PushInstrSize = 1;
511 unsigned MoveInstr = (Is64Bit ? X86::MOV64rr : X86::MOV32rr);
512 unsigned MoveInstrSize = (Is64Bit ? 3 : 2);
Bill Wendling09b02c82011-07-25 18:00:28 +0000513 unsigned SubtractInstrIdx = (Is64Bit ? 3 : 2);
514
Bill Wendlingde770552011-07-26 08:03:49 +0000515 unsigned StackDivide = (Is64Bit ? 8 : 4);
516
Bill Wendling09b02c82011-07-25 18:00:28 +0000517 unsigned InstrOffset = 0;
Bill Wendling09b02c82011-07-25 18:00:28 +0000518 unsigned StackAdjust = 0;
Bill Wendling57a3cd22011-12-06 21:23:42 +0000519 unsigned StackSize = 0;
Bill Wendling09b02c82011-07-25 18:00:28 +0000520
521 MachineBasicBlock &MBB = MF.front(); // Prologue is in entry BB.
522 bool ExpectEnd = false;
523 for (MachineBasicBlock::iterator
524 MBBI = MBB.begin(), MBBE = MBB.end(); MBBI != MBBE; ++MBBI) {
525 MachineInstr &MI = *MBBI;
526 unsigned Opc = MI.getOpcode();
527 if (Opc == X86::PROLOG_LABEL) continue;
528 if (!MI.getFlag(MachineInstr::FrameSetup)) break;
529
530 // We don't exect any more prolog instructions.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000531 if (ExpectEnd) return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000532
533 if (Opc == PushInstr) {
534 // If there are too many saved registers, we cannot use compact encoding.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000535 if (SavedRegIdx >= CU_NUM_SAVED_REGS) return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000536
Bill Wendling10e412e2011-12-14 23:53:24 +0000537 SavedRegs[SavedRegIdx++] = MI.getOperand(0).getReg();
Bill Wendling57a3cd22011-12-06 21:23:42 +0000538 StackAdjust += OffsetSize;
Bill Wendling09b02c82011-07-25 18:00:28 +0000539 InstrOffset += PushInstrSize;
540 } else if (Opc == MoveInstr) {
541 unsigned SrcReg = MI.getOperand(1).getReg();
542 unsigned DstReg = MI.getOperand(0).getReg();
543
544 if (DstReg != FramePtr || SrcReg != StackPtr)
Bill Wendling89ec1c52013-04-19 00:05:59 +0000545 return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000546
Bill Wendling57a3cd22011-12-06 21:23:42 +0000547 StackAdjust = 0;
Bill Wendling09b02c82011-07-25 18:00:28 +0000548 memset(SavedRegs, 0, sizeof(SavedRegs));
Bill Wendling10e412e2011-12-14 23:53:24 +0000549 SavedRegIdx = 0;
Bill Wendling09b02c82011-07-25 18:00:28 +0000550 InstrOffset += MoveInstrSize;
Bill Wendling84d518a2011-12-06 22:14:27 +0000551 } else if (Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
552 Opc == X86::SUB32ri || Opc == X86::SUB32ri8) {
Bill Wendling57a3cd22011-12-06 21:23:42 +0000553 if (StackSize)
554 // We already have a stack size.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000555 return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000556
557 if (!MI.getOperand(0).isReg() ||
558 MI.getOperand(0).getReg() != MI.getOperand(1).getReg() ||
559 MI.getOperand(0).getReg() != StackPtr || !MI.getOperand(2).isImm())
560 // We need this to be a stack adjustment pointer. Something like:
561 //
562 // %RSP<def> = SUB64ri8 %RSP, 48
Bill Wendling89ec1c52013-04-19 00:05:59 +0000563 return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000564
Bill Wendling57a3cd22011-12-06 21:23:42 +0000565 StackSize = MI.getOperand(2).getImm() / StackDivide;
Bill Wendling09b02c82011-07-25 18:00:28 +0000566 SubtractInstrIdx += InstrOffset;
567 ExpectEnd = true;
568 }
569 }
570
571 // Encode that we are using EBP/RBP as the frame pointer.
572 uint32_t CompactUnwindEncoding = 0;
Bill Wendling57a3cd22011-12-06 21:23:42 +0000573 StackAdjust /= StackDivide;
Bill Wendling09b02c82011-07-25 18:00:28 +0000574 if (HasFP) {
Bill Wendling57a3cd22011-12-06 21:23:42 +0000575 if ((StackAdjust & 0xFF) != StackAdjust)
Bill Wendling09b02c82011-07-25 18:00:28 +0000576 // Offset was too big for compact encoding.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000577 return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000578
579 // Get the encoding of the saved registers when we have a frame pointer.
580 uint32_t RegEnc = encodeCompactUnwindRegistersWithFrame(SavedRegs, Is64Bit);
Bill Wendling89ec1c52013-04-19 00:05:59 +0000581 if (RegEnc == ~0U) return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000582
Bill Wendling89ec1c52013-04-19 00:05:59 +0000583 CompactUnwindEncoding |= CU::UNWIND_MODE_BP_FRAME;
Bill Wendling57a3cd22011-12-06 21:23:42 +0000584 CompactUnwindEncoding |= (StackAdjust & 0xFF) << 16;
Bill Wendling89ec1c52013-04-19 00:05:59 +0000585 CompactUnwindEncoding |= RegEnc & CU::UNWIND_BP_FRAME_REGISTERS;
Bill Wendling09b02c82011-07-25 18:00:28 +0000586 } else {
Bill Wendlingb3ec3292011-12-07 07:58:55 +0000587 ++StackAdjust;
588 uint32_t TotalStackSize = StackAdjust + StackSize;
Bill Wendling581ac272011-12-06 21:34:01 +0000589 if ((TotalStackSize & 0xFF) == TotalStackSize) {
Bill Wendling5b2c4972011-12-06 19:16:17 +0000590 // Frameless stack with a small stack size.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000591 CompactUnwindEncoding |= CU::UNWIND_MODE_STACK_IMMD;
Bill Wendling5b2c4972011-12-06 19:16:17 +0000592
593 // Encode the stack size.
Bill Wendling581ac272011-12-06 21:34:01 +0000594 CompactUnwindEncoding |= (TotalStackSize & 0xFF) << 16;
Bill Wendling09b02c82011-07-25 18:00:28 +0000595 } else {
Bill Wendling57a3cd22011-12-06 21:23:42 +0000596 if ((StackAdjust & 0x7) != StackAdjust)
Bill Wendling09b02c82011-07-25 18:00:28 +0000597 // The extra stack adjustments are too big for us to handle.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000598 return CU::UNWIND_MODE_DWARF;
Bill Wendling09b02c82011-07-25 18:00:28 +0000599
600 // Frameless stack with an offset too large for us to encode compactly.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000601 CompactUnwindEncoding |= CU::UNWIND_MODE_STACK_IND;
Bill Wendling09b02c82011-07-25 18:00:28 +0000602
603 // Encode the offset to the nnnnnn value in the 'subl $nnnnnn, ESP'
604 // instruction.
605 CompactUnwindEncoding |= (SubtractInstrIdx & 0xFF) << 16;
606
Bill Wendling57a3cd22011-12-06 21:23:42 +0000607 // Encode any extra stack stack adjustments (done via push instructions).
608 CompactUnwindEncoding |= (StackAdjust & 0x7) << 13;
Bill Wendling09b02c82011-07-25 18:00:28 +0000609 }
610
Bill Wendling5b2c4972011-12-06 19:16:17 +0000611 // Encode the number of registers saved.
Bill Wendling10e412e2011-12-14 23:53:24 +0000612 CompactUnwindEncoding |= (SavedRegIdx & 0x7) << 10;
Bill Wendling75e14e02011-12-06 19:09:06 +0000613
Bill Wendling09b02c82011-07-25 18:00:28 +0000614 // Get the encoding of the saved registers when we don't have a frame
615 // pointer.
Bill Wendling57a3cd22011-12-06 21:23:42 +0000616 uint32_t RegEnc =
Bill Wendling10e412e2011-12-14 23:53:24 +0000617 encodeCompactUnwindRegistersWithoutFrame(SavedRegs, SavedRegIdx,
Bill Wendling57a3cd22011-12-06 21:23:42 +0000618 Is64Bit);
Bill Wendling89ec1c52013-04-19 00:05:59 +0000619 if (RegEnc == ~0U) return CU::UNWIND_MODE_DWARF;
Bill Wendling5b2c4972011-12-06 19:16:17 +0000620
621 // Encode the register encoding.
Bill Wendling89ec1c52013-04-19 00:05:59 +0000622 CompactUnwindEncoding |=
623 RegEnc & CU::UNWIND_FRAMELESS_STACK_REG_PERMUTATION;
Bill Wendling09b02c82011-07-25 18:00:28 +0000624 }
625
626 return CompactUnwindEncoding;
627}
628
Nadav Rotem677689c2012-12-23 07:30:09 +0000629/// usesTheStack - This function checks if any of the users of EFLAGS
Nadav Rotemd0696ef2012-12-21 23:48:49 +0000630/// copies the EFLAGS. We know that the code that lowers COPY of EFLAGS has
631/// to use the stack, and if we don't adjust the stack we clobber the first
632/// frame index.
Nadav Rotem677689c2012-12-23 07:30:09 +0000633/// See X86InstrInfo::copyPhysReg.
634static bool usesTheStack(MachineFunction &MF) {
Nadav Rotemd0696ef2012-12-21 23:48:49 +0000635 MachineRegisterInfo &MRI = MF.getRegInfo();
636
637 for (MachineRegisterInfo::reg_iterator ri = MRI.reg_begin(X86::EFLAGS),
638 re = MRI.reg_end(); ri != re; ++ri)
639 if (ri->isCopy())
640 return true;
641
642 return false;
643}
644
Anton Korobeynikov33464912010-11-15 00:06:54 +0000645/// emitPrologue - Push callee-saved registers onto the stack, which
646/// automatically adjust the stack pointer. Adjust the stack pointer to allocate
647/// space for local variables. Also emit labels used by the exception handler to
648/// generate the exception handling frames.
Anton Korobeynikov16c29b52011-01-10 12:39:04 +0000649void X86FrameLowering::emitPrologue(MachineFunction &MF) const {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000650 MachineBasicBlock &MBB = MF.front(); // Prologue goes in entry BB.
651 MachineBasicBlock::iterator MBBI = MBB.begin();
652 MachineFrameInfo *MFI = MF.getFrameInfo();
653 const Function *Fn = MF.getFunction();
Anton Korobeynikovd9e33852010-11-18 23:25:52 +0000654 const X86RegisterInfo *RegInfo = TM.getRegisterInfo();
655 const X86InstrInfo &TII = *TM.getInstrInfo();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000656 MachineModuleInfo &MMI = MF.getMMI();
657 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
658 bool needsFrameMoves = MMI.hasDebugInfo() ||
Rafael Espindolafc2bb8c2011-05-25 03:44:17 +0000659 Fn->needsUnwindTableEntry();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000660 uint64_t MaxAlign = MFI->getMaxAlignment(); // Desired stack alignment.
661 uint64_t StackSize = MFI->getStackSize(); // Number of bytes to allocate.
Anton Korobeynikovd0c38172010-11-18 21:19:35 +0000662 bool HasFP = hasFP(MF);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000663 bool Is64Bit = STI.is64Bit();
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000664 bool IsLP64 = STI.isTarget64BitLP64();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000665 bool IsWin64 = STI.isTargetWin64();
Evan Chengde1df102012-02-07 22:50:41 +0000666 bool UseLEA = STI.useLeaForSP();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000667 unsigned StackAlign = getStackAlignment();
668 unsigned SlotSize = RegInfo->getSlotSize();
669 unsigned FramePtr = RegInfo->getFrameRegister(MF);
670 unsigned StackPtr = RegInfo->getStackRegister();
Chad Rosier3f0dbab2012-07-10 17:45:53 +0000671 unsigned BasePtr = RegInfo->getBaseRegister();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000672 DebugLoc DL;
673
674 // If we're forcing a stack realignment we can't rely on just the frame
675 // info, we need to know the ABI stack alignment as well in case we
676 // have a call out. Otherwise just make sure we have some alignment - we'll
677 // go with the minimum SlotSize.
678 if (ForceStackAlign) {
679 if (MFI->hasCalls())
680 MaxAlign = (StackAlign > MaxAlign) ? StackAlign : MaxAlign;
681 else if (MaxAlign < SlotSize)
682 MaxAlign = SlotSize;
683 }
684
685 // Add RETADDR move area to callee saved frame size.
686 int TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
687 if (TailCallReturnAddrDelta < 0)
688 X86FI->setCalleeSavedFrameSize(
689 X86FI->getCalleeSavedFrameSize() - TailCallReturnAddrDelta);
690
691 // If this is x86-64 and the Red Zone is not disabled, if we are a leaf
692 // function, and use up to 128 bytes of stack space, don't have a frame
693 // pointer, calls, or dynamic alloca then we do not need to adjust the
Nadav Rotemd0696ef2012-12-21 23:48:49 +0000694 // stack pointer (we fit in the Red Zone). We also check that we don't
695 // push and pop from the stack.
Bill Wendling831737d2012-12-30 10:32:01 +0000696 if (Is64Bit && !Fn->getAttributes().hasAttribute(AttributeSet::FunctionIndex,
697 Attribute::NoRedZone) &&
Anton Korobeynikov33464912010-11-15 00:06:54 +0000698 !RegInfo->needsStackRealignment(MF) &&
Nick Lewycky8a8d4792011-12-02 22:16:29 +0000699 !MFI->hasVarSizedObjects() && // No dynamic alloca.
700 !MFI->adjustsStack() && // No calls.
701 !IsWin64 && // Win64 has no Red Zone
Nadav Rotem677689c2012-12-23 07:30:09 +0000702 !usesTheStack(MF) && // Don't push and pop.
Nick Lewycky8a8d4792011-12-02 22:16:29 +0000703 !MF.getTarget().Options.EnableSegmentedStacks) { // Regular stack
Anton Korobeynikov33464912010-11-15 00:06:54 +0000704 uint64_t MinSize = X86FI->getCalleeSavedFrameSize();
705 if (HasFP) MinSize += SlotSize;
706 StackSize = std::max(MinSize, StackSize > 128 ? StackSize - 128 : 0);
707 MFI->setStackSize(StackSize);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000708 }
709
710 // Insert stack pointer adjustment for later moving of return addr. Only
711 // applies to tail call optimized functions where the callee argument stack
712 // size is bigger than the callers.
713 if (TailCallReturnAddrDelta < 0) {
714 MachineInstr *MI =
715 BuildMI(MBB, MBBI, DL,
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000716 TII.get(getSUBriOpcode(IsLP64, -TailCallReturnAddrDelta)),
Anton Korobeynikov33464912010-11-15 00:06:54 +0000717 StackPtr)
718 .addReg(StackPtr)
Charles Davisaff232a2011-06-12 01:45:54 +0000719 .addImm(-TailCallReturnAddrDelta)
720 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000721 MI->getOperand(3).setIsDead(); // The EFLAGS implicit def is dead.
722 }
723
724 // Mapping for machine moves:
725 //
726 // DST: VirtualFP AND
727 // SRC: VirtualFP => DW_CFA_def_cfa_offset
728 // ELSE => DW_CFA_def_cfa
729 //
730 // SRC: VirtualFP AND
731 // DST: Register => DW_CFA_def_cfa_register
732 //
733 // ELSE
734 // OFFSET < 0 => DW_CFA_offset_extended_sf
735 // REG < 64 => DW_CFA_offset + Reg
736 // ELSE => DW_CFA_offset_extended
737
738 std::vector<MachineMove> &Moves = MMI.getFrameMoves();
Anton Korobeynikov33464912010-11-15 00:06:54 +0000739 uint64_t NumBytes = 0;
Michael Liaoaa3c2c02012-10-25 06:29:14 +0000740 int stackGrowth = -SlotSize;
Anton Korobeynikov33464912010-11-15 00:06:54 +0000741
742 if (HasFP) {
743 // Calculate required stack adjustment.
744 uint64_t FrameSize = StackSize - SlotSize;
Alexey Samsonov99a92f22012-07-16 06:54:09 +0000745 if (RegInfo->needsStackRealignment(MF)) {
746 // Callee-saved registers are pushed on stack before the stack
747 // is realigned.
748 FrameSize -= X86FI->getCalleeSavedFrameSize();
749 NumBytes = (FrameSize + MaxAlign - 1) / MaxAlign * MaxAlign;
750 } else {
751 NumBytes = FrameSize - X86FI->getCalleeSavedFrameSize();
752 }
Anton Korobeynikov33464912010-11-15 00:06:54 +0000753
754 // Get the offset of the stack slot for the EBP register, which is
755 // guaranteed to be the last slot by processFunctionBeforeFrameFinalized.
756 // Update the frame offset adjustment.
757 MFI->setOffsetAdjustment(-NumBytes);
758
759 // Save EBP/RBP into the appropriate stack slot.
760 BuildMI(MBB, MBBI, DL, TII.get(Is64Bit ? X86::PUSH64r : X86::PUSH32r))
Charles Davisaff232a2011-06-12 01:45:54 +0000761 .addReg(FramePtr, RegState::Kill)
762 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000763
764 if (needsFrameMoves) {
765 // Mark the place where EBP/RBP was saved.
766 MCSymbol *FrameLabel = MMI.getContext().CreateTempSymbol();
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000767 BuildMI(MBB, MBBI, DL, TII.get(X86::PROLOG_LABEL))
768 .addSym(FrameLabel);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000769
770 // Define the current CFA rule to use the provided offset.
771 if (StackSize) {
772 MachineLocation SPDst(MachineLocation::VirtualFP);
773 MachineLocation SPSrc(MachineLocation::VirtualFP, 2 * stackGrowth);
774 Moves.push_back(MachineMove(FrameLabel, SPDst, SPSrc));
775 } else {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000776 MachineLocation SPDst(StackPtr);
777 MachineLocation SPSrc(StackPtr, stackGrowth);
778 Moves.push_back(MachineMove(FrameLabel, SPDst, SPSrc));
779 }
780
781 // Change the rule for the FramePtr to be an "offset" rule.
782 MachineLocation FPDst(MachineLocation::VirtualFP, 2 * stackGrowth);
783 MachineLocation FPSrc(FramePtr);
784 Moves.push_back(MachineMove(FrameLabel, FPDst, FPSrc));
785 }
786
Bill Wendling09b02c82011-07-25 18:00:28 +0000787 // Update EBP with the new base value.
Anton Korobeynikov33464912010-11-15 00:06:54 +0000788 BuildMI(MBB, MBBI, DL,
789 TII.get(Is64Bit ? X86::MOV64rr : X86::MOV32rr), FramePtr)
Charles Davisaff232a2011-06-12 01:45:54 +0000790 .addReg(StackPtr)
791 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000792
793 if (needsFrameMoves) {
794 // Mark effective beginning of when frame pointer becomes valid.
795 MCSymbol *FrameLabel = MMI.getContext().CreateTempSymbol();
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000796 BuildMI(MBB, MBBI, DL, TII.get(X86::PROLOG_LABEL))
797 .addSym(FrameLabel);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000798
799 // Define the current CFA to use the EBP/RBP register.
800 MachineLocation FPDst(FramePtr);
801 MachineLocation FPSrc(MachineLocation::VirtualFP);
802 Moves.push_back(MachineMove(FrameLabel, FPDst, FPSrc));
803 }
804
805 // Mark the FramePtr as live-in in every block except the entry.
806 for (MachineFunction::iterator I = llvm::next(MF.begin()), E = MF.end();
807 I != E; ++I)
808 I->addLiveIn(FramePtr);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000809 } else {
810 NumBytes = StackSize - X86FI->getCalleeSavedFrameSize();
811 }
812
813 // Skip the callee-saved push instructions.
814 bool PushedRegs = false;
815 int StackOffset = 2 * stackGrowth;
816
817 while (MBBI != MBB.end() &&
818 (MBBI->getOpcode() == X86::PUSH32r ||
819 MBBI->getOpcode() == X86::PUSH64r)) {
820 PushedRegs = true;
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000821 MBBI->setFlag(MachineInstr::FrameSetup);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000822 ++MBBI;
823
824 if (!HasFP && needsFrameMoves) {
825 // Mark callee-saved push instruction.
826 MCSymbol *Label = MMI.getContext().CreateTempSymbol();
827 BuildMI(MBB, MBBI, DL, TII.get(X86::PROLOG_LABEL)).addSym(Label);
828
829 // Define the current CFA rule to use the provided offset.
Bill Wendling09b02c82011-07-25 18:00:28 +0000830 unsigned Ptr = StackSize ? MachineLocation::VirtualFP : StackPtr;
Anton Korobeynikov33464912010-11-15 00:06:54 +0000831 MachineLocation SPDst(Ptr);
832 MachineLocation SPSrc(Ptr, StackOffset);
833 Moves.push_back(MachineMove(Label, SPDst, SPSrc));
834 StackOffset += stackGrowth;
835 }
836 }
837
Alexey Samsonov99a92f22012-07-16 06:54:09 +0000838 // Realign stack after we pushed callee-saved registers (so that we'll be
839 // able to calculate their offsets from the frame pointer).
840
841 // NOTE: We push the registers before realigning the stack, so
842 // vector callee-saved (xmm) registers may be saved w/o proper
843 // alignment in this way. However, currently these regs are saved in
844 // stack slots (see X86FrameLowering::spillCalleeSavedRegisters()), so
845 // this shouldn't be a problem.
846 if (RegInfo->needsStackRealignment(MF)) {
847 assert(HasFP && "There should be a frame pointer if stack is realigned.");
848 MachineInstr *MI =
849 BuildMI(MBB, MBBI, DL,
850 TII.get(Is64Bit ? X86::AND64ri32 : X86::AND32ri), StackPtr)
851 .addReg(StackPtr)
852 .addImm(-MaxAlign)
853 .setMIFlag(MachineInstr::FrameSetup);
854
855 // The EFLAGS implicit def is dead.
856 MI->getOperand(3).setIsDead();
857 }
858
Anton Korobeynikov33464912010-11-15 00:06:54 +0000859 // If there is an SUB32ri of ESP immediately before this instruction, merge
860 // the two. This can be the case when tail call elimination is enabled and
861 // the callee has more arguments then the caller.
862 NumBytes -= mergeSPUpdates(MBB, MBBI, StackPtr, true);
863
864 // If there is an ADD32ri or SUB32ri of ESP immediately after this
865 // instruction, merge the two instructions.
866 mergeSPUpdatesDown(MBB, MBBI, StackPtr, &NumBytes);
867
868 // Adjust stack pointer: ESP -= numbytes.
869
870 // Windows and cygwin/mingw require a prologue helper routine when allocating
871 // more than 4K bytes on the stack. Windows uses __chkstk and cygwin/mingw
872 // uses __alloca. __alloca and the 32-bit version of __chkstk will probe the
873 // stack and adjust the stack pointer in one go. The 64-bit version of
874 // __chkstk is only responsible for probing the stack. The 64-bit prologue is
875 // responsible for adjusting the stack pointer. Touching the stack at 4K
876 // increments is necessary to ensure that the guard pages used by the OS
877 // virtual memory manager are allocated in correct sequence.
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000878 if (NumBytes >= 4096 && STI.isTargetCOFF() && !STI.isTargetEnvMacho()) {
879 const char *StackProbeSymbol;
880 bool isSPUpdateNeeded = false;
881
882 if (Is64Bit) {
883 if (STI.isTargetCygMing())
884 StackProbeSymbol = "___chkstk";
885 else {
886 StackProbeSymbol = "__chkstk";
887 isSPUpdateNeeded = true;
888 }
889 } else if (STI.isTargetCygMing())
890 StackProbeSymbol = "_alloca";
891 else
892 StackProbeSymbol = "_chkstk";
893
Anton Korobeynikov33464912010-11-15 00:06:54 +0000894 // Check whether EAX is livein for this function.
895 bool isEAXAlive = isEAXLiveIn(MF);
896
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000897 if (isEAXAlive) {
898 // Sanity check that EAX is not livein for this function.
899 // It should not be, so throw an assert.
900 assert(!Is64Bit && "EAX is livein in x64 case!");
901
Anton Korobeynikov33464912010-11-15 00:06:54 +0000902 // Save EAX
903 BuildMI(MBB, MBBI, DL, TII.get(X86::PUSH32r))
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000904 .addReg(X86::EAX, RegState::Kill)
905 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000906 }
Anton Korobeynikov33464912010-11-15 00:06:54 +0000907
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000908 if (Is64Bit) {
909 // Handle the 64-bit Windows ABI case where we need to call __chkstk.
910 // Function prologue is responsible for adjusting the stack pointer.
911 BuildMI(MBB, MBBI, DL, TII.get(X86::MOV64ri), X86::RAX)
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000912 .addImm(NumBytes)
913 .setMIFlag(MachineInstr::FrameSetup);
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000914 } else {
915 // Allocate NumBytes-4 bytes on stack in case of isEAXAlive.
916 // We'll also use 4 already allocated bytes for EAX.
917 BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32ri), X86::EAX)
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000918 .addImm(isEAXAlive ? NumBytes - 4 : NumBytes)
919 .setMIFlag(MachineInstr::FrameSetup);
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000920 }
921
922 BuildMI(MBB, MBBI, DL,
923 TII.get(Is64Bit ? X86::W64ALLOCA : X86::CALLpcrel32))
924 .addExternalSymbol(StackProbeSymbol)
925 .addReg(StackPtr, RegState::Define | RegState::Implicit)
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000926 .addReg(X86::EFLAGS, RegState::Define | RegState::Implicit)
927 .setMIFlag(MachineInstr::FrameSetup);
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000928
929 // MSVC x64's __chkstk needs to adjust %rsp.
930 // FIXME: %rax preserves the offset and should be available.
931 if (isSPUpdateNeeded)
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000932 emitSPUpdate(MBB, MBBI, StackPtr, -(int64_t)NumBytes, Is64Bit, IsLP64,
Eric Christopher76ad43c2012-10-03 08:10:01 +0000933 UseLEA, TII, *RegInfo);
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000934
935 if (isEAXAlive) {
936 // Restore EAX
937 MachineInstr *MI = addRegOffset(BuildMI(MF, DL, TII.get(X86::MOV32rm),
938 X86::EAX),
939 StackPtr, false, NumBytes - 4);
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000940 MI->setFlag(MachineInstr::FrameSetup);
NAKAMURA Takumia2e07622011-03-24 07:07:00 +0000941 MBB.insert(MBBI, MI);
942 }
Anton Korobeynikov33464912010-11-15 00:06:54 +0000943 } else if (NumBytes)
Eli Bendersky2a1b60d2013-02-05 21:53:29 +0000944 emitSPUpdate(MBB, MBBI, StackPtr, -(int64_t)NumBytes, Is64Bit, IsLP64,
Eric Christopher76ad43c2012-10-03 08:10:01 +0000945 UseLEA, TII, *RegInfo);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000946
Chad Rosier3f0dbab2012-07-10 17:45:53 +0000947 // If we need a base pointer, set it up here. It's whatever the value
948 // of the stack pointer is at this point. Any variable size objects
949 // will be allocated after this, so we can still use the base pointer
950 // to reference locals.
951 if (RegInfo->hasBasePointer(MF)) {
952 // Update the frame pointer with the current stack pointer.
953 unsigned Opc = Is64Bit ? X86::MOV64rr : X86::MOV32rr;
954 BuildMI(MBB, MBBI, DL, TII.get(Opc), BasePtr)
955 .addReg(StackPtr)
956 .setMIFlag(MachineInstr::FrameSetup);
Chad Rosier3f0dbab2012-07-10 17:45:53 +0000957 }
958
Rafael Espindolaf0adba92011-04-15 15:11:06 +0000959 if (( (!HasFP && NumBytes) || PushedRegs) && needsFrameMoves) {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000960 // Mark end of stack pointer adjustment.
961 MCSymbol *Label = MMI.getContext().CreateTempSymbol();
Bill Wendlingfb4eb162011-07-21 00:44:56 +0000962 BuildMI(MBB, MBBI, DL, TII.get(X86::PROLOG_LABEL))
963 .addSym(Label);
Anton Korobeynikov33464912010-11-15 00:06:54 +0000964
965 if (!HasFP && NumBytes) {
966 // Define the current CFA rule to use the provided offset.
967 if (StackSize) {
968 MachineLocation SPDst(MachineLocation::VirtualFP);
969 MachineLocation SPSrc(MachineLocation::VirtualFP,
970 -StackSize + stackGrowth);
971 Moves.push_back(MachineMove(Label, SPDst, SPSrc));
972 } else {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000973 MachineLocation SPDst(StackPtr);
974 MachineLocation SPSrc(StackPtr, stackGrowth);
975 Moves.push_back(MachineMove(Label, SPDst, SPSrc));
976 }
977 }
978
979 // Emit DWARF info specifying the offsets of the callee-saved registers.
980 if (PushedRegs)
981 emitCalleeSavedFrameMoves(MF, Label, HasFP ? FramePtr : StackPtr);
982 }
Bill Wendling09b02c82011-07-25 18:00:28 +0000983
984 // Darwin 10.7 and greater has support for compact unwind encoding.
Bill Wendlingc8725d12011-09-06 23:47:14 +0000985 if (STI.getTargetTriple().isMacOSX() &&
Eli Friedmanac86d432011-08-31 16:19:51 +0000986 !STI.getTargetTriple().isMacOSXVersionLT(10, 7))
Bill Wendling09b02c82011-07-25 18:00:28 +0000987 MMI.setCompactUnwindEncoding(getCompactUnwindEncoding(MF));
Anton Korobeynikov33464912010-11-15 00:06:54 +0000988}
989
Anton Korobeynikov16c29b52011-01-10 12:39:04 +0000990void X86FrameLowering::emitEpilogue(MachineFunction &MF,
Nick Lewycky3c2f0a12011-06-14 03:23:52 +0000991 MachineBasicBlock &MBB) const {
Anton Korobeynikov33464912010-11-15 00:06:54 +0000992 const MachineFrameInfo *MFI = MF.getFrameInfo();
993 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
Anton Korobeynikovd9e33852010-11-18 23:25:52 +0000994 const X86RegisterInfo *RegInfo = TM.getRegisterInfo();
995 const X86InstrInfo &TII = *TM.getInstrInfo();
Jakob Stoklund Olesen4f28c1c2011-01-13 21:28:52 +0000996 MachineBasicBlock::iterator MBBI = MBB.getLastNonDebugInstr();
997 assert(MBBI != MBB.end() && "Returning block has no instructions");
Anton Korobeynikov33464912010-11-15 00:06:54 +0000998 unsigned RetOpcode = MBBI->getOpcode();
999 DebugLoc DL = MBBI->getDebugLoc();
1000 bool Is64Bit = STI.is64Bit();
Eli Bendersky2a1b60d2013-02-05 21:53:29 +00001001 bool IsLP64 = STI.isTarget64BitLP64();
Evan Chengde1df102012-02-07 22:50:41 +00001002 bool UseLEA = STI.useLeaForSP();
Anton Korobeynikov33464912010-11-15 00:06:54 +00001003 unsigned StackAlign = getStackAlignment();
1004 unsigned SlotSize = RegInfo->getSlotSize();
1005 unsigned FramePtr = RegInfo->getFrameRegister(MF);
1006 unsigned StackPtr = RegInfo->getStackRegister();
1007
1008 switch (RetOpcode) {
1009 default:
1010 llvm_unreachable("Can only insert epilog into returning blocks");
1011 case X86::RET:
1012 case X86::RETI:
1013 case X86::TCRETURNdi:
1014 case X86::TCRETURNri:
1015 case X86::TCRETURNmi:
1016 case X86::TCRETURNdi64:
1017 case X86::TCRETURNri64:
1018 case X86::TCRETURNmi64:
1019 case X86::EH_RETURN:
1020 case X86::EH_RETURN64:
1021 break; // These are ok
1022 }
1023
1024 // Get the number of bytes to allocate from the FrameInfo.
1025 uint64_t StackSize = MFI->getStackSize();
1026 uint64_t MaxAlign = MFI->getMaxAlignment();
1027 unsigned CSSize = X86FI->getCalleeSavedFrameSize();
1028 uint64_t NumBytes = 0;
1029
1030 // If we're forcing a stack realignment we can't rely on just the frame
1031 // info, we need to know the ABI stack alignment as well in case we
1032 // have a call out. Otherwise just make sure we have some alignment - we'll
1033 // go with the minimum.
1034 if (ForceStackAlign) {
1035 if (MFI->hasCalls())
1036 MaxAlign = (StackAlign > MaxAlign) ? StackAlign : MaxAlign;
1037 else
1038 MaxAlign = MaxAlign ? MaxAlign : 4;
1039 }
1040
Anton Korobeynikovd0c38172010-11-18 21:19:35 +00001041 if (hasFP(MF)) {
Anton Korobeynikov33464912010-11-15 00:06:54 +00001042 // Calculate required stack adjustment.
1043 uint64_t FrameSize = StackSize - SlotSize;
Alexey Samsonov99a92f22012-07-16 06:54:09 +00001044 if (RegInfo->needsStackRealignment(MF)) {
1045 // Callee-saved registers were pushed on stack before the stack
1046 // was realigned.
1047 FrameSize -= CSSize;
1048 NumBytes = (FrameSize + MaxAlign - 1) / MaxAlign * MaxAlign;
1049 } else {
1050 NumBytes = FrameSize - CSSize;
1051 }
Anton Korobeynikov33464912010-11-15 00:06:54 +00001052
1053 // Pop EBP.
1054 BuildMI(MBB, MBBI, DL,
1055 TII.get(Is64Bit ? X86::POP64r : X86::POP32r), FramePtr);
1056 } else {
1057 NumBytes = StackSize - CSSize;
1058 }
1059
1060 // Skip the callee-saved pop instructions.
Anton Korobeynikov33464912010-11-15 00:06:54 +00001061 while (MBBI != MBB.begin()) {
1062 MachineBasicBlock::iterator PI = prior(MBBI);
1063 unsigned Opc = PI->getOpcode();
1064
Jakob Stoklund Olesen4f28c1c2011-01-13 21:28:52 +00001065 if (Opc != X86::POP32r && Opc != X86::POP64r && Opc != X86::DBG_VALUE &&
Evan Cheng5a96b3d2011-12-07 07:15:52 +00001066 !PI->isTerminator())
Anton Korobeynikov33464912010-11-15 00:06:54 +00001067 break;
1068
1069 --MBBI;
1070 }
Alexey Samsonov99a92f22012-07-16 06:54:09 +00001071 MachineBasicBlock::iterator FirstCSPop = MBBI;
Anton Korobeynikov33464912010-11-15 00:06:54 +00001072
1073 DL = MBBI->getDebugLoc();
1074
1075 // If there is an ADD32ri or SUB32ri of ESP immediately before this
1076 // instruction, merge the two instructions.
1077 if (NumBytes || MFI->hasVarSizedObjects())
1078 mergeSPUpdatesUp(MBB, MBBI, StackPtr, &NumBytes);
1079
1080 // If dynamic alloca is used, then reset esp to point to the last callee-saved
1081 // slot before popping them off! Same applies for the case, when stack was
1082 // realigned.
Alexey Samsonov99a92f22012-07-16 06:54:09 +00001083 if (RegInfo->needsStackRealignment(MF) || MFI->hasVarSizedObjects()) {
1084 if (RegInfo->needsStackRealignment(MF))
1085 MBBI = FirstCSPop;
1086 if (CSSize != 0) {
Eli Bendersky16221a62013-02-06 20:43:57 +00001087 unsigned Opc = getLEArOpcode(IsLP64);
Alexey Samsonov99a92f22012-07-16 06:54:09 +00001088 addRegOffset(BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr),
1089 FramePtr, false, -CSSize);
Anton Korobeynikov33464912010-11-15 00:06:54 +00001090 } else {
Alexey Samsonov99a92f22012-07-16 06:54:09 +00001091 unsigned Opc = (Is64Bit ? X86::MOV64rr : X86::MOV32rr);
1092 BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr)
Anton Korobeynikov33464912010-11-15 00:06:54 +00001093 .addReg(FramePtr);
1094 }
1095 } else if (NumBytes) {
1096 // Adjust stack pointer back: ESP += numbytes.
Eli Bendersky2a1b60d2013-02-05 21:53:29 +00001097 emitSPUpdate(MBB, MBBI, StackPtr, NumBytes, Is64Bit, IsLP64, UseLEA,
1098 TII, *RegInfo);
Anton Korobeynikov33464912010-11-15 00:06:54 +00001099 }
1100
1101 // We're returning from function via eh_return.
1102 if (RetOpcode == X86::EH_RETURN || RetOpcode == X86::EH_RETURN64) {
Jakob Stoklund Olesen4f28c1c2011-01-13 21:28:52 +00001103 MBBI = MBB.getLastNonDebugInstr();
Anton Korobeynikov33464912010-11-15 00:06:54 +00001104 MachineOperand &DestAddr = MBBI->getOperand(0);
1105 assert(DestAddr.isReg() && "Offset should be in register!");
1106 BuildMI(MBB, MBBI, DL,
1107 TII.get(Is64Bit ? X86::MOV64rr : X86::MOV32rr),
1108 StackPtr).addReg(DestAddr.getReg());
1109 } else if (RetOpcode == X86::TCRETURNri || RetOpcode == X86::TCRETURNdi ||
1110 RetOpcode == X86::TCRETURNmi ||
1111 RetOpcode == X86::TCRETURNri64 || RetOpcode == X86::TCRETURNdi64 ||
1112 RetOpcode == X86::TCRETURNmi64) {
1113 bool isMem = RetOpcode == X86::TCRETURNmi || RetOpcode == X86::TCRETURNmi64;
1114 // Tail call return: adjust the stack pointer and jump to callee.
Jakob Stoklund Olesenf7ca9762011-01-13 22:47:43 +00001115 MBBI = MBB.getLastNonDebugInstr();
Anton Korobeynikov33464912010-11-15 00:06:54 +00001116 MachineOperand &JumpTarget = MBBI->getOperand(0);
1117 MachineOperand &StackAdjust = MBBI->getOperand(isMem ? 5 : 1);
1118 assert(StackAdjust.isImm() && "Expecting immediate value.");
1119
1120 // Adjust stack pointer.
1121 int StackAdj = StackAdjust.getImm();
1122 int MaxTCDelta = X86FI->getTCReturnAddrDelta();
1123 int Offset = 0;
1124 assert(MaxTCDelta <= 0 && "MaxTCDelta should never be positive");
1125
1126 // Incoporate the retaddr area.
1127 Offset = StackAdj-MaxTCDelta;
1128 assert(Offset >= 0 && "Offset should never be negative");
1129
1130 if (Offset) {
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001131 // Check for possible merge with preceding ADD instruction.
Anton Korobeynikov33464912010-11-15 00:06:54 +00001132 Offset += mergeSPUpdates(MBB, MBBI, StackPtr, true);
Eli Bendersky2a1b60d2013-02-05 21:53:29 +00001133 emitSPUpdate(MBB, MBBI, StackPtr, Offset, Is64Bit, IsLP64,
1134 UseLEA, TII, *RegInfo);
Anton Korobeynikov33464912010-11-15 00:06:54 +00001135 }
1136
1137 // Jump to label or value in register.
1138 if (RetOpcode == X86::TCRETURNdi || RetOpcode == X86::TCRETURNdi64) {
Evan Cheng3d2125c2010-11-30 23:55:39 +00001139 MachineInstrBuilder MIB =
1140 BuildMI(MBB, MBBI, DL, TII.get((RetOpcode == X86::TCRETURNdi)
1141 ? X86::TAILJMPd : X86::TAILJMPd64));
1142 if (JumpTarget.isGlobal())
1143 MIB.addGlobalAddress(JumpTarget.getGlobal(), JumpTarget.getOffset(),
1144 JumpTarget.getTargetFlags());
1145 else {
1146 assert(JumpTarget.isSymbol());
1147 MIB.addExternalSymbol(JumpTarget.getSymbolName(),
1148 JumpTarget.getTargetFlags());
1149 }
Anton Korobeynikov33464912010-11-15 00:06:54 +00001150 } else if (RetOpcode == X86::TCRETURNmi || RetOpcode == X86::TCRETURNmi64) {
1151 MachineInstrBuilder MIB =
1152 BuildMI(MBB, MBBI, DL, TII.get((RetOpcode == X86::TCRETURNmi)
1153 ? X86::TAILJMPm : X86::TAILJMPm64));
1154 for (unsigned i = 0; i != 5; ++i)
1155 MIB.addOperand(MBBI->getOperand(i));
1156 } else if (RetOpcode == X86::TCRETURNri64) {
1157 BuildMI(MBB, MBBI, DL, TII.get(X86::TAILJMPr64)).
1158 addReg(JumpTarget.getReg(), RegState::Kill);
1159 } else {
1160 BuildMI(MBB, MBBI, DL, TII.get(X86::TAILJMPr)).
1161 addReg(JumpTarget.getReg(), RegState::Kill);
1162 }
1163
1164 MachineInstr *NewMI = prior(MBBI);
Jakob Stoklund Olesenbe06aac2012-12-20 22:54:02 +00001165 NewMI->copyImplicitOps(MF, MBBI);
Anton Korobeynikov33464912010-11-15 00:06:54 +00001166
1167 // Delete the pseudo instruction TCRETURN.
1168 MBB.erase(MBBI);
1169 } else if ((RetOpcode == X86::RET || RetOpcode == X86::RETI) &&
1170 (X86FI->getTCReturnAddrDelta() < 0)) {
1171 // Add the return addr area delta back since we are not tail calling.
1172 int delta = -1*X86FI->getTCReturnAddrDelta();
Jakob Stoklund Olesen4f28c1c2011-01-13 21:28:52 +00001173 MBBI = MBB.getLastNonDebugInstr();
Anton Korobeynikov33464912010-11-15 00:06:54 +00001174
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001175 // Check for possible merge with preceding ADD instruction.
Anton Korobeynikov33464912010-11-15 00:06:54 +00001176 delta += mergeSPUpdates(MBB, MBBI, StackPtr, true);
Eli Bendersky2a1b60d2013-02-05 21:53:29 +00001177 emitSPUpdate(MBB, MBBI, StackPtr, delta, Is64Bit, IsLP64, UseLEA, TII,
1178 *RegInfo);
Anton Korobeynikov33464912010-11-15 00:06:54 +00001179 }
1180}
Anton Korobeynikovd9e33852010-11-18 23:25:52 +00001181
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00001182int X86FrameLowering::getFrameIndexOffset(const MachineFunction &MF, int FI) const {
Chad Rosier3fb6eca2012-05-23 23:45:10 +00001183 const X86RegisterInfo *RegInfo =
Anton Korobeynikov82f58742010-11-20 15:59:32 +00001184 static_cast<const X86RegisterInfo*>(MF.getTarget().getRegisterInfo());
1185 const MachineFrameInfo *MFI = MF.getFrameInfo();
1186 int Offset = MFI->getObjectOffset(FI) - getOffsetOfLocalArea();
1187 uint64_t StackSize = MFI->getStackSize();
1188
Chad Rosier3f0dbab2012-07-10 17:45:53 +00001189 if (RegInfo->hasBasePointer(MF)) {
1190 assert (hasFP(MF) && "VLAs and dynamic stack realign, but no FP?!");
1191 if (FI < 0) {
1192 // Skip the saved EBP.
1193 return Offset + RegInfo->getSlotSize();
1194 } else {
1195 assert((-(Offset + StackSize)) % MFI->getObjectAlignment(FI) == 0);
1196 return Offset + StackSize;
1197 }
1198 } else if (RegInfo->needsStackRealignment(MF)) {
Anton Korobeynikov82f58742010-11-20 15:59:32 +00001199 if (FI < 0) {
1200 // Skip the saved EBP.
Chad Rosier3fb6eca2012-05-23 23:45:10 +00001201 return Offset + RegInfo->getSlotSize();
Anton Korobeynikov82f58742010-11-20 15:59:32 +00001202 } else {
Duncan Sands17001ce2011-10-18 12:44:00 +00001203 assert((-(Offset + StackSize)) % MFI->getObjectAlignment(FI) == 0);
Anton Korobeynikov82f58742010-11-20 15:59:32 +00001204 return Offset + StackSize;
1205 }
1206 // FIXME: Support tail calls
1207 } else {
1208 if (!hasFP(MF))
1209 return Offset + StackSize;
1210
1211 // Skip the saved EBP.
Chad Rosier3fb6eca2012-05-23 23:45:10 +00001212 Offset += RegInfo->getSlotSize();
Anton Korobeynikov82f58742010-11-20 15:59:32 +00001213
1214 // Skip the RETADDR move area
1215 const X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1216 int TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
1217 if (TailCallReturnAddrDelta < 0)
1218 Offset -= TailCallReturnAddrDelta;
1219 }
1220
1221 return Offset;
1222}
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001223
Alexey Samsonovd07d06c2012-05-01 15:16:06 +00001224int X86FrameLowering::getFrameIndexReference(const MachineFunction &MF, int FI,
1225 unsigned &FrameReg) const {
Chad Rosier3fb6eca2012-05-23 23:45:10 +00001226 const X86RegisterInfo *RegInfo =
Alexey Samsonovd07d06c2012-05-01 15:16:06 +00001227 static_cast<const X86RegisterInfo*>(MF.getTarget().getRegisterInfo());
1228 // We can't calculate offset from frame pointer if the stack is realigned,
Chad Rosier3f0dbab2012-07-10 17:45:53 +00001229 // so enforce usage of stack/base pointer. The base pointer is used when we
1230 // have dynamic allocas in addition to dynamic realignment.
1231 if (RegInfo->hasBasePointer(MF))
1232 FrameReg = RegInfo->getBaseRegister();
1233 else if (RegInfo->needsStackRealignment(MF))
1234 FrameReg = RegInfo->getStackRegister();
1235 else
1236 FrameReg = RegInfo->getFrameRegister(MF);
Alexey Samsonovd07d06c2012-05-01 15:16:06 +00001237 return getFrameIndexOffset(MF, FI);
1238}
1239
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00001240bool X86FrameLowering::spillCalleeSavedRegisters(MachineBasicBlock &MBB,
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001241 MachineBasicBlock::iterator MI,
1242 const std::vector<CalleeSavedInfo> &CSI,
1243 const TargetRegisterInfo *TRI) const {
1244 if (CSI.empty())
1245 return false;
1246
1247 DebugLoc DL = MBB.findDebugLoc(MI);
1248
1249 MachineFunction &MF = *MBB.getParent();
1250
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001251 unsigned SlotSize = STI.is64Bit() ? 8 : 4;
1252 unsigned FPReg = TRI->getFrameRegister(MF);
1253 unsigned CalleeFrameSize = 0;
1254
1255 const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
1256 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1257
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001258 // Push GPRs. It increases frame size.
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001259 unsigned Opc = STI.is64Bit() ? X86::PUSH64r : X86::PUSH32r;
1260 for (unsigned i = CSI.size(); i != 0; --i) {
1261 unsigned Reg = CSI[i-1].getReg();
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001262 if (!X86::GR64RegClass.contains(Reg) &&
1263 !X86::GR32RegClass.contains(Reg))
1264 continue;
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001265 // Add the callee-saved register as live-in. It's killed at the spill.
1266 MBB.addLiveIn(Reg);
1267 if (Reg == FPReg)
1268 // X86RegisterInfo::emitPrologue will handle spilling of frame register.
1269 continue;
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001270 CalleeFrameSize += SlotSize;
Charles Davisaff232a2011-06-12 01:45:54 +00001271 BuildMI(MBB, MI, DL, TII.get(Opc)).addReg(Reg, RegState::Kill)
1272 .setMIFlag(MachineInstr::FrameSetup);
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001273 }
1274
1275 X86FI->setCalleeSavedFrameSize(CalleeFrameSize);
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001276
1277 // Make XMM regs spilled. X86 does not have ability of push/pop XMM.
1278 // It can be done by spilling XMMs to stack frame.
1279 // Note that only Win64 ABI might spill XMMs.
1280 for (unsigned i = CSI.size(); i != 0; --i) {
1281 unsigned Reg = CSI[i-1].getReg();
1282 if (X86::GR64RegClass.contains(Reg) ||
1283 X86::GR32RegClass.contains(Reg))
1284 continue;
1285 // Add the callee-saved register as live-in. It's killed at the spill.
1286 MBB.addLiveIn(Reg);
1287 const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
1288 TII.storeRegToStackSlot(MBB, MI, Reg, true, CSI[i-1].getFrameIdx(),
1289 RC, TRI);
1290 }
1291
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001292 return true;
1293}
1294
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00001295bool X86FrameLowering::restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001296 MachineBasicBlock::iterator MI,
1297 const std::vector<CalleeSavedInfo> &CSI,
1298 const TargetRegisterInfo *TRI) const {
1299 if (CSI.empty())
1300 return false;
1301
1302 DebugLoc DL = MBB.findDebugLoc(MI);
1303
1304 MachineFunction &MF = *MBB.getParent();
1305 const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001306
1307 // Reload XMMs from stack frame.
1308 for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1309 unsigned Reg = CSI[i].getReg();
1310 if (X86::GR64RegClass.contains(Reg) ||
1311 X86::GR32RegClass.contains(Reg))
1312 continue;
1313 const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
1314 TII.loadRegFromStackSlot(MBB, MI, Reg, CSI[i].getFrameIdx(),
1315 RC, TRI);
1316 }
1317
1318 // POP GPRs.
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001319 unsigned FPReg = TRI->getFrameRegister(MF);
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001320 unsigned Opc = STI.is64Bit() ? X86::POP64r : X86::POP32r;
1321 for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
1322 unsigned Reg = CSI[i].getReg();
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001323 if (!X86::GR64RegClass.contains(Reg) &&
1324 !X86::GR32RegClass.contains(Reg))
1325 continue;
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001326 if (Reg == FPReg)
1327 // X86RegisterInfo::emitEpilogue will handle restoring of frame register.
1328 continue;
NAKAMURA Takumi419f2322011-02-27 08:47:19 +00001329 BuildMI(MBB, MI, DL, TII.get(Opc), Reg);
Anton Korobeynikovcd775ce2010-11-27 23:05:03 +00001330 }
1331 return true;
1332}
Anton Korobeynikov94c5ae02010-11-27 23:05:25 +00001333
1334void
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00001335X86FrameLowering::processFunctionBeforeCalleeSavedScan(MachineFunction &MF,
Anton Korobeynikov94c5ae02010-11-27 23:05:25 +00001336 RegScavenger *RS) const {
1337 MachineFrameInfo *MFI = MF.getFrameInfo();
1338 const X86RegisterInfo *RegInfo = TM.getRegisterInfo();
1339 unsigned SlotSize = RegInfo->getSlotSize();
1340
1341 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1342 int32_t TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
1343
1344 if (TailCallReturnAddrDelta < 0) {
1345 // create RETURNADDR area
1346 // arg
1347 // arg
1348 // RETADDR
1349 // { ...
1350 // RETADDR area
1351 // ...
1352 // }
1353 // [EBP]
1354 MFI->CreateFixedObject(-TailCallReturnAddrDelta,
1355 (-1U*SlotSize)+TailCallReturnAddrDelta, true);
1356 }
1357
1358 if (hasFP(MF)) {
1359 assert((TailCallReturnAddrDelta <= 0) &&
1360 "The Delta should always be zero or negative");
Anton Korobeynikov16c29b52011-01-10 12:39:04 +00001361 const TargetFrameLowering &TFI = *MF.getTarget().getFrameLowering();
Anton Korobeynikov94c5ae02010-11-27 23:05:25 +00001362
1363 // Create a frame entry for the EBP register that must be saved.
1364 int FrameIdx = MFI->CreateFixedObject(SlotSize,
1365 -(int)SlotSize +
1366 TFI.getOffsetOfLocalArea() +
1367 TailCallReturnAddrDelta,
1368 true);
1369 assert(FrameIdx == MFI->getObjectIndexBegin() &&
1370 "Slot for EBP register must be last in order to be found!");
Duncan Sands17001ce2011-10-18 12:44:00 +00001371 (void)FrameIdx;
Anton Korobeynikov94c5ae02010-11-27 23:05:25 +00001372 }
Chad Rosier3f0dbab2012-07-10 17:45:53 +00001373
1374 // Spill the BasePtr if it's used.
1375 if (RegInfo->hasBasePointer(MF))
1376 MF.getRegInfo().setPhysRegUsed(RegInfo->getBaseRegister());
Anton Korobeynikov94c5ae02010-11-27 23:05:25 +00001377}
Rafael Espindola76927d752011-08-30 19:39:58 +00001378
1379static bool
1380HasNestArgument(const MachineFunction *MF) {
1381 const Function *F = MF->getFunction();
1382 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1383 I != E; I++) {
1384 if (I->hasNestAttr())
1385 return true;
1386 }
1387 return false;
1388}
1389
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001390/// GetScratchRegister - Get a temp register for performing work in the
1391/// segmented stack and the Erlang/HiPE stack prologue. Depending on platform
1392/// and the properties of the function either one or two registers will be
1393/// needed. Set primary to true for the first register, false for the second.
Rafael Espindola76927d752011-08-30 19:39:58 +00001394static unsigned
Rafael Espindola2028b792012-01-11 19:00:37 +00001395GetScratchRegister(bool Is64Bit, const MachineFunction &MF, bool Primary) {
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001396 CallingConv::ID CallingConvention = MF.getFunction()->getCallingConv();
1397
1398 // Erlang stuff.
1399 if (CallingConvention == CallingConv::HiPE) {
1400 if (Is64Bit)
1401 return Primary ? X86::R14 : X86::R13;
1402 else
1403 return Primary ? X86::EBX : X86::EDI;
1404 }
1405
David Blaikie4d6ccb52012-01-20 21:51:11 +00001406 if (Is64Bit)
Rafael Espindola2028b792012-01-11 19:00:37 +00001407 return Primary ? X86::R11 : X86::R12;
Rafael Espindola76927d752011-08-30 19:39:58 +00001408
David Blaikie4d6ccb52012-01-20 21:51:11 +00001409 bool IsNested = HasNestArgument(&MF);
1410
1411 if (CallingConvention == CallingConv::X86_FastCall ||
1412 CallingConvention == CallingConv::Fast) {
1413 if (IsNested)
1414 report_fatal_error("Segmented stacks does not support fastcall with "
1415 "nested function.");
1416 return Primary ? X86::EAX : X86::ECX;
Rafael Espindola76927d752011-08-30 19:39:58 +00001417 }
David Blaikie4d6ccb52012-01-20 21:51:11 +00001418 if (IsNested)
1419 return Primary ? X86::EDX : X86::EAX;
1420 return Primary ? X86::ECX : X86::EAX;
Rafael Espindola76927d752011-08-30 19:39:58 +00001421}
1422
Sanjoy Das199ce332011-12-03 09:32:07 +00001423// The stack limit in the TCB is set to this many bytes above the actual stack
1424// limit.
1425static const uint64_t kSplitStackAvailable = 256;
1426
Rafael Espindola76927d752011-08-30 19:39:58 +00001427void
1428X86FrameLowering::adjustForSegmentedStacks(MachineFunction &MF) const {
1429 MachineBasicBlock &prologueMBB = MF.front();
1430 MachineFrameInfo *MFI = MF.getFrameInfo();
1431 const X86InstrInfo &TII = *TM.getInstrInfo();
1432 uint64_t StackSize;
1433 bool Is64Bit = STI.is64Bit();
1434 unsigned TlsReg, TlsOffset;
1435 DebugLoc DL;
Rafael Espindola76927d752011-08-30 19:39:58 +00001436
Rafael Espindola2028b792012-01-11 19:00:37 +00001437 unsigned ScratchReg = GetScratchRegister(Is64Bit, MF, true);
Rafael Espindola76927d752011-08-30 19:39:58 +00001438 assert(!MF.getRegInfo().isLiveIn(ScratchReg) &&
1439 "Scratch register is live-in");
1440
1441 if (MF.getFunction()->isVarArg())
1442 report_fatal_error("Segmented stacks do not support vararg functions.");
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001443 if (!STI.isTargetLinux() && !STI.isTargetDarwin() &&
1444 !STI.isTargetWin32() && !STI.isTargetFreeBSD())
Rafael Espindola85b9d432012-01-12 20:24:30 +00001445 report_fatal_error("Segmented stacks not supported on this platform.");
Rafael Espindola76927d752011-08-30 19:39:58 +00001446
1447 MachineBasicBlock *allocMBB = MF.CreateMachineBasicBlock();
1448 MachineBasicBlock *checkMBB = MF.CreateMachineBasicBlock();
1449 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
1450 bool IsNested = false;
1451
1452 // We need to know if the function has a nest argument only in 64 bit mode.
1453 if (Is64Bit)
1454 IsNested = HasNestArgument(&MF);
1455
Bill Wendling4e680542011-10-13 08:24:19 +00001456 // The MOV R10, RAX needs to be in a different block, since the RET we emit in
1457 // allocMBB needs to be last (terminating) instruction.
Bill Wendling4e680542011-10-13 08:24:19 +00001458
Rafael Espindola76927d752011-08-30 19:39:58 +00001459 for (MachineBasicBlock::livein_iterator i = prologueMBB.livein_begin(),
1460 e = prologueMBB.livein_end(); i != e; i++) {
1461 allocMBB->addLiveIn(*i);
1462 checkMBB->addLiveIn(*i);
1463 }
1464
1465 if (IsNested)
Rafael Espindolae840e882011-10-26 21:12:27 +00001466 allocMBB->addLiveIn(X86::R10);
1467
Rafael Espindola76927d752011-08-30 19:39:58 +00001468 MF.push_front(allocMBB);
1469 MF.push_front(checkMBB);
1470
1471 // Eventually StackSize will be calculated by a link-time pass; which will
1472 // also decide whether checking code needs to be injected into this particular
1473 // prologue.
1474 StackSize = MFI->getStackSize();
1475
Rafael Espindola2028b792012-01-11 19:00:37 +00001476 // When the frame size is less than 256 we just compare the stack
1477 // boundary directly to the value of the stack pointer, per gcc.
1478 bool CompareStackPointer = StackSize < kSplitStackAvailable;
1479
Rafael Espindola76927d752011-08-30 19:39:58 +00001480 // Read the limit off the current stacklet off the stack_guard location.
1481 if (Is64Bit) {
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001482 if (STI.isTargetLinux()) {
Rafael Espindola2028b792012-01-11 19:00:37 +00001483 TlsReg = X86::FS;
1484 TlsOffset = 0x70;
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001485 } else if (STI.isTargetDarwin()) {
Rafael Espindola2028b792012-01-11 19:00:37 +00001486 TlsReg = X86::GS;
1487 TlsOffset = 0x60 + 90*8; // See pthread_machdep.h. Steal TLS slot 90.
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001488 } else if (STI.isTargetFreeBSD()) {
Rafael Espindola85b9d432012-01-12 20:24:30 +00001489 TlsReg = X86::FS;
1490 TlsOffset = 0x18;
Rafael Espindolae4d18de2012-01-12 20:22:08 +00001491 } else {
1492 report_fatal_error("Segmented stacks not supported on this platform.");
Rafael Espindola2028b792012-01-11 19:00:37 +00001493 }
Rafael Espindola76927d752011-08-30 19:39:58 +00001494
Rafael Espindola2028b792012-01-11 19:00:37 +00001495 if (CompareStackPointer)
Sanjoy Das199ce332011-12-03 09:32:07 +00001496 ScratchReg = X86::RSP;
1497 else
1498 BuildMI(checkMBB, DL, TII.get(X86::LEA64r), ScratchReg).addReg(X86::RSP)
Rafael Espindola014f7a32012-01-11 18:14:03 +00001499 .addImm(1).addReg(0).addImm(-StackSize).addReg(0);
Sanjoy Das199ce332011-12-03 09:32:07 +00001500
Rafael Espindola76927d752011-08-30 19:39:58 +00001501 BuildMI(checkMBB, DL, TII.get(X86::CMP64rm)).addReg(ScratchReg)
Rafael Espindola014f7a32012-01-11 18:14:03 +00001502 .addReg(0).addImm(1).addReg(0).addImm(TlsOffset).addReg(TlsReg);
Rafael Espindola76927d752011-08-30 19:39:58 +00001503 } else {
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001504 if (STI.isTargetLinux()) {
Rafael Espindolae4d18de2012-01-12 20:22:08 +00001505 TlsReg = X86::GS;
1506 TlsOffset = 0x30;
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001507 } else if (STI.isTargetDarwin()) {
Rafael Espindolae4d18de2012-01-12 20:22:08 +00001508 TlsReg = X86::GS;
1509 TlsOffset = 0x48 + 90*4;
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001510 } else if (STI.isTargetWin32()) {
Rafael Espindolae4d18de2012-01-12 20:22:08 +00001511 TlsReg = X86::FS;
1512 TlsOffset = 0x14; // pvArbitrary, reserved for application use
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001513 } else if (STI.isTargetFreeBSD()) {
Rafael Espindola85b9d432012-01-12 20:24:30 +00001514 report_fatal_error("Segmented stacks not supported on FreeBSD i386.");
Rafael Espindolae4d18de2012-01-12 20:22:08 +00001515 } else {
1516 report_fatal_error("Segmented stacks not supported on this platform.");
1517 }
Rafael Espindola76927d752011-08-30 19:39:58 +00001518
Rafael Espindola2028b792012-01-11 19:00:37 +00001519 if (CompareStackPointer)
Sanjoy Das199ce332011-12-03 09:32:07 +00001520 ScratchReg = X86::ESP;
1521 else
1522 BuildMI(checkMBB, DL, TII.get(X86::LEA32r), ScratchReg).addReg(X86::ESP)
Rafael Espindola014f7a32012-01-11 18:14:03 +00001523 .addImm(1).addReg(0).addImm(-StackSize).addReg(0);
Sanjoy Das199ce332011-12-03 09:32:07 +00001524
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001525 if (STI.isTargetLinux() || STI.isTargetWin32()) {
Rafael Espindola2028b792012-01-11 19:00:37 +00001526 BuildMI(checkMBB, DL, TII.get(X86::CMP32rm)).addReg(ScratchReg)
1527 .addReg(0).addImm(0).addReg(0).addImm(TlsOffset).addReg(TlsReg);
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001528 } else if (STI.isTargetDarwin()) {
Rafael Espindola2028b792012-01-11 19:00:37 +00001529
1530 // TlsOffset doesn't fit into a mod r/m byte so we need an extra register
1531 unsigned ScratchReg2;
1532 bool SaveScratch2;
1533 if (CompareStackPointer) {
1534 // The primary scratch register is available for holding the TLS offset
1535 ScratchReg2 = GetScratchRegister(Is64Bit, MF, true);
1536 SaveScratch2 = false;
1537 } else {
1538 // Need to use a second register to hold the TLS offset
1539 ScratchReg2 = GetScratchRegister(Is64Bit, MF, false);
1540
1541 // Unfortunately, with fastcc the second scratch register may hold an arg
1542 SaveScratch2 = MF.getRegInfo().isLiveIn(ScratchReg2);
1543 }
1544
1545 // If Scratch2 is live-in then it needs to be saved
1546 assert((!MF.getRegInfo().isLiveIn(ScratchReg2) || SaveScratch2) &&
1547 "Scratch register is live-in and not saved");
1548
1549 if (SaveScratch2)
1550 BuildMI(checkMBB, DL, TII.get(X86::PUSH32r))
1551 .addReg(ScratchReg2, RegState::Kill);
1552
1553 BuildMI(checkMBB, DL, TII.get(X86::MOV32ri), ScratchReg2)
1554 .addImm(TlsOffset);
1555 BuildMI(checkMBB, DL, TII.get(X86::CMP32rm))
1556 .addReg(ScratchReg)
1557 .addReg(ScratchReg2).addImm(1).addReg(0)
1558 .addImm(0)
1559 .addReg(TlsReg);
1560
1561 if (SaveScratch2)
1562 BuildMI(checkMBB, DL, TII.get(X86::POP32r), ScratchReg2);
1563 }
Rafael Espindola76927d752011-08-30 19:39:58 +00001564 }
1565
1566 // This jump is taken if SP >= (Stacklet Limit + Stack Space required).
1567 // It jumps to normal execution of the function body.
Rafael Espindola313c7032012-01-11 18:23:35 +00001568 BuildMI(checkMBB, DL, TII.get(X86::JA_4)).addMBB(&prologueMBB);
Rafael Espindola76927d752011-08-30 19:39:58 +00001569
1570 // On 32 bit we first push the arguments size and then the frame size. On 64
1571 // bit, we pass the stack frame size in r10 and the argument size in r11.
1572 if (Is64Bit) {
1573 // Functions with nested arguments use R10, so it needs to be saved across
1574 // the call to _morestack
1575
1576 if (IsNested)
1577 BuildMI(allocMBB, DL, TII.get(X86::MOV64rr), X86::RAX).addReg(X86::R10);
1578
1579 BuildMI(allocMBB, DL, TII.get(X86::MOV64ri), X86::R10)
1580 .addImm(StackSize);
1581 BuildMI(allocMBB, DL, TII.get(X86::MOV64ri), X86::R11)
1582 .addImm(X86FI->getArgumentStackSize());
1583 MF.getRegInfo().setPhysRegUsed(X86::R10);
1584 MF.getRegInfo().setPhysRegUsed(X86::R11);
1585 } else {
Rafael Espindola76927d752011-08-30 19:39:58 +00001586 BuildMI(allocMBB, DL, TII.get(X86::PUSHi32))
1587 .addImm(X86FI->getArgumentStackSize());
1588 BuildMI(allocMBB, DL, TII.get(X86::PUSHi32))
1589 .addImm(StackSize);
1590 }
1591
1592 // __morestack is in libgcc
1593 if (Is64Bit)
1594 BuildMI(allocMBB, DL, TII.get(X86::CALL64pcrel32))
1595 .addExternalSymbol("__morestack");
1596 else
1597 BuildMI(allocMBB, DL, TII.get(X86::CALLpcrel32))
1598 .addExternalSymbol("__morestack");
1599
Bill Wendling4e680542011-10-13 08:24:19 +00001600 if (IsNested)
Rafael Espindolae840e882011-10-26 21:12:27 +00001601 BuildMI(allocMBB, DL, TII.get(X86::MORESTACK_RET_RESTORE_R10));
1602 else
1603 BuildMI(allocMBB, DL, TII.get(X86::MORESTACK_RET));
Bill Wendling4e680542011-10-13 08:24:19 +00001604
Rafael Espindolae840e882011-10-26 21:12:27 +00001605 allocMBB->addSuccessor(&prologueMBB);
Bill Wendling4e680542011-10-13 08:24:19 +00001606
Rafael Espindola76927d752011-08-30 19:39:58 +00001607 checkMBB->addSuccessor(allocMBB);
1608 checkMBB->addSuccessor(&prologueMBB);
1609
Jakob Stoklund Olesen51f0c762011-09-24 01:11:19 +00001610#ifdef XDEBUG
Rafael Espindola76927d752011-08-30 19:39:58 +00001611 MF.verify();
1612#endif
1613}
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001614
Yiannis Tsiouris2d1035d2013-02-28 16:59:10 +00001615/// Erlang programs may need a special prologue to handle the stack size they
1616/// might need at runtime. That is because Erlang/OTP does not implement a C
1617/// stack but uses a custom implementation of hybrid stack/heap architecture.
1618/// (for more information see Eric Stenman's Ph.D. thesis:
1619/// http://publications.uu.se/uu/fulltext/nbn_se_uu_diva-2688.pdf)
1620///
1621/// CheckStack:
1622/// temp0 = sp - MaxStack
1623/// if( temp0 < SP_LIMIT(P) ) goto IncStack else goto OldStart
1624/// OldStart:
1625/// ...
1626/// IncStack:
1627/// call inc_stack # doubles the stack space
1628/// temp0 = sp - MaxStack
1629/// if( temp0 < SP_LIMIT(P) ) goto IncStack else goto OldStart
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001630void X86FrameLowering::adjustForHiPEPrologue(MachineFunction &MF) const {
1631 const X86InstrInfo &TII = *TM.getInstrInfo();
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001632 MachineFrameInfo *MFI = MF.getFrameInfo();
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001633 const unsigned SlotSize = TM.getRegisterInfo()->getSlotSize();
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001634 const bool Is64Bit = STI.is64Bit();
1635 DebugLoc DL;
1636 // HiPE-specific values
1637 const unsigned HipeLeafWords = 24;
1638 const unsigned CCRegisteredArgs = Is64Bit ? 6 : 5;
1639 const unsigned Guaranteed = HipeLeafWords * SlotSize;
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001640 unsigned CallerStkArity = MF.getFunction()->arg_size() > CCRegisteredArgs ?
1641 MF.getFunction()->arg_size() - CCRegisteredArgs : 0;
1642 unsigned MaxStack = MFI->getStackSize() + CallerStkArity*SlotSize + SlotSize;
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001643
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001644 assert(STI.isTargetLinux() &&
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001645 "HiPE prologue is only supported on Linux operating systems.");
1646
1647 // Compute the largest caller's frame that is needed to fit the callees'
1648 // frames. This 'MaxStack' is computed from:
1649 //
1650 // a) the fixed frame size, which is the space needed for all spilled temps,
1651 // b) outgoing on-stack parameter areas, and
1652 // c) the minimum stack space this function needs to make available for the
1653 // functions it calls (a tunable ABI property).
1654 if (MFI->hasCalls()) {
1655 unsigned MoreStackForCalls = 0;
1656
1657 for (MachineFunction::iterator MBBI = MF.begin(), MBBE = MF.end();
1658 MBBI != MBBE; ++MBBI)
1659 for (MachineBasicBlock::iterator MI = MBBI->begin(), ME = MBBI->end();
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001660 MI != ME; ++MI) {
1661 if (!MI->isCall())
1662 continue;
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001663
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001664 // Get callee operand.
1665 const MachineOperand &MO = MI->getOperand(0);
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001666
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001667 // Only take account of global function calls (no closures etc.).
1668 if (!MO.isGlobal())
1669 continue;
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001670
Benjamin Kramerb1e1d5d2013-02-19 17:32:57 +00001671 const Function *F = dyn_cast<Function>(MO.getGlobal());
1672 if (!F)
1673 continue;
1674
1675 // Do not update 'MaxStack' for primitive and built-in functions
1676 // (encoded with names either starting with "erlang."/"bif_" or not
1677 // having a ".", such as a simple <Module>.<Function>.<Arity>, or an
1678 // "_", such as the BIF "suspend_0") as they are executed on another
1679 // stack.
1680 if (F->getName().find("erlang.") != StringRef::npos ||
1681 F->getName().find("bif_") != StringRef::npos ||
1682 F->getName().find_first_of("._") == StringRef::npos)
1683 continue;
1684
1685 unsigned CalleeStkArity =
1686 F->arg_size() > CCRegisteredArgs ? F->arg_size()-CCRegisteredArgs : 0;
1687 if (HipeLeafWords - 1 > CalleeStkArity)
1688 MoreStackForCalls = std::max(MoreStackForCalls,
1689 (HipeLeafWords - 1 - CalleeStkArity) * SlotSize);
1690 }
Benjamin Kramer98fbe272013-02-18 20:55:12 +00001691 MaxStack += MoreStackForCalls;
1692 }
1693
1694 // If the stack frame needed is larger than the guaranteed then runtime checks
1695 // and calls to "inc_stack_0" BIF should be inserted in the assembly prologue.
1696 if (MaxStack > Guaranteed) {
1697 MachineBasicBlock &prologueMBB = MF.front();
1698 MachineBasicBlock *stackCheckMBB = MF.CreateMachineBasicBlock();
1699 MachineBasicBlock *incStackMBB = MF.CreateMachineBasicBlock();
1700
1701 for (MachineBasicBlock::livein_iterator I = prologueMBB.livein_begin(),
1702 E = prologueMBB.livein_end(); I != E; I++) {
1703 stackCheckMBB->addLiveIn(*I);
1704 incStackMBB->addLiveIn(*I);
1705 }
1706
1707 MF.push_front(incStackMBB);
1708 MF.push_front(stackCheckMBB);
1709
1710 unsigned ScratchReg, SPReg, PReg, SPLimitOffset;
1711 unsigned LEAop, CMPop, CALLop;
1712 if (Is64Bit) {
1713 SPReg = X86::RSP;
1714 PReg = X86::RBP;
1715 LEAop = X86::LEA64r;
1716 CMPop = X86::CMP64rm;
1717 CALLop = X86::CALL64pcrel32;
1718 SPLimitOffset = 0x90;
1719 } else {
1720 SPReg = X86::ESP;
1721 PReg = X86::EBP;
1722 LEAop = X86::LEA32r;
1723 CMPop = X86::CMP32rm;
1724 CALLop = X86::CALLpcrel32;
1725 SPLimitOffset = 0x4c;
1726 }
1727
1728 ScratchReg = GetScratchRegister(Is64Bit, MF, true);
1729 assert(!MF.getRegInfo().isLiveIn(ScratchReg) &&
1730 "HiPE prologue scratch register is live-in");
1731
1732 // Create new MBB for StackCheck:
1733 addRegOffset(BuildMI(stackCheckMBB, DL, TII.get(LEAop), ScratchReg),
1734 SPReg, false, -MaxStack);
1735 // SPLimitOffset is in a fixed heap location (pointed by BP).
1736 addRegOffset(BuildMI(stackCheckMBB, DL, TII.get(CMPop))
1737 .addReg(ScratchReg), PReg, false, SPLimitOffset);
1738 BuildMI(stackCheckMBB, DL, TII.get(X86::JAE_4)).addMBB(&prologueMBB);
1739
1740 // Create new MBB for IncStack:
1741 BuildMI(incStackMBB, DL, TII.get(CALLop)).
1742 addExternalSymbol("inc_stack_0");
1743 addRegOffset(BuildMI(incStackMBB, DL, TII.get(LEAop), ScratchReg),
1744 SPReg, false, -MaxStack);
1745 addRegOffset(BuildMI(incStackMBB, DL, TII.get(CMPop))
1746 .addReg(ScratchReg), PReg, false, SPLimitOffset);
1747 BuildMI(incStackMBB, DL, TII.get(X86::JLE_4)).addMBB(incStackMBB);
1748
1749 stackCheckMBB->addSuccessor(&prologueMBB, 99);
1750 stackCheckMBB->addSuccessor(incStackMBB, 1);
1751 incStackMBB->addSuccessor(&prologueMBB, 99);
1752 incStackMBB->addSuccessor(incStackMBB, 1);
1753 }
1754#ifdef XDEBUG
1755 MF.verify();
1756#endif
1757}
Eli Bendersky700ed802013-02-21 20:05:00 +00001758
1759void X86FrameLowering::
1760eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
1761 MachineBasicBlock::iterator I) const {
1762 const X86InstrInfo &TII = *TM.getInstrInfo();
1763 const X86RegisterInfo &RegInfo = *TM.getRegisterInfo();
1764 unsigned StackPtr = RegInfo.getStackRegister();
1765 bool reseveCallFrame = hasReservedCallFrame(MF);
1766 int Opcode = I->getOpcode();
1767 bool isDestroy = Opcode == TII.getCallFrameDestroyOpcode();
1768 bool IsLP64 = STI.isTarget64BitLP64();
1769 DebugLoc DL = I->getDebugLoc();
1770 uint64_t Amount = !reseveCallFrame ? I->getOperand(0).getImm() : 0;
1771 uint64_t CalleeAmt = isDestroy ? I->getOperand(1).getImm() : 0;
1772 I = MBB.erase(I);
1773
1774 if (!reseveCallFrame) {
1775 // If the stack pointer can be changed after prologue, turn the
1776 // adjcallstackup instruction into a 'sub ESP, <amt>' and the
1777 // adjcallstackdown instruction into 'add ESP, <amt>'
1778 // TODO: consider using push / pop instead of sub + store / add
1779 if (Amount == 0)
1780 return;
1781
1782 // We need to keep the stack aligned properly. To do this, we round the
1783 // amount of space needed for the outgoing arguments up to the next
1784 // alignment boundary.
1785 unsigned StackAlign = TM.getFrameLowering()->getStackAlignment();
1786 Amount = (Amount + StackAlign - 1) / StackAlign * StackAlign;
1787
1788 MachineInstr *New = 0;
1789 if (Opcode == TII.getCallFrameSetupOpcode()) {
1790 New = BuildMI(MF, DL, TII.get(getSUBriOpcode(IsLP64, Amount)),
1791 StackPtr)
1792 .addReg(StackPtr)
1793 .addImm(Amount);
1794 } else {
1795 assert(Opcode == TII.getCallFrameDestroyOpcode());
1796
1797 // Factor out the amount the callee already popped.
1798 Amount -= CalleeAmt;
1799
1800 if (Amount) {
1801 unsigned Opc = getADDriOpcode(IsLP64, Amount);
1802 New = BuildMI(MF, DL, TII.get(Opc), StackPtr)
1803 .addReg(StackPtr).addImm(Amount);
1804 }
1805 }
1806
1807 if (New) {
1808 // The EFLAGS implicit def is dead.
1809 New->getOperand(3).setIsDead();
1810
1811 // Replace the pseudo instruction with a new instruction.
1812 MBB.insert(I, New);
1813 }
1814
1815 return;
1816 }
1817
1818 if (Opcode == TII.getCallFrameDestroyOpcode() && CalleeAmt) {
1819 // If we are performing frame pointer elimination and if the callee pops
1820 // something off the stack pointer, add it back. We do this until we have
1821 // more advanced stack pointer tracking ability.
1822 unsigned Opc = getSUBriOpcode(IsLP64, CalleeAmt);
1823 MachineInstr *New = BuildMI(MF, DL, TII.get(Opc), StackPtr)
1824 .addReg(StackPtr).addImm(CalleeAmt);
1825
1826 // The EFLAGS implicit def is dead.
1827 New->getOperand(3).setIsDead();
1828
1829 // We are not tracking the stack pointer adjustment by the callee, so make
1830 // sure we restore the stack pointer immediately after the call, there may
1831 // be spill code inserted between the CALL and ADJCALLSTACKUP instructions.
1832 MachineBasicBlock::iterator B = MBB.begin();
1833 while (I != B && !llvm::prior(I)->isCall())
1834 --I;
1835 MBB.insert(I, New);
1836 }
1837}
1838