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