1 /*
2 * Copyright (c) 1997, 2010, 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_VM_RUNTIME_SHAREDRUNTIME_HPP
26 #define SHARE_VM_RUNTIME_SHAREDRUNTIME_HPP
27
28 #include "interpreter/bytecodeHistogram.hpp"
29 #include "interpreter/bytecodeTracer.hpp"
30 #include "interpreter/linkResolver.hpp"
31 #include "memory/allocation.hpp"
32 #include "memory/resourceArea.hpp"
33 #include "runtime/threadLocalStorage.hpp"
34 #include "utilities/hashtable.hpp"
35
36 class AdapterHandlerEntry;
37 class AdapterHandlerTable;
38 class AdapterFingerPrint;
39 class vframeStream;
40
41 // Runtime is the base class for various runtime interfaces
42 // (InterpreterRuntime, CompilerRuntime, etc.). It provides
43 // shared functionality such as exception forwarding (C++ to
44 // Java exceptions), locking/unlocking mechanisms, statistical
45 // information, etc.
46
47 class SharedRuntime: AllStatic {
48 private:
49 static methodHandle resolve_sub_helper(JavaThread *thread,
50 bool is_virtual,
51 bool is_optimized, TRAPS);
52
53 // Shared stub locations
54
55 static RuntimeStub* _wrong_method_blob;
56 static RuntimeStub* _ic_miss_blob;
57 static RuntimeStub* _resolve_opt_virtual_call_blob;
58 static RuntimeStub* _resolve_virtual_call_blob;
59 static RuntimeStub* _resolve_static_call_blob;
60
61 static SafepointBlob* _polling_page_safepoint_handler_blob;
62 static SafepointBlob* _polling_page_return_handler_blob;
63 #ifdef COMPILER2
64 static ExceptionBlob* _exception_blob;
65 static UncommonTrapBlob* _uncommon_trap_blob;
66 #endif // COMPILER2
67
68 #ifndef PRODUCT
69
70 // Counters
71 static int _nof_megamorphic_calls; // total # of megamorphic calls (through vtable)
72
73 #endif // !PRODUCT
74 public:
75
76 // max bytes for each dtrace string parameter
77 enum { max_dtrace_string_size = 256 };
78
79 // The following arithmetic routines are used on platforms that do
80 // not have machine instructions to implement their functionality.
81 // Do not remove these.
82
83 // long arithmetics
84 static jlong lmul(jlong y, jlong x);
85 static jlong ldiv(jlong y, jlong x);
86 static jlong lrem(jlong y, jlong x);
87
88 // float and double remainder
89 static jfloat frem(jfloat x, jfloat y);
90 static jdouble drem(jdouble x, jdouble y);
91
92 #ifdef __SOFTFP__
93 static jfloat fadd(jfloat x, jfloat y);
94 static jfloat fsub(jfloat x, jfloat y);
95 static jfloat fmul(jfloat x, jfloat y);
96 static jfloat fdiv(jfloat x, jfloat y);
97
98 static jdouble dadd(jdouble x, jdouble y);
99 static jdouble dsub(jdouble x, jdouble y);
100 static jdouble dmul(jdouble x, jdouble y);
101 static jdouble ddiv(jdouble x, jdouble y);
102 #endif // __SOFTFP__
103
104 // float conversion (needs to set appropriate rounding mode)
105 static jint f2i (jfloat x);
106 static jlong f2l (jfloat x);
107 static jint d2i (jdouble x);
108 static jlong d2l (jdouble x);
109 static jfloat d2f (jdouble x);
110 static jfloat l2f (jlong x);
111 static jdouble l2d (jlong x);
112
113 #ifdef __SOFTFP__
114 static jfloat i2f (jint x);
115 static jdouble i2d (jint x);
116 static jdouble f2d (jfloat x);
117 #endif // __SOFTFP__
118
119 // double trigonometrics and transcendentals
120 static jdouble dsin(jdouble x);
121 static jdouble dcos(jdouble x);
122 static jdouble dtan(jdouble x);
123 static jdouble dlog(jdouble x);
124 static jdouble dlog10(jdouble x);
125 static jdouble dexp(jdouble x);
126 static jdouble dpow(jdouble x, jdouble y);
127
128 #if defined(__SOFTFP__) || defined(E500V2)
129 static double dabs(double f);
130 #endif
131
132 #if defined(__SOFTFP__) || defined(PPC)
133 static double dsqrt(double f);
134 #endif
135
136 #ifdef __SOFTFP__
137 // C++ compiler generates soft float instructions as well as passing
138 // float and double in registers.
139 static int fcmpl(float x, float y);
140 static int fcmpg(float x, float y);
141 static int dcmpl(double x, double y);
142 static int dcmpg(double x, double y);
143
144 static int unordered_fcmplt(float x, float y);
145 static int unordered_dcmplt(double x, double y);
146 static int unordered_fcmple(float x, float y);
147 static int unordered_dcmple(double x, double y);
148 static int unordered_fcmpge(float x, float y);
149 static int unordered_dcmpge(double x, double y);
150 static int unordered_fcmpgt(float x, float y);
151 static int unordered_dcmpgt(double x, double y);
152
153 static float fneg(float f);
154 static double dneg(double f);
155 #endif
156
157 // exception handling across interpreter/compiler boundaries
158 static address raw_exception_handler_for_return_address(JavaThread* thread, address return_address);
159 static address exception_handler_for_return_address(JavaThread* thread, address return_address);
160
161 #ifndef SERIALGC
162 // G1 write barriers
163 static void g1_wb_pre(oopDesc* orig, JavaThread *thread);
164 static void g1_wb_post(void* card_addr, JavaThread* thread);
165 #endif // !SERIALGC
166
167 // exception handling and implicit exceptions
168 static address compute_compiled_exc_handler(nmethod* nm, address ret_pc, Handle& exception,
169 bool force_unwind, bool top_frame_only);
170 enum ImplicitExceptionKind {
171 IMPLICIT_NULL,
172 IMPLICIT_DIVIDE_BY_ZERO,
173 STACK_OVERFLOW
174 };
175 static void throw_AbstractMethodError(JavaThread* thread);
176 static void throw_IncompatibleClassChangeError(JavaThread* thread);
177 static void throw_ArithmeticException(JavaThread* thread);
178 static void throw_NullPointerException(JavaThread* thread);
179 static void throw_NullPointerException_at_call(JavaThread* thread);
180 static void throw_StackOverflowError(JavaThread* thread);
181 static address continuation_for_implicit_exception(JavaThread* thread,
182 address faulting_pc,
183 ImplicitExceptionKind exception_kind);
184
185 // Shared stub locations
186 static address get_poll_stub(address pc);
187
188 static address get_ic_miss_stub() {
189 assert(_ic_miss_blob!= NULL, "oops");
190 return _ic_miss_blob->entry_point();
191 }
192
193 static address get_handle_wrong_method_stub() {
194 assert(_wrong_method_blob!= NULL, "oops");
195 return _wrong_method_blob->entry_point();
196 }
197
198 #ifdef COMPILER2
199 static void generate_uncommon_trap_blob(void);
200 static UncommonTrapBlob* uncommon_trap_blob() { return _uncommon_trap_blob; }
201 #endif // COMPILER2
202
203 static address get_resolve_opt_virtual_call_stub(){
204 assert(_resolve_opt_virtual_call_blob != NULL, "oops");
205 return _resolve_opt_virtual_call_blob->entry_point();
206 }
207 static address get_resolve_virtual_call_stub() {
208 assert(_resolve_virtual_call_blob != NULL, "oops");
209 return _resolve_virtual_call_blob->entry_point();
210 }
211 static address get_resolve_static_call_stub() {
212 assert(_resolve_static_call_blob != NULL, "oops");
213 return _resolve_static_call_blob->entry_point();
214 }
215
216 static SafepointBlob* polling_page_return_handler_blob() { return _polling_page_return_handler_blob; }
217 static SafepointBlob* polling_page_safepoint_handler_blob() { return _polling_page_safepoint_handler_blob; }
218
219 // Counters
220 #ifndef PRODUCT
221 static address nof_megamorphic_calls_addr() { return (address)&_nof_megamorphic_calls; }
222 #endif // PRODUCT
223
224 // Helper routine for full-speed JVMTI exception throwing support
225 static void throw_and_post_jvmti_exception(JavaThread *thread, Handle h_exception);
226 static void throw_and_post_jvmti_exception(JavaThread *thread, Symbol* name, const char *message = NULL);
227
228 // RedefineClasses() tracing support for obsolete method entry
229 static int rc_trace_method_entry(JavaThread* thread, methodOopDesc* m);
230
231 // To be used as the entry point for unresolved native methods.
232 static address native_method_throw_unsatisfied_link_error_entry();
233
234 // bytecode tracing is only used by the TraceBytecodes
235 static intptr_t trace_bytecode(JavaThread* thread, intptr_t preserve_this_value, intptr_t tos, intptr_t tos2) PRODUCT_RETURN0;
236
237 // Used to back off a spin lock that is under heavy contention
238 static void yield_all(JavaThread* thread, int attempts = 0);
239
240 static oop retrieve_receiver( Symbol* sig, frame caller );
241
242 static void register_finalizer(JavaThread* thread, oopDesc* obj);
243
244 // dtrace notifications
245 static int dtrace_object_alloc(oopDesc* o);
246 static int dtrace_object_alloc_base(Thread* thread, oopDesc* o);
247 static int dtrace_method_entry(JavaThread* thread, methodOopDesc* m);
248 static int dtrace_method_exit(JavaThread* thread, methodOopDesc* m);
249
250 // Utility method for retrieving the Java thread id, returns 0 if the
251 // thread is not a well formed Java thread.
252 static jlong get_java_tid(Thread* thread);
253
254
255 // used by native wrappers to reenable yellow if overflow happened in native code
256 static void reguard_yellow_pages();
257
258 /**
259 * Fill in the "X cannot be cast to a Y" message for ClassCastException
260 *
261 * @param thr the current thread
262 * @param name the name of the class of the object attempted to be cast
263 * @return the dynamically allocated exception message (must be freed
264 * by the caller using a resource mark)
265 *
266 * BCP must refer to the current 'checkcast' opcode for the frame
267 * on top of the stack.
268 * The caller (or one of it's callers) must use a ResourceMark
269 * in order to correctly free the result.
270 */
271 static char* generate_class_cast_message(JavaThread* thr, const char* name);
272
273 /**
274 * Fill in the message for a WrongMethodTypeException
275 *
276 * @param thr the current thread
277 * @param mtype (optional) expected method type (or argument class)
278 * @param mhandle (optional) actual method handle (or argument)
279 * @return the dynamically allocated exception message
280 *
281 * BCP for the frame on top of the stack must refer to an
282 * 'invokevirtual' op for a method handle, or an 'invokedyamic' op.
283 * The caller (or one of its callers) must use a ResourceMark
284 * in order to correctly free the result.
285 */
286 static char* generate_wrong_method_type_message(JavaThread* thr,
287 oopDesc* mtype = NULL,
288 oopDesc* mhandle = NULL);
289
290 /** Return non-null if the mtype is a klass or Class, not a MethodType. */
291 static oop wrong_method_type_is_for_single_argument(JavaThread* thr,
292 oopDesc* mtype);
293
294 /**
295 * Fill in the "X cannot be cast to a Y" message for ClassCastException
296 *
297 * @param name the name of the class of the object attempted to be cast
298 * @param klass the name of the target klass attempt
299 * @param gripe the specific kind of problem being reported
300 * @return the dynamically allocated exception message (must be freed
301 * by the caller using a resource mark)
302 *
303 * This version does not require access the frame, so it can be called
304 * from interpreted code
305 * The caller (or one of it's callers) must use a ResourceMark
306 * in order to correctly free the result.
307 */
308 static char* generate_class_cast_message(const char* name, const char* klass,
309 const char* gripe = " cannot be cast to ");
310
311 // Resolves a call site- may patch in the destination of the call into the
312 // compiled code.
313 static methodHandle resolve_helper(JavaThread *thread,
314 bool is_virtual,
315 bool is_optimized, TRAPS);
316
317 static void generate_stubs(void);
318
319 private:
320 // deopt blob
321 static void generate_deopt_blob(void);
322 static DeoptimizationBlob* _deopt_blob;
323
324 public:
325 static DeoptimizationBlob* deopt_blob(void) { return _deopt_blob; }
326
327 // Resets a call-site in compiled code so it will get resolved again.
328 static methodHandle reresolve_call_site(JavaThread *thread, TRAPS);
329
330 // In the code prolog, if the klass comparison fails, the inline cache
331 // misses and the call site is patched to megamorphic
332 static methodHandle handle_ic_miss_helper(JavaThread* thread, TRAPS);
333
334 // Find the method that called us.
335 static methodHandle find_callee_method(JavaThread* thread, TRAPS);
336
337
338 private:
339 static Handle find_callee_info(JavaThread* thread,
340 Bytecodes::Code& bc,
341 CallInfo& callinfo, TRAPS);
342 static Handle find_callee_info_helper(JavaThread* thread,
343 vframeStream& vfst,
344 Bytecodes::Code& bc,
345 CallInfo& callinfo, TRAPS);
346
347 static address clean_virtual_call_entry();
348 static address clean_opt_virtual_call_entry();
349 static address clean_static_call_entry();
350
351 public:
352
353 // Read the array of BasicTypes from a Java signature, and compute where
354 // compiled Java code would like to put the results. Values in reg_lo and
355 // reg_hi refer to 4-byte quantities. Values less than SharedInfo::stack0 are
356 // registers, those above refer to 4-byte stack slots. All stack slots are
357 // based off of the window top. SharedInfo::stack0 refers to the first usable
358 // slot in the bottom of the frame. SharedInfo::stack0+1 refers to the memory word
359 // 4-bytes higher. So for sparc because the register window save area is at
360 // the bottom of the frame the first 16 words will be skipped and SharedInfo::stack0
361 // will be just above it. (
362 // return value is the maximum number of VMReg stack slots the convention will use.
363 static int java_calling_convention(const BasicType *sig_bt, VMRegPair *regs, int total_args_passed, int is_outgoing);
364
365 // Ditto except for calling C
366 static int c_calling_convention(const BasicType *sig_bt, VMRegPair *regs, int total_args_passed);
367
368 // Generate I2C and C2I adapters. These adapters are simple argument marshalling
369 // blobs. Unlike adapters in the tiger and earlier releases the code in these
370 // blobs does not create a new frame and are therefore virtually invisible
371 // to the stack walking code. In general these blobs extend the callers stack
372 // as needed for the conversion of argument locations.
373
374 // When calling a c2i blob the code will always call the interpreter even if
375 // by the time we reach the blob there is compiled code available. This allows
376 // the blob to pass the incoming stack pointer (the sender sp) in a known
377 // location for the interpreter to record. This is used by the frame code
378 // to correct the sender code to match up with the stack pointer when the
379 // thread left the compiled code. In addition it allows the interpreter
380 // to remove the space the c2i adapter allocated to do it argument conversion.
381
382 // Although a c2i blob will always run interpreted even if compiled code is
383 // present if we see that compiled code is present the compiled call site
384 // will be patched/re-resolved so that later calls will run compiled.
385
386 // Aditionally a c2i blob need to have a unverified entry because it can be reached
387 // in situations where the call site is an inlined cache site and may go megamorphic.
388
389 // A i2c adapter is simpler than the c2i adapter. This is because it is assumed
390 // that the interpreter before it does any call dispatch will record the current
391 // stack pointer in the interpreter frame. On return it will restore the stack
392 // pointer as needed. This means the i2c adapter code doesn't need any special
393 // handshaking path with compiled code to keep the stack walking correct.
394
395 static AdapterHandlerEntry* generate_i2c2i_adapters(MacroAssembler *_masm,
396 int total_args_passed,
397 int max_arg,
398 const BasicType *sig_bt,
399 const VMRegPair *regs,
400 AdapterFingerPrint* fingerprint);
401
402 // OSR support
403
404 // OSR_migration_begin will extract the jvm state from an interpreter
405 // frame (locals, monitors) and store the data in a piece of C heap
406 // storage. This then allows the interpreter frame to be removed from the
407 // stack and the OSR nmethod to be called. That method is called with a
408 // pointer to the C heap storage. This pointer is the return value from
409 // OSR_migration_begin.
410
411 static intptr_t* OSR_migration_begin( JavaThread *thread);
412
413 // OSR_migration_end is a trivial routine. It is called after the compiled
414 // method has extracted the jvm state from the C heap that OSR_migration_begin
415 // created. It's entire job is to simply free this storage.
416 static void OSR_migration_end ( intptr_t* buf);
417
418 // Convert a sig into a calling convention register layout
419 // and find interesting things about it.
420 static VMRegPair* find_callee_arguments(Symbol* sig, bool has_receiver, int *arg_size);
421 static VMReg name_for_receiver();
422
423 // "Top of Stack" slots that may be unused by the calling convention but must
424 // otherwise be preserved.
425 // On Intel these are not necessary and the value can be zero.
426 // On Sparc this describes the words reserved for storing a register window
427 // when an interrupt occurs.
428 static uint out_preserve_stack_slots();
429
430 // Save and restore a native result
431 static void save_native_result(MacroAssembler *_masm, BasicType ret_type, int frame_slots );
432 static void restore_native_result(MacroAssembler *_masm, BasicType ret_type, int frame_slots );
433
434 // Generate a native wrapper for a given method. The method takes arguments
435 // in the Java compiled code convention, marshals them to the native
436 // convention (handlizes oops, etc), transitions to native, makes the call,
437 // returns to java state (possibly blocking), unhandlizes any result and
438 // returns.
439 static nmethod *generate_native_wrapper(MacroAssembler* masm,
440 methodHandle method,
441 int total_args_passed,
442 int max_arg,
443 BasicType *sig_bt,
444 VMRegPair *regs,
445 BasicType ret_type );
446
447 #ifdef HAVE_DTRACE_H
448 // Generate a dtrace wrapper for a given method. The method takes arguments
449 // in the Java compiled code convention, marshals them to the native
450 // convention (handlizes oops, etc), transitions to native, makes the call,
451 // returns to java state (possibly blocking), unhandlizes any result and
452 // returns.
453 static nmethod *generate_dtrace_nmethod(MacroAssembler* masm,
454 methodHandle method);
455
456 // dtrace support to convert a Java string to utf8
457 static void get_utf(oopDesc* src, address dst);
458 #endif // def HAVE_DTRACE_H
459
460 // A compiled caller has just called the interpreter, but compiled code
461 // exists. Patch the caller so he no longer calls into the interpreter.
462 static void fixup_callers_callsite(methodOopDesc* moop, address ret_pc);
463
464 // Slow-path Locking and Unlocking
465 static void complete_monitor_locking_C(oopDesc* obj, BasicLock* lock, JavaThread* thread);
466 static void complete_monitor_unlocking_C(oopDesc* obj, BasicLock* lock);
467
468 // Resolving of calls
469 static address resolve_static_call_C (JavaThread *thread);
470 static address resolve_virtual_call_C (JavaThread *thread);
471 static address resolve_opt_virtual_call_C(JavaThread *thread);
472
473 // arraycopy, the non-leaf version. (See StubRoutines for all the leaf calls.)
474 static void slow_arraycopy_C(oopDesc* src, jint src_pos,
475 oopDesc* dest, jint dest_pos,
476 jint length, JavaThread* thread);
477
478 // handle ic miss with caller being compiled code
479 // wrong method handling (inline cache misses, zombie methods)
480 static address handle_wrong_method(JavaThread* thread);
481 static address handle_wrong_method_ic_miss(JavaThread* thread);
482
483 #ifndef PRODUCT
484
485 // Collect and print inline cache miss statistics
486 private:
487 enum { maxICmiss_count = 100 };
488 static int _ICmiss_index; // length of IC miss histogram
489 static int _ICmiss_count[maxICmiss_count]; // miss counts
490 static address _ICmiss_at[maxICmiss_count]; // miss addresses
491 static void trace_ic_miss(address at);
492
493 public:
494 static int _monitor_enter_ctr; // monitor enter slow
495 static int _monitor_exit_ctr; // monitor exit slow
496 static int _throw_null_ctr; // throwing a null-pointer exception
497 static int _ic_miss_ctr; // total # of IC misses
498 static int _wrong_method_ctr;
499 static int _resolve_static_ctr;
500 static int _resolve_virtual_ctr;
501 static int _resolve_opt_virtual_ctr;
502 static int _implicit_null_throws;
503 static int _implicit_div0_throws;
504
505 static int _jbyte_array_copy_ctr; // Slow-path byte array copy
506 static int _jshort_array_copy_ctr; // Slow-path short array copy
507 static int _jint_array_copy_ctr; // Slow-path int array copy
508 static int _jlong_array_copy_ctr; // Slow-path long array copy
509 static int _oop_array_copy_ctr; // Slow-path oop array copy
510 static int _checkcast_array_copy_ctr; // Slow-path oop array copy, with cast
511 static int _unsafe_array_copy_ctr; // Slow-path includes alignment checks
512 static int _generic_array_copy_ctr; // Slow-path includes type decoding
513 static int _slow_array_copy_ctr; // Slow-path failed out to a method call
514
515 static int _new_instance_ctr; // 'new' object requires GC
516 static int _new_array_ctr; // 'new' array requires GC
517 static int _multi1_ctr, _multi2_ctr, _multi3_ctr, _multi4_ctr, _multi5_ctr;
518 static int _find_handler_ctr; // find exception handler
519 static int _rethrow_ctr; // rethrow exception
520 static int _mon_enter_stub_ctr; // monitor enter stub
521 static int _mon_exit_stub_ctr; // monitor exit stub
522 static int _mon_enter_ctr; // monitor enter slow
523 static int _mon_exit_ctr; // monitor exit slow
524 static int _partial_subtype_ctr; // SubRoutines::partial_subtype_check
525
526 // Statistics code
527 // stats for "normal" compiled calls (non-interface)
528 static int _nof_normal_calls; // total # of calls
529 static int _nof_optimized_calls; // total # of statically-bound calls
530 static int _nof_inlined_calls; // total # of inlined normal calls
531 static int _nof_static_calls; // total # of calls to static methods or super methods (invokespecial)
532 static int _nof_inlined_static_calls; // total # of inlined static calls
533 // stats for compiled interface calls
534 static int _nof_interface_calls; // total # of compiled calls
535 static int _nof_optimized_interface_calls; // total # of statically-bound interface calls
536 static int _nof_inlined_interface_calls; // total # of inlined interface calls
537 static int _nof_megamorphic_interface_calls;// total # of megamorphic interface calls
538 // stats for runtime exceptions
539 static int _nof_removable_exceptions; // total # of exceptions that could be replaced by branches due to inlining
540
541 public: // for compiler
542 static address nof_normal_calls_addr() { return (address)&_nof_normal_calls; }
543 static address nof_optimized_calls_addr() { return (address)&_nof_optimized_calls; }
544 static address nof_inlined_calls_addr() { return (address)&_nof_inlined_calls; }
545 static address nof_static_calls_addr() { return (address)&_nof_static_calls; }
546 static address nof_inlined_static_calls_addr() { return (address)&_nof_inlined_static_calls; }
547 static address nof_interface_calls_addr() { return (address)&_nof_interface_calls; }
548 static address nof_optimized_interface_calls_addr() { return (address)&_nof_optimized_interface_calls; }
549 static address nof_inlined_interface_calls_addr() { return (address)&_nof_inlined_interface_calls; }
550 static address nof_megamorphic_interface_calls_addr() { return (address)&_nof_megamorphic_interface_calls; }
551 static void print_call_statistics(int comp_total);
552 static void print_statistics();
553 static void print_ic_miss_histogram();
554
555 #endif // PRODUCT
556 };
557
558
559 // ---------------------------------------------------------------------------
560 // Implementation of AdapterHandlerLibrary
561 //
562 // This library manages argument marshaling adapters and native wrappers.
563 // There are 2 flavors of adapters: I2C and C2I.
564 //
565 // The I2C flavor takes a stock interpreted call setup, marshals the
566 // arguments for a Java-compiled call, and jumps to Rmethod-> code()->
567 // code_begin(). It is broken to call it without an nmethod assigned.
568 // The usual behavior is to lift any register arguments up out of the
569 // stack and possibly re-pack the extra arguments to be contigious.
570 // I2C adapters will save what the interpreter's stack pointer will be
571 // after arguments are popped, then adjust the interpreter's frame
572 // size to force alignment and possibly to repack the arguments.
573 // After re-packing, it jumps to the compiled code start. There are
574 // no safepoints in this adapter code and a GC cannot happen while
575 // marshaling is in progress.
576 //
577 // The C2I flavor takes a stock compiled call setup plus the target method in
578 // Rmethod, marshals the arguments for an interpreted call and jumps to
579 // Rmethod->_i2i_entry. On entry, the interpreted frame has not yet been
580 // setup. Compiled frames are fixed-size and the args are likely not in the
581 // right place. Hence all the args will likely be copied into the
582 // interpreter's frame, forcing that frame to grow. The compiled frame's
583 // outgoing stack args will be dead after the copy.
584 //
585 // Native wrappers, like adapters, marshal arguments. Unlike adapters they
586 // also perform an offical frame push & pop. They have a call to the native
587 // routine in their middles and end in a return (instead of ending in a jump).
588 // The native wrappers are stored in real nmethods instead of the BufferBlobs
589 // used by the adapters. The code generation happens here because it's very
590 // similar to what the adapters have to do.
591
592 class AdapterHandlerEntry : public BasicHashtableEntry {
593 friend class AdapterHandlerTable;
594
595 private:
596 AdapterFingerPrint* _fingerprint;
597 address _i2c_entry;
598 address _c2i_entry;
599 address _c2i_unverified_entry;
600
601 #ifdef ASSERT
602 // Captures code and signature used to generate this adapter when
603 // verifing adapter equivalence.
604 unsigned char* _saved_code;
605 int _code_length;
606 BasicType* _saved_sig;
607 int _total_args_passed;
608 #endif
609
610 void init(AdapterFingerPrint* fingerprint, address i2c_entry, address c2i_entry, address c2i_unverified_entry) {
611 _fingerprint = fingerprint;
612 _i2c_entry = i2c_entry;
613 _c2i_entry = c2i_entry;
614 _c2i_unverified_entry = c2i_unverified_entry;
615 #ifdef ASSERT
616 _saved_code = NULL;
617 _code_length = 0;
618 _saved_sig = NULL;
619 _total_args_passed = 0;
620 #endif
621 }
622
623 void deallocate();
624
625 // should never be used
626 AdapterHandlerEntry();
627
628 public:
629 address get_i2c_entry() { return _i2c_entry; }
630 address get_c2i_entry() { return _c2i_entry; }
631 address get_c2i_unverified_entry() { return _c2i_unverified_entry; }
632
633 void relocate(address new_base);
634
635 AdapterFingerPrint* fingerprint() { return _fingerprint; }
636
637 AdapterHandlerEntry* next() {
638 return (AdapterHandlerEntry*)BasicHashtableEntry::next();
639 }
640
641 #ifdef ASSERT
642 // Used to verify that code generated for shared adapters is equivalent
643 void save_code(unsigned char* code, int length, int total_args_passed, BasicType* sig_bt);
644 bool compare_code(unsigned char* code, int length, int total_args_passed, BasicType* sig_bt);
645 #endif
646
647 void print();
648 };
649
650 class AdapterHandlerLibrary: public AllStatic {
651 private:
652 static BufferBlob* _buffer; // the temporary code buffer in CodeCache
653 static AdapterHandlerTable* _adapters;
654 static AdapterHandlerEntry* _abstract_method_handler;
655 static BufferBlob* buffer_blob();
656 static void initialize();
657
658 public:
659
660 static AdapterHandlerEntry* new_entry(AdapterFingerPrint* fingerprint,
661 address i2c_entry, address c2i_entry, address c2i_unverified_entry);
662 static nmethod* create_native_wrapper(methodHandle method);
663 static AdapterHandlerEntry* get_adapter(methodHandle method);
664
665 #ifdef HAVE_DTRACE_H
666 static nmethod* create_dtrace_nmethod (methodHandle method);
667 #endif // HAVE_DTRACE_H
668
669 static void print_handler(CodeBlob* b) { print_handler_on(tty, b); }
670 static void print_handler_on(outputStream* st, CodeBlob* b);
671 static bool contains(CodeBlob* b);
672 #ifndef PRODUCT
673 static void print_statistics();
674 #endif /* PRODUCT */
675
676 };
677
678 #endif // SHARE_VM_RUNTIME_SHAREDRUNTIME_HPP