org.graalvm.compiler.lir.framemap

Class FrameMap

java.lang.Object

org.graalvm.compiler.lir.framemap.FrameMap

Direct Known Subclasses:

AArch64FrameMap, AMD64FrameMap

public abstract class FrameMap
extends Object

This class is used to build the stack frame layout for a compiled method. A StackSlot is used to index slots of the frame relative to the stack pointer. The frame size is only fixed after register allocation when all spill slots have been allocated. Both the outgoing argument area and the spill area can grow until then. Therefore, outgoing arguments are indexed from the stack pointer, while spill slots are indexed from the beginning of the frame (and the total frame size has to be added to get the actual offset from the stack pointer).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FrameMap.ReferenceMapBuilderFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	hasOutgoingStackArguments Determines if this frame has values on the stack for outgoing calls.
protected int	initialSpillSize Initial size of the area occupied by spill slots and other stack-allocated memory blocks.
protected int	outgoingSize Size of the area occupied by outgoing overflow arguments.
protected int	spillSize Size of the area occupied by spill slots and other stack-allocated memory blocks.

Constructor Summary

Constructors

Constructor and Description
FrameMap(CodeCacheProvider codeCache, RegisterConfig registerConfig, FrameMap.ReferenceMapBuilderFactory referenceMapFactory) Creates a new frame map for the specified method.

Method Summary

Modifier and Type	Method and Description
boolean	accessesCallerFrame() Determines if an offset to an incoming stack argument was ever returned by FrameMap.offsetForStackSlot(StackSlot).
protected int	alignFrameSize(int size) Aligns the given frame size to the stack alignment size and return the aligned size.
StackSlot	allocateSpillSlot(<any> kind) Reserves a spill slot in the frame of the method being compiled.
StackSlot	allocateStackMemory(int sizeInBytes, int alignmentInBytes) Reserves a contiguous and aligned range of memory in the frame of the method being compiled.
void	callsMethod(CallingConvention cc) Informs the frame map that the compiled code calls a particular method, which may need stack space for outgoing arguments.
abstract int	currentFrameSize() Gets the current size of this frame.
void	finish() Computes the final size of this frame.
boolean	frameNeedsAllocating() Determines if any space is used in the frame apart from the return address slot.
int	frameSize() Gets the allocated space in the compiled frame, not including any ABI required storage like the return address slot or a saved frame pointer.
RegisterConfig	getRegisterConfig()
TargetDescription	getTarget()
ReferenceMapBuilder	newReferenceMapBuilder()
int	offsetForStackSlot(StackSlot slot) Computes the offset of a stack slot relative to the frame register.
int	outgoingSize()
void	reserveOutgoing(int argsSize) Reserves space for stack-based outgoing arguments.
protected int	returnAddressSize()
int	spillSlotSize(<any> kind) Returns the spill slot size for the given ValueKind.
abstract int	totalFrameSize() Gets the total frame size of the compiled frame, including any ABI required storage like the return address slot or a saved frame pointer.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

initialSpillSize

protected int initialSpillSize

Initial size of the area occupied by spill slots and other stack-allocated memory blocks.

spillSize

protected int spillSize

Size of the area occupied by spill slots and other stack-allocated memory blocks.

outgoingSize

protected int outgoingSize

Size of the area occupied by outgoing overflow arguments. This value is adjusted as calling conventions for outgoing calls are retrieved. On some platforms, there is a minimum outgoing size even if no overflow arguments are on the stack.

hasOutgoingStackArguments

protected boolean hasOutgoingStackArguments

Determines if this frame has values on the stack for outgoing calls.

Constructor Detail

FrameMap

public FrameMap(CodeCacheProvider codeCache,
                RegisterConfig registerConfig,
                FrameMap.ReferenceMapBuilderFactory referenceMapFactory)

Creates a new frame map for the specified method. The given registerConfig is optional, in case null is passed the default RegisterConfig from the CodeCacheProvider will be used.

Method Detail

getRegisterConfig

public RegisterConfig getRegisterConfig()

getTarget

public TargetDescription getTarget()

returnAddressSize

protected int returnAddressSize()

accessesCallerFrame

public boolean accessesCallerFrame()

Determines if an offset to an incoming stack argument was ever returned by FrameMap.offsetForStackSlot(StackSlot).

frameSize

public int frameSize()

Gets the allocated space in the compiled frame, not including any ABI required storage like the return address slot or a saved frame pointer. FrameMap.totalFrameSize() includes all storage that is part of the frame.

Returns:

The size of the allocated frame space (in bytes).

outgoingSize

public int outgoingSize()

frameNeedsAllocating

public boolean frameNeedsAllocating()

Determines if any space is used in the frame apart from the return address slot.

totalFrameSize

public abstract int totalFrameSize()

Gets the total frame size of the compiled frame, including any ABI required storage like the return address slot or a saved frame pointer.

Returns:

The total size of the frame (in bytes).

currentFrameSize

public abstract int currentFrameSize()

Gets the current size of this frame. This is the size that would be returned by FrameMap.frameSize() if FrameMap.finish() were called now.

alignFrameSize

protected int alignFrameSize(int size)

Aligns the given frame size to the stack alignment size and return the aligned size.

Parameters:

size - the initial frame size to be aligned

Returns:

the aligned frame size

finish

public void finish()

Computes the final size of this frame. After this method has been called, methods that change the frame size cannot be called anymore, e.g., no more spill slots or outgoing arguments can be requested.

offsetForStackSlot

public int offsetForStackSlot(StackSlot slot)

Computes the offset of a stack slot relative to the frame register.

Parameters:

slot - a stack slot

Returns:

the offset of the stack slot

callsMethod

public void callsMethod(CallingConvention cc)

Informs the frame map that the compiled code calls a particular method, which may need stack space for outgoing arguments.

Parameters:

cc - The calling convention for the called method.

reserveOutgoing

public void reserveOutgoing(int argsSize)

Reserves space for stack-based outgoing arguments.

Parameters:

argsSize - The amount of space (in bytes) to reserve for stack-based outgoing arguments.

spillSlotSize

public int spillSlotSize(<any> kind)

Returns the spill slot size for the given ValueKind. The default value is the size in bytes for the target architecture.

Parameters:

kind - the ValueKind to be stored in the spill slot.

Returns:

the size in bytes

allocateSpillSlot

public StackSlot allocateSpillSlot(<any> kind)

Reserves a spill slot in the frame of the method being compiled. The returned slot is aligned on its natural alignment, i.e., an 8-byte spill slot is aligned at an 8-byte boundary, unless overridden by a subclass.

Parameters:

kind - The kind of the spill slot to be reserved.

Returns:

A spill slot denoting the reserved memory area.

allocateStackMemory

public StackSlot allocateStackMemory(int sizeInBytes,
                                     int alignmentInBytes)

Reserves a contiguous and aligned range of memory in the frame of the method being compiled.

Parameters:

sizeInBytes - the number of bytes to reserve. Must be > 0.

alignmentInBytes - the required alignment of the memory. Must be > 0, a power of 2, and not exceed the OS stack frame alignment.

Returns:

the first reserved stack slot (i.e., at the lowest address)

newReferenceMapBuilder

public ReferenceMapBuilder newReferenceMapBuilder()