com.oracle.graal.pointsto.meta

Class AnalysisMethod

java.lang.Object

com.oracle.graal.pointsto.meta.AnalysisElement

com.oracle.graal.pointsto.meta.AnalysisMethod

All Implemented Interfaces:

GraphProvider, OriginalMethodProvider, WrappedElement, WrappedJavaMethod, com.oracle.svm.common.meta.MultiMethod, AnnotatedElement

Direct Known Subclasses:

PointsToAnalysisMethod

public abstract class AnalysisMethod
extends AnalysisElement
implements WrappedJavaMethod, GraphProvider, OriginalMethodProvider, com.oracle.svm.common.meta.MultiMethod

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnalysisMethod.Signature

Nested classes/interfaces inherited from class com.oracle.graal.pointsto.meta.AnalysisElement

AnalysisElement.ElementNotification, AnalysisElement.MethodOverrideReachableNotification, AnalysisElement.ReachabilityReason, AnalysisElement.ReachabilityTraceBuilder, AnalysisElement.SubtypeReachableNotification

Nested classes/interfaces inherited from interface com.oracle.graal.pointsto.infrastructure.GraphProvider

GraphProvider.Purpose

Nested classes/interfaces inherited from interface com.oracle.svm.common.meta.MultiMethod

com.oracle.svm.common.meta.MultiMethod.MultiMethodKey

Field Summary

Fields

Modifier and Type	Field and Description
protected AnalysisType	declaringClass
protected AnalysisMethod[]	implementations All concrete methods that can actually be called when calling this method.
ResolvedJavaMethod	wrapped

Fields inherited from interface com.oracle.svm.common.meta.MultiMethod

DEOPT_TARGET_METHOD, ORIGINAL_METHOD

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnalysisMethod(AnalysisMethod original, com.oracle.svm.common.meta.MultiMethod.MultiMethodKey multiMethodKey)
protected	AnalysisMethod(AnalysisUniverse universe, ResolvedJavaMethod wrapped, com.oracle.svm.common.meta.MultiMethod.MultiMethodKey multiMethodKey, Map<com.oracle.svm.common.meta.MultiMethod.MultiMethodKey,com.oracle.svm.common.meta.MultiMethod> multiMethodMap)

Method Summary

