/*

 * Copyright (c) 1998, 2019, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 *

 */

#include "precompiled.hpp"

#include "ci/ciCallSite.hpp"

#include "ci/ciMethodHandle.hpp"

#include "classfile/vmSymbols.hpp"

#include "compiler/compileBroker.hpp"

#include "compiler/compileLog.hpp"

#include "interpreter/linkResolver.hpp"

#include "opto/addnode.hpp"

#include "opto/callGenerator.hpp"

#include "opto/castnode.hpp"

#include "opto/cfgnode.hpp"

#include "opto/mulnode.hpp"

#include "opto/parse.hpp"

#include "opto/rootnode.hpp"

#include "opto/runtime.hpp"

#include "opto/subnode.hpp"

#include "prims/nativeLookup.hpp"

#include "runtime/sharedRuntime.hpp"

void trace_type_profile(Compile* C, ciMethod *method, int depth, int bci, ciMethod *prof_method, ciKlass *prof_klass, int site_count, int receiver_count) {

  if (TraceTypeProfile || C->print_inlining()) {

    outputStream* out = tty;

    if (!C->print_inlining()) {

      if (!PrintOpto && !PrintCompilation) {

        method->print_short_name();

        tty->cr();

      }

      CompileTask::print_inlining_tty(prof_method, depth, bci);

    } else {

      out = C->print_inlining_stream();

    }

    CompileTask::print_inline_indent(depth, out);

    out->print(" \\-> TypeProfile (%d/%d counts) = ", receiver_count, site_count);

    stringStream ss;

    prof_klass->name()->print_symbol_on(&ss);

    out->print("%s", ss.as_string());

    out->cr();

  }

}

