com.oracle.graal.nodes

Class FrameState

java.lang.Object

com.oracle.graal.graph.Node

com.oracle.graal.nodes.VirtualState

com.oracle.graal.nodes.FrameState

All Implemented Interfaces:

IterableNodeType, Cloneable, Formattable

public final class FrameState
extends VirtualState
implements IterableNodeType

The FrameState class encapsulates the frame state (i.e. local variables and operand stack) at a particular point in the abstract interpretation. This can be used as debug or deoptimization information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	FrameState.TwoSlotMarker

Nested classes/interfaces inherited from class com.oracle.graal.nodes.VirtualState

VirtualState.NodeClosure<T extends Node>, VirtualState.VirtualClosure

Nested classes/interfaces inherited from class com.oracle.graal.graph.Node

Node.ConstantNodeParameter, Node.InjectedNodeParameter, Node.Input, Node.NodeIntrinsic, Node.OptionalInput, Node.Successor, Node.ValueNumberable

Field Summary

Fields

Modifier and Type	Field and Description
int	bci The bytecode index to which this frame state applies.
protected boolean	duringCall
protected int	localsSize
protected ResolvedJavaMethod	method
private static DebugMetric	METRIC_FRAMESTATE_COUNT
(package private) NodeInputList<MonitorIdNode>	monitorIds
(package private) FrameState	outerFrameState
protected boolean	rethrowException
protected int	stackSize
static ValueNode	TWO_SLOT_MARKER Marker value for the second slot of values that occupy two local variable or expression stack slots.
static NodeClass<FrameState>	TYPE
(package private) NodeInputList<ValueNode>	values Contains the locals, the expressions and the locked objects, in this order.
(package private) NodeInputList<EscapeObjectState>	virtualObjectMappings

Fields inherited from class com.oracle.graal.graph.Node

NODE_LIST, NOT_ITERABLE, USE_UNSAFE_TO_CLONE, WithAllEdges, WithNoEdges, WithOnlyInputEdges, WithOnlySucessorEdges

Constructor Summary

Constructors

Constructor and Description
FrameState(FrameState outerFrameState, ResolvedJavaMethod method, int bci, int localsSize, int stackSize, int lockSize, boolean rethrowException, boolean duringCall, List<MonitorIdNode> monitorIds, List<EscapeObjectState> virtualObjectMappings)
FrameState(FrameState outerFrameState, ResolvedJavaMethod method, int bci, List<ValueNode> values, int localsSize, int stackSize, boolean rethrowException, boolean duringCall, List<MonitorIdNode> monitorIds, List<EscapeObjectState> virtualObjectMappings)
FrameState(FrameState outerFrameState, ResolvedJavaMethod method, int bci, ValueNode[] locals, ValueNode[] stack, int stackSize, ValueNode[] locks, List<MonitorIdNode> monitorIds, boolean rethrowException, boolean duringCall)
FrameState(int bci)
FrameState(int bci, ValueNode returnValue) Creates a placeholder frame state with a single element on the stack representing a return value.

Method Summary

