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