1 /*
   2  * Copyright (c) 2014, 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.replacements;
  26 
  27 import jdk.vm.ci.meta.JavaKind;
  28 import jdk.vm.ci.meta.MetaAccessProvider;
  29 
  30 import org.graalvm.compiler.api.replacements.Fold;
  31 import org.graalvm.compiler.api.replacements.Fold.InjectedParameter;
  32 import org.graalvm.compiler.debug.Assertions;
  33 import org.graalvm.compiler.replacements.nodes.AssertionNode;
  34 
  35 // JaCoCo Exclude
  36 public final class ReplacementsUtil {
  37     private ReplacementsUtil() {
  38         // empty
  39     }
  40 
  41     public static final boolean REPLACEMENTS_ASSERTIONS_ENABLED = Assertions.assertionsEnabled();
  42 
  43     /**
  44      * Asserts that condition evaluates to true by the time compilation is finished. This is
  45      * intended to be used within snippets or stubs, and will lead to a compile error if the
  46      * assertion fails.
  47      */
  48     public static void staticAssert(boolean condition, String message) {
  49         if (REPLACEMENTS_ASSERTIONS_ENABLED) {
  50             AssertionNode.assertion(true, condition, message);
  51         }
  52     }
  53 
  54     /**
  55      * Asserts that condition evaluates to true at runtime. This is intended to be used within
  56      * snippets or stubs, and will lead to a VM error if it fails.
  57      */
  58     public static void runtimeAssert(boolean condition, String message) {
  59         if (REPLACEMENTS_ASSERTIONS_ENABLED) {
  60             AssertionNode.assertion(false, condition, message);
  61         }
  62     }
  63 
  64     @Fold
  65     public static int arrayIndexScale(@InjectedParameter MetaAccessProvider metaAccessProvider, JavaKind elementKind) {
  66         return metaAccessProvider.getArrayIndexScale(elementKind);
  67     }
  68 
  69     @Fold
  70     public static int getArrayBaseOffset(@InjectedParameter MetaAccessProvider metaAccessProvider, JavaKind elementKind) {
  71         return metaAccessProvider.getArrayBaseOffset(elementKind);
  72     }
  73 
  74 }