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