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 #ifndef SHARE_VM_SERVICES_WRITEABLEFLAG_HPP
  26 #define SHARE_VM_SERVICES_WRITEABLEFLAG_HPP
  27 
  28 class WriteableFlags : AllStatic {
  29 public:
  30   enum error {
  31     // no error
  32     SUCCESS,
  33     // flag name is missing
  34     MISSING_NAME,
  35     // flag value is missing
  36     MISSING_VALUE,
  37     // error parsing the textual form of the value
  38     WRONG_FORMAT,
  39     // flag is not writeable
  40     NON_WRITABLE,
  41     // flag value is outside of its bounds
  42     OUT_OF_BOUNDS,
  43     // there is no flag with the given name
  44     INVALID_FLAG,
  45     // other, unspecified error related to setting the flag
  46     ERR_OTHER
  47   } err;
  48 
  49 private:
  50   // a writeable flag setter accepting either 'jvalue' or 'char *' values
  51   static int set_flag(const char* name, const void* value, int(*setter)(Flag*, const void*, Flag::Flags, FormatBuffer<80>&), Flag::Flags origin, FormatBuffer<80>& err_msg);
  52   // a writeable flag setter accepting 'char *' values
  53   static int set_flag_from_char(Flag* f, const void* value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  54   // a writeable flag setter accepting 'jvalue' values
  55   static int set_flag_from_jvalue(Flag* f, const void* value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  56 
  57   // set a boolean global flag
  58   static int set_bool_flag(const char* name, const char* value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  59   // set a int global flag
  60   static int set_int_flag(const char* name, const char* value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  61   // set a uint global flag
  62   static int set_uint_flag(const char* name, const char* value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  63   // set a intx global flag
  64   static int set_intx_flag(const char* name, const char* value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  65   // set a uintx global flag
  66   static int set_uintx_flag(const char* name, const char* value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  67   // set a uint64_t global flag
  68   static int set_uint64_t_flag(const char* name, const char* value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  69   // set a size_t global flag using value from AttachOperation
  70   static int set_size_t_flag(const char* name, const char* value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  71   // set a boolean global flag
  72   static int set_bool_flag(const char* name, bool value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  73   // set a int global flag
  74   static int set_int_flag(const char* name, int value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  75   // set a uint global flag
  76   static int set_uint_flag(const char* name, uint value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  77   // set a intx global flag
  78   static int set_intx_flag(const char* name, intx value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  79   // set a uintx global flag
  80   static int set_uintx_flag(const char* name, uintx value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  81   // set a uint64_t global flag
  82   static int set_uint64_t_flag(const char* name, uint64_t value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  83   // set a size_t global flag using value from AttachOperation
  84   static int set_size_t_flag(const char* name, size_t value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  85   // set a string global flag
  86   static int set_ccstr_flag(const char* name, const char* value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  87 
  88 public:
  89   /* sets a writeable flag to the provided value
  90    *
  91    * - return status is one of the WriteableFlags::err enum values
  92    * - an eventual error message will be generated to the provided err_msg buffer
  93    */
  94   static int set_flag(const char* flag_name, const char* flag_value, Flag::Flags origin, FormatBuffer<80>& err_msg);
  95 
  96   /* sets a writeable flag to the provided value
  97    *
  98    * - return status is one of the WriteableFlags::err enum values
  99    * - an eventual error message will be generated to the provided err_msg buffer
 100    */
 101   static int set_flag(const char* flag_name, jvalue flag_value, Flag::Flags origin, FormatBuffer<80>& err_msg);
 102 };
 103 
 104 #endif /* SHARE_VM_SERVICES_WRITEABLEFLAG_HPP */
 105