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_COMPILETASK_HPP
26 #define SHARE_COMPILER_COMPILETASK_HPP
27
28 #include "ci/ciMethod.hpp"
29 #include "code/nmethod.hpp"
30 #include "compiler/compileLog.hpp"
31 #include "memory/allocation.hpp"
32 #include "utilities/xmlstream.hpp"
33
34 class CompileTrainingData;
35 class DirectiveSet;
36
37 JVMCI_ONLY(class JVMCICompileState;)
38
39 enum class InliningResult { SUCCESS, FAILURE };
40
41 inline InliningResult inlining_result_of(bool success) {
42 return success ? InliningResult::SUCCESS : InliningResult::FAILURE;
43 }
44
45 // CompileTask
46 //
47 // An entry in the compile queue. It represents a pending or current
48 // compilation.
49
50 class CompileTask : public CHeapObj<mtCompiler> {
51 friend class VMStructs;
52 friend class JVMCIVMStructs;
53
54 public:
55 // Different reasons for a compilation
56 // The order is important - mapped to reason_names[]
57 enum CompileReason {
58 Reason_None,
59 Reason_InvocationCount, // Simple/StackWalk-policy
60 Reason_BackedgeCount, // Simple/StackWalk-policy
61 Reason_Tiered, // Tiered-policy
62 Reason_Replay, // ciReplay
63 Reason_Whitebox, // Whitebox API
64 Reason_MustBeCompiled, // Used for -Xcomp or AlwaysCompileLoopMethods (see CompilationPolicy::must_be_compiled())
65 Reason_Bootstrap, // JVMCI bootstrap
66 Reason_Count
67 };
68
69 static const char* reason_name(CompileTask::CompileReason compile_reason) {
70 static const char* reason_names[] = {
71 "no_reason",
72 "count",
73 "backedge_count",
74 "tiered",
75 "replay",
76 "whitebox",
77 "must_be_compiled",
78 "bootstrap"
79 };
80 return reason_names[compile_reason];
81 }
82
83 private:
84 static CompileTask* _task_free_list;
85 Monitor* _lock;
86 int _compile_id;
87 Method* _method;
88 jobject _method_holder;
89 int _osr_bci;
90 bool _is_complete;
91 bool _is_success;
92 bool _is_blocking;
93 CodeSection::csize_t _nm_content_size;
94 CodeSection::csize_t _nm_total_size;
95 CodeSection::csize_t _nm_insts_size;
96 DirectiveSet* _directive;
97 #if INCLUDE_JVMCI
98 bool _has_waiter;
99 // Compilation state for a blocking JVMCI compilation
100 JVMCICompileState* _blocking_jvmci_compile_state;
101 #endif
102 int _waiting_count; // See waiting_for_completion_count()
103 int _comp_level;
104 int _num_inlined_bytecodes;
105 CompileTask* _next, *_prev;
106 bool _is_free;
107 // Fields used for logging why the compilation was initiated:
108 jlong _time_queued; // time when task was enqueued
109 jlong _time_started; // time when compilation started
110 int _hot_count; // information about its invocation counter
111 CompileReason _compile_reason; // more info about the task
112 const char* _failure_reason;
113 // Specifies if _failure_reason is on the C heap.
114 bool _failure_reason_on_C_heap;
115 CompileTrainingData* _training_data;
116 size_t _arena_bytes; // peak size of temporary memory during compilation (e.g. node arenas)
117
118 public:
119 CompileTask() : _failure_reason(nullptr), _failure_reason_on_C_heap(false) {
120 // May hold MethodCompileQueue_lock
121 _lock = new Monitor(Mutex::safepoint-1, "CompileTask_lock");
122 }
123
124 void initialize(int compile_id, const methodHandle& method, int osr_bci, int comp_level,
125 int hot_count,
126 CompileTask::CompileReason compile_reason, bool is_blocking);
127
128 static CompileTask* allocate();
129 static void free(CompileTask* task);
130
131 int compile_id() const { return _compile_id; }
132 Method* method() const { return _method; }
133 int osr_bci() const { return _osr_bci; }
134 bool is_complete() const { return _is_complete; }
135 bool is_blocking() const { return _is_blocking; }
136 bool is_success() const { return _is_success; }
137 DirectiveSet* directive() const { return _directive; }
138 CodeSection::csize_t nm_content_size() { return _nm_content_size; }
139 void set_nm_content_size(CodeSection::csize_t size) { _nm_content_size = size; }
140 CodeSection::csize_t nm_insts_size() { return _nm_insts_size; }
141 void set_nm_insts_size(CodeSection::csize_t size) { _nm_insts_size = size; }
142 CodeSection::csize_t nm_total_size() { return _nm_total_size; }
143 void set_nm_total_size(CodeSection::csize_t size) { _nm_total_size = size; }
144 bool can_become_stale() const {
145 switch (_compile_reason) {
146 case Reason_BackedgeCount:
147 case Reason_InvocationCount:
148 case Reason_Tiered:
149 return !_is_blocking;
150 default:
151 return false;
152 }
153 }
154 #if INCLUDE_JVMCI
155 bool should_wait_for_compilation() const {
156 // Wait for blocking compilation to finish.
157 switch (_compile_reason) {
158 case Reason_Replay:
159 case Reason_Whitebox:
160 case Reason_Bootstrap:
161 return _is_blocking;
162 default:
163 return false;
164 }
165 }
166
167 bool has_waiter() const { return _has_waiter; }
168 void clear_waiter() { _has_waiter = false; }
169 JVMCICompileState* blocking_jvmci_compile_state() const { return _blocking_jvmci_compile_state; }
170 void set_blocking_jvmci_compile_state(JVMCICompileState* state) {
171 _blocking_jvmci_compile_state = state;
172 }
173 #endif
174
175 Monitor* lock() const { return _lock; }
176
177 // See how many threads are waiting for this task. Must have lock to read this.
178 int waiting_for_completion_count() {
179 assert(_lock->owned_by_self(), "must have lock to use waiting_for_completion_count()");
180 return _waiting_count;
181 }
182 // Indicates that a thread is waiting for this task to complete. Must have lock to use this.
183 void inc_waiting_for_completion() {
184 assert(_lock->owned_by_self(), "must have lock to use inc_waiting_for_completion()");
185 _waiting_count++;
186 }
187 // Indicates that a thread stopped waiting for this task to complete. Must have lock to use this.
188 void dec_waiting_for_completion() {
189 assert(_lock->owned_by_self(), "must have lock to use dec_waiting_for_completion()");
190 assert(_waiting_count > 0, "waiting count is not positive");
191 _waiting_count--;
192 }
193
194 void mark_complete() { _is_complete = true; }
195 void mark_success() { _is_success = true; }
196 void mark_started(jlong time) { _time_started = time; }
197
198 int comp_level() { return _comp_level;}
199 void set_comp_level(int comp_level) { _comp_level = comp_level;}
200
201 CompileReason compile_reason() { return _compile_reason; }
202
203 AbstractCompiler* compiler() const;
204 CompileTask* select_for_compilation();
205
206 int num_inlined_bytecodes() const { return _num_inlined_bytecodes; }
207 void set_num_inlined_bytecodes(int n) { _num_inlined_bytecodes = n; }
208
209 CompileTask* next() const { return _next; }
210 void set_next(CompileTask* next) { _next = next; }
211 CompileTask* prev() const { return _prev; }
212 void set_prev(CompileTask* prev) { _prev = prev; }
213 bool is_free() const { return _is_free; }
214 void set_is_free(bool val) { _is_free = val; }
215 bool is_unloaded() const;
216
217 CompileTrainingData* training_data() const { return _training_data; }
218 void set_training_data(CompileTrainingData* td) { _training_data = td; }
219
220 // RedefineClasses support
221 void metadata_do(MetadataClosure* f);
222 void mark_on_stack();
223
224 void set_arena_bytes(size_t s) { _arena_bytes = s; }
225 size_t arena_bytes() const { return _arena_bytes; }
226
227 private:
228 static void print_impl(outputStream* st, Method* method, int compile_id, int comp_level,
229 bool is_osr_method = false, int osr_bci = -1, bool is_blocking = false,
230 const char* msg = nullptr, bool short_form = false, bool cr = true,
231 jlong time_queued = 0, jlong time_started = 0);
232
233 public:
234 void print(outputStream* st = tty, const char* msg = nullptr, bool short_form = false, bool cr = true);
235 void print_ul(const char* msg = nullptr);
236 static void print(outputStream* st, const nmethod* nm, const char* msg = nullptr, bool short_form = false, bool cr = true) {
237 print_impl(st, nm->method(), nm->compile_id(), nm->comp_level(),
238 nm->is_osr_method(), nm->is_osr_method() ? nm->osr_entry_bci() : -1, /*is_blocking*/ false,
239 msg, short_form, cr);
240 }
241 static void print_ul(const nmethod* nm, const char* msg = nullptr);
242
243 /**
244 * @deprecated Please rely on Compile::inline_printer. Do not directly write inlining information to tty.
245 */
246 static void print_inline_indent(int inline_level, outputStream* st = tty);
247
248 void print_tty();
249 void print_line_on_error(outputStream* st, char* buf, int buflen);
250
251 void log_task(xmlStream* log);
252 void log_task_queued();
253 void log_task_start(CompileLog* log);
254 void log_task_done(CompileLog* log);
255
256 void set_failure_reason(const char* reason, bool on_C_heap = false) {
257 _failure_reason = reason;
258 _failure_reason_on_C_heap = on_C_heap;
259 }
260
261 bool check_break_at_flags();
262
263 static void print_inlining_header(outputStream* st, ciMethod* method, int inline_level, int bci);
264 static void print_inlining_inner(outputStream* st, ciMethod* method, int inline_level, int bci, InliningResult result, const char* msg = nullptr);
265 static void print_inline_inner_method_info(outputStream* st, ciMethod* method);
266 static void print_inlining_inner_message(outputStream* st, InliningResult result, const char* msg);
267
268 static void print_inlining_tty(ciMethod* method, int inline_level, int bci, InliningResult result, const char* msg = nullptr) {
269 print_inlining_inner(tty, method, inline_level, bci, result, msg);
270 }
271 static void print_inlining_ul(ciMethod* method, int inline_level, int bci, InliningResult result, const char* msg = nullptr);
272 };
273
274 #endif // SHARE_COMPILER_COMPILETASK_HPP