org.graalvm.compiler.truffle.runtime.debug

Class TraceCompilationListener

java.lang.Object

org.graalvm.compiler.truffle.runtime.AbstractGraalTruffleRuntimeListener

org.graalvm.compiler.truffle.runtime.debug.TraceCompilationListener

All Implemented Interfaces:

GraalTruffleRuntimeListener

public final class TraceCompilationListener
extends AbstractGraalTruffleRuntimeListener

Traces AST-level compilation events with a detailed log message sent to the Truffle log stream for each event.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COUNT_THRESHOLD_FORMAT
static String	TIER_FORMAT

Fields inherited from class org.graalvm.compiler.truffle.runtime.AbstractGraalTruffleRuntimeListener

runtime

Method Summary

Modifier and Type	Method and Description
static void	install(GraalTruffleRuntime runtime)
void	onCompilationDeoptimized(OptimizedCallTarget target, com.oracle.truffle.api.frame.Frame frame) Notifies this object when target has just deoptimized and is now executing in the Truffle interpreter instead of executing compiled code.
void	onCompilationDequeued(OptimizedCallTarget target, Object source, CharSequence reason, int tier) Notifies this object after target is removed from the compilation queue.
void	onCompilationFailed(OptimizedCallTarget target, String reason, boolean bailout, boolean permanentBailout, int tier) Notifies this object when compilation of target fails.
void	onCompilationInvalidated(OptimizedCallTarget target, Object source, CharSequence reason) Notifies this object when target is invalidated.
void	onCompilationQueued(OptimizedCallTarget target, int tier) Notifies this object after target is added to the compilation queue.
void	onCompilationStarted(OptimizedCallTarget target, TruffleCompilationTask task) Notifies this object when compilation of target is about to start.
void	onCompilationSuccess(OptimizedCallTarget target, TruffleInlining inliningDecision, TruffleCompilerListener.GraphInfo graph, TruffleCompilerListener.CompilationResultInfo result, int tier) Notifies this object when compilation of target succeeds.
void	onCompilationTruffleTierFinished(OptimizedCallTarget target, TruffleInlining inliningDecision, TruffleCompilerListener.GraphInfo graph) Notifies this object when compilation of target has completed partial evaluation and is about to perform compilation of the graph produced by partial evaluation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graalvm.compiler.truffle.runtime.GraalTruffleRuntimeListener

addASTSizeProperty, onCompilationGraalTierFinished, onCompilationSplit, onCompilationSplitFailed, onEngineClosed, onShutdown

Field Detail

TIER_FORMAT

public static final String TIER_FORMAT

See Also:

Constant Field Values

COUNT_THRESHOLD_FORMAT

public static final String COUNT_THRESHOLD_FORMAT

See Also:

Constant Field Values

Method Detail

install

public static void install(GraalTruffleRuntime runtime)

onCompilationQueued

public void onCompilationQueued(OptimizedCallTarget target,
                                int tier)

Description copied from interface: GraalTruffleRuntimeListener

Notifies this object after target is added to the compilation queue.

Parameters:

target - the call target that has just been enqueued for compilation

tier - Which compilation tier is in question.

onCompilationDequeued

public void onCompilationDequeued(OptimizedCallTarget target,
                                  Object source,
                                  CharSequence reason,
                                  int tier)

Description copied from interface: GraalTruffleRuntimeListener

Notifies this object after target is removed from the compilation queue.

Parameters:

target - the call target that has just been removed from the compilation queue

source - the source object that caused the compilation to be unqueued. For example the source Node object. May be null.

reason - a textual description of the reason why the compilation was unqueued. May be null.

tier - Which compilation tier is in question.

onCompilationFailed

public void onCompilationFailed(OptimizedCallTarget target,
                                String reason,
                                boolean bailout,
                                boolean permanentBailout,
                                int tier)

Description copied from interface: GraalTruffleRuntimeListener

Notifies this object when compilation of target fails.

Parameters:

target - the call target whose compilation failed

reason - a description of the failure

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 is in question.

onCompilationStarted

public void onCompilationStarted(OptimizedCallTarget target,
                                 TruffleCompilationTask task)

Description copied from interface: GraalTruffleRuntimeListener

Notifies this object when compilation of target is about to start.

Parameters:

target - the call target about to be compiled

task - which compilation task is in question.

onCompilationDeoptimized

public void onCompilationDeoptimized(OptimizedCallTarget target,
                                     com.oracle.truffle.api.frame.Frame frame)

Description copied from interface: GraalTruffleRuntimeListener

Notifies this object when target has just deoptimized and is now executing in the Truffle interpreter instead of executing compiled code.

Parameters:

target - the call target whose compiled code was just deoptimized

onCompilationTruffleTierFinished

public void onCompilationTruffleTierFinished(OptimizedCallTarget target,
                                             TruffleInlining inliningDecision,
                                             TruffleCompilerListener.GraphInfo graph)

Description copied from interface: GraalTruffleRuntimeListener

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

Parameters:

target - the call target being compiled

inliningDecision - the inlining plan used during partial evaluation

graph - access to compiler graph info

onCompilationSuccess

public void onCompilationSuccess(OptimizedCallTarget target,
                                 TruffleInlining inliningDecision,
                                 TruffleCompilerListener.GraphInfo graph,
                                 TruffleCompilerListener.CompilationResultInfo result,
                                 int tier)

Description copied from interface: GraalTruffleRuntimeListener

Notifies this object when compilation of target succeeds.

Parameters:

target - the call target whose compilation succeeded

inliningDecision - the inlining plan used during the compilation

graph - access to compiler graph info

result - access to compilation result info

tier - Which compilation tier is in question.

onCompilationInvalidated

public void onCompilationInvalidated(OptimizedCallTarget target,
                                     Object source,
                                     CharSequence reason)

Description copied from interface: GraalTruffleRuntimeListener

Notifies this object when target is invalidated.

Parameters:

target - the call target whose compiled code was just invalidated

source - the source object that caused the compilation to be invalidated. For example the source Node object. May be null.

reason - a textual description of the reason why the compilation was invalidated. May be null.