com.oracle.graal.pointsto.api

Class HostVM

java.lang.Object

com.oracle.graal.pointsto.api.HostVM

public abstract class HostVM
extends Object

This abstract class defines the functionality that the hosting VM must support.

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassLoader	classLoader
protected List<BiConsumer<AnalysisMethod,org.graalvm.compiler.nodes.StructuredGraph>>	methodAfterParsingListeners
protected org.graalvm.compiler.options.OptionValues	options

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HostVM(org.graalvm.compiler.options.OptionValues options, ClassLoader classLoader)

Method Summary

Modifier and Type	Method and Description
void	addMethodAfterParsingListener(BiConsumer<AnalysisMethod,org.graalvm.compiler.nodes.StructuredGraph> methodAfterParsingHook)
void	checkForbidden(AnalysisType type, AnalysisType.UsageKind kind) Check if the type is allowed.
void	checkType(ResolvedJavaType type, AnalysisUniverse universe) Run additional checks on a type before the corresponding AnalysisType is created.
void	clearInThread()
abstract org.graalvm.compiler.java.GraphBuilderPhase.Instance	createGraphBuilderPhase(HostedProviders providers, org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration graphBuilderConfig, org.graalvm.compiler.phases.OptimisticOptimizations optimisticOpts, org.graalvm.compiler.nodes.graphbuilderconf.IntrinsicContext initialIntrinsicContext)
Object	getConfiguration()
String	getImageName() Gets the name of the native image being built.
Optional<AnalysisMethod>	handleForeignCall(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor foreignCallDescriptor, org.graalvm.compiler.core.common.spi.ForeignCallsProvider foreignCallsProvider) Hook for handling foreign calls.
boolean	hasNeverInlineDirective(ResolvedJavaMethod method) Check if the method can be inlined.
abstract void	initializeType(AnalysisType newValue) Run initialization tasks for a newly created AnalysisType.
InlineBeforeAnalysisPolicy<?>	inlineBeforeAnalysisPolicy()
void	installInThread(Object vmConfig)
abstract boolean	isInitialized(AnalysisType type) Check if an AnalysisType is initialized.
boolean	isRelocatedPointer(Object originalObject) Check if the provided object is a relocated pointer.
void	methodAfterParsingHook(BigBang bb, AnalysisMethod method, org.graalvm.compiler.nodes.StructuredGraph graph) Can be overwritten to run code after a method is parsed.
void	methodBeforeTypeFlowCreationHook(PointsToAnalysis bb, AnalysisMethod method, org.graalvm.compiler.nodes.StructuredGraph graph) Can be overwritten to run code before a method is created.
void	notifyClassReachabilityListener(AnalysisUniverse universe, org.graalvm.nativeimage.hosted.Feature.DuringAnalysisAccess access)
org.graalvm.compiler.options.OptionValues	options()
boolean	platformSupported(AnnotatedElement element) Check if the element is supported on current platform.
void	registerClassReachabilityListener(BiConsumer<org.graalvm.nativeimage.hosted.Feature.DuringAnalysisAccess,Class<?>> listener)
void	registerType(AnalysisType newValue) Register newly created type.
boolean	skipInterface(AnalysisUniverse universe, ResolvedJavaType interfaceType, ResolvedJavaType implementingType)
org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration	updateGraphBuilderConfiguration(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration config, AnalysisMethod method) Hook to change the GraphBuilderConfiguration used for parsing a method during analysis.

Methods inherited from class java.lang.Object

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

Field Detail

options

protected final org.graalvm.compiler.options.OptionValues options

classLoader

protected final ClassLoader classLoader

methodAfterParsingListeners

protected final List<BiConsumer<AnalysisMethod,org.graalvm.compiler.nodes.StructuredGraph>> methodAfterParsingListeners

Constructor Detail

HostVM

protected HostVM(org.graalvm.compiler.options.OptionValues options,
                 ClassLoader classLoader)

Method Detail

options

public org.graalvm.compiler.options.OptionValues options()

isRelocatedPointer

public boolean isRelocatedPointer(Object originalObject)

Check if the provided object is a relocated pointer.

Parameters:

originalObject - the object to check

handleForeignCall

