1 /*
2 * Copyright (c) 1998, 2025, 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 "classfile/symbolTable.hpp"
26 #include "compiler/compilerDirectives.hpp"
27 #include "compiler/compilerOracle.hpp"
28 #include "compiler/methodMatcher.hpp"
29 #include "jvm.h"
30 #include "memory/allocation.inline.hpp"
31 #include "memory/oopFactory.hpp"
32 #include "memory/resourceArea.hpp"
33 #include "oops/klass.hpp"
34 #include "oops/method.inline.hpp"
35 #include "oops/symbol.hpp"
36 #include "opto/phasetype.hpp"
37 #include "opto/traceAutoVectorizationTag.hpp"
38 #include "opto/traceMergeStoresTag.hpp"
39 #include "runtime/globals_extension.hpp"
40 #include "runtime/handles.inline.hpp"
41 #include "runtime/jniHandles.hpp"
42 #include "runtime/os.hpp"
43 #include "utilities/istream.hpp"
44 #include "utilities/parseInteger.hpp"
45
46 // Default compile commands, if defined, are parsed before any of the
47 // explicitly defined compile commands. Thus, explicitly defined compile
48 // commands take precedence over default compile commands. The effect is
49 // as if the default compile commands had been specified at the start of
50 // the command line.
51 static const char* const default_compile_commands[] = {
52 #ifdef ASSERT
53 // In debug builds, impose a (generous) per-compilation memory limit
54 // to catch pathological compilations during testing. The suboption
55 // "crash" will cause the JVM to assert.
56 //
57 // Note: to disable the default limit at the command line,
58 // set a limit of 0 (e.g. -XX:CompileCommand=MemLimit,*.*,0).
59 "MemLimit,*.*,1G~crash",
60 #endif
61 nullptr };
62
63 static const char* optiontype_names[] = {
64 #define enum_of_types(type, name) name,
65 OPTION_TYPES(enum_of_types)
66 #undef enum_of_types
67 };
68
69 static const char* optiontype2name(enum OptionType type) {
70 return optiontype_names[static_cast<int>(type)];
71 }
72
73 static enum OptionType option_types[] = {
74 #define enum_of_options(option, name, ctype) OptionType::ctype,
75 COMPILECOMMAND_OPTIONS(enum_of_options)
76 #undef enum_of_options
77 };
78
79 static enum OptionType option2type(CompileCommandEnum option) {
80 return option_types[static_cast<int>(option)];
81 }
82
83 static const char* option_names[] = {
84 #define enum_of_options(option, name, ctype) name,
85 COMPILECOMMAND_OPTIONS(enum_of_options)
86 #undef enum_of_options
87 };
88
89 static const char* option2name(CompileCommandEnum option) {
90 return option_names[static_cast<int>(option)];
91 }
92
93 /* Methods to map real type names to OptionType */
94 template<typename T>
95 static OptionType get_type_for() {
96 return OptionType::Unknown;
97 };
98
99 template<> OptionType get_type_for<intx>() {
100 return OptionType::Intx;
101 }
102
103 template<> OptionType get_type_for<uintx>() {
104 return OptionType::Uintx;
105 }
106
107 template<> OptionType get_type_for<bool>() {
108 return OptionType::Bool;
109 }
110
111 template<> OptionType get_type_for<ccstr>() {
112 return OptionType::Ccstr;
113 }
114
115 template<> OptionType get_type_for<double>() {
116 return OptionType::Double;
117 }
118
119 class MethodMatcher;
120 class TypedMethodOptionMatcher;
121
122 static TypedMethodOptionMatcher* option_list = nullptr;
123 static bool any_set = false;
124
125 // A filter for quick lookup if an option is set
126 static bool option_filter[static_cast<int>(CompileCommandEnum::Unknown) + 1] = { 0 };
127
128 static void command_set_in_filter(CompileCommandEnum option) {
129 assert(option != CompileCommandEnum::Unknown, "sanity");
130 assert(option2type(option) != OptionType::Unknown, "sanity");
131
132 if ((option != CompileCommandEnum::DontInline) &&
133 (option != CompileCommandEnum::Inline) &&
134 (option != CompileCommandEnum::Log)) {
135 any_set = true;
136 }
137 option_filter[static_cast<int>(option)] = true;
138 }
139
140 static bool has_command(CompileCommandEnum option) {
141 return option_filter[static_cast<int>(option)];
142 }
143
144 class TypedMethodOptionMatcher : public MethodMatcher {
145 private:
146 TypedMethodOptionMatcher* _next;
147 CompileCommandEnum _option;
148 public:
149
150 union {
151 bool bool_value;
152 intx intx_value;
153 uintx uintx_value;
154 double double_value;
155 ccstr ccstr_value;
156 } _u;
157
158 TypedMethodOptionMatcher() : MethodMatcher(),
159 _next(nullptr),
160 _option(CompileCommandEnum::Unknown) {
161 memset(&_u, 0, sizeof(_u));
162 }
163
164 ~TypedMethodOptionMatcher();
165 static TypedMethodOptionMatcher* parse_method_pattern(char*& line, char* errorbuf, const int buf_size);
166 TypedMethodOptionMatcher* match(const methodHandle &method, CompileCommandEnum option);
167
168 void init(CompileCommandEnum option, TypedMethodOptionMatcher* next) {
169 _next = next;
170 _option = option;
171 }
172
173 void init_matcher(Symbol* class_name, Mode class_mode,
174 Symbol* method_name, Mode method_mode,
175 Symbol* signature) {
176 MethodMatcher::init(class_name, class_mode, method_name, method_mode, signature);
177 }
178
179 void set_next(TypedMethodOptionMatcher* next) {_next = next; }
180 TypedMethodOptionMatcher* next() { return _next; }
181 CompileCommandEnum option() { return _option; }
182 template<typename T> T value();
183 template<typename T> void set_value(T value);
184 void print();
185 void print_all();
186 TypedMethodOptionMatcher* clone();
187 };
188
189 // A few templated accessors instead of a full template class.
190 template<> intx TypedMethodOptionMatcher::value<intx>() {
191 return _u.intx_value;
192 }
193
194 template<> uintx TypedMethodOptionMatcher::value<uintx>() {
195 return _u.uintx_value;
196 }
197
198 template<> bool TypedMethodOptionMatcher::value<bool>() {
199 return _u.bool_value;
200 }
201
202 template<> double TypedMethodOptionMatcher::value<double>() {
203 return _u.double_value;
204 }
205
206 template<> ccstr TypedMethodOptionMatcher::value<ccstr>() {
207 return _u.ccstr_value;
208 }
209
210 template<> void TypedMethodOptionMatcher::set_value(intx value) {
211 _u.intx_value = value;
212 }
213
214 template<> void TypedMethodOptionMatcher::set_value(uintx value) {
215 _u.uintx_value = value;
216 }
217
218 template<> void TypedMethodOptionMatcher::set_value(double value) {
219 _u.double_value = value;
220 }
221
222 template<> void TypedMethodOptionMatcher::set_value(bool value) {
223 _u.bool_value = value;
224 }
225
226 template<> void TypedMethodOptionMatcher::set_value(ccstr value) {
227 _u.ccstr_value = (ccstr)os::strdup_check_oom(value);
228 }
229
230 void TypedMethodOptionMatcher::print() {
231 ttyLocker ttyl;
232 print_base(tty);
233 const char* name = option2name(_option);
234 enum OptionType type = option2type(_option);
235 switch (type) {
236 case OptionType::Intx:
237 tty->print_cr(" intx %s = %zd", name, value<intx>());
238 break;
239 case OptionType::Uintx:
240 tty->print_cr(" uintx %s = %zu", name, value<uintx>());
241 break;
242 case OptionType::Bool:
243 tty->print_cr(" bool %s = %s", name, value<bool>() ? "true" : "false");
244 break;
245 case OptionType::Double:
246 tty->print_cr(" double %s = %f", name, value<double>());
247 break;
248 case OptionType::Ccstr:
249 case OptionType::Ccstrlist:
250 tty->print_cr(" const char* %s = '%s'", name, value<ccstr>());
251 break;
252 default:
253 ShouldNotReachHere();
254 }
255 }
256
257 void TypedMethodOptionMatcher::print_all() {
258 print();
259 if (_next != nullptr) {
260 tty->print(" ");
261 _next->print_all();
262 }
263 }
264
265 TypedMethodOptionMatcher* TypedMethodOptionMatcher::clone() {
266 TypedMethodOptionMatcher* m = new TypedMethodOptionMatcher();
267 m->_class_mode = _class_mode;
268 m->_class_name = _class_name;
269 m->_method_mode = _method_mode;
270 m->_method_name = _method_name;
271 m->_signature = _signature;
272 // Need to ref count the symbols
273 if (_class_name != nullptr) {
274 _class_name->increment_refcount();
275 }
276 if (_method_name != nullptr) {
277 _method_name->increment_refcount();
278 }
279 if (_signature != nullptr) {
280 _signature->increment_refcount();
281 }
282 return m;
283 }
284
285 TypedMethodOptionMatcher::~TypedMethodOptionMatcher() {
286 enum OptionType type = option2type(_option);
287 if (type == OptionType::Ccstr || type == OptionType::Ccstrlist) {
288 ccstr v = value<ccstr>();
289 os::free((void*)v);
290 }
291 }
292
293 TypedMethodOptionMatcher* TypedMethodOptionMatcher::parse_method_pattern(char*& line, char* errorbuf, const int buf_size) {
294 assert(*errorbuf == '\0', "Dont call here with error_msg already set");
295 const char* error_msg = nullptr;
296 TypedMethodOptionMatcher* tom = new TypedMethodOptionMatcher();
297 MethodMatcher::parse_method_pattern(line, error_msg, tom);
298 if (error_msg != nullptr) {
299 jio_snprintf(errorbuf, buf_size, error_msg);
300 delete tom;
301 return nullptr;
302 }
303 return tom;
304 }
305
306 TypedMethodOptionMatcher* TypedMethodOptionMatcher::match(const methodHandle& method, CompileCommandEnum option) {
307 TypedMethodOptionMatcher* current = this;
308 while (current != nullptr) {
309 if (current->_option == option) {
310 if (current->matches(method)) {
311 return current;
312 }
313 }
314 current = current->next();
315 }
316 return nullptr;
317 }
318
319 template<typename T>
320 static bool register_command(TypedMethodOptionMatcher* matcher,
321 CompileCommandEnum option,
322 char* errorbuf,
323 const int buf_size,
324 T value) {
325 assert(matcher != option_list, "No circular lists please");
326 if (option == CompileCommandEnum::Log && !LogCompilation) {
327 tty->print_cr("Warning: +LogCompilation must be enabled in order for individual methods to be logged with ");
328 tty->print_cr(" CompileCommand=log,<method pattern>");
329 }
330 assert(CompilerOracle::option_matches_type(option, value), "Value must match option type");
331
332 if (option == CompileCommandEnum::Blackhole && !UnlockExperimentalVMOptions) {
333 warning("Blackhole compile option is experimental and must be enabled via -XX:+UnlockExperimentalVMOptions");
334 // Delete matcher as we don't keep it
335 delete matcher;
336 return true;
337 }
338
339 if (!UnlockDiagnosticVMOptions) {
340 const char* name = option2name(option);
341 JVMFlag* flag = JVMFlag::find_declared_flag(name);
342 if (flag != nullptr && flag->is_diagnostic()) {
343 jio_snprintf(errorbuf, buf_size, "VM option '%s' is diagnostic and must be enabled via -XX:+UnlockDiagnosticVMOptions.", name);
344 delete matcher;
345 return false;
346 }
347 }
348
349 matcher->init(option, option_list);
350 matcher->set_value<T>(value);
351 option_list = matcher;
352 command_set_in_filter(option);
353
354 if (!CompilerOracle::be_quiet()) {
355 // Print out the successful registration of a compile command
356 ttyLocker ttyl;
357 tty->print("CompileCommand: %s ", option2name(option));
358 matcher->print();
359 }
360
361 return true;
362 }
363
364 template<typename T>
365 bool CompilerOracle::has_option_value(const methodHandle& method, CompileCommandEnum option, T& value) {
366 assert(option_matches_type(option, value), "Value must match option type");
367 if (!has_command(option)) {
368 return false;
369 }
370 if (option_list != nullptr) {
371 TypedMethodOptionMatcher* m = option_list->match(method, option);
372 if (m != nullptr) {
373 value = m->value<T>();
374 return true;
375 }
376 }
377 return false;
378 }
379
380 static bool resolve_inlining_predicate(CompileCommandEnum option, const methodHandle& method) {
381 assert(option == CompileCommandEnum::Inline || option == CompileCommandEnum::DontInline, "Sanity");
382 bool v1 = false;
383 bool v2 = false;
384 bool has_inline = CompilerOracle::has_option_value(method, CompileCommandEnum::Inline, v1);
385 bool has_dnotinline = CompilerOracle::has_option_value(method, CompileCommandEnum::DontInline, v2);
386 if (has_inline && has_dnotinline) {
387 if (v1 && v2) {
388 // Conflict options detected
389 // Find the last one for that method and return the predicate accordingly
390 // option_list lists options in reverse order. So the first option we find is the last which was specified.
391 CompileCommandEnum last_one = CompileCommandEnum::Unknown;
392 TypedMethodOptionMatcher* current = option_list;
393 while (current != nullptr) {
394 last_one = current->option();
395 if (last_one == CompileCommandEnum::Inline || last_one == CompileCommandEnum::DontInline) {
396 if (current->matches(method)) {
397 return last_one == option;
398 }
399 }
400 current = current->next();
401 }
402 ShouldNotReachHere();
403 return false;
404 } else {
405 // No conflicts
406 return option == CompileCommandEnum::Inline ? v1 : v2;
407 }
408 } else {
409 if (option == CompileCommandEnum::Inline) {
410 return has_inline ? v1 : false;
411 } else {
412 return has_dnotinline ? v2 : false;
413 }
414 }
415 }
416
417 static bool check_predicate(CompileCommandEnum option, const methodHandle& method) {
418 // Special handling for Inline and DontInline since conflict options may be specified
419 if (option == CompileCommandEnum::Inline || option == CompileCommandEnum::DontInline) {
420 return resolve_inlining_predicate(option, method);
421 }
422
423 bool value = false;
424 if (CompilerOracle::has_option_value(method, option, value)) {
425 return value;
426 }
427 return false;
428 }
429
430 bool CompilerOracle::has_any_command_set() {
431 return any_set;
432 }
433
434 // Explicit instantiation for all OptionTypes supported.
435 template bool CompilerOracle::has_option_value<intx>(const methodHandle& method, CompileCommandEnum option, intx& value);
436 template bool CompilerOracle::has_option_value<uintx>(const methodHandle& method, CompileCommandEnum option, uintx& value);
437 template bool CompilerOracle::has_option_value<bool>(const methodHandle& method, CompileCommandEnum option, bool& value);
438 template bool CompilerOracle::has_option_value<ccstr>(const methodHandle& method, CompileCommandEnum option, ccstr& value);
439 template bool CompilerOracle::has_option_value<double>(const methodHandle& method, CompileCommandEnum option, double& value);
440
441 template<typename T>
442 bool CompilerOracle::option_matches_type(CompileCommandEnum option, T& value) {
443 enum OptionType option_type = option2type(option);
444 if (option_type == OptionType::Unknown) {
445 return false; // Can't query options with type Unknown.
446 }
447 if (option_type == OptionType::Ccstrlist) {
448 option_type = OptionType::Ccstr; // CCstrList type options are stored as Ccstr
449 }
450 return (get_type_for<T>() == option_type);
451 }
452
453 template bool CompilerOracle::option_matches_type<intx>(CompileCommandEnum option, intx& value);
454 template bool CompilerOracle::option_matches_type<uintx>(CompileCommandEnum option, uintx& value);
455 template bool CompilerOracle::option_matches_type<bool>(CompileCommandEnum option, bool& value);
456 template bool CompilerOracle::option_matches_type<ccstr>(CompileCommandEnum option, ccstr& value);
457 template bool CompilerOracle::option_matches_type<double>(CompileCommandEnum option, double& value);
458
459 bool CompilerOracle::has_option(const methodHandle& method, CompileCommandEnum option) {
460 bool value = false;
461 has_option_value(method, option, value);
462 return value;
463 }
464
465 bool CompilerOracle::should_exclude(const methodHandle& method) {
466 if (check_predicate(CompileCommandEnum::Exclude, method)) {
467 return true;
468 }
469 if (has_command(CompileCommandEnum::CompileOnly)) {
470 return !check_predicate(CompileCommandEnum::CompileOnly, method);
471 }
472 return false;
473 }
474
475 bool CompilerOracle::should_inline(const methodHandle& method) {
476 return (check_predicate(CompileCommandEnum::Inline, method));
477 }
478
479 bool CompilerOracle::should_not_inline(const methodHandle& method) {
480 return check_predicate(CompileCommandEnum::DontInline, method) || check_predicate(CompileCommandEnum::Exclude, method);
481 }
482
483 bool CompilerOracle::should_print(const methodHandle& method) {
484 return check_predicate(CompileCommandEnum::Print, method);
485 }
486
487 bool CompilerOracle::should_print_methods() {
488 return has_command(CompileCommandEnum::Print);
489 }
490
491 // Tells whether there are any methods to collect memory statistics for
492 bool CompilerOracle::should_collect_memstat() {
493 return has_command(CompileCommandEnum::MemStat) || has_command(CompileCommandEnum::MemLimit);
494 }
495
496 bool CompilerOracle::should_log(const methodHandle& method) {
497 if (!LogCompilation) return false;
498 if (!has_command(CompileCommandEnum::Log)) {
499 return true; // by default, log all
500 }
501 return (check_predicate(CompileCommandEnum::Log, method));
502 }
503
504 bool CompilerOracle::should_break_at(const methodHandle& method) {
505 return check_predicate(CompileCommandEnum::Break, method);
506 }
507
508 void CompilerOracle::tag_blackhole_if_possible(const methodHandle& method) {
509 if (!check_predicate(CompileCommandEnum::Blackhole, method)) {
510 return;
511 }
512 guarantee(UnlockExperimentalVMOptions, "Checked during initial parsing");
513 if (method->result_type() != T_VOID) {
514 warning("Blackhole compile option only works for methods with void type: %s",
515 method->name_and_sig_as_C_string());
516 return;
517 }
518 if (!method->is_empty_method()) {
519 warning("Blackhole compile option only works for empty methods: %s",
520 method->name_and_sig_as_C_string());
521 return;
522 }
523 if (!method->is_static()) {
524 warning("Blackhole compile option only works for static methods: %s",
525 method->name_and_sig_as_C_string());
526 return;
527 }
528 if (method->intrinsic_id() == vmIntrinsics::_blackhole) {
529 return;
530 }
531 if (method->intrinsic_id() != vmIntrinsics::_none) {
532 warning("Blackhole compile option only works for methods that do not have intrinsic set: %s, %s",
533 method->name_and_sig_as_C_string(), vmIntrinsics::name_at(method->intrinsic_id()));
534 return;
535 }
536 method->set_intrinsic_id(vmIntrinsics::_blackhole);
537 }
538
539 static CompileCommandEnum match_option_name(const char* line, int* bytes_read, char* errorbuf, int bufsize) {
540 assert(ARRAY_SIZE(option_names) == static_cast<int>(CompileCommandEnum::Count), "option_names size mismatch");
541
542 *bytes_read = 0;
543 char option_buf[256];
544 int matches = sscanf(line, "%255[a-zA-Z0-9]%n", option_buf, bytes_read);
545 if (matches > 0 && strcasecmp(option_buf, "unknown") != 0) {
546 for (uint i = 0; i < ARRAY_SIZE(option_names); i++) {
547 if (strcasecmp(option_buf, option_names[i]) == 0) {
548 return static_cast<CompileCommandEnum>(i);
549 }
550 }
551 }
552 jio_snprintf(errorbuf, bufsize, "Unrecognized option '%s'", option_buf);
553 return CompileCommandEnum::Unknown;
554 }
555
556 // match exactly and don't mess with errorbuf
557 CompileCommandEnum CompilerOracle::parse_option_name(const char* line) {
558 for (uint i = 0; i < ARRAY_SIZE(option_names); i++) {
559 if (strcasecmp(line, option_names[i]) == 0) {
560 return static_cast<CompileCommandEnum>(i);
561 }
562 }
563 return CompileCommandEnum::Unknown;
564 }
565
566 enum OptionType CompilerOracle::parse_option_type(const char* type_str) {
567 for (uint i = 0; i < ARRAY_SIZE(optiontype_names); i++) {
568 if (strcasecmp(type_str, optiontype_names[i]) == 0) {
569 return static_cast<enum OptionType>(i);
570 }
571 }
572 return OptionType::Unknown;
573 }
574
575 static void print_tip() { // CMH Update info
576 tty->cr();
577 tty->print_cr("Usage: '-XX:CompileCommand=<option>,<method pattern>' - to set boolean option to true");
578 tty->print_cr("Usage: '-XX:CompileCommand=<option>,<method pattern>,<value>'");
579 tty->print_cr("Use: '-XX:CompileCommand=help' for more information and to list all option.");
580 tty->cr();
581 }
582
583 static void print_option(CompileCommandEnum option, const char* name, enum OptionType type) {
584 if (type != OptionType::Unknown) {
585 tty->print_cr(" %s (%s)", name, optiontype2name(type));
586 }
587 }
588
589 static void print_commands() {
590 tty->cr();
591 tty->print_cr("All available options:");
592 #define enum_of_options(option, name, ctype) print_option(CompileCommandEnum::option, name, OptionType::ctype);
593 COMPILECOMMAND_OPTIONS(enum_of_options)
594 #undef enum_of_options
595 tty->cr();
596 }
597
598 static void usage() {
599 tty->cr();
600 tty->print_cr("The CompileCommand option enables the user of the JVM to control specific");
601 tty->print_cr("behavior of the dynamic compilers.");
602 tty->cr();
603 tty->print_cr("Compile commands has this general form:");
604 tty->print_cr("-XX:CompileCommand=<option><method pattern><value>");
605 tty->print_cr(" Sets <option> to the specified value for methods matching <method pattern>");
606 tty->print_cr(" All options are typed");
607 tty->cr();
608 tty->print_cr("-XX:CompileCommand=<option><method pattern>");
609 tty->print_cr(" Sets <option> to true for methods matching <method pattern>");
610 tty->print_cr(" Only applies to boolean options.");
611 tty->cr();
612 tty->print_cr("-XX:CompileCommand=quiet");
613 tty->print_cr(" Silence the compile command output");
614 tty->cr();
615 tty->print_cr("-XX:CompileCommand=help");
616 tty->print_cr(" Prints this help text");
617 tty->cr();
618 print_commands();
619 tty->cr();
620 tty->print_cr("Method patterns has the format:");
621 tty->print_cr(" package/Class.method()");
622 tty->cr();
623 tty->print_cr("For backward compatibility this form is also allowed:");
624 tty->print_cr(" package.Class::method()");
625 tty->cr();
626 tty->print_cr("The signature can be separated by an optional whitespace or comma:");
627 tty->print_cr(" package/Class.method ()");
628 tty->cr();
629 tty->print_cr("The class and method identifier can be used together with leading or");
630 tty->print_cr("trailing *'s for wildcard matching:");
631 tty->print_cr(" *ackage/Clas*.*etho*()");
632 tty->cr();
633 tty->print_cr("It is possible to use more than one CompileCommand on the command line:");
634 tty->print_cr(" -XX:CompileCommand=exclude,java/*.* -XX:CompileCommand=log,java*.*");
635 tty->cr();
636 tty->print_cr("The CompileCommands can be loaded from a file with the flag");
637 tty->print_cr("-XX:CompileCommandFile=<file> or be added to the file '.hotspot_compiler'");
638 tty->print_cr("Use the same format in the file as the argument to the CompileCommand flag.");
639 tty->print_cr("Add one command on each line.");
640 tty->print_cr(" exclude java/*.*");
641 tty->print_cr(" option java/*.* ReplayInline");
642 tty->cr();
643 tty->print_cr("The following commands have conflicting behavior: 'exclude', 'inline', 'dontinline',");
644 tty->print_cr("and 'compileonly'. There is no priority of commands. Applying (a subset of) these");
645 tty->print_cr("commands to the same method results in undefined behavior.");
646 tty->cr();
647 tty->print_cr("The 'exclude' command excludes methods from top-level compilations as well as");
648 tty->print_cr("from inlining, whereas the 'compileonly' command only excludes methods from");
649 tty->print_cr("top-level compilations (i.e. they can still be inlined into other compilation units).");
650 tty->cr();
651 };
652
653 static int skip_whitespace(char* &line) {
654 // Skip any leading spaces
655 int whitespace_read = 0;
656 sscanf(line, "%*[ \t]%n", &whitespace_read);
657 line += whitespace_read;
658 return whitespace_read;
659 }
660
661 static void skip_comma(char* &line) {
662 // Skip any leading spaces
663 if (*line == ',') {
664 line++;
665 }
666 }
667
668 static bool parseMemLimit(const char* line, intx& value, int& bytes_read, char* errorbuf, const int buf_size) {
669 // Format:
670 // "<memory size>['~' <suboption>]"
671 // <memory size> can have units, e.g. M
672 // <suboption> one of "crash" "stop", if omitted, "stop" is implied.
673 //
674 // Examples:
675 // -XX:CompileCommand='memlimit,*.*,20m'
676 // -XX:CompileCommand='memlimit,*.*,20m~stop'
677 // -XX:CompileCommand='memlimit,Option::toString,1m~crash'
678 //
679 // The resulting intx carries the size and whether we are to stop or crash:
680 // - neg. value means crash
681 // - pos. value (default) means stop
682 size_t s = 0;
683 char* end;
684 if (!parse_integer<size_t>(line, &end, &s)) {
685 jio_snprintf(errorbuf, buf_size, "MemLimit: invalid value");
686 return false;
687 }
688 bytes_read = (int)(end - line);
689
690 intx v = (intx)s;
691 if ((*end) != '\0') {
692 if (strncasecmp(end, "~crash", 6) == 0) {
693 v = -v;
694 bytes_read += 6;
695 } else if (strncasecmp(end, "~stop", 5) == 0) {
696 // ok, this is the default
697 bytes_read += 5;
698 } else {
699 jio_snprintf(errorbuf, buf_size, "MemLimit: invalid option");
700 return false;
701 }
702 }
703 value = v;
704 return true;
705 }
706
707 static bool parseMemStat(const char* line, uintx& value, int& bytes_read, char* errorbuf, const int buf_size) {
708
709 #define IF_ENUM_STRING(S, CMD) \
710 if (strncasecmp(line, S, strlen(S)) == 0) { \
711 bytes_read += (int)strlen(S); \
712 CMD \
713 return true; \
714 }
715
716 IF_ENUM_STRING("collect", {
717 value = (uintx)MemStatAction::collect;
718 });
719 IF_ENUM_STRING("print", {
720 value = (uintx)MemStatAction::print;
721 });
722 #undef IF_ENUM_STRING
723
724 jio_snprintf(errorbuf, buf_size, "MemStat: invalid option");
725
726 return false;
727 }
728
729 static bool scan_value(enum OptionType type, char* line, int& total_bytes_read,
730 TypedMethodOptionMatcher* matcher, CompileCommandEnum option, char* errorbuf, const int buf_size) {
731 int bytes_read = 0;
732 const char* ccname = option2name(option);
733 const char* type_str = optiontype2name(type);
734 int skipped = skip_whitespace(line);
735 total_bytes_read += skipped;
736 if (type == OptionType::Intx) {
737 intx value;
738 bool success = false;
739 if (option == CompileCommandEnum::MemLimit) {
740 // Special parsing for MemLimit
741 success = parseMemLimit(line, value, bytes_read, errorbuf, buf_size);
742 } else {
743 // Is it a raw number?
744 success = sscanf(line, "%zd%n", &value, &bytes_read) == 1;
745 }
746 if (success) {
747 total_bytes_read += bytes_read;
748 return register_command(matcher, option, errorbuf, buf_size, value);
749 } else {
750 jio_snprintf(errorbuf, buf_size, "Value cannot be read for option '%s' of type '%s'", ccname, type_str);
751 return false;
752 }
753 } else if (type == OptionType::Uintx) {
754 uintx value;
755 bool success = false;
756 if (option == CompileCommandEnum::MemStat) {
757 // Special parsing for MemStat
758 success = parseMemStat(line, value, bytes_read, errorbuf, buf_size);
759 } else {
760 // parse as raw number
761 success = sscanf(line, "%zu%n", &value, &bytes_read) == 1;
762 }
763 if (success) {
764 total_bytes_read += bytes_read;
765 return register_command(matcher, option, errorbuf, buf_size, value);
766 } else {
767 jio_snprintf(errorbuf, buf_size, "Value cannot be read for option '%s' of type '%s'", ccname, type_str);
768 return false;
769 }
770 } else if (type == OptionType::Ccstr) {
771 ResourceMark rm;
772 char* value = NEW_RESOURCE_ARRAY(char, strlen(line) + 1);
773 if (sscanf(line, "%255[_a-zA-Z0-9]%n", value, &bytes_read) == 1) {
774 total_bytes_read += bytes_read;
775 return register_command(matcher, option, errorbuf, buf_size, (ccstr) value);
776 } else {
777 jio_snprintf(errorbuf, buf_size, "Value cannot be read for option '%s' of type '%s'", ccname, type_str);
778 return false;
779 }
780 } else if (type == OptionType::Ccstrlist) {
781 // Accumulates several strings into one. The internal type is ccstr.
782 ResourceMark rm;
783 char* value = NEW_RESOURCE_ARRAY(char, strlen(line) + 1);
784 char* next_value = value;
785 if (sscanf(line, "%255[_a-zA-Z0-9+\\-]%n", next_value, &bytes_read) == 1) {
786 total_bytes_read += bytes_read;
787 line += bytes_read;
788 next_value += bytes_read + 1;
789 char* end_value = next_value - 1;
790 while (sscanf(line, "%*[ \t]%255[_a-zA-Z0-9+\\-]%n", next_value, &bytes_read) == 1) {
791 total_bytes_read += bytes_read;
792 line += bytes_read;
793 *end_value = ' '; // override '\0'
794 next_value += bytes_read;
795 end_value = next_value-1;
796 }
797
798 if (option == CompileCommandEnum::ControlIntrinsic || option == CompileCommandEnum::DisableIntrinsic) {
799 ControlIntrinsicValidator validator(value, (option == CompileCommandEnum::DisableIntrinsic));
800
801 if (!validator.is_valid()) {
802 jio_snprintf(errorbuf, buf_size, "Unrecognized intrinsic detected in %s: %s", option2name(option), validator.what());
803 return false;
804 }
805 }
806 #if !defined(PRODUCT) && defined(COMPILER2)
807 else if (option == CompileCommandEnum::TraceAutoVectorization) {
808 TraceAutoVectorizationTagValidator validator(value, true);
809
810 if (!validator.is_valid()) {
811 jio_snprintf(errorbuf, buf_size, "Unrecognized tag name in %s: %s", option2name(option), validator.what());
812 return false;
813 }
814 } else if (option == CompileCommandEnum::TraceMergeStores) {
815 TraceMergeStores::TagValidator validator(value, true);
816
817 if (!validator.is_valid()) {
818 jio_snprintf(errorbuf, buf_size, "Unrecognized tag name in %s: %s", option2name(option), validator.what());
819 return false;
820 }
821 } else if (option == CompileCommandEnum::PrintIdealPhase) {
822 PhaseNameValidator validator(value);
823
824 if (!validator.is_valid()) {
825 jio_snprintf(errorbuf, buf_size, "Unrecognized phase name in %s: %s", option2name(option), validator.what());
826 return false;
827 }
828 } else if (option == CompileCommandEnum::TestOptionList) {
829 // all values are ok
830 } else if (option == CompileCommandEnum::TooManyTrapsAtBCI) {
831 // FIXME
832 }
833 #endif
834 else {
835 assert(false, "Ccstrlist type option missing validator");
836 }
837
838 return register_command(matcher, option, errorbuf, buf_size, (ccstr) value);
839 } else {
840 jio_snprintf(errorbuf, buf_size, "Value cannot be read for option '%s' of type '%s'", ccname, type_str);
841 return false;
842 }
843 } else if (type == OptionType::Bool) {
844 char value[256];
845 if (*line == '\0') {
846 // Short version of a CompileCommand sets a boolean Option to true
847 // -XXCompileCommand=<Option>,<method pattern>
848 return register_command(matcher, option, errorbuf, buf_size,true);
849 }
850 if (sscanf(line, "%255[a-zA-Z]%n", value, &bytes_read) == 1) {
851 if (strcasecmp(value, "true") == 0) {
852 total_bytes_read += bytes_read;
853 return register_command(matcher, option, errorbuf, buf_size,true);
854 } else if (strcasecmp(value, "false") == 0) {
855 total_bytes_read += bytes_read;
856 return register_command(matcher, option, errorbuf, buf_size,false);
857 } else {
858 jio_snprintf(errorbuf, buf_size, "Value cannot be read for option '%s' of type '%s'", ccname, type_str);
859 return false;
860 }
861 } else {
862 jio_snprintf(errorbuf, buf_size, "Value cannot be read for option '%s' of type '%s'", ccname, type_str);
863 return false;
864 }
865 } else if (type == OptionType::Double) {
866 char buffer[2][256];
867 // Decimal separator '.' has been replaced with ' ' or '/' earlier,
868 // so read integer and fraction part of double value separately.
869 if (sscanf(line, "%255[0-9]%*[ /\t]%255[0-9]%n", buffer[0], buffer[1], &bytes_read) == 2) {
870 char value[512] = "";
871 jio_snprintf(value, sizeof(value), "%s.%s", buffer[0], buffer[1]);
872 total_bytes_read += bytes_read;
873 return register_command(matcher, option, errorbuf, buf_size, atof(value));
874 } else {
875 jio_snprintf(errorbuf, buf_size, "Value cannot be read for option '%s' of type '%s'", ccname, type_str);
876 return false;
877 }
878 } else {
879 jio_snprintf(errorbuf, buf_size, "Type '%s' not supported ", type_str);
880 return false;
881 }
882 }
883
884 // Scan next option and value in line, return MethodMatcher object on success, nullptr on failure.
885 // On failure, error_msg contains description for the first error.
886 // For future extensions: set error_msg on first error.
887 static bool scan_option_and_value(enum OptionType type, char* line, int& total_bytes_read,
888 TypedMethodOptionMatcher* matcher,
889 char* errorbuf, const int buf_size) {
890 total_bytes_read = 0;
891 int bytes_read = 0;
892 char option_buf[256];
893
894 // Read option name.
895 if (sscanf(line, "%*[ \t]%255[a-zA-Z0-9]%n", option_buf, &bytes_read) == 1) {
896 line += bytes_read;
897 total_bytes_read += bytes_read;
898 int bytes_read2 = 0;
899 total_bytes_read += skip_whitespace(line);
900 CompileCommandEnum option = match_option_name(option_buf, &bytes_read2, errorbuf, buf_size);
901 if (option == CompileCommandEnum::Unknown) {
902 assert(*errorbuf != '\0', "error must have been set");
903 return false;
904 }
905 enum OptionType optiontype = option2type(option);
906 if (option2type(option) != type) {
907 const char* optiontype_name = optiontype2name(optiontype);
908 const char* type_name = optiontype2name(type);
909 jio_snprintf(errorbuf, buf_size, "Option '%s' with type '%s' doesn't match supplied type '%s'", option_buf, optiontype_name, type_name);
910 return false;
911 }
912 return scan_value(type, line, total_bytes_read, matcher, option, errorbuf, buf_size);
913 } else {
914 const char* type_str = optiontype2name(type);
915 jio_snprintf(errorbuf, buf_size, "Option name for type '%s' should be alphanumeric ", type_str);
916 return false;
917 }
918 }
919
920 void CompilerOracle::print_parse_error(char* error_msg, char* original_line) {
921 assert(*error_msg != '\0', "Must have error_message");
922 ttyLocker ttyl;
923 tty->print_cr("CompileCommand: An error occurred during parsing");
924 tty->print_cr("Error: %s", error_msg);
925 tty->print_cr("Line: '%s'", original_line);
926 print_tip();
927 }
928
929 class LineCopy : StackObj {
930 const char* _copy;
931 public:
932 LineCopy(char* line) {
933 _copy = os::strdup(line, mtInternal);
934 }
935 ~LineCopy() {
936 os::free((void*)_copy);
937 }
938 char* get() {
939 return (char*)_copy;
940 }
941 };
942
943 bool CompilerOracle::parse_from_line_quietly(char* line) {
944 const bool quiet0 = _quiet;
945 _quiet = true;
946 const bool result = parse_from_line(line);
947 _quiet = quiet0;
948 return result;
949 }
950
951 bool CompilerOracle::parse_from_line(char* line) {
952 if ((line[0] == '\0') || (line[0] == '#')) {
953 return true;
954 }
955
956 LineCopy original(line);
957 int bytes_read;
958 char error_buf[1024] = {0};
959
960 CompileCommandEnum option = match_option_name(line, &bytes_read, error_buf, sizeof(error_buf));
961 line += bytes_read;
962 ResourceMark rm;
963
964 if (option == CompileCommandEnum::Unknown) {
965 print_parse_error(error_buf, original.get());
966 return false;
967 }
968
969 if (option == CompileCommandEnum::Quiet) {
970 _quiet = true;
971 return true;
972 }
973
974 if (option == CompileCommandEnum::Help) {
975 usage();
976 return true;
977 }
978
979 if (option == CompileCommandEnum::Option) {
980 // Look for trailing options.
981 //
982 // Two types of trailing options are
983 // supported:
984 //
985 // (1) CompileCommand=option,Klass::method,option
986 // (2) CompileCommand=option,Klass::method,type,option,value
987 //
988 // Type (1) is used to enable a boolean option for a method.
989 //
990 // Type (2) is used to support options with a value. Values can have the
991 // the following types: intx, uintx, bool, ccstr, ccstrlist, and double.
992
993 char option_type[256]; // stores option for Type (1) and type of Type (2)
994 skip_comma(line);
995 TypedMethodOptionMatcher* archetype = TypedMethodOptionMatcher::parse_method_pattern(line, error_buf, sizeof(error_buf));
996 if (archetype == nullptr) {
997 print_parse_error(error_buf, original.get());
998 return false;
999 }
1000
1001 skip_whitespace(line);
1002
1003 // This is unnecessarily complex. Should retire multi-option lines and skip while loop
1004 while (sscanf(line, "%255[a-zA-Z0-9]%n", option_type, &bytes_read) == 1) {
1005 line += bytes_read;
1006
1007 // typed_matcher is used as a blueprint for each option, deleted at the end
1008 TypedMethodOptionMatcher* typed_matcher = archetype->clone();
1009 enum OptionType type = parse_option_type(option_type);
1010 if (type != OptionType::Unknown) {
1011 // Type (2) option: parse option name and value.
1012 if (!scan_option_and_value(type, line, bytes_read, typed_matcher, error_buf, sizeof(error_buf))) {
1013 print_parse_error(error_buf, original.get());
1014 return false;
1015 }
1016 line += bytes_read;
1017 } else {
1018 // Type (1) option - option_type contains the option name -> bool value = true is implied
1019 int bytes_read;
1020 CompileCommandEnum option = match_option_name(option_type, &bytes_read, error_buf, sizeof(error_buf));
1021 if (option == CompileCommandEnum::Unknown) {
1022 print_parse_error(error_buf, original.get());
1023 return false;
1024 }
1025 if (option2type(option) == OptionType::Bool) {
1026 if (!register_command(typed_matcher, option, error_buf, sizeof(error_buf), true)) {
1027 print_parse_error(error_buf, original.get());
1028 return false;
1029 }
1030 } else {
1031 jio_snprintf(error_buf, sizeof(error_buf), " Missing type '%s' before option '%s'",
1032 optiontype2name(option2type(option)), option2name(option));
1033 print_parse_error(error_buf, original.get());
1034 return false;
1035 }
1036 }
1037 assert(typed_matcher != nullptr, "sanity");
1038 assert(*error_buf == '\0', "No error here");
1039 skip_whitespace(line);
1040 } // while(
1041 delete archetype;
1042 } else { // not an OptionCommand
1043 // Command has the following form:
1044 // CompileCommand=<option>,<method pattern><value>
1045 // CompileCommand=<option>,<method pattern> (implies option is bool and value is true)
1046 assert(*error_buf == '\0', "Don't call here with error_buf already set");
1047 enum OptionType type = option2type(option);
1048 int bytes_read = 0;
1049 skip_comma(line);
1050 TypedMethodOptionMatcher* matcher = TypedMethodOptionMatcher::parse_method_pattern(line, error_buf, sizeof(error_buf));
1051 if (matcher == nullptr) {
1052 print_parse_error(error_buf, original.get());
1053 return false;
1054 }
1055 skip_whitespace(line);
1056 if (*line == '\0') {
1057 if (option2type(option) == OptionType::Bool) {
1058 // if this is a bool option this implies true
1059 if (!register_command(matcher, option, error_buf, sizeof(error_buf), true)) {
1060 print_parse_error(error_buf, original.get());
1061 return false;
1062 }
1063 return true;
1064 } else if (option == CompileCommandEnum::MemStat) {
1065 // MemStat default action is to collect data but to not print
1066 if (!register_command(matcher, option, error_buf, sizeof(error_buf), (uintx)MemStatAction::collect)) {
1067 print_parse_error(error_buf, original.get());
1068 return false;
1069 }
1070 return true;
1071 } else {
1072 jio_snprintf(error_buf, sizeof(error_buf), " Option '%s' is not followed by a value", option2name(option));
1073 print_parse_error(error_buf, original.get());
1074 return false;
1075 }
1076 }
1077 if (!scan_value(type, line, bytes_read, matcher, option, error_buf, sizeof(error_buf))) {
1078 print_parse_error(error_buf, original.get());
1079 return false;
1080 }
1081 assert(matcher != nullptr, "consistency");
1082 }
1083 return true;
1084 }
1085
1086 static const char* default_cc_file = ".hotspot_compiler";
1087
1088 static const char* cc_file() {
1089 #ifdef ASSERT
1090 if (CompileCommandFile == nullptr)
1091 return default_cc_file;
1092 #endif
1093 return CompileCommandFile;
1094 }
1095
1096 bool CompilerOracle::has_command_file() {
1097 return cc_file() != nullptr;
1098 }
1099
1100 bool CompilerOracle::_quiet = false;
1101
1102 bool CompilerOracle::parse_from_file() {
1103 assert(has_command_file(), "command file must be specified");
1104 FILE* stream = os::fopen(cc_file(), "rt");
1105 if (stream == nullptr) {
1106 return true;
1107 }
1108
1109 FileInput input(stream, /*need_close=*/ true);
1110 return parse_from_input(&input, parse_from_line);
1111 }
1112
1113 bool CompilerOracle::parse_from_input(inputStream::Input* input,
1114 CompilerOracle::
1115 parse_from_line_fn_t* parse_from_line) {
1116 bool success = true;
1117 for (inputStream in(input); !in.done(); in.next()) {
1118 if (!parse_from_line(in.current_line())) {
1119 success = false;
1120 }
1121 }
1122 return success;
1123 }
1124
1125 bool CompilerOracle::parse_from_string(const char* str,
1126 CompilerOracle::
1127 parse_from_line_fn_t* parse_from_line) {
1128 MemoryInput input(str, strlen(str));
1129 return parse_from_input(&input, parse_from_line);
1130 }
1131
1132 bool compilerOracle_init() {
1133 bool success = true;
1134 // Register default compile commands first - any commands specified via CompileCommand will
1135 // supersede these default commands.
1136 for (int i = 0; default_compile_commands[i] != nullptr; i ++) {
1137 char* s = os::strdup(default_compile_commands[i]);
1138 success = CompilerOracle::parse_from_line_quietly(s);
1139 os::free(s);
1140 assert(success, "default compile command \"%s\" failed to parse", default_compile_commands[i]);
1141 }
1142 if (!CompilerOracle::parse_from_string(CompileCommand, CompilerOracle::parse_from_line)) {
1143 success = false;
1144 }
1145 if (!CompilerOracle::parse_from_string(CompileOnly, CompilerOracle::parse_compile_only)) {
1146 success = false;
1147 }
1148 if (CompilerOracle::has_command_file()) {
1149 if (!CompilerOracle::parse_from_file()) {
1150 success = false;
1151 }
1152 } else {
1153 struct stat buf;
1154 if (os::stat(default_cc_file, &buf) == 0) {
1155 warning("%s file is present but has been ignored. "
1156 "Run with -XX:CompileCommandFile=%s to load the file.",
1157 default_cc_file, default_cc_file);
1158 }
1159 }
1160 if (has_command(CompileCommandEnum::Print)) {
1161 if (PrintAssembly) {
1162 warning("CompileCommand and/or %s file contains 'print' commands, but PrintAssembly is also enabled", default_cc_file);
1163 }
1164 }
1165 return success;
1166 }
1167
1168 bool CompilerOracle::parse_compile_only(char* line) {
1169 if (line[0] == '\0') {
1170 return true;
1171 }
1172 ResourceMark rm;
1173 char error_buf[1024] = {0};
1174 LineCopy original(line);
1175 char* method_pattern;
1176 do {
1177 if (line[0] == '\0') {
1178 break;
1179 }
1180 method_pattern = strtok_r(line, ",", &line);
1181 if (method_pattern != nullptr) {
1182 TypedMethodOptionMatcher* matcher = TypedMethodOptionMatcher::parse_method_pattern(method_pattern, error_buf, sizeof(error_buf));
1183 if (matcher != nullptr) {
1184 if (register_command(matcher, CompileCommandEnum::CompileOnly, error_buf, sizeof(error_buf), true)) {
1185 continue;
1186 }
1187 }
1188 }
1189 ttyLocker ttyl;
1190 tty->print_cr("CompileOnly: An error occurred during parsing");
1191 if (*error_buf != '\0') {
1192 tty->print_cr("Error: %s", error_buf);
1193 }
1194 tty->print_cr("Line: '%s'", original.get());
1195 return false;
1196 } while (method_pattern != nullptr && line != nullptr);
1197 return true;
1198 }
1199
1200 CompileCommandEnum CompilerOracle::string_to_option(const char* name) {
1201 int bytes_read = 0;
1202 char errorbuf[1024] = {0};
1203 return match_option_name(name, &bytes_read, errorbuf, sizeof(errorbuf));
1204 }