/*
 * Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */


package org.graalvm.compiler.debug;

import java.io.PrintStream;
import java.util.Collection;

import org.graalvm.compiler.debug.DebugContext.Scope;
import org.graalvm.compiler.options.OptionValues;

import jdk.vm.ci.meta.JavaMethod;

public interface DebugConfig {

    
Returns the option values used to configure this object.
/** * Returns the option values used to configure this object. */
OptionValues getOptions();
Determines the current log level in scope.
/** * Determines the current log level in {@code scope}. */
int getLogLevel(DebugContext.Scope scope);
Determines the current dump level in scope.
/** * Determines the current dump level in {@code scope}. */
int getDumpLevel(DebugContext.Scope scope);
Determines if logging is enabled for any JavaMethod in scope's context.
/** * Determines if logging is enabled for any {@link JavaMethod} in {@code scope}'s * {@linkplain Scope#getCurrentContext() context}. */
boolean isLogEnabledForMethod(DebugContext.Scope scope);
Determines if counting is enabled in scope.
See Also:
/** * Determines if counting is enabled in {@code scope}. * * @see DebugContext#counter(CharSequence) */
boolean isCountEnabled(DebugContext.Scope scope);
Determines if memory use tracking is scope.
See Also:
/** * Determines if memory use tracking is {@code scope}. * * @see DebugContext#memUseTracker(CharSequence) */
boolean isMemUseTrackingEnabled(DebugContext.Scope scope);
Determines if dumping is enabled for any JavaMethod in scope's context.
/** * Determines if dumping is enabled for any {@link JavaMethod} in {@code scope}'s * {@linkplain Scope#getCurrentContext() context}. */
boolean isDumpEnabledForMethod(DebugContext.Scope scope);
See Also:
  • isVerifyEnabled.isVerifyEnabled()
/** * @see DebugContext#isVerifyEnabled() */
boolean isVerifyEnabled(DebugContext.Scope scope);
See Also:
  • isVerifyEnabledForMethod.isVerifyEnabledForMethod()
/** * @see DebugContext#isVerifyEnabledForMethod() */
boolean isVerifyEnabledForMethod(DebugContext.Scope scope);
See Also:
  • timer.timer(CharSequence)
/** * @see DebugContext#timer(CharSequence) */
boolean isTimeEnabled(DebugContext.Scope scope);
Handles notification of an exception occurring within a debug scope.
Returns:the exception object that is to be propagated to parent scope. A value of null indicates that e is to be propagated.
/** * Handles notification of an exception occurring within a debug scope. * * @return the exception object that is to be propagated to parent scope. A value of * {@code null} indicates that {@code e} is to be propagated. */
RuntimeException interceptException(DebugContext debug, Throwable e);
Gets an unmodifiable view of the dump handlers registered with this configuration.
/** * Gets an unmodifiable view of the dump handlers registered with this configuration. */
Collection<DebugDumpHandler> dumpHandlers();
Gets the PrintStream for logging.
/** * Gets the {@link PrintStream} for logging. */
PrintStream output();
Gets an unmodifiable view of the verify handlers registered with this configuration.
/** * Gets an unmodifiable view of the verify handlers registered with this configuration. */
Collection<DebugVerifyHandler> verifyHandlers(); default void closeDumpHandlers(boolean ignoreErrors) { for (DebugDumpHandler handler : dumpHandlers()) { try { handler.close(); } catch (Throwable e) { if (!ignoreErrors) { throw e; } } } }
Extracts a JavaMethod from an opaque debug context.
Returns:the JavaMethod represented by context or null
/** * Extracts a {@link JavaMethod} from an opaque debug context. * * @return the {@link JavaMethod} represented by {@code context} or null */
static JavaMethod asJavaMethod(Object context) { if (context instanceof JavaMethodContext) { return ((JavaMethodContext) context).asJavaMethod(); } if (context instanceof JavaMethod) { return (JavaMethod) context; } return null; } }