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