1 /*
2 * Copyright (c) 1999, 2014, 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 "runtime/perfData.hpp"
31
32 class nmethod;
33 class nmethodLocker;
34
35 // CompileTask
36 //
37 // An entry in the compile queue. It represents a pending or current
38 // compilation.
39 class CompileTask : public CHeapObj<mtCompiler> {
40 friend class VMStructs;
41
42 private:
43 static CompileTask* _task_free_list;
44 #ifdef ASSERT
45 static int _num_allocated_tasks;
46 #endif
47
48 Monitor* _lock;
49 uint _compile_id;
50 Method* _method;
51 jobject _method_holder;
52 int _osr_bci;
53 bool _is_complete;
54 bool _is_success;
55 bool _is_blocking;
56 int _comp_level;
57 int _num_inlined_bytecodes;
58 nmethodLocker* _code_handle; // holder of eventual result
59 CompileTask* _next, *_prev;
60 bool _is_free;
61 // Fields used for logging why the compilation was initiated:
62 jlong _time_queued; // in units of os::elapsed_counter()
63 Method* _hot_method; // which method actually triggered this task
64 jobject _hot_method_holder;
65 int _hot_count; // information about its invocation counter
66 const char* _comment; // more info about the task
67 const char* _failure_reason;
68
69 public:
70 CompileTask() {
71 _lock = new Monitor(Mutex::nonleaf+2, "CompileTaskLock");
72 }
73
74 void initialize(int compile_id, methodHandle method, int osr_bci, int comp_level,
75 methodHandle hot_method, int hot_count, const char* comment,
76 bool is_blocking);
77
78 static CompileTask* allocate();
79 static void free(CompileTask* task);
80
81 int compile_id() const { return _compile_id; }
82 Method* method() const { return _method; }
83 Method* hot_method() const { return _hot_method; }
84 int osr_bci() const { return _osr_bci; }
85 bool is_complete() const { return _is_complete; }
86 bool is_blocking() const { return _is_blocking; }
87 bool is_success() const { return _is_success; }
88
89 nmethodLocker* code_handle() const { return _code_handle; }
90 void set_code_handle(nmethodLocker* l) { _code_handle = l; }
91 nmethod* code() const; // _code_handle->code()
92 void set_code(nmethod* nm); // _code_handle->set_code(nm)
93
94 Monitor* lock() const { return _lock; }
95
96 void mark_complete() { _is_complete = true; }
97 void mark_success() { _is_success = true; }
98
99 int comp_level() { return _comp_level;}
100 void set_comp_level(int comp_level) { _comp_level = comp_level;}
101
102 int num_inlined_bytecodes() const { return _num_inlined_bytecodes; }
103 void set_num_inlined_bytecodes(int n) { _num_inlined_bytecodes = n; }
104
105 CompileTask* next() const { return _next; }
106 void set_next(CompileTask* next) { _next = next; }
107 CompileTask* prev() const { return _prev; }
108 void set_prev(CompileTask* prev) { _prev = prev; }
109 bool is_free() const { return _is_free; }
110 void set_is_free(bool val) { _is_free = val; }
111
112 // RedefineClasses support
113 void metadata_do(void f(Metadata*));
114
115 private:
116 static void print_compilation_impl(outputStream* st, Method* method, int compile_id, int comp_level,
117 bool is_osr_method = false, int osr_bci = -1, bool is_blocking = false,
118 const char* msg = NULL, bool short_form = false, bool cr = true);
119
120 public:
121 void print_compilation(outputStream* st = tty, const char* msg = NULL, bool short_form = false, bool cr = true);
122 static void print_compilation(outputStream* st, const nmethod* nm, const char* msg = NULL, bool short_form = false, bool cr = true) {
123 print_compilation_impl(st, nm->method(), nm->compile_id(), nm->comp_level(),
124 nm->is_osr_method(), nm->is_osr_method() ? nm->osr_entry_bci() : -1, /*is_blocking*/ false,
125 msg, short_form, cr);
126 }
127
128 static void print_inlining(outputStream* st, ciMethod* method, int inline_level, int bci, const char* msg = NULL);
129 static void print_inlining(ciMethod* method, int inline_level, int bci, const char* msg = NULL) {
130 print_inlining(tty, method, inline_level, bci, msg);
131 }
132
133 // Redefine Classes support
134 void mark_on_stack();
135
136 static void print_inline_indent(int inline_level, outputStream* st = tty);
137
138 void print_tty();
139 void print_line_on_error(outputStream* st, char* buf, int buflen);
140
141 void log_task(xmlStream* log);
142 void log_task_queued();
143 void log_task_start(CompileLog* log);
144 void log_task_done(CompileLog* log);
145
146 void set_failure_reason(const char* reason) {
147 _failure_reason = reason;
148 }
149 };
150
151 // CompilerCounters
152 //
153 // Per Compiler Performance Counters.
154 //
155 class CompilerCounters : public CHeapObj<mtCompiler> {
156
157 public:
158 enum {
159 cmname_buffer_length = 160
160 };
161
162 private:
163
164 char _current_method[cmname_buffer_length];
165 PerfStringVariable* _perf_current_method;
166
167 int _compile_type;
168 PerfVariable* _perf_compile_type;
169
170 PerfCounter* _perf_time;
171 PerfCounter* _perf_compiles;
172
173 public:
174 CompilerCounters(const char* name, int instance, TRAPS);
175
176 // these methods should be called in a thread safe context
177
178 void set_current_method(const char* method) {
179 strncpy(_current_method, method, (size_t)cmname_buffer_length-1);
180 _current_method[cmname_buffer_length-1] = '\0';
181 if (UsePerfData) _perf_current_method->set_value(method);
182 }
183
184 char* current_method() { return _current_method; }
185
186 void set_compile_type(int compile_type) {
187 _compile_type = compile_type;
188 if (UsePerfData) _perf_compile_type->set_value((jlong)compile_type);
189 }
190
191 int compile_type() { return _compile_type; }
192
193 PerfCounter* time_counter() { return _perf_time; }
194 PerfCounter* compile_counter() { return _perf_compiles; }
195 };
196
197 // CompileQueue
198 //
199 // A list of CompileTasks.
200 class CompileQueue : public CHeapObj<mtCompiler> {
201 private:
202 const char* _name;
203
204 CompileTask* _first;
205 CompileTask* _last;
206
207 CompileTask* _first_stale;
208
209 int _size;
210
211 void purge_stale_tasks();
212 public:
213 CompileQueue(const char* name) {
214 _name = name;
215 _first = NULL;
216 _last = NULL;
217 _size = 0;
218 _first_stale = NULL;
219 }
220
221 const char* name() const { return _name; }
222
223 void add(CompileTask* task);
224 void remove(CompileTask* task);
225 void remove_and_mark_stale(CompileTask* task);
226 CompileTask* first() { return _first; }
227 CompileTask* last() { return _last; }
228
229 CompileTask* get();
230
231 bool is_empty() const { return _first == NULL; }
232 int size() const { return _size; }
233
234
235 // Redefine Classes support
236 void mark_on_stack();
237 void free_all();
238 void print_tty();
239 void print(outputStream* st = tty);
240
241 ~CompileQueue() {
242 assert (is_empty(), " Compile Queue must be empty");
243 }
244 };
245
246 // CompileTaskWrapper
247 //
248 // Assign this task to the current thread. Deallocate the task
249 // when the compilation is complete.
250 class CompileTaskWrapper : StackObj {
251 public:
252 CompileTaskWrapper(CompileTask* task);
253 ~CompileTaskWrapper();
254 };
255
256
257 // Compilation
258 //
259 // The broker for all compilation requests.
260 class CompileBroker: AllStatic {
261 friend class Threads;
262 friend class CompileTaskWrapper;
263
264 public:
265 enum {
266 name_buffer_length = 100
267 };
268
269 // Compile type Information for print_last_compile() and CompilerCounters
270 enum { no_compile, normal_compile, osr_compile, native_compile };
271 static int assign_compile_id (methodHandle method, int osr_bci);
272
273
274 private:
275 static bool _initialized;
276 static volatile bool _should_block;
277
278 // This flag can be used to stop compilation or turn it back on
279 static volatile jint _should_compile_new_jobs;
280
281 // The installed compiler(s)
282 static AbstractCompiler* _compilers[2];
283
284 // These counters are used for assigning id's to each compilation
285 static volatile jint _compilation_id;
286 static volatile jint _osr_compilation_id;
287
288 static int _last_compile_type;
289 static int _last_compile_level;
290 static char _last_method_compiled[name_buffer_length];
291
292 static CompileQueue* _c2_compile_queue;
293 static CompileQueue* _c1_compile_queue;
294
295 // performance counters
296 static PerfCounter* _perf_total_compilation;
297 static PerfCounter* _perf_native_compilation;
298 static PerfCounter* _perf_osr_compilation;
299 static PerfCounter* _perf_standard_compilation;
300
301 static PerfCounter* _perf_total_bailout_count;
302 static PerfCounter* _perf_total_invalidated_count;
303 static PerfCounter* _perf_total_compile_count;
304 static PerfCounter* _perf_total_native_compile_count;
305 static PerfCounter* _perf_total_osr_compile_count;
306 static PerfCounter* _perf_total_standard_compile_count;
307
308 static PerfCounter* _perf_sum_osr_bytes_compiled;
309 static PerfCounter* _perf_sum_standard_bytes_compiled;
310 static PerfCounter* _perf_sum_nmethod_size;
311 static PerfCounter* _perf_sum_nmethod_code_size;
312
313 static PerfStringVariable* _perf_last_method;
314 static PerfStringVariable* _perf_last_failed_method;
315 static PerfStringVariable* _perf_last_invalidated_method;
316 static PerfVariable* _perf_last_compile_type;
317 static PerfVariable* _perf_last_compile_size;
318 static PerfVariable* _perf_last_failed_type;
319 static PerfVariable* _perf_last_invalidated_type;
320
321 // Timers and counters for generating statistics
322 static elapsedTimer _t_total_compilation;
323 static elapsedTimer _t_osr_compilation;
324 static elapsedTimer _t_standard_compilation;
325 static elapsedTimer _t_invalidated_compilation;
326 static elapsedTimer _t_bailedout_compilation;
327
328 static int _total_compile_count;
329 static int _total_bailout_count;
330 static int _total_invalidated_count;
331 static int _total_native_compile_count;
332 static int _total_osr_compile_count;
333 static int _total_standard_compile_count;
334 static int _sum_osr_bytes_compiled;
335 static int _sum_standard_bytes_compiled;
336 static int _sum_nmethod_size;
337 static int _sum_nmethod_code_size;
338 static long _peak_compilation_time;
339
340 static volatile jint _print_compilation_warning;
341
342 static JavaThread* make_thread(const char* name, CompileQueue* queue, CompilerCounters* counters, AbstractCompiler* comp, bool compiler_thread, TRAPS);
343 static void init_compiler_sweeper_threads(int c1_compiler_count, int c2_compiler_count);
344 static bool compilation_is_complete (methodHandle method, int osr_bci, int comp_level);
345 static bool compilation_is_prohibited(methodHandle method, int osr_bci, int comp_level);
346 static bool is_compile_blocking();
347 static void preload_classes (methodHandle method, TRAPS);
348
349 static CompileTask* create_compile_task(CompileQueue* queue,
350 int compile_id,
351 methodHandle method,
352 int osr_bci,
353 int comp_level,
354 methodHandle hot_method,
355 int hot_count,
356 const char* comment,
357 bool blocking);
358 static void wait_for_completion(CompileTask* task);
359
360 static void invoke_compiler_on_method(CompileTask* task);
361 static void set_last_compile(CompilerThread *thread, methodHandle method, bool is_osr, int comp_level);
362 static void push_jni_handle_block();
363 static void pop_jni_handle_block();
364 static bool check_break_at(methodHandle method, int compile_id, bool is_osr);
365 static void collect_statistics(CompilerThread* thread, elapsedTimer time, CompileTask* task);
366
367 static void compile_method_base(methodHandle method,
368 int osr_bci,
369 int comp_level,
370 methodHandle hot_method,
371 int hot_count,
372 const char* comment,
373 Thread* thread);
374
375 static CompileQueue* compile_queue(int comp_level);
376 static bool init_compiler_runtime();
377 static void shutdown_compiler_runtime(AbstractCompiler* comp, CompilerThread* thread);
378
379 public:
380 enum {
381 // The entry bci used for non-OSR compilations.
382 standard_entry_bci = InvocationEntryBci
383 };
384
385 static AbstractCompiler* compiler(int comp_level) {
386 if (is_c2_compile(comp_level)) return _compilers[1]; // C2
387 if (is_c1_compile(comp_level)) return _compilers[0]; // C1
388 return NULL;
389 }
390
391 static bool compilation_is_in_queue(methodHandle method);
392 static void print_compile_queues(outputStream* st);
393 static int queue_size(int comp_level) {
394 CompileQueue *q = compile_queue(comp_level);
395 return q != NULL ? q->size() : 0;
396 }
397 static void compilation_init();
398 static void init_compiler_thread_log();
399 static nmethod* compile_method(methodHandle method,
400 int osr_bci,
401 int comp_level,
402 methodHandle hot_method,
403 int hot_count,
404 const char* comment, Thread* thread);
405
406 static void compiler_thread_loop();
407 static uint get_compilation_id() { return _compilation_id; }
408
409 // Set _should_block.
410 // Call this from the VM, with Threads_lock held and a safepoint requested.
411 static void set_should_block();
412
413 // Call this from the compiler at convenient points, to poll for _should_block.
414 static void maybe_block();
415
416 enum {
417 // Flags for toggling compiler activity
418 stop_compilation = 0,
419 run_compilation = 1,
420 shutdown_compilaton = 2
421 };
422
423 static jint get_compilation_activity_mode() { return _should_compile_new_jobs; }
424 static bool should_compile_new_jobs() { return UseCompiler && (_should_compile_new_jobs == run_compilation); }
425 static bool set_should_compile_new_jobs(jint new_state) {
426 // Return success if the current caller set it
427 jint old = Atomic::cmpxchg(new_state, &_should_compile_new_jobs, 1-new_state);
428 return (old == (1-new_state));
429 }
430
431 static void disable_compilation_forever() {
432 UseCompiler = false;
433 AlwaysCompileLoopMethods = false;
434 Atomic::xchg(shutdown_compilaton, &_should_compile_new_jobs);
435 }
436
437 static bool is_compilation_disabled_forever() {
438 return _should_compile_new_jobs == shutdown_compilaton;
439 }
440 static void handle_full_code_cache(int code_blob_type);
441 // Ensures that warning is only printed once.
442 static bool should_print_compiler_warning() {
443 jint old = Atomic::cmpxchg(1, &_print_compilation_warning, 0);
444 return old == 0;
445 }
446 // Return total compilation ticks
447 static jlong total_compilation_ticks() {
448 return _perf_total_compilation != NULL ? _perf_total_compilation->get_value() : 0;
449 }
450
451 // Redefine Classes support
452 static void mark_on_stack();
453
454 // Print a detailed accounting of compilation time
455 static void print_times();
456
457 // Debugging output for failure
458 static void print_last_compile();
459
460 static void print_compiler_threads_on(outputStream* st);
461
462 // compiler name for debugging
463 static const char* compiler_name(int comp_level);
464
465 static int get_total_compile_count() { return _total_compile_count; }
466 static int get_total_bailout_count() { return _total_bailout_count; }
467 static int get_total_invalidated_count() { return _total_invalidated_count; }
468 static int get_total_native_compile_count() { return _total_native_compile_count; }
469 static int get_total_osr_compile_count() { return _total_osr_compile_count; }
470 static int get_total_standard_compile_count() { return _total_standard_compile_count; }
471 static int get_sum_osr_bytes_compiled() { return _sum_osr_bytes_compiled; }
472 static int get_sum_standard_bytes_compiled() { return _sum_standard_bytes_compiled; }
473 static int get_sum_nmethod_size() { return _sum_nmethod_size;}
474 static int get_sum_nmethod_code_size() { return _sum_nmethod_code_size; }
475 static long get_peak_compilation_time() { return _peak_compilation_time; }
476 static long get_total_compilation_time() { return _t_total_compilation.milliseconds(); }
477
478 // Log that compilation profiling is skipped because metaspace is full.
479 static void log_metaspace_failure();
480 };
481
482 #endif // SHARE_VM_COMPILER_COMPILEBROKER_HPP