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