org.graalvm.compiler.replacements.arraycopy

Class ArrayCopyCallNode

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

org.graalvm.compiler.nodes.memory.AbstractMemoryCheckpoint

org.graalvm.compiler.replacements.arraycopy.ArrayCopyCallNode

All Implemented Interfaces:

Cloneable, Formattable, MemoryKillMarker, CanonicalizableMarker, FixedNodeInterface, FixedWithNextNodeInterface, MemoryAccess, MemoryKill, SingleMemoryKill, Canonicalizable, Lowerable, NodeWithState, StateSplit, ValueNodeInterface

public final class ArrayCopyCallNode
extends AbstractMemoryCheckpoint
implements Lowerable, SingleMemoryKill, MemoryAccess, Canonicalizable

Implements System.arraycopy(java.lang.Object, int, java.lang.Object, int, int) via a call to specialized stubs based on the element type and memory properties. The target of the call is queried via ArrayCopyLookup.lookupArraycopyDescriptor(JavaKind, boolean, boolean, boolean, org.graalvm.word.LocationIdentity).

Note: this node does not have an exception edge. Only use in situations where the exception edge is not needed.

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.memory.MemoryKill

MemoryKill.NoLocation

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 ValueNode	dest
protected ValueNode	destPos
protected ValueNode	length
protected ValueNode	src
protected ValueNode	srcPos
static NodeClass<ArrayCopyCallNode>	TYPE

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

stateAfter

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

Fields inherited from interface org.graalvm.compiler.nodes.memory.MemoryKill

MULTI_KILL_NO_LOCATION, NO_LOCATION

Constructor Summary

Constructors

Constructor and Description
ArrayCopyCallNode(ArrayCopyForeignCalls foreignCalls, WordTypes wordTypes, ValueNode src, ValueNode srcPos, ValueNode dest, ValueNode destPos, ValueNode length, JavaKind elementKind, boolean aligned, boolean disjoint, boolean uninitialized, int heapWordSize)
ArrayCopyCallNode(ArrayCopyForeignCalls foreignCalls, WordTypes wordTypes, ValueNode src, ValueNode srcPos, ValueNode dest, ValueNode destPos, ValueNode length, JavaKind copyKind, JavaKind srcKind, JavaKind destKind, boolean aligned, boolean disjoint, boolean uninitialized, int heapWordSize)
ArrayCopyCallNode(ArrayCopyForeignCalls foreignCalls, WordTypes wordTypes, ValueNode src, ValueNode srcPos, ValueNode dest, ValueNode destPos, ValueNode length, JavaKind elementKind, org.graalvm.word.LocationIdentity killedLocationIdentity, boolean aligned, boolean disjoint, boolean uninitialized, int heapWordSize)
ArrayCopyCallNode(ArrayCopyForeignCalls foreignCalls, WordTypes wordTypes, ValueNode src, ValueNode srcPos, ValueNode dest, ValueNode destPos, ValueNode length, JavaKind elementKind, org.graalvm.word.LocationIdentity locationIdentity, org.graalvm.word.LocationIdentity killedLocationIdentity, boolean aligned, boolean disjoint, boolean uninitialized, int heapWordSize)

Method Summary

