org.graalvm.compiler.hotspot

Class HotSpotForeignCallLinkageImpl

java.lang.Object

HotSpotForeignCallTarget

org.graalvm.compiler.hotspot.HotSpotForeignCallLinkageImpl

All Implemented Interfaces:

ForeignCallLinkage, HotSpotForeignCallLinkage

public class HotSpotForeignCallLinkageImpl
extends HotSpotForeignCallTarget
implements HotSpotForeignCallLinkage

The details required to link a HotSpot runtime or stub call.

Nested Class Summary

Nested classes/interfaces inherited from interface org.graalvm.compiler.hotspot.HotSpotForeignCallLinkage

HotSpotForeignCallLinkage.RegisterEffect

Field Summary

Fields

Modifier and Type	Field and Description
protected HotSpotForeignCallDescriptor	descriptor The descriptor of the call.

Fields inherited from interface org.graalvm.compiler.hotspot.HotSpotForeignCallLinkage

JUMP_ADDRESS

Constructor Summary

Constructors

Constructor and Description
HotSpotForeignCallLinkageImpl(HotSpotForeignCallDescriptor descriptor, long address, HotSpotForeignCallLinkage.RegisterEffect effect, CallingConvention outgoingCallingConvention, CallingConvention incomingCallingConvention)

Method Summary

Modifier and Type	Method and Description
static HotSpotForeignCallLinkage	create(MetaAccessProvider metaAccess, CodeCacheProvider codeCache, WordTypes wordTypes, HotSpotForeignCallsProvider foreignCalls, HotSpotForeignCallDescriptor descriptor, long address, HotSpotForeignCallLinkage.RegisterEffect effect, Type outgoingCcType, Type incomingCcType) Creates a HotSpotForeignCallLinkage.
static CallingConvention	createCallingConvention(MetaAccessProvider metaAccess, CodeCacheProvider codeCache, WordTypes wordTypes, <any> valueKindFactory, ForeignCallDescriptor descriptor, Type ccType) Gets a calling convention for a given descriptor and call type.
boolean	destroysRegisters() Determines if the foreign call target destroys all registers.
void	finalizeAddress(Backend backend)
long	getAddress()
HotSpotForeignCallDescriptor	getDescriptor()
HotSpotForeignCallLinkage.RegisterEffect	getEffect()
CallingConvention	getIncomingCallingConvention() Gets the details of where parameters are passed and value(s) are returned from the callee's perspective.
long	getMaxCallTargetOffset() Returns the maximum absolute offset of a PC relative call to this stub from any position in the code cache or -1 when not applicable.
CallingConvention	getOutgoingCallingConvention() Gets the details of where parameters are passed and value(s) are returned from the caller's perspective.
Stub	getStub() Gets the stub, if any, this foreign call links to.
String	getSymbol() Gets the VM symbol associated with the target address of the call.
Value[]	getTemporaries() Gets the values used/killed by this foreign call.
boolean	isCompiledStub() Determines if this is a call to a compiled stub.
boolean	mayContainFP() Determines if the runtime function or stub might use floating point registers.
boolean	needsClearUpperVectorRegisters() Returns true if further cleanup on the float registers is needed after performing the foreign call.
boolean	needsDebugInfo() Determines if debug info needs to be associated with this call.
boolean	needsJavaFrameAnchor() Determines if a JavaFrameAnchor needs to be set up and torn down around this call.
void	setCompiledStub(Stub stub)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

descriptor

protected final HotSpotForeignCallDescriptor descriptor

The descriptor of the call.

Constructor Detail

HotSpotForeignCallLinkageImpl

public HotSpotForeignCallLinkageImpl(HotSpotForeignCallDescriptor descriptor,
                                     long address,
                                     HotSpotForeignCallLinkage.RegisterEffect effect,
                                     CallingConvention outgoingCallingConvention,
                                     CallingConvention incomingCallingConvention)

Method Detail

create

public static HotSpotForeignCallLinkage create(MetaAccessProvider metaAccess,
                                               CodeCacheProvider codeCache,
                                               WordTypes wordTypes,
                                               HotSpotForeignCallsProvider foreignCalls,
                                               HotSpotForeignCallDescriptor descriptor,
                                               long address,
                                               HotSpotForeignCallLinkage.RegisterEffect effect,
                                               Type outgoingCcType,
                                               Type incomingCcType)

Creates a HotSpotForeignCallLinkage.

Parameters:

descriptor - the descriptor of the call

address - the address of the code to call

effect - specifies if the call destroys or preserves all registers (apart from temporaries which are always destroyed)

outgoingCcType - outgoing (caller) calling convention type

