Debug (Graal OpenJDK Project Documentation)

java.lang.Object
- com.oracle.graal.debug.Debug

```
public class Debug
extends Object
```
Scope based debugging facility. This facility is isEnabled() if assertions are enabled for the Debug class or the system property is "true" when Debug is initialized.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Debug.Initialization` Class to assist with initialization of `Debug`.
`static interface`	`Debug.Scope` Represents a debug scope entered by `scope(Object)` or `sandbox(CharSequence, DebugConfig, Object...)`.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_LOG_LEVEL`
`static String`	`ENABLE_METRIC_PROPERTY_NAME_PREFIX`
`static String`	`ENABLE_TIMER_PROPERTY_NAME_PREFIX`
`static String`	`ENABLE_UNSCOPED_MEM_USE_TRACKERS_PROPERTY_NAME`
`static String`	`ENABLE_UNSCOPED_METRICS_PROPERTY_NAME`
`static String`	`ENABLE_UNSCOPED_TIMERS_PROPERTY_NAME`
`private static boolean`	`ENABLED`
`private static Set<String>`	`enabledMetrics` Set of unconditionally enabled metrics.
`private static Set<String>`	`enabledMetricsSubstrings`
`private static Set<String>`	`enabledTimers` Set of unconditionally enabled timers.
`private static Set<String>`	`enabledTimersSubstrings`
`private static ClassValue<String>`	`formattedClassName` There are paths where construction of formatted class names are common and the code below is surprisingly expensive, so compute it once and cache it.
`private static boolean`	`isUnconditionalMemUseTrackingEnabled` Specifies if all mem use trackers are unconditionally enabled.
`private static DebugMemUseTracker`	`VOID_MEM_USE_TRACKER`
`private static DebugMetric`	`VOID_METRIC`
`private static DebugTimer`	`VOID_TIMER`

Constructor Summary

Constructors
Constructor and Description

Debug()

Constructors
Constructor and Description
`Debug()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`applyFormattingFlagsAndWidth(String s, int flags, int width)`
`static boolean`	`areUnconditionalMetricsEnabled()`
`static boolean`	`areUnconditionalTimersEnabled()`
`static Iterable<Object>`	`context()`
`static <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.
`static <T> List<T>`	`contextSnapshot(Class<T> clazz)`
`static Object`	`convertFormatArg(Object arg)`
`static DebugHistogram`	`createHistogram(String name)` Creates an object for counting value frequencies.
`private static DebugMemUseTracker`	`createMemUseTracker(String format, Object arg1, Object arg2)`
`private static DebugMetric`	`createMetric(String format, Object arg1, Object arg2)`
`private static DebugTimer`	`createTimer(String format, Object arg1, Object arg2)`
`static String`	`currentScope()` Gets a string composed of the names in the current nesting of debug scopes separated by `'.'`.
`static <T> Callable<T>`	`decorateDebugRoot(Callable<T> callable, String name, DebugConfig config)`
`static Runnable`	`decorateDebugRoot(Runnable runnable, String name, DebugConfig config)`
`static <T> Callable<T>`	`decorateScope(Callable<T> callable, String name, Object... context)`
`static Runnable`	`decorateScope(Runnable runnable, String name, Object... context)`
`static DebugConfigScope`	`disableIntercept()` Opens a scope in which exception interception is disabled.
`static void`	`dump(int dumpLevel, Object object, String msg)`
`static void`	`dump(int dumpLevel, Object object, String format, Object arg)`
`static void`	`dump(int dumpLevel, Object object, String format, Object[] args)` Deprecated.
`static void`	`dump(int dumpLevel, Object object, String format, Object arg1, Object arg2)`
`static void`	`dump(int dumpLevel, Object object, String format, Object arg1, Object arg2, Object arg3)`
`static void`	`dump(Object object, String msg)`
`static void`	`dump(Object object, String format, Object arg)`
`static void`	`dump(Object object, String format, Object[] args)` Deprecated.
`static void`	`dump(Object object, String format, Object arg1, Object arg2)`
`static void`	`dump(Object object, String format, Object arg1, Object arg2, Object arg3)`
`private static boolean`	`findMatch(Set<String> haystack, Set<String> haystackSubstrings, String needle)`
`static DebugConfig`	`fixedConfig(int logLevel, int dumpLevel, boolean isMeterEnabled, boolean isMemUseTrackingEnabled, boolean isTimerEnabled, boolean isVerifyEnabled, Collection<DebugDumpHandler> dumpHandlers, Collection<DebugVerifyHandler> verifyHandlers, PrintStream output)`
`static Debug.Scope`	`forceLog()`
`private static String`	`formatDebugName(String format, Object arg1, Object arg2)`
`static RuntimeException`	`handle(Throwable exception)` Handles an exception in the context of the debug scope just exited.
`static Indent`	`indent()` Opens a new indentation level (by adding some spaces) based on the current indentation level.
`private static boolean`	`initialize()`
`static boolean`	`isDumpEnabled()`
`static boolean`	`isDumpEnabled(int dumpLevel)`
`static boolean`	`isDumpEnabledForMethod()`
`static boolean`	`isEnabled()`
`static boolean`	`isLogEnabled()`
`static boolean`	`isLogEnabled(int logLevel)`
`static boolean`	`isLogEnabledForMethod()`
`static boolean`	`isMemUseTrackingEnabled()`
`static boolean`	`isMeterEnabled()`
`static boolean`	`isTimeEnabled()`
`static boolean`	`isVerifyEnabled()` Determines if verification is enabled in the current debug scope.
`static boolean`	`isVerifyEnabledForMethod()` Determines if verification is enabled in the current method, regardless of the current debug scope.
`static void`	`log(int logLevel, String msg)` Prints a message to the current debug scope's logging stream if logging is enabled.
`static void`	`log(int logLevel, String format, int arg)` Prints a message to the current debug scope's logging stream if logging is enabled.
`static void`	`log(int logLevel, String format, int arg1, int arg2)`
`static void`	`log(int logLevel, String format, int arg1, int arg2, int arg3)`
`static void`	`log(int logLevel, String format, int arg1, Object arg2)`
`static void`	`log(int logLevel, String format, Object arg)` Prints a message to the current debug scope's logging stream if logging is enabled.
`static void`	`log(int logLevel, String format, Object[] args)` Deprecated.
`static void`	`log(int logLevel, String format, Object arg1, int arg2)`
`static void`	`log(int logLevel, String format, Object arg1, Object arg2)`
`static void`	`log(int logLevel, String format, Object arg1, Object arg2, Object arg3)`
`static void`	`log(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4)`
`static void`	`log(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5)`
`static void`	`log(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6)`
`static void`	`log(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6, Object arg7)`
`static void`	`log(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6, Object arg7, Object arg8)`
`static void`	`log(String msg)`
`static void`	`log(String format, int arg)`
`static void`	`log(String format, int arg1, int arg2)`
`static void`	`log(String format, int arg1, int arg2, int arg3)`
`static void`	`log(String format, int arg1, Object arg2)`
`static void`	`log(String format, Object arg)`
`static void`	`log(String format, Object[] args)` Deprecated.
`static void`	`log(String format, Object arg1, int arg2)`
`static void`	`log(String format, Object arg1, Object arg2)`
`static void`	`log(String format, Object arg1, Object arg2, Object arg3)`
`static void`	`log(String format, Object arg1, Object arg2, Object arg3, Object arg4)`
`static void`	`log(String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5)`
`static void`	`log(String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6)`
`static void`	`log(String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6, Object arg7)`
`static void`	`log(String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6, Object arg7, Object arg8)`
`static Indent`	`logAndIndent(int logLevel, String msg)` A convenience function which combines `log(String)` and `indent()`.
`static Indent`	`logAndIndent(int logLevel, String format, int arg)` A convenience function which combines `log(String, Object)` and `indent()`.
`static Indent`	`logAndIndent(int logLevel, String format, int arg1, int arg2)`
`static Indent`	`logAndIndent(int logLevel, String format, int arg1, int arg2, int arg3)`
`static Indent`	`logAndIndent(int logLevel, String format, int arg1, Object arg2)`
`static Indent`	`logAndIndent(int logLevel, String format, Object arg)` A convenience function which combines `log(String, Object)` and `indent()`.
`static void`	`logAndIndent(int logLevel, String format, Object[] args)` Deprecated.
`static Indent`	`logAndIndent(int logLevel, String format, Object arg1, int arg2)`
`static Indent`	`logAndIndent(int logLevel, String format, Object arg1, int arg2, int arg3)`
`static Indent`	`logAndIndent(int logLevel, String format, Object arg1, Object arg2)`
`static Indent`	`logAndIndent(int logLevel, String format, Object arg1, Object arg2, Object arg3)`
`static Indent`	`logAndIndent(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4)`
`static Indent`	`logAndIndent(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5)`
`static Indent`	`logAndIndent(int logLevel, String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6)`
`static Indent`	`logAndIndent(String msg)`
`static Indent`	`logAndIndent(String format, int arg)`
`static Indent`	`logAndIndent(String format, int arg1, int arg2)`
`static Indent`	`logAndIndent(String format, int arg1, int arg2, int arg3)`
`static Indent`	`logAndIndent(String format, int arg1, Object arg2)`
`static Indent`	`logAndIndent(String format, Object arg)`
`static void`	`logAndIndent(String format, Object[] args)` Deprecated.
`static Indent`	`logAndIndent(String format, Object arg1, int arg2)`
`static Indent`	`logAndIndent(String format, Object arg1, int arg2, int arg3)`
`static Indent`	`logAndIndent(String format, Object arg1, Object arg2)`
`static Indent`	`logAndIndent(String format, Object arg1, Object arg2, Object arg3)`
`static Indent`	`logAndIndent(String format, Object arg1, Object arg2, Object arg3, Object arg4)`
`static Indent`	`logAndIndent(String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5)`
`static Indent`	`logAndIndent(String format, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6)`
`static void`	`logv(int logLevel, String format, Object... args)` Prints a message to the current debug scope's logging stream.
`static void`	`logv(String format, Object... args)`
`static Indent`	`logvAndIndent(int logLevel, String format, Object... args)` A convenience function which combines `logv(int, String, Object...)` and `indent()`.
`private static Indent`	`logvAndIndentInternal(int logLevel, String format, Object... args)`
`static DebugMemUseTracker`	`memUseTracker(CharSequence name)` Creates a memory use tracker that is enabled iff debugging is enabled.
`static DebugMemUseTracker`	`memUseTracker(String format, Object arg)` Creates a debug memory use tracker.
`static DebugMemUseTracker`	`memUseTracker(String format, Object arg1, Object arg2)` Creates a debug memory use tracker.
`static DebugMetric`	`metric(CharSequence name)` Creates a metric that is enabled iff debugging is enabled or the system property whose name is formed by adding to "jvmci.debug.metric." to `name` is true.
`static DebugMetric`	`metric(String format, Object arg)` Creates a debug metric.
`static DebugMetric`	`metric(String format, Object arg1, Object arg2)` Creates a debug metric.
`protected static void`	`parseMetricAndTimerSystemProperties(Set<String> metrics, Set<String> timers, Set<String> metricsSubstrings, Set<String> timersSubstrings)`
`static Debug.Scope`	`sandbox(CharSequence name, DebugConfig config, Object... context)` Creates and enters a new debug scope which will be disjoint from the current debug scope.
`static Debug.Scope`	`scope(Object name)` Similar to `scope(Object, Object[])` but without context objects.
`static Debug.Scope`	`scope(Object name, Object context)`
`static Debug.Scope`	`scope(Object name, Object[] contextObjects)` Creates and enters a new debug scope which will be a child of the current debug scope.
`static Debug.Scope`	`scope(Object name, Object context1, Object context2)`
`static Debug.Scope`	`scope(Object name, Object context1, Object context2, Object context3)`
`static DebugConfigScope`	`setConfig(DebugConfig config)` Changes the debug configuration for the current thread.
`static DebugConfig`	`silentConfig()`
`static DebugTimer`	`timer(CharSequence name)` Creates a timer that is enabled iff debugging is enabled or the system property whose name is formed by adding to "jvmci.debug.timer." to `name` is true.
`static DebugTimer`	`timer(String format, Object arg)` Creates a debug timer.
`static DebugTimer`	`timer(String format, Object arg1, Object arg2)` Creates a debug timer.
`static void`	`verify(Object object, String message)` Calls all `DebugVerifyHandler`s in the current config to perform verification on a given object.
`static void`	`verify(Object object, String format, Object arg)` Calls all `DebugVerifyHandler`s in the current config to perform verification on a given object.
`static void`	`verify(Object object, String format, Object[] args)` Deprecated.

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

