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 | 4d474d0 | 2008-02-11 11:34:59 +0000 | [diff] [blame^] | 10 | Copyright (C) 2000-2008 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 | |
| 45 | // VEX defines Char, UChar, Short, UShort, Int, UInt, Long, ULong, |
| 46 | // Addr32, Addr64, HWord, HChar, Bool, False and True. |
| 47 | #include "libvex_basictypes.h" |
| 48 | |
| 49 | // For the VG_() macro |
| 50 | #include "pub_tool_basics_asm.h" |
| 51 | |
| 52 | // For varargs types |
| 53 | #include <stdarg.h> |
| 54 | |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 55 | |
| 56 | /* --------------------------------------------------------------------- |
njn | d01fef7 | 2005-03-25 23:35:48 +0000 | [diff] [blame] | 57 | builtin types |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 58 | ------------------------------------------------------------------ */ |
| 59 | |
| 60 | // By choosing the right types, we can get these right for 32-bit and 64-bit |
| 61 | // platforms without having to do any conditional compilation or anything. |
nethercote | 8b5f40c | 2004-11-02 13:29:50 +0000 | [diff] [blame] | 62 | // |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 63 | // Size in bits on: 32-bit archs 64-bit archs |
| 64 | // ------------ ------------ |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 65 | typedef unsigned long UWord; // 32 64 |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 66 | |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 67 | typedef signed long Word; // 32 64 |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 68 | |
| 69 | typedef UWord Addr; // 32 64 |
sewardj | fa8ec11 | 2005-01-19 11:55:34 +0000 | [diff] [blame] | 70 | typedef UWord AddrH; // 32 64 |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 71 | |
nethercote | 7ac7f7b | 2004-11-02 12:36:02 +0000 | [diff] [blame] | 72 | typedef UWord SizeT; // 32 64 |
| 73 | typedef Word SSizeT; // 32 64 |
| 74 | |
nethercote | ada0d2b | 2004-11-04 19:10:43 +0000 | [diff] [blame] | 75 | typedef Word OffT; // 32 64 |
nethercote | 5b9fafd | 2004-11-04 18:39:22 +0000 | [diff] [blame] | 76 | |
sewardj | 274461d | 2005-10-02 17:01:41 +0000 | [diff] [blame] | 77 | typedef ULong Off64T; // 64 64 |
| 78 | |
njn | 21edee3 | 2005-06-11 04:44:38 +0000 | [diff] [blame] | 79 | #if !defined(NULL) |
| 80 | # define NULL ((void*)0) |
| 81 | #endif |
sewardj | bc7df20 | 2005-05-02 10:25:34 +0000 | [diff] [blame] | 82 | |
sewardj | e1f33a4 | 2006-10-17 01:38:48 +0000 | [diff] [blame] | 83 | |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 84 | /* --------------------------------------------------------------------- |
| 85 | non-builtin types |
| 86 | ------------------------------------------------------------------ */ |
| 87 | |
| 88 | // These probably shouldn't be here, but moving them to their logical |
| 89 | // modules results in a lot more #includes... |
| 90 | |
| 91 | /* ThreadIds are simply indices into the VG_(threads)[] array. */ |
| 92 | typedef UInt ThreadId; |
| 93 | |
| 94 | /* An abstraction of syscall return values. |
sewardj | e1f33a4 | 2006-10-17 01:38:48 +0000 | [diff] [blame] | 95 | Linux: |
| 96 | When .isError == False, |
| 97 | res holds the return value, and err is zero. |
| 98 | When .isError == True, |
| 99 | err holds the error code, and res is zero. |
| 100 | |
| 101 | AIX: |
| 102 | res is the POSIX result of the syscall. |
| 103 | err is the corresponding errno value. |
| 104 | isError === err==0 |
| 105 | |
| 106 | Unlike on Linux, it is possible for 'err' to be nonzero (thus an |
| 107 | error has occurred), nevertheless 'res' is also nonzero. AIX |
| 108 | userspace does not appear to consistently inspect 'err' to |
| 109 | determine whether or not an error has occurred. For example, |
| 110 | sys_open() will return -1 for 'val' if a file cannot be opened, |
| 111 | as well as the relevant errno value in 'err', but AIX userspace |
| 112 | then consults 'val' to figure out if the syscall failed, rather |
| 113 | than looking at 'err'. Hence we need to represent them both. |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 114 | */ |
sewardj | e1f33a4 | 2006-10-17 01:38:48 +0000 | [diff] [blame] | 115 | typedef |
| 116 | struct { |
| 117 | UWord res; |
| 118 | UWord err; |
| 119 | Bool isError; |
| 120 | } |
| 121 | SysRes; |
| 122 | |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 123 | |
| 124 | /* --------------------------------------------------------------------- |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 125 | Miscellaneous (word size, endianness, regparmness, stringification) |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 126 | ------------------------------------------------------------------ */ |
| 127 | |
sewardj | 6e340c7 | 2005-07-10 00:53:42 +0000 | [diff] [blame] | 128 | /* Word size: this is going to be either 4 or 8. */ |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 129 | // It should probably be in m_machine. |
| 130 | #define VG_WORDSIZE VEX_HOST_WORDSIZE |
| 131 | |
sewardj | 6e340c7 | 2005-07-10 00:53:42 +0000 | [diff] [blame] | 132 | /* Endianness */ |
| 133 | #undef VG_BIGENDIAN |
| 134 | #undef VG_LITTLEENDIAN |
| 135 | |
| 136 | #if defined(VGA_x86) || defined(VGA_amd64) |
| 137 | # define VG_LITTLEENDIAN 1 |
sewardj | 2c48c7b | 2005-11-29 13:05:56 +0000 | [diff] [blame] | 138 | #elif defined(VGA_ppc32) || defined(VGA_ppc64) |
sewardj | 6e340c7 | 2005-07-10 00:53:42 +0000 | [diff] [blame] | 139 | # define VG_BIGENDIAN 1 |
| 140 | #endif |
| 141 | |
| 142 | /* Regparmness */ |
njn | f536bbb | 2005-06-13 04:21:38 +0000 | [diff] [blame] | 143 | #if defined(VGA_x86) |
njn | af839f5 | 2005-06-23 03:27:57 +0000 | [diff] [blame] | 144 | # define VG_REGPARM(n) __attribute__((regparm(n))) |
sewardj | 2c48c7b | 2005-11-29 13:05:56 +0000 | [diff] [blame] | 145 | #elif defined(VGA_amd64) || defined(VGA_ppc32) || defined(VGA_ppc64) |
njn | af839f5 | 2005-06-23 03:27:57 +0000 | [diff] [blame] | 146 | # define VG_REGPARM(n) /* */ |
njn | f536bbb | 2005-06-13 04:21:38 +0000 | [diff] [blame] | 147 | #else |
| 148 | # error Unknown arch |
| 149 | #endif |
| 150 | |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 151 | /* Macro games */ |
| 152 | #define VG_STRINGIFZ(__str) #__str |
| 153 | #define VG_STRINGIFY(__str) VG_STRINGIFZ(__str) |
| 154 | |
njn | 64ea7f8 | 2006-10-14 23:26:21 +0000 | [diff] [blame] | 155 | // Where to send bug reports to. |
| 156 | #define VG_BUGS_TO "www.valgrind.org" |
| 157 | |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 158 | #endif /* __PUB_TOOL_BASICS_H */ |
nethercote | ebf1d86 | 2004-11-01 18:22:05 +0000 | [diff] [blame] | 159 | |
| 160 | /*--------------------------------------------------------------------*/ |
| 161 | /*--- end ---*/ |
| 162 | /*--------------------------------------------------------------------*/ |