org.graalvm.compiler.truffle.compiler

Class TruffleDebugContextImpl

java.lang.Object

org.graalvm.compiler.truffle.compiler.TruffleDebugContextImpl

All Implemented Interfaces:

AutoCloseable, TruffleDebugContext

public class TruffleDebugContextImpl
extends Object
implements TruffleDebugContext

Implementation of TruffleDebugContext in terms of DebugContext.

Field Summary

Fields

Modifier and Type	Field and Description
DebugContext	debugContext

Constructor Summary

Constructors

Constructor and Description
TruffleDebugContextImpl(DebugContext debugContext)

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.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

debugContext

public final DebugContext debugContext

Constructor Detail

TruffleDebugContextImpl

public TruffleDebugContextImpl(DebugContext debugContext)

Method Detail

buildOutput

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

Description copied from interface: TruffleDebugContext

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

Specified by:

buildOutput in interface TruffleDebugContext

Throws:

IOException

isDumpEnabled

public boolean isDumpEnabled()

Description copied from interface: TruffleDebugContext

Determines if dumping is enabled in the current scope.

Specified by:

isDumpEnabled in interface TruffleDebugContext

getVersionProperties

public Map<Object,Object> getVersionProperties()

Description copied from interface: TruffleDebugContext

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}
 

Specified by:

getVersionProperties in interface TruffleDebugContext

scope

public AutoCloseable scope(String name)

Description copied from interface: TruffleDebugContext

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.

Specified by:

scope in interface TruffleDebugContext

scope

public AutoCloseable scope(String name,
                           Object context)

Description copied from interface: TruffleDebugContext

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.

Specified by:

scope in interface TruffleDebugContext

context - some context to be associated with the scope

close

public void close()

Description copied from interface: TruffleDebugContext

Closes this debug context.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface TruffleDebugContext

closeDebugChannels

public void closeDebugChannels()

Description copied from interface: TruffleDebugContext

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.

Specified by:

closeDebugChannels in interface TruffleDebugContext