Field Detail
- ENABLED
```
private static final boolean ENABLED
```
- DEFAULT_LOG_LEVEL
```
public static final int DEFAULT_LOG_LEVEL
```
  See Also:
  
  Constant Field Values
- VOID_METRIC
```
private static final DebugMetric VOID_METRIC
```
- VOID_MEM_USE_TRACKER
```
private static final DebugMemUseTracker VOID_MEM_USE_TRACKER
```
- ENABLE_UNSCOPED_TIMERS_PROPERTY_NAME
```
public static final String ENABLE_UNSCOPED_TIMERS_PROPERTY_NAME
```
  See Also:
  
  Constant Field Values
- ENABLE_UNSCOPED_METRICS_PROPERTY_NAME
```
public static final String ENABLE_UNSCOPED_METRICS_PROPERTY_NAME
```
  See Also:
  
  Constant Field Values
- ENABLE_UNSCOPED_MEM_USE_TRACKERS_PROPERTY_NAME
```
public static final String ENABLE_UNSCOPED_MEM_USE_TRACKERS_PROPERTY_NAME
```
  See Also:
  
  Constant Field Values
- ENABLE_TIMER_PROPERTY_NAME_PREFIX
```
public static final String ENABLE_TIMER_PROPERTY_NAME_PREFIX
```
  See Also:
  
  timer(CharSequence), Constant Field Values
