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