org.graalvm.compiler.replacements

Class IntrinsicGraphBuilder

java.lang.Object

org.graalvm.compiler.nodes.spi.CoreProvidersDelegate

org.graalvm.compiler.replacements.IntrinsicGraphBuilder

All Implemented Interfaces:

GraphBuilderContext, GraphBuilderTool, InvocationPlugin.Receiver, CoreProviders

public class IntrinsicGraphBuilder
extends CoreProvidersDelegate
implements GraphBuilderContext, InvocationPlugin.Receiver

Implementation of GraphBuilderContext used to produce a graph for a method based on an InvocationPlugin for the method.

Nested Class Summary

Nested classes/interfaces inherited from interface org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext

GraphBuilderContext.ExternalInliningContext

Field Summary

Fields

Modifier and Type	Field and Description
protected ValueNode[]	arguments
protected Bytecode	code
protected StructuredGraph	graph
protected int	invokeBci
protected FixedWithNextNode	lastInstr
protected ResolvedJavaMethod	method
protected ValueNode	returnValue

Constructor Summary

Constructors

Modifier	Constructor and Description
	IntrinsicGraphBuilder(OptionValues options, DebugContext debug, CoreProviders providers, Bytecode code, int invokeBci)
	IntrinsicGraphBuilder(OptionValues options, DebugContext debug, CoreProviders providers, Bytecode code, int invokeBci, StructuredGraph.AllowAssumptions allowAssumptions)
protected	IntrinsicGraphBuilder(OptionValues options, DebugContext debug, CoreProviders providers, Bytecode code, int invokeBci, StructuredGraph.AllowAssumptions allowAssumptions, GraphBuilderConfiguration graphBuilderConfig)

Method Summary

Modifier and Type	Method and Description
<T extends ValueNode> T	append(T v) Adds the given node to the graph and also adds recursively all referenced inputs.
BailoutException	bailout(String string)
int	bci() Gets the index of the bytecode instruction currently being parsed.
StructuredGraph	buildGraph(InvocationPlugin plugin)
boolean	canMergeIntrinsicReturns() Some InvocationPlugins have to build a MergeNode to handle multiple return paths but not all contexts can do this.
AbstractBeginNode	genExplicitExceptionEdge(BytecodeExceptionNode.BytecodeExceptionKind exceptionKind, ValueNode... exceptionArguments) Generates an exception edge for the current bytecode.
ValueNode	get(boolean performNullCheck) Gets the receiver value, optionally null checking it first if necessary.
Bytecode	getCode() Gets the code being parsed.
int	getDepth() Gets the inline depth of this context.
StructuredGraph	getGraph() Gets the graph being constructed.
IntrinsicContext	getIntrinsic() Gets the intrinsic of the current parsing context or null if not parsing an intrinsic.
FrameState	getInvocationPluginBeforeState() Build a FrameState that represents the represents the state before an intrinsic was invoked.
FrameState	getInvocationPluginReturnState(JavaKind returnKind, ValueNode retVal) Build a FrameState that represents the return from an intrinsic with returnValue on the top of stack.
CallTargetNode.InvokeKind	getInvokeKind() Gets the kind of invocation currently being parsed.
JavaType	getInvokeReturnType() Gets the return type of the invocation currently being parsed.
ResolvedJavaMethod	getMethod() Gets the method being parsed by this context.
GraphBuilderContext	getParent() Gets the parsing context for the method that inlines the method being parsed by this context.
Invoke	handleReplacedInvoke(CallTargetNode.InvokeKind invokeKind, ResolvedJavaMethod targetMethod, ValueNode[] args, boolean forceInlineEverything) Handles an invocation that a plugin determines can replace the original invocation (i.e., the one for which the plugin was applied).
void	handleReplacedInvoke(CallTargetNode callTarget, JavaKind resultType)
Invoke	invokeFallback(FixedWithNextNode predecessor, EndNode end)
boolean	isParsingInvocationPlugin()
protected void	mergeUnwinds() If the graph contains multiple unwind nodes, then this method merges them into a single unwind node containing a merged ExceptionNode.
boolean	parsingIntrinsic() Determines if this parsing context is within the bytecode of an intrinsic or a method inlined by an intrinsic.
ValueNode	pop(JavaKind slotKind) Pops a value from the frame state stack using an explicit kind.
void	push(JavaKind kind, ValueNode value) Pushes a given value to the frame state stack using an explicit kind.
protected void	setExceptionState(StateSplit exceptionObject) Currently unimplemented here, but implemented in subclasses that need it.
void	setStateAfter(StateSplit sideEffect) Creates a snap shot of the current frame state with the BCI of the instruction after the one currently being parsed and assigns it to a given side effect node.
String	toString()

Methods inherited from class org.graalvm.compiler.nodes.spi.CoreProvidersDelegate

getConstantFieldProvider, getConstantReflection, getForeignCalls, getLoopsDataProvider, getLowerer, getMetaAccess, getMetaAccessExtensionProvider, getPlatformConfigurationProvider, getProviders, getReplacements, getStampProvider, getWordVerification

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext

add, addNonNullCast, addPush, allowDeoptInPlugins, bciCanBeDuplicated, emitBytecodeExceptionCheck, genCheckcastDynamic, getExternalInliningContext, getInvokeReturnStamp, getNonIntrinsicAncestor, intrinsicRangeCheck, isPluginEnabled, maskSubWordValue, maybeEmitExplicitDivisionByZeroCheck, maybeEmitExplicitNegativeArraySizeCheck, maybeEmitExplicitNegativeArraySizeCheck, needsExplicitException, nullCheckedValue, nullCheckedValue, popArguments, recursiveInliningDepth, replacePlugin, replacePluginWithException

Methods inherited from interface org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderTool

canDeferPlugin, getAssumptions, getDebug, getOptions, shouldDeferPlugin

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

getConstantFieldProvider, getConstantReflection, getForeignCalls, getLoopsDataProvider, getLowerer, getMetaAccess, getMetaAccessExtensionProvider, getPlatformConfigurationProvider, getReplacements, getStampProvider, getWordVerification

Methods inherited from interface org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver

get, isConstant

Field Detail

graph

protected final StructuredGraph graph

code

protected final Bytecode code

method

protected final ResolvedJavaMethod method

invokeBci

protected final int invokeBci

lastInstr

protected FixedWithNextNode lastInstr

arguments

protected ValueNode[] arguments

returnValue

protected ValueNode returnValue

Constructor Detail

IntrinsicGraphBuilder

public IntrinsicGraphBuilder(OptionValues options,
                             DebugContext debug,
                             CoreProviders providers,
                             Bytecode code,
                             int invokeBci)

IntrinsicGraphBuilder

public IntrinsicGraphBuilder(OptionValues options,
                             DebugContext debug,
                             CoreProviders providers,
                             Bytecode code,
                             int invokeBci,
                             StructuredGraph.AllowAssumptions allowAssumptions)

IntrinsicGraphBuilder

protected IntrinsicGraphBuilder(OptionValues options,
                                DebugContext debug,
                                CoreProviders providers,
                                Bytecode code,
                                int invokeBci,
                                StructuredGraph.AllowAssumptions allowAssumptions,
                                GraphBuilderConfiguration graphBuilderConfig)

Method Detail

genExplicitExceptionEdge

public AbstractBeginNode genExplicitExceptionEdge(BytecodeExceptionNode.BytecodeExceptionKind exceptionKind,
                                                  ValueNode... exceptionArguments)

Description copied from interface: GraphBuilderContext

Generates an exception edge for the current bytecode. When GraphBuilderContext.needsExplicitException() returns true, this method should return non-null begin nodes.

Specified by:

genExplicitExceptionEdge in interface GraphBuilderContext

Parameters:

exceptionKind - the type of exception to be created.

exceptionArguments - the arguments for the exception.

Returns:

a begin node that precedes the actual exception instantiation code.

setExceptionState

protected void setExceptionState(StateSplit exceptionObject)

Currently unimplemented here, but implemented in subclasses that need it.

Parameters:

exceptionObject - The node that needs an exception state.

mergeUnwinds

protected void mergeUnwinds()

If the graph contains multiple unwind nodes, then this method merges them into a single unwind node containing a merged ExceptionNode. This is needed because an IntrinsicGraph can only contain at most a single UnwindNode. Currently unimplemented here, but implemented in subclasses that need it.

append

public <T extends ValueNode> T append(T v)

Description copied from interface: GraphBuilderTool

Adds the given node to the graph and also adds recursively all referenced inputs.

Specified by:

append in interface GraphBuilderTool

Parameters:

v - the node to be added to the graph

Returns:

either the node added or an equivalent node

push

public void push(JavaKind kind,
                 ValueNode value)

Description copied from interface: GraphBuilderContext

Pushes a given value to the frame state stack using an explicit kind. This should be used when value.getJavaKind() is different from the kind that the bytecode instruction currently being parsed pushes to the stack.

Specified by:

push in interface GraphBuilderContext

Parameters:

kind - the kind to use when type checking this operation

value - the value to push to the stack. The value must already have been appended.

pop

public ValueNode pop(JavaKind slotKind)

Description copied from interface: GraphBuilderContext

Pops a value from the frame state stack using an explicit kind.

Specified by:

pop in interface GraphBuilderContext

Parameters:

slotKind - the kind to use when type checking this operation

Returns:

the value on the top of the stack

handleReplacedInvoke

public Invoke handleReplacedInvoke(CallTargetNode.InvokeKind invokeKind,
                                   ResolvedJavaMethod targetMethod,
                                   ValueNode[] args,
                                   boolean forceInlineEverything)

Description copied from interface: GraphBuilderContext

Handles an invocation that a plugin determines can replace the original invocation (i.e., the one for which the plugin was applied). This applies all standard graph builder processing to the replaced invocation including applying any relevant plugins.

Specified by:

