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