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