com.oracle.truffle.nfi.CallSignatureNode Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of truffle-nfi Show documentation
Show all versions of truffle-nfi Show documentation
Native function interface for the Truffle framework.
/*
* Copyright (c) 2020, 2024, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Universal Permissive License (UPL), Version 1.0
*
* Subject to the condition set forth below, permission is hereby granted to any
* person obtaining a copy of this software, associated documentation and/or
* data (collectively the "Software"), free of charge and under any and all
* copyright rights in the Software, and any and all patent rights owned or
* freely licensable by each licensor hereunder covering either (i) the
* unmodified Software as contributed to or provided by such licensor, or (ii)
* the Larger Works (as defined below), to deal in both
*
* (a) the Software, and
*
* (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
* one is included with the Software each a "Larger Work" to which the Software
* is contributed by such licensors),
*
* without restriction, including without limitation the rights to copy, create
* derivative works of, display, perform, and distribute the Software and make,
* use, sell, offer for sale, import, export, have made, and have sold the
* Software and the Larger Work(s), and to sublicense the foregoing rights on
* either these or other terms.
*
* This license is subject to the following condition:
*
* The above copyright notice and either this complete permission notice or at a
* minimum a reference to the UPL must be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package com.oracle.truffle.nfi;
import com.oracle.truffle.api.CompilerDirectives.CompilationFinal;
import com.oracle.truffle.api.dsl.Bind;
import com.oracle.truffle.api.dsl.Cached;
import com.oracle.truffle.api.dsl.Fallback;
import com.oracle.truffle.api.dsl.GenerateAOT;
import com.oracle.truffle.api.dsl.GenerateCached;
import com.oracle.truffle.api.dsl.GenerateInline;
import com.oracle.truffle.api.dsl.GenerateUncached;
import com.oracle.truffle.api.dsl.NeverDefault;
import com.oracle.truffle.api.dsl.ReportPolymorphism;
import com.oracle.truffle.api.dsl.Specialization;
import com.oracle.truffle.api.frame.VirtualFrame;
import com.oracle.truffle.api.interop.ArityException;
import com.oracle.truffle.api.interop.InteropLibrary;
import com.oracle.truffle.api.interop.UnsupportedMessageException;
import com.oracle.truffle.api.interop.UnsupportedTypeException;
import com.oracle.truffle.api.library.CachedLibrary;
import com.oracle.truffle.api.nodes.ExplodeLoop;
import com.oracle.truffle.api.nodes.IndirectCallNode;
import com.oracle.truffle.api.nodes.Node;
import com.oracle.truffle.api.nodes.RootNode;
import com.oracle.truffle.api.profiles.InlinedBranchProfile;
import com.oracle.truffle.nfi.CallSignatureNodeFactory.OptimizedCallClosureNodeGen;
import com.oracle.truffle.nfi.CallSignatureNodeFactory.OptimizedCallSignatureNodeGen;
import com.oracle.truffle.nfi.ConvertTypeNode.ConvertFromNativeNode;
import com.oracle.truffle.nfi.ConvertTypeNode.ConvertToNativeNode;
import com.oracle.truffle.nfi.NFISignature.ArgsCachedState;
import com.oracle.truffle.nfi.NFISignature.SignatureCachedState;
import com.oracle.truffle.nfi.NFIType.TypeCachedState;
import com.oracle.truffle.nfi.backend.spi.NFIBackendSignatureLibrary;
@GenerateAOT
abstract class CallSignatureNode extends Node {
abstract Object execute(NFISignature signature, Object function, Object[] args) throws ArityException, UnsupportedTypeException, UnsupportedMessageException;
@GenerateUncached
@GenerateInline(false)
abstract static class CachedCallSignatureNode extends CallSignatureNode {
@Specialization(guards = {"cachedState != null", "signature.cachedState == cachedState"}, limit = "3")
Object doOptimizedDirect(NFISignature signature, Object function, Object[] args,
@Cached("signature.cachedState") SignatureCachedState cachedState,
@Cached("cachedState.createOptimizedSignatureCall()") CallSignatureNode call) throws ArityException, UnsupportedTypeException, UnsupportedMessageException {
try {
assert cachedState == signature.cachedState;
return call.execute(signature, function, args);
} finally {
/*
* Rethrow pending exceptions from upcalls. This might swallow other pending
* exceptions at this point. But all exceptions that might be pending here come the
* marshalling of the return value. If there is a pending exception, we essentially
* pretend that the return value handling never happened, since the return value is
* usused anyway.
*/
NFILanguage.get(this).rethrowPendingException();
}
}
@ReportPolymorphism.Megamorphic
@Specialization(replaces = "doOptimizedDirect", guards = "signature.cachedState != null")
Object doOptimizedIndirect(NFISignature signature, Object function, Object[] args,
@Cached IndirectCallNode call) {
try {
return call.call(signature.cachedState.getPolymorphicSignatureCall(), signature, function, args);
} finally {
// rethrow pending exceptions from upcalls (see also comment in doOptimizedDirect)
NFILanguage.get(this).rethrowPendingException();
}
}
@ReportPolymorphism.Megamorphic
@Specialization(guards = "signature.cachedState == null")
static Object doSlowPath(NFISignature signature, Object function, Object[] args,
@Bind("this") Node node,
@Cached InlinedBranchProfile exception,
@Cached ConvertToNativeNode convertArg,
@Cached ConvertFromNativeNode convertRet,
@CachedLibrary(limit = "3") NFIBackendSignatureLibrary nativeLibrary,
@Cached BackendSymbolUnwrapNode backendSymbolUnwrapNode) throws ArityException, UnsupportedTypeException, UnsupportedMessageException {
try {
if (args.length != signature.managedArgCount) {
exception.enter(node);
throw ArityException.create(signature.managedArgCount, signature.managedArgCount, args.length);
}
Object[] preparedArgs = new Object[signature.nativeArgCount];
int argIdx = 0;
for (int i = 0; i < preparedArgs.length; i++) {
Object input = null;
if (signature.argTypes[i].cachedState.managedArgCount == 1) {
input = args[argIdx++];
}
preparedArgs[i] = convertArg.executeInlined(node, signature.argTypes[i], input);
}
Object ret = nativeLibrary.call(signature.nativeSignature, backendSymbolUnwrapNode.execute(node, function), preparedArgs);
return convertRet.executeInlined(node, signature.retType, ret);
} finally {
// rethrow pending exceptions from upcalls
NFILanguage.get(node).rethrowPendingException();
}
}
}
@NeverDefault
static CallSignatureNode createOptimizedCall(TypeCachedState retType, ArgsCachedState argsState) {
return OptimizedCallSignatureNodeGen.create(retType, argsState);
}
@NeverDefault
static CallSignatureNode createOptimizedClosure(TypeCachedState retType, ArgsCachedState argsState) {
return OptimizedCallClosureNodeGen.create(retType, argsState);
}
abstract static class OptimizedCallSignatureNode extends CallSignatureNode {
@Child ConvertTypeNode convertRet;
@CompilationFinal(dimensions = 1) final TypeCachedState[] argTypes;
@Children final ConvertTypeNode[] convertArgs;
private final int managedArgCount;
OptimizedCallSignatureNode(TypeCachedState retType, ArgsCachedState argsState) {
this.convertRet = retType.createFromNative();
this.argTypes = new TypeCachedState[argsState.nativeArgCount];
this.convertArgs = new ConvertTypeNode[argsState.nativeArgCount];
this.managedArgCount = argsState.managedArgCount;
ArgsCachedState cur = argsState;
for (int i = argsState.nativeArgCount - 1; i >= 0; i--) {
argTypes[i] = cur.argType;
convertArgs[i] = cur.argType.createToNative();
cur = cur.prev;
}
}
@ExplodeLoop
Object[] prepareArgs(NFISignature signature, Object[] args) throws UnsupportedTypeException {
Object[] preparedArgs = new Object[convertArgs.length];
int argIdx = 0;
for (int i = 0; i < convertArgs.length; i++) {
Object input = null;
if (argTypes[i].managedArgCount == 1) {
input = args[argIdx++];
}
preparedArgs[i] = convertArgs[i].execute(signature.argTypes[i], input);
}
assert argIdx == managedArgCount;
return preparedArgs;
}
@Specialization
Object doCall(NFISignature signature, Object function, Object[] args,
@Cached InlinedBranchProfile exception,
@CachedLibrary(limit = "1") NFIBackendSignatureLibrary backendLibrary,
@Cached BackendSymbolUnwrapNode backendSymbolUnwrapNode) throws ArityException, UnsupportedTypeException, UnsupportedMessageException {
if (args.length != managedArgCount) {
exception.enter(this);
throw ArityException.create(managedArgCount, managedArgCount, args.length);
}
Object[] preparedArgs = prepareArgs(signature, args);
Object ret = backendLibrary.call(signature.nativeSignature, backendSymbolUnwrapNode.execute(this, function), preparedArgs);
return convertRet.execute(signature.retType, ret);
}
}
abstract static class OptimizedCallClosureNode extends CallSignatureNode {
@Child ConvertTypeNode convertRet;
@CompilationFinal(dimensions = 1) final TypeCachedState[] argTypes;
@Children final ConvertTypeNode[] convertArgs;
final int managedArgCount;
OptimizedCallClosureNode(TypeCachedState retType, ArgsCachedState argsState) {
this.convertRet = retType.createToNative();
this.argTypes = new TypeCachedState[argsState.nativeArgCount];
this.convertArgs = new ConvertTypeNode[argsState.nativeArgCount];
this.managedArgCount = argsState.managedArgCount;
ArgsCachedState cur = argsState;
for (int i = argsState.nativeArgCount - 1; i >= 0; i--) {
argTypes[i] = cur.argType;
convertArgs[i] = cur.argType.createFromNative();
cur = cur.prev;
}
}
@ExplodeLoop
Object[] prepareArgs(NFISignature signature, Object[] args) throws UnsupportedTypeException {
Object[] preparedArgs = new Object[managedArgCount];
int argIdx = 0;
for (int i = 0; i < convertArgs.length; i++) {
if (argTypes[i].managedArgCount == 1) {
preparedArgs[argIdx++] = convertArgs[i].execute(signature.argTypes[i], args[i]);
}
}
assert argIdx == managedArgCount;
return preparedArgs;
}
@SuppressWarnings("truffle-static-method")
@Specialization(limit = "1")
@GenerateAOT.Exclude
Object doCall(NFISignature signature, Object function, Object[] args,
@Bind("this") Node node,
@Cached InlinedBranchProfile exception,
@CachedLibrary("function") InteropLibrary interop) throws ArityException, UnsupportedTypeException, UnsupportedMessageException {
if (args.length != convertArgs.length) {
exception.enter(node);
throw ArityException.create(convertArgs.length, convertArgs.length, args.length);
}
Object[] preparedArgs = prepareArgs(signature, args);
Object ret = interop.execute(function, preparedArgs);
return convertRet.execute(signature.retType, ret);
}
}
static final class CallSignatureRootNode extends RootNode {
@Child CallSignatureNode callSignature;
CallSignatureRootNode(NFILanguage language, CallSignatureNode callSignature) {
super(language);
this.callSignature = callSignature;
}
@Override
public Object execute(VirtualFrame frame) {
NFISignature signature = (NFISignature) frame.getArguments()[0];
Object function = frame.getArguments()[1];
Object[] args = (Object[]) frame.getArguments()[2];
try {
return callSignature.execute(signature, function, args);
} catch (ArityException | UnsupportedTypeException | UnsupportedMessageException e) {
// The caller of the resulting CallTarget is always CachedCallSignatureNode.
// These exceptions are declared to be thrown there.
throw silenceException(RuntimeException.class, e);
}
}
@SuppressWarnings({"unchecked", "unused"})
static RuntimeException silenceException(Class type, Exception ex) throws E {
throw (E) ex;
}
}
@GenerateAOT
@GenerateUncached
@GenerateCached(false)
@GenerateInline
abstract static class BackendSymbolUnwrapNode extends Node {
abstract Object execute(Node node, Object symbol);
@Specialization
Object unwrapNFISymbol(NFISymbol symbol) {
return symbol.nativeSymbol;
}
@Fallback
Object noUnwrap(Object symbol) {
return symbol;
}
}
}