org.graalvm.compiler.core.common.spi

Class ForeignCallDescriptor

java.lang.Object

org.graalvm.compiler.core.common.spi.ForeignCallDescriptor

Direct Known Subclasses:

HotSpotForeignCallDescriptor

public class ForeignCallDescriptor
extends Object

The information required for high level code generation of a foreign call. A foreign call differs from a normal compiled Java call in at least one of these aspects:

• The call is to C/C++/assembler code.
• The call uses different conventions for passing parameters or returning values.
• The callee has different register saving semantics. For example, the callee may save all registers (apart from some specified temporaries) in which case the register allocator doesn't not need to spill all live registers around the call site.
• The call does not occur at an INVOKE* bytecode. Such a call could be transformed into a standard Java call if the foreign routine is a normal Java method and the runtime supports linking Java calls at arbitrary bytecodes.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canDeoptimize
protected boolean	isGuaranteedSafepoint
protected boolean	isReexecutable
protected org.graalvm.word.LocationIdentity[]	killedLocations
protected ForeignCallSignature	signature

Constructor Summary

Constructors

Constructor and Description
ForeignCallDescriptor(String name, Class<?> resultType, Class<?>[] argumentTypes, boolean isReexecutable, org.graalvm.word.LocationIdentity[] killedLocations, boolean canDeoptimize, boolean isGuaranteedSafepoint)

Method Summary

Modifier and Type	Method and Description
boolean	canDeoptimize() Determines if deoptimization can occur during a given foreign call.
boolean	equals(Object o)
Class<?>[]	getArgumentTypes()
org.graalvm.word.LocationIdentity[]	getKilledLocations() Gets the set of memory locations killed by a given foreign call.
String	getName()
Class<?>	getResultType()
ForeignCallSignature	getSignature()
int	hashCode()
boolean	isGuaranteedSafepoint() Identifies foreign calls which are guaranteed to include a safepoint check.
boolean	isReexecutable() Determines if a given foreign call is side-effect free.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

signature

protected final ForeignCallSignature signature

isReexecutable

protected final boolean isReexecutable

canDeoptimize

protected final boolean canDeoptimize

isGuaranteedSafepoint

protected final boolean isGuaranteedSafepoint

killedLocations

protected final org.graalvm.word.LocationIdentity[] killedLocations

Constructor Detail

ForeignCallDescriptor

public ForeignCallDescriptor(String name,
                             Class<?> resultType,
                             Class<?>[] argumentTypes,
                             boolean isReexecutable,
                             org.graalvm.word.LocationIdentity[] killedLocations,
                             boolean canDeoptimize,
                             boolean isGuaranteedSafepoint)

Method Detail

getSignature

public ForeignCallSignature getSignature()

getName

public String getName()

getResultType

public Class<?> getResultType()

getArgumentTypes

public Class<?>[] getArgumentTypes()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isReexecutable

public boolean isReexecutable()

Determines if a given foreign call is side-effect free. Deoptimization cannot return execution to a point before a foreign call that has a side effect.

getKilledLocations

public org.graalvm.word.LocationIdentity[] getKilledLocations()

Gets the set of memory locations killed by a given foreign call. Returning the special value LocationIdentity.any() denotes that the call kills all memory locations. Returning any empty array denotes that the call does not kill any memory locations.

canDeoptimize

public boolean canDeoptimize()

Determines if deoptimization can occur during a given foreign call.

isGuaranteedSafepoint

public boolean isGuaranteedSafepoint()

Identifies foreign calls which are guaranteed to include a safepoint check.

toString

public String toString()

Overrides:

toString in class Object