org.graalvm.compiler.nodes

Class GuardedValueNode

java.lang.Object

org.graalvm.compiler.graph.Node

org.graalvm.compiler.nodes.ValueNode

org.graalvm.compiler.nodes.calc.FloatingNode

org.graalvm.compiler.nodes.FloatingGuardedNode

org.graalvm.compiler.nodes.GuardedValueNode

All Implemented Interfaces:

Cloneable, Formattable, Node.ValueNumberable, CanonicalizableMarker, GuardedNode, Canonicalizable, LimitedValueProxy, LIRLowerable, Proxy, ValueProxy, Virtualizable, ValueNodeInterface

public final class GuardedValueNode
extends FloatingGuardedNode
implements LIRLowerable, Virtualizable, Canonicalizable, ValueProxy

A node that changes the type of its input, usually narrowing it. For example, a GuardedValueNode is used to keep the nodes depending on guards inside a loop during speculative guard movement. A GuardedValueNode will only go away if its guard is null or StructuredGraph.start().

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

Nested classes/interfaces inherited from interface org.graalvm.compiler.nodes.spi.Canonicalizable

Canonicalizable.Binary<T extends Node>, Canonicalizable.BinaryCommutative<T extends Node>, Canonicalizable.Ternary<T extends Node>, Canonicalizable.Unary<T extends Node>

Field Summary

Fields

Modifier and Type	Field and Description
static NodeClass<GuardedValueNode>	TYPE

Fields inherited from class org.graalvm.compiler.nodes.FloatingGuardedNode

guard

Fields inherited from class org.graalvm.compiler.nodes.ValueNode

EMPTY_ARRAY, stamp

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
GuardedValueNode(ValueNode object, GuardingNode guard)

Method Summary

Modifier and Type	Method and Description
Node	canonical(CanonicalizerTool tool) Implementations of this method can provide local optimizations like constant folding and strength reduction.
static ValueNode	create(ValueNode object, GuardingNode guard)
void	generate(NodeLIRBuilderTool generator)
ValueNode	getOriginalNode()
boolean	inferStamp() This method can be overridden by subclasses of ValueNode if they need to recompute their stamp if their inputs change.
ValueNode	object()
void	virtualize(VirtualizerTool tool) A node class can implement this method to convey information about what its effect would be if some of its inputs were virtualized.

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

getGuard, setGuard

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

asConstant, asJavaConstant, asNode, asSerializableConstant, checkReplaceAtUsagesInvariants, getStackKind, graph, hasUsagesOtherThan, isAllowedUsageType, isConstant, isConstantPredicate, isDefaultConstant, isIllegalConstant, isJavaConstant, isNullConstant, isSerializableConstant, recursivelyDataFlowEqualsUpTo, setStamp, stamp, updateStamp, updateUsagesInterface

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

Methods inherited from interface org.graalvm.compiler.nodes.spi.ValueProxy

getGuard

Methods inherited from interface org.graalvm.compiler.nodes.ValueNodeInterface

asNode

Field Detail

TYPE

public static final NodeClass<GuardedValueNode> TYPE

Constructor Detail

GuardedValueNode

public GuardedValueNode(ValueNode object,
                        GuardingNode guard)

Method Detail

create

public static ValueNode create(ValueNode object,
                               GuardingNode guard)

object

public ValueNode object()

generate

public void generate(NodeLIRBuilderTool generator)

Specified by:

generate in interface LIRLowerable

inferStamp

public boolean inferStamp()

Description copied from class: ValueNode

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.

Overrides:

inferStamp in class ValueNode

Returns:

true if the stamp has changed, false otherwise.

virtualize

public void virtualize(VirtualizerTool tool)

Description copied from interface: Virtualizable

A node class can implement this method to convey information about what its effect would be if some of its inputs were virtualized. All modifications must be made through the supplied tool, and not directly on the node, because by the time this method is called the virtualized/non-virtualized state is still speculative and might not hold because of loops, etc.

Specified by:

virtualize in interface Virtualizable

Parameters:

tool - the tool used to describe the effects of this node

canonical

public Node canonical(CanonicalizerTool tool)

Description copied from interface: Canonicalizable

Implementations of this method can provide local optimizations like constant folding and strength reduction. Implementations should look at the properties and inputs of the current node and determine if there is a more optimal and always semantically correct replacement.
The return value determines the effect that the canonicalization will have:

• Returning an pre-existing node will replace the current node with the given one.
• Returning a newly created node (that was not yet added to the graph) will replace the current node with the given one, after adding it to the graph. If both the replacement and the replacee are anchored in control flow (fixed nodes), the replacement will be added to the control flow. It is invalid to replace a non-fixed node with a newly created fixed node (because its placement in the control flow cannot be determined without scheduling).
• Returning null will delete the current node and replace it with null at all usages. Note that it is not necessary to delete floating nodes that have no more usages this way - they will be deleted automatically.

Specified by:

canonical in interface Canonicalizable

Parameters:

tool - provides access to runtime interfaces like MetaAccessProvider

getOriginalNode

public ValueNode getOriginalNode()

Specified by:

getOriginalNode in interface LimitedValueProxy

Specified by:

getOriginalNode in interface Proxy