org.graalvm.compiler.debug

Interface DebugDumpHandler

All Superinterfaces:

AutoCloseable, Closeable, DebugHandler

All Known Implementing Classes:

BciBlockMappingDumpHandler, CFGPrinterObserver, GraphPrinterDumpHandler

public interface DebugDumpHandler
extends Closeable, DebugHandler

Interface implemented by classes that provide an external visualization of selected object types such as compiler graphs and nodes. The format and client required to consume the visualizations is determined by the implementation. For example, a dumper may convert a compiler node to a human readable string and print it to the console. A more sophisticated dumper may serialize a compiler graph and send it over the network to a tool (e.g., https://github.com/graalvm/visualizer) that can display graphs.

Method Summary

Modifier and Type	Method and Description
default void	close() Flushes and releases resources managed by this dump handler.
void	dump(Object object, DebugContext debug, boolean forced, String format, Object... arguments) If the type of object is supported by this dumper, then a representation of object is sent to some consumer in a format determined by this object.

Method Detail

dump

void dump(Object object,
          DebugContext debug,
          boolean forced,
          String format,
          Object... arguments)

If the type of object is supported by this dumper, then a representation of object is sent to some consumer in a format determined by this object.

Parameters:

object - the object to be dumped

debug - the debug context requesting the dump

forced - true if called from DebugContext.forceDump(Object, String, Object...)

format - a format string specifying a title that describes the context of the dump (e.g., the compiler phase in which request is made)

arguments - arguments referenced by the format specifiers in format

close

default void close()

Flushes and releases resources managed by this dump handler. A subsequent call to DebugDumpHandler.dump(java.lang.Object, org.graalvm.compiler.debug.DebugContext, boolean, java.lang.String, java.lang.Object...) will create and open new resources. That is, this method can be used to reset the handler.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable