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