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/javaClasses.hpp"
  27 #include "runtime/arguments.hpp"
  28 #include "runtime/java.hpp"
  29 #include "runtime/jniHandles.hpp"
  30 #include "services/writeableFlags.hpp"
  31 
  32 // set a boolean global flag
  33 int WriteableFlags::set_bool_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
  34   int value = true;
  35 
  36   if (sscanf(arg, "%d", &value)) {
  37     return set_bool_flag(name, value != 0, origin, err_msg);
  38   }
  39   err_msg.print("flag value must be a boolean (1 or 0)");
  40   return WRONG_FORMAT;
  41 }
  42 
  43 int WriteableFlags::set_bool_flag(const char* name, bool value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
  44   return CommandLineFlags::boolAtPut((char*)name, &value, origin) ? SUCCESS : ERR_OTHER;
  45 }
  46 
  47 // set a int global flag
  48 int WriteableFlags::set_int_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
  49   int value;
  50 
  51   if (sscanf(arg, "%d", &value)) {
  52     return set_int_flag(name, value, origin, err_msg);
  53   }
  54   err_msg.print("flag value must be an integer");
  55   return WRONG_FORMAT;
  56 }
  57 
  58 int WriteableFlags::set_int_flag(const char* name, int value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
  59   return CommandLineFlags::intAtPut((char*)name, &value, origin) ? SUCCESS : ERR_OTHER;
  60 }
  61 
  62 // set a uint global flag
  63 int WriteableFlags::set_uint_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
  64   uint value;
  65 
  66   if (sscanf(arg, "%u", &value)) {
  67     return set_uint_flag(name, value, origin, err_msg);
  68   }
  69   err_msg.print("flag value must be an unsigned integer");
  70   return WRONG_FORMAT;
  71 }
  72 
  73 int WriteableFlags::set_uint_flag(const char* name, uint value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
  74   return CommandLineFlags::uintAtPut((char*)name, &value, origin) ? SUCCESS : ERR_OTHER;
  75 }
  76 
  77 // set a intx global flag
  78 int WriteableFlags::set_intx_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
  79   intx value;
  80 
  81   if (sscanf(arg, INTX_FORMAT, &value)) {
  82     return set_intx_flag(name, value, origin, err_msg);
  83   }
  84   err_msg.print("flag value must be an integer");
  85   return WRONG_FORMAT;
  86 }
  87 
  88 int WriteableFlags::set_intx_flag(const char* name, intx value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
  89   return CommandLineFlags::intxAtPut((char*)name, &value, origin) ? SUCCESS : ERR_OTHER;
  90 }
  91 
  92 // set a uintx global flag
  93 int WriteableFlags::set_uintx_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
  94   uintx value;
  95 
  96   if (sscanf(arg, UINTX_FORMAT, &value)) {
  97     return set_uintx_flag(name, value, origin, err_msg);
  98   }
  99   err_msg.print("flag value must be an unsigned integer");
 100   return WRONG_FORMAT;
 101 }
 102 
 103 int WriteableFlags::set_uintx_flag(const char* name, uintx value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 104   if (strncmp(name, "MaxHeapFreeRatio", 17) == 0) {
 105       if (!Arguments::verify_MaxHeapFreeRatio(err_msg, value)) {
 106         return OUT_OF_BOUNDS;
 107       }
 108     } else if (strncmp(name, "MinHeapFreeRatio", 17) == 0) {
 109       if (!Arguments::verify_MinHeapFreeRatio(err_msg, value)) {
 110         return OUT_OF_BOUNDS;
 111       }
 112     }
 113     return CommandLineFlags::uintxAtPut((char*)name, &value, origin) ? SUCCESS : ERR_OTHER;
 114 }
 115 
 116 // set a uint64_t global flag
 117 int WriteableFlags::set_uint64_t_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 118   uint64_t value;
 119 
 120   if (sscanf(arg, UINT64_FORMAT, &value)) {
 121     return set_uint64_t_flag(name, value, origin, err_msg);
 122   }
 123   err_msg.print("flag value must be an unsigned 64-bit integer");
 124   return WRONG_FORMAT;
 125 }
 126 
 127 int WriteableFlags::set_uint64_t_flag(const char* name, uint64_t value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 128   return CommandLineFlags::uint64_tAtPut((char*)name, &value, origin) ? SUCCESS : ERR_OTHER;
 129 }
 130 
 131 // set a size_t global flag
 132 int WriteableFlags::set_size_t_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 133   size_t value;
 134 
 135   if (sscanf(arg, SIZE_FORMAT, &value)) {
 136     return set_size_t_flag(name, value, origin, err_msg);
 137   }
 138   err_msg.print("flag value must be an unsigned integer");
 139   return WRONG_FORMAT;
 140 }
 141 
 142 int WriteableFlags::set_size_t_flag(const char* name, size_t value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 143   return CommandLineFlags::size_tAtPut((char*)name, &value, origin) ? SUCCESS : ERR_OTHER;
 144 }
 145 
 146 // set a string global flag using value from AttachOperation
 147 int WriteableFlags::set_ccstr_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 148   bool res = CommandLineFlags::ccstrAtPut((char*)name, &arg, origin);
 149 
 150   return res? SUCCESS : ERR_OTHER;
 151 }
 152 
 153 /* sets a writeable flag to the provided value
 154  *
 155  * - return status is one of the WriteableFlags::err enum values
 156  * - an eventual error message will be generated to the provided err_msg buffer
 157  */
 158 int WriteableFlags::set_flag(const char* flag_name, const char* flag_value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 159   return set_flag(flag_name, &flag_value, set_flag_from_char, origin, err_msg);
 160 }
 161 
 162 /* sets a writeable flag to the provided value
 163  *
 164  * - return status is one of the WriteableFlags::err enum values
 165  * - an eventual error message will be generated to the provided err_msg buffer
 166  */
 167 int WriteableFlags::set_flag(const char* flag_name, jvalue flag_value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 168   return set_flag(flag_name, &flag_value, set_flag_from_jvalue, origin, err_msg);
 169 }
 170 
 171 // a writeable flag setter accepting either 'jvalue' or 'char *' values
 172 int WriteableFlags::set_flag(const char* name, const void* value, int(*setter)(Flag*,const void*,Flag::Flags,FormatBuffer<80>&), Flag::Flags origin, FormatBuffer<80>& err_msg) {
 173   if (name == NULL) {
 174     err_msg.print("flag name is missing");
 175     return MISSING_NAME;
 176   }
 177   if (value == NULL) {
 178     err_msg.print("flag value is missing");
 179     return MISSING_VALUE;
 180   }
 181 
 182   Flag* f = Flag::find_flag((char*)name, strlen(name));
 183   if (f) {
 184     // only writeable flags are allowed to be set
 185     if (f->is_writeable()) {
 186       return setter(f, value, origin, err_msg);
 187     } else {
 188       err_msg.print("only 'writeable' flags can be set");
 189       return NON_WRITABLE;
 190     }
 191   }
 192 
 193   err_msg.print("flag %s does not exist", name);
 194   return INVALID_FLAG;
 195 }
 196 
 197 // a writeable flag setter accepting 'char *' values
 198 int WriteableFlags::set_flag_from_char(Flag* f, const void* value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 199   char* flag_value = *(char**)value;
 200   if (flag_value == NULL) {
 201     err_msg.print("flag value is missing");
 202     return MISSING_VALUE;
 203   }
 204   if (f->is_bool()) {
 205     return set_bool_flag(f->_name, flag_value, origin, err_msg);
 206   } else if (f->is_int()) {
 207     return set_int_flag(f->_name, flag_value, origin, err_msg);
 208   } else if (f->is_uint()) {
 209     return set_uint_flag(f->_name, flag_value, origin, err_msg);
 210   } else if (f->is_intx()) {
 211     return set_intx_flag(f->_name, flag_value, origin, err_msg);
 212   } else if (f->is_uintx()) {
 213     return set_uintx_flag(f->_name, flag_value, origin, err_msg);
 214   } else if (f->is_uint64_t()) {
 215     return set_uint64_t_flag(f->_name, flag_value, origin, err_msg);
 216   } else if (f->is_size_t()) {
 217     return set_size_t_flag(f->_name, flag_value, origin, err_msg);
 218   } else if (f->is_ccstr()) {
 219     return set_ccstr_flag(f->_name, flag_value, origin, err_msg);
 220   } else {
 221     ShouldNotReachHere();
 222   }
 223   return ERR_OTHER;
 224 }
 225 
 226 // a writeable flag setter accepting 'jvalue' values
 227 int WriteableFlags::set_flag_from_jvalue(Flag* f, const void* value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 228   jvalue new_value = *(jvalue*)value;
 229   if (f->is_bool()) {
 230     bool bvalue = (new_value.z == JNI_TRUE ? true : false);
 231     return set_bool_flag(f->_name, bvalue, origin, err_msg);
 232   } else if (f->is_int()) {
 233     int ivalue = (int)new_value.j;
 234     return set_int_flag(f->_name, ivalue, origin, err_msg);
 235   } else if (f->is_uint()) {
 236     uint uvalue = (uint)new_value.j;
 237     return set_uint_flag(f->_name, uvalue, origin, err_msg);
 238   } else if (f->is_intx()) {
 239     intx ivalue = (intx)new_value.j;
 240     return set_intx_flag(f->_name, ivalue, origin, err_msg);
 241   } else if (f->is_uintx()) {
 242     uintx uvalue = (uintx)new_value.j;
 243     return set_uintx_flag(f->_name, uvalue, origin, err_msg);
 244   } else if (f->is_uint64_t()) {
 245     uint64_t uvalue = (uint64_t)new_value.j;
 246     return set_uint64_t_flag(f->_name, uvalue, origin, err_msg);
 247   } else if (f->is_size_t()) {
 248     size_t svalue = (size_t)new_value.j;
 249     return set_size_t_flag(f->_name, svalue, origin, err_msg);
 250   } else if (f->is_ccstr()) {
 251     oop str = JNIHandles::resolve_external_guard(new_value.l);
 252     if (str == NULL) {
 253       err_msg.print("flag value is missing");
 254       return MISSING_VALUE;
 255     }
 256     ccstr svalue = java_lang_String::as_utf8_string(str);
 257     int ret = WriteableFlags::set_ccstr_flag(f->_name, svalue, origin, err_msg);
 258     if (ret != SUCCESS) {
 259       FREE_C_HEAP_ARRAY(char, svalue);
 260     }
 261     return ret;
 262   } else {
 263     ShouldNotReachHere();
 264   }
 265   return ERR_OTHER;
 266 }
 267