njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 1 | |
| 2 | /*--------------------------------------------------------------------*/ |
| 3 | /*--- The leak checker, shared between Memcheck and Addrcheck. ---*/ |
| 4 | /*--- mac_leakcheck.c ---*/ |
| 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 | 43c799e | 2003-04-08 00:08:52 +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 | 43c799e | 2003-04-08 00:08:52 +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 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 33 | #include <setjmp.h> |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 34 | #include "mac_shared.h" |
| 35 | |
| 36 | /* Define to debug the memory-leak-detector. */ |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 37 | #define VG_DEBUG_LEAKCHECK 0 |
| 38 | #define VG_DEBUG_CLIQUE 0 |
| 39 | |
| 40 | #define ROUNDDN(p, a) ((Addr)(p) & ~((a)-1)) |
| 41 | #define ROUNDUP(p, a) ROUNDDN((p)+(a)-1, (a)) |
| 42 | #define PGROUNDDN(p) ROUNDDN(p, VKI_PAGE_SIZE) |
| 43 | #define PGROUNDUP(p) ROUNDUP(p, VKI_PAGE_SIZE) |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 44 | |
| 45 | /*------------------------------------------------------------*/ |
| 46 | /*--- Low-level address-space scanning, for the leak ---*/ |
| 47 | /*--- detector. ---*/ |
| 48 | /*------------------------------------------------------------*/ |
| 49 | |
| 50 | static |
| 51 | jmp_buf memscan_jmpbuf; |
| 52 | |
| 53 | |
| 54 | static |
njn | 695c16e | 2005-03-27 03:40:28 +0000 | [diff] [blame] | 55 | void scan_all_valid_memory_catcher ( Int sigNo, Addr addr ) |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 56 | { |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 57 | if (0) |
| 58 | VG_(printf)("OUCH! sig=%d addr=%p\n", sigNo, addr); |
| 59 | if (sigNo == VKI_SIGSEGV || sigNo == VKI_SIGBUS) |
| 60 | __builtin_longjmp(memscan_jmpbuf, 1); |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 61 | } |
| 62 | |
| 63 | /*------------------------------------------------------------*/ |
| 64 | /*--- Detecting leaked (unreachable) malloc'd blocks. ---*/ |
| 65 | /*------------------------------------------------------------*/ |
| 66 | |
| 67 | /* A block is either |
| 68 | -- Proper-ly reached; a pointer to its start has been found |
| 69 | -- Interior-ly reached; only an interior pointer to it has been found |
| 70 | -- Unreached; so far, no pointers to any part of it have been found. |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 71 | -- IndirectLeak; leaked, but referred to by another leaked block |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 72 | */ |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 73 | typedef enum { |
| 74 | Unreached, |
| 75 | IndirectLeak, |
| 76 | Interior, |
| 77 | Proper |
| 78 | } Reachedness; |
| 79 | |
| 80 | /* An entry in the mark stack */ |
| 81 | typedef struct { |
| 82 | Int next:30; /* Index of next in mark stack */ |
| 83 | UInt state:2; /* Reachedness */ |
| 84 | SizeT indirect; /* if Unreached, how much is unreachable from here */ |
| 85 | } MarkStack; |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 86 | |
| 87 | /* A block record, used for generating err msgs. */ |
| 88 | typedef |
| 89 | struct _LossRecord { |
| 90 | struct _LossRecord* next; |
| 91 | /* Where these lost blocks were allocated. */ |
| 92 | ExeContext* allocated_at; |
| 93 | /* Their reachability. */ |
| 94 | Reachedness loss_mode; |
| 95 | /* Number of blocks and total # bytes involved. */ |
| 96 | UInt total_bytes; |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 97 | UInt indirect_bytes; |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 98 | UInt num_blocks; |
| 99 | } |
| 100 | LossRecord; |
| 101 | |
njn | 0297703 | 2005-05-17 04:00:11 +0000 | [diff] [blame^] | 102 | /* The 'extra' struct for leak errors. */ |
| 103 | typedef struct { |
| 104 | UInt n_this_record; |
| 105 | UInt n_total_records; |
| 106 | LossRecord* lossRecord; |
| 107 | } LeakExtra; |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 108 | |
| 109 | /* Find the i such that ptr points at or inside the block described by |
| 110 | shadows[i]. Return -1 if none found. This assumes that shadows[] |
| 111 | has been sorted on the ->data field. */ |
| 112 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 113 | #if VG_DEBUG_LEAKCHECK |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 114 | /* Used to sanity-check the fast binary-search mechanism. */ |
| 115 | static |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 116 | Int find_shadow_for_OLD ( Addr ptr, |
| 117 | MAC_Chunk** shadows, |
| 118 | Int n_shadows ) |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 119 | |
| 120 | { |
| 121 | Int i; |
| 122 | Addr a_lo, a_hi; |
| 123 | PROF_EVENT(70); |
| 124 | for (i = 0; i < n_shadows; i++) { |
| 125 | PROF_EVENT(71); |
| 126 | a_lo = shadows[i]->data; |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 127 | a_hi = ((Addr)shadows[i]->data) + shadows[i]->size; |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 128 | if (a_lo <= ptr && ptr <= a_hi) |
| 129 | return i; |
| 130 | } |
| 131 | return -1; |
| 132 | } |
| 133 | #endif |
| 134 | |
| 135 | |
| 136 | static |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 137 | Int find_shadow_for ( Addr ptr, |
| 138 | MAC_Chunk** shadows, |
| 139 | Int n_shadows ) |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 140 | { |
| 141 | Addr a_mid_lo, a_mid_hi; |
| 142 | Int lo, mid, hi, retVal; |
| 143 | /* VG_(printf)("find shadow for %p = ", ptr); */ |
| 144 | retVal = -1; |
| 145 | lo = 0; |
| 146 | hi = n_shadows-1; |
| 147 | while (True) { |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 148 | /* invariant: current unsearched space is from lo to hi, inclusive. */ |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 149 | if (lo > hi) break; /* not found */ |
| 150 | |
| 151 | mid = (lo + hi) / 2; |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 152 | a_mid_lo = shadows[mid]->data; |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 153 | a_mid_hi = shadows[mid]->data + shadows[mid]->size; |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 154 | |
| 155 | if (ptr < a_mid_lo) { |
| 156 | hi = mid-1; |
| 157 | continue; |
| 158 | } |
| 159 | if (ptr > a_mid_hi) { |
| 160 | lo = mid+1; |
| 161 | continue; |
| 162 | } |
sewardj | 76754cf | 2005-03-14 00:14:04 +0000 | [diff] [blame] | 163 | tl_assert(ptr >= a_mid_lo && ptr <= a_mid_hi); |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 164 | retVal = mid; |
| 165 | break; |
| 166 | } |
| 167 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 168 | # if VG_DEBUG_LEAKCHECK |
sewardj | 76754cf | 2005-03-14 00:14:04 +0000 | [diff] [blame] | 169 | tl_assert(retVal == find_shadow_for_OLD ( ptr, shadows, n_shadows )); |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 170 | # endif |
| 171 | /* VG_(printf)("%d\n", retVal); */ |
| 172 | return retVal; |
| 173 | } |
| 174 | |
| 175 | /* Globals, for the following callback used by VG_(detect_memory_leaks). */ |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 176 | static MAC_Chunk** lc_shadows; |
| 177 | static Int lc_n_shadows; |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 178 | static MarkStack* lc_markstack; |
| 179 | static Int lc_markstack_top; |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 180 | static Addr lc_min_mallocd_addr; |
| 181 | static Addr lc_max_mallocd_addr; |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 182 | static SizeT lc_scanned; |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 183 | |
sewardj | 05fe85e | 2005-04-27 22:46:36 +0000 | [diff] [blame] | 184 | static Bool (*lc_is_within_valid_secondary) (Addr addr); |
| 185 | static Bool (*lc_is_valid_aligned_word) (Addr addr); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 186 | |
njn | 0297703 | 2005-05-17 04:00:11 +0000 | [diff] [blame^] | 187 | static const Char *str_lossmode(Reachedness lossmode) |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 188 | { |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 189 | const Char *loss = "?"; |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 190 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 191 | switch(lossmode) { |
| 192 | case Unreached: loss = "definitely lost"; break; |
| 193 | case IndirectLeak: loss = "indirectly lost"; break; |
| 194 | case Interior: loss = "possibly lost"; break; |
| 195 | case Proper: loss = "still reachable"; break; |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 196 | } |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 197 | |
| 198 | return loss; |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 199 | } |
| 200 | |
| 201 | /* Used for printing leak errors, avoids exposing the LossRecord type (which |
| 202 | comes in as void*, requiring a cast. */ |
njn | 0297703 | 2005-05-17 04:00:11 +0000 | [diff] [blame^] | 203 | void MAC_(pp_LeakError)(void* vextra) |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 204 | { |
njn | 0297703 | 2005-05-17 04:00:11 +0000 | [diff] [blame^] | 205 | LeakExtra* extra = (LeakExtra*)vextra; |
| 206 | LossRecord* l = extra->lossRecord; |
| 207 | const Char *loss = str_lossmode(l->loss_mode); |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 208 | |
| 209 | VG_(message)(Vg_UserMsg, ""); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 210 | if (l->indirect_bytes) { |
| 211 | VG_(message)(Vg_UserMsg, |
| 212 | "%d (%d direct, %d indirect) bytes in %d blocks are %s in loss record %d of %d", |
| 213 | l->total_bytes + l->indirect_bytes, |
| 214 | l->total_bytes, l->indirect_bytes, l->num_blocks, |
njn | 0297703 | 2005-05-17 04:00:11 +0000 | [diff] [blame^] | 215 | loss, extra->n_this_record, extra->n_total_records); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 216 | } else { |
| 217 | VG_(message)(Vg_UserMsg, |
| 218 | "%d bytes in %d blocks are %s in loss record %d of %d", |
| 219 | l->total_bytes, l->num_blocks, |
njn | 0297703 | 2005-05-17 04:00:11 +0000 | [diff] [blame^] | 220 | loss, extra->n_this_record, extra->n_total_records); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 221 | } |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 222 | VG_(pp_ExeContext)(l->allocated_at); |
| 223 | } |
| 224 | |
njn | e8b5c05 | 2003-07-22 22:03:58 +0000 | [diff] [blame] | 225 | Int MAC_(bytes_leaked) = 0; |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 226 | Int MAC_(bytes_indirect) = 0; |
njn | e8b5c05 | 2003-07-22 22:03:58 +0000 | [diff] [blame] | 227 | Int MAC_(bytes_dubious) = 0; |
| 228 | Int MAC_(bytes_reachable) = 0; |
| 229 | Int MAC_(bytes_suppressed) = 0; |
njn | 47363ab | 2003-04-21 13:24:40 +0000 | [diff] [blame] | 230 | |
njn | 06072ec | 2003-09-30 15:35:13 +0000 | [diff] [blame] | 231 | static Int lc_compar(void* n1, void* n2) |
| 232 | { |
| 233 | MAC_Chunk* mc1 = *(MAC_Chunk**)n1; |
| 234 | MAC_Chunk* mc2 = *(MAC_Chunk**)n2; |
| 235 | return (mc1->data < mc2->data ? -1 : 1); |
| 236 | } |
| 237 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 238 | /* If ptr is pointing to a heap-allocated block which hasn't been seen |
| 239 | before, push it onto the mark stack. Clique is the index of the |
| 240 | clique leader; -1 if none. */ |
| 241 | static void _lc_markstack_push(Addr ptr, Int clique) |
| 242 | { |
| 243 | Int sh_no; |
| 244 | |
| 245 | if (!VG_(is_client_addr)(ptr)) /* quick filter */ |
| 246 | return; |
| 247 | |
| 248 | sh_no = find_shadow_for(ptr, lc_shadows, lc_n_shadows); |
| 249 | |
| 250 | if (VG_DEBUG_LEAKCHECK) |
| 251 | VG_(printf)("ptr=%p -> block %d\n", ptr, sh_no); |
| 252 | |
| 253 | if (sh_no == -1) |
| 254 | return; |
| 255 | |
sewardj | 76754cf | 2005-03-14 00:14:04 +0000 | [diff] [blame] | 256 | tl_assert(sh_no >= 0 && sh_no < lc_n_shadows); |
| 257 | tl_assert(ptr <= lc_shadows[sh_no]->data + lc_shadows[sh_no]->size); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 258 | |
| 259 | if (lc_markstack[sh_no].state == Unreached) { |
| 260 | if (0) |
| 261 | VG_(printf)("pushing %p-%p\n", lc_shadows[sh_no]->data, |
| 262 | lc_shadows[sh_no]->data + lc_shadows[sh_no]->size); |
| 263 | |
sewardj | 76754cf | 2005-03-14 00:14:04 +0000 | [diff] [blame] | 264 | tl_assert(lc_markstack[sh_no].next == -1); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 265 | lc_markstack[sh_no].next = lc_markstack_top; |
| 266 | lc_markstack_top = sh_no; |
| 267 | } |
| 268 | |
| 269 | if (clique != -1) { |
| 270 | if (0) |
| 271 | VG_(printf)("mopup: %d: %p is %d\n", |
| 272 | sh_no, lc_shadows[sh_no]->data, lc_markstack[sh_no].state); |
| 273 | |
| 274 | /* An unmarked block - add it to the clique. Add its size to |
| 275 | the clique-leader's indirect size. If the new block was |
| 276 | itself a clique leader, it isn't any more, so add its |
| 277 | indirect to the new clique leader. |
| 278 | |
| 279 | If this block *is* the clique leader, it means this is a |
| 280 | cyclic structure, so none of this applies. */ |
| 281 | if (lc_markstack[sh_no].state == Unreached) { |
| 282 | lc_markstack[sh_no].state = IndirectLeak; |
| 283 | |
| 284 | if (sh_no != clique) { |
| 285 | if (VG_DEBUG_CLIQUE) { |
| 286 | if (lc_markstack[sh_no].indirect) |
| 287 | VG_(printf)(" clique %d joining clique %d adding %d+%d bytes\n", |
| 288 | sh_no, clique, |
| 289 | lc_shadows[sh_no]->size, lc_markstack[sh_no].indirect); |
| 290 | else |
| 291 | VG_(printf)(" %d joining %d adding %d\n", |
| 292 | sh_no, clique, lc_shadows[sh_no]->size); |
| 293 | } |
| 294 | |
| 295 | lc_markstack[clique].indirect += lc_shadows[sh_no]->size; |
| 296 | lc_markstack[clique].indirect += lc_markstack[sh_no].indirect; |
| 297 | lc_markstack[sh_no].indirect = 0; /* shouldn't matter */ |
| 298 | } |
| 299 | } |
| 300 | } else if (ptr == lc_shadows[sh_no]->data) { |
| 301 | lc_markstack[sh_no].state = Proper; |
| 302 | } else { |
| 303 | if (lc_markstack[sh_no].state == Unreached) |
| 304 | lc_markstack[sh_no].state = Interior; |
| 305 | } |
| 306 | } |
| 307 | |
| 308 | static void lc_markstack_push(Addr ptr) |
| 309 | { |
| 310 | _lc_markstack_push(ptr, -1); |
| 311 | } |
| 312 | |
| 313 | /* Return the top of the mark stack, if any. */ |
| 314 | static Int lc_markstack_pop(void) |
| 315 | { |
| 316 | Int ret = lc_markstack_top; |
| 317 | |
| 318 | if (ret != -1) { |
| 319 | lc_markstack_top = lc_markstack[ret].next; |
| 320 | lc_markstack[ret].next = -1; |
| 321 | } |
| 322 | |
| 323 | return ret; |
| 324 | } |
| 325 | |
sewardj | 45d94cc | 2005-04-20 14:44:11 +0000 | [diff] [blame] | 326 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 327 | /* Scan a block of memory between [start, start+len). This range may |
| 328 | be bogus, inaccessable, or otherwise strange; we deal with it. |
| 329 | |
| 330 | If clique != -1, it means we're gathering leaked memory into |
| 331 | cliques, and clique is the index of the current clique leader. */ |
| 332 | static void _lc_scan_memory(Addr start, SizeT len, Int clique) |
| 333 | { |
| 334 | Addr ptr = ROUNDUP(start, sizeof(Addr)); |
| 335 | Addr end = ROUNDDN(start+len, sizeof(Addr)); |
| 336 | vki_sigset_t sigmask; |
| 337 | |
| 338 | if (VG_DEBUG_LEAKCHECK) |
| 339 | VG_(printf)("scan %p-%p\n", start, len); |
| 340 | VG_(sigprocmask)(VKI_SIG_SETMASK, NULL, &sigmask); |
njn | 695c16e | 2005-03-27 03:40:28 +0000 | [diff] [blame] | 341 | VG_(set_fault_catcher)(scan_all_valid_memory_catcher); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 342 | |
| 343 | lc_scanned += end-ptr; |
| 344 | |
| 345 | if (!VG_(is_client_addr)(ptr) || |
| 346 | !VG_(is_addressable)(ptr, sizeof(Addr), VKI_PROT_READ)) |
| 347 | ptr = PGROUNDUP(ptr+1); /* first page bad */ |
| 348 | |
sewardj | 05fe85e | 2005-04-27 22:46:36 +0000 | [diff] [blame] | 349 | while (ptr < end) { |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 350 | Addr addr; |
| 351 | |
| 352 | /* Skip invalid chunks */ |
sewardj | 05fe85e | 2005-04-27 22:46:36 +0000 | [diff] [blame] | 353 | if (!(*lc_is_within_valid_secondary)(ptr)) { |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 354 | ptr = ROUNDUP(ptr+1, SECONDARY_SIZE); |
| 355 | continue; |
| 356 | } |
| 357 | |
| 358 | /* Look to see if this page seems reasonble */ |
| 359 | if ((ptr % VKI_PAGE_SIZE) == 0) { |
| 360 | if (!VG_(is_client_addr)(ptr) || |
| 361 | !VG_(is_addressable)(ptr, sizeof(Addr), VKI_PROT_READ)) |
| 362 | ptr += VKI_PAGE_SIZE; /* bad page - skip it */ |
| 363 | } |
| 364 | |
| 365 | if (__builtin_setjmp(memscan_jmpbuf) == 0) { |
sewardj | 05fe85e | 2005-04-27 22:46:36 +0000 | [diff] [blame] | 366 | if ((*lc_is_valid_aligned_word)(ptr)) { |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 367 | addr = *(Addr *)ptr; |
| 368 | _lc_markstack_push(addr, clique); |
| 369 | } else if (0 && VG_DEBUG_LEAKCHECK) |
| 370 | VG_(printf)("%p not valid\n", ptr); |
| 371 | ptr += sizeof(Addr); |
| 372 | } else { |
| 373 | /* We need to restore the signal mask, because we were |
| 374 | longjmped out of a signal handler. */ |
| 375 | VG_(sigprocmask)(VKI_SIG_SETMASK, &sigmask, NULL); |
| 376 | |
| 377 | ptr = PGROUNDUP(ptr+1); /* bad page - skip it */ |
| 378 | } |
| 379 | } |
| 380 | |
| 381 | VG_(sigprocmask)(VKI_SIG_SETMASK, &sigmask, NULL); |
| 382 | VG_(set_fault_catcher)(NULL); |
| 383 | } |
| 384 | |
sewardj | 45d94cc | 2005-04-20 14:44:11 +0000 | [diff] [blame] | 385 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 386 | static void lc_scan_memory(Addr start, SizeT len) |
| 387 | { |
| 388 | _lc_scan_memory(start, len, -1); |
| 389 | } |
| 390 | |
| 391 | /* Process the mark stack until empty. If mopup is true, then we're |
| 392 | actually gathering leaked blocks, so they should be marked |
| 393 | IndirectLeak. */ |
| 394 | static void lc_do_leakcheck(Int clique) |
| 395 | { |
| 396 | Int top; |
| 397 | |
| 398 | while((top = lc_markstack_pop()) != -1) { |
sewardj | 76754cf | 2005-03-14 00:14:04 +0000 | [diff] [blame] | 399 | tl_assert(top >= 0 && top < lc_n_shadows); |
| 400 | tl_assert(lc_markstack[top].state != Unreached); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 401 | |
| 402 | _lc_scan_memory(lc_shadows[top]->data, lc_shadows[top]->size, clique); |
| 403 | } |
| 404 | } |
| 405 | |
| 406 | static Int blocks_leaked; |
| 407 | static Int blocks_indirect; |
| 408 | static Int blocks_dubious; |
| 409 | static Int blocks_reachable; |
| 410 | static Int blocks_suppressed; |
| 411 | |
njn | b8dca86 | 2005-03-14 02:42:44 +0000 | [diff] [blame] | 412 | static void full_report(ThreadId tid) |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 413 | { |
| 414 | Int i; |
| 415 | Int n_lossrecords; |
| 416 | LossRecord* errlist; |
| 417 | LossRecord* p; |
| 418 | Bool is_suppressed; |
njn | 0297703 | 2005-05-17 04:00:11 +0000 | [diff] [blame^] | 419 | LeakExtra leak_extra; |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 420 | |
| 421 | /* Go through and group lost structures into cliques. For each |
| 422 | Unreached block, push it onto the mark stack, and find all the |
| 423 | blocks linked to it. These are marked IndirectLeak, and their |
| 424 | size is added to the clique leader's indirect size. If one of |
| 425 | the found blocks was itself a clique leader (from a previous |
| 426 | pass), then the cliques are merged. */ |
| 427 | for (i = 0; i < lc_n_shadows; i++) { |
| 428 | if (VG_DEBUG_CLIQUE) |
| 429 | VG_(printf)("cliques: %d at %p -> %s\n", |
njn | 0297703 | 2005-05-17 04:00:11 +0000 | [diff] [blame^] | 430 | i, lc_shadows[i]->data, str_lossmode(lc_markstack[i].state)); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 431 | if (lc_markstack[i].state != Unreached) |
| 432 | continue; |
| 433 | |
sewardj | 76754cf | 2005-03-14 00:14:04 +0000 | [diff] [blame] | 434 | tl_assert(lc_markstack_top == -1); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 435 | |
| 436 | if (VG_DEBUG_CLIQUE) |
| 437 | VG_(printf)("%d: gathering clique %p\n", i, lc_shadows[i]->data); |
| 438 | |
| 439 | _lc_markstack_push(lc_shadows[i]->data, i); |
| 440 | |
| 441 | lc_do_leakcheck(i); |
| 442 | |
sewardj | 76754cf | 2005-03-14 00:14:04 +0000 | [diff] [blame] | 443 | tl_assert(lc_markstack_top == -1); |
| 444 | tl_assert(lc_markstack[i].state == IndirectLeak); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 445 | |
| 446 | lc_markstack[i].state = Unreached; /* Return to unreached state, |
| 447 | to indicate its a clique |
| 448 | leader */ |
| 449 | } |
| 450 | |
| 451 | /* Common up the lost blocks so we can print sensible error messages. */ |
| 452 | n_lossrecords = 0; |
| 453 | errlist = NULL; |
| 454 | for (i = 0; i < lc_n_shadows; i++) { |
| 455 | ExeContext* where = lc_shadows[i]->where; |
| 456 | |
| 457 | for (p = errlist; p != NULL; p = p->next) { |
| 458 | if (p->loss_mode == lc_markstack[i].state |
| 459 | && VG_(eq_ExeContext) ( MAC_(clo_leak_resolution), |
| 460 | p->allocated_at, |
| 461 | where) ) { |
| 462 | break; |
| 463 | } |
| 464 | } |
| 465 | if (p != NULL) { |
| 466 | p->num_blocks ++; |
| 467 | p->total_bytes += lc_shadows[i]->size; |
| 468 | p->indirect_bytes += lc_markstack[i].indirect; |
| 469 | } else { |
| 470 | n_lossrecords ++; |
| 471 | p = VG_(malloc)(sizeof(LossRecord)); |
| 472 | p->loss_mode = lc_markstack[i].state; |
| 473 | p->allocated_at = where; |
| 474 | p->total_bytes = lc_shadows[i]->size; |
| 475 | p->indirect_bytes = lc_markstack[i].indirect; |
| 476 | p->num_blocks = 1; |
| 477 | p->next = errlist; |
| 478 | errlist = p; |
| 479 | } |
| 480 | } |
| 481 | |
| 482 | /* Print out the commoned-up blocks and collect summary stats. */ |
| 483 | for (i = 0; i < n_lossrecords; i++) { |
| 484 | Bool print_record; |
| 485 | LossRecord* p_min = NULL; |
| 486 | UInt n_min = 0xFFFFFFFF; |
| 487 | for (p = errlist; p != NULL; p = p->next) { |
| 488 | if (p->num_blocks > 0 && p->total_bytes < n_min) { |
| 489 | n_min = p->total_bytes + p->indirect_bytes; |
| 490 | p_min = p; |
| 491 | } |
| 492 | } |
sewardj | 76754cf | 2005-03-14 00:14:04 +0000 | [diff] [blame] | 493 | tl_assert(p_min != NULL); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 494 | |
| 495 | /* Ok to have tst==NULL; it's only used if --gdb-attach=yes, and |
| 496 | we disallow that when --leak-check=yes. |
| 497 | |
njn | 0297703 | 2005-05-17 04:00:11 +0000 | [diff] [blame^] | 498 | Prints the error if not suppressed, unless it's reachable (Proper |
| 499 | or IndirectLeak) and --show-reachable=no */ |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 500 | |
| 501 | print_record = ( MAC_(clo_show_reachable) || |
njn | 0297703 | 2005-05-17 04:00:11 +0000 | [diff] [blame^] | 502 | Unreached == p_min->loss_mode || |
| 503 | Interior == p_min->loss_mode ); |
| 504 | |
| 505 | // Nb: because VG_(unique_error) does all the error processing |
| 506 | // immediately, and doesn't save the error, leakExtra can be |
| 507 | // stack-allocated. |
| 508 | leak_extra.n_this_record = i+1; |
| 509 | leak_extra.n_total_records = n_lossrecords; |
| 510 | leak_extra.lossRecord = p_min; |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 511 | is_suppressed = |
njn | 0297703 | 2005-05-17 04:00:11 +0000 | [diff] [blame^] | 512 | VG_(unique_error) ( tid, LeakErr, /*Addr*/0, /*s*/NULL, |
| 513 | /*extra*/&leak_extra, |
| 514 | /*where*/p_min->allocated_at, print_record, |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 515 | /*allow_GDB_attach*/False, /*count_error*/False ); |
| 516 | |
| 517 | if (is_suppressed) { |
| 518 | blocks_suppressed += p_min->num_blocks; |
| 519 | MAC_(bytes_suppressed) += p_min->total_bytes; |
| 520 | |
| 521 | } else if (Unreached == p_min->loss_mode) { |
| 522 | blocks_leaked += p_min->num_blocks; |
| 523 | MAC_(bytes_leaked) += p_min->total_bytes; |
| 524 | |
| 525 | } else if (IndirectLeak == p_min->loss_mode) { |
| 526 | blocks_indirect += p_min->num_blocks; |
| 527 | MAC_(bytes_indirect)+= p_min->total_bytes; |
| 528 | |
| 529 | } else if (Interior == p_min->loss_mode) { |
| 530 | blocks_dubious += p_min->num_blocks; |
| 531 | MAC_(bytes_dubious) += p_min->total_bytes; |
| 532 | |
| 533 | } else if (Proper == p_min->loss_mode) { |
| 534 | blocks_reachable += p_min->num_blocks; |
| 535 | MAC_(bytes_reachable) += p_min->total_bytes; |
| 536 | |
| 537 | } else { |
sewardj | 76754cf | 2005-03-14 00:14:04 +0000 | [diff] [blame] | 538 | VG_(tool_panic)("generic_detect_memory_leaks: unknown loss mode"); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 539 | } |
| 540 | p_min->num_blocks = 0; |
| 541 | } |
| 542 | } |
| 543 | |
| 544 | /* Compute a quick summary of the leak check. */ |
| 545 | static void make_summary() |
| 546 | { |
| 547 | Int i; |
| 548 | |
| 549 | for(i = 0; i < lc_n_shadows; i++) { |
| 550 | SizeT size = lc_shadows[i]->size; |
| 551 | |
| 552 | switch(lc_markstack[i].state) { |
| 553 | case Unreached: |
| 554 | blocks_leaked++; |
| 555 | MAC_(bytes_leaked) += size; |
| 556 | break; |
| 557 | |
| 558 | case Proper: |
| 559 | blocks_reachable++; |
| 560 | MAC_(bytes_reachable) += size; |
| 561 | break; |
| 562 | |
| 563 | case Interior: |
| 564 | blocks_dubious++; |
| 565 | MAC_(bytes_dubious) += size; |
| 566 | break; |
| 567 | |
| 568 | case IndirectLeak: /* shouldn't happen */ |
| 569 | blocks_indirect++; |
| 570 | MAC_(bytes_indirect) += size; |
| 571 | break; |
| 572 | } |
| 573 | } |
| 574 | } |
| 575 | |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 576 | /* Top level entry point to leak detector. Call here, passing in |
| 577 | suitable address-validating functions (see comment at top of |
njn | 695c16e | 2005-03-27 03:40:28 +0000 | [diff] [blame] | 578 | scan_all_valid_memory above). All this is to avoid duplication |
nethercote | 996901a | 2004-08-03 13:29:09 +0000 | [diff] [blame] | 579 | of the leak-detection code for Memcheck and Addrcheck. |
| 580 | Also pass in a tool-specific function to extract the .where field |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 581 | for allocated blocks, an indication of the resolution wanted for |
| 582 | distinguishing different allocation points, and whether or not |
| 583 | reachable blocks should be shown. |
| 584 | */ |
| 585 | void MAC_(do_detect_memory_leaks) ( |
njn | b8dca86 | 2005-03-14 02:42:44 +0000 | [diff] [blame] | 586 | ThreadId tid, LeakCheckMode mode, |
sewardj | 05fe85e | 2005-04-27 22:46:36 +0000 | [diff] [blame] | 587 | Bool (*is_within_valid_secondary) ( Addr ), |
| 588 | Bool (*is_valid_aligned_word) ( Addr ) |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 589 | ) |
| 590 | { |
njn | b8dca86 | 2005-03-14 02:42:44 +0000 | [diff] [blame] | 591 | Int i; |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 592 | |
sewardj | 76754cf | 2005-03-14 00:14:04 +0000 | [diff] [blame] | 593 | tl_assert(mode != LC_Off); |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 594 | |
njn | 06072ec | 2003-09-30 15:35:13 +0000 | [diff] [blame] | 595 | /* VG_(HT_to_array) allocates storage for shadows */ |
| 596 | lc_shadows = (MAC_Chunk**)VG_(HT_to_array)( MAC_(malloc_list), |
| 597 | &lc_n_shadows ); |
| 598 | |
| 599 | /* Sort the array. */ |
| 600 | VG_(ssort)((void*)lc_shadows, lc_n_shadows, sizeof(VgHashNode*), lc_compar); |
| 601 | |
| 602 | /* Sanity check; assert that the blocks are now in order */ |
| 603 | for (i = 0; i < lc_n_shadows-1; i++) { |
sewardj | 76754cf | 2005-03-14 00:14:04 +0000 | [diff] [blame] | 604 | tl_assert( lc_shadows[i]->data <= lc_shadows[i+1]->data); |
njn | 06072ec | 2003-09-30 15:35:13 +0000 | [diff] [blame] | 605 | } |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 606 | |
| 607 | /* Sanity check -- make sure they don't overlap */ |
| 608 | for (i = 0; i < lc_n_shadows-1; i++) { |
sewardj | 76754cf | 2005-03-14 00:14:04 +0000 | [diff] [blame] | 609 | tl_assert( lc_shadows[i]->data + lc_shadows[i]->size |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 610 | < lc_shadows[i+1]->data ); |
| 611 | } |
| 612 | |
| 613 | if (lc_n_shadows == 0) { |
sewardj | 76754cf | 2005-03-14 00:14:04 +0000 | [diff] [blame] | 614 | tl_assert(lc_shadows == NULL); |
sewardj | 37d06f2 | 2003-09-17 21:48:26 +0000 | [diff] [blame] | 615 | if (VG_(clo_verbosity) >= 1) { |
| 616 | VG_(message)(Vg_UserMsg, |
| 617 | "No malloc'd blocks -- no leaks are possible."); |
| 618 | } |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 619 | return; |
| 620 | } |
| 621 | |
nethercote | 0f19bce | 2003-12-02 10:17:44 +0000 | [diff] [blame] | 622 | if (VG_(clo_verbosity) > 0) |
| 623 | VG_(message)(Vg_UserMsg, |
| 624 | "searching for pointers to %d not-freed blocks.", |
| 625 | lc_n_shadows ); |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 626 | |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 627 | lc_min_mallocd_addr = lc_shadows[0]->data; |
| 628 | lc_max_mallocd_addr = lc_shadows[lc_n_shadows-1]->data |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 629 | + lc_shadows[lc_n_shadows-1]->size; |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 630 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 631 | lc_markstack = VG_(malloc)( lc_n_shadows * sizeof(*lc_markstack) ); |
| 632 | for (i = 0; i < lc_n_shadows; i++) { |
| 633 | lc_markstack[i].next = -1; |
| 634 | lc_markstack[i].state = Unreached; |
| 635 | lc_markstack[i].indirect = 0; |
| 636 | } |
| 637 | lc_markstack_top = -1; |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 638 | |
sewardj | 05fe85e | 2005-04-27 22:46:36 +0000 | [diff] [blame] | 639 | lc_is_within_valid_secondary = is_within_valid_secondary; |
| 640 | lc_is_valid_aligned_word = is_valid_aligned_word; |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 641 | |
| 642 | lc_scanned = 0; |
| 643 | |
| 644 | /* Do the scan of memory, pushing any pointers onto the mark stack */ |
| 645 | VG_(find_root_memory)(lc_scan_memory); |
| 646 | |
| 647 | /* Push registers onto mark stack */ |
| 648 | VG_(mark_from_registers)(lc_markstack_push); |
| 649 | |
| 650 | /* Keep walking the heap until everything is found */ |
| 651 | lc_do_leakcheck(-1); |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 652 | |
nethercote | 0f19bce | 2003-12-02 10:17:44 +0000 | [diff] [blame] | 653 | if (VG_(clo_verbosity) > 0) |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 654 | VG_(message)(Vg_UserMsg, "checked %d bytes.", lc_scanned); |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 655 | |
njn | e8b5c05 | 2003-07-22 22:03:58 +0000 | [diff] [blame] | 656 | blocks_leaked = MAC_(bytes_leaked) = 0; |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 657 | blocks_indirect = MAC_(bytes_indirect) = 0; |
njn | e8b5c05 | 2003-07-22 22:03:58 +0000 | [diff] [blame] | 658 | blocks_dubious = MAC_(bytes_dubious) = 0; |
| 659 | blocks_reachable = MAC_(bytes_reachable) = 0; |
| 660 | blocks_suppressed = MAC_(bytes_suppressed) = 0; |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 661 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 662 | if (mode == LC_Full) |
njn | b8dca86 | 2005-03-14 02:42:44 +0000 | [diff] [blame] | 663 | full_report(tid); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 664 | else |
| 665 | make_summary(); |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 666 | |
nethercote | 0f19bce | 2003-12-02 10:17:44 +0000 | [diff] [blame] | 667 | if (VG_(clo_verbosity) > 0) { |
| 668 | VG_(message)(Vg_UserMsg, ""); |
| 669 | VG_(message)(Vg_UserMsg, "LEAK SUMMARY:"); |
| 670 | VG_(message)(Vg_UserMsg, " definitely lost: %d bytes in %d blocks.", |
| 671 | MAC_(bytes_leaked), blocks_leaked ); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 672 | if (blocks_indirect > 0) |
| 673 | VG_(message)(Vg_UserMsg, " indirectly lost: %d bytes in %d blocks.", |
| 674 | MAC_(bytes_indirect), blocks_indirect ); |
| 675 | VG_(message)(Vg_UserMsg, " possibly lost: %d bytes in %d blocks.", |
nethercote | 0f19bce | 2003-12-02 10:17:44 +0000 | [diff] [blame] | 676 | MAC_(bytes_dubious), blocks_dubious ); |
| 677 | VG_(message)(Vg_UserMsg, " still reachable: %d bytes in %d blocks.", |
| 678 | MAC_(bytes_reachable), blocks_reachable ); |
| 679 | VG_(message)(Vg_UserMsg, " suppressed: %d bytes in %d blocks.", |
| 680 | MAC_(bytes_suppressed), blocks_suppressed ); |
njn | 6a32942 | 2005-03-12 20:38:13 +0000 | [diff] [blame] | 681 | if (mode == LC_Summary && blocks_leaked > 0) |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 682 | VG_(message)(Vg_UserMsg, |
| 683 | "Use --leak-check=full to see details of leaked memory."); |
| 684 | else if (!MAC_(clo_show_reachable)) { |
nethercote | 0f19bce | 2003-12-02 10:17:44 +0000 | [diff] [blame] | 685 | VG_(message)(Vg_UserMsg, |
| 686 | "Reachable blocks (those to which a pointer was found) are not shown."); |
| 687 | VG_(message)(Vg_UserMsg, |
| 688 | "To see them, rerun with: --show-reachable=yes"); |
| 689 | } |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 690 | } |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 691 | |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 692 | VG_(free) ( lc_shadows ); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 693 | VG_(free) ( lc_markstack ); |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 694 | } |
| 695 | |
| 696 | /*--------------------------------------------------------------------*/ |
| 697 | /*--- end mac_leakcheck.c ---*/ |
| 698 | /*--------------------------------------------------------------------*/ |
| 699 | |