com.oracle.truffle.api.profiles

Class InlinedConditionProfile

java.lang.Object

com.oracle.truffle.api.profiles.InlinedProfile

com.oracle.truffle.api.profiles.InlinedConditionProfile

public final class InlinedConditionProfile
extends InlinedProfile

ConditionProfiles are useful to profile the outcome of conditions. A regular condition profile keeps track of a binary state, for each branch whether a branch was hit or not and communicates this to the compiler. If frequency information for each branch should be collected use InlinedCountingConditionProfile instead.

Usage example:

 abstract class AbsoluteNode extends Node {

     abstract void execute(int value);

     @Specialization
     int doDefault(int value,
                     @Cached InlinedConditionProfile p) {
         if (p.profile(this, value >= 0)) {
             return value;
         } else {
             return -value;
         }
     }
 }
 

Since:

23.0

Method Summary

Modifier and Type	Method and Description
void	disable(Node node) Disables this profile by setting it to its generic state.
static InlinedConditionProfile	getUncached() Returns the uncached version of the profile.
static InlinedConditionProfile	inline(InlineSupport.InlineTarget target) Returns an inlined version of the profile.
boolean	profile(Node node, boolean value)
void	reset(Node node) Resets this profile to its uninitialized state.
String	toString(Node node) Prints a string representation of this inlined profile given a target node.
boolean	wasFalse(Node node) Returns true if the InlinedConditionProfile.profile(Node, boolean) method ever received a false value, otherwise false.
boolean	wasTrue(Node node) Returns true if the InlinedConditionProfile.profile(Node, boolean) method ever received a true value, otherwise false.

Methods inherited from class com.oracle.truffle.api.profiles.InlinedProfile

toString

Methods inherited from class java.lang.Object

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

Method Detail

profile

public boolean profile(Node node,
                       boolean value)

Since:

23.0

wasTrue

public boolean wasTrue(Node node)

Returns true if the InlinedConditionProfile.profile(Node, boolean) method ever received a true value, otherwise false. For profiles with profiling disabled or uncached profiles this method always returns true.

Since:

23.0

wasFalse

public boolean wasFalse(Node node)

Returns true if the InlinedConditionProfile.profile(Node, boolean) method ever received a false value, otherwise false. For profiles with profiling disabled or uncached profiles this method always returns true.

Since:

23.0

disable

public void disable(Node node)

Disables this profile by setting it to its generic state. After disabling it is guaranteed to never deoptimize on any invocation of a profile method.

This method must not be called on compiled code paths. Note that disabling the profile will not invalidate existing compiled code that uses this profile.

Specified by:

disable in class InlinedProfile

Since:

23.0

reset

public void reset(Node node)

Resets this profile to its uninitialized state. Has no effect if this profile is already in its uninitialized state or a disabled version of this profile is used.

This method must not be called on compiled code paths. Note that disabling the profile will not invalidate existing compiled code that uses this profile.

Specified by:

reset in class InlinedProfile

Since:

23.0

toString

public String toString(Node node)

Prints a string representation of this inlined profile given a target node.

Specified by:

toString in class InlinedProfile

Since:

23.0

inline

public static InlinedConditionProfile inline(InlineSupport.InlineTarget target)

Returns an inlined version of the profile. This version is automatically used by Truffle DSL node inlining.

Since:

23.0

getUncached

public static InlinedConditionProfile getUncached()

Returns the uncached version of the profile. The uncached version of a profile does not perform any profiling.

Since:

23.0