org.graalvm.compiler.hotspot.stubs

Class Stub

java.lang.Object

org.graalvm.compiler.hotspot.stubs.Stub

Direct Known Subclasses:

AbstractForeignCallStub, SnippetStub

public abstract class Stub
extends Object

Base class for implementing some low level code providing the out-of-line slow path for a snippet and/or a callee saved call to a HotSpot C/C++ runtime function or even another compiled Java method.

Field Summary

Fields

Modifier and Type	Field and Description
protected InstalledCode	code The code installed for the stub.
protected HotSpotForeignCallLinkage	linkage The linkage information for a call to this stub from compiled code.
protected OptionValues	options
protected HotSpotProviders	providers

Constructor Summary

Constructors

Constructor and Description
Stub(OptionValues options, HotSpotProviders providers, HotSpotForeignCallLinkage linkage) Creates a new stub.

Method Summary

Modifier and Type	Method and Description
protected void	checkSafeDataReference(DataPatch data)
protected LIRSuites	createLIRSuites()
protected Suites	createSuites()
protected abstract Object	debugScopeContext() Gets a context object for the debug scope created when producing the code for this stub.
InstalledCode	getCode(Backend backend) Gets the code for this stub, compiling it first if necessary.
CompilationResult	getCompilationResult(DebugContext debug, Backend backend) Gets a CompilationResult that can be used for code generation.
org.graalvm.collections.EconomicSet<Register>	getDestroyedCallerRegisters() Gets the registers destroyed by this stub from a caller's perspective.
protected abstract StructuredGraph	getGraph(DebugContext debug, CompilationIdentifier compilationId) Gets the graph that from which the code for this stub will be compiled.
protected abstract ResolvedJavaMethod	getInstalledCodeOwner() Gets the method the stub's code will be associated with once installed.
HotSpotForeignCallLinkage	getLinkage() Gets the linkage for a call to this stub from compiled code.
RegisterConfig	getRegisterConfig()
CompilationIdentifier	getStubCompilationId()
void	initDestroyedCallerRegisters(org.graalvm.collections.EconomicSet<Register> registers)
boolean	shouldSaveRegistersAroundCalls()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

linkage

protected final HotSpotForeignCallLinkage linkage

The linkage information for a call to this stub from compiled code.

code

protected InstalledCode code

The code installed for the stub.

options

protected final OptionValues options

providers

protected final HotSpotProviders providers

Constructor Detail

Stub

public Stub(OptionValues options,
            HotSpotProviders providers,
            HotSpotForeignCallLinkage linkage)

Creates a new stub.

Parameters:

linkage - linkage details for a call to the stub

Method Detail

initDestroyedCallerRegisters

public void initDestroyedCallerRegisters(org.graalvm.collections.EconomicSet<Register> registers)

getDestroyedCallerRegisters

public org.graalvm.collections.EconomicSet<Register> getDestroyedCallerRegisters()

Gets the registers destroyed by this stub from a caller's perspective. These are the temporaries of this stub and must thus be caller saved by a callers of this stub.

shouldSaveRegistersAroundCalls

public boolean shouldSaveRegistersAroundCalls()

getLinkage

public HotSpotForeignCallLinkage getLinkage()

Gets the linkage for a call to this stub from compiled code.

getRegisterConfig

public RegisterConfig getRegisterConfig()

getGraph

protected abstract StructuredGraph getGraph(DebugContext debug,
                                            CompilationIdentifier compilationId)

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

Parameters:

compilationId - unique compilation id for the stub

toString

public String toString()

Overrides:

toString in class Object

getInstalledCodeOwner

protected abstract ResolvedJavaMethod getInstalledCodeOwner()

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

debugScopeContext

protected abstract Object debugScopeContext()

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

getCode

public InstalledCode getCode(Backend backend)

Gets the code for this stub, compiling it first if necessary.

getCompilationResult

public CompilationResult getCompilationResult(DebugContext debug,
                                              Backend backend)

Gets a CompilationResult that can be used for code generation. Required for AOT.

getStubCompilationId

public CompilationIdentifier getStubCompilationId()

checkSafeDataReference

protected void checkSafeDataReference(DataPatch data)

createSuites

protected Suites createSuites()

createLIRSuites

protected LIRSuites createLIRSuites()