1 /*
2 * Copyright (c) 1999, 2011, 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 #include "precompiled.hpp"
26 #include "c1/c1_CFGPrinter.hpp"
27 #include "c1/c1_Compilation.hpp"
28 #include "c1/c1_IR.hpp"
29 #include "c1/c1_LIRAssembler.hpp"
30 #include "c1/c1_LinearScan.hpp"
31 #include "c1/c1_MacroAssembler.hpp"
32 #include "c1/c1_ValueMap.hpp"
33 #include "c1/c1_ValueStack.hpp"
34 #include "code/debugInfoRec.hpp"
35
36
37 typedef enum {
38 _t_compile,
39 _t_setup,
40 _t_optimizeIR,
41 _t_buildIR,
42 _t_emit_lir,
43 _t_linearScan,
44 _t_lirGeneration,
45 _t_lir_schedule,
46 _t_codeemit,
47 _t_codeinstall,
48 max_phase_timers
49 } TimerName;
50
51 static const char * timer_name[] = {
52 "compile",
53 "setup",
54 "optimizeIR",
55 "buildIR",
56 "emit_lir",
57 "linearScan",
58 "lirGeneration",
59 "lir_schedule",
60 "codeemit",
61 "codeinstall"
62 };
63
64 static elapsedTimer timers[max_phase_timers];
65 static int totalInstructionNodes = 0;
66
67 class PhaseTraceTime: public TraceTime {
68 private:
69 JavaThread* _thread;
70
71 public:
72 PhaseTraceTime(TimerName timer):
73 TraceTime("", &timers[timer], CITime || CITimeEach, Verbose) {
74 }
75 };
76
77 // Implementation of Compilation
78
79
80 #ifndef PRODUCT
81
82 void Compilation::maybe_print_current_instruction() {
83 if (_current_instruction != NULL && _last_instruction_printed != _current_instruction) {
84 _last_instruction_printed = _current_instruction;
85 _current_instruction->print_line();
86 }
87 }
88 #endif // PRODUCT
89
90
91 DebugInformationRecorder* Compilation::debug_info_recorder() const {
92 return _env->debug_info();
93 }
94
95
96 Dependencies* Compilation::dependency_recorder() const {
97 return _env->dependencies();
98 }
99
100
101 void Compilation::initialize() {
102 // Use an oop recorder bound to the CI environment.
103 // (The default oop recorder is ignorant of the CI.)
104 OopRecorder* ooprec = new OopRecorder(_env->arena());
105 _env->set_oop_recorder(ooprec);
106 _env->set_debug_info(new DebugInformationRecorder(ooprec));
107 debug_info_recorder()->set_oopmaps(new OopMapSet());
108 _env->set_dependencies(new Dependencies(_env));
109 }
110
111
112 void Compilation::build_hir() {
113 CHECK_BAILOUT();
114
115 // setup ir
116 _hir = new IR(this, method(), osr_bci());
117 if (!_hir->is_valid()) {
118 bailout("invalid parsing");
119 return;
120 }
121
122 #ifndef PRODUCT
123 if (PrintCFGToFile) {
124 CFGPrinter::print_cfg(_hir, "After Generation of HIR", true, false);
125 }
126 #endif
127
128 #ifndef PRODUCT
129 if (PrintCFG || PrintCFG0) { tty->print_cr("CFG after parsing"); _hir->print(true); }
130 if (PrintIR || PrintIR0 ) { tty->print_cr("IR after parsing"); _hir->print(false); }
131 #endif
132
133 _hir->verify();
134
135 if (UseC1Optimizations) {
136 NEEDS_CLEANUP
137 // optimization
138 PhaseTraceTime timeit(_t_optimizeIR);
139
140 _hir->optimize();
141 }
142
143 _hir->verify();
144
145 _hir->split_critical_edges();
146
147 #ifndef PRODUCT
148 if (PrintCFG || PrintCFG1) { tty->print_cr("CFG after optimizations"); _hir->print(true); }
149 if (PrintIR || PrintIR1 ) { tty->print_cr("IR after optimizations"); _hir->print(false); }
150 #endif
151
152 _hir->verify();
153
154 // compute block ordering for code generation
155 // the control flow must not be changed from here on
156 _hir->compute_code();
157
158 if (UseGlobalValueNumbering) {
159 ResourceMark rm;
160 int instructions = Instruction::number_of_instructions();
161 GlobalValueNumbering gvn(_hir);
162 assert(instructions == Instruction::number_of_instructions(),
163 "shouldn't have created an instructions");
164 }
165
166 // compute use counts after global value numbering
167 _hir->compute_use_counts();
168
169 #ifndef PRODUCT
170 if (PrintCFG || PrintCFG2) { tty->print_cr("CFG before code generation"); _hir->code()->print(true); }
171 if (PrintIR || PrintIR2 ) { tty->print_cr("IR before code generation"); _hir->code()->print(false, true); }
172 #endif
173
174 _hir->verify();
175 }
176
177
178 void Compilation::emit_lir() {
179 CHECK_BAILOUT();
180
181 LIRGenerator gen(this, method());
182 {
183 PhaseTraceTime timeit(_t_lirGeneration);
184 hir()->iterate_linear_scan_order(&gen);
185 }
186
187 CHECK_BAILOUT();
188
189 {
190 PhaseTraceTime timeit(_t_linearScan);
191
192 LinearScan* allocator = new LinearScan(hir(), &gen, frame_map());
193 set_allocator(allocator);
194 // Assign physical registers to LIR operands using a linear scan algorithm.
195 allocator->do_linear_scan();
196 CHECK_BAILOUT();
197
198 _max_spills = allocator->max_spills();
199 }
200
201 if (BailoutAfterLIR) {
202 if (PrintLIR && !bailed_out()) {
203 print_LIR(hir()->code());
204 }
205 bailout("Bailing out because of -XX:+BailoutAfterLIR");
206 }
207 }
208
209
210 void Compilation::emit_code_epilog(LIR_Assembler* assembler) {
211 CHECK_BAILOUT();
212
213 CodeOffsets* code_offsets = assembler->offsets();
214
215 // generate code or slow cases
216 assembler->emit_slow_case_stubs();
217 CHECK_BAILOUT();
218
219 // generate exception adapters
220 assembler->emit_exception_entries(exception_info_list());
221 CHECK_BAILOUT();
222
223 // Generate code for exception handler.
224 code_offsets->set_value(CodeOffsets::Exceptions, assembler->emit_exception_handler());
225 CHECK_BAILOUT();
226
227 // Generate code for deopt handler.
228 code_offsets->set_value(CodeOffsets::Deopt, assembler->emit_deopt_handler());
229 CHECK_BAILOUT();
230
231 // Emit the MethodHandle deopt handler code (if required).
232 if (has_method_handle_invokes()) {
233 // We can use the same code as for the normal deopt handler, we
234 // just need a different entry point address.
235 code_offsets->set_value(CodeOffsets::DeoptMH, assembler->emit_deopt_handler());
236 CHECK_BAILOUT();
237 }
238
239 // Emit the handler to remove the activation from the stack and
240 // dispatch to the caller.
241 offsets()->set_value(CodeOffsets::UnwindHandler, assembler->emit_unwind_handler());
242
243 // done
244 masm()->flush();
245 }
246
247
248 bool Compilation::setup_code_buffer(CodeBuffer* code, int call_stub_estimate) {
249 // Preinitialize the consts section to some large size:
250 int locs_buffer_size = 20 * (relocInfo::length_limit + sizeof(relocInfo));
251 char* locs_buffer = NEW_RESOURCE_ARRAY(char, locs_buffer_size);
252 code->insts()->initialize_shared_locs((relocInfo*)locs_buffer,
253 locs_buffer_size / sizeof(relocInfo));
254 code->initialize_consts_size(Compilation::desired_max_constant_size());
255 // Call stubs + two deopt handlers (regular and MH) + exception handler
256 int stub_size = (call_stub_estimate * LIR_Assembler::call_stub_size) +
257 LIR_Assembler::exception_handler_size +
258 (2 * LIR_Assembler::deopt_handler_size);
259 if (stub_size >= code->insts_capacity()) return false;
260 code->initialize_stubs_size(stub_size);
261 return true;
262 }
263
264
265 int Compilation::emit_code_body() {
266 // emit code
267 if (!setup_code_buffer(code(), allocator()->num_calls())) {
268 BAILOUT_("size requested greater than avail code buffer size", 0);
269 }
270 code()->initialize_oop_recorder(env()->oop_recorder());
271
272 _masm = new C1_MacroAssembler(code());
273 _masm->set_oop_recorder(env()->oop_recorder());
274
275 LIR_Assembler lir_asm(this);
276
277 lir_asm.emit_code(hir()->code());
278 CHECK_BAILOUT_(0);
279
280 emit_code_epilog(&lir_asm);
281 CHECK_BAILOUT_(0);
282
283 generate_exception_handler_table();
284
285 #ifndef PRODUCT
286 if (PrintExceptionHandlers && Verbose) {
287 exception_handler_table()->print();
288 }
289 #endif /* PRODUCT */
290
291 return frame_map()->framesize();
292 }
293
294
295 int Compilation::compile_java_method() {
296 assert(!method()->is_native(), "should not reach here");
297
298 if (BailoutOnExceptionHandlers) {
299 if (method()->has_exception_handlers()) {
300 bailout("linear scan can't handle exception handlers");
301 }
302 }
303
304 CHECK_BAILOUT_(no_frame_size);
305
306 if (is_profiling() && !method()->ensure_method_data()) {
307 BAILOUT_("mdo allocation failed", no_frame_size);
308 }
309
310 {
311 PhaseTraceTime timeit(_t_buildIR);
312 build_hir();
313 }
314 if (BailoutAfterHIR) {
315 BAILOUT_("Bailing out because of -XX:+BailoutAfterHIR", no_frame_size);
316 }
317
318
319 {
320 PhaseTraceTime timeit(_t_emit_lir);
321
322 _frame_map = new FrameMap(method(), hir()->number_of_locks(), MAX2(4, hir()->max_stack()));
323 emit_lir();
324 }
325 CHECK_BAILOUT_(no_frame_size);
326
327 {
328 PhaseTraceTime timeit(_t_codeemit);
329 return emit_code_body();
330 }
331 }
332
333 void Compilation::install_code(int frame_size) {
334 // frame_size is in 32-bit words so adjust it intptr_t words
335 assert(frame_size == frame_map()->framesize(), "must match");
336 assert(in_bytes(frame_map()->framesize_in_bytes()) % sizeof(intptr_t) == 0, "must be at least pointer aligned");
337 _env->register_method(
338 method(),
339 osr_bci(),
340 &_offsets,
341 in_bytes(_frame_map->sp_offset_for_orig_pc()),
342 code(),
343 in_bytes(frame_map()->framesize_in_bytes()) / sizeof(intptr_t),
344 debug_info_recorder()->_oopmaps,
345 exception_handler_table(),
346 implicit_exception_table(),
347 compiler(),
348 _env->comp_level(),
349 has_unsafe_access()
350 );
351 }
352
353
354 void Compilation::compile_method() {
355 // setup compilation
356 initialize();
357
358 if (!method()->can_be_compiled()) {
359 // Prevent race condition 6328518.
360 // This can happen if the method is obsolete or breakpointed.
361 bailout("Bailing out because method is not compilable");
362 return;
363 }
364
365 if (_env->jvmti_can_hotswap_or_post_breakpoint()) {
366 // We can assert evol_method because method->can_be_compiled is true.
367 dependency_recorder()->assert_evol_method(method());
368 }
369
370 if (method()->break_at_execute()) {
371 BREAKPOINT;
372 }
373
374 #ifndef PRODUCT
375 if (PrintCFGToFile) {
376 CFGPrinter::print_compilation(this);
377 }
378 #endif
379
380 // compile method
381 int frame_size = compile_java_method();
382
383 // bailout if method couldn't be compiled
384 // Note: make sure we mark the method as not compilable!
385 CHECK_BAILOUT();
386
387 if (InstallMethods) {
388 // install code
389 PhaseTraceTime timeit(_t_codeinstall);
390 install_code(frame_size);
391 }
392 totalInstructionNodes += Instruction::number_of_instructions();
393 }
394
395
396 void Compilation::generate_exception_handler_table() {
397 // Generate an ExceptionHandlerTable from the exception handler
398 // information accumulated during the compilation.
399 ExceptionInfoList* info_list = exception_info_list();
400
401 if (info_list->length() == 0) {
402 return;
403 }
404
405 // allocate some arrays for use by the collection code.
406 const int num_handlers = 5;
407 GrowableArray<intptr_t>* bcis = new GrowableArray<intptr_t>(num_handlers);
408 GrowableArray<intptr_t>* scope_depths = new GrowableArray<intptr_t>(num_handlers);
409 GrowableArray<intptr_t>* pcos = new GrowableArray<intptr_t>(num_handlers);
410
411 for (int i = 0; i < info_list->length(); i++) {
412 ExceptionInfo* info = info_list->at(i);
413 XHandlers* handlers = info->exception_handlers();
414
415 // empty the arrays
416 bcis->trunc_to(0);
417 scope_depths->trunc_to(0);
418 pcos->trunc_to(0);
419
420 for (int i = 0; i < handlers->length(); i++) {
421 XHandler* handler = handlers->handler_at(i);
422 assert(handler->entry_pco() != -1, "must have been generated");
423
424 int e = bcis->find(handler->handler_bci());
425 if (e >= 0 && scope_depths->at(e) == handler->scope_count()) {
426 // two different handlers are declared to dispatch to the same
427 // catch bci. During parsing we created edges for each
428 // handler but we really only need one. The exception handler
429 // table will also get unhappy if we try to declare both since
430 // it's nonsensical. Just skip this handler.
431 continue;
432 }
433
434 bcis->append(handler->handler_bci());
435 if (handler->handler_bci() == -1) {
436 // insert a wildcard handler at scope depth 0 so that the
437 // exception lookup logic with find it.
438 scope_depths->append(0);
439 } else {
440 scope_depths->append(handler->scope_count());
441 }
442 pcos->append(handler->entry_pco());
443
444 // stop processing once we hit a catch any
445 if (handler->is_catch_all()) {
446 assert(i == handlers->length() - 1, "catch all must be last handler");
447 }
448 }
449 exception_handler_table()->add_subtable(info->pco(), bcis, scope_depths, pcos);
450 }
451 }
452
453
454 Compilation::Compilation(AbstractCompiler* compiler, ciEnv* env, ciMethod* method,
455 int osr_bci, BufferBlob* buffer_blob)
456 : _compiler(compiler)
457 , _env(env)
458 , _method(method)
459 , _osr_bci(osr_bci)
460 , _hir(NULL)
461 , _max_spills(-1)
462 , _frame_map(NULL)
463 , _masm(NULL)
464 , _has_exception_handlers(false)
465 , _has_fpu_code(true) // pessimistic assumption
466 , _would_profile(false)
467 , _has_unsafe_access(false)
468 , _has_method_handle_invokes(false)
469 , _bailout_msg(NULL)
470 , _exception_info_list(NULL)
471 , _allocator(NULL)
472 , _next_id(0)
473 , _next_block_id(0)
474 , _code(buffer_blob)
475 , _current_instruction(NULL)
476 #ifndef PRODUCT
477 , _last_instruction_printed(NULL)
478 #endif // PRODUCT
479 {
480 PhaseTraceTime timeit(_t_compile);
481 _arena = Thread::current()->resource_area();
482 _env->set_compiler_data(this);
483 _exception_info_list = new ExceptionInfoList();
484 _implicit_exception_table.set_size(0);
485 compile_method();
486 if (bailed_out()) {
487 _env->record_method_not_compilable(bailout_msg(), !TieredCompilation);
488 if (is_profiling()) {
489 // Compilation failed, create MDO, which would signal the interpreter
490 // to start profiling on its own.
491 _method->ensure_method_data();
492 }
493 } else if (is_profiling()) {
494 ciMethodData *md = method->method_data_or_null();
495 if (md != NULL) {
496 md->set_would_profile(_would_profile);
497 }
498 }
499 }
500
501 Compilation::~Compilation() {
502 _env->set_compiler_data(NULL);
503 }
504
505
506 void Compilation::add_exception_handlers_for_pco(int pco, XHandlers* exception_handlers) {
507 #ifndef PRODUCT
508 if (PrintExceptionHandlers && Verbose) {
509 tty->print_cr(" added exception scope for pco %d", pco);
510 }
511 #endif
512 // Note: we do not have program counters for these exception handlers yet
513 exception_info_list()->push(new ExceptionInfo(pco, exception_handlers));
514 }
515
516
517 void Compilation::notice_inlined_method(ciMethod* method) {
518 _env->notice_inlined_method(method);
519 }
520
521
522 void Compilation::bailout(const char* msg) {
523 assert(msg != NULL, "bailout message must exist");
524 if (!bailed_out()) {
525 // keep first bailout message
526 if (PrintBailouts) tty->print_cr("compilation bailout: %s", msg);
527 _bailout_msg = msg;
528 }
529 }
530
531
532 void Compilation::print_timers() {
533 // tty->print_cr(" Native methods : %6.3f s, Average : %2.3f", CompileBroker::_t_native_compilation.seconds(), CompileBroker::_t_native_compilation.seconds() / CompileBroker::_total_native_compile_count);
534 float total = timers[_t_setup].seconds() + timers[_t_buildIR].seconds() + timers[_t_emit_lir].seconds() + timers[_t_lir_schedule].seconds() + timers[_t_codeemit].seconds() + timers[_t_codeinstall].seconds();
535
536
537 tty->print_cr(" Detailed C1 Timings");
538 tty->print_cr(" Setup time: %6.3f s (%4.1f%%)", timers[_t_setup].seconds(), (timers[_t_setup].seconds() / total) * 100.0);
539 tty->print_cr(" Build IR: %6.3f s (%4.1f%%)", timers[_t_buildIR].seconds(), (timers[_t_buildIR].seconds() / total) * 100.0);
540 tty->print_cr(" Optimize: %6.3f s (%4.1f%%)", timers[_t_optimizeIR].seconds(), (timers[_t_optimizeIR].seconds() / total) * 100.0);
541 tty->print_cr(" Emit LIR: %6.3f s (%4.1f%%)", timers[_t_emit_lir].seconds(), (timers[_t_emit_lir].seconds() / total) * 100.0);
542 tty->print_cr(" LIR Gen: %6.3f s (%4.1f%%)", timers[_t_lirGeneration].seconds(), (timers[_t_lirGeneration].seconds() / total) * 100.0);
543 tty->print_cr(" Linear Scan: %6.3f s (%4.1f%%)", timers[_t_linearScan].seconds(), (timers[_t_linearScan].seconds() / total) * 100.0);
544 NOT_PRODUCT(LinearScan::print_timers(timers[_t_linearScan].seconds()));
545 tty->print_cr(" LIR Schedule: %6.3f s (%4.1f%%)", timers[_t_lir_schedule].seconds(), (timers[_t_lir_schedule].seconds() / total) * 100.0);
546 tty->print_cr(" Code Emission: %6.3f s (%4.1f%%)", timers[_t_codeemit].seconds(), (timers[_t_codeemit].seconds() / total) * 100.0);
547 tty->print_cr(" Code Installation: %6.3f s (%4.1f%%)", timers[_t_codeinstall].seconds(), (timers[_t_codeinstall].seconds() / total) * 100.0);
548 tty->print_cr(" Instruction Nodes: %6d nodes", totalInstructionNodes);
549
550 NOT_PRODUCT(LinearScan::print_statistics());
551 }
552
553
554 #ifndef PRODUCT
555 void Compilation::compile_only_this_method() {
556 ResourceMark rm;
557 fileStream stream(fopen("c1_compile_only", "wt"));
558 stream.print_cr("# c1 compile only directives");
559 compile_only_this_scope(&stream, hir()->top_scope());
560 }
561
562
563 void Compilation::compile_only_this_scope(outputStream* st, IRScope* scope) {
564 st->print("CompileOnly=");
565 scope->method()->holder()->name()->print_symbol_on(st);
566 st->print(".");
567 scope->method()->name()->print_symbol_on(st);
568 st->cr();
569 }
570
571
572 void Compilation::exclude_this_method() {
573 fileStream stream(fopen(".hotspot_compiler", "at"));
574 stream.print("exclude ");
575 method()->holder()->name()->print_symbol_on(&stream);
576 stream.print(" ");
577 method()->name()->print_symbol_on(&stream);
578 stream.cr();
579 stream.cr();
580 }
581 #endif