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/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 }
90
91 err_msg.print("%s", buffer);
92 }
93
94 // set a boolean global flag
95 Flag::Error WriteableFlags::set_bool_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
96 if ((strcasecmp(arg, "true") == 0) || (*arg == '1' && *(arg + 1) == 0)) {
97 return set_bool_flag(name, true, origin, err_msg);
98 } else if ((strcasecmp(arg, "false") == 0) || (*arg == '0' && *(arg + 1) == 0)) {
99 return set_bool_flag(name, false, origin, err_msg);
100 }
101 err_msg.print("flag value must be a boolean (1/0 or true/false)");
102 return Flag::WRONG_FORMAT;
103 }
104
105 Flag::Error WriteableFlags::set_bool_flag(const char* name, bool value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
106 Flag::Error err = CommandLineFlags::boolAtPut(name, &value, origin);
107 print_flag_error_message_if_needed(err, name, err_msg);
108 return err;
109 }
110
111 // set a int global flag
112 Flag::Error WriteableFlags::set_int_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
113 int value;
114
115 if (sscanf(arg, "%d", &value)) {
116 return set_int_flag(name, value, origin, err_msg);
117 }
118 err_msg.print("flag value must be an integer");
119 return Flag::WRONG_FORMAT;
120 }
121
122 Flag::Error WriteableFlags::set_int_flag(const char* name, int value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
123 Flag::Error err = CommandLineFlags::intAtPut(name, &value, origin);
124 print_flag_error_message_if_needed(err, name, err_msg);
125 return err;
126 }
127
128 // set a uint global flag
129 Flag::Error WriteableFlags::set_uint_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
130 uint value;
131
132 if (sscanf(arg, "%u", &value)) {
133 return set_uint_flag(name, value, origin, err_msg);
134 }
135 err_msg.print("flag value must be an unsigned integer");
136 return Flag::WRONG_FORMAT;
137 }
138
139 Flag::Error WriteableFlags::set_uint_flag(const char* name, uint value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
140 Flag::Error err = CommandLineFlags::uintAtPut(name, &value, origin);
141 print_flag_error_message_if_needed(err, name, err_msg);
142 return err;
143 }
144
145 // set a intx global flag
146 Flag::Error WriteableFlags::set_intx_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
147 intx value;
148
149 if (sscanf(arg, INTX_FORMAT, &value)) {
150 return set_intx_flag(name, value, origin, err_msg);
151 }
152 err_msg.print("flag value must be an integer");
153 return Flag::WRONG_FORMAT;
154 }
155
156 Flag::Error WriteableFlags::set_intx_flag(const char* name, intx value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
157 Flag::Error err = CommandLineFlags::intxAtPut(name, &value, origin);
158 print_flag_error_message_if_needed(err, name, err_msg);
159 return err;
160 }
161
162 // set a uintx global flag
163 Flag::Error WriteableFlags::set_uintx_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
164 uintx value;
165
166 if (sscanf(arg, UINTX_FORMAT, &value)) {
167 return set_uintx_flag(name, value, origin, err_msg);
168 }
169 err_msg.print("flag value must be an unsigned integer");
170 return Flag::WRONG_FORMAT;
171 }
172
173 Flag::Error WriteableFlags::set_uintx_flag(const char* name, uintx value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
174 Flag::Error err = CommandLineFlags::uintxAtPut(name, &value, origin);
175 print_flag_error_message_if_needed(err, name, err_msg);
176 return err;
177 }
178
179 // set a uint64_t global flag
180 Flag::Error WriteableFlags::set_uint64_t_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
181 uint64_t value;
182
183 if (sscanf(arg, UINT64_FORMAT, &value)) {
184 return set_uint64_t_flag(name, value, origin, err_msg);
185 }
186 err_msg.print("flag value must be an unsigned 64-bit integer");
187 return Flag::WRONG_FORMAT;
188 }
189
190 Flag::Error WriteableFlags::set_uint64_t_flag(const char* name, uint64_t value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
191 Flag::Error err = CommandLineFlags::uint64_tAtPut(name, &value, origin);
192 print_flag_error_message_if_needed(err, name, err_msg);
193 return err;
194 }
195
196 // set a size_t global flag
197 Flag::Error WriteableFlags::set_size_t_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
198 size_t value;
199
200 if (sscanf(arg, SIZE_FORMAT, &value)) {
201 return set_size_t_flag(name, value, origin, err_msg);
202 }
203 err_msg.print("flag value must be an unsigned integer");
204 return Flag::WRONG_FORMAT;
205 }
206
207 Flag::Error WriteableFlags::set_size_t_flag(const char* name, size_t value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
208 Flag::Error err = CommandLineFlags::size_tAtPut(name, &value, origin);
209 print_flag_error_message_if_needed(err, name, err_msg);
210 return err;
211 }
212
213 // set a string global flag using value from AttachOperation
214 Flag::Error WriteableFlags::set_ccstr_flag(const char* name, const char* value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
215 Flag::Error err = CommandLineFlags::ccstrAtPut((char*)name, &value, origin);
216 print_flag_error_message_if_needed(err, name, err_msg);
217 return err;
218 }
219
220 /* sets a writeable flag to the provided value
221 *
222 * - return status is one of the WriteableFlags::err enum values
223 * - an eventual error message will be generated to the provided err_msg buffer
224 */
225 Flag::Error WriteableFlags::set_flag(const char* flag_name, const char* flag_value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
226 return set_flag(flag_name, &flag_value, set_flag_from_char, origin, err_msg);
227 }
228
229 /* sets a writeable flag to the provided value
230 *
231 * - return status is one of the WriteableFlags::err enum values
232 * - an eventual error message will be generated to the provided err_msg buffer
233 */
234 Flag::Error WriteableFlags::set_flag(const char* flag_name, jvalue flag_value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
235 return set_flag(flag_name, &flag_value, set_flag_from_jvalue, origin, err_msg);
236 }
237
238 // a writeable flag setter accepting either 'jvalue' or 'char *' values
239 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) {
240 if (name == NULL) {
241 err_msg.print("flag name is missing");
242 return Flag::MISSING_NAME;
243 }
244 if (value == NULL) {
245 err_msg.print("flag value is missing");
246 return Flag::MISSING_VALUE;
247 }
248
249 Flag* f = Flag::find_flag((char*)name, strlen(name));
250 if (f) {
251 // only writeable flags are allowed to be set
252 if (f->is_writeable()) {
253 return setter(f, value, origin, err_msg);
254 } else {
255 err_msg.print("only 'writeable' flags can be set");
256 return Flag::NON_WRITABLE;
257 }
258 }
259
260 err_msg.print("flag %s does not exist", name);
261 return Flag::INVALID_FLAG;
262 }
263
264 // a writeable flag setter accepting 'char *' values
265 Flag::Error WriteableFlags::set_flag_from_char(Flag* f, const void* value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
266 char* flag_value = *(char**)value;
267 if (flag_value == NULL) {
268 err_msg.print("flag value is missing");
269 return Flag::MISSING_VALUE;
270 }
271 if (f->is_bool()) {
272 return set_bool_flag(f->_name, flag_value, origin, err_msg);
273 } else if (f->is_int()) {
274 return set_int_flag(f->_name, flag_value, origin, err_msg);
275 } else if (f->is_uint()) {
276 return set_uint_flag(f->_name, flag_value, origin, err_msg);
277 } else if (f->is_intx()) {
278 return set_intx_flag(f->_name, flag_value, origin, err_msg);
279 } else if (f->is_uintx()) {
280 return set_uintx_flag(f->_name, flag_value, origin, err_msg);
281 } else if (f->is_uint64_t()) {
282 return set_uint64_t_flag(f->_name, flag_value, origin, err_msg);
283 } else if (f->is_size_t()) {
284 return set_size_t_flag(f->_name, flag_value, origin, err_msg);
285 } else if (f->is_ccstr()) {
286 return set_ccstr_flag(f->_name, flag_value, origin, err_msg);
287 } else {
288 ShouldNotReachHere();
289 }
290 return Flag::ERR_OTHER;
291 }
292
293 // a writeable flag setter accepting 'jvalue' values
294 Flag::Error WriteableFlags::set_flag_from_jvalue(Flag* f, const void* value, Flag::Flags origin,
295 FormatBuffer<80>& err_msg) {
296 jvalue new_value = *(jvalue*)value;
297 if (f->is_bool()) {
298 bool bvalue = (new_value.z == JNI_TRUE ? true : false);
299 return set_bool_flag(f->_name, bvalue, origin, err_msg);
300 } else if (f->is_int()) {
301 int ivalue = (int)new_value.j;
302 return set_int_flag(f->_name, ivalue, origin, err_msg);
303 } else if (f->is_uint()) {
304 uint uvalue = (uint)new_value.j;
305 return set_uint_flag(f->_name, uvalue, origin, err_msg);
306 } else if (f->is_intx()) {
307 intx ivalue = (intx)new_value.j;
308 return set_intx_flag(f->_name, ivalue, origin, err_msg);
309 } else if (f->is_uintx()) {
310 uintx uvalue = (uintx)new_value.j;
311 return set_uintx_flag(f->_name, uvalue, origin, err_msg);
312 } else if (f->is_uint64_t()) {
313 uint64_t uvalue = (uint64_t)new_value.j;
314 return set_uint64_t_flag(f->_name, uvalue, origin, err_msg);
315 } else if (f->is_size_t()) {
316 size_t svalue = (size_t)new_value.j;
317 return set_size_t_flag(f->_name, svalue, origin, err_msg);
318 } else if (f->is_ccstr()) {
319 oop str = JNIHandles::resolve_external_guard(new_value.l);
320 if (str == NULL) {
321 err_msg.print("flag value is missing");
322 return Flag::MISSING_VALUE;
323 }
324 ccstr svalue = java_lang_String::as_utf8_string(str);
325 Flag::Error ret = WriteableFlags::set_ccstr_flag(f->_name, svalue, origin, err_msg);
326 if (ret != Flag::SUCCESS) {
327 FREE_C_HEAP_ARRAY(char, svalue);
328 }
329 return ret;
330 } else {
331 ShouldNotReachHere();
332 }
333 return Flag::ERR_OTHER;
334 }