#include "Target/WebAssembly/WebAssemblyFrameLowering.h"

Inheritance diagram for llvm::WebAssemblyFrameLowering:

Public Member Functions
	WebAssemblyFrameLowering ()

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).

void	emitPrologue (MachineFunction &MF, MachineBasicBlock &MBB) const override
	These methods insert prolog and epilog code into the function.

void	emitEpilogue (MachineFunction &MF, MachineBasicBlock &MBB) const override

bool	hasFP (const MachineFunction &MF) const override
	Return true if the specified function should have a dedicated frame pointer register.

bool	hasReservedCallFrame (const MachineFunction &MF) const override
	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.

bool	isSupportedStackID (TargetStackID::Value ID) const override

DwarfFrameBase	getDwarfFrameBase (const MachineFunction &MF) const override
	Return the frame base information to be encoded in the DWARF subprogram debug info.

bool	needsPrologForEH (const MachineFunction &MF) const

void	writeSPToGlobal (unsigned SrcReg, MachineFunction &MF, MachineBasicBlock &MBB, MachineBasicBlock::iterator &InsertStore, const DebugLoc &DL) const
	Write SP back to __stack_pointer global.

Public Member Functions inherited from llvm::TargetFrameLowering
	TargetFrameLowering (StackDirection D, Align StackAl, int LAO, Align TransAl=Align(1), bool StackReal=true)

virtual	~TargetFrameLowering ()

StackDirection	getStackGrowthDirection () const
	getStackGrowthDirection - Return the direction the stack grows

unsigned	getStackAlignment () const
	getStackAlignment - This method returns the number of bytes to which the stack pointer must be aligned on entry to a function.

Align	getStackAlign () const
	getStackAlignment - This method returns the number of bytes to which the stack pointer must be aligned on entry to a function.

virtual uint64_t	getStackThreshold () const
	getStackThreshold - Return the maximum stack size

int	alignSPAdjust (int SPAdj) const
	alignSPAdjust - This method aligns the stack adjustment to the correct alignment.

Align	getTransientStackAlign () const
	getTransientStackAlignment - This method returns the number of bytes to which the stack pointer must be aligned at all times, even between calls.

bool	isStackRealignable () const
	isStackRealignable - This method returns whether the stack can be realigned.

virtual bool	isStackIdSafeForLocalArea (unsigned StackId) const
	This method returns whether or not it is safe for an object with the given stack id to be bundled into the local area.

int	getOffsetOfLocalArea () const
	getOffsetOfLocalArea - This method returns the offset of the local area from the stack pointer on entrance to a function.

virtual bool	allocateScavengingFrameIndexesNearIncomingSP (const MachineFunction &MF) const
	Control the placement of special register scavenging spill slots when allocating a stack frame.

virtual bool	assignCalleeSavedSpillSlots (MachineFunction &MF, const TargetRegisterInfo *TRI, std::vector< CalleeSavedInfo > &CSI, unsigned &MinCSFrameIndex, unsigned &MaxCSFrameIndex) const
	assignCalleeSavedSpillSlots - Allows target to override spill slot assignment logic.

virtual bool	assignCalleeSavedSpillSlots (MachineFunction &MF, const TargetRegisterInfo *TRI, std::vector< CalleeSavedInfo > &CSI) const

