org.graalvm.compiler.replacements

Class ReplacementsImpl

java.lang.Object

org.graalvm.compiler.replacements.ReplacementsImpl

All Implemented Interfaces:

GeneratedPluginInjectionProvider, GraphBuilderPlugin, InlineInvokePlugin, Replacements

Direct Known Subclasses:

HotSpotReplacementsImpl

public class ReplacementsImpl
extends Object
implements Replacements, InlineInvokePlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReplacementsImpl.GraphMaker Creates and preprocesses a graph for a replacement.

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

InlineInvokePlugin.InlineInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected BytecodeProvider	defaultBytecodeProvider The default BytecodeProvider to use for accessing the bytecode of a replacement if the replacement doesn't provide another BytecodeProvider.
protected ConcurrentMap<ResolvedJavaMethod,StructuredGraph>	graphs The preprocessed replacement graphs.
protected Providers	providers
SnippetReflectionProvider	snippetReflection
TargetDescription	target

Constructor Summary

Constructors

Constructor and Description
ReplacementsImpl(DebugHandlersFactory debugHandlersFactory, Providers providers, SnippetReflectionProvider snippetReflection, BytecodeProvider bytecodeProvider, TargetDescription target)

Method Summary

Modifier and Type	Method and Description
protected ReplacementsImpl.GraphMaker	createGraphMaker(ResolvedJavaMethod substitute, ResolvedJavaMethod original) Can be overridden to return an object that specializes various parts of graph preprocessing.
BytecodeProvider	getDefaultReplacementBytecodeProvider() Gets the provider for accessing the bytecode of a substitution method if no other provider is associated with the substitution method.
GraphBuilderConfiguration.Plugins	getGraphBuilderPlugins() Gets the object managing the various graph builder plugins used by this object when parsing bytecode into a graph.
<T> T	getInjectedArgument(Class<T> capability)
Stamp	getInjectedStamp(Class<?> type, boolean nonNull) Gets a stamp denoting a given type and non-nullness property.
StructuredGraph	getInlineSubstitution(ResolvedJavaMethod method, int invokeBci, Invoke.InlineControl inlineControl, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition, StructuredGraph.AllowAssumptions allowAssumptions, OptionValues options) Gets a graph that is a substitution for a given method.
StructuredGraph	getIntrinsicGraph(ResolvedJavaMethod method, CompilationIdentifier compilationId, DebugContext debug, StructuredGraph.AllowAssumptions allowAssumptions, Cancellable cancellable) Gets a graph produced from the intrinsic for a given method that can be compiled and installed for the method.
Class<? extends GraphBuilderPlugin>	getIntrinsifyingPlugin(ResolvedJavaMethod method) Gets the plugin type that intrinsifies calls to method.
Providers	getProviders()
StructuredGraph	getSnippet(ResolvedJavaMethod method, ResolvedJavaMethod recursiveEntry, Object[] args, BitSet nonNullParameters, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition, OptionValues options) Gets the snippet graph derived from a given method.
SnippetParameterInfo	getSnippetParameterInfo(ResolvedJavaMethod method) Get the snippet metadata required to inline the snippet.
<T extends SnippetTemplateCache> T	getSnippetTemplateCache(Class<T> templatesClass) Get snippet templates that were registered with Replacements.registerSnippetTemplateCache(SnippetTemplateCache).
JavaKind	getWordKind() Gets the JavaKind corresponding to word values.
boolean	hasSubstitution(ResolvedJavaMethod method, OptionValues options) Determines if there may be a substitution graph for a given method.
boolean	isSnippet(ResolvedJavaMethod method) Return true if the method is a Snippet.
StructuredGraph	makeGraph(DebugContext debug, BytecodeProvider bytecodeProvider, ResolvedJavaMethod method, Object[] args, BitSet nonNullParameters, ResolvedJavaMethod original, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition) Creates a preprocessed graph for a snippet or method substitution with a context of .
StructuredGraph	makeGraph(DebugContext debug, BytecodeProvider bytecodeProvider, ResolvedJavaMethod method, Object[] args, BitSet nonNullParameters, ResolvedJavaMethod original, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition, IntrinsicContext.CompilationContext context) Creates a preprocessed graph for a snippet or method substitution.
void	notifyNotInlined(GraphBuilderContext b, ResolvedJavaMethod method, Invoke invoke) Notifies this plugin of the Invoke node created for a method that was not inlined per InlineInvokePlugin.shouldInlineInvoke(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.ValueNode[]).
DebugContext	openDebugContext(String idPrefix, ResolvedJavaMethod method, OptionValues options)
DebugContext	openSnippetDebugContext(DebugContext.Description description, DebugContext outer, OptionValues options) Create a DebugContext for use with Snippet related work.
DebugContext	openSnippetDebugContext(String idPrefix, ResolvedJavaMethod method, OptionValues options)
void	registerConditionalPlugin(InvocationPlugin plugin) Marks a plugin as conditionally applied.
void	registerSnippet(ResolvedJavaMethod method, ResolvedJavaMethod original, Object receiver, boolean trackNodeSourcePosition, OptionValues options) Registers a method as snippet.
void	registerSnippetTemplateCache(SnippetTemplateCache templates) Register snippet templates.
void	setGraphBuilderPlugins(GraphBuilderConfiguration.Plugins plugins)
void	setProviders(Providers providers)
InlineInvokePlugin.InlineInfo	shouldInlineInvoke(GraphBuilderContext b, ResolvedJavaMethod method, ValueNode[] args) Determines whether a given method should be inlined based on whether it has a substitution or whether the inlining context is already within a substitution.

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.spi.Replacements

