TruffleCompilerRuntime

All Known Subinterfaces:

HotSpotTruffleCompilerRuntime

All Known Implementing Classes:

AbstractHotSpotTruffleRuntime, GraalTruffleRuntime
```
public interface TruffleCompilerRuntime
```
Defines an interface to the Truffle metadata required by a TruffleCompiler without exposing a Truffle compiler directly to Truffle AST classes. This allows a Truffle runtime and Truffle compiler to exists in separate heaps or even separate processes.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`TruffleCompilerRuntime.ConstantFieldInfo` Value returned by `TruffleCompilerRuntime.getConstantFieldInfo(ResolvedJavaField)` describing how a field read can be constant folded based on Truffle annotations.
`static class`	`TruffleCompilerRuntime.InlineKind`
`static class`	`TruffleCompilerRuntime.LoopExplosionKind` Controls behavior of `ExplodeLoop` annotation.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`CompilableTruffleAST`	`asCompilableTruffleAST(JavaConstant constant)` Gets the `CompilableTruffleAST` represented by `constant`.
`default String`	`formatEvent(int depth, String event, int eventWidth, String subject, int subjectWidth, Map<String,Object> properties, int propertyWidth)` Formats a message describing a Truffle event as a single line of text.
`JavaConstant`	`getCallTargetForCallNode(JavaConstant callNode)` Gets the compiler constant representing the target of `callNode`.
`TruffleCompilerRuntime.ConstantFieldInfo`	`getConstantFieldInfo(ResolvedJavaField field)` Gets an object describing how a read of `field` can be constant folded based on Truffle annotations.
`int`	`getFrameSlotKindTagForJavaKind(JavaKind kind)` Gets the `FrameSlotKind.tag` corresponding to a `JavaKind` value.
`int`	`getFrameSlotKindTagsCount()` Gets the number of valid `FrameSlotKind.tag` values.
`default <T> T`	`getGraalOptions(Class<T> type)` Gets the Graal option values for this runtime in an instance of `type`.
`TruffleCompilerRuntime.InlineKind`	`getInlineKind(ResolvedJavaMethod original, boolean duringPartialEvaluation)` Gets an object describing whether and how a method can be inlined based on Truffle directives.
`JavaKind`	`getJavaKindForFrameSlotKind(int frameSlotKindTag)` Gets the Java kind corresponding to a `FrameSlotKind.tag` value.
`TruffleCompilerRuntime.LoopExplosionKind`	`getLoopExplosionKind(ResolvedJavaMethod method)` Queries how loops in `method` with constant number of invocations should be unrolled.
`static TruffleCompilerRuntime`	`getRuntime()` Gets the singleton runtime instance.
`static TruffleCompilerRuntime`	`getRuntimeIfAvailable()` Gets the singleton runtime instance if it is available other returns `null`.
`TruffleCompiler`	`getTruffleCompiler(CompilableTruffleAST compilable)` Gets the primary `TruffleCompiler` instance associated with this runtime, creating and initializing it in a thread-safe manner first if necessary.
`boolean`	`isBytecodeInterpreterSwitch(ResolvedJavaMethod method)` Determines if `method` is annotated by `BytecodeInterpreterSwitch`.
`boolean`	`isBytecodeInterpreterSwitchBoundary(ResolvedJavaMethod method)` Determines if `method` is annotated by `BytecodeInterpreterSwitchBoundary`.
`boolean`	`isInInterpreter(ResolvedJavaMethod targetMethod)` Determines if `method` is the inInterpeter method from CompilerDirectives.
`boolean`	`isInlineable(ResolvedJavaMethod method)` Determines if `method` can be inlined by the runtime (independently from Truffle).
`boolean`	`isSpecializationMethod(ResolvedJavaMethod method)` Determines if `method` is annotated by `Specialization`.
`boolean`	`isSuppressedFailure(CompilableTruffleAST compilable, Supplier<String> serializedException)` Determines if the exception which happened during the compilation is suppressed and should be silent.
`boolean`	`isTransferToInterpreterMethod(ResolvedJavaMethod method)` Determines if `method` is a method is a transferToInterpreter method from CompilerDirectives.
`boolean`	`isTruffleBoundary(ResolvedJavaMethod method)` Determines if `method` is annotated by `TruffleBoundary`.
`boolean`	`isValueType(ResolvedJavaType type)` Determines if `type` is a value type.
`default void`	`log(CompilableTruffleAST compilable, String message)` Writes `message` followed by a new line to the Truffle logger.
`void`	`log(String loggerId, CompilableTruffleAST compilable, String message)`
`default void`	`logEvent(CompilableTruffleAST compilable, int depth, String event, Map<String,Object> properties)` Formats a Truffle event and writes it to the log output.
`default void`	`logEvent(CompilableTruffleAST compilable, int depth, String event, String subject, Map<String,Object> properties, String message)` Formats a Truffle event and writes it to the log output.
`Consumer<OptimizedAssumptionDependency>`	`registerOptimizedAssumptionDependency(JavaConstant optimizedAssumption)` Registers some dependent code on an assumption.
`default ResolvedJavaType`	`resolveType(MetaAccessProvider metaAccess, String className)` Looks up a type in this runtime.
`ResolvedJavaType`	`resolveType(MetaAccessProvider metaAccess, String className, boolean required)` Looks up a type in this runtime.

