1 /* 2 * Copyright (c) 1997, 2020, 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_INTERPRETER_ABSTRACTINTERPRETER_HPP 26 #define SHARE_INTERPRETER_ABSTRACTINTERPRETER_HPP 27 28 #include "asm/macroAssembler.hpp" 29 #include "classfile/vmIntrinsics.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 Zero Interpreter Functionality 44 // 45 // templateTable* bytecodeInterpreter* actual interpretation of bytecodes 46 // 47 // templateInterpreter* zeroInterpreter* generation of assembly code that creates 48 // and manages interpreter runtime frames. 49 // 50 51 class InterpreterMacroAssembler; 52 53 class AbstractInterpreter: AllStatic { 54 friend class VMStructs; 55 friend class ZeroInterpreterGenerator; 56 friend class TemplateInterpreterGenerator; 57 public: 58 enum MethodKind { 59 zerolocals, // method needs locals initialization 60 zerolocals_synchronized, // method needs locals initialization & is synchronized 61 native, // native method 62 native_synchronized, // native method & is synchronized 63 empty, // empty method (code: _return) 64 getter, // getter method 65 setter, // setter method 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 + (static_cast<int>(vmIntrinsics::LAST_MH_SIG_POLY) 70 - static_cast<int>(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_util_zip_CRC32_update, // implementation of java.util.zip.CRC32.update() 84 java_util_zip_CRC32_updateBytes, // implementation of java.util.zip.CRC32.updateBytes() 85 java_util_zip_CRC32_updateByteBuffer, // implementation of java.util.zip.CRC32.updateByteBuffer() 86 java_util_zip_CRC32C_updateBytes, // implementation of java.util.zip.CRC32C.updateBytes(crc, b[], off, end) 87 java_util_zip_CRC32C_updateDirectByteBuffer, // implementation of java.util.zip.CRC32C.updateDirectByteBuffer(crc, address, off, end) 88 java_lang_Float_intBitsToFloat, // implementation of java.lang.Float.intBitsToFloat() 89 java_lang_Float_floatToRawIntBits, // implementation of java.lang.Float.floatToRawIntBits() 90 java_lang_Double_longBitsToDouble, // implementation of java.lang.Double.longBitsToDouble() 91 java_lang_Double_doubleToRawLongBits, // implementation of java.lang.Double.doubleToRawLongBits() 92 number_of_method_entries, 93 invalid = -1 94 }; 95 96 // Conversion from the part of the above enum to vmIntrinsics::_invokeExact, etc. method_handle_intrinsic(MethodKind kind)97 static vmIntrinsics::ID method_handle_intrinsic(MethodKind kind) { 98 if (kind >= method_handle_invoke_FIRST && kind <= method_handle_invoke_LAST) 99 return vmIntrinsics::ID_from(static_cast<int>(vmIntrinsics::FIRST_MH_SIG_POLY) + (kind - method_handle_invoke_FIRST)); 100 else 101 return vmIntrinsics::_none; 102 } 103 104 enum SomeConstants { 105 number_of_result_handlers = 10 // number of result handlers for native calls 106 }; 107 108 protected: 109 static StubQueue* _code; // the interpreter code (codelets) 110 111 static bool _notice_safepoints; // true if safepoints are activated 112 113 static address _native_entry_begin; // Region for native entry code 114 static address _native_entry_end; 115 116 // method entry points 117 static address _entry_table[number_of_method_entries]; // entry points for a given method 118 static address _cds_entry_table[number_of_method_entries]; // entry points for methods in the CDS archive 119 static address _native_abi_to_tosca[number_of_result_handlers]; // for native method result handlers 120 static address _slow_signature_handler; // the native method generic (slow) signature handler 121 122 static address _rethrow_exception_entry; // rethrows an activation in previous frame 123 124 friend class AbstractInterpreterGenerator; 125 friend class InterpreterMacroAssembler; 126 127 public: 128 // Initialization/debugging 129 static void initialize(); code()130 static StubQueue* code() { return _code; } 131 132 133 // Method activation 134 static MethodKind method_kind(const methodHandle& m); entry_for_kind(MethodKind k)135 static address entry_for_kind(MethodKind k) { assert(0 <= k && k < number_of_method_entries, "illegal kind"); return _entry_table[k]; } entry_for_method(const methodHandle & m)136 static address entry_for_method(const methodHandle& m) { return entry_for_kind(method_kind(m)); } 137 138 // used by class data sharing 139 static address entry_for_cds_method(const methodHandle& m) NOT_CDS_RETURN_(NULL); 140 static address entry_for_cds_method(AbstractInterpreter::MethodKind kind) NOT_CDS_RETURN_(NULL); 141 static void generate_entry_for_cds_method(MethodKind kind) NOT_CDS_RETURN; 142 143 // used for bootstrapping method handles: 144 static void set_entry_for_kind(MethodKind k, address e); 145 146 static void print_method_kind(MethodKind kind) PRODUCT_RETURN; 147 148 // These should never be compiled since the interpreter will prefer 149 // the compiled version to the intrinsic version. can_be_compiled(const methodHandle & m)150 static bool can_be_compiled(const methodHandle& m) { 151 switch (m->intrinsic_id()) { 152 case vmIntrinsics::_dsin : // fall thru 153 case vmIntrinsics::_dcos : // fall thru 154 case vmIntrinsics::_dtan : // fall thru 155 case vmIntrinsics::_dabs : // fall thru 156 case vmIntrinsics::_dsqrt : // fall thru 157 case vmIntrinsics::_dlog : // fall thru 158 case vmIntrinsics::_dlog10: // fall thru 159 case vmIntrinsics::_dpow : // fall thru 160 case vmIntrinsics::_dexp : // fall thru 161 case vmIntrinsics::_fmaD : // fall thru 162 case vmIntrinsics::_fmaF : // fall thru 163 return false; 164 default: 165 return true; 166 } 167 } 168 169 // Runtime support 170 171 // length = invoke bytecode length (to advance to next bytecode) deopt_entry(TosState state,int length)172 static address deopt_entry(TosState state, int length) { ShouldNotReachHere(); return NULL; } return_entry(TosState state,int length,Bytecodes::Code code)173 static address return_entry(TosState state, int length, Bytecodes::Code code) { ShouldNotReachHere(); return NULL; } 174 rethrow_exception_entry()175 static address rethrow_exception_entry() { return _rethrow_exception_entry; } 176 177 // Activation size in words for a method that is just being called. 178 // Parameters haven't been pushed so count them too. 179 static int size_top_interpreter_activation(Method* method); 180 181 // Deoptimization support 182 // Compute the entry address for continuation after 183 static address deopt_continue_after_entry(Method* method, 184 address bcp, 185 int callee_parameters, 186 bool is_top_frame); 187 // Compute the entry address for reexecution 188 static address deopt_reexecute_entry(Method* method, address bcp); 189 // Deoptimization should reexecute this bytecode 190 static bool bytecode_should_reexecute(Bytecodes::Code code); 191 192 // deoptimization support 193 static int size_activation(int max_stack, 194 int temps, 195 int extra_args, 196 int monitors, 197 int callee_params, 198 int callee_locals, 199 bool is_top_frame); 200 201 static void layout_activation(Method* method, 202 int temps, 203 int popframe_args, 204 int monitors, 205 int caller_actual_parameters, 206 int callee_params, 207 int callee_locals, 208 frame* caller, 209 frame* interpreter_frame, 210 bool is_top_frame, 211 bool is_bottom_frame); 212 213 // Runtime support 214 static bool is_not_reached(const methodHandle& method, int bci); 215 // Safepoint support notice_safepoints()216 static void notice_safepoints() { ShouldNotReachHere(); } // stops the thread when reaching a safepoint ignore_safepoints()217 static void ignore_safepoints() { ShouldNotReachHere(); } // ignores safepoints 218 219 // Support for native calls slow_signature_handler()220 static address slow_signature_handler() { return _slow_signature_handler; } result_handler(BasicType type)221 static address result_handler(BasicType type) { return _native_abi_to_tosca[BasicType_as_index(type)]; } 222 static int BasicType_as_index(BasicType type); // computes index into result_handler_by_index table in_native_entry(address pc)223 static bool in_native_entry(address pc) { return _native_entry_begin <= pc && pc < _native_entry_end; } 224 // Debugging/printing 225 static void print(); // prints the interpreter code 226 227 public: 228 // Interpreter helpers 229 const static int stackElementWords = 1; 230 const static int stackElementSize = stackElementWords * wordSize; 231 const static int logStackElementSize = LogBytesPerWord; 232 expr_index_at(int i)233 static int expr_index_at(int i) { 234 return stackElementWords * i; 235 } 236 expr_offset_in_bytes(int i)237 static int expr_offset_in_bytes(int i) { 238 #if !defined(ZERO) && (defined(PPC) || defined(S390)) 239 return stackElementSize * i + wordSize; // both point to one word past TOS 240 #else 241 return stackElementSize * i; 242 #endif 243 } 244 local_index_at(int i)245 static int local_index_at(int i) { 246 assert(i <= 0, "local direction already negated"); 247 return stackElementWords * i; 248 } 249 250 #if !defined(ZERO) && (defined(IA32) || defined(AMD64)) stackElementScale()251 static Address::ScaleFactor stackElementScale() { 252 return NOT_LP64(Address::times_4) LP64_ONLY(Address::times_8); 253 } 254 #endif 255 256 // Local values relative to locals[n] local_offset_in_bytes(int n)257 static int local_offset_in_bytes(int n) { 258 return ((frame::interpreter_frame_expression_stack_direction() * n) * stackElementSize); 259 } 260 261 // access to stacked values according to type: oop_addr_in_slot(intptr_t * slot_addr)262 static oop* oop_addr_in_slot(intptr_t* slot_addr) { 263 return (oop*) slot_addr; 264 } int_addr_in_slot(intptr_t * slot_addr)265 static jint* int_addr_in_slot(intptr_t* slot_addr) { 266 if ((int) sizeof(jint) < wordSize && !Endian::is_Java_byte_ordering_different()) 267 // big-endian LP64 268 return (jint*)(slot_addr + 1) - 1; 269 else 270 return (jint*) slot_addr; 271 } long_in_slot(intptr_t * slot_addr)272 static jlong long_in_slot(intptr_t* slot_addr) { 273 if (sizeof(intptr_t) >= sizeof(jlong)) { 274 return *(jlong*) slot_addr; 275 } else { 276 return Bytes::get_native_u8((address)slot_addr); 277 } 278 } set_long_in_slot(intptr_t * slot_addr,jlong value)279 static void set_long_in_slot(intptr_t* slot_addr, jlong value) { 280 if (sizeof(intptr_t) >= sizeof(jlong)) { 281 *(jlong*) slot_addr = value; 282 } else { 283 Bytes::put_native_u8((address)slot_addr, value); 284 } 285 } 286 287 static void initialize_method_handle_entries(); 288 }; 289 290 //------------------------------------------------------------------------------------------------------------------------ 291 // The interpreter generator. 292 293 class Template; 294 class AbstractInterpreterGenerator: public StackObj { 295 protected: 296 InterpreterMacroAssembler* _masm; 297 298 public: 299 AbstractInterpreterGenerator(StubQueue* _code); 300 }; 301 302 #endif // SHARE_INTERPRETER_ABSTRACTINTERPRETER_HPP 303