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