org.graalvm.compiler.nodes

Class ConstantNode

java.lang.Object

org.graalvm.compiler.graph.Node

org.graalvm.compiler.nodes.ValueNode

org.graalvm.compiler.nodes.calc.FloatingNode

org.graalvm.compiler.nodes.ConstantNode

All Implemented Interfaces:

Cloneable, Formattable, Node.ValueNumberable, ArrayLengthProvider, LIRLowerable, ValueNodeInterface

public final class ConstantNode
extends FloatingNode
implements LIRLowerable, ArrayLengthProvider

The ConstantNode represents a constant.

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

ArrayLengthProvider.FindLengthMode

Field Summary

Fields

Modifier and Type	Field and Description
static NodeClass<ConstantNode>	TYPE
protected Constant	value

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
ConstantNode(Constant value, Stamp stamp) Constructs a new node representing the specified constant.
ConstantNode(Stamp stamp, ConstantReflectionProvider constantReflection, ResolvedJavaType type)

Method Summary

Modifier and Type	Method and Description
static ConstantNode	defaultForKind(JavaKind kind)
static ConstantNode	defaultForKind(JavaKind kind, StructuredGraph graph)
ValueNode	findLength(ArrayLengthProvider.FindLengthMode mode, ConstantReflectionProvider constantReflection) Returns the length of the array described by this node, or null if it is not available.
static ConstantNode	forBoolean(boolean i) Returns a node for a boolean constant.
static ConstantNode	forBoolean(boolean i, StructuredGraph graph) Returns a node for a boolean constant.
static ConstantNode	forByte(byte i, StructuredGraph graph) Returns a node for a byte constant.
static ConstantNode	forChar(char i, StructuredGraph graph) Returns a node for a char constant.
static Class<?>	forClass(ResolvedJavaType type)
static ConstantNode	forConstant(JavaConstant constant, int stableDimension, boolean isDefaultStable, MetaAccessProvider metaAccess)
static ConstantNode	forConstant(JavaConstant array, MetaAccessProvider metaAccess)
static ConstantNode	forConstant(JavaConstant constant, MetaAccessProvider metaAccess, StructuredGraph graph)
static ConstantNode	forConstant(Stamp stamp, Constant constant, int stableDimension, boolean isDefaultStable, MetaAccessProvider metaAccess)
static ConstantNode	forConstant(Stamp stamp, Constant constant, MetaAccessProvider metaAccess)
static ConstantNode	forConstant(Stamp stamp, Constant constant, MetaAccessProvider metaAccess, StructuredGraph graph)
static ConstantNode	forDouble(double d) Returns a node for a double constant.
static ConstantNode	forDouble(double d, StructuredGraph graph) Returns a node for a double constant.
static ConstantNode	forFloat(float f) Returns a node for a float constant.
static ConstantNode	forFloat(float f, StructuredGraph graph) Returns a node for a float constant.
static ConstantNode	forFloatingKind(JavaKind kind, double value)
static ConstantNode	forFloatingKind(JavaKind kind, double value, StructuredGraph graph)
static ConstantNode	forFloatingStamp(Stamp stamp, double value) Returns a node for a constant double that's compatible to a given stamp.
static ConstantNode	forFloatingStamp(Stamp stamp, double value, StructuredGraph graph) Returns a node for a constant double that's compatible to a given stamp.
static ConstantNode	forInt(int i) Returns a node for an integer constant.
static ConstantNode	forInt(int i, StructuredGraph graph) Returns a node for an integer constant.
static ConstantNode	forIntegerKind(JavaKind kind, long value)
static ConstantNode	forIntegerKind(JavaKind kind, long value, StructuredGraph graph)
static ConstantNode	forIntegerStamp(Stamp stamp, long value) Returns a node for a constant integer that's compatible to a given stamp.
static ConstantNode	forIntegerStamp(Stamp stamp, long value, StructuredGraph graph) Returns a node for a constant integer that's compatible to a given stamp.
static ConstantNode	forLong(long i) Returns a node for an long constant.
static ConstantNode	forLong(long i, StructuredGraph graph) Returns a node for an long constant.
static ConstantNode	forPrimitive(JavaConstant constant) Returns a node for a Java primitive.
static ConstantNode	forPrimitive(JavaConstant constant, StructuredGraph graph) Returns a node for a Java primitive.
static ConstantNode	forPrimitive(Stamp stamp, Constant constant) Returns a node for a primitive of a given type.
static ConstantNode	forPrimitive(Stamp stamp, JavaConstant constant, StructuredGraph graph) Returns a node for a primitive of a given type.
static ConstantNode	forShort(short i, StructuredGraph graph) Returns a node for a short constant.
void	generate(NodeLIRBuilderTool gen)
static NodeIterable<ConstantNode>	getConstantNodes(StructuredGraph graph) Gathers all the ConstantNodes that are inputs to the live nodes in a given graph.
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).
int	getStableDimension()
Constant	getValue()
boolean	isDefaultStable()
void	replace(StructuredGraph graph, Node replacement) Replaces this node at its usages with another node.
String	toString(Verbosity verbosity) Creates a String representation for this with a given Verbosity.

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