CallGenerator* Compile::call_generator(ciMethod* callee, int vtable_index, bool call_does_dispatch,

                                       JVMState* jvms, bool allow_inline,

                                       float prof_factor, ciKlass* speculative_receiver_type,

                                       bool allow_intrinsics, bool delayed_forbidden) {

  ciMethod*       caller   = jvms->method();

  int             bci      = jvms->bci();

  Bytecodes::Code bytecode = caller->java_code_at_bci(bci);

  guarantee(callee != NULL, "failed method resolution");

  // Dtrace currently doesn't work unless all calls are vanilla

  if (env()->dtrace_method_probes()) {

    allow_inline = false;

  }

  // Note: When we get profiling during stage-1 compiles, we want to pull

  // from more specific profile data which pertains to this inlining.

  // Right now, ignore the information in jvms->caller(), and do method[bci].

  ciCallProfile profile = caller->call_profile_at_bci(bci);

  // See how many times this site has been invoked.

  int site_count = profile.count();

  int receiver_count = -1;

  if (call_does_dispatch && UseTypeProfile && profile.has_receiver(0)) {

    // Receivers in the profile structure are ordered by call counts

    // so that the most called (major) receiver is profile.receiver(0).

    receiver_count = profile.receiver_count(0);

  }

  CompileLog* log = this->log();

  if (log != NULL) {

    int rid = (receiver_count >= 0)? log->identify(profile.receiver(0)): -1;

    int r2id = (rid != -1 && profile.has_receiver(1))? log->identify(profile.receiver(1)):-1;

    log->begin_elem("call method='%d' count='%d' prof_factor='%f'",

                    log->identify(callee), site_count, prof_factor);

    if (call_does_dispatch)  log->print(" virtual='1'");

    if (allow_inline)     log->print(" inline='1'");

    if (receiver_count >= 0) {

      log->print(" receiver='%d' receiver_count='%d'", rid, receiver_count);

      if (profile.has_receiver(1)) {

        log->print(" receiver2='%d' receiver2_count='%d'", r2id, profile.receiver_count(1));

      }

    }

    if (callee->is_method_handle_intrinsic()) {

      log->print(" method_handle_intrinsic='1'");

    }

    log->end_elem();

  }

  // Special case the handling of certain common, profitable library

  // methods.  If these methods are replaced with specialized code,

  // then we return it as the inlined version of the call.

  // We do this before the strict f.p. check below because the

  // intrinsics handle strict f.p. correctly.

  CallGenerator* cg_intrinsic = NULL;

  if (allow_inline && allow_intrinsics) {

    CallGenerator* cg = find_intrinsic(callee, call_does_dispatch);

    if (cg != NULL) {

      if (cg->is_predicated()) {

        // Code without intrinsic but, hopefully, inlined.

        CallGenerator* inline_cg = this->call_generator(callee,

              vtable_index, call_does_dispatch, jvms, allow_inline, prof_factor, speculative_receiver_type, false);

        if (inline_cg != NULL) {

          cg = CallGenerator::for_predicated_intrinsic(cg, inline_cg);

        }

      }

      // If intrinsic does the virtual dispatch, we try to use the type profile

      // first, and hopefully inline it as the regular virtual call below.

      // We will retry the intrinsic if nothing had claimed it afterwards.

      if (cg->does_virtual_dispatch()) {

        cg_intrinsic = cg;

        cg = NULL;

      } else {

        return cg;

      }

    }

  }

  // Do method handle calls.

  // NOTE: This must happen before normal inlining logic below since

  // MethodHandle.invoke* are native methods which obviously don't

  // have bytecodes and so normal inlining fails.

  if (callee->is_method_handle_intrinsic()) {

    CallGenerator* cg = CallGenerator::for_method_handle_call(jvms, caller, callee, delayed_forbidden);

    assert(cg == NULL || !delayed_forbidden || !cg->is_late_inline() || cg->is_mh_late_inline(), "unexpected CallGenerator");

    return cg;

  }

  // Do not inline strict fp into non-strict code, or the reverse

  if (caller->is_strict() ^ callee->is_strict()) {

    allow_inline = false;

  }

  // Attempt to inline...

  if (allow_inline) {

    // The profile data is only partly attributable to this caller,

    // scale back the call site information.

    float past_uses = jvms->method()->scale_count(site_count, prof_factor);

    // This is the number of times we expect the call code to be used.

    float expected_uses = past_uses;

    // Try inlining a bytecoded method:

    if (!call_does_dispatch) {

      InlineTree* ilt = InlineTree::find_subtree_from_root(this->ilt(), jvms->caller(), jvms->method());

      WarmCallInfo scratch_ci;

      bool should_delay = false;

      WarmCallInfo* ci = ilt->ok_to_inline(callee, jvms, profile, &scratch_ci, should_delay);

      assert(ci != &scratch_ci, "do not let this pointer escape");

      bool allow_inline   = (ci != NULL && !ci->is_cold());

      bool require_inline = (allow_inline && ci->is_hot());

      if (allow_inline) {

        CallGenerator* cg = CallGenerator::for_inline(callee, expected_uses);

        if (require_inline && cg != NULL) {

          // Delay the inlining of this method to give us the

          // opportunity to perform some high level optimizations

          // first.

          if (should_delay_string_inlining(callee, jvms)) {

            assert(!delayed_forbidden, "strange");

            return CallGenerator::for_string_late_inline(callee, cg);

          } else if (should_delay_boxing_inlining(callee, jvms)) {

            assert(!delayed_forbidden, "strange");

            return CallGenerator::for_boxing_late_inline(callee, cg);

          } else if ((should_delay || AlwaysIncrementalInline) && !delayed_forbidden) {

            return CallGenerator::for_late_inline(callee, cg);

          }

        }

        if (cg == NULL || should_delay) {

          // Fall through.

        } else if (require_inline || !InlineWarmCalls) {

          return cg;

        } else {

          CallGenerator* cold_cg = call_generator(callee, vtable_index, call_does_dispatch, jvms, false, prof_factor);

          return CallGenerator::for_warm_call(ci, cold_cg, cg);

        }

      }

    }

    // Try using the type profile.

    if (call_does_dispatch && site_count > 0 && UseTypeProfile) {

      // The major receiver's count >= TypeProfileMajorReceiverPercent of site_count.

      bool have_major_receiver = profile.has_receiver(0) && (100.*profile.receiver_prob(0) >= (float)TypeProfileMajorReceiverPercent);

      ciMethod* receiver_method = NULL;

      int morphism = profile.morphism();

      if (speculative_receiver_type != NULL) {

        if (!too_many_traps_or_recompiles(caller, bci, Deoptimization::Reason_speculate_class_check)) {

          // We have a speculative type, we should be able to resolve

          // the call. We do that before looking at the profiling at

          // this invoke because it may lead to bimorphic inlining which

          // a speculative type should help us avoid.

          receiver_method = callee->resolve_invoke(jvms->method()->holder(),

                                                   speculative_receiver_type);

          if (receiver_method == NULL) {

            speculative_receiver_type = NULL;

          } else {

            morphism = 1;

          }

        } else {

          // speculation failed before. Use profiling at the call

          // (could allow bimorphic inlining for instance).

          speculative_receiver_type = NULL;

        }

      }

      if (receiver_method == NULL &&

          (have_major_receiver || morphism == 1 ||

           (morphism == 2 && UseBimorphicInlining))) {

        // receiver_method = profile.method();

        // Profiles do not suggest methods now.  Look it up in the major receiver.

        receiver_method = callee->resolve_invoke(jvms->method()->holder(),

                                                      profile.receiver(0));

      }

      if (receiver_method != NULL) {

        // The single majority receiver sufficiently outweighs the minority.

        CallGenerator* hit_cg = this->call_generator(receiver_method,

              vtable_index, !call_does_dispatch, jvms, allow_inline, prof_factor);

        if (hit_cg != NULL) {

          // Look up second receiver.

          CallGenerator* next_hit_cg = NULL;

          ciMethod* next_receiver_method = NULL;

          if (morphism == 2 && UseBimorphicInlining) {

            next_receiver_method = callee->resolve_invoke(jvms->method()->holder(),

                                                               profile.receiver(1));

            if (next_receiver_method != NULL) {

              next_hit_cg = this->call_generator(next_receiver_method,

                                  vtable_index, !call_does_dispatch, jvms,

                                  allow_inline, prof_factor);

              if (next_hit_cg != NULL && !next_hit_cg->is_inline() &&

                  have_major_receiver && UseOnlyInlinedBimorphic) {

                  // Skip if we can't inline second receiver's method

                  next_hit_cg = NULL;

              }

            }

          }

          CallGenerator* miss_cg;

          Deoptimization::DeoptReason reason = (morphism == 2

                                               ? Deoptimization::Reason_bimorphic

                                               : Deoptimization::reason_class_check(speculative_receiver_type != NULL));

          if ((morphism == 1 || (morphism == 2 && next_hit_cg != NULL)) &&

              !too_many_traps_or_recompiles(caller, bci, reason)

             ) {

            // Generate uncommon trap for class check failure path

            // in case of monomorphic or bimorphic virtual call site.

            miss_cg = CallGenerator::for_uncommon_trap(callee, reason,

                        Deoptimization::Action_maybe_recompile);

          } else {

            // Generate virtual call for class check failure path

            // in case of polymorphic virtual call site.

            miss_cg = CallGenerator::for_virtual_call(callee, vtable_index);

          }

          if (miss_cg != NULL) {

            if (next_hit_cg != NULL) {

              assert(speculative_receiver_type == NULL, "shouldn't end up here if we used speculation");

              trace_type_profile(C, jvms->method(), jvms->depth() - 1, jvms->bci(), next_receiver_method, profile.receiver(1), site_count, profile.receiver_count(1));

              // We don't need to record dependency on a receiver here and below.

              // Whenever we inline, the dependency is added by Parse::Parse().

              miss_cg = CallGenerator::for_predicted_call(profile.receiver(1), miss_cg, next_hit_cg, PROB_MAX);

            }

            if (miss_cg != NULL) {

              ciKlass* k = speculative_receiver_type != NULL ? speculative_receiver_type : profile.receiver(0);

              trace_type_profile(C, jvms->method(), jvms->depth() - 1, jvms->bci(), receiver_method, k, site_count, receiver_count);

              float hit_prob = speculative_receiver_type != NULL ? 1.0 : profile.receiver_prob(0);

              CallGenerator* cg = CallGenerator::for_predicted_call(k, miss_cg, hit_cg, hit_prob);

              if (cg != NULL)  return cg;

            }

          }

        }

      }

    }

    // If there is only one implementor of this interface then we

    // may be able to bind this invoke directly to the implementing

    // klass but we need both a dependence on the single interface

    // and on the method we bind to. Additionally since all we know

    // about the receiver type is that it's supposed to implement the

    // interface we have to insert a check that it's the class we

    // expect.  Interface types are not checked by the verifier so

    // they are roughly equivalent to Object.

    // The number of implementors for declared_interface is less or

    // equal to the number of implementors for target->holder() so

    // if number of implementors of target->holder() == 1 then

    // number of implementors for decl_interface is 0 or 1. If

    // it's 0 then no class implements decl_interface and there's

    // no point in inlining.

    if (call_does_dispatch && bytecode == Bytecodes::_invokeinterface) {

      ciInstanceKlass* declared_interface =

          caller->get_declared_method_holder_at_bci(bci)->as_instance_klass();

      ciInstanceKlass* singleton = declared_interface->unique_implementor();

      if (singleton != NULL &&

          (!callee->is_default_method() || callee->is_overpass()) /* CHA doesn't support default methods yet */) {

        assert(singleton != declared_interface, "not a unique implementor");

        ciMethod* cha_monomorphic_target =

            callee->find_monomorphic_target(caller->holder(), declared_interface, singleton);

        if (cha_monomorphic_target != NULL &&

            cha_monomorphic_target->holder() != env()->Object_klass()) { // subtype check against Object is useless

          ciKlass* holder = cha_monomorphic_target->holder();

          // Try to inline the method found by CHA. Inlined method is guarded by the type check.

          CallGenerator* hit_cg = call_generator(cha_monomorphic_target,

              vtable_index, !call_does_dispatch, jvms, allow_inline, prof_factor);

          // Deoptimize on type check fail. The interpreter will throw ICCE for us.

          CallGenerator* miss_cg = CallGenerator::for_uncommon_trap(callee,

              Deoptimization::Reason_class_check, Deoptimization::Action_none);

          CallGenerator* cg = CallGenerator::for_guarded_call(holder, miss_cg, hit_cg);

          if (hit_cg != NULL && cg != NULL) {

            dependencies()->assert_unique_concrete_method(declared_interface, cha_monomorphic_target);

            return cg;

          }

        }

      }

    }

  }

  // Nothing claimed the intrinsic, we go with straight-forward inlining

  // for already discovered intrinsic.

  if (allow_inline && allow_intrinsics && cg_intrinsic != NULL) {

    assert(cg_intrinsic->does_virtual_dispatch(), "sanity");

    return cg_intrinsic;

  }

  // There was no special inlining tactic, or it bailed out.

  // Use a more generic tactic, like a simple call.

  if (call_does_dispatch) {

    const char* msg = "virtual call";

    if (PrintInlining) print_inlining(callee, jvms->depth() - 1, jvms->bci(), msg);

    C->log_inline_failure(msg);

    return CallGenerator::for_virtual_call(callee, vtable_index);

  } else {

    // Class Hierarchy Analysis or Type Profile reveals a unique target,

    // or it is a static or special call.

    return CallGenerator::for_direct_call(callee, should_delay_inlining(callee, jvms));

  }

}

