1 /*
   2  * Copyright (c) 2016, 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.core.test;
  26 
  27 import static org.graalvm.compiler.core.test.GraalCompilerTest.getInitialOptions;
  28 
  29 import java.lang.reflect.Method;
  30 import java.lang.reflect.Modifier;
  31 
  32 import org.graalvm.compiler.api.test.Graal;
  33 import org.graalvm.compiler.core.common.PermanentBailoutException;
  34 import org.graalvm.compiler.core.common.RetryableBailoutException;
  35 import org.graalvm.compiler.debug.DebugCloseable;
  36 import org.graalvm.compiler.debug.DebugHandlersFactory;
  37 import org.graalvm.compiler.debug.DebugContext;
  38 import org.graalvm.compiler.debug.GraalError;
  39 import org.graalvm.compiler.java.GraphBuilderPhase;
  40 import org.graalvm.compiler.nodes.StructuredGraph;
  41 import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration;
  42 import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration.Plugins;
  43 import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugins;
  44 import org.graalvm.compiler.options.OptionValues;
  45 import org.graalvm.compiler.phases.OptimisticOptimizations;
  46 import org.graalvm.compiler.phases.Phase;
  47 import org.graalvm.compiler.phases.PhaseSuite;
  48 import org.graalvm.compiler.phases.VerifyPhase.VerificationError;
  49 import org.graalvm.compiler.phases.tiers.HighTierContext;
  50 import org.graalvm.compiler.phases.util.Providers;
  51 import org.graalvm.compiler.phases.verify.VerifyBailoutUsage;
  52 import org.graalvm.compiler.runtime.RuntimeProvider;
  53 import org.junit.Test;
  54 
  55 import jdk.vm.ci.code.BailoutException;
  56 import jdk.vm.ci.meta.MetaAccessProvider;
  57 import jdk.vm.ci.meta.ResolvedJavaMethod;
  58 
  59 public class VerifyBailoutUsageTest {
  60 
  61     private static class InvalidBailoutUsagePhase1 extends Phase {
  62         @Override
  63         protected void run(StructuredGraph graph) {
  64             throw new BailoutException("Bailout in graph %s", graph);
  65         }
  66     }
  67 
  68     private static class InvalidBailoutUsagePhase2 extends Phase {
  69         @Override
  70         protected void run(StructuredGraph graph) {
  71             throw new BailoutException(new GraalError("other cause"), "Bailout in graph %s", graph);
  72         }
  73     }
  74 
  75     private static class InvalidBailoutUsagePhase3 extends Phase {
  76         @Override
  77         protected void run(StructuredGraph graph) {
  78             throw new BailoutException(true/* permanent */, "Bailout in graph %s", graph);
  79         }
  80     }
  81 
  82     private static class ValidPermanentBailoutUsage extends Phase {
  83         @Override
  84         protected void run(StructuredGraph graph) {
  85             throw new PermanentBailoutException("Valid permanent bailout %s", graph);
  86         }
  87     }
  88 
  89     private static class ValidRetryableBailoutUsage extends Phase {
  90         @Override
  91         protected void run(StructuredGraph graph) {
  92             throw new RetryableBailoutException("Valid retryable bailout %s", graph);
  93         }
  94     }
  95 
  96     @Test(expected = VerificationError.class)
  97     public void testInvalidBailout01() {
  98         testBailoutUsage(InvalidBailoutUsagePhase1.class);
  99     }
 100 
 101     @Test(expected = VerificationError.class)
 102     public void testInvalidBailout02() {
 103         testBailoutUsage(InvalidBailoutUsagePhase2.class);
 104     }
 105 
 106     @Test(expected = VerificationError.class)
 107     public void testInvalidBailout03() {
 108         testBailoutUsage(InvalidBailoutUsagePhase3.class);
 109     }
 110 
 111     @Test
 112     public void testValidPermanentBailout() {
 113         testBailoutUsage(ValidPermanentBailoutUsage.class);
 114     }
 115 
 116     @Test
 117     public void testValidRetryableBailout() {
 118         testBailoutUsage(ValidRetryableBailoutUsage.class);
 119     }
 120 
 121     @SuppressWarnings("try")
 122     private static void testBailoutUsage(Class<?> c) {
 123         RuntimeProvider rt = Graal.getRequiredCapability(RuntimeProvider.class);
 124         Providers providers = rt.getHostBackend().getProviders();
 125         MetaAccessProvider metaAccess = providers.getMetaAccess();
 126         PhaseSuite<HighTierContext> graphBuilderSuite = new PhaseSuite<>();
 127         Plugins plugins = new Plugins(new InvocationPlugins());
 128         GraphBuilderConfiguration config = GraphBuilderConfiguration.getDefault(plugins).withEagerResolving(true).withUnresolvedIsError(true);
 129         graphBuilderSuite.appendPhase(new GraphBuilderPhase(config));
 130         HighTierContext context = new HighTierContext(providers, graphBuilderSuite, OptimisticOptimizations.NONE);
 131         OptionValues options = getInitialOptions();
 132         DebugContext debug = DebugContext.create(options, DebugHandlersFactory.LOADER);
 133         for (Method m : c.getDeclaredMethods()) {
 134             if (!Modifier.isNative(m.getModifiers()) && !Modifier.isAbstract(m.getModifiers())) {
 135                 ResolvedJavaMethod method = metaAccess.lookupJavaMethod(m);
 136                 StructuredGraph graph = new StructuredGraph.Builder(options, debug).method(method).build();
 137                 graphBuilderSuite.apply(graph, context);
 138                 try (DebugCloseable s = debug.disableIntercept()) {
 139                     new VerifyBailoutUsage().apply(graph, context);
 140                 }
 141             }
 142         }
 143     }
 144 }