VEX/pub/libvex_emnote.h

   1
   2 /*---------------------------------------------------------------*/
   3 /*--- begin                                   libvex_emnote.h ---*/
   4 /*---------------------------------------------------------------*/
   5
   6 /*
   7    This file is part of Valgrind, a dynamic binary instrumentation
   8    framework.
   9
  10    Copyright (C) 2004-2017 OpenWorks LLP
  11       info@open-works.net
  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, see <http://www.gnu.org/licenses/>.
  25
  26    The GNU General Public License is contained in the file COPYING.
  27
  28    Neither the names of the U.S. Department of Energy nor the
  29    University of California nor the names of its contributors may be
  30    used to endorse or promote products derived from this software
  31    without prior written permission.
  32 */
  33
  34 #ifndef __LIBVEX_EMNOTE_H
  35 #define __LIBVEX_EMNOTE_H
  36
  37 #include "libvex_basictypes.h"
  38
  39 /* VEX can sometimes generate code which returns to the dispatcher
  40    with the guest state pointer set to VEX_TRC_JMP_EMWARN or
  41    VEX_TRC_JMP_EMFAIL.  This means that VEX is trying to tell Valgrind
  42    something noteworthy about emulation progress. For example, that Valgrind
  43    is doing imprecise emulation in some sense.  The guest's pseudo-register
  44    "guest_EMNOTE" will hold a value of type VexEmNote, which describes
  45    the nature of the warning.  Currently the limitations that are
  46    warned about apply primarily to floating point support.
  47
  48    All guest states must have a 32-bit (UInt) guest_EMNOTE pseudo-
  49    register, that emulation warnings can be written in to.
  50
  51    Note that guest_EMNOTE only carries a valid value at the jump
  52    marked as VEX_TRC_JMP_EMWARN / VEX_TRC_JMP_EMFAIL.  You can't assume
  53    it will continue to carry a valid value from any amount of time after
  54    the jump.
  55 */
  56
  57 typedef
  58    enum {
  59       /* no note indicated */
  60       EmNote_NONE=0,
  61
  62       /* unmasking x87 FP exceptions is not supported */
  63       EmWarn_X86_x87exns,
  64
  65       /* change of x87 FP precision away from 64-bit (mantissa) */
  66       EmWarn_X86_x87precision,
  67
  68       /* unmasking SSE FP exceptions is not supported */
  69       EmWarn_X86_sseExns,
  70
  71       /* setting mxcsr.fz is not supported */
  72       EmWarn_X86_fz,
  73
  74       /* setting mxcsr.daz is not supported */
  75       EmWarn_X86_daz,
  76
  77       /* settings to %eflags.ac (alignment check) are noted but ignored */
  78       EmWarn_X86_acFlag,
  79
  80       /* unmasking PPC32/64 FP exceptions is not supported */
  81       EmWarn_PPCexns,
  82
  83       /* overflow/underflow of the PPC64 _REDIR stack (ppc64 only) */
  84       EmWarn_PPC64_redir_overflow,
  85       EmWarn_PPC64_redir_underflow,
  86
  87       /* insn specifies a rounding mode other than "according to FPC"
  88          which requires the floating point extension facility. But that
  89          facility is not available on this host */
  90       EmWarn_S390X_fpext_rounding,
  91
  92       /* insn (e.g. srnmb) specifies an invalid rounding mode */
  93       EmWarn_S390X_invalid_rounding,
  94
  95       /* stfle insn is not supported on this host */
  96       EmFail_S390X_stfle,
  97
  98       /* stckf insn is not supported on this host */
  99       EmFail_S390X_stckf,
 100
 101       /* ecag insn is not supported on this host */
 102       EmFail_S390X_ecag,
 103
 104       /* pfpo insn is not supported on this host */
 105       EmFail_S390X_pfpo,
 106
 107       /* DFP insns are not supported on this host */
 108       EmFail_S390X_DFP_insn,
 109
 110       /* insn needs floating point extension facility which is not
 111          available on this host */
 112       EmFail_S390X_fpext,
 113
 114       /* GPR 0 contains invalid rounding mode for PFPO instruction */
 115       EmFail_S390X_invalid_PFPO_rounding_mode,
 116
 117       /* The function code specified in GPR 0 executed by PFPO
 118          instruction is invalid */
 119       EmFail_S390X_invalid_PFPO_function,
 120
 121       /* some insn needs vector facility which is not available on this host */
 122       EmFail_S390X_vx,
 123
 124       /* ppno insn is not supported on this host */
 125       EmFail_S390X_ppno,
 126
 127       /* insn needs vector-enhancements facility which is not available on this
 128          host */
 129       EmFail_S390X_vxe,
 130
 131       EmNote_NUMBER
 132    }
 133    VexEmNote;
 134
 135
 136 /* Produces a short string describing the warning. */
 137 extern const HChar* LibVEX_EmNote_string ( VexEmNote );
 138
 139
 140 #endif /* ndef __LIBVEX_EMNOTE_H */
 141
 142 /*---------------------------------------------------------------*/
 143 /*---                                         libvex_emnote.h ---*/
 144 /*---------------------------------------------------------------*/