Modifier and Type	Method and Description
static void	arraycopy(Object src, int srcPos, Object dest, int destPos, int length, JavaKind elementKind, org.graalvm.word.LocationIdentity killedLocationIdentity, int heapWordSize)
static void	arraycopyObjectKillsAny(Object src, int srcPos, Object dest, int destPos, int length, int heapWordSize)
Node	canonical(CanonicalizerTool tool) Implementations of this method can provide local optimizations like constant folding and strength reduction.
static void	disjointArraycopy(Object src, int srcPos, Object dest, int destPos, int length, JavaKind elementKind, int heapWordSize)
static void	disjointArraycopy(Object src, int srcPos, Object dest, int destPos, int length, JavaKind elementKind, org.graalvm.word.LocationIdentity killedLocationIdentity, int heapWordSize)
static void	disjointArraycopyDifferentKinds(Object src, int srcPos, Object dest, int destPos, int length, JavaKind copyKind, JavaKind srcKind, JavaKind destKind, int heapWordSize) Type punned copy of length elements of kind copyKind from an array with srcKind elements to an array with destKind elements.
static void	disjointArraycopyKillsInit(Object src, int srcPos, Object dest, int destPos, int length, JavaKind elementKind, int heapWordSize)
static void	disjointUninitializedArraycopy(Object src, int srcPos, Object dest, int destPos, int length, JavaKind elementKind, int heapWordSize)
ValueNode	getDestination()
ValueNode	getDestinationPosition()
JavaKind	getElementKind()
org.graalvm.word.LocationIdentity	getKilledLocationIdentity() This method is used to determine which memory location is killed by this node.
MemoryKill	getLastLocationAccess()
ValueNode	getLength()
org.graalvm.word.LocationIdentity	getLocationIdentity()
ValueNode	getSource()
ValueNode	getSourcePosition()
boolean	hasSideEffect() Determines if this node has a side-effect.
boolean	isAligned()
boolean	isDisjoint()
boolean	isUninitialized()
void	lower(LoweringTool tool) Expand this node into lower level nodes expressing the same semantics.
void	setLastLocationAccess(MemoryKill lla)
void	updateAlignedDisjoint(MetaAccessProvider metaAccess)

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

setStateAfter, stateAfter, verify

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

asFixedWithNextNode, next, setNext

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

asFixedNode

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, 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.memory.MemoryKill

asMultiMemoryKill, asSingleMemoryKill, isMemoryKill, isMultiMemoryKill, isSingleMemoryKill

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

asNode

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

states

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

asFixedNode

Field Detail

TYPE

public static final NodeClass<ArrayCopyCallNode> TYPE

src

protected ValueNode src

srcPos

protected ValueNode srcPos

dest

protected ValueNode dest

destPos

protected ValueNode destPos

length

protected ValueNode length

Constructor Detail

ArrayCopyCallNode

public ArrayCopyCallNode(ArrayCopyForeignCalls foreignCalls,
                         WordTypes wordTypes,
                         ValueNode src,
                         ValueNode srcPos,
                         ValueNode dest,
                         ValueNode destPos,
                         ValueNode length,
                         JavaKind elementKind,
                         boolean aligned,
                         boolean disjoint,
                         boolean uninitialized,
                         int heapWordSize)

ArrayCopyCallNode

public ArrayCopyCallNode(ArrayCopyForeignCalls foreignCalls,
                         WordTypes wordTypes,
                         ValueNode src,
                         ValueNode srcPos,
                         ValueNode dest,
                         ValueNode destPos,
                         ValueNode length,
                         JavaKind copyKind,
                         JavaKind srcKind,
                         JavaKind destKind,
                         boolean aligned,
                         boolean disjoint,
                         boolean uninitialized,
                         int heapWordSize)

ArrayCopyCallNode

public ArrayCopyCallNode(ArrayCopyForeignCalls foreignCalls,
                         WordTypes wordTypes,
                         ValueNode src,
                         ValueNode srcPos,
                         ValueNode dest,
                         ValueNode destPos,
                         ValueNode length,
                         JavaKind elementKind,
                         org.graalvm.word.LocationIdentity killedLocationIdentity,
                         boolean aligned,
                         boolean disjoint,
                         boolean uninitialized,
                         int heapWordSize)

ArrayCopyCallNode

public ArrayCopyCallNode(ArrayCopyForeignCalls foreignCalls,
                         WordTypes wordTypes,
                         ValueNode src,
                         ValueNode srcPos,
                         ValueNode dest,
                         ValueNode destPos,
                         ValueNode length,
                         JavaKind elementKind,
                         org.graalvm.word.LocationIdentity locationIdentity,
                         org.graalvm.word.LocationIdentity killedLocationIdentity,
                         boolean aligned,
                         boolean disjoint,
                         boolean uninitialized,
                         int heapWordSize)

Method Detail

getSource

public ValueNode getSource()

getSourcePosition

public ValueNode getSourcePosition()

getDestination

