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