org.graalvm.compiler.truffle.compiler

Class TruffleCompilerImpl

java.lang.Object

org.graalvm.compiler.truffle.compiler.TruffleCompilerImpl

All Implemented Interfaces:

CompilationWatchDog.EventHandler, TruffleCompiler, TruffleCompilerBase

Direct Known Subclasses:

HotSpotTruffleCompilerImpl

public abstract class TruffleCompilerImpl
extends Object
implements TruffleCompilerBase, CompilationWatchDog.EventHandler

Coordinates partial evaluation of a Truffle AST and subsequent compilation via Graal.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TruffleCompilerImpl.CancellableTruffleCompilationTask Wrapper around a TruffleCompilationTask which also implements Cancellable to allow co-operative canceling of truffle compilations.

Field Summary

Fields

Modifier and Type	Field and Description
protected GraphBuilderConfiguration	builderConfig
static MemUseTrackerKey	CodeInstallationMemUse
protected org.graalvm.compiler.truffle.compiler.TruffleCompilerImpl.TrufflePostCodeInstallationTaskFactory	codeInstallationTaskFactory
static TimerKey	CodeInstallationTime
static MemUseTrackerKey	CompilationMemUse
static TimerKey	CompilationTime
protected TruffleCompilerConfiguration	config
static TimerKey	EncodedGraphCacheEvictionTime
static OptimisticOptimizations	Optimizations
static MemUseTrackerKey	PartialEvaluationMemUse
static TimerKey	PartialEvaluationTime
protected PartialEvaluator	partialEvaluator

Fields inherited from interface org.graalvm.compiler.truffle.common.TruffleCompiler

FIRST_TIER_COMPILATION_SUFFIX, FIRST_TIER_INDEX, LAST_TIER_INDEX, SECOND_TIER_COMPILATION_SUFFIX

Fields inherited from interface org.graalvm.compiler.core.CompilationWatchDog.EventHandler

DEFAULT, STUCK_COMPILATION_EXIT_CODE

Constructor Summary

Constructors

Constructor and Description
TruffleCompilerImpl(TruffleCompilerConfiguration config)

Method Summary

Modifier and Type	Method and Description
protected void	afterCodeInstallation(CompilationResult result, InstalledCode installedCode) Notifies this object once installedCode has been installed in the code cache.
CompilableTruffleAST	asCompilableTruffleAST(JavaConstant constant)
void	compileAST(org.graalvm.options.OptionValues options, DebugContext debug, CompilableTruffleAST compilable, CompilationIdentifier compilationId, TruffleCompilerImpl.CancellableTruffleCompilationTask task, TruffleCompilerListener listener)
CompilationResult	compilePEGraph(StructuredGraph graph, String name, PhaseSuite<HighTierContext> graphBuilderSuite, CompilableTruffleAST compilable, CompilationRequest compilationRequest, TruffleCompilerListener listener, TruffleCompilationTask task) Compiles a graph produced by TruffleTier, i.e.
abstract TruffleCompilationIdentifier	createCompilationIdentifier(CompilableTruffleAST compilable) Creates a new CompilationIdentifier for compilable.
protected abstract CompilationResult	createCompilationResult(String name, CompilationIdentifier compilationIdentifier, CompilableTruffleAST compilable) Creates the CompilationResult to be used for a Truffle compilation.
protected abstract DebugContext	createDebugContext(OptionValues options, CompilationIdentifier compilationId, CompilableTruffleAST compilable, PrintStream logStream)
abstract PhaseSuite<HighTierContext>	createGraphBuilderSuite(TruffleTierConfiguration tier)
protected abstract InstalledCode	createInstalledCode(CompilableTruffleAST compilable)
protected abstract PartialEvaluator	createPartialEvaluator(TruffleCompilerConfiguration configuration) Creates the partial evaluator used by this compiler.
static PartialEvaluatorConfiguration	createPartialEvaluatorConfiguration(String name)
void	doCompile(TruffleDebugContext truffleDebug, TruffleCompilation compilation, Map<String,Object> optionsMap, TruffleCompilationTask task, TruffleCompilerListener inListener) Compiles compilable to machine code.
protected void	exitHostVM(int status) Calls System.exit(int) in the runtime embedding the Graal compiler.
protected CompilableTruffleAST	getCompilable(CompilationResult result) Gets the CompilableTruffleAST associated with result.
protected abstract Map<CompilationWrapper.ExceptionAction,Integer>	getCompilationProblemsPerAction() Gets the map used to count the number of compilation failures or bailouts handled by each action.
TruffleCompilerConfiguration	getConfig()
protected abstract DiagnosticsOutputDirectory	getDebugOutputDirectory()
static org.graalvm.options.OptionValues	getOptionsForCompiler(Map<String,Object> options) Converts the values of PolyglotCompilerOptions passed to the TruffleCompiler.doCompile(org.graalvm.compiler.truffle.common.TruffleDebugContext, org.graalvm.compiler.truffle.common.TruffleCompilation, java.util.Map<java.lang.String, java.lang.Object>, org.graalvm.compiler.truffle.common.TruffleCompilationTask, org.graalvm.compiler.truffle.common.TruffleCompilerListener) as a Map into OptionValues.
PartialEvaluator	getPartialEvaluator()
SnippetReflectionProvider	getSnippetReflection()
TruffleTier	getTruffleTier()
void	initialize(Map<String,Object> optionsMap, CompilableTruffleAST compilable, boolean firstInitialization) Initializes the compiler before the first compilation.
protected TruffleTier	newTruffleTier(org.graalvm.options.OptionValues options)
void	onStuckCompilation(CompilationWatchDog watchDog, Thread watched, CompilationIdentifier compilation, StackTraceElement[] stackTrace, int stuckTime) Notifies this object that a compilation appears to be stuck.
TruffleCompilation	openCompilation(CompilableTruffleAST compilable) Opens a new compilation for compilable.
TruffleDebugContext	openDebugContext(Map<String,Object> options, TruffleCompilation compilation) Opens a debug context for Truffle compilation.
void	shutdown() Notifies this object that it will no longer being used and should thus perform all relevant finalization tasks.

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.common.TruffleCompiler

