org.graalvm.compiler.replacements.nodes

Interface MacroInvokable

All Superinterfaces:

DeoptBciSupplier, FixedNodeInterface, Invokable, Lowerable, MemoryKill, MemoryKillMarker, NodeWithState, SingleMemoryKill, StateSplit, ValueNodeInterface

All Known Implementing Classes:

BasicObjectCloneNode, CallSiteTargetNode, HotSpotReflectionGetCallerClassNode, MacroNode, MacroWithExceptionNode, MethodHandleNode, ObjectCloneNode, ProfileBooleanNode, PureFunctionMacroNode, ReflectionGetCallerClassNode, SnippetSubstitutionNode, VirtualizableInvokeMacroNode

public interface MacroInvokable
extends Invokable, Lowerable, StateSplit, SingleMemoryKill

Macro invokable nodes can be used to temporarily replace an invoke. They can, for example, be used to implement constant folding for known JDK functions like Class.isInterface().

During lowering subclasses may lower the node as appropriate. Otherwise, the macro node is replaced with an Invoke.

Nested Class Summary

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

MemoryKill.NoLocation

Field Summary

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

MULTI_KILL_NO_LOCATION, NO_LOCATION

Method Summary

Modifier and Type	Method and Description
static boolean	assertArgumentCount(MacroInvokable macro)
default ValueNode	getArgument(int index)
default int	getArgumentCount()
NodeInputList<ValueNode>	getArguments() Gets the arguments for this macro node.
CallTargetNode.InvokeKind	getInvokeKind()
default void	lower(LoweringTool tool) Expand this node into lower level nodes expressing the same semantics.
static StructuredGraph	lowerReplacement(StructuredGraph graph, StructuredGraph replacementGraph, LoweringTool tool) Applies lowering to a replacement graph.
Invoke	replaceWithInvoke() Replaces this node with an invoke of the target method.
default void	setBci(int bci) Remember the byte code index (BCI) for code generation or lowering purposes.

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

asFixedNodeOrNull, getContextMethod, getTargetMethod, updateInliningLogAfterClone, updateInliningLogAfterRegister

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

bci

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

hasSideEffect, setStateAfter, stateAfter

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

getKilledLocationIdentity

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

asMultiMemoryKill, asSingleMemoryKill, isMemoryKill, isMultiMemoryKill, isSingleMemoryKill

Method Detail

getInvokeKind

CallTargetNode.InvokeKind getInvokeKind()

getArguments

NodeInputList<ValueNode> getArguments()

Gets the arguments for this macro node.

getArgument

default ValueNode getArgument(int index)

See Also:

MacroInvokable.getArguments()

getArgumentCount

default int getArgumentCount()

See Also:

MacroInvokable.getArguments()

assertArgumentCount

static boolean assertArgumentCount(MacroInvokable macro)

setBci

default void setBci(int bci)

Description copied from interface: DeoptBciSupplier

Remember the byte code index (BCI) for code generation or lowering purposes. For example, nodes lowering to foreign calls that can safepoint require a valid BCI for computations of the during-state of such a foreign call.

Specified by:

setBci in interface DeoptBciSupplier

replaceWithInvoke

Invoke replaceWithInvoke()

Replaces this node with an invoke of the target method.

Returns:

the newly create Invoke

lowerReplacement

static StructuredGraph lowerReplacement(StructuredGraph graph,
                                        StructuredGraph replacementGraph,
                                        LoweringTool tool)

Applies lowering to a replacement graph.

Parameters:

replacementGraph - a replacement (i.e., snippet or method substitution) graph

lower

default 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