1 /*
   2  * Copyright (c) 2015, 2019, 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_RUNTIME_FLAGS_JVMFLAGRANGELIST_HPP
  26 #define SHARE_RUNTIME_FLAGS_JVMFLAGRANGELIST_HPP
  27 
  28 #include "runtime/flags/jvmFlag.hpp"
  29 #include "utilities/growableArray.hpp"
  30 
  31 /*
  32  * Here we have a mechanism for extracting ranges specified in flag macro tables.
  33  *
  34  * The specified ranges are used to verify that flags have valid values.
  35  *
  36  * An example of a range is "min <= flag <= max". Both "min" and "max" must be
  37  * constant and can not change. If either "min" or "max" can change,
  38  * then we need to use constraint instead.
  39  */
  40 
  41 class JVMFlagRange : public CHeapObj<mtArguments> {
  42 protected:
  43   const JVMFlag* const _flag;
  44 public:
  45   // the "name" argument must be a string literal
  46   JVMFlagRange(const JVMFlag* flag) : _flag(flag) {}
  47   ~JVMFlagRange() {}
  48   const JVMFlag* flag() const { return _flag; }
  49   const char* name() const { return _flag->_name; }
  50   virtual JVMFlag::Error check(bool verbose = true) { ShouldNotReachHere(); return JVMFlag::ERR_OTHER; }
  51   virtual JVMFlag::Error check_int(int value, bool verbose = true) { ShouldNotReachHere(); return JVMFlag::ERR_OTHER; }
  52   virtual JVMFlag::Error check_intx(intx value, bool verbose = true) { ShouldNotReachHere(); return JVMFlag::ERR_OTHER; }
  53   virtual JVMFlag::Error check_uint(uint value, bool verbose = true) { ShouldNotReachHere(); return JVMFlag::ERR_OTHER; }
  54   virtual JVMFlag::Error check_uintx(uintx value, bool verbose = true) { ShouldNotReachHere(); return JVMFlag::ERR_OTHER; }
  55   virtual JVMFlag::Error check_uint64_t(uint64_t value, bool verbose = true) { ShouldNotReachHere(); return JVMFlag::ERR_OTHER; }
  56   virtual JVMFlag::Error check_size_t(size_t value, bool verbose = true) { ShouldNotReachHere(); return JVMFlag::ERR_OTHER; }
  57   virtual JVMFlag::Error check_double(double value, bool verbose = true) { ShouldNotReachHere(); return JVMFlag::ERR_OTHER; }
  58   virtual void print(outputStream* st) { ; }
  59 };
  60 
  61 class JVMFlagRangeList : public AllStatic {
  62   static GrowableArray<JVMFlagRange*>* _ranges;
  63 public:
  64   static void init();
  65   static int length() { return (_ranges != NULL) ? _ranges->length() : 0; }
  66   static JVMFlagRange* at(int i) { return (_ranges != NULL) ? _ranges->at(i) : NULL; }
  67   static JVMFlagRange* find(const JVMFlag* flag);
  68   static void add(JVMFlagRange* range) { _ranges->append(range); }
  69   static void print(outputStream* st, const JVMFlag* flag, RangeStrFunc default_range_str_func);
  70   // Check the final values of all flags for ranges.
  71   static bool check_ranges();
  72 };
  73 
  74 #endif // SHARE_RUNTIME_FLAGS_JVMFLAGRANGELIST_HPP