DebugContext

java.lang.Object
- org.graalvm.compiler.debug.DebugContext

All Implemented Interfaces:

AutoCloseable
```
public final class DebugContext
extends Object
implements AutoCloseable
```
A facility for logging and dumping as well as a container for values associated with MetricKeys. A DebugContext object must only be used on the thread that created it. This means it needs to be passed around as a parameter. For convenience, it can be encapsulated in a widely used object that is in scope wherever a DebugContext is needed. However, care must be taken when such objects can be exposed to multiple threads (e.g., they are in a non-thread-local cache).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DebugContext.Activation` An object used to undo the changes made by DebugContext#activate().
`static class`	`DebugContext.Builder` Object used to create a `DebugContext`.
`static interface`	`DebugContext.CompilerPhaseScope` Scope for a compiler phase event.
`static class`	`DebugContext.Description` Describes the computation associated with a `DebugContext`.
`static interface`	`DebugContext.Scope` Represents a debug scope entered by `DebugContext.scope(Object)` or `DebugContext.sandbox(CharSequence, DebugConfig, Object...)`.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BASIC_LEVEL` Basic debug level.
`static int`	`DETAILED_LEVEL` Detailed debug level.
`static String`	`DUMP_FILE_MESSAGE_FORMAT` The format of the message printed on the console by `DebugContext.getDumpPath(java.lang.String, boolean)` when `DebugOptions.ShowDumpFiles` is true.
`static String`	`DUMP_FILE_MESSAGE_REGEXP` The regular expression for matching the message derived from `DebugContext.DUMP_FILE_MESSAGE_FORMAT`.
`static int`	`ENABLED_LEVEL` A special dump level that indicates the dumping machinery is enabled but no dumps will be produced except through other options.
`static int`	`INFO_LEVEL` Informational debug level.
`static Iterable<DebugHandlersFactory>`	`NO_CONFIG_CUSTOMIZERS`
`static DebugContext.Description`	`NO_DESCRIPTION`
`static GlobalMetrics`	`NO_GLOBAL_METRIC_VALUES`
`static int`	`VERBOSE_LEVEL` Verbose debug level.
`static int`	`VERY_DETAILED_LEVEL` Very detailed debug level.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DebugContext.Activation`	`activate()` Activates this object as the debug context for the current thread.
`long[]`	`addValuesTo(long[] tally)` Gets a tally of the metric values in this context and a given tally.
`static Map<Object,Object>`	`addVersionProperties(Map<Object,Object> properties)` Adds version properties to the provided map.
`static String`	`applyFormattingFlagsAndWidth(String s, int flags, int width)`
`boolean`	`areMetricsEnabled()`
`boolean`	`areScopesEnabled()` Determines if dynamic scopes are enabled.
`<G,N,M> GraphOutput<G,M>`	`buildOutput(GraphOutput.Builder<G,N,M> builder)` Gets an object for describing a graph and sending it to IGV.
`void`	`close()`
`void`	`closeDumpHandlers(boolean ignoreErrors)`
`Iterable<Object>`	`context()`
`<T> T`	`contextLookup(Class<T> clazz)` Searches the current debug scope, bottom up, for a context object that is an instance of a given type.
`<T> T`	`contextLookupTopdown(Class<T> clazz)` Searches the current debug scope, top down, for a context object that is an instance of a given type.
`<T> List<T>`	`contextSnapshot(Class<T> clazz)`
`static Object`	`convertFormatArg(Object arg)`
`static org.graalvm.collections.EconomicMap<MetricKey,Long>`	`convertValuesToKeyValueMap(long[] values)` Creates and returns a sorted map from metric names to their values in `values`.
`static CounterKey`	`counter(CharSequence name)` Creates a counter.
`static CounterKey`	`counter(String format, Object arg)` Creates a debug counter.
`static CounterKey`	`counter(String format, Object arg1, Object arg2)` Creates a debug counter.
`DebugContext.Scope`	`disable()` Disables all metrics and scope related functionality until `close()` is called on the returned object.
`static DebugContext`	`disabled(OptionValues options)` Create a DebugContext with debugging disabled.
`DebugCloseable`	`disableIntercept()` Opens a scope in which exception interception is disabled.
`void`	`dump(int dumpLevel, Object object, String msg)`
`void`	`dump(int dumpLevel, Object object, String format, Object arg)`
`void`	`dump(int dumpLevel, Object object, String format, Object arg1, Object arg2)`
`void`	`dump(int dumpLevel, Object object, String format, Object arg1, Object arg2, Object arg3)`
`void`	`dump(int dumpLevel, Object object, String format, Object arg1, Object arg2, Object arg3, Object arg4)`
`void`	`dump(int dumpLevel, Object object, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5)`
`void`	`dump(int dumpLevel, Object object, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6)`
`void`	`dump(int dumpLevel, Object object, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6, Object arg7)`
`DebugContext.CompilerPhaseScope`	`enterCompilerPhase(CharSequence phaseName)` Notifies this object that the compiler is entering a phase.
`DebugContext.CompilerPhaseScope`	`enterCompilerPhase(Supplier<CharSequence> phaseName)` Notifies this object that the compiler is entering a phase.
`void`	`forceDump(Object object, String format, Object... args)` Forces an unconditional dump.
`DebugContext.Scope`	`forceLog()`
`static DebugContext`	`forCurrentThread()` Gets the debug context for the current thread.
`DebugConfig`	`getConfig()`
`String`	`getCurrentScopeName()` Gets a string composed of the names in the current nesting of debug scopes separated by `'.'`.
`static PrintStream`	`getDefaultLogStream()`
`DebugContext.Description`	`getDescription()` Gets a description of the computation associated with this debug context.
`String`	`getDumpPath(String extension, boolean createMissingDirectory)`
`GlobalMetrics`	`getGlobalMetrics()` Gets the global metrics associated with this debug context.
`Map<MetricKey,Long>`	`getMetricsSnapshot()`
`OptionValues`	`getOptions()` Gets the options this debug context was constructed with.
`RuntimeException`	`handle(Throwable exception)` Handles an exception in the context of the debug scope just exited.
`boolean`	`hasCompilationListener()` Determines if `DebugContext.enterCompilerPhase(java.lang.CharSequence)` and `DebugContext.notifyInlining(ResolvedJavaMethod, ResolvedJavaMethod, boolean, java.lang.CharSequence, int)` do anything.
`Indent`	`indent()` Opens a new indentation level (by adding some spaces) based on the current indentation level.
`boolean`	`inNestedScope()` Determines if scopes are enabled and this context is in a non-top-level scope.
`boolean`	`isCountEnabled()`
`boolean`	`isDumpEnabled(int dumpLevel)`
`boolean`	`isDumpEnabledForMethod()`
`boolean`	`isLogEnabled()`
`boolean`	`isLogEnabled(int logLevel)`
`boolean`	`isLogEnabledForMethod()`
`boolean`	`isMemUseTrackingEnabled()`
`boolean`	`isTimeEnabled()`
`boolean`	`isVerifyEnabled()` Determines if verification is enabled in the current scope.
`boolean`	`isVerifyEnabledForMethod()` Determines if verification is enabled for any `JavaMethod` in the current scope.
`void`	`log(int logLevel, String msg)` Prints a message to the current debug scope's logging stream if logging is enabled.
`void`	`log(int logLevel, String format, int arg)` Prints a message to the current debug scope's logging stream if logging is enabled.
`void`	`log(int logLevel, String format, int arg1, int arg2)`
`void`	`log(int logLevel, String format, int arg1, int arg2, int arg3)`
`void`	`log(int logLevel, String format, int arg1, Object arg2)`
`void`	`log(int logLevel, String format, Object arg)` Prints a message to the current debug scope's logging stream if logging is enabled.
`void`	`log(int logLevel, String format, Object arg1, int arg2)`
`void`	`log(int logLevel, String format, Object arg1, Object arg2)`
`void`	`log(int logLevel, String format, Object arg1, Object arg2, Object arg3)`
`void`	`log(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4)`
`void`	`log(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5)`
`void`	`log(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6)`
`void`	`log(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6, Object arg7)`
`void`	`log(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6, Object arg7, Object arg8)`
`void`	`log(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6, Object arg7, Object arg8, Object arg9)`
`void`	`log(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6, Object arg7, Object arg8, Object arg9, Object arg10)`
`void`	`log(String msg)`
`void`	`log(String format, int arg)`
`void`	`log(String format, int arg1, int arg2)`
`void`	`log(String format, int arg1, int arg2, int arg3)`
`void`	`log(String format, int arg1, Object arg2)`
`void`	`log(String format, Object arg)`
`void`	`log(String format, Object arg1, int arg2)`
`void`	`log(String format, Object arg1, Object arg2)`
`void`	`log(String format, Object arg1, Object arg2, Object arg3)`
`void`	`log(String format, Object arg1, Object arg2, Object arg3, Object arg4)`
`void`	`log(String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5)`
`void`	`log(String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6)`
`void`	`log(String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6, Object arg7)`
`void`	`log(String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6, Object arg7, Object arg8)`
`void`	`log(String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6, Object arg7, Object arg8, Object arg9)`
`void`	`log(String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6, Object arg7, Object arg8, Object arg9, Object arg10)`
`Indent`	`logAndIndent(int logLevel, String msg)` A convenience function which combines `DebugContext.log(String)` and `DebugContext.indent()`.
`Indent`	`logAndIndent(int logLevel, String format, int arg)` A convenience function which combines `DebugContext.log(String, Object)` and `DebugContext.indent()`.
`Indent`	`logAndIndent(int logLevel, String format, int arg1, int arg2)`
`Indent`	`logAndIndent(int logLevel, String format, int arg1, int arg2, int arg3)`
`Indent`	`logAndIndent(int logLevel, String format, int arg1, Object arg2)`
`Indent`	`logAndIndent(int logLevel, String format, Object arg)` A convenience function which combines `DebugContext.log(String, Object)` and `DebugContext.indent()`.
`Indent`	`logAndIndent(int logLevel, String format, Object arg1, int arg2)`
`Indent`	`logAndIndent(int logLevel, String format, Object arg1, int arg2, int arg3)`
`Indent`	`logAndIndent(int logLevel, String format, Object arg1, Object arg2)`
`Indent`	`logAndIndent(int logLevel, String format, Object arg1, Object arg2, Object arg3)`
`Indent`	`logAndIndent(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4)`
`Indent`	`logAndIndent(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5)`
`Indent`	`logAndIndent(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6)`
`Indent`	`logAndIndent(String msg)`
`Indent`	`logAndIndent(String format, int arg)`
`Indent`	`logAndIndent(String format, int arg1, int arg2)`
`Indent`	`logAndIndent(String format, int arg1, int arg2, int arg3)`
`Indent`	`logAndIndent(String format, int arg1, Object arg2)`
`Indent`	`logAndIndent(String format, Object arg)`
`Indent`	`logAndIndent(String format, Object arg1, int arg2)`
`Indent`	`logAndIndent(String format, Object arg1, int arg2, int arg3)`
`Indent`	`logAndIndent(String format, Object arg1, Object arg2)`
`Indent`	`logAndIndent(String format, Object arg1, Object arg2, Object arg3)`
`Indent`	`logAndIndent(String format, Object arg1, Object arg2, Object arg3, Object arg4)`
`Indent`	`logAndIndent(String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5)`
`Indent`	`logAndIndent(String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6)`
`void`	`logv(int logLevel, String format, Object... args)` Prints a message to the current debug scope's logging stream.
`void`	`logv(String format, Object... args)`
`Indent`	`logvAndIndent(int logLevel, String format, Object... args)` A convenience function which combines `DebugContext.logv(int, String, Object...)` and `DebugContext.indent()`.
`static MemUseTrackerKey`	`memUseTracker(CharSequence name)` Creates a memory use tracker.
`static MemUseTrackerKey`	`memUseTracker(String format, Object arg)` Creates a debug memory use tracker.
`static MemUseTrackerKey`	`memUseTracker(String format, Object arg1, Object arg2)` Creates a debug memory use tracker.
`void`	`notifyInlining(ResolvedJavaMethod caller, ResolvedJavaMethod callee, boolean succeeded, CharSequence message, int bci)` Notifies this object when the compiler considers inlining `callee` into `caller`.
`void`	`printMetrics(DebugContext.Description desc)` Prints metric values in this object to the file (if any) specified by `DebugOptions.MetricsFile`.
`DebugContext.Scope`	`sandbox(CharSequence name, DebugConfig config, Object... context)` Creates and enters a new debug scope which will be disjoint from the current debug scope.
`DebugContext.Scope`	`scope(Object name)` Similar to `DebugContext.scope(Object, Object[])` but without context objects.
`DebugContext.Scope`	`scope(Object name, Object context)`
`DebugContext.Scope`	`scope(Object name, Object[] contextObjects)` Creates and enters a new debug scope which will be a child of the current debug scope.
`DebugContext.Scope`	`scope(Object name, Object context1, Object context2)`
`DebugContext.Scope`	`scope(Object name, Object context1, Object context2, Object context3)`
`static TimerKey`	`timer(CharSequence name)` Creates a timer.
`static TimerKey`	`timer(String format, Object arg)` Creates a debug timer.
`static TimerKey`	`timer(String format, Object arg1, Object arg2)` Creates a debug timer.
`void`	`verify(Object object, String message)` Calls all `DebugVerifyHandler`s in the current config to perform verification on a given object.
`void`	`verify(Object object, String format, Object arg)` Calls all `DebugVerifyHandler`s in the current config to perform verification on a given object.
`DebugContext.Scope`	`withContext(Object context)` Create an unnamed scope that appends some context to the current scope.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- DUMP_FILE_MESSAGE_FORMAT
```
public static final String DUMP_FILE_MESSAGE_FORMAT
```
  The format of the message printed on the console by DebugContext.getDumpPath(java.lang.String, boolean) when DebugOptions.ShowDumpFiles is true. The %s placeholder is replaced with the absolute path of the dump file (i.e. the value returned by the method).
  
  See Also:
  
  Constant Field Values
- DUMP_FILE_MESSAGE_REGEXP
```
public static final String DUMP_FILE_MESSAGE_REGEXP
```
  The regular expression for matching the message derived from DebugContext.DUMP_FILE_MESSAGE_FORMAT. Keep in sync with the catch_files array in common.json.
  
  See Also:
  
  Constant Field Values
- NO_DESCRIPTION
```
public static final DebugContext.Description NO_DESCRIPTION
```
- NO_GLOBAL_METRIC_VALUES
```
public static final GlobalMetrics NO_GLOBAL_METRIC_VALUES
```
- NO_CONFIG_CUSTOMIZERS
```
public static final Iterable<DebugHandlersFactory> NO_CONFIG_CUSTOMIZERS
```
- ENABLED_LEVEL
```
public static final int ENABLED_LEVEL
```
  A special dump level that indicates the dumping machinery is enabled but no dumps will be produced except through other options.
  
  See Also:
  
  Constant Field Values
- BASIC_LEVEL
```
public static final int BASIC_LEVEL
```
  Basic debug level. For HIR dumping, only ~5 graphs per method: after parsing, after inlining, after high tier, after mid tier, after low tier. LIR dumping: After LIR generation, after each pre-allocation, allocation and post allocation stage, and after code installation.
  
  See Also:
  
  Constant Field Values
- INFO_LEVEL
```
public static final int INFO_LEVEL
```
  Informational debug level. HIR dumping: One graph after each applied top-level phase. LIR dumping: After each applied phase.
  
  See Also:
  
  Constant Field Values
- VERBOSE_LEVEL
```
public static final int VERBOSE_LEVEL
```
  Verbose debug level. HIR dumping: One graph after each phase (including sub phases). LIR dumping: After each phase including sub phases.
  
  See Also:
  
  Constant Field Values
- DETAILED_LEVEL
```
public static final int DETAILED_LEVEL
```
  Detailed debug level. HIR dumping: Graphs within phases where interesting for a phase, max ~5 per phase. LIR dumping: Dump CFG within phases where interesting.
  
  See Also:
  
  Constant Field Values
- VERY_DETAILED_LEVEL
```
public static final int VERY_DETAILED_LEVEL
```
  Very detailed debug level. HIR dumping: Graphs per node granularity graph change (before/after change). LIR dumping: Intermediate CFGs of phases where interesting.
  
  See Also:
  
  Constant Field Values

Method Detail

getDefaultLogStream

public static PrintStream getDefaultLogStream()

areScopesEnabled
```
public boolean areScopesEnabled()
```
Determines if dynamic scopes are enabled.

buildOutput

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

Gets an object for describing a graph and sending it to IGV.

Throws:: IOException

addVersionProperties
```
public static Map<Object,Object> addVersionProperties(Map<Object,Object> properties)
```
Adds version properties to the provided map. The version properties are read at a start of the JVM from a JVM specific location. Each property identifiers a commit of a certain component in the system. The properties added to the properties map are prefixed with "version." prefix.

Parameters:

properties - map to add the version properties to or null

Returns:

properties with version properties added or an unmodifiable map containing the version properties if properties == null

getOptions
```
public OptionValues getOptions()
```
Gets the options this debug context was constructed with.

activate
```
public DebugContext.Activation activate()
```
Activates this object as the debug context for the current thread. This method should be used in a try-with-resources statement.

Returns:

an object that will deactivate the debug context for the current thread when DebugContext.Activation.close() is called on it

disabled

public static DebugContext disabled(OptionValues options)

Create a DebugContext with debugging disabled.

forCurrentThread
```
public static DebugContext forCurrentThread()
```
Gets the debug context for the current thread. This should only be used when there is no other reasonable means to get a hold of a debug context.

getDescription
```
public DebugContext.Description getDescription()
```
Gets a description of the computation associated with this debug context.

Returns:

null if no description is available

hasCompilationListener
```
public boolean hasCompilationListener()
```
Determines if DebugContext.enterCompilerPhase(java.lang.CharSequence) and DebugContext.notifyInlining(ResolvedJavaMethod, ResolvedJavaMethod, boolean, java.lang.CharSequence, int) do anything.

Returns:

true if there is a listener for compiler phase and inlining events attached to this object, false otherwise

enterCompilerPhase
```
public DebugContext.CompilerPhaseScope enterCompilerPhase(CharSequence phaseName)
```
Notifies this object that the compiler is entering a phase. It is recommended to use this method in a try-with-resource statement.

Parameters:

phaseName - name of the phase being entered

Returns:

null if DebugContext.hasCompilationListener() returns false otherwise an object whose DebugContext.CompilerPhaseScope.close() method must be called when the phase ends

enterCompilerPhase
```
public DebugContext.CompilerPhaseScope enterCompilerPhase(Supplier<CharSequence> phaseName)
```
Notifies this object that the compiler is entering a phase. It is recommended to use this method in a try-with-resource statement.

Parameters:

phaseName - name of the phase being entered

Returns:

null if DebugContext.hasCompilationListener() returns false otherwise an object whose DebugContext.CompilerPhaseScope.close() method must be called when the phase ends

notifyInlining
```
public void notifyInlining(ResolvedJavaMethod caller,
                           ResolvedJavaMethod callee,
                           boolean succeeded,
                           CharSequence message,
                           int bci)
