1 /* 2 * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. 8 * 9 * This code is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 * version 2 for more details (a copy is included in the LICENSE file that 13 * accompanied this code). 14 * 15 * You should have received a copy of the GNU General Public License version 16 * 2 along with this work; if not, write to the Free Software Foundation, 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 * 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 * or visit www.oracle.com if you need additional information or have any 21 * questions. 22 */ 23 24 25 package org.graalvm.compiler.nodes.graphbuilderconf; 26 27 import static jdk.vm.ci.services.Services.IS_BUILDING_NATIVE_IMAGE; 28 import static jdk.vm.ci.services.Services.IS_IN_NATIVE_IMAGE; 29 30 import java.lang.annotation.Annotation; 31 import java.lang.reflect.Method; 32 33 import org.graalvm.compiler.api.replacements.Fold; 34 import org.graalvm.compiler.debug.GraalError; 35 import org.graalvm.compiler.graph.Node.NodeIntrinsic; 36 import org.graalvm.compiler.nodes.ValueNode; 37 38 import jdk.vm.ci.meta.MetaAccessProvider; 39 import jdk.vm.ci.meta.ResolvedJavaMethod; 40 import jdk.vm.ci.meta.ResolvedJavaType; 41 42 /** 43 * Abstract class for a plugin generated for a method annotated by {@link NodeIntrinsic} or 44 * {@link Fold}. 45 */ 46 public abstract class GeneratedInvocationPlugin implements InvocationPlugin { 47 48 private ResolvedJavaMethod executeMethod; 49 50 /** 51 * Gets the class of the annotation for which this plugin was generated. 52 */ 53 public abstract Class<? extends Annotation> getSource(); 54 55 @Override 56 public abstract boolean execute(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode[] args); 57 58 @Override 59 public StackTraceElement getApplySourceLocation(MetaAccessProvider metaAccess) { 60 Class<?> c = getClass(); 61 for (Method m : c.getDeclaredMethods()) { 62 if (m.getName().equals("execute")) { 63 return metaAccess.lookupJavaMethod(m).asStackTraceElement(0); 64 } 65 } 66 throw new GraalError("could not find method named \"execute\" in " + c.getName()); 67 } 68 69 protected boolean checkInjectedArgument(GraphBuilderContext b, ValueNode arg, ResolvedJavaMethod foldAnnotatedMethod) { 70 if (arg.isNullConstant()) { 71 return true; 72 } 73 74 if (IS_IN_NATIVE_IMAGE) { 75 // The reflection here is problematic for SVM. 76 return true; 77 } 78 79 if (b.getMethod().equals(foldAnnotatedMethod)) { 80 return false; 81 } 82 83 ResolvedJavaMethod thisExecuteMethod = getExecutedMethod(b); 84 if (b.getMethod().equals(thisExecuteMethod)) { 85 // The "execute" method of this plugin is itself being compiled. In (only) this context, 86 // the injected argument of the call to the @Fold annotated method will be non-null. 87 if (IS_BUILDING_NATIVE_IMAGE) { 88 return false; 89 } 90 return true; 91 } 92 throw new AssertionError("must pass null to injected argument of " + foldAnnotatedMethod.format("%H.%n(%p)") + ", not " + arg); 93 } 94 95 private ResolvedJavaMethod getExecutedMethod(GraphBuilderContext b) { 96 if (executeMethod == null) { 97 MetaAccessProvider metaAccess = b.getMetaAccess(); 98 ResolvedJavaMethod baseMethod = metaAccess.lookupJavaMethod(getExecuteMethod()); 99 ResolvedJavaType thisClass = metaAccess.lookupJavaType(getClass()); 100 executeMethod = thisClass.resolveConcreteMethod(baseMethod, thisClass); 101 } 102 return executeMethod; 103 } 104 105 private static Method getExecuteMethod() { 106 try { 107 return GeneratedInvocationPlugin.class.getMethod("execute", GraphBuilderContext.class, ResolvedJavaMethod.class, InvocationPlugin.Receiver.class, ValueNode[].class); 108 } catch (NoSuchMethodException | SecurityException e) { 109 throw new GraalError(e); 110 } 111 } 112 }