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