- ENABLE_METRIC_PROPERTY_NAME_PREFIX
```
public static final String ENABLE_METRIC_PROPERTY_NAME_PREFIX
```
  See Also:
  
  metric(CharSequence), Constant Field Values
- enabledMetrics
```
private static final Set<String> enabledMetrics
```
  Set of unconditionally enabled metrics. Possible values and their meanings:
  - null: no unconditionally enabled metrics
  - isEmpty(): all metrics are unconditionally enabled
  - !isEmpty(): use findMatch(Set, Set, String) on this set and enabledMetricsSubstrings to determine which metrics are unconditionally enabled
- enabledTimers
```
private static final Set<String> enabledTimers
```
  Set of unconditionally enabled timers. Same interpretation of values as for enabledMetrics.
- enabledMetricsSubstrings
```
private static final Set<String> enabledMetricsSubstrings
```
- enabledTimersSubstrings
```
private static final Set<String> enabledTimersSubstrings
```
- isUnconditionalMemUseTrackingEnabled
```
private static final boolean isUnconditionalMemUseTrackingEnabled
```
  Specifies if all mem use trackers are unconditionally enabled.
- formattedClassName
```
private static final ClassValue<String> formattedClassName
```
  There are paths where construction of formatted class names are common and the code below is surprisingly expensive, so compute it once and cache it.
- VOID_TIMER
```
private static final DebugTimer VOID_TIMER
```

Constructor Detail
- Debug
```
public Debug()
```

Method Detail

initialize
```
private static boolean initialize()
```

isEnabled
```
public static boolean isEnabled()
```