virtual const SpillSlot *	getCalleeSavedSpillSlots (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.

virtual bool	targetHandlesStackFrameRounding () const
	targetHandlesStackFrameRounding - Returns true if the target is responsible for rounding up the stack frame (probably at emitPrologue time).

virtual bool	enableShrinkWrapping (const MachineFunction &MF) const
	Returns true if the target will correctly handle shrink wrapping.

virtual bool	enableStackSlotScavenging (const MachineFunction &MF) const
	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.

virtual bool	enableCalleeSaveSkip (const MachineFunction &MF) const
	Returns true if the target can safely skip saving callee-saved registers for noreturn nounwind functions.

virtual void	emitPrologue (MachineFunction &MF, MachineBasicBlock &MBB) const =0
	emitProlog/emitEpilog - These methods insert prolog and epilog code into the function.

virtual void	emitEpilogue (MachineFunction &MF, MachineBasicBlock &MBB) const =0

virtual void	emitZeroCallUsedRegs (BitVector RegsToZero, MachineBasicBlock &MBB) const
	emitZeroCallUsedRegs - Zeros out call used registers.

virtual void	emitCalleeSavedFrameMovesFullCFA (MachineBasicBlock &MBB, MachineBasicBlock::iterator MBBI) const
	With basic block sections, emit callee saved frame moves for basic blocks that are in a different section.

virtual bool	enableCFIFixup (MachineFunction &MF) const
	Returns true if we may need to fix the unwind information for the function.

virtual void	resetCFIToInitialState (MachineBasicBlock &MBB) const
	Emit CFI instructions that recreate the state of the unwind information upon fucntion entry.

virtual void	inlineStackProbe (MachineFunction &MF, MachineBasicBlock &PrologueMBB) const
	Replace a StackProbe stub (if any) with the actual probe code inline.

virtual bool	stackProbeFunctionModifiesSP () const
	Does the stack probe function call return with a modified stack pointer?

virtual void	adjustForSegmentedStacks (MachineFunction &MF, MachineBasicBlock &PrologueMBB) const
	Adjust the prologue to have the function use segmented stacks.

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.

virtual bool	spillCalleeSavedRegisters (MachineBasicBlock &MBB, MachineBasicBlock::iterator MI, ArrayRef< CalleeSavedInfo > CSI, const TargetRegisterInfo *TRI) const
	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().

virtual bool	restoreCalleeSavedRegisters (MachineBasicBlock &MBB, MachineBasicBlock::iterator MI, MutableArrayRef< CalleeSavedInfo > CSI, const TargetRegisterInfo *TRI) const
	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().

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".

virtual bool	hasFP (const MachineFunction &MF) const =0
	hasFP - Return true if the specified function should have a dedicated frame pointer register.

virtual bool	hasReservedCallFrame (const MachineFunction &MF) const
	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.

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.

virtual bool	needsFrameIndexResolution (const MachineFunction &MF) const

virtual StackOffset	getFrameIndexReference (const MachineFunction &MF, int FI, Register &FrameReg) const
	getFrameIndexReference - This method should return the base register and offset used to reference a frame index location.

virtual StackOffset	getFrameIndexReferencePreferSP (const MachineFunction &MF, int FI, Register &FrameReg, bool IgnoreSPUpdates) const
	Same as `getFrameIndexReference`, except that the stack pointer (as opposed to the frame pointer) will be the preferred value for `FrameReg`.

virtual StackOffset	getNonLocalFrameIndexReference (const MachineFunction &MF, int FI) const
	getNonLocalFrameIndexReference - This method returns the offset used to reference a frame index location.

virtual StackOffset	getFrameIndexReferenceFromSP (const MachineFunction &MF, int FI) const
	getFrameIndexReferenceFromSP - This method returns the offset from the stack pointer to the slot of the specified index.

virtual void	getCalleeSaves (const MachineFunction &MF, BitVector &SavedRegs) const
	Returns the callee-saved registers as computed by determineCalleeSaves in the BitVector `SavedRegs`.

virtual void	determineCalleeSaves (MachineFunction &MF, BitVector &SavedRegs, RegScavenger *RS=nullptr) const
	This method determines which of the registers reported by TargetRegisterInfo::getCalleeSavedRegs() should actually get saved.

virtual void	processFunctionBeforeFrameFinalized (MachineFunction &MF, RegScavenger *RS=nullptr) const
	processFunctionBeforeFrameFinalized - This method is called immediately before the specified function's frame layout (MF.getFrameInfo()) is finalized.

virtual void	processFunctionBeforeFrameIndicesReplaced (MachineFunction &MF, RegScavenger *RS=nullptr) const
	processFunctionBeforeFrameIndicesReplaced - This method is called immediately before MO_FrameIndex operands are eliminated, but after the frame is finalized.

virtual unsigned	getWinEHParentFrameOffset (const MachineFunction &MF) const

virtual MachineBasicBlock::iterator	eliminateCallFramePseudoInstr (MachineFunction &MF, MachineBasicBlock &MBB, MachineBasicBlock::iterator MI) const
	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).

virtual void	orderFrameObjects (const MachineFunction &MF, SmallVectorImpl< int > &objectsToAllocate) const
	Order the symbols in the local stack frame.

virtual bool	canUseAsPrologue (const MachineBasicBlock &MBB) const
	Check whether or not the given `MBB` can be used as a prologue for the target.

