org.graalvm.compiler.hotspot.stubs

Class SnippetStub

java.lang.Object

org.graalvm.compiler.hotspot.stubs.Stub

org.graalvm.compiler.hotspot.stubs.SnippetStub

All Implemented Interfaces:

Snippets

Direct Known Subclasses:

AMD64MathStub, CreateExceptionStub, ExceptionHandlerStub, UnwindExceptionToCallerStub, VerifyOopStub

public abstract class SnippetStub
extends Stub
implements Snippets

Base class for a stub defined by a snippet.

Field Summary

Fields

Modifier and Type	Field and Description
protected ResolvedJavaMethod	method

Fields inherited from class org.graalvm.compiler.hotspot.stubs.Stub

code, linkage, options, providers

Constructor Summary

Constructors

Constructor and Description
SnippetStub(Class<? extends Snippets> snippetDeclaringClass, String snippetMethodName, OptionValues options, HotSpotProviders providers, HotSpotForeignCallLinkage linkage) Creates a new snippet stub.
SnippetStub(String snippetMethodName, OptionValues options, HotSpotProviders providers, HotSpotForeignCallLinkage linkage) Creates a new snippet stub.

Method Summary

Modifier and Type	Method and Description
protected StructuredGraph	buildInitialGraph(DebugContext debug, CompilationIdentifier compilationId, Object[] args, BitSet nonNullParameters)
protected Object	debugScopeContext() Gets a context object for the debug scope created when producing the code for this stub.
protected Object	getConstantParameterValue(int index, String name)
protected StructuredGraph	getGraph(DebugContext debug, CompilationIdentifier compilationId) Gets the graph that from which the code for this stub will be compiled.
ResolvedJavaMethod	getInstalledCodeOwner() Gets the method the stub's code will be associated with once installed.
ResolvedJavaMethod	getMethod()
protected Object[]	makeConstArgs(SnippetParameterInfo info)
protected void	registerSnippet()
String	toString()

Methods inherited from class org.graalvm.compiler.hotspot.stubs.Stub

checkSafeDataReference, createLIRSuites, createSuites, getCode, getDestroyedCallerRegisters, getLinkage, getRegisterConfig, getStubCompilationId, initDestroyedCallerRegisters, shouldSaveRegistersAroundCalls

Methods inherited from class java.lang.Object

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

Field Detail

method

protected final ResolvedJavaMethod method

Constructor Detail

SnippetStub

public SnippetStub(String snippetMethodName,
                   OptionValues options,
                   HotSpotProviders providers,
                   HotSpotForeignCallLinkage linkage)

Creates a new snippet stub.

Parameters:

snippetMethodName - name of the single Snippet annotated method in the class of this object

linkage - linkage details for a call to the stub

SnippetStub

public SnippetStub(Class<? extends Snippets> snippetDeclaringClass,
                   String snippetMethodName,
                   OptionValues options,
                   HotSpotProviders providers,
                   HotSpotForeignCallLinkage linkage)

Creates a new snippet stub.

Parameters:

snippetDeclaringClass - this class in which the Snippet annotated method is declared. If null, this the class of this object is used.

snippetMethodName - name of the single Snippet annotated method in snippetDeclaringClass

linkage - linkage details for a call to the stub

Method Detail

registerSnippet

protected void registerSnippet()

getGraph

protected StructuredGraph getGraph(DebugContext debug,
                                   CompilationIdentifier compilationId)

Description copied from class: Stub

Gets the graph that from which the code for this stub will be compiled.

Specified by:

getGraph in class Stub

compilationId - unique compilation id for the stub

buildInitialGraph

protected StructuredGraph buildInitialGraph(DebugContext debug,
                                            CompilationIdentifier compilationId,
                                            Object[] args,
                                            BitSet nonNullParameters)

makeConstArgs

protected Object[] makeConstArgs(SnippetParameterInfo info)

getConstantParameterValue

protected Object getConstantParameterValue(int index,
                                           String name)

debugScopeContext

protected Object debugScopeContext()

Description copied from class: Stub

Gets a context object for the debug scope created when producing the code for this stub.

Specified by:

debugScopeContext in class Stub

getInstalledCodeOwner

public ResolvedJavaMethod getInstalledCodeOwner()

Description copied from class: Stub

Gets the method the stub's code will be associated with once installed. This may be null.

Specified by:

getInstalledCodeOwner in class Stub

toString

public String toString()

Overrides:

toString in class Stub

getMethod

public ResolvedJavaMethod getMethod()