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