Modifier and Type	Method and Description
boolean	allowRuntimeCompilation() Returns true if a graph can be provided for GraphProvider.Purpose.PREPARE_RUNTIME_COMPILATION.
StackTraceElement	asStackTraceElement(int bci)
org.graalvm.compiler.nodes.StructuredGraph	buildGraph(org.graalvm.compiler.debug.DebugContext debug, ResolvedJavaMethod method, HostedProviders providers, GraphProvider.Purpose purpose)
boolean	canBeInlined()
boolean	canBeStaticallyBound()
void	cleanupAfterAnalysis()
protected abstract AnalysisMethod	createMultiMethod(AnalysisMethod analysisMethod, com.oracle.svm.common.meta.MultiMethod.MultiMethodKey newMultiMethodKey)
org.graalvm.compiler.nodes.StructuredGraph	decodeAnalyzedGraph(org.graalvm.compiler.debug.DebugContext debug, Iterable<org.graalvm.compiler.nodes.EncodedGraph.EncodedNodeReference> nodeReferences) Returns the Graal IR for the method that has been processed by the static analysis.
AnalysisParsedGraph	ensureGraphParsed(BigBang bb) Ensures that the method has been parsed, i.e., that the Graal IR for the method is available.
boolean	equals(Object obj)
Collection<com.oracle.svm.common.meta.MultiMethod>	getAllMultiMethods()
org.graalvm.compiler.nodes.EncodedGraph	getAnalyzedGraph()
Set<AnalysisMethod>	getCallers() Get the set of all callers for this method, as inferred by the static analysis.
byte[]	getCode()
int	getCodeSize()
ConstantPool	getConstantPool()
AnalysisType	getDeclaringClass()
Constant	getEncoding()
Object	getEntryPointData()
ExceptionHandler[]	getExceptionHandlers()
Type[]	getGenericParameterTypes()
int	getId()
protected Object	getImplementationInvokedReason()
AnalysisMethod[]	getImplementations()
protected Object	getInlinedReason()
Object	getIntrinsicMethodReason()
protected Object	getInvokedReason()
abstract List<BytecodePosition>	getInvokeLocations() Get the list of all invoke locations for this method, as inferred by the static analysis.
abstract Iterable<? extends InvokeInfo>	getInvokes()
Executable	getJavaMethod()
LineNumberTable	getLineNumberTable()
LocalVariableTable	getLocalVariableTable()
int	getMaxLocals()
int	getMaxStackSize()
int	getModifiers()
AnalysisMethod	getMultiMethod(com.oracle.svm.common.meta.MultiMethod.MultiMethodKey key)
com.oracle.svm.common.meta.MultiMethod.MultiMethodKey	getMultiMethodKey()
String	getName()
AnalysisMethod	getOrCreateMultiMethod(com.oracle.svm.common.meta.MultiMethod.MultiMethodKey key)
AnalysisMethod	getOrCreateMultiMethod(com.oracle.svm.common.meta.MultiMethod.MultiMethodKey key, Consumer<AnalysisMethod> createAction)
Annotation[][]	getParameterAnnotations()
Parameter[]	getParameters()
StackTraceElement[]	getParsingContext()
abstract Object	getParsingReason()
ProfilingInfo	getProfilingInfo(boolean includeNormal, boolean includeOSR)
String	getQualifiedName()
boolean	getReturnsAllInstantiatedTypes()
WrappedSignature	getSignature()
SpeculationLog	getSpeculationLog()
protected AnalysisUniverse	getUniverse()
ResolvedJavaMethod	getWrapped()
int	hashCode()
boolean	hasNeverInlineDirective()
boolean	isBridge()
boolean	isClassInitializer()
boolean	isConstructor()
boolean	isDefault()
boolean	isDirectRootMethod() Returns true if the method is marked as direct root.
boolean	isEntryPoint()
abstract boolean	isImplementationInvokable()
boolean	isImplementationInvoked() Returns true if the method body can ever be executed.
boolean	isInlined()
boolean	isIntrinsicMethod()
boolean	isInVirtualMethodTable(ResolvedJavaType resolved)
boolean	isInvoked() Returns true if this method is ever used as the target of a call site.
boolean	isReachable()
boolean	isSimplyImplementationInvoked()
boolean	isSynthetic()
boolean	isTriggered() Return true if reachability handlers should be executed for this element.
boolean	isVarArgs()
boolean	isVirtualRootMethod() Returns true if the method is marked as virtual root.
protected void	notifyImplementationInvokedCallbacks()
protected void	notifyMethodOverride(AnalysisMethod override)
void	onImplementationInvoked()
void	onReachable()
boolean	registerAsDirectRootMethod(Object reason) Registers this method as a direct (special or static) root for the analysis.
void	registerAsEntryPoint(Object newEntryPointData)
boolean	registerAsImplementationInvoked(Object reason)
void	registerAsInlined(Object reason)
void	registerAsIntrinsicMethod(Object reason) Registers this method as intrinsified to Graal nodes via a graph builder plugin.
boolean	registerAsInvoked(Object reason)
boolean	registerAsVirtualRootMethod(Object reason) Registers this method as a virtual root for the analysis.
void	registerImplementationInvokedCallback(Consumer<org.graalvm.nativeimage.hosted.Feature.DuringAnalysisAccess> callback)
void	registerOverrideReachabilityNotification(AnalysisElement.MethodOverrideReachableNotification notification)
AnalysisParsedGraph	reparseGraph(BigBang bb) Forces the graph to be reparsed and the reparsing to be done by this thread.
void	reprofile()
protected AnalysisMethod	resolveInType(AnalysisType holder) Resolves this method in the provided type, but only if the type or any of its subtypes is marked as instantiated.
protected AnalysisMethod	resolveInType(AnalysisType holder, boolean holderOrSubtypeInstantiated)
void	setAnalyzedGraph(org.graalvm.compiler.nodes.EncodedGraph analyzedGraph)
void	setReturnsAllInstantiatedTypes() This should only be set via calling FeatureImpl.BeforeAnalysisAccessImpl#registerOpaqueMethodReturn.
boolean	shouldBeInlined()
abstract void	startTrackInvocations()
String	toString()

