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 "asm/macroAssembler.hpp" 26 #include "asm/macroAssembler.inline.hpp" 27 #include "cds/metaspaceShared.hpp" 28 #include "compiler/disassembler.hpp" 29 #include "interpreter/bytecodeHistogram.hpp" 30 #include "interpreter/bytecodeStream.hpp" 31 #include "interpreter/interpreter.hpp" 32 #include "interpreter/interpreterRuntime.hpp" 33 #include "interpreter/interp_masm.hpp" 34 #include "interpreter/templateTable.hpp" 35 #include "memory/allocation.inline.hpp" 36 #include "memory/resourceArea.hpp" 37 #include "oops/arrayOop.hpp" 38 #include "oops/constantPool.inline.hpp" 39 #include "oops/cpCache.inline.hpp" 40 #include "oops/methodData.hpp" 41 #include "oops/method.inline.hpp" 42 #include "oops/oop.inline.hpp" 43 #include "prims/jvmtiExport.hpp" 44 #include "prims/methodHandles.hpp" 45 #include "runtime/handles.inline.hpp" 46 #include "runtime/sharedRuntime.hpp" 47 #include "runtime/stubRoutines.hpp" 48 #include "runtime/timer.hpp" 49 50 # define __ _masm-> 51 52 //------------------------------------------------------------------------------------------------------------------------ 53 // Implementation of platform independent aspects of Interpreter 54 55 void AbstractInterpreter::initialize() { 56 // make sure 'imported' classes are initialized 57 if (CountBytecodes || TraceBytecodes || StopInterpreterAt) BytecodeCounter::reset(); 58 if (PrintBytecodeHistogram) BytecodeHistogram::reset(); 59 if (PrintBytecodePairHistogram) BytecodePairHistogram::reset(); 60 } 61 62 void AbstractInterpreter::print() { 63 tty->cr(); 64 tty->print_cr("----------------------------------------------------------------------"); 65 tty->print_cr("Interpreter"); 66 tty->cr(); 67 tty->print_cr("code size = %6dK bytes", (int)_code->used_space()/1024); 68 tty->print_cr("total space = %6dK bytes", (int)_code->total_space()/1024); 69 tty->print_cr("wasted space = %6dK bytes", (int)_code->available_space()/1024); 70 tty->cr(); 71 tty->print_cr("# of codelets = %6d" , _code->number_of_stubs()); 72 if (_code->number_of_stubs() != 0) { 73 tty->print_cr("avg codelet size = %6d bytes", _code->used_space() / _code->number_of_stubs()); 74 tty->cr(); 75 } 76 _should_print_instructions = PrintInterpreter; 77 _code->print(); 78 _should_print_instructions = false; 79 tty->print_cr("----------------------------------------------------------------------"); 80 tty->cr(); 81 } 82 83 84 //------------------------------------------------------------------------------------------------------------------------ 85 // Implementation of interpreter 86 87 StubQueue* AbstractInterpreter::_code = nullptr; 88 bool AbstractInterpreter::_notice_safepoints = false; 89 address AbstractInterpreter::_rethrow_exception_entry = nullptr; 90 91 address AbstractInterpreter::_slow_signature_handler; 92 address AbstractInterpreter::_entry_table [AbstractInterpreter::number_of_method_entries]; 93 address AbstractInterpreter::_native_abi_to_tosca [AbstractInterpreter::number_of_result_handlers]; 94 95 bool AbstractInterpreter::_should_print_instructions = false; 96 97 //------------------------------------------------------------------------------------------------------------------------ 98 // Generation of complete interpreter 99 100 AbstractInterpreterGenerator::AbstractInterpreterGenerator() { 101 _masm = nullptr; 102 } 103 104 105 //------------------------------------------------------------------------------------------------------------------------ 106 // Entry points 107 108 AbstractInterpreter::MethodKind AbstractInterpreter::method_kind(const methodHandle& m) { 109 // Abstract method? 110 if (m->is_abstract()) return abstract; 111 112 // Method handle primitive? 113 vmIntrinsics::ID iid = m->intrinsic_id(); 114 if (iid != vmIntrinsics::_none) { 115 if (m->is_method_handle_intrinsic()) { 116 assert(MethodHandles::is_signature_polymorphic(iid), "must match an intrinsic"); 117 MethodKind kind = (MethodKind)(method_handle_invoke_FIRST + 118 vmIntrinsics::as_int(iid) - 119 static_cast<int>(vmIntrinsics::FIRST_MH_SIG_POLY)); 120 assert(kind <= method_handle_invoke_LAST, "parallel enum ranges"); 121 return kind; 122 } 123 124 switch (iid) { 125 #ifndef ZERO 126 // Use optimized stub code for CRC32 native methods. 127 case vmIntrinsics::_updateCRC32: return java_util_zip_CRC32_update; 128 case vmIntrinsics::_updateBytesCRC32: return java_util_zip_CRC32_updateBytes; 129 case vmIntrinsics::_updateByteBufferCRC32: return java_util_zip_CRC32_updateByteBuffer; 130 // Use optimized stub code for CRC32C methods. 131 case vmIntrinsics::_updateBytesCRC32C: return java_util_zip_CRC32C_updateBytes; 132 case vmIntrinsics::_updateDirectByteBufferCRC32C: return java_util_zip_CRC32C_updateDirectByteBuffer; 133 case vmIntrinsics::_float16ToFloat: return java_lang_Float_float16ToFloat; 134 case vmIntrinsics::_floatToFloat16: return java_lang_Float_floatToFloat16; 135 case vmIntrinsics::_currentThread: return java_lang_Thread_currentThread; 136 #endif // ZERO 137 case vmIntrinsics::_dsin: return java_lang_math_sin; 138 case vmIntrinsics::_dcos: return java_lang_math_cos; 139 case vmIntrinsics::_dtan: return java_lang_math_tan; 140 case vmIntrinsics::_dtanh: return java_lang_math_tanh; 141 case vmIntrinsics::_dabs: return java_lang_math_abs; 142 case vmIntrinsics::_dlog: return java_lang_math_log; 143 case vmIntrinsics::_dlog10: return java_lang_math_log10; 144 case vmIntrinsics::_dpow: return java_lang_math_pow; 145 case vmIntrinsics::_dexp: return java_lang_math_exp; 146 case vmIntrinsics::_fmaD: return java_lang_math_fmaD; 147 case vmIntrinsics::_fmaF: return java_lang_math_fmaF; 148 case vmIntrinsics::_dsqrt: return java_lang_math_sqrt; 149 case vmIntrinsics::_dsqrt_strict: return java_lang_math_sqrt_strict; 150 case vmIntrinsics::_Reference_get: return java_lang_ref_reference_get; 151 case vmIntrinsics::_Object_init: 152 if (m->code_size() == 1) { 153 // We need to execute the special return bytecode to check for 154 // finalizer registration so create a normal frame. 155 return zerolocals; 156 } 157 break; 158 default: break; 159 } 160 } 161 162 // Native method? 163 if (m->is_native()) { 164 if (m->is_continuation_native_intrinsic()) { 165 // This entry will never be called. The real entry gets generated later, like for MH intrinsics. 166 return abstract; 167 } 168 assert(!m->is_method_handle_intrinsic(), "overlapping bits here, watch out"); 169 return m->is_synchronized() ? native_synchronized : native; 170 } 171 172 // Synchronized? 173 if (m->is_synchronized()) { 174 return zerolocals_synchronized; 175 } 176 177 // Empty method? 178 if (m->is_empty_method()) { 179 return empty; 180 } 181 182 // Getter method? 183 if (m->is_getter()) { 184 return getter; 185 } 186 187 // Setter method? 188 if (m->is_setter()) { 189 return setter; 190 } 191 192 // Note: for now: zero locals for all non-empty methods 193 return zerolocals; 194 } 195 196 vmIntrinsics::ID AbstractInterpreter::method_intrinsic(MethodKind kind) { 197 switch (kind) { 198 case java_lang_math_sin : return vmIntrinsics::_dsin; 199 case java_lang_math_cos : return vmIntrinsics::_dcos; 200 case java_lang_math_tan : return vmIntrinsics::_dtan; 201 case java_lang_math_tanh : return vmIntrinsics::_dtanh; 202 case java_lang_math_abs : return vmIntrinsics::_dabs; 203 case java_lang_math_log : return vmIntrinsics::_dlog; 204 case java_lang_math_log10 : return vmIntrinsics::_dlog10; 205 case java_lang_math_sqrt : return vmIntrinsics::_dsqrt; 206 case java_lang_math_sqrt_strict : return vmIntrinsics::_dsqrt_strict; 207 case java_lang_math_pow : return vmIntrinsics::_dpow; 208 case java_lang_math_exp : return vmIntrinsics::_dexp; 209 case java_lang_math_fmaD : return vmIntrinsics::_fmaD; 210 case java_lang_math_fmaF : return vmIntrinsics::_fmaF; 211 case java_lang_ref_reference_get: return vmIntrinsics::_Reference_get; 212 case java_util_zip_CRC32_update : return vmIntrinsics::_updateCRC32; 213 case java_util_zip_CRC32_updateBytes 214 : return vmIntrinsics::_updateBytesCRC32; 215 case java_util_zip_CRC32_updateByteBuffer 216 : return vmIntrinsics::_updateByteBufferCRC32; 217 case java_util_zip_CRC32C_updateBytes 218 : return vmIntrinsics::_updateBytesCRC32C; 219 case java_util_zip_CRC32C_updateDirectByteBuffer 220 : return vmIntrinsics::_updateDirectByteBufferCRC32C; 221 case java_lang_Thread_currentThread 222 : return vmIntrinsics::_currentThread; 223 case java_lang_Float_float16ToFloat 224 : return vmIntrinsics::_float16ToFloat; 225 case java_lang_Float_floatToFloat16 226 : return vmIntrinsics::_floatToFloat16; 227 228 default: 229 fatal("unexpected method intrinsic kind: %d", kind); 230 break; 231 } 232 return vmIntrinsics::_none; 233 } 234 235 void AbstractInterpreter::set_entry_for_kind(MethodKind kind, address entry) { 236 assert(kind >= method_handle_invoke_FIRST && 237 kind <= method_handle_invoke_LAST, "late initialization only for MH entry points"); 238 assert(_entry_table[kind] == _entry_table[abstract], "previous value must be AME entry"); 239 _entry_table[kind] = entry; 240 } 241 242 // Return true if the interpreter can prove that the given bytecode has 243 // not yet been executed (in Java semantics, not in actual operation). 244 bool AbstractInterpreter::is_not_reached(const methodHandle& method, int bci) { 245 BytecodeStream s(method, bci); 246 Bytecodes::Code code = s.next(); 247 248 if (Bytecodes::is_invoke(code)) { 249 assert(!Bytecodes::must_rewrite(code), "invokes aren't rewritten"); 250 ConstantPool* cpool = method()->constants(); 251 252 Bytecode invoke_bc(s.bytecode()); 253 254 switch (code) { 255 case Bytecodes::_invokedynamic: { 256 assert(invoke_bc.has_index_u4(code), "sanity"); 257 int method_index = invoke_bc.get_index_u4(code); 258 return cpool->resolved_indy_entry_at(method_index)->is_resolved(); 259 } 260 case Bytecodes::_invokevirtual: // fall-through 261 case Bytecodes::_invokeinterface: // fall-through 262 case Bytecodes::_invokespecial: // fall-through 263 case Bytecodes::_invokestatic: { 264 if (cpool->has_preresolution()) { 265 return false; // might have been reached 266 } 267 assert(!invoke_bc.has_index_u4(code), "sanity"); 268 int method_index = invoke_bc.get_index_u2(code); 269 constantPoolHandle cp(Thread::current(), cpool); 270 Method* resolved_method = ConstantPool::method_at_if_loaded(cp, method_index); 271 return (resolved_method == nullptr); 272 } 273 default: ShouldNotReachHere(); 274 } 275 } else if (!Bytecodes::must_rewrite(code)) { 276 // might have been reached 277 return false; 278 } 279 280 // the bytecode might not be rewritten if the method is an accessor, etc. 281 address ientry = method->interpreter_entry(); 282 if (ientry != entry_for_kind(AbstractInterpreter::zerolocals) && 283 ientry != entry_for_kind(AbstractInterpreter::zerolocals_synchronized)) 284 return false; // interpreter does not run this method! 285 286 // otherwise, we can be sure this bytecode has never been executed 287 return true; 288 } 289 290 291 #ifndef PRODUCT 292 void AbstractInterpreter::print_method_kind(MethodKind kind) { 293 switch (kind) { 294 case zerolocals : tty->print("zerolocals" ); break; 295 case zerolocals_synchronized: tty->print("zerolocals_synchronized"); break; 296 case native : tty->print("native" ); break; 297 case native_synchronized : tty->print("native_synchronized" ); break; 298 case empty : tty->print("empty" ); break; 299 case getter : tty->print("getter" ); break; 300 case setter : tty->print("setter" ); break; 301 case abstract : tty->print("abstract" ); break; 302 case java_lang_math_sin : tty->print("java_lang_math_sin" ); break; 303 case java_lang_math_cos : tty->print("java_lang_math_cos" ); break; 304 case java_lang_math_tan : tty->print("java_lang_math_tan" ); break; 305 case java_lang_math_tanh : tty->print("java_lang_math_tanh" ); break; 306 case java_lang_math_abs : tty->print("java_lang_math_abs" ); break; 307 case java_lang_math_log : tty->print("java_lang_math_log" ); break; 308 case java_lang_math_log10 : tty->print("java_lang_math_log10" ); break; 309 case java_lang_math_pow : tty->print("java_lang_math_pow" ); break; 310 case java_lang_math_exp : tty->print("java_lang_math_exp" ); break; 311 case java_lang_math_fmaD : tty->print("java_lang_math_fmaD" ); break; 312 case java_lang_math_fmaF : tty->print("java_lang_math_fmaF" ); break; 313 case java_lang_math_sqrt : tty->print("java_lang_math_sqrt" ); break; 314 case java_lang_math_sqrt_strict : tty->print("java_lang_math_sqrt_strict"); break; 315 case java_util_zip_CRC32_update : tty->print("java_util_zip_CRC32_update"); break; 316 case java_util_zip_CRC32_updateBytes : tty->print("java_util_zip_CRC32_updateBytes"); break; 317 case java_util_zip_CRC32_updateByteBuffer : tty->print("java_util_zip_CRC32_updateByteBuffer"); break; 318 case java_util_zip_CRC32C_updateBytes : tty->print("java_util_zip_CRC32C_updateBytes"); break; 319 case java_util_zip_CRC32C_updateDirectByteBuffer: tty->print("java_util_zip_CRC32C_updateDirectByteByffer"); break; 320 case java_lang_ref_reference_get : tty->print("java_lang_ref_reference_get"); break; 321 case java_lang_Thread_currentThread : tty->print("java_lang_Thread_currentThread"); break; 322 case java_lang_Float_float16ToFloat : tty->print("java_lang_Float_float16ToFloat"); break; 323 case java_lang_Float_floatToFloat16 : tty->print("java_lang_Float_floatToFloat16"); break; 324 default: 325 if (kind >= method_handle_invoke_FIRST && 326 kind <= method_handle_invoke_LAST) { 327 const char* kind_name = vmIntrinsics::name_at(method_handle_intrinsic(kind)); 328 if (kind_name[0] == '_') kind_name = &kind_name[1]; // '_invokeExact' => 'invokeExact' 329 tty->print("method_handle_%s", kind_name); 330 break; 331 } 332 ShouldNotReachHere(); 333 break; 334 } 335 } 336 #endif // PRODUCT 337 338 339 //------------------------------------------------------------------------------------------------------------------------ 340 // Deoptimization support 341 342 /** 343 * If a deoptimization happens, this function returns the point of next bytecode to continue execution. 344 */ 345 address AbstractInterpreter::deopt_continue_after_entry(Method* method, address bcp, int callee_parameters, bool is_top_frame) { 346 assert(method->contains(bcp), "just checkin'"); 347 348 // Get the original and rewritten bytecode. 349 Bytecodes::Code code = Bytecodes::java_code_at(method, bcp); 350 assert(!Interpreter::bytecode_should_reexecute(code), "should not reexecute"); 351 352 const int bci = method->bci_from(bcp); 353 354 // compute continuation length 355 const int length = Bytecodes::length_at(method, bcp); 356 357 // compute result type 358 BasicType type = T_ILLEGAL; 359 360 switch (code) { 361 case Bytecodes::_invokevirtual : 362 case Bytecodes::_invokespecial : 363 case Bytecodes::_invokestatic : 364 case Bytecodes::_invokeinterface: { 365 Thread *thread = Thread::current(); 366 ResourceMark rm(thread); 367 methodHandle mh(thread, method); 368 type = Bytecode_invoke(mh, bci).result_type(); 369 // since the cache entry might not be initialized: 370 // (NOT needed for the old calling convention) 371 if (!is_top_frame) { 372 int index = Bytes::get_native_u2(bcp+1); 373 method->constants()->cache()->resolved_method_entry_at(index)->set_num_parameters(callee_parameters); 374 } 375 break; 376 } 377 378 case Bytecodes::_invokedynamic: { 379 Thread *thread = Thread::current(); 380 ResourceMark rm(thread); 381 methodHandle mh(thread, method); 382 type = Bytecode_invoke(mh, bci).result_type(); 383 // since the cache entry might not be initialized: 384 // (NOT needed for the old calling convention) 385 if (!is_top_frame) { 386 int index = Bytes::get_native_u4(bcp+1); 387 method->constants()->resolved_indy_entry_at(index)->set_num_parameters(callee_parameters); 388 } 389 break; 390 } 391 392 case Bytecodes::_ldc : 393 case Bytecodes::_ldc_w : // fall through 394 case Bytecodes::_ldc2_w: 395 { 396 Thread *thread = Thread::current(); 397 ResourceMark rm(thread); 398 methodHandle mh(thread, method); 399 type = Bytecode_loadconstant(mh, bci).result_type(); 400 break; 401 } 402 403 default: 404 type = Bytecodes::result_type(code); 405 break; 406 } 407 408 // return entry point for computed continuation state & bytecode length 409 return 410 is_top_frame 411 ? Interpreter::deopt_entry (as_TosState(type), length) 412 : Interpreter::return_entry(as_TosState(type), length, code); 413 } 414 415 // If deoptimization happens, this function returns the point where the interpreter reexecutes 416 // the bytecode. 417 // Note: Bytecodes::_athrow is a special case in that it does not return 418 // Interpreter::deopt_entry(vtos, 0) like others 419 address AbstractInterpreter::deopt_reexecute_entry(Method* method, address bcp) { 420 assert(method->contains(bcp), "just checkin'"); 421 Bytecodes::Code code = Bytecodes::java_code_at(method, bcp); 422 #if defined(COMPILER1) || INCLUDE_JVMCI 423 if(code == Bytecodes::_athrow ) { 424 return Interpreter::rethrow_exception_entry(); 425 } 426 #endif /* COMPILER1 || INCLUDE_JVMCI */ 427 return Interpreter::deopt_entry(vtos, 0); 428 } 429 430 // If deoptimization happens, the interpreter should reexecute these bytecodes. 431 // This function mainly helps the compilers to set up the reexecute bit. 432 bool AbstractInterpreter::bytecode_should_reexecute(Bytecodes::Code code) { 433 switch (code) { 434 case Bytecodes::_lookupswitch: 435 case Bytecodes::_tableswitch: 436 case Bytecodes::_fast_binaryswitch: 437 case Bytecodes::_fast_linearswitch: 438 // recompute conditional expression folded into _if<cond> 439 case Bytecodes::_lcmp : 440 case Bytecodes::_fcmpl : 441 case Bytecodes::_fcmpg : 442 case Bytecodes::_dcmpl : 443 case Bytecodes::_dcmpg : 444 case Bytecodes::_ifnull : 445 case Bytecodes::_ifnonnull : 446 case Bytecodes::_goto : 447 case Bytecodes::_goto_w : 448 case Bytecodes::_ifeq : 449 case Bytecodes::_ifne : 450 case Bytecodes::_iflt : 451 case Bytecodes::_ifge : 452 case Bytecodes::_ifgt : 453 case Bytecodes::_ifle : 454 case Bytecodes::_if_icmpeq : 455 case Bytecodes::_if_icmpne : 456 case Bytecodes::_if_icmplt : 457 case Bytecodes::_if_icmpge : 458 case Bytecodes::_if_icmpgt : 459 case Bytecodes::_if_icmple : 460 case Bytecodes::_if_acmpeq : 461 case Bytecodes::_if_acmpne : 462 // special cases 463 case Bytecodes::_getfield : 464 case Bytecodes::_putfield : 465 case Bytecodes::_getstatic : 466 case Bytecodes::_putstatic : 467 case Bytecodes::_aastore : 468 #ifdef COMPILER1 469 //special case of reexecution 470 case Bytecodes::_athrow : 471 #endif 472 return true; 473 474 default: 475 return false; 476 } 477 } 478 479 void AbstractInterpreter::initialize_method_handle_entries() { 480 // method handle entry kinds are generated later in MethodHandlesAdapterGenerator::generate: 481 for (int i = method_handle_invoke_FIRST; i <= method_handle_invoke_LAST; i++) { 482 MethodKind kind = (MethodKind) i; 483 _entry_table[kind] = _entry_table[Interpreter::abstract]; 484 } 485 }