1 /* -*- mode: C; c-basic-offset: 3; -*- */ 2 3 /*---------------------------------------------------------------*/ 4 /*--- begin guest_s390_defs.h ---*/ 5 /*---------------------------------------------------------------*/ 6 7 /* 8 This file is part of Valgrind, a dynamic binary instrumentation 9 framework. 10 11 Copyright IBM Corp. 2010-2013 12 13 This program is free software; you can redistribute it and/or 14 modify it under the terms of the GNU General Public License as 15 published by the Free Software Foundation; either version 2 of the 16 License, or (at your option) any later version. 17 18 This program is distributed in the hope that it will be useful, but 19 WITHOUT ANY WARRANTY; without even the implied warranty of 20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 21 General Public License for more details. 22 23 You should have received a copy of the GNU General Public License 24 along with this program; if not, write to the Free Software 25 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 26 02110-1301, USA. 27 28 The GNU General Public License is contained in the file COPYING. 29 */ 30 31 /* Contributed by Florian Krohm */ 32 33 #ifndef __VEX_GUEST_S390_DEFS_H 34 #define __VEX_GUEST_S390_DEFS_H 35 36 #include "libvex_basictypes.h" // offsetof 37 #include "guest_generic_bb_to_IR.h" // DisResult 38 #include "libvex_guest_s390x.h" // VexGuestS390XState 39 40 41 /* Convert one s390 insn to IR. See the type DisOneInstrFn in 42 bb_to_IR.h. */ 43 DisResult disInstr_S390 ( IRSB* irbb, 44 Bool (*resteerOkFn) ( void*, Addr64 ), 45 Bool resteerCisOk, 46 void* callback_opaque, 47 UChar* guest_code, 48 Long delta, 49 Addr64 guest_IP, 50 VexArch guest_arch, 51 VexArchInfo* archinfo, 52 VexAbiInfo* abiinfo, 53 Bool host_bigendian, 54 Bool sigill_diag ); 55 56 /* Used by the optimiser to specialise calls to helpers. */ 57 IRExpr* guest_s390x_spechelper ( const HChar *function_name, 58 IRExpr **args, 59 IRStmt **precedingStmts, 60 Int n_precedingStmts); 61 62 63 /* Describes to the optimser which part of the guest state require 64 precise memory exceptions. This is logically part of the guest 65 state description. */ 66 Bool guest_s390x_state_requires_precise_mem_exns ( Int, Int ); 67 68 extern VexGuestLayout s390xGuest_layout; 69 70 71 #define S390X_GUEST_OFFSET(x) offsetof(VexGuestS390XState, x) 72 73 /*------------------------------------------------------------*/ 74 /*--- Helper functions. ---*/ 75 /*------------------------------------------------------------*/ 76 void s390x_dirtyhelper_EX(ULong torun); 77 ULong s390x_dirtyhelper_STCK(ULong *addr); 78 ULong s390x_dirtyhelper_STCKF(ULong *addr); 79 ULong s390x_dirtyhelper_STCKE(ULong *addr); 80 ULong s390x_dirtyhelper_STFLE(VexGuestS390XState *guest_state, ULong *addr); 81 void s390x_dirtyhelper_CUxy(UChar *addr, ULong data, ULong num_bytes); 82 83 ULong s390_do_cu12_cu14_helper1(UInt byte1, UInt etf3_and_m3_is_1); 84 ULong s390_do_cu12_helper2(UInt byte1, UInt byte2, UInt byte3, UInt byte4, 85 ULong stuff); 86 ULong s390_do_cu14_helper2(UInt byte1, UInt byte2, UInt byte3, UInt byte4, 87 ULong stuff); 88 ULong s390_do_cu21(UInt srcvalue, UInt low_surrogate); 89 ULong s390_do_cu24(UInt srcvalue, UInt low_surrogate); 90 ULong s390_do_cu41(UInt srcvalue); 91 ULong s390_do_cu42(UInt srcvalue); 92 UInt s390_do_cvb(ULong decimal); 93 ULong s390_do_cvd(ULong binary); 94 ULong s390_do_ecag(ULong op2addr); 95 UInt s390_do_pfpo(UInt gpr0); 96 97 /* The various ways to compute the condition code. */ 98 enum { 99 S390_CC_OP_BITWISE = 0, 100 S390_CC_OP_SIGNED_COMPARE = 1, 101 S390_CC_OP_UNSIGNED_COMPARE = 2, 102 S390_CC_OP_SIGNED_ADD_32 = 3, 103 S390_CC_OP_SIGNED_ADD_64 = 4, 104 S390_CC_OP_UNSIGNED_ADD_32 = 5, 105 S390_CC_OP_UNSIGNED_ADD_64 = 6, 106 S390_CC_OP_UNSIGNED_ADDC_32 = 7, 107 S390_CC_OP_UNSIGNED_ADDC_64 = 8, 108 S390_CC_OP_SIGNED_SUB_32 = 9, 109 S390_CC_OP_SIGNED_SUB_64 = 10, 110 S390_CC_OP_UNSIGNED_SUB_32 = 11, 111 S390_CC_OP_UNSIGNED_SUB_64 = 12, 112 S390_CC_OP_UNSIGNED_SUBB_32 = 13, 113 S390_CC_OP_UNSIGNED_SUBB_64 = 14, 114 S390_CC_OP_LOAD_AND_TEST = 15, 115 S390_CC_OP_LOAD_POSITIVE_32 = 16, 116 S390_CC_OP_LOAD_POSITIVE_64 = 17, 117 S390_CC_OP_TEST_UNDER_MASK_8 = 18, 118 S390_CC_OP_TEST_UNDER_MASK_16 = 19, 119 S390_CC_OP_SHIFT_LEFT_32 = 20, 120 S390_CC_OP_SHIFT_LEFT_64 = 21, 121 S390_CC_OP_INSERT_CHAR_MASK_32 = 22, 122 S390_CC_OP_BFP_RESULT_32 = 23, 123 S390_CC_OP_BFP_RESULT_64 = 24, 124 S390_CC_OP_BFP_RESULT_128 = 25, 125 S390_CC_OP_BFP_32_TO_INT_32 = 26, 126 S390_CC_OP_BFP_64_TO_INT_32 = 27, 127 S390_CC_OP_BFP_128_TO_INT_32 = 28, 128 S390_CC_OP_BFP_32_TO_INT_64 = 29, 129 S390_CC_OP_BFP_64_TO_INT_64 = 30, 130 S390_CC_OP_BFP_128_TO_INT_64 = 31, 131 S390_CC_OP_BFP_TDC_32 = 32, 132 S390_CC_OP_BFP_TDC_64 = 33, 133 S390_CC_OP_BFP_TDC_128 = 34, 134 S390_CC_OP_SET = 35, 135 S390_CC_OP_BFP_32_TO_UINT_32 = 36, 136 S390_CC_OP_BFP_64_TO_UINT_32 = 37, 137 S390_CC_OP_BFP_128_TO_UINT_32 = 38, 138 S390_CC_OP_BFP_32_TO_UINT_64 = 39, 139 S390_CC_OP_BFP_64_TO_UINT_64 = 40, 140 S390_CC_OP_BFP_128_TO_UINT_64 = 41, 141 S390_CC_OP_DFP_RESULT_64 = 42, 142 S390_CC_OP_DFP_RESULT_128 = 43, 143 S390_CC_OP_DFP_TDC_32 = 44, 144 S390_CC_OP_DFP_TDC_64 = 45, 145 S390_CC_OP_DFP_TDC_128 = 46, 146 S390_CC_OP_DFP_TDG_32 = 47, 147 S390_CC_OP_DFP_TDG_64 = 48, 148 S390_CC_OP_DFP_TDG_128 = 49, 149 S390_CC_OP_DFP_64_TO_UINT_32 = 50, 150 S390_CC_OP_DFP_128_TO_UINT_32 = 51, 151 S390_CC_OP_DFP_64_TO_UINT_64 = 52, 152 S390_CC_OP_DFP_128_TO_UINT_64 = 53, 153 S390_CC_OP_DFP_64_TO_INT_32 = 54, 154 S390_CC_OP_DFP_128_TO_INT_32 = 55, 155 S390_CC_OP_DFP_64_TO_INT_64 = 56, 156 S390_CC_OP_DFP_128_TO_INT_64 = 57, 157 S390_CC_OP_PFPO_32 = 58, 158 S390_CC_OP_PFPO_64 = 59, 159 S390_CC_OP_PFPO_128 = 60 160 }; 161 162 /*------------------------------------------------------------*/ 163 /*--- Thunk layout ---*/ 164 /*------------------------------------------------------------*/ 165 166 /* 167 Z -- value is zero extended to 32 / 64 bit 168 S -- value is sign extended to 32 / 64 bit 169 F -- a binary floating point value 170 D -- a decimal floating point value 171 172 +--------------------------------+-----------------------+----------------------+-----------------+ 173 | op | cc_dep1 | cc_dep2 | cc_ndep | 174 +--------------------------------+-----------------------+----------------------+-----------------+ 175 | S390_CC_OP_BITWISE | Z result | | | 176 | S390_CC_OP_SIGNED_COMPARE | S 1st operand | S 2nd operand | | 177 | S390_CC_OP_UNSIGNED_COMPARE | Z 1st operand | Z 2nd operand | | 178 | S390_CC_OP_SIGNED_ADD_32 | S 1st operand | S 2nd operand | | 179 | S390_CC_OP_SIGNED_ADD_64 | S 1st operand | S 2nd operand | | 180 | S390_CC_OP_UNSIGNED_ADD_32 | Z 1st operand | Z 2nd operand | | 181 | S390_CC_OP_UNSIGNED_ADD_64 | Z 1st operand | Z 2nd operand | | 182 | S390_CC_OP_UNSIGNED_ADDC_32 | Z 1st operand | Z 2nd operand | Z carry in | 183 | S390_CC_OP_UNSIGNED_ADDC_64 | Z 1st operand | Z 2nd operand | Z carry in | 184 | S390_CC_OP_SIGNED_SUB_32 | S left operand | S right operand | | 185 | S390_CC_OP_SIGNED_SUB_64 | S left operand | S right operand | | 186 | S390_CC_OP_UNSIGNED_SUB_32 | Z left operand | Z right operand | | 187 | S390_CC_OP_UNSIGNED_SUB_64 | Z left operand | Z right operand | | 188 | S390_CC_OP_UNSIGNED_SUBB_32 | Z left operand | Z right operand | Z borrow in | 189 | S390_CC_OP_UNSIGNED_SUBB_64 | Z left operand | Z right operand | Z borrow in | 190 | S390_CC_OP_LOAD_AND_TEST | S loaded value | | | 191 | S390_CC_OP_LOAD_POSITIVE_32 | S loaded value | | | 192 | S390_CC_OP_LOAD_POSITIVE_64 | S loaded value | | | 193 | S390_CC_OP_TEST_UNDER_MASK_8 | Z tested value | Z mask | | 194 | S390_CC_OP_TEST_UNDER_MASK_16 | Z tested value | Z mask | | 195 | S390_CC_OP_SHIFT_LEFT_32 | Z value to be shifted | Z shift amount | | 196 | S390_CC_OP_SHIFT_LEFT_64 | Z value to be shifted | Z shift amount | | 197 | S390_CC_OP_INSERT_CHAR_MASK_32 | Z result | Z mask | | 198 | S390_CC_OP_BFP_RESULT_32 | F result | | | 199 | S390_CC_OP_BFP_RESULT_64 | F result | | | 200 | S390_CC_OP_BFP_RESULT_128 | F result hi 64 bits | F result low 64 bits | | 201 | S390_CC_OP_BFP_32_TO_INT_32 | F source | Z rounding mode | | 202 | S390_CC_OP_BFP_64_TO_INT_32 | F source | Z rounding mode | | 203 | S390_CC_OP_BFP_128_TO_INT_32 | F source hi 64 bits | F source low 64 bits | Z rounding mode | 204 | S390_CC_OP_BFP_32_TO_INT_64 | F source | Z rounding mode | | 205 | S390_CC_OP_BFP_64_TO_INT_64 | F source | Z rounding mode | | 206 | S390_CC_OP_BFP_128_TO_INT_64 | F source hi 64 bits | F source low 64 bits | Z rounding mode | 207 | S390_CC_OP_BFP_TDC_32 | F value | Z class | | 208 | S390_CC_OP_BFP_TDC_64 | F value | Z class | | 209 | S390_CC_OP_BFP_TDC_128 | F value hi 64 bits | F value low 64 bits | Z class | 210 | S390_CC_OP_SET | Z condition code | | | 211 | S390_CC_OP_BFP_32_TO_UINT_32 | F source | Z rounding mode | | 212 | S390_CC_OP_BFP_64_TO_UINT_32 | F source | Z rounding mode | | 213 | S390_CC_OP_BFP_128_TO_UINT_32 | F source hi 64 bits | F source low 64 bits | Z rounding mode | 214 | S390_CC_OP_BFP_32_TO_UINT_64 | F source | Z rounding mode | | 215 | S390_CC_OP_BFP_64_TO_UINT_64 | F source | Z rounding mode | | 216 | S390_CC_OP_BFP_128_TO_UINT_64 | F source hi 64 bits | F source low 64 bits | Z rounding mode | 217 | S390_CC_OP_DFP_RESULT_64 | D result | | | 218 | S390_CC_OP_DFP_RESULT_128 | D result hi 64 bits | D result low 64 bits | | 219 | S390_CC_OP_DFP_TDC_32 | D value | Z class | | 220 | S390_CC_OP_DFP_TDC_64 | D value | Z class | | 221 | S390_CC_OP_DFP_TDC_128 | D value hi 64 bits | D value low 64 bits | Z class | 222 | S390_CC_OP_DFP_TDG_32 | D value | Z group | | 223 | S390_CC_OP_DFP_TDG_64 | D value | Z group | | 224 | S390_CC_OP_DFP_TDG_128 | D value hi 64 bits | D value low 64 bits | Z group | 225 | S390_CC_OP_DFP_64_TO_UINT_32 | D source | Z rounding mode | | 226 | S390_CC_OP_DFP_128_TO_UINT_32 | D source hi 64 bits | D source low 64 bits | Z rounding mode | 227 | S390_CC_OP_DFP_64_TO_UINT_64 | D source | Z rounding mode | | 228 | S390_CC_OP_DFP_128_TO_UINT_64 | D source hi 64 bits | D source low 64 bits | Z rounding mode | 229 | S390_CC_OP_DFP_64_TO_INT_32 | D source | Z rounding mode | | 230 | S390_CC_OP_DFP_128_TO_INT_32 | D source hi 64 bits | D source low 64 bits | Z rounding mode | 231 | S390_CC_OP_DFP_64_TO_INT_64 | D source | Z rounding mode | | 232 | S390_CC_OP_DFP_128_TO_INT_64 | D source hi 64 bits | D source low 64 bits | Z rounding mode | 233 | S390_CC_OP_PFPO_32 | F|D source | Z GR0 low 32 bits | | 234 | S390_CC_OP_PFPO_64 | F|D source | Z GR0 low 32 bits | | 235 | S390_CC_OP_PFPO_128 | F|D source hi 64 bits | F|D src low 64 bits | Z GR0 low 32 bits | 236 +--------------------------------+-----------------------+----------------------+-----------------+ 237 */ 238 239 /*------------------------------------------------------------*/ 240 /*--- Condition code helpers. ---*/ 241 /*------------------------------------------------------------*/ 242 UInt s390_calculate_cc(ULong cc_op, ULong cc_dep1, ULong cc_dep2, 243 ULong cc_ndep); 244 UInt s390_calculate_cond(ULong mask, ULong op, ULong dep1, ULong dep2, 245 ULong ndep); 246 247 /* Size of special instruction preamble */ 248 #define S390_SPECIAL_OP_PREAMBLE_SIZE 8 249 250 /* Size of special instructions */ 251 #define S390_SPECIAL_OP_SIZE 2 252 253 /* Last target instruction for the EX helper */ 254 extern ULong last_execute_target; 255 256 /*---------------------------------------------------------------*/ 257 /*--- end guest_s390_defs.h ---*/ 258 /*---------------------------------------------------------------*/ 259 260 #endif /* __VEX_GUEST_S390_DEFS_H */ 261