com.oracle.truffle.api.profiles

Class InlinedIntValueProfile

java.lang.Object

com.oracle.truffle.api.profiles.InlinedProfile

com.oracle.truffle.api.profiles.InlinedIntValueProfile

public final class InlinedIntValueProfile
extends InlinedProfile

Specialized value profile to capture certain properties of int runtime values. Value profiles require a runtime check in their initialized state to verify their profiled assumption. Value profiles are limited to capture monomorphic profiles only. This means that if two or more values are profiled within a single profile then the profile has no effect. If the value assumption is invalidated in compiled code then it is invalidated.

Usage example:

 abstract class IntProfileNode extends Node {

     abstract int execute(int input);

     @Specialization
     int doDefault(int input, @Cached InlinedIntValueProfile profile) {
         int profiledValue = profile.profile(this, input);
         // compiler may now see profiledValue as a partial evaluation constant
         return profiledValue;
     }
 }
 

Since:

23.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	GENERIC
protected static int	REQUIRED_STATE_BITS
protected static int	SPECIALIZED
protected InlineSupport.StateField	state
protected static int	UNINITIALIZED

Method Summary

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

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

Field Detail

UNINITIALIZED

protected static final int UNINITIALIZED

See Also:

Constant Field Values

SPECIALIZED

protected static final int SPECIALIZED

See Also:

Constant Field Values

GENERIC

protected static final int GENERIC

See Also:

Constant Field Values

REQUIRED_STATE_BITS

protected static final int REQUIRED_STATE_BITS

See Also:

Constant Field Values

state

protected final InlineSupport.StateField state

Method Detail

profile

public int profile(Node node,
                   int value)

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

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

Since:

23.0

disable

public final void disable(Node node)

Description copied from class: InlinedProfile

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

reset

public final void reset(Node node)

Description copied from class: InlinedProfile

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