asConstant, asJavaConstant, asNode, asSerializableConstant, checkReplaceAtUsagesInvariants, getStackKind, graph, hasUsagesOtherThan, inferStamp, 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, getInsertionPosition, getNodeClass, getNodeSourcePosition, getOptions, getUsageCount, hasExactlyOneUsage, hasExactlyOneUsageOfType, 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, 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<ConstantNode> TYPE

value

protected final Constant value

Constructor Detail

ConstantNode

public ConstantNode(Constant value,
                    Stamp stamp)

Constructs a new node representing the specified constant.

Parameters:

value - the constant

ConstantNode

public ConstantNode(Stamp stamp,
                    ConstantReflectionProvider constantReflection,
                    ResolvedJavaType type)

Method Detail

getValue

public Constant getValue()

Returns:

the constant value represented by this node

getStableDimension

public int getStableDimension()

Returns:

the number of stable dimensions if this is a stable array, otherwise 0

isDefaultStable

public boolean isDefaultStable()

Returns:

true if this is a stable array and the default elements are considered stable

getConstantNodes

public static NodeIterable<ConstantNode> getConstantNodes(StructuredGraph graph)

Gathers all the ConstantNodes that are inputs to the live nodes in a given graph.

replace

public void replace(StructuredGraph graph,
                    Node replacement)

Replaces this node at its usages with another node.

generate

public void generate(NodeLIRBuilderTool gen)

Specified by:

generate in interface LIRLowerable

forConstant

public static ConstantNode forConstant(JavaConstant constant,
                                       MetaAccessProvider metaAccess,
                                       StructuredGraph graph)

forConstant

public static ConstantNode forConstant(JavaConstant constant,
                                       int stableDimension,
                                       boolean isDefaultStable,
                                       MetaAccessProvider metaAccess)

forConstant

public static ConstantNode forConstant(JavaConstant array,
                                       MetaAccessProvider metaAccess)

forConstant

public static ConstantNode forConstant(Stamp stamp,
                                       Constant constant,
                                       MetaAccessProvider metaAccess,
                                       StructuredGraph graph)

forConstant

public static ConstantNode forConstant(Stamp stamp,
                                       Constant constant,
                                       int stableDimension,
                                       boolean isDefaultStable,
                                       MetaAccessProvider metaAccess)

forConstant

public static ConstantNode forConstant(Stamp stamp,
                                       Constant constant,
                                       MetaAccessProvider metaAccess)

forPrimitive

public static ConstantNode forPrimitive(JavaConstant constant,
                                        StructuredGraph graph)

Returns a node for a Java primitive.

forPrimitive

public static ConstantNode forPrimitive(JavaConstant constant)

Returns a node for a Java primitive.

forPrimitive

public static ConstantNode forPrimitive(Stamp stamp,
                                        JavaConstant constant,
                                        StructuredGraph graph)

Returns a node for a primitive of a given type.

forPrimitive

public static ConstantNode forPrimitive(Stamp stamp,
                                        Constant constant)

Returns a node for a primitive of a given type.

forDouble

public static ConstantNode forDouble(double d,
                                     StructuredGraph graph)

Returns a node for a double constant.

Parameters:

d - the double value for which to create the instruction

Returns:

a node for a double constant

forDouble

public static ConstantNode forDouble(double d)

Returns a node for a double constant.

Parameters:

d - the double value for which to create the instruction

