org.graalvm.compiler.truffle.common

Interface TruffleCompiler

All Known Subinterfaces:

HotSpotTruffleCompiler, TruffleCompilerBase

All Known Implementing Classes:

HotSpotTruffleCompilerImpl, TruffleCompilerImpl

public interface TruffleCompiler

A compiler that partially evaluates and compiles a CompilableTruffleAST to machine code.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIRST_TIER_COMPILATION_SUFFIX
static int	FIRST_TIER_INDEX
static int	LAST_TIER_INDEX
static String	SECOND_TIER_COMPILATION_SUFFIX

Method Summary

Modifier and Type	Method and Description
void	doCompile(TruffleDebugContext debug, TruffleCompilation compilation, Map<String,Object> options, TruffleCompilationTask task, TruffleCompilerListener listener) Compiles compilable to machine code.
String	getCompilerConfigurationName() Returns a unique name for the configuration in use by this compiler.
void	initialize(Map<String,Object> options, CompilableTruffleAST compilation, boolean firstInitialization) Initializes the compiler before the first compilation.
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.

Field Detail

FIRST_TIER_COMPILATION_SUFFIX

static final String FIRST_TIER_COMPILATION_SUFFIX

See Also:

Constant Field Values

SECOND_TIER_COMPILATION_SUFFIX

static final String SECOND_TIER_COMPILATION_SUFFIX

See Also:

Constant Field Values

FIRST_TIER_INDEX

static final int FIRST_TIER_INDEX

See Also:

Constant Field Values

LAST_TIER_INDEX

static final int LAST_TIER_INDEX

See Also:

Constant Field Values

Method Detail

initialize

void initialize(Map<String,Object> options,
                CompilableTruffleAST compilation,
                boolean firstInitialization)

Initializes the compiler before the first compilation.

Parameters:

options - the options for initialization

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

Since:

20.0.0

openCompilation

TruffleCompilation openCompilation(CompilableTruffleAST compilable)

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.

Parameters:

compilable - the Truffle AST to be compiled

openDebugContext

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

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

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

doCompile

void doCompile(TruffleDebugContext debug,
               TruffleCompilation compilation,
               Map<String,Object> options,
               TruffleCompilationTask task,
               TruffleCompilerListener listener)

Compiles compilable to machine code.

Parameters:

debug - a debug context to use

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

options - option values relevant to compilation

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

listener - a listener receiving events about compilation success or failure

getCompilerConfigurationName

String getCompilerConfigurationName()

Returns a unique name for the configuration in use by this compiler.

shutdown

void shutdown()

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.