Methods inherited from class com.oracle.graal.pointsto.meta.AnalysisElement

execute, getAnnotation, getAnnotations, getDeclaredAnnotation, getDeclaredAnnotations, isAnnotationPresent, notifyReachabilityCallback, notifyReachabilityCallbacks, registerReachabilityNotification

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.oracle.graal.pointsto.infrastructure.OriginalMethodProvider

getJavaMethod

Methods inherited from interface com.oracle.svm.common.meta.MultiMethod

isDeoptTarget, isDeoptTarget, isOriginalMethod, isOriginalMethod

Methods inherited from interface java.lang.reflect.AnnotatedElement

getAnnotationsByType, getDeclaredAnnotationsByType

Field Detail

wrapped

public final ResolvedJavaMethod wrapped

declaringClass

protected final AnalysisType declaringClass

implementations

protected AnalysisMethod[] implementations

All concrete methods that can actually be called when calling this method. This includes all overridden methods in subclasses, as well as this method if it is non-abstract.

Constructor Detail

AnalysisMethod

protected AnalysisMethod(AnalysisUniverse universe,
                         ResolvedJavaMethod wrapped,
                         com.oracle.svm.common.meta.MultiMethod.MultiMethodKey multiMethodKey,
                         Map<com.oracle.svm.common.meta.MultiMethod.MultiMethodKey,com.oracle.svm.common.meta.MultiMethod> multiMethodMap)

AnalysisMethod

protected AnalysisMethod(AnalysisMethod original,
                         com.oracle.svm.common.meta.MultiMethod.MultiMethodKey multiMethodKey)

Method Detail

getQualifiedName

public String getQualifiedName()

getUniverse

protected AnalysisUniverse getUniverse()

Specified by:

getUniverse in class AnalysisElement

cleanupAfterAnalysis

public void cleanupAfterAnalysis()

startTrackInvocations

public abstract void startTrackInvocations()

getInvokes

public abstract Iterable<? extends InvokeInfo> getInvokes()

Returns:

analysis related invoke information for given method, mainly the possible callees to traverse the call graph

getParsingReason

public abstract Object getParsingReason()

Returns:

the position of the invocation that triggered parsing for this method, or null

getParsingContext

public final StackTraceElement[] getParsingContext()

Returns:

the parsing context in which given method was parsed

getId

public int getId()

registerAsIntrinsicMethod

public void registerAsIntrinsicMethod(Object reason)

Registers this method as intrinsified to Graal nodes via a graph builder plugin. Such a method is treated similar to an invoked method. For example, method resolution must be able to find the method (otherwise the intrinsification would not work).

registerAsEntryPoint

public void registerAsEntryPoint(Object newEntryPointData)

registerAsInvoked

public boolean registerAsInvoked(Object reason)

registerAsImplementationInvoked

public boolean registerAsImplementationInvoked(Object reason)

registerAsInlined

public void registerAsInlined(Object reason)

registerImplementationInvokedCallback

public void registerImplementationInvokedCallback(Consumer<org.graalvm.nativeimage.hosted.Feature.DuringAnalysisAccess> callback)

notifyImplementationInvokedCallbacks

protected void notifyImplementationInvokedCallbacks()

getCallers

public Set<AnalysisMethod> getCallers()

Get the set of all callers for this method, as inferred by the static analysis.

getInvokeLocations

public abstract List<BytecodePosition> getInvokeLocations()

Get the list of all invoke locations for this method, as inferred by the static analysis.

isEntryPoint

public boolean isEntryPoint()

getEntryPointData

public Object getEntryPointData()

isIntrinsicMethod

public boolean isIntrinsicMethod()

getIntrinsicMethodReason

public Object getIntrinsicMethodReason()

registerAsVirtualRootMethod

public boolean registerAsVirtualRootMethod(Object reason)

