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