Home | History | Annotate | Download | only in priv
      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-2012
     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 "libvex_ir.h"                // IRSB  (needed by bb_to_IR.h)
     38 #include "libvex.h"                   // VexArch  (needed by bb_to_IR.h)
     39 #include "guest_generic_bb_to_IR.h"   // DisResult
     40 #include "libvex_guest_s390x.h"       // VexGuestS390XState
     41 
     42 
     43 /* Convert one s390 insn to IR.  See the type DisOneInstrFn in
     44    bb_to_IR.h. */
     45 DisResult disInstr_S390 ( IRSB*        irbb,
     46                           Bool         (*resteerOkFn) ( void*, Addr64 ),
     47                           Bool         resteerCisOk,
     48                           void*        callback_opaque,
     49                           UChar*       guest_code,
     50                           Long         delta,
     51                           Addr64       guest_IP,
     52                           VexArch      guest_arch,
     53                           VexArchInfo* archinfo,
     54                           VexAbiInfo*  abiinfo,
     55                           Bool         host_bigendian );
     56 
     57 /* Used by the optimiser to specialise calls to helpers. */
     58 IRExpr* guest_s390x_spechelper ( HChar   *function_name,
     59                                  IRExpr **args,
     60                                  IRStmt **precedingStmts,
     61                                  Int n_precedingStmts);
     62 
     63 
     64 /* Describes to the optimser which part of the guest state require
     65    precise memory exceptions.  This is logically part of the guest
     66    state description. */
     67 Bool guest_s390x_state_requires_precise_mem_exns ( Int, Int );
     68 
     69 extern VexGuestLayout s390xGuest_layout;
     70 
     71 
     72 #define S390X_GUEST_OFFSET(x)  offsetof(VexGuestS390XState, x)
     73 
     74 /*------------------------------------------------------------*/
     75 /*--- Helper functions.                                    ---*/
     76 /*------------------------------------------------------------*/
     77 void s390x_dirtyhelper_EX(ULong torun);
     78 ULong s390x_dirtyhelper_STCK(ULong *addr);
     79 ULong s390x_dirtyhelper_STCKF(ULong *addr);
     80 ULong s390x_dirtyhelper_STCKE(ULong *addr);
     81 ULong s390x_dirtyhelper_STFLE(VexGuestS390XState *guest_state, ULong *addr);
     82 void  s390x_dirtyhelper_CUxy(UChar *addr, ULong data, ULong num_bytes);
     83 
     84 ULong s390_do_cu12_cu14_helper1(UInt byte1, UInt etf3_and_m3_is_1);
     85 ULong s390_do_cu12_helper2(UInt byte1, UInt byte2, UInt byte3, UInt byte4,
     86                            ULong stuff);
     87 ULong s390_do_cu14_helper2(UInt byte1, UInt byte2, UInt byte3, UInt byte4,
     88                            ULong stuff);
     89 ULong s390_do_cu21(UInt srcvalue, UInt low_surrogate);
     90 ULong s390_do_cu24(UInt srcvalue, UInt low_surrogate);
     91 ULong s390_do_cu41(UInt srcvalue);
     92 ULong s390_do_cu42(UInt srcvalue);
     93 UInt  s390_do_cvb(ULong decimal);
     94 ULong s390_do_cvd(ULong binary);
     95 
     96 /* The various ways to compute the condition code. */
     97 enum {
     98    S390_CC_OP_BITWISE = 0,
     99    S390_CC_OP_SIGNED_COMPARE = 1,
    100    S390_CC_OP_UNSIGNED_COMPARE = 2,
    101    S390_CC_OP_SIGNED_ADD_32 = 3,
    102    S390_CC_OP_SIGNED_ADD_64 = 4,
    103    S390_CC_OP_UNSIGNED_ADD_32 = 5,
    104    S390_CC_OP_UNSIGNED_ADD_64 = 6,
    105    S390_CC_OP_UNSIGNED_ADDC_32 = 7,
    106    S390_CC_OP_UNSIGNED_ADDC_64 = 8,
    107    S390_CC_OP_SIGNED_SUB_32 = 9,
    108    S390_CC_OP_SIGNED_SUB_64 = 10,
    109    S390_CC_OP_UNSIGNED_SUB_32 = 11,
    110    S390_CC_OP_UNSIGNED_SUB_64 = 12,
    111    S390_CC_OP_UNSIGNED_SUBB_32 = 13,
    112    S390_CC_OP_UNSIGNED_SUBB_64 = 14,
    113    S390_CC_OP_LOAD_AND_TEST = 15,
    114    S390_CC_OP_LOAD_POSITIVE_32 = 16,
    115    S390_CC_OP_LOAD_POSITIVE_64 = 17,
    116    S390_CC_OP_TEST_UNDER_MASK_8 = 18,
    117    S390_CC_OP_TEST_UNDER_MASK_16 = 19,
    118    S390_CC_OP_SHIFT_LEFT_32 = 20,
    119    S390_CC_OP_SHIFT_LEFT_64 = 21,
    120    S390_CC_OP_INSERT_CHAR_MASK_32 = 22,
    121    S390_CC_OP_BFP_RESULT_32 = 23,
    122    S390_CC_OP_BFP_RESULT_64 = 24,
    123    S390_CC_OP_BFP_RESULT_128 = 25,
    124    S390_CC_OP_BFP_32_TO_INT_32 = 26,
    125    S390_CC_OP_BFP_64_TO_INT_32 = 27,
    126    S390_CC_OP_BFP_128_TO_INT_32 = 28,
    127    S390_CC_OP_BFP_32_TO_INT_64 = 29,
    128    S390_CC_OP_BFP_64_TO_INT_64 = 30,
    129    S390_CC_OP_BFP_128_TO_INT_64 = 31,
    130    S390_CC_OP_BFP_TDC_32 = 32,
    131    S390_CC_OP_BFP_TDC_64 = 33,
    132    S390_CC_OP_BFP_TDC_128 = 34,
    133    S390_CC_OP_SET = 35
    134 };
    135 
    136 /*------------------------------------------------------------*/
    137 /*--- Thunk layout                                         ---*/
    138 /*------------------------------------------------------------*/
    139 
    140 /*
    141    Z -- value is zero extended to 32 / 64 bit
    142    S -- value is sign extended to 32 / 64 bit
    143    F -- a binary floating point value
    144 
    145    +--------------------------------+-----------------------+----------------------+-------------+
    146    | op                             |   cc_dep1             |   cc_dep2            |   cc_ndep   |
    147    +--------------------------------+-----------------------+----------------------+-------------+
    148    | S390_CC_OP_BITWISE             | Z result              |                      |             |
    149    | S390_CC_OP_SIGNED_COMPARE      | S 1st operand         | S 2nd operand        |             |
    150    | S390_CC_OP_UNSIGNED_COMPARE    | Z 1st operand         | Z 2nd operand        |             |
    151    | S390_CC_OP_SIGNED_ADD_32       | S 1st operand         | S 2nd operand        |             |
    152    | S390_CC_OP_SIGNED_ADD_64       | S 1st operand         | S 2nd operand        |             |
    153    | S390_CC_OP_UNSIGNED_ADD_32     | Z 1st operand         | Z 2nd operand        |             |
    154    | S390_CC_OP_UNSIGNED_ADD_64     | Z 1st operand         | Z 2nd operand        |             |
    155    | S390_CC_OP_UNSIGNED_ADDC_32    | Z 1st operand         | Z 2nd operand        | Z carry in  |
    156    | S390_CC_OP_UNSIGNED_ADDC_64    | Z 1st operand         | Z 2nd operand        | Z carry in  |
    157    | S390_CC_OP_SIGNED_SUB_32       | S left operand        | S right operand      |             |
    158    | S390_CC_OP_SIGNED_SUB_64       | S left operand        | S right operand      |             |
    159    | S390_CC_OP_UNSIGNED_SUB_32     | Z left operand        | Z right operand      |             |
    160    | S390_CC_OP_UNSIGNED_SUB_64     | Z left operand        | Z right operand      |             |
    161    | S390_CC_OP_UNSIGNED_SUBB_32    | Z left operand        | Z right operand      | Z borrow in |
    162    | S390_CC_OP_UNSIGNED_SUBB_64    | Z left operand        | Z right operand      | Z borrow in |
    163    | S390_CC_OP_LOAD_AND_TEST       | S loaded value        |                      |             |
    164    | S390_CC_OP_LOAD_POSITIVE_32    | S loaded value        |                      |             |
    165    | S390_CC_OP_LOAD_POSITIVE_64    | S loaded value        |                      |             |
    166    | S390_CC_OP_TEST_UNDER_MASK_8   | Z tested value        | Z mask               |             |
    167    | S390_CC_OP_TEST_UNDER_MASK_16  | Z tested value        | Z mask               |             |
    168    | S390_CC_OP_SHIFT_LEFT_32       | Z value to be shifted | Z shift amount       |             |
    169    | S390_CC_OP_SHIFT_LEFT_64       | Z value to be shifted | Z shift amount       |             |
    170    | S390_CC_OP_INSERT_CHAR_MASK_32 | Z result              | Z mask               |             |
    171    | S390_CC_OP_BFP_RESULT_32       | F result              |                      |             |
    172    | S390_CC_OP_BFP_RESULT_64       | F result              |                      |             |
    173    | S390_CC_OP_BFP_RESULT_128      | F result hi 64 bits   | F result low 64 bits |             |
    174    | S390_CC_OP_BFP_32_TO_INT_32    | F source              |                      |             |
    175    | S390_CC_OP_BFP_64_TO_INT_32    | F source              |                      |             |
    176    | S390_CC_OP_BFP_128_TO_INT_32   | F source hi 64 bits   |                      |             |
    177    | S390_CC_OP_BFP_32_TO_INT_64    | F source              |                      |             |
    178    | S390_CC_OP_BFP_64_TO_INT_64    | F source              |                      |             |
    179    | S390_CC_OP_BFP_128_TO_INT_64   | F source hi 64 bits   |                      |             |
    180    | S390_CC_OP_BFP_TDC_32          | F value               | Z class              |             |
    181    | S390_CC_OP_BFP_TDC_64          | F value               | Z class              |             |
    182    | S390_CC_OP_BFP_TDC_128         | F value hi 64 bits    | F value low 64 bits  | Z class     |
    183    | S390_CC_OP_SET                 | Z condition code      |                      |             |
    184    +--------------------------------+-----------------------+----------------------+-------------+
    185 */
    186 
    187 /*------------------------------------------------------------*/
    188 /*--- Condition code helpers.                             ---*/
    189 /*------------------------------------------------------------*/
    190 UInt s390_calculate_cc(ULong cc_op, ULong cc_dep1, ULong cc_dep2,
    191                        ULong cc_ndep);
    192 UInt s390_calculate_cond(ULong mask, ULong op, ULong dep1, ULong dep2,
    193                          ULong ndep);
    194 
    195 /* Size of special instruction preamble */
    196 #define S390_SPECIAL_OP_PREAMBLE_SIZE 8
    197 
    198 /* Size of special instructions */
    199 #define S390_SPECIAL_OP_SIZE 2
    200 
    201 /* Last target instruction for the EX helper */
    202 extern ULong last_execute_target;
    203 
    204 /*---------------------------------------------------------------*/
    205 /*--- end                                   guest_s390_defs.h ---*/
    206 /*---------------------------------------------------------------*/
    207 
    208 #endif /* __VEX_GUEST_S390_DEFS_H */
    209