// Return true for methods that shouldn't be inlined early so that

// they are easier to analyze and optimize as intrinsics.

bool Compile::should_delay_string_inlining(ciMethod* call_method, JVMState* jvms) {

  if (has_stringbuilder()) {

    if ((call_method->holder() == C->env()->StringBuilder_klass() ||

         call_method->holder() == C->env()->StringBuffer_klass()) &&

        (jvms->method()->holder() == C->env()->StringBuilder_klass() ||

         jvms->method()->holder() == C->env()->StringBuffer_klass())) {

      // Delay SB calls only when called from non-SB code

      return false;

    }

    switch (call_method->intrinsic_id()) {

      case vmIntrinsics::_StringBuilder_void:

      case vmIntrinsics::_StringBuilder_int:

      case vmIntrinsics::_StringBuilder_String:

      case vmIntrinsics::_StringBuilder_append_char:

      case vmIntrinsics::_StringBuilder_append_int:

      case vmIntrinsics::_StringBuilder_append_String:

      case vmIntrinsics::_StringBuilder_toString:

      case vmIntrinsics::_StringBuffer_void:

      case vmIntrinsics::_StringBuffer_int:

      case vmIntrinsics::_StringBuffer_String:

      case vmIntrinsics::_StringBuffer_append_char:

      case vmIntrinsics::_StringBuffer_append_int:

      case vmIntrinsics::_StringBuffer_append_String:

      case vmIntrinsics::_StringBuffer_toString:

      case vmIntrinsics::_Integer_toString:

        return true;

      case vmIntrinsics::_String_String:

        {

          Node* receiver = jvms->map()->in(jvms->argoff() + 1);

          if (receiver->is_Proj() && receiver->in(0)->is_CallStaticJava()) {

            CallStaticJavaNode* csj = receiver->in(0)->as_CallStaticJava();

            ciMethod* m = csj->method();

            if (m != NULL &&

                (m->intrinsic_id() == vmIntrinsics::_StringBuffer_toString ||

                 m->intrinsic_id() == vmIntrinsics::_StringBuilder_toString))

              // Delay String.<init>(new SB())

              return true;

          }

          return false;

        }

      default:

        return false;

    }

  }

  return false;

}

