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