1 /*
   2  * Copyright (c) 1997, 2012, 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/templateTable.hpp"
  34 #include "memory/allocation.inline.hpp"
  35 #include "memory/resourceArea.hpp"
  36 #include "oops/arrayOop.hpp"
  37 #include "oops/methodData.hpp"
  38 #include "oops/method.hpp"
  39 #include "oops/oop.inline.hpp"
  40 #include "prims/forte.hpp"
  41 #include "prims/jvmtiExport.hpp"
  42 #include "prims/methodHandles.hpp"
  43 #include "runtime/handles.inline.hpp"
  44 #include "runtime/sharedRuntime.hpp"
  45 #include "runtime/stubRoutines.hpp"
  46 #include "runtime/timer.hpp"
  47 
  48 # define __ _masm->
  49 
  50 
  51 //------------------------------------------------------------------------------------------------------------------------
  52 // Implementation of InterpreterCodelet
  53 
  54 void InterpreterCodelet::initialize(const char* description, Bytecodes::Code bytecode) {
  55   _description       = description;
  56   _bytecode          = bytecode;
  57 }
  58 
  59 
  60 void InterpreterCodelet::verify() {
  61 }
  62 
  63 
  64 void InterpreterCodelet::print_on(outputStream* st) const {
  65   ttyLocker ttyl;
  66 
  67   if (PrintInterpreter) {
  68     st->cr();
  69     st->print_cr("----------------------------------------------------------------------");
  70   }
  71 
  72   if (description() != NULL) st->print("%s  ", description());
  73   if (bytecode()    >= 0   ) st->print("%d %s  ", bytecode(), Bytecodes::name(bytecode()));
  74   st->print_cr("[" INTPTR_FORMAT ", " INTPTR_FORMAT "]  %d bytes",
  75                 code_begin(), code_end(), code_size());
  76 
  77   if (PrintInterpreter) {
  78     st->cr();
  79     Disassembler::decode(code_begin(), code_end(), st, DEBUG_ONLY(_comments) NOT_DEBUG(CodeComments()));
  80   }
  81 }
  82 
  83 
  84 //------------------------------------------------------------------------------------------------------------------------
  85 // Implementation of  platform independent aspects of Interpreter
  86 
  87 void AbstractInterpreter::initialize() {
  88   if (_code != NULL) return;
  89 
  90   // make sure 'imported' classes are initialized
  91   if (CountBytecodes || TraceBytecodes || StopInterpreterAt) BytecodeCounter::reset();
  92   if (PrintBytecodeHistogram)                                BytecodeHistogram::reset();
  93   if (PrintBytecodePairHistogram)                            BytecodePairHistogram::reset();
  94 
  95   InvocationCounter::reinitialize(DelayCompilationDuringStartup);
  96 
  97 }
  98 
  99 void AbstractInterpreter::print() {
 100   tty->cr();
 101   tty->print_cr("----------------------------------------------------------------------");
 102   tty->print_cr("Interpreter");
 103   tty->cr();
 104   tty->print_cr("code size        = %6dK bytes", (int)_code->used_space()/1024);
 105   tty->print_cr("total space      = %6dK bytes", (int)_code->total_space()/1024);
 106   tty->print_cr("wasted space     = %6dK bytes", (int)_code->available_space()/1024);
 107   tty->cr();
 108   tty->print_cr("# of codelets    = %6d"      , _code->number_of_stubs());
 109   tty->print_cr("avg codelet size = %6d bytes", _code->used_space() / _code->number_of_stubs());
 110   tty->cr();
 111   _code->print();
 112   tty->print_cr("----------------------------------------------------------------------");
 113   tty->cr();
 114 }
 115 
 116 
 117 void interpreter_init() {
 118   Interpreter::initialize();
 119 #ifndef PRODUCT
 120   if (TraceBytecodes) BytecodeTracer::set_closure(BytecodeTracer::std_closure());
 121 #endif // PRODUCT
 122   // need to hit every safepoint in order to call zapping routine
 123   // register the interpreter
 124   Forte::register_stub(
 125     "Interpreter",
 126     AbstractInterpreter::code()->code_start(),
 127     AbstractInterpreter::code()->code_end()
 128   );
 129 
 130   // notify JVMTI profiler
 131   if (JvmtiExport::should_post_dynamic_code_generated()) {
 132     JvmtiExport::post_dynamic_code_generated("Interpreter",
 133                                              AbstractInterpreter::code()->code_start(),
 134                                              AbstractInterpreter::code()->code_end());
 135   }
 136 }
 137 
 138 //------------------------------------------------------------------------------------------------------------------------
 139 // Implementation of interpreter
 140 
 141 StubQueue* AbstractInterpreter::_code                                       = NULL;
 142 bool       AbstractInterpreter::_notice_safepoints                          = false;
 143 address    AbstractInterpreter::_rethrow_exception_entry                    = NULL;
 144 
 145 address    AbstractInterpreter::_native_entry_begin                         = NULL;
 146 address    AbstractInterpreter::_native_entry_end                           = NULL;
 147 address    AbstractInterpreter::_slow_signature_handler;
 148 address    AbstractInterpreter::_entry_table            [AbstractInterpreter::number_of_method_entries];
 149 address    AbstractInterpreter::_native_abi_to_tosca    [AbstractInterpreter::number_of_result_handlers];
 150 
 151 //------------------------------------------------------------------------------------------------------------------------
 152 // Generation of complete interpreter
 153 
 154 AbstractInterpreterGenerator::AbstractInterpreterGenerator(StubQueue* _code) {
 155   _masm                      = NULL;
 156 }
 157 
 158 
 159 static const BasicType types[Interpreter::number_of_result_handlers] = {
 160   T_BOOLEAN,
 161   T_CHAR   ,
 162   T_BYTE   ,
 163   T_SHORT  ,
 164   T_INT    ,
 165   T_LONG   ,
 166   T_VOID   ,
 167   T_FLOAT  ,
 168   T_DOUBLE ,
 169   T_OBJECT
 170 };
 171 
 172 void AbstractInterpreterGenerator::generate_all() {
 173 
 174 
 175   { CodeletMark cm(_masm, "slow signature handler");
 176     Interpreter::_slow_signature_handler = generate_slow_signature_handler();
 177   }
 178 
 179 }
 180 
 181 //------------------------------------------------------------------------------------------------------------------------
 182 // Entry points
 183 
 184 AbstractInterpreter::MethodKind AbstractInterpreter::method_kind(methodHandle m) {
 185   // Abstract method?
 186   if (m->is_abstract()) return abstract;
 187 
 188   // Method handle primitive?
 189   if (m->is_method_handle_intrinsic()) {
 190     vmIntrinsics::ID id = m->intrinsic_id();
 191     assert(MethodHandles::is_signature_polymorphic(id), "must match an intrinsic");
 192     MethodKind kind = (MethodKind)( method_handle_invoke_FIRST +
 193                                     ((int)id - vmIntrinsics::FIRST_MH_SIG_POLY) );
 194     assert(kind <= method_handle_invoke_LAST, "parallel enum ranges");
 195     return kind;
 196   }
 197 
 198   // Native method?
 199   // Note: This test must come _before_ the test for intrinsic
 200   //       methods. See also comments below.
 201   if (m->is_native()) {
 202     assert(!m->is_method_handle_intrinsic(), "overlapping bits here, watch out");
 203     return m->is_synchronized() ? native_synchronized : native;
 204   }
 205 
 206   // Synchronized?
 207   if (m->is_synchronized()) {
 208     return zerolocals_synchronized;
 209   }
 210 
 211   if (RegisterFinalizersAtInit && m->code_size() == 1 &&
 212       m->intrinsic_id() == vmIntrinsics::_Object_init) {
 213     // We need to execute the special return bytecode to check for
 214     // finalizer registration so create a normal frame.
 215     return zerolocals;
 216   }
 217 
 218   // Empty method?
 219   if (m->is_empty_method()) {
 220     return empty;
 221   }
 222 
 223   // Special intrinsic method?
 224   // Note: This test must come _after_ the test for native methods,
 225   //       otherwise we will run into problems with JDK 1.2, see also
 226   //       AbstractInterpreterGenerator::generate_method_entry() for
 227   //       for details.
 228   switch (m->intrinsic_id()) {
 229     case vmIntrinsics::_dsin  : return java_lang_math_sin  ;
 230     case vmIntrinsics::_dcos  : return java_lang_math_cos  ;
 231     case vmIntrinsics::_dtan  : return java_lang_math_tan  ;
 232     case vmIntrinsics::_dabs  : return java_lang_math_abs  ;
 233     case vmIntrinsics::_dsqrt : return java_lang_math_sqrt ;
 234     case vmIntrinsics::_dlog  : return java_lang_math_log  ;
 235     case vmIntrinsics::_dlog10: return java_lang_math_log10;
 236     case vmIntrinsics::_dpow  : return java_lang_math_pow  ;
 237     case vmIntrinsics::_dexp  : return java_lang_math_exp  ;
 238 
 239     case vmIntrinsics::_Reference_get:
 240                                 return java_lang_ref_reference_get;
 241   }
 242 
 243   // Accessor method?
 244   if (m->is_accessor()) {
 245     assert(m->size_of_parameters() == 1, "fast code for accessors assumes parameter size = 1");
 246     return accessor;
 247   }
 248 
 249   // Note: for now: zero locals for all non-empty methods
 250   return zerolocals;
 251 }
 252 
 253 
 254 void AbstractInterpreter::set_entry_for_kind(AbstractInterpreter::MethodKind kind, address entry) {
 255   assert(kind >= method_handle_invoke_FIRST &&
 256          kind <= method_handle_invoke_LAST, "late initialization only for MH entry points");
 257   assert(_entry_table[kind] == _entry_table[abstract], "previous value must be AME entry");
 258   _entry_table[kind] = entry;
 259 }
 260 
 261 
 262 // Return true if the interpreter can prove that the given bytecode has
 263 // not yet been executed (in Java semantics, not in actual operation).
 264 bool AbstractInterpreter::is_not_reached(methodHandle method, int bci) {
 265   Bytecodes::Code code = method()->code_at(bci);
 266 
 267   if (!Bytecodes::must_rewrite(code)) {
 268     // might have been reached
 269     return false;
 270   }
 271 
 272   // the bytecode might not be rewritten if the method is an accessor, etc.
 273   address ientry = method->interpreter_entry();
 274   if (ientry != entry_for_kind(AbstractInterpreter::zerolocals) &&
 275       ientry != entry_for_kind(AbstractInterpreter::zerolocals_synchronized))
 276     return false;  // interpreter does not run this method!
 277 
 278   // otherwise, we can be sure this bytecode has never been executed
 279   return true;
 280 }
 281 
 282 
 283 #ifndef PRODUCT
 284 void AbstractInterpreter::print_method_kind(MethodKind kind) {
 285   switch (kind) {
 286     case zerolocals             : tty->print("zerolocals"             ); break;
 287     case zerolocals_synchronized: tty->print("zerolocals_synchronized"); break;
 288     case native                 : tty->print("native"                 ); break;
 289     case native_synchronized    : tty->print("native_synchronized"    ); break;
 290     case empty                  : tty->print("empty"                  ); break;
 291     case accessor               : tty->print("accessor"               ); break;
 292     case abstract               : tty->print("abstract"               ); break;
 293     case java_lang_math_sin     : tty->print("java_lang_math_sin"     ); break;
 294     case java_lang_math_cos     : tty->print("java_lang_math_cos"     ); break;
 295     case java_lang_math_tan     : tty->print("java_lang_math_tan"     ); break;
 296     case java_lang_math_abs     : tty->print("java_lang_math_abs"     ); break;
 297     case java_lang_math_sqrt    : tty->print("java_lang_math_sqrt"    ); break;
 298     case java_lang_math_log     : tty->print("java_lang_math_log"     ); break;
 299     case java_lang_math_log10   : tty->print("java_lang_math_log10"   ); 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 // If deoptimization happens, this function returns the point of next bytecode to continue execution
 319 address AbstractInterpreter::deopt_continue_after_entry(Method* method, address bcp, int callee_parameters, bool is_top_frame) {
 320   assert(method->contains(bcp), "just checkin'");
 321   Bytecodes::Code code   = Bytecodes::java_code_at(method, bcp);
 322   assert(!Interpreter::bytecode_should_reexecute(code), "should not reexecute");
 323   int             bci    = method->bci_from(bcp);
 324   int             length = -1; // initial value for debugging
 325   // compute continuation length
 326   length = Bytecodes::length_at(method, bcp);
 327   // compute result type
 328   BasicType type = T_ILLEGAL;
 329 
 330   switch (code) {
 331     case Bytecodes::_invokevirtual  :
 332     case Bytecodes::_invokespecial  :
 333     case Bytecodes::_invokestatic   :
 334     case Bytecodes::_invokeinterface: {
 335       Thread *thread = Thread::current();
 336       ResourceMark rm(thread);
 337       methodHandle mh(thread, method);
 338       type = Bytecode_invoke(mh, bci).result_type();
 339       // since the cache entry might not be initialized:
 340       // (NOT needed for the old calling convension)
 341       if (!is_top_frame) {
 342         int index = Bytes::get_native_u2(bcp+1);
 343         method->constants()->cache()->entry_at(index)->set_parameter_size(callee_parameters);
 344       }
 345       break;
 346     }
 347 
 348    case Bytecodes::_invokedynamic: {
 349       Thread *thread = Thread::current();
 350       ResourceMark rm(thread);
 351       methodHandle mh(thread, method);
 352       type = Bytecode_invoke(mh, bci).result_type();
 353       // since the cache entry might not be initialized:
 354       // (NOT needed for the old calling convension)
 355       if (!is_top_frame) {
 356         int index = Bytes::get_native_u4(bcp+1);
 357         method->constants()->invokedynamic_cp_cache_entry_at(index)->set_parameter_size(callee_parameters);
 358       }
 359       break;
 360     }
 361 
 362     case Bytecodes::_ldc   :
 363     case Bytecodes::_ldc_w : // fall through
 364     case Bytecodes::_ldc2_w:
 365       {
 366         Thread *thread = Thread::current();
 367         ResourceMark rm(thread);
 368         methodHandle mh(thread, method);
 369         type = Bytecode_loadconstant(mh, bci).result_type();
 370         break;
 371       }
 372 
 373     default:
 374       type = Bytecodes::result_type(code);
 375       break;
 376   }
 377 
 378   // return entry point for computed continuation state & bytecode length
 379   return
 380     is_top_frame
 381     ? Interpreter::deopt_entry (as_TosState(type), length)
 382     : Interpreter::return_entry(as_TosState(type), length);
 383 }
 384 
 385 // If deoptimization happens, this function returns the point where the interpreter reexecutes
 386 // the bytecode.
 387 // Note: Bytecodes::_athrow is a special case in that it does not return
 388 //       Interpreter::deopt_entry(vtos, 0) like others
 389 address AbstractInterpreter::deopt_reexecute_entry(Method* method, address bcp) {
 390   assert(method->contains(bcp), "just checkin'");
 391   Bytecodes::Code code   = Bytecodes::java_code_at(method, bcp);
 392 #ifdef COMPILER1
 393   if(code == Bytecodes::_athrow ) {
 394     return Interpreter::rethrow_exception_entry();
 395   }
 396 #endif /* COMPILER1 */
 397   return Interpreter::deopt_entry(vtos, 0);
 398 }
 399 
 400 // If deoptimization happens, the interpreter should reexecute these bytecodes.
 401 // This function mainly helps the compilers to set up the reexecute bit.
 402 bool AbstractInterpreter::bytecode_should_reexecute(Bytecodes::Code code) {
 403   switch (code) {
 404     case Bytecodes::_lookupswitch:
 405     case Bytecodes::_tableswitch:
 406     case Bytecodes::_fast_binaryswitch:
 407     case Bytecodes::_fast_linearswitch:
 408     // recompute condtional expression folded into _if<cond>
 409     case Bytecodes::_lcmp      :
 410     case Bytecodes::_fcmpl     :
 411     case Bytecodes::_fcmpg     :
 412     case Bytecodes::_dcmpl     :
 413     case Bytecodes::_dcmpg     :
 414     case Bytecodes::_ifnull    :
 415     case Bytecodes::_ifnonnull :
 416     case Bytecodes::_goto      :
 417     case Bytecodes::_goto_w    :
 418     case Bytecodes::_ifeq      :
 419     case Bytecodes::_ifne      :
 420     case Bytecodes::_iflt      :
 421     case Bytecodes::_ifge      :
 422     case Bytecodes::_ifgt      :
 423     case Bytecodes::_ifle      :
 424     case Bytecodes::_if_icmpeq :
 425     case Bytecodes::_if_icmpne :
 426     case Bytecodes::_if_icmplt :
 427     case Bytecodes::_if_icmpge :
 428     case Bytecodes::_if_icmpgt :
 429     case Bytecodes::_if_icmple :
 430     case Bytecodes::_if_acmpeq :
 431     case Bytecodes::_if_acmpne :
 432     // special cases
 433     case Bytecodes::_getfield  :
 434     case Bytecodes::_putfield  :
 435     case Bytecodes::_getstatic :
 436     case Bytecodes::_putstatic :
 437     case Bytecodes::_aastore   :
 438 #ifdef COMPILER1
 439     //special case of reexecution
 440     case Bytecodes::_athrow    :
 441 #endif
 442       return true;
 443 
 444     default:
 445       return false;
 446   }
 447 }
 448 
 449 void AbstractInterpreterGenerator::bang_stack_shadow_pages(bool native_call) {
 450   // Quick & dirty stack overflow checking: bang the stack & handle trap.
 451   // Note that we do the banging after the frame is setup, since the exception
 452   // handling code expects to find a valid interpreter frame on the stack.
 453   // Doing the banging earlier fails if the caller frame is not an interpreter
 454   // frame.
 455   // (Also, the exception throwing code expects to unlock any synchronized
 456   // method receiever, so do the banging after locking the receiver.)
 457 
 458   // Bang each page in the shadow zone. We can't assume it's been done for
 459   // an interpreter frame with greater than a page of locals, so each page
 460   // needs to be checked.  Only true for non-native.
 461   if (UseStackBanging) {
 462     const int start_page = native_call ? StackShadowPages : 1;
 463     const int page_size = os::vm_page_size();
 464     for (int pages = start_page; pages <= StackShadowPages ; pages++) {
 465       __ bang_stack_with_offset(pages*page_size);
 466     }
 467   }
 468 }
 469 
 470 void AbstractInterpreterGenerator::initialize_method_handle_entries() {
 471   // method handle entry kinds are generated later in MethodHandlesAdapterGenerator::generate:
 472   for (int i = Interpreter::method_handle_invoke_FIRST; i <= Interpreter::method_handle_invoke_LAST; i++) {
 473     Interpreter::MethodKind kind = (Interpreter::MethodKind) i;
 474     Interpreter::_entry_table[kind] = Interpreter::_entry_table[Interpreter::abstract];
 475   }
 476 }