com.oracle.graal.replacements

Class SnippetTemplate

java.lang.Object

com.oracle.graal.replacements.SnippetTemplate

public class SnippetTemplate
extends Object

A snippet template is a graph created by parsing a snippet method and then specialized by binding constants to the snippet's Snippet.ConstantParameter parameters. Snippet templates can be managed in a cache maintained by SnippetTemplate.AbstractTemplates.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnippetTemplate.AbstractTemplates Base class for snippet classes.
static class	SnippetTemplate.Arguments Values that are bound to the snippet method parameters.
(package private) static class	SnippetTemplate.CacheKey
protected static class	SnippetTemplate.EagerSnippetInfo
protected static class	SnippetTemplate.LazySnippetInfo
private static class	SnippetTemplate.MemoryInputMap
private class	SnippetTemplate.MemoryOutputMap
static class	SnippetTemplate.SnippetInfo Holds the ResolvedJavaMethod of the snippet, together with some information about the method that needs to be computed only once.
static interface	SnippetTemplate.UsageReplacer Logic for replacing a snippet-lowered node at its usages with the return value of the snippet.
(package private) static class	SnippetTemplate.Varargs Wrapper for the prototype value of a varargs parameter.
(package private) static class	SnippetTemplate.VarargsPlaceholderNode

Field Summary

Fields

Modifier and Type	Field and Description
private static Object	CONSTANT_PARAMETER
static SnippetTemplate.UsageReplacer	DEFAULT_REPLACER Represents the default usage replacer logic which simply delegates to Node.replaceAtUsages(Node).
private ArrayList<DeoptimizingNode>	deoptNodes Nodes that inherit a deoptimization FrameState from the replacee during instantiation.
private SnippetTemplate.SnippetInfo	info
private DebugMetric	instantiationCounter Counts instantiations of this template.
private DebugTimer	instantiationTimer Times instantiations of this template.
static boolean	LAZY_SNIPPETS
private static String	MAX_TEMPLATES_PER_SNIPPET_PROPERTY_NAME
private static int	MaxTemplatesPerSnippet
private MemoryAnchorNode	memoryAnchor The memory anchor (if any) of the snippet.
private ArrayList<Node>	nodes The nodes to be inlined when this specialization is instantiated.
private Object[]	parameters The named parameters of this template that must be bound to values during instantiation.
private ReturnNode	returnNode The return node (if any) of the snippet.
private ArrayList<StateSplit>	sideEffectNodes Nodes that inherit the StateSplit.stateAfter() from the replacee during instantiation.
private StructuredGraph	snippet The graph built from the snippet method.
private SnippetReflectionProvider	snippetReflection
private static DebugTimer	SnippetTemplateCreationTime
private static DebugMetric	SnippetTemplates
private ArrayList<ValueNode>	stampNodes The nodes that inherit the ValueNode.stamp() from the replacee during instantiation.
private static Object	UNUSED_PARAMETER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SnippetTemplate(Providers providers, SnippetReflectionProvider snippetReflection, SnippetTemplate.Arguments args) Creates a snippet template.

Method Summary

Modifier and Type	Method and Description
private boolean	assertSnippetKills(ValueNode replacee)
private Map<Node,Node>	bind(StructuredGraph replaceeGraph, MetaAccessProvider metaAccess, SnippetTemplate.Arguments args) Gets the instantiation-time bindings to this template's parameters.
private static boolean	checkAllVarargPlaceholdersAreDeleted(int parameterCount, SnippetTemplate.VarargsPlaceholderNode[] placeholders)
private static boolean	checkConstantArgument(MetaAccessProvider metaAccess, ResolvedJavaMethod method, Signature signature, int i, String name, Object arg, Kind kind)
private static boolean	checkTemplate(MetaAccessProvider metaAccess, SnippetTemplate.Arguments args, ResolvedJavaMethod method, Signature signature)
private static boolean	checkVarargs(MetaAccessProvider metaAccess, ResolvedJavaMethod method, Signature signature, int i, String name, SnippetTemplate.Varargs varargs)
StructuredGraph	copySpecializedGraph() Gets a copy of the specialized graph.
protected JavaConstant	forBoxed(Object argument, Kind localKind) Converts a Java boxed value to a JavaConstant of the right kind.
protected Object[]	getConstantArgs(SnippetTemplate.Arguments args)
private static LocationIdentity	getLocationIdentity(Node node)
static boolean	hasConstantParameter(ResolvedJavaMethod method) Determines if any parameter of a given method is annotated with Snippet.ConstantParameter.
Map<Node,Node>	instantiate(MetaAccessProvider metaAccess, FixedNode replacee, SnippetTemplate.UsageReplacer replacer, SnippetTemplate.Arguments args) Replaces a given fixed node with this specialized snippet.
void	instantiate(MetaAccessProvider metaAccess, FloatingNode replacee, SnippetTemplate.UsageReplacer replacer, LoweringTool tool, SnippetTemplate.Arguments args) Replaces a given floating node with this specialized snippet.
private void	propagateStamp(Node node)
private void	replaceMemoryUsages(ValueNode node, MemoryMap map)
private void	rewireMemoryGraph(ValueNode replacee, Map<Node,Node> duplicates)
String	toString()
private void	updateStamps(ValueNode replacee, Map<Node,Node> duplicates)

Methods inherited from class java.lang.Object

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

Field Detail

LAZY_SNIPPETS

public static boolean LAZY_SNIPPETS

SnippetTemplateCreationTime

private static final DebugTimer SnippetTemplateCreationTime

SnippetTemplates

private static final DebugMetric SnippetTemplates

MAX_TEMPLATES_PER_SNIPPET_PROPERTY_NAME

private static final String MAX_TEMPLATES_PER_SNIPPET_PROPERTY_NAME

