org.graalvm.compiler.nodes.java

Class StoreFieldNode

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

org.graalvm.compiler.nodes.java.StoreFieldNode

All Implemented Interfaces:

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

public final class StoreFieldNode
extends AccessFieldNode
implements StateSplit, Virtualizable, Canonicalizable, SingleMemoryKill

The StoreFieldNode represents a write to a static or instance field.

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>

Nested classes/interfaces inherited from interface org.graalvm.compiler.nodes.memory.MemoryKill

MemoryKill.NoLocation

Field Summary

Fields

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

Fields inherited from class org.graalvm.compiler.nodes.java.AccessFieldNode

field, location, memoryOrder

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
StoreFieldNode(ValueNode object, ResolvedJavaField field, ValueNode value)
StoreFieldNode(ValueNode object, ResolvedJavaField field, ValueNode value, FrameState stateAfter)
StoreFieldNode(ValueNode object, ResolvedJavaField field, ValueNode value, FrameState stateAfter, MemoryOrderMode memoryOrder)
StoreFieldNode(ValueNode object, ResolvedJavaField field, ValueNode value, MemoryOrderMode memoryOrder)

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.
NodeCycles	estimatedNodeCycles()
org.graalvm.word.LocationIdentity	getKilledLocationIdentity() This method is used to determine which memory location is killed by this node.
FrameState	getState()
boolean	hasSideEffect() Determines if this node has a side-effect.
void	setStateAfter(FrameState x) Sets the FrameState corresponding to the state of the JVM after execution of this node.
FrameState	stateAfter() Gets the FrameState corresponding to the state of the JVM after execution of this node.
ValueNode	value()
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.java.AccessFieldNode

dynamicNodeSizeEstimate, field, getLocationIdentity, getMemoryOrder, isStatic, object, toString, 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, 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, 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.NodeWithState

states

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

asFixedNode

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

asNode

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

asMultiMemoryKill, asSingleMemoryKill, isMemoryKill, isMultiMemoryKill, isSingleMemoryKill

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

lower

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

ordersMemoryAccesses

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

getLastLocationAccess, setLastLocationAccess

Field Detail

TYPE

public static final NodeClass<StoreFieldNode> TYPE

Constructor Detail

StoreFieldNode

public StoreFieldNode(ValueNode object,
                      ResolvedJavaField field,
                      ValueNode value)

StoreFieldNode

public StoreFieldNode(ValueNode object,
                      ResolvedJavaField field,
                      ValueNode value,
                      MemoryOrderMode memoryOrder)

StoreFieldNode

public StoreFieldNode(ValueNode object,
                      ResolvedJavaField field,
                      ValueNode value,
                      FrameState stateAfter)

StoreFieldNode

public StoreFieldNode(ValueNode object,
                      ResolvedJavaField field,
                      ValueNode value,
                      FrameState stateAfter,
                      MemoryOrderMode memoryOrder)

Method Detail

stateAfter

public FrameState stateAfter()

Description copied from interface: StateSplit

Gets the FrameState corresponding to the state of the JVM after execution of this node.

Specified by:

stateAfter in interface StateSplit

setStateAfter

public void setStateAfter(FrameState x)

Description copied from interface: StateSplit

Sets the FrameState corresponding to the state of the JVM after execution of this node.

Specified by:

setStateAfter in interface StateSplit

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

value

public ValueNode value()

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.

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

getState

public FrameState getState()

estimatedNodeCycles

public NodeCycles estimatedNodeCycles()

Overrides:

estimatedNodeCycles in class 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