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