p_debug_mem.c File Reference

Memory debugging. More...

Include dependency graph for p_debug_mem.c:

Go to the source code of this file.

Data Structures
struct	debug_memory_header
struct	debug_memory_footer
Defines
#define	DEBUG_MEMORY_MAGIC   0x6e34090aU
#define	real_malloc(_size)   malloc(_size)
#define	real_free(_ptr)   free(_ptr)
Functions
static struct debug_memory_header *	header_from_data (void *data)
static void *	data_from_header (struct debug_memory_header *hdr)
static struct debug_memory_footer *	footer_from_header (struct debug_memory_header *hdr)
void *	debug_malloc (const char *file, unsigned line, const char *function, size_t size)
void	debug_free (const char *file, unsigned line, const char *function, void *ptr)
void *	debug_calloc (const char *file, unsigned line, const char *function, size_t count, size_t size)
void *	debug_realloc (const char *file, unsigned line, const char *function, void *old_ptr, size_t old_size, size_t new_size)
unsigned long	debug_memory_begin (void)
void	debug_memory_end (unsigned long start_no)
Variables
static struct list_head	list = { &list, &list }
static unsigned long	last_no = 0

---

Detailed Description

Memory debugging.

Author:

José Fonseca <jrfonseca@tungstengraphics.com>

Definition in file p_debug_mem.c.

---

Define Documentation

#define DEBUG_MEMORY_MAGIC   0x6e34090aU

Definition at line 51 of file p_debug_mem.c.

#define real_free

(

_ptr

)

free(_ptr)

Definition at line 62 of file p_debug_mem.c.

#define real_malloc

(

_size

)

malloc(_size)

Definition at line 61 of file p_debug_mem.c.

---

Function Documentation

static void* data_from_header

(

struct debug_memory_header *

hdr

)

[static]

Definition at line 99 of file p_debug_mem.c.

{
   if(hdr)
      return (void *)((char *)hdr + sizeof(struct debug_memory_header));
   else
      return NULL;
}

void* debug_calloc	(	const char *	file,
		unsigned	line,
		const char *	function,
		size_t	count,
		size_t	size
	)

Definition at line 184 of file p_debug_mem.c.

References debug_malloc().

{
   void *ptr = debug_malloc( file, line, function, count * size );
   if( ptr )
      memset( ptr, 0, count * size );
   return ptr;
}

void debug_free	(	const char *	file,
		unsigned	line,
		const char *	function,
		void *	ptr
	)

Definition at line 150 of file p_debug_mem.c.

References debug_assert, DEBUG_MEMORY_MAGIC, debug_printf(), debug_memory_header::file, footer_from_header(), debug_memory_header::function, debug_memory_header::head, header_from_data(), debug_memory_header::line, LIST_DEL, debug_memory_footer::magic, debug_memory_header::magic, and real_free.

{
   struct debug_memory_header *hdr;
   struct debug_memory_footer *ftr;
   
   if(!ptr)
      return;
   
   hdr = header_from_data(ptr);
   if(hdr->magic != DEBUG_MEMORY_MAGIC) {
      debug_printf("%s:%u:%s: freeing bad or corrupted memory %p\n",
                   file, line, function,
                   ptr);
      debug_assert(0);
      return;
   }

   ftr = footer_from_header(hdr);
   if(ftr->magic != DEBUG_MEMORY_MAGIC) {
      debug_printf("%s:%u:%s: buffer overflow %p\n",
                   hdr->file, hdr->line, hdr->function,
                   ptr);
      debug_assert(0);
   }

   LIST_DEL(&hdr->head);
   hdr->magic = 0;
   ftr->magic = 0;
   
   real_free(hdr);
}

void* debug_malloc	(	const char *	file,
		unsigned	line,
		const char *	function,
		size_t	size
	)

Definition at line 118 of file p_debug_mem.c.

References assert, data_from_header(), DEBUG_MEMORY_MAGIC, debug_printf(), debug_memory_header::file, footer_from_header(), debug_memory_header::function, debug_memory_header::head, last_no, debug_memory_header::line, LIST_ADDTAIL, debug_memory_footer::magic, debug_memory_header::magic, debug_memory_header::no, real_malloc, and debug_memory_header::size.

{
   struct debug_memory_header *hdr;
   struct debug_memory_footer *ftr;
   
   assert(size);
   
   hdr = real_malloc(sizeof(*hdr) + size + sizeof(*ftr));
   if(!hdr) {
      debug_printf("%s:%u:%s: out of memory when trying to allocate %lu bytes\n",
                   file, line, function,
                   (long unsigned)size);
      return NULL;
   }
 
   hdr->no = last_no++;
   hdr->file = file;
   hdr->line = line;
   hdr->function = function;
   hdr->size = size;
   hdr->magic = DEBUG_MEMORY_MAGIC;

   ftr = footer_from_header(hdr);
   ftr->magic = DEBUG_MEMORY_MAGIC;
   
   LIST_ADDTAIL(&hdr->head, &list);
   
   return data_from_header(hdr);
}

unsigned long debug_memory_begin

(

void

)

Definition at line 259 of file p_debug_mem.c.

References last_no.

{
   return last_no;
}

void debug_memory_end

(

unsigned long

start_no

)

Definition at line 265 of file p_debug_mem.c.

