1 /*
   2  * Copyright (c) 1997, 2025, 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 "compiler/compiler_globals.hpp"
  26 #include "interp_masm_x86.hpp"
  27 #include "interpreter/interpreter.hpp"
  28 #include "interpreter/interpreterRuntime.hpp"
  29 #include "logging/log.hpp"
  30 #include "oops/arrayOop.hpp"
  31 #include "oops/constMethodFlags.hpp"
  32 #include "oops/markWord.hpp"
  33 #include "oops/methodData.hpp"
  34 #include "oops/method.hpp"
  35 #include "oops/inlineKlass.hpp"
  36 #include "oops/resolvedFieldEntry.hpp"
  37 #include "oops/resolvedIndyEntry.hpp"
  38 #include "oops/resolvedMethodEntry.hpp"
  39 #include "prims/jvmtiExport.hpp"
  40 #include "prims/jvmtiThreadState.hpp"
  41 #include "runtime/basicLock.hpp"
  42 #include "runtime/frame.inline.hpp"
  43 #include "runtime/javaThread.hpp"
  44 #include "runtime/safepointMechanism.hpp"
  45 #include "runtime/sharedRuntime.hpp"
  46 #include "utilities/powerOfTwo.hpp"
  47 
  48 // Implementation of InterpreterMacroAssembler
  49 
  50 void InterpreterMacroAssembler::jump_to_entry(address entry) {
  51   assert(entry, "Entry must have been generated by now");
  52   jump(RuntimeAddress(entry));
  53 }
  54 
  55 void InterpreterMacroAssembler::profile_obj_type(Register obj, const Address& mdo_addr) {
  56   Label update, next, none;
  57 
  58   assert_different_registers(obj, rscratch1, mdo_addr.base(), mdo_addr.index());
  59 
  60   interp_verify_oop(obj, atos);
  61 
  62   testptr(obj, obj);
  63   jccb(Assembler::notZero, update);
  64   testptr(mdo_addr, TypeEntries::null_seen);
  65   jccb(Assembler::notZero, next); // null already seen. Nothing to do anymore.
  66   // atomic update to prevent overwriting Klass* with 0
  67   lock();
  68   orptr(mdo_addr, TypeEntries::null_seen);
  69   jmpb(next);
  70 
  71   bind(update);
  72   load_klass(obj, obj, rscratch1);
  73   mov(rscratch1, obj);
  74 
  75   xorptr(obj, mdo_addr);
  76   testptr(obj, TypeEntries::type_klass_mask);
  77   jccb(Assembler::zero, next); // klass seen before, nothing to
  78                                // do. The unknown bit may have been
  79                                // set already but no need to check.
  80 
  81   testptr(obj, TypeEntries::type_unknown);
  82   jccb(Assembler::notZero, next); // already unknown. Nothing to do anymore.
  83 
  84   cmpptr(mdo_addr, 0);
  85   jccb(Assembler::equal, none);
  86   cmpptr(mdo_addr, TypeEntries::null_seen);
  87   jccb(Assembler::equal, none);
  88 
  89   // There is a chance that the checks above (re-reading profiling
  90   // data from memory) fail if another thread has just set the
  91   // profiling to this obj's klass
  92   mov(obj, rscratch1);
  93   xorptr(obj, mdo_addr);
  94   testptr(obj, TypeEntries::type_klass_mask);
  95   jccb(Assembler::zero, next);
  96 
  97   // different than before. Cannot keep accurate profile.
  98   orptr(mdo_addr, TypeEntries::type_unknown);
  99   jmpb(next);
 100 
 101   bind(none);
 102   // first time here. Set profile type.
 103   movptr(mdo_addr, obj);
 104 #ifdef ASSERT
 105   andptr(obj, TypeEntries::type_klass_mask);
 106   verify_klass_ptr(obj);
 107 #endif
 108 
 109   bind(next);
 110 }
 111 
 112 void InterpreterMacroAssembler::profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual) {
 113   if (!ProfileInterpreter) {
 114     return;
 115   }
 116 
 117   if (MethodData::profile_arguments() || MethodData::profile_return()) {
 118     Label profile_continue;
 119 
 120     test_method_data_pointer(mdp, profile_continue);
 121 
 122     int off_to_start = is_virtual ? in_bytes(VirtualCallData::virtual_call_data_size()) : in_bytes(CounterData::counter_data_size());
 123 
 124     cmpb(Address(mdp, in_bytes(DataLayout::tag_offset()) - off_to_start), is_virtual ? DataLayout::virtual_call_type_data_tag : DataLayout::call_type_data_tag);
 125     jcc(Assembler::notEqual, profile_continue);
 126 
 127     if (MethodData::profile_arguments()) {
 128       Label done;
 129       int off_to_args = in_bytes(TypeEntriesAtCall::args_data_offset());
 130       addptr(mdp, off_to_args);
 131 
 132       for (int i = 0; i < TypeProfileArgsLimit; i++) {
 133         if (i > 0 || MethodData::profile_return()) {
 134           // If return value type is profiled we may have no argument to profile
 135           movptr(tmp, Address(mdp, in_bytes(TypeEntriesAtCall::cell_count_offset())-off_to_args));
 136           subl(tmp, i*TypeStackSlotEntries::per_arg_count());
 137           cmpl(tmp, TypeStackSlotEntries::per_arg_count());
 138           jcc(Assembler::less, done);
 139         }
 140         movptr(tmp, Address(callee, Method::const_offset()));
 141         load_unsigned_short(tmp, Address(tmp, ConstMethod::size_of_parameters_offset()));
 142         // stack offset o (zero based) from the start of the argument
 143         // list, for n arguments translates into offset n - o - 1 from
 144         // the end of the argument list
 145         subptr(tmp, Address(mdp, in_bytes(TypeEntriesAtCall::stack_slot_offset(i))-off_to_args));
 146         subl(tmp, 1);
 147         Address arg_addr = argument_address(tmp);
 148         movptr(tmp, arg_addr);
 149 
 150         Address mdo_arg_addr(mdp, in_bytes(TypeEntriesAtCall::argument_type_offset(i))-off_to_args);
 151         profile_obj_type(tmp, mdo_arg_addr);
 152 
 153         int to_add = in_bytes(TypeStackSlotEntries::per_arg_size());
 154         addptr(mdp, to_add);
 155         off_to_args += to_add;
 156       }
 157 
 158       if (MethodData::profile_return()) {
 159         movptr(tmp, Address(mdp, in_bytes(TypeEntriesAtCall::cell_count_offset())-off_to_args));
 160         subl(tmp, TypeProfileArgsLimit*TypeStackSlotEntries::per_arg_count());
 161       }
 162 
 163       bind(done);
 164 
 165       if (MethodData::profile_return()) {
 166         // We're right after the type profile for the last
 167         // argument. tmp is the number of cells left in the
 168         // CallTypeData/VirtualCallTypeData to reach its end. Non null
 169         // if there's a return to profile.
 170         assert(SingleTypeEntry::static_cell_count() < TypeStackSlotEntries::per_arg_count(), "can't move past ret type");
 171         shll(tmp, log2i_exact((int)DataLayout::cell_size));
 172         addptr(mdp, tmp);
 173       }
 174       movptr(Address(rbp, frame::interpreter_frame_mdp_offset * wordSize), mdp);
 175     } else {
 176       assert(MethodData::profile_return(), "either profile call args or call ret");
 177       update_mdp_by_constant(mdp, in_bytes(TypeEntriesAtCall::return_only_size()));
 178     }
 179 
 180     // mdp points right after the end of the
 181     // CallTypeData/VirtualCallTypeData, right after the cells for the
 182     // return value type if there's one
 183 
 184     bind(profile_continue);
 185   }
 186 }
 187 
 188 void InterpreterMacroAssembler::profile_return_type(Register mdp, Register ret, Register tmp) {
 189   assert_different_registers(mdp, ret, tmp, _bcp_register);
 190   if (ProfileInterpreter && MethodData::profile_return()) {
 191     Label profile_continue;
 192 
 193     test_method_data_pointer(mdp, profile_continue);
 194 
 195     if (MethodData::profile_return_jsr292_only()) {
 196       assert(Method::intrinsic_id_size_in_bytes() == 2, "assuming Method::_intrinsic_id is u2");
 197 
 198       // If we don't profile all invoke bytecodes we must make sure
 199       // it's a bytecode we indeed profile. We can't go back to the
 200       // beginning of the ProfileData we intend to update to check its
 201       // type because we're right after it and we don't known its
 202       // length
 203       Label do_profile;
 204       cmpb(Address(_bcp_register, 0), Bytecodes::_invokedynamic);
 205       jcc(Assembler::equal, do_profile);
 206       cmpb(Address(_bcp_register, 0), Bytecodes::_invokehandle);
 207       jcc(Assembler::equal, do_profile);
 208       get_method(tmp);
 209       cmpw(Address(tmp, Method::intrinsic_id_offset()), static_cast<int>(vmIntrinsics::_compiledLambdaForm));
 210       jcc(Assembler::notEqual, profile_continue);
 211 
 212       bind(do_profile);
 213     }
 214 
 215     Address mdo_ret_addr(mdp, -in_bytes(SingleTypeEntry::size()));
 216     mov(tmp, ret);
 217     profile_obj_type(tmp, mdo_ret_addr);
 218 
 219     bind(profile_continue);
 220   }
 221 }
 222 
 223 void InterpreterMacroAssembler::profile_parameters_type(Register mdp, Register tmp1, Register tmp2) {
 224   if (ProfileInterpreter && MethodData::profile_parameters()) {
 225     Label profile_continue;
 226 
 227     test_method_data_pointer(mdp, profile_continue);
 228 
 229     // Load the offset of the area within the MDO used for
 230     // parameters. If it's negative we're not profiling any parameters
 231     movl(tmp1, Address(mdp, in_bytes(MethodData::parameters_type_data_di_offset()) - in_bytes(MethodData::data_offset())));
 232     testl(tmp1, tmp1);
 233     jcc(Assembler::negative, profile_continue);
 234 
 235     // Compute a pointer to the area for parameters from the offset
 236     // and move the pointer to the slot for the last
 237     // parameters. Collect profiling from last parameter down.
 238     // mdo start + parameters offset + array length - 1
 239     addptr(mdp, tmp1);
 240     movptr(tmp1, Address(mdp, ArrayData::array_len_offset()));
 241     decrement(tmp1, TypeStackSlotEntries::per_arg_count());
 242 
 243     Label loop;
 244     bind(loop);
 245 
 246     int off_base = in_bytes(ParametersTypeData::stack_slot_offset(0));
 247     int type_base = in_bytes(ParametersTypeData::type_offset(0));
 248     Address::ScaleFactor per_arg_scale = Address::times(DataLayout::cell_size);
 249     Address arg_off(mdp, tmp1, per_arg_scale, off_base);
 250     Address arg_type(mdp, tmp1, per_arg_scale, type_base);
 251 
 252     // load offset on the stack from the slot for this parameter
 253     movptr(tmp2, arg_off);
 254     negptr(tmp2);
 255     // read the parameter from the local area
 256     movptr(tmp2, Address(_locals_register, tmp2, Interpreter::stackElementScale()));
 257 
 258     // profile the parameter
 259     profile_obj_type(tmp2, arg_type);
 260 
 261     // go to next parameter
 262     decrement(tmp1, TypeStackSlotEntries::per_arg_count());
 263     jcc(Assembler::positive, loop);
 264 
 265     bind(profile_continue);
 266   }
 267 }
 268 
 269 void InterpreterMacroAssembler::call_VM_leaf_base(address entry_point,
 270                                                   int number_of_arguments) {
 271   // interpreter specific
 272   //
 273   // Note: No need to save/restore bcp & locals registers
 274   //       since these are callee saved registers and no blocking/
 275   //       GC can happen in leaf calls.
 276   // Further Note: DO NOT save/restore bcp/locals. If a caller has
 277   // already saved them so that it can use rsi/rdi as temporaries
 278   // then a save/restore here will DESTROY the copy the caller
 279   // saved! There used to be a save_bcp() that only happened in
 280   // the ASSERT path (no restore_bcp). Which caused bizarre failures
 281   // when jvm built with ASSERTs.
 282 #ifdef ASSERT
 283   {
 284     Label L;
 285     cmpptr(Address(rbp, frame::interpreter_frame_last_sp_offset * wordSize), NULL_WORD);
 286     jcc(Assembler::equal, L);
 287     stop("InterpreterMacroAssembler::call_VM_leaf_base:"
 288          " last_sp != null");
 289     bind(L);
 290   }
 291 #endif
 292   // super call
 293   MacroAssembler::call_VM_leaf_base(entry_point, number_of_arguments);
 294   // interpreter specific
 295   // LP64: Used to ASSERT that r13/r14 were equal to frame's bcp/locals
 296   // but since they may not have been saved (and we don't want to
 297   // save them here (see note above) the assert is invalid.
 298 }
 299 
 300 void InterpreterMacroAssembler::call_VM_base(Register oop_result,
 301                                              Register last_java_sp,
 302                                              address  entry_point,
 303                                              int      number_of_arguments,
 304                                              bool     check_exceptions) {
 305   // interpreter specific
 306   //
 307   // Note: Could avoid restoring locals ptr (callee saved) - however doesn't
 308   //       really make a difference for these runtime calls, since they are
 309   //       slow anyway. Btw., bcp must be saved/restored since it may change
 310   //       due to GC.
 311   save_bcp();
 312 #ifdef ASSERT
 313   {
 314     Label L;
 315     cmpptr(Address(rbp, frame::interpreter_frame_last_sp_offset * wordSize), NULL_WORD);
 316     jcc(Assembler::equal, L);
 317     stop("InterpreterMacroAssembler::call_VM_base:"
 318          " last_sp isn't null");
 319     bind(L);
 320   }
 321 #endif /* ASSERT */
 322   // super call
 323   MacroAssembler::call_VM_base(oop_result, last_java_sp,
 324                                entry_point, number_of_arguments,
 325                                check_exceptions);
 326   // interpreter specific
 327   restore_bcp();
 328   restore_locals();
 329 }
 330 
 331 void InterpreterMacroAssembler::call_VM_preemptable_helper(Register oop_result,
 332                                                            address entry_point,
 333                                                            int number_of_arguments,
 334                                                            bool check_exceptions) {
 335   assert(InterpreterRuntime::is_preemptable_call(entry_point), "VM call not preemptable, should use call_VM()");
 336   Label resume_pc, not_preempted;
 337 
 338 #ifdef ASSERT
 339   {
 340     Label L1, L2;
 341     cmpptr(Address(r15_thread, JavaThread::preempt_alternate_return_offset()), NULL_WORD);
 342     jcc(Assembler::equal, L1);
 343     stop("call_VM_preemptable_helper: should not have alternate return address set");
 344     bind(L1);
 345     // We check this counter in patch_return_pc_with_preempt_stub() during freeze.
 346     incrementl(Address(r15_thread, JavaThread::interp_at_preemptable_vmcall_cnt_offset()));
 347     cmpl(Address(r15_thread, JavaThread::interp_at_preemptable_vmcall_cnt_offset()), 0);
 348     jcc(Assembler::greater, L2);
 349     stop("call_VM_preemptable_helper: should be > 0");
 350     bind(L2);
 351   }
 352 #endif /* ASSERT */
 353 
 354   // Force freeze slow path.
 355   push_cont_fastpath();
 356 
 357   // Make VM call. In case of preemption set last_pc to the one we want to resume to.
 358   lea(rscratch1, resume_pc);
 359   push(rscratch1);
 360   lea(rax, Address(rsp, wordSize));
 361   call_VM_base(noreg, rax, entry_point, number_of_arguments, false);
 362   pop(rscratch1);
 363 
 364   pop_cont_fastpath();
 365 
 366 #ifdef ASSERT
 367   {
 368     Label L;
 369     decrementl(Address(r15_thread, JavaThread::interp_at_preemptable_vmcall_cnt_offset()));
 370     cmpl(Address(r15_thread, JavaThread::interp_at_preemptable_vmcall_cnt_offset()), 0);
 371     jcc(Assembler::greaterEqual, L);
 372     stop("call_VM_preemptable_helper: should be >= 0");
 373     bind(L);
 374   }
 375 #endif /* ASSERT */
 376 
 377   // Check if preempted.
 378   movptr(rscratch1, Address(r15_thread, JavaThread::preempt_alternate_return_offset()));
 379   cmpptr(rscratch1, NULL_WORD);
 380   jccb(Assembler::zero, not_preempted);
 381   movptr(Address(r15_thread, JavaThread::preempt_alternate_return_offset()), NULL_WORD);
 382   jmp(rscratch1);
 383 
 384   // In case of preemption, this is where we will resume once we finally acquire the monitor.
 385   bind(resume_pc);
 386   restore_after_resume(false /* is_native */);
 387 
 388   bind(not_preempted);
 389   if (check_exceptions) {
 390     // check for pending exceptions
 391     cmpptr(Address(r15_thread, Thread::pending_exception_offset()), NULL_WORD);
 392     Label ok;
 393     jcc(Assembler::equal, ok);
 394     // Exception stub expects return pc to be at top of stack. We only need
 395     // it to check Interpreter::contains(return_address) so anything will do.
 396     lea(rscratch1, resume_pc);
 397     push(rscratch1);
 398     jump(RuntimeAddress(StubRoutines::forward_exception_entry()));
 399     bind(ok);
 400   }
 401 
 402   // get oop result if there is one and reset the value in the thread
 403   if (oop_result->is_valid()) {
 404     get_vm_result_oop(oop_result);
 405   }
 406 }
 407 
 408 static void pass_arg1(MacroAssembler* masm, Register arg) {
 409   if (c_rarg1 != arg ) {
 410     masm->mov(c_rarg1, arg);
 411   }
 412 }
 413 
 414 static void pass_arg2(MacroAssembler* masm, Register arg) {
 415   if (c_rarg2 != arg ) {
 416     masm->mov(c_rarg2, arg);
 417   }
 418 }
 419 
 420 void InterpreterMacroAssembler::call_VM_preemptable(Register oop_result,
 421                                          address entry_point,
 422                                          Register arg_1,
 423                                          bool check_exceptions) {
 424   pass_arg1(this, arg_1);
 425   call_VM_preemptable_helper(oop_result, entry_point, 1, check_exceptions);
 426 }
 427 
 428 void InterpreterMacroAssembler::call_VM_preemptable(Register oop_result,
 429                                          address entry_point,
 430                                          Register arg_1,
 431                                          Register arg_2,
 432                                          bool check_exceptions) {
 433   LP64_ONLY(assert_different_registers(arg_1, c_rarg2));
 434   pass_arg2(this, arg_2);
 435   pass_arg1(this, arg_1);
 436   call_VM_preemptable_helper(oop_result, entry_point, 2, check_exceptions);
 437 }
 438 
 439 void InterpreterMacroAssembler::restore_after_resume(bool is_native) {
 440   lea(rscratch1, ExternalAddress(Interpreter::cont_resume_interpreter_adapter()));
 441   call(rscratch1);
 442   if (is_native) {
 443     // On resume we need to set up stack as expected.
 444     push(dtos);
 445     push(ltos);
 446   }
 447 }
 448 
 449 void InterpreterMacroAssembler::check_and_handle_popframe() {
 450   if (JvmtiExport::can_pop_frame()) {
 451     Label L;
 452     // Initiate popframe handling only if it is not already being
 453     // processed.  If the flag has the popframe_processing bit set, it
 454     // means that this code is called *during* popframe handling - we
 455     // don't want to reenter.
 456     // This method is only called just after the call into the vm in
 457     // call_VM_base, so the arg registers are available.
 458     Register pop_cond = c_rarg0;
 459     movl(pop_cond, Address(r15_thread, JavaThread::popframe_condition_offset()));
 460     testl(pop_cond, JavaThread::popframe_pending_bit);
 461     jcc(Assembler::zero, L);
 462     testl(pop_cond, JavaThread::popframe_processing_bit);
 463     jcc(Assembler::notZero, L);
 464     // Call Interpreter::remove_activation_preserving_args_entry() to get the
 465     // address of the same-named entrypoint in the generated interpreter code.
 466     call_VM_leaf(CAST_FROM_FN_PTR(address, Interpreter::remove_activation_preserving_args_entry));
 467     jmp(rax);
 468     bind(L);
 469   }
 470 }
 471 
 472 void InterpreterMacroAssembler::load_earlyret_value(TosState state) {
 473   movptr(rcx, Address(r15_thread, JavaThread::jvmti_thread_state_offset()));
 474   const Address tos_addr(rcx, JvmtiThreadState::earlyret_tos_offset());
 475   const Address oop_addr(rcx, JvmtiThreadState::earlyret_oop_offset());
 476   const Address val_addr(rcx, JvmtiThreadState::earlyret_value_offset());
 477 
 478   switch (state) {
 479     case atos: movptr(rax, oop_addr);
 480                movptr(oop_addr, NULL_WORD);
 481                interp_verify_oop(rax, state);         break;
 482     case ltos: movptr(rax, val_addr);                 break;
 483     case btos:                                   // fall through
 484     case ztos:                                   // fall through
 485     case ctos:                                   // fall through
 486     case stos:                                   // fall through
 487     case itos: movl(rax, val_addr);                 break;
 488     case ftos: movflt(xmm0, val_addr);              break;
 489     case dtos: movdbl(xmm0, val_addr);              break;
 490     case vtos: /* nothing to do */                  break;
 491     default  : ShouldNotReachHere();
 492   }
 493 
 494   // Clean up tos value in the thread object
 495   movl(tos_addr, ilgl);
 496   movptr(val_addr, NULL_WORD);
 497 }
 498 
 499 
 500 void InterpreterMacroAssembler::check_and_handle_earlyret() {
 501   if (JvmtiExport::can_force_early_return()) {
 502     Label L;
 503     Register tmp = c_rarg0;
 504     Register rthread = r15_thread;
 505 
 506     movptr(tmp, Address(rthread, JavaThread::jvmti_thread_state_offset()));
 507     testptr(tmp, tmp);
 508     jcc(Assembler::zero, L); // if (thread->jvmti_thread_state() == nullptr) exit;
 509 
 510     // Initiate earlyret handling only if it is not already being processed.
 511     // If the flag has the earlyret_processing bit set, it means that this code
 512     // is called *during* earlyret handling - we don't want to reenter.
 513     movl(tmp, Address(tmp, JvmtiThreadState::earlyret_state_offset()));
 514     cmpl(tmp, JvmtiThreadState::earlyret_pending);
 515     jcc(Assembler::notEqual, L);
 516 
 517     // Call Interpreter::remove_activation_early_entry() to get the address of the
 518     // same-named entrypoint in the generated interpreter code.
 519     movptr(tmp, Address(rthread, JavaThread::jvmti_thread_state_offset()));
 520     movl(tmp, Address(tmp, JvmtiThreadState::earlyret_tos_offset()));
 521     call_VM_leaf(CAST_FROM_FN_PTR(address, Interpreter::remove_activation_early_entry), tmp);
 522     jmp(rax);
 523     bind(L);
 524   }
 525 }
 526 
 527 void InterpreterMacroAssembler::get_unsigned_2_byte_index_at_bcp(Register reg, int bcp_offset) {
 528   assert(bcp_offset >= 0, "bcp is still pointing to start of bytecode");
 529   load_unsigned_short(reg, Address(_bcp_register, bcp_offset));
 530   bswapl(reg);
 531   shrl(reg, 16);
 532 }
 533 
 534 void InterpreterMacroAssembler::get_cache_index_at_bcp(Register index,
 535                                                        int bcp_offset,
 536                                                        size_t index_size) {
 537   assert(bcp_offset > 0, "bcp is still pointing to start of bytecode");
 538   if (index_size == sizeof(u2)) {
 539     load_unsigned_short(index, Address(_bcp_register, bcp_offset));
 540   } else if (index_size == sizeof(u4)) {
 541     movl(index, Address(_bcp_register, bcp_offset));
 542   } else if (index_size == sizeof(u1)) {
 543     load_unsigned_byte(index, Address(_bcp_register, bcp_offset));
 544   } else {
 545     ShouldNotReachHere();
 546   }
 547 }
 548 
 549 // Load object from cpool->resolved_references(index)
 550 void InterpreterMacroAssembler::load_resolved_reference_at_index(Register result,
 551                                                                  Register index,
 552                                                                  Register tmp) {
 553   assert_different_registers(result, index);
 554 
 555   get_constant_pool(result);
 556   // load pointer for resolved_references[] objArray
 557   movptr(result, Address(result, ConstantPool::cache_offset()));
 558   movptr(result, Address(result, ConstantPoolCache::resolved_references_offset()));
 559   resolve_oop_handle(result, tmp);
 560   load_heap_oop(result, Address(result, index,
 561                                 UseCompressedOops ? Address::times_4 : Address::times_ptr,
 562                                 arrayOopDesc::base_offset_in_bytes(T_OBJECT)), tmp);
 563 }
 564 
 565 // load cpool->resolved_klass_at(index)
 566 void InterpreterMacroAssembler::load_resolved_klass_at_index(Register klass,
 567                                                              Register cpool,
 568                                                              Register index) {
 569   assert_different_registers(cpool, index);
 570 
 571   movw(index, Address(cpool, index, Address::times_ptr, sizeof(ConstantPool)));
 572   Register resolved_klasses = cpool;
 573   movptr(resolved_klasses, Address(cpool, ConstantPool::resolved_klasses_offset()));
 574   movptr(klass, Address(resolved_klasses, index, Address::times_ptr, Array<Klass*>::base_offset_in_bytes()));
 575 }
 576 
 577 // Generate a subtype check: branch to ok_is_subtype if sub_klass is a
 578 // subtype of super_klass.
 579 //
 580 // Args:
 581 //      rax: superklass
 582 //      Rsub_klass: subklass
 583 //
 584 // Kills:
 585 //      rcx
 586 void InterpreterMacroAssembler::gen_subtype_check(Register Rsub_klass,
 587                                                   Label& ok_is_subtype,
 588                                                   bool profile) {
 589   assert(Rsub_klass != rax, "rax holds superklass");
 590   assert(Rsub_klass != r14, "r14 holds locals");
 591   assert(Rsub_klass != r13, "r13 holds bcp");
 592   assert(Rsub_klass != rcx, "rcx holds 2ndary super array length");
 593 
 594   // Profile the not-null value's klass.
 595   if (profile) {
 596     profile_typecheck(rcx, Rsub_klass); // blows rcx
 597   }
 598   // Do the check.
 599   check_klass_subtype(Rsub_klass, rax, rcx, ok_is_subtype); // blows rcx
 600 }
 601 
 602 
 603 // Java Expression Stack
 604 
 605 void InterpreterMacroAssembler::pop_ptr(Register r) {
 606   pop(r);
 607 }
 608 
 609 void InterpreterMacroAssembler::push_ptr(Register r) {
 610   push(r);
 611 }
 612 
 613 void InterpreterMacroAssembler::push_i(Register r) {
 614   push(r);
 615 }
 616 
 617 void InterpreterMacroAssembler::push_i_or_ptr(Register r) {
 618   push(r);
 619 }
 620 
 621 void InterpreterMacroAssembler::push_f(XMMRegister r) {
 622   subptr(rsp, wordSize);
 623   movflt(Address(rsp, 0), r);
 624 }
 625 
 626 void InterpreterMacroAssembler::pop_f(XMMRegister r) {
 627   movflt(r, Address(rsp, 0));
 628   addptr(rsp, wordSize);
 629 }
 630 
 631 void InterpreterMacroAssembler::push_d(XMMRegister r) {
 632   subptr(rsp, 2 * wordSize);
 633   movdbl(Address(rsp, 0), r);
 634 }
 635 
 636 void InterpreterMacroAssembler::pop_d(XMMRegister r) {
 637   movdbl(r, Address(rsp, 0));
 638   addptr(rsp, 2 * Interpreter::stackElementSize);
 639 }
 640 
 641 void InterpreterMacroAssembler::pop_i(Register r) {
 642   // XXX can't use pop currently, upper half non clean
 643   movl(r, Address(rsp, 0));
 644   addptr(rsp, wordSize);
 645 }
 646 
 647 void InterpreterMacroAssembler::pop_l(Register r) {
 648   movq(r, Address(rsp, 0));
 649   addptr(rsp, 2 * Interpreter::stackElementSize);
 650 }
 651 
 652 void InterpreterMacroAssembler::push_l(Register r) {
 653   subptr(rsp, 2 * wordSize);
 654   movptr(Address(rsp, Interpreter::expr_offset_in_bytes(0)), r         );
 655   movptr(Address(rsp, Interpreter::expr_offset_in_bytes(1)), NULL_WORD );
 656 }
 657 
 658 void InterpreterMacroAssembler::pop(TosState state) {
 659   switch (state) {
 660   case atos: pop_ptr();                 break;
 661   case btos:
 662   case ztos:
 663   case ctos:
 664   case stos:
 665   case itos: pop_i();                   break;
 666   case ltos: pop_l();                   break;
 667   case ftos: pop_f(xmm0);               break;
 668   case dtos: pop_d(xmm0);               break;
 669   case vtos: /* nothing to do */        break;
 670   default:   ShouldNotReachHere();
 671   }
 672   interp_verify_oop(rax, state);
 673 }
 674 
 675 void InterpreterMacroAssembler::push(TosState state) {
 676   interp_verify_oop(rax, state);
 677   switch (state) {
 678   case atos: push_ptr();                break;
 679   case btos:
 680   case ztos:
 681   case ctos:
 682   case stos:
 683   case itos: push_i();                  break;
 684   case ltos: push_l();                  break;
 685   case ftos: push_f(xmm0);              break;
 686   case dtos: push_d(xmm0);              break;
 687   case vtos: /* nothing to do */        break;
 688   default  : ShouldNotReachHere();
 689   }
 690 }
 691 
 692 // Helpers for swap and dup
 693 void InterpreterMacroAssembler::load_ptr(int n, Register val) {
 694   movptr(val, Address(rsp, Interpreter::expr_offset_in_bytes(n)));
 695 }
 696 
 697 void InterpreterMacroAssembler::store_ptr(int n, Register val) {
 698   movptr(Address(rsp, Interpreter::expr_offset_in_bytes(n)), val);
 699 }
 700 
 701 
 702 void InterpreterMacroAssembler::prepare_to_jump_from_interpreted() {
 703   // set sender sp
 704   lea(_bcp_register, Address(rsp, wordSize));
 705   // record last_sp
 706   mov(rcx, _bcp_register);
 707   subptr(rcx, rbp);
 708   sarptr(rcx, LogBytesPerWord);
 709   movptr(Address(rbp, frame::interpreter_frame_last_sp_offset * wordSize), rcx);
 710 }
 711 
 712 
 713 // Jump to from_interpreted entry of a call unless single stepping is possible
 714 // in this thread in which case we must call the i2i entry
 715 void InterpreterMacroAssembler::jump_from_interpreted(Register method, Register temp) {
 716   prepare_to_jump_from_interpreted();
 717 
 718   if (JvmtiExport::can_post_interpreter_events()) {
 719     Label run_compiled_code;
 720     // JVMTI events, such as single-stepping, are implemented partly by avoiding running
 721     // compiled code in threads for which the event is enabled.  Check here for
 722     // interp_only_mode if these events CAN be enabled.
 723     // interp_only is an int, on little endian it is sufficient to test the byte only
 724     // Is a cmpl faster?
 725     cmpb(Address(r15_thread, JavaThread::interp_only_mode_offset()), 0);
 726     jccb(Assembler::zero, run_compiled_code);
 727     jmp(Address(method, Method::interpreter_entry_offset()));
 728     bind(run_compiled_code);
 729   }
 730 
 731   jmp(Address(method, Method::from_interpreted_offset()));
 732 }
 733 
 734 // The following two routines provide a hook so that an implementation
 735 // can schedule the dispatch in two parts.  x86 does not do this.
 736 void InterpreterMacroAssembler::dispatch_prolog(TosState state, int step) {
 737   // Nothing x86 specific to be done here
 738 }
 739 
 740 void InterpreterMacroAssembler::dispatch_epilog(TosState state, int step) {
 741   dispatch_next(state, step);
 742 }
 743 
 744 void InterpreterMacroAssembler::dispatch_base(TosState state,
 745                                               address* table,
 746                                               bool verifyoop,
 747                                               bool generate_poll) {
 748   if (VerifyActivationFrameSize) {
 749     Label L;
 750     mov(rcx, rbp);
 751     subptr(rcx, rsp);
 752     int32_t min_frame_size =
 753       (frame::link_offset - frame::interpreter_frame_initial_sp_offset) *
 754       wordSize;
 755     cmpptr(rcx, min_frame_size);
 756     jcc(Assembler::greaterEqual, L);
 757     stop("broken stack frame");
 758     bind(L);
 759   }
 760   if (verifyoop) {
 761     interp_verify_oop(rax, state);
 762   }
 763 
 764   address* const safepoint_table = Interpreter::safept_table(state);
 765   Label no_safepoint, dispatch;
 766   if (table != safepoint_table && generate_poll) {
 767     NOT_PRODUCT(block_comment("Thread-local Safepoint poll"));
 768     testb(Address(r15_thread, JavaThread::polling_word_offset()), SafepointMechanism::poll_bit());
 769 
 770     jccb(Assembler::zero, no_safepoint);
 771     lea(rscratch1, ExternalAddress((address)safepoint_table));
 772     jmpb(dispatch);
 773   }
 774 
 775   bind(no_safepoint);
 776   lea(rscratch1, ExternalAddress((address)table));
 777   bind(dispatch);
 778   jmp(Address(rscratch1, rbx, Address::times_8));
 779 }
 780 
 781 void InterpreterMacroAssembler::dispatch_only(TosState state, bool generate_poll) {
 782   dispatch_base(state, Interpreter::dispatch_table(state), true, generate_poll);
 783 }
 784 
 785 void InterpreterMacroAssembler::dispatch_only_normal(TosState state) {
 786   dispatch_base(state, Interpreter::normal_table(state));
 787 }
 788 
 789 void InterpreterMacroAssembler::dispatch_only_noverify(TosState state) {
 790   dispatch_base(state, Interpreter::normal_table(state), false);
 791 }
 792 
 793 
 794 void InterpreterMacroAssembler::dispatch_next(TosState state, int step, bool generate_poll) {
 795   // load next bytecode (load before advancing _bcp_register to prevent AGI)
 796   load_unsigned_byte(rbx, Address(_bcp_register, step));
 797   // advance _bcp_register
 798   increment(_bcp_register, step);
 799   dispatch_base(state, Interpreter::dispatch_table(state), true, generate_poll);
 800 }
 801 
 802 void InterpreterMacroAssembler::dispatch_via(TosState state, address* table) {
 803   // load current bytecode
 804   load_unsigned_byte(rbx, Address(_bcp_register, 0));
 805   dispatch_base(state, table);
 806 }
 807 
 808 void InterpreterMacroAssembler::narrow(Register result) {
 809 
 810   // Get method->_constMethod->_result_type
 811   movptr(rcx, Address(rbp, frame::interpreter_frame_method_offset * wordSize));
 812   movptr(rcx, Address(rcx, Method::const_offset()));
 813   load_unsigned_byte(rcx, Address(rcx, ConstMethod::result_type_offset()));
 814 
 815   Label done, notBool, notByte, notChar;
 816 
 817   // common case first
 818   cmpl(rcx, T_INT);
 819   jcc(Assembler::equal, done);
 820 
 821   // mask integer result to narrower return type.
 822   cmpl(rcx, T_BOOLEAN);
 823   jcc(Assembler::notEqual, notBool);
 824   andl(result, 0x1);
 825   jmp(done);
 826 
 827   bind(notBool);
 828   cmpl(rcx, T_BYTE);
 829   jcc(Assembler::notEqual, notByte);
 830   movsbl(result, result);
 831   jmp(done);
 832 
 833   bind(notByte);
 834   cmpl(rcx, T_CHAR);
 835   jcc(Assembler::notEqual, notChar);
 836   movzwl(result, result);
 837   jmp(done);
 838 
 839   bind(notChar);
 840   // cmpl(rcx, T_SHORT);  // all that's left
 841   // jcc(Assembler::notEqual, done);
 842   movswl(result, result);
 843 
 844   // Nothing to do for T_INT
 845   bind(done);
 846 }
 847 
 848 // remove activation
 849 //
 850 // Unlock the receiver if this is a synchronized method.
 851 // Unlock any Java monitors from synchronized blocks.
 852 // Apply stack watermark barrier.
 853 // Notify JVMTI.
 854 // Remove the activation from the stack.
 855 //
 856 // If there are locked Java monitors
 857 //    If throw_monitor_exception
 858 //       throws IllegalMonitorStateException
 859 //    Else if install_monitor_exception
 860 //       installs IllegalMonitorStateException
 861 //    Else
 862 //       no error processing
 863 void InterpreterMacroAssembler::remove_activation(TosState state,
 864                                                   Register ret_addr,
 865                                                   bool throw_monitor_exception,
 866                                                   bool install_monitor_exception,
 867                                                   bool notify_jvmdi) {
 868   // Note: Registers rdx xmm0 may be in use for the
 869   // result check if synchronized method
 870   Label unlocked, unlock, no_unlock;
 871 
 872 #ifdef ASSERT
 873   Label not_preempted;
 874   cmpptr(Address(r15_thread, JavaThread::preempt_alternate_return_offset()), NULL_WORD);
 875   jcc(Assembler::equal, not_preempted);
 876   stop("remove_activation: should not have alternate return address set");
 877   bind(not_preempted);
 878 #endif /* ASSERT */
 879 
 880   const Register rthread = r15_thread;
 881   const Register robj    = c_rarg1;
 882   const Register rmon    = c_rarg1;
 883 
 884   // get the value of _do_not_unlock_if_synchronized into rdx
 885   const Address do_not_unlock_if_synchronized(rthread,
 886     in_bytes(JavaThread::do_not_unlock_if_synchronized_offset()));
 887   movbool(rbx, do_not_unlock_if_synchronized);
 888   movbool(do_not_unlock_if_synchronized, false); // reset the flag
 889 
 890   // get method access flags
 891   movptr(rcx, Address(rbp, frame::interpreter_frame_method_offset * wordSize));
 892   load_unsigned_short(rcx, Address(rcx, Method::access_flags_offset()));
 893   testl(rcx, JVM_ACC_SYNCHRONIZED);
 894   jcc(Assembler::zero, unlocked);
 895 
 896   // Don't unlock anything if the _do_not_unlock_if_synchronized flag
 897   // is set.
 898   testbool(rbx);
 899   jcc(Assembler::notZero, no_unlock);
 900 
 901   // unlock monitor
 902   push(state); // save result
 903 
 904   // BasicObjectLock will be first in list, since this is a
 905   // synchronized method. However, need to check that the object has
 906   // not been unlocked by an explicit monitorexit bytecode.
 907   const Address monitor(rbp, frame::interpreter_frame_initial_sp_offset *
 908                         wordSize - (int) sizeof(BasicObjectLock));
 909   // We use c_rarg1/rdx so that if we go slow path it will be the correct
 910   // register for unlock_object to pass to VM directly
 911   lea(robj, monitor); // address of first monitor
 912 
 913   movptr(rax, Address(robj, BasicObjectLock::obj_offset()));
 914   testptr(rax, rax);
 915   jcc(Assembler::notZero, unlock);
 916 
 917   pop(state);
 918   if (throw_monitor_exception) {
 919     // Entry already unlocked, need to throw exception
 920     call_VM(noreg, CAST_FROM_FN_PTR(address,
 921                    InterpreterRuntime::throw_illegal_monitor_state_exception));
 922     should_not_reach_here();
 923   } else {
 924     // Monitor already unlocked during a stack unroll. If requested,
 925     // install an illegal_monitor_state_exception.  Continue with
 926     // stack unrolling.
 927     if (install_monitor_exception) {
 928       call_VM(noreg, CAST_FROM_FN_PTR(address,
 929                      InterpreterRuntime::new_illegal_monitor_state_exception));
 930     }
 931     jmp(unlocked);
 932   }
 933 
 934   bind(unlock);
 935   unlock_object(robj);
 936   pop(state);
 937 
 938   // Check that for block-structured locking (i.e., that all locked
 939   // objects has been unlocked)
 940   bind(unlocked);
 941 
 942   // rax, rdx: Might contain return value
 943 
 944   // Check that all monitors are unlocked
 945   {
 946     Label loop, exception, entry, restart;
 947     const int entry_size = frame::interpreter_frame_monitor_size_in_bytes();
 948     const Address monitor_block_top(
 949         rbp, frame::interpreter_frame_monitor_block_top_offset * wordSize);
 950     const Address monitor_block_bot(
 951         rbp, frame::interpreter_frame_initial_sp_offset * wordSize);
 952 
 953     bind(restart);
 954     // We use c_rarg1 so that if we go slow path it will be the correct
 955     // register for unlock_object to pass to VM directly
 956     movptr(rmon, monitor_block_top); // derelativize pointer
 957     lea(rmon, Address(rbp, rmon, Address::times_ptr));
 958     // c_rarg1 points to current entry, starting with top-most entry
 959 
 960     lea(rbx, monitor_block_bot);  // points to word before bottom of
 961                                   // monitor block
 962     jmp(entry);
 963 
 964     // Entry already locked, need to throw exception
 965     bind(exception);
 966 
 967     if (throw_monitor_exception) {
 968       // Throw exception
 969       MacroAssembler::call_VM(noreg,
 970                               CAST_FROM_FN_PTR(address, InterpreterRuntime::
 971                                    throw_illegal_monitor_state_exception));
 972       should_not_reach_here();
 973     } else {
 974       // Stack unrolling. Unlock object and install illegal_monitor_exception.
 975       // Unlock does not block, so don't have to worry about the frame.
 976       // We don't have to preserve c_rarg1 since we are going to throw an exception.
 977 
 978       push(state);
 979       mov(robj, rmon);   // nop if robj and rmon are the same
 980       unlock_object(robj);
 981       pop(state);
 982 
 983       if (install_monitor_exception) {
 984         call_VM(noreg, CAST_FROM_FN_PTR(address,
 985                                         InterpreterRuntime::
 986                                         new_illegal_monitor_state_exception));
 987       }
 988 
 989       jmp(restart);
 990     }
 991 
 992     bind(loop);
 993     // check if current entry is used
 994     cmpptr(Address(rmon, BasicObjectLock::obj_offset()), NULL_WORD);
 995     jcc(Assembler::notEqual, exception);
 996 
 997     addptr(rmon, entry_size); // otherwise advance to next entry
 998     bind(entry);
 999     cmpptr(rmon, rbx); // check if bottom reached
1000     jcc(Assembler::notEqual, loop); // if not at bottom then check this entry
1001   }
1002 
1003   bind(no_unlock);
1004 
1005   JFR_ONLY(enter_jfr_critical_section();)
1006 
1007   // The below poll is for the stack watermark barrier. It allows fixing up frames lazily,
1008   // that would normally not be safe to use. Such bad returns into unsafe territory of
1009   // the stack, will call InterpreterRuntime::at_unwind.
1010   Label slow_path;
1011   Label fast_path;
1012   safepoint_poll(slow_path, true /* at_return */, false /* in_nmethod */);
1013   jmp(fast_path);
1014   bind(slow_path);
1015   push(state);
1016   set_last_Java_frame(noreg, rbp, (address)pc(), rscratch1);
1017   super_call_VM_leaf(CAST_FROM_FN_PTR(address, InterpreterRuntime::at_unwind), r15_thread);
1018   reset_last_Java_frame(true);
1019   pop(state);
1020   bind(fast_path);
1021 
1022   // JVMTI support. Make sure the safepoint poll test is issued prior.
1023   if (notify_jvmdi) {
1024     notify_method_exit(state, NotifyJVMTI);    // preserve TOSCA
1025   } else {
1026     notify_method_exit(state, SkipNotifyJVMTI); // preserve TOSCA
1027   }
1028 
1029   if (StackReservedPages > 0) {
1030     movptr(rbx,
1031                Address(rbp, frame::interpreter_frame_sender_sp_offset * wordSize));
1032     // testing if reserved zone needs to be re-enabled
1033     Register rthread = r15_thread;
1034     Label no_reserved_zone_enabling;
1035 
1036     // check if already enabled - if so no re-enabling needed
1037     assert(sizeof(StackOverflow::StackGuardState) == 4, "unexpected size");
1038     cmpl(Address(rthread, JavaThread::stack_guard_state_offset()), StackOverflow::stack_guard_enabled);
1039     jcc(Assembler::equal, no_reserved_zone_enabling);
1040 
1041     cmpptr(rbx, Address(rthread, JavaThread::reserved_stack_activation_offset()));
1042     jcc(Assembler::lessEqual, no_reserved_zone_enabling);
1043 
1044     JFR_ONLY(leave_jfr_critical_section();)
1045 
1046     call_VM_leaf(
1047       CAST_FROM_FN_PTR(address, SharedRuntime::enable_stack_reserved_zone), rthread);
1048     call_VM(noreg, CAST_FROM_FN_PTR(address,
1049                    InterpreterRuntime::throw_delayed_StackOverflowError));
1050     should_not_reach_here();
1051 
1052     bind(no_reserved_zone_enabling);
1053   }
1054 
1055   // remove activation
1056   // get sender sp
1057   movptr(rbx,
1058          Address(rbp, frame::interpreter_frame_sender_sp_offset * wordSize));
1059 
1060   if (state == atos && InlineTypeReturnedAsFields) {
1061     Label skip;
1062     Label not_null;
1063     testptr(rax, rax);
1064     jcc(Assembler::notZero, not_null);
1065     // Returned value is null, zero all return registers because they may belong to oop fields
1066     xorq(j_rarg1, j_rarg1);
1067     xorq(j_rarg2, j_rarg2);
1068     xorq(j_rarg3, j_rarg3);
1069     xorq(j_rarg4, j_rarg4);
1070     xorq(j_rarg5, j_rarg5);
1071     jmp(skip);
1072     bind(not_null);
1073 
1074     // Check if we are returning an non-null inline type and load its fields into registers
1075     test_oop_is_not_inline_type(rax, rscratch1, skip, /* can_be_null= */ false);
1076 
1077 #ifndef _LP64
1078     super_call_VM_leaf(StubRoutines::load_inline_type_fields_in_regs());
1079 #else
1080     // Load fields from a buffered value with an inline class specific handler
1081     load_klass(rdi, rax, rscratch1);
1082     movptr(rdi, Address(rdi, InlineKlass::adr_members_offset()));
1083     movptr(rdi, Address(rdi, InlineKlass::unpack_handler_offset()));
1084     // Unpack handler can be null if inline type is not scalarizable in returns
1085     testptr(rdi, rdi);
1086     jcc(Assembler::zero, skip);
1087     call(rdi);
1088 #endif
1089 #ifdef ASSERT
1090     // TODO 8284443 Enable
1091     if (StressCallingConvention && false) {
1092       Label skip_stress;
1093       movptr(rscratch1, Address(rbp, frame::interpreter_frame_method_offset * wordSize));
1094       movl(rscratch1, Address(rscratch1, Method::flags_offset()));
1095       testl(rcx, MethodFlags::has_scalarized_return_flag());
1096       jcc(Assembler::zero, skip_stress);
1097       load_klass(rax, rax, rscratch1);
1098       orptr(rax, 1);
1099       bind(skip_stress);
1100     }
1101 #endif
1102     // call above kills the value in rbx. Reload it.
1103     movptr(rbx, Address(rbp, frame::interpreter_frame_sender_sp_offset * wordSize));
1104     bind(skip);
1105   }
1106 
1107   leave();                           // remove frame anchor
1108 
1109   JFR_ONLY(leave_jfr_critical_section();)
1110 
1111   pop(ret_addr);                     // get return address
1112   mov(rsp, rbx);                     // set sp to sender sp
1113   pop_cont_fastpath();
1114 
1115 }
1116 
1117 #if INCLUDE_JFR
1118 void InterpreterMacroAssembler::enter_jfr_critical_section() {
1119   const Address sampling_critical_section(r15_thread, in_bytes(SAMPLING_CRITICAL_SECTION_OFFSET_JFR));
1120   movbool(sampling_critical_section, true);
1121 }
1122 
1123 void InterpreterMacroAssembler::leave_jfr_critical_section() {
1124   const Address sampling_critical_section(r15_thread, in_bytes(SAMPLING_CRITICAL_SECTION_OFFSET_JFR));
1125   movbool(sampling_critical_section, false);
1126 }
1127 #endif // INCLUDE_JFR
1128 
1129 void InterpreterMacroAssembler::get_method_counters(Register method,
1130                                                     Register mcs, Label& skip) {
1131   Label has_counters;
1132   movptr(mcs, Address(method, Method::method_counters_offset()));
1133   testptr(mcs, mcs);
1134   jcc(Assembler::notZero, has_counters);
1135   call_VM(noreg, CAST_FROM_FN_PTR(address,
1136           InterpreterRuntime::build_method_counters), method);
1137   movptr(mcs, Address(method,Method::method_counters_offset()));
1138   testptr(mcs, mcs);
1139   jcc(Assembler::zero, skip); // No MethodCounters allocated, OutOfMemory
1140   bind(has_counters);
1141 }
1142 
1143 void InterpreterMacroAssembler::allocate_instance(Register klass, Register new_obj,
1144                                                   Register t1, Register t2,
1145                                                   bool clear_fields, Label& alloc_failed) {
1146   MacroAssembler::allocate_instance(klass, new_obj, t1, t2, clear_fields, alloc_failed);
1147   if (DTraceAllocProbes) {
1148     // Trigger dtrace event for fastpath
1149     push(atos);
1150     call_VM_leaf(CAST_FROM_FN_PTR(address, static_cast<int (*)(oopDesc*)>(SharedRuntime::dtrace_object_alloc)), new_obj);
1151     pop(atos);
1152   }
1153 }
1154 
1155 void InterpreterMacroAssembler::read_flat_field(Register entry, Register tmp1, Register tmp2, Register obj) {
1156   Label alloc_failed, slow_path, done;
1157   const Register alloc_temp = LP64_ONLY(rscratch1) NOT_LP64(rsi);
1158   const Register dst_temp   = LP64_ONLY(rscratch2) NOT_LP64(rdi);
1159   assert_different_registers(obj, entry, tmp1, tmp2, dst_temp, r8, r9);
1160 
1161   // If the field is nullable, jump to slow path
1162   load_unsigned_byte(tmp1, Address(entry, in_bytes(ResolvedFieldEntry::flags_offset())));
1163   testl(tmp1, 1 << ResolvedFieldEntry::is_null_free_inline_type_shift);
1164   jcc(Assembler::equal, slow_path);
1165 
1166   // Grap the inline field klass
1167   const Register field_klass = tmp1;
1168   load_unsigned_short(tmp2, Address(entry, in_bytes(ResolvedFieldEntry::field_index_offset())));
1169 
1170   movptr(tmp1, Address(entry, ResolvedFieldEntry::field_holder_offset()));
1171   get_inline_type_field_klass(tmp1, tmp2, field_klass);
1172 
1173   // allocate buffer
1174   push(obj);  // push object being read from
1175   allocate_instance(field_klass, obj, alloc_temp, dst_temp, false, alloc_failed);
1176 
1177   // Have an oop instance buffer, copy into it
1178   load_unsigned_short(r9, Address(entry, in_bytes(ResolvedFieldEntry::field_index_offset())));
1179   movptr(r8, Address(entry, in_bytes(ResolvedFieldEntry::field_holder_offset())));
1180   inline_layout_info(r8, r9, r8); // holder, index, info => InlineLayoutInfo into r8
1181 
1182   payload_addr(obj, dst_temp, field_klass);
1183   pop(alloc_temp);             // restore object being read from
1184   load_sized_value(tmp2, Address(entry, in_bytes(ResolvedFieldEntry::field_offset_offset())), sizeof(int), true /*is_signed*/);
1185   lea(tmp2, Address(alloc_temp, tmp2));
1186   // call_VM_leaf, clobbers a few regs, save restore new obj
1187   push(obj);
1188   flat_field_copy(IS_DEST_UNINITIALIZED, tmp2, dst_temp, r8);
1189   pop(obj);
1190   jmp(done);
1191 
1192   bind(alloc_failed);
1193   pop(obj);
1194   bind(slow_path);
1195   call_VM(noreg, CAST_FROM_FN_PTR(address, InterpreterRuntime::read_flat_field),
1196           obj, entry);
1197   get_vm_result_oop(obj);
1198   bind(done);
1199 }
1200 
1201 void InterpreterMacroAssembler::write_flat_field(Register entry, Register tmp1, Register tmp2,
1202                                                  Register obj, Register off, Register value) {
1203   assert_different_registers(entry, tmp1, tmp2, obj, off, value);
1204 
1205   Label slow_path, done;
1206 
1207   load_unsigned_byte(tmp2, Address(entry, in_bytes(ResolvedFieldEntry::flags_offset())));
1208   test_field_is_not_null_free_inline_type(tmp2, tmp1, slow_path);
1209 
1210   null_check(value); // FIXME JDK-8341120
1211 
1212   lea(obj, Address(obj, off, Address::times_1));
1213 
1214   load_klass(tmp2, value, tmp1);
1215   payload_addr(value, value, tmp2);
1216 
1217   Register idx = tmp1;
1218   load_unsigned_short(idx, Address(entry, in_bytes(ResolvedFieldEntry::field_index_offset())));
1219   movptr(tmp2, Address(entry, in_bytes(ResolvedFieldEntry::field_holder_offset())));
1220 
1221   Register layout_info = off;
1222   inline_layout_info(tmp2, idx, layout_info);
1223 
1224   flat_field_copy(IN_HEAP, value, obj, layout_info);
1225   jmp(done);
1226 
1227   bind(slow_path);
1228   call_VM(noreg, CAST_FROM_FN_PTR(address, InterpreterRuntime::write_flat_field), obj, value, entry);
1229 
1230   bind(done);
1231 }
1232 
1233 // Lock object
1234 //
1235 // Args:
1236 //      rdx, c_rarg1: BasicObjectLock to be used for locking
1237 //
1238 // Kills:
1239 //      rax, rbx
1240 void InterpreterMacroAssembler::lock_object(Register lock_reg) {
1241   assert(lock_reg == c_rarg1, "The argument is only for looks. It must be c_rarg1");
1242 
1243   Label done, slow_case;
1244 
1245   const Register swap_reg = rax; // Must use rax for cmpxchg instruction
1246   const Register tmp_reg = rbx;
1247   const Register obj_reg = c_rarg3; // Will contain the oop
1248 
1249   // Load object pointer into obj_reg
1250   movptr(obj_reg, Address(lock_reg, BasicObjectLock::obj_offset()));
1251 
1252   fast_lock(lock_reg, obj_reg, swap_reg, tmp_reg, slow_case);
1253   jmp(done);
1254 
1255   bind(slow_case);
1256 
1257   // Call the runtime routine for slow case
1258   call_VM_preemptable(noreg,
1259           CAST_FROM_FN_PTR(address, InterpreterRuntime::monitorenter),
1260           lock_reg);
1261   bind(done);
1262 }
1263 
1264 
1265 // Unlocks an object. Used in monitorexit bytecode and
1266 // remove_activation.  Throws an IllegalMonitorException if object is
1267 // not locked by current thread.
1268 //
1269 // Args:
1270 //      rdx, c_rarg1: BasicObjectLock for lock
1271 //
1272 // Kills:
1273 //      rax
1274 //      c_rarg0, c_rarg1, c_rarg2, c_rarg3, ... (param regs)
1275 //      rscratch1 (scratch reg)
1276 // rax, rbx, rcx, rdx
1277 void InterpreterMacroAssembler::unlock_object(Register lock_reg) {
1278   assert(lock_reg == c_rarg1, "The argument is only for looks. It must be c_rarg1");
1279 
1280   Label done, slow_case;
1281 
1282   const Register swap_reg   = rax;  // Must use rax for cmpxchg instruction
1283   const Register header_reg = c_rarg2;  // Will contain the old oopMark
1284   const Register obj_reg    = c_rarg3;  // Will contain the oop
1285 
1286   save_bcp(); // Save in case of exception
1287 
1288   // Load oop into obj_reg(%c_rarg3)
1289   movptr(obj_reg, Address(lock_reg, BasicObjectLock::obj_offset()));
1290 
1291   // Free entry
1292   movptr(Address(lock_reg, BasicObjectLock::obj_offset()), NULL_WORD);
1293 
1294   fast_unlock(obj_reg, swap_reg, header_reg, slow_case);
1295   jmp(done);
1296 
1297   bind(slow_case);
1298   // Call the runtime routine for slow case.
1299   movptr(Address(lock_reg, BasicObjectLock::obj_offset()), obj_reg); // restore obj
1300   call_VM_leaf(CAST_FROM_FN_PTR(address, InterpreterRuntime::monitorexit), lock_reg);
1301 
1302   bind(done);
1303 
1304   restore_bcp();
1305 }
1306 
1307 void InterpreterMacroAssembler::test_method_data_pointer(Register mdp,
1308                                                          Label& zero_continue) {
1309   assert(ProfileInterpreter, "must be profiling interpreter");
1310   movptr(mdp, Address(rbp, frame::interpreter_frame_mdp_offset * wordSize));
1311   testptr(mdp, mdp);
1312   jcc(Assembler::zero, zero_continue);
1313 }
1314 
1315 
1316 // Set the method data pointer for the current bcp.
1317 void InterpreterMacroAssembler::set_method_data_pointer_for_bcp() {
1318   assert(ProfileInterpreter, "must be profiling interpreter");
1319   Label set_mdp;
1320   push(rax);
1321   push(rbx);
1322 
1323   get_method(rbx);
1324   // Test MDO to avoid the call if it is null.
1325   movptr(rax, Address(rbx, in_bytes(Method::method_data_offset())));
1326   testptr(rax, rax);
1327   jcc(Assembler::zero, set_mdp);
1328   // rbx: method
1329   // _bcp_register: bcp
1330   call_VM_leaf(CAST_FROM_FN_PTR(address, InterpreterRuntime::bcp_to_di), rbx, _bcp_register);
1331   // rax: mdi
1332   // mdo is guaranteed to be non-zero here, we checked for it before the call.
1333   movptr(rbx, Address(rbx, in_bytes(Method::method_data_offset())));
1334   addptr(rbx, in_bytes(MethodData::data_offset()));
1335   addptr(rax, rbx);
1336   bind(set_mdp);
1337   movptr(Address(rbp, frame::interpreter_frame_mdp_offset * wordSize), rax);
1338   pop(rbx);
1339   pop(rax);
1340 }
1341 
1342 void InterpreterMacroAssembler::verify_method_data_pointer() {
1343   assert(ProfileInterpreter, "must be profiling interpreter");
1344 #ifdef ASSERT
1345   Label verify_continue;
1346   push(rax);
1347   push(rbx);
1348   Register arg3_reg = c_rarg3;
1349   Register arg2_reg = c_rarg2;
1350   push(arg3_reg);
1351   push(arg2_reg);
1352   test_method_data_pointer(arg3_reg, verify_continue); // If mdp is zero, continue
1353   get_method(rbx);
1354 
1355   // If the mdp is valid, it will point to a DataLayout header which is
1356   // consistent with the bcp.  The converse is highly probable also.
1357   load_unsigned_short(arg2_reg,
1358                       Address(arg3_reg, in_bytes(DataLayout::bci_offset())));
1359   addptr(arg2_reg, Address(rbx, Method::const_offset()));
1360   lea(arg2_reg, Address(arg2_reg, ConstMethod::codes_offset()));
1361   cmpptr(arg2_reg, _bcp_register);
1362   jcc(Assembler::equal, verify_continue);
1363   // rbx: method
1364   // _bcp_register: bcp
1365   // c_rarg3: mdp
1366   call_VM_leaf(CAST_FROM_FN_PTR(address, InterpreterRuntime::verify_mdp),
1367                rbx, _bcp_register, arg3_reg);
1368   bind(verify_continue);
1369   pop(arg2_reg);
1370   pop(arg3_reg);
1371   pop(rbx);
1372   pop(rax);
1373 #endif // ASSERT
1374 }
1375 
1376 
1377 void InterpreterMacroAssembler::set_mdp_data_at(Register mdp_in,
1378                                                 int constant,
1379                                                 Register value) {
1380   assert(ProfileInterpreter, "must be profiling interpreter");
1381   Address data(mdp_in, constant);
1382   movptr(data, value);
1383 }
1384 
1385 
1386 void InterpreterMacroAssembler::increment_mdp_data_at(Register mdp_in,
1387                                                       int constant) {
1388   assert(ProfileInterpreter, "must be profiling interpreter");
1389   Address data(mdp_in, constant);
1390   addptr(data, DataLayout::counter_increment);
1391 }
1392 
1393 
1394 void InterpreterMacroAssembler::increment_mdp_data_at(Register mdp_in,
1395                                                       Register index,
1396                                                       int constant) {
1397   assert(ProfileInterpreter, "must be profiling interpreter");
1398   Address data(mdp_in, index, Address::times_1, constant);
1399   addptr(data, DataLayout::counter_increment);
1400 }
1401 
1402 void InterpreterMacroAssembler::set_mdp_flag_at(Register mdp_in,
1403                                                 int flag_byte_constant) {
1404   assert(ProfileInterpreter, "must be profiling interpreter");
1405   int header_offset = in_bytes(DataLayout::flags_offset());
1406   int header_bits = flag_byte_constant;
1407   // Set the flag
1408   orb(Address(mdp_in, header_offset), header_bits);
1409 }
1410 
1411 
1412 
1413 void InterpreterMacroAssembler::test_mdp_data_at(Register mdp_in,
1414                                                  int offset,
1415                                                  Register value,
1416                                                  Register test_value_out,
1417                                                  Label& not_equal_continue) {
1418   assert(ProfileInterpreter, "must be profiling interpreter");
1419   if (test_value_out == noreg) {
1420     cmpptr(value, Address(mdp_in, offset));
1421   } else {
1422     // Put the test value into a register, so caller can use it:
1423     movptr(test_value_out, Address(mdp_in, offset));
1424     cmpptr(test_value_out, value);
1425   }
1426   jcc(Assembler::notEqual, not_equal_continue);
1427 }
1428 
1429 
1430 void InterpreterMacroAssembler::update_mdp_by_offset(Register mdp_in,
1431                                                      int offset_of_disp) {
1432   assert(ProfileInterpreter, "must be profiling interpreter");
1433   Address disp_address(mdp_in, offset_of_disp);
1434   addptr(mdp_in, disp_address);
1435   movptr(Address(rbp, frame::interpreter_frame_mdp_offset * wordSize), mdp_in);
1436 }
1437 
1438 
1439 void InterpreterMacroAssembler::update_mdp_by_offset(Register mdp_in,
1440                                                      Register reg,
1441                                                      int offset_of_disp) {
1442   assert(ProfileInterpreter, "must be profiling interpreter");
1443   Address disp_address(mdp_in, reg, Address::times_1, offset_of_disp);
1444   addptr(mdp_in, disp_address);
1445   movptr(Address(rbp, frame::interpreter_frame_mdp_offset * wordSize), mdp_in);
1446 }
1447 
1448 
1449 void InterpreterMacroAssembler::update_mdp_by_constant(Register mdp_in,
1450                                                        int constant) {
1451   assert(ProfileInterpreter, "must be profiling interpreter");
1452   addptr(mdp_in, constant);
1453   movptr(Address(rbp, frame::interpreter_frame_mdp_offset * wordSize), mdp_in);
1454 }
1455 
1456 
1457 void InterpreterMacroAssembler::update_mdp_for_ret(Register return_bci) {
1458   assert(ProfileInterpreter, "must be profiling interpreter");
1459   push(return_bci); // save/restore across call_VM
1460   call_VM(noreg,
1461           CAST_FROM_FN_PTR(address, InterpreterRuntime::update_mdp_for_ret),
1462           return_bci);
1463   pop(return_bci);
1464 }
1465 
1466 
1467 void InterpreterMacroAssembler::profile_taken_branch(Register mdp) {
1468   if (ProfileInterpreter) {
1469     Label profile_continue;
1470 
1471     // If no method data exists, go to profile_continue.
1472     test_method_data_pointer(mdp, profile_continue);
1473 
1474     // We are taking a branch.  Increment the taken count.
1475     increment_mdp_data_at(mdp, in_bytes(JumpData::taken_offset()));
1476 
1477     // The method data pointer needs to be updated to reflect the new target.
1478     update_mdp_by_offset(mdp, in_bytes(JumpData::displacement_offset()));
1479     bind(profile_continue);
1480   }
1481 }
1482 
1483 
1484 void InterpreterMacroAssembler::profile_not_taken_branch(Register mdp, bool acmp) {
1485   if (ProfileInterpreter) {
1486     Label profile_continue;
1487 
1488     // If no method data exists, go to profile_continue.
1489     test_method_data_pointer(mdp, profile_continue);
1490 
1491     // We are not taking a branch.  Increment the not taken count.
1492     increment_mdp_data_at(mdp, in_bytes(BranchData::not_taken_offset()));
1493 
1494     // The method data pointer needs to be updated to correspond to
1495     // the next bytecode
1496     update_mdp_by_constant(mdp, acmp ? in_bytes(ACmpData::acmp_data_size()): in_bytes(BranchData::branch_data_size()));
1497     bind(profile_continue);
1498   }
1499 }
1500 
1501 void InterpreterMacroAssembler::profile_call(Register mdp) {
1502   if (ProfileInterpreter) {
1503     Label profile_continue;
1504 
1505     // If no method data exists, go to profile_continue.
1506     test_method_data_pointer(mdp, profile_continue);
1507 
1508     // We are making a call.  Increment the count.
1509     increment_mdp_data_at(mdp, in_bytes(CounterData::count_offset()));
1510 
1511     // The method data pointer needs to be updated to reflect the new target.
1512     update_mdp_by_constant(mdp, in_bytes(CounterData::counter_data_size()));
1513     bind(profile_continue);
1514   }
1515 }
1516 
1517 
1518 void InterpreterMacroAssembler::profile_final_call(Register mdp) {
1519   if (ProfileInterpreter) {
1520     Label profile_continue;
1521 
1522     // If no method data exists, go to profile_continue.
1523     test_method_data_pointer(mdp, profile_continue);
1524 
1525     // We are making a call.  Increment the count.
1526     increment_mdp_data_at(mdp, in_bytes(CounterData::count_offset()));
1527 
1528     // The method data pointer needs to be updated to reflect the new target.
1529     update_mdp_by_constant(mdp,
1530                            in_bytes(VirtualCallData::
1531                                     virtual_call_data_size()));
1532     bind(profile_continue);
1533   }
1534 }
1535 
1536 
1537 void InterpreterMacroAssembler::profile_virtual_call(Register receiver,
1538                                                      Register mdp,
1539                                                      bool receiver_can_be_null) {
1540   if (ProfileInterpreter) {
1541     Label profile_continue;
1542 
1543     // If no method data exists, go to profile_continue.
1544     test_method_data_pointer(mdp, profile_continue);
1545 
1546     Label skip_receiver_profile;
1547     if (receiver_can_be_null) {
1548       Label not_null;
1549       testptr(receiver, receiver);
1550       jccb(Assembler::notZero, not_null);
1551       // We are making a call.  Increment the count for null receiver.
1552       increment_mdp_data_at(mdp, in_bytes(CounterData::count_offset()));
1553       jmp(skip_receiver_profile);
1554       bind(not_null);
1555     }
1556 
1557     // Record the receiver type.
1558     profile_receiver_type(receiver, mdp, 0);
1559     bind(skip_receiver_profile);
1560 
1561     // The method data pointer needs to be updated to reflect the new target.
1562     update_mdp_by_constant(mdp, in_bytes(VirtualCallData::virtual_call_data_size()));
1563     bind(profile_continue);
1564   }
1565 }
1566 
1567 void InterpreterMacroAssembler::profile_ret(Register return_bci,
1568                                             Register mdp) {
1569   if (ProfileInterpreter) {
1570     Label profile_continue;
1571     uint row;
1572 
1573     // If no method data exists, go to profile_continue.
1574     test_method_data_pointer(mdp, profile_continue);
1575 
1576     // Update the total ret count.
1577     increment_mdp_data_at(mdp, in_bytes(CounterData::count_offset()));
1578 
1579     for (row = 0; row < RetData::row_limit(); row++) {
1580       Label next_test;
1581 
1582       // See if return_bci is equal to bci[n]:
1583       test_mdp_data_at(mdp,
1584                        in_bytes(RetData::bci_offset(row)),
1585                        return_bci, noreg,
1586                        next_test);
1587 
1588       // return_bci is equal to bci[n].  Increment the count.
1589       increment_mdp_data_at(mdp, in_bytes(RetData::bci_count_offset(row)));
1590 
1591       // The method data pointer needs to be updated to reflect the new target.
1592       update_mdp_by_offset(mdp,
1593                            in_bytes(RetData::bci_displacement_offset(row)));
1594       jmp(profile_continue);
1595       bind(next_test);
1596     }
1597 
1598     update_mdp_for_ret(return_bci);
1599 
1600     bind(profile_continue);
1601   }
1602 }
1603 
1604 
1605 void InterpreterMacroAssembler::profile_null_seen(Register mdp) {
1606   if (ProfileInterpreter) {
1607     Label profile_continue;
1608 
1609     // If no method data exists, go to profile_continue.
1610     test_method_data_pointer(mdp, profile_continue);
1611 
1612     set_mdp_flag_at(mdp, BitData::null_seen_byte_constant());
1613 
1614     // The method data pointer needs to be updated.
1615     int mdp_delta = in_bytes(BitData::bit_data_size());
1616     if (TypeProfileCasts) {
1617       mdp_delta = in_bytes(VirtualCallData::virtual_call_data_size());
1618     }
1619     update_mdp_by_constant(mdp, mdp_delta);
1620 
1621     bind(profile_continue);
1622   }
1623 }
1624 
1625 
1626 void InterpreterMacroAssembler::profile_typecheck(Register mdp, Register klass) {
1627   if (ProfileInterpreter) {
1628     Label profile_continue;
1629 
1630     // If no method data exists, go to profile_continue.
1631     test_method_data_pointer(mdp, profile_continue);
1632 
1633     // The method data pointer needs to be updated.
1634     int mdp_delta = in_bytes(BitData::bit_data_size());
1635     if (TypeProfileCasts) {
1636       mdp_delta = in_bytes(VirtualCallData::virtual_call_data_size());
1637 
1638       // Record the object type.
1639       profile_receiver_type(klass, mdp, 0);
1640     }
1641     update_mdp_by_constant(mdp, mdp_delta);
1642 
1643     bind(profile_continue);
1644   }
1645 }
1646 
1647 
1648 void InterpreterMacroAssembler::profile_switch_default(Register mdp) {
1649   if (ProfileInterpreter) {
1650     Label profile_continue;
1651 
1652     // If no method data exists, go to profile_continue.
1653     test_method_data_pointer(mdp, profile_continue);
1654 
1655     // Update the default case count
1656     increment_mdp_data_at(mdp,
1657                           in_bytes(MultiBranchData::default_count_offset()));
1658 
1659     // The method data pointer needs to be updated.
1660     update_mdp_by_offset(mdp,
1661                          in_bytes(MultiBranchData::
1662                                   default_displacement_offset()));
1663 
1664     bind(profile_continue);
1665   }
1666 }
1667 
1668 
1669 void InterpreterMacroAssembler::profile_switch_case(Register index,
1670                                                     Register mdp,
1671                                                     Register reg2) {
1672   if (ProfileInterpreter) {
1673     Label profile_continue;
1674 
1675     // If no method data exists, go to profile_continue.
1676     test_method_data_pointer(mdp, profile_continue);
1677 
1678     // Build the base (index * per_case_size_in_bytes()) +
1679     // case_array_offset_in_bytes()
1680     movl(reg2, in_bytes(MultiBranchData::per_case_size()));
1681     imulptr(index, reg2); // XXX l ?
1682     addptr(index, in_bytes(MultiBranchData::case_array_offset())); // XXX l ?
1683 
1684     // Update the case count
1685     increment_mdp_data_at(mdp,
1686                           index,
1687                           in_bytes(MultiBranchData::relative_count_offset()));
1688 
1689     // The method data pointer needs to be updated.
1690     update_mdp_by_offset(mdp,
1691                          index,
1692                          in_bytes(MultiBranchData::
1693                                   relative_displacement_offset()));
1694 
1695     bind(profile_continue);
1696   }
1697 }
1698 
1699 template <class ArrayData> void InterpreterMacroAssembler::profile_array_type(Register mdp,
1700                                                                               Register array,
1701                                                                               Register tmp) {
1702   if (ProfileInterpreter) {
1703     Label profile_continue;
1704 
1705     // If no method data exists, go to profile_continue.
1706     test_method_data_pointer(mdp, profile_continue);
1707 
1708     mov(tmp, array);
1709     profile_obj_type(tmp, Address(mdp, in_bytes(ArrayData::array_offset())));
1710 
1711     Label not_flat;
1712     test_non_flat_array_oop(array, tmp, not_flat);
1713 
1714     set_mdp_flag_at(mdp, ArrayData::flat_array_byte_constant());
1715 
1716     bind(not_flat);
1717 
1718     Label not_null_free;
1719     test_non_null_free_array_oop(array, tmp, not_null_free);
1720 
1721     set_mdp_flag_at(mdp, ArrayData::null_free_array_byte_constant());
1722 
1723     bind(not_null_free);
1724 
1725     bind(profile_continue);
1726   }
1727 }
1728 
1729 template void InterpreterMacroAssembler::profile_array_type<ArrayLoadData>(Register mdp,
1730                                                                            Register array,
1731                                                                            Register tmp);
1732 template void InterpreterMacroAssembler::profile_array_type<ArrayStoreData>(Register mdp,
1733                                                                             Register array,
1734                                                                             Register tmp);
1735 
1736 
1737 void InterpreterMacroAssembler::profile_multiple_element_types(Register mdp, Register element, Register tmp, const Register tmp2) {
1738   if (ProfileInterpreter) {
1739     Label profile_continue;
1740 
1741     // If no method data exists, go to profile_continue.
1742     test_method_data_pointer(mdp, profile_continue);
1743 
1744     Label done, update;
1745     testptr(element, element);
1746     jccb(Assembler::notZero, update);
1747     set_mdp_flag_at(mdp, BitData::null_seen_byte_constant());
1748     jmp(done);
1749 
1750     bind(update);
1751     load_klass(tmp, element, rscratch1);
1752 
1753     // Record the object type.
1754     profile_receiver_type(tmp, mdp, 0);
1755 
1756     bind(done);
1757 
1758     // The method data pointer needs to be updated.
1759     update_mdp_by_constant(mdp, in_bytes(ArrayStoreData::array_store_data_size()));
1760 
1761     bind(profile_continue);
1762   }
1763 }
1764 
1765 void InterpreterMacroAssembler::profile_element_type(Register mdp,
1766                                                      Register element,
1767                                                      Register tmp) {
1768   if (ProfileInterpreter) {
1769     Label profile_continue;
1770 
1771     // If no method data exists, go to profile_continue.
1772     test_method_data_pointer(mdp, profile_continue);
1773 
1774     mov(tmp, element);
1775     profile_obj_type(tmp, Address(mdp, in_bytes(ArrayLoadData::element_offset())));
1776 
1777     // The method data pointer needs to be updated.
1778     update_mdp_by_constant(mdp, in_bytes(ArrayLoadData::array_load_data_size()));
1779 
1780     bind(profile_continue);
1781   }
1782 }
1783 
1784 void InterpreterMacroAssembler::profile_acmp(Register mdp,
1785                                              Register left,
1786                                              Register right,
1787                                              Register tmp) {
1788   if (ProfileInterpreter) {
1789     Label profile_continue;
1790 
1791     // If no method data exists, go to profile_continue.
1792     test_method_data_pointer(mdp, profile_continue);
1793 
1794     mov(tmp, left);
1795     profile_obj_type(tmp, Address(mdp, in_bytes(ACmpData::left_offset())));
1796 
1797     Label left_not_inline_type;
1798     test_oop_is_not_inline_type(left, tmp, left_not_inline_type);
1799     set_mdp_flag_at(mdp, ACmpData::left_inline_type_byte_constant());
1800     bind(left_not_inline_type);
1801 
1802     mov(tmp, right);
1803     profile_obj_type(tmp, Address(mdp, in_bytes(ACmpData::right_offset())));
1804 
1805     Label right_not_inline_type;
1806     test_oop_is_not_inline_type(right, tmp, right_not_inline_type);
1807     set_mdp_flag_at(mdp, ACmpData::right_inline_type_byte_constant());
1808     bind(right_not_inline_type);
1809 
1810     bind(profile_continue);
1811   }
1812 }
1813 
1814 
1815 void InterpreterMacroAssembler::_interp_verify_oop(Register reg, TosState state, const char* file, int line) {
1816   if (state == atos) {
1817     MacroAssembler::_verify_oop_checked(reg, "broken oop", file, line);
1818   }
1819 }
1820 
1821 
1822 // Jump if ((*counter_addr += increment) & mask) == 0
1823 void InterpreterMacroAssembler::increment_mask_and_jump(Address counter_addr, Address mask,
1824                                                         Register scratch, Label* where) {
1825   // This update is actually not atomic and can lose a number of updates
1826   // under heavy contention, but the alternative of using the (contended)
1827   // atomic update here penalizes profiling paths too much.
1828   movl(scratch, counter_addr);
1829   incrementl(scratch, InvocationCounter::count_increment);
1830   movl(counter_addr, scratch);
1831   andl(scratch, mask);
1832   if (where != nullptr) {
1833     jcc(Assembler::zero, *where);
1834   }
1835 }
1836 
1837 void InterpreterMacroAssembler::notify_method_entry() {
1838   // Whenever JVMTI is interp_only_mode, method entry/exit events are sent to
1839   // track stack depth.  If it is possible to enter interp_only_mode we add
1840   // the code to check if the event should be sent.
1841   Register rthread = r15_thread;
1842   Register rarg = c_rarg1;
1843   if (JvmtiExport::can_post_interpreter_events()) {
1844     Label L;
1845     movl(rdx, Address(rthread, JavaThread::interp_only_mode_offset()));
1846     testl(rdx, rdx);
1847     jcc(Assembler::zero, L);
1848     call_VM(noreg, CAST_FROM_FN_PTR(address,
1849                                     InterpreterRuntime::post_method_entry));
1850     bind(L);
1851   }
1852 
1853   if (DTraceMethodProbes) {
1854     get_method(rarg);
1855     call_VM_leaf(CAST_FROM_FN_PTR(address, SharedRuntime::dtrace_method_entry),
1856                  rthread, rarg);
1857   }
1858 
1859   // RedefineClasses() tracing support for obsolete method entry
1860   if (log_is_enabled(Trace, redefine, class, obsolete)) {
1861     get_method(rarg);
1862     call_VM_leaf(
1863       CAST_FROM_FN_PTR(address, SharedRuntime::rc_trace_method_entry),
1864       rthread, rarg);
1865   }
1866 }
1867 
1868 
1869 void InterpreterMacroAssembler::notify_method_exit(
1870     TosState state, NotifyMethodExitMode mode) {
1871   // Whenever JVMTI is interp_only_mode, method entry/exit events are sent to
1872   // track stack depth.  If it is possible to enter interp_only_mode we add
1873   // the code to check if the event should be sent.
1874   Register rthread = r15_thread;
1875   Register rarg = c_rarg1;
1876   if (mode == NotifyJVMTI && JvmtiExport::can_post_interpreter_events()) {
1877     Label L;
1878     // Note: frame::interpreter_frame_result has a dependency on how the
1879     // method result is saved across the call to post_method_exit. If this
1880     // is changed then the interpreter_frame_result implementation will
1881     // need to be updated too.
1882 
1883     // template interpreter will leave the result on the top of the stack.
1884     push(state);
1885     movl(rdx, Address(rthread, JavaThread::interp_only_mode_offset()));
1886     testl(rdx, rdx);
1887     jcc(Assembler::zero, L);
1888     call_VM(noreg,
1889             CAST_FROM_FN_PTR(address, InterpreterRuntime::post_method_exit));
1890     bind(L);
1891     pop(state);
1892   }
1893 
1894   if (DTraceMethodProbes) {
1895     push(state);
1896     get_method(rarg);
1897     call_VM_leaf(CAST_FROM_FN_PTR(address, SharedRuntime::dtrace_method_exit),
1898                  rthread, rarg);
1899     pop(state);
1900   }
1901 }
1902 
1903 void InterpreterMacroAssembler::load_resolved_indy_entry(Register cache, Register index) {
1904   // Get index out of bytecode pointer
1905   get_cache_index_at_bcp(index, 1, sizeof(u4));
1906   // Get address of invokedynamic array
1907   movptr(cache, Address(rbp, frame::interpreter_frame_cache_offset * wordSize));
1908   movptr(cache, Address(cache, in_bytes(ConstantPoolCache::invokedynamic_entries_offset())));
1909   if (is_power_of_2(sizeof(ResolvedIndyEntry))) {
1910     shll(index, log2i_exact(sizeof(ResolvedIndyEntry))); // Scale index by power of 2
1911   } else {
1912     imull(index, index, sizeof(ResolvedIndyEntry)); // Scale the index to be the entry index * sizeof(ResolvedIndyEntry)
1913   }
1914   lea(cache, Address(cache, index, Address::times_1, Array<ResolvedIndyEntry>::base_offset_in_bytes()));
1915 }
1916 
1917 void InterpreterMacroAssembler::load_field_entry(Register cache, Register index, int bcp_offset) {
1918   // Get index out of bytecode pointer
1919   movptr(cache, Address(rbp, frame::interpreter_frame_cache_offset * wordSize));
1920   get_cache_index_at_bcp(index, bcp_offset, sizeof(u2));
1921 
1922   movptr(cache, Address(cache, ConstantPoolCache::field_entries_offset()));
1923   // Take shortcut if the size is a power of 2
1924   if (is_power_of_2(sizeof(ResolvedFieldEntry))) {
1925     shll(index, log2i_exact(sizeof(ResolvedFieldEntry))); // Scale index by power of 2
1926   } else {
1927     imull(index, index, sizeof(ResolvedFieldEntry)); // Scale the index to be the entry index * sizeof(ResolvedFieldEntry)
1928   }
1929   lea(cache, Address(cache, index, Address::times_1, Array<ResolvedFieldEntry>::base_offset_in_bytes()));
1930 }
1931 
1932 void InterpreterMacroAssembler::load_method_entry(Register cache, Register index, int bcp_offset) {
1933   // Get index out of bytecode pointer
1934   movptr(cache, Address(rbp, frame::interpreter_frame_cache_offset * wordSize));
1935   get_cache_index_at_bcp(index, bcp_offset, sizeof(u2));
1936 
1937   movptr(cache, Address(cache, ConstantPoolCache::method_entries_offset()));
1938   imull(index, index, sizeof(ResolvedMethodEntry)); // Scale the index to be the entry index * sizeof(ResolvedMethodEntry)
1939   lea(cache, Address(cache, index, Address::times_1, Array<ResolvedMethodEntry>::base_offset_in_bytes()));
1940 }