```
Notifies this object when the compiler considers inlining callee into caller. A call to this method should be guarded with DebugContext.hasCompilationListener() if message is not a string literal or pre-computed value

Parameters:

caller - caller method

callee - callee method considered for inlining into caller

succeeded - true if callee was inlined into caller

message - extra information about inlining decision

bci - byte code index of call site

getGlobalMetrics
```
public GlobalMetrics getGlobalMetrics()
```
Gets the global metrics associated with this debug context.

Returns:

null if no global metrics are available

getDumpPath

public String getDumpPath(String extension,
                          boolean createMissingDirectory)

isDumpEnabled

public boolean isDumpEnabled(int dumpLevel)

isVerifyEnabledForMethod
```
public boolean isVerifyEnabledForMethod()
```
Determines if verification is enabled for any JavaMethod in the current scope.

See Also:

DebugContext.verify(Object, String)

isVerifyEnabled
```
public boolean isVerifyEnabled()
```
Determines if verification is enabled in the current scope.

See Also:

DebugContext.verify(Object, String)

isCountEnabled
```
public boolean isCountEnabled()
```

isTimeEnabled
```
public boolean isTimeEnabled()
```

isMemUseTrackingEnabled

public boolean isMemUseTrackingEnabled()

isDumpEnabledForMethod

public boolean isDumpEnabledForMethod()

isLogEnabledForMethod

public boolean isLogEnabledForMethod()

isLogEnabled
```
public boolean isLogEnabled()
```

isLogEnabled

public boolean isLogEnabled(int logLevel)

getCurrentScopeName
```
public String getCurrentScopeName()
```
Gets a string composed of the names in the current nesting of debug scopes separated by '.'.

scope
```
public DebugContext.Scope scope(Object name,
                                Object[] contextObjects)
                         throws Throwable
