org.graalvm.compiler.truffle.common

Interface TruffleCompilerListener

public interface TruffleCompilerListener

A listener for events related to the compilation of a CompilableTruffleAST. The events are described only in terms of types that can be easily serialized or proxied across a heap boundary.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TruffleCompilerListener.CompilationResultInfo Summary information for the result of a compilation.
static interface	TruffleCompilerListener.GraphInfo Summary information for a compiler graph.

Method Summary

Modifier and Type	Method and Description
default void	onCompilationRetry(CompilableTruffleAST compilable, TruffleCompilationTask task) Notifies this object when compilation of compilable is re-tried to diagnose a compilation problem.
default void	onFailure(CompilableTruffleAST compilable, String reason, boolean bailout, boolean permanentBailout, int tier) Notifies this object when compilation of compilable fails.
void	onGraalTierFinished(CompilableTruffleAST compilable, TruffleCompilerListener.GraphInfo graph) Notifies this object when Graal IR compilation compilable completes.
default void	onSuccess(CompilableTruffleAST compilable, TruffleInliningData inliningPlan, TruffleCompilerListener.GraphInfo graph, TruffleCompilerListener.CompilationResultInfo compilationResultInfo, int tier) Notifies this object when compilation of compilable succeeds.
void	onTruffleTierFinished(CompilableTruffleAST compilable, TruffleInliningData inliningPlan, TruffleCompilerListener.GraphInfo graph) Notifies this object when compilation of compilable has completed partial evaluation and is about to perform compilation of the graph produced by partial evaluation.

Method Detail

onGraalTierFinished

void onGraalTierFinished(CompilableTruffleAST compilable,
                         TruffleCompilerListener.GraphInfo graph)

Notifies this object when Graal IR compilation compilable completes. Graal compilation occurs between TruffleCompilerListener.onTruffleTierFinished(org.graalvm.compiler.truffle.common.CompilableTruffleAST, org.graalvm.compiler.truffle.common.TruffleInliningData, org.graalvm.compiler.truffle.common.TruffleCompilerListener.GraphInfo) and code installation.

Parameters:

compilable - the call target that was compiled

graph - the graph representing compilable. The graph object is only valid for the lifetime of a call to this method. Invoking any TruffleCompilerListener.GraphInfo method on graph after this method returns will result in an IllegalStateException.

onTruffleTierFinished

void onTruffleTierFinished(CompilableTruffleAST compilable,
                           TruffleInliningData inliningPlan,
                           TruffleCompilerListener.GraphInfo graph)

Notifies this object when compilation of compilable has completed partial evaluation and is about to perform compilation of the graph produced by partial evaluation.

Parameters:

compilable - the call target being compiled

inliningPlan - the inlining plan used during partial evaluation

graph - the graph representing compilable. The graph object is only valid for the lifetime of a call to this method. Invoking any TruffleCompilerListener.GraphInfo method on graph after this method returns will result in an IllegalStateException.

onSuccess

default void onSuccess(CompilableTruffleAST compilable,
                       TruffleInliningData inliningPlan,
                       TruffleCompilerListener.GraphInfo graph,
                       TruffleCompilerListener.CompilationResultInfo compilationResultInfo,
                       int tier)

Notifies this object when compilation of compilable succeeds.

Parameters:

compilable - the Truffle AST whose compilation succeeded

inliningPlan - the inlining plan used during partial evaluation

graph - the graph representing compilable. The graph object is only valid for the lifetime of a call to this method. Invoking any TruffleCompilerListener.GraphInfo method on graph after this method returns will result in an IllegalStateException.

compilationResultInfo - the result of a compilation. The compilationResultInfo object is only valid for the lifetime of a call to this method. Invoking any TruffleCompilerListener.CompilationResultInfo method on compilationResultInfo after this method returns will result in an IllegalStateException.

tier - Which compilation tier was the compilation

onFailure

default void onFailure(CompilableTruffleAST compilable,
                       String reason,
                       boolean bailout,
                       boolean permanentBailout,
                       int tier)

Notifies this object when compilation of compilable fails.

Parameters:

compilable - the Truffle AST whose compilation failed

reason - the reason compilation failed

bailout - specifies whether the failure was a bailout or an error in the compiler. A bailout means the compiler aborted the compilation based on some of property of target (e.g., too big). A non-bailout means an unexpected error in the compiler itself.

permanentBailout - specifies if a bailout is due to a condition that probably won't change if the target is compiled again. This value is meaningless if bailout == false.

tier - Which compilation tier was the compilation

onCompilationRetry

default void onCompilationRetry(CompilableTruffleAST compilable,
                                TruffleCompilationTask task)

Notifies this object when compilation of compilable is re-tried to diagnose a compilation problem.

Parameters:

compilable - the Truffle AST which is going to be re-compiled.

task - Which compilation task is in question.