com.oracle.truffle.nfi.spi

Class NativeSymbolLibrary

java.lang.Object

com.oracle.truffle.api.nodes.Node

com.oracle.truffle.api.library.Library

com.oracle.truffle.nfi.spi.NativeSymbolLibrary

All Implemented Interfaces:

com.oracle.truffle.api.nodes.NodeInterface, Cloneable

public abstract class NativeSymbolLibrary
extends com.oracle.truffle.api.library.Library

Library that specifies the protocol between the Truffle NFI and its backend implementations. Symbols contained in native libraries should implement this library.

See Also:

NFIBackendTools.createBindableSymbol(java.lang.Object)

Nested Class Summary

Nested classes/interfaces inherited from class com.oracle.truffle.api.nodes.Node

com.oracle.truffle.api.nodes.Node.Child, com.oracle.truffle.api.nodes.Node.Children

Constructor Summary

Constructors

Constructor and Description
NativeSymbolLibrary()

Method Summary

Modifier and Type	Method and Description
Object	call(Object receiver, Object signature, Object... args) Call a native function with a specified signature.
boolean	isBindable(Object receiver) Returns true if the receiver is a native symbol that can be bound to a signature and subsequently called.
Object	prepareSignature(Object receiver, NativeSignature signature) Prepare a signature for use by the NFI backend.

Methods inherited from class com.oracle.truffle.api.library.Library

accepts

Methods inherited from class com.oracle.truffle.api.nodes.Node

accept, adoptChildren, atomic, atomic, copy, deepCopy, getChildren, getCost, getDebugProperties, getDescription, getEncapsulatingSourceSection, getLock, getParent, getRootNode, getSourceSection, insert, insert, isAdoptable, isSafelyReplaceableBy, lookupContextReference, lookupLanguageReference, notifyInserted, onReplace, replace, replace, reportPolymorphicSpecialize, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NativeSymbolLibrary

public NativeSymbolLibrary()

Method Detail

isBindable

public boolean isBindable(Object receiver)

Returns true if the receiver is a native symbol that can be bound to a signature and subsequently called.

prepareSignature

public Object prepareSignature(Object receiver,
                               NativeSignature signature)
                        throws com.oracle.truffle.api.interop.UnsupportedMessageException,
                               com.oracle.truffle.api.interop.UnsupportedTypeException

Prepare a signature for use by the NFI backend. This message is sent when binding a signature to a receiver. The NFI backend should allocate any data structures needed for calling symbols with this signature. The signature returned by this method will be cached, and may be reused for different receivers.

Throws:

com.oracle.truffle.api.interop.UnsupportedMessageException

com.oracle.truffle.api.interop.UnsupportedTypeException

call

public Object call(Object receiver,
                   Object signature,
                   Object... args)
            throws com.oracle.truffle.api.interop.ArityException,
                   com.oracle.truffle.api.interop.UnsupportedMessageException,
                   com.oracle.truffle.api.interop.UnsupportedTypeException

Call a native function with a specified signature. The signature is guaranteed to be an object produced by the NativeSymbolLibrary.prepareSignature(java.lang.Object, com.oracle.truffle.nfi.spi.types.NativeSignature) message of this library, but not necessarily with the same receiver symbol.

Throws:

com.oracle.truffle.api.interop.ArityException

com.oracle.truffle.api.interop.UnsupportedMessageException

com.oracle.truffle.api.interop.UnsupportedTypeException