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 }; 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 179 180 #define method_entry(kind) \ 181 { CodeletMark cm(_masm, "method entry point (kind = " #kind ")"); \ 182 Interpreter::_entry_table[Interpreter::kind] = generate_method_entry(Interpreter::kind, false); \ 183 } 184 185 // all non-native method kinds 186 method_entry(zerolocals) 187 method_entry(zerolocals_synchronized) 188 method_entry(empty) 189 method_entry(getter) 190 method_entry(setter) 191 method_entry(abstract) 192 method_entry(java_lang_math_sin ) 193 method_entry(java_lang_math_cos ) 194 method_entry(java_lang_math_tan ) 195 method_entry(java_lang_math_abs ) 196 method_entry(java_lang_math_sqrt ) 197 method_entry(java_lang_math_sqrt_strict) 198 method_entry(java_lang_math_log ) 199 method_entry(java_lang_math_log10) 200 method_entry(java_lang_math_exp ) 201 method_entry(java_lang_math_pow ) 202 method_entry(java_lang_math_fmaF ) 203 method_entry(java_lang_math_fmaD ) 204 method_entry(java_lang_ref_reference_get) 205 AbstractInterpreter::initialize_method_handle_entries(); 206 207 method_entry(java_util_zip_CRC32C_updateBytes) 208 method_entry(java_util_zip_CRC32C_updateDirectByteBuffer) 209 210 method_entry(java_lang_Float_float16ToFloat); 211 method_entry(java_lang_Float_floatToFloat16); 212 213 #undef method_entry 214 215 // all native method kinds 216 #define native_method_entry(kind) \ 217 { CodeletMark cm(_masm, "native method entry point (kind = " #kind ")"); \ 218 Interpreter::_entry_table[Interpreter::kind] = generate_method_entry(Interpreter::kind, true); \ 219 } 220 221 native_method_entry(native) 222 native_method_entry(native_synchronized) 223 224 // Entries to intrinsics for native methods should follow 225 // entries for `native` methods to use the same address in case 226 // intrinsic is disabled. 227 native_method_entry(java_lang_Thread_currentThread) 228 229 native_method_entry(java_util_zip_CRC32_update) 230 native_method_entry(java_util_zip_CRC32_updateBytes) 231 native_method_entry(java_util_zip_CRC32_updateByteBuffer) 232 233 native_method_entry(java_lang_Float_intBitsToFloat) 234 native_method_entry(java_lang_Float_floatToRawIntBits) 235 native_method_entry(java_lang_Double_longBitsToDouble) 236 native_method_entry(java_lang_Double_doubleToRawLongBits) 237 238 #undef native_method_entry 239 240 // Bytecodes 241 set_entry_points_for_all_bytes(); 242 243 // installation of code in other places in the runtime 244 // (ExcutableCodeManager calls not needed to copy the entries) 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 __ verify_FPU(1, t->tos_in()); 379 #endif // !PRODUCT 380 int step = 0; 381 if (!t->does_dispatch()) { 382 step = t->is_wide() ? Bytecodes::wide_length_for(t->bytecode()) : Bytecodes::length_for(t->bytecode()); 383 if (tos_out == ilgl) tos_out = t->tos_out(); 384 // compute bytecode size 385 assert(step > 0, "just checkin'"); 386 // setup stuff for dispatching next bytecode 387 if (ProfileInterpreter && VerifyDataPointer 388 && MethodData::bytecode_has_profile(t->bytecode())) { 389 __ verify_method_data_pointer(); 390 } 391 __ dispatch_prolog(tos_out, step); 392 } 393 // generate template 394 t->generate(_masm); 395 // advance 396 if (t->does_dispatch()) { 397 #ifdef ASSERT 398 // make sure execution doesn't go beyond this point if code is broken 399 __ should_not_reach_here(); 400 #endif // ASSERT 401 } else { 402 // dispatch to next bytecode 403 __ dispatch_epilog(tos_out, step); 404 } 405 } 406 407 // Generate method entries 408 address TemplateInterpreterGenerator::generate_method_entry( 409 AbstractInterpreter::MethodKind kind, bool native) { 410 // determine code generation flags 411 bool synchronized = false; 412 address entry_point = nullptr; 413 414 switch (kind) { 415 case Interpreter::zerolocals : break; 416 case Interpreter::zerolocals_synchronized: synchronized = true; break; 417 case Interpreter::native : break; 418 case Interpreter::native_synchronized : synchronized = true; break; 419 case Interpreter::empty : break; 420 case Interpreter::getter : break; 421 case Interpreter::setter : 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 entry_point = Interpreter::entry_for_kind(synchronized ? Interpreter::native_synchronized : Interpreter::native); 435 if (entry_point == nullptr) { 436 entry_point = generate_native_entry(synchronized); 437 } 438 } else { 439 entry_point = Interpreter::entry_for_kind(synchronized ? Interpreter::zerolocals_synchronized : Interpreter::zerolocals); 440 if (entry_point == nullptr) { 441 entry_point = generate_normal_entry(synchronized); 442 } 443 } 444 445 return entry_point; 446 } 447 448 // Generate intrinsic method entries 449 address TemplateInterpreterGenerator::generate_intrinsic_entry(AbstractInterpreter::MethodKind kind) { 450 if (!InlineIntrinsics || !vmIntrinsics::is_intrinsic_available(AbstractInterpreter::method_intrinsic(kind))) { 451 return nullptr; 452 } 453 454 address entry_point = nullptr; 455 456 switch (kind) { 457 case Interpreter::java_lang_math_sin : // fall thru 458 case Interpreter::java_lang_math_cos : // fall thru 459 case Interpreter::java_lang_math_tan : // fall thru 460 case Interpreter::java_lang_math_abs : // fall thru 461 case Interpreter::java_lang_math_log : // fall thru 462 case Interpreter::java_lang_math_log10 : // fall thru 463 case Interpreter::java_lang_math_sqrt : // fall thru 464 case Interpreter::java_lang_math_pow : // fall thru 465 case Interpreter::java_lang_math_exp : // fall thru 466 case Interpreter::java_lang_math_fmaD : // fall thru 467 case Interpreter::java_lang_math_fmaF : entry_point = generate_math_entry(kind); break; 468 case Interpreter::java_lang_math_sqrt_strict 469 : entry_point = generate_math_entry(Interpreter::java_lang_math_sqrt); break; 470 case Interpreter::java_lang_ref_reference_get 471 : entry_point = generate_Reference_get_entry(); break; 472 case Interpreter::java_util_zip_CRC32_update 473 : entry_point = generate_CRC32_update_entry(); break; 474 case Interpreter::java_util_zip_CRC32_updateBytes 475 : // fall thru 476 case Interpreter::java_util_zip_CRC32_updateByteBuffer 477 : entry_point = generate_CRC32_updateBytes_entry(kind); break; 478 case Interpreter::java_util_zip_CRC32C_updateBytes 479 : // fall thru 480 case Interpreter::java_util_zip_CRC32C_updateDirectByteBuffer 481 : entry_point = generate_CRC32C_updateBytes_entry(kind); break; 482 case Interpreter::java_lang_Thread_currentThread 483 : entry_point = generate_currentThread(); break; 484 case Interpreter::java_lang_Float_float16ToFloat 485 : entry_point = generate_Float_float16ToFloat_entry(); break; 486 case Interpreter::java_lang_Float_floatToFloat16 487 : entry_point = generate_Float_floatToFloat16_entry(); break; 488 489 // On x86_32 platforms, a special entry is generated for the following four methods. 490 // On other platforms the native entry is used to enter these methods. 491 case Interpreter::java_lang_Float_intBitsToFloat 492 : entry_point = generate_Float_intBitsToFloat_entry(); break; 493 case Interpreter::java_lang_Float_floatToRawIntBits 494 : entry_point = generate_Float_floatToRawIntBits_entry(); break; 495 case Interpreter::java_lang_Double_longBitsToDouble 496 : entry_point = generate_Double_longBitsToDouble_entry(); break; 497 case Interpreter::java_lang_Double_doubleToRawLongBits 498 : entry_point = generate_Double_doubleToRawLongBits_entry(); break; 499 default: 500 fatal("unexpected intrinsic method kind: %d", kind); 501 break; 502 } 503 return entry_point; 504 } 505