org.graalvm.compiler.replacements

Class GraphKit

java.lang.Object

org.graalvm.compiler.nodes.spi.CoreProvidersDelegate

org.graalvm.compiler.replacements.GraphKit

All Implemented Interfaces:

GraphBuilderTool, CoreProviders

public class GraphKit
extends CoreProvidersDelegate
implements GraphBuilderTool

A utility for manually creating a graph. This will be expanded as necessary to support all subsystems that employ manual graph creation (as opposed to bytecode parsing based graph creation).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GraphKit.IfState
protected static class	GraphKit.Structure

Field Summary

Fields

Modifier and Type	Field and Description
protected StructuredGraph	graph
protected GraphBuilderConfiguration.Plugins	graphBuilderPlugins
protected FixedWithNextNode	lastFixedNode
protected WordTypes	wordTypes

Constructor Summary

Constructors

Constructor and Description
GraphKit(DebugContext debug, ResolvedJavaMethod stubMethod, Providers providers, WordTypes wordTypes, GraphBuilderConfiguration.Plugins graphBuilderPlugins, CompilationIdentifier compilationId, String name, boolean trackNodeSourcePosition, boolean recordInlinedMethods)

Method Summary

Modifier and Type	Method and Description
<T extends ValueNode> T	add(T node)
<T extends ValueNode> T	append(T node) Adds the given node to the graph and also adds recursively all referenced inputs.
JavaKind	asKind(JavaType type)
<T extends ValueNode> T	changeToWord(T node)
boolean	checkArgs(ResolvedJavaMethod method, ValueNode... args) Determines if a given set of arguments is compatible with the signature of a given method.
protected ExceptionObjectNode	createExceptionObjectNode(FrameStateBuilder frameStateBuilder, int exceptionEdgeBci)
protected GraphBuilderPhase.Instance	createGraphBuilderInstance(GraphBuilderConfiguration graphBuilderConfig, OptimisticOptimizations optimisticOpts, IntrinsicContext initialIntrinsicContext)
InvokeNode	createIntrinsicInvoke(ResolvedJavaMethod method, ValueNode... args)
InvokeNode	createInvoke(Class<?> declaringClass, String name, CallTargetNode.InvokeKind invokeKind, FrameStateBuilder frameStateBuilder, int bci, ValueNode... args) Creates and appends an InvokeNode for a call to a given method with a given set of arguments.
InvokeNode	createInvoke(Class<?> declaringClass, String name, ValueNode... args)
InvokeNode	createInvoke(ResolvedJavaMethod method, CallTargetNode.InvokeKind invokeKind, FrameStateBuilder frameStateBuilder, int bci, ValueNode... args) Creates and appends an InvokeNode for a call to a given method with a given set of arguments.
InvokeWithExceptionNode	createInvokeWithExceptionAndUnwind(MethodCallTargetNode callTarget, FrameStateBuilder frameStateBuilder, int invokeBci)
InvokeWithExceptionNode	createInvokeWithExceptionAndUnwind(ResolvedJavaMethod method, CallTargetNode.InvokeKind invokeKind, FrameStateBuilder frameStateBuilder, int invokeBci, ValueNode... args)
protected MethodCallTargetNode	createMethodCallTarget(CallTargetNode.InvokeKind invokeKind, ResolvedJavaMethod targetMethod, ValueNode[] args, StampPair returnStamp, int bci)
void	elsePart()
AbstractMergeNode	endIf() Ends an if block started with #startIf(LogicNode, BranchProbabilityData).
AbstractMergeNode	endInvokeWithException() Finishes a control flow started with GraphKit.startInvokeWithException(ResolvedJavaMethod, org.graalvm.compiler.nodes.CallTargetNode.InvokeKind, org.graalvm.compiler.java.FrameStateBuilder, int, org.graalvm.compiler.nodes.ValueNode...).
ExceptionObjectNode	exceptionObject()
void	exceptionPart()
ResolvedJavaMethod	findMethod(Class<?> declaringClass, String name, boolean isStatic)
ResolvedJavaMethod	findMethod(Class<?> declaringClass, String name, Class<?>... parameterTypes)
StructuredGraph	getGraph() Gets the graph being constructed.
protected <T extends GraphKit.Structure> T	getTopStructure(Class<T> expectedClass)
void	inline(Invoke invoke, String reason, String phase)
void	inlineAsIntrinsic(Invoke invoke, String reason, String phase) Inlines a given invocation to a method.
void	inlineInvokesAsIntrinsics(String reason, String phase) Recursively inlines all invocations currently in the graph.
void	noExceptionPart()
boolean	parsingIntrinsic() Determines if this parsing context is within the bytecode of an intrinsic or a method inlined by an intrinsic.
protected void	popStructure()
protected void	pushStructure(GraphKit.Structure structure)
protected void	setStateAfterException(FrameStateBuilder frameStateBuilder, int exceptionEdgeBci, StateSplit exceptionObject, boolean rethrow)
IfNode	startIf(LogicNode condition, ProfileData.BranchProbabilityData profileData) Starts an if-block.
InvokeWithExceptionNode	startInvokeWithException(CallTargetNode callTarget, FrameStateBuilder frameStateBuilder, int invokeBci)
InvokeWithExceptionNode	startInvokeWithException(ResolvedJavaMethod method, CallTargetNode.InvokeKind invokeKind, FrameStateBuilder frameStateBuilder, int invokeBci, ValueNode... args)
void	thenPart()
<T extends FloatingNode & Node.ValueNumberable> T	unique(T node) Ensures a floating node is added to or already present in the graph via Graph.unique(T).
Stamp	wordStamp(ResolvedJavaType type)

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, toString, wait, wait, wait

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