public Optional<AnalysisMethod> handleForeignCall(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor foreignCallDescriptor,
                                                  org.graalvm.compiler.core.common.spi.ForeignCallsProvider foreignCallsProvider)

Hook for handling foreign calls.

Parameters:

foreignCallDescriptor - the foreign call descriptor

foreignCallsProvider - the foreign calls provider

Returns:

the AnalysisMethod modeling the foreign call, if supported

registerClassReachabilityListener

public void registerClassReachabilityListener(BiConsumer<org.graalvm.nativeimage.hosted.Feature.DuringAnalysisAccess,Class<?>> listener)

notifyClassReachabilityListener

public void notifyClassReachabilityListener(AnalysisUniverse universe,
                                            org.graalvm.nativeimage.hosted.Feature.DuringAnalysisAccess access)

checkForbidden

public void checkForbidden(AnalysisType type,
                           AnalysisType.UsageKind kind)

Check if the type is allowed.

Parameters:

type - the type to check

kind - usage kind

registerType

public void registerType(AnalysisType newValue)

Register newly created type.

Parameters:

newValue - the type to register

checkType

public void checkType(ResolvedJavaType type,
                      AnalysisUniverse universe)

Run additional checks on a type before the corresponding AnalysisType is created.

Parameters:

type - the hosted type

universe - the analysis universe

initializeType

public abstract void initializeType(AnalysisType newValue)

Run initialization tasks for a newly created AnalysisType.

Parameters:

newValue - the type to initialize

isInitialized

public abstract boolean isInitialized(AnalysisType type)

Check if an AnalysisType is initialized.

updateGraphBuilderConfiguration

public org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration updateGraphBuilderConfiguration(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration config,
                                                                                                             AnalysisMethod method)

Hook to change the GraphBuilderConfiguration used for parsing a method during analysis.

Parameters:

config - The default configuration used by the static analysis.

method - The method that is going to be parsed with the returned configuration.

Returns:

The updated configuration for the method.

createGraphBuilderPhase

public abstract org.graalvm.compiler.java.GraphBuilderPhase.Instance createGraphBuilderPhase(HostedProviders providers,
                                                                                             org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration graphBuilderConfig,
                                                                                             org.graalvm.compiler.phases.OptimisticOptimizations optimisticOpts,
                                                                                             org.graalvm.compiler.nodes.graphbuilderconf.IntrinsicContext initialIntrinsicContext)

getImageName

public String getImageName()

Gets the name of the native image being built.

Returns:

null if this VM is not being used in the context of building a native image

addMethodAfterParsingListener

public void addMethodAfterParsingListener(BiConsumer<AnalysisMethod,org.graalvm.compiler.nodes.StructuredGraph> methodAfterParsingHook)

methodAfterParsingHook

public void methodAfterParsingHook(BigBang bb,
                                   AnalysisMethod method,
                                   org.graalvm.compiler.nodes.StructuredGraph graph)

Can be overwritten to run code after a method is parsed.

Parameters:

bb - the analysis engine

method - the newly parsed method

graph - the method graph

methodBeforeTypeFlowCreationHook

public void methodBeforeTypeFlowCreationHook(PointsToAnalysis bb,
                                             AnalysisMethod method,
                                             org.graalvm.compiler.nodes.StructuredGraph graph)

Can be overwritten to run code before a method is created.

Parameters:

bb - the analysis engine

method - the newly created method

graph - the method graph

hasNeverInlineDirective

public boolean hasNeverInlineDirective(ResolvedJavaMethod method)

Check if the method can be inlined.

Parameters:

method - the target method

inlineBeforeAnalysisPolicy

public InlineBeforeAnalysisPolicy<?> inlineBeforeAnalysisPolicy()

skipInterface

public boolean skipInterface(AnalysisUniverse universe,
                             ResolvedJavaType interfaceType,
                             ResolvedJavaType implementingType)

platformSupported

public boolean platformSupported(AnnotatedElement element)

Check if the element is supported on current platform.

Parameters:

element - the AnnotatedElement to check

installInThread

public void installInThread(Object vmConfig)

clearInThread

public void clearInThread()

getConfiguration

public Object getConfiguration()