1 /*
   2  * Copyright (c) 1997, 2017, 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 "precompiled.hpp"
  26 #include "interpreter/interpreter.hpp"
  27 #include "interpreter/interpreterRuntime.hpp"
  28 #include "interpreter/interp_masm.hpp"
  29 #include "interpreter/templateInterpreter.hpp"
  30 #include "interpreter/templateInterpreterGenerator.hpp"
  31 #include "interpreter/templateTable.hpp"
  32 
  33 #ifndef CC_INTERP
  34 
  35 # define __ _masm->
  36 
  37 TemplateInterpreterGenerator::TemplateInterpreterGenerator(StubQueue* _code): AbstractInterpreterGenerator(_code) {
  38   _unimplemented_bytecode    = NULL;
  39   _illegal_bytecode_sequence = NULL;
  40   generate_all();
  41 }
  42 
  43 static const BasicType types[Interpreter::number_of_result_handlers] = {
  44   T_BOOLEAN,
  45   T_CHAR   ,
  46   T_BYTE   ,
  47   T_SHORT  ,
  48   T_INT    ,
  49   T_LONG   ,
  50   T_VOID   ,
  51   T_FLOAT  ,
  52   T_DOUBLE ,
  53   T_OBJECT
  54 };
  55 
  56 void TemplateInterpreterGenerator::generate_all() {
  57   { CodeletMark cm(_masm, "slow signature handler");
  58     AbstractInterpreter::_slow_signature_handler = generate_slow_signature_handler();
  59   }
  60 
  61   { CodeletMark cm(_masm, "error exits");
  62     _unimplemented_bytecode    = generate_error_exit("unimplemented bytecode");
  63     _illegal_bytecode_sequence = generate_error_exit("illegal bytecode sequence - method not verified");
  64   }
  65 
  66 #ifndef PRODUCT
  67   if (TraceBytecodes) {
  68     CodeletMark cm(_masm, "bytecode tracing support");
  69     Interpreter::_trace_code =
  70       EntryPoint(
  71                  generate_trace_code(btos),
  72                  generate_trace_code(ztos),
  73                  generate_trace_code(ctos),
  74                  generate_trace_code(stos),
  75                  generate_trace_code(atos),
  76                  generate_trace_code(itos),
  77                  generate_trace_code(ltos),
  78                  generate_trace_code(ftos),
  79                  generate_trace_code(dtos),
  80                  generate_trace_code(vtos)
  81                  );
  82   }
  83 #endif // !PRODUCT
  84 
  85   { CodeletMark cm(_masm, "return entry points");
  86     const int index_size = sizeof(u2);
  87     Interpreter::_return_entry[0] = EntryPoint();
  88     for (int i = 1; i < Interpreter::number_of_return_entries; i++) {
  89       address return_itos = generate_return_entry_for(itos, i, index_size);
  90       Interpreter::_return_entry[i] =
  91         EntryPoint(
  92                    return_itos,
  93                    return_itos,
  94                    return_itos,
  95                    return_itos,
  96                    generate_return_entry_for(atos, i, index_size),
  97                    return_itos,
  98                    generate_return_entry_for(ltos, i, index_size),
  99                    generate_return_entry_for(ftos, i, index_size),
 100                    generate_return_entry_for(dtos, i, index_size),
 101                    generate_return_entry_for(vtos, i, index_size)
 102                    );
 103     }
 104   }
 105 
 106   { CodeletMark cm(_masm, "invoke return entry points");
 107     // These states are in order specified in TosState, except btos/ztos/ctos/stos are
 108     // really the same as itos since there is no top of stack optimization for these types
 109     const TosState states[] = {itos, itos, itos, itos, itos, ltos, ftos, dtos, atos, vtos, ilgl};
 110     const int invoke_length = Bytecodes::length_for(Bytecodes::_invokestatic);
 111     const int invokeinterface_length = Bytecodes::length_for(Bytecodes::_invokeinterface);
 112     const int invokedynamic_length = Bytecodes::length_for(Bytecodes::_invokedynamic);
 113 
 114     for (int i = 0; i < Interpreter::number_of_return_addrs; i++) {
 115       TosState state = states[i];
 116       assert(state != ilgl, "states array is wrong above");
 117       Interpreter::_invoke_return_entry[i] = generate_return_entry_for(state, invoke_length, sizeof(u2));
 118       Interpreter::_invokeinterface_return_entry[i] = generate_return_entry_for(state, invokeinterface_length, sizeof(u2));
 119       Interpreter::_invokedynamic_return_entry[i] = generate_return_entry_for(state, invokedynamic_length, sizeof(u4));
 120     }
 121   }
 122 
 123   { CodeletMark cm(_masm, "earlyret entry points");
 124     Interpreter::_earlyret_entry =
 125       EntryPoint(
 126                  generate_earlyret_entry_for(btos),
 127                  generate_earlyret_entry_for(ztos),
 128                  generate_earlyret_entry_for(ctos),
 129                  generate_earlyret_entry_for(stos),
 130                  generate_earlyret_entry_for(atos),
 131                  generate_earlyret_entry_for(itos),
 132                  generate_earlyret_entry_for(ltos),
 133                  generate_earlyret_entry_for(ftos),
 134                  generate_earlyret_entry_for(dtos),
 135                  generate_earlyret_entry_for(vtos)
 136                  );
 137   }
 138 
 139   { CodeletMark cm(_masm, "result handlers for native calls");
 140     // The various result converter stublets.
 141     int is_generated[Interpreter::number_of_result_handlers];
 142     memset(is_generated, 0, sizeof(is_generated));
 143 
 144     for (int i = 0; i < Interpreter::number_of_result_handlers; i++) {
 145       BasicType type = types[i];
 146       if (!is_generated[Interpreter::BasicType_as_index(type)]++) {
 147         Interpreter::_native_abi_to_tosca[Interpreter::BasicType_as_index(type)] = generate_result_handler_for(type);
 148       }
 149     }
 150   }
 151 
 152 
 153   { CodeletMark cm(_masm, "safepoint entry points");
 154     Interpreter::_safept_entry =
 155       EntryPoint(
 156                  generate_safept_entry_for(btos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
 157                  generate_safept_entry_for(ztos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
 158                  generate_safept_entry_for(ctos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
 159                  generate_safept_entry_for(stos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
 160                  generate_safept_entry_for(atos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
 161                  generate_safept_entry_for(itos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
 162                  generate_safept_entry_for(ltos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
 163                  generate_safept_entry_for(ftos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
 164                  generate_safept_entry_for(dtos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
 165                  generate_safept_entry_for(vtos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint))
 166                  );
 167   }
 168 
 169   { CodeletMark cm(_masm, "exception handling");
 170     // (Note: this is not safepoint safe because thread may return to compiled code)
 171     generate_throw_exception();
 172   }
 173 
 174   { CodeletMark cm(_masm, "throw exception entrypoints");
 175     Interpreter::_throw_ArrayIndexOutOfBoundsException_entry = generate_ArrayIndexOutOfBounds_handler("java/lang/ArrayIndexOutOfBoundsException");
 176     Interpreter::_throw_ArrayStoreException_entry            = generate_klass_exception_handler("java/lang/ArrayStoreException"                 );
 177     Interpreter::_throw_ArithmeticException_entry            = generate_exception_handler("java/lang/ArithmeticException"           , "/ by zero");
 178     Interpreter::_throw_ClassCastException_entry             = generate_ClassCastException_handler();
 179     Interpreter::_throw_NullPointerException_entry           = generate_exception_handler("java/lang/NullPointerException"          , NULL       );
 180     Interpreter::_throw_StackOverflowError_entry             = generate_StackOverflowError_handler();
 181   }
 182 
 183 
 184 
 185 #define method_entry(kind)                                              \
 186   { CodeletMark cm(_masm, "method entry point (kind = " #kind ")"); \
 187     Interpreter::_entry_table[Interpreter::kind] = generate_method_entry(Interpreter::kind); \
 188     Interpreter::update_cds_entry_table(Interpreter::kind); \
 189   }
 190 
 191   // all non-native method kinds
 192   method_entry(zerolocals)
 193   method_entry(zerolocals_synchronized)
 194   method_entry(empty)
 195   method_entry(accessor)
 196   method_entry(abstract)
 197   method_entry(java_lang_math_sin  )
 198   method_entry(java_lang_math_cos  )
 199   method_entry(java_lang_math_tan  )
 200   method_entry(java_lang_math_abs  )
 201   method_entry(java_lang_math_sqrt )
 202   method_entry(java_lang_math_log  )
 203   method_entry(java_lang_math_log10)
 204   method_entry(java_lang_math_exp  )
 205   method_entry(java_lang_math_pow  )
 206   method_entry(java_lang_math_fmaF )
 207   method_entry(java_lang_math_fmaD )
 208   method_entry(java_lang_ref_reference_get)
 209 
 210   AbstractInterpreter::initialize_method_handle_entries();
 211 
 212   // all native method kinds (must be one contiguous block)
 213   Interpreter::_native_entry_begin = Interpreter::code()->code_end();
 214   method_entry(native)
 215   method_entry(native_synchronized)
 216   Interpreter::_native_entry_end = Interpreter::code()->code_end();
 217 
 218   method_entry(java_util_zip_CRC32_update)
 219   method_entry(java_util_zip_CRC32_updateBytes)
 220   method_entry(java_util_zip_CRC32_updateByteBuffer)
 221   method_entry(java_util_zip_CRC32C_updateBytes)
 222   method_entry(java_util_zip_CRC32C_updateDirectByteBuffer)
 223 
 224   method_entry(java_lang_Float_intBitsToFloat);
 225   method_entry(java_lang_Float_floatToRawIntBits);
 226   method_entry(java_lang_Double_longBitsToDouble);
 227   method_entry(java_lang_Double_doubleToRawLongBits);
 228 
 229 #undef method_entry
 230 
 231   // Bytecodes
 232   set_entry_points_for_all_bytes();
 233 
 234   // installation of code in other places in the runtime
 235   // (ExcutableCodeManager calls not needed to copy the entries)
 236   set_safepoints_for_all_bytes();
 237 
 238   { CodeletMark cm(_masm, "deoptimization entry points");
 239     Interpreter::_deopt_entry[0] = EntryPoint();
 240     Interpreter::_deopt_entry[0].set_entry(vtos, generate_deopt_entry_for(vtos, 0));
 241     for (int i = 1; i < Interpreter::number_of_deopt_entries; i++) {
 242       address deopt_itos = generate_deopt_entry_for(itos, i);
 243       Interpreter::_deopt_entry[i] =
 244         EntryPoint(
 245                    deopt_itos, /* btos */
 246                    deopt_itos, /* ztos */
 247                    deopt_itos, /* ctos */
 248                    deopt_itos, /* stos */
 249                    generate_deopt_entry_for(atos, i),
 250                    deopt_itos, /* itos */
 251                    generate_deopt_entry_for(ltos, i),
 252                    generate_deopt_entry_for(ftos, i),
 253                    generate_deopt_entry_for(dtos, i),
 254                    generate_deopt_entry_for(vtos, i)
 255                    );
 256     }
 257     address return_continuation = Interpreter::_normal_table.entry(Bytecodes::_return).entry(vtos);
 258     vmassert(return_continuation != NULL, "return entry not generated yet");
 259     Interpreter::_deopt_reexecute_return_entry = generate_deopt_entry_for(vtos, 0, return_continuation);
 260   }
 261 
 262 }
 263 
 264 //------------------------------------------------------------------------------------------------------------------------
 265 
 266 address TemplateInterpreterGenerator::generate_error_exit(const char* msg) {
 267   address entry = __ pc();
 268   __ stop(msg);
 269   return entry;
 270 }
 271 
 272 
 273 //------------------------------------------------------------------------------------------------------------------------
 274 
 275 void TemplateInterpreterGenerator::set_entry_points_for_all_bytes() {
 276   for (int i = 0; i < DispatchTable::length; i++) {
 277     Bytecodes::Code code = (Bytecodes::Code)i;
 278     if (Bytecodes::is_defined(code)) {
 279       set_entry_points(code);
 280     } else {
 281       set_unimplemented(i);
 282     }
 283   }
 284 }
 285 
 286 
 287 void TemplateInterpreterGenerator::set_safepoints_for_all_bytes() {
 288   for (int i = 0; i < DispatchTable::length; i++) {
 289     Bytecodes::Code code = (Bytecodes::Code)i;
 290     if (Bytecodes::is_defined(code)) Interpreter::_safept_table.set_entry(code, Interpreter::_safept_entry);
 291   }
 292 }
 293 
 294 
 295 void TemplateInterpreterGenerator::set_unimplemented(int i) {
 296   address e = _unimplemented_bytecode;
 297   EntryPoint entry(e, e, e, e, e, e, e, e, e, e);
 298   Interpreter::_normal_table.set_entry(i, entry);
 299   Interpreter::_wentry_point[i] = _unimplemented_bytecode;
 300 }
 301 
 302 
 303 void TemplateInterpreterGenerator::set_entry_points(Bytecodes::Code code) {
 304   CodeletMark cm(_masm, Bytecodes::name(code), code);
 305   // initialize entry points
 306   assert(_unimplemented_bytecode    != NULL, "should have been generated before");
 307   assert(_illegal_bytecode_sequence != NULL, "should have been generated before");
 308   address bep = _illegal_bytecode_sequence;
 309   address zep = _illegal_bytecode_sequence;
 310   address cep = _illegal_bytecode_sequence;
 311   address sep = _illegal_bytecode_sequence;
 312   address aep = _illegal_bytecode_sequence;
 313   address iep = _illegal_bytecode_sequence;
 314   address lep = _illegal_bytecode_sequence;
 315   address fep = _illegal_bytecode_sequence;
 316   address dep = _illegal_bytecode_sequence;
 317   address vep = _unimplemented_bytecode;
 318   address wep = _unimplemented_bytecode;
 319   // code for short & wide version of bytecode
 320   if (Bytecodes::is_defined(code)) {
 321     Template* t = TemplateTable::template_for(code);
 322     assert(t->is_valid(), "just checking");
 323     set_short_entry_points(t, bep, cep, sep, aep, iep, lep, fep, dep, vep);
 324   }
 325   if (Bytecodes::wide_is_defined(code)) {
 326     Template* t = TemplateTable::template_for_wide(code);
 327     assert(t->is_valid(), "just checking");
 328     set_wide_entry_point(t, wep);
 329   }
 330   // set entry points
 331   EntryPoint entry(bep, zep, cep, sep, aep, iep, lep, fep, dep, vep);
 332   Interpreter::_normal_table.set_entry(code, entry);
 333   Interpreter::_wentry_point[code] = wep;
 334 }
 335 
 336 
 337 void TemplateInterpreterGenerator::set_wide_entry_point(Template* t, address& wep) {
 338   assert(t->is_valid(), "template must exist");
 339   assert(t->tos_in() == vtos, "only vtos tos_in supported for wide instructions");
 340   wep = __ pc(); generate_and_dispatch(t);
 341 }
 342 
 343 
 344 void TemplateInterpreterGenerator::set_short_entry_points(Template* t, address& bep, address& cep, address& sep, address& aep, address& iep, address& lep, address& fep, address& dep, address& vep) {
 345   assert(t->is_valid(), "template must exist");
 346   switch (t->tos_in()) {
 347     case btos:
 348     case ztos:
 349     case ctos:
 350     case stos:
 351       ShouldNotReachHere();  // btos/ctos/stos should use itos.
 352       break;
 353     case atos: vep = __ pc(); __ pop(atos); aep = __ pc(); generate_and_dispatch(t); break;
 354     case itos: vep = __ pc(); __ pop(itos); iep = __ pc(); generate_and_dispatch(t); break;
 355     case ltos: vep = __ pc(); __ pop(ltos); lep = __ pc(); generate_and_dispatch(t); break;
 356     case ftos: vep = __ pc(); __ pop(ftos); fep = __ pc(); generate_and_dispatch(t); break;
 357     case dtos: vep = __ pc(); __ pop(dtos); dep = __ pc(); generate_and_dispatch(t); break;
 358     case vtos: set_vtos_entry_points(t, bep, cep, sep, aep, iep, lep, fep, dep, vep);     break;
 359     default  : ShouldNotReachHere();                                                 break;
 360   }
 361 }
 362 
 363 
 364 //------------------------------------------------------------------------------------------------------------------------
 365 
 366 void TemplateInterpreterGenerator::generate_and_dispatch(Template* t, TosState tos_out) {
 367   if (PrintBytecodeHistogram)                                    histogram_bytecode(t);
 368 #ifndef PRODUCT
 369   // debugging code
 370   if (CountBytecodes || TraceBytecodes || StopInterpreterAt > 0) count_bytecode();
 371   if (PrintBytecodePairHistogram)                                histogram_bytecode_pair(t);
 372   if (TraceBytecodes)                                            trace_bytecode(t);
 373   if (StopInterpreterAt > 0)                                     stop_interpreter_at();
 374   __ verify_FPU(1, t->tos_in());
 375 #endif // !PRODUCT
 376   int step = 0;
 377   if (!t->does_dispatch()) {
 378     step = t->is_wide() ? Bytecodes::wide_length_for(t->bytecode()) : Bytecodes::length_for(t->bytecode());
 379     if (tos_out == ilgl) tos_out = t->tos_out();
 380     // compute bytecode size
 381     assert(step > 0, "just checkin'");
 382     // setup stuff for dispatching next bytecode
 383     if (ProfileInterpreter && VerifyDataPointer
 384         && MethodData::bytecode_has_profile(t->bytecode())) {
 385       __ verify_method_data_pointer();
 386     }
 387     __ dispatch_prolog(tos_out, step);
 388   }
 389   // generate template
 390   t->generate(_masm);
 391   // advance
 392   if (t->does_dispatch()) {
 393 #ifdef ASSERT
 394     // make sure execution doesn't go beyond this point if code is broken
 395     __ should_not_reach_here();
 396 #endif // ASSERT
 397   } else {
 398     // dispatch to next bytecode
 399     __ dispatch_epilog(tos_out, step);
 400   }
 401 }
 402 
 403 // Generate method entries
 404 address TemplateInterpreterGenerator::generate_method_entry(
 405                                         AbstractInterpreter::MethodKind kind) {
 406   // determine code generation flags
 407   bool native = false;
 408   bool synchronized = false;
 409   address entry_point = NULL;
 410 
 411   switch (kind) {
 412   case Interpreter::zerolocals             :                                          break;
 413   case Interpreter::zerolocals_synchronized:                synchronized = true;      break;
 414   case Interpreter::native                 : native = true;                           break;
 415   case Interpreter::native_synchronized    : native = true; synchronized = true;      break;
 416   case Interpreter::empty                  : break;
 417   case Interpreter::accessor               : break;
 418   case Interpreter::abstract               : entry_point = generate_abstract_entry(); break;
 419 
 420   case Interpreter::java_lang_math_sin     : // fall thru
 421   case Interpreter::java_lang_math_cos     : // fall thru
 422   case Interpreter::java_lang_math_tan     : // fall thru
 423   case Interpreter::java_lang_math_abs     : // fall thru
 424   case Interpreter::java_lang_math_log     : // fall thru
 425   case Interpreter::java_lang_math_log10   : // fall thru
 426   case Interpreter::java_lang_math_sqrt    : // fall thru
 427   case Interpreter::java_lang_math_pow     : // fall thru
 428   case Interpreter::java_lang_math_exp     : // fall thru
 429   case Interpreter::java_lang_math_fmaD    : // fall thru
 430   case Interpreter::java_lang_math_fmaF    : entry_point = generate_math_entry(kind);      break;
 431   case Interpreter::java_lang_ref_reference_get
 432                                            : entry_point = generate_Reference_get_entry(); break;
 433   case Interpreter::java_util_zip_CRC32_update
 434                                            : native = true; entry_point = generate_CRC32_update_entry();  break;
 435   case Interpreter::java_util_zip_CRC32_updateBytes
 436                                            : // fall thru
 437   case Interpreter::java_util_zip_CRC32_updateByteBuffer
 438                                            : native = true; entry_point = generate_CRC32_updateBytes_entry(kind); break;
 439   case Interpreter::java_util_zip_CRC32C_updateBytes
 440                                            : // fall thru
 441   case Interpreter::java_util_zip_CRC32C_updateDirectByteBuffer
 442                                            : entry_point = generate_CRC32C_updateBytes_entry(kind); break;
 443 #ifdef IA32
 444   // On x86_32 platforms, a special entry is generated for the following four methods.
 445   // On other platforms the normal entry is used to enter these methods.
 446   case Interpreter::java_lang_Float_intBitsToFloat
 447                                            : native = true; entry_point = generate_Float_intBitsToFloat_entry(); break;
 448   case Interpreter::java_lang_Float_floatToRawIntBits
 449                                            : native = true; entry_point = generate_Float_floatToRawIntBits_entry(); break;
 450   case Interpreter::java_lang_Double_longBitsToDouble
 451                                            : native = true; entry_point = generate_Double_longBitsToDouble_entry(); break;
 452   case Interpreter::java_lang_Double_doubleToRawLongBits
 453                                            : native = true; entry_point = generate_Double_doubleToRawLongBits_entry(); break;
 454 #else
 455   case Interpreter::java_lang_Float_intBitsToFloat:
 456   case Interpreter::java_lang_Float_floatToRawIntBits:
 457   case Interpreter::java_lang_Double_longBitsToDouble:
 458   case Interpreter::java_lang_Double_doubleToRawLongBits:
 459     native = true;
 460     break;
 461 #endif // !IA32
 462   default:
 463     fatal("unexpected method kind: %d", kind);
 464     break;
 465   }
 466 
 467   if (entry_point) {
 468     return entry_point;
 469   }
 470 
 471   // We expect the normal and native entry points to be generated first so we can reuse them.
 472   if (native) {
 473     entry_point = Interpreter::entry_for_kind(synchronized ? Interpreter::native_synchronized : Interpreter::native);
 474     if (entry_point == NULL) {
 475       entry_point = generate_native_entry(synchronized);
 476     }
 477   } else {
 478     entry_point = Interpreter::entry_for_kind(synchronized ? Interpreter::zerolocals_synchronized : Interpreter::zerolocals);
 479     if (entry_point == NULL) {
 480       entry_point = generate_normal_entry(synchronized);
 481     }
 482   }
 483 
 484   return entry_point;
 485 }
 486 #endif // !CC_INTERP