```
Creates and enters a new debug scope which will be a child of the current debug scope.
It is recommended to use the try-with-resource statement for managing entering and leaving debug scopes. For example:
```
 try (Scope s = Debug.scope("InliningGraph", inlineeGraph)) {
     ...
 } catch (Throwable e) {
     throw Debug.handle(e);
 }
 
```
The name argument is subject to the following type based conversion before having Object.toString() called on it:
```
     Type          | Conversion
 ------------------+-----------------
  java.lang.Class  | arg.getSimpleName()
                   |
 
```
Parameters:

name - the name of the new scope

contextObjects - an array of object to be appended to the current debug context

Returns:

the scope entered by this method which will be exited when its DebugContext.Scope.close() method is called

Throws:

Throwable - used to enforce a catch block.

scope
```
public DebugContext.Scope scope(Object name)
```
Similar to DebugContext.scope(Object, Object[]) but without context objects. Therefore the catch block can be omitted.

See Also:

DebugContext.scope(Object, Object[])

scope

public DebugContext.Scope scope(Object name,
                                Object context)
                         throws Throwable

Parameters:: context - an object to be appended to the current debug context
Throws:: Throwable
See Also:: DebugContext.scope(Object, Object[])

scope

public DebugContext.Scope scope(Object name,
                                Object context1,
                                Object context2)
                         throws Throwable

Parameters:: context1 - first object to be appended to the current debug context; context2 - second object to be appended to the current debug context
Throws:: Throwable
See Also:: DebugContext.scope(Object, Object[])

scope

public DebugContext.Scope scope(Object name,
                                Object context1,
                                Object context2,
                                Object context3)
                         throws Throwable

Parameters:: context1 - first object to be appended to the current debug context; context2 - second object to be appended to the current debug context; context3 - third object to be appended to the current debug context
Throws:: Throwable
See Also:: DebugContext.scope(Object, Object[])

withContext
```
public DebugContext.Scope withContext(Object context)
                               throws Throwable
