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 "oops/valueKlass.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/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 if (!VTBuffer::is_in_vt_buffer(_receiver)) { 152 f->do_oop((oop*)&_receiver); 153 } else { 154 assert(_receiver->is_value(), "Sanity check"); 155 BufferedValuesDealiaser* dealiaser = Thread::current()->buffered_values_dealiaser(); 156 assert(dealiaser != NULL, "Sanity check"); 157 dealiaser->oops_do(f, _receiver); 158 } 159 handles()->oops_do(f); 160 } 161 162 163 // Helper methods 164 static BasicType runtime_type_from(JavaValue* result) { 165 switch (result->get_type()) { 166 case T_BOOLEAN: // fall through 167 case T_CHAR : // fall through 168 case T_SHORT : // fall through 169 case T_INT : // fall through 170 #ifndef _LP64 171 case T_OBJECT : // fall through 172 case T_ARRAY : // fall through 173 #endif 174 case T_BYTE : // fall through 175 case T_VOID : return T_INT; 176 case T_LONG : return T_LONG; 177 case T_FLOAT : return T_FLOAT; 178 case T_DOUBLE : return T_DOUBLE; 179 #ifdef _LP64 180 case T_ARRAY : // fall through 181 case T_OBJECT: return T_OBJECT; 182 #endif 183 default: 184 ShouldNotReachHere(); 185 return T_ILLEGAL; 186 } 187 } 188 189 // ============ Virtual calls ============ 190 191 void JavaCalls::call_virtual(JavaValue* result, Klass* spec_klass, Symbol* name, Symbol* signature, JavaCallArguments* args, TRAPS) { 192 CallInfo callinfo; 193 Handle receiver = args->receiver(); 194 Klass* recvrKlass = receiver.is_null() ? (Klass*)NULL : receiver->klass(); 195 LinkInfo link_info(spec_klass, name, signature); 196 LinkResolver::resolve_virtual_call( 197 callinfo, receiver, recvrKlass, link_info, true, CHECK); 198 methodHandle method = callinfo.selected_method(); 199 assert(method.not_null(), "should have thrown exception"); 200 201 // Invoke the method 202 JavaCalls::call(result, method, args, CHECK); 203 } 204 205 206 void JavaCalls::call_virtual(JavaValue* result, Handle receiver, Klass* spec_klass, Symbol* name, Symbol* signature, TRAPS) { 207 JavaCallArguments args(receiver); // One oop argument 208 call_virtual(result, spec_klass, name, signature, &args, CHECK); 209 } 210 211 212 void JavaCalls::call_virtual(JavaValue* result, Handle receiver, Klass* spec_klass, Symbol* name, Symbol* signature, Handle arg1, TRAPS) { 213 JavaCallArguments args(receiver); // One oop argument 214 args.push_oop(arg1); 215 call_virtual(result, spec_klass, name, signature, &args, CHECK); 216 } 217 218 219 220 void JavaCalls::call_virtual(JavaValue* result, Handle receiver, Klass* spec_klass, Symbol* name, Symbol* signature, Handle arg1, Handle arg2, TRAPS) { 221 JavaCallArguments args(receiver); // One oop argument 222 args.push_oop(arg1); 223 args.push_oop(arg2); 224 call_virtual(result, spec_klass, name, signature, &args, CHECK); 225 } 226 227 228 // ============ Special calls ============ 229 230 void JavaCalls::call_special(JavaValue* result, Klass* klass, Symbol* name, Symbol* signature, JavaCallArguments* args, TRAPS) { 231 CallInfo callinfo; 232 LinkInfo link_info(klass, name, signature); 233 LinkResolver::resolve_special_call(callinfo, args->receiver(), link_info, CHECK); 234 methodHandle method = callinfo.selected_method(); 235 assert(method.not_null(), "should have thrown exception"); 236 237 // Invoke the method 238 JavaCalls::call(result, method, args, CHECK); 239 } 240 241 242 void JavaCalls::call_special(JavaValue* result, Handle receiver, Klass* klass, Symbol* name, Symbol* signature, TRAPS) { 243 JavaCallArguments args(receiver); // One oop argument 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, TRAPS) { 249 JavaCallArguments args(receiver); // One oop argument 250 args.push_oop(arg1); 251 call_special(result, klass, name, signature, &args, CHECK); 252 } 253 254 255 void JavaCalls::call_special(JavaValue* result, Handle receiver, Klass* klass, Symbol* name, Symbol* signature, Handle arg1, Handle arg2, TRAPS) { 256 JavaCallArguments args(receiver); // One oop argument 257 args.push_oop(arg1); 258 args.push_oop(arg2); 259 call_special(result, klass, name, signature, &args, CHECK); 260 } 261 262 263 // ============ Static calls ============ 264 265 void JavaCalls::call_static(JavaValue* result, Klass* klass, Symbol* name, Symbol* signature, JavaCallArguments* args, TRAPS) { 266 CallInfo callinfo; 267 LinkInfo link_info(klass, name, signature); 268 LinkResolver::resolve_static_call(callinfo, link_info, true, CHECK); 269 methodHandle method = callinfo.selected_method(); 270 assert(method.not_null(), "should have thrown exception"); 271 272 // Invoke the method 273 JavaCalls::call(result, method, args, CHECK); 274 } 275 276 277 void JavaCalls::call_static(JavaValue* result, Klass* klass, Symbol* name, Symbol* signature, TRAPS) { 278 JavaCallArguments args; // No 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, TRAPS) { 284 JavaCallArguments args(arg1); // One oop argument 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, TRAPS) { 290 JavaCallArguments args; // One oop argument 291 args.push_oop(arg1); 292 args.push_oop(arg2); 293 call_static(result, klass, name, signature, &args, CHECK); 294 } 295 296 297 void JavaCalls::call_static(JavaValue* result, Klass* klass, Symbol* name, Symbol* signature, Handle arg1, Handle arg2, Handle arg3, TRAPS) { 298 JavaCallArguments args; // One oop argument 299 args.push_oop(arg1); 300 args.push_oop(arg2); 301 args.push_oop(arg3); 302 call_static(result, klass, name, signature, &args, CHECK); 303 } 304 305 // ------------------------------------------------- 306 // Implementation of JavaCalls (low level) 307 308 309 void JavaCalls::call(JavaValue* result, const methodHandle& method, JavaCallArguments* args, TRAPS) { 310 // Check if we need to wrap a potential OS exception handler around thread 311 // This is used for e.g. Win32 structured exception handlers 312 assert(THREAD->is_Java_thread(), "only JavaThreads can make JavaCalls"); 313 // Need to wrap each and every time, since there might be native code down the 314 // stack that has installed its own exception handlers 315 os::os_exception_wrapper(call_helper, result, method, args, THREAD); 316 } 317 318 void JavaCalls::call_helper(JavaValue* result, const methodHandle& method, JavaCallArguments* args, TRAPS) { 319 320 JavaThread* thread = (JavaThread*)THREAD; 321 assert(thread->is_Java_thread(), "must be called by a java thread"); 322 assert(method.not_null(), "must have a method to call"); 323 assert(!SafepointSynchronize::is_at_safepoint(), "call to Java code during VM operation"); 324 assert(!thread->handle_area()->no_handle_mark_active(), "cannot call out to Java here"); 325 326 327 CHECK_UNHANDLED_OOPS_ONLY(thread->clear_unhandled_oops();) 328 329 #if INCLUDE_JVMCI 330 // Gets the nmethod (if any) that should be called instead of normal target 331 nmethod* alternative_target = args->alternative_target(); 332 if (alternative_target == NULL) { 333 #endif 334 // Verify the arguments 335 336 if (CheckJNICalls) { 337 args->verify(method, result->get_type()); 338 } 339 else debug_only(args->verify(method, result->get_type())); 340 #if INCLUDE_JVMCI 341 } 342 #else 343 344 // Ignore call if method is empty 345 if (method->is_empty_method()) { 346 assert(result->get_type() == T_VOID, "an empty method must return a void value"); 347 return; 348 } 349 #endif 350 351 #ifdef ASSERT 352 { InstanceKlass* holder = method->method_holder(); 353 // A klass might not be initialized since JavaCall's might be used during the executing of 354 // the <clinit>. For example, a Thread.start might start executing on an object that is 355 // not fully initialized! (bad Java programming style) 356 assert(holder->is_linked(), "rewriting must have taken place"); 357 } 358 #endif 359 360 CompilationPolicy::compile_if_required(method, CHECK); 361 362 // Since the call stub sets up like the interpreter we call the from_interpreted_entry 363 // so we can go compiled via a i2c. Otherwise initial entry method will always 364 // run interpreted. 365 address entry_point = method->from_interpreted_entry(); 366 if (JvmtiExport::can_post_interpreter_events() && thread->is_interp_only_mode()) { 367 entry_point = method->interpreter_entry(); 368 } 369 370 // Figure out if the result value is an oop or not (Note: This is a different value 371 // than result_type. result_type will be T_INT of oops. (it is about size) 372 BasicType result_type = runtime_type_from(result); 373 bool oop_result_flag = (result->get_type() == T_OBJECT || result->get_type() == T_ARRAY); 374 375 // NOTE: if we move the computation of the result_val_address inside 376 // the call to call_stub, the optimizer produces wrong code. 377 intptr_t* result_val_address = (intptr_t*)(result->get_value_addr()); 378 379 // Find receiver 380 Handle receiver = (!method->is_static()) ? args->receiver() : Handle(); 381 382 // When we reenter Java, we need to reenable the reserved/yellow zone which 383 // might already be disabled when we are in VM. 384 if (!thread->stack_guards_enabled()) { 385 thread->reguard_stack(); 386 } 387 388 // Check that there are shadow pages available before changing thread state 389 // to Java. Calculate current_stack_pointer here to make sure 390 // stack_shadow_pages_available() and bang_stack_shadow_pages() use the same sp. 391 address sp = os::current_stack_pointer(); 392 if (!os::stack_shadow_pages_available(THREAD, method, sp)) { 393 // Throw stack overflow exception with preinitialized exception. 394 Exceptions::throw_stack_overflow_exception(THREAD, __FILE__, __LINE__, method); 395 return; 396 } else { 397 // Touch pages checked if the OS needs them to be touched to be mapped. 398 os::map_stack_shadow_pages(sp); 399 } 400 401 #if INCLUDE_JVMCI 402 if (alternative_target != NULL) { 403 if (alternative_target->is_alive()) { 404 thread->set_jvmci_alternate_call_target(alternative_target->verified_entry_point()); 405 entry_point = method->adapter()->get_i2c_entry(); 406 } else { 407 THROW(vmSymbols::jdk_vm_ci_code_InvalidInstalledCodeException()); 408 } 409 } 410 #endif 411 412 // do call 413 { JavaCallWrapper link(method, receiver, result, CHECK); 414 { HandleMark hm(thread); // HandleMark used by HandleMarkCleaner 415 416 StubRoutines::call_stub()( 417 (address)&link, 418 // (intptr_t*)&(result->_value), // see NOTE above (compiler problem) 419 result_val_address, // see NOTE above (compiler problem) 420 result_type, 421 method(), 422 entry_point, 423 args->parameters(), 424 args->size_of_parameters(), 425 CHECK 426 ); 427 428 result = link.result(); // circumvent MS C++ 5.0 compiler bug (result is clobbered across call) 429 // Preserve oop return value across possible gc points 430 if (oop_result_flag) { 431 thread->set_vm_result((oop) result->get_jobject()); 432 } 433 } 434 } // Exit JavaCallWrapper (can block - potential return oop must be preserved) 435 436 // Check if a thread stop or suspend should be executed 437 // The following assert was not realistic. Thread.stop can set that bit at any moment. 438 //assert(!thread->has_special_runtime_exit_condition(), "no async. exceptions should be installed"); 439 440 // Restore possible oop return 441 if (oop_result_flag) { 442 result->set_jobject((jobject)thread->vm_result()); 443 thread->set_vm_result(NULL); 444 } 445 } 446 447 448 //-------------------------------------------------------------------------------------- 449 // Implementation of JavaCallArguments 450 451 inline bool is_value_state_indirect_oop(uint state) { 452 assert(state != JavaCallArguments::value_state_oop, 453 "Checking for handles after removal"); 454 assert(state < JavaCallArguments::value_state_limit, 455 "Invalid value state %u", state); 456 return state != JavaCallArguments::value_state_primitive; 457 } 458 459 inline oop resolve_indirect_oop(intptr_t value, uint state) { 460 switch (state) { 461 case JavaCallArguments::value_state_handle: 462 { 463 oop* ptr = reinterpret_cast<oop*>(value); 464 return Handle::raw_resolve(ptr); 465 } 466 467 case JavaCallArguments::value_state_jobject: 468 { 469 jobject obj = reinterpret_cast<jobject>(value); 470 return JNIHandles::resolve(obj); 471 } 472 473 default: 474 ShouldNotReachHere(); 475 return NULL; 476 } 477 } 478 479 intptr_t* JavaCallArguments::parameters() { 480 // First convert all handles to oops 481 for(int i = 0; i < _size; i++) { 482 uint state = _value_state[i]; 483 assert(state != value_state_oop, "Multiple handle conversions"); 484 if (is_value_state_indirect_oop(state)) { 485 oop obj = resolve_indirect_oop(_value[i], state); 486 _value[i] = cast_from_oop<intptr_t>(obj); 487 _value_state[i] = value_state_oop; 488 } 489 } 490 // Return argument vector 491 return _value; 492 } 493 494 495 class SignatureChekker : public SignatureIterator { 496 private: 497 int _pos; 498 BasicType _return_type; 499 u_char* _value_state; 500 intptr_t* _value; 501 502 public: 503 bool _is_return; 504 505 SignatureChekker(Symbol* signature, 506 BasicType return_type, 507 bool is_static, 508 u_char* value_state, 509 intptr_t* value) : 510 SignatureIterator(signature), 511 _pos(0), 512 _return_type(return_type), 513 _value_state(value_state), 514 _value(value), 515 _is_return(false) 516 { 517 if (!is_static) { 518 check_value(true); // Receiver must be an oop 519 } 520 } 521 522 void check_value(bool type) { 523 uint state = _value_state[_pos++]; 524 if (type) { 525 guarantee(is_value_state_indirect_oop(state), 526 "signature does not match pushed arguments: %u at %d", 527 state, _pos - 1); 528 } else { 529 guarantee(state == JavaCallArguments::value_state_primitive, 530 "signature does not match pushed arguments: %u at %d", 531 state, _pos - 1); 532 } 533 } 534 535 void check_doing_return(bool state) { _is_return = state; } 536 537 void check_return_type(BasicType t) { 538 guarantee(_is_return && t == _return_type, "return type does not match"); 539 } 540 541 void check_int(BasicType t) { 542 if (_is_return) { 543 check_return_type(t); 544 return; 545 } 546 check_value(false); 547 } 548 549 void check_double(BasicType t) { check_long(t); } 550 551 void check_long(BasicType t) { 552 if (_is_return) { 553 check_return_type(t); 554 return; 555 } 556 557 check_value(false); 558 check_value(false); 559 } 560 561 void check_obj(BasicType t) { 562 if (_is_return) { 563 check_return_type(t); 564 return; 565 } 566 567 intptr_t v = _value[_pos]; 568 if (v != 0) { 569 // v is a "handle" referring to an oop, cast to integral type. 570 // There shouldn't be any handles in very low memory. 571 guarantee((size_t)v >= (size_t)os::vm_page_size(), 572 "Bad JNI oop argument %d: " PTR_FORMAT, _pos, v); 573 // Verify the pointee. 574 oop vv = resolve_indirect_oop(v, _value_state[_pos]); 575 guarantee(oopDesc::is_oop_or_null(vv, true), 576 "Bad JNI oop argument %d: " PTR_FORMAT " -> " PTR_FORMAT, 577 _pos, v, p2i(vv)); 578 } 579 580 check_value(true); // Verify value state. 581 } 582 583 void do_bool() { check_int(T_BOOLEAN); } 584 void do_char() { check_int(T_CHAR); } 585 void do_float() { check_int(T_FLOAT); } 586 void do_double() { check_double(T_DOUBLE); } 587 void do_byte() { check_int(T_BYTE); } 588 void do_short() { check_int(T_SHORT); } 589 void do_int() { check_int(T_INT); } 590 void do_long() { check_long(T_LONG); } 591 void do_void() { check_return_type(T_VOID); } 592 void do_object(int begin, int end) { check_obj(T_OBJECT); } 593 void do_valuetype(int begin, int end){ check_obj(T_VALUETYPE); } 594 void do_array(int begin, int end) { check_obj(T_OBJECT); } 595 }; 596 597 598 void JavaCallArguments::verify(const methodHandle& method, BasicType return_type) { 599 guarantee(method->size_of_parameters() == size_of_parameters(), "wrong no. of arguments pushed"); 600 601 // Treat T_OBJECT and T_ARRAY as the same 602 if (return_type == T_ARRAY) return_type = T_OBJECT; 603 604 // Check that oop information is correct 605 Symbol* signature = method->signature(); 606 607 SignatureChekker sc(signature, 608 return_type, 609 method->is_static(), 610 _value_state, 611 _value); 612 sc.iterate_parameters(); 613 sc.check_doing_return(true); 614 sc.iterate_returntype(); 615 }