Field Detail

graph

protected final StructuredGraph graph

wordTypes

protected final WordTypes wordTypes

graphBuilderPlugins

protected final GraphBuilderConfiguration.Plugins graphBuilderPlugins

lastFixedNode

protected FixedWithNextNode lastFixedNode

Constructor Detail

GraphKit

public GraphKit(DebugContext debug,
                ResolvedJavaMethod stubMethod,
                Providers providers,
                WordTypes wordTypes,
                GraphBuilderConfiguration.Plugins graphBuilderPlugins,
                CompilationIdentifier compilationId,
                String name,
                boolean trackNodeSourcePosition,
                boolean recordInlinedMethods)

Method Detail

getGraph

public StructuredGraph getGraph()

Description copied from interface: GraphBuilderTool

Gets the graph being constructed.

Specified by:

getGraph in interface GraphBuilderTool

parsingIntrinsic

public boolean parsingIntrinsic()

Description copied from interface: GraphBuilderTool

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

unique

public <T extends FloatingNode & Node.ValueNumberable> T unique(T node)

Ensures a floating node is added to or already present in the graph via Graph.unique(T).

Returns:

a node similar to node if one exists, otherwise node

add

public <T extends ValueNode> T add(T node)

changeToWord

public <T extends ValueNode> T changeToWord(T node)

wordStamp

public Stamp wordStamp(ResolvedJavaType type)

asKind

public final JavaKind asKind(JavaType type)

append

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

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:

node - the node to be added to the graph

Returns:

either the node added or an equivalent node

createInvoke

public InvokeNode createInvoke(Class<?> declaringClass,
                               String name,
                               ValueNode... args)

createInvoke

public InvokeNode createInvoke(Class<?> declaringClass,
                               String name,
                               CallTargetNode.InvokeKind invokeKind,
                               FrameStateBuilder frameStateBuilder,
                               int bci,
                               ValueNode... args)

Creates and appends an InvokeNode for a call to a given method with a given set of arguments. The method is looked up via reflection based on the declaring class and name.

Parameters:

declaringClass - the class declaring the invoked method

name - the name of the invoked method

args - the arguments to the invocation

findMethod

public ResolvedJavaMethod findMethod(Class<?> declaringClass,
                                     String name,
                                     boolean isStatic)

findMethod

public ResolvedJavaMethod findMethod(Class<?> declaringClass,
                                     String name,
                                     Class<?>... parameterTypes)

createInvoke

public InvokeNode createInvoke(ResolvedJavaMethod method,
                               CallTargetNode.InvokeKind invokeKind,
                               FrameStateBuilder frameStateBuilder,
                               int bci,
                               ValueNode... args)

Creates and appends an InvokeNode for a call to a given method with a given set of arguments.

createIntrinsicInvoke

public InvokeNode createIntrinsicInvoke(ResolvedJavaMethod method,
                                        ValueNode... args)

createInvokeWithExceptionAndUnwind

public InvokeWithExceptionNode createInvokeWithExceptionAndUnwind(ResolvedJavaMethod method,
                                                                  CallTargetNode.InvokeKind invokeKind,
                                                                  FrameStateBuilder frameStateBuilder,
                                                                  int invokeBci,
                                                                  ValueNode... args)

