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