- Method Detail
  - getRuntimeIfAvailable
```
static TruffleCompilerRuntime getRuntimeIfAvailable()
```
    Gets the singleton runtime instance if it is available other returns null.
  - getRuntime
```
static TruffleCompilerRuntime getRuntime()
```
    Gets the singleton runtime instance.
    
    Throws:
    
    IllegalStateException - if the singleton instance has not been initialized
  - getConstantFieldInfo
```
TruffleCompilerRuntime.ConstantFieldInfo getConstantFieldInfo(ResolvedJavaField field)
```
    Gets an object describing how a read of field can be constant folded based on Truffle annotations.
    
    Returns:
    
    null if there are no constant folding related Truffle annotations on field
  - getLoopExplosionKind
```
TruffleCompilerRuntime.LoopExplosionKind getLoopExplosionKind(ResolvedJavaMethod method)
```
    Queries how loops in method with constant number of invocations should be unrolled.
  - getTruffleCompiler
```
TruffleCompiler getTruffleCompiler(CompilableTruffleAST compilable)
```
    Gets the primary TruffleCompiler instance associated with this runtime, creating and initializing it in a thread-safe manner first if necessary.
  - asCompilableTruffleAST
```
CompilableTruffleAST asCompilableTruffleAST(JavaConstant constant)
```
    Gets the CompilableTruffleAST represented by constant.
    
    Returns:
    
    null if constant does not represent a CompilableTruffleAST or it cannot be converted to a CompilableTruffleAST in the calling context
  - getCallTargetForCallNode
```
JavaConstant getCallTargetForCallNode(JavaConstant callNode)
```
    Gets the compiler constant representing the target of callNode.
  - registerOptimizedAssumptionDependency
```
Consumer<OptimizedAssumptionDependency> registerOptimizedAssumptionDependency(JavaConstant optimizedAssumption)
```
    Registers some dependent code on an assumption. As the dependent code may not yet be available, a Consumer is returned that must be notified when the code becomes available. If there is an error while compiling or installing the code, the returned consumer must be called with a null argument. If the assumption is already invalid, then null is returned in which case the caller (e.g., the compiler) must ensure the dependent code is never executed.
    
    Parameters:
    
    optimizedAssumption - compiler constant representing an OptimizedAssumption
  - logEvent
```
default void logEvent(CompilableTruffleAST compilable,
                      int depth,
                      String event,
                      Map<String,Object> properties)
```
    Formats a Truffle event and writes it to the log output.
    
    Parameters:
    
    compilable - the currently compiled AST used as a subject
    
    depth - nesting depth of the event
    
    event - a short description of the event being traced
    
    properties - name/value pairs describing properties relevant to the event
    
    Since:
    
    20.1.0
  - logEvent
```
default void logEvent(CompilableTruffleAST compilable,
                      int depth,
                      String event,
                      String subject,
                      Map<String,Object> properties,
                      String message)
```
    Formats a Truffle event and writes it to the log output.
    
    Parameters:
    
    compilable - the currently compiled AST
    
    depth - nesting depth of the event
    
    event - a short description of the event being traced
    
    subject - a description of the event's subject
    
    properties - name/value pairs describing properties relevant to the event
    
    message - optional additional message appended to the formatted event
    
    Since:
    
    20.1.0
  - log
```
default void log(CompilableTruffleAST compilable,
                 String message)
```
    Writes message followed by a new line to the Truffle logger.
    
    Parameters:
    
    compilable - the currently compiled AST
    
    message - message to log
  - log
```
void log(String loggerId,
         CompilableTruffleAST compilable,
         String message)
```
  - formatEvent
```
default String formatEvent(int depth,
                           String event,
                           int eventWidth,
                           String subject,
                           int subjectWidth,
                           Map<String,Object> properties,
                           int propertyWidth)
```
    Formats a message describing a Truffle event as a single line of text. A representative event trace line is shown below:
```
 opt queued       :anonymous                                   |ASTSize      20/   20 |Calls/Thres    7723/    3 |CallsAndLoop/Thres    7723/ 1000 |Inval#              0
 
```
    Parameters:
    
    depth - nesting depth of the event (subject column is indented @{code depth * 2})
    
    event - a short description of the event being traced (e.g., "opt done")
    
    eventWidth - the minimum width of the event column
    
    subject - a description of the event's subject (e.g., name of a Truffle AST)
    
    subjectWidth - the minimum width of the subject column
    
    properties - name/value pairs describing properties relevant to the event
    
    propertyWidth - the minimum width of the column for each property
  - resolveType
