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.hpp" 33 #include "oops/method.inline.hpp" 34 #include "oops/oop.inline.hpp" 35 #include "prims/jniCheck.hpp" 36 #include "runtime/compilationPolicy.hpp" 37 #include "runtime/handles.inline.hpp" 38 #include "runtime/interfaceSupport.hpp" 39 #include "runtime/javaCalls.hpp" 40 #include "runtime/jniHandles.inline.hpp" 41 #include "runtime/mutexLocker.hpp" 42 #include "runtime/os.inline.hpp" 43 #include "runtime/signature.hpp" 44 #include "runtime/stubRoutines.hpp" 45 #include "runtime/thread.inline.hpp" 46 #if INCLUDE_JVMCI 47 #include "jvmci/jvmciJavaClasses.hpp" 48 #include "jvmci/jvmciRuntime.hpp" 49 #endif 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 = 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); // One oop argument 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); // One oop argument 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); // One oop argument 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 = 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); // One oop argument 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); // One oop argument 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); // One oop argument 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 = 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; // No argument 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); // One oop argument 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; // One oop argument 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; // One oop argument 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 // ------------------------------------------------- 300 // Implementation of JavaCalls (low level) 301 302 303 void JavaCalls::call(JavaValue* result, const methodHandle& method, JavaCallArguments* args, TRAPS) { 304 // Check if we need to wrap a potential OS exception handler around thread 305 // This is used for e.g. Win32 structured exception handlers 306 assert(THREAD->is_Java_thread(), "only JavaThreads can make JavaCalls"); 307 // Need to wrap each and every time, since there might be native code down the 308 // stack that has installed its own exception handlers 309 os::os_exception_wrapper(call_helper, result, method, args, THREAD); 310 } 311 312 void JavaCalls::call_helper(JavaValue* result, const methodHandle& method, JavaCallArguments* args, TRAPS) { 313 314 JavaThread* thread = (JavaThread*)THREAD; 315 assert(thread->is_Java_thread(), "must be called by a java thread"); 316 assert(method.not_null(), "must have a method to call"); 317 assert(!SafepointSynchronize::is_at_safepoint(), "call to Java code during VM operation"); 318 assert(!thread->handle_area()->no_handle_mark_active(), "cannot call out to Java here"); 319 320 321 CHECK_UNHANDLED_OOPS_ONLY(thread->clear_unhandled_oops();) 322 323 #if INCLUDE_JVMCI 324 // Gets the nmethod (if any) that should be called instead of normal target 325 nmethod* alternative_target = args->alternative_target(); 326 if (alternative_target == NULL) { 327 #endif 328 // Verify the arguments 329 330 if (CheckJNICalls) { 331 args->verify(method, result->get_type()); 332 } 333 else debug_only(args->verify(method, result->get_type())); 334 #if INCLUDE_JVMCI 335 } 336 #else 337 338 // Ignore call if method is empty 339 if (method->is_empty_method()) { 340 assert(result->get_type() == T_VOID, "an empty method must return a void value"); 341 return; 342 } 343 #endif 344 345 #ifdef ASSERT 346 { InstanceKlass* holder = method->method_holder(); 347 // A klass might not be initialized since JavaCall's might be used during the executing of 348 // the <clinit>. For example, a Thread.start might start executing on an object that is 349 // not fully initialized! (bad Java programming style) 350 assert(holder->is_linked(), "rewriting must have taken place"); 351 } 352 #endif 353 354 CompilationPolicy::compile_if_required(method, CHECK); 355 356 // Since the call stub sets up like the interpreter we call the from_interpreted_entry 357 // so we can go compiled via a i2c. Otherwise initial entry method will always 358 // run interpreted. 359 address entry_point = method->from_interpreted_entry(); 360 if (JvmtiExport::can_post_interpreter_events() && thread->is_interp_only_mode()) { 361 entry_point = method->interpreter_entry(); 362 } 363 364 // Figure out if the result value is an oop or not (Note: This is a different value 365 // than result_type. result_type will be T_INT of oops. (it is about size) 366 BasicType result_type = runtime_type_from(result); 367 bool oop_result_flag = (result->get_type() == T_OBJECT || result->get_type() == T_ARRAY); 368 369 // NOTE: if we move the computation of the result_val_address inside 370 // the call to call_stub, the optimizer produces wrong code. 371 intptr_t* result_val_address = (intptr_t*)(result->get_value_addr()); 372 373 // Find receiver 374 Handle receiver = (!method->is_static()) ? args->receiver() : Handle(); 375 376 // When we reenter Java, we need to reenable the reserved/yellow zone which 377 // might already be disabled when we are in VM. 378 if (!thread->stack_guards_enabled()) { 379 thread->reguard_stack(); 380 } 381 382 // Check that there are shadow pages available before changing thread state 383 // to Java. Calculate current_stack_pointer here to make sure 384 // stack_shadow_pages_available() and bang_stack_shadow_pages() use the same sp. 385 address sp = os::current_stack_pointer(); 386 if (!os::stack_shadow_pages_available(THREAD, method, sp)) { 387 // Throw stack overflow exception with preinitialized exception. 388 Exceptions::throw_stack_overflow_exception(THREAD, __FILE__, __LINE__, method); 389 return; 390 } else { 391 // Touch pages checked if the OS needs them to be touched to be mapped. 392 os::map_stack_shadow_pages(sp); 393 } 394 395 #if INCLUDE_JVMCI 396 if (alternative_target != NULL) { 397 if (alternative_target->is_alive()) { 398 thread->set_jvmci_alternate_call_target(alternative_target->verified_entry_point()); 399 entry_point = method->adapter()->get_i2c_entry(); 400 } else { 401 THROW(vmSymbols::jdk_vm_ci_code_InvalidInstalledCodeException()); 402 } 403 } 404 #endif 405 406 // do call 407 { JavaCallWrapper link(method, receiver, result, CHECK); 408 { HandleMark hm(thread); // HandleMark used by HandleMarkCleaner 409 410 StubRoutines::call_stub()( 411 (address)&link, 412 // (intptr_t*)&(result->_value), // see NOTE above (compiler problem) 413 result_val_address, // see NOTE above (compiler problem) 414 result_type, 415 method(), 416 entry_point, 417 args->parameters(), 418 args->size_of_parameters(), 419 CHECK 420 ); 421 422 result = link.result(); // circumvent MS C++ 5.0 compiler bug (result is clobbered across call) 423 // Preserve oop return value across possible gc points 424 if (oop_result_flag) { 425 thread->set_vm_result((oop) result->get_jobject()); 426 } 427 } 428 } // Exit JavaCallWrapper (can block - potential return oop must be preserved) 429 430 // Check if a thread stop or suspend should be executed 431 // The following assert was not realistic. Thread.stop can set that bit at any moment. 432 //assert(!thread->has_special_runtime_exit_condition(), "no async. exceptions should be installed"); 433 434 // Restore possible oop return 435 if (oop_result_flag) { 436 result->set_jobject((jobject)thread->vm_result()); 437 thread->set_vm_result(NULL); 438 } 439 } 440 441 442 //-------------------------------------------------------------------------------------- 443 // Implementation of JavaCallArguments 444 445 inline bool is_value_state_indirect_oop(uint state) { 446 assert(state != JavaCallArguments::value_state_oop, 447 "Checking for handles after removal"); 448 assert(state < JavaCallArguments::value_state_limit, 449 "Invalid value state %u", state); 450 return state != JavaCallArguments::value_state_primitive; 451 } 452 453 inline oop resolve_indirect_oop(intptr_t value, uint state) { 454 switch (state) { 455 case JavaCallArguments::value_state_handle: 456 { 457 oop* ptr = reinterpret_cast<oop*>(value); 458 return Handle::raw_resolve(ptr); 459 } 460 461 case JavaCallArguments::value_state_jobject: 462 { 463 jobject obj = reinterpret_cast<jobject>(value); 464 return JNIHandles::resolve(obj); 465 } 466 467 default: 468 ShouldNotReachHere(); 469 return NULL; 470 } 471 } 472 473 intptr_t* JavaCallArguments::parameters() { 474 // First convert all handles to oops 475 for(int i = 0; i < _size; i++) { 476 uint state = _value_state[i]; 477 assert(state != value_state_oop, "Multiple handle conversions"); 478 if (is_value_state_indirect_oop(state)) { 479 oop obj = resolve_indirect_oop(_value[i], state); 480 _value[i] = cast_from_oop<intptr_t>(obj); 481 _value_state[i] = value_state_oop; 482 } 483 } 484 // Return argument vector 485 return _value; 486 } 487 488 489 class SignatureChekker : public SignatureIterator { 490 private: 491 int _pos; 492 BasicType _return_type; 493 u_char* _value_state; 494 intptr_t* _value; 495 496 public: 497 bool _is_return; 498 499 SignatureChekker(Symbol* signature, 500 BasicType return_type, 501 bool is_static, 502 u_char* value_state, 503 intptr_t* value) : 504 SignatureIterator(signature), 505 _pos(0), 506 _return_type(return_type), 507 _value_state(value_state), 508 _value(value), 509 _is_return(false) 510 { 511 if (!is_static) { 512 check_value(true); // Receiver must be an oop 513 } 514 } 515 516 void check_value(bool type) { 517 uint state = _value_state[_pos++]; 518 if (type) { 519 guarantee(is_value_state_indirect_oop(state), 520 "signature does not match pushed arguments: %u at %d", 521 state, _pos - 1); 522 } else { 523 guarantee(state == JavaCallArguments::value_state_primitive, 524 "signature does not match pushed arguments: %u at %d", 525 state, _pos - 1); 526 } 527 } 528 529 void check_doing_return(bool state) { _is_return = state; } 530 531 void check_return_type(BasicType t) { 532 guarantee(_is_return && t == _return_type, "return type does not match"); 533 } 534 535 void check_int(BasicType t) { 536 if (_is_return) { 537 check_return_type(t); 538 return; 539 } 540 check_value(false); 541 } 542 543 void check_double(BasicType t) { check_long(t); } 544 545 void check_long(BasicType t) { 546 if (_is_return) { 547 check_return_type(t); 548 return; 549 } 550 551 check_value(false); 552 check_value(false); 553 } 554 555 void check_obj(BasicType t) { 556 if (_is_return) { 557 check_return_type(t); 558 return; 559 } 560 561 intptr_t v = _value[_pos]; 562 if (v != 0) { 563 // v is a "handle" referring to an oop, cast to integral type. 564 // There shouldn't be any handles in very low memory. 565 guarantee((size_t)v >= (size_t)os::vm_page_size(), 566 "Bad JNI oop argument %d: " PTR_FORMAT, _pos, v); 567 // Verify the pointee. 568 oop vv = resolve_indirect_oop(v, _value_state[_pos]); 569 guarantee(oopDesc::is_oop_or_null(vv, true), 570 "Bad JNI oop argument %d: " PTR_FORMAT " -> " PTR_FORMAT, 571 _pos, v, p2i(vv)); 572 } 573 574 check_value(true); // Verify value state. 575 } 576 577 void do_bool() { check_int(T_BOOLEAN); } 578 void do_char() { check_int(T_CHAR); } 579 void do_float() { check_int(T_FLOAT); } 580 void do_double() { check_double(T_DOUBLE); } 581 void do_byte() { check_int(T_BYTE); } 582 void do_short() { check_int(T_SHORT); } 583 void do_int() { check_int(T_INT); } 584 void do_long() { check_long(T_LONG); } 585 void do_void() { check_return_type(T_VOID); } 586 void do_object(int begin, int end) { check_obj(T_OBJECT); } 587 void do_array(int begin, int end) { check_obj(T_OBJECT); } 588 }; 589 590 591 void JavaCallArguments::verify(const methodHandle& method, BasicType return_type) { 592 guarantee(method->size_of_parameters() == size_of_parameters(), "wrong no. of arguments pushed"); 593 594 // Treat T_OBJECT and T_ARRAY as the same 595 if (return_type == T_ARRAY) return_type = T_OBJECT; 596 597 // Check that oop information is correct 598 Symbol* signature = method->signature(); 599 600 SignatureChekker sc(signature, 601 return_type, 602 method->is_static(), 603 _value_state, 604 _value); 605 sc.iterate_parameters(); 606 sc.check_doing_return(true); 607 sc.iterate_returntype(); 608 }