1 /*
   2  * Copyright (c) 2015, 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 #include "precompiled.hpp"
  26 #include "code/relocInfo.hpp"
  27 #include "compiler/compilerDefinitions.hpp"
  28 #include "oops/metadata.hpp"
  29 #include "runtime/os.hpp"
  30 #include "interpreter/invocationCounter.hpp"
  31 #include "runtime/arguments.hpp"
  32 #include "runtime/flags/jvmFlag.hpp"
  33 #include "runtime/flags/jvmFlagConstraintsCompiler.hpp"
  34 #include "runtime/globals.hpp"
  35 #include "runtime/globals_extension.hpp"
  36 
  37 JVMFlag::Error AliasLevelConstraintFunc(intx value, bool verbose) {
  38   if ((value <= 1) && (Arguments::mode() == Arguments::_comp || Arguments::mode() == Arguments::_mixed)) {
  39     JVMFlag::printError(verbose,
  40                         "AliasLevel (" INTX_FORMAT ") is not "
  41                         "compatible with -Xcomp or -Xmixed\n",
  42                         value);
  43     return JVMFlag::VIOLATES_CONSTRAINT;
  44   } else {
  45     return JVMFlag::SUCCESS;
  46   }
  47 }
  48 
  49 /**
  50  * Validate the minimum number of compiler threads needed to run the
  51  * JVM. The following configurations are possible.
  52  *
  53  * 1) The JVM is build using an interpreter only. As a result, the minimum number of
  54  *    compiler threads is 0.
  55  * 2) The JVM is build using the compiler(s) and tiered compilation is disabled. As
  56  *    a result, either C1 or C2 is used, so the minimum number of compiler threads is 1.
  57  * 3) The JVM is build using the compiler(s) and tiered compilation is enabled. However,
  58  *    the option "TieredStopAtLevel < CompLevel_full_optimization". As a result, only
  59  *    C1 can be used, so the minimum number of compiler threads is 1.
  60  * 4) The JVM is build using the compilers and tiered compilation is enabled. The option
  61  *    'TieredStopAtLevel = CompLevel_full_optimization' (the default value). As a result,
  62  *    the minimum number of compiler threads is 2.
  63  */
  64 JVMFlag::Error CICompilerCountConstraintFunc(intx value, bool verbose) {
  65   int min_number_of_compiler_threads = 0;
  66 #if !defined(COMPILER1) && !defined(COMPILER2) && !INCLUDE_JVMCI
  67   // case 1
  68 #else
  69   if (!TieredCompilation || (TieredStopAtLevel < CompLevel_full_optimization)) {
  70     min_number_of_compiler_threads = 1; // case 2 or case 3
  71   } else {
  72     min_number_of_compiler_threads = 2;   // case 4 (tiered)
  73   }
  74 #endif
  75 
  76   // The default CICompilerCount's value is CI_COMPILER_COUNT.
  77   // With a client VM, -XX:+TieredCompilation causes TieredCompilation
  78   // to be true here (the option is validated later) and
  79   // min_number_of_compiler_threads to exceed CI_COMPILER_COUNT.
  80   min_number_of_compiler_threads = MIN2(min_number_of_compiler_threads, CI_COMPILER_COUNT);
  81 
  82   if (value < (intx)min_number_of_compiler_threads) {
  83     JVMFlag::printError(verbose,
  84                         "CICompilerCount (" INTX_FORMAT ") must be "
  85                         "at least %d \n",
  86                         value, min_number_of_compiler_threads);
  87     return JVMFlag::VIOLATES_CONSTRAINT;
  88   } else {
  89     return JVMFlag::SUCCESS;
  90   }
  91 }
  92 
  93 JVMFlag::Error AllocatePrefetchDistanceConstraintFunc(intx value, bool verbose) {
  94   if (value < 0 || value > 512) {
  95     JVMFlag::printError(verbose,
  96                         "AllocatePrefetchDistance (" INTX_FORMAT ") must be "
  97                         "between 0 and %d\n",
  98                         AllocatePrefetchDistance, 512);
  99     return JVMFlag::VIOLATES_CONSTRAINT;
 100   }
 101 
 102   return JVMFlag::SUCCESS;
 103 }
 104 
 105 JVMFlag::Error AllocatePrefetchStepSizeConstraintFunc(intx value, bool verbose) {
 106   if (AllocatePrefetchStyle == 3) {
 107     if (value % wordSize != 0) {
 108       JVMFlag::printError(verbose,
 109                           "AllocatePrefetchStepSize (" INTX_FORMAT ") must be multiple of %d\n",
 110                           value, wordSize);
 111       return JVMFlag::VIOLATES_CONSTRAINT;
 112     }
 113   }
 114   return JVMFlag::SUCCESS;
 115 }
 116 
 117 JVMFlag::Error AllocatePrefetchInstrConstraintFunc(intx value, bool verbose) {
 118   intx max_value = max_intx;
 119 #if defined(SPARC)
 120   max_value = 1;
 121 #elif defined(X86)
 122   max_value = 3;
 123 #endif
 124   if (value < 0 || value > max_value) {
 125     JVMFlag::printError(verbose,
 126                         "AllocatePrefetchInstr (" INTX_FORMAT ") must be "
 127                         "between 0 and " INTX_FORMAT "\n", value, max_value);
 128     return JVMFlag::VIOLATES_CONSTRAINT;
 129   }
 130 
 131   return JVMFlag::SUCCESS;
 132 }
 133 
 134 JVMFlag::Error CompileThresholdConstraintFunc(intx value, bool verbose) {
 135   if (value < 0 || value > INT_MAX >> InvocationCounter::count_shift) {
 136     JVMFlag::printError(verbose,
 137                         "CompileThreshold (" INTX_FORMAT ") "
 138                         "must be between 0 and %d\n",
 139                         value,
 140                         INT_MAX >> InvocationCounter::count_shift);
 141     return JVMFlag::VIOLATES_CONSTRAINT;
 142   }
 143 
 144   return JVMFlag::SUCCESS;
 145 }
 146 
 147 JVMFlag::Error OnStackReplacePercentageConstraintFunc(intx value, bool verbose) {
 148   int64_t  max_percentage_limit = ((int64_t)INT_MAX>>InvocationCounter::count_shift)*100;
 149   max_percentage_limit = CompileThreshold == 0  ? max_percentage_limit : max_percentage_limit/CompileThreshold;
 150   
 151   if (ProfileInterpreter) {
 152     if (value < InterpreterProfilePercentage) {
 153       JVMFlag::printError(verbose,
 154                           "OnStackReplacePercentage (" INTX_FORMAT ") must be "
 155                           "larger than InterpreterProfilePercentage (" INTX_FORMAT ")\n",
 156                           value, InterpreterProfilePercentage);
 157       return JVMFlag::VIOLATES_CONSTRAINT;
 158     }
 159 
 160     max_percentage_limit += InterpreterProfilePercentage;
 161     if (value > max_percentage_limit) {
 162       JVMFlag::printError(verbose,
 163                           "OnStackReplacePercentage (" INTX_FORMAT ") must be between 0 and " INT64_FORMAT "\n",
 164                           value,
 165                           max_percentage_limit);
 166       return JVMFlag::VIOLATES_CONSTRAINT;
 167     }
 168   } else {
 169     if (value < 0) {
 170       JVMFlag::printError(verbose,
 171                           "OnStackReplacePercentage (" INTX_FORMAT ") must be "
 172                           "non-negative\n", value);
 173       return JVMFlag::VIOLATES_CONSTRAINT;
 174     }
 175 
 176     if (value > max_percentage_limit) {
 177       JVMFlag::printError(verbose,
 178                           "OnStackReplacePercentage (" INTX_FORMAT ") must be between 0 and " INT64_FORMAT "\n",
 179                           value,
 180                           max_percentage_limit);
 181       return JVMFlag::VIOLATES_CONSTRAINT;
 182     }
 183   }
 184   return JVMFlag::SUCCESS;
 185 }
 186 
 187 JVMFlag::Error CodeCacheSegmentSizeConstraintFunc(uintx value, bool verbose) {
 188   if (CodeCacheSegmentSize < (uintx)CodeEntryAlignment) {
 189     JVMFlag::printError(verbose,
 190                         "CodeCacheSegmentSize  (" UINTX_FORMAT ") must be "
 191                         "larger than or equal to CodeEntryAlignment (" INTX_FORMAT ") "
 192                         "to align entry points\n",
 193                         CodeCacheSegmentSize, CodeEntryAlignment);
 194     return JVMFlag::VIOLATES_CONSTRAINT;
 195   }
 196 
 197   if (CodeCacheSegmentSize < sizeof(jdouble)) {
 198     JVMFlag::printError(verbose,
 199                         "CodeCacheSegmentSize  (" UINTX_FORMAT ") must be "
 200                         "at least " SIZE_FORMAT " to align constants\n",
 201                         CodeCacheSegmentSize, sizeof(jdouble));
 202     return JVMFlag::VIOLATES_CONSTRAINT;
 203   }
 204 
 205 #ifdef COMPILER2
 206   if (CodeCacheSegmentSize < (uintx)OptoLoopAlignment) {
 207     JVMFlag::printError(verbose,
 208                         "CodeCacheSegmentSize  (" UINTX_FORMAT ") must be "
 209                         "larger than or equal to OptoLoopAlignment (" INTX_FORMAT ") "
 210                         "to align inner loops\n",
 211                         CodeCacheSegmentSize, OptoLoopAlignment);
 212     return JVMFlag::VIOLATES_CONSTRAINT;
 213   }
 214 #endif
 215 
 216   return JVMFlag::SUCCESS;
 217 }
 218 
 219 JVMFlag::Error CompilerThreadPriorityConstraintFunc(intx value, bool verbose) {
 220 #ifdef SOLARIS
 221   if ((value < MinimumPriority || value > MaximumPriority) &&
 222       (value != -1) && (value != -FXCriticalPriority)) {
 223     JVMFlag::printError(verbose,
 224                         "CompileThreadPriority (" INTX_FORMAT ") must be "
 225                         "between %d and %d inclusively or -1 (means no change) "
 226                         "or %d (special value for critical thread class/priority)\n",
 227                         value, MinimumPriority, MaximumPriority, -FXCriticalPriority);
 228     return JVMFlag::VIOLATES_CONSTRAINT;
 229   }
 230 #endif
 231 
 232   return JVMFlag::SUCCESS;
 233 }
 234 
 235 JVMFlag::Error CodeEntryAlignmentConstraintFunc(intx value, bool verbose) {
 236 #ifdef SPARC
 237   if (CodeEntryAlignment % relocInfo::addr_unit() != 0) {
 238     JVMFlag::printError(verbose,
 239                         "CodeEntryAlignment (" INTX_FORMAT ") must be "
 240                         "multiple of NOP size\n", CodeEntryAlignment);
 241     return JVMFlag::VIOLATES_CONSTRAINT;
 242   }
 243 #endif
 244 
 245   if (!is_power_of_2(value)) {
 246     JVMFlag::printError(verbose,
 247                         "CodeEntryAlignment (" INTX_FORMAT ") must be "
 248                         "a power of two\n", CodeEntryAlignment);
 249     return JVMFlag::VIOLATES_CONSTRAINT;
 250   }
 251 
 252   if (CodeEntryAlignment < 16) {
 253       JVMFlag::printError(verbose,
 254                           "CodeEntryAlignment (" INTX_FORMAT ") must be "
 255                           "greater than or equal to %d\n",
 256                           CodeEntryAlignment, 16);
 257       return JVMFlag::VIOLATES_CONSTRAINT;
 258   }
 259 
 260   return JVMFlag::SUCCESS;
 261 }
 262 
 263 JVMFlag::Error OptoLoopAlignmentConstraintFunc(intx value, bool verbose) {
 264   if (!is_power_of_2(value)) {
 265     JVMFlag::printError(verbose,
 266                         "OptoLoopAlignment (" INTX_FORMAT ") "
 267                         "must be a power of two\n",
 268                         value);
 269     return JVMFlag::VIOLATES_CONSTRAINT;
 270   }
 271 
 272   // Relevant on ppc, s390, sparc. Will be optimized where
 273   // addr_unit() == 1.
 274   if (OptoLoopAlignment % relocInfo::addr_unit() != 0) {
 275     JVMFlag::printError(verbose,
 276                         "OptoLoopAlignment (" INTX_FORMAT ") must be "
 277                         "multiple of NOP size (%d)\n",
 278                         value, relocInfo::addr_unit());
 279     return JVMFlag::VIOLATES_CONSTRAINT;
 280   }
 281 
 282   return JVMFlag::SUCCESS;
 283 }
 284 
 285 JVMFlag::Error ArraycopyDstPrefetchDistanceConstraintFunc(uintx value, bool verbose) {
 286   if (value >= 4032) {
 287     JVMFlag::printError(verbose,
 288                         "ArraycopyDstPrefetchDistance (" UINTX_FORMAT ") must be"
 289                         "between 0 and 4031\n", value);
 290     return JVMFlag::VIOLATES_CONSTRAINT;
 291   }
 292 
 293   return JVMFlag::SUCCESS;
 294 }
 295 
 296 JVMFlag::Error ArraycopySrcPrefetchDistanceConstraintFunc(uintx value, bool verbose) {
 297   if (value >= 4032) {
 298     JVMFlag::printError(verbose,
 299                         "ArraycopySrcPrefetchDistance (" UINTX_FORMAT ") must be"
 300                         "between 0 and 4031\n", value);
 301     return JVMFlag::VIOLATES_CONSTRAINT;
 302   }
 303 
 304   return JVMFlag::SUCCESS;
 305 }
 306 
 307 JVMFlag::Error TypeProfileLevelConstraintFunc(uintx value, bool verbose) {
 308   for (int i = 0; i < 3; i++) {
 309     if (value % 10 > 2) {
 310       JVMFlag::printError(verbose,
 311                           "Invalid value (" UINTX_FORMAT ") "
 312                           "in TypeProfileLevel at position %d\n", value, i);
 313       return JVMFlag::VIOLATES_CONSTRAINT;
 314     }
 315     value = value / 10;
 316   }
 317 
 318   return JVMFlag::SUCCESS;
 319 }
 320 
 321 JVMFlag::Error InitArrayShortSizeConstraintFunc(intx value, bool verbose) {
 322   if (value % BytesPerLong != 0) {
 323     return JVMFlag::VIOLATES_CONSTRAINT;
 324   } else {
 325     return JVMFlag::SUCCESS;
 326   }
 327 }
 328 
 329 #ifdef COMPILER2
 330 JVMFlag::Error InteriorEntryAlignmentConstraintFunc(intx value, bool verbose) {
 331   if (InteriorEntryAlignment > CodeEntryAlignment) {
 332     JVMFlag::printError(verbose,
 333                        "InteriorEntryAlignment (" INTX_FORMAT ") must be "
 334                        "less than or equal to CodeEntryAlignment (" INTX_FORMAT ")\n",
 335                        InteriorEntryAlignment, CodeEntryAlignment);
 336     return JVMFlag::VIOLATES_CONSTRAINT;
 337   }
 338 
 339 #ifdef SPARC
 340   if (InteriorEntryAlignment % relocInfo::addr_unit() != 0) {
 341     JVMFlag::printError(verbose,
 342                         "InteriorEntryAlignment (" INTX_FORMAT ") must be "
 343                         "multiple of NOP size\n");
 344     return JVMFlag::VIOLATES_CONSTRAINT;
 345   }
 346 #endif
 347 
 348   if (!is_power_of_2(value)) {
 349      JVMFlag::printError(verbose,
 350                          "InteriorEntryAlignment (" INTX_FORMAT ") must be "
 351                          "a power of two\n", InteriorEntryAlignment);
 352      return JVMFlag::VIOLATES_CONSTRAINT;
 353    }
 354 
 355   int minimum_alignment = 16;
 356 #if defined(SPARC) || (defined(X86) && !defined(AMD64))
 357   minimum_alignment = 4;
 358 #elif defined(S390)
 359   minimum_alignment = 2;
 360 #endif
 361 
 362   if (InteriorEntryAlignment < minimum_alignment) {
 363     JVMFlag::printError(verbose,
 364                         "InteriorEntryAlignment (" INTX_FORMAT ") must be "
 365                         "greater than or equal to %d\n",
 366                         InteriorEntryAlignment, minimum_alignment);
 367     return JVMFlag::VIOLATES_CONSTRAINT;
 368   }
 369 
 370   return JVMFlag::SUCCESS;
 371 }
 372 
 373 JVMFlag::Error NodeLimitFudgeFactorConstraintFunc(intx value, bool verbose) {
 374   if (value < MaxNodeLimit * 2 / 100 || value > MaxNodeLimit * 40 / 100) {
 375     JVMFlag::printError(verbose,
 376                         "NodeLimitFudgeFactor must be between 2%% and 40%% "
 377                         "of MaxNodeLimit (" INTX_FORMAT ")\n",
 378                         MaxNodeLimit);
 379     return JVMFlag::VIOLATES_CONSTRAINT;
 380   }
 381 
 382   return JVMFlag::SUCCESS;
 383 }
 384 #endif // COMPILER2
 385 
 386 JVMFlag::Error RTMTotalCountIncrRateConstraintFunc(int value, bool verbose) {
 387 #if INCLUDE_RTM_OPT
 388   if (UseRTMLocking && !is_power_of_2(RTMTotalCountIncrRate)) {
 389     JVMFlag::printError(verbose,
 390                         "RTMTotalCountIncrRate (%d) must be "
 391                         "a power of 2, resetting it to 64\n",
 392                         RTMTotalCountIncrRate);
 393     FLAG_SET_DEFAULT(RTMTotalCountIncrRate, 64);
 394   }
 395 #endif
 396 
 397   return JVMFlag::SUCCESS;
 398 }