misc/decoder_test/XED2/include/xed/xed-util.h

   1 /*BEGIN_LEGAL
   2 Intel Open Source License
   3
   4 Copyright (c) 2002-2007 Intel Corporation
   5 All rights reserved.
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions are
   8 met:
   9
  10 Redistributions of source code must retain the above copyright notice,
  11 this list of conditions and the following disclaimer.  Redistributions
  12 in binary form must reproduce the above copyright notice, this list of
  13 conditions and the following disclaimer in the documentation and/or
  14 other materials provided with the distribution.  Neither the name of
  15 the Intel Corporation nor the names of its contributors may be used to
  16 endorse or promote products derived from this software without
  17 specific prior written permission.
  18
  19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE INTEL OR
  23 ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 END_LEGAL */
  31 /// @file xed-util.h
  32 /// @author Mark Charney   <mark.charney@intel.com>
  33
  34
  35
  36 #ifndef _XED_UTIL_H_
  37 # define _XED_UTIL_H_
  38
  39 #include "xed-common-hdrs.h"
  40 #include "xed-types.h"
  41 #include "xed-portability.h"
  42
  43
  44 ////////////////////////////////////////////////////////////////////////////
  45 // DEFINES
  46 ////////////////////////////////////////////////////////////////////////////
  47 extern int xed_verbose;
  48 #if defined(XED_MESSAGES)
  49 # include <stdio.h> // only with XED_MESSAGES defined
  50 extern  FILE* xed_log_file;
  51 #endif
  52 #define XED_EMIT_MESSAGES  (XED_MESSAGES==1 && xed_verbose >= 1)
  53 #define XED_INFO_VERBOSE   (XED_MESSAGES==1 && xed_verbose >= 2)
  54 #define XED_INFO2_VERBOSE  (XED_MESSAGES==1 && xed_verbose >= 3)
  55 #define XED_VERBOSE        (XED_MESSAGES==1 && xed_verbose >= 4)
  56 #define XED_MORE_VERBOSE   (XED_MESSAGES==1 && xed_verbose >= 5)
  57 #define XED_VERY_VERBOSE   (XED_MESSAGES==1 && xed_verbose >= 6)
  58
  59 #if defined(__GNUC__)
  60 # define XED_FUNCNAME __func__
  61 #else
  62 # define XED_FUNCNAME ""
  63 #endif
  64
  65 #if XED_MESSAGES==1
  66 #define XED2IMSG(x)                                             \
  67     do {                                                        \
  68         if (XED_EMIT_MESSAGES) {                                \
  69             if (XED_VERY_VERBOSE) {                             \
  70                 fprintf(xed_log_file,"%s:%d:%s: ",              \
  71                         __FILE__, __LINE__, XED_FUNCNAME);      \
  72             }                                                   \
  73             fprintf x;                                          \
  74             fflush(xed_log_file);                               \
  75         }                                                       \
  76     } while(0)
  77
  78 #define XED2TMSG(x)                                             \
  79     do {                                                        \
  80         if (XED_VERBOSE) {                                      \
  81             if (XED_VERY_VERBOSE) {                             \
  82                 fprintf(xed_log_file,"%s:%d:%s: ",              \
  83                         __FILE__, __LINE__, XED_FUNCNAME);      \
  84             }                                                   \
  85             fprintf x;                                          \
  86             fflush(xed_log_file);                               \
  87         }                                                       \
  88     } while(0)
  89
  90 #define XED2VMSG(x)                                             \
  91     do {                                                        \
  92         if (XED_VERY_VERBOSE) {                                 \
  93             fprintf(xed_log_file,"%s:%d:%s: ",                  \
  94                     __FILE__, __LINE__, XED_FUNCNAME);          \
  95             fprintf x;                                          \
  96             fflush(xed_log_file);                               \
  97         }                                                       \
  98     } while(0)
  99
 100 #define XED2DIE(x)                                              \
 101     do {                                                        \
 102         if (XED_EMIT_MESSAGES) {                                \
 103             fprintf(xed_log_file,"%s:%d:%s: ",                  \
 104                              __FILE__, __LINE__, XED_FUNCNAME); \
 105             fprintf x;                                          \
 106             fflush(xed_log_file);                               \
 107         }                                                       \
 108         xed_assert(0);                                          \
 109     } while(0)
 110
 111
 112
 113 #else
 114 # define XED2IMSG(x)
 115 # define XED2TMSG(x)
 116 # define XED2VMSG(x)
 117 # define XED2DIE(x) do { xed_assert(0); } while(0)
 118 #endif
 119
 120 #if defined(XED_ASSERTS)
 121 #  define xed_assert(x)  do { if (( x )== 0) xed_internal_assert( #x, __FILE__, __LINE__); } while(0)
 122 #else
 123 #  define xed_assert(x)  do {  } while(0)
 124 #endif
 125 XED_NORETURN XED_NOINLINE XED_DLL_EXPORT void xed_internal_assert(const char* s, const char* file, int line);
 126
 127 /// @ingroup INIT
 128 /// This is for registering a function to be called during XED's assert
 129 /// processing. If you do not register an abort function, then the system's
 130 /// abort function will be called. If your supplied function returns, then
 131 /// abort() will still be called.
 132 ///
 133 /// @param fn This is a function pointer for a function that should handle the
 134 ///        assertion reporting. The function pointer points to  a function that
 135 ///        takes 4 arguments:
 136 ///                     (1) msg, the assertion message,
 137 ///                     (2) file, the file name,
 138 ///                     (3) line, the line number (as an integer), and
 139 ///                     (4) other, a void pointer that is supplied as thei
 140 ///                         2nd argument to this registration.
 141 /// @param other This is a void* that is passed back to your supplied function  fn
 142 ///        as its 4th argument. It can be zero if you don't need this
 143 ///        feature. You can used this to convey whatever additional context
 144 ///        to your assertion handler (like FILE* pointers etc.).
 145 ///
 146 XED_DLL_EXPORT void xed_register_abort_function(void (*fn)(const char* msg,
 147                                                            const char* file, int line, void* other),
 148                                                 void* other);
 149
 150
 151 ////////////////////////////////////////////////////////////////////////////
 152 // PROTOTYPES
 153 ////////////////////////////////////////////////////////////////////////////
 154 char* xed_downcase_buf(char* s);
 155
 156 int xed_itoa(char* buf, xed_uint64_t f, int buflen);
 157 int xed_itoa_hex_zeros(char* buf, xed_uint64_t f, xed_uint_t xed_bits_to_print, xed_bool_t leading_zeros, int buflen);
 158 int xed_itoa_hex(char* buf, xed_uint64_t f, xed_uint_t xed_bits_to_print, int buflen);
 159 int xed_itoa_signed(char* buf, xed_int64_t f, int buflen);
 160
 161 char xed_to_ascii_hex_nibble(xed_uint_t x);
 162
 163 int xed_sprintf_uint8_hex(char* buf, xed_uint8_t x, int buflen);
 164 int xed_sprintf_uint16_hex(char* buf, xed_uint16_t x, int buflen);
 165 int xed_sprintf_uint32_hex(char* buf, xed_uint32_t x, int buflen);
 166 int xed_sprintf_uint64_hex(char* buf, xed_uint64_t x, int buflen);
 167 int xed_sprintf_uint8(char* buf, xed_uint8_t x, int buflen);
 168 int xed_sprintf_uint16(char* buf, xed_uint16_t x, int buflen);
 169 int xed_sprintf_uint32(char* buf, xed_uint32_t x, int buflen);
 170 int xed_sprintf_uint64(char* buf, xed_uint64_t x, int buflen);
 171 int xed_sprintf_int8(char* buf, xed_int8_t x, int buflen);
 172 int xed_sprintf_int16(char* buf, xed_int16_t x, int buflen);
 173 int xed_sprintf_int32(char* buf, xed_int32_t x, int buflen);
 174 int xed_sprintf_int64(char* buf, xed_int64_t x, int buflen);
 175
 176
 177 /// Set the FILE* for XED's log msgs
 178 XED_DLL_EXPORT void xed_set_log_file(FILE* o);
 179
 180
 181 /// Set the verbosity level for XED
 182 XED_DLL_EXPORT void xed_set_verbosity(int v);
 183
 184 void xed_derror(const char* s);
 185 void xed_dwarn(const char* s);
 186
 187 XED_DLL_EXPORT xed_int64_t xed_sign_extend32_64(xed_int32_t x);
 188 XED_DLL_EXPORT xed_int64_t xed_sign_extend16_64(xed_int16_t x);
 189 XED_DLL_EXPORT xed_int64_t xed_sign_extend8_64(xed_int8_t x);
 190
 191 XED_DLL_EXPORT xed_int32_t xed_sign_extend16_32(xed_int16_t x);
 192 XED_DLL_EXPORT xed_int32_t xed_sign_extend8_32(xed_int8_t x);
 193
 194 XED_DLL_EXPORT xed_int16_t xed_sign_extend8_16(xed_int8_t x);
 195
 196 ///arbitrary sign extension from a qty of "bits" length to 32b
 197 XED_DLL_EXPORT xed_int32_t xed_sign_extend_arbitrary_to_32(xed_uint32_t x, unsigned int bits);
 198
 199 ///arbitrary sign extension from a qty of "bits" length to 64b
 200 XED_DLL_EXPORT xed_int64_t xed_sign_extend_arbitrary_to_64(xed_uint64_t x, unsigned int bits);
 201
 202
 203 XED_DLL_EXPORT xed_uint64_t xed_zero_extend32_64(xed_uint32_t x);
 204 XED_DLL_EXPORT xed_uint64_t xed_zero_extend16_64(xed_uint16_t x);
 205 XED_DLL_EXPORT xed_uint64_t xed_zero_extend8_64(xed_uint8_t x);
 206
 207 XED_DLL_EXPORT xed_uint32_t xed_zero_extend16_32(xed_uint16_t x);
 208 XED_DLL_EXPORT xed_uint32_t xed_zero_extend8_32(xed_uint8_t x);
 209
 210 XED_DLL_EXPORT xed_uint16_t xed_zero_extend8_16(xed_uint8_t x);
 211
 212 XED_DLL_EXPORT xed_int32_t
 213 xed_little_endian_to_int32(xed_uint64_t x, unsigned int len);
 214
 215 XED_DLL_EXPORT xed_int64_t
 216 xed_little_endian_to_int64(xed_uint64_t x, unsigned int len);
 217 XED_DLL_EXPORT xed_uint64_t
 218 xed_little_endian_to_uint64(xed_uint64_t x, unsigned int len);
 219
 220 XED_DLL_EXPORT xed_int64_t
 221 xed_little_endian_hilo_to_int64(xed_uint32_t hi_le, xed_uint32_t lo_le, unsigned int len);
 222 XED_DLL_EXPORT xed_uint64_t
 223 xed_little_endian_hilo_to_uint64(xed_uint32_t hi_le, xed_uint32_t lo_le, unsigned int len);
 224
 225 XED_DLL_EXPORT xed_uint8_t
 226 xed_get_byte(xed_uint64_t x, unsigned int i, unsigned int len);
 227
 228 static XED_INLINE xed_uint64_t xed_make_uint64(xed_uint32_t hi, xed_uint32_t lo) {
 229     xed_uint64_t x,y;
 230     x=hi;
 231     y= (x<<32) | lo;
 232     return y;
 233 }
 234 static XED_INLINE xed_int64_t xed_make_int64(xed_uint32_t hi, xed_uint32_t lo) {
 235     xed_uint64_t x,y;
 236     x=hi;
 237     y= (x<<32) | lo;
 238     return STATIC_CAST(xed_int64_t,y);
 239 }
 240
 241 /// returns the number of bytes required to store the UNSIGNED number x
 242 /// given a mask of legal lengths. For the legal_widths argument, bit 0
 243 /// implies 1 byte is a legal return width, bit 1 implies that 2 bytes is a
 244 /// legal return width, bit 2 implies that 4 bytes is a legal return width.
 245 /// This returns 8 (indicating 8B) if none of the provided legal widths
 246 /// applies.
 247 XED_DLL_EXPORT xed_uint_t xed_shortest_width_unsigned(xed_uint64_t x, xed_uint8_t legal_widths);
 248
 249 /// returns the number of bytes required to store the SIGNED number x
 250 /// given a mask of legal lengths. For the legal_widths argument, bit 0 implies 1
 251 /// byte is a legal return width, bit 1 implies that 2 bytes is a legal
 252 /// return width, bit 2 implies that 4 bytes is a legal return width.  This
 253 /// returns 8 (indicating 8B) if none of the provided legal widths applies.
 254 XED_DLL_EXPORT xed_uint_t xed_shortest_width_signed(xed_int64_t x, xed_uint8_t legal_widths);
 255
 256 ////////////////////////////////////////////////////////////////////////////
 257 // GLOBALS
 258 ////////////////////////////////////////////////////////////////////////////
 259
 260 ////////////////////////////////////////////////////////////////////////////
 261 #endif
 262 //Local Variables:
 263 //pref: "../../xed-util.c"
 264 //End: