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