Implement pedantic checking of all allocated blocks whenever a
[kopensolaris-gnu/glibc.git] / malloc / mcheck.c
1 /* Standard debugging hooks for `malloc'.
2    Copyright (C) 1990-1997, 1999, 2000 Free Software Foundation, Inc.
3    Written May 1989 by Mike Haertel.
4
5    This library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Library General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    This library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Library General Public License for more details.
14
15    You should have received a copy of the GNU Library General Public
16    License along with this library; see the file COPYING.LIB.  If not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 02111-1307, USA.
19
20    The author may be reached (Email) at the address mike@ai.mit.edu,
21    or (US mail) as Mike Haertel c/o Free Software Foundation.  */
22
23 #ifndef _MALLOC_INTERNAL
24 # define _MALLOC_INTERNAL
25 # include <malloc.h>
26 # include <mcheck.h>
27 # include <stdint.h>
28 # include <stdio.h>
29 # include <libintl.h>
30 #endif
31
32 /* Old hook values.  */
33 static void (*old_free_hook) __P ((__ptr_t ptr, __const __ptr_t));
34 static __ptr_t (*old_malloc_hook) __P ((__malloc_size_t size, const __ptr_t));
35 static __ptr_t (*old_realloc_hook) __P ((__ptr_t ptr, __malloc_size_t size,
36                                          __const __ptr_t));
37
38 /* Function to call when something awful happens.  */
39 static void (*abortfunc) __P ((enum mcheck_status));
40
41 /* Arbitrary magical numbers.  */
42 #define MAGICWORD       0xfedabeeb
43 #define MAGICFREE       0xd8675309
44 #define MAGICBYTE       ((char) 0xd7)
45 #define MALLOCFLOOD     ((char) 0x93)
46 #define FREEFLOOD       ((char) 0x95)
47
48 struct hdr
49   {
50     __malloc_size_t size;       /* Exact size requested by user.  */
51     unsigned long int magic;    /* Magic number to check header integrity.  */
52     struct hdr *prev;
53     struct hdr *next;
54   };
55
56 /* This is the beginning of the list of all memory blocks allocated.
57    It is only constructed if the pedantic testing is requested.  */
58 static struct hdr *root;
59
60 /* Nonzero if pedentic checking of all blocks is requested.  */
61 static int pedantic;
62
63 #if defined _LIBC || defined STDC_HEADERS || defined USG
64 # include <string.h>
65 # define flood memset
66 #else
67 static void flood __P ((__ptr_t, int, __malloc_size_t));
68 static void
69 flood (ptr, val, size)
70      __ptr_t ptr;
71      int val;
72      __malloc_size_t size;
73 {
74   char *cp = ptr;
75   while (size--)
76     *cp++ = val;
77 }
78 #endif
79
80 static enum mcheck_status checkhdr __P ((const struct hdr *));
81 static enum mcheck_status
82 checkhdr (hdr)
83      const struct hdr *hdr;
84 {
85   enum mcheck_status status;
86   switch (hdr->magic ^ ((uintptr_t) hdr->prev + (uintptr_t) hdr->next))
87     {
88     default:
89       status = MCHECK_HEAD;
90       break;
91     case MAGICFREE:
92       status = MCHECK_FREE;
93       break;
94     case MAGICWORD:
95       if (((char *) &hdr[1])[hdr->size] != MAGICBYTE)
96         status = MCHECK_TAIL;
97       else
98         status = MCHECK_OK;
99       break;
100     }
101   if (status != MCHECK_OK)
102     (*abortfunc) (status);
103   return status;
104 }
105
106 static void check_all __P ((void));
107 static void
108 check_all ()
109 {
110   /* Walk through all the active blocks and test whether they were tempered
111      with.  */
112   struct hdr *runp = root;
113
114   while (runp != NULL)
115     {
116       (void) checkhdr (runp);
117
118       runp = runp->next;
119     }
120 }
121
122 static void unlink_blk __P ((struct hdr *ptr));
123 static void
124 unlink_blk (ptr)
125      struct hdr *ptr;
126 {
127   if (ptr->next != NULL)
128     {
129       ptr->next->prev = ptr->prev;
130       ptr->next->magic = MAGICWORD ^ ((uintptr_t) ptr->next->prev
131                                       + (uintptr_t) ptr->next->next);
132     }
133   if (ptr->prev != NULL)
134     {
135       ptr->prev->next = ptr->next;
136       ptr->prev->magic = MAGICWORD ^ ((uintptr_t) ptr->prev->prev
137                                       + (uintptr_t) ptr->prev->next);
138     }
139   else
140     root = ptr->next;
141 }
142
143 static void link_blk  __P ((struct hdr *ptr));
144 static void
145 link_blk (hdr)
146      struct hdr *hdr;
147 {
148   hdr->prev = NULL;
149   hdr->next = root;
150   root = hdr;
151   hdr->magic = MAGICWORD ^ (uintptr_t) hdr->next;
152
153   /* And the next block.  */
154   if (hdr->next != NULL)
155     {
156       hdr->next->prev = hdr;
157       hdr->next->magic = MAGICWORD ^ ((uintptr_t) hdr
158                                       + (uintptr_t) hdr->next->next);
159     }
160 }
161
162 static void freehook __P ((__ptr_t, const __ptr_t));
163 static void
164 freehook (ptr, caller)
165      __ptr_t ptr;
166      const __ptr_t caller;
167 {
168   if (pedantic)
169     check_all ();
170   if (ptr)
171     {
172       struct hdr *hdr = ((struct hdr *) ptr) - 1;
173       checkhdr (hdr);
174       hdr->magic = MAGICFREE;
175       unlink_blk (hdr);
176       hdr->prev = hdr->next = NULL;
177       flood (ptr, FREEFLOOD, hdr->size);
178       ptr = (__ptr_t) hdr;
179     }
180   __free_hook = old_free_hook;
181   if (old_free_hook != NULL)
182     (*old_free_hook) (ptr, caller);
183   else
184     free (ptr);
185   __free_hook = freehook;
186 }
187
188 static __ptr_t mallochook __P ((__malloc_size_t, const __ptr_t));
189 static __ptr_t
190 mallochook (size, caller)
191      __malloc_size_t size;
192      const __ptr_t caller;
193 {
194   struct hdr *hdr;
195
196   if (pedantic)
197     check_all ();
198
199   __malloc_hook = old_malloc_hook;
200   if (old_malloc_hook != NULL)
201     hdr = (struct hdr *) (*old_malloc_hook) (sizeof (struct hdr) + size + 1,
202                                              caller);
203   else
204     hdr = (struct hdr *) malloc (sizeof (struct hdr) + size + 1);
205   __malloc_hook = mallochook;
206   if (hdr == NULL)
207     return NULL;
208
209   hdr->size = size;
210   link_blk (hdr);
211   ((char *) &hdr[1])[size] = MAGICBYTE;
212   flood ((__ptr_t) (hdr + 1), MALLOCFLOOD, size);
213   return (__ptr_t) (hdr + 1);
214 }
215
216 static __ptr_t reallochook __P ((__ptr_t, __malloc_size_t, const __ptr_t));
217 static __ptr_t
218 reallochook (ptr, size, caller)
219      __ptr_t ptr;
220      __malloc_size_t size;
221      const __ptr_t caller;
222 {
223   struct hdr *hdr;
224   __malloc_size_t osize;
225
226   if (pedantic)
227     check_all ();
228
229   if (ptr)
230     {
231       hdr = ((struct hdr *) ptr) - 1;
232       osize = hdr->size;
233
234       checkhdr (hdr);
235       unlink_blk (hdr);
236       if (size < osize)
237         flood ((char *) ptr + size, FREEFLOOD, osize - size);
238     }
239   else
240     {
241       osize = 0;
242       hdr = NULL;
243     }
244   __free_hook = old_free_hook;
245   __malloc_hook = old_malloc_hook;
246   __realloc_hook = old_realloc_hook;
247   if (old_realloc_hook != NULL)
248     hdr = (struct hdr *) (*old_realloc_hook) ((__ptr_t) hdr,
249                                               sizeof (struct hdr) + size + 1,
250                                               caller);
251   else
252     hdr = (struct hdr *) realloc ((__ptr_t) hdr,
253                                   sizeof (struct hdr) + size + 1);
254   __free_hook = freehook;
255   __malloc_hook = mallochook;
256   __realloc_hook = reallochook;
257   if (hdr == NULL)
258     return NULL;
259
260   hdr->size = size;
261   link_blk (hdr);
262   ((char *) &hdr[1])[size] = MAGICBYTE;
263   if (size > osize)
264     flood ((char *) (hdr + 1) + osize, MALLOCFLOOD, size - osize);
265   return (__ptr_t) (hdr + 1);
266 }
267
268 static void mabort __P ((enum mcheck_status status));
269 static void
270 mabort (status)
271      enum mcheck_status status;
272 {
273   const char *msg;
274   switch (status)
275     {
276     case MCHECK_OK:
277       msg = _("memory is consistent, library is buggy\n");
278       break;
279     case MCHECK_HEAD:
280       msg = _("memory clobbered before allocated block\n");
281       break;
282     case MCHECK_TAIL:
283       msg = _("memory clobbered past end of allocated block\n");
284       break;
285     case MCHECK_FREE:
286       msg = _("block freed twice\n");
287       break;
288     default:
289       msg = _("bogus mcheck_status, library is buggy\n");
290       break;
291     }
292 #ifdef _LIBC
293   __libc_fatal (msg);
294 #else
295   fprintf (stderr, "mcheck: %s", msg);
296   fflush (stderr);
297   abort ();
298 #endif
299 }
300
301 static int mcheck_used;
302
303 int
304 mcheck (func)
305      void (*func) __P ((enum mcheck_status));
306 {
307   abortfunc = (func != NULL) ? func : &mabort;
308
309   /* These hooks may not be safely inserted if malloc is already in use.  */
310   if (__malloc_initialized <= 0 && !mcheck_used)
311     {
312       old_free_hook = __free_hook;
313       __free_hook = freehook;
314       old_malloc_hook = __malloc_hook;
315       __malloc_hook = mallochook;
316       old_realloc_hook = __realloc_hook;
317       __realloc_hook = reallochook;
318       mcheck_used = 1;
319     }
320
321   return mcheck_used ? 0 : -1;
322 }
323
324 int
325 mcheck_pedantic (func)
326       void (*func) __P ((enum mcheck_status));
327 {
328   pedantic = 1;
329   return mcheck (func);
330 }
331
332 enum mcheck_status
333 mprobe (__ptr_t ptr)
334 {
335   return mcheck_used ? checkhdr (((struct hdr *) ptr) - 1) : MCHECK_DISABLED;
336 }