1 /*
2 * Copyright (c) 1999, 2019, 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_COMPILEBROKER_HPP
26 #define SHARE_COMPILER_COMPILEBROKER_HPP
27
28 #include "ci/compilerInterface.hpp"
29 #include "compiler/abstractCompiler.hpp"
30 #include "compiler/compileTask.hpp"
31 #include "compiler/compilerDirectives.hpp"
32 #include "runtime/perfData.hpp"
33 #include "utilities/stack.hpp"
34 #if INCLUDE_JVMCI
35 #include "jvmci/jvmciCompiler.hpp"
36 #endif
37
38 class nmethod;
39 class nmethodLocker;
40
41 // CompilerCounters
42 //
43 // Per Compiler Performance Counters.
44 //
45 class CompilerCounters : public CHeapObj<mtCompiler> {
46
47 public:
48 enum {
49 cmname_buffer_length = 160
50 };
51
52 private:
53
54 char _current_method[cmname_buffer_length];
55 int _compile_type;
56
57 public:
58 CompilerCounters();
59
60 // these methods should be called in a thread safe context
61
62 void set_current_method(const char* method) {
63 strncpy(_current_method, method, (size_t)cmname_buffer_length-1);
64 _current_method[cmname_buffer_length-1] = '\0';
65 }
66
67 char* current_method() { return _current_method; }
68
69 void set_compile_type(int compile_type) {
70 _compile_type = compile_type;
71 }
72
73 int compile_type() { return _compile_type; }
74
75 };
76
77 // CompileQueue
78 //
79 // A list of CompileTasks.
80 class CompileQueue : public CHeapObj<mtCompiler> {
81 private:
82 const char* _name;
83
84 CompileTask* _first;
85 CompileTask* _last;
86
87 CompileTask* _first_stale;
88
89 int _size;
90
91 void purge_stale_tasks();
92 public:
93 CompileQueue(const char* name) {
94 _name = name;
95 _first = NULL;
96 _last = NULL;
97 _size = 0;
98 _first_stale = NULL;
99 }
100
101 const char* name() const { return _name; }
102
103 void add(CompileTask* task);
104 void remove(CompileTask* task);
105 void remove_and_mark_stale(CompileTask* task);
106 CompileTask* first() { return _first; }
107 CompileTask* last() { return _last; }
108
109 CompileTask* get();
110
111 bool is_empty() const { return _first == NULL; }
112 int size() const { return _size; }
113
114
115 // Redefine Classes support
116 void mark_on_stack();
117 void free_all();
118 void print_tty();
119 void print(outputStream* st = tty);
120
121 ~CompileQueue() {
122 assert (is_empty(), " Compile Queue must be empty");
123 }
124 };
125
126 // CompileTaskWrapper
127 //
128 // Assign this task to the current thread. Deallocate the task
129 // when the compilation is complete.
130 class CompileTaskWrapper : StackObj {
131 public:
132 CompileTaskWrapper(CompileTask* task);
133 ~CompileTaskWrapper();
134 };
135
136 // Compilation
137 //
138 // The broker for all compilation requests.
139 class CompileBroker: AllStatic {
140 friend class Threads;
141 friend class CompileTaskWrapper;
142
143 public:
144 enum {
145 name_buffer_length = 100
146 };
147
148 // Compile type Information for print_last_compile() and CompilerCounters
149 enum { no_compile, normal_compile, osr_compile, native_compile };
150 static int assign_compile_id (const methodHandle& method, int osr_bci);
151
152
153 private:
154 static bool _initialized;
155 static volatile bool _should_block;
156
157 // This flag can be used to stop compilation or turn it back on
158 static volatile jint _should_compile_new_jobs;
159
160 // The installed compiler(s)
161 static AbstractCompiler* _compilers[2];
162
163 // The maximum numbers of compiler threads to be determined during startup.
164 static int _c1_count, _c2_count;
165
166 // An array of compiler thread Java objects
167 static jobject *_compiler1_objects, *_compiler2_objects;
168
169 // An array of compiler logs
170 static CompileLog **_compiler1_logs, **_compiler2_logs;
171
172 // These counters are used for assigning id's to each compilation
173 static volatile jint _compilation_id;
174 static volatile jint _osr_compilation_id;
175
176 static CompileQueue* _c2_compile_queue;
177 static CompileQueue* _c1_compile_queue;
178
179 // performance counters
180 static PerfCounter* _perf_total_compilation;
181 static PerfCounter* _perf_native_compilation;
182 static PerfCounter* _perf_osr_compilation;
183 static PerfCounter* _perf_standard_compilation;
184
185 static PerfCounter* _perf_total_bailout_count;
186 static PerfCounter* _perf_total_invalidated_count;
187 static PerfCounter* _perf_total_compile_count;
188 static PerfCounter* _perf_total_native_compile_count;
189 static PerfCounter* _perf_total_osr_compile_count;
190 static PerfCounter* _perf_total_standard_compile_count;
191
192 static PerfCounter* _perf_sum_osr_bytes_compiled;
193 static PerfCounter* _perf_sum_standard_bytes_compiled;
194 static PerfCounter* _perf_sum_nmethod_size;
195 static PerfCounter* _perf_sum_nmethod_code_size;
196
197 static PerfStringVariable* _perf_last_method;
198 static PerfStringVariable* _perf_last_failed_method;
199 static PerfStringVariable* _perf_last_invalidated_method;
200 static PerfVariable* _perf_last_compile_type;
201 static PerfVariable* _perf_last_compile_size;
202 static PerfVariable* _perf_last_failed_type;
203 static PerfVariable* _perf_last_invalidated_type;
204
205 // Timers and counters for generating statistics
206 static elapsedTimer _t_total_compilation;
207 static elapsedTimer _t_osr_compilation;
208 static elapsedTimer _t_standard_compilation;
209 static elapsedTimer _t_invalidated_compilation;
210 static elapsedTimer _t_bailedout_compilation;
211
212 static int _total_compile_count;
213 static int _total_bailout_count;
214 static int _total_invalidated_count;
215 static int _total_native_compile_count;
216 static int _total_osr_compile_count;
217 static int _total_standard_compile_count;
218 static int _total_compiler_stopped_count;
219 static int _total_compiler_restarted_count;
220 static int _sum_osr_bytes_compiled;
221 static int _sum_standard_bytes_compiled;
222 static int _sum_nmethod_size;
223 static int _sum_nmethod_code_size;
224 static long _peak_compilation_time;
225
226 static volatile int _print_compilation_warning;
227
228 static Handle create_thread_oop(const char* name, TRAPS);
229 static JavaThread* make_thread(jobject thread_oop, CompileQueue* queue, AbstractCompiler* comp, Thread* THREAD);
230 static void init_compiler_sweeper_threads();
231 static void possibly_add_compiler_threads(Thread* THREAD);
232 static bool compilation_is_prohibited(const methodHandle& method, int osr_bci, int comp_level, bool excluded);
233
234 static CompileTask* create_compile_task(CompileQueue* queue,
235 int compile_id,
236 const methodHandle& method,
237 int osr_bci,
238 int comp_level,
239 const methodHandle& hot_method,
240 int hot_count,
241 CompileTask::CompileReason compile_reason,
242 bool blocking);
243 static void wait_for_completion(CompileTask* task);
244 #if INCLUDE_JVMCI
245 static bool wait_for_jvmci_completion(JVMCICompiler* comp, CompileTask* task, JavaThread* thread);
246 #endif
247
248 static void invoke_compiler_on_method(CompileTask* task);
249 static void post_compile(CompilerThread* thread, CompileTask* task, bool success, ciEnv* ci_env,
250 int compilable, const char* failure_reason);
251 static void update_compile_perf_data(CompilerThread *thread, const methodHandle& method, bool is_osr);
252
253 static void push_jni_handle_block();
254 static void pop_jni_handle_block();
255 static void collect_statistics(CompilerThread* thread, elapsedTimer time, CompileTask* task);
256
257 static void compile_method_base(const methodHandle& method,
258 int osr_bci,
259 int comp_level,
260 const methodHandle& hot_method,
261 int hot_count,
262 CompileTask::CompileReason compile_reason,
263 bool blocking,
264 Thread* thread);
265
266 static CompileQueue* compile_queue(int comp_level);
267 static bool init_compiler_runtime();
268 static void shutdown_compiler_runtime(AbstractCompiler* comp, CompilerThread* thread);
269
270 public:
271
272 static DirectivesStack* dirstack();
273 static void set_dirstack(DirectivesStack* stack);
274
275 enum {
276 // The entry bci used for non-OSR compilations.
277 standard_entry_bci = InvocationEntryBci
278 };
279
280 static AbstractCompiler* compiler(int comp_level) {
281 if (is_c2_compile(comp_level)) return _compilers[1]; // C2
282 if (is_c1_compile(comp_level)) return _compilers[0]; // C1
283 return NULL;
284 }
285
286 static bool compilation_is_complete(const methodHandle& method, int osr_bci, int comp_level);
287 static bool compilation_is_in_queue(const methodHandle& method);
288 static void print_compile_queues(outputStream* st);
289 static void print_directives(outputStream* st);
290 static int queue_size(int comp_level) {
291 CompileQueue *q = compile_queue(comp_level);
292 return q != NULL ? q->size() : 0;
293 }
294 static void compilation_init_phase1(Thread* THREAD);
295 static void compilation_init_phase2();
296 static void init_compiler_thread_log();
297 static nmethod* compile_method(const methodHandle& method,
298 int osr_bci,
299 int comp_level,
300 const methodHandle& hot_method,
301 int hot_count,
302 CompileTask::CompileReason compile_reason,
303 Thread* thread);
304
305 static nmethod* compile_method(const methodHandle& method,
306 int osr_bci,
307 int comp_level,
308 const methodHandle& hot_method,
309 int hot_count,
310 CompileTask::CompileReason compile_reason,
311 DirectiveSet* directive,
312 Thread* thread);
313
314 // Acquire any needed locks and assign a compile id
315 static uint assign_compile_id_unlocked(Thread* thread, const methodHandle& method, int osr_bci);
316
317 static void compiler_thread_loop();
318 static uint get_compilation_id() { return _compilation_id; }
319
320 // Set _should_block.
321 // Call this from the VM, with Threads_lock held and a safepoint requested.
322 static void set_should_block();
323
324 // Call this from the compiler at convenient points, to poll for _should_block.
325 static void maybe_block();
326
327 enum CompilerActivity {
328 // Flags for toggling compiler activity
329 stop_compilation = 0,
330 run_compilation = 1,
331 shutdown_compilation = 2
332 };
333
334 static jint get_compilation_activity_mode() { return _should_compile_new_jobs; }
335 static bool should_compile_new_jobs() { return UseCompiler && (_should_compile_new_jobs == run_compilation); }
336 static bool set_should_compile_new_jobs(jint new_state) {
337 // Return success if the current caller set it
338 jint old = Atomic::cmpxchg(new_state, &_should_compile_new_jobs, 1-new_state);
339 bool success = (old == (1-new_state));
340 if (success) {
341 if (new_state == run_compilation) {
342 _total_compiler_restarted_count++;
343 } else {
344 _total_compiler_stopped_count++;
345 }
346 }
347 return success;
348 }
349
350 static void disable_compilation_forever() {
351 UseCompiler = false;
352 AlwaysCompileLoopMethods = false;
353 Atomic::xchg(jint(shutdown_compilation), &_should_compile_new_jobs);
354 }
355
356 static bool is_compilation_disabled_forever() {
357 return _should_compile_new_jobs == shutdown_compilation;
358 }
359 static void handle_full_code_cache(int code_blob_type);
360 // Ensures that warning is only printed once.
361 static bool should_print_compiler_warning() {
362 jint old = Atomic::cmpxchg(1, &_print_compilation_warning, 0);
363 return old == 0;
364 }
365 // Return total compilation ticks
366 static jlong total_compilation_ticks() {
367 return _perf_total_compilation != NULL ? _perf_total_compilation->get_value() : 0;
368 }
369
370 // Redefine Classes support
371 static void mark_on_stack();
372
373 #if INCLUDE_JVMCI
374 // Print curent compilation time stats for a given compiler
375 static void print_times(AbstractCompiler* comp);
376 #endif
377
378 // Print a detailed accounting of compilation time
379 static void print_times(bool per_compiler = true, bool aggregate = true);
380
381 // compiler name for debugging
382 static const char* compiler_name(int comp_level);
383
384 // Provide access to compiler thread Java objects
385 static jobject compiler1_object(int idx) {
386 assert(_compiler1_objects != NULL, "must be initialized");
387 assert(idx < _c1_count, "oob");
388 return _compiler1_objects[idx];
389 }
390
391 static jobject compiler2_object(int idx) {
392 assert(_compiler2_objects != NULL, "must be initialized");
393 assert(idx < _c2_count, "oob");
394 return _compiler2_objects[idx];
395 }
396
397 static bool can_remove(CompilerThread *ct, bool do_it);
398
399 static CompileLog* get_log(CompilerThread* ct);
400
401 static int get_total_compile_count() { return _total_compile_count; }
402 static int get_total_bailout_count() { return _total_bailout_count; }
403 static int get_total_invalidated_count() { return _total_invalidated_count; }
404 static int get_total_native_compile_count() { return _total_native_compile_count; }
405 static int get_total_osr_compile_count() { return _total_osr_compile_count; }
406 static int get_total_standard_compile_count() { return _total_standard_compile_count; }
407 static int get_total_compiler_stopped_count() { return _total_compiler_stopped_count; }
408 static int get_total_compiler_restarted_count() { return _total_compiler_restarted_count; }
409 static int get_sum_osr_bytes_compiled() { return _sum_osr_bytes_compiled; }
410 static int get_sum_standard_bytes_compiled() { return _sum_standard_bytes_compiled; }
411 static int get_sum_nmethod_size() { return _sum_nmethod_size;}
412 static int get_sum_nmethod_code_size() { return _sum_nmethod_code_size; }
413 static long get_peak_compilation_time() { return _peak_compilation_time; }
414 static long get_total_compilation_time() { return _t_total_compilation.milliseconds(); }
415
416 // Log that compilation profiling is skipped because metaspace is full.
417 static void log_metaspace_failure();
418
419 // CodeHeap State Analytics.
420 static void print_info(outputStream *out);
421 static void print_heapinfo(outputStream *out, const char* function, size_t granularity);
422 };
423
424 #endif // SHARE_COMPILER_COMPILEBROKER_HPP