org.graalvm.compiler.hotspot

Class HotSpotGraalRuntime

java.lang.Object

org.graalvm.compiler.hotspot.HotSpotGraalRuntime

All Implemented Interfaces:

GraalRuntime, HotSpotGraalRuntimeProvider, SnippetCounter.Group.Factory, RuntimeProvider

public final class HotSpotGraalRuntime
extends Object
implements HotSpotGraalRuntimeProvider

Singleton class holding the instance of the GraalRuntime.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HotSpotGraalRuntime.HotSpotGC Constants denoting the GC algorithms available in HotSpot.

Method Summary

Modifier and Type	Method and Description
void	addShutdownHook(Runnable hook) Adds a Runnable that will be run when this runtime is HotSpotGraalRuntime.shutdown().
SnippetCounter.Group	createSnippetCounterGroup(String groupName) If snippet counters are enabled, creates and registers a SnippetCounter.Group with the given name.
<T extends Architecture> Backend	getBackend(Class<T> arch) Gets the backend for a given architecture.
<T> T	getCapability(Class<T> clazz)
Map<CompilationWrapper.ExceptionAction,Integer>	getCompilationProblemsPerAction() Gets the map used to count compilation problems at each CompilationWrapper.ExceptionAction level.
String	getCompilerConfigurationName() Returns the unique compiler configuration name that is in use.
HotSpotGraalRuntime.HotSpotGC	getGarbageCollector()
HotSpotBackend	getHostBackend() Gets the host backend.
HotSpotProviders	getHostProviders()
Instrumentation	getInstrumentation() Returns the instance holding the instrumentation data structures.
HotSpotGraalManagementRegistration	getManagement()
GlobalMetrics	getMetricValues()
String	getName()
OptionValues	getOptions() Gets the option values associated with this runtime.
String[]	getOptionValues(String... names) Gets the values for the options corresponding to names encoded as strings.
DiagnosticsOutputDirectory	getOutputDirectory() Gets a directory into which diagnostics such crash reports and dumps should be written.
GraalHotSpotVMConfig	getVMConfig()
void	handleManagementInitializationFailure(Throwable cause)
Object	invokeManagementAction(String actionName, Object[] params)
boolean	isBootstrapping() Determines if the VM is currently bootstrapping the JVMCI compiler.
boolean	isShutdown() This runtime has been requested to shutdown.
void	notifyBootstrapFinished()
DebugContext	openDebugContext(OptionValues compilationOptions, CompilationIdentifier compilationId, Object compilable, Iterable<DebugHandlersFactory> factories, PrintStream logStream) Opens a debug context for compiling compilable.
String[]	setOptionValues(String[] names, String[] values) Sets or updates this object's options from names and values.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graalvm.compiler.hotspot.HotSpotGraalRuntimeProvider

getTarget

Methods inherited from interface org.graalvm.compiler.api.runtime.GraalRuntime

getRequiredCapability

Method Detail

getMetricValues

public GlobalMetrics getMetricValues()

getHostProviders

public HotSpotProviders getHostProviders()

Specified by:

getHostProviders in interface HotSpotGraalRuntimeProvider

getVMConfig

public GraalHotSpotVMConfig getVMConfig()

Specified by:

getVMConfig in interface HotSpotGraalRuntimeProvider

openDebugContext

public DebugContext openDebugContext(OptionValues compilationOptions,
                                     CompilationIdentifier compilationId,
                                     Object compilable,
                                     Iterable<DebugHandlersFactory> factories,
                                     PrintStream logStream)

Description copied from interface: HotSpotGraalRuntimeProvider

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

Specified by:

openDebugContext in interface HotSpotGraalRuntimeProvider

Parameters:

compilationOptions - the options used to configure the compilation debug context

compilationId - a system wide unique compilation id

compilable - the input to the compilation

logStream - the log stream to use in this context

getOptions

public OptionValues getOptions()

Description copied from interface: HotSpotGraalRuntimeProvider

Gets the option values associated with this runtime.

Specified by:

getOptions in interface HotSpotGraalRuntimeProvider

createSnippetCounterGroup

public SnippetCounter.Group createSnippetCounterGroup(String groupName)

Description copied from interface: SnippetCounter.Group.Factory

If snippet counters are enabled, creates and registers a SnippetCounter.Group with the given name. Otherwise, returns null.

