1 /*
   2  * Copyright (c) 1997, 2023, 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/javaClasses.inline.hpp"
  27 #include "classfile/symbolTable.hpp"
  28 #include "classfile/vmClasses.hpp"
  29 #include "classfile/vmSymbols.hpp"
  30 #include "code/codeCache.hpp"
  31 #include "compiler/compilationPolicy.hpp"
  32 #include "compiler/compileBroker.hpp"
  33 #include "compiler/disassembler.hpp"
  34 #include "gc/shared/barrierSetNMethod.hpp"
  35 #include "gc/shared/collectedHeap.hpp"
  36 #include "interpreter/bytecodeTracer.hpp"
  37 #include "interpreter/interpreter.hpp"
  38 #include "interpreter/interpreterRuntime.hpp"
  39 #include "interpreter/linkResolver.hpp"
  40 #include "interpreter/templateTable.hpp"
  41 #include "jvm_io.h"
  42 #include "logging/log.hpp"
  43 #include "memory/oopFactory.hpp"
  44 #include "memory/resourceArea.hpp"
  45 #include "memory/universe.hpp"
  46 #include "oops/constantPool.inline.hpp"
  47 #include "oops/cpCache.inline.hpp"
  48 #include "oops/instanceKlass.inline.hpp"
  49 #include "oops/klass.inline.hpp"
  50 #include "oops/methodData.hpp"
  51 #include "oops/method.inline.hpp"
  52 #include "oops/objArrayKlass.hpp"
  53 #include "oops/objArrayOop.inline.hpp"
  54 #include "oops/oop.inline.hpp"
  55 #include "oops/symbol.hpp"
  56 #include "prims/jvmtiExport.hpp"
  57 #include "prims/methodHandles.hpp"
  58 #include "prims/nativeLookup.hpp"
  59 #include "runtime/atomic.hpp"
  60 #include "runtime/continuation.hpp"
  61 #include "runtime/deoptimization.hpp"
  62 #include "runtime/fieldDescriptor.inline.hpp"
  63 #include "runtime/frame.inline.hpp"
  64 #include "runtime/handles.inline.hpp"
  65 #include "runtime/icache.hpp"
  66 #include "runtime/interfaceSupport.inline.hpp"
  67 #include "runtime/java.hpp"
  68 #include "runtime/javaCalls.hpp"
  69 #include "runtime/jfieldIDWorkaround.hpp"
  70 #include "runtime/osThread.hpp"
  71 #include "runtime/sharedRuntime.hpp"
  72 #include "runtime/stackWatermarkSet.hpp"
  73 #include "runtime/stubRoutines.hpp"
  74 #include "runtime/synchronizer.hpp"
  75 #include "runtime/threadCritical.hpp"
  76 #include "utilities/align.hpp"
  77 #include "utilities/checkedCast.hpp"
  78 #include "utilities/copy.hpp"
  79 #include "utilities/events.hpp"
  80 #ifdef COMPILER2
  81 #include "opto/runtime.hpp"
  82 #endif
  83 
  84 // Helper class to access current interpreter state
  85 class LastFrameAccessor : public StackObj {
  86   frame _last_frame;
  87 public:
  88   LastFrameAccessor(JavaThread* current) {
  89     assert(current == Thread::current(), "sanity");
  90     _last_frame = current->last_frame();
  91   }
  92   bool is_interpreted_frame() const              { return _last_frame.is_interpreted_frame(); }
  93   Method*   method() const                       { return _last_frame.interpreter_frame_method(); }
  94   address   bcp() const                          { return _last_frame.interpreter_frame_bcp(); }
  95   int       bci() const                          { return _last_frame.interpreter_frame_bci(); }
  96   address   mdp() const                          { return _last_frame.interpreter_frame_mdp(); }
  97 
  98   void      set_bcp(address bcp)                 { _last_frame.interpreter_frame_set_bcp(bcp); }
  99   void      set_mdp(address dp)                  { _last_frame.interpreter_frame_set_mdp(dp); }
 100 
 101   // pass method to avoid calling unsafe bcp_to_method (partial fix 4926272)
 102   Bytecodes::Code code() const                   { return Bytecodes::code_at(method(), bcp()); }
 103 
 104   Bytecode  bytecode() const                     { return Bytecode(method(), bcp()); }
 105   int get_index_u1(Bytecodes::Code bc) const     { return bytecode().get_index_u1(bc); }
 106   int get_index_u2(Bytecodes::Code bc) const     { return bytecode().get_index_u2(bc); }
 107   int get_index_u4(Bytecodes::Code bc) const     { return bytecode().get_index_u4(bc); }
 108   int number_of_dimensions() const               { return bcp()[3]; }
 109 
 110   oop callee_receiver(Symbol* signature) {
 111     return _last_frame.interpreter_callee_receiver(signature);
 112   }
 113   BasicObjectLock* monitor_begin() const {
 114     return _last_frame.interpreter_frame_monitor_begin();
 115   }
 116   BasicObjectLock* monitor_end() const {
 117     return _last_frame.interpreter_frame_monitor_end();
 118   }
 119   BasicObjectLock* next_monitor(BasicObjectLock* current) const {
 120     return _last_frame.next_monitor_in_interpreter_frame(current);
 121   }
 122 
 123   frame& get_frame()                             { return _last_frame; }
 124 };
 125 
 126 //------------------------------------------------------------------------------------------------------------------------
 127 // State accessors
 128 
 129 void InterpreterRuntime::set_bcp_and_mdp(address bcp, JavaThread* current) {
 130   LastFrameAccessor last_frame(current);
 131   last_frame.set_bcp(bcp);
 132   if (ProfileInterpreter) {
 133     // ProfileTraps uses MDOs independently of ProfileInterpreter.
 134     // That is why we must check both ProfileInterpreter and mdo != nullptr.
 135     MethodData* mdo = last_frame.method()->method_data();
 136     if (mdo != nullptr) {
 137       NEEDS_CLEANUP;
 138       last_frame.set_mdp(mdo->bci_to_dp(last_frame.bci()));
 139     }
 140   }
 141 }
 142 
 143 //------------------------------------------------------------------------------------------------------------------------
 144 // Constants
 145 
 146 
 147 JRT_ENTRY(void, InterpreterRuntime::ldc(JavaThread* current, bool wide))
 148   // access constant pool
 149   LastFrameAccessor last_frame(current);
 150   ConstantPool* pool = last_frame.method()->constants();
 151   int cp_index = wide ? last_frame.get_index_u2(Bytecodes::_ldc_w) : last_frame.get_index_u1(Bytecodes::_ldc);
 152   constantTag tag = pool->tag_at(cp_index);
 153 
 154   assert (tag.is_unresolved_klass() || tag.is_klass(), "wrong ldc call");
 155   Klass* klass = pool->klass_at(cp_index, CHECK);
 156   oop java_class = klass->java_mirror();
 157   current->set_vm_result(java_class);
 158 JRT_END
 159 
 160 JRT_ENTRY(void, InterpreterRuntime::resolve_ldc(JavaThread* current, Bytecodes::Code bytecode)) {
 161   assert(bytecode == Bytecodes::_ldc ||
 162          bytecode == Bytecodes::_ldc_w ||
 163          bytecode == Bytecodes::_ldc2_w ||
 164          bytecode == Bytecodes::_fast_aldc ||
 165          bytecode == Bytecodes::_fast_aldc_w, "wrong bc");
 166   ResourceMark rm(current);
 167   const bool is_fast_aldc = (bytecode == Bytecodes::_fast_aldc ||
 168                              bytecode == Bytecodes::_fast_aldc_w);
 169   LastFrameAccessor last_frame(current);
 170   methodHandle m (current, last_frame.method());
 171   Bytecode_loadconstant ldc(m, last_frame.bci());
 172 
 173   // Double-check the size.  (Condy can have any type.)
 174   BasicType type = ldc.result_type();
 175   switch (type2size[type]) {
 176   case 2: guarantee(bytecode == Bytecodes::_ldc2_w, ""); break;
 177   case 1: guarantee(bytecode != Bytecodes::_ldc2_w, ""); break;
 178   default: ShouldNotReachHere();
 179   }
 180 
 181   // Resolve the constant.  This does not do unboxing.
 182   // But it does replace Universe::the_null_sentinel by null.
 183   oop result = ldc.resolve_constant(CHECK);
 184   assert(result != nullptr || is_fast_aldc, "null result only valid for fast_aldc");
 185 
 186 #ifdef ASSERT
 187   {
 188     // The bytecode wrappers aren't GC-safe so construct a new one
 189     Bytecode_loadconstant ldc2(m, last_frame.bci());
 190     int rindex = ldc2.cache_index();
 191     if (rindex < 0)
 192       rindex = m->constants()->cp_to_object_index(ldc2.pool_index());
 193     if (rindex >= 0) {
 194       oop coop = m->constants()->resolved_reference_at(rindex);
 195       oop roop = (result == nullptr ? Universe::the_null_sentinel() : result);
 196       assert(roop == coop, "expected result for assembly code");
 197     }
 198   }
 199 #endif
 200   current->set_vm_result(result);
 201   if (!is_fast_aldc) {
 202     // Tell the interpreter how to unbox the primitive.
 203     guarantee(java_lang_boxing_object::is_instance(result, type), "");
 204     int offset = java_lang_boxing_object::value_offset(type);
 205     intptr_t flags = ((as_TosState(type) << ConstantPoolCache::tos_state_shift)
 206                       | (offset & ConstantPoolCache::field_index_mask));
 207     current->set_vm_result_2((Metadata*)flags);
 208   }
 209 }
 210 JRT_END
 211 
 212 
 213 //------------------------------------------------------------------------------------------------------------------------
 214 // Allocation
 215 
 216 JRT_ENTRY(void, InterpreterRuntime::_new(JavaThread* current, ConstantPool* pool, int index))
 217   Klass* k = pool->klass_at(index, CHECK);
 218   InstanceKlass* klass = InstanceKlass::cast(k);
 219 
 220   // Make sure we are not instantiating an abstract klass
 221   klass->check_valid_for_instantiation(true, CHECK);
 222 
 223   // Make sure klass is initialized
 224   klass->initialize(CHECK);
 225 
 226   // At this point the class may not be fully initialized
 227   // because of recursive initialization. If it is fully
 228   // initialized & has_finalized is not set, we rewrite
 229   // it into its fast version (Note: no locking is needed
 230   // here since this is an atomic byte write and can be
 231   // done more than once).
 232   //
 233   // Note: In case of classes with has_finalized we don't
 234   //       rewrite since that saves us an extra check in
 235   //       the fast version which then would call the
 236   //       slow version anyway (and do a call back into
 237   //       Java).
 238   //       If we have a breakpoint, then we don't rewrite
 239   //       because the _breakpoint bytecode would be lost.
 240   oop obj = klass->allocate_instance(CHECK);
 241   current->set_vm_result(obj);
 242 JRT_END
 243 
 244 
 245 JRT_ENTRY(void, InterpreterRuntime::newarray(JavaThread* current, BasicType type, jint size))
 246   oop obj = oopFactory::new_typeArray(type, size, CHECK);
 247   current->set_vm_result(obj);
 248 JRT_END
 249 
 250 
 251 JRT_ENTRY(void, InterpreterRuntime::anewarray(JavaThread* current, ConstantPool* pool, int index, jint size))
 252   Klass*    klass = pool->klass_at(index, CHECK);
 253   objArrayOop obj = oopFactory::new_objArray(klass, size, CHECK);
 254   current->set_vm_result(obj);
 255 JRT_END
 256 
 257 
 258 JRT_ENTRY(void, InterpreterRuntime::multianewarray(JavaThread* current, jint* first_size_address))
 259   // We may want to pass in more arguments - could make this slightly faster
 260   LastFrameAccessor last_frame(current);
 261   ConstantPool* constants = last_frame.method()->constants();
 262   int          i = last_frame.get_index_u2(Bytecodes::_multianewarray);
 263   Klass* klass   = constants->klass_at(i, CHECK);
 264   int   nof_dims = last_frame.number_of_dimensions();
 265   assert(klass->is_klass(), "not a class");
 266   assert(nof_dims >= 1, "multianewarray rank must be nonzero");
 267 
 268   // We must create an array of jints to pass to multi_allocate.
 269   ResourceMark rm(current);
 270   const int small_dims = 10;
 271   jint dim_array[small_dims];
 272   jint *dims = &dim_array[0];
 273   if (nof_dims > small_dims) {
 274     dims = (jint*) NEW_RESOURCE_ARRAY(jint, nof_dims);
 275   }
 276   for (int index = 0; index < nof_dims; index++) {
 277     // offset from first_size_address is addressed as local[index]
 278     int n = Interpreter::local_offset_in_bytes(index)/jintSize;
 279     dims[index] = first_size_address[n];
 280   }
 281   oop obj = ArrayKlass::cast(klass)->multi_allocate(nof_dims, dims, CHECK);
 282   current->set_vm_result(obj);
 283 JRT_END
 284 
 285 
 286 JRT_ENTRY(void, InterpreterRuntime::register_finalizer(JavaThread* current, oopDesc* obj))
 287   assert(oopDesc::is_oop(obj), "must be a valid oop");
 288   assert(obj->klass()->has_finalizer(), "shouldn't be here otherwise");
 289   InstanceKlass::register_finalizer(instanceOop(obj), CHECK);
 290 JRT_END
 291 
 292 
 293 // Quicken instance-of and check-cast bytecodes
 294 JRT_ENTRY(void, InterpreterRuntime::quicken_io_cc(JavaThread* current))
 295   // Force resolving; quicken the bytecode
 296   LastFrameAccessor last_frame(current);
 297   int which = last_frame.get_index_u2(Bytecodes::_checkcast);
 298   ConstantPool* cpool = last_frame.method()->constants();
 299   // We'd expect to assert that we're only here to quicken bytecodes, but in a multithreaded
 300   // program we might have seen an unquick'd bytecode in the interpreter but have another
 301   // thread quicken the bytecode before we get here.
 302   // assert( cpool->tag_at(which).is_unresolved_klass(), "should only come here to quicken bytecodes" );
 303   Klass* klass = cpool->klass_at(which, CHECK);
 304   current->set_vm_result_2(klass);
 305 JRT_END
 306 
 307 
 308 //------------------------------------------------------------------------------------------------------------------------
 309 // Exceptions
 310 
 311 void InterpreterRuntime::note_trap_inner(JavaThread* current, int reason,
 312                                          const methodHandle& trap_method, int trap_bci) {
 313   if (trap_method.not_null()) {
 314     MethodData* trap_mdo = trap_method->method_data();
 315     if (trap_mdo == nullptr) {
 316       ExceptionMark em(current);
 317       JavaThread* THREAD = current; // For exception macros.
 318       Method::build_profiling_method_data(trap_method, THREAD);
 319       if (HAS_PENDING_EXCEPTION) {
 320         // Only metaspace OOM is expected. No Java code executed.
 321         assert((PENDING_EXCEPTION->is_a(vmClasses::OutOfMemoryError_klass())),
 322                "we expect only an OOM error here");
 323         CLEAR_PENDING_EXCEPTION;
 324       }
 325       trap_mdo = trap_method->method_data();
 326       // and fall through...
 327     }
 328     if (trap_mdo != nullptr) {
 329       // Update per-method count of trap events.  The interpreter
 330       // is updating the MDO to simulate the effect of compiler traps.
 331       Deoptimization::update_method_data_from_interpreter(trap_mdo, trap_bci, reason);
 332     }
 333   }
 334 }
 335 
 336 // Assume the compiler is (or will be) interested in this event.
 337 // If necessary, create an MDO to hold the information, and record it.
 338 void InterpreterRuntime::note_trap(JavaThread* current, int reason) {
 339   assert(ProfileTraps, "call me only if profiling");
 340   LastFrameAccessor last_frame(current);
 341   methodHandle trap_method(current, last_frame.method());
 342   int trap_bci = trap_method->bci_from(last_frame.bcp());
 343   note_trap_inner(current, reason, trap_method, trap_bci);
 344 }
 345 
 346 static Handle get_preinitialized_exception(Klass* k, TRAPS) {
 347   // get klass
 348   InstanceKlass* klass = InstanceKlass::cast(k);
 349   assert(klass->is_initialized(),
 350          "this klass should have been initialized during VM initialization");
 351   // create instance - do not call constructor since we may have no
 352   // (java) stack space left (should assert constructor is empty)
 353   Handle exception;
 354   oop exception_oop = klass->allocate_instance(CHECK_(exception));
 355   exception = Handle(THREAD, exception_oop);
 356   if (StackTraceInThrowable) {
 357     java_lang_Throwable::fill_in_stack_trace(exception);
 358   }
 359   return exception;
 360 }
 361 
 362 // Special handling for stack overflow: since we don't have any (java) stack
 363 // space left we use the pre-allocated & pre-initialized StackOverflowError
 364 // klass to create an stack overflow error instance.  We do not call its
 365 // constructor for the same reason (it is empty, anyway).
 366 JRT_ENTRY(void, InterpreterRuntime::throw_StackOverflowError(JavaThread* current))
 367   Handle exception = get_preinitialized_exception(
 368                                  vmClasses::StackOverflowError_klass(),
 369                                  CHECK);
 370   // Increment counter for hs_err file reporting
 371   Atomic::inc(&Exceptions::_stack_overflow_errors);
 372   // Remove the ScopedValue bindings in case we got a StackOverflowError
 373   // while we were trying to manipulate ScopedValue bindings.
 374   current->clear_scopedValueBindings();
 375   THROW_HANDLE(exception);
 376 JRT_END
 377 
 378 JRT_ENTRY(void, InterpreterRuntime::throw_delayed_StackOverflowError(JavaThread* current))
 379   Handle exception = get_preinitialized_exception(
 380                                  vmClasses::StackOverflowError_klass(),
 381                                  CHECK);
 382   java_lang_Throwable::set_message(exception(),
 383           Universe::delayed_stack_overflow_error_message());
 384   // Increment counter for hs_err file reporting
 385   Atomic::inc(&Exceptions::_stack_overflow_errors);
 386   // Remove the ScopedValue bindings in case we got a StackOverflowError
 387   // while we were trying to manipulate ScopedValue bindings.
 388   current->clear_scopedValueBindings();
 389   THROW_HANDLE(exception);
 390 JRT_END
 391 
 392 JRT_ENTRY(void, InterpreterRuntime::create_exception(JavaThread* current, char* name, char* message))
 393   // lookup exception klass
 394   TempNewSymbol s = SymbolTable::new_symbol(name);
 395   if (ProfileTraps) {
 396     if (s == vmSymbols::java_lang_ArithmeticException()) {
 397       note_trap(current, Deoptimization::Reason_div0_check);
 398     } else if (s == vmSymbols::java_lang_NullPointerException()) {
 399       note_trap(current, Deoptimization::Reason_null_check);
 400     }
 401   }
 402   // create exception
 403   Handle exception = Exceptions::new_exception(current, s, message);
 404   current->set_vm_result(exception());
 405 JRT_END
 406 
 407 
 408 JRT_ENTRY(void, InterpreterRuntime::create_klass_exception(JavaThread* current, char* name, oopDesc* obj))
 409   // Produce the error message first because note_trap can safepoint
 410   ResourceMark rm(current);
 411   const char* klass_name = obj->klass()->external_name();
 412   // lookup exception klass
 413   TempNewSymbol s = SymbolTable::new_symbol(name);
 414   if (ProfileTraps) {
 415     if (s == vmSymbols::java_lang_ArrayStoreException()) {
 416       note_trap(current, Deoptimization::Reason_array_check);
 417     } else {
 418       note_trap(current, Deoptimization::Reason_class_check);
 419     }
 420   }
 421   // create exception, with klass name as detail message
 422   Handle exception = Exceptions::new_exception(current, s, klass_name);
 423   current->set_vm_result(exception());
 424 JRT_END
 425 
 426 JRT_ENTRY(void, InterpreterRuntime::throw_ArrayIndexOutOfBoundsException(JavaThread* current, arrayOopDesc* a, jint index))
 427   // Produce the error message first because note_trap can safepoint
 428   ResourceMark rm(current);
 429   stringStream ss;
 430   ss.print("Index %d out of bounds for length %d", index, a->length());
 431 
 432   if (ProfileTraps) {
 433     note_trap(current, Deoptimization::Reason_range_check);
 434   }
 435 
 436   THROW_MSG(vmSymbols::java_lang_ArrayIndexOutOfBoundsException(), ss.as_string());
 437 JRT_END
 438 
 439 JRT_ENTRY(void, InterpreterRuntime::throw_ClassCastException(
 440   JavaThread* current, oopDesc* obj))
 441 
 442   // Produce the error message first because note_trap can safepoint
 443   ResourceMark rm(current);
 444   char* message = SharedRuntime::generate_class_cast_message(
 445     current, obj->klass());
 446 
 447   if (ProfileTraps) {
 448     note_trap(current, Deoptimization::Reason_class_check);
 449   }
 450 
 451   // create exception
 452   THROW_MSG(vmSymbols::java_lang_ClassCastException(), message);
 453 JRT_END
 454 
 455 // exception_handler_for_exception(...) returns the continuation address,
 456 // the exception oop (via TLS) and sets the bci/bcp for the continuation.
 457 // The exception oop is returned to make sure it is preserved over GC (it
 458 // is only on the stack if the exception was thrown explicitly via athrow).
 459 // During this operation, the expression stack contains the values for the
 460 // bci where the exception happened. If the exception was propagated back
 461 // from a call, the expression stack contains the values for the bci at the
 462 // invoke w/o arguments (i.e., as if one were inside the call).
 463 JRT_ENTRY(address, InterpreterRuntime::exception_handler_for_exception(JavaThread* current, oopDesc* exception))
 464   // We get here after we have unwound from a callee throwing an exception
 465   // into the interpreter. Any deferred stack processing is notified of
 466   // the event via the StackWatermarkSet.
 467   StackWatermarkSet::after_unwind(current);
 468 
 469   LastFrameAccessor last_frame(current);
 470   Handle             h_exception(current, exception);
 471   methodHandle       h_method   (current, last_frame.method());
 472   constantPoolHandle h_constants(current, h_method->constants());
 473   bool               should_repeat;
 474   int                handler_bci;
 475   int                current_bci = last_frame.bci();
 476 
 477   if (current->frames_to_pop_failed_realloc() > 0) {
 478     // Allocation of scalar replaced object used in this frame
 479     // failed. Unconditionally pop the frame.
 480     current->dec_frames_to_pop_failed_realloc();
 481     current->set_vm_result(h_exception());
 482     // If the method is synchronized we already unlocked the monitor
 483     // during deoptimization so the interpreter needs to skip it when
 484     // the frame is popped.
 485     current->set_do_not_unlock_if_synchronized(true);
 486     return Interpreter::remove_activation_entry();
 487   }
 488 
 489   // Need to do this check first since when _do_not_unlock_if_synchronized
 490   // is set, we don't want to trigger any classloading which may make calls
 491   // into java, or surprisingly find a matching exception handler for bci 0
 492   // since at this moment the method hasn't been "officially" entered yet.
 493   if (current->do_not_unlock_if_synchronized()) {
 494     ResourceMark rm;
 495     assert(current_bci == 0,  "bci isn't zero for do_not_unlock_if_synchronized");
 496     current->set_vm_result(exception);
 497     return Interpreter::remove_activation_entry();
 498   }
 499 
 500   do {
 501     should_repeat = false;
 502 
 503     // assertions
 504     assert(h_exception.not_null(), "null exceptions should be handled by athrow");
 505     // Check that exception is a subclass of Throwable.
 506     assert(h_exception->is_a(vmClasses::Throwable_klass()),
 507            "Exception not subclass of Throwable");
 508 
 509     // tracing
 510     if (log_is_enabled(Info, exceptions)) {
 511       ResourceMark rm(current);
 512       stringStream tempst;
 513       tempst.print("interpreter method <%s>\n"
 514                    " at bci %d for thread " INTPTR_FORMAT " (%s)",
 515                    h_method->print_value_string(), current_bci, p2i(current), current->name());
 516       Exceptions::log_exception(h_exception, tempst.as_string());
 517     }
 518 // Don't go paging in something which won't be used.
 519 //     else if (extable->length() == 0) {
 520 //       // disabled for now - interpreter is not using shortcut yet
 521 //       // (shortcut is not to call runtime if we have no exception handlers)
 522 //       // warning("performance bug: should not call runtime if method has no exception handlers");
 523 //     }
 524     // for AbortVMOnException flag
 525     Exceptions::debug_check_abort(h_exception);
 526 
 527     // exception handler lookup
 528     Klass* klass = h_exception->klass();
 529     handler_bci = Method::fast_exception_handler_bci_for(h_method, klass, current_bci, THREAD);
 530     if (HAS_PENDING_EXCEPTION) {
 531       // We threw an exception while trying to find the exception handler.
 532       // Transfer the new exception to the exception handle which will
 533       // be set into thread local storage, and do another lookup for an
 534       // exception handler for this exception, this time starting at the
 535       // BCI of the exception handler which caused the exception to be
 536       // thrown (bug 4307310).
 537       h_exception = Handle(THREAD, PENDING_EXCEPTION);
 538       CLEAR_PENDING_EXCEPTION;
 539       if (handler_bci >= 0) {
 540         current_bci = handler_bci;
 541         should_repeat = true;
 542       }
 543     }
 544   } while (should_repeat == true);
 545 
 546 #if INCLUDE_JVMCI
 547   if (EnableJVMCI && h_method->method_data() != nullptr) {
 548     ResourceMark rm(current);
 549     ProfileData* pdata = h_method->method_data()->allocate_bci_to_data(current_bci, nullptr);
 550     if (pdata != nullptr && pdata->is_BitData()) {
 551       BitData* bit_data = (BitData*) pdata;
 552       bit_data->set_exception_seen();
 553     }
 554   }
 555 #endif
 556 
 557   // notify JVMTI of an exception throw; JVMTI will detect if this is a first
 558   // time throw or a stack unwinding throw and accordingly notify the debugger
 559   if (JvmtiExport::can_post_on_exceptions()) {
 560     JvmtiExport::post_exception_throw(current, h_method(), last_frame.bcp(), h_exception());
 561   }
 562 
 563   address continuation = nullptr;
 564   address handler_pc = nullptr;
 565   if (handler_bci < 0 || !current->stack_overflow_state()->reguard_stack((address) &continuation)) {
 566     // Forward exception to callee (leaving bci/bcp untouched) because (a) no
 567     // handler in this method, or (b) after a stack overflow there is not yet
 568     // enough stack space available to reprotect the stack.
 569     continuation = Interpreter::remove_activation_entry();
 570 #if COMPILER2_OR_JVMCI
 571     // Count this for compilation purposes
 572     h_method->interpreter_throwout_increment(THREAD);
 573 #endif
 574   } else {
 575     // handler in this method => change bci/bcp to handler bci/bcp and continue there
 576     handler_pc = h_method->code_base() + handler_bci;
 577 #ifndef ZERO
 578     set_bcp_and_mdp(handler_pc, current);
 579     continuation = Interpreter::dispatch_table(vtos)[*handler_pc];
 580 #else
 581     continuation = (address)(intptr_t) handler_bci;
 582 #endif
 583   }
 584 
 585   // notify debugger of an exception catch
 586   // (this is good for exceptions caught in native methods as well)
 587   if (JvmtiExport::can_post_on_exceptions()) {
 588     JvmtiExport::notice_unwind_due_to_exception(current, h_method(), handler_pc, h_exception(), (handler_pc != nullptr));
 589   }
 590 
 591   current->set_vm_result(h_exception());
 592   return continuation;
 593 JRT_END
 594 
 595 
 596 JRT_ENTRY(void, InterpreterRuntime::throw_pending_exception(JavaThread* current))
 597   assert(current->has_pending_exception(), "must only be called if there's an exception pending");
 598   // nothing to do - eventually we should remove this code entirely (see comments @ call sites)
 599 JRT_END
 600 
 601 
 602 JRT_ENTRY(void, InterpreterRuntime::throw_AbstractMethodError(JavaThread* current))
 603   THROW(vmSymbols::java_lang_AbstractMethodError());
 604 JRT_END
 605 
 606 // This method is called from the "abstract_entry" of the interpreter.
 607 // At that point, the arguments have already been removed from the stack
 608 // and therefore we don't have the receiver object at our fingertips. (Though,
 609 // on some platforms the receiver still resides in a register...). Thus,
 610 // we have no choice but print an error message not containing the receiver
 611 // type.
 612 JRT_ENTRY(void, InterpreterRuntime::throw_AbstractMethodErrorWithMethod(JavaThread* current,
 613                                                                         Method* missingMethod))
 614   ResourceMark rm(current);
 615   assert(missingMethod != nullptr, "sanity");
 616   methodHandle m(current, missingMethod);
 617   LinkResolver::throw_abstract_method_error(m, THREAD);
 618 JRT_END
 619 
 620 JRT_ENTRY(void, InterpreterRuntime::throw_AbstractMethodErrorVerbose(JavaThread* current,
 621                                                                      Klass* recvKlass,
 622                                                                      Method* missingMethod))
 623   ResourceMark rm(current);
 624   methodHandle mh = methodHandle(current, missingMethod);
 625   LinkResolver::throw_abstract_method_error(mh, recvKlass, THREAD);
 626 JRT_END
 627 
 628 
 629 JRT_ENTRY(void, InterpreterRuntime::throw_IncompatibleClassChangeError(JavaThread* current))
 630   THROW(vmSymbols::java_lang_IncompatibleClassChangeError());
 631 JRT_END
 632 
 633 JRT_ENTRY(void, InterpreterRuntime::throw_IncompatibleClassChangeErrorVerbose(JavaThread* current,
 634                                                                               Klass* recvKlass,
 635                                                                               Klass* interfaceKlass))
 636   ResourceMark rm(current);
 637   char buf[1000];
 638   buf[0] = '\0';
 639   jio_snprintf(buf, sizeof(buf),
 640                "Class %s does not implement the requested interface %s",
 641                recvKlass ? recvKlass->external_name() : "nullptr",
 642                interfaceKlass ? interfaceKlass->external_name() : "nullptr");
 643   THROW_MSG(vmSymbols::java_lang_IncompatibleClassChangeError(), buf);
 644 JRT_END
 645 
 646 JRT_ENTRY(void, InterpreterRuntime::throw_NullPointerException(JavaThread* current))
 647   THROW(vmSymbols::java_lang_NullPointerException());
 648 JRT_END
 649 
 650 //------------------------------------------------------------------------------------------------------------------------
 651 // Fields
 652 //
 653 
 654 void InterpreterRuntime::resolve_get_put(JavaThread* current, Bytecodes::Code bytecode) {
 655   // resolve field
 656   fieldDescriptor info;
 657   LastFrameAccessor last_frame(current);
 658   constantPoolHandle pool(current, last_frame.method()->constants());
 659   methodHandle m(current, last_frame.method());
 660   bool is_put    = (bytecode == Bytecodes::_putfield  || bytecode == Bytecodes::_nofast_putfield ||
 661                     bytecode == Bytecodes::_putstatic);
 662   bool is_static = (bytecode == Bytecodes::_getstatic || bytecode == Bytecodes::_putstatic);
 663 
 664   int field_index = last_frame.get_index_u2(bytecode);
 665   {
 666     JvmtiHideSingleStepping jhss(current);
 667     JavaThread* THREAD = current; // For exception macros.
 668     LinkResolver::resolve_field_access(info, pool, field_index,
 669                                        m, bytecode, CHECK);
 670   } // end JvmtiHideSingleStepping
 671 
 672   // check if link resolution caused cpCache to be updated
 673   if (pool->resolved_field_entry_at(field_index)->is_resolved(bytecode)) return;
 674 
 675 
 676   // compute auxiliary field attributes
 677   TosState state  = as_TosState(info.field_type());
 678 
 679   // Resolution of put instructions on final fields is delayed. That is required so that
 680   // exceptions are thrown at the correct place (when the instruction is actually invoked).
 681   // If we do not resolve an instruction in the current pass, leaving the put_code
 682   // set to zero will cause the next put instruction to the same field to reresolve.
 683 
 684   // Resolution of put instructions to final instance fields with invalid updates (i.e.,
 685   // to final instance fields with updates originating from a method different than <init>)
 686   // is inhibited. A putfield instruction targeting an instance final field must throw
 687   // an IllegalAccessError if the instruction is not in an instance
 688   // initializer method <init>. If resolution were not inhibited, a putfield
 689   // in an initializer method could be resolved in the initializer. Subsequent
 690   // putfield instructions to the same field would then use cached information.
 691   // As a result, those instructions would not pass through the VM. That is,
 692   // checks in resolve_field_access() would not be executed for those instructions
 693   // and the required IllegalAccessError would not be thrown.
 694   //
 695   // Also, we need to delay resolving getstatic and putstatic instructions until the
 696   // class is initialized.  This is required so that access to the static
 697   // field will call the initialization function every time until the class
 698   // is completely initialized ala. in 2.17.5 in JVM Specification.
 699   InstanceKlass* klass = info.field_holder();
 700   bool uninitialized_static = is_static && !klass->is_initialized();
 701   bool has_initialized_final_update = info.field_holder()->major_version() >= 53 &&
 702                                       info.has_initialized_final_update();
 703   assert(!(has_initialized_final_update && !info.access_flags().is_final()), "Fields with initialized final updates must be final");
 704 
 705   Bytecodes::Code get_code = (Bytecodes::Code)0;
 706   Bytecodes::Code put_code = (Bytecodes::Code)0;
 707   if (!uninitialized_static) {
 708     get_code = ((is_static) ? Bytecodes::_getstatic : Bytecodes::_getfield);
 709     if ((is_put && !has_initialized_final_update) || !info.access_flags().is_final()) {
 710       put_code = ((is_static) ? Bytecodes::_putstatic : Bytecodes::_putfield);
 711     }
 712   }
 713 
 714   ResolvedFieldEntry* entry = pool->resolved_field_entry_at(field_index);
 715   entry->set_flags(info.access_flags().is_final(), info.access_flags().is_volatile());
 716   entry->fill_in(info.field_holder(), info.offset(),
 717                  checked_cast<u2>(info.index()), checked_cast<u1>(state),
 718                  static_cast<u1>(get_code), static_cast<u1>(put_code));
 719 }
 720 
 721 
 722 //------------------------------------------------------------------------------------------------------------------------
 723 // Synchronization
 724 //
 725 // The interpreter's synchronization code is factored out so that it can
 726 // be shared by method invocation and synchronized blocks.
 727 //%note synchronization_3
 728 
 729 //%note monitor_1
 730 JRT_ENTRY_NO_ASYNC(void, InterpreterRuntime::monitorenter(JavaThread* current, BasicObjectLock* elem))
 731   assert(LockingMode != LM_LIGHTWEIGHT, "Should call monitorenter_obj() when using the new lightweight locking");
 732 #ifdef ASSERT
 733   current->last_frame().interpreter_frame_verify_monitor(elem);
 734 #endif
 735   Handle h_obj(current, elem->obj());
 736   assert(Universe::heap()->is_in_or_null(h_obj()),
 737          "must be null or an object");
 738   ObjectSynchronizer::enter(h_obj, elem->lock(), current);
 739   assert(Universe::heap()->is_in_or_null(elem->obj()),
 740          "must be null or an object");
 741 #ifdef ASSERT
 742   current->last_frame().interpreter_frame_verify_monitor(elem);
 743 #endif
 744 JRT_END
 745 
 746 // NOTE: We provide a separate implementation for the new lightweight locking to workaround a limitation
 747 // of registers in x86_32. This entry point accepts an oop instead of a BasicObjectLock*.
 748 // The problem is that we would need to preserve the register that holds the BasicObjectLock,
 749 // but we are using that register to hold the thread. We don't have enough registers to
 750 // also keep the BasicObjectLock, but we don't really need it anyway, we only need
 751 // the object. See also InterpreterMacroAssembler::lock_object().
 752 // As soon as legacy stack-locking goes away we could remove the other monitorenter() entry
 753 // point, and only use oop-accepting entries (same for monitorexit() below).
 754 JRT_ENTRY_NO_ASYNC(void, InterpreterRuntime::monitorenter_obj(JavaThread* current, oopDesc* obj))
 755   assert(LockingMode == LM_LIGHTWEIGHT, "Should call monitorenter() when not using the new lightweight locking");
 756   Handle h_obj(current, cast_to_oop(obj));
 757   assert(Universe::heap()->is_in_or_null(h_obj()),
 758          "must be null or an object");
 759   ObjectSynchronizer::enter(h_obj, nullptr, current);
 760   return;
 761 JRT_END
 762 
 763 JRT_LEAF(void, InterpreterRuntime::monitorexit(BasicObjectLock* elem))
 764   oop obj = elem->obj();
 765   assert(Universe::heap()->is_in(obj), "must be an object");
 766   // The object could become unlocked through a JNI call, which we have no other checks for.
 767   // Give a fatal message if CheckJNICalls. Otherwise we ignore it.
 768   if (obj->is_unlocked()) {
 769     if (CheckJNICalls) {
 770       fatal("Object has been unlocked by JNI");
 771     }
 772     return;
 773   }
 774   ObjectSynchronizer::exit(obj, elem->lock(), JavaThread::current());
 775   // Free entry. If it is not cleared, the exception handling code will try to unlock the monitor
 776   // again at method exit or in the case of an exception.
 777   elem->set_obj(nullptr);
 778 JRT_END
 779 
 780 
 781 JRT_ENTRY(void, InterpreterRuntime::throw_illegal_monitor_state_exception(JavaThread* current))
 782   THROW(vmSymbols::java_lang_IllegalMonitorStateException());
 783 JRT_END
 784 
 785 
 786 JRT_ENTRY(void, InterpreterRuntime::new_illegal_monitor_state_exception(JavaThread* current))
 787   // Returns an illegal exception to install into the current thread. The
 788   // pending_exception flag is cleared so normal exception handling does not
 789   // trigger. Any current installed exception will be overwritten. This
 790   // method will be called during an exception unwind.
 791 
 792   assert(!HAS_PENDING_EXCEPTION, "no pending exception");
 793   Handle exception(current, current->vm_result());
 794   assert(exception() != nullptr, "vm result should be set");
 795   current->set_vm_result(nullptr); // clear vm result before continuing (may cause memory leaks and assert failures)
 796   exception = get_preinitialized_exception(vmClasses::IllegalMonitorStateException_klass(), CATCH);
 797   current->set_vm_result(exception());
 798 JRT_END
 799 
 800 
 801 //------------------------------------------------------------------------------------------------------------------------
 802 // Invokes
 803 
 804 JRT_ENTRY(Bytecodes::Code, InterpreterRuntime::get_original_bytecode_at(JavaThread* current, Method* method, address bcp))
 805   return method->orig_bytecode_at(method->bci_from(bcp));
 806 JRT_END
 807 
 808 JRT_ENTRY(void, InterpreterRuntime::set_original_bytecode_at(JavaThread* current, Method* method, address bcp, Bytecodes::Code new_code))
 809   method->set_orig_bytecode_at(method->bci_from(bcp), new_code);
 810 JRT_END
 811 
 812 JRT_ENTRY(void, InterpreterRuntime::_breakpoint(JavaThread* current, Method* method, address bcp))
 813   JvmtiExport::post_raw_breakpoint(current, method, bcp);
 814 JRT_END
 815 
 816 void InterpreterRuntime::resolve_invoke(JavaThread* current, Bytecodes::Code bytecode) {
 817   LastFrameAccessor last_frame(current);
 818   // extract receiver from the outgoing argument list if necessary
 819   Handle receiver(current, nullptr);
 820   if (bytecode == Bytecodes::_invokevirtual || bytecode == Bytecodes::_invokeinterface ||
 821       bytecode == Bytecodes::_invokespecial) {
 822     ResourceMark rm(current);
 823     methodHandle m (current, last_frame.method());
 824     Bytecode_invoke call(m, last_frame.bci());
 825     Symbol* signature = call.signature();
 826     receiver = Handle(current, last_frame.callee_receiver(signature));
 827 
 828     assert(Universe::heap()->is_in_or_null(receiver()),
 829            "sanity check");
 830     assert(receiver.is_null() ||
 831            !Universe::heap()->is_in(receiver->klass()),
 832            "sanity check");
 833   }
 834 
 835   // resolve method
 836   CallInfo info;
 837   constantPoolHandle pool(current, last_frame.method()->constants());
 838   ConstantPoolCache* cache = pool->cache();
 839 
 840   methodHandle resolved_method;
 841 
 842   int method_index = last_frame.get_index_u2(bytecode);
 843   {
 844     JvmtiHideSingleStepping jhss(current);
 845     JavaThread* THREAD = current; // For exception macros.
 846     LinkResolver::resolve_invoke(info, receiver, pool,
 847                                  method_index, bytecode,
 848                                  THREAD);
 849 
 850     if (HAS_PENDING_EXCEPTION) {
 851       if (ProfileTraps && PENDING_EXCEPTION->klass()->name() == vmSymbols::java_lang_NullPointerException()) {
 852         // Preserve the original exception across the call to note_trap()
 853         PreserveExceptionMark pm(current);
 854         // Recording the trap will help the compiler to potentially recognize this exception as "hot"
 855         note_trap(current, Deoptimization::Reason_null_check);
 856       }
 857       return;
 858     }
 859 
 860     if (JvmtiExport::can_hotswap_or_post_breakpoint() && info.resolved_method()->is_old()) {
 861       resolved_method = methodHandle(current, info.resolved_method()->get_new_method());
 862     } else {
 863       resolved_method = methodHandle(current, info.resolved_method());
 864     }
 865   } // end JvmtiHideSingleStepping
 866 
 867   // check if link resolution caused cpCache to be updated
 868   if (cache->resolved_method_entry_at(method_index)->is_resolved(bytecode)) return;
 869 
 870 #ifdef ASSERT
 871   if (bytecode == Bytecodes::_invokeinterface) {
 872     if (resolved_method->method_holder() == vmClasses::Object_klass()) {
 873       // NOTE: THIS IS A FIX FOR A CORNER CASE in the JVM spec
 874       // (see also CallInfo::set_interface for details)
 875       assert(info.call_kind() == CallInfo::vtable_call ||
 876              info.call_kind() == CallInfo::direct_call, "");
 877       assert(resolved_method->is_final() || info.has_vtable_index(),
 878              "should have been set already");
 879     } else if (!resolved_method->has_itable_index()) {
 880       // Resolved something like CharSequence.toString.  Use vtable not itable.
 881       assert(info.call_kind() != CallInfo::itable_call, "");
 882     } else {
 883       // Setup itable entry
 884       assert(info.call_kind() == CallInfo::itable_call, "");
 885       int index = resolved_method->itable_index();
 886       assert(info.itable_index() == index, "");
 887     }
 888   } else if (bytecode == Bytecodes::_invokespecial) {
 889     assert(info.call_kind() == CallInfo::direct_call, "must be direct call");
 890   } else {
 891     assert(info.call_kind() == CallInfo::direct_call ||
 892            info.call_kind() == CallInfo::vtable_call, "");
 893   }
 894 #endif
 895   // Get sender and only set cpCache entry to resolved if it is not an
 896   // interface.  The receiver for invokespecial calls within interface
 897   // methods must be checked for every call.
 898   InstanceKlass* sender = pool->pool_holder();
 899 
 900   switch (info.call_kind()) {
 901   case CallInfo::direct_call:
 902     cache->set_direct_call(bytecode, method_index, resolved_method, sender->is_interface());
 903     break;
 904   case CallInfo::vtable_call:
 905     cache->set_vtable_call(bytecode, method_index, resolved_method, info.vtable_index());
 906     break;
 907   case CallInfo::itable_call:
 908     cache->set_itable_call(
 909       bytecode,
 910       method_index,
 911       info.resolved_klass(),
 912       resolved_method,
 913       info.itable_index());
 914     break;
 915   default:  ShouldNotReachHere();
 916   }
 917 }
 918 
 919 
 920 // First time execution:  Resolve symbols, create a permanent MethodType object.
 921 void InterpreterRuntime::resolve_invokehandle(JavaThread* current) {
 922   const Bytecodes::Code bytecode = Bytecodes::_invokehandle;
 923   LastFrameAccessor last_frame(current);
 924 
 925   // resolve method
 926   CallInfo info;
 927   constantPoolHandle pool(current, last_frame.method()->constants());
 928   int method_index = last_frame.get_index_u2(bytecode);
 929   {
 930     JvmtiHideSingleStepping jhss(current);
 931     JavaThread* THREAD = current; // For exception macros.
 932     LinkResolver::resolve_invoke(info, Handle(), pool,
 933                                  method_index, bytecode,
 934                                  CHECK);
 935   } // end JvmtiHideSingleStepping
 936 
 937   pool->cache()->set_method_handle(method_index, info);
 938 }
 939 
 940 // First time execution:  Resolve symbols, create a permanent CallSite object.
 941 void InterpreterRuntime::resolve_invokedynamic(JavaThread* current) {
 942   LastFrameAccessor last_frame(current);
 943   const Bytecodes::Code bytecode = Bytecodes::_invokedynamic;
 944 
 945   // resolve method
 946   CallInfo info;
 947   constantPoolHandle pool(current, last_frame.method()->constants());
 948   int index = last_frame.get_index_u4(bytecode);
 949   {
 950     JvmtiHideSingleStepping jhss(current);
 951     JavaThread* THREAD = current; // For exception macros.
 952     LinkResolver::resolve_invoke(info, Handle(), pool,
 953                                  index, bytecode, CHECK);
 954   } // end JvmtiHideSingleStepping
 955 
 956   pool->cache()->set_dynamic_call(info, pool->decode_invokedynamic_index(index));
 957 }
 958 
 959 // This function is the interface to the assembly code. It returns the resolved
 960 // cpCache entry.  This doesn't safepoint, but the helper routines safepoint.
 961 // This function will check for redefinition!
 962 JRT_ENTRY(void, InterpreterRuntime::resolve_from_cache(JavaThread* current, Bytecodes::Code bytecode)) {
 963   switch (bytecode) {
 964   case Bytecodes::_getstatic:
 965   case Bytecodes::_putstatic:
 966   case Bytecodes::_getfield:
 967   case Bytecodes::_putfield:
 968     resolve_get_put(current, bytecode);
 969     break;
 970   case Bytecodes::_invokevirtual:
 971   case Bytecodes::_invokespecial:
 972   case Bytecodes::_invokestatic:
 973   case Bytecodes::_invokeinterface:
 974     resolve_invoke(current, bytecode);
 975     break;
 976   case Bytecodes::_invokehandle:
 977     resolve_invokehandle(current);
 978     break;
 979   case Bytecodes::_invokedynamic:
 980     resolve_invokedynamic(current);
 981     break;
 982   default:
 983     fatal("unexpected bytecode: %s", Bytecodes::name(bytecode));
 984     break;
 985   }
 986 }
 987 JRT_END
 988 
 989 //------------------------------------------------------------------------------------------------------------------------
 990 // Miscellaneous
 991 
 992 
 993 nmethod* InterpreterRuntime::frequency_counter_overflow(JavaThread* current, address branch_bcp) {
 994   // Enable WXWrite: the function is called directly by interpreter.
 995   MACOS_AARCH64_ONLY(ThreadWXEnable wx(WXWrite, current));
 996 
 997   // frequency_counter_overflow_inner can throw async exception.
 998   nmethod* nm = frequency_counter_overflow_inner(current, branch_bcp);
 999   assert(branch_bcp != nullptr || nm == nullptr, "always returns null for non OSR requests");
1000   if (branch_bcp != nullptr && nm != nullptr) {
1001     // This was a successful request for an OSR nmethod.  Because
1002     // frequency_counter_overflow_inner ends with a safepoint check,
1003     // nm could have been unloaded so look it up again.  It's unsafe
1004     // to examine nm directly since it might have been freed and used
1005     // for something else.
1006     LastFrameAccessor last_frame(current);
1007     Method* method =  last_frame.method();
1008     int bci = method->bci_from(last_frame.bcp());
1009     nm = method->lookup_osr_nmethod_for(bci, CompLevel_none, false);
1010     BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
1011     if (nm != nullptr && bs_nm != nullptr) {
1012       // in case the transition passed a safepoint we need to barrier this again
1013       if (!bs_nm->nmethod_osr_entry_barrier(nm)) {
1014         nm = nullptr;
1015       }
1016     }
1017   }
1018   if (nm != nullptr && current->is_interp_only_mode()) {
1019     // Normally we never get an nm if is_interp_only_mode() is true, because
1020     // policy()->event has a check for this and won't compile the method when
1021     // true. However, it's possible for is_interp_only_mode() to become true
1022     // during the compilation. We don't want to return the nm in that case
1023     // because we want to continue to execute interpreted.
1024     nm = nullptr;
1025   }
1026 #ifndef PRODUCT
1027   if (TraceOnStackReplacement) {
1028     if (nm != nullptr) {
1029       tty->print("OSR entry @ pc: " INTPTR_FORMAT ": ", p2i(nm->osr_entry()));
1030       nm->print();
1031     }
1032   }
1033 #endif
1034   return nm;
1035 }
1036 
1037 JRT_ENTRY(nmethod*,
1038           InterpreterRuntime::frequency_counter_overflow_inner(JavaThread* current, address branch_bcp))
1039   // use UnlockFlagSaver to clear and restore the _do_not_unlock_if_synchronized
1040   // flag, in case this method triggers classloading which will call into Java.
1041   UnlockFlagSaver fs(current);
1042 
1043   LastFrameAccessor last_frame(current);
1044   assert(last_frame.is_interpreted_frame(), "must come from interpreter");
1045   methodHandle method(current, last_frame.method());
1046   const int branch_bci = branch_bcp != nullptr ? method->bci_from(branch_bcp) : InvocationEntryBci;
1047   const int bci = branch_bcp != nullptr ? method->bci_from(last_frame.bcp()) : InvocationEntryBci;
1048 
1049   nmethod* osr_nm = CompilationPolicy::event(method, method, branch_bci, bci, CompLevel_none, nullptr, CHECK_NULL);
1050 
1051   BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
1052   if (osr_nm != nullptr && bs_nm != nullptr) {
1053     if (!bs_nm->nmethod_osr_entry_barrier(osr_nm)) {
1054       osr_nm = nullptr;
1055     }
1056   }
1057   return osr_nm;
1058 JRT_END
1059 
1060 JRT_LEAF(jint, InterpreterRuntime::bcp_to_di(Method* method, address cur_bcp))
1061   assert(ProfileInterpreter, "must be profiling interpreter");
1062   int bci = method->bci_from(cur_bcp);
1063   MethodData* mdo = method->method_data();
1064   if (mdo == nullptr)  return 0;
1065   return mdo->bci_to_di(bci);
1066 JRT_END
1067 
1068 #ifdef ASSERT
1069 JRT_LEAF(void, InterpreterRuntime::verify_mdp(Method* method, address bcp, address mdp))
1070   assert(ProfileInterpreter, "must be profiling interpreter");
1071 
1072   MethodData* mdo = method->method_data();
1073   assert(mdo != nullptr, "must not be null");
1074 
1075   int bci = method->bci_from(bcp);
1076 
1077   address mdp2 = mdo->bci_to_dp(bci);
1078   if (mdp != mdp2) {
1079     ResourceMark rm;
1080     tty->print_cr("FAILED verify : actual mdp %p   expected mdp %p @ bci %d", mdp, mdp2, bci);
1081     int current_di = mdo->dp_to_di(mdp);
1082     int expected_di  = mdo->dp_to_di(mdp2);
1083     tty->print_cr("  actual di %d   expected di %d", current_di, expected_di);
1084     int expected_approx_bci = mdo->data_at(expected_di)->bci();
1085     int approx_bci = -1;
1086     if (current_di >= 0) {
1087       approx_bci = mdo->data_at(current_di)->bci();
1088     }
1089     tty->print_cr("  actual bci is %d  expected bci %d", approx_bci, expected_approx_bci);
1090     mdo->print_on(tty);
1091     method->print_codes();
1092   }
1093   assert(mdp == mdp2, "wrong mdp");
1094 JRT_END
1095 #endif // ASSERT
1096 
1097 JRT_ENTRY(void, InterpreterRuntime::update_mdp_for_ret(JavaThread* current, int return_bci))
1098   assert(ProfileInterpreter, "must be profiling interpreter");
1099   ResourceMark rm(current);
1100   LastFrameAccessor last_frame(current);
1101   assert(last_frame.is_interpreted_frame(), "must come from interpreter");
1102   MethodData* h_mdo = last_frame.method()->method_data();
1103 
1104   // Grab a lock to ensure atomic access to setting the return bci and
1105   // the displacement.  This can block and GC, invalidating all naked oops.
1106   MutexLocker ml(RetData_lock);
1107 
1108   // ProfileData is essentially a wrapper around a derived oop, so we
1109   // need to take the lock before making any ProfileData structures.
1110   ProfileData* data = h_mdo->data_at(h_mdo->dp_to_di(last_frame.mdp()));
1111   guarantee(data != nullptr, "profile data must be valid");
1112   RetData* rdata = data->as_RetData();
1113   address new_mdp = rdata->fixup_ret(return_bci, h_mdo);
1114   last_frame.set_mdp(new_mdp);
1115 JRT_END
1116 
1117 JRT_ENTRY(MethodCounters*, InterpreterRuntime::build_method_counters(JavaThread* current, Method* m))
1118   return Method::build_method_counters(current, m);
1119 JRT_END
1120 
1121 
1122 JRT_ENTRY(void, InterpreterRuntime::at_safepoint(JavaThread* current))
1123   // We used to need an explicit preserve_arguments here for invoke bytecodes. However,
1124   // stack traversal automatically takes care of preserving arguments for invoke, so
1125   // this is no longer needed.
1126 
1127   // JRT_END does an implicit safepoint check, hence we are guaranteed to block
1128   // if this is called during a safepoint
1129 
1130   if (JvmtiExport::should_post_single_step()) {
1131     // This function is called by the interpreter when single stepping. Such single
1132     // stepping could unwind a frame. Then, it is important that we process any frames
1133     // that we might return into.
1134     StackWatermarkSet::before_unwind(current);
1135 
1136     // We are called during regular safepoints and when the VM is
1137     // single stepping. If any thread is marked for single stepping,
1138     // then we may have JVMTI work to do.
1139     LastFrameAccessor last_frame(current);
1140     JvmtiExport::at_single_stepping_point(current, last_frame.method(), last_frame.bcp());
1141   }
1142 JRT_END
1143 
1144 JRT_LEAF(void, InterpreterRuntime::at_unwind(JavaThread* current))
1145   assert(current == JavaThread::current(), "pre-condition");
1146   // This function is called by the interpreter when the return poll found a reason
1147   // to call the VM. The reason could be that we are returning into a not yet safe
1148   // to access frame. We handle that below.
1149   // Note that this path does not check for single stepping, because we do not want
1150   // to single step when unwinding frames for an exception being thrown. Instead,
1151   // such single stepping code will use the safepoint table, which will use the
1152   // InterpreterRuntime::at_safepoint callback.
1153   StackWatermarkSet::before_unwind(current);
1154 JRT_END
1155 
1156 JRT_ENTRY(void, InterpreterRuntime::post_field_access(JavaThread* current, oopDesc* obj,
1157                                                       ResolvedFieldEntry *entry))
1158 
1159   // check the access_flags for the field in the klass
1160 
1161   InstanceKlass* ik = entry->field_holder();
1162   int index = entry->field_index();
1163   if (!ik->field_status(index).is_access_watched()) return;
1164 
1165   bool is_static = (obj == nullptr);
1166   HandleMark hm(current);
1167 
1168   Handle h_obj;
1169   if (!is_static) {
1170     // non-static field accessors have an object, but we need a handle
1171     h_obj = Handle(current, obj);
1172   }
1173   InstanceKlass* field_holder = entry->field_holder(); // HERE
1174   jfieldID fid = jfieldIDWorkaround::to_jfieldID(field_holder, entry->field_offset(), is_static);
1175   LastFrameAccessor last_frame(current);
1176   JvmtiExport::post_field_access(current, last_frame.method(), last_frame.bcp(), field_holder, h_obj, fid);
1177 JRT_END
1178 
1179 JRT_ENTRY(void, InterpreterRuntime::post_field_modification(JavaThread* current, oopDesc* obj,
1180                                                             ResolvedFieldEntry *entry, jvalue *value))
1181 
1182   InstanceKlass* ik = entry->field_holder();
1183 
1184   // check the access_flags for the field in the klass
1185   int index = entry->field_index();
1186   // bail out if field modifications are not watched
1187   if (!ik->field_status(index).is_modification_watched()) return;
1188 
1189   char sig_type = '\0';
1190 
1191   switch((TosState)entry->tos_state()) {
1192     case btos: sig_type = JVM_SIGNATURE_BYTE;    break;
1193     case ztos: sig_type = JVM_SIGNATURE_BOOLEAN; break;
1194     case ctos: sig_type = JVM_SIGNATURE_CHAR;    break;
1195     case stos: sig_type = JVM_SIGNATURE_SHORT;   break;
1196     case itos: sig_type = JVM_SIGNATURE_INT;     break;
1197     case ftos: sig_type = JVM_SIGNATURE_FLOAT;   break;
1198     case atos: sig_type = JVM_SIGNATURE_CLASS;   break;
1199     case ltos: sig_type = JVM_SIGNATURE_LONG;    break;
1200     case dtos: sig_type = JVM_SIGNATURE_DOUBLE;  break;
1201     default:  ShouldNotReachHere(); return;
1202   }
1203   bool is_static = (obj == nullptr);
1204 
1205   HandleMark hm(current);
1206   jfieldID fid = jfieldIDWorkaround::to_jfieldID(ik, entry->field_offset(), is_static);
1207   jvalue fvalue;
1208 #ifdef _LP64
1209   fvalue = *value;
1210 #else
1211   // Long/double values are stored unaligned and also noncontiguously with
1212   // tagged stacks.  We can't just do a simple assignment even in the non-
1213   // J/D cases because a C++ compiler is allowed to assume that a jvalue is
1214   // 8-byte aligned, and interpreter stack slots are only 4-byte aligned.
1215   // We assume that the two halves of longs/doubles are stored in interpreter
1216   // stack slots in platform-endian order.
1217   jlong_accessor u;
1218   jint* newval = (jint*)value;
1219   u.words[0] = newval[0];
1220   u.words[1] = newval[Interpreter::stackElementWords]; // skip if tag
1221   fvalue.j = u.long_value;
1222 #endif // _LP64
1223 
1224   Handle h_obj;
1225   if (!is_static) {
1226     // non-static field accessors have an object, but we need a handle
1227     h_obj = Handle(current, obj);
1228   }
1229 
1230   LastFrameAccessor last_frame(current);
1231   JvmtiExport::post_raw_field_modification(current, last_frame.method(), last_frame.bcp(), ik, h_obj,
1232                                            fid, sig_type, &fvalue);
1233 JRT_END
1234 
1235 JRT_ENTRY(void, InterpreterRuntime::post_method_entry(JavaThread* current))
1236   LastFrameAccessor last_frame(current);
1237   JvmtiExport::post_method_entry(current, last_frame.method(), last_frame.get_frame());
1238 JRT_END
1239 
1240 
1241 // This is a JRT_BLOCK_ENTRY because we have to stash away the return oop
1242 // before transitioning to VM, and restore it after transitioning back
1243 // to Java. The return oop at the top-of-stack, is not walked by the GC.
1244 JRT_BLOCK_ENTRY(void, InterpreterRuntime::post_method_exit(JavaThread* current))
1245   LastFrameAccessor last_frame(current);
1246   JvmtiExport::post_method_exit(current, last_frame.method(), last_frame.get_frame());
1247 JRT_END
1248 
1249 JRT_LEAF(int, InterpreterRuntime::interpreter_contains(address pc))
1250 {
1251   return (Interpreter::contains(Continuation::get_top_return_pc_post_barrier(JavaThread::current(), pc)) ? 1 : 0);
1252 }
1253 JRT_END
1254 
1255 
1256 // Implementation of SignatureHandlerLibrary
1257 
1258 #ifndef SHARING_FAST_NATIVE_FINGERPRINTS
1259 // Dummy definition (else normalization method is defined in CPU
1260 // dependent code)
1261 uint64_t InterpreterRuntime::normalize_fast_native_fingerprint(uint64_t fingerprint) {
1262   return fingerprint;
1263 }
1264 #endif
1265 
1266 address SignatureHandlerLibrary::set_handler_blob() {
1267   BufferBlob* handler_blob = BufferBlob::create("native signature handlers", blob_size);
1268   if (handler_blob == nullptr) {
1269     return nullptr;
1270   }
1271   address handler = handler_blob->code_begin();
1272   _handler_blob = handler_blob;
1273   _handler = handler;
1274   return handler;
1275 }
1276 
1277 void SignatureHandlerLibrary::initialize() {
1278   if (_fingerprints != nullptr) {
1279     return;
1280   }
1281   if (set_handler_blob() == nullptr) {
1282     vm_exit_out_of_memory(blob_size, OOM_MALLOC_ERROR, "native signature handlers");
1283   }
1284 
1285   BufferBlob* bb = BufferBlob::create("Signature Handler Temp Buffer",
1286                                       SignatureHandlerLibrary::buffer_size);
1287   _buffer = bb->code_begin();
1288 
1289   _fingerprints = new (mtCode) GrowableArray<uint64_t>(32, mtCode);
1290   _handlers     = new (mtCode) GrowableArray<address>(32, mtCode);
1291 }
1292 
1293 address SignatureHandlerLibrary::set_handler(CodeBuffer* buffer) {
1294   address handler   = _handler;
1295   int     insts_size = buffer->pure_insts_size();
1296   if (handler + insts_size > _handler_blob->code_end()) {
1297     // get a new handler blob
1298     handler = set_handler_blob();
1299   }
1300   if (handler != nullptr) {
1301     memcpy(handler, buffer->insts_begin(), insts_size);
1302     pd_set_handler(handler);
1303     ICache::invalidate_range(handler, insts_size);
1304     _handler = handler + insts_size;
1305   }
1306   return handler;
1307 }
1308 
1309 void SignatureHandlerLibrary::add(const methodHandle& method) {
1310   if (method->signature_handler() == nullptr) {
1311     // use slow signature handler if we can't do better
1312     int handler_index = -1;
1313     // check if we can use customized (fast) signature handler
1314     if (UseFastSignatureHandlers && method->size_of_parameters() <= Fingerprinter::fp_max_size_of_parameters) {
1315       // use customized signature handler
1316       MutexLocker mu(SignatureHandlerLibrary_lock);
1317       // make sure data structure is initialized
1318       initialize();
1319       // lookup method signature's fingerprint
1320       uint64_t fingerprint = Fingerprinter(method).fingerprint();
1321       // allow CPU dependent code to optimize the fingerprints for the fast handler
1322       fingerprint = InterpreterRuntime::normalize_fast_native_fingerprint(fingerprint);
1323       handler_index = _fingerprints->find(fingerprint);
1324       // create handler if necessary
1325       if (handler_index < 0) {
1326         ResourceMark rm;
1327         ptrdiff_t align_offset = align_up(_buffer, CodeEntryAlignment) - (address)_buffer;
1328         CodeBuffer buffer((address)(_buffer + align_offset),
1329                           checked_cast<int>(SignatureHandlerLibrary::buffer_size - align_offset));
1330         InterpreterRuntime::SignatureHandlerGenerator(method, &buffer).generate(fingerprint);
1331         // copy into code heap
1332         address handler = set_handler(&buffer);
1333         if (handler == nullptr) {
1334           // use slow signature handler (without memorizing it in the fingerprints)
1335         } else {
1336           // debugging support
1337           if (PrintSignatureHandlers && (handler != Interpreter::slow_signature_handler())) {
1338             ttyLocker ttyl;
1339             tty->cr();
1340             tty->print_cr("argument handler #%d for: %s %s (fingerprint = " UINT64_FORMAT ", %d bytes generated)",
1341                           _handlers->length(),
1342                           (method->is_static() ? "static" : "receiver"),
1343                           method->name_and_sig_as_C_string(),
1344                           fingerprint,
1345                           buffer.insts_size());
1346             if (buffer.insts_size() > 0) {
1347               Disassembler::decode(handler, handler + buffer.insts_size(), tty
1348                                    NOT_PRODUCT(COMMA &buffer.asm_remarks()));
1349             }
1350 #ifndef PRODUCT
1351             address rh_begin = Interpreter::result_handler(method()->result_type());
1352             if (CodeCache::contains(rh_begin)) {
1353               // else it might be special platform dependent values
1354               tty->print_cr(" --- associated result handler ---");
1355               address rh_end = rh_begin;
1356               while (*(int*)rh_end != 0) {
1357                 rh_end += sizeof(int);
1358               }
1359               Disassembler::decode(rh_begin, rh_end);
1360             } else {
1361               tty->print_cr(" associated result handler: " PTR_FORMAT, p2i(rh_begin));
1362             }
1363 #endif
1364           }
1365           // add handler to library
1366           _fingerprints->append(fingerprint);
1367           _handlers->append(handler);
1368           // set handler index
1369           assert(_fingerprints->length() == _handlers->length(), "sanity check");
1370           handler_index = _fingerprints->length() - 1;
1371         }
1372       }
1373       // Set handler under SignatureHandlerLibrary_lock
1374       if (handler_index < 0) {
1375         // use generic signature handler
1376         method->set_signature_handler(Interpreter::slow_signature_handler());
1377       } else {
1378         // set handler
1379         method->set_signature_handler(_handlers->at(handler_index));
1380       }
1381     } else {
1382       DEBUG_ONLY(JavaThread::current()->check_possible_safepoint());
1383       // use generic signature handler
1384       method->set_signature_handler(Interpreter::slow_signature_handler());
1385     }
1386   }
1387 #ifdef ASSERT
1388   int handler_index = -1;
1389   int fingerprint_index = -2;
1390   {
1391     // '_handlers' and '_fingerprints' are 'GrowableArray's and are NOT synchronized
1392     // in any way if accessed from multiple threads. To avoid races with another
1393     // thread which may change the arrays in the above, mutex protected block, we
1394     // have to protect this read access here with the same mutex as well!
1395     MutexLocker mu(SignatureHandlerLibrary_lock);
1396     if (_handlers != nullptr) {
1397       handler_index = _handlers->find(method->signature_handler());
1398       uint64_t fingerprint = Fingerprinter(method).fingerprint();
1399       fingerprint = InterpreterRuntime::normalize_fast_native_fingerprint(fingerprint);
1400       fingerprint_index = _fingerprints->find(fingerprint);
1401     }
1402   }
1403   assert(method->signature_handler() == Interpreter::slow_signature_handler() ||
1404          handler_index == fingerprint_index, "sanity check");
1405 #endif // ASSERT
1406 }
1407 
1408 void SignatureHandlerLibrary::add(uint64_t fingerprint, address handler) {
1409   int handler_index = -1;
1410   // use customized signature handler
1411   MutexLocker mu(SignatureHandlerLibrary_lock);
1412   // make sure data structure is initialized
1413   initialize();
1414   fingerprint = InterpreterRuntime::normalize_fast_native_fingerprint(fingerprint);
1415   handler_index = _fingerprints->find(fingerprint);
1416   // create handler if necessary
1417   if (handler_index < 0) {
1418     if (PrintSignatureHandlers && (handler != Interpreter::slow_signature_handler())) {
1419       tty->cr();
1420       tty->print_cr("argument handler #%d at " PTR_FORMAT " for fingerprint " UINT64_FORMAT,
1421                     _handlers->length(),
1422                     p2i(handler),
1423                     fingerprint);
1424     }
1425     _fingerprints->append(fingerprint);
1426     _handlers->append(handler);
1427   } else {
1428     if (PrintSignatureHandlers) {
1429       tty->cr();
1430       tty->print_cr("duplicate argument handler #%d for fingerprint " UINT64_FORMAT "(old: " PTR_FORMAT ", new : " PTR_FORMAT ")",
1431                     _handlers->length(),
1432                     fingerprint,
1433                     p2i(_handlers->at(handler_index)),
1434                     p2i(handler));
1435     }
1436   }
1437 }
1438 
1439 
1440 BufferBlob*              SignatureHandlerLibrary::_handler_blob = nullptr;
1441 address                  SignatureHandlerLibrary::_handler      = nullptr;
1442 GrowableArray<uint64_t>* SignatureHandlerLibrary::_fingerprints = nullptr;
1443 GrowableArray<address>*  SignatureHandlerLibrary::_handlers     = nullptr;
1444 address                  SignatureHandlerLibrary::_buffer       = nullptr;
1445 
1446 
1447 JRT_ENTRY(void, InterpreterRuntime::prepare_native_call(JavaThread* current, Method* method))
1448   methodHandle m(current, method);
1449   assert(m->is_native(), "sanity check");
1450   // lookup native function entry point if it doesn't exist
1451   if (!m->has_native_function()) {
1452     NativeLookup::lookup(m, CHECK);
1453   }
1454   // make sure signature handler is installed
1455   SignatureHandlerLibrary::add(m);
1456   // The interpreter entry point checks the signature handler first,
1457   // before trying to fetch the native entry point and klass mirror.
1458   // We must set the signature handler last, so that multiple processors
1459   // preparing the same method will be sure to see non-null entry & mirror.
1460 JRT_END
1461 
1462 #if defined(IA32) || defined(AMD64) || defined(ARM)
1463 JRT_LEAF(void, InterpreterRuntime::popframe_move_outgoing_args(JavaThread* current, void* src_address, void* dest_address))
1464   assert(current == JavaThread::current(), "pre-condition");
1465   if (src_address == dest_address) {
1466     return;
1467   }
1468   ResourceMark rm;
1469   LastFrameAccessor last_frame(current);
1470   assert(last_frame.is_interpreted_frame(), "");
1471   jint bci = last_frame.bci();
1472   methodHandle mh(current, last_frame.method());
1473   Bytecode_invoke invoke(mh, bci);
1474   ArgumentSizeComputer asc(invoke.signature());
1475   int size_of_arguments = (asc.size() + (invoke.has_receiver() ? 1 : 0)); // receiver
1476   Copy::conjoint_jbytes(src_address, dest_address,
1477                        size_of_arguments * Interpreter::stackElementSize);
1478 JRT_END
1479 #endif
1480 
1481 #if INCLUDE_JVMTI
1482 // This is a support of the JVMTI PopFrame interface.
1483 // Make sure it is an invokestatic of a polymorphic intrinsic that has a member_name argument
1484 // and return it as a vm_result so that it can be reloaded in the list of invokestatic parameters.
1485 // The member_name argument is a saved reference (in local#0) to the member_name.
1486 // For backward compatibility with some JDK versions (7, 8) it can also be a direct method handle.
1487 // FIXME: remove DMH case after j.l.i.InvokerBytecodeGenerator code shape is updated.
1488 JRT_ENTRY(void, InterpreterRuntime::member_name_arg_or_null(JavaThread* current, address member_name,
1489                                                             Method* method, address bcp))
1490   Bytecodes::Code code = Bytecodes::code_at(method, bcp);
1491   if (code != Bytecodes::_invokestatic) {
1492     return;
1493   }
1494   ConstantPool* cpool = method->constants();
1495   int cp_index = Bytes::get_native_u2(bcp + 1);
1496   Symbol* cname = cpool->klass_name_at(cpool->klass_ref_index_at(cp_index, code));
1497   Symbol* mname = cpool->name_ref_at(cp_index, code);
1498 
1499   if (MethodHandles::has_member_arg(cname, mname)) {
1500     oop member_name_oop = cast_to_oop(member_name);
1501     if (java_lang_invoke_DirectMethodHandle::is_instance(member_name_oop)) {
1502       // FIXME: remove after j.l.i.InvokerBytecodeGenerator code shape is updated.
1503       member_name_oop = java_lang_invoke_DirectMethodHandle::member(member_name_oop);
1504     }
1505     current->set_vm_result(member_name_oop);
1506   } else {
1507     current->set_vm_result(nullptr);
1508   }
1509 JRT_END
1510 #endif // INCLUDE_JVMTI
1511 
1512 #ifndef PRODUCT
1513 // This must be a JRT_LEAF function because the interpreter must save registers on x86 to
1514 // call this, which changes rsp and makes the interpreter's expression stack not walkable.
1515 // The generated code still uses call_VM because that will set up the frame pointer for
1516 // bcp and method.
1517 JRT_LEAF(intptr_t, InterpreterRuntime::trace_bytecode(JavaThread* current, intptr_t preserve_this_value, intptr_t tos, intptr_t tos2))
1518   assert(current == JavaThread::current(), "pre-condition");
1519   LastFrameAccessor last_frame(current);
1520   assert(last_frame.is_interpreted_frame(), "must be an interpreted frame");
1521   methodHandle mh(current, last_frame.method());
1522   BytecodeTracer::trace_interpreter(mh, last_frame.bcp(), tos, tos2);
1523   return preserve_this_value;
1524 JRT_END
1525 #endif // !PRODUCT