```
Create an unnamed scope that appends some context to the current scope.

Parameters:

context - an object to be appended to the current debug context

Throws:

Throwable

sandbox
```
public DebugContext.Scope sandbox(CharSequence name,
                                  DebugConfig config,
                                  Object... context)
                           throws Throwable
```
Creates and enters a new debug scope which will be disjoint from the current debug scope.
It is recommended to use the try-with-resource statement for managing entering and leaving debug scopes. For example:
```
 try (Scope s = Debug.sandbox("CompilingStub", null, stubGraph)) {
     ...
 } catch (Throwable e) {
     throw Debug.handle(e);
 }
 
```
Parameters:

name - the name of the new scope

config - the debug configuration to use for the new scope or null to disable the scoping mechanism within the sandbox scope

context - objects to be appended to the current debug context

Returns:

the scope entered by this method which will be exited when its DebugContext.Scope.close() method is called

Throws:

Throwable

inNestedScope
```
public boolean inNestedScope()
```
Determines if scopes are enabled and this context is in a non-top-level scope.

disable
```
public DebugContext.Scope disable()
```
Disables all metrics and scope related functionality until close() is called on the returned object.

forceLog

public DebugContext.Scope forceLog()
                            throws Throwable

Throws:: Throwable

disableIntercept
```
public DebugCloseable disableIntercept()
```
Opens a scope in which exception interception is disabled. The current state of interception is restored when DebugCloseable.close() is called on the returned object. This is particularly useful to suppress extraneous output in JUnit tests that are expected to throw an exception.

handle
```
public RuntimeException handle(Throwable exception)
```
Handles an exception in the context of the debug scope just exited. The just exited scope must have the current scope as its parent which will be the case if the try-with-resource pattern recommended by DebugContext.scope(Object) and DebugContext.sandbox(CharSequence, DebugConfig, Object...) is used

See Also:

DebugContext.scope(Object, Object[]), DebugContext.sandbox(CharSequence, DebugConfig, Object...)

log
```
public void log(String msg)
```

log
```
public void log(int logLevel,
                String msg)
