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