1 /*
   2  * Copyright (c) 2000, 2021, 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/bcEscapeAnalyzer.hpp"
  27 #include "ci/ciCallSite.hpp"
  28 #include "ci/ciObjArray.hpp"
  29 #include "ci/ciMemberName.hpp"
  30 #include "ci/ciMethodHandle.hpp"
  31 #include "classfile/javaClasses.hpp"
  32 #include "compiler/compileLog.hpp"
  33 #include "opto/addnode.hpp"
  34 #include "opto/callGenerator.hpp"
  35 #include "opto/callnode.hpp"
  36 #include "opto/castnode.hpp"
  37 #include "opto/cfgnode.hpp"
  38 #include "opto/parse.hpp"
  39 #include "opto/rootnode.hpp"
  40 #include "opto/runtime.hpp"
  41 #include "opto/subnode.hpp"
  42 #include "runtime/sharedRuntime.hpp"
  43 #include "ci/ciNativeEntryPoint.hpp"
  44 #include "utilities/debug.hpp"
  45 
  46 // Utility function.
  47 const TypeFunc* CallGenerator::tf() const {
  48   return TypeFunc::make(method());
  49 }
  50 
  51 bool CallGenerator::is_inlined_method_handle_intrinsic(JVMState* jvms, ciMethod* m) {
  52   return is_inlined_method_handle_intrinsic(jvms->method(), jvms->bci(), m);
  53 }
  54 
  55 bool CallGenerator::is_inlined_method_handle_intrinsic(ciMethod* caller, int bci, ciMethod* m) {
  56   ciMethod* symbolic_info = caller->get_method_at_bci(bci);
  57   return is_inlined_method_handle_intrinsic(symbolic_info, m);
  58 }
  59 
  60 bool CallGenerator::is_inlined_method_handle_intrinsic(ciMethod* symbolic_info, ciMethod* m) {
  61   return symbolic_info->is_method_handle_intrinsic() && !m->is_method_handle_intrinsic();
  62 }
  63 
  64 //-----------------------------ParseGenerator---------------------------------
  65 // Internal class which handles all direct bytecode traversal.
  66 class ParseGenerator : public InlineCallGenerator {
  67 private:
  68   bool  _is_osr;
  69   float _expected_uses;
  70 
  71 public:
  72   ParseGenerator(ciMethod* method, float expected_uses, bool is_osr = false)
  73     : InlineCallGenerator(method)
  74   {
  75     _is_osr        = is_osr;
  76     _expected_uses = expected_uses;
  77     assert(InlineTree::check_can_parse(method) == NULL, "parse must be possible");
  78   }
  79 
  80   virtual bool      is_parse() const           { return true; }
  81   virtual JVMState* generate(JVMState* jvms);
  82   int is_osr() { return _is_osr; }
  83 
  84 };
  85 
  86 JVMState* ParseGenerator::generate(JVMState* jvms) {
  87   Compile* C = Compile::current();
  88   C->print_inlining_update(this);
  89 
  90   if (is_osr()) {
  91     // The JVMS for a OSR has a single argument (see its TypeFunc).
  92     assert(jvms->depth() == 1, "no inline OSR");
  93   }
  94 
  95   if (C->failing()) {
  96     return NULL;  // bailing out of the compile; do not try to parse
  97   }
  98 
  99   Parse parser(jvms, method(), _expected_uses);
 100   // Grab signature for matching/allocation
 101   GraphKit& exits = parser.exits();
 102 
 103   if (C->failing()) {
 104     while (exits.pop_exception_state() != NULL) ;
 105     return NULL;
 106   }
 107 
 108   assert(exits.jvms()->same_calls_as(jvms), "sanity");
 109 
 110   // Simply return the exit state of the parser,
 111   // augmented by any exceptional states.
 112   return exits.transfer_exceptions_into_jvms();
 113 }
 114 
 115 //---------------------------DirectCallGenerator------------------------------
 116 // Internal class which handles all out-of-line calls w/o receiver type checks.
 117 class DirectCallGenerator : public CallGenerator {
 118  private:
 119   CallStaticJavaNode* _call_node;
 120   // Force separate memory and I/O projections for the exceptional
 121   // paths to facilitate late inlinig.
 122   bool                _separate_io_proj;
 123 
 124 protected:
 125   void set_call_node(CallStaticJavaNode* call) { _call_node = call; }
 126 
 127  public:
 128   DirectCallGenerator(ciMethod* method, bool separate_io_proj)
 129     : CallGenerator(method),
 130       _separate_io_proj(separate_io_proj)
 131   {
 132   }
 133   virtual JVMState* generate(JVMState* jvms);
 134 
 135   virtual CallNode* call_node() const { return _call_node; }
 136   virtual CallGenerator* with_call_node(CallNode* call) {
 137     DirectCallGenerator* dcg = new DirectCallGenerator(method(), _separate_io_proj);
 138     dcg->set_call_node(call->as_CallStaticJava());
 139     return dcg;
 140   }
 141 };
 142 
 143 JVMState* DirectCallGenerator::generate(JVMState* jvms) {
 144   GraphKit kit(jvms);
 145   kit.C->print_inlining_update(this);
 146   bool is_static = method()->is_static();
 147   address target = is_static ? SharedRuntime::get_resolve_static_call_stub()
 148                              : SharedRuntime::get_resolve_opt_virtual_call_stub();
 149 
 150   if (kit.C->log() != NULL) {
 151     kit.C->log()->elem("direct_call bci='%d'", jvms->bci());
 152   }
 153 
 154   CallStaticJavaNode* call = new CallStaticJavaNode(kit.C, tf(), target, method());
 155   if (is_inlined_method_handle_intrinsic(jvms, method())) {
 156     // To be able to issue a direct call and skip a call to MH.linkTo*/invokeBasic adapter,
 157     // additional information about the method being invoked should be attached
 158     // to the call site to make resolution logic work
 159     // (see SharedRuntime::resolve_static_call_C).
 160     call->set_override_symbolic_info(true);
 161   }
 162   _call_node = call;  // Save the call node in case we need it later
 163   if (!is_static) {
 164     // Make an explicit receiver null_check as part of this call.
 165     // Since we share a map with the caller, his JVMS gets adjusted.
 166     kit.null_check_receiver_before_call(method());
 167     if (kit.stopped()) {
 168       // And dump it back to the caller, decorated with any exceptions:
 169       return kit.transfer_exceptions_into_jvms();
 170     }
 171     // Mark the call node as virtual, sort of:
 172     call->set_optimized_virtual(true);
 173     if (method()->is_method_handle_intrinsic() ||
 174         method()->is_compiled_lambda_form()) {
 175       call->set_method_handle_invoke(true);
 176     }
 177   }
 178   kit.set_arguments_for_java_call(call);
 179   kit.set_edges_for_java_call(call, false, _separate_io_proj);
 180   Node* ret = kit.set_results_for_java_call(call, _separate_io_proj);
 181   kit.push_node(method()->return_type()->basic_type(), ret);
 182   return kit.transfer_exceptions_into_jvms();
 183 }
 184 
 185 //--------------------------VirtualCallGenerator------------------------------
 186 // Internal class which handles all out-of-line calls checking receiver type.
 187 class VirtualCallGenerator : public CallGenerator {
 188 private:
 189   int _vtable_index;
 190   bool _separate_io_proj;
 191   CallDynamicJavaNode* _call_node;
 192 
 193 protected:
 194   void set_call_node(CallDynamicJavaNode* call) { _call_node = call; }
 195 
 196 public:
 197   VirtualCallGenerator(ciMethod* method, int vtable_index, bool separate_io_proj)
 198     : CallGenerator(method), _vtable_index(vtable_index), _separate_io_proj(separate_io_proj), _call_node(NULL)
 199   {
 200     assert(vtable_index == Method::invalid_vtable_index ||
 201            vtable_index >= 0, "either invalid or usable");
 202   }
 203   virtual bool      is_virtual() const          { return true; }
 204   virtual JVMState* generate(JVMState* jvms);
 205 
 206   virtual CallNode* call_node() const { return _call_node; }
 207   int vtable_index() const { return _vtable_index; }
 208 
 209   virtual CallGenerator* with_call_node(CallNode* call) {
 210     VirtualCallGenerator* cg = new VirtualCallGenerator(method(), _vtable_index, _separate_io_proj);
 211     cg->set_call_node(call->as_CallDynamicJava());
 212     return cg;
 213   }
 214 };
 215 
 216 JVMState* VirtualCallGenerator::generate(JVMState* jvms) {
 217   GraphKit kit(jvms);
 218   Node* receiver = kit.argument(0);
 219 
 220   kit.C->print_inlining_update(this);
 221 
 222   if (kit.C->log() != NULL) {
 223     kit.C->log()->elem("virtual_call bci='%d'", jvms->bci());
 224   }
 225 
 226   // If the receiver is a constant null, do not torture the system
 227   // by attempting to call through it.  The compile will proceed
 228   // correctly, but may bail out in final_graph_reshaping, because
 229   // the call instruction will have a seemingly deficient out-count.
 230   // (The bailout says something misleading about an "infinite loop".)
 231   if (kit.gvn().type(receiver)->higher_equal(TypePtr::NULL_PTR)) {
 232     assert(Bytecodes::is_invoke(kit.java_bc()), "%d: %s", kit.java_bc(), Bytecodes::name(kit.java_bc()));
 233     ciMethod* declared_method = kit.method()->get_method_at_bci(kit.bci());
 234     int arg_size = declared_method->signature()->arg_size_for_bc(kit.java_bc());
 235     kit.inc_sp(arg_size);  // restore arguments
 236     kit.uncommon_trap(Deoptimization::Reason_null_check,
 237                       Deoptimization::Action_none,
 238                       NULL, "null receiver");
 239     return kit.transfer_exceptions_into_jvms();
 240   }
 241 
 242   // Ideally we would unconditionally do a null check here and let it
 243   // be converted to an implicit check based on profile information.
 244   // However currently the conversion to implicit null checks in
 245   // Block::implicit_null_check() only looks for loads and stores, not calls.
 246   ciMethod *caller = kit.method();
 247   ciMethodData *caller_md = (caller == NULL) ? NULL : caller->method_data();
 248   if (!UseInlineCaches || !ImplicitNullChecks || !os::zero_page_read_protected() ||
 249        ((ImplicitNullCheckThreshold > 0) && caller_md &&
 250        (caller_md->trap_count(Deoptimization::Reason_null_check)
 251        >= (uint)ImplicitNullCheckThreshold))) {
 252     // Make an explicit receiver null_check as part of this call.
 253     // Since we share a map with the caller, his JVMS gets adjusted.
 254     receiver = kit.null_check_receiver_before_call(method());
 255     if (kit.stopped()) {
 256       // And dump it back to the caller, decorated with any exceptions:
 257       return kit.transfer_exceptions_into_jvms();
 258     }
 259   }
 260 
 261   assert(!method()->is_static(), "virtual call must not be to static");
 262   assert(!method()->is_final(), "virtual call should not be to final");
 263   assert(!method()->is_private(), "virtual call should not be to private");
 264   assert(_vtable_index == Method::invalid_vtable_index || !UseInlineCaches,
 265          "no vtable calls if +UseInlineCaches ");
 266   address target = SharedRuntime::get_resolve_virtual_call_stub();
 267   // Normal inline cache used for call
 268   CallDynamicJavaNode* call = new CallDynamicJavaNode(tf(), target, method(), _vtable_index);
 269   if (is_inlined_method_handle_intrinsic(jvms, method())) {
 270     // To be able to issue a direct call (optimized virtual or virtual)
 271     // and skip a call to MH.linkTo*/invokeBasic adapter, additional information
 272     // about the method being invoked should be attached to the call site to
 273     // make resolution logic work (see SharedRuntime::resolve_{virtual,opt_virtual}_call_C).
 274     call->set_override_symbolic_info(true);
 275   }
 276   _call_node = call;  // Save the call node in case we need it later
 277 
 278   kit.set_arguments_for_java_call(call);
 279   kit.set_edges_for_java_call(call, false /*must_throw*/, _separate_io_proj);
 280   Node* ret = kit.set_results_for_java_call(call, _separate_io_proj);
 281   kit.push_node(method()->return_type()->basic_type(), ret);
 282 
 283   // Represent the effect of an implicit receiver null_check
 284   // as part of this call.  Since we share a map with the caller,
 285   // his JVMS gets adjusted.
 286   kit.cast_not_null(receiver);
 287   return kit.transfer_exceptions_into_jvms();
 288 }
 289 
 290 CallGenerator* CallGenerator::for_inline(ciMethod* m, float expected_uses) {
 291   if (InlineTree::check_can_parse(m) != NULL)  return NULL;
 292   return new ParseGenerator(m, expected_uses);
 293 }
 294 
 295 // As a special case, the JVMS passed to this CallGenerator is
 296 // for the method execution already in progress, not just the JVMS
 297 // of the caller.  Thus, this CallGenerator cannot be mixed with others!
 298 CallGenerator* CallGenerator::for_osr(ciMethod* m, int osr_bci) {
 299   if (InlineTree::check_can_parse(m) != NULL)  return NULL;
 300   float past_uses = m->interpreter_invocation_count();
 301   float expected_uses = past_uses;
 302   return new ParseGenerator(m, expected_uses, true);
 303 }
 304 
 305 CallGenerator* CallGenerator::for_direct_call(ciMethod* m, bool separate_io_proj) {
 306   assert(!m->is_abstract(), "for_direct_call mismatch");
 307   return new DirectCallGenerator(m, separate_io_proj);
 308 }
 309 
 310 CallGenerator* CallGenerator::for_virtual_call(ciMethod* m, int vtable_index) {
 311   assert(!m->is_static(), "for_virtual_call mismatch");
 312   assert(!m->is_method_handle_intrinsic(), "should be a direct call");
 313   return new VirtualCallGenerator(m, vtable_index, false /*separate_io_projs*/);
 314 }
 315 
 316 // Allow inlining decisions to be delayed
 317 class LateInlineCallGenerator : public DirectCallGenerator {
 318  private:
 319   jlong _unique_id;   // unique id for log compilation
 320   bool _is_pure_call; // a hint that the call doesn't have important side effects to care about
 321 
 322  protected:
 323   CallGenerator* _inline_cg;
 324   virtual bool do_late_inline_check(Compile* C, JVMState* jvms) { return true; }
 325   virtual CallGenerator* inline_cg() const { return _inline_cg; }
 326   virtual bool is_pure_call() const { return _is_pure_call; }
 327 
 328  public:
 329   LateInlineCallGenerator(ciMethod* method, CallGenerator* inline_cg, bool is_pure_call = false) :
 330     DirectCallGenerator(method, true), _unique_id(0), _is_pure_call(is_pure_call), _inline_cg(inline_cg) {}
 331 
 332   virtual bool is_late_inline() const { return true; }
 333 
 334   // Convert the CallStaticJava into an inline
 335   virtual void do_late_inline();
 336 
 337   virtual JVMState* generate(JVMState* jvms) {
 338     Compile *C = Compile::current();
 339 
 340     C->log_inline_id(this);
 341 
 342     // Record that this call site should be revisited once the main
 343     // parse is finished.
 344     if (!is_mh_late_inline()) {
 345       C->add_late_inline(this);
 346     }
 347 
 348     // Emit the CallStaticJava and request separate projections so
 349     // that the late inlining logic can distinguish between fall
 350     // through and exceptional uses of the memory and io projections
 351     // as is done for allocations and macro expansion.
 352     return DirectCallGenerator::generate(jvms);
 353   }
 354 
 355   virtual void print_inlining_late(const char* msg) {
 356     CallNode* call = call_node();
 357     Compile* C = Compile::current();
 358     C->print_inlining_assert_ready();
 359     C->print_inlining(method(), call->jvms()->depth()-1, call->jvms()->bci(), msg);
 360     C->print_inlining_move_to(this);
 361     C->print_inlining_update_delayed(this);
 362   }
 363 
 364   virtual void set_unique_id(jlong id) {
 365     _unique_id = id;
 366   }
 367 
 368   virtual jlong unique_id() const {
 369     return _unique_id;
 370   }
 371 
 372   virtual CallGenerator* with_call_node(CallNode* call) {
 373     LateInlineCallGenerator* cg = new LateInlineCallGenerator(method(), _inline_cg, _is_pure_call);
 374     cg->set_call_node(call->as_CallStaticJava());
 375     return cg;
 376   }
 377 };
 378 
 379 CallGenerator* CallGenerator::for_late_inline(ciMethod* method, CallGenerator* inline_cg) {
 380   return new LateInlineCallGenerator(method, inline_cg);
 381 }
 382 
 383 class LateInlineMHCallGenerator : public LateInlineCallGenerator {
 384   ciMethod* _caller;
 385   bool _input_not_const;
 386 
 387   virtual bool do_late_inline_check(Compile* C, JVMState* jvms);
 388 
 389  public:
 390   LateInlineMHCallGenerator(ciMethod* caller, ciMethod* callee, bool input_not_const) :
 391     LateInlineCallGenerator(callee, NULL), _caller(caller), _input_not_const(input_not_const) {}
 392 
 393   virtual bool is_mh_late_inline() const { return true; }
 394 
 395   // Convert the CallStaticJava into an inline
 396   virtual void do_late_inline();
 397 
 398   virtual JVMState* generate(JVMState* jvms) {
 399     JVMState* new_jvms = LateInlineCallGenerator::generate(jvms);
 400 
 401     Compile* C = Compile::current();
 402     if (_input_not_const) {
 403       // inlining won't be possible so no need to enqueue right now.
 404       call_node()->set_generator(this);
 405     } else {
 406       C->add_late_inline(this);
 407     }
 408     return new_jvms;
 409   }
 410 
 411   virtual CallGenerator* with_call_node(CallNode* call) {
 412     LateInlineMHCallGenerator* cg = new LateInlineMHCallGenerator(_caller, method(), _input_not_const);
 413     cg->set_call_node(call->as_CallStaticJava());
 414     return cg;
 415   }
 416 };
 417 
 418 bool LateInlineMHCallGenerator::do_late_inline_check(Compile* C, JVMState* jvms) {
 419   // Even if inlining is not allowed, a virtual call can be strength-reduced to a direct call.
 420   bool allow_inline = C->inlining_incrementally();
 421   bool input_not_const = true;
 422   CallGenerator* cg = for_method_handle_inline(jvms, _caller, method(), allow_inline, input_not_const);
 423   assert(!input_not_const, "sanity"); // shouldn't have been scheduled for inlining in the first place
 424 
 425   if (cg != NULL) {
 426     assert(!cg->is_late_inline() || cg->is_mh_late_inline() || AlwaysIncrementalInline, "we're doing late inlining");
 427     _inline_cg = cg;
 428     C->dec_number_of_mh_late_inlines();
 429     return true;
 430   } else {
 431     // Method handle call which has a constant appendix argument should be either inlined or replaced with a direct call
 432     // unless there's a signature mismatch between caller and callee. If the failure occurs, there's not much to be improved later,
 433     // so don't reinstall the generator to avoid pushing the generator between IGVN and incremental inlining indefinitely.
 434     return false;
 435   }
 436 }
 437 
 438 CallGenerator* CallGenerator::for_mh_late_inline(ciMethod* caller, ciMethod* callee, bool input_not_const) {
 439   assert(IncrementalInlineMH, "required");
 440   Compile::current()->inc_number_of_mh_late_inlines();
 441   CallGenerator* cg = new LateInlineMHCallGenerator(caller, callee, input_not_const);
 442   return cg;
 443 }
 444 
 445 // Allow inlining decisions to be delayed
 446 class LateInlineVirtualCallGenerator : public VirtualCallGenerator {
 447  private:
 448   jlong          _unique_id;   // unique id for log compilation
 449   CallGenerator* _inline_cg;
 450   ciMethod*      _callee;
 451   bool           _is_pure_call;
 452   float          _prof_factor;
 453 
 454  protected:
 455   virtual bool do_late_inline_check(Compile* C, JVMState* jvms);
 456   virtual CallGenerator* inline_cg() const { return _inline_cg; }
 457   virtual bool is_pure_call() const { return _is_pure_call; }
 458 
 459  public:
 460   LateInlineVirtualCallGenerator(ciMethod* method, int vtable_index, float prof_factor)
 461   : VirtualCallGenerator(method, vtable_index, true /*separate_io_projs*/),
 462     _unique_id(0), _inline_cg(NULL), _callee(NULL), _is_pure_call(false), _prof_factor(prof_factor) {
 463     assert(IncrementalInlineVirtual, "required");
 464   }
 465 
 466   virtual bool is_late_inline() const { return true; }
 467 
 468   virtual bool is_virtual_late_inline() const { return true; }
 469 
 470   // Convert the CallDynamicJava into an inline
 471   virtual void do_late_inline();
 472 
 473   virtual void set_callee_method(ciMethod* m) {
 474     assert(_callee == NULL, "repeated inlining attempt");
 475     _callee = m;
 476   }
 477 
 478   virtual JVMState* generate(JVMState* jvms) {
 479     // Emit the CallDynamicJava and request separate projections so
 480     // that the late inlining logic can distinguish between fall
 481     // through and exceptional uses of the memory and io projections
 482     // as is done for allocations and macro expansion.
 483     JVMState* new_jvms = VirtualCallGenerator::generate(jvms);
 484     if (call_node() != NULL) {
 485       call_node()->set_generator(this);
 486     }
 487     return new_jvms;
 488   }
 489 
 490   virtual void print_inlining_late(const char* msg) {
 491     CallNode* call = call_node();
 492     Compile* C = Compile::current();
 493     C->print_inlining_assert_ready();
 494     C->print_inlining(method(), call->jvms()->depth()-1, call->jvms()->bci(), msg);
 495     C->print_inlining_move_to(this);
 496     C->print_inlining_update_delayed(this);
 497   }
 498 
 499   virtual void set_unique_id(jlong id) {
 500     _unique_id = id;
 501   }
 502 
 503   virtual jlong unique_id() const {
 504     return _unique_id;
 505   }
 506 
 507   virtual CallGenerator* with_call_node(CallNode* call) {
 508     LateInlineVirtualCallGenerator* cg = new LateInlineVirtualCallGenerator(method(), vtable_index(), _prof_factor);
 509     cg->set_call_node(call->as_CallDynamicJava());
 510     return cg;
 511   }
 512 };
 513 
 514 bool LateInlineVirtualCallGenerator::do_late_inline_check(Compile* C, JVMState* jvms) {
 515   // Method handle linker case is handled in CallDynamicJavaNode::Ideal().
 516   // Unless inlining is performed, _override_symbolic_info bit will be set in DirectCallGenerator::generate().
 517 
 518   // Implicit receiver null checks introduce problems when exception states are combined.
 519   Node* receiver = jvms->map()->argument(jvms, 0);
 520   const Type* recv_type = C->initial_gvn()->type(receiver);
 521   if (recv_type->maybe_null()) {
 522     return false;
 523   }
 524   // Even if inlining is not allowed, a virtual call can be strength-reduced to a direct call.
 525   bool allow_inline = C->inlining_incrementally();
 526   if (!allow_inline && _callee->holder()->is_interface()) {
 527     // Don't convert the interface call to a direct call guarded by an interface subtype check.
 528     return false;
 529   }
 530   CallGenerator* cg = C->call_generator(_callee,
 531                                         vtable_index(),
 532                                         false /*call_does_dispatch*/,
 533                                         jvms,
 534                                         allow_inline,
 535                                         _prof_factor,
 536                                         NULL /*speculative_receiver_type*/,
 537                                         true /*allow_intrinsics*/);
 538 
 539   if (cg != NULL) {
 540     assert(!cg->is_late_inline() || cg->is_mh_late_inline() || AlwaysIncrementalInline, "we're doing late inlining");
 541     _inline_cg = cg;
 542     return true;
 543   } else {
 544     // Virtual call which provably doesn't dispatch should be either inlined or replaced with a direct call.
 545     assert(false, "no progress");
 546     return false;
 547   }
 548 }
 549 
 550 CallGenerator* CallGenerator::for_late_inline_virtual(ciMethod* m, int vtable_index, float prof_factor) {
 551   assert(IncrementalInlineVirtual, "required");
 552   assert(!m->is_static(), "for_virtual_call mismatch");
 553   assert(!m->is_method_handle_intrinsic(), "should be a direct call");
 554   return new LateInlineVirtualCallGenerator(m, vtable_index, prof_factor);
 555 }
 556 
 557 void LateInlineCallGenerator::do_late_inline() {
 558   CallGenerator::do_late_inline_helper();
 559 }
 560 
 561 void LateInlineMHCallGenerator::do_late_inline() {
 562   CallGenerator::do_late_inline_helper();
 563 }
 564 
 565 void LateInlineVirtualCallGenerator::do_late_inline() {
 566   assert(_callee != NULL, "required"); // set up in CallDynamicJavaNode::Ideal
 567   CallGenerator::do_late_inline_helper();
 568 }
 569 
 570 static bool has_non_debug_usages(Node* n) {
 571   for (DUIterator_Fast imax, i = n->fast_outs(imax); i < imax; i++) {
 572     Node* m = n->fast_out(i);
 573     if (!m->is_SafePoint()
 574         || (m->is_Call() && m->as_Call()->has_non_debug_use(n))) {
 575       return true;
 576     }
 577   }
 578   return false;
 579 }
 580 
 581 static bool is_box_cache_valid(CallNode* call) {
 582   ciInstanceKlass* klass = call->as_CallStaticJava()->method()->holder();
 583   return klass->is_box_cache_valid();
 584 }
 585 
 586 // delay box in runtime, treat box as a scalarized object
 587 static void scalarize_debug_usages(CallNode* call, Node* resproj) {
 588   GraphKit kit(call->jvms());
 589   PhaseGVN& gvn = kit.gvn();
 590 
 591   ProjNode* res = resproj->as_Proj();
 592   ciInstanceKlass* klass = call->as_CallStaticJava()->method()->holder();
 593   int n_fields = klass->nof_nonstatic_fields();
 594   assert(n_fields == 1, "the klass must be an auto-boxing klass");
 595 
 596   for (DUIterator_Last imin, i = res->last_outs(imin); i >= imin;) {
 597     SafePointNode* sfpt = res->last_out(i)->as_SafePoint();
 598     uint first_ind = sfpt->req() - sfpt->jvms()->scloff();
 599     Node* sobj = new SafePointScalarObjectNode(gvn.type(res)->isa_oopptr(),
 600 #ifdef ASSERT
 601                                                 call,
 602 #endif // ASSERT
 603                                                 first_ind, n_fields, true);
 604     sobj->init_req(0, kit.root());
 605     sfpt->add_req(call->in(TypeFunc::Parms));
 606     sobj = gvn.transform(sobj);
 607     JVMState* jvms = sfpt->jvms();
 608     jvms->set_endoff(sfpt->req());
 609     int start = jvms->debug_start();
 610     int end   = jvms->debug_end();
 611     int num_edges = sfpt->replace_edges_in_range(res, sobj, start, end, &gvn);
 612     i -= num_edges;
 613   }
 614 
 615   assert(res->outcnt() == 0, "the box must have no use after replace");
 616 
 617 #ifndef PRODUCT
 618   if (PrintEliminateAllocations) {
 619     tty->print("++++ Eliminated: %d ", call->_idx);
 620     call->as_CallStaticJava()->method()->print_short_name(tty);
 621     tty->cr();
 622   }
 623 #endif
 624 }
 625 
 626 void CallGenerator::do_late_inline_helper() {
 627   assert(is_late_inline(), "only late inline allowed");
 628 
 629   // Can't inline it
 630   CallNode* call = call_node();
 631   if (call == NULL || call->outcnt() == 0 ||
 632       call->in(0) == NULL || call->in(0)->is_top()) {
 633     return;
 634   }
 635 
 636   const TypeTuple *r = call->tf()->domain();
 637   for (int i1 = 0; i1 < method()->arg_size(); i1++) {
 638     if (call->in(TypeFunc::Parms + i1)->is_top() && r->field_at(TypeFunc::Parms + i1) != Type::HALF) {
 639       assert(Compile::current()->inlining_incrementally(), "shouldn't happen during parsing");
 640       return;
 641     }
 642   }
 643 
 644   if (call->in(TypeFunc::Memory)->is_top()) {
 645     assert(Compile::current()->inlining_incrementally(), "shouldn't happen during parsing");
 646     return;
 647   }
 648   if (call->in(TypeFunc::Memory)->is_MergeMem()) {
 649     MergeMemNode* merge_mem = call->in(TypeFunc::Memory)->as_MergeMem();
 650     if (merge_mem->base_memory() == merge_mem->empty_memory()) {
 651       return; // dead path
 652     }
 653   }
 654 
 655   // check for unreachable loop
 656   CallProjections callprojs;
 657   call->extract_projections(&callprojs, true);
 658   if ((callprojs.fallthrough_catchproj == call->in(0)) ||
 659       (callprojs.catchall_catchproj    == call->in(0)) ||
 660       (callprojs.fallthrough_memproj   == call->in(TypeFunc::Memory)) ||
 661       (callprojs.catchall_memproj      == call->in(TypeFunc::Memory)) ||
 662       (callprojs.fallthrough_ioproj    == call->in(TypeFunc::I_O)) ||
 663       (callprojs.catchall_ioproj       == call->in(TypeFunc::I_O)) ||
 664       (callprojs.resproj != NULL && call->find_edge(callprojs.resproj) != -1) ||
 665       (callprojs.exobj   != NULL && call->find_edge(callprojs.exobj) != -1)) {
 666     return;
 667   }
 668 
 669   Compile* C = Compile::current();
 670   // Remove inlined methods from Compiler's lists.
 671   if (call->is_macro()) {
 672     C->remove_macro_node(call);
 673   }
 674 
 675   bool result_not_used = false;
 676 
 677   if (is_pure_call()) {
 678     if (is_boxing_late_inline() && callprojs.resproj != nullptr) {
 679         // replace box node to scalar node only in case it is directly referenced by debug info
 680         assert(call->as_CallStaticJava()->is_boxing_method(), "sanity");
 681         if (!has_non_debug_usages(callprojs.resproj) && is_box_cache_valid(call)) {
 682           scalarize_debug_usages(call, callprojs.resproj);
 683         }
 684     }
 685 
 686     // The call is marked as pure (no important side effects), but result isn't used.
 687     // It's safe to remove the call.
 688     result_not_used = (callprojs.resproj == NULL || callprojs.resproj->outcnt() == 0);
 689   }
 690 
 691   if (result_not_used) {
 692     GraphKit kit(call->jvms());
 693     kit.replace_call(call, C->top(), true);
 694   } else {
 695     // Make a clone of the JVMState that appropriate to use for driving a parse
 696     JVMState* old_jvms = call->jvms();
 697     JVMState* jvms = old_jvms->clone_shallow(C);
 698     uint size = call->req();
 699     SafePointNode* map = new SafePointNode(size, jvms);
 700     for (uint i1 = 0; i1 < size; i1++) {
 701       map->init_req(i1, call->in(i1));
 702     }
 703 
 704     // Make sure the state is a MergeMem for parsing.
 705     if (!map->in(TypeFunc::Memory)->is_MergeMem()) {
 706       Node* mem = MergeMemNode::make(map->in(TypeFunc::Memory));
 707       C->initial_gvn()->set_type_bottom(mem);
 708       map->set_req(TypeFunc::Memory, mem);
 709     }
 710 
 711     uint nargs = method()->arg_size();
 712     // blow away old call arguments
 713     Node* top = C->top();
 714     for (uint i1 = 0; i1 < nargs; i1++) {
 715       map->set_req(TypeFunc::Parms + i1, top);
 716     }
 717     jvms->set_map(map);
 718 
 719     // Make enough space in the expression stack to transfer
 720     // the incoming arguments and return value.
 721     map->ensure_stack(jvms, jvms->method()->max_stack());
 722     for (uint i1 = 0; i1 < nargs; i1++) {
 723       map->set_argument(jvms, i1, call->in(TypeFunc::Parms + i1));
 724     }
 725 
 726     C->print_inlining_assert_ready();
 727 
 728     C->print_inlining_move_to(this);
 729 
 730     C->log_late_inline(this);
 731 
 732     // JVMState is ready, so time to perform some checks and prepare for inlining attempt.
 733     if (!do_late_inline_check(C, jvms)) {
 734       map->disconnect_inputs(C);
 735       C->print_inlining_update_delayed(this);
 736       return;
 737     }
 738 
 739     // Setup default node notes to be picked up by the inlining
 740     Node_Notes* old_nn = C->node_notes_at(call->_idx);
 741     if (old_nn != NULL) {
 742       Node_Notes* entry_nn = old_nn->clone(C);
 743       entry_nn->set_jvms(jvms);
 744       C->set_default_node_notes(entry_nn);
 745     }
 746 
 747     // Now perform the inlining using the synthesized JVMState
 748     JVMState* new_jvms = inline_cg()->generate(jvms);
 749     if (new_jvms == NULL)  return;  // no change
 750     if (C->failing())      return;
 751 
 752     // Capture any exceptional control flow
 753     GraphKit kit(new_jvms);
 754 
 755     // Find the result object
 756     Node* result = C->top();
 757     int   result_size = method()->return_type()->size();
 758     if (result_size != 0 && !kit.stopped()) {
 759       result = (result_size == 1) ? kit.pop() : kit.pop_pair();
 760     }
 761 
 762     if (inline_cg()->is_inline()) {
 763       C->set_has_loops(C->has_loops() || inline_cg()->method()->has_loops());
 764       C->env()->notice_inlined_method(inline_cg()->method());
 765     }
 766     C->set_inlining_progress(true);
 767     C->set_do_cleanup(kit.stopped()); // path is dead; needs cleanup
 768     kit.replace_call(call, result, true);
 769   }
 770 }
 771 
 772 class LateInlineStringCallGenerator : public LateInlineCallGenerator {
 773 
 774  public:
 775   LateInlineStringCallGenerator(ciMethod* method, CallGenerator* inline_cg) :
 776     LateInlineCallGenerator(method, inline_cg) {}
 777 
 778   virtual JVMState* generate(JVMState* jvms) {
 779     Compile *C = Compile::current();
 780 
 781     C->log_inline_id(this);
 782 
 783     C->add_string_late_inline(this);
 784 
 785     JVMState* new_jvms = DirectCallGenerator::generate(jvms);
 786     return new_jvms;
 787   }
 788 
 789   virtual bool is_string_late_inline() const { return true; }
 790 
 791   virtual CallGenerator* with_call_node(CallNode* call) {
 792     LateInlineStringCallGenerator* cg = new LateInlineStringCallGenerator(method(), _inline_cg);
 793     cg->set_call_node(call->as_CallStaticJava());
 794     return cg;
 795   }
 796 };
 797 
 798 CallGenerator* CallGenerator::for_string_late_inline(ciMethod* method, CallGenerator* inline_cg) {
 799   return new LateInlineStringCallGenerator(method, inline_cg);
 800 }
 801 
 802 class LateInlineBoxingCallGenerator : public LateInlineCallGenerator {
 803 
 804  public:
 805   LateInlineBoxingCallGenerator(ciMethod* method, CallGenerator* inline_cg) :
 806     LateInlineCallGenerator(method, inline_cg, /*is_pure=*/true) {}
 807 
 808   virtual JVMState* generate(JVMState* jvms) {
 809     Compile *C = Compile::current();
 810 
 811     C->log_inline_id(this);
 812 
 813     C->add_boxing_late_inline(this);
 814 
 815     JVMState* new_jvms = DirectCallGenerator::generate(jvms);
 816     return new_jvms;
 817   }
 818 
 819   virtual bool is_boxing_late_inline() const { return true; }
 820 
 821   virtual CallGenerator* with_call_node(CallNode* call) {
 822     LateInlineBoxingCallGenerator* cg = new LateInlineBoxingCallGenerator(method(), _inline_cg);
 823     cg->set_call_node(call->as_CallStaticJava());
 824     return cg;
 825   }
 826 };
 827 
 828 CallGenerator* CallGenerator::for_boxing_late_inline(ciMethod* method, CallGenerator* inline_cg) {
 829   return new LateInlineBoxingCallGenerator(method, inline_cg);
 830 }
 831 
 832 class LateInlineVectorReboxingCallGenerator : public LateInlineCallGenerator {
 833 
 834  public:
 835   LateInlineVectorReboxingCallGenerator(ciMethod* method, CallGenerator* inline_cg) :
 836     LateInlineCallGenerator(method, inline_cg, /*is_pure=*/true) {}
 837 
 838   virtual JVMState* generate(JVMState* jvms) {
 839     Compile *C = Compile::current();
 840 
 841     C->log_inline_id(this);
 842 
 843     C->add_vector_reboxing_late_inline(this);
 844 
 845     JVMState* new_jvms = DirectCallGenerator::generate(jvms);
 846     return new_jvms;
 847   }
 848 
 849   virtual CallGenerator* with_call_node(CallNode* call) {
 850     LateInlineVectorReboxingCallGenerator* cg = new LateInlineVectorReboxingCallGenerator(method(), _inline_cg);
 851     cg->set_call_node(call->as_CallStaticJava());
 852     return cg;
 853   }
 854 };
 855 
 856 //   static CallGenerator* for_vector_reboxing_late_inline(ciMethod* m, CallGenerator* inline_cg);
 857 CallGenerator* CallGenerator::for_vector_reboxing_late_inline(ciMethod* method, CallGenerator* inline_cg) {
 858   return new LateInlineVectorReboxingCallGenerator(method, inline_cg);
 859 }
 860 
 861 //------------------------PredictedCallGenerator------------------------------
 862 // Internal class which handles all out-of-line calls checking receiver type.
 863 class PredictedCallGenerator : public CallGenerator {
 864   ciKlass*       _predicted_receiver;
 865   CallGenerator* _if_missed;
 866   CallGenerator* _if_hit;
 867   float          _hit_prob;
 868   bool           _exact_check;
 869 
 870 public:
 871   PredictedCallGenerator(ciKlass* predicted_receiver,
 872                          CallGenerator* if_missed,
 873                          CallGenerator* if_hit, bool exact_check,
 874                          float hit_prob)
 875     : CallGenerator(if_missed->method())
 876   {
 877     // The call profile data may predict the hit_prob as extreme as 0 or 1.
 878     // Remove the extremes values from the range.
 879     if (hit_prob > PROB_MAX)   hit_prob = PROB_MAX;
 880     if (hit_prob < PROB_MIN)   hit_prob = PROB_MIN;
 881 
 882     _predicted_receiver = predicted_receiver;
 883     _if_missed          = if_missed;
 884     _if_hit             = if_hit;
 885     _hit_prob           = hit_prob;
 886     _exact_check        = exact_check;
 887   }
 888 
 889   virtual bool      is_virtual()   const    { return true; }
 890   virtual bool      is_inline()    const    { return _if_hit->is_inline(); }
 891   virtual bool      is_deferred()  const    { return _if_hit->is_deferred(); }
 892 
 893   virtual JVMState* generate(JVMState* jvms);
 894 };
 895 
 896 
 897 CallGenerator* CallGenerator::for_predicted_call(ciKlass* predicted_receiver,
 898                                                  CallGenerator* if_missed,
 899                                                  CallGenerator* if_hit,
 900                                                  float hit_prob) {
 901   return new PredictedCallGenerator(predicted_receiver, if_missed, if_hit,
 902                                     /*exact_check=*/true, hit_prob);
 903 }
 904 
 905 CallGenerator* CallGenerator::for_guarded_call(ciKlass* guarded_receiver,
 906                                                CallGenerator* if_missed,
 907                                                CallGenerator* if_hit) {
 908   return new PredictedCallGenerator(guarded_receiver, if_missed, if_hit,
 909                                     /*exact_check=*/false, PROB_ALWAYS);
 910 }
 911 
 912 JVMState* PredictedCallGenerator::generate(JVMState* jvms) {
 913   GraphKit kit(jvms);
 914   kit.C->print_inlining_update(this);
 915   PhaseGVN& gvn = kit.gvn();
 916   // We need an explicit receiver null_check before checking its type.
 917   // We share a map with the caller, so his JVMS gets adjusted.
 918   Node* receiver = kit.argument(0);
 919   CompileLog* log = kit.C->log();
 920   if (log != NULL) {
 921     log->elem("predicted_call bci='%d' exact='%d' klass='%d'",
 922               jvms->bci(), (_exact_check ? 1 : 0), log->identify(_predicted_receiver));
 923   }
 924 
 925   receiver = kit.null_check_receiver_before_call(method());
 926   if (kit.stopped()) {
 927     return kit.transfer_exceptions_into_jvms();
 928   }
 929 
 930   // Make a copy of the replaced nodes in case we need to restore them
 931   ReplacedNodes replaced_nodes = kit.map()->replaced_nodes();
 932   replaced_nodes.clone();
 933 
 934   Node* casted_receiver = receiver;  // will get updated in place...
 935   Node* slow_ctl = NULL;
 936   if (_exact_check) {
 937     slow_ctl = kit.type_check_receiver(receiver, _predicted_receiver, _hit_prob,
 938                                        &casted_receiver);
 939   } else {
 940     slow_ctl = kit.subtype_check_receiver(receiver, _predicted_receiver,
 941                                           &casted_receiver);
 942   }
 943 
 944   SafePointNode* slow_map = NULL;
 945   JVMState* slow_jvms = NULL;
 946   { PreserveJVMState pjvms(&kit);
 947     kit.set_control(slow_ctl);
 948     if (!kit.stopped()) {
 949       slow_jvms = _if_missed->generate(kit.sync_jvms());
 950       if (kit.failing())
 951         return NULL;  // might happen because of NodeCountInliningCutoff
 952       assert(slow_jvms != NULL, "must be");
 953       kit.add_exception_states_from(slow_jvms);
 954       kit.set_map(slow_jvms->map());
 955       if (!kit.stopped())
 956         slow_map = kit.stop();
 957     }
 958   }
 959 
 960   if (kit.stopped()) {
 961     // Instance does not match the predicted type.
 962     kit.set_jvms(slow_jvms);
 963     return kit.transfer_exceptions_into_jvms();
 964   }
 965 
 966   // Fall through if the instance matches the desired type.
 967   kit.replace_in_map(receiver, casted_receiver);
 968 
 969   // Make the hot call:
 970   JVMState* new_jvms = _if_hit->generate(kit.sync_jvms());
 971   if (new_jvms == NULL) {
 972     // Inline failed, so make a direct call.
 973     assert(_if_hit->is_inline(), "must have been a failed inline");
 974     CallGenerator* cg = CallGenerator::for_direct_call(_if_hit->method());
 975     new_jvms = cg->generate(kit.sync_jvms());
 976   }
 977   kit.add_exception_states_from(new_jvms);
 978   kit.set_jvms(new_jvms);
 979 
 980   // Need to merge slow and fast?
 981   if (slow_map == NULL) {
 982     // The fast path is the only path remaining.
 983     return kit.transfer_exceptions_into_jvms();
 984   }
 985 
 986   if (kit.stopped()) {
 987     // Inlined method threw an exception, so it's just the slow path after all.
 988     kit.set_jvms(slow_jvms);
 989     return kit.transfer_exceptions_into_jvms();
 990   }
 991 
 992   // There are 2 branches and the replaced nodes are only valid on
 993   // one: restore the replaced nodes to what they were before the
 994   // branch.
 995   kit.map()->set_replaced_nodes(replaced_nodes);
 996 
 997   // Finish the diamond.
 998   kit.C->set_has_split_ifs(true); // Has chance for split-if optimization
 999   RegionNode* region = new RegionNode(3);
1000   region->init_req(1, kit.control());
1001   region->init_req(2, slow_map->control());
1002   kit.set_control(gvn.transform(region));
1003   Node* iophi = PhiNode::make(region, kit.i_o(), Type::ABIO);
1004   iophi->set_req(2, slow_map->i_o());
1005   kit.set_i_o(gvn.transform(iophi));
1006   // Merge memory
1007   kit.merge_memory(slow_map->merged_memory(), region, 2);
1008   // Transform new memory Phis.
1009   for (MergeMemStream mms(kit.merged_memory()); mms.next_non_empty();) {
1010     Node* phi = mms.memory();
1011     if (phi->is_Phi() && phi->in(0) == region) {
1012       mms.set_memory(gvn.transform(phi));
1013     }
1014   }
1015   uint tos = kit.jvms()->stkoff() + kit.sp();
1016   uint limit = slow_map->req();
1017   for (uint i = TypeFunc::Parms; i < limit; i++) {
1018     // Skip unused stack slots; fast forward to monoff();
1019     if (i == tos) {
1020       i = kit.jvms()->monoff();
1021       if( i >= limit ) break;
1022     }
1023     Node* m = kit.map()->in(i);
1024     Node* n = slow_map->in(i);
1025     if (m != n) {
1026       const Type* t = gvn.type(m)->meet_speculative(gvn.type(n));
1027       Node* phi = PhiNode::make(region, m, t);
1028       phi->set_req(2, n);
1029       kit.map()->set_req(i, gvn.transform(phi));
1030     }
1031   }
1032   return kit.transfer_exceptions_into_jvms();
1033 }
1034 
1035 
1036 CallGenerator* CallGenerator::for_method_handle_call(JVMState* jvms, ciMethod* caller, ciMethod* callee, bool allow_inline) {
1037   assert(callee->is_method_handle_intrinsic(), "for_method_handle_call mismatch");
1038   bool input_not_const;
1039   CallGenerator* cg = CallGenerator::for_method_handle_inline(jvms, caller, callee, allow_inline, input_not_const);
1040   Compile* C = Compile::current();
1041   if (cg != NULL) {
1042     if (AlwaysIncrementalInline) {
1043       return CallGenerator::for_late_inline(callee, cg);
1044     } else {
1045       return cg;
1046     }
1047   }
1048   int bci = jvms->bci();
1049   ciCallProfile profile = caller->call_profile_at_bci(bci);
1050   int call_site_count = caller->scale_count(profile.count());
1051 
1052   if (IncrementalInlineMH && call_site_count > 0 &&
1053       (input_not_const || !C->inlining_incrementally() || C->over_inlining_cutoff())) {
1054     return CallGenerator::for_mh_late_inline(caller, callee, input_not_const);
1055   } else {
1056     // Out-of-line call.
1057     return CallGenerator::for_direct_call(callee);
1058   }
1059 }
1060 
1061 class NativeCallGenerator : public CallGenerator {
1062 private:
1063   address _call_addr;
1064   ciNativeEntryPoint* _nep;
1065 public:
1066   NativeCallGenerator(ciMethod* m, address call_addr, ciNativeEntryPoint* nep)
1067    : CallGenerator(m), _call_addr(call_addr), _nep(nep) {}
1068 
1069   virtual JVMState* generate(JVMState* jvms);
1070 };
1071 
1072 JVMState* NativeCallGenerator::generate(JVMState* jvms) {
1073   GraphKit kit(jvms);
1074 
1075   Node* call = kit.make_native_call(_call_addr, tf(), method()->arg_size(), _nep); // -fallback, - nep
1076   if (call == NULL) return NULL;
1077 
1078   kit.C->print_inlining_update(this);
1079   if (kit.C->log() != NULL) {
1080     kit.C->log()->elem("l2n_intrinsification_success bci='%d' entry_point='" INTPTR_FORMAT "'", jvms->bci(), p2i(_call_addr));
1081   }
1082 
1083   return kit.transfer_exceptions_into_jvms();
1084 }
1085 
1086 CallGenerator* CallGenerator::for_method_handle_inline(JVMState* jvms, ciMethod* caller, ciMethod* callee, bool allow_inline, bool& input_not_const) {
1087   GraphKit kit(jvms);
1088   PhaseGVN& gvn = kit.gvn();
1089   Compile* C = kit.C;
1090   vmIntrinsics::ID iid = callee->intrinsic_id();
1091   input_not_const = true;
1092   if (StressMethodHandleLinkerInlining) {
1093     allow_inline = false;
1094   }
1095   switch (iid) {
1096   case vmIntrinsics::_invokeBasic:
1097     {
1098       // Get MethodHandle receiver:
1099       Node* receiver = kit.argument(0);
1100       if (receiver->Opcode() == Op_ConP) {
1101         input_not_const = false;
1102         const TypeOopPtr* oop_ptr = receiver->bottom_type()->is_oopptr();
1103         ciMethod* target = oop_ptr->const_oop()->as_method_handle()->get_vmtarget();
1104         const int vtable_index = Method::invalid_vtable_index;
1105 
1106         if (!ciMethod::is_consistent_info(callee, target)) {
1107           print_inlining_failure(C, callee, jvms->depth() - 1, jvms->bci(),
1108                                  "signatures mismatch");
1109           return NULL;
1110         }
1111 
1112         CallGenerator* cg = C->call_generator(target, vtable_index,
1113                                               false /* call_does_dispatch */,
1114                                               jvms,
1115                                               allow_inline,
1116                                               PROB_ALWAYS);
1117         return cg;
1118       } else {
1119         print_inlining_failure(C, callee, jvms->depth() - 1, jvms->bci(),
1120                                "receiver not constant");
1121       }
1122     }
1123     break;
1124 
1125   case vmIntrinsics::_linkToVirtual:
1126   case vmIntrinsics::_linkToStatic:
1127   case vmIntrinsics::_linkToSpecial:
1128   case vmIntrinsics::_linkToInterface:
1129     {
1130       // Get MemberName argument:
1131       Node* member_name = kit.argument(callee->arg_size() - 1);
1132       if (member_name->Opcode() == Op_ConP) {
1133         input_not_const = false;
1134         const TypeOopPtr* oop_ptr = member_name->bottom_type()->is_oopptr();
1135         ciMethod* target = oop_ptr->const_oop()->as_member_name()->get_vmtarget();
1136 
1137         if (!ciMethod::is_consistent_info(callee, target)) {
1138           print_inlining_failure(C, callee, jvms->depth() - 1, jvms->bci(),
1139                                  "signatures mismatch");
1140           return NULL;
1141         }
1142 
1143         // In lambda forms we erase signature types to avoid resolving issues
1144         // involving class loaders.  When we optimize a method handle invoke
1145         // to a direct call we must cast the receiver and arguments to its
1146         // actual types.
1147         ciSignature* signature = target->signature();
1148         const int receiver_skip = target->is_static() ? 0 : 1;
1149         // Cast receiver to its type.
1150         if (!target->is_static()) {
1151           Node* arg = kit.argument(0);
1152           const TypeOopPtr* arg_type = arg->bottom_type()->isa_oopptr();
1153           const Type*       sig_type = TypeOopPtr::make_from_klass(signature->accessing_klass());
1154           if (arg_type != NULL && !arg_type->higher_equal(sig_type)) {
1155             const Type* recv_type = arg_type->filter_speculative(sig_type); // keep speculative part
1156             Node* cast_obj = gvn.transform(new CheckCastPPNode(kit.control(), arg, recv_type));
1157             kit.set_argument(0, cast_obj);
1158           }
1159         }
1160         // Cast reference arguments to its type.
1161         for (int i = 0, j = 0; i < signature->count(); i++) {
1162           ciType* t = signature->type_at(i);
1163           if (t->is_klass()) {
1164             Node* arg = kit.argument(receiver_skip + j);
1165             const TypeOopPtr* arg_type = arg->bottom_type()->isa_oopptr();
1166             const Type*       sig_type = TypeOopPtr::make_from_klass(t->as_klass());
1167             if (arg_type != NULL && !arg_type->higher_equal(sig_type)) {
1168               const Type* narrowed_arg_type = arg_type->filter_speculative(sig_type); // keep speculative part
1169               Node* cast_obj = gvn.transform(new CheckCastPPNode(kit.control(), arg, narrowed_arg_type));
1170               kit.set_argument(receiver_skip + j, cast_obj);
1171             }
1172           }
1173           j += t->size();  // long and double take two slots
1174         }
1175 
1176         // Try to get the most accurate receiver type
1177         const bool is_virtual              = (iid == vmIntrinsics::_linkToVirtual);
1178         const bool is_virtual_or_interface = (is_virtual || iid == vmIntrinsics::_linkToInterface);
1179         int  vtable_index       = Method::invalid_vtable_index;
1180         bool call_does_dispatch = false;
1181 
1182         ciKlass* speculative_receiver_type = NULL;
1183         if (is_virtual_or_interface) {
1184           ciInstanceKlass* klass = target->holder();
1185           Node*             receiver_node = kit.argument(0);
1186           const TypeOopPtr* receiver_type = gvn.type(receiver_node)->isa_oopptr();
1187           // call_does_dispatch and vtable_index are out-parameters.  They might be changed.
1188           // optimize_virtual_call() takes 2 different holder
1189           // arguments for a corner case that doesn't apply here (see
1190           // Parse::do_call())
1191           target = C->optimize_virtual_call(caller, klass, klass,
1192                                             target, receiver_type, is_virtual,
1193                                             call_does_dispatch, vtable_index, // out-parameters
1194                                             false /* check_access */);
1195           // We lack profiling at this call but type speculation may
1196           // provide us with a type
1197           speculative_receiver_type = (receiver_type != NULL) ? receiver_type->speculative_type() : NULL;
1198         }
1199         CallGenerator* cg = C->call_generator(target, vtable_index, call_does_dispatch, jvms,
1200                                               allow_inline,
1201                                               PROB_ALWAYS,
1202                                               speculative_receiver_type);
1203         return cg;
1204       } else {
1205         print_inlining_failure(C, callee, jvms->depth() - 1, jvms->bci(),
1206                                "member_name not constant");
1207       }
1208     }
1209     break;
1210 
1211     case vmIntrinsics::_linkToNative:
1212     {
1213       Node* addr_n = kit.argument(1); // target address
1214       Node* nep_n = kit.argument(callee->arg_size() - 1); // NativeEntryPoint
1215       // This check needs to be kept in sync with the one in CallStaticJavaNode::Ideal
1216       if (addr_n->Opcode() == Op_ConL && nep_n->Opcode() == Op_ConP) {
1217         input_not_const = false;
1218         const TypeLong* addr_t = addr_n->bottom_type()->is_long();
1219         const TypeOopPtr* nep_t = nep_n->bottom_type()->is_oopptr();
1220         address addr = (address) addr_t->get_con();
1221         ciNativeEntryPoint* nep = nep_t->const_oop()->as_native_entry_point();
1222         return new NativeCallGenerator(callee, addr, nep);
1223       } else {
1224         print_inlining_failure(C, callee, jvms->depth() - 1, jvms->bci(),
1225                                "NativeEntryPoint not constant");
1226       }
1227     }
1228     break;
1229 
1230   default:
1231     fatal("unexpected intrinsic %d: %s", vmIntrinsics::as_int(iid), vmIntrinsics::name_at(iid));
1232     break;
1233   }
1234   return NULL;
1235 }
1236 
1237 
1238 //------------------------PredicatedIntrinsicGenerator------------------------------
1239 // Internal class which handles all predicated Intrinsic calls.
1240 class PredicatedIntrinsicGenerator : public CallGenerator {
1241   CallGenerator* _intrinsic;
1242   CallGenerator* _cg;
1243 
1244 public:
1245   PredicatedIntrinsicGenerator(CallGenerator* intrinsic,
1246                                CallGenerator* cg)
1247     : CallGenerator(cg->method())
1248   {
1249     _intrinsic = intrinsic;
1250     _cg        = cg;
1251   }
1252 
1253   virtual bool      is_virtual()   const    { return true; }
1254   virtual bool      is_inline()    const    { return true; }
1255   virtual bool      is_intrinsic() const    { return true; }
1256 
1257   virtual JVMState* generate(JVMState* jvms);
1258 };
1259 
1260 
1261 CallGenerator* CallGenerator::for_predicated_intrinsic(CallGenerator* intrinsic,
1262                                                        CallGenerator* cg) {
1263   return new PredicatedIntrinsicGenerator(intrinsic, cg);
1264 }
1265 
1266 
1267 JVMState* PredicatedIntrinsicGenerator::generate(JVMState* jvms) {
1268   // The code we want to generate here is:
1269   //    if (receiver == NULL)
1270   //        uncommon_Trap
1271   //    if (predicate(0))
1272   //        do_intrinsic(0)
1273   //    else
1274   //    if (predicate(1))
1275   //        do_intrinsic(1)
1276   //    ...
1277   //    else
1278   //        do_java_comp
1279 
1280   GraphKit kit(jvms);
1281   PhaseGVN& gvn = kit.gvn();
1282 
1283   CompileLog* log = kit.C->log();
1284   if (log != NULL) {
1285     log->elem("predicated_intrinsic bci='%d' method='%d'",
1286               jvms->bci(), log->identify(method()));
1287   }
1288 
1289   if (!method()->is_static()) {
1290     // We need an explicit receiver null_check before checking its type in predicate.
1291     // We share a map with the caller, so his JVMS gets adjusted.
1292     Node* receiver = kit.null_check_receiver_before_call(method());
1293     if (kit.stopped()) {
1294       return kit.transfer_exceptions_into_jvms();
1295     }
1296   }
1297 
1298   int n_predicates = _intrinsic->predicates_count();
1299   assert(n_predicates > 0, "sanity");
1300 
1301   JVMState** result_jvms = NEW_RESOURCE_ARRAY(JVMState*, (n_predicates+1));
1302 
1303   // Region for normal compilation code if intrinsic failed.
1304   Node* slow_region = new RegionNode(1);
1305 
1306   int results = 0;
1307   for (int predicate = 0; (predicate < n_predicates) && !kit.stopped(); predicate++) {
1308 #ifdef ASSERT
1309     JVMState* old_jvms = kit.jvms();
1310     SafePointNode* old_map = kit.map();
1311     Node* old_io  = old_map->i_o();
1312     Node* old_mem = old_map->memory();
1313     Node* old_exc = old_map->next_exception();
1314 #endif
1315     Node* else_ctrl = _intrinsic->generate_predicate(kit.sync_jvms(), predicate);
1316 #ifdef ASSERT
1317     // Assert(no_new_memory && no_new_io && no_new_exceptions) after generate_predicate.
1318     assert(old_jvms == kit.jvms(), "generate_predicate should not change jvm state");
1319     SafePointNode* new_map = kit.map();
1320     assert(old_io  == new_map->i_o(), "generate_predicate should not change i_o");
1321     assert(old_mem == new_map->memory(), "generate_predicate should not change memory");
1322     assert(old_exc == new_map->next_exception(), "generate_predicate should not add exceptions");
1323 #endif
1324     if (!kit.stopped()) {
1325       PreserveJVMState pjvms(&kit);
1326       // Generate intrinsic code:
1327       JVMState* new_jvms = _intrinsic->generate(kit.sync_jvms());
1328       if (new_jvms == NULL) {
1329         // Intrinsic failed, use normal compilation path for this predicate.
1330         slow_region->add_req(kit.control());
1331       } else {
1332         kit.add_exception_states_from(new_jvms);
1333         kit.set_jvms(new_jvms);
1334         if (!kit.stopped()) {
1335           result_jvms[results++] = kit.jvms();
1336         }
1337       }
1338     }
1339     if (else_ctrl == NULL) {
1340       else_ctrl = kit.C->top();
1341     }
1342     kit.set_control(else_ctrl);
1343   }
1344   if (!kit.stopped()) {
1345     // Final 'else' after predicates.
1346     slow_region->add_req(kit.control());
1347   }
1348   if (slow_region->req() > 1) {
1349     PreserveJVMState pjvms(&kit);
1350     // Generate normal compilation code:
1351     kit.set_control(gvn.transform(slow_region));
1352     JVMState* new_jvms = _cg->generate(kit.sync_jvms());
1353     if (kit.failing())
1354       return NULL;  // might happen because of NodeCountInliningCutoff
1355     assert(new_jvms != NULL, "must be");
1356     kit.add_exception_states_from(new_jvms);
1357     kit.set_jvms(new_jvms);
1358     if (!kit.stopped()) {
1359       result_jvms[results++] = kit.jvms();
1360     }
1361   }
1362 
1363   if (results == 0) {
1364     // All paths ended in uncommon traps.
1365     (void) kit.stop();
1366     return kit.transfer_exceptions_into_jvms();
1367   }
1368 
1369   if (results == 1) { // Only one path
1370     kit.set_jvms(result_jvms[0]);
1371     return kit.transfer_exceptions_into_jvms();
1372   }
1373 
1374   // Merge all paths.
1375   kit.C->set_has_split_ifs(true); // Has chance for split-if optimization
1376   RegionNode* region = new RegionNode(results + 1);
1377   Node* iophi = PhiNode::make(region, kit.i_o(), Type::ABIO);
1378   for (int i = 0; i < results; i++) {
1379     JVMState* jvms = result_jvms[i];
1380     int path = i + 1;
1381     SafePointNode* map = jvms->map();
1382     region->init_req(path, map->control());
1383     iophi->set_req(path, map->i_o());
1384     if (i == 0) {
1385       kit.set_jvms(jvms);
1386     } else {
1387       kit.merge_memory(map->merged_memory(), region, path);
1388     }
1389   }
1390   kit.set_control(gvn.transform(region));
1391   kit.set_i_o(gvn.transform(iophi));
1392   // Transform new memory Phis.
1393   for (MergeMemStream mms(kit.merged_memory()); mms.next_non_empty();) {
1394     Node* phi = mms.memory();
1395     if (phi->is_Phi() && phi->in(0) == region) {
1396       mms.set_memory(gvn.transform(phi));
1397     }
1398   }
1399 
1400   // Merge debug info.
1401   Node** ins = NEW_RESOURCE_ARRAY(Node*, results);
1402   uint tos = kit.jvms()->stkoff() + kit.sp();
1403   Node* map = kit.map();
1404   uint limit = map->req();
1405   for (uint i = TypeFunc::Parms; i < limit; i++) {
1406     // Skip unused stack slots; fast forward to monoff();
1407     if (i == tos) {
1408       i = kit.jvms()->monoff();
1409       if( i >= limit ) break;
1410     }
1411     Node* n = map->in(i);
1412     ins[0] = n;
1413     const Type* t = gvn.type(n);
1414     bool needs_phi = false;
1415     for (int j = 1; j < results; j++) {
1416       JVMState* jvms = result_jvms[j];
1417       Node* jmap = jvms->map();
1418       Node* m = NULL;
1419       if (jmap->req() > i) {
1420         m = jmap->in(i);
1421         if (m != n) {
1422           needs_phi = true;
1423           t = t->meet_speculative(gvn.type(m));
1424         }
1425       }
1426       ins[j] = m;
1427     }
1428     if (needs_phi) {
1429       Node* phi = PhiNode::make(region, n, t);
1430       for (int j = 1; j < results; j++) {
1431         phi->set_req(j + 1, ins[j]);
1432       }
1433       map->set_req(i, gvn.transform(phi));
1434     }
1435   }
1436 
1437   return kit.transfer_exceptions_into_jvms();
1438 }
1439 
1440 //-------------------------UncommonTrapCallGenerator-----------------------------
1441 // Internal class which handles all out-of-line calls checking receiver type.
1442 class UncommonTrapCallGenerator : public CallGenerator {
1443   Deoptimization::DeoptReason _reason;
1444   Deoptimization::DeoptAction _action;
1445 
1446 public:
1447   UncommonTrapCallGenerator(ciMethod* m,
1448                             Deoptimization::DeoptReason reason,
1449                             Deoptimization::DeoptAction action)
1450     : CallGenerator(m)
1451   {
1452     _reason = reason;
1453     _action = action;
1454   }
1455 
1456   virtual bool      is_virtual() const          { ShouldNotReachHere(); return false; }
1457   virtual bool      is_trap() const             { return true; }
1458 
1459   virtual JVMState* generate(JVMState* jvms);
1460 };
1461 
1462 
1463 CallGenerator*
1464 CallGenerator::for_uncommon_trap(ciMethod* m,
1465                                  Deoptimization::DeoptReason reason,
1466                                  Deoptimization::DeoptAction action) {
1467   return new UncommonTrapCallGenerator(m, reason, action);
1468 }
1469 
1470 
1471 JVMState* UncommonTrapCallGenerator::generate(JVMState* jvms) {
1472   GraphKit kit(jvms);
1473   kit.C->print_inlining_update(this);
1474   // Take the trap with arguments pushed on the stack.  (Cf. null_check_receiver).
1475   // Callsite signature can be different from actual method being called (i.e _linkTo* sites).
1476   // Use callsite signature always.
1477   ciMethod* declared_method = kit.method()->get_method_at_bci(kit.bci());
1478   int nargs = declared_method->arg_size();
1479   kit.inc_sp(nargs);
1480   assert(nargs <= kit.sp() && kit.sp() <= jvms->stk_size(), "sane sp w/ args pushed");
1481   if (_reason == Deoptimization::Reason_class_check &&
1482       _action == Deoptimization::Action_maybe_recompile) {
1483     // Temp fix for 6529811
1484     // Don't allow uncommon_trap to override our decision to recompile in the event
1485     // of a class cast failure for a monomorphic call as it will never let us convert
1486     // the call to either bi-morphic or megamorphic and can lead to unc-trap loops
1487     bool keep_exact_action = true;
1488     kit.uncommon_trap(_reason, _action, NULL, "monomorphic vcall checkcast", false, keep_exact_action);
1489   } else {
1490     kit.uncommon_trap(_reason, _action);
1491   }
1492   return kit.transfer_exceptions_into_jvms();
1493 }
1494 
1495 // (Note:  Moved hook_up_call to GraphKit::set_edges_for_java_call.)
1496 
1497 // (Node:  Merged hook_up_exits into ParseGenerator::generate.)