1 /*
   2  * Copyright (c) 1998, 2025, 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 "ci/ciCallSite.hpp"
  26 #include "ci/ciMethodHandle.hpp"
  27 #include "ci/ciSymbols.hpp"
  28 #include "classfile/vmIntrinsics.hpp"
  29 #include "classfile/vmSymbols.hpp"
  30 #include "compiler/compileBroker.hpp"
  31 #include "compiler/compileLog.hpp"
  32 #include "interpreter/linkResolver.hpp"
  33 #include "jvm_io.h"
  34 #include "logging/log.hpp"
  35 #include "logging/logLevel.hpp"
  36 #include "logging/logMessage.hpp"
  37 #include "logging/logStream.hpp"
  38 #include "opto/addnode.hpp"
  39 #include "opto/callGenerator.hpp"
  40 #include "opto/castnode.hpp"
  41 #include "opto/cfgnode.hpp"
  42 #include "opto/inlinetypenode.hpp"
  43 #include "opto/mulnode.hpp"
  44 #include "opto/parse.hpp"
  45 #include "opto/rootnode.hpp"
  46 #include "opto/runtime.hpp"
  47 #include "opto/subnode.hpp"
  48 #include "prims/methodHandles.hpp"
  49 #include "runtime/sharedRuntime.hpp"
  50 #include "utilities/macros.hpp"
  51 #if INCLUDE_JFR
  52 #include "jfr/jfr.hpp"
  53 #endif
  54 
  55 static void print_trace_type_profile(outputStream* out, int depth, ciKlass* prof_klass, int site_count, int receiver_count,
  56                                      bool with_deco) {
  57   if (with_deco) {
  58     CompileTask::print_inline_indent(depth, out);
  59   }
  60   out->print(" \\-> TypeProfile (%d/%d counts) = ", receiver_count, site_count);
  61   prof_klass->name()->print_symbol_on(out);
  62   if (with_deco) {
  63     out->cr();
  64   }
  65 }
  66 
  67 static void trace_type_profile(Compile* C, ciMethod* method, JVMState* jvms,
  68                                ciMethod* prof_method, ciKlass* prof_klass, int site_count, int receiver_count) {
  69   int depth = jvms->depth() - 1;
  70   int bci = jvms->bci();
  71   if (TraceTypeProfile || C->print_inlining()) {
  72     if (!C->print_inlining()) {
  73       if (!PrintOpto && !PrintCompilation) {
  74         method->print_short_name();
  75         tty->cr();
  76       }
  77       CompileTask::print_inlining_tty(prof_method, depth, bci, InliningResult::SUCCESS);
  78       print_trace_type_profile(tty, depth, prof_klass, site_count, receiver_count, true);
  79     } else {
  80       auto stream = C->inline_printer()->record(method, jvms, InliningResult::SUCCESS);
  81       print_trace_type_profile(stream, depth, prof_klass, site_count, receiver_count, false);
  82     }
  83   }
  84 
  85   LogTarget(Debug, jit, inlining) lt;
  86   if (lt.is_enabled()) {
  87     LogStream ls(lt);
  88     print_trace_type_profile(&ls, depth, prof_klass, site_count, receiver_count, true);
  89   }
  90 }
  91 
  92 static bool arg_can_be_larval(ciMethod* callee, int arg_idx) {
  93   if (callee->is_object_constructor() && arg_idx == 0) {
  94     return true;
  95   }
  96 
  97   if (arg_idx != 1 || callee->intrinsic_id() == vmIntrinsicID::_none) {
  98     return false;
  99   }
 100 
 101   switch (callee->intrinsic_id()) {
 102     case vmIntrinsicID::_finishPrivateBuffer:
 103     case vmIntrinsicID::_putBoolean:
 104     case vmIntrinsicID::_putBooleanOpaque:
 105     case vmIntrinsicID::_putBooleanRelease:
 106     case vmIntrinsicID::_putBooleanVolatile:
 107     case vmIntrinsicID::_putByte:
 108     case vmIntrinsicID::_putByteOpaque:
 109     case vmIntrinsicID::_putByteRelease:
 110     case vmIntrinsicID::_putByteVolatile:
 111     case vmIntrinsicID::_putChar:
 112     case vmIntrinsicID::_putCharOpaque:
 113     case vmIntrinsicID::_putCharRelease:
 114     case vmIntrinsicID::_putCharUnaligned:
 115     case vmIntrinsicID::_putCharVolatile:
 116     case vmIntrinsicID::_putShort:
 117     case vmIntrinsicID::_putShortOpaque:
 118     case vmIntrinsicID::_putShortRelease:
 119     case vmIntrinsicID::_putShortUnaligned:
 120     case vmIntrinsicID::_putShortVolatile:
 121     case vmIntrinsicID::_putInt:
 122     case vmIntrinsicID::_putIntOpaque:
 123     case vmIntrinsicID::_putIntRelease:
 124     case vmIntrinsicID::_putIntUnaligned:
 125     case vmIntrinsicID::_putIntVolatile:
 126     case vmIntrinsicID::_putLong:
 127     case vmIntrinsicID::_putLongOpaque:
 128     case vmIntrinsicID::_putLongRelease:
 129     case vmIntrinsicID::_putLongUnaligned:
 130     case vmIntrinsicID::_putLongVolatile:
 131     case vmIntrinsicID::_putFloat:
 132     case vmIntrinsicID::_putFloatOpaque:
 133     case vmIntrinsicID::_putFloatRelease:
 134     case vmIntrinsicID::_putFloatVolatile:
 135     case vmIntrinsicID::_putDouble:
 136     case vmIntrinsicID::_putDoubleOpaque:
 137     case vmIntrinsicID::_putDoubleRelease:
 138     case vmIntrinsicID::_putDoubleVolatile:
 139     case vmIntrinsicID::_putReference:
 140     case vmIntrinsicID::_putReferenceOpaque:
 141     case vmIntrinsicID::_putReferenceRelease:
 142     case vmIntrinsicID::_putReferenceVolatile:
 143       return true;
 144     default:
 145       return false;
 146   }
 147 }
 148 
 149 CallGenerator* Compile::call_generator(ciMethod* callee, int vtable_index, bool call_does_dispatch,
 150                                        JVMState* jvms, bool allow_inline,
 151                                        float prof_factor, ciKlass* speculative_receiver_type,
 152                                        bool allow_intrinsics) {
 153   assert(callee != nullptr, "failed method resolution");
 154 
 155   ciMethod*       caller      = jvms->method();
 156   int             bci         = jvms->bci();
 157   Bytecodes::Code bytecode    = caller->java_code_at_bci(bci);
 158   ciMethod*       orig_callee = caller->get_method_at_bci(bci);
 159 
 160   const bool is_virtual = (bytecode == Bytecodes::_invokevirtual) || (orig_callee->intrinsic_id() == vmIntrinsics::_linkToVirtual);
 161   const bool is_interface = (bytecode == Bytecodes::_invokeinterface) || (orig_callee->intrinsic_id() == vmIntrinsics::_linkToInterface);
 162   const bool is_virtual_or_interface = is_virtual || is_interface;
 163 
 164   const bool check_access = !orig_callee->is_method_handle_intrinsic(); // method handle intrinsics don't perform access checks
 165 
 166   // Dtrace currently doesn't work unless all calls are vanilla
 167   if (env()->dtrace_method_probes()) {
 168     allow_inline = false;
 169   }
 170 
 171   // Note: When we get profiling during stage-1 compiles, we want to pull
 172   // from more specific profile data which pertains to this inlining.
 173   // Right now, ignore the information in jvms->caller(), and do method[bci].
 174   ciCallProfile profile = caller->call_profile_at_bci(bci);
 175 
 176   // See how many times this site has been invoked.
 177   int site_count = profile.count();
 178   int receiver_count = -1;
 179   if (call_does_dispatch && UseTypeProfile && profile.has_receiver(0)) {
 180     // Receivers in the profile structure are ordered by call counts
 181     // so that the most called (major) receiver is profile.receiver(0).
 182     receiver_count = profile.receiver_count(0);
 183   }
 184 
 185   CompileLog* log = this->log();
 186   if (log != nullptr) {
 187     int rid = (receiver_count >= 0)? log->identify(profile.receiver(0)): -1;
 188     int r2id = (rid != -1 && profile.has_receiver(1))? log->identify(profile.receiver(1)):-1;
 189     log->begin_elem("call method='%d' count='%d' prof_factor='%f'",
 190                     log->identify(callee), site_count, prof_factor);
 191     if (call_does_dispatch)  log->print(" virtual='1'");
 192     if (allow_inline)     log->print(" inline='1'");
 193     if (receiver_count >= 0) {
 194       log->print(" receiver='%d' receiver_count='%d'", rid, receiver_count);
 195       if (profile.has_receiver(1)) {
 196         log->print(" receiver2='%d' receiver2_count='%d'", r2id, profile.receiver_count(1));
 197       }
 198     }
 199     if (callee->is_method_handle_intrinsic()) {
 200       log->print(" method_handle_intrinsic='1'");
 201     }
 202     log->end_elem();
 203   }
 204 
 205   // Special case the handling of certain common, profitable library
 206   // methods.  If these methods are replaced with specialized code,
 207   // then we return it as the inlined version of the call.
 208   CallGenerator* cg_intrinsic = nullptr;
 209   if (callee->intrinsic_id() == vmIntrinsics::_makePrivateBuffer || callee->intrinsic_id() == vmIntrinsics::_finishPrivateBuffer) {
 210     // These methods must be inlined so that we don't have larval value objects crossing method
 211     // boundaries
 212     assert(!call_does_dispatch, "callee should not be virtual %s", callee->name()->as_utf8());
 213     CallGenerator* cg = find_intrinsic(callee, call_does_dispatch);
 214 
 215     if (cg == nullptr) {
 216       // This is probably because the intrinsics is disabled from the command line
 217       char reason[256];
 218       jio_snprintf(reason, sizeof(reason), "cannot find an intrinsics for %s", callee->name()->as_utf8());
 219       C->record_method_not_compilable(reason);
 220       return nullptr;
 221     }
 222     return cg;
 223   } else if (allow_inline && allow_intrinsics) {
 224     CallGenerator* cg = find_intrinsic(callee, call_does_dispatch);
 225     if (cg != nullptr) {
 226       if (cg->is_predicated()) {
 227         // Code without intrinsic but, hopefully, inlined.
 228         CallGenerator* inline_cg = this->call_generator(callee,
 229               vtable_index, call_does_dispatch, jvms, allow_inline, prof_factor, speculative_receiver_type, false);
 230         if (inline_cg != nullptr) {
 231           cg = CallGenerator::for_predicated_intrinsic(cg, inline_cg);
 232         }
 233       }
 234 
 235       // If intrinsic does the virtual dispatch, we try to use the type profile
 236       // first, and hopefully inline it as the regular virtual call below.
 237       // We will retry the intrinsic if nothing had claimed it afterwards.
 238       if (cg->does_virtual_dispatch()) {
 239         cg_intrinsic = cg;
 240         cg = nullptr;
 241       } else if (IncrementalInline && should_delay_vector_inlining(callee, jvms)) {
 242         return CallGenerator::for_late_inline(callee, cg);
 243       } else {
 244         return cg;
 245       }
 246     }
 247   }
 248 
 249   // Do method handle calls.
 250   // NOTE: This must happen before normal inlining logic below since
 251   // MethodHandle.invoke* are native methods which obviously don't
 252   // have bytecodes and so normal inlining fails.
 253   if (callee->is_method_handle_intrinsic()) {
 254     CallGenerator* cg = CallGenerator::for_method_handle_call(jvms, caller, callee, allow_inline);
 255     return cg;
 256   }
 257 
 258   // Attempt to inline...
 259   if (allow_inline) {
 260     // The profile data is only partly attributable to this caller,
 261     // scale back the call site information.
 262     float past_uses = jvms->method()->scale_count(site_count, prof_factor);
 263     // This is the number of times we expect the call code to be used.
 264     float expected_uses = past_uses;
 265 
 266     // Try inlining a bytecoded method:
 267     if (!call_does_dispatch) {
 268       InlineTree* ilt = InlineTree::find_subtree_from_root(this->ilt(), jvms->caller(), jvms->method());
 269       bool should_delay = C->should_delay_inlining();
 270       if (ilt->ok_to_inline(callee, jvms, profile, should_delay)) {
 271         CallGenerator* cg = CallGenerator::for_inline(callee, expected_uses);
 272         // For optimized virtual calls assert at runtime that receiver object
 273         // is a subtype of the inlined method holder. CHA can report a method
 274         // as a unique target under an abstract method, but receiver type
 275         // sometimes has a broader type. Similar scenario is possible with
 276         // default methods when type system loses information about implemented
 277         // interfaces.
 278         if (cg != nullptr && is_virtual_or_interface && !callee->is_static()) {
 279           CallGenerator* trap_cg = CallGenerator::for_uncommon_trap(callee,
 280               Deoptimization::Reason_receiver_constraint, Deoptimization::Action_none);
 281 
 282           cg = CallGenerator::for_guarded_call(callee->holder(), trap_cg, cg);
 283         }
 284         if (cg != nullptr) {
 285           // Delay the inlining of this method to give us the
 286           // opportunity to perform some high level optimizations
 287           // first.
 288           if (should_delay) {
 289             return CallGenerator::for_late_inline(callee, cg);
 290           } else if (should_delay_string_inlining(callee, jvms)) {
 291             return CallGenerator::for_string_late_inline(callee, cg);
 292           } else if (should_delay_boxing_inlining(callee, jvms)) {
 293             return CallGenerator::for_boxing_late_inline(callee, cg);
 294           } else if (should_delay_vector_reboxing_inlining(callee, jvms)) {
 295             return CallGenerator::for_vector_reboxing_late_inline(callee, cg);
 296           } else {
 297             return cg;
 298           }
 299         }
 300       }
 301     }
 302 
 303     // Try using the type profile.
 304     if (call_does_dispatch && site_count > 0 && UseTypeProfile) {
 305       // The major receiver's count >= TypeProfileMajorReceiverPercent of site_count.
 306       bool have_major_receiver = profile.has_receiver(0) && (100.*profile.receiver_prob(0) >= (float)TypeProfileMajorReceiverPercent);
 307       ciMethod* receiver_method = nullptr;
 308 
 309       int morphism = profile.morphism();
 310       if (speculative_receiver_type != nullptr) {
 311         if (!too_many_traps_or_recompiles(caller, bci, Deoptimization::Reason_speculate_class_check)) {
 312           // We have a speculative type, we should be able to resolve
 313           // the call. We do that before looking at the profiling at
 314           // this invoke because it may lead to bimorphic inlining which
 315           // a speculative type should help us avoid.
 316           receiver_method = callee->resolve_invoke(jvms->method()->holder(),
 317                                                    speculative_receiver_type,
 318                                                    check_access);
 319           if (receiver_method == nullptr) {
 320             speculative_receiver_type = nullptr;
 321           } else {
 322             morphism = 1;
 323           }
 324         } else {
 325           // speculation failed before. Use profiling at the call
 326           // (could allow bimorphic inlining for instance).
 327           speculative_receiver_type = nullptr;
 328         }
 329       }
 330       if (receiver_method == nullptr &&
 331           (have_major_receiver || morphism == 1 ||
 332            (morphism == 2 && UseBimorphicInlining))) {
 333         // receiver_method = profile.method();
 334         // Profiles do not suggest methods now.  Look it up in the major receiver.
 335         assert(check_access, "required");
 336         receiver_method = callee->resolve_invoke(jvms->method()->holder(),
 337                                                  profile.receiver(0));
 338       }
 339       if (receiver_method != nullptr) {
 340         // The single majority receiver sufficiently outweighs the minority.
 341         CallGenerator* hit_cg = this->call_generator(receiver_method,
 342               vtable_index, !call_does_dispatch, jvms, allow_inline, prof_factor);
 343         if (hit_cg != nullptr) {
 344           // Look up second receiver.
 345           CallGenerator* next_hit_cg = nullptr;
 346           ciMethod* next_receiver_method = nullptr;
 347           if (morphism == 2 && UseBimorphicInlining) {
 348             assert(check_access, "required");
 349             next_receiver_method = callee->resolve_invoke(jvms->method()->holder(),
 350                                                           profile.receiver(1));
 351             if (next_receiver_method != nullptr) {
 352               next_hit_cg = this->call_generator(next_receiver_method,
 353                                   vtable_index, !call_does_dispatch, jvms,
 354                                   allow_inline, prof_factor);
 355               if (next_hit_cg != nullptr && !next_hit_cg->is_inline() &&
 356                   have_major_receiver && UseOnlyInlinedBimorphic) {
 357                   // Skip if we can't inline second receiver's method
 358                   next_hit_cg = nullptr;
 359               }
 360             }
 361           }
 362           CallGenerator* miss_cg;
 363           Deoptimization::DeoptReason reason = (morphism == 2
 364                                                ? Deoptimization::Reason_bimorphic
 365                                                : Deoptimization::reason_class_check(speculative_receiver_type != nullptr));
 366           if ((morphism == 1 || (morphism == 2 && next_hit_cg != nullptr)) &&
 367               !too_many_traps_or_recompiles(caller, bci, reason)
 368              ) {
 369             // Generate uncommon trap for class check failure path
 370             // in case of monomorphic or bimorphic virtual call site.
 371             miss_cg = CallGenerator::for_uncommon_trap(callee, reason,
 372                         Deoptimization::Action_maybe_recompile);
 373           } else {
 374             // Generate virtual call for class check failure path
 375             // in case of polymorphic virtual call site.
 376             miss_cg = (IncrementalInlineVirtual ? CallGenerator::for_late_inline_virtual(callee, vtable_index, prof_factor)
 377                                                 : CallGenerator::for_virtual_call(callee, vtable_index));
 378           }
 379           if (miss_cg != nullptr) {
 380             if (next_hit_cg != nullptr) {
 381               assert(speculative_receiver_type == nullptr, "shouldn't end up here if we used speculation");
 382               trace_type_profile(C, jvms->method(), jvms, next_receiver_method, profile.receiver(1), site_count, profile.receiver_count(1));
 383               // We don't need to record dependency on a receiver here and below.
 384               // Whenever we inline, the dependency is added by Parse::Parse().
 385               miss_cg = CallGenerator::for_predicted_call(profile.receiver(1), miss_cg, next_hit_cg, PROB_MAX);
 386             }
 387             if (miss_cg != nullptr) {
 388               ciKlass* k = speculative_receiver_type != nullptr ? speculative_receiver_type : profile.receiver(0);
 389               trace_type_profile(C, jvms->method(), jvms, receiver_method, k, site_count, receiver_count);
 390               float hit_prob = speculative_receiver_type != nullptr ? 1.0 : profile.receiver_prob(0);
 391               CallGenerator* cg = CallGenerator::for_predicted_call(k, miss_cg, hit_cg, hit_prob);
 392               if (cg != nullptr) {
 393                 return cg;
 394               }
 395             }
 396           }
 397         }
 398       }
 399     }
 400 
 401     // If there is only one implementor of this interface then we
 402     // may be able to bind this invoke directly to the implementing
 403     // klass but we need both a dependence on the single interface
 404     // and on the method we bind to. Additionally since all we know
 405     // about the receiver type is that it's supposed to implement the
 406     // interface we have to insert a check that it's the class we
 407     // expect.  Interface types are not checked by the verifier so
 408     // they are roughly equivalent to Object.
 409     // The number of implementors for declared_interface is less or
 410     // equal to the number of implementors for target->holder() so
 411     // if number of implementors of target->holder() == 1 then
 412     // number of implementors for decl_interface is 0 or 1. If
 413     // it's 0 then no class implements decl_interface and there's
 414     // no point in inlining.
 415     if (call_does_dispatch && is_interface) {
 416       ciInstanceKlass* declared_interface = nullptr;
 417       if (orig_callee->intrinsic_id() == vmIntrinsics::_linkToInterface) {
 418         // MemberName doesn't keep information about resolved interface class (REFC) once
 419         // resolution is over, but resolved method holder (DECC) can be used as a
 420         // conservative approximation.
 421         declared_interface = callee->holder();
 422       } else {
 423         assert(!orig_callee->is_method_handle_intrinsic(), "not allowed");
 424         declared_interface = caller->get_declared_method_holder_at_bci(bci)->as_instance_klass();
 425       }
 426       assert(declared_interface->is_interface(), "required");
 427       ciInstanceKlass* singleton = declared_interface->unique_implementor();
 428 
 429       if (singleton != nullptr) {
 430         assert(singleton != declared_interface, "not a unique implementor");
 431 
 432         ciMethod* cha_monomorphic_target =
 433             callee->find_monomorphic_target(caller->holder(), declared_interface, singleton, check_access);
 434 
 435         if (cha_monomorphic_target != nullptr &&
 436             cha_monomorphic_target->holder() != env()->Object_klass()) { // subtype check against Object is useless
 437           ciKlass* holder = cha_monomorphic_target->holder();
 438 
 439           // Try to inline the method found by CHA. Inlined method is guarded by the type check.
 440           CallGenerator* hit_cg = call_generator(cha_monomorphic_target,
 441               vtable_index, !call_does_dispatch, jvms, allow_inline, prof_factor);
 442 
 443           // Deoptimize on type check fail. The interpreter will throw ICCE for us.
 444           CallGenerator* miss_cg = CallGenerator::for_uncommon_trap(callee,
 445               Deoptimization::Reason_class_check, Deoptimization::Action_none);
 446 
 447           ciKlass* constraint = (holder->is_subclass_of(singleton) ? holder : singleton); // avoid upcasts
 448           CallGenerator* cg = CallGenerator::for_guarded_call(constraint, miss_cg, hit_cg);
 449           if (hit_cg != nullptr && cg != nullptr) {
 450             dependencies()->assert_unique_implementor(declared_interface, singleton);
 451             dependencies()->assert_unique_concrete_method(declared_interface, cha_monomorphic_target, declared_interface, callee);
 452             return cg;
 453           }
 454         }
 455       }
 456     } // call_does_dispatch && is_interface
 457 
 458     // Nothing claimed the intrinsic, we go with straight-forward inlining
 459     // for already discovered intrinsic.
 460     if (allow_intrinsics && cg_intrinsic != nullptr) {
 461       assert(cg_intrinsic->does_virtual_dispatch(), "sanity");
 462       return cg_intrinsic;
 463     }
 464   } // allow_inline
 465 
 466   // There was no special inlining tactic, or it bailed out.
 467   // Use a more generic tactic, like a simple call.
 468   if (call_does_dispatch) {
 469     const char* msg = "virtual call";
 470     C->inline_printer()->record(callee, jvms, InliningResult::FAILURE, msg);
 471     C->log_inline_failure(msg);
 472     if (IncrementalInlineVirtual && allow_inline) {
 473       return CallGenerator::for_late_inline_virtual(callee, vtable_index, prof_factor); // attempt to inline through virtual call later
 474     } else {
 475       return CallGenerator::for_virtual_call(callee, vtable_index);
 476     }
 477   } else {
 478     // Class Hierarchy Analysis or Type Profile reveals a unique target, or it is a static or special call.
 479     CallGenerator* cg = CallGenerator::for_direct_call(callee, should_delay_inlining(callee, jvms));
 480     // For optimized virtual calls assert at runtime that receiver object
 481     // is a subtype of the method holder.
 482     if (cg != nullptr && is_virtual_or_interface && !callee->is_static()) {
 483       CallGenerator* trap_cg = CallGenerator::for_uncommon_trap(callee,
 484           Deoptimization::Reason_receiver_constraint, Deoptimization::Action_none);
 485       cg = CallGenerator::for_guarded_call(callee->holder(), trap_cg, cg);
 486     }
 487     return cg;
 488   }
 489 }
 490 
 491 // Return true for methods that shouldn't be inlined early so that
 492 // they are easier to analyze and optimize as intrinsics.
 493 bool Compile::should_delay_string_inlining(ciMethod* call_method, JVMState* jvms) {
 494   if (has_stringbuilder()) {
 495 
 496     if ((call_method->holder() == C->env()->StringBuilder_klass() ||
 497          call_method->holder() == C->env()->StringBuffer_klass()) &&
 498         (jvms->method()->holder() == C->env()->StringBuilder_klass() ||
 499          jvms->method()->holder() == C->env()->StringBuffer_klass())) {
 500       // Delay SB calls only when called from non-SB code
 501       return false;
 502     }
 503 
 504     switch (call_method->intrinsic_id()) {
 505       case vmIntrinsics::_StringBuilder_void:
 506       case vmIntrinsics::_StringBuilder_int:
 507       case vmIntrinsics::_StringBuilder_String:
 508       case vmIntrinsics::_StringBuilder_append_char:
 509       case vmIntrinsics::_StringBuilder_append_int:
 510       case vmIntrinsics::_StringBuilder_append_String:
 511       case vmIntrinsics::_StringBuilder_toString:
 512       case vmIntrinsics::_StringBuffer_void:
 513       case vmIntrinsics::_StringBuffer_int:
 514       case vmIntrinsics::_StringBuffer_String:
 515       case vmIntrinsics::_StringBuffer_append_char:
 516       case vmIntrinsics::_StringBuffer_append_int:
 517       case vmIntrinsics::_StringBuffer_append_String:
 518       case vmIntrinsics::_StringBuffer_toString:
 519       case vmIntrinsics::_Integer_toString:
 520         return true;
 521 
 522       case vmIntrinsics::_String_String:
 523         {
 524           Node* receiver = jvms->map()->in(jvms->argoff() + 1);
 525           if (receiver->is_Proj() && receiver->in(0)->is_CallStaticJava()) {
 526             CallStaticJavaNode* csj = receiver->in(0)->as_CallStaticJava();
 527             ciMethod* m = csj->method();
 528             if (m != nullptr &&
 529                 (m->intrinsic_id() == vmIntrinsics::_StringBuffer_toString ||
 530                  m->intrinsic_id() == vmIntrinsics::_StringBuilder_toString))
 531               // Delay String.<init>(new SB())
 532               return true;
 533           }
 534           return false;
 535         }
 536 
 537       default:
 538         return false;
 539     }
 540   }
 541   return false;
 542 }
 543 
 544 bool Compile::should_delay_boxing_inlining(ciMethod* call_method, JVMState* jvms) {
 545   if (eliminate_boxing() && call_method->is_boxing_method()) {
 546     set_has_boxed_value(true);
 547     return aggressive_unboxing();
 548   }
 549   return false;
 550 }
 551 
 552 bool Compile::should_delay_vector_inlining(ciMethod* call_method, JVMState* jvms) {
 553   return EnableVectorSupport && call_method->is_vector_method();
 554 }
 555 
 556 bool Compile::should_delay_vector_reboxing_inlining(ciMethod* call_method, JVMState* jvms) {
 557   return EnableVectorSupport && (call_method->intrinsic_id() == vmIntrinsics::_VectorRebox);
 558 }
 559 
 560 // uncommon-trap call-sites where callee is unloaded, uninitialized or will not link
 561 bool Parse::can_not_compile_call_site(ciMethod *dest_method, ciInstanceKlass* klass) {
 562   // Additional inputs to consider...
 563   // bc      = bc()
 564   // caller  = method()
 565   // iter().get_method_holder_index()
 566   assert( dest_method->is_loaded(), "ciTypeFlow should not let us get here" );
 567   // Interface classes can be loaded & linked and never get around to
 568   // being initialized.  Uncommon-trap for not-initialized static or
 569   // v-calls.  Let interface calls happen.
 570   ciInstanceKlass* holder_klass = dest_method->holder();
 571   if (!holder_klass->is_being_initialized() &&
 572       !holder_klass->is_initialized() &&
 573       !holder_klass->is_interface()) {
 574     uncommon_trap(Deoptimization::Reason_uninitialized,
 575                   Deoptimization::Action_reinterpret,
 576                   holder_klass);
 577     return true;
 578   }
 579 
 580   assert(dest_method->is_loaded(), "dest_method: typeflow responsibility");
 581   return false;
 582 }
 583 
 584 #ifdef ASSERT
 585 static bool check_call_consistency(JVMState* jvms, CallGenerator* cg) {
 586   ciMethod* symbolic_info = jvms->method()->get_method_at_bci(jvms->bci());
 587   ciMethod* resolved_method = cg->method();
 588   if (!ciMethod::is_consistent_info(symbolic_info, resolved_method)) {
 589     tty->print_cr("JVMS:");
 590     jvms->dump();
 591     tty->print_cr("Bytecode info:");
 592     jvms->method()->get_method_at_bci(jvms->bci())->print(); tty->cr();
 593     tty->print_cr("Resolved method:");
 594     cg->method()->print(); tty->cr();
 595     return false;
 596   }
 597   return true;
 598 }
 599 #endif // ASSERT
 600 
 601 //------------------------------do_call----------------------------------------
 602 // Handle your basic call.  Inline if we can & want to, else just setup call.
 603 void Parse::do_call() {
 604   // It's likely we are going to add debug info soon.
 605   // Also, if we inline a guy who eventually needs debug info for this JVMS,
 606   // our contribution to it is cleaned up right here.
 607   kill_dead_locals();
 608 
 609   // Set frequently used booleans
 610   const bool is_virtual = bc() == Bytecodes::_invokevirtual;
 611   const bool is_virtual_or_interface = is_virtual || bc() == Bytecodes::_invokeinterface;
 612   const bool has_receiver = Bytecodes::has_receiver(bc());
 613 
 614   // Find target being called
 615   bool             will_link;
 616   ciSignature*     declared_signature = nullptr;
 617   ciMethod*        orig_callee  = iter().get_method(will_link, &declared_signature);  // callee in the bytecode
 618   ciInstanceKlass* holder_klass = orig_callee->holder();
 619   ciKlass*         holder       = iter().get_declared_method_holder();
 620   ciInstanceKlass* klass = ciEnv::get_instance_klass_for_declared_method_holder(holder);
 621   assert(declared_signature != nullptr, "cannot be null");
 622   JFR_ONLY(Jfr::on_resolution(this, holder, orig_callee);)
 623 
 624   // Bump max node limit for JSR292 users
 625   if (bc() == Bytecodes::_invokedynamic || orig_callee->is_method_handle_intrinsic()) {
 626     C->set_max_node_limit(3*MaxNodeLimit);
 627   }
 628 
 629   // uncommon-trap when callee is unloaded, uninitialized or will not link
 630   // bailout when too many arguments for register representation
 631   if (!will_link || can_not_compile_call_site(orig_callee, klass)) {
 632     if (PrintOpto && (Verbose || WizardMode)) {
 633       method()->print_name(); tty->print_cr(" can not compile call at bci %d to:", bci());
 634       orig_callee->print_name(); tty->cr();
 635     }
 636     return;
 637   }
 638   assert(holder_klass->is_loaded(), "");
 639   //assert((bc_callee->is_static() || is_invokedynamic) == !has_receiver , "must match bc");  // XXX invokehandle (cur_bc_raw)
 640   // Note: this takes into account invokeinterface of methods declared in java/lang/Object,
 641   // which should be invokevirtuals but according to the VM spec may be invokeinterfaces
 642   assert(holder_klass->is_interface() || holder_klass->super() == nullptr || (bc() != Bytecodes::_invokeinterface), "must match bc");
 643   // Note:  In the absence of miranda methods, an abstract class K can perform
 644   // an invokevirtual directly on an interface method I.m if K implements I.
 645 
 646   // orig_callee is the resolved callee which's signature includes the
 647   // appendix argument.
 648   const int nargs = orig_callee->arg_size();
 649   const bool is_signature_polymorphic = MethodHandles::is_signature_polymorphic(orig_callee->intrinsic_id());
 650 
 651   // Push appendix argument (MethodType, CallSite, etc.), if one.
 652   if (iter().has_appendix()) {
 653     ciObject* appendix_arg = iter().get_appendix();
 654     const TypeOopPtr* appendix_arg_type = TypeOopPtr::make_from_constant(appendix_arg, /* require_const= */ true);
 655     Node* appendix_arg_node = _gvn.makecon(appendix_arg_type);
 656     push(appendix_arg_node);
 657   }
 658 
 659   // ---------------------
 660   // Does Class Hierarchy Analysis reveal only a single target of a v-call?
 661   // Then we may inline or make a static call, but become dependent on there being only 1 target.
 662   // Does the call-site type profile reveal only one receiver?
 663   // Then we may introduce a run-time check and inline on the path where it succeeds.
 664   // The other path may uncommon_trap, check for another receiver, or do a v-call.
 665 
 666   // Try to get the most accurate receiver type
 667   ciMethod* callee             = orig_callee;
 668   int       vtable_index       = Method::invalid_vtable_index;
 669   bool      call_does_dispatch = false;
 670 
 671   // Speculative type of the receiver if any
 672   ciKlass* speculative_receiver_type = nullptr;
 673   if (is_virtual_or_interface) {
 674     Node* receiver_node             = stack(sp() - nargs);
 675     const TypeOopPtr* receiver_type = _gvn.type(receiver_node)->isa_oopptr();
 676     // call_does_dispatch and vtable_index are out-parameters.  They might be changed.
 677     // For arrays, klass below is Object. When vtable calls are used,
 678     // resolving the call with Object would allow an illegal call to
 679     // finalize() on an array. We use holder instead: illegal calls to
 680     // finalize() won't be compiled as vtable calls (IC call
 681     // resolution will catch the illegal call) and the few legal calls
 682     // on array types won't be either.
 683     callee = C->optimize_virtual_call(method(), klass, holder, orig_callee,
 684                                       receiver_type, is_virtual,
 685                                       call_does_dispatch, vtable_index);  // out-parameters
 686     speculative_receiver_type = receiver_type != nullptr ? receiver_type->speculative_type() : nullptr;
 687   }
 688 
 689   // Additional receiver subtype checks for interface calls via invokespecial or invokeinterface.
 690   ciKlass* receiver_constraint = nullptr;
 691   if (iter().cur_bc_raw() == Bytecodes::_invokespecial && !orig_callee->is_object_constructor()) {
 692     ciInstanceKlass* calling_klass = method()->holder();
 693     ciInstanceKlass* sender_klass = calling_klass;
 694     if (sender_klass->is_interface()) {
 695       receiver_constraint = sender_klass;
 696     }
 697   } else if (iter().cur_bc_raw() == Bytecodes::_invokeinterface && orig_callee->is_private()) {
 698     assert(holder->is_interface(), "How did we get a non-interface method here!");
 699     receiver_constraint = holder;
 700   }
 701 
 702   if (receiver_constraint != nullptr) {
 703     Node* receiver_node = stack(sp() - nargs);
 704     Node* cls_node = makecon(TypeKlassPtr::make(receiver_constraint, Type::trust_interfaces));
 705     Node* bad_type_ctrl = nullptr;
 706     Node* casted_receiver = gen_checkcast(receiver_node, cls_node, &bad_type_ctrl);
 707     if (bad_type_ctrl != nullptr) {
 708       PreserveJVMState pjvms(this);
 709       set_control(bad_type_ctrl);
 710       uncommon_trap(Deoptimization::Reason_class_check,
 711                     Deoptimization::Action_none);
 712     }
 713     if (stopped()) {
 714       return; // MUST uncommon-trap?
 715     }
 716     set_stack(sp() - nargs, casted_receiver);
 717   }
 718 
 719   // Scalarize value objects passed into this invocation if we know that they are not larval
 720   for (int arg_idx = 0; arg_idx < nargs; arg_idx++) {
 721     if (arg_can_be_larval(callee, arg_idx)) {
 722       continue;
 723     }
 724 
 725     cast_to_non_larval(peek(nargs - 1 - arg_idx));
 726   }
 727 
 728   // Note:  It's OK to try to inline a virtual call.
 729   // The call generator will not attempt to inline a polymorphic call
 730   // unless it knows how to optimize the receiver dispatch.
 731   bool try_inline = (C->do_inlining() || InlineAccessors);
 732 
 733   // ---------------------
 734   dec_sp(nargs);              // Temporarily pop args for JVM state of call
 735   JVMState* jvms = sync_jvms();
 736 
 737   // ---------------------
 738   // Decide call tactic.
 739   // This call checks with CHA, the interpreter profile, intrinsics table, etc.
 740   // It decides whether inlining is desirable or not.
 741   CallGenerator* cg = C->call_generator(callee, vtable_index, call_does_dispatch, jvms, try_inline, prof_factor(), speculative_receiver_type);
 742   if (failing()) {
 743     return;
 744   }
 745   assert(cg != nullptr, "must find a CallGenerator for callee %s", callee->name()->as_utf8());
 746 
 747   // NOTE:  Don't use orig_callee and callee after this point!  Use cg->method() instead.
 748   orig_callee = callee = nullptr;
 749 
 750   // ---------------------
 751 
 752   // Feed profiling data for arguments to the type system so it can
 753   // propagate it as speculative types
 754   record_profiled_arguments_for_speculation(cg->method(), bc());
 755 
 756 #ifndef PRODUCT
 757   // bump global counters for calls
 758   count_compiled_calls(/*at_method_entry*/ false, cg->is_inline());
 759 
 760   // Record first part of parsing work for this call
 761   parse_histogram()->record_change();
 762 #endif // not PRODUCT
 763 
 764   assert(jvms == this->jvms(), "still operating on the right JVMS");
 765   assert(jvms_in_sync(),       "jvms must carry full info into CG");
 766 
 767   // save across call, for a subsequent cast_not_null.
 768   Node* receiver = has_receiver ? argument(0) : nullptr;
 769 
 770   // The extra CheckCastPPs for speculative types mess with PhaseStringOpts
 771   if (receiver != nullptr && !call_does_dispatch && !cg->is_string_late_inline()) {
 772     // Feed profiling data for a single receiver to the type system so
 773     // it can propagate it as a speculative type
 774     receiver = record_profiled_receiver_for_speculation(receiver);
 775   }
 776 
 777   JVMState* new_jvms = cg->generate(jvms);
 778   if (new_jvms == nullptr) {
 779     // When inlining attempt fails (e.g., too many arguments),
 780     // it may contaminate the current compile state, making it
 781     // impossible to pull back and try again.  Once we call
 782     // cg->generate(), we are committed.  If it fails, the whole
 783     // compilation task is compromised.
 784     if (failing())  return;
 785 
 786     // This can happen if a library intrinsic is available, but refuses
 787     // the call site, perhaps because it did not match a pattern the
 788     // intrinsic was expecting to optimize. Should always be possible to
 789     // get a normal java call that may inline in that case
 790     cg = C->call_generator(cg->method(), vtable_index, call_does_dispatch, jvms, try_inline, prof_factor(), speculative_receiver_type, /* allow_intrinsics= */ false);
 791     new_jvms = cg->generate(jvms);
 792     if (new_jvms == nullptr) {
 793       guarantee(failing(), "call failed to generate:  calls should work");
 794       return;
 795     }
 796   }
 797 
 798   if (cg->is_inline()) {
 799     // Accumulate has_loops estimate
 800     C->env()->notice_inlined_method(cg->method());
 801   }
 802 
 803   // Reset parser state from [new_]jvms, which now carries results of the call.
 804   // Return value (if any) is already pushed on the stack by the cg.
 805   add_exception_states_from(new_jvms);
 806   if (new_jvms->map()->control() == top()) {
 807     stop_and_kill_map();
 808   } else {
 809     assert(new_jvms->same_calls_as(jvms), "method/bci left unchanged");
 810     set_jvms(new_jvms);
 811   }
 812 
 813   assert(check_call_consistency(jvms, cg), "inconsistent info");
 814 
 815   if (!stopped()) {
 816     // This was some sort of virtual call, which did a null check for us.
 817     // Now we can assert receiver-not-null, on the normal return path.
 818     if (receiver != nullptr && cg->is_virtual()) {
 819       Node* cast = cast_not_null(receiver);
 820       // %%% assert(receiver == cast, "should already have cast the receiver");
 821     }
 822 
 823     ciType* rtype = cg->method()->return_type();
 824     ciType* ctype = declared_signature->return_type();
 825 
 826     if (Bytecodes::has_optional_appendix(iter().cur_bc_raw()) || is_signature_polymorphic) {
 827       // Be careful here with return types.
 828       if (ctype != rtype) {
 829         BasicType rt = rtype->basic_type();
 830         BasicType ct = ctype->basic_type();
 831         if (ct == T_VOID) {
 832           // It's OK for a method to return a value that is discarded.
 833           // The discarding does not require any special action from the caller.
 834           // The Java code knows this, at VerifyType.isNullConversion.
 835           pop_node(rt);  // whatever it was, pop it
 836         } else if (rt == T_INT || is_subword_type(rt)) {
 837           // Nothing.  These cases are handled in lambda form bytecode.
 838           assert(ct == T_INT || is_subword_type(ct), "must match: rt=%s, ct=%s", type2name(rt), type2name(ct));
 839         } else if (is_reference_type(rt)) {
 840           assert(is_reference_type(ct), "rt=%s, ct=%s", type2name(rt), type2name(ct));
 841           if (ctype->is_loaded()) {
 842             const TypeOopPtr* arg_type = TypeOopPtr::make_from_klass(rtype->as_klass());
 843             const Type*       sig_type = TypeOopPtr::make_from_klass(ctype->as_klass());
 844             if (arg_type != nullptr && !arg_type->higher_equal(sig_type)) {
 845               Node* retnode = pop();
 846               Node* cast_obj = _gvn.transform(new CheckCastPPNode(control(), retnode, sig_type));
 847               push(cast_obj);
 848             }
 849           }
 850         } else {
 851           assert(rt == ct, "unexpected mismatch: rt=%s, ct=%s", type2name(rt), type2name(ct));
 852           // push a zero; it's better than getting an oop/int mismatch
 853           pop_node(rt);
 854           Node* retnode = zerocon(ct);
 855           push_node(ct, retnode);
 856         }
 857         // Now that the value is well-behaved, continue with the call-site type.
 858         rtype = ctype;
 859       }
 860     } else {
 861       // Symbolic resolution enforces the types to be the same.
 862       // NOTE: We must relax the assert for unloaded types because two
 863       // different ciType instances of the same unloaded class type
 864       // can appear to be "loaded" by different loaders (depending on
 865       // the accessing class).
 866       assert(!rtype->is_loaded() || !ctype->is_loaded() || rtype == ctype,
 867              "mismatched return types: rtype=%s, ctype=%s", rtype->name(), ctype->name());
 868     }
 869 
 870     // If the return type of the method is not loaded, assert that the
 871     // value we got is a null.  Otherwise, we need to recompile.
 872     if (!rtype->is_loaded()) {
 873       if (PrintOpto && (Verbose || WizardMode)) {
 874         method()->print_name(); tty->print_cr(" asserting nullness of result at bci: %d", bci());
 875         cg->method()->print_name(); tty->cr();
 876       }
 877       if (C->log() != nullptr) {
 878         C->log()->elem("assert_null reason='return' klass='%d'",
 879                        C->log()->identify(rtype));
 880       }
 881       // If there is going to be a trap, put it at the next bytecode:
 882       set_bci(iter().next_bci());
 883       null_assert(peek());
 884       set_bci(iter().cur_bci()); // put it back
 885     }
 886     BasicType ct = ctype->basic_type();
 887     if (is_reference_type(ct)) {
 888       record_profiled_return_for_speculation();
 889     }
 890 
 891     if (!rtype->is_void() && cg->method()->intrinsic_id() != vmIntrinsicID::_makePrivateBuffer) {
 892       Node* retnode = peek();
 893       const Type* rettype = gvn().type(retnode);
 894       if (rettype->is_inlinetypeptr() && !retnode->is_InlineType()) {
 895         retnode = InlineTypeNode::make_from_oop(this, retnode, rettype->inline_klass());
 896         dec_sp(1);
 897         push(retnode);
 898       }
 899     }
 900 
 901     if (cg->method()->is_object_constructor() && receiver != nullptr && gvn().type(receiver)->is_inlinetypeptr()) {
 902       InlineTypeNode* non_larval = InlineTypeNode::make_from_oop(this, receiver, gvn().type(receiver)->inline_klass());
 903       // Relinquish the oop input, we will delay the allocation to the point it is needed, see the
 904       // comments in InlineTypeNode::Ideal for more details
 905       non_larval = non_larval->clone_if_required(&gvn(), nullptr);
 906       non_larval->set_oop(gvn(), null());
 907       non_larval->set_is_buffered(gvn(), false);
 908       non_larval = gvn().transform(non_larval)->as_InlineType();
 909       map()->replace_edge(receiver, non_larval);
 910     }
 911   }
 912 
 913   // Restart record of parsing work after possible inlining of call
 914 #ifndef PRODUCT
 915   parse_histogram()->set_initial_state(bc());
 916 #endif
 917 }
 918 
 919 //---------------------------catch_call_exceptions-----------------------------
 920 // Put a Catch and CatchProj nodes behind a just-created call.
 921 // Send their caught exceptions to the proper handler.
 922 // This may be used after a call to the rethrow VM stub,
 923 // when it is needed to process unloaded exception classes.
 924 void Parse::catch_call_exceptions(ciExceptionHandlerStream& handlers) {
 925   // Exceptions are delivered through this channel:
 926   Node* i_o = this->i_o();
 927 
 928   // Add a CatchNode.
 929   Arena tmp_mem{mtCompiler};
 930   GrowableArray<int> bcis(&tmp_mem, 8, 0, -1);
 931   GrowableArray<const Type*> extypes(&tmp_mem, 8, 0, nullptr);
 932   GrowableArray<int> saw_unloaded(&tmp_mem, 8, 0, -1);
 933 
 934   bool default_handler = false;
 935   for (; !handlers.is_done(); handlers.next()) {
 936     ciExceptionHandler* h       = handlers.handler();
 937     int                 h_bci   = h->handler_bci();
 938     ciInstanceKlass*    h_klass = h->is_catch_all() ? env()->Throwable_klass() : h->catch_klass();
 939     // Do not introduce unloaded exception types into the graph:
 940     if (!h_klass->is_loaded()) {
 941       if (saw_unloaded.contains(h_bci)) {
 942         /* We've already seen an unloaded exception with h_bci,
 943            so don't duplicate. Duplication will cause the CatchNode to be
 944            unnecessarily large. See 4713716. */
 945         continue;
 946       } else {
 947         saw_unloaded.append(h_bci);
 948       }
 949     }
 950     const Type* h_extype = TypeOopPtr::make_from_klass(h_klass);
 951     // (We use make_from_klass because it respects UseUniqueSubclasses.)
 952     h_extype = h_extype->join(TypeInstPtr::NOTNULL);
 953     assert(!h_extype->empty(), "sanity");
 954     // Note: It's OK if the BCIs repeat themselves.
 955     bcis.append(h_bci);
 956     extypes.append(h_extype);
 957     if (h_bci == -1) {
 958       default_handler = true;
 959     }
 960   }
 961 
 962   if (!default_handler) {
 963     bcis.append(-1);
 964     const Type* extype = TypeOopPtr::make_from_klass(env()->Throwable_klass())->is_instptr();
 965     extype = extype->join(TypeInstPtr::NOTNULL);
 966     extypes.append(extype);
 967   }
 968 
 969   int len = bcis.length();
 970   CatchNode *cn = new CatchNode(control(), i_o, len+1);
 971   Node *catch_ = _gvn.transform(cn);
 972 
 973   // now branch with the exception state to each of the (potential)
 974   // handlers
 975   for(int i=0; i < len; i++) {
 976     // Setup JVM state to enter the handler.
 977     PreserveJVMState pjvms(this);
 978     // Locals are just copied from before the call.
 979     // Get control from the CatchNode.
 980     int handler_bci = bcis.at(i);
 981     Node* ctrl = _gvn.transform( new CatchProjNode(catch_, i+1,handler_bci));
 982     // This handler cannot happen?
 983     if (ctrl == top())  continue;
 984     set_control(ctrl);
 985 
 986     // Create exception oop
 987     const TypeInstPtr* extype = extypes.at(i)->is_instptr();
 988     Node* ex_oop = _gvn.transform(new CreateExNode(extypes.at(i), ctrl, i_o));
 989 
 990     // Handle unloaded exception classes.
 991     if (saw_unloaded.contains(handler_bci)) {
 992       // An unloaded exception type is coming here.  Do an uncommon trap.
 993 #ifndef PRODUCT
 994       // We do not expect the same handler bci to take both cold unloaded
 995       // and hot loaded exceptions.  But, watch for it.
 996       if (PrintOpto && (Verbose || WizardMode) && extype->is_loaded()) {
 997         tty->print("Warning: Handler @%d takes mixed loaded/unloaded exceptions in ", bci());
 998         method()->print_name(); tty->cr();
 999       } else if (PrintOpto && (Verbose || WizardMode)) {
1000         tty->print("Bailing out on unloaded exception type ");
1001         extype->instance_klass()->print_name();
1002         tty->print(" at bci:%d in ", bci());
1003         method()->print_name(); tty->cr();
1004       }
1005 #endif
1006       // Emit an uncommon trap instead of processing the block.
1007       set_bci(handler_bci);
1008       push_ex_oop(ex_oop);
1009       uncommon_trap(Deoptimization::Reason_unloaded,
1010                     Deoptimization::Action_reinterpret,
1011                     extype->instance_klass(), "!loaded exception");
1012       set_bci(iter().cur_bci()); // put it back
1013       continue;
1014     }
1015 
1016     // go to the exception handler
1017     if (handler_bci < 0) {     // merge with corresponding rethrow node
1018       throw_to_exit(make_exception_state(ex_oop));
1019     } else {                      // Else jump to corresponding handle
1020       push_ex_oop(ex_oop);        // Clear stack and push just the oop.
1021       merge_exception(handler_bci);
1022     }
1023   }
1024 
1025   // The first CatchProj is for the normal return.
1026   // (Note:  If this is a call to rethrow_Java, this node goes dead.)
1027   set_control(_gvn.transform( new CatchProjNode(catch_, CatchProjNode::fall_through_index, CatchProjNode::no_handler_bci)));
1028 }
1029 
1030 
1031 //----------------------------catch_inline_exceptions--------------------------
1032 // Handle all exceptions thrown by an inlined method or individual bytecode.
1033 // Common case 1: we have no handler, so all exceptions merge right into
1034 // the rethrow case.
1035 // Case 2: we have some handlers, with loaded exception klasses that have
1036 // no subklasses.  We do a Deutsch-Schiffman style type-check on the incoming
1037 // exception oop and branch to the handler directly.
1038 // Case 3: We have some handlers with subklasses or are not loaded at
1039 // compile-time.  We have to call the runtime to resolve the exception.
1040 // So we insert a RethrowCall and all the logic that goes with it.
1041 void Parse::catch_inline_exceptions(SafePointNode* ex_map) {
1042   // Caller is responsible for saving away the map for normal control flow!
1043   assert(stopped(), "call set_map(nullptr) first");
1044   assert(method()->has_exception_handlers(), "don't come here w/o work to do");
1045 
1046   Node* ex_node = saved_ex_oop(ex_map);
1047   if (ex_node == top()) {
1048     // No action needed.
1049     return;
1050   }
1051   const TypeInstPtr* ex_type = _gvn.type(ex_node)->isa_instptr();
1052   NOT_PRODUCT(if (ex_type==nullptr) tty->print_cr("*** Exception not InstPtr"));
1053   if (ex_type == nullptr)
1054     ex_type = TypeOopPtr::make_from_klass(env()->Throwable_klass())->is_instptr();
1055 
1056   // determine potential exception handlers
1057   ciExceptionHandlerStream handlers(method(), bci(),
1058                                     ex_type->instance_klass(),
1059                                     ex_type->klass_is_exact());
1060 
1061   // Start executing from the given throw state.  (Keep its stack, for now.)
1062   // Get the exception oop as known at compile time.
1063   ex_node = use_exception_state(ex_map);
1064 
1065   // Get the exception oop klass from its header
1066   Node* ex_klass_node = nullptr;
1067   if (has_exception_handler() && !ex_type->klass_is_exact()) {
1068     Node* p = basic_plus_adr( ex_node, ex_node, oopDesc::klass_offset_in_bytes());
1069     ex_klass_node = _gvn.transform(LoadKlassNode::make(_gvn, immutable_memory(), p, TypeInstPtr::KLASS, TypeInstKlassPtr::OBJECT));
1070 
1071     // Compute the exception klass a little more cleverly.
1072     // Obvious solution is to simple do a LoadKlass from the 'ex_node'.
1073     // However, if the ex_node is a PhiNode, I'm going to do a LoadKlass for
1074     // each arm of the Phi.  If I know something clever about the exceptions
1075     // I'm loading the class from, I can replace the LoadKlass with the
1076     // klass constant for the exception oop.
1077     if (ex_node->is_Phi()) {
1078       ex_klass_node = new PhiNode(ex_node->in(0), TypeInstKlassPtr::OBJECT);
1079       for (uint i = 1; i < ex_node->req(); i++) {
1080         Node* ex_in = ex_node->in(i);
1081         if (ex_in == top() || ex_in == nullptr) {
1082           // This path was not taken.
1083           ex_klass_node->init_req(i, top());
1084           continue;
1085         }
1086         Node* p = basic_plus_adr(ex_in, ex_in, oopDesc::klass_offset_in_bytes());
1087         Node* k = _gvn.transform(LoadKlassNode::make(_gvn, immutable_memory(), p, TypeInstPtr::KLASS, TypeInstKlassPtr::OBJECT));
1088         ex_klass_node->init_req( i, k );
1089       }
1090       ex_klass_node = _gvn.transform(ex_klass_node);
1091     }
1092   }
1093 
1094   // Scan the exception table for applicable handlers.
1095   // If none, we can call rethrow() and be done!
1096   // If precise (loaded with no subklasses), insert a D.S. style
1097   // pointer compare to the correct handler and loop back.
1098   // If imprecise, switch to the Rethrow VM-call style handling.
1099 
1100   int remaining = handlers.count_remaining();
1101 
1102   // iterate through all entries sequentially
1103   for (;!handlers.is_done(); handlers.next()) {
1104     ciExceptionHandler* handler = handlers.handler();
1105 
1106     if (handler->is_rethrow()) {
1107       // If we fell off the end of the table without finding an imprecise
1108       // exception klass (and without finding a generic handler) then we
1109       // know this exception is not handled in this method.  We just rethrow
1110       // the exception into the caller.
1111       throw_to_exit(make_exception_state(ex_node));
1112       return;
1113     }
1114 
1115     // exception handler bci range covers throw_bci => investigate further
1116     int handler_bci = handler->handler_bci();
1117 
1118     if (remaining == 1) {
1119       push_ex_oop(ex_node);        // Push exception oop for handler
1120       if (PrintOpto && WizardMode) {
1121         tty->print_cr("  Catching every inline exception bci:%d -> handler_bci:%d", bci(), handler_bci);
1122       }
1123       // If this is a backwards branch in the bytecodes, add safepoint
1124       maybe_add_safepoint(handler_bci);
1125       merge_exception(handler_bci); // jump to handler
1126       return;                   // No more handling to be done here!
1127     }
1128 
1129     // Get the handler's klass
1130     ciInstanceKlass* klass = handler->catch_klass();
1131 
1132     if (!klass->is_loaded()) {  // klass is not loaded?
1133       // fall through into catch_call_exceptions which will emit a
1134       // handler with an uncommon trap.
1135       break;
1136     }
1137 
1138     if (klass->is_interface())  // should not happen, but...
1139       break;                    // bail out
1140 
1141     // Check the type of the exception against the catch type
1142     const TypeKlassPtr *tk = TypeKlassPtr::make(klass);
1143     Node* con = _gvn.makecon(tk);
1144     Node* not_subtype_ctrl = gen_subtype_check(ex_klass_node, con);
1145     if (!stopped()) {
1146       PreserveJVMState pjvms(this);
1147       const TypeInstPtr* tinst = TypeOopPtr::make_from_klass_unique(klass)->cast_to_ptr_type(TypePtr::NotNull)->is_instptr();
1148       assert(klass->has_subklass() || tinst->klass_is_exact(), "lost exactness");
1149       Node* ex_oop = _gvn.transform(new CheckCastPPNode(control(), ex_node, tinst));
1150       push_ex_oop(ex_oop);      // Push exception oop for handler
1151       if (PrintOpto && WizardMode) {
1152         tty->print("  Catching inline exception bci:%d -> handler_bci:%d -- ", bci(), handler_bci);
1153         klass->print_name();
1154         tty->cr();
1155       }
1156       // If this is a backwards branch in the bytecodes, add safepoint
1157       maybe_add_safepoint(handler_bci);
1158       merge_exception(handler_bci);
1159     }
1160     set_control(not_subtype_ctrl);
1161 
1162     // Come here if exception does not match handler.
1163     // Carry on with more handler checks.
1164     --remaining;
1165   }
1166 
1167   assert(!stopped(), "you should return if you finish the chain");
1168 
1169   // Oops, need to call into the VM to resolve the klasses at runtime.
1170   kill_dead_locals();
1171 
1172   { PreserveReexecuteState preexecs(this);
1173     // When throwing an exception, set the reexecute flag for deoptimization.
1174     // This is mostly needed to pass -XX:+VerifyStack sanity checks.
1175     jvms()->set_should_reexecute(true);
1176 
1177     make_runtime_call(RC_NO_LEAF | RC_MUST_THROW,
1178                       OptoRuntime::rethrow_Type(),
1179                       OptoRuntime::rethrow_stub(),
1180                       nullptr, nullptr,
1181                       ex_node);
1182   }
1183 
1184   // Rethrow is a pure call, no side effects, only a result.
1185   // The result cannot be allocated, so we use I_O
1186 
1187   // Catch exceptions from the rethrow
1188   catch_call_exceptions(handlers);
1189 }
1190 
1191 
1192 // (Note:  Moved add_debug_info into GraphKit::add_safepoint_edges.)
1193 
1194 
1195 #ifndef PRODUCT
1196 void Parse::count_compiled_calls(bool at_method_entry, bool is_inline) {
1197   if( CountCompiledCalls ) {
1198     if( at_method_entry ) {
1199       // bump invocation counter if top method (for statistics)
1200       if (CountCompiledCalls && depth() == 1) {
1201         const TypePtr* addr_type = TypeMetadataPtr::make(method());
1202         Node* adr1 = makecon(addr_type);
1203         Node* adr2 = basic_plus_adr(adr1, adr1, in_bytes(Method::compiled_invocation_counter_offset()));
1204         increment_counter(adr2);
1205       }
1206     } else if (is_inline) {
1207       switch (bc()) {
1208       case Bytecodes::_invokevirtual:   increment_counter(SharedRuntime::nof_inlined_calls_addr()); break;
1209       case Bytecodes::_invokeinterface: increment_counter(SharedRuntime::nof_inlined_interface_calls_addr()); break;
1210       case Bytecodes::_invokestatic:
1211       case Bytecodes::_invokedynamic:
1212       case Bytecodes::_invokespecial:   increment_counter(SharedRuntime::nof_inlined_static_calls_addr()); break;
1213       default: fatal("unexpected call bytecode");
1214       }
1215     } else {
1216       switch (bc()) {
1217       case Bytecodes::_invokevirtual:   increment_counter(SharedRuntime::nof_normal_calls_addr()); break;
1218       case Bytecodes::_invokeinterface: increment_counter(SharedRuntime::nof_interface_calls_addr()); break;
1219       case Bytecodes::_invokestatic:
1220       case Bytecodes::_invokedynamic:
1221       case Bytecodes::_invokespecial:   increment_counter(SharedRuntime::nof_static_calls_addr()); break;
1222       default: fatal("unexpected call bytecode");
1223       }
1224     }
1225   }
1226 }
1227 #endif //PRODUCT
1228 
1229 
1230 ciMethod* Compile::optimize_virtual_call(ciMethod* caller, ciInstanceKlass* klass,
1231                                          ciKlass* holder, ciMethod* callee,
1232                                          const TypeOopPtr* receiver_type, bool is_virtual,
1233                                          bool& call_does_dispatch, int& vtable_index,
1234                                          bool check_access) {
1235   // Set default values for out-parameters.
1236   call_does_dispatch = true;
1237   vtable_index       = Method::invalid_vtable_index;
1238 
1239   // Choose call strategy.
1240   ciMethod* optimized_virtual_method = optimize_inlining(caller, klass, holder, callee,
1241                                                          receiver_type, check_access);
1242 
1243   // Have the call been sufficiently improved such that it is no longer a virtual?
1244   if (optimized_virtual_method != nullptr) {
1245     callee             = optimized_virtual_method;
1246     call_does_dispatch = false;
1247   } else if (!UseInlineCaches && is_virtual && callee->is_loaded()) {
1248     // We can make a vtable call at this site
1249     vtable_index = callee->resolve_vtable_index(caller->holder(), holder);
1250   }
1251   return callee;
1252 }
1253 
1254 // Identify possible target method and inlining style
1255 ciMethod* Compile::optimize_inlining(ciMethod* caller, ciInstanceKlass* klass, ciKlass* holder,
1256                                      ciMethod* callee, const TypeOopPtr* receiver_type,
1257                                      bool check_access) {
1258   // only use for virtual or interface calls
1259 
1260   // If it is obviously final, do not bother to call find_monomorphic_target,
1261   // because the class hierarchy checks are not needed, and may fail due to
1262   // incompletely loaded classes.  Since we do our own class loading checks
1263   // in this module, we may confidently bind to any method.
1264   if (callee->can_be_statically_bound()) {
1265     return callee;
1266   }
1267 
1268   if (receiver_type == nullptr) {
1269     return nullptr; // no receiver type info
1270   }
1271 
1272   // Attempt to improve the receiver
1273   bool actual_receiver_is_exact = false;
1274   ciInstanceKlass* actual_receiver = klass;
1275   // Array methods are all inherited from Object, and are monomorphic.
1276   // finalize() call on array is not allowed.
1277   if (receiver_type->isa_aryptr() &&
1278       callee->holder() == env()->Object_klass() &&
1279       callee->name() != ciSymbols::finalize_method_name()) {
1280     return callee;
1281   }
1282 
1283   // All other interesting cases are instance klasses.
1284   if (!receiver_type->isa_instptr()) {
1285     return nullptr;
1286   }
1287 
1288   ciInstanceKlass* receiver_klass = receiver_type->is_instptr()->instance_klass();
1289   if (receiver_klass->is_loaded() && receiver_klass->is_initialized() && !receiver_klass->is_interface() &&
1290       (receiver_klass == actual_receiver || receiver_klass->is_subtype_of(actual_receiver))) {
1291     // ikl is a same or better type than the original actual_receiver,
1292     // e.g. static receiver from bytecodes.
1293     actual_receiver = receiver_klass;
1294     // Is the actual_receiver exact?
1295     actual_receiver_is_exact = receiver_type->klass_is_exact();
1296   }
1297 
1298   ciInstanceKlass*   calling_klass = caller->holder();
1299   ciMethod* cha_monomorphic_target = callee->find_monomorphic_target(calling_klass, klass, actual_receiver, check_access);
1300 
1301   if (cha_monomorphic_target != nullptr) {
1302     // Hardwiring a virtual.
1303     assert(!callee->can_be_statically_bound(), "should have been handled earlier");
1304     assert(!cha_monomorphic_target->is_abstract(), "");
1305     if (!cha_monomorphic_target->can_be_statically_bound(actual_receiver)) {
1306       // If we inlined because CHA revealed only a single target method,
1307       // then we are dependent on that target method not getting overridden
1308       // by dynamic class loading.  Be sure to test the "static" receiver
1309       // dest_method here, as opposed to the actual receiver, which may
1310       // falsely lead us to believe that the receiver is final or private.
1311       dependencies()->assert_unique_concrete_method(actual_receiver, cha_monomorphic_target, holder, callee);
1312     }
1313     return cha_monomorphic_target;
1314   }
1315 
1316   // If the type is exact, we can still bind the method w/o a vcall.
1317   // (This case comes after CHA so we can see how much extra work it does.)
1318   if (actual_receiver_is_exact) {
1319     // In case of evolution, there is a dependence on every inlined method, since each
1320     // such method can be changed when its class is redefined.
1321     ciMethod* exact_method = callee->resolve_invoke(calling_klass, actual_receiver);
1322     if (exact_method != nullptr) {
1323       return exact_method;
1324     }
1325   }
1326 
1327   return nullptr;
1328 }