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/stubInfo.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 class SharedRuntime: AllStatic {
52 private:
53 // Declare shared stub fields
54 #define SHARED_STUB_FIELD_DECLARE(name, type) \
55 static type* BLOB_FIELD_NAME(name);
56 SHARED_STUBS_DO(SHARED_STUB_FIELD_DECLARE)
57 #undef SHARED_STUB_FIELD_DECLARE
58
59 #ifdef ASSERT
60 static bool is_resolve_id(StubId id) {
61 return (id == StubId::shared_wrong_method_id ||
62 id == StubId::shared_wrong_method_abstract_id ||
63 id == StubId::shared_ic_miss_id ||
64 id == StubId::shared_resolve_opt_virtual_call_id ||
65 id == StubId::shared_resolve_virtual_call_id ||
66 id == StubId::shared_resolve_static_call_id);
67 }
68 static bool is_polling_page_id(StubId id) {
69 return (id == StubId::shared_polling_page_vectors_safepoint_handler_id ||
70 id == StubId::shared_polling_page_safepoint_handler_id ||
71 id == StubId::shared_polling_page_return_handler_id);
72 }
73 static bool is_throw_id(StubId id) {
74 return (id == StubId::shared_throw_AbstractMethodError_id ||
75 id == StubId::shared_throw_IncompatibleClassChangeError_id ||
76 id == StubId::shared_throw_NullPointerException_at_call_id ||
77 id == StubId::shared_throw_StackOverflowError_id ||
78 id == StubId::shared_throw_delayed_StackOverflowError_id);
79 }
80 #endif
81
82 // cont_doYieldStub is not yet folded into the general model for
83 // shared stub/blob handling. It is actually a specially generated
84 // native wrapper for a specific native method, as also is it's
85 // counterpart the continuation do_enter method.
86 static nmethod* _cont_doYield_stub;
87
88 #ifndef PRODUCT
89 // Counters
90 static int64_t _nof_megamorphic_calls; // total # of megamorphic calls (through vtable)
91 #endif // !PRODUCT
92
93 private:
94 static SafepointBlob* generate_handler_blob(StubId id, address call_ptr);
95 static RuntimeStub* generate_resolve_blob(StubId id, address destination);
96 static RuntimeStub* generate_throw_exception(StubId id, address runtime_entry);
97 public:
98 static void generate_initial_stubs(void);
99 static void generate_stubs(void);
100 #if INCLUDE_JFR
101 static void generate_jfr_stubs(void);
102 // For c2: c_rarg0 is junk, call to runtime to write a checkpoint.
103 // It returns a jobject handle to the event writer.
104 // The handle is dereferenced and the return value is the event writer oop.
105 static RuntimeStub* generate_jfr_write_checkpoint();
106 // For c2: call to runtime to return a buffer lease.
107 static RuntimeStub* generate_jfr_return_lease();
108 #endif
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
313 // Counters
314 #ifndef PRODUCT
315 static address nof_megamorphic_calls_addr() { return (address)&_nof_megamorphic_calls; }
316 #endif // PRODUCT
317
318 // Helper routine for full-speed JVMTI exception throwing support
319 static void throw_and_post_jvmti_exception(JavaThread* current, Handle h_exception);
320 static void throw_and_post_jvmti_exception(JavaThread* current, Symbol* name, const char *message = nullptr);
321
322 #if INCLUDE_JVMTI
323 // Functions for JVMTI notifications
324 static void notify_jvmti_vthread_start(oopDesc* vt, jboolean hide, JavaThread* current);
325 static void notify_jvmti_vthread_end(oopDesc* vt, jboolean hide, JavaThread* current);
326 static void notify_jvmti_vthread_mount(oopDesc* vt, jboolean hide, JavaThread* current);
327 static void notify_jvmti_vthread_unmount(oopDesc* vt, jboolean hide, JavaThread* current);
328 #endif
329
330 // RedefineClasses() tracing support for obsolete method entry
331 static int rc_trace_method_entry(JavaThread* thread, Method* m);
332
333 // To be used as the entry point for unresolved native methods.
334 static address native_method_throw_unsatisfied_link_error_entry();
335
336 static void register_finalizer(JavaThread* thread, oopDesc* obj);
337
338 // dtrace notifications
339 static int dtrace_object_alloc(oopDesc* o);
340 static int dtrace_object_alloc(JavaThread* thread, oopDesc* o);
341 static int dtrace_object_alloc(JavaThread* thread, oopDesc* o, size_t size);
342 static int dtrace_method_entry(JavaThread* thread, Method* m);
343 static int dtrace_method_exit(JavaThread* thread, Method* m);
344
345 // Utility method for retrieving the Java thread id, returns 0 if the
346 // thread is not a well formed Java thread.
347 static jlong get_java_tid(JavaThread* thread);
348
349
350 // used by native wrappers to re-enable yellow if overflow happened in native code
351 static void reguard_yellow_pages();
352
353 // Fill in the "X cannot be cast to a Y" message for ClassCastException
354 //
355 // @param thr the current thread
356 // @param caster_klass the class of the object we are casting
357 // @return the dynamically allocated exception message (must be freed
358 // by the caller using a resource mark)
359 //
360 // BCP must refer to the current 'checkcast' opcode for the frame
361 // on top of the stack.
362 // The caller (or one of its callers) must use a ResourceMark
363 // in order to correctly free the result.
364 //
365 static char* generate_class_cast_message(JavaThread* thr, Klass* caster_klass);
366
367 // Fill in the "X cannot be cast to a Y" message for ClassCastException
368 //
369 // @param caster_klass the class of the object we are casting
370 // @param target_klass the target klass attempt
371 // @return the dynamically allocated exception message (must be freed
372 // by the caller using a resource mark)
373 //
374 // This version does not require access the frame, so it can be called
375 // from interpreted code
376 // The caller (or one of it's callers) must use a ResourceMark
377 // in order to correctly free the result.
378 //
379 static char* generate_class_cast_message(Klass* caster_klass, Klass* target_klass, Symbol* target_klass_name = nullptr);
380
381 static char* generate_identity_exception_message(JavaThread* thr, Klass* klass);
382
383 // Resolves a call site- may patch in the destination of the call into the
384 // compiled code.
385 static methodHandle resolve_helper(bool is_virtual, bool is_optimized, bool& caller_is_c1, TRAPS);
386
387 private:
388 // deopt blob
389 static void generate_deopt_blob(void);
390
391 static bool handle_ic_miss_helper_internal(Handle receiver, nmethod* caller_nm, const frame& caller_frame,
392 methodHandle callee_method, Bytecodes::Code bc, CallInfo& call_info,
393 bool& needs_ic_stub_refill, bool& is_optimized, bool caller_is_c1, TRAPS);
394
395 public:
396 static DeoptimizationBlob* deopt_blob(void) { return _deopt_blob; }
397
398 // Resets a call-site in compiled code so it will get resolved again.
399 static methodHandle reresolve_call_site(bool& is_static_call, bool& is_optimized, bool& caller_is_c1, TRAPS);
400
401 // In the code prolog, if the klass comparison fails, the inline cache
402 // misses and the call site is patched to megamorphic
403 static methodHandle handle_ic_miss_helper(bool& caller_is_c1, TRAPS);
404
405 // Find the method that called us.
406 static methodHandle find_callee_method(bool& caller_is_c1, TRAPS);
407
408 static void monitor_enter_helper(oopDesc* obj, BasicLock* lock, JavaThread* thread);
409
410 static void monitor_exit_helper(oopDesc* obj, BasicLock* lock, JavaThread* current);
411
412 // Issue UL warning for unlocked JNI monitor on virtual thread termination
413 static void log_jni_monitor_still_held();
414
415 private:
416 static Handle find_callee_info(Bytecodes::Code& bc, CallInfo& callinfo, TRAPS);
417 static Handle find_callee_info_helper(vframeStream& vfst, Bytecodes::Code& bc, CallInfo& callinfo, TRAPS);
418
419 static Method* extract_attached_method(vframeStream& vfst);
420
421 #if defined(X86) && defined(COMPILER1)
422 // For Object.hashCode, System.identityHashCode try to pull hashCode from object header if available.
423 static void inline_check_hashcode_from_object_header(MacroAssembler* masm, const methodHandle& method, Register obj_reg, Register result);
424 #endif // X86 && COMPILER1
425
426 public:
427
428 // Read the array of BasicTypes from a Java signature, and compute where
429 // compiled Java code would like to put the results. Values in reg_lo and
430 // reg_hi refer to 4-byte quantities. Values less than SharedInfo::stack0 are
431 // registers, those above refer to 4-byte stack slots. All stack slots are
432 // based off of the window top. SharedInfo::stack0 refers to the first usable
433 // slot in the bottom of the frame. SharedInfo::stack0+1 refers to the memory word
434 // 4-bytes higher.
435 // return value is the maximum number of VMReg stack slots the convention will use.
436 static int java_calling_convention(const BasicType* sig_bt, VMRegPair* regs, int total_args_passed);
437 static int java_calling_convention(const GrowableArray<SigEntry>* sig, VMRegPair* regs) {
438 BasicType* sig_bt = NEW_RESOURCE_ARRAY(BasicType, sig->length());
439 int total_args_passed = SigEntry::fill_sig_bt(sig, sig_bt);
440 return java_calling_convention(sig_bt, regs, total_args_passed);
441 }
442 static int java_return_convention(const BasicType* sig_bt, VMRegPair* regs, int total_args_passed);
443 static const uint java_return_convention_max_int;
444 static const uint java_return_convention_max_float;
445
446 static void check_member_name_argument_is_last_argument(const methodHandle& method,
447 const BasicType* sig_bt,
448 const VMRegPair* regs) NOT_DEBUG_RETURN;
449
450 // Ditto except for calling C
451 //
452 // C argument in register AND stack slot.
453 // Some architectures require that an argument must be passed in a register
454 // AND in a stack slot. These architectures provide a second VMRegPair array
455 // to be filled by the c_calling_convention method. On other architectures,
456 // null is being passed as the second VMRegPair array, so arguments are either
457 // passed in a register OR in a stack slot.
458 static int c_calling_convention(const BasicType *sig_bt, VMRegPair *regs, int total_args_passed);
459
460 static int vector_calling_convention(VMRegPair *regs,
461 uint num_bits,
462 uint total_args_passed);
463
464 // Generate I2C and C2I adapters. These adapters are simple argument marshalling
465 // blobs. Unlike adapters in the tiger and earlier releases the code in these
466 // blobs does not create a new frame and are therefore virtually invisible
467 // to the stack walking code. In general these blobs extend the callers stack
468 // as needed for the conversion of argument locations.
469
470 // When calling a c2i blob the code will always call the interpreter even if
471 // by the time we reach the blob there is compiled code available. This allows
472 // the blob to pass the incoming stack pointer (the sender sp) in a known
473 // location for the interpreter to record. This is used by the frame code
474 // to correct the sender code to match up with the stack pointer when the
475 // thread left the compiled code. In addition it allows the interpreter
476 // to remove the space the c2i adapter allocated to do its argument conversion.
477
478 // Although a c2i blob will always run interpreted even if compiled code is
479 // present if we see that compiled code is present the compiled call site
480 // will be patched/re-resolved so that later calls will run compiled.
481
482 // Additionally a c2i blob need to have a unverified entry because it can be reached
483 // in situations where the call site is an inlined cache site and may go megamorphic.
484
485 // A i2c adapter is simpler than the c2i adapter. This is because it is assumed
486 // that the interpreter before it does any call dispatch will record the current
487 // stack pointer in the interpreter frame. On return it will restore the stack
488 // pointer as needed. This means the i2c adapter code doesn't need any special
489 // handshaking path with compiled code to keep the stack walking correct.
490
491 static void generate_i2c2i_adapters(MacroAssembler* _masm,
492 int total_args_passed,
493 const GrowableArray<SigEntry>* sig,
494 const VMRegPair* regs,
495 const GrowableArray<SigEntry>* sig_cc,
496 const VMRegPair* regs_cc,
497 const GrowableArray<SigEntry>* sig_cc_ro,
498 const VMRegPair* regs_cc_ro,
499 AdapterHandlerEntry* handler,
500 AdapterBlob*& new_adapter,
501 bool allocate_code_blob);
502
503 static void gen_i2c_adapter(MacroAssembler *_masm,
504 int comp_args_on_stack,
505 const GrowableArray<SigEntry>* sig,
506 const VMRegPair *regs);
507
508 // OSR support
509
510 // OSR_migration_begin will extract the jvm state from an interpreter
511 // frame (locals, monitors) and store the data in a piece of C heap
512 // storage. This then allows the interpreter frame to be removed from the
513 // stack and the OSR nmethod to be called. That method is called with a
514 // pointer to the C heap storage. This pointer is the return value from
515 // OSR_migration_begin.
516
517 static intptr_t* OSR_migration_begin(JavaThread *thread);
518
519 // OSR_migration_end is a trivial routine. It is called after the compiled
520 // method has extracted the jvm state from the C heap that OSR_migration_begin
521 // created. It's entire job is to simply free this storage.
522 static void OSR_migration_end(intptr_t* buf);
523
524 // Convert a sig into a calling convention register layout
525 // and find interesting things about it.
526 static VMRegPair* find_callee_arguments(Symbol* sig, bool has_receiver, bool has_appendix, int *arg_size);
527 static VMReg name_for_receiver();
528
529 // "Top of Stack" slots that may be unused by the calling convention but must
530 // otherwise be preserved.
531 // On Intel these are not necessary and the value can be zero.
532 // On Sparc this describes the words reserved for storing a register window
533 // when an interrupt occurs.
534 static uint out_preserve_stack_slots();
535
536 // Stack slots that may be unused by the calling convention but must
537 // otherwise be preserved. On Intel this includes the return address.
538 // On PowerPC it includes the 4 words holding the old TOC & LR glue.
539 static uint in_preserve_stack_slots();
540
541 static VMReg thread_register();
542
543 static void continuation_enter_cleanup(MacroAssembler* masm);
544
545 // Is vector's size (in bytes) bigger than a size saved by default?
546 // For example, on x86 16 bytes XMM registers are saved by default.
547 static bool is_wide_vector(int size);
548
549 // Save and restore a native result
550 static void save_native_result(MacroAssembler *_masm, BasicType ret_type, int frame_slots);
551 static void restore_native_result(MacroAssembler *_masm, BasicType ret_type, int frame_slots);
552
553 // Generate a native wrapper for a given method. The method takes arguments
554 // in the Java compiled code convention, marshals them to the native
555 // convention (handlizes oops, etc), transitions to native, makes the call,
556 // returns to java state (possibly blocking), unhandlizes any result and
557 // returns.
558 //
559 // The wrapper may contain special-case code if the given method
560 // is a compiled method handle adapter, such as _invokeBasic, _linkToVirtual, etc.
561 static nmethod* generate_native_wrapper(MacroAssembler* masm,
562 const methodHandle& method,
563 int compile_id,
564 BasicType* sig_bt,
565 VMRegPair* regs,
566 BasicType ret_type);
567
568 // A compiled caller has just called the interpreter, but compiled code
569 // exists. Patch the caller so he no longer calls into the interpreter.
570 static void fixup_callers_callsite(Method* moop, address ret_pc);
571 static bool should_fixup_call_destination(address destination, address entry_point, address caller_pc, Method* moop, CodeBlob* cb);
572
573 // Slow-path Locking and Unlocking
574 static void complete_monitor_locking_C(oopDesc* obj, BasicLock* lock, JavaThread* current);
575 static void complete_monitor_unlocking_C(oopDesc* obj, BasicLock* lock, JavaThread* current);
576
577 // Resolving of calls
578 static address get_resolved_entry (JavaThread* current, methodHandle callee_method,
579 bool is_static_call, bool is_optimized, bool caller_is_c1);
580 static address resolve_static_call_C (JavaThread* current);
581 static address resolve_virtual_call_C (JavaThread* current);
582 static address resolve_opt_virtual_call_C(JavaThread* current);
583
584 static void load_inline_type_fields_in_regs(JavaThread* current, oopDesc* res);
585 static void store_inline_type_fields_to_buf(JavaThread* current, intptr_t res);
586
587 // arraycopy, the non-leaf version. (See StubRoutines for all the leaf calls.)
588 static void slow_arraycopy_C(oopDesc* src, jint src_pos,
589 oopDesc* dest, jint dest_pos,
590 jint length, JavaThread* thread);
591
592 // handle ic miss with caller being compiled code
593 // wrong method handling (inline cache misses)
594 static address handle_wrong_method(JavaThread* current);
595 static address handle_wrong_method_abstract(JavaThread* current);
596 static address handle_wrong_method_ic_miss(JavaThread* current);
597 static void allocate_inline_types(JavaThread* current, Method* callee, bool allocate_receiver);
598 static oop allocate_inline_types_impl(JavaThread* current, methodHandle callee, bool allocate_receiver, TRAPS);
599
600 static address handle_unsafe_access(JavaThread* thread, address next_pc);
601
602 static BufferedInlineTypeBlob* generate_buffered_inline_type_adapter(const InlineKlass* vk);
603 #ifndef PRODUCT
604
605 // Collect and print inline cache miss statistics
606 private:
607 enum { maxICmiss_count = 100 };
608 static int _ICmiss_index; // length of IC miss histogram
609 static int _ICmiss_count[maxICmiss_count]; // miss counts
610 static address _ICmiss_at[maxICmiss_count]; // miss addresses
611 static void trace_ic_miss(address at);
612
613 public:
614 static uint _ic_miss_ctr; // total # of IC misses
615 static uint _wrong_method_ctr;
616 static uint _resolve_static_ctr;
617 static uint _resolve_virtual_ctr;
618 static uint _resolve_opt_virtual_ctr;
619 static uint _implicit_null_throws;
620 static uint _implicit_div0_throws;
621
622 static uint _jbyte_array_copy_ctr; // Slow-path byte array copy
623 static uint _jshort_array_copy_ctr; // Slow-path short array copy
624 static uint _jint_array_copy_ctr; // Slow-path int array copy
625 static uint _jlong_array_copy_ctr; // Slow-path long array copy
626 static uint _oop_array_copy_ctr; // Slow-path oop array copy
627 static uint _checkcast_array_copy_ctr; // Slow-path oop array copy, with cast
628 static uint _unsafe_array_copy_ctr; // Slow-path includes alignment checks
629 static uint _generic_array_copy_ctr; // Slow-path includes type decoding
630 static uint _slow_array_copy_ctr; // Slow-path failed out to a method call
631
632 static uint _unsafe_set_memory_ctr; // Slow-path includes alignment checks
633
634 static uint _new_instance_ctr; // 'new' object requires GC
635 static uint _new_array_ctr; // 'new' array requires GC
636 static uint _multi2_ctr, _multi3_ctr, _multi4_ctr, _multi5_ctr;
637 static uint _find_handler_ctr; // find exception handler
638 static uint _rethrow_ctr; // rethrow exception
639 static uint _mon_enter_stub_ctr; // monitor enter stub
640 static uint _mon_exit_stub_ctr; // monitor exit stub
641 static uint _mon_enter_ctr; // monitor enter slow
642 static uint _mon_exit_ctr; // monitor exit slow
643 static uint _partial_subtype_ctr; // SubRoutines::partial_subtype_check
644
645 // Statistics code
646 // stats for "normal" compiled calls (non-interface)
647 static int64_t _nof_normal_calls; // total # of calls
648 static int64_t _nof_inlined_calls; // total # of inlined normal calls
649 static int64_t _nof_static_calls; // total # of calls to static methods or super methods (invokespecial)
650 static int64_t _nof_inlined_static_calls; // total # of inlined static calls
651 // stats for compiled interface calls
652 static int64_t _nof_interface_calls; // total # of compiled calls
653 static int64_t _nof_inlined_interface_calls; // total # of inlined interface calls
654
655 public: // for compiler
656 static address nof_normal_calls_addr() { return (address)&_nof_normal_calls; }
657 static address nof_inlined_calls_addr() { return (address)&_nof_inlined_calls; }
658 static address nof_static_calls_addr() { return (address)&_nof_static_calls; }
659 static address nof_inlined_static_calls_addr() { return (address)&_nof_inlined_static_calls; }
660 static address nof_interface_calls_addr() { return (address)&_nof_interface_calls; }
661 static address nof_inlined_interface_calls_addr() { return (address)&_nof_inlined_interface_calls; }
662 static void print_call_statistics(uint64_t comp_total);
663 static void print_ic_miss_histogram();
664
665 #endif // PRODUCT
666
667 static void print_statistics() PRODUCT_RETURN;
668 };
669
670
671 // ---------------------------------------------------------------------------
672 // Implementation of AdapterHandlerLibrary
673 //
674 // This library manages argument marshaling adapters and native wrappers.
675 // There are 2 flavors of adapters: I2C and C2I.
676 //
677 // The I2C flavor takes a stock interpreted call setup, marshals the
678 // arguments for a Java-compiled call, and jumps to Rmethod-> code()->
679 // code_begin(). It is broken to call it without an nmethod assigned.
680 // The usual behavior is to lift any register arguments up out of the
681 // stack and possibly re-pack the extra arguments to be contiguous.
682 // I2C adapters will save what the interpreter's stack pointer will be
683 // after arguments are popped, then adjust the interpreter's frame
684 // size to force alignment and possibly to repack the arguments.
685 // After re-packing, it jumps to the compiled code start. There are
686 // no safepoints in this adapter code and a GC cannot happen while
687 // marshaling is in progress.
688 //
689 // The C2I flavor takes a stock compiled call setup plus the target method in
690 // Rmethod, marshals the arguments for an interpreted call and jumps to
691 // Rmethod->_i2i_entry. On entry, the interpreted frame has not yet been
692 // setup. Compiled frames are fixed-size and the args are likely not in the
693 // right place. Hence all the args will likely be copied into the
694 // interpreter's frame, forcing that frame to grow. The compiled frame's
695 // outgoing stack args will be dead after the copy.
696 //
697 // Native wrappers, like adapters, marshal arguments. Unlike adapters they
698 // also perform an official frame push & pop. They have a call to the native
699 // routine in their middles and end in a return (instead of ending in a jump).
700 // The native wrappers are stored in real nmethods instead of the BufferBlobs
701 // used by the adapters. The code generation happens here because it's very
702 // similar to what the adapters have to do.
703
704 class AdapterHandlerEntry : public MetaspaceObj {
705 friend class AdapterHandlerLibrary;
706
707 public:
708 static const int ENTRIES_COUNT = 7;
709
710 private:
711 AdapterFingerPrint* _fingerprint;
712 address _i2c_entry;
713 address _c2i_entry;
714 address _c2i_inline_entry;
715 address _c2i_inline_ro_entry;
716 address _c2i_unverified_entry;
717 address _c2i_unverified_inline_entry;
718 address _c2i_no_clinit_check_entry;
719 bool _linked;
720
721 static const char *_entry_names[];
722
723 // Support for scalarized inline type calling convention
724 const GrowableArray<SigEntry>* _sig_cc;
725
726 #ifdef ASSERT
727 // Captures code and signature used to generate this adapter when
728 // verifying adapter equivalence.
729 unsigned char* _saved_code;
730 int _saved_code_length;
731 #endif
732
733 AdapterHandlerEntry(AdapterFingerPrint* fingerprint) :
734 _fingerprint(fingerprint),
735 _i2c_entry(nullptr),
736 _c2i_entry(nullptr),
737 _c2i_inline_entry(nullptr),
738 _c2i_inline_ro_entry(nullptr),
739 _c2i_unverified_entry(nullptr),
740 _c2i_unverified_inline_entry(nullptr),
741 _c2i_no_clinit_check_entry(nullptr),
742 _linked(false),
743 _sig_cc(nullptr)
744 #ifdef ASSERT
745 , _saved_code(nullptr),
746 _saved_code_length(0)
747 #endif
748 { }
749
750 ~AdapterHandlerEntry();
751
752 // Allocate on CHeap instead of metaspace (see JDK-8331086).
753 // Dummy argument is used to avoid C++ warning about using
754 // deleted opearator MetaspaceObj::delete().
755 void* operator new(size_t size, size_t dummy) throw() {
756 assert(size == BytesPerWord * heap_word_size(sizeof(AdapterHandlerEntry)), "should match");
757 void* p = AllocateHeap(size, mtCode);
758 memset(p, 0, size);
759 return p;
760 }
761
762 public:
763 static AdapterHandlerEntry* allocate(AdapterFingerPrint* fingerprint) {
764 return new(0) AdapterHandlerEntry(fingerprint);
765 }
766
767 static void deallocate(AdapterHandlerEntry *handler) {
768 handler->~AdapterHandlerEntry();
769 }
770
771 void set_entry_points(address i2c_entry, address c2i_entry, address c2i_inline_entry, address c2i_inline_ro_entry,
772 address c2i_unverified_entry, address c2i_unverified_inline_entry,
773 address c2i_no_clinit_check_entry = nullptr,
774 bool linked = true) {
775 _i2c_entry = i2c_entry;
776 _c2i_entry = c2i_entry;
777 _c2i_inline_entry = c2i_inline_entry;
778 _c2i_inline_ro_entry = c2i_inline_ro_entry;
779 _c2i_unverified_entry = c2i_unverified_entry;
780 _c2i_unverified_inline_entry = c2i_unverified_inline_entry;
781 _c2i_no_clinit_check_entry = c2i_no_clinit_check_entry;
782 _linked = linked;
783 }
784
785 address get_i2c_entry() const { return _i2c_entry; }
786 address get_c2i_entry() const { return _c2i_entry; }
787 address get_c2i_inline_entry() const { return _c2i_inline_entry; }
788 address get_c2i_inline_ro_entry() const { return _c2i_inline_ro_entry; }
789 address get_c2i_unverified_entry() const { return _c2i_unverified_entry; }
790 address get_c2i_unverified_inline_entry() const { return _c2i_unverified_inline_entry; }
791 address get_c2i_no_clinit_check_entry() const { return _c2i_no_clinit_check_entry; }
792
793 static const char* entry_name(int i) {
794 assert(i >=0 && i < ENTRIES_COUNT, "entry id out of range");
795 return _entry_names[i];
796 }
797
798 bool is_linked() const { return _linked; }
799 address base_address();
800 void relocate(address new_base);
801
802 // Support for scalarized inline type calling convention
803 void set_sig_cc(const GrowableArray<SigEntry>* sig) { _sig_cc = sig; }
804 const GrowableArray<SigEntry>* get_sig_cc() const { return _sig_cc; }
805
806 AdapterFingerPrint* fingerprint() const { return _fingerprint; }
807
808 #ifdef ASSERT
809 // Used to verify that code generated for shared adapters is equivalent
810 void save_code (unsigned char* code, int length);
811 bool compare_code(AdapterHandlerEntry* other);
812 #endif
813
814 //virtual void print_on(outputStream* st) const; DO NOT USE
815 void print_adapter_on(outputStream* st) const;
816
817 void metaspace_pointers_do(MetaspaceClosure* it);
818 int size() const {return (int)heap_word_size(sizeof(AdapterHandlerEntry)); }
819 MetaspaceObj::Type type() const { return AdapterHandlerEntryType; }
820
821 void remove_unshareable_info() NOT_CDS_RETURN;
822 void link() NOT_CDS_RETURN;
823 };
824
825 #if INCLUDE_CDS
826 class ArchivedAdapterTable;
827 #endif // INCLUDE_CDS
828
829 class CompiledEntrySignature;
830
831 class AdapterHandlerLibrary: public AllStatic {
832 friend class SharedRuntime;
833 private:
834 static BufferBlob* _buffer; // the temporary code buffer in CodeCache
835 static AdapterHandlerEntry* _no_arg_handler;
836 static AdapterHandlerEntry* _int_arg_handler;
837 static AdapterHandlerEntry* _obj_arg_handler;
838 static AdapterHandlerEntry* _obj_int_arg_handler;
839 static AdapterHandlerEntry* _obj_obj_arg_handler;
840 #if INCLUDE_CDS
841 static ArchivedAdapterTable _aot_adapter_handler_table;
842 #endif // INCLUDE_CDS
843
844 static BufferBlob* buffer_blob();
845 static void initialize();
846 static AdapterHandlerEntry* get_simple_adapter(const methodHandle& method);
847 static AdapterBlob* lookup_aot_cache(AdapterHandlerEntry* handler);
848 static AdapterHandlerEntry* create_adapter(AdapterBlob*& new_adapter,
849 CompiledEntrySignature& ces,
850 bool allocate_code_blob,
851 bool is_transient = false);
852 static void lookup_simple_adapters() NOT_CDS_RETURN;
853 #ifndef PRODUCT
854 static void print_adapter_handler_info(outputStream* st, AdapterHandlerEntry* handler, AdapterBlob* adapter_blob);
855 #endif // PRODUCT
856 public:
857
858 static AdapterHandlerEntry* new_entry(AdapterFingerPrint* fingerprint);
859 static void create_native_wrapper(const methodHandle& method);
860 static AdapterHandlerEntry* get_adapter(const methodHandle& method);
861 static AdapterHandlerEntry* lookup(const GrowableArray<SigEntry>* sig, bool has_ro_adapter = false);
862 static bool generate_adapter_code(AdapterBlob*& adapter_blob,
863 AdapterHandlerEntry* handler,
864 CompiledEntrySignature& ces,
865 bool allocate_code_blob,
866 bool is_transient);
867
868 #ifdef ASSERT
869 static void verify_adapter_sharing(CompiledEntrySignature& ces, AdapterHandlerEntry* cached_entry);
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(AdapterFingerPrint* fingerprint);
876 static uint32_t id(AdapterFingerPrint* fingerprint);
877 #ifndef PRODUCT
878 static void print_statistics();
879 #endif // PRODUCT
880
881 static AdapterBlob* link_aot_adapter_handler(AdapterHandlerEntry* handler) NOT_CDS_RETURN_(nullptr);
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 };
886
887 // Utility class for computing the calling convention of the 3 types
888 // of compiled method entries:
889 // Method::_from_compiled_entry - sig_cc
890 // Method::_from_compiled_inline_ro_entry - sig_cc_ro
891 // Method::_from_compiled_inline_entry - sig
892 class CompiledEntrySignature : public StackObj {
893 Method* _method;
894 int _num_inline_args;
895 bool _has_inline_recv;
896 GrowableArray<SigEntry>* _sig;
897 GrowableArray<SigEntry>* _sig_cc;
898 GrowableArray<SigEntry>* _sig_cc_ro;
899 VMRegPair* _regs;
900 VMRegPair* _regs_cc;
901 VMRegPair* _regs_cc_ro;
902
903 int _args_on_stack;
904 int _args_on_stack_cc;
905 int _args_on_stack_cc_ro;
906
907 bool _c1_needs_stack_repair;
908 bool _c2_needs_stack_repair;
909
910 GrowableArray<Method*>* _supers;
911
912 public:
913 Method* method() const { return _method; }
914
915 // Used by Method::_from_compiled_inline_entry
916 GrowableArray<SigEntry>* sig() const { return _sig; }
917
918 // Used by Method::_from_compiled_entry
919 GrowableArray<SigEntry>* sig_cc() const { return _sig_cc; }
920
921 // Used by Method::_from_compiled_inline_ro_entry
922 GrowableArray<SigEntry>* sig_cc_ro() const { return _sig_cc_ro; }
923
924 VMRegPair* regs() const { return _regs; }
925 VMRegPair* regs_cc() const { return _regs_cc; }
926 VMRegPair* regs_cc_ro() const { return _regs_cc_ro; }
927
928 int args_on_stack() const { return _args_on_stack; }
929 int args_on_stack_cc() const { return _args_on_stack_cc; }
930 int args_on_stack_cc_ro() const { return _args_on_stack_cc_ro; }
931
932 int num_inline_args() const { return _num_inline_args; }
933 bool has_inline_recv() const { return _has_inline_recv; }
934
935 bool has_scalarized_args() const { return _sig != _sig_cc; }
936 bool c1_needs_stack_repair() const { return _c1_needs_stack_repair; }
937 bool c2_needs_stack_repair() const { return _c2_needs_stack_repair; }
938 CodeOffsets::Entries c1_inline_ro_entry_type() const;
939
940 GrowableArray<Method*>* get_supers();
941
942 CompiledEntrySignature(Method* method = nullptr);
943 void compute_calling_conventions(bool init = true);
944 void initialize_from_fingerprint(AdapterFingerPrint* fingerprint);
945 };
946
947 #endif // SHARE_RUNTIME_SHAREDRUNTIME_HPP