1 /*
   2  * Copyright (c) 1997, 2018, 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 #ifndef SHARE_VM_INTERPRETER_ABSTRACTINTERPRETER_HPP
  26 #define SHARE_VM_INTERPRETER_ABSTRACTINTERPRETER_HPP
  27 
  28 #include "asm/macroAssembler.hpp"
  29 #include "code/stubs.hpp"
  30 #include "interpreter/bytecodes.hpp"
  31 #include "runtime/frame.hpp"
  32 #include "runtime/thread.hpp"
  33 #include "runtime/vmThread.hpp"
  34 
  35 // This file contains the platform-independent parts
  36 // of the abstract interpreter and the abstract interpreter generator.
  37 
  38 // Organization of the interpreter(s). There exists two different interpreters in hotpot
  39 // an assembly language version (aka template interpreter) and a high level language version
  40 // (aka c++ interpreter). Th division of labor is as follows:
  41 
  42 // Template Interpreter          C++ Interpreter        Functionality
  43 //
  44 // templateTable*                bytecodeInterpreter*   actual interpretation of bytecodes
  45 //
  46 // templateInterpreter*          cppInterpreter*        generation of assembly code that creates
  47 //                                                      and manages interpreter runtime frames.
  48 //                                                      Also code for populating interpreter
  49 //                                                      frames created during deoptimization.
  50 //
  51 
  52 class InterpreterMacroAssembler;
  53 
  54 class AbstractInterpreter: AllStatic {
  55   friend class VMStructs;
  56   friend class CppInterpreterGenerator;
  57   friend class TemplateInterpreterGenerator;
  58  public:
  59   enum MethodKind {
  60     zerolocals,                                                 // method needs locals initialization
  61     zerolocals_synchronized,                                    // method needs locals initialization & is synchronized
  62     native,                                                     // native method
  63     native_synchronized,                                        // native method & is synchronized
  64     empty,                                                      // empty method (code: _return)
  65     accessor,                                                   // accessor method (code: _aload_0, _getfield, _(a|i)return)
  66     abstract,                                                   // abstract method (throws an AbstractMethodException)
  67     method_handle_invoke_FIRST,                                 // java.lang.invoke.MethodHandles::invokeExact, etc.
  68     method_handle_invoke_LAST                                   = (method_handle_invoke_FIRST
  69                                                                    + (vmIntrinsics::LAST_MH_SIG_POLY
  70                                                                       - vmIntrinsics::FIRST_MH_SIG_POLY)),
  71     java_lang_math_sin,                                         // implementation of java.lang.Math.sin   (x)
  72     java_lang_math_cos,                                         // implementation of java.lang.Math.cos   (x)
  73     java_lang_math_tan,                                         // implementation of java.lang.Math.tan   (x)
  74     java_lang_math_abs,                                         // implementation of java.lang.Math.abs   (x)
  75     java_lang_math_sqrt,                                        // implementation of java.lang.Math.sqrt  (x)
  76     java_lang_math_log,                                         // implementation of java.lang.Math.log   (x)
  77     java_lang_math_log10,                                       // implementation of java.lang.Math.log10 (x)
  78     java_lang_math_pow,                                         // implementation of java.lang.Math.pow   (x,y)
  79     java_lang_math_exp,                                         // implementation of java.lang.Math.exp   (x)
  80     java_lang_math_fmaF,                                        // implementation of java.lang.Math.fma   (x, y, z)
  81     java_lang_math_fmaD,                                        // implementation of java.lang.Math.fma   (x, y, z)
  82     java_lang_ref_reference_get,                                // implementation of java.lang.ref.Reference.get()
  83     java_lang_continuation_getSP,                               // implementation of java.lang.Continuation.getSP()
  84     java_lang_continuation_getFP,                               // implementation of java.lang.Continuation.getFP()
  85     java_lang_continuation_getPC,                               // implementation of java.lang.Continuation.getPC()
  86     java_lang_continuation_doContinue,                          // implementation of java.lang.Continuation.doContinue()
  87     java_lang_continuation_doYield,                             // implementation of java.lang.Continuation.doYield()
  88     java_lang_continuation_runLevel,                            // implementation of java.lang.Continuation.runLevel()
  89     java_util_zip_CRC32_update,                                 // implementation of java.util.zip.CRC32.update()
  90     java_util_zip_CRC32_updateBytes,                            // implementation of java.util.zip.CRC32.updateBytes()
  91     java_util_zip_CRC32_updateByteBuffer,                       // implementation of java.util.zip.CRC32.updateByteBuffer()
  92     java_util_zip_CRC32C_updateBytes,                           // implementation of java.util.zip.CRC32C.updateBytes(crc, b[], off, end)
  93     java_util_zip_CRC32C_updateDirectByteBuffer,                // implementation of java.util.zip.CRC32C.updateDirectByteBuffer(crc, address, off, end)
  94     java_lang_Float_intBitsToFloat,                             // implementation of java.lang.Float.intBitsToFloat()
  95     java_lang_Float_floatToRawIntBits,                          // implementation of java.lang.Float.floatToRawIntBits()
  96     java_lang_Double_longBitsToDouble,                          // implementation of java.lang.Double.longBitsToDouble()
  97     java_lang_Double_doubleToRawLongBits,                       // implementation of java.lang.Double.doubleToRawLongBits()
  98     number_of_method_entries,
  99     invalid = -1
 100   };
 101 
 102   // Conversion from the part of the above enum to vmIntrinsics::_invokeExact, etc.
 103   static vmIntrinsics::ID method_handle_intrinsic(MethodKind kind) {
 104     if (kind >= method_handle_invoke_FIRST && kind <= method_handle_invoke_LAST)
 105       return (vmIntrinsics::ID)( vmIntrinsics::FIRST_MH_SIG_POLY + (kind - method_handle_invoke_FIRST) );
 106     else
 107       return vmIntrinsics::_none;
 108   }
 109 
 110   enum SomeConstants {
 111     number_of_result_handlers = 10                              // number of result handlers for native calls
 112   };
 113 
 114  protected:
 115   static StubQueue* _code;                                      // the interpreter code (codelets)
 116 
 117   static bool       _notice_safepoints;                         // true if safepoints are activated
 118 
 119   static address    _native_entry_begin;                        // Region for native entry code
 120   static address    _native_entry_end;
 121 
 122   // method entry points
 123   static address    _entry_table[number_of_method_entries];     // entry points for a given method
 124   static address    _cds_entry_table[number_of_method_entries]; // entry points for methods in the CDS archive
 125   static address    _native_abi_to_tosca[number_of_result_handlers];  // for native method result handlers
 126   static address    _slow_signature_handler;                              // the native method generic (slow) signature handler
 127 
 128   static address    _rethrow_exception_entry;                   // rethrows an activation in previous frame
 129 
 130   friend class      AbstractInterpreterGenerator;
 131   friend class      InterpreterMacroAssembler;
 132 
 133  public:
 134   // Initialization/debugging
 135   static void       initialize();
 136   static StubQueue* code()                                      { return _code; }
 137 
 138 
 139   // Method activation
 140   static MethodKind method_kind(const methodHandle& m);
 141   static address    entry_for_kind(MethodKind k)                { assert(0 <= k && k < number_of_method_entries, "illegal kind"); return _entry_table[k]; }
 142   static address    entry_for_method(const methodHandle& m)     { return entry_for_kind(method_kind(m)); }
 143 
 144   static address entry_for_cds_method(const methodHandle& m) {
 145     MethodKind k = method_kind(m);
 146     assert(0 <= k && k < number_of_method_entries, "illegal kind");
 147     return _cds_entry_table[k];
 148   }
 149 
 150   // used by class data sharing
 151   static void       update_cds_entry_table(MethodKind kind) NOT_CDS_RETURN;
 152 
 153   static address    get_trampoline_code_buffer(AbstractInterpreter::MethodKind kind) NOT_CDS_RETURN_(0);
 154 
 155   // used for bootstrapping method handles:
 156   static void       set_entry_for_kind(MethodKind k, address e);
 157 
 158   static void       print_method_kind(MethodKind kind)          PRODUCT_RETURN;
 159 
 160   // These should never be compiled since the interpreter will prefer
 161   // the compiled version to the intrinsic version.
 162   static bool       can_be_compiled(const methodHandle& m) {
 163     switch (m->intrinsic_id()) {
 164       case vmIntrinsics::_dsin  : // fall thru
 165       case vmIntrinsics::_dcos  : // fall thru
 166       case vmIntrinsics::_dtan  : // fall thru
 167       case vmIntrinsics::_dabs  : // fall thru
 168       case vmIntrinsics::_dsqrt : // fall thru
 169       case vmIntrinsics::_dlog  : // fall thru
 170       case vmIntrinsics::_dlog10: // fall thru
 171       case vmIntrinsics::_dpow  : // fall thru
 172       case vmIntrinsics::_dexp  : // fall thru
 173       case vmIntrinsics::_fmaD  : // fall thru
 174       case vmIntrinsics::_fmaF  : // fall thru
 175         return false;
 176       default:
 177         return true;
 178     }
 179   }
 180 
 181   // Runtime support
 182 
 183   // length = invoke bytecode length (to advance to next bytecode)
 184   static address deopt_entry(TosState state, int length) { ShouldNotReachHere(); return NULL; }
 185   static address return_entry(TosState state, int length, Bytecodes::Code code) { ShouldNotReachHere(); return NULL; }
 186 
 187   static address    rethrow_exception_entry()                   { return _rethrow_exception_entry; }
 188 
 189   // Activation size in words for a method that is just being called.
 190   // Parameters haven't been pushed so count them too.
 191   static int        size_top_interpreter_activation(Method* method);
 192 
 193   // Deoptimization support
 194   // Compute the entry address for continuation after
 195   static address deopt_continue_after_entry(Method* method,
 196                                             address bcp,
 197                                             int callee_parameters,
 198                                             bool is_top_frame);
 199   // Compute the entry address for reexecution
 200   static address deopt_reexecute_entry(Method* method, address bcp);
 201   // Deoptimization should reexecute this bytecode
 202   static bool    bytecode_should_reexecute(Bytecodes::Code code);
 203 
 204   // deoptimization support
 205   static int        size_activation(int max_stack,
 206                                     int temps,
 207                                     int extra_args,
 208                                     int monitors,
 209                                     int callee_params,
 210                                     int callee_locals,
 211                                     bool is_top_frame);
 212 
 213   static void      layout_activation(Method* method,
 214                                      int temps,
 215                                      int popframe_args,
 216                                      int monitors,
 217                                      int caller_actual_parameters,
 218                                      int callee_params,
 219                                      int callee_locals,
 220                                      frame* caller,
 221                                      frame* interpreter_frame,
 222                                      bool is_top_frame,
 223                                      bool is_bottom_frame);
 224 
 225   // Runtime support
 226   static bool       is_not_reached(const methodHandle& method, int bci);
 227   // Safepoint support
 228   static void       notice_safepoints()                         { ShouldNotReachHere(); } // stops the thread when reaching a safepoint
 229   static void       ignore_safepoints()                         { ShouldNotReachHere(); } // ignores safepoints
 230 
 231   // Support for native calls
 232   static address    slow_signature_handler()                    { return _slow_signature_handler; }
 233   static address    result_handler(BasicType type)              { return _native_abi_to_tosca[BasicType_as_index(type)]; }
 234   static int        BasicType_as_index(BasicType type);         // computes index into result_handler_by_index table
 235   static bool       in_native_entry(address pc)                 { return _native_entry_begin <= pc && pc < _native_entry_end; }
 236   // Debugging/printing
 237   static void       print();                                    // prints the interpreter code
 238 
 239  public:
 240   // Interpreter helpers
 241   const static int stackElementWords   = 1;
 242   const static int stackElementSize    = stackElementWords * wordSize;
 243   const static int logStackElementSize = LogBytesPerWord;
 244 
 245   static int expr_index_at(int i) {
 246     return stackElementWords * i;
 247   }
 248 
 249   static int expr_offset_in_bytes(int i) {
 250 #if !defined(ZERO) && (defined(PPC) || defined(S390) || defined(SPARC))
 251     return stackElementSize * i + wordSize;  // both point to one word past TOS
 252 #else
 253     return stackElementSize * i;
 254 #endif
 255   }
 256 
 257   static int local_index_at(int i) {
 258     assert(i <= 0, "local direction already negated");
 259     return stackElementWords * i;
 260   }
 261 
 262 #if !defined(ZERO) && (defined(IA32) || defined(AMD64))
 263   static Address::ScaleFactor stackElementScale() {
 264     return NOT_LP64(Address::times_4) LP64_ONLY(Address::times_8);
 265   }
 266 #endif
 267 
 268   // Local values relative to locals[n]
 269   static int  local_offset_in_bytes(int n) {
 270     return ((frame::interpreter_frame_expression_stack_direction() * n) * stackElementSize);
 271   }
 272 
 273   // access to stacked values according to type:
 274   static oop* oop_addr_in_slot(intptr_t* slot_addr) {
 275     return (oop*) slot_addr;
 276   }
 277   static jint* int_addr_in_slot(intptr_t* slot_addr) {
 278     if ((int) sizeof(jint) < wordSize && !Endian::is_Java_byte_ordering_different())
 279       // big-endian LP64
 280       return (jint*)(slot_addr + 1) - 1;
 281     else
 282       return (jint*) slot_addr;
 283   }
 284   static jlong long_in_slot(intptr_t* slot_addr) {
 285     if (sizeof(intptr_t) >= sizeof(jlong)) {
 286       return *(jlong*) slot_addr;
 287     } else {
 288       return Bytes::get_native_u8((address)slot_addr);
 289     }
 290   }
 291   static void set_long_in_slot(intptr_t* slot_addr, jlong value) {
 292     if (sizeof(intptr_t) >= sizeof(jlong)) {
 293       *(jlong*) slot_addr = value;
 294     } else {
 295       Bytes::put_native_u8((address)slot_addr, value);
 296     }
 297   }
 298   static void get_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
 299     switch (type) {
 300     case T_BOOLEAN: value->z = *int_addr_in_slot(slot_addr);            break;
 301     case T_CHAR:    value->c = *int_addr_in_slot(slot_addr);            break;
 302     case T_BYTE:    value->b = *int_addr_in_slot(slot_addr);            break;
 303     case T_SHORT:   value->s = *int_addr_in_slot(slot_addr);            break;
 304     case T_INT:     value->i = *int_addr_in_slot(slot_addr);            break;
 305     case T_LONG:    value->j = long_in_slot(slot_addr);                 break;
 306     case T_FLOAT:   value->f = *(jfloat*)int_addr_in_slot(slot_addr);   break;
 307     case T_DOUBLE:  value->d = jdouble_cast(long_in_slot(slot_addr));   break;
 308     case T_OBJECT:  value->l = (jobject)*oop_addr_in_slot(slot_addr);   break;
 309     default:        ShouldNotReachHere();
 310     }
 311   }
 312   static void set_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
 313     switch (type) {
 314     case T_BOOLEAN: *int_addr_in_slot(slot_addr) = (value->z != 0);     break;
 315     case T_CHAR:    *int_addr_in_slot(slot_addr) = value->c;            break;
 316     case T_BYTE:    *int_addr_in_slot(slot_addr) = value->b;            break;
 317     case T_SHORT:   *int_addr_in_slot(slot_addr) = value->s;            break;
 318     case T_INT:     *int_addr_in_slot(slot_addr) = value->i;            break;
 319     case T_LONG:    set_long_in_slot(slot_addr, value->j);              break;
 320     case T_FLOAT:   *(jfloat*)int_addr_in_slot(slot_addr) = value->f;   break;
 321     case T_DOUBLE:  set_long_in_slot(slot_addr, jlong_cast(value->d));  break;
 322     case T_OBJECT:  *oop_addr_in_slot(slot_addr) = (oop) value->l;      break;
 323     default:        ShouldNotReachHere();
 324     }
 325   }
 326 
 327   static void initialize_method_handle_entries();
 328 };
 329 
 330 //------------------------------------------------------------------------------------------------------------------------
 331 // The interpreter generator.
 332 
 333 class Template;
 334 class AbstractInterpreterGenerator: public StackObj {
 335  protected:
 336   InterpreterMacroAssembler* _masm;
 337 
 338  public:
 339   AbstractInterpreterGenerator(StubQueue* _code);
 340 };
 341 
 342 #endif // SHARE_VM_INTERPRETER_ABSTRACTINTERPRETER_HPP