1/*
2 * Copyright (c) 1997, 2019, 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 "code/stubs.hpp"
30#include "interpreter/bytecodes.hpp"
31#include "runtime/frame.hpp"
32#include "runtime/thread.hpp"
33#include "runtime/vmThread.hpp"
34
35// This file contains the platform-independent parts
36// of the abstract interpreter and the abstract interpreter generator.
37
38// Organization of the interpreter(s). There exists two different interpreters in hotpot
39// an assembly language version (aka template interpreter) and a high level language version
40// (aka c++ interpreter). Th division of labor is as follows:
41
42// Template Interpreter C++ Interpreter Functionality
43//
44// templateTable* bytecodeInterpreter* actual interpretation of bytecodes
45//
46// templateInterpreter* cppInterpreter* generation of assembly code that creates
47// and manages interpreter runtime frames.
48// Also code for populating interpreter
49// frames created during deoptimization.
50//
51
52class InterpreterMacroAssembler;
53
54class AbstractInterpreter: AllStatic {
55 friend class VMStructs;
56 friend class CppInterpreterGenerator;
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 accessor, // accessor method (code: _aload_0, _getfield, _(a|i)return)
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 + (vmIntrinsics::LAST_MH_SIG_POLY
70 - 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.
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)( 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();
130 static StubQueue* code() { return _code; }
131
132
133 // Method activation
134 static MethodKind method_kind(const methodHandle& m);
135 static address entry_for_kind(MethodKind k) { assert(0 <= k && k < number_of_method_entries, "illegal kind"); return _entry_table[k]; }
136 static address entry_for_method(const methodHandle& m) { return entry_for_kind(method_kind(m)); }
137
138 static address entry_for_cds_method(const methodHandle& m) {
139 MethodKind k = method_kind(m);
140 assert(0 <= k && k < number_of_method_entries, "illegal kind");
141 return _cds_entry_table[k];
142 }
143
144 // used by class data sharing
145 static void update_cds_entry_table(MethodKind kind) NOT_CDS_RETURN;
146
147 static address get_trampoline_code_buffer(AbstractInterpreter::MethodKind kind) NOT_CDS_RETURN_(0);
148
149 // used for bootstrapping method handles:
150 static void set_entry_for_kind(MethodKind k, address e);
151
152 static void print_method_kind(MethodKind kind) PRODUCT_RETURN;
153
154 // These should never be compiled since the interpreter will prefer
155 // the compiled version to the intrinsic version.
156 static bool can_be_compiled(const methodHandle& m) {
157 switch (m->intrinsic_id()) {
158 case vmIntrinsics::_dsin : // fall thru
159 case vmIntrinsics::_dcos : // fall thru
160 case vmIntrinsics::_dtan : // fall thru
161 case vmIntrinsics::_dabs : // fall thru
162 case vmIntrinsics::_dsqrt : // fall thru
163 case vmIntrinsics::_dlog : // fall thru
164 case vmIntrinsics::_dlog10: // fall thru
165 case vmIntrinsics::_dpow : // fall thru
166 case vmIntrinsics::_dexp : // fall thru
167 case vmIntrinsics::_fmaD : // fall thru
168 case vmIntrinsics::_fmaF : // fall thru
169 return false;
170 default:
171 return true;
172 }
173 }
174
175 // Runtime support
176
177 // length = invoke bytecode length (to advance to next bytecode)
178 static address deopt_entry(TosState state, int length) { ShouldNotReachHere(); return NULL; }
179 static address return_entry(TosState state, int length, Bytecodes::Code code) { ShouldNotReachHere(); return NULL; }
180
181 static address rethrow_exception_entry() { return _rethrow_exception_entry; }
182
183 // Activation size in words for a method that is just being called.
184 // Parameters haven't been pushed so count them too.
185 static int size_top_interpreter_activation(Method* method);
186
187 // Deoptimization support
188 // Compute the entry address for continuation after
189 static address deopt_continue_after_entry(Method* method,
190 address bcp,
191 int callee_parameters,
192 bool is_top_frame);
193 // Compute the entry address for reexecution
194 static address deopt_reexecute_entry(Method* method, address bcp);
195 // Deoptimization should reexecute this bytecode
196 static bool bytecode_should_reexecute(Bytecodes::Code code);
197
198 // deoptimization support
199 static int size_activation(int max_stack,
200 int temps,
201 int extra_args,
202 int monitors,
203 int callee_params,
204 int callee_locals,
205 bool is_top_frame);
206
207 static void layout_activation(Method* method,
208 int temps,
209 int popframe_args,
210 int monitors,
211 int caller_actual_parameters,
212 int callee_params,
213 int callee_locals,
214 frame* caller,
215 frame* interpreter_frame,
216 bool is_top_frame,
217 bool is_bottom_frame);
218
219 // Runtime support
220 static bool is_not_reached(const methodHandle& method, int bci);
221 // Safepoint support
222 static void notice_safepoints() { ShouldNotReachHere(); } // stops the thread when reaching a safepoint
223 static void ignore_safepoints() { ShouldNotReachHere(); } // ignores safepoints
224
225 // Support for native calls
226 static address slow_signature_handler() { return _slow_signature_handler; }
227 static address result_handler(BasicType type) { return _native_abi_to_tosca[BasicType_as_index(type)]; }
228 static int BasicType_as_index(BasicType type); // computes index into result_handler_by_index table
229 static bool in_native_entry(address pc) { return _native_entry_begin <= pc && pc < _native_entry_end; }
230 // Debugging/printing
231 static void print(); // prints the interpreter code
232
233 public:
234 // Interpreter helpers
235 const static int stackElementWords = 1;
236 const static int stackElementSize = stackElementWords * wordSize;
237 const static int logStackElementSize = LogBytesPerWord;
238
239 static int expr_index_at(int i) {
240 return stackElementWords * i;
241 }
242
243 static int expr_offset_in_bytes(int i) {
244#if !defined(ZERO) && (defined(PPC) || defined(S390) || defined(SPARC))
245 return stackElementSize * i + wordSize; // both point to one word past TOS
246#else
247 return stackElementSize * i;
248#endif
249 }
250
251 static int local_index_at(int i) {
252 assert(i <= 0, "local direction already negated");
253 return stackElementWords * i;
254 }
255
256#if !defined(ZERO) && (defined(IA32) || defined(AMD64))
257 static Address::ScaleFactor stackElementScale() {
258 return NOT_LP64(Address::times_4) LP64_ONLY(Address::times_8);
259 }
260#endif
261
262 // Local values relative to locals[n]
263 static int local_offset_in_bytes(int n) {
264 return ((frame::interpreter_frame_expression_stack_direction() * n) * stackElementSize);
265 }
266
267 // access to stacked values according to type:
268 static oop* oop_addr_in_slot(intptr_t* slot_addr) {
269 return (oop*) slot_addr;
270 }
271 static jint* int_addr_in_slot(intptr_t* slot_addr) {
272 if ((int) sizeof(jint) < wordSize && !Endian::is_Java_byte_ordering_different())
273 // big-endian LP64
274 return (jint*)(slot_addr + 1) - 1;
275 else
276 return (jint*) slot_addr;
277 }
278 static jlong long_in_slot(intptr_t* slot_addr) {
279 if (sizeof(intptr_t) >= sizeof(jlong)) {
280 return *(jlong*) slot_addr;
281 } else {
282 return Bytes::get_native_u8((address)slot_addr);
283 }
284 }
285 static void set_long_in_slot(intptr_t* slot_addr, jlong value) {
286 if (sizeof(intptr_t) >= sizeof(jlong)) {
287 *(jlong*) slot_addr = value;
288 } else {
289 Bytes::put_native_u8((address)slot_addr, value);
290 }
291 }
292 static void get_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
293 switch (type) {
294 case T_BOOLEAN: value->z = *int_addr_in_slot(slot_addr); break;
295 case T_CHAR: value->c = *int_addr_in_slot(slot_addr); break;
296 case T_BYTE: value->b = *int_addr_in_slot(slot_addr); break;
297 case T_SHORT: value->s = *int_addr_in_slot(slot_addr); break;
298 case T_INT: value->i = *int_addr_in_slot(slot_addr); break;
299 case T_LONG: value->j = long_in_slot(slot_addr); break;
300 case T_FLOAT: value->f = *(jfloat*)int_addr_in_slot(slot_addr); break;
301 case T_DOUBLE: value->d = jdouble_cast(long_in_slot(slot_addr)); break;
302 case T_OBJECT: value->l = (jobject)*oop_addr_in_slot(slot_addr); break;
303 default: ShouldNotReachHere();
304 }
305 }
306 static void set_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
307 switch (type) {
308 case T_BOOLEAN: *int_addr_in_slot(slot_addr) = (value->z != 0); break;
309 case T_CHAR: *int_addr_in_slot(slot_addr) = value->c; break;
310 case T_BYTE: *int_addr_in_slot(slot_addr) = value->b; break;
311 case T_SHORT: *int_addr_in_slot(slot_addr) = value->s; break;
312 case T_INT: *int_addr_in_slot(slot_addr) = value->i; break;
313 case T_LONG: set_long_in_slot(slot_addr, value->j); break;
314 case T_FLOAT: *(jfloat*)int_addr_in_slot(slot_addr) = value->f; break;
315 case T_DOUBLE: set_long_in_slot(slot_addr, jlong_cast(value->d)); break;
316 case T_OBJECT: *oop_addr_in_slot(slot_addr) = (oop) value->l; break;
317 default: ShouldNotReachHere();
318 }
319 }
320
321 static void initialize_method_handle_entries();
322};
323
324//------------------------------------------------------------------------------------------------------------------------
325// The interpreter generator.
326
327class Template;
328class AbstractInterpreterGenerator: public StackObj {
329 protected:
330 InterpreterMacroAssembler* _masm;
331
332 public:
333 AbstractInterpreterGenerator(StubQueue* _code);
334};
335
336#endif // SHARE_INTERPRETER_ABSTRACTINTERPRETER_HPP
337