Registers this method as a virtual root for the analysis. The class constant of the declaring class is used for exception metadata, so marking a method as invoked also makes the declaring class reachable. Class is always marked as reachable regardless of the success of the atomic mark, same reason as in AnalysisMethod.registerAsImplementationInvoked(Object).

registerAsDirectRootMethod

public boolean registerAsDirectRootMethod(Object reason)

Registers this method as a direct (special or static) root for the analysis.

isVirtualRootMethod

public boolean isVirtualRootMethod()

Returns true if the method is marked as virtual root. This doesn't necessarily mean that the method is implementation-invoked, that depends on the instantiation state of the respective receiver types.

isDirectRootMethod

public boolean isDirectRootMethod()

Returns true if the method is marked as direct root. For special invoked methods this doesn't necessarily mean that the method is implementation-invoked, that depends on the instantiation state of the respective receiver types. Static root methods are immediately registered as implementation-invoked too.

isSimplyImplementationInvoked

public boolean isSimplyImplementationInvoked()

isInvoked

public boolean isInvoked()

Returns true if this method is ever used as the target of a call site.

getInvokedReason

protected Object getInvokedReason()

isImplementationInvoked

public boolean isImplementationInvoked()

Returns true if the method body can ever be executed. Methods registered as root are also registered as implementation invoked when they are linked.

getImplementationInvokedReason

protected Object getImplementationInvokedReason()

isInlined

public boolean isInlined()

getInlinedReason

protected Object getInlinedReason()

isReachable

public boolean isReachable()

Specified by:

isReachable in class AnalysisElement

isTriggered

public boolean isTriggered()

Description copied from class: AnalysisElement

Return true if reachability handlers should be executed for this element.

Overrides:

isTriggered in class AnalysisElement

onImplementationInvoked

public void onImplementationInvoked()

onReachable

public void onReachable()

Specified by:

onReachable in class AnalysisElement

notifyMethodOverride

protected void notifyMethodOverride(AnalysisMethod override)

registerOverrideReachabilityNotification

public void registerOverrideReachabilityNotification(AnalysisElement.MethodOverrideReachableNotification notification)

resolveInType

protected AnalysisMethod resolveInType(AnalysisType holder)

Resolves this method in the provided type, but only if the type or any of its subtypes is marked as instantiated.

resolveInType

protected AnalysisMethod resolveInType(AnalysisType holder,
                                       boolean holderOrSubtypeInstantiated)

getWrapped

public ResolvedJavaMethod getWrapped()

Specified by:

getWrapped in interface WrappedElement

Specified by:

getWrapped in interface WrappedJavaMethod

Specified by:

getWrapped in class AnalysisElement

getName

public String getName()

getSignature

public WrappedSignature getSignature()

buildGraph

public org.graalvm.compiler.nodes.StructuredGraph buildGraph(org.graalvm.compiler.debug.DebugContext debug,
                                                             ResolvedJavaMethod method,
                                                             HostedProviders providers,
                                                             GraphProvider.Purpose purpose)

Specified by:

buildGraph in interface GraphProvider

allowRuntimeCompilation

public boolean allowRuntimeCompilation()

Description copied from interface: GraphProvider

Returns true if a graph can be provided for GraphProvider.Purpose.PREPARE_RUNTIME_COMPILATION. Note that a manually generated graph must be able to provide the proper deoptimization entry points and deoptimization frame states.

Specified by:

allowRuntimeCompilation in interface GraphProvider

getCode

public byte[] getCode()

getCodeSize

public int getCodeSize()

getDeclaringClass

public AnalysisType getDeclaringClass()

getMaxLocals

public int getMaxLocals()

getMaxStackSize

public int getMaxStackSize()

getParameters

public Parameter[] getParameters()

getModifiers

public int getModifiers()

isSynthetic

public boolean isSynthetic()

isVarArgs

public boolean isVarArgs()

isBridge

public boolean isBridge()

isClassInitializer

public boolean isClassInitializer()

isConstructor

public boolean isConstructor()

canBeStaticallyBound

public boolean canBeStaticallyBound()

