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