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