LLVM  8.0.1
Public Member Functions | List of all members
llvm::AArch64FrameLowering Class Reference

#include "Target/AArch64/AArch64FrameLowering.h"

Inheritance diagram for llvm::AArch64FrameLowering:
Inheritance graph
[legend]
Collaboration diagram for llvm::AArch64FrameLowering:
Collaboration graph
[legend]

Public Member Functions

 AArch64FrameLowering ()
 
void emitCalleeSavedFrameMoves (MachineBasicBlock &MBB, MachineBasicBlock::iterator MBBI) const
 
MachineBasicBlock::iterator eliminateCallFramePseudoInstr (MachineFunction &MF, MachineBasicBlock &MBB, MachineBasicBlock::iterator I) const override
 This method is called during prolog/epilog code insertion to eliminate call frame setup and destroy pseudo instructions (but only if the Target is using them). More...
 
void emitPrologue (MachineFunction &MF, MachineBasicBlock &MBB) const override
 emitProlog/emitEpilog - These methods insert prolog and epilog code into the function. More...
 
void emitEpilogue (MachineFunction &MF, MachineBasicBlock &MBB) const override
 
bool canUseAsPrologue (const MachineBasicBlock &MBB) const override
 Check whether or not the given MBB can be used as a prologue for the target. More...
 
int getFrameIndexReference (const MachineFunction &MF, int FI, unsigned &FrameReg) const override
 getFrameIndexReference - Provide a base+offset reference to an FI slot for debug info. More...
 
int resolveFrameIndexReference (const MachineFunction &MF, int FI, unsigned &FrameReg, bool PreferFP=false) const
 
bool spillCalleeSavedRegisters (MachineBasicBlock &MBB, MachineBasicBlock::iterator MI, const std::vector< CalleeSavedInfo > &CSI, const TargetRegisterInfo *TRI) const override
 spillCalleeSavedRegisters - Issues instruction(s) to spill all callee saved registers and returns true if it isn't possible / profitable to do so by issuing a series of store instructions via storeRegToStackSlot(). More...
 
bool restoreCalleeSavedRegisters (MachineBasicBlock &MBB, MachineBasicBlock::iterator MI, std::vector< CalleeSavedInfo > &CSI, const TargetRegisterInfo *TRI) const override
 restoreCalleeSavedRegisters - Issues instruction(s) to restore all callee saved registers and returns true if it isn't possible / profitable to do so by issuing a series of load instructions via loadRegToStackSlot(). More...
 
bool canUseRedZone (const MachineFunction &MF) const
 Can this function use the red zone for local allocations. More...
 
bool hasFP (const MachineFunction &MF) const override
 hasFP - Return true if the specified function should have a dedicated frame pointer register. More...
 
bool hasReservedCallFrame (const MachineFunction &MF) const override
 hasReservedCallFrame - Under normal circumstances, when a frame pointer is not required, we reserve argument space for call sites in the function immediately on entry to the current function. More...
 
void determineCalleeSaves (MachineFunction &MF, BitVector &SavedRegs, RegScavenger *RS) const override
 This method determines which of the registers reported by TargetRegisterInfo::getCalleeSavedRegs() should actually get saved. More...
 
bool enableShrinkWrapping (const MachineFunction &MF) const override
 Returns true if the target will correctly handle shrink wrapping. More...
 
bool enableStackSlotScavenging (const MachineFunction &MF) const override
 Returns true if the stack slot holes in the fixed and callee-save stack area should be used when allocating other stack locations to reduce stack size. More...
 
void processFunctionBeforeFrameFinalized (MachineFunction &MF, RegScavenger *RS) const override
 processFunctionBeforeFrameFinalized - This method is called immediately before the specified function's frame layout (MF.getFrameInfo()) is finalized. More...
 
unsigned getWinEHParentFrameOffset (const MachineFunction &MF) const override
 The parent frame offset (aka dispFrame) is only used on X86_64 to retrieve the parent's frame pointer. More...
 
unsigned getWinEHFuncletFrameSize (const MachineFunction &MF) const
 Funclets only need to account for space for the callee saved registers, as the locals are accounted for in the parent's stack frame. More...
 
int getFrameIndexReferencePreferSP (const MachineFunction &MF, int FI, unsigned &FrameReg, bool IgnoreSPUpdates) const override
 For Win64 AArch64 EH, the offset to the Unwind object is from the SP before the update. More...
 
- Public Member Functions inherited from llvm::TargetFrameLowering
 TargetFrameLowering (StackDirection D, unsigned StackAl, int LAO, unsigned TransAl=1, bool StackReal=true)
 
virtual ~TargetFrameLowering ()
 
StackDirection getStackGrowthDirection () const
 getStackGrowthDirection - Return the direction the stack grows More...
 
unsigned getStackAlignment () const
 getStackAlignment - This method returns the number of bytes to which the stack pointer must be aligned on entry to a function. More...
 
int alignSPAdjust (int SPAdj) const
 alignSPAdjust - This method aligns the stack adjustment to the correct alignment. More...
 
unsigned getTransientStackAlignment () const
 getTransientStackAlignment - This method returns the number of bytes to which the stack pointer must be aligned at all times, even between calls. More...
 
bool isStackRealignable () const
 isStackRealignable - This method returns whether the stack can be realigned. More...
 
