1/* 2 * Copyright (c) 1997, 2016, 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 51class InterpreterMacroAssembler; 52 53class 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(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(methodHandle m) { return entry_for_kind(method_kind(m)); } 136 137 static address entry_for_cds_method(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 static bool can_be_compiled(methodHandle m); 154 155 // Runtime support 156 157 // length = invoke bytecode length (to advance to next bytecode) 158 static address deopt_entry(TosState state, int length) { ShouldNotReachHere(); return NULL; } 159 static address return_entry(TosState state, int length, Bytecodes::Code code) { ShouldNotReachHere(); return NULL; } 160 161 static address rethrow_exception_entry() { return _rethrow_exception_entry; } 162 163 // Activation size in words for a method that is just being called. 164 // Parameters haven't been pushed so count them too. 165 static int size_top_interpreter_activation(Method* method); 166 167 // Deoptimization support 168 // Compute the entry address for continuation after 169 static address deopt_continue_after_entry(Method* method, 170 address bcp, 171 int callee_parameters, 172 bool is_top_frame); 173 // Compute the entry address for reexecution 174 static address deopt_reexecute_entry(Method* method, address bcp); 175 // Deoptimization should reexecute this bytecode 176 static bool bytecode_should_reexecute(Bytecodes::Code code); 177 178 // deoptimization support 179 static int size_activation(int max_stack, 180 int temps, 181 int extra_args, 182 int monitors, 183 int callee_params, 184 int callee_locals, 185 bool is_top_frame); 186 187 static void layout_activation(Method* method, 188 int temps, 189 int popframe_args, 190 int monitors, 191 int caller_actual_parameters, 192 int callee_params, 193 int callee_locals, 194 frame* caller, 195 frame* interpreter_frame, 196 bool is_top_frame, 197 bool is_bottom_frame); 198 199 // Runtime support 200 static bool is_not_reached(const methodHandle& method, int bci); 201 // Safepoint support 202 static void notice_safepoints() { ShouldNotReachHere(); } // stops the thread when reaching a safepoint 203 static void ignore_safepoints() { ShouldNotReachHere(); } // ignores safepoints 204 205 // Support for native calls 206 static address slow_signature_handler() { return _slow_signature_handler; } 207 static address result_handler(BasicType type) { return _native_abi_to_tosca[BasicType_as_index(type)]; } 208 static int BasicType_as_index(BasicType type); // computes index into result_handler_by_index table 209 static bool in_native_entry(address pc) { return _native_entry_begin <= pc && pc < _native_entry_end; } 210 // Debugging/printing 211 static void print(); // prints the interpreter code 212 213 public: 214 // Interpreter helpers 215 const static int stackElementWords = 1; 216 const static int stackElementSize = stackElementWords * wordSize; 217 const static int logStackElementSize = LogBytesPerWord; 218 219 static int expr_index_at(int i) { 220 return stackElementWords * i; 221 } 222 223 static int expr_offset_in_bytes(int i) { 224#if !defined(ZERO) && (defined(PPC) || defined(S390) || defined(SPARC)) 225 return stackElementSize * i + wordSize; // both point to one word past TOS 226#else 227 return stackElementSize * i; 228#endif 229 } 230 231 static int local_index_at(int i) { 232 assert(i <= 0, "local direction already negated"); 233 return stackElementWords * i; 234 } 235 236#if !defined(ZERO) && (defined(IA32) || defined(AMD64)) 237 static Address::ScaleFactor stackElementScale() { 238 return NOT_LP64(Address::times_4) LP64_ONLY(Address::times_8); 239 } 240#endif 241 242 // Local values relative to locals[n] 243 static int local_offset_in_bytes(int n) { 244 return ((frame::interpreter_frame_expression_stack_direction() * n) * stackElementSize); 245 } 246 247 // access to stacked values according to type: 248 static oop* oop_addr_in_slot(intptr_t* slot_addr) { 249 return (oop*) slot_addr; 250 } 251 static jint* int_addr_in_slot(intptr_t* slot_addr) { 252 if ((int) sizeof(jint) < wordSize && !Bytes::is_Java_byte_ordering_different()) 253 // big-endian LP64 254 return (jint*)(slot_addr + 1) - 1; 255 else 256 return (jint*) slot_addr; 257 } 258 static jlong long_in_slot(intptr_t* slot_addr) { 259 if (sizeof(intptr_t) >= sizeof(jlong)) { 260 return *(jlong*) slot_addr; 261 } else { 262 return Bytes::get_native_u8((address)slot_addr); 263 } 264 } 265 static void set_long_in_slot(intptr_t* slot_addr, jlong value) { 266 if (sizeof(intptr_t) >= sizeof(jlong)) { 267 *(jlong*) slot_addr = value; 268 } else { 269 Bytes::put_native_u8((address)slot_addr, value); 270 } 271 } 272 static void get_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) { 273 switch (type) { 274 case T_BOOLEAN: value->z = *int_addr_in_slot(slot_addr); break; 275 case T_CHAR: value->c = *int_addr_in_slot(slot_addr); break; 276 case T_BYTE: value->b = *int_addr_in_slot(slot_addr); break; 277 case T_SHORT: value->s = *int_addr_in_slot(slot_addr); break; 278 case T_INT: value->i = *int_addr_in_slot(slot_addr); break; 279 case T_LONG: value->j = long_in_slot(slot_addr); break; 280 case T_FLOAT: value->f = *(jfloat*)int_addr_in_slot(slot_addr); break; 281 case T_DOUBLE: value->d = jdouble_cast(long_in_slot(slot_addr)); break; 282 case T_OBJECT: value->l = (jobject)*oop_addr_in_slot(slot_addr); break; 283 default: ShouldNotReachHere(); 284 } 285 } 286 static void set_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) { 287 switch (type) { 288 case T_BOOLEAN: *int_addr_in_slot(slot_addr) = (value->z != 0); break; 289 case T_CHAR: *int_addr_in_slot(slot_addr) = value->c; break; 290 case T_BYTE: *int_addr_in_slot(slot_addr) = value->b; break; 291 case T_SHORT: *int_addr_in_slot(slot_addr) = value->s; break; 292 case T_INT: *int_addr_in_slot(slot_addr) = value->i; break; 293 case T_LONG: set_long_in_slot(slot_addr, value->j); break; 294 case T_FLOAT: *(jfloat*)int_addr_in_slot(slot_addr) = value->f; break; 295 case T_DOUBLE: set_long_in_slot(slot_addr, jlong_cast(value->d)); break; 296 case T_OBJECT: *oop_addr_in_slot(slot_addr) = (oop) value->l; break; 297 default: ShouldNotReachHere(); 298 } 299 } 300 301 static void initialize_method_handle_entries(); 302}; 303 304//------------------------------------------------------------------------------------------------------------------------ 305// The interpreter generator. 306 307class Template; 308class AbstractInterpreterGenerator: public StackObj { 309 protected: 310 InterpreterMacroAssembler* _masm; 311 312 public: 313 AbstractInterpreterGenerator(StubQueue* _code); 314}; 315 316#endif // SHARE_VM_INTERPRETER_ABSTRACTINTERPRETER_HPP 317