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