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