1 /*
   2  * Copyright (c) 2003, 2026, Oracle and/or its affiliates. All rights reserved.
   3  * Copyright (c) 2014, 2020, Red Hat Inc. All rights reserved.
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This code is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 only, as
   8  * published by the Free Software Foundation.
   9  *
  10  * This code is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * version 2 for more details (a copy is included in the LICENSE file that
  14  * accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License version
  17  * 2 along with this work; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21  * or visit www.oracle.com if you need additional information or have any
  22  * questions.
  23  *
  24  */
  25 
  26 #include "asm/macroAssembler.inline.hpp"
  27 #include "classfile/javaClasses.hpp"
  28 #include "compiler/disassembler.hpp"
  29 #include "compiler/compiler_globals.hpp"
  30 #include "gc/shared/barrierSetAssembler.hpp"
  31 #include "interpreter/bytecodeHistogram.hpp"
  32 #include "interpreter/interpreter.hpp"
  33 #include "interpreter/interpreterRuntime.hpp"
  34 #include "interpreter/interp_masm.hpp"
  35 #include "interpreter/templateInterpreterGenerator.hpp"
  36 #include "interpreter/templateTable.hpp"
  37 #include "interpreter/bytecodeTracer.hpp"
  38 #include "memory/resourceArea.hpp"
  39 #include "oops/arrayOop.hpp"
  40 #include "oops/method.hpp"
  41 #include "oops/methodCounters.hpp"
  42 #include "oops/methodData.hpp"
  43 #include "oops/oop.inline.hpp"
  44 #include "oops/resolvedIndyEntry.hpp"
  45 #include "oops/resolvedMethodEntry.hpp"
  46 #include "prims/jvmtiExport.hpp"
  47 #include "prims/jvmtiThreadState.hpp"
  48 #include "runtime/arguments.hpp"
  49 #include "runtime/deoptimization.hpp"
  50 #include "runtime/frame.inline.hpp"
  51 #include "runtime/globals.hpp"
  52 #include "runtime/jniHandles.hpp"
  53 #include "runtime/sharedRuntime.hpp"
  54 #include "runtime/stubRoutines.hpp"
  55 #include "runtime/synchronizer.hpp"
  56 #include "runtime/timer.hpp"
  57 #include "runtime/vframeArray.hpp"
  58 #include "utilities/checkedCast.hpp"
  59 #include "utilities/debug.hpp"
  60 #include "utilities/powerOfTwo.hpp"
  61 #include <sys/types.h>
  62 
  63 // Size of interpreter code.  Increase if too small.  Interpreter will
  64 // fail with a guarantee ("not enough space for interpreter generation");
  65 // if too small.
  66 // Run with +PrintInterpreter to get the VM to print out the size.
  67 // Max size with JVMTI
  68 int TemplateInterpreter::InterpreterCodeSize = 200 * 1024;
  69 
  70 #define __ Disassembler::hook<InterpreterMacroAssembler>(__FILE__, __LINE__, _masm)->
  71 
  72 address TemplateInterpreterGenerator::generate_slow_signature_handler() {
  73   address entry = __ pc();
  74 
  75   __ andr(esp, esp, -16);
  76   __ mov(c_rarg3, esp);
  77   // rmethod
  78   // rlocals
  79   // c_rarg3: first stack arg - wordSize
  80 
  81   // adjust sp
  82   __ sub(sp, c_rarg3, 18 * wordSize);
  83   __ str(lr, Address(__ pre(sp, -2 * wordSize)));
  84   __ call_VM(noreg,
  85              CAST_FROM_FN_PTR(address,
  86                               InterpreterRuntime::slow_signature_handler),
  87              rmethod, rlocals, c_rarg3);
  88 
  89   // r0: result handler
  90 
  91   // Stack layout:
  92   // rsp: return address           <- sp
  93   //      1 garbage
  94   //      8 integer args (if static first is unused)
  95   //      1 float/double identifiers
  96   //      8 double args
  97   //        stack args              <- esp
  98   //        garbage
  99   //        expression stack bottom
 100   //        bcp (null)
 101   //        ...
 102 
 103   // Restore LR
 104   __ ldr(lr, Address(__ post(sp, 2 * wordSize)));
 105 
 106   // Do FP first so we can use c_rarg3 as temp
 107   __ ldrw(c_rarg3, Address(sp, 9 * wordSize)); // float/double identifiers
 108 
 109   for (int i = 0; i < Argument::n_float_register_parameters_c; i++) {
 110     const FloatRegister r = as_FloatRegister(i);
 111 
 112     Label d, done;
 113 
 114     __ tbnz(c_rarg3, i, d);
 115     __ ldrs(r, Address(sp, (10 + i) * wordSize));
 116     __ b(done);
 117     __ bind(d);
 118     __ ldrd(r, Address(sp, (10 + i) * wordSize));
 119     __ bind(done);
 120   }
 121 
 122   // c_rarg0 contains the result from the call of
 123   // InterpreterRuntime::slow_signature_handler so we don't touch it
 124   // here.  It will be loaded with the JNIEnv* later.
 125   __ ldr(c_rarg1, Address(sp, 1 * wordSize));
 126   for (int i = c_rarg2->encoding(); i <= c_rarg7->encoding(); i += 2) {
 127     Register rm = as_Register(i), rn = as_Register(i+1);
 128     __ ldp(rm, rn, Address(sp, i * wordSize));
 129   }
 130 
 131   __ add(sp, sp, 18 * wordSize);
 132   __ ret(lr);
 133 
 134   return entry;
 135 }
 136 
 137 
 138 //
 139 // Various method entries
 140 //
 141 
 142 address TemplateInterpreterGenerator::generate_math_entry(AbstractInterpreter::MethodKind kind) {
 143   // rmethod: Method*
 144   // r19_sender_sp: sender sp
 145   // esp: args
 146 
 147   // These don't need a safepoint check because they aren't virtually
 148   // callable. We won't enter these intrinsics from compiled code.
 149   // If in the future we added an intrinsic which was virtually callable
 150   // we'd have to worry about how to safepoint so that this code is used.
 151 
 152   // mathematical functions inlined by compiler
 153   // (interpreter must provide identical implementation
 154   // in order to avoid monotonicity bugs when switching
 155   // from interpreter to compiler in the middle of some
 156   // computation)
 157   //
 158   // stack:
 159   //        [ arg ] <-- esp
 160   //        [ arg ]
 161   // retaddr in lr
 162 
 163   address entry_point = nullptr;
 164   Register continuation = lr;
 165   switch (kind) {
 166   case Interpreter::java_lang_math_abs:
 167     entry_point = __ pc();
 168     __ ldrd(v0, Address(esp));
 169     __ fabsd(v0, v0);
 170     __ mov(sp, r19_sender_sp); // Restore caller's SP
 171     break;
 172   case Interpreter::java_lang_math_sqrt:
 173     entry_point = __ pc();
 174     __ ldrd(v0, Address(esp));
 175     __ fsqrtd(v0, v0);
 176     __ mov(sp, r19_sender_sp);
 177     break;
 178   case Interpreter::java_lang_math_sin :
 179   case Interpreter::java_lang_math_cos :
 180   case Interpreter::java_lang_math_tan :
 181   case Interpreter::java_lang_math_log :
 182   case Interpreter::java_lang_math_log10 :
 183   case Interpreter::java_lang_math_exp :
 184     entry_point = __ pc();
 185     __ ldrd(v0, Address(esp));
 186     __ mov(sp, r19_sender_sp);
 187     __ mov(r23, lr);
 188     continuation = r23;  // The first free callee-saved register
 189     generate_transcendental_entry(kind, 1);
 190     break;
 191   case Interpreter::java_lang_math_pow :
 192     entry_point = __ pc();
 193     __ mov(r23, lr);
 194     continuation = r23;
 195     __ ldrd(v0, Address(esp, 2 * Interpreter::stackElementSize));
 196     __ ldrd(v1, Address(esp));
 197     __ mov(sp, r19_sender_sp);
 198     generate_transcendental_entry(kind, 2);
 199     break;
 200   case Interpreter::java_lang_math_fmaD :
 201     if (UseFMA) {
 202       entry_point = __ pc();
 203       __ ldrd(v0, Address(esp, 4 * Interpreter::stackElementSize));
 204       __ ldrd(v1, Address(esp, 2 * Interpreter::stackElementSize));
 205       __ ldrd(v2, Address(esp));
 206       __ fmaddd(v0, v0, v1, v2);
 207       __ mov(sp, r19_sender_sp); // Restore caller's SP
 208     }
 209     break;
 210   case Interpreter::java_lang_math_fmaF :
 211     if (UseFMA) {
 212       entry_point = __ pc();
 213       __ ldrs(v0, Address(esp, 2 * Interpreter::stackElementSize));
 214       __ ldrs(v1, Address(esp, Interpreter::stackElementSize));
 215       __ ldrs(v2, Address(esp));
 216       __ fmadds(v0, v0, v1, v2);
 217       __ mov(sp, r19_sender_sp); // Restore caller's SP
 218     }
 219     break;
 220   default:
 221     ;
 222   }
 223   if (entry_point) {
 224     __ br(continuation);
 225   }
 226 
 227   return entry_point;
 228 }
 229 
 230   // double trigonometrics and transcendentals
 231   // static jdouble dsin(jdouble x);
 232   // static jdouble dcos(jdouble x);
 233   // static jdouble dtan(jdouble x);
 234   // static jdouble dlog(jdouble x);
 235   // static jdouble dlog10(jdouble x);
 236   // static jdouble dexp(jdouble x);
 237   // static jdouble dpow(jdouble x, jdouble y);
 238 
 239 void TemplateInterpreterGenerator::generate_transcendental_entry(AbstractInterpreter::MethodKind kind, int fpargs) {
 240   address fn;
 241   switch (kind) {
 242   case Interpreter::java_lang_math_sin :
 243     if (StubRoutines::dsin() == nullptr) {
 244       fn = CAST_FROM_FN_PTR(address, SharedRuntime::dsin);
 245     } else {
 246       fn = CAST_FROM_FN_PTR(address, StubRoutines::dsin());
 247     }
 248     break;
 249   case Interpreter::java_lang_math_cos :
 250     if (StubRoutines::dcos() == nullptr) {
 251       fn = CAST_FROM_FN_PTR(address, SharedRuntime::dcos);
 252     } else {
 253       fn = CAST_FROM_FN_PTR(address, StubRoutines::dcos());
 254     }
 255     break;
 256   case Interpreter::java_lang_math_tan :
 257     if (StubRoutines::dtan() == nullptr) {
 258       fn = CAST_FROM_FN_PTR(address, SharedRuntime::dtan);
 259     } else {
 260       fn = CAST_FROM_FN_PTR(address, StubRoutines::dtan());
 261     }
 262     break;
 263   case Interpreter::java_lang_math_log :
 264     if (StubRoutines::dlog() == nullptr) {
 265       fn = CAST_FROM_FN_PTR(address, SharedRuntime::dlog);
 266     } else {
 267       fn = CAST_FROM_FN_PTR(address, StubRoutines::dlog());
 268     }
 269     break;
 270   case Interpreter::java_lang_math_log10 :
 271     if (StubRoutines::dlog10() == nullptr) {
 272       fn = CAST_FROM_FN_PTR(address, SharedRuntime::dlog10);
 273     } else {
 274       fn = CAST_FROM_FN_PTR(address, StubRoutines::dlog10());
 275     }
 276     break;
 277   case Interpreter::java_lang_math_exp :
 278     if (StubRoutines::dexp() == nullptr) {
 279       fn = CAST_FROM_FN_PTR(address, SharedRuntime::dexp);
 280     } else {
 281       fn = CAST_FROM_FN_PTR(address, StubRoutines::dexp());
 282     }
 283     break;
 284   case Interpreter::java_lang_math_pow :
 285     if (StubRoutines::dpow() == nullptr) {
 286       fn = CAST_FROM_FN_PTR(address, SharedRuntime::dpow);
 287     } else {
 288       fn = CAST_FROM_FN_PTR(address, StubRoutines::dpow());
 289     }
 290     break;
 291   default:
 292     ShouldNotReachHere();
 293     fn = nullptr;  // unreachable
 294   }
 295   __ mov(rscratch1, fn);
 296   __ blr(rscratch1);
 297 }
 298 
 299 address TemplateInterpreterGenerator::generate_Float_float16ToFloat_entry() {
 300   assert(VM_Version::supports_float16(), "this intrinsic is not supported");
 301   // r19_sender_sp: sender sp
 302   // stack:
 303   //        [ arg ] <-- esp
 304   //        [ arg ]
 305   // retaddr in lr
 306   // result in v0
 307 
 308   address entry_point = __ pc();
 309   __ ldrw(c_rarg0, Address(esp));
 310   __ flt16_to_flt(v0, c_rarg0, v1);
 311   __ mov(sp, r19_sender_sp); // Restore caller's SP
 312   __ br(lr);
 313   return entry_point;
 314 }
 315 
 316 address TemplateInterpreterGenerator::generate_Float_floatToFloat16_entry() {
 317   assert(VM_Version::supports_float16(), "this intrinsic is not supported");
 318   // r19_sender_sp: sender sp
 319   // stack:
 320   //        [ arg ] <-- esp
 321   //        [ arg ]
 322   // retaddr in lr
 323   // result in c_rarg0
 324 
 325   address entry_point = __ pc();
 326   __ ldrs(v0, Address(esp));
 327   __ flt_to_flt16(c_rarg0, v0, v1);
 328   __ mov(sp, r19_sender_sp); // Restore caller's SP
 329   __ br(lr);
 330   return entry_point;
 331 }
 332 
 333 // Abstract method entry
 334 // Attempt to execute abstract method. Throw exception
 335 address TemplateInterpreterGenerator::generate_abstract_entry(void) {
 336   // rmethod: Method*
 337   // r19_sender_sp: sender SP
 338 
 339   address entry_point = __ pc();
 340 
 341   // abstract method entry
 342 
 343   //  pop return address, reset last_sp to null
 344   __ empty_expression_stack();
 345   __ restore_bcp();      // bcp must be correct for exception handler   (was destroyed)
 346   __ restore_locals();   // make sure locals pointer is correct as well (was destroyed)
 347 
 348   // throw exception
 349   __ call_VM(noreg, CAST_FROM_FN_PTR(address,
 350                                      InterpreterRuntime::throw_AbstractMethodErrorWithMethod),
 351                                      rmethod);
 352   // the call_VM checks for exception, so we should never return here.
 353   __ should_not_reach_here();
 354 
 355   return entry_point;
 356 }
 357 
 358 address TemplateInterpreterGenerator::generate_StackOverflowError_handler() {
 359   address entry = __ pc();
 360 
 361 #ifdef ASSERT
 362   {
 363     Label L;
 364     __ ldr(rscratch1, Address(rfp,
 365                        frame::interpreter_frame_monitor_block_top_offset *
 366                        wordSize));
 367     __ lea(rscratch1, Address(rfp, rscratch1, Address::lsl(Interpreter::logStackElementSize)));
 368     __ mov(rscratch2, sp);
 369     __ cmp(rscratch1, rscratch2); // maximal rsp for current rfp (stack
 370                            // grows negative)
 371     __ br(Assembler::HS, L); // check if frame is complete
 372     __ stop ("interpreter frame not set up");
 373     __ bind(L);
 374   }
 375 #endif // ASSERT
 376   // Restore bcp under the assumption that the current frame is still
 377   // interpreted
 378   __ restore_bcp();
 379 
 380   // expression stack must be empty before entering the VM if an
 381   // exception happened
 382   __ empty_expression_stack();
 383   // throw exception
 384   __ call_VM(noreg,
 385              CAST_FROM_FN_PTR(address,
 386                               InterpreterRuntime::throw_StackOverflowError));
 387   return entry;
 388 }
 389 
 390 address TemplateInterpreterGenerator::generate_ArrayIndexOutOfBounds_handler() {
 391   address entry = __ pc();
 392   // expression stack must be empty before entering the VM if an
 393   // exception happened
 394   __ empty_expression_stack();
 395   // setup parameters
 396 
 397   // ??? convention: expect aberrant index in register r1
 398   __ movw(c_rarg2, r1);
 399   // ??? convention: expect array in register r3
 400   __ mov(c_rarg1, r3);
 401   __ call_VM(noreg,
 402              CAST_FROM_FN_PTR(address,
 403                               InterpreterRuntime::
 404                               throw_ArrayIndexOutOfBoundsException),
 405              c_rarg1, c_rarg2);
 406   return entry;
 407 }
 408 
 409 address TemplateInterpreterGenerator::generate_ClassCastException_handler() {
 410   address entry = __ pc();
 411 
 412   // object is at TOS
 413   __ pop(c_rarg1);
 414 
 415   // expression stack must be empty before entering the VM if an
 416   // exception happened
 417   __ empty_expression_stack();
 418 
 419   __ call_VM(noreg,
 420              CAST_FROM_FN_PTR(address,
 421                               InterpreterRuntime::
 422                               throw_ClassCastException),
 423              c_rarg1);
 424   return entry;
 425 }
 426 
 427 address TemplateInterpreterGenerator::generate_exception_handler_common(
 428         const char* name, const char* message, bool pass_oop) {
 429   assert(!pass_oop || message == nullptr, "either oop or message but not both");
 430   address entry = __ pc();
 431   if (pass_oop) {
 432     // object is at TOS
 433     __ pop(c_rarg2);
 434   }
 435   // expression stack must be empty before entering the VM if an
 436   // exception happened
 437   __ empty_expression_stack();
 438   // setup parameters
 439   __ lea(c_rarg1, Address((address)name));
 440   if (pass_oop) {
 441     __ call_VM(r0, CAST_FROM_FN_PTR(address,
 442                                     InterpreterRuntime::
 443                                     create_klass_exception),
 444                c_rarg1, c_rarg2);
 445   } else {
 446     // kind of lame ExternalAddress can't take null because
 447     // external_word_Relocation will assert.
 448     if (message != nullptr) {
 449       __ lea(c_rarg2, Address((address)message));
 450     } else {
 451       __ mov(c_rarg2, NULL_WORD);
 452     }
 453     __ call_VM(r0,
 454                CAST_FROM_FN_PTR(address, InterpreterRuntime::create_exception),
 455                c_rarg1, c_rarg2);
 456   }
 457   // throw exception
 458   __ b(address(Interpreter::throw_exception_entry()));
 459   return entry;
 460 }
 461 
 462 address TemplateInterpreterGenerator::generate_return_entry_for(TosState state, int step, size_t index_size) {
 463   address entry = __ pc();
 464 
 465   // Restore stack bottom in case i2c adjusted stack
 466   __ ldr(rscratch1, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));
 467   __ lea(esp, Address(rfp, rscratch1, Address::lsl(Interpreter::logStackElementSize)));
 468   // and null it as marker that esp is now tos until next java call
 469   __ str(zr, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));
 470   __ restore_bcp();
 471   __ restore_locals();
 472   __ restore_constant_pool_cache();
 473   __ get_method(rmethod);
 474 
 475   if (state == atos) {
 476     Register obj = r0;
 477     Register mdp = r1;
 478     Register tmp = r2;
 479     __ profile_return_type(mdp, obj, tmp);
 480   }
 481 
 482   const Register cache = r1;
 483   const Register index = r2;
 484 
 485   if (index_size == sizeof(u4)) {
 486     __ load_resolved_indy_entry(cache, index);
 487     __ load_unsigned_short(cache, Address(cache, in_bytes(ResolvedIndyEntry::num_parameters_offset())));
 488     __ add(esp, esp, cache, Assembler::LSL, 3);
 489   } else {
 490     // Pop N words from the stack
 491     assert(index_size == sizeof(u2), "Can only be u2");
 492     __ load_method_entry(cache, index);
 493     __ load_unsigned_short(cache, Address(cache, in_bytes(ResolvedMethodEntry::num_parameters_offset())));
 494     __ add(esp, esp, cache, Assembler::LSL, 3);
 495   }
 496 
 497   // Restore machine SP
 498   __ restore_sp_after_call();
 499 
 500   __ check_and_handle_popframe(rthread);
 501   __ check_and_handle_earlyret(rthread);
 502 
 503   __ get_dispatch();
 504   __ dispatch_next(state, step);
 505 
 506   return entry;
 507 }
 508 
 509 address TemplateInterpreterGenerator::generate_deopt_entry_for(TosState state,
 510                                                                int step,
 511                                                                address continuation) {
 512   address entry = __ pc();
 513   __ restore_bcp();
 514   __ restore_locals();
 515   __ restore_constant_pool_cache();
 516   __ get_method(rmethod);
 517   __ get_dispatch();
 518 
 519   __ restore_sp_after_call();  // Restore SP to extended SP
 520 
 521   // Restore expression stack pointer
 522   __ ldr(rscratch1, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));
 523   __ lea(esp, Address(rfp, rscratch1, Address::lsl(Interpreter::logStackElementSize)));
 524   // null last_sp until next java call
 525   __ str(zr, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));
 526 
 527   // handle exceptions
 528   {
 529     Label L;
 530     __ ldr(rscratch1, Address(rthread, Thread::pending_exception_offset()));
 531     __ cbz(rscratch1, L);
 532     __ call_VM(noreg,
 533                CAST_FROM_FN_PTR(address,
 534                                 InterpreterRuntime::throw_pending_exception));
 535     __ should_not_reach_here();
 536     __ bind(L);
 537   }
 538 
 539   if (continuation == nullptr) {
 540     __ dispatch_next(state, step);
 541   } else {
 542     __ jump_to_entry(continuation);
 543   }
 544   return entry;
 545 }
 546 
 547 address TemplateInterpreterGenerator::generate_result_handler_for(
 548         BasicType type) {
 549     address entry = __ pc();
 550   switch (type) {
 551   case T_BOOLEAN: __ c2bool(r0);         break;
 552   case T_CHAR   : __ uxth(r0, r0);       break;
 553   case T_BYTE   : __ sxtb(r0, r0);        break;
 554   case T_SHORT  : __ sxth(r0, r0);        break;
 555   case T_INT    : __ uxtw(r0, r0);        break;  // FIXME: We almost certainly don't need this
 556   case T_LONG   : /* nothing to do */        break;
 557   case T_VOID   : /* nothing to do */        break;
 558   case T_FLOAT  : /* nothing to do */        break;
 559   case T_DOUBLE : /* nothing to do */        break;
 560   case T_OBJECT :
 561     // retrieve result from frame
 562     __ ldr(r0, Address(rfp, frame::interpreter_frame_oop_temp_offset*wordSize));
 563     // and verify it
 564     __ verify_oop(r0);
 565     break;
 566   default       : ShouldNotReachHere();
 567   }
 568   __ ret(lr);                                  // return from result handler
 569   return entry;
 570 }
 571 
 572 address TemplateInterpreterGenerator::generate_safept_entry_for(
 573         TosState state,
 574         address runtime_entry) {
 575   address entry = __ pc();
 576   __ push(state);
 577   __ push_cont_fastpath(rthread);
 578   __ call_VM(noreg, runtime_entry);
 579   __ pop_cont_fastpath(rthread);
 580   __ membar(Assembler::AnyAny);
 581   __ dispatch_via(vtos, Interpreter::_normal_table.table_for(vtos));
 582   return entry;
 583 }
 584 
 585 address TemplateInterpreterGenerator::generate_cont_resume_interpreter_adapter() {
 586   if (!Continuations::enabled()) return nullptr;
 587   address start = __ pc();
 588 
 589   __ restore_bcp();
 590   __ restore_locals();
 591 
 592   // Restore constant pool cache
 593   __ ldr(rcpool, Address(rfp, frame::interpreter_frame_cache_offset * wordSize));
 594 
 595   // Restore Java expression stack pointer
 596   __ ldr(rscratch1, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));
 597   __ lea(esp, Address(rfp, rscratch1, Address::lsl(Interpreter::logStackElementSize)));
 598   // and null it as marker that esp is now tos until next java call
 599   __ str(zr, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));
 600 
 601   // Restore machine SP
 602   __ ldr(rscratch1, Address(rfp, frame::interpreter_frame_extended_sp_offset * wordSize));
 603   __ lea(sp, Address(rfp, rscratch1, Address::lsl(LogBytesPerWord)));
 604 
 605   // Restore method
 606   __ ldr(rmethod, Address(rfp, frame::interpreter_frame_method_offset * wordSize));
 607 
 608   // Restore dispatch
 609   uint64_t offset;
 610   __ adrp(rdispatch, ExternalAddress((address)Interpreter::dispatch_table()), offset);
 611   __ add(rdispatch, rdispatch, offset);
 612 
 613   __ ret(lr);
 614 
 615   return start;
 616 }
 617 
 618 
 619 // Helpers for commoning out cases in the various type of method entries.
 620 //
 621 
 622 
 623 // increment invocation count & check for overflow
 624 //
 625 // Note: checking for negative value instead of overflow
 626 //       so we have a 'sticky' overflow test
 627 //
 628 // rmethod: method
 629 //
 630 void TemplateInterpreterGenerator::generate_counter_incr(Label* overflow) {
 631   Label done;
 632   // Note: In tiered we increment either counters in Method* or in MDO depending if we're profiling or not.
 633   int increment = InvocationCounter::count_increment;
 634   Label no_mdo;
 635   if (ProfileInterpreter) {
 636     // Are we profiling?
 637     __ ldr(r0, Address(rmethod, Method::method_data_offset()));
 638     __ cbz(r0, no_mdo);
 639     // Increment counter in the MDO
 640     const Address mdo_invocation_counter(r0, in_bytes(MethodData::invocation_counter_offset()) +
 641                                               in_bytes(InvocationCounter::counter_offset()));
 642     const Address mask(r0, in_bytes(MethodData::invoke_mask_offset()));
 643     __ increment_mask_and_jump(mdo_invocation_counter, increment, mask, rscratch1, rscratch2, false, Assembler::EQ, overflow);
 644     __ b(done);
 645   }
 646   __ bind(no_mdo);
 647   // Increment counter in MethodCounters
 648   const Address invocation_counter(rscratch2,
 649                 MethodCounters::invocation_counter_offset() +
 650                 InvocationCounter::counter_offset());
 651   __ get_method_counters(rmethod, rscratch2, done);
 652   const Address mask(rscratch2, in_bytes(MethodCounters::invoke_mask_offset()));
 653   __ increment_mask_and_jump(invocation_counter, increment, mask, rscratch1, r1, false, Assembler::EQ, overflow);
 654   __ bind(done);
 655 }
 656 
 657 void TemplateInterpreterGenerator::generate_counter_overflow(Label& do_continue) {
 658 
 659   // Asm interpreter on entry
 660   // On return (i.e. jump to entry_point) [ back to invocation of interpreter ]
 661   // Everything as it was on entry
 662 
 663   // InterpreterRuntime::frequency_counter_overflow takes two
 664   // arguments, the first (thread) is passed by call_VM, the second
 665   // indicates if the counter overflow occurs at a backwards branch
 666   // (null bcp).  We pass zero for it.  The call returns the address
 667   // of the verified entry point for the method or null if the
 668   // compilation did not complete (either went background or bailed
 669   // out).
 670   __ mov(c_rarg1, 0);
 671   __ call_VM(noreg,
 672              CAST_FROM_FN_PTR(address,
 673                               InterpreterRuntime::frequency_counter_overflow),
 674              c_rarg1);
 675 
 676   __ b(do_continue);
 677 }
 678 
 679 // See if we've got enough room on the stack for locals plus overhead
 680 // below JavaThread::stack_overflow_limit(). If not, throw a StackOverflowError
 681 // without going through the signal handler, i.e., reserved and yellow zones
 682 // will not be made usable. The shadow zone must suffice to handle the
 683 // overflow.
 684 // The expression stack grows down incrementally, so the normal guard
 685 // page mechanism will work for that.
 686 //
 687 // NOTE: Since the additional locals are also always pushed (wasn't
 688 // obvious in generate_method_entry) so the guard should work for them
 689 // too.
 690 //
 691 // Args:
 692 //      r3: number of additional locals this frame needs (what we must check)
 693 //      rmethod: Method*
 694 //
 695 // Kills:
 696 //      r0
 697 void TemplateInterpreterGenerator::generate_stack_overflow_check(void) {
 698 
 699   // monitor entry size: see picture of stack set
 700   // (generate_method_entry) and frame_amd64.hpp
 701   const int entry_size = frame::interpreter_frame_monitor_size_in_bytes();
 702 
 703   // total overhead size: entry_size + (saved rbp through expr stack
 704   // bottom).  be sure to change this if you add/subtract anything
 705   // to/from the overhead area
 706   const int overhead_size =
 707     -(frame::interpreter_frame_initial_sp_offset * wordSize) + entry_size;
 708 
 709   const size_t page_size = os::vm_page_size();
 710 
 711   Label after_frame_check;
 712 
 713   // see if the frame is greater than one page in size. If so,
 714   // then we need to verify there is enough stack space remaining
 715   // for the additional locals.
 716   //
 717   // Note that we use SUBS rather than CMP here because the immediate
 718   // field of this instruction may overflow.  SUBS can cope with this
 719   // because it is a macro that will expand to some number of MOV
 720   // instructions and a register operation.
 721   __ subs(rscratch1, r3, (page_size - overhead_size) / Interpreter::stackElementSize);
 722   __ br(Assembler::LS, after_frame_check);
 723 
 724   // compute rsp as if this were going to be the last frame on
 725   // the stack before the red zone
 726 
 727   // locals + overhead, in bytes
 728   __ mov(r0, overhead_size);
 729   __ add(r0, r0, r3, Assembler::LSL, Interpreter::logStackElementSize);  // 2 slots per parameter.
 730 
 731   const Address stack_limit(rthread, JavaThread::stack_overflow_limit_offset());
 732   __ ldr(rscratch1, stack_limit);
 733 
 734 #ifdef ASSERT
 735   Label limit_okay;
 736   // Verify that thread stack limit is non-zero.
 737   __ cbnz(rscratch1, limit_okay);
 738   __ stop("stack overflow limit is zero");
 739   __ bind(limit_okay);
 740 #endif
 741 
 742   // Add stack limit to locals.
 743   __ add(r0, r0, rscratch1);
 744 
 745   // Check against the current stack bottom.
 746   __ cmp(sp, r0);
 747   __ br(Assembler::HI, after_frame_check);
 748 
 749   // Remove the incoming args, peeling the machine SP back to where it
 750   // was in the caller.  This is not strictly necessary, but unless we
 751   // do so the stack frame may have a garbage FP; this ensures a
 752   // correct call stack that we can always unwind.  The ANDR should be
 753   // unnecessary because the sender SP in r19 is always aligned, but
 754   // it doesn't hurt.
 755   __ andr(sp, r19_sender_sp, -16);
 756 
 757   // Note: the restored frame is not necessarily interpreted.
 758   // Use the shared runtime version of the StackOverflowError.
 759   assert(SharedRuntime::throw_StackOverflowError_entry() != nullptr, "stub not yet generated");
 760   __ far_jump(RuntimeAddress(SharedRuntime::throw_StackOverflowError_entry()));
 761 
 762   // all done with frame size check
 763   __ bind(after_frame_check);
 764 }
 765 
 766 // Allocate monitor and lock method (asm interpreter)
 767 //
 768 // Args:
 769 //      rmethod: Method*
 770 //      rlocals: locals
 771 //
 772 // Kills:
 773 //      r0
 774 //      c_rarg0, c_rarg1, c_rarg2, c_rarg3, ...(param regs)
 775 //      rscratch1, rscratch2 (scratch regs)
 776 void TemplateInterpreterGenerator::lock_method() {
 777   // synchronize method
 778   const Address access_flags(rmethod, Method::access_flags_offset());
 779   const Address monitor_block_top(
 780         rfp,
 781         frame::interpreter_frame_monitor_block_top_offset * wordSize);
 782   const int entry_size = frame::interpreter_frame_monitor_size_in_bytes();
 783 
 784 #ifdef ASSERT
 785   {
 786     Label L;
 787     __ ldrh(r0, access_flags);
 788     __ tst(r0, JVM_ACC_SYNCHRONIZED);
 789     __ br(Assembler::NE, L);
 790     __ stop("method doesn't need synchronization");
 791     __ bind(L);
 792   }
 793 #endif // ASSERT
 794 
 795   // get synchronization object
 796   {
 797     Label done;
 798     __ ldrh(r0, access_flags);
 799     __ tst(r0, JVM_ACC_STATIC);
 800     // get receiver (assume this is frequent case)
 801     __ ldr(r0, Address(rlocals, Interpreter::local_offset_in_bytes(0)));
 802     __ br(Assembler::EQ, done);
 803     __ load_mirror(r0, rmethod, r5, rscratch2);
 804 
 805 #ifdef ASSERT
 806     {
 807       Label L;
 808       __ cbnz(r0, L);
 809       __ stop("synchronization object is null");
 810       __ bind(L);
 811     }
 812 #endif // ASSERT
 813 
 814     __ bind(done);
 815   }
 816 
 817   // add space for monitor & lock
 818   __ check_extended_sp();
 819   __ sub(sp, sp, entry_size); // add space for a monitor entry
 820   __ sub(esp, esp, entry_size);
 821   __ sub(rscratch1, sp, rfp);
 822   __ asr(rscratch1, rscratch1, Interpreter::logStackElementSize);
 823   __ str(rscratch1, Address(rfp, frame::interpreter_frame_extended_sp_offset * wordSize));
 824   __ sub(rscratch1, esp, rfp);
 825   __ asr(rscratch1, rscratch1, Interpreter::logStackElementSize);
 826   __ str(rscratch1, monitor_block_top);  // set new monitor block top
 827 
 828   // store object
 829   __ str(r0, Address(esp, BasicObjectLock::obj_offset()));
 830   __ mov(c_rarg1, esp); // object address
 831   __ lock_object(c_rarg1);
 832 }
 833 
 834 // Generate a fixed interpreter frame. This is identical setup for
 835 // interpreted methods and for native methods hence the shared code.
 836 //
 837 // Args:
 838 //      lr: return address
 839 //      rmethod: Method*
 840 //      rlocals: pointer to locals
 841 //      rcpool: cp cache
 842 //      stack_pointer: previous sp
 843 void TemplateInterpreterGenerator::generate_fixed_frame(bool native_call) {
 844   // Save ConstMethod* in r5_const_method for later use to avoid loading multiple times
 845   Register r5_const_method = r5;
 846   __ ldr(r5_const_method, Address(rmethod, Method::const_offset()));
 847 
 848   // initialize fixed part of activation frame
 849   if (native_call) {
 850     __ sub(esp, sp, 14 *  wordSize);
 851     __ mov(rbcp, zr);
 852     __ mov(rscratch1, frame::interpreter_frame_initial_sp_offset);
 853     __ stp(rscratch1, zr, Address(__ pre(sp, -14 * wordSize)));
 854     // add 2 zero-initialized slots for native calls
 855     __ stp(zr, zr, Address(sp, 12 * wordSize));
 856   } else {
 857     __ sub(esp, sp, 12 *  wordSize);
 858     __ add(rbcp, r5_const_method, in_bytes(ConstMethod::codes_offset())); // get codebase
 859     __ mov(rscratch1, frame::interpreter_frame_initial_sp_offset);
 860     __ stp(rscratch1, rbcp, Address(__ pre(sp, -12 * wordSize)));
 861   }
 862 
 863   if (ProfileInterpreter) {
 864     Label method_data_continue;
 865     __ ldr(rscratch1, Address(rmethod, Method::method_data_offset()));
 866     __ cbz(rscratch1, method_data_continue);
 867     __ lea(rscratch1, Address(rscratch1, in_bytes(MethodData::data_offset())));
 868     __ bind(method_data_continue);
 869     __ stp(rscratch1, rmethod, Address(sp, 6 * wordSize));  // save Method* and mdp (method data pointer)
 870   } else {
 871     __ stp(zr, rmethod, Address(sp, 6 * wordSize));         // save Method* (no mdp)
 872   }
 873 
 874   __ protect_return_address();
 875   __ stp(rfp, lr, Address(sp, 10 * wordSize));
 876   __ lea(rfp, Address(sp, 10 * wordSize));
 877 
 878   // Save ConstantPool* in r11_constants for later use to avoid loading multiple times
 879   Register r11_constants = r11;
 880   __ ldr(r11_constants, Address(r5_const_method, ConstMethod::constants_offset()));
 881   __ ldr(rcpool, Address(r11_constants, ConstantPool::cache_offset()));
 882   __ sub(rscratch1, rlocals, rfp);
 883   __ lsr(rscratch1, rscratch1, Interpreter::logStackElementSize);   // rscratch1 = rlocals - fp();
 884   // Store relativized rlocals, see frame::interpreter_frame_locals().
 885   __ stp(rscratch1, rcpool, Address(sp, 2 * wordSize));
 886 
 887   // set sender sp
 888   // leave last_sp as null
 889   __ stp(zr, r19_sender_sp, Address(sp, 8 * wordSize));
 890 
 891   // Get mirror. Resolve ConstantPool* -> InstanceKlass* -> Java mirror.
 892   __ ldr(r10, Address(r11_constants, ConstantPool::pool_holder_offset()));
 893   __ ldr(r10, Address(r10, in_bytes(Klass::java_mirror_offset())));
 894   __ resolve_oop_handle(r10, rscratch1, rscratch2);
 895   if (! native_call) {
 896     __ ldrh(rscratch1, Address(r5_const_method, ConstMethod::max_stack_offset()));
 897     __ add(rscratch1, rscratch1, MAX2(3, Method::extra_stack_entries()));
 898     __ sub(rscratch1, sp, rscratch1, ext::uxtw, 3);
 899     __ andr(rscratch1, rscratch1, -16);
 900     __ sub(rscratch2, rscratch1, rfp);
 901     __ asr(rscratch2, rscratch2, Interpreter::logStackElementSize);
 902     // Store extended SP and mirror
 903     __ stp(r10, rscratch2, Address(sp, 4 * wordSize));
 904     // Move SP out of the way
 905     __ mov(sp, rscratch1);
 906   } else {
 907     // Make sure there is room for the exception oop pushed in case method throws
 908     // an exception (see TemplateInterpreterGenerator::generate_throw_exception())
 909     __ sub(rscratch1, sp, 2 * wordSize);
 910     __ sub(rscratch2, rscratch1, rfp);
 911     __ asr(rscratch2, rscratch2, Interpreter::logStackElementSize);
 912     __ stp(r10, rscratch2, Address(sp, 4 * wordSize));
 913     __ mov(sp, rscratch1);
 914   }
 915 }
 916 
 917 // End of helpers
 918 
 919 // Various method entries
 920 //------------------------------------------------------------------------------------------------------------------------
 921 //
 922 //
 923 
 924 // Method entry for java.lang.ref.Reference.get.
 925 address TemplateInterpreterGenerator::generate_Reference_get_entry(void) {
 926   // Code: _aload_0, _getfield, _areturn
 927   // parameter size = 1
 928   //
 929   // The code that gets generated by this routine is split into 2 parts:
 930   //    1. The "intrinsified" code for G1 (or any SATB based GC),
 931   //    2. The slow path - which is an expansion of the regular method entry.
 932   //
 933   // Notes:-
 934   // * In the G1 code we do not check whether we need to block for
 935   //   a safepoint. If G1 is enabled then we must execute the specialized
 936   //   code for Reference.get (except when the Reference object is null)
 937   //   so that we can log the value in the referent field with an SATB
 938   //   update buffer.
 939   //   If the code for the getfield template is modified so that the
 940   //   G1 pre-barrier code is executed when the current method is
 941   //   Reference.get() then going through the normal method entry
 942   //   will be fine.
 943   // * The G1 code can, however, check the receiver object (the instance
 944   //   of java.lang.Reference) and jump to the slow path if null. If the
 945   //   Reference object is null then we obviously cannot fetch the referent
 946   //   and so we don't need to call the G1 pre-barrier. Thus we can use the
 947   //   regular method entry code to generate the NPE.
 948   //
 949   // This code is based on generate_accessor_entry.
 950   //
 951   // rmethod: Method*
 952   // r19_sender_sp: senderSP must preserve for slow path, set SP to it on fast path
 953 
 954   // LR is live.  It must be saved around calls.
 955 
 956   address entry = __ pc();
 957 
 958   const int referent_offset = java_lang_ref_Reference::referent_offset();
 959 
 960   Label slow_path;
 961   const Register local_0 = c_rarg0;
 962   // Check if local 0 != null
 963   // If the receiver is null then it is OK to jump to the slow path.
 964   __ ldr(local_0, Address(esp, 0));
 965   __ cbz(local_0, slow_path);
 966 
 967   // Load the value of the referent field.
 968   const Address field_address(local_0, referent_offset);
 969   BarrierSetAssembler *bs = BarrierSet::barrier_set()->barrier_set_assembler();
 970   bs->load_at(_masm, IN_HEAP | ON_WEAK_OOP_REF, T_OBJECT, local_0, field_address, /*tmp1*/ rscratch1, /*tmp2*/ rscratch2);
 971 
 972   // areturn
 973   __ andr(sp, r19_sender_sp, -16);  // done with stack
 974   __ ret(lr);
 975 
 976   // generate a vanilla interpreter entry as the slow path
 977   __ bind(slow_path);
 978   __ jump_to_entry(Interpreter::entry_for_kind(Interpreter::zerolocals));
 979   return entry;
 980 
 981 }
 982 
 983 /**
 984  * Method entry for static native methods:
 985  *   int java.util.zip.CRC32.update(int crc, int b)
 986  */
 987 address TemplateInterpreterGenerator::generate_CRC32_update_entry() {
 988   assert(UseCRC32Intrinsics, "this intrinsic is not supported");
 989   address entry = __ pc();
 990 
 991   // rmethod: Method*
 992   // r19_sender_sp: senderSP must preserved for slow path
 993   // esp: args
 994 
 995   Label slow_path;
 996   // If we need a safepoint check, generate full interpreter entry.
 997   __ safepoint_poll(slow_path, false /* at_return */, false /* in_nmethod */);
 998 
 999   // We don't generate local frame and don't align stack because
1000   // we call stub code and there is no safepoint on this path.
1001 
1002   // Load parameters
1003   const Register crc = c_rarg0;  // crc
1004   const Register val = c_rarg1;  // source java byte value
1005   const Register tbl = c_rarg2;  // scratch
1006 
1007   // Arguments are reversed on java expression stack
1008   __ ldrw(val, Address(esp, 0));              // byte value
1009   __ ldrw(crc, Address(esp, wordSize));       // Initial CRC
1010 
1011   uint64_t offset;
1012   __ adrp(tbl, ExternalAddress(StubRoutines::crc_table_addr()), offset);
1013   __ add(tbl, tbl, offset);
1014 
1015   __ mvnw(crc, crc); // ~crc
1016   __ update_byte_crc32(crc, val, tbl);
1017   __ mvnw(crc, crc); // ~crc
1018 
1019   // result in c_rarg0
1020 
1021   __ andr(sp, r19_sender_sp, -16);
1022   __ ret(lr);
1023 
1024   // generate a vanilla native entry as the slow path
1025   __ bind(slow_path);
1026   __ jump_to_entry(Interpreter::entry_for_kind(Interpreter::native));
1027   return entry;
1028 }
1029 
1030 /**
1031  * Method entry for static native methods:
1032  *   int java.util.zip.CRC32.updateBytes(int crc, byte[] b, int off, int len)
1033  *   int java.util.zip.CRC32.updateByteBuffer(int crc, long buf, int off, int len)
1034  */
1035 address TemplateInterpreterGenerator::generate_CRC32_updateBytes_entry(AbstractInterpreter::MethodKind kind) {
1036   assert(UseCRC32Intrinsics, "this intrinsic is not supported");
1037   address entry = __ pc();
1038 
1039   // rmethod,: Method*
1040   // r19_sender_sp: senderSP must preserved for slow path
1041 
1042   Label slow_path;
1043   // If we need a safepoint check, generate full interpreter entry.
1044   __ safepoint_poll(slow_path, false /* at_return */, false /* in_nmethod */);
1045 
1046   // We don't generate local frame and don't align stack because
1047   // we call stub code and there is no safepoint on this path.
1048 
1049   // Load parameters
1050   const Register crc = c_rarg0;  // crc
1051   const Register buf = c_rarg1;  // source java byte array address
1052   const Register len = c_rarg2;  // length
1053   const Register off = len;      // offset (never overlaps with 'len')
1054 
1055   // Arguments are reversed on java expression stack
1056   // Calculate address of start element
1057   if (kind == Interpreter::java_util_zip_CRC32_updateByteBuffer) {
1058     __ ldr(buf, Address(esp, 2*wordSize)); // long buf
1059     __ ldrw(off, Address(esp, wordSize)); // offset
1060     __ add(buf, buf, off); // + offset
1061     __ ldrw(crc,   Address(esp, 4*wordSize)); // Initial CRC
1062   } else {
1063     __ ldr(buf, Address(esp, 2*wordSize)); // byte[] array
1064     __ add(buf, buf, arrayOopDesc::base_offset_in_bytes(T_BYTE)); // + header size
1065     __ ldrw(off, Address(esp, wordSize)); // offset
1066     __ add(buf, buf, off); // + offset
1067     __ ldrw(crc,   Address(esp, 3*wordSize)); // Initial CRC
1068   }
1069   // Can now load 'len' since we're finished with 'off'
1070   __ ldrw(len, Address(esp, 0x0)); // Length
1071 
1072   __ andr(sp, r19_sender_sp, -16); // Restore the caller's SP
1073 
1074   // We are frameless so we can just jump to the stub.
1075   __ b(CAST_FROM_FN_PTR(address, StubRoutines::updateBytesCRC32()));
1076 
1077   // generate a vanilla native entry as the slow path
1078   __ bind(slow_path);
1079   __ jump_to_entry(Interpreter::entry_for_kind(Interpreter::native));
1080   return entry;
1081 }
1082 
1083 /**
1084  * Method entry for intrinsic-candidate (non-native) methods:
1085  *   int java.util.zip.CRC32C.updateBytes(int crc, byte[] b, int off, int end)
1086  *   int java.util.zip.CRC32C.updateDirectByteBuffer(int crc, long buf, int off, int end)
1087  * Unlike CRC32, CRC32C does not have any methods marked as native
1088  * CRC32C also uses an "end" variable instead of the length variable CRC32 uses
1089  */
1090 address TemplateInterpreterGenerator::generate_CRC32C_updateBytes_entry(AbstractInterpreter::MethodKind kind) {
1091   assert(UseCRC32CIntrinsics, "this intrinsic is not supported");
1092   address entry = __ pc();
1093 
1094   // Prepare jump to stub using parameters from the stack
1095   const Register crc = c_rarg0; // initial crc
1096   const Register buf = c_rarg1; // source java byte array address
1097   const Register len = c_rarg2; // len argument to the kernel
1098 
1099   const Register end = len; // index of last element to process
1100   const Register off = crc; // offset
1101 
1102   __ ldrw(end, Address(esp)); // int end
1103   __ ldrw(off, Address(esp, wordSize)); // int offset
1104   __ sub(len, end, off);
1105   __ ldr(buf, Address(esp, 2*wordSize)); // byte[] buf | long buf
1106   __ add(buf, buf, off); // + offset
1107   if (kind == Interpreter::java_util_zip_CRC32C_updateDirectByteBuffer) {
1108     __ ldrw(crc, Address(esp, 4*wordSize)); // long crc
1109   } else {
1110     __ add(buf, buf, arrayOopDesc::base_offset_in_bytes(T_BYTE)); // + header size
1111     __ ldrw(crc, Address(esp, 3*wordSize)); // long crc
1112   }
1113 
1114   __ andr(sp, r19_sender_sp, -16); // Restore the caller's SP
1115 
1116   // Jump to the stub.
1117   __ b(CAST_FROM_FN_PTR(address, StubRoutines::updateBytesCRC32C()));
1118 
1119   return entry;
1120 }
1121 
1122 void TemplateInterpreterGenerator::bang_stack_shadow_pages(bool native_call) {
1123   // See more discussion in stackOverflow.hpp.
1124 
1125   const int shadow_zone_size = checked_cast<int>(StackOverflow::stack_shadow_zone_size());
1126   const int page_size = (int)os::vm_page_size();
1127   const int n_shadow_pages = shadow_zone_size / page_size;
1128 
1129 #ifdef ASSERT
1130   Label L_good_limit;
1131   __ ldr(rscratch1, Address(rthread, JavaThread::shadow_zone_safe_limit()));
1132   __ cbnz(rscratch1, L_good_limit);
1133   __ stop("shadow zone safe limit is not initialized");
1134   __ bind(L_good_limit);
1135 
1136   Label L_good_watermark;
1137   __ ldr(rscratch1, Address(rthread, JavaThread::shadow_zone_growth_watermark()));
1138   __ cbnz(rscratch1, L_good_watermark);
1139   __ stop("shadow zone growth watermark is not initialized");
1140   __ bind(L_good_watermark);
1141 #endif
1142 
1143   Label L_done;
1144 
1145   __ ldr(rscratch1, Address(rthread, JavaThread::shadow_zone_growth_watermark()));
1146   __ cmp(sp, rscratch1);
1147   __ br(Assembler::HI, L_done);
1148 
1149   for (int p = 1; p <= n_shadow_pages; p++) {
1150     __ sub(rscratch2, sp, p*page_size);
1151     __ str(zr, Address(rscratch2));
1152   }
1153 
1154   // Record the new watermark, but only if the update is above the safe limit.
1155   // Otherwise, the next time around the check above would pass the safe limit.
1156   __ ldr(rscratch1, Address(rthread, JavaThread::shadow_zone_safe_limit()));
1157   __ cmp(sp, rscratch1);
1158   __ br(Assembler::LS, L_done);
1159   __ mov(rscratch1, sp);
1160   __ str(rscratch1, Address(rthread, JavaThread::shadow_zone_growth_watermark()));
1161 
1162   __ bind(L_done);
1163 }
1164 
1165 // Interpreter stub for calling a native method. (asm interpreter)
1166 // This sets up a somewhat different looking stack for calling the
1167 // native method than the typical interpreter frame setup.
1168 address TemplateInterpreterGenerator::generate_native_entry(bool synchronized) {
1169   // determine code generation flags
1170   bool inc_counter  = UseCompiler || CountCompiledCalls;
1171 
1172   // r1: Method*
1173   // rscratch1: sender sp
1174 
1175   address entry_point = __ pc();
1176 
1177   const Address constMethod       (rmethod, Method::const_offset());
1178   const Address access_flags      (rmethod, Method::access_flags_offset());
1179   const Address size_of_parameters(r2, ConstMethod::
1180                                        size_of_parameters_offset());
1181 
1182   // get parameter size (always needed)
1183   __ ldr(r2, constMethod);
1184   __ load_unsigned_short(r2, size_of_parameters);
1185 
1186   // Native calls don't need the stack size check since they have no
1187   // expression stack and the arguments are already on the stack and
1188   // we only add a handful of words to the stack.
1189 
1190   // rmethod: Method*
1191   // r2: size of parameters
1192   // rscratch1: sender sp
1193 
1194   // for natives the size of locals is zero
1195 
1196   // compute beginning of parameters (rlocals)
1197   __ add(rlocals, esp, r2, ext::uxtx, 3);
1198   __ add(rlocals, rlocals, -wordSize);
1199 
1200   // Pull SP back to minimum size: this avoids holes in the stack
1201   __ andr(sp, esp, -16);
1202 
1203   // initialize fixed part of activation frame
1204   generate_fixed_frame(true);
1205 
1206   // make sure method is native & not abstract
1207 #ifdef ASSERT
1208   __ ldrh(r0, access_flags);
1209   {
1210     Label L;
1211     __ tst(r0, JVM_ACC_NATIVE);
1212     __ br(Assembler::NE, L);
1213     __ stop("tried to execute non-native method as native");
1214     __ bind(L);
1215   }
1216   {
1217     Label L;
1218     __ tst(r0, JVM_ACC_ABSTRACT);
1219     __ br(Assembler::EQ, L);
1220     __ stop("tried to execute abstract method in interpreter");
1221     __ bind(L);
1222   }
1223 #endif
1224 
1225   // Since at this point in the method invocation the exception
1226   // handler would try to exit the monitor of synchronized methods
1227   // which hasn't been entered yet, we set the thread local variable
1228   // _do_not_unlock_if_synchronized to true. The remove_activation
1229   // will check this flag.
1230 
1231    const Address do_not_unlock_if_synchronized(rthread,
1232         in_bytes(JavaThread::do_not_unlock_if_synchronized_offset()));
1233   __ mov(rscratch2, true);
1234   __ strb(rscratch2, do_not_unlock_if_synchronized);
1235 
1236   // increment invocation count & check for overflow
1237   Label invocation_counter_overflow;
1238   if (inc_counter) {
1239     generate_counter_incr(&invocation_counter_overflow);
1240   }
1241 
1242   Label continue_after_compile;
1243   __ bind(continue_after_compile);
1244 
1245   bang_stack_shadow_pages(true);
1246 
1247   // reset the _do_not_unlock_if_synchronized flag
1248   __ strb(zr, do_not_unlock_if_synchronized);
1249 
1250   // check for synchronized methods
1251   // Must happen AFTER invocation_counter check and stack overflow check,
1252   // so method is not locked if overflows.
1253   if (synchronized) {
1254     lock_method();
1255   } else {
1256     // no synchronization necessary
1257 #ifdef ASSERT
1258     {
1259       Label L;
1260       __ ldrh(r0, access_flags);
1261       __ tst(r0, JVM_ACC_SYNCHRONIZED);
1262       __ br(Assembler::EQ, L);
1263       __ stop("method needs synchronization");
1264       __ bind(L);
1265     }
1266 #endif
1267   }
1268 
1269   // start execution
1270 #ifdef ASSERT
1271   {
1272     Label L;
1273     const Address monitor_block_top(rfp,
1274                  frame::interpreter_frame_monitor_block_top_offset * wordSize);
1275     __ ldr(rscratch1, monitor_block_top);
1276     __ lea(rscratch1, Address(rfp, rscratch1, Address::lsl(Interpreter::logStackElementSize)));
1277     __ cmp(esp, rscratch1);
1278     __ br(Assembler::EQ, L);
1279     __ stop("broken stack frame setup in interpreter 1");
1280     __ bind(L);
1281   }
1282 #endif
1283 
1284   // jvmti support
1285   __ notify_method_entry();
1286 
1287   // work registers
1288   const Register t = r17;
1289   const Register result_handler = r19;
1290 
1291   // allocate space for parameters
1292   __ ldr(t, Address(rmethod, Method::const_offset()));
1293   __ load_unsigned_short(t, Address(t, ConstMethod::size_of_parameters_offset()));
1294 
1295   __ sub(rscratch1, esp, t, ext::uxtx, Interpreter::logStackElementSize);
1296   __ andr(sp, rscratch1, -16);
1297   __ mov(esp, rscratch1);
1298 
1299   // get signature handler
1300   {
1301     Label L;
1302     __ ldr(t, Address(rmethod, Method::signature_handler_offset()));
1303     __ cbnz(t, L);
1304     __ call_VM(noreg,
1305                CAST_FROM_FN_PTR(address,
1306                                 InterpreterRuntime::prepare_native_call),
1307                rmethod);
1308     __ ldr(t, Address(rmethod, Method::signature_handler_offset()));
1309     __ bind(L);
1310   }
1311 
1312   // call signature handler
1313   assert(InterpreterRuntime::SignatureHandlerGenerator::from() == rlocals,
1314          "adjust this code");
1315   assert(InterpreterRuntime::SignatureHandlerGenerator::to() == sp,
1316          "adjust this code");
1317   assert(InterpreterRuntime::SignatureHandlerGenerator::temp() == rscratch1,
1318           "adjust this code");
1319 
1320   // The generated handlers do not touch rmethod (the method).
1321   // However, large signatures cannot be cached and are generated
1322   // each time here.  The slow-path generator can do a GC on return,
1323   // so we must reload it after the call.
1324   __ blr(t);
1325   __ get_method(rmethod);        // slow path can do a GC, reload rmethod
1326 
1327 
1328   // result handler is in r0
1329   // set result handler
1330   __ mov(result_handler, r0);
1331   // Save it in the frame in case of preemption; we cannot rely on callee saved registers.
1332   __ str(r0, Address(rfp, frame::interpreter_frame_result_handler_offset * wordSize));
1333 
1334   // pass mirror handle if static call
1335   {
1336     Label L;
1337     __ ldrh(t, Address(rmethod, Method::access_flags_offset()));
1338     __ tbz(t, exact_log2(JVM_ACC_STATIC), L);
1339     // get mirror
1340     __ load_mirror(t, rmethod, r10, rscratch2);
1341     // copy mirror into activation frame
1342     __ str(t, Address(rfp, frame::interpreter_frame_oop_temp_offset * wordSize));
1343     // pass handle to mirror
1344     __ add(c_rarg1, rfp, frame::interpreter_frame_oop_temp_offset * wordSize);
1345     __ bind(L);
1346   }
1347 
1348   // get native function entry point in r10
1349   {
1350     Label L;
1351     __ ldr(r10, Address(rmethod, Method::native_function_offset()));
1352     ExternalAddress unsatisfied(SharedRuntime::native_method_throw_unsatisfied_link_error_entry());
1353     __ lea(rscratch2, unsatisfied);
1354     __ cmp(r10, rscratch2);
1355     __ br(Assembler::NE, L);
1356     __ call_VM(noreg,
1357                CAST_FROM_FN_PTR(address,
1358                                 InterpreterRuntime::prepare_native_call),
1359                rmethod);
1360     __ get_method(rmethod);
1361     __ ldr(r10, Address(rmethod, Method::native_function_offset()));
1362     __ bind(L);
1363   }
1364 
1365   // pass JNIEnv
1366   __ add(c_rarg0, rthread, in_bytes(JavaThread::jni_environment_offset()));
1367 
1368   // It is enough that the pc() points into the right code
1369   // segment. It does not have to be the correct return pc.
1370   // For convenience we use the pc we want to resume to in
1371   // case of preemption on Object.wait.
1372   Label native_return;
1373   __ set_last_Java_frame(esp, rfp, native_return, rscratch1);
1374 
1375   // change thread state
1376 #ifdef ASSERT
1377   {
1378     Label L;
1379     __ ldrw(t, Address(rthread, JavaThread::thread_state_offset()));
1380     __ cmp(t, (u1)_thread_in_Java);
1381     __ br(Assembler::EQ, L);
1382     __ stop("Wrong thread state in native stub");
1383     __ bind(L);
1384   }
1385 #endif
1386 
1387   // Change state to native
1388   __ mov(rscratch1, _thread_in_native);
1389   __ lea(rscratch2, Address(rthread, JavaThread::thread_state_offset()));
1390   __ stlrw(rscratch1, rscratch2);
1391 
1392   __ push_cont_fastpath();
1393 
1394   // Call the native method.
1395   __ blr(r10);
1396 
1397   __ pop_cont_fastpath();
1398 
1399   __ get_method(rmethod);
1400   // result potentially in r0 or v0
1401 
1402   // Restore cpu control state after JNI call
1403   __ restore_cpu_control_state_after_jni(rscratch1, rscratch2);
1404 
1405   // make room for the pushes we're about to do
1406   __ sub(rscratch1, esp, 4 * wordSize);
1407   __ andr(sp, rscratch1, -16);
1408 
1409   // NOTE: The order of these pushes is known to frame::interpreter_frame_result
1410   // in order to extract the result of a method call. If the order of these
1411   // pushes change or anything else is added to the stack then the code in
1412   // interpreter_frame_result must also change.
1413   __ push(dtos);
1414   __ push(ltos);
1415 
1416   __ verify_sve_vector_length();
1417 
1418   // change thread state
1419   __ mov(rscratch1, _thread_in_native_trans);
1420   __ lea(rscratch2, Address(rthread, JavaThread::thread_state_offset()));
1421   __ stlrw(rscratch1, rscratch2);
1422 
1423   // Force this write out before the read below
1424   if (!UseSystemMemoryBarrier) {
1425     __ dmb(Assembler::ISH);
1426   }
1427 
1428   // check for safepoint operation in progress and/or pending suspend requests
1429   {
1430     Label L, Continue;
1431 
1432     // No need for acquire as Java threads always disarm themselves.
1433     __ safepoint_poll(L, true /* at_return */, false /* in_nmethod */);
1434     __ ldrw(rscratch2, Address(rthread, JavaThread::suspend_flags_offset()));
1435     __ cbz(rscratch2, Continue);
1436     __ bind(L);
1437 
1438     // Don't use call_VM as it will see a possible pending exception
1439     // and forward it and never return here preventing us from
1440     // clearing _last_native_pc down below. So we do a runtime call by
1441     // hand.
1442     //
1443     __ mov(c_rarg0, rthread);
1444     __ lea(rscratch2, RuntimeAddress(CAST_FROM_FN_PTR(address, JavaThread::check_special_condition_for_native_trans)));
1445     __ blr(rscratch2);
1446     __ get_method(rmethod);
1447     __ reinit_heapbase();
1448     __ bind(Continue);
1449   }
1450 
1451   // change thread state
1452   __ mov(rscratch1, _thread_in_Java);
1453   __ lea(rscratch2, Address(rthread, JavaThread::thread_state_offset()));
1454   __ stlrw(rscratch1, rscratch2);
1455 
1456   // Check preemption for Object.wait()
1457   Label not_preempted;
1458   __ ldr(rscratch1, Address(rthread, JavaThread::preempt_alternate_return_offset()));
1459   __ cbz(rscratch1, not_preempted);
1460   __ str(zr, Address(rthread, JavaThread::preempt_alternate_return_offset()));
1461   __ br(rscratch1);
1462   __ bind(native_return);
1463   __ restore_after_resume(true /* is_native */);
1464   // reload result_handler
1465   __ ldr(result_handler, Address(rfp, frame::interpreter_frame_result_handler_offset*wordSize));
1466   __ bind(not_preempted);
1467 
1468   // reset_last_Java_frame
1469   __ reset_last_Java_frame(true);
1470 
1471   if (CheckJNICalls) {
1472     // clear_pending_jni_exception_check
1473     __ str(zr, Address(rthread, JavaThread::pending_jni_exception_check_fn_offset()));
1474   }
1475 
1476   // reset handle block
1477   __ ldr(t, Address(rthread, JavaThread::active_handles_offset()));
1478   __ str(zr, Address(t, JNIHandleBlock::top_offset()));
1479 
1480   // If result is an oop unbox and store it in frame where gc will see it
1481   // and result handler will pick it up
1482 
1483   {
1484     Label no_oop;
1485     __ adr(t, ExternalAddress(AbstractInterpreter::result_handler(T_OBJECT)));
1486     __ cmp(t, result_handler);
1487     __ br(Assembler::NE, no_oop);
1488     // Unbox oop result, e.g. JNIHandles::resolve result.
1489     __ pop(ltos);
1490     __ resolve_jobject(r0, t, rscratch2);
1491     __ str(r0, Address(rfp, frame::interpreter_frame_oop_temp_offset*wordSize));
1492     // keep stack depth as expected by pushing oop which will eventually be discarded
1493     __ push(ltos);
1494     __ bind(no_oop);
1495   }
1496 
1497   {
1498     Label no_reguard;
1499     __ lea(rscratch1, Address(rthread, in_bytes(JavaThread::stack_guard_state_offset())));
1500     __ ldrw(rscratch1, Address(rscratch1));
1501     __ cmp(rscratch1, (u1)StackOverflow::stack_guard_yellow_reserved_disabled);
1502     __ br(Assembler::NE, no_reguard);
1503 
1504     __ push_call_clobbered_registers();
1505     __ mov(c_rarg0, rthread);
1506     __ lea(rscratch2, RuntimeAddress(CAST_FROM_FN_PTR(address, SharedRuntime::reguard_yellow_pages)));
1507     __ blr(rscratch2);
1508     __ pop_call_clobbered_registers();
1509 
1510     __ bind(no_reguard);
1511   }
1512 
1513   // The method register is junk from after the thread_in_native transition
1514   // until here.  Also can't call_VM until the bcp has been
1515   // restored.  Need bcp for throwing exception below so get it now.
1516   __ get_method(rmethod);
1517 
1518   // restore bcp to have legal interpreter frame, i.e., bci == 0 <=>
1519   // rbcp == code_base()
1520   __ ldr(rbcp, Address(rmethod, Method::const_offset()));   // get ConstMethod*
1521   __ add(rbcp, rbcp, in_bytes(ConstMethod::codes_offset()));          // get codebase
1522   // handle exceptions (exception handling will handle unlocking!)
1523   {
1524     Label L;
1525     __ ldr(rscratch1, Address(rthread, Thread::pending_exception_offset()));
1526     __ cbz(rscratch1, L);
1527     // Note: At some point we may want to unify this with the code
1528     // used in call_VM_base(); i.e., we should use the
1529     // StubRoutines::forward_exception code. For now this doesn't work
1530     // here because the rsp is not correctly set at this point.
1531     __ MacroAssembler::call_VM(noreg,
1532                                CAST_FROM_FN_PTR(address,
1533                                InterpreterRuntime::throw_pending_exception));
1534     __ should_not_reach_here();
1535     __ bind(L);
1536   }
1537 
1538   // do unlocking if necessary
1539   {
1540     Label L;
1541     __ ldrh(t, Address(rmethod, Method::access_flags_offset()));
1542     __ tbz(t, exact_log2(JVM_ACC_SYNCHRONIZED), L);
1543     // the code below should be shared with interpreter macro
1544     // assembler implementation
1545     {
1546       Label unlock;
1547       // BasicObjectLock will be first in list, since this is a
1548       // synchronized method. However, need to check that the object
1549       // has not been unlocked by an explicit monitorexit bytecode.
1550 
1551       // monitor expect in c_rarg1 for slow unlock path
1552       __ lea (c_rarg1, Address(rfp,   // address of first monitor
1553                                (intptr_t)(frame::interpreter_frame_initial_sp_offset *
1554                                           wordSize - sizeof(BasicObjectLock))));
1555 
1556       __ ldr(t, Address(c_rarg1, BasicObjectLock::obj_offset()));
1557       __ cbnz(t, unlock);
1558 
1559       // Entry already unlocked, need to throw exception
1560       __ MacroAssembler::call_VM(noreg,
1561                                  CAST_FROM_FN_PTR(address,
1562                    InterpreterRuntime::throw_illegal_monitor_state_exception));
1563       __ should_not_reach_here();
1564 
1565       __ bind(unlock);
1566       __ unlock_object(c_rarg1);
1567     }
1568     __ bind(L);
1569   }
1570 
1571   #if INCLUDE_JFR
1572   __ enter_jfr_critical_section();
1573 
1574   // This poll test is to uphold the invariant that a JFR sampled frame
1575   // must not return to its caller without a prior safepoint poll check.
1576   // The earlier poll check in this routine is insufficient for this purpose
1577   // because the thread has transitioned back to Java.
1578 
1579   Label slow_path;
1580   Label fast_path;
1581   __ safepoint_poll(slow_path, true /* at_return */, false /* in_nmethod */);
1582   __ br(Assembler::AL, fast_path);
1583   __ bind(slow_path);
1584   __ push(dtos);
1585   __ push(ltos);
1586   __ set_last_Java_frame(esp, rfp, __ pc(), rscratch1);
1587   __ super_call_VM_leaf(CAST_FROM_FN_PTR(address, InterpreterRuntime::at_unwind), rthread);
1588   __ reset_last_Java_frame(true);
1589   __ pop(ltos);
1590   __ pop(dtos);
1591   __ bind(fast_path);
1592 
1593 #endif // INCLUDE_JFR
1594 
1595   // jvmti support
1596   // Note: This must happen _after_ handling/throwing any exceptions since
1597   //       the exception handler code notifies the runtime of method exits
1598   //       too. If this happens before, method entry/exit notifications are
1599   //       not properly paired (was bug - gri 11/22/99).
1600   __ notify_method_exit(vtos, InterpreterMacroAssembler::NotifyJVMTI);
1601 
1602   // restore potential result in r0:d0, call result handler to
1603   // restore potential result in ST0 & handle result
1604 
1605   __ pop(ltos);
1606   __ pop(dtos);
1607 
1608   __ blr(result_handler);
1609 
1610   // remove activation
1611   __ ldr(esp, Address(rfp,
1612                     frame::interpreter_frame_sender_sp_offset *
1613                     wordSize)); // get sender sp
1614   // remove frame anchor
1615   __ leave();
1616 
1617   JFR_ONLY(__ leave_jfr_critical_section();)
1618 
1619   // restore sender sp
1620   __ mov(sp, esp);
1621 
1622   __ ret(lr);
1623 
1624   if (inc_counter) {
1625     // Handle overflow of counter and compile method
1626     __ bind(invocation_counter_overflow);
1627     generate_counter_overflow(continue_after_compile);
1628   }
1629 
1630   return entry_point;
1631 }
1632 
1633 //
1634 // Generic interpreted method entry to (asm) interpreter
1635 //
1636 address TemplateInterpreterGenerator::generate_normal_entry(bool synchronized) {
1637   // determine code generation flags
1638   bool inc_counter  = UseCompiler || CountCompiledCalls;
1639 
1640   // rscratch1: sender sp
1641   address entry_point = __ pc();
1642 
1643   const Address constMethod(rmethod, Method::const_offset());
1644   const Address access_flags(rmethod, Method::access_flags_offset());
1645   const Address size_of_parameters(r3,
1646                                    ConstMethod::size_of_parameters_offset());
1647   const Address size_of_locals(r3, ConstMethod::size_of_locals_offset());
1648 
1649   // get parameter size (always needed)
1650   // need to load the const method first
1651   __ ldr(r3, constMethod);
1652   __ load_unsigned_short(r2, size_of_parameters);
1653 
1654   // r2: size of parameters
1655 
1656   __ load_unsigned_short(r3, size_of_locals); // get size of locals in words
1657   __ sub(r3, r3, r2); // r3 = no. of additional locals
1658 
1659   // see if we've got enough room on the stack for locals plus overhead.
1660   generate_stack_overflow_check();
1661 
1662   // compute beginning of parameters (rlocals)
1663   __ add(rlocals, esp, r2, ext::uxtx, 3);
1664   __ sub(rlocals, rlocals, wordSize);
1665 
1666   __ mov(rscratch1, esp);
1667 
1668   // r3 - # of additional locals
1669   // allocate space for locals
1670   // explicitly initialize locals
1671   // Initializing memory allocated for locals in the same direction as
1672   // the stack grows to ensure page initialization order according
1673   // to windows-aarch64 stack page growth requirement (see
1674   // https://docs.microsoft.com/en-us/cpp/build/arm64-windows-abi-conventions?view=msvc-160#stack)
1675   {
1676     Label exit, loop;
1677     __ ands(zr, r3, r3);
1678     __ br(Assembler::LE, exit); // do nothing if r3 <= 0
1679     __ bind(loop);
1680     __ str(zr, Address(__ pre(rscratch1, -wordSize)));
1681     __ sub(r3, r3, 1); // until everything initialized
1682     __ cbnz(r3, loop);
1683     __ bind(exit);
1684   }
1685 
1686   // Padding between locals and fixed part of activation frame to ensure
1687   // SP is always 16-byte aligned.
1688   __ andr(sp, rscratch1, -16);
1689 
1690   // And the base dispatch table
1691   __ get_dispatch();
1692 
1693   // initialize fixed part of activation frame
1694   generate_fixed_frame(false);
1695 
1696   // make sure method is not native & not abstract
1697 #ifdef ASSERT
1698   __ ldrh(r0, access_flags);
1699   {
1700     Label L;
1701     __ tst(r0, JVM_ACC_NATIVE);
1702     __ br(Assembler::EQ, L);
1703     __ stop("tried to execute native method as non-native");
1704     __ bind(L);
1705   }
1706  {
1707     Label L;
1708     __ tst(r0, JVM_ACC_ABSTRACT);
1709     __ br(Assembler::EQ, L);
1710     __ stop("tried to execute abstract method in interpreter");
1711     __ bind(L);
1712   }
1713 #endif
1714 
1715   // Since at this point in the method invocation the exception
1716   // handler would try to exit the monitor of synchronized methods
1717   // which hasn't been entered yet, we set the thread local variable
1718   // _do_not_unlock_if_synchronized to true. The remove_activation
1719   // will check this flag.
1720 
1721    const Address do_not_unlock_if_synchronized(rthread,
1722         in_bytes(JavaThread::do_not_unlock_if_synchronized_offset()));
1723   __ mov(rscratch2, true);
1724   __ strb(rscratch2, do_not_unlock_if_synchronized);
1725 
1726   Register mdp = r3;
1727   __ profile_parameters_type(mdp, r1, r2);
1728 
1729   // increment invocation count & check for overflow
1730   Label invocation_counter_overflow;
1731   if (inc_counter) {
1732     generate_counter_incr(&invocation_counter_overflow);
1733   }
1734 
1735   Label continue_after_compile;
1736   __ bind(continue_after_compile);
1737 
1738   bang_stack_shadow_pages(false);
1739 
1740   // reset the _do_not_unlock_if_synchronized flag
1741   __ strb(zr, do_not_unlock_if_synchronized);
1742 
1743   // check for synchronized methods
1744   // Must happen AFTER invocation_counter check and stack overflow check,
1745   // so method is not locked if overflows.
1746   if (synchronized) {
1747     // Allocate monitor and lock method
1748     lock_method();
1749   } else {
1750     // no synchronization necessary
1751 #ifdef ASSERT
1752     {
1753       Label L;
1754       __ ldrh(r0, access_flags);
1755       __ tst(r0, JVM_ACC_SYNCHRONIZED);
1756       __ br(Assembler::EQ, L);
1757       __ stop("method needs synchronization");
1758       __ bind(L);
1759     }
1760 #endif
1761   }
1762 
1763   // start execution
1764 #ifdef ASSERT
1765   {
1766     Label L;
1767      const Address monitor_block_top (rfp,
1768                  frame::interpreter_frame_monitor_block_top_offset * wordSize);
1769     __ ldr(rscratch1, monitor_block_top);
1770     __ lea(rscratch1, Address(rfp, rscratch1, Address::lsl(Interpreter::logStackElementSize)));
1771     __ cmp(esp, rscratch1);
1772     __ br(Assembler::EQ, L);
1773     __ stop("broken stack frame setup in interpreter 2");
1774     __ bind(L);
1775   }
1776 #endif
1777 
1778   // jvmti support
1779   __ notify_method_entry();
1780 
1781   __ dispatch_next(vtos);
1782 
1783   // invocation counter overflow
1784   if (inc_counter) {
1785     // Handle overflow of counter and compile method
1786     __ bind(invocation_counter_overflow);
1787     generate_counter_overflow(continue_after_compile);
1788   }
1789 
1790   return entry_point;
1791 }
1792 
1793 // Method entry for java.lang.Thread.currentThread
1794 address TemplateInterpreterGenerator::generate_currentThread() {
1795   address entry_point = __ pc();
1796 
1797   __ ldr(r0, Address(rthread, JavaThread::vthread_offset()));
1798   __ resolve_oop_handle(r0, rscratch1, rscratch2);
1799   __ ret(lr);
1800 
1801   return entry_point;
1802 }
1803 
1804 //-----------------------------------------------------------------------------
1805 // Exceptions
1806 
1807 void TemplateInterpreterGenerator::generate_throw_exception() {
1808   // Entry point in previous activation (i.e., if the caller was
1809   // interpreted)
1810   Interpreter::_rethrow_exception_entry = __ pc();
1811   // Restore sp to interpreter_frame_last_sp even though we are going
1812   // to empty the expression stack for the exception processing.
1813   __ str(zr, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));
1814   // r0: exception
1815   // r3: return address/pc that threw exception
1816   __ restore_bcp();    // rbcp points to call/send
1817   __ restore_locals();
1818   __ restore_constant_pool_cache();
1819   __ reinit_heapbase();  // restore rheapbase as heapbase.
1820   __ get_dispatch();
1821 
1822   // Entry point for exceptions thrown within interpreter code
1823   Interpreter::_throw_exception_entry = __ pc();
1824   // If we came here via a NullPointerException on the receiver of a
1825   // method, rmethod may be corrupt.
1826   __ get_method(rmethod);
1827   // expression stack is undefined here
1828   // r0: exception
1829   // rbcp: exception bcp
1830   __ verify_oop(r0);
1831   __ mov(c_rarg1, r0);
1832 
1833   // expression stack must be empty before entering the VM in case of
1834   // an exception
1835   __ empty_expression_stack();
1836   // find exception handler address and preserve exception oop
1837   __ call_VM(r3,
1838              CAST_FROM_FN_PTR(address,
1839                           InterpreterRuntime::exception_handler_for_exception),
1840              c_rarg1);
1841 
1842   // Restore machine SP
1843   __ restore_sp_after_call();
1844 
1845   // r0: exception handler entry point
1846   // r3: preserved exception oop
1847   // rbcp: bcp for exception handler
1848   __ push_ptr(r3); // push exception which is now the only value on the stack
1849   __ br(r0); // jump to exception handler (may be _remove_activation_entry!)
1850 
1851   // If the exception is not handled in the current frame the frame is
1852   // removed and the exception is rethrown (i.e. exception
1853   // continuation is _rethrow_exception).
1854   //
1855   // Note: At this point the bci is still the bxi for the instruction
1856   // which caused the exception and the expression stack is
1857   // empty. Thus, for any VM calls at this point, GC will find a legal
1858   // oop map (with empty expression stack).
1859 
1860   //
1861   // JVMTI PopFrame support
1862   //
1863 
1864   Interpreter::_remove_activation_preserving_args_entry = __ pc();
1865   __ empty_expression_stack();
1866   __ restore_bcp(); // We could have returned from deoptimizing this frame, so restore rbcp.
1867   // Set the popframe_processing bit in pending_popframe_condition
1868   // indicating that we are currently handling popframe, so that
1869   // call_VMs that may happen later do not trigger new popframe
1870   // handling cycles.
1871   __ ldrw(r3, Address(rthread, JavaThread::popframe_condition_offset()));
1872   __ orr(r3, r3, JavaThread::popframe_processing_bit);
1873   __ strw(r3, Address(rthread, JavaThread::popframe_condition_offset()));
1874 
1875   {
1876     // Check to see whether we are returning to a deoptimized frame.
1877     // (The PopFrame call ensures that the caller of the popped frame is
1878     // either interpreted or compiled and deoptimizes it if compiled.)
1879     // In this case, we can't call dispatch_next() after the frame is
1880     // popped, but instead must save the incoming arguments and restore
1881     // them after deoptimization has occurred.
1882     //
1883     // Note that we don't compare the return PC against the
1884     // deoptimization blob's unpack entry because of the presence of
1885     // adapter frames in C2.
1886     Label caller_not_deoptimized;
1887     __ ldr(c_rarg1, Address(rfp, frame::return_addr_offset * wordSize));
1888     // This is a return address, so requires authenticating for PAC.
1889     __ authenticate_return_address(c_rarg1);
1890     __ super_call_VM_leaf(CAST_FROM_FN_PTR(address,
1891                                InterpreterRuntime::interpreter_contains), c_rarg1);
1892     __ cbnz(r0, caller_not_deoptimized);
1893 
1894     // Compute size of arguments for saving when returning to
1895     // deoptimized caller
1896     __ get_method(r0);
1897     __ ldr(r0, Address(r0, Method::const_offset()));
1898     __ load_unsigned_short(r0, Address(r0, in_bytes(ConstMethod::
1899                                                     size_of_parameters_offset())));
1900     __ lsl(r0, r0, Interpreter::logStackElementSize);
1901     __ restore_locals(); // XXX do we need this?
1902     __ sub(rlocals, rlocals, r0);
1903     __ add(rlocals, rlocals, wordSize);
1904     // Save these arguments
1905     __ super_call_VM_leaf(CAST_FROM_FN_PTR(address,
1906                                            Deoptimization::
1907                                            popframe_preserve_args),
1908                           rthread, r0, rlocals);
1909 
1910     __ remove_activation(vtos,
1911                          /* throw_monitor_exception */ false,
1912                          /* install_monitor_exception */ false,
1913                          /* notify_jvmdi */ false);
1914 
1915     // Inform deoptimization that it is responsible for restoring
1916     // these arguments
1917     __ mov(rscratch1, JavaThread::popframe_force_deopt_reexecution_bit);
1918     __ strw(rscratch1, Address(rthread, JavaThread::popframe_condition_offset()));
1919 
1920     // Continue in deoptimization handler
1921     __ ret(lr);
1922 
1923     __ bind(caller_not_deoptimized);
1924   }
1925 
1926   __ remove_activation(vtos,
1927                        /* throw_monitor_exception */ false,
1928                        /* install_monitor_exception */ false,
1929                        /* notify_jvmdi */ false);
1930 
1931   // Restore the last_sp and null it out
1932   __ ldr(rscratch1, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));
1933   __ lea(esp, Address(rfp, rscratch1, Address::lsl(Interpreter::logStackElementSize)));
1934   __ str(zr, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));
1935 
1936   __ restore_bcp();
1937   __ restore_locals();
1938   __ restore_constant_pool_cache();
1939   __ get_method(rmethod);
1940   __ get_dispatch();
1941 
1942   // The method data pointer was incremented already during
1943   // call profiling. We have to restore the mdp for the current bcp.
1944   if (ProfileInterpreter) {
1945     __ set_method_data_pointer_for_bcp();
1946   }
1947 
1948   // Clear the popframe condition flag
1949   __ strw(zr, Address(rthread, JavaThread::popframe_condition_offset()));
1950   assert(JavaThread::popframe_inactive == 0, "fix popframe_inactive");
1951 
1952 #if INCLUDE_JVMTI
1953   {
1954     Label L_done;
1955 
1956     __ ldrb(rscratch1, Address(rbcp, 0));
1957     __ cmpw(rscratch1, Bytecodes::_invokestatic);
1958     __ br(Assembler::NE, L_done);
1959 
1960     // The member name argument must be restored if _invokestatic is re-executed after a PopFrame call.
1961     // Detect such a case in the InterpreterRuntime function and return the member name argument, or null.
1962 
1963     __ ldr(c_rarg0, Address(rlocals, 0));
1964     __ call_VM(r0, CAST_FROM_FN_PTR(address, InterpreterRuntime::member_name_arg_or_null), c_rarg0, rmethod, rbcp);
1965 
1966     __ cbz(r0, L_done);
1967 
1968     __ str(r0, Address(esp, 0));
1969     __ bind(L_done);
1970   }
1971 #endif // INCLUDE_JVMTI
1972 
1973   // Restore machine SP
1974   __ restore_sp_after_call();
1975 
1976   __ dispatch_next(vtos);
1977   // end of PopFrame support
1978 
1979   Interpreter::_remove_activation_entry = __ pc();
1980 
1981   // preserve exception over this code sequence
1982   __ pop_ptr(r0);
1983   __ str(r0, Address(rthread, JavaThread::vm_result_oop_offset()));
1984   // remove the activation (without doing throws on illegalMonitorExceptions)
1985   __ remove_activation(vtos, false, true, false);
1986   // restore exception
1987   __ get_vm_result_oop(r0, rthread);
1988 
1989   // In between activations - previous activation type unknown yet
1990   // compute continuation point - the continuation point expects the
1991   // following registers set up:
1992   //
1993   // r0: exception
1994   // lr: return address/pc that threw exception
1995   // esp: expression stack of caller
1996   // rfp: fp of caller
1997   __ stp(r0, lr, Address(__ pre(sp, -2 * wordSize)));  // save exception & return address
1998   __ super_call_VM_leaf(CAST_FROM_FN_PTR(address,
1999                           SharedRuntime::exception_handler_for_return_address),
2000                         rthread, lr);
2001   __ mov(r1, r0);                               // save exception handler
2002   __ ldp(r0, lr, Address(__ post(sp, 2 * wordSize)));  // restore exception & return address
2003   // We might be returning to a deopt handler that expects r3 to
2004   // contain the exception pc
2005   __ mov(r3, lr);
2006   // Note that an "issuing PC" is actually the next PC after the call
2007   __ br(r1);                                    // jump to exception
2008                                                 // handler of caller
2009 }
2010 
2011 
2012 //
2013 // JVMTI ForceEarlyReturn support
2014 //
2015 address TemplateInterpreterGenerator::generate_earlyret_entry_for(TosState state) {
2016   address entry = __ pc();
2017 
2018   __ restore_bcp();
2019   __ restore_locals();
2020   __ empty_expression_stack();
2021   __ load_earlyret_value(state);
2022 
2023   __ ldr(rscratch1, Address(rthread, JavaThread::jvmti_thread_state_offset()));
2024   Address cond_addr(rscratch1, JvmtiThreadState::earlyret_state_offset());
2025 
2026   // Clear the earlyret state
2027   assert(JvmtiThreadState::earlyret_inactive == 0, "should be");
2028   __ str(zr, cond_addr);
2029 
2030   __ remove_activation(state,
2031                        false, /* throw_monitor_exception */
2032                        false, /* install_monitor_exception */
2033                        true); /* notify_jvmdi */
2034   __ ret(lr);
2035 
2036   return entry;
2037 } // end of ForceEarlyReturn support
2038 
2039 
2040 
2041 //-----------------------------------------------------------------------------
2042 // Helper for vtos entry point generation
2043 
2044 void TemplateInterpreterGenerator::set_vtos_entry_points(Template* t,
2045                                                          address& bep,
2046                                                          address& cep,
2047                                                          address& sep,
2048                                                          address& aep,
2049                                                          address& iep,
2050                                                          address& lep,
2051                                                          address& fep,
2052                                                          address& dep,
2053                                                          address& vep) {
2054   assert(t->is_valid() && t->tos_in() == vtos, "illegal template");
2055   Label L;
2056   aep = __ pc();     // atos entry point
2057       __ push_ptr();
2058       __ b(L);
2059   fep = __ pc();     // ftos entry point
2060       __ push_f();
2061       __ b(L);
2062   dep = __ pc();     // dtos entry point
2063       __ push_d();
2064       __ b(L);
2065   lep = __ pc();     // ltos entry point
2066       __ push_l();
2067       __ b(L);
2068   bep = cep = sep = iep = __ pc();     // [bcsi]tos entry point
2069       __ push_i();
2070   vep = __ pc();     // vtos entry point
2071   __ bind(L);
2072   generate_and_dispatch(t);
2073 }
2074 
2075 //-----------------------------------------------------------------------------
2076 
2077 // Non-product code
2078 #ifndef PRODUCT
2079 address TemplateInterpreterGenerator::generate_trace_code(TosState state) {
2080   address entry = __ pc();
2081 
2082   __ protect_return_address();
2083   __ push(lr);
2084   __ push(state);
2085   __ push(RegSet::range(r0, r15), sp);
2086   __ mov(c_rarg2, r0);  // Pass itos
2087   __ call_VM(noreg,
2088              CAST_FROM_FN_PTR(address, InterpreterRuntime::trace_bytecode),
2089              c_rarg1, c_rarg2, c_rarg3);
2090   __ pop(RegSet::range(r0, r15), sp);
2091   __ pop(state);
2092   __ pop(lr);
2093   __ authenticate_return_address();
2094   __ ret(lr);                                   // return from result handler
2095 
2096   return entry;
2097 }
2098 
2099 void TemplateInterpreterGenerator::count_bytecode() {
2100   __ mov(r10, (address) &BytecodeCounter::_counter_value);
2101   __ atomic_add(noreg, 1, r10);
2102 }
2103 
2104 void TemplateInterpreterGenerator::histogram_bytecode(Template* t) {
2105   __ mov(r10, (address) &BytecodeHistogram::_counters[t->bytecode()]);
2106   __ atomic_addw(noreg, 1, r10);
2107 }
2108 
2109 void TemplateInterpreterGenerator::histogram_bytecode_pair(Template* t) {
2110   // Calculate new index for counter:
2111   //   _index = (_index >> log2_number_of_codes) |
2112   //            (bytecode << log2_number_of_codes);
2113   Register index_addr = rscratch1;
2114   Register index = rscratch2;
2115   __ mov(index_addr, (address) &BytecodePairHistogram::_index);
2116   __ ldrw(index, index_addr);
2117   __ mov(r10,
2118          ((int)t->bytecode()) << BytecodePairHistogram::log2_number_of_codes);
2119   __ orrw(index, r10, index, Assembler::LSR,
2120           BytecodePairHistogram::log2_number_of_codes);
2121   __ strw(index, index_addr);
2122 
2123   // Bump bucket contents:
2124   //   _counters[_index] ++;
2125   Register counter_addr = rscratch1;
2126   __ mov(r10, (address) &BytecodePairHistogram::_counters);
2127   __ lea(counter_addr, Address(r10, index, Address::lsl(LogBytesPerInt)));
2128   __ atomic_addw(noreg, 1, counter_addr);
2129 }
2130 
2131 void TemplateInterpreterGenerator::trace_bytecode(Template* t) {
2132   // Call a little run-time stub to avoid blow-up for each bytecode.
2133   // The run-time runtime saves the right registers, depending on
2134   // the tosca in-state for the given template.
2135 
2136   assert(Interpreter::trace_code(t->tos_in()) != nullptr,
2137          "entry must have been generated");
2138   __ bl(RuntimeAddress(Interpreter::trace_code(t->tos_in())));
2139   __ reinit_heapbase();
2140 }
2141 
2142 
2143 void TemplateInterpreterGenerator::stop_interpreter_at() {
2144   Label L;
2145   __ push(rscratch1);
2146   __ mov(rscratch1, (address) &BytecodeCounter::_counter_value);
2147   __ ldr(rscratch1, Address(rscratch1));
2148   __ mov(rscratch2, StopInterpreterAt);
2149   __ cmp(rscratch1, rscratch2);
2150   __ br(Assembler::NE, L);
2151   __ brk(0);
2152   __ bind(L);
2153   __ pop(rscratch1);
2154 }
2155 
2156 #endif // !PRODUCT