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