1/*
2 * Copyright (c) 2013, 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 */
23package org.graalvm.compiler.core.phases;
24
25import static org.graalvm.compiler.core.common.GraalOptions.ConditionalElimination;
26import static org.graalvm.compiler.core.common.GraalOptions.FullUnroll;
27import static org.graalvm.compiler.core.common.GraalOptions.ImmutableCode;
28import static org.graalvm.compiler.core.common.GraalOptions.LoopPeeling;
29import static org.graalvm.compiler.core.common.GraalOptions.LoopUnswitch;
30import static org.graalvm.compiler.core.common.GraalOptions.OptConvertDeoptsToGuards;
31import static org.graalvm.compiler.core.common.GraalOptions.OptLoopTransform;
32import static org.graalvm.compiler.core.common.GraalOptions.OptReadElimination;
33import static org.graalvm.compiler.core.common.GraalOptions.PartialEscapeAnalysis;
34import static org.graalvm.compiler.phases.common.DeadCodeEliminationPhase.Optionality.Optional;
35
36import org.graalvm.compiler.loop.DefaultLoopPolicies;
37import org.graalvm.compiler.loop.LoopPolicies;
38import org.graalvm.compiler.loop.phases.LoopFullUnrollPhase;
39import org.graalvm.compiler.loop.phases.LoopPeelingPhase;
40import org.graalvm.compiler.loop.phases.LoopUnswitchingPhase;
41import org.graalvm.compiler.nodes.spi.LoweringTool;
42import org.graalvm.compiler.options.Option;
43import org.graalvm.compiler.options.OptionKey;
44import org.graalvm.compiler.options.OptionType;
45import org.graalvm.compiler.options.OptionValues;
46import org.graalvm.compiler.phases.PhaseSuite;
47import org.graalvm.compiler.phases.common.CanonicalizerPhase;
48import org.graalvm.compiler.phases.common.ConvertDeoptimizeToGuardPhase;
49import org.graalvm.compiler.phases.common.DeadCodeEliminationPhase;
50import org.graalvm.compiler.phases.common.IncrementalCanonicalizerPhase;
51import org.graalvm.compiler.phases.common.IterativeConditionalEliminationPhase;
52import org.graalvm.compiler.phases.common.LoweringPhase;
53import org.graalvm.compiler.phases.common.RemoveValueProxyPhase;
54import org.graalvm.compiler.phases.common.inlining.InliningPhase;
55import org.graalvm.compiler.phases.tiers.HighTierContext;
56import org.graalvm.compiler.virtual.phases.ea.EarlyReadEliminationPhase;
57import org.graalvm.compiler.virtual.phases.ea.PartialEscapePhase;
58
59public class HighTier extends PhaseSuite<HighTierContext> {
60
61    public static class Options {
62
63        // @formatter:off
64        @Option(help = "Enable inlining", type = OptionType.Expert)
65        public static final OptionKey<Boolean> Inline = new OptionKey<>(true);
66        // @formatter:on
67    }
68
69    public HighTier(OptionValues options) {
70        CanonicalizerPhase canonicalizer = new CanonicalizerPhase();
71        if (ImmutableCode.getValue(options)) {
72            canonicalizer.disableReadCanonicalization();
73        }
74
75        appendPhase(canonicalizer);
76
77        if (Options.Inline.getValue(options)) {
78            appendPhase(new InliningPhase(canonicalizer));
79            appendPhase(new DeadCodeEliminationPhase(Optional));
80        }
81
82        if (OptConvertDeoptsToGuards.getValue(options)) {
83            appendPhase(new IncrementalCanonicalizerPhase<>(canonicalizer, new ConvertDeoptimizeToGuardPhase()));
84        }
85
86        if (ConditionalElimination.getValue(options)) {
87            appendPhase(new IterativeConditionalEliminationPhase(canonicalizer, false));
88        }
89
90        LoopPolicies loopPolicies = createLoopPolicies();
91        if (FullUnroll.getValue(options)) {
92            appendPhase(new LoopFullUnrollPhase(canonicalizer, loopPolicies));
93        }
94
95        if (OptLoopTransform.getValue(options)) {
96            if (LoopPeeling.getValue(options)) {
97                appendPhase(new LoopPeelingPhase(loopPolicies));
98            }
99            if (LoopUnswitch.getValue(options)) {
100                appendPhase(new LoopUnswitchingPhase(loopPolicies));
101            }
102        }
103
104        appendPhase(canonicalizer);
105
106        if (PartialEscapeAnalysis.getValue(options)) {
107            appendPhase(new PartialEscapePhase(true, canonicalizer, options));
108        }
109
110        if (OptReadElimination.getValue(options)) {
111            appendPhase(new EarlyReadEliminationPhase(canonicalizer));
112        }
113
114        appendPhase(new RemoveValueProxyPhase());
115
116        appendPhase(new LoweringPhase(canonicalizer, LoweringTool.StandardLoweringStage.HIGH_TIER));
117    }
118
119    public LoopPolicies createLoopPolicies() {
120        return new DefaultLoopPolicies();
121    }
122}
123