jdk/src/hotspot/cpu/s390/macroAssembler_s390.cpp
Fredrik Bredberg 119108c0d4 8373595: A new ObjectMonitorTable implementation
Co-authored-by: Anton Artemov <aartemov@openjdk.org>
Co-authored-by: Erik Österlund <eosterlund@openjdk.org>
Co-authored-by: Roman Kennke <rkennke@openjdk.org>
Reviewed-by: aboldtch, amitkumar, aartemov, rkennke, coleenp, eosterlund
2026-02-25 09:24:44 +00:00

6787 lines
251 KiB
C++

/*
* Copyright (c) 2016, 2026, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2016, 2024 SAP SE. All rights reserved.
* Copyright 2024 IBM Corporation. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*
*/
#include "asm/codeBuffer.hpp"
#include "asm/macroAssembler.inline.hpp"
#include "code/compiledIC.hpp"
#include "compiler/disassembler.hpp"
#include "gc/shared/barrierSet.hpp"
#include "gc/shared/barrierSetAssembler.hpp"
#include "gc/shared/collectedHeap.inline.hpp"
#include "interpreter/interpreter.hpp"
#include "gc/shared/cardTableBarrierSet.hpp"
#include "memory/resourceArea.hpp"
#include "memory/universe.hpp"
#include "oops/accessDecorators.hpp"
#include "oops/compressedKlass.inline.hpp"
#include "oops/compressedOops.inline.hpp"
#include "oops/klass.inline.hpp"
#include "prims/methodHandles.hpp"
#include "registerSaver_s390.hpp"
#include "runtime/icache.hpp"
#include "runtime/interfaceSupport.inline.hpp"
#include "runtime/objectMonitor.hpp"
#include "runtime/objectMonitorTable.hpp"
#include "runtime/os.hpp"
#include "runtime/safepoint.hpp"
#include "runtime/safepointMechanism.hpp"
#include "runtime/sharedRuntime.hpp"
#include "runtime/stubRoutines.hpp"
#include "utilities/events.hpp"
#include "utilities/macros.hpp"
#include "utilities/powerOfTwo.hpp"
#include <ucontext.h>
#define BLOCK_COMMENT(str) block_comment(str)
#define BIND(label) bind(label); BLOCK_COMMENT(#label ":")
// Move 32-bit register if destination and source are different.
void MacroAssembler::lr_if_needed(Register rd, Register rs) {
if (rs != rd) { z_lr(rd, rs); }
}
// Move register if destination and source are different.
void MacroAssembler::lgr_if_needed(Register rd, Register rs) {
if (rs != rd) { z_lgr(rd, rs); }
}
// Zero-extend 32-bit register into 64-bit register if destination and source are different.
void MacroAssembler::llgfr_if_needed(Register rd, Register rs) {
if (rs != rd) { z_llgfr(rd, rs); }
}
// Move float register if destination and source are different.
void MacroAssembler::ldr_if_needed(FloatRegister rd, FloatRegister rs) {
if (rs != rd) { z_ldr(rd, rs); }
}
// Move integer register if destination and source are different.
// It is assumed that shorter-than-int types are already
// appropriately sign-extended.
void MacroAssembler::move_reg_if_needed(Register dst, BasicType dst_type, Register src,
BasicType src_type) {
assert((dst_type != T_FLOAT) && (dst_type != T_DOUBLE), "use move_freg for float types");
assert((src_type != T_FLOAT) && (src_type != T_DOUBLE), "use move_freg for float types");
if (dst_type == src_type) {
lgr_if_needed(dst, src); // Just move all 64 bits.
return;
}
switch (dst_type) {
// Do not support these types for now.
// case T_BOOLEAN:
case T_BYTE: // signed byte
switch (src_type) {
case T_INT:
z_lgbr(dst, src);
break;
default:
ShouldNotReachHere();
}
return;
case T_CHAR:
case T_SHORT:
switch (src_type) {
case T_INT:
if (dst_type == T_CHAR) {
z_llghr(dst, src);
} else {
z_lghr(dst, src);
}
break;
default:
ShouldNotReachHere();
}
return;
case T_INT:
switch (src_type) {
case T_BOOLEAN:
case T_BYTE:
case T_CHAR:
case T_SHORT:
case T_INT:
case T_LONG:
case T_OBJECT:
case T_ARRAY:
case T_VOID:
case T_ADDRESS:
lr_if_needed(dst, src);
// llgfr_if_needed(dst, src); // zero-extend (in case we need to find a bug).
return;
default:
assert(false, "non-integer src type");
return;
}
case T_LONG:
switch (src_type) {
case T_BOOLEAN:
case T_BYTE:
case T_CHAR:
case T_SHORT:
case T_INT:
z_lgfr(dst, src); // sign extension
return;
case T_LONG:
case T_OBJECT:
case T_ARRAY:
case T_VOID:
case T_ADDRESS:
lgr_if_needed(dst, src);
return;
default:
assert(false, "non-integer src type");
return;
}
return;
case T_OBJECT:
case T_ARRAY:
case T_VOID:
case T_ADDRESS:
switch (src_type) {
// These types don't make sense to be converted to pointers:
// case T_BOOLEAN:
// case T_BYTE:
// case T_CHAR:
// case T_SHORT:
case T_INT:
z_llgfr(dst, src); // zero extension
return;
case T_LONG:
case T_OBJECT:
case T_ARRAY:
case T_VOID:
case T_ADDRESS:
lgr_if_needed(dst, src);
return;
default:
assert(false, "non-integer src type");
return;
}
return;
default:
assert(false, "non-integer dst type");
return;
}
}
// Move float register if destination and source are different.
void MacroAssembler::move_freg_if_needed(FloatRegister dst, BasicType dst_type,
FloatRegister src, BasicType src_type) {
assert((dst_type == T_FLOAT) || (dst_type == T_DOUBLE), "use move_reg for int types");
assert((src_type == T_FLOAT) || (src_type == T_DOUBLE), "use move_reg for int types");
if (dst_type == src_type) {
ldr_if_needed(dst, src); // Just move all 64 bits.
} else {
switch (dst_type) {
case T_FLOAT:
assert(src_type == T_DOUBLE, "invalid float type combination");
z_ledbr(dst, src);
return;
case T_DOUBLE:
assert(src_type == T_FLOAT, "invalid float type combination");
z_ldebr(dst, src);
return;
default:
assert(false, "non-float dst type");
return;
}
}
}
// Optimized emitter for reg to mem operations.
// Uses modern instructions if running on modern hardware, classic instructions
// otherwise. Prefers (usually shorter) classic instructions if applicable.
// Data register (reg) cannot be used as work register.
//
// Don't rely on register locking, instead pass a scratch register (Z_R0 by default).
// CAUTION! Passing registers >= Z_R2 may produce bad results on old CPUs!
void MacroAssembler::freg2mem_opt(FloatRegister reg,
int64_t disp,
Register index,
Register base,
void (MacroAssembler::*modern) (FloatRegister, int64_t, Register, Register),
void (MacroAssembler::*classic)(FloatRegister, int64_t, Register, Register),
Register scratch) {
index = (index == noreg) ? Z_R0 : index;
if (Displacement::is_shortDisp(disp)) {
(this->*classic)(reg, disp, index, base);
} else {
if (Displacement::is_validDisp(disp)) {
(this->*modern)(reg, disp, index, base);
} else {
if (scratch != Z_R0 && scratch != Z_R1) {
(this->*modern)(reg, disp, index, base); // Will fail with disp out of range.
} else {
if (scratch != Z_R0) { // scratch == Z_R1
if ((scratch == index) || (index == base)) {
(this->*modern)(reg, disp, index, base); // Will fail with disp out of range.
} else {
add2reg(scratch, disp, base);
(this->*classic)(reg, 0, index, scratch);
if (base == scratch) {
add2reg(base, -disp); // Restore base.
}
}
} else { // scratch == Z_R0
z_lgr(scratch, base);
add2reg(base, disp);
(this->*classic)(reg, 0, index, base);
z_lgr(base, scratch); // Restore base.
}
}
}
}
}
void MacroAssembler::freg2mem_opt(FloatRegister reg, const Address &a, bool is_double) {
if (is_double) {
freg2mem_opt(reg, a.disp20(), a.indexOrR0(), a.baseOrR0(), MODERN_FFUN(z_stdy), CLASSIC_FFUN(z_std));
} else {
freg2mem_opt(reg, a.disp20(), a.indexOrR0(), a.baseOrR0(), MODERN_FFUN(z_stey), CLASSIC_FFUN(z_ste));
}
}
// Optimized emitter for mem to reg operations.
// Uses modern instructions if running on modern hardware, classic instructions
// otherwise. Prefers (usually shorter) classic instructions if applicable.
// data register (reg) cannot be used as work register.
//
// Don't rely on register locking, instead pass a scratch register (Z_R0 by default).
// CAUTION! Passing registers >= Z_R2 may produce bad results on old CPUs!
void MacroAssembler::mem2freg_opt(FloatRegister reg,
int64_t disp,
Register index,
Register base,
void (MacroAssembler::*modern) (FloatRegister, int64_t, Register, Register),
void (MacroAssembler::*classic)(FloatRegister, int64_t, Register, Register),
Register scratch) {
index = (index == noreg) ? Z_R0 : index;
if (Displacement::is_shortDisp(disp)) {
(this->*classic)(reg, disp, index, base);
} else {
if (Displacement::is_validDisp(disp)) {
(this->*modern)(reg, disp, index, base);
} else {
if (scratch != Z_R0 && scratch != Z_R1) {
(this->*modern)(reg, disp, index, base); // Will fail with disp out of range.
} else {
if (scratch != Z_R0) { // scratch == Z_R1
if ((scratch == index) || (index == base)) {
(this->*modern)(reg, disp, index, base); // Will fail with disp out of range.
} else {
add2reg(scratch, disp, base);
(this->*classic)(reg, 0, index, scratch);
if (base == scratch) {
add2reg(base, -disp); // Restore base.
}
}
} else { // scratch == Z_R0
z_lgr(scratch, base);
add2reg(base, disp);
(this->*classic)(reg, 0, index, base);
z_lgr(base, scratch); // Restore base.
}
}
}
}
}
void MacroAssembler::mem2freg_opt(FloatRegister reg, const Address &a, bool is_double) {
if (is_double) {
mem2freg_opt(reg, a.disp20(), a.indexOrR0(), a.baseOrR0(), MODERN_FFUN(z_ldy), CLASSIC_FFUN(z_ld));
} else {
mem2freg_opt(reg, a.disp20(), a.indexOrR0(), a.baseOrR0(), MODERN_FFUN(z_ley), CLASSIC_FFUN(z_le));
}
}
// Optimized emitter for reg to mem operations.
// Uses modern instructions if running on modern hardware, classic instructions
// otherwise. Prefers (usually shorter) classic instructions if applicable.
// Data register (reg) cannot be used as work register.
//
// Don't rely on register locking, instead pass a scratch register
// (Z_R0 by default)
// CAUTION! passing registers >= Z_R2 may produce bad results on old CPUs!
void MacroAssembler::reg2mem_opt(Register reg,
int64_t disp,
Register index,
Register base,
void (MacroAssembler::*modern) (Register, int64_t, Register, Register),
void (MacroAssembler::*classic)(Register, int64_t, Register, Register),
Register scratch) {
index = (index == noreg) ? Z_R0 : index;
if (Displacement::is_shortDisp(disp)) {
(this->*classic)(reg, disp, index, base);
} else {
if (Displacement::is_validDisp(disp)) {
(this->*modern)(reg, disp, index, base);
} else {
if (scratch != Z_R0 && scratch != Z_R1) {
(this->*modern)(reg, disp, index, base); // Will fail with disp out of range.
} else {
if (scratch != Z_R0) { // scratch == Z_R1
if ((scratch == index) || (index == base)) {
(this->*modern)(reg, disp, index, base); // Will fail with disp out of range.
} else {
add2reg(scratch, disp, base);
(this->*classic)(reg, 0, index, scratch);
if (base == scratch) {
add2reg(base, -disp); // Restore base.
}
}
} else { // scratch == Z_R0
if ((scratch == reg) || (scratch == base) || (reg == base)) {
(this->*modern)(reg, disp, index, base); // Will fail with disp out of range.
} else {
z_lgr(scratch, base);
add2reg(base, disp);
(this->*classic)(reg, 0, index, base);
z_lgr(base, scratch); // Restore base.
}
}
}
}
}
}
int MacroAssembler::reg2mem_opt(Register reg, const Address &a, bool is_double) {
int store_offset = offset();
if (is_double) {
reg2mem_opt(reg, a.disp20(), a.indexOrR0(), a.baseOrR0(), MODERN_IFUN(z_stg), CLASSIC_IFUN(z_stg));
} else {
reg2mem_opt(reg, a.disp20(), a.indexOrR0(), a.baseOrR0(), MODERN_IFUN(z_sty), CLASSIC_IFUN(z_st));
}
return store_offset;
}
// Optimized emitter for mem to reg operations.
// Uses modern instructions if running on modern hardware, classic instructions
// otherwise. Prefers (usually shorter) classic instructions if applicable.
// Data register (reg) will be used as work register where possible.
void MacroAssembler::mem2reg_opt(Register reg,
int64_t disp,
Register index,
Register base,
void (MacroAssembler::*modern) (Register, int64_t, Register, Register),
void (MacroAssembler::*classic)(Register, int64_t, Register, Register)) {
index = (index == noreg) ? Z_R0 : index;
if (Displacement::is_shortDisp(disp)) {
(this->*classic)(reg, disp, index, base);
} else {
if (Displacement::is_validDisp(disp)) {
(this->*modern)(reg, disp, index, base);
} else {
if ((reg == index) && (reg == base)) {
z_sllg(reg, reg, 1);
add2reg(reg, disp);
(this->*classic)(reg, 0, noreg, reg);
} else if ((reg == index) && (reg != Z_R0)) {
add2reg(reg, disp);
(this->*classic)(reg, 0, reg, base);
} else if (reg == base) {
add2reg(reg, disp);
(this->*classic)(reg, 0, index, reg);
} else if (reg != Z_R0) {
add2reg(reg, disp, base);
(this->*classic)(reg, 0, index, reg);
} else { // reg == Z_R0 && reg != base here
add2reg(base, disp);
(this->*classic)(reg, 0, index, base);
add2reg(base, -disp);
}
}
}
}
void MacroAssembler::mem2reg_opt(Register reg, const Address &a, bool is_double) {
if (is_double) {
z_lg(reg, a);
} else {
mem2reg_opt(reg, a.disp20(), a.indexOrR0(), a.baseOrR0(), MODERN_IFUN(z_ly), CLASSIC_IFUN(z_l));
}
}
void MacroAssembler::mem2reg_signed_opt(Register reg, const Address &a) {
mem2reg_opt(reg, a.disp20(), a.indexOrR0(), a.baseOrR0(), MODERN_IFUN(z_lgf), CLASSIC_IFUN(z_lgf));
}
void MacroAssembler::and_imm(Register r, long mask,
Register tmp /* = Z_R0 */,
bool wide /* = false */) {
assert(wide || Immediate::is_simm32(mask), "mask value too large");
if (!wide) {
z_nilf(r, mask);
return;
}
assert(r != tmp, " need a different temporary register !");
load_const_optimized(tmp, mask);
z_ngr(r, tmp);
}
// Calculate the 1's complement.
// Note: The condition code is neither preserved nor correctly set by this code!!!
// Note: (wide == false) does not protect the high order half of the target register
// from alteration. It only serves as optimization hint for 32-bit results.
void MacroAssembler::not_(Register r1, Register r2, bool wide) {
if ((r2 == noreg) || (r2 == r1)) { // Calc 1's complement in place.
z_xilf(r1, -1);
if (wide) {
z_xihf(r1, -1);
}
} else { // Distinct src and dst registers.
load_const_optimized(r1, -1);
z_xgr(r1, r2);
}
}
unsigned long MacroAssembler::create_mask(int lBitPos, int rBitPos) {
assert(lBitPos >= 0, "zero is leftmost bit position");
assert(rBitPos <= 63, "63 is rightmost bit position");
assert(lBitPos <= rBitPos, "inverted selection interval");
return (lBitPos == 0 ? (unsigned long)(-1L) : ((1UL<<(63-lBitPos+1))-1)) & (~((1UL<<(63-rBitPos))-1));
}
// Helper function for the "Rotate_then_<logicalOP>" emitters.
// Rotate src, then mask register contents such that only bits in range survive.
// For oneBits == false, all bits not in range are set to 0. Useful for deleting all bits outside range.
// For oneBits == true, all bits not in range are set to 1. Useful for preserving all bits outside range.
// The caller must ensure that the selected range only contains bits with defined value.
void MacroAssembler::rotate_then_mask(Register dst, Register src, int lBitPos, int rBitPos,
int nRotate, bool src32bit, bool dst32bit, bool oneBits) {
assert(!(dst32bit && lBitPos < 32), "selection interval out of range for int destination");
bool sll4rll = (nRotate >= 0) && (nRotate <= (63-rBitPos)); // Substitute SLL(G) for RLL(G).
bool srl4rll = (nRotate < 0) && (-nRotate <= lBitPos); // Substitute SRL(G) for RLL(G).
// Pre-determine which parts of dst will be zero after shift/rotate.
bool llZero = sll4rll && (nRotate >= 16);
bool lhZero = (sll4rll && (nRotate >= 32)) || (srl4rll && (nRotate <= -48));
bool lfZero = llZero && lhZero;
bool hlZero = (sll4rll && (nRotate >= 48)) || (srl4rll && (nRotate <= -32));
bool hhZero = (srl4rll && (nRotate <= -16));
bool hfZero = hlZero && hhZero;
// rotate then mask src operand.
// if oneBits == true, all bits outside selected range are 1s.
// if oneBits == false, all bits outside selected range are 0s.
if (src32bit) { // There might be garbage in the upper 32 bits which will get masked away.
if (dst32bit) {
z_rll(dst, src, nRotate); // Copy and rotate, upper half of reg remains undisturbed.
} else {
if (sll4rll) { z_sllg(dst, src, nRotate); }
else if (srl4rll) { z_srlg(dst, src, -nRotate); }
else { z_rllg(dst, src, nRotate); }
}
} else {
if (sll4rll) { z_sllg(dst, src, nRotate); }
else if (srl4rll) { z_srlg(dst, src, -nRotate); }
else { z_rllg(dst, src, nRotate); }
}
unsigned long range_mask = create_mask(lBitPos, rBitPos);
unsigned int range_mask_h = (unsigned int)(range_mask >> 32);
unsigned int range_mask_l = (unsigned int)range_mask;
unsigned short range_mask_hh = (unsigned short)(range_mask >> 48);
unsigned short range_mask_hl = (unsigned short)(range_mask >> 32);
unsigned short range_mask_lh = (unsigned short)(range_mask >> 16);
unsigned short range_mask_ll = (unsigned short)range_mask;
// Works for z9 and newer H/W.
if (oneBits) {
if ((~range_mask_l) != 0) { z_oilf(dst, ~range_mask_l); } // All bits outside range become 1s.
if (((~range_mask_h) != 0) && !dst32bit) { z_oihf(dst, ~range_mask_h); }
} else {
// All bits outside range become 0s
if (((~range_mask_l) != 0) && !lfZero) {
z_nilf(dst, range_mask_l);
}
if (((~range_mask_h) != 0) && !dst32bit && !hfZero) {
z_nihf(dst, range_mask_h);
}
}
}
// Rotate src, then insert selected range from rotated src into dst.
// Clear dst before, if requested.
void MacroAssembler::rotate_then_insert(Register dst, Register src, int lBitPos, int rBitPos,
int nRotate, bool clear_dst) {
// This version does not depend on src being zero-extended int2long.
nRotate &= 0x003f; // For risbg, pretend it's an unsigned value.
z_risbg(dst, src, lBitPos, rBitPos, nRotate, clear_dst); // Rotate, then insert selected, clear the rest.
}
// Rotate src, then and selected range from rotated src into dst.
// Set condition code only if so requested. Otherwise it is unpredictable.
// See performance note in macroAssembler_s390.hpp for important information.
void MacroAssembler::rotate_then_and(Register dst, Register src, int lBitPos, int rBitPos,
int nRotate, bool test_only) {
guarantee(!test_only, "Emitter not fit for test_only instruction variant.");
// This version does not depend on src being zero-extended int2long.
nRotate &= 0x003f; // For risbg, pretend it's an unsigned value.
z_rxsbg(dst, src, lBitPos, rBitPos, nRotate, test_only); // Rotate, then xor selected.
}
// Rotate src, then or selected range from rotated src into dst.
// Set condition code only if so requested. Otherwise it is unpredictable.
// See performance note in macroAssembler_s390.hpp for important information.
void MacroAssembler::rotate_then_or(Register dst, Register src, int lBitPos, int rBitPos,
int nRotate, bool test_only) {
guarantee(!test_only, "Emitter not fit for test_only instruction variant.");
// This version does not depend on src being zero-extended int2long.
nRotate &= 0x003f; // For risbg, pretend it's an unsigned value.
z_rosbg(dst, src, lBitPos, rBitPos, nRotate, test_only); // Rotate, then xor selected.
}
// Rotate src, then xor selected range from rotated src into dst.
// Set condition code only if so requested. Otherwise it is unpredictable.
// See performance note in macroAssembler_s390.hpp for important information.
void MacroAssembler::rotate_then_xor(Register dst, Register src, int lBitPos, int rBitPos,
int nRotate, bool test_only) {
guarantee(!test_only, "Emitter not fit for test_only instruction variant.");
// This version does not depend on src being zero-extended int2long.
nRotate &= 0x003f; // For risbg, pretend it's an unsigned value.
z_rxsbg(dst, src, lBitPos, rBitPos, nRotate, test_only); // Rotate, then xor selected.
}
void MacroAssembler::add64(Register r1, RegisterOrConstant inc) {
if (inc.is_register()) {
z_agr(r1, inc.as_register());
} else { // constant
intptr_t imm = inc.as_constant();
add2reg(r1, imm);
}
}
// Helper function to multiply the 64bit contents of a register by a 16bit constant.
// The optimization tries to avoid the mghi instruction, since it uses the FPU for
// calculation and is thus rather slow.
//
// There is no handling for special cases, e.g. cval==0 or cval==1.
//
// Returns len of generated code block.
unsigned int MacroAssembler::mul_reg64_const16(Register rval, Register work, int cval) {
int block_start = offset();
bool sign_flip = cval < 0;
cval = sign_flip ? -cval : cval;
BLOCK_COMMENT("Reg64*Con16 {");
int bit1 = cval & -cval;
if (bit1 == cval) {
z_sllg(rval, rval, exact_log2(bit1));
if (sign_flip) { z_lcgr(rval, rval); }
} else {
int bit2 = (cval-bit1) & -(cval-bit1);
if ((bit1+bit2) == cval) {
z_sllg(work, rval, exact_log2(bit1));
z_sllg(rval, rval, exact_log2(bit2));
z_agr(rval, work);
if (sign_flip) { z_lcgr(rval, rval); }
} else {
if (sign_flip) { z_mghi(rval, -cval); }
else { z_mghi(rval, cval); }
}
}
BLOCK_COMMENT("} Reg64*Con16");
int block_end = offset();
return block_end - block_start;
}
// Generic operation r1 := r2 + imm.
//
// Should produce the best code for each supported CPU version.
// r2 == noreg yields r1 := r1 + imm
// imm == 0 emits either no instruction or r1 := r2 !
// NOTES: 1) Don't use this function where fixed sized
// instruction sequences are required!!!
// 2) Don't use this function if condition code
// setting is required!
// 3) Despite being declared as int64_t, the parameter imm
// must be a simm_32 value (= signed 32-bit integer).
void MacroAssembler::add2reg(Register r1, int64_t imm, Register r2) {
assert(Immediate::is_simm32(imm), "probably an implicit conversion went wrong");
if (r2 == noreg) { r2 = r1; }
// Handle special case imm == 0.
if (imm == 0) {
lgr_if_needed(r1, r2);
// Nothing else to do.
return;
}
if (!PreferLAoverADD || (r2 == Z_R0)) {
bool distinctOpnds = VM_Version::has_DistinctOpnds();
// Can we encode imm in 16 bits signed?
if (Immediate::is_simm16(imm)) {
if (r1 == r2) {
z_aghi(r1, imm);
return;
}
if (distinctOpnds) {
z_aghik(r1, r2, imm);
return;
}
lgr_if_needed(r1, r2);
z_aghi(r1, imm);
return;
}
} else {
// Can we encode imm in 12 bits unsigned?
if (Displacement::is_shortDisp(imm)) {
z_la(r1, imm, r2);
return;
}
// Can we encode imm in 20 bits signed?
if (Displacement::is_validDisp(imm)) {
// Always use LAY instruction, so we don't need the tmp register.
z_lay(r1, imm, r2);
return;
}
}
// Can handle it (all possible values) with long immediates.
lgr_if_needed(r1, r2);
z_agfi(r1, imm);
}
void MacroAssembler::add2reg_32(Register r1, int64_t imm, Register r2) {
assert(Immediate::is_simm32(imm), "probably an implicit conversion went wrong");
if (r2 == noreg) { r2 = r1; }
// Handle special case imm == 0.
if (imm == 0) {
lr_if_needed(r1, r2);
// Nothing else to do.
return;
}
if (Immediate::is_simm16(imm)) {
if (r1 == r2){
z_ahi(r1, imm);
return;
}
if (VM_Version::has_DistinctOpnds()) {
z_ahik(r1, r2, imm);
return;
}
lr_if_needed(r1, r2);
z_ahi(r1, imm);
return;
}
// imm is simm32
lr_if_needed(r1, r2);
z_afi(r1, imm);
}
// Generic operation r := b + x + d
//
// Addition of several operands with address generation semantics - sort of:
// - no restriction on the registers. Any register will do for any operand.
// - x == noreg: operand will be disregarded.
// - b == noreg: will use (contents of) result reg as operand (r := r + d).
// - x == Z_R0: just disregard
// - b == Z_R0: use as operand. This is not address generation semantics!!!
//
// The same restrictions as on add2reg() are valid!!!
void MacroAssembler::add2reg_with_index(Register r, int64_t d, Register x, Register b) {
assert(Immediate::is_simm32(d), "probably an implicit conversion went wrong");
if (x == noreg) { x = Z_R0; }
if (b == noreg) { b = r; }
// Handle special case x == R0.
if (x == Z_R0) {
// Can simply add the immediate value to the base register.
add2reg(r, d, b);
return;
}
if (!PreferLAoverADD || (b == Z_R0)) {
bool distinctOpnds = VM_Version::has_DistinctOpnds();
// Handle special case d == 0.
if (d == 0) {
if (b == x) { z_sllg(r, b, 1); return; }
if (r == x) { z_agr(r, b); return; }
if (r == b) { z_agr(r, x); return; }
if (distinctOpnds) { z_agrk(r, x, b); return; }
z_lgr(r, b);
z_agr(r, x);
} else {
if (x == b) { z_sllg(r, x, 1); }
else if (r == x) { z_agr(r, b); }
else if (r == b) { z_agr(r, x); }
else if (distinctOpnds) { z_agrk(r, x, b); }
else {
z_lgr(r, b);
z_agr(r, x);
}
add2reg(r, d);
}
} else {
// Can we encode imm in 12 bits unsigned?
if (Displacement::is_shortDisp(d)) {
z_la(r, d, x, b);
return;
}
// Can we encode imm in 20 bits signed?
if (Displacement::is_validDisp(d)) {
z_lay(r, d, x, b);
return;
}
z_la(r, 0, x, b);
add2reg(r, d);
}
}
// Generic emitter (32bit) for direct memory increment.
// For optimal code, do not specify Z_R0 as temp register.
void MacroAssembler::add2mem_32(const Address &a, int64_t imm, Register tmp) {
if (VM_Version::has_MemWithImmALUOps() && Immediate::is_simm8(imm)) {
z_asi(a, imm);
} else {
z_lgf(tmp, a);
add2reg(tmp, imm);
z_st(tmp, a);
}
}
void MacroAssembler::add2mem_64(const Address &a, int64_t imm, Register tmp) {
if (VM_Version::has_MemWithImmALUOps() && Immediate::is_simm8(imm)) {
z_agsi(a, imm);
} else {
z_lg(tmp, a);
add2reg(tmp, imm);
z_stg(tmp, a);
}
}
void MacroAssembler::load_sized_value(Register dst, Address src, size_t size_in_bytes, bool is_signed) {
switch (size_in_bytes) {
case 8: z_lg(dst, src); break;
case 4: is_signed ? z_lgf(dst, src) : z_llgf(dst, src); break;
case 2: is_signed ? z_lgh(dst, src) : z_llgh(dst, src); break;
case 1: is_signed ? z_lgb(dst, src) : z_llgc(dst, src); break;
default: ShouldNotReachHere();
}
}
void MacroAssembler::store_sized_value(Register src, Address dst, size_t size_in_bytes) {
switch (size_in_bytes) {
case 8: z_stg(src, dst); break;
case 4: z_st(src, dst); break;
case 2: z_sth(src, dst); break;
case 1: z_stc(src, dst); break;
default: ShouldNotReachHere();
}
}
// Split a si20 offset (20bit, signed) into an ui12 offset (12bit, unsigned) and
// a high-order summand in register tmp.
//
// return value: < 0: No split required, si20 actually has property uimm12.
// >= 0: Split performed. Use return value as uimm12 displacement and
// tmp as index register.
int MacroAssembler::split_largeoffset(int64_t si20_offset, Register tmp, bool fixed_codelen, bool accumulate) {
assert(Immediate::is_simm20(si20_offset), "sanity");
int lg_off = (int)si20_offset & 0x0fff; // Punch out low-order 12 bits, always positive.
int ll_off = (int)si20_offset & ~0x0fff; // Force low-order 12 bits to zero.
assert((Displacement::is_shortDisp(si20_offset) && (ll_off == 0)) ||
!Displacement::is_shortDisp(si20_offset), "unexpected offset values");
assert((lg_off+ll_off) == si20_offset, "offset splitup error");
Register work = accumulate? Z_R0 : tmp;
if (fixed_codelen) { // Len of code = 10 = 4 + 6.
z_lghi(work, ll_off>>12); // Implicit sign extension.
z_slag(work, work, 12);
} else { // Len of code = 0..10.
if (ll_off == 0) { return -1; }
// ll_off has 8 significant bits (at most) plus sign.
if ((ll_off & 0x0000f000) == 0) { // Non-zero bits only in upper halfbyte.
z_llilh(work, ll_off >> 16);
if (ll_off < 0) { // Sign-extension required.
z_lgfr(work, work);
}
} else {
if ((ll_off & 0x000f0000) == 0) { // Non-zero bits only in lower halfbyte.
z_llill(work, ll_off);
} else { // Non-zero bits in both halfbytes.
z_lghi(work, ll_off>>12); // Implicit sign extension.
z_slag(work, work, 12);
}
}
}
if (accumulate) { z_algr(tmp, work); } // len of code += 4
return lg_off;
}
void MacroAssembler::load_float_largeoffset(FloatRegister t, int64_t si20, Register a, Register tmp) {
if (Displacement::is_validDisp(si20)) {
z_ley(t, si20, a);
} else {
// Fixed_codelen = true is a simple way to ensure that the size of load_float_largeoffset
// does not depend on si20 (scratch buffer emit size == code buffer emit size for constant
// pool loads).
bool accumulate = true;
bool fixed_codelen = true;
Register work;
if (fixed_codelen) {
z_lgr(tmp, a); // Lgr_if_needed not applicable due to fixed_codelen.
} else {
accumulate = (a == tmp);
}
work = tmp;
int disp12 = split_largeoffset(si20, work, fixed_codelen, accumulate);
if (disp12 < 0) {
z_le(t, si20, work);
} else {
if (accumulate) {
z_le(t, disp12, work);
} else {
z_le(t, disp12, work, a);
}
}
}
}
void MacroAssembler::load_double_largeoffset(FloatRegister t, int64_t si20, Register a, Register tmp) {
if (Displacement::is_validDisp(si20)) {
z_ldy(t, si20, a);
} else {
// Fixed_codelen = true is a simple way to ensure that the size of load_double_largeoffset
// does not depend on si20 (scratch buffer emit size == code buffer emit size for constant
// pool loads).
bool accumulate = true;
bool fixed_codelen = true;
Register work;
if (fixed_codelen) {
z_lgr(tmp, a); // Lgr_if_needed not applicable due to fixed_codelen.
} else {
accumulate = (a == tmp);
}
work = tmp;
int disp12 = split_largeoffset(si20, work, fixed_codelen, accumulate);
if (disp12 < 0) {
z_ld(t, si20, work);
} else {
if (accumulate) {
z_ld(t, disp12, work);
} else {
z_ld(t, disp12, work, a);
}
}
}
}
// PCrelative TOC access.
// Returns distance (in bytes) from current position to start of consts section.
// Returns 0 (zero) if no consts section exists or if it has size zero.
long MacroAssembler::toc_distance() {
CodeSection* cs = code()->consts();
return (long)((cs != nullptr) ? cs->start()-pc() : 0);
}
// Implementation on x86/sparc assumes that constant and instruction section are
// adjacent, but this doesn't hold. Two special situations may occur, that we must
// be able to handle:
// 1. const section may be located apart from the inst section.
// 2. const section may be empty
// In both cases, we use the const section's start address to compute the "TOC",
// this seems to occur only temporarily; in the final step we always seem to end up
// with the pc-relatice variant.
//
// PC-relative offset could be +/-2**32 -> use long for disp
// Furthermore: makes no sense to have special code for
// adjacent const and inst sections.
void MacroAssembler::load_toc(Register Rtoc) {
// Simply use distance from start of const section (should be patched in the end).
long disp = toc_distance();
RelocationHolder rspec = internal_word_Relocation::spec(pc() + disp);
relocate(rspec);
z_larl(Rtoc, RelAddr::pcrel_off32(disp)); // Offset is in halfwords.
}
// PCrelative TOC access.
// Load from anywhere pcrelative (with relocation of load instr)
void MacroAssembler::load_long_pcrelative(Register Rdst, address dataLocation) {
address pc = this->pc();
ptrdiff_t total_distance = dataLocation - pc;
RelocationHolder rspec = internal_word_Relocation::spec(dataLocation);
assert((total_distance & 0x01L) == 0, "halfword alignment is mandatory");
assert(total_distance != 0, "sanity");
// Some extra safety net.
if (!RelAddr::is_in_range_of_RelAddr32(total_distance)) {
guarantee(RelAddr::is_in_range_of_RelAddr32(total_distance), "load_long_pcrelative can't handle distance " INTPTR_FORMAT, total_distance);
}
(this)->relocate(rspec, relocInfo::pcrel_addr_format);
z_lgrl(Rdst, RelAddr::pcrel_off32(total_distance));
}
// PCrelative TOC access.
// Load from anywhere pcrelative (with relocation of load instr)
// loaded addr has to be relocated when added to constant pool.
void MacroAssembler::load_addr_pcrelative(Register Rdst, address addrLocation) {
address pc = this->pc();
ptrdiff_t total_distance = addrLocation - pc;
RelocationHolder rspec = internal_word_Relocation::spec(addrLocation);
assert((total_distance & 0x01L) == 0, "halfword alignment is mandatory");
// Some extra safety net.
if (!RelAddr::is_in_range_of_RelAddr32(total_distance)) {
guarantee(RelAddr::is_in_range_of_RelAddr32(total_distance), "load_long_pcrelative can't handle distance " INTPTR_FORMAT, total_distance);
}
(this)->relocate(rspec, relocInfo::pcrel_addr_format);
z_lgrl(Rdst, RelAddr::pcrel_off32(total_distance));
}
// Generic operation: load a value from memory and test.
// CondCode indicates the sign (<0, ==0, >0) of the loaded value.
void MacroAssembler::load_and_test_byte(Register dst, const Address &a) {
z_lb(dst, a);
z_ltr(dst, dst);
}
void MacroAssembler::load_and_test_short(Register dst, const Address &a) {
int64_t disp = a.disp20();
if (Displacement::is_shortDisp(disp)) {
z_lh(dst, a);
} else if (Displacement::is_longDisp(disp)) {
z_lhy(dst, a);
} else {
guarantee(false, "displacement out of range");
}
z_ltr(dst, dst);
}
void MacroAssembler::load_and_test_int(Register dst, const Address &a) {
z_lt(dst, a);
}
void MacroAssembler::load_and_test_int2long(Register dst, const Address &a) {
z_ltgf(dst, a);
}
void MacroAssembler::load_and_test_long(Register dst, const Address &a) {
z_ltg(dst, a);
}
// Test a bit in memory for 2 byte datatype.
void MacroAssembler::testbit_ushort(const Address &a, unsigned int bit) {
assert(a.index() == noreg, "no index reg allowed in testbit");
if (bit <= 7) {
z_tm(a.disp() + 1, a.base(), 1 << bit);
} else if (bit <= 15) {
z_tm(a.disp() + 0, a.base(), 1 << (bit - 8));
} else {
ShouldNotReachHere();
}
}
// Test a bit in memory.
void MacroAssembler::testbit(const Address &a, unsigned int bit) {
assert(a.index() == noreg, "no index reg allowed in testbit");
if (bit <= 7) {
z_tm(a.disp() + 3, a.base(), 1 << bit);
} else if (bit <= 15) {
z_tm(a.disp() + 2, a.base(), 1 << (bit - 8));
} else if (bit <= 23) {
z_tm(a.disp() + 1, a.base(), 1 << (bit - 16));
} else if (bit <= 31) {
z_tm(a.disp() + 0, a.base(), 1 << (bit - 24));
} else {
ShouldNotReachHere();
}
}
// Test a bit in a register. Result is reflected in CC.
void MacroAssembler::testbit(Register r, unsigned int bitPos) {
if (bitPos < 16) {
z_tmll(r, 1U<<bitPos);
} else if (bitPos < 32) {
z_tmlh(r, 1U<<(bitPos-16));
} else if (bitPos < 48) {
z_tmhl(r, 1U<<(bitPos-32));
} else if (bitPos < 64) {
z_tmhh(r, 1U<<(bitPos-48));
} else {
ShouldNotReachHere();
}
}
void MacroAssembler::prefetch_read(Address a) {
z_pfd(1, a.disp20(), a.indexOrR0(), a.base());
}
void MacroAssembler::prefetch_update(Address a) {
z_pfd(2, a.disp20(), a.indexOrR0(), a.base());
}
// Clear a register, i.e. load const zero into reg.
// Return len (in bytes) of generated instruction(s).
// whole_reg: Clear 64 bits if true, 32 bits otherwise.
// set_cc: Use instruction that sets the condition code, if true.
int MacroAssembler::clear_reg(Register r, bool whole_reg, bool set_cc) {
unsigned int start_off = offset();
if (whole_reg) {
set_cc ? z_xgr(r, r) : z_laz(r, 0, Z_R0);
} else { // Only 32bit register.
set_cc ? z_xr(r, r) : z_lhi(r, 0);
}
return offset() - start_off;
}
#ifdef ASSERT
int MacroAssembler::preset_reg(Register r, unsigned long pattern, int pattern_len) {
switch (pattern_len) {
case 1:
pattern = (pattern & 0x000000ff) | ((pattern & 0x000000ff)<<8);
case 2:
pattern = (pattern & 0x0000ffff) | ((pattern & 0x0000ffff)<<16);
case 4:
pattern = (pattern & 0xffffffffL) | ((pattern & 0xffffffffL)<<32);
case 8:
return load_const_optimized_rtn_len(r, pattern, true);
break;
default:
guarantee(false, "preset_reg: bad len");
}
return 0;
}
#endif
// addr: Address descriptor of memory to clear. Index register will not be used!
// size: Number of bytes to clear.
// condition code will not be preserved.
// !!! DO NOT USE THEM FOR ATOMIC MEMORY CLEARING !!!
// !!! Use store_const() instead !!!
void MacroAssembler::clear_mem(const Address& addr, unsigned int size) {
guarantee((addr.disp() + size) <= 4096, "MacroAssembler::clear_mem: size too large");
switch (size) {
case 0:
return;
case 1:
z_mvi(addr, 0);
return;
case 2:
z_mvhhi(addr, 0);
return;
case 4:
z_mvhi(addr, 0);
return;
case 8:
z_mvghi(addr, 0);
return;
default: ; // Fallthru to xc.
}
// Caution: the emitter with Address operands does implicitly decrement the length
if (size <= 256) {
z_xc(addr, size, addr);
} else {
unsigned int offset = addr.disp();
unsigned int incr = 256;
for (unsigned int i = 0; i <= size-incr; i += incr) {
z_xc(offset, incr - 1, addr.base(), offset, addr.base());
offset += incr;
}
unsigned int rest = size - (offset - addr.disp());
if (size > 0) {
z_xc(offset, rest-1, addr.base(), offset, addr.base());
}
}
}
void MacroAssembler::align(int modulus) {
align(modulus, offset());
}
void MacroAssembler::align(int modulus, int target) {
assert(((modulus % 2 == 0) && (target % 2 == 0)), "needs to be even");
int delta = target - offset();
while ((offset() + delta) % modulus != 0) z_nop();
}
// Special version for non-relocateable code if required alignment
// is larger than CodeEntryAlignment.
void MacroAssembler::align_address(int modulus) {
while ((uintptr_t)pc() % modulus != 0) z_nop();
}
Address MacroAssembler::argument_address(RegisterOrConstant arg_slot,
Register temp_reg,
int64_t extra_slot_offset) {
// On Z, we can have index and disp in an Address. So don't call argument_offset,
// which issues an unnecessary add instruction.
int stackElementSize = Interpreter::stackElementSize;
int64_t offset = extra_slot_offset * stackElementSize;
const Register argbase = Z_esp;
if (arg_slot.is_constant()) {
offset += arg_slot.as_constant() * stackElementSize;
return Address(argbase, offset);
}
// else
assert(temp_reg != noreg, "must specify");
assert(temp_reg != Z_ARG1, "base and index are conflicting");
z_sllg(temp_reg, arg_slot.as_register(), exact_log2(stackElementSize)); // tempreg = arg_slot << 3
return Address(argbase, temp_reg, offset);
}
//===================================================================
//=== START C O N S T A N T S I N C O D E S T R E A M ===
//===================================================================
//=== P A T CH A B L E C O N S T A N T S ===
//===================================================================
//---------------------------------------------------
// Load (patchable) constant into register
//---------------------------------------------------
// Load absolute address (and try to optimize).
// Note: This method is usable only for position-fixed code,
// referring to a position-fixed target location.
// If not so, relocations and patching must be used.
void MacroAssembler::load_absolute_address(Register d, address addr) {
assert(addr != nullptr, "should not happen");
BLOCK_COMMENT("load_absolute_address:");
if (addr == nullptr) {
z_larl(d, pc()); // Dummy emit for size calc.
return;
}
if (RelAddr::is_in_range_of_RelAddr32(addr, pc())) {
z_larl(d, addr);
return;
}
load_const_optimized(d, (long)addr);
}
// Load a 64bit constant.
// Patchable code sequence, but not atomically patchable.
// Make sure to keep code size constant -> no value-dependent optimizations.
// Do not kill condition code.
void MacroAssembler::load_const(Register t, long x) {
// Note: Right shift is only cleanly defined for unsigned types
// or for signed types with nonnegative values.
Assembler::z_iihf(t, (long)((unsigned long)x >> 32));
Assembler::z_iilf(t, (long)((unsigned long)x & 0xffffffffUL));
}
// Load a 32bit constant into a 64bit register, sign-extend or zero-extend.
// Patchable code sequence, but not atomically patchable.
// Make sure to keep code size constant -> no value-dependent optimizations.
// Do not kill condition code.
void MacroAssembler::load_const_32to64(Register t, int64_t x, bool sign_extend) {
if (sign_extend) { Assembler::z_lgfi(t, x); }
else { Assembler::z_llilf(t, x); }
}
// Load narrow oop constant, no decompression.
void MacroAssembler::load_narrow_oop(Register t, narrowOop a) {
assert(UseCompressedOops, "must be on to call this method");
load_const_32to64(t, CompressedOops::narrow_oop_value(a), false /*sign_extend*/);
}
// Load narrow klass constant, compression required.
void MacroAssembler::load_narrow_klass(Register t, Klass* k) {
assert(UseCompressedClassPointers, "must be on to call this method");
narrowKlass encoded_k = CompressedKlassPointers::encode(k);
load_const_32to64(t, encoded_k, false /*sign_extend*/);
}
//------------------------------------------------------
// Compare (patchable) constant with register.
//------------------------------------------------------
// Compare narrow oop in reg with narrow oop constant, no decompression.
void MacroAssembler::compare_immediate_narrow_oop(Register oop1, narrowOop oop2) {
assert(UseCompressedOops, "must be on to call this method");
Assembler::z_clfi(oop1, CompressedOops::narrow_oop_value(oop2));
}
// Compare narrow oop in reg with narrow oop constant, no decompression.
void MacroAssembler::compare_immediate_narrow_klass(Register klass1, Klass* klass2) {
assert(UseCompressedClassPointers, "must be on to call this method");
narrowKlass encoded_k = CompressedKlassPointers::encode(klass2);
Assembler::z_clfi(klass1, encoded_k);
}
//----------------------------------------------------------
// Check which kind of load_constant we have here.
//----------------------------------------------------------
// Detection of CPU version dependent load_const sequence.
// The detection is valid only for code sequences generated by load_const,
// not load_const_optimized.
bool MacroAssembler::is_load_const(address a) {
unsigned long inst1, inst2;
unsigned int len1, len2;
len1 = get_instruction(a, &inst1);
len2 = get_instruction(a + len1, &inst2);
return is_z_iihf(inst1) && is_z_iilf(inst2);
}
// Detection of CPU version dependent load_const_32to64 sequence.
// Mostly used for narrow oops and narrow Klass pointers.
// The detection is valid only for code sequences generated by load_const_32to64.
bool MacroAssembler::is_load_const_32to64(address pos) {
unsigned long inst1, inst2;
unsigned int len1;
len1 = get_instruction(pos, &inst1);
return is_z_llilf(inst1);
}
// Detection of compare_immediate_narrow sequence.
// The detection is valid only for code sequences generated by compare_immediate_narrow_oop.
bool MacroAssembler::is_compare_immediate32(address pos) {
return is_equal(pos, CLFI_ZOPC, RIL_MASK);
}
// Detection of compare_immediate_narrow sequence.
// The detection is valid only for code sequences generated by compare_immediate_narrow_oop.
bool MacroAssembler::is_compare_immediate_narrow_oop(address pos) {
return is_compare_immediate32(pos);
}
// Detection of compare_immediate_narrow sequence.
// The detection is valid only for code sequences generated by compare_immediate_narrow_klass.
bool MacroAssembler::is_compare_immediate_narrow_klass(address pos) {
return is_compare_immediate32(pos);
}
//-----------------------------------
// patch the load_constant
//-----------------------------------
// CPU-version dependent patching of load_const.
void MacroAssembler::patch_const(address a, long x) {
assert(is_load_const(a), "not a load of a constant");
// Note: Right shift is only cleanly defined for unsigned types
// or for signed types with nonnegative values.
set_imm32((address)a, (long)((unsigned long)x >> 32));
set_imm32((address)(a + 6), (long)((unsigned long)x & 0xffffffffUL));
}
// Patching the value of CPU version dependent load_const_32to64 sequence.
// The passed ptr MUST be in compressed format!
int MacroAssembler::patch_load_const_32to64(address pos, int64_t np) {
assert(is_load_const_32to64(pos), "not a load of a narrow ptr (oop or klass)");
set_imm32(pos, np);
return 6;
}
// Patching the value of CPU version dependent compare_immediate_narrow sequence.
// The passed ptr MUST be in compressed format!
int MacroAssembler::patch_compare_immediate_32(address pos, int64_t np) {
assert(is_compare_immediate32(pos), "not a compressed ptr compare");
set_imm32(pos, np);
return 6;
}
// Patching the immediate value of CPU version dependent load_narrow_oop sequence.
// The passed ptr must NOT be in compressed format!
int MacroAssembler::patch_load_narrow_oop(address pos, oop o) {
assert(UseCompressedOops, "Can only patch compressed oops");
return patch_load_const_32to64(pos, CompressedOops::narrow_oop_value(o));
}
// Patching the immediate value of CPU version dependent load_narrow_klass sequence.
// The passed ptr must NOT be in compressed format!
int MacroAssembler::patch_load_narrow_klass(address pos, Klass* k) {
assert(UseCompressedClassPointers, "Can only patch compressed klass pointers");
narrowKlass nk = CompressedKlassPointers::encode(k);
return patch_load_const_32to64(pos, nk);
}
// Patching the immediate value of CPU version dependent compare_immediate_narrow_oop sequence.
// The passed ptr must NOT be in compressed format!
int MacroAssembler::patch_compare_immediate_narrow_oop(address pos, oop o) {
assert(UseCompressedOops, "Can only patch compressed oops");
return patch_compare_immediate_32(pos, CompressedOops::narrow_oop_value(o));
}
// Patching the immediate value of CPU version dependent compare_immediate_narrow_klass sequence.
// The passed ptr must NOT be in compressed format!
int MacroAssembler::patch_compare_immediate_narrow_klass(address pos, Klass* k) {
assert(UseCompressedClassPointers, "Can only patch compressed klass pointers");
narrowKlass nk = CompressedKlassPointers::encode(k);
return patch_compare_immediate_32(pos, nk);
}
//------------------------------------------------------------------------
// Extract the constant from a load_constant instruction stream.
//------------------------------------------------------------------------
// Get constant from a load_const sequence.
long MacroAssembler::get_const(address a) {
assert(is_load_const(a), "not a load of a constant");
unsigned long x;
x = (((unsigned long) (get_imm32(a,0) & 0xffffffff)) << 32);
x |= (((unsigned long) (get_imm32(a,1) & 0xffffffff)));
return (long) x;
}
//--------------------------------------
// Store a constant in memory.
//--------------------------------------
// General emitter to move a constant to memory.
// The store is atomic.
// o Address must be given in RS format (no index register)
// o Displacement should be 12bit unsigned for efficiency. 20bit signed also supported.
// o Constant can be 1, 2, 4, or 8 bytes, signed or unsigned.
// o Memory slot can be 1, 2, 4, or 8 bytes, signed or unsigned.
// o Memory slot must be at least as wide as constant, will assert otherwise.
// o Signed constants will sign-extend, unsigned constants will zero-extend to slot width.
int MacroAssembler::store_const(const Address &dest, long imm,
unsigned int lm, unsigned int lc,
Register scratch) {
int64_t disp = dest.disp();
Register base = dest.base();
assert(!dest.has_index(), "not supported");
assert((lm==1)||(lm==2)||(lm==4)||(lm==8), "memory length not supported");
assert((lc==1)||(lc==2)||(lc==4)||(lc==8), "constant length not supported");
assert(lm>=lc, "memory slot too small");
assert(lc==8 || Immediate::is_simm(imm, lc*8), "const out of range");
assert(Displacement::is_validDisp(disp), "displacement out of range");
bool is_shortDisp = Displacement::is_shortDisp(disp);
int store_offset = -1;
// For target len == 1 it's easy.
if (lm == 1) {
store_offset = offset();
if (is_shortDisp) {
z_mvi(disp, base, imm);
return store_offset;
} else {
z_mviy(disp, base, imm);
return store_offset;
}
}
// All the "good stuff" takes an unsigned displacement.
if (is_shortDisp) {
// NOTE: Cannot use clear_mem for imm==0, because it is not atomic.
store_offset = offset();
switch (lm) {
case 2: // Lc == 1 handled correctly here, even for unsigned. Instruction does no widening.
z_mvhhi(disp, base, imm);
return store_offset;
case 4:
if (Immediate::is_simm16(imm)) {
z_mvhi(disp, base, imm);
return store_offset;
}
break;
case 8:
if (Immediate::is_simm16(imm)) {
z_mvghi(disp, base, imm);
return store_offset;
}
break;
default:
ShouldNotReachHere();
break;
}
}
// Can't optimize, so load value and store it.
guarantee(scratch != noreg, " need a scratch register here !");
if (imm != 0) {
load_const_optimized(scratch, imm); // Preserves CC anyway.
} else {
// Leave CC alone!!
(void) clear_reg(scratch, true, false); // Indicate unused result.
}
store_offset = offset();
if (is_shortDisp) {
switch (lm) {
case 2:
z_sth(scratch, disp, Z_R0, base);
return store_offset;
case 4:
z_st(scratch, disp, Z_R0, base);
return store_offset;
case 8:
z_stg(scratch, disp, Z_R0, base);
return store_offset;
default:
ShouldNotReachHere();
break;
}
} else {
switch (lm) {
case 2:
z_sthy(scratch, disp, Z_R0, base);
return store_offset;
case 4:
z_sty(scratch, disp, Z_R0, base);
return store_offset;
case 8:
z_stg(scratch, disp, Z_R0, base);
return store_offset;
default:
ShouldNotReachHere();
break;
}
}
return -1; // should not reach here
}
//===================================================================
//=== N O T P A T CH A B L E C O N S T A N T S ===
//===================================================================
// Load constant x into register t with a fast instruction sequence
// depending on the bits in x. Preserves CC under all circumstances.
int MacroAssembler::load_const_optimized_rtn_len(Register t, long x, bool emit) {
if (x == 0) {
int len;
if (emit) {
len = clear_reg(t, true, false);
} else {
len = 4;
}
return len;
}
if (Immediate::is_simm16(x)) {
if (emit) { z_lghi(t, x); }
return 4;
}
// 64 bit value: | part1 | part2 | part3 | part4 |
// At least one part is not zero!
// Note: Right shift is only cleanly defined for unsigned types
// or for signed types with nonnegative values.
int part1 = (int)((unsigned long)x >> 48) & 0x0000ffff;
int part2 = (int)((unsigned long)x >> 32) & 0x0000ffff;
int part3 = (int)((unsigned long)x >> 16) & 0x0000ffff;
int part4 = (int)x & 0x0000ffff;
int part12 = (int)((unsigned long)x >> 32);
int part34 = (int)x;
// Lower word only (unsigned).
if (part12 == 0) {
if (part3 == 0) {
if (emit) z_llill(t, part4);
return 4;
}
if (part4 == 0) {
if (emit) z_llilh(t, part3);
return 4;
}
if (emit) z_llilf(t, part34);
return 6;
}
// Upper word only.
if (part34 == 0) {
if (part1 == 0) {
if (emit) z_llihl(t, part2);
return 4;
}
if (part2 == 0) {
if (emit) z_llihh(t, part1);
return 4;
}
if (emit) z_llihf(t, part12);
return 6;
}
// Lower word only (signed).
if ((part1 == 0x0000ffff) && (part2 == 0x0000ffff) && ((part3 & 0x00008000) != 0)) {
if (emit) z_lgfi(t, part34);
return 6;
}
int len = 0;
if ((part1 == 0) || (part2 == 0)) {
if (part1 == 0) {
if (emit) z_llihl(t, part2);
len += 4;
} else {
if (emit) z_llihh(t, part1);
len += 4;
}
} else {
if (emit) z_llihf(t, part12);
len += 6;
}
if ((part3 == 0) || (part4 == 0)) {
if (part3 == 0) {
if (emit) z_iill(t, part4);
len += 4;
} else {
if (emit) z_iilh(t, part3);
len += 4;
}
} else {
if (emit) z_iilf(t, part34);
len += 6;
}
return len;
}
//=====================================================================
//=== H I G H E R L E V E L B R A N C H E M I T T E R S ===
//=====================================================================
// Note: In the worst case, one of the scratch registers is destroyed!!!
void MacroAssembler::compare32_and_branch(Register r1, RegisterOrConstant x2, branch_condition cond, Label& lbl) {
// Right operand is constant.
if (x2.is_constant()) {
jlong value = x2.as_constant();
compare_and_branch_optimized(r1, value, cond, lbl, /*len64=*/false, /*has_sign=*/true);
return;
}
// Right operand is in register.
compare_and_branch_optimized(r1, x2.as_register(), cond, lbl, /*len64=*/false, /*has_sign=*/true);
}
// Note: In the worst case, one of the scratch registers is destroyed!!!
void MacroAssembler::compareU32_and_branch(Register r1, RegisterOrConstant x2, branch_condition cond, Label& lbl) {
// Right operand is constant.
if (x2.is_constant()) {
jlong value = x2.as_constant();
compare_and_branch_optimized(r1, value, cond, lbl, /*len64=*/false, /*has_sign=*/false);
return;
}
// Right operand is in register.
compare_and_branch_optimized(r1, x2.as_register(), cond, lbl, /*len64=*/false, /*has_sign=*/false);
}
// Note: In the worst case, one of the scratch registers is destroyed!!!
void MacroAssembler::compare64_and_branch(Register r1, RegisterOrConstant x2, branch_condition cond, Label& lbl) {
// Right operand is constant.
if (x2.is_constant()) {
jlong value = x2.as_constant();
compare_and_branch_optimized(r1, value, cond, lbl, /*len64=*/true, /*has_sign=*/true);
return;
}
// Right operand is in register.
compare_and_branch_optimized(r1, x2.as_register(), cond, lbl, /*len64=*/true, /*has_sign=*/true);
}
void MacroAssembler::compareU64_and_branch(Register r1, RegisterOrConstant x2, branch_condition cond, Label& lbl) {
// Right operand is constant.
if (x2.is_constant()) {
jlong value = x2.as_constant();
compare_and_branch_optimized(r1, value, cond, lbl, /*len64=*/true, /*has_sign=*/false);
return;
}
// Right operand is in register.
compare_and_branch_optimized(r1, x2.as_register(), cond, lbl, /*len64=*/true, /*has_sign=*/false);
}
// Generate an optimal branch to the branch target.
// Optimal means that a relative branch (brc or brcl) is used if the
// branch distance is short enough. Loading the target address into a
// register and branching via reg is used as fallback only.
//
// Used registers:
// Z_R1 - work reg. Holds branch target address.
// Used in fallback case only.
//
// This version of branch_optimized is good for cases where the target address is known
// and constant, i.e. is never changed (no relocation, no patching).
void MacroAssembler::branch_optimized(Assembler::branch_condition cond, address branch_addr) {
address branch_origin = pc();
if (RelAddr::is_in_range_of_RelAddr16(branch_addr, branch_origin)) {
z_brc(cond, branch_addr);
} else if (RelAddr::is_in_range_of_RelAddr32(branch_addr, branch_origin)) {
z_brcl(cond, branch_addr);
} else {
load_const_optimized(Z_R1, branch_addr); // CC must not get killed by load_const_optimized.
z_bcr(cond, Z_R1);
}
}
// This version of branch_optimized is good for cases where the target address
// is potentially not yet known at the time the code is emitted.
//
// One very common case is a branch to an unbound label which is handled here.
// The caller might know (or hope) that the branch distance is short enough
// to be encoded in a 16bit relative address. In this case he will pass a
// NearLabel branch_target.
// Care must be taken with unbound labels. Each call to target(label) creates
// an entry in the patch queue for that label to patch all references of the label
// once it gets bound. Those recorded patch locations must be patchable. Otherwise,
// an assertion fires at patch time.
void MacroAssembler::branch_optimized(Assembler::branch_condition cond, Label& branch_target) {
if (branch_target.is_bound()) {
address branch_addr = target(branch_target);
branch_optimized(cond, branch_addr);
} else if (branch_target.is_near()) {
z_brc(cond, branch_target); // Caller assures that the target will be in range for z_brc.
} else {
z_brcl(cond, branch_target); // Let's hope target is in range. Otherwise, we will abort at patch time.
}
}
// Generate an optimal compare and branch to the branch target.
// Optimal means that a relative branch (clgrj, brc or brcl) is used if the
// branch distance is short enough. Loading the target address into a
// register and branching via reg is used as fallback only.
//
// Input:
// r1 - left compare operand
// r2 - right compare operand
void MacroAssembler::compare_and_branch_optimized(Register r1,
Register r2,
Assembler::branch_condition cond,
address branch_addr,
bool len64,
bool has_sign) {
unsigned int casenum = (len64?2:0)+(has_sign?0:1);
address branch_origin = pc();
if (VM_Version::has_CompareBranch() && RelAddr::is_in_range_of_RelAddr16(branch_addr, branch_origin)) {
switch (casenum) {
case 0: z_crj( r1, r2, cond, branch_addr); break;
case 1: z_clrj (r1, r2, cond, branch_addr); break;
case 2: z_cgrj(r1, r2, cond, branch_addr); break;
case 3: z_clgrj(r1, r2, cond, branch_addr); break;
default: ShouldNotReachHere(); break;
}
} else {
switch (casenum) {
case 0: z_cr( r1, r2); break;
case 1: z_clr(r1, r2); break;
case 2: z_cgr(r1, r2); break;
case 3: z_clgr(r1, r2); break;
default: ShouldNotReachHere(); break;
}
branch_optimized(cond, branch_addr);
}
}
// Generate an optimal compare and branch to the branch target.
// Optimal means that a relative branch (clgij, brc or brcl) is used if the
// branch distance is short enough. Loading the target address into a
// register and branching via reg is used as fallback only.
//
// Input:
// r1 - left compare operand (in register)
// x2 - right compare operand (immediate)
void MacroAssembler::compare_and_branch_optimized(Register r1,
jlong x2,
Assembler::branch_condition cond,
Label& branch_target,
bool len64,
bool has_sign) {
address branch_origin = pc();
bool x2_imm8 = (has_sign && Immediate::is_simm8(x2)) || (!has_sign && Immediate::is_uimm8(x2));
bool is_RelAddr16 = branch_target.is_near() ||
(branch_target.is_bound() &&
RelAddr::is_in_range_of_RelAddr16(target(branch_target), branch_origin));
unsigned int casenum = (len64?2:0)+(has_sign?0:1);
if (VM_Version::has_CompareBranch() && is_RelAddr16 && x2_imm8) {
switch (casenum) {
case 0: z_cij( r1, x2, cond, branch_target); break;
case 1: z_clij(r1, x2, cond, branch_target); break;
case 2: z_cgij(r1, x2, cond, branch_target); break;
case 3: z_clgij(r1, x2, cond, branch_target); break;
default: ShouldNotReachHere(); break;
}
return;
}
if (x2 == 0) {
switch (casenum) {
case 0: z_ltr(r1, r1); break;
case 1: z_ltr(r1, r1); break; // Caution: unsigned test only provides zero/notZero indication!
case 2: z_ltgr(r1, r1); break;
case 3: z_ltgr(r1, r1); break; // Caution: unsigned test only provides zero/notZero indication!
default: ShouldNotReachHere(); break;
}
} else {
if ((has_sign && Immediate::is_simm16(x2)) || (!has_sign && Immediate::is_uimm(x2, 15))) {
switch (casenum) {
case 0: z_chi(r1, x2); break;
case 1: z_chi(r1, x2); break; // positive immediate < 2**15
case 2: z_cghi(r1, x2); break;
case 3: z_cghi(r1, x2); break; // positive immediate < 2**15
default: break;
}
} else if ( (has_sign && Immediate::is_simm32(x2)) || (!has_sign && Immediate::is_uimm32(x2)) ) {
switch (casenum) {
case 0: z_cfi( r1, x2); break;
case 1: z_clfi(r1, x2); break;
case 2: z_cgfi(r1, x2); break;
case 3: z_clgfi(r1, x2); break;
default: ShouldNotReachHere(); break;
}
} else {
// No instruction with immediate operand possible, so load into register.
Register scratch = (r1 != Z_R0) ? Z_R0 : Z_R1;
load_const_optimized(scratch, x2);
switch (casenum) {
case 0: z_cr( r1, scratch); break;
case 1: z_clr(r1, scratch); break;
case 2: z_cgr(r1, scratch); break;
case 3: z_clgr(r1, scratch); break;
default: ShouldNotReachHere(); break;
}
}
}
branch_optimized(cond, branch_target);
}
// Generate an optimal compare and branch to the branch target.
// Optimal means that a relative branch (clgrj, brc or brcl) is used if the
// branch distance is short enough. Loading the target address into a
// register and branching via reg is used as fallback only.
//
// Input:
// r1 - left compare operand
// r2 - right compare operand
void MacroAssembler::compare_and_branch_optimized(Register r1,
Register r2,
Assembler::branch_condition cond,
Label& branch_target,
bool len64,
bool has_sign) {
unsigned int casenum = (len64 ? 2 : 0) + (has_sign ? 0 : 1);
if (branch_target.is_bound()) {
address branch_addr = target(branch_target);
compare_and_branch_optimized(r1, r2, cond, branch_addr, len64, has_sign);
} else {
if (VM_Version::has_CompareBranch() && branch_target.is_near()) {
switch (casenum) {
case 0: z_crj( r1, r2, cond, branch_target); break;
case 1: z_clrj( r1, r2, cond, branch_target); break;
case 2: z_cgrj( r1, r2, cond, branch_target); break;
case 3: z_clgrj(r1, r2, cond, branch_target); break;
default: ShouldNotReachHere(); break;
}
} else {
switch (casenum) {
case 0: z_cr( r1, r2); break;
case 1: z_clr(r1, r2); break;
case 2: z_cgr(r1, r2); break;
case 3: z_clgr(r1, r2); break;
default: ShouldNotReachHere(); break;
}
branch_optimized(cond, branch_target);
}
}
}
//===========================================================================
//=== END H I G H E R L E V E L B R A N C H E M I T T E R S ===
//===========================================================================
AddressLiteral MacroAssembler::allocate_metadata_address(Metadata* obj) {
assert(oop_recorder() != nullptr, "this assembler needs an OopRecorder");
int index = oop_recorder()->allocate_metadata_index(obj);
RelocationHolder rspec = metadata_Relocation::spec(index);
return AddressLiteral((address)obj, rspec);
}
AddressLiteral MacroAssembler::constant_metadata_address(Metadata* obj) {
assert(oop_recorder() != nullptr, "this assembler needs an OopRecorder");
int index = oop_recorder()->find_index(obj);
RelocationHolder rspec = metadata_Relocation::spec(index);
return AddressLiteral((address)obj, rspec);
}
AddressLiteral MacroAssembler::allocate_oop_address(jobject obj) {
assert(oop_recorder() != nullptr, "this assembler needs an OopRecorder");
int oop_index = oop_recorder()->allocate_oop_index(obj);
return AddressLiteral(address(obj), oop_Relocation::spec(oop_index));
}
AddressLiteral MacroAssembler::constant_oop_address(jobject obj) {
assert(oop_recorder() != nullptr, "this assembler needs an OopRecorder");
int oop_index = oop_recorder()->find_index(obj);
return AddressLiteral(address(obj), oop_Relocation::spec(oop_index));
}
// NOTE: destroys r
void MacroAssembler::c2bool(Register r, Register t) {
z_lcr(t, r); // t = -r
z_or(r, t); // r = -r OR r
z_srl(r, 31); // Yields 0 if r was 0, 1 otherwise.
}
// Patch instruction `inst' at offset `inst_pos' to refer to `dest_pos'
// and return the resulting instruction.
// Dest_pos and inst_pos are 32 bit only. These parms can only designate
// relative positions.
// Use correct argument types. Do not pre-calculate distance.
unsigned long MacroAssembler::patched_branch(address dest_pos, unsigned long inst, address inst_pos) {
int c = 0;
unsigned long patched_inst = 0;
if (is_call_pcrelative_short(inst) ||
is_branch_pcrelative_short(inst) ||
is_branchoncount_pcrelative_short(inst) ||
is_branchonindex32_pcrelative_short(inst)) {
c = 1;
int m = fmask(15, 0); // simm16(-1, 16, 32);
int v = simm16(RelAddr::pcrel_off16(dest_pos, inst_pos), 16, 32);
patched_inst = (inst & ~m) | v;
} else if (is_compareandbranch_pcrelative_short(inst)) {
c = 2;
long m = fmask(31, 16); // simm16(-1, 16, 48);
long v = simm16(RelAddr::pcrel_off16(dest_pos, inst_pos), 16, 48);
patched_inst = (inst & ~m) | v;
} else if (is_branchonindex64_pcrelative_short(inst)) {
c = 3;
long m = fmask(31, 16); // simm16(-1, 16, 48);
long v = simm16(RelAddr::pcrel_off16(dest_pos, inst_pos), 16, 48);
patched_inst = (inst & ~m) | v;
} else if (is_call_pcrelative_long(inst) || is_branch_pcrelative_long(inst)) {
c = 4;
long m = fmask(31, 0); // simm32(-1, 16, 48);
long v = simm32(RelAddr::pcrel_off32(dest_pos, inst_pos), 16, 48);
patched_inst = (inst & ~m) | v;
} else if (is_pcrelative_long(inst)) { // These are the non-branch pc-relative instructions.
c = 5;
long m = fmask(31, 0); // simm32(-1, 16, 48);
long v = simm32(RelAddr::pcrel_off32(dest_pos, inst_pos), 16, 48);
patched_inst = (inst & ~m) | v;
} else {
print_dbg_msg(tty, inst, "not a relative branch", 0);
dump_code_range(tty, inst_pos, 32, "not a pcrelative branch");
ShouldNotReachHere();
}
long new_off = get_pcrel_offset(patched_inst);
if (new_off != (dest_pos-inst_pos)) {
tty->print_cr("case %d: dest_pos = %p, inst_pos = %p, disp = %ld(%12.12lx)", c, dest_pos, inst_pos, new_off, new_off);
print_dbg_msg(tty, inst, "<- original instruction: branch patching error", 0);
print_dbg_msg(tty, patched_inst, "<- patched instruction: branch patching error", 0);
#ifdef LUCY_DBG
VM_Version::z_SIGSEGV();
#endif
ShouldNotReachHere();
}
return patched_inst;
}
// Only called when binding labels (share/vm/asm/assembler.cpp)
// Pass arguments as intended. Do not pre-calculate distance.
void MacroAssembler::pd_patch_instruction(address branch, address target, const char* file, int line) {
unsigned long stub_inst;
int inst_len = get_instruction(branch, &stub_inst);
set_instruction(branch, patched_branch(target, stub_inst, branch), inst_len);
}
// Extract relative address (aka offset).
// inv_simm16 works for 4-byte instructions only.
// compare and branch instructions are 6-byte and have a 16bit offset "in the middle".
long MacroAssembler::get_pcrel_offset(unsigned long inst) {
if (MacroAssembler::is_pcrelative_short(inst)) {
if (((inst&0xFFFFffff00000000UL) == 0) && ((inst&0x00000000FFFF0000UL) != 0)) {
return RelAddr::inv_pcrel_off16(inv_simm16(inst));
} else {
return RelAddr::inv_pcrel_off16(inv_simm16_48(inst));
}
}
if (MacroAssembler::is_pcrelative_long(inst)) {
return RelAddr::inv_pcrel_off32(inv_simm32(inst));
}
print_dbg_msg(tty, inst, "not a pcrelative instruction", 6);
#ifdef LUCY_DBG
VM_Version::z_SIGSEGV();
#else
ShouldNotReachHere();
#endif
return -1;
}
long MacroAssembler::get_pcrel_offset(address pc) {
unsigned long inst;
unsigned int len = get_instruction(pc, &inst);
#ifdef ASSERT
long offset;
if (MacroAssembler::is_pcrelative_short(inst) || MacroAssembler::is_pcrelative_long(inst)) {
offset = get_pcrel_offset(inst);
} else {
offset = -1;
}
if (offset == -1) {
dump_code_range(tty, pc, 32, "not a pcrelative instruction");
#ifdef LUCY_DBG
VM_Version::z_SIGSEGV();
#else
ShouldNotReachHere();
#endif
}
return offset;
#else
return get_pcrel_offset(inst);
#endif // ASSERT
}
// Get target address from pc-relative instructions.
address MacroAssembler::get_target_addr_pcrel(address pc) {
assert(is_pcrelative_long(pc), "not a pcrelative instruction");
return pc + get_pcrel_offset(pc);
}
// Patch pc relative load address.
void MacroAssembler::patch_target_addr_pcrel(address pc, address con) {
unsigned long inst;
// Offset is +/- 2**32 -> use long.
ptrdiff_t distance = con - pc;
get_instruction(pc, &inst);
if (is_pcrelative_short(inst)) {
*(short *)(pc+2) = RelAddr::pcrel_off16(con, pc); // Instructions are at least 2-byte aligned, no test required.
// Some extra safety net.
if (!RelAddr::is_in_range_of_RelAddr16(distance)) {
print_dbg_msg(tty, inst, "distance out of range (16bit)", 4);
dump_code_range(tty, pc, 32, "distance out of range (16bit)");
guarantee(RelAddr::is_in_range_of_RelAddr16(distance), "too far away (more than +/- 2**16");
}
return;
}
if (is_pcrelative_long(inst)) {
*(int *)(pc+2) = RelAddr::pcrel_off32(con, pc);
// Some Extra safety net.
if (!RelAddr::is_in_range_of_RelAddr32(distance)) {
print_dbg_msg(tty, inst, "distance out of range (32bit)", 6);
dump_code_range(tty, pc, 32, "distance out of range (32bit)");
guarantee(RelAddr::is_in_range_of_RelAddr32(distance), "too far away (more than +/- 2**32");
}
return;
}
guarantee(false, "not a pcrelative instruction to patch!");
}
// "Current PC" here means the address just behind the basr instruction.
address MacroAssembler::get_PC(Register result) {
z_basr(result, Z_R0); // Don't branch, just save next instruction address in result.
return pc();
}
// Get current PC + offset.
// Offset given in bytes, must be even!
// "Current PC" here means the address of the larl instruction plus the given offset.
address MacroAssembler::get_PC(Register result, int64_t offset) {
address here = pc();
z_larl(result, offset/2); // Save target instruction address in result.
return here + offset;
}
void MacroAssembler::instr_size(Register size, Register pc) {
// Extract 2 most significant bits of current instruction.
z_llgc(size, Address(pc));
z_srl(size, 6);
// Compute (x+3)&6 which translates 0->2, 1->4, 2->4, 3->6.
z_ahi(size, 3);
z_nill(size, 6);
}
// Resize_frame with SP(new) = SP(old) - [offset].
void MacroAssembler::resize_frame_sub(Register offset, Register fp, bool load_fp)
{
assert_different_registers(offset, fp, Z_SP);
if (load_fp) { z_lg(fp, _z_abi(callers_sp), Z_SP); }
z_sgr(Z_SP, offset);
z_stg(fp, _z_abi(callers_sp), Z_SP);
}
// Resize_frame with SP(new) = [newSP] + offset.
// This emitter is useful if we already have calculated a pointer
// into the to-be-allocated stack space, e.g. with special alignment properties,
// but need some additional space, e.g. for spilling.
// newSP is the pre-calculated pointer. It must not be modified.
// fp holds, or is filled with, the frame pointer.
// offset is the additional increment which is added to addr to form the new SP.
// Note: specify a negative value to reserve more space!
// load_fp == true only indicates that fp is not pre-filled with the frame pointer.
// It does not guarantee that fp contains the frame pointer at the end.
void MacroAssembler::resize_frame_abs_with_offset(Register newSP, Register fp, int offset, bool load_fp) {
assert_different_registers(newSP, fp, Z_SP);
if (load_fp) {
z_lg(fp, _z_abi(callers_sp), Z_SP);
}
add2reg(Z_SP, offset, newSP);
z_stg(fp, _z_abi(callers_sp), Z_SP);
}
// Resize_frame with SP(new) = [newSP].
// load_fp == true only indicates that fp is not pre-filled with the frame pointer.
// It does not guarantee that fp contains the frame pointer at the end.
void MacroAssembler::resize_frame_absolute(Register newSP, Register fp, bool load_fp) {
assert_different_registers(newSP, fp, Z_SP);
if (load_fp) {
z_lg(fp, _z_abi(callers_sp), Z_SP); // need to use load/store.
}
z_lgr(Z_SP, newSP);
if (newSP != Z_R0) { // make sure we generate correct code, no matter what register newSP uses.
z_stg(fp, _z_abi(callers_sp), newSP);
} else {
z_stg(fp, _z_abi(callers_sp), Z_SP);
}
}
// Resize_frame with SP(new) = SP(old) + offset.
void MacroAssembler::resize_frame(RegisterOrConstant offset, Register fp, bool load_fp) {
assert_different_registers(fp, Z_SP);
if (load_fp) {
z_lg(fp, _z_abi(callers_sp), Z_SP);
}
add64(Z_SP, offset);
z_stg(fp, _z_abi(callers_sp), Z_SP);
}
void MacroAssembler::push_frame(Register bytes, Register old_sp, bool copy_sp, bool bytes_with_inverted_sign) {
#ifdef ASSERT
assert_different_registers(bytes, old_sp, Z_SP);
if (!copy_sp) {
z_cgr(old_sp, Z_SP);
asm_assert(bcondEqual, "[old_sp]!=[Z_SP]", 0x211);
}
#endif
if (copy_sp) { z_lgr(old_sp, Z_SP); }
if (bytes_with_inverted_sign) {
z_agr(Z_SP, bytes);
} else {
z_sgr(Z_SP, bytes); // Z_sgfr sufficient, but probably not faster.
}
z_stg(old_sp, _z_abi(callers_sp), Z_SP);
}
unsigned int MacroAssembler::push_frame(unsigned int bytes, Register scratch) {
long offset = Assembler::align(bytes, frame::alignment_in_bytes);
assert(offset > 0, "should push a frame with positive size, size = %ld.", offset);
assert(Displacement::is_validDisp(-offset), "frame size out of range, size = %ld", offset);
// We must not write outside the current stack bounds (given by Z_SP).
// Thus, we have to first update Z_SP and then store the previous SP as stack linkage.
// We rely on Z_R0 by default to be available as scratch.
z_lgr(scratch, Z_SP);
add2reg(Z_SP, -offset);
z_stg(scratch, _z_abi(callers_sp), Z_SP);
#ifdef ASSERT
// Just make sure nobody uses the value in the default scratch register.
// When another register is used, the caller might rely on it containing the frame pointer.
if (scratch == Z_R0) {
z_iihf(scratch, 0xbaadbabe);
z_iilf(scratch, 0xdeadbeef);
}
#endif
return offset;
}
// Push a frame of size `bytes' plus abi160 on top.
unsigned int MacroAssembler::push_frame_abi160(unsigned int bytes) {
BLOCK_COMMENT("push_frame_abi160 {");
unsigned int res = push_frame(bytes + frame::z_abi_160_size);
BLOCK_COMMENT("} push_frame_abi160");
return res;
}
// Pop current C frame.
void MacroAssembler::pop_frame() {
BLOCK_COMMENT("pop_frame {");
Assembler::z_lg(Z_SP, _z_abi(callers_sp), Z_SP);
BLOCK_COMMENT("} pop_frame");
}
// Pop current C frame and restore return PC register (Z_R14).
void MacroAssembler::pop_frame_restore_retPC(int frame_size_in_bytes) {
BLOCK_COMMENT("pop_frame_restore_retPC:");
int retPC_offset = _z_common_abi(return_pc) + frame_size_in_bytes;
// If possible, pop frame by add instead of load (a penny saved is a penny got :-).
if (Displacement::is_validDisp(retPC_offset)) {
z_lg(Z_R14, retPC_offset, Z_SP);
add2reg(Z_SP, frame_size_in_bytes);
} else {
add2reg(Z_SP, frame_size_in_bytes);
restore_return_pc();
}
}
void MacroAssembler::call_VM_leaf_base(address entry_point, bool allow_relocation) {
if (allow_relocation) {
call_c(entry_point);
} else {
call_c_static(entry_point);
}
}
void MacroAssembler::call_VM_leaf_base(address entry_point) {
bool allow_relocation = true;
call_VM_leaf_base(entry_point, allow_relocation);
}
int MacroAssembler::ic_check_size() {
int ic_size = 24;
if (!ImplicitNullChecks) {
ic_size += 6;
}
if (UseCompactObjectHeaders) {
ic_size += 12;
} else {
ic_size += 6; // either z_llgf or z_lg
}
return ic_size;
}
int MacroAssembler::ic_check(int end_alignment) {
Register R2_receiver = Z_ARG1;
Register R0_scratch = Z_R0_scratch;
Register R1_scratch = Z_R1_scratch;
Register R9_data = Z_inline_cache;
Label success, failure;
// The UEP of a code blob ensures that the VEP is padded. However, the padding of the UEP is placed
// before the inline cache check, so we don't have to execute any nop instructions when dispatching
// through the UEP, yet we can ensure that the VEP is aligned appropriately. That's why we align
// before the inline cache check here, and not after
align(end_alignment, offset() + ic_check_size());
int uep_offset = offset();
if (!ImplicitNullChecks) {
z_cgij(R2_receiver, 0, Assembler::bcondEqual, failure);
}
if (UseCompactObjectHeaders) {
load_narrow_klass_compact(R1_scratch, R2_receiver);
} else if (UseCompressedClassPointers) {
z_llgf(R1_scratch, Address(R2_receiver, oopDesc::klass_offset_in_bytes()));
} else {
z_lg(R1_scratch, Address(R2_receiver, oopDesc::klass_offset_in_bytes()));
}
z_cg(R1_scratch, Address(R9_data, in_bytes(CompiledICData::speculated_klass_offset())));
z_bre(success);
bind(failure);
load_const(R1_scratch, AddressLiteral(SharedRuntime::get_ic_miss_stub()));
z_br(R1_scratch);
bind(success);
assert((offset() % end_alignment) == 0, "Misaligned verified entry point, offset() = %d, end_alignment = %d", offset(), end_alignment);
return uep_offset;
}
void MacroAssembler::call_VM_base(Register oop_result,
Register last_java_sp,
address entry_point,
bool allow_relocation,
bool check_exceptions) { // Defaults to true.
// Allow_relocation indicates, if true, that the generated code shall
// be fit for code relocation or referenced data relocation. In other
// words: all addresses must be considered variable. PC-relative addressing
// is not possible then.
// On the other hand, if (allow_relocation == false), addresses and offsets
// may be considered stable, enabling us to take advantage of some PC-relative
// addressing tweaks. These might improve performance and reduce code size.
// Determine last_java_sp register.
if (!last_java_sp->is_valid()) {
last_java_sp = Z_SP; // Load Z_SP as SP.
}
set_top_ijava_frame_at_SP_as_last_Java_frame(last_java_sp, Z_R1, allow_relocation);
// ARG1 must hold thread address.
z_lgr(Z_ARG1, Z_thread);
address return_pc = nullptr;
if (allow_relocation) {
return_pc = call_c(entry_point);
} else {
return_pc = call_c_static(entry_point);
}
reset_last_Java_frame(allow_relocation);
// C++ interp handles this in the interpreter.
check_and_handle_popframe(Z_thread);
check_and_handle_earlyret(Z_thread);
// Check for pending exceptions.
if (check_exceptions) {
// Check for pending exceptions (java_thread is set upon return).
load_and_test_long(Z_R0_scratch, Address(Z_thread, Thread::pending_exception_offset()));
// This used to conditionally jump to forward_exception however it is
// possible if we relocate that the branch will not reach. So we must jump
// around so we can always reach.
Label ok;
z_bre(ok); // Bcondequal is the same as bcondZero.
call_stub(StubRoutines::forward_exception_entry());
bind(ok);
}
// Get oop result if there is one and reset the value in the thread.
if (oop_result->is_valid()) {
get_vm_result_oop(oop_result);
}
_last_calls_return_pc = return_pc; // Wipe out other (error handling) calls.
}
void MacroAssembler::call_VM_base(Register oop_result,
Register last_java_sp,
address entry_point,
bool check_exceptions) { // Defaults to true.
bool allow_relocation = true;
call_VM_base(oop_result, last_java_sp, entry_point, allow_relocation, check_exceptions);
}
// VM calls without explicit last_java_sp.
void MacroAssembler::call_VM(Register oop_result, address entry_point, bool check_exceptions) {
// Call takes possible detour via InterpreterMacroAssembler.
call_VM_base(oop_result, noreg, entry_point, true, check_exceptions);
}
void MacroAssembler::call_VM(Register oop_result, address entry_point, Register arg_1, bool check_exceptions) {
// Z_ARG1 is reserved for the thread.
lgr_if_needed(Z_ARG2, arg_1);
call_VM(oop_result, entry_point, check_exceptions);
}
void MacroAssembler::call_VM(Register oop_result, address entry_point, Register arg_1, Register arg_2, bool check_exceptions) {
// Z_ARG1 is reserved for the thread.
assert_different_registers(arg_2, Z_ARG2);
lgr_if_needed(Z_ARG2, arg_1);
lgr_if_needed(Z_ARG3, arg_2);
call_VM(oop_result, entry_point, check_exceptions);
}
void MacroAssembler::call_VM(Register oop_result, address entry_point, Register arg_1, Register arg_2,
Register arg_3, bool check_exceptions) {
// Z_ARG1 is reserved for the thread.
assert_different_registers(arg_3, Z_ARG2, Z_ARG3);
assert_different_registers(arg_2, Z_ARG2);
lgr_if_needed(Z_ARG2, arg_1);
lgr_if_needed(Z_ARG3, arg_2);
lgr_if_needed(Z_ARG4, arg_3);
call_VM(oop_result, entry_point, check_exceptions);
}
// VM static calls without explicit last_java_sp.
void MacroAssembler::call_VM_static(Register oop_result, address entry_point, bool check_exceptions) {
// Call takes possible detour via InterpreterMacroAssembler.
call_VM_base(oop_result, noreg, entry_point, false, check_exceptions);
}
void MacroAssembler::call_VM_static(Register oop_result, address entry_point, Register arg_1, Register arg_2,
Register arg_3, bool check_exceptions) {
// Z_ARG1 is reserved for the thread.
assert_different_registers(arg_3, Z_ARG2, Z_ARG3);
assert_different_registers(arg_2, Z_ARG2);
lgr_if_needed(Z_ARG2, arg_1);
lgr_if_needed(Z_ARG3, arg_2);
lgr_if_needed(Z_ARG4, arg_3);
call_VM_static(oop_result, entry_point, check_exceptions);
}
// VM calls with explicit last_java_sp.
void MacroAssembler::call_VM(Register oop_result, Register last_java_sp, address entry_point, bool check_exceptions) {
// Call takes possible detour via InterpreterMacroAssembler.
call_VM_base(oop_result, last_java_sp, entry_point, true, check_exceptions);
}
void MacroAssembler::call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1, bool check_exceptions) {
// Z_ARG1 is reserved for the thread.
lgr_if_needed(Z_ARG2, arg_1);
call_VM(oop_result, last_java_sp, entry_point, check_exceptions);
}
void MacroAssembler::call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1,
Register arg_2, bool check_exceptions) {
// Z_ARG1 is reserved for the thread.
assert_different_registers(arg_2, Z_ARG2);
lgr_if_needed(Z_ARG2, arg_1);
lgr_if_needed(Z_ARG3, arg_2);
call_VM(oop_result, last_java_sp, entry_point, check_exceptions);
}
void MacroAssembler::call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1,
Register arg_2, Register arg_3, bool check_exceptions) {
// Z_ARG1 is reserved for the thread.
assert_different_registers(arg_3, Z_ARG2, Z_ARG3);
assert_different_registers(arg_2, Z_ARG2);
lgr_if_needed(Z_ARG2, arg_1);
lgr_if_needed(Z_ARG3, arg_2);
lgr_if_needed(Z_ARG4, arg_3);
call_VM(oop_result, last_java_sp, entry_point, check_exceptions);
}
// VM leaf calls.
void MacroAssembler::call_VM_leaf(address entry_point) {
// Call takes possible detour via InterpreterMacroAssembler.
call_VM_leaf_base(entry_point, true);
}
void MacroAssembler::call_VM_leaf(address entry_point, Register arg_1) {
if (arg_1 != noreg) lgr_if_needed(Z_ARG1, arg_1);
call_VM_leaf(entry_point);
}
void MacroAssembler::call_VM_leaf(address entry_point, Register arg_1, Register arg_2) {
assert_different_registers(arg_2, Z_ARG1);
if (arg_1 != noreg) lgr_if_needed(Z_ARG1, arg_1);
if (arg_2 != noreg) lgr_if_needed(Z_ARG2, arg_2);
call_VM_leaf(entry_point);
}
void MacroAssembler::call_VM_leaf(address entry_point, Register arg_1, Register arg_2, Register arg_3) {
assert_different_registers(arg_3, Z_ARG1, Z_ARG2);
assert_different_registers(arg_2, Z_ARG1);
if (arg_1 != noreg) lgr_if_needed(Z_ARG1, arg_1);
if (arg_2 != noreg) lgr_if_needed(Z_ARG2, arg_2);
if (arg_3 != noreg) lgr_if_needed(Z_ARG3, arg_3);
call_VM_leaf(entry_point);
}
// Static VM leaf calls.
// Really static VM leaf calls are never patched.
void MacroAssembler::call_VM_leaf_static(address entry_point) {
// Call takes possible detour via InterpreterMacroAssembler.
call_VM_leaf_base(entry_point, false);
}
void MacroAssembler::call_VM_leaf_static(address entry_point, Register arg_1) {
if (arg_1 != noreg) lgr_if_needed(Z_ARG1, arg_1);
call_VM_leaf_static(entry_point);
}
void MacroAssembler::call_VM_leaf_static(address entry_point, Register arg_1, Register arg_2) {
assert_different_registers(arg_2, Z_ARG1);
if (arg_1 != noreg) lgr_if_needed(Z_ARG1, arg_1);
if (arg_2 != noreg) lgr_if_needed(Z_ARG2, arg_2);
call_VM_leaf_static(entry_point);
}
void MacroAssembler::call_VM_leaf_static(address entry_point, Register arg_1, Register arg_2, Register arg_3) {
assert_different_registers(arg_3, Z_ARG1, Z_ARG2);
assert_different_registers(arg_2, Z_ARG1);
if (arg_1 != noreg) lgr_if_needed(Z_ARG1, arg_1);
if (arg_2 != noreg) lgr_if_needed(Z_ARG2, arg_2);
if (arg_3 != noreg) lgr_if_needed(Z_ARG3, arg_3);
call_VM_leaf_static(entry_point);
}
// Don't use detour via call_c(reg).
address MacroAssembler::call_c(address function_entry) {
load_const(Z_R1, function_entry);
return call(Z_R1);
}
// Variant for really static (non-relocatable) calls which are never patched.
address MacroAssembler::call_c_static(address function_entry) {
load_absolute_address(Z_R1, function_entry);
#if 0 // def ASSERT
// Verify that call site did not move.
load_const_optimized(Z_R0, function_entry);
z_cgr(Z_R1, Z_R0);
z_brc(bcondEqual, 3);
z_illtrap(0xba);
#endif
return call(Z_R1);
}
address MacroAssembler::call_c_opt(address function_entry) {
bool success = call_far_patchable(function_entry, -2 /* emit relocation + constant */);
_last_calls_return_pc = success ? pc() : nullptr;
return _last_calls_return_pc;
}
// Identify a call_far_patchable instruction: LARL + LG + BASR
//
// nop ; optionally, if required for alignment
// lgrl rx,A(TOC entry) ; PC-relative access into constant pool
// basr Z_R14,rx ; end of this instruction must be aligned to a word boundary
//
// Code pattern will eventually get patched into variant2 (see below for detection code).
//
bool MacroAssembler::is_call_far_patchable_variant0_at(address instruction_addr) {
address iaddr = instruction_addr;
// Check for the actual load instruction.
if (!is_load_const_from_toc(iaddr)) { return false; }
iaddr += load_const_from_toc_size();
// Check for the call (BASR) instruction, finally.
assert(iaddr-instruction_addr+call_byregister_size() == call_far_patchable_size(), "size mismatch");
return is_call_byregister(iaddr);
}
// Identify a call_far_patchable instruction: BRASL
//
// Code pattern to suits atomic patching:
// nop ; Optionally, if required for alignment.
// nop ... ; Multiple filler nops to compensate for size difference (variant0 is longer).
// nop ; For code pattern detection: Prepend each BRASL with a nop.
// brasl Z_R14,<reladdr> ; End of code must be 4-byte aligned !
bool MacroAssembler::is_call_far_patchable_variant2_at(address instruction_addr) {
const address call_addr = (address)((intptr_t)instruction_addr + call_far_patchable_size() - call_far_pcrelative_size());
// Check for correct number of leading nops.
address iaddr;
for (iaddr = instruction_addr; iaddr < call_addr; iaddr += nop_size()) {
if (!is_z_nop(iaddr)) { return false; }
}
assert(iaddr == call_addr, "sanity");
// --> Check for call instruction.
if (is_call_far_pcrelative(call_addr)) {
assert(call_addr-instruction_addr+call_far_pcrelative_size() == call_far_patchable_size(), "size mismatch");
return true;
}
return false;
}
// Emit a NOT mt-safely patchable 64 bit absolute call.
// If toc_offset == -2, then the destination of the call (= target) is emitted
// to the constant pool and a runtime_call relocation is added
// to the code buffer.
// If toc_offset != -2, target must already be in the constant pool at
// _ctableStart+toc_offset (a caller can retrieve toc_offset
// from the runtime_call relocation).
// Special handling of emitting to scratch buffer when there is no constant pool.
// Slightly changed code pattern. We emit an additional nop if we would
// not end emitting at a word aligned address. This is to ensure
// an atomically patchable displacement in brasl instructions.
//
// A call_far_patchable comes in different flavors:
// - LARL(CP) / LG(CP) / BR (address in constant pool, access via CP register)
// - LGRL(CP) / BR (address in constant pool, pc-relative access)
// - BRASL (relative address of call target coded in instruction)
// All flavors occupy the same amount of space. Length differences are compensated
// by leading nops, such that the instruction sequence always ends at the same
// byte offset. This is required to keep the return offset constant.
// Furthermore, the return address (the end of the instruction sequence) is forced
// to be on a 4-byte boundary. This is required for atomic patching, should we ever
// need to patch the call target of the BRASL flavor.
// RETURN value: false, if no constant pool entry could be allocated, true otherwise.
bool MacroAssembler::call_far_patchable(address target, int64_t tocOffset) {
// Get current pc and ensure word alignment for end of instr sequence.
const address start_pc = pc();
const intptr_t start_off = offset();
assert(!call_far_patchable_requires_alignment_nop(start_pc), "call_far_patchable requires aligned address");
const ptrdiff_t dist = (ptrdiff_t)(target - (start_pc + 2)); // Prepend each BRASL with a nop.
const bool emit_target_to_pool = (tocOffset == -2) && !code_section()->scratch_emit();
const bool emit_relative_call = !emit_target_to_pool &&
RelAddr::is_in_range_of_RelAddr32(dist) &&
ReoptimizeCallSequences &&
!code_section()->scratch_emit();
if (emit_relative_call) {
// Add padding to get the same size as below.
const unsigned int padding = call_far_patchable_size() - call_far_pcrelative_size();
unsigned int current_padding;
for (current_padding = 0; current_padding < padding; current_padding += nop_size()) { z_nop(); }
assert(current_padding == padding, "sanity");
// relative call: len = 2(nop) + 6 (brasl)
// CodeBlob resize cannot occur in this case because
// this call is emitted into pre-existing space.
z_nop(); // Prepend each BRASL with a nop.
z_brasl(Z_R14, target);
} else {
// absolute call: Get address from TOC.
// len = (load TOC){6|0} + (load from TOC){6} + (basr){2} = {14|8}
if (emit_target_to_pool) {
// When emitting the call for the first time, we do not need to use
// the pc-relative version. It will be patched anyway, when the code
// buffer is copied.
// Relocation is not needed when !ReoptimizeCallSequences.
relocInfo::relocType rt = ReoptimizeCallSequences ? relocInfo::runtime_call_w_cp_type : relocInfo::none;
AddressLiteral dest(target, rt);
// Store_oop_in_toc() adds dest to the constant table. As side effect, this kills
// inst_mark(). Reset if possible.
bool reset_mark = (inst_mark() == pc());
tocOffset = store_oop_in_toc(dest);
if (reset_mark) { set_inst_mark(); }
if (tocOffset == -1) {
return false; // Couldn't create constant pool entry.
}
}
assert(offset() == start_off, "emit no code before this point!");
address tocPos = pc() + tocOffset;
if (emit_target_to_pool) {
tocPos = code()->consts()->start() + tocOffset;
}
load_long_pcrelative(Z_R14, tocPos);
z_basr(Z_R14, Z_R14);
}
#ifdef ASSERT
// Assert that we can identify the emitted call.
assert(is_call_far_patchable_at(addr_at(start_off)), "can't identify emitted call");
assert(offset() == start_off+call_far_patchable_size(), "wrong size");
if (emit_target_to_pool) {
assert(get_dest_of_call_far_patchable_at(addr_at(start_off), code()->consts()->start()) == target,
"wrong encoding of dest address");
}
#endif
return true; // success
}
// Identify a call_far_patchable instruction.
// For more detailed information see header comment of call_far_patchable.
bool MacroAssembler::is_call_far_patchable_at(address instruction_addr) {
return is_call_far_patchable_variant2_at(instruction_addr) || // short version: BRASL
is_call_far_patchable_variant0_at(instruction_addr); // long version LARL + LG + BASR
}
// Does the call_far_patchable instruction use a pc-relative encoding
// of the call destination?
bool MacroAssembler::is_call_far_patchable_pcrelative_at(address instruction_addr) {
// Variant 2 is pc-relative.
return is_call_far_patchable_variant2_at(instruction_addr);
}
bool MacroAssembler::is_call_far_pcrelative(address instruction_addr) {
// Prepend each BRASL with a nop.
return is_z_nop(instruction_addr) && is_z_brasl(instruction_addr + nop_size()); // Match at position after one nop required.
}
// Set destination address of a call_far_patchable instruction.
void MacroAssembler::set_dest_of_call_far_patchable_at(address instruction_addr, address dest, int64_t tocOffset) {
ResourceMark rm;
// Now that CP entry is verified, patch call to a pc-relative call (if circumstances permit).
int code_size = MacroAssembler::call_far_patchable_size();
CodeBuffer buf(instruction_addr, code_size);
MacroAssembler masm(&buf);
masm.call_far_patchable(dest, tocOffset);
ICache::invalidate_range(instruction_addr, code_size); // Empty on z.
}
// Get dest address of a call_far_patchable instruction.
address MacroAssembler::get_dest_of_call_far_patchable_at(address instruction_addr, address ctable) {
// Dynamic TOC: absolute address in constant pool.
// Check variant2 first, it is more frequent.
// Relative address encoded in call instruction.
if (is_call_far_patchable_variant2_at(instruction_addr)) {
return MacroAssembler::get_target_addr_pcrel(instruction_addr + nop_size()); // Prepend each BRASL with a nop.
// Absolute address in constant pool.
} else if (is_call_far_patchable_variant0_at(instruction_addr)) {
address iaddr = instruction_addr;
long tocOffset = get_load_const_from_toc_offset(iaddr);
address tocLoc = iaddr + tocOffset;
return *(address *)(tocLoc);
} else {
fprintf(stderr, "MacroAssembler::get_dest_of_call_far_patchable_at has a problem at %p:\n", instruction_addr);
fprintf(stderr, "not a call_far_patchable: %16.16lx %16.16lx, len = %d\n",
*(unsigned long*)instruction_addr,
*(unsigned long*)(instruction_addr+8),
call_far_patchable_size());
Disassembler::decode(instruction_addr, instruction_addr+call_far_patchable_size());
ShouldNotReachHere();
return nullptr;
}
}
void MacroAssembler::align_call_far_patchable(address pc) {
if (call_far_patchable_requires_alignment_nop(pc)) { z_nop(); }
}
void MacroAssembler::check_and_handle_earlyret(Register java_thread) {
}
void MacroAssembler::check_and_handle_popframe(Register java_thread) {
}
// Read from the polling page.
// Use TM or TMY instruction, depending on read offset.
// offset = 0: Use TM, safepoint polling.
// offset < 0: Use TMY, profiling safepoint polling.
void MacroAssembler::load_from_polling_page(Register polling_page_address, int64_t offset) {
if (Immediate::is_uimm12(offset)) {
z_tm(offset, polling_page_address, mask_safepoint);
} else {
z_tmy(offset, polling_page_address, mask_profiling);
}
}
// Check whether z_instruction is a read access to the polling page
// which was emitted by load_from_polling_page(..).
bool MacroAssembler::is_load_from_polling_page(address instr_loc) {
unsigned long z_instruction;
unsigned int ilen = get_instruction(instr_loc, &z_instruction);
if (ilen == 2) { return false; } // It's none of the allowed instructions.
if (ilen == 4) {
if (!is_z_tm(z_instruction)) { return false; } // It's len=4, but not a z_tm. fail.
int ms = inv_mask(z_instruction,8,32); // mask
int ra = inv_reg(z_instruction,16,32); // base register
int ds = inv_uimm12(z_instruction); // displacement
if (!(ds == 0 && ra != 0 && ms == mask_safepoint)) {
return false; // It's not a z_tm(0, ra, mask_safepoint). Fail.
}
} else { /* if (ilen == 6) */
assert(!is_z_lg(z_instruction), "old form (LG) polling page access. Please fix and use TM(Y).");
if (!is_z_tmy(z_instruction)) { return false; } // It's len=6, but not a z_tmy. fail.
int ms = inv_mask(z_instruction,8,48); // mask
int ra = inv_reg(z_instruction,16,48); // base register
int ds = inv_simm20(z_instruction); // displacement
}
return true;
}
// Extract poll address from instruction and ucontext.
address MacroAssembler::get_poll_address(address instr_loc, void* ucontext) {
assert(ucontext != nullptr, "must have ucontext");
ucontext_t* uc = (ucontext_t*) ucontext;
unsigned long z_instruction;
unsigned int ilen = get_instruction(instr_loc, &z_instruction);
if (ilen == 4 && is_z_tm(z_instruction)) {
int ra = inv_reg(z_instruction, 16, 32); // base register
int ds = inv_uimm12(z_instruction); // displacement
address addr = (address)uc->uc_mcontext.gregs[ra];
return addr + ds;
} else if (ilen == 6 && is_z_tmy(z_instruction)) {
int ra = inv_reg(z_instruction, 16, 48); // base register
int ds = inv_simm20(z_instruction); // displacement
address addr = (address)uc->uc_mcontext.gregs[ra];
return addr + ds;
}
ShouldNotReachHere();
return nullptr;
}
// Extract poll register from instruction.
uint MacroAssembler::get_poll_register(address instr_loc) {
unsigned long z_instruction;
unsigned int ilen = get_instruction(instr_loc, &z_instruction);
if (ilen == 4 && is_z_tm(z_instruction)) {
return (uint)inv_reg(z_instruction, 16, 32); // base register
} else if (ilen == 6 && is_z_tmy(z_instruction)) {
return (uint)inv_reg(z_instruction, 16, 48); // base register
}
ShouldNotReachHere();
return 0;
}
void MacroAssembler::safepoint_poll(Label& slow_path, Register temp_reg) {
const Address poll_byte_addr(Z_thread, in_bytes(JavaThread::polling_word_offset()) + 7 /* Big Endian */);
// Armed page has poll_bit set.
z_tm(poll_byte_addr, SafepointMechanism::poll_bit());
z_brnaz(slow_path);
}
// Don't rely on register locking, always use Z_R1 as scratch register instead.
void MacroAssembler::bang_stack_with_offset(int offset) {
// Stack grows down, caller passes positive offset.
assert(offset > 0, "must bang with positive offset");
if (Displacement::is_validDisp(-offset)) {
z_tmy(-offset, Z_SP, mask_stackbang);
} else {
add2reg(Z_R1, -offset, Z_SP); // Do not destroy Z_SP!!!
z_tm(0, Z_R1, mask_stackbang); // Just banging.
}
}
void MacroAssembler::reserved_stack_check(Register return_pc) {
// Test if reserved zone needs to be enabled.
Label no_reserved_zone_enabling;
assert(return_pc == Z_R14, "Return pc must be in R14 before z_br() to StackOverflow stub.");
BLOCK_COMMENT("reserved_stack_check {");
z_clg(Z_SP, Address(Z_thread, JavaThread::reserved_stack_activation_offset()));
z_brl(no_reserved_zone_enabling);
// Enable reserved zone again, throw stack overflow exception.
save_return_pc();
push_frame_abi160(0);
call_VM_leaf(CAST_FROM_FN_PTR(address, SharedRuntime::enable_stack_reserved_zone), Z_thread);
pop_frame();
restore_return_pc();
load_const_optimized(Z_R1, SharedRuntime::throw_delayed_StackOverflowError_entry());
// Don't use call() or z_basr(), they will invalidate Z_R14 which contains the return pc.
z_br(Z_R1);
should_not_reach_here();
bind(no_reserved_zone_enabling);
BLOCK_COMMENT("} reserved_stack_check");
}
// Defines obj, preserves var_size_in_bytes, okay for t2 == var_size_in_bytes.
void MacroAssembler::tlab_allocate(Register obj,
Register var_size_in_bytes,
int con_size_in_bytes,
Register t1,
Label& slow_case) {
assert_different_registers(obj, var_size_in_bytes, t1);
Register end = t1;
Register thread = Z_thread;
z_lg(obj, Address(thread, JavaThread::tlab_top_offset()));
if (var_size_in_bytes == noreg) {
z_lay(end, Address(obj, con_size_in_bytes));
} else {
z_lay(end, Address(obj, var_size_in_bytes));
}
z_cg(end, Address(thread, JavaThread::tlab_end_offset()));
branch_optimized(bcondHigh, slow_case);
// Update the tlab top pointer.
z_stg(end, Address(thread, JavaThread::tlab_top_offset()));
// Recover var_size_in_bytes if necessary.
if (var_size_in_bytes == end) {
z_sgr(var_size_in_bytes, obj);
}
}
// Emitter for interface method lookup.
// input: recv_klass, intf_klass, itable_index
// output: method_result
// kills: itable_index, temp1_reg, Z_R0, Z_R1
// TODO: Temp2_reg is unused. we may use this emitter also in the itable stubs.
// If the register is still not needed then, remove it.
void MacroAssembler::lookup_interface_method(Register recv_klass,
Register intf_klass,
RegisterOrConstant itable_index,
Register method_result,
Register temp1_reg,
Label& no_such_interface,
bool return_method) {
const Register vtable_len = temp1_reg; // Used to compute itable_entry_addr.
const Register itable_entry_addr = Z_R1_scratch;
const Register itable_interface = Z_R0_scratch;
BLOCK_COMMENT("lookup_interface_method {");
// Load start of itable entries into itable_entry_addr.
z_llgf(vtable_len, Address(recv_klass, Klass::vtable_length_offset()));
z_sllg(vtable_len, vtable_len, exact_log2(vtableEntry::size_in_bytes()));
// Loop over all itable entries until desired interfaceOop(Rinterface) found.
add2reg_with_index(itable_entry_addr,
in_bytes(Klass::vtable_start_offset() + itableOffsetEntry::interface_offset()),
recv_klass, vtable_len);
const int itable_offset_search_inc = itableOffsetEntry::size() * wordSize;
Label search;
bind(search);
// Handle IncompatibleClassChangeError.
// If the entry is null then we've reached the end of the table
// without finding the expected interface, so throw an exception.
load_and_test_long(itable_interface, Address(itable_entry_addr));
z_bre(no_such_interface);
add2reg(itable_entry_addr, itable_offset_search_inc);
z_cgr(itable_interface, intf_klass);
z_brne(search);
// Entry found and itable_entry_addr points to it, get offset of vtable for interface.
if (return_method) {
const int vtable_offset_offset = in_bytes(itableOffsetEntry::offset_offset() -
itableOffsetEntry::interface_offset()) -
itable_offset_search_inc;
// Compute itableMethodEntry and get method and entry point
// we use addressing with index and displacement, since the formula
// for computing the entry's offset has a fixed and a dynamic part,
// the latter depending on the matched interface entry and on the case,
// that the itable index has been passed as a register, not a constant value.
int method_offset = in_bytes(itableMethodEntry::method_offset());
// Fixed part (displacement), common operand.
Register itable_offset = method_result; // Dynamic part (index register).
if (itable_index.is_register()) {
// Compute the method's offset in that register, for the formula, see the
// else-clause below.
z_sllg(itable_offset, itable_index.as_register(), exact_log2(itableMethodEntry::size() * wordSize));
z_agf(itable_offset, vtable_offset_offset, itable_entry_addr);
} else {
// Displacement increases.
method_offset += itableMethodEntry::size() * wordSize * itable_index.as_constant();
// Load index from itable.
z_llgf(itable_offset, vtable_offset_offset, itable_entry_addr);
}
// Finally load the method's oop.
z_lg(method_result, method_offset, itable_offset, recv_klass);
}
BLOCK_COMMENT("} lookup_interface_method");
}
// Lookup for virtual method invocation.
void MacroAssembler::lookup_virtual_method(Register recv_klass,
RegisterOrConstant vtable_index,
Register method_result) {
assert_different_registers(recv_klass, vtable_index.register_or_noreg());
assert(vtableEntry::size() * wordSize == wordSize,
"else adjust the scaling in the code below");
BLOCK_COMMENT("lookup_virtual_method {");
const int base = in_bytes(Klass::vtable_start_offset());
if (vtable_index.is_constant()) {
// Load with base + disp.
Address vtable_entry_addr(recv_klass,
vtable_index.as_constant() * wordSize +
base +
in_bytes(vtableEntry::method_offset()));
z_lg(method_result, vtable_entry_addr);
} else {
// Shift index properly and load with base + index + disp.
Register vindex = vtable_index.as_register();
Address vtable_entry_addr(recv_klass, vindex,
base + in_bytes(vtableEntry::method_offset()));
z_sllg(vindex, vindex, exact_log2(wordSize));
z_lg(method_result, vtable_entry_addr);
}
BLOCK_COMMENT("} lookup_virtual_method");
}
// Factor out code to call ic_miss_handler.
// Generate code to call the inline cache miss handler.
//
// In most cases, this code will be generated out-of-line.
// The method parameters are intended to provide some variability.
// ICM - Label which has to be bound to the start of useful code (past any traps).
// trapMarker - Marking byte for the generated illtrap instructions (if any).
// Any value except 0x00 is supported.
// = 0x00 - do not generate illtrap instructions.
// use nops to fill unused space.
// requiredSize - required size of the generated code. If the actually
// generated code is smaller, use padding instructions to fill up.
// = 0 - no size requirement, no padding.
// scratch - scratch register to hold branch target address.
//
// The method returns the code offset of the bound label.
unsigned int MacroAssembler::call_ic_miss_handler(Label& ICM, int trapMarker, int requiredSize, Register scratch) {
intptr_t startOffset = offset();
// Prevent entry at content_begin().
if (trapMarker != 0) {
z_illtrap(trapMarker);
}
// Load address of inline cache miss code into scratch register
// and branch to cache miss handler.
BLOCK_COMMENT("IC miss handler {");
BIND(ICM);
unsigned int labelOffset = offset();
AddressLiteral icmiss(SharedRuntime::get_ic_miss_stub());
load_const_optimized(scratch, icmiss);
z_br(scratch);
// Fill unused space.
if (requiredSize > 0) {
while ((offset() - startOffset) < requiredSize) {
if (trapMarker == 0) {
z_nop();
} else {
z_illtrap(trapMarker);
}
}
}
BLOCK_COMMENT("} IC miss handler");
return labelOffset;
}
void MacroAssembler::nmethod_UEP(Label& ic_miss) {
Register ic_reg = Z_inline_cache;
int klass_offset = oopDesc::klass_offset_in_bytes();
if (!ImplicitNullChecks || MacroAssembler::needs_explicit_null_check(klass_offset)) {
if (VM_Version::has_CompareBranch()) {
z_cgij(Z_ARG1, 0, Assembler::bcondEqual, ic_miss);
} else {
z_ltgr(Z_ARG1, Z_ARG1);
z_bre(ic_miss);
}
}
// Compare cached class against klass from receiver.
compare_klass_ptr(ic_reg, klass_offset, Z_ARG1, false);
z_brne(ic_miss);
}
void MacroAssembler::check_klass_subtype_fast_path(Register sub_klass,
Register super_klass,
Register temp1_reg,
Label* L_success,
Label* L_failure,
Label* L_slow_path,
Register super_check_offset) {
// Input registers must not overlap.
assert_different_registers(sub_klass, super_klass, temp1_reg, super_check_offset);
const int sco_offset = in_bytes(Klass::super_check_offset_offset());
bool must_load_sco = ! super_check_offset->is_valid();
// Input registers must not overlap.
if (must_load_sco) {
assert(temp1_reg != noreg, "supply either a temp or a register offset");
}
const Register Rsuper_check_offset = temp1_reg;
NearLabel L_fallthrough;
int label_nulls = 0;
if (L_success == nullptr) { L_success = &L_fallthrough; label_nulls++; }
if (L_failure == nullptr) { L_failure = &L_fallthrough; label_nulls++; }
if (L_slow_path == nullptr) { L_slow_path = &L_fallthrough; label_nulls++; }
assert(label_nulls <= 1 || (L_slow_path == &L_fallthrough && label_nulls <= 2), "at most one null in the batch, usually");
BLOCK_COMMENT("check_klass_subtype_fast_path {");
// If the pointers are equal, we are done (e.g., String[] elements).
// This self-check enables sharing of secondary supertype arrays among
// non-primary types such as array-of-interface. Otherwise, each such
// type would need its own customized SSA.
// We move this check to the front of the fast path because many
// type checks are in fact trivially successful in this manner,
// so we get a nicely predicted branch right at the start of the check.
compare64_and_branch(sub_klass, super_klass, bcondEqual, *L_success);
// Check the supertype display, which is uint.
if (must_load_sco) {
z_llgf(Rsuper_check_offset, sco_offset, super_klass);
super_check_offset = Rsuper_check_offset;
}
Address super_check_addr(sub_klass, super_check_offset, 0);
z_cg(super_klass, super_check_addr); // compare w/ displayed supertype
branch_optimized(Assembler::bcondEqual, *L_success);
// This check has worked decisively for primary supers.
// Secondary supers are sought in the super_cache ('super_cache_addr').
// (Secondary supers are interfaces and very deeply nested subtypes.)
// This works in the same check above because of a tricky aliasing
// between the super_cache and the primary super display elements.
// (The 'super_check_addr' can address either, as the case requires.)
// Note that the cache is updated below if it does not help us find
// what we need immediately.
// So if it was a primary super, we can just fail immediately.
// Otherwise, it's the slow path for us (no success at this point).
// Hacked jmp, which may only be used just before L_fallthrough.
#define final_jmp(label) \
if (&(label) == &L_fallthrough) { /*do nothing*/ } \
else { branch_optimized(Assembler::bcondAlways, label); } /*omit semicolon*/
z_cfi(super_check_offset, in_bytes(Klass::secondary_super_cache_offset()));
if (L_failure == &L_fallthrough) {
branch_optimized(Assembler::bcondEqual, *L_slow_path);
} else {
branch_optimized(Assembler::bcondNotEqual, *L_failure);
final_jmp(*L_slow_path);
}
bind(L_fallthrough);
#undef final_jmp
BLOCK_COMMENT("} check_klass_subtype_fast_path");
// fallthru (to slow path)
}
void MacroAssembler::check_klass_subtype_slow_path_linear(Register Rsubklass,
Register Rsuperklass,
Register Rarray_ptr, // tmp
Register Rlength, // tmp
Label* L_success,
Label* L_failure,
bool set_cond_codes /* unused */) {
// Input registers must not overlap.
// Also check for R1 which is explicitly used here.
assert_different_registers(Z_R1, Rsubklass, Rsuperklass, Rarray_ptr, Rlength);
NearLabel L_fallthrough;
int label_nulls = 0;
if (L_success == nullptr) { L_success = &L_fallthrough; label_nulls++; }
if (L_failure == nullptr) { L_failure = &L_fallthrough; label_nulls++; }
assert(label_nulls <= 1, "at most one null in the batch");
const int ss_offset = in_bytes(Klass::secondary_supers_offset());
const int sc_offset = in_bytes(Klass::secondary_super_cache_offset());
const int length_offset = Array<Klass*>::length_offset_in_bytes();
const int base_offset = Array<Klass*>::base_offset_in_bytes();
// Hacked jmp, which may only be used just before L_fallthrough.
#define final_jmp(label) \
if (&(label) == &L_fallthrough) { /*do nothing*/ } \
else branch_optimized(Assembler::bcondAlways, label) /*omit semicolon*/
NearLabel loop_iterate, loop_count, match;
BLOCK_COMMENT("check_klass_subtype_slow_path_linear {");
z_lg(Rarray_ptr, ss_offset, Rsubklass);
load_and_test_int(Rlength, Address(Rarray_ptr, length_offset));
branch_optimized(Assembler::bcondZero, *L_failure);
// Oops in table are NO MORE compressed.
z_cg(Rsuperklass, base_offset, Rarray_ptr); // Check array element for match.
z_bre(match); // Shortcut for array length = 1.
// No match yet, so we must walk the array's elements.
z_lngfr(Rlength, Rlength);
z_sllg(Rlength, Rlength, LogBytesPerWord); // -#bytes of cache array
z_llill(Z_R1, BytesPerWord); // Set increment/end index.
add2reg(Rlength, 2 * BytesPerWord); // start index = -(n-2)*BytesPerWord
z_slgr(Rarray_ptr, Rlength); // start addr: += (n-2)*BytesPerWord
z_bru(loop_count);
BIND(loop_iterate);
z_cg(Rsuperklass, base_offset, Rlength, Rarray_ptr); // Check array element for match.
z_bre(match);
BIND(loop_count);
z_brxlg(Rlength, Z_R1, loop_iterate);
// Rsuperklass not found among secondary super classes -> failure.
branch_optimized(Assembler::bcondAlways, *L_failure);
// Got a hit. Return success (zero result). Set cache.
// Cache load doesn't happen here. For speed, it is directly emitted by the compiler.
BIND(match);
if (UseSecondarySupersCache) {
z_stg(Rsuperklass, sc_offset, Rsubklass); // Save result to cache.
}
final_jmp(*L_success);
// Exit to the surrounding code.
BIND(L_fallthrough);
#undef final_jmp
BLOCK_COMMENT("} check_klass_subtype_slow_path_linear");
}
// If Register r is invalid, remove a new register from
// available_regs, and add new register to regs_to_push.
Register MacroAssembler::allocate_if_noreg(Register r,
RegSetIterator<Register> &available_regs,
RegSet &regs_to_push) {
if (!r->is_valid()) {
r = *available_regs++;
regs_to_push += r;
}
return r;
}
// check_klass_subtype_slow_path_table() looks for super_klass in the
// hash table belonging to super_klass, branching to L_success or
// L_failure as appropriate. This is essentially a shim which
// allocates registers as necessary and then calls
// lookup_secondary_supers_table() to do the work. Any of the temp
// regs may be noreg, in which case this logic will choose some
// registers push and pop them from the stack.
void MacroAssembler::check_klass_subtype_slow_path_table(Register sub_klass,
Register super_klass,
Register temp_reg,
Register temp2_reg,
Register temp3_reg,
Register temp4_reg,
Register result_reg,
Label* L_success,
Label* L_failure,
bool set_cond_codes) {
BLOCK_COMMENT("check_klass_subtype_slow_path_table {");
RegSet temps = RegSet::of(temp_reg, temp2_reg, temp3_reg, temp4_reg);
assert_different_registers(sub_klass, super_klass, temp_reg, temp2_reg, temp4_reg);
Label L_fallthrough;
int label_nulls = 0;
if (L_success == nullptr) { L_success = &L_fallthrough; label_nulls++; }
if (L_failure == nullptr) { L_failure = &L_fallthrough; label_nulls++; }
assert(label_nulls <= 1, "at most one null in the batch");
RegSetIterator<Register> available_regs
// Z_R0 will be used to hold Z_R15(Z_SP) while pushing a new frame, So don't use that here.
// Z_R1 will be used to hold r_bitmap in lookup_secondary_supers_table_var, so can't be used
// Z_R2, Z_R3, Z_R4 will be used in secondary_supers_verify, for the failure reporting
= (RegSet::range(Z_R0, Z_R15) - temps - sub_klass - super_klass - Z_R1_scratch - Z_R0_scratch - Z_R2 - Z_R3 - Z_R4).begin();
RegSet pushed_regs;
temp_reg = allocate_if_noreg(temp_reg, available_regs, pushed_regs);
temp2_reg = allocate_if_noreg(temp2_reg, available_regs, pushed_regs);
temp3_reg = allocate_if_noreg(temp3_reg, available_regs, pushed_regs);;
temp4_reg = allocate_if_noreg(temp4_reg, available_regs, pushed_regs);
result_reg = allocate_if_noreg(result_reg, available_regs, pushed_regs);
const int frame_size = pushed_regs.size() * BytesPerWord + frame::z_abi_160_size;
// Push & save registers
{
int i = 0;
save_return_pc();
push_frame(frame_size);
for (auto it = pushed_regs.begin(); *it != noreg; i++) {
z_stg(*it++, i * BytesPerWord + frame::z_abi_160_size, Z_SP);
}
assert(i * BytesPerWord + frame::z_abi_160_size == frame_size, "sanity");
}
lookup_secondary_supers_table_var(sub_klass,
super_klass,
temp_reg, temp2_reg, temp3_reg, temp4_reg, result_reg);
// NOTE: Condition Code should not be altered before jump instruction below !!!!
z_cghi(result_reg, 0);
{
int i = 0;
for (auto it = pushed_regs.begin(); *it != noreg; ++i) {
z_lg(*it++, i * BytesPerWord + frame::z_abi_160_size, Z_SP);
}
assert(i * BytesPerWord + frame::z_abi_160_size == frame_size, "sanity");
pop_frame();
restore_return_pc();
}
// NB! Callers may assume that, when set_cond_codes is true, this
// code sets temp2_reg to a nonzero value.
if (set_cond_codes) {
z_lghi(temp2_reg, 1);
}
branch_optimized(bcondNotEqual, *L_failure);
if(L_success != &L_fallthrough) {
z_bru(*L_success);
}
bind(L_fallthrough);
BLOCK_COMMENT("} check_klass_subtype_slow_path_table");
}
void MacroAssembler::check_klass_subtype_slow_path(Register sub_klass,
Register super_klass,
Register temp_reg,
Register temp2_reg,
Label* L_success,
Label* L_failure,
bool set_cond_codes) {
BLOCK_COMMENT("check_klass_subtype_slow_path {");
if (UseSecondarySupersTable) {
check_klass_subtype_slow_path_table(sub_klass,
super_klass,
temp_reg,
temp2_reg,
/*temp3*/noreg,
/*temp4*/noreg,
/*result*/noreg,
L_success,
L_failure,
set_cond_codes);
} else {
check_klass_subtype_slow_path_linear(sub_klass,
super_klass,
temp_reg,
temp2_reg,
L_success,
L_failure,
set_cond_codes);
}
BLOCK_COMMENT("} check_klass_subtype_slow_path");
}
// Emitter for combining fast and slow path.
void MacroAssembler::check_klass_subtype(Register sub_klass,
Register super_klass,
Register temp1_reg,
Register temp2_reg,
Label& L_success) {
NearLabel failure;
BLOCK_COMMENT(err_msg("check_klass_subtype(%s subclass of %s) {", sub_klass->name(), super_klass->name()));
check_klass_subtype_fast_path(sub_klass, super_klass, temp1_reg,
&L_success, &failure, nullptr);
check_klass_subtype_slow_path(sub_klass, super_klass,
temp1_reg, temp2_reg, &L_success, nullptr);
BIND(failure);
BLOCK_COMMENT("} check_klass_subtype");
}
// scans r_count pointer sized words at [r_addr] for occurrence of r_value,
// generic (r_count must be >0)
// iff found: CC eq, r_result == 0
void MacroAssembler::repne_scan(Register r_addr, Register r_value, Register r_count, Register r_result) {
NearLabel L_loop, L_exit;
BLOCK_COMMENT("repne_scan {");
#ifdef ASSERT
z_chi(r_count, 0);
asm_assert(bcondHigh, "count must be positive", 11);
#endif
clear_reg(r_result, true /* whole_reg */, false /* set_cc */); // sets r_result=0, let's hope that search will be successful
bind(L_loop);
z_cg(r_value, Address(r_addr));
z_bre(L_exit); // branch on success
z_la(r_addr, wordSize, r_addr);
z_brct(r_count, L_loop);
// z_brct above doesn't change CC.
// If we reach here, then the value in r_value is not present. Set r_result to 1.
z_lghi(r_result, 1);
bind(L_exit);
BLOCK_COMMENT("} repne_scan");
}
// Ensure that the inline code and the stub are using the same registers.
#define LOOKUP_SECONDARY_SUPERS_TABLE_REGISTERS \
do { \
assert(r_super_klass == Z_ARG1 && \
r_array_base == Z_ARG5 && \
r_array_length == Z_ARG4 && \
(r_array_index == Z_ARG3 || r_array_index == noreg) && \
(r_sub_klass == Z_ARG2 || r_sub_klass == noreg) && \
(r_bitmap == Z_R10 || r_bitmap == noreg) && \
(r_result == Z_R11 || r_result == noreg), "registers must match s390.ad"); \
} while(0)
// Note: this method also kills Z_R1_scratch register on machines older than z15
void MacroAssembler::lookup_secondary_supers_table_const(Register r_sub_klass,
Register r_super_klass,
Register r_temp1,
Register r_temp2,
Register r_temp3,
Register r_temp4,
Register r_result,
u1 super_klass_slot) {
NearLabel L_done, L_failure;
BLOCK_COMMENT("lookup_secondary_supers_table_const {");
const Register
r_array_base = r_temp1,
r_array_length = r_temp2,
r_array_index = r_temp3,
r_bitmap = r_temp4;
LOOKUP_SECONDARY_SUPERS_TABLE_REGISTERS;
z_lg(r_bitmap, Address(r_sub_klass, Klass::secondary_supers_bitmap_offset()));
// First check the bitmap to see if super_klass might be present. If
// the bit is zero, we are certain that super_klass is not one of
// the secondary supers.
u1 bit = super_klass_slot;
int shift_count = Klass::SECONDARY_SUPERS_TABLE_MASK - bit;
z_sllg(r_array_index, r_bitmap, shift_count); // take the bit to 63rd location
// Initialize r_result with 0 (indicating success). If searching fails, r_result will be loaded
// with 1 (failure) at the end of this method.
clear_reg(r_result, true /* whole_reg */, false /* set_cc */); // r_result = 0
// We test the MSB of r_array_index, i.e., its sign bit
testbit(r_array_index, 63);
z_bfalse(L_failure); // if not set, then jump!!!
// We will consult the secondary-super array.
z_lg(r_array_base, Address(r_sub_klass, Klass::secondary_supers_offset()));
// The value i in r_array_index is >= 1, so even though r_array_base
// points to the length, we don't need to adjust it to point to the
// data.
assert(Array<Klass*>::base_offset_in_bytes() == wordSize, "Adjust this code");
// Get the first array index that can contain super_klass.
if (bit != 0) {
pop_count_long(r_array_index, r_array_index, Z_R1_scratch); // kills Z_R1_scratch on machines older than z15
// NB! r_array_index is off by 1. It is compensated by keeping r_array_base off by 1 word.
z_sllg(r_array_index, r_array_index, LogBytesPerWord); // scale
} else {
// Actually use index 0, but r_array_base and r_array_index are off by 1 word
// such that the sum is precise.
z_lghi(r_array_index, BytesPerWord); // for slow path (scaled)
}
z_cg(r_super_klass, Address(r_array_base, r_array_index));
branch_optimized(bcondEqual, L_done); // found a match; success
// Is there another entry to check? Consult the bitmap.
testbit(r_bitmap, (bit + 1) & Klass::SECONDARY_SUPERS_TABLE_MASK);
z_bfalse(L_failure);
// Linear probe. Rotate the bitmap so that the next bit to test is
// in Bit 2 for the look-ahead check in the slow path.
if (bit != 0) {
z_rllg(r_bitmap, r_bitmap, 64-bit); // rotate right
}
// Calls into the stub generated by lookup_secondary_supers_table_slow_path.
// Arguments: r_super_klass, r_array_base, r_array_index, r_bitmap.
// Kills: r_array_length.
// Returns: r_result
call_stub(StubRoutines::lookup_secondary_supers_table_slow_path_stub());
z_bru(L_done); // pass whatever result we got from a slow path
bind(L_failure);
z_lghi(r_result, 1);
bind(L_done);
BLOCK_COMMENT("} lookup_secondary_supers_table_const");
if (VerifySecondarySupers) {
verify_secondary_supers_table(r_sub_klass, r_super_klass, r_result,
r_temp1, r_temp2, r_temp3);
}
}
// At runtime, return 0 in result if r_super_klass is a superclass of
// r_sub_klass, otherwise return nonzero. Use this version of
// lookup_secondary_supers_table() if you don't know ahead of time
// which superclass will be searched for. Used by interpreter and
// runtime stubs. It is larger and has somewhat greater latency than
// the version above, which takes a constant super_klass_slot.
void MacroAssembler::lookup_secondary_supers_table_var(Register r_sub_klass,
Register r_super_klass,
Register temp1,
Register temp2,
Register temp3,
Register temp4,
Register result) {
assert_different_registers(r_sub_klass, r_super_klass, temp1, temp2, temp3, temp4, result, Z_R1_scratch);
Label L_done, L_failure;
BLOCK_COMMENT("lookup_secondary_supers_table_var {");
const Register
r_array_index = temp3,
slot = temp4, // NOTE: "slot" can't be Z_R0 otherwise z_sllg and z_rllg instructions below will mess up!!!!
r_bitmap = Z_R1_scratch;
z_llgc(slot, Address(r_super_klass, Klass::hash_slot_offset()));
// Initialize r_result with 0 (indicating success). If searching fails, r_result will be loaded
// with 1 (failure) at the end of this method.
clear_reg(result, true /* whole_reg */, false /* set_cc */); // result = 0
z_lg(r_bitmap, Address(r_sub_klass, Klass::secondary_supers_bitmap_offset()));
// First check the bitmap to see if super_klass might be present. If
// the bit is zero, we are certain that super_klass is not one of
// the secondary supers.
z_xilf(slot, (u1)(Klass::SECONDARY_SUPERS_TABLE_SIZE - 1)); // slot ^ 63 === 63 - slot (mod 64)
z_sllg(r_array_index, r_bitmap, /*d2 = */ 0, /* b2 = */ slot);
testbit(r_array_index, Klass::SECONDARY_SUPERS_TABLE_SIZE - 1);
branch_optimized(bcondAllZero, L_failure);
const Register
r_array_base = temp1,
r_array_length = temp2;
// Get the first array index that can contain super_klass into r_array_index.
// NOTE: Z_R1_scratch is holding bitmap (look above for r_bitmap). So let's try to save it.
// On the other hand, r_array_base/temp1 is free at current moment (look at the load operation below).
pop_count_long(r_array_index, r_array_index, temp1); // kills r_array_base/temp1 on machines older than z15
// The value i in r_array_index is >= 1, so even though r_array_base
// points to the length, we don't need to adjust it to point to the data.
assert(Array<Klass*>::base_offset_in_bytes() == wordSize, "Adjust this code");
assert(Array<Klass*>::length_offset_in_bytes() == 0, "Adjust this code");
// We will consult the secondary-super array.
z_lg(r_array_base, Address(r_sub_klass, in_bytes(Klass::secondary_supers_offset())));
// NB! r_array_index is off by 1. It is compensated by keeping r_array_base off by 1 word.
z_sllg(r_array_index, r_array_index, LogBytesPerWord); // scale, r_array_index is loaded by popcnt above
z_cg(r_super_klass, Address(r_array_base, r_array_index));
branch_optimized(bcondEqual, L_done); // found a match
// Note: this is a small hack:
//
// The operation "(slot ^ 63) === 63 - slot (mod 64)" has already been performed above.
// Since we lack a rotate-right instruction, we achieve the same effect by rotating left
// by "64 - slot" positions. This produces the result equivalent to a right rotation by "slot" positions.
//
// => initial slot value
// => slot = 63 - slot // done above with that z_xilf instruction
// => slot = 64 - slot // need to do for rotating right by "slot" positions
// => slot = 64 - (63 - slot)
// => slot = slot - 63 + 64
// => slot = slot + 1
//
// So instead of rotating-left by 64-slot times, we can, for now, just rotate left by slot+1 and it would be fine.
// Linear probe. Rotate the bitmap so that the next bit to test is
// in Bit 1.
z_aghi(slot, 1); // slot = slot + 1
z_rllg(r_bitmap, r_bitmap, /*d2=*/ 0, /*b2=*/ slot);
testbit(r_bitmap, 1);
branch_optimized(bcondAllZero, L_failure);
// The slot we just inspected is at secondary_supers[r_array_index - 1].
// The next slot to be inspected, by the logic we're about to call,
// is secondary_supers[r_array_index]. Bits 0 and 1 in the bitmap
// have been checked.
lookup_secondary_supers_table_slow_path(r_super_klass, r_array_base, r_array_index,
r_bitmap, /*temp=*/ r_array_length, result, /*is_stub*/false);
// pass whatever we got from slow path
z_bru(L_done);
bind(L_failure);
z_lghi(result, 1); // load 1 to represent failure
bind(L_done);
BLOCK_COMMENT("} lookup_secondary_supers_table_var");
if (VerifySecondarySupers) {
verify_secondary_supers_table(r_sub_klass, r_super_klass, result,
temp1, temp2, temp3);
}
}
// Called by code generated by check_klass_subtype_slow_path
// above. This is called when there is a collision in the hashed
// lookup in the secondary supers array.
void MacroAssembler::lookup_secondary_supers_table_slow_path(Register r_super_klass,
Register r_array_base,
Register r_array_index,
Register r_bitmap,
Register r_temp,
Register r_result,
bool is_stub) {
assert_different_registers(r_super_klass, r_array_base, r_array_index, r_bitmap, r_result, r_temp);
const Register
r_array_length = r_temp,
r_sub_klass = noreg;
if(is_stub) {
LOOKUP_SECONDARY_SUPERS_TABLE_REGISTERS;
}
BLOCK_COMMENT("lookup_secondary_supers_table_slow_path {");
NearLabel L_done, L_failure;
// Load the array length.
z_llgf(r_array_length, Address(r_array_base, Array<Klass*>::length_offset_in_bytes()));
// And adjust the array base to point to the data.
// NB!
// Effectively increments the current slot index by 1.
assert(Array<Klass*>::base_offset_in_bytes() == wordSize, "");
add2reg(r_array_base, Array<Klass*>::base_offset_in_bytes());
// Linear probe
NearLabel L_huge;
// The bitmap is full to bursting.
z_chi(r_array_length, Klass::SECONDARY_SUPERS_BITMAP_FULL - 2);
z_brh(L_huge);
// NB! Our caller has checked bits 0 and 1 in the bitmap. The
// current slot (at secondary_supers[r_array_index]) has not yet
// been inspected, and r_array_index may be out of bounds if we
// wrapped around the end of the array.
{ // This is conventional linear probing, but instead of terminating
// when a null entry is found in the table, we maintain a bitmap
// in which a 0 indicates missing entries.
// As long as the bitmap is not completely full,
// array_length == popcount(bitmap). The array_length check above
// guarantees there are 0s in the bitmap, so the loop eventually
// terminates.
#ifdef ASSERT
// r_result is set to 0 by lookup_secondary_supers_table.
// clear_reg(r_result, true /* whole_reg */, false /* set_cc */);
z_cghi(r_result, 0);
asm_assert(bcondEqual, "r_result required to be 0, used by z_locgr", 44);
// We should only reach here after having found a bit in the bitmap.
z_ltgr(r_array_length, r_array_length);
asm_assert(bcondHigh, "array_length > 0, should hold", 22);
#endif // ASSERT
// Compute limit in r_array_length
add2reg(r_array_length, -1);
z_sllg(r_array_length, r_array_length, LogBytesPerWord);
NearLabel L_loop;
bind(L_loop);
// Check for wraparound.
z_cgr(r_array_index, r_array_length);
z_locgr(r_array_index, r_result, bcondHigh); // r_result is containing 0
z_cg(r_super_klass, Address(r_array_base, r_array_index));
z_bre(L_done); // success
// look-ahead check: if Bit 2 is 0, we're done
testbit(r_bitmap, 2);
z_bfalse(L_failure);
z_rllg(r_bitmap, r_bitmap, 64-1); // rotate right
add2reg(r_array_index, BytesPerWord);
z_bru(L_loop);
}
{ // Degenerate case: more than 64 secondary supers.
// FIXME: We could do something smarter here, maybe a vectorized
// comparison or a binary search, but is that worth any added
// complexity?
bind(L_huge);
repne_scan(r_array_base, r_super_klass, r_array_length, r_result);
z_bru(L_done); // forward the result we got from repne_scan
}
bind(L_failure);
z_lghi(r_result, 1);
bind(L_done);
BLOCK_COMMENT("} lookup_secondary_supers_table_slow_path");
}
// Make sure that the hashed lookup and a linear scan agree.
void MacroAssembler::verify_secondary_supers_table(Register r_sub_klass,
Register r_super_klass,
Register r_result /* expected */,
Register r_temp1,
Register r_temp2,
Register r_temp3) {
assert_different_registers(r_sub_klass, r_super_klass, r_result, r_temp1, r_temp2, r_temp3);
const Register
r_array_base = r_temp1,
r_array_length = r_temp2,
r_array_index = r_temp3,
r_bitmap = noreg; // unused
BLOCK_COMMENT("verify_secondary_supers_table {");
Label L_passed, L_failure;
// We will consult the secondary-super array.
z_lg(r_array_base, Address(r_sub_klass, in_bytes(Klass::secondary_supers_offset())));
// Load the array length.
z_llgf(r_array_length, Address(r_array_base, Array<Klass*>::length_offset_in_bytes()));
// And adjust the array base to point to the data.
z_aghi(r_array_base, Array<Klass*>::base_offset_in_bytes());
const Register r_linear_result = r_array_index; // reuse
z_chi(r_array_length, 0);
load_on_condition_imm_32(r_linear_result, 1, bcondNotHigh); // load failure if array_length <= 0
z_brc(bcondNotHigh, L_failure);
repne_scan(r_array_base, r_super_klass, r_array_length, r_linear_result);
bind(L_failure);
z_cr(r_result, r_linear_result);
z_bre(L_passed);
// report fatal error and terminate VM
// Argument shuffle
// Z_F1, Z_F3, Z_F5 are volatile regs
z_ldgr(Z_F1, r_super_klass);
z_ldgr(Z_F3, r_sub_klass);
z_ldgr(Z_F5, r_linear_result);
z_lgr(Z_ARG4, r_result);
z_lgdr(Z_ARG1, Z_F1); // r_super_klass
z_lgdr(Z_ARG2, Z_F3); // r_sub_klass
z_lgdr(Z_ARG3, Z_F5); // r_linear_result
const char* msg = "mismatch";
load_const_optimized(Z_ARG5, (address)msg);
call_VM_leaf(CAST_FROM_FN_PTR(address, Klass::on_secondary_supers_verification_failure));
should_not_reach_here();
bind(L_passed);
BLOCK_COMMENT("} verify_secondary_supers_table");
}
void MacroAssembler::clinit_barrier(Register klass, Register thread, Label* L_fast_path, Label* L_slow_path) {
assert(L_fast_path != nullptr || L_slow_path != nullptr, "at least one is required");
Label L_fallthrough;
if (L_fast_path == nullptr) {
L_fast_path = &L_fallthrough;
} else if (L_slow_path == nullptr) {
L_slow_path = &L_fallthrough;
}
// Fast path check: class is fully initialized.
// init_state needs acquire, but S390 is TSO, and so we are already good.
z_cli(Address(klass, InstanceKlass::init_state_offset()), InstanceKlass::fully_initialized);
z_bre(*L_fast_path);
// Fast path check: current thread is initializer thread
z_cg(thread, Address(klass, InstanceKlass::init_thread_offset()));
if (L_slow_path == &L_fallthrough) {
z_bre(*L_fast_path);
} else if (L_fast_path == &L_fallthrough) {
z_brne(*L_slow_path);
} else {
Unimplemented();
}
bind(L_fallthrough);
}
// Increment a counter at counter_address when the eq condition code is
// set. Kills registers tmp1_reg and tmp2_reg and preserves the condition code.
void MacroAssembler::increment_counter_eq(address counter_address, Register tmp1_reg, Register tmp2_reg) {
Label l;
z_brne(l);
load_const(tmp1_reg, counter_address);
add2mem_32(Address(tmp1_reg), 1, tmp2_reg);
z_cr(tmp1_reg, tmp1_reg); // Set cc to eq.
bind(l);
}
void MacroAssembler::resolve_jobject(Register value, Register tmp1, Register tmp2) {
BarrierSetAssembler* bs = BarrierSet::barrier_set()->barrier_set_assembler();
bs->resolve_jobject(this, value, tmp1, tmp2);
}
void MacroAssembler::resolve_global_jobject(Register value, Register tmp1, Register tmp2) {
BarrierSetAssembler* bs = BarrierSet::barrier_set()->barrier_set_assembler();
bs->resolve_global_jobject(this, value, tmp1, tmp2);
}
// Last_Java_sp must comply to the rules in frame_s390.hpp.
void MacroAssembler::set_last_Java_frame(Register last_Java_sp, Register last_Java_pc, bool allow_relocation) {
BLOCK_COMMENT("set_last_Java_frame {");
// Always set last_Java_pc and flags first because once last_Java_sp
// is visible has_last_Java_frame is true and users will look at the
// rest of the fields. (Note: flags should always be zero before we
// get here so doesn't need to be set.)
// Verify that last_Java_pc was zeroed on return to Java.
if (allow_relocation) {
asm_assert_mem8_is_zero(in_bytes(JavaThread::last_Java_pc_offset()),
Z_thread,
"last_Java_pc not zeroed before leaving Java",
0x200);
} else {
asm_assert_mem8_is_zero_static(in_bytes(JavaThread::last_Java_pc_offset()),
Z_thread,
"last_Java_pc not zeroed before leaving Java",
0x200);
}
// When returning from calling out from Java mode the frame anchor's
// last_Java_pc will always be set to null. It is set here so that
// if we are doing a call to native (not VM) that we capture the
// known pc and don't have to rely on the native call having a
// standard frame linkage where we can find the pc.
if (last_Java_pc!=noreg) {
z_stg(last_Java_pc, Address(Z_thread, JavaThread::last_Java_pc_offset()));
}
// This membar release is not required on z/Architecture, since the sequence of stores
// in maintained. Nevertheless, we leave it in to document the required ordering.
// The implementation of z_release() should be empty.
// z_release();
z_stg(last_Java_sp, Address(Z_thread, JavaThread::last_Java_sp_offset()));
BLOCK_COMMENT("} set_last_Java_frame");
}
void MacroAssembler::reset_last_Java_frame(bool allow_relocation) {
BLOCK_COMMENT("reset_last_Java_frame {");
if (allow_relocation) {
asm_assert_mem8_isnot_zero(in_bytes(JavaThread::last_Java_sp_offset()),
Z_thread,
"SP was not set, still zero",
0x202);
} else {
asm_assert_mem8_isnot_zero_static(in_bytes(JavaThread::last_Java_sp_offset()),
Z_thread,
"SP was not set, still zero",
0x202);
}
// _last_Java_sp = 0
// Clearing storage must be atomic here, so don't use clear_mem()!
store_const(Address(Z_thread, JavaThread::last_Java_sp_offset()), 0);
// _last_Java_pc = 0
store_const(Address(Z_thread, JavaThread::last_Java_pc_offset()), 0);
BLOCK_COMMENT("} reset_last_Java_frame");
return;
}
void MacroAssembler::set_top_ijava_frame_at_SP_as_last_Java_frame(Register sp, Register tmp1, bool allow_relocation) {
assert_different_registers(sp, tmp1);
// We cannot trust that code generated by the C++ compiler saves R14
// to z_abi_160.return_pc, because sometimes it spills R14 using stmg at
// z_abi_160.gpr14 (e.g. InterpreterRuntime::_new()).
// Therefore we load the PC into tmp1 and let set_last_Java_frame() save
// it into the frame anchor.
get_PC(tmp1);
set_last_Java_frame(/*sp=*/sp, /*pc=*/tmp1, allow_relocation);
}
void MacroAssembler::set_thread_state(JavaThreadState new_state) {
z_release();
assert(Immediate::is_uimm16(_thread_max_state), "enum value out of range for instruction");
assert(sizeof(JavaThreadState) == sizeof(int), "enum value must have base type int");
store_const(Address(Z_thread, JavaThread::thread_state_offset()), new_state, Z_R0, false);
}
void MacroAssembler::get_vm_result_oop(Register oop_result) {
z_lg(oop_result, Address(Z_thread, JavaThread::vm_result_oop_offset()));
clear_mem(Address(Z_thread, JavaThread::vm_result_oop_offset()), sizeof(void*));
verify_oop(oop_result, FILE_AND_LINE);
}
void MacroAssembler::get_vm_result_metadata(Register result) {
z_lg(result, Address(Z_thread, JavaThread::vm_result_metadata_offset()));
clear_mem(Address(Z_thread, JavaThread::vm_result_metadata_offset()), sizeof(void*));
}
// We require that C code which does not return a value in vm_result will
// leave it undisturbed.
void MacroAssembler::set_vm_result(Register oop_result) {
z_stg(oop_result, Address(Z_thread, JavaThread::vm_result_oop_offset()));
}
// Explicit null checks (used for method handle code).
void MacroAssembler::null_check(Register reg, Register tmp, int64_t offset) {
if (!ImplicitNullChecks) {
NearLabel ok;
compare64_and_branch(reg, (intptr_t) 0, Assembler::bcondNotEqual, ok);
// We just put the address into reg if it was 0 (tmp==Z_R0 is allowed so we can't use it for the address).
address exception_entry = Interpreter::throw_NullPointerException_entry();
load_absolute_address(reg, exception_entry);
z_br(reg);
bind(ok);
} else {
if (needs_explicit_null_check((intptr_t)offset)) {
// Provoke OS null exception if reg is null by
// accessing M[reg] w/o changing any registers.
z_lg(tmp, 0, reg);
}
// else
// Nothing to do, (later) access of M[reg + offset]
// will provoke OS null exception if reg is null.
}
}
//-------------------------------------
// Compressed Klass Pointers
//-------------------------------------
// Klass oop manipulations if compressed.
void MacroAssembler::encode_klass_not_null(Register dst, Register src) {
Register current = (src != noreg) ? src : dst; // Klass is in dst if no src provided. (dst == src) also possible.
address base = CompressedKlassPointers::base();
int shift = CompressedKlassPointers::shift();
bool need_zero_extend = base != nullptr;
assert(UseCompressedClassPointers, "only for compressed klass ptrs");
BLOCK_COMMENT("cKlass encoder {");
#ifdef ASSERT
Label ok;
z_tmll(current, CompressedKlassPointers::klass_alignment_in_bytes() - 1); // Check alignment.
z_brc(Assembler::bcondAllZero, ok);
// The plain disassembler does not recognize illtrap. It instead displays
// a 32-bit value. Issuing two illtraps assures the disassembler finds
// the proper beginning of the next instruction.
z_illtrap(0xee);
z_illtrap(0xee);
bind(ok);
#endif
// Scale down the incoming klass pointer first.
// We then can be sure we calculate an offset that fits into 32 bit.
// More generally speaking: all subsequent calculations are purely 32-bit.
if (shift != 0) {
z_srlg(dst, current, shift);
current = dst;
}
if (base != nullptr) {
// Use scaled-down base address parts to match scaled-down klass pointer.
unsigned int base_h = ((unsigned long)base)>>(32+shift);
unsigned int base_l = (unsigned int)(((unsigned long)base)>>shift);
// General considerations:
// - when calculating (current_h - base_h), all digits must cancel (become 0).
// Otherwise, we would end up with a compressed klass pointer which doesn't
// fit into 32-bit.
// - Only bit#33 of the difference could potentially be non-zero. For that
// to happen, (current_l < base_l) must hold. In this case, the subtraction
// will create a borrow out of bit#32, nicely killing bit#33.
// - With the above, we only need to consider current_l and base_l to
// calculate the result.
// - Both values are treated as unsigned. The unsigned subtraction is
// replaced by adding (unsigned) the 2's complement of the subtrahend.
if (base_l == 0) {
// - By theory, the calculation to be performed here (current_h - base_h) MUST
// cancel all high-word bits. Otherwise, we would end up with an offset
// (i.e. compressed klass pointer) that does not fit into 32 bit.
// - current_l remains unchanged.
// - Therefore, we can replace all calculation with just a
// zero-extending load 32 to 64 bit.
// - Even that can be replaced with a conditional load if dst != current.
// (this is a local view. The shift step may have requested zero-extension).
} else {
if ((base_h == 0) && is_uimm(base_l, 31)) {
// If we happen to find that (base_h == 0), and that base_l is within the range
// which can be represented by a signed int, then we can use 64bit signed add with
// (-base_l) as 32bit signed immediate operand. The add will take care of the
// upper 32 bits of the result, saving us the need of an extra zero extension.
// For base_l to be in the required range, it must not have the most significant
// bit (aka sign bit) set.
lgr_if_needed(dst, current); // no zero/sign extension in this case!
z_agfi(dst, -(int)base_l); // base_l must be passed as signed.
need_zero_extend = false;
current = dst;
} else {
// To begin with, we may need to copy and/or zero-extend the register operand.
// We have to calculate (current_l - base_l). Because there is no unsigend
// subtract instruction with immediate operand, we add the 2's complement of base_l.
if (need_zero_extend) {
z_llgfr(dst, current);
need_zero_extend = false;
} else {
llgfr_if_needed(dst, current);
}
current = dst;
z_alfi(dst, -base_l);
}
}
}
if (need_zero_extend) {
// We must zero-extend the calculated result. It may have some leftover bits in
// the hi-word because we only did optimized calculations.
z_llgfr(dst, current);
} else {
llgfr_if_needed(dst, current); // zero-extension while copying comes at no extra cost.
}
BLOCK_COMMENT("} cKlass encoder");
}
// This function calculates the size of the code generated by
// decode_klass_not_null(register dst, Register src)
// when Universe::heap() isn't null. Hence, if the instructions
// it generates change, then this method needs to be updated.
int MacroAssembler::instr_size_for_decode_klass_not_null() {
address base = CompressedKlassPointers::base();
int shift_size = CompressedKlassPointers::shift() == 0 ? 0 : 6; /* sllg */
int addbase_size = 0;
assert(UseCompressedClassPointers, "only for compressed klass ptrs");
if (base != nullptr) {
unsigned int base_h = ((unsigned long)base)>>32;
unsigned int base_l = (unsigned int)((unsigned long)base);
if ((base_h != 0) && (base_l == 0) && VM_Version::has_HighWordInstr()) {
addbase_size += 6; /* aih */
} else if ((base_h == 0) && (base_l != 0)) {
addbase_size += 6; /* algfi */
} else {
addbase_size += load_const_size();
addbase_size += 4; /* algr */
}
}
#ifdef ASSERT
addbase_size += 10;
addbase_size += 2; // Extra sigill.
#endif
return addbase_size + shift_size;
}
// !!! If the instructions that get generated here change
// then function instr_size_for_decode_klass_not_null()
// needs to get updated.
// This variant of decode_klass_not_null() must generate predictable code!
// The code must only depend on globally known parameters.
void MacroAssembler::decode_klass_not_null(Register dst) {
address base = CompressedKlassPointers::base();
int shift = CompressedKlassPointers::shift();
int beg_off = offset();
assert(UseCompressedClassPointers, "only for compressed klass ptrs");
BLOCK_COMMENT("cKlass decoder (const size) {");
if (shift != 0) { // Shift required?
z_sllg(dst, dst, shift);
}
if (base != nullptr) {
unsigned int base_h = ((unsigned long)base)>>32;
unsigned int base_l = (unsigned int)((unsigned long)base);
if ((base_h != 0) && (base_l == 0) && VM_Version::has_HighWordInstr()) {
z_aih(dst, base_h); // Base has no set bits in lower half.
} else if ((base_h == 0) && (base_l != 0)) {
z_algfi(dst, base_l); // Base has no set bits in upper half.
} else {
load_const(Z_R0, base); // Base has set bits everywhere.
z_algr(dst, Z_R0);
}
}
#ifdef ASSERT
Label ok;
z_tmll(dst, CompressedKlassPointers::klass_alignment_in_bytes() - 1); // Check alignment.
z_brc(Assembler::bcondAllZero, ok);
// The plain disassembler does not recognize illtrap. It instead displays
// a 32-bit value. Issuing two illtraps assures the disassembler finds
// the proper beginning of the next instruction.
z_illtrap(0xd1);
z_illtrap(0xd1);
bind(ok);
#endif
assert(offset() == beg_off + instr_size_for_decode_klass_not_null(), "Code gen mismatch.");
BLOCK_COMMENT("} cKlass decoder (const size)");
}
// This variant of decode_klass_not_null() is for cases where
// 1) the size of the generated instructions may vary
// 2) the result is (potentially) stored in a register different from the source.
void MacroAssembler::decode_klass_not_null(Register dst, Register src) {
address base = CompressedKlassPointers::base();
int shift = CompressedKlassPointers::shift();
assert(UseCompressedClassPointers, "only for compressed klass ptrs");
BLOCK_COMMENT("cKlass decoder {");
if (src == noreg) src = dst;
if (shift != 0) { // Shift or at least move required?
z_sllg(dst, src, shift);
} else {
lgr_if_needed(dst, src);
}
if (base != nullptr) {
unsigned int base_h = ((unsigned long)base)>>32;
unsigned int base_l = (unsigned int)((unsigned long)base);
if ((base_h != 0) && (base_l == 0) && VM_Version::has_HighWordInstr()) {
z_aih(dst, base_h); // Base has not set bits in lower half.
} else if ((base_h == 0) && (base_l != 0)) {
z_algfi(dst, base_l); // Base has no set bits in upper half.
} else {
load_const_optimized(Z_R0, base); // Base has set bits everywhere.
z_algr(dst, Z_R0);
}
}
#ifdef ASSERT
Label ok;
z_tmll(dst, CompressedKlassPointers::klass_alignment_in_bytes() - 1); // Check alignment.
z_brc(Assembler::bcondAllZero, ok);
// The plain disassembler does not recognize illtrap. It instead displays
// a 32-bit value. Issuing two illtraps assures the disassembler finds
// the proper beginning of the next instruction.
z_illtrap(0xd2);
z_illtrap(0xd2);
bind(ok);
#endif
BLOCK_COMMENT("} cKlass decoder");
}
void MacroAssembler::load_klass(Register klass, Address mem) {
if (UseCompressedClassPointers) {
z_llgf(klass, mem);
// Attention: no null check here!
decode_klass_not_null(klass);
} else {
z_lg(klass, mem);
}
}
// Loads the obj's Klass* into dst.
// Input:
// src - the oop we want to load the klass from.
// dst - output nklass.
void MacroAssembler::load_narrow_klass_compact(Register dst, Register src) {
BLOCK_COMMENT("load_narrow_klass_compact {");
assert(UseCompactObjectHeaders, "expects UseCompactObjectHeaders");
z_lg(dst, Address(src, oopDesc::mark_offset_in_bytes()));
z_srlg(dst, dst, markWord::klass_shift);
BLOCK_COMMENT("} load_narrow_klass_compact");
}
void MacroAssembler::cmp_klass(Register klass, Register obj, Register tmp) {
BLOCK_COMMENT("cmp_klass {");
assert_different_registers(obj, klass, tmp);
if (UseCompactObjectHeaders) {
assert(tmp != noreg, "required");
assert_different_registers(klass, obj, tmp);
load_narrow_klass_compact(tmp, obj);
z_cr(klass, tmp);
} else if (UseCompressedClassPointers) {
z_c(klass, Address(obj, oopDesc::klass_offset_in_bytes()));
} else {
z_cg(klass, Address(obj, oopDesc::klass_offset_in_bytes()));
}
BLOCK_COMMENT("} cmp_klass");
}
void MacroAssembler::cmp_klasses_from_objects(Register obj1, Register obj2, Register tmp1, Register tmp2) {
BLOCK_COMMENT("cmp_klasses_from_objects {");
if (UseCompactObjectHeaders) {
assert(tmp1 != noreg && tmp2 != noreg, "required");
assert_different_registers(obj1, obj2, tmp1, tmp2);
load_narrow_klass_compact(tmp1, obj1);
load_narrow_klass_compact(tmp2, obj2);
z_cr(tmp1, tmp2);
} else if (UseCompressedClassPointers) {
z_l(tmp1, Address(obj1, oopDesc::klass_offset_in_bytes()));
z_c(tmp1, Address(obj2, oopDesc::klass_offset_in_bytes()));
} else {
z_lg(tmp1, Address(obj1, oopDesc::klass_offset_in_bytes()));
z_cg(tmp1, Address(obj2, oopDesc::klass_offset_in_bytes()));
}
BLOCK_COMMENT("} cmp_klasses_from_objects");
}
void MacroAssembler::load_klass(Register klass, Register src_oop) {
if (UseCompactObjectHeaders) {
load_narrow_klass_compact(klass, src_oop);
decode_klass_not_null(klass);
} else if (UseCompressedClassPointers) {
z_llgf(klass, oopDesc::klass_offset_in_bytes(), src_oop);
decode_klass_not_null(klass);
} else {
z_lg(klass, oopDesc::klass_offset_in_bytes(), src_oop);
}
}
void MacroAssembler::store_klass(Register klass, Register dst_oop, Register ck) {
assert(!UseCompactObjectHeaders, "Don't use with compact headers");
if (UseCompressedClassPointers) {
assert_different_registers(dst_oop, klass, Z_R0);
if (ck == noreg) ck = klass;
encode_klass_not_null(ck, klass);
z_st(ck, Address(dst_oop, oopDesc::klass_offset_in_bytes()));
} else {
z_stg(klass, Address(dst_oop, oopDesc::klass_offset_in_bytes()));
}
}
void MacroAssembler::store_klass_gap(Register s, Register d) {
assert(!UseCompactObjectHeaders, "Don't use with compact headers");
if (UseCompressedClassPointers) {
assert(s != d, "not enough registers");
// Support s = noreg.
if (s != noreg) {
z_st(s, Address(d, oopDesc::klass_gap_offset_in_bytes()));
} else {
z_mvhi(Address(d, oopDesc::klass_gap_offset_in_bytes()), 0);
}
}
}
// Compare klass ptr in memory against klass ptr in register.
//
// Rop1 - klass in register, always uncompressed.
// disp - Offset of klass in memory, compressed/uncompressed, depending on runtime flag.
// Rbase - Base address of cKlass in memory.
// maybenull - True if Rop1 possibly is a null.
void MacroAssembler::compare_klass_ptr(Register Rop1, int64_t disp, Register Rbase, bool maybenull) {
BLOCK_COMMENT("compare klass ptr {");
if (UseCompressedClassPointers) {
const int shift = CompressedKlassPointers::shift();
address base = CompressedKlassPointers::base();
if (UseCompactObjectHeaders) {
assert(shift >= 3, "cKlass encoder detected bad shift");
} else {
assert((shift == 0) || (shift == 3), "cKlass encoder detected bad shift");
}
assert_different_registers(Rop1, Z_R0);
assert_different_registers(Rop1, Rbase, Z_R1);
// First encode register oop and then compare with cOop in memory.
// This sequence saves an unnecessary cOop load and decode.
if (base == nullptr) {
if (shift == 0) {
z_cl(Rop1, disp, Rbase); // Unscaled
} else {
z_srlg(Z_R0, Rop1, shift); // ZeroBased
z_cl(Z_R0, disp, Rbase);
}
} else { // HeapBased
#ifdef ASSERT
bool used_R0 = true;
bool used_R1 = true;
#endif
Register current = Rop1;
Label done;
if (maybenull) { // null pointer must be preserved!
z_ltgr(Z_R0, current);
z_bre(done);
current = Z_R0;
}
unsigned int base_h = ((unsigned long)base)>>32;
unsigned int base_l = (unsigned int)((unsigned long)base);
if ((base_h != 0) && (base_l == 0) && VM_Version::has_HighWordInstr()) {
lgr_if_needed(Z_R0, current);
z_aih(Z_R0, -((int)base_h)); // Base has no set bits in lower half.
} else if ((base_h == 0) && (base_l != 0)) {
lgr_if_needed(Z_R0, current);
z_agfi(Z_R0, -(int)base_l);
} else {
int pow2_offset = get_oop_base_complement(Z_R1, ((uint64_t)(intptr_t)base));
add2reg_with_index(Z_R0, pow2_offset, Z_R1, Rop1); // Subtract base by adding complement.
}
if (shift != 0) {
z_srlg(Z_R0, Z_R0, shift);
}
bind(done);
z_cl(Z_R0, disp, Rbase);
#ifdef ASSERT
if (used_R0) preset_reg(Z_R0, 0xb05bUL, 2);
if (used_R1) preset_reg(Z_R1, 0xb06bUL, 2);
#endif
}
} else {
z_clg(Rop1, disp, Z_R0, Rbase);
}
BLOCK_COMMENT("} compare klass ptr");
}
//---------------------------
// Compressed oops
//---------------------------
void MacroAssembler::encode_heap_oop(Register oop) {
oop_encoder(oop, oop, true /*maybe null*/);
}
void MacroAssembler::encode_heap_oop_not_null(Register oop) {
oop_encoder(oop, oop, false /*not null*/);
}
// Called with something derived from the oop base. e.g. oop_base>>3.
int MacroAssembler::get_oop_base_pow2_offset(uint64_t oop_base) {
unsigned int oop_base_ll = ((unsigned int)(oop_base >> 0)) & 0xffff;
unsigned int oop_base_lh = ((unsigned int)(oop_base >> 16)) & 0xffff;
unsigned int oop_base_hl = ((unsigned int)(oop_base >> 32)) & 0xffff;
unsigned int oop_base_hh = ((unsigned int)(oop_base >> 48)) & 0xffff;
unsigned int n_notzero_parts = (oop_base_ll == 0 ? 0:1)
+ (oop_base_lh == 0 ? 0:1)
+ (oop_base_hl == 0 ? 0:1)
+ (oop_base_hh == 0 ? 0:1);
assert(oop_base != 0, "This is for HeapBased cOops only");
if (n_notzero_parts != 1) { // Check if oop_base is just a few pages shy of a power of 2.
uint64_t pow2_offset = 0x10000 - oop_base_ll;
if (pow2_offset < 0x8000) { // This might not be necessary.
uint64_t oop_base2 = oop_base + pow2_offset;
oop_base_ll = ((unsigned int)(oop_base2 >> 0)) & 0xffff;
oop_base_lh = ((unsigned int)(oop_base2 >> 16)) & 0xffff;
oop_base_hl = ((unsigned int)(oop_base2 >> 32)) & 0xffff;
oop_base_hh = ((unsigned int)(oop_base2 >> 48)) & 0xffff;
n_notzero_parts = (oop_base_ll == 0 ? 0:1) +
(oop_base_lh == 0 ? 0:1) +
(oop_base_hl == 0 ? 0:1) +
(oop_base_hh == 0 ? 0:1);
if (n_notzero_parts == 1) {
assert(-(int64_t)pow2_offset != (int64_t)-1, "We use -1 to signal uninitialized base register");
return -pow2_offset;
}
}
}
return 0;
}
// If base address is offset from a straight power of two by just a few pages,
// return this offset to the caller for a possible later composite add.
// TODO/FIX: will only work correctly for 4k pages.
int MacroAssembler::get_oop_base(Register Rbase, uint64_t oop_base) {
int pow2_offset = get_oop_base_pow2_offset(oop_base);
load_const_optimized(Rbase, oop_base - pow2_offset); // Best job possible.
return pow2_offset;
}
int MacroAssembler::get_oop_base_complement(Register Rbase, uint64_t oop_base) {
int offset = get_oop_base(Rbase, oop_base);
z_lcgr(Rbase, Rbase);
return -offset;
}
// Compare compressed oop in memory against oop in register.
// Rop1 - Oop in register.
// disp - Offset of cOop in memory.
// Rbase - Base address of cOop in memory.
// maybenull - True if Rop1 possibly is a null.
// maybenulltarget - Branch target for Rop1 == nullptr, if flow control shall NOT continue with compare instruction.
void MacroAssembler::compare_heap_oop(Register Rop1, Address mem, bool maybenull) {
Register Rbase = mem.baseOrR0();
Register Rindex = mem.indexOrR0();
int64_t disp = mem.disp();
const int shift = CompressedOops::shift();
address base = CompressedOops::base();
assert(UseCompressedOops, "must be on to call this method");
assert(Universe::heap() != nullptr, "java heap must be initialized to call this method");
assert((shift == 0) || (shift == LogMinObjAlignmentInBytes), "cOop encoder detected bad shift");
assert_different_registers(Rop1, Z_R0);
assert_different_registers(Rop1, Rbase, Z_R1);
assert_different_registers(Rop1, Rindex, Z_R1);
BLOCK_COMMENT("compare heap oop {");
// First encode register oop and then compare with cOop in memory.
// This sequence saves an unnecessary cOop load and decode.
if (base == nullptr) {
if (shift == 0) {
z_cl(Rop1, disp, Rindex, Rbase); // Unscaled
} else {
z_srlg(Z_R0, Rop1, shift); // ZeroBased
z_cl(Z_R0, disp, Rindex, Rbase);
}
} else { // HeapBased
#ifdef ASSERT
bool used_R0 = true;
bool used_R1 = true;
#endif
Label done;
int pow2_offset = get_oop_base_complement(Z_R1, ((uint64_t)(intptr_t)base));
if (maybenull) { // null pointer must be preserved!
z_ltgr(Z_R0, Rop1);
z_bre(done);
}
add2reg_with_index(Z_R0, pow2_offset, Z_R1, Rop1);
z_srlg(Z_R0, Z_R0, shift);
bind(done);
z_cl(Z_R0, disp, Rindex, Rbase);
#ifdef ASSERT
if (used_R0) preset_reg(Z_R0, 0xb05bUL, 2);
if (used_R1) preset_reg(Z_R1, 0xb06bUL, 2);
#endif
}
BLOCK_COMMENT("} compare heap oop");
}
void MacroAssembler::access_store_at(BasicType type, DecoratorSet decorators,
const Address& addr, Register val,
Register tmp1, Register tmp2, Register tmp3) {
assert((decorators & ~(AS_RAW | IN_HEAP | IN_NATIVE | IS_ARRAY | IS_NOT_NULL |
ON_UNKNOWN_OOP_REF)) == 0, "unsupported decorator");
BarrierSetAssembler* bs = BarrierSet::barrier_set()->barrier_set_assembler();
decorators = AccessInternal::decorator_fixup(decorators, type);
bool as_raw = (decorators & AS_RAW) != 0;
if (as_raw) {
bs->BarrierSetAssembler::store_at(this, decorators, type,
addr, val,
tmp1, tmp2, tmp3);
} else {
bs->store_at(this, decorators, type,
addr, val,
tmp1, tmp2, tmp3);
}
}
void MacroAssembler::access_load_at(BasicType type, DecoratorSet decorators,
const Address& addr, Register dst,
Register tmp1, Register tmp2, Label *is_null) {
assert((decorators & ~(AS_RAW | IN_HEAP | IN_NATIVE | IS_ARRAY | IS_NOT_NULL |
ON_PHANTOM_OOP_REF | ON_WEAK_OOP_REF)) == 0, "unsupported decorator");
BarrierSetAssembler* bs = BarrierSet::barrier_set()->barrier_set_assembler();
decorators = AccessInternal::decorator_fixup(decorators, type);
bool as_raw = (decorators & AS_RAW) != 0;
if (as_raw) {
bs->BarrierSetAssembler::load_at(this, decorators, type,
addr, dst,
tmp1, tmp2, is_null);
} else {
bs->load_at(this, decorators, type,
addr, dst,
tmp1, tmp2, is_null);
}
}
void MacroAssembler::load_heap_oop(Register dest, const Address &a,
Register tmp1, Register tmp2,
DecoratorSet decorators, Label *is_null) {
access_load_at(T_OBJECT, IN_HEAP | decorators, a, dest, tmp1, tmp2, is_null);
}
void MacroAssembler::store_heap_oop(Register Roop, const Address &a,
Register tmp1, Register tmp2, Register tmp3,
DecoratorSet decorators) {
access_store_at(T_OBJECT, IN_HEAP | decorators, a, Roop, tmp1, tmp2, tmp3);
}
//-------------------------------------------------
// Encode compressed oop. Generally usable encoder.
//-------------------------------------------------
// Rsrc - contains regular oop on entry. It remains unchanged.
// Rdst - contains compressed oop on exit.
// Rdst and Rsrc may indicate same register, in which case Rsrc does not remain unchanged.
//
// Rdst must not indicate scratch register Z_R1 (Z_R1_scratch) for functionality.
// Rdst should not indicate scratch register Z_R0 (Z_R0_scratch) for performance.
//
// only32bitValid is set, if later code only uses the lower 32 bits. In this
// case we must not fix the upper 32 bits.
void MacroAssembler::oop_encoder(Register Rdst, Register Rsrc, bool maybenull,
Register Rbase, int pow2_offset, bool only32bitValid) {
const address oop_base = CompressedOops::base();
const int oop_shift = CompressedOops::shift();
const bool disjoint = CompressedOops::base_disjoint();
assert(UseCompressedOops, "must be on to call this method");
assert(Universe::heap() != nullptr, "java heap must be initialized to call this encoder");
assert((oop_shift == 0) || (oop_shift == LogMinObjAlignmentInBytes), "cOop encoder detected bad shift");
if (disjoint || (oop_base == nullptr)) {
BLOCK_COMMENT("cOop encoder zeroBase {");
if (oop_shift == 0) {
if (oop_base != nullptr && !only32bitValid) {
z_llgfr(Rdst, Rsrc); // Clear upper bits in case the register will be decoded again.
} else {
lgr_if_needed(Rdst, Rsrc);
}
} else {
z_srlg(Rdst, Rsrc, oop_shift);
if (oop_base != nullptr && !only32bitValid) {
z_llgfr(Rdst, Rdst); // Clear upper bits in case the register will be decoded again.
}
}
BLOCK_COMMENT("} cOop encoder zeroBase");
return;
}
bool used_R0 = false;
bool used_R1 = false;
BLOCK_COMMENT("cOop encoder general {");
assert_different_registers(Rdst, Z_R1);
assert_different_registers(Rsrc, Rbase);
if (maybenull) {
Label done;
// We reorder shifting and subtracting, so that we can compare
// and shift in parallel:
//
// cycle 0: potential LoadN, base = <const>
// cycle 1: base = !base dst = src >> 3, cmp cr = (src != 0)
// cycle 2: if (cr) br, dst = dst + base + offset
// Get oop_base components.
if (pow2_offset == -1) {
if (Rdst == Rbase) {
if (Rdst == Z_R1 || Rsrc == Z_R1) {
Rbase = Z_R0;
used_R0 = true;
} else {
Rdst = Z_R1;
used_R1 = true;
}
}
if (Rbase == Z_R1) {
used_R1 = true;
}
pow2_offset = get_oop_base_complement(Rbase, ((uint64_t)(intptr_t)oop_base) >> oop_shift);
}
assert_different_registers(Rdst, Rbase);
// Check for null oop (must be left alone) and shift.
if (oop_shift != 0) { // Shift out alignment bits
if (((intptr_t)oop_base&0xc000000000000000L) == 0L) { // We are sure: no single address will have the leftmost bit set.
z_srag(Rdst, Rsrc, oop_shift); // Arithmetic shift sets the condition code.
} else {
z_srlg(Rdst, Rsrc, oop_shift);
z_ltgr(Rsrc, Rsrc); // This is the recommended way of testing for zero.
// This probably is faster, as it does not write a register. No!
// z_cghi(Rsrc, 0);
}
} else {
z_ltgr(Rdst, Rsrc); // Move null to result register.
}
z_bre(done);
// Subtract oop_base components.
if ((Rdst == Z_R0) || (Rbase == Z_R0)) {
z_algr(Rdst, Rbase);
if (pow2_offset != 0) { add2reg(Rdst, pow2_offset); }
} else {
add2reg_with_index(Rdst, pow2_offset, Rbase, Rdst);
}
if (!only32bitValid) {
z_llgfr(Rdst, Rdst); // Clear upper bits in case the register will be decoded again.
}
bind(done);
} else { // not null
// Get oop_base components.
if (pow2_offset == -1) {
pow2_offset = get_oop_base_complement(Rbase, (uint64_t)(intptr_t)oop_base);
}
// Subtract oop_base components and shift.
if (Rdst == Z_R0 || Rsrc == Z_R0 || Rbase == Z_R0) {
// Don't use lay instruction.
if (Rdst == Rsrc) {
z_algr(Rdst, Rbase);
} else {
lgr_if_needed(Rdst, Rbase);
z_algr(Rdst, Rsrc);
}
if (pow2_offset != 0) add2reg(Rdst, pow2_offset);
} else {
add2reg_with_index(Rdst, pow2_offset, Rbase, Rsrc);
}
if (oop_shift != 0) { // Shift out alignment bits.
z_srlg(Rdst, Rdst, oop_shift);
}
if (!only32bitValid) {
z_llgfr(Rdst, Rdst); // Clear upper bits in case the register will be decoded again.
}
}
#ifdef ASSERT
if (used_R0 && Rdst != Z_R0 && Rsrc != Z_R0) { preset_reg(Z_R0, 0xb01bUL, 2); }
if (used_R1 && Rdst != Z_R1 && Rsrc != Z_R1) { preset_reg(Z_R1, 0xb02bUL, 2); }
#endif
BLOCK_COMMENT("} cOop encoder general");
}
//-------------------------------------------------
// decode compressed oop. Generally usable decoder.
//-------------------------------------------------
// Rsrc - contains compressed oop on entry.
// Rdst - contains regular oop on exit.
// Rdst and Rsrc may indicate same register.
// Rdst must not be the same register as Rbase, if Rbase was preloaded (before call).
// Rdst can be the same register as Rbase. Then, either Z_R0 or Z_R1 must be available as scratch.
// Rbase - register to use for the base
// pow2_offset - offset of base to nice value. If -1, base must be loaded.
// For performance, it is good to
// - avoid Z_R0 for any of the argument registers.
// - keep Rdst and Rsrc distinct from Rbase. Rdst == Rsrc is ok for performance.
// - avoid Z_R1 for Rdst if Rdst == Rbase.
void MacroAssembler::oop_decoder(Register Rdst, Register Rsrc, bool maybenull, Register Rbase, int pow2_offset) {
const address oop_base = CompressedOops::base();
const int oop_shift = CompressedOops::shift();
const bool disjoint = CompressedOops::base_disjoint();
assert(UseCompressedOops, "must be on to call this method");
assert(Universe::heap() != nullptr, "java heap must be initialized to call this decoder");
assert((oop_shift == 0) || (oop_shift == LogMinObjAlignmentInBytes),
"cOop encoder detected bad shift");
// cOops are always loaded zero-extended from memory. No explicit zero-extension necessary.
if (oop_base != nullptr) {
unsigned int oop_base_hl = ((unsigned int)((uint64_t)(intptr_t)oop_base >> 32)) & 0xffff;
unsigned int oop_base_hh = ((unsigned int)((uint64_t)(intptr_t)oop_base >> 48)) & 0xffff;
unsigned int oop_base_hf = ((unsigned int)((uint64_t)(intptr_t)oop_base >> 32)) & 0xFFFFffff;
if (disjoint && (oop_base_hl == 0 || oop_base_hh == 0)) {
BLOCK_COMMENT("cOop decoder disjointBase {");
// We do not need to load the base. Instead, we can install the upper bits
// with an OR instead of an ADD.
Label done;
// Rsrc contains a narrow oop. Thus we are sure the leftmost <oop_shift> bits will never be set.
if (maybenull) { // null pointer must be preserved!
z_slag(Rdst, Rsrc, oop_shift); // Arithmetic shift sets the condition code.
z_bre(done);
} else {
z_sllg(Rdst, Rsrc, oop_shift); // Logical shift leaves condition code alone.
}
if ((oop_base_hl != 0) && (oop_base_hh != 0)) {
z_oihf(Rdst, oop_base_hf);
} else if (oop_base_hl != 0) {
z_oihl(Rdst, oop_base_hl);
} else {
assert(oop_base_hh != 0, "not heapbased mode");
z_oihh(Rdst, oop_base_hh);
}
bind(done);
BLOCK_COMMENT("} cOop decoder disjointBase");
} else {
BLOCK_COMMENT("cOop decoder general {");
// There are three decode steps:
// scale oop offset (shift left)
// get base (in reg) and pow2_offset (constant)
// add base, pow2_offset, and oop offset
// The following register overlap situations may exist:
// Rdst == Rsrc, Rbase any other
// not a problem. Scaling in-place leaves Rbase undisturbed.
// Loading Rbase does not impact the scaled offset.
// Rdst == Rbase, Rsrc any other
// scaling would destroy a possibly preloaded Rbase. Loading Rbase
// would destroy the scaled offset.
// Remedy: use Rdst_tmp if Rbase has been preloaded.
// use Rbase_tmp if base has to be loaded.
// Rsrc == Rbase, Rdst any other
// Only possible without preloaded Rbase.
// Loading Rbase does not destroy compressed oop because it was scaled into Rdst before.
// Rsrc == Rbase, Rdst == Rbase
// Only possible without preloaded Rbase.
// Loading Rbase would destroy compressed oop. Scaling in-place is ok.
// Remedy: use Rbase_tmp.
//
Label done;
Register Rdst_tmp = Rdst;
Register Rbase_tmp = Rbase;
bool used_R0 = false;
bool used_R1 = false;
bool base_preloaded = pow2_offset >= 0;
guarantee(!(base_preloaded && (Rsrc == Rbase)), "Register clash, check caller");
assert(oop_shift != 0, "room for optimization");
// Check if we need to use scratch registers.
if (Rdst == Rbase) {
assert(!(((Rdst == Z_R0) && (Rsrc == Z_R1)) || ((Rdst == Z_R1) && (Rsrc == Z_R0))), "need a scratch reg");
if (Rdst != Rsrc) {
if (base_preloaded) { Rdst_tmp = (Rdst == Z_R1) ? Z_R0 : Z_R1; }
else { Rbase_tmp = (Rdst == Z_R1) ? Z_R0 : Z_R1; }
} else {
Rbase_tmp = (Rdst == Z_R1) ? Z_R0 : Z_R1;
}
}
if (base_preloaded) lgr_if_needed(Rbase_tmp, Rbase);
// Scale oop and check for null.
// Rsrc contains a narrow oop. Thus we are sure the leftmost <oop_shift> bits will never be set.
if (maybenull) { // null pointer must be preserved!
z_slag(Rdst_tmp, Rsrc, oop_shift); // Arithmetic shift sets the condition code.
z_bre(done);
} else {
z_sllg(Rdst_tmp, Rsrc, oop_shift); // Logical shift leaves condition code alone.
}
// Get oop_base components.
if (!base_preloaded) {
pow2_offset = get_oop_base(Rbase_tmp, (uint64_t)(intptr_t)oop_base);
}
// Add up all components.
if ((Rbase_tmp == Z_R0) || (Rdst_tmp == Z_R0)) {
z_algr(Rdst_tmp, Rbase_tmp);
if (pow2_offset != 0) { add2reg(Rdst_tmp, pow2_offset); }
} else {
add2reg_with_index(Rdst_tmp, pow2_offset, Rbase_tmp, Rdst_tmp);
}
bind(done);
lgr_if_needed(Rdst, Rdst_tmp);
#ifdef ASSERT
if (used_R0 && Rdst != Z_R0 && Rsrc != Z_R0) { preset_reg(Z_R0, 0xb03bUL, 2); }
if (used_R1 && Rdst != Z_R1 && Rsrc != Z_R1) { preset_reg(Z_R1, 0xb04bUL, 2); }
#endif
BLOCK_COMMENT("} cOop decoder general");
}
} else {
BLOCK_COMMENT("cOop decoder zeroBase {");
if (oop_shift == 0) {
lgr_if_needed(Rdst, Rsrc);
} else {
z_sllg(Rdst, Rsrc, oop_shift);
}
BLOCK_COMMENT("} cOop decoder zeroBase");
}
}
// ((OopHandle)result).resolve();
void MacroAssembler::resolve_oop_handle(Register result) {
// OopHandle::resolve is an indirection.
z_lg(result, 0, result);
}
void MacroAssembler::load_mirror_from_const_method(Register mirror, Register const_method) {
mem2reg_opt(mirror, Address(const_method, ConstMethod::constants_offset()));
mem2reg_opt(mirror, Address(mirror, ConstantPool::pool_holder_offset()));
mem2reg_opt(mirror, Address(mirror, Klass::java_mirror_offset()));
resolve_oop_handle(mirror);
}
void MacroAssembler::load_method_holder(Register holder, Register method) {
mem2reg_opt(holder, Address(method, Method::const_offset()));
mem2reg_opt(holder, Address(holder, ConstMethod::constants_offset()));
mem2reg_opt(holder, Address(holder, ConstantPool::pool_holder_offset()));
}
//---------------------------------------------------------------
//--- Operations on arrays.
//---------------------------------------------------------------
// Compiler ensures base is doubleword aligned and cnt is #doublewords.
// Emitter does not KILL cnt and base arguments, since they need to be copied to
// work registers anyway.
// Actually, only r0, r1, and r5 are killed.
unsigned int MacroAssembler::Clear_Array(Register cnt_arg, Register base_pointer_arg, Register odd_tmp_reg) {
int block_start = offset();
Register dst_len = Z_R1; // Holds dst len for MVCLE.
Register dst_addr = Z_R0; // Holds dst addr for MVCLE.
Label doXC, doMVCLE, done;
BLOCK_COMMENT("Clear_Array {");
// Check for zero len and convert to long.
z_ltgfr(odd_tmp_reg, cnt_arg);
z_bre(done); // Nothing to do if len == 0.
// Prefetch data to be cleared.
if (VM_Version::has_Prefetch()) {
z_pfd(0x02, 0, Z_R0, base_pointer_arg);
z_pfd(0x02, 256, Z_R0, base_pointer_arg);
}
z_sllg(dst_len, odd_tmp_reg, 3); // #bytes to clear.
z_cghi(odd_tmp_reg, 32); // Check for len <= 256 bytes (<=32 DW).
z_brnh(doXC); // If so, use executed XC to clear.
// MVCLE: initialize long arrays (general case).
bind(doMVCLE);
z_lgr(dst_addr, base_pointer_arg);
// Pass 0 as source length to MVCLE: destination will be filled with padding byte 0.
// The even register of the register pair is not killed.
clear_reg(odd_tmp_reg, true, false);
MacroAssembler::move_long_ext(dst_addr, as_Register(odd_tmp_reg->encoding()-1), 0);
z_bru(done);
// XC: initialize short arrays.
Label XC_template; // Instr template, never exec directly!
bind(XC_template);
z_xc(0,0,base_pointer_arg,0,base_pointer_arg);
bind(doXC);
add2reg(dst_len, -1); // Get #bytes-1 for EXECUTE.
if (VM_Version::has_ExecuteExtensions()) {
z_exrl(dst_len, XC_template); // Execute XC with var. len.
} else {
z_larl(odd_tmp_reg, XC_template);
z_ex(dst_len,0,Z_R0,odd_tmp_reg); // Execute XC with var. len.
}
// z_bru(done); // fallthru
bind(done);
BLOCK_COMMENT("} Clear_Array");
int block_end = offset();
return block_end - block_start;
}
// Compiler ensures base is doubleword aligned and cnt is count of doublewords.
// Emitter does not KILL any arguments nor work registers.
// Emitter generates up to 16 XC instructions, depending on the array length.
unsigned int MacroAssembler::Clear_Array_Const(long cnt, Register base) {
int block_start = offset();
int off;
int lineSize_Bytes = AllocatePrefetchStepSize;
int lineSize_DW = AllocatePrefetchStepSize>>LogBytesPerWord;
bool doPrefetch = VM_Version::has_Prefetch();
int XC_maxlen = 256;
int numXCInstr = cnt > 0 ? (cnt*BytesPerWord-1)/XC_maxlen+1 : 0;
BLOCK_COMMENT("Clear_Array_Const {");
assert(cnt*BytesPerWord <= 4096, "ClearArrayConst can handle 4k only");
// Do less prefetching for very short arrays.
if (numXCInstr > 0) {
// Prefetch only some cache lines, then begin clearing.
if (doPrefetch) {
if (cnt*BytesPerWord <= lineSize_Bytes/4) { // If less than 1/4 of a cache line to clear,
z_pfd(0x02, 0, Z_R0, base); // prefetch just the first cache line.
} else {
assert(XC_maxlen == lineSize_Bytes, "ClearArrayConst needs 256B cache lines");
for (off = 0; (off < AllocatePrefetchLines) && (off <= numXCInstr); off ++) {
z_pfd(0x02, off*lineSize_Bytes, Z_R0, base);
}
}
}
for (off=0; off<(numXCInstr-1); off++) {
z_xc(off*XC_maxlen, XC_maxlen-1, base, off*XC_maxlen, base);
// Prefetch some cache lines in advance.
if (doPrefetch && (off <= numXCInstr-AllocatePrefetchLines)) {
z_pfd(0x02, (off+AllocatePrefetchLines)*lineSize_Bytes, Z_R0, base);
}
}
if (off*XC_maxlen < cnt*BytesPerWord) {
z_xc(off*XC_maxlen, (cnt*BytesPerWord-off*XC_maxlen)-1, base, off*XC_maxlen, base);
}
}
BLOCK_COMMENT("} Clear_Array_Const");
int block_end = offset();
return block_end - block_start;
}
// Compiler ensures base is doubleword aligned and cnt is #doublewords.
// Emitter does not KILL cnt and base arguments, since they need to be copied to
// work registers anyway.
// Actually, only r0, r1, (which are work registers) and odd_tmp_reg are killed.
//
// For very large arrays, exploit MVCLE H/W support.
// MVCLE instruction automatically exploits H/W-optimized page mover.
// - Bytes up to next page boundary are cleared with a series of XC to self.
// - All full pages are cleared with the page mover H/W assist.
// - Remaining bytes are again cleared by a series of XC to self.
//
unsigned int MacroAssembler::Clear_Array_Const_Big(long cnt, Register base_pointer_arg, Register odd_tmp_reg) {
int block_start = offset();
Register dst_len = Z_R1; // Holds dst len for MVCLE.
Register dst_addr = Z_R0; // Holds dst addr for MVCLE.
BLOCK_COMMENT("Clear_Array_Const_Big {");
// Get len to clear.
load_const_optimized(dst_len, (long)cnt*8L); // in Bytes = #DW*8
// Prepare other args to MVCLE.
z_lgr(dst_addr, base_pointer_arg);
// Pass 0 as source length to MVCLE: destination will be filled with padding byte 0.
// The even register of the register pair is not killed.
(void) clear_reg(odd_tmp_reg, true, false); // Src len of MVCLE is zero.
MacroAssembler::move_long_ext(dst_addr, as_Register(odd_tmp_reg->encoding() - 1), 0);
BLOCK_COMMENT("} Clear_Array_Const_Big");
int block_end = offset();
return block_end - block_start;
}
// Allocator.
unsigned int MacroAssembler::CopyRawMemory_AlignedDisjoint(Register src_reg, Register dst_reg,
Register cnt_reg,
Register tmp1_reg, Register tmp2_reg) {
// Tmp1 is oddReg.
// Tmp2 is evenReg.
int block_start = offset();
Label doMVC, doMVCLE, done, MVC_template;
BLOCK_COMMENT("CopyRawMemory_AlignedDisjoint {");
// Check for zero len and convert to long.
z_ltgfr(cnt_reg, cnt_reg); // Remember casted value for doSTG case.
z_bre(done); // Nothing to do if len == 0.
z_sllg(Z_R1, cnt_reg, 3); // Dst len in bytes. calc early to have the result ready.
z_cghi(cnt_reg, 32); // Check for len <= 256 bytes (<=32 DW).
z_brnh(doMVC); // If so, use executed MVC to clear.
bind(doMVCLE); // A lot of data (more than 256 bytes).
// Prep dest reg pair.
z_lgr(Z_R0, dst_reg); // dst addr
// Dst len already in Z_R1.
// Prep src reg pair.
z_lgr(tmp2_reg, src_reg); // src addr
z_lgr(tmp1_reg, Z_R1); // Src len same as dst len.
// Do the copy.
move_long_ext(Z_R0, tmp2_reg, 0xb0); // Bypass cache.
z_bru(done); // All done.
bind(MVC_template); // Just some data (not more than 256 bytes).
z_mvc(0, 0, dst_reg, 0, src_reg);
bind(doMVC);
if (VM_Version::has_ExecuteExtensions()) {
add2reg(Z_R1, -1);
} else {
add2reg(tmp1_reg, -1, Z_R1);
z_larl(Z_R1, MVC_template);
}
if (VM_Version::has_Prefetch()) {
z_pfd(1, 0,Z_R0,src_reg);
z_pfd(2, 0,Z_R0,dst_reg);
// z_pfd(1,256,Z_R0,src_reg); // Assume very short copy.
// z_pfd(2,256,Z_R0,dst_reg);
}
if (VM_Version::has_ExecuteExtensions()) {
z_exrl(Z_R1, MVC_template);
} else {
z_ex(tmp1_reg, 0, Z_R0, Z_R1);
}
bind(done);
BLOCK_COMMENT("} CopyRawMemory_AlignedDisjoint");
int block_end = offset();
return block_end - block_start;
}
//-------------------------------------------------
// Constants (scalar and oop) in constant pool
//-------------------------------------------------
// Add a non-relocated constant to the CP.
int MacroAssembler::store_const_in_toc(AddressLiteral& val) {
long value = val.value();
address tocPos = long_constant(value);
if (tocPos != nullptr) {
int tocOffset = (int)(tocPos - code()->consts()->start());
return tocOffset;
}
// Address_constant returned null, so no constant entry has been created.
// In that case, we return a "fatal" offset, just in case that subsequently
// generated access code is executed.
return -1;
}
// Returns the TOC offset where the address is stored.
// Add a relocated constant to the CP.
int MacroAssembler::store_oop_in_toc(AddressLiteral& oop) {
// Use RelocationHolder::none for the constant pool entry.
// Otherwise we will end up with a failing NativeCall::verify(x),
// where x is the address of the constant pool entry.
address tocPos = address_constant((address)oop.value(), RelocationHolder::none);
if (tocPos != nullptr) {
int tocOffset = (int)(tocPos - code()->consts()->start());
RelocationHolder rsp = oop.rspec();
Relocation *rel = rsp.reloc();
// Store toc_offset in relocation, used by call_far_patchable.
if ((relocInfo::relocType)rel->type() == relocInfo::runtime_call_w_cp_type) {
((runtime_call_w_cp_Relocation *)(rel))->set_constant_pool_offset(tocOffset);
}
// Relocate at the load's pc.
relocate(rsp);
return tocOffset;
}
// Address_constant returned null, so no constant entry has been created
// in that case, we return a "fatal" offset, just in case that subsequently
// generated access code is executed.
return -1;
}
bool MacroAssembler::load_const_from_toc(Register dst, AddressLiteral& a, Register Rtoc) {
int tocOffset = store_const_in_toc(a);
if (tocOffset == -1) return false;
address tocPos = tocOffset + code()->consts()->start();
assert((address)code()->consts()->start() != nullptr, "Please add CP address");
relocate(a.rspec());
load_long_pcrelative(dst, tocPos);
return true;
}
bool MacroAssembler::load_oop_from_toc(Register dst, AddressLiteral& a, Register Rtoc) {
int tocOffset = store_oop_in_toc(a);
if (tocOffset == -1) return false;
address tocPos = tocOffset + code()->consts()->start();
assert((address)code()->consts()->start() != nullptr, "Please add CP address");
load_addr_pcrelative(dst, tocPos);
return true;
}
// If the instruction sequence at the given pc is a load_const_from_toc
// sequence, return the value currently stored at the referenced position
// in the TOC.
intptr_t MacroAssembler::get_const_from_toc(address pc) {
assert(is_load_const_from_toc(pc), "must be load_const_from_pool");
long offset = get_load_const_from_toc_offset(pc);
address dataLoc = nullptr;
if (is_load_const_from_toc_pcrelative(pc)) {
dataLoc = pc + offset;
} else {
CodeBlob* cb = CodeCache::find_blob(pc);
assert(cb && cb->is_nmethod(), "sanity");
nmethod* nm = (nmethod*)cb;
dataLoc = nm->ctable_begin() + offset;
}
return *(intptr_t *)dataLoc;
}
// If the instruction sequence at the given pc is a load_const_from_toc
// sequence, copy the passed-in new_data value into the referenced
// position in the TOC.
void MacroAssembler::set_const_in_toc(address pc, unsigned long new_data, CodeBlob *cb) {
assert(is_load_const_from_toc(pc), "must be load_const_from_pool");
long offset = MacroAssembler::get_load_const_from_toc_offset(pc);
address dataLoc = nullptr;
if (is_load_const_from_toc_pcrelative(pc)) {
dataLoc = pc+offset;
} else {
nmethod* nm = CodeCache::find_nmethod(pc);
assert((cb == nullptr) || (nm == (nmethod*)cb), "instruction address should be in CodeBlob");
dataLoc = nm->ctable_begin() + offset;
}
if (*(unsigned long *)dataLoc != new_data) { // Prevent cache invalidation: update only if necessary.
*(unsigned long *)dataLoc = new_data;
}
}
// Dynamic TOC. Getter must only be called if "a" is a load_const_from_toc
// site. Verify by calling is_load_const_from_toc() before!!
// Offset is +/- 2**32 -> use long.
long MacroAssembler::get_load_const_from_toc_offset(address a) {
assert(is_load_const_from_toc_pcrelative(a), "expected pc relative load");
// expected code sequence:
// z_lgrl(t, simm32); len = 6
unsigned long inst;
unsigned int len = get_instruction(a, &inst);
return get_pcrel_offset(inst);
}
//**********************************************************************************
// inspection of generated instruction sequences for a particular pattern
//**********************************************************************************
bool MacroAssembler::is_load_const_from_toc_pcrelative(address a) {
#ifdef ASSERT
unsigned long inst;
unsigned int len = get_instruction(a+2, &inst);
if ((len == 6) && is_load_pcrelative_long(a) && is_call_pcrelative_long(inst)) {
const int range = 128;
Assembler::dump_code_range(tty, a, range, "instr(a) == z_lgrl && instr(a+2) == z_brasl");
VM_Version::z_SIGSEGV();
}
#endif
// expected code sequence:
// z_lgrl(t, relAddr32); len = 6
//TODO: verify accessed data is in CP, if possible.
return is_load_pcrelative_long(a); // TODO: might be too general. Currently, only lgrl is used.
}
bool MacroAssembler::is_load_const_from_toc_call(address a) {
return is_load_const_from_toc(a) && is_call_byregister(a + load_const_from_toc_size());
}
bool MacroAssembler::is_load_const_call(address a) {
return is_load_const(a) && is_call_byregister(a + load_const_size());
}
//-------------------------------------------------
// Emitters for some really CICS instructions
//-------------------------------------------------
void MacroAssembler::move_long_ext(Register dst, Register src, unsigned int pad) {
assert(dst->encoding()%2==0, "must be an even/odd register pair");
assert(src->encoding()%2==0, "must be an even/odd register pair");
assert(pad<256, "must be a padding BYTE");
Label retry;
bind(retry);
Assembler::z_mvcle(dst, src, pad);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
void MacroAssembler::compare_long_ext(Register left, Register right, unsigned int pad) {
assert(left->encoding() % 2 == 0, "must be an even/odd register pair");
assert(right->encoding() % 2 == 0, "must be an even/odd register pair");
assert(pad<256, "must be a padding BYTE");
Label retry;
bind(retry);
Assembler::z_clcle(left, right, pad, Z_R0);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
void MacroAssembler::compare_long_uni(Register left, Register right, unsigned int pad) {
assert(left->encoding() % 2 == 0, "must be an even/odd register pair");
assert(right->encoding() % 2 == 0, "must be an even/odd register pair");
assert(pad<=0xfff, "must be a padding HALFWORD");
assert(VM_Version::has_ETF2(), "instruction must be available");
Label retry;
bind(retry);
Assembler::z_clclu(left, right, pad, Z_R0);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
void MacroAssembler::search_string(Register end, Register start) {
assert(end->encoding() != 0, "end address must not be in R0");
assert(start->encoding() != 0, "start address must not be in R0");
Label retry;
bind(retry);
Assembler::z_srst(end, start);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
void MacroAssembler::search_string_uni(Register end, Register start) {
assert(end->encoding() != 0, "end address must not be in R0");
assert(start->encoding() != 0, "start address must not be in R0");
assert(VM_Version::has_ETF3(), "instruction must be available");
Label retry;
bind(retry);
Assembler::z_srstu(end, start);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
void MacroAssembler::kmac(Register srcBuff) {
assert(srcBuff->encoding() != 0, "src buffer address can't be in Z_R0");
assert(srcBuff->encoding() % 2 == 0, "src buffer/len must be an even/odd register pair");
Label retry;
bind(retry);
Assembler::z_kmac(Z_R0, srcBuff);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
void MacroAssembler::kimd(Register srcBuff) {
assert(srcBuff->encoding() != 0, "src buffer address can't be in Z_R0");
assert(srcBuff->encoding() % 2 == 0, "src buffer/len must be an even/odd register pair");
Label retry;
bind(retry);
Assembler::z_kimd(Z_R0, srcBuff);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
void MacroAssembler::klmd(Register srcBuff) {
assert(srcBuff->encoding() != 0, "src buffer address can't be in Z_R0");
assert(srcBuff->encoding() % 2 == 0, "src buffer/len must be an even/odd register pair");
Label retry;
bind(retry);
Assembler::z_klmd(Z_R0, srcBuff);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
void MacroAssembler::km(Register dstBuff, Register srcBuff) {
// DstBuff and srcBuff are allowed to be the same register (encryption in-place).
// DstBuff and srcBuff storage must not overlap destructively, and neither must overlap the parameter block.
assert(srcBuff->encoding() != 0, "src buffer address can't be in Z_R0");
assert(dstBuff->encoding() % 2 == 0, "dst buffer addr must be an even register");
assert(srcBuff->encoding() % 2 == 0, "src buffer addr/len must be an even/odd register pair");
Label retry;
bind(retry);
Assembler::z_km(dstBuff, srcBuff);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
void MacroAssembler::kmc(Register dstBuff, Register srcBuff) {
// DstBuff and srcBuff are allowed to be the same register (encryption in-place).
// DstBuff and srcBuff storage must not overlap destructively, and neither must overlap the parameter block.
assert(srcBuff->encoding() != 0, "src buffer address can't be in Z_R0");
assert(dstBuff->encoding() % 2 == 0, "dst buffer addr must be an even register");
assert(srcBuff->encoding() % 2 == 0, "src buffer addr/len must be an even/odd register pair");
Label retry;
bind(retry);
Assembler::z_kmc(dstBuff, srcBuff);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
void MacroAssembler::kmctr(Register dstBuff, Register ctrBuff, Register srcBuff) {
// DstBuff and srcBuff are allowed to be the same register (encryption in-place).
// DstBuff and srcBuff storage must not overlap destructively, and neither must overlap the parameter block.
assert(srcBuff->encoding() != 0, "src buffer address can't be in Z_R0");
assert(dstBuff->encoding() != 0, "dst buffer address can't be in Z_R0");
assert(ctrBuff->encoding() != 0, "ctr buffer address can't be in Z_R0");
assert(ctrBuff->encoding() % 2 == 0, "ctr buffer addr must be an even register");
assert(dstBuff->encoding() % 2 == 0, "dst buffer addr must be an even register");
assert(srcBuff->encoding() % 2 == 0, "src buffer addr/len must be an even/odd register pair");
Label retry;
bind(retry);
Assembler::z_kmctr(dstBuff, ctrBuff, srcBuff);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
void MacroAssembler::cksm(Register crcBuff, Register srcBuff) {
assert(srcBuff->encoding() % 2 == 0, "src buffer addr/len must be an even/odd register pair");
Label retry;
bind(retry);
Assembler::z_cksm(crcBuff, srcBuff);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
void MacroAssembler::translate_oo(Register r1, Register r2, uint m3) {
assert(r1->encoding() % 2 == 0, "dst addr/src len must be an even/odd register pair");
assert((m3 & 0b1110) == 0, "Unused mask bits must be zero");
Label retry;
bind(retry);
Assembler::z_troo(r1, r2, m3);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
void MacroAssembler::translate_ot(Register r1, Register r2, uint m3) {
assert(r1->encoding() % 2 == 0, "dst addr/src len must be an even/odd register pair");
assert((m3 & 0b1110) == 0, "Unused mask bits must be zero");
Label retry;
bind(retry);
Assembler::z_trot(r1, r2, m3);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
void MacroAssembler::translate_to(Register r1, Register r2, uint m3) {
assert(r1->encoding() % 2 == 0, "dst addr/src len must be an even/odd register pair");
assert((m3 & 0b1110) == 0, "Unused mask bits must be zero");
Label retry;
bind(retry);
Assembler::z_trto(r1, r2, m3);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
void MacroAssembler::translate_tt(Register r1, Register r2, uint m3) {
assert(r1->encoding() % 2 == 0, "dst addr/src len must be an even/odd register pair");
assert((m3 & 0b1110) == 0, "Unused mask bits must be zero");
Label retry;
bind(retry);
Assembler::z_trtt(r1, r2, m3);
Assembler::z_brc(Assembler::bcondOverflow /* CC==3 (iterate) */, retry);
}
//---------------------------------------
// Helpers for Intrinsic Emitters
//---------------------------------------
/**
* uint32_t crc;
* timesXtoThe32[crc & 0xFF] ^ (crc >> 8);
*/
void MacroAssembler::fold_byte_crc32(Register crc, Register val, Register table, Register tmp) {
assert_different_registers(crc, table, tmp);
assert_different_registers(val, table);
if (crc == val) { // Must rotate first to use the unmodified value.
rotate_then_insert(tmp, val, 56-2, 63-2, 2, true); // Insert byte 7 of val, shifted left by 2, into byte 6..7 of tmp, clear the rest.
z_srl(crc, 8); // Unsigned shift, clear leftmost 8 bits.
} else {
z_srl(crc, 8); // Unsigned shift, clear leftmost 8 bits.
rotate_then_insert(tmp, val, 56-2, 63-2, 2, true); // Insert byte 7 of val, shifted left by 2, into byte 6..7 of tmp, clear the rest.
}
z_x(crc, Address(table, tmp, 0));
}
/**
* uint32_t crc;
* timesXtoThe32[crc & 0xFF] ^ (crc >> 8);
*/
void MacroAssembler::fold_8bit_crc32(Register crc, Register table, Register tmp) {
fold_byte_crc32(crc, crc, table, tmp);
}
/**
* Emits code to update CRC-32 with a byte value according to constants in table.
*
* @param [in,out]crc Register containing the crc.
* @param [in]val Register containing the byte to fold into the CRC.
* @param [in]table Register containing the table of crc constants.
*
* uint32_t crc;
* val = crc_table[(val ^ crc) & 0xFF];
* crc = val ^ (crc >> 8);
*/
void MacroAssembler::update_byte_crc32(Register crc, Register val, Register table) {
z_xr(val, crc);
fold_byte_crc32(crc, val, table, val);
}
/**
* @param crc register containing existing CRC (32-bit)
* @param buf register pointing to input byte buffer (byte*)
* @param len register containing number of bytes
* @param table register pointing to CRC table
*/
void MacroAssembler::update_byteLoop_crc32(Register crc, Register buf, Register len, Register table, Register data) {
assert_different_registers(crc, buf, len, table, data);
Label L_mainLoop, L_done;
const int mainLoop_stepping = 1;
// Process all bytes in a single-byte loop.
z_ltr(len, len);
z_brnh(L_done);
bind(L_mainLoop);
z_llgc(data, Address(buf, (intptr_t)0));// Current byte of input buffer (zero extended). Avoids garbage in upper half of register.
add2reg(buf, mainLoop_stepping); // Advance buffer position.
update_byte_crc32(crc, data, table);
z_brct(len, L_mainLoop); // Iterate.
bind(L_done);
}
/**
* Emits code to update CRC-32 with a 4-byte value according to constants in table.
* Implementation according to jdk/src/share/native/java/util/zip/zlib-1.2.8/crc32.c.
*
*/
void MacroAssembler::update_1word_crc32(Register crc, Register buf, Register table, int bufDisp, int bufInc,
Register t0, Register t1, Register t2, Register t3) {
// This is what we implement (the DOBIG4 part):
//
// #define DOBIG4 c ^= *++buf4; \
// c = crc_table[4][c & 0xff] ^ crc_table[5][(c >> 8) & 0xff] ^ \
// crc_table[6][(c >> 16) & 0xff] ^ crc_table[7][c >> 24]
// #define DOBIG32 DOBIG4; DOBIG4; DOBIG4; DOBIG4; DOBIG4; DOBIG4; DOBIG4; DOBIG4
// Pre-calculate (constant) column offsets, use columns 4..7 for big-endian.
const int ix0 = 4*(4*CRC32_COLUMN_SIZE);
const int ix1 = 5*(4*CRC32_COLUMN_SIZE);
const int ix2 = 6*(4*CRC32_COLUMN_SIZE);
const int ix3 = 7*(4*CRC32_COLUMN_SIZE);
// XOR crc with next four bytes of buffer.
lgr_if_needed(t0, crc);
z_x(t0, Address(buf, bufDisp));
if (bufInc != 0) {
add2reg(buf, bufInc);
}
// Chop crc into 4 single-byte pieces, shifted left 2 bits, to form the table indices.
rotate_then_insert(t3, t0, 56-2, 63-2, 2, true); // ((c >> 0) & 0xff) << 2
rotate_then_insert(t2, t0, 56-2, 63-2, 2-8, true); // ((c >> 8) & 0xff) << 2
rotate_then_insert(t1, t0, 56-2, 63-2, 2-16, true); // ((c >> 16) & 0xff) << 2
rotate_then_insert(t0, t0, 56-2, 63-2, 2-24, true); // ((c >> 24) & 0xff) << 2
// XOR indexed table values to calculate updated crc.
z_ly(t2, Address(table, t2, (intptr_t)ix1));
z_ly(t0, Address(table, t0, (intptr_t)ix3));
z_xy(t2, Address(table, t3, (intptr_t)ix0));
z_xy(t0, Address(table, t1, (intptr_t)ix2));
z_xr(t0, t2); // Now t0 contains the updated CRC value.
lgr_if_needed(crc, t0);
}
/**
* @param crc register containing existing CRC (32-bit)
* @param buf register pointing to input byte buffer (byte*)
* @param len register containing number of bytes
* @param table register pointing to CRC table
*
* uses Z_R10..Z_R13 as work register. Must be saved/restored by caller!
*/
void MacroAssembler::kernel_crc32_1word(Register crc, Register buf, Register len, Register table,
Register t0, Register t1, Register t2, Register t3,
bool invertCRC) {
assert_different_registers(crc, buf, len, table);
Label L_mainLoop, L_tail;
Register data = t0;
Register ctr = Z_R0;
const int mainLoop_stepping = 4;
const int log_stepping = exact_log2(mainLoop_stepping);
// Don't test for len <= 0 here. This pathological case should not occur anyway.
// Optimizing for it by adding a test and a branch seems to be a waste of CPU cycles.
// The situation itself is detected and handled correctly by the conditional branches
// following aghi(len, -stepping) and aghi(len, +stepping).
if (invertCRC) {
not_(crc, noreg, false); // 1s complement of crc
}
// Check for short (<4 bytes) buffer.
z_srag(ctr, len, log_stepping);
z_brnh(L_tail);
z_lrvr(crc, crc); // Revert byte order because we are dealing with big-endian data.
rotate_then_insert(len, len, 64-log_stepping, 63, 0, true); // #bytes for tailLoop
BIND(L_mainLoop);
update_1word_crc32(crc, buf, table, 0, mainLoop_stepping, crc, t1, t2, t3);
z_brct(ctr, L_mainLoop); // Iterate.
z_lrvr(crc, crc); // Revert byte order back to original.
// Process last few (<8) bytes of buffer.
BIND(L_tail);
update_byteLoop_crc32(crc, buf, len, table, data);
if (invertCRC) {
not_(crc, noreg, false); // 1s complement of crc
}
}
/**
* @param crc register containing existing CRC (32-bit)
* @param buf register pointing to input byte buffer (byte*)
* @param len register containing number of bytes
* @param table register pointing to CRC table
*/
void MacroAssembler::kernel_crc32_1byte(Register crc, Register buf, Register len, Register table,
Register t0, Register t1, Register t2, Register t3,
bool invertCRC) {
assert_different_registers(crc, buf, len, table);
Register data = t0;
if (invertCRC) {
not_(crc, noreg, false); // 1s complement of crc
}
update_byteLoop_crc32(crc, buf, len, table, data);
if (invertCRC) {
not_(crc, noreg, false); // 1s complement of crc
}
}
void MacroAssembler::kernel_crc32_singleByte(Register crc, Register buf, Register len, Register table, Register tmp,
bool invertCRC) {
assert_different_registers(crc, buf, len, table, tmp);
if (invertCRC) {
not_(crc, noreg, false); // 1s complement of crc
}
z_llgc(tmp, Address(buf, (intptr_t)0)); // Current byte of input buffer (zero extended). Avoids garbage in upper half of register.
update_byte_crc32(crc, tmp, table);
if (invertCRC) {
not_(crc, noreg, false); // 1s complement of crc
}
}
void MacroAssembler::kernel_crc32_singleByteReg(Register crc, Register val, Register table,
bool invertCRC) {
assert_different_registers(crc, val, table);
if (invertCRC) {
not_(crc, noreg, false); // 1s complement of crc
}
update_byte_crc32(crc, val, table);
if (invertCRC) {
not_(crc, noreg, false); // 1s complement of crc
}
}
//
// Code for BigInteger::multiplyToLen() intrinsic.
//
// dest_lo += src1 + src2
// dest_hi += carry1 + carry2
// Z_R7 is destroyed !
void MacroAssembler::add2_with_carry(Register dest_hi, Register dest_lo,
Register src1, Register src2) {
clear_reg(Z_R7);
z_algr(dest_lo, src1);
z_alcgr(dest_hi, Z_R7);
z_algr(dest_lo, src2);
z_alcgr(dest_hi, Z_R7);
}
// Multiply 64 bit by 64 bit first loop.
void MacroAssembler::multiply_64_x_64_loop(Register x, Register xstart,
Register x_xstart,
Register y, Register y_idx,
Register z,
Register carry,
Register product,
Register idx, Register kdx) {
// jlong carry, x[], y[], z[];
// for (int idx=ystart, kdx=ystart+1+xstart; idx >= 0; idx--, kdx--) {
// huge_128 product = y[idx] * x[xstart] + carry;
// z[kdx] = (jlong)product;
// carry = (jlong)(product >>> 64);
// }
// z[xstart] = carry;
Label L_first_loop, L_first_loop_exit;
Label L_one_x, L_one_y, L_multiply;
z_aghi(xstart, -1);
z_brl(L_one_x); // Special case: length of x is 1.
// Load next two integers of x.
z_sllg(Z_R1_scratch, xstart, LogBytesPerInt);
mem2reg_opt(x_xstart, Address(x, Z_R1_scratch, 0));
bind(L_first_loop);
z_aghi(idx, -1);
z_brl(L_first_loop_exit);
z_aghi(idx, -1);
z_brl(L_one_y);
// Load next two integers of y.
z_sllg(Z_R1_scratch, idx, LogBytesPerInt);
mem2reg_opt(y_idx, Address(y, Z_R1_scratch, 0));
bind(L_multiply);
Register multiplicand = product->successor();
Register product_low = multiplicand;
lgr_if_needed(multiplicand, x_xstart);
z_mlgr(product, y_idx); // multiplicand * y_idx -> product::multiplicand
clear_reg(Z_R7);
z_algr(product_low, carry); // Add carry to result.
z_alcgr(product, Z_R7); // Add carry of the last addition.
add2reg(kdx, -2);
// Store result.
z_sllg(Z_R7, kdx, LogBytesPerInt);
reg2mem_opt(product_low, Address(z, Z_R7, 0));
lgr_if_needed(carry, product);
z_bru(L_first_loop);
bind(L_one_y); // Load one 32 bit portion of y as (0,value).
clear_reg(y_idx);
mem2reg_opt(y_idx, Address(y, (intptr_t) 0), false);
z_bru(L_multiply);
bind(L_one_x); // Load one 32 bit portion of x as (0,value).
clear_reg(x_xstart);
mem2reg_opt(x_xstart, Address(x, (intptr_t) 0), false);
z_bru(L_first_loop);
bind(L_first_loop_exit);
}
// Multiply 64 bit by 64 bit and add 128 bit.
void MacroAssembler::multiply_add_128_x_128(Register x_xstart, Register y,
Register z,
Register yz_idx, Register idx,
Register carry, Register product,
int offset) {
// huge_128 product = (y[idx] * x_xstart) + z[kdx] + carry;
// z[kdx] = (jlong)product;
Register multiplicand = product->successor();
Register product_low = multiplicand;
z_sllg(Z_R7, idx, LogBytesPerInt);
mem2reg_opt(yz_idx, Address(y, Z_R7, offset));
lgr_if_needed(multiplicand, x_xstart);
z_mlgr(product, yz_idx); // multiplicand * yz_idx -> product::multiplicand
mem2reg_opt(yz_idx, Address(z, Z_R7, offset));
add2_with_carry(product, product_low, carry, yz_idx);
z_sllg(Z_R7, idx, LogBytesPerInt);
reg2mem_opt(product_low, Address(z, Z_R7, offset));
}
// Multiply 128 bit by 128 bit. Unrolled inner loop.
void MacroAssembler::multiply_128_x_128_loop(Register x_xstart,
Register y, Register z,
Register yz_idx, Register idx,
Register jdx,
Register carry, Register product,
Register carry2) {
// jlong carry, x[], y[], z[];
// int kdx = ystart+1;
// for (int idx=ystart-2; idx >= 0; idx -= 2) { // Third loop
// huge_128 product = (y[idx+1] * x_xstart) + z[kdx+idx+1] + carry;
// z[kdx+idx+1] = (jlong)product;
// jlong carry2 = (jlong)(product >>> 64);
// product = (y[idx] * x_xstart) + z[kdx+idx] + carry2;
// z[kdx+idx] = (jlong)product;
// carry = (jlong)(product >>> 64);
// }
// idx += 2;
// if (idx > 0) {
// product = (y[idx] * x_xstart) + z[kdx+idx] + carry;
// z[kdx+idx] = (jlong)product;
// carry = (jlong)(product >>> 64);
// }
Label L_third_loop, L_third_loop_exit, L_post_third_loop_done;
// scale the index
lgr_if_needed(jdx, idx);
and_imm(jdx, 0xfffffffffffffffcL);
rshift(jdx, 2);
bind(L_third_loop);
z_aghi(jdx, -1);
z_brl(L_third_loop_exit);
add2reg(idx, -4);
multiply_add_128_x_128(x_xstart, y, z, yz_idx, idx, carry, product, 8);
lgr_if_needed(carry2, product);
multiply_add_128_x_128(x_xstart, y, z, yz_idx, idx, carry2, product, 0);
lgr_if_needed(carry, product);
z_bru(L_third_loop);
bind(L_third_loop_exit); // Handle any left-over operand parts.
and_imm(idx, 0x3);
z_brz(L_post_third_loop_done);
Label L_check_1;
z_aghi(idx, -2);
z_brl(L_check_1);
multiply_add_128_x_128(x_xstart, y, z, yz_idx, idx, carry, product, 0);
lgr_if_needed(carry, product);
bind(L_check_1);
add2reg(idx, 0x2);
and_imm(idx, 0x1);
z_aghi(idx, -1);
z_brl(L_post_third_loop_done);
Register multiplicand = product->successor();
Register product_low = multiplicand;
z_sllg(Z_R7, idx, LogBytesPerInt);
clear_reg(yz_idx);
mem2reg_opt(yz_idx, Address(y, Z_R7, 0), false);
lgr_if_needed(multiplicand, x_xstart);
z_mlgr(product, yz_idx); // multiplicand * yz_idx -> product::multiplicand
clear_reg(yz_idx);
mem2reg_opt(yz_idx, Address(z, Z_R7, 0), false);
add2_with_carry(product, product_low, yz_idx, carry);
z_sllg(Z_R7, idx, LogBytesPerInt);
reg2mem_opt(product_low, Address(z, Z_R7, 0), false);
rshift(product_low, 32);
lshift(product, 32);
z_ogr(product_low, product);
lgr_if_needed(carry, product_low);
bind(L_post_third_loop_done);
}
void MacroAssembler::multiply_to_len(Register x, Register xlen,
Register y, Register ylen,
Register z,
Register tmp1, Register tmp2,
Register tmp3, Register tmp4,
Register tmp5) {
ShortBranchVerifier sbv(this);
assert_different_registers(x, xlen, y, ylen, z,
tmp1, tmp2, tmp3, tmp4, tmp5, Z_R1_scratch, Z_R7);
assert_different_registers(x, xlen, y, ylen, z,
tmp1, tmp2, tmp3, tmp4, tmp5, Z_R8);
z_stmg(Z_R7, Z_R13, _z_abi(gpr7), Z_SP);
const Register idx = tmp1;
const Register kdx = tmp2;
const Register xstart = tmp3;
const Register y_idx = tmp4;
const Register carry = tmp5;
const Register product = Z_R0_scratch;
const Register x_xstart = Z_R8;
// First Loop.
//
// final static long LONG_MASK = 0xffffffffL;
// int xstart = xlen - 1;
// int ystart = ylen - 1;
// long carry = 0;
// for (int idx=ystart, kdx=ystart+1+xstart; idx >= 0; idx-, kdx--) {
// long product = (y[idx] & LONG_MASK) * (x[xstart] & LONG_MASK) + carry;
// z[kdx] = (int)product;
// carry = product >>> 32;
// }
// z[xstart] = (int)carry;
//
lgr_if_needed(idx, ylen); // idx = ylen
z_agrk(kdx, xlen, ylen); // kdx = xlen + ylen
clear_reg(carry); // carry = 0
Label L_done;
lgr_if_needed(xstart, xlen);
z_aghi(xstart, -1);
z_brl(L_done);
multiply_64_x_64_loop(x, xstart, x_xstart, y, y_idx, z, carry, product, idx, kdx);
NearLabel L_second_loop;
compare64_and_branch(kdx, RegisterOrConstant((intptr_t) 0), bcondEqual, L_second_loop);
NearLabel L_carry;
z_aghi(kdx, -1);
z_brz(L_carry);
// Store lower 32 bits of carry.
z_sllg(Z_R1_scratch, kdx, LogBytesPerInt);
reg2mem_opt(carry, Address(z, Z_R1_scratch, 0), false);
rshift(carry, 32);
z_aghi(kdx, -1);
bind(L_carry);
// Store upper 32 bits of carry.
z_sllg(Z_R1_scratch, kdx, LogBytesPerInt);
reg2mem_opt(carry, Address(z, Z_R1_scratch, 0), false);
// Second and third (nested) loops.
//
// for (int i = xstart-1; i >= 0; i--) { // Second loop
// carry = 0;
// for (int jdx=ystart, k=ystart+1+i; jdx >= 0; jdx--, k--) { // Third loop
// long product = (y[jdx] & LONG_MASK) * (x[i] & LONG_MASK) +
// (z[k] & LONG_MASK) + carry;
// z[k] = (int)product;
// carry = product >>> 32;
// }
// z[i] = (int)carry;
// }
//
// i = xlen, j = tmp1, k = tmp2, carry = tmp5, x[i] = rdx
const Register jdx = tmp1;
bind(L_second_loop);
clear_reg(carry); // carry = 0;
lgr_if_needed(jdx, ylen); // j = ystart+1
z_aghi(xstart, -1); // i = xstart-1;
z_brl(L_done);
// Use free slots in the current stackframe instead of push/pop.
Address zsave(Z_SP, _z_abi(carg_1));
reg2mem_opt(z, zsave);
Label L_last_x;
z_sllg(Z_R1_scratch, xstart, LogBytesPerInt);
load_address(z, Address(z, Z_R1_scratch, 4)); // z = z + k - j
z_aghi(xstart, -1); // i = xstart-1;
z_brl(L_last_x);
z_sllg(Z_R1_scratch, xstart, LogBytesPerInt);
mem2reg_opt(x_xstart, Address(x, Z_R1_scratch, 0));
Label L_third_loop_prologue;
bind(L_third_loop_prologue);
Address xsave(Z_SP, _z_abi(carg_2));
Address xlensave(Z_SP, _z_abi(carg_3));
Address ylensave(Z_SP, _z_abi(carg_4));
reg2mem_opt(x, xsave);
reg2mem_opt(xstart, xlensave);
reg2mem_opt(ylen, ylensave);
multiply_128_x_128_loop(x_xstart, y, z, y_idx, jdx, ylen, carry, product, x);
mem2reg_opt(z, zsave);
mem2reg_opt(x, xsave);
mem2reg_opt(xlen, xlensave); // This is the decrement of the loop counter!
mem2reg_opt(ylen, ylensave);
add2reg(tmp3, 1, xlen);
z_sllg(Z_R1_scratch, tmp3, LogBytesPerInt);
reg2mem_opt(carry, Address(z, Z_R1_scratch, 0), false);
z_aghi(tmp3, -1);
z_brl(L_done);
rshift(carry, 32);
z_sllg(Z_R1_scratch, tmp3, LogBytesPerInt);
reg2mem_opt(carry, Address(z, Z_R1_scratch, 0), false);
z_bru(L_second_loop);
// Next infrequent code is moved outside loops.
bind(L_last_x);
clear_reg(x_xstart);
mem2reg_opt(x_xstart, Address(x, (intptr_t) 0), false);
z_bru(L_third_loop_prologue);
bind(L_done);
z_lmg(Z_R7, Z_R13, _z_abi(gpr7), Z_SP);
}
void MacroAssembler::asm_assert(branch_condition cond, const char* msg, int id, bool is_static) {
#ifdef ASSERT
Label ok;
z_brc(cond, ok);
is_static ? stop_static(msg, id) : stop(msg, id);
bind(ok);
#endif // ASSERT
}
// Assert if CC indicates "not equal" (check_equal==true) or "equal" (check_equal==false).
void MacroAssembler::asm_assert(bool check_equal, const char *msg, int id) {
#ifdef ASSERT
asm_assert(check_equal ? bcondEqual : bcondNotEqual, msg, id);
#endif // ASSERT
}
void MacroAssembler::asm_assert_mems_zero(bool check_equal, bool allow_relocation, int size, int64_t mem_offset,
Register mem_base, const char* msg, int id) {
#ifdef ASSERT
switch (size) {
case 4:
load_and_test_int(Z_R0, Address(mem_base, mem_offset));
break;
case 8:
load_and_test_long(Z_R0, Address(mem_base, mem_offset));
break;
default:
ShouldNotReachHere();
}
// if relocation is not allowed then stop_static() will be called otherwise call stop()
asm_assert(check_equal ? bcondEqual : bcondNotEqual, msg, id, !allow_relocation);
#endif // ASSERT
}
// Check the condition
// expected_size == FP - SP
// after transformation:
// expected_size - FP + SP == 0
// Destroys Register expected_size if no tmp register is passed.
void MacroAssembler::asm_assert_frame_size(Register expected_size, Register tmp, const char* msg, int id) {
#ifdef ASSERT
lgr_if_needed(tmp, expected_size);
z_algr(tmp, Z_SP);
z_slg(tmp, 0, Z_R0, Z_SP);
asm_assert(bcondEqual, msg, id);
#endif // ASSERT
}
// Save and restore functions: Exclude Z_R0.
void MacroAssembler::save_volatile_regs(Register dst, int offset, bool include_fp, bool include_flags) {
z_stmg(Z_R1, Z_R5, offset, dst); offset += 5 * BytesPerWord;
if (include_fp) {
z_std(Z_F0, Address(dst, offset)); offset += BytesPerWord;
z_std(Z_F1, Address(dst, offset)); offset += BytesPerWord;
z_std(Z_F2, Address(dst, offset)); offset += BytesPerWord;
z_std(Z_F3, Address(dst, offset)); offset += BytesPerWord;
z_std(Z_F4, Address(dst, offset)); offset += BytesPerWord;
z_std(Z_F5, Address(dst, offset)); offset += BytesPerWord;
z_std(Z_F6, Address(dst, offset)); offset += BytesPerWord;
z_std(Z_F7, Address(dst, offset)); offset += BytesPerWord;
}
if (include_flags) {
Label done;
z_mvi(Address(dst, offset), 2); // encoding: equal
z_bre(done);
z_mvi(Address(dst, offset), 4); // encoding: higher
z_brh(done);
z_mvi(Address(dst, offset), 1); // encoding: lower
bind(done);
}
}
void MacroAssembler::restore_volatile_regs(Register src, int offset, bool include_fp, bool include_flags) {
z_lmg(Z_R1, Z_R5, offset, src); offset += 5 * BytesPerWord;
if (include_fp) {
z_ld(Z_F0, Address(src, offset)); offset += BytesPerWord;
z_ld(Z_F1, Address(src, offset)); offset += BytesPerWord;
z_ld(Z_F2, Address(src, offset)); offset += BytesPerWord;
z_ld(Z_F3, Address(src, offset)); offset += BytesPerWord;
z_ld(Z_F4, Address(src, offset)); offset += BytesPerWord;
z_ld(Z_F5, Address(src, offset)); offset += BytesPerWord;
z_ld(Z_F6, Address(src, offset)); offset += BytesPerWord;
z_ld(Z_F7, Address(src, offset)); offset += BytesPerWord;
}
if (include_flags) {
z_cli(Address(src, offset), 2); // see encoding above
}
}
// Plausibility check for oops.
void MacroAssembler::verify_oop(Register oop, const char* msg) {
if (!VerifyOops) return;
BLOCK_COMMENT("verify_oop {");
unsigned int nbytes_save = (5 + 8 + 1) * BytesPerWord;
address entry_addr = StubRoutines::verify_oop_subroutine_entry_address();
save_return_pc();
// Push frame, but preserve flags
z_lgr(Z_R0, Z_SP);
z_lay(Z_SP, -((int64_t)nbytes_save + frame::z_abi_160_size), Z_SP);
z_stg(Z_R0, _z_abi(callers_sp), Z_SP);
save_volatile_regs(Z_SP, frame::z_abi_160_size, true, true);
lgr_if_needed(Z_ARG2, oop);
load_const_optimized(Z_ARG1, (address)msg);
load_const_optimized(Z_R1, entry_addr);
z_lg(Z_R1, 0, Z_R1);
call_c(Z_R1);
restore_volatile_regs(Z_SP, frame::z_abi_160_size, true, true);
pop_frame();
restore_return_pc();
BLOCK_COMMENT("} verify_oop ");
}
void MacroAssembler::verify_oop_addr(Address addr, const char* msg) {
if (!VerifyOops) return;
BLOCK_COMMENT("verify_oop {");
unsigned int nbytes_save = (5 + 8) * BytesPerWord;
address entry_addr = StubRoutines::verify_oop_subroutine_entry_address();
save_return_pc();
unsigned int frame_size = push_frame_abi160(nbytes_save); // kills Z_R0
save_volatile_regs(Z_SP, frame::z_abi_160_size, true, false);
z_lg(Z_ARG2, addr.plus_disp(frame_size));
load_const_optimized(Z_ARG1, (address)msg);
load_const_optimized(Z_R1, entry_addr);
z_lg(Z_R1, 0, Z_R1);
call_c(Z_R1);
restore_volatile_regs(Z_SP, frame::z_abi_160_size, true, false);
pop_frame();
restore_return_pc();
BLOCK_COMMENT("} verify_oop ");
}
const char* MacroAssembler::stop_types[] = {
"stop",
"untested",
"unimplemented",
"shouldnotreachhere"
};
static void stop_on_request(const char* tp, const char* msg) {
tty->print("Z assembly code requires stop: (%s) %s\n", tp, msg);
guarantee(false, "Z assembly code requires stop: %s", msg);
}
void MacroAssembler::stop(int type, const char* msg, int id) {
BLOCK_COMMENT(err_msg("stop: %s {", msg));
// Setup arguments.
load_const(Z_ARG1, (void*) stop_types[type%stop_end]);
load_const(Z_ARG2, (void*) msg);
get_PC(Z_R14); // Following code pushes a frame without entering a new function. Use current pc as return address.
save_return_pc(); // Saves return pc Z_R14.
push_frame_abi160(0);
call_VM_leaf(CAST_FROM_FN_PTR(address, stop_on_request), Z_ARG1, Z_ARG2);
// The plain disassembler does not recognize illtrap. It instead displays
// a 32-bit value. Issuing two illtraps assures the disassembler finds
// the proper beginning of the next instruction.
z_illtrap(id); // Illegal instruction.
z_illtrap(id); // Illegal instruction.
BLOCK_COMMENT(" } stop");
}
// Special version of stop() for code size reduction.
// Reuses the previously generated call sequence, if any.
// Generates the call sequence on its own, if necessary.
// Note: This code will work only in non-relocatable code!
// The relative address of the data elements (arg1, arg2) must not change.
// The reentry point must not move relative to it's users. This prerequisite
// should be given for "hand-written" code, if all chain calls are in the same code blob.
// Generated code must not undergo any transformation, e.g. ShortenBranches, to be safe.
address MacroAssembler::stop_chain(address reentry, int type, const char* msg, int id, bool allow_relocation) {
BLOCK_COMMENT(err_msg("stop_chain(%s,%s): %s {", reentry==nullptr?"init":"cont", allow_relocation?"reloc ":"static", msg));
// Setup arguments.
if (allow_relocation) {
// Relocatable version (for comparison purposes). Remove after some time.
load_const(Z_ARG1, (void*) stop_types[type%stop_end]);
load_const(Z_ARG2, (void*) msg);
} else {
load_absolute_address(Z_ARG1, (address)stop_types[type%stop_end]);
load_absolute_address(Z_ARG2, (address)msg);
}
if ((reentry != nullptr) && RelAddr::is_in_range_of_RelAddr16(reentry, pc())) {
BLOCK_COMMENT("branch to reentry point:");
z_brc(bcondAlways, reentry);
} else {
BLOCK_COMMENT("reentry point:");
reentry = pc(); // Re-entry point for subsequent stop calls.
save_return_pc(); // Saves return pc Z_R14.
push_frame_abi160(0);
if (allow_relocation) {
reentry = nullptr; // Prevent reentry if code relocation is allowed.
call_VM_leaf(CAST_FROM_FN_PTR(address, stop_on_request), Z_ARG1, Z_ARG2);
} else {
call_VM_leaf_static(CAST_FROM_FN_PTR(address, stop_on_request), Z_ARG1, Z_ARG2);
}
z_illtrap(id); // Illegal instruction as emergency stop, should the above call return.
}
BLOCK_COMMENT(" } stop_chain");
return reentry;
}
// Special version of stop() for code size reduction.
// Assumes constant relative addresses for data and runtime call.
void MacroAssembler::stop_static(int type, const char* msg, int id) {
stop_chain(nullptr, type, msg, id, false);
}
void MacroAssembler::stop_subroutine() {
unimplemented("stop_subroutine", 710);
}
// Prints msg to stdout from within generated code..
void MacroAssembler::warn(const char* msg) {
RegisterSaver::save_live_registers(this, RegisterSaver::all_registers, Z_R14);
load_absolute_address(Z_R1, (address) warning);
load_absolute_address(Z_ARG1, (address) msg);
(void) call(Z_R1);
RegisterSaver::restore_live_registers(this, RegisterSaver::all_registers);
}
#ifndef PRODUCT
// Write pattern 0x0101010101010101 in region [low-before, high+after].
void MacroAssembler::zap_from_to(Register low, Register high, Register val, Register addr, int before, int after) {
if (!ZapEmptyStackFields) return;
BLOCK_COMMENT("zap memory region {");
load_const_optimized(val, 0x0101010101010101);
int size = before + after;
if (low == high && size < 5 && size > 0) {
int offset = -before*BytesPerWord;
for (int i = 0; i < size; ++i) {
z_stg(val, Address(low, offset));
offset +=(1*BytesPerWord);
}
} else {
add2reg(addr, -before*BytesPerWord, low);
if (after) {
#ifdef ASSERT
jlong check = after * BytesPerWord;
assert(Immediate::is_simm32(check) && Immediate::is_simm32(-check), "value not encodable !");
#endif
add2reg(high, after * BytesPerWord);
}
NearLabel loop;
bind(loop);
z_stg(val, Address(addr));
add2reg(addr, 8);
compare64_and_branch(addr, high, bcondNotHigh, loop);
if (after) {
add2reg(high, -after * BytesPerWord);
}
}
BLOCK_COMMENT("} zap memory region");
}
#endif // !PRODUCT
// Implements fast-locking.
// - obj: the object to be locked, contents preserved.
// - temp1, temp2: temporary registers, contents destroyed.
// Note: make sure Z_R1 is not manipulated here when C2 compiler is in play
void MacroAssembler::fast_lock(Register basic_lock, Register obj, Register temp1, Register temp2, Label& slow) {
assert_different_registers(basic_lock, obj, temp1, temp2);
Label push;
const Register top = temp1;
const Register mark = temp2;
const int mark_offset = oopDesc::mark_offset_in_bytes();
const ByteSize ls_top_offset = JavaThread::lock_stack_top_offset();
// Preload the markWord. It is important that this is the first
// instruction emitted as it is part of C1's null check semantics.
z_lg(mark, Address(obj, mark_offset));
if (UseObjectMonitorTable) {
// Clear cache in case fast locking succeeds or we need to take the slow-path.
const Address om_cache_addr = Address(basic_lock, BasicObjectLock::lock_offset() + in_ByteSize((BasicLock::object_monitor_cache_offset_in_bytes())));
z_mvghi(om_cache_addr, 0);
}
if (DiagnoseSyncOnValueBasedClasses != 0) {
load_klass(temp1, obj);
z_tm(Address(temp1, Klass::misc_flags_offset()), KlassFlags::_misc_is_value_based_class);
z_brne(slow);
}
// First we need to check if the lock-stack has room for pushing the object reference.
z_lgf(top, Address(Z_thread, ls_top_offset));
compareU32_and_branch(top, (unsigned)LockStack::end_offset(), bcondNotLow, slow);
// The underflow check is elided. The recursive check will always fail
// when the lock stack is empty because of the _bad_oop_sentinel field.
// Check for recursion:
z_aghi(top, -oopSize);
z_cg(obj, Address(Z_thread, top));
z_bre(push);
// Check header for monitor (0b10).
z_tmll(mark, markWord::monitor_value);
branch_optimized(bcondNotAllZero, slow);
{ // Try to lock. Transition lock bits 0b01 => 0b00
const Register locked_obj = top;
z_oill(mark, markWord::unlocked_value);
z_lgr(locked_obj, mark);
// Clear lock-bits from locked_obj (locked state)
z_xilf(locked_obj, markWord::unlocked_value);
z_csg(mark, locked_obj, mark_offset, obj);
branch_optimized(Assembler::bcondNotEqual, slow);
}
bind(push);
// After successful lock, push object on lock-stack
z_lgf(top, Address(Z_thread, ls_top_offset));
z_stg(obj, Address(Z_thread, top));
z_alsi(in_bytes(ls_top_offset), Z_thread, oopSize);
}
// Implements fast-unlocking.
// - obj: the object to be unlocked
// - temp1, temp2: temporary registers, will be destroyed
// - Z_R1_scratch: will be killed in case of Interpreter & C1 Compiler
void MacroAssembler::fast_unlock(Register obj, Register temp1, Register temp2, Label& slow) {
assert_different_registers(obj, temp1, temp2);
Label unlocked, push_and_slow;
const Register mark = temp1;
const Register top = temp2;
const int mark_offset = oopDesc::mark_offset_in_bytes();
const ByteSize ls_top_offset = JavaThread::lock_stack_top_offset();
#ifdef ASSERT
{
// The following checks rely on the fact that LockStack is only ever modified by
// its owning thread, even if the lock got inflated concurrently; removal of LockStack
// entries after inflation will happen delayed in that case.
// Check for lock-stack underflow.
NearLabel stack_ok;
z_lgf(top, Address(Z_thread, ls_top_offset));
compareU32_and_branch(top, (unsigned)LockStack::start_offset(), bcondNotLow, stack_ok);
stop("Lock-stack underflow");
bind(stack_ok);
}
#endif // ASSERT
// Check if obj is top of lock-stack.
z_lgf(top, Address(Z_thread, ls_top_offset));
z_aghi(top, -oopSize);
z_cg(obj, Address(Z_thread, top));
branch_optimized(bcondNotEqual, slow);
// pop object from lock-stack
#ifdef ASSERT
const Register temp_top = temp1; // mark is not yet loaded, but be careful
z_agrk(temp_top, top, Z_thread);
z_xc(0, oopSize-1, temp_top, 0, temp_top); // wipe out lock-stack entry
#endif // ASSERT
z_alsi(in_bytes(ls_top_offset), Z_thread, -oopSize); // pop object
// The underflow check is elided. The recursive check will always fail
// when the lock stack is empty because of the _bad_oop_sentinel field.
// Check if recursive. (this is a check for the 2nd object on the stack)
z_aghi(top, -oopSize);
z_cg(obj, Address(Z_thread, top));
branch_optimized(bcondEqual, unlocked);
// Not recursive. Check header for monitor (0b10).
z_lg(mark, Address(obj, mark_offset));
z_tmll(mark, markWord::monitor_value);
z_brnaz(push_and_slow);
#ifdef ASSERT
// Check header not unlocked (0b01).
NearLabel not_unlocked;
z_tmll(mark, markWord::unlocked_value);
z_braz(not_unlocked);
stop("fast_unlock already unlocked");
bind(not_unlocked);
#endif // ASSERT
{ // Try to unlock. Transition lock bits 0b00 => 0b01
Register unlocked_obj = top;
z_lgr(unlocked_obj, mark);
z_oill(unlocked_obj, markWord::unlocked_value);
z_csg(mark, unlocked_obj, mark_offset, obj);
branch_optimized(Assembler::bcondEqual, unlocked);
}
bind(push_and_slow);
// Restore lock-stack and handle the unlock in runtime.
z_lgf(top, Address(Z_thread, ls_top_offset));
DEBUG_ONLY(z_stg(obj, Address(Z_thread, top));)
z_alsi(in_bytes(ls_top_offset), Z_thread, oopSize);
// set CC to NE
z_ltgr(obj, obj); // object shouldn't be null at this point
branch_optimized(bcondAlways, slow);
bind(unlocked);
}
void MacroAssembler::compiler_fast_lock_object(Register obj, Register box, Register tmp1, Register tmp2) {
assert_different_registers(obj, box, tmp1, tmp2, Z_R0_scratch);
// Handle inflated monitor.
NearLabel inflated;
// Finish fast lock successfully. MUST reach to with flag == NE
NearLabel locked;
// Finish fast lock unsuccessfully. MUST branch to with flag == EQ
NearLabel slow_path;
if (UseObjectMonitorTable) {
// Clear cache in case fast locking succeeds or we need to take the slow-path.
z_mvghi(Address(box, BasicLock::object_monitor_cache_offset_in_bytes()), 0);
}
if (DiagnoseSyncOnValueBasedClasses != 0) {
load_klass(tmp1, obj);
z_tm(Address(tmp1, Klass::misc_flags_offset()), KlassFlags::_misc_is_value_based_class);
z_brne(slow_path);
}
const Register mark = tmp1;
const int mark_offset = oopDesc::mark_offset_in_bytes();
const ByteSize ls_top_offset = JavaThread::lock_stack_top_offset();
BLOCK_COMMENT("compiler_fast_locking {");
{ // Fast locking
// Push lock to the lock stack and finish successfully. MUST reach to with flag == EQ
NearLabel push;
const Register top = tmp2;
// Check if lock-stack is full.
z_lgf(top, Address(Z_thread, ls_top_offset));
compareU32_and_branch(top, (unsigned) LockStack::end_offset() - 1, bcondHigh, slow_path);
// The underflow check is elided. The recursive check will always fail
// when the lock stack is empty because of the _bad_oop_sentinel field.
// Check if recursive.
z_aghi(top, -oopSize);
z_cg(obj, Address(Z_thread, top));
z_bre(push);
// Check for monitor (0b10)
z_lg(mark, Address(obj, mark_offset));
z_tmll(mark, markWord::monitor_value);
z_brnaz(inflated);
// not inflated
{ // Try to lock. Transition lock bits 0b01 => 0b00
assert(mark_offset == 0, "required to avoid a lea");
const Register locked_obj = top;
z_oill(mark, markWord::unlocked_value);
z_lgr(locked_obj, mark);
// Clear lock-bits from locked_obj (locked state)
z_xilf(locked_obj, markWord::unlocked_value);
z_csg(mark, locked_obj, mark_offset, obj);
branch_optimized(Assembler::bcondNotEqual, slow_path);
}
bind(push);
// After successful lock, push object on lock-stack.
z_lgf(top, Address(Z_thread, ls_top_offset));
z_stg(obj, Address(Z_thread, top));
z_alsi(in_bytes(ls_top_offset), Z_thread, oopSize);
z_cgr(obj, obj); // set the CC to EQ, as it could be changed by alsi
z_bru(locked);
}
BLOCK_COMMENT("} compiler_fast_locking");
BLOCK_COMMENT("handle_inflated_monitor_locking {");
{ // Handle inflated monitor.
bind(inflated);
const Register tmp1_monitor = tmp1;
if (!UseObjectMonitorTable) {
assert(tmp1_monitor == mark, "should be the same here");
} else {
const Register tmp1_bucket = tmp1;
const Register hash = Z_R0_scratch;
NearLabel monitor_found;
// Save the mark, we might need it to extract the hash.
z_lgr(hash, mark);
// Look for the monitor in the om_cache.
ByteSize cache_offset = JavaThread::om_cache_oops_offset();
ByteSize monitor_offset = OMCache::oop_to_monitor_difference();
const int num_unrolled = OMCache::CAPACITY;
for (int i = 0; i < num_unrolled; i++) {
z_lg(tmp1_monitor, Address(Z_thread, cache_offset + monitor_offset));
z_cg(obj, Address(Z_thread, cache_offset));
z_bre(monitor_found);
cache_offset = cache_offset + OMCache::oop_to_oop_difference();
}
// Get the hash code.
z_srlg(hash, hash, markWord::hash_shift);
// Get the table and calculate the bucket's address.
load_const_optimized(tmp2, ObjectMonitorTable::current_table_address());
z_lg(tmp2, Address(tmp2));
z_ng(hash, Address(tmp2, ObjectMonitorTable::table_capacity_mask_offset()));
z_lg(tmp1_bucket, Address(tmp2, ObjectMonitorTable::table_buckets_offset()));
z_sllg(hash, hash, LogBytesPerWord);
z_agr(tmp1_bucket, hash);
// Read the monitor from the bucket.
z_lg(tmp1_monitor, Address(tmp1_bucket));
// Check if the monitor in the bucket is special (empty, tombstone or removed).
z_clgfi(tmp1_monitor, ObjectMonitorTable::SpecialPointerValues::below_is_special);
z_brl(slow_path);
// Check if object matches.
z_lg(tmp2, Address(tmp1_monitor, ObjectMonitor::object_offset()));
BarrierSetAssembler* bs_asm = BarrierSet::barrier_set()->barrier_set_assembler();
bs_asm->try_resolve_weak_handle_in_c2(this, tmp2, Z_R0_scratch, slow_path);
z_cgr(obj, tmp2);
z_brne(slow_path);
bind(monitor_found);
}
NearLabel monitor_locked;
// lock the monitor
const Register zero = tmp2;
const ByteSize monitor_tag = in_ByteSize(UseObjectMonitorTable ? 0 : checked_cast<int>(markWord::monitor_value));
const Address owner_address(tmp1_monitor, ObjectMonitor::owner_offset() - monitor_tag);
const Address recursions_address(tmp1_monitor, ObjectMonitor::recursions_offset() - monitor_tag);
// Try to CAS owner (no owner => current thread's _monitor_owner_id).
// If csg succeeds then CR=EQ, otherwise, register zero is filled
// with the current owner.
z_lghi(zero, 0);
z_lg(Z_R0_scratch, Address(Z_thread, JavaThread::monitor_owner_id_offset()));
z_csg(zero, Z_R0_scratch, owner_address);
z_bre(monitor_locked);
// Check if recursive.
z_cgr(Z_R0_scratch, zero); // zero contains the owner from z_csg instruction
z_brne(slow_path);
// Recursive
z_agsi(recursions_address, 1ll);
bind(monitor_locked);
if (UseObjectMonitorTable) {
// Cache the monitor for unlock
z_stg(tmp1_monitor, Address(box, BasicLock::object_monitor_cache_offset_in_bytes()));
}
// set the CC now
z_cgr(obj, obj);
}
BLOCK_COMMENT("} handle_inflated_monitor_locking");
bind(locked);
#ifdef ASSERT
// Check that locked label is reached with flag == EQ.
NearLabel flag_correct;
z_bre(flag_correct);
stop("CC is not set to EQ, it should be - lock");
#endif // ASSERT
bind(slow_path);
#ifdef ASSERT
// Check that slow_path label is reached with flag == NE.
z_brne(flag_correct);
stop("CC is not set to NE, it should be - lock");
bind(flag_correct);
#endif // ASSERT
// C2 uses the value of flag (NE vs EQ) to determine the continuation.
}
void MacroAssembler::compiler_fast_unlock_object(Register obj, Register box, Register tmp1, Register tmp2) {
assert_different_registers(obj, box, tmp1, tmp2);
// Handle inflated monitor.
NearLabel inflated, inflated_load_mark;
// Finish fast unlock successfully. MUST reach to with flag == EQ.
NearLabel unlocked;
// Finish fast unlock unsuccessfully. MUST branch to with flag == NE.
NearLabel slow_path;
const Register mark = tmp1;
const Register top = tmp2;
const int mark_offset = oopDesc::mark_offset_in_bytes();
const ByteSize ls_top_offset = JavaThread::lock_stack_top_offset();
BLOCK_COMMENT("compiler_fast_unlock {");
{ // Fast Unlock
NearLabel push_and_slow_path;
// Check if obj is top of lock-stack.
z_lgf(top, Address(Z_thread, ls_top_offset));
z_aghi(top, -oopSize);
z_cg(obj, Address(Z_thread, top));
branch_optimized(bcondNotEqual, inflated_load_mark);
// Pop lock-stack.
#ifdef ASSERT
const Register temp_top = tmp1; // let's not kill top here, we can use for recursive check
z_agrk(temp_top, top, Z_thread);
z_xc(0, oopSize-1, temp_top, 0, temp_top); // wipe out lock-stack entry
#endif
z_alsi(in_bytes(ls_top_offset), Z_thread, -oopSize); // pop object
// The underflow check is elided. The recursive check will always fail
// when the lock stack is empty because of the _bad_oop_sentinel field.
// Check if recursive.
z_aghi(top, -oopSize);
z_cg(obj, Address(Z_thread, top));
z_bre(unlocked);
// Not recursive
// Check for monitor (0b10).
// Because we got here by popping (meaning we pushed in locked)
// there will be no monitor in the box. So we need to push back the obj
// so that the runtime can fix any potential anonymous owner.
z_lg(mark, Address(obj, mark_offset));
z_tmll(mark, markWord::monitor_value);
if (!UseObjectMonitorTable) {
z_brnaz(inflated);
} else {
z_brnaz(push_and_slow_path);
}
#ifdef ASSERT
// Check header not unlocked (0b01).
NearLabel not_unlocked;
z_tmll(mark, markWord::unlocked_value);
z_braz(not_unlocked);
stop("fast_unlock already unlocked");
bind(not_unlocked);
#endif // ASSERT
{ // Try to unlock. Transition lock bits 0b00 => 0b01
Register unlocked_obj = top;
z_lgr(unlocked_obj, mark);
z_oill(unlocked_obj, markWord::unlocked_value);
z_csg(mark, unlocked_obj, mark_offset, obj);
branch_optimized(Assembler::bcondEqual, unlocked);
}
bind(push_and_slow_path);
// Restore lock-stack and handle the unlock in runtime.
z_lgf(top, Address(Z_thread, ls_top_offset));
DEBUG_ONLY(z_stg(obj, Address(Z_thread, top));)
z_alsi(in_bytes(ls_top_offset), Z_thread, oopSize);
// set CC to NE
z_ltgr(obj, obj); // object is not null here
z_bru(slow_path);
}
BLOCK_COMMENT("} compiler_fast_unlock");
{ // Handle inflated monitor.
bind(inflated_load_mark);
z_lg(mark, Address(obj, mark_offset));
#ifdef ASSERT
z_tmll(mark, markWord::monitor_value);
z_brnaz(inflated);
stop("Fast Unlock not monitor");
#endif // ASSERT
bind(inflated);
#ifdef ASSERT
NearLabel check_done, loop;
z_lgf(top, Address(Z_thread, ls_top_offset));
bind(loop);
z_aghi(top, -oopSize);
compareU32_and_branch(top, in_bytes(JavaThread::lock_stack_base_offset()),
bcondLow, check_done);
z_cg(obj, Address(Z_thread, top));
z_brne(loop);
stop("Fast Unlock lock on stack");
bind(check_done);
#endif // ASSERT
const Register tmp1_monitor = tmp1;
if (!UseObjectMonitorTable) {
assert(tmp1_monitor == mark, "should be the same here");
} else {
// Uses ObjectMonitorTable. Look for the monitor in our BasicLock on the stack.
z_lg(tmp1_monitor, Address(box, BasicLock::object_monitor_cache_offset_in_bytes()));
// null check with ZF == 0, no valid pointer below alignof(ObjectMonitor*)
z_cghi(tmp1_monitor, alignof(ObjectMonitor*));
z_brl(slow_path);
}
// mark contains the tagged ObjectMonitor*.
const Register monitor = mark;
const ByteSize monitor_tag = in_ByteSize(UseObjectMonitorTable ? 0 : checked_cast<int>(markWord::monitor_value));
const Address recursions_address{monitor, ObjectMonitor::recursions_offset() - monitor_tag};
const Address succ_address{monitor, ObjectMonitor::succ_offset() - monitor_tag};
const Address entry_list_address{monitor, ObjectMonitor::entry_list_offset() - monitor_tag};
const Address owner_address{monitor, ObjectMonitor::owner_offset() - monitor_tag};
NearLabel not_recursive;
const Register recursions = tmp2;
// Check if recursive.
load_and_test_long(recursions, recursions_address);
z_bre(not_recursive); // if 0 then jump, it's not recursive locking
// Recursive unlock
z_agsi(recursions_address, -1ll);
z_cgr(monitor, monitor); // set the CC to EQUAL
z_bru(unlocked);
bind(not_recursive);
NearLabel set_eq_unlocked;
// Set owner to null.
// Release to satisfy the JMM
z_release();
z_lghi(tmp2, 0);
z_stg(tmp2 /*=0*/, owner_address);
// We need a full fence after clearing owner to avoid stranding.
z_fence();
// Check if the entry_list is empty.
load_and_test_long(tmp2, entry_list_address);
z_bre(unlocked); // If so we are done.
// Check if there is a successor.
load_and_test_long(tmp2, succ_address);
z_brne(set_eq_unlocked); // If so we are done.
// Save the monitor pointer in the current thread, so we can try to
// reacquire the lock in SharedRuntime::monitor_exit_helper().
if (!UseObjectMonitorTable) {
z_xilf(monitor, markWord::monitor_value);
}
z_stg(monitor, Address(Z_thread, JavaThread::unlocked_inflated_monitor_offset()));
z_ltgr(obj, obj); // Set flag = NE
z_bru(slow_path);
bind(set_eq_unlocked);
z_cr(tmp2, tmp2); // Set flag = EQ
}
bind(unlocked);
#ifdef ASSERT
// Check that unlocked label is reached with flag == EQ.
NearLabel flag_correct;
z_bre(flag_correct);
stop("CC is not set to EQ, it should be - unlock");
#endif // ASSERT
bind(slow_path);
#ifdef ASSERT
// Check that slow_path label is reached with flag == NE.
z_brne(flag_correct);
stop("CC is not set to NE, it should be - unlock");
bind(flag_correct);
#endif // ASSERT
// C2 uses the value of flag (NE vs EQ) to determine the continuation.
}
void MacroAssembler::pop_count_int(Register r_dst, Register r_src, Register r_tmp) {
BLOCK_COMMENT("pop_count_int {");
assert(r_tmp != noreg, "temp register required for pop_count_int, as code may run on machine older than z15");
assert_different_registers(r_dst, r_tmp); // if r_src is same as r_tmp, it should be fine
if (VM_Version::has_MiscInstrExt3()) {
pop_count_int_with_ext3(r_dst, r_src);
} else {
pop_count_int_without_ext3(r_dst, r_src, r_tmp);
}
BLOCK_COMMENT("} pop_count_int");
}
void MacroAssembler::pop_count_long(Register r_dst, Register r_src, Register r_tmp) {
BLOCK_COMMENT("pop_count_long {");
assert(r_tmp != noreg, "temp register required for pop_count_long, as code may run on machine older than z15");
assert_different_registers(r_dst, r_tmp); // if r_src is same as r_tmp, it should be fine
if (VM_Version::has_MiscInstrExt3()) {
pop_count_long_with_ext3(r_dst, r_src);
} else {
pop_count_long_without_ext3(r_dst, r_src, r_tmp);
}
BLOCK_COMMENT("} pop_count_long");
}
void MacroAssembler::pop_count_int_without_ext3(Register r_dst, Register r_src, Register r_tmp) {
BLOCK_COMMENT("pop_count_int_without_ext3 {");
assert(r_tmp != noreg, "temp register required for popcnt, for machines < z15");
assert_different_registers(r_dst, r_tmp); // if r_src is same as r_tmp, it should be fine
z_popcnt(r_dst, r_src, 0);
z_srlg(r_tmp, r_dst, 16);
z_alr(r_dst, r_tmp);
z_srlg(r_tmp, r_dst, 8);
z_alr(r_dst, r_tmp);
z_llgcr(r_dst, r_dst);
BLOCK_COMMENT("} pop_count_int_without_ext3");
}
void MacroAssembler::pop_count_long_without_ext3(Register r_dst, Register r_src, Register r_tmp) {
BLOCK_COMMENT("pop_count_long_without_ext3 {");
assert(r_tmp != noreg, "temp register required for popcnt, for machines < z15");
assert_different_registers(r_dst, r_tmp); // if r_src is same as r_tmp, it should be fine
z_popcnt(r_dst, r_src, 0);
z_ahhlr(r_dst, r_dst, r_dst);
z_sllg(r_tmp, r_dst, 16);
z_algr(r_dst, r_tmp);
z_sllg(r_tmp, r_dst, 8);
z_algr(r_dst, r_tmp);
z_srlg(r_dst, r_dst, 56);
BLOCK_COMMENT("} pop_count_long_without_ext3");
}
void MacroAssembler::pop_count_long_with_ext3(Register r_dst, Register r_src) {
BLOCK_COMMENT("pop_count_long_with_ext3 {");
guarantee(VM_Version::has_MiscInstrExt3(),
"this hardware doesn't support miscellaneous-instruction-extensions facility 3, still pop_count_long_with_ext3 is used");
z_popcnt(r_dst, r_src, 8);
BLOCK_COMMENT("} pop_count_long_with_ext3");
}
void MacroAssembler::pop_count_int_with_ext3(Register r_dst, Register r_src) {
BLOCK_COMMENT("pop_count_int_with_ext3 {");
guarantee(VM_Version::has_MiscInstrExt3(),
"this hardware doesn't support miscellaneous-instruction-extensions facility 3, still pop_count_long_with_ext3 is used");
z_llgfr(r_dst, r_src);
z_popcnt(r_dst, r_dst, 8);
BLOCK_COMMENT("} pop_count_int_with_ext3");
}
// LOAD HALFWORD IMMEDIATE ON CONDITION (32 <- 16)
void MacroAssembler::load_on_condition_imm_32(Register dst, int64_t i2, branch_condition cc) {
if (VM_Version::has_LoadStoreConditional2()) { // z_lochi works on z13 or above
assert(Assembler::is_simm16(i2), "sanity");
z_lochi(dst, i2, cc);
} else {
NearLabel done;
z_brc(Assembler::inverse_condition(cc), done);
z_lhi(dst, i2);
bind(done);
}
}
// LOAD HALFWORD IMMEDIATE ON CONDITION (64 <- 16)
void MacroAssembler::load_on_condition_imm_64(Register dst, int64_t i2, branch_condition cc) {
if (VM_Version::has_LoadStoreConditional2()) { // z_locghi works on z13 or above
assert(Assembler::is_simm16(i2), "sanity");
z_locghi(dst, i2, cc);
} else {
NearLabel done;
z_brc(Assembler::inverse_condition(cc), done);
z_lghi(dst, i2);
bind(done);
}
}