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(BlockLayoutByFrequency, "BlockLayoutByFrequency", Bool) \
81 option(TraceOptoPipelining, "TraceOptoPipelining", Bool) \
82 option(TraceOptoOutput, "TraceOptoOutput", Bool) \
83 option(TraceSpilling, "TraceSpilling", Bool) \
84 NOT_PRODUCT(option(TraceEscapeAnalysis, "TraceEscapeAnalysis", Bool)) \
85 NOT_PRODUCT(option(PrintIdeal, "PrintIdeal", Bool)) \
86 NOT_PRODUCT(option(PrintIdealPhase, "PrintIdealPhase", Ccstrlist)) \
87 NOT_PRODUCT(option(IGVPrintLevel, "IGVPrintLevel", Intx)) \
88 NOT_PRODUCT(option(TraceAutoVectorization, "TraceAutoVectorization", Ccstrlist)) \
89 option(Vectorize, "Vectorize", Bool) \
90 option(CloneMapDebug, "CloneMapDebug", Bool) \
91 option(IncrementalInlineForceCleanup, "IncrementalInlineForceCleanup", Bool) \
92 option(MaxNodeLimit, "MaxNodeLimit", Intx) \
93 NOT_PRODUCT(option(TestOptionInt, "TestOptionInt", Intx)) \
94 NOT_PRODUCT(option(TestOptionUint, "TestOptionUint", Uintx)) \
95 NOT_PRODUCT(option(TestOptionBool, "TestOptionBool", Bool)) \
96 NOT_PRODUCT(option(TestOptionBool2, "TestOptionBool2", Bool)) \
97 NOT_PRODUCT(option(TestOptionStr, "TestOptionStr", Ccstr)) \
98 NOT_PRODUCT(option(TestOptionList, "TestOptionList", Ccstrlist)) \
99 NOT_PRODUCT(option(TestOptionDouble, "TestOptionDouble", Double)) \
100 option(Option, "option", Unknown) \
101 option(Unknown, "unknown", Unknown)
102
103 enum class CompileCommandEnum : int {
104 #define enum_of_options(option, name, ctype) option,
105 COMPILECOMMAND_OPTIONS(enum_of_options)
106 #undef enum_of_options
107 Count
108 };
109
110 enum class OptionType {
111 #define enum_of_types(type, name) type,
112 OPTION_TYPES(enum_of_types)
113 #undef enum_of_types
114 Unknown
115 };
116
117 enum class MemStatAction {
118 collect = 1, print = 2
119 };
120
121 class CompilerOracle : AllStatic {
122 public:
123 typedef bool parse_from_line_fn_t(char*);
124
125 private:
126 static bool _quiet;
127 static void print_parse_error(char* error_msg, char* original_line);
128 static void print_command(CompileCommandEnum option, const char* name, enum OptionType type);
129
130 // The core parser.
131 static bool parse_from_input(inputStream::Input* input,
132 parse_from_line_fn_t* parse_from_line);
133
134 public:
135 // True if the command file has been specified or is implicit
136 static bool has_command_file();
137
138 // Reads from file and adds to lists
139 static bool parse_from_file();
140
141 // Tells whether we to exclude compilation of method
142 static bool should_exclude(const methodHandle& method);
143 static bool be_quiet() { return _quiet; }
144
145 // Tells whether we want to inline this method
146 static bool should_inline(const methodHandle& method);
147
148 // Tells whether we want to disallow inlining of this method
149 static bool should_not_inline(const methodHandle& method);
150
151 // Tells whether this method changes Thread.currentThread()
152 static bool changes_current_thread(const methodHandle& method);
153
154 // Tells whether we should print the assembly for this method
155 static bool should_print(const methodHandle& method);
156
157 // Tells whether we should log the compilation data for this method
158 static bool should_log(const methodHandle& method);
159
160 // Tells whether to break when compiling method
161 static bool should_break_at(const methodHandle& method);
162
163 // Tells whether there are any methods to print for print_method_statistics()
164 static bool should_print_methods();
165
166 // Tells whether there are any methods to (collect|collect+print) memory statistics for
167 static bool should_collect_memstat();
168 static bool should_print_final_memstat_report();
169
170 // Tags the method as blackhole candidate, if possible.
171 static void tag_blackhole_if_possible(const methodHandle& method);
172
173 // A wrapper for checking bool options
174 static bool has_option(const methodHandle& method, CompileCommandEnum option);
175
176 // Check if method has option and value set. If yes, overwrite value and return true,
177 // otherwise leave value unchanged and return false.
178 template<typename T>
179 static bool has_option_value(const methodHandle& method, CompileCommandEnum option, T& value);
180
181 // This check is currently only needed by whitebox API
182 template<typename T>
183 static bool option_matches_type(CompileCommandEnum option, T& value);
184
185 // Reads from string instead of file
186 static bool parse_from_string(const char* option_string,
187 parse_from_line_fn_t* parser);
188 static bool parse_from_line(char* line);
189 static bool parse_from_line_quietly(char* line);
190 static bool parse_compile_only(char* line);
191
192 // Fast check if there is any option set that compile control needs to know about
193 static bool has_any_command_set();
194
195 // convert a string to a proper compilecommand option - used from whitebox.
196 // returns CompileCommandEnum::Unknown on names not matching an option.
197 static CompileCommandEnum string_to_option(const char* name);
198
199 // convert a string to a proper compilecommand option
200 // returns CompileCommandEnum::Unknown if name is not an option.
201 static CompileCommandEnum parse_option_name(const char* name);
202
203 // convert a string to a proper option type
204 // returns OptionType::Unknown on strings not matching an option type.
205 static enum OptionType parse_option_type(const char* type_str);
206 };
207
208 #endif // SHARE_COMPILER_COMPILERORACLE_HPP