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 java.lang.annotation.Annotation;
  28 import java.lang.reflect.Method;
  29 
  30 import org.graalvm.compiler.api.replacements.Fold;
  31 import org.graalvm.compiler.debug.GraalError;
  32 import org.graalvm.compiler.graph.Node.NodeIntrinsic;
  33 import org.graalvm.compiler.nodes.ValueNode;
  34 
  35 import jdk.vm.ci.meta.MetaAccessProvider;
  36 import jdk.vm.ci.meta.ResolvedJavaMethod;
  37 import jdk.vm.ci.meta.ResolvedJavaType;
  38 
  39 /**
  40  * Abstract class for a plugin generated for a method annotated by {@link NodeIntrinsic} or
  41  * {@link Fold}.
  42  */
  43 public abstract class GeneratedInvocationPlugin implements InvocationPlugin {
  44 
  45     /**
  46      * Gets the class of the annotation for which this plugin was generated.
  47      */
  48     public abstract Class<? extends Annotation> getSource();
  49 
  50     @Override
  51     public abstract boolean execute(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode[] args);
  52 
  53     @Override
  54     public StackTraceElement getApplySourceLocation(MetaAccessProvider metaAccess) {
  55         Class<?> c = getClass();
  56         for (Method m : c.getDeclaredMethods()) {
  57             if (m.getName().equals("execute")) {
  58                 return metaAccess.lookupJavaMethod(m).asStackTraceElement(0);
  59             }
  60         }
  61         throw new GraalError("could not find method named \"execute\" in " + c.getName());
  62     }
  63 
  64     protected boolean checkInjectedArgument(GraphBuilderContext b, ValueNode arg, ResolvedJavaMethod foldAnnotatedMethod) {
  65         if (arg.isNullConstant()) {
  66             return true;
  67         }
  68 
  69         MetaAccessProvider metaAccess = b.getMetaAccess();
  70         ResolvedJavaMethod executeMethod = metaAccess.lookupJavaMethod(getExecuteMethod());
  71         ResolvedJavaType thisClass = metaAccess.lookupJavaType(getClass());
  72         ResolvedJavaMethod thisExecuteMethod = thisClass.resolveConcreteMethod(executeMethod, thisClass);
  73         if (b.getMethod().equals(thisExecuteMethod)) {
  74             // The "execute" method of this plugin is itself being compiled. In (only) this context,
  75             // the injected argument of the call to the @Fold annotated method will be non-null.
  76             return true;
  77         }
  78         throw new AssertionError("must pass null to injected argument of " + foldAnnotatedMethod.format("%H.%n(%p)") + ", not " + arg);
  79     }
  80 
  81     private static Method getExecuteMethod() {
  82         try {
  83             return GeneratedInvocationPlugin.class.getMethod("execute", GraphBuilderContext.class, ResolvedJavaMethod.class, InvocationPlugin.Receiver.class, ValueNode[].class);
  84         } catch (NoSuchMethodException | SecurityException e) {
  85             throw new GraalError(e);
  86         }
  87     }
  88 }