org.graalvm.compiler.nodes.java

Class ArrayLengthNode

java.lang.Object

org.graalvm.compiler.graph.Node

org.graalvm.compiler.nodes.ValueNode

org.graalvm.compiler.nodes.FixedNode

org.graalvm.compiler.nodes.FixedWithNextNode

org.graalvm.compiler.nodes.java.ArrayLengthNode

All Implemented Interfaces:

Cloneable, Formattable, CanonicalizableMarker, FixedNodeInterface, FixedWithNextNodeInterface, MemoryAccess, Canonicalizable, Canonicalizable.Unary<ValueNode>, Lowerable, Virtualizable, ValueNodeInterface

public final class ArrayLengthNode
extends FixedWithNextNode
implements Canonicalizable.Unary<ValueNode>, Lowerable, Virtualizable, MemoryAccess

The ArrayLength instruction gets the length of an array.

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<ArrayLengthNode>	TYPE

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

next

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
ArrayLengthNode(ValueNode array)

Method Summary

Modifier and Type	Method and Description
ValueNode	array()
static int	arrayLength(Object array) Returns the length of the given array.
ValueNode	canonical(CanonicalizerTool tool, ValueNode forValue) Similar to Canonicalizable.canonical(CanonicalizerTool), except that implementations should act as if the current input of the node was the given one, i.e., they should never look at the inputs via the this pointer.
static ValueNode	create(ValueNode forValue, ConstantReflectionProvider constantReflection)
org.graalvm.word.LocationIdentity	getLocationIdentity()
ValueNode	getValue() Gets the current value of the input, so that calling Canonicalizable.Unary.canonical(CanonicalizerTool, Node) with the value returned from this method should behave exactly like Canonicalizable.canonical(CanonicalizerTool).
static boolean	intrinsify(GraphBuilderContext b, ValueNode array)
static ValueNode	readArrayLength(ValueNode originalArray, ConstantReflectionProvider constantReflection) Gets the length of an array if possible.
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.FixedWithNextNode

asFixedWithNextNode, next, setNext

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

asFixedNode, verify

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, 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, 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

Methods inherited from interface org.graalvm.compiler.nodes.spi.Canonicalizable.Unary

canonical

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

lower

Methods inherited from interface org.graalvm.compiler.nodes.memory.MemoryAccess

getLastLocationAccess, setLastLocationAccess

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

asNode

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

asFixedNode

Field Detail

TYPE

public static final NodeClass<ArrayLengthNode> TYPE

Constructor Detail

ArrayLengthNode

public ArrayLengthNode(ValueNode array)

Method Detail

array

public ValueNode array()

getValue

public ValueNode getValue()

Description copied from interface: Canonicalizable.Unary

Gets the current value of the input, so that calling Canonicalizable.Unary.canonical(CanonicalizerTool, Node) with the value returned from this method should behave exactly like Canonicalizable.canonical(CanonicalizerTool).

Specified by:

getValue in interface Canonicalizable.Unary<ValueNode>

getLocationIdentity

public org.graalvm.word.LocationIdentity getLocationIdentity()

Specified by:

getLocationIdentity in interface MemoryAccess

create

public static ValueNode create(ValueNode forValue,
                               ConstantReflectionProvider constantReflection)

canonical

public ValueNode canonical(CanonicalizerTool tool,
                           ValueNode forValue)

Description copied from interface: Canonicalizable.Unary

Similar to Canonicalizable.canonical(CanonicalizerTool), except that implementations should act as if the current input of the node was the given one, i.e., they should never look at the inputs via the this pointer.

Specified by:

canonical in interface Canonicalizable.Unary<ValueNode>

readArrayLength

public static ValueNode readArrayLength(ValueNode originalArray,
                                        ConstantReflectionProvider constantReflection)

Gets the length of an array if possible.

Returns:

a node representing the length of array or null if it is not available

intrinsify

public static boolean intrinsify(GraphBuilderContext b,
                                 ValueNode array)

arrayLength

public static int arrayLength(Object array)

Returns the length of the given array. It does not check if the provided object is an array, so the caller has to check that beforehand.

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