1 /* 2 * Copyright (c) 1997, 2023, 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 "oops/method.hpp" 33 #include "runtime/frame.hpp" 34 #include "runtime/javaThread.hpp" 35 #include "runtime/vmThread.hpp" 36 37 // This file contains the platform-independent parts 38 // of the abstract interpreter and the abstract interpreter generator. 39 40 // Organization of the interpreter(s). There exists two different interpreters in hotpot 41 // an assembly language version (aka template interpreter) and a high level language version 42 // (aka c++ interpreter). Th division of labor is as follows: 43 44 // Template Interpreter Zero Interpreter Functionality 45 // 46 // templateTable* bytecodeInterpreter* actual interpretation of bytecodes 47 // 48 // templateInterpreter* zeroInterpreter* generation of assembly code that creates 49 // and manages interpreter runtime frames. 50 // 51 52 class InterpreterMacroAssembler; 53 54 class AbstractInterpreter: AllStatic { 55 friend class VMStructs; 56 friend class ZeroInterpreterGenerator; 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 getter, // getter method 66 setter, // setter method 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 + (static_cast<int>(vmIntrinsics::LAST_MH_SIG_POLY) 71 - static_cast<int>(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_sqrt_strict, // implementation of java.lang.StrictMath.sqrt(x) 78 java_lang_math_log, // implementation of java.lang.Math.log (x) 79 java_lang_math_log10, // implementation of java.lang.Math.log10 (x) 80 java_lang_math_pow, // implementation of java.lang.Math.pow (x,y) 81 java_lang_math_exp, // implementation of java.lang.Math.exp (x) 82 java_lang_math_fmaF, // implementation of java.lang.Math.fma (x, y, z) 83 java_lang_math_fmaD, // implementation of java.lang.Math.fma (x, y, z) 84 java_lang_ref_reference_get, // implementation of java.lang.ref.Reference.get() 85 java_util_zip_CRC32_update, // implementation of java.util.zip.CRC32.update() 86 java_util_zip_CRC32_updateBytes, // implementation of java.util.zip.CRC32.updateBytes() 87 java_util_zip_CRC32_updateByteBuffer, // implementation of java.util.zip.CRC32.updateByteBuffer() 88 java_util_zip_CRC32C_updateBytes, // implementation of java.util.zip.CRC32C.updateBytes(crc, b[], off, end) 89 java_util_zip_CRC32C_updateDirectByteBuffer, // implementation of java.util.zip.CRC32C.updateDirectByteBuffer(crc, address, off, end) 90 java_lang_Float_intBitsToFloat, // implementation of java.lang.Float.intBitsToFloat() 91 java_lang_Float_floatToRawIntBits, // implementation of java.lang.Float.floatToRawIntBits() 92 java_lang_Float_float16ToFloat, // implementation of java.lang.Float.float16ToFloat() 93 java_lang_Float_floatToFloat16, // implementation of java.lang.Float.floatToFloat16() 94 java_lang_Double_longBitsToDouble, // implementation of java.lang.Double.longBitsToDouble() 95 java_lang_Double_doubleToRawLongBits, // implementation of java.lang.Double.doubleToRawLongBits() 96 java_lang_Thread_currentThread, // implementation of java.lang.Thread.currentThread() 97 number_of_method_entries, 98 invalid = -1 99 }; 100 101 // Conversion from the part of the above enum to vmIntrinsics::_invokeExact, etc. 102 static vmIntrinsics::ID method_handle_intrinsic(MethodKind kind) { 103 if (kind >= method_handle_invoke_FIRST && kind <= method_handle_invoke_LAST) 104 return vmIntrinsics::ID_from(static_cast<int>(vmIntrinsics::FIRST_MH_SIG_POLY) + (kind - method_handle_invoke_FIRST)); 105 else 106 return vmIntrinsics::_none; 107 } 108 109 // Conversion from the above enum to vmIntrinsics::ID 110 static vmIntrinsics::ID method_intrinsic(MethodKind kind); 111 112 enum SomeConstants { 113 number_of_result_handlers = 11 // number of result handlers for native calls 114 }; 115 116 protected: 117 static StubQueue* _code; // the interpreter code (codelets) 118 119 static bool _notice_safepoints; // true if safepoints are activated 120 121 // method entry points 122 static address _entry_table[number_of_method_entries]; // entry points for a given method 123 static address _native_abi_to_tosca[number_of_result_handlers]; // for native method result handlers 124 static address _slow_signature_handler; // the native method generic (slow) signature handler 125 126 static address _rethrow_exception_entry; // rethrows an activation in previous frame 127 128 friend class AbstractInterpreterGenerator; 129 friend class InterpreterMacroAssembler; 130 131 public: 132 // Initialization/debugging 133 static void initialize(); 134 static StubQueue* code() { return _code; } 135 136 137 // Method activation 138 static MethodKind method_kind(const methodHandle& m); 139 static address entry_for_kind(MethodKind k) { assert(0 <= k && k < number_of_method_entries, "illegal kind"); return _entry_table[k]; } 140 static address entry_for_method(const methodHandle& m) { return entry_for_kind(method_kind(m)); } 141 142 // used for bootstrapping method handles: 143 static void set_entry_for_kind(MethodKind k, address e); 144 145 static void print_method_kind(MethodKind kind) PRODUCT_RETURN; 146 147 // These should never be compiled since the interpreter will prefer 148 // the compiled version to the intrinsic version. 149 static bool can_be_compiled(const methodHandle& m) { 150 switch (m->intrinsic_id()) { 151 case vmIntrinsics::_dsin : // fall thru 152 case vmIntrinsics::_dcos : // fall thru 153 case vmIntrinsics::_dtan : // fall thru 154 case vmIntrinsics::_dabs : // fall thru 155 case vmIntrinsics::_dsqrt : // fall thru 156 case vmIntrinsics::_dsqrt_strict : // 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 case vmIntrinsics::_floatToFloat16 : // fall thru 164 case vmIntrinsics::_float16ToFloat : // fall thru 165 case vmIntrinsics::_Continuation_doYield : // fall thru 166 return false; 167 168 default: 169 return true; 170 } 171 } 172 173 // Runtime support 174 175 // length = invoke bytecode length (to advance to next bytecode) 176 static address deopt_entry(TosState state, int length) { ShouldNotReachHere(); return nullptr; } 177 static address return_entry(TosState state, int length, Bytecodes::Code code) { ShouldNotReachHere(); return nullptr; } 178 179 static address rethrow_exception_entry() { return _rethrow_exception_entry; } 180 181 // Activation size in words for a method that is just being called. 182 // Parameters haven't been pushed so count them too. 183 static int size_top_interpreter_activation(Method* method); 184 185 // Deoptimization support 186 // Compute the entry address for continuation after 187 static address deopt_continue_after_entry(Method* method, 188 address bcp, 189 int callee_parameters, 190 bool is_top_frame); 191 // Compute the entry address for reexecution 192 static address deopt_reexecute_entry(Method* method, address bcp); 193 // Deoptimization should reexecute this bytecode 194 static bool bytecode_should_reexecute(Bytecodes::Code code); 195 196 // deoptimization support 197 static int size_activation(int max_stack, 198 int temps, 199 int extra_args, 200 int monitors, 201 int callee_params, 202 int callee_locals, 203 bool is_top_frame); 204 205 static void layout_activation(Method* method, 206 int temps, 207 int popframe_args, 208 int monitors, 209 int caller_actual_parameters, 210 int callee_params, 211 int callee_locals, 212 frame* caller, 213 frame* interpreter_frame, 214 bool is_top_frame, 215 bool is_bottom_frame); 216 217 // Runtime support 218 static bool is_not_reached(const methodHandle& method, int bci); 219 // Safepoint support 220 static void notice_safepoints() { ShouldNotReachHere(); } // stops the thread when reaching a safepoint 221 static void ignore_safepoints() { ShouldNotReachHere(); } // ignores safepoints 222 223 // Support for native calls 224 static address slow_signature_handler() { return _slow_signature_handler; } 225 static address result_handler(BasicType type) { return _native_abi_to_tosca[BasicType_as_index(type)]; } 226 static int BasicType_as_index(BasicType type); // computes index into result_handler_by_index table 227 // Debugging/printing 228 static void print(); // prints the interpreter code 229 230 public: 231 // Interpreter helpers 232 const static int stackElementWords = 1; 233 const static int stackElementSize = stackElementWords * wordSize; 234 const static int logStackElementSize = LogBytesPerWord; 235 236 static int expr_index_at(int i) { 237 return stackElementWords * i; 238 } 239 240 static int expr_offset_in_bytes(int i) { 241 #if !defined(ZERO) && (defined(PPC) || defined(S390)) 242 return stackElementSize * i + wordSize; // both point to one word past TOS 243 #else 244 return stackElementSize * i; 245 #endif 246 } 247 248 static int local_index_at(int i) { 249 assert(i <= 0, "local direction already negated"); 250 return stackElementWords * i; 251 } 252 253 #if !defined(ZERO) && (defined(IA32) || defined(AMD64)) 254 static Address::ScaleFactor stackElementScale() { 255 return NOT_LP64(Address::times_4) LP64_ONLY(Address::times_8); 256 } 257 #endif 258 259 // Local values relative to locals[n] 260 static int local_offset_in_bytes(int n) { 261 return ((frame::interpreter_frame_expression_stack_direction() * n) * stackElementSize); 262 } 263 264 // access to stacked values according to type: 265 static oop* oop_addr_in_slot(intptr_t* slot_addr) { 266 return (oop*) slot_addr; 267 } 268 static jint* int_addr_in_slot(intptr_t* slot_addr) { 269 if ((int) sizeof(jint) < wordSize && !Endian::is_Java_byte_ordering_different()) 270 // big-endian LP64 271 return (jint*)(slot_addr + 1) - 1; 272 else 273 return (jint*) slot_addr; 274 } 275 static jlong long_in_slot(intptr_t* slot_addr) { 276 if (sizeof(intptr_t) >= sizeof(jlong)) { 277 return *(jlong*) slot_addr; 278 } else { 279 return Bytes::get_native_u8((address)slot_addr); 280 } 281 } 282 static void set_long_in_slot(intptr_t* slot_addr, jlong value) { 283 if (sizeof(intptr_t) >= sizeof(jlong)) { 284 *(jlong*) slot_addr = value; 285 } else { 286 Bytes::put_native_u8((address)slot_addr, value); 287 } 288 } 289 290 static void initialize_method_handle_entries(); 291 }; 292 293 //------------------------------------------------------------------------------------------------------------------------ 294 // The interpreter generator. 295 296 class Template; 297 class AbstractInterpreterGenerator: public StackObj { 298 protected: 299 InterpreterMacroAssembler* _masm; 300 301 public: 302 AbstractInterpreterGenerator(); 303 }; 304 305 #endif // SHARE_INTERPRETER_ABSTRACTINTERPRETER_HPP