1 /*
2 * Copyright (c) 1998, 2024, 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 #ifndef SHARE_COMPILER_COMPILERORACLE_HPP
26 #define SHARE_COMPILER_COMPILERORACLE_HPP
27
28 #include "memory/allStatic.hpp"
29 #include "oops/oopsHierarchy.hpp"
30 #include "utilities/istream.hpp"
31
32 class methodHandle;
33
34
35 // CompilerOracle is an interface for turning on and off compilation
36 // for some methods
37
38 // OPTION_TYPES: type, name
39 #define OPTION_TYPES(type) \
40 type(Intx, "intx") \
41 type(Uintx, "uintx") \
42 type(Bool, "bool") \
43 type(Ccstr, "ccstr") \
44 type(Ccstrlist, "ccstrlist") \
45 type(Double, "double")
46
47 // COMPILECOMMAND_OPTIONS: option, name, variant, type
48 #define COMPILECOMMAND_OPTIONS(option) \
49 option(Help, "help", Unknown) \
50 option(Quiet, "quiet", Unknown) \
51 option(Log, "log", Bool) \
52 option(Print, "print", Bool) \
53 option(Inline, "inline", Bool) \
54 option(DontInline, "dontinline", Bool) \
55 option(Blackhole, "blackhole", Bool) \
56 option(CompileOnly, "compileonly", Bool)\
57 option(Exclude, "exclude", Bool) \
58 option(Break, "break", Bool) \
59 option(BreakAtExecute, "BreakAtExecute", Bool) \
60 option(BreakAtCompile, "BreakAtCompile", Bool) \
61 option(MemLimit, "MemLimit", Intx) \
62 option(MemStat, "MemStat", Uintx) \
63 option(PrintAssembly, "PrintAssembly", Bool) \
64 option(PrintCompilation, "PrintCompilation", Bool) \
65 option(PrintInlining, "PrintInlining", Bool) \
66 option(PrintIntrinsics, "PrintIntrinsics", Bool) \
67 option(PrintNMethods, "PrintNMethods", Bool) \
68 option(PrintOptoAssembly, "PrintOptoAssembly", Bool) \
69 option(PrintDebugInfo, "PrintDebugInfo", Bool) \
70 option(PrintRelocations, "PrintRelocations", Bool) \
71 option(PrintDependencies, "PrintDependencies", Bool) \
72 option(BackgroundCompilation, "BackgroundCompilation", Bool) \
73 option(RepeatCompilation, "RepeatCompilation", Intx) \
74 option(ReplayInline, "ReplayInline", Bool) \
75 option(DumpReplay, "DumpReplay", Bool) \
76 option(DumpInline, "DumpInline", Bool) \
77 option(CompileThresholdScaling, "CompileThresholdScaling", Double) \
78 option(ControlIntrinsic, "ControlIntrinsic", Ccstrlist) \
79 option(DisableIntrinsic, "DisableIntrinsic", Ccstrlist) \
80 option(NoRTMLockEliding, "NoRTMLockEliding", Bool) \
81 option(UseRTMLockEliding, "UseRTMLockEliding", Bool) \
82 option(BlockLayoutByFrequency, "BlockLayoutByFrequency", Bool) \
83 option(TraceOptoPipelining, "TraceOptoPipelining", Bool) \
84 option(TraceOptoOutput, "TraceOptoOutput", Bool) \
85 option(TraceSpilling, "TraceSpilling", Bool) \
86 NOT_PRODUCT(option(TraceEscapeAnalysis, "TraceEscapeAnalysis", Bool)) \
87 NOT_PRODUCT(option(PrintIdeal, "PrintIdeal", Bool)) \
88 NOT_PRODUCT(option(PrintIdealPhase, "PrintIdealPhase", Ccstrlist)) \
89 NOT_PRODUCT(option(IGVPrintLevel, "IGVPrintLevel", Intx)) \
90 NOT_PRODUCT(option(TraceAutoVectorization, "TraceAutoVectorization", Ccstrlist)) \
91 option(Vectorize, "Vectorize", Bool) \
92 option(CloneMapDebug, "CloneMapDebug", Bool) \
93 option(IncrementalInlineForceCleanup, "IncrementalInlineForceCleanup", Bool) \
94 option(MaxNodeLimit, "MaxNodeLimit", Intx) \
95 NOT_PRODUCT(option(TestOptionInt, "TestOptionInt", Intx)) \
96 NOT_PRODUCT(option(TestOptionUint, "TestOptionUint", Uintx)) \
97 NOT_PRODUCT(option(TestOptionBool, "TestOptionBool", Bool)) \
98 NOT_PRODUCT(option(TestOptionBool2, "TestOptionBool2", Bool)) \
99 NOT_PRODUCT(option(TestOptionStr, "TestOptionStr", Ccstr)) \
100 NOT_PRODUCT(option(TestOptionList, "TestOptionList", Ccstrlist)) \
101 NOT_PRODUCT(option(TestOptionDouble, "TestOptionDouble", Double)) \
102 option(Option, "option", Unknown) \
103 option(Unknown, "unknown", Unknown)
104
105 enum class CompileCommandEnum : int {
106 #define enum_of_options(option, name, ctype) option,
107 COMPILECOMMAND_OPTIONS(enum_of_options)
108 #undef enum_of_options
109 Count
110 };
111
112 enum class OptionType {
113 #define enum_of_types(type, name) type,
114 OPTION_TYPES(enum_of_types)
115 #undef enum_of_types
116 Unknown
117 };
118
119 enum class MemStatAction {
120 collect = 1, print = 2
121 };
122
123 class CompilerOracle : AllStatic {
124 public:
125 typedef bool parse_from_line_fn_t(char*);
126
127 private:
128 static bool _quiet;
129 static void print_parse_error(char* error_msg, char* original_line);
130 static void print_command(CompileCommandEnum option, const char* name, enum OptionType type);
131
132 // The core parser.
133 static bool parse_from_input(inputStream::Input* input,
134 parse_from_line_fn_t* parse_from_line);
135
136 public:
137 // True if the command file has been specified or is implicit
138 static bool has_command_file();
139
140 // Reads from file and adds to lists
141 static bool parse_from_file();
142
143 // Tells whether we to exclude compilation of method
144 static bool should_exclude(const methodHandle& method);
145 static bool be_quiet() { return _quiet; }
146
147 // Tells whether we want to inline this method
148 static bool should_inline(const methodHandle& method);
149
150 // Tells whether we want to disallow inlining of this method
151 static bool should_not_inline(const methodHandle& method);
152
153 // Tells whether this method changes Thread.currentThread()
154 static bool changes_current_thread(const methodHandle& method);
155
156 // Tells whether we should print the assembly for this method
157 static bool should_print(const methodHandle& method);
158
159 // Tells whether we should log the compilation data for this method
160 static bool should_log(const methodHandle& method);
161
162 // Tells whether to break when compiling method
163 static bool should_break_at(const methodHandle& method);
164
165 // Tells whether there are any methods to print for print_method_statistics()
166 static bool should_print_methods();
167
168 // Tells whether there are any methods to (collect|collect+print) memory statistics for
169 static bool should_collect_memstat();
170 static bool should_print_final_memstat_report();
171
172 // Tags the method as blackhole candidate, if possible.
173 static void tag_blackhole_if_possible(const methodHandle& method);
174
175 // A wrapper for checking bool options
176 static bool has_option(const methodHandle& method, CompileCommandEnum option);
177
178 // Check if method has option and value set. If yes, overwrite value and return true,
179 // otherwise leave value unchanged and return false.
180 template<typename T>
181 static bool has_option_value(const methodHandle& method, CompileCommandEnum option, T& value);
182
183 // This check is currently only needed by whitebox API
184 template<typename T>
185 static bool option_matches_type(CompileCommandEnum option, T& value);
186
187 // Reads from string instead of file
188 static bool parse_from_string(const char* option_string,
189 parse_from_line_fn_t* parser);
190 static bool parse_from_line(char* line);
191 static bool parse_from_line_quietly(char* line);
192 static bool parse_compile_only(char* line);
193
194 // Fast check if there is any option set that compile control needs to know about
195 static bool has_any_command_set();
196
197 // convert a string to a proper compilecommand option - used from whitebox.
198 // returns CompileCommandEnum::Unknown on names not matching an option.
199 static CompileCommandEnum string_to_option(const char* name);
200
201 // convert a string to a proper compilecommand option
202 // returns CompileCommandEnum::Unknown if name is not an option.
203 static CompileCommandEnum parse_option_name(const char* name);
204
205 // convert a string to a proper option type
206 // returns OptionType::Unknown on strings not matching an option type.
207 static enum OptionType parse_option_type(const char* type_str);
208 };
209
210 #endif // SHARE_COMPILER_COMPILERORACLE_HPP