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_NPE_UninitializedField_entry = generate_exception_handler("java/lang/NullPointerException", "Uninitialized null-restricted field");
175 Interpreter::_throw_StackOverflowError_entry = generate_StackOverflowError_handler();
176 }
177
178 { CodeletMark cm(_masm, "preemption resume adapter");
179 Interpreter::_cont_resume_interpreter_adapter = generate_cont_resume_interpreter_adapter();
180 }
181
182 #define method_entry(kind) \
183 { CodeletMark cm(_masm, "method entry point (kind = " #kind ")"); \
184 Interpreter::_entry_table[Interpreter::kind] = generate_method_entry(Interpreter::kind, false); \
185 }
186
187 // all non-native method kinds
188 method_entry(zerolocals)
189 method_entry(zerolocals_synchronized)
190 method_entry(empty)
191 method_entry(getter)
192 method_entry(setter)
193 method_entry(abstract)
194 method_entry(java_lang_math_sin )
195 method_entry(java_lang_math_cos )
196 method_entry(java_lang_math_tan )
197 method_entry(java_lang_math_tanh )
198 method_entry(java_lang_math_abs )
199 method_entry(java_lang_math_sqrt )
200 method_entry(java_lang_math_sqrt_strict)
201 method_entry(java_lang_math_log )
202 method_entry(java_lang_math_log10)
203 method_entry(java_lang_math_exp )
204 method_entry(java_lang_math_pow )
205 method_entry(java_lang_math_fmaF )
206 method_entry(java_lang_math_fmaD )
207 method_entry(java_lang_ref_reference_get)
208 AbstractInterpreter::initialize_method_handle_entries();
209
210 method_entry(java_util_zip_CRC32C_updateBytes)
211 method_entry(java_util_zip_CRC32C_updateDirectByteBuffer)
212
213 method_entry(java_lang_Float_float16ToFloat);
214 method_entry(java_lang_Float_floatToFloat16);
215
216 #undef method_entry
217
218 // all native method kinds
219 #define native_method_entry(kind) \
220 { CodeletMark cm(_masm, "native method entry point (kind = " #kind ")"); \
221 Interpreter::_entry_table[Interpreter::kind] = generate_method_entry(Interpreter::kind, true); \
222 }
223
224 native_method_entry(native)
225 native_method_entry(native_synchronized)
226
227 // Entries to intrinsics for native methods should follow
228 // entries for `native` methods to use the same address in case
229 // intrinsic is disabled.
230 native_method_entry(java_lang_Thread_currentThread)
231
232 native_method_entry(java_util_zip_CRC32_update)
233 native_method_entry(java_util_zip_CRC32_updateBytes)
234 native_method_entry(java_util_zip_CRC32_updateByteBuffer)
235
236 #undef native_method_entry
237
238 // Bytecodes
239 set_entry_points_for_all_bytes();
240
241 // installation of code in other places in the runtime
242 set_safepoints_for_all_bytes();
243
244 { CodeletMark cm(_masm, "deoptimization entry points");
245 Interpreter::_deopt_entry[0] = EntryPoint();
246 Interpreter::_deopt_entry[0].set_entry(vtos, generate_deopt_entry_for(vtos, 0));
247 for (int i = 1; i < Interpreter::number_of_deopt_entries; i++) {
248 Interpreter::_deopt_entry[i] =
249 EntryPoint(
250 generate_deopt_entry_for(atos, i),
251 generate_deopt_entry_for(itos, i),
252 generate_deopt_entry_for(ltos, i),
253 generate_deopt_entry_for(ftos, i),
254 generate_deopt_entry_for(dtos, i),
255 generate_deopt_entry_for(vtos, i)
256 );
257 }
258 address return_continuation = Interpreter::_normal_table.entry(Bytecodes::_return).entry(vtos);
259 vmassert(return_continuation != nullptr, "return entry not generated yet");
260 Interpreter::_deopt_reexecute_return_entry = generate_deopt_entry_for(vtos, 0, return_continuation);
261 }
262
263 }
264
265 //------------------------------------------------------------------------------------------------------------------------
266
267 address TemplateInterpreterGenerator::generate_error_exit(const char* msg) {
268 address entry = __ pc();
269 __ stop(msg);
270 return entry;
271 }
272
273
274 //------------------------------------------------------------------------------------------------------------------------
275
276 void TemplateInterpreterGenerator::set_entry_points_for_all_bytes() {
277 for (int i = 0; i < DispatchTable::length; i++) {
278 Bytecodes::Code code = (Bytecodes::Code)i;
279 if (Bytecodes::is_defined(code)) {
280 set_entry_points(code);
281 } else {
282 set_unimplemented(i);
283 }
284 }
285 }
286
287
288 void TemplateInterpreterGenerator::set_safepoints_for_all_bytes() {
289 for (int i = 0; i < DispatchTable::length; i++) {
290 Bytecodes::Code code = (Bytecodes::Code)i;
291 if (Bytecodes::is_defined(code)) Interpreter::_safept_table.set_entry(code, Interpreter::_safept_entry);
292 }
293 }
294
295
296 void TemplateInterpreterGenerator::set_unimplemented(int i) {
297 address e = _unimplemented_bytecode;
298 EntryPoint entry(e, e, e, e, e, e, e, e, e, e);
299 Interpreter::_normal_table.set_entry(i, entry);
300 Interpreter::_wentry_point[i] = _unimplemented_bytecode;
301 }
302
303
304 void TemplateInterpreterGenerator::set_entry_points(Bytecodes::Code code) {
305 CodeletMark cm(_masm, Bytecodes::name(code), code);
306 // initialize entry points
307 assert(_unimplemented_bytecode != nullptr, "should have been generated before");
308 assert(_illegal_bytecode_sequence != nullptr, "should have been generated before");
309 address bep = _illegal_bytecode_sequence;
310 address zep = _illegal_bytecode_sequence;
311 address cep = _illegal_bytecode_sequence;
312 address sep = _illegal_bytecode_sequence;
313 address aep = _illegal_bytecode_sequence;
314 address iep = _illegal_bytecode_sequence;
315 address lep = _illegal_bytecode_sequence;
316 address fep = _illegal_bytecode_sequence;
317 address dep = _illegal_bytecode_sequence;
318 address vep = _unimplemented_bytecode;
319 address wep = _unimplemented_bytecode;
320 // code for short & wide version of bytecode
321 if (Bytecodes::is_defined(code)) {
322 Template* t = TemplateTable::template_for(code);
323 assert(t->is_valid(), "just checking");
324 set_short_entry_points(t, bep, cep, sep, aep, iep, lep, fep, dep, vep);
325 }
326 if (Bytecodes::wide_is_defined(code)) {
327 Template* t = TemplateTable::template_for_wide(code);
328 assert(t->is_valid(), "just checking");
329 set_wide_entry_point(t, wep);
330 }
331 // set entry points
332 EntryPoint entry(bep, zep, cep, sep, aep, iep, lep, fep, dep, vep);
333 Interpreter::_normal_table.set_entry(code, entry);
334 Interpreter::_wentry_point[code] = wep;
335 }
336
337
338 void TemplateInterpreterGenerator::set_wide_entry_point(Template* t, address& wep) {
339 assert(t->is_valid(), "template must exist");
340 assert(t->tos_in() == vtos, "only vtos tos_in supported for wide instructions");
341 wep = __ pc(); generate_and_dispatch(t);
342 }
343
344
345 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) {
346 assert(t->is_valid(), "template must exist");
347 switch (t->tos_in()) {
348 case btos:
349 case ztos:
350 case ctos:
351 case stos:
352 ShouldNotReachHere(); // btos/ctos/stos should use itos.
353 break;
354 case atos: vep = __ pc(); __ pop(atos); aep = __ pc(); generate_and_dispatch(t); break;
355 case itos: vep = __ pc(); __ pop(itos); iep = __ pc(); generate_and_dispatch(t); break;
356 case ltos: vep = __ pc(); __ pop(ltos); lep = __ pc(); generate_and_dispatch(t); break;
357 case ftos: vep = __ pc(); __ pop(ftos); fep = __ pc(); generate_and_dispatch(t); break;
358 case dtos: vep = __ pc(); __ pop(dtos); dep = __ pc(); generate_and_dispatch(t); break;
359 case vtos: set_vtos_entry_points(t, bep, cep, sep, aep, iep, lep, fep, dep, vep); break;
360 default : ShouldNotReachHere(); break;
361 }
362 }
363
364
365 //------------------------------------------------------------------------------------------------------------------------
366
367 void TemplateInterpreterGenerator::generate_and_dispatch(Template* t, TosState tos_out) {
368 #ifndef PRODUCT
369 // debugging code
370 if (CountBytecodes || TraceBytecodes || StopInterpreterAt > 0) count_bytecode();
371 if (PrintBytecodeHistogram) histogram_bytecode(t);
372 if (PrintBytecodePairHistogram) histogram_bytecode_pair(t);
373 if (TraceBytecodes) trace_bytecode(t);
374 if (StopInterpreterAt > 0) stop_interpreter_at();
375 #endif // !PRODUCT
376 int step = 0;
377 if (!t->does_dispatch()) {
378 step = t->is_wide() ? Bytecodes::wide_length_for(t->bytecode()) : Bytecodes::length_for(t->bytecode());
379 if (tos_out == ilgl) tos_out = t->tos_out();
380 // compute bytecode size
381 assert(step > 0, "just checkin'");
382 // setup stuff for dispatching next bytecode
383 if (ProfileInterpreter && VerifyDataPointer
384 && MethodData::bytecode_has_profile(t->bytecode())) {
385 __ verify_method_data_pointer();
386 }
387 __ dispatch_prolog(tos_out, step);
388 }
389 // generate template
390 t->generate(_masm);
391 // advance
392 if (t->does_dispatch()) {
393 #ifdef ASSERT
394 // make sure execution doesn't go beyond this point if code is broken
395 __ should_not_reach_here();
396 #endif // ASSERT
397 } else {
398 // dispatch to next bytecode
399 __ dispatch_epilog(tos_out, step);
400 }
401 }
402
403 // Generate method entries
404 address TemplateInterpreterGenerator::generate_method_entry(
405 AbstractInterpreter::MethodKind kind, bool native) {
406 // determine code generation flags
407 bool synchronized = false;
408 address entry_point = nullptr;
409
410 switch (kind) {
411 case Interpreter::zerolocals : break;
412 case Interpreter::zerolocals_synchronized: synchronized = true; break;
413 case Interpreter::native : break;
414 case Interpreter::native_synchronized : synchronized = true; break;
415 case Interpreter::empty : break;
416 case Interpreter::getter : break;
417 case Interpreter::setter : break;
418 case Interpreter::abstract : entry_point = generate_abstract_entry(); break;
419 default:
420 entry_point = generate_intrinsic_entry(kind); // process the rest
421 break;
422 }
423
424 if (entry_point) {
425 return entry_point;
426 }
427
428 // We expect the normal and native entry points to be generated first so we can reuse them.
429 if (native) {
430 entry_point = Interpreter::entry_for_kind(synchronized ? Interpreter::native_synchronized : Interpreter::native);
431 if (entry_point == nullptr) {
432 entry_point = generate_native_entry(synchronized);
433 }
434 } else {
435 entry_point = Interpreter::entry_for_kind(synchronized ? Interpreter::zerolocals_synchronized : Interpreter::zerolocals);
436 if (entry_point == nullptr) {
437 entry_point = generate_normal_entry(synchronized);
438 }
439 }
440
441 return entry_point;
442 }
443
444 // Generate intrinsic method entries
445 address TemplateInterpreterGenerator::generate_intrinsic_entry(AbstractInterpreter::MethodKind kind) {
446 if (!InlineIntrinsics || !vmIntrinsics::is_intrinsic_available(AbstractInterpreter::method_intrinsic(kind))) {
447 return nullptr;
448 }
449
450 address entry_point = nullptr;
451
452 switch (kind) {
453 case Interpreter::java_lang_math_sin : // fall thru
454 case Interpreter::java_lang_math_cos : // fall thru
455 case Interpreter::java_lang_math_tan : // fall thru
456 case Interpreter::java_lang_math_tanh : // fall thru
457 case Interpreter::java_lang_math_abs : // fall thru
458 case Interpreter::java_lang_math_log : // fall thru
459 case Interpreter::java_lang_math_log10 : // fall thru
460 case Interpreter::java_lang_math_sqrt : // fall thru
461 case Interpreter::java_lang_math_pow : // fall thru
462 case Interpreter::java_lang_math_exp : // fall thru
463 case Interpreter::java_lang_math_fmaD : // fall thru
464 case Interpreter::java_lang_math_fmaF : entry_point = generate_math_entry(kind); break;
465 case Interpreter::java_lang_math_sqrt_strict
466 : entry_point = generate_math_entry(Interpreter::java_lang_math_sqrt); break;
467 case Interpreter::java_lang_ref_reference_get
468 : entry_point = generate_Reference_get_entry(); break;
469 case Interpreter::java_util_zip_CRC32_update
470 : entry_point = generate_CRC32_update_entry(); break;
471 case Interpreter::java_util_zip_CRC32_updateBytes
472 : // fall thru
473 case Interpreter::java_util_zip_CRC32_updateByteBuffer
474 : entry_point = generate_CRC32_updateBytes_entry(kind); break;
475 case Interpreter::java_util_zip_CRC32C_updateBytes
476 : // fall thru
477 case Interpreter::java_util_zip_CRC32C_updateDirectByteBuffer
478 : entry_point = generate_CRC32C_updateBytes_entry(kind); break;
479 case Interpreter::java_lang_Thread_currentThread
480 : entry_point = generate_currentThread(); break;
481 case Interpreter::java_lang_Float_float16ToFloat
482 : entry_point = generate_Float_float16ToFloat_entry(); break;
483 case Interpreter::java_lang_Float_floatToFloat16
484 : entry_point = generate_Float_floatToFloat16_entry(); break;
485 default:
486 fatal("unexpected intrinsic method kind: %d", kind);
487 break;
488 }
489 return entry_point;
490 }
491