com.oracle.truffle.nfi.backend.panama.PanamaSignature Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of truffle-nfi-panama Show documentation
Show all versions of truffle-nfi-panama Show documentation
Implementation of the Truffle NFI using CLinker from project panama.
/*
* Copyright (c) 2017, 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.backend.panama;
import com.oracle.truffle.api.CallTarget;
import com.oracle.truffle.api.CompilerAsserts;
import com.oracle.truffle.api.CompilerDirectives;
import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
import com.oracle.truffle.api.dsl.Bind;
import com.oracle.truffle.api.dsl.Cached;
import com.oracle.truffle.api.dsl.GenerateAOT;
import com.oracle.truffle.api.dsl.ImportStatic;
import com.oracle.truffle.api.dsl.Specialization;
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.library.ExportLibrary;
import com.oracle.truffle.api.library.ExportMessage;
import com.oracle.truffle.api.nodes.Node;
import com.oracle.truffle.api.profiles.InlinedBranchProfile;
import com.oracle.truffle.nfi.backend.panama.FunctionExecuteNodeGen.SignatureExecuteNodeGen;
import com.oracle.truffle.nfi.backend.spi.NFIBackendSignatureBuilderLibrary;
import com.oracle.truffle.nfi.backend.spi.NFIBackendSignatureLibrary;
import com.oracle.truffle.nfi.backend.spi.types.NativeSimpleType;
import com.oracle.truffle.nfi.backend.spi.util.ProfiledArrayBuilder;
import com.oracle.truffle.nfi.backend.spi.util.ProfiledArrayBuilder.ArrayBuilderFactory;
import com.oracle.truffle.nfi.backend.spi.util.ProfiledArrayBuilder.ArrayFactory;
import com.oracle.truffle.nfi.backend.panama.PanamaClosure.MonomorphicClosureInfo;
import com.oracle.truffle.nfi.backend.panama.PanamaClosure.PolymorphicClosureInfo;
import java.lang.foreign.Arena;
import java.lang.foreign.FunctionDescriptor;
import java.lang.foreign.Linker;
import java.lang.foreign.MemorySegment;
import java.lang.invoke.MethodHandle;
import java.lang.invoke.MethodType;
@ExportLibrary(value = NFIBackendSignatureLibrary.class, useForAOT = false)
final class PanamaSignature {
@TruffleBoundary
public static PanamaSignature create(PanamaNFIContext context, CachedSignatureInfo info, MethodType upcallType) {
return new PanamaSignature(info.functionDescriptor, upcallType, info);
}
private final @SuppressWarnings("preview") FunctionDescriptor functionDescriptor;
final CachedSignatureInfo signatureInfo;
private final MethodType upcallType;
PanamaSignature(@SuppressWarnings("preview") FunctionDescriptor functionDescriptor, MethodType upcallType, CachedSignatureInfo signatureInfo) {
this.functionDescriptor = functionDescriptor;
this.upcallType = upcallType;
this.signatureInfo = signatureInfo;
}
@ExportMessage
static final class Call {
@Specialization
static Object callPanama(PanamaSignature self, PanamaSymbol functionPointer, Object[] args,
@Cached.Exclusive @Cached FunctionExecuteNode functionExecute) throws ArityException, UnsupportedTypeException {
long pointer = functionPointer.asPointer();
return functionExecute.execute(pointer, self, args);
}
@Specialization(limit = "3")
@GenerateAOT.Exclude
static Object callGeneric(PanamaSignature self, Object functionPointer, Object[] args,
@CachedLibrary("functionPointer") InteropLibrary interop,
@Bind("$node") Node node,
@Cached InlinedBranchProfile isExecutable,
@Cached InlinedBranchProfile toNative,
@Cached InlinedBranchProfile error,
@Cached.Exclusive @Cached FunctionExecuteNode functionExecute) throws ArityException, UnsupportedTypeException {
if (interop.isExecutable(functionPointer)) {
// This branch can be invoked when SignatureLibrary is used to invoke a function
// pointer without prior engaging the interop to execute executable function
// pointers. It may happen, for example, in SVM for function substitutes.
try {
isExecutable.enter(node);
return interop.execute(functionPointer, args);
} catch (UnsupportedMessageException e) {
error.enter(node);
throw UnsupportedTypeException.create(new Object[]{functionPointer}, "functionPointer was executable but threw UnsupportedMessageException on execute()");
}
}
if (!interop.isPointer(functionPointer)) {
toNative.enter(node);
interop.toNative(functionPointer);
}
long pointer;
try {
pointer = interop.asPointer(functionPointer);
} catch (UnsupportedMessageException e) {
error.enter(node);
throw UnsupportedTypeException.create(new Object[]{functionPointer}, "functionPointer is not executable and not a pointer");
}
return functionExecute.execute(pointer, self, args);
}
}
MethodType getUpcallMethodType() {
return upcallType;
}
@TruffleBoundary
@SuppressWarnings({"preview", "restricted"})
MemorySegment bind(MethodHandle cachedHandle, Object receiver) {
MethodHandle bound = cachedHandle.bindTo(receiver);
@SuppressWarnings("preview")
Arena arena = PanamaNFIContext.get(null).getContextArena();
return Linker.nativeLinker().upcallStub(bound, functionDescriptor, arena);
}
@ExportMessage
@ImportStatic(PanamaNFILanguage.class)
static final class CreateClosure {
@Specialization(guards = {"signature.signatureInfo == cachedSignatureInfo", "executable == cachedExecutable"}, assumptions = "getSingleContextAssumption()", limit = "3")
static PanamaClosure doCachedExecutable(PanamaSignature signature, Object executable,
@Cached("signature.signatureInfo") CachedSignatureInfo cachedSignatureInfo,
@Cached("executable") Object cachedExecutable,
@Cached("create(cachedSignatureInfo, cachedExecutable)") MonomorphicClosureInfo cachedClosureInfo) {
assert signature.signatureInfo == cachedSignatureInfo && executable == cachedExecutable;
// no need to cache duplicated allocation in the single-context case
// the NFI frontend is taking care of that already
MethodHandle cachedHandle = cachedClosureInfo.handle.asType(signature.getUpcallMethodType());
@SuppressWarnings("preview")
MemorySegment ret = signature.bind(cachedHandle, cachedExecutable);
return new PanamaClosure(ret);
}
@Specialization(replaces = "doCachedExecutable", guards = "signature.signatureInfo == cachedSignatureInfo", limit = "3")
static PanamaClosure doCachedSignature(PanamaSignature signature, Object executable,
@Cached("signature.signatureInfo") CachedSignatureInfo cachedSignatureInfo,
@Cached("create(cachedSignatureInfo)") PolymorphicClosureInfo cachedClosureInfo) {
assert signature.signatureInfo == cachedSignatureInfo;
MethodHandle cachedHandle = cachedClosureInfo.handle.asType(signature.getUpcallMethodType());
@SuppressWarnings("preview")
MemorySegment ret = signature.bind(cachedHandle, executable);
return new PanamaClosure(ret);
}
@TruffleBoundary
@Specialization(replaces = "doCachedSignature")
static PanamaClosure createClosure(PanamaSignature signature, Object executable) {
PolymorphicClosureInfo cachedClosureInfo = PolymorphicClosureInfo.create(signature.signatureInfo);
MethodHandle cachedHandle = cachedClosureInfo.handle.asType(signature.getUpcallMethodType());
@SuppressWarnings("preview")
MemorySegment ret = signature.bind(cachedHandle, executable);
return new PanamaClosure(ret);
}
}
@ExportLibrary(NFIBackendSignatureBuilderLibrary.class)
static final class PanamaSignatureBuilder {
MethodType downcallType;
MethodType upcallType;
PanamaType retType;
ArgsState argsState;
ProfiledArrayBuilder argTypes;
private static final ArrayFactory FACTORY = PanamaType[]::new;
void addArg(PanamaType arg, ArgsState newState) {
assert argsState.argCount + 1 == newState.argCount;
argTypes.add(arg);
argsState = newState;
}
PanamaSignatureBuilder(ArrayBuilderFactory factory) {
argsState = ArgsState.NO_ARGS;
argTypes = factory.allocate(FACTORY);
downcallType = MethodType.methodType(void.class);
upcallType = MethodType.methodType(void.class, Object.class);
}
@ExportMessage
void setReturnType(Object t) {
PanamaType type = (PanamaType) t;
retType = type;
downcallType = downcallType.changeReturnType(type.javaType);
upcallType = upcallType.changeReturnType(type.javaRetType);
}
@ExportMessage
static class AddArgument {
@Specialization(guards = {"builder.argsState == oldState", "type == cachedType"}, limit = "1")
static void doCached(PanamaSignatureBuilder builder, PanamaType type,
@Cached("type") PanamaType cachedType,
@Cached("builder.argsState") ArgsState oldState,
@Cached("oldState.addArg(cachedType)") ArgsState newState) {
assert builder.argsState == oldState && type == cachedType;
builder.addArg(cachedType, newState);
builder.downcallType = builder.downcallType.appendParameterTypes(type.javaType);
builder.upcallType = builder.upcallType.appendParameterTypes(type.javaType);
}
@Specialization(replaces = "doCached")
static void doGeneric(PanamaSignatureBuilder builder, PanamaType type) {
ArgsState newState = builder.argsState.addArg(type);
builder.addArg(type, newState);
}
}
@ExportMessage
void makeVarargs() {
throw new UnsupportedOperationException("Cannot make varargs because varargs are not implemented.");
}
@ExportMessage
@ImportStatic(PanamaSignature.class)
static class Build {
@Specialization(guards = {"builder.argsState == cachedState", "builder.retType == cachedRetType"}, limit = "3")
static Object doCached(PanamaSignatureBuilder builder,
@Cached("builder.retType") @SuppressWarnings("unused") PanamaType cachedRetType,
@Cached("builder.argsState") @SuppressWarnings("unused") ArgsState cachedState,
@CachedLibrary("builder") NFIBackendSignatureBuilderLibrary self,
@Cached("prepareSignatureInfo(cachedRetType, cachedState)") CachedSignatureInfo cachedSignatureInfo) {
return create(PanamaNFIContext.get(self), cachedSignatureInfo, builder.upcallType);
}
@Specialization(replaces = "doCached")
static Object doGeneric(PanamaSignatureBuilder builder,
@CachedLibrary("builder") NFIBackendSignatureBuilderLibrary self) {
CachedSignatureInfo sigInfo = prepareSignatureInfo(builder.retType, builder.argsState);
return create(PanamaNFIContext.get(self), sigInfo, builder.upcallType);
}
}
}
@TruffleBoundary
@SuppressWarnings("unused")
public static CachedSignatureInfo prepareSignatureInfo(PanamaType retType, ArgsState state) {
PanamaType[] argTypes = new PanamaType[state.argCount];
ArgsState curState = state;
for (int i = state.argCount - 1; i >= 0; i--) {
argTypes[i] = curState.lastArg;
curState = curState.prev;
}
@SuppressWarnings("preview")
FunctionDescriptor descriptor = createDescriptor(argTypes, retType);
MethodHandle downcallHandle = createDowncallHandle(descriptor);
return new CachedSignatureInfo(PanamaNFILanguage.get(null), retType, argTypes, descriptor, downcallHandle);
}
private static @SuppressWarnings("preview") FunctionDescriptor createDescriptor(PanamaType[] argTypes, PanamaType retType) {
@SuppressWarnings("preview")
FunctionDescriptor descriptor = FunctionDescriptor.ofVoid();
if (retType.nativeLayout == null) {
descriptor = descriptor.dropReturnLayout();
} else {
descriptor = descriptor.changeReturnLayout(retType.nativeLayout);
}
for (PanamaType argType : argTypes) {
descriptor = descriptor.appendArgumentLayouts(argType.nativeLayout);
}
return descriptor;
}
static MethodHandle createDowncallHandle(@SuppressWarnings("preview") FunctionDescriptor descriptor) {
int parameterCount = descriptor.argumentLayouts().size();
@SuppressWarnings({"preview", "restricted"})
MethodHandle handle = Linker.nativeLinker().downcallHandle(descriptor).asSpreader(Object[].class, parameterCount).asType(
MethodType.methodType(Object.class, new Class[]{MemorySegment.class, Object[].class}));
return handle;
}
static final class ArgsState {
static final ArgsState NO_ARGS = new ArgsState(0, null, null);
final int argCount;
final PanamaType lastArg;
final ArgsState prev;
ArgsState(int argCount, PanamaType lastArg, ArgsState prev) {
this.argCount = argCount;
this.lastArg = lastArg;
this.prev = prev;
}
ArgsState addArg(PanamaType type) {
return new ArgsState(argCount + 1, type, this);
}
}
static final class CachedSignatureInfo {
final PanamaType retType;
final PanamaType[] argTypes;
final @SuppressWarnings("preview") FunctionDescriptor functionDescriptor;
final CallTarget callTarget;
final MethodHandle downcallHandle;
CachedSignatureInfo(PanamaNFILanguage language, PanamaType retType, PanamaType[] argTypes, @SuppressWarnings("preview") FunctionDescriptor functionDescriptor,
MethodHandle downcallHandle) {
this.retType = retType;
this.argTypes = argTypes;
this.functionDescriptor = functionDescriptor;
this.downcallHandle = downcallHandle;
this.callTarget = SignatureExecuteNodeGen.create(language, this).getCallTarget();
}
PanamaType[] getArgTypes() {
return argTypes;
}
PanamaType getRetType() {
return retType;
}
Object execute(PanamaSignature signature, Object[] args, @SuppressWarnings("preview") MemorySegment segment) {
assert signature.signatureInfo == this;
CompilerAsserts.partialEvaluationConstant(retType);
ErrorContext ctx = PanamaNFILanguage.get(null).errorContext.get();
try {
int errnoMirror = ctx.getErrno();
if (ctx.nativeErrnoSet()) {
ctx.setErrno(ctx.getNativeErrno());
}
Object result = (Object) downcallHandle.invokeExact(segment, args);
ctx.setNativeErrno(ctx.getErrno());
ctx.setErrno(errnoMirror);
if (result == null) {
return NativePointer.NULL;
} else if (retType.type == NativeSimpleType.STRING) {
@SuppressWarnings("preview")
long pointer = ((MemorySegment) result).address();
return new NativeString(pointer);
} else if (retType.type == NativeSimpleType.POINTER) {
return NativePointer.create((long) result);
} else {
return result;
}
} catch (Throwable t) {
CompilerDirectives.transferToInterpreterAndInvalidate();
throw new IllegalStateException(t);
}
}
}
}