1 /*
   2  * Copyright (c) 2011, 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.nodes.spi;
  26 
  27 import org.graalvm.compiler.core.common.spi.ConstantFieldProvider;
  28 import org.graalvm.compiler.graph.NodeSourcePosition;
  29 import org.graalvm.compiler.nodes.FixedNode;
  30 import org.graalvm.compiler.nodes.FixedWithNextNode;
  31 import org.graalvm.compiler.nodes.LogicNode;
  32 import org.graalvm.compiler.nodes.extended.AnchoringNode;
  33 import org.graalvm.compiler.nodes.extended.GuardingNode;
  34 
  35 import jdk.vm.ci.meta.ConstantReflectionProvider;
  36 import jdk.vm.ci.meta.DeoptimizationAction;
  37 import jdk.vm.ci.meta.DeoptimizationReason;
  38 import jdk.vm.ci.meta.MetaAccessProvider;
  39 import jdk.vm.ci.meta.SpeculationLog.Speculation;
  40 
  41 public interface LoweringTool {
  42 
  43     CoreProviders getProviders();
  44 
  45     MetaAccessProvider getMetaAccess();
  46 
  47     LoweringProvider getLowerer();
  48 
  49     ConstantReflectionProvider getConstantReflection();
  50 
  51     ConstantFieldProvider getConstantFieldProvider();
  52 
  53     Replacements getReplacements();
  54 
  55     StampProvider getStampProvider();
  56 
  57     GuardingNode createGuard(FixedNode before, LogicNode condition, DeoptimizationReason deoptReason, DeoptimizationAction action);
  58 
  59     GuardingNode createGuard(FixedNode before, LogicNode condition, DeoptimizationReason deoptReason, DeoptimizationAction action, Speculation speculation, boolean negated,
  60                     NodeSourcePosition noDeoptSuccessorPosition);
  61 
  62     /**
  63      * Gets the closest fixed node preceding the node currently being lowered.
  64      */
  65     FixedWithNextNode lastFixedNode();
  66 
  67     AnchoringNode getCurrentGuardAnchor();
  68 
  69     /**
  70      * Marker interface lowering stages.
  71      */
  72     interface LoweringStage {
  73     }
  74 
  75     /**
  76      * The lowering stages used in a standard Graal phase plan. Lowering is called 3 times, during
  77      * every tier of compilation.
  78      */
  79     enum StandardLoweringStage implements LoweringStage {
  80         HIGH_TIER,
  81         MID_TIER,
  82         LOW_TIER
  83     }
  84 
  85     /**
  86      * Returns current lowering stage.
  87      */
  88     LoweringStage getLoweringStage();
  89 }