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