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