getCompilerConfigurationName

Methods inherited from interface org.graalvm.compiler.core.CompilationWatchDog.EventHandler

onException, onLongCompilation

Field Detail

config

protected TruffleCompilerConfiguration config

builderConfig

protected final GraphBuilderConfiguration builderConfig

partialEvaluator

protected final PartialEvaluator partialEvaluator

codeInstallationTaskFactory

protected final org.graalvm.compiler.truffle.compiler.TruffleCompilerImpl.TrufflePostCodeInstallationTaskFactory codeInstallationTaskFactory

Optimizations

public static final OptimisticOptimizations Optimizations

PartialEvaluationTime

public static final TimerKey PartialEvaluationTime

CompilationTime

public static final TimerKey CompilationTime

CodeInstallationTime

public static final TimerKey CodeInstallationTime

EncodedGraphCacheEvictionTime

public static final TimerKey EncodedGraphCacheEvictionTime

PartialEvaluationMemUse

public static final MemUseTrackerKey PartialEvaluationMemUse

CompilationMemUse

public static final MemUseTrackerKey CompilationMemUse

CodeInstallationMemUse

public static final MemUseTrackerKey CodeInstallationMemUse

Constructor Detail

TruffleCompilerImpl

public TruffleCompilerImpl(TruffleCompilerConfiguration config)

Method Detail

getConfig

public TruffleCompilerConfiguration getConfig()

createPartialEvaluator

protected abstract PartialEvaluator createPartialEvaluator(TruffleCompilerConfiguration configuration)

Creates the partial evaluator used by this compiler.

createCompilationIdentifier

public abstract TruffleCompilationIdentifier createCompilationIdentifier(CompilableTruffleAST compilable)

Creates a new CompilationIdentifier for compilable. Implementations of this method must guarantee that the CompilationIdentifier.Verbosity.ID for each returned value is unique.

createDebugContext

protected abstract DebugContext createDebugContext(OptionValues options,
                                                   CompilationIdentifier compilationId,
                                                   CompilableTruffleAST compilable,
                                                   PrintStream logStream)

openCompilation

public final TruffleCompilation openCompilation(CompilableTruffleAST compilable)

Description copied from interface: TruffleCompiler

Opens a new compilation for compilable. Each call results in a new compilation object. The returned compilation object may be associated with external resources which are only released by calling close.

Specified by:

openCompilation in interface TruffleCompiler

Parameters:

compilable - the Truffle AST to be compiled

openDebugContext

public final TruffleDebugContext openDebugContext(Map<String,Object> options,
                                                  TruffleCompilation compilation)

Description copied from interface: TruffleCompiler

Opens a debug context for Truffle compilation. The close() method should be called on the returned object once the compilation is finished.

Specified by:

openDebugContext in interface TruffleCompiler

Parameters:

options - the options for the debug context

compilation - a compilation object created by openCompilation to be used for a single compilation or null if the returned context will be used for multiple Truffle compilations

Returns:

the new TruffleDebugContext

createPartialEvaluatorConfiguration

public static PartialEvaluatorConfiguration createPartialEvaluatorConfiguration(String name)

doCompile

public final void doCompile(TruffleDebugContext truffleDebug,
                            TruffleCompilation compilation,
                            Map<String,Object> optionsMap,
                            TruffleCompilationTask task,
                            TruffleCompilerListener inListener)

Description copied from interface: TruffleCompiler

Compiles compilable to machine code.

Specified by:

doCompile in interface TruffleCompiler

Parameters:

truffleDebug - a debug context to use

compilation - a compilation object created by openCompilation to be used for the compilation

optionsMap - option values relevant to compilation

task - an object that holds information about the compilation process itself (e.g. which tier, was the compilation canceled)

inListener - a listener receiving events about compilation success or failure

initialize

public void initialize(Map<String,Object> optionsMap,
                       CompilableTruffleAST compilable,
                       boolean firstInitialization)

