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                           "CompileThreshold * (OnStackReplacePercentage - InterpreterProfilePercentage) / 100 = "
 164                           INTX_FORMAT " "
 165                           "must be between 0 and %d, try changing "
 166                           "CompileThreshold, InterpreterProfilePercentage, and/or OnStackReplacePercentage\n",
 167                           (CompileThreshold * (value - InterpreterProfilePercentage)) / 100,
 168                           INT_MAX >> InvocationCounter::count_shift);
 169       return JVMFlag::VIOLATES_CONSTRAINT;
 170     }
 171   } else {
 172     if (value < 0) {
 173       JVMFlag::printError(verbose,
 174                           "OnStackReplacePercentage (" INTX_FORMAT ") must be "
 175                           "non-negative\n", value);
 176       return JVMFlag::VIOLATES_CONSTRAINT;
 177     }
 178 
 179     if (value > max_percentage_limit) {
 180       JVMFlag::printError(verbose,
 181                           "CompileThreshold * OnStackReplacePercentage / 100 = " INTX_FORMAT " "
 182                           "must be between 0 and %d, try changing "
 183                           "CompileThreshold and/or OnStackReplacePercentage\n",
 184                           (CompileThreshold * value) / 100,
 185                           INT_MAX >> InvocationCounter::count_shift);
 186       return JVMFlag::VIOLATES_CONSTRAINT;
 187     }
 188   }
 189   return JVMFlag::SUCCESS;
 190 }
 191 
 192 JVMFlag::Error CodeCacheSegmentSizeConstraintFunc(uintx value, bool verbose) {
 193   if (CodeCacheSegmentSize < (uintx)CodeEntryAlignment) {
 194     JVMFlag::printError(verbose,
 195                         "CodeCacheSegmentSize  (" UINTX_FORMAT ") must be "
 196                         "larger than or equal to CodeEntryAlignment (" INTX_FORMAT ") "
 197                         "to align entry points\n",
 198                         CodeCacheSegmentSize, CodeEntryAlignment);
 199     return JVMFlag::VIOLATES_CONSTRAINT;
 200   }
 201 
 202   if (CodeCacheSegmentSize < sizeof(jdouble)) {
 203     JVMFlag::printError(verbose,
 204                         "CodeCacheSegmentSize  (" UINTX_FORMAT ") must be "
 205                         "at least " SIZE_FORMAT " to align constants\n",
 206                         CodeCacheSegmentSize, sizeof(jdouble));
 207     return JVMFlag::VIOLATES_CONSTRAINT;
 208   }
 209 
 210 #ifdef COMPILER2
 211   if (CodeCacheSegmentSize < (uintx)OptoLoopAlignment) {
 212     JVMFlag::printError(verbose,
 213                         "CodeCacheSegmentSize  (" UINTX_FORMAT ") must be "
 214                         "larger than or equal to OptoLoopAlignment (" INTX_FORMAT ") "
 215                         "to align inner loops\n",
 216                         CodeCacheSegmentSize, OptoLoopAlignment);
 217     return JVMFlag::VIOLATES_CONSTRAINT;
 218   }
 219 #endif
 220 
 221   return JVMFlag::SUCCESS;
 222 }
 223 
 224 JVMFlag::Error CompilerThreadPriorityConstraintFunc(intx value, bool verbose) {
 225 #ifdef SOLARIS
 226   if ((value < MinimumPriority || value > MaximumPriority) &&
 227       (value != -1) && (value != -FXCriticalPriority)) {
 228     JVMFlag::printError(verbose,
 229                         "CompileThreadPriority (" INTX_FORMAT ") must be "
 230                         "between %d and %d inclusively or -1 (means no change) "
 231                         "or %d (special value for critical thread class/priority)\n",
 232                         value, MinimumPriority, MaximumPriority, -FXCriticalPriority);
 233     return JVMFlag::VIOLATES_CONSTRAINT;
 234   }
 235 #endif
 236 
 237   return JVMFlag::SUCCESS;
 238 }
 239 
 240 JVMFlag::Error CodeEntryAlignmentConstraintFunc(intx value, bool verbose) {
 241 #ifdef SPARC
 242   if (CodeEntryAlignment % relocInfo::addr_unit() != 0) {
 243     JVMFlag::printError(verbose,
 244                         "CodeEntryAlignment (" INTX_FORMAT ") must be "
 245                         "multiple of NOP size\n", CodeEntryAlignment);
 246     return JVMFlag::VIOLATES_CONSTRAINT;
 247   }
 248 #endif
 249 
 250   if (!is_power_of_2(value)) {
 251     JVMFlag::printError(verbose,
 252                         "CodeEntryAlignment (" INTX_FORMAT ") must be "
 253                         "a power of two\n", CodeEntryAlignment);
 254     return JVMFlag::VIOLATES_CONSTRAINT;
 255   }
 256 
 257   if (CodeEntryAlignment < 16) {
 258       JVMFlag::printError(verbose,
 259                           "CodeEntryAlignment (" INTX_FORMAT ") must be "
 260                           "greater than or equal to %d\n",
 261                           CodeEntryAlignment, 16);
 262       return JVMFlag::VIOLATES_CONSTRAINT;
 263   }
 264 
 265   return JVMFlag::SUCCESS;
 266 }
 267 
 268 JVMFlag::Error OptoLoopAlignmentConstraintFunc(intx value, bool verbose) {
 269   if (!is_power_of_2(value)) {
 270     JVMFlag::printError(verbose,
 271                         "OptoLoopAlignment (" INTX_FORMAT ") "
 272                         "must be a power of two\n",
 273                         value);
 274     return JVMFlag::VIOLATES_CONSTRAINT;
 275   }
 276 
 277   // Relevant on ppc, s390, sparc. Will be optimized where
 278   // addr_unit() == 1.
 279   if (OptoLoopAlignment % relocInfo::addr_unit() != 0) {
 280     JVMFlag::printError(verbose,
 281                         "OptoLoopAlignment (" INTX_FORMAT ") must be "
 282                         "multiple of NOP size (%d)\n",
 283                         value, relocInfo::addr_unit());
 284     return JVMFlag::VIOLATES_CONSTRAINT;
 285   }
 286 
 287   return JVMFlag::SUCCESS;
 288 }
 289 
 290 JVMFlag::Error ArraycopyDstPrefetchDistanceConstraintFunc(uintx value, bool verbose) {
 291   if (value >= 4032) {
 292     JVMFlag::printError(verbose,
 293                         "ArraycopyDstPrefetchDistance (" UINTX_FORMAT ") must be"
 294                         "between 0 and 4031\n", value);
 295     return JVMFlag::VIOLATES_CONSTRAINT;
 296   }
 297 
 298   return JVMFlag::SUCCESS;
 299 }
 300 
 301 JVMFlag::Error ArraycopySrcPrefetchDistanceConstraintFunc(uintx value, bool verbose) {
 302   if (value >= 4032) {
 303     JVMFlag::printError(verbose,
 304                         "ArraycopySrcPrefetchDistance (" UINTX_FORMAT ") must be"
 305                         "between 0 and 4031\n", value);
 306     return JVMFlag::VIOLATES_CONSTRAINT;
 307   }
 308 
 309   return JVMFlag::SUCCESS;
 310 }
 311 
 312 JVMFlag::Error TypeProfileLevelConstraintFunc(uintx value, bool verbose) {
 313   for (int i = 0; i < 3; i++) {
 314     if (value % 10 > 2) {
 315       JVMFlag::printError(verbose,
 316                           "Invalid value (" UINTX_FORMAT ") "
 317                           "in TypeProfileLevel at position %d\n", value, i);
 318       return JVMFlag::VIOLATES_CONSTRAINT;
 319     }
 320     value = value / 10;
 321   }
 322 
 323   return JVMFlag::SUCCESS;
 324 }
 325 
 326 JVMFlag::Error InitArrayShortSizeConstraintFunc(intx value, bool verbose) {
 327   if (value % BytesPerLong != 0) {
 328     return JVMFlag::VIOLATES_CONSTRAINT;
 329   } else {
 330     return JVMFlag::SUCCESS;
 331   }
 332 }
 333 
 334 #ifdef COMPILER2
 335 JVMFlag::Error InteriorEntryAlignmentConstraintFunc(intx value, bool verbose) {
 336   if (InteriorEntryAlignment > CodeEntryAlignment) {
 337     JVMFlag::printError(verbose,
 338                        "InteriorEntryAlignment (" INTX_FORMAT ") must be "
 339                        "less than or equal to CodeEntryAlignment (" INTX_FORMAT ")\n",
 340                        InteriorEntryAlignment, CodeEntryAlignment);
 341     return JVMFlag::VIOLATES_CONSTRAINT;
 342   }
 343 
 344 #ifdef SPARC
 345   if (InteriorEntryAlignment % relocInfo::addr_unit() != 0) {
 346     JVMFlag::printError(verbose,
 347                         "InteriorEntryAlignment (" INTX_FORMAT ") must be "
 348                         "multiple of NOP size\n");
 349     return JVMFlag::VIOLATES_CONSTRAINT;
 350   }
 351 #endif
 352 
 353   if (!is_power_of_2(value)) {
 354      JVMFlag::printError(verbose,
 355                          "InteriorEntryAlignment (" INTX_FORMAT ") must be "
 356                          "a power of two\n", InteriorEntryAlignment);
 357      return JVMFlag::VIOLATES_CONSTRAINT;
 358    }
 359 
 360   int minimum_alignment = 16;
 361 #if defined(SPARC) || (defined(X86) && !defined(AMD64))
 362   minimum_alignment = 4;
 363 #elif defined(S390)
 364   minimum_alignment = 2;
 365 #endif
 366 
 367   if (InteriorEntryAlignment < minimum_alignment) {
 368     JVMFlag::printError(verbose,
 369                         "InteriorEntryAlignment (" INTX_FORMAT ") must be "
 370                         "greater than or equal to %d\n",
 371                         InteriorEntryAlignment, minimum_alignment);
 372     return JVMFlag::VIOLATES_CONSTRAINT;
 373   }
 374 
 375   return JVMFlag::SUCCESS;
 376 }
 377 
 378 JVMFlag::Error NodeLimitFudgeFactorConstraintFunc(intx value, bool verbose) {
 379   if (value < MaxNodeLimit * 2 / 100 || value > MaxNodeLimit * 40 / 100) {
 380     JVMFlag::printError(verbose,
 381                         "NodeLimitFudgeFactor must be between 2%% and 40%% "
 382                         "of MaxNodeLimit (" INTX_FORMAT ")\n",
 383                         MaxNodeLimit);
 384     return JVMFlag::VIOLATES_CONSTRAINT;
 385   }
 386 
 387   return JVMFlag::SUCCESS;
 388 }
 389 #endif // COMPILER2
 390 
 391 JVMFlag::Error RTMTotalCountIncrRateConstraintFunc(int value, bool verbose) {
 392 #if INCLUDE_RTM_OPT
 393   if (UseRTMLocking && !is_power_of_2(RTMTotalCountIncrRate)) {
 394     JVMFlag::printError(verbose,
 395                         "RTMTotalCountIncrRate (%d) must be "
 396                         "a power of 2, resetting it to 64\n",
 397                         RTMTotalCountIncrRate);
 398     FLAG_SET_DEFAULT(RTMTotalCountIncrRate, 64);
 399   }
 400 #endif
 401 
 402   return JVMFlag::SUCCESS;
 403 }