1 /*
   2  * Copyright (c) 1998, 2012, 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 "ci/ciCallSite.hpp"
  27 #include "ci/ciMethodHandle.hpp"
  28 #include "classfile/vmSymbols.hpp"
  29 #include "compiler/compileBroker.hpp"
  30 #include "compiler/compileLog.hpp"
  31 #include "interpreter/linkResolver.hpp"
  32 #include "opto/addnode.hpp"
  33 #include "opto/callGenerator.hpp"
  34 #include "opto/cfgnode.hpp"
  35 #include "opto/mulnode.hpp"
  36 #include "opto/parse.hpp"
  37 #include "opto/rootnode.hpp"
  38 #include "opto/runtime.hpp"
  39 #include "opto/subnode.hpp"
  40 #include "prims/nativeLookup.hpp"
  41 #include "runtime/sharedRuntime.hpp"
  42 
  43 void trace_type_profile(Compile* C, ciMethod *method, int depth, int bci, ciMethod *prof_method, ciKlass *prof_klass, int site_count, int receiver_count) {
  44   if (TraceTypeProfile || C->print_inlining()) {
  45     outputStream* out = tty;
  46     if (!C->print_inlining()) {
  47       if (NOT_PRODUCT(!PrintOpto &&) !PrintCompilation) {
  48         method->print_short_name();
  49         tty->cr();
  50       }
  51       CompileTask::print_inlining(prof_method, depth, bci);
  52     } else {
  53       out = C->print_inlining_stream();
  54     }
  55     CompileTask::print_inline_indent(depth, out);
  56     out->print(" \\-> TypeProfile (%d/%d counts) = ", receiver_count, site_count);
  57     stringStream ss;
  58     prof_klass->name()->print_symbol_on(&ss);
  59     out->print(ss.as_string());
  60     out->cr();
  61   }
  62 }
  63 
  64 CallGenerator* Compile::call_generator(ciMethod* callee, int vtable_index, bool call_does_dispatch,
  65                                        JVMState* jvms, bool allow_inline,
  66                                        float prof_factor, bool allow_intrinsics, bool delayed_forbidden) {
  67   ciMethod*       caller   = jvms->method();
  68   int             bci      = jvms->bci();
  69   Bytecodes::Code bytecode = caller->java_code_at_bci(bci);
  70   guarantee(callee != NULL, "failed method resolution");
  71 
  72   // Dtrace currently doesn't work unless all calls are vanilla
  73   if (env()->dtrace_method_probes()) {
  74     allow_inline = false;
  75   }
  76 
  77   // Note: When we get profiling during stage-1 compiles, we want to pull
  78   // from more specific profile data which pertains to this inlining.
  79   // Right now, ignore the information in jvms->caller(), and do method[bci].
  80   ciCallProfile profile = caller->call_profile_at_bci(bci);
  81 
  82   // See how many times this site has been invoked.
  83   int site_count = profile.count();
  84   int receiver_count = -1;
  85   if (call_does_dispatch && UseTypeProfile && profile.has_receiver(0)) {
  86     // Receivers in the profile structure are ordered by call counts
  87     // so that the most called (major) receiver is profile.receiver(0).
  88     receiver_count = profile.receiver_count(0);
  89   }
  90 
  91   CompileLog* log = this->log();
  92   if (log != NULL) {
  93     int rid = (receiver_count >= 0)? log->identify(profile.receiver(0)): -1;
  94     int r2id = (rid != -1 && profile.has_receiver(1))? log->identify(profile.receiver(1)):-1;
  95     log->begin_elem("call method='%d' count='%d' prof_factor='%g'",
  96                     log->identify(callee), site_count, prof_factor);
  97     if (call_does_dispatch)  log->print(" virtual='1'");
  98     if (allow_inline)     log->print(" inline='1'");
  99     if (receiver_count >= 0) {
 100       log->print(" receiver='%d' receiver_count='%d'", rid, receiver_count);
 101       if (profile.has_receiver(1)) {
 102         log->print(" receiver2='%d' receiver2_count='%d'", r2id, profile.receiver_count(1));
 103       }
 104     }
 105     log->end_elem();
 106   }
 107 
 108   // Special case the handling of certain common, profitable library
 109   // methods.  If these methods are replaced with specialized code,
 110   // then we return it as the inlined version of the call.
 111   // We do this before the strict f.p. check below because the
 112   // intrinsics handle strict f.p. correctly.
 113   if (allow_inline && allow_intrinsics) {
 114     CallGenerator* cg = find_intrinsic(callee, call_does_dispatch);
 115     if (cg != NULL) {
 116       if (cg->is_predicted()) {
 117         // Code without intrinsic but, hopefully, inlined.
 118         CallGenerator* inline_cg = this->call_generator(callee,
 119               vtable_index, call_does_dispatch, jvms, allow_inline, prof_factor, false);
 120         if (inline_cg != NULL) {
 121           cg = CallGenerator::for_predicted_intrinsic(cg, inline_cg);
 122         }
 123       }
 124       return cg;
 125     }
 126   }
 127 
 128   // Do method handle calls.
 129   // NOTE: This must happen before normal inlining logic below since
 130   // MethodHandle.invoke* are native methods which obviously don't
 131   // have bytecodes and so normal inlining fails.
 132   if (callee->is_method_handle_intrinsic()) {
 133     CallGenerator* cg = CallGenerator::for_method_handle_call(jvms, caller, callee, delayed_forbidden);
 134     assert(cg == NULL || !delayed_forbidden || !cg->is_late_inline() || cg->is_mh_late_inline(), "unexpected CallGenerator");
 135     return cg;
 136   }
 137 
 138   // Do not inline strict fp into non-strict code, or the reverse
 139   if (caller->is_strict() ^ callee->is_strict()) {
 140     allow_inline = false;
 141   }
 142 
 143   // Attempt to inline...
 144   if (allow_inline) {
 145     // The profile data is only partly attributable to this caller,
 146     // scale back the call site information.
 147     float past_uses = jvms->method()->scale_count(site_count, prof_factor);
 148     // This is the number of times we expect the call code to be used.
 149     float expected_uses = past_uses;
 150 
 151     // Try inlining a bytecoded method:
 152     if (!call_does_dispatch) {
 153       InlineTree* ilt;
 154       if (UseOldInlining) {
 155         ilt = InlineTree::find_subtree_from_root(this->ilt(), jvms->caller(), jvms->method());
 156       } else {
 157         // Make a disembodied, stateless ILT.
 158         // TO DO:  When UseOldInlining is removed, copy the ILT code elsewhere.
 159         float site_invoke_ratio = prof_factor;
 160         // Note:  ilt is for the root of this parse, not the present call site.
 161         ilt = new InlineTree(this, jvms->method(), jvms->caller(), site_invoke_ratio, MaxInlineLevel);
 162       }
 163       WarmCallInfo scratch_ci;
 164       if (!UseOldInlining)
 165         scratch_ci.init(jvms, callee, profile, prof_factor);
 166       bool should_delay = false;
 167       WarmCallInfo* ci = ilt->ok_to_inline(callee, jvms, profile, &scratch_ci, should_delay);
 168       assert(ci != &scratch_ci, "do not let this pointer escape");
 169       bool allow_inline   = (ci != NULL && !ci->is_cold());
 170       bool require_inline = (allow_inline && ci->is_hot());
 171 
 172       if (allow_inline) {
 173         CallGenerator* cg = CallGenerator::for_inline(callee, expected_uses);
 174 
 175         if (require_inline && cg != NULL) {
 176           // Delay the inlining of this method to give us the
 177           // opportunity to perform some high level optimizations
 178           // first.
 179           if (should_delay_string_inlining(callee, jvms)) {
 180             assert(!delayed_forbidden, "strange");
 181             return CallGenerator::for_string_late_inline(callee, cg);
 182           } else if (should_delay_boxing_inlining(callee, jvms)) {
 183             assert(!delayed_forbidden, "strange");
 184             return CallGenerator::for_boxing_late_inline(callee, cg);
 185           } else if ((should_delay || AlwaysIncrementalInline) && !delayed_forbidden) {
 186             return CallGenerator::for_late_inline(callee, cg);
 187           }
 188         }
 189         if (cg == NULL || should_delay) {
 190           // Fall through.
 191         } else if (require_inline || !InlineWarmCalls) {
 192           return cg;
 193         } else {
 194           CallGenerator* cold_cg = call_generator(callee, vtable_index, call_does_dispatch, jvms, false, prof_factor);
 195           return CallGenerator::for_warm_call(ci, cold_cg, cg);
 196         }
 197       }
 198     }
 199 
 200     // Try using the type profile.
 201     if (call_does_dispatch && site_count > 0 && receiver_count > 0) {
 202       // The major receiver's count >= TypeProfileMajorReceiverPercent of site_count.
 203       bool have_major_receiver = (100.*profile.receiver_prob(0) >= (float)TypeProfileMajorReceiverPercent);
 204       ciMethod* receiver_method = NULL;
 205       if (have_major_receiver || profile.morphism() == 1 ||
 206           (profile.morphism() == 2 && UseBimorphicInlining)) {
 207         // receiver_method = profile.method();
 208         // Profiles do not suggest methods now.  Look it up in the major receiver.
 209         receiver_method = callee->resolve_invoke(jvms->method()->holder(),
 210                                                       profile.receiver(0));
 211       }
 212       if (receiver_method != NULL) {
 213         // The single majority receiver sufficiently outweighs the minority.
 214         CallGenerator* hit_cg = this->call_generator(receiver_method,
 215               vtable_index, !call_does_dispatch, jvms, allow_inline, prof_factor);
 216         if (hit_cg != NULL) {
 217           // Look up second receiver.
 218           CallGenerator* next_hit_cg = NULL;
 219           ciMethod* next_receiver_method = NULL;
 220           if (profile.morphism() == 2 && UseBimorphicInlining) {
 221             next_receiver_method = callee->resolve_invoke(jvms->method()->holder(),
 222                                                                profile.receiver(1));
 223             if (next_receiver_method != NULL) {
 224               next_hit_cg = this->call_generator(next_receiver_method,
 225                                   vtable_index, !call_does_dispatch, jvms,
 226                                   allow_inline, prof_factor);
 227               if (next_hit_cg != NULL && !next_hit_cg->is_inline() &&
 228                   have_major_receiver && UseOnlyInlinedBimorphic) {
 229                   // Skip if we can't inline second receiver's method
 230                   next_hit_cg = NULL;
 231               }
 232             }
 233           }
 234           CallGenerator* miss_cg;
 235           Deoptimization::DeoptReason reason = (profile.morphism() == 2) ?
 236                                     Deoptimization::Reason_bimorphic :
 237                                     Deoptimization::Reason_class_check;
 238           if (( profile.morphism() == 1 ||
 239                (profile.morphism() == 2 && next_hit_cg != NULL) ) &&
 240               !too_many_traps(jvms->method(), jvms->bci(), reason)
 241              ) {
 242             // Generate uncommon trap for class check failure path
 243             // in case of monomorphic or bimorphic virtual call site.
 244             miss_cg = CallGenerator::for_uncommon_trap(callee, reason,
 245                         Deoptimization::Action_maybe_recompile);
 246           } else {
 247             // Generate virtual call for class check failure path
 248             // in case of polymorphic virtual call site.
 249             miss_cg = CallGenerator::for_virtual_call(callee, vtable_index);
 250           }
 251           if (miss_cg != NULL) {
 252             if (next_hit_cg != NULL) {
 253               trace_type_profile(C, jvms->method(), jvms->depth() - 1, jvms->bci(), next_receiver_method, profile.receiver(1), site_count, profile.receiver_count(1));
 254               // We don't need to record dependency on a receiver here and below.
 255               // Whenever we inline, the dependency is added by Parse::Parse().
 256               miss_cg = CallGenerator::for_predicted_call(profile.receiver(1), miss_cg, next_hit_cg, PROB_MAX);
 257             }
 258             if (miss_cg != NULL) {
 259               trace_type_profile(C, jvms->method(), jvms->depth() - 1, jvms->bci(), receiver_method, profile.receiver(0), site_count, receiver_count);
 260               CallGenerator* cg = CallGenerator::for_predicted_call(profile.receiver(0), miss_cg, hit_cg, profile.receiver_prob(0));
 261               if (cg != NULL)  return cg;
 262             }
 263           }
 264         }
 265       }
 266     }
 267   }
 268 
 269   // There was no special inlining tactic, or it bailed out.
 270   // Use a more generic tactic, like a simple call.
 271   if (call_does_dispatch) {
 272     return CallGenerator::for_virtual_call(callee, vtable_index);
 273   } else {
 274     // Class Hierarchy Analysis or Type Profile reveals a unique target,
 275     // or it is a static or special call.
 276     return CallGenerator::for_direct_call(callee, should_delay_inlining(callee, jvms));
 277   }
 278 }
 279 
 280 // Return true for methods that shouldn't be inlined early so that
 281 // they are easier to analyze and optimize as intrinsics.
 282 bool Compile::should_delay_string_inlining(ciMethod* call_method, JVMState* jvms) {
 283   if (has_stringbuilder()) {
 284 
 285     if ((call_method->holder() == C->env()->StringBuilder_klass() ||
 286          call_method->holder() == C->env()->StringBuffer_klass()) &&
 287         (jvms->method()->holder() == C->env()->StringBuilder_klass() ||
 288          jvms->method()->holder() == C->env()->StringBuffer_klass())) {
 289       // Delay SB calls only when called from non-SB code
 290       return false;
 291     }
 292 
 293     switch (call_method->intrinsic_id()) {
 294       case vmIntrinsics::_StringBuilder_void:
 295       case vmIntrinsics::_StringBuilder_int:
 296       case vmIntrinsics::_StringBuilder_String:
 297       case vmIntrinsics::_StringBuilder_append_char:
 298       case vmIntrinsics::_StringBuilder_append_int:
 299       case vmIntrinsics::_StringBuilder_append_String:
 300       case vmIntrinsics::_StringBuilder_toString:
 301       case vmIntrinsics::_StringBuffer_void:
 302       case vmIntrinsics::_StringBuffer_int:
 303       case vmIntrinsics::_StringBuffer_String:
 304       case vmIntrinsics::_StringBuffer_append_char:
 305       case vmIntrinsics::_StringBuffer_append_int:
 306       case vmIntrinsics::_StringBuffer_append_String:
 307       case vmIntrinsics::_StringBuffer_toString:
 308       case vmIntrinsics::_Integer_toString:
 309         return true;
 310 
 311       case vmIntrinsics::_String_String:
 312         {
 313           Node* receiver = jvms->map()->in(jvms->argoff() + 1);
 314           if (receiver->is_Proj() && receiver->in(0)->is_CallStaticJava()) {
 315             CallStaticJavaNode* csj = receiver->in(0)->as_CallStaticJava();
 316             ciMethod* m = csj->method();
 317             if (m != NULL &&
 318                 (m->intrinsic_id() == vmIntrinsics::_StringBuffer_toString ||
 319                  m->intrinsic_id() == vmIntrinsics::_StringBuilder_toString))
 320               // Delay String.<init>(new SB())
 321               return true;
 322           }
 323           return false;
 324         }
 325 
 326       default:
 327         return false;
 328     }
 329   }
 330   return false;
 331 }
 332 
 333 bool Compile::should_delay_boxing_inlining(ciMethod* call_method, JVMState* jvms) {
 334   if (eliminate_boxing() && call_method->is_boxing_method()) {
 335     set_has_boxed_value(true);
 336     return true;
 337   }
 338   return false;
 339 }
 340 
 341 // uncommon-trap call-sites where callee is unloaded, uninitialized or will not link
 342 bool Parse::can_not_compile_call_site(ciMethod *dest_method, ciInstanceKlass* klass) {
 343   // Additional inputs to consider...
 344   // bc      = bc()
 345   // caller  = method()
 346   // iter().get_method_holder_index()
 347   assert( dest_method->is_loaded(), "ciTypeFlow should not let us get here" );
 348   // Interface classes can be loaded & linked and never get around to
 349   // being initialized.  Uncommon-trap for not-initialized static or
 350   // v-calls.  Let interface calls happen.
 351   ciInstanceKlass* holder_klass = dest_method->holder();
 352   if (!holder_klass->is_being_initialized() &&
 353       !holder_klass->is_initialized() &&
 354       !holder_klass->is_interface()) {
 355     uncommon_trap(Deoptimization::Reason_uninitialized,
 356                   Deoptimization::Action_reinterpret,
 357                   holder_klass);
 358     return true;
 359   }
 360 
 361   assert(dest_method->is_loaded(), "dest_method: typeflow responsibility");
 362   return false;
 363 }
 364 
 365 
 366 //------------------------------do_call----------------------------------------
 367 // Handle your basic call.  Inline if we can & want to, else just setup call.
 368 void Parse::do_call() {
 369   // It's likely we are going to add debug info soon.
 370   // Also, if we inline a guy who eventually needs debug info for this JVMS,
 371   // our contribution to it is cleaned up right here.
 372   kill_dead_locals();
 373 
 374   // Set frequently used booleans
 375   const bool is_virtual = bc() == Bytecodes::_invokevirtual;
 376   const bool is_virtual_or_interface = is_virtual || bc() == Bytecodes::_invokeinterface;
 377   const bool has_receiver = Bytecodes::has_receiver(bc());
 378 
 379   // Find target being called
 380   bool             will_link;
 381   ciSignature*     declared_signature = NULL;
 382   ciMethod*        orig_callee  = iter().get_method(will_link, &declared_signature);  // callee in the bytecode
 383   ciInstanceKlass* holder_klass = orig_callee->holder();
 384   ciKlass*         holder       = iter().get_declared_method_holder();
 385   ciInstanceKlass* klass = ciEnv::get_instance_klass_for_declared_method_holder(holder);
 386   assert(declared_signature != NULL, "cannot be null");
 387 
 388   // uncommon-trap when callee is unloaded, uninitialized or will not link
 389   // bailout when too many arguments for register representation
 390   if (!will_link || can_not_compile_call_site(orig_callee, klass)) {
 391 #ifndef PRODUCT
 392     if (PrintOpto && (Verbose || WizardMode)) {
 393       method()->print_name(); tty->print_cr(" can not compile call at bci %d to:", bci());
 394       orig_callee->print_name(); tty->cr();
 395     }
 396 #endif
 397     return;
 398   }
 399   assert(holder_klass->is_loaded(), "");
 400   //assert((bc_callee->is_static() || is_invokedynamic) == !has_receiver , "must match bc");  // XXX invokehandle (cur_bc_raw)
 401   // Note: this takes into account invokeinterface of methods declared in java/lang/Object,
 402   // which should be invokevirtuals but according to the VM spec may be invokeinterfaces
 403   assert(holder_klass->is_interface() || holder_klass->super() == NULL || (bc() != Bytecodes::_invokeinterface), "must match bc");
 404   // Note:  In the absence of miranda methods, an abstract class K can perform
 405   // an invokevirtual directly on an interface method I.m if K implements I.
 406 
 407   // orig_callee is the resolved callee which's signature includes the
 408   // appendix argument.
 409   const int nargs = orig_callee->arg_size();
 410   const bool is_signature_polymorphic = MethodHandles::is_signature_polymorphic(orig_callee->intrinsic_id());
 411 
 412   // Push appendix argument (MethodType, CallSite, etc.), if one.
 413   if (iter().has_appendix()) {
 414     ciObject* appendix_arg = iter().get_appendix();
 415     const TypeOopPtr* appendix_arg_type = TypeOopPtr::make_from_constant(appendix_arg);
 416     Node* appendix_arg_node = _gvn.makecon(appendix_arg_type);
 417     push(appendix_arg_node);
 418   }
 419 
 420   // ---------------------
 421   // Does Class Hierarchy Analysis reveal only a single target of a v-call?
 422   // Then we may inline or make a static call, but become dependent on there being only 1 target.
 423   // Does the call-site type profile reveal only one receiver?
 424   // Then we may introduce a run-time check and inline on the path where it succeeds.
 425   // The other path may uncommon_trap, check for another receiver, or do a v-call.
 426 
 427   // Try to get the most accurate receiver type
 428   ciMethod* callee             = orig_callee;
 429   int       vtable_index       = Method::invalid_vtable_index;
 430   bool      call_does_dispatch = false;
 431 
 432   if (is_virtual_or_interface) {
 433     Node*             receiver_node = stack(sp() - nargs);
 434     const TypeOopPtr* receiver_type = _gvn.type(receiver_node)->isa_oopptr();
 435     // call_does_dispatch and vtable_index are out-parameters.  They might be changed.
 436     callee = C->optimize_virtual_call(method(), bci(), klass, orig_callee, receiver_type,
 437                                       is_virtual,
 438                                       call_does_dispatch, vtable_index);  // out-parameters
 439   }
 440 
 441   // Note:  It's OK to try to inline a virtual call.
 442   // The call generator will not attempt to inline a polymorphic call
 443   // unless it knows how to optimize the receiver dispatch.
 444   bool try_inline = (C->do_inlining() || InlineAccessors);
 445 
 446   // ---------------------
 447   dec_sp(nargs);              // Temporarily pop args for JVM state of call
 448   JVMState* jvms = sync_jvms();
 449 
 450   // ---------------------
 451   // Decide call tactic.
 452   // This call checks with CHA, the interpreter profile, intrinsics table, etc.
 453   // It decides whether inlining is desirable or not.
 454   CallGenerator* cg = C->call_generator(callee, vtable_index, call_does_dispatch, jvms, try_inline, prof_factor());
 455 
 456   // NOTE:  Don't use orig_callee and callee after this point!  Use cg->method() instead.
 457   orig_callee = callee = NULL;
 458 
 459   // ---------------------
 460   // Round double arguments before call
 461   round_double_arguments(cg->method());
 462 
 463 #ifndef PRODUCT
 464   // bump global counters for calls
 465   count_compiled_calls(/*at_method_entry*/ false, cg->is_inline());
 466 
 467   // Record first part of parsing work for this call
 468   parse_histogram()->record_change();
 469 #endif // not PRODUCT
 470 
 471   assert(jvms == this->jvms(), "still operating on the right JVMS");
 472   assert(jvms_in_sync(),       "jvms must carry full info into CG");
 473 
 474   // save across call, for a subsequent cast_not_null.
 475   Node* receiver = has_receiver ? argument(0) : NULL;
 476 
 477   // Bump method data counters (We profile *before* the call is made
 478   // because exceptions don't return to the call site.)
 479   profile_call(receiver);
 480 
 481   JVMState* new_jvms = cg->generate(jvms);
 482   if (new_jvms == NULL) {
 483     // When inlining attempt fails (e.g., too many arguments),
 484     // it may contaminate the current compile state, making it
 485     // impossible to pull back and try again.  Once we call
 486     // cg->generate(), we are committed.  If it fails, the whole
 487     // compilation task is compromised.
 488     if (failing())  return;
 489 
 490     // This can happen if a library intrinsic is available, but refuses
 491     // the call site, perhaps because it did not match a pattern the
 492     // intrinsic was expecting to optimize. Should always be possible to
 493     // get a normal java call that may inline in that case
 494     cg = C->call_generator(cg->method(), vtable_index, call_does_dispatch, jvms, try_inline, prof_factor(), /* allow_intrinsics= */ false);
 495     if ((new_jvms = cg->generate(jvms)) == NULL) {
 496       guarantee(failing(), "call failed to generate:  calls should work");
 497       return;
 498     }
 499   }
 500 
 501   if (cg->is_inline()) {
 502     // Accumulate has_loops estimate
 503     C->set_has_loops(C->has_loops() || cg->method()->has_loops());
 504     C->env()->notice_inlined_method(cg->method());
 505   }
 506 
 507   // Reset parser state from [new_]jvms, which now carries results of the call.
 508   // Return value (if any) is already pushed on the stack by the cg.
 509   add_exception_states_from(new_jvms);
 510   if (new_jvms->map()->control() == top()) {
 511     stop_and_kill_map();
 512   } else {
 513     assert(new_jvms->same_calls_as(jvms), "method/bci left unchanged");
 514     set_jvms(new_jvms);
 515   }
 516 
 517   if (!stopped()) {
 518     // This was some sort of virtual call, which did a null check for us.
 519     // Now we can assert receiver-not-null, on the normal return path.
 520     if (receiver != NULL && cg->is_virtual()) {
 521       Node* cast = cast_not_null(receiver);
 522       // %%% assert(receiver == cast, "should already have cast the receiver");
 523     }
 524 
 525     // Round double result after a call from strict to non-strict code
 526     round_double_result(cg->method());
 527 
 528     ciType* rtype = cg->method()->return_type();
 529     ciType* ctype = declared_signature->return_type();
 530 
 531     if (Bytecodes::has_optional_appendix(iter().cur_bc_raw()) || is_signature_polymorphic) {
 532       // Be careful here with return types.
 533       if (ctype != rtype) {
 534         BasicType rt = rtype->basic_type();
 535         BasicType ct = ctype->basic_type();
 536         if (ct == T_VOID) {
 537           // It's OK for a method  to return a value that is discarded.
 538           // The discarding does not require any special action from the caller.
 539           // The Java code knows this, at VerifyType.isNullConversion.
 540           pop_node(rt);  // whatever it was, pop it
 541         } else if (rt == T_INT || is_subword_type(rt)) {
 542           // Nothing.  These cases are handled in lambda form bytecode.
 543           assert(ct == T_INT || is_subword_type(ct), err_msg_res("must match: rt=%s, ct=%s", type2name(rt), type2name(ct)));
 544         } else if (rt == T_OBJECT || rt == T_ARRAY) {
 545           assert(ct == T_OBJECT || ct == T_ARRAY, err_msg_res("rt=%s, ct=%s", type2name(rt), type2name(ct)));
 546           if (ctype->is_loaded()) {
 547             const TypeOopPtr* arg_type = TypeOopPtr::make_from_klass(rtype->as_klass());
 548             const Type*       sig_type = TypeOopPtr::make_from_klass(ctype->as_klass());
 549             if (arg_type != NULL && !arg_type->higher_equal(sig_type)) {
 550               Node* retnode = pop();
 551               Node* cast_obj = _gvn.transform(new (C) CheckCastPPNode(control(), retnode, sig_type));
 552               push(cast_obj);
 553             }
 554           }
 555         } else {
 556           assert(rt == ct, err_msg_res("unexpected mismatch: rt=%s, ct=%s", type2name(rt), type2name(ct)));
 557           // push a zero; it's better than getting an oop/int mismatch
 558           pop_node(rt);
 559           Node* retnode = zerocon(ct);
 560           push_node(ct, retnode);
 561         }
 562         // Now that the value is well-behaved, continue with the call-site type.
 563         rtype = ctype;
 564       }
 565     } else {
 566       // Symbolic resolution enforces the types to be the same.
 567       // NOTE: We must relax the assert for unloaded types because two
 568       // different ciType instances of the same unloaded class type
 569       // can appear to be "loaded" by different loaders (depending on
 570       // the accessing class).
 571       assert(!rtype->is_loaded() || !ctype->is_loaded() || rtype == ctype,
 572              err_msg_res("mismatched return types: rtype=%s, ctype=%s", rtype->name(), ctype->name()));
 573     }
 574 
 575     // If the return type of the method is not loaded, assert that the
 576     // value we got is a null.  Otherwise, we need to recompile.
 577     if (!rtype->is_loaded()) {
 578 #ifndef PRODUCT
 579       if (PrintOpto && (Verbose || WizardMode)) {
 580         method()->print_name(); tty->print_cr(" asserting nullness of result at bci: %d", bci());
 581         cg->method()->print_name(); tty->cr();
 582       }
 583 #endif
 584       if (C->log() != NULL) {
 585         C->log()->elem("assert_null reason='return' klass='%d'",
 586                        C->log()->identify(rtype));
 587       }
 588       // If there is going to be a trap, put it at the next bytecode:
 589       set_bci(iter().next_bci());
 590       null_assert(peek());
 591       set_bci(iter().cur_bci()); // put it back
 592     }
 593   }
 594 
 595   // Restart record of parsing work after possible inlining of call
 596 #ifndef PRODUCT
 597   parse_histogram()->set_initial_state(bc());
 598 #endif
 599 }
 600 
 601 //---------------------------catch_call_exceptions-----------------------------
 602 // Put a Catch and CatchProj nodes behind a just-created call.
 603 // Send their caught exceptions to the proper handler.
 604 // This may be used after a call to the rethrow VM stub,
 605 // when it is needed to process unloaded exception classes.
 606 void Parse::catch_call_exceptions(ciExceptionHandlerStream& handlers) {
 607   // Exceptions are delivered through this channel:
 608   Node* i_o = this->i_o();
 609 
 610   // Add a CatchNode.
 611   GrowableArray<int>* bcis = new (C->node_arena()) GrowableArray<int>(C->node_arena(), 8, 0, -1);
 612   GrowableArray<const Type*>* extypes = new (C->node_arena()) GrowableArray<const Type*>(C->node_arena(), 8, 0, NULL);
 613   GrowableArray<int>* saw_unloaded = new (C->node_arena()) GrowableArray<int>(C->node_arena(), 8, 0, 0);
 614 
 615   for (; !handlers.is_done(); handlers.next()) {
 616     ciExceptionHandler* h        = handlers.handler();
 617     int                 h_bci    = h->handler_bci();
 618     ciInstanceKlass*    h_klass  = h->is_catch_all() ? env()->Throwable_klass() : h->catch_klass();
 619     // Do not introduce unloaded exception types into the graph:
 620     if (!h_klass->is_loaded()) {
 621       if (saw_unloaded->contains(h_bci)) {
 622         /* We've already seen an unloaded exception with h_bci,
 623            so don't duplicate. Duplication will cause the CatchNode to be
 624            unnecessarily large. See 4713716. */
 625         continue;
 626       } else {
 627         saw_unloaded->append(h_bci);
 628       }
 629     }
 630     const Type*         h_extype = TypeOopPtr::make_from_klass(h_klass);
 631     // (We use make_from_klass because it respects UseUniqueSubclasses.)
 632     h_extype = h_extype->join(TypeInstPtr::NOTNULL);
 633     assert(!h_extype->empty(), "sanity");
 634     // Note:  It's OK if the BCIs repeat themselves.
 635     bcis->append(h_bci);
 636     extypes->append(h_extype);
 637   }
 638 
 639   int len = bcis->length();
 640   CatchNode *cn = new (C) CatchNode(control(), i_o, len+1);
 641   Node *catch_ = _gvn.transform(cn);
 642 
 643   // now branch with the exception state to each of the (potential)
 644   // handlers
 645   for(int i=0; i < len; i++) {
 646     // Setup JVM state to enter the handler.
 647     PreserveJVMState pjvms(this);
 648     // Locals are just copied from before the call.
 649     // Get control from the CatchNode.
 650     int handler_bci = bcis->at(i);
 651     Node* ctrl = _gvn.transform( new (C) CatchProjNode(catch_, i+1,handler_bci));
 652     // This handler cannot happen?
 653     if (ctrl == top())  continue;
 654     set_control(ctrl);
 655 
 656     // Create exception oop
 657     const TypeInstPtr* extype = extypes->at(i)->is_instptr();
 658     Node *ex_oop = _gvn.transform(new (C) CreateExNode(extypes->at(i), ctrl, i_o));
 659 
 660     // Handle unloaded exception classes.
 661     if (saw_unloaded->contains(handler_bci)) {
 662       // An unloaded exception type is coming here.  Do an uncommon trap.
 663 #ifndef PRODUCT
 664       // We do not expect the same handler bci to take both cold unloaded
 665       // and hot loaded exceptions.  But, watch for it.
 666       if ((Verbose || WizardMode) && extype->is_loaded()) {
 667         tty->print("Warning: Handler @%d takes mixed loaded/unloaded exceptions in ", bci());
 668         method()->print_name(); tty->cr();
 669       } else if (PrintOpto && (Verbose || WizardMode)) {
 670         tty->print("Bailing out on unloaded exception type ");
 671         extype->klass()->print_name();
 672         tty->print(" at bci:%d in ", bci());
 673         method()->print_name(); tty->cr();
 674       }
 675 #endif
 676       // Emit an uncommon trap instead of processing the block.
 677       set_bci(handler_bci);
 678       push_ex_oop(ex_oop);
 679       uncommon_trap(Deoptimization::Reason_unloaded,
 680                     Deoptimization::Action_reinterpret,
 681                     extype->klass(), "!loaded exception");
 682       set_bci(iter().cur_bci()); // put it back
 683       continue;
 684     }
 685 
 686     // go to the exception handler
 687     if (handler_bci < 0) {     // merge with corresponding rethrow node
 688       throw_to_exit(make_exception_state(ex_oop));
 689     } else {                      // Else jump to corresponding handle
 690       push_ex_oop(ex_oop);        // Clear stack and push just the oop.
 691       merge_exception(handler_bci);
 692     }
 693   }
 694 
 695   // The first CatchProj is for the normal return.
 696   // (Note:  If this is a call to rethrow_Java, this node goes dead.)
 697   set_control(_gvn.transform( new (C) CatchProjNode(catch_, CatchProjNode::fall_through_index, CatchProjNode::no_handler_bci)));
 698 }
 699 
 700 
 701 //----------------------------catch_inline_exceptions--------------------------
 702 // Handle all exceptions thrown by an inlined method or individual bytecode.
 703 // Common case 1: we have no handler, so all exceptions merge right into
 704 // the rethrow case.
 705 // Case 2: we have some handlers, with loaded exception klasses that have
 706 // no subklasses.  We do a Deutsch-Shiffman style type-check on the incoming
 707 // exception oop and branch to the handler directly.
 708 // Case 3: We have some handlers with subklasses or are not loaded at
 709 // compile-time.  We have to call the runtime to resolve the exception.
 710 // So we insert a RethrowCall and all the logic that goes with it.
 711 void Parse::catch_inline_exceptions(SafePointNode* ex_map) {
 712   // Caller is responsible for saving away the map for normal control flow!
 713   assert(stopped(), "call set_map(NULL) first");
 714   assert(method()->has_exception_handlers(), "don't come here w/o work to do");
 715 
 716   Node* ex_node = saved_ex_oop(ex_map);
 717   if (ex_node == top()) {
 718     // No action needed.
 719     return;
 720   }
 721   const TypeInstPtr* ex_type = _gvn.type(ex_node)->isa_instptr();
 722   NOT_PRODUCT(if (ex_type==NULL) tty->print_cr("*** Exception not InstPtr"));
 723   if (ex_type == NULL)
 724     ex_type = TypeOopPtr::make_from_klass(env()->Throwable_klass())->is_instptr();
 725 
 726   // determine potential exception handlers
 727   ciExceptionHandlerStream handlers(method(), bci(),
 728                                     ex_type->klass()->as_instance_klass(),
 729                                     ex_type->klass_is_exact());
 730 
 731   // Start executing from the given throw state.  (Keep its stack, for now.)
 732   // Get the exception oop as known at compile time.
 733   ex_node = use_exception_state(ex_map);
 734 
 735   // Get the exception oop klass from its header
 736   Node* ex_klass_node = NULL;
 737   if (has_ex_handler() && !ex_type->klass_is_exact()) {
 738     Node* p = basic_plus_adr( ex_node, ex_node, oopDesc::klass_offset_in_bytes());
 739     ex_klass_node = _gvn.transform( LoadKlassNode::make(_gvn, immutable_memory(), p, TypeInstPtr::KLASS, TypeKlassPtr::OBJECT) );
 740 
 741     // Compute the exception klass a little more cleverly.
 742     // Obvious solution is to simple do a LoadKlass from the 'ex_node'.
 743     // However, if the ex_node is a PhiNode, I'm going to do a LoadKlass for
 744     // each arm of the Phi.  If I know something clever about the exceptions
 745     // I'm loading the class from, I can replace the LoadKlass with the
 746     // klass constant for the exception oop.
 747     if( ex_node->is_Phi() ) {
 748       ex_klass_node = new (C) PhiNode( ex_node->in(0), TypeKlassPtr::OBJECT );
 749       for( uint i = 1; i < ex_node->req(); i++ ) {
 750         Node* p = basic_plus_adr( ex_node->in(i), ex_node->in(i), oopDesc::klass_offset_in_bytes() );
 751         Node* k = _gvn.transform( LoadKlassNode::make(_gvn, immutable_memory(), p, TypeInstPtr::KLASS, TypeKlassPtr::OBJECT) );
 752         ex_klass_node->init_req( i, k );
 753       }
 754       _gvn.set_type(ex_klass_node, TypeKlassPtr::OBJECT);
 755 
 756     }
 757   }
 758 
 759   // Scan the exception table for applicable handlers.
 760   // If none, we can call rethrow() and be done!
 761   // If precise (loaded with no subklasses), insert a D.S. style
 762   // pointer compare to the correct handler and loop back.
 763   // If imprecise, switch to the Rethrow VM-call style handling.
 764 
 765   int remaining = handlers.count_remaining();
 766 
 767   // iterate through all entries sequentially
 768   for (;!handlers.is_done(); handlers.next()) {
 769     ciExceptionHandler* handler = handlers.handler();
 770 
 771     if (handler->is_rethrow()) {
 772       // If we fell off the end of the table without finding an imprecise
 773       // exception klass (and without finding a generic handler) then we
 774       // know this exception is not handled in this method.  We just rethrow
 775       // the exception into the caller.
 776       throw_to_exit(make_exception_state(ex_node));
 777       return;
 778     }
 779 
 780     // exception handler bci range covers throw_bci => investigate further
 781     int handler_bci = handler->handler_bci();
 782 
 783     if (remaining == 1) {
 784       push_ex_oop(ex_node);        // Push exception oop for handler
 785 #ifndef PRODUCT
 786       if (PrintOpto && WizardMode) {
 787         tty->print_cr("  Catching every inline exception bci:%d -> handler_bci:%d", bci(), handler_bci);
 788       }
 789 #endif
 790       merge_exception(handler_bci); // jump to handler
 791       return;                   // No more handling to be done here!
 792     }
 793 
 794     // Get the handler's klass
 795     ciInstanceKlass* klass = handler->catch_klass();
 796 
 797     if (!klass->is_loaded()) {  // klass is not loaded?
 798       // fall through into catch_call_exceptions which will emit a
 799       // handler with an uncommon trap.
 800       break;
 801     }
 802 
 803     if (klass->is_interface())  // should not happen, but...
 804       break;                    // bail out
 805 
 806     // Check the type of the exception against the catch type
 807     const TypeKlassPtr *tk = TypeKlassPtr::make(klass);
 808     Node* con = _gvn.makecon(tk);
 809     Node* not_subtype_ctrl = gen_subtype_check(ex_klass_node, con);
 810     if (!stopped()) {
 811       PreserveJVMState pjvms(this);
 812       const TypeInstPtr* tinst = TypeOopPtr::make_from_klass_unique(klass)->cast_to_ptr_type(TypePtr::NotNull)->is_instptr();
 813       assert(klass->has_subklass() || tinst->klass_is_exact(), "lost exactness");
 814       Node* ex_oop = _gvn.transform(new (C) CheckCastPPNode(control(), ex_node, tinst));
 815       push_ex_oop(ex_oop);      // Push exception oop for handler
 816 #ifndef PRODUCT
 817       if (PrintOpto && WizardMode) {
 818         tty->print("  Catching inline exception bci:%d -> handler_bci:%d -- ", bci(), handler_bci);
 819         klass->print_name();
 820         tty->cr();
 821       }
 822 #endif
 823       merge_exception(handler_bci);
 824     }
 825     set_control(not_subtype_ctrl);
 826 
 827     // Come here if exception does not match handler.
 828     // Carry on with more handler checks.
 829     --remaining;
 830   }
 831 
 832   assert(!stopped(), "you should return if you finish the chain");
 833 
 834   // Oops, need to call into the VM to resolve the klasses at runtime.
 835   // Note:  This call must not deoptimize, since it is not a real at this bci!
 836   kill_dead_locals();
 837 
 838   make_runtime_call(RC_NO_LEAF | RC_MUST_THROW,
 839                     OptoRuntime::rethrow_Type(),
 840                     OptoRuntime::rethrow_stub(),
 841                     NULL, NULL,
 842                     ex_node);
 843 
 844   // Rethrow is a pure call, no side effects, only a result.
 845   // The result cannot be allocated, so we use I_O
 846 
 847   // Catch exceptions from the rethrow
 848   catch_call_exceptions(handlers);
 849 }
 850 
 851 
 852 // (Note:  Moved add_debug_info into GraphKit::add_safepoint_edges.)
 853 
 854 
 855 #ifndef PRODUCT
 856 void Parse::count_compiled_calls(bool at_method_entry, bool is_inline) {
 857   if( CountCompiledCalls ) {
 858     if( at_method_entry ) {
 859       // bump invocation counter if top method (for statistics)
 860       if (CountCompiledCalls && depth() == 1) {
 861         const TypePtr* addr_type = TypeMetadataPtr::make(method());
 862         Node* adr1 = makecon(addr_type);
 863         Node* adr2 = basic_plus_adr(adr1, adr1, in_bytes(Method::compiled_invocation_counter_offset()));
 864         increment_counter(adr2);
 865       }
 866     } else if (is_inline) {
 867       switch (bc()) {
 868       case Bytecodes::_invokevirtual:   increment_counter(SharedRuntime::nof_inlined_calls_addr()); break;
 869       case Bytecodes::_invokeinterface: increment_counter(SharedRuntime::nof_inlined_interface_calls_addr()); break;
 870       case Bytecodes::_invokestatic:
 871       case Bytecodes::_invokedynamic:
 872       case Bytecodes::_invokespecial:   increment_counter(SharedRuntime::nof_inlined_static_calls_addr()); break;
 873       default: fatal("unexpected call bytecode");
 874       }
 875     } else {
 876       switch (bc()) {
 877       case Bytecodes::_invokevirtual:   increment_counter(SharedRuntime::nof_normal_calls_addr()); break;
 878       case Bytecodes::_invokeinterface: increment_counter(SharedRuntime::nof_interface_calls_addr()); break;
 879       case Bytecodes::_invokestatic:
 880       case Bytecodes::_invokedynamic:
 881       case Bytecodes::_invokespecial:   increment_counter(SharedRuntime::nof_static_calls_addr()); break;
 882       default: fatal("unexpected call bytecode");
 883       }
 884     }
 885   }
 886 }
 887 #endif //PRODUCT
 888 
 889 
 890 ciMethod* Compile::optimize_virtual_call(ciMethod* caller, int bci, ciInstanceKlass* klass,
 891                                          ciMethod* callee, const TypeOopPtr* receiver_type,
 892                                          bool is_virtual,
 893                                          bool& call_does_dispatch, int& vtable_index) {
 894   // Set default values for out-parameters.
 895   call_does_dispatch = true;
 896   vtable_index       = Method::invalid_vtable_index;
 897 
 898   // Choose call strategy.
 899   ciMethod* optimized_virtual_method = optimize_inlining(caller, bci, klass, callee, receiver_type);
 900 
 901   // Have the call been sufficiently improved such that it is no longer a virtual?
 902   if (optimized_virtual_method != NULL) {
 903     callee             = optimized_virtual_method;
 904     call_does_dispatch = false;
 905   } else if (!UseInlineCaches && is_virtual && callee->is_loaded()) {
 906     // We can make a vtable call at this site
 907     vtable_index = callee->resolve_vtable_index(caller->holder(), klass);
 908   }
 909   return callee;
 910 }
 911 
 912 // Identify possible target method and inlining style
 913 ciMethod* Compile::optimize_inlining(ciMethod* caller, int bci, ciInstanceKlass* klass,
 914                                      ciMethod* callee, const TypeOopPtr* receiver_type) {
 915   // only use for virtual or interface calls
 916 
 917   // If it is obviously final, do not bother to call find_monomorphic_target,
 918   // because the class hierarchy checks are not needed, and may fail due to
 919   // incompletely loaded classes.  Since we do our own class loading checks
 920   // in this module, we may confidently bind to any method.
 921   if (callee->can_be_statically_bound()) {
 922     return callee;
 923   }
 924 
 925   // Attempt to improve the receiver
 926   bool actual_receiver_is_exact = false;
 927   ciInstanceKlass* actual_receiver = klass;
 928   if (receiver_type != NULL) {
 929     // Array methods are all inherited from Object, and are monomorphic.
 930     if (receiver_type->isa_aryptr() &&
 931         callee->holder() == env()->Object_klass()) {
 932       return callee;
 933     }
 934 
 935     // All other interesting cases are instance klasses.
 936     if (!receiver_type->isa_instptr()) {
 937       return NULL;
 938     }
 939 
 940     ciInstanceKlass *ikl = receiver_type->klass()->as_instance_klass();
 941     if (ikl->is_loaded() && ikl->is_initialized() && !ikl->is_interface() &&
 942         (ikl == actual_receiver || ikl->is_subtype_of(actual_receiver))) {
 943       // ikl is a same or better type than the original actual_receiver,
 944       // e.g. static receiver from bytecodes.
 945       actual_receiver = ikl;
 946       // Is the actual_receiver exact?
 947       actual_receiver_is_exact = receiver_type->klass_is_exact();
 948     }
 949   }
 950 
 951   ciInstanceKlass*   calling_klass = caller->holder();
 952   ciMethod* cha_monomorphic_target = callee->find_monomorphic_target(calling_klass, klass, actual_receiver);
 953   if (cha_monomorphic_target != NULL) {
 954     assert(!cha_monomorphic_target->is_abstract(), "");
 955     // Look at the method-receiver type.  Does it add "too much information"?
 956     ciKlass*    mr_klass = cha_monomorphic_target->holder();
 957     const Type* mr_type  = TypeInstPtr::make(TypePtr::BotPTR, mr_klass);
 958     if (receiver_type == NULL || !receiver_type->higher_equal(mr_type)) {
 959       // Calling this method would include an implicit cast to its holder.
 960       // %%% Not yet implemented.  Would throw minor asserts at present.
 961       // %%% The most common wins are already gained by +UseUniqueSubclasses.
 962       // To fix, put the higher_equal check at the call of this routine,
 963       // and add a CheckCastPP to the receiver.
 964       if (TraceDependencies) {
 965         tty->print_cr("found unique CHA method, but could not cast up");
 966         tty->print("  method  = ");
 967         cha_monomorphic_target->print();
 968         tty->cr();
 969       }
 970       if (log() != NULL) {
 971         log()->elem("missed_CHA_opportunity klass='%d' method='%d'",
 972                        log()->identify(klass),
 973                        log()->identify(cha_monomorphic_target));
 974       }
 975       cha_monomorphic_target = NULL;
 976     }
 977   }
 978   if (cha_monomorphic_target != NULL) {
 979     // Hardwiring a virtual.
 980     // If we inlined because CHA revealed only a single target method,
 981     // then we are dependent on that target method not getting overridden
 982     // by dynamic class loading.  Be sure to test the "static" receiver
 983     // dest_method here, as opposed to the actual receiver, which may
 984     // falsely lead us to believe that the receiver is final or private.
 985     dependencies()->assert_unique_concrete_method(actual_receiver, cha_monomorphic_target);
 986     return cha_monomorphic_target;
 987   }
 988 
 989   // If the type is exact, we can still bind the method w/o a vcall.
 990   // (This case comes after CHA so we can see how much extra work it does.)
 991   if (actual_receiver_is_exact) {
 992     // In case of evolution, there is a dependence on every inlined method, since each
 993     // such method can be changed when its class is redefined.
 994     ciMethod* exact_method = callee->resolve_invoke(calling_klass, actual_receiver);
 995     if (exact_method != NULL) {
 996 #ifndef PRODUCT
 997       if (PrintOpto) {
 998         tty->print("  Calling method via exact type @%d --- ", bci);
 999         exact_method->print_name();
1000         tty->cr();
1001       }
1002 #endif
1003       return exact_method;
1004     }
1005   }
1006 
1007   return NULL;
1008 }