virtual bool	canUseAsEpilogue (const MachineBasicBlock &MBB) const
	Check whether or not the given `MBB` can be used as a epilogue for the target.

virtual TargetStackID::Value	getStackIDForScalableVectors () const
	Returns the StackID that scalable vectors should be associated with.

virtual bool	isSupportedStackID (TargetStackID::Value ID) const

virtual bool	isProfitableForNoCSROpt (const Function &F) const
	Check if the no-CSR optimisation is profitable for the given function.

virtual int	getInitialCFAOffset (const MachineFunction &MF) const
	Return initial CFA offset value i.e.

virtual Register	getInitialCFARegister (const MachineFunction &MF) const
	Return initial CFA register value i.e.

virtual DwarfFrameBase	getDwarfFrameBase (const MachineFunction &MF) const
	Return the frame base information to be encoded in the DWARF subprogram debug info.

virtual void	spillFPBP (MachineFunction &MF) const
	If frame pointer or base pointer is clobbered by an instruction, we should spill/restore it around that instruction.

virtual void	emitRemarks (const MachineFunction &MF, MachineOptimizationRemarkEmitter *ORE) const
	This method is called at the end of prolog/epilog code insertion, so targets can emit remarks based on the final frame layout.

Static Public Member Functions
static std::optional< unsigned >	getLocalForStackObject (MachineFunction &MF, int FrameIndex)

static unsigned	getSPReg (const MachineFunction &MF)

static unsigned	getFPReg (const MachineFunction &MF)

static unsigned	getOpcConst (const MachineFunction &MF)

static unsigned	getOpcAdd (const MachineFunction &MF)

static unsigned	getOpcSub (const MachineFunction &MF)

static unsigned	getOpcAnd (const MachineFunction &MF)

static unsigned	getOpcGlobGet (const MachineFunction &MF)

static unsigned	getOpcGlobSet (const MachineFunction &MF)

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.

Static Public Attributes
static const size_t	RedZoneSize = 128
	Size of the red zone for the user stack (leaf functions can use this much space below the stack pointer without writing it back to __stack_pointer global).

Additional Inherited Members
Public Types inherited from llvm::TargetFrameLowering
enum	StackDirection { StackGrowsUp , StackGrowsDown }

Detailed Description

Definition at line 22 of file WebAssemblyFrameLowering.h.

Constructor & Destructor Documentation

◆ WebAssemblyFrameLowering()

llvm::WebAssemblyFrameLowering::WebAssemblyFrameLowering ( )

inline

Definition at line 30 of file WebAssemblyFrameLowering.h.

Member Function Documentation

◆ eliminateCallFramePseudoInstr()

MachineBasicBlock::iterator WebAssemblyFrameLowering::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 246 of file WebAssemblyFrameLowering.cpp.

References assert(), DL, llvm::MachineBasicBlock::erase(), getSPReg(), llvm::MachineFunction::getSubtarget(), hasFP(), I, MBB, TII, and writeSPToGlobal().

◆ emitEpilogue()

void WebAssemblyFrameLowering::emitEpilogue	(	MachineFunction &	MF,
		MachineBasicBlock &	MBB
	)		const

overridevirtual

◆ emitPrologue()

void WebAssemblyFrameLowering::emitPrologue	(	MachineFunction &	MF,
		MachineBasicBlock &	MBB
	)		const

overridevirtual

These methods insert prolog and epilog code into the function.

Implements llvm::TargetFrameLowering.

Definition at line 261 of file WebAssemblyFrameLowering.cpp.

References llvm::MachineInstrBuilder::addExternalSymbol(), llvm::MachineInstrBuilder::addImm(), llvm::MachineInstrBuilder::addReg(), assert(), llvm::MachineBasicBlock::begin(), llvm::BuildMI(), llvm::MachineFunction::createExternalSymbolName(), DL, llvm::MachineBasicBlock::end(), getFPReg(), llvm::MachineFunction::getFrameInfo(), llvm::MachineFunction::getInfo(), getOpcAnd(), getOpcConst(), getOpcGlobGet(), getOpcSub(), llvm::MachineFunction::getRegInfo(), getSPReg(), llvm::MachineFunction::getSubtarget(), hasFP(), llvm::WebAssembly::isArgument(), MBB, MRI, TII, llvm::Align::value(), and writeSPToGlobal().

◆ getDwarfFrameBase()