Modifier and Type	Method and Description
void	addVirtualObjectMapping(EscapeObjectState virtualObject)
void	applyToNonVirtual(VirtualState.NodeClosure<? super ValueNode> closure)
void	applyToVirtual(VirtualState.VirtualClosure closure) Performs a pre-order iteration over all elements reachable from this state that are a subclass of VirtualState.
private boolean	checkStackDepth(int oldBci, int oldStackSize, boolean oldDuringCall, boolean oldRethrowException, int newBci, int newStackSize, boolean newDuringCall, boolean newRethrowException) Perform a few sanity checks on the transformation of the stack state.
private void	createValues(ValueNode[] locals, ValueNode[] stack, ValueNode[] locks)
FrameState	duplicate() Gets a copy of this frame state.
FrameState	duplicate(int newBci) Gets a copy of this frame state.
FrameState	duplicateModified(int newBci, boolean newRethrowException, Kind popKind, Kind[] pushedSlotKinds, ValueNode[] pushedValues) Creates a copy of this frame state with one stack element of type popKind popped from the stack and the values in pushedValues pushed on the stack.
FrameState	duplicateModified(Kind popKind, Kind pushedSlotKind, ValueNode pushedValue) Creates a copy of this frame state with the top of stack replaced with with pushedValue which must be of type popKind.
FrameState	duplicateModified(StructuredGraph graph, int newBci, boolean newRethrowException, boolean newDuringCall, Kind popKind, Kind[] pushedSlotKinds, ValueNode[] pushedValues) Creates a copy of this frame state with one stack element of type popKind popped from the stack and the values in pushedValues pushed on the stack.
FrameState	duplicateModifiedBeforeCall(int newBci, Kind popKind, Kind[] pushedSlotKinds, ValueNode[] pushedValues)
FrameState	duplicateModifiedDuringCall(int newBci, Kind popKind) Creates a copy of this frame state with one stack element of type popKind popped from the stack.
FrameState	duplicateWithVirtualState() Duplicates a FrameState, along with a deep copy of all connected VirtualState (outer FrameStates, VirtualObjectStates, ...).
boolean	duringCall()
Map<Object,Object>	getDebugProperties(Map<Object,Object> map) Fills a Map with properties of this node for use in debugging (e.g., to view in the ideal graph visualizer).
NodeIterable<FrameState>	innerFrameStates()
boolean	isPartOfThisState(VirtualState state)
ValueNode	localAt(int i) Gets the value in the local variables at the specified index.
int	localsSize() Gets the size of the local variables.
ValueNode	lockAt(int i) Get the monitor owner at the specified index.
int	locksSize() Gets the number of locked monitors in this frame state.
ResolvedJavaMethod	method()
MonitorIdNode	monitorIdAt(int i) Get the MonitorIdNode that corresponds to the locked object at the specified index.
int	monitorIdCount()
NodeInputList<MonitorIdNode>	monitorIds()
int	nestedLockDepth() Gets the number of locked monitors in this frame state and all outer frame states.
FrameState	outerFrameState()
boolean	rethrowException()
void	setOuterFrameState(FrameState x)
ValueNode	stackAt(int i) Get the value on the stack at the specified stack index.
int	stackSize() Gets the current size (height) of the stack.
BytecodePosition	toBytecodePosition()
static BytecodePosition	toBytecodePosition(FrameState fs)
private static String	toString(FrameState frameState)
String	toString(Verbosity verbosity) Creates a String representation for this node with a given Verbosity.
NodeInputList<ValueNode>	values()
boolean	verify()
EscapeObjectState	virtualObjectMappingAt(int i)
int	virtualObjectMappingCount()
NodeInputList<EscapeObjectState>	virtualObjectMappings()

Methods inherited from class com.oracle.graal.nodes.VirtualState

graph

Methods inherited from class com.oracle.graal.graph.Node

acceptInputs, acceptSuccessors, afterClone, assertFalse, assertTrue, cfgPredecessors, cfgSuccessors, clearInputs, clearSuccessors, copyWithInputs, copyWithInputs, equals, fail, formatTo, getDebugProperties, getId, getNodeClass, getUsageAt, getUsageCount, hashCode, hasNoUsages, hasUsages, inputs, isAlive, isAllowedUsageType, isDeleted, markDeleted, modCount, newIdentityMap, newIdentityMap, newIdentityMap, newMap, newMap, newMap, newSet, newSet, predecessor, pushInputs, removeUsage, replaceAndDelete, replaceAtMatchingUsages, replaceAtPredecessor, replaceAtUsages, replaceAtUsages, replaceAtUsages, replaceFirstInput, replaceFirstSuccessor, safeDelete, simplify, successors, toString, updatePredecessor, updateUsages, updateUsagesInterface, usages, valueEquals, verifyEdges, verifyInputs

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final NodeClass<FrameState> TYPE

METRIC_FRAMESTATE_COUNT

private static final DebugMetric METRIC_FRAMESTATE_COUNT

TWO_SLOT_MARKER

