org.graalvm.compiler.nodes.graphbuilderconf

Interface GraphBuilderContext

All Superinterfaces:

CoreProviders, GraphBuilderTool

All Known Implementing Classes:

BytecodeParser, IntrinsicGraphBuilder, PEGraphDecoder.PEAppendGraphBuilderContext, PEGraphDecoder.PENonAppendGraphBuilderContext, PEGraphDecoder.PEPluginGraphBuilderContext

public interface GraphBuilderContext
extends GraphBuilderTool

Used by a GraphBuilderPlugin to interface with an object that parses the bytecode of a single method as part of building a graph .

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	GraphBuilderContext.ExternalInliningContext Interface whose instances hold inlining information about the current context, in a wider sense.

Method Summary

Modifier and Type	Method and Description
default <T extends ValueNode> T	add(T value) Adds a node and all its inputs to the graph.
default ValueNode	addNonNullCast(ValueNode value)
default <T extends ValueNode> T	addPush(JavaKind kind, T value) Adds a node with a non-void kind to the graph, pushes it to the stack.
default boolean	allowDeoptInPlugins() When this returns false, the parser will report an error if an InvocationPlugin inserts a DeoptimizeNode or FixedGuardNode.
BailoutException	bailout(String string)
int	bci() Gets the index of the bytecode instruction currently being parsed.
default boolean	bciCanBeDuplicated()
default boolean	canMergeIntrinsicReturns() Some InvocationPlugins have to build a MergeNode to handle multiple return paths but not all contexts can do this.
default AbstractBeginNode	emitBytecodeExceptionCheck(LogicNode condition, boolean passingOnTrue, BytecodeExceptionNode.BytecodeExceptionKind exceptionKind, ValueNode... arguments)
default void	genCheckcastDynamic(ValueNode object, ValueNode javaClass)
default AbstractBeginNode	genExplicitExceptionEdge(BytecodeExceptionNode.BytecodeExceptionKind exceptionKind, ValueNode... exceptionArguments) Generates an exception edge for the current bytecode.
Bytecode	getCode() Gets the code being parsed.
default int	getDepth() Gets the inline depth of this context.
default GraphBuilderContext.ExternalInliningContext	getExternalInliningContext()
IntrinsicContext	getIntrinsic() Gets the intrinsic of the current parsing context or null if not parsing an intrinsic.
default FrameState	getInvocationPluginBeforeState() Build a FrameState that represents the represents the state before an intrinsic was invoked.
default FrameState	getInvocationPluginReturnState(JavaKind returnKind, ValueNode returnValue) 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.
default StampPair	getInvokeReturnStamp(Assumptions assumptions)
JavaType	getInvokeReturnType() Gets the return type of the invocation currently being parsed.
ResolvedJavaMethod	getMethod() Gets the method being parsed by this context.
default GraphBuilderContext	getNonIntrinsicAncestor() Gets the first ancestor parsing context that is not parsing a intrinsic.
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)
default GuardingNode	intrinsicRangeCheck(LogicNode condition, boolean negated) Emit a range check for an intrinsic.
default Invoke	invokeFallback(FixedWithNextNode predecessor, EndNode end)
boolean	isParsingInvocationPlugin()
default boolean	isPluginEnabled(GraphBuilderPlugin plugin) Determines if a graph builder plugin is enabled under current context.
default ValueNode	maskSubWordValue(ValueNode value, JavaKind kind) Adds masking to a given subword value according to a given , such that the masked value falls in the range of the given kind.
default GuardingNode	maybeEmitExplicitDivisionByZeroCheck(ValueNode divisor)
default ValueNode	maybeEmitExplicitNegativeArraySizeCheck(ValueNode arrayLength)
default ValueNode	maybeEmitExplicitNegativeArraySizeCheck(ValueNode arrayLength, BytecodeExceptionNode.BytecodeExceptionKind exceptionKind) When GraphBuilderContext.needsExplicitException() is true, the method returns a node with a stamp that is always positive and emits code that throws the provided exceptionKind for a negative length.
default boolean	needsExplicitException()
default ValueNode	nullCheckedValue(ValueNode value)
default ValueNode	nullCheckedValue(ValueNode value, DeoptimizationAction action) Gets a version of a given value that has a non-null stamp.
default boolean	parsingIntrinsic() Determines if this parsing context is within the bytecode of an intrinsic or a method inlined by an intrinsic.
default ValueNode	pop(JavaKind slotKind) Pops a value from the frame state stack using an explicit kind.
default ValueNode[]	popArguments(int argSize)
void	push(JavaKind kind, ValueNode value) Pushes a given value to the frame state stack using an explicit kind.
default int	recursiveInliningDepth(ResolvedJavaMethod method) Computes the recursive inlining depth of the provided method, i.e., counts how often the provided method is already in the GraphBuilderContext.getParent() chain starting at this context.
default void	replacePlugin(GeneratedInvocationPlugin plugin, ResolvedJavaMethod targetMethod, ValueNode[] args, PluginReplacementNode.ReplacementFunction replacementFunction) Replaces an invocation of a given method by inserting a PluginReplacementNode that defers the application of an InvocationPlugin.
default void	replacePluginWithException(GeneratedInvocationPlugin plugin, ResolvedJavaMethod targetMethod, ValueNode[] args, PluginReplacementWithExceptionNode.ReplacementWithExceptionFunction replacementFunction) Replaces an invocation of a given method by inserting a PluginReplacementWithExceptionNode that defers the application of an InvocationPlugin.
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.

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

