1 /*
2 * Copyright (c) 1997, 2025, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #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/metaspaceClosure.hpp"
34 #include "memory/resourceArea.hpp"
35 #include "runtime/safepointVerifiers.hpp"
36 #include "runtime/stubInfo.hpp"
37 #include "utilities/macros.hpp"
38
39 class AdapterHandlerEntry;
40 class AdapterFingerPrint;
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 #if INCLUDE_JVMTI
322 // Functions for JVMTI notifications
323 static void notify_jvmti_vthread_start(oopDesc* vt, jboolean hide, JavaThread* current);
324 static void notify_jvmti_vthread_end(oopDesc* vt, jboolean hide, JavaThread* current);
325 static void notify_jvmti_vthread_mount(oopDesc* vt, jboolean hide, JavaThread* current);
326 static void notify_jvmti_vthread_unmount(oopDesc* vt, jboolean hide, JavaThread* current);
327 #endif
328
329 // RedefineClasses() tracing support for obsolete method entry
330 static int rc_trace_method_entry(JavaThread* thread, Method* m);
331
332 // To be used as the entry point for unresolved native methods.
333 static address native_method_throw_unsatisfied_link_error_entry();
334
335 static void register_finalizer(JavaThread* thread, oopDesc* obj);
336
337 // dtrace notifications
338 static int dtrace_object_alloc(oopDesc* o);
339 static int dtrace_object_alloc(JavaThread* thread, oopDesc* o);
340 static int dtrace_object_alloc(JavaThread* thread, oopDesc* o, size_t size);
341 static int dtrace_method_entry(JavaThread* thread, Method* m);
342 static int dtrace_method_exit(JavaThread* thread, Method* m);
343
344 // Utility method for retrieving the Java thread id, returns 0 if the
345 // thread is not a well formed Java thread.
346 static jlong get_java_tid(JavaThread* thread);
347
348
349 // used by native wrappers to re-enable yellow if overflow happened in native code
350 static void reguard_yellow_pages();
351
352 // Fill in the "X cannot be cast to a Y" message for ClassCastException
353 //
354 // @param thr the current thread
355 // @param caster_klass the class of the object we are casting
356 // @return the dynamically allocated exception message (must be freed
357 // by the caller using a resource mark)
358 //
359 // BCP must refer to the current 'checkcast' opcode for the frame
360 // on top of the stack.
361 // The caller (or one of its callers) must use a ResourceMark
362 // in order to correctly free the result.
363 //
364 static char* generate_class_cast_message(JavaThread* thr, Klass* caster_klass);
365
366 // Fill in the "X cannot be cast to a Y" message for ClassCastException
367 //
368 // @param caster_klass the class of the object we are casting
369 // @param target_klass the target klass attempt
370 // @return the dynamically allocated exception message (must be freed
371 // by the caller using a resource mark)
372 //
373 // This version does not require access the frame, so it can be called
374 // from interpreted code
375 // The caller (or one of it's callers) must use a ResourceMark
376 // in order to correctly free the result.
377 //
378 static char* generate_class_cast_message(Klass* caster_klass, Klass* target_klass, Symbol* target_klass_name = nullptr);
379
380 // Resolves a call site- may patch in the destination of the call into the
381 // compiled code.
382 static methodHandle resolve_helper(bool is_virtual, bool is_optimized, TRAPS);
383
384 private:
385 // deopt blob
386 static void generate_deopt_blob(void);
387
388 static bool handle_ic_miss_helper_internal(Handle receiver, nmethod* caller_nm, const frame& caller_frame,
389 methodHandle callee_method, Bytecodes::Code bc, CallInfo& call_info,
390 bool& needs_ic_stub_refill, TRAPS);
391
392 public:
393 static DeoptimizationBlob* deopt_blob(void) { return _deopt_blob; }
394
395 // Resets a call-site in compiled code so it will get resolved again.
396 static methodHandle reresolve_call_site(TRAPS);
397
398 // In the code prolog, if the klass comparison fails, the inline cache
399 // misses and the call site is patched to megamorphic
400 static methodHandle handle_ic_miss_helper(TRAPS);
401
402 // Find the method that called us.
403 static methodHandle find_callee_method(TRAPS);
404
405 static void monitor_enter_helper(oopDesc* obj, BasicLock* lock, JavaThread* thread);
406
407 static void monitor_exit_helper(oopDesc* obj, BasicLock* lock, JavaThread* current);
408
409 private:
410 static Handle find_callee_info(Bytecodes::Code& bc, CallInfo& callinfo, TRAPS);
411 static Handle find_callee_info_helper(vframeStream& vfst, Bytecodes::Code& bc, CallInfo& callinfo, TRAPS);
412
413 static Method* extract_attached_method(vframeStream& vfst);
414
415 #if defined(X86) && defined(COMPILER1)
416 // For Object.hashCode, System.identityHashCode try to pull hashCode from object header if available.
417 static void inline_check_hashcode_from_object_header(MacroAssembler* masm, const methodHandle& method, Register obj_reg, Register result);
418 #endif // X86 && COMPILER1
419
420 public:
421
422 // Read the array of BasicTypes from a Java signature, and compute where
423 // compiled Java code would like to put the results. Values in reg_lo and
424 // reg_hi refer to 4-byte quantities. Values less than SharedInfo::stack0 are
425 // registers, those above refer to 4-byte stack slots. All stack slots are
426 // based off of the window top. SharedInfo::stack0 refers to the first usable
427 // slot in the bottom of the frame. SharedInfo::stack0+1 refers to the memory word
428 // 4-bytes higher.
429 // return value is the maximum number of VMReg stack slots the convention will use.
430 static int java_calling_convention(const BasicType* sig_bt, VMRegPair* regs, int total_args_passed);
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 int max_arg,
480 const BasicType *sig_bt,
481 const VMRegPair *regs,
482 address entry_address[AdapterBlob::ENTRY_COUNT]);
483
484 static void gen_i2c_adapter(MacroAssembler *_masm,
485 int total_args_passed,
486 int comp_args_on_stack,
487 const BasicType *sig_bt,
488 const VMRegPair *regs);
489
490 // OSR support
491
492 // OSR_migration_begin will extract the jvm state from an interpreter
493 // frame (locals, monitors) and store the data in a piece of C heap
494 // storage. This then allows the interpreter frame to be removed from the
495 // stack and the OSR nmethod to be called. That method is called with a
496 // pointer to the C heap storage. This pointer is the return value from
497 // OSR_migration_begin.
498
499 static intptr_t* OSR_migration_begin(JavaThread *thread);
500
501 // OSR_migration_end is a trivial routine. It is called after the compiled
502 // method has extracted the jvm state from the C heap that OSR_migration_begin
503 // created. It's entire job is to simply free this storage.
504 static void OSR_migration_end(intptr_t* buf);
505
506 // Convert a sig into a calling convention register layout
507 // and find interesting things about it.
508 static VMRegPair* find_callee_arguments(Symbol* sig, bool has_receiver, bool has_appendix, int *arg_size);
509 static VMReg name_for_receiver();
510
511 // "Top of Stack" slots that may be unused by the calling convention but must
512 // otherwise be preserved.
513 // On Intel these are not necessary and the value can be zero.
514 // On Sparc this describes the words reserved for storing a register window
515 // when an interrupt occurs.
516 static uint out_preserve_stack_slots();
517
518 // Stack slots that may be unused by the calling convention but must
519 // otherwise be preserved. On Intel this includes the return address.
520 // On PowerPC it includes the 4 words holding the old TOC & LR glue.
521 static uint in_preserve_stack_slots();
522
523 static VMReg thread_register();
524
525 static void continuation_enter_cleanup(MacroAssembler* masm);
526
527 // Is vector's size (in bytes) bigger than a size saved by default?
528 // For example, on x86 16 bytes XMM registers are saved by default.
529 static bool is_wide_vector(int size);
530
531 // Save and restore a native result
532 static void save_native_result(MacroAssembler *_masm, BasicType ret_type, int frame_slots);
533 static void restore_native_result(MacroAssembler *_masm, BasicType ret_type, int frame_slots);
534
535 // Generate a native wrapper for a given method. The method takes arguments
536 // in the Java compiled code convention, marshals them to the native
537 // convention (handlizes oops, etc), transitions to native, makes the call,
538 // returns to java state (possibly blocking), unhandlizes any result and
539 // returns.
540 //
541 // The wrapper may contain special-case code if the given method
542 // is a compiled method handle adapter, such as _invokeBasic, _linkToVirtual, etc.
543 static nmethod* generate_native_wrapper(MacroAssembler* masm,
544 const methodHandle& method,
545 int compile_id,
546 BasicType* sig_bt,
547 VMRegPair* regs,
548 BasicType ret_type);
549
550 // A compiled caller has just called the interpreter, but compiled code
551 // exists. Patch the caller so he no longer calls into the interpreter.
552 static void fixup_callers_callsite(Method* moop, address ret_pc);
553 static bool should_fixup_call_destination(address destination, address entry_point, address caller_pc, Method* moop, CodeBlob* cb);
554
555 // Slow-path Locking and Unlocking
556 static void complete_monitor_locking_C(oopDesc* obj, BasicLock* lock, JavaThread* current);
557 static void complete_monitor_unlocking_C(oopDesc* obj, BasicLock* lock, JavaThread* current);
558
559 // Resolving of calls
560 static address get_resolved_entry (JavaThread* current, methodHandle callee_method);
561 static address resolve_static_call_C (JavaThread* current);
562 static address resolve_virtual_call_C (JavaThread* current);
563 static address resolve_opt_virtual_call_C(JavaThread* current);
564
565 // arraycopy, the non-leaf version. (See StubRoutines for all the leaf calls.)
566 static void slow_arraycopy_C(oopDesc* src, jint src_pos,
567 oopDesc* dest, jint dest_pos,
568 jint length, JavaThread* thread);
569
570 // handle ic miss with caller being compiled code
571 // wrong method handling (inline cache misses)
572 static address handle_wrong_method(JavaThread* current);
573 static address handle_wrong_method_abstract(JavaThread* current);
574 static address handle_wrong_method_ic_miss(JavaThread* current);
575
576 static address handle_unsafe_access(JavaThread* thread, address next_pc);
577
578 private:
579 static PerfTickCounters* _perf_resolve_opt_virtual_total_time;
580 static PerfTickCounters* _perf_resolve_virtual_total_time;
581 static PerfTickCounters* _perf_resolve_static_total_time;
582 static PerfTickCounters* _perf_handle_wrong_method_total_time;
583 static PerfTickCounters* _perf_ic_miss_total_time;
584 public:
585 static uint _ic_miss_ctr; // total # of IC misses
586 static uint _wrong_method_ctr;
587 static uint _resolve_static_ctr;
588 static uint _resolve_virtual_ctr;
589 static uint _resolve_opt_virtual_ctr;
590
591 static void print_counters_on(outputStream* st);
592
593 #ifndef PRODUCT
594
595 // Collect and print inline cache miss statistics
596 private:
597 enum { maxICmiss_count = 100 };
598 static int _ICmiss_index; // length of IC miss histogram
599 static int _ICmiss_count[maxICmiss_count]; // miss counts
600 static address _ICmiss_at[maxICmiss_count]; // miss addresses
601 static void trace_ic_miss(address at);
602
603 public:
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
648 static void print_call_statistics_on(outputStream* st);
649 static void print_ic_miss_histogram_on(outputStream* st);
650
651 #ifdef COMPILER2
652 // Runtime methods for printf-style debug nodes
653 static void debug_print_value(jboolean x);
654 static void debug_print_value(jbyte x);
655 static void debug_print_value(jshort x);
656 static void debug_print_value(jchar x);
657 static void debug_print_value(jint x);
658 static void debug_print_value(jlong x);
659 static void debug_print_value(jfloat x);
660 static void debug_print_value(jdouble x);
661 static void debug_print_value(oopDesc* x);
662
663 template <typename T, typename... Rest>
664 static void debug_print_rec(T arg, Rest... args) {
665 debug_print_value(arg);
666 debug_print_rec(args...);
667 }
668
669 static void debug_print_rec() {}
670
671 // template is required here as we need to know the exact signature at compile-time
672 template <typename... TT>
673 static void debug_print(const char *str, TT... args) {
674 // these three lines are the manual expansion of JRT_LEAF ... JRT_END, does not work well with templates
675 DEBUG_ONLY(NoHandleMark __hm;)
676 os::verify_stack_alignment();
677 DEBUG_ONLY(NoSafepointVerifier __nsv;)
678
679 tty->print_cr("%s", str);
680 debug_print_rec(args...);
681 }
682 #endif // COMPILER2
683
684 #endif // PRODUCT
685
686 static void print_statistics() PRODUCT_RETURN;
687 };
688
689
690 // ---------------------------------------------------------------------------
691 // Implementation of AdapterHandlerLibrary
692 //
693 // This library manages argument marshaling adapters and native wrappers.
694 // There are 2 flavors of adapters: I2C and C2I.
695 //
696 // The I2C flavor takes a stock interpreted call setup, marshals the
697 // arguments for a Java-compiled call, and jumps to Rmethod-> code()->
698 // code_begin(). It is broken to call it without an nmethod assigned.
699 // The usual behavior is to lift any register arguments up out of the
700 // stack and possibly re-pack the extra arguments to be contiguous.
701 // I2C adapters will save what the interpreter's stack pointer will be
702 // after arguments are popped, then adjust the interpreter's frame
703 // size to force alignment and possibly to repack the arguments.
704 // After re-packing, it jumps to the compiled code start. There are
705 // no safepoints in this adapter code and a GC cannot happen while
706 // marshaling is in progress.
707 //
708 // The C2I flavor takes a stock compiled call setup plus the target method in
709 // Rmethod, marshals the arguments for an interpreted call and jumps to
710 // Rmethod->_i2i_entry. On entry, the interpreted frame has not yet been
711 // setup. Compiled frames are fixed-size and the args are likely not in the
712 // right place. Hence all the args will likely be copied into the
713 // interpreter's frame, forcing that frame to grow. The compiled frame's
714 // outgoing stack args will be dead after the copy.
715 //
716 // Native wrappers, like adapters, marshal arguments. Unlike adapters they
717 // also perform an official frame push & pop. They have a call to the native
718 // routine in their middles and end in a return (instead of ending in a jump).
719 // The native wrappers are stored in real nmethods instead of the BufferBlobs
720 // used by the adapters. The code generation happens here because it's very
721 // similar to what the adapters have to do.
722
723 class AdapterHandlerEntry : public MetaspaceObj {
724 friend class AdapterHandlerLibrary;
725
726 public:
727 static const int ENTRIES_COUNT = 4;
728
729 private:
730 AdapterFingerPrint* _fingerprint;
731 AdapterBlob* _adapter_blob;
732 uint _id;
733 bool _linked;
734
735 static const char *_entry_names[];
736
737 #ifdef ASSERT
738 // Captures code and signature used to generate this adapter when
739 // verifying adapter equivalence.
740 unsigned char* _saved_code;
741 int _saved_code_length;
742 #endif
743
744 AdapterHandlerEntry(int id, AdapterFingerPrint* fingerprint) :
745 _fingerprint(fingerprint),
746 _adapter_blob(nullptr),
747 _id(id),
748 _linked(false)
749 #ifdef ASSERT
750 , _saved_code(nullptr),
751 _saved_code_length(0)
752 #endif
753 { }
754
755 ~AdapterHandlerEntry();
756
757 // Allocate on CHeap instead of metaspace (see JDK-8331086).
758 // Dummy argument is used to avoid C++ warning about using
759 // deleted opearator MetaspaceObj::delete().
760 void* operator new(size_t size, size_t dummy) throw() {
761 assert(size == BytesPerWord * heap_word_size(sizeof(AdapterHandlerEntry)), "should match");
762 void* p = AllocateHeap(size, mtCode);
763 memset(p, 0, size);
764 return p;
765 }
766
767 public:
768 static AdapterHandlerEntry* allocate(uint id, AdapterFingerPrint* fingerprint) {
769 return new(0) AdapterHandlerEntry(id, fingerprint);
770 }
771
772 static void deallocate(AdapterHandlerEntry *handler) {
773 handler->~AdapterHandlerEntry();
774 }
775
776 void set_adapter_blob(AdapterBlob* blob) {
777 _adapter_blob = blob;
778 _linked = true;
779 }
780
781 address get_i2c_entry() const {
782 #ifndef ZERO
783 assert(_adapter_blob != nullptr, "must be");
784 return _adapter_blob->i2c_entry();
785 #else
786 return nullptr;
787 #endif // ZERO
788 }
789
790 address get_c2i_entry() const {
791 #ifndef ZERO
792 assert(_adapter_blob != nullptr, "must be");
793 return _adapter_blob->c2i_entry();
794 #else
795 return nullptr;
796 #endif // ZERO
797 }
798
799 address get_c2i_unverified_entry() const {
800 #ifndef ZERO
801 assert(_adapter_blob != nullptr, "must be");
802 return _adapter_blob->c2i_unverified_entry();
803 #else
804 return nullptr;
805 #endif // ZERO
806 }
807
808 address get_c2i_no_clinit_check_entry() const {
809 #ifndef ZERO
810 assert(_adapter_blob != nullptr, "must be");
811 return _adapter_blob->c2i_no_clinit_check_entry();
812 #else
813 return nullptr;
814 #endif // ZERO
815 }
816
817 AdapterBlob* adapter_blob() const { return _adapter_blob; }
818 bool is_linked() const { return _linked; }
819
820 uint id() const { return _id; }
821 AdapterFingerPrint* fingerprint() const { return _fingerprint; }
822
823 #ifdef ASSERT
824 // Used to verify that code generated for shared adapters is equivalent
825 void save_code (unsigned char* code, int length);
826 bool compare_code(AdapterHandlerEntry* other);
827 #endif
828
829 //virtual void print_on(outputStream* st) const; DO NOT USE
830 void print_adapter_on(outputStream* st) const;
831
832 void metaspace_pointers_do(MetaspaceClosure* it);
833 int size() const {return (int)heap_word_size(sizeof(AdapterHandlerEntry)); }
834 MetaspaceObj::Type type() const { return AdapterHandlerEntryType; }
835
836 void remove_unshareable_info() NOT_CDS_RETURN;
837 void link() NOT_CDS_RETURN;
838 };
839
840 #if INCLUDE_CDS
841 class ArchivedAdapterTable;
842 #endif // INCLUDE_CDS
843
844 class AdapterHandlerLibrary: public AllStatic {
845 friend class SharedRuntime;
846 private:
847 static volatile uint _id_counter; // counter for generating unique adapter ids, range = [1,UINT_MAX]
848 static BufferBlob* _buffer; // the temporary code buffer in CodeCache
849 static AdapterHandlerEntry* _no_arg_handler;
850 static AdapterHandlerEntry* _int_arg_handler;
851 static AdapterHandlerEntry* _obj_arg_handler;
852 static AdapterHandlerEntry* _obj_int_arg_handler;
853 static AdapterHandlerEntry* _obj_obj_arg_handler;
854 #if INCLUDE_CDS
855 static ArchivedAdapterTable _aot_adapter_handler_table;
856 #endif // INCLUDE_CDS
857
858 static BufferBlob* buffer_blob();
859 static void initialize();
860 static AdapterHandlerEntry* get_simple_adapter(const methodHandle& method);
861 static void lookup_aot_cache(AdapterHandlerEntry* handler);
862 static AdapterHandlerEntry* create_adapter(int total_args_passed,
863 BasicType* sig_bt,
864 bool is_transient = false);
865 static void lookup_simple_adapters() NOT_CDS_RETURN;
866 #ifndef PRODUCT
867 static void print_adapter_handler_info(outputStream* st, AdapterHandlerEntry* handler);
868 #endif // PRODUCT
869 public:
870
871 static AdapterHandlerEntry* new_entry(AdapterFingerPrint* fingerprint);
872 static void create_native_wrapper(const methodHandle& method);
873 static AdapterHandlerEntry* get_adapter(const methodHandle& method);
874 static AdapterHandlerEntry* lookup(int total_args_passed, BasicType* sig_bt);
875 static bool generate_adapter_code(AdapterHandlerEntry* handler,
876 int total_args_passed,
877 BasicType* sig_bt,
878 bool is_transient);
879
880 #ifdef ASSERT
881 static void verify_adapter_sharing(int total_args_passed, BasicType* sig_bt, AdapterHandlerEntry* cached);
882 #endif // ASSERT
883
884 static void print_handler(const CodeBlob* b) { print_handler_on(tty, b); }
885 static void print_handler_on(outputStream* st, const CodeBlob* b);
886 static bool contains(const CodeBlob* b);
887 static const char* name(AdapterHandlerEntry* handler);
888 static uint32_t id(AdapterHandlerEntry* handler);
889 #ifndef PRODUCT
890 static void print_statistics_on(outputStream* st);
891 #endif // PRODUCT
892
893 static void link_aot_adapter_handler(AdapterHandlerEntry* handler) NOT_CDS_RETURN;
894 static void dump_aot_adapter_table() NOT_CDS_RETURN;
895 static void serialize_shared_table_header(SerializeClosure* soc) NOT_CDS_RETURN;
896 static void link_aot_adapters() NOT_CDS_RETURN;
897 static void address_to_offset(address entry_address[AdapterBlob::ENTRY_COUNT], int entry_offset[AdapterBlob::ENTRY_COUNT]);
898 };
899
900 #endif // SHARE_RUNTIME_SHAREDRUNTIME_HPP