org.graalvm.compiler.replacements

Class SnippetTemplate.Arguments

java.lang.Object

org.graalvm.compiler.replacements.SnippetTemplate.Arguments

All Implemented Interfaces:

Formattable

Enclosing class:

SnippetTemplate

public static class SnippetTemplate.Arguments
extends Object
implements Formattable

Values that are bound to the snippet method parameters. The methods SnippetTemplate.Arguments.add(java.lang.String, java.lang.Object), SnippetTemplate.Arguments.addConst(java.lang.String, java.lang.Object), and SnippetTemplate.Arguments.addVarargs(java.lang.String, java.lang.Class<?>, org.graalvm.compiler.core.common.type.Stamp, java.lang.Object) must be called in the same order as in the signature of the snippet method. The parameter name is passed to the add methods for assertion checking, i.e., to enforce that the order matches. Which method needs to be called depends on the annotation of the snippet method parameter:

• Use SnippetTemplate.Arguments.add(java.lang.String, java.lang.Object) for a parameter without an annotation. The value is bound when the SnippetTemplate is instantiated.
• Use SnippetTemplate.Arguments.addConst(java.lang.String, java.lang.Object) for a parameter annotated with Snippet.ConstantParameter. The value is bound when the SnippetTemplate is created.
• Use SnippetTemplate.Arguments.addVarargs(java.lang.String, java.lang.Class<?>, org.graalvm.compiler.core.common.type.Stamp, java.lang.Object) for an array parameter annotated with Snippet.VarargsParameter. A separate SnippetTemplate is created for every distinct array length. The actual values are bound when the SnippetTemplate is instantiated

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cacheable
protected org.graalvm.compiler.replacements.SnippetTemplate.CacheKey	cacheKey
protected Stamp[]	constStamps
protected SnippetTemplate.SnippetInfo	info
protected int	nextParamIdx
protected Object[]	values

Constructor Summary

Constructors

Constructor and Description
Arguments(SnippetTemplate.SnippetInfo info, StructuredGraph.GuardsStage guardsStage, LoweringTool.LoweringStage loweringStage)

Method Summary

Modifier and Type	Method and Description
SnippetTemplate.Arguments	add(String name, Object value)
SnippetTemplate.Arguments	addConst(String name, Object value)
SnippetTemplate.Arguments	addConst(String name, Object value, Stamp stamp)
SnippetTemplate.Arguments	addVarargs(String name, Class<?> componentType, Stamp argStamp, Object value)
void	formatTo(Formatter formatter, int flags, int width, int precision)
void	setCacheable(boolean cacheable)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

info

protected final SnippetTemplate.SnippetInfo info

cacheKey

protected final org.graalvm.compiler.replacements.SnippetTemplate.CacheKey cacheKey

values

protected final Object[] values

constStamps

protected final Stamp[] constStamps

cacheable

protected boolean cacheable

nextParamIdx

protected int nextParamIdx

Constructor Detail

Arguments

public Arguments(SnippetTemplate.SnippetInfo info,
                 StructuredGraph.GuardsStage guardsStage,
                 LoweringTool.LoweringStage loweringStage)

Method Detail

add

public SnippetTemplate.Arguments add(String name,
                                     Object value)

addConst

public SnippetTemplate.Arguments addConst(String name,
                                          Object value)

addConst

public SnippetTemplate.Arguments addConst(String name,
                                          Object value,
                                          Stamp stamp)

addVarargs

public SnippetTemplate.Arguments addVarargs(String name,
                                            Class<?> componentType,
                                            Stamp argStamp,
                                            Object value)

setCacheable

public void setCacheable(boolean cacheable)

toString

public String toString()

Overrides:

toString in class Object

formatTo

public void formatTo(Formatter formatter,
                     int flags,
                     int width,
                     int precision)

Specified by:

formatTo in interface Formattable