com.oracle.graal.api.replacements

Interface SnippetReflectionProvider

All Known Implementing Classes:

HotSpotSnippetReflectionProvider

public interface SnippetReflectionProvider

Reflection operations on values represented as constants for the processing of snippets. Snippets need a direct access to the value of object constants, which is not allowed in other parts of Graal to enforce compiler-VM separation.

This interface must not be used in Graal code that is not related to snippet processing.

Method Summary

Modifier and Type	Method and Description
<T> T	asObject(Class<T> type, JavaConstant constant) Gets the object reference a given constant represents if it is of a given type.
Object	asObject(ResolvedJavaType type, JavaConstant constant) Gets the object reference a given constant represents if it is of a given type.
JavaConstant	forBoxed(Kind kind, Object value) Creates a boxed constant for the given kind from an Object.
JavaConstant	forObject(Object object) Creates a boxed object constant.
Object	getInjectedNodeIntrinsicParameter(ResolvedJavaType type) Gets the value to bind to an injected parameter in a node intrinsic.
Object	getSubstitutionGuardParameter(Class<?> type) Gets the value to bind to a parameter in a SubstitutionGuard constructor.
default Object	invoke(ResolvedJavaMethod method, Object receiver, Object... args) Invokes a given method via Method.invoke(Object, Object...).
default Object	newArray(ResolvedJavaType componentType, int length) Creates a new array with a given type as the component type and the specified length.
default Object	readConstantFieldValue(JavaField field, Object receiver) Gets the constant value of this field.
static Class<?>	resolveClassForSnippet(JavaType type) Resolves a parameter or return type involved in snippet code to a Class.

Method Detail

forObject

JavaConstant forObject(Object object)

Creates a boxed object constant.

Parameters:

object - the object value to box

Returns:

a constant containing object

asObject

<T> T asObject(Class<T> type,
               JavaConstant constant)

Gets the object reference a given constant represents if it is of a given type. The constant must have kind Kind.Object.

Parameters:

type - the expected type of the object represented by constant. If the object is required to be of this type, then wrap the call to this method in Objects.requireNonNull(Object).

constant - an object constant

Returns:

the object value represented by constant cast to type if it is an instance of type otherwise null

asObject

Object asObject(ResolvedJavaType type,
                JavaConstant constant)

Gets the object reference a given constant represents if it is of a given type. The constant must have kind Kind.Object.

Parameters:

type - the expected type of the object represented by constant. If the object is required to be of this type, then wrap the call to this method in Objects.requireNonNull(Object).

constant - an object constant

Returns:

the object value represented by constant if it is an instance of type otherwise null

forBoxed

JavaConstant forBoxed(Kind kind,
                      Object value)

Creates a boxed constant for the given kind from an Object. The object needs to be of the Java boxed type corresponding to the kind.

Parameters:

kind - the kind of the constant to create

value - the Java boxed value: a Byte instance for Kind.Byte, etc.

Returns:

the boxed copy of value

resolveClassForSnippet

static Class<?> resolveClassForSnippet(JavaType type)
                                throws ClassNotFoundException

Resolves a parameter or return type involved in snippet code to a Class.

Throws:

ClassNotFoundException

invoke

default Object invoke(ResolvedJavaMethod method,
                      Object receiver,
                      Object... args)

Invokes a given method via Method.invoke(Object, Object...).

readConstantFieldValue

default Object readConstantFieldValue(JavaField field,
                                      Object receiver)

Gets the constant value of this field. Note that a static final field may not be considered constant if its declaring class is not yet initialized or if it is a well known field that can be updated via other means (e.g., System.setOut(java.io.PrintStream)).

Parameters:

receiver - object from which this field's value is to be read. This value is ignored if this field is static.

Returns:

the constant value of this field or null if this field is not considered constant by the runtime

newArray

default Object newArray(ResolvedJavaType componentType,
                        int length)

Creates a new array with a given type as the component type and the specified length. This method is similar to Array.newInstance(Class, int).

getSubstitutionGuardParameter

Object getSubstitutionGuardParameter(Class<?> type)

Gets the value to bind to a parameter in a SubstitutionGuard constructor.

Parameters:

type - the type of a parameter in a SubstitutionGuard constructor

Returns:

the value that should be bound to the parameter when invoking the constructor or null if this provider cannot provide a value of the requested type

getInjectedNodeIntrinsicParameter

Object getInjectedNodeIntrinsicParameter(ResolvedJavaType type)

Gets the value to bind to an injected parameter in a node intrinsic.

Parameters:

type - the type of a parameter in a node intrinsic constructor

Returns:

the value that should be bound to the parameter when invoking the constructor or null if this provider cannot provide a value of the requested type