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