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 PRAGMA_FORMAT_NONLITERAL_IGNORED_EXTERNAL
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 }
91
92 PRAGMA_DIAG_PUSH
93 PRAGMA_FORMAT_NONLITERAL_IGNORED_INTERNAL
94 err_msg.print(buffer);
95 PRAGMA_DIAG_POP
96 }
97
98 // set a boolean global flag
99 Flag::Error WriteableFlags::set_bool_flag(const char* name, const char* arg, Flag::Flags origin, FormatBuffer<80>& err_msg) {
100 int value = true;
101
102 if (sscanf(arg, "%d", &value)) {
103 return set_bool_flag(name, value != 0, origin, err_msg);
104 }
105 err_msg.print("flag value must be a boolean (1 or 0)");
106 return Flag::WRONG_FORMAT;
107 }
108
109 Flag::Error WriteableFlags::set_bool_flag(const char* name, bool value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
110 Flag::Error err = CommandLineFlags::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 Flag::Error WriteableFlags::set_int_flag(const char* name, const char* arg, Flag::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 Flag::WRONG_FORMAT;
124 }
125
126 Flag::Error WriteableFlags::set_int_flag(const char* name, int value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
127 Flag::Error err = CommandLineFlags::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 Flag::Error WriteableFlags::set_uint_flag(const char* name, const char* arg, Flag::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 Flag::WRONG_FORMAT;
141 }
142
143 Flag::Error WriteableFlags::set_uint_flag(const char* name, uint value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
144 Flag::Error err = CommandLineFlags::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 Flag::Error WriteableFlags::set_intx_flag(const char* name, const char* arg, Flag::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 Flag::WRONG_FORMAT;
158 }
159
160 Flag::Error WriteableFlags::set_intx_flag(const char* name, intx value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
161 Flag::Error err = CommandLineFlags::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 Flag::Error WriteableFlags::set_uintx_flag(const char* name, const char* arg, Flag::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 Flag::WRONG_FORMAT;
175 }
176
177 Flag::Error WriteableFlags::set_uintx_flag(const char* name, uintx value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
178 Flag::Error err = CommandLineFlags::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 Flag::Error WriteableFlags::set_uint64_t_flag(const char* name, const char* arg, Flag::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 Flag::WRONG_FORMAT;
192 }
193
194 Flag::Error WriteableFlags::set_uint64_t_flag(const char* name, uint64_t value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
195 Flag::Error err = CommandLineFlags::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 Flag::Error WriteableFlags::set_size_t_flag(const char* name, const char* arg, Flag::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 Flag::WRONG_FORMAT;
209 }
210
211 Flag::Error WriteableFlags::set_size_t_flag(const char* name, size_t value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
212 Flag::Error err = CommandLineFlags::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 Flag::Error WriteableFlags::set_ccstr_flag(const char* name, const char* value, Flag::Flags origin, FormatBuffer<80>& err_msg) {
219 Flag::Error err = CommandLineFlags::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 Flag::Error WriteableFlags::set_flag(const char* flag_name, const char* flag_value, Flag::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 Flag::Error WriteableFlags::set_flag(const char* flag_name, jvalue flag_value, Flag::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 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) {
244 if (name == NULL) {
245 err_msg.print("flag name is missing");
246 return Flag::MISSING_NAME;
247 }
248 if (value == NULL) {
249 err_msg.print("flag value is missing");
250 return Flag::MISSING_VALUE;
251 }
252
253 Flag* f = Flag::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 Flag::NON_WRITABLE;
261 }
262 }
263
264 err_msg.print("flag %s does not exist", name);
265 return Flag::INVALID_FLAG;
266 }
267
268 // a writeable flag setter accepting 'char *' values
269 Flag::Error WriteableFlags::set_flag_from_char(Flag* f, const void* value, Flag::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 Flag::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 Flag::ERR_OTHER;
295 }
296
297 // a writeable flag setter accepting 'jvalue' values
298 Flag::Error WriteableFlags::set_flag_from_jvalue(Flag* f, const void* value, Flag::Flags origin, 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 }
338