```
Prints a message to the current debug scope's logging stream if logging is enabled.

Parameters:

msg - the message to log

log

public void log(String format,
                Object arg)

log
```
public void log(int logLevel,
                String format,
                Object arg)
```
Prints a message to the current debug scope's logging stream if logging is enabled.

Parameters:

format - a format string

arg - the argument referenced by the format specifiers in format

log

public void log(String format,
                int arg)

log
```
public void log(int logLevel,
                String format,
                int arg)
```
Prints a message to the current debug scope's logging stream if logging is enabled.

Parameters:

format - a format string

arg - the argument referenced by the format specifiers in format

log

public void log(String format,
                Object arg1,
                Object arg2)

log

public void log(int logLevel,
                String format,
                Object arg1,
                Object arg2)

See Also:: DebugContext.log(int, String, Object)

log

public void log(String format,
                int arg1,
                Object arg2)

log

public void log(int logLevel,
                String format,
                int arg1,
                Object arg2)

See Also:: DebugContext.log(int, String, Object)

log

public void log(String format,
                Object arg1,
                int arg2)

log

public void log(int logLevel,
                String format,
                Object arg1,
                int arg2)

See Also:: DebugContext.log(int, String, Object)

log

public void log(String format,
                int arg1,
                int arg2)

log

public void log(int logLevel,
                String format,
                int arg1,
                int arg2)

See Also:: DebugContext.log(int, String, Object)

log

public void log(String format,
                Object arg1,
                Object arg2,
                Object arg3)

log

public void log(int logLevel,
                String format,
                Object arg1,
                Object arg2,
                Object arg3)

See Also:: DebugContext.log(int, String, Object)

log

public void log(String format,
                int arg1,
                int arg2,
                int arg3)

log

public void log(int logLevel,
                String format,
                int arg1,
                int arg2,
                int arg3)

See Also:: DebugContext.log(int, String, Object)

log

public void log(String format,
                Object arg1,
                Object arg2,
                Object arg3,
                Object arg4)

log

public void log(int logLevel,
                String format,
                Object arg1,
                Object arg2,
                Object arg3,
                Object arg4)

See Also:: DebugContext.log(int, String, Object)

log

public void log(String format,
                Object arg1,
                Object arg2,
                Object arg3,
                Object arg4,
                Object arg5)

log

public void log(int logLevel,
                String format,
                Object arg1,
                Object arg2,
                Object arg3,
                Object arg4,
                Object arg5)

See Also:: DebugContext.log(int, String, Object)

log

public void log(String format,
                Object arg1,
                Object arg2,
                Object arg3,
                Object arg4,
                Object arg5,
                Object arg6)

log

public void log(int logLevel,
                String format,
                Object arg1,
                Object arg2,
                Object arg3,
                Object arg4,
                Object arg5,
                Object arg6)

See Also:: DebugContext.log(int, String, Object)

log

public void log(String format,
                Object arg1,
                Object arg2,
                Object arg3,
                Object arg4,
                Object arg5,
                Object arg6,
                Object arg7)

log

public void log(String format,
                Object arg1,
                Object arg2,
                Object arg3,
                Object arg4,
                Object arg5,
                Object arg6,
                Object arg7,
                Object arg8)

log

public void log(int logLevel,
                String format,
                Object arg1,
                Object arg2,
                Object arg3,
                Object arg4,
                Object arg5,
                Object arg6,
                Object arg7)

See Also:: DebugContext.log(int, String, Object)

log

public void log(int logLevel,
                String format,
                Object arg1,
                Object arg2,
                Object arg3,
                Object arg4,
                Object arg5,
                Object arg6,
                Object arg7,
                Object arg8)

log

public void log(String format,
                Object arg1,
                Object arg2,
                Object arg3,
                Object arg4,
                Object arg5,
                Object arg6,
                Object arg7,
                Object arg8,
                Object arg9)

log

public void log(int logLevel,
                String format,
                Object arg1,
                Object arg2,
                Object arg3,
                Object arg4,
                Object arg5,
                Object arg6,
                Object arg7,
                Object arg8,
                Object arg9)

log

public void log(String format,
                Object arg1,
                Object arg2,
                Object arg3,
                Object arg4,
                Object arg5,
                Object arg6,
                Object arg7,
                Object arg8,
                Object arg9,
                Object arg10)

log

public void log(int logLevel,
                String format,
                Object arg1,
                Object arg2,
                Object arg3,
                Object arg4,
                Object arg5,
                Object arg6,
                Object arg7,
                Object arg8,
                Object arg9,
                Object arg10)

logv

public void logv(String format,
                 Object... args)

logv
```
public void logv(int logLevel,
                 String format,
                 Object... args)
