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