public final class PrimitiveValueProfile extends ValueProfile
Represents a ValueProfile
that speculates on the primitive equality or object identity of
values. Note that for float
and double
values we compare primitive equality via
Float.floatToRawIntBits(float)
and Double.doubleToRawLongBits(double)
, so that for example
-0.0
is not considered the same as 0.0
, even though primitive equality would
normally say that it was.
Specialized value profile to capture certain properties of Object
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 identities or classes are profiles within a single profile then the profile has no
effect and no overhead after compilation. There are specialized versions of this profile with
less interpreter footprint for boolean
, byte
,
int
, long
, float
and
double
values.
Usage example:
class SampleNode extends Node { final ValueProfile profile = ValueProfile.create{Identity,Class}Profile(); Object execute(Object input) { Object profiledValue = profile.profile(input); // compiler may know now more about profiledValue return profieldValue; } }
A profile is a Truffle utility class that uses the Truffle compiler
directives
to guard for and/or forward runtime information to the compiler. Whenever Truffle DSL
can be used inlined profiles
subclasses should be used instead of regular
profile
subclasses.
Usage: Profiles should be stored in final
or compilation final
fields of node classes to ensure that they can get optimized properly.
Profiles must not be shared between ASTs. Using the same profile multiple times in a single
node
or in multiple nodes
which link
to the
same root
is allowed. Never store profiles inside runtime values that
leave the scope of the originating AST. This limitation exists because the used mechanism to
invalidate compiled code performs local invalidations only. For global speculations use
assumptions
instead.
Compilation: Some profiles like branch
profiles do not induce
additional overhead in compiled code. Others like value
profiles might
require a runtime check to verify their assumptions which are forwarded to the compiler. Even if
profiles do not induce direct overhead in compiled code it still might get invalidated as a
result of using profiles. Invalidating profiles will result in the invalidation of compiled code.
It is therefore essential to place these profiles in way that is neither too aggressive nor too
conservative.
Footprint: Whether profiling information can be forwarded to the compiler depends on the
capabilities of the runtime system
. If the runtime returns
true
in TruffleRuntime.isProfilingEnabled()
then runtime information will
get collected. This comes at at the cost of additional overhead and footprint in interpreted
mode. Thats why the factory methods of profiles can return implementations where profiling is
disabled. Using disabled profiles makes sense for runtimes that are unable to use the collected
profiling information. Even runtime implementations that are able to use this information might
decide to turn off profiling for benchmarking purposes.
Profile subclasses:
BranchProfile
to profile on unlikely branches like errors.ConditionProfile
to profile on conditionals or boolean values.LoopConditionProfile
to profile on conditionals of loops with special support for
counted loops.ValueProfile
to profile on properties like type and identity of values.ByteValueProfile
to profile on byte
values.IntValueProfile
to profile on int
values.LongValueProfile
to profile on long
values.FloatValueProfile
to profile on float
values.DoubleValueProfile
to profile on double
values.PrimitiveValueProfile
to profile on objects by identity and on primitives by value.
Modifier and Type | Method and Description |
---|---|
static PrimitiveValueProfile |
create()
Returns a
PrimitiveValueProfile that speculates on the primitive equality or object
identity of a value. |
static PrimitiveValueProfile |
createEqualityProfile()
Returns a
PrimitiveValueProfile that speculates on the primitive equality or object
identity of a value. |
void |
disable()
Disables this profile by setting it to its generic state.
|
static PrimitiveValueProfile |
getUncached()
Returns the uncached version of the profile.
|
boolean |
profile(boolean value) |
byte |
profile(byte value) |
char |
profile(char value) |
double |
profile(double value) |
float |
profile(float value) |
int |
profile(int value) |
long |
profile(long value) |
short |
profile(short value) |
<T> T |
profile(T v) |
void |
reset()
Resets this profile to its uninitialized state.
|
String |
toString() |
createClassProfile, createIdentityProfile, inline
clone
public <T> T profile(T v)
profile
in class ValueProfile
public byte profile(byte value)
public short profile(short value)
public int profile(int value)
public long profile(long value)
public float profile(float value)
public double profile(double value)
public boolean profile(boolean value)
public char profile(char value)
public void disable()
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.
public void reset()
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.
public static PrimitiveValueProfile createEqualityProfile()
PrimitiveValueProfile
that speculates on the primitive equality or object
identity of a value.public static PrimitiveValueProfile create()
PrimitiveValueProfile
that speculates on the primitive equality or object
identity of a value.public static PrimitiveValueProfile getUncached()