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