1 /*
   2  * Copyright (c) 1997, 2019, 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 "asm/macroAssembler.hpp"
  27 #include "asm/macroAssembler.inline.hpp"
  28 #include "compiler/disassembler.hpp"
  29 #include "interpreter/bytecodeHistogram.hpp"
  30 #include "interpreter/bytecodeInterpreter.hpp"
  31 #include "interpreter/bytecodeStream.hpp"
  32 #include "interpreter/interpreter.hpp"
  33 #include "interpreter/interpreterRuntime.hpp"
  34 #include "interpreter/interp_masm.hpp"
  35 #include "interpreter/templateTable.hpp"
  36 #include "memory/allocation.inline.hpp"
  37 #include "memory/metaspaceShared.hpp"
  38 #include "memory/resourceArea.hpp"
  39 #include "oops/arrayOop.hpp"
  40 #include "oops/constantPool.hpp"
  41 #include "oops/cpCache.inline.hpp"
  42 #include "oops/methodData.hpp"
  43 #include "oops/method.hpp"
  44 #include "oops/oop.inline.hpp"
  45 #include "prims/forte.hpp"
  46 #include "prims/jvmtiExport.hpp"
  47 #include "prims/methodHandles.hpp"
  48 #include "runtime/handles.inline.hpp"
  49 #include "runtime/sharedRuntime.hpp"
  50 #include "runtime/stubRoutines.hpp"
  51 #include "runtime/timer.hpp"
  52 
  53 # define __ _masm->
  54 
  55 //------------------------------------------------------------------------------------------------------------------------
  56 // Implementation of platform independent aspects of Interpreter
  57 
  58 void AbstractInterpreter::initialize() {
  59   if (_code != NULL) return;
  60 
  61   // make sure 'imported' classes are initialized
  62   if (CountBytecodes || TraceBytecodes || StopInterpreterAt) BytecodeCounter::reset();
  63   if (PrintBytecodeHistogram)                                BytecodeHistogram::reset();
  64   if (PrintBytecodePairHistogram)                            BytecodePairHistogram::reset();
  65 
  66   InvocationCounter::reinitialize();
  67 
  68 }
  69 
  70 void AbstractInterpreter::print() {
  71   tty->cr();
  72   tty->print_cr("----------------------------------------------------------------------");
  73   tty->print_cr("Interpreter");
  74   tty->cr();
  75   tty->print_cr("code size        = %6dK bytes", (int)_code->used_space()/1024);
  76   tty->print_cr("total space      = %6dK bytes", (int)_code->total_space()/1024);
  77   tty->print_cr("wasted space     = %6dK bytes", (int)_code->available_space()/1024);
  78   tty->cr();
  79   tty->print_cr("# of codelets    = %6d"      , _code->number_of_stubs());
  80   if (_code->number_of_stubs() != 0) {
  81     tty->print_cr("avg codelet size = %6d bytes", _code->used_space() / _code->number_of_stubs());
  82     tty->cr();
  83   }
  84   _code->print();
  85   tty->print_cr("----------------------------------------------------------------------");
  86   tty->cr();
  87 }
  88 
  89 
  90 //------------------------------------------------------------------------------------------------------------------------
  91 // Implementation of interpreter
  92 
  93 StubQueue* AbstractInterpreter::_code                                       = NULL;
  94 bool       AbstractInterpreter::_notice_safepoints                          = false;
  95 address    AbstractInterpreter::_rethrow_exception_entry                    = NULL;
  96 
  97 address    AbstractInterpreter::_native_entry_begin                         = NULL;
  98 address    AbstractInterpreter::_native_entry_end                           = NULL;
  99 address    AbstractInterpreter::_slow_signature_handler;
 100 address    AbstractInterpreter::_entry_table            [AbstractInterpreter::number_of_method_entries];
 101 address    AbstractInterpreter::_cds_entry_table        [AbstractInterpreter::number_of_method_entries];
 102 address    AbstractInterpreter::_native_abi_to_tosca    [AbstractInterpreter::number_of_result_handlers];
 103 
 104 //------------------------------------------------------------------------------------------------------------------------
 105 // Generation of complete interpreter
 106 
 107 AbstractInterpreterGenerator::AbstractInterpreterGenerator(StubQueue* _code) {
 108   _masm                      = NULL;
 109 }
 110 
 111 
 112 //------------------------------------------------------------------------------------------------------------------------
 113 // Entry points
 114 
 115 AbstractInterpreter::MethodKind AbstractInterpreter::method_kind(const methodHandle& m) {
 116   // Abstract method?
 117   if (m->is_abstract()) return abstract;
 118 
 119   // Method handle primitive?
 120   if (m->is_method_handle_intrinsic()) {
 121     vmIntrinsics::ID id = m->intrinsic_id();
 122     assert(MethodHandles::is_signature_polymorphic(id), "must match an intrinsic");
 123     MethodKind kind = (MethodKind)( method_handle_invoke_FIRST +
 124                                     ((int)id - vmIntrinsics::FIRST_MH_SIG_POLY) );
 125     assert(kind <= method_handle_invoke_LAST, "parallel enum ranges");
 126     return kind;
 127   }
 128 
 129 #ifndef CC_INTERP
 130   switch (m->intrinsic_id()) {
 131     // Use optimized stub code for CRC32 native methods.
 132     case vmIntrinsics::_updateCRC32            : return java_util_zip_CRC32_update;
 133     case vmIntrinsics::_updateBytesCRC32       : return java_util_zip_CRC32_updateBytes;
 134     case vmIntrinsics::_updateByteBufferCRC32  : return java_util_zip_CRC32_updateByteBuffer;
 135     // Use optimized stub code for CRC32C methods.
 136     case vmIntrinsics::_updateBytesCRC32C             : return java_util_zip_CRC32C_updateBytes;
 137     case vmIntrinsics::_updateDirectByteBufferCRC32C  : return java_util_zip_CRC32C_updateDirectByteBuffer;
 138     case vmIntrinsics::_intBitsToFloat:      return java_lang_Float_intBitsToFloat;
 139     case vmIntrinsics::_floatToRawIntBits:   return java_lang_Float_floatToRawIntBits;
 140     case vmIntrinsics::_longBitsToDouble:    return java_lang_Double_longBitsToDouble;
 141     case vmIntrinsics::_doubleToRawLongBits: return java_lang_Double_doubleToRawLongBits;
 142     default:                                 break;
 143   }
 144 #endif // CC_INTERP
 145 
 146   // Native method?
 147   // Note: This test must come _before_ the test for intrinsic
 148   //       methods. See also comments below.
 149   if (m->is_native()) {
 150     assert(!m->is_method_handle_intrinsic(), "overlapping bits here, watch out");
 151     return m->is_synchronized() ? native_synchronized : native;
 152   }
 153 
 154   // Synchronized?
 155   if (m->is_synchronized()) {
 156     return zerolocals_synchronized;
 157   }
 158 
 159   if (RegisterFinalizersAtInit && m->code_size() == 1 &&
 160       m->intrinsic_id() == vmIntrinsics::_Object_init) {
 161     // We need to execute the special return bytecode to check for
 162     // finalizer registration so create a normal frame.
 163     return zerolocals;
 164   }
 165 
 166   // Empty method?
 167   if (m->is_empty_method()) {
 168     return empty;
 169   }
 170 
 171   // Special intrinsic method?
 172   // Note: This test must come _after_ the test for native methods,
 173   //       otherwise we will run into problems with JDK 1.2, see also
 174   //       TemplateInterpreterGenerator::generate_method_entry() for
 175   //       for details.
 176   switch (m->intrinsic_id()) {
 177     case vmIntrinsics::_dsin  : return java_lang_math_sin  ;
 178     case vmIntrinsics::_dcos  : return java_lang_math_cos  ;
 179     case vmIntrinsics::_dtan  : return java_lang_math_tan  ;
 180     case vmIntrinsics::_dabs  : return java_lang_math_abs  ;
 181     case vmIntrinsics::_dsqrt : return java_lang_math_sqrt ;
 182     case vmIntrinsics::_dlog  : return java_lang_math_log  ;
 183     case vmIntrinsics::_dlog10: return java_lang_math_log10;
 184     case vmIntrinsics::_dpow  : return java_lang_math_pow  ;
 185     case vmIntrinsics::_dexp  : return java_lang_math_exp  ;
 186     case vmIntrinsics::_fmaD  : return java_lang_math_fmaD ;
 187     case vmIntrinsics::_fmaF  : return java_lang_math_fmaF ;
 188 
 189     case vmIntrinsics::_Reference_get
 190                               : return java_lang_ref_reference_get;
 191     case vmIntrinsics::_Continuation_getSP
 192                               : return java_lang_continuation_getSP;
 193     case vmIntrinsics::_Continuation_getFP
 194                               : return java_lang_continuation_getFP;
 195     case vmIntrinsics::_Continuation_getPC
 196                               : return java_lang_continuation_getPC;
 197     case vmIntrinsics::_Continuation_doContinue
 198                               : return java_lang_continuation_doContinue;
 199     case vmIntrinsics::_Continuation_doYield
 200                               : return java_lang_continuation_doYield;
 201     case vmIntrinsics::_Continuation_jump
 202                               : return java_lang_continuation_jump;
 203     case vmIntrinsics::_Continuation_runLevel
 204                               : return java_lang_continuation_runLevel;
 205     default                   : break;
 206   }
 207 
 208   // Accessor method?
 209   if (m->is_getter()) {
 210     // TODO: We should have used ::is_accessor above, but fast accessors in Zero expect only getters.
 211     // See CppInterpreter::accessor_entry in cppInterpreter_zero.cpp. This should be fixed in Zero,
 212     // then the call above updated to ::is_accessor
 213     assert(m->size_of_parameters() == 1, "fast code for accessors assumes parameter size = 1");
 214     return accessor;
 215   }
 216 
 217   // Symbol* kname = m->klass_name();
 218   // Symbol* name = m->name();
 219   // if (kname == vmSymbols::java_lang_Continuation()) {
 220   //   if (name == vmSymbols::enter_name()) {
 221   //     return java_lang_continuation_enter;
 222   //   }
 223   // }
 224 
 225   // Note: for now: zero locals for all non-empty methods
 226   return zerolocals;
 227 }
 228 
 229 #if INCLUDE_CDS
 230 
 231 address AbstractInterpreter::get_trampoline_code_buffer(AbstractInterpreter::MethodKind kind) {
 232   const size_t trampoline_size = SharedRuntime::trampoline_size();
 233   address addr = MetaspaceShared::cds_i2i_entry_code_buffers((size_t)(AbstractInterpreter::number_of_method_entries) * trampoline_size);
 234   addr += (size_t)(kind) * trampoline_size;
 235 
 236   return addr;
 237 }
 238 
 239 void AbstractInterpreter::update_cds_entry_table(AbstractInterpreter::MethodKind kind) {
 240   if (DumpSharedSpaces || UseSharedSpaces) {
 241     address trampoline = get_trampoline_code_buffer(kind);
 242     _cds_entry_table[kind] = trampoline;
 243 
 244     CodeBuffer buffer(trampoline, (int)(SharedRuntime::trampoline_size()));
 245     MacroAssembler _masm(&buffer);
 246     SharedRuntime::generate_trampoline(&_masm, _entry_table[kind]);
 247 
 248     if (PrintInterpreter) {
 249       Disassembler::decode(buffer.insts_begin(), buffer.insts_end());
 250     }
 251   }
 252 }
 253 
 254 #endif
 255 
 256 void AbstractInterpreter::set_entry_for_kind(AbstractInterpreter::MethodKind kind, address entry) {
 257   assert(kind >= method_handle_invoke_FIRST &&
 258          kind <= method_handle_invoke_LAST, "late initialization only for MH entry points");
 259   assert(_entry_table[kind] == _entry_table[abstract], "previous value must be AME entry");
 260   _entry_table[kind] = entry;
 261 
 262   update_cds_entry_table(kind);
 263 }
 264 
 265 // Return true if the interpreter can prove that the given bytecode has
 266 // not yet been executed (in Java semantics, not in actual operation).
 267 bool AbstractInterpreter::is_not_reached(const methodHandle& method, int bci) {
 268   BytecodeStream s(method, bci);
 269   Bytecodes::Code code = s.next();
 270 
 271   if (Bytecodes::is_invoke(code)) {
 272     assert(!Bytecodes::must_rewrite(code), "invokes aren't rewritten");
 273     ConstantPool* cpool = method()->constants();
 274 
 275     Bytecode invoke_bc(s.bytecode());
 276 
 277     switch (code) {
 278       case Bytecodes::_invokedynamic: {
 279         assert(invoke_bc.has_index_u4(code), "sanity");
 280         int method_index = invoke_bc.get_index_u4(code);
 281         return cpool->invokedynamic_cp_cache_entry_at(method_index)->is_f1_null();
 282       }
 283       case Bytecodes::_invokevirtual:   // fall-through
 284       case Bytecodes::_invokeinterface: // fall-through
 285       case Bytecodes::_invokespecial:   // fall-through
 286       case Bytecodes::_invokestatic: {
 287         if (cpool->has_preresolution()) {
 288           return false; // might have been reached
 289         }
 290         assert(!invoke_bc.has_index_u4(code), "sanity");
 291         int method_index = invoke_bc.get_index_u2_cpcache(code);
 292         Method* resolved_method = ConstantPool::method_at_if_loaded(cpool, method_index);
 293         return (resolved_method == NULL);
 294       }
 295       default: ShouldNotReachHere();
 296     }
 297   } else if (!Bytecodes::must_rewrite(code)) {
 298     // might have been reached
 299     return false;
 300   }
 301 
 302   // the bytecode might not be rewritten if the method is an accessor, etc.
 303   address ientry = method->interpreter_entry();
 304   if (ientry != entry_for_kind(AbstractInterpreter::zerolocals) &&
 305       ientry != entry_for_kind(AbstractInterpreter::zerolocals_synchronized))
 306     return false;  // interpreter does not run this method!
 307 
 308   // otherwise, we can be sure this bytecode has never been executed
 309   return true;
 310 }
 311 
 312 
 313 #ifndef PRODUCT
 314 void AbstractInterpreter::print_method_kind(MethodKind kind) {
 315   switch (kind) {
 316     case zerolocals             : tty->print("zerolocals"             ); break;
 317     case zerolocals_synchronized: tty->print("zerolocals_synchronized"); break;
 318     case native                 : tty->print("native"                 ); break;
 319     case native_synchronized    : tty->print("native_synchronized"    ); break;
 320     case empty                  : tty->print("empty"                  ); break;
 321     case accessor               : tty->print("accessor"               ); break;
 322     case abstract               : tty->print("abstract"               ); break;
 323     case java_lang_math_sin     : tty->print("java_lang_math_sin"     ); break;
 324     case java_lang_math_cos     : tty->print("java_lang_math_cos"     ); break;
 325     case java_lang_math_tan     : tty->print("java_lang_math_tan"     ); break;
 326     case java_lang_math_abs     : tty->print("java_lang_math_abs"     ); break;
 327     case java_lang_math_sqrt    : tty->print("java_lang_math_sqrt"    ); break;
 328     case java_lang_math_log     : tty->print("java_lang_math_log"     ); break;
 329     case java_lang_math_log10   : tty->print("java_lang_math_log10"   ); break;
 330     case java_lang_math_fmaD    : tty->print("java_lang_math_fmaD"    ); break;
 331     case java_lang_math_fmaF    : tty->print("java_lang_math_fmaF"    ); break;
 332     case java_util_zip_CRC32_update           : tty->print("java_util_zip_CRC32_update"); break;
 333     case java_util_zip_CRC32_updateBytes      : tty->print("java_util_zip_CRC32_updateBytes"); break;
 334     case java_util_zip_CRC32_updateByteBuffer : tty->print("java_util_zip_CRC32_updateByteBuffer"); break;
 335     case java_util_zip_CRC32C_updateBytes     : tty->print("java_util_zip_CRC32C_updateBytes"); break;
 336     case java_util_zip_CRC32C_updateDirectByteBuffer: tty->print("java_util_zip_CRC32C_updateDirectByteByffer"); break;
 337     default:
 338       if (kind >= method_handle_invoke_FIRST &&
 339           kind <= method_handle_invoke_LAST) {
 340         const char* kind_name = vmIntrinsics::name_at(method_handle_intrinsic(kind));
 341         if (kind_name[0] == '_')  kind_name = &kind_name[1];  // '_invokeExact' => 'invokeExact'
 342         tty->print("method_handle_%s", kind_name);
 343         break;
 344       }
 345       ShouldNotReachHere();
 346       break;
 347   }
 348 }
 349 #endif // PRODUCT
 350 
 351 
 352 //------------------------------------------------------------------------------------------------------------------------
 353 // Deoptimization support
 354 
 355 /**
 356  * If a deoptimization happens, this function returns the point of next bytecode to continue execution.
 357  */
 358 address AbstractInterpreter::deopt_continue_after_entry(Method* method, address bcp, int callee_parameters, bool is_top_frame) {
 359   assert(method->contains(bcp), "just checkin'");
 360 
 361   // Get the original and rewritten bytecode.
 362   Bytecodes::Code code = Bytecodes::java_code_at(method, bcp);
 363   assert(!Interpreter::bytecode_should_reexecute(code), "should not reexecute");
 364 
 365   const int bci = method->bci_from(bcp);
 366 
 367   // compute continuation length
 368   const int length = Bytecodes::length_at(method, bcp);
 369 
 370   // compute result type
 371   BasicType type = T_ILLEGAL;
 372 
 373   switch (code) {
 374     case Bytecodes::_invokevirtual  :
 375     case Bytecodes::_invokespecial  :
 376     case Bytecodes::_invokestatic   :
 377     case Bytecodes::_invokeinterface: {
 378       Thread *thread = Thread::current();
 379       ResourceMark rm(thread);
 380       methodHandle mh(thread, method);
 381       type = Bytecode_invoke(mh, bci).result_type();
 382       // since the cache entry might not be initialized:
 383       // (NOT needed for the old calling convension)
 384       if (!is_top_frame) {
 385         int index = Bytes::get_native_u2(bcp+1);
 386         method->constants()->cache()->entry_at(index)->set_parameter_size(callee_parameters);
 387       }
 388       break;
 389     }
 390 
 391    case Bytecodes::_invokedynamic: {
 392       Thread *thread = Thread::current();
 393       ResourceMark rm(thread);
 394       methodHandle mh(thread, method);
 395       type = Bytecode_invoke(mh, bci).result_type();
 396       // since the cache entry might not be initialized:
 397       // (NOT needed for the old calling convension)
 398       if (!is_top_frame) {
 399         int index = Bytes::get_native_u4(bcp+1);
 400         method->constants()->invokedynamic_cp_cache_entry_at(index)->set_parameter_size(callee_parameters);
 401       }
 402       break;
 403     }
 404 
 405     case Bytecodes::_ldc   :
 406     case Bytecodes::_ldc_w : // fall through
 407     case Bytecodes::_ldc2_w:
 408       {
 409         Thread *thread = Thread::current();
 410         ResourceMark rm(thread);
 411         methodHandle mh(thread, method);
 412         type = Bytecode_loadconstant(mh, bci).result_type();
 413         break;
 414       }
 415 
 416     default:
 417       type = Bytecodes::result_type(code);
 418       break;
 419   }
 420 
 421   // return entry point for computed continuation state & bytecode length
 422   return
 423     is_top_frame
 424     ? Interpreter::deopt_entry (as_TosState(type), length)
 425     : Interpreter::return_entry(as_TosState(type), length, code);
 426 }
 427 
 428 // If deoptimization happens, this function returns the point where the interpreter reexecutes
 429 // the bytecode.
 430 // Note: Bytecodes::_athrow is a special case in that it does not return
 431 //       Interpreter::deopt_entry(vtos, 0) like others
 432 address AbstractInterpreter::deopt_reexecute_entry(Method* method, address bcp) {
 433   assert(method->contains(bcp), "just checkin'");
 434   Bytecodes::Code code   = Bytecodes::java_code_at(method, bcp);
 435 #if defined(COMPILER1) || INCLUDE_JVMCI
 436   if(code == Bytecodes::_athrow ) {
 437     return Interpreter::rethrow_exception_entry();
 438   }
 439 #endif /* COMPILER1 || INCLUDE_JVMCI */
 440   return Interpreter::deopt_entry(vtos, 0);
 441 }
 442 
 443 // If deoptimization happens, the interpreter should reexecute these bytecodes.
 444 // This function mainly helps the compilers to set up the reexecute bit.
 445 bool AbstractInterpreter::bytecode_should_reexecute(Bytecodes::Code code) {
 446   switch (code) {
 447     case Bytecodes::_lookupswitch:
 448     case Bytecodes::_tableswitch:
 449     case Bytecodes::_fast_binaryswitch:
 450     case Bytecodes::_fast_linearswitch:
 451     // recompute condtional expression folded into _if<cond>
 452     case Bytecodes::_lcmp      :
 453     case Bytecodes::_fcmpl     :
 454     case Bytecodes::_fcmpg     :
 455     case Bytecodes::_dcmpl     :
 456     case Bytecodes::_dcmpg     :
 457     case Bytecodes::_ifnull    :
 458     case Bytecodes::_ifnonnull :
 459     case Bytecodes::_goto      :
 460     case Bytecodes::_goto_w    :
 461     case Bytecodes::_ifeq      :
 462     case Bytecodes::_ifne      :
 463     case Bytecodes::_iflt      :
 464     case Bytecodes::_ifge      :
 465     case Bytecodes::_ifgt      :
 466     case Bytecodes::_ifle      :
 467     case Bytecodes::_if_icmpeq :
 468     case Bytecodes::_if_icmpne :
 469     case Bytecodes::_if_icmplt :
 470     case Bytecodes::_if_icmpge :
 471     case Bytecodes::_if_icmpgt :
 472     case Bytecodes::_if_icmple :
 473     case Bytecodes::_if_acmpeq :
 474     case Bytecodes::_if_acmpne :
 475     // special cases
 476     case Bytecodes::_getfield  :
 477     case Bytecodes::_putfield  :
 478     case Bytecodes::_getstatic :
 479     case Bytecodes::_putstatic :
 480     case Bytecodes::_aastore   :
 481 #ifdef COMPILER1
 482     //special case of reexecution
 483     case Bytecodes::_athrow    :
 484 #endif
 485       return true;
 486 
 487     default:
 488       return false;
 489   }
 490 }
 491 
 492 void AbstractInterpreter::initialize_method_handle_entries() {
 493   // method handle entry kinds are generated later in MethodHandlesAdapterGenerator::generate:
 494   for (int i = method_handle_invoke_FIRST; i <= method_handle_invoke_LAST; i++) {
 495     MethodKind kind = (MethodKind) i;
 496     _entry_table[kind] = _entry_table[Interpreter::abstract];
 497     Interpreter::update_cds_entry_table(kind);
 498   }
 499 }