public static final ValueNode TWO_SLOT_MARKER

Marker value for the second slot of values that occupy two local variable or expression stack slots. The marker value is used by the bytecode parser, but replaced with null in the values of the FrameState.

localsSize

protected final int localsSize

stackSize

protected final int stackSize

rethrowException

protected boolean rethrowException

See Also:

BytecodeFrame.rethrowException

duringCall

protected final boolean duringCall

outerFrameState

FrameState outerFrameState

values

NodeInputList<ValueNode> values

Contains the locals, the expressions and the locked objects, in this order.

monitorIds

NodeInputList<MonitorIdNode> monitorIds

virtualObjectMappings

NodeInputList<EscapeObjectState> virtualObjectMappings

bci

public final int bci

The bytecode index to which this frame state applies.

method

protected final ResolvedJavaMethod method

Constructor Detail

FrameState

public FrameState(FrameState outerFrameState,
                  ResolvedJavaMethod method,
                  int bci,
                  int localsSize,
                  int stackSize,
                  int lockSize,
                  boolean rethrowException,
                  boolean duringCall,
                  List<MonitorIdNode> monitorIds,
                  List<EscapeObjectState> virtualObjectMappings)

FrameState

public FrameState(FrameState outerFrameState,
                  ResolvedJavaMethod method,
                  int bci,
                  List<ValueNode> values,
                  int localsSize,
                  int stackSize,
                  boolean rethrowException,
                  boolean duringCall,
                  List<MonitorIdNode> monitorIds,
                  List<EscapeObjectState> virtualObjectMappings)

FrameState

public FrameState(int bci)

FrameState

public FrameState(int bci,
                  ValueNode returnValue)

Creates a placeholder frame state with a single element on the stack representing a return value. This allows the parsing of an intrinsic to communicate the returned value in a stateAfter to the inlining call site.

Parameters:

bci - this must be BytecodeFrame.AFTER_BCI

FrameState

public FrameState(FrameState outerFrameState,
                  ResolvedJavaMethod method,
                  int bci,
                  ValueNode[] locals,
                  ValueNode[] stack,
                  int stackSize,
                  ValueNode[] locks,
                  List<MonitorIdNode> monitorIds,
                  boolean rethrowException,
                  boolean duringCall)

Method Detail

createValues

private void createValues(ValueNode[] locals,
                          ValueNode[] stack,
                          ValueNode[] locks)

values

public NodeInputList<ValueNode> values()

monitorIds

public NodeInputList<MonitorIdNode> monitorIds()

outerFrameState

public FrameState outerFrameState()

setOuterFrameState

public void setOuterFrameState(FrameState x)

toBytecodePosition

public BytecodePosition toBytecodePosition()

toBytecodePosition

public static BytecodePosition toBytecodePosition(FrameState fs)

rethrowException

public boolean rethrowException()

See Also:

BytecodeFrame.rethrowException

duringCall

public boolean duringCall()

method

public ResolvedJavaMethod method()

addVirtualObjectMapping

public void addVirtualObjectMapping(EscapeObjectState virtualObject)

virtualObjectMappingCount

public int virtualObjectMappingCount()

virtualObjectMappingAt

public EscapeObjectState virtualObjectMappingAt(int i)

virtualObjectMappings

public NodeInputList<EscapeObjectState> virtualObjectMappings()

duplicate

public FrameState duplicate(int newBci)

Gets a copy of this frame state.

duplicate

public FrameState duplicate()

Gets a copy of this frame state.

duplicateWithVirtualState

public FrameState duplicateWithVirtualState()

Duplicates a FrameState, along with a deep copy of all connected VirtualState (outer FrameStates, VirtualObjectStates, ...).

Specified by:

duplicateWithVirtualState in class VirtualState

duplicateModifiedDuringCall

public FrameState duplicateModifiedDuringCall(int newBci,
                                              Kind popKind)

Creates a copy of this frame state with one stack element of type popKind popped from the stack.

duplicateModifiedBeforeCall

