1 /*
2 * Copyright (c) 1997, 2026, 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 #ifndef SHARE_RUNTIME_SHAREDRUNTIME_HPP
26 #define SHARE_RUNTIME_SHAREDRUNTIME_HPP
27
28 #include "asm/codeBuffer.hpp"
29 #include "code/codeBlob.hpp"
30 #include "code/vmreg.hpp"
31 #include "interpreter/linkResolver.hpp"
32 #include "memory/allStatic.hpp"
33 #include "memory/resourceArea.hpp"
34 #include "runtime/safepointVerifiers.hpp"
35 #include "runtime/signature.hpp"
36 #include "runtime/stubInfo.hpp"
37 #include "utilities/macros.hpp"
38
39 class AdapterHandlerEntry;
40 class AdapterFingerPrint;
41 class MetaspaceClosure;
42 class SerializeClosure;
43 class vframeStream;
44 class SigEntry;
45
46 // Runtime is the base class for various runtime interfaces
47 // (InterpreterRuntime, CompilerRuntime, etc.). It provides
48 // shared functionality such as exception forwarding (C++ to
49 // Java exceptions), locking/unlocking mechanisms, statistical
50 // information, etc.
51
52 class SharedRuntime: AllStatic {
53 private:
54 // Declare shared stub fields
55 #define SHARED_STUB_FIELD_DECLARE(name, type) \
56 static type* BLOB_FIELD_NAME(name);
57 SHARED_STUBS_DO(SHARED_STUB_FIELD_DECLARE)
58 #undef SHARED_STUB_FIELD_DECLARE
59
60 #ifdef ASSERT
61 static bool is_resolve_id(StubId id) {
62 return (id == StubId::shared_wrong_method_id ||
63 id == StubId::shared_wrong_method_abstract_id ||
64 id == StubId::shared_ic_miss_id ||
65 id == StubId::shared_resolve_opt_virtual_call_id ||
66 id == StubId::shared_resolve_virtual_call_id ||
67 id == StubId::shared_resolve_static_call_id);
68 }
69 static bool is_polling_page_id(StubId id) {
70 return (id == StubId::shared_polling_page_vectors_safepoint_handler_id ||
71 id == StubId::shared_polling_page_safepoint_handler_id ||
72 id == StubId::shared_polling_page_return_handler_id);
73 }
74 static bool is_throw_id(StubId id) {
75 return (id == StubId::shared_throw_AbstractMethodError_id ||
76 id == StubId::shared_throw_IncompatibleClassChangeError_id ||
77 id == StubId::shared_throw_NullPointerException_at_call_id ||
78 id == StubId::shared_throw_StackOverflowError_id ||
79 id == StubId::shared_throw_delayed_StackOverflowError_id);
80 }
81 #endif
82
83 // cont_doYieldStub is not yet folded into the general model for
84 // shared stub/blob handling. It is actually a specially generated
85 // native wrapper for a specific native method, as also is it's
86 // counterpart the continuation do_enter method.
87 static nmethod* _cont_doYield_stub;
88
89 #ifndef PRODUCT
90 // Counters
91 static int64_t _nof_megamorphic_calls; // total # of megamorphic calls (through vtable)
92 #endif // !PRODUCT
93
94 private:
95 static SafepointBlob* generate_handler_blob(StubId id, address call_ptr);
96 static RuntimeStub* generate_resolve_blob(StubId id, address destination);
97 static RuntimeStub* generate_throw_exception(StubId id, address runtime_entry);
98 public:
99 static void generate_initial_stubs(void);
100 static void generate_stubs(void);
101 #if INCLUDE_JFR
102 static void generate_jfr_stubs(void);
103 // For c2: c_rarg0 is junk, call to runtime to write a checkpoint.
104 // It returns a jobject handle to the event writer.
105 // The handle is dereferenced and the return value is the event writer oop.
106 static RuntimeStub* generate_jfr_write_checkpoint();
107 // For c2: call to runtime to return a buffer lease.
108 static RuntimeStub* generate_jfr_return_lease();
109 #endif
110 static void init_adapter_library();
111
112 static const char *stub_name(StubId id) {
113 assert(StubInfo::is_shared(id), "not a shared stub %s", StubInfo::name(id));
114 return StubInfo::name(id);
115 }
116
117 // max bytes for each dtrace string parameter
118 enum { max_dtrace_string_size = 256 };
119
120 // The following arithmetic routines are used on platforms that do
121 // not have machine instructions to implement their functionality.
122 // Do not remove these.
123
124 // long arithmetics
125 static jlong lmul(jlong y, jlong x);
126 static jlong ldiv(jlong y, jlong x);
127 static jlong lrem(jlong y, jlong x);
128
129 // float and double remainder
130 static jfloat frem(jfloat x, jfloat y);
131 static jdouble drem(jdouble x, jdouble y);
132
133
134 #ifdef _WIN64
135 // Workaround for fmod issue in the Windows x64 CRT
136 static double fmod_winx64(double x, double y);
137 #endif
138
139 #ifdef __SOFTFP__
140 static jfloat fadd(jfloat x, jfloat y);
141 static jfloat fsub(jfloat x, jfloat y);
142 static jfloat fmul(jfloat x, jfloat y);
143 static jfloat fdiv(jfloat x, jfloat y);
144
145 static jdouble dadd(jdouble x, jdouble y);
146 static jdouble dsub(jdouble x, jdouble y);
147 static jdouble dmul(jdouble x, jdouble y);
148 static jdouble ddiv(jdouble x, jdouble y);
149 #endif // __SOFTFP__
150
151 // float conversion (needs to set appropriate rounding mode)
152 static jint f2i (jfloat x);
153 static jlong f2l (jfloat x);
154 static jint d2i (jdouble x);
155 static jlong d2l (jdouble x);
156 static jfloat d2f (jdouble x);
157 static jfloat l2f (jlong x);
158 static jdouble l2d (jlong x);
159 static jfloat i2f (jint x);
160
161 #ifdef __SOFTFP__
162 static jdouble i2d (jint x);
163 static jdouble f2d (jfloat x);
164 #endif // __SOFTFP__
165
166 // double trigonometrics and transcendentals
167 static jdouble dsin(jdouble x);
168 static jdouble dcos(jdouble x);
169 static jdouble dtan(jdouble x);
170 static jdouble dlog(jdouble x);
171 static jdouble dlog10(jdouble x);
172 static jdouble dexp(jdouble x);
173 static jdouble dpow(jdouble x, jdouble y);
174
175 #if defined(__SOFTFP__) || defined(E500V2)
176 static double dabs(double f);
177 #endif
178
179 #if defined(__SOFTFP__)
180 static double dsqrt(double f);
181 #endif
182
183 // Montgomery multiplication
184 static void montgomery_multiply(jint *a_ints, jint *b_ints, jint *n_ints,
185 jint len, jlong inv, jint *m_ints);
186 static void montgomery_square(jint *a_ints, jint *n_ints,
187 jint len, jlong inv, jint *m_ints);
188
189 #ifdef __SOFTFP__
190 // C++ compiler generates soft float instructions as well as passing
191 // float and double in registers.
192 static int fcmpl(float x, float y);
193 static int fcmpg(float x, float y);
194 static int dcmpl(double x, double y);
195 static int dcmpg(double x, double y);
196
197 static int unordered_fcmplt(float x, float y);
198 static int unordered_dcmplt(double x, double y);
199 static int unordered_fcmple(float x, float y);
200 static int unordered_dcmple(double x, double y);
201 static int unordered_fcmpge(float x, float y);
202 static int unordered_dcmpge(double x, double y);
203 static int unordered_fcmpgt(float x, float y);
204 static int unordered_dcmpgt(double x, double y);
205
206 static float fneg(float f);
207 static double dneg(double f);
208 #endif
209
210 // exception handling across interpreter/compiler boundaries
211 static address raw_exception_handler_for_return_address(JavaThread* current, address return_address);
212 static address exception_handler_for_return_address(JavaThread* current, address return_address);
213
214 // exception handling and implicit exceptions
215 static address compute_compiled_exc_handler(nmethod* nm, address ret_pc, Handle& exception,
216 bool force_unwind, bool top_frame_only, bool& recursive_exception_occurred);
217 enum ImplicitExceptionKind {
218 IMPLICIT_NULL,
219 IMPLICIT_DIVIDE_BY_ZERO,
220 STACK_OVERFLOW
221 };
222 static void throw_AbstractMethodError(JavaThread* current);
223 static void throw_IncompatibleClassChangeError(JavaThread* current);
224 static void throw_ArithmeticException(JavaThread* current);
225 static void throw_NullPointerException(JavaThread* current);
226 static void throw_NullPointerException_at_call(JavaThread* current);
227 static void throw_StackOverflowError(JavaThread* current);
228 static void throw_delayed_StackOverflowError(JavaThread* current);
229 static void throw_StackOverflowError_common(JavaThread* current, bool delayed);
230 static address continuation_for_implicit_exception(JavaThread* current,
231 address faulting_pc,
232 ImplicitExceptionKind exception_kind);
233
234 // Post-slow-path-allocation, pre-initializing-stores step for
235 // implementing e.g. ReduceInitialCardMarks
236 static void on_slowpath_allocation_exit(JavaThread* current);
237
238 static void enable_stack_reserved_zone(JavaThread* current);
239 static frame look_for_reserved_stack_annotated_method(JavaThread* current, frame fr);
240
241 // Shared stub locations
242 static address get_poll_stub(address pc);
243
244 static address get_ic_miss_stub() {
245 assert(_ic_miss_blob!= nullptr, "oops");
246 return _ic_miss_blob->entry_point();
247 }
248
249 static address get_handle_wrong_method_stub() {
250 assert(_wrong_method_blob!= nullptr, "oops");
251 return _wrong_method_blob->entry_point();
252 }
253
254 static address get_handle_wrong_method_abstract_stub() {
255 assert(_wrong_method_abstract_blob!= nullptr, "oops");
256 return _wrong_method_abstract_blob->entry_point();
257 }
258
259 static address get_resolve_opt_virtual_call_stub() {
260 assert(_resolve_opt_virtual_call_blob != nullptr, "oops");
261 return _resolve_opt_virtual_call_blob->entry_point();
262 }
263 static address get_resolve_virtual_call_stub() {
264 assert(_resolve_virtual_call_blob != nullptr, "oops");
265 return _resolve_virtual_call_blob->entry_point();
266 }
267 static address get_resolve_static_call_stub() {
268 assert(_resolve_static_call_blob != nullptr, "oops");
269 return _resolve_static_call_blob->entry_point();
270 }
271
272 static SafepointBlob* polling_page_return_handler_blob() { return _polling_page_return_handler_blob; }
273 static SafepointBlob* polling_page_safepoint_handler_blob() { return _polling_page_safepoint_handler_blob; }
274 static SafepointBlob* polling_page_vectors_safepoint_handler_blob() { return _polling_page_vectors_safepoint_handler_blob; }
275
276 static nmethod* cont_doYield_stub() {
277 assert(_cont_doYield_stub != nullptr, "oops");
278 return _cont_doYield_stub;
279 }
280
281 // Implicit exceptions
282 static address throw_AbstractMethodError_entry() {
283 assert(_throw_AbstractMethodError_blob != nullptr, "");
284 return _throw_AbstractMethodError_blob->entry_point();
285 }
286 static address throw_IncompatibleClassChangeError_entry() {
287 assert(_throw_IncompatibleClassChangeError_blob != nullptr, "");
288 return _throw_IncompatibleClassChangeError_blob->entry_point();
289 }
290 static address throw_NullPointerException_at_call_entry() {
291 assert(_throw_NullPointerException_at_call_blob != nullptr, "");
292 return _throw_NullPointerException_at_call_blob->entry_point();
293 }
294 static address throw_StackOverflowError_entry() {
295 assert(_throw_StackOverflowError_blob != nullptr, "");
296 return _throw_StackOverflowError_blob->entry_point();
297 }
298 static address throw_delayed_StackOverflowError_entry() {
299 assert(_throw_delayed_StackOverflowError_blob != nullptr, "");
300 return _throw_delayed_StackOverflowError_blob->entry_point();
301 }
302
303 #if INCLUDE_JFR
304 static address jfr_write_checkpoint() {
305 assert(_jfr_write_checkpoint_blob != nullptr, "");
306 return _jfr_write_checkpoint_blob->entry_point();
307 }
308 static address jfr_return_lease() {
309 assert(_jfr_return_lease_blob != nullptr, "");
310 return _jfr_return_lease_blob->entry_point();
311 }
312 #endif
313
314 // Counters
315 #ifndef PRODUCT
316 static address nof_megamorphic_calls_addr() { return (address)&_nof_megamorphic_calls; }
317 #endif // PRODUCT
318
319 // Helper routine for full-speed JVMTI exception throwing support
320 static void throw_and_post_jvmti_exception(JavaThread* current, Handle h_exception);
321 static void throw_and_post_jvmti_exception(JavaThread* current, Symbol* name, const char *message = nullptr);
322
323 // RedefineClasses() tracing support for obsolete method entry
324 static int rc_trace_method_entry(JavaThread* thread, Method* m);
325
326 // To be used as the entry point for unresolved native methods.
327 static address native_method_throw_unsatisfied_link_error_entry();
328
329 static void register_finalizer(JavaThread* thread, oopDesc* obj);
330
331 // dtrace notifications
332 static int dtrace_object_alloc(oopDesc* o);
333 static int dtrace_object_alloc(JavaThread* thread, oopDesc* o);
334 static int dtrace_object_alloc(JavaThread* thread, oopDesc* o, size_t size);
335 static int dtrace_method_entry(JavaThread* thread, Method* m);
336 static int dtrace_method_exit(JavaThread* thread, Method* m);
337
338 // Utility method for retrieving the Java thread id, returns 0 if the
339 // thread is not a well formed Java thread.
340 static jlong get_java_tid(JavaThread* thread);
341
342
343 // used by native wrappers to re-enable yellow if overflow happened in native code
344 static void reguard_yellow_pages();
345
346 // Fill in the "X cannot be cast to a Y" message for ClassCastException
347 //
348 // @param thr the current thread
349 // @param caster_klass the class of the object we are casting
350 // @return the dynamically allocated exception message (must be freed
351 // by the caller using a resource mark)
352 //
353 // BCP must refer to the current 'checkcast' opcode for the frame
354 // on top of the stack.
355 // The caller (or one of its callers) must use a ResourceMark
356 // in order to correctly free the result.
357 //
358 static char* generate_class_cast_message(JavaThread* thr, Klass* caster_klass);
359
360 // Fill in the "X cannot be cast to a Y" message for ClassCastException
361 //
362 // @param caster_klass the class of the object we are casting
363 // @param target_klass the target klass attempt
364 // @return the dynamically allocated exception message (must be freed
365 // by the caller using a resource mark)
366 //
367 // This version does not require access the frame, so it can be called
368 // from interpreted code
369 // The caller (or one of it's callers) must use a ResourceMark
370 // in order to correctly free the result.
371 //
372 static char* generate_class_cast_message(Klass* caster_klass, Klass* target_klass, Symbol* target_klass_name = nullptr);
373
374 static char* generate_identity_exception_message(JavaThread* thr, Klass* klass);
375
376 // Resolves a call site- may patch in the destination of the call into the
377 // compiled code.
378 static methodHandle resolve_helper(bool is_virtual, bool is_optimized, bool& caller_does_not_scalarize, TRAPS);
379
380 private:
381 // deopt blob
382 static void generate_deopt_blob(void);
383
384 public:
385 static DeoptimizationBlob* deopt_blob(void) { return _deopt_blob; }
386
387 // Resets a call-site in compiled code so it will get resolved again.
388 static methodHandle reresolve_call_site(bool& is_optimized, bool& caller_does_not_scalarize, TRAPS);
389
390 // In the code prolog, if the klass comparison fails, the inline cache
391 // misses and the call site is patched to megamorphic
392 static methodHandle handle_ic_miss_helper(bool& caller_does_not_scalarize, TRAPS);
393
394 // Find the method that called us.
395 static methodHandle find_callee_method(bool& caller_does_not_scalarize, TRAPS);
396
397 static void monitor_enter_helper(oopDesc* obj, BasicLock* lock, JavaThread* thread);
398
399 static void monitor_exit_helper(oopDesc* obj, BasicLock* lock, JavaThread* current);
400
401 private:
402 static Handle find_callee_info(Bytecodes::Code& bc, CallInfo& callinfo, TRAPS);
403 static Handle find_callee_info_helper(vframeStream& vfst, Bytecodes::Code& bc, CallInfo& callinfo, TRAPS);
404
405 static Method* extract_attached_method(vframeStream& vfst);
406
407 #if defined(X86) && defined(COMPILER1)
408 // For Object.hashCode, System.identityHashCode try to pull hashCode from object header if available.
409 static void inline_check_hashcode_from_object_header(MacroAssembler* masm, const methodHandle& method, Register obj_reg, Register result);
410 #endif // X86 && COMPILER1
411
412 public:
413
414 // Read the array of BasicTypes from a Java signature, and compute where
415 // compiled Java code would like to put the results. Values in reg_lo and
416 // reg_hi refer to 4-byte quantities. Values less than SharedInfo::stack0 are
417 // registers, those above refer to 4-byte stack slots. All stack slots are
418 // based off of the window top. SharedInfo::stack0 refers to the first usable
419 // slot in the bottom of the frame. SharedInfo::stack0+1 refers to the memory word
420 // 4-bytes higher.
421 // return value is the maximum number of VMReg stack slots the convention will use.
422 static int java_calling_convention(const BasicType* sig_bt, VMRegPair* regs, int total_args_passed);
423 static int java_calling_convention(const GrowableArray<SigEntry>* sig, VMRegPair* regs) {
424 BasicType* sig_bt = NEW_RESOURCE_ARRAY(BasicType, sig->length());
425 int total_args_passed = SigEntry::fill_sig_bt(sig, sig_bt);
426 return java_calling_convention(sig_bt, regs, total_args_passed);
427 }
428 static int java_return_convention(const BasicType* sig_bt, VMRegPair* regs, int total_args_passed);
429 static const uint java_return_convention_max_int;
430 static const uint java_return_convention_max_float;
431
432 static void check_member_name_argument_is_last_argument(const methodHandle& method,
433 const BasicType* sig_bt,
434 const VMRegPair* regs) NOT_DEBUG_RETURN;
435
436 // Ditto except for calling C
437 //
438 // C argument in register AND stack slot.
439 // Some architectures require that an argument must be passed in a register
440 // AND in a stack slot. These architectures provide a second VMRegPair array
441 // to be filled by the c_calling_convention method. On other architectures,
442 // null is being passed as the second VMRegPair array, so arguments are either
443 // passed in a register OR in a stack slot.
444 static int c_calling_convention(const BasicType *sig_bt, VMRegPair *regs, int total_args_passed);
445
446 static int vector_calling_convention(VMRegPair *regs,
447 uint num_bits,
448 uint total_args_passed);
449
450 // Generate I2C and C2I adapters. These adapters are simple argument marshalling
451 // blobs. Unlike adapters in the tiger and earlier releases the code in these
452 // blobs does not create a new frame and are therefore virtually invisible
453 // to the stack walking code. In general these blobs extend the callers stack
454 // as needed for the conversion of argument locations.
455
456 // When calling a c2i blob the code will always call the interpreter even if
457 // by the time we reach the blob there is compiled code available. This allows
458 // the blob to pass the incoming stack pointer (the sender sp) in a known
459 // location for the interpreter to record. This is used by the frame code
460 // to correct the sender code to match up with the stack pointer when the
461 // thread left the compiled code. In addition it allows the interpreter
462 // to remove the space the c2i adapter allocated to do its argument conversion.
463
464 // Although a c2i blob will always run interpreted even if compiled code is
465 // present if we see that compiled code is present the compiled call site
466 // will be patched/re-resolved so that later calls will run compiled.
467
468 // Additionally a c2i blob need to have a unverified entry because it can be reached
469 // in situations where the call site is an inlined cache site and may go megamorphic.
470
471 // A i2c adapter is simpler than the c2i adapter. This is because it is assumed
472 // that the interpreter before it does any call dispatch will record the current
473 // stack pointer in the interpreter frame. On return it will restore the stack
474 // pointer as needed. This means the i2c adapter code doesn't need any special
475 // handshaking path with compiled code to keep the stack walking correct.
476
477 static void generate_i2c2i_adapters(MacroAssembler* _masm,
478 int total_args_passed,
479 const GrowableArray<SigEntry>* sig,
480 const VMRegPair* regs,
481 const GrowableArray<SigEntry>* sig_cc,
482 const VMRegPair* regs_cc,
483 const GrowableArray<SigEntry>* sig_cc_ro,
484 const VMRegPair* regs_cc_ro,
485 address entry_address[AdapterBlob::ENTRY_COUNT],
486 AdapterBlob*& new_adapter,
487 bool allocate_code_blob);
488
489 static void gen_i2c_adapter(MacroAssembler *_masm,
490 int comp_args_on_stack,
491 const GrowableArray<SigEntry>* sig,
492 const VMRegPair *regs);
493
494 // OSR support
495
496 // OSR_migration_begin will extract the jvm state from an interpreter
497 // frame (locals, monitors) and store the data in a piece of C heap
498 // storage. This then allows the interpreter frame to be removed from the
499 // stack and the OSR nmethod to be called. That method is called with a
500 // pointer to the C heap storage. This pointer is the return value from
501 // OSR_migration_begin.
502
503 static intptr_t* OSR_migration_begin(JavaThread *thread);
504
505 // OSR_migration_end is a trivial routine. It is called after the compiled
506 // method has extracted the jvm state from the C heap that OSR_migration_begin
507 // created. It's entire job is to simply free this storage.
508 static void OSR_migration_end(intptr_t* buf);
509
510 // Convert a sig into a calling convention register layout
511 // and find interesting things about it.
512 static VMRegPair* find_callee_arguments(Symbol* sig, bool has_receiver, bool has_appendix, int *arg_size);
513 static VMReg name_for_receiver();
514
515 // "Top of Stack" slots that may be unused by the calling convention but must
516 // otherwise be preserved.
517 // On Intel these are not necessary and the value can be zero.
518 // On Sparc this describes the words reserved for storing a register window
519 // when an interrupt occurs.
520 static uint out_preserve_stack_slots();
521
522 // Stack slots that may be unused by the calling convention but must
523 // otherwise be preserved. On Intel this includes the return address.
524 // On PowerPC it includes the 4 words holding the old TOC & LR glue.
525 static uint in_preserve_stack_slots();
526
527 static VMReg thread_register();
528
529 static void continuation_enter_cleanup(MacroAssembler* masm);
530
531 // Is vector's size (in bytes) bigger than a size saved by default?
532 // For example, on x86 16 bytes XMM registers are saved by default.
533 static bool is_wide_vector(int size);
534
535 // Save and restore a native result
536 static void save_native_result(MacroAssembler *_masm, BasicType ret_type, int frame_slots);
537 static void restore_native_result(MacroAssembler *_masm, BasicType ret_type, int frame_slots);
538
539 // Generate a native wrapper for a given method. The method takes arguments
540 // in the Java compiled code convention, marshals them to the native
541 // convention (handlizes oops, etc), transitions to native, makes the call,
542 // returns to java state (possibly blocking), unhandlizes any result and
543 // returns.
544 //
545 // The wrapper may contain special-case code if the given method
546 // is a compiled method handle adapter, such as _invokeBasic, _linkToVirtual, etc.
547 static nmethod* generate_native_wrapper(MacroAssembler* masm,
548 const methodHandle& method,
549 int compile_id,
550 BasicType* sig_bt,
551 VMRegPair* regs,
552 BasicType ret_type);
553
554 // A compiled caller has just called the interpreter, but compiled code
555 // exists. Patch the caller so he no longer calls into the interpreter.
556 static void fixup_callers_callsite(Method* moop, address ret_pc);
557
558 // Slow-path Locking and Unlocking
559 static void complete_monitor_locking_C(oopDesc* obj, BasicLock* lock, JavaThread* current);
560 static void complete_monitor_unlocking_C(oopDesc* obj, BasicLock* lock, JavaThread* current);
561
562 // Resolving of calls
563 static address get_resolved_entry (JavaThread* current, methodHandle callee_method,
564 bool is_static_call, bool is_optimized, bool caller_does_not_scalarize);
565 static address resolve_static_call_C (JavaThread* current);
566 static address resolve_virtual_call_C (JavaThread* current);
567 static address resolve_opt_virtual_call_C(JavaThread* current);
568
569 static void load_inline_type_fields_in_regs(JavaThread* current, oopDesc* res);
570 static void store_inline_type_fields_to_buf(JavaThread* current, intptr_t res);
571
572 // arraycopy, the non-leaf version. (See StubRoutines for all the leaf calls.)
573 static void slow_arraycopy_C(oopDesc* src, jint src_pos,
574 oopDesc* dest, jint dest_pos,
575 jint length, JavaThread* thread);
576
577 // handle ic miss with caller being compiled code
578 // wrong method handling (inline cache misses)
579 static address handle_wrong_method(JavaThread* current);
580 static address handle_wrong_method_abstract(JavaThread* current);
581 static address handle_wrong_method_ic_miss(JavaThread* current);
582 static void allocate_inline_types(JavaThread* current, Method* callee, bool allocate_receiver);
583 static oop allocate_inline_types_impl(JavaThread* current, methodHandle callee, bool allocate_receiver, bool from_c1, TRAPS);
584
585 static address handle_unsafe_access(JavaThread* thread, address next_pc);
586
587 static BufferedInlineTypeBlob* generate_buffered_inline_type_adapter(const InlineKlass* vk);
588 #ifndef PRODUCT
589
590 // Collect and print inline cache miss statistics
591 private:
592 enum { maxICmiss_count = 100 };
593 static int _ICmiss_index; // length of IC miss histogram
594 static int _ICmiss_count[maxICmiss_count]; // miss counts
595 static address _ICmiss_at[maxICmiss_count]; // miss addresses
596 static void trace_ic_miss(address at);
597
598 public:
599 static uint _ic_miss_ctr; // total # of IC misses
600 static uint _wrong_method_ctr;
601 static uint _resolve_static_ctr;
602 static uint _resolve_virtual_ctr;
603 static uint _resolve_opt_virtual_ctr;
604 static uint _implicit_null_throws;
605 static uint _implicit_div0_throws;
606
607 static uint _jbyte_array_copy_ctr; // Slow-path byte array copy
608 static uint _jshort_array_copy_ctr; // Slow-path short array copy
609 static uint _jint_array_copy_ctr; // Slow-path int array copy
610 static uint _jlong_array_copy_ctr; // Slow-path long array copy
611 static uint _oop_array_copy_ctr; // Slow-path oop array copy
612 static uint _checkcast_array_copy_ctr; // Slow-path oop array copy, with cast
613 static uint _unsafe_array_copy_ctr; // Slow-path includes alignment checks
614 static uint _generic_array_copy_ctr; // Slow-path includes type decoding
615 static uint _slow_array_copy_ctr; // Slow-path failed out to a method call
616
617 static uint _unsafe_set_memory_ctr; // Slow-path includes alignment checks
618
619 static uint _new_instance_ctr; // 'new' object requires GC
620 static uint _new_array_ctr; // 'new' array requires GC
621 static uint _multi2_ctr, _multi3_ctr, _multi4_ctr, _multi5_ctr;
622 static uint _find_handler_ctr; // find exception handler
623 static uint _rethrow_ctr; // rethrow exception
624 static uint _mon_enter_stub_ctr; // monitor enter stub
625 static uint _mon_exit_stub_ctr; // monitor exit stub
626 static uint _mon_enter_ctr; // monitor enter slow
627 static uint _mon_exit_ctr; // monitor exit slow
628 static uint _partial_subtype_ctr; // SubRoutines::partial_subtype_check
629
630 // Statistics code
631 // stats for "normal" compiled calls (non-interface)
632 static int64_t _nof_normal_calls; // total # of calls
633 static int64_t _nof_inlined_calls; // total # of inlined normal calls
634 static int64_t _nof_static_calls; // total # of calls to static methods or super methods (invokespecial)
635 static int64_t _nof_inlined_static_calls; // total # of inlined static calls
636 // stats for compiled interface calls
637 static int64_t _nof_interface_calls; // total # of compiled calls
638 static int64_t _nof_inlined_interface_calls; // total # of inlined interface calls
639
640 public: // for compiler
641 static address nof_normal_calls_addr() { return (address)&_nof_normal_calls; }
642 static address nof_inlined_calls_addr() { return (address)&_nof_inlined_calls; }
643 static address nof_static_calls_addr() { return (address)&_nof_static_calls; }
644 static address nof_inlined_static_calls_addr() { return (address)&_nof_inlined_static_calls; }
645 static address nof_interface_calls_addr() { return (address)&_nof_interface_calls; }
646 static address nof_inlined_interface_calls_addr() { return (address)&_nof_inlined_interface_calls; }
647 static void print_call_statistics(uint64_t comp_total);
648 static void print_ic_miss_histogram();
649
650 #ifdef COMPILER2
651 // Runtime methods for printf-style debug nodes
652 static void debug_print_value(jboolean x);
653 static void debug_print_value(jbyte x);
654 static void debug_print_value(jshort x);
655 static void debug_print_value(jchar x);
656 static void debug_print_value(jint x);
657 static void debug_print_value(jlong x);
658 static void debug_print_value(jfloat x);
659 static void debug_print_value(jdouble x);
660 static void debug_print_value(oopDesc* x);
661
662 template <typename T, typename... Rest>
663 static void debug_print_rec(T arg, Rest... args) {
664 debug_print_value(arg);
665 debug_print_rec(args...);
666 }
667
668 static void debug_print_rec() {}
669
670 // template is required here as we need to know the exact signature at compile-time
671 template <typename... TT>
672 static void debug_print(const char *str, TT... args) {
673 // these three lines are the manual expansion of JRT_LEAF ... JRT_END, does not work well with templates
674 DEBUG_ONLY(NoHandleMark __hm;)
675 os::verify_stack_alignment();
676 DEBUG_ONLY(NoSafepointVerifier __nsv;)
677
678 tty->print_cr("%s", str);
679 debug_print_rec(args...);
680 }
681 #endif // COMPILER2
682
683 #endif // PRODUCT
684
685 static void print_statistics() PRODUCT_RETURN;
686 };
687
688
689 // ---------------------------------------------------------------------------
690 // Implementation of AdapterHandlerLibrary
691 //
692 // This library manages argument marshaling adapters and native wrappers.
693 // There are 2 flavors of adapters: I2C and C2I.
694 //
695 // The I2C flavor takes a stock interpreted call setup, marshals the
696 // arguments for a Java-compiled call, and jumps to Rmethod-> code()->
697 // code_begin(). It is broken to call it without an nmethod assigned.
698 // The usual behavior is to lift any register arguments up out of the
699 // stack and possibly re-pack the extra arguments to be contiguous.
700 // I2C adapters will save what the interpreter's stack pointer will be
701 // after arguments are popped, then adjust the interpreter's frame
702 // size to force alignment and possibly to repack the arguments.
703 // After re-packing, it jumps to the compiled code start. There are
704 // no safepoints in this adapter code and a GC cannot happen while
705 // marshaling is in progress.
706 //
707 // The C2I flavor takes a stock compiled call setup plus the target method in
708 // Rmethod, marshals the arguments for an interpreted call and jumps to
709 // Rmethod->_i2i_entry. On entry, the interpreted frame has not yet been
710 // setup. Compiled frames are fixed-size and the args are likely not in the
711 // right place. Hence all the args will likely be copied into the
712 // interpreter's frame, forcing that frame to grow. The compiled frame's
713 // outgoing stack args will be dead after the copy.
714 //
715 // Native wrappers, like adapters, marshal arguments. Unlike adapters they
716 // also perform an official frame push & pop. They have a call to the native
717 // routine in their middles and end in a return (instead of ending in a jump).
718 // The native wrappers are stored in real nmethods instead of the BufferBlobs
719 // used by the adapters. The code generation happens here because it's very
720 // similar to what the adapters have to do.
721
722 class AdapterHandlerEntry : public MetaspaceObj {
723 friend class AdapterHandlerLibrary;
724
725 public:
726 static const int ENTRIES_COUNT = 7;
727
728 private:
729 AdapterFingerPrint* _fingerprint;
730 AdapterBlob* _adapter_blob;
731 uint _id;
732 bool _linked;
733
734 static const char *_entry_names[];
735
736 // Support for scalarized inline type calling convention
737 const GrowableArray<SigEntry>* _sig_cc;
738 const GrowableArray<SigEntry>* _sig_cc_ro;
739
740 #ifdef ASSERT
741 // Captures code and signature used to generate this adapter when
742 // verifying adapter equivalence.
743 unsigned char* _saved_code;
744 int _saved_code_length;
745 #endif
746
747 AdapterHandlerEntry(int id, AdapterFingerPrint* fingerprint) :
748 _fingerprint(fingerprint),
749 _adapter_blob(nullptr),
750 _id(id),
751 _linked(false),
752 _sig_cc(nullptr),
753 _sig_cc_ro(nullptr)
754 #ifdef ASSERT
755 , _saved_code(nullptr),
756 _saved_code_length(0)
757 #endif
758 { }
759
760 ~AdapterHandlerEntry();
761
762 // Allocate on CHeap instead of metaspace (see JDK-8331086).
763 // Dummy argument is used to avoid C++ warning about using
764 // deleted opearator MetaspaceObj::delete().
765 void* operator new(size_t size, size_t dummy) throw() {
766 assert(size == BytesPerWord * heap_word_size(sizeof(AdapterHandlerEntry)), "should match");
767 void* p = AllocateHeap(size, mtCode);
768 memset(p, 0, size);
769 return p;
770 }
771
772 public:
773 static AdapterHandlerEntry* allocate(uint id, AdapterFingerPrint* fingerprint) {
774 return new(0) AdapterHandlerEntry(id, fingerprint);
775 }
776
777 static void deallocate(AdapterHandlerEntry *handler) {
778 handler->~AdapterHandlerEntry();
779 }
780
781 void set_adapter_blob(AdapterBlob* blob) {
782 _adapter_blob = blob;
783 _linked = true;
784 }
785
786 address get_i2c_entry() const {
787 #ifndef ZERO
788 assert(_adapter_blob != nullptr, "must be");
789 return _adapter_blob->i2c_entry();
790 #else
791 return nullptr;
792 #endif // ZERO
793 }
794
795 address get_c2i_entry() const {
796 #ifndef ZERO
797 assert(_adapter_blob != nullptr, "must be");
798 return _adapter_blob->c2i_entry();
799 #else
800 return nullptr;
801 #endif // ZERO
802 }
803
804 address get_c2i_inline_entry() const {
805 #ifndef ZERO
806 assert(_adapter_blob != nullptr, "must be");
807 return _adapter_blob->c2i_inline_entry();
808 #else
809 return nullptr;
810 #endif // ZERO
811 }
812
813 address get_c2i_inline_ro_entry() const {
814 #ifndef ZERO
815 assert(_adapter_blob != nullptr, "must be");
816 return _adapter_blob->c2i_inline_ro_entry();
817 #else
818 return nullptr;
819 #endif // ZERO
820 }
821
822 address get_c2i_unverified_entry() const {
823 #ifndef ZERO
824 assert(_adapter_blob != nullptr, "must be");
825 return _adapter_blob->c2i_unverified_entry();
826 #else
827 return nullptr;
828 #endif // ZERO
829 }
830
831 address get_c2i_unverified_inline_entry() const {
832 #ifndef ZERO
833 assert(_adapter_blob != nullptr, "must be");
834 return _adapter_blob->c2i_unverified_inline_entry();
835 #else
836 return nullptr;
837 #endif // ZERO
838 }
839
840 address get_c2i_no_clinit_check_entry() const {
841 #ifndef ZERO
842 assert(_adapter_blob != nullptr, "must be");
843 return _adapter_blob->c2i_no_clinit_check_entry();
844 #else
845 return nullptr;
846 #endif // ZERO
847 }
848
849 AdapterBlob* adapter_blob() const { return _adapter_blob; }
850 bool is_linked() const { return _linked; }
851
852 // Support for scalarized inline type calling convention
853 void set_sig_cc(const GrowableArray<SigEntry>* sig) {
854 assert(_sig_cc == nullptr, "Already initialized");
855 _sig_cc = sig;
856 }
857 const GrowableArray<SigEntry>* get_sig_cc() const { return _sig_cc; }
858 void set_sig_cc_ro(const GrowableArray<SigEntry>* sig) {
859 assert(_sig_cc_ro == nullptr, "Already initialized");
860 _sig_cc_ro = sig;
861 }
862 const GrowableArray<SigEntry>* get_sig_cc_ro() const { return _sig_cc_ro; }
863
864 uint id() const { return _id; }
865 AdapterFingerPrint* fingerprint() const { return _fingerprint; }
866
867 #ifdef ASSERT
868 // Used to verify that code generated for shared adapters is equivalent
869 void save_code (unsigned char* code, int length);
870 bool compare_code(AdapterHandlerEntry* other);
871 #endif
872
873 //virtual void print_on(outputStream* st) const; DO NOT USE
874 void print_adapter_on(outputStream* st) const;
875
876 void metaspace_pointers_do(MetaspaceClosure* it);
877 int size() const {return (int)heap_word_size(sizeof(AdapterHandlerEntry)); }
878 MetaspaceObj::Type type() const { return AdapterHandlerEntryType; }
879
880 void remove_unshareable_info() NOT_CDS_RETURN;
881 void link() NOT_CDS_RETURN;
882 };
883
884 #if INCLUDE_CDS
885 class ArchivedAdapterTable;
886 #endif // INCLUDE_CDS
887
888 class CompiledEntrySignature;
889
890 class AdapterHandlerLibrary: public AllStatic {
891 friend class SharedRuntime;
892 private:
893 static volatile uint _id_counter; // counter for generating unique adapter ids, range = [1,UINT_MAX]
894 static BufferBlob* _buffer; // the temporary code buffer in CodeCache
895 static AdapterHandlerEntry* _no_arg_handler;
896 static AdapterHandlerEntry* _int_arg_handler;
897 static AdapterHandlerEntry* _obj_arg_handler;
898 static AdapterHandlerEntry* _obj_int_arg_handler;
899 static AdapterHandlerEntry* _obj_obj_arg_handler;
900 #if INCLUDE_CDS
901 static ArchivedAdapterTable _aot_adapter_handler_table;
902 #endif // INCLUDE_CDS
903
904 static BufferBlob* buffer_blob();
905 static void initialize();
906 static AdapterHandlerEntry* get_simple_adapter(const methodHandle& method);
907 static void lookup_aot_cache(AdapterHandlerEntry* handler);
908 static AdapterHandlerEntry* create_adapter(CompiledEntrySignature& ces,
909 bool allocate_code_blob,
910 bool is_transient = false);
911 static void lookup_simple_adapters() NOT_CDS_RETURN;
912 #ifndef PRODUCT
913 static void print_adapter_handler_info(outputStream* st, AdapterHandlerEntry* handler);
914 #endif // PRODUCT
915 public:
916
917 static AdapterHandlerEntry* new_entry(AdapterFingerPrint* fingerprint);
918 static void create_native_wrapper(const methodHandle& method);
919 static AdapterHandlerEntry* get_adapter(const methodHandle& method);
920 static AdapterHandlerEntry* lookup(const GrowableArray<SigEntry>* sig, bool has_ro_adapter = false);
921 static bool generate_adapter_code(AdapterHandlerEntry* handler,
922 CompiledEntrySignature& ces,
923 bool allocate_code_blob,
924 bool is_transient);
925
926 #ifdef ASSERT
927 static void verify_adapter_sharing(CompiledEntrySignature& ces, AdapterHandlerEntry* cached_entry);
928 #endif // ASSERT
929
930 static void print_handler(const CodeBlob* b) { print_handler_on(tty, b); }
931 static void print_handler_on(outputStream* st, const CodeBlob* b);
932 static const char* name(AdapterHandlerEntry* handler);
933 static uint32_t id(AdapterHandlerEntry* handler);
934 #ifndef PRODUCT
935 static void print_statistics();
936 #endif // PRODUCT
937
938 static void link_aot_adapter_handler(AdapterHandlerEntry* handler) NOT_CDS_RETURN;
939 static void dump_aot_adapter_table() NOT_CDS_RETURN;
940 static void serialize_shared_table_header(SerializeClosure* soc) NOT_CDS_RETURN;
941 static void link_aot_adapters() NOT_CDS_RETURN;
942 static void address_to_offset(address entry_address[AdapterBlob::ENTRY_COUNT], int entry_offset[AdapterBlob::ENTRY_COUNT]);
943 };
944
945 // Utility class for computing the calling convention of the 3 types
946 // of compiled method entries:
947 // Method::_from_compiled_entry - sig_cc
948 // Method::_from_compiled_inline_ro_entry - sig_cc_ro
949 // Method::_from_compiled_inline_entry - sig
950 class CompiledEntrySignature : public StackObj {
951 private:
952 Method* _method;
953 int _num_inline_args;
954 bool _has_inline_recv;
955 GrowableArray<SigEntry>* _sig;
956 GrowableArray<SigEntry>* _sig_cc;
957 GrowableArray<SigEntry>* _sig_cc_ro;
958 VMRegPair* _regs;
959 VMRegPair* _regs_cc;
960 VMRegPair* _regs_cc_ro;
961
962 int _args_on_stack;
963 int _args_on_stack_cc;
964 int _args_on_stack_cc_ro;
965
966 bool _c1_needs_stack_repair;
967 bool _c2_needs_stack_repair;
968
969 GrowableArray<Method*>* _supers;
970 GrowableArray<Method*>* get_supers();
971
972 public:
973 Method* method() const { return _method; }
974
975 // Used by Method::_from_compiled_inline_entry
976 GrowableArray<SigEntry>* sig() const { return _sig; }
977
978 // Used by Method::_from_compiled_entry
979 GrowableArray<SigEntry>* sig_cc() const { return _sig_cc; }
980
981 // Used by Method::_from_compiled_inline_ro_entry
982 GrowableArray<SigEntry>* sig_cc_ro() const { return _sig_cc_ro; }
983
984 VMRegPair* regs() const { return _regs; }
985 VMRegPair* regs_cc() const { return _regs_cc; }
986 VMRegPair* regs_cc_ro() const { return _regs_cc_ro; }
987
988 int args_on_stack() const { return _args_on_stack; }
989 int args_on_stack_cc() const { return _args_on_stack_cc; }
990 int args_on_stack_cc_ro() const { return _args_on_stack_cc_ro; }
991
992 int num_inline_args() const { return _num_inline_args; }
993 bool has_inline_recv() const { return _has_inline_recv; }
994
995 bool has_scalarized_args() const { return _sig != _sig_cc; }
996 bool c1_needs_stack_repair() const { return _c1_needs_stack_repair; }
997 bool c2_needs_stack_repair() const { return _c2_needs_stack_repair; }
998 CodeOffsets::Entries c1_inline_ro_entry_type() const;
999
1000 CompiledEntrySignature(Method* method = nullptr);
1001 void compute_calling_conventions(bool init = true);
1002 void initialize_from_fingerprint(AdapterFingerPrint* fingerprint);
1003 };
1004
1005 #endif // SHARE_RUNTIME_SHAREDRUNTIME_HPP