1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Header included by every tool C file. pub_tool_basics.h ---*/ 4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* 7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This file is part of Valgrind, a dynamic binary instrumentation 8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown framework. 9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 10663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng Copyright (C) 2000-2012 Julian Seward 11ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown jseward@acm.org 12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is free software; you can redistribute it and/or 14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown modify it under the terms of the GNU General Public License as 15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown published by the Free Software Foundation; either version 2 of the 16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown License, or (at your option) any later version. 17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is distributed in the hope that it will be useful, but 19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown WITHOUT ANY WARRANTY; without even the implied warranty of 20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown General Public License for more details. 22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown You should have received a copy of the GNU General Public License 24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown along with this program; if not, write to the Free Software 25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 02111-1307, USA. 27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown The GNU General Public License is contained in the file COPYING. 29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __PUB_TOOL_BASICS_H 32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_TOOL_BASICS_H 33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//-------------------------------------------------------------------- 35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// PURPOSE: This header should be imported by every single C file in 36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// tools. It contains the basic types and other things needed everywhere. 37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// There is no corresponding C file because this isn't a module 38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// containing executable code, it's all just declarations. 39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//-------------------------------------------------------------------- 40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* --------------------------------------------------------------------- 42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Other headers to include 43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ------------------------------------------------------------------ */ 44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// VEX defines Char, UChar, Short, UShort, Int, UInt, Long, ULong, 46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Addr32, Addr64, HWord, HChar, Bool, False and True. 47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "libvex_basictypes.h" 48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// For varargs types 50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include <stdarg.h> 51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* --------------------------------------------------------------------- 54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown symbol prefixing 55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ------------------------------------------------------------------ */ 56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// All symbols externally visible from Valgrind are prefixed 58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// as specified here to avoid namespace conflict problems. 59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// 60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// VG_ is for symbols exported from modules. ML_ (module-local) is 61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// for symbols which are not intended to be visible outside modules, 62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// but which cannot be declared as C 'static's since they need to be 63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// visible across C files within a given module. It is a mistake for 64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// a ML_ name to appear in a pub_core_*.h or pub_tool_*.h file. 65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Likewise it is a mistake for a VG_ name to appear in a priv_*.h 66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// file. 67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VGAPPEND(str1,str2) str1##str2 69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_(str) VGAPPEND(vgPlain_, str) 71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define ML_(str) VGAPPEND(vgModuleLocal_, str) 72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* --------------------------------------------------------------------- 75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown builtin types 76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ------------------------------------------------------------------ */ 77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// By choosing the right types, we can get these right for 32-bit and 64-bit 79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// platforms without having to do any conditional compilation or anything. 80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// POSIX references: 81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// - http://www.opengroup.org/onlinepubs/009695399/basedefs/sys/types.h.html 82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// - http://www.opengroup.org/onlinepubs/009695399/basedefs/stddef.h.html 83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// 84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Size in bits on: 32-bit archs 64-bit archs 85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// ------------ ------------ 86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef unsigned long UWord; // 32 64 87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef signed long Word; // 32 64 88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Addr is for holding an address. AddrH was intended to be "Addr on the 90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// host", for the notional case where host word size != guest word size. 91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// But since the assumption that host arch == guest arch has become so 92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// deeply wired in, it's a pretty pointless distinction now. 93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef UWord Addr; // 32 64 94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef UWord AddrH; // 32 64 95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Our equivalents of POSIX 'size_t' and 'ssize_t': 97ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// - size_t is an "unsigned integer type of the result of the sizeof operator". 98ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// - ssize_t is "used for a count of bytes or an error indication". 99ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef UWord SizeT; // 32 64 100ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef Word SSizeT; // 32 64 101ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 102ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Our equivalent of POSIX 'ptrdiff_t': 103ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// - ptrdiff_t is a "signed integer type of the result of subtracting two 104ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// pointers". 105ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// We use it for memory offsets, eg. the offset into a memory block. 106ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef Word PtrdiffT; // 32 64 107ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 108ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Our equivalent of POSIX 'off_t': 109ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// - off_t is "used for file sizes". 110ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// At one point we were using it for memory offsets, but PtrdiffT should be 111ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// used in those cases. 112b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov// Nb: on Linux, off_t is a signed word-sized int. On Darwin it's 113ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// always a signed 64-bit int. So we defined our own Off64T as well. 114b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov#if defined(VGO_linux) 115ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef Word OffT; // 32 64 116ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGO_darwin) 117ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef Long OffT; // 64 64 118ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#else 119ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# error Unknown OS 120ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif 121ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef Long Off64T; // 64 64 122ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 123ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#if !defined(NULL) 124ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define NULL ((void*)0) 125ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif 126ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 127ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* This is just too useful to not have around the place somewhere. */ 128ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef struct { UWord uw1; UWord uw2; } UWordPair; 129ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 130ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 131ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* --------------------------------------------------------------------- 132ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown non-builtin types 133ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ------------------------------------------------------------------ */ 134ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 135ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// These probably shouldn't be here, but moving them to their logical 136ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// modules results in a lot more #includes... 137ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 138ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* ThreadIds are simply indices into the VG_(threads)[] array. */ 139ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef UInt ThreadId; 140ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 141ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* An abstraction of syscall return values. 142ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Linux: 143ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown When _isError == False, 144ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown _val holds the return value. 145ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown When _isError == True, 146ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown _err holds the error code. 147ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 148ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Darwin: 149ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Interpretation depends on _mode: 150ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown MACH, MDEP: 151ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown these can never 'fail' (apparently). The result of the 152ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown syscall is a single host word, _wLO. 153ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown UNIX: 154ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Can record a double-word error or a double-word result: 155ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown When _mode is SysRes_UNIX_OK, _wHI:_wLO holds the result. 156ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown When _mode is SysRes_UNIX_ERR, _wHI:_wLO holds the error code. 157ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Probably the high word of an error is always ignored by 158ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown userspace, but we have to record it, so that we can correctly 159ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown update both {R,E}DX and {R,E}AX (in guest state) given a SysRes, 160ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown if we're required to. 161ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 162ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#if defined(VGO_linux) 163ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 164ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 165ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown UWord _val; 166663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng UWord _valEx; // only used on mips-linux 167ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Bool _isError; 168ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 169ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SysRes; 170ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGO_darwin) 171ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 172ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown enum { 173ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SysRes_MACH=40, // MACH, result is _wLO 174ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SysRes_MDEP, // MDEP, result is _wLO 175ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SysRes_UNIX_OK, // UNIX, success, result is _wHI:_wLO 176ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SysRes_UNIX_ERR // UNIX, error, error is _wHI:_wLO 177ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 178ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SysResMode; 179ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 180ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 181ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown UWord _wLO; 182ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown UWord _wHI; 183ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SysResMode _mode; 184ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 185ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SysRes; 186ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#else 187ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# error "Unknown OS" 188ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif 189ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 190ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 191ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* ---- And now some basic accessor functions for it. ---- */ 192ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 193ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#if defined(VGO_linux) 194ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 195ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstatic inline Bool sr_isError ( SysRes sr ) { 196ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return sr._isError; 197ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 198ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstatic inline UWord sr_Res ( SysRes sr ) { 199ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return sr._isError ? 0 : sr._val; 200ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 201663860b1408516d02ebfcb3a9999a134e6cfb223Ben Chengstatic inline UWord sr_ResEx ( SysRes sr ) { 202663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng return sr._isError ? 0 : sr._valEx; 203663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng} 204ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstatic inline UWord sr_ResHI ( SysRes sr ) { 205ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return 0; 206ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 207ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstatic inline UWord sr_Err ( SysRes sr ) { 208ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return sr._isError ? sr._val : 0; 209ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 210ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstatic inline Bool sr_EQ ( SysRes sr1, SysRes sr2 ) { 211ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return sr1._val == sr2._val 212ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown && ((sr1._isError && sr2._isError) 213ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown || (!sr1._isError && !sr2._isError)); 214ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 215ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 216ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGO_darwin) 217ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 218ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstatic inline Bool sr_isError ( SysRes sr ) { 219ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown switch (sr._mode) { 220ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown case SysRes_UNIX_ERR: return True; 221ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown default: return False; 222ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* should check tags properly and assert here, but we can't here */ 223ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 224ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 225ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 226ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstatic inline UWord sr_Res ( SysRes sr ) { 227ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown switch (sr._mode) { 228ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown case SysRes_MACH: 229ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown case SysRes_MDEP: 230ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown case SysRes_UNIX_OK: return sr._wLO; 231ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown default: return 0; /* should assert, but we can't here */ 232ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 233ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 234ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 235ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstatic inline UWord sr_ResHI ( SysRes sr ) { 236ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown switch (sr._mode) { 237ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown case SysRes_UNIX_OK: return sr._wHI; 238ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown default: return 0; /* should assert, but we can't here */ 239ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 240ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 241ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 242ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstatic inline UWord sr_Err ( SysRes sr ) { 243ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown switch (sr._mode) { 244ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown case SysRes_UNIX_ERR: return sr._wLO; 245ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown default: return 0; /* should assert, but we can't here */ 246ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 247ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 248ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 249ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstatic inline Bool sr_EQ ( SysRes sr1, SysRes sr2 ) { 250ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return sr1._mode == sr2._mode 251ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown && sr1._wLO == sr2._wLO && sr1._wHI == sr2._wHI; 252ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 253ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 254ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#else 255ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# error "Unknown OS" 256ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif 257ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 258ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 259ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* --------------------------------------------------------------------- 260ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Miscellaneous (word size, endianness, regparmness, stringification) 261ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ------------------------------------------------------------------ */ 262ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 263ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Word size: this is going to be either 4 or 8. */ 264ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// It should probably be in m_machine. 265ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_WORDSIZE VEX_HOST_WORDSIZE 266ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 267ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Endianness */ 268ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#undef VG_BIGENDIAN 269ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#undef VG_LITTLEENDIAN 270ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 271663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng#if defined(VGA_x86) || defined(VGA_amd64) || defined (VGA_arm) \ 272663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng || (defined(VGA_mips32) && defined (_MIPSEL)) 273ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_LITTLEENDIAN 1 274663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng#elif defined(VGA_ppc32) || defined(VGA_ppc64) || defined(VGA_s390x) \ 275663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng || (defined(VGA_mips32) && defined (_MIPSEB)) 276ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_BIGENDIAN 1 277ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#else 278ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# error Unknown arch 279ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif 280ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 281ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Regparmness */ 282ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#if defined(VGA_x86) 283ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_REGPARM(n) __attribute__((regparm(n))) 284ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGA_amd64) || defined(VGA_ppc32) \ 285663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng || defined(VGA_ppc64) || defined(VGA_arm) || defined(VGA_s390x) \ 286663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng || defined(VGA_mips32) 287ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_REGPARM(n) /* */ 288ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#else 289ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# error Unknown arch 290ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif 291ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 292ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Macro games */ 293ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_STRINGIFZ(__str) #__str 294ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_STRINGIFY(__str) VG_STRINGIFZ(__str) 295ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 296ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Where to send bug reports to. 297ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_BUGS_TO "www.valgrind.org" 298ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 299ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Branch prediction hints. */ 300b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov#if defined(__GNUC__) 301ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define LIKELY(x) __builtin_expect(!!(x), 1) 302b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov# define UNLIKELY(x) __builtin_expect(!!(x), 0) 303ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#else 304ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define LIKELY(x) (x) 305ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define UNLIKELY(x) (x) 306ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif 307ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 308ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// printf format string checking for gcc. 309ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// This feature has been supported since at least gcc version 2.95. 310ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// For more information about the format attribute, see 311ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// http://gcc.gnu.org/onlinedocs/gcc-4.3.0/gcc/Function-Attributes.html. 312ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#if defined(__GNUC__) 313ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define PRINTF_CHECK(x, y) __attribute__((format(__printf__, x, y))) 314ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#else 315ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define PRINTF_CHECK(x, y) 316ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif 317ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 318ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 319ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif /* __PUB_TOOL_BASICS_H */ 320ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 321ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 322ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end ---*/ 323ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 324