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