isDumpEnabledForMethod

public static boolean isDumpEnabledForMethod()

isDumpEnabled
```
public static boolean isDumpEnabled()
```

isDumpEnabled

public static boolean isDumpEnabled(int dumpLevel)

isVerifyEnabledForMethod
```
public static boolean isVerifyEnabledForMethod()
```
Determines if verification is enabled in the current method, regardless of the current debug scope.

See Also:

verify(Object, String)

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

See Also:

verify(Object, String)

isMeterEnabled

public static boolean isMeterEnabled()

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

isMemUseTrackingEnabled

public static boolean isMemUseTrackingEnabled()

isLogEnabledForMethod

public static boolean isLogEnabledForMethod()

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

isLogEnabled

public static boolean isLogEnabled(int logLevel)

decorateDebugRoot

public static Runnable decorateDebugRoot(Runnable runnable,
                                         String name,
                                         DebugConfig config)

decorateDebugRoot

public static <T> Callable<T> decorateDebugRoot(Callable<T> callable,
                                                String name,
                                                DebugConfig config)

decorateScope

public static Runnable decorateScope(Runnable runnable,
                                     String name,
                                     Object... context)

decorateScope

public static <T> Callable<T> decorateScope(Callable<T> callable,
                                            String name,
                                            Object... context)

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

scope
```
public static Debug.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 Debug.Scope.close() method is called

Throws:

Throwable - used to enforce a catch block.

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

See Also:

scope(Object, Object[])

scope

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

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

scope

public static Debug.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:: scope(Object, Object[])

scope

public static Debug.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:: scope(Object, Object[])

sandbox
```
public static Debug.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

context - objects to be appended to the current debug context

Returns:

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

Throws:

Throwable

forceLog

public static Debug.Scope forceLog()
                            throws Throwable

Throws:: Throwable

disableIntercept
```
public static DebugConfigScope disableIntercept()
```
Opens a scope in which exception interception is disabled. It is recommended to use the try-with-resource statement for managing entering and leaving such scopes:
```
 try (DebugConfigScope s = Debug.disableIntercept()) {
     ...
 }
 
```
This is particularly useful to suppress extraneous output in JUnit tests that are expected to throw an exception.

handle
```
public static 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 scope(Object) and sandbox(CharSequence, DebugConfig, Object...) is used

See Also:

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

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

log
```
public static 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 static void log(String format,
                       Object arg)

log
```
public static 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 static void log(String format,
                       int arg)

log
```
public static 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 static void log(String format,
                       Object arg1,
                       Object arg2)

log

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

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

log

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

log

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

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

log

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

log

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

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

log

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

log

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

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

log

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

log

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

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

log

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

log

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

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

log

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

log

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

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

log

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

log

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

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

log

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

log

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

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

log

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

log

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

log

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

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

log

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

logv

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

logv
```
public static 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 is 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

log
```
@Deprecated
public static void log(String format,
                                   Object[] args)
```
Deprecated.

This override exists to catch cases when log(String, Object) is called with one argument bound to a varargs method parameter. It will bind to this method instead of the single arg variant and produce a deprecation warning instead of silently wrapping the Object[] inside of another Object[].

log
```
@Deprecated
public static void log(int logLevel,
                                   String format,
                                   Object[] args)
```
Deprecated.

This override exists to catch cases when log(int, String, Object) is called with one argument bound to a varargs method parameter. It will bind to this method instead of the single arg variant and produce a deprecation warning instead of silently wrapping the Object[] inside of another Object[].

dump

public static void dump(Object object,
                        String msg)

dump

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

dump

public static void dump(Object object,
                        String format,
                        Object arg)

dump

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

dump

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

dump

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

dump

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

dump

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

dump
```
@Deprecated
public static void dump(Object object,
                                    String format,
                                    Object[] args)
