1 /*
2 * Copyright (c) 2016, 2026, Oracle and/or its affiliates. All rights reserved.
3 * Copyright (c) 2016, 2024 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 // Major contributions by AHa, AS, JL, ML.
27
28 #include "asm/macroAssembler.inline.hpp"
29 #include "gc/shared/barrierSet.hpp"
30 #include "gc/shared/barrierSetAssembler.hpp"
31 #include "interp_masm_s390.hpp"
32 #include "interpreter/interpreter.hpp"
33 #include "interpreter/interpreterRuntime.hpp"
34 #include "oops/arrayOop.hpp"
35 #include "oops/markWord.hpp"
36 #include "oops/methodCounters.hpp"
37 #include "oops/methodData.hpp"
38 #include "oops/resolvedFieldEntry.hpp"
39 #include "oops/resolvedIndyEntry.hpp"
40 #include "oops/resolvedMethodEntry.hpp"
41 #include "prims/jvmtiExport.hpp"
42 #include "prims/jvmtiThreadState.hpp"
43 #include "runtime/basicLock.hpp"
44 #include "runtime/frame.inline.hpp"
45 #include "runtime/javaThread.hpp"
46 #include "runtime/safepointMechanism.hpp"
47 #include "runtime/sharedRuntime.hpp"
48 #include "utilities/macros.hpp"
49 #include "utilities/powerOfTwo.hpp"
50
51 // Implementation of InterpreterMacroAssembler.
52 // This file specializes the assembler with interpreter-specific macros.
53
54 #ifdef PRODUCT
55 #define BLOCK_COMMENT(str)
56 #define BIND(label) bind(label);
57 #else
58 #define BLOCK_COMMENT(str) block_comment(str)
59 #define BIND(label) bind(label); BLOCK_COMMENT(#label ":")
60 #endif
61
62 void InterpreterMacroAssembler::jump_to_entry(address entry, Register Rscratch) {
63 assert(entry != nullptr, "Entry must have been generated by now");
64 assert(Rscratch != Z_R0, "Can't use R0 for addressing");
65 branch_optimized(Assembler::bcondAlways, entry);
66 }
67
68 void InterpreterMacroAssembler::empty_expression_stack(void) {
69 get_monitors(Z_R1_scratch);
70 add2reg(Z_esp, -Interpreter::stackElementSize, Z_R1_scratch);
71 }
72
73 // Dispatch code executed in the prolog of a bytecode which does not do it's
74 // own dispatch.
75 void InterpreterMacroAssembler::dispatch_prolog(TosState state, int bcp_incr) {
76 // On z/Architecture we are short on registers, therefore we do not preload the
77 // dispatch address of the next bytecode.
78 }
79
80 // Dispatch code executed in the epilog of a bytecode which does not do it's
81 // own dispatch.
82 void InterpreterMacroAssembler::dispatch_epilog(TosState state, int step) {
83 dispatch_next(state, step);
84 }
85
86 void InterpreterMacroAssembler::dispatch_next(TosState state, int bcp_incr, bool generate_poll) {
87 z_llgc(Z_bytecode, bcp_incr, Z_R0, Z_bcp); // Load next bytecode.
88 add2reg(Z_bcp, bcp_incr); // Advance bcp. Add2reg produces optimal code.
89 dispatch_base(state, Interpreter::dispatch_table(state), generate_poll);
90 }
91
92 // Common code to dispatch and dispatch_only.
93 // Dispatch value in Lbyte_code and increment Lbcp.
94
95 void InterpreterMacroAssembler::dispatch_base(TosState state, address* table, bool generate_poll) {
96 #ifdef ASSERT
97 address reentry = nullptr;
98 { Label OK;
99 // Check if the frame pointer in Z_fp is correct.
100 z_cg(Z_fp, 0, Z_SP);
101 z_bre(OK);
102 reentry = stop_chain_static(reentry, "invalid frame pointer Z_fp: " FILE_AND_LINE);
103 bind(OK);
104 }
105 { Label OK;
106 // check if the locals pointer in Z_locals is correct
107
108 // _z_ijava_state_neg(locals)) is fp relativized, so we need to
109 // extract the pointer.
110
111 z_lg(Z_R1_scratch, Address(Z_fp, _z_ijava_state_neg(locals)));
112 z_sllg(Z_R1_scratch, Z_R1_scratch, Interpreter::logStackElementSize);
113 z_agr(Z_R1_scratch, Z_fp);
114
115 z_cgr(Z_locals, Z_R1_scratch);
116 z_bre(OK);
117 reentry = stop_chain_static(reentry, "invalid locals pointer Z_locals: " FILE_AND_LINE);
118 bind(OK);
119 }
120 #endif
121
122 // TODO: Maybe implement +VerifyActivationFrameSize here.
123 verify_oop(Z_tos, state);
124
125 // Dispatch table to use.
126 load_absolute_address(Z_tmp_1, (address)table); // Z_tmp_1 = table;
127
128 if (generate_poll) {
129 address *sfpt_tbl = Interpreter::safept_table(state);
130 if (table != sfpt_tbl) {
131 Label dispatch;
132 const Address poll_byte_addr(Z_thread, in_bytes(JavaThread::polling_word_offset()) + 7 /* Big Endian */);
133 // Armed page has poll_bit set, if poll bit is cleared just continue.
134 z_tm(poll_byte_addr, SafepointMechanism::poll_bit());
135 z_braz(dispatch);
136 load_absolute_address(Z_tmp_1, (address)sfpt_tbl); // Z_tmp_1 = table;
137 bind(dispatch);
138 }
139 }
140
141 // 0 <= Z_bytecode < 256 => Use a 32 bit shift, because it is shorter than sllg.
142 // Z_bytecode must have been loaded zero-extended for this approach to be correct.
143 z_sll(Z_bytecode, LogBytesPerWord, Z_R0); // Multiply by wordSize.
144 z_lg(Z_tmp_1, 0, Z_bytecode, Z_tmp_1); // Get entry addr.
145
146 z_br(Z_tmp_1);
147 }
148
149 void InterpreterMacroAssembler::dispatch_only(TosState state, bool generate_poll) {
150 dispatch_base(state, Interpreter::dispatch_table(state), generate_poll);
151 }
152
153 void InterpreterMacroAssembler::dispatch_only_normal(TosState state) {
154 dispatch_base(state, Interpreter::normal_table(state));
155 }
156
157 void InterpreterMacroAssembler::dispatch_via(TosState state, address *table) {
158 // Load current bytecode.
159 z_llgc(Z_bytecode, Address(Z_bcp, (intptr_t)0));
160 dispatch_base(state, table);
161 }
162
163 // The following call_VM*_base() methods overload and mask the respective
164 // declarations/definitions in class MacroAssembler. They are meant as a "detour"
165 // to perform additional, template interpreter specific tasks before actually
166 // calling their MacroAssembler counterparts.
167
168 void InterpreterMacroAssembler::call_VM_leaf_base(address entry_point) {
169 bool allow_relocation = true; // Fenerally valid variant. Assume code is relocated.
170 // interpreter specific
171 // Note: No need to save/restore bcp (Z_R13) pointer since these are callee
172 // saved registers and no blocking/ GC can happen in leaf calls.
173
174 // super call
175 MacroAssembler::call_VM_leaf_base(entry_point, allow_relocation);
176 }
177
178 void InterpreterMacroAssembler::call_VM_leaf_base(address entry_point, bool allow_relocation) {
179 // interpreter specific
180 // Note: No need to save/restore bcp (Z_R13) pointer since these are callee
181 // saved registers and no blocking/ GC can happen in leaf calls.
182
183 // super call
184 MacroAssembler::call_VM_leaf_base(entry_point, allow_relocation);
185 }
186
187 void InterpreterMacroAssembler::call_VM_base(Register oop_result, Register last_java_sp,
188 address entry_point, bool check_exceptions) {
189 bool allow_relocation = true; // Fenerally valid variant. Assume code is relocated.
190 // interpreter specific
191
192 save_bcp();
193 save_esp();
194 // super call
195 MacroAssembler::call_VM_base(oop_result, last_java_sp,
196 entry_point, allow_relocation, check_exceptions);
197 restore_bcp();
198 }
199
200 void InterpreterMacroAssembler::call_VM_base(Register oop_result, Register last_java_sp,
201 address entry_point, bool allow_relocation,
202 bool check_exceptions) {
203 // interpreter specific
204
205 save_bcp();
206 save_esp();
207 // super call
208 MacroAssembler::call_VM_base(oop_result, last_java_sp,
209 entry_point, allow_relocation, check_exceptions);
210 restore_bcp();
211 }
212
213 void InterpreterMacroAssembler::check_and_handle_popframe(Register scratch_reg) {
214 if (JvmtiExport::can_pop_frame()) {
215 BLOCK_COMMENT("check_and_handle_popframe {");
216 Label L;
217 // Initiate popframe handling only if it is not already being
218 // processed. If the flag has the popframe_processing bit set, it
219 // means that this code is called *during* popframe handling - we
220 // don't want to reenter.
221 // TODO: Check if all four state combinations could be visible.
222 // If (processing and !pending) is an invisible/impossible state,
223 // there is optimization potential by testing both bits at once.
224 // Then, All_Zeroes and All_Ones means skip, Mixed means doit.
225 testbit(Address(Z_thread, JavaThread::popframe_condition_offset()),
226 exact_log2(JavaThread::popframe_pending_bit));
227 z_bfalse(L);
228 testbit(Address(Z_thread, JavaThread::popframe_condition_offset()),
229 exact_log2(JavaThread::popframe_processing_bit));
230 z_btrue(L);
231
232 // Call Interpreter::remove_activation_preserving_args_entry() to get the
233 // address of the same-named entrypoint in the generated interpreter code.
234 call_VM_leaf(CAST_FROM_FN_PTR(address, Interpreter::remove_activation_preserving_args_entry));
235 // The above call should (as its only effect) return the contents of the field
236 // _remove_activation_preserving_args_entry in Z_RET.
237 // We just jump there to have the work done.
238 z_br(Z_RET);
239 // There is no way for control to fall thru here.
240
241 bind(L);
242 BLOCK_COMMENT("} check_and_handle_popframe");
243 }
244 }
245
246
247 void InterpreterMacroAssembler::load_earlyret_value(TosState state) {
248 Register RjvmtiState = Z_R1_scratch;
249 int tos_off = in_bytes(JvmtiThreadState::earlyret_tos_offset());
250 int oop_off = in_bytes(JvmtiThreadState::earlyret_oop_offset());
251 int val_off = in_bytes(JvmtiThreadState::earlyret_value_offset());
252 int state_off = in_bytes(JavaThread::jvmti_thread_state_offset());
253
254 z_lg(RjvmtiState, state_off, Z_thread);
255
256 switch (state) {
257 case atos: z_lg(Z_tos, oop_off, RjvmtiState);
258 store_const(Address(RjvmtiState, oop_off), 0L, 8, 8, Z_R0_scratch);
259 break;
260 case ltos: z_lg(Z_tos, val_off, RjvmtiState); break;
261 case btos: // fall through
262 case ztos: // fall through
263 case ctos: // fall through
264 case stos: // fall through
265 case itos: z_llgf(Z_tos, val_off, RjvmtiState); break;
266 case ftos: z_le(Z_ftos, val_off, RjvmtiState); break;
267 case dtos: z_ld(Z_ftos, val_off, RjvmtiState); break;
268 case vtos: /* nothing to do */ break;
269 default : ShouldNotReachHere();
270 }
271
272 // Clean up tos value in the jvmti thread state.
273 store_const(Address(RjvmtiState, val_off), 0L, 8, 8, Z_R0_scratch);
274 // Set tos state field to illegal value.
275 store_const(Address(RjvmtiState, tos_off), ilgl, 4, 1, Z_R0_scratch);
276 }
277
278 void InterpreterMacroAssembler::check_and_handle_earlyret(Register scratch_reg) {
279 if (JvmtiExport::can_force_early_return()) {
280 BLOCK_COMMENT("check_and_handle_earlyret {");
281 Label L;
282 // arg regs are save, because we are just behind the call in call_VM_base
283 Register jvmti_thread_state = Z_ARG2;
284 Register tmp = Z_ARG3;
285 load_and_test_long(jvmti_thread_state, Address(Z_thread, JavaThread::jvmti_thread_state_offset()));
286 z_bre(L); // if (thread->jvmti_thread_state() == nullptr) exit;
287
288 // Initiate earlyret handling only if it is not already being processed.
289 // If the flag has the earlyret_processing bit set, it means that this code
290 // is called *during* earlyret handling - we don't want to reenter.
291
292 assert((JvmtiThreadState::earlyret_pending != 0) && (JvmtiThreadState::earlyret_inactive == 0),
293 "must fix this check, when changing the values of the earlyret enum");
294 assert(JvmtiThreadState::earlyret_pending == 1, "must fix this check, when changing the values of the earlyret enum");
295
296 load_and_test_int(tmp, Address(jvmti_thread_state, JvmtiThreadState::earlyret_state_offset()));
297 z_brz(L); // if (thread->jvmti_thread_state()->_earlyret_state != JvmtiThreadState::earlyret_pending) exit;
298
299 // Call Interpreter::remove_activation_early_entry() to get the address of the
300 // same-named entrypoint in the generated interpreter code.
301 assert(sizeof(TosState) == 4, "unexpected size");
302 z_l(Z_ARG1, Address(jvmti_thread_state, JvmtiThreadState::earlyret_tos_offset()));
303 call_VM_leaf(CAST_FROM_FN_PTR(address, Interpreter::remove_activation_early_entry), Z_ARG1);
304 // The above call should (as its only effect) return the contents of the field
305 // _remove_activation_preserving_args_entry in Z_RET.
306 // We just jump there to have the work done.
307 z_br(Z_RET);
308 // There is no way for control to fall thru here.
309
310 bind(L);
311 BLOCK_COMMENT("} check_and_handle_earlyret");
312 }
313 }
314
315 void InterpreterMacroAssembler::super_call_VM_leaf(address entry_point, Register arg_1, Register arg_2) {
316 lgr_if_needed(Z_ARG1, arg_1);
317 assert(arg_2 != Z_ARG1, "smashed argument");
318 lgr_if_needed(Z_ARG2, arg_2);
319 MacroAssembler::call_VM_leaf_base(entry_point, true);
320 }
321
322 void InterpreterMacroAssembler::get_cache_index_at_bcp(Register index, int bcp_offset, size_t index_size) {
323 Address param(Z_bcp, bcp_offset);
324
325 BLOCK_COMMENT("get_cache_index_at_bcp {");
326 assert(bcp_offset > 0, "bcp is still pointing to start of bytecode");
327 if (index_size == sizeof(u2)) {
328 load_sized_value(index, param, 2, false /*signed*/);
329 } else if (index_size == sizeof(u4)) {
330
331 load_sized_value(index, param, 4, false);
332 } else if (index_size == sizeof(u1)) {
333 z_llgc(index, param);
334 } else {
335 ShouldNotReachHere();
336 }
337 BLOCK_COMMENT("}");
338 }
339
340 void InterpreterMacroAssembler::load_resolved_indy_entry(Register cache, Register index) {
341 // Get index out of bytecode pointer.
342 get_cache_index_at_bcp(index, 1, sizeof(u4));
343
344 // Get the address of the ResolvedIndyEntry array
345 get_constant_pool_cache(cache);
346 z_lg(cache, Address(cache, in_bytes(ConstantPoolCache::invokedynamic_entries_offset())));
347
348 // Scale the index to form a byte offset into the ResolvedIndyEntry array
349 size_t entry_size = sizeof(ResolvedIndyEntry);
350 if (is_power_of_2(entry_size)) {
351 z_sllg(index, index, exact_log2(entry_size));
352 } else {
353 z_mghi(index, entry_size);
354 }
355
356 // Calculate the final field address.
357 z_la(cache, Array<ResolvedIndyEntry>::base_offset_in_bytes(), index, cache);
358 }
359
360 void InterpreterMacroAssembler::load_field_entry(Register cache, Register index, int bcp_offset) {
361 // Get field index out of bytecode pointer.
362 get_cache_index_at_bcp(index, bcp_offset, sizeof(u2));
363
364 // Get the address of the ResolvedFieldEntry array.
365 get_constant_pool_cache(cache);
366 z_lg(cache, Address(cache, in_bytes(ConstantPoolCache::field_entries_offset())));
367
368 // Scale the index to form a byte offset into the ResolvedFieldEntry array
369 size_t entry_size = sizeof(ResolvedFieldEntry);
370 if (is_power_of_2(entry_size)) {
371 z_sllg(index, index, exact_log2(entry_size));
372 } else {
373 z_mghi(index, entry_size);
374 }
375
376 // Calculate the final field address.
377 z_la(cache, Array<ResolvedFieldEntry>::base_offset_in_bytes(), index, cache);
378 }
379
380 void InterpreterMacroAssembler::load_method_entry(Register cache, Register index, int bcp_offset) {
381 // Get field index out of bytecode pointer.
382 get_cache_index_at_bcp(index, bcp_offset, sizeof(u2));
383
384 // Get the address of the ResolvedMethodEntry array.
385 get_constant_pool_cache(cache);
386 z_lg(cache, Address(cache, in_bytes(ConstantPoolCache::method_entries_offset())));
387
388 // Scale the index to form a byte offset into the ResolvedMethodEntry array
389 size_t entry_size = sizeof(ResolvedMethodEntry);
390 if (is_power_of_2(entry_size)) {
391 z_sllg(index, index, exact_log2(entry_size));
392 } else {
393 z_mghi(index, entry_size);
394 }
395
396 // Calculate the final field address.
397 z_la(cache, Array<ResolvedMethodEntry>::base_offset_in_bytes(), index, cache);
398 }
399
400 // Load object from cpool->resolved_references(index).
401 void InterpreterMacroAssembler::load_resolved_reference_at_index(Register result, Register index) {
402 assert_different_registers(result, index);
403 get_constant_pool(result);
404
405 // Convert
406 // - from field index to resolved_references() index and
407 // - from word index to byte offset.
408 // Since this is a java object, it is potentially compressed.
409 Register tmp = index; // reuse
410 z_sllg(index, index, LogBytesPerHeapOop); // Offset into resolved references array.
411 // Load pointer for resolved_references[] objArray.
412 z_lg(result, in_bytes(ConstantPool::cache_offset()), result);
413 z_lg(result, in_bytes(ConstantPoolCache::resolved_references_offset()), result);
414 resolve_oop_handle(result); // Load resolved references array itself.
415 #ifdef ASSERT
416 NearLabel index_ok;
417 z_lgf(Z_R0, Address(result, arrayOopDesc::length_offset_in_bytes()));
418 z_sllg(Z_R0, Z_R0, LogBytesPerHeapOop);
419 compare64_and_branch(tmp, Z_R0, Assembler::bcondLow, index_ok);
420 stop("resolved reference index out of bounds", 0x09256);
421 bind(index_ok);
422 #endif
423 z_agr(result, index); // Address of indexed array element.
424 load_heap_oop(result, Address(result, arrayOopDesc::base_offset_in_bytes(T_OBJECT)), tmp, noreg);
425 }
426
427 // load cpool->resolved_klass_at(index)
428 void InterpreterMacroAssembler::load_resolved_klass_at_offset(Register cpool, Register offset, Register iklass) {
429 // int value = *(Rcpool->int_at_addr(which));
430 // int resolved_klass_index = extract_low_short_from_int(value);
431 z_llgh(offset, Address(cpool, offset, sizeof(ConstantPool) + 2)); // offset = resolved_klass_index (s390 is big-endian)
432 z_sllg(offset, offset, LogBytesPerWord); // Convert 'index' to 'offset'
433 z_lg(iklass, Address(cpool, ConstantPool::resolved_klasses_offset())); // iklass = cpool->_resolved_klasses
434 z_lg(iklass, Address(iklass, offset, Array<Klass*>::base_offset_in_bytes()));
435 }
436
437 // Generate a subtype check: branch to ok_is_subtype if sub_klass is
438 // a subtype of super_klass. Blows registers Rsuper_klass, Rsub_klass, tmp1, tmp2.
439 void InterpreterMacroAssembler::gen_subtype_check(Register Rsub_klass,
440 Register Rsuper_klass,
441 Register Rtmp1,
442 Register Rtmp2,
443 Label &ok_is_subtype) {
444 // Profile the not-null value's klass.
445 profile_typecheck(Rtmp1, Rsub_klass, Rtmp2);
446
447 // Do the check.
448 check_klass_subtype(Rsub_klass, Rsuper_klass, Rtmp1, Rtmp2, ok_is_subtype);
449 }
450
451 // Pop topmost element from stack. It just disappears.
452 // Useful if consumed previously by access via stackTop().
453 void InterpreterMacroAssembler::popx(int len) {
454 add2reg(Z_esp, len*Interpreter::stackElementSize);
455 DEBUG_ONLY(verify_esp(Z_esp, Z_R1_scratch));
456 }
457
458 // Get Address object of stack top. No checks. No pop.
459 // Purpose: - Provide address of stack operand to exploit reg-mem operations.
460 // - Avoid RISC-like mem2reg - reg-reg-op sequence.
461 Address InterpreterMacroAssembler::stackTop() {
462 return Address(Z_esp, Interpreter::expr_offset_in_bytes(0));
463 }
464
465 void InterpreterMacroAssembler::pop_i(Register r) {
466 z_l(r, Interpreter::expr_offset_in_bytes(0), Z_esp);
467 add2reg(Z_esp, Interpreter::stackElementSize);
468 assert_different_registers(r, Z_R1_scratch);
469 DEBUG_ONLY(verify_esp(Z_esp, Z_R1_scratch));
470 }
471
472 void InterpreterMacroAssembler::pop_ptr(Register r) {
473 z_lg(r, Interpreter::expr_offset_in_bytes(0), Z_esp);
474 add2reg(Z_esp, Interpreter::stackElementSize);
475 assert_different_registers(r, Z_R1_scratch);
476 DEBUG_ONLY(verify_esp(Z_esp, Z_R1_scratch));
477 }
478
479 void InterpreterMacroAssembler::pop_l(Register r) {
480 z_lg(r, Interpreter::expr_offset_in_bytes(0), Z_esp);
481 add2reg(Z_esp, 2*Interpreter::stackElementSize);
482 assert_different_registers(r, Z_R1_scratch);
483 DEBUG_ONLY(verify_esp(Z_esp, Z_R1_scratch));
484 }
485
486 void InterpreterMacroAssembler::pop_f(FloatRegister f) {
487 mem2freg_opt(f, Address(Z_esp, Interpreter::expr_offset_in_bytes(0)), false);
488 add2reg(Z_esp, Interpreter::stackElementSize);
489 DEBUG_ONLY(verify_esp(Z_esp, Z_R1_scratch));
490 }
491
492 void InterpreterMacroAssembler::pop_d(FloatRegister f) {
493 mem2freg_opt(f, Address(Z_esp, Interpreter::expr_offset_in_bytes(0)), true);
494 add2reg(Z_esp, 2*Interpreter::stackElementSize);
495 DEBUG_ONLY(verify_esp(Z_esp, Z_R1_scratch));
496 }
497
498 void InterpreterMacroAssembler::push_i(Register r) {
499 assert_different_registers(r, Z_R1_scratch);
500 DEBUG_ONLY(verify_esp(Z_esp, Z_R1_scratch));
501 z_st(r, Address(Z_esp));
502 add2reg(Z_esp, -Interpreter::stackElementSize);
503 }
504
505 void InterpreterMacroAssembler::push_ptr(Register r) {
506 z_stg(r, Address(Z_esp));
507 add2reg(Z_esp, -Interpreter::stackElementSize);
508 }
509
510 void InterpreterMacroAssembler::push_l(Register r) {
511 assert_different_registers(r, Z_R1_scratch);
512 DEBUG_ONLY(verify_esp(Z_esp, Z_R1_scratch));
513 int offset = -Interpreter::stackElementSize;
514 z_stg(r, Address(Z_esp, offset));
515 clear_mem(Address(Z_esp), Interpreter::stackElementSize);
516 add2reg(Z_esp, 2 * offset);
517 }
518
519 void InterpreterMacroAssembler::push_f(FloatRegister f) {
520 DEBUG_ONLY(verify_esp(Z_esp, Z_R1_scratch));
521 freg2mem_opt(f, Address(Z_esp), false);
522 add2reg(Z_esp, -Interpreter::stackElementSize);
523 }
524
525 void InterpreterMacroAssembler::push_d(FloatRegister d) {
526 DEBUG_ONLY(verify_esp(Z_esp, Z_R1_scratch));
527 int offset = -Interpreter::stackElementSize;
528 freg2mem_opt(d, Address(Z_esp, offset));
529 add2reg(Z_esp, 2 * offset);
530 }
531
532 void InterpreterMacroAssembler::push(TosState state) {
533 verify_oop(Z_tos, state);
534 switch (state) {
535 case atos: push_ptr(); break;
536 case btos: push_i(); break;
537 case ztos:
538 case ctos:
539 case stos: push_i(); break;
540 case itos: push_i(); break;
541 case ltos: push_l(); break;
542 case ftos: push_f(); break;
543 case dtos: push_d(); break;
544 case vtos: /* nothing to do */ break;
545 default : ShouldNotReachHere();
546 }
547 }
548
549 void InterpreterMacroAssembler::pop(TosState state) {
550 switch (state) {
551 case atos: pop_ptr(Z_tos); break;
552 case btos: pop_i(Z_tos); break;
553 case ztos:
554 case ctos:
555 case stos: pop_i(Z_tos); break;
556 case itos: pop_i(Z_tos); break;
557 case ltos: pop_l(Z_tos); break;
558 case ftos: pop_f(Z_ftos); break;
559 case dtos: pop_d(Z_ftos); break;
560 case vtos: /* nothing to do */ break;
561 default : ShouldNotReachHere();
562 }
563 verify_oop(Z_tos, state);
564 }
565
566 // Helpers for swap and dup.
567 void InterpreterMacroAssembler::load_ptr(int n, Register val) {
568 z_lg(val, Address(Z_esp, Interpreter::expr_offset_in_bytes(n)));
569 }
570
571 void InterpreterMacroAssembler::store_ptr(int n, Register val) {
572 z_stg(val, Address(Z_esp, Interpreter::expr_offset_in_bytes(n)));
573 }
574
575 void InterpreterMacroAssembler::prepare_to_jump_from_interpreted(Register method) {
576 // Satisfy interpreter calling convention (see generate_normal_entry()).
577 z_lgr(Z_R10, Z_SP); // Set sender sp (aka initial caller sp, aka unextended sp).
578 #ifdef ASSERT
579 NearLabel ok;
580 Register tmp = Z_R1;
581 z_lg(tmp, Address(Z_fp, _z_ijava_state_neg(top_frame_sp)));
582 z_slag(tmp, tmp, Interpreter::logStackElementSize);
583 z_agr(tmp, Z_fp);
584 z_cgr(tmp, Z_SP);
585 z_bre(ok);
586 stop("corrupted top_frame_sp");
587 bind(ok);
588 #endif
589 save_bcp();
590 save_esp();
591 z_lgr(Z_method, method); // Set Z_method (kills Z_fp!).
592 }
593
594 // Jump to from_interpreted entry of a call unless single stepping is possible
595 // in this thread in which case we must call the i2i entry.
596 void InterpreterMacroAssembler::jump_from_interpreted(Register method, Register temp) {
597 assert_different_registers(method, Z_R10 /*used for initial_caller_sp*/, temp);
598 prepare_to_jump_from_interpreted(method);
599
600 if (JvmtiExport::can_post_interpreter_events()) {
601 // JVMTI events, such as single-stepping, are implemented partly by avoiding running
602 // compiled code in threads for which the event is enabled. Check here for
603 // interp_only_mode if these events CAN be enabled.
604 z_lg(Z_R1_scratch, Address(method, Method::from_interpreted_offset()));
605 MacroAssembler::load_and_test_int(Z_R0_scratch, Address(Z_thread, JavaThread::interp_only_mode_offset()));
606 z_bcr(bcondEqual, Z_R1_scratch); // Run compiled code if zero.
607 // Run interpreted.
608 z_lg(Z_R1_scratch, Address(method, Method::interpreter_entry_offset()));
609 z_br(Z_R1_scratch);
610 } else {
611 // Run compiled code.
612 z_lg(Z_R1_scratch, Address(method, Method::from_interpreted_offset()));
613 z_br(Z_R1_scratch);
614 }
615 }
616
617 #ifdef ASSERT
618 void InterpreterMacroAssembler::verify_esp(Register Resp, Register Rtemp) {
619 // About to read or write Resp[0].
620 // Make sure it is not in the monitors or the TOP_IJAVA_FRAME_ABI.
621 address reentry = nullptr;
622
623 {
624 // Check if the frame pointer in Z_fp is correct.
625 NearLabel OK;
626 z_cg(Z_fp, 0, Z_SP);
627 z_bre(OK);
628 reentry = stop_chain_static(reentry, "invalid frame pointer Z_fp");
629 bind(OK);
630 }
631 {
632 // Resp must not point into or below the operand stack,
633 // i.e. IJAVA_STATE.monitors > Resp.
634 NearLabel OK;
635 Register Rmonitors = Rtemp;
636 get_monitors(Rmonitors);
637 compareU64_and_branch(Rmonitors, Resp, bcondHigh, OK);
638 reentry = stop_chain_static(reentry, "too many pops: Z_esp points into monitor area");
639 bind(OK);
640 }
641 {
642 // Resp may point to the last word of TOP_IJAVA_FRAME_ABI, but not below
643 // i.e. !(Z_SP + frame::z_top_ijava_frame_abi_size - Interpreter::stackElementSize > Resp).
644 NearLabel OK;
645 Register Rabi_bottom = Rtemp;
646 add2reg(Rabi_bottom, frame::z_top_ijava_frame_abi_size - Interpreter::stackElementSize, Z_SP);
647 compareU64_and_branch(Rabi_bottom, Resp, bcondNotHigh, OK);
648 reentry = stop_chain_static(reentry, "too many pushes: Z_esp points into TOP_IJAVA_FRAME_ABI");
649 bind(OK);
650 }
651 }
652
653 void InterpreterMacroAssembler::asm_assert_ijava_state_magic(Register tmp) {
654 Label magic_ok;
655 load_const_optimized(tmp, frame::z_istate_magic_number);
656 z_cg(tmp, Address(Z_fp, _z_ijava_state_neg(magic)));
657 z_bre(magic_ok);
658 stop_static("error: wrong magic number in ijava_state access");
659 bind(magic_ok);
660 }
661 #endif // ASSERT
662
663 void InterpreterMacroAssembler::save_bcp() {
664 z_stg(Z_bcp, Address(Z_fp, _z_ijava_state_neg(bcp)));
665 asm_assert_ijava_state_magic(Z_bcp);
666 NOT_PRODUCT(z_lg(Z_bcp, Address(Z_fp, _z_ijava_state_neg(bcp))));
667 }
668
669 void InterpreterMacroAssembler::restore_bcp() {
670 asm_assert_ijava_state_magic(Z_bcp);
671 z_lg(Z_bcp, Address(Z_fp, _z_ijava_state_neg(bcp)));
672 }
673
674 void InterpreterMacroAssembler::save_esp(Register fp) {
675 if (fp == noreg) {
676 fp = Z_fp;
677 }
678 z_sgrk(Z_R0, Z_esp, fp);
679 z_srag(Z_R0, Z_R0, Interpreter::logStackElementSize);
680 z_stg(Z_R0, Address(fp, _z_ijava_state_neg(esp)));
681 }
682
683 void InterpreterMacroAssembler::restore_esp() {
684 asm_assert_ijava_state_magic(Z_esp);
685 z_lg(Z_esp, Address(Z_fp, _z_ijava_state_neg(esp)));
686 z_slag(Z_esp, Z_esp, Interpreter::logStackElementSize);
687 z_agr(Z_esp, Z_fp);
688 }
689
690 void InterpreterMacroAssembler::get_monitors(Register reg) {
691 asm_assert_ijava_state_magic(reg);
692 #ifdef ASSERT
693 NearLabel ok;
694 z_cg(Z_fp, 0, Z_SP);
695 z_bre(ok);
696 stop("Z_fp is corrupted");
697 bind(ok);
698 #endif // ASSERT
699 mem2reg_opt(reg, Address(Z_fp, _z_ijava_state_neg(monitors)));
700 z_slag(reg, reg, Interpreter::logStackElementSize);
701 z_agr(reg, Z_fp);
702 }
703
704 void InterpreterMacroAssembler::save_monitors(Register reg) {
705 #ifdef ASSERT
706 NearLabel ok;
707 z_cg(Z_fp, 0, Z_SP);
708 z_bre(ok);
709 stop("Z_fp is corrupted");
710 bind(ok);
711 #endif // ASSERT
712 z_sgr(reg, Z_fp);
713 z_srag(reg, reg, Interpreter::logStackElementSize);
714 reg2mem_opt(reg, Address(Z_fp, _z_ijava_state_neg(monitors)));
715 }
716
717 void InterpreterMacroAssembler::get_mdp(Register mdp) {
718 z_lg(mdp, _z_ijava_state_neg(mdx), Z_fp);
719 }
720
721 void InterpreterMacroAssembler::save_mdp(Register mdp) {
722 z_stg(mdp, _z_ijava_state_neg(mdx), Z_fp);
723 }
724
725 // Values that are only read (besides initialization).
726 void InterpreterMacroAssembler::restore_locals() {
727 asm_assert_ijava_state_magic(Z_locals);
728 z_lg(Z_locals, Address(Z_fp, _z_ijava_state_neg(locals)));
729 z_sllg(Z_locals, Z_locals, Interpreter::logStackElementSize);
730 z_agr(Z_locals, Z_fp);
731 }
732
733 void InterpreterMacroAssembler::get_method(Register reg) {
734 asm_assert_ijava_state_magic(reg);
735 z_lg(reg, Address(Z_fp, _z_ijava_state_neg(method)));
736 }
737
738 void InterpreterMacroAssembler::get_2_byte_integer_at_bcp(Register Rdst, int bcp_offset,
739 signedOrNot is_signed) {
740 // Rdst is an 8-byte return value!!!
741
742 // Unaligned loads incur only a small penalty on z/Architecture. The penalty
743 // is a few (2..3) ticks, even when the load crosses a cache line
744 // boundary. In case of a cache miss, the stall could, of course, be
745 // much longer.
746
747 switch (is_signed) {
748 case Signed:
749 z_lgh(Rdst, bcp_offset, Z_R0, Z_bcp);
750 break;
751 case Unsigned:
752 z_llgh(Rdst, bcp_offset, Z_R0, Z_bcp);
753 break;
754 default:
755 ShouldNotReachHere();
756 }
757 }
758
759
760 void InterpreterMacroAssembler::get_4_byte_integer_at_bcp(Register Rdst, int bcp_offset,
761 setCCOrNot set_cc) {
762 // Rdst is an 8-byte return value!!!
763
764 // Unaligned loads incur only a small penalty on z/Architecture. The penalty
765 // is a few (2..3) ticks, even when the load crosses a cache line
766 // boundary. In case of a cache miss, the stall could, of course, be
767 // much longer.
768
769 // Both variants implement a sign-extending int2long load.
770 if (set_cc == set_CC) {
771 load_and_test_int2long(Rdst, Address(Z_bcp, (intptr_t)bcp_offset));
772 } else {
773 mem2reg_signed_opt( Rdst, Address(Z_bcp, (intptr_t)bcp_offset));
774 }
775 }
776
777 void InterpreterMacroAssembler::get_constant_pool(Register Rdst) {
778 get_method(Rdst);
779 mem2reg_opt(Rdst, Address(Rdst, Method::const_offset()));
780 mem2reg_opt(Rdst, Address(Rdst, ConstMethod::constants_offset()));
781 }
782
783 void InterpreterMacroAssembler::get_constant_pool_cache(Register Rdst) {
784 get_constant_pool(Rdst);
785 mem2reg_opt(Rdst, Address(Rdst, ConstantPool::cache_offset()));
786 }
787
788 void InterpreterMacroAssembler::get_cpool_and_tags(Register Rcpool, Register Rtags) {
789 get_constant_pool(Rcpool);
790 mem2reg_opt(Rtags, Address(Rcpool, ConstantPool::tags_offset()));
791 }
792
793 // Unlock if synchronized method.
794 //
795 // Unlock the receiver if this is a synchronized method.
796 // Unlock any Java monitors from synchronized blocks.
797 //
798 // If there are locked Java monitors
799 // If throw_monitor_exception
800 // throws IllegalMonitorStateException
801 // Else if install_monitor_exception
802 // installs IllegalMonitorStateException
803 // Else
804 // no error processing
805 void InterpreterMacroAssembler::unlock_if_synchronized_method(TosState state,
806 bool throw_monitor_exception,
807 bool install_monitor_exception) {
808 NearLabel unlocked, unlock, no_unlock;
809
810 {
811 Register R_method = Z_ARG2;
812 Register R_do_not_unlock_if_synchronized = Z_ARG3;
813
814 // Get the value of _do_not_unlock_if_synchronized into G1_scratch.
815 const Address do_not_unlock_if_synchronized(Z_thread,
816 JavaThread::do_not_unlock_if_synchronized_offset());
817 load_sized_value(R_do_not_unlock_if_synchronized, do_not_unlock_if_synchronized, 1, false /*unsigned*/);
818 z_mvi(do_not_unlock_if_synchronized, false); // Reset the flag.
819
820 // Check if synchronized method.
821 get_method(R_method);
822 verify_oop(Z_tos, state);
823 push(state); // Save tos/result.
824 testbit_ushort(method2_(R_method, access_flags), JVM_ACC_SYNCHRONIZED_BIT);
825 z_bfalse(unlocked);
826
827 // Don't unlock anything if the _do_not_unlock_if_synchronized flag
828 // is set.
829 compareU64_and_branch(R_do_not_unlock_if_synchronized, (intptr_t)0L, bcondNotEqual, no_unlock);
830 }
831
832 // unlock monitor
833
834 // BasicObjectLock will be first in list, since this is a
835 // synchronized method. However, need to check that the object has
836 // not been unlocked by an explicit monitorexit bytecode.
837 const Address monitor(Z_fp, -(frame::z_ijava_state_size + (int) sizeof(BasicObjectLock)));
838 // We use Z_ARG2 so that if we go slow path it will be the correct
839 // register for unlock_object to pass to VM directly.
840 load_address(Z_ARG2, monitor); // Address of first monitor.
841 z_lg(Z_ARG3, Address(Z_ARG2, BasicObjectLock::obj_offset()));
842 compareU64_and_branch(Z_ARG3, (intptr_t)0L, bcondNotEqual, unlock);
843
844 if (throw_monitor_exception) {
845 // Entry already unlocked need to throw an exception.
846 MacroAssembler::call_VM(noreg, CAST_FROM_FN_PTR(address, InterpreterRuntime::throw_illegal_monitor_state_exception));
847 should_not_reach_here();
848 } else {
849 // Monitor already unlocked during a stack unroll.
850 // If requested, install an illegal_monitor_state_exception.
851 // Continue with stack unrolling.
852 if (install_monitor_exception) {
853 MacroAssembler::call_VM(noreg, CAST_FROM_FN_PTR(address, InterpreterRuntime::new_illegal_monitor_state_exception));
854 }
855 z_bru(unlocked);
856 }
857
858 bind(unlock);
859
860 unlock_object(Z_ARG2);
861
862 bind(unlocked);
863
864 // I0, I1: Might contain return value
865
866 // Check that all monitors are unlocked.
867 {
868 NearLabel loop, exception, entry, restart;
869 const int entry_size = frame::interpreter_frame_monitor_size_in_bytes();
870 // We use Z_ARG2 so that if we go slow path it will be the correct
871 // register for unlock_object to pass to VM directly.
872 Register R_current_monitor = Z_ARG2;
873 Register R_monitor_block_bot = Z_ARG1;
874 const Address monitor_block_bot(Z_fp, -frame::z_ijava_state_size);
875
876 bind(restart);
877 // Starting with top-most entry.
878 get_monitors(R_current_monitor);
879 // Points to word before bottom of monitor block.
880 load_address(R_monitor_block_bot, monitor_block_bot);
881 z_bru(entry);
882
883 // Entry already locked, need to throw exception.
884 bind(exception);
885
886 if (throw_monitor_exception) {
887 // Throw exception.
888 MacroAssembler::call_VM(noreg,
889 CAST_FROM_FN_PTR(address, InterpreterRuntime::
890 throw_illegal_monitor_state_exception));
891 should_not_reach_here();
892 } else {
893 // Stack unrolling. Unlock object and install illegal_monitor_exception.
894 // Unlock does not block, so don't have to worry about the frame.
895 // We don't have to preserve c_rarg1 since we are going to throw an exception.
896 unlock_object(R_current_monitor);
897 if (install_monitor_exception) {
898 call_VM(noreg, CAST_FROM_FN_PTR(address,
899 InterpreterRuntime::
900 new_illegal_monitor_state_exception));
901 }
902 z_bru(restart);
903 }
904
905 bind(loop);
906 // Check if current entry is used.
907 load_and_test_long(Z_R0_scratch, Address(R_current_monitor, BasicObjectLock::obj_offset()));
908 z_brne(exception);
909
910 add2reg(R_current_monitor, entry_size); // Otherwise advance to next entry.
911 bind(entry);
912 compareU64_and_branch(R_current_monitor, R_monitor_block_bot, bcondNotEqual, loop);
913 }
914
915 bind(no_unlock);
916 pop(state);
917 verify_oop(Z_tos, state);
918 }
919
920 void InterpreterMacroAssembler::narrow(Register result, Register ret_type) {
921 get_method(ret_type);
922 z_lg(ret_type, Address(ret_type, in_bytes(Method::const_offset())));
923 z_lb(ret_type, Address(ret_type, in_bytes(ConstMethod::result_type_offset())));
924
925 Label notBool, notByte, notChar, done;
926
927 // common case first
928 compareU32_and_branch(ret_type, T_INT, bcondEqual, done);
929
930 compareU32_and_branch(ret_type, T_BOOLEAN, bcondNotEqual, notBool);
931 z_nilf(result, 0x1);
932 z_bru(done);
933
934 bind(notBool);
935 compareU32_and_branch(ret_type, T_BYTE, bcondNotEqual, notByte);
936 z_lbr(result, result);
937 z_bru(done);
938
939 bind(notByte);
940 compareU32_and_branch(ret_type, T_CHAR, bcondNotEqual, notChar);
941 z_nilf(result, 0xffff);
942 z_bru(done);
943
944 bind(notChar);
945 // compareU32_and_branch(ret_type, T_SHORT, bcondNotEqual, notShort);
946 z_lhr(result, result);
947
948 // Nothing to do for T_INT
949 bind(done);
950 }
951
952 // remove activation
953 //
954 // Unlock the receiver if this is a synchronized method.
955 // Unlock any Java monitors from synchronized blocks.
956 // Remove the activation from the stack.
957 //
958 // If there are locked Java monitors
959 // If throw_monitor_exception
960 // throws IllegalMonitorStateException
961 // Else if install_monitor_exception
962 // installs IllegalMonitorStateException
963 // Else
964 // no error processing
965 void InterpreterMacroAssembler::remove_activation(TosState state,
966 Register return_pc,
967 bool throw_monitor_exception,
968 bool install_monitor_exception,
969 bool notify_jvmti) {
970 BLOCK_COMMENT("remove_activation {");
971 unlock_if_synchronized_method(state, throw_monitor_exception, install_monitor_exception);
972
973 // Save result (push state before jvmti call and pop it afterwards) and notify jvmti.
974 notify_method_exit(false, state, notify_jvmti ? NotifyJVMTI : SkipNotifyJVMTI);
975
976 if (StackReservedPages > 0) {
977 BLOCK_COMMENT("reserved_stack_check:");
978 // Test if reserved zone needs to be enabled.
979 Label no_reserved_zone_enabling;
980
981 // check if already enabled - if so no re-enabling needed
982 assert(sizeof(StackOverflow::StackGuardState) == 4, "unexpected size");
983 z_ly(Z_R0, Address(Z_thread, JavaThread::stack_guard_state_offset()));
984 compare32_and_branch(Z_R0, StackOverflow::stack_guard_enabled, bcondEqual, no_reserved_zone_enabling);
985
986 // Compare frame pointers. There is no good stack pointer, as with stack
987 // frame compression we can get different SPs when we do calls. A subsequent
988 // call could have a smaller SP, so that this compare succeeds for an
989 // inner call of the method annotated with ReservedStack.
990 z_lg(Z_R0, Address(Z_SP, (intptr_t)_z_abi(callers_sp)));
991 z_clg(Z_R0, Address(Z_thread, JavaThread::reserved_stack_activation_offset())); // Compare with frame pointer in memory.
992 z_brl(no_reserved_zone_enabling);
993
994 // Enable reserved zone again, throw stack overflow exception.
995 call_VM_leaf(CAST_FROM_FN_PTR(address, SharedRuntime::enable_stack_reserved_zone), Z_thread);
996 call_VM(noreg, CAST_FROM_FN_PTR(address, InterpreterRuntime::throw_delayed_StackOverflowError));
997
998 should_not_reach_here();
999
1000 bind(no_reserved_zone_enabling);
1001 }
1002
1003 verify_oop(Z_tos, state);
1004
1005 pop_interpreter_frame(return_pc, Z_ARG2, Z_ARG3);
1006 BLOCK_COMMENT("} remove_activation");
1007 }
1008
1009 // lock object
1010 //
1011 // Registers alive
1012 // monitor (Z_R10) - Address of the BasicObjectLock to be used for locking,
1013 // which must be initialized with the object to lock.
1014 // object (Z_R11, Z_R2) - Address of the object to be locked.
1015 // templateTable (monitorenter) is using Z_R2 for object
1016 void InterpreterMacroAssembler::lock_object(Register monitor, Register object) {
1017 const Register header = Z_ARG5;
1018 const Register tmp = Z_R1_scratch;
1019
1020 NearLabel done, slow_case;
1021
1022 fast_lock(monitor, object, header, tmp, slow_case);
1023 z_bru(done);
1024
1025 bind(slow_case);
1026 call_VM(noreg,
1027 CAST_FROM_FN_PTR(address, InterpreterRuntime::monitorenter),
1028 monitor);
1029 bind(done);
1030 }
1031
1032 // Unlocks an object. Used in monitorexit bytecode and remove_activation.
1033 //
1034 // Registers alive
1035 // monitor - address of the BasicObjectLock to be used for locking,
1036 // which must be initialized with the object to lock.
1037 //
1038 // Throw IllegalMonitorException if object is not locked by current thread.
1039 void InterpreterMacroAssembler::unlock_object(Register monitor, Register object) {
1040 const Register header = Z_ARG4;
1041 const Register current_header = Z_R1_scratch;
1042 Address obj_entry(monitor, BasicObjectLock::obj_offset());
1043 Label done, slow_case;
1044
1045 if (object == noreg) {
1046 // In the template interpreter, we must assure that the object
1047 // entry in the monitor is cleared on all paths. Thus we move
1048 // loading up to here, and clear the entry afterwards.
1049 object = Z_ARG3; // Use Z_ARG3 if caller didn't pass object.
1050 z_lg(object, obj_entry);
1051 }
1052
1053 assert_different_registers(monitor, object, header, current_header);
1054
1055 clear_mem(obj_entry, sizeof(oop));
1056
1057 fast_unlock(object, header, current_header, slow_case);
1058 z_bru(done);
1059
1060 // The lock has been converted into a heavy lock and hence
1061 // we need to get into the slow case.
1062 bind(slow_case);
1063 z_stg(object, obj_entry); // Restore object entry, has been cleared above.
1064 call_VM_leaf(CAST_FROM_FN_PTR(address, InterpreterRuntime::monitorexit), monitor);
1065 bind(done);
1066 }
1067
1068 void InterpreterMacroAssembler::test_method_data_pointer(Register mdp, Label& zero_continue) {
1069 assert(ProfileInterpreter, "must be profiling interpreter");
1070 load_and_test_long(mdp, Address(Z_fp, _z_ijava_state_neg(mdx)));
1071 z_brz(zero_continue);
1072 }
1073
1074 // Set the method data pointer for the current bcp.
1075 void InterpreterMacroAssembler::set_method_data_pointer_for_bcp() {
1076 assert(ProfileInterpreter, "must be profiling interpreter");
1077 Label set_mdp;
1078 Register mdp = Z_ARG4;
1079 Register method = Z_ARG5;
1080
1081 get_method(method);
1082 // Test MDO to avoid the call if it is null.
1083 load_and_test_long(mdp, method2_(method, method_data));
1084 z_brz(set_mdp);
1085
1086 call_VM_leaf(CAST_FROM_FN_PTR(address, InterpreterRuntime::bcp_to_di), method, Z_bcp);
1087 // Z_RET: mdi
1088 // Mdo is guaranteed to be non-zero here, we checked for it before the call.
1089 assert(method->is_nonvolatile(), "choose nonvolatile reg or reload from frame");
1090 z_lg(mdp, method2_(method, method_data)); // Must reload, mdp is volatile reg.
1091 add2reg_with_index(mdp, in_bytes(MethodData::data_offset()), Z_RET, mdp);
1092
1093 bind(set_mdp);
1094 save_mdp(mdp);
1095 }
1096
1097 void InterpreterMacroAssembler::verify_method_data_pointer() {
1098 assert(ProfileInterpreter, "must be profiling interpreter");
1099 #ifdef ASSERT
1100 NearLabel verify_continue;
1101 Register bcp_expected = Z_ARG3;
1102 Register mdp = Z_ARG4;
1103 Register method = Z_ARG5;
1104
1105 test_method_data_pointer(mdp, verify_continue); // If mdp is zero, continue
1106 get_method(method);
1107
1108 // If the mdp is valid, it will point to a DataLayout header which is
1109 // consistent with the bcp. The converse is highly probable also.
1110 load_sized_value(bcp_expected, Address(mdp, DataLayout::bci_offset()), 2, false /*signed*/);
1111 z_ag(bcp_expected, Address(method, Method::const_offset()));
1112 load_address(bcp_expected, Address(bcp_expected, ConstMethod::codes_offset()));
1113 compareU64_and_branch(bcp_expected, Z_bcp, bcondEqual, verify_continue);
1114 call_VM_leaf(CAST_FROM_FN_PTR(address, InterpreterRuntime::verify_mdp), method, Z_bcp, mdp);
1115 bind(verify_continue);
1116 #endif // ASSERT
1117 }
1118
1119 void InterpreterMacroAssembler::set_mdp_data_at(Register mdp_in, int constant, Register value) {
1120 assert(ProfileInterpreter, "must be profiling interpreter");
1121 z_stg(value, constant, mdp_in);
1122 }
1123
1124 void InterpreterMacroAssembler::increment_mdp_data_at(Register mdp_in,
1125 int constant,
1126 Register tmp,
1127 bool decrement) {
1128 assert_different_registers(mdp_in, tmp);
1129 // counter address
1130 Address data(mdp_in, constant);
1131 const int delta = decrement ? -DataLayout::counter_increment : DataLayout::counter_increment;
1132 add2mem_64(Address(mdp_in, constant), delta, tmp);
1133 }
1134
1135 void InterpreterMacroAssembler::set_mdp_flag_at(Register mdp_in,
1136 int flag_byte_constant) {
1137 assert(ProfileInterpreter, "must be profiling interpreter");
1138 // Set the flag.
1139 z_oi(Address(mdp_in, DataLayout::flags_offset()), flag_byte_constant);
1140 }
1141
1142 void InterpreterMacroAssembler::test_mdp_data_at(Register mdp_in,
1143 int offset,
1144 Register value,
1145 Register test_value_out,
1146 Label& not_equal_continue) {
1147 assert(ProfileInterpreter, "must be profiling interpreter");
1148 if (test_value_out == noreg) {
1149 z_cg(value, Address(mdp_in, offset));
1150 z_brne(not_equal_continue);
1151 } else {
1152 // Put the test value into a register, so caller can use it:
1153 z_lg(test_value_out, Address(mdp_in, offset));
1154 compareU64_and_branch(test_value_out, value, bcondNotEqual, not_equal_continue);
1155 }
1156 }
1157
1158 void InterpreterMacroAssembler::update_mdp_by_offset(Register mdp_in, int offset_of_disp) {
1159 update_mdp_by_offset(mdp_in, noreg, offset_of_disp);
1160 }
1161
1162 void InterpreterMacroAssembler::update_mdp_by_offset(Register mdp_in,
1163 Register dataidx,
1164 int offset_of_disp) {
1165 assert(ProfileInterpreter, "must be profiling interpreter");
1166 Address disp_address(mdp_in, dataidx, offset_of_disp);
1167 Assembler::z_ag(mdp_in, disp_address);
1168 save_mdp(mdp_in);
1169 }
1170
1171 void InterpreterMacroAssembler::update_mdp_by_constant(Register mdp_in, int constant) {
1172 assert(ProfileInterpreter, "must be profiling interpreter");
1173 add2reg(mdp_in, constant);
1174 save_mdp(mdp_in);
1175 }
1176
1177 void InterpreterMacroAssembler::update_mdp_for_ret(Register return_bci) {
1178 assert(ProfileInterpreter, "must be profiling interpreter");
1179 assert(return_bci->is_nonvolatile(), "choose nonvolatile reg or save/restore");
1180 call_VM(noreg,
1181 CAST_FROM_FN_PTR(address, InterpreterRuntime::update_mdp_for_ret),
1182 return_bci);
1183 }
1184
1185 void InterpreterMacroAssembler::profile_taken_branch(Register mdp, Register bumped_count) {
1186 if (ProfileInterpreter) {
1187 Label profile_continue;
1188
1189 // If no method data exists, go to profile_continue.
1190 // Otherwise, assign to mdp.
1191 test_method_data_pointer(mdp, profile_continue);
1192
1193 // We are taking a branch. Increment the taken count.
1194 // We inline increment_mdp_data_at to return bumped_count in a register
1195 //increment_mdp_data_at(mdp, in_bytes(JumpData::taken_offset()));
1196 Address data(mdp, JumpData::taken_offset());
1197 z_lg(bumped_count, data);
1198 // 64-bit overflow is very unlikely. Saturation to 32-bit values is
1199 // performed when reading the counts.
1200 add2reg(bumped_count, DataLayout::counter_increment);
1201 z_stg(bumped_count, data); // Store back out
1202
1203 // The method data pointer needs to be updated to reflect the new target.
1204 update_mdp_by_offset(mdp, in_bytes(JumpData::displacement_offset()));
1205 bind(profile_continue);
1206 }
1207 }
1208
1209 // Kills Z_R1_scratch.
1210 void InterpreterMacroAssembler::profile_not_taken_branch(Register mdp) {
1211 if (ProfileInterpreter) {
1212 Label profile_continue;
1213
1214 // If no method data exists, go to profile_continue.
1215 test_method_data_pointer(mdp, profile_continue);
1216
1217 // We are taking a branch. Increment the not taken count.
1218 increment_mdp_data_at(mdp, in_bytes(BranchData::not_taken_offset()), Z_R1_scratch);
1219
1220 // The method data pointer needs to be updated to correspond to
1221 // the next bytecode.
1222 update_mdp_by_constant(mdp, in_bytes(BranchData::branch_data_size()));
1223 bind(profile_continue);
1224 }
1225 }
1226
1227 // Kills: Z_R1_scratch.
1228 void InterpreterMacroAssembler::profile_call(Register mdp) {
1229 if (ProfileInterpreter) {
1230 Label profile_continue;
1231
1232 // If no method data exists, go to profile_continue.
1233 test_method_data_pointer(mdp, profile_continue);
1234
1235 // We are making a call. Increment the count.
1236 increment_mdp_data_at(mdp, in_bytes(CounterData::count_offset()));
1237
1238 // The method data pointer needs to be updated to reflect the new target.
1239 update_mdp_by_constant(mdp, in_bytes(CounterData::counter_data_size()));
1240 bind(profile_continue);
1241 }
1242 }
1243
1244 void InterpreterMacroAssembler::profile_final_call(Register mdp) {
1245 if (ProfileInterpreter) {
1246 Label profile_continue;
1247
1248 // If no method data exists, go to profile_continue.
1249 test_method_data_pointer(mdp, profile_continue);
1250
1251 // We are making a call. Increment the count.
1252 increment_mdp_data_at(mdp, in_bytes(CounterData::count_offset()));
1253
1254 // The method data pointer needs to be updated to reflect the new target.
1255 update_mdp_by_constant(mdp, in_bytes(VirtualCallData::virtual_call_data_size()));
1256 bind(profile_continue);
1257 }
1258 }
1259
1260 void InterpreterMacroAssembler::profile_virtual_call(Register receiver,
1261 Register mdp,
1262 Register reg2) {
1263 if (ProfileInterpreter) {
1264 NearLabel profile_continue;
1265
1266 // If no method data exists, go to profile_continue.
1267 test_method_data_pointer(mdp, profile_continue);
1268
1269 // Record the receiver type.
1270 record_klass_in_profile(receiver, mdp, reg2);
1271
1272 // The method data pointer needs to be updated to reflect the new target.
1273 update_mdp_by_constant(mdp, in_bytes(VirtualCallData::virtual_call_data_size()));
1274 bind(profile_continue);
1275 }
1276 }
1277
1278 // This routine creates a state machine for updating the multi-row
1279 // type profile at a virtual call site (or other type-sensitive bytecode).
1280 // The machine visits each row (of receiver/count) until the receiver type
1281 // is found, or until it runs out of rows. At the same time, it remembers
1282 // the location of the first empty row. (An empty row records null for its
1283 // receiver, and can be allocated for a newly-observed receiver type.)
1284 // Because there are two degrees of freedom in the state, a simple linear
1285 // search will not work; it must be a decision tree. Hence this helper
1286 // function is recursive, to generate the required tree structured code.
1287 // It's the interpreter, so we are trading off code space for speed.
1288 // See below for example code.
1289 void InterpreterMacroAssembler::record_klass_in_profile_helper(
1290 Register receiver, Register mdp,
1291 Register reg2, int start_row,
1292 Label& done) {
1293 if (TypeProfileWidth == 0) {
1294 increment_mdp_data_at(mdp, in_bytes(CounterData::count_offset()));
1295 return;
1296 }
1297
1298 int last_row = VirtualCallData::row_limit() - 1;
1299 assert(start_row <= last_row, "must be work left to do");
1300 // Test this row for both the receiver and for null.
1301 // Take any of three different outcomes:
1302 // 1. found receiver => increment count and goto done
1303 // 2. found null => keep looking for case 1, maybe allocate this cell
1304 // 3. found something else => keep looking for cases 1 and 2
1305 // Case 3 is handled by a recursive call.
1306 for (int row = start_row; row <= last_row; row++) {
1307 NearLabel next_test;
1308 bool test_for_null_also = (row == start_row);
1309
1310 // See if the receiver is receiver[n].
1311 int recvr_offset = in_bytes(VirtualCallData::receiver_offset(row));
1312 test_mdp_data_at(mdp, recvr_offset, receiver,
1313 (test_for_null_also ? reg2 : noreg),
1314 next_test);
1315 // (Reg2 now contains the receiver from the CallData.)
1316
1317 // The receiver is receiver[n]. Increment count[n].
1318 int count_offset = in_bytes(VirtualCallData::receiver_count_offset(row));
1319 increment_mdp_data_at(mdp, count_offset);
1320 z_bru(done);
1321 bind(next_test);
1322
1323 if (test_for_null_also) {
1324 Label found_null;
1325 // Failed the equality check on receiver[n]... Test for null.
1326 z_ltgr(reg2, reg2);
1327 if (start_row == last_row) {
1328 // The only thing left to do is handle the null case.
1329 z_brz(found_null);
1330 // Receiver did not match any saved receiver and there is no empty row for it.
1331 // Increment total counter to indicate polymorphic case.
1332 increment_mdp_data_at(mdp, in_bytes(CounterData::count_offset()));
1333 z_bru(done);
1334 bind(found_null);
1335 break;
1336 }
1337 // Since null is rare, make it be the branch-taken case.
1338 z_brz(found_null);
1339
1340 // Put all the "Case 3" tests here.
1341 record_klass_in_profile_helper(receiver, mdp, reg2, start_row + 1, done);
1342
1343 // Found a null. Keep searching for a matching receiver,
1344 // but remember that this is an empty (unused) slot.
1345 bind(found_null);
1346 }
1347 }
1348
1349 // In the fall-through case, we found no matching receiver, but we
1350 // observed the receiver[start_row] is null.
1351
1352 // Fill in the receiver field and increment the count.
1353 int recvr_offset = in_bytes(VirtualCallData::receiver_offset(start_row));
1354 set_mdp_data_at(mdp, recvr_offset, receiver);
1355 int count_offset = in_bytes(VirtualCallData::receiver_count_offset(start_row));
1356 load_const_optimized(reg2, DataLayout::counter_increment);
1357 set_mdp_data_at(mdp, count_offset, reg2);
1358 if (start_row > 0) {
1359 z_bru(done);
1360 }
1361 }
1362
1363 // Example state machine code for three profile rows:
1364 // // main copy of decision tree, rooted at row[1]
1365 // if (row[0].rec == rec) { row[0].incr(); goto done; }
1366 // if (row[0].rec != nullptr) {
1367 // // inner copy of decision tree, rooted at row[1]
1368 // if (row[1].rec == rec) { row[1].incr(); goto done; }
1369 // if (row[1].rec != nullptr) {
1370 // // degenerate decision tree, rooted at row[2]
1371 // if (row[2].rec == rec) { row[2].incr(); goto done; }
1372 // if (row[2].rec != nullptr) { count.incr(); goto done; } // overflow
1373 // row[2].init(rec); goto done;
1374 // } else {
1375 // // remember row[1] is empty
1376 // if (row[2].rec == rec) { row[2].incr(); goto done; }
1377 // row[1].init(rec); goto done;
1378 // }
1379 // } else {
1380 // // remember row[0] is empty
1381 // if (row[1].rec == rec) { row[1].incr(); goto done; }
1382 // if (row[2].rec == rec) { row[2].incr(); goto done; }
1383 // row[0].init(rec); goto done;
1384 // }
1385 // done:
1386
1387 void InterpreterMacroAssembler::record_klass_in_profile(Register receiver,
1388 Register mdp, Register reg2) {
1389 assert(ProfileInterpreter, "must be profiling");
1390 Label done;
1391
1392 record_klass_in_profile_helper(receiver, mdp, reg2, 0, done);
1393
1394 bind (done);
1395 }
1396
1397 void InterpreterMacroAssembler::profile_ret(Register return_bci, Register mdp) {
1398 if (ProfileInterpreter) {
1399 NearLabel profile_continue;
1400 uint row;
1401
1402 // If no method data exists, go to profile_continue.
1403 test_method_data_pointer(mdp, profile_continue);
1404
1405 // Update the total ret count.
1406 increment_mdp_data_at(mdp, in_bytes(CounterData::count_offset()));
1407
1408 for (row = 0; row < RetData::row_limit(); row++) {
1409 NearLabel next_test;
1410
1411 // See if return_bci is equal to bci[n]:
1412 test_mdp_data_at(mdp,
1413 in_bytes(RetData::bci_offset(row)),
1414 return_bci, noreg,
1415 next_test);
1416
1417 // Return_bci is equal to bci[n]. Increment the count.
1418 increment_mdp_data_at(mdp, in_bytes(RetData::bci_count_offset(row)));
1419
1420 // The method data pointer needs to be updated to reflect the new target.
1421 update_mdp_by_offset(mdp, in_bytes(RetData::bci_displacement_offset(row)));
1422 z_bru(profile_continue);
1423 bind(next_test);
1424 }
1425
1426 update_mdp_for_ret(return_bci);
1427
1428 bind(profile_continue);
1429 }
1430 }
1431
1432 void InterpreterMacroAssembler::profile_null_seen(Register mdp) {
1433 if (ProfileInterpreter) {
1434 Label profile_continue;
1435
1436 // If no method data exists, go to profile_continue.
1437 test_method_data_pointer(mdp, profile_continue);
1438
1439 set_mdp_flag_at(mdp, BitData::null_seen_byte_constant());
1440
1441 // The method data pointer needs to be updated.
1442 int mdp_delta = in_bytes(BitData::bit_data_size());
1443 if (TypeProfileCasts) {
1444 mdp_delta = in_bytes(VirtualCallData::virtual_call_data_size());
1445 }
1446 update_mdp_by_constant(mdp, mdp_delta);
1447
1448 bind(profile_continue);
1449 }
1450 }
1451
1452 void InterpreterMacroAssembler::profile_typecheck(Register mdp, Register klass, Register reg2) {
1453 if (ProfileInterpreter) {
1454 Label profile_continue;
1455
1456 // If no method data exists, go to profile_continue.
1457 test_method_data_pointer(mdp, profile_continue);
1458
1459 // The method data pointer needs to be updated.
1460 int mdp_delta = in_bytes(BitData::bit_data_size());
1461 if (TypeProfileCasts) {
1462 mdp_delta = in_bytes(VirtualCallData::virtual_call_data_size());
1463
1464 // Record the object type.
1465 record_klass_in_profile(klass, mdp, reg2);
1466 }
1467 update_mdp_by_constant(mdp, mdp_delta);
1468
1469 bind(profile_continue);
1470 }
1471 }
1472
1473 void InterpreterMacroAssembler::profile_switch_default(Register mdp) {
1474 if (ProfileInterpreter) {
1475 Label profile_continue;
1476
1477 // If no method data exists, go to profile_continue.
1478 test_method_data_pointer(mdp, profile_continue);
1479
1480 // Update the default case count.
1481 increment_mdp_data_at(mdp, in_bytes(MultiBranchData::default_count_offset()));
1482
1483 // The method data pointer needs to be updated.
1484 update_mdp_by_offset(mdp, in_bytes(MultiBranchData::default_displacement_offset()));
1485
1486 bind(profile_continue);
1487 }
1488 }
1489
1490 // Kills: index, scratch1, scratch2.
1491 void InterpreterMacroAssembler::profile_switch_case(Register index,
1492 Register mdp,
1493 Register scratch1,
1494 Register scratch2) {
1495 if (ProfileInterpreter) {
1496 Label profile_continue;
1497 assert_different_registers(index, mdp, scratch1, scratch2);
1498
1499 // If no method data exists, go to profile_continue.
1500 test_method_data_pointer(mdp, profile_continue);
1501
1502 // Build the base (index * per_case_size_in_bytes()) +
1503 // case_array_offset_in_bytes().
1504 z_sllg(index, index, exact_log2(in_bytes(MultiBranchData::per_case_size())));
1505 add2reg(index, in_bytes(MultiBranchData::case_array_offset()));
1506
1507 // Add the calculated base to the mdp -> address of the case' data.
1508 Address case_data_addr(mdp, index);
1509 Register case_data = scratch1;
1510 load_address(case_data, case_data_addr);
1511
1512 // Update the case count.
1513 increment_mdp_data_at(case_data,
1514 in_bytes(MultiBranchData::relative_count_offset()),
1515 scratch2);
1516
1517 // The method data pointer needs to be updated.
1518 update_mdp_by_offset(mdp,
1519 index,
1520 in_bytes(MultiBranchData::relative_displacement_offset()));
1521
1522 bind(profile_continue);
1523 }
1524 }
1525
1526 // kills: R0, R1, flags, loads klass from obj (if not null)
1527 void InterpreterMacroAssembler::profile_obj_type(Register obj, Address mdo_addr, Register klass, bool cmp_done) {
1528 NearLabel null_seen, init_klass, do_nothing, do_update;
1529
1530 // Klass = obj is allowed.
1531 const Register tmp = Z_R1;
1532 assert_different_registers(obj, mdo_addr.base(), tmp, Z_R0);
1533 assert_different_registers(klass, mdo_addr.base(), tmp, Z_R0);
1534
1535 z_lg(tmp, mdo_addr);
1536 if (cmp_done) {
1537 z_brz(null_seen);
1538 } else {
1539 compareU64_and_branch(obj, (intptr_t)0, Assembler::bcondEqual, null_seen);
1540 }
1541
1542 MacroAssembler::verify_oop(obj, FILE_AND_LINE);
1543 load_klass(klass, obj);
1544
1545 // Klass seen before, nothing to do (regardless of unknown bit).
1546 z_lgr(Z_R0, tmp);
1547 assert(Immediate::is_uimm(~TypeEntries::type_klass_mask, 16), "or change following instruction");
1548 z_nill(Z_R0, TypeEntries::type_klass_mask & 0xFFFF);
1549 compareU64_and_branch(Z_R0, klass, Assembler::bcondEqual, do_nothing);
1550
1551 // Already unknown. Nothing to do anymore.
1552 z_tmll(tmp, TypeEntries::type_unknown);
1553 z_brc(Assembler::bcondAllOne, do_nothing);
1554
1555 z_lgr(Z_R0, tmp);
1556 assert(Immediate::is_uimm(~TypeEntries::type_mask, 16), "or change following instruction");
1557 z_nill(Z_R0, TypeEntries::type_mask & 0xFFFF);
1558 compareU64_and_branch(Z_R0, (intptr_t)0, Assembler::bcondEqual, init_klass);
1559
1560 // Different than before. Cannot keep accurate profile.
1561 z_oill(tmp, TypeEntries::type_unknown);
1562 z_bru(do_update);
1563
1564 bind(init_klass);
1565 // Combine klass and null_seen bit (only used if (tmp & type_mask)==0).
1566 z_ogr(tmp, klass);
1567 z_bru(do_update);
1568
1569 bind(null_seen);
1570 // Set null_seen if obj is 0.
1571 z_oill(tmp, TypeEntries::null_seen);
1572 // fallthru: z_bru(do_update);
1573
1574 bind(do_update);
1575 z_stg(tmp, mdo_addr);
1576
1577 bind(do_nothing);
1578 }
1579
1580 void InterpreterMacroAssembler::profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual) {
1581 if (!ProfileInterpreter) {
1582 return;
1583 }
1584
1585 assert_different_registers(mdp, callee, tmp);
1586
1587 if (MethodData::profile_arguments() || MethodData::profile_return()) {
1588 Label profile_continue;
1589
1590 test_method_data_pointer(mdp, profile_continue);
1591
1592 int off_to_start = is_virtual ? in_bytes(VirtualCallData::virtual_call_data_size()) : in_bytes(CounterData::counter_data_size());
1593
1594 z_cliy(in_bytes(DataLayout::tag_offset()) - off_to_start, mdp,
1595 is_virtual ? DataLayout::virtual_call_type_data_tag : DataLayout::call_type_data_tag);
1596 z_brne(profile_continue);
1597
1598 if (MethodData::profile_arguments()) {
1599 NearLabel done;
1600 int off_to_args = in_bytes(TypeEntriesAtCall::args_data_offset());
1601 add2reg(mdp, off_to_args);
1602
1603 for (int i = 0; i < TypeProfileArgsLimit; i++) {
1604 if (i > 0 || MethodData::profile_return()) {
1605 // If return value type is profiled we may have no argument to profile.
1606 z_lg(tmp, in_bytes(TypeEntriesAtCall::cell_count_offset())-off_to_args, mdp);
1607 add2reg(tmp, -i*TypeStackSlotEntries::per_arg_count());
1608 compare64_and_branch(tmp, TypeStackSlotEntries::per_arg_count(), Assembler::bcondLow, done);
1609 }
1610 z_lg(tmp, Address(callee, Method::const_offset()));
1611 z_lgh(tmp, Address(tmp, ConstMethod::size_of_parameters_offset()));
1612 // Stack offset o (zero based) from the start of the argument
1613 // list. For n arguments translates into offset n - o - 1 from
1614 // the end of the argument list. But there is an extra slot at
1615 // the top of the stack. So the offset is n - o from Lesp.
1616 z_sg(tmp, Address(mdp, in_bytes(TypeEntriesAtCall::stack_slot_offset(i))-off_to_args));
1617 z_sllg(tmp, tmp, Interpreter::logStackElementSize);
1618 Address stack_slot_addr(tmp, Z_esp);
1619 z_ltg(tmp, stack_slot_addr);
1620
1621 Address mdo_arg_addr(mdp, in_bytes(TypeEntriesAtCall::argument_type_offset(i))-off_to_args);
1622 profile_obj_type(tmp, mdo_arg_addr, tmp, /*ltg did compare to 0*/ true);
1623
1624 int to_add = in_bytes(TypeStackSlotEntries::per_arg_size());
1625 add2reg(mdp, to_add);
1626 off_to_args += to_add;
1627 }
1628
1629 if (MethodData::profile_return()) {
1630 z_lg(tmp, in_bytes(TypeEntriesAtCall::cell_count_offset())-off_to_args, mdp);
1631 add2reg(tmp, -TypeProfileArgsLimit*TypeStackSlotEntries::per_arg_count());
1632 }
1633
1634 bind(done);
1635
1636 if (MethodData::profile_return()) {
1637 // We're right after the type profile for the last
1638 // argument. Tmp is the number of cells left in the
1639 // CallTypeData/VirtualCallTypeData to reach its end. Non null
1640 // if there's a return to profile.
1641 assert(SingleTypeEntry::static_cell_count() < TypeStackSlotEntries::per_arg_count(), "can't move past ret type");
1642 z_sllg(tmp, tmp, exact_log2(DataLayout::cell_size));
1643 z_agr(mdp, tmp);
1644 }
1645 z_stg(mdp, _z_ijava_state_neg(mdx), Z_fp);
1646 } else {
1647 assert(MethodData::profile_return(), "either profile call args or call ret");
1648 update_mdp_by_constant(mdp, in_bytes(TypeEntriesAtCall::return_only_size()));
1649 }
1650
1651 // Mdp points right after the end of the
1652 // CallTypeData/VirtualCallTypeData, right after the cells for the
1653 // return value type if there's one.
1654 bind(profile_continue);
1655 }
1656 }
1657
1658 void InterpreterMacroAssembler::profile_return_type(Register mdp, Register ret, Register tmp) {
1659 assert_different_registers(mdp, ret, tmp);
1660 if (ProfileInterpreter && MethodData::profile_return()) {
1661 Label profile_continue;
1662
1663 test_method_data_pointer(mdp, profile_continue);
1664
1665 if (MethodData::profile_return_jsr292_only()) {
1666 // If we don't profile all invoke bytecodes we must make sure
1667 // it's a bytecode we indeed profile. We can't go back to the
1668 // beginning of the ProfileData we intend to update to check its
1669 // type because we're right after it and we don't known its
1670 // length.
1671 NearLabel do_profile;
1672 Address bc(Z_bcp);
1673 z_lb(tmp, bc);
1674 compare32_and_branch(tmp, Bytecodes::_invokedynamic, Assembler::bcondEqual, do_profile);
1675 compare32_and_branch(tmp, Bytecodes::_invokehandle, Assembler::bcondEqual, do_profile);
1676 get_method(tmp);
1677 // Supplement to 8139891: _intrinsic_id exceeded 1-byte size limit.
1678 if (Method::intrinsic_id_size_in_bytes() == 1) {
1679 z_cli(in_bytes(Method::intrinsic_id_offset()), tmp, static_cast<int>(vmIntrinsics::_compiledLambdaForm));
1680 } else {
1681 assert(Method::intrinsic_id_size_in_bytes() == 2, "size error: check Method::_intrinsic_id");
1682 z_lh(tmp, in_bytes(Method::intrinsic_id_offset()), Z_R0, tmp);
1683 z_chi(tmp, static_cast<int>(vmIntrinsics::_compiledLambdaForm));
1684 }
1685 z_brne(profile_continue);
1686
1687 bind(do_profile);
1688 }
1689
1690 Address mdo_ret_addr(mdp, -in_bytes(SingleTypeEntry::size()));
1691 profile_obj_type(ret, mdo_ret_addr, tmp);
1692
1693 bind(profile_continue);
1694 }
1695 }
1696
1697 void InterpreterMacroAssembler::profile_parameters_type(Register mdp, Register tmp1, Register tmp2) {
1698 if (ProfileInterpreter && MethodData::profile_parameters()) {
1699 Label profile_continue, done;
1700
1701 test_method_data_pointer(mdp, profile_continue);
1702
1703 // Load the offset of the area within the MDO used for
1704 // parameters. If it's negative we're not profiling any parameters.
1705 Address parm_di_addr(mdp, in_bytes(MethodData::parameters_type_data_di_offset()) - in_bytes(MethodData::data_offset()));
1706 load_and_test_int2long(tmp1, parm_di_addr);
1707 z_brl(profile_continue);
1708
1709 // Compute a pointer to the area for parameters from the offset
1710 // and move the pointer to the slot for the last
1711 // parameters. Collect profiling from last parameter down.
1712 // mdo start + parameters offset + array length - 1
1713
1714 // Pointer to the parameter area in the MDO.
1715 z_agr(mdp, tmp1);
1716
1717 // Offset of the current profile entry to update.
1718 const Register entry_offset = tmp1;
1719 // entry_offset = array len in number of cells.
1720 z_lg(entry_offset, Address(mdp, ArrayData::array_len_offset()));
1721 // entry_offset (number of cells) = array len - size of 1 entry
1722 add2reg(entry_offset, -TypeStackSlotEntries::per_arg_count());
1723 // entry_offset in bytes
1724 z_sllg(entry_offset, entry_offset, exact_log2(DataLayout::cell_size));
1725
1726 Label loop;
1727 bind(loop);
1728
1729 Address arg_off(mdp, entry_offset, ParametersTypeData::stack_slot_offset(0));
1730 Address arg_type(mdp, entry_offset, ParametersTypeData::type_offset(0));
1731
1732 // Load offset on the stack from the slot for this parameter.
1733 z_lg(tmp2, arg_off);
1734 z_sllg(tmp2, tmp2, Interpreter::logStackElementSize);
1735 z_lcgr(tmp2); // Negate.
1736
1737 // Profile the parameter.
1738 z_ltg(tmp2, Address(Z_locals, tmp2));
1739 profile_obj_type(tmp2, arg_type, tmp2, /*ltg did compare to 0*/ true);
1740
1741 // Go to next parameter.
1742 z_aghi(entry_offset, -TypeStackSlotEntries::per_arg_count() * DataLayout::cell_size);
1743 z_brnl(loop);
1744
1745 bind(profile_continue);
1746 }
1747 }
1748
1749 // Jump if ((*counter_addr += increment) & mask) satisfies the condition.
1750 void InterpreterMacroAssembler::increment_mask_and_jump(Address counter_addr,
1751 int increment,
1752 Address mask,
1753 Register scratch,
1754 bool preloaded,
1755 branch_condition cond,
1756 Label *where) {
1757 assert_different_registers(counter_addr.base(), scratch);
1758 if (preloaded) {
1759 add2reg(scratch, increment);
1760 reg2mem_opt(scratch, counter_addr, false);
1761 } else {
1762 if (VM_Version::has_MemWithImmALUOps() && Immediate::is_simm8(increment) && counter_addr.is_RSYform()) {
1763 z_alsi(counter_addr.disp20(), counter_addr.base(), increment);
1764 mem2reg_signed_opt(scratch, counter_addr);
1765 } else {
1766 mem2reg_signed_opt(scratch, counter_addr);
1767 add2reg(scratch, increment);
1768 reg2mem_opt(scratch, counter_addr, false);
1769 }
1770 }
1771 z_n(scratch, mask);
1772 if (where) { z_brc(cond, *where); }
1773 }
1774
1775 // Get MethodCounters object for given method. Lazily allocated if necessary.
1776 // method - Ptr to Method object.
1777 // Rcounters - Ptr to MethodCounters object associated with Method object.
1778 // skip - Exit point if MethodCounters object can't be created (OOM condition).
1779 void InterpreterMacroAssembler::get_method_counters(Register Rmethod,
1780 Register Rcounters,
1781 Label& skip) {
1782 assert_different_registers(Rmethod, Rcounters);
1783
1784 BLOCK_COMMENT("get MethodCounters object {");
1785
1786 Label has_counters;
1787 load_and_test_long(Rcounters, Address(Rmethod, Method::method_counters_offset()));
1788 z_brnz(has_counters);
1789
1790 call_VM(noreg, CAST_FROM_FN_PTR(address, InterpreterRuntime::build_method_counters), Rmethod);
1791 z_ltgr(Rcounters, Z_RET); // Runtime call returns MethodCounters object.
1792 z_brz(skip); // No MethodCounters, out of memory.
1793
1794 bind(has_counters);
1795
1796 BLOCK_COMMENT("} get MethodCounters object");
1797 }
1798
1799 // Increment invocation counter in MethodCounters object.
1800 // Return (invocation_counter+backedge_counter) as "result" in RctrSum.
1801 // Counter values are all unsigned.
1802 void InterpreterMacroAssembler::increment_invocation_counter(Register Rcounters, Register RctrSum) {
1803 assert(UseCompiler, "incrementing must be useful");
1804 assert_different_registers(Rcounters, RctrSum);
1805
1806 int increment = InvocationCounter::count_increment;
1807 int inv_counter_offset = in_bytes(MethodCounters::invocation_counter_offset() + InvocationCounter::counter_offset());
1808 int be_counter_offset = in_bytes(MethodCounters::backedge_counter_offset() + InvocationCounter::counter_offset());
1809
1810 BLOCK_COMMENT("Increment invocation counter {");
1811
1812 if (VM_Version::has_MemWithImmALUOps() && Immediate::is_simm8(increment)) {
1813 // Increment the invocation counter in place,
1814 // then add the incremented value to the backedge counter.
1815 z_l(RctrSum, be_counter_offset, Rcounters);
1816 z_alsi(inv_counter_offset, Rcounters, increment); // Atomic increment @no extra cost!
1817 z_nilf(RctrSum, InvocationCounter::count_mask_value); // Mask off state bits.
1818 z_al(RctrSum, inv_counter_offset, Z_R0, Rcounters);
1819 } else {
1820 // This path is optimized for low register consumption
1821 // at the cost of somewhat higher operand delays.
1822 // It does not need an extra temp register.
1823
1824 // Update the invocation counter.
1825 z_l(RctrSum, inv_counter_offset, Rcounters);
1826 if (RctrSum == Z_R0) {
1827 z_ahi(RctrSum, increment);
1828 } else {
1829 add2reg(RctrSum, increment);
1830 }
1831 z_st(RctrSum, inv_counter_offset, Rcounters);
1832
1833 // Mask off the state bits.
1834 z_nilf(RctrSum, InvocationCounter::count_mask_value);
1835
1836 // Add the backedge counter to the updated invocation counter to
1837 // form the result.
1838 z_al(RctrSum, be_counter_offset, Z_R0, Rcounters);
1839 }
1840
1841 BLOCK_COMMENT("} Increment invocation counter");
1842
1843 // Note that this macro must leave the backedge_count + invocation_count in Rtmp!
1844 }
1845
1846
1847 // increment backedge counter in MethodCounters object.
1848 // return (invocation_counter+backedge_counter) as "result" in RctrSum
1849 // counter values are all unsigned!
1850 void InterpreterMacroAssembler::increment_backedge_counter(Register Rcounters, Register RctrSum) {
1851 assert(UseCompiler, "incrementing must be useful");
1852 assert_different_registers(Rcounters, RctrSum);
1853
1854 int increment = InvocationCounter::count_increment;
1855 int inv_counter_offset = in_bytes(MethodCounters::invocation_counter_offset() + InvocationCounter::counter_offset());
1856 int be_counter_offset = in_bytes(MethodCounters::backedge_counter_offset() + InvocationCounter::counter_offset());
1857
1858 BLOCK_COMMENT("Increment backedge counter {");
1859
1860 if (VM_Version::has_MemWithImmALUOps() && Immediate::is_simm8(increment)) {
1861 // Increment the invocation counter in place,
1862 // then add the incremented value to the backedge counter.
1863 z_l(RctrSum, inv_counter_offset, Rcounters);
1864 z_alsi(be_counter_offset, Rcounters, increment); // Atomic increment @no extra cost!
1865 z_nilf(RctrSum, InvocationCounter::count_mask_value); // Mask off state bits.
1866 z_al(RctrSum, be_counter_offset, Z_R0, Rcounters);
1867 } else {
1868 // This path is optimized for low register consumption
1869 // at the cost of somewhat higher operand delays.
1870 // It does not need an extra temp register.
1871
1872 // Update the invocation counter.
1873 z_l(RctrSum, be_counter_offset, Rcounters);
1874 if (RctrSum == Z_R0) {
1875 z_ahi(RctrSum, increment);
1876 } else {
1877 add2reg(RctrSum, increment);
1878 }
1879 z_st(RctrSum, be_counter_offset, Rcounters);
1880
1881 // Mask off the state bits.
1882 z_nilf(RctrSum, InvocationCounter::count_mask_value);
1883
1884 // Add the backedge counter to the updated invocation counter to
1885 // form the result.
1886 z_al(RctrSum, inv_counter_offset, Z_R0, Rcounters);
1887 }
1888
1889 BLOCK_COMMENT("} Increment backedge counter");
1890
1891 // Note that this macro must leave the backedge_count + invocation_count in Rtmp!
1892 }
1893
1894 // Add an InterpMonitorElem to stack (see frame_s390.hpp).
1895 void InterpreterMacroAssembler::add_monitor_to_stack(bool stack_is_empty,
1896 Register Rtemp1,
1897 Register Rtemp2,
1898 Register Rtemp3) {
1899
1900 const Register Rcurr_slot = Rtemp1;
1901 const Register Rlimit = Rtemp2;
1902 const jint delta = -frame::interpreter_frame_monitor_size_in_bytes();
1903
1904 assert((delta & LongAlignmentMask) == 0,
1905 "sizeof BasicObjectLock must be even number of doublewords");
1906 assert(2 * wordSize == -delta, "this works only as long as delta == -2*wordSize");
1907 assert(Rcurr_slot != Z_R0, "Register must be usable as base register");
1908 assert_different_registers(Rlimit, Rcurr_slot, Rtemp3);
1909
1910 get_monitors(Rlimit);
1911
1912 // Adjust stack pointer for additional monitor entry.
1913 resize_frame(RegisterOrConstant((intptr_t) delta), Z_fp, false);
1914
1915 // Rtemp3 is free at this point, use it to store top_frame_sp
1916 z_sgrk(Rtemp3, Z_SP, Z_fp);
1917 z_srag(Rtemp3, Rtemp3, Interpreter::logStackElementSize);
1918 reg2mem_opt(Rtemp3, Address(Z_fp, _z_ijava_state_neg(top_frame_sp)));
1919
1920 if (!stack_is_empty) {
1921 // Must copy stack contents down.
1922 NearLabel next, done;
1923
1924 // Rtemp := addr(Tos), Z_esp is pointing below it!
1925 add2reg(Rcurr_slot, wordSize, Z_esp);
1926
1927 // Nothing to do, if already at monitor area.
1928 compareU64_and_branch(Rcurr_slot, Rlimit, bcondNotLow, done);
1929
1930 bind(next);
1931
1932 // Move one stack slot.
1933 mem2reg_opt(Rtemp3, Address(Rcurr_slot));
1934 reg2mem_opt(Rtemp3, Address(Rcurr_slot, delta));
1935 add2reg(Rcurr_slot, wordSize);
1936 compareU64_and_branch(Rcurr_slot, Rlimit, bcondLow, next); // Are we done?
1937
1938 bind(done);
1939 // Done copying stack.
1940 }
1941
1942 // Adjust expression stack and monitor pointers.
1943 add2reg(Z_esp, delta);
1944 add2reg(Rlimit, delta);
1945 save_monitors(Rlimit);
1946 }
1947
1948 // Note: Index holds the offset in bytes afterwards.
1949 // You can use this to store a new value (with Llocals as the base).
1950 void InterpreterMacroAssembler::access_local_int(Register index, Register dst) {
1951 z_sllg(index, index, LogBytesPerWord);
1952 mem2reg_opt(dst, Address(Z_locals, index), false);
1953 }
1954
1955 void InterpreterMacroAssembler::verify_oop(Register reg, TosState state) {
1956 if (state == atos) { MacroAssembler::verify_oop(reg, FILE_AND_LINE); }
1957 }
1958
1959 // Inline assembly for:
1960 //
1961 // if (thread is in interp_only_mode) {
1962 // InterpreterRuntime::post_method_entry();
1963 // }
1964
1965 void InterpreterMacroAssembler::notify_method_entry() {
1966
1967 // JVMTI
1968 // Whenever JVMTI puts a thread in interp_only_mode, method
1969 // entry/exit events are sent for that thread to track stack
1970 // depth. If it is possible to enter interp_only_mode we add
1971 // the code to check if the event should be sent.
1972 if (JvmtiExport::can_post_interpreter_events()) {
1973 Label jvmti_post_done;
1974 MacroAssembler::load_and_test_int(Z_R0, Address(Z_thread, JavaThread::interp_only_mode_offset()));
1975 z_bre(jvmti_post_done);
1976 call_VM(noreg, CAST_FROM_FN_PTR(address, InterpreterRuntime::post_method_entry));
1977 bind(jvmti_post_done);
1978 }
1979 }
1980
1981 // Inline assembly for:
1982 //
1983 // if (thread is in interp_only_mode) {
1984 // if (!native_method) save result
1985 // InterpreterRuntime::post_method_exit();
1986 // if (!native_method) restore result
1987 // }
1988 // if (DTraceMethodProbes) {
1989 // SharedRuntime::dtrace_method_exit(thread, method);
1990 // }
1991 //
1992 // For native methods their result is stored in z_ijava_state.lresult
1993 // and z_ijava_state.fresult before coming here.
1994 // Java methods have their result stored in the expression stack.
1995 //
1996 // Notice the dependency to frame::interpreter_frame_result().
1997 void InterpreterMacroAssembler::notify_method_exit(bool native_method,
1998 TosState state,
1999 NotifyMethodExitMode mode) {
2000 // JVMTI
2001 // Whenever JVMTI puts a thread in interp_only_mode, method
2002 // entry/exit events are sent for that thread to track stack
2003 // depth. If it is possible to enter interp_only_mode we add
2004 // the code to check if the event should be sent.
2005 if (mode == NotifyJVMTI && JvmtiExport::can_post_interpreter_events()) {
2006 Label jvmti_post_done;
2007 MacroAssembler::load_and_test_int(Z_R0, Address(Z_thread, JavaThread::interp_only_mode_offset()));
2008 z_bre(jvmti_post_done);
2009 if (!native_method) push(state); // see frame::interpreter_frame_result()
2010 call_VM(noreg, CAST_FROM_FN_PTR(address, InterpreterRuntime::post_method_exit));
2011 if (!native_method) pop(state);
2012 bind(jvmti_post_done);
2013 }
2014 }
2015
2016 void InterpreterMacroAssembler::skip_if_jvmti_mode(Label &Lskip, Register Rscratch) {
2017 if (!JvmtiExport::can_post_interpreter_events()) {
2018 return;
2019 }
2020
2021 load_and_test_int(Rscratch, Address(Z_thread, JavaThread::interp_only_mode_offset()));
2022 z_brnz(Lskip);
2023
2024 }
2025
2026 // Pop the topmost TOP_IJAVA_FRAME and set it's sender_sp as new Z_SP.
2027 // The return pc is loaded into the register return_pc.
2028 //
2029 // Registers updated:
2030 // return_pc - The return pc of the calling frame.
2031 // tmp1, tmp2 - scratch
2032 void InterpreterMacroAssembler::pop_interpreter_frame(Register return_pc, Register tmp1, Register tmp2) {
2033 // F0 Z_SP -> caller_sp (F1's)
2034 // ...
2035 // sender_sp (F1's)
2036 // ...
2037 // F1 Z_fp -> caller_sp (F2's)
2038 // return_pc (Continuation after return from F0.)
2039 // ...
2040 // F2 caller_sp
2041
2042 // Remove F0's activation. Restoring Z_SP to sender_sp reverts modifications
2043 // (a) by a c2i adapter and (b) by generate_fixed_frame().
2044 // In case (a) the new top frame F1 is an unextended compiled frame.
2045 // In case (b) F1 is converted from PARENT_IJAVA_FRAME to TOP_IJAVA_FRAME.
2046
2047 // Case (b) seems to be redundant when returning to a interpreted caller,
2048 // because then the caller's top_frame_sp is installed as sp (see
2049 // TemplateInterpreterGenerator::generate_return_entry_for ()). But
2050 // pop_interpreter_frame() is also used in exception handling and there the
2051 // frame type of the caller is unknown, therefore top_frame_sp cannot be used,
2052 // so it is important that sender_sp is the caller's sp as TOP_IJAVA_FRAME.
2053
2054 Register R_f1_sender_sp = tmp1;
2055 Register R_f2_sp = tmp2;
2056
2057 // First check for the interpreter frame's magic.
2058 asm_assert_ijava_state_magic(R_f2_sp/*tmp*/);
2059 z_lg(R_f2_sp, _z_parent_ijava_frame_abi(callers_sp), Z_fp);
2060 z_lg(R_f1_sender_sp, _z_ijava_state_neg(sender_sp), Z_fp);
2061 if (return_pc->is_valid())
2062 z_lg(return_pc, _z_parent_ijava_frame_abi(return_pc), Z_fp);
2063 // Pop F0 by resizing to R_f1_sender_sp and using R_f2_sp as fp.
2064 resize_frame_absolute(R_f1_sender_sp, R_f2_sp, false/*load fp*/);
2065
2066 #ifdef ASSERT
2067 // The return_pc in the new top frame is dead... at least that's my
2068 // current understanding; to assert this I overwrite it.
2069 load_const_optimized(Z_ARG3, 0xb00b1);
2070 z_stg(Z_ARG3, _z_parent_ijava_frame_abi(return_pc), Z_SP);
2071 #endif
2072 }