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