org.graalvm.compiler.nodes

Class FrameState

java.lang.Object

org.graalvm.compiler.graph.Node

org.graalvm.compiler.nodes.VirtualState

org.graalvm.compiler.nodes.FrameState

All Implemented Interfaces:

Cloneable, Formattable, IterableNodeType

public final class FrameState
extends VirtualState
implements IterableNodeType

The FrameState class encapsulates the frame state (i.e. local variables, operand stack and locked objects) 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
static interface	FrameState.ValueFunction Function for computing a value in this frame state.

Nested classes/interfaces inherited from class org.graalvm.compiler.nodes.VirtualState

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

Nested classes/interfaces inherited from class org.graalvm.compiler.graph.Node

Node.ConstantNodeParameter, Node.EdgeVisitor, Node.IndirectCanonicalization, Node.InjectedNodeParameter, Node.Input, Node.NodeInsertionStackTrace, Node.NodeIntrinsic, Node.NodeIntrinsicFactory, 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.
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

Fields inherited from class org.graalvm.compiler.graph.Node

NODE_LIST, NOT_ITERABLE, TRACK_CREATION_POSITION, WithAllEdges, WithNoEdges, WithOnlyInputEdges, WithOnlySucessorEdges

Constructor Summary

Constructors

Constructor and Description
FrameState(FrameState outerFrameState, Bytecode code, int bci, int localsSize, int stackSize, int locksSize, boolean rethrowException, boolean duringCall, List<MonitorIdNode> monitorIds, List<EscapeObjectState> virtualObjectMappings)
FrameState(FrameState outerFrameState, Bytecode code, int bci, List<ValueNode> values, int localsSize, int stackSize, int locksSize, boolean rethrowException, boolean duringCall, List<MonitorIdNode> monitorIds, List<EscapeObjectState> virtualObjectMappings, FrameState.ValueFunction valueFunction)
FrameState(FrameState outerFrameState, Bytecode code, int bci, ValueNode[] locals, ValueNode[] stack, int stackSize, JavaKind[] pushedSlotKinds, ValueNode[] pushedValues, ValueNode[] locks, List<MonitorIdNode> monitorIds, boolean rethrowException, boolean duringCall)
FrameState(int bci)
FrameState(int bci, ValueNode returnValueOrExceptionObject) Creates a placeholder frame state with a single element on the stack representing a return value or thrown exception.

Method Summary