createInvokeWithExceptionAndUnwind

public InvokeWithExceptionNode createInvokeWithExceptionAndUnwind(MethodCallTargetNode callTarget,
                                                                  FrameStateBuilder frameStateBuilder,
                                                                  int invokeBci)

createMethodCallTarget

protected MethodCallTargetNode createMethodCallTarget(CallTargetNode.InvokeKind invokeKind,
                                                      ResolvedJavaMethod targetMethod,
                                                      ValueNode[] args,
                                                      StampPair returnStamp,
                                                      int bci)

checkArgs

public boolean checkArgs(ResolvedJavaMethod method,
                         ValueNode... args)

Determines if a given set of arguments is compatible with the signature of a given method.

Returns:

true if args are compatible with the signature if method

Throws:

AssertionError - if args are not compatible with the signature if method

inlineInvokesAsIntrinsics

public void inlineInvokesAsIntrinsics(String reason,
                                      String phase)

Recursively inlines all invocations currently in the graph. The graph of the inlined method is processed in the same manner as for snippets and method substitutions (e.g. intrinsics).

inlineAsIntrinsic

public void inlineAsIntrinsic(Invoke invoke,
                              String reason,
                              String phase)

Inlines a given invocation to a method. The graph of the inlined method is processed in the same manner as for snippets and method substitutions (e.g. intrinsics).

inline

public void inline(Invoke invoke,
                   String reason,
                   String phase)

createGraphBuilderInstance

protected GraphBuilderPhase.Instance createGraphBuilderInstance(GraphBuilderConfiguration graphBuilderConfig,
                                                                OptimisticOptimizations optimisticOpts,
                                                                IntrinsicContext initialIntrinsicContext)

pushStructure

protected void pushStructure(GraphKit.Structure structure)

getTopStructure

protected <T extends GraphKit.Structure> T getTopStructure(Class<T> expectedClass)

popStructure

protected void popStructure()

startIf

public IfNode startIf(LogicNode condition,
                      ProfileData.BranchProbabilityData profileData)

Starts an if-block. This call can be followed by a call to GraphKit.thenPart() to start emitting the code executed when the condition hold; and a call to GraphKit.elsePart() to start emititng the code when the condition does not hold. It must be followed by a call to GraphKit.endIf() to close the if-block.

Parameters:

condition - The condition for the if-block

profileData - The estimated probability the condition is true

Returns:

the created IfNode.

thenPart

public void thenPart()

elsePart

public void elsePart()

endIf

public AbstractMergeNode endIf()

Ends an if block started with #startIf(LogicNode, BranchProbabilityData).

Returns:

the created merge node, or null if no merge node was required (for example, when one part ended with a control sink).

startInvokeWithException

public InvokeWithExceptionNode startInvokeWithException(ResolvedJavaMethod method,
                                                        CallTargetNode.InvokeKind invokeKind,
                                                        FrameStateBuilder frameStateBuilder,
                                                        int invokeBci,
                                                        ValueNode... args)

startInvokeWithException

public InvokeWithExceptionNode startInvokeWithException(CallTargetNode callTarget,
                                                        FrameStateBuilder frameStateBuilder,
                                                        int invokeBci)

createExceptionObjectNode

protected ExceptionObjectNode createExceptionObjectNode(FrameStateBuilder frameStateBuilder,
                                                        int exceptionEdgeBci)

setStateAfterException

protected void setStateAfterException(FrameStateBuilder frameStateBuilder,
                                      int exceptionEdgeBci,
                                      StateSplit exceptionObject,
                                      boolean rethrow)

noExceptionPart

public void noExceptionPart()

exceptionPart

public void exceptionPart()

exceptionObject

public ExceptionObjectNode exceptionObject()

endInvokeWithException

public AbstractMergeNode endInvokeWithException()

Finishes a control flow started with GraphKit.startInvokeWithException(ResolvedJavaMethod, org.graalvm.compiler.nodes.CallTargetNode.InvokeKind, org.graalvm.compiler.java.FrameStateBuilder, int, org.graalvm.compiler.nodes.ValueNode...). If necessary, creates a merge of the non-exception and exception edges. The merge node is returned and the non-exception edge is the first forward end of the merge, the exception edge is the second forward end (relevant for phi nodes).