closeSnippetRegistration, isEncodingSnippets

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

notifyAfterInline, notifyBeforeInline

Field Detail

providers

protected Providers providers

snippetReflection

public final SnippetReflectionProvider snippetReflection

target

public final TargetDescription target

graphs

protected final ConcurrentMap<ResolvedJavaMethod,StructuredGraph> graphs

The preprocessed replacement graphs.

defaultBytecodeProvider

protected final BytecodeProvider defaultBytecodeProvider

The default BytecodeProvider to use for accessing the bytecode of a replacement if the replacement doesn't provide another BytecodeProvider.

Constructor Detail

ReplacementsImpl

public ReplacementsImpl(DebugHandlersFactory debugHandlersFactory,
                        Providers providers,
                        SnippetReflectionProvider snippetReflection,
                        BytecodeProvider bytecodeProvider,
                        TargetDescription target)

Method Detail

getProviders

public Providers getProviders()

Specified by:

getProviders in interface Replacements

setProviders

public void setProviders(Providers providers)

setGraphBuilderPlugins

public void setGraphBuilderPlugins(GraphBuilderConfiguration.Plugins plugins)

getGraphBuilderPlugins

public GraphBuilderConfiguration.Plugins getGraphBuilderPlugins()

Description copied from interface: Replacements

Gets the object managing the various graph builder plugins used by this object when parsing bytecode into a graph.

Specified by:

getGraphBuilderPlugins in interface Replacements

getInjectedArgument

public <T> T getInjectedArgument(Class<T> capability)

Specified by:

getInjectedArgument in interface GeneratedPluginInjectionProvider

getInjectedStamp

public Stamp getInjectedStamp(Class<?> type,
                              boolean nonNull)

Description copied from interface: GeneratedPluginInjectionProvider

Gets a stamp denoting a given type and non-nullness property.

Specified by:

getInjectedStamp in interface GeneratedPluginInjectionProvider

Parameters:

type - the type the returned stamp represents

nonNull - specifies if the returned stamp denotes a value that is guaranteed to be non-null

getIntrinsifyingPlugin

public Class<? extends GraphBuilderPlugin> getIntrinsifyingPlugin(ResolvedJavaMethod method)

Description copied from interface: Replacements

Gets the plugin type that intrinsifies calls to method.

Specified by:

getIntrinsifyingPlugin in interface Replacements

shouldInlineInvoke

