org.graalvm.compiler.nodes

Class ValueNode

java.lang.Object

org.graalvm.compiler.graph.Node

org.graalvm.compiler.nodes.ValueNode

All Implemented Interfaces:

Cloneable, Formattable, ValueNodeInterface

Direct Known Subclasses:

CallTargetNode, FixedNode, FloatingNode, MonitorIdNode, PEGraphDecoder.ExceptionPlaceholderNode, VirtualObjectNode

public abstract class ValueNode
extends Node
implements ValueNodeInterface

This class represents a value within the graph, including local variables, phis, and all other instructions.

Nested Class Summary

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
static ValueNode[]	EMPTY_ARRAY
protected Stamp	stamp The kind of this value.
static NodeClass<ValueNode>	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
ValueNode(NodeClass<? extends ValueNode> c, Stamp stamp)

Method Summary

Modifier and Type	Method and Description
Constant	asConstant() Convert this value to a constant if it is a constant, otherwise return null.
JavaConstant	asJavaConstant()
ValueNode	asNode()
SerializableConstant	asSerializableConstant()
protected boolean	checkReplaceAtUsagesInvariants(Node other) Subclasses can override this to check invariants related to replacing uses of this.
JavaKind	getStackKind()
StructuredGraph	graph() Gets the graph context of this.
boolean	hasUsagesOtherThan(ValueNode node, NodeValueMap nodeValueMap) Checks if this node has usages other than the given node node.
boolean	inferStamp() This method can be overridden by subclasses of ValueNode if they need to recompute their stamp if their inputs change.
boolean	isAllowedUsageType(InputType type)
boolean	isConstant() Checks whether this value is a constant (i.e.
static NodePredicate	isConstantPredicate()
boolean	isDefaultConstant()
boolean	isIllegalConstant()
boolean	isJavaConstant()
boolean	isNullConstant() Checks whether this value represents the null constant.
boolean	isSerializableConstant()
boolean	recursivelyDataFlowEqualsUpTo(FloatingNode that, InputType ignoredInputType) Determines whether this node is recursively equal to the other node while ignoring differences in control-flow edges and inputs of the given ignoredInputType.
void	setStamp(Stamp stamp)
Stamp	stamp(NodeView view)
protected boolean	updateStamp(Stamp newStamp) Checks if the given stamp is different than the current one ( newStamp.equals(oldStamp) == false).
protected void	updateUsagesInterface(ValueNodeInterface oldInput, ValueNodeInterface newInput)

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

afterClone, applyInputs, applySuccessors, assertFalse, assertTrue, cfgPredecessors, cfgSuccessors, clearInputs, clearNodeSourcePosition, clearSuccessors, copyWithInputs, copyWithInputs, dataFlowEquals, dynamicNodeSizeEstimate, estimatedNodeCycles, estimatedNodeSize, fail, formatTo, getCreationPosition, getDebug, getDebugProperties, getDebugProperties, getInsertionPosition, getNodeClass, getNodeSourcePosition, getOptions, getUsageCount, hasExactlyOneUsage, hashCode, hasMoreThanOneUsage, hasNoUsages, hasOnlyUsagesOfType, hasUsages, hasUsagesOfType, inputPositions, inputs, isAlive, 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, toString, updateNodeSourcePosition, updatePredecessor, updateUsages, usages, valueEquals, verify, 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<ValueNode> TYPE

EMPTY_ARRAY

public static final ValueNode[] EMPTY_ARRAY

stamp

protected Stamp stamp

The kind of this value. This is JavaKind.Void for instructions that produce no value. This kind is guaranteed to be a stack kind.

Constructor Detail

ValueNode

public ValueNode(NodeClass<? extends ValueNode> c,
                 Stamp stamp)

Method Detail

stamp

public final Stamp stamp(NodeView view)

setStamp

public final void setStamp(Stamp stamp)

graph

public final StructuredGraph graph()

Description copied from class: Node

Gets the graph context of this.

Overrides:

graph in class Node

updateStamp

protected final boolean updateStamp(Stamp newStamp)

Checks if the given stamp is different than the current one ( newStamp.equals(oldStamp) == false). If it is different then the new stamp will become the current stamp for this node.

Returns:

true if the stamp has changed, false otherwise.

inferStamp

public boolean inferStamp()

This method can be overridden by subclasses of ValueNode if they need to recompute their stamp if their inputs change. A typical implementation will compute the stamp and pass it to ValueNode.updateStamp(Stamp), whose return value can be used as the result of this method.

Returns:

true if the stamp has changed, false otherwise.

getStackKind

public final JavaKind getStackKind()

isConstant

public final boolean isConstant()

Checks whether this value is a constant (i.e. it is of type ConstantNode.

Returns:

true if this value is a constant

isConstantPredicate

public static NodePredicate isConstantPredicate()

isNullConstant

public final boolean isNullConstant()

Checks whether this value represents the null constant.

Returns:

true if this value represents the null constant

isDefaultConstant

public final boolean isDefaultConstant()

asConstant

public final Constant asConstant()

Convert this value to a constant if it is a constant, otherwise return null.

Returns:

the JavaConstant represented by this value if it is a constant; null otherwise

isIllegalConstant

public boolean isIllegalConstant()

isJavaConstant

public final boolean isJavaConstant()

asJavaConstant

public final JavaConstant asJavaConstant()

isSerializableConstant

public final boolean isSerializableConstant()

asSerializableConstant

public final SerializableConstant asSerializableConstant()

asNode

public final ValueNode asNode()

Specified by:

asNode in interface ValueNodeInterface

updateUsagesInterface

protected void updateUsagesInterface(ValueNodeInterface oldInput,
                                     ValueNodeInterface newInput)

isAllowedUsageType

public boolean isAllowedUsageType(InputType type)

Overrides:

isAllowedUsageType in class Node

hasUsagesOtherThan

public boolean hasUsagesOtherThan(ValueNode node,
                                  NodeValueMap nodeValueMap)

Checks if this node has usages other than the given node node.

Parameters:

node - node which is ignored when searching for usages

nodeValueMap -

Returns:

true if this node has other usages, false otherwise

checkReplaceAtUsagesInvariants

protected boolean checkReplaceAtUsagesInvariants(Node other)

Description copied from class: Node

Subclasses can override this to check invariants related to replacing uses of this.

Overrides:

checkReplaceAtUsagesInvariants in class Node

Returns:

true if all invariants hold

recursivelyDataFlowEqualsUpTo

public boolean recursivelyDataFlowEqualsUpTo(FloatingNode that,
                                             InputType ignoredInputType)

Determines whether this node is recursively equal to the other node while ignoring differences in control-flow edges and inputs of the given ignoredInputType. Recursive equality is only applied to FloatingNodes reachable via inputs; FixedNodes are only considered equal if they are the same node. WARNING: This method is useful only in very particular contexts, and only for limited purposes. For example, it might be used to check if two values are equal up to memory or guard inputs. Some external knowledge about the memory graph, data flow, control flow, etc., is required to interpret the meaning of this "equality". It is not legal in general to replace one of the "equal" nodes with the other.