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 "asm/codeBuffer.hpp"
29 #include "code/codeBlob.hpp"
30 #include "code/vmreg.hpp"
31 #include "interpreter/linkResolver.hpp"
32 #include "memory/allStatic.hpp"
33 #include "memory/resourceArea.hpp"
34 #include "runtime/signature.hpp"
35 #include "runtime/stubDeclarations.hpp"
36 #include "utilities/macros.hpp"
37
38 class AdapterHandlerEntry;
39 class AdapterFingerPrint;
40 class vframeStream;
41 class SigEntry;
42
43 // Runtime is the base class for various runtime interfaces
44 // (InterpreterRuntime, CompilerRuntime, etc.). It provides
45 // shared functionality such as exception forwarding (C++ to
46 // Java exceptions), locking/unlocking mechanisms, statistical
47 // information, etc.
48
49 // define SharedStubId enum tags: wrong_method_id, etc
50
51 #define SHARED_STUB_ID_ENUM_DECLARE(name, type) STUB_ID_NAME(name),
52 enum class SharedStubId :int {
53 NO_STUBID = -1,
54 SHARED_STUBS_DO(SHARED_STUB_ID_ENUM_DECLARE)
55 NUM_STUBIDS
56 };
57 #undef SHARED_STUB_ID_ENUM_DECLARE
58
59 class SharedRuntime: AllStatic {
60 friend class VMStructs;
61
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
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 static char* generate_identity_exception_message(JavaThread* thr, Klass* klass);
373
374 // Resolves a call site- may patch in the destination of the call into the
375 // compiled code.
376 static methodHandle resolve_helper(bool is_virtual, bool is_optimized, bool& caller_is_c1, TRAPS);
377
378 private:
379 // deopt blob
380 static void generate_deopt_blob(void);
381
382 static bool handle_ic_miss_helper_internal(Handle receiver, nmethod* caller_nm, const frame& caller_frame,
383 methodHandle callee_method, Bytecodes::Code bc, CallInfo& call_info,
384 bool& needs_ic_stub_refill, bool& is_optimized, bool caller_is_c1, TRAPS);
385
386 public:
387 static DeoptimizationBlob* deopt_blob(void) { return _deopt_blob; }
388
389 // Resets a call-site in compiled code so it will get resolved again.
390 static methodHandle reresolve_call_site(bool& is_static_call, bool& is_optimized, bool& caller_is_c1, TRAPS);
391
392 // In the code prolog, if the klass comparison fails, the inline cache
393 // misses and the call site is patched to megamorphic
394 static methodHandle handle_ic_miss_helper(bool& is_optimized, bool& caller_is_c1, TRAPS);
395
396 // Find the method that called us.
397 static methodHandle find_callee_method(bool is_optimized, bool& caller_is_c1, TRAPS);
398
399 static void monitor_enter_helper(oopDesc* obj, BasicLock* lock, JavaThread* thread);
400
401 static void monitor_exit_helper(oopDesc* obj, BasicLock* lock, JavaThread* current);
402
403 // Issue UL warning for unlocked JNI monitor on virtual thread termination
404 static void log_jni_monitor_still_held();
405
406 private:
407 static Handle find_callee_info(Bytecodes::Code& bc, CallInfo& callinfo, TRAPS);
408 static Handle find_callee_info_helper(vframeStream& vfst, Bytecodes::Code& bc, CallInfo& callinfo, TRAPS);
409
410 static Method* extract_attached_method(vframeStream& vfst);
411
412 #if defined(X86) && defined(COMPILER1)
413 // For Object.hashCode, System.identityHashCode try to pull hashCode from object header if available.
414 static void inline_check_hashcode_from_object_header(MacroAssembler* masm, const methodHandle& method, Register obj_reg, Register result);
415 #endif // X86 && COMPILER1
416
417 public:
418
419 // Read the array of BasicTypes from a Java signature, and compute where
420 // compiled Java code would like to put the results. Values in reg_lo and
421 // reg_hi refer to 4-byte quantities. Values less than SharedInfo::stack0 are
422 // registers, those above refer to 4-byte stack slots. All stack slots are
423 // based off of the window top. SharedInfo::stack0 refers to the first usable
424 // slot in the bottom of the frame. SharedInfo::stack0+1 refers to the memory word
425 // 4-bytes higher.
426 // return value is the maximum number of VMReg stack slots the convention will use.
427 static int java_calling_convention(const BasicType* sig_bt, VMRegPair* regs, int total_args_passed);
428 static int java_calling_convention(const GrowableArray<SigEntry>* sig, VMRegPair* regs) {
429 BasicType* sig_bt = NEW_RESOURCE_ARRAY(BasicType, sig->length());
430 int total_args_passed = SigEntry::fill_sig_bt(sig, sig_bt);
431 return java_calling_convention(sig_bt, regs, total_args_passed);
432 }
433 static int java_return_convention(const BasicType* sig_bt, VMRegPair* regs, int total_args_passed);
434 static const uint java_return_convention_max_int;
435 static const uint java_return_convention_max_float;
436
437 static void check_member_name_argument_is_last_argument(const methodHandle& method,
438 const BasicType* sig_bt,
439 const VMRegPair* regs) NOT_DEBUG_RETURN;
440
441 // Ditto except for calling C
442 //
443 // C argument in register AND stack slot.
444 // Some architectures require that an argument must be passed in a register
445 // AND in a stack slot. These architectures provide a second VMRegPair array
446 // to be filled by the c_calling_convention method. On other architectures,
447 // null is being passed as the second VMRegPair array, so arguments are either
448 // passed in a register OR in a stack slot.
449 static int c_calling_convention(const BasicType *sig_bt, VMRegPair *regs, int total_args_passed);
450
451 static int vector_calling_convention(VMRegPair *regs,
452 uint num_bits,
453 uint total_args_passed);
454
455 // Generate I2C and C2I adapters. These adapters are simple argument marshalling
456 // blobs. Unlike adapters in the tiger and earlier releases the code in these
457 // blobs does not create a new frame and are therefore virtually invisible
458 // to the stack walking code. In general these blobs extend the callers stack
459 // as needed for the conversion of argument locations.
460
461 // When calling a c2i blob the code will always call the interpreter even if
462 // by the time we reach the blob there is compiled code available. This allows
463 // the blob to pass the incoming stack pointer (the sender sp) in a known
464 // location for the interpreter to record. This is used by the frame code
465 // to correct the sender code to match up with the stack pointer when the
466 // thread left the compiled code. In addition it allows the interpreter
467 // to remove the space the c2i adapter allocated to do its argument conversion.
468
469 // Although a c2i blob will always run interpreted even if compiled code is
470 // present if we see that compiled code is present the compiled call site
471 // will be patched/re-resolved so that later calls will run compiled.
472
473 // Additionally a c2i blob need to have a unverified entry because it can be reached
474 // in situations where the call site is an inlined cache site and may go megamorphic.
475
476 // A i2c adapter is simpler than the c2i adapter. This is because it is assumed
477 // that the interpreter before it does any call dispatch will record the current
478 // stack pointer in the interpreter frame. On return it will restore the stack
479 // pointer as needed. This means the i2c adapter code doesn't need any special
480 // handshaking path with compiled code to keep the stack walking correct.
481
482 static AdapterHandlerEntry* generate_i2c2i_adapters(MacroAssembler *masm,
483 int comp_args_on_stack,
484 const GrowableArray<SigEntry>* sig,
485 const VMRegPair* regs,
486 const GrowableArray<SigEntry>* sig_cc,
487 const VMRegPair* regs_cc,
488 const GrowableArray<SigEntry>* sig_cc_ro,
489 const VMRegPair* regs_cc_ro,
490 AdapterFingerPrint* fingerprint,
491 AdapterBlob*& new_adapter,
492 bool allocate_code_blob);
493
494 static void gen_i2c_adapter(MacroAssembler *_masm,
495 int comp_args_on_stack,
496 const GrowableArray<SigEntry>* sig,
497 const VMRegPair *regs);
498
499 // OSR support
500
501 // OSR_migration_begin will extract the jvm state from an interpreter
502 // frame (locals, monitors) and store the data in a piece of C heap
503 // storage. This then allows the interpreter frame to be removed from the
504 // stack and the OSR nmethod to be called. That method is called with a
505 // pointer to the C heap storage. This pointer is the return value from
506 // OSR_migration_begin.
507
508 static intptr_t* OSR_migration_begin(JavaThread *thread);
509
510 // OSR_migration_end is a trivial routine. It is called after the compiled
511 // method has extracted the jvm state from the C heap that OSR_migration_begin
512 // created. It's entire job is to simply free this storage.
513 static void OSR_migration_end(intptr_t* buf);
514
515 // Convert a sig into a calling convention register layout
516 // and find interesting things about it.
517 static VMRegPair* find_callee_arguments(Symbol* sig, bool has_receiver, bool has_appendix, int *arg_size);
518 static VMReg name_for_receiver();
519
520 // "Top of Stack" slots that may be unused by the calling convention but must
521 // otherwise be preserved.
522 // On Intel these are not necessary and the value can be zero.
523 // On Sparc this describes the words reserved for storing a register window
524 // when an interrupt occurs.
525 static uint out_preserve_stack_slots();
526
527 // Stack slots that may be unused by the calling convention but must
528 // otherwise be preserved. On Intel this includes the return address.
529 // On PowerPC it includes the 4 words holding the old TOC & LR glue.
530 static uint in_preserve_stack_slots();
531
532 // Is vector's size (in bytes) bigger than a size saved by default?
533 // For example, on x86 16 bytes XMM registers are saved by default.
534 static bool is_wide_vector(int size);
535
536 // Save and restore a native result
537 static void save_native_result(MacroAssembler *_masm, BasicType ret_type, int frame_slots);
538 static void restore_native_result(MacroAssembler *_masm, BasicType ret_type, int frame_slots);
539
540 // Generate a native wrapper for a given method. The method takes arguments
541 // in the Java compiled code convention, marshals them to the native
542 // convention (handlizes oops, etc), transitions to native, makes the call,
543 // returns to java state (possibly blocking), unhandlizes any result and
544 // returns.
545 //
546 // The wrapper may contain special-case code if the given method
547 // is a compiled method handle adapter, such as _invokeBasic, _linkToVirtual, etc.
548 static nmethod* generate_native_wrapper(MacroAssembler* masm,
549 const methodHandle& method,
550 int compile_id,
551 BasicType* sig_bt,
552 VMRegPair* regs,
553 BasicType ret_type);
554
555 // A compiled caller has just called the interpreter, but compiled code
556 // exists. Patch the caller so he no longer calls into the interpreter.
557 static void fixup_callers_callsite(Method* moop, address ret_pc);
558 static bool should_fixup_call_destination(address destination, address entry_point, address caller_pc, Method* moop, CodeBlob* cb);
559
560 // Slow-path Locking and Unlocking
561 static void complete_monitor_locking_C(oopDesc* obj, BasicLock* lock, JavaThread* current);
562 static void complete_monitor_unlocking_C(oopDesc* obj, BasicLock* lock, JavaThread* current);
563
564 // Resolving of calls
565 static address get_resolved_entry (JavaThread* current, methodHandle callee_method,
566 bool is_static_call, bool is_optimized, bool caller_is_c1);
567 static address resolve_static_call_C (JavaThread* current);
568 static address resolve_virtual_call_C (JavaThread* current);
569 static address resolve_opt_virtual_call_C(JavaThread* current);
570
571 static void load_inline_type_fields_in_regs(JavaThread* current, oopDesc* res);
572 static void store_inline_type_fields_to_buf(JavaThread* current, intptr_t res);
573
574 // arraycopy, the non-leaf version. (See StubRoutines for all the leaf calls.)
575 static void slow_arraycopy_C(oopDesc* src, jint src_pos,
576 oopDesc* dest, jint dest_pos,
577 jint length, JavaThread* thread);
578
579 // handle ic miss with caller being compiled code
580 // wrong method handling (inline cache misses)
581 static address handle_wrong_method(JavaThread* current);
582 static address handle_wrong_method_abstract(JavaThread* current);
583 static address handle_wrong_method_ic_miss(JavaThread* current);
584 static void allocate_inline_types(JavaThread* current, Method* callee, bool allocate_receiver);
585 static oop allocate_inline_types_impl(JavaThread* current, methodHandle callee, bool allocate_receiver, TRAPS);
586
587 static address handle_unsafe_access(JavaThread* thread, address next_pc);
588
589 static BufferedInlineTypeBlob* generate_buffered_inline_type_adapter(const InlineKlass* vk);
590 #ifndef PRODUCT
591
592 // Collect and print inline cache miss statistics
593 private:
594 enum { maxICmiss_count = 100 };
595 static int _ICmiss_index; // length of IC miss histogram
596 static int _ICmiss_count[maxICmiss_count]; // miss counts
597 static address _ICmiss_at[maxICmiss_count]; // miss addresses
598 static void trace_ic_miss(address at);
599
600 public:
601 static uint _ic_miss_ctr; // total # of IC misses
602 static uint _wrong_method_ctr;
603 static uint _resolve_static_ctr;
604 static uint _resolve_virtual_ctr;
605 static uint _resolve_opt_virtual_ctr;
606 static uint _implicit_null_throws;
607 static uint _implicit_div0_throws;
608
609 static uint _jbyte_array_copy_ctr; // Slow-path byte array copy
610 static uint _jshort_array_copy_ctr; // Slow-path short array copy
611 static uint _jint_array_copy_ctr; // Slow-path int array copy
612 static uint _jlong_array_copy_ctr; // Slow-path long array copy
613 static uint _oop_array_copy_ctr; // Slow-path oop array copy
614 static uint _checkcast_array_copy_ctr; // Slow-path oop array copy, with cast
615 static uint _unsafe_array_copy_ctr; // Slow-path includes alignment checks
616 static uint _generic_array_copy_ctr; // Slow-path includes type decoding
617 static uint _slow_array_copy_ctr; // Slow-path failed out to a method call
618
619 static uint _unsafe_set_memory_ctr; // Slow-path includes alignment checks
620
621 static uint _new_instance_ctr; // 'new' object requires GC
622 static uint _new_array_ctr; // 'new' array requires GC
623 static uint _multi2_ctr, _multi3_ctr, _multi4_ctr, _multi5_ctr;
624 static uint _find_handler_ctr; // find exception handler
625 static uint _rethrow_ctr; // rethrow exception
626 static uint _mon_enter_stub_ctr; // monitor enter stub
627 static uint _mon_exit_stub_ctr; // monitor exit stub
628 static uint _mon_enter_ctr; // monitor enter slow
629 static uint _mon_exit_ctr; // monitor exit slow
630 static uint _partial_subtype_ctr; // SubRoutines::partial_subtype_check
631
632 // Statistics code
633 // stats for "normal" compiled calls (non-interface)
634 static int64_t _nof_normal_calls; // total # of calls
635 static int64_t _nof_inlined_calls; // total # of inlined normal calls
636 static int64_t _nof_static_calls; // total # of calls to static methods or super methods (invokespecial)
637 static int64_t _nof_inlined_static_calls; // total # of inlined static calls
638 // stats for compiled interface calls
639 static int64_t _nof_interface_calls; // total # of compiled calls
640 static int64_t _nof_inlined_interface_calls; // total # of inlined interface calls
641
642 public: // for compiler
643 static address nof_normal_calls_addr() { return (address)&_nof_normal_calls; }
644 static address nof_inlined_calls_addr() { return (address)&_nof_inlined_calls; }
645 static address nof_static_calls_addr() { return (address)&_nof_static_calls; }
646 static address nof_inlined_static_calls_addr() { return (address)&_nof_inlined_static_calls; }
647 static address nof_interface_calls_addr() { return (address)&_nof_interface_calls; }
648 static address nof_inlined_interface_calls_addr() { return (address)&_nof_inlined_interface_calls; }
649 static void print_call_statistics(uint64_t comp_total);
650 static void print_ic_miss_histogram();
651
652 #endif // PRODUCT
653
654 static void print_statistics() PRODUCT_RETURN;
655 };
656
657
658 // ---------------------------------------------------------------------------
659 // Implementation of AdapterHandlerLibrary
660 //
661 // This library manages argument marshaling adapters and native wrappers.
662 // There are 2 flavors of adapters: I2C and C2I.
663 //
664 // The I2C flavor takes a stock interpreted call setup, marshals the
665 // arguments for a Java-compiled call, and jumps to Rmethod-> code()->
666 // code_begin(). It is broken to call it without an nmethod assigned.
667 // The usual behavior is to lift any register arguments up out of the
668 // stack and possibly re-pack the extra arguments to be contiguous.
669 // I2C adapters will save what the interpreter's stack pointer will be
670 // after arguments are popped, then adjust the interpreter's frame
671 // size to force alignment and possibly to repack the arguments.
672 // After re-packing, it jumps to the compiled code start. There are
673 // no safepoints in this adapter code and a GC cannot happen while
674 // marshaling is in progress.
675 //
676 // The C2I flavor takes a stock compiled call setup plus the target method in
677 // Rmethod, marshals the arguments for an interpreted call and jumps to
678 // Rmethod->_i2i_entry. On entry, the interpreted frame has not yet been
679 // setup. Compiled frames are fixed-size and the args are likely not in the
680 // right place. Hence all the args will likely be copied into the
681 // interpreter's frame, forcing that frame to grow. The compiled frame's
682 // outgoing stack args will be dead after the copy.
683 //
684 // Native wrappers, like adapters, marshal arguments. Unlike adapters they
685 // also perform an official frame push & pop. They have a call to the native
686 // routine in their middles and end in a return (instead of ending in a jump).
687 // The native wrappers are stored in real nmethods instead of the BufferBlobs
688 // used by the adapters. The code generation happens here because it's very
689 // similar to what the adapters have to do.
690
691 class AdapterHandlerEntry : public CHeapObj<mtCode> {
692 friend class AdapterHandlerLibrary;
693
694 private:
695 AdapterFingerPrint* _fingerprint;
696 address _i2c_entry;
697 address _c2i_entry;
698 address _c2i_inline_entry;
699 address _c2i_inline_ro_entry;
700 address _c2i_unverified_entry;
701 address _c2i_unverified_inline_entry;
702 address _c2i_no_clinit_check_entry;
703
704 // Support for scalarized inline type calling convention
705 const GrowableArray<SigEntry>* _sig_cc;
706
707 #ifdef ASSERT
708 // Captures code and signature used to generate this adapter when
709 // verifying adapter equivalence.
710 unsigned char* _saved_code;
711 int _saved_code_length;
712 #endif
713
714 AdapterHandlerEntry(AdapterFingerPrint* fingerprint, address i2c_entry, address c2i_entry,
715 address c2i_inline_entry, address c2i_inline_ro_entry,
716 address c2i_unverified_entry, address c2i_unverified_inline_entry,
717 address c2i_no_clinit_check_entry) :
718 _fingerprint(fingerprint),
719 _i2c_entry(i2c_entry),
720 _c2i_entry(c2i_entry),
721 _c2i_inline_entry(c2i_inline_entry),
722 _c2i_inline_ro_entry(c2i_inline_ro_entry),
723 _c2i_unverified_entry(c2i_unverified_entry),
724 _c2i_unverified_inline_entry(c2i_unverified_inline_entry),
725 _c2i_no_clinit_check_entry(c2i_no_clinit_check_entry),
726 _sig_cc(nullptr)
727 #ifdef ASSERT
728 , _saved_code_length(0)
729 #endif
730 { }
731
732 ~AdapterHandlerEntry();
733
734 public:
735 address get_i2c_entry() const { return _i2c_entry; }
736 address get_c2i_entry() const { return _c2i_entry; }
737 address get_c2i_inline_entry() const { return _c2i_inline_entry; }
738 address get_c2i_inline_ro_entry() const { return _c2i_inline_ro_entry; }
739 address get_c2i_unverified_entry() const { return _c2i_unverified_entry; }
740 address get_c2i_unverified_inline_entry() const { return _c2i_unverified_inline_entry; }
741 address get_c2i_no_clinit_check_entry() const { return _c2i_no_clinit_check_entry; }
742
743 address base_address();
744 void relocate(address new_base);
745
746 // Support for scalarized inline type calling convention
747 void set_sig_cc(const GrowableArray<SigEntry>* sig) { _sig_cc = sig; }
748 const GrowableArray<SigEntry>* get_sig_cc() const { return _sig_cc; }
749
750 AdapterFingerPrint* fingerprint() const { return _fingerprint; }
751
752 #ifdef ASSERT
753 // Used to verify that code generated for shared adapters is equivalent
754 void save_code (unsigned char* code, int length);
755 bool compare_code(AdapterHandlerEntry* other);
756 #endif
757
758 //virtual void print_on(outputStream* st) const; DO NOT USE
759 void print_adapter_on(outputStream* st) const;
760 };
761
762 class CompiledEntrySignature;
763
764 class AdapterHandlerLibrary: public AllStatic {
765 friend class SharedRuntime;
766 private:
767 static BufferBlob* _buffer; // the temporary code buffer in CodeCache
768 static AdapterHandlerEntry* _abstract_method_handler;
769 static AdapterHandlerEntry* _no_arg_handler;
770 static AdapterHandlerEntry* _int_arg_handler;
771 static AdapterHandlerEntry* _obj_arg_handler;
772 static AdapterHandlerEntry* _obj_int_arg_handler;
773 static AdapterHandlerEntry* _obj_obj_arg_handler;
774
775 static BufferBlob* buffer_blob();
776 static void initialize();
777 static AdapterHandlerEntry* create_adapter(AdapterBlob*& new_adapter,
778 CompiledEntrySignature& ces,
779 bool allocate_code_blob);
780 static AdapterHandlerEntry* get_simple_adapter(const methodHandle& method);
781 public:
782
783 static AdapterHandlerEntry* new_entry(AdapterFingerPrint* fingerprint,
784 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, address c2i_no_clinit_check_entry = nullptr);
786 static void create_native_wrapper(const methodHandle& method);
787 static AdapterHandlerEntry* get_adapter(const methodHandle& method);
788
789 static void print_handler(const CodeBlob* b) { print_handler_on(tty, b); }
790 static void print_handler_on(outputStream* st, const CodeBlob* b);
791 static bool contains(const CodeBlob* b);
792 #ifndef PRODUCT
793 static void print_statistics();
794 #endif // PRODUCT
795
796 };
797
798 // Utility class for computing the calling convention of the 3 types
799 // of compiled method entries:
800 // Method::_from_compiled_entry - sig_cc
801 // Method::_from_compiled_inline_ro_entry - sig_cc_ro
802 // Method::_from_compiled_inline_entry - sig
803 class CompiledEntrySignature : public StackObj {
804 Method* _method;
805 int _num_inline_args;
806 bool _has_inline_recv;
807 GrowableArray<SigEntry>* _sig;
808 GrowableArray<SigEntry>* _sig_cc;
809 GrowableArray<SigEntry>* _sig_cc_ro;
810 VMRegPair* _regs;
811 VMRegPair* _regs_cc;
812 VMRegPair* _regs_cc_ro;
813
814 int _args_on_stack;
815 int _args_on_stack_cc;
816 int _args_on_stack_cc_ro;
817
818 bool _c1_needs_stack_repair;
819 bool _c2_needs_stack_repair;
820
821 GrowableArray<Method*>* _supers;
822
823 public:
824 Method* method() const { return _method; }
825
826 // Used by Method::_from_compiled_inline_entry
827 GrowableArray<SigEntry>* sig() const { return _sig; }
828
829 // Used by Method::_from_compiled_entry
830 GrowableArray<SigEntry>* sig_cc() const { return _sig_cc; }
831
832 // Used by Method::_from_compiled_inline_ro_entry
833 GrowableArray<SigEntry>* sig_cc_ro() const { return _sig_cc_ro; }
834
835 VMRegPair* regs() const { return _regs; }
836 VMRegPair* regs_cc() const { return _regs_cc; }
837 VMRegPair* regs_cc_ro() const { return _regs_cc_ro; }
838
839 int args_on_stack() const { return _args_on_stack; }
840 int args_on_stack_cc() const { return _args_on_stack_cc; }
841 int args_on_stack_cc_ro() const { return _args_on_stack_cc_ro; }
842
843 int num_inline_args() const { return _num_inline_args; }
844 bool has_inline_recv() const { return _has_inline_recv; }
845
846 bool has_scalarized_args() const { return _sig != _sig_cc; }
847 bool c1_needs_stack_repair() const { return _c1_needs_stack_repair; }
848 bool c2_needs_stack_repair() const { return _c2_needs_stack_repair; }
849 CodeOffsets::Entries c1_inline_ro_entry_type() const;
850
851 GrowableArray<Method*>* get_supers();
852
853 CompiledEntrySignature(Method* method = nullptr);
854 void compute_calling_conventions(bool init = true);
855 };
856
857 #endif // SHARE_RUNTIME_SHAREDRUNTIME_HPP