References data_from_header(), debug_assert, DEBUG_MEMORY_MAGIC, debug_printf(), debug_memory_header::file, footer_from_header(), debug_memory_header::function, last_no, debug_memory_header::line, LIST_ENTRY, debug_memory_footer::magic, debug_memory_header::magic, debug_memory_header::no, list_head::prev, and debug_memory_header::size.

{
   size_t total_size = 0;
   struct list_head *entry;

   if(start_no == last_no)
      return;

   entry = list.prev;
   for (; entry != &list; entry = entry->prev) {
      struct debug_memory_header *hdr;
      void *ptr;
      struct debug_memory_footer *ftr;

      hdr = LIST_ENTRY(struct debug_memory_header, entry, head);
      ptr = data_from_header(hdr);
      ftr = footer_from_header(hdr);

      if(hdr->magic != DEBUG_MEMORY_MAGIC) {
         debug_printf("%s:%u:%s: bad or corrupted memory %p\n",
                      hdr->file, hdr->line, hdr->function,
                      ptr);
         debug_assert(0);
      }

      if((start_no <= hdr->no && hdr->no < last_no) ||
         (last_no < start_no && (hdr->no < last_no || start_no <= hdr->no))) {
         debug_printf("%s:%u:%s: %u bytes at %p not freed\n",
                      hdr->file, hdr->line, hdr->function,
                      hdr->size, ptr);
         total_size += hdr->size;
      }

      if(ftr->magic != DEBUG_MEMORY_MAGIC) {
         debug_printf("%s:%u:%s: buffer overflow %p\n",
                      hdr->file, hdr->line, hdr->function,
                      ptr);
         debug_assert(0);
      }
   }

   if(total_size) {
      debug_printf("Total of %u KB of system memory apparently leaked\n",
                   (total_size + 1023)/1024);
   }
   else {
      debug_printf("No memory leaks detected.\n");
   }
}

void* debug_realloc	(	const char *	file,
		unsigned	line,
		const char *	function,
		void *	old_ptr,
		size_t	old_size,
		size_t	new_size
	)

Definition at line 194 of file p_debug_mem.c.

References data_from_header(), debug_assert, debug_free(), debug_malloc(), DEBUG_MEMORY_MAGIC, debug_printf(), debug_memory_header::file, footer_from_header(), debug_memory_header::function, debug_memory_header::head, header_from_data(), debug_memory_header::line, LIST_REPLACE, debug_memory_footer::magic, debug_memory_header::magic, debug_memory_header::no, real_free, real_malloc, and debug_memory_header::size.

{
   struct debug_memory_header *old_hdr, *new_hdr;
   struct debug_memory_footer *old_ftr, *new_ftr;
   void *new_ptr;
   
   if(!old_ptr)
      return debug_malloc( file, line, function, new_size );
   
   if(!new_size) {
      debug_free( file, line, function, old_ptr );
      return NULL;
   }
   
   old_hdr = header_from_data(old_ptr);
   if(old_hdr->magic != DEBUG_MEMORY_MAGIC) {
      debug_printf("%s:%u:%s: reallocating bad or corrupted memory %p\n",
                   file, line, function,
                   old_ptr);
      debug_assert(0);
      return NULL;
   }
   
   old_ftr = footer_from_header(old_hdr);
   if(old_ftr->magic != DEBUG_MEMORY_MAGIC) {
      debug_printf("%s:%u:%s: buffer overflow %p\n",
                   old_hdr->file, old_hdr->line, old_hdr->function,
                   old_ptr);
      debug_assert(0);
   }

   /* alloc new */
   new_hdr = real_malloc(sizeof(*new_hdr) + new_size + sizeof(*new_ftr));
   if(!new_hdr) {
      debug_printf("%s:%u:%s: out of memory when trying to allocate %lu bytes\n",
                   file, line, function,
                   (long unsigned)new_size);
      return NULL;
   }
   new_hdr->no = old_hdr->no;
   new_hdr->file = old_hdr->file;
   new_hdr->line = old_hdr->line;
   new_hdr->function = old_hdr->function;
   new_hdr->size = new_size;
   new_hdr->magic = DEBUG_MEMORY_MAGIC;
   
   new_ftr = footer_from_header(new_hdr);
   new_ftr->magic = DEBUG_MEMORY_MAGIC;
   
   LIST_REPLACE(&old_hdr->head, &new_hdr->head);

   /* copy data */
   new_ptr = data_from_header(new_hdr);
   memcpy( new_ptr, old_ptr, old_size < new_size ? old_size : new_size );

   /* free old */
   old_hdr->magic = 0;
   old_ftr->magic = 0;
   real_free(old_hdr);

   return new_ptr;
}

static struct debug_memory_footer* footer_from_header

(

struct debug_memory_header *

hdr

)

[static, read]

Definition at line 108 of file p_debug_mem.c.

References debug_memory_header::size.

{
   if(hdr)
      return (struct debug_memory_footer *)((char *)hdr + sizeof(struct debug_memory_header) + hdr->size);
   else
      return NULL;
}

static struct debug_memory_header* header_from_data

(

void *

data

)

[static, read]

Definition at line 90 of file p_debug_mem.c.

{
   if(data)
      return (struct debug_memory_header *)((char *)data - sizeof(struct debug_memory_header));
   else
      return NULL;
}

---

Variable Documentation

unsigned long last_no = 0 [static]

Definition at line 86 of file p_debug_mem.c.

struct list_head list = { &list, &list } [static]

Definition at line 84 of file p_debug_mem.c.

---