com.oracle.truffle.api.profiles

Class InlinedBranchProfile

java.lang.Object

com.oracle.truffle.api.profiles.InlinedProfile

com.oracle.truffle.api.profiles.InlinedBranchProfile

public final class InlinedBranchProfile
extends InlinedProfile

BranchProfiles are profiles to speculate on branches that are unlikely to be visited. If the InlinedBranchProfile.enter(Node) method is invoked first the optimized code is invalidated and the branch where InlinedBranchProfile.enter(Node) is invoked is enabled for compilation. Otherwise if the InlinedBranchProfile.enter(Node) method was never invoked the branch will not get compiled.

Usage example:

 class ExampleNode extends Node {

     abstract int execute(int value);

     @Specialization
     int doDefault(int value, @Cached InlinedBranchProfile errorProfile) {
         if (value == Integer.MAX_VALUE) {
             errorProfile.enter(this);
             throw new Error("Invalid input value");
         }
         return value;
     }
 }
 

Since:

23.0

See Also:

InlinedProfile

Method Summary

Modifier and Type	Method and Description
void	disable(Node node) Disables this profile by setting it to its generic state.
void	enter(Node node)
static InlinedBranchProfile	getUncached() Returns the uncached version of the profile.
static InlinedBranchProfile	inline(InlineSupport.InlineTarget target) Returns an inlined version of the profile.
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	wasEntered(Node node) Returns true if the InlinedBranchProfile.enter(Node) method was ever called, 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

enter

public void enter(Node node)

Since:

23.0

wasEntered

public boolean wasEntered(Node node)

Returns true if the InlinedBranchProfile.enter(Node) method was ever called, otherwise false. For profiles with profiling disabled or uncached profiles this method always returns true.

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

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

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 InlinedBranchProfile 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 InlinedBranchProfile getUncached()

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

Since:

23.0