bool Compile::should_delay_boxing_inlining(ciMethod* call_method, JVMState* jvms) {

  if (eliminate_boxing() && call_method->is_boxing_method()) {

    set_has_boxed_value(true);

    return aggressive_unboxing();

  }

  return false;

}

// uncommon-trap call-sites where callee is unloaded, uninitialized or will not link

bool Parse::can_not_compile_call_site(ciMethod *dest_method, ciInstanceKlass* klass) {

  // Additional inputs to consider...

  // bc      = bc()

  // caller  = method()

  // iter().get_method_holder_index()

  assert( dest_method->is_loaded(), "ciTypeFlow should not let us get here" );

  // Interface classes can be loaded & linked and never get around to

  // being initialized.  Uncommon-trap for not-initialized static or

  // v-calls.  Let interface calls happen.

  ciInstanceKlass* holder_klass = dest_method->holder();

  if (!holder_klass->is_being_initialized() &&

      !holder_klass->is_initialized() &&

      !holder_klass->is_interface()) {

    uncommon_trap(Deoptimization::Reason_uninitialized,

                  Deoptimization::Action_reinterpret,

                  holder_klass);

    return true;

  }

  assert(dest_method->is_loaded(), "dest_method: typeflow responsibility");

  return false;

}

#ifdef ASSERT