```
Prints a message to the current debug scope's logging stream. This method must only be called if debugging scopes are enabled as it incurs allocation at the call site. If possible, call one of the other log() methods in this class that take a fixed number of parameters.

Parameters:

format - a format string

args - the arguments referenced by the format specifiers in format

forceDump
```
public void forceDump(Object object,
                      String format,
                      Object... args)
```
Forces an unconditional dump. This method exists mainly for debugging. It can also be used to force a graph dump from IDEs that support invoking a Java method while at a breakpoint.

dump

public void dump(int dumpLevel,
                 Object object,
                 String msg)

dump

public void dump(int dumpLevel,
                 Object object,
                 String format,
                 Object arg)

dump

public void dump(int dumpLevel,
                 Object object,
                 String format,
                 Object arg1,
                 Object arg2)

dump

public void dump(int dumpLevel,
                 Object object,
                 String format,
                 Object arg1,
                 Object arg2,
                 Object arg3)

dump

public void dump(int dumpLevel,
                 Object object,
                 String format,
                 Object arg1,
                 Object arg2,
                 Object arg3,
                 Object arg4)

dump

public void dump(int dumpLevel,
                 Object object,
                 String format,
                 Object arg1,
                 Object arg2,
                 Object arg3,
                 Object arg4,
                 Object arg5)

dump

public void dump(int dumpLevel,
                 Object object,
                 String format,
                 Object arg1,
                 Object arg2,
                 Object arg3,
                 Object arg4,
                 Object arg5,
                 Object arg6)

dump

public void dump(int dumpLevel,
                 Object object,
                 String format,
                 Object arg1,
                 Object arg2,
                 Object arg3,
                 Object arg4,
                 Object arg5,
                 Object arg6,
                 Object arg7)

verify
```
public void verify(Object object,
                   String message)
```
Calls all DebugVerifyHandlers in the current config to perform verification on a given object.

Parameters:

object - object to verify

message - description of verification context

See Also:

DebugVerifyHandler.verify(org.graalvm.compiler.debug.DebugContext, java.lang.Object, java.lang.String, java.lang.Object...)

verify
```
public void verify(Object object,
                   String format,
                   Object arg)
```
Calls all DebugVerifyHandlers in the current config to perform verification on a given object.

Parameters:

object - object to verify

format - a format string for the description of the verification context

arg - the argument referenced by the format specifiers in format

See Also:

DebugVerifyHandler.verify(org.graalvm.compiler.debug.DebugContext, java.lang.Object, java.lang.String, java.lang.Object...)

indent
```
public Indent indent()
```
Opens a new indentation level (by adding some spaces) based on the current indentation level. This should be used in a try-with-resources pattern.

Returns:

an object that reverts to the current indentation level when closed or null if debugging is disabled

See Also:

DebugContext.logAndIndent(int, String), DebugContext.logAndIndent(int, String, Object)

logAndIndent

public Indent logAndIndent(String msg)

logAndIndent
```
public Indent logAndIndent(int logLevel,
                           String msg)
