/*

 * Copyright (c) 1997, 2015, 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 "code/codeCacheExtensions.hpp"

#include "interpreter/interpreter.hpp"

#include "interpreter/interpreterGenerator.hpp"

#include "interpreter/interpreterRuntime.hpp"

#include "interpreter/interp_masm.hpp"

#include "interpreter/templateInterpreter.hpp"

#include "interpreter/templateTable.hpp"

#ifndef CC_INTERP

# define __ _masm->

void TemplateInterpreter::initialize() {

  if (_code != NULL) return;

  // assertions

  assert((int)Bytecodes::number_of_codes <= (int)DispatchTable::length,

         "dispatch table too small");

  AbstractInterpreter::initialize();

  TemplateTable::initialize();

  // generate interpreter

  { ResourceMark rm;

    TraceTime timer("Interpreter generation", TraceStartupTime);

    int code_size = InterpreterCodeSize;

    NOT_PRODUCT(code_size *= 4;)  // debug uses extra interpreter code space

#if INCLUDE_JVMTI

    if (CodeCacheExtensions::saving_generated_interpreter()) {

      // May requires several versions of the codelets.

      // Final size will automatically be optimized.

      code_size *= 2;

    }

#endif

    _code = new StubQueue(new InterpreterCodeletInterface, code_size, NULL,

                          "Interpreter");

    InterpreterGenerator g(_code);

  }

  if (PrintInterpreter) {

    if (CodeCacheExtensions::saving_generated_interpreter() &&

        CodeCacheExtensions::use_pregenerated_interpreter()) {

      ResourceMark rm;

      tty->print("Printing the newly generated interpreter first");

      print();

      tty->print("Printing the pregenerated interpreter next");

    }

  }

  // Install the pregenerated interpreter code before printing it

  CodeCacheExtensions::complete_step(CodeCacheExtensionsSteps::TemplateInterpreter);

  if (PrintInterpreter) {

    ResourceMark rm;

    print();

  }

  // initialize dispatch table

  _active_table = _normal_table;

}

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

// Implementation of EntryPoint

EntryPoint::EntryPoint() {

  assert(number_of_states == 9, "check the code below");

  _entry[btos] = NULL;

  _entry[ctos] = NULL;

  _entry[stos] = NULL;

  _entry[atos] = NULL;

  _entry[itos] = NULL;

  _entry[ltos] = NULL;

  _entry[ftos] = NULL;

  _entry[dtos] = NULL;

  _entry[vtos] = NULL;

}

EntryPoint::EntryPoint(address bentry, address centry, address sentry, address aentry, address ientry, address lentry, address fentry, address dentry, address ventry) {

  assert(number_of_states == 9, "check the code below");

  _entry[btos] = bentry;

  _entry[ctos] = centry;

  _entry[stos] = sentry;

  _entry[atos] = aentry;

  _entry[itos] = ientry;

  _entry[ltos] = lentry;

  _entry[ftos] = fentry;

  _entry[dtos] = dentry;

  _entry[vtos] = ventry;

}

void EntryPoint::set_entry(TosState state, address entry) {

  assert(0 <= state && state < number_of_states, "state out of bounds");

  _entry[state] = entry;

}

address EntryPoint::entry(TosState state) const {

  assert(0 <= state && state < number_of_states, "state out of bounds");

  return _entry[state];

}

void EntryPoint::print() {

  tty->print("[");

  for (int i = 0; i < number_of_states; i++) {

    if (i > 0) tty->print(", ");

    tty->print(INTPTR_FORMAT, p2i(_entry[i]));

  }

  tty->print("]");

}

bool EntryPoint::operator == (const EntryPoint& y) {

  int i = number_of_states;

  while (i-- > 0) {

    if (_entry[i] != y._entry[i]) return false;

  }

  return true;

}

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

// Implementation of DispatchTable

EntryPoint DispatchTable::entry(int i) const {

  assert(0 <= i && i < length, "index out of bounds");

  return

    EntryPoint(

      _table[btos][i],

      _table[ctos][i],

      _table[stos][i],

      _table[atos][i],

      _table[itos][i],

      _table[ltos][i],

      _table[ftos][i],

      _table[dtos][i],

      _table[vtos][i]

    );

}

void DispatchTable::set_entry(int i, EntryPoint& entry) {

  assert(0 <= i && i < length, "index out of bounds");

  assert(number_of_states == 9, "check the code below");

  _table[btos][i] = entry.entry(btos);

  _table[ctos][i] = entry.entry(ctos);

  _table[stos][i] = entry.entry(stos);

  _table[atos][i] = entry.entry(atos);

  _table[itos][i] = entry.entry(itos);

  _table[ltos][i] = entry.entry(ltos);

  _table[ftos][i] = entry.entry(ftos);

  _table[dtos][i] = entry.entry(dtos);

  _table[vtos][i] = entry.entry(vtos);

}

bool DispatchTable::operator == (DispatchTable& y) {

  int i = length;

  while (i-- > 0) {

    EntryPoint t = y.entry(i); // for compiler compatibility (BugId 4150096)

    if (!(entry(i) == t)) return false;

  }

  return true;

}

address    TemplateInterpreter::_remove_activation_entry                    = NULL;

address    TemplateInterpreter::_remove_activation_preserving_args_entry    = NULL;

address    TemplateInterpreter::_throw_ArrayIndexOutOfBoundsException_entry = NULL;

address    TemplateInterpreter::_throw_ArrayStoreException_entry            = NULL;

address    TemplateInterpreter::_throw_ArithmeticException_entry            = NULL;

address    TemplateInterpreter::_throw_ClassCastException_entry             = NULL;

address    TemplateInterpreter::_throw_NullPointerException_entry           = NULL;

address    TemplateInterpreter::_throw_StackOverflowError_entry             = NULL;

address    TemplateInterpreter::_throw_exception_entry                      = NULL;

#ifndef PRODUCT

EntryPoint TemplateInterpreter::_trace_code;

#endif // !PRODUCT

EntryPoint TemplateInterpreter::_return_entry[TemplateInterpreter::number_of_return_entries];

EntryPoint TemplateInterpreter::_earlyret_entry;

EntryPoint TemplateInterpreter::_deopt_entry [TemplateInterpreter::number_of_deopt_entries ];

EntryPoint TemplateInterpreter::_continuation_entry;

EntryPoint TemplateInterpreter::_safept_entry;

address TemplateInterpreter::_invoke_return_entry[TemplateInterpreter::number_of_return_addrs];

address TemplateInterpreter::_invokeinterface_return_entry[TemplateInterpreter::number_of_return_addrs];

address TemplateInterpreter::_invokedynamic_return_entry[TemplateInterpreter::number_of_return_addrs];

DispatchTable TemplateInterpreter::_active_table;

DispatchTable TemplateInterpreter::_normal_table;

DispatchTable TemplateInterpreter::_safept_table;

address    TemplateInterpreter::_wentry_point[DispatchTable::length];

TemplateInterpreterGenerator::TemplateInterpreterGenerator(StubQueue* _code): AbstractInterpreterGenerator(_code) {

  _unimplemented_bytecode    = NULL;

  _illegal_bytecode_sequence = NULL;

}

static const BasicType types[Interpreter::number_of_result_handlers] = {

  T_BOOLEAN,

  T_CHAR   ,

  T_BYTE   ,

  T_SHORT  ,

  T_INT    ,

  T_LONG   ,

  T_VOID   ,

  T_FLOAT  ,

  T_DOUBLE ,

  T_OBJECT

};

void TemplateInterpreterGenerator::generate_all() {

  // Loop, in case we need several variants of the interpreter entries

  do {

    if (!CodeCacheExtensions::skip_code_generation()) {

      // bypass code generation when useless

      AbstractInterpreterGenerator::generate_all();

      { CodeletMark cm(_masm, "error exits");

        _unimplemented_bytecode    = generate_error_exit("unimplemented bytecode");

        _illegal_bytecode_sequence = generate_error_exit("illegal bytecode sequence - method not verified");

      }

#ifndef PRODUCT

      if (TraceBytecodes) {

        CodeletMark cm(_masm, "bytecode tracing support");

        Interpreter::_trace_code =

          EntryPoint(

                     generate_trace_code(btos),

                     generate_trace_code(ctos),

                     generate_trace_code(stos),

                     generate_trace_code(atos),

                     generate_trace_code(itos),

                     generate_trace_code(ltos),

                     generate_trace_code(ftos),

                     generate_trace_code(dtos),

                     generate_trace_code(vtos)

                     );

      }

#endif // !PRODUCT

      { CodeletMark cm(_masm, "return entry points");

        const int index_size = sizeof(u2);

        for (int i = 0; i < Interpreter::number_of_return_entries; i++) {

          Interpreter::_return_entry[i] =

            EntryPoint(

                       generate_return_entry_for(itos, i, index_size),

                       generate_return_entry_for(itos, i, index_size),

                       generate_return_entry_for(itos, i, index_size),

                       generate_return_entry_for(atos, i, index_size),

                       generate_return_entry_for(itos, i, index_size),

                       generate_return_entry_for(ltos, i, index_size),

                       generate_return_entry_for(ftos, i, index_size),

                       generate_return_entry_for(dtos, i, index_size),

                       generate_return_entry_for(vtos, i, index_size)

                       );

        }

      }

      { CodeletMark cm(_masm, "invoke return entry points");

        const TosState states[] = {itos, itos, itos, itos, ltos, ftos, dtos, atos, vtos};

        const int invoke_length = Bytecodes::length_for(Bytecodes::_invokestatic);

        const int invokeinterface_length = Bytecodes::length_for(Bytecodes::_invokeinterface);

        const int invokedynamic_length = Bytecodes::length_for(Bytecodes::_invokedynamic);

        for (int i = 0; i < Interpreter::number_of_return_addrs; i++) {

          TosState state = states[i];

          Interpreter::_invoke_return_entry[i] = generate_return_entry_for(state, invoke_length, sizeof(u2));

          Interpreter::_invokeinterface_return_entry[i] = generate_return_entry_for(state, invokeinterface_length, sizeof(u2));

          Interpreter::_invokedynamic_return_entry[i] = generate_return_entry_for(state, invokedynamic_length, sizeof(u4));

        }

      }

      { CodeletMark cm(_masm, "earlyret entry points");

        Interpreter::_earlyret_entry =

          EntryPoint(

                     generate_earlyret_entry_for(btos),

                     generate_earlyret_entry_for(ctos),

                     generate_earlyret_entry_for(stos),

                     generate_earlyret_entry_for(atos),

                     generate_earlyret_entry_for(itos),

                     generate_earlyret_entry_for(ltos),

                     generate_earlyret_entry_for(ftos),

                     generate_earlyret_entry_for(dtos),

                     generate_earlyret_entry_for(vtos)

                     );

      }

      { CodeletMark cm(_masm, "deoptimization entry points");

        for (int i = 0; i < Interpreter::number_of_deopt_entries; i++) {

          Interpreter::_deopt_entry[i] =

            EntryPoint(

                       generate_deopt_entry_for(itos, i),

                       generate_deopt_entry_for(itos, i),

                       generate_deopt_entry_for(itos, i),

                       generate_deopt_entry_for(atos, i),

                       generate_deopt_entry_for(itos, i),

                       generate_deopt_entry_for(ltos, i),

                       generate_deopt_entry_for(ftos, i),

                       generate_deopt_entry_for(dtos, i),

                       generate_deopt_entry_for(vtos, i)

                       );

        }

      }

      { CodeletMark cm(_masm, "result handlers for native calls");

        // The various result converter stublets.

        int is_generated[Interpreter::number_of_result_handlers];

        memset(is_generated, 0, sizeof(is_generated));

        for (int i = 0; i < Interpreter::number_of_result_handlers; i++) {

          BasicType type = types[i];

          if (!is_generated[Interpreter::BasicType_as_index(type)]++) {

            Interpreter::_native_abi_to_tosca[Interpreter::BasicType_as_index(type)] = generate_result_handler_for(type);

          }

        }

      }

      { CodeletMark cm(_masm, "continuation entry points");

        Interpreter::_continuation_entry =

          EntryPoint(

                     generate_continuation_for(btos),

                     generate_continuation_for(ctos),

                     generate_continuation_for(stos),

                     generate_continuation_for(atos),

                     generate_continuation_for(itos),

                     generate_continuation_for(ltos),

                     generate_continuation_for(ftos),

                     generate_continuation_for(dtos),

                     generate_continuation_for(vtos)

                     );

      }

      { CodeletMark cm(_masm, "safepoint entry points");

        Interpreter::_safept_entry =

          EntryPoint(

                     generate_safept_entry_for(btos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),

                     generate_safept_entry_for(ctos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),

                     generate_safept_entry_for(stos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),

                     generate_safept_entry_for(atos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),

                     generate_safept_entry_for(itos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),

                     generate_safept_entry_for(ltos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),

                     generate_safept_entry_for(ftos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),

                     generate_safept_entry_for(dtos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),

                     generate_safept_entry_for(vtos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint))

                     );

      }

      { CodeletMark cm(_masm, "exception handling");

        // (Note: this is not safepoint safe because thread may return to compiled code)

        generate_throw_exception();

      }

      { CodeletMark cm(_masm, "throw exception entrypoints");

        Interpreter::_throw_ArrayIndexOutOfBoundsException_entry = generate_ArrayIndexOutOfBounds_handler("java/lang/ArrayIndexOutOfBoundsException");

        Interpreter::_throw_ArrayStoreException_entry            = generate_klass_exception_handler("java/lang/ArrayStoreException"                 );

        Interpreter::_throw_ArithmeticException_entry            = generate_exception_handler("java/lang/ArithmeticException"           , "/ by zero");

        Interpreter::_throw_ClassCastException_entry             = generate_ClassCastException_handler();

        Interpreter::_throw_NullPointerException_entry           = generate_exception_handler("java/lang/NullPointerException"          , NULL       );

        Interpreter::_throw_StackOverflowError_entry             = generate_StackOverflowError_handler();

      }

#define method_entry(kind)                                              \

      { CodeletMark cm(_masm, "method entry point (kind = " #kind ")"); \

        Interpreter::_entry_table[Interpreter::kind] = ((InterpreterGenerator*)this)->generate_method_entry(Interpreter::kind); \

      }

      // all non-native method kinds

      method_entry(zerolocals)

      initialize_method_handle_entries();

      // all native method kinds (must be one contiguous block)

      Interpreter::_native_entry_begin = Interpreter::code()->code_end();

      method_entry(native)

#undef method_entry

      // Bytecodes

      set_entry_points_for_all_bytes();

    }

  } while (CodeCacheExtensions::needs_other_interpreter_variant());

  // installation of code in other places in the runtime

  // (ExcutableCodeManager calls not needed to copy the entries)

  set_safepoints_for_all_bytes();

}

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

address TemplateInterpreterGenerator::generate_error_exit(const char* msg) {

  address entry = __ pc();

  __ stop(msg);

  return entry;

}

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

void TemplateInterpreterGenerator::set_entry_points_for_all_bytes() {

  for (int i = 0; i < DispatchTable::length; i++) {

    Bytecodes::Code code = (Bytecodes::Code)i;

    if (Bytecodes::is_defined(code)) {

      set_entry_points(code);

    } else {

      set_unimplemented(i);

    }

  }

}

void TemplateInterpreterGenerator::set_safepoints_for_all_bytes() {

  for (int i = 0; i < DispatchTable::length; i++) {

    Bytecodes::Code code = (Bytecodes::Code)i;

    if (Bytecodes::is_defined(code)) Interpreter::_safept_table.set_entry(code, Interpreter::_safept_entry);

  }

}

void TemplateInterpreterGenerator::set_unimplemented(int i) {

  address e = _unimplemented_bytecode;

  EntryPoint entry(e, e, e, e, e, e, e, e, e);

  Interpreter::_normal_table.set_entry(i, entry);

  Interpreter::_wentry_point[i] = _unimplemented_bytecode;

}

void TemplateInterpreterGenerator::set_entry_points(Bytecodes::Code code) {

  if (CodeCacheExtensions::skip_template_interpreter_entries(code)) {

    return;

  }

  CodeletMark cm(_masm, Bytecodes::name(code), code);

  // initialize entry points

  assert(_unimplemented_bytecode    != NULL, "should have been generated before");

  assert(_illegal_bytecode_sequence != NULL, "should have been generated before");

  address bep = _illegal_bytecode_sequence;

  address cep = _illegal_bytecode_sequence;

  address sep = _illegal_bytecode_sequence;

  address aep = _illegal_bytecode_sequence;

  address iep = _illegal_bytecode_sequence;

  address lep = _illegal_bytecode_sequence;

  address fep = _illegal_bytecode_sequence;

  address dep = _illegal_bytecode_sequence;

  address vep = _unimplemented_bytecode;

  address wep = _unimplemented_bytecode;

  // code for short & wide version of bytecode

  if (Bytecodes::is_defined(code)) {

    Template* t = TemplateTable::template_for(code);

    assert(t->is_valid(), "just checking");

    set_short_entry_points(t, bep, cep, sep, aep, iep, lep, fep, dep, vep);

  }

  if (Bytecodes::wide_is_defined(code)) {