handleReplacedInvoke in interface GraphBuilderContext

Parameters:

invokeKind - the kind of the replacement invocation

targetMethod - the target of the replacement invocation

args - the arguments to the replacement invocation

forceInlineEverything - specifies if all invocations encountered in the scope of handling the replaced invoke are to be force inlined

handleReplacedInvoke

public void handleReplacedInvoke(CallTargetNode callTarget,
                                 JavaKind resultType)

Specified by:

handleReplacedInvoke in interface GraphBuilderContext

getGraph

public StructuredGraph getGraph()

Description copied from interface: GraphBuilderTool

Gets the graph being constructed.

Specified by:

getGraph in interface GraphBuilderTool

setStateAfter

public void setStateAfter(StateSplit sideEffect)

Description copied from interface: GraphBuilderContext

Creates a snap shot of the current frame state with the BCI of the instruction after the one currently being parsed and assigns it to a given side effect node.

Specified by:

setStateAfter in interface GraphBuilderContext

Parameters:

sideEffect - a side effect node just appended to the graph

getParent

public GraphBuilderContext getParent()

Description copied from interface: GraphBuilderContext

Gets the parsing context for the method that inlines the method being parsed by this context.

Specified by:

getParent in interface GraphBuilderContext

getCode

public Bytecode getCode()

Description copied from interface: GraphBuilderContext

Gets the code being parsed.

Specified by:

getCode in interface GraphBuilderContext

getMethod

public ResolvedJavaMethod getMethod()

Description copied from interface: GraphBuilderContext

Gets the method being parsed by this context.

Specified by:

getMethod in interface GraphBuilderContext

bci

public int bci()

Description copied from interface: GraphBuilderContext

Gets the index of the bytecode instruction currently being parsed.

Specified by:

bci in interface GraphBuilderContext

getInvokeKind

public CallTargetNode.InvokeKind getInvokeKind()

Description copied from interface: GraphBuilderContext

Gets the kind of invocation currently being parsed.

Specified by:

getInvokeKind in interface GraphBuilderContext

getInvokeReturnType

public JavaType getInvokeReturnType()

Description copied from interface: GraphBuilderContext

Gets the return type of the invocation currently being parsed.

Specified by:

getInvokeReturnType in interface GraphBuilderContext

getDepth

public int getDepth()

Description copied from interface: GraphBuilderContext

Gets the inline depth of this context. A return value of 0 implies that this is the context for the parse root.

Specified by:

getDepth in interface GraphBuilderContext

parsingIntrinsic

public boolean parsingIntrinsic()

Description copied from interface: GraphBuilderContext

Determines if this parsing context is within the bytecode of an intrinsic or a method inlined by an intrinsic.

Specified by:

parsingIntrinsic in interface GraphBuilderContext

Specified by:

parsingIntrinsic in interface GraphBuilderTool

getIntrinsic

public IntrinsicContext getIntrinsic()

Description copied from interface: GraphBuilderContext

Gets the intrinsic of the current parsing context or null if not parsing an intrinsic.

Specified by:

getIntrinsic in interface GraphBuilderContext

bailout

public BailoutException bailout(String string)

Specified by:

bailout in interface GraphBuilderContext

get

public ValueNode get(boolean performNullCheck)

Description copied from interface: InvocationPlugin.Receiver

Gets the receiver value, optionally null checking it first if necessary.

Specified by:

get in interface InvocationPlugin.Receiver

buildGraph

public final StructuredGraph buildGraph(InvocationPlugin plugin)

getInvocationPluginReturnState

public FrameState getInvocationPluginReturnState(JavaKind returnKind,
                                                 ValueNode retVal)

Description copied from interface: GraphBuilderContext

Build a FrameState that represents the return from an intrinsic with returnValue on the top of stack. Usually this will be a state in the caller after the call site.

Specified by:

getInvocationPluginReturnState in interface GraphBuilderContext

getInvocationPluginBeforeState

public FrameState getInvocationPluginBeforeState()

Description copied from interface: GraphBuilderContext

Build a FrameState that represents the represents the state before an intrinsic was invoked.

Specified by:

getInvocationPluginBeforeState in interface GraphBuilderContext

canMergeIntrinsicReturns

public boolean canMergeIntrinsicReturns()

Description copied from interface: GraphBuilderContext

Some InvocationPlugins have to build a MergeNode to handle multiple return paths but not all contexts can do this.

Specified by:

canMergeIntrinsicReturns in interface GraphBuilderContext

Returns:

false if GraphBuilderContext.getInvocationPluginReturnState(JavaKind, ValueNode) cannot be called (i.e. it unconditionally raises an error)

isParsingInvocationPlugin

public boolean isParsingInvocationPlugin()

Specified by:

isParsingInvocationPlugin in interface GraphBuilderContext

invokeFallback

public Invoke invokeFallback(FixedWithNextNode predecessor,
                             EndNode end)

Specified by:

invokeFallback in interface GraphBuilderContext

toString

public String toString()

Overrides:

toString in class Object