```
A convenience function which combines DebugContext.log(String) and DebugContext.indent().

Parameters:

msg - the message to log

Returns:

an object that reverts to the current indentation level when closed or null if debugging is disabled

logAndIndent

public Indent logAndIndent(String format,
                           Object arg)

logAndIndent
```
public Indent logAndIndent(int logLevel,
                           String format,
                           Object arg)
```
A convenience function which combines DebugContext.log(String, Object) and DebugContext.indent().

Parameters:

format - a format string

arg - the argument referenced by the format specifiers in format

Returns:

an object that reverts to the current indentation level when closed or null if debugging is disabled

logAndIndent

public Indent logAndIndent(String format,
                           int arg)

logAndIndent
```
public Indent logAndIndent(int logLevel,
                           String format,
                           int arg)
```
A convenience function which combines DebugContext.log(String, Object) and DebugContext.indent().

Parameters:

format - a format string

arg - the argument referenced by the format specifiers in format

Returns:

an object that reverts to the current indentation level when closed or null if debugging is disabled

logAndIndent

public Indent logAndIndent(String format,
                           int arg1,
                           Object arg2)

logAndIndent

public Indent logAndIndent(int logLevel,
                           String format,
                           int arg1,
                           Object arg2)

See Also:: DebugContext.logAndIndent(int, String, Object)

logAndIndent

public Indent logAndIndent(String format,
                           Object arg1,
                           int arg2)

logAndIndent

public Indent logAndIndent(int logLevel,
                           String format,
                           Object arg1,
                           int arg2)

See Also:: DebugContext.logAndIndent(int, String, Object)

logAndIndent

public Indent logAndIndent(String format,
                           int arg1,
                           int arg2)

logAndIndent

public Indent logAndIndent(int logLevel,
                           String format,
                           int arg1,
                           int arg2)

See Also:: DebugContext.logAndIndent(int, String, Object)

logAndIndent

public Indent logAndIndent(String format,
                           Object arg1,
                           Object arg2)

logAndIndent

public Indent logAndIndent(int logLevel,
                           String format,
                           Object arg1,
                           Object arg2)

See Also:: DebugContext.logAndIndent(int, String, Object)

logAndIndent

public Indent logAndIndent(String format,
                           Object arg1,
                           Object arg2,
                           Object arg3)

logAndIndent

public Indent logAndIndent(int logLevel,
                           String format,
                           Object arg1,
                           Object arg2,
                           Object arg3)

See Also:: DebugContext.logAndIndent(int, String, Object)

logAndIndent

public Indent logAndIndent(String format,
                           int arg1,
                           int arg2,
                           int arg3)

logAndIndent

public Indent logAndIndent(int logLevel,
                           String format,
                           int arg1,
                           int arg2,
                           int arg3)

See Also:: DebugContext.logAndIndent(int, String, Object)

logAndIndent

public Indent logAndIndent(String format,
                           Object arg1,
                           int arg2,
                           int arg3)

logAndIndent

public Indent logAndIndent(int logLevel,
                           String format,
                           Object arg1,
                           int arg2,
                           int arg3)

See Also:: DebugContext.logAndIndent(int, String, Object)

logAndIndent

public Indent logAndIndent(String format,
                           Object arg1,
                           Object arg2,
                           Object arg3,
                           Object arg4)

logAndIndent

public Indent logAndIndent(int logLevel,
                           String format,
                           Object arg1,
                           Object arg2,
                           Object arg3,
                           Object arg4)

See Also:: DebugContext.logAndIndent(int, String, Object)

logAndIndent

public Indent logAndIndent(String format,
                           Object arg1,
                           Object arg2,
                           Object arg3,
                           Object arg4,
                           Object arg5)

logAndIndent

public Indent logAndIndent(int logLevel,
                           String format,
                           Object arg1,
                           Object arg2,
                           Object arg3,
                           Object arg4,
                           Object arg5)

See Also:: DebugContext.logAndIndent(int, String, Object)

logAndIndent

public Indent logAndIndent(String format,
                           Object arg1,
                           Object arg2,
                           Object arg3,
                           Object arg4,
                           Object arg5,
                           Object arg6)

logAndIndent

public Indent logAndIndent(int logLevel,
                           String format,
                           Object arg1,
                           Object arg2,
                           Object arg3,
                           Object arg4,
                           Object arg5,
                           Object arg6)

See Also:: DebugContext.logAndIndent(int, String, Object)

logvAndIndent
```
public Indent logvAndIndent(int logLevel,
                            String format,
                            Object... args)