public ValueNode getDestination()

getDestinationPosition

public ValueNode getDestinationPosition()

getLength

public ValueNode getLength()

getElementKind

public JavaKind getElementKind()

lower

public void lower(LoweringTool tool)

Description copied from interface: Lowerable

Expand this node into lower level nodes expressing the same semantics. If the introduced nodes are themselves lowerable, they should be recursively lowered as part of this call.

Specified by:

lower in interface Lowerable

getLastLocationAccess

public MemoryKill getLastLocationAccess()

Specified by:

getLastLocationAccess in interface MemoryAccess

Returns:

a MemoryKill that represents the last memory state in the memory graph for the LocationIdentity returned by MemoryAccess.getLocationIdentity()

setLastLocationAccess

public void setLastLocationAccess(MemoryKill lla)

Specified by:

setLastLocationAccess in interface MemoryAccess

Parameters:

lla - the MemoryKill that represents the last kill of the LocationIdentity returned by MemoryAccess.getLocationIdentity()

getLocationIdentity

public org.graalvm.word.LocationIdentity getLocationIdentity()

Specified by:

getLocationIdentity in interface MemoryAccess

getKilledLocationIdentity

public org.graalvm.word.LocationIdentity getKilledLocationIdentity()

Description copied from interface: SingleMemoryKill

This method is used to determine which memory location is killed by this node. Returning the special value LocationIdentity.any() will kill all memory locations.

Specified by:

getKilledLocationIdentity in interface SingleMemoryKill

Returns:

the identity of the location killed by this node.

hasSideEffect

public boolean hasSideEffect()

Description copied from interface: StateSplit

Determines if this node has a side-effect. Such nodes cannot be safely re-executed because they modify state which is visible to other threads or modify state beyond what is captured in FrameState nodes.

Specified by:

hasSideEffect in interface StateSplit

Overrides:

hasSideEffect in class AbstractStateSplit

arraycopyObjectKillsAny

public static void arraycopyObjectKillsAny(Object src,
                                           int srcPos,
                                           Object dest,
                                           int destPos,
                                           int length,
                                           int heapWordSize)

arraycopy

public static void arraycopy(Object src,
                             int srcPos,
                             Object dest,
                             int destPos,
                             int length,
                             JavaKind elementKind,
                             org.graalvm.word.LocationIdentity killedLocationIdentity,
                             int heapWordSize)

disjointArraycopy

public static void disjointArraycopy(Object src,
                                     int srcPos,
                                     Object dest,
                                     int destPos,
                                     int length,
                                     JavaKind elementKind,
                                     int heapWordSize)

disjointArraycopy

public static void disjointArraycopy(Object src,
                                     int srcPos,
                                     Object dest,
                                     int destPos,
                                     int length,
                                     JavaKind elementKind,
                                     org.graalvm.word.LocationIdentity killedLocationIdentity,
                                     int heapWordSize)

disjointArraycopyDifferentKinds

public static void disjointArraycopyDifferentKinds(Object src,
                                                   int srcPos,
                                                   Object dest,
                                                   int destPos,
                                                   int length,
                                                   JavaKind copyKind,
                                                   JavaKind srcKind,
                                                   JavaKind destKind,
                                                   int heapWordSize)

Type punned copy of length elements of kind copyKind from an array with srcKind elements to an array with destKind elements.

disjointArraycopyKillsInit

public static void disjointArraycopyKillsInit(Object src,
                                              int srcPos,
                                              Object dest,
                                              int destPos,
                                              int length,
                                              JavaKind elementKind,
                                              int heapWordSize)

disjointUninitializedArraycopy

public static void disjointUninitializedArraycopy(Object src,
                                                  int srcPos,
                                                  Object dest,
                                                  int destPos,
                                                  int length,
                                                  JavaKind elementKind,
                                                  int heapWordSize)

isAligned

public boolean isAligned()

isDisjoint

public boolean isDisjoint()

isUninitialized

public boolean isUninitialized()

updateAlignedDisjoint

public void updateAlignedDisjoint(MetaAccessProvider metaAccess)

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