org.graalvm.compiler.nodes

Class PiNode

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.PiNode

All Implemented Interfaces:

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

Direct Known Subclasses:

DynamicPiNode, PiArrayNode

public class PiNode
extends FloatingGuardedNode
implements LIRLowerable, Virtualizable, Canonicalizable, ValueProxy

A node that changes the type of its input, usually narrowing it. For example, a PiNode refines the type of a receiver during type-guarded inlining to be the type tested by the guard. In contrast to a GuardedValueNode, a PiNode is useless as soon as the type of its input is as narrow or narrower than the PiNode's type. The PiNode, and therefore also the scheduling restriction enforced by the guard, will go away.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PiNode.IntrinsifyOp
static class	PiNode.Placeholder A placeholder node in a snippet that will be replaced with a PiNode when the snippet is instantiated.
static class	PiNode.PlaceholderStamp A stamp for PiNode.Placeholder nodes which are only used in snippets.

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
protected Stamp	piStamp
static NodeClass<PiNode>	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

Modifier	Constructor and Description
protected	PiNode(NodeClass<? extends PiNode> c, ValueNode object, Stamp stamp, GuardingNode guard)
	PiNode(ValueNode object, ResolvedJavaType toType, boolean exactType, boolean nonNull)
	PiNode(ValueNode object, Stamp stamp)
	PiNode(ValueNode object, Stamp stamp, ValueNode guard)
	PiNode(ValueNode object, ValueNode guard)

Method Summary

Modifier and Type	Method and Description
static Class<?>	asNonNullClass(Object object) Casts an object to have an exact, non-null stamp representing Class.
static Class<?>	asNonNullObject(Object object) Casts an object to have an exact, non-null stamp representing Class.
Node	canonical(CanonicalizerTool tool) Implementations of this method can provide local optimizations like constant folding and strength reduction.
static ValueNode	canonical(ValueNode object, Stamp piStamp, GuardingNode guard, PiNode self)
static ValueNode	create(ValueNode object, Stamp stamp)
static ValueNode	create(ValueNode object, Stamp stamp, ValueNode guard)
static ValueNode	create(ValueNode object, ValueNode 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.
static boolean	intrinsify(GraphBuilderContext b, ValueNode object, ResolvedJavaType toType, boolean exactType, boolean nonNull)
static boolean	intrinsify(GraphBuilderContext b, ValueNode input, ValueNode guard, PiNode.IntrinsifyOp intrinsifyOp)
ValueNode	object()
static Object	piCast(Object object, ResolvedJavaType toType, boolean exactType, boolean nonNull)
static Object	piCastNonNull(Object object, GuardingNode guard) Changes the stamp of an object and ensures the newly stamped value is non-null and does not float above a given guard.
static Object	piCastNonNull(Object object, ResolvedJavaType toType) Changes the stamp of an object to represent a given type and to indicate that the object is not null.
static Class<?>	piCastNonNullClass(Class<?> type, GuardingNode guard) Changes the stamp of an object and ensures the newly stamped value is non-null and does not float above a given guard.
static int	piCastNonZero(int value, GuardingNode guard)
static long	piCastNonZero(long value, GuardingNode guard)
static int	piCastPositive(int value, GuardingNode guard) Changes the stamp of a primitive value and ensures the newly stamped value is positive and does not float above a given guard.
static Object	piCastToSnippetReplaceeStamp(Object object) Changes the stamp of an object inside a snippet to be the stamp of the node replaced by the snippet.
Stamp	piStamp() A stamp expressing the property that is proved by the guard, but not more.
void	setOriginalNode(ValueNode newNode)
void	strengthenPiStamp(Stamp newPiStamp)
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<PiNode> TYPE

piStamp

protected Stamp piStamp

Constructor Detail

PiNode

protected PiNode(NodeClass<? extends PiNode> c,
                 ValueNode object,
                 Stamp stamp,
                 GuardingNode guard)

PiNode

public PiNode(ValueNode object,
              Stamp stamp)

PiNode

public PiNode(ValueNode object,
              Stamp stamp,
              ValueNode guard)

PiNode

public PiNode(ValueNode object,
              ValueNode guard)

PiNode

public PiNode(ValueNode object,
              ResolvedJavaType toType,
              boolean exactType,
              boolean nonNull)

Method Detail

object

public ValueNode object()

create

public static ValueNode create(ValueNode object,
                               Stamp stamp)

create

public static ValueNode create(ValueNode object,
                               Stamp stamp,
                               ValueNode guard)

create

public static ValueNode create(ValueNode object,
                               ValueNode guard)

intrinsify

public static boolean intrinsify(GraphBuilderContext b,
                                 ValueNode input,
                                 ValueNode guard,
                                 PiNode.IntrinsifyOp intrinsifyOp)

intrinsify

public static boolean intrinsify(GraphBuilderContext b,
                                 ValueNode object,
                                 ResolvedJavaType toType,
                                 boolean exactType,
                                 boolean nonNull)

piStamp

public final Stamp piStamp()

A stamp expressing the property that is proved by the guard, but not more.

For example, if the guard proves a property x >= 0 on an int value, then the PiNode.piStamp() should be StampFactory.positiveInt(). If the input value's stamp is constrained, e.g., [-100 - 100], then this pi's overall ValueNode.stamp(NodeView) will be [0 - 100], computed as the join of the PiNode.piStamp() and the input's stamp.

strengthenPiStamp

public void strengthenPiStamp(Stamp newPiStamp)

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 static ValueNode canonical(ValueNode object,
                                  Stamp piStamp,
                                  GuardingNode guard,
                                  PiNode self)

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

setOriginalNode

public void setOriginalNode(ValueNode newNode)

asNonNullClass

public static Class<?> asNonNullClass(Object object)

Casts an object to have an exact, non-null stamp representing Class.

asNonNullObject

public static Class<?> asNonNullObject(Object object)

Casts an object to have an exact, non-null stamp representing Class.

piCastToSnippetReplaceeStamp

public static Object piCastToSnippetReplaceeStamp(Object object)

Changes the stamp of an object inside a snippet to be the stamp of the node replaced by the snippet.

piCastPositive

public static int piCastPositive(int value,
                                 GuardingNode guard)

Changes the stamp of a primitive value and ensures the newly stamped value is positive and does not float above a given guard.

Parameters:

value - an arbitrary int value

guard - a node proving that value >= 0 holds at some point in the graph

Returns:

the value with its stamp clamped to exclude negative values, guarded by guard

piCastNonZero

public static int piCastNonZero(int value,
                                GuardingNode guard)

piCastNonZero

public static long piCastNonZero(long value,
                                 GuardingNode guard)

piCastNonNull

public static Object piCastNonNull(Object object,
                                   GuardingNode guard)

Changes the stamp of an object and ensures the newly stamped value is non-null and does not float above a given guard.

piCastNonNullClass

public static Class<?> piCastNonNullClass(Class<?> type,
                                          GuardingNode guard)

Changes the stamp of an object and ensures the newly stamped value is non-null and does not float above a given guard.

piCastNonNull

public static Object piCastNonNull(Object object,
                                   ResolvedJavaType toType)

Changes the stamp of an object to represent a given type and to indicate that the object is not null.

piCast

public static Object piCast(Object object,
                            ResolvedJavaType toType,
                            boolean exactType,
                            boolean nonNull)