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