Modifier and Type	Method and Description
void	addVirtualObjectMapping(EscapeObjectState virtualObject)
void	applyToNonVirtual(VirtualState.NodePositionClosure<? super Node> closure)
void	applyToVirtual(VirtualState.VirtualClosure closure) Performs a pre-order iteration over all elements reachable from this state that are a subclass of VirtualState.
boolean	canProduceBytecodeFrame() Determines if this frame state can be converted to a BytecodeFrame.
FrameState	duplicate() Gets a copy of this frame state.
FrameState	duplicate(FrameState.ValueFunction valueFunc) Gets a copy of this frame state with each value in the copy computed by applying valueFunc to the FrameState.values() in this frame state.
FrameState	duplicateModified(JavaKind popKind, JavaKind pushedSlotKind, ValueNode pushedValue, List<EscapeObjectState> pushedVirtualObjectMappings) Creates a copy of this frame state with the top of stack replaced with pushedValue which must be of type popKind.
FrameState	duplicateModified(StructuredGraph graph, int newBci, boolean newRethrowException, boolean newDuringCall, JavaKind popKind, JavaKind[] pushedSlotKinds, ValueNode[] pushedValues, List<EscapeObjectState> pushedVirtualObjectMappings)
FrameState	duplicateModified(StructuredGraph graph, int newBci, boolean newRethrowException, boolean newDuringCall, JavaKind popKind, JavaKind[] pushedSlotKinds, ValueNode[] pushedValues, List<EscapeObjectState> pushedVirtualObjectMappings, boolean checkStackDepth) 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, JavaKind popKind, JavaKind[] pushedSlotKinds, ValueNode[] pushedValues, List<EscapeObjectState> pushedVirtualObjectMappings)
FrameState	duplicateModifiedDuringCall(int newBci, JavaKind 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()
Bytecode	getCode()
Map<Object,Object>	getDebugProperties(Map<Object,Object> map) Fills a Map with properties of this for use in debugging (e.g., to view in the ideal graph visualizer).
Node	getInput(Position p) Wrapper for Position.get(Node) that is aware of the local variable storage truncation in FrameState.values().
ResolvedJavaMethod	getMethod()
NodeIterable<FrameState>	innerFrameStates()
boolean	isExceptionHandlingBCI()
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.
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 size (height) of the stack.
static NodeSourcePosition	toSourcePosition(FrameState fs)
String	toString(Verbosity verbosity) Creates a String representation for this with a given Verbosity.
NodeInputList<ValueNode>	values() Gets the list of values in this frame state.
boolean	verify()
EscapeObjectState	virtualObjectMappingAt(int i)
int	virtualObjectMappingCount()
NodeInputList<EscapeObjectState>	virtualObjectMappings()

Methods inherited from class org.graalvm.compiler.nodes.VirtualState

graph

Methods inherited from class org.graalvm.compiler.graph.Node

afterClone, applyInputs, applySuccessors, assertFalse, assertTrue, cfgPredecessors, cfgSuccessors, checkReplaceAtUsagesInvariants, clearInputs, clearNodeSourcePosition, clearSuccessors, copyWithInputs, copyWithInputs, dataFlowEquals, dynamicNodeSizeEstimate, estimatedNodeCycles, estimatedNodeSize, fail, formatTo, getCreationPosition, getDebug, getDebugProperties, getInsertionPosition, getNodeClass, getNodeSourcePosition, getOptions, getUsageCount, hasExactlyOneUsage, hashCode, hasMoreThanOneUsage, hasNoUsages, hasOnlyUsagesOfType, hasUsages, hasUsagesOfType, inputPositions, inputs, isAlive, isAllowedUsageType, isDeleted, isUnregistered, markDeleted, maybeNotifyZeroUsages, modCount, predecessor, pushInputs, removeUsage, replaceAllInputs, replaceAndDelete, replaceAtAllUsages, replaceAtMatchingUsages, replaceAtPredecessor, replaceAtUsages, replaceAtUsages, replaceAtUsages, replaceAtUsages, replaceAtUsages, replaceAtUsagesAndDelete, replaceAtUsagesAndDelete, replaceFirstInput, replaceFirstSuccessor, safeDelete, setCreationPosition, setInsertionPosition, setNodeSourcePosition, singleUsage, successorPositions, successors, toString, updateNodeSourcePosition, updatePredecessor, updateUsages, usages, valueEquals, verifyEdges, verifyInputs, verifySourcePosition, withNodeSourcePosition

Methods inherited from class java.lang.Object

clone, equals, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final NodeClass<FrameState> TYPE

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 FrameState.values of the FrameState.

bci

public final int bci

The bytecode index to which this frame state applies.

Constructor Detail

FrameState

public FrameState(FrameState outerFrameState,
                  Bytecode code,
                  int bci,
                  int localsSize,
                  int stackSize,
                  int locksSize,
                  boolean rethrowException,
                  boolean duringCall,
                  List<MonitorIdNode> monitorIds,
                  List<EscapeObjectState> virtualObjectMappings)

FrameState

public FrameState(FrameState outerFrameState,
                  Bytecode code,
                  int bci,
                  List<ValueNode> values,
                  int localsSize,
                  int stackSize,
                  int locksSize,
                  boolean rethrowException,
                  boolean duringCall,
                  List<MonitorIdNode> monitorIds,
                  List<EscapeObjectState> virtualObjectMappings,
                  FrameState.ValueFunction valueFunction)

Parameters:

values - see FrameState.values()

FrameState

public FrameState(int bci)

FrameState

public FrameState(int bci,
                  ValueNode returnValueOrExceptionObject)

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

Parameters:

bci - this must be BytecodeFrame.AFTER_BCI

FrameState

public FrameState(FrameState outerFrameState,
                  Bytecode code,
                  int bci,
                  ValueNode[] locals,
                  ValueNode[] stack,
                  int stackSize,
                  JavaKind[] pushedSlotKinds,
                  ValueNode[] pushedValues,
                  ValueNode[] locks,
                  List<MonitorIdNode> monitorIds,
                  boolean rethrowException,
                  boolean duringCall)

Method Detail

values

public NodeInputList<ValueNode> values()

Gets the list of values in this frame state. The returned list contains the locked objects, the expression stack and the used locals in that order. The used locals are those up to and including the last non-null local. That is, no storage is allocated for the trailing null locals.

   <-- locksSize --> <-- stackSize --> <----- localsSize ---->
  +-----------------+-----------------+---------+-------------+
  |      locks      |      stack      | locals  | null locals |
  +-----------------+-----------------+---------+-------------+
   <-------------- values.size() -------------->
 

getInput

public Node getInput(Position p)

Wrapper for Position.get(Node) that is aware of the local variable storage truncation in FrameState.values(). That is, if p denotes a valid local variable index for which there is no allocated storage, null is returned.

monitorIds

public NodeInputList<MonitorIdNode> monitorIds()

outerFrameState

public FrameState outerFrameState()

setOuterFrameState

public void setOuterFrameState(FrameState x)

toSourcePosition

public static NodeSourcePosition toSourcePosition(FrameState fs)

rethrowException

public boolean rethrowException()

See Also:

BytecodeFrame.rethrowException

duringCall

public boolean duringCall()

getCode

public Bytecode getCode()

getMethod

public ResolvedJavaMethod getMethod()

canProduceBytecodeFrame

public boolean canProduceBytecodeFrame()

Determines if this frame state can be converted to a BytecodeFrame. Since a BytecodeFrame encodes FrameState.getMethod() and FrameState.bci, it does not preserve FrameState.getCode(). FrameState.bci is only guaranteed to be valid in terms of getCode().getCode() which may be different from getMethod().getCode() if the latter has been subject to instrumentation.

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

Gets a copy of this frame state.

duplicate

public FrameState duplicate(FrameState.ValueFunction valueFunc)

Gets a copy of this frame state with each value in the copy computed by applying valueFunc to the FrameState.values() in 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,
                                              JavaKind 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,
                                              JavaKind popKind,
                                              JavaKind[] pushedSlotKinds,
                                              ValueNode[] pushedValues,
                                              List<EscapeObjectState> pushedVirtualObjectMappings)

