org.graalvm.compiler.nodeinfo

Annotation Type NodeInfo

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface NodeInfo

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
InputType[]	allowedUsageTypes
NodeCycles	cycles An estimation of the number of CPU cycles needed to execute this node that can be used to compare its execution cost against other nodes.
String	cyclesRationale A rationale for the chosen NodeInfo.cycles() value.
String	nameTemplate The template used to build the Verbosity.Name version.
String	shortName
NodeSize	size An estimation of the code size needed to represent this node in machine code that can be used to compare its size cost against other nodes.
String	sizeRationale A rationale for the chosen NodeInfo.size() value.

Element Detail

shortName

public abstract String shortName

Default:

""

nameTemplate

public abstract String nameTemplate

The template used to build the Verbosity.Name version. Variable part are specified using {i#inputName} or {p#propertyName}.

Default:

""

allowedUsageTypes

public abstract InputType[] allowedUsageTypes

Default:

{}

cycles

public abstract NodeCycles cycles

An estimation of the number of CPU cycles needed to execute this node that can be used to compare its execution cost against other nodes. Implementations of graph cost models based on this value might throw an exception if a node's NodeCycles value is NodeCycles.CYCLES_UNSET. As such, it is recommended to specify a value for nodes likely to be inputs to a graph cost model.

Default:

org.graalvm.compiler.nodeinfo.NodeCycles.CYCLES_UNSET

cyclesRationale

public abstract String cyclesRationale

A rationale for the chosen NodeInfo.cycles() value.

Default:

""

size

public abstract NodeSize size

An estimation of the code size needed to represent this node in machine code that can be used to compare its size cost against other nodes. Implementations of graph cost models based on this value might throw an exception if a node's NodeSize value is NodeSize.SIZE_UNSET. As such, it is recommended to specify a value for nodes likely to be inputs to a graph cost model.

Default:

org.graalvm.compiler.nodeinfo.NodeSize.SIZE_UNSET

sizeRationale

public abstract String sizeRationale

A rationale for the chosen NodeInfo.size() value.

Default:

""