ProfilingInfo (Graal OpenJDK Project Documentation)

All Known Implementing Classes:

DefaultProfilingInfo, HotSpotProfilingInfo
```
public interface ProfilingInfo
```
Provides access to the profiling information of one specific method. Every accessor method returns the information that is available at the time of invocation. If a method is invoked multiple times, it may return significantly different results for every invocation as the profiling information may be changed by other Java threads at any time.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`double`	`getBranchTakenProbability(int bci)` Returns an estimate of how often the branch at the given byte code was taken.
`int`	`getCodeSize()` Returns the length of the bytecodes associated with this profile.
`int`	`getCompilerIRSize(Class<?> irType)` Gets the size of the compiler intermediate representation (IR) associated with this method last recorded by `setCompilerIRSize(Class, int)`.
`int`	`getDeoptimizationCount(DeoptimizationReason reason)` Returns how frequently a method was deoptimized for the given deoptimization reason.
`TriState`	`getExceptionSeen(int bci)` Returns information if the given BCI did ever throw an exception.
`int`	`getExecutionCount(int bci)` Returns an estimate how often the current BCI was executed.
`JavaMethodProfile`	`getMethodProfile(int bci)` Returns the MethodProfile for the given BCI.
`TriState`	`getNullSeen(int bci)` Returns information if null was ever seen for the given BCI.
`double[]`	`getSwitchProbabilities(int bci)` Returns an estimate of how often the switch cases are taken at the given BCI.
`JavaTypeProfile`	`getTypeProfile(int bci)` Returns the TypeProfile for the given BCI.
`boolean`	`isMature()` Returns true if the profiling information can be assumed as sufficiently accurate.
`boolean`	`setCompilerIRSize(Class<?> irType, int irSize)` Records the size of the compiler intermediate representation (IR) associated with this method.
`void`	`setMature()` Force data to be treated as mature if possible.
`default String`	`toString(ResolvedJavaMethod method, String sep)` Formats this profiling information to a string.

- Method Detail
  - getCodeSize
```
int getCodeSize()
```
    Returns the length of the bytecodes associated with this profile.
  - getBranchTakenProbability
```
double getBranchTakenProbability(int bci)
```
    Returns an estimate of how often the branch at the given byte code was taken.
    
    Returns:
    
    The estimated probability, with 0.0 meaning never and 1.0 meaning always, or -1 if this information is not available.
  - getSwitchProbabilities
```
double[] getSwitchProbabilities(int bci)
```
    Returns an estimate of how often the switch cases are taken at the given BCI. The default case is stored as the last entry.
    
    Returns:
    
    A double value that contains the estimated probabilities, with 0.0 meaning never and 1.0 meaning always, or -1 if this information is not available.
  - getTypeProfile
```
JavaTypeProfile getTypeProfile(int bci)
```
    Returns the TypeProfile for the given BCI.
    
    Returns:
    
    Returns a JavaTypeProfile object, or null if not available.
  - getMethodProfile
```
JavaMethodProfile getMethodProfile(int bci)
```
    Returns the MethodProfile for the given BCI.
    
    Returns:
    
    Returns a JavaMethodProfile object, or null if not available.
  - getExceptionSeen
```
TriState getExceptionSeen(int bci)
```
    Returns information if the given BCI did ever throw an exception.
    
    Returns:
    
    TriState.TRUE if the instruction has thrown an exception at least once, TriState.FALSE if it never threw an exception, and TriState.UNKNOWN if this information was not recorded.
  - getNullSeen
```
TriState getNullSeen(int bci)
```
    Returns information if null was ever seen for the given BCI. This information is collected for the aastore, checkcast and instanceof bytecodes.
    
    Returns:
    
    TriState.TRUE if null was seen for the instruction, TriState.FALSE if null was NOT seen, and TriState.UNKNOWN if this information was not recorded.
  - getExecutionCount
```
int getExecutionCount(int bci)
```
    Returns an estimate how often the current BCI was executed. Avoid comparing execution counts to each other, as the returned value highly depends on the time of invocation.
    
    Returns:
    
    the estimated execution count or -1 if not available.
  - getDeoptimizationCount
```
int getDeoptimizationCount(DeoptimizationReason reason)
```
    Returns how frequently a method was deoptimized for the given deoptimization reason. This only indicates how often the method did fall back to the interpreter for the execution and does not indicate how often it was recompiled.
    
    Parameters:
    
    reason - the reason for which the number of deoptimizations should be queried
    
    Returns:
    
    the number of times the compiled method deoptimized for the given reason.
  - setCompilerIRSize
```
boolean setCompilerIRSize(Class<?> irType,
                          int irSize)
```
    Records the size of the compiler intermediate representation (IR) associated with this method.
    
    Parameters:
    
    irType - the IR type for which the size is being recorded
    
    irSize - the IR size to be recorded. The unit depends on the IR.
    
    Returns:
    
    whether recording this information for irType is supported
  - getCompilerIRSize
```
int getCompilerIRSize(Class<?> irType)
```
    Gets the size of the compiler intermediate representation (IR) associated with this method last recorded by setCompilerIRSize(Class, int).
    
    Parameters:
    
    irType - the IR type for which the size is being requested
    
    Returns:
    
    the requested IR size or -1 if it is unavailable for irType
  - isMature
```
boolean isMature()
```
    Returns true if the profiling information can be assumed as sufficiently accurate.
    
    Returns:
    
    true if the profiling information was recorded often enough mature enough, false otherwise.
  - setMature
```
void setMature()
```
    Force data to be treated as mature if possible.
  - toString
```
default String toString(ResolvedJavaMethod method,
                        String sep)
```
    Formats this profiling information to a string.
    
    Parameters:
    
    method - an optional method that augments the profile string returned
    
    sep - the separator to use for each separate profile record

Interface ProfilingInfo

Method Summary

Method Detail

getCodeSize

getBranchTakenProbability

getSwitchProbabilities

getTypeProfile

getMethodProfile

getExceptionSeen

getNullSeen

getExecutionCount

getDeoptimizationCount

setCompilerIRSize

getCompilerIRSize

isMature

setMature

toString