1 /*
2 * Copyright (c) 1999, 2021, Oracle and/or its affiliates. All rights reserved.
3 * Copyright (c) 2012, 2021 SAP SE. 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/macroAssembler.inline.hpp"
28 #include "c1/c1_CodeStubs.hpp"
29 #include "c1/c1_FrameMap.hpp"
30 #include "c1/c1_LIRAssembler.hpp"
31 #include "c1/c1_MacroAssembler.hpp"
32 #include "c1/c1_Runtime1.hpp"
33 #include "classfile/javaClasses.hpp"
34 #include "nativeInst_ppc.hpp"
35 #include "runtime/sharedRuntime.hpp"
36 #include "utilities/macros.hpp"
37 #include "vmreg_ppc.inline.hpp"
38
39 #define __ ce->masm()->
40
41 void C1SafepointPollStub::emit_code(LIR_Assembler* ce) {
42 if (UseSIGTRAP) {
43 DEBUG_ONLY( __ should_not_reach_here("C1SafepointPollStub::emit_code"); )
44 } else {
45 assert(SharedRuntime::polling_page_return_handler_blob() != NULL,
46 "polling page return stub not created yet");
47 address stub = SharedRuntime::polling_page_return_handler_blob()->entry_point();
48
49 __ bind(_entry);
50 // Using pc relative address computation.
51 {
52 Label next_pc;
53 __ bl(next_pc);
54 __ bind(next_pc);
55 }
56 int current_offset = __ offset();
57 __ mflr(R12);
58 __ add_const_optimized(R12, R12, safepoint_offset() - current_offset);
59 __ std(R12, in_bytes(JavaThread::saved_exception_pc_offset()), R16_thread);
60
61 __ add_const_optimized(R0, R29_TOC, MacroAssembler::offset_to_global_toc(stub));
62 __ mtctr(R0);
63 __ bctr();
64 }
65 }
66
67 RangeCheckStub::RangeCheckStub(CodeEmitInfo* info, LIR_Opr index, LIR_Opr array)
68 : _index(index), _array(array), _throw_index_out_of_bounds_exception(false) {
69 assert(info != NULL, "must have info");
70 _info = new CodeEmitInfo(info);
71 }
72
73 RangeCheckStub::RangeCheckStub(CodeEmitInfo* info, LIR_Opr index)
74 : _index(index), _array(NULL), _throw_index_out_of_bounds_exception(true) {
75 assert(info != NULL, "must have info");
76 _info = new CodeEmitInfo(info);
77 }
78
79 void RangeCheckStub::emit_code(LIR_Assembler* ce) {
80 __ bind(_entry);
81
82 if (_info->deoptimize_on_exception()) {
83 address a = Runtime1::entry_for(Runtime1::predicate_failed_trap_id);
84 //__ load_const_optimized(R0, a);
85 __ add_const_optimized(R0, R29_TOC, MacroAssembler::offset_to_global_toc(a));
86 __ mtctr(R0);
87 __ bctrl();
88 ce->add_call_info_here(_info);
89 ce->verify_oop_map(_info);
90 debug_only(__ illtrap());
91 return;
92 }
93
94 address stub = _throw_index_out_of_bounds_exception ? Runtime1::entry_for(Runtime1::throw_index_exception_id)
95 : Runtime1::entry_for(Runtime1::throw_range_check_failed_id);
96 //__ load_const_optimized(R0, stub);
97 __ add_const_optimized(R0, R29_TOC, MacroAssembler::offset_to_global_toc(stub));
98 __ mtctr(R0);
99
100 Register index = R0;
101 if (_index->is_register()) {
102 __ extsw(index, _index->as_register());
103 } else {
104 __ load_const_optimized(index, _index->as_jint());
105 }
106 if (_array) {
107 __ std(_array->as_pointer_register(), -8, R1_SP);
108 }
109 __ std(index, -16, R1_SP);
110
111 __ bctrl();
112 ce->add_call_info_here(_info);
113 ce->verify_oop_map(_info);
114 debug_only(__ illtrap());
115 }
116
117
118 PredicateFailedStub::PredicateFailedStub(CodeEmitInfo* info) {
119 _info = new CodeEmitInfo(info);
120 }
121
122 void PredicateFailedStub::emit_code(LIR_Assembler* ce) {
123 __ bind(_entry);
124 address a = Runtime1::entry_for(Runtime1::predicate_failed_trap_id);
125 //__ load_const_optimized(R0, a);
126 __ add_const_optimized(R0, R29_TOC, MacroAssembler::offset_to_global_toc(a));
127 __ mtctr(R0);
128 __ bctrl();
129 ce->add_call_info_here(_info);
130 ce->verify_oop_map(_info);
131 debug_only(__ illtrap());
132 }
133
134
135 void CounterOverflowStub::emit_code(LIR_Assembler* ce) {
136 __ bind(_entry);
137
138 // Parameter 1: bci
139 __ load_const_optimized(R0, _bci);
140 __ std(R0, -16, R1_SP);
141
142 // Parameter 2: Method*
143 Metadata *m = _method->as_constant_ptr()->as_metadata();
144 AddressLiteral md = __ constant_metadata_address(m); // Notify OOP recorder (don't need the relocation).
145 __ load_const_optimized(R0, md.value());
146 __ std(R0, -8, R1_SP);
147
148 address a = Runtime1::entry_for(Runtime1::counter_overflow_id);
149 //__ load_const_optimized(R0, a);
150 __ add_const_optimized(R0, R29_TOC, MacroAssembler::offset_to_global_toc(a));
151 __ mtctr(R0);
152 __ bctrl();
153 ce->add_call_info_here(_info);
154 ce->verify_oop_map(_info);
155
156 __ b(_continuation);
157 }
158
159
160 void DivByZeroStub::emit_code(LIR_Assembler* ce) {
161 if (_offset != -1) {
162 ce->compilation()->implicit_exception_table()->append(_offset, __ offset());
163 }
164 __ bind(_entry);
165 address stub = Runtime1::entry_for(Runtime1::throw_div0_exception_id);
166 //__ load_const_optimized(R0, stub);
167 __ add_const_optimized(R0, R29_TOC, MacroAssembler::offset_to_global_toc(stub));
168 __ mtctr(R0);
169 __ bctrl();
170 ce->add_call_info_here(_info);
171 ce->verify_oop_map(_info);
172 debug_only(__ illtrap());
173 }
174
175
176 void ImplicitNullCheckStub::emit_code(LIR_Assembler* ce) {
177 address a;
178 if (_info->deoptimize_on_exception()) {
179 // Deoptimize, do not throw the exception, because it is probably wrong to do it here.
180 a = Runtime1::entry_for(Runtime1::predicate_failed_trap_id);
181 } else {
182 a = Runtime1::entry_for(Runtime1::throw_null_pointer_exception_id);
183 }
184
185 if (ImplicitNullChecks || TrapBasedNullChecks) {
186 ce->compilation()->implicit_exception_table()->append(_offset, __ offset());
187 }
188 __ bind(_entry);
189 //__ load_const_optimized(R0, a);
190 __ add_const_optimized(R0, R29_TOC, MacroAssembler::offset_to_global_toc(a));
191 __ mtctr(R0);
192 __ bctrl();
193 ce->add_call_info_here(_info);
194 ce->verify_oop_map(_info);
195 debug_only(__ illtrap());
196 }
197
198
199 // Implementation of SimpleExceptionStub
200 void SimpleExceptionStub::emit_code(LIR_Assembler* ce) {
201 __ bind(_entry);
202 address stub = Runtime1::entry_for(_stub);
203 //__ load_const_optimized(R0, stub);
204 __ add_const_optimized(R0, R29_TOC, MacroAssembler::offset_to_global_toc(stub));
205 if (_obj->is_valid()) { __ mr_if_needed(/*tmp1 in do_CheckCast*/ R4_ARG2, _obj->as_register()); }
206 __ mtctr(R0);
207 __ bctrl();
208 ce->add_call_info_here(_info);
209 debug_only( __ illtrap(); )
210 }
211
212
213 // Implementation of NewInstanceStub
214 NewInstanceStub::NewInstanceStub(LIR_Opr klass_reg, LIR_Opr result, ciInstanceKlass* klass, CodeEmitInfo* info, Runtime1::StubID stub_id) {
215 _result = result;
216 _klass = klass;
217 _klass_reg = klass_reg;
218 _info = new CodeEmitInfo(info);
219 assert(stub_id == Runtime1::new_instance_id ||
220 stub_id == Runtime1::fast_new_instance_id ||
221 stub_id == Runtime1::fast_new_instance_init_check_id,
222 "need new_instance id");
223 _stub_id = stub_id;
224 }
225
226 void NewInstanceStub::emit_code(LIR_Assembler* ce) {
227 __ bind(_entry);
228
229 address entry = Runtime1::entry_for(_stub_id);
230 //__ load_const_optimized(R0, entry);
231 __ add_const_optimized(R0, R29_TOC, MacroAssembler::offset_to_global_toc(entry));
232 __ mtctr(R0);
233 __ bctrl();
234 ce->add_call_info_here(_info);
235 ce->verify_oop_map(_info);
236 __ b(_continuation);
237 }
238
239
240 // Implementation of NewTypeArrayStub
241 NewTypeArrayStub::NewTypeArrayStub(LIR_Opr klass_reg, LIR_Opr length, LIR_Opr result, CodeEmitInfo* info) {
242 _klass_reg = klass_reg;
243 _length = length;
244 _result = result;
245 _info = new CodeEmitInfo(info);
246 }
247
248 void NewTypeArrayStub::emit_code(LIR_Assembler* ce) {
249 __ bind(_entry);
250
251 address entry = Runtime1::entry_for(Runtime1::new_type_array_id);
252 //__ load_const_optimized(R0, entry);
253 __ add_const_optimized(R0, R29_TOC, MacroAssembler::offset_to_global_toc(entry));
254 __ mr_if_needed(/*op->tmp1()->as_register()*/ R5_ARG3, _length->as_register()); // already sign-extended
255 __ mtctr(R0);
256 __ bctrl();
257 ce->add_call_info_here(_info);
258 ce->verify_oop_map(_info);
259 __ b(_continuation);
260 }
261
262
263 // Implementation of NewObjectArrayStub
264 NewObjectArrayStub::NewObjectArrayStub(LIR_Opr klass_reg, LIR_Opr length, LIR_Opr result, CodeEmitInfo* info) {
265 _klass_reg = klass_reg;
266 _length = length;
267 _result = result;
268 _info = new CodeEmitInfo(info);
269 }
270
271 void NewObjectArrayStub::emit_code(LIR_Assembler* ce) {
272 __ bind(_entry);
273
274 address entry = Runtime1::entry_for(Runtime1::new_object_array_id);
275 //__ load_const_optimized(R0, entry);
276 __ add_const_optimized(R0, R29_TOC, MacroAssembler::offset_to_global_toc(entry));
277 __ mr_if_needed(/*op->tmp1()->as_register()*/ R5_ARG3, _length->as_register()); // already sign-extended
278 __ mtctr(R0);
279 __ bctrl();
280 ce->add_call_info_here(_info);
281 ce->verify_oop_map(_info);
282 __ b(_continuation);
283 }
284
285
286 // Implementation of MonitorAccessStubs
287 MonitorEnterStub::MonitorEnterStub(LIR_Opr obj_reg, LIR_Opr lock_reg, CodeEmitInfo* info)
288 : MonitorAccessStub(obj_reg, lock_reg) {
289 _info = new CodeEmitInfo(info);
290 }
291
292 void MonitorEnterStub::emit_code(LIR_Assembler* ce) {
293 __ bind(_entry);
294 address stub = Runtime1::entry_for(ce->compilation()->has_fpu_code() ? Runtime1::monitorenter_id : Runtime1::monitorenter_nofpu_id);
295 //__ load_const_optimized(R0, stub);
296 __ add_const_optimized(R0, R29_TOC, MacroAssembler::offset_to_global_toc(stub));
297 __ mr_if_needed(/*scratch_opr()->as_register()*/ R4_ARG2, _obj_reg->as_register());
298 assert(_lock_reg->as_register() == R5_ARG3, "");
299 __ mtctr(R0);
300 __ bctrl();
301 ce->add_call_info_here(_info);
302 ce->verify_oop_map(_info);
303 __ b(_continuation);
304 }
305
306 void MonitorExitStub::emit_code(LIR_Assembler* ce) {
307 __ bind(_entry);
308 if (_compute_lock) {
309 ce->monitor_address(_monitor_ix, _lock_reg);
310 }
311 address stub = Runtime1::entry_for(ce->compilation()->has_fpu_code() ? Runtime1::monitorexit_id : Runtime1::monitorexit_nofpu_id);
312 //__ load_const_optimized(R0, stub);
313 __ add_const_optimized(R0, R29_TOC, MacroAssembler::offset_to_global_toc(stub));
314 assert(_lock_reg->as_register() == R4_ARG2, "");
315 __ mtctr(R0);
316 __ bctrl();
317 __ b(_continuation);
318 }
319
320 void LoadKlassStub::emit_code(LIR_Assembler* ce) {
321 Unimplemented(); // Only needed with compact object headers.
322 }
323
324 // Implementation of patching:
325 // - Copy the code at given offset to an inlined buffer (first the bytes, then the number of bytes).
326 // - Replace original code with a call to the stub.
327 // At Runtime:
328 // - call to stub, jump to runtime
329 // - in runtime: preserve all registers (especially objects, i.e., source and destination object)
330 // - in runtime: after initializing class, restore original code, reexecute instruction
331
332 int PatchingStub::_patch_info_offset = -(5 * BytesPerInstWord);
333
334 void PatchingStub::align_patch_site(MacroAssembler* ) {
335 // Patch sites on ppc are always properly aligned.
336 }
337
338 #ifdef ASSERT
339 inline void compare_with_patch_site(address template_start, address pc_start, int bytes_to_copy) {
340 address start = template_start;
341 for (int i = 0; i < bytes_to_copy; i++) {
342 address ptr = (address)(pc_start + i);
343 int a_byte = (*ptr) & 0xFF;
344 assert(a_byte == *start++, "should be the same code");
345 }
346 }
347 #endif
348
349 void PatchingStub::emit_code(LIR_Assembler* ce) {
350 // copy original code here
351 assert(NativeGeneralJump::instruction_size <= _bytes_to_copy && _bytes_to_copy <= 0xFF,
352 "not enough room for call, need %d", _bytes_to_copy);
353 assert((_bytes_to_copy & 0x3) == 0, "must copy a multiple of four bytes");
354
355 Label call_patch;
356
357 int being_initialized_entry = __ offset();
358
359 if (_id == load_klass_id) {
360 // Produce a copy of the load klass instruction for use by the being initialized case.
361 AddressLiteral addrlit((address)NULL, metadata_Relocation::spec(_index));
362 __ load_const(_obj, addrlit, R0);
363 DEBUG_ONLY( compare_with_patch_site(__ code_section()->start() + being_initialized_entry, _pc_start, _bytes_to_copy); )
364 } else if (_id == load_mirror_id || _id == load_appendix_id) {
365 // Produce a copy of the load mirror instruction for use by the being initialized case.
366 AddressLiteral addrlit((address)NULL, oop_Relocation::spec(_index));
367 __ load_const(_obj, addrlit, R0);
368 DEBUG_ONLY( compare_with_patch_site(__ code_section()->start() + being_initialized_entry, _pc_start, _bytes_to_copy); )
369 } else {
370 // Make a copy of the code which is going to be patched.
371 for (int i = 0; i < _bytes_to_copy; i++) {
372 address ptr = (address)(_pc_start + i);
373 int a_byte = (*ptr) & 0xFF;
374 __ emit_int8 (a_byte);
375 }
376 }
377
378 address end_of_patch = __ pc();
379 int bytes_to_skip = 0;
380 if (_id == load_mirror_id) {
381 int offset = __ offset();
382 __ block_comment(" being_initialized check");
383
384 // Static field accesses have special semantics while the class
385 // initializer is being run so we emit a test which can be used to
386 // check that this code is being executed by the initializing
387 // thread.
388 assert(_obj != noreg, "must be a valid register");
389 assert(_index >= 0, "must have oop index");
390 __ mr(R0, _obj); // spill
391 __ ld(_obj, java_lang_Class::klass_offset(), _obj);
392 __ ld(_obj, in_bytes(InstanceKlass::init_thread_offset()), _obj);
393 __ cmpd(CCR0, _obj, R16_thread);
394 __ mr(_obj, R0); // restore
395 __ bne(CCR0, call_patch);
396
397 // Load_klass patches may execute the patched code before it's
398 // copied back into place so we need to jump back into the main
399 // code of the nmethod to continue execution.
400 __ b(_patch_site_continuation);
401
402 // Make sure this extra code gets skipped.
403 bytes_to_skip += __ offset() - offset;
404 }
405
406 // Now emit the patch record telling the runtime how to find the
407 // pieces of the patch. We only need 3 bytes but it has to be
408 // aligned as an instruction so emit 4 bytes.
409 int sizeof_patch_record = 4;
410 bytes_to_skip += sizeof_patch_record;
411
412 // Emit the offsets needed to find the code to patch.
413 int being_initialized_entry_offset = __ offset() - being_initialized_entry + sizeof_patch_record;
414
415 // Emit the patch record. We need to emit a full word, so emit an extra empty byte.
416 __ emit_int8(0);
417 __ emit_int8(being_initialized_entry_offset);
418 __ emit_int8(bytes_to_skip);
419 __ emit_int8(_bytes_to_copy);
420 address patch_info_pc = __ pc();
421 assert(patch_info_pc - end_of_patch == bytes_to_skip, "incorrect patch info");
422
423 address entry = __ pc();
424 NativeGeneralJump::insert_unconditional((address)_pc_start, entry);
425 address target = NULL;
426 relocInfo::relocType reloc_type = relocInfo::none;
427 switch (_id) {
428 case access_field_id: target = Runtime1::entry_for(Runtime1::access_field_patching_id); break;
429 case load_klass_id: target = Runtime1::entry_for(Runtime1::load_klass_patching_id);
430 reloc_type = relocInfo::metadata_type; break;
431 case load_mirror_id: target = Runtime1::entry_for(Runtime1::load_mirror_patching_id);
432 reloc_type = relocInfo::oop_type; break;
433 case load_appendix_id: target = Runtime1::entry_for(Runtime1::load_appendix_patching_id);
434 reloc_type = relocInfo::oop_type; break;
435 default: ShouldNotReachHere();
436 }
437 __ bind(call_patch);
438
439 __ block_comment("patch entry point");
440 //__ load_const(R0, target); + mtctr + bctrl must have size -_patch_info_offset
441 __ load_const32(R0, MacroAssembler::offset_to_global_toc(target));
442 __ add(R0, R29_TOC, R0);
443 __ mtctr(R0);
444 __ bctrl();
445 assert(_patch_info_offset == (patch_info_pc - __ pc()), "must not change");
446 ce->add_call_info_here(_info);
447 __ b(_patch_site_entry);
448 if (_id == load_klass_id || _id == load_mirror_id || _id == load_appendix_id) {
449 CodeSection* cs = __ code_section();
450 address pc = (address)_pc_start;
451 RelocIterator iter(cs, pc, pc + 1);
452 relocInfo::change_reloc_info_for_address(&iter, (address) pc, reloc_type, relocInfo::none);
453 }
454 }
455
456
457 void DeoptimizeStub::emit_code(LIR_Assembler* ce) {
458 __ bind(_entry);
459 address stub = Runtime1::entry_for(Runtime1::deoptimize_id);
460 //__ load_const_optimized(R0, stub);
461 __ add_const_optimized(R0, R29_TOC, MacroAssembler::offset_to_global_toc(stub));
462 __ mtctr(R0);
463
464 __ load_const_optimized(R0, _trap_request); // Pass trap request in R0.
465 __ bctrl();
466 ce->add_call_info_here(_info);
467 debug_only(__ illtrap());
468 }
469
470
471 void ArrayCopyStub::emit_code(LIR_Assembler* ce) {
472 //---------------slow case: call to native-----------------
473 __ bind(_entry);
474 __ mr(R3_ARG1, src()->as_register());
475 __ extsw(R4_ARG2, src_pos()->as_register());
476 __ mr(R5_ARG3, dst()->as_register());
477 __ extsw(R6_ARG4, dst_pos()->as_register());
478 __ extsw(R7_ARG5, length()->as_register());
479
480 ce->emit_static_call_stub();
481
482 bool success = ce->emit_trampoline_stub_for_call(SharedRuntime::get_resolve_static_call_stub());
483 if (!success) { return; }
484
485 __ relocate(relocInfo::static_call_type);
486 // Note: At this point we do not have the address of the trampoline
487 // stub, and the entry point might be too far away for bl, so __ pc()
488 // serves as dummy and the bl will be patched later.
489 __ code()->set_insts_mark();
490 __ bl(__ pc());
491 ce->add_call_info_here(info());
492 ce->verify_oop_map(info());
493
494 #ifndef PRODUCT
495 const address counter = (address)&Runtime1::_arraycopy_slowcase_cnt;
496 const Register tmp = R3, tmp2 = R4;
497 int simm16_offs = __ load_const_optimized(tmp, counter, tmp2, true);
498 __ lwz(tmp2, simm16_offs, tmp);
499 __ addi(tmp2, tmp2, 1);
500 __ stw(tmp2, simm16_offs, tmp);
501 #endif
502
503 __ b(_continuation);
504 }
505
506 #undef __