static bool check_call_consistency(JVMState* jvms, CallGenerator* cg) {

  ciMethod* symbolic_info = jvms->method()->get_method_at_bci(jvms->bci());

  ciMethod* resolved_method = cg->method();

  if (!ciMethod::is_consistent_info(symbolic_info, resolved_method)) {

    tty->print_cr("JVMS:");

    jvms->dump();

    tty->print_cr("Bytecode info:");

    jvms->method()->get_method_at_bci(jvms->bci())->print(); tty->cr();

    tty->print_cr("Resolved method:");

    cg->method()->print(); tty->cr();

    return false;

  }

  return true;

}

#endif // ASSERT

//------------------------------do_call----------------------------------------

// Handle your basic call.  Inline if we can & want to, else just setup call.

void Parse::do_call() {

  // It's likely we are going to add debug info soon.

  // Also, if we inline a guy who eventually needs debug info for this JVMS,

  // our contribution to it is cleaned up right here.

  kill_dead_locals();

  C->print_inlining_assert_ready();

  // Set frequently used booleans

  const bool is_virtual = bc() == Bytecodes::_invokevirtual;

  const bool is_virtual_or_interface = is_virtual || bc() == Bytecodes::_invokeinterface;

  const bool has_receiver = Bytecodes::has_receiver(bc());

  // Find target being called

  bool             will_link;

  ciSignature*     declared_signature = NULL;

  ciMethod*        orig_callee  = iter().get_method(will_link, &declared_signature);  // callee in the bytecode

  ciInstanceKlass* holder_klass = orig_callee->holder();

  ciKlass*         holder       = iter().get_declared_method_holder();

  ciInstanceKlass* klass = ciEnv::get_instance_klass_for_declared_method_holder(holder);

  assert(declared_signature != NULL, "cannot be null");

  // Bump max node limit for JSR292 users

  if (bc() == Bytecodes::_invokedynamic || orig_callee->is_method_handle_intrinsic()) {

    C->set_max_node_limit(3*MaxNodeLimit);

  }

  // uncommon-trap when callee is unloaded, uninitialized or will not link

  // bailout when too many arguments for register representation