virtual unsigned getStackAlignmentSkew (const MachineFunction &MF) const
 Return the skew that has to be applied to stack alignment under certain conditions (e.g. More...
 
int getOffsetOfLocalArea () const
 getOffsetOfLocalArea - This method returns the offset of the local area from the stack pointer on entrance to a function. More...
 
virtual bool isFPCloseToIncomingSP () const
 isFPCloseToIncomingSP - Return true if the frame pointer is close to the incoming stack pointer, false if it is close to the post-prologue stack pointer. More...
 
virtual bool assignCalleeSavedSpillSlots (MachineFunction &MF, const TargetRegisterInfo *TRI, std::vector< CalleeSavedInfo > &CSI) const
 assignCalleeSavedSpillSlots - Allows target to override spill slot assignment logic. More...
 
virtual const SpillSlotgetCalleeSavedSpillSlots (unsigned &NumEntries) const
 getCalleeSavedSpillSlots - This method returns a pointer to an array of pairs, that contains an entry for each callee saved register that must be spilled to a particular stack location if it is spilled. More...
 
virtual bool targetHandlesStackFrameRounding () const
 targetHandlesStackFrameRounding - Returns true if the target is responsible for rounding up the stack frame (probably at emitPrologue time). More...
 
virtual bool enableCalleeSaveSkip (const MachineFunction &MF) const
 Returns true if the target can safely skip saving callee-saved registers for noreturn nounwind functions. More...
 
virtual void inlineStackProbe (MachineFunction &MF, MachineBasicBlock &PrologueMBB) const
 Replace a StackProbe stub (if any) with the actual probe code inline. More...
 
virtual void adjustForSegmentedStacks (MachineFunction &MF, MachineBasicBlock &PrologueMBB) const
 Adjust the prologue to have the function use segmented stacks. More...
 
virtual void adjustForHiPEPrologue (MachineFunction &MF, MachineBasicBlock &PrologueMBB) const
 Adjust the prologue to add Erlang Run-Time System (ERTS) specific code in the assembly prologue to explicitly handle the stack. More...
 
virtual bool keepFramePointer (const MachineFunction &MF) const
 Return true if the target wants to keep the frame pointer regardless of the function attribute "frame-pointer". More...
 
virtual bool canSimplifyCallFramePseudos (const MachineFunction &MF) const
 canSimplifyCallFramePseudos - When possible, it's best to simplify the call frame pseudo ops before doing frame index elimination. More...
 
virtual bool needsFrameIndexResolution (const MachineFunction &MF) const
 
virtual void orderFrameObjects (const MachineFunction &MF, SmallVectorImpl< int > &objectsToAllocate) const
 Order the symbols in the local stack frame. More...
 
virtual bool canUseAsEpilogue (const MachineBasicBlock &MBB) const
 Check whether or not the given MBB can be used as a epilogue for the target. More...
 
virtual int getInitialCFAOffset (const MachineFunction &MF) const
 Return initial CFA offset value i.e. More...
 
virtual unsigned getInitialCFARegister (const MachineFunction &MF) const
 Return initial CFA register value i.e. More...
 

Additional Inherited Members

- Public Types inherited from llvm::TargetFrameLowering
enum  StackDirection { StackGrowsUp, StackGrowsDown }
 
- Static Public Member Functions inherited from llvm::TargetFrameLowering
static bool isSafeForNoCSROpt (const Function &F)
 Check if given function is safe for not having callee saved registers. More...
 

Detailed Description

Definition at line 21 of file AArch64FrameLowering.h.

Constructor & Destructor Documentation

◆ AArch64FrameLowering()

llvm::AArch64FrameLowering::AArch64FrameLowering ( )
inlineexplicit

Member Function Documentation

◆ canUseAsPrologue()

bool AArch64FrameLowering::canUseAsPrologue ( const MachineBasicBlock MBB) const
overridevirtual

Check whether or not the given MBB can be used as a prologue for the target.

The prologue will be inserted first in this basic block. This method is used by the shrink-wrapping pass to decide if MBB will be correctly handled by the target. As soon as the target enable shrink-wrapping without overriding this method, we assume that each basic block is a valid prologue.

Reimplemented from llvm::TargetFrameLowering.

Definition at line 386 of file AArch64FrameLowering.cpp.

References findScratchNonCalleeSaveRegister(), llvm::MachineBasicBlock::getParent(), llvm::AArch64Subtarget::getRegisterInfo(), and llvm::MachineFunction::getSubtarget().

Referenced by AArch64FrameLowering().

◆ canUseRedZone()

bool AArch64FrameLowering::canUseRedZone ( const MachineFunction MF) const

◆ determineCalleeSaves()

void AArch64FrameLowering::determineCalleeSaves ( MachineFunction MF,
BitVector SavedRegs,
RegScavenger RS 
) const
overridevirtual

This method determines which of the registers reported by TargetRegisterInfo::getCalleeSavedRegs() should actually get saved.

The default implementation checks populates the SavedRegs bitset with all registers which are modified in the function, targets may override this function to save additional registers. This method also sets up the register scavenger ensuring there is a free register or a frameindex available.

Reimplemented from llvm::TargetFrameLowering.

Definition at line 1956 of file AArch64FrameLowering.cpp.

References llvm::RegScavenger::addScavengingFrameIndex(), llvm::AMDGPU::HSAMD::Kernel::Arg::Key::Align, llvm::alignTo(), llvm::AArch64RegisterInfo::cannotEliminateFrame(), contains(), llvm::BitVector::count(), llvm::MachineFrameInfo::CreateStackObject(), llvm::dbgs(), llvm::TargetFrameLowering::determineCalleeSaves(), estimateRSStackSizeLimit(), llvm::MachineFrameInfo::estimateStackSize(), llvm::AArch64RegisterInfo::getBaseRegister(), llvm::MachineRegisterInfo::getCalleeSavedRegs(), llvm::Function::getCallingConv(), llvm::MachineFunction::getFrameInfo(), llvm::MachineFunction::getFunction(), llvm::MachineFunction::getInfo(), llvm::MachineFunction::getRegInfo(), llvm::TargetSubtargetInfo::getRegisterInfo(), llvm::TargetRegisterInfo::getRegSizeInBits(), llvm::TargetRegisterInfo::getSpillAlignment(), llvm::TargetRegisterInfo::getSpillSize(), llvm::MachineFunction::getSubtarget(), llvm::CallingConv::GHC, llvm::AArch64RegisterInfo::hasBasePointer(), hasFP(), llvm::MachineRegisterInfo::isPhysRegUsed(), llvm::AArch64RegisterInfo::isReservedReg(), LLVM_DEBUG, MRI, llvm::printReg(), produceCompactUnwindFrame(), Reg, llvm::BitVector::set(), llvm::BitVector::set_bits(), llvm::AArch64FunctionInfo::setCalleeSavedStackSize(), llvm::AArch64FunctionInfo::setCalleeSaveStackHasFreeSpace(), llvm::AArch64FunctionInfo::setHasStackFrame(), Size, llvm::BitVector::test(), TRI, and windowsRequiresStackProbe().

Referenced by AArch64FrameLowering().

◆ eliminateCallFramePseudoInstr()

MachineBasicBlock::iterator AArch64FrameLowering::eliminateCallFramePseudoInstr ( MachineFunction MF,
MachineBasicBlock MBB,
MachineBasicBlock::iterator  MI 
) const
overridevirtual

This method is called during prolog/epilog code insertion to eliminate call frame setup and destroy pseudo instructions (but only if the Target is using them).

It is responsible for eliminating these instructions, replacing them with concrete instructions. This method need only be implemented if using call frame setup/destroy pseudo instructions. Returns an iterator pointing to the instruction after the replaced one.

Reimplemented from llvm::TargetFrameLowering.

Definition at line 248 of file AArch64FrameLowering.cpp.

References llvm::AMDGPU::HSAMD::Kernel::Arg::Key::Align, llvm::alignTo(), assert(), llvm::emitFrameOffset(), llvm::MachineBasicBlock::erase(), llvm::TargetSubtargetInfo::getFrameLowering(), llvm::TargetSubtargetInfo::getInstrInfo(), llvm::TargetFrameLowering::getStackAlignment(), llvm::MachineFunction::getSubtarget(), llvm::TargetFrameLowering::hasReservedCallFrame(), and TII.

Referenced by AArch64FrameLowering().

◆ emitCalleeSavedFrameMoves()

void AArch64FrameLowering::emitCalleeSavedFrameMoves ( MachineBasicBlock MBB,
MachineBasicBlock::iterator  MBBI 
) const

◆ emitEpilogue()

void AArch64FrameLowering::emitEpilogue ( MachineFunction MF,
MachineBasicBlock MBB 
) const
overridevirtual

◆ emitPrologue()

void AArch64FrameLowering::emitPrologue ( MachineFunction MF,
MachineBasicBlock MBB 
) const
overridevirtual

emitProlog/emitEpilog - These methods insert prolog and epilog code into the function.

Implements llvm::TargetFrameLowering.

Definition at line 796 of file AArch64FrameLowering.cpp.

References llvm::MachineFunction::addFrameInst(), llvm::alignTo(), assert(), llvm::MachineBasicBlock::begin(), llvm::BuildMI(), canUseRedZone(), convertCalleeSaveRestoreToSPPrePostIncDec(), llvm::MCCFIInstruction::createDefCfaOffset(), llvm::MCCFIInstruction::createNegateRAState(), llvm::MCContext::createTempSymbol(), llvm::emitFrameOffset(), F(), llvm::MachineInstr::FrameSetup, llvm::MCInstrInfo::get(), llvm::AArch64FunctionInfo::getCalleeSavedStackSize(), llvm::Function::getCallingConv(), llvm::MachineModuleInfo::getContext(), llvm::MachineFunction::getFrameInfo(), llvm::MachineFunction::getFunction(), llvm::MachineFunction::getInfo(), llvm::AArch64Subtarget::getInstrInfo(), llvm::TargetMachine::getMCAsmInfo(), llvm::MachineFunction::getMMI(), llvm::AArch64Subtarget::getRegisterInfo(), llvm::MachineFrameInfo::getStackSize(), llvm::MachineFunction::getSubtarget(), llvm::MachineFunction::getTarget(), llvm::AArch64FunctionInfo::getVarArgsGPRSize(), getWinEHFuncletFrameSize(), llvm::CallingConv::GHC, llvm::MachineModuleInfo::hasDebugInfo(), hasFP(), llvm::AArch64FunctionInfo::hasStackFrame(), llvm::AArch64Subtarget::isCallingConvWin64(), llvm::MachineBasicBlock::isEHFuncletEntry(), llvm::Function::needsUnwindTableEntry(), needsWinCFI(), llvm::AArch64FunctionInfo::setHasRedZone(), llvm::MachineFunction::setHasWinCFI(), llvm::AArch64FunctionInfo::setLocalStackSize(), llvm::MachineInstrBuilder::setMIFlags(), ShouldSignReturnAddress(), ShouldSignWithAKey(), TII, llvm::MCAsmInfo::usesWindowsCFI(), and windowsRequiresStackProbe().

Referenced by AArch64FrameLowering().

◆ enableShrinkWrapping()

bool llvm::AArch64FrameLowering::enableShrinkWrapping ( const MachineFunction MF) const
inlineoverridevirtual

Returns true if the target will correctly handle shrink wrapping.

Reimplemented from llvm::TargetFrameLowering.

Definition at line 66 of file AArch64FrameLowering.h.

References enableStackSlotScavenging(), getFrameIndexReferencePreferSP(), getWinEHFuncletFrameSize(), getWinEHParentFrameOffset(), and processFunctionBeforeFrameFinalized().

◆ enableStackSlotScavenging()

bool AArch64FrameLowering::enableStackSlotScavenging ( const MachineFunction MF) const
overridevirtual

Returns true if the stack slot holes in the fixed and callee-save stack area should be used when allocating other stack locations to reduce stack size.

Reimplemented from llvm::TargetFrameLowering.

Definition at line 2090 of file AArch64FrameLowering.cpp.

References llvm::MachineFunction::getInfo(), and llvm::AArch64FunctionInfo::hasCalleeSaveStackFreeSpace().

Referenced by enableShrinkWrapping().

◆ getFrameIndexReference()

int AArch64FrameLowering::getFrameIndexReference ( const MachineFunction MF,
int  FI,
unsigned FrameReg 
) const
overridevirtual

getFrameIndexReference - Provide a base+offset reference to an FI slot for debug info.

It's the same as what we use for resolving the code-gen references for now. FIXME: This can go wrong when references are SP-relative and simple call frames aren't used.

Reimplemented from llvm::TargetFrameLowering.

Definition at line 1454 of file AArch64FrameLowering.cpp.

References resolveFrameIndexReference().

Referenced by AArch64FrameLowering().

◆ getFrameIndexReferencePreferSP()

int AArch64FrameLowering::getFrameIndexReferencePreferSP ( const MachineFunction MF,
int  FI,
unsigned FrameReg,
bool  IgnoreSPUpdates 
) const
overridevirtual

For Win64 AArch64 EH, the offset to the Unwind object is from the SP before the update.

This is easily retrieved as it is exactly the offset that is set in processFunctionBeforeFrameFinalized.

Reimplemented from llvm::TargetFrameLowering.

Definition at line 2132 of file AArch64FrameLowering.cpp.

References llvm::dbgs(), llvm::MachineFunction::getFrameInfo(), llvm::MachineFrameInfo::getObjectOffset(), and LLVM_DEBUG.

Referenced by enableShrinkWrapping().

◆ getWinEHFuncletFrameSize()

unsigned AArch64FrameLowering::getWinEHFuncletFrameSize ( const MachineFunction MF) const

Funclets only need to account for space for the callee saved registers, as the locals are accounted for in the parent's stack frame.

Definition at line 2151 of file AArch64FrameLowering.cpp.

References llvm::alignTo(), llvm::MachineFunction::getFrameInfo(), llvm::MachineFunction::getInfo(), llvm::MachineFrameInfo::getMaxCallFrameSize(), and llvm::TargetFrameLowering::getStackAlignment().

Referenced by emitEpilogue(), emitPrologue(), and enableShrinkWrapping().

◆ getWinEHParentFrameOffset()

unsigned AArch64FrameLowering::getWinEHParentFrameOffset ( const MachineFunction MF) const
overridevirtual

The parent frame offset (aka dispFrame) is only used on X86_64 to retrieve the parent's frame pointer.

Reimplemented from llvm::TargetFrameLowering.

Definition at line 2144 of file AArch64FrameLowering.cpp.

Referenced by enableShrinkWrapping().

◆ hasFP()

bool AArch64FrameLowering::hasFP ( const MachineFunction MF) const
overridevirtual

◆ hasReservedCallFrame()

bool AArch64FrameLowering::hasReservedCallFrame ( const MachineFunction MF) const
overridevirtual

hasReservedCallFrame - Under normal circumstances, when a frame pointer is not required, we reserve argument space for call sites in the function immediately on entry to the current function.

This eliminates the need for add/sub sp brackets around call sites. Returns true if the call frame is included as part of the stack frame.

Reimplemented from llvm::TargetFrameLowering.

Definition at line 244 of file AArch64FrameLowering.cpp.

References llvm::MachineFunction::getFrameInfo(), and llvm::MachineFrameInfo::hasVarSizedObjects().

Referenced by AArch64FrameLowering().

◆ processFunctionBeforeFrameFinalized()

void AArch64FrameLowering::processFunctionBeforeFrameFinalized ( MachineFunction MF,
RegScavenger RS 
) const
overridevirtual

◆ resolveFrameIndexReference()

int AArch64FrameLowering::resolveFrameIndexReference ( const MachineFunction MF,
int  FI,
unsigned FrameReg,
bool  PreferFP = false 
) const

◆ restoreCalleeSavedRegisters()

bool AArch64FrameLowering::restoreCalleeSavedRegisters ( MachineBasicBlock MBB,
MachineBasicBlock::iterator  MI,
std::vector< CalleeSavedInfo > &  CSI,
const TargetRegisterInfo TRI 
) const
overridevirtual

◆ spillCalleeSavedRegisters()

bool AArch64FrameLowering::spillCalleeSavedRegisters ( MachineBasicBlock MBB,
MachineBasicBlock::iterator  MI,
const std::vector< CalleeSavedInfo > &  CSI,
const TargetRegisterInfo TRI 
) const
overridevirtual

spillCalleeSavedRegisters - Issues instruction(s) to spill all callee saved registers and returns true if it isn't possible / profitable to do so by issuing a series of store instructions via storeRegToStackSlot().

Returns false otherwise.

Reimplemented from llvm::TargetFrameLowering.

Definition at line 1728 of file AArch64FrameLowering.cpp.

References llvm::MachineFunction::addFrameInst(), llvm::MachineInstrBuilder::addImm(), llvm::MachineBasicBlock::addLiveIn(), llvm::MachineInstrBuilder::addMemOperand(), llvm::MachineInstrBuilder::addReg(), llvm::AMDGPU::HSAMD::Kernel::Arg::Key::Align, assert(), llvm::BuildMI(), computeCalleeSaveRegisterPairs(), llvm::MCCFIInstruction::createEscape(), llvm::dbgs(), llvm::RegState::Define, llvm::MachineInstr::FrameSetup, llvm::MCInstrInfo::get(), llvm::MachinePointerInfo::getFixedStack(), llvm::MachineFunction::getFunction(), llvm::TargetSubtargetInfo::getInstrInfo(), llvm::MachineFunction::getMachineMemOperand(), llvm::MachineBasicBlock::getParent(), getPrologueDeath(), llvm::MachineFunction::getRegInfo(), llvm::MachineFunction::getSubtarget(), llvm::GPR, llvm::Function::hasFnAttribute(), InsertSEH(), llvm::MachineRegisterInfo::isReserved(), LLVM_DEBUG, llvm::MachineMemOperand::MOStore, MRI, needsWinCFI(), llvm::Attribute::NoUnwind, llvm::printReg(), llvm::SmallVectorTemplateCommon< T >::rbegin(), llvm::SmallVectorTemplateCommon< T >::rend(), llvm::NVPTX::PTXCvtMode::RPI, llvm::MachineInstrBuilder::setMIFlag(), Size, std::swap(), and TII.

Referenced by AArch64FrameLowering().


The documentation for this class was generated from the following files: