njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 1 | |
| 2 | /*--------------------------------------------------------------------*/ |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 3 | /*--- Declarations shared between MemCheck and AddrCheck. ---*/ |
| 4 | /*--- mac_shared.h ---*/ |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 5 | /*--------------------------------------------------------------------*/ |
| 6 | |
| 7 | /* |
nethercote | 137bc55 | 2003-11-14 17:47:54 +0000 | [diff] [blame] | 8 | This file is part of MemCheck, a heavyweight Valgrind tool for |
| 9 | detecting memory errors, and AddrCheck, a lightweight Valgrind tool |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 10 | for detecting memory errors. |
| 11 | |
njn | 5361242 | 2005-03-12 16:22:54 +0000 | [diff] [blame] | 12 | Copyright (C) 2000-2005 Julian Seward |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 13 | jseward@acm.org |
| 14 | |
| 15 | This program is free software; you can redistribute it and/or |
| 16 | modify it under the terms of the GNU General Public License as |
| 17 | published by the Free Software Foundation; either version 2 of the |
| 18 | License, or (at your option) any later version. |
| 19 | |
| 20 | This program is distributed in the hope that it will be useful, but |
| 21 | WITHOUT ANY WARRANTY; without even the implied warranty of |
| 22 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 23 | General Public License for more details. |
| 24 | |
| 25 | You should have received a copy of the GNU General Public License |
| 26 | along with this program; if not, write to the Free Software |
| 27 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
| 28 | 02111-1307, USA. |
| 29 | |
| 30 | The GNU General Public License is contained in the file COPYING. |
| 31 | */ |
| 32 | |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 33 | /* Note: This header contains the declarations shared between |
| 34 | Addrcheck and Memcheck, and is #included by both. */ |
| 35 | |
| 36 | #ifndef __MAC_SHARED_H |
| 37 | #define __MAC_SHARED_H |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 38 | |
nethercote | 4606320 | 2004-09-02 08:51:43 +0000 | [diff] [blame] | 39 | #include "tool.h" |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 40 | |
| 41 | #define MAC_(str) VGAPPEND(vgMAC_,str) |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 42 | |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 43 | /*------------------------------------------------------------*/ |
| 44 | /*--- Errors and suppressions ---*/ |
| 45 | /*------------------------------------------------------------*/ |
| 46 | |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 47 | /* The classification of a faulting address. */ |
| 48 | typedef |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 49 | enum { |
nethercote | 8b76fe5 | 2004-11-08 19:20:09 +0000 | [diff] [blame] | 50 | Undescribed, // as-yet unclassified |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 51 | Stack, |
nethercote | 8b76fe5 | 2004-11-08 19:20:09 +0000 | [diff] [blame] | 52 | Unknown, // classification yielded nothing useful |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 53 | Freed, Mallocd, |
nethercote | 8b76fe5 | 2004-11-08 19:20:09 +0000 | [diff] [blame] | 54 | UserG, // in a user-defined block |
| 55 | Mempool, // in a mempool |
| 56 | Register, // in a register; for Param errors only |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 57 | } |
| 58 | AddrKind; |
| 59 | |
| 60 | /* Records info about a faulting address. */ |
| 61 | typedef |
nethercote | 05675c8 | 2004-08-04 10:37:49 +0000 | [diff] [blame] | 62 | struct { // Used by: |
| 63 | AddrKind akind; // ALL |
nethercote | 928a5f7 | 2004-11-03 18:10:37 +0000 | [diff] [blame] | 64 | SizeT blksize; // Freed, Mallocd |
nethercote | 8b76fe5 | 2004-11-08 19:20:09 +0000 | [diff] [blame] | 65 | OffT rwoffset; // Freed, Mallocd |
nethercote | 05675c8 | 2004-08-04 10:37:49 +0000 | [diff] [blame] | 66 | ExeContext* lastchange; // Freed, Mallocd |
| 67 | ThreadId stack_tid; // Stack |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 68 | const Char *desc; // UserG |
nethercote | 05675c8 | 2004-08-04 10:37:49 +0000 | [diff] [blame] | 69 | Bool maybe_gcc; // True if just below %esp -- could be a gcc bug. |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 70 | } |
| 71 | AddrInfo; |
| 72 | |
| 73 | typedef |
| 74 | enum { |
nethercote | 05675c8 | 2004-08-04 10:37:49 +0000 | [diff] [blame] | 75 | ParamSupp, // Bad syscall params |
| 76 | CoreMemSupp, // Memory errors in core (pthread ops, signal handling) |
| 77 | |
| 78 | // Use of invalid values of given size (MemCheck only) |
njn | c061666 | 2003-06-12 09:58:41 +0000 | [diff] [blame] | 79 | Value0Supp, Value1Supp, Value2Supp, Value4Supp, Value8Supp, Value16Supp, |
nethercote | 05675c8 | 2004-08-04 10:37:49 +0000 | [diff] [blame] | 80 | |
| 81 | // Invalid read/write attempt at given size |
njn | c061666 | 2003-06-12 09:58:41 +0000 | [diff] [blame] | 82 | Addr1Supp, Addr2Supp, Addr4Supp, Addr8Supp, Addr16Supp, |
nethercote | 05675c8 | 2004-08-04 10:37:49 +0000 | [diff] [blame] | 83 | |
| 84 | FreeSupp, // Invalid or mismatching free |
| 85 | OverlapSupp, // Overlapping blocks in memcpy(), strcpy(), etc |
| 86 | LeakSupp, // Something to be suppressed in a leak check. |
| 87 | MempoolSupp, // Memory pool suppression. |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 88 | } |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 89 | MAC_SuppKind; |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 90 | |
| 91 | /* What kind of error it is. */ |
| 92 | typedef |
| 93 | enum { ValueErr, /* Memcheck only */ |
| 94 | CoreMemErr, |
| 95 | AddrErr, |
| 96 | ParamErr, UserErr, /* behaves like an anonymous ParamErr */ |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 97 | FreeErr, FreeMismatchErr, |
njn | 7201b2a | 2003-08-19 12:16:05 +0000 | [diff] [blame] | 98 | OverlapErr, |
rjwalsh | bc0bb83 | 2004-06-19 18:12:36 +0000 | [diff] [blame] | 99 | LeakErr, |
| 100 | IllegalMempoolErr, |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 101 | } |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 102 | MAC_ErrorKind; |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 103 | |
| 104 | /* What kind of memory access is involved in the error? */ |
| 105 | typedef |
| 106 | enum { ReadAxs, WriteAxs, ExecAxs } |
| 107 | AxsKind; |
| 108 | |
| 109 | /* Extra context for memory errors */ |
| 110 | typedef |
nethercote | 05675c8 | 2004-08-04 10:37:49 +0000 | [diff] [blame] | 111 | struct { // Used by: |
| 112 | AxsKind axskind; // AddrErr |
| 113 | Int size; // AddrErr, ValueErr |
| 114 | AddrInfo addrinfo; // {Addr,Free,FreeMismatch,Param,User}Err |
nethercote | 8b76fe5 | 2004-11-08 19:20:09 +0000 | [diff] [blame] | 115 | Bool isUnaddr; // {CoreMem,Param,User}Err |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 116 | } |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 117 | MAC_Error; |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 118 | |
njn | b6cae9f | 2003-09-04 20:50:47 +0000 | [diff] [blame] | 119 | /* Extra info for overlap errors */ |
| 120 | typedef |
| 121 | struct { |
| 122 | Addr src; |
| 123 | Addr dst; |
| 124 | Int len; // -1 if unused |
| 125 | } |
| 126 | OverlapExtra; |
| 127 | |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 128 | /* For malloc()/new/new[] vs. free()/delete/delete[] mismatch checking. */ |
| 129 | typedef |
| 130 | enum { |
| 131 | MAC_AllocMalloc = 0, |
| 132 | MAC_AllocNew = 1, |
njn | 1078545 | 2003-05-20 16:38:24 +0000 | [diff] [blame] | 133 | MAC_AllocNewVec = 2, |
| 134 | MAC_AllocCustom = 3 |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 135 | } |
| 136 | MAC_AllocKind; |
| 137 | |
| 138 | /* Nb: first two fields must match core's VgHashNode. */ |
| 139 | typedef |
| 140 | struct _MAC_Chunk { |
| 141 | struct _MAC_Chunk* next; |
nethercote | 05675c8 | 2004-08-04 10:37:49 +0000 | [diff] [blame] | 142 | Addr data; // ptr to actual block |
njn | b729e0d | 2004-12-01 00:19:38 +0000 | [diff] [blame] | 143 | SizeT size : (sizeof(UWord)*8)-2; // size requested; 30 or 62 bits |
nethercote | 05675c8 | 2004-08-04 10:37:49 +0000 | [diff] [blame] | 144 | MAC_AllocKind allockind : 2; // which wrapper did the allocation |
| 145 | ExeContext* where; // where it was allocated |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 146 | } |
| 147 | MAC_Chunk; |
| 148 | |
rjwalsh | bc0bb83 | 2004-06-19 18:12:36 +0000 | [diff] [blame] | 149 | /* Memory pool. Nb: first two fields must match core's VgHashNode. */ |
| 150 | typedef |
| 151 | struct _MAC_Mempool { |
| 152 | struct _MAC_Mempool* next; |
nethercote | 05675c8 | 2004-08-04 10:37:49 +0000 | [diff] [blame] | 153 | Addr pool; // pool identifier |
njn | b729e0d | 2004-12-01 00:19:38 +0000 | [diff] [blame] | 154 | SizeT rzB; // pool red-zone size |
nethercote | 05675c8 | 2004-08-04 10:37:49 +0000 | [diff] [blame] | 155 | Bool is_zeroed; // allocations from this pool are zeroed |
| 156 | VgHashTable chunks; // chunks associated with this pool |
rjwalsh | bc0bb83 | 2004-06-19 18:12:36 +0000 | [diff] [blame] | 157 | } |
| 158 | MAC_Mempool; |
| 159 | |
| 160 | |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 161 | /*------------------------------------------------------------*/ |
nethercote | 7cc9c23 | 2004-01-21 15:08:04 +0000 | [diff] [blame] | 162 | /*--- Profiling of tools and memory events ---*/ |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 163 | /*------------------------------------------------------------*/ |
| 164 | |
| 165 | typedef |
| 166 | enum { |
| 167 | VgpCheckMem = VgpFini+1, |
| 168 | VgpSetMem, |
| 169 | VgpESPAdj |
| 170 | } |
nethercote | 7cc9c23 | 2004-01-21 15:08:04 +0000 | [diff] [blame] | 171 | VgpToolCC; |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 172 | |
| 173 | /* Define to collect detailed performance info. */ |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 174 | /* #define MAC_PROFILE_MEMORY */ |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 175 | |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 176 | #ifdef MAC_PROFILE_MEMORY |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 177 | # define N_PROF_EVENTS 150 |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 178 | |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 179 | extern UInt MAC_(event_ctr)[N_PROF_EVENTS]; |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 180 | |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 181 | # define PROF_EVENT(ev) \ |
njn | ca82cc0 | 2004-11-22 17:18:48 +0000 | [diff] [blame] | 182 | do { tl_assert((ev) >= 0 && (ev) < N_PROF_EVENTS); \ |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 183 | MAC_(event_ctr)[ev]++; \ |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 184 | } while (False); |
| 185 | |
| 186 | #else |
| 187 | |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 188 | # define PROF_EVENT(ev) /* */ |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 189 | |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 190 | #endif /* MAC_PROFILE_MEMORY */ |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 191 | |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 192 | |
sewardj | 45d94cc | 2005-04-20 14:44:11 +0000 | [diff] [blame^] | 193 | //zz /*------------------------------------------------------------*/ |
| 194 | //zz /*--- V and A bits (Victoria & Albert ?) ---*/ |
| 195 | //zz /*------------------------------------------------------------*/ |
| 196 | //zz |
| 197 | //zz /* expand 1 bit -> 8 */ |
| 198 | //zz #define BIT_EXPAND(b) ((~(((UChar)(b) & 1) - 1)) & 0xFF) |
| 199 | //zz |
| 200 | //zz #define SECONDARY_SHIFT 16 |
| 201 | //zz #define SECONDARY_SIZE (1 << SECONDARY_SHIFT) |
| 202 | //zz #define SECONDARY_MASK (SECONDARY_SIZE - 1) |
| 203 | //zz |
| 204 | //zz #define PRIMARY_SIZE (1 << (32 - SECONDARY_SHIFT)) |
| 205 | //zz |
| 206 | //zz #define SM_OFF(addr) ((addr) & SECONDARY_MASK) |
| 207 | //zz #define PM_IDX(addr) ((addr) >> SECONDARY_SHIFT) |
| 208 | /* |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 209 | #define IS_DISTINGUISHED_SM(smap) \ |
| 210 | ((smap) >= &distinguished_secondary_maps[0] && \ |
| 211 | (smap) < &distinguished_secondary_maps[N_SECONDARY_MAPS]) |
| 212 | |
| 213 | #define IS_DISTINGUISHED(addr) (IS_DISTINGUISHED_SM(primary_map[PM_IDX(addr)])) |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 214 | |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 215 | #define ENSURE_MAPPABLE(addr,caller) \ |
| 216 | do { \ |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 217 | if (IS_DISTINGUISHED(addr)) { \ |
| 218 | primary_map[PM_IDX(addr)] = alloc_secondary_map(caller, primary_map[PM_IDX(addr)]); \ |
sewardj | 45d94cc | 2005-04-20 14:44:11 +0000 | [diff] [blame^] | 219 | if (0) VG_(printf)("new 2map because of %p\n", addr); \ |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 220 | } \ |
sewardj | 45d94cc | 2005-04-20 14:44:11 +0000 | [diff] [blame^] | 221 | } while(0) |
| 222 | */ |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 223 | |
| 224 | #define BITARR_SET(aaa_p,iii_p) \ |
| 225 | do { \ |
sewardj | 45d94cc | 2005-04-20 14:44:11 +0000 | [diff] [blame^] | 226 | UWord iii = (UWord)iii_p; \ |
| 227 | UChar* aaa = (UChar*)aaa_p; \ |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 228 | aaa[iii >> 3] |= (1 << (iii & 7)); \ |
| 229 | } while (0) |
| 230 | |
| 231 | #define BITARR_CLEAR(aaa_p,iii_p) \ |
| 232 | do { \ |
sewardj | 45d94cc | 2005-04-20 14:44:11 +0000 | [diff] [blame^] | 233 | UWord iii = (UWord)iii_p; \ |
| 234 | UChar* aaa = (UChar*)aaa_p; \ |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 235 | aaa[iii >> 3] &= ~(1 << (iii & 7)); \ |
| 236 | } while (0) |
| 237 | |
| 238 | #define BITARR_TEST(aaa_p,iii_p) \ |
sewardj | 45d94cc | 2005-04-20 14:44:11 +0000 | [diff] [blame^] | 239 | (0 != (((UChar*)aaa_p)[ ((UWord)iii_p) >> 3 ] \ |
| 240 | & (1 << (((UWord)iii_p) & 7)))) \ |
| 241 | |
| 242 | static inline |
| 243 | void write_bit_array ( UChar* arr, UWord idx, UWord bit ) |
| 244 | { |
| 245 | UWord shift = idx & 7; |
| 246 | idx >>= 3; |
| 247 | bit &= 1; |
| 248 | arr[idx] = (arr[idx] & ~(1<<shift)) | (bit << shift); |
| 249 | } |
| 250 | |
| 251 | static inline |
| 252 | UWord read_bit_array ( UChar* arr, UWord idx ) |
| 253 | { |
| 254 | UWord shift = idx & 7; |
| 255 | idx >>= 3; |
| 256 | return 1 & (arr[idx] >> shift); |
| 257 | } |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 258 | |
| 259 | |
sewardj | 45d94cc | 2005-04-20 14:44:11 +0000 | [diff] [blame^] | 260 | #define VGM_BIT_VALID 0 |
| 261 | #define VGM_BIT_INVALID 1 |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 262 | |
sewardj | 45d94cc | 2005-04-20 14:44:11 +0000 | [diff] [blame^] | 263 | #define VGM_NIBBLE_VALID 0 |
| 264 | #define VGM_NIBBLE_INVALID 0xF |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 265 | |
sewardj | 45d94cc | 2005-04-20 14:44:11 +0000 | [diff] [blame^] | 266 | #define VGM_BYTE_VALID 0 |
| 267 | #define VGM_BYTE_INVALID 0xFF |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 268 | |
sewardj | 45d94cc | 2005-04-20 14:44:11 +0000 | [diff] [blame^] | 269 | #define VGM_WORD32_VALID 0 |
| 270 | #define VGM_WORD32_INVALID 0xFFFFFFFF |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 271 | |
sewardj | 45d94cc | 2005-04-20 14:44:11 +0000 | [diff] [blame^] | 272 | #define VGM_WORD64_VALID 0ULL |
| 273 | #define VGM_WORD64_INVALID 0xFFFFFFFFFFFFFFFFULL |
| 274 | |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 275 | |
| 276 | /*------------------------------------------------------------*/ |
| 277 | /*--- Command line options + defaults ---*/ |
| 278 | /*------------------------------------------------------------*/ |
| 279 | |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 280 | /* Memcheck defines a couple more. */ |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 281 | |
| 282 | /* Allow loads from partially-valid addresses? default: YES */ |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 283 | extern Bool MAC_(clo_partial_loads_ok); |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 284 | |
| 285 | /* Max volume of the freed blocks queue. */ |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 286 | extern Int MAC_(clo_freelist_vol); |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 287 | |
| 288 | /* Do leak check at exit? default: NO */ |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 289 | typedef |
| 290 | enum { |
| 291 | LC_Off, |
| 292 | LC_Summary, |
| 293 | LC_Full, |
| 294 | } |
| 295 | LeakCheckMode; |
| 296 | |
| 297 | extern LeakCheckMode MAC_(clo_leak_check); |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 298 | |
| 299 | /* How closely should we compare ExeContexts in leak records? default: 2 */ |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 300 | extern VgRes MAC_(clo_leak_resolution); |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 301 | |
| 302 | /* In leak check, show reachable-but-not-freed blocks? default: NO */ |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 303 | extern Bool MAC_(clo_show_reachable); |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 304 | |
| 305 | /* Assume accesses immediately below %esp are due to gcc-2.96 bugs. |
| 306 | * default: NO*/ |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 307 | extern Bool MAC_(clo_workaround_gcc296_bugs); |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 308 | |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 309 | extern Bool MAC_(process_common_cmd_line_option) ( Char* arg ); |
| 310 | extern void MAC_(print_common_usage) ( void ); |
| 311 | extern void MAC_(print_common_debug_usage) ( void ); |
| 312 | |
njn | 8a97c6d | 2005-03-31 04:37:24 +0000 | [diff] [blame] | 313 | /* We want a 16B redzone on heap blocks for Addrcheck and Memcheck */ |
| 314 | #define MALLOC_REDZONE_SZB 16 |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 315 | |
| 316 | /*------------------------------------------------------------*/ |
| 317 | /*--- Variables ---*/ |
| 318 | /*------------------------------------------------------------*/ |
| 319 | |
| 320 | /* For tracking malloc'd blocks */ |
| 321 | extern VgHashTable MAC_(malloc_list); |
| 322 | |
rjwalsh | bc0bb83 | 2004-06-19 18:12:36 +0000 | [diff] [blame] | 323 | /* For tracking memory pools. */ |
| 324 | extern VgHashTable MAC_(mempool_list); |
| 325 | |
nethercote | 7cc9c23 | 2004-01-21 15:08:04 +0000 | [diff] [blame] | 326 | /* Function pointers for the two tools to track interesting events. */ |
nethercote | 451eae9 | 2004-11-02 13:06:32 +0000 | [diff] [blame] | 327 | extern void (*MAC_(new_mem_heap)) ( Addr a, SizeT len, Bool is_inited ); |
| 328 | extern void (*MAC_(ban_mem_heap)) ( Addr a, SizeT len ); |
| 329 | extern void (*MAC_(die_mem_heap)) ( Addr a, SizeT len ); |
| 330 | extern void (*MAC_(copy_mem_heap))( Addr from, Addr to, SizeT len ); |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 331 | |
sewardj | ecf8e10 | 2003-07-12 12:11:39 +0000 | [diff] [blame] | 332 | /* Function pointers for internal sanity checking. */ |
nethercote | 451eae9 | 2004-11-02 13:06:32 +0000 | [diff] [blame] | 333 | extern Bool (*MAC_(check_noaccess))( Addr a, SizeT len, Addr* bad_addr ); |
sewardj | ecf8e10 | 2003-07-12 12:11:39 +0000 | [diff] [blame] | 334 | |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 335 | /* Used in describe_addr() */ |
| 336 | extern Bool (*MAC_(describe_addr_supp)) ( Addr a, AddrInfo* ai ); |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 337 | |
njn | 47363ab | 2003-04-21 13:24:40 +0000 | [diff] [blame] | 338 | /* For VALGRIND_COUNT_LEAKS client request */ |
njn | e8b5c05 | 2003-07-22 22:03:58 +0000 | [diff] [blame] | 339 | extern Int MAC_(bytes_leaked); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 340 | extern Int MAC_(bytes_indirect); |
njn | e8b5c05 | 2003-07-22 22:03:58 +0000 | [diff] [blame] | 341 | extern Int MAC_(bytes_dubious); |
| 342 | extern Int MAC_(bytes_reachable); |
| 343 | extern Int MAC_(bytes_suppressed); |
sewardj | 99aac97 | 2002-12-26 01:53:45 +0000 | [diff] [blame] | 344 | |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 345 | /*------------------------------------------------------------*/ |
| 346 | /*--- Functions ---*/ |
| 347 | /*------------------------------------------------------------*/ |
| 348 | |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 349 | extern void MAC_(pp_AddrInfo) ( Addr a, AddrInfo* ai ); |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 350 | |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 351 | extern void MAC_(clear_MAC_Error) ( MAC_Error* err_extra ); |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 352 | |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 353 | extern Bool MAC_(shared_recognised_suppression) ( Char* name, Supp* su ); |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 354 | |
sewardj | 2a99cf6 | 2004-11-24 10:44:19 +0000 | [diff] [blame] | 355 | extern void* MAC_(new_block) ( ThreadId tid, |
| 356 | Addr p, SizeT size, SizeT align, UInt rzB, |
nethercote | 57e36b3 | 2004-07-10 14:56:28 +0000 | [diff] [blame] | 357 | Bool is_zeroed, MAC_AllocKind kind, |
| 358 | VgHashTable table); |
sewardj | 2a99cf6 | 2004-11-24 10:44:19 +0000 | [diff] [blame] | 359 | |
| 360 | extern void MAC_(handle_free) ( ThreadId tid, |
| 361 | Addr p, UInt rzB, MAC_AllocKind kind ); |
njn | 1078545 | 2003-05-20 16:38:24 +0000 | [diff] [blame] | 362 | |
rjwalsh | bc0bb83 | 2004-06-19 18:12:36 +0000 | [diff] [blame] | 363 | extern void MAC_(create_mempool)(Addr pool, UInt rzB, Bool is_zeroed); |
sewardj | 2a99cf6 | 2004-11-24 10:44:19 +0000 | [diff] [blame] | 364 | |
rjwalsh | bc0bb83 | 2004-06-19 18:12:36 +0000 | [diff] [blame] | 365 | extern void MAC_(destroy_mempool)(Addr pool); |
sewardj | 2a99cf6 | 2004-11-24 10:44:19 +0000 | [diff] [blame] | 366 | |
| 367 | extern void MAC_(mempool_alloc)(ThreadId tid, |
| 368 | Addr pool, Addr addr, SizeT size); |
| 369 | |
rjwalsh | bc0bb83 | 2004-06-19 18:12:36 +0000 | [diff] [blame] | 370 | extern void MAC_(mempool_free)(Addr pool, Addr addr); |
| 371 | |
njn | 7271864 | 2003-07-24 08:45:32 +0000 | [diff] [blame] | 372 | extern void MAC_(record_address_error) ( ThreadId tid, Addr a, |
sewardj | af48a60 | 2003-07-06 00:54:47 +0000 | [diff] [blame] | 373 | Int size, Bool isWrite ); |
nethercote | 8b76fe5 | 2004-11-08 19:20:09 +0000 | [diff] [blame] | 374 | extern void MAC_(record_core_mem_error) ( ThreadId tid, Bool isUnaddr, |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 375 | Char* s ); |
nethercote | 8b76fe5 | 2004-11-08 19:20:09 +0000 | [diff] [blame] | 376 | extern void MAC_(record_param_error) ( ThreadId tid, Addr a, Bool isReg, |
| 377 | Bool isUnaddr, Char* msg ); |
njn | 7271864 | 2003-07-24 08:45:32 +0000 | [diff] [blame] | 378 | extern void MAC_(record_jump_error) ( ThreadId tid, Addr a ); |
| 379 | extern void MAC_(record_free_error) ( ThreadId tid, Addr a ); |
| 380 | extern void MAC_(record_freemismatch_error)( ThreadId tid, Addr a ); |
sewardj | 2a99cf6 | 2004-11-24 10:44:19 +0000 | [diff] [blame] | 381 | extern void MAC_(record_overlap_error) ( ThreadId tid, |
| 382 | Char* function, OverlapExtra* oe ); |
rjwalsh | bc0bb83 | 2004-06-19 18:12:36 +0000 | [diff] [blame] | 383 | extern void MAC_(record_illegal_mempool_error) ( ThreadId tid, Addr pool ); |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 384 | |
njn | b126f73 | 2004-11-22 17:57:07 +0000 | [diff] [blame] | 385 | extern void MAC_(pp_shared_Error) ( Error* err); |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 386 | |
thughes | 4ad52d0 | 2004-06-27 17:37:21 +0000 | [diff] [blame] | 387 | extern MAC_Chunk* MAC_(first_matching_freed_MAC_Chunk)( Bool (*p)(MAC_Chunk*, void*), void* d ); |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 388 | |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 389 | extern void MAC_(common_pre_clo_init) ( void ); |
njn | b8dca86 | 2005-03-14 02:42:44 +0000 | [diff] [blame] | 390 | extern void MAC_(common_fini) ( void (*leak_check)(ThreadId tid, |
| 391 | LeakCheckMode mode) ); |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 392 | |
njn | 7271864 | 2003-07-24 08:45:32 +0000 | [diff] [blame] | 393 | extern Bool MAC_(handle_common_client_requests) ( ThreadId tid, |
nethercote | d1b64b2 | 2004-11-04 18:22:28 +0000 | [diff] [blame] | 394 | UWord* arg_block, UWord* ret ); |
njn | 47363ab | 2003-04-21 13:24:40 +0000 | [diff] [blame] | 395 | |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 396 | /* For leak checking */ |
| 397 | extern void MAC_(pp_LeakError)(void* vl, UInt n_this_record, |
| 398 | UInt n_total_records); |
| 399 | |
njn | 86f12dc | 2005-03-14 01:16:05 +0000 | [diff] [blame] | 400 | extern void MAC_(print_malloc_stats) ( void ); |
| 401 | |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 402 | extern void MAC_(do_detect_memory_leaks) ( |
njn | b8dca86 | 2005-03-14 02:42:44 +0000 | [diff] [blame] | 403 | ThreadId tid, LeakCheckMode mode, |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 404 | Bool (*is_valid_64k_chunk) ( UInt ), |
| 405 | Bool (*is_valid_address) ( Addr ) |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 406 | ); |
| 407 | |
njn | 9fb73db | 2005-03-27 01:55:21 +0000 | [diff] [blame] | 408 | extern VGA_REGPARM(1) void MAC_(new_mem_stack_4) ( Addr old_ESP ); |
| 409 | extern VGA_REGPARM(1) void MAC_(die_mem_stack_4) ( Addr old_ESP ); |
| 410 | extern VGA_REGPARM(1) void MAC_(new_mem_stack_8) ( Addr old_ESP ); |
| 411 | extern VGA_REGPARM(1) void MAC_(die_mem_stack_8) ( Addr old_ESP ); |
| 412 | extern VGA_REGPARM(1) void MAC_(new_mem_stack_12) ( Addr old_ESP ); |
| 413 | extern VGA_REGPARM(1) void MAC_(die_mem_stack_12) ( Addr old_ESP ); |
| 414 | extern VGA_REGPARM(1) void MAC_(new_mem_stack_16) ( Addr old_ESP ); |
| 415 | extern VGA_REGPARM(1) void MAC_(die_mem_stack_16) ( Addr old_ESP ); |
| 416 | extern VGA_REGPARM(1) void MAC_(new_mem_stack_32) ( Addr old_ESP ); |
| 417 | extern VGA_REGPARM(1) void MAC_(die_mem_stack_32) ( Addr old_ESP ); |
| 418 | extern void MAC_(die_mem_stack) ( Addr a, SizeT len); |
| 419 | extern void MAC_(new_mem_stack) ( Addr a, SizeT len); |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 420 | |
| 421 | |
| 422 | /*------------------------------------------------------------*/ |
| 423 | /*--- Stack pointer adjustment ---*/ |
| 424 | /*------------------------------------------------------------*/ |
| 425 | |
| 426 | /* Some noble preprocessor abuse, to enable Memcheck and Addrcheck to |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 427 | share this code, but call different functions. |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 428 | |
| 429 | Note that this code is executed very frequently and must be highly |
| 430 | optimised, which is why I resort to the preprocessor to achieve the |
sewardj | 45d94cc | 2005-04-20 14:44:11 +0000 | [diff] [blame^] | 431 | factoring, rather than eg. using function pointers. |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 432 | */ |
| 433 | |
sewardj | 45d94cc | 2005-04-20 14:44:11 +0000 | [diff] [blame^] | 434 | #define SP_UPDATE_HANDLERS(ALIGNED4_NEW, ALIGNED4_DIE, \ |
| 435 | ALIGNED8_NEW, ALIGNED8_DIE, \ |
| 436 | UNALIGNED_NEW, UNALIGNED_DIE) \ |
| 437 | \ |
| 438 | void VGA_REGPARM(1) MAC_(new_mem_stack_4)(Addr new_SP) \ |
| 439 | { \ |
| 440 | PROF_EVENT(110); \ |
| 441 | if (VG_IS_4_ALIGNED(new_SP)) { \ |
| 442 | ALIGNED4_NEW ( new_SP ); \ |
| 443 | } else { \ |
| 444 | UNALIGNED_NEW ( new_SP, 4 ); \ |
| 445 | } \ |
| 446 | } \ |
| 447 | \ |
| 448 | void VGA_REGPARM(1) MAC_(die_mem_stack_4)(Addr new_SP) \ |
| 449 | { \ |
| 450 | PROF_EVENT(120); \ |
| 451 | if (VG_IS_4_ALIGNED(new_SP)) { \ |
| 452 | ALIGNED4_DIE ( new_SP-4 ); \ |
| 453 | } else { \ |
| 454 | UNALIGNED_DIE ( new_SP-4, 4 ); \ |
| 455 | } \ |
| 456 | } \ |
| 457 | \ |
| 458 | void VGA_REGPARM(1) MAC_(new_mem_stack_8)(Addr new_SP) \ |
| 459 | { \ |
| 460 | PROF_EVENT(111); \ |
| 461 | if (VG_IS_8_ALIGNED(new_SP)) { \ |
| 462 | ALIGNED8_NEW ( new_SP ); \ |
| 463 | } else if (VG_IS_4_ALIGNED(new_SP)) { \ |
| 464 | ALIGNED4_NEW ( new_SP ); \ |
| 465 | ALIGNED4_NEW ( new_SP+4 ); \ |
| 466 | } else { \ |
| 467 | UNALIGNED_NEW ( new_SP, 8 ); \ |
| 468 | } \ |
| 469 | } \ |
| 470 | \ |
| 471 | void VGA_REGPARM(1) MAC_(die_mem_stack_8)(Addr new_SP) \ |
| 472 | { \ |
| 473 | PROF_EVENT(121); \ |
| 474 | if (VG_IS_8_ALIGNED(new_SP)) { \ |
| 475 | ALIGNED8_DIE ( new_SP-8 ); \ |
| 476 | } else if (VG_IS_4_ALIGNED(new_SP)) { \ |
| 477 | ALIGNED4_DIE ( new_SP-8 ); \ |
| 478 | ALIGNED4_DIE ( new_SP-4 ); \ |
| 479 | } else { \ |
| 480 | UNALIGNED_DIE ( new_SP-8, 8 ); \ |
| 481 | } \ |
| 482 | } \ |
| 483 | \ |
| 484 | void VGA_REGPARM(1) MAC_(new_mem_stack_12)(Addr new_SP) \ |
| 485 | { \ |
| 486 | PROF_EVENT(112); \ |
| 487 | if (VG_IS_8_ALIGNED(new_SP)) { \ |
| 488 | ALIGNED8_NEW ( new_SP ); \ |
| 489 | ALIGNED4_NEW ( new_SP+8 ); \ |
| 490 | } else if (VG_IS_4_ALIGNED(new_SP)) { \ |
| 491 | ALIGNED4_NEW ( new_SP ); \ |
| 492 | ALIGNED8_NEW ( new_SP+4 ); \ |
| 493 | } else { \ |
| 494 | UNALIGNED_NEW ( new_SP, 12 ); \ |
| 495 | } \ |
| 496 | } \ |
| 497 | \ |
| 498 | void VGA_REGPARM(1) MAC_(die_mem_stack_12)(Addr new_SP) \ |
| 499 | { \ |
| 500 | PROF_EVENT(122); \ |
| 501 | /* Note the -12 in the test */ \ |
| 502 | if (VG_IS_8_ALIGNED(new_SP-12)) { \ |
| 503 | ALIGNED8_DIE ( new_SP-12 ); \ |
| 504 | ALIGNED4_DIE ( new_SP-4 ); \ |
| 505 | } else if (VG_IS_4_ALIGNED(new_SP)) { \ |
| 506 | ALIGNED4_DIE ( new_SP-12 ); \ |
| 507 | ALIGNED8_DIE ( new_SP-8 ); \ |
| 508 | } else { \ |
| 509 | UNALIGNED_DIE ( new_SP-12, 12 ); \ |
| 510 | } \ |
| 511 | } \ |
| 512 | \ |
| 513 | void VGA_REGPARM(1) MAC_(new_mem_stack_16)(Addr new_SP) \ |
| 514 | { \ |
| 515 | PROF_EVENT(113); \ |
| 516 | if (VG_IS_8_ALIGNED(new_SP)) { \ |
| 517 | ALIGNED8_NEW ( new_SP ); \ |
| 518 | ALIGNED8_NEW ( new_SP+8 ); \ |
| 519 | } else if (VG_IS_4_ALIGNED(new_SP)) { \ |
| 520 | ALIGNED4_NEW ( new_SP ); \ |
| 521 | ALIGNED8_NEW ( new_SP+4 ); \ |
| 522 | ALIGNED4_NEW ( new_SP+12 ); \ |
| 523 | } else { \ |
| 524 | UNALIGNED_NEW ( new_SP, 16 ); \ |
| 525 | } \ |
| 526 | } \ |
| 527 | \ |
| 528 | void VGA_REGPARM(1) MAC_(die_mem_stack_16)(Addr new_SP) \ |
| 529 | { \ |
| 530 | PROF_EVENT(123); \ |
| 531 | if (VG_IS_8_ALIGNED(new_SP)) { \ |
| 532 | ALIGNED8_DIE ( new_SP-16 ); \ |
| 533 | ALIGNED8_DIE ( new_SP-8 ); \ |
| 534 | } else if (VG_IS_4_ALIGNED(new_SP)) { \ |
| 535 | ALIGNED4_DIE ( new_SP-16 ); \ |
| 536 | ALIGNED8_DIE ( new_SP-12 ); \ |
| 537 | ALIGNED4_DIE ( new_SP-4 ); \ |
| 538 | } else { \ |
| 539 | UNALIGNED_DIE ( new_SP-16, 16 ); \ |
| 540 | } \ |
| 541 | } \ |
| 542 | \ |
| 543 | void VGA_REGPARM(1) MAC_(new_mem_stack_32)(Addr new_SP) \ |
| 544 | { \ |
| 545 | PROF_EVENT(114); \ |
| 546 | if (VG_IS_8_ALIGNED(new_SP)) { \ |
| 547 | ALIGNED8_NEW ( new_SP ); \ |
| 548 | ALIGNED8_NEW ( new_SP+8 ); \ |
| 549 | ALIGNED8_NEW ( new_SP+16 ); \ |
| 550 | ALIGNED8_NEW ( new_SP+24 ); \ |
| 551 | } else if (VG_IS_4_ALIGNED(new_SP)) { \ |
| 552 | ALIGNED4_NEW ( new_SP ); \ |
| 553 | ALIGNED8_NEW ( new_SP+4 ); \ |
| 554 | ALIGNED8_NEW ( new_SP+12 ); \ |
| 555 | ALIGNED8_NEW ( new_SP+20 ); \ |
| 556 | ALIGNED4_NEW ( new_SP+28 ); \ |
| 557 | } else { \ |
| 558 | UNALIGNED_NEW ( new_SP, 32 ); \ |
| 559 | } \ |
| 560 | } \ |
| 561 | \ |
| 562 | void VGA_REGPARM(1) MAC_(die_mem_stack_32)(Addr new_SP) \ |
| 563 | { \ |
| 564 | PROF_EVENT(124); \ |
| 565 | if (VG_IS_8_ALIGNED(new_SP)) { \ |
| 566 | ALIGNED8_DIE ( new_SP-32 ); \ |
| 567 | ALIGNED8_DIE ( new_SP-24 ); \ |
| 568 | ALIGNED8_DIE ( new_SP-16 ); \ |
| 569 | ALIGNED8_DIE ( new_SP- 8 ); \ |
| 570 | } else if (VG_IS_4_ALIGNED(new_SP)) { \ |
| 571 | ALIGNED4_DIE ( new_SP-32 ); \ |
| 572 | ALIGNED8_DIE ( new_SP-28 ); \ |
| 573 | ALIGNED8_DIE ( new_SP-20 ); \ |
| 574 | ALIGNED8_DIE ( new_SP-12 ); \ |
| 575 | ALIGNED4_DIE ( new_SP-4 ); \ |
| 576 | } else { \ |
| 577 | UNALIGNED_DIE ( new_SP-32, 32 ); \ |
| 578 | } \ |
| 579 | } \ |
| 580 | \ |
| 581 | void MAC_(new_mem_stack) ( Addr a, SizeT len ) \ |
| 582 | { \ |
| 583 | PROF_EVENT(115); \ |
| 584 | UNALIGNED_NEW ( a, len ); \ |
| 585 | } \ |
| 586 | \ |
| 587 | void MAC_(die_mem_stack) ( Addr a, SizeT len ) \ |
| 588 | { \ |
| 589 | PROF_EVENT(125); \ |
| 590 | UNALIGNED_DIE ( a, len ); \ |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 591 | } |
| 592 | |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 593 | #endif /* __MAC_SHARED_H */ |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 594 | |
| 595 | /*--------------------------------------------------------------------*/ |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 596 | /*--- end mac_shared.h ---*/ |
njn | 5c004e4 | 2002-11-18 11:04:50 +0000 | [diff] [blame] | 597 | /*--------------------------------------------------------------------*/ |