incomingCcType - incoming (callee) calling convention type (can be null)

createCallingConvention

public static CallingConvention createCallingConvention(MetaAccessProvider metaAccess,
                                                        CodeCacheProvider codeCache,
                                                        WordTypes wordTypes,
                                                        <any> valueKindFactory,
                                                        ForeignCallDescriptor descriptor,
                                                        Type ccType)

Gets a calling convention for a given descriptor and call type.

toString

public String toString()

getEffect

public HotSpotForeignCallLinkage.RegisterEffect getEffect()

Specified by:

getEffect in interface HotSpotForeignCallLinkage

getOutgoingCallingConvention

public CallingConvention getOutgoingCallingConvention()

Description copied from interface: ForeignCallLinkage

Gets the details of where parameters are passed and value(s) are returned from the caller's perspective.

Specified by:

getOutgoingCallingConvention in interface ForeignCallLinkage

getIncomingCallingConvention

public CallingConvention getIncomingCallingConvention()

Description copied from interface: ForeignCallLinkage

Gets the details of where parameters are passed and value(s) are returned from the callee's perspective.

Specified by:

getIncomingCallingConvention in interface ForeignCallLinkage

getTemporaries

public Value[] getTemporaries()

Description copied from interface: ForeignCallLinkage

Gets the values used/killed by this foreign call.

Specified by:

getTemporaries in interface ForeignCallLinkage

getMaxCallTargetOffset

public long getMaxCallTargetOffset()

Description copied from interface: ForeignCallLinkage

Returns the maximum absolute offset of a PC relative call to this stub from any position in the code cache or -1 when not applicable. Intended for determining the required size of address/offset fields.

Specified by:

getMaxCallTargetOffset in interface ForeignCallLinkage

getDescriptor

public HotSpotForeignCallDescriptor getDescriptor()

Specified by:

getDescriptor in interface ForeignCallLinkage

Specified by:

getDescriptor in interface HotSpotForeignCallLinkage

setCompiledStub

public void setCompiledStub(Stub stub)

Specified by:

setCompiledStub in interface HotSpotForeignCallLinkage

isCompiledStub

public boolean isCompiledStub()

Determines if this is a call to a compiled stub.

Specified by:

isCompiledStub in interface HotSpotForeignCallLinkage

getStub

public Stub getStub()

Description copied from interface: HotSpotForeignCallLinkage

Gets the stub, if any, this foreign call links to.

Specified by:

getStub in interface HotSpotForeignCallLinkage

finalizeAddress

public void finalizeAddress(Backend backend)

Specified by:

finalizeAddress in interface HotSpotForeignCallLinkage

getAddress

public long getAddress()

Specified by:

getAddress in interface HotSpotForeignCallLinkage

destroysRegisters

public boolean destroysRegisters()

Description copied from interface: ForeignCallLinkage

Determines if the foreign call target destroys all registers.

Specified by:

destroysRegisters in interface ForeignCallLinkage

Returns:

true if the register allocator must save all live registers around a call to this target

needsDebugInfo

public boolean needsDebugInfo()

Description copied from interface: ForeignCallLinkage

Determines if debug info needs to be associated with this call. Debug info is required if the function can raise an exception, try to lock, trigger GC or do anything else that requires the VM to be able to inspect the thread's execution state.

Specified by:

needsDebugInfo in interface ForeignCallLinkage

mayContainFP

public boolean mayContainFP()

Description copied from interface: HotSpotForeignCallLinkage

Determines if the runtime function or stub might use floating point registers. If the answer is no, then no FPU state management prologue or epilogue needs to be emitted around the call.

Specified by:

mayContainFP in interface HotSpotForeignCallLinkage

needsJavaFrameAnchor

public boolean needsJavaFrameAnchor()

Description copied from interface: HotSpotForeignCallLinkage

Determines if a JavaFrameAnchor needs to be set up and torn down around this call.

Specified by:

needsJavaFrameAnchor in interface HotSpotForeignCallLinkage

getSymbol

public String getSymbol()

Description copied from interface: HotSpotForeignCallLinkage

Gets the VM symbol associated with the target address of the call.

Specified by:

getSymbol in interface HotSpotForeignCallLinkage

needsClearUpperVectorRegisters

public boolean needsClearUpperVectorRegisters()

Description copied from interface: ForeignCallLinkage

Returns true if further cleanup on the float registers is needed after performing the foreign call. This is critical on AMD64 as there is a performance penalty switching between legacy SSE and AVX instruction while the upper halves of the xmm registers are not zero.

Specified by:

needsClearUpperVectorRegisters in interface ForeignCallLinkage