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 if (m->is_synchronized()) {
170 return m->has_upcall_on_method_entry() ? native_synchronized_upcalls : native_synchronized;
171 }
172 return m->has_upcall_on_method_entry() ? native_upcalls : native;
173 }
174
175 // Synchronized?
176 if (m->is_synchronized()) {
177 return m->has_upcall_on_method_entry() ? zerolocals_synchronized_upcalls : zerolocals_synchronized;
178 }
179
180 // Empty method?
181 if (m->is_empty_method()) {
182 return m->has_upcall_on_method_entry() ? empty_upcalls : empty;
183 }
184
185 // Getter method?
186 if (m->is_getter()) {
187 return getter;
188 }
189
190 // Setter method?
191 if (m->is_setter()) {
192 return setter;
193 }
194
195 // Note: for now: zero locals for all non-empty methods
196 return m->has_upcall_on_method_entry() ? zerolocals_upcalls : zerolocals;
197 }
198
199 vmIntrinsics::ID AbstractInterpreter::method_intrinsic(MethodKind kind) {
200 switch (kind) {
201 case java_lang_math_sin : return vmIntrinsics::_dsin;
202 case java_lang_math_cos : return vmIntrinsics::_dcos;
203 case java_lang_math_tan : return vmIntrinsics::_dtan;
204 case java_lang_math_tanh : return vmIntrinsics::_dtanh;
205 case java_lang_math_abs : return vmIntrinsics::_dabs;
206 case java_lang_math_log : return vmIntrinsics::_dlog;
207 case java_lang_math_log10 : return vmIntrinsics::_dlog10;
208 case java_lang_math_sqrt : return vmIntrinsics::_dsqrt;
209 case java_lang_math_sqrt_strict : return vmIntrinsics::_dsqrt_strict;
210 case java_lang_math_pow : return vmIntrinsics::_dpow;
211 case java_lang_math_exp : return vmIntrinsics::_dexp;
212 case java_lang_math_fmaD : return vmIntrinsics::_fmaD;
213 case java_lang_math_fmaF : return vmIntrinsics::_fmaF;
214 case java_lang_ref_reference_get: return vmIntrinsics::_Reference_get;
215 case java_util_zip_CRC32_update : return vmIntrinsics::_updateCRC32;
216 case java_util_zip_CRC32_updateBytes
217 : return vmIntrinsics::_updateBytesCRC32;
218 case java_util_zip_CRC32_updateByteBuffer
219 : return vmIntrinsics::_updateByteBufferCRC32;
220 case java_util_zip_CRC32C_updateBytes
221 : return vmIntrinsics::_updateBytesCRC32C;
222 case java_util_zip_CRC32C_updateDirectByteBuffer
223 : return vmIntrinsics::_updateDirectByteBufferCRC32C;
224 case java_lang_Thread_currentThread
225 : return vmIntrinsics::_currentThread;
226 case java_lang_Float_float16ToFloat
227 : return vmIntrinsics::_float16ToFloat;
228 case java_lang_Float_floatToFloat16
229 : return vmIntrinsics::_floatToFloat16;
230
231 default:
232 fatal("unexpected method intrinsic kind: %d", kind);
233 break;
234 }
235 return vmIntrinsics::_none;
236 }
237
238 void AbstractInterpreter::set_entry_for_kind(MethodKind kind, address entry) {
239 assert(kind >= method_handle_invoke_FIRST &&
240 kind <= method_handle_invoke_LAST, "late initialization only for MH entry points");
241 assert(_entry_table[kind] == _entry_table[abstract], "previous value must be AME entry");
242 _entry_table[kind] = entry;
243 }
244
245 // Return true if the interpreter can prove that the given bytecode has
246 // not yet been executed (in Java semantics, not in actual operation).
247 bool AbstractInterpreter::is_not_reached(const methodHandle& method, int bci) {
248 BytecodeStream s(method, bci);
249 Bytecodes::Code code = s.next();
250
251 if (Bytecodes::is_invoke(code)) {
252 assert(!Bytecodes::must_rewrite(code), "invokes aren't rewritten");
253 ConstantPool* cpool = method()->constants();
254
255 Bytecode invoke_bc(s.bytecode());
256
257 switch (code) {
258 case Bytecodes::_invokedynamic: {
259 assert(invoke_bc.has_index_u4(code), "sanity");
260 int method_index = invoke_bc.get_index_u4(code);
261 return cpool->resolved_indy_entry_at(method_index)->is_resolved();
262 }
263 case Bytecodes::_invokevirtual: // fall-through
264 case Bytecodes::_invokeinterface: // fall-through
265 case Bytecodes::_invokespecial: // fall-through
266 case Bytecodes::_invokestatic: {
267 if (cpool->has_preresolution()) {
268 return false; // might have been reached
269 }
270 assert(!invoke_bc.has_index_u4(code), "sanity");
271 int method_index = invoke_bc.get_index_u2(code);
272 constantPoolHandle cp(Thread::current(), cpool);
273 Method* resolved_method = ConstantPool::method_at_if_loaded(cp, method_index);
274 return (resolved_method == nullptr);
275 }
276 default: ShouldNotReachHere();
277 }
278 } else if (!Bytecodes::must_rewrite(code)) {
279 // might have been reached
280 return false;
281 }
282
283 // the bytecode might not be rewritten if the method is an accessor, etc.
284 address ientry = method->interpreter_entry();
285 if (ientry != entry_for_kind(AbstractInterpreter::zerolocals) &&
286 ientry != entry_for_kind(AbstractInterpreter::zerolocals_synchronized))
287 return false; // interpreter does not run this method!
288
289 // otherwise, we can be sure this bytecode has never been executed
290 return true;
291 }
292
293
294 #ifndef PRODUCT
295 void AbstractInterpreter::print_method_kind(MethodKind kind) {
296 switch (kind) {
297 case zerolocals : tty->print("zerolocals" ); break;
298 case zerolocals_synchronized: tty->print("zerolocals_synchronized"); break;
299 case native : tty->print("native" ); break;
300 case native_synchronized : tty->print("native_synchronized" ); break;
301 case empty : tty->print("empty" ); break;
302 case getter : tty->print("getter" ); break;
303 case setter : tty->print("setter" ); break;
304 case abstract : tty->print("abstract" ); break;
305 case java_lang_math_sin : tty->print("java_lang_math_sin" ); break;
306 case java_lang_math_cos : tty->print("java_lang_math_cos" ); break;
307 case java_lang_math_tan : tty->print("java_lang_math_tan" ); break;
308 case java_lang_math_tanh : tty->print("java_lang_math_tanh" ); break;
309 case java_lang_math_abs : tty->print("java_lang_math_abs" ); break;
310 case java_lang_math_log : tty->print("java_lang_math_log" ); break;
311 case java_lang_math_log10 : tty->print("java_lang_math_log10" ); break;
312 case java_lang_math_pow : tty->print("java_lang_math_pow" ); break;
313 case java_lang_math_exp : tty->print("java_lang_math_exp" ); break;
314 case java_lang_math_fmaD : tty->print("java_lang_math_fmaD" ); break;
315 case java_lang_math_fmaF : tty->print("java_lang_math_fmaF" ); break;
316 case java_lang_math_sqrt : tty->print("java_lang_math_sqrt" ); break;
317 case java_lang_math_sqrt_strict : tty->print("java_lang_math_sqrt_strict"); break;
318 case java_util_zip_CRC32_update : tty->print("java_util_zip_CRC32_update"); break;
319 case java_util_zip_CRC32_updateBytes : tty->print("java_util_zip_CRC32_updateBytes"); break;
320 case java_util_zip_CRC32_updateByteBuffer : tty->print("java_util_zip_CRC32_updateByteBuffer"); break;
321 case java_util_zip_CRC32C_updateBytes : tty->print("java_util_zip_CRC32C_updateBytes"); break;
322 case java_util_zip_CRC32C_updateDirectByteBuffer: tty->print("java_util_zip_CRC32C_updateDirectByteByffer"); break;
323 case java_lang_ref_reference_get : tty->print("java_lang_ref_reference_get"); break;
324 case java_lang_Thread_currentThread : tty->print("java_lang_Thread_currentThread"); break;
325 case java_lang_Float_float16ToFloat : tty->print("java_lang_Float_float16ToFloat"); break;
326 case java_lang_Float_floatToFloat16 : tty->print("java_lang_Float_floatToFloat16"); break;
327 default:
328 if (kind >= method_handle_invoke_FIRST &&
329 kind <= method_handle_invoke_LAST) {
330 const char* kind_name = vmIntrinsics::name_at(method_handle_intrinsic(kind));
331 if (kind_name[0] == '_') kind_name = &kind_name[1]; // '_invokeExact' => 'invokeExact'
332 tty->print("method_handle_%s", kind_name);
333 break;
334 }
335 ShouldNotReachHere();
336 break;
337 }
338 }
339 #endif // PRODUCT
340
341
342 //------------------------------------------------------------------------------------------------------------------------
343 // Deoptimization support
344
345 /**
346 * If a deoptimization happens, this function returns the point of next bytecode to continue execution.
347 */
348 address AbstractInterpreter::deopt_continue_after_entry(Method* method, address bcp, int callee_parameters, bool is_top_frame) {
349 assert(method->contains(bcp), "just checkin'");
350
351 // Get the original and rewritten bytecode.
352 Bytecodes::Code code = Bytecodes::java_code_at(method, bcp);
353 assert(!Interpreter::bytecode_should_reexecute(code), "should not reexecute");
354
355 const int bci = method->bci_from(bcp);
356
357 // compute continuation length
358 const int length = Bytecodes::length_at(method, bcp);
359
360 // compute result type
361 BasicType type = T_ILLEGAL;
362
363 switch (code) {
364 case Bytecodes::_invokevirtual :
365 case Bytecodes::_invokespecial :
366 case Bytecodes::_invokestatic :
367 case Bytecodes::_invokeinterface: {
368 Thread *thread = Thread::current();
369 ResourceMark rm(thread);
370 methodHandle mh(thread, method);
371 type = Bytecode_invoke(mh, bci).result_type();
372 // since the cache entry might not be initialized:
373 // (NOT needed for the old calling convention)
374 if (!is_top_frame) {
375 int index = Bytes::get_native_u2(bcp+1);
376 method->constants()->cache()->resolved_method_entry_at(index)->set_num_parameters(callee_parameters);
377 }
378 break;
379 }
380
381 case Bytecodes::_invokedynamic: {
382 Thread *thread = Thread::current();
383 ResourceMark rm(thread);
384 methodHandle mh(thread, method);
385 type = Bytecode_invoke(mh, bci).result_type();
386 // since the cache entry might not be initialized:
387 // (NOT needed for the old calling convention)
388 if (!is_top_frame) {
389 int index = Bytes::get_native_u4(bcp+1);
390 method->constants()->resolved_indy_entry_at(index)->set_num_parameters(callee_parameters);
391 }
392 break;
393 }
394
395 case Bytecodes::_ldc :
396 case Bytecodes::_ldc_w : // fall through
397 case Bytecodes::_ldc2_w:
398 {
399 Thread *thread = Thread::current();
400 ResourceMark rm(thread);
401 methodHandle mh(thread, method);
402 type = Bytecode_loadconstant(mh, bci).result_type();
403 break;
404 }
405
406 default:
407 type = Bytecodes::result_type(code);
408 break;
409 }
410
411 // return entry point for computed continuation state & bytecode length
412 return
413 is_top_frame
414 ? Interpreter::deopt_entry (as_TosState(type), length)
415 : Interpreter::return_entry(as_TosState(type), length, code);
416 }
417
418 // If deoptimization happens, this function returns the point where the interpreter reexecutes
419 // the bytecode.
420 // Note: Bytecodes::_athrow is a special case in that it does not return
421 // Interpreter::deopt_entry(vtos, 0) like others
422 address AbstractInterpreter::deopt_reexecute_entry(Method* method, address bcp) {
423 assert(method->contains(bcp), "just checkin'");
424 Bytecodes::Code code = Bytecodes::java_code_at(method, bcp);
425 #if defined(COMPILER1) || INCLUDE_JVMCI
426 if(code == Bytecodes::_athrow ) {
427 return Interpreter::rethrow_exception_entry();
428 }
429 #endif /* COMPILER1 || INCLUDE_JVMCI */
430 return Interpreter::deopt_entry(vtos, 0);
431 }
432
433 // If deoptimization happens, the interpreter should reexecute these bytecodes.
434 // This function mainly helps the compilers to set up the reexecute bit.
435 bool AbstractInterpreter::bytecode_should_reexecute(Bytecodes::Code code) {
436 switch (code) {
437 case Bytecodes::_lookupswitch:
438 case Bytecodes::_tableswitch:
439 case Bytecodes::_fast_binaryswitch:
440 case Bytecodes::_fast_linearswitch:
441 // recompute conditional expression folded into _if<cond>
442 case Bytecodes::_lcmp :
443 case Bytecodes::_fcmpl :
444 case Bytecodes::_fcmpg :
445 case Bytecodes::_dcmpl :
446 case Bytecodes::_dcmpg :
447 case Bytecodes::_ifnull :
448 case Bytecodes::_ifnonnull :
449 case Bytecodes::_goto :
450 case Bytecodes::_goto_w :
451 case Bytecodes::_ifeq :
452 case Bytecodes::_ifne :
453 case Bytecodes::_iflt :
454 case Bytecodes::_ifge :
455 case Bytecodes::_ifgt :
456 case Bytecodes::_ifle :
457 case Bytecodes::_if_icmpeq :
458 case Bytecodes::_if_icmpne :
459 case Bytecodes::_if_icmplt :
460 case Bytecodes::_if_icmpge :
461 case Bytecodes::_if_icmpgt :
462 case Bytecodes::_if_icmple :
463 case Bytecodes::_if_acmpeq :
464 case Bytecodes::_if_acmpne :
465 // special cases
466 case Bytecodes::_getfield :
467 case Bytecodes::_putfield :
468 case Bytecodes::_getstatic :
469 case Bytecodes::_putstatic :
470 case Bytecodes::_aastore :
471 #ifdef COMPILER1
472 //special case of reexecution
473 case Bytecodes::_athrow :
474 #endif
475 return true;
476
477 default:
478 return false;
479 }
480 }
481
482 void AbstractInterpreter::initialize_method_handle_entries() {
483 // method handle entry kinds are generated later in MethodHandlesAdapterGenerator::generate:
484 for (int i = method_handle_invoke_FIRST; i <= method_handle_invoke_LAST; i++) {
485 MethodKind kind = (MethodKind) i;
486 _entry_table[kind] = _entry_table[Interpreter::abstract];
487 }
488 }