1 /*
   2  * Copyright (c) 2000, 2020, 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 #ifndef SHARE_JVMCI_JVMCI_GLOBALS_HPP
  26 #define SHARE_JVMCI_JVMCI_GLOBALS_HPP
  27 
  28 #include "runtime/flags/jvmFlag.hpp"
  29 
  30 class fileStream;
  31 
  32 //
  33 // Defines all global flags used by the JVMCI compiler. Only flags that need
  34 // to be accessible to the JVMCI C++ code should be defined here.
  35 //
  36 #define JVMCI_FLAGS(develop, \
  37                     develop_pd, \
  38                     product, \
  39                     product_pd, \
  40                     diagnostic, \
  41                     diagnostic_pd, \
  42                     experimental, \
  43                     notproduct, \
  44                     range, \
  45                     constraint) \
  46                                                                             \
  47   experimental(bool, EnableJVMCI, false,                                    \
  48           "Enable JVMCI")                                                   \
  49                                                                             \
  50   experimental(bool, EnableJVMCIProduct, false,                             \
  51           "Allow JVMCI to be used in product mode. This alters a subset of "\
  52           "JVMCI flags to be non-experimental, defaults UseJVMCICompiler "  \
  53           "and EnableJVMCI to true and defaults UseJVMCINativeLibrary "     \
  54           "to true if a JVMCI native library is available.")                \
  55                                                                             \
  56   experimental(bool, UseJVMCICompiler, false,                               \
  57           "Use JVMCI as the default compiler. Defaults to true if "         \
  58           "EnableJVMCIProduct is true.")                                    \
  59                                                                             \
  60   experimental(bool, JVMCIPrintProperties, false,                           \
  61           "Prints properties used by the JVMCI compiler and exits")         \
  62                                                                             \
  63   experimental(bool, BootstrapJVMCI, false,                                 \
  64           "Bootstrap JVMCI before running Java main method. This "          \
  65           "initializes the compile queue with a small set of methods "      \
  66           "and processes the queue until it is empty. Combining this with " \
  67           "-XX:-TieredCompilation makes JVMCI compile more of itself.")     \
  68                                                                             \
  69   experimental(bool, EagerJVMCI, false,                                     \
  70           "Force eager JVMCI initialization")                               \
  71                                                                             \
  72   experimental(bool, PrintBootstrap, true,                                  \
  73           "Print JVMCI bootstrap progress and summary")                     \
  74                                                                             \
  75   experimental(intx, JVMCIThreads, 1,                                       \
  76           "Force number of JVMCI compiler threads to use. Ignored if "      \
  77           "UseJVMCICompiler is false.")                                     \
  78           range(1, max_jint)                                                \
  79                                                                             \
  80   experimental(intx, JVMCIHostThreads, 1,                                   \
  81           "Force number of C1 compiler threads. Ignored if "                \
  82           "UseJVMCICompiler is false.")                                     \
  83           range(1, max_jint)                                                \
  84                                                                             \
  85   NOT_COMPILER2(product(intx, MaxVectorSize, 64,                            \
  86           "Max vector size in bytes, "                                      \
  87           "actual size could be less depending on elements type")           \
  88           range(0, max_jint))                                               \
  89                                                                             \
  90   NOT_COMPILER2(product(bool, ReduceInitialCardMarks, true,                 \
  91           "Defer write barriers of young objects"))                         \
  92                                                                             \
  93   experimental(intx, JVMCITraceLevel, 0,                                    \
  94           "Trace level for JVMCI: "                                         \
  95           "1 means emit a message for each CompilerToVM call,"              \
  96           "levels greater than 1 provide progressively greater detail")     \
  97           range(0, 6)                                                       \
  98                                                                             \
  99   experimental(intx, JVMCICounterSize, 0,                                   \
 100           "Reserved size for benchmark counters")                           \
 101           range(0, 1000000)                                                 \
 102                                                                             \
 103   experimental(bool, JVMCICountersExcludeCompiler, true,                    \
 104           "Exclude JVMCI compiler threads from benchmark counters")         \
 105                                                                             \
 106   develop(bool, JVMCIUseFastLocking, true,                                  \
 107           "Use fast inlined locking code")                                  \
 108                                                                             \
 109   experimental(intx, JVMCINMethodSizeLimit, (80*K)*wordSize,                \
 110           "Maximum size of a compiled method.")                             \
 111           range(0, max_jint)                                                \
 112                                                                             \
 113   experimental(ccstr, JVMCILibPath, NULL,                                   \
 114           "LD path for loading the JVMCI shared library")                   \
 115                                                                             \
 116   experimental(ccstr, JVMCILibDumpJNIConfig, NULL,                          \
 117           "Dumps to the given file a description of the classes, fields "   \
 118           "and methods the JVMCI shared library must provide")              \
 119                                                                             \
 120   experimental(bool, UseJVMCINativeLibrary, false,                          \
 121           "Execute JVMCI Java code from a shared library "                  \
 122           "instead of loading it from class files and executing it "        \
 123           "on the HotSpot heap. Defaults to true if EnableJVMCIProduct is " \
 124           "true and a JVMCI native library is available.")                  \
 125                                                                             \
 126   NOT_COMPILER2(diagnostic(bool, UseMultiplyToLenIntrinsic, false,          \
 127           "Enables intrinsification of BigInteger.multiplyToLen()"))        \
 128                                                                             \
 129   NOT_COMPILER2(diagnostic(bool, UseSquareToLenIntrinsic, false,            \
 130           "Enables intrinsification of BigInteger.squareToLen()"))          \
 131                                                                             \
 132   NOT_COMPILER2(diagnostic(bool, UseMulAddIntrinsic, false,                 \
 133           "Enables intrinsification of BigInteger.mulAdd()"))               \
 134                                                                             \
 135   NOT_COMPILER2(diagnostic(bool, UseMontgomeryMultiplyIntrinsic, false,     \
 136           "Enables intrinsification of BigInteger.montgomeryMultiply()"))   \
 137                                                                             \
 138   NOT_COMPILER2(diagnostic(bool, UseMontgomerySquareIntrinsic, false,       \
 139           "Enables intrinsification of BigInteger.montgomerySquare()"))
 140 
 141 // The base name for the shared library containing the JVMCI based compiler
 142 #define JVMCI_SHARED_LIBRARY_NAME "jvmcicompiler"
 143 
 144 class JVMCIGlobals {
 145  private:
 146   static fileStream* _jni_config_file;
 147  public:
 148 
 149   // Returns true if jvmci flags are consistent. If not consistent,
 150   // an error message describing the inconsistency is printed before
 151   // returning false.
 152   static bool check_jvmci_flags_are_consistent();
 153 
 154   // Convert JVMCI experimental flags to product
 155   static bool enable_jvmci_product_mode(JVMFlag::Flags);
 156 
 157   // Check and exit VM with error if selected GC is not supported by JVMCI.
 158   static void check_jvmci_supported_gc();
 159 
 160   static fileStream* get_jni_config_file() { return _jni_config_file; }
 161 };
 162 #endif // SHARE_JVMCI_JVMCI_GLOBALS_HPP