1 /*
   2  * Copyright (c) 2015, 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 "classfile/stringTable.hpp"
  27 #include "classfile/symbolTable.hpp"
  28 #include "gc/shared/referenceProcessor.hpp"
  29 #include "runtime/arguments.hpp"
  30 #include "runtime/commandLineFlagConstraintList.hpp"
  31 #include "runtime/commandLineFlagConstraintsCompiler.hpp"
  32 #include "runtime/commandLineFlagConstraintsGC.hpp"
  33 #include "runtime/commandLineFlagConstraintsRuntime.hpp"
  34 #include "runtime/os.hpp"
  35 #include "utilities/macros.hpp"
  36 
  37 class CommandLineFlagConstraint_bool : public CommandLineFlagConstraint {
  38   CommandLineFlagConstraintFunc_bool _constraint;
  39 
  40 public:
  41   // the "name" argument must be a string literal
  42   CommandLineFlagConstraint_bool(const char* name,
  43                                  CommandLineFlagConstraintFunc_bool func,
  44                                  ConstraintType type) : CommandLineFlagConstraint(name, type) {
  45     _constraint=func;
  46   }
  47 
  48   Flag::Error apply_bool(bool* value, bool verbose) {
  49     return _constraint(verbose, value);
  50   }
  51 };
  52 
  53 class CommandLineFlagConstraint_int : public CommandLineFlagConstraint {
  54   CommandLineFlagConstraintFunc_int _constraint;
  55 
  56 public:
  57   // the "name" argument must be a string literal
  58   CommandLineFlagConstraint_int(const char* name,
  59                                 CommandLineFlagConstraintFunc_int func,
  60                                 ConstraintType type) : CommandLineFlagConstraint(name, type) {
  61     _constraint=func;
  62   }
  63 
  64   Flag::Error apply_int(int* value, bool verbose) {
  65     return _constraint(verbose, value);
  66   }
  67 };
  68 
  69 class CommandLineFlagConstraint_intx : public CommandLineFlagConstraint {
  70   CommandLineFlagConstraintFunc_intx _constraint;
  71 
  72 public:
  73   // the "name" argument must be a string literal
  74   CommandLineFlagConstraint_intx(const char* name,
  75                                  CommandLineFlagConstraintFunc_intx func,
  76                                  ConstraintType type) : CommandLineFlagConstraint(name, type) {
  77     _constraint=func;
  78   }
  79 
  80   Flag::Error apply_intx(intx* value, bool verbose) {
  81     return _constraint(verbose, value);
  82   }
  83 };
  84 
  85 class CommandLineFlagConstraint_uint : public CommandLineFlagConstraint {
  86   CommandLineFlagConstraintFunc_uint _constraint;
  87 
  88 public:
  89   // the "name" argument must be a string literal
  90   CommandLineFlagConstraint_uint(const char* name,
  91                                  CommandLineFlagConstraintFunc_uint func,
  92                                  ConstraintType type) : CommandLineFlagConstraint(name, type) {
  93     _constraint=func;
  94   }
  95 
  96   Flag::Error apply_uint(uint* value, bool verbose) {
  97     return _constraint(verbose, value);
  98   }
  99 };
 100 
 101 class CommandLineFlagConstraint_uintx : public CommandLineFlagConstraint {
 102   CommandLineFlagConstraintFunc_uintx _constraint;
 103 
 104 public:
 105   // the "name" argument must be a string literal
 106   CommandLineFlagConstraint_uintx(const char* name,
 107                                   CommandLineFlagConstraintFunc_uintx func,
 108                                   ConstraintType type) : CommandLineFlagConstraint(name, type) {
 109     _constraint=func;
 110   }
 111 
 112   Flag::Error apply_uintx(uintx* value, bool verbose) {
 113     return _constraint(verbose, value);
 114   }
 115 };
 116 
 117 class CommandLineFlagConstraint_uint64_t : public CommandLineFlagConstraint {
 118   CommandLineFlagConstraintFunc_uint64_t _constraint;
 119 
 120 public:
 121   // the "name" argument must be a string literal
 122   CommandLineFlagConstraint_uint64_t(const char* name,
 123                                      CommandLineFlagConstraintFunc_uint64_t func,
 124                                      ConstraintType type) : CommandLineFlagConstraint(name, type) {
 125     _constraint=func;
 126   }
 127 
 128   Flag::Error apply_uint64_t(uint64_t* value, bool verbose) {
 129     return _constraint(verbose, value);
 130   }
 131 };
 132 
 133 class CommandLineFlagConstraint_size_t : public CommandLineFlagConstraint {
 134   CommandLineFlagConstraintFunc_size_t _constraint;
 135 
 136 public:
 137   // the "name" argument must be a string literal
 138   CommandLineFlagConstraint_size_t(const char* name,
 139                                    CommandLineFlagConstraintFunc_size_t func,
 140                                    ConstraintType type) : CommandLineFlagConstraint(name, type) {
 141     _constraint=func;
 142   }
 143 
 144   Flag::Error apply_size_t(size_t* value, bool verbose) {
 145     return _constraint(verbose, value);
 146   }
 147 };
 148 
 149 class CommandLineFlagConstraint_double : public CommandLineFlagConstraint {
 150   CommandLineFlagConstraintFunc_double _constraint;
 151 
 152 public:
 153   // the "name" argument must be a string literal
 154   CommandLineFlagConstraint_double(const char* name,
 155                                    CommandLineFlagConstraintFunc_double func,
 156                                    ConstraintType type) : CommandLineFlagConstraint(name, type) {
 157     _constraint=func;
 158   }
 159 
 160   Flag::Error apply_double(double* value, bool verbose) {
 161     return _constraint(verbose, value);
 162   }
 163 };
 164 
 165 // No constraint emitting
 166 void emit_constraint_no(...)                          { /* NOP */ }
 167 
 168 // No constraint emitting if function argument is NOT provided
 169 void emit_constraint_bool(const char* /*name*/)       { /* NOP */ }
 170 void emit_constraint_ccstr(const char* /*name*/)      { /* NOP */ }
 171 void emit_constraint_ccstrlist(const char* /*name*/)  { /* NOP */ }
 172 void emit_constraint_int(const char* /*name*/)        { /* NOP */ }
 173 void emit_constraint_intx(const char* /*name*/)       { /* NOP */ }
 174 void emit_constraint_uint(const char* /*name*/)       { /* NOP */ }
 175 void emit_constraint_uintx(const char* /*name*/)      { /* NOP */ }
 176 void emit_constraint_uint64_t(const char* /*name*/)   { /* NOP */ }
 177 void emit_constraint_size_t(const char* /*name*/)     { /* NOP */ }
 178 void emit_constraint_double(const char* /*name*/)     { /* NOP */ }
 179 
 180 CommandLineFlagConstraint::ConstraintType CommandLineFlagConstraint::change_to_enum(const char* type) {
 181   static const char* const anytime_str         = "Anytime";
 182   static const char* const afterParse_str      = "AfterParse";
 183   static const char* const afterMemoryInit_str = "AfterMemoryInit";
 184 
 185   if (strncmp(type, afterParse_str, 10) == 0) {
 186     return CommandLineFlagConstraint::AfterParse;
 187   } else if (strncmp(type, afterMemoryInit_str, 15) == 0) {
 188     return CommandLineFlagConstraint::AfterMemoryInit;
 189   } else if (strncmp(type, anytime_str, 7) == 0) {
 190     return CommandLineFlagConstraint::Anytime;
 191   } else {
 192     ShouldNotReachHere();
 193     return CommandLineFlagConstraint::AfterMemoryInit;
 194   }
 195 }
 196 
 197 // CommandLineFlagConstraint emitting code functions if function argument is provided
 198 void emit_constraint_bool(const char* name, CommandLineFlagConstraintFunc_bool func, const char* type) {
 199   CommandLineFlagConstraintList::add(new CommandLineFlagConstraint_bool(name, func, CommandLineFlagConstraint::change_to_enum(type)));
 200 }
 201 void emit_constraint_int(const char* name, CommandLineFlagConstraintFunc_int func, const char* type) {
 202   CommandLineFlagConstraintList::add(new CommandLineFlagConstraint_int(name, func, CommandLineFlagConstraint::change_to_enum(type)));
 203 }
 204 void emit_constraint_intx(const char* name, CommandLineFlagConstraintFunc_intx func, const char* type) {
 205   CommandLineFlagConstraintList::add(new CommandLineFlagConstraint_intx(name, func, CommandLineFlagConstraint::change_to_enum(type)));
 206 }
 207 void emit_constraint_uint(const char* name, CommandLineFlagConstraintFunc_uint func, const char* type) {
 208   CommandLineFlagConstraintList::add(new CommandLineFlagConstraint_uint(name, func, CommandLineFlagConstraint::change_to_enum(type)));
 209 }
 210 void emit_constraint_uintx(const char* name, CommandLineFlagConstraintFunc_uintx func, const char* type) {
 211   CommandLineFlagConstraintList::add(new CommandLineFlagConstraint_uintx(name, func, CommandLineFlagConstraint::change_to_enum(type)));
 212 }
 213 void emit_constraint_uint64_t(const char* name, CommandLineFlagConstraintFunc_uint64_t func, const char* type) {
 214   CommandLineFlagConstraintList::add(new CommandLineFlagConstraint_uint64_t(name, func, CommandLineFlagConstraint::change_to_enum(type)));
 215 }
 216 void emit_constraint_size_t(const char* name, CommandLineFlagConstraintFunc_size_t func, const char* type) {
 217   CommandLineFlagConstraintList::add(new CommandLineFlagConstraint_size_t(name, func, CommandLineFlagConstraint::change_to_enum(type)));
 218 }
 219 void emit_constraint_double(const char* name, CommandLineFlagConstraintFunc_double func, const char* type) {
 220   CommandLineFlagConstraintList::add(new CommandLineFlagConstraint_double(name, func, CommandLineFlagConstraint::change_to_enum(type)));
 221 }
 222 
 223 // Generate code to call emit_constraint_xxx function
 224 #define EMIT_CONSTRAINT_PRODUCT_FLAG(type, name, value, doc)      ); emit_constraint_##type(#name
 225 #define EMIT_CONSTRAINT_COMMERCIAL_FLAG(type, name, value, doc)   ); emit_constraint_##type(#name
 226 #define EMIT_CONSTRAINT_DIAGNOSTIC_FLAG(type, name, value, doc)   ); emit_constraint_##type(#name
 227 #define EMIT_CONSTRAINT_EXPERIMENTAL_FLAG(type, name, value, doc) ); emit_constraint_##type(#name
 228 #define EMIT_CONSTRAINT_MANAGEABLE_FLAG(type, name, value, doc)   ); emit_constraint_##type(#name
 229 #define EMIT_CONSTRAINT_PRODUCT_RW_FLAG(type, name, value, doc)   ); emit_constraint_##type(#name
 230 #define EMIT_CONSTRAINT_PD_PRODUCT_FLAG(type, name, doc)          ); emit_constraint_##type(#name
 231 #define EMIT_CONSTRAINT_DEVELOPER_FLAG(type, name, value, doc)    ); emit_constraint_##type(#name
 232 #define EMIT_CONSTRAINT_PD_DEVELOPER_FLAG(type, name, doc)        ); emit_constraint_##type(#name
 233 #define EMIT_CONSTRAINT_NOTPRODUCT_FLAG(type, name, value, doc)   ); emit_constraint_##type(#name
 234 #define EMIT_CONSTRAINT_LP64_PRODUCT_FLAG(type, name, value, doc) ); emit_constraint_##type(#name
 235 
 236 // Generate func argument to pass into emit_constraint_xxx functions
 237 #define EMIT_CONSTRAINT_CHECK(func, type)                               , func, #type
 238 
 239 // the "name" argument must be a string literal
 240 #define INITIAL_CONTRAINTS_SIZE 16
 241 GrowableArray<CommandLineFlagConstraint*>* CommandLineFlagConstraintList::_constraints = NULL;
 242 CommandLineFlagConstraint::ConstraintType CommandLineFlagConstraintList::_validationType = CommandLineFlagConstraint::Anytime;
 243 
 244 // Check the ranges of all flags that have them or print them out and exit if requested
 245 void CommandLineFlagConstraintList::init(void) {
 246 
 247   _constraints = new (ResourceObj::C_HEAP, mtInternal) GrowableArray<CommandLineFlagConstraint*>(INITIAL_CONTRAINTS_SIZE, true);
 248 
 249   emit_constraint_no(NULL RUNTIME_FLAGS(EMIT_CONSTRAINT_DEVELOPER_FLAG,
 250                                         EMIT_CONSTRAINT_PD_DEVELOPER_FLAG,
 251                                         EMIT_CONSTRAINT_PRODUCT_FLAG,
 252                                         EMIT_CONSTRAINT_PD_PRODUCT_FLAG,
 253                                         EMIT_CONSTRAINT_DIAGNOSTIC_FLAG,
 254                                         EMIT_CONSTRAINT_EXPERIMENTAL_FLAG,
 255                                         EMIT_CONSTRAINT_NOTPRODUCT_FLAG,
 256                                         EMIT_CONSTRAINT_MANAGEABLE_FLAG,
 257                                         EMIT_CONSTRAINT_PRODUCT_RW_FLAG,
 258                                         EMIT_CONSTRAINT_LP64_PRODUCT_FLAG,
 259                                         IGNORE_RANGE,
 260                                         EMIT_CONSTRAINT_CHECK));
 261 
 262   EMIT_CONSTRAINTS_FOR_GLOBALS_EXT
 263 
 264   emit_constraint_no(NULL ARCH_FLAGS(EMIT_CONSTRAINT_DEVELOPER_FLAG,
 265                                      EMIT_CONSTRAINT_PRODUCT_FLAG,
 266                                      EMIT_CONSTRAINT_DIAGNOSTIC_FLAG,
 267                                      EMIT_CONSTRAINT_EXPERIMENTAL_FLAG,
 268                                      EMIT_CONSTRAINT_NOTPRODUCT_FLAG,
 269                                      IGNORE_RANGE,
 270                                      EMIT_CONSTRAINT_CHECK));
 271 
 272 #ifdef COMPILER1
 273   emit_constraint_no(NULL C1_FLAGS(EMIT_CONSTRAINT_DEVELOPER_FLAG,
 274                                    EMIT_CONSTRAINT_PD_DEVELOPER_FLAG,
 275                                    EMIT_CONSTRAINT_PRODUCT_FLAG,
 276                                    EMIT_CONSTRAINT_PD_PRODUCT_FLAG,
 277                                    EMIT_CONSTRAINT_DIAGNOSTIC_FLAG,
 278                                    EMIT_CONSTRAINT_NOTPRODUCT_FLAG,
 279                                    IGNORE_RANGE,
 280                                    EMIT_CONSTRAINT_CHECK));
 281 #endif // COMPILER1
 282 
 283 #ifdef COMPILER2
 284   emit_constraint_no(NULL C2_FLAGS(EMIT_CONSTRAINT_DEVELOPER_FLAG,
 285                                    EMIT_CONSTRAINT_PD_DEVELOPER_FLAG,
 286                                    EMIT_CONSTRAINT_PRODUCT_FLAG,
 287                                    EMIT_CONSTRAINT_PD_PRODUCT_FLAG,
 288                                    EMIT_CONSTRAINT_DIAGNOSTIC_FLAG,
 289                                    EMIT_CONSTRAINT_EXPERIMENTAL_FLAG,
 290                                    EMIT_CONSTRAINT_NOTPRODUCT_FLAG,
 291                                    IGNORE_RANGE,
 292                                    EMIT_CONSTRAINT_CHECK));
 293 #endif // COMPILER2
 294 
 295 #ifndef INCLUDE_ALL_GCS
 296   emit_constraint_no(NULL G1_FLAGS(EMIT_CONSTRAINT_DEVELOPER_FLAG,
 297                                    EMIT_CONSTRAINT_PD_DEVELOPER_FLAG,
 298                                    EMIT_CONSTRAINT_PRODUCT_FLAG,
 299                                    EMIT_CONSTRAINT_PD_PRODUCT_FLAG,
 300                                    EMIT_CONSTRAINT_DIAGNOSTIC_FLAG,
 301                                    EMIT_CONSTRAINT_EXPERIMENTAL_FLAG,
 302                                    EMIT_CONSTRAINT_NOTPRODUCT_FLAG,
 303                                    EMIT_CONSTRAINT_MANAGEABLE_FLAG,
 304                                    EMIT_CONSTRAINT_PRODUCT_RW_FLAG,
 305                                    IGNORE_RANGE,
 306                                    EMIT_CONSTRAINT_CHECK));
 307 #endif // INCLUDE_ALL_GCS
 308 }
 309 
 310 // Find constraints by name and return only if found constraint's type is equal or lower than current validating type.
 311 CommandLineFlagConstraint* CommandLineFlagConstraintList::find_if_validated(const char* name) {
 312   CommandLineFlagConstraint* found = NULL;
 313   for (int i=0; i<length(); i++) {
 314     CommandLineFlagConstraint* constraint = at(i);
 315     if ((strcmp(constraint->name(), name) == 0) &&
 316         (constraint->type() <= _validationType)) {
 317       found = constraint;
 318       break;
 319     }
 320   }
 321   return found;
 322 }