1 /*
2 * Copyright (c) 1999, 2017, 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_VM_COMPILER_COMPILEBROKER_HPP
26 #define SHARE_VM_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 // These counters are used for assigning id's to each compilation
164 static volatile jint _compilation_id;
165 static volatile jint _osr_compilation_id;
166
167 static int _last_compile_type;
168 static int _last_compile_level;
169 static char _last_method_compiled[name_buffer_length];
170
171 static CompileQueue* _c2_compile_queue;
172 static CompileQueue* _c1_compile_queue;
173
174 // performance counters
175 static PerfCounter* _perf_total_compilation;
176 static PerfCounter* _perf_native_compilation;
177 static PerfCounter* _perf_osr_compilation;
178 static PerfCounter* _perf_standard_compilation;
179
180 static PerfCounter* _perf_total_bailout_count;
181 static PerfCounter* _perf_total_invalidated_count;
182 static PerfCounter* _perf_total_compile_count;
183 static PerfCounter* _perf_total_native_compile_count;
184 static PerfCounter* _perf_total_osr_compile_count;
185 static PerfCounter* _perf_total_standard_compile_count;
186
187 static PerfCounter* _perf_sum_osr_bytes_compiled;
188 static PerfCounter* _perf_sum_standard_bytes_compiled;
189 static PerfCounter* _perf_sum_nmethod_size;
190 static PerfCounter* _perf_sum_nmethod_code_size;
191
192 static PerfStringVariable* _perf_last_method;
193 static PerfStringVariable* _perf_last_failed_method;
194 static PerfStringVariable* _perf_last_invalidated_method;
195 static PerfVariable* _perf_last_compile_type;
196 static PerfVariable* _perf_last_compile_size;
197 static PerfVariable* _perf_last_failed_type;
198 static PerfVariable* _perf_last_invalidated_type;
199
200 // Timers and counters for generating statistics
201 static elapsedTimer _t_total_compilation;
202 static elapsedTimer _t_osr_compilation;
203 static elapsedTimer _t_standard_compilation;
204 static elapsedTimer _t_invalidated_compilation;
205 static elapsedTimer _t_bailedout_compilation;
206
207 static int _total_compile_count;
208 static int _total_bailout_count;
209 static int _total_invalidated_count;
210 static int _total_native_compile_count;
211 static int _total_osr_compile_count;
212 static int _total_standard_compile_count;
213 static int _sum_osr_bytes_compiled;
214 static int _sum_standard_bytes_compiled;
215 static int _sum_nmethod_size;
216 static int _sum_nmethod_code_size;
217 static long _peak_compilation_time;
218
219 static volatile jint _print_compilation_warning;
220
221 static JavaThread* make_thread(const char* name, CompileQueue* queue, CompilerCounters* counters, AbstractCompiler* comp, bool compiler_thread, TRAPS);
222 static void init_compiler_sweeper_threads(int c1_compiler_count, int c2_compiler_count);
223 static bool compilation_is_complete (const methodHandle& method, int osr_bci, int comp_level);
224 static bool compilation_is_prohibited(const methodHandle& method, int osr_bci, int comp_level, bool excluded);
225 static void preload_classes (const methodHandle& method, TRAPS);
226
227 static CompileTask* create_compile_task(CompileQueue* queue,
228 int compile_id,
229 const methodHandle& method,
230 int osr_bci,
231 int comp_level,
232 const methodHandle& hot_method,
233 int hot_count,
234 CompileTask::CompileReason compile_reason,
235 bool blocking);
236 static void wait_for_completion(CompileTask* task);
237 #if INCLUDE_JVMCI
238 static bool wait_for_jvmci_completion(JVMCICompiler* comp, CompileTask* task, JavaThread* thread);
239 #endif
240
241 static void invoke_compiler_on_method(CompileTask* task);
242 static void post_compile(CompilerThread* thread, CompileTask* task, bool success, ciEnv* ci_env);
243 static void set_last_compile(CompilerThread *thread, const methodHandle& method, bool is_osr, int comp_level);
244 static void push_jni_handle_block();
245 static void pop_jni_handle_block();
246 static void collect_statistics(CompilerThread* thread, elapsedTimer time, CompileTask* task);
247
248 static void compile_method_base(const methodHandle& method,
249 int osr_bci,
250 int comp_level,
251 const methodHandle& hot_method,
252 int hot_count,
253 CompileTask::CompileReason compile_reason,
254 bool blocking,
255 Thread* thread);
256
257 static CompileQueue* compile_queue(int comp_level);
258 static bool init_compiler_runtime();
259 static void shutdown_compiler_runtime(AbstractCompiler* comp, CompilerThread* thread);
260
261 public:
262
263 static DirectivesStack* dirstack();
264 static void set_dirstack(DirectivesStack* stack);
265
266 enum {
267 // The entry bci used for non-OSR compilations.
268 standard_entry_bci = InvocationEntryBci
269 };
270
271 static AbstractCompiler* compiler(int comp_level) {
272 if (is_c2_compile(comp_level)) return _compilers[1]; // C2
273 if (is_c1_compile(comp_level)) return _compilers[0]; // C1
274 return NULL;
275 }
276
277 static bool compilation_is_in_queue(const methodHandle& method);
278 static void print_compile_queues(outputStream* st);
279 static void print_directives(outputStream* st);
280 static int queue_size(int comp_level) {
281 CompileQueue *q = compile_queue(comp_level);
282 return q != NULL ? q->size() : 0;
283 }
284 static void compilation_init(TRAPS);
285 static void init_compiler_thread_log();
286 static nmethod* compile_method(const methodHandle& method,
287 int osr_bci,
288 int comp_level,
289 const methodHandle& hot_method,
290 int hot_count,
291 CompileTask::CompileReason compile_reason,
292 Thread* thread);
293
294 static nmethod* compile_method(const methodHandle& method,
295 int osr_bci,
296 int comp_level,
297 const methodHandle& hot_method,
298 int hot_count,
299 CompileTask::CompileReason compile_reason,
300 DirectiveSet* directive,
301 Thread* thread);
302
303 // Acquire any needed locks and assign a compile id
304 static uint assign_compile_id_unlocked(Thread* thread, const methodHandle& method, int osr_bci);
305
306 static void compiler_thread_loop();
307 static uint get_compilation_id() { return _compilation_id; }
308
309 // Set _should_block.
310 // Call this from the VM, with Threads_lock held and a safepoint requested.
311 static void set_should_block();
312
313 // Call this from the compiler at convenient points, to poll for _should_block.
314 static void maybe_block();
315
316 enum {
317 // Flags for toggling compiler activity
318 stop_compilation = 0,
319 run_compilation = 1,
320 shutdown_compilaton = 2
321 };
322
323 static jint get_compilation_activity_mode() { return _should_compile_new_jobs; }
324 static bool should_compile_new_jobs() { return UseCompiler && (_should_compile_new_jobs == run_compilation); }
325 static bool set_should_compile_new_jobs(jint new_state) {
326 // Return success if the current caller set it
327 jint old = Atomic::cmpxchg(new_state, &_should_compile_new_jobs, 1-new_state);
328 return (old == (1-new_state));
329 }
330
331 static void disable_compilation_forever() {
332 UseCompiler = false;
333 AlwaysCompileLoopMethods = false;
334 Atomic::xchg(shutdown_compilaton, &_should_compile_new_jobs);
335 }
336
337 static bool is_compilation_disabled_forever() {
338 return _should_compile_new_jobs == shutdown_compilaton;
339 }
340 static void handle_full_code_cache(int code_blob_type);
341 // Ensures that warning is only printed once.
342 static bool should_print_compiler_warning() {
343 jint old = Atomic::cmpxchg(1, &_print_compilation_warning, 0);
344 return old == 0;
345 }
346 // Return total compilation ticks
347 static jlong total_compilation_ticks() {
348 return _perf_total_compilation != NULL ? _perf_total_compilation->get_value() : 0;
349 }
350
351 // Redefine Classes support
352 static void mark_on_stack();
353
354 #if INCLUDE_JVMCI
355 // Print curent compilation time stats for a given compiler
356 static void print_times(AbstractCompiler* comp);
357 #endif
358
359 // Print a detailed accounting of compilation time
360 static void print_times(bool per_compiler = true, bool aggregate = true);
361
362 // Debugging output for failure
363 static void print_last_compile();
364
365 // compiler name for debugging
366 static const char* compiler_name(int comp_level);
367
368 static int get_total_compile_count() { return _total_compile_count; }
369 static int get_total_bailout_count() { return _total_bailout_count; }
370 static int get_total_invalidated_count() { return _total_invalidated_count; }
371 static int get_total_native_compile_count() { return _total_native_compile_count; }
372 static int get_total_osr_compile_count() { return _total_osr_compile_count; }
373 static int get_total_standard_compile_count() { return _total_standard_compile_count; }
374 static int get_sum_osr_bytes_compiled() { return _sum_osr_bytes_compiled; }
375 static int get_sum_standard_bytes_compiled() { return _sum_standard_bytes_compiled; }
376 static int get_sum_nmethod_size() { return _sum_nmethod_size;}
377 static int get_sum_nmethod_code_size() { return _sum_nmethod_code_size; }
378 static long get_peak_compilation_time() { return _peak_compilation_time; }
379 static long get_total_compilation_time() { return _t_total_compilation.milliseconds(); }
380
381 // Log that compilation profiling is skipped because metaspace is full.
382 static void log_metaspace_failure();
383 };
384
385 #endif // SHARE_VM_COMPILER_COMPILEBROKER_HPP