TargetFrameLowering::DwarfFrameBase WebAssemblyFrameLowering::getDwarfFrameBase ( const MachineFunction & MF ) const

overridevirtual

Return the frame base information to be encoded in the DWARF subprogram debug info.

Reimplemented from llvm::TargetFrameLowering.

Definition at line 383 of file WebAssemblyFrameLowering.cpp.

References llvm::WebAssemblyFunctionInfo::getFrameBaseLocal(), llvm::MachineFunction::getInfo(), llvm::WebAssemblyFunctionInfo::isFrameBaseVirtual(), llvm::TargetFrameLowering::DwarfFrameBase::Kind, llvm::TargetFrameLowering::DwarfFrameBase::Location, llvm::WebAssembly::TI_GLOBAL_RELOC, llvm::WebAssembly::TI_LOCAL, and llvm::TargetFrameLowering::DwarfFrameBase::WasmLoc.

◆ getFPReg()

unsigned WebAssemblyFrameLowering::getFPReg ( const MachineFunction & MF )

static

Definition at line 187 of file WebAssemblyFrameLowering.cpp.

References llvm::MachineFunction::getSubtarget().

Referenced by emitEpilogue(), and emitPrologue().

◆ getLocalForStackObject()

std::optional< unsigned > WebAssemblyFrameLowering::getLocalForStackObject	(	MachineFunction &	MF,
		int	FrameIndex
	)

static

Definition at line 54 of file WebAssemblyFrameLowering.cpp.

References llvm::WebAssemblyFunctionInfo::addLocal(), llvm::ComputeValueVTs(), llvm::AllocaInst::getAddressSpace(), llvm::AllocaInst::getAllocatedType(), llvm::MachineFunction::getDataLayout(), llvm::MachineFunction::getFrameInfo(), llvm::MachineFunction::getInfo(), llvm::WebAssemblyFunctionInfo::getLocals(), llvm::MachineFrameInfo::getObjectAllocation(), llvm::MachineFrameInfo::getObjectOffset(), llvm::WebAssemblyFunctionInfo::getParams(), llvm::MachineFrameInfo::getStackID(), llvm::MachineFunction::getSubtarget(), llvm::WebAssembly::isWasmVarAddressSpace(), llvm::MachineFrameInfo::setObjectOffset(), llvm::MachineFrameInfo::setObjectSize(), llvm::MachineFrameInfo::setStackID(), llvm::SmallVectorBase< Size_T >::size(), and llvm::TargetStackID::WasmLocal.

Referenced by INITIALIZE_PASS(), and IsWebAssemblyLocal().

◆ getOpcAdd()

unsigned WebAssemblyFrameLowering::getOpcAdd ( const MachineFunction & MF )

static

Definition at line 200 of file WebAssemblyFrameLowering.cpp.

References llvm::MachineFunction::getSubtarget().

Referenced by llvm::WebAssemblyRegisterInfo::eliminateFrameIndex(), and emitEpilogue().

◆ getOpcAnd()

unsigned WebAssemblyFrameLowering::getOpcAnd ( const MachineFunction & MF )

static

Definition at line 212 of file WebAssemblyFrameLowering.cpp.

References llvm::MachineFunction::getSubtarget().

Referenced by emitPrologue().

◆ getOpcConst()

unsigned WebAssemblyFrameLowering::getOpcConst ( const MachineFunction & MF )

static

Definition at line 194 of file WebAssemblyFrameLowering.cpp.

References llvm::MachineFunction::getSubtarget().

Referenced by llvm::WebAssemblyRegisterInfo::eliminateFrameIndex(), emitEpilogue(), and emitPrologue().

◆ getOpcGlobGet()

unsigned WebAssemblyFrameLowering::getOpcGlobGet ( const MachineFunction & MF )

static

Definition at line 219 of file WebAssemblyFrameLowering.cpp.

References llvm::MachineFunction::getSubtarget().

Referenced by emitPrologue().

◆ getOpcGlobSet()

unsigned WebAssemblyFrameLowering::getOpcGlobSet ( const MachineFunction & MF )

static

Definition at line 226 of file WebAssemblyFrameLowering.cpp.

References llvm::MachineFunction::getSubtarget().

Referenced by writeSPToGlobal().

◆ getOpcSub()

unsigned WebAssemblyFrameLowering::getOpcSub ( const MachineFunction & MF )

static