append, canDeferPlugin, getAssumptions, getDebug, getGraph, getOptions, shouldDeferPlugin

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

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

Method Detail

push

void push(JavaKind kind,
          ValueNode value)

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.

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

default ValueNode pop(JavaKind slotKind)

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

Parameters:

slotKind - the kind to use when type checking this operation

Returns:

the value on the top of the stack

popArguments

default ValueNode[] popArguments(int argSize)

add

default <T extends ValueNode> T add(T value)

Adds a node and all its inputs to the graph. If the node is in the graph, returns immediately. If the node is a StateSplit with a null frame state , the frame state is initialized.

Parameters:

value - the value to add to the graph. The value.getJavaKind() kind is used when type checking this operation.

Returns:

a node equivalent to value in the graph

addNonNullCast

default ValueNode addNonNullCast(ValueNode value)

addPush

default <T extends ValueNode> T addPush(JavaKind kind,
                                        T value)

Adds a node with a non-void kind to the graph, pushes it to the stack. If the returned node is a StateSplit with a null frame state, the frame state is initialized.

Parameters:

kind - the kind to use when type checking this operation

value - the value to add to the graph and push to the stack

Returns:

a node equivalent to value in the graph

handleReplacedInvoke

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). This applies all standard graph builder processing to the replaced invocation including applying any relevant plugins.

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

void handleReplacedInvoke(CallTargetNode callTarget,
                          JavaKind resultType)

setStateAfter

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.

Parameters:

sideEffect - a side effect node just appended to the graph

getParent

GraphBuilderContext getParent()

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

getNonIntrinsicAncestor

default GraphBuilderContext getNonIntrinsicAncestor()

Gets the first ancestor parsing context that is not parsing a intrinsic.

getCode

Bytecode getCode()

Gets the code being parsed.

getMethod

ResolvedJavaMethod getMethod()

Gets the method being parsed by this context.

bci

int bci()

Gets the index of the bytecode instruction currently being parsed.

bciCanBeDuplicated

default boolean bciCanBeDuplicated()

getInvokeKind

CallTargetNode.InvokeKind getInvokeKind()

Gets the kind of invocation currently being parsed.

getInvokeReturnType

JavaType getInvokeReturnType()

Gets the return type of the invocation currently being parsed.

getInvokeReturnStamp

default StampPair getInvokeReturnStamp(Assumptions assumptions)

getDepth

default int getDepth()

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

recursiveInliningDepth

default int recursiveInliningDepth(ResolvedJavaMethod method)

Computes the recursive inlining depth of the provided method, i.e., counts how often the provided method is already in the GraphBuilderContext.getParent() chain starting at this context.

parsingIntrinsic

default boolean parsingIntrinsic()

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

Specified by:

parsingIntrinsic in interface GraphBuilderTool

isPluginEnabled

default boolean isPluginEnabled(GraphBuilderPlugin plugin)

Determines if a graph builder plugin is enabled under current context.

