org.graalvm.compiler.graph

Annotation Type Node.NodeIntrinsic

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public static @interface Node.NodeIntrinsic

Annotates a method that can be replaced by a compiler intrinsic. A (resolved) call to the annotated method will be processed by a generated InvocationPlugin that calls either a factory method or a constructor corresponding with the annotated method. By default the intrinsics are implemented by invoking the constructor but a factory method may be used instead. To use a factory method the class implementing the intrinsic must be annotated with Node.NodeIntrinsicFactory. To ease error checking of NodeIntrinsics all intrinsics are expected to be implemented in the same way, so it's not possible to mix constructor and factory intrinsification in the same class.

A factory method corresponding to an annotated method is a static method named intrinsify defined in the class denoted by Node.NodeIntrinsic.value(). In order, its signature is as follows:

1. A GraphBuilderContext parameter.
2. A sequence of zero or more injected parameters.
3. Remaining parameters that match the declared parameters of the annotated method.

A constructor corresponding to an annotated method is defined in the class denoted by Node.NodeIntrinsic.value(). In order, its signature is as follows:

1. A sequence of zero or more injected parameters.
2. Remaining parameters that match the declared parameters of the annotated method.

There must be exactly one such factory method or constructor corresponding to a Node.NodeIntrinsic annotated method.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	hasSideEffect If true then this is lowered into a node that has side effects.
boolean	injectedStampIsNonNull If true, the factory method or constructor selected by the annotation must have an injected Stamp parameter.
Class<?>	value The class declaring the factory method or Node subclass declaring the constructor used to intrinsify a call to the annotated method.

Element Detail

value

public abstract Class<?> value

The class declaring the factory method or Node subclass declaring the constructor used to intrinsify a call to the annotated method. The default value is the class in which the annotated method is declared.

Default:

org.graalvm.compiler.graph.Node.NodeIntrinsic.class

injectedStampIsNonNull

public abstract boolean injectedStampIsNonNull

If true, the factory method or constructor selected by the annotation must have an injected Stamp parameter. Calling AbstractPointerStamp.nonNull() on the injected stamp is guaranteed to return true.

Default:

false

hasSideEffect

public abstract boolean hasSideEffect

If true then this is lowered into a node that has side effects.

Default:

false