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