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_COMPILERDIRECTIVES_HPP
26 #define SHARE_COMPILER_COMPILERDIRECTIVES_HPP
27
28 #include "classfile/vmIntrinsics.hpp"
29 #include "ci/ciMetadata.hpp"
30 #include "ci/ciMethod.hpp"
31 #include "compiler/compiler_globals.hpp"
32 #include "compiler/methodMatcher.hpp"
33 #include "opto/phasetype.hpp"
34 #include "utilities/bitMap.hpp"
35 #include "utilities/exceptions.hpp"
36 #include "utilities/tribool.hpp"
37
38 // Directives flag name, type, default value, compile command name
39 #define compilerdirectives_common_other_flags(cflags) \
40 cflags(Enable, bool, false, Unknown) \
41 cflags(Exclude, bool, false, Unknown) \
42 cflags(BreakAtExecute, bool, false, BreakAtExecute) \
43 cflags(BreakAtCompile, bool, false, BreakAtCompile) \
44 cflags(Log, bool, LogCompilation, Unknown) \
45 cflags(MemLimit, intx, 0, MemLimit) \
46 cflags(MemStat, uintx, 0, MemStat) \
47 cflags(PrintAssembly, bool, PrintAssembly, PrintAssembly) \
48 cflags(PrintCompilation, bool, PrintCompilation, PrintCompilation) \
49 cflags(PrintInlining, bool, PrintInlining, PrintInlining) \
50 cflags(PrintNMethods, bool, PrintNMethods, PrintNMethods) \
51 cflags(BackgroundCompilation, bool, BackgroundCompilation, BackgroundCompilation) \
52 cflags(ReplayInline, bool, false, ReplayInline) \
53 cflags(DumpReplay, bool, false, DumpReplay) \
54 cflags(DumpInline, bool, false, DumpInline) \
55 cflags(CompilerDirectivesIgnoreCompileCommands, bool, CompilerDirectivesIgnoreCompileCommands, Unknown) \
56 cflags(RepeatCompilation, intx, RepeatCompilation, RepeatCompilation) \
57 cflags(PrecompileRecorded, uintx, 0, PrecompileRecorded) \
58 cflags(DontPrecompile, bool, false, DontPrecompile) \
59 cflags(DontPreload, bool, false, DontPreload) \
60 cflags(IgnoreRecordedProfile, bool, false, IgnoreRecordedProfile) \
61 cflags(IgnorePrecompiled, bool, false, IgnorePrecompiled) \
62 cflags(TooManyTrapsAtBCI, ccstrlist, "", TooManyTrapsAtBCI)
63 #define compilerdirectives_common_string_flags(cflags) \
64 cflags(DisableIntrinsic, ccstrlist, DisableIntrinsic, DisableIntrinsic) \
65 cflags(ControlIntrinsic, ccstrlist, ControlIntrinsic, ControlIntrinsic)
66 #define compilerdirectives_common_flags(cflags) \
67 compilerdirectives_common_other_flags(cflags) \
68 compilerdirectives_common_string_flags(cflags)
69
70 #ifdef COMPILER1
71 #define compilerdirectives_c1_other_flags(cflags)
72 #define compilerdirectives_c1_string_flags(cflags)
73 #else
74 #define compilerdirectives_c1_other_flags(cflags)
75 #define compilerdirectives_c1_string_flags(cflags)
76 #endif
77
78 #define compilerdirectives_c1_flags(cflags) \
79 compilerdirectives_c1_other_flags(cflags) \
80 compilerdirectives_c1_string_flags(cflags)
81
82 #ifdef COMPILER2
83 #define compilerdirectives_c2_other_flags(cflags) \
84 cflags(BlockLayoutByFrequency, bool, BlockLayoutByFrequency, BlockLayoutByFrequency) \
85 cflags(PrintOptoAssembly, bool, PrintOptoAssembly, PrintOptoAssembly) \
86 cflags(PrintIntrinsics, bool, PrintIntrinsics, PrintIntrinsics) \
87 NOT_PRODUCT(cflags(TraceOptoPipelining, bool, TraceOptoPipelining, TraceOptoPipelining)) \
88 NOT_PRODUCT(cflags(TraceOptoOutput, bool, TraceOptoOutput, TraceOptoOutput)) \
89 NOT_PRODUCT(cflags(TraceEscapeAnalysis, bool, false, TraceEscapeAnalysis)) \
90 NOT_PRODUCT(cflags(PrintIdeal, bool, PrintIdeal, PrintIdeal)) \
91 cflags(TraceSpilling, bool, TraceSpilling, TraceSpilling) \
92 cflags(Vectorize, bool, false, Vectorize) \
93 cflags(CloneMapDebug, bool, false, CloneMapDebug) \
94 NOT_PRODUCT(cflags(IGVPrintLevel, intx, PrintIdealGraphLevel, IGVPrintLevel)) \
95 cflags(IncrementalInlineForceCleanup, bool, IncrementalInlineForceCleanup, IncrementalInlineForceCleanup) \
96 cflags(MaxNodeLimit, intx, MaxNodeLimit, MaxNodeLimit)
97 #define compilerdirectives_c2_string_flags(cflags) \
98 NOT_PRODUCT(cflags(TraceAutoVectorization, ccstrlist, "", TraceAutoVectorization)) \
99 NOT_PRODUCT(cflags(TraceMergeStores, ccstrlist, "", TraceMergeStores)) \
100 NOT_PRODUCT(cflags(PrintIdealPhase, ccstrlist, "", PrintIdealPhase))
101 #else
102 #define compilerdirectives_c2_other_flags(cflags)
103 #define compilerdirectives_c2_string_flags(cflags)
104 #endif
105
106 #define compilerdirectives_c2_flags(cflags) \
107 compilerdirectives_c2_other_flags(cflags) \
108 compilerdirectives_c2_string_flags(cflags)
109
110 class AbstractCompiler;
111 class CompilerDirectives;
112 class DirectiveSet;
113
114 class DirectivesStack : AllStatic {
115 private:
116 static CompilerDirectives* _top;
117 static CompilerDirectives* _bottom;
118 static int _depth;
119
120 static void pop_inner(); // no lock version of pop
121 public:
122 static void init();
123 static DirectiveSet* getMatchingDirective(const methodHandle& mh, AbstractCompiler* comp);
124 static DirectiveSet* getDefaultDirective(AbstractCompiler* comp);
125 static void push(CompilerDirectives* directive);
126 static void pop(int count);
127 static bool check_capacity(int request_size, outputStream* st);
128 static void clear();
129 static void print(outputStream* st);
130 static void release(DirectiveSet* set);
131 static void release(CompilerDirectives* dir);
132 };
133
134 class DirectiveSet : public CHeapObj<mtCompiler> {
135 private:
136 InlineMatcher* _inlinematchers;
137 CompilerDirectives* _directive;
138 TriBoolArray<(size_t)vmIntrinsics::number_of_intrinsics(), int> _intrinsic_control_words;
139 CHeapBitMap _ideal_phase_name_set;
140 CHeapBitMap _trace_auto_vectorization_tags;
141 CHeapBitMap _trace_merge_stores_tags;
142
143 public:
144 DirectiveSet(CompilerDirectives* directive);
145 ~DirectiveSet();
146 void init_control_intrinsic();
147 CompilerDirectives* directive();
148 bool parse_and_add_inline(char* str, const char*& error_msg);
149 void append_inline(InlineMatcher* m);
150 bool should_inline(ciMethod* inlinee);
151 bool should_not_inline(ciMethod* inlinee);
152 void print_inline(outputStream* st);
153 DirectiveSet* compilecommand_compatibility_init(const methodHandle& method);
154 bool is_exclusive_copy() { return _directive == nullptr; }
155 bool matches_inline(const methodHandle& method, int inline_action);
156 static DirectiveSet* clone(DirectiveSet const* src);
157 bool is_intrinsic_disabled(vmIntrinsicID id);
158 static ccstrlist canonicalize_control_intrinsic(ccstrlist option_value);
159 void finalize(outputStream* st);
160 bool is_c1(CompilerDirectives* directive) const;
161 bool is_c2(CompilerDirectives* directive) const;
162 bool should_collect_memstat() const;
163 bool should_print_memstat() const;
164 size_t mem_limit() const;
165 bool should_crash_at_mem_limit() const; // true: crash false: stop compilation
166
167 typedef enum {
168 #define enum_of_flags(name, type, dvalue, cc_flag) name##Index,
169 compilerdirectives_common_flags(enum_of_flags)
170 compilerdirectives_c2_flags(enum_of_flags)
171 compilerdirectives_c1_flags(enum_of_flags)
172 #undef enum_of_flags
173 number_of_flags
174 } flags;
175
176 private:
177 bool _modified[number_of_flags]; // Records what options where set by a directive
178 public:
179 #define flag_store_definition(name, type, dvalue, cc_flag) type name##Option;
180 compilerdirectives_common_flags(flag_store_definition)
181 compilerdirectives_c2_flags(flag_store_definition)
182 compilerdirectives_c1_flags(flag_store_definition)
183 #undef flag_store_definition
184
185 // Casting to get the same function signature for all setters. Used from parser.
186 #define set_function_definition(name, type, dvalue, cc_flag) void set_##name(void* value) { type val = *(type*)value; name##Option = val; _modified[name##Index] = true; }
187 compilerdirectives_common_other_flags(set_function_definition)
188 compilerdirectives_c2_other_flags(set_function_definition)
189 compilerdirectives_c1_other_flags(set_function_definition)
190 #undef set_function_definition
191
192 // Casting to get the same function signature for all setters. Used from parser.
193 //
194 // IMPORTANT: Takes ownership, will use os::free. Ensure the memory was dynamically allocated on the
195 // C heap.
196 #define set_string_function_definition(name, type, dvalue, cc_flag) \
197 void set_##name(void* value) { \
198 if (_modified[name##Index]) { \
199 os::free(const_cast<char*>(name##Option)); \
200 } \
201 type val = *(type*)value; \
202 name##Option = val; \
203 _modified[name##Index] = true; \
204 }
205 compilerdirectives_common_string_flags(set_string_function_definition)
206 compilerdirectives_c2_string_flags(set_string_function_definition)
207 compilerdirectives_c1_string_flags(set_string_function_definition)
208 #undef set_string_function_definition
209
210 void set_ideal_phase_name_set(const BitMap& set) {
211 _ideal_phase_name_set.set_from(set);
212 };
213 bool should_print_phase(const CompilerPhaseType cpt) const {
214 return _ideal_phase_name_set.at(cpt);
215 };
216 void set_trace_auto_vectorization_tags(const CHeapBitMap& tags) {
217 _trace_auto_vectorization_tags.set_from(tags);
218 };
219 const CHeapBitMap& trace_auto_vectorization_tags() {
220 return _trace_auto_vectorization_tags;
221 };
222 void set_trace_merge_stores_tags(const CHeapBitMap& tags) {
223 _trace_merge_stores_tags.set_from(tags);
224 };
225 const CHeapBitMap& trace_merge_stores_tags() {
226 return _trace_merge_stores_tags;
227 };
228
229 void print_intx(outputStream* st, ccstr n, intx v, bool mod) { if (mod) { st->print("%s:" INTX_FORMAT " ", n, v); } }
230 void print_uintx(outputStream* st, ccstr n, intx v, bool mod) { if (mod) { st->print("%s:" UINTX_FORMAT " ", n, v); } }
231 void print_bool(outputStream* st, ccstr n, bool v, bool mod) { if (mod) { st->print("%s:%s ", n, v ? "true" : "false"); } }
232 void print_double(outputStream* st, ccstr n, double v, bool mod) { if (mod) { st->print("%s:%f ", n, v); } }
233 void print_ccstr(outputStream* st, ccstr n, ccstr v, bool mod) { if (mod) { st->print("%s:%s ", n, v); } }
234 void print_ccstrlist(outputStream* st, ccstr n, ccstr v, bool mod) { print_ccstr(st, n, v, mod); }
235
236 void print(outputStream* st) {
237 print_inline(st);
238 st->print(" ");
239 #define print_function_definition(name, type, dvalue, cc_flag) print_##type(st, #name, this->name##Option, true);
240 compilerdirectives_common_flags(print_function_definition)
241 compilerdirectives_c2_flags(print_function_definition)
242 compilerdirectives_c1_flags(print_function_definition)
243 #undef print_function_definition
244 st->cr();
245 }
246 };
247
248 // Iterator of ControlIntrinsic=+_id1,-_id2,+_id3,...
249 //
250 // If disable_all is set, it accepts DisableIntrinsic and all intrinsic Ids
251 // appear in the list are disabled. Arguments don't have +/- prefix. eg.
252 // DisableIntrinsic=_id1,_id2,_id3,...
253 class ControlIntrinsicIter {
254 private:
255 bool _enabled;
256 char* _token;
257 char* _saved_ptr;
258 char* _list;
259 const bool _disableIntrinsic;
260 void next_token();
261
262 public:
263 ControlIntrinsicIter(ccstrlist option, bool disable_all = false);
264 ~ControlIntrinsicIter();
265
266 bool is_enabled() const { return _enabled; }
267 const char* operator*() const { return _token; }
268
269 ControlIntrinsicIter& operator++();
270 };
271
272 class ControlIntrinsicValidator {
273 private:
274 bool _valid;
275 char* _bad;
276
277 public:
278 ControlIntrinsicValidator(ccstrlist option, bool disable_all) : _valid(true), _bad(nullptr) {
279 for (ControlIntrinsicIter iter(option, disable_all); *iter != nullptr && _valid; ++iter) {
280 if (vmIntrinsics::_none == vmIntrinsics::find_id(*iter)) {
281 const size_t len = MIN2<size_t>(strlen(*iter), 63) + 1; // cap len to a value we know is enough for all intrinsic names
282 _bad = NEW_C_HEAP_ARRAY(char, len, mtCompiler);
283 // strncpy always writes len characters. If the source string is shorter, the function fills the remaining bytes with nullptrs.
284 strncpy(_bad, *iter, len);
285 _valid = false;
286 }
287 }
288 }
289
290 ~ControlIntrinsicValidator() {
291 if (_bad != nullptr) {
292 FREE_C_HEAP_ARRAY(char, _bad);
293 }
294 }
295
296 bool is_valid() const {
297 return _valid;
298 }
299
300 const char* what() const {
301 return _bad;
302 }
303 };
304
305 class CompilerDirectives : public CHeapObj<mtCompiler> {
306 private:
307 CompilerDirectives* _next;
308 BasicMatcher* _match;
309 int _ref_count;
310
311 public:
312
313 CompilerDirectives();
314 ~CompilerDirectives();
315
316 CompilerDirectives* next();
317 void set_next(CompilerDirectives* next) {_next = next; }
318
319 bool match(const methodHandle& method);
320 BasicMatcher* match() { return _match; }
321 bool add_match(char* str, const char*& error_msg);
322 DirectiveSet* get_for(AbstractCompiler *comp);
323 void print(outputStream* st);
324 bool is_default_directive() { return _next == nullptr; }
325 void finalize(outputStream* st);
326
327 void inc_refcount();
328 void dec_refcount();
329 int refcount();
330
331 DirectiveSet* _c1_store;
332 DirectiveSet* _c2_store;
333 };
334
335 #endif // SHARE_COMPILER_COMPILERDIRECTIVES_HPP