Home | History | Annotate | Download | only in pub
      1 
      2 /*---------------------------------------------------------------*/
      3 /*--- begin                               libvex_basictypes.h ---*/
      4 /*---------------------------------------------------------------*/
      5 
      6 /*
      7    This file is part of Valgrind, a dynamic binary instrumentation
      8    framework.
      9 
     10    Copyright (C) 2004-2011 OpenWorks LLP
     11       info (at) 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, 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    Neither the names of the U.S. Department of Energy nor the
     31    University of California nor the names of its contributors may be
     32    used to endorse or promote products derived from this software
     33    without prior written permission.
     34 */
     35 
     36 #ifndef __LIBVEX_BASICTYPES_H
     37 #define __LIBVEX_BASICTYPES_H
     38 
     39 /* It is important that the sizes of the following data types (on the
     40    host) are as stated.  LibVEX_Init therefore checks these at
     41    startup. */
     42 
     43 /* Always 8 bits. */
     44 typedef  unsigned char   UChar;
     45 typedef    signed char   Char;
     46 typedef           char   HChar; /* signfulness depends on host */
     47                                 /* Only to be used for printf etc
     48                                    format strings */
     49 
     50 /* Always 16 bits. */
     51 typedef  unsigned short  UShort;
     52 typedef    signed short  Short;
     53 
     54 /* Always 32 bits. */
     55 typedef  unsigned int    UInt;
     56 typedef    signed int    Int;
     57 
     58 /* Always 64 bits. */
     59 typedef  unsigned long long int   ULong;
     60 typedef    signed long long int   Long;
     61 
     62 /* Always 128 bits. */
     63 typedef  UInt  U128[4];
     64 
     65 /* A union for doing 128-bit vector primitives conveniently. */
     66 typedef
     67    union {
     68       UChar  w8[16];
     69       UShort w16[8];
     70       UInt   w32[4];
     71       ULong  w64[2];
     72    }
     73    V128;
     74 
     75 /* Floating point. */
     76 typedef  float   Float;    /* IEEE754 single-precision (32-bit) value */
     77 typedef  double  Double;   /* IEEE754 double-precision (64-bit) value */
     78 
     79 /* Bool is always 8 bits. */
     80 typedef  unsigned char  Bool;
     81 #define  True   ((Bool)1)
     82 #define  False  ((Bool)0)
     83 
     84 /* Use this to coerce the result of a C comparison to a Bool.  This is
     85    useful when compiling with Intel icc with ultra-paranoid
     86    compilation flags (-Wall). */
     87 static inline Bool toBool ( Int x ) {
     88    Int r = (x == 0) ? False : True;
     89    return (Bool)r;
     90 }
     91 static inline UChar toUChar ( Int x ) {
     92    x &= 0xFF;
     93    return (UChar)x;
     94 }
     95 static inline HChar toHChar ( Int x ) {
     96    x &= 0xFF;
     97    return (HChar)x;
     98 }
     99 static inline UShort toUShort ( Int x ) {
    100    x &= 0xFFFF;
    101    return (UShort)x;
    102 }
    103 static inline Short toShort ( Int x ) {
    104    x &= 0xFFFF;
    105    return (Short)x;
    106 }
    107 static inline UInt toUInt ( Long x ) {
    108    x &= 0xFFFFFFFFLL;
    109    return (UInt)x;
    110 }
    111 
    112 /* 32/64 bit addresses. */
    113 typedef  UInt      Addr32;
    114 typedef  ULong     Addr64;
    115 
    116 /* Something which has the same size as void* on the host.  That is,
    117    it is 32 bits on a 32-bit host and 64 bits on a 64-bit host, and so
    118    it can safely be coerced to and from a pointer type on the host
    119    machine. */
    120 typedef  unsigned long HWord;
    121 
    122 
    123 /* This is so useful it should be visible absolutely everywhere. */
    124 #if !defined(offsetof)
    125 #   define offsetof(type,memb) ((Int)(HWord)&((type*)0)->memb)
    126 #endif
    127 
    128 
    129 /* We need to know the host word size in order to write Ptr_to_ULong
    130    and ULong_to_Ptr in a way that doesn't cause compilers to complain.
    131    These functions allow us to cast pointers to and from 64-bit
    132    integers without complaints from compilers, regardless of the host
    133    word size.
    134 
    135    Also set up VEX_REGPARM.
    136 */
    137 
    138 #undef VEX_HOST_WORDSIZE
    139 #undef VEX_REGPARM
    140 
    141 /* The following 4 work OK for Linux. */
    142 #if defined(__x86_64__)
    143 #   define VEX_HOST_WORDSIZE 8
    144 #   define VEX_REGPARM(_n) /* */
    145 
    146 #elif defined(__i386__)
    147 #   define VEX_HOST_WORDSIZE 4
    148 #   define VEX_REGPARM(_n) __attribute__((regparm(_n)))
    149 
    150 #elif defined(__powerpc__) && defined(__powerpc64__)
    151 #   define VEX_HOST_WORDSIZE 8
    152 #   define VEX_REGPARM(_n) /* */
    153 
    154 #elif defined(__powerpc__) && !defined(__powerpc64__)
    155 #   define VEX_HOST_WORDSIZE 4
    156 #   define VEX_REGPARM(_n) /* */
    157 
    158 #elif defined(__arm__)
    159 #   define VEX_HOST_WORDSIZE 4
    160 #   define VEX_REGPARM(_n) /* */
    161 
    162 #elif defined(_AIX) && !defined(__64BIT__)
    163 #   define VEX_HOST_WORDSIZE 4
    164 #   define VEX_REGPARM(_n) /* */
    165 
    166 #elif defined(_AIX) && defined(__64BIT__)
    167 #   define VEX_HOST_WORDSIZE 8
    168 #   define VEX_REGPARM(_n) /* */
    169 
    170 #elif defined(__s390x__)
    171 #   define VEX_HOST_WORDSIZE 8
    172 #   define VEX_REGPARM(_n) /* */
    173 
    174 #else
    175 #   error "Vex: Fatal: Can't establish the host architecture"
    176 #endif
    177 
    178 
    179 #if VEX_HOST_WORDSIZE == 8
    180    static inline ULong Ptr_to_ULong ( void* p ) {
    181       return (ULong)p;
    182    }
    183    static inline void* ULong_to_Ptr ( ULong n ) {
    184       return (void*)n;
    185    }
    186 #elif VEX_HOST_WORDSIZE == 4
    187    static inline ULong Ptr_to_ULong ( void* p ) {
    188       UInt w = (UInt)p;
    189       return (ULong)w;
    190    }
    191    static inline void* ULong_to_Ptr ( ULong n ) {
    192       UInt w = (UInt)n;
    193       return (void*)w;
    194    }
    195 #else
    196 #   error "Vex: Fatal: Can't define  Ptr_to_ULong / ULong_to_Ptr"
    197 #endif
    198 
    199 
    200 #endif /* ndef __LIBVEX_BASICTYPES_H */
    201 
    202 /*---------------------------------------------------------------*/
    203 /*---                                     libvex_basictypes.h ---*/
    204 /*---------------------------------------------------------------*/
    205