nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 1 | |
| 2 | /*--------------------------------------------------------------------*/ |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 3 | /*--- Header included by every tool C file. pub_tool_basics.h ---*/ |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 4 | /*--------------------------------------------------------------------*/ |
| 5 | |
| 6 | /* |
njn | b9c427c | 2004-12-01 14:14:42 +0000 | [diff] [blame] | 7 | This file is part of Valgrind, a dynamic binary instrumentation |
| 8 | framework. |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 9 | |
sewardj | b3a1e4b | 2015-08-21 11:32:26 +0000 | [diff] [blame] | 10 | Copyright (C) 2000-2015 Julian Seward |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 11 | jseward@acm.org |
| 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., 59 Temple Place, Suite 330, Boston, MA |
| 26 | 02111-1307, USA. |
| 27 | |
| 28 | The GNU General Public License is contained in the file COPYING. |
| 29 | */ |
| 30 | |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 31 | #ifndef __PUB_TOOL_BASICS_H |
| 32 | #define __PUB_TOOL_BASICS_H |
| 33 | |
| 34 | //-------------------------------------------------------------------- |
| 35 | // PURPOSE: This header should be imported by every single C file in |
| 36 | // tools. It contains the basic types and other things needed everywhere. |
| 37 | // There is no corresponding C file because this isn't a module |
| 38 | // containing executable code, it's all just declarations. |
| 39 | //-------------------------------------------------------------------- |
| 40 | |
| 41 | /* --------------------------------------------------------------------- |
| 42 | Other headers to include |
| 43 | ------------------------------------------------------------------ */ |
| 44 | |
florian | af93042 | 2014-12-29 19:06:40 +0000 | [diff] [blame] | 45 | // VEX defines Char, UChar, Short, UShort, Int, UInt, Long, ULong, SizeT, |
florian | 9b3da11 | 2014-12-31 12:11:15 +0000 | [diff] [blame] | 46 | // Addr, Addr32, Addr64, HWord, HChar, Bool, False and True. |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 47 | #include "libvex_basictypes.h" |
| 48 | |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 49 | // For varargs types |
| 50 | #include <stdarg.h> |
| 51 | |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 52 | |
| 53 | /* --------------------------------------------------------------------- |
njn | 9c53325 | 2009-04-24 04:57:07 +0000 | [diff] [blame] | 54 | symbol prefixing |
| 55 | ------------------------------------------------------------------ */ |
| 56 | |
| 57 | // All symbols externally visible from Valgrind are prefixed |
| 58 | // as specified here to avoid namespace conflict problems. |
| 59 | // |
| 60 | // VG_ is for symbols exported from modules. ML_ (module-local) is |
| 61 | // for symbols which are not intended to be visible outside modules, |
| 62 | // but which cannot be declared as C 'static's since they need to be |
| 63 | // visible across C files within a given module. It is a mistake for |
| 64 | // a ML_ name to appear in a pub_core_*.h or pub_tool_*.h file. |
| 65 | // Likewise it is a mistake for a VG_ name to appear in a priv_*.h |
| 66 | // file. |
| 67 | |
| 68 | #define VGAPPEND(str1,str2) str1##str2 |
| 69 | |
| 70 | #define VG_(str) VGAPPEND(vgPlain_, str) |
| 71 | #define ML_(str) VGAPPEND(vgModuleLocal_, str) |
| 72 | |
| 73 | |
| 74 | /* --------------------------------------------------------------------- |
njn | d01fef7 | 2005-03-25 23:35:48 +0000 | [diff] [blame] | 75 | builtin types |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 76 | ------------------------------------------------------------------ */ |
| 77 | |
| 78 | // By choosing the right types, we can get these right for 32-bit and 64-bit |
| 79 | // platforms without having to do any conditional compilation or anything. |
njn | c4431bf | 2009-01-15 21:29:24 +0000 | [diff] [blame] | 80 | // POSIX references: |
| 81 | // - http://www.opengroup.org/onlinepubs/009695399/basedefs/sys/types.h.html |
| 82 | // - http://www.opengroup.org/onlinepubs/009695399/basedefs/stddef.h.html |
nethercote | 8b5f40c | 2004-11-02 13:29:50 +0000 | [diff] [blame] | 83 | // |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 84 | // Size in bits on: 32-bit archs 64-bit archs |
| 85 | // ------------ ------------ |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 86 | typedef unsigned long UWord; // 32 64 |
njn | c4431bf | 2009-01-15 21:29:24 +0000 | [diff] [blame] | 87 | typedef signed long Word; // 32 64 |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 88 | |
florian | af93042 | 2014-12-29 19:06:40 +0000 | [diff] [blame] | 89 | // Our equivalent of POSIX 'ssize_t': |
njn | c4431bf | 2009-01-15 21:29:24 +0000 | [diff] [blame] | 90 | // - ssize_t is "used for a count of bytes or an error indication". |
nethercote | 7ac7f7b | 2004-11-02 12:36:02 +0000 | [diff] [blame] | 91 | typedef Word SSizeT; // 32 64 |
| 92 | |
njn | c4431bf | 2009-01-15 21:29:24 +0000 | [diff] [blame] | 93 | // Our equivalent of POSIX 'ptrdiff_t': |
| 94 | // - ptrdiff_t is a "signed integer type of the result of subtracting two |
| 95 | // pointers". |
| 96 | // We use it for memory offsets, eg. the offset into a memory block. |
| 97 | typedef Word PtrdiffT; // 32 64 |
nethercote | 5b9fafd | 2004-11-04 18:39:22 +0000 | [diff] [blame] | 98 | |
njn | c4431bf | 2009-01-15 21:29:24 +0000 | [diff] [blame] | 99 | // Our equivalent of POSIX 'off_t': |
| 100 | // - off_t is "used for file sizes". |
| 101 | // At one point we were using it for memory offsets, but PtrdiffT should be |
| 102 | // used in those cases. |
sewardj | 6e9de46 | 2011-06-28 07:25:29 +0000 | [diff] [blame] | 103 | // Nb: on Linux, off_t is a signed word-sized int. On Darwin it's |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 104 | // always a signed 64-bit int. So we defined our own Off64T as well. |
sewardj | 8eb8bab | 2015-07-21 14:44:28 +0000 | [diff] [blame] | 105 | #if defined(VGO_linux) || defined(VGO_solaris) |
njn | c4431bf | 2009-01-15 21:29:24 +0000 | [diff] [blame] | 106 | typedef Word OffT; // 32 64 |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 107 | #elif defined(VGO_darwin) |
| 108 | typedef Long OffT; // 64 64 |
| 109 | #else |
| 110 | # error Unknown OS |
| 111 | #endif |
njn | c4431bf | 2009-01-15 21:29:24 +0000 | [diff] [blame] | 112 | typedef Long Off64T; // 64 64 |
sewardj | 274461d | 2005-10-02 17:01:41 +0000 | [diff] [blame] | 113 | |
njn | 21edee3 | 2005-06-11 04:44:38 +0000 | [diff] [blame] | 114 | #if !defined(NULL) |
| 115 | # define NULL ((void*)0) |
| 116 | #endif |
sewardj | bc7df20 | 2005-05-02 10:25:34 +0000 | [diff] [blame] | 117 | |
sewardj | 9c606bd | 2008-09-18 18:12:50 +0000 | [diff] [blame] | 118 | /* This is just too useful to not have around the place somewhere. */ |
| 119 | typedef struct { UWord uw1; UWord uw2; } UWordPair; |
| 120 | |
sewardj | e1f33a4 | 2006-10-17 01:38:48 +0000 | [diff] [blame] | 121 | |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 122 | /* --------------------------------------------------------------------- |
| 123 | non-builtin types |
| 124 | ------------------------------------------------------------------ */ |
| 125 | |
| 126 | // These probably shouldn't be here, but moving them to their logical |
| 127 | // modules results in a lot more #includes... |
| 128 | |
| 129 | /* ThreadIds are simply indices into the VG_(threads)[] array. */ |
| 130 | typedef UInt ThreadId; |
| 131 | |
| 132 | /* An abstraction of syscall return values. |
sewardj | bd664fd | 2015-07-08 17:08:23 +0000 | [diff] [blame] | 133 | Linux/MIPS32 and Linux/MIPS64: |
| 134 | When _isError == False, |
| 135 | _val and possible _valEx hold the return value. Whether |
| 136 | _valEx actually holds a valid value depends on which syscall |
| 137 | this SysRes holds of the result of. |
| 138 | When _isError == True, |
| 139 | _val holds the error code. |
| 140 | |
| 141 | Linux/other: |
njn | cda2f0f | 2009-05-18 02:12:08 +0000 | [diff] [blame] | 142 | When _isError == False, |
| 143 | _val holds the return value. |
| 144 | When _isError == True, |
sewardj | bd664fd | 2015-07-08 17:08:23 +0000 | [diff] [blame] | 145 | _val holds the error code. |
sewardj | e1f33a4 | 2006-10-17 01:38:48 +0000 | [diff] [blame] | 146 | |
njn | cda2f0f | 2009-05-18 02:12:08 +0000 | [diff] [blame] | 147 | Darwin: |
| 148 | Interpretation depends on _mode: |
| 149 | MACH, MDEP: |
| 150 | these can never 'fail' (apparently). The result of the |
| 151 | syscall is a single host word, _wLO. |
| 152 | UNIX: |
| 153 | Can record a double-word error or a double-word result: |
| 154 | When _mode is SysRes_UNIX_OK, _wHI:_wLO holds the result. |
| 155 | When _mode is SysRes_UNIX_ERR, _wHI:_wLO holds the error code. |
| 156 | Probably the high word of an error is always ignored by |
| 157 | userspace, but we have to record it, so that we can correctly |
njn | 38c73d7 | 2009-05-19 01:32:52 +0000 | [diff] [blame] | 158 | update both {R,E}DX and {R,E}AX (in guest state) given a SysRes, |
| 159 | if we're required to. |
sewardj | 8eb8bab | 2015-07-21 14:44:28 +0000 | [diff] [blame] | 160 | |
| 161 | Solaris: |
| 162 | When _isError == False, |
| 163 | _val and _val2 hold the return value. |
| 164 | When _isError == True, |
| 165 | _val holds the error code. |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 166 | */ |
sewardj | bd664fd | 2015-07-08 17:08:23 +0000 | [diff] [blame] | 167 | #if defined(VGP_mips32_linux) || defined(VGP_mips64_linux) |
sewardj | e1f33a4 | 2006-10-17 01:38:48 +0000 | [diff] [blame] | 168 | typedef |
| 169 | struct { |
njn | cda2f0f | 2009-05-18 02:12:08 +0000 | [diff] [blame] | 170 | Bool _isError; |
florian | 9c120ae | 2015-04-20 21:02:18 +0000 | [diff] [blame] | 171 | UWord _val; |
florian | 9c120ae | 2015-04-20 21:02:18 +0000 | [diff] [blame] | 172 | UWord _valEx; |
sewardj | e1f33a4 | 2006-10-17 01:38:48 +0000 | [diff] [blame] | 173 | } |
| 174 | SysRes; |
sewardj | bd664fd | 2015-07-08 17:08:23 +0000 | [diff] [blame] | 175 | |
| 176 | #elif defined(VGO_linux) \ |
| 177 | && !defined(VGP_mips32_linux) && !defined(VGP_mips64_linux) |
| 178 | typedef |
| 179 | struct { |
| 180 | Bool _isError; |
| 181 | UWord _val; |
| 182 | } |
| 183 | SysRes; |
| 184 | |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 185 | #elif defined(VGO_darwin) |
| 186 | typedef |
bart | 116458b | 2009-12-29 14:11:38 +0000 | [diff] [blame] | 187 | enum { |
| 188 | SysRes_MACH=40, // MACH, result is _wLO |
| 189 | SysRes_MDEP, // MDEP, result is _wLO |
| 190 | SysRes_UNIX_OK, // UNIX, success, result is _wHI:_wLO |
| 191 | SysRes_UNIX_ERR // UNIX, error, error is _wHI:_wLO |
| 192 | } |
| 193 | SysResMode; |
| 194 | typedef |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 195 | struct { |
| 196 | UWord _wLO; |
| 197 | UWord _wHI; |
bart | 116458b | 2009-12-29 14:11:38 +0000 | [diff] [blame] | 198 | SysResMode _mode; |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 199 | } |
| 200 | SysRes; |
sewardj | bd664fd | 2015-07-08 17:08:23 +0000 | [diff] [blame] | 201 | |
sewardj | 8eb8bab | 2015-07-21 14:44:28 +0000 | [diff] [blame] | 202 | #elif defined(VGO_solaris) |
| 203 | typedef |
| 204 | struct { |
| 205 | UWord _val; |
| 206 | UWord _val2; |
| 207 | Bool _isError; |
| 208 | } |
| 209 | SysRes; |
| 210 | |
njn | cda2f0f | 2009-05-18 02:12:08 +0000 | [diff] [blame] | 211 | #else |
| 212 | # error "Unknown OS" |
| 213 | #endif |
| 214 | |
| 215 | |
| 216 | /* ---- And now some basic accessor functions for it. ---- */ |
| 217 | |
sewardj | bd664fd | 2015-07-08 17:08:23 +0000 | [diff] [blame] | 218 | #if defined(VGP_mips32_linux) || defined(VGP_mips64_linux) |
njn | cda2f0f | 2009-05-18 02:12:08 +0000 | [diff] [blame] | 219 | |
| 220 | static inline Bool sr_isError ( SysRes sr ) { |
| 221 | return sr._isError; |
| 222 | } |
| 223 | static inline UWord sr_Res ( SysRes sr ) { |
| 224 | return sr._isError ? 0 : sr._val; |
| 225 | } |
sewardj | 5db1540 | 2012-06-07 09:13:21 +0000 | [diff] [blame] | 226 | static inline UWord sr_ResEx ( SysRes sr ) { |
| 227 | return sr._isError ? 0 : sr._valEx; |
| 228 | } |
njn | cda2f0f | 2009-05-18 02:12:08 +0000 | [diff] [blame] | 229 | static inline UWord sr_Err ( SysRes sr ) { |
| 230 | return sr._isError ? sr._val : 0; |
| 231 | } |
sewardj | bd664fd | 2015-07-08 17:08:23 +0000 | [diff] [blame] | 232 | static inline Bool sr_EQ ( UInt sysno, SysRes sr1, SysRes sr2 ) { |
| 233 | /* This uglyness of hardcoding syscall numbers is necessary to |
| 234 | avoid having this header file be dependant on |
| 235 | include/vki/vki-scnums-mips{32,64}-linux.h. It seems pretty |
| 236 | safe given that it is inconceivable that the syscall numbers |
| 237 | for such simple syscalls would ever change. To make it |
| 238 | really safe, coregrind/m_vkiscnums.c static-asserts that these |
| 239 | syscall numbers haven't changed, so that the build wil simply |
| 240 | fail if they ever do. */ |
| 241 | # if defined(VGP_mips32_linux) |
| 242 | const UInt __nr_Linux = 4000; |
| 243 | const UInt __nr_pipe = __nr_Linux + 42; |
| 244 | const UInt __nr_pipe2 = __nr_Linux + 328; |
| 245 | # else |
| 246 | const UInt __nr_Linux = 5000; |
| 247 | const UInt __nr_pipe = __nr_Linux + 21; |
| 248 | const UInt __nr_pipe2 = __nr_Linux + 287; |
| 249 | # endif |
| 250 | Bool useEx = sysno == __nr_pipe || sysno == __nr_pipe2; |
florian | d59d978 | 2015-04-01 19:20:16 +0000 | [diff] [blame] | 251 | return sr1._val == sr2._val |
sewardj | bd664fd | 2015-07-08 17:08:23 +0000 | [diff] [blame] | 252 | && (useEx ? (sr1._valEx == sr2._valEx) : True) |
| 253 | && sr1._isError == sr2._isError; |
| 254 | } |
| 255 | |
| 256 | #elif defined(VGO_linux) \ |
| 257 | && !defined(VGP_mips32_linux) && !defined(VGP_mips64_linux) |
| 258 | |
| 259 | static inline Bool sr_isError ( SysRes sr ) { |
| 260 | return sr._isError; |
| 261 | } |
| 262 | static inline UWord sr_Res ( SysRes sr ) { |
| 263 | return sr._isError ? 0 : sr._val; |
| 264 | } |
| 265 | static inline UWord sr_Err ( SysRes sr ) { |
| 266 | return sr._isError ? sr._val : 0; |
| 267 | } |
| 268 | static inline Bool sr_EQ ( UInt sysno, SysRes sr1, SysRes sr2 ) { |
| 269 | /* sysno is ignored for Linux/not-MIPS */ |
| 270 | return sr1._val == sr2._val |
| 271 | && sr1._isError == sr2._isError; |
njn | cda2f0f | 2009-05-18 02:12:08 +0000 | [diff] [blame] | 272 | } |
| 273 | |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 274 | #elif defined(VGO_darwin) |
| 275 | |
| 276 | static inline Bool sr_isError ( SysRes sr ) { |
| 277 | switch (sr._mode) { |
sewardj | 19e2c94 | 2014-10-17 15:05:01 +0000 | [diff] [blame] | 278 | case SysRes_UNIX_ERR: |
| 279 | return True; |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 280 | /* should check tags properly and assert here, but we can't here */ |
sewardj | 19e2c94 | 2014-10-17 15:05:01 +0000 | [diff] [blame] | 281 | case SysRes_MACH: |
| 282 | case SysRes_MDEP: |
| 283 | case SysRes_UNIX_OK: |
| 284 | default: |
| 285 | return False; |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 286 | } |
| 287 | } |
| 288 | |
| 289 | static inline UWord sr_Res ( SysRes sr ) { |
| 290 | switch (sr._mode) { |
| 291 | case SysRes_MACH: |
| 292 | case SysRes_MDEP: |
sewardj | 19e2c94 | 2014-10-17 15:05:01 +0000 | [diff] [blame] | 293 | case SysRes_UNIX_OK: |
| 294 | return sr._wLO; |
| 295 | /* should assert, but we can't here */ |
| 296 | case SysRes_UNIX_ERR: |
| 297 | default: |
| 298 | return 0; |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 299 | } |
| 300 | } |
| 301 | |
| 302 | static inline UWord sr_ResHI ( SysRes sr ) { |
| 303 | switch (sr._mode) { |
sewardj | 19e2c94 | 2014-10-17 15:05:01 +0000 | [diff] [blame] | 304 | case SysRes_UNIX_OK: |
| 305 | return sr._wHI; |
| 306 | /* should assert, but we can't here */ |
| 307 | case SysRes_MACH: |
| 308 | case SysRes_MDEP: |
| 309 | case SysRes_UNIX_ERR: |
| 310 | default: |
| 311 | return 0; |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 312 | } |
| 313 | } |
| 314 | |
| 315 | static inline UWord sr_Err ( SysRes sr ) { |
| 316 | switch (sr._mode) { |
sewardj | 19e2c94 | 2014-10-17 15:05:01 +0000 | [diff] [blame] | 317 | case SysRes_UNIX_ERR: |
| 318 | return sr._wLO; |
| 319 | /* should assert, but we can't here */ |
| 320 | case SysRes_MACH: |
| 321 | case SysRes_MDEP: |
| 322 | case SysRes_UNIX_OK: |
| 323 | default: |
| 324 | return 0; |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 325 | } |
| 326 | } |
| 327 | |
sewardj | bd664fd | 2015-07-08 17:08:23 +0000 | [diff] [blame] | 328 | static inline Bool sr_EQ ( UInt sysno, SysRes sr1, SysRes sr2 ) { |
| 329 | /* sysno is ignored for Darwin */ |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 330 | return sr1._mode == sr2._mode |
| 331 | && sr1._wLO == sr2._wLO && sr1._wHI == sr2._wHI; |
| 332 | } |
| 333 | |
sewardj | 8eb8bab | 2015-07-21 14:44:28 +0000 | [diff] [blame] | 334 | #elif defined(VGO_solaris) |
| 335 | |
| 336 | static inline Bool sr_isError ( SysRes sr ) { |
| 337 | return sr._isError; |
| 338 | } |
| 339 | static inline UWord sr_Res ( SysRes sr ) { |
| 340 | return sr._isError ? 0 : sr._val; |
| 341 | } |
| 342 | static inline UWord sr_ResHI ( SysRes sr ) { |
| 343 | return sr._isError ? 0 : sr._val2; |
| 344 | } |
| 345 | static inline UWord sr_Err ( SysRes sr ) { |
| 346 | return sr._isError ? sr._val : 0; |
| 347 | } |
| 348 | static inline Bool sr_EQ ( UInt sysno, SysRes sr1, SysRes sr2 ) { |
| 349 | /* sysno is ignored for Solaris */ |
| 350 | return sr1._val == sr2._val |
| 351 | && sr1._val2 == sr2._val2 |
| 352 | && sr1._isError == sr2._isError; |
| 353 | } |
| 354 | |
njn | cda2f0f | 2009-05-18 02:12:08 +0000 | [diff] [blame] | 355 | #else |
| 356 | # error "Unknown OS" |
| 357 | #endif |
sewardj | e1f33a4 | 2006-10-17 01:38:48 +0000 | [diff] [blame] | 358 | |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 359 | |
| 360 | /* --------------------------------------------------------------------- |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 361 | Miscellaneous (word size, endianness, regparmness, stringification) |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 362 | ------------------------------------------------------------------ */ |
| 363 | |
sewardj | 6e340c7 | 2005-07-10 00:53:42 +0000 | [diff] [blame] | 364 | /* Word size: this is going to be either 4 or 8. */ |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 365 | // It should probably be in m_machine. |
| 366 | #define VG_WORDSIZE VEX_HOST_WORDSIZE |
| 367 | |
sewardj | 6e340c7 | 2005-07-10 00:53:42 +0000 | [diff] [blame] | 368 | /* Endianness */ |
| 369 | #undef VG_BIGENDIAN |
| 370 | #undef VG_LITTLEENDIAN |
| 371 | |
sewardj | 5db1540 | 2012-06-07 09:13:21 +0000 | [diff] [blame] | 372 | #if defined(VGA_x86) || defined(VGA_amd64) || defined (VGA_arm) \ |
sewardj | f0c1250 | 2014-01-12 12:54:00 +0000 | [diff] [blame] | 373 | || ((defined(VGA_mips32) || defined(VGA_mips64)) && defined (_MIPSEL)) \ |
sewardj | 112711a | 2015-04-10 12:30:09 +0000 | [diff] [blame] | 374 | || defined(VGA_arm64) || defined(VGA_ppc64le) || defined(VGA_tilegx) |
sewardj | 6e340c7 | 2005-07-10 00:53:42 +0000 | [diff] [blame] | 375 | # define VG_LITTLEENDIAN 1 |
carll | cae0cc2 | 2014-08-07 23:17:29 +0000 | [diff] [blame] | 376 | #elif defined(VGA_ppc32) || defined(VGA_ppc64be) || defined(VGA_s390x) \ |
petarj | 4df0bfc | 2013-02-27 23:17:33 +0000 | [diff] [blame] | 377 | || ((defined(VGA_mips32) || defined(VGA_mips64)) && defined (_MIPSEB)) |
sewardj | 6e340c7 | 2005-07-10 00:53:42 +0000 | [diff] [blame] | 378 | # define VG_BIGENDIAN 1 |
njn | 38c73d7 | 2009-05-19 01:32:52 +0000 | [diff] [blame] | 379 | #else |
| 380 | # error Unknown arch |
sewardj | 6e340c7 | 2005-07-10 00:53:42 +0000 | [diff] [blame] | 381 | #endif |
| 382 | |
florian | d65f726 | 2014-12-29 22:19:24 +0000 | [diff] [blame] | 383 | /* Offsetof */ |
| 384 | #if !defined(offsetof) |
| 385 | # define offsetof(type,memb) ((SizeT)(HWord)&((type*)0)->memb) |
| 386 | #endif |
| 387 | |
| 388 | /* Alignment */ |
| 389 | /* We use a prefix vg_ for vg_alignof as its behaviour slightly |
| 390 | differs from the standard alignof/gcc defined __alignof__ |
| 391 | |
| 392 | vg_alignof returns a "safe" alignement. |
| 393 | "safe" is defined as the alignment chosen by the compiler in |
| 394 | a struct made of a char followed by this type. |
| 395 | |
| 396 | Note that this is not necessarily the "preferred" alignment |
| 397 | for a platform. This preferred alignment is returned by the gcc |
| 398 | __alignof__ and by the standard (in recent standard) alignof. |
| 399 | Compared to __alignof__, vg_alignof gives on some platforms (e.g. |
| 400 | amd64, ppc32, ppc64) a bigger alignment for long double (16 bytes |
| 401 | instead of 8). |
| 402 | On some platforms (e.g. x86), vg_alignof gives a smaller alignment |
| 403 | than __alignof__ for long long and double (4 bytes instead of 8). |
| 404 | If we want to have the "preferred" alignment for the basic types, |
| 405 | then either we need to depend on gcc __alignof__, or on a (too) |
| 406 | recent standard and compiler (implementing <stdalign.h>). |
| 407 | */ |
| 408 | #define vg_alignof(_type) (sizeof(struct {char c;_type _t;})-sizeof(_type)) |
| 409 | |
sewardj | 6e340c7 | 2005-07-10 00:53:42 +0000 | [diff] [blame] | 410 | /* Regparmness */ |
njn | f536bbb | 2005-06-13 04:21:38 +0000 | [diff] [blame] | 411 | #if defined(VGA_x86) |
njn | af839f5 | 2005-06-23 03:27:57 +0000 | [diff] [blame] | 412 | # define VG_REGPARM(n) __attribute__((regparm(n))) |
sewardj | 59570ff | 2010-01-01 11:59:33 +0000 | [diff] [blame] | 413 | #elif defined(VGA_amd64) || defined(VGA_ppc32) \ |
carll | cae0cc2 | 2014-08-07 23:17:29 +0000 | [diff] [blame] | 414 | || defined(VGA_ppc64be) || defined(VGA_ppc64le) \ |
| 415 | || defined(VGA_arm) || defined(VGA_s390x) \ |
sewardj | f0c1250 | 2014-01-12 12:54:00 +0000 | [diff] [blame] | 416 | || defined(VGA_mips32) || defined(VGA_mips64) \ |
sewardj | 112711a | 2015-04-10 12:30:09 +0000 | [diff] [blame] | 417 | || defined(VGA_arm64) || defined(VGA_tilegx) |
njn | af839f5 | 2005-06-23 03:27:57 +0000 | [diff] [blame] | 418 | # define VG_REGPARM(n) /* */ |
njn | f536bbb | 2005-06-13 04:21:38 +0000 | [diff] [blame] | 419 | #else |
| 420 | # error Unknown arch |
| 421 | #endif |
| 422 | |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 423 | /* Macro games */ |
| 424 | #define VG_STRINGIFZ(__str) #__str |
| 425 | #define VG_STRINGIFY(__str) VG_STRINGIFZ(__str) |
| 426 | |
njn | 64ea7f8 | 2006-10-14 23:26:21 +0000 | [diff] [blame] | 427 | // Where to send bug reports to. |
| 428 | #define VG_BUGS_TO "www.valgrind.org" |
| 429 | |
bart | 5dd8e6a | 2008-03-22 08:04:29 +0000 | [diff] [blame] | 430 | /* Branch prediction hints. */ |
sewardj | 4ee9c56 | 2011-05-09 21:54:44 +0000 | [diff] [blame] | 431 | #if defined(__GNUC__) |
bart | 5dd8e6a | 2008-03-22 08:04:29 +0000 | [diff] [blame] | 432 | # define LIKELY(x) __builtin_expect(!!(x), 1) |
sewardj | 4ee9c56 | 2011-05-09 21:54:44 +0000 | [diff] [blame] | 433 | # define UNLIKELY(x) __builtin_expect(!!(x), 0) |
bart | 5dd8e6a | 2008-03-22 08:04:29 +0000 | [diff] [blame] | 434 | #else |
| 435 | # define LIKELY(x) (x) |
| 436 | # define UNLIKELY(x) (x) |
| 437 | #endif |
| 438 | |
sewardj | 588adef | 2009-08-15 22:41:51 +0000 | [diff] [blame] | 439 | // printf format string checking for gcc. |
| 440 | // This feature has been supported since at least gcc version 2.95. |
| 441 | // For more information about the format attribute, see |
| 442 | // http://gcc.gnu.org/onlinedocs/gcc-4.3.0/gcc/Function-Attributes.html. |
| 443 | #if defined(__GNUC__) |
| 444 | #define PRINTF_CHECK(x, y) __attribute__((format(__printf__, x, y))) |
| 445 | #else |
| 446 | #define PRINTF_CHECK(x, y) |
| 447 | #endif |
| 448 | |
florian | 70a5de1 | 2014-10-22 12:53:16 +0000 | [diff] [blame] | 449 | // Macro to "cast" away constness (from type const T to type T) without |
| 450 | // GCC complaining about it. This macro should be used RARELY. |
| 451 | // x is expected to have type const T |
| 452 | #define CONST_CAST(T,x) \ |
| 453 | ({ \ |
| 454 | union { \ |
| 455 | const T in; \ |
| 456 | T out; \ |
| 457 | } var = { .in = x }; var.out; \ |
| 458 | }) |
bart | 5dd8e6a | 2008-03-22 08:04:29 +0000 | [diff] [blame] | 459 | |
florian | c13d544 | 2015-03-28 18:36:01 +0000 | [diff] [blame] | 460 | // Poor man's static assert |
florian | ea73483 | 2015-04-04 18:43:00 +0000 | [diff] [blame] | 461 | #define STATIC_ASSERT(x) extern int VG_(VG_(VG_(unused)))[(x) ? 1 : -1] \ |
| 462 | __attribute__((unused)) |
florian | c13d544 | 2015-03-28 18:36:01 +0000 | [diff] [blame] | 463 | |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 464 | #endif /* __PUB_TOOL_BASICS_H */ |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 465 | |
| 466 | /*--------------------------------------------------------------------*/ |
| 467 | /*--- end ---*/ |
| 468 | /*--------------------------------------------------------------------*/ |