1 /*
2 * Copyright (c) 1997, 2017, 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 #include "precompiled.hpp"
26 #include "classfile/systemDictionary.hpp"
27 #include "classfile/vmSymbols.hpp"
28 #include "code/nmethod.hpp"
29 #include "compiler/compileBroker.hpp"
30 #include "interpreter/interpreter.hpp"
31 #include "interpreter/linkResolver.hpp"
32 #include "memory/universe.inline.hpp"
33 #include "oops/oop.inline.hpp"
34 #include "prims/jniCheck.hpp"
35 #include "runtime/compilationPolicy.hpp"
36 #include "runtime/handles.inline.hpp"
37 #include "runtime/interfaceSupport.hpp"
38 #include "runtime/javaCalls.hpp"
39 #include "runtime/mutexLocker.hpp"
40 #include "runtime/os.inline.hpp"
41 #include "runtime/signature.hpp"
42 #include "runtime/stubRoutines.hpp"
43 #include "runtime/thread.inline.hpp"
44 #if INCLUDE_JVMCI
45 #include "jvmci/jvmciJavaClasses.hpp"
46 #include "jvmci/jvmciRuntime.hpp"
47 #endif
48
49 // -----------------------------------------------------
50 // Implementation of JavaCallWrapper
51
52 JavaCallWrapper::JavaCallWrapper(methodHandle callee_method, Handle receiver, JavaValue* result, TRAPS) {
53 JavaThread* thread = (JavaThread *)THREAD;
54 bool clear_pending_exception = true;
55
56 guarantee(thread->is_Java_thread(), "crucial check - the VM thread cannot and must not escape to Java code");
57 assert(!thread->owns_locks(), "must release all locks when leaving VM");
58 guarantee(thread->can_call_java(), "cannot make java calls from the native compiler");
59 _result = result;
60
61 // Allocate handle block for Java code. This must be done before we change thread_state to _thread_in_Java_or_stub,
62 // since it can potentially block.
63 JNIHandleBlock* new_handles = JNIHandleBlock::allocate_block(thread);
64
65 // After this, we are official in JavaCode. This needs to be done before we change any of the thread local
66 // info, since we cannot find oops before the new information is set up completely.
67 ThreadStateTransition::transition(thread, _thread_in_vm, _thread_in_Java);
68
69 // Make sure that we handle asynchronous stops and suspends _before_ we clear all thread state
70 // in JavaCallWrapper::JavaCallWrapper(). This way, we can decide if we need to do any pd actions
71 // to prepare for stop/suspend (flush register windows on sparcs, cache sp, or other state).
72 if (thread->has_special_runtime_exit_condition()) {
73 thread->handle_special_runtime_exit_condition();
74 if (HAS_PENDING_EXCEPTION) {
75 clear_pending_exception = false;
76 }
77 }
78
79
80 // Make sure to set the oop's after the thread transition - since we can block there. No one is GC'ing
81 // the JavaCallWrapper before the entry frame is on the stack.
82 _callee_method = callee_method();
83 _receiver = receiver();
84
85 #ifdef CHECK_UNHANDLED_OOPS
86 THREAD->allow_unhandled_oop(&_receiver);
87 #endif // CHECK_UNHANDLED_OOPS
88
89 _thread = (JavaThread *)thread;
90 _handles = _thread->active_handles(); // save previous handle block & Java frame linkage
91
92 // For the profiler, the last_Java_frame information in thread must always be in
93 // legal state. We have no last Java frame if last_Java_sp == NULL so
94 // the valid transition is to clear _last_Java_sp and then reset the rest of
95 // the (platform specific) state.
96
97 _anchor.copy(_thread->frame_anchor());
98 _thread->frame_anchor()->clear();
99
100 debug_only(_thread->inc_java_call_counter());
101 _thread->set_active_handles(new_handles); // install new handle block and reset Java frame linkage
102
103 assert (_thread->thread_state() != _thread_in_native, "cannot set native pc to NULL");
104
105 // clear any pending exception in thread (native calls start with no exception pending)
106 if(clear_pending_exception) {
107 _thread->clear_pending_exception();
108 }
109
110 if (_anchor.last_Java_sp() == NULL) {
111 _thread->record_base_of_stack_pointer();
112 }
113 }
114
115
116 JavaCallWrapper::~JavaCallWrapper() {
117 assert(_thread == JavaThread::current(), "must still be the same thread");
118
119 // restore previous handle block & Java frame linkage
120 JNIHandleBlock *_old_handles = _thread->active_handles();
121 _thread->set_active_handles(_handles);
122
123 _thread->frame_anchor()->zap();
124
125 debug_only(_thread->dec_java_call_counter());
126
127 if (_anchor.last_Java_sp() == NULL) {
128 _thread->set_base_of_stack_pointer(NULL);
129 }
130
131
132 // Old thread-local info. has been restored. We are not back in the VM.
133 ThreadStateTransition::transition_from_java(_thread, _thread_in_vm);
134
135 // State has been restored now make the anchor frame visible for the profiler.
136 // Do this after the transition because this allows us to put an assert
137 // the Java->vm transition which checks to see that stack is not walkable
138 // on sparc/ia64 which will catch violations of the reseting of last_Java_frame
139 // invariants (i.e. _flags always cleared on return to Java)
140
141 _thread->frame_anchor()->copy(&_anchor);
142
143 // Release handles after we are marked as being inside the VM again, since this
144 // operation might block
145 JNIHandleBlock::release_block(_old_handles, _thread);
146 }
147
148
149 void JavaCallWrapper::oops_do(OopClosure* f) {
150 f->do_oop((oop*)&_receiver);
151 handles()->oops_do(f);
152 }
153
154
155 // Helper methods
156 static BasicType runtime_type_from(JavaValue* result) {
157 switch (result->get_type()) {
158 case T_BOOLEAN: // fall through
159 case T_CHAR : // fall through
160 case T_SHORT : // fall through
161 case T_INT : // fall through
162 #ifndef _LP64
163 case T_OBJECT : // fall through
164 case T_ARRAY : // fall through
165 #endif
166 case T_BYTE : // fall through
167 case T_VOID : return T_INT;
168 case T_LONG : return T_LONG;
169 case T_FLOAT : return T_FLOAT;
170 case T_DOUBLE : return T_DOUBLE;
171 #ifdef _LP64
172 case T_ARRAY : // fall through
173 case T_OBJECT: return T_OBJECT;
174 #endif
175 default:
176 ShouldNotReachHere();
177 return T_ILLEGAL;
178 }
179 }
180
181 // ============ Virtual calls ============
182
183 void JavaCalls::call_virtual(JavaValue* result, Klass* spec_klass, Symbol* name, Symbol* signature, JavaCallArguments* args, TRAPS) {
184 CallInfo callinfo;
185 Handle receiver = args->receiver();
186 Klass* recvrKlass = receiver.is_null() ? (Klass*)NULL : receiver->klass();
187 LinkInfo link_info(spec_klass, name, signature);
188 LinkResolver::resolve_virtual_call(
189 callinfo, receiver, recvrKlass, link_info, true, CHECK);
190 methodHandle method = callinfo.selected_method();
191 assert(method.not_null(), "should have thrown exception");
192
193 // Invoke the method
194 JavaCalls::call(result, method, args, CHECK);
195 }
196
197
198 void JavaCalls::call_virtual(JavaValue* result, Handle receiver, Klass* spec_klass, Symbol* name, Symbol* signature, TRAPS) {
199 JavaCallArguments args(receiver); // One oop argument
200 call_virtual(result, spec_klass, name, signature, &args, CHECK);
201 }
202
203
204 void JavaCalls::call_virtual(JavaValue* result, Handle receiver, Klass* spec_klass, Symbol* name, Symbol* signature, Handle arg1, TRAPS) {
205 JavaCallArguments args(receiver); // One oop argument
206 args.push_oop(arg1);
207 call_virtual(result, spec_klass, name, signature, &args, CHECK);
208 }
209
210
211
212 void JavaCalls::call_virtual(JavaValue* result, Handle receiver, Klass* spec_klass, Symbol* name, Symbol* signature, Handle arg1, Handle arg2, TRAPS) {
213 JavaCallArguments args(receiver); // One oop argument
214 args.push_oop(arg1);
215 args.push_oop(arg2);
216 call_virtual(result, spec_klass, name, signature, &args, CHECK);
217 }
218
219
220 // ============ Special calls ============
221
222 void JavaCalls::call_special(JavaValue* result, Klass* klass, Symbol* name, Symbol* signature, JavaCallArguments* args, TRAPS) {
223 CallInfo callinfo;
224 LinkInfo link_info(klass, name, signature);
225 LinkResolver::resolve_special_call(callinfo, args->receiver(), link_info, CHECK);
226 methodHandle method = callinfo.selected_method();
227 assert(method.not_null(), "should have thrown exception");
228
229 // Invoke the method
230 JavaCalls::call(result, method, args, CHECK);
231 }
232
233
234 void JavaCalls::call_special(JavaValue* result, Handle receiver, Klass* klass, Symbol* name, Symbol* signature, TRAPS) {
235 JavaCallArguments args(receiver); // One oop argument
236 call_special(result, klass, name, signature, &args, CHECK);
237 }
238
239
240 void JavaCalls::call_special(JavaValue* result, Handle receiver, Klass* klass, Symbol* name, Symbol* signature, Handle arg1, TRAPS) {
241 JavaCallArguments args(receiver); // One oop argument
242 args.push_oop(arg1);
243 call_special(result, klass, name, signature, &args, CHECK);
244 }
245
246
247 void JavaCalls::call_special(JavaValue* result, Handle receiver, Klass* klass, Symbol* name, Symbol* signature, Handle arg1, Handle arg2, TRAPS) {
248 JavaCallArguments args(receiver); // One oop argument
249 args.push_oop(arg1);
250 args.push_oop(arg2);
251 call_special(result, klass, name, signature, &args, CHECK);
252 }
253
254
255 // ============ Static calls ============
256
257 void JavaCalls::call_static(JavaValue* result, Klass* klass, Symbol* name, Symbol* signature, JavaCallArguments* args, TRAPS) {
258 CallInfo callinfo;
259 LinkInfo link_info(klass, name, signature);
260 LinkResolver::resolve_static_call(callinfo, link_info, true, CHECK);
261 methodHandle method = callinfo.selected_method();
262 assert(method.not_null(), "should have thrown exception");
263
264 // Invoke the method
265 JavaCalls::call(result, method, args, CHECK);
266 }
267
268
269 void JavaCalls::call_static(JavaValue* result, Klass* klass, Symbol* name, Symbol* signature, TRAPS) {
270 JavaCallArguments args; // No argument
271 call_static(result, klass, name, signature, &args, CHECK);
272 }
273
274
275 void JavaCalls::call_static(JavaValue* result, Klass* klass, Symbol* name, Symbol* signature, Handle arg1, TRAPS) {
276 JavaCallArguments args(arg1); // One oop argument
277 call_static(result, klass, name, signature, &args, CHECK);
278 }
279
280
281 void JavaCalls::call_static(JavaValue* result, Klass* klass, Symbol* name, Symbol* signature, Handle arg1, Handle arg2, TRAPS) {
282 JavaCallArguments args; // One oop argument
283 args.push_oop(arg1);
284 args.push_oop(arg2);
285 call_static(result, klass, name, signature, &args, CHECK);
286 }
287
288
289 void JavaCalls::call_static(JavaValue* result, Klass* klass, Symbol* name, Symbol* signature, Handle arg1, Handle arg2, Handle arg3, TRAPS) {
290 JavaCallArguments args; // One oop argument
291 args.push_oop(arg1);
292 args.push_oop(arg2);
293 args.push_oop(arg3);
294 call_static(result, klass, name, signature, &args, CHECK);
295 }
296
297 // -------------------------------------------------
298 // Implementation of JavaCalls (low level)
299
300
301 void JavaCalls::call(JavaValue* result, const methodHandle& method, JavaCallArguments* args, TRAPS) {
302 // Check if we need to wrap a potential OS exception handler around thread
303 // This is used for e.g. Win32 structured exception handlers
304 assert(THREAD->is_Java_thread(), "only JavaThreads can make JavaCalls");
305 // Need to wrap each and every time, since there might be native code down the
306 // stack that has installed its own exception handlers
307 os::os_exception_wrapper(call_helper, result, method, args, THREAD);
308 }
309
310 void JavaCalls::call_helper(JavaValue* result, const methodHandle& method, JavaCallArguments* args, TRAPS) {
311 // During dumping, Java execution environment is not fully initialized. Also, Java execution
312 // may cause undesirable side-effects in the class metadata.
313 assert(!DumpSharedSpaces, "must not execute Java bytecodes when dumping");
314
315 JavaThread* thread = (JavaThread*)THREAD;
316 assert(thread->is_Java_thread(), "must be called by a java thread");
317 assert(method.not_null(), "must have a method to call");
318 assert(!SafepointSynchronize::is_at_safepoint(), "call to Java code during VM operation");
319 assert(!thread->handle_area()->no_handle_mark_active(), "cannot call out to Java here");
320
321
322 CHECK_UNHANDLED_OOPS_ONLY(thread->clear_unhandled_oops();)
323
324 #if INCLUDE_JVMCI
325 // Gets the nmethod (if any) that should be called instead of normal target
326 nmethod* alternative_target = args->alternative_target();
327 if (alternative_target == NULL) {
328 #endif
329 // Verify the arguments
330
331 if (CheckJNICalls) {
332 args->verify(method, result->get_type());
333 }
334 else debug_only(args->verify(method, result->get_type()));
335 #if INCLUDE_JVMCI
336 }
337 #else
338
339 // Ignore call if method is empty
340 if (method->is_empty_method()) {
341 assert(result->get_type() == T_VOID, "an empty method must return a void value");
342 return;
343 }
344 #endif
345
346 #ifdef ASSERT
347 { InstanceKlass* holder = method->method_holder();
348 // A klass might not be initialized since JavaCall's might be used during the executing of
349 // the <clinit>. For example, a Thread.start might start executing on an object that is
350 // not fully initialized! (bad Java programming style)
351 assert(holder->is_linked(), "rewriting must have taken place");
352 }
353 #endif
354
355 CompilationPolicy::compile_if_required(method, CHECK);
356
357 // Since the call stub sets up like the interpreter we call the from_interpreted_entry
358 // so we can go compiled via a i2c. Otherwise initial entry method will always
359 // run interpreted.
360 address entry_point = method->from_interpreted_entry();
361 if (JvmtiExport::can_post_interpreter_events() && thread->is_interp_only_mode()) {
362 entry_point = method->interpreter_entry();
363 }
364
365 // Figure out if the result value is an oop or not (Note: This is a different value
366 // than result_type. result_type will be T_INT of oops. (it is about size)
367 BasicType result_type = runtime_type_from(result);
368 bool oop_result_flag = (result->get_type() == T_OBJECT || result->get_type() == T_ARRAY);
369
370 // NOTE: if we move the computation of the result_val_address inside
371 // the call to call_stub, the optimizer produces wrong code.
372 intptr_t* result_val_address = (intptr_t*)(result->get_value_addr());
373
374 // Find receiver
375 Handle receiver = (!method->is_static()) ? args->receiver() : Handle();
376
377 // When we reenter Java, we need to reenable the reserved/yellow zone which
378 // might already be disabled when we are in VM.
379 if (!thread->stack_guards_enabled()) {
380 thread->reguard_stack();
381 }
382
383 // Check that there are shadow pages available before changing thread state
384 // to Java. Calculate current_stack_pointer here to make sure
385 // stack_shadow_pages_available() and bang_stack_shadow_pages() use the same sp.
386 address sp = os::current_stack_pointer();
387 if (!os::stack_shadow_pages_available(THREAD, method, sp)) {
388 // Throw stack overflow exception with preinitialized exception.
389 Exceptions::throw_stack_overflow_exception(THREAD, __FILE__, __LINE__, method);
390 return;
391 } else {
392 // Touch pages checked if the OS needs them to be touched to be mapped.
393 os::map_stack_shadow_pages(sp);
394 }
395
396 #if INCLUDE_JVMCI
397 if (alternative_target != NULL) {
398 if (alternative_target->is_alive()) {
399 thread->set_jvmci_alternate_call_target(alternative_target->verified_entry_point());
400 entry_point = method->adapter()->get_i2c_entry();
401 } else {
402 THROW(vmSymbols::jdk_vm_ci_code_InvalidInstalledCodeException());
403 }
404 }
405 #endif
406
407 // do call
408 { JavaCallWrapper link(method, receiver, result, CHECK);
409 { HandleMark hm(thread); // HandleMark used by HandleMarkCleaner
410
411 StubRoutines::call_stub()(
412 (address)&link,
413 // (intptr_t*)&(result->_value), // see NOTE above (compiler problem)
414 result_val_address, // see NOTE above (compiler problem)
415 result_type,
416 method(),
417 entry_point,
418 args->parameters(),
419 args->size_of_parameters(),
420 CHECK
421 );
422
423 result = link.result(); // circumvent MS C++ 5.0 compiler bug (result is clobbered across call)
424 // Preserve oop return value across possible gc points
425 if (oop_result_flag) {
426 thread->set_vm_result((oop) result->get_jobject());
427 }
428 }
429 } // Exit JavaCallWrapper (can block - potential return oop must be preserved)
430
431 // Check if a thread stop or suspend should be executed
432 // The following assert was not realistic. Thread.stop can set that bit at any moment.
433 //assert(!thread->has_special_runtime_exit_condition(), "no async. exceptions should be installed");
434
435 // Restore possible oop return
436 if (oop_result_flag) {
437 result->set_jobject((jobject)thread->vm_result());
438 thread->set_vm_result(NULL);
439 }
440 }
441
442
443 //--------------------------------------------------------------------------------------
444 // Implementation of JavaCallArguments
445
446 inline bool is_value_state_indirect_oop(uint state) {
447 assert(state != JavaCallArguments::value_state_oop,
448 "Checking for handles after removal");
449 assert(state < JavaCallArguments::value_state_limit,
450 "Invalid value state %u", state);
451 return state != JavaCallArguments::value_state_primitive;
452 }
453
454 inline oop resolve_indirect_oop(intptr_t value, uint state) {
455 switch (state) {
456 case JavaCallArguments::value_state_handle:
457 {
458 oop* ptr = reinterpret_cast<oop*>(value);
459 return Handle::raw_resolve(ptr);
460 }
461
462 case JavaCallArguments::value_state_jobject:
463 {
464 jobject obj = reinterpret_cast<jobject>(value);
465 return JNIHandles::resolve(obj);
466 }
467
468 default:
469 ShouldNotReachHere();
470 return NULL;
471 }
472 }
473
474 intptr_t* JavaCallArguments::parameters() {
475 // First convert all handles to oops
476 for(int i = 0; i < _size; i++) {
477 uint state = _value_state[i];
478 assert(state != value_state_oop, "Multiple handle conversions");
479 if (is_value_state_indirect_oop(state)) {
480 oop obj = resolve_indirect_oop(_value[i], state);
481 _value[i] = cast_from_oop<intptr_t>(obj);
482 _value_state[i] = value_state_oop;
483 }
484 }
485 // Return argument vector
486 return _value;
487 }
488
489
490 class SignatureChekker : public SignatureIterator {
491 private:
492 int _pos;
493 BasicType _return_type;
494 u_char* _value_state;
495 intptr_t* _value;
496
497 public:
498 bool _is_return;
499
500 SignatureChekker(Symbol* signature,
501 BasicType return_type,
502 bool is_static,
503 u_char* value_state,
504 intptr_t* value) :
505 SignatureIterator(signature),
506 _pos(0),
507 _return_type(return_type),
508 _value_state(value_state),
509 _value(value),
510 _is_return(false)
511 {
512 if (!is_static) {
513 check_value(true); // Receiver must be an oop
514 }
515 }
516
517 void check_value(bool type) {
518 uint state = _value_state[_pos++];
519 if (type) {
520 guarantee(is_value_state_indirect_oop(state),
521 "signature does not match pushed arguments: %u at %d",
522 state, _pos - 1);
523 } else {
524 guarantee(state == JavaCallArguments::value_state_primitive,
525 "signature does not match pushed arguments: %u at %d",
526 state, _pos - 1);
527 }
528 }
529
530 void check_doing_return(bool state) { _is_return = state; }
531
532 void check_return_type(BasicType t) {
533 guarantee(_is_return && t == _return_type, "return type does not match");
534 }
535
536 void check_int(BasicType t) {
537 if (_is_return) {
538 check_return_type(t);
539 return;
540 }
541 check_value(false);
542 }
543
544 void check_double(BasicType t) { check_long(t); }
545
546 void check_long(BasicType t) {
547 if (_is_return) {
548 check_return_type(t);
549 return;
550 }
551
552 check_value(false);
553 check_value(false);
554 }
555
556 void check_obj(BasicType t) {
557 if (_is_return) {
558 check_return_type(t);
559 return;
560 }
561
562 intptr_t v = _value[_pos];
563 if (v != 0) {
564 // v is a "handle" referring to an oop, cast to integral type.
565 // There shouldn't be any handles in very low memory.
566 guarantee((size_t)v >= (size_t)os::vm_page_size(),
567 "Bad JNI oop argument %d: " PTR_FORMAT, _pos, v);
568 // Verify the pointee.
569 oop vv = resolve_indirect_oop(v, _value_state[_pos]);
570 guarantee(vv->is_oop_or_null(true),
571 "Bad JNI oop argument %d: " PTR_FORMAT " -> " PTR_FORMAT,
572 _pos, v, p2i(vv));
573 }
574
575 check_value(true); // Verify value state.
576 }
577
578 void do_bool() { check_int(T_BOOLEAN); }
579 void do_char() { check_int(T_CHAR); }
580 void do_float() { check_int(T_FLOAT); }
581 void do_double() { check_double(T_DOUBLE); }
582 void do_byte() { check_int(T_BYTE); }
583 void do_short() { check_int(T_SHORT); }
584 void do_int() { check_int(T_INT); }
585 void do_long() { check_long(T_LONG); }
586 void do_void() { check_return_type(T_VOID); }
587 void do_object(int begin, int end) { check_obj(T_OBJECT); }
588 void do_array(int begin, int end) { check_obj(T_OBJECT); }
589 };
590
591
592 void JavaCallArguments::verify(const methodHandle& method, BasicType return_type) {
593 guarantee(method->size_of_parameters() == size_of_parameters(), "wrong no. of arguments pushed");
594
595 // Treat T_OBJECT and T_ARRAY as the same
596 if (return_type == T_ARRAY) return_type = T_OBJECT;
597
598 // Check that oop information is correct
599 Symbol* signature = method->signature();
600
601 SignatureChekker sc(signature,
602 return_type,
603 method->is_static(),
604 _value_state,
605 _value);
606 sc.iterate_parameters();
607 sc.check_doing_return(true);
608 sc.iterate_returntype();
609 }