org.graalvm.compiler.truffle.common

Interface TruffleDebugContext

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

TruffleDebugContextImpl

public interface TruffleDebugContext
extends AutoCloseable

Functionality related to generating output useful for debugging compilation of Truffle ASTs.

Method Summary

Modifier and Type	Method and Description
<G,N,M> GraphOutput<G,M>	buildOutput(GraphOutput.Builder<G,N,M> builder) Opens a channel for dumping the graph based structure represented by builder.
void	close() Closes this debug context.
void	closeDebugChannels() Closes any debugging output channels open in this scope.
Map<Object,Object>	getVersionProperties() Gets a map from components in the current runtime to the id of the source code control commit from which they were built.
boolean	isDumpEnabled() Determines if dumping is enabled in the current scope.
AutoCloseable	scope(String name) Opens a named scope.
AutoCloseable	scope(String name, Object context) Opens a named scope.

Method Detail

getVersionProperties

Map<Object,Object> getVersionProperties()

Gets a map from components in the current runtime to the id of the source code control commit from which they were built. A typical map when running on GraalVM is shown below:

 {version.substratevm=f5875dc5cd664df832f3ef6546fe3ab3610152a9,
  version.tools=f5875dc5cd664df832f3ef6546fe3ab3610152a9,
  version.truffle=f5875dc5cd664df832f3ef6546fe3ab3610152a9,
  version.compiler=f5875dc5cd664df832f3ef6546fe3ab3610152a9,
  version.sulong=d453fd9d5e17a5fd1739cc4c77f7995852ace14f,
  version.sdk=f5875dc5cd664df832f3ef6546fe3ab3610152a9,
  version.vm=f5875dc5cd664df832f3ef6546fe3ab3610152a9,
  version.graal-js=c32bfc97c8435f285055e289d193e3b06e6b40e5,
  version.regex=f5875dc5cd664df832f3ef6546fe3ab3610152a9,
  version.graal-nodejs=c32bfc97c8435f285055e289d193e3b06e6b40e5}
 

buildOutput

<G,N,M> GraphOutput<G,M> buildOutput(GraphOutput.Builder<G,N,M> builder)
                              throws IOException

Opens a channel for dumping the graph based structure represented by builder.

Throws:

IOException

isDumpEnabled

boolean isDumpEnabled()

Determines if dumping is enabled in the current scope.

scope

AutoCloseable scope(String name)

Opens a named scope. The implementation will typically rely on command line options based on scope names to decide in which scopes dumping is enabled.

scope

AutoCloseable scope(String name,
                    Object context)

Opens a named scope. The implementation will typically rely on command line options based on scope names to decide in which scopes dumping is enabled.

Parameters:

context - some context to be associated with the scope

close

void close()

Closes this debug context.

Specified by:

close in interface AutoCloseable

closeDebugChannels

void closeDebugChannels()

Closes any debugging output channels open in this scope. This is useful when debug output is structured and closing a channel sends output denoting the end of a nested data structure.