public InlineInvokePlugin.InlineInfo shouldInlineInvoke(GraphBuilderContext b,
                                                        ResolvedJavaMethod method,
                                                        ValueNode[] args)

Determines whether a given method should be inlined based on whether it has a substitution or whether the inlining context is already within a substitution.

Specified by:

shouldInlineInvoke in interface InlineInvokePlugin

Parameters:

b - the context

method - the target method of an invoke

args - the arguments to the invoke

Returns:

an object specifying how method is to be inlined or null if it should not be inlined based on substitution related criteria

notifyNotInlined

public void notifyNotInlined(GraphBuilderContext b,
                             ResolvedJavaMethod method,
                             Invoke invoke)

Description copied from interface: InlineInvokePlugin

Notifies this plugin of the Invoke node created for a method that was not inlined per InlineInvokePlugin.shouldInlineInvoke(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.ValueNode[]).

Specified by:

notifyNotInlined in interface InlineInvokePlugin

Parameters:

b - the context

method - the method that was not inlined

invoke - the invoke node created for the call to method

openSnippetDebugContext

public DebugContext openSnippetDebugContext(DebugContext.Description description,
                                            DebugContext outer,
                                            OptionValues options)

Description copied from interface: Replacements

Create a DebugContext for use with Snippet related work. Snippet processingis hidden by default using the flags DebugStubsAndSnippets.

Specified by:

openSnippetDebugContext in interface Replacements

openSnippetDebugContext

public DebugContext openSnippetDebugContext(String idPrefix,
                                            ResolvedJavaMethod method,
                                            OptionValues options)

openDebugContext

public DebugContext openDebugContext(String idPrefix,
                                     ResolvedJavaMethod method,
                                     OptionValues options)

getSnippet

public StructuredGraph getSnippet(ResolvedJavaMethod method,
                                  ResolvedJavaMethod recursiveEntry,
                                  Object[] args,
                                  BitSet nonNullParameters,
                                  boolean trackNodeSourcePosition,
                                  NodeSourcePosition replaceePosition,
                                  OptionValues options)

Description copied from interface: Replacements

Gets the snippet graph derived from a given method.

Specified by:

getSnippet in interface Replacements

recursiveEntry - XXX always null now?.

args - arguments to the snippet if available, otherwise null

Returns:

the snippet graph, if any, that is derived from method

getSnippetParameterInfo

public SnippetParameterInfo getSnippetParameterInfo(ResolvedJavaMethod method)

Description copied from interface: Replacements

Get the snippet metadata required to inline the snippet.

Specified by:

getSnippetParameterInfo in interface Replacements

isSnippet

public boolean isSnippet(ResolvedJavaMethod method)

Description copied from interface: Replacements

Return true if the method is a Snippet.

Specified by:

isSnippet in interface Replacements

registerSnippet

public void registerSnippet(ResolvedJavaMethod method,
                            ResolvedJavaMethod original,
                            Object receiver,
                            boolean trackNodeSourcePosition,
                            OptionValues options)

Description copied from interface: Replacements

Registers a method as snippet.

Specified by:

registerSnippet in interface Replacements

registerConditionalPlugin

public void registerConditionalPlugin(InvocationPlugin plugin)

Description copied from interface: Replacements

Marks a plugin as conditionally applied. In the contenxt of libgraal conditional plugins can't be used in during graph encoding for snippets and method substitutions and this is used to detect violations of this restriction.

Specified by:

registerConditionalPlugin in interface Replacements

hasSubstitution

public boolean hasSubstitution(ResolvedJavaMethod method,
                               OptionValues options)

Description copied from interface: Replacements

Determines if there may be a substitution graph for a given method. A call to Replacements.getInlineSubstitution(ResolvedJavaMethod, int, org.graalvm.compiler.nodes.Invoke.InlineControl, boolean, org.graalvm.compiler.graph.NodeSourcePosition, org.graalvm.compiler.nodes.StructuredGraph.AllowAssumptions, org.graalvm.compiler.options.OptionValues) may still return null for method and substitution may be based on an InvocationPlugin that returns false for InvocationPlugin.execute(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver, org.graalvm.compiler.nodes.ValueNode[]) making it impossible to create a substitute graph.