Description copied from interface: TruffleCompiler

Initializes the compiler before the first compilation.

Specified by:

initialize in interface TruffleCompiler

Parameters:

optionsMap - the options for initialization

compilable - the Truffle AST that triggered the initialization

firstInitialization - first initialization. For a multi-isolate compiler the firstInitialization must be true for an initialization in the first isolate and false for an initialization in the following isolates.

newTruffleTier

protected TruffleTier newTruffleTier(org.graalvm.options.OptionValues options)

shutdown

public void shutdown()

Description copied from interface: TruffleCompiler

Notifies this object that it will no longer being used and should thus perform all relevant finalization tasks. This is typically performed when the process exits.

Specified by:

shutdown in interface TruffleCompiler

getDebugOutputDirectory

protected abstract DiagnosticsOutputDirectory getDebugOutputDirectory()

getCompilationProblemsPerAction

protected abstract Map<CompilationWrapper.ExceptionAction,Integer> getCompilationProblemsPerAction()

Gets the map used to count the number of compilation failures or bailouts handled by each action.

See Also:

CompilationWrapper.CompilationWrapper(DiagnosticsOutputDirectory, Map)

compileAST

public void compileAST(org.graalvm.options.OptionValues options,
                       DebugContext debug,
                       CompilableTruffleAST compilable,
                       CompilationIdentifier compilationId,
                       TruffleCompilerImpl.CancellableTruffleCompilationTask task,
                       TruffleCompilerListener listener)

compilePEGraph

public CompilationResult compilePEGraph(StructuredGraph graph,
                                        String name,
                                        PhaseSuite<HighTierContext> graphBuilderSuite,
                                        CompilableTruffleAST compilable,
                                        CompilationRequest compilationRequest,
                                        TruffleCompilerListener listener,
                                        TruffleCompilationTask task)

Compiles a graph produced by TruffleTier, i.e. TruffleCompilerImpl.truffleTier(TruffleCompilationWrapper, DebugContext).

Parameters:

graph - a graph resulting from partial evaluation

name - the name to be used for the returned result

graphBuilderSuite - phase suite to be used for creating new graphs during inlining

compilationRequest -

listener -

createInstalledCode

protected abstract InstalledCode createInstalledCode(CompilableTruffleAST compilable)

exitHostVM

protected 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.

createCompilationResult

protected abstract CompilationResult createCompilationResult(String name,
                                                             CompilationIdentifier compilationIdentifier,
                                                             CompilableTruffleAST compilable)

Creates the CompilationResult to be used for a Truffle compilation.

createGraphBuilderSuite

public abstract PhaseSuite<HighTierContext> createGraphBuilderSuite(TruffleTierConfiguration tier)

getPartialEvaluator

public PartialEvaluator getPartialEvaluator()

Specified by:

getPartialEvaluator in interface TruffleCompilerBase

getTruffleTier

public TruffleTier getTruffleTier()

Specified by:

getTruffleTier in interface TruffleCompilerBase

asCompilableTruffleAST

public CompilableTruffleAST asCompilableTruffleAST(JavaConstant constant)

onStuckCompilation

public void onStuckCompilation(CompilationWatchDog watchDog,
                               Thread watched,
                               CompilationIdentifier compilation,
                               StackTraceElement[] stackTrace,
                               int stuckTime)

Description copied from interface: CompilationWatchDog.EventHandler

Notifies this object that a compilation appears to be stuck. The typical action to take is to exit the VM with exit code CompilationWatchDog.EventHandler.STUCK_COMPILATION_EXIT_CODE.

Specified by:

onStuckCompilation in interface CompilationWatchDog.EventHandler

Parameters:

watchDog - the watch dog watching the compilation

watched - the watched compiler thread

compilation - the compilation

stackTrace - snapshot stack trace for watched

stuckTime - seconds compilation appears to have been stuck for

getCompilable

protected CompilableTruffleAST getCompilable(CompilationResult result)

Gets the CompilableTruffleAST associated with result.

Parameters:

result - a CompilationResult that may have a non-null CompilableTruffleAST associated with it

afterCodeInstallation

protected void afterCodeInstallation(CompilationResult result,
                                     InstalledCode installedCode)

Notifies this object once installedCode has been installed in the code cache.

Parameters:

result - the result of compilation

installedCode - code that has just been installed in the code cache

getSnippetReflection

public final SnippetReflectionProvider getSnippetReflection()

Specified by:

getSnippetReflection in interface TruffleCompilerBase

getOptionsForCompiler

public static org.graalvm.options.OptionValues getOptionsForCompiler(Map<String,Object> options)

Converts the values of PolyglotCompilerOptions passed to the TruffleCompiler.doCompile(org.graalvm.compiler.truffle.common.TruffleDebugContext, org.graalvm.compiler.truffle.common.TruffleCompilation, java.util.Map<java.lang.String, java.lang.Object>, org.graalvm.compiler.truffle.common.TruffleCompilationTask, org.graalvm.compiler.truffle.common.TruffleCompilerListener) as a Map into OptionValues.