/*

 * Copyright (c) 1999, 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 "runtime/handles.inline.hpp"

#include "jfr/support/jfrIntrinsics.hpp"

#include "opto/c2compiler.hpp"

#include "opto/compile.hpp"

#include "opto/optoreg.hpp"

#include "opto/output.hpp"

#include "opto/runtime.hpp"

#include "utilities/macros.hpp"

// register information defined by ADLC

extern const char register_save_policy[];

extern const int  register_save_type[];

const char* C2Compiler::retry_no_subsuming_loads() {

  return "retry without subsuming loads";

}

const char* C2Compiler::retry_no_escape_analysis() {

  return "retry without escape analysis";

}

const char* C2Compiler::retry_class_loading_during_parsing() {

  return "retry class loading during parsing";

}

bool C2Compiler::init_c2_runtime() {

  // Check assumptions used while running ADLC

  Compile::adlc_verification();

  assert(REG_COUNT <= ConcreteRegisterImpl::number_of_registers, "incompatible register counts");

  for (int i = 0; i < ConcreteRegisterImpl::number_of_registers ; i++ ) {

      OptoReg::vm2opto[i] = OptoReg::Bad;

  }

  for( OptoReg::Name i=OptoReg::Name(0); i<OptoReg::Name(REG_COUNT); i = OptoReg::add(i,1) ) {

    VMReg r = OptoReg::as_VMReg(i);

    if (r->is_valid()) {

      OptoReg::vm2opto[r->value()] = i;

    }

  }

  // Check that runtime and architecture description agree on callee-saved-floats

  bool callee_saved_floats = false;

  for( OptoReg::Name i=OptoReg::Name(0); i<OptoReg::Name(_last_Mach_Reg); i = OptoReg::add(i,1) ) {

    // Is there a callee-saved float or double?

    if( register_save_policy[i] == 'E' /* callee-saved */ &&

       (register_save_type[i] == Op_RegF || register_save_type[i] == Op_RegD) ) {

      callee_saved_floats = true;

    }

  }

  DEBUG_ONLY( Node::init_NodeProperty(); )

  Compile::pd_compiler2_init();

  CompilerThread* thread = CompilerThread::current();

  HandleMark handle_mark(thread);

  return OptoRuntime::generate(thread->env());

}

void C2Compiler::initialize() {

  // The first compiler thread that gets here will initialize the

  // small amount of global state (and runtime stubs) that C2 needs.

  // There is a race possible once at startup and then we're fine

  // Note that this is being called from a compiler thread not the

  // main startup thread.

  if (should_perform_init()) {

    bool successful = C2Compiler::init_c2_runtime();

    int new_state = (successful) ? initialized : failed;

    set_state(new_state);

  }

}

void C2Compiler::compile_method(ciEnv* env, ciMethod* target, int entry_bci, DirectiveSet* directive) {

  assert(is_initialized(), "Compiler thread must be initialized");

  bool subsume_loads = SubsumeLoads;

  bool do_escape_analysis = DoEscapeAnalysis && !env->should_retain_local_variables()

                                             && !env->jvmti_can_get_owned_monitor_info();

  bool eliminate_boxing = EliminateAutoBox;

  while (!env->failing()) {

    // Attempt to compile while subsuming loads into machine instructions.

    Compile C(env, this, target, entry_bci, subsume_loads, do_escape_analysis, eliminate_boxing, directive);

    // Check result and retry if appropriate.

    if (C.failure_reason() != NULL) {

      if (C.failure_reason_is(retry_class_loading_during_parsing())) {

        env->report_failure(C.failure_reason());

        continue;  // retry

      }

      if (C.failure_reason_is(retry_no_subsuming_loads())) {

        assert(subsume_loads, "must make progress");

        subsume_loads = false;

        env->report_failure(C.failure_reason());

        continue;  // retry

      }

      if (C.failure_reason_is(retry_no_escape_analysis())) {

        assert(do_escape_analysis, "must make progress");

        do_escape_analysis = false;

        env->report_failure(C.failure_reason());

        continue;  // retry

      }

      if (C.has_boxed_value()) {

        // Recompile without boxing elimination regardless failure reason.

        assert(eliminate_boxing, "must make progress");

        eliminate_boxing = false;

        env->report_failure(C.failure_reason());

        continue;  // retry

      }

      // Pass any other failure reason up to the ciEnv.

      // Note that serious, irreversible failures are already logged

      // on the ciEnv via env->record_method_not_compilable().

      env->record_failure(C.failure_reason());

    }

    if (StressRecompilation) {

      if (subsume_loads) {

        subsume_loads = false;

        continue;  // retry

      }

      if (do_escape_analysis) {

        do_escape_analysis = false;

        continue;  // retry

      }

    }

    // print inlining for last compilation only

    C.dump_print_inlining();

    // No retry; just break the loop.

    break;

  }

}

