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