Specified by:

hasSubstitution in interface Replacements

Returns:

true iff there may be a substitution graph available for method

getDefaultReplacementBytecodeProvider

public BytecodeProvider getDefaultReplacementBytecodeProvider()

Description copied from interface: Replacements

Gets the provider for accessing the bytecode of a substitution method if no other provider is associated with the substitution method.

Specified by:

getDefaultReplacementBytecodeProvider in interface Replacements

getInlineSubstitution

public StructuredGraph getInlineSubstitution(ResolvedJavaMethod method,
                                             int invokeBci,
                                             Invoke.InlineControl inlineControl,
                                             boolean trackNodeSourcePosition,
                                             NodeSourcePosition replaceePosition,
                                             StructuredGraph.AllowAssumptions allowAssumptions,
                                             OptionValues options)

Description copied from interface: Replacements

Gets a graph that is a substitution for a given method.

Specified by:

getInlineSubstitution in interface Replacements

invokeBci - the call site BCI for the substitution

Returns:

the graph, if any, that is a substitution for method

getIntrinsicGraph

public StructuredGraph getIntrinsicGraph(ResolvedJavaMethod method,
                                         CompilationIdentifier compilationId,
                                         DebugContext debug,
                                         StructuredGraph.AllowAssumptions allowAssumptions,
                                         Cancellable cancellable)

Description copied from interface: Replacements

Gets a graph produced from the intrinsic for a given method that can be compiled and installed for the method.

Specified by:

getIntrinsicGraph in interface Replacements

Returns:

an intrinsic graph that can be compiled and installed for method or null

makeGraph

public StructuredGraph makeGraph(DebugContext debug,
                                 BytecodeProvider bytecodeProvider,
                                 ResolvedJavaMethod method,
                                 Object[] args,
                                 BitSet nonNullParameters,
                                 ResolvedJavaMethod original,
                                 boolean trackNodeSourcePosition,
                                 NodeSourcePosition replaceePosition,
                                 IntrinsicContext.CompilationContext context)

Creates a preprocessed graph for a snippet or method substitution.

Parameters:

bytecodeProvider - how to access the bytecode of method

method - the snippet or method substitution for which a graph will be created

args -

nonNullParameters -

original - XXX always null?

trackNodeSourcePosition - record source information

context - compilation context for the graph

makeGraph

public final StructuredGraph makeGraph(DebugContext debug,
                                       BytecodeProvider bytecodeProvider,
                                       ResolvedJavaMethod method,
                                       Object[] args,
                                       BitSet nonNullParameters,
                                       ResolvedJavaMethod original,
                                       boolean trackNodeSourcePosition,
                                       NodeSourcePosition replaceePosition)

Creates a preprocessed graph for a snippet or method substitution with a context of . IntrinsicContext.CompilationContext.INLINE_AFTER_PARSING .

Parameters:

bytecodeProvider - how to access the bytecode of method

method - the snippet or method substitution for which a graph will be created

args -

nonNullParameters -

original - XXX always null?

trackNodeSourcePosition - record source information

createGraphMaker

protected ReplacementsImpl.GraphMaker createGraphMaker(ResolvedJavaMethod substitute,
                                                       ResolvedJavaMethod original)

Can be overridden to return an object that specializes various parts of graph preprocessing.

registerSnippetTemplateCache

public void registerSnippetTemplateCache(SnippetTemplateCache templates)

Description copied from interface: Replacements

Register snippet templates.

Specified by:

registerSnippetTemplateCache in interface Replacements

getSnippetTemplateCache

public <T extends SnippetTemplateCache> T getSnippetTemplateCache(Class<T> templatesClass)

Description copied from interface: Replacements

Get snippet templates that were registered with Replacements.registerSnippetTemplateCache(SnippetTemplateCache).

Specified by:

getSnippetTemplateCache in interface Replacements

getWordKind

public JavaKind getWordKind()

Description copied from interface: Replacements

Gets the JavaKind corresponding to word values.

Specified by:

getWordKind in interface Replacements