1 /*
  2  * Copyright (c) 1997, 2024, 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 "code/codeBlob.hpp"
 29 #include "code/vmreg.hpp"
 30 #include "interpreter/linkResolver.hpp"
 31 #include "memory/allStatic.hpp"
 32 #include "memory/resourceArea.hpp"
 33 #include "runtime/stubDeclarations.hpp"
 34 #include "utilities/macros.hpp"
 35 
 36 class AdapterHandlerEntry;
 37 class AdapterFingerPrint;
 38 class vframeStream;
 39 class ObjectWaiter;
 40 
 41 // Runtime is the base class for various runtime interfaces
 42 // (InterpreterRuntime, CompilerRuntime, etc.). It provides
 43 // shared functionality such as exception forwarding (C++ to
 44 // Java exceptions), locking/unlocking mechanisms, statistical
 45 // information, etc.
 46 
 47 // define SharedStubId enum tags: wrong_method_id, etc
 48 
 49 #define SHARED_STUB_ID_ENUM_DECLARE(name, type) STUB_ID_NAME(name),
 50 enum class SharedStubId :int {
 51   NO_STUBID = -1,
 52   SHARED_STUBS_DO(SHARED_STUB_ID_ENUM_DECLARE)
 53   NUM_STUBIDS
 54 };
 55 #undef SHARED_STUB_ID_ENUM_DECLARE
 56 
 57 class SharedRuntime: AllStatic {
 58   friend class VMStructs;
 59 
 60  private:
 61   // Declare shared stub fields
 62 #define SHARED_STUB_FIELD_DECLARE(name, type) \
 63   static type        BLOB_FIELD_NAME(name);
 64   SHARED_STUBS_DO(SHARED_STUB_FIELD_DECLARE)
 65 #undef SHARED_STUB_FIELD_DECLARE
 66 
 67 #ifdef ASSERT
 68   static bool is_resolve_id(SharedStubId id) {
 69     return (id == SharedStubId::wrong_method_id ||
 70             id == SharedStubId::wrong_method_abstract_id ||
 71             id == SharedStubId::ic_miss_id ||
 72             id == SharedStubId::resolve_opt_virtual_call_id ||
 73             id == SharedStubId::resolve_virtual_call_id ||
 74             id == SharedStubId::resolve_static_call_id);
 75   }
 76   static bool is_polling_page_id(SharedStubId id) {
 77     return (id == SharedStubId::polling_page_vectors_safepoint_handler_id ||
 78             id == SharedStubId::polling_page_safepoint_handler_id ||
 79             id == SharedStubId::polling_page_return_handler_id);
 80   }
 81   static bool is_throw_id(SharedStubId id) {
 82     return (id == SharedStubId::throw_AbstractMethodError_id ||
 83             id == SharedStubId::throw_IncompatibleClassChangeError_id ||
 84             id == SharedStubId::throw_NullPointerException_at_call_id ||
 85             id == SharedStubId::throw_StackOverflowError_id ||
 86             id == SharedStubId::throw_delayed_StackOverflowError_id);
 87   }
 88 #endif   
 89     
 90   static int _object_wait_resume_offset;
 91 
 92   // cont_doYieldStub is not yet folded into the general model for
 93   // shared stub/blob handling. It is actually a specially generated
 94   // native wrapper for a specific native method, as also is it's
 95   // counterpart the continuation do_enter method.
 96   static nmethod*            _cont_doYield_stub;
 97 
 98   // Stub names indexed by SharedStubId
 99   static const char *_stub_names[];
100 
101 #ifndef PRODUCT
102   // Counters
103   static int64_t _nof_megamorphic_calls;         // total # of megamorphic calls (through vtable)
104 #endif // !PRODUCT
105 
106  private:
107   static SafepointBlob* generate_handler_blob(SharedStubId id, address call_ptr);
108   static RuntimeStub*   generate_resolve_blob(SharedStubId id, address destination);
109   static RuntimeStub*   generate_throw_exception(SharedStubId id, address runtime_entry);
110  public:
111   static void generate_initial_stubs(void);
112   static void generate_stubs(void);
113 #if INCLUDE_JFR
114   static void generate_jfr_stubs(void);
115   // For c2: c_rarg0 is junk, call to runtime to write a checkpoint.
116   // It returns a jobject handle to the event writer.
117   // The handle is dereferenced and the return value is the event writer oop.
118   static RuntimeStub* generate_jfr_write_checkpoint();
119   // For c2: call to runtime to return a buffer lease.
120   static RuntimeStub* generate_jfr_return_lease();
121 #endif
122 
123   static const char *stub_name(SharedStubId id) {
124     assert(id > SharedStubId::NO_STUBID && id < SharedStubId::NUM_STUBIDS, "stub id out of range");
125     return _stub_names[(int)id];
126   }
127 
128   // max bytes for each dtrace string parameter
129   enum { max_dtrace_string_size = 256 };
130 
131   // The following arithmetic routines are used on platforms that do
132   // not have machine instructions to implement their functionality.
133   // Do not remove these.
134 
135   // long arithmetics
136   static jlong   lmul(jlong y, jlong x);
137   static jlong   ldiv(jlong y, jlong x);
138   static jlong   lrem(jlong y, jlong x);
139 
140   // float and double remainder
141   static jfloat  frem(jfloat  x, jfloat  y);
142   static jdouble drem(jdouble x, jdouble y);
143 
144 
145 #ifdef _WIN64
146   // Workaround for fmod issue in the Windows x64 CRT
147   static double fmod_winx64(double x, double y);
148 #endif
149 
150 #ifdef __SOFTFP__
151   static jfloat  fadd(jfloat x, jfloat y);
152   static jfloat  fsub(jfloat x, jfloat y);
153   static jfloat  fmul(jfloat x, jfloat y);
154   static jfloat  fdiv(jfloat x, jfloat y);
155 
156   static jdouble dadd(jdouble x, jdouble y);
157   static jdouble dsub(jdouble x, jdouble y);
158   static jdouble dmul(jdouble x, jdouble y);
159   static jdouble ddiv(jdouble x, jdouble y);
160 #endif // __SOFTFP__
161 
162   // float conversion (needs to set appropriate rounding mode)
163   static jint    f2i (jfloat  x);
164   static jlong   f2l (jfloat  x);
165   static jint    d2i (jdouble x);
166   static jlong   d2l (jdouble x);
167   static jfloat  d2f (jdouble x);
168   static jfloat  l2f (jlong   x);
169   static jdouble l2d (jlong   x);
170   static jfloat  i2f (jint    x);
171 
172 #ifdef __SOFTFP__
173   static jdouble i2d (jint    x);
174   static jdouble f2d (jfloat  x);
175 #endif // __SOFTFP__
176 
177   // double trigonometrics and transcendentals
178   static jdouble dsin(jdouble x);
179   static jdouble dcos(jdouble x);
180   static jdouble dtan(jdouble x);
181   static jdouble dlog(jdouble x);
182   static jdouble dlog10(jdouble x);
183   static jdouble dexp(jdouble x);
184   static jdouble dpow(jdouble x, jdouble y);
185 
186 #if defined(__SOFTFP__) || defined(E500V2)
187   static double dabs(double f);
188 #endif
189 
190 #if defined(__SOFTFP__) || defined(PPC)
191   static double dsqrt(double f);
192 #endif
193 
194   // Montgomery multiplication
195   static void montgomery_multiply(jint *a_ints, jint *b_ints, jint *n_ints,
196                                   jint len, jlong inv, jint *m_ints);
197   static void montgomery_square(jint *a_ints, jint *n_ints,
198                                 jint len, jlong inv, jint *m_ints);
199 
200 #ifdef __SOFTFP__
201   // C++ compiler generates soft float instructions as well as passing
202   // float and double in registers.
203   static int  fcmpl(float x, float y);
204   static int  fcmpg(float x, float y);
205   static int  dcmpl(double x, double y);
206   static int  dcmpg(double x, double y);
207 
208   static int unordered_fcmplt(float x, float y);
209   static int unordered_dcmplt(double x, double y);
210   static int unordered_fcmple(float x, float y);
211   static int unordered_dcmple(double x, double y);
212   static int unordered_fcmpge(float x, float y);
213   static int unordered_dcmpge(double x, double y);
214   static int unordered_fcmpgt(float x, float y);
215   static int unordered_dcmpgt(double x, double y);
216 
217   static float  fneg(float f);
218   static double dneg(double f);
219 #endif
220 
221   // exception handling across interpreter/compiler boundaries
222   static address raw_exception_handler_for_return_address(JavaThread* current, address return_address);
223   static address exception_handler_for_return_address(JavaThread* current, address return_address);
224 
225   // exception handling and implicit exceptions
226   static address compute_compiled_exc_handler(nmethod* nm, address ret_pc, Handle& exception,
227                                               bool force_unwind, bool top_frame_only, bool& recursive_exception_occurred);
228   enum ImplicitExceptionKind {
229     IMPLICIT_NULL,
230     IMPLICIT_DIVIDE_BY_ZERO,
231     STACK_OVERFLOW
232   };
233   static void    throw_AbstractMethodError(JavaThread* current);
234   static void    throw_IncompatibleClassChangeError(JavaThread* current);
235   static void    throw_ArithmeticException(JavaThread* current);
236   static void    throw_NullPointerException(JavaThread* current);
237   static void    throw_NullPointerException_at_call(JavaThread* current);
238   static void    throw_StackOverflowError(JavaThread* current);
239   static void    throw_delayed_StackOverflowError(JavaThread* current);
240   static void    throw_StackOverflowError_common(JavaThread* current, bool delayed);
241   static address continuation_for_implicit_exception(JavaThread* current,
242                                                      address faulting_pc,
243                                                      ImplicitExceptionKind exception_kind);
244 
245   static int object_wait_resume_offset() { return _object_wait_resume_offset; }
246   static void set_object_wait_resume_offset(int offset) {
247     _object_wait_resume_offset = offset;
248   }
249 
250   // Post-slow-path-allocation, pre-initializing-stores step for
251   // implementing e.g. ReduceInitialCardMarks
252   static void on_slowpath_allocation_exit(JavaThread* current);
253 
254   static void enable_stack_reserved_zone(JavaThread* current);
255   static frame look_for_reserved_stack_annotated_method(JavaThread* current, frame fr);
256 
257   // Shared stub locations
258   static address get_poll_stub(address pc);
259 
260   static address get_ic_miss_stub() {
261     assert(_ic_miss_blob!= nullptr, "oops");
262     return _ic_miss_blob->entry_point();
263   }
264 
265   static address get_handle_wrong_method_stub() {
266     assert(_wrong_method_blob!= nullptr, "oops");
267     return _wrong_method_blob->entry_point();
268   }
269 
270   static address get_handle_wrong_method_abstract_stub() {
271     assert(_wrong_method_abstract_blob!= nullptr, "oops");
272     return _wrong_method_abstract_blob->entry_point();
273   }
274 
275   static address get_resolve_opt_virtual_call_stub() {
276     assert(_resolve_opt_virtual_call_blob != nullptr, "oops");
277     return _resolve_opt_virtual_call_blob->entry_point();
278   }
279   static address get_resolve_virtual_call_stub() {
280     assert(_resolve_virtual_call_blob != nullptr, "oops");
281     return _resolve_virtual_call_blob->entry_point();
282   }
283   static address get_resolve_static_call_stub() {
284     assert(_resolve_static_call_blob != nullptr, "oops");
285     return _resolve_static_call_blob->entry_point();
286   }
287 
288   static SafepointBlob* polling_page_return_handler_blob()     { return _polling_page_return_handler_blob; }
289   static SafepointBlob* polling_page_safepoint_handler_blob()  { return _polling_page_safepoint_handler_blob; }
290   static SafepointBlob* polling_page_vectors_safepoint_handler_blob()  { return _polling_page_vectors_safepoint_handler_blob; }
291 
292   static nmethod* cont_doYield_stub() {
293     assert(_cont_doYield_stub != nullptr, "oops");
294     return _cont_doYield_stub;
295   }
296 
297   // Implicit exceptions
298   static address throw_AbstractMethodError_entry()          { return _throw_AbstractMethodError_blob->entry_point(); }
299   static address throw_IncompatibleClassChangeError_entry() { return _throw_IncompatibleClassChangeError_blob->entry_point(); }
300   static address throw_NullPointerException_at_call_entry() { return _throw_NullPointerException_at_call_blob->entry_point(); }
301   static address throw_StackOverflowError_entry()           { return _throw_StackOverflowError_blob->entry_point(); }
302   static address throw_delayed_StackOverflowError_entry()   { return _throw_delayed_StackOverflowError_blob->entry_point(); }
303 
304 #if INCLUDE_JFR
305   static address jfr_write_checkpoint() { return _jfr_write_checkpoint_blob->entry_point(); }
306   static address jfr_return_lease()     { return _jfr_return_lease_blob->entry_point(); }
307 #endif
308 
309   // Counters
310 #ifndef PRODUCT
311   static address nof_megamorphic_calls_addr() { return (address)&_nof_megamorphic_calls; }
312 #endif // PRODUCT
313 
314   // Helper routine for full-speed JVMTI exception throwing support
315   static void throw_and_post_jvmti_exception(JavaThread* current, Handle h_exception);
316   static void throw_and_post_jvmti_exception(JavaThread* current, Symbol* name, const char *message = nullptr);
317 
318 #if INCLUDE_JVMTI
319   // Functions for JVMTI notifications
320   static void notify_jvmti_vthread_start(oopDesc* vt, jboolean hide, JavaThread* current);
321   static void notify_jvmti_vthread_end(oopDesc* vt, jboolean hide, JavaThread* current);
322   static void notify_jvmti_vthread_mount(oopDesc* vt, jboolean hide, JavaThread* current);
323   static void notify_jvmti_vthread_unmount(oopDesc* vt, jboolean hide, JavaThread* current);
324 #endif
325 
326   // RedefineClasses() tracing support for obsolete method entry
327   static int rc_trace_method_entry(JavaThread* thread, Method* m);
328 
329   // To be used as the entry point for unresolved native methods.
330   static address native_method_throw_unsatisfied_link_error_entry();
331 
332   static void register_finalizer(JavaThread* thread, oopDesc* obj);
333 
334   // dtrace notifications
335   static int dtrace_object_alloc(oopDesc* o);
336   static int dtrace_object_alloc(JavaThread* thread, oopDesc* o);
337   static int dtrace_object_alloc(JavaThread* thread, oopDesc* o, size_t size);
338   static int dtrace_method_entry(JavaThread* thread, Method* m);
339   static int dtrace_method_exit(JavaThread* thread, Method* m);
340 
341   // Utility method for retrieving the Java thread id, returns 0 if the
342   // thread is not a well formed Java thread.
343   static jlong get_java_tid(JavaThread* thread);
344 
345 
346   // used by native wrappers to re-enable yellow if overflow happened in native code
347   static void reguard_yellow_pages();
348 
349   // Fill in the "X cannot be cast to a Y" message for ClassCastException
350   //
351   // @param thr the current thread
352   // @param caster_klass the class of the object we are casting
353   // @return the dynamically allocated exception message (must be freed
354   // by the caller using a resource mark)
355   //
356   // BCP must refer to the current 'checkcast' opcode for the frame
357   // on top of the stack.
358   // The caller (or one of its callers) must use a ResourceMark
359   // in order to correctly free the result.
360   //
361   static char* generate_class_cast_message(JavaThread* thr, Klass* caster_klass);
362 
363   // Fill in the "X cannot be cast to a Y" message for ClassCastException
364   //
365   // @param caster_klass the class of the object we are casting
366   // @param target_klass the target klass attempt
367   // @return the dynamically allocated exception message (must be freed
368   // by the caller using a resource mark)
369   //
370   // This version does not require access the frame, so it can be called
371   // from interpreted code
372   // The caller (or one of it's callers) must use a ResourceMark
373   // in order to correctly free the result.
374   //
375   static char* generate_class_cast_message(Klass* caster_klass, Klass* target_klass, Symbol* target_klass_name = nullptr);
376 
377   // Resolves a call site- may patch in the destination of the call into the
378   // compiled code.
379   static methodHandle resolve_helper(bool is_virtual, bool is_optimized, TRAPS);
380 
381  private:
382   // deopt blob
383   static void generate_deopt_blob(void);
384 
385   static bool handle_ic_miss_helper_internal(Handle receiver, nmethod* caller_nm, const frame& caller_frame,
386                                              methodHandle callee_method, Bytecodes::Code bc, CallInfo& call_info,
387                                              bool& needs_ic_stub_refill, TRAPS);
388 
389  public:
390   static DeoptimizationBlob* deopt_blob(void)      { return _deopt_blob; }
391 
392   // Resets a call-site in compiled code so it will get resolved again.
393   static methodHandle reresolve_call_site(TRAPS);
394 
395   // In the code prolog, if the klass comparison fails, the inline cache
396   // misses and the call site is patched to megamorphic
397   static methodHandle handle_ic_miss_helper(TRAPS);
398 
399   // Find the method that called us.
400   static methodHandle find_callee_method(TRAPS);
401 
402   static void monitor_enter_helper(oopDesc* obj, BasicLock* lock, JavaThread* thread);
403 
404   static void monitor_exit_helper(oopDesc* obj, BasicLock* lock, JavaThread* current);
405 
406   // Issue UL warning for unlocked JNI monitor on virtual thread termination
407   static void log_jni_monitor_still_held();
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 AdapterHandlerEntry* generate_i2c2i_adapters(MacroAssembler *_masm,
478                                                       int total_args_passed,
479                                                       int max_arg,
480                                                       const BasicType *sig_bt,
481                                                       const VMRegPair *regs,
482                                                       AdapterFingerPrint* fingerprint);
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 #ifndef PRODUCT
579 
580   // Collect and print inline cache miss statistics
581  private:
582   enum { maxICmiss_count = 100 };
583   static int     _ICmiss_index;                  // length of IC miss histogram
584   static int     _ICmiss_count[maxICmiss_count]; // miss counts
585   static address _ICmiss_at[maxICmiss_count];    // miss addresses
586   static void trace_ic_miss(address at);
587 
588  public:
589   static uint _ic_miss_ctr;                      // total # of IC misses
590   static uint _wrong_method_ctr;
591   static uint _resolve_static_ctr;
592   static uint _resolve_virtual_ctr;
593   static uint _resolve_opt_virtual_ctr;
594   static uint _implicit_null_throws;
595   static uint _implicit_div0_throws;
596 
597   static uint _jbyte_array_copy_ctr;       // Slow-path byte array copy
598   static uint _jshort_array_copy_ctr;      // Slow-path short array copy
599   static uint _jint_array_copy_ctr;        // Slow-path int array copy
600   static uint _jlong_array_copy_ctr;       // Slow-path long array copy
601   static uint _oop_array_copy_ctr;         // Slow-path oop array copy
602   static uint _checkcast_array_copy_ctr;   // Slow-path oop array copy, with cast
603   static uint _unsafe_array_copy_ctr;      // Slow-path includes alignment checks
604   static uint _generic_array_copy_ctr;     // Slow-path includes type decoding
605   static uint _slow_array_copy_ctr;        // Slow-path failed out to a method call
606 
607   static uint _unsafe_set_memory_ctr;      // Slow-path includes alignment checks
608 
609   static uint _new_instance_ctr;           // 'new' object requires GC
610   static uint _new_array_ctr;              // 'new' array requires GC
611   static uint _multi2_ctr, _multi3_ctr, _multi4_ctr, _multi5_ctr;
612   static uint _find_handler_ctr;           // find exception handler
613   static uint _rethrow_ctr;                // rethrow exception
614   static uint _mon_enter_stub_ctr;         // monitor enter stub
615   static uint _mon_exit_stub_ctr;          // monitor exit stub
616   static uint _mon_enter_ctr;              // monitor enter slow
617   static uint _mon_exit_ctr;               // monitor exit slow
618   static uint _partial_subtype_ctr;        // SubRoutines::partial_subtype_check
619 
620   // Statistics code
621   // stats for "normal" compiled calls (non-interface)
622   static int64_t _nof_normal_calls;               // total # of calls
623   static int64_t _nof_inlined_calls;              // total # of inlined normal calls
624   static int64_t _nof_static_calls;               // total # of calls to static methods or super methods (invokespecial)
625   static int64_t _nof_inlined_static_calls;       // total # of inlined static calls
626   // stats for compiled interface calls
627   static int64_t _nof_interface_calls;            // total # of compiled calls
628   static int64_t _nof_inlined_interface_calls;    // total # of inlined interface calls
629 
630  public: // for compiler
631   static address nof_normal_calls_addr()                { return (address)&_nof_normal_calls; }
632   static address nof_inlined_calls_addr()               { return (address)&_nof_inlined_calls; }
633   static address nof_static_calls_addr()                { return (address)&_nof_static_calls; }
634   static address nof_inlined_static_calls_addr()        { return (address)&_nof_inlined_static_calls; }
635   static address nof_interface_calls_addr()             { return (address)&_nof_interface_calls; }
636   static address nof_inlined_interface_calls_addr()     { return (address)&_nof_inlined_interface_calls; }
637   static void print_call_statistics(uint64_t comp_total);
638   static void print_ic_miss_histogram();
639 
640 #endif // PRODUCT
641 
642   static void print_statistics() PRODUCT_RETURN;
643 };
644 
645 
646 // ---------------------------------------------------------------------------
647 // Implementation of AdapterHandlerLibrary
648 //
649 // This library manages argument marshaling adapters and native wrappers.
650 // There are 2 flavors of adapters: I2C and C2I.
651 //
652 // The I2C flavor takes a stock interpreted call setup, marshals the
653 // arguments for a Java-compiled call, and jumps to Rmethod-> code()->
654 // code_begin().  It is broken to call it without an nmethod assigned.
655 // The usual behavior is to lift any register arguments up out of the
656 // stack and possibly re-pack the extra arguments to be contiguous.
657 // I2C adapters will save what the interpreter's stack pointer will be
658 // after arguments are popped, then adjust the interpreter's frame
659 // size to force alignment and possibly to repack the arguments.
660 // After re-packing, it jumps to the compiled code start.  There are
661 // no safepoints in this adapter code and a GC cannot happen while
662 // marshaling is in progress.
663 //
664 // The C2I flavor takes a stock compiled call setup plus the target method in
665 // Rmethod, marshals the arguments for an interpreted call and jumps to
666 // Rmethod->_i2i_entry.  On entry, the interpreted frame has not yet been
667 // setup.  Compiled frames are fixed-size and the args are likely not in the
668 // right place.  Hence all the args will likely be copied into the
669 // interpreter's frame, forcing that frame to grow.  The compiled frame's
670 // outgoing stack args will be dead after the copy.
671 //
672 // Native wrappers, like adapters, marshal arguments.  Unlike adapters they
673 // also perform an official frame push & pop.  They have a call to the native
674 // routine in their middles and end in a return (instead of ending in a jump).
675 // The native wrappers are stored in real nmethods instead of the BufferBlobs
676 // used by the adapters.  The code generation happens here because it's very
677 // similar to what the adapters have to do.
678 
679 class AdapterHandlerEntry : public CHeapObj<mtCode> {
680   friend class AdapterHandlerLibrary;
681 
682  private:
683   AdapterFingerPrint* _fingerprint;
684   address _i2c_entry;
685   address _c2i_entry;
686   address _c2i_unverified_entry;
687   address _c2i_no_clinit_check_entry;
688 
689 #ifdef ASSERT
690   // Captures code and signature used to generate this adapter when
691   // verifying adapter equivalence.
692   unsigned char* _saved_code;
693   int            _saved_code_length;
694 #endif
695 
696   AdapterHandlerEntry(AdapterFingerPrint* fingerprint, address i2c_entry, address c2i_entry,
697                       address c2i_unverified_entry,
698                       address c2i_no_clinit_check_entry) :
699     _fingerprint(fingerprint),
700     _i2c_entry(i2c_entry),
701     _c2i_entry(c2i_entry),
702     _c2i_unverified_entry(c2i_unverified_entry),
703     _c2i_no_clinit_check_entry(c2i_no_clinit_check_entry)
704 #ifdef ASSERT
705     , _saved_code_length(0)
706 #endif
707   { }
708 
709   ~AdapterHandlerEntry();
710 
711  public:
712   address get_i2c_entry()                  const { return _i2c_entry; }
713   address get_c2i_entry()                  const { return _c2i_entry; }
714   address get_c2i_unverified_entry()       const { return _c2i_unverified_entry; }
715   address get_c2i_no_clinit_check_entry()  const { return _c2i_no_clinit_check_entry; }
716 
717   address base_address();
718   void relocate(address new_base);
719 
720   AdapterFingerPrint* fingerprint() const { return _fingerprint; }
721 
722 #ifdef ASSERT
723   // Used to verify that code generated for shared adapters is equivalent
724   void save_code   (unsigned char* code, int length);
725   bool compare_code(AdapterHandlerEntry* other);
726 #endif
727 
728   //virtual void print_on(outputStream* st) const;  DO NOT USE
729   void print_adapter_on(outputStream* st) const;
730 };
731 
732 class AdapterHandlerLibrary: public AllStatic {
733   friend class SharedRuntime;
734  private:
735   static BufferBlob* _buffer; // the temporary code buffer in CodeCache
736   static AdapterHandlerEntry* _abstract_method_handler;
737   static AdapterHandlerEntry* _no_arg_handler;
738   static AdapterHandlerEntry* _int_arg_handler;
739   static AdapterHandlerEntry* _obj_arg_handler;
740   static AdapterHandlerEntry* _obj_int_arg_handler;
741   static AdapterHandlerEntry* _obj_obj_arg_handler;
742 
743   static BufferBlob* buffer_blob();
744   static void initialize();
745   static AdapterHandlerEntry* create_adapter(AdapterBlob*& new_adapter,
746                                              int total_args_passed,
747                                              BasicType* sig_bt,
748                                              bool allocate_code_blob);
749   static AdapterHandlerEntry* get_simple_adapter(const methodHandle& method);
750  public:
751 
752   static AdapterHandlerEntry* new_entry(AdapterFingerPrint* fingerprint,
753                                         address i2c_entry,
754                                         address c2i_entry,
755                                         address c2i_unverified_entry,
756                                         address c2i_no_clinit_check_entry = nullptr);
757   static void create_native_wrapper(const methodHandle& method);
758   static AdapterHandlerEntry* get_adapter(const methodHandle& method);
759 
760   static void print_handler(const CodeBlob* b) { print_handler_on(tty, b); }
761   static void print_handler_on(outputStream* st, const CodeBlob* b);
762   static bool contains(const CodeBlob* b);
763 #ifndef PRODUCT
764   static void print_statistics();
765 #endif // PRODUCT
766 
767 };
768 
769 #endif // SHARE_RUNTIME_SHAREDRUNTIME_HPP