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 "classfile/javaClasses.hpp"
  27 #include "memory/allocation.inline.hpp"
  28 #include "runtime/arguments.hpp"
  29 #include "runtime/commandLineFlagRangeList.hpp"
  30 #include "runtime/java.hpp"
  31 #include "runtime/jniHandles.hpp"
  32 #include "services/writeableFlags.hpp"
  33 
  34 #define TEMP_BUF_SIZE 80
  35 
  36 static void buffer_concat(char* buffer, const char* src) {
  37   strncat(buffer, src, TEMP_BUF_SIZE - 1 - strlen(buffer));
  38 }
  39 
  40 static void print_flag_error_message_bounds(const char* name, char* buffer) {
  41   CommandLineFlagRange* range = CommandLineFlagRangeList::find(name);
  42   if (range != NULL) {
  43     buffer_concat(buffer, "must have value in range ");
  44 
  45     stringStream stream;
  46     range->print(&stream);
  47     const char* range_string = stream.as_string();
  48     size_t j = strlen(buffer);
  49     for (size_t i=0; j<TEMP_BUF_SIZE-1; i++) {
  50       if (range_string[i] == '\0') {
  51         break;
  52       } else if (range_string[i] != ' ') {
  53         buffer[j] = range_string[i];
  54         j++;
  55       }
  56     }
  57     buffer[j] = '\0';
  58   }
  59 }
  60 
  61 static void print_flag_error_message_if_needed(Flag::Error error, const char* name, FormatBuffer<80>& err_msg) {
  62   if (error == Flag::SUCCESS) {
  63     return;
  64   }
  65 
  66   char buffer[TEMP_BUF_SIZE] = {'\0'};
  67   if ((error != Flag::MISSING_NAME) && (name != NULL)) {
  68     buffer_concat(buffer, name);
  69     buffer_concat(buffer, " error: ");
  70   } else {
  71     buffer_concat(buffer, "Error: ");
  72   }
  73   switch (error) {
  74     case Flag::MISSING_NAME:
  75       buffer_concat(buffer, "flag name is missing."); break;
  76     case Flag::MISSING_VALUE:
  77       buffer_concat(buffer, "parsing the textual form of the value."); break;
  78     case Flag::NON_WRITABLE:
  79       buffer_concat(buffer, "flag is not writeable."); break;
  80     case Flag::OUT_OF_BOUNDS:
  81       print_flag_error_message_bounds(name, buffer); break;
  82     case Flag::VIOLATES_CONSTRAINT:
  83       buffer_concat(buffer, "value violates its flag's constraint."); break;
  84     case Flag::INVALID_FLAG:
  85       buffer_concat(buffer, "there is no flag with the given name."); break;
  86     case Flag::ERR_OTHER:
  87       buffer_concat(buffer, "other, unspecified error related to setting the flag."); break;
  88     case Flag::SUCCESS:
  89       break;
  90     default:
  91       break;
  92   }
  93 
  94   err_msg.print("%s", buffer);
  95 }
  96 
  97 // set a boolean global flag
  98 Flag::Error WriteableFlags::set_bool_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
  99   if ((strcasecmp(arg, "true") == 0) || (*arg == '1' && *(arg + 1) == 0)) {
 100     return set_bool_flag(name, true, origin, err_msg);
 101   } else if ((strcasecmp(arg, "false") == 0) || (*arg == '0' && *(arg + 1) == 0)) {
 102     return set_bool_flag(name, false, origin, err_msg);
 103   }
 104   err_msg.print("flag value must be a boolean (1/0 or true/false)");
 105   return Flag::WRONG_FORMAT;
 106 }
 107 
 108 Flag::Error WriteableFlags::set_bool_flag(const char* name, bool value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 109   Flag::Error err = CommandLineFlags::boolAtPut(name, &value, origin);
 110   print_flag_error_message_if_needed(err, name, err_msg);
 111   return err;
 112 }
 113 
 114 // set a int global flag
 115 Flag::Error WriteableFlags::set_int_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 116   int value;
 117 
 118   if (sscanf(arg, "%d", &value)) {
 119     return set_int_flag(name, value, origin, err_msg);
 120   }
 121   err_msg.print("flag value must be an integer");
 122   return Flag::WRONG_FORMAT;
 123 }
 124 
 125 Flag::Error WriteableFlags::set_int_flag(const char* name, int value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 126   Flag::Error err = CommandLineFlags::intAtPut(name, &value, origin);
 127   print_flag_error_message_if_needed(err, name, err_msg);
 128   return err;
 129 }
 130 
 131 // set a uint global flag
 132 Flag::Error WriteableFlags::set_uint_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 133   uint value;
 134 
 135   if (sscanf(arg, "%u", &value)) {
 136     return set_uint_flag(name, value, origin, err_msg);
 137   }
 138   err_msg.print("flag value must be an unsigned integer");
 139   return Flag::WRONG_FORMAT;
 140 }
 141 
 142 Flag::Error WriteableFlags::set_uint_flag(const char* name, uint value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 143   Flag::Error err = CommandLineFlags::uintAtPut(name, &value, origin);
 144   print_flag_error_message_if_needed(err, name, err_msg);
 145   return err;
 146 }
 147 
 148 // set a intx global flag
 149 Flag::Error WriteableFlags::set_intx_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 150   intx value;
 151 
 152   if (sscanf(arg, INTX_FORMAT, &value)) {
 153     return set_intx_flag(name, value, origin, err_msg);
 154   }
 155   err_msg.print("flag value must be an integer");
 156   return Flag::WRONG_FORMAT;
 157 }
 158 
 159 Flag::Error WriteableFlags::set_intx_flag(const char* name, intx value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 160   Flag::Error err = CommandLineFlags::intxAtPut(name, &value, origin);
 161   print_flag_error_message_if_needed(err, name, err_msg);
 162   return err;
 163 }
 164 
 165 // set a uintx global flag
 166 Flag::Error WriteableFlags::set_uintx_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 167   uintx value;
 168 
 169   if (sscanf(arg, UINTX_FORMAT, &value)) {
 170     return set_uintx_flag(name, value, origin, err_msg);
 171   }
 172   err_msg.print("flag value must be an unsigned integer");
 173   return Flag::WRONG_FORMAT;
 174 }
 175 
 176 Flag::Error WriteableFlags::set_uintx_flag(const char* name, uintx value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 177   Flag::Error err = CommandLineFlags::uintxAtPut(name, &value, origin);
 178   print_flag_error_message_if_needed(err, name, err_msg);
 179   return err;
 180 }
 181 
 182 // set a uint64_t global flag
 183 Flag::Error WriteableFlags::set_uint64_t_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 184   uint64_t value;
 185 
 186   if (sscanf(arg, UINT64_FORMAT, &value)) {
 187     return set_uint64_t_flag(name, value, origin, err_msg);
 188   }
 189   err_msg.print("flag value must be an unsigned 64-bit integer");
 190   return Flag::WRONG_FORMAT;
 191 }
 192 
 193 Flag::Error WriteableFlags::set_uint64_t_flag(const char* name, uint64_t value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 194   Flag::Error err = CommandLineFlags::uint64_tAtPut(name, &value, origin);
 195   print_flag_error_message_if_needed(err, name, err_msg);
 196   return err;
 197 }
 198 
 199 // set a size_t global flag
 200 Flag::Error WriteableFlags::set_size_t_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 201   size_t value;
 202 
 203   if (sscanf(arg, SIZE_FORMAT, &value)) {
 204     return set_size_t_flag(name, value, origin, err_msg);
 205   }
 206   err_msg.print("flag value must be an unsigned integer");
 207   return Flag::WRONG_FORMAT;
 208 }
 209 
 210 Flag::Error WriteableFlags::set_size_t_flag(const char* name, size_t value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 211   Flag::Error err = CommandLineFlags::size_tAtPut(name, &value, origin);
 212   print_flag_error_message_if_needed(err, name, err_msg);
 213   return err;
 214 }
 215 
 216 // set a string global flag using value from AttachOperation
 217 Flag::Error WriteableFlags::set_ccstr_flag(const char* name, const char* value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 218   Flag::Error err = CommandLineFlags::ccstrAtPut((char*)name, &value, origin);
 219   print_flag_error_message_if_needed(err, name, err_msg);
 220   return err;
 221 }
 222 
 223 /* sets a writeable flag to the provided value
 224  *
 225  * - return status is one of the WriteableFlags::err enum values
 226  * - an eventual error message will be generated to the provided err_msg buffer
 227  */
 228 Flag::Error WriteableFlags::set_flag(const char* flag_name, const char* flag_value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 229   return set_flag(flag_name, &flag_value, set_flag_from_char, origin, err_msg);
 230 }
 231 
 232 /* sets a writeable flag to the provided value
 233  *
 234  * - return status is one of the WriteableFlags::err enum values
 235  * - an eventual error message will be generated to the provided err_msg buffer
 236  */
 237 Flag::Error WriteableFlags::set_flag(const char* flag_name, jvalue flag_value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 238   return set_flag(flag_name, &flag_value, set_flag_from_jvalue, origin, err_msg);
 239 }
 240 
 241 // a writeable flag setter accepting either 'jvalue' or 'char *' values
 242 Flag::Error WriteableFlags::set_flag(const char* name, const void* value, Flag::Error(*setter)(Flag*,const void*,Flag::Flags,FormatBuffer<80>&), Flag::Flags origin, FormatBuffer<80>& err_msg) {
 243   if (name == NULL) {
 244     err_msg.print("flag name is missing");
 245     return Flag::MISSING_NAME;
 246   }
 247   if (value == NULL) {
 248     err_msg.print("flag value is missing");
 249     return Flag::MISSING_VALUE;
 250   }
 251 
 252   Flag* f = Flag::find_flag((char*)name, strlen(name));
 253   if (f) {
 254     // only writeable flags are allowed to be set
 255     if (f->is_writeable()) {
 256       return setter(f, value, origin, err_msg);
 257     } else {
 258       err_msg.print("only 'writeable' flags can be set");
 259       return Flag::NON_WRITABLE;
 260     }
 261   }
 262 
 263   err_msg.print("flag %s does not exist", name);
 264   return Flag::INVALID_FLAG;
 265 }
 266 
 267 // a writeable flag setter accepting 'char *' values
 268 Flag::Error WriteableFlags::set_flag_from_char(Flag* f, const void* value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
 269   char* flag_value = *(char**)value;
 270   if (flag_value == NULL) {
 271     err_msg.print("flag value is missing");
 272     return Flag::MISSING_VALUE;
 273   }
 274   if (f->is_bool()) {
 275     return set_bool_flag(f->_name, flag_value, origin, err_msg);
 276   } else if (f->is_int()) {
 277     return set_int_flag(f->_name, flag_value, origin, err_msg);
 278   } else if (f->is_uint()) {
 279     return set_uint_flag(f->_name, flag_value, origin, err_msg);
 280   } else if (f->is_intx()) {
 281     return set_intx_flag(f->_name, flag_value, origin, err_msg);
 282   } else if (f->is_uintx()) {
 283     return set_uintx_flag(f->_name, flag_value, origin, err_msg);
 284   } else if (f->is_uint64_t()) {
 285     return set_uint64_t_flag(f->_name, flag_value, origin, err_msg);
 286   } else if (f->is_size_t()) {
 287     return set_size_t_flag(f->_name, flag_value, origin, err_msg);
 288   } else if (f->is_ccstr()) {
 289     return set_ccstr_flag(f->_name, flag_value, origin, err_msg);
 290   } else {
 291     ShouldNotReachHere();
 292   }
 293   return Flag::ERR_OTHER;
 294 }
 295 
 296 // a writeable flag setter accepting 'jvalue' values
 297 Flag::Error WriteableFlags::set_flag_from_jvalue(Flag* f, const void* value, Flag::Flags origin,
 298                                                  FormatBuffer<80>& err_msg) {
 299   jvalue new_value = *(jvalue*)value;
 300   if (f->is_bool()) {
 301     bool bvalue = (new_value.z == JNI_TRUE ? true : false);
 302     return set_bool_flag(f->_name, bvalue, origin, err_msg);
 303   } else if (f->is_int()) {
 304     int ivalue = (int)new_value.j;
 305     return set_int_flag(f->_name, ivalue, origin, err_msg);
 306   } else if (f->is_uint()) {
 307     uint uvalue = (uint)new_value.j;
 308     return set_uint_flag(f->_name, uvalue, origin, err_msg);
 309   } else if (f->is_intx()) {
 310     intx ivalue = (intx)new_value.j;
 311     return set_intx_flag(f->_name, ivalue, origin, err_msg);
 312   } else if (f->is_uintx()) {
 313     uintx uvalue = (uintx)new_value.j;
 314     return set_uintx_flag(f->_name, uvalue, origin, err_msg);
 315   } else if (f->is_uint64_t()) {
 316     uint64_t uvalue = (uint64_t)new_value.j;
 317     return set_uint64_t_flag(f->_name, uvalue, origin, err_msg);
 318   } else if (f->is_size_t()) {
 319     size_t svalue = (size_t)new_value.j;
 320     return set_size_t_flag(f->_name, svalue, origin, err_msg);
 321   } else if (f->is_ccstr()) {
 322     oop str = JNIHandles::resolve_external_guard(new_value.l);
 323     if (str == NULL) {
 324       err_msg.print("flag value is missing");
 325       return Flag::MISSING_VALUE;
 326     }
 327     ccstr svalue = java_lang_String::as_utf8_string(str);
 328     Flag::Error ret = WriteableFlags::set_ccstr_flag(f->_name, svalue, origin, err_msg);
 329     if (ret != Flag::SUCCESS) {
 330       FREE_C_HEAP_ARRAY(char, svalue);
 331     }
 332     return ret;
 333   } else {
 334     ShouldNotReachHere();
 335   }
 336   return Flag::ERR_OTHER;
 337 }