/**************************************************************************
- *
+ *
* Copyright 2008 VMware, Inc.
* All Rights Reserved.
- *
+ *
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* distribute, sub license, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
- *
+ *
* The above copyright notice and this permission notice (including the
* next paragraph) shall be included in all copies or substantial portions
* of the Software.
- *
+ *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
* ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- *
+ *
**************************************************************************/
/**
* @file
* Memory debugging.
- *
+ *
* @author José Fonseca <jfonseca@vmware.com>
*/
-#include "pipe/p_config.h"
+#include "pipe/p_config.h"
#define DEBUG_MEMORY_IMPLEMENTATION
#include "os/os_memory_debug.h"
#include "os/os_thread.h"
-#include "util/u_debug.h"
-#include "util/u_debug_stack.h"
+#include "util/u_debug.h"
+#include "util/u_debug_stack.h"
#include "util/list.h"
-#define DEBUG_MEMORY_MAGIC 0x6e34090aU
+#define DEBUG_MEMORY_MAGIC 0x6e34090aU
#define DEBUG_MEMORY_STACK 0 /* XXX: disabled until we have symbol lookup */
/**
#define DEBUG_FREED_BYTE 0x33
-struct debug_memory_header
+struct debug_memory_header
{
struct list_head head;
-
+
unsigned long no;
const char *file;
unsigned line;
static inline struct debug_memory_header *
header_from_data(void *data)
{
- if(data)
+ if (data)
return (struct debug_memory_header *)((char *)data - sizeof(struct debug_memory_header));
else
return NULL;
static inline void *
data_from_header(struct debug_memory_header *hdr)
{
- if(hdr)
+ if (hdr)
return (void *)((char *)hdr + sizeof(struct debug_memory_header));
else
return NULL;
static inline struct debug_memory_footer *
footer_from_header(struct debug_memory_header *hdr)
{
- if(hdr)
+ if (hdr)
return (struct debug_memory_footer *)((char *)hdr + sizeof(struct debug_memory_header) + hdr->size);
else
return NULL;
void *
debug_malloc(const char *file, unsigned line, const char *function,
- size_t size)
+ size_t size)
{
struct debug_memory_header *hdr;
struct debug_memory_footer *ftr;
-
+
hdr = os_malloc(sizeof(*hdr) + size + sizeof(*ftr));
if (!hdr) {
debug_printf("%s:%u:%s: out of memory when trying to allocate %lu bytes\n",
(long unsigned)size);
return NULL;
}
-
+
hdr->no = last_no++;
hdr->file = file;
hdr->line = line;
ftr = footer_from_header(hdr);
ftr->magic = DEBUG_MEMORY_MAGIC;
-
+
mtx_lock(&list_mutex);
LIST_ADDTAIL(&hdr->head, &list);
mtx_unlock(&list_mutex);
-
+
return data_from_header(hdr);
}
void
debug_free(const char *file, unsigned line, const char *function,
- void *ptr)
+ void *ptr)
{
struct debug_memory_header *hdr;
struct debug_memory_footer *ftr;
-
+
if (!ptr)
return;
-
+
hdr = header_from_data(ptr);
- if(hdr->magic != DEBUG_MEMORY_MAGIC) {
+ if (hdr->magic != DEBUG_MEMORY_MAGIC) {
debug_printf("%s:%u:%s: freeing bad or corrupted memory %p\n",
file, line, function,
ptr);
}
ftr = footer_from_header(hdr);
- if(ftr->magic != DEBUG_MEMORY_MAGIC) {
+ if (ftr->magic != DEBUG_MEMORY_MAGIC) {
debug_printf("%s:%u:%s: buffer overflow %p\n",
hdr->file, hdr->line, hdr->function,
ptr);
mtx_unlock(&list_mutex);
hdr->magic = 0;
ftr->magic = 0;
-
+
os_free(hdr);
#endif
}
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) {
+
+ 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) {
+ 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) {
+ 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);
#if DEBUG_FREED_MEMORY
new_hdr->freed = FALSE;
#endif
-
+
new_ftr = footer_from_header(new_hdr);
new_ftr->magic = DEBUG_MEMORY_MAGIC;
-
+
mtx_lock(&list_mutex);
LIST_REPLACE(&old_hdr->head, &new_hdr->head);
mtx_unlock(&list_mutex);
return last_no;
}
-void
+void
debug_memory_end(unsigned long start_no)
{
size_t total_size = 0;
struct list_head *entry;
- if(start_no == last_no)
+ if (start_no == last_no)
return;
entry = list.prev;
ptr = data_from_header(hdr);
ftr = footer_from_header(hdr);
- if(hdr->magic != DEBUG_MEMORY_MAGIC) {
+ 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: %lu bytes at %p not freed\n",
- hdr->file, hdr->line, hdr->function,
- (unsigned long) hdr->size, ptr);
+ 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: %lu bytes at %p not freed\n",
+ hdr->file, hdr->line, hdr->function,
+ (unsigned long) hdr->size, ptr);
#if DEBUG_MEMORY_STACK
- debug_backtrace_dump(hdr->backtrace, DEBUG_MEMORY_STACK);
+ debug_backtrace_dump(hdr->backtrace, DEBUG_MEMORY_STACK);
#endif
- total_size += hdr->size;
+ total_size += hdr->size;
}
- if(ftr->magic != DEBUG_MEMORY_MAGIC) {
+ if (ftr->magic != DEBUG_MEMORY_MAGIC) {
debug_printf("%s:%u:%s: buffer overflow %p\n",
hdr->file, hdr->line, hdr->function,
ptr);
}
}
- if(total_size) {
+ if (total_size) {
debug_printf("Total of %lu KB of system memory apparently leaked\n",
- (unsigned long) (total_size + 1023)/1024);
+ (unsigned long) (total_size + 1023)/1024);
}
else {
debug_printf("No memory leaks detected.\n");
debug_memory_tag(void *ptr, unsigned tag)
{
struct debug_memory_header *hdr;
-
+
if (!ptr)
return;
-
+
hdr = header_from_data(ptr);
if (hdr->magic != DEBUG_MEMORY_MAGIC) {
debug_printf("%s corrupted memory at %p\n", __FUNCTION__, ptr);
{
struct debug_memory_header *hdr;
struct debug_memory_footer *ftr;
-
+
if (!ptr)
return;
-
+
hdr = header_from_data(ptr);
ftr = footer_from_header(hdr);
* We can periodically call this from elsewhere to do a basic sanity
* check of the heap memory we've allocated.
*/
-void
+void
debug_memory_check(void)
{
struct list_head *entry;