public FrameState duplicateModifiedBeforeCall(int newBci,
                                              Kind popKind,
                                              Kind[] pushedSlotKinds,
                                              ValueNode[] pushedValues)

duplicateModified

public FrameState duplicateModified(int newBci,
                                    boolean newRethrowException,
                                    Kind popKind,
                                    Kind[] pushedSlotKinds,
                                    ValueNode[] pushedValues)

Creates a copy of this frame state with one stack element of type popKind popped from the stack and the values in pushedValues pushed on the stack. The pushedValues will be formatted correctly in slot encoding: a long or double will be followed by a null slot.

duplicateModified

public FrameState duplicateModified(Kind popKind,
                                    Kind pushedSlotKind,
                                    ValueNode pushedValue)

Creates a copy of this frame state with the top of stack replaced with with pushedValue which must be of type popKind.

duplicateModified

public FrameState duplicateModified(StructuredGraph graph,
                                    int newBci,
                                    boolean newRethrowException,
                                    boolean newDuringCall,
                                    Kind popKind,
                                    Kind[] pushedSlotKinds,
                                    ValueNode[] pushedValues)

Creates a copy of this frame state with one stack element of type popKind popped from the stack and the values in pushedValues pushed on the stack. The pushedValues will be formatted correctly in slot encoding: a long or double will be followed by a null slot. The bci will be changed to newBci.

checkStackDepth

private boolean checkStackDepth(int oldBci,
                                int oldStackSize,
                                boolean oldDuringCall,
                                boolean oldRethrowException,
                                int newBci,
                                int newStackSize,
                                boolean newDuringCall,
                                boolean newRethrowException)

Perform a few sanity checks on the transformation of the stack state. The current expectation is that a stateAfter is being transformed into a stateDuring, so the stack depth may change.

localsSize

public int localsSize()

Gets the size of the local variables.

stackSize

public int stackSize()

Gets the current size (height) of the stack.

locksSize

public int locksSize()

Gets the number of locked monitors in this frame state.

nestedLockDepth

public int nestedLockDepth()

Gets the number of locked monitors in this frame state and all outer frame states.

localAt

public ValueNode localAt(int i)

Gets the value in the local variables at the specified index.

Parameters:

i - the index into the locals

Returns:

the instruction that produced the value for the specified local

stackAt

public ValueNode stackAt(int i)

Get the value on the stack at the specified stack index.

Parameters:

i - the index into the stack, with 0 being the bottom of the stack

Returns:

the instruction at the specified position in the stack

lockAt

public ValueNode lockAt(int i)

Get the monitor owner at the specified index.

Parameters:

i - the index into the list of locked monitors.

Returns:

the lock owner at the given index.

monitorIdAt

public MonitorIdNode monitorIdAt(int i)

Get the MonitorIdNode that corresponds to the locked object at the specified index.

monitorIdCount

public int monitorIdCount()

innerFrameStates

public NodeIterable<FrameState> innerFrameStates()

toString

private static String toString(FrameState frameState)

toString

public String toString(Verbosity verbosity)

Description copied from class: Node

Creates a String representation for this node with a given Verbosity.

Overrides:

toString in class Node

getDebugProperties

public Map<Object,Object> getDebugProperties(Map<Object,Object> map)

Description copied from class: Node

Fills a Map with properties of this node for use in debugging (e.g., to view in the ideal graph visualizer). Subclasses overriding this method should also fill the map using their superclass.

Overrides:

getDebugProperties in class Node

verify

public boolean verify()

Overrides:

verify in class Node

applyToNonVirtual

public void applyToNonVirtual(VirtualState.NodeClosure<? super ValueNode> closure)

Specified by:

applyToNonVirtual in class VirtualState

applyToVirtual

public void applyToVirtual(VirtualState.VirtualClosure closure)

Description copied from class: VirtualState

Performs a pre-order iteration over all elements reachable from this state that are a subclass of VirtualState.

Specified by:

applyToVirtual in class VirtualState

isPartOfThisState

public boolean isPartOfThisState(VirtualState state)

Specified by:

isPartOfThisState in class VirtualState