/*

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

 * Copyright (c) 2014, 2019, Red Hat Inc. 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 "asm/macroAssembler.inline.hpp"

#include "gc/shared/barrierSetAssembler.hpp"

#include "interpreter/bytecodeHistogram.hpp"

#include "interpreter/interpreter.hpp"

#include "interpreter/interpreterRuntime.hpp"

#include "interpreter/interp_masm.hpp"

#include "interpreter/templateInterpreterGenerator.hpp"

#include "interpreter/templateTable.hpp"

#include "interpreter/bytecodeTracer.hpp"

#include "memory/resourceArea.hpp"

#include "oops/arrayOop.hpp"

#include "oops/methodData.hpp"

#include "oops/method.hpp"

#include "oops/oop.inline.hpp"

#include "prims/jvmtiExport.hpp"

#include "prims/jvmtiThreadState.hpp"

#include "runtime/arguments.hpp"

#include "runtime/deoptimization.hpp"

#include "runtime/frame.inline.hpp"

#include "runtime/sharedRuntime.hpp"

#include "runtime/stubRoutines.hpp"

#include "runtime/synchronizer.hpp"

#include "runtime/timer.hpp"

#include "runtime/vframeArray.hpp"

#include "utilities/debug.hpp"

#include <sys/types.h>

#ifndef PRODUCT

#include "oops/method.hpp"

#endif // !PRODUCT

// Size of interpreter code.  Increase if too small.  Interpreter will

// fail with a guarantee ("not enough space for interpreter generation");

// if too small.

// Run with +PrintInterpreter to get the VM to print out the size.

// Max size with JVMTI

int TemplateInterpreter::InterpreterCodeSize = 200 * 1024;

#define __ _masm->

//-----------------------------------------------------------------------------

extern "C" void entry(CodeBuffer*);

//-----------------------------------------------------------------------------

address TemplateInterpreterGenerator::generate_slow_signature_handler() {

  address entry = __ pc();

  __ andr(esp, esp, -16);

  __ mov(c_rarg3, esp);

  // rmethod

  // rlocals

  // c_rarg3: first stack arg - wordSize

  // adjust sp

  __ sub(sp, c_rarg3, 18 * wordSize);

  __ str(lr, Address(__ pre(sp, -2 * wordSize)));

  __ call_VM(noreg,

             CAST_FROM_FN_PTR(address,

                              InterpreterRuntime::slow_signature_handler),

             rmethod, rlocals, c_rarg3);

  // r0: result handler

  // Stack layout:

  // rsp: return address           <- sp

  //      1 garbage

  //      8 integer args (if static first is unused)

  //      1 float/double identifiers

  //      8 double args

  //        stack args              <- esp

  //        garbage

  //        expression stack bottom

  //        bcp (NULL)

  //        ...

  // Restore LR

  __ ldr(lr, Address(__ post(sp, 2 * wordSize)));

  // Do FP first so we can use c_rarg3 as temp

  __ ldrw(c_rarg3, Address(sp, 9 * wordSize)); // float/double identifiers

  for (int i = 0; i < Argument::n_float_register_parameters_c; i++) {

    const FloatRegister r = as_FloatRegister(i);

    Label d, done;

    __ tbnz(c_rarg3, i, d);

    __ ldrs(r, Address(sp, (10 + i) * wordSize));

    __ b(done);

    __ bind(d);

    __ ldrd(r, Address(sp, (10 + i) * wordSize));

    __ bind(done);

  }

  // c_rarg0 contains the result from the call of

  // InterpreterRuntime::slow_signature_handler so we don't touch it

  // here.  It will be loaded with the JNIEnv* later.

  __ ldr(c_rarg1, Address(sp, 1 * wordSize));

  for (int i = c_rarg2->encoding(); i <= c_rarg7->encoding(); i += 2) {

    Register rm = as_Register(i), rn = as_Register(i+1);

    __ ldp(rm, rn, Address(sp, i * wordSize));

  }

  __ add(sp, sp, 18 * wordSize);

  __ ret(lr);

  return entry;

}

//

// Various method entries

//

address TemplateInterpreterGenerator::generate_math_entry(AbstractInterpreter::MethodKind kind) {

  // rmethod: Method*

  // r13: sender sp

  // esp: args

  if (!InlineIntrinsics) return NULL; // Generate a vanilla entry

  // These don't need a safepoint check because they aren't virtually

  // callable. We won't enter these intrinsics from compiled code.

  // If in the future we added an intrinsic which was virtually callable

  // we'd have to worry about how to safepoint so that this code is used.

  // mathematical functions inlined by compiler

  // (interpreter must provide identical implementation

  // in order to avoid monotonicity bugs when switching

  // from interpreter to compiler in the middle of some

  // computation)

  //

  // stack:

  //        [ arg ] <-- esp

  //        [ arg ]

  // retaddr in lr

  address entry_point = NULL;

  Register continuation = lr;

  switch (kind) {

  case Interpreter::java_lang_math_abs:

    entry_point = __ pc();

    __ ldrd(v0, Address(esp));

    __ fabsd(v0, v0);

    __ mov(sp, r13); // Restore caller's SP

    break;

  case Interpreter::java_lang_math_sqrt:

    entry_point = __ pc();

    __ ldrd(v0, Address(esp));

    __ fsqrtd(v0, v0);

    __ mov(sp, r13);

    break;

  case Interpreter::java_lang_math_sin :

  case Interpreter::java_lang_math_cos :

  case Interpreter::java_lang_math_tan :

  case Interpreter::java_lang_math_log :

  case Interpreter::java_lang_math_log10 :

  case Interpreter::java_lang_math_exp :

    entry_point = __ pc();

    __ ldrd(v0, Address(esp));

    __ mov(sp, r13);

    __ mov(r19, lr);

    continuation = r19;  // The first callee-saved register

    generate_transcendental_entry(kind, 1);

    break;

  case Interpreter::java_lang_math_pow :

    entry_point = __ pc();

    __ mov(r19, lr);

    continuation = r19;

    __ ldrd(v0, Address(esp, 2 * Interpreter::stackElementSize));

    __ ldrd(v1, Address(esp));

    __ mov(sp, r13);

    generate_transcendental_entry(kind, 2);

    break;

  case Interpreter::java_lang_math_fmaD :

    if (UseFMA) {

      entry_point = __ pc();

      __ ldrd(v0, Address(esp, 4 * Interpreter::stackElementSize));

      __ ldrd(v1, Address(esp, 2 * Interpreter::stackElementSize));

      __ ldrd(v2, Address(esp));

      __ fmaddd(v0, v0, v1, v2);

      __ mov(sp, r13); // Restore caller's SP

    }

    break;

  case Interpreter::java_lang_math_fmaF :

    if (UseFMA) {

      entry_point = __ pc();

      __ ldrs(v0, Address(esp, 2 * Interpreter::stackElementSize));

      __ ldrs(v1, Address(esp, Interpreter::stackElementSize));

      __ ldrs(v2, Address(esp));

      __ fmadds(v0, v0, v1, v2);

      __ mov(sp, r13); // Restore caller's SP

    }

    break;

  default:

    ;

  }

  if (entry_point) {

    __ br(continuation);

  }

  return entry_point;

}

  // double trigonometrics and transcendentals

  // static jdouble dsin(jdouble x);

  // static jdouble dcos(jdouble x);

  // static jdouble dtan(jdouble x);

  // static jdouble dlog(jdouble x);

  // static jdouble dlog10(jdouble x);

  // static jdouble dexp(jdouble x);

  // static jdouble dpow(jdouble x, jdouble y);

void TemplateInterpreterGenerator::generate_transcendental_entry(AbstractInterpreter::MethodKind kind, int fpargs) {

  address fn;

  switch (kind) {

  case Interpreter::java_lang_math_sin :

    if (StubRoutines::dsin() == NULL) {

      fn = CAST_FROM_FN_PTR(address, SharedRuntime::dsin);

    } else {

      fn = CAST_FROM_FN_PTR(address, StubRoutines::dsin());

    }

    break;

  case Interpreter::java_lang_math_cos :

    if (StubRoutines::dcos() == NULL) {

      fn = CAST_FROM_FN_PTR(address, SharedRuntime::dcos);

    } else {

      fn = CAST_FROM_FN_PTR(address, StubRoutines::dcos());

    }

    break;

  case Interpreter::java_lang_math_tan :

    if (StubRoutines::dtan() == NULL) {

      fn = CAST_FROM_FN_PTR(address, SharedRuntime::dtan);

    } else {

      fn = CAST_FROM_FN_PTR(address, StubRoutines::dtan());

    }

    break;

  case Interpreter::java_lang_math_log :

    if (StubRoutines::dlog() == NULL) {

      fn = CAST_FROM_FN_PTR(address, SharedRuntime::dlog);

    } else {

      fn = CAST_FROM_FN_PTR(address, StubRoutines::dlog());

    }

    break;

  case Interpreter::java_lang_math_log10 :

    if (StubRoutines::dlog10() == NULL) {

      fn = CAST_FROM_FN_PTR(address, SharedRuntime::dlog10);

    } else {

      fn = CAST_FROM_FN_PTR(address, StubRoutines::dlog10());

    }

    break;

  case Interpreter::java_lang_math_exp :

    if (StubRoutines::dexp() == NULL) {

      fn = CAST_FROM_FN_PTR(address, SharedRuntime::dexp);

    } else {

      fn = CAST_FROM_FN_PTR(address, StubRoutines::dexp());

    }

    break;

  case Interpreter::java_lang_math_pow :

    if (StubRoutines::dpow() == NULL) {

      fn = CAST_FROM_FN_PTR(address, SharedRuntime::dpow);

    } else {

      fn = CAST_FROM_FN_PTR(address, StubRoutines::dpow());

    }

    break;

  default:

    ShouldNotReachHere();

    fn = NULL;  // unreachable

  }

  __ mov(rscratch1, fn);

  __ blr(rscratch1);

}

// Abstract method entry

// Attempt to execute abstract method. Throw exception

address TemplateInterpreterGenerator::generate_abstract_entry(void) {

  // rmethod: Method*

  // r13: sender SP

  address entry_point = __ pc();

  // abstract method entry

  //  pop return address, reset last_sp to NULL

  __ empty_expression_stack();

  __ restore_bcp();      // bcp must be correct for exception handler   (was destroyed)

  __ restore_locals();   // make sure locals pointer is correct as well (was destroyed)

  // throw exception

  __ call_VM(noreg, CAST_FROM_FN_PTR(address,

                                     InterpreterRuntime::throw_AbstractMethodErrorWithMethod),

                                     rmethod);

  // the call_VM checks for exception, so we should never return here.

  __ should_not_reach_here();

  return entry_point;

}

address TemplateInterpreterGenerator::generate_StackOverflowError_handler() {

  address entry = __ pc();

#ifdef ASSERT

  {

    Label L;

    __ ldr(rscratch1, Address(rfp,

                       frame::interpreter_frame_monitor_block_top_offset *

                       wordSize));

    __ mov(rscratch2, sp);

    __ cmp(rscratch1, rscratch2); // maximal rsp for current rfp (stack

                           // grows negative)

    __ br(Assembler::HS, L); // check if frame is complete

    __ stop ("interpreter frame not set up");

    __ bind(L);

  }

#endif // ASSERT

  // Restore bcp under the assumption that the current frame is still

  // interpreted

  __ restore_bcp();

  // expression stack must be empty before entering the VM if an

  // exception happened

  __ empty_expression_stack();

  // throw exception

  __ call_VM(noreg,

             CAST_FROM_FN_PTR(address,

                              InterpreterRuntime::throw_StackOverflowError));

  return entry;

}

address TemplateInterpreterGenerator::generate_ArrayIndexOutOfBounds_handler() {

  address entry = __ pc();

  // expression stack must be empty before entering the VM if an

  // exception happened

  __ empty_expression_stack();

  // setup parameters

  // ??? convention: expect aberrant index in register r1

  __ movw(c_rarg2, r1);

  // ??? convention: expect array in register r3

  __ mov(c_rarg1, r3);

  __ call_VM(noreg,

             CAST_FROM_FN_PTR(address,

                              InterpreterRuntime::

                              throw_ArrayIndexOutOfBoundsException),

             c_rarg1, c_rarg2);

  return entry;

}

address TemplateInterpreterGenerator::generate_ClassCastException_handler() {

  address entry = __ pc();

  // object is at TOS

  __ pop(c_rarg1);

  // expression stack must be empty before entering the VM if an

  // exception happened

  __ empty_expression_stack();

  __ call_VM(noreg,

             CAST_FROM_FN_PTR(address,

                              InterpreterRuntime::

                              throw_ClassCastException),

             c_rarg1);

  return entry;

}

address TemplateInterpreterGenerator::generate_exception_handler_common(

        const char* name, const char* message, bool pass_oop) {

  assert(!pass_oop || message == NULL, "either oop or message but not both");

  address entry = __ pc();

  if (pass_oop) {

    // object is at TOS

    __ pop(c_rarg2);

  }

  // expression stack must be empty before entering the VM if an

  // exception happened

  __ empty_expression_stack();

  // setup parameters

  __ lea(c_rarg1, Address((address)name));

  if (pass_oop) {

    __ call_VM(r0, CAST_FROM_FN_PTR(address,

                                    InterpreterRuntime::

                                    create_klass_exception),

               c_rarg1, c_rarg2);

  } else {

    // kind of lame ExternalAddress can't take NULL because

    // external_word_Relocation will assert.

    if (message != NULL) {

      __ lea(c_rarg2, Address((address)message));

    } else {

      __ mov(c_rarg2, NULL_WORD);

    }

    __ call_VM(r0,

               CAST_FROM_FN_PTR(address, InterpreterRuntime::create_exception),

               c_rarg1, c_rarg2);

  }

  // throw exception

  __ b(address(Interpreter::throw_exception_entry()));

  return entry;

}

address TemplateInterpreterGenerator::generate_return_entry_for(TosState state, int step, size_t index_size) {

  address entry = __ pc();

  // Restore stack bottom in case i2c adjusted stack

  __ ldr(esp, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));

  // and NULL it as marker that esp is now tos until next java call

  __ str(zr, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));

  __ restore_bcp();

  __ restore_locals();

  __ restore_constant_pool_cache();

  __ get_method(rmethod);

  if (state == atos) {

    Register obj = r0;

    Register mdp = r1;

    Register tmp = r2;

    __ ldr(mdp, Address(rmethod, Method::method_data_offset()));

    __ profile_return_type(mdp, obj, tmp);

  }

  // Pop N words from the stack

  __ get_cache_and_index_at_bcp(r1, r2, 1, index_size);

  __ ldr(r1, Address(r1, ConstantPoolCache::base_offset() + ConstantPoolCacheEntry::flags_offset()));

  __ andr(r1, r1, ConstantPoolCacheEntry::parameter_size_mask);

  __ add(esp, esp, r1, Assembler::LSL, 3);

  // Restore machine SP

  __ ldr(rscratch1, Address(rmethod, Method::const_offset()));

  __ ldrh(rscratch1, Address(rscratch1, ConstMethod::max_stack_offset()));

  __ add(rscratch1, rscratch1, frame::interpreter_frame_monitor_size() + 2);

  __ ldr(rscratch2,

         Address(rfp, frame::interpreter_frame_initial_sp_offset * wordSize));

  __ sub(rscratch1, rscratch2, rscratch1, ext::uxtw, 3);

  __ andr(sp, rscratch1, -16);

 __ check_and_handle_popframe(rthread);

 __ check_and_handle_earlyret(rthread);

  __ get_dispatch();

  __ dispatch_next(state, step);

  return entry;

}

address TemplateInterpreterGenerator::generate_deopt_entry_for(TosState state,

                                                               int step,

                                                               address continuation) {

  address entry = __ pc();

  __ restore_bcp();

  __ restore_locals();

  __ restore_constant_pool_cache();

  __ get_method(rmethod);

  __ get_dispatch();

  // Calculate stack limit

  __ ldr(rscratch1, Address(rmethod, Method::const_offset()));

  __ ldrh(rscratch1, Address(rscratch1, ConstMethod::max_stack_offset()));

  __ add(rscratch1, rscratch1, frame::interpreter_frame_monitor_size() + 2);

  __ ldr(rscratch2,

         Address(rfp, frame::interpreter_frame_initial_sp_offset * wordSize));

  __ sub(rscratch1, rscratch2, rscratch1, ext::uxtx, 3);

  __ andr(sp, rscratch1, -16);

  // Restore expression stack pointer

  __ ldr(esp, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));

  // NULL last_sp until next java call

  __ str(zr, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));

#if INCLUDE_JVMCI

  // Check if we need to take lock at entry of synchronized method.  This can

  // only occur on method entry so emit it only for vtos with step 0.

  if ((EnableJVMCI || UseAOT) && state == vtos && step == 0) {

    Label L;

    __ ldrb(rscratch1, Address(rthread, JavaThread::pending_monitorenter_offset()));