blob: 88b9f3a9fa4de60f3f7d5bb9efc9e44f002111f0 [file] [log] [blame]
njn5c004e42002-11-18 11:04:50 +00001
2/*--------------------------------------------------------------------*/
njn51d827b2005-05-09 01:02:08 +00003/*--- Declarations shared between Memcheck and Addrcheck. ---*/
njn43c799e2003-04-08 00:08:52 +00004/*--- mac_shared.h ---*/
njn5c004e42002-11-18 11:04:50 +00005/*--------------------------------------------------------------------*/
6
7/*
nethercote137bc552003-11-14 17:47:54 +00008 This file is part of MemCheck, a heavyweight Valgrind tool for
9 detecting memory errors, and AddrCheck, a lightweight Valgrind tool
njn5c004e42002-11-18 11:04:50 +000010 for detecting memory errors.
11
njn53612422005-03-12 16:22:54 +000012 Copyright (C) 2000-2005 Julian Seward
njn5c004e42002-11-18 11:04:50 +000013 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
njn43c799e2003-04-08 00:08:52 +000033/* 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
njn5c004e42002-11-18 11:04:50 +000038
njn43c799e2003-04-08 00:08:52 +000039#define MAC_(str) VGAPPEND(vgMAC_,str)
njn5c004e42002-11-18 11:04:50 +000040
njn9b007f62003-04-07 14:40:25 +000041/*------------------------------------------------------------*/
42/*--- Errors and suppressions ---*/
43/*------------------------------------------------------------*/
44
njn5c004e42002-11-18 11:04:50 +000045/* The classification of a faulting address. */
46typedef
njn43c799e2003-04-08 00:08:52 +000047 enum {
nethercote8b76fe52004-11-08 19:20:09 +000048 Undescribed, // as-yet unclassified
njn43c799e2003-04-08 00:08:52 +000049 Stack,
nethercote8b76fe52004-11-08 19:20:09 +000050 Unknown, // classification yielded nothing useful
njn43c799e2003-04-08 00:08:52 +000051 Freed, Mallocd,
nethercote8b76fe52004-11-08 19:20:09 +000052 UserG, // in a user-defined block
53 Mempool, // in a mempool
54 Register, // in a register; for Param errors only
njn5c004e42002-11-18 11:04:50 +000055 }
56 AddrKind;
57
58/* Records info about a faulting address. */
59typedef
nethercote05675c82004-08-04 10:37:49 +000060 struct { // Used by:
61 AddrKind akind; // ALL
nethercote928a5f72004-11-03 18:10:37 +000062 SizeT blksize; // Freed, Mallocd
nethercote8b76fe52004-11-08 19:20:09 +000063 OffT rwoffset; // Freed, Mallocd
nethercote05675c82004-08-04 10:37:49 +000064 ExeContext* lastchange; // Freed, Mallocd
65 ThreadId stack_tid; // Stack
sewardjb5f6f512005-03-10 23:59:00 +000066 const Char *desc; // UserG
nethercote05675c82004-08-04 10:37:49 +000067 Bool maybe_gcc; // True if just below %esp -- could be a gcc bug.
njn5c004e42002-11-18 11:04:50 +000068 }
69 AddrInfo;
70
71typedef
72 enum {
nethercote05675c82004-08-04 10:37:49 +000073 ParamSupp, // Bad syscall params
74 CoreMemSupp, // Memory errors in core (pthread ops, signal handling)
75
76 // Use of invalid values of given size (MemCheck only)
njnc0616662003-06-12 09:58:41 +000077 Value0Supp, Value1Supp, Value2Supp, Value4Supp, Value8Supp, Value16Supp,
nethercote05675c82004-08-04 10:37:49 +000078
79 // Invalid read/write attempt at given size
njnc0616662003-06-12 09:58:41 +000080 Addr1Supp, Addr2Supp, Addr4Supp, Addr8Supp, Addr16Supp,
nethercote05675c82004-08-04 10:37:49 +000081
82 FreeSupp, // Invalid or mismatching free
83 OverlapSupp, // Overlapping blocks in memcpy(), strcpy(), etc
84 LeakSupp, // Something to be suppressed in a leak check.
85 MempoolSupp, // Memory pool suppression.
njn5c004e42002-11-18 11:04:50 +000086 }
njn43c799e2003-04-08 00:08:52 +000087 MAC_SuppKind;
njn5c004e42002-11-18 11:04:50 +000088
89/* What kind of error it is. */
90typedef
91 enum { ValueErr, /* Memcheck only */
92 CoreMemErr,
93 AddrErr,
94 ParamErr, UserErr, /* behaves like an anonymous ParamErr */
njn43c799e2003-04-08 00:08:52 +000095 FreeErr, FreeMismatchErr,
njn7201b2a2003-08-19 12:16:05 +000096 OverlapErr,
rjwalshbc0bb832004-06-19 18:12:36 +000097 LeakErr,
98 IllegalMempoolErr,
njn5c004e42002-11-18 11:04:50 +000099 }
njn43c799e2003-04-08 00:08:52 +0000100 MAC_ErrorKind;
njn5c004e42002-11-18 11:04:50 +0000101
102/* What kind of memory access is involved in the error? */
103typedef
104 enum { ReadAxs, WriteAxs, ExecAxs }
105 AxsKind;
106
107/* Extra context for memory errors */
108typedef
nethercote05675c82004-08-04 10:37:49 +0000109 struct { // Used by:
110 AxsKind axskind; // AddrErr
111 Int size; // AddrErr, ValueErr
112 AddrInfo addrinfo; // {Addr,Free,FreeMismatch,Param,User}Err
nethercote8b76fe52004-11-08 19:20:09 +0000113 Bool isUnaddr; // {CoreMem,Param,User}Err
njn5c004e42002-11-18 11:04:50 +0000114 }
njn43c799e2003-04-08 00:08:52 +0000115 MAC_Error;
njn5c004e42002-11-18 11:04:50 +0000116
njnb6cae9f2003-09-04 20:50:47 +0000117/* Extra info for overlap errors */
118typedef
119 struct {
120 Addr src;
121 Addr dst;
122 Int len; // -1 if unused
123 }
124 OverlapExtra;
125
njn3e884182003-04-15 13:03:23 +0000126/* For malloc()/new/new[] vs. free()/delete/delete[] mismatch checking. */
127typedef
128 enum {
129 MAC_AllocMalloc = 0,
130 MAC_AllocNew = 1,
njn10785452003-05-20 16:38:24 +0000131 MAC_AllocNewVec = 2,
132 MAC_AllocCustom = 3
njn3e884182003-04-15 13:03:23 +0000133 }
134 MAC_AllocKind;
135
136/* Nb: first two fields must match core's VgHashNode. */
137typedef
138 struct _MAC_Chunk {
139 struct _MAC_Chunk* next;
nethercote05675c82004-08-04 10:37:49 +0000140 Addr data; // ptr to actual block
njnb729e0d2004-12-01 00:19:38 +0000141 SizeT size : (sizeof(UWord)*8)-2; // size requested; 30 or 62 bits
nethercote05675c82004-08-04 10:37:49 +0000142 MAC_AllocKind allockind : 2; // which wrapper did the allocation
143 ExeContext* where; // where it was allocated
njn3e884182003-04-15 13:03:23 +0000144 }
145 MAC_Chunk;
146
rjwalshbc0bb832004-06-19 18:12:36 +0000147/* Memory pool. Nb: first two fields must match core's VgHashNode. */
148typedef
149 struct _MAC_Mempool {
150 struct _MAC_Mempool* next;
nethercote05675c82004-08-04 10:37:49 +0000151 Addr pool; // pool identifier
njnb729e0d2004-12-01 00:19:38 +0000152 SizeT rzB; // pool red-zone size
nethercote05675c82004-08-04 10:37:49 +0000153 Bool is_zeroed; // allocations from this pool are zeroed
154 VgHashTable chunks; // chunks associated with this pool
rjwalshbc0bb832004-06-19 18:12:36 +0000155 }
156 MAC_Mempool;
157
158
njn9b007f62003-04-07 14:40:25 +0000159/*------------------------------------------------------------*/
nethercote7cc9c232004-01-21 15:08:04 +0000160/*--- Profiling of tools and memory events ---*/
njn9b007f62003-04-07 14:40:25 +0000161/*------------------------------------------------------------*/
162
163typedef
164 enum {
165 VgpCheckMem = VgpFini+1,
166 VgpSetMem,
167 VgpESPAdj
168 }
nethercote7cc9c232004-01-21 15:08:04 +0000169 VgpToolCC;
njn9b007f62003-04-07 14:40:25 +0000170
171/* Define to collect detailed performance info. */
sewardj23eb2fd2005-04-22 16:29:19 +0000172/* #define MAC_PROFILE_MEMORY */
njn5c004e42002-11-18 11:04:50 +0000173
njn43c799e2003-04-08 00:08:52 +0000174#ifdef MAC_PROFILE_MEMORY
sewardjc1a2cda2005-04-21 17:34:00 +0000175# define N_PROF_EVENTS 500
njn5c004e42002-11-18 11:04:50 +0000176
sewardjc1a2cda2005-04-21 17:34:00 +0000177extern UInt MAC_(event_ctr)[N_PROF_EVENTS];
178extern HChar* MAC_(event_ctr_name)[N_PROF_EVENTS];
njn9b007f62003-04-07 14:40:25 +0000179
sewardjc1a2cda2005-04-21 17:34:00 +0000180# define PROF_EVENT(ev, name) \
181 do { tl_assert((ev) >= 0 && (ev) < N_PROF_EVENTS); \
182 /* crude and inaccurate check to ensure the same */ \
183 /* event isn't being used with > 1 name */ \
184 if (MAC_(event_ctr_name)[ev]) \
185 tl_assert(name == MAC_(event_ctr_name)[ev]); \
186 MAC_(event_ctr)[ev]++; \
187 MAC_(event_ctr_name)[ev] = (name); \
njn5c004e42002-11-18 11:04:50 +0000188 } while (False);
189
190#else
191
sewardjc1a2cda2005-04-21 17:34:00 +0000192# define PROF_EVENT(ev, name) /* */
njn5c004e42002-11-18 11:04:50 +0000193
njn43c799e2003-04-08 00:08:52 +0000194#endif /* MAC_PROFILE_MEMORY */
njn5c004e42002-11-18 11:04:50 +0000195
njn9b007f62003-04-07 14:40:25 +0000196
sewardj23eb2fd2005-04-22 16:29:19 +0000197/*------------------------------------------------------------*/
198/*--- V and A bits (Victoria & Albert ?) ---*/
199/*------------------------------------------------------------*/
200
201/* expand 1 bit -> 8 */
202#define BIT_TO_BYTE(b) ((~(((UChar)(b) & 1) - 1)) & 0xFF)
203
sewardj05fe85e2005-04-27 22:46:36 +0000204/* The number of entries in the primary map can be altered. However
205 we hardwire the assumption that each secondary map covers precisely
206 64k of address space. */
207#define SECONDARY_SIZE 65536 /* DO NOT CHANGE */
208#define SECONDARY_MASK (SECONDARY_SIZE-1) /* DO NOT CHANGE */
209
sewardj45d94cc2005-04-20 14:44:11 +0000210//zz #define SECONDARY_SHIFT 16
211//zz #define SECONDARY_SIZE (1 << SECONDARY_SHIFT)
212//zz #define SECONDARY_MASK (SECONDARY_SIZE - 1)
213//zz
214//zz #define PRIMARY_SIZE (1 << (32 - SECONDARY_SHIFT))
215//zz
216//zz #define SM_OFF(addr) ((addr) & SECONDARY_MASK)
217//zz #define PM_IDX(addr) ((addr) >> SECONDARY_SHIFT)
218/*
sewardjb5f6f512005-03-10 23:59:00 +0000219#define IS_DISTINGUISHED_SM(smap) \
220 ((smap) >= &distinguished_secondary_maps[0] && \
221 (smap) < &distinguished_secondary_maps[N_SECONDARY_MAPS])
222
223#define IS_DISTINGUISHED(addr) (IS_DISTINGUISHED_SM(primary_map[PM_IDX(addr)]))
njn5c004e42002-11-18 11:04:50 +0000224
njn43c799e2003-04-08 00:08:52 +0000225#define ENSURE_MAPPABLE(addr,caller) \
226 do { \
sewardjb5f6f512005-03-10 23:59:00 +0000227 if (IS_DISTINGUISHED(addr)) { \
228 primary_map[PM_IDX(addr)] = alloc_secondary_map(caller, primary_map[PM_IDX(addr)]); \
sewardj45d94cc2005-04-20 14:44:11 +0000229 if (0) VG_(printf)("new 2map because of %p\n", addr); \
njn43c799e2003-04-08 00:08:52 +0000230 } \
sewardj45d94cc2005-04-20 14:44:11 +0000231 } while(0)
232*/
njn5c004e42002-11-18 11:04:50 +0000233
234#define BITARR_SET(aaa_p,iii_p) \
235 do { \
sewardj45d94cc2005-04-20 14:44:11 +0000236 UWord iii = (UWord)iii_p; \
237 UChar* aaa = (UChar*)aaa_p; \
njn5c004e42002-11-18 11:04:50 +0000238 aaa[iii >> 3] |= (1 << (iii & 7)); \
239 } while (0)
240
241#define BITARR_CLEAR(aaa_p,iii_p) \
242 do { \
sewardj45d94cc2005-04-20 14:44:11 +0000243 UWord iii = (UWord)iii_p; \
244 UChar* aaa = (UChar*)aaa_p; \
njn5c004e42002-11-18 11:04:50 +0000245 aaa[iii >> 3] &= ~(1 << (iii & 7)); \
246 } while (0)
247
248#define BITARR_TEST(aaa_p,iii_p) \
sewardj45d94cc2005-04-20 14:44:11 +0000249 (0 != (((UChar*)aaa_p)[ ((UWord)iii_p) >> 3 ] \
250 & (1 << (((UWord)iii_p) & 7)))) \
251
252static inline
253void write_bit_array ( UChar* arr, UWord idx, UWord bit )
254{
255 UWord shift = idx & 7;
256 idx >>= 3;
257 bit &= 1;
258 arr[idx] = (arr[idx] & ~(1<<shift)) | (bit << shift);
259}
260
261static inline
262UWord read_bit_array ( UChar* arr, UWord idx )
263{
264 UWord shift = idx & 7;
265 idx >>= 3;
266 return 1 & (arr[idx] >> shift);
267}
njn5c004e42002-11-18 11:04:50 +0000268
269
sewardj45d94cc2005-04-20 14:44:11 +0000270#define VGM_BIT_VALID 0
271#define VGM_BIT_INVALID 1
njn5c004e42002-11-18 11:04:50 +0000272
sewardj45d94cc2005-04-20 14:44:11 +0000273#define VGM_NIBBLE_VALID 0
274#define VGM_NIBBLE_INVALID 0xF
njn5c004e42002-11-18 11:04:50 +0000275
sewardj45d94cc2005-04-20 14:44:11 +0000276#define VGM_BYTE_VALID 0
277#define VGM_BYTE_INVALID 0xFF
njn5c004e42002-11-18 11:04:50 +0000278
sewardj45d94cc2005-04-20 14:44:11 +0000279#define VGM_WORD32_VALID 0
280#define VGM_WORD32_INVALID 0xFFFFFFFF
njn5c004e42002-11-18 11:04:50 +0000281
sewardj45d94cc2005-04-20 14:44:11 +0000282#define VGM_WORD64_VALID 0ULL
283#define VGM_WORD64_INVALID 0xFFFFFFFFFFFFFFFFULL
284
njn5c004e42002-11-18 11:04:50 +0000285
286/*------------------------------------------------------------*/
287/*--- Command line options + defaults ---*/
288/*------------------------------------------------------------*/
289
njn43c799e2003-04-08 00:08:52 +0000290/* Memcheck defines a couple more. */
njn5c004e42002-11-18 11:04:50 +0000291
292/* Allow loads from partially-valid addresses? default: YES */
njn43c799e2003-04-08 00:08:52 +0000293extern Bool MAC_(clo_partial_loads_ok);
njn5c004e42002-11-18 11:04:50 +0000294
295/* Max volume of the freed blocks queue. */
njn43c799e2003-04-08 00:08:52 +0000296extern Int MAC_(clo_freelist_vol);
njn5c004e42002-11-18 11:04:50 +0000297
298/* Do leak check at exit? default: NO */
sewardjb5f6f512005-03-10 23:59:00 +0000299typedef
300 enum {
301 LC_Off,
302 LC_Summary,
303 LC_Full,
304 }
305 LeakCheckMode;
306
307extern LeakCheckMode MAC_(clo_leak_check);
njn5c004e42002-11-18 11:04:50 +0000308
309/* How closely should we compare ExeContexts in leak records? default: 2 */
njn43c799e2003-04-08 00:08:52 +0000310extern VgRes MAC_(clo_leak_resolution);
njn5c004e42002-11-18 11:04:50 +0000311
312/* In leak check, show reachable-but-not-freed blocks? default: NO */
njn43c799e2003-04-08 00:08:52 +0000313extern Bool MAC_(clo_show_reachable);
njn5c004e42002-11-18 11:04:50 +0000314
315/* Assume accesses immediately below %esp are due to gcc-2.96 bugs.
316 * default: NO*/
njn43c799e2003-04-08 00:08:52 +0000317extern Bool MAC_(clo_workaround_gcc296_bugs);
njn5c004e42002-11-18 11:04:50 +0000318
njn3e884182003-04-15 13:03:23 +0000319extern Bool MAC_(process_common_cmd_line_option) ( Char* arg );
320extern void MAC_(print_common_usage) ( void );
321extern void MAC_(print_common_debug_usage) ( void );
322
njn8a97c6d2005-03-31 04:37:24 +0000323/* We want a 16B redzone on heap blocks for Addrcheck and Memcheck */
njn51d827b2005-05-09 01:02:08 +0000324#define MAC_MALLOC_REDZONE_SZB 16
njn3e884182003-04-15 13:03:23 +0000325
326/*------------------------------------------------------------*/
327/*--- Variables ---*/
328/*------------------------------------------------------------*/
329
330/* For tracking malloc'd blocks */
331extern VgHashTable MAC_(malloc_list);
332
rjwalshbc0bb832004-06-19 18:12:36 +0000333/* For tracking memory pools. */
334extern VgHashTable MAC_(mempool_list);
335
nethercote7cc9c232004-01-21 15:08:04 +0000336/* Function pointers for the two tools to track interesting events. */
nethercote451eae92004-11-02 13:06:32 +0000337extern void (*MAC_(new_mem_heap)) ( Addr a, SizeT len, Bool is_inited );
338extern void (*MAC_(ban_mem_heap)) ( Addr a, SizeT len );
339extern void (*MAC_(die_mem_heap)) ( Addr a, SizeT len );
340extern void (*MAC_(copy_mem_heap))( Addr from, Addr to, SizeT len );
njn3e884182003-04-15 13:03:23 +0000341
sewardjecf8e102003-07-12 12:11:39 +0000342/* Function pointers for internal sanity checking. */
nethercote451eae92004-11-02 13:06:32 +0000343extern Bool (*MAC_(check_noaccess))( Addr a, SizeT len, Addr* bad_addr );
sewardjecf8e102003-07-12 12:11:39 +0000344
njn3e884182003-04-15 13:03:23 +0000345/* Used in describe_addr() */
346extern Bool (*MAC_(describe_addr_supp)) ( Addr a, AddrInfo* ai );
njn5c004e42002-11-18 11:04:50 +0000347
njn47363ab2003-04-21 13:24:40 +0000348/* For VALGRIND_COUNT_LEAKS client request */
njne8b5c052003-07-22 22:03:58 +0000349extern Int MAC_(bytes_leaked);
sewardjb5f6f512005-03-10 23:59:00 +0000350extern Int MAC_(bytes_indirect);
njne8b5c052003-07-22 22:03:58 +0000351extern Int MAC_(bytes_dubious);
352extern Int MAC_(bytes_reachable);
353extern Int MAC_(bytes_suppressed);
sewardj99aac972002-12-26 01:53:45 +0000354
njn5c004e42002-11-18 11:04:50 +0000355/*------------------------------------------------------------*/
356/*--- Functions ---*/
357/*------------------------------------------------------------*/
358
njn43c799e2003-04-08 00:08:52 +0000359extern void MAC_(pp_AddrInfo) ( Addr a, AddrInfo* ai );
njn5c004e42002-11-18 11:04:50 +0000360
njn43c799e2003-04-08 00:08:52 +0000361extern void MAC_(clear_MAC_Error) ( MAC_Error* err_extra );
njn5c004e42002-11-18 11:04:50 +0000362
njn51d827b2005-05-09 01:02:08 +0000363extern Bool MAC_(eq_Error) ( VgRes res, Error* e1, Error* e2 );
364extern UInt MAC_(update_extra)( Error* err );
365extern Bool MAC_(read_extra_suppression_info) ( Int fd, Char* buf, Int nBuf, Supp *su );
366extern Bool MAC_(error_matches_suppression)(Error* err, Supp* su);
367extern Char* MAC_(get_error_name) ( Error* err );
368extern void MAC_(print_extra_suppression_info) ( Error* err );
369
370extern Bool MAC_(shared_recognised_suppression) ( Char* name, Supp* su );
njn5c004e42002-11-18 11:04:50 +0000371
sewardj2a99cf62004-11-24 10:44:19 +0000372extern void* MAC_(new_block) ( ThreadId tid,
373 Addr p, SizeT size, SizeT align, UInt rzB,
nethercote57e36b32004-07-10 14:56:28 +0000374 Bool is_zeroed, MAC_AllocKind kind,
375 VgHashTable table);
sewardj2a99cf62004-11-24 10:44:19 +0000376
377extern void MAC_(handle_free) ( ThreadId tid,
378 Addr p, UInt rzB, MAC_AllocKind kind );
njn10785452003-05-20 16:38:24 +0000379
rjwalshbc0bb832004-06-19 18:12:36 +0000380extern void MAC_(create_mempool)(Addr pool, UInt rzB, Bool is_zeroed);
sewardj2a99cf62004-11-24 10:44:19 +0000381
rjwalshbc0bb832004-06-19 18:12:36 +0000382extern void MAC_(destroy_mempool)(Addr pool);
sewardj2a99cf62004-11-24 10:44:19 +0000383
384extern void MAC_(mempool_alloc)(ThreadId tid,
385 Addr pool, Addr addr, SizeT size);
386
rjwalshbc0bb832004-06-19 18:12:36 +0000387extern void MAC_(mempool_free)(Addr pool, Addr addr);
388
njn72718642003-07-24 08:45:32 +0000389extern void MAC_(record_address_error) ( ThreadId tid, Addr a,
sewardjaf48a602003-07-06 00:54:47 +0000390 Int size, Bool isWrite );
nethercote8b76fe52004-11-08 19:20:09 +0000391extern void MAC_(record_core_mem_error) ( ThreadId tid, Bool isUnaddr,
njn43c799e2003-04-08 00:08:52 +0000392 Char* s );
nethercote8b76fe52004-11-08 19:20:09 +0000393extern void MAC_(record_param_error) ( ThreadId tid, Addr a, Bool isReg,
394 Bool isUnaddr, Char* msg );
njn72718642003-07-24 08:45:32 +0000395extern void MAC_(record_jump_error) ( ThreadId tid, Addr a );
396extern void MAC_(record_free_error) ( ThreadId tid, Addr a );
397extern void MAC_(record_freemismatch_error)( ThreadId tid, Addr a );
sewardj2a99cf62004-11-24 10:44:19 +0000398extern void MAC_(record_overlap_error) ( ThreadId tid,
399 Char* function, OverlapExtra* oe );
rjwalshbc0bb832004-06-19 18:12:36 +0000400extern void MAC_(record_illegal_mempool_error) ( ThreadId tid, Addr pool );
njn5c004e42002-11-18 11:04:50 +0000401
njnb126f732004-11-22 17:57:07 +0000402extern void MAC_(pp_shared_Error) ( Error* err);
njn43c799e2003-04-08 00:08:52 +0000403
thughes4ad52d02004-06-27 17:37:21 +0000404extern MAC_Chunk* MAC_(first_matching_freed_MAC_Chunk)( Bool (*p)(MAC_Chunk*, void*), void* d );
njn43c799e2003-04-08 00:08:52 +0000405
njn3e884182003-04-15 13:03:23 +0000406extern void MAC_(common_pre_clo_init) ( void );
njnb8dca862005-03-14 02:42:44 +0000407extern void MAC_(common_fini) ( void (*leak_check)(ThreadId tid,
408 LeakCheckMode mode) );
njn3e884182003-04-15 13:03:23 +0000409
njn72718642003-07-24 08:45:32 +0000410extern Bool MAC_(handle_common_client_requests) ( ThreadId tid,
nethercoted1b64b22004-11-04 18:22:28 +0000411 UWord* arg_block, UWord* ret );
njn47363ab2003-04-21 13:24:40 +0000412
njn43c799e2003-04-08 00:08:52 +0000413/* For leak checking */
njn02977032005-05-17 04:00:11 +0000414extern void MAC_(pp_LeakError)(void* extra);
njn43c799e2003-04-08 00:08:52 +0000415
njn86f12dc2005-03-14 01:16:05 +0000416extern void MAC_(print_malloc_stats) ( void );
417
njn43c799e2003-04-08 00:08:52 +0000418extern void MAC_(do_detect_memory_leaks) (
njnb8dca862005-03-14 02:42:44 +0000419 ThreadId tid, LeakCheckMode mode,
sewardj05fe85e2005-04-27 22:46:36 +0000420 Bool (*is_within_valid_secondary) ( Addr ),
421 Bool (*is_valid_aligned_word) ( Addr )
njn43c799e2003-04-08 00:08:52 +0000422 );
423
njnaf839f52005-06-23 03:27:57 +0000424extern VG_REGPARM(1) void MAC_(new_mem_stack_4) ( Addr old_ESP );
425extern VG_REGPARM(1) void MAC_(die_mem_stack_4) ( Addr old_ESP );
426extern VG_REGPARM(1) void MAC_(new_mem_stack_8) ( Addr old_ESP );
427extern VG_REGPARM(1) void MAC_(die_mem_stack_8) ( Addr old_ESP );
428extern VG_REGPARM(1) void MAC_(new_mem_stack_12) ( Addr old_ESP );
429extern VG_REGPARM(1) void MAC_(die_mem_stack_12) ( Addr old_ESP );
430extern VG_REGPARM(1) void MAC_(new_mem_stack_16) ( Addr old_ESP );
431extern VG_REGPARM(1) void MAC_(die_mem_stack_16) ( Addr old_ESP );
432extern VG_REGPARM(1) void MAC_(new_mem_stack_32) ( Addr old_ESP );
433extern VG_REGPARM(1) void MAC_(die_mem_stack_32) ( Addr old_ESP );
434extern void MAC_(die_mem_stack) ( Addr a, SizeT len);
435extern void MAC_(new_mem_stack) ( Addr a, SizeT len);
njn9b007f62003-04-07 14:40:25 +0000436
njn51d827b2005-05-09 01:02:08 +0000437extern void* MAC_(malloc) ( ThreadId tid, SizeT n );
438extern void* MAC_(__builtin_new) ( ThreadId tid, SizeT n );
439extern void* MAC_(__builtin_vec_new) ( ThreadId tid, SizeT n );
440extern void* MAC_(memalign) ( ThreadId tid, SizeT align, SizeT n );
441extern void* MAC_(calloc) ( ThreadId tid, SizeT nmemb, SizeT size1 );
442extern void MAC_(free) ( ThreadId tid, void* p );
443extern void MAC_(__builtin_delete) ( ThreadId tid, void* p );
444extern void MAC_(__builtin_vec_delete) ( ThreadId tid, void* p );
445extern void* MAC_(realloc) ( ThreadId tid, void* p, SizeT new_size );
njn9b007f62003-04-07 14:40:25 +0000446
447/*------------------------------------------------------------*/
448/*--- Stack pointer adjustment ---*/
449/*------------------------------------------------------------*/
450
451/* Some noble preprocessor abuse, to enable Memcheck and Addrcheck to
njn3e884182003-04-15 13:03:23 +0000452 share this code, but call different functions.
njn9b007f62003-04-07 14:40:25 +0000453
454 Note that this code is executed very frequently and must be highly
455 optimised, which is why I resort to the preprocessor to achieve the
sewardj45d94cc2005-04-20 14:44:11 +0000456 factoring, rather than eg. using function pointers.
njn9b007f62003-04-07 14:40:25 +0000457*/
458
sewardj045a4052005-04-23 22:42:27 +0000459#define SP_UPDATE_HANDLERS(ALIGNED4_NEW, ALIGNED4_DIE, \
460 ALIGNED8_NEW, ALIGNED8_DIE, \
461 UNALIGNED_NEW, UNALIGNED_DIE) \
462 \
njnaf839f52005-06-23 03:27:57 +0000463void VG_REGPARM(1) MAC_(new_mem_stack_4)(Addr new_SP) \
sewardj045a4052005-04-23 22:42:27 +0000464{ \
465 PROF_EVENT(110, "new_mem_stack_4"); \
466 if (VG_IS_4_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000467 ALIGNED4_NEW ( -VG_STACK_REDZONE_SZB + new_SP ); \
sewardj045a4052005-04-23 22:42:27 +0000468 } else { \
njnaf839f52005-06-23 03:27:57 +0000469 UNALIGNED_NEW ( -VG_STACK_REDZONE_SZB + new_SP, 4 ); \
sewardj045a4052005-04-23 22:42:27 +0000470 } \
471} \
472 \
njnaf839f52005-06-23 03:27:57 +0000473void VG_REGPARM(1) MAC_(die_mem_stack_4)(Addr new_SP) \
sewardj045a4052005-04-23 22:42:27 +0000474{ \
475 PROF_EVENT(120, "die_mem_stack_4"); \
476 if (VG_IS_4_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000477 ALIGNED4_DIE ( -VG_STACK_REDZONE_SZB + new_SP-4 ); \
sewardj045a4052005-04-23 22:42:27 +0000478 } else { \
njnaf839f52005-06-23 03:27:57 +0000479 UNALIGNED_DIE ( -VG_STACK_REDZONE_SZB + new_SP-4, 4 ); \
sewardj045a4052005-04-23 22:42:27 +0000480 } \
481} \
482 \
njnaf839f52005-06-23 03:27:57 +0000483void VG_REGPARM(1) MAC_(new_mem_stack_8)(Addr new_SP) \
sewardj045a4052005-04-23 22:42:27 +0000484{ \
485 PROF_EVENT(111, "new_mem_stack_8"); \
486 if (VG_IS_8_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000487 ALIGNED8_NEW ( -VG_STACK_REDZONE_SZB + new_SP ); \
sewardj045a4052005-04-23 22:42:27 +0000488 } else if (VG_IS_4_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000489 ALIGNED4_NEW ( -VG_STACK_REDZONE_SZB + new_SP ); \
490 ALIGNED4_NEW ( -VG_STACK_REDZONE_SZB + new_SP+4 ); \
sewardj045a4052005-04-23 22:42:27 +0000491 } else { \
njnaf839f52005-06-23 03:27:57 +0000492 UNALIGNED_NEW ( -VG_STACK_REDZONE_SZB + new_SP, 8 ); \
sewardj045a4052005-04-23 22:42:27 +0000493 } \
494} \
495 \
njnaf839f52005-06-23 03:27:57 +0000496void VG_REGPARM(1) MAC_(die_mem_stack_8)(Addr new_SP) \
sewardj045a4052005-04-23 22:42:27 +0000497{ \
498 PROF_EVENT(121, "die_mem_stack_8"); \
499 if (VG_IS_8_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000500 ALIGNED8_DIE ( -VG_STACK_REDZONE_SZB + new_SP-8 ); \
sewardj045a4052005-04-23 22:42:27 +0000501 } else if (VG_IS_4_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000502 ALIGNED4_DIE ( -VG_STACK_REDZONE_SZB + new_SP-8 ); \
503 ALIGNED4_DIE ( -VG_STACK_REDZONE_SZB + new_SP-4 ); \
sewardj045a4052005-04-23 22:42:27 +0000504 } else { \
njnaf839f52005-06-23 03:27:57 +0000505 UNALIGNED_DIE ( -VG_STACK_REDZONE_SZB + new_SP-8, 8 ); \
sewardj045a4052005-04-23 22:42:27 +0000506 } \
507} \
508 \
njnaf839f52005-06-23 03:27:57 +0000509void VG_REGPARM(1) MAC_(new_mem_stack_12)(Addr new_SP) \
sewardj045a4052005-04-23 22:42:27 +0000510{ \
511 PROF_EVENT(112, "new_mem_stack_12"); \
512 if (VG_IS_8_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000513 ALIGNED8_NEW ( -VG_STACK_REDZONE_SZB + new_SP ); \
514 ALIGNED4_NEW ( -VG_STACK_REDZONE_SZB + new_SP+8 ); \
sewardj045a4052005-04-23 22:42:27 +0000515 } else if (VG_IS_4_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000516 ALIGNED4_NEW ( -VG_STACK_REDZONE_SZB + new_SP ); \
517 ALIGNED8_NEW ( -VG_STACK_REDZONE_SZB + new_SP+4 ); \
sewardj045a4052005-04-23 22:42:27 +0000518 } else { \
njnaf839f52005-06-23 03:27:57 +0000519 UNALIGNED_NEW ( -VG_STACK_REDZONE_SZB + new_SP, 12 ); \
sewardj045a4052005-04-23 22:42:27 +0000520 } \
521} \
522 \
njnaf839f52005-06-23 03:27:57 +0000523void VG_REGPARM(1) MAC_(die_mem_stack_12)(Addr new_SP) \
sewardj045a4052005-04-23 22:42:27 +0000524{ \
525 PROF_EVENT(122, "die_mem_stack_12"); \
526 /* Note the -12 in the test */ \
527 if (VG_IS_8_ALIGNED(new_SP-12)) { \
njnaf839f52005-06-23 03:27:57 +0000528 ALIGNED8_DIE ( -VG_STACK_REDZONE_SZB + new_SP-12 ); \
529 ALIGNED4_DIE ( -VG_STACK_REDZONE_SZB + new_SP-4 ); \
sewardj045a4052005-04-23 22:42:27 +0000530 } else if (VG_IS_4_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000531 ALIGNED4_DIE ( -VG_STACK_REDZONE_SZB + new_SP-12 ); \
532 ALIGNED8_DIE ( -VG_STACK_REDZONE_SZB + new_SP-8 ); \
sewardj045a4052005-04-23 22:42:27 +0000533 } else { \
njnaf839f52005-06-23 03:27:57 +0000534 UNALIGNED_DIE ( -VG_STACK_REDZONE_SZB + new_SP-12, 12 ); \
sewardj045a4052005-04-23 22:42:27 +0000535 } \
536} \
537 \
njnaf839f52005-06-23 03:27:57 +0000538void VG_REGPARM(1) MAC_(new_mem_stack_16)(Addr new_SP) \
sewardj045a4052005-04-23 22:42:27 +0000539{ \
540 PROF_EVENT(113, "new_mem_stack_16"); \
541 if (VG_IS_8_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000542 ALIGNED8_NEW ( -VG_STACK_REDZONE_SZB + new_SP ); \
543 ALIGNED8_NEW ( -VG_STACK_REDZONE_SZB + new_SP+8 ); \
sewardj045a4052005-04-23 22:42:27 +0000544 } else if (VG_IS_4_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000545 ALIGNED4_NEW ( -VG_STACK_REDZONE_SZB + new_SP ); \
546 ALIGNED8_NEW ( -VG_STACK_REDZONE_SZB + new_SP+4 ); \
547 ALIGNED4_NEW ( -VG_STACK_REDZONE_SZB + new_SP+12 ); \
sewardj045a4052005-04-23 22:42:27 +0000548 } else { \
njnaf839f52005-06-23 03:27:57 +0000549 UNALIGNED_NEW ( -VG_STACK_REDZONE_SZB + new_SP, 16 ); \
sewardj045a4052005-04-23 22:42:27 +0000550 } \
551} \
552 \
njnaf839f52005-06-23 03:27:57 +0000553void VG_REGPARM(1) MAC_(die_mem_stack_16)(Addr new_SP) \
sewardj045a4052005-04-23 22:42:27 +0000554{ \
555 PROF_EVENT(123, "die_mem_stack_16"); \
556 if (VG_IS_8_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000557 ALIGNED8_DIE ( -VG_STACK_REDZONE_SZB + new_SP-16 ); \
558 ALIGNED8_DIE ( -VG_STACK_REDZONE_SZB + new_SP-8 ); \
sewardj045a4052005-04-23 22:42:27 +0000559 } else if (VG_IS_4_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000560 ALIGNED4_DIE ( -VG_STACK_REDZONE_SZB + new_SP-16 ); \
561 ALIGNED8_DIE ( -VG_STACK_REDZONE_SZB + new_SP-12 ); \
562 ALIGNED4_DIE ( -VG_STACK_REDZONE_SZB + new_SP-4 ); \
sewardj045a4052005-04-23 22:42:27 +0000563 } else { \
njnaf839f52005-06-23 03:27:57 +0000564 UNALIGNED_DIE ( -VG_STACK_REDZONE_SZB + new_SP-16, 16 ); \
sewardj045a4052005-04-23 22:42:27 +0000565 } \
566} \
567 \
njnaf839f52005-06-23 03:27:57 +0000568void VG_REGPARM(1) MAC_(new_mem_stack_32)(Addr new_SP) \
sewardj045a4052005-04-23 22:42:27 +0000569{ \
570 PROF_EVENT(114, "new_mem_stack_32"); \
571 if (VG_IS_8_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000572 ALIGNED8_NEW ( -VG_STACK_REDZONE_SZB + new_SP ); \
573 ALIGNED8_NEW ( -VG_STACK_REDZONE_SZB + new_SP+8 ); \
574 ALIGNED8_NEW ( -VG_STACK_REDZONE_SZB + new_SP+16 ); \
575 ALIGNED8_NEW ( -VG_STACK_REDZONE_SZB + new_SP+24 ); \
sewardj045a4052005-04-23 22:42:27 +0000576 } else if (VG_IS_4_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000577 ALIGNED4_NEW ( -VG_STACK_REDZONE_SZB + new_SP ); \
578 ALIGNED8_NEW ( -VG_STACK_REDZONE_SZB + new_SP+4 ); \
579 ALIGNED8_NEW ( -VG_STACK_REDZONE_SZB + new_SP+12 ); \
580 ALIGNED8_NEW ( -VG_STACK_REDZONE_SZB + new_SP+20 ); \
581 ALIGNED4_NEW ( -VG_STACK_REDZONE_SZB + new_SP+28 ); \
sewardj045a4052005-04-23 22:42:27 +0000582 } else { \
njnaf839f52005-06-23 03:27:57 +0000583 UNALIGNED_NEW ( -VG_STACK_REDZONE_SZB + new_SP, 32 ); \
sewardj045a4052005-04-23 22:42:27 +0000584 } \
585} \
586 \
njnaf839f52005-06-23 03:27:57 +0000587void VG_REGPARM(1) MAC_(die_mem_stack_32)(Addr new_SP) \
sewardj045a4052005-04-23 22:42:27 +0000588{ \
589 PROF_EVENT(124, "die_mem_stack_32"); \
590 if (VG_IS_8_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000591 ALIGNED8_DIE ( -VG_STACK_REDZONE_SZB + new_SP-32 ); \
592 ALIGNED8_DIE ( -VG_STACK_REDZONE_SZB + new_SP-24 ); \
593 ALIGNED8_DIE ( -VG_STACK_REDZONE_SZB + new_SP-16 ); \
594 ALIGNED8_DIE ( -VG_STACK_REDZONE_SZB + new_SP- 8 ); \
sewardj045a4052005-04-23 22:42:27 +0000595 } else if (VG_IS_4_ALIGNED(new_SP)) { \
njnaf839f52005-06-23 03:27:57 +0000596 ALIGNED4_DIE ( -VG_STACK_REDZONE_SZB + new_SP-32 ); \
597 ALIGNED8_DIE ( -VG_STACK_REDZONE_SZB + new_SP-28 ); \
598 ALIGNED8_DIE ( -VG_STACK_REDZONE_SZB + new_SP-20 ); \
599 ALIGNED8_DIE ( -VG_STACK_REDZONE_SZB + new_SP-12 ); \
600 ALIGNED4_DIE ( -VG_STACK_REDZONE_SZB + new_SP-4 ); \
sewardj045a4052005-04-23 22:42:27 +0000601 } else { \
njnaf839f52005-06-23 03:27:57 +0000602 UNALIGNED_DIE ( -VG_STACK_REDZONE_SZB + new_SP-32, 32 ); \
sewardj045a4052005-04-23 22:42:27 +0000603 } \
604} \
605 \
606void MAC_(new_mem_stack) ( Addr a, SizeT len ) \
607{ \
608 PROF_EVENT(115, "new_mem_stack"); \
njnaf839f52005-06-23 03:27:57 +0000609 UNALIGNED_NEW ( -VG_STACK_REDZONE_SZB + a, len ); \
sewardj045a4052005-04-23 22:42:27 +0000610} \
611 \
612void MAC_(die_mem_stack) ( Addr a, SizeT len ) \
613{ \
614 PROF_EVENT(125, "die_mem_stack"); \
njnaf839f52005-06-23 03:27:57 +0000615 UNALIGNED_DIE ( -VG_STACK_REDZONE_SZB + a, len ); \
njn9b007f62003-04-07 14:40:25 +0000616}
617
njn43c799e2003-04-08 00:08:52 +0000618#endif /* __MAC_SHARED_H */
njn5c004e42002-11-18 11:04:50 +0000619
620/*--------------------------------------------------------------------*/
njnc7561b92005-06-19 01:24:32 +0000621/*--- end ---*/
njn5c004e42002-11-18 11:04:50 +0000622/*--------------------------------------------------------------------*/