```
Deprecated.

This override exists to catch cases when dump(Object, String, Object) is called with one argument bound to a varargs method parameter. It will bind to this method instead of the single arg variant and produce a deprecation warning instead of silently wrapping the Object[] inside of another Object[].

dump

@Deprecated
public static void dump(int dumpLevel,
                                    Object object,
                                    String format,
                                    Object[] args)

Deprecated.

This override exists to catch cases when dump(int, Object, String, Object) is called with one argument bound to a varargs method parameter. It will bind to this method instead of the single arg variant and produce a deprecation warning instead of silently wrapping the Object[] inside of another Object[].

verify
```
public static 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(Object, String)

verify
```
public static 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(Object, String)

verify
```
@Deprecated
public static void verify(Object object,
                                      String format,
                                      Object[] args)
```
Deprecated.

This override exists to catch cases when verify(Object, String, Object) is called with one argument bound to a varargs method parameter. It will bind to this method instead of the single arg variant and produce a deprecation warning instead of silently wrapping the Object[] inside of another Object[].

indent
```
public static 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:

logAndIndent(int, String), logAndIndent(int, String, Object)

logAndIndent

public static Indent logAndIndent(String msg)

logAndIndent
```
public static Indent logAndIndent(int logLevel,
                                  String msg)
```
A convenience function which combines log(String) and 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 static Indent logAndIndent(String format,
                                  Object arg)

logAndIndent
```
public static Indent logAndIndent(int logLevel,
                                  String format,
                                  Object arg)
```
A convenience function which combines log(String, Object) and 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 static Indent logAndIndent(String format,
                                  int arg)

logAndIndent
```
public static Indent logAndIndent(int logLevel,
                                  String format,
                                  int arg)
```
A convenience function which combines log(String, Object) and 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 static Indent logAndIndent(String format,
                                  int arg1,
                                  Object arg2)

logAndIndent

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

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

logAndIndent

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

logAndIndent

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

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

logAndIndent

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

logAndIndent

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

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

logAndIndent

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

logAndIndent

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

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

logAndIndent

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

logAndIndent

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

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

logAndIndent

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

logAndIndent

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

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

logAndIndent

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

logAndIndent

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

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

logAndIndent

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

logAndIndent

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

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

logAndIndent

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

logAndIndent

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

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

logAndIndent

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

logAndIndent

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

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

logvAndIndent
```
public static Indent logvAndIndent(int logLevel,
                                   String format,
                                   Object... args)
```
A convenience function which combines logv(int, String, Object...) and 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

logvAndIndentInternal

private static Indent logvAndIndentInternal(int logLevel,
                                            String format,
                                            Object... args)

logAndIndent
```
@Deprecated
public static void logAndIndent(String format,
                                            Object[] args)
```
Deprecated.

This override exists to catch cases when logAndIndent(String, Object) is called with one argument bound to a varargs method parameter. It will bind to this method instead of the single arg variant and produce a deprecation warning instead of silently wrapping the Object[] inside of another Object[].

logAndIndent
```
@Deprecated
public static void logAndIndent(int logLevel,
                                            String format,
                                            Object[] args)
```
Deprecated.

This override exists to catch cases when logAndIndent(int, String, Object) is called with one argument bound to a varargs method parameter. It will bind to this method instead of the single arg variant and produce a deprecation warning instead of silently wrapping the Object[] inside of another Object[].

context

public static Iterable<Object> context()

contextSnapshot

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

