com.oracle.truffle.polyglot.HostInteropReflect Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of truffle-api Show documentation
Show all versions of truffle-api Show documentation
Truffle is a multi-language framework for executing dynamic languages
that achieves high performance when combined with Graal.
/*
* Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.oracle.truffle.polyglot;
import java.lang.invoke.MethodHandle;
import java.lang.invoke.MethodHandles;
import java.lang.invoke.MethodType;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.Proxy;
import java.lang.reflect.Type;
import java.util.Objects;
import org.graalvm.collections.EconomicSet;
import com.oracle.truffle.api.CallTarget;
import com.oracle.truffle.api.CompilerAsserts;
import com.oracle.truffle.api.CompilerDirectives;
import com.oracle.truffle.api.CompilerDirectives.CompilationFinal;
import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
import com.oracle.truffle.api.TruffleOptions;
import com.oracle.truffle.api.dsl.Cached;
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.ForeignAccess;
import com.oracle.truffle.api.interop.KeyInfo;
import com.oracle.truffle.api.interop.Message;
import com.oracle.truffle.api.interop.TruffleObject;
import com.oracle.truffle.api.interop.UnknownIdentifierException;
import com.oracle.truffle.api.interop.UnsupportedMessageException;
import com.oracle.truffle.api.interop.UnsupportedTypeException;
import com.oracle.truffle.api.nodes.Node;
import com.oracle.truffle.api.profiles.ConditionProfile;
import com.oracle.truffle.polyglot.PolyglotLanguageContext.ToGuestValuesNode;
final class HostInteropReflect {
static final Object[] EMPTY = {};
private HostInteropReflect() {
}
@CompilerDirectives.TruffleBoundary
static Class findInnerClass(Class clazz, String name) {
if (Modifier.isPublic(clazz.getModifiers())) {
for (Class t : clazz.getClasses()) {
// no support for non-static type members now
if (isStaticTypeOrInterface(t) && t.getSimpleName().equals(name)) {
return t;
}
}
}
return null;
}
static boolean isJNIName(String name) {
return name.contains("__");
}
@CompilerDirectives.TruffleBoundary
static HostMethodDesc findMethod(Class clazz, String name, boolean onlyStatic) {
if (TruffleOptions.AOT) {
return null;
}
HostClassDesc classDesc = HostClassDesc.forClass(clazz);
HostMethodDesc foundMethod = classDesc.lookupMethod(name, onlyStatic);
if (foundMethod == null && isJNIName(name)) {
foundMethod = classDesc.lookupMethodByJNIName(name, onlyStatic);
}
return foundMethod;
}
@CompilerDirectives.TruffleBoundary
static HostFieldDesc findField(Class clazz, String name, boolean onlyStatic) {
HostClassDesc classDesc = HostClassDesc.forClass(clazz);
return classDesc.lookupField(name, onlyStatic);
}
@CompilerDirectives.TruffleBoundary
static int findKeyInfo(Class clazz, String name, boolean onlyStatic) {
if (TruffleOptions.AOT) {
return 0;
}
boolean readable = false;
boolean writable = false;
boolean invocable = false;
boolean internal = false;
HostClassDesc classDesc = HostClassDesc.forClass(clazz);
HostMethodDesc foundMethod = classDesc.lookupMethod(name, onlyStatic);
if (foundMethod != null) {
readable = true;
invocable = true;
} else if (isJNIName(name)) {
foundMethod = classDesc.lookupMethodByJNIName(name, onlyStatic);
if (foundMethod != null) {
readable = true;
invocable = true;
internal = true;
}
}
if (!readable) {
HostFieldDesc foundField = classDesc.lookupField(name, onlyStatic);
if (foundField != null) {
readable = true;
writable = true;
}
}
if (onlyStatic) {
if (!readable) {
if ("class".equals(name)) {
readable = true;
}
}
if (!readable) {
Class innerClass = findInnerClass(clazz, name);
if (innerClass != null) {
readable = true;
}
}
}
if (readable) {
return KeyInfo.READABLE | (writable ? KeyInfo.MODIFIABLE : 0) | (invocable ? KeyInfo.INVOCABLE : 0) | (internal ? KeyInfo.INTERNAL : 0);
}
return 0;
}
@CompilerDirectives.TruffleBoundary
static T asJavaFunction(Class functionalType, TruffleObject function, PolyglotLanguageContext languageContext) {
assert isFunctionalInterface(functionalType);
Method functionalInterfaceMethod = functionalInterfaceMethod(functionalType);
final FunctionProxyHandler handler = new FunctionProxyHandler(function, functionalInterfaceMethod, languageContext);
Object obj = Proxy.newProxyInstance(functionalType.getClassLoader(), new Class[]{functionalType}, handler);
return functionalType.cast(obj);
}
@CompilerDirectives.TruffleBoundary
static boolean isFunctionalInterface(Class type) {
if (!type.isInterface() || type == TruffleObject.class) {
return false;
}
if (type.getAnnotation(FunctionalInterface.class) != null) {
return true;
} else if (functionalInterfaceMethod(type) != null) {
return true;
}
return false;
}
static Method functionalInterfaceMethod(Class functionalInterface) {
if (!functionalInterface.isInterface()) {
return null;
}
Method found = null;
for (Method m : functionalInterface.getMethods()) {
if (Modifier.isAbstract(m.getModifiers()) && !HostClassDesc.isObjectMethodOverride(m)) {
if (found != null) {
return null;
}
found = m;
}
}
return found;
}
static TruffleObject asTruffleViaReflection(Object obj, PolyglotLanguageContext languageContext) {
if (obj instanceof Proxy) {
return asTruffleObjectProxy(obj, languageContext);
}
return HostObject.forObject(obj, languageContext);
}
@CompilerDirectives.TruffleBoundary
private static TruffleObject asTruffleObjectProxy(Object obj, PolyglotLanguageContext languageContext) {
if (Proxy.isProxyClass(obj.getClass())) {
InvocationHandler h = Proxy.getInvocationHandler(obj);
if (h instanceof FunctionProxyHandler) {
return ((FunctionProxyHandler) h).functionObj;
} else if (h instanceof ObjectProxyHandler) {
return ((ObjectProxyHandler) h).obj;
}
}
return HostObject.forObject(obj, languageContext);
}
static Object newProxyInstance(Class clazz, TruffleObject obj, PolyglotLanguageContext languageContext) throws IllegalArgumentException {
return Proxy.newProxyInstance(clazz.getClassLoader(), new Class[]{clazz}, new ObjectProxyHandler(obj, languageContext, clazz));
}
static boolean isStaticTypeOrInterface(Class t) {
// anonymous classes are private, they should be eliminated elsewhere
return Modifier.isPublic(t.getModifiers()) && (t.isInterface() || t.isEnum() || Modifier.isStatic(t.getModifiers()));
}
@CompilerDirectives.TruffleBoundary
static String[] findUniquePublicMemberNames(Class clazz, boolean onlyStatic, boolean includeInternal) throws SecurityException {
HostClassDesc classDesc = HostClassDesc.forClass(clazz);
EconomicSet names = EconomicSet.create();
names.addAll(classDesc.getFieldNames(onlyStatic));
names.addAll(classDesc.getMethodNames(onlyStatic, includeInternal));
if (onlyStatic) {
names.add("class");
if (Modifier.isPublic(clazz.getModifiers())) {
// no support for non-static member types now
for (Class t : clazz.getClasses()) {
if (!isStaticTypeOrInterface(t)) {
continue;
}
names.add(t.getSimpleName());
}
}
}
return names.toArray(new String[names.size()]);
}
@SuppressWarnings({"unchecked"})
static RuntimeException rethrow(Throwable ex) throws E {
throw (E) ex;
}
public static Class getMethodReturnType(Method method) {
if (method == null || method.getReturnType() == void.class) {
return Object.class;
}
return method.getReturnType();
}
public static Type getMethodGenericReturnType(Method method) {
if (method == null || method.getReturnType() == void.class) {
return Object.class;
}
return method.getGenericReturnType();
}
static String jniName(Method m) {
StringBuilder sb = new StringBuilder();
noUnderscore(sb, m.getName()).append("__");
appendType(sb, m.getReturnType());
Class[] arr = m.getParameterTypes();
for (int i = 0; i < arr.length; i++) {
appendType(sb, arr[i]);
}
return sb.toString();
}
private static StringBuilder noUnderscore(StringBuilder sb, String name) {
return sb.append(name.replace("_", "_1").replace('.', '_'));
}
private static void appendType(StringBuilder sb, Class type) {
if (type == Integer.TYPE) {
sb.append('I');
return;
}
if (type == Long.TYPE) {
sb.append('J');
return;
}
if (type == Double.TYPE) {
sb.append('D');
return;
}
if (type == Float.TYPE) {
sb.append('F');
return;
}
if (type == Byte.TYPE) {
sb.append('B');
return;
}
if (type == Boolean.TYPE) {
sb.append('Z');
return;
}
if (type == Short.TYPE) {
sb.append('S');
return;
}
if (type == Void.TYPE) {
sb.append('V');
return;
}
if (type == Character.TYPE) {
sb.append('C');
return;
}
if (type.isArray()) {
sb.append("_3");
appendType(sb, type.getComponentType());
return;
}
noUnderscore(sb.append('L'), type.getName());
sb.append("_2");
}
}
class FunctionProxyNode extends HostEntryRootNode {
final Class receiverClass;
final Method method;
@Child private PolyglotExecuteNode executeNode;
@CompilationFinal private Class returnClass;
@CompilationFinal private Type returnType;
FunctionProxyNode(Class receiverType, Method method) {
this.receiverClass = receiverType;
this.method = method;
}
@SuppressWarnings("unchecked")
@Override
protected Class getReceiverType() {
return (Class) receiverClass;
}
@Override
public final String getName() {
return "FunctionalInterfaceProxy<" + receiverClass + ", " + method + ">";
}
@Override
protected Object executeImpl(PolyglotLanguageContext languageContext, TruffleObject function, Object[] args, int offset) {
if (executeNode == null) {
CompilerDirectives.transferToInterpreterAndInvalidate();
this.returnClass = HostInteropReflect.getMethodReturnType(method);
this.returnType = HostInteropReflect.getMethodGenericReturnType(method);
this.executeNode = insert(new PolyglotExecuteNode());
}
return executeNode.execute(languageContext, function, args[offset], returnClass, returnType);
}
@Override
public int hashCode() {
int result = 1;
result = 31 * result + Objects.hashCode(receiverClass);
result = 31 * result + Objects.hashCode(method);
return result;
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof FunctionProxyNode)) {
return false;
}
FunctionProxyNode other = (FunctionProxyNode) obj;
return receiverClass == other.receiverClass && method.equals(other.method);
}
static CallTarget lookup(PolyglotLanguageContext languageContext, Class receiverClass, Method method) {
FunctionProxyNode node = new FunctionProxyNode(receiverClass, method);
CallTarget target = lookupHostCodeCache(languageContext, node, CallTarget.class);
if (target == null) {
target = installHostCodeCache(languageContext, node, createTarget(node), CallTarget.class);
}
return target;
}
}
final class FunctionProxyHandler implements InvocationHandler {
final TruffleObject functionObj;
final PolyglotLanguageContext languageContext;
private final Method functionMethod;
private final CallTarget target;
FunctionProxyHandler(TruffleObject obj, Method functionMethod, PolyglotLanguageContext languageContext) {
this.functionObj = obj;
this.languageContext = languageContext;
this.functionMethod = functionMethod;
this.target = FunctionProxyNode.lookup(languageContext, obj.getClass(), functionMethod);
}
@Override
public Object invoke(Object proxy, Method method, Object[] arguments) throws Throwable {
CompilerAsserts.neverPartOfCompilation();
if (method.equals(functionMethod)) {
return target.call(languageContext, functionObj, spreadVarArgsArray(arguments));
} else {
return invokeDefault(proxy, method, arguments);
}
}
private Object[] spreadVarArgsArray(Object[] arguments) {
if (!functionMethod.isVarArgs()) {
return arguments;
}
if (arguments.length == 1) {
return (Object[]) arguments[0];
} else {
final int allButOne = arguments.length - 1;
Object[] last = (Object[]) arguments[allButOne];
Object[] merge = new Object[allButOne + last.length];
System.arraycopy(arguments, 0, merge, 0, allButOne);
System.arraycopy(last, 0, merge, allButOne, last.length);
return merge;
}
}
private static Object invokeDefault(Object proxy, Method method, Object[] arguments) throws Throwable {
if (method.getDeclaringClass() == Object.class) {
switch (method.getName()) {
case "equals":
return proxy == arguments[0];
case "hashCode":
return System.identityHashCode(proxy);
case "toString":
return proxy.getClass().getName() + "@" + Integer.toHexString(System.identityHashCode(proxy));
default:
throw new UnsupportedOperationException(method.getName());
}
}
// default method; requires Java 9 (JEP 274)
Class declaringClass = method.getDeclaringClass();
assert declaringClass.isInterface() : declaringClass;
MethodHandle mh;
try {
mh = MethodHandles.lookup().findSpecial(declaringClass, method.getName(), MethodType.methodType(method.getReturnType(), method.getParameterTypes()), declaringClass);
} catch (IllegalAccessException e) {
throw new UnsupportedOperationException(method.getName(), e);
}
return mh.bindTo(proxy).invokeWithArguments(arguments);
}
}
class ObjectProxyNode extends HostEntryRootNode {
final Class receiverClass;
final Class interfaceType;
@Child private ProxyInvokeNode proxyInvoke = ProxyInvokeNodeGen.create();
@CompilationFinal private ToGuestValuesNode toGuests;
ObjectProxyNode(Class receiverType, Class interfaceType) {
this.receiverClass = receiverType;
this.interfaceType = interfaceType;
}
@SuppressWarnings("unchecked")
@Override
protected Class getReceiverType() {
return (Class) receiverClass;
}
@Override
public final String getName() {
return "InterfaceProxy<" + receiverClass + ">";
}
@Override
protected Object executeImpl(PolyglotLanguageContext languageContext, TruffleObject receiver, Object[] args, int offset) {
if (proxyInvoke == null || toGuests == null) {
CompilerDirectives.transferToInterpreterAndInvalidate();
toGuests = ToGuestValuesNode.create();
proxyInvoke = ProxyInvokeNodeGen.create();
}
Method method = (Method) args[offset];
Object[] arguments = toGuests.apply(languageContext, (Object[]) args[offset + 1]);
return proxyInvoke.execute(languageContext, receiver, method, arguments);
}
@Override
public int hashCode() {
int result = 1;
result = 31 * result + Objects.hashCode(receiverClass);
result = 31 * result + Objects.hashCode(interfaceType);
return result;
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof ObjectProxyNode)) {
return false;
}
ObjectProxyNode other = (ObjectProxyNode) obj;
return receiverClass == other.receiverClass && interfaceType == other.interfaceType;
}
static CallTarget lookup(PolyglotLanguageContext languageContext, Class receiverClass, Class interfaceClass) {
ObjectProxyNode node = new ObjectProxyNode(receiverClass, interfaceClass);
CallTarget target = lookupHostCodeCache(languageContext, node, CallTarget.class);
if (target == null) {
target = installHostCodeCache(languageContext, node, createTarget(node), CallTarget.class);
}
return target;
}
}
@ImportStatic({Message.class, HostInteropReflect.class})
abstract class ProxyInvokeNode extends Node {
public abstract Object execute(PolyglotLanguageContext languageContext, TruffleObject receiver, Method method, Object[] arguments);
/*
* The limit of the proxy node is unbounded. There are only so many methods a Java interface can
* have. So we always want to specialize.
*/
protected static final int LIMIT = Integer.MAX_VALUE;
@CompilationFinal private boolean invokeFailed;
/*
* It is supposed to be safe to compare method names with == only as they are always interned.
*/
@Specialization(guards = {"cachedMethod.equals(method)"}, limit = "LIMIT")
@SuppressWarnings("unused")
protected Object doCachedMethod(PolyglotLanguageContext languageContext, TruffleObject receiver, Method method, Object[] arguments,
@Cached("method") Method cachedMethod,
@Cached("method.getName()") String name,
@Cached("getMethodReturnType(method)") Class returnClass,
@Cached("getMethodGenericReturnType(method)") Type returnType,
@Cached("INVOKE.createNode()") Node invokeNode,
@Cached("KEY_INFO.createNode()") Node keyInfoNode,
@Cached("READ.createNode()") Node readNode,
@Cached("IS_EXECUTABLE.createNode()") Node isExecutableNode,
@Cached("EXECUTE.createNode()") Node executeNode,
@Cached("createBinaryProfile()") ConditionProfile branchProfile,
@Cached("create()") ToHostNode toJava) {
Object result = invokeOrExecute(languageContext, receiver, arguments, name, invokeNode, keyInfoNode, readNode, isExecutableNode, executeNode, branchProfile);
return toJava.execute(result, returnClass, returnType, languageContext);
}
@TruffleBoundary
private static boolean guardReturnType(Method method, Type returnType) {
return method.getGenericReturnType().equals(returnType);
}
private Object invokeOrExecute(PolyglotLanguageContext polyglotContext, TruffleObject receiver, Object[] arguments, String name, Node invokeNode, Node keyInfoNode, Node readNode,
Node isExecutableNode,
Node executeNode,
ConditionProfile invokeOrReadAndExecuteProfile) {
try {
if (!invokeFailed) {
try {
return ForeignAccess.sendInvoke(invokeNode, receiver, name, arguments);
} catch (UnsupportedMessageException | UnknownIdentifierException e) {
CompilerDirectives.transferToInterpreterAndInvalidate();
// fallthrough to unsupported
invokeFailed = true;
}
}
if (invokeFailed) {
int keyInfo = ForeignAccess.sendKeyInfo(keyInfoNode, receiver, name);
if (invokeOrReadAndExecuteProfile.profile(KeyInfo.isInvocable(keyInfo))) {
try {
return ForeignAccess.sendInvoke(invokeNode, receiver, name, arguments);
} catch (UnsupportedMessageException e) {
CompilerDirectives.transferToInterpreter();
// fallthrough to unsupported
}
} else if (KeyInfo.isReadable(keyInfo)) {
Object readValue = ForeignAccess.sendRead(readNode, receiver, name);
if (readValue instanceof TruffleObject) {
TruffleObject truffleReadValue = (TruffleObject) readValue;
if (ForeignAccess.sendIsExecutable(isExecutableNode, truffleReadValue)) {
return ForeignAccess.sendExecute(executeNode, truffleReadValue, arguments);
}
}
if (arguments.length == 0) {
return readValue;
}
}
}
CompilerDirectives.transferToInterpreter();
throw HostInteropErrors.invokeUnsupported(polyglotContext, receiver, name);
} catch (UnknownIdentifierException e) {
CompilerDirectives.transferToInterpreter();
throw HostInteropErrors.invokeUnsupported(polyglotContext, receiver, name);
} catch (UnsupportedTypeException e) {
CompilerDirectives.transferToInterpreter();
throw HostInteropErrors.invalidExecuteArgumentType(polyglotContext, receiver, e.getSuppliedValues());
} catch (ArityException e) {
CompilerDirectives.transferToInterpreter();
throw HostInteropErrors.invalidExecuteArity(polyglotContext, receiver, arguments, e.getExpectedArity(), e.getActualArity());
} catch (UnsupportedMessageException e) {
CompilerDirectives.transferToInterpreter();
throw HostInteropErrors.invokeUnsupported(polyglotContext, receiver, name);
}
}
}
final class ObjectProxyHandler implements InvocationHandler {
final TruffleObject obj;
final PolyglotLanguageContext languageContext;
final CallTarget invoke;
ObjectProxyHandler(TruffleObject obj, PolyglotLanguageContext languageContext, Class interfaceClass) {
this.obj = obj;
this.languageContext = languageContext;
this.invoke = ObjectProxyNode.lookup(languageContext, obj.getClass(), interfaceClass);
}
@Override
public Object invoke(Object proxy, Method method, Object[] arguments) throws Throwable {
CompilerAsserts.neverPartOfCompilation();
return invoke.call(languageContext, obj, method, arguments == null ? HostInteropReflect.EMPTY : arguments);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy