285 lines
7.2 KiB
C
285 lines
7.2 KiB
C
/* More debugging hooks for `malloc'.
|
|
Copyright (C) 1991, 92, 93, 94, 96, 97, 98 Free Software Foundation, Inc.
|
|
Written April 2, 1991 by John Gilmore of Cygnus Support.
|
|
Based on mcheck.c by Mike Haertel.
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Library General Public License as
|
|
published by the Free Software Foundation; either version 2 of the
|
|
License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public
|
|
License along with this library; see the file COPYING.LIB. If not,
|
|
write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
Boston, MA 02111-1307, USA.
|
|
|
|
The author may be reached (Email) at the address mike@ai.mit.edu,
|
|
or (US mail) as Mike Haertel c/o Free Software Foundation. */
|
|
|
|
#ifndef _MALLOC_INTERNAL
|
|
#define _MALLOC_INTERNAL
|
|
#include <malloc.h>
|
|
#include <mcheck.h>
|
|
#include <bits/libc-lock.h>
|
|
#endif
|
|
|
|
#ifdef HAVE_ELF
|
|
#include <elf/ldsodefs.h>
|
|
#endif
|
|
|
|
#include <stdio.h>
|
|
|
|
#ifndef __GNU_LIBRARY__
|
|
extern char *getenv ();
|
|
#else
|
|
#include <stdlib.h>
|
|
#endif
|
|
|
|
#if defined _LIBC && defined USE_IN_LIBIO
|
|
# include <libio/iolibio.h>
|
|
# define setvbuf(s, b, f, l) _IO_setvbuf (s, b, f, l)
|
|
#endif
|
|
|
|
#define TRACE_BUFFER_SIZE 512
|
|
|
|
static FILE *mallstream;
|
|
static const char mallenv[]= "MALLOC_TRACE";
|
|
static char malloc_trace_buffer[TRACE_BUFFER_SIZE];
|
|
|
|
__libc_lock_define_initialized (static, lock);
|
|
|
|
/* Address to breakpoint on accesses to... */
|
|
__ptr_t mallwatch;
|
|
|
|
/* File name and line number information, for callers that had
|
|
the foresight to call through a macro. */
|
|
char *_mtrace_file;
|
|
int _mtrace_line;
|
|
|
|
/* Old hook values. */
|
|
static void (*tr_old_free_hook) __P ((__ptr_t ptr, const __ptr_t));
|
|
static __ptr_t (*tr_old_malloc_hook) __P ((__malloc_size_t size,
|
|
const __ptr_t));
|
|
static __ptr_t (*tr_old_realloc_hook) __P ((__ptr_t ptr,
|
|
__malloc_size_t size,
|
|
const __ptr_t));
|
|
|
|
/* This function is called when the block being alloc'd, realloc'd, or
|
|
freed has an address matching the variable "mallwatch". In a debugger,
|
|
set "mallwatch" to the address of interest, then put a breakpoint on
|
|
tr_break. */
|
|
|
|
void tr_break __P ((void));
|
|
void
|
|
tr_break ()
|
|
{
|
|
}
|
|
|
|
static void tr_where __P ((const __ptr_t)) internal_function;
|
|
static void
|
|
internal_function
|
|
tr_where (caller)
|
|
const __ptr_t caller;
|
|
{
|
|
if (_mtrace_file)
|
|
{
|
|
fprintf (mallstream, "@ %s:%d ", _mtrace_file, _mtrace_line);
|
|
_mtrace_file = NULL;
|
|
}
|
|
else if (caller != NULL)
|
|
{
|
|
#ifdef HAVE_ELF
|
|
Dl_info info;
|
|
if (_dl_addr (caller, &info))
|
|
{
|
|
fprintf (mallstream, "@ %s%s%s%s%s[%p]",
|
|
info.dli_fname ?: "", info.dli_fname ? ":" : "",
|
|
info.dli_sname ? "(" : "",
|
|
info.dli_sname ?: "", info.dli_sname ? ") " : " ",
|
|
caller);
|
|
}
|
|
else
|
|
#endif
|
|
fprintf (mallstream, "@ [%p] ", caller);
|
|
}
|
|
}
|
|
|
|
static void tr_freehook __P ((__ptr_t, const __ptr_t));
|
|
static void
|
|
tr_freehook (ptr, caller)
|
|
__ptr_t ptr;
|
|
const __ptr_t caller;
|
|
{
|
|
tr_where (caller);
|
|
/* Be sure to print it first. */
|
|
fprintf (mallstream, "- %p\n", ptr);
|
|
if (ptr == mallwatch)
|
|
tr_break ();
|
|
__libc_lock_lock (lock);
|
|
__free_hook = tr_old_free_hook;
|
|
if (tr_old_free_hook != NULL)
|
|
(*tr_old_free_hook) (ptr, caller);
|
|
else
|
|
free (ptr);
|
|
__free_hook = tr_freehook;
|
|
__libc_lock_unlock (lock);
|
|
}
|
|
|
|
static __ptr_t tr_mallochook __P ((__malloc_size_t, const __ptr_t));
|
|
static __ptr_t
|
|
tr_mallochook (size, caller)
|
|
__malloc_size_t size;
|
|
const __ptr_t caller;
|
|
{
|
|
__ptr_t hdr;
|
|
|
|
__libc_lock_lock (lock);
|
|
|
|
__malloc_hook = tr_old_malloc_hook;
|
|
if (tr_old_malloc_hook != NULL)
|
|
hdr = (__ptr_t) (*tr_old_malloc_hook) (size, caller);
|
|
else
|
|
hdr = (__ptr_t) malloc (size);
|
|
__malloc_hook = tr_mallochook;
|
|
|
|
__libc_lock_unlock (lock);
|
|
|
|
tr_where (caller);
|
|
/* We could be printing a NULL here; that's OK. */
|
|
fprintf (mallstream, "+ %p %#lx\n", hdr, (unsigned long int) size);
|
|
|
|
if (hdr == mallwatch)
|
|
tr_break ();
|
|
|
|
return hdr;
|
|
}
|
|
|
|
static __ptr_t tr_reallochook __P ((__ptr_t, __malloc_size_t, const __ptr_t));
|
|
static __ptr_t
|
|
tr_reallochook (ptr, size, caller)
|
|
__ptr_t ptr;
|
|
__malloc_size_t size;
|
|
const __ptr_t caller;
|
|
{
|
|
__ptr_t hdr;
|
|
|
|
if (ptr == mallwatch)
|
|
tr_break ();
|
|
|
|
__libc_lock_lock (lock);
|
|
|
|
__free_hook = tr_old_free_hook;
|
|
__malloc_hook = tr_old_malloc_hook;
|
|
__realloc_hook = tr_old_realloc_hook;
|
|
if (tr_old_realloc_hook != NULL)
|
|
hdr = (__ptr_t) (*tr_old_realloc_hook) (ptr, size, caller);
|
|
else
|
|
hdr = (__ptr_t) realloc (ptr, size);
|
|
__free_hook = tr_freehook;
|
|
__malloc_hook = tr_mallochook;
|
|
__realloc_hook = tr_reallochook;
|
|
|
|
__libc_lock_unlock (lock);
|
|
|
|
tr_where (caller);
|
|
if (hdr == NULL)
|
|
/* Failed realloc. */
|
|
fprintf (mallstream, "! %p %#lx\n", ptr, (unsigned long int) size);
|
|
else if (ptr == NULL)
|
|
fprintf (mallstream, "+ %p %#lx\n", hdr, (unsigned long int) size);
|
|
else
|
|
fprintf (mallstream, "< %p\n> %p %#lx\n", ptr, hdr,
|
|
(unsigned long int) size);
|
|
|
|
if (hdr == mallwatch)
|
|
tr_break ();
|
|
|
|
return hdr;
|
|
}
|
|
|
|
|
|
#ifdef _LIBC
|
|
extern void __libc_freeres (void);
|
|
|
|
/* This function gets called to make sure all memory the library
|
|
allocates get freed and so does not irritate the user when studying
|
|
the mtrace output. */
|
|
static void
|
|
release_libc_mem (void)
|
|
{
|
|
/* Only call the free function if we still are running in mtrace mode. */
|
|
if (mallstream != NULL)
|
|
__libc_freeres ();
|
|
}
|
|
#endif
|
|
|
|
|
|
/* We enable tracing if either the environment variable MALLOC_TRACE
|
|
is set, or if the variable mallwatch has been patched to an address
|
|
that the debugging user wants us to stop on. When patching mallwatch,
|
|
don't forget to set a breakpoint on tr_break! */
|
|
|
|
void
|
|
mtrace ()
|
|
{
|
|
#ifdef _LIBC
|
|
static int added_atexit_handler = 0;
|
|
#endif
|
|
char *mallfile;
|
|
|
|
/* Don't panic if we're called more than once. */
|
|
if (mallstream != NULL)
|
|
return;
|
|
|
|
#ifdef _LIBC
|
|
/* When compiling the GNU libc we use the secure getenv function
|
|
which prevents the misuse in case of SUID or SGID enabled
|
|
programs. */
|
|
mallfile = __secure_getenv (mallenv);
|
|
#else
|
|
mallfile = getenv (mallenv);
|
|
#endif
|
|
if (mallfile != NULL || mallwatch != NULL)
|
|
{
|
|
mallstream = fopen (mallfile != NULL ? mallfile : "/dev/null", "w");
|
|
if (mallstream != NULL)
|
|
{
|
|
/* Be sure it doesn't malloc its buffer! */
|
|
setvbuf (mallstream, malloc_trace_buffer, _IOFBF, TRACE_BUFFER_SIZE);
|
|
fprintf (mallstream, "= Start\n");
|
|
tr_old_free_hook = __free_hook;
|
|
__free_hook = tr_freehook;
|
|
tr_old_malloc_hook = __malloc_hook;
|
|
__malloc_hook = tr_mallochook;
|
|
tr_old_realloc_hook = __realloc_hook;
|
|
__realloc_hook = tr_reallochook;
|
|
#ifdef _LIBC
|
|
if (!added_atexit_handler)
|
|
{
|
|
added_atexit_handler = 1;
|
|
atexit (release_libc_mem);
|
|
}
|
|
#endif
|
|
}
|
|
}
|
|
}
|
|
|
|
void
|
|
muntrace ()
|
|
{
|
|
if (mallstream == NULL)
|
|
return;
|
|
|
|
fprintf (mallstream, "= End\n");
|
|
fclose (mallstream);
|
|
mallstream = NULL;
|
|
__free_hook = tr_old_free_hook;
|
|
__malloc_hook = tr_old_malloc_hook;
|
|
__realloc_hook = tr_old_realloc_hook;
|
|
}
|