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