getIntrinsic

IntrinsicContext getIntrinsic()

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

isParsingInvocationPlugin

boolean isParsingInvocationPlugin()

bailout

BailoutException bailout(String string)

nullCheckedValue

default ValueNode nullCheckedValue(ValueNode value)

intrinsicRangeCheck

default GuardingNode intrinsicRangeCheck(LogicNode condition,
                                         boolean negated)

Emit a range check for an intrinsic. This is different from a normal bytecode range check since it might be checking a range of indexes for an operation on an array body.

nullCheckedValue

default ValueNode nullCheckedValue(ValueNode value,
                                   DeoptimizationAction action)

Gets a version of a given value that has a non-null stamp.

maybeEmitExplicitNegativeArraySizeCheck

default ValueNode maybeEmitExplicitNegativeArraySizeCheck(ValueNode arrayLength,
                                                          BytecodeExceptionNode.BytecodeExceptionKind exceptionKind)

When GraphBuilderContext.needsExplicitException() is true, the method returns a node with a stamp that is always positive and emits code that throws the provided exceptionKind for a negative length.

maybeEmitExplicitNegativeArraySizeCheck

default ValueNode maybeEmitExplicitNegativeArraySizeCheck(ValueNode arrayLength)

maybeEmitExplicitDivisionByZeroCheck

default GuardingNode maybeEmitExplicitDivisionByZeroCheck(ValueNode divisor)

emitBytecodeExceptionCheck

default AbstractBeginNode emitBytecodeExceptionCheck(LogicNode condition,
                                                     boolean passingOnTrue,
                                                     BytecodeExceptionNode.BytecodeExceptionKind exceptionKind,
                                                     ValueNode... arguments)

genCheckcastDynamic

default void genCheckcastDynamic(ValueNode object,
                                 ValueNode javaClass)

canMergeIntrinsicReturns

default boolean canMergeIntrinsicReturns()

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

Returns:

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

getInvocationPluginReturnState

default FrameState getInvocationPluginReturnState(JavaKind returnKind,
                                                  ValueNode returnValue)

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.

getInvocationPluginBeforeState

default FrameState getInvocationPluginBeforeState()

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

allowDeoptInPlugins

default boolean allowDeoptInPlugins()

When this returns false, the parser will report an error if an InvocationPlugin inserts a DeoptimizeNode or FixedGuardNode.

invokeFallback

default Invoke invokeFallback(FixedWithNextNode predecessor,
                              EndNode end)

getExternalInliningContext

default GraphBuilderContext.ExternalInliningContext getExternalInliningContext()

maskSubWordValue

default ValueNode maskSubWordValue(ValueNode value,
                                   JavaKind kind)

Adds masking to a given subword value according to a given , such that the masked value falls in the range of the given kind. In the cases where the given kind is not a subword kind, the input value is returned immediately.

Parameters:

value - the value to be masked

kind - the kind that specifies the range of the masked value

Returns:

the masked value

needsExplicitException

default boolean needsExplicitException()

Returns:

true if an explicit exception check should be emitted.

genExplicitExceptionEdge

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

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

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.

replacePlugin

default void replacePlugin(GeneratedInvocationPlugin plugin,
                           ResolvedJavaMethod targetMethod,
                           ValueNode[] args,
                           PluginReplacementNode.ReplacementFunction replacementFunction)

Replaces an invocation of a given method by inserting a PluginReplacementNode that defers the application of an InvocationPlugin.

Parameters:

plugin - the InvocationPlugin that is deferred

targetMethod - the target of the replacement invocation

args - the arguments to the replacement invocation

replacementFunction - the replacement function for deferred application of the plugin

replacePluginWithException

default void replacePluginWithException(GeneratedInvocationPlugin plugin,
                                        ResolvedJavaMethod targetMethod,
                                        ValueNode[] args,
                                        PluginReplacementWithExceptionNode.ReplacementWithExceptionFunction replacementFunction)

Replaces an invocation of a given method by inserting a PluginReplacementWithExceptionNode that defers the application of an InvocationPlugin.

Parameters:

plugin - the InvocationPlugin that is deferred

targetMethod - the target of the replacement invocation

args - the arguments to the replacement invocation

replacementFunction - the replacement function for deferred application of the plugin