1 //===- X86RegisterInfo.cpp - X86 Register Information -----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains the X86 implementation of the TargetRegisterInfo class.
11 // This file is responsible for the frame pointer elimination optimization
14 //===----------------------------------------------------------------------===//
17 #include "X86RegisterInfo.h"
18 #include "X86InstrBuilder.h"
19 #include "X86MachineFunctionInfo.h"
20 #include "X86Subtarget.h"
21 #include "X86TargetMachine.h"
22 #include "llvm/Constants.h"
23 #include "llvm/Function.h"
24 #include "llvm/Type.h"
25 #include "llvm/CodeGen/ValueTypes.h"
26 #include "llvm/CodeGen/MachineInstrBuilder.h"
27 #include "llvm/CodeGen/MachineFunction.h"
28 #include "llvm/CodeGen/MachineFunctionPass.h"
29 #include "llvm/CodeGen/MachineFrameInfo.h"
30 #include "llvm/CodeGen/MachineLocation.h"
31 #include "llvm/CodeGen/MachineModuleInfo.h"
32 #include "llvm/CodeGen/MachineRegisterInfo.h"
33 #include "llvm/Target/TargetAsmInfo.h"
34 #include "llvm/Target/TargetFrameInfo.h"
35 #include "llvm/Target/TargetInstrInfo.h"
36 #include "llvm/Target/TargetMachine.h"
37 #include "llvm/Target/TargetOptions.h"
38 #include "llvm/ADT/BitVector.h"
39 #include "llvm/ADT/STLExtras.h"
40 #include "llvm/Support/Compiler.h"
43 X86RegisterInfo::X86RegisterInfo(X86TargetMachine &tm,
44 const TargetInstrInfo &tii)
45 : X86GenRegisterInfo(tm.getSubtarget<X86Subtarget>().is64Bit() ?
46 X86::ADJCALLSTACKDOWN64 :
47 X86::ADJCALLSTACKDOWN32,
48 tm.getSubtarget<X86Subtarget>().is64Bit() ?
49 X86::ADJCALLSTACKUP64 :
50 X86::ADJCALLSTACKUP32),
52 // Cache some information.
53 const X86Subtarget *Subtarget = &TM.getSubtarget<X86Subtarget>();
54 Is64Bit = Subtarget->is64Bit();
55 IsWin64 = Subtarget->isTargetWin64();
56 StackAlign = TM.getFrameInfo()->getStackAlignment();
68 // getDwarfRegNum - This function maps LLVM register identifiers to the
69 // Dwarf specific numbering, used in debug info and exception tables.
71 int X86RegisterInfo::getDwarfRegNum(unsigned RegNo, bool isEH) const {
72 const X86Subtarget *Subtarget = &TM.getSubtarget<X86Subtarget>();
73 unsigned Flavour = DWARFFlavour::X86_64;
74 if (!Subtarget->is64Bit()) {
75 if (Subtarget->isTargetDarwin()) {
77 Flavour = DWARFFlavour::X86_32_DarwinEH;
79 Flavour = DWARFFlavour::X86_32_Generic;
80 } else if (Subtarget->isTargetCygMing()) {
81 // Unsupported by now, just quick fallback
82 Flavour = DWARFFlavour::X86_32_Generic;
84 Flavour = DWARFFlavour::X86_32_Generic;
88 return X86GenRegisterInfo::getDwarfRegNumFull(RegNo, Flavour);
91 // getX86RegNum - This function maps LLVM register identifiers to their X86
92 // specific numbering, which is used in various places encoding instructions.
94 unsigned X86RegisterInfo::getX86RegNum(unsigned RegNo) {
96 case X86::RAX: case X86::EAX: case X86::AX: case X86::AL: return N86::EAX;
97 case X86::RCX: case X86::ECX: case X86::CX: case X86::CL: return N86::ECX;
98 case X86::RDX: case X86::EDX: case X86::DX: case X86::DL: return N86::EDX;
99 case X86::RBX: case X86::EBX: case X86::BX: case X86::BL: return N86::EBX;
100 case X86::RSP: case X86::ESP: case X86::SP: case X86::SPL: case X86::AH:
102 case X86::RBP: case X86::EBP: case X86::BP: case X86::BPL: case X86::CH:
104 case X86::RSI: case X86::ESI: case X86::SI: case X86::SIL: case X86::DH:
106 case X86::RDI: case X86::EDI: case X86::DI: case X86::DIL: case X86::BH:
109 case X86::R8: case X86::R8D: case X86::R8W: case X86::R8B:
111 case X86::R9: case X86::R9D: case X86::R9W: case X86::R9B:
113 case X86::R10: case X86::R10D: case X86::R10W: case X86::R10B:
115 case X86::R11: case X86::R11D: case X86::R11W: case X86::R11B:
117 case X86::R12: case X86::R12D: case X86::R12W: case X86::R12B:
119 case X86::R13: case X86::R13D: case X86::R13W: case X86::R13B:
121 case X86::R14: case X86::R14D: case X86::R14W: case X86::R14B:
123 case X86::R15: case X86::R15D: case X86::R15W: case X86::R15B:
126 case X86::ST0: case X86::ST1: case X86::ST2: case X86::ST3:
127 case X86::ST4: case X86::ST5: case X86::ST6: case X86::ST7:
128 return RegNo-X86::ST0;
130 case X86::XMM0: case X86::XMM8: case X86::MM0:
132 case X86::XMM1: case X86::XMM9: case X86::MM1:
134 case X86::XMM2: case X86::XMM10: case X86::MM2:
136 case X86::XMM3: case X86::XMM11: case X86::MM3:
138 case X86::XMM4: case X86::XMM12: case X86::MM4:
140 case X86::XMM5: case X86::XMM13: case X86::MM5:
142 case X86::XMM6: case X86::XMM14: case X86::MM6:
144 case X86::XMM7: case X86::XMM15: case X86::MM7:
148 assert(isVirtualRegister(RegNo) && "Unknown physical register!");
149 assert(0 && "Register allocator hasn't allocated reg correctly yet!");
154 const TargetRegisterClass *
155 X86RegisterInfo::getCrossCopyRegClass(const TargetRegisterClass *RC) const {
156 if (RC == &X86::CCRRegClass) {
158 return &X86::GR64RegClass;
160 return &X86::GR32RegClass;
166 X86RegisterInfo::getCalleeSavedRegs(const MachineFunction *MF) const {
167 bool callsEHReturn = false;
170 const MachineFrameInfo *MFI = MF->getFrameInfo();
171 const MachineModuleInfo *MMI = MFI->getMachineModuleInfo();
172 callsEHReturn = (MMI ? MMI->callsEHReturn() : false);
175 static const unsigned CalleeSavedRegs32Bit[] = {
176 X86::ESI, X86::EDI, X86::EBX, X86::EBP, 0
179 static const unsigned CalleeSavedRegs32EHRet[] = {
180 X86::EAX, X86::EDX, X86::ESI, X86::EDI, X86::EBX, X86::EBP, 0
183 static const unsigned CalleeSavedRegs64Bit[] = {
184 X86::RBX, X86::R12, X86::R13, X86::R14, X86::R15, X86::RBP, 0
187 static const unsigned CalleeSavedRegs64EHRet[] = {
188 X86::RAX, X86::RDX, X86::RBX, X86::R12,
189 X86::R13, X86::R14, X86::R15, X86::RBP, 0
192 static const unsigned CalleeSavedRegsWin64[] = {
193 X86::RBX, X86::RBP, X86::RDI, X86::RSI,
194 X86::R12, X86::R13, X86::R14, X86::R15,
195 X86::XMM6, X86::XMM7, X86::XMM8, X86::XMM9,
196 X86::XMM10, X86::XMM11, X86::XMM12, X86::XMM13,
197 X86::XMM14, X86::XMM15, 0
202 return CalleeSavedRegsWin64;
204 return (callsEHReturn ? CalleeSavedRegs64EHRet : CalleeSavedRegs64Bit);
206 return (callsEHReturn ? CalleeSavedRegs32EHRet : CalleeSavedRegs32Bit);
210 const TargetRegisterClass* const*
211 X86RegisterInfo::getCalleeSavedRegClasses(const MachineFunction *MF) const {
212 bool callsEHReturn = false;
215 const MachineFrameInfo *MFI = MF->getFrameInfo();
216 const MachineModuleInfo *MMI = MFI->getMachineModuleInfo();
217 callsEHReturn = (MMI ? MMI->callsEHReturn() : false);
220 static const TargetRegisterClass * const CalleeSavedRegClasses32Bit[] = {
221 &X86::GR32RegClass, &X86::GR32RegClass,
222 &X86::GR32RegClass, &X86::GR32RegClass, 0
224 static const TargetRegisterClass * const CalleeSavedRegClasses32EHRet[] = {
225 &X86::GR32RegClass, &X86::GR32RegClass,
226 &X86::GR32RegClass, &X86::GR32RegClass,
227 &X86::GR32RegClass, &X86::GR32RegClass, 0
229 static const TargetRegisterClass * const CalleeSavedRegClasses64Bit[] = {
230 &X86::GR64RegClass, &X86::GR64RegClass,
231 &X86::GR64RegClass, &X86::GR64RegClass,
232 &X86::GR64RegClass, &X86::GR64RegClass, 0
234 static const TargetRegisterClass * const CalleeSavedRegClasses64EHRet[] = {
235 &X86::GR64RegClass, &X86::GR64RegClass,
236 &X86::GR64RegClass, &X86::GR64RegClass,
237 &X86::GR64RegClass, &X86::GR64RegClass,
238 &X86::GR64RegClass, &X86::GR64RegClass, 0
240 static const TargetRegisterClass * const CalleeSavedRegClassesWin64[] = {
241 &X86::GR64RegClass, &X86::GR64RegClass,
242 &X86::GR64RegClass, &X86::GR64RegClass,
243 &X86::GR64RegClass, &X86::GR64RegClass,
244 &X86::GR64RegClass, &X86::GR64RegClass,
245 &X86::VR128RegClass, &X86::VR128RegClass,
246 &X86::VR128RegClass, &X86::VR128RegClass,
247 &X86::VR128RegClass, &X86::VR128RegClass,
248 &X86::VR128RegClass, &X86::VR128RegClass,
249 &X86::VR128RegClass, &X86::VR128RegClass, 0
254 return CalleeSavedRegClassesWin64;
256 return (callsEHReturn ?
257 CalleeSavedRegClasses64EHRet : CalleeSavedRegClasses64Bit);
259 return (callsEHReturn ?
260 CalleeSavedRegClasses32EHRet : CalleeSavedRegClasses32Bit);
264 BitVector X86RegisterInfo::getReservedRegs(const MachineFunction &MF) const {
265 BitVector Reserved(getNumRegs());
266 // Set the stack-pointer register and its aliases as reserved.
267 Reserved.set(X86::RSP);
268 Reserved.set(X86::ESP);
269 Reserved.set(X86::SP);
270 Reserved.set(X86::SPL);
271 // Set the frame-pointer register and its aliases as reserved if needed.
273 Reserved.set(X86::RBP);
274 Reserved.set(X86::EBP);
275 Reserved.set(X86::BP);
276 Reserved.set(X86::BPL);
278 // Mark the x87 stack registers as reserved, since they don't
279 // behave normally with respect to liveness. We don't fully
280 // model the effects of x87 stack pushes and pops after
282 Reserved.set(X86::ST0);
283 Reserved.set(X86::ST1);
284 Reserved.set(X86::ST2);
285 Reserved.set(X86::ST3);
286 Reserved.set(X86::ST4);
287 Reserved.set(X86::ST5);
288 Reserved.set(X86::ST6);
289 Reserved.set(X86::ST7);
293 //===----------------------------------------------------------------------===//
294 // Stack Frame Processing methods
295 //===----------------------------------------------------------------------===//
297 static unsigned calculateMaxStackAlignment(const MachineFrameInfo *FFI) {
298 unsigned MaxAlign = 0;
299 for (int i = FFI->getObjectIndexBegin(),
300 e = FFI->getObjectIndexEnd(); i != e; ++i) {
301 if (FFI->isDeadObjectIndex(i))
303 unsigned Align = FFI->getObjectAlignment(i);
304 MaxAlign = std::max(MaxAlign, Align);
310 // hasFP - Return true if the specified function should have a dedicated frame
311 // pointer register. This is true if the function has variable sized allocas or
312 // if frame pointer elimination is disabled.
314 bool X86RegisterInfo::hasFP(const MachineFunction &MF) const {
315 const MachineFrameInfo *MFI = MF.getFrameInfo();
316 const MachineModuleInfo *MMI = MFI->getMachineModuleInfo();
318 return (NoFramePointerElim ||
319 needsStackRealignment(MF) ||
320 MFI->hasVarSizedObjects() ||
321 MFI->isFrameAddressTaken() ||
322 MF.getInfo<X86MachineFunctionInfo>()->getForceFramePointer() ||
323 (MMI && MMI->callsUnwindInit()));
326 bool X86RegisterInfo::needsStackRealignment(const MachineFunction &MF) const {
327 const MachineFrameInfo *MFI = MF.getFrameInfo();;
329 // FIXME: Currently we don't support stack realignment for functions with
330 // variable-sized allocas
331 return (RealignStack &&
332 (MFI->getMaxAlignment() > StackAlign &&
333 !MFI->hasVarSizedObjects()));
336 bool X86RegisterInfo::hasReservedCallFrame(MachineFunction &MF) const {
337 return !MF.getFrameInfo()->hasVarSizedObjects();
341 X86RegisterInfo::getFrameIndexOffset(MachineFunction &MF, int FI) const {
342 int Offset = MF.getFrameInfo()->getObjectOffset(FI) + SlotSize;
343 uint64_t StackSize = MF.getFrameInfo()->getStackSize();
345 if (needsStackRealignment(MF)) {
347 // Skip the saved EBP
350 unsigned Align = MF.getFrameInfo()->getObjectAlignment(FI);
351 assert( (-(Offset + StackSize)) % Align == 0);
353 return Offset + StackSize;
356 // FIXME: Support tail calls
359 return Offset + StackSize;
361 // Skip the saved EBP
364 // Skip the RETADDR move area
365 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
366 int TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
367 if (TailCallReturnAddrDelta < 0) Offset -= TailCallReturnAddrDelta;
373 void X86RegisterInfo::
374 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
375 MachineBasicBlock::iterator I) const {
376 if (!hasReservedCallFrame(MF)) {
377 // If the stack pointer can be changed after prologue, turn the
378 // adjcallstackup instruction into a 'sub ESP, <amt>' and the
379 // adjcallstackdown instruction into 'add ESP, <amt>'
380 // TODO: consider using push / pop instead of sub + store / add
381 MachineInstr *Old = I;
382 uint64_t Amount = Old->getOperand(0).getImm();
384 // We need to keep the stack aligned properly. To do this, we round the
385 // amount of space needed for the outgoing arguments up to the next
386 // alignment boundary.
387 Amount = (Amount+StackAlign-1)/StackAlign*StackAlign;
389 MachineInstr *New = 0;
390 if (Old->getOpcode() == getCallFrameSetupOpcode()) {
391 New = BuildMI(MF, TII.get(Is64Bit ? X86::SUB64ri32 : X86::SUB32ri),
392 StackPtr).addReg(StackPtr).addImm(Amount);
394 assert(Old->getOpcode() == getCallFrameDestroyOpcode());
395 // factor out the amount the callee already popped.
396 uint64_t CalleeAmt = Old->getOperand(1).getImm();
399 unsigned Opc = (Amount < 128) ?
400 (Is64Bit ? X86::ADD64ri8 : X86::ADD32ri8) :
401 (Is64Bit ? X86::ADD64ri32 : X86::ADD32ri);
402 New = BuildMI(MF, TII.get(Opc), StackPtr)
403 .addReg(StackPtr).addImm(Amount);
407 // The EFLAGS implicit def is dead.
408 New->getOperand(3).setIsDead();
410 // Replace the pseudo instruction with a new instruction...
411 if (New) MBB.insert(I, New);
413 } else if (I->getOpcode() == getCallFrameDestroyOpcode()) {
414 // If we are performing frame pointer elimination and if the callee pops
415 // something off the stack pointer, add it back. We do this until we have
416 // more advanced stack pointer tracking ability.
417 if (uint64_t CalleeAmt = I->getOperand(1).getImm()) {
418 unsigned Opc = (CalleeAmt < 128) ?
419 (Is64Bit ? X86::SUB64ri8 : X86::SUB32ri8) :
420 (Is64Bit ? X86::SUB64ri32 : X86::SUB32ri);
422 BuildMI(MF, TII.get(Opc), StackPtr).addReg(StackPtr).addImm(CalleeAmt);
423 // The EFLAGS implicit def is dead.
424 New->getOperand(3).setIsDead();
433 void X86RegisterInfo::eliminateFrameIndex(MachineBasicBlock::iterator II,
434 int SPAdj, RegScavenger *RS) const{
435 assert(SPAdj == 0 && "Unexpected");
438 MachineInstr &MI = *II;
439 MachineFunction &MF = *MI.getParent()->getParent();
440 while (!MI.getOperand(i).isFI()) {
442 assert(i < MI.getNumOperands() && "Instr doesn't have FrameIndex operand!");
445 int FrameIndex = MI.getOperand(i).getIndex();
448 if (needsStackRealignment(MF))
449 BasePtr = (FrameIndex < 0 ? FramePtr : StackPtr);
451 BasePtr = (hasFP(MF) ? FramePtr : StackPtr);
453 // This must be part of a four operand memory reference. Replace the
454 // FrameIndex with base register with EBP. Add an offset to the offset.
455 MI.getOperand(i).ChangeToRegister(BasePtr, false);
457 // Now add the frame object offset to the offset from EBP. Offset is a
459 int Offset = getFrameIndexOffset(MF, FrameIndex) +
460 (int)(MI.getOperand(i+3).getImm());
462 MI.getOperand(i+3).ChangeToImmediate(Offset);
466 X86RegisterInfo::processFunctionBeforeCalleeSavedScan(MachineFunction &MF,
467 RegScavenger *RS) const {
468 MachineFrameInfo *FFI = MF.getFrameInfo();
470 // Calculate and set max stack object alignment early, so we can decide
471 // whether we will need stack realignment (and thus FP).
472 unsigned MaxAlign = std::max(FFI->getMaxAlignment(),
473 calculateMaxStackAlignment(FFI));
475 FFI->setMaxAlignment(MaxAlign);
479 X86RegisterInfo::processFunctionBeforeFrameFinalized(MachineFunction &MF) const{
480 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
481 int32_t TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
482 if (TailCallReturnAddrDelta < 0) {
483 // create RETURNADDR area
493 CreateFixedObject(-TailCallReturnAddrDelta,
494 (-1*SlotSize)+TailCallReturnAddrDelta);
497 assert((TailCallReturnAddrDelta <= 0) &&
498 "The Delta should always be zero or negative");
499 // Create a frame entry for the EBP register that must be saved.
500 int FrameIdx = MF.getFrameInfo()->CreateFixedObject(SlotSize,
502 TailCallReturnAddrDelta);
503 assert(FrameIdx == MF.getFrameInfo()->getObjectIndexBegin() &&
504 "Slot for EBP register must be last in order to be found!");
509 /// emitSPUpdate - Emit a series of instructions to increment / decrement the
510 /// stack pointer by a constant value.
512 void emitSPUpdate(MachineBasicBlock &MBB, MachineBasicBlock::iterator &MBBI,
513 unsigned StackPtr, int64_t NumBytes, bool Is64Bit,
514 const TargetInstrInfo &TII) {
515 bool isSub = NumBytes < 0;
516 uint64_t Offset = isSub ? -NumBytes : NumBytes;
519 (Is64Bit ? X86::SUB64ri8 : X86::SUB32ri8) :
520 (Is64Bit ? X86::SUB64ri32 : X86::SUB32ri))
522 (Is64Bit ? X86::ADD64ri8 : X86::ADD32ri8) :
523 (Is64Bit ? X86::ADD64ri32 : X86::ADD32ri));
524 uint64_t Chunk = (1LL << 31) - 1;
527 uint64_t ThisVal = (Offset > Chunk) ? Chunk : Offset;
529 BuildMI(MBB, MBBI, TII.get(Opc), StackPtr).addReg(StackPtr).addImm(ThisVal);
530 // The EFLAGS implicit def is dead.
531 MI->getOperand(3).setIsDead();
536 // mergeSPUpdatesUp - Merge two stack-manipulating instructions upper iterator.
538 void mergeSPUpdatesUp(MachineBasicBlock &MBB, MachineBasicBlock::iterator &MBBI,
539 unsigned StackPtr, uint64_t *NumBytes = NULL) {
540 if (MBBI == MBB.begin()) return;
542 MachineBasicBlock::iterator PI = prior(MBBI);
543 unsigned Opc = PI->getOpcode();
544 if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
545 Opc == X86::ADD32ri || Opc == X86::ADD32ri8) &&
546 PI->getOperand(0).getReg() == StackPtr) {
548 *NumBytes += PI->getOperand(2).getImm();
550 } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
551 Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
552 PI->getOperand(0).getReg() == StackPtr) {
554 *NumBytes -= PI->getOperand(2).getImm();
559 // mergeSPUpdatesUp - Merge two stack-manipulating instructions lower iterator.
561 void mergeSPUpdatesDown(MachineBasicBlock &MBB,
562 MachineBasicBlock::iterator &MBBI,
563 unsigned StackPtr, uint64_t *NumBytes = NULL) {
566 if (MBBI == MBB.end()) return;
568 MachineBasicBlock::iterator NI = next(MBBI);
569 if (NI == MBB.end()) return;
571 unsigned Opc = NI->getOpcode();
572 if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
573 Opc == X86::ADD32ri || Opc == X86::ADD32ri8) &&
574 NI->getOperand(0).getReg() == StackPtr) {
576 *NumBytes -= NI->getOperand(2).getImm();
579 } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
580 Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
581 NI->getOperand(0).getReg() == StackPtr) {
583 *NumBytes += NI->getOperand(2).getImm();
589 /// mergeSPUpdates - Checks the instruction before/after the passed
590 /// instruction. If it is an ADD/SUB instruction it is deleted
591 /// argument and the stack adjustment is returned as a positive value for ADD
592 /// and a negative for SUB.
593 static int mergeSPUpdates(MachineBasicBlock &MBB,
594 MachineBasicBlock::iterator &MBBI,
596 bool doMergeWithPrevious) {
598 if ((doMergeWithPrevious && MBBI == MBB.begin()) ||
599 (!doMergeWithPrevious && MBBI == MBB.end()))
604 MachineBasicBlock::iterator PI = doMergeWithPrevious ? prior(MBBI) : MBBI;
605 MachineBasicBlock::iterator NI = doMergeWithPrevious ? 0 : next(MBBI);
606 unsigned Opc = PI->getOpcode();
607 if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
608 Opc == X86::ADD32ri || Opc == X86::ADD32ri8) &&
609 PI->getOperand(0).getReg() == StackPtr){
610 Offset += PI->getOperand(2).getImm();
612 if (!doMergeWithPrevious) MBBI = NI;
613 } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
614 Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
615 PI->getOperand(0).getReg() == StackPtr) {
616 Offset -= PI->getOperand(2).getImm();
618 if (!doMergeWithPrevious) MBBI = NI;
624 void X86RegisterInfo::emitFrameMoves(MachineFunction &MF,
625 unsigned FrameLabelId,
626 unsigned ReadyLabelId) const {
627 MachineFrameInfo *MFI = MF.getFrameInfo();
628 MachineModuleInfo *MMI = MFI->getMachineModuleInfo();
632 uint64_t StackSize = MFI->getStackSize();
633 std::vector<MachineMove> &Moves = MMI->getFrameMoves();
634 const TargetData *TD = MF.getTarget().getTargetData();
636 // Calculate amount of bytes used for return address storing
638 (MF.getTarget().getFrameInfo()->getStackGrowthDirection() ==
639 TargetFrameInfo::StackGrowsUp ?
640 TD->getPointerSize() : -TD->getPointerSize());
643 // Show update of SP.
646 MachineLocation SPDst(MachineLocation::VirtualFP);
647 MachineLocation SPSrc(MachineLocation::VirtualFP, 2*stackGrowth);
648 Moves.push_back(MachineMove(FrameLabelId, SPDst, SPSrc));
650 MachineLocation SPDst(MachineLocation::VirtualFP);
651 MachineLocation SPSrc(MachineLocation::VirtualFP,
652 -StackSize+stackGrowth);
653 Moves.push_back(MachineMove(FrameLabelId, SPDst, SPSrc));
656 //FIXME: Verify & implement for FP
657 MachineLocation SPDst(StackPtr);
658 MachineLocation SPSrc(StackPtr, stackGrowth);
659 Moves.push_back(MachineMove(FrameLabelId, SPDst, SPSrc));
662 // Add callee saved registers to move list.
663 const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
665 // FIXME: This is dirty hack. The code itself is pretty mess right now.
666 // It should be rewritten from scratch and generalized sometimes.
668 // Determine maximum offset (minumum due to stack growth)
669 int64_t MaxOffset = 0;
670 for (unsigned I = 0, E = CSI.size(); I!=E; ++I)
671 MaxOffset = std::min(MaxOffset,
672 MFI->getObjectOffset(CSI[I].getFrameIdx()));
675 int64_t saveAreaOffset = (hasFP(MF) ? 3 : 2)*stackGrowth;
676 for (unsigned I = 0, E = CSI.size(); I!=E; ++I) {
677 int64_t Offset = MFI->getObjectOffset(CSI[I].getFrameIdx());
678 unsigned Reg = CSI[I].getReg();
679 Offset = (MaxOffset-Offset+saveAreaOffset);
680 MachineLocation CSDst(MachineLocation::VirtualFP, Offset);
681 MachineLocation CSSrc(Reg);
682 Moves.push_back(MachineMove(FrameLabelId, CSDst, CSSrc));
687 MachineLocation FPDst(MachineLocation::VirtualFP, 2*stackGrowth);
688 MachineLocation FPSrc(FramePtr);
689 Moves.push_back(MachineMove(ReadyLabelId, FPDst, FPSrc));
692 MachineLocation FPDst(hasFP(MF) ? FramePtr : StackPtr);
693 MachineLocation FPSrc(MachineLocation::VirtualFP);
694 Moves.push_back(MachineMove(ReadyLabelId, FPDst, FPSrc));
698 void X86RegisterInfo::emitPrologue(MachineFunction &MF) const {
699 MachineBasicBlock &MBB = MF.front(); // Prolog goes in entry BB
700 MachineFrameInfo *MFI = MF.getFrameInfo();
701 const Function* Fn = MF.getFunction();
702 const X86Subtarget* Subtarget = &MF.getTarget().getSubtarget<X86Subtarget>();
703 MachineModuleInfo *MMI = MFI->getMachineModuleInfo();
704 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
705 MachineBasicBlock::iterator MBBI = MBB.begin();
706 bool needsFrameMoves = (MMI && MMI->hasDebugInfo()) ||
707 !Fn->doesNotThrow() ||
708 UnwindTablesMandatory;
709 // Prepare for frame info.
710 unsigned FrameLabelId = 0;
712 // Get the number of bytes to allocate from the FrameInfo.
713 uint64_t StackSize = MFI->getStackSize();
714 // Get desired stack alignment
715 uint64_t MaxAlign = MFI->getMaxAlignment();
717 // Add RETADDR move area to callee saved frame size.
718 int TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
719 if (TailCallReturnAddrDelta < 0)
720 X86FI->setCalleeSavedFrameSize(
721 X86FI->getCalleeSavedFrameSize() +(-TailCallReturnAddrDelta));
723 // Insert stack pointer adjustment for later moving of return addr. Only
724 // applies to tail call optimized functions where the callee argument stack
725 // size is bigger than the callers.
726 if (TailCallReturnAddrDelta < 0) {
728 BuildMI(MBB, MBBI, TII.get(Is64Bit? X86::SUB64ri32 : X86::SUB32ri),
729 StackPtr).addReg(StackPtr).addImm(-TailCallReturnAddrDelta);
730 // The EFLAGS implicit def is dead.
731 MI->getOperand(3).setIsDead();
734 uint64_t NumBytes = 0;
736 // Calculate required stack adjustment
737 uint64_t FrameSize = StackSize - SlotSize;
738 if (needsStackRealignment(MF))
739 FrameSize = (FrameSize + MaxAlign - 1)/MaxAlign*MaxAlign;
741 NumBytes = FrameSize - X86FI->getCalleeSavedFrameSize();
743 // Get the offset of the stack slot for the EBP register... which is
744 // guaranteed to be the last slot by processFunctionBeforeFrameFinalized.
745 // Update the frame offset adjustment.
746 MFI->setOffsetAdjustment(-NumBytes);
748 // Save EBP into the appropriate stack slot...
749 BuildMI(MBB, MBBI, TII.get(Is64Bit ? X86::PUSH64r : X86::PUSH32r))
750 .addReg(FramePtr, /*isDef=*/false, /*isImp=*/false, /*isKill=*/true);
752 if (needsFrameMoves) {
753 // Mark effective beginning of when frame pointer becomes valid.
754 FrameLabelId = MMI->NextLabelID();
755 BuildMI(MBB, MBBI, TII.get(X86::DBG_LABEL)).addImm(FrameLabelId);
758 // Update EBP with the new base value...
759 BuildMI(MBB, MBBI, TII.get(Is64Bit ? X86::MOV64rr : X86::MOV32rr), FramePtr)
762 // Mark the FramePtr as live-in in every block except the entry.
763 for (MachineFunction::iterator I = next(MF.begin()), E = MF.end();
765 I->addLiveIn(FramePtr);
768 if (needsStackRealignment(MF)) {
771 TII.get(Is64Bit ? X86::AND64ri32 : X86::AND32ri),
772 StackPtr).addReg(StackPtr).addImm(-MaxAlign);
773 // The EFLAGS implicit def is dead.
774 MI->getOperand(3).setIsDead();
777 NumBytes = StackSize - X86FI->getCalleeSavedFrameSize();
779 unsigned ReadyLabelId = 0;
780 if (needsFrameMoves) {
781 // Mark effective beginning of when frame pointer is ready.
782 ReadyLabelId = MMI->NextLabelID();
783 BuildMI(MBB, MBBI, TII.get(X86::DBG_LABEL)).addImm(ReadyLabelId);
786 // Skip the callee-saved push instructions.
787 while (MBBI != MBB.end() &&
788 (MBBI->getOpcode() == X86::PUSH32r ||
789 MBBI->getOpcode() == X86::PUSH64r))
792 if (NumBytes) { // adjust stack pointer: ESP -= numbytes
793 if (NumBytes >= 4096 && Subtarget->isTargetCygMing()) {
794 // Check, whether EAX is livein for this function
795 bool isEAXAlive = false;
796 for (MachineRegisterInfo::livein_iterator
797 II = MF.getRegInfo().livein_begin(),
798 EE = MF.getRegInfo().livein_end(); (II != EE) && !isEAXAlive; ++II) {
799 unsigned Reg = II->first;
800 isEAXAlive = (Reg == X86::EAX || Reg == X86::AX ||
801 Reg == X86::AH || Reg == X86::AL);
804 // Function prologue calls _alloca to probe the stack when allocating
805 // more than 4k bytes in one go. Touching the stack at 4K increments is
806 // necessary to ensure that the guard pages used by the OS virtual memory
807 // manager are allocated in correct sequence.
809 BuildMI(MBB, MBBI, TII.get(X86::MOV32ri), X86::EAX).addImm(NumBytes);
810 BuildMI(MBB, MBBI, TII.get(X86::CALLpcrel32))
811 .addExternalSymbol("_alloca");
814 BuildMI(MBB, MBBI, TII.get(X86::PUSH32r))
815 .addReg(X86::EAX, /*isDef=*/false, /*isImp=*/false, /*isKill=*/true);
816 // Allocate NumBytes-4 bytes on stack. We'll also use 4 already
817 // allocated bytes for EAX.
818 BuildMI(MBB, MBBI, TII.get(X86::MOV32ri), X86::EAX).addImm(NumBytes-4);
819 BuildMI(MBB, MBBI, TII.get(X86::CALLpcrel32))
820 .addExternalSymbol("_alloca");
822 MachineInstr *MI = addRegOffset(BuildMI(MF, TII.get(X86::MOV32rm),X86::EAX),
823 StackPtr, false, NumBytes-4);
824 MBB.insert(MBBI, MI);
827 // If there is an SUB32ri of ESP immediately before this instruction,
828 // merge the two. This can be the case when tail call elimination is
829 // enabled and the callee has more arguments then the caller.
830 NumBytes -= mergeSPUpdates(MBB, MBBI, StackPtr, true);
831 // If there is an ADD32ri or SUB32ri of ESP immediately after this
832 // instruction, merge the two instructions.
833 mergeSPUpdatesDown(MBB, MBBI, StackPtr, &NumBytes);
836 emitSPUpdate(MBB, MBBI, StackPtr, -(int64_t)NumBytes, Is64Bit, TII);
841 emitFrameMoves(MF, FrameLabelId, ReadyLabelId);
844 void X86RegisterInfo::emitEpilogue(MachineFunction &MF,
845 MachineBasicBlock &MBB) const {
846 const MachineFrameInfo *MFI = MF.getFrameInfo();
847 X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
848 MachineBasicBlock::iterator MBBI = prior(MBB.end());
849 unsigned RetOpcode = MBBI->getOpcode();
854 case X86::TCRETURNdi:
855 case X86::TCRETURNri:
856 case X86::TCRETURNri64:
857 case X86::TCRETURNdi64:
859 case X86::EH_RETURN64:
862 case X86::TAILJMPm: break; // These are ok
864 assert(0 && "Can only insert epilog into returning blocks");
867 // Get the number of bytes to allocate from the FrameInfo
868 uint64_t StackSize = MFI->getStackSize();
869 uint64_t MaxAlign = MFI->getMaxAlignment();
870 unsigned CSSize = X86FI->getCalleeSavedFrameSize();
871 uint64_t NumBytes = 0;
874 // Calculate required stack adjustment
875 uint64_t FrameSize = StackSize - SlotSize;
876 if (needsStackRealignment(MF))
877 FrameSize = (FrameSize + MaxAlign - 1)/MaxAlign*MaxAlign;
879 NumBytes = FrameSize - CSSize;
882 BuildMI(MBB, MBBI, TII.get(Is64Bit ? X86::POP64r : X86::POP32r), FramePtr);
884 NumBytes = StackSize - CSSize;
886 // Skip the callee-saved pop instructions.
887 MachineBasicBlock::iterator LastCSPop = MBBI;
888 while (MBBI != MBB.begin()) {
889 MachineBasicBlock::iterator PI = prior(MBBI);
890 unsigned Opc = PI->getOpcode();
891 if (Opc != X86::POP32r && Opc != X86::POP64r &&
892 !PI->getDesc().isTerminator())
897 // If there is an ADD32ri or SUB32ri of ESP immediately before this
898 // instruction, merge the two instructions.
899 if (NumBytes || MFI->hasVarSizedObjects())
900 mergeSPUpdatesUp(MBB, MBBI, StackPtr, &NumBytes);
902 // If dynamic alloca is used, then reset esp to point to the last callee-saved
903 // slot before popping them off! Same applies for the case, when stack was
905 if (needsStackRealignment(MF)) {
906 // We cannot use LEA here, because stack pointer was realigned. We need to
907 // deallocate local frame back
909 emitSPUpdate(MBB, MBBI, StackPtr, NumBytes, Is64Bit, TII);
910 MBBI = prior(LastCSPop);
914 TII.get(Is64Bit ? X86::MOV64rr : X86::MOV32rr),
915 StackPtr).addReg(FramePtr);
916 } else if (MFI->hasVarSizedObjects()) {
918 unsigned Opc = Is64Bit ? X86::LEA64r : X86::LEA32r;
919 MachineInstr *MI = addRegOffset(BuildMI(MF, TII.get(Opc), StackPtr),
920 FramePtr, false, -CSSize);
921 MBB.insert(MBBI, MI);
923 BuildMI(MBB, MBBI, TII.get(Is64Bit ? X86::MOV64rr : X86::MOV32rr),
924 StackPtr).addReg(FramePtr);
927 // adjust stack pointer back: ESP += numbytes
929 emitSPUpdate(MBB, MBBI, StackPtr, NumBytes, Is64Bit, TII);
932 // We're returning from function via eh_return.
933 if (RetOpcode == X86::EH_RETURN || RetOpcode == X86::EH_RETURN64) {
934 MBBI = prior(MBB.end());
935 MachineOperand &DestAddr = MBBI->getOperand(0);
936 assert(DestAddr.isReg() && "Offset should be in register!");
938 TII.get(Is64Bit ? X86::MOV64rr : X86::MOV32rr),
939 StackPtr).addReg(DestAddr.getReg());
940 // Tail call return: adjust the stack pointer and jump to callee
941 } else if (RetOpcode == X86::TCRETURNri || RetOpcode == X86::TCRETURNdi ||
942 RetOpcode== X86::TCRETURNri64 || RetOpcode == X86::TCRETURNdi64) {
943 MBBI = prior(MBB.end());
944 MachineOperand &JumpTarget = MBBI->getOperand(0);
945 MachineOperand &StackAdjust = MBBI->getOperand(1);
946 assert(StackAdjust.isImm() && "Expecting immediate value.");
948 // Adjust stack pointer.
949 int StackAdj = StackAdjust.getImm();
950 int MaxTCDelta = X86FI->getTCReturnAddrDelta();
952 assert(MaxTCDelta <= 0 && "MaxTCDelta should never be positive");
953 // Incoporate the retaddr area.
954 Offset = StackAdj-MaxTCDelta;
955 assert(Offset >= 0 && "Offset should never be negative");
957 // Check for possible merge with preceeding ADD instruction.
958 Offset += mergeSPUpdates(MBB, MBBI, StackPtr, true);
959 emitSPUpdate(MBB, MBBI, StackPtr, Offset, Is64Bit, TII);
961 // Jump to label or value in register.
962 if (RetOpcode == X86::TCRETURNdi|| RetOpcode == X86::TCRETURNdi64)
963 BuildMI(MBB, MBBI, TII.get(X86::TAILJMPd)).
964 addGlobalAddress(JumpTarget.getGlobal(), JumpTarget.getOffset());
965 else if (RetOpcode== X86::TCRETURNri64) {
966 BuildMI(MBB, MBBI, TII.get(X86::TAILJMPr64), JumpTarget.getReg());
968 BuildMI(MBB, MBBI, TII.get(X86::TAILJMPr), JumpTarget.getReg());
969 // Delete the pseudo instruction TCRETURN.
971 } else if ((RetOpcode == X86::RET || RetOpcode == X86::RETI) &&
972 (X86FI->getTCReturnAddrDelta() < 0)) {
973 // Add the return addr area delta back since we are not tail calling.
974 int delta = -1*X86FI->getTCReturnAddrDelta();
975 MBBI = prior(MBB.end());
976 // Check for possible merge with preceeding ADD instruction.
977 delta += mergeSPUpdates(MBB, MBBI, StackPtr, true);
978 emitSPUpdate(MBB, MBBI, StackPtr, delta, Is64Bit, TII);
982 unsigned X86RegisterInfo::getRARegister() const {
984 return X86::RIP; // Should have dwarf #16
986 return X86::EIP; // Should have dwarf #8
989 unsigned X86RegisterInfo::getFrameRegister(MachineFunction &MF) const {
990 return hasFP(MF) ? FramePtr : StackPtr;
993 void X86RegisterInfo::getInitialFrameState(std::vector<MachineMove> &Moves)
995 // Calculate amount of bytes used for return address storing
996 int stackGrowth = (Is64Bit ? -8 : -4);
998 // Initial state of the frame pointer is esp+4.
999 MachineLocation Dst(MachineLocation::VirtualFP);
1000 MachineLocation Src(StackPtr, stackGrowth);
1001 Moves.push_back(MachineMove(0, Dst, Src));
1003 // Add return address to move list
1004 MachineLocation CSDst(StackPtr, stackGrowth);
1005 MachineLocation CSSrc(getRARegister());
1006 Moves.push_back(MachineMove(0, CSDst, CSSrc));
1009 unsigned X86RegisterInfo::getEHExceptionRegister() const {
1010 assert(0 && "What is the exception register");
1014 unsigned X86RegisterInfo::getEHHandlerRegister() const {
1015 assert(0 && "What is the exception handler register");
1020 unsigned getX86SubSuperRegister(unsigned Reg, MVT VT, bool High) {
1021 switch (VT.getSimpleVT()) {
1022 default: return Reg;
1027 case X86::AH: case X86::AL: case X86::AX: case X86::EAX: case X86::RAX:
1029 case X86::DH: case X86::DL: case X86::DX: case X86::EDX: case X86::RDX:
1031 case X86::CH: case X86::CL: case X86::CX: case X86::ECX: case X86::RCX:
1033 case X86::BH: case X86::BL: case X86::BX: case X86::EBX: case X86::RBX:
1039 case X86::AH: case X86::AL: case X86::AX: case X86::EAX: case X86::RAX:
1041 case X86::DH: case X86::DL: case X86::DX: case X86::EDX: case X86::RDX:
1043 case X86::CH: case X86::CL: case X86::CX: case X86::ECX: case X86::RCX:
1045 case X86::BH: case X86::BL: case X86::BX: case X86::EBX: case X86::RBX:
1047 case X86::SIL: case X86::SI: case X86::ESI: case X86::RSI:
1049 case X86::DIL: case X86::DI: case X86::EDI: case X86::RDI:
1051 case X86::BPL: case X86::BP: case X86::EBP: case X86::RBP:
1053 case X86::SPL: case X86::SP: case X86::ESP: case X86::RSP:
1055 case X86::R8B: case X86::R8W: case X86::R8D: case X86::R8:
1057 case X86::R9B: case X86::R9W: case X86::R9D: case X86::R9:
1059 case X86::R10B: case X86::R10W: case X86::R10D: case X86::R10:
1061 case X86::R11B: case X86::R11W: case X86::R11D: case X86::R11:
1063 case X86::R12B: case X86::R12W: case X86::R12D: case X86::R12:
1065 case X86::R13B: case X86::R13W: case X86::R13D: case X86::R13:
1067 case X86::R14B: case X86::R14W: case X86::R14D: case X86::R14:
1069 case X86::R15B: case X86::R15W: case X86::R15D: case X86::R15:
1075 default: return Reg;
1076 case X86::AH: case X86::AL: case X86::AX: case X86::EAX: case X86::RAX:
1078 case X86::DH: case X86::DL: case X86::DX: case X86::EDX: case X86::RDX:
1080 case X86::CH: case X86::CL: case X86::CX: case X86::ECX: case X86::RCX:
1082 case X86::BH: case X86::BL: case X86::BX: case X86::EBX: case X86::RBX:
1084 case X86::SIL: case X86::SI: case X86::ESI: case X86::RSI:
1086 case X86::DIL: case X86::DI: case X86::EDI: case X86::RDI:
1088 case X86::BPL: case X86::BP: case X86::EBP: case X86::RBP:
1090 case X86::SPL: case X86::SP: case X86::ESP: case X86::RSP:
1092 case X86::R8B: case X86::R8W: case X86::R8D: case X86::R8:
1094 case X86::R9B: case X86::R9W: case X86::R9D: case X86::R9:
1096 case X86::R10B: case X86::R10W: case X86::R10D: case X86::R10:
1098 case X86::R11B: case X86::R11W: case X86::R11D: case X86::R11:
1100 case X86::R12B: case X86::R12W: case X86::R12D: case X86::R12:
1102 case X86::R13B: case X86::R13W: case X86::R13D: case X86::R13:
1104 case X86::R14B: case X86::R14W: case X86::R14D: case X86::R14:
1106 case X86::R15B: case X86::R15W: case X86::R15D: case X86::R15:
1111 default: return Reg;
1112 case X86::AH: case X86::AL: case X86::AX: case X86::EAX: case X86::RAX:
1114 case X86::DH: case X86::DL: case X86::DX: case X86::EDX: case X86::RDX:
1116 case X86::CH: case X86::CL: case X86::CX: case X86::ECX: case X86::RCX:
1118 case X86::BH: case X86::BL: case X86::BX: case X86::EBX: case X86::RBX:
1120 case X86::SIL: case X86::SI: case X86::ESI: case X86::RSI:
1122 case X86::DIL: case X86::DI: case X86::EDI: case X86::RDI:
1124 case X86::BPL: case X86::BP: case X86::EBP: case X86::RBP:
1126 case X86::SPL: case X86::SP: case X86::ESP: case X86::RSP:
1128 case X86::R8B: case X86::R8W: case X86::R8D: case X86::R8:
1130 case X86::R9B: case X86::R9W: case X86::R9D: case X86::R9:
1132 case X86::R10B: case X86::R10W: case X86::R10D: case X86::R10:
1134 case X86::R11B: case X86::R11W: case X86::R11D: case X86::R11:
1136 case X86::R12B: case X86::R12W: case X86::R12D: case X86::R12:
1138 case X86::R13B: case X86::R13W: case X86::R13D: case X86::R13:
1140 case X86::R14B: case X86::R14W: case X86::R14D: case X86::R14:
1142 case X86::R15B: case X86::R15W: case X86::R15D: case X86::R15:
1147 default: return Reg;
1148 case X86::AH: case X86::AL: case X86::AX: case X86::EAX: case X86::RAX:
1150 case X86::DH: case X86::DL: case X86::DX: case X86::EDX: case X86::RDX:
1152 case X86::CH: case X86::CL: case X86::CX: case X86::ECX: case X86::RCX:
1154 case X86::BH: case X86::BL: case X86::BX: case X86::EBX: case X86::RBX:
1156 case X86::SIL: case X86::SI: case X86::ESI: case X86::RSI:
1158 case X86::DIL: case X86::DI: case X86::EDI: case X86::RDI:
1160 case X86::BPL: case X86::BP: case X86::EBP: case X86::RBP:
1162 case X86::SPL: case X86::SP: case X86::ESP: case X86::RSP:
1164 case X86::R8B: case X86::R8W: case X86::R8D: case X86::R8:
1166 case X86::R9B: case X86::R9W: case X86::R9D: case X86::R9:
1168 case X86::R10B: case X86::R10W: case X86::R10D: case X86::R10:
1170 case X86::R11B: case X86::R11W: case X86::R11D: case X86::R11:
1172 case X86::R12B: case X86::R12W: case X86::R12D: case X86::R12:
1174 case X86::R13B: case X86::R13W: case X86::R13D: case X86::R13:
1176 case X86::R14B: case X86::R14W: case X86::R14D: case X86::R14:
1178 case X86::R15B: case X86::R15W: case X86::R15D: case X86::R15:
1187 #include "X86GenRegisterInfo.inc"
1190 struct VISIBILITY_HIDDEN MSAC : public MachineFunctionPass {
1192 MSAC() : MachineFunctionPass(&ID) {}
1194 virtual bool runOnMachineFunction(MachineFunction &MF) {
1195 MachineFrameInfo *FFI = MF.getFrameInfo();
1196 MachineRegisterInfo &RI = MF.getRegInfo();
1198 // Calculate max stack alignment of all already allocated stack objects.
1199 unsigned MaxAlign = calculateMaxStackAlignment(FFI);
1201 // Be over-conservative: scan over all vreg defs and find, whether vector
1202 // registers are used. If yes - there is probability, that vector register
1203 // will be spilled and thus stack needs to be aligned properly.
1204 for (unsigned RegNum = TargetRegisterInfo::FirstVirtualRegister;
1205 RegNum < RI.getLastVirtReg(); ++RegNum)
1206 MaxAlign = std::max(MaxAlign, RI.getRegClass(RegNum)->getAlignment());
1208 FFI->setMaxAlignment(MaxAlign);
1213 virtual const char *getPassName() const {
1214 return "X86 Maximal Stack Alignment Calculator";
1222 llvm::createX86MaxStackAlignmentCalculatorPass() { return new MSAC(); }