contextLookup
```
public static <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.

memUseTracker
```
public static DebugMemUseTracker memUseTracker(CharSequence name)
```
Creates a memory use tracker that is enabled iff debugging is enabled.
A disabled tracker has virtually no overhead.

memUseTracker

public static DebugMemUseTracker 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 metering is enabled.

See Also:: metric(String, Object, Object)

memUseTracker

public static DebugMemUseTracker 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:: memUseTracker(CharSequence)

createMemUseTracker

private static DebugMemUseTracker createMemUseTracker(String format,
                                                      Object arg1,
                                                      Object arg2)

metric
```
public static DebugMetric metric(CharSequence name)
```
Creates a metric that is enabled iff debugging is enabled or the system property whose name is formed by adding to "jvmci.debug.metric." to name is true. If the latter condition is true, then the returned metric is unconditional otherwise it is conditional.
A disabled metric has virtually no overhead.

applyFormattingFlagsAndWidth

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

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

metric(String, Object, Object)

metric

public static DebugMetric metric(String format,
                                 Object arg1,
                                 Object arg2)

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

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

except that the string formatting only happens if metering 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:: metric(CharSequence)

createMetric

private static DebugMetric createMetric(String format,
                                        Object arg1,
                                        Object arg2)

setConfig
```
public static DebugConfigScope setConfig(DebugConfig config)
```
Changes the debug configuration for the current thread.

Parameters:

config - new configuration to use for the current thread

Returns:

an object that when closed will restore the debug configuration for the current thread to what it was before this method was called

createHistogram

public static DebugHistogram createHistogram(String name)

Creates an object for counting value frequencies.

silentConfig

public static DebugConfig silentConfig()

fixedConfig

public static DebugConfig fixedConfig(int logLevel,
                                      int dumpLevel,
                                      boolean isMeterEnabled,
                                      boolean isMemUseTrackingEnabled,
                                      boolean isTimerEnabled,
                                      boolean isVerifyEnabled,
                                      Collection<DebugDumpHandler> dumpHandlers,
                                      Collection<DebugVerifyHandler> verifyHandlers,
                                      PrintStream output)

findMatch

private static boolean findMatch(Set<String> haystack,
                                 Set<String> haystackSubstrings,
                                 String needle)

areUnconditionalTimersEnabled

public static boolean areUnconditionalTimersEnabled()

areUnconditionalMetricsEnabled

public static boolean areUnconditionalMetricsEnabled()

parseMetricAndTimerSystemProperties

protected static void parseMetricAndTimerSystemProperties(Set<String> metrics,
                                                          Set<String> timers,
                                                          Set<String> metricsSubstrings,
                                                          Set<String> timersSubstrings)

timer
```
public static DebugTimer timer(CharSequence name)
```
Creates a timer that is enabled iff debugging is enabled or the system property whose name is formed by adding to "jvmci.debug.timer." to name is true. If the latter condition is true, then the returned timer is unconditional otherwise it is conditional.
A disabled timer has virtually no overhead.

timer
```
public static DebugTimer 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:

timer(String, Object, Object)

timer

public static DebugTimer 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:: timer(CharSequence)

convertFormatArg

public static Object convertFormatArg(Object arg)

formatDebugName

private static String formatDebugName(String format,
                                      Object arg1,
                                      Object arg2)

createTimer

private static DebugTimer createTimer(String format,
                                      Object arg1,
                                      Object arg2)

Class Debug

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENABLED

DEFAULT_LOG_LEVEL

VOID_METRIC

VOID_MEM_USE_TRACKER

ENABLE_UNSCOPED_TIMERS_PROPERTY_NAME

ENABLE_UNSCOPED_METRICS_PROPERTY_NAME

ENABLE_UNSCOPED_MEM_USE_TRACKERS_PROPERTY_NAME

ENABLE_TIMER_PROPERTY_NAME_PREFIX

ENABLE_METRIC_PROPERTY_NAME_PREFIX

enabledMetrics

enabledTimers

enabledMetricsSubstrings

enabledTimersSubstrings

isUnconditionalMemUseTrackingEnabled

formattedClassName

VOID_TIMER

Constructor Detail

Debug

Method Detail

initialize

isEnabled

isDumpEnabledForMethod

isDumpEnabled

isDumpEnabled

isVerifyEnabledForMethod

isVerifyEnabled

isMeterEnabled

isTimeEnabled

isMemUseTrackingEnabled

isLogEnabledForMethod

isLogEnabled

isLogEnabled

decorateDebugRoot

decorateDebugRoot

decorateScope

decorateScope

currentScope

scope

scope

scope

scope

scope

sandbox

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

log

log

log