org.graalvm.compiler.nodes

Class TypeCheckHints

java.lang.Object

org.graalvm.compiler.nodes.TypeCheckHints

public class TypeCheckHints
extends Object

Utility for deriving hint types for a type check instruction (e.g. checkcast or instanceof) based on the target type of the check and any profiling information available for the instruction.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TypeCheckHints.Hint A receiver type profiled in a type check instruction.

Field Summary

Fields

Modifier and Type	Field and Description
ResolvedJavaType	exact If non-null, then this is the only type that could pass the type check because the target of the type check is a final class or has been speculated to be a final class and this value is the only concrete subclass of the target type.
double	hintHitProbability The total probability that the type check will hit one of the types in TypeCheckHints.hints.
TypeCheckHints.Hint[]	hints The most likely types that the type check instruction will see.
JavaTypeProfile	profile The profile from which this information was derived.

Constructor Summary

Constructors

Constructor and Description
TypeCheckHints(TypeReference targetType, JavaTypeProfile profile, Assumptions assumptions, double minHintHitProbability, int maxHints) Derives hint information for use when generating the code for a type check instruction.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

exact

public final ResolvedJavaType exact

If non-null, then this is the only type that could pass the type check because the target of the type check is a final class or has been speculated to be a final class and this value is the only concrete subclass of the target type.

hints

public final TypeCheckHints.Hint[] hints

The most likely types that the type check instruction will see.

profile

public final JavaTypeProfile profile

The profile from which this information was derived.

hintHitProbability

public final double hintHitProbability

The total probability that the type check will hit one of the types in TypeCheckHints.hints.

Constructor Detail

TypeCheckHints

public TypeCheckHints(TypeReference targetType,
                      JavaTypeProfile profile,
                      Assumptions assumptions,
                      double minHintHitProbability,
                      int maxHints)

Derives hint information for use when generating the code for a type check instruction.

Parameters:

targetType - the target type of the type check

profile - the profiling information available for the instruction (if any)

assumptions - the object in which speculations are recorded. This is null if speculations are not supported.

minHintHitProbability - if the probability that the type check will hit one of the profiled types (up to maxHints) is below this value, then TypeCheckHints.hints will be null

maxHints - the maximum length of TypeCheckHints.hints