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