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