void C2Compiler::print_timers() {

  Compile::print_timers();

}

bool C2Compiler::is_intrinsic_supported(const methodHandle& method, bool is_virtual) {

  vmIntrinsics::ID id = method->intrinsic_id();

  assert(id != vmIntrinsics::_none, "must be a VM intrinsic");

  if (id < vmIntrinsics::FIRST_ID || id > vmIntrinsics::LAST_COMPILER_INLINE) {

    return false;

  }

  // Only Object.hashCode and Object.clone intrinsics implement also a virtual

  // dispatch because calling both methods is expensive but both methods are

  // frequently overridden. All other intrinsics implement only a non-virtual

  // dispatch.

  if (is_virtual) {

    switch (id) {

    case vmIntrinsics::_hashCode:

    case vmIntrinsics::_clone:

      break;

    default:

      return false;

    }

  }

  switch (id) {

  case vmIntrinsics::_compressStringC:

  case vmIntrinsics::_compressStringB:

    if (!Matcher::has_match_rule(Op_StrCompressedCopy)) return false;

    break;

  case vmIntrinsics::_inflateStringC:

  case vmIntrinsics::_inflateStringB:

    if (!Matcher::has_match_rule(Op_StrInflatedCopy)) return false;

    break;

  case vmIntrinsics::_compareToL:

  case vmIntrinsics::_compareToU:

  case vmIntrinsics::_compareToLU:

  case vmIntrinsics::_compareToUL:

    if (!Matcher::match_rule_supported(Op_StrComp)) return false;

    break;

  case vmIntrinsics::_equalsL:

  case vmIntrinsics::_equalsU:

    if (!Matcher::match_rule_supported(Op_StrEquals)) return false;

    break;

  case vmIntrinsics::_equalsB:

  case vmIntrinsics::_equalsC:

    if (!Matcher::match_rule_supported(Op_AryEq)) return false;

    break;

  case vmIntrinsics::_copyMemory:

    if (StubRoutines::unsafe_arraycopy() == NULL) return false;

    break;

  case vmIntrinsics::_encodeISOArray:

  case vmIntrinsics::_encodeByteISOArray:

    if (!Matcher::match_rule_supported(Op_EncodeISOArray)) return false;

    break;

  case vmIntrinsics::_hasNegatives:

    if (!Matcher::match_rule_supported(Op_HasNegatives))  return false;

    break;

  case vmIntrinsics::_bitCount_i:

    if (!Matcher::match_rule_supported(Op_PopCountI)) return false;

    break;

  case vmIntrinsics::_bitCount_l:

    if (!Matcher::match_rule_supported(Op_PopCountL)) return false;

    break;

  case vmIntrinsics::_numberOfLeadingZeros_i:

    if (!Matcher::match_rule_supported(Op_CountLeadingZerosI)) return false;

    break;

  case vmIntrinsics::_numberOfLeadingZeros_l:

    if (!Matcher::match_rule_supported(Op_CountLeadingZerosL)) return false;

    break;

  case vmIntrinsics::_numberOfTrailingZeros_i:

    if (!Matcher::match_rule_supported(Op_CountTrailingZerosI)) return false;

    break;

  case vmIntrinsics::_numberOfTrailingZeros_l:

    if (!Matcher::match_rule_supported(Op_CountTrailingZerosL)) return false;

    break;

  case vmIntrinsics::_reverseBytes_c:

    if (!Matcher::match_rule_supported(Op_ReverseBytesUS)) return false;

    break;

  case vmIntrinsics::_reverseBytes_s:

    if (!Matcher::match_rule_supported(Op_ReverseBytesS)) return false;

    break;

  case vmIntrinsics::_reverseBytes_i:

    if (!Matcher::match_rule_supported(Op_ReverseBytesI)) return false;

    break;

  case vmIntrinsics::_reverseBytes_l:

    if (!Matcher::match_rule_supported(Op_ReverseBytesL)) return false;

    break;

  /* CompareAndSet, Object: */

  case vmIntrinsics::_compareAndSetReference:

#ifdef _LP64

    if ( UseCompressedOops && !Matcher::match_rule_supported(Op_CompareAndSwapN)) return false;

    if (!UseCompressedOops && !Matcher::match_rule_supported(Op_CompareAndSwapP)) return false;

#else

    if (!Matcher::match_rule_supported(Op_CompareAndSwapP)) return false;

#endif

    break;

  case vmIntrinsics::_weakCompareAndSetReferencePlain:

  case vmIntrinsics::_weakCompareAndSetReferenceAcquire:

  case vmIntrinsics::_weakCompareAndSetReferenceRelease:

  case vmIntrinsics::_weakCompareAndSetReference:

#ifdef _LP64

    if ( UseCompressedOops && !Matcher::match_rule_supported(Op_WeakCompareAndSwapN)) return false;

    if (!UseCompressedOops && !Matcher::match_rule_supported(Op_WeakCompareAndSwapP)) return false;

#else

    if (!Matcher::match_rule_supported(Op_WeakCompareAndSwapP)) return false;

#endif

    break;

  /* CompareAndSet, Long: */

  case vmIntrinsics::_compareAndSetLong:

    if (!Matcher::match_rule_supported(Op_CompareAndSwapL)) return false;

    break;

  case vmIntrinsics::_weakCompareAndSetLongPlain:

  case vmIntrinsics::_weakCompareAndSetLongAcquire:

  case vmIntrinsics::_weakCompareAndSetLongRelease:

  case vmIntrinsics::_weakCompareAndSetLong:

    if (!Matcher::match_rule_supported(Op_WeakCompareAndSwapL)) return false;

    break;

  /* CompareAndSet, Int: */

  case vmIntrinsics::_compareAndSetInt:

    if (!Matcher::match_rule_supported(Op_CompareAndSwapI)) return false;

    break;

  case vmIntrinsics::_weakCompareAndSetIntPlain:

  case vmIntrinsics::_weakCompareAndSetIntAcquire:

  case vmIntrinsics::_weakCompareAndSetIntRelease:

  case vmIntrinsics::_weakCompareAndSetInt:

    if (!Matcher::match_rule_supported(Op_WeakCompareAndSwapI)) return false;

    break;

  /* CompareAndSet, Byte: */

  case vmIntrinsics::_compareAndSetByte:

    if (!Matcher::match_rule_supported(Op_CompareAndSwapB)) return false;

    break;

  case vmIntrinsics::_weakCompareAndSetBytePlain:

  case vmIntrinsics::_weakCompareAndSetByteAcquire:

  case vmIntrinsics::_weakCompareAndSetByteRelease:

  case vmIntrinsics::_weakCompareAndSetByte:

    if (!Matcher::match_rule_supported(Op_WeakCompareAndSwapB)) return false;

    break;

  /* CompareAndSet, Short: */

  case vmIntrinsics::_compareAndSetShort:

    if (!Matcher::match_rule_supported(Op_CompareAndSwapS)) return false;

    break;

  case vmIntrinsics::_weakCompareAndSetShortPlain:

  case vmIntrinsics::_weakCompareAndSetShortAcquire:

  case vmIntrinsics::_weakCompareAndSetShortRelease:

  case vmIntrinsics::_weakCompareAndSetShort:

    if (!Matcher::match_rule_supported(Op_WeakCompareAndSwapS)) return false;

    break;

  /* CompareAndExchange, Object: */

  case vmIntrinsics::_compareAndExchangeReference:

  case vmIntrinsics::_compareAndExchangeReferenceAcquire:

  case vmIntrinsics::_compareAndExchangeReferenceRelease:

#ifdef _LP64

    if ( UseCompressedOops && !Matcher::match_rule_supported(Op_CompareAndExchangeN)) return false;

    if (!UseCompressedOops && !Matcher::match_rule_supported(Op_CompareAndExchangeP)) return false;

#else

    if (!Matcher::match_rule_supported(Op_CompareAndExchangeP)) return false;

#endif

    break;

  /* CompareAndExchange, Long: */

  case vmIntrinsics::_compareAndExchangeLong:

  case vmIntrinsics::_compareAndExchangeLongAcquire:

  case vmIntrinsics::_compareAndExchangeLongRelease:

    if (!Matcher::match_rule_supported(Op_CompareAndExchangeL)) return false;

    break;

  /* CompareAndExchange, Int: */

  case vmIntrinsics::_compareAndExchangeInt:

  case vmIntrinsics::_compareAndExchangeIntAcquire:

  case vmIntrinsics::_compareAndExchangeIntRelease:

    if (!Matcher::match_rule_supported(Op_CompareAndExchangeI)) return false;

    break;

  /* CompareAndExchange, Byte: */

  case vmIntrinsics::_compareAndExchangeByte:

  case vmIntrinsics::_compareAndExchangeByteAcquire:

  case vmIntrinsics::_compareAndExchangeByteRelease:

    if (!Matcher::match_rule_supported(Op_CompareAndExchangeB)) return false;

    break;

  /* CompareAndExchange, Short: */

  case vmIntrinsics::_compareAndExchangeShort:

  case vmIntrinsics::_compareAndExchangeShortAcquire:

  case vmIntrinsics::_compareAndExchangeShortRelease:

    if (!Matcher::match_rule_supported(Op_CompareAndExchangeS)) return false;

    break;

  case vmIntrinsics::_getAndAddByte:

    if (!Matcher::match_rule_supported(Op_GetAndAddB)) return false;

    break;

  case vmIntrinsics::_getAndAddShort:

    if (!Matcher::match_rule_supported(Op_GetAndAddS)) return false;

    break;

  case vmIntrinsics::_getAndAddInt:

    if (!Matcher::match_rule_supported(Op_GetAndAddI)) return false;

    break;

  case vmIntrinsics::_getAndAddLong:

    if (!Matcher::match_rule_supported(Op_GetAndAddL)) return false;

    break;

  case vmIntrinsics::_getAndSetByte:

    if (!Matcher::match_rule_supported(Op_GetAndSetB)) return false;

    break;

  case vmIntrinsics::_getAndSetShort:

    if (!Matcher::match_rule_supported(Op_GetAndSetS)) return false;

    break;

  case vmIntrinsics::_getAndSetInt:

    if (!Matcher::match_rule_supported(Op_GetAndSetI)) return false;

    break;

  case vmIntrinsics::_getAndSetLong:

    if (!Matcher::match_rule_supported(Op_GetAndSetL)) return false;

    break;

  case vmIntrinsics::_getAndSetReference:

#ifdef _LP64

    if (!UseCompressedOops && !Matcher::match_rule_supported(Op_GetAndSetP)) return false;

    if (UseCompressedOops && !Matcher::match_rule_supported(Op_GetAndSetN)) return false;

    break;

#else

    if (!Matcher::match_rule_supported(Op_GetAndSetP)) return false;

    break;

#endif

  case vmIntrinsics::_incrementExactI:

  case vmIntrinsics::_addExactI:

    if (!Matcher::match_rule_supported(Op_OverflowAddI)) return false;

    break;

  case vmIntrinsics::_incrementExactL:

  case vmIntrinsics::_addExactL:

    if (!Matcher::match_rule_supported(Op_OverflowAddL)) return false;

    break;

  case vmIntrinsics::_decrementExactI:

  case vmIntrinsics::_subtractExactI:

    if (!Matcher::match_rule_supported(Op_OverflowSubI)) return false;

    break;

  case vmIntrinsics::_decrementExactL:

  case vmIntrinsics::_subtractExactL:

    if (!Matcher::match_rule_supported(Op_OverflowSubL)) return false;

    break;

  case vmIntrinsics::_negateExactI:

    if (!Matcher::match_rule_supported(Op_OverflowSubI)) return false;

    break;

  case vmIntrinsics::_negateExactL:

    if (!Matcher::match_rule_supported(Op_OverflowSubL)) return false;

    break;

  case vmIntrinsics::_multiplyExactI:

    if (!Matcher::match_rule_supported(Op_OverflowMulI)) return false;

    break;

  case vmIntrinsics::_multiplyExactL:

    if (!Matcher::match_rule_supported(Op_OverflowMulL)) return false;

    break;

  case vmIntrinsics::_multiplyHigh:

    if (!Matcher::match_rule_supported(Op_MulHiL)) return false;

    break;

  case vmIntrinsics::_getCallerClass:

    if (SystemDictionary::reflect_CallerSensitive_klass() == NULL) return false;

    break;

  case vmIntrinsics::_onSpinWait:

    if (!Matcher::match_rule_supported(Op_OnSpinWait)) return false;

    break;

  case vmIntrinsics::_fmaD:

    if (!UseFMA || !Matcher::match_rule_supported(Op_FmaD)) return false;

    break;

  case vmIntrinsics::_fmaF:

    if (!UseFMA || !Matcher::match_rule_supported(Op_FmaF)) return false;

    break;

  case vmIntrinsics::_isDigit:

    if (!Matcher::match_rule_supported(Op_Digit)) return false;

    break;

  case vmIntrinsics::_isLowerCase:

    if (!Matcher::match_rule_supported(Op_LowerCase)) return false;

    break;

  case vmIntrinsics::_isUpperCase:

    if (!Matcher::match_rule_supported(Op_UpperCase)) return false;

    break;

  case vmIntrinsics::_isWhitespace:

    if (!Matcher::match_rule_supported(Op_Whitespace)) return false;

    break;

  case vmIntrinsics::_maxF:

    if (!Matcher::match_rule_supported(Op_MaxF)) return false;

    break;

  case vmIntrinsics::_minF:

    if (!Matcher::match_rule_supported(Op_MinF)) return false;

    break;

  case vmIntrinsics::_maxD:

    if (!Matcher::match_rule_supported(Op_MaxD)) return false;

    break;

  case vmIntrinsics::_minD:

    if (!Matcher::match_rule_supported(Op_MinD)) return false;

    break;

  case vmIntrinsics::_writeback0:

    if (!Matcher::match_rule_supported(Op_CacheWB)) return false;

    break;

  case vmIntrinsics::_writebackPreSync0:

    if (!Matcher::match_rule_supported(Op_CacheWBPreSync)) return false;

    break;

  case vmIntrinsics::_writebackPostSync0:

    if (!Matcher::match_rule_supported(Op_CacheWBPostSync)) return false;

    break;

  case vmIntrinsics::_rint:

  case vmIntrinsics::_ceil:

  case vmIntrinsics::_floor:

    if (!Matcher::match_rule_supported(Op_RoundDoubleMode)) return false;

    break;

  case vmIntrinsics::_hashCode:

  case vmIntrinsics::_identityHashCode:

  case vmIntrinsics::_getClass:

  case vmIntrinsics::_dsin:

  case vmIntrinsics::_dcos:

  case vmIntrinsics::_dtan:

  case vmIntrinsics::_dabs:

  case vmIntrinsics::_fabs:

  case vmIntrinsics::_iabs:

  case vmIntrinsics::_labs:

  case vmIntrinsics::_datan2:

  case vmIntrinsics::_dsqrt:

  case vmIntrinsics::_dexp:

  case vmIntrinsics::_dlog:

  case vmIntrinsics::_dlog10:

  case vmIntrinsics::_dpow:

  case vmIntrinsics::_min:

  case vmIntrinsics::_max:

  case vmIntrinsics::_arraycopy:

  case vmIntrinsics::_indexOfL:

  case vmIntrinsics::_indexOfU:

  case vmIntrinsics::_indexOfUL:

  case vmIntrinsics::_indexOfIL: