org.graalvm.compiler.replacements.nodes

Class MacroNode

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.replacements.nodes.MacroNode

All Implemented Interfaces:

Cloneable, Formattable, MemoryKillMarker, DeoptBciSupplier, FixedNodeInterface, FixedWithNextNodeInterface, Invokable, MemoryKill, SingleMemoryKill, Lowerable, NodeWithState, StateSplit, ValueNodeInterface, MacroInvokable

Direct Known Subclasses:

BasicObjectCloneNode, CallSiteTargetNode, MethodHandleNode, ProfileBooleanNode, PureFunctionMacroNode, ReflectionGetCallerClassNode, VirtualizableInvokeMacroNode

public abstract class MacroNode
extends FixedWithNextNode
implements MacroInvokable

See Also:

MacroInvokable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MacroNode.MacroParams Encapsulates the parameters for constructing a MacroNode that are the same for all leaf constructor call sites.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected NodeInputList<ValueNode>	arguments
protected int	bci
protected ResolvedJavaMethod	callerMethod
protected CallTargetNode.InvokeKind	invokeKind
protected StampPair	returnStamp
protected FrameState	stateAfter
protected ResolvedJavaMethod	targetMethod
static NodeClass<MacroNode>	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

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

MULTI_KILL_NO_LOCATION, NO_LOCATION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MacroNode(NodeClass<? extends MacroNode> c, MacroNode.MacroParams p)

Method Summary

Modifier and Type	Method and Description
protected void	afterClone(Node other)
int	bci()
protected InvokeNode	createInvoke(boolean verifyStamp) Replace this node with the equivalent invoke.
NodeInputList<ValueNode>	getArguments() Gets the arguments for this macro node.
ResolvedJavaMethod	getContextMethod() Returns the method from which the call is executed.
CallTargetNode.InvokeKind	getInvokeKind()
org.graalvm.word.LocationIdentity	getKilledLocationIdentity() Returns LocationIdentity.any().
org.graalvm.word.LocationIdentity	getLocationIdentity()
ResolvedJavaMethod	getTargetMethod()
boolean	hasSideEffect() Determines if this node has a side-effect.
boolean	inferStamp() This method can be overridden by subclasses of ValueNode if they need to recompute their stamp if their inputs change.
Invoke	replaceWithInvoke() Replaces this node with an invoke of the target method.
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[]	toArgumentArray()
protected void	verifyStamp()

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, isAllowedUsageType, isConstant, isConstantPredicate, isDefaultConstant, isIllegalConstant, isJavaConstant, isNullConstant, isSerializableConstant, recursivelyDataFlowEqualsUpTo, setStamp, stamp, updateStamp, updateUsagesInterface

Methods inherited from class org.graalvm.compiler.graph.Node

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.replacements.nodes.MacroInvokable

assertArgumentCount, getArgument, getArgumentCount, lower, lowerReplacement, setBci

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

asFixedNodeOrNull, updateInliningLogAfterClone, updateInliningLogAfterRegister

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

Field Detail

TYPE

public static final NodeClass<MacroNode> TYPE

arguments

protected NodeInputList<ValueNode> arguments

stateAfter

protected FrameState stateAfter

bci

protected final int bci

callerMethod

protected final ResolvedJavaMethod callerMethod

targetMethod

protected final ResolvedJavaMethod targetMethod

invokeKind

protected final CallTargetNode.InvokeKind invokeKind

returnStamp

protected final StampPair returnStamp

Constructor Detail

MacroNode

protected MacroNode(NodeClass<? extends MacroNode> c,
                    MacroNode.MacroParams p)

Method Detail

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.

verifyStamp

protected void verifyStamp()

getContextMethod

public ResolvedJavaMethod getContextMethod()

Description copied from interface: Invokable

Returns the method from which the call is executed.

Specified by:

getContextMethod in interface Invokable

Returns:

the method from which the call is executed.

getArguments

public NodeInputList<ValueNode> getArguments()

Description copied from interface: MacroInvokable

Gets the arguments for this macro node.

Specified by:

getArguments in interface MacroInvokable

toArgumentArray

public ValueNode[] toArgumentArray()

bci

public int bci()

Specified by:

bci in interface DeoptBciSupplier

Returns:

the byte code index (BCI) associated with the node implementing this interface

getTargetMethod

public ResolvedJavaMethod getTargetMethod()

Specified by:

getTargetMethod in interface Invokable

getInvokeKind

public CallTargetNode.InvokeKind getInvokeKind()

Specified by:

getInvokeKind in interface MacroInvokable

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

getKilledLocationIdentity

public final org.graalvm.word.LocationIdentity getKilledLocationIdentity()

Returns LocationIdentity.any(). This node needs to kill any location because it might get replaced with an invoke and InvokeNode.getKilledLocationIdentity() kills LocationIdentity.any() and the kill location must not get broader.

Specified by:

getKilledLocationIdentity in interface SingleMemoryKill

Returns:

the identity of the location killed by this node.

afterClone

protected void afterClone(Node other)

Overrides:

afterClone in class Node

replaceWithInvoke

public Invoke replaceWithInvoke()

Description copied from interface: MacroInvokable

Replaces this node with an invoke of the target method.

Specified by:

replaceWithInvoke in interface MacroInvokable

Returns:

the newly create Invoke

getLocationIdentity

public org.graalvm.word.LocationIdentity getLocationIdentity()

createInvoke

protected InvokeNode createInvoke(boolean verifyStamp)

Replace this node with the equivalent invoke. If we are falling back to the original invoke then the stamp of the current node isn't permitted to be different than the actual invoke because this would leave the graph in an inconsistent state.