com.oracle.graal.lir.framemap

Class FrameMap

java.lang.Object

com.oracle.graal.lir.framemap.FrameMap

Direct Known Subclasses:

AMD64FrameMap, SPARCFrameMap

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 are 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
private boolean	accessesCallerFrame Records whether an offset to an incoming stack argument was ever returned by offsetForStackSlot(StackSlot).
private int	frameSize The final frame size, not including the size of the return address slot.
private 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.
private List<StackSlot>	objectStackSlots The list of stack slots allocated in this frame that are present in every reference map.
protected int	outgoingSize Size of the area occupied by outgoing overflow arguments.
private FrameMap.ReferenceMapBuilderFactory	referenceMapFactory
private RegisterConfig	registerConfig
protected int	spillSize Size of the area occupied by spill slots and other stack-allocated memory blocks.
private TargetDescription	target

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 offsetForStackSlot(StackSlot).
void	addLiveValues(ReferenceMapBuilder refMap)
protected void	addObjectStackSlot(StackSlot objectSlot)
protected abstract int	alignFrameSize(int size) Aligns the given frame size to the stack alignment size and return the aligned size.
protected abstract StackSlot	allocateNewSpillSlot(LIRKind kind, int additionalOffset) Reserves a new spill slot in the frame of the method being compiled.
StackSlot	allocateSpillSlot(LIRKind kind) Reserves a spill slot in the frame of the method being compiled.
StackSlot	allocateStackSlots(int slots, BitSet objects) Reserves a number of contiguous slots in the frame of the method being compiled.
protected int	calleeSaveAreaSize()
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 frame size of the compiled frame, not including the size of the return address slot.
RegisterConfig	getRegisterConfig()
TargetDescription	getTarget()
ReferenceMapBuilder	newReferenceMapBuilder()
int	offsetForStackSlot(StackSlot slot) Computes the offset of a stack slot relative to the frame register.
abstract int	offsetToCalleeSaveArea() Gets the offset from the stack pointer to the stack area where callee-saved registers are stored.
int	outgoingSize()
void	reserveOutgoing(int argsSize) Reserves space for stack-based outgoing arguments.
protected int	returnAddressSize()
int	spillSlotRangeSize(int slots) Returns the size of the stack slot range for slots objects.
int	spillSlotSize(LIRKind kind) Returns the spill slot size for the given LIRKind.
abstract int	totalFrameSize() Gets the total frame size of the compiled frame, including the size of the return address slot.

Methods inherited from class java.lang.Object

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

Field Detail

target

private final TargetDescription target

registerConfig

private final RegisterConfig registerConfig

referenceMapFactory

private final FrameMap.ReferenceMapBuilderFactory referenceMapFactory

frameSize

private int frameSize

The final frame size, not including the size of the return address slot. The value is only set after register allocation is complete, i.e., after all spill slots have been allocated.

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

private boolean hasOutgoingStackArguments

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

objectStackSlots

private final List<StackSlot> objectStackSlots

The list of stack slots allocated in this frame that are present in every reference map.

accessesCallerFrame

private boolean accessesCallerFrame

Records whether an offset to an incoming stack argument was ever returned by offsetForStackSlot(StackSlot).

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

addLiveValues

public void addLiveValues(ReferenceMapBuilder refMap)

returnAddressSize

protected int returnAddressSize()

calleeSaveAreaSize

protected int calleeSaveAreaSize()

accessesCallerFrame

public boolean accessesCallerFrame()

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

frameSize

public int frameSize()

Gets the frame size of the compiled frame, not including the size of the return address slot.

Returns:

The size of the frame (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 the size of the return address slot.

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 frameSize() if finish() were called now.

alignFrameSize

protected abstract 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

offsetToCalleeSaveArea

public abstract int offsetToCalleeSaveArea()

Gets the offset from the stack pointer to the stack area where callee-saved registers are stored.

Returns:

The offset to the callee save area (in bytes).

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.

allocateNewSpillSlot

protected abstract StackSlot allocateNewSpillSlot(LIRKind kind,
                                                  int additionalOffset)

Reserves a new 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.

Parameters:

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

additionalOffset -

Returns:

A spill slot denoting the reserved memory area.

spillSlotSize

public int spillSlotSize(LIRKind kind)

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

Parameters:

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

Returns:

the size in bytes

allocateSpillSlot

public StackSlot allocateSpillSlot(LIRKind 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.

spillSlotRangeSize

public int spillSlotRangeSize(int slots)

Returns the size of the stack slot range for slots objects.

Parameters:

slots - The number of slots.

Returns:

The size in byte

allocateStackSlots

public StackSlot allocateStackSlots(int slots,
                                    BitSet objects)

Reserves a number of contiguous slots in the frame of the method being compiled. If the requested number of slots is 0, this method returns null.

Parameters:

slots - the number of slots to reserve

objects - specifies the indexes of the object pointer slots. The caller is responsible for guaranteeing that each such object pointer slot is initialized before any instruction that uses a reference map. Without this guarantee, the garbage collector could see garbage object values.

Returns:

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

addObjectStackSlot

protected void addObjectStackSlot(StackSlot objectSlot)

newReferenceMapBuilder

public ReferenceMapBuilder newReferenceMapBuilder()