org.graalvm.compiler.nodes

Enum ProfileData.ProfileSource

java.lang.Object

java.lang.Enum<ProfileData.ProfileSource>

org.graalvm.compiler.nodes.ProfileData.ProfileSource

All Implemented Interfaces:

Serializable, Comparable<ProfileData.ProfileSource>

Enclosing class:

ProfileData

public static enum ProfileData.ProfileSource
extends Enum<ProfileData.ProfileSource>

The source of nodes' knowledge about their branch probabilities or loop frequencies, in decreasing order of trust. Information injected via annotations is most trusted, followed by information from mature profiling info. All other sources of probabilities/frequencies are unknown.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INJECTED The profiling information was injected via annotations, or in some other way during compilation based on domain knowledge (e.g., exception paths are very improbable).
PROFILED The profiling information comes from mature profiling information.
UNKNOWN The profiling information comes from immature profiling information or some unknown source.

Method Summary

Modifier and Type	Method and Description
ProfileData.ProfileSource	combine(ProfileData.ProfileSource other) Combine the sources of knowledge about profiles.
static boolean	isTrusted(ProfileData.ProfileSource source)
static ProfileData.ProfileSource	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProfileData.ProfileSource[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INJECTED

public static final ProfileData.ProfileSource INJECTED

The profiling information was injected via annotations, or in some other way during compilation based on domain knowledge (e.g., exception paths are very improbable).

PROFILED

public static final ProfileData.ProfileSource PROFILED

The profiling information comes from mature profiling information.

UNKNOWN

public static final ProfileData.ProfileSource UNKNOWN

The profiling information comes from immature profiling information or some unknown source.

Method Detail

values

public static ProfileData.ProfileSource[] values()

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ProfileData.ProfileSource valueOf(String name)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

combine

public ProfileData.ProfileSource combine(ProfileData.ProfileSource other)

Combine the sources of knowledge about profiles. This returns the most trusted source of the two, e.g., it treats a combination of profiled and unknown information as profiled overall. For example, when deriving a loop's frequency from a trusted exit probability, we want to treat the derived frequency as trusted as well, even if the loop contains some other control flow with unknown branch probabilities.

isTrusted

public static boolean isTrusted(ProfileData.ProfileSource source)