org.graalvm.compiler.core

Class CompilationWrapper<T>

java.lang.Object

org.graalvm.compiler.core.CompilationWrapper<T>

public abstract class CompilationWrapper<T>
extends Object

Wrapper for a compilation that centralizes what action to take based on GraalCompilerOptions.CompilationBailoutAsFailure and GraalCompilerOptions.CompilationFailureAction when an uncaught exception occurs during compilation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompilationWrapper.ExceptionAction Actions to take upon an exception being raised during compilation performed via CompilationWrapper.
class	CompilationWrapper.Failure Call back for handling a compilation failure.

Constructor Summary

Constructors

Constructor and Description
CompilationWrapper(DiagnosticsOutputDirectory outputDirectory, Map<CompilationWrapper.ExceptionAction,Integer> problemsHandledPerAction)

Method Summary

Modifier and Type	Method and Description
protected abstract DebugContext	createRetryDebugContext(DebugContext initialDebug, OptionValues options, PrintStream logStream) Creates the DebugContext to use when retrying a compilation.
protected abstract void	exitHostVM(int status) Calls System.exit(int) in the runtime embedding the Graal compiler.
protected abstract T	handleException(Throwable t) Handles an uncaught exception.
protected CompilationWrapper.ExceptionAction	lookupAction(OptionValues options, Throwable cause) Gets the action to take based on the value of GraalCompilerOptions.CompilationBailoutAsFailure, GraalCompilerOptions.CompilationFailureAction and GraalCompilerOptions.ExitVMOnException in options.
protected T	onCompilationFailure(CompilationWrapper.Failure failure) Entry point for handling a compilation failure.
protected abstract T	performCompilation(DebugContext debug) Perform the compilation wrapped by this object.
T	run(DebugContext initialDebug)
abstract String	toString() Gets a value that represents the input to the compilation.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompilationWrapper

public CompilationWrapper(DiagnosticsOutputDirectory outputDirectory,
                          Map<CompilationWrapper.ExceptionAction,Integer> problemsHandledPerAction)

Parameters:

outputDirectory - object used to access a directory for dumping if the compilation is re-executed

problemsHandledPerAction - map used to count the number of compilation failures or bailouts handled by each action. This is provided by the caller as it is expected to be shared between instances of CompilationWrapper.

Method Detail

handleException

protected abstract T handleException(Throwable t)

Handles an uncaught exception.

Parameters:

t - an exception thrown during CompilationWrapper.run(DebugContext)

Returns:

a value representing the result of a failed compilation (may be null)

lookupAction

protected CompilationWrapper.ExceptionAction lookupAction(OptionValues options,
                                                          Throwable cause)

Gets the action to take based on the value of GraalCompilerOptions.CompilationBailoutAsFailure, GraalCompilerOptions.CompilationFailureAction and GraalCompilerOptions.ExitVMOnException in options. Subclasses can override this to choose a different action.

Parameters:

cause - the cause of the bailout or failure

performCompilation

protected abstract T performCompilation(DebugContext debug)

Perform the compilation wrapped by this object.

Parameters:

debug - the debug context to use for the compilation

toString

public abstract String toString()

Gets a value that represents the input to the compilation.

Overrides:

toString in class Object

createRetryDebugContext

protected abstract DebugContext createRetryDebugContext(DebugContext initialDebug,
                                                        OptionValues options,
                                                        PrintStream logStream)

Creates the DebugContext to use when retrying a compilation.

Parameters:

initialDebug - the debug context used in the failing compilation

options - the options for configuring the debug context

logStream - the log stream to use in the debug context

onCompilationFailure

protected T onCompilationFailure(CompilationWrapper.Failure failure)

Entry point for handling a compilation failure. A subclass can use this to implement control over logging/dumping. This is important for example when an embedder wants to prevent flooding logging mechanisms in the embedding environment.

Returns:

the value returned by failure.handle()

run

public final T run(DebugContext initialDebug)

exitHostVM

protected abstract void exitHostVM(int status)

Calls System.exit(int) in the runtime embedding the Graal compiler. This will be a different runtime than Graal's runtime in the case of libgraal.