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