Definition at line 206 of file WebAssemblyFrameLowering.cpp.

References llvm::MachineFunction::getSubtarget().

Referenced by emitPrologue().

◆ getSPReg()

unsigned WebAssemblyFrameLowering::getSPReg ( const MachineFunction & MF )

static

Definition at line 181 of file WebAssemblyFrameLowering.cpp.

References llvm::MachineFunction::getSubtarget().

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

◆ hasFP()

bool WebAssemblyFrameLowering::hasFP ( const MachineFunction & MF ) const

overridevirtual

Return true if the specified function should have a dedicated frame pointer register.

Implements llvm::TargetFrameLowering.

Definition at line 101 of file WebAssemblyFrameLowering.cpp.

References llvm::MachineFunction::getFrameInfo(), llvm::MachineFrameInfo::getStackSize(), llvm::MachineFrameInfo::hasPatchPoint(), llvm::MachineFrameInfo::hasStackMap(), llvm::MachineFrameInfo::hasVarSizedObjects(), and llvm::MachineFrameInfo::isFrameAddressTaken().

Referenced by eliminateCallFramePseudoInstr(), emitEpilogue(), emitPrologue(), and llvm::WebAssemblyRegisterInfo::getFrameRegister().

◆ hasReservedCallFrame()

bool WebAssemblyFrameLowering::hasReservedCallFrame ( const MachineFunction & MF ) const

overridevirtual

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 123 of file WebAssemblyFrameLowering.cpp.

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

◆ isSupportedStackID()

bool WebAssemblyFrameLowering::isSupportedStackID ( TargetStackID::Value ID ) const

overridevirtual

Reimplemented from llvm::TargetFrameLowering.

Definition at line 372 of file WebAssemblyFrameLowering.cpp.

References llvm::TargetFrameLowering::isSupportedStackID(), and llvm::TargetStackID::WasmLocal.

◆ needsPrologForEH()

bool WebAssemblyFrameLowering::needsPrologForEH ( const MachineFunction & MF ) const

Definition at line 147 of file WebAssemblyFrameLowering.cpp.

References llvm::MCAsmInfo::getExceptionHandlingType(), llvm::MachineFunction::getFrameInfo(), llvm::MachineFunction::getFunction(), llvm::TargetMachine::getMCAsmInfo(), llvm::MachineFunction::getTarget(), llvm::MachineFrameInfo::hasCalls(), llvm::Function::hasPersonalityFn(), and llvm::Wasm.

◆ writeSPToGlobal()

void WebAssemblyFrameLowering::writeSPToGlobal	(	unsigned	SrcReg,
		MachineFunction &	MF,
		MachineBasicBlock &	MBB,
		MachineBasicBlock::iterator &	InsertStore,
		const DebugLoc &	DL
	)		const

Write SP back to __stack_pointer global.

Definition at line 232 of file WebAssemblyFrameLowering.cpp.

References llvm::MachineInstrBuilder::addExternalSymbol(), llvm::MachineInstrBuilder::addReg(), llvm::BuildMI(), llvm::MachineFunction::createExternalSymbolName(), DL, getOpcGlobSet(), llvm::MachineFunction::getSubtarget(), MBB, and TII.

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

Member Data Documentation

◆ RedZoneSize

const size_t llvm::WebAssemblyFrameLowering::RedZoneSize = 128

static

Size of the red zone for the user stack (leaf functions can use this much space below the stack pointer without writing it back to __stack_pointer global).

Definition at line 28 of file WebAssemblyFrameLowering.h.

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

lib/Target/WebAssembly/WebAssemblyFrameLowering.h
lib/Target/WebAssembly/WebAssemblyFrameLowering.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WebAssemblyFrameLowering()

Member Function Documentation

◆ eliminateCallFramePseudoInstr()

◆ emitEpilogue()

◆ emitPrologue()

◆ getDwarfFrameBase()

◆ getFPReg()

◆ getLocalForStackObject()

◆ getOpcAdd()

◆ getOpcAnd()

◆ getOpcConst()

◆ getOpcGlobGet()

◆ getOpcGlobSet()

◆ getOpcSub()

◆ getSPReg()

◆ hasFP()

◆ hasReservedCallFrame()

◆ isSupportedStackID()

◆ needsPrologForEH()

◆ writeSPToGlobal()

Member Data Documentation

◆ RedZoneSize