1 /*
2 * Copyright (c) 2015, 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.core.test;
24
25 import org.graalvm.compiler.debug.DebugContext;
26 import org.graalvm.compiler.nodes.ProxyNode;
27 import org.graalvm.compiler.nodes.StructuredGraph;
28 import org.graalvm.compiler.nodes.StructuredGraph.AllowAssumptions;
29 import org.graalvm.compiler.nodes.spi.LoweringTool;
30 import org.graalvm.compiler.phases.common.CanonicalizerPhase;
31 import org.graalvm.compiler.phases.common.ConditionalEliminationPhase;
32 import org.graalvm.compiler.phases.common.ConvertDeoptimizeToGuardPhase;
33 import org.graalvm.compiler.phases.common.IterativeConditionalEliminationPhase;
34 import org.graalvm.compiler.phases.common.LoweringPhase;
35 import org.graalvm.compiler.phases.schedule.SchedulePhase;
36 import org.graalvm.compiler.phases.tiers.PhaseContext;
37 import org.junit.Assert;
38
39 /**
40 * Collection of tests for {@link org.graalvm.compiler.phases.common.ConditionalEliminationPhase}
41 * including those that triggered bugs in this phase.
42 */
43 public class ConditionalEliminationTestBase extends GraalCompilerTest {
44 protected static int sink0;
45 protected static int sink1;
46 protected static int sink2;
47
48 protected void testConditionalElimination(String snippet, String referenceSnippet) {
49 testConditionalElimination(snippet, referenceSnippet, false, false);
50 }
51
52 @SuppressWarnings("try")
53 protected void testConditionalElimination(String snippet, String referenceSnippet, boolean applyConditionalEliminationOnReference, boolean applyLowering) {
54 StructuredGraph graph = parseEager(snippet, AllowAssumptions.YES);
55 DebugContext debug = graph.getDebug();
56 debug.dump(DebugContext.BASIC_LEVEL, graph, "Graph");
57 PhaseContext context = new PhaseContext(getProviders());
58 CanonicalizerPhase canonicalizer1 = new CanonicalizerPhase();
59 CanonicalizerPhase canonicalizer = new CanonicalizerPhase();
60 try (DebugContext.Scope scope = debug.scope("ConditionalEliminationTest", graph)) {
61 prepareGraph(graph, canonicalizer1, context, applyLowering);
62 new IterativeConditionalEliminationPhase(canonicalizer, true).apply(graph, context);
63 canonicalizer.apply(graph, context);
64 canonicalizer.apply(graph, context);
65 new ConvertDeoptimizeToGuardPhase().apply(graph, context);
66 } catch (Throwable t) {
67 debug.handle(t);
68 }
69 StructuredGraph referenceGraph = parseEager(referenceSnippet, AllowAssumptions.YES);
70 try (DebugContext.Scope scope = debug.scope("ConditionalEliminationTest.ReferenceGraph", referenceGraph)) {
71 prepareGraph(referenceGraph, canonicalizer, context, applyLowering);
72 if (applyConditionalEliminationOnReference) {
73 new ConditionalEliminationPhase(true).apply(referenceGraph, context);
74 }
75 canonicalizer.apply(referenceGraph, context);
76 canonicalizer.apply(referenceGraph, context);
77 new ConvertDeoptimizeToGuardPhase().apply(graph, context);
78 } catch (Throwable t) {
79 debug.handle(t);
80 }
81 assertEquals(referenceGraph, graph);
82 }
83
84 protected void prepareGraph(StructuredGraph graph, CanonicalizerPhase canonicalizer, PhaseContext context, boolean applyLowering) {
85 if (applyLowering) {
86 new ConvertDeoptimizeToGuardPhase().apply(graph, context);
87 new LoweringPhase(canonicalizer, LoweringTool.StandardLoweringStage.HIGH_TIER).apply(graph, context);
88 canonicalizer.apply(graph, context);
89 }
90 canonicalizer.apply(graph, context);
91 new ConvertDeoptimizeToGuardPhase().apply(graph, context);
92 }
93
94 public void testProxies(String snippet, int expectedProxiesCreated) {
95 StructuredGraph graph = parseEager(snippet, AllowAssumptions.YES);
96 PhaseContext context = new PhaseContext(getProviders());
97 CanonicalizerPhase canonicalizer1 = new CanonicalizerPhase();
98 canonicalizer1.disableSimplification();
99 canonicalizer1.apply(graph, context);
100 CanonicalizerPhase canonicalizer = new CanonicalizerPhase();
101 new LoweringPhase(canonicalizer, LoweringTool.StandardLoweringStage.HIGH_TIER).apply(graph, context);
102 canonicalizer.apply(graph, context);
103
104 int baseProxyCount = graph.getNodes().filter(ProxyNode.class).count();
105 new ConditionalEliminationPhase(true).apply(graph, context);
106 canonicalizer.apply(graph, context);
107 new SchedulePhase(graph.getOptions()).apply(graph, context);
108 int actualProxiesCreated = graph.getNodes().filter(ProxyNode.class).count() - baseProxyCount;
109 Assert.assertEquals(expectedProxiesCreated, actualProxiesCreated);
110 }
111 }