Specified by:

createSnippetCounterGroup in interface SnippetCounter.Group.Factory

Parameters:

groupName - name of the counter group

getName

public String getName()

Specified by:

getName in interface GraalRuntime

Specified by:

getName in interface HotSpotGraalRuntimeProvider

getCapability

public <T> T getCapability(Class<T> clazz)

Specified by:

getCapability in interface GraalRuntime

getGarbageCollector

public HotSpotGraalRuntime.HotSpotGC getGarbageCollector()

Specified by:

getGarbageCollector in interface HotSpotGraalRuntimeProvider

getHostBackend

public HotSpotBackend getHostBackend()

Description copied from interface: RuntimeProvider

Gets the host backend.

Specified by:

getHostBackend in interface HotSpotGraalRuntimeProvider

Specified by:

getHostBackend in interface RuntimeProvider

getBackend

public <T extends Architecture> Backend getBackend(Class<T> arch)

Description copied from interface: RuntimeProvider

Gets the backend for a given architecture.

Specified by:

getBackend in interface RuntimeProvider

Parameters:

arch - a specific architecture class

getCompilerConfigurationName

public String getCompilerConfigurationName()

Description copied from interface: HotSpotGraalRuntimeProvider

Returns the unique compiler configuration name that is in use. Useful for users to find out which configuration is in use.

Specified by:

getCompilerConfigurationName in interface HotSpotGraalRuntimeProvider

getInstrumentation

public Instrumentation getInstrumentation()

Description copied from interface: HotSpotGraalRuntimeProvider

Returns the instance holding the instrumentation data structures.

Specified by:

getInstrumentation in interface HotSpotGraalRuntimeProvider

addShutdownHook

public void addShutdownHook(Runnable hook)

Adds a Runnable that will be run when this runtime is HotSpotGraalRuntime.shutdown(). The runnable will be run on the same thread doing the shutdown. All the advice for regular shutdown hooks also applies here but even more so since the hook runs on the shutdown thread.

notifyBootstrapFinished

public void notifyBootstrapFinished()

isBootstrapping

public boolean isBootstrapping()

Description copied from interface: HotSpotGraalRuntimeProvider

Determines if the VM is currently bootstrapping the JVMCI compiler.

Specified by:

isBootstrapping in interface HotSpotGraalRuntimeProvider

isShutdown

public boolean isShutdown()

Description copied from interface: HotSpotGraalRuntimeProvider

This runtime has been requested to shutdown.

Specified by:

isShutdown in interface HotSpotGraalRuntimeProvider

getOutputDirectory

public DiagnosticsOutputDirectory getOutputDirectory()

Description copied from interface: HotSpotGraalRuntimeProvider

Gets a directory into which diagnostics such crash reports and dumps should be written.

Specified by:

getOutputDirectory in interface HotSpotGraalRuntimeProvider

getCompilationProblemsPerAction

public Map<CompilationWrapper.ExceptionAction,Integer> getCompilationProblemsPerAction()

Description copied from interface: HotSpotGraalRuntimeProvider

Gets the map used to count compilation problems at each CompilationWrapper.ExceptionAction level. All updates and queries to the map should be synchronized.

Specified by:

getCompilationProblemsPerAction in interface HotSpotGraalRuntimeProvider

getManagement

public HotSpotGraalManagementRegistration getManagement()

handleManagementInitializationFailure

public void handleManagementInitializationFailure(Throwable cause)

setOptionValues

public String[] setOptionValues(String[] names,
                                String[] values)

Sets or updates this object's options from names and values.

Parameters:

values - the values to set. The empty string represents null which resets an option to its default value. For string type options, a non-empty value must be enclosed in double quotes.

Returns:

an array of Strings where the element at index i is names[i] if setting the denoted option succeeded, null if the option is unknown otherwise an error message describing the failure to set the option

getOptionValues

public String[] getOptionValues(String... names)

Gets the values for the options corresponding to names encoded as strings. The empty string represents null. For string type options, non-null values will be enclosed in double quotes.

Parameters:

names - a list of option names

Returns:

the values for each named option. If an element in names does not denote an existing option, the corresponding element in the returned array will be null

invokeManagementAction

public Object invokeManagementAction(String actionName,
                                     Object[] params)
                              throws Exception

Throws:

Exception