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 #include "compiler/disassembler.hpp"
26 #include "interpreter/interpreter.hpp"
27 #include "interpreter/interpreterRuntime.hpp"
28 #include "interpreter/interp_masm.hpp"
29 #include "interpreter/templateInterpreter.hpp"
30 #include "interpreter/templateInterpreterGenerator.hpp"
31 #include "interpreter/templateTable.hpp"
32 #include "oops/methodData.hpp"
33
34 #define __ Disassembler::hook<InterpreterMacroAssembler>(__FILE__, __LINE__, _masm)->
35
36 TemplateInterpreterGenerator::TemplateInterpreterGenerator(): AbstractInterpreterGenerator() {
37 _unimplemented_bytecode = nullptr;
38 _illegal_bytecode_sequence = nullptr;
39 generate_all();
40 }
41
42 static const BasicType types[Interpreter::number_of_result_handlers] = {
43 T_BOOLEAN,
44 T_CHAR ,
45 T_BYTE ,
46 T_SHORT ,
47 T_INT ,
48 T_LONG ,
49 T_VOID ,
50 T_FLOAT ,
51 T_DOUBLE ,
52 T_OBJECT
53 };
54
55 void TemplateInterpreterGenerator::generate_all() {
56 { CodeletMark cm(_masm, "slow signature handler");
57 AbstractInterpreter::_slow_signature_handler = generate_slow_signature_handler();
58 }
59
60 { CodeletMark cm(_masm, "error exits");
61 _unimplemented_bytecode = generate_error_exit("unimplemented bytecode");
62 _illegal_bytecode_sequence = generate_error_exit("illegal bytecode sequence - method not verified");
63 }
64
65 #ifndef PRODUCT
66 if (TraceBytecodes) {
67 CodeletMark cm(_masm, "bytecode tracing support");
68 Interpreter::_trace_code =
69 EntryPoint(
70 generate_trace_code(atos),
71 generate_trace_code(itos),
72 generate_trace_code(ltos),
73 generate_trace_code(ftos),
74 generate_trace_code(dtos),
75 generate_trace_code(vtos)
76 );
77 }
78 #endif // !PRODUCT
79
80 { CodeletMark cm(_masm, "return entry points");
81 Interpreter::_return_entry[0] = EntryPoint();
82 for (int i = 1; i < Interpreter::number_of_return_entries; i++) {
83 Interpreter::_return_entry[i] =
84 EntryPoint(
85 generate_return_entry_for(atos, i, sizeof(u2)),
86 generate_return_entry_for(itos, i, sizeof(u2)),
87 generate_return_entry_for(ltos, i, sizeof(u2)),
88 generate_return_entry_for(ftos, i, sizeof(u2)),
89 generate_return_entry_for(dtos, i, sizeof(u2)),
90 generate_return_entry_for(vtos, i, sizeof(u2))
91 );
92 }
93 }
94
95 { CodeletMark cm(_masm, "invoke return entry points");
96 // These states are in order specified in TosState, except btos/ztos/ctos/stos which
97 // are the same as itos since there is no top of stack optimization for these types
98 const TosState states[] = {ilgl, ilgl, ilgl, ilgl, itos, ltos, ftos, dtos, atos, vtos, ilgl};
99 const int invoke_length = Bytecodes::length_for(Bytecodes::_invokestatic);
100 const int invokeinterface_length = Bytecodes::length_for(Bytecodes::_invokeinterface);
101 const int invokedynamic_length = Bytecodes::length_for(Bytecodes::_invokedynamic);
102
103 assert(invoke_length >= 0 && invoke_length < Interpreter::number_of_return_entries, "invariant");
104 assert(invokeinterface_length >= 0 && invokeinterface_length < Interpreter::number_of_return_entries, "invariant");
105
106 for (int i = itos; i < Interpreter::number_of_return_addrs; i++) {
107 TosState state = states[i];
108 assert(state != ilgl, "states array is wrong above");
109
110 // Reuse generated entry points
111 Interpreter::_invoke_return_entry[i] = Interpreter::_return_entry[invoke_length].entry(state);
112 Interpreter::_invokeinterface_return_entry[i] = Interpreter::_return_entry[invokeinterface_length].entry(state);
113
114 Interpreter::_invokedynamic_return_entry[i] = generate_return_entry_for(state, invokedynamic_length, sizeof(u4));
115 }
116
117 // set itos entry points for btos/ztos/ctos/stos
118 for (int i = 0; i < itos; i++) {
119 Interpreter::_invoke_return_entry[i] = Interpreter::_invoke_return_entry[itos];
120 Interpreter::_invokeinterface_return_entry[i] = Interpreter::_invokeinterface_return_entry[itos];
121 Interpreter::_invokedynamic_return_entry[i] = Interpreter::_invokedynamic_return_entry[itos];
122 }
123 }
124
125 { CodeletMark cm(_masm, "earlyret entry points");
126 Interpreter::_earlyret_entry =
127 EntryPoint(
128 generate_earlyret_entry_for(atos),
129 generate_earlyret_entry_for(itos),
130 generate_earlyret_entry_for(ltos),
131 generate_earlyret_entry_for(ftos),
132 generate_earlyret_entry_for(dtos),
133 generate_earlyret_entry_for(vtos)
134 );
135 }
136
137 { CodeletMark cm(_masm, "result handlers for native calls");
138 // The various result converter stublets.
139 int is_generated[Interpreter::number_of_result_handlers];
140 memset(is_generated, 0, sizeof(is_generated));
141
142 for (int i = 0; i < Interpreter::number_of_result_handlers; i++) {
143 BasicType type = types[i];
144 if (!is_generated[Interpreter::BasicType_as_index(type)]++) {
145 Interpreter::_native_abi_to_tosca[Interpreter::BasicType_as_index(type)] = generate_result_handler_for(type);
146 }
147 }
148 }
149
150
151 { CodeletMark cm(_masm, "safepoint entry points");
152 Interpreter::_safept_entry =
153 EntryPoint(
154 generate_safept_entry_for(atos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
155 generate_safept_entry_for(itos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
156 generate_safept_entry_for(ltos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
157 generate_safept_entry_for(ftos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
158 generate_safept_entry_for(dtos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
159 generate_safept_entry_for(vtos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint))
160 );
161 }
162
163 { CodeletMark cm(_masm, "exception handling");
164 // (Note: this is not safepoint safe because thread may return to compiled code)
165 generate_throw_exception();
166 }
167
168 { CodeletMark cm(_masm, "throw exception entrypoints");
169 Interpreter::_throw_ArrayIndexOutOfBoundsException_entry = generate_ArrayIndexOutOfBounds_handler();
170 Interpreter::_throw_ArrayStoreException_entry = generate_klass_exception_handler("java/lang/ArrayStoreException");
171 Interpreter::_throw_ArithmeticException_entry = generate_exception_handler("java/lang/ArithmeticException", "/ by zero");
172 Interpreter::_throw_ClassCastException_entry = generate_ClassCastException_handler();
173 Interpreter::_throw_NullPointerException_entry = generate_exception_handler("java/lang/NullPointerException", nullptr);
174 Interpreter::_throw_StackOverflowError_entry = generate_StackOverflowError_handler();
175 }
176
177 { CodeletMark cm(_masm, "preemption resume adapter");
178 Interpreter::_cont_resume_interpreter_adapter = generate_cont_resume_interpreter_adapter();
179 }
180
181 #define method_entry(kind) \
182 { CodeletMark cm(_masm, "method entry point (kind = " #kind ")"); \
183 Interpreter::_entry_table[Interpreter::kind] = generate_method_entry(Interpreter::kind, false); \
184 }
185
186 // all non-native method kinds
187 method_entry(zerolocals)
188 method_entry(zerolocals_synchronized)
189 method_entry(empty)
190 method_entry(getter)
191 method_entry(setter)
192 method_entry(abstract)
193 method_entry(java_lang_math_sin )
194 method_entry(java_lang_math_cos )
195 method_entry(java_lang_math_tan )
196 method_entry(java_lang_math_tanh )
197 method_entry(java_lang_math_abs )
198 method_entry(java_lang_math_sqrt )
199 method_entry(java_lang_math_sqrt_strict)
200 method_entry(java_lang_math_log )
201 method_entry(java_lang_math_log10)
202 method_entry(java_lang_math_exp )
203 method_entry(java_lang_math_pow )
204 method_entry(java_lang_math_fmaF )
205 method_entry(java_lang_math_fmaD )
206 method_entry(java_lang_ref_reference_get)
207 AbstractInterpreter::initialize_method_handle_entries();
208
209 method_entry(java_util_zip_CRC32C_updateBytes)
210 method_entry(java_util_zip_CRC32C_updateDirectByteBuffer)
211
212 method_entry(java_lang_Float_float16ToFloat);
213 method_entry(java_lang_Float_floatToFloat16);
214
215 #undef method_entry
216
217 // all native method kinds
218 #define native_method_entry(kind) \
219 { CodeletMark cm(_masm, "native method entry point (kind = " #kind ")"); \
220 Interpreter::_entry_table[Interpreter::kind] = generate_method_entry(Interpreter::kind, true); \
221 }
222
223 native_method_entry(native)
224 native_method_entry(native_synchronized)
225
226 // Entries to intrinsics for native methods should follow
227 // entries for `native` methods to use the same address in case
228 // intrinsic is disabled.
229 native_method_entry(java_lang_Thread_currentThread)
230
231 native_method_entry(java_util_zip_CRC32_update)
232 native_method_entry(java_util_zip_CRC32_updateBytes)
233 native_method_entry(java_util_zip_CRC32_updateByteBuffer)
234
235 #undef native_method_entry
236
237 // Bytecodes
238 set_entry_points_for_all_bytes();
239
240 // installation of code in other places in the runtime
241 set_safepoints_for_all_bytes();
242
243 { CodeletMark cm(_masm, "deoptimization entry points");
244 Interpreter::_deopt_entry[0] = EntryPoint();
245 Interpreter::_deopt_entry[0].set_entry(vtos, generate_deopt_entry_for(vtos, 0));
246 for (int i = 1; i < Interpreter::number_of_deopt_entries; i++) {
247 Interpreter::_deopt_entry[i] =
248 EntryPoint(
249 generate_deopt_entry_for(atos, i),
250 generate_deopt_entry_for(itos, i),
251 generate_deopt_entry_for(ltos, i),
252 generate_deopt_entry_for(ftos, i),
253 generate_deopt_entry_for(dtos, i),
254 generate_deopt_entry_for(vtos, i)
255 );
256 }
257 address return_continuation = Interpreter::_normal_table.entry(Bytecodes::_return).entry(vtos);
258 vmassert(return_continuation != nullptr, "return entry not generated yet");
259 Interpreter::_deopt_reexecute_return_entry = generate_deopt_entry_for(vtos, 0, return_continuation);
260 }
261
262 }
263
264 //------------------------------------------------------------------------------------------------------------------------
265
266 address TemplateInterpreterGenerator::generate_error_exit(const char* msg) {
267 address entry = __ pc();
268 __ stop(msg);
269 return entry;
270 }
271
272
273 //------------------------------------------------------------------------------------------------------------------------
274
275 void TemplateInterpreterGenerator::set_entry_points_for_all_bytes() {
276 for (int i = 0; i < DispatchTable::length; i++) {
277 Bytecodes::Code code = (Bytecodes::Code)i;
278 if (Bytecodes::is_defined(code)) {
279 set_entry_points(code);
280 } else {
281 set_unimplemented(i);
282 }
283 }
284 }
285
286
287 void TemplateInterpreterGenerator::set_safepoints_for_all_bytes() {
288 for (int i = 0; i < DispatchTable::length; i++) {
289 Bytecodes::Code code = (Bytecodes::Code)i;
290 if (Bytecodes::is_defined(code)) Interpreter::_safept_table.set_entry(code, Interpreter::_safept_entry);
291 }
292 }
293
294
295 void TemplateInterpreterGenerator::set_unimplemented(int i) {
296 address e = _unimplemented_bytecode;
297 EntryPoint entry(e, e, e, e, e, e, e, e, e, e);
298 Interpreter::_normal_table.set_entry(i, entry);
299 Interpreter::_wentry_point[i] = _unimplemented_bytecode;
300 }
301
302
303 void TemplateInterpreterGenerator::set_entry_points(Bytecodes::Code code) {
304 CodeletMark cm(_masm, Bytecodes::name(code), code);
305 // initialize entry points
306 assert(_unimplemented_bytecode != nullptr, "should have been generated before");
307 assert(_illegal_bytecode_sequence != nullptr, "should have been generated before");
308 address bep = _illegal_bytecode_sequence;
309 address zep = _illegal_bytecode_sequence;
310 address cep = _illegal_bytecode_sequence;
311 address sep = _illegal_bytecode_sequence;
312 address aep = _illegal_bytecode_sequence;
313 address iep = _illegal_bytecode_sequence;
314 address lep = _illegal_bytecode_sequence;
315 address fep = _illegal_bytecode_sequence;
316 address dep = _illegal_bytecode_sequence;
317 address vep = _unimplemented_bytecode;
318 address wep = _unimplemented_bytecode;
319 // code for short & wide version of bytecode
320 if (Bytecodes::is_defined(code)) {
321 Template* t = TemplateTable::template_for(code);
322 assert(t->is_valid(), "just checking");
323 set_short_entry_points(t, bep, cep, sep, aep, iep, lep, fep, dep, vep);
324 }
325 if (Bytecodes::wide_is_defined(code)) {
326 Template* t = TemplateTable::template_for_wide(code);
327 assert(t->is_valid(), "just checking");
328 set_wide_entry_point(t, wep);
329 }
330 // set entry points
331 EntryPoint entry(bep, zep, cep, sep, aep, iep, lep, fep, dep, vep);
332 Interpreter::_normal_table.set_entry(code, entry);
333 Interpreter::_wentry_point[code] = wep;
334 }
335
336
337 void TemplateInterpreterGenerator::set_wide_entry_point(Template* t, address& wep) {
338 assert(t->is_valid(), "template must exist");
339 assert(t->tos_in() == vtos, "only vtos tos_in supported for wide instructions");
340 wep = __ pc(); generate_and_dispatch(t);
341 }
342
343
344 void TemplateInterpreterGenerator::set_short_entry_points(Template* t, address& bep, address& cep, address& sep, address& aep, address& iep, address& lep, address& fep, address& dep, address& vep) {
345 assert(t->is_valid(), "template must exist");
346 switch (t->tos_in()) {
347 case btos:
348 case ztos:
349 case ctos:
350 case stos:
351 ShouldNotReachHere(); // btos/ctos/stos should use itos.
352 break;
353 case atos: vep = __ pc(); __ pop(atos); aep = __ pc(); generate_and_dispatch(t); break;
354 case itos: vep = __ pc(); __ pop(itos); iep = __ pc(); generate_and_dispatch(t); break;
355 case ltos: vep = __ pc(); __ pop(ltos); lep = __ pc(); generate_and_dispatch(t); break;
356 case ftos: vep = __ pc(); __ pop(ftos); fep = __ pc(); generate_and_dispatch(t); break;
357 case dtos: vep = __ pc(); __ pop(dtos); dep = __ pc(); generate_and_dispatch(t); break;
358 case vtos: set_vtos_entry_points(t, bep, cep, sep, aep, iep, lep, fep, dep, vep); break;
359 default : ShouldNotReachHere(); break;
360 }
361 }
362
363
364 //------------------------------------------------------------------------------------------------------------------------
365
366 void TemplateInterpreterGenerator::generate_and_dispatch(Template* t, TosState tos_out) {
367 #ifndef PRODUCT
368 // debugging code
369 if (CountBytecodes || TraceBytecodes || StopInterpreterAt > 0) count_bytecode();
370 if (PrintBytecodeHistogram) histogram_bytecode(t);
371 if (PrintBytecodePairHistogram) histogram_bytecode_pair(t);
372 if (TraceBytecodes) trace_bytecode(t);
373 if (StopInterpreterAt > 0) stop_interpreter_at();
374 #endif // !PRODUCT
375 int step = 0;
376 if (!t->does_dispatch()) {
377 step = t->is_wide() ? Bytecodes::wide_length_for(t->bytecode()) : Bytecodes::length_for(t->bytecode());
378 if (tos_out == ilgl) tos_out = t->tos_out();
379 // compute bytecode size
380 assert(step > 0, "just checkin'");
381 // setup stuff for dispatching next bytecode
382 if (ProfileInterpreter && VerifyDataPointer
383 && MethodData::bytecode_has_profile(t->bytecode())) {
384 __ verify_method_data_pointer();
385 }
386 __ dispatch_prolog(tos_out, step);
387 }
388 // generate template
389 t->generate(_masm);
390 // advance
391 if (t->does_dispatch()) {
392 #ifdef ASSERT
393 // make sure execution doesn't go beyond this point if code is broken
394 __ should_not_reach_here();
395 #endif // ASSERT
396 } else {
397 // dispatch to next bytecode
398 __ dispatch_epilog(tos_out, step);
399 }
400 }
401
402 // Generate method entries
403 address TemplateInterpreterGenerator::generate_method_entry(
404 AbstractInterpreter::MethodKind kind, bool native) {
405 // determine code generation flags
406 bool synchronized = false;
407 address entry_point = nullptr;
408
409 switch (kind) {
410 case Interpreter::zerolocals : break;
411 case Interpreter::zerolocals_synchronized: synchronized = true; break;
412 case Interpreter::native : break;
413 case Interpreter::native_synchronized : synchronized = true; break;
414 case Interpreter::empty : break;
415 case Interpreter::getter : break;
416 case Interpreter::setter : break;
417 case Interpreter::abstract : entry_point = generate_abstract_entry(); break;
418 default:
419 entry_point = generate_intrinsic_entry(kind); // process the rest
420 break;
421 }
422
423 if (entry_point) {
424 return entry_point;
425 }
426
427 // We expect the normal and native entry points to be generated first so we can reuse them.
428 if (native) {
429 entry_point = Interpreter::entry_for_kind(synchronized ? Interpreter::native_synchronized : Interpreter::native);
430 if (entry_point == nullptr) {
431 entry_point = generate_native_entry(synchronized);
432 }
433 } else {
434 entry_point = Interpreter::entry_for_kind(synchronized ? Interpreter::zerolocals_synchronized : Interpreter::zerolocals);
435 if (entry_point == nullptr) {
436 entry_point = generate_normal_entry(synchronized);
437 }
438 }
439
440 return entry_point;
441 }
442
443 // Generate intrinsic method entries
444 address TemplateInterpreterGenerator::generate_intrinsic_entry(AbstractInterpreter::MethodKind kind) {
445 if (!InlineIntrinsics || !vmIntrinsics::is_intrinsic_available(AbstractInterpreter::method_intrinsic(kind))) {
446 return nullptr;
447 }
448
449 address entry_point = nullptr;
450
451 switch (kind) {
452 case Interpreter::java_lang_math_sin : // fall thru
453 case Interpreter::java_lang_math_cos : // fall thru
454 case Interpreter::java_lang_math_tan : // fall thru
455 case Interpreter::java_lang_math_tanh : // fall thru
456 case Interpreter::java_lang_math_abs : // fall thru
457 case Interpreter::java_lang_math_log : // fall thru
458 case Interpreter::java_lang_math_log10 : // fall thru
459 case Interpreter::java_lang_math_sqrt : // fall thru
460 case Interpreter::java_lang_math_pow : // fall thru
461 case Interpreter::java_lang_math_exp : // fall thru
462 case Interpreter::java_lang_math_fmaD : // fall thru
463 case Interpreter::java_lang_math_fmaF : entry_point = generate_math_entry(kind); break;
464 case Interpreter::java_lang_math_sqrt_strict
465 : entry_point = generate_math_entry(Interpreter::java_lang_math_sqrt); break;
466 case Interpreter::java_lang_ref_reference_get
467 : entry_point = generate_Reference_get_entry(); break;
468 case Interpreter::java_util_zip_CRC32_update
469 : entry_point = generate_CRC32_update_entry(); break;
470 case Interpreter::java_util_zip_CRC32_updateBytes
471 : // fall thru
472 case Interpreter::java_util_zip_CRC32_updateByteBuffer
473 : entry_point = generate_CRC32_updateBytes_entry(kind); break;
474 case Interpreter::java_util_zip_CRC32C_updateBytes
475 : // fall thru
476 case Interpreter::java_util_zip_CRC32C_updateDirectByteBuffer
477 : entry_point = generate_CRC32C_updateBytes_entry(kind); break;
478 case Interpreter::java_lang_Thread_currentThread
479 : entry_point = generate_currentThread(); break;
480 case Interpreter::java_lang_Float_float16ToFloat
481 : entry_point = generate_Float_float16ToFloat_entry(); break;
482 case Interpreter::java_lang_Float_floatToFloat16
483 : entry_point = generate_Float_floatToFloat16_entry(); break;
484 default:
485 fatal("unexpected intrinsic method kind: %d", kind);
486 break;
487 }
488 return entry_point;
489 }
490