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