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 #include "precompiled.hpp"
  26 #include "jvm.h"
  27 #include "jvmci/jvmci_globals.hpp"
  28 #include "gc/shared/gcConfig.hpp"
  29 #include "utilities/defaultStream.hpp"
  30 #include "utilities/ostream.hpp"
  31 #include "runtime/globals_extension.hpp"
  32 
  33 fileStream* JVMCIGlobals::_jni_config_file = NULL;
  34 
  35 // Return true if jvmci flags are consistent.
  36 bool JVMCIGlobals::check_jvmci_flags_are_consistent() {
  37 
  38 #ifndef PRODUCT
  39 #define APPLY_JVMCI_FLAGS(params3, params4) \
  40   JVMCI_FLAGS(params4, params3, params4, params3, params4, params3, params4, params4, IGNORE_RANGE, IGNORE_CONSTRAINT)
  41 #define JVMCI_DECLARE_CHECK4(type, name, value, doc) bool name##checked = false;
  42 #define JVMCI_DECLARE_CHECK3(type, name, doc)        bool name##checked = false;
  43 #define JVMCI_FLAG_CHECKED(name)                          name##checked = true;
  44   APPLY_JVMCI_FLAGS(JVMCI_DECLARE_CHECK3, JVMCI_DECLARE_CHECK4)
  45 #else
  46 #define JVMCI_FLAG_CHECKED(name)
  47 #endif
  48 
  49   // Checks that a given flag is not set if a given guard flag is false.
  50 #define CHECK_NOT_SET(FLAG, GUARD)                     \
  51   JVMCI_FLAG_CHECKED(FLAG)                             \
  52   if (!GUARD && !FLAG_IS_DEFAULT(FLAG)) {              \
  53     jio_fprintf(defaultStream::error_stream(),         \
  54         "Improperly specified VM option '%s': '%s' must be enabled\n", #FLAG, #GUARD); \
  55     return false;                                      \
  56   }
  57 
  58   if (EnableJVMCIProduct) {
  59     if (FLAG_IS_DEFAULT(EnableJVMCI)) {
  60       FLAG_SET_DEFAULT(EnableJVMCI, true);
  61     }
  62     if (EnableJVMCI && FLAG_IS_DEFAULT(UseJVMCICompiler)) {
  63       FLAG_SET_DEFAULT(UseJVMCICompiler, true);
  64     }
  65   }
  66 
  67   JVMCI_FLAG_CHECKED(UseJVMCICompiler)
  68   JVMCI_FLAG_CHECKED(EnableJVMCI)
  69   JVMCI_FLAG_CHECKED(EnableJVMCIProduct)
  70 
  71   CHECK_NOT_SET(BootstrapJVMCI,   UseJVMCICompiler)
  72   CHECK_NOT_SET(PrintBootstrap,   UseJVMCICompiler)
  73   CHECK_NOT_SET(JVMCIThreads,     UseJVMCICompiler)
  74   CHECK_NOT_SET(JVMCIHostThreads, UseJVMCICompiler)
  75 
  76   if (UseJVMCICompiler) {
  77     if (FLAG_IS_DEFAULT(UseJVMCINativeLibrary) && !UseJVMCINativeLibrary) {
  78       char path[JVM_MAXPATHLEN];
  79       if (os::dll_locate_lib(path, sizeof(path), Arguments::get_dll_dir(), JVMCI_SHARED_LIBRARY_NAME)) {
  80         // If a JVMCI native library is present,
  81         // we enable UseJVMCINativeLibrary by default.
  82         FLAG_SET_DEFAULT(UseJVMCINativeLibrary, true);
  83       }
  84     }
  85     if (!FLAG_IS_DEFAULT(EnableJVMCI) && !EnableJVMCI) {
  86       jio_fprintf(defaultStream::error_stream(),
  87           "Improperly specified VM option UseJVMCICompiler: EnableJVMCI cannot be disabled\n");
  88       return false;
  89     }
  90     FLAG_SET_DEFAULT(EnableJVMCI, true);
  91     if (BootstrapJVMCI && UseJVMCINativeLibrary) {
  92       jio_fprintf(defaultStream::error_stream(), "-XX:+BootstrapJVMCI is not compatible with -XX:+UseJVMCINativeLibrary\n");
  93       return false;
  94     }
  95     if (BootstrapJVMCI && (TieredStopAtLevel < CompLevel_full_optimization)) {
  96       jio_fprintf(defaultStream::error_stream(),
  97           "-XX:+BootstrapJVMCI is not compatible with -XX:TieredStopAtLevel=%d\n", TieredStopAtLevel);
  98       return false;
  99     }
 100   }
 101 
 102   if (!EnableJVMCI) {
 103     // Switch off eager JVMCI initialization if JVMCI is disabled.
 104     // Don't throw error if EagerJVMCI is set to allow testing.
 105     if (EagerJVMCI) {
 106       FLAG_SET_DEFAULT(EagerJVMCI, false);
 107     }
 108   }
 109   JVMCI_FLAG_CHECKED(EagerJVMCI)
 110 
 111   CHECK_NOT_SET(JVMCITraceLevel,              EnableJVMCI)
 112   CHECK_NOT_SET(JVMCICounterSize,             EnableJVMCI)
 113   CHECK_NOT_SET(JVMCICountersExcludeCompiler, EnableJVMCI)
 114   CHECK_NOT_SET(JVMCIUseFastLocking,          EnableJVMCI)
 115   CHECK_NOT_SET(JVMCINMethodSizeLimit,        EnableJVMCI)
 116   CHECK_NOT_SET(JVMCIPrintProperties,         EnableJVMCI)
 117   CHECK_NOT_SET(UseJVMCINativeLibrary,        EnableJVMCI)
 118   CHECK_NOT_SET(JVMCILibPath,                 EnableJVMCI)
 119   CHECK_NOT_SET(JVMCILibDumpJNIConfig,        EnableJVMCI)
 120 
 121 #ifndef COMPILER2
 122   JVMCI_FLAG_CHECKED(MaxVectorSize)
 123   JVMCI_FLAG_CHECKED(ReduceInitialCardMarks)
 124   JVMCI_FLAG_CHECKED(UseMultiplyToLenIntrinsic)
 125   JVMCI_FLAG_CHECKED(UseSquareToLenIntrinsic)
 126   JVMCI_FLAG_CHECKED(UseMulAddIntrinsic)
 127   JVMCI_FLAG_CHECKED(UseMontgomeryMultiplyIntrinsic)
 128   JVMCI_FLAG_CHECKED(UseMontgomerySquareIntrinsic)
 129 #endif // !COMPILER2
 130 
 131 #ifndef PRODUCT
 132 #define JVMCI_CHECK4(type, name, value, doc) assert(name##checked, #name " flag not checked");
 133 #define JVMCI_CHECK3(type, name, doc)        assert(name##checked, #name " flag not checked");
 134   // Ensures that all JVMCI flags are checked by this method.
 135   APPLY_JVMCI_FLAGS(JVMCI_CHECK3, JVMCI_CHECK4)
 136 #undef APPLY_JVMCI_FLAGS
 137 #undef JVMCI_DECLARE_CHECK3
 138 #undef JVMCI_DECLARE_CHECK4
 139 #undef JVMCI_CHECK3
 140 #undef JVMCI_CHECK4
 141 #undef JVMCI_FLAG_CHECKED
 142 #endif // PRODUCT
 143 #undef CHECK_NOT_SET
 144 
 145   if (JVMCILibDumpJNIConfig != NULL) {
 146     _jni_config_file = new(ResourceObj::C_HEAP, mtJVMCI) fileStream(JVMCILibDumpJNIConfig);
 147     if (_jni_config_file == NULL || !_jni_config_file->is_open()) {
 148       jio_fprintf(defaultStream::error_stream(),
 149           "Could not open file for dumping JVMCI shared library JNI config: %s\n", JVMCILibDumpJNIConfig);
 150       return false;
 151     }
 152   }
 153 
 154   return true;
 155 }
 156 
 157 // Convert JVMCI flags from experimental to product
 158 bool JVMCIGlobals::enable_jvmci_product_mode(JVMFlag::Flags origin) {
 159   const char *JVMCIFlags[] = {
 160     "EnableJVMCI",
 161     "EnableJVMCIProduct",
 162     "UseJVMCICompiler",
 163     "JVMCIPrintProperties",
 164     "EagerJVMCI",
 165     "JVMCIThreads",
 166     "JVMCICounterSize",
 167     "JVMCICountersExcludeCompiler",
 168     "JVMCINMethodSizeLimit",
 169     "JVMCILibPath",
 170     "JVMCILibDumpJNIConfig",
 171     "UseJVMCINativeLibrary",
 172     NULL
 173   };
 174 
 175   for (int i = 0; JVMCIFlags[i] != NULL; i++) {
 176     JVMFlag *jvmciFlag = (JVMFlag *)JVMFlag::find_declared_flag(JVMCIFlags[i]);
 177     if (jvmciFlag == NULL) {
 178       return false;
 179     }
 180     jvmciFlag->clear_experimental();
 181     jvmciFlag->set_product();
 182   }
 183 
 184   bool value = true;
 185   JVMFlag *jvmciEnableFlag = JVMFlag::find_flag("EnableJVMCIProduct");
 186   if (JVMFlag::boolAtPut(jvmciEnableFlag, &value, origin) != JVMFlag::SUCCESS) {
 187     return false;
 188   }
 189 
 190   // Effect of EnableJVMCIProduct on changing defaults of EnableJVMCI
 191   // and UseJVMCICompiler is deferred to check_jvmci_flags_are_consistent
 192   // so that setting these flags explicitly (e.g. on the command line)
 193   // takes precedence.
 194 
 195   return true;
 196 }
 197 
 198 void JVMCIGlobals::check_jvmci_supported_gc() {
 199   if (EnableJVMCI) {
 200     // Check if selected GC is supported by JVMCI and Java compiler
 201     if (!(UseSerialGC || UseParallelGC || UseG1GC)) {
 202       vm_exit_during_initialization("JVMCI Compiler does not support selected GC", GCConfig::hs_err_name());
 203       FLAG_SET_DEFAULT(EnableJVMCI, false);
 204       FLAG_SET_DEFAULT(UseJVMCICompiler, false);
 205     }
 206   }
 207 }