blob: 2e482f59a3f85f5f3a0b1bfba7b75077295d00e5 [file] [log] [blame]
sewardj2019a972011-03-07 16:04:07 +00001/* -*- 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
sewardj89ae8472013-10-18 14:12:58 +000011 Copyright IBM Corp. 2010-2013
sewardj2019a972011-03-07 16:04:07 +000012
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
floriane88b3c92011-07-05 02:48:39 +000036#include "libvex_basictypes.h" // offsetof
sewardj2019a972011-03-07 16:04:07 +000037#include "guest_generic_bb_to_IR.h" // DisResult
florianad43b3a2012-02-20 15:01:14 +000038#include "libvex_guest_s390x.h" // VexGuestS390XState
sewardj2019a972011-03-07 16:04:07 +000039
florianb4df7682011-07-05 02:09:01 +000040
sewardj2019a972011-03-07 16:04:07 +000041/* Convert one s390 insn to IR. See the type DisOneInstrFn in
42 bb_to_IR.h. */
sewardj2019a972011-03-07 16:04:07 +000043DisResult disInstr_S390 ( IRSB* irbb,
florianbeac5302014-12-31 12:09:38 +000044 Bool (*resteerOkFn) ( void*, Addr ),
sewardj2019a972011-03-07 16:04:07 +000045 Bool resteerCisOk,
46 void* callback_opaque,
florian8462d112014-09-24 15:18:09 +000047 const UChar* guest_code,
sewardj2019a972011-03-07 16:04:07 +000048 Long delta,
floriand4cc0de2015-01-02 11:44:12 +000049 Addr guest_IP,
sewardj2019a972011-03-07 16:04:07 +000050 VexArch guest_arch,
floriancacba8e2014-12-15 18:58:07 +000051 const VexArchInfo* archinfo,
52 const VexAbiInfo* abiinfo,
sewardj9b769162014-07-24 12:42:03 +000053 VexEndness host_endness,
sewardj442e51a2012-12-06 18:08:04 +000054 Bool sigill_diag );
sewardj2019a972011-03-07 16:04:07 +000055
56/* Used by the optimiser to specialise calls to helpers. */
florian1ff47562012-10-21 02:09:51 +000057IRExpr* guest_s390x_spechelper ( const HChar *function_name,
sewardj2019a972011-03-07 16:04:07 +000058 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. */
sewardj2019a972011-03-07 16:04:07 +000066Bool guest_s390x_state_requires_precise_mem_exns ( Int, Int );
67
florianb4df7682011-07-05 02:09:01 +000068extern VexGuestLayout s390xGuest_layout;
sewardj2019a972011-03-07 16:04:07 +000069
70
floriane88b3c92011-07-05 02:48:39 +000071#define S390X_GUEST_OFFSET(x) offsetof(VexGuestS390XState, x)
sewardj2019a972011-03-07 16:04:07 +000072
73/*------------------------------------------------------------*/
floriane711c802012-07-15 02:25:55 +000074/*--- Helper functions. ---*/
sewardj2019a972011-03-07 16:04:07 +000075/*------------------------------------------------------------*/
76void s390x_dirtyhelper_EX(ULong torun);
sewardj1e5fea62011-05-17 16:18:36 +000077ULong s390x_dirtyhelper_STCK(ULong *addr);
78ULong s390x_dirtyhelper_STCKF(ULong *addr);
79ULong s390x_dirtyhelper_STCKE(ULong *addr);
florianae884112012-07-27 20:55:01 +000080ULong s390x_dirtyhelper_STFLE(VexGuestS390XState *guest_state, ULong *addr);
floriana0100c92012-07-20 00:06:35 +000081void s390x_dirtyhelper_CUxy(UChar *addr, ULong data, ULong num_bytes);
sewardj2019a972011-03-07 16:04:07 +000082
florian3f8a96a2012-08-05 02:59:55 +000083ULong s390_do_cu12_cu14_helper1(UInt byte1, UInt etf3_and_m3_is_1);
florian6d9b9b22012-08-03 18:35:39 +000084ULong s390_do_cu12_helper2(UInt byte1, UInt byte2, UInt byte3, UInt byte4,
85 ULong stuff);
florian3f8a96a2012-08-05 02:59:55 +000086ULong s390_do_cu14_helper2(UInt byte1, UInt byte2, UInt byte3, UInt byte4,
87 ULong stuff);
floriana0100c92012-07-20 00:06:35 +000088ULong s390_do_cu21(UInt srcvalue, UInt low_surrogate);
florian2a415a12012-07-21 17:41:36 +000089ULong s390_do_cu24(UInt srcvalue, UInt low_surrogate);
florianaf2194f2012-08-06 00:07:54 +000090ULong s390_do_cu41(UInt srcvalue);
florian956194b2012-07-28 22:18:32 +000091ULong s390_do_cu42(UInt srcvalue);
floriane711c802012-07-15 02:25:55 +000092UInt s390_do_cvb(ULong decimal);
93ULong s390_do_cvd(ULong binary);
florian8c88cb62012-08-26 18:58:13 +000094ULong s390_do_ecag(ULong op2addr);
florian78d5ef72013-05-11 15:02:58 +000095UInt s390_do_pfpo(UInt gpr0);
floriane711c802012-07-15 02:25:55 +000096
sewardj2019a972011-03-07 16:04:07 +000097/* The various ways to compute the condition code. */
sewardj2019a972011-03-07 16:04:07 +000098enum {
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,
florian7700fc92012-01-16 17:25:55 +0000117 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,
florian1c8f7ff2012-09-01 00:12:11 +0000134 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,
florian12390202012-11-10 22:34:14 +0000140 S390_CC_OP_BFP_128_TO_UINT_64 = 41,
floriane38f6412012-12-21 17:32:12 +0000141 S390_CC_OP_DFP_RESULT_64 = 42,
floriance9e3db2012-12-27 20:14:03 +0000142 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,
florian5f034622013-01-13 02:29:05 +0000148 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,
floriana887acd2013-02-08 23:32:54 +0000154 S390_CC_OP_DFP_128_TO_INT_32 = 55,
155 S390_CC_OP_DFP_64_TO_INT_64 = 56,
florian78d5ef72013-05-11 15:02:58 +0000156 S390_CC_OP_DFP_128_TO_INT_64 = 57,
florian7ab421d2013-06-17 21:03:56 +0000157 S390_CC_OP_PFPO_32 = 58,
158 S390_CC_OP_PFPO_64 = 59,
159 S390_CC_OP_PFPO_128 = 60
sewardj2019a972011-03-07 16:04:07 +0000160};
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
floriancb2b24e2012-12-20 14:31:19 +0000170 D -- a decimal floating point value
sewardj2019a972011-03-07 16:04:07 +0000171
florian19e00772012-09-06 03:13:22 +0000172 +--------------------------------+-----------------------+----------------------+-----------------+
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 |
floriancb2b24e2012-12-20 14:31:19 +0000217 | S390_CC_OP_DFP_RESULT_64 | D result | | |
floriane38f6412012-12-21 17:32:12 +0000218 | S390_CC_OP_DFP_RESULT_128 | D result hi 64 bits | D result low 64 bits | |
floriance9e3db2012-12-27 20:14:03 +0000219 | 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 |
florian5f034622013-01-13 02:29:05 +0000225 | 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 |
florian1fd227c2013-02-08 16:01:23 +0000229 | 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 |
florian5f034622013-01-13 02:29:05 +0000231 | 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 |
florian7ab421d2013-06-17 21:03:56 +0000233 | S390_CC_OP_PFPO_32 | F|D source | Z GR0 low 32 bits | |
florian78d5ef72013-05-11 15:02:58 +0000234 | 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 |
florian19e00772012-09-06 03:13:22 +0000236 +--------------------------------+-----------------------+----------------------+-----------------+
sewardj2019a972011-03-07 16:04:07 +0000237*/
238
239/*------------------------------------------------------------*/
florianb4df7682011-07-05 02:09:01 +0000240/*--- Condition code helpers. ---*/
sewardj2019a972011-03-07 16:04:07 +0000241/*------------------------------------------------------------*/
242UInt s390_calculate_cc(ULong cc_op, ULong cc_dep1, ULong cc_dep2,
243 ULong cc_ndep);
sewardj2019a972011-03-07 16:04:07 +0000244UInt 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 */
254extern ULong last_execute_target;
255
256/*---------------------------------------------------------------*/
257/*--- end guest_s390_defs.h ---*/
258/*---------------------------------------------------------------*/
259
260#endif /* __VEX_GUEST_S390_DEFS_H */