```
default ResolvedJavaType resolveType(MetaAccessProvider metaAccess,
                                     String className)
```
    Looks up a type in this runtime.
    
    Parameters:
    
    className - name of the type to lookup (same format as Class.forName(String)
    
    Returns:
    
    the resolved type
    
    Throws:
    
    NoClassDefFoundError - if resolution fails
  - resolveType
```
ResolvedJavaType resolveType(MetaAccessProvider metaAccess,
                             String className,
                             boolean required)
```
    Looks up a type in this runtime.
    
    Parameters:
    
    className - name of the type to lookup (same format as Class.forName(String)
    
    required - specifies if NoClassDefFoundError should be thrown or null should be returned if resolution fails
    
    Returns:
    
    the resolved type or null if resolution fails and required == false
    
    Throws:
    
    NoClassDefFoundError - if resolution fails and required == true
  - getGraalOptions
```
default <T> T getGraalOptions(Class<T> type)
```
    Gets the Graal option values for this runtime in an instance of type.
    
    Throws:
    
    IllegalArgumentException - if this runtime does not support type
  - getInlineKind
```
TruffleCompilerRuntime.InlineKind getInlineKind(ResolvedJavaMethod original,
                                                boolean duringPartialEvaluation)
```
    Gets an object describing whether and how a method can be inlined based on Truffle directives.
    
    Parameters:
    
    original - candidate for inlining
    
    duringPartialEvaluation - whether the inlining context is partial evaluation
  - isValueType
```
boolean isValueType(ResolvedJavaType type)
```
    Determines if type is a value type. Reference comparisons (==) between value type instances have undefined semantics and can either return true or false.
  - getJavaKindForFrameSlotKind
```
JavaKind getJavaKindForFrameSlotKind(int frameSlotKindTag)
```
    Gets the Java kind corresponding to a FrameSlotKind.tag value.
  - getFrameSlotKindTagForJavaKind
```
int getFrameSlotKindTagForJavaKind(JavaKind kind)
```
    Gets the FrameSlotKind.tag corresponding to a JavaKind value.
  - getFrameSlotKindTagsCount
```
int getFrameSlotKindTagsCount()
```
    Gets the number of valid FrameSlotKind.tag values. The valid values are contiguous from 0 up to but not including the return value.
  - isInlineable
```
boolean isInlineable(ResolvedJavaMethod method)
```
    Determines if method can be inlined by the runtime (independently from Truffle).
  - isTruffleBoundary
```
boolean isTruffleBoundary(ResolvedJavaMethod method)
```
    Determines if method is annotated by TruffleBoundary.
  - isSpecializationMethod
```
boolean isSpecializationMethod(ResolvedJavaMethod method)
```
    Determines if method is annotated by Specialization.
  - isBytecodeInterpreterSwitch
```
boolean isBytecodeInterpreterSwitch(ResolvedJavaMethod method)
```
    Determines if method is annotated by BytecodeInterpreterSwitch.
  - isBytecodeInterpreterSwitchBoundary
```
boolean isBytecodeInterpreterSwitchBoundary(ResolvedJavaMethod method)
```
    Determines if method is annotated by BytecodeInterpreterSwitchBoundary.
  - isSuppressedFailure
```
boolean isSuppressedFailure(CompilableTruffleAST compilable,
                            Supplier<String> serializedException)
```
    Determines if the exception which happened during the compilation is suppressed and should be silent.
  - isInInterpreter
```
boolean isInInterpreter(ResolvedJavaMethod targetMethod)
```
    Determines if method is the inInterpeter method from CompilerDirectives.
  - isTransferToInterpreterMethod
```
boolean isTransferToInterpreterMethod(ResolvedJavaMethod method)
```
    Determines if method is a method is a transferToInterpreter method from CompilerDirectives.

Interface TruffleCompilerRuntime

Nested Class Summary

Method Summary

Method Detail

getRuntimeIfAvailable

getRuntime

getConstantFieldInfo

getLoopExplosionKind

getTruffleCompiler

asCompilableTruffleAST

getCallTargetForCallNode

registerOptimizedAssumptionDependency

logEvent

logEvent

log

log

formatEvent

resolveType

resolveType

getGraalOptions

getInlineKind

isValueType

getJavaKindForFrameSlotKind

getFrameSlotKindTagForJavaKind

getFrameSlotKindTagsCount

isInlineable

isTruffleBoundary

isSpecializationMethod

isBytecodeInterpreterSwitch

isBytecodeInterpreterSwitchBoundary

isSuppressedFailure

isInInterpreter

isTransferToInterpreterMethod