(check_all): Turn off pedantic flag for the time of check to avoid recursion.
[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   /* Temporarily turn off the checks.  */
115   pedantic = 0;
116
117   while (runp != NULL)
118     {
119       (void) checkhdr (runp);
120
121       runp = runp->next;
122     }
123
124   /* Turn checks on again.  */
125   pedantic = 1;
126 }
127
128 static void unlink_blk __P ((struct hdr *ptr));
129 static void
130 unlink_blk (ptr)
131      struct hdr *ptr;
132 {
133   if (ptr->next != NULL)
134     {
135       ptr->next->prev = ptr->prev;
136       ptr->next->magic = MAGICWORD ^ ((uintptr_t) ptr->next->prev
137                                       + (uintptr_t) ptr->next->next);
138     }
139   if (ptr->prev != NULL)
140     {
141       ptr->prev->next = ptr->next;
142       ptr->prev->magic = MAGICWORD ^ ((uintptr_t) ptr->prev->prev
143                                       + (uintptr_t) ptr->prev->next);
144     }
145   else
146     root = ptr->next;
147 }
148
149 static void link_blk  __P ((struct hdr *ptr));
150 static void
151 link_blk (hdr)
152      struct hdr *hdr;
153 {
154   hdr->prev = NULL;
155   hdr->next = root;
156   root = hdr;
157   hdr->magic = MAGICWORD ^ (uintptr_t) hdr->next;
158
159   /* And the next block.  */
160   if (hdr->next != NULL)
161     {
162       hdr->next->prev = hdr;
163       hdr->next->magic = MAGICWORD ^ ((uintptr_t) hdr
164                                       + (uintptr_t) hdr->next->next);
165     }
166 }
167
168 static void freehook __P ((__ptr_t, const __ptr_t));
169 static void
170 freehook (ptr, caller)
171      __ptr_t ptr;
172      const __ptr_t caller;
173 {
174   if (pedantic)
175     check_all ();
176   if (ptr)
177     {
178       struct hdr *hdr = ((struct hdr *) ptr) - 1;
179       checkhdr (hdr);
180       hdr->magic = MAGICFREE;
181       unlink_blk (hdr);
182       hdr->prev = hdr->next = NULL;
183       flood (ptr, FREEFLOOD, hdr->size);
184       ptr = (__ptr_t) hdr;
185     }
186   __free_hook = old_free_hook;
187   if (old_free_hook != NULL)
188     (*old_free_hook) (ptr, caller);
189   else
190     free (ptr);
191   __free_hook = freehook;
192 }
193
194 static __ptr_t mallochook __P ((__malloc_size_t, const __ptr_t));
195 static __ptr_t
196 mallochook (size, caller)
197      __malloc_size_t size;
198      const __ptr_t caller;
199 {
200   struct hdr *hdr;
201
202   if (pedantic)
203     check_all ();
204
205   __malloc_hook = old_malloc_hook;
206   if (old_malloc_hook != NULL)
207     hdr = (struct hdr *) (*old_malloc_hook) (sizeof (struct hdr) + size + 1,
208                                              caller);
209   else
210     hdr = (struct hdr *) malloc (sizeof (struct hdr) + size + 1);
211   __malloc_hook = mallochook;
212   if (hdr == NULL)
213     return NULL;
214
215   hdr->size = size;
216   link_blk (hdr);
217   ((char *) &hdr[1])[size] = MAGICBYTE;
218   flood ((__ptr_t) (hdr + 1), MALLOCFLOOD, size);
219   return (__ptr_t) (hdr + 1);
220 }
221
222 static __ptr_t reallochook __P ((__ptr_t, __malloc_size_t, const __ptr_t));
223 static __ptr_t
224 reallochook (ptr, size, caller)
225      __ptr_t ptr;
226      __malloc_size_t size;
227      const __ptr_t caller;
228 {
229   struct hdr *hdr;
230   __malloc_size_t osize;
231
232   if (pedantic)
233     check_all ();
234
235   if (ptr)
236     {
237       hdr = ((struct hdr *) ptr) - 1;
238       osize = hdr->size;
239
240       checkhdr (hdr);
241       unlink_blk (hdr);
242       if (size < osize)
243         flood ((char *) ptr + size, FREEFLOOD, osize - size);
244     }
245   else
246     {
247       osize = 0;
248       hdr = NULL;
249     }
250   __free_hook = old_free_hook;
251   __malloc_hook = old_malloc_hook;
252   __realloc_hook = old_realloc_hook;
253   if (old_realloc_hook != NULL)
254     hdr = (struct hdr *) (*old_realloc_hook) ((__ptr_t) hdr,
255                                               sizeof (struct hdr) + size + 1,
256                                               caller);
257   else
258     hdr = (struct hdr *) realloc ((__ptr_t) hdr,
259                                   sizeof (struct hdr) + size + 1);
260   __free_hook = freehook;
261   __malloc_hook = mallochook;
262   __realloc_hook = reallochook;
263   if (hdr == NULL)
264     return NULL;
265
266   hdr->size = size;
267   link_blk (hdr);
268   ((char *) &hdr[1])[size] = MAGICBYTE;
269   if (size > osize)
270     flood ((char *) (hdr + 1) + osize, MALLOCFLOOD, size - osize);
271   return (__ptr_t) (hdr + 1);
272 }
273
274 static void mabort __P ((enum mcheck_status status));
275 static void
276 mabort (status)
277      enum mcheck_status status;
278 {
279   const char *msg;
280   switch (status)
281     {
282     case MCHECK_OK:
283       msg = _("memory is consistent, library is buggy\n");
284       break;
285     case MCHECK_HEAD:
286       msg = _("memory clobbered before allocated block\n");
287       break;
288     case MCHECK_TAIL:
289       msg = _("memory clobbered past end of allocated block\n");
290       break;
291     case MCHECK_FREE:
292       msg = _("block freed twice\n");
293       break;
294     default:
295       msg = _("bogus mcheck_status, library is buggy\n");
296       break;
297     }
298 #ifdef _LIBC
299   __libc_fatal (msg);
300 #else
301   fprintf (stderr, "mcheck: %s", msg);
302   fflush (stderr);
303   abort ();
304 #endif
305 }
306
307 static int mcheck_used;
308
309 int
310 mcheck (func)
311      void (*func) __P ((enum mcheck_status));
312 {
313   abortfunc = (func != NULL) ? func : &mabort;
314
315   /* These hooks may not be safely inserted if malloc is already in use.  */
316   if (__malloc_initialized <= 0 && !mcheck_used)
317     {
318       old_free_hook = __free_hook;
319       __free_hook = freehook;
320       old_malloc_hook = __malloc_hook;
321       __malloc_hook = mallochook;
322       old_realloc_hook = __realloc_hook;
323       __realloc_hook = reallochook;
324       mcheck_used = 1;
325     }
326
327   return mcheck_used ? 0 : -1;
328 }
329
330 int
331 mcheck_pedantic (func)
332       void (*func) __P ((enum mcheck_status));
333 {
334   pedantic = 1;
335   return mcheck (func);
336 }
337
338 enum mcheck_status
339 mprobe (__ptr_t ptr)
340 {
341   return mcheck_used ? checkhdr (((struct hdr *) ptr) - 1) : MCHECK_DISABLED;
342 }