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