1 /*
   2  * Copyright (c) 1999, 2023, Oracle and/or its affiliates. All rights reserved.
   3  * Copyright (c) 2014, 2021, 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 "precompiled.hpp"
  27 #include "asm/assembler.hpp"
  28 #include "c1/c1_CodeStubs.hpp"
  29 #include "c1/c1_Defs.hpp"
  30 #include "c1/c1_MacroAssembler.hpp"
  31 #include "c1/c1_Runtime1.hpp"
  32 #include "compiler/disassembler.hpp"
  33 #include "compiler/oopMap.hpp"
  34 #include "gc/shared/cardTable.hpp"
  35 #include "gc/shared/cardTableBarrierSet.hpp"
  36 #include "gc/shared/collectedHeap.hpp"
  37 #include "gc/shared/tlab_globals.hpp"
  38 #include "interpreter/interpreter.hpp"
  39 #include "memory/universe.hpp"
  40 #include "nativeInst_aarch64.hpp"
  41 #include "oops/compiledICHolder.hpp"
  42 #include "oops/oop.inline.hpp"
  43 #include "prims/jvmtiExport.hpp"
  44 #include "register_aarch64.hpp"
  45 #include "runtime/sharedRuntime.hpp"
  46 #include "runtime/signature.hpp"
  47 #include "runtime/stubRoutines.hpp"
  48 #include "runtime/vframe.hpp"
  49 #include "runtime/vframeArray.hpp"
  50 #include "utilities/powerOfTwo.hpp"
  51 #include "vmreg_aarch64.inline.hpp"
  52 
  53 
  54 // Implementation of StubAssembler
  55 
  56 int StubAssembler::call_RT(Register oop_result1, Register metadata_result, address entry, int args_size) {
  57   // setup registers
  58   assert(!(oop_result1->is_valid() || metadata_result->is_valid()) || oop_result1 != metadata_result, "registers must be different");
  59   assert(oop_result1 != rthread && metadata_result != rthread, "registers must be different");
  60   assert(args_size >= 0, "illegal args_size");
  61   bool align_stack = false;
  62 
  63   mov(c_rarg0, rthread);
  64   set_num_rt_args(0); // Nothing on stack
  65 
  66   Label retaddr;
  67   set_last_Java_frame(sp, rfp, retaddr, rscratch1);
  68 
  69   // do the call
  70   lea(rscratch1, RuntimeAddress(entry));
  71   blr(rscratch1);
  72   bind(retaddr);
  73   int call_offset = offset();
  74   // verify callee-saved register
  75 #ifdef ASSERT
  76   push(r0, sp);
  77   { Label L;
  78     get_thread(r0);
  79     cmp(rthread, r0);
  80     br(Assembler::EQ, L);
  81     stop("StubAssembler::call_RT: rthread not callee saved?");
  82     bind(L);
  83   }
  84   pop(r0, sp);
  85 #endif
  86   reset_last_Java_frame(true);
  87 
  88   // check for pending exceptions
  89   { Label L;
  90     // check for pending exceptions (java_thread is set upon return)
  91     ldr(rscratch1, Address(rthread, in_bytes(Thread::pending_exception_offset())));
  92     cbz(rscratch1, L);
  93     // exception pending => remove activation and forward to exception handler
  94     // make sure that the vm_results are cleared
  95     if (oop_result1->is_valid()) {
  96       str(zr, Address(rthread, JavaThread::vm_result_offset()));
  97     }
  98     if (metadata_result->is_valid()) {
  99       str(zr, Address(rthread, JavaThread::vm_result_2_offset()));
 100     }
 101     if (frame_size() == no_frame_size) {
 102       leave();
 103       far_jump(RuntimeAddress(StubRoutines::forward_exception_entry()));
 104     } else if (_stub_id == Runtime1::forward_exception_id) {
 105       should_not_reach_here();
 106     } else {
 107       far_jump(RuntimeAddress(Runtime1::entry_for(Runtime1::forward_exception_id)));
 108     }
 109     bind(L);
 110   }
 111   // get oop results if there are any and reset the values in the thread
 112   if (oop_result1->is_valid()) {
 113     get_vm_result(oop_result1, rthread);
 114   }
 115   if (metadata_result->is_valid()) {
 116     get_vm_result_2(metadata_result, rthread);
 117   }
 118   return call_offset;
 119 }
 120 
 121 
 122 int StubAssembler::call_RT(Register oop_result1, Register metadata_result, address entry, Register arg1) {
 123   mov(c_rarg1, arg1);
 124   return call_RT(oop_result1, metadata_result, entry, 1);
 125 }
 126 
 127 
 128 int StubAssembler::call_RT(Register oop_result1, Register metadata_result, address entry, Register arg1, Register arg2) {
 129   if (c_rarg1 == arg2) {
 130     if (c_rarg2 == arg1) {
 131       mov(rscratch1, arg1);
 132       mov(arg1, arg2);
 133       mov(arg2, rscratch1);
 134     } else {
 135       mov(c_rarg2, arg2);
 136       mov(c_rarg1, arg1);
 137     }
 138   } else {
 139     mov(c_rarg1, arg1);
 140     mov(c_rarg2, arg2);
 141   }
 142   return call_RT(oop_result1, metadata_result, entry, 2);
 143 }
 144 
 145 
 146 int StubAssembler::call_RT(Register oop_result1, Register metadata_result, address entry, Register arg1, Register arg2, Register arg3) {
 147   // if there is any conflict use the stack
 148   if (arg1 == c_rarg2 || arg1 == c_rarg3 ||
 149       arg2 == c_rarg1 || arg2 == c_rarg3 ||
 150       arg3 == c_rarg1 || arg3 == c_rarg2) {
 151     stp(arg3, arg2, Address(pre(sp, -2 * wordSize)));
 152     stp(arg1, zr, Address(pre(sp, -2 * wordSize)));
 153     ldp(c_rarg1, zr, Address(post(sp, 2 * wordSize)));
 154     ldp(c_rarg3, c_rarg2, Address(post(sp, 2 * wordSize)));
 155   } else {
 156     mov(c_rarg1, arg1);
 157     mov(c_rarg2, arg2);
 158     mov(c_rarg3, arg3);
 159   }
 160   return call_RT(oop_result1, metadata_result, entry, 3);
 161 }
 162 
 163 enum return_state_t {
 164   does_not_return, requires_return
 165 };
 166 
 167 
 168 // Implementation of StubFrame
 169 
 170 class StubFrame: public StackObj {
 171  private:
 172   StubAssembler* _sasm;
 173   bool _return_state;
 174 
 175  public:
 176   StubFrame(StubAssembler* sasm, const char* name, bool must_gc_arguments, return_state_t return_state=requires_return);
 177   void load_argument(int offset_in_words, Register reg);
 178 
 179   ~StubFrame();
 180 };;
 181 
 182 void StubAssembler::prologue(const char* name, bool must_gc_arguments) {
 183   set_info(name, must_gc_arguments);
 184   enter();
 185 }
 186 
 187 void StubAssembler::epilogue() {
 188   leave();
 189   ret(lr);
 190 }
 191 
 192 #define __ _sasm->
 193 
 194 StubFrame::StubFrame(StubAssembler* sasm, const char* name, bool must_gc_arguments, return_state_t return_state) {
 195   _sasm = sasm;
 196   _return_state = return_state;
 197   __ prologue(name, must_gc_arguments);
 198 }
 199 
 200 // load parameters that were stored with LIR_Assembler::store_parameter
 201 // Note: offsets for store_parameter and load_argument must match
 202 void StubFrame::load_argument(int offset_in_words, Register reg) {
 203   __ load_parameter(offset_in_words, reg);
 204 }
 205 
 206 StubFrame::~StubFrame() {
 207   if (_return_state == requires_return) {
 208     __ epilogue();
 209   } else {
 210     __ should_not_reach_here();
 211   }
 212 }
 213 
 214 #undef __
 215 
 216 
 217 // Implementation of Runtime1
 218 
 219 #define __ sasm->
 220 
 221 const int float_regs_as_doubles_size_in_slots = pd_nof_fpu_regs_frame_map * 2;
 222 
 223 // Stack layout for saving/restoring  all the registers needed during a runtime
 224 // call (this includes deoptimization)
 225 // Note: note that users of this frame may well have arguments to some runtime
 226 // while these values are on the stack. These positions neglect those arguments
 227 // but the code in save_live_registers will take the argument count into
 228 // account.
 229 //
 230 
 231 enum reg_save_layout {
 232   reg_save_frame_size = 32 /* float */ + 32 /* integer */
 233 };
 234 
 235 // Save off registers which might be killed by calls into the runtime.
 236 // Tries to smart of about FP registers.  In particular we separate
 237 // saving and describing the FPU registers for deoptimization since we
 238 // have to save the FPU registers twice if we describe them.  The
 239 // deopt blob is the only thing which needs to describe FPU registers.
 240 // In all other cases it should be sufficient to simply save their
 241 // current value.
 242 
 243 static int cpu_reg_save_offsets[FrameMap::nof_cpu_regs];
 244 static int fpu_reg_save_offsets[FrameMap::nof_fpu_regs];
 245 static int reg_save_size_in_words;
 246 static int frame_size_in_bytes = -1;
 247 
 248 static OopMap* generate_oop_map(StubAssembler* sasm, bool save_fpu_registers) {
 249   int frame_size_in_bytes = reg_save_frame_size * BytesPerWord;
 250   sasm->set_frame_size(frame_size_in_bytes / BytesPerWord);
 251   int frame_size_in_slots = frame_size_in_bytes / sizeof(jint);
 252   OopMap* oop_map = new OopMap(frame_size_in_slots, 0);
 253 
 254   for (int i = 0; i < FrameMap::nof_cpu_regs; i++) {
 255     Register r = as_Register(i);
 256     if (i <= 18 && i != rscratch1->encoding() && i != rscratch2->encoding()) {
 257       int sp_offset = cpu_reg_save_offsets[i];
 258       oop_map->set_callee_saved(VMRegImpl::stack2reg(sp_offset),
 259                                 r->as_VMReg());
 260     }
 261   }
 262 
 263   if (save_fpu_registers) {
 264     for (int i = 0; i < FrameMap::nof_fpu_regs; i++) {
 265       FloatRegister r = as_FloatRegister(i);
 266       {
 267         int sp_offset = fpu_reg_save_offsets[i];
 268         oop_map->set_callee_saved(VMRegImpl::stack2reg(sp_offset),
 269                                   r->as_VMReg());
 270       }
 271     }
 272   }
 273   return oop_map;
 274 }
 275 
 276 static OopMap* save_live_registers(StubAssembler* sasm,
 277                                    bool save_fpu_registers = true) {
 278   __ block_comment("save_live_registers");
 279 
 280   __ push(RegSet::range(r0, r29), sp);         // integer registers except lr & sp
 281 
 282   if (save_fpu_registers) {
 283     for (int i = 31; i>= 0; i -= 4) {
 284       __ sub(sp, sp, 4 * wordSize); // no pre-increment for st1. Emulate it without modifying other registers
 285       __ st1(as_FloatRegister(i-3), as_FloatRegister(i-2), as_FloatRegister(i-1),
 286           as_FloatRegister(i), __ T1D, Address(sp));
 287     }
 288   } else {
 289     __ add(sp, sp, -32 * wordSize);
 290   }
 291   return generate_oop_map(sasm, save_fpu_registers);
 292 }
 293 
 294 static void restore_live_registers(StubAssembler* sasm, bool restore_fpu_registers = true) {
 295   if (restore_fpu_registers) {
 296     for (int i = 0; i < 32; i += 4)
 297       __ ld1(as_FloatRegister(i), as_FloatRegister(i+1), as_FloatRegister(i+2),
 298           as_FloatRegister(i+3), __ T1D, Address(__ post(sp, 4 * wordSize)));
 299   } else {
 300     __ add(sp, sp, 32 * wordSize);
 301   }
 302 
 303   __ pop(RegSet::range(r0, r29), sp);
 304 }
 305 
 306 static void restore_live_registers_except_r0(StubAssembler* sasm, bool restore_fpu_registers = true)  {
 307 
 308   if (restore_fpu_registers) {
 309     for (int i = 0; i < 32; i += 4)
 310       __ ld1(as_FloatRegister(i), as_FloatRegister(i+1), as_FloatRegister(i+2),
 311           as_FloatRegister(i+3), __ T1D, Address(__ post(sp, 4 * wordSize)));
 312   } else {
 313     __ add(sp, sp, 32 * wordSize);
 314   }
 315 
 316   __ ldp(zr, r1, Address(__ post(sp, 16)));
 317   __ pop(RegSet::range(r2, r29), sp);
 318 }
 319 
 320 
 321 
 322 void Runtime1::initialize_pd() {
 323   int i;
 324   int sp_offset = 0;
 325 
 326   // all float registers are saved explicitly
 327   assert(FrameMap::nof_fpu_regs == 32, "double registers not handled here");
 328   for (i = 0; i < FrameMap::nof_fpu_regs; i++) {
 329     fpu_reg_save_offsets[i] = sp_offset;
 330     sp_offset += 2;   // SP offsets are in halfwords
 331   }
 332 
 333   for (i = 0; i < FrameMap::nof_cpu_regs; i++) {
 334     Register r = as_Register(i);
 335     cpu_reg_save_offsets[i] = sp_offset;
 336     sp_offset += 2;   // SP offsets are in halfwords
 337   }
 338 }
 339 
 340 
 341 // target: the entry point of the method that creates and posts the exception oop
 342 // has_argument: true if the exception needs arguments (passed in rscratch1 and rscratch2)
 343 
 344 OopMapSet* Runtime1::generate_exception_throw(StubAssembler* sasm, address target, bool has_argument) {
 345   // make a frame and preserve the caller's caller-save registers
 346   OopMap* oop_map = save_live_registers(sasm);
 347   int call_offset;
 348   if (!has_argument) {
 349     call_offset = __ call_RT(noreg, noreg, target);
 350   } else {
 351     __ mov(c_rarg1, rscratch1);
 352     __ mov(c_rarg2, rscratch2);
 353     call_offset = __ call_RT(noreg, noreg, target);
 354   }
 355   OopMapSet* oop_maps = new OopMapSet();
 356   oop_maps->add_gc_map(call_offset, oop_map);
 357   return oop_maps;
 358 }
 359 
 360 
 361 OopMapSet* Runtime1::generate_handle_exception(StubID id, StubAssembler *sasm) {
 362   __ block_comment("generate_handle_exception");
 363 
 364   // incoming parameters
 365   const Register exception_oop = r0;
 366   const Register exception_pc  = r3;
 367   // other registers used in this stub
 368 
 369   // Save registers, if required.
 370   OopMapSet* oop_maps = new OopMapSet();
 371   OopMap* oop_map = nullptr;
 372   switch (id) {
 373   case forward_exception_id:
 374     // We're handling an exception in the context of a compiled frame.
 375     // The registers have been saved in the standard places.  Perform
 376     // an exception lookup in the caller and dispatch to the handler
 377     // if found.  Otherwise unwind and dispatch to the callers
 378     // exception handler.
 379     oop_map = generate_oop_map(sasm, 1 /*thread*/);
 380 
 381     // load and clear pending exception oop into r0
 382     __ ldr(exception_oop, Address(rthread, Thread::pending_exception_offset()));
 383     __ str(zr, Address(rthread, Thread::pending_exception_offset()));
 384 
 385     // load issuing PC (the return address for this stub) into r3
 386     __ ldr(exception_pc, Address(rfp, 1*BytesPerWord));
 387     __ authenticate_return_address(exception_pc, rscratch1);
 388 
 389     // make sure that the vm_results are cleared (may be unnecessary)
 390     __ str(zr, Address(rthread, JavaThread::vm_result_offset()));
 391     __ str(zr, Address(rthread, JavaThread::vm_result_2_offset()));
 392     break;
 393   case handle_exception_nofpu_id:
 394   case handle_exception_id:
 395     // At this point all registers MAY be live.
 396     oop_map = save_live_registers(sasm, id != handle_exception_nofpu_id);
 397     break;
 398   case handle_exception_from_callee_id: {
 399     // At this point all registers except exception oop (r0) and
 400     // exception pc (lr) are dead.
 401     const int frame_size = 2 /*fp, return address*/;
 402     oop_map = new OopMap(frame_size * VMRegImpl::slots_per_word, 0);
 403     sasm->set_frame_size(frame_size);
 404     break;
 405   }
 406   default: ShouldNotReachHere();
 407   }
 408 
 409   // verify that only r0 and r3 are valid at this time
 410   __ invalidate_registers(false, true, true, false, true, true);
 411   // verify that r0 contains a valid exception
 412   __ verify_not_null_oop(exception_oop);
 413 
 414 #ifdef ASSERT
 415   // check that fields in JavaThread for exception oop and issuing pc are
 416   // empty before writing to them
 417   Label oop_empty;
 418   __ ldr(rscratch1, Address(rthread, JavaThread::exception_oop_offset()));
 419   __ cbz(rscratch1, oop_empty);
 420   __ stop("exception oop already set");
 421   __ bind(oop_empty);
 422 
 423   Label pc_empty;
 424   __ ldr(rscratch1, Address(rthread, JavaThread::exception_pc_offset()));
 425   __ cbz(rscratch1, pc_empty);
 426   __ stop("exception pc already set");
 427   __ bind(pc_empty);
 428 #endif
 429 
 430   // save exception oop and issuing pc into JavaThread
 431   // (exception handler will load it from here)
 432   __ str(exception_oop, Address(rthread, JavaThread::exception_oop_offset()));
 433   __ str(exception_pc, Address(rthread, JavaThread::exception_pc_offset()));
 434 
 435   // patch throwing pc into return address (has bci & oop map)
 436   __ protect_return_address(exception_pc, rscratch1);
 437   __ str(exception_pc, Address(rfp, 1*BytesPerWord));
 438 
 439   // compute the exception handler.
 440   // the exception oop and the throwing pc are read from the fields in JavaThread
 441   int call_offset = __ call_RT(noreg, noreg, CAST_FROM_FN_PTR(address, exception_handler_for_pc));
 442   oop_maps->add_gc_map(call_offset, oop_map);
 443 
 444   // r0: handler address
 445   //      will be the deopt blob if nmethod was deoptimized while we looked up
 446   //      handler regardless of whether handler existed in the nmethod.
 447 
 448   // only r0 is valid at this time, all other registers have been destroyed by the runtime call
 449   __ invalidate_registers(false, true, true, true, true, true);
 450 
 451   // patch the return address, this stub will directly return to the exception handler
 452   __ protect_return_address(r0, rscratch1);
 453   __ str(r0, Address(rfp, 1*BytesPerWord));
 454 
 455   switch (id) {
 456   case forward_exception_id:
 457   case handle_exception_nofpu_id:
 458   case handle_exception_id:
 459     // Restore the registers that were saved at the beginning.
 460     restore_live_registers(sasm, id != handle_exception_nofpu_id);
 461     break;
 462   case handle_exception_from_callee_id:
 463     break;
 464   default:  ShouldNotReachHere();
 465   }
 466 
 467   return oop_maps;
 468 }
 469 
 470 
 471 void Runtime1::generate_unwind_exception(StubAssembler *sasm) {
 472   // incoming parameters
 473   const Register exception_oop = r0;
 474   // callee-saved copy of exception_oop during runtime call
 475   const Register exception_oop_callee_saved = r19;
 476   // other registers used in this stub
 477   const Register exception_pc = r3;
 478   const Register handler_addr = r1;
 479 
 480   // verify that only r0, is valid at this time
 481   __ invalidate_registers(false, true, true, true, true, true);
 482 
 483 #ifdef ASSERT
 484   // check that fields in JavaThread for exception oop and issuing pc are empty
 485   Label oop_empty;
 486   __ ldr(rscratch1, Address(rthread, JavaThread::exception_oop_offset()));
 487   __ cbz(rscratch1, oop_empty);
 488   __ stop("exception oop must be empty");
 489   __ bind(oop_empty);
 490 
 491   Label pc_empty;
 492   __ ldr(rscratch1, Address(rthread, JavaThread::exception_pc_offset()));
 493   __ cbz(rscratch1, pc_empty);
 494   __ stop("exception pc must be empty");
 495   __ bind(pc_empty);
 496 #endif
 497 
 498   // Save our return address because
 499   // exception_handler_for_return_address will destroy it.  We also
 500   // save exception_oop
 501   __ mov(r3, lr);
 502   __ protect_return_address();
 503   __ stp(lr, exception_oop, Address(__ pre(sp, -2 * wordSize)));
 504 
 505   // search the exception handler address of the caller (using the return address)
 506   __ call_VM_leaf(CAST_FROM_FN_PTR(address, SharedRuntime::exception_handler_for_return_address), rthread, r3);
 507   // r0: exception handler address of the caller
 508 
 509   // Only R0 is valid at this time; all other registers have been
 510   // destroyed by the call.
 511   __ invalidate_registers(false, true, true, true, false, true);
 512 
 513   // move result of call into correct register
 514   __ mov(handler_addr, r0);
 515 
 516   // get throwing pc (= return address).
 517   // lr has been destroyed by the call
 518   __ ldp(lr, exception_oop, Address(__ post(sp, 2 * wordSize)));
 519   __ authenticate_return_address();
 520   __ mov(r3, lr);
 521 
 522   __ verify_not_null_oop(exception_oop);
 523 
 524   // continue at exception handler (return address removed)
 525   // note: do *not* remove arguments when unwinding the
 526   //       activation since the caller assumes having
 527   //       all arguments on the stack when entering the
 528   //       runtime to determine the exception handler
 529   //       (GC happens at call site with arguments!)
 530   // r0: exception oop
 531   // r3: throwing pc
 532   // r1: exception handler
 533   __ br(handler_addr);
 534 }
 535 
 536 
 537 
 538 OopMapSet* Runtime1::generate_patching(StubAssembler* sasm, address target) {
 539   // use the maximum number of runtime-arguments here because it is difficult to
 540   // distinguish each RT-Call.
 541   // Note: This number affects also the RT-Call in generate_handle_exception because
 542   //       the oop-map is shared for all calls.
 543   DeoptimizationBlob* deopt_blob = SharedRuntime::deopt_blob();
 544   assert(deopt_blob != nullptr, "deoptimization blob must have been created");
 545 
 546   OopMap* oop_map = save_live_registers(sasm);
 547 
 548   __ mov(c_rarg0, rthread);
 549   Label retaddr;
 550   __ set_last_Java_frame(sp, rfp, retaddr, rscratch1);
 551   // do the call
 552   __ lea(rscratch1, RuntimeAddress(target));
 553   __ blr(rscratch1);
 554   __ bind(retaddr);
 555   OopMapSet* oop_maps = new OopMapSet();
 556   oop_maps->add_gc_map(__ offset(), oop_map);
 557   // verify callee-saved register
 558 #ifdef ASSERT
 559   { Label L;
 560     __ get_thread(rscratch1);
 561     __ cmp(rthread, rscratch1);
 562     __ br(Assembler::EQ, L);
 563     __ stop("StubAssembler::call_RT: rthread not callee saved?");
 564     __ bind(L);
 565   }
 566 #endif
 567 
 568   __ reset_last_Java_frame(true);
 569 
 570 #ifdef ASSERT
 571   // check that fields in JavaThread for exception oop and issuing pc are empty
 572   Label oop_empty;
 573   __ ldr(rscratch1, Address(rthread, Thread::pending_exception_offset()));
 574   __ cbz(rscratch1, oop_empty);
 575   __ stop("exception oop must be empty");
 576   __ bind(oop_empty);
 577 
 578   Label pc_empty;
 579   __ ldr(rscratch1, Address(rthread, JavaThread::exception_pc_offset()));
 580   __ cbz(rscratch1, pc_empty);
 581   __ stop("exception pc must be empty");
 582   __ bind(pc_empty);
 583 #endif
 584 
 585   // Runtime will return true if the nmethod has been deoptimized, this is the
 586   // expected scenario and anything else is  an error. Note that we maintain a
 587   // check on the result purely as a defensive measure.
 588   Label no_deopt;
 589   __ cbz(r0, no_deopt);                                // Have we deoptimized?
 590 
 591   // Perform a re-execute. The proper return  address is already on the stack,
 592   // we just need  to restore registers, pop  all of our frame  but the return
 593   // address and jump to the deopt blob.
 594   restore_live_registers(sasm);
 595   __ leave();
 596   __ far_jump(RuntimeAddress(deopt_blob->unpack_with_reexecution()));
 597 
 598   __ bind(no_deopt);
 599   __ stop("deopt not performed");
 600 
 601   return oop_maps;
 602 }
 603 
 604 
 605 OopMapSet* Runtime1::generate_code_for(StubID id, StubAssembler* sasm) {
 606 
 607   const Register exception_oop = r0;
 608   const Register exception_pc  = r3;
 609 
 610   // for better readability
 611   const bool must_gc_arguments = true;
 612   const bool dont_gc_arguments = false;
 613 
 614   // default value; overwritten for some optimized stubs that are called from methods that do not use the fpu
 615   bool save_fpu_registers = true;
 616 
 617   // stub code & info for the different stubs
 618   OopMapSet* oop_maps = nullptr;
 619   OopMap* oop_map = nullptr;
 620   switch (id) {
 621     {
 622     case forward_exception_id:
 623       {
 624         oop_maps = generate_handle_exception(id, sasm);
 625         __ leave();
 626         __ ret(lr);
 627       }
 628       break;
 629 
 630     case throw_div0_exception_id:
 631       { StubFrame f(sasm, "throw_div0_exception", dont_gc_arguments, does_not_return);
 632         oop_maps = generate_exception_throw(sasm, CAST_FROM_FN_PTR(address, throw_div0_exception), false);
 633       }
 634       break;
 635 
 636     case throw_null_pointer_exception_id:
 637       { StubFrame f(sasm, "throw_null_pointer_exception", dont_gc_arguments, does_not_return);
 638         oop_maps = generate_exception_throw(sasm, CAST_FROM_FN_PTR(address, throw_null_pointer_exception), false);
 639       }
 640       break;
 641 
 642     case new_instance_id:
 643     case fast_new_instance_id:
 644     case fast_new_instance_init_check_id:
 645       {
 646         Register klass = r3; // Incoming
 647         Register obj   = r0; // Result
 648 
 649         if (id == new_instance_id) {
 650           __ set_info("new_instance", dont_gc_arguments);
 651         } else if (id == fast_new_instance_id) {
 652           __ set_info("fast new_instance", dont_gc_arguments);
 653         } else {
 654           assert(id == fast_new_instance_init_check_id, "bad StubID");
 655           __ set_info("fast new_instance init check", dont_gc_arguments);
 656         }
 657 
 658         __ enter();
 659         OopMap* map = save_live_registers(sasm);
 660         int call_offset = __ call_RT(obj, noreg, CAST_FROM_FN_PTR(address, new_instance), klass);
 661         oop_maps = new OopMapSet();
 662         oop_maps->add_gc_map(call_offset, map);
 663         restore_live_registers_except_r0(sasm);
 664         __ verify_oop(obj);
 665         __ leave();
 666         __ ret(lr);
 667 
 668         // r0,: new instance
 669       }
 670 
 671       break;
 672 
 673     case counter_overflow_id:
 674       {
 675         Register bci = r0, method = r1;
 676         __ enter();
 677         OopMap* map = save_live_registers(sasm);
 678         // Retrieve bci
 679         __ ldrw(bci, Address(rfp, 2*BytesPerWord));
 680         // And a pointer to the Method*
 681         __ ldr(method, Address(rfp, 3*BytesPerWord));
 682         int call_offset = __ call_RT(noreg, noreg, CAST_FROM_FN_PTR(address, counter_overflow), bci, method);
 683         oop_maps = new OopMapSet();
 684         oop_maps->add_gc_map(call_offset, map);
 685         restore_live_registers(sasm);
 686         __ leave();
 687         __ ret(lr);
 688       }
 689       break;
 690 
 691     case new_type_array_id:
 692     case new_object_array_id:
 693       {
 694         Register length   = r19; // Incoming
 695         Register klass    = r3; // Incoming
 696         Register obj      = r0; // Result
 697 
 698         if (id == new_type_array_id) {
 699           __ set_info("new_type_array", dont_gc_arguments);
 700         } else {
 701           __ set_info("new_object_array", dont_gc_arguments);
 702         }
 703 
 704 #ifdef ASSERT
 705         // assert object type is really an array of the proper kind
 706         {
 707           Label ok;
 708           Register t0 = obj;
 709           __ ldrw(t0, Address(klass, Klass::layout_helper_offset()));
 710           __ asrw(t0, t0, Klass::_lh_array_tag_shift);
 711           int tag = ((id == new_type_array_id)
 712                      ? Klass::_lh_array_tag_type_value
 713                      : Klass::_lh_array_tag_obj_value);
 714           __ mov(rscratch1, tag);
 715           __ cmpw(t0, rscratch1);
 716           __ br(Assembler::EQ, ok);
 717           __ stop("assert(is an array klass)");
 718           __ should_not_reach_here();
 719           __ bind(ok);
 720         }
 721 #endif // ASSERT
 722 
 723         __ enter();
 724         OopMap* map = save_live_registers(sasm);
 725         int call_offset;
 726         if (id == new_type_array_id) {
 727           call_offset = __ call_RT(obj, noreg, CAST_FROM_FN_PTR(address, new_type_array), klass, length);
 728         } else {
 729           call_offset = __ call_RT(obj, noreg, CAST_FROM_FN_PTR(address, new_object_array), klass, length);
 730         }
 731 
 732         oop_maps = new OopMapSet();
 733         oop_maps->add_gc_map(call_offset, map);
 734         restore_live_registers_except_r0(sasm);
 735 
 736         __ verify_oop(obj);
 737         __ leave();
 738         __ ret(lr);
 739 
 740         // r0: new array
 741       }
 742       break;
 743 
 744     case new_multi_array_id:
 745       { StubFrame f(sasm, "new_multi_array", dont_gc_arguments);
 746         // r0,: klass
 747         // r19,: rank
 748         // r2: address of 1st dimension
 749         OopMap* map = save_live_registers(sasm);
 750         __ mov(c_rarg1, r0);
 751         __ mov(c_rarg3, r2);
 752         __ mov(c_rarg2, r19);
 753         int call_offset = __ call_RT(r0, noreg, CAST_FROM_FN_PTR(address, new_multi_array), r1, r2, r3);
 754 
 755         oop_maps = new OopMapSet();
 756         oop_maps->add_gc_map(call_offset, map);
 757         restore_live_registers_except_r0(sasm);
 758 
 759         // r0,: new multi array
 760         __ verify_oop(r0);
 761       }
 762       break;
 763 
 764     case register_finalizer_id:
 765       {
 766         __ set_info("register_finalizer", dont_gc_arguments);
 767 
 768         // This is called via call_runtime so the arguments
 769         // will be place in C abi locations
 770 
 771         __ verify_oop(c_rarg0);
 772 
 773         // load the klass and check the has finalizer flag
 774         Label register_finalizer;
 775         Register t = r5;
 776         __ load_klass(t, r0);
 777         __ ldrw(t, Address(t, Klass::access_flags_offset()));
 778         __ tbnz(t, exact_log2(JVM_ACC_HAS_FINALIZER), register_finalizer);
 779         __ ret(lr);
 780 
 781         __ bind(register_finalizer);
 782         __ enter();
 783         OopMap* oop_map = save_live_registers(sasm);
 784         int call_offset = __ call_RT(noreg, noreg, CAST_FROM_FN_PTR(address, SharedRuntime::register_finalizer), r0);
 785         oop_maps = new OopMapSet();
 786         oop_maps->add_gc_map(call_offset, oop_map);
 787 
 788         // Now restore all the live registers
 789         restore_live_registers(sasm);
 790 
 791         __ leave();
 792         __ ret(lr);
 793       }
 794       break;
 795 
 796     case throw_class_cast_exception_id:
 797       { StubFrame f(sasm, "throw_class_cast_exception", dont_gc_arguments, does_not_return);
 798         oop_maps = generate_exception_throw(sasm, CAST_FROM_FN_PTR(address, throw_class_cast_exception), true);
 799       }
 800       break;
 801 
 802     case throw_incompatible_class_change_error_id:
 803       { StubFrame f(sasm, "throw_incompatible_class_cast_exception", dont_gc_arguments, does_not_return);
 804         oop_maps = generate_exception_throw(sasm, CAST_FROM_FN_PTR(address, throw_incompatible_class_change_error), false);
 805       }
 806       break;
 807 
 808     case slow_subtype_check_id:
 809       {
 810         // Typical calling sequence:
 811         // __ push(klass_RInfo);  // object klass or other subclass
 812         // __ push(sup_k_RInfo);  // array element klass or other superclass
 813         // __ bl(slow_subtype_check);
 814         // Note that the subclass is pushed first, and is therefore deepest.
 815         enum layout {
 816           r0_off, r0_off_hi,
 817           r2_off, r2_off_hi,
 818           r4_off, r4_off_hi,
 819           r5_off, r5_off_hi,
 820           sup_k_off, sup_k_off_hi,
 821           klass_off, klass_off_hi,
 822           framesize,
 823           result_off = sup_k_off
 824         };
 825 
 826         __ set_info("slow_subtype_check", dont_gc_arguments);
 827         __ push(RegSet::of(r0, r2, r4, r5), sp);
 828 
 829         // This is called by pushing args and not with C abi
 830         // __ ldr(r4, Address(sp, (klass_off) * VMRegImpl::stack_slot_size)); // subclass
 831         // __ ldr(r0, Address(sp, (sup_k_off) * VMRegImpl::stack_slot_size)); // superclass
 832 
 833         __ ldp(r4, r0, Address(sp, (sup_k_off) * VMRegImpl::stack_slot_size));
 834 
 835         Label miss;
 836         __ check_klass_subtype_slow_path(r4, r0, r2, r5, nullptr, &miss);
 837 
 838         // fallthrough on success:
 839         __ mov(rscratch1, 1);
 840         __ str(rscratch1, Address(sp, (result_off) * VMRegImpl::stack_slot_size)); // result
 841         __ pop(RegSet::of(r0, r2, r4, r5), sp);
 842         __ ret(lr);
 843 
 844         __ bind(miss);
 845         __ str(zr, Address(sp, (result_off) * VMRegImpl::stack_slot_size)); // result
 846         __ pop(RegSet::of(r0, r2, r4, r5), sp);
 847         __ ret(lr);
 848       }
 849       break;
 850 
 851     case monitorenter_nofpu_id:
 852       save_fpu_registers = false;
 853       // fall through
 854     case monitorenter_id:
 855       {
 856         StubFrame f(sasm, "monitorenter", dont_gc_arguments);
 857         OopMap* map = save_live_registers(sasm, save_fpu_registers);
 858 
 859         // Called with store_parameter and not C abi
 860 
 861         f.load_argument(1, r0); // r0,: object
 862         f.load_argument(0, r1); // r1,: lock address
 863 
 864         int call_offset = __ call_RT(noreg, noreg, CAST_FROM_FN_PTR(address, monitorenter), r0, r1);
 865 
 866         oop_maps = new OopMapSet();
 867         oop_maps->add_gc_map(call_offset, map);
 868         restore_live_registers(sasm, save_fpu_registers);
 869       }
 870       break;
 871 
 872     case monitorexit_nofpu_id:
 873       save_fpu_registers = false;
 874       // fall through
 875     case monitorexit_id:
 876       {
 877         StubFrame f(sasm, "monitorexit", dont_gc_arguments);
 878         OopMap* map = save_live_registers(sasm, save_fpu_registers);
 879 
 880         // Called with store_parameter and not C abi
 881 
 882         f.load_argument(0, r0); // r0,: lock address
 883 
 884         // note: really a leaf routine but must setup last java sp
 885         //       => use call_RT for now (speed can be improved by
 886         //       doing last java sp setup manually)
 887         int call_offset = __ call_RT(noreg, noreg, CAST_FROM_FN_PTR(address, monitorexit), r0);
 888 
 889         oop_maps = new OopMapSet();
 890         oop_maps->add_gc_map(call_offset, map);
 891         restore_live_registers(sasm, save_fpu_registers);
 892       }
 893       break;
 894 
 895     case deoptimize_id:
 896       {
 897         StubFrame f(sasm, "deoptimize", dont_gc_arguments, does_not_return);
 898         OopMap* oop_map = save_live_registers(sasm);
 899         f.load_argument(0, c_rarg1);
 900         int call_offset = __ call_RT(noreg, noreg, CAST_FROM_FN_PTR(address, deoptimize), c_rarg1);
 901 
 902         oop_maps = new OopMapSet();
 903         oop_maps->add_gc_map(call_offset, oop_map);
 904         restore_live_registers(sasm);
 905         DeoptimizationBlob* deopt_blob = SharedRuntime::deopt_blob();
 906         assert(deopt_blob != nullptr, "deoptimization blob must have been created");
 907         __ leave();
 908         __ far_jump(RuntimeAddress(deopt_blob->unpack_with_reexecution()));
 909       }
 910       break;
 911 
 912     case throw_range_check_failed_id:
 913       { StubFrame f(sasm, "range_check_failed", dont_gc_arguments, does_not_return);
 914         oop_maps = generate_exception_throw(sasm, CAST_FROM_FN_PTR(address, throw_range_check_exception), true);
 915       }
 916       break;
 917 
 918     case unwind_exception_id:
 919       { __ set_info("unwind_exception", dont_gc_arguments);
 920         // note: no stubframe since we are about to leave the current
 921         //       activation and we are calling a leaf VM function only.
 922         generate_unwind_exception(sasm);
 923       }
 924       break;
 925 
 926     case access_field_patching_id:
 927       { StubFrame f(sasm, "access_field_patching", dont_gc_arguments, does_not_return);
 928         // we should set up register map
 929         oop_maps = generate_patching(sasm, CAST_FROM_FN_PTR(address, access_field_patching));
 930       }
 931       break;
 932 
 933     case load_klass_patching_id:
 934       { StubFrame f(sasm, "load_klass_patching", dont_gc_arguments, does_not_return);
 935         // we should set up register map
 936         oop_maps = generate_patching(sasm, CAST_FROM_FN_PTR(address, move_klass_patching));
 937       }
 938       break;
 939 
 940     case load_mirror_patching_id:
 941       { StubFrame f(sasm, "load_mirror_patching", dont_gc_arguments, does_not_return);
 942         // we should set up register map
 943         oop_maps = generate_patching(sasm, CAST_FROM_FN_PTR(address, move_mirror_patching));
 944       }
 945       break;
 946 
 947     case load_appendix_patching_id:
 948       { StubFrame f(sasm, "load_appendix_patching", dont_gc_arguments, does_not_return);
 949         // we should set up register map
 950         oop_maps = generate_patching(sasm, CAST_FROM_FN_PTR(address, move_appendix_patching));
 951       }
 952       break;
 953 
 954     case handle_exception_nofpu_id:
 955     case handle_exception_id:
 956       { StubFrame f(sasm, "handle_exception", dont_gc_arguments);
 957         oop_maps = generate_handle_exception(id, sasm);
 958       }
 959       break;
 960 
 961     case handle_exception_from_callee_id:
 962       { StubFrame f(sasm, "handle_exception_from_callee", dont_gc_arguments);
 963         oop_maps = generate_handle_exception(id, sasm);
 964       }
 965       break;
 966 
 967     case throw_index_exception_id:
 968       { StubFrame f(sasm, "index_range_check_failed", dont_gc_arguments, does_not_return);
 969         oop_maps = generate_exception_throw(sasm, CAST_FROM_FN_PTR(address, throw_index_exception), true);
 970       }
 971       break;
 972 
 973     case throw_array_store_exception_id:
 974       { StubFrame f(sasm, "throw_array_store_exception", dont_gc_arguments, does_not_return);
 975         // tos + 0: link
 976         //     + 1: return address
 977         oop_maps = generate_exception_throw(sasm, CAST_FROM_FN_PTR(address, throw_array_store_exception), true);
 978       }
 979       break;
 980 
 981     case predicate_failed_trap_id:
 982       {
 983         StubFrame f(sasm, "predicate_failed_trap", dont_gc_arguments, does_not_return);
 984 
 985         OopMap* map = save_live_registers(sasm);
 986 
 987         int call_offset = __ call_RT(noreg, noreg, CAST_FROM_FN_PTR(address, predicate_failed_trap));
 988         oop_maps = new OopMapSet();
 989         oop_maps->add_gc_map(call_offset, map);
 990         restore_live_registers(sasm);
 991         __ leave();
 992         DeoptimizationBlob* deopt_blob = SharedRuntime::deopt_blob();
 993         assert(deopt_blob != nullptr, "deoptimization blob must have been created");
 994 
 995         __ far_jump(RuntimeAddress(deopt_blob->unpack_with_reexecution()));
 996       }
 997       break;
 998 
 999     case dtrace_object_alloc_id:
1000       { // c_rarg0: object
1001         StubFrame f(sasm, "dtrace_object_alloc", dont_gc_arguments);
1002         save_live_registers(sasm);
1003 
1004         __ call_VM_leaf(CAST_FROM_FN_PTR(address, static_cast<int (*)(oopDesc*)>(SharedRuntime::dtrace_object_alloc)), c_rarg0);
1005 
1006         restore_live_registers(sasm);
1007       }
1008       break;
1009 
1010     default:
1011       { StubFrame f(sasm, "unimplemented entry", dont_gc_arguments, does_not_return);
1012         __ mov(r0, (int)id);
1013         __ call_RT(noreg, noreg, CAST_FROM_FN_PTR(address, unimplemented_entry), r0);
1014       }
1015       break;
1016     }
1017   }
1018   return oop_maps;
1019 }
1020 
1021 #undef __
1022 
1023 const char *Runtime1::pd_name_for_address(address entry) { Unimplemented(); return 0; }