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