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