```
A convenience function which combines DebugContext.logv(int, String, Object...) and DebugContext.indent().

Parameters:

format - a format string

args - the arguments referenced by the format specifiers in format

Returns:

an object that reverts to the current indentation level when closed or null if debugging is disabled

context
```
public Iterable<Object> context()
```

contextSnapshot

public <T> List<T> contextSnapshot(Class<T> clazz)

contextLookup
```
public <T> T contextLookup(Class<T> clazz)
```
Searches the current debug scope, bottom up, for a context object that is an instance of a given type. The first such object found is returned.

contextLookupTopdown
```
public <T> T contextLookupTopdown(Class<T> clazz)
```
Searches the current debug scope, top down, for a context object that is an instance of a given type. The first such object found is returned.

memUseTracker

public static MemUseTrackerKey memUseTracker(CharSequence name)

Creates a memory use tracker.

memUseTracker

public static MemUseTrackerKey memUseTracker(String format,
                                             Object arg)

Creates a debug memory use tracker. Invoking this method is equivalent to:

 Debug.memUseTracker(format, arg, null)

except that the string formatting only happens if mem tracking is enabled.

See Also:: DebugContext.counter(String, Object, Object)

memUseTracker

public static MemUseTrackerKey memUseTracker(String format,
                                             Object arg1,
                                             Object arg2)

Creates a debug memory use tracker. Invoking this method is equivalent to:

 Debug.memUseTracker(String.format(format, arg1, arg2))

except that the string formatting only happens if memory use tracking is enabled. In addition, each argument is subject to the following type based conversion before being passed as an argument to String.format(String, Object...):

     Type          | Conversion
 ------------------+-----------------
  java.lang.Class  | arg.getSimpleName()
                   |

See Also:: DebugContext.memUseTracker(CharSequence)

counter

public static CounterKey counter(CharSequence name)

Creates a counter.

addValuesTo
```
public long[] addValuesTo(long[] tally)
```
Gets a tally of the metric values in this context and a given tally.

Parameters:

tally - the tally to which the metrics should be added

Returns:

a tally of the metric values in this context and tally. This will be tally if this context has no metric values or tally is wide enough to hold all the metric values in this context otherwise it will be a new array.

convertValuesToKeyValueMap
```
public static org.graalvm.collections.EconomicMap<MetricKey,Long> convertValuesToKeyValueMap(long[] values)
```
Creates and returns a sorted map from metric names to their values in values.

Parameters:

values - values for metrics in the KeyRegistry.

applyFormattingFlagsAndWidth

public static String applyFormattingFlagsAndWidth(String s,
                                                  int flags,
                                                  int width)

counter
```
public static CounterKey counter(String format,
                                 Object arg)
```
Creates a debug counter. Invoking this method is equivalent to:
```
 Debug.counter(format, arg, null)
 
```
except that the string formatting only happens if count is enabled.
See Also:

DebugContext.counter(String, Object, Object)

counter

public static CounterKey counter(String format,
                                 Object arg1,
                                 Object arg2)

Creates a debug counter. Invoking this method is equivalent to:

 Debug.counter(String.format(format, arg1, arg2))

except that the string formatting only happens if count is enabled. In addition, each argument is subject to the following type based conversion before being passed as an argument to String.format(String, Object...):

     Type          | Conversion
 ------------------+-----------------
  java.lang.Class  | arg.getSimpleName()
                   |

See Also:: DebugContext.counter(CharSequence)

getConfig
```
public DebugConfig getConfig()
```

timer
```
public static TimerKey timer(CharSequence name)
```
Creates a timer.
A disabled timer has virtually no overhead.

timer
```
public static TimerKey timer(String format,
                             Object arg)
```
Creates a debug timer. Invoking this method is equivalent to:
```
 Debug.timer(format, arg, null)
 
```
except that the string formatting only happens if timing is enabled.
See Also:

DebugContext.timer(String, Object, Object)

timer

public static TimerKey timer(String format,
                             Object arg1,
                             Object arg2)

Creates a debug timer. Invoking this method is equivalent to:

 Debug.timer(String.format(format, arg1, arg2))

except that the string formatting only happens if timing is enabled. In addition, each argument is subject to the following type based conversion before being passed as an argument to String.format(String, Object...):

     Type          | Conversion
 ------------------+-----------------
  java.lang.Class  | arg.getSimpleName()
                   |

See Also:: DebugContext.timer(CharSequence)

convertFormatArg

public static Object convertFormatArg(Object arg)

areMetricsEnabled
```
public boolean areMetricsEnabled()
```

close
```
public void close()
```
Specified by:

close in interface AutoCloseable

closeDumpHandlers

public void closeDumpHandlers(boolean ignoreErrors)

printMetrics
```
public void printMetrics(DebugContext.Description desc)
```
Prints metric values in this object to the file (if any) specified by DebugOptions.MetricsFile.

getMetricsSnapshot

public Map<MetricKey,Long> getMetricsSnapshot()

Class DebugContext

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DUMP_FILE_MESSAGE_FORMAT

DUMP_FILE_MESSAGE_REGEXP

NO_DESCRIPTION

NO_GLOBAL_METRIC_VALUES

NO_CONFIG_CUSTOMIZERS

ENABLED_LEVEL

BASIC_LEVEL

INFO_LEVEL

VERBOSE_LEVEL

DETAILED_LEVEL

VERY_DETAILED_LEVEL

Method Detail

getDefaultLogStream

areScopesEnabled

buildOutput

addVersionProperties

getOptions

activate

disabled

forCurrentThread

getDescription

hasCompilationListener

enterCompilerPhase

enterCompilerPhase

notifyInlining

getGlobalMetrics

getDumpPath

isDumpEnabled

isVerifyEnabledForMethod

isVerifyEnabled

isCountEnabled

isTimeEnabled

isMemUseTrackingEnabled

isDumpEnabledForMethod

isLogEnabledForMethod

isLogEnabled

isLogEnabled

getCurrentScopeName

scope

scope

scope

scope

scope

withContext

sandbox

inNestedScope

disable

forceLog

disableIntercept

handle

log

log

log

log

log

log

log

log

log

log

log

log

log

log

log

log

log

log

log

log

log

log

log

log