Returns:

a node for a double constant

forFloat

public static ConstantNode forFloat(float f,
                                    StructuredGraph graph)

Returns a node for a float constant.

Parameters:

f - the float value for which to create the instruction

Returns:

a node for a float constant

forFloat

public static ConstantNode forFloat(float f)

Returns a node for a float constant.

Parameters:

f - the float value for which to create the instruction

Returns:

a node for a float constant

forLong

public static ConstantNode forLong(long i,
                                   StructuredGraph graph)

Returns a node for an long constant.

Parameters:

i - the long value for which to create the instruction

Returns:

a node for an long constant

forLong

public static ConstantNode forLong(long i)

Returns a node for an long constant.

Parameters:

i - the long value for which to create the instruction

Returns:

a node for an long constant

forInt

public static ConstantNode forInt(int i,
                                  StructuredGraph graph)

Returns a node for an integer constant.

Parameters:

i - the integer value for which to create the instruction

Returns:

a node for an integer constant

forInt

public static ConstantNode forInt(int i)

Returns a node for an integer constant.

Parameters:

i - the integer value for which to create the instruction

Returns:

a node for an integer constant

forBoolean

public static ConstantNode forBoolean(boolean i,
                                      StructuredGraph graph)

Returns a node for a boolean constant.

Parameters:

i - the boolean value for which to create the instruction

Returns:

a node representing the boolean

forBoolean

public static ConstantNode forBoolean(boolean i)

Returns a node for a boolean constant.

Parameters:

i - the boolean value for which to create the instruction

Returns:

a node representing the boolean

forByte

public static ConstantNode forByte(byte i,
                                   StructuredGraph graph)

Returns a node for a byte constant.

Parameters:

i - the byte value for which to create the instruction

Returns:

a node representing the byte

forChar

public static ConstantNode forChar(char i,
                                   StructuredGraph graph)

Returns a node for a char constant.

Parameters:

i - the char value for which to create the instruction

Returns:

a node representing the char

forShort

public static ConstantNode forShort(short i,
                                    StructuredGraph graph)

Returns a node for a short constant.

Parameters:

i - the short value for which to create the instruction

Returns:

a node representing the short

forIntegerStamp

public static ConstantNode forIntegerStamp(Stamp stamp,
                                           long value,
                                           StructuredGraph graph)

Returns a node for a constant integer that's compatible to a given stamp.

forIntegerStamp

public static ConstantNode forIntegerStamp(Stamp stamp,
                                           long value)

Returns a node for a constant integer that's compatible to a given stamp.

forIntegerKind

public static ConstantNode forIntegerKind(JavaKind kind,
                                          long value,
                                          StructuredGraph graph)

forIntegerKind

public static ConstantNode forIntegerKind(JavaKind kind,
                                          long value)

forFloatingKind

public static ConstantNode forFloatingKind(JavaKind kind,
                                           double value,
                                           StructuredGraph graph)

forFloatingKind

public static ConstantNode forFloatingKind(JavaKind kind,
                                           double value)

forFloatingStamp

public static ConstantNode forFloatingStamp(Stamp stamp,
                                            double value,
                                            StructuredGraph graph)

Returns a node for a constant double that's compatible to a given stamp.

forFloatingStamp

public static ConstantNode forFloatingStamp(Stamp stamp,
                                            double value)

Returns a node for a constant double that's compatible to a given stamp.

defaultForKind

public static ConstantNode defaultForKind(JavaKind kind,
                                          StructuredGraph graph)

defaultForKind

public static ConstantNode defaultForKind(JavaKind kind)

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

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

findLength

public ValueNode findLength(ArrayLengthProvider.FindLengthMode mode,
                            ConstantReflectionProvider constantReflection)

Description copied from interface: ArrayLengthProvider

Returns the length of the array described by this node, or null if it is not available. Details of the different modes are documented in ArrayLengthProvider.FindLengthMode. This method should not be called directly. Use GraphUtil.arrayLength(org.graalvm.compiler.nodes.ValueNode, org.graalvm.compiler.nodes.spi.ArrayLengthProvider.FindLengthMode, ConstantReflectionProvider) instead.

Specified by:

findLength in interface ArrayLengthProvider

forClass

public static Class<?> forClass(ResolvedJavaType type)