See Also:

Constant Field Values

MaxTemplatesPerSnippet

private static final int MaxTemplatesPerSnippet

UNUSED_PARAMETER

private static final Object UNUSED_PARAMETER

CONSTANT_PARAMETER

private static final Object CONSTANT_PARAMETER

snippetReflection

private final SnippetReflectionProvider snippetReflection

snippet

private final StructuredGraph snippet

The graph built from the snippet method.

info

private final SnippetTemplate.SnippetInfo info

parameters

private final Object[] parameters

The named parameters of this template that must be bound to values during instantiation. For a parameter that is still live after specialization, the value in this map is either a ParameterNode instance or a ParameterNode array. For an eliminated parameter, the value is identical to the key.

returnNode

private final ReturnNode returnNode

The return node (if any) of the snippet.

memoryAnchor

private final MemoryAnchorNode memoryAnchor

The memory anchor (if any) of the snippet.

sideEffectNodes

private final ArrayList<StateSplit> sideEffectNodes

Nodes that inherit the StateSplit.stateAfter() from the replacee during instantiation.

deoptNodes

private final ArrayList<DeoptimizingNode> deoptNodes

Nodes that inherit a deoptimization FrameState from the replacee during instantiation.

stampNodes

private final ArrayList<ValueNode> stampNodes

The nodes that inherit the ValueNode.stamp() from the replacee during instantiation.

nodes

private final ArrayList<Node> nodes

The nodes to be inlined when this specialization is instantiated.

instantiationTimer

private final DebugTimer instantiationTimer

Times instantiations of this template.

See Also:

SnippetTemplate.SnippetInfo.instantiationTimer

instantiationCounter

private final DebugMetric instantiationCounter

Counts instantiations of this template.

See Also:

SnippetTemplate.SnippetInfo.instantiationCounter

DEFAULT_REPLACER

public static final SnippetTemplate.UsageReplacer DEFAULT_REPLACER

Represents the default usage replacer logic which simply delegates to Node.replaceAtUsages(Node).

Constructor Detail

SnippetTemplate

protected SnippetTemplate(Providers providers,
                          SnippetReflectionProvider snippetReflection,
                          SnippetTemplate.Arguments args)

Creates a snippet template.

Method Detail

hasConstantParameter

public static boolean hasConstantParameter(ResolvedJavaMethod method)

Determines if any parameter of a given method is annotated with Snippet.ConstantParameter.

getConstantArgs

protected Object[] getConstantArgs(SnippetTemplate.Arguments args)

checkAllVarargPlaceholdersAreDeleted

private static boolean checkAllVarargPlaceholdersAreDeleted(int parameterCount,
                                                            SnippetTemplate.VarargsPlaceholderNode[] placeholders)

checkConstantArgument

private static boolean checkConstantArgument(MetaAccessProvider metaAccess,
                                             ResolvedJavaMethod method,
                                             Signature signature,
                                             int i,
                                             String name,
                                             Object arg,
                                             Kind kind)

checkVarargs

private static boolean checkVarargs(MetaAccessProvider metaAccess,
                                    ResolvedJavaMethod method,
                                    Signature signature,
                                    int i,
                                    String name,
                                    SnippetTemplate.Varargs varargs)

bind

private Map<Node,Node> bind(StructuredGraph replaceeGraph,
                            MetaAccessProvider metaAccess,
                            SnippetTemplate.Arguments args)

Gets the instantiation-time bindings to this template's parameters.

Returns:

the map that will be used to bind arguments to parameters when inlining this template

forBoxed

protected JavaConstant forBoxed(Object argument,
                                Kind localKind)

Converts a Java boxed value to a JavaConstant of the right kind. This adjusts for the limitation that a Local's kind is a stack kind and so cannot be used for re-boxing primitives smaller than an int.

Parameters:

argument - a Java boxed value

localKind - the kind of the Local to which argument will be bound

assertSnippetKills

private boolean assertSnippetKills(ValueNode replacee)

rewireMemoryGraph

private void rewireMemoryGraph(ValueNode replacee,
                               Map<Node,Node> duplicates)

getLocationIdentity

private static LocationIdentity getLocationIdentity(Node node)

replaceMemoryUsages

private void replaceMemoryUsages(ValueNode node,
                                 MemoryMap map)

instantiate

public Map<Node,Node> instantiate(MetaAccessProvider metaAccess,
                                  FixedNode replacee,
                                  SnippetTemplate.UsageReplacer replacer,
                                  SnippetTemplate.Arguments args)

Replaces a given fixed node with this specialized snippet.

Parameters:

metaAccess -

replacee - the node that will be replaced

replacer - object that replaces the usages of replacee

args - the arguments to be bound to the flattened positional parameters of the snippet

Returns:

the map of duplicated nodes (original -> duplicate)

propagateStamp

private void propagateStamp(Node node)

updateStamps

private void updateStamps(ValueNode replacee,
                          Map<Node,Node> duplicates)

copySpecializedGraph

public StructuredGraph copySpecializedGraph()

Gets a copy of the specialized graph.

instantiate

public void instantiate(MetaAccessProvider metaAccess,
                        FloatingNode replacee,
                        SnippetTemplate.UsageReplacer replacer,
                        LoweringTool tool,
                        SnippetTemplate.Arguments args)

Replaces a given floating node with this specialized snippet.

Parameters:

metaAccess -

replacee - the node that will be replaced

replacer - object that replaces the usages of replacee

args - the arguments to be bound to the flattened positional parameters of the snippet

toString

public String toString()

Overrides:

toString in class Object

checkTemplate

private static boolean checkTemplate(MetaAccessProvider metaAccess,
                                     SnippetTemplate.Arguments args,
                                     ResolvedJavaMethod method,
                                     Signature signature)