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