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