duplicateModified

public FrameState duplicateModified(JavaKind popKind,
                                    JavaKind pushedSlotKind,
                                    ValueNode pushedValue,
                                    List<EscapeObjectState> pushedVirtualObjectMappings)

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

duplicateModified

public FrameState duplicateModified(StructuredGraph graph,
                                    int newBci,
                                    boolean newRethrowException,
                                    boolean newDuringCall,
                                    JavaKind popKind,
                                    JavaKind[] pushedSlotKinds,
                                    ValueNode[] pushedValues,
                                    List<EscapeObjectState> pushedVirtualObjectMappings)

duplicateModified

public FrameState duplicateModified(StructuredGraph graph,
                                    int newBci,
                                    boolean newRethrowException,
                                    boolean newDuringCall,
                                    JavaKind popKind,
                                    JavaKind[] pushedSlotKinds,
                                    ValueNode[] pushedValues,
                                    List<EscapeObjectState> pushedVirtualObjectMappings,
                                    boolean checkStackDepth)

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.

localsSize

public int localsSize()

Gets the size of the local variables.

stackSize

public int stackSize()

Gets the 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

public String toString(Verbosity verbosity)

Description copied from class: Node

Creates a String representation for this 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 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

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

applyToNonVirtual

public void applyToNonVirtual(VirtualState.NodePositionClosure<? super Node> closure)

Specified by:

applyToNonVirtual in class VirtualState

isPartOfThisState

public boolean isPartOfThisState(VirtualState state)

Specified by:

isPartOfThisState in class VirtualState

isExceptionHandlingBCI

public boolean isExceptionHandlingBCI()