getImplementations

public AnalysisMethod[] getImplementations()

getExceptionHandlers

public ExceptionHandler[] getExceptionHandlers()

asStackTraceElement

public StackTraceElement asStackTraceElement(int bci)

getProfilingInfo

public ProfilingInfo getProfilingInfo(boolean includeNormal,
                                      boolean includeOSR)

getConstantPool

public ConstantPool getConstantPool()

getParameterAnnotations

public Annotation[][] getParameterAnnotations()

getGenericParameterTypes

public Type[] getGenericParameterTypes()

canBeInlined

public boolean canBeInlined()

hasNeverInlineDirective

public boolean hasNeverInlineDirective()

shouldBeInlined

public boolean shouldBeInlined()

getLineNumberTable

public LineNumberTable getLineNumberTable()

toString

public String toString()

Overrides:

toString in class Object

getLocalVariableTable

public LocalVariableTable getLocalVariableTable()

reprofile

public void reprofile()

getEncoding

public Constant getEncoding()

isInVirtualMethodTable

public boolean isInVirtualMethodTable(ResolvedJavaType resolved)

isDefault

public boolean isDefault()

getSpeculationLog

public SpeculationLog getSpeculationLog()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getJavaMethod

public Executable getJavaMethod()

Specified by:

getJavaMethod in interface OriginalMethodProvider

reparseGraph

public AnalysisParsedGraph reparseGraph(BigBang bb)

Forces the graph to be reparsed and the reparsing to be done by this thread.

ensureGraphParsed

public AnalysisParsedGraph ensureGraphParsed(BigBang bb)

Ensures that the method has been parsed, i.e., that the Graal IR for the method is available.

decodeAnalyzedGraph

public org.graalvm.compiler.nodes.StructuredGraph decodeAnalyzedGraph(org.graalvm.compiler.debug.DebugContext debug,
                                                                      Iterable<org.graalvm.compiler.nodes.EncodedGraph.EncodedNodeReference> nodeReferences)

Returns the Graal IR for the method that has been processed by the static analysis.

setAnalyzedGraph

public void setAnalyzedGraph(org.graalvm.compiler.nodes.EncodedGraph analyzedGraph)

getAnalyzedGraph

public org.graalvm.compiler.nodes.EncodedGraph getAnalyzedGraph()

getMultiMethodKey

public com.oracle.svm.common.meta.MultiMethod.MultiMethodKey getMultiMethodKey()

Specified by:

getMultiMethodKey in interface com.oracle.svm.common.meta.MultiMethod

getOrCreateMultiMethod

public AnalysisMethod getOrCreateMultiMethod(com.oracle.svm.common.meta.MultiMethod.MultiMethodKey key)

Specified by:

getOrCreateMultiMethod in interface com.oracle.svm.common.meta.MultiMethod

getMultiMethod

public AnalysisMethod getMultiMethod(com.oracle.svm.common.meta.MultiMethod.MultiMethodKey key)

Specified by:

getMultiMethod in interface com.oracle.svm.common.meta.MultiMethod

getAllMultiMethods

public Collection<com.oracle.svm.common.meta.MultiMethod> getAllMultiMethods()

Specified by:

getAllMultiMethods in interface com.oracle.svm.common.meta.MultiMethod

getOrCreateMultiMethod

public AnalysisMethod getOrCreateMultiMethod(com.oracle.svm.common.meta.MultiMethod.MultiMethodKey key,
                                             Consumer<AnalysisMethod> createAction)

setReturnsAllInstantiatedTypes

public void setReturnsAllInstantiatedTypes()

This should only be set via calling FeatureImpl.BeforeAnalysisAccessImpl#registerOpaqueMethodReturn.

getReturnsAllInstantiatedTypes

public boolean getReturnsAllInstantiatedTypes()

createMultiMethod

protected abstract AnalysisMethod createMultiMethod(AnalysisMethod analysisMethod,
                                                    com.oracle.svm.common.meta.MultiMethod.MultiMethodKey newMultiMethodKey)

isImplementationInvokable

public abstract boolean isImplementationInvokable()