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_delay_inline(const methodHandle& method) {
484 return (check_predicate(CompileCommandEnum::DelayInline, method));
485 }
486
487 bool CompilerOracle::should_print(const methodHandle& method) {
488 return check_predicate(CompileCommandEnum::Print, method);
489 }
490
491 bool CompilerOracle::should_print_methods() {
492 return has_command(CompileCommandEnum::Print);
493 }
494
495 // Tells whether there are any methods to collect memory statistics for
496 bool CompilerOracle::should_collect_memstat() {
497 return has_command(CompileCommandEnum::MemStat) || has_command(CompileCommandEnum::MemLimit);
498 }
499
500 bool CompilerOracle::should_log(const methodHandle& method) {
501 if (!LogCompilation) return false;
502 if (!has_command(CompileCommandEnum::Log)) {
503 return true; // by default, log all
504 }
505 return (check_predicate(CompileCommandEnum::Log, method));
506 }
507
508 bool CompilerOracle::should_break_at(const methodHandle& method) {
509 return check_predicate(CompileCommandEnum::Break, method);
510 }
511
512 void CompilerOracle::tag_blackhole_if_possible(const methodHandle& method) {
513 if (!check_predicate(CompileCommandEnum::Blackhole, method)) {
514 return;
515 }
516 guarantee(UnlockExperimentalVMOptions, "Checked during initial parsing");
517 if (method->result_type() != T_VOID) {
518 warning("Blackhole compile option only works for methods with void type: %s",
519 method->name_and_sig_as_C_string());
520 return;
521 }
522 if (!method->is_empty_method()) {
523 warning("Blackhole compile option only works for empty methods: %s",
524 method->name_and_sig_as_C_string());
525 return;
526 }
527 if (!method->is_static()) {
528 warning("Blackhole compile option only works for static methods: %s",
529 method->name_and_sig_as_C_string());
530 return;
531 }
532 if (method->intrinsic_id() == vmIntrinsics::_blackhole) {
533 return;
534 }
535 if (method->intrinsic_id() != vmIntrinsics::_none) {
536 warning("Blackhole compile option only works for methods that do not have intrinsic set: %s, %s",
537 method->name_and_sig_as_C_string(), vmIntrinsics::name_at(method->intrinsic_id()));
538 return;
539 }
540 method->set_intrinsic_id(vmIntrinsics::_blackhole);
541 }
542
543 static CompileCommandEnum match_option_name(const char* line, int* bytes_read, char* errorbuf, int bufsize) {
544 assert(ARRAY_SIZE(option_names) == static_cast<int>(CompileCommandEnum::Count), "option_names size mismatch");
545
546 *bytes_read = 0;
547 char option_buf[256];
548 int matches = sscanf(line, "%255[a-zA-Z0-9]%n", option_buf, bytes_read);
549 if (matches > 0 && strcasecmp(option_buf, "unknown") != 0) {
550 for (uint i = 0; i < ARRAY_SIZE(option_names); i++) {
551 if (strcasecmp(option_buf, option_names[i]) == 0) {
552 return static_cast<CompileCommandEnum>(i);
553 }
554 }
555 }
556 jio_snprintf(errorbuf, bufsize, "Unrecognized option '%s'", option_buf);
557 return CompileCommandEnum::Unknown;
558 }
559
560 // match exactly and don't mess with errorbuf
561 CompileCommandEnum CompilerOracle::parse_option_name(const char* line) {
562 for (uint i = 0; i < ARRAY_SIZE(option_names); i++) {
563 if (strcasecmp(line, option_names[i]) == 0) {
564 return static_cast<CompileCommandEnum>(i);
565 }
566 }
567 return CompileCommandEnum::Unknown;
568 }
569
570 enum OptionType CompilerOracle::parse_option_type(const char* type_str) {
571 for (uint i = 0; i < ARRAY_SIZE(optiontype_names); i++) {
572 if (strcasecmp(type_str, optiontype_names[i]) == 0) {
573 return static_cast<enum OptionType>(i);
574 }
575 }
576 return OptionType::Unknown;
577 }
578
579 static void print_tip() { // CMH Update info
580 tty->cr();
581 tty->print_cr("Usage: '-XX:CompileCommand=<option>,<method pattern>' - to set boolean option to true");
582 tty->print_cr("Usage: '-XX:CompileCommand=<option>,<method pattern>,<value>'");
583 tty->print_cr("Use: '-XX:CompileCommand=help' for more information and to list all option.");
584 tty->cr();
585 }
586
587 static void print_option(CompileCommandEnum option, const char* name, enum OptionType type) {
588 if (type != OptionType::Unknown) {
589 tty->print_cr(" %s (%s)", name, optiontype2name(type));
590 }
591 }
592
593 static void print_commands() {
594 tty->cr();
595 tty->print_cr("All available options:");
596 #define enum_of_options(option, name, ctype) print_option(CompileCommandEnum::option, name, OptionType::ctype);
597 COMPILECOMMAND_OPTIONS(enum_of_options)
598 #undef enum_of_options
599 tty->cr();
600 }
601
602 static void usage() {
603 tty->cr();
604 tty->print_cr("The CompileCommand option enables the user of the JVM to control specific");
605 tty->print_cr("behavior of the dynamic compilers.");
606 tty->cr();
607 tty->print_cr("Compile commands has this general form:");
608 tty->print_cr("-XX:CompileCommand=<option><method pattern><value>");
609 tty->print_cr(" Sets <option> to the specified value for methods matching <method pattern>");
610 tty->print_cr(" All options are typed");
611 tty->cr();
612 tty->print_cr("-XX:CompileCommand=<option><method pattern>");
613 tty->print_cr(" Sets <option> to true for methods matching <method pattern>");
614 tty->print_cr(" Only applies to boolean options.");
615 tty->cr();
616 tty->print_cr("-XX:CompileCommand=quiet");
617 tty->print_cr(" Silence the compile command output");
618 tty->cr();
619 tty->print_cr("-XX:CompileCommand=help");
620 tty->print_cr(" Prints this help text");
621 tty->cr();
622 print_commands();
623 tty->cr();
624 tty->print_cr("The <method pattern> has the format '<class>.<method><descriptor>'.");
625 tty->cr();
626 tty->print_cr("For example, the <method pattern>");
627 tty->cr();
628 tty->print_cr(" package/Class.method(Lpackage/Parameter;)Lpackage/Return;");
629 tty->cr();
630 tty->print_cr("matches the <method> 'method' in <class> 'package/Class' with <descriptor>");
631 tty->print_cr("'(Lpackage/Parameter;)Lpackage/Return;'");
632 tty->cr();
633 tty->print_cr("For backward compatibility this form is also allowed:");
634 tty->cr();
635 tty->print_cr(" package.Class::method(Lpackage.Parameter;)Lpackage.Return;");
636 tty->cr();
637 tty->print_cr("A whitespace or comma can optionally separate the <descriptor> from the");
638 tty->print_cr("<method>:");
639 tty->cr();
640 tty->print_cr(" package/Class.method (Lpackage/Parameter;)Lpackage/Return;");
641 tty->print_cr(" package/Class.method,(Lpackage/Parameter;)Lpackage/Return;");
642 tty->cr();
643 tty->print_cr("The <class> and <method> accept leading and trailing '*' wildcards");
644 tty->print_cr("matching:");
645 tty->cr();
646 tty->print_cr(" *ackage/Clas*.*etho*(Lpackage/Parameter;)Lpackage/Return;");
647 tty->cr();
648 tty->print_cr("The <descriptor> does not support explicit wildcards and");
649 tty->print_cr("always has an implicit trailing wildcard. Therefore,");
650 tty->cr();
651 tty->print_cr(" package/Class.method(Lpackage/Parameter;)Lpackage/Return;");
652 tty->cr();
653 tty->print_cr("matches a subset of");
654 tty->cr();
655 tty->print_cr(" package/Class.method(Lpackage/Parameter;)");
656 tty->cr();
657 tty->print_cr("which matches a subset of");
658 tty->cr();
659 tty->print_cr(" package/Class.method");
660 tty->cr();
661 tty->print_cr("which matches all possible descriptors.");
662 tty->cr();
663 tty->print_cr("It is possible to use more than one CompileCommand on the command line:");
664 tty->print_cr(" -XX:CompileCommand=exclude,java/*.* -XX:CompileCommand=log,java*.*");
665 tty->cr();
666 tty->print_cr("The CompileCommands can be loaded from a file with the flag");
667 tty->print_cr("-XX:CompileCommandFile=<file> or be added to the file '.hotspot_compiler'");
668 tty->print_cr("Use the same format in the file as the argument to the CompileCommand flag.");
669 tty->print_cr("Add one command on each line.");
670 tty->print_cr(" exclude java/*.*");
671 tty->print_cr(" option java/*.* ReplayInline");
672 tty->cr();
673 tty->print_cr("The following commands have conflicting behavior: 'exclude', 'inline', 'dontinline',");
674 tty->print_cr("and 'compileonly'. There is no priority of commands. Applying (a subset of) these");
675 tty->print_cr("commands to the same method results in undefined behavior.");
676 tty->cr();
677 tty->print_cr("The 'exclude' command excludes methods from top-level compilations as well as");
678 tty->print_cr("from inlining, whereas the 'compileonly' command only excludes methods from");
679 tty->print_cr("top-level compilations (i.e. they can still be inlined into other compilation units).");
680 tty->cr();
681 };
682
683 static int skip_whitespace(char* &line) {
684 // Skip any leading spaces
685 int whitespace_read = 0;
686 sscanf(line, "%*[ \t]%n", &whitespace_read);
687 line += whitespace_read;
688 return whitespace_read;
689 }
690
691 static void skip_comma(char* &line) {
692 // Skip any leading spaces
693 if (*line == ',') {
694 line++;
695 }
696 }
697
698 static bool parseMemLimit(const char* line, intx& value, int& bytes_read, char* errorbuf, const int buf_size) {
699 // Format:
700 // "<memory size>['~' <suboption>]"
701 // <memory size> can have units, e.g. M
702 // <suboption> one of "crash" "stop", if omitted, "stop" is implied.
703 //
704 // Examples:
705 // -XX:CompileCommand='memlimit,*.*,20m'
706 // -XX:CompileCommand='memlimit,*.*,20m~stop'
707 // -XX:CompileCommand='memlimit,Option::toString,1m~crash'
708 //
709 // The resulting intx carries the size and whether we are to stop or crash:
710 // - neg. value means crash
711 // - pos. value (default) means stop
712 size_t s = 0;
713 char* end;
714 if (!parse_integer<size_t>(line, &end, &s)) {
715 jio_snprintf(errorbuf, buf_size, "MemLimit: invalid value");
716 return false;
717 }
718 bytes_read = (int)(end - line);
719
720 intx v = (intx)s;
721 if ((*end) != '\0') {
722 if (strncasecmp(end, "~crash", 6) == 0) {
723 v = -v;
724 bytes_read += 6;
725 } else if (strncasecmp(end, "~stop", 5) == 0) {
726 // ok, this is the default
727 bytes_read += 5;
728 } else {
729 jio_snprintf(errorbuf, buf_size, "MemLimit: invalid option");
730 return false;
731 }
732 }
733 value = v;
734 return true;
735 }
736
737 static bool parseMemStat(const char* line, uintx& value, int& bytes_read, char* errorbuf, const int buf_size) {
738
739 #define IF_ENUM_STRING(S, CMD) \
740 if (strncasecmp(line, S, strlen(S)) == 0) { \
741 bytes_read += (int)strlen(S); \
742 CMD \
743 return true; \
744 }
745
746 IF_ENUM_STRING("collect", {
747 value = (uintx)MemStatAction::collect;
748 });
749 IF_ENUM_STRING("print", {
750 value = (uintx)MemStatAction::print;
751 });
752 #undef IF_ENUM_STRING
753
754 jio_snprintf(errorbuf, buf_size, "MemStat: invalid option");
755
756 return false;
757 }
758
759 static bool scan_value(enum OptionType type, char* line, int& total_bytes_read,
760 TypedMethodOptionMatcher* matcher, CompileCommandEnum option, char* errorbuf, const int buf_size) {
761 int bytes_read = 0;
762 const char* ccname = option2name(option);
763 const char* type_str = optiontype2name(type);
764 int skipped = skip_whitespace(line);
765 total_bytes_read += skipped;
766 if (type == OptionType::Intx) {
767 intx value;
768 bool success = false;
769 if (option == CompileCommandEnum::MemLimit) {
770 // Special parsing for MemLimit
771 success = parseMemLimit(line, value, bytes_read, errorbuf, buf_size);
772 } else {
773 // Is it a raw number?
774 success = sscanf(line, "%zd%n", &value, &bytes_read) == 1;
775 }
776 if (success) {
777 total_bytes_read += bytes_read;
778 return register_command(matcher, option, errorbuf, buf_size, value);
779 } else {
780 jio_snprintf(errorbuf, buf_size, "Value cannot be read for option '%s' of type '%s'", ccname, type_str);
781 return false;
782 }
783 } else if (type == OptionType::Uintx) {
784 uintx value;
785 bool success = false;
786 if (option == CompileCommandEnum::MemStat) {
787 // Special parsing for MemStat
788 success = parseMemStat(line, value, bytes_read, errorbuf, buf_size);
789 } else {
790 // parse as raw number
791 success = sscanf(line, "%zu%n", &value, &bytes_read) == 1;
792 }
793 if (success) {
794 total_bytes_read += bytes_read;
795 return register_command(matcher, option, errorbuf, buf_size, value);
796 } else {
797 jio_snprintf(errorbuf, buf_size, "Value cannot be read for option '%s' of type '%s'", ccname, type_str);
798 return false;
799 }
800 } else if (type == OptionType::Ccstr) {
801 ResourceMark rm;
802 char* value = NEW_RESOURCE_ARRAY(char, strlen(line) + 1);
803 if (sscanf(line, "%255[_a-zA-Z0-9]%n", value, &bytes_read) == 1) {
804 total_bytes_read += bytes_read;
805 return register_command(matcher, option, errorbuf, buf_size, (ccstr) value);
806 } else {
807 jio_snprintf(errorbuf, buf_size, "Value cannot be read for option '%s' of type '%s'", ccname, type_str);
808 return false;
809 }
810 } else if (type == OptionType::Ccstrlist) {
811 // Accumulates several strings into one. The internal type is ccstr.
812 ResourceMark rm;
813 char* value = NEW_RESOURCE_ARRAY(char, strlen(line) + 1);
814 char* next_value = value;
815 if (sscanf(line, "%255[_a-zA-Z0-9+\\-]%n", next_value, &bytes_read) == 1) {
816 total_bytes_read += bytes_read;
817 line += bytes_read;
818 next_value += bytes_read + 1;
819 char* end_value = next_value - 1;
820 while (sscanf(line, "%*[ \t]%255[_a-zA-Z0-9+\\-]%n", next_value, &bytes_read) == 1) {
821 total_bytes_read += bytes_read;
822 line += bytes_read;
823 *end_value = ' '; // override '\0'
824 next_value += bytes_read;
825 end_value = next_value-1;
826 }
827
828 if (option == CompileCommandEnum::ControlIntrinsic || option == CompileCommandEnum::DisableIntrinsic) {
829 ControlIntrinsicValidator validator(value, (option == CompileCommandEnum::DisableIntrinsic));
830
831 if (!validator.is_valid()) {
832 jio_snprintf(errorbuf, buf_size, "Unrecognized intrinsic detected in %s: %s", option2name(option), validator.what());
833 return false;
834 }
835 }
836 #if !defined(PRODUCT) && defined(COMPILER2)
837 else if (option == CompileCommandEnum::TraceAutoVectorization) {
838 TraceAutoVectorizationTagValidator validator(value, true);
839
840 if (!validator.is_valid()) {
841 jio_snprintf(errorbuf, buf_size, "Unrecognized tag name in %s: %s", option2name(option), validator.what());
842 return false;
843 }
844 } else if (option == CompileCommandEnum::TraceMergeStores) {
845 TraceMergeStores::TagValidator validator(value, true);
846
847 if (!validator.is_valid()) {
848 jio_snprintf(errorbuf, buf_size, "Unrecognized tag name in %s: %s", option2name(option), validator.what());
849 return false;
850 }
851 } else if (option == CompileCommandEnum::PrintIdealPhase) {
852 PhaseNameValidator validator(value);
853
854 if (!validator.is_valid()) {
855 jio_snprintf(errorbuf, buf_size, "Unrecognized phase name in %s: %s", option2name(option), validator.what());
856 return false;
857 }
858 } else if (option == CompileCommandEnum::TestOptionList) {
859 // all values are ok
860 }
861 #endif
862 else {
863 assert(false, "Ccstrlist type option missing validator");
864 }
865
866 return register_command(matcher, option, errorbuf, buf_size, (ccstr) value);
867 } else {
868 jio_snprintf(errorbuf, buf_size, "Value cannot be read for option '%s' of type '%s'", ccname, type_str);
869 return false;
870 }
871 } else if (type == OptionType::Bool) {
872 char value[256];
873 if (*line == '\0') {
874 // Short version of a CompileCommand sets a boolean Option to true
875 // -XXCompileCommand=<Option>,<method pattern>
876 return register_command(matcher, option, errorbuf, buf_size,true);
877 }
878 if (sscanf(line, "%255[a-zA-Z]%n", value, &bytes_read) == 1) {
879 if (strcasecmp(value, "true") == 0) {
880 total_bytes_read += bytes_read;
881 return register_command(matcher, option, errorbuf, buf_size,true);
882 } else if (strcasecmp(value, "false") == 0) {
883 total_bytes_read += bytes_read;
884 return register_command(matcher, option, errorbuf, buf_size,false);
885 } else {
886 jio_snprintf(errorbuf, buf_size, "Value cannot be read for option '%s' of type '%s'", ccname, type_str);
887 return false;
888 }
889 } else {
890 jio_snprintf(errorbuf, buf_size, "Value cannot be read for option '%s' of type '%s'", ccname, type_str);
891 return false;
892 }
893 } else if (type == OptionType::Double) {
894 char buffer[2][256];
895 // Decimal separator '.' has been replaced with ' ' or '/' earlier,
896 // so read integer and fraction part of double value separately.
897 if (sscanf(line, "%255[0-9]%*[ /\t]%255[0-9]%n", buffer[0], buffer[1], &bytes_read) == 2) {
898 char value[512] = "";
899 jio_snprintf(value, sizeof(value), "%s.%s", buffer[0], buffer[1]);
900 total_bytes_read += bytes_read;
901 return register_command(matcher, option, errorbuf, buf_size, atof(value));
902 } else {
903 jio_snprintf(errorbuf, buf_size, "Value cannot be read for option '%s' of type '%s'", ccname, type_str);
904 return false;
905 }
906 } else {
907 jio_snprintf(errorbuf, buf_size, "Type '%s' not supported ", type_str);
908 return false;
909 }
910 }
911
912 // Scan next option and value in line, return MethodMatcher object on success, nullptr on failure.
913 // On failure, error_msg contains description for the first error.
914 // For future extensions: set error_msg on first error.
915 static bool scan_option_and_value(enum OptionType type, char* line, int& total_bytes_read,
916 TypedMethodOptionMatcher* matcher,
917 char* errorbuf, const int buf_size) {
918 total_bytes_read = 0;
919 int bytes_read = 0;
920 char option_buf[256];
921
922 // Read option name.
923 if (sscanf(line, "%*[ \t]%255[a-zA-Z0-9]%n", option_buf, &bytes_read) == 1) {
924 line += bytes_read;
925 total_bytes_read += bytes_read;
926 int bytes_read2 = 0;
927 total_bytes_read += skip_whitespace(line);
928 CompileCommandEnum option = match_option_name(option_buf, &bytes_read2, errorbuf, buf_size);
929 if (option == CompileCommandEnum::Unknown) {
930 assert(*errorbuf != '\0', "error must have been set");
931 return false;
932 }
933 enum OptionType optiontype = option2type(option);
934 if (option2type(option) != type) {
935 const char* optiontype_name = optiontype2name(optiontype);
936 const char* type_name = optiontype2name(type);
937 jio_snprintf(errorbuf, buf_size, "Option '%s' with type '%s' doesn't match supplied type '%s'", option_buf, optiontype_name, type_name);
938 return false;
939 }
940 return scan_value(type, line, total_bytes_read, matcher, option, errorbuf, buf_size);
941 } else {
942 const char* type_str = optiontype2name(type);
943 jio_snprintf(errorbuf, buf_size, "Option name for type '%s' should be alphanumeric ", type_str);
944 return false;
945 }
946 }
947
948 void CompilerOracle::print_parse_error(char* error_msg, char* original_line) {
949 assert(*error_msg != '\0', "Must have error_message");
950 ttyLocker ttyl;
951 tty->print_cr("CompileCommand: An error occurred during parsing");
952 tty->print_cr("Error: %s", error_msg);
953 tty->print_cr("Line: '%s'", original_line);
954 print_tip();
955 }
956
957 class LineCopy : StackObj {
958 const char* _copy;
959 public:
960 LineCopy(char* line) {
961 _copy = os::strdup(line, mtInternal);
962 }
963 ~LineCopy() {
964 os::free((void*)_copy);
965 }
966 char* get() {
967 return (char*)_copy;
968 }
969 };
970
971 bool CompilerOracle::parse_from_line_quietly(char* line) {
972 const bool quiet0 = _quiet;
973 _quiet = true;
974 const bool result = parse_from_line(line);
975 _quiet = quiet0;
976 return result;
977 }
978
979 bool CompilerOracle::parse_from_line(char* line) {
980 if ((line[0] == '\0') || (line[0] == '#')) {
981 return true;
982 }
983
984 LineCopy original(line);
985 int bytes_read;
986 char error_buf[1024] = {0};
987
988 CompileCommandEnum option = match_option_name(line, &bytes_read, error_buf, sizeof(error_buf));
989 line += bytes_read;
990 ResourceMark rm;
991
992 if (option == CompileCommandEnum::Unknown) {
993 print_parse_error(error_buf, original.get());
994 return false;
995 }
996
997 if (option == CompileCommandEnum::Quiet) {
998 _quiet = true;
999 return true;
1000 }
1001
1002 if (option == CompileCommandEnum::Help) {
1003 usage();
1004 return true;
1005 }
1006
1007 if (option == CompileCommandEnum::Option) {
1008 // Look for trailing options.
1009 //
1010 // Two types of trailing options are
1011 // supported:
1012 //
1013 // (1) CompileCommand=option,Klass::method,option
1014 // (2) CompileCommand=option,Klass::method,type,option,value
1015 //
1016 // Type (1) is used to enable a boolean option for a method.
1017 //
1018 // Type (2) is used to support options with a value. Values can have the
1019 // the following types: intx, uintx, bool, ccstr, ccstrlist, and double.
1020
1021 char option_type[256]; // stores option for Type (1) and type of Type (2)
1022 skip_comma(line);
1023 TypedMethodOptionMatcher* archetype = TypedMethodOptionMatcher::parse_method_pattern(line, error_buf, sizeof(error_buf));
1024 if (archetype == nullptr) {
1025 print_parse_error(error_buf, original.get());
1026 return false;
1027 }
1028
1029 skip_whitespace(line);
1030
1031 // This is unnecessarily complex. Should retire multi-option lines and skip while loop
1032 while (sscanf(line, "%255[a-zA-Z0-9]%n", option_type, &bytes_read) == 1) {
1033 line += bytes_read;
1034
1035 // typed_matcher is used as a blueprint for each option, deleted at the end
1036 TypedMethodOptionMatcher* typed_matcher = archetype->clone();
1037 enum OptionType type = parse_option_type(option_type);
1038 if (type != OptionType::Unknown) {
1039 // Type (2) option: parse option name and value.
1040 if (!scan_option_and_value(type, line, bytes_read, typed_matcher, error_buf, sizeof(error_buf))) {
1041 print_parse_error(error_buf, original.get());
1042 return false;
1043 }
1044 line += bytes_read;
1045 } else {
1046 // Type (1) option - option_type contains the option name -> bool value = true is implied
1047 int bytes_read;
1048 CompileCommandEnum option = match_option_name(option_type, &bytes_read, error_buf, sizeof(error_buf));
1049 if (option == CompileCommandEnum::Unknown) {
1050 print_parse_error(error_buf, original.get());
1051 return false;
1052 }
1053 if (option2type(option) == OptionType::Bool) {
1054 if (!register_command(typed_matcher, option, error_buf, sizeof(error_buf), true)) {
1055 print_parse_error(error_buf, original.get());
1056 return false;
1057 }
1058 } else {
1059 jio_snprintf(error_buf, sizeof(error_buf), " Missing type '%s' before option '%s'",
1060 optiontype2name(option2type(option)), option2name(option));
1061 print_parse_error(error_buf, original.get());
1062 return false;
1063 }
1064 }
1065 assert(typed_matcher != nullptr, "sanity");
1066 assert(*error_buf == '\0', "No error here");
1067 skip_whitespace(line);
1068 } // while(
1069 delete archetype;
1070 } else { // not an OptionCommand
1071 // Command has the following form:
1072 // CompileCommand=<option>,<method pattern><value>
1073 // CompileCommand=<option>,<method pattern> (implies option is bool and value is true)
1074 assert(*error_buf == '\0', "Don't call here with error_buf already set");
1075 enum OptionType type = option2type(option);
1076 int bytes_read = 0;
1077 skip_comma(line);
1078 TypedMethodOptionMatcher* matcher = TypedMethodOptionMatcher::parse_method_pattern(line, error_buf, sizeof(error_buf));
1079 if (matcher == nullptr) {
1080 print_parse_error(error_buf, original.get());
1081 return false;
1082 }
1083 skip_whitespace(line);
1084 if (*line == '\0') {
1085 if (option2type(option) == OptionType::Bool) {
1086 // if this is a bool option this implies true
1087 if (!register_command(matcher, option, error_buf, sizeof(error_buf), true)) {
1088 print_parse_error(error_buf, original.get());
1089 return false;
1090 }
1091 return true;
1092 } else if (option == CompileCommandEnum::MemStat) {
1093 // MemStat default action is to collect data but to not print
1094 if (!register_command(matcher, option, error_buf, sizeof(error_buf), (uintx)MemStatAction::collect)) {
1095 print_parse_error(error_buf, original.get());
1096 return false;
1097 }
1098 return true;
1099 } else {
1100 jio_snprintf(error_buf, sizeof(error_buf), " Option '%s' is not followed by a value", option2name(option));
1101 print_parse_error(error_buf, original.get());
1102 return false;
1103 }
1104 }
1105 if (!scan_value(type, line, bytes_read, matcher, option, error_buf, sizeof(error_buf))) {
1106 print_parse_error(error_buf, original.get());
1107 return false;
1108 }
1109 assert(matcher != nullptr, "consistency");
1110 }
1111 return true;
1112 }
1113
1114 static const char* default_cc_file = ".hotspot_compiler";
1115
1116 static const char* cc_file() {
1117 #ifdef ASSERT
1118 if (CompileCommandFile == nullptr)
1119 return default_cc_file;
1120 #endif
1121 return CompileCommandFile;
1122 }
1123
1124 bool CompilerOracle::has_command_file() {
1125 return cc_file() != nullptr;
1126 }
1127
1128 bool CompilerOracle::_quiet = false;
1129
1130 bool CompilerOracle::parse_from_file() {
1131 assert(has_command_file(), "command file must be specified");
1132 FILE* stream = os::fopen(cc_file(), "rt");
1133 if (stream == nullptr) {
1134 return true;
1135 }
1136
1137 FileInput input(stream, /*need_close=*/ true);
1138 return parse_from_input(&input, parse_from_line);
1139 }
1140
1141 bool CompilerOracle::parse_from_input(inputStream::Input* input,
1142 CompilerOracle::
1143 parse_from_line_fn_t* parse_from_line) {
1144 bool success = true;
1145 for (inputStream in(input); !in.done(); in.next()) {
1146 if (!parse_from_line(in.current_line())) {
1147 success = false;
1148 }
1149 }
1150 return success;
1151 }
1152
1153 bool CompilerOracle::parse_from_string(const char* str,
1154 CompilerOracle::
1155 parse_from_line_fn_t* parse_from_line) {
1156 MemoryInput input(str, strlen(str));
1157 return parse_from_input(&input, parse_from_line);
1158 }
1159
1160 bool compilerOracle_init() {
1161 bool success = true;
1162 // Register default compile commands first - any commands specified via CompileCommand will
1163 // supersede these default commands.
1164 for (int i = 0; default_compile_commands[i] != nullptr; i ++) {
1165 char* s = os::strdup(default_compile_commands[i]);
1166 success = CompilerOracle::parse_from_line_quietly(s);
1167 os::free(s);
1168 assert(success, "default compile command \"%s\" failed to parse", default_compile_commands[i]);
1169 }
1170 if (!CompilerOracle::parse_from_string(CompileCommand, CompilerOracle::parse_from_line)) {
1171 success = false;
1172 }
1173 if (!CompilerOracle::parse_from_string(CompileOnly, CompilerOracle::parse_compile_only)) {
1174 success = false;
1175 }
1176 if (CompilerOracle::has_command_file()) {
1177 if (!CompilerOracle::parse_from_file()) {
1178 success = false;
1179 }
1180 } else {
1181 struct stat buf;
1182 if (os::stat(default_cc_file, &buf) == 0) {
1183 warning("%s file is present but has been ignored. "
1184 "Run with -XX:CompileCommandFile=%s to load the file.",
1185 default_cc_file, default_cc_file);
1186 }
1187 }
1188 if (has_command(CompileCommandEnum::Print)) {
1189 if (PrintAssembly) {
1190 warning("CompileCommand and/or %s file contains 'print' commands, but PrintAssembly is also enabled", default_cc_file);
1191 }
1192 }
1193 return success;
1194 }
1195
1196 bool CompilerOracle::parse_compile_only(char* line) {
1197 if (line[0] == '\0') {
1198 return true;
1199 }
1200 ResourceMark rm;
1201 char error_buf[1024] = {0};
1202 LineCopy original(line);
1203 char* method_pattern;
1204 do {
1205 if (line[0] == '\0') {
1206 break;
1207 }
1208 method_pattern = strtok_r(line, ",", &line);
1209 if (method_pattern != nullptr) {
1210 TypedMethodOptionMatcher* matcher = TypedMethodOptionMatcher::parse_method_pattern(method_pattern, error_buf, sizeof(error_buf));
1211 if (matcher != nullptr) {
1212 if (register_command(matcher, CompileCommandEnum::CompileOnly, error_buf, sizeof(error_buf), true)) {
1213 continue;
1214 }
1215 }
1216 }
1217 ttyLocker ttyl;
1218 tty->print_cr("CompileOnly: An error occurred during parsing");
1219 if (*error_buf != '\0') {
1220 tty->print_cr("Error: %s", error_buf);
1221 }
1222 tty->print_cr("Line: '%s'", original.get());
1223 return false;
1224 } while (method_pattern != nullptr && line != nullptr);
1225 return true;
1226 }
1227
1228 CompileCommandEnum CompilerOracle::string_to_option(const char* name) {
1229 int bytes_read = 0;
1230 char errorbuf[1024] = {0};
1231 return match_option_name(name, &bytes_read, errorbuf, sizeof(errorbuf));
1232 }