#include "quakedef.h"
-cvar_t developer_memory = {0, "developer_memory", "0"};
+cvar_t developer_memory = {0, "developer_memory", "0", "prints debugging information about memory allocations"};
+cvar_t developer_memorydebug = {0, "developer_memorydebug", "0", "enables memory corruption checks (very slow)"};
mempool_t *poolchain = NULL;
-void *_Mem_Alloc(mempool_t *pool, int size, const char *filename, int fileline)
+void *_Mem_Alloc(mempool_t *pool, size_t size, const char *filename, int fileline)
{
#if MEMCLUMPING
int i, j, k, needed, endbit, largest;
Sys_Error("Mem_Alloc: pool == NULL (alloc at %s:%i)", filename, fileline);
if (developer.integer && developer_memory.integer)
Con_Printf("Mem_Alloc: pool %s, file %s:%i, size %i bytes\n", pool->name, filename, fileline, size);
+ if (developer.integer && developer_memorydebug.integer)
+ _Mem_CheckSentinelsGlobal(filename, fileline);
pool->totalsize += size;
#if MEMCLUMPING
if (size < 4096)
clump->largestavailable = MEMBITS - needed;
j = 0;
choseclump:
- mem = (memheader_t *)((qbyte *) clump->block + j * MEMUNIT);
+ mem = (memheader_t *)((unsigned char *) clump->block + j * MEMUNIT);
mem->clump = clump;
clump->blocksinuse += needed;
for (i = j + needed;j < i;j++)
// big allocations are not clumped
#endif
pool->realsize += sizeof(memheader_t) + size + sizeof(int);
- mem = malloc(sizeof(memheader_t) + size + sizeof(int));
+ mem = (memheader_t *)malloc(sizeof(memheader_t) + size + sizeof(int));
if (mem == NULL)
Sys_Error("Mem_Alloc: out of memory (alloc at %s:%i)", filename, fileline);
#if MEMCLUMPING
mem->pool = pool;
mem->sentinel1 = MEMHEADER_SENTINEL1;
// we have to use only a single byte for this sentinel, because it may not be aligned, and some platforms can't use unaligned accesses
- *((qbyte *) mem + sizeof(memheader_t) + mem->size) = MEMHEADER_SENTINEL2;
+ *((unsigned char *) mem + sizeof(memheader_t) + mem->size) = MEMHEADER_SENTINEL2;
// append to head of list
mem->next = pool->chain;
mem->prev = NULL;
pool->chain = mem;
if (mem->next)
mem->next->prev = mem;
- memset((void *)((qbyte *) mem + sizeof(memheader_t)), 0, mem->size);
- return (void *)((qbyte *) mem + sizeof(memheader_t));
+ memset((void *)((unsigned char *) mem + sizeof(memheader_t)), 0, mem->size);
+ return (void *)((unsigned char *) mem + sizeof(memheader_t));
}
-void _Mem_Free(void *data, const char *filename, int fileline)
+// only used by _Mem_Free and _Mem_FreePool
+static void _Mem_FreeBlock(memheader_t *mem, const char *filename, int fileline)
{
#if MEMCLUMPING
int i, firstblock, endblock;
memclump_t *clump, **clumpchainpointer;
#endif
- memheader_t *mem;
mempool_t *pool;
- if (data == NULL)
- Sys_Error("Mem_Free: data == NULL (called at %s:%i)", filename, fileline);
-
- mem = (memheader_t *)((qbyte *) data - sizeof(memheader_t));
if (mem->sentinel1 != MEMHEADER_SENTINEL1)
Sys_Error("Mem_Free: trashed header sentinel 1 (alloc at %s:%i, free at %s:%i)", mem->filename, mem->fileline, filename, fileline);
- if (*((qbyte *) mem + sizeof(memheader_t) + mem->size) != MEMHEADER_SENTINEL2)
+ if (*((unsigned char *) mem + sizeof(memheader_t) + mem->size) != MEMHEADER_SENTINEL2)
Sys_Error("Mem_Free: trashed header sentinel 2 (alloc at %s:%i, free at %s:%i)", mem->filename, mem->fileline, filename, fileline);
pool = mem->pool;
if (developer.integer && developer_memory.integer)
Sys_Error("Mem_Free: trashed clump sentinel 1 (free at %s:%i)", filename, fileline);
if (clump->sentinel2 != MEMCLUMP_SENTINEL)
Sys_Error("Mem_Free: trashed clump sentinel 2 (free at %s:%i)", filename, fileline);
- firstblock = ((qbyte *) mem - (qbyte *) clump->block);
+ firstblock = ((unsigned char *) mem - (unsigned char *) clump->block);
if (firstblock & (MEMUNIT - 1))
Sys_Error("Mem_Free: address not valid in clump (free at %s:%i)", filename, fileline);
firstblock /= MEMUNIT;
{
#endif
pool->realsize -= sizeof(memheader_t) + mem->size + sizeof(int);
- memset(mem, 0xBF, sizeof(memheader_t) + mem->size + sizeof(int));
+ if (developer_memorydebug.integer)
+ memset(mem, 0xBF, sizeof(memheader_t) + mem->size + sizeof(int));
free(mem);
#if MEMCLUMPING
}
#endif
}
-mempool_t *_Mem_AllocPool(const char *name, const char *filename, int fileline)
+void _Mem_Free(void *data, const char *filename, int fileline)
+{
+ if (data == NULL)
+ Sys_Error("Mem_Free: data == NULL (called at %s:%i)", filename, fileline);
+
+ if (developer.integer && developer_memorydebug.integer)
+ {
+ _Mem_CheckSentinelsGlobal(filename, fileline);
+ if (!Mem_IsAllocated(NULL, data))
+ Sys_Error("Mem_Free: data is not allocated (called at %s:%i)", filename, fileline);
+ }
+
+ _Mem_FreeBlock((memheader_t *)((unsigned char *) data - sizeof(memheader_t)), filename, fileline);
+}
+
+mempool_t *_Mem_AllocPool(const char *name, int flags, mempool_t *parent, const char *filename, int fileline)
{
mempool_t *pool;
- pool = malloc(sizeof(mempool_t));
+ if (developer.integer && developer_memorydebug.integer)
+ _Mem_CheckSentinelsGlobal(filename, fileline);
+ pool = (mempool_t *)malloc(sizeof(mempool_t));
if (pool == NULL)
Sys_Error("Mem_AllocPool: out of memory (allocpool at %s:%i)", filename, fileline);
memset(pool, 0, sizeof(mempool_t));
pool->sentinel2 = MEMHEADER_SENTINEL1;
pool->filename = filename;
pool->fileline = fileline;
+ pool->flags = flags;
pool->chain = NULL;
pool->totalsize = 0;
pool->realsize = sizeof(mempool_t);
- strcpy(pool->name, name);
+ strlcpy (pool->name, name, sizeof (pool->name));
+ pool->parent = parent;
pool->next = poolchain;
poolchain = pool;
return pool;
}
-void _Mem_FreePool(mempool_t **pool, const char *filename, int fileline)
+void _Mem_FreePool(mempool_t **poolpointer, const char *filename, int fileline)
{
- mempool_t **chainaddress;
- if (*pool)
+ mempool_t *pool = *poolpointer;
+ mempool_t **chainaddress, *iter, *temp;
+
+ if (developer.integer && developer_memorydebug.integer)
+ _Mem_CheckSentinelsGlobal(filename, fileline);
+ if (pool)
{
- if ((*pool)->sentinel1 != MEMHEADER_SENTINEL1)
- Sys_Error("Mem_FreePool: trashed pool sentinel 1 (allocpool at %s:%i, freepool at %s:%i)", (*pool)->filename, (*pool)->fileline, filename, fileline);
- if ((*pool)->sentinel2 != MEMHEADER_SENTINEL1)
- Sys_Error("Mem_FreePool: trashed pool sentinel 2 (allocpool at %s:%i, freepool at %s:%i)", (*pool)->filename, (*pool)->fileline, filename, fileline);
// unlink pool from chain
- for (chainaddress = &poolchain;*chainaddress && *chainaddress != *pool;chainaddress = &((*chainaddress)->next));
- if (*chainaddress != *pool)
+ for (chainaddress = &poolchain;*chainaddress && *chainaddress != pool;chainaddress = &((*chainaddress)->next));
+ if (*chainaddress != pool)
Sys_Error("Mem_FreePool: pool already free (freepool at %s:%i)", filename, fileline);
- *chainaddress = (*pool)->next;
+ if (pool->sentinel1 != MEMHEADER_SENTINEL1)
+ Sys_Error("Mem_FreePool: trashed pool sentinel 1 (allocpool at %s:%i, freepool at %s:%i)", pool->filename, pool->fileline, filename, fileline);
+ if (pool->sentinel2 != MEMHEADER_SENTINEL1)
+ Sys_Error("Mem_FreePool: trashed pool sentinel 2 (allocpool at %s:%i, freepool at %s:%i)", pool->filename, pool->fileline, filename, fileline);
+ *chainaddress = pool->next;
// free memory owned by the pool
- while ((*pool)->chain)
- Mem_Free((void *)((qbyte *) (*pool)->chain + sizeof(memheader_t)));
+ while (pool->chain)
+ _Mem_FreeBlock(pool->chain, filename, fileline);
+
+ // free child pools, too
+ for(iter = poolchain; iter; temp = iter = iter->next)
+ if(iter->parent == pool)
+ _Mem_FreePool(&temp, filename, fileline);
// free the pool itself
- memset(*pool, 0xBF, sizeof(mempool_t));
- free(*pool);
- *pool = NULL;
+ memset(pool, 0xBF, sizeof(mempool_t));
+ free(pool);
+
+ *poolpointer = NULL;
}
}
void _Mem_EmptyPool(mempool_t *pool, const char *filename, int fileline)
{
+ mempool_t *chainaddress;
+
+ if (developer.integer && developer_memorydebug.integer)
+ {
+ _Mem_CheckSentinelsGlobal(filename, fileline);
+ // check if this pool is in the poolchain
+ for (chainaddress = poolchain;chainaddress;chainaddress = chainaddress->next)
+ if (chainaddress == pool)
+ break;
+ if (!chainaddress)
+ Sys_Error("Mem_EmptyPool: pool is already free (emptypool at %s:%i)", filename, fileline);
+ }
if (pool == NULL)
Sys_Error("Mem_EmptyPool: pool == NULL (emptypool at %s:%i)", filename, fileline);
if (pool->sentinel1 != MEMHEADER_SENTINEL1)
// free memory owned by the pool
while (pool->chain)
- Mem_Free((void *)((qbyte *) pool->chain + sizeof(memheader_t)));
+ _Mem_FreeBlock(pool->chain, filename, fileline);
+
+ // empty child pools, too
+ for(chainaddress = poolchain; chainaddress; chainaddress = chainaddress->next)
+ if(chainaddress->parent == pool)
+ _Mem_EmptyPool(chainaddress, filename, fileline);
+
}
void _Mem_CheckSentinels(void *data, const char *filename, int fileline)
if (data == NULL)
Sys_Error("Mem_CheckSentinels: data == NULL (sentinel check at %s:%i)", filename, fileline);
- mem = (memheader_t *)((qbyte *) data - sizeof(memheader_t));
+ mem = (memheader_t *)((unsigned char *) data - sizeof(memheader_t));
if (mem->sentinel1 != MEMHEADER_SENTINEL1)
Sys_Error("Mem_CheckSentinels: trashed header sentinel 1 (block allocated at %s:%i, sentinel check at %s:%i)", mem->filename, mem->fileline, filename, fileline);
- if (*((qbyte *) mem + sizeof(memheader_t) + mem->size) != MEMHEADER_SENTINEL2)
+ if (*((unsigned char *) mem + sizeof(memheader_t) + mem->size) != MEMHEADER_SENTINEL2)
Sys_Error("Mem_CheckSentinels: trashed header sentinel 2 (block allocated at %s:%i, sentinel check at %s:%i)", mem->filename, mem->fileline, filename, fileline);
}
}
for (pool = poolchain;pool;pool = pool->next)
for (mem = pool->chain;mem;mem = mem->next)
- _Mem_CheckSentinels((void *)((qbyte *) mem + sizeof(memheader_t)), filename, fileline);
+ _Mem_CheckSentinels((void *)((unsigned char *) mem + sizeof(memheader_t)), filename, fileline);
#if MEMCLUMPING
for (pool = poolchain;pool;pool = pool->next)
for (clump = pool->clumpchain;clump;clump = clump->chain)
#endif
}
+qboolean Mem_IsAllocated(mempool_t *pool, void *data)
+{
+ memheader_t *header;
+ memheader_t *target;
+
+ if (pool)
+ {
+ // search only one pool
+ target = (memheader_t *)((unsigned char *) data - sizeof(memheader_t));
+ for( header = pool->chain ; header ; header = header->next )
+ if( header == target )
+ return true;
+ }
+ else
+ {
+ // search all pools
+ for (pool = poolchain;pool;pool = pool->next)
+ if (Mem_IsAllocated(pool, data))
+ return true;
+ }
+ return false;
+}
+
+
// used for temporary memory allocations around the engine, not for longterm
// storage, if anything in this pool stays allocated during gameplay, it is
// considered a leak
void Mem_PrintStats(void)
{
- int count = 0, size = 0;
+ size_t count = 0, size = 0, realsize = 0;
mempool_t *pool;
memheader_t *mem;
Mem_CheckSentinelsGlobal();
{
count++;
size += pool->totalsize;
+ realsize += pool->realsize;
}
- Con_Printf("%i memory pools, totalling %i bytes (%.3fMB)\n", count, size, size / 1048576.0);
- if (tempmempool == NULL)
- Con_Printf("Error: no tempmempool allocated\n");
- else if (tempmempool->chain)
+ Con_Printf("%lu memory pools, totalling %lu bytes (%.3fMB)\n", (unsigned long)count, (unsigned long)size, size / 1048576.0);
+ Con_Printf("total allocated size: %lu bytes (%.3fMB)\n", (unsigned long)realsize, realsize / 1048576.0);
+ for (pool = poolchain;pool;pool = pool->next)
{
- Con_Printf("%i bytes (%.3fMB) of temporary memory still allocated (Leak!)\n", tempmempool->totalsize, tempmempool->totalsize / 1048576.0);
- Con_Printf("listing temporary memory allocations:\n");
- for (mem = tempmempool->chain;mem;mem = mem->next)
- Con_Printf("%10i bytes allocated at %s:%i\n", mem->size, mem->filename, mem->fileline);
+ if ((pool->flags & POOLFLAG_TEMP) && pool->chain)
+ {
+ Con_Printf("Memory pool %p has sprung a leak totalling %lu bytes (%.3fMB)! Listing contents...\n", pool, (unsigned long)pool->totalsize, pool->totalsize / 1048576.0);
+ for (mem = pool->chain;mem;mem = mem->next)
+ Con_Printf("%10lu bytes allocated at %s:%i\n", (unsigned long)mem->size, mem->filename, mem->fileline);
+ }
}
}
-void Mem_PrintList(int listallocations)
+void Mem_PrintList(size_t minallocationsize)
{
mempool_t *pool;
memheader_t *mem;
Mem_CheckSentinelsGlobal();
- Con_Printf("memory pool list:\n"
+ Con_Print("memory pool list:\n"
"size name\n");
for (pool = poolchain;pool;pool = pool->next)
{
- if (pool->lastchecksize != 0 && pool->totalsize != pool->lastchecksize)
- Con_Printf("%6ik (%6ik actual) %s (%i byte change)\n", (pool->totalsize + 1023) / 1024, (pool->realsize + 1023) / 1024, pool->name, pool->totalsize - pool->lastchecksize);
- else
- Con_Printf("%6ik (%6ik actual) %s\n", (pool->totalsize + 1023) / 1024, (pool->realsize + 1023) / 1024, pool->name);
+ Con_Printf("%10luk (%10luk actual) %s (%+li byte change) %s\n", (unsigned long) ((pool->totalsize + 1023) / 1024), (unsigned long)((pool->realsize + 1023) / 1024), pool->name, (long)pool->totalsize - pool->lastchecksize, (pool->flags & POOLFLAG_TEMP) ? "TEMP" : "");
pool->lastchecksize = pool->totalsize;
- if (listallocations)
- for (mem = pool->chain;mem;mem = mem->next)
- Con_Printf("%10i bytes allocated at %s:%i\n", mem->size, mem->filename, mem->fileline);
+ for (mem = pool->chain;mem;mem = mem->next)
+ if (mem->size >= minallocationsize)
+ Con_Printf("%10lu bytes allocated at %s:%i\n", (unsigned long)mem->size, mem->filename, mem->fileline);
}
}
switch(Cmd_Argc())
{
case 1:
- Mem_PrintList(false);
+ Mem_PrintList(1<<30);
Mem_PrintStats();
break;
case 2:
- if (!strcmp(Cmd_Argv(1), "all"))
- {
- Mem_PrintList(true);
- Mem_PrintStats();
- break;
- }
- // drop through
+ Mem_PrintList(atoi(Cmd_Argv(1)) * 1024);
+ Mem_PrintStats();
+ break;
default:
- Con_Printf("MemList_f: unrecognized options\nusage: memlist [all]\n");
+ Con_Print("MemList_f: unrecognized options\nusage: memlist [all]\n");
break;
}
}
-extern void R_TextureStats_PrintTotal(void);
+extern void R_TextureStats_Print(qboolean printeach, qboolean printpool, qboolean printtotal);
void MemStats_f(void)
{
Mem_CheckSentinelsGlobal();
- R_TextureStats_PrintTotal();
+ R_TextureStats_Print(false, false, true);
Mem_PrintStats();
}
*/
void Memory_Init (void)
{
- tempmempool = Mem_AllocPool("Temporary Memory");
- zonemempool = Mem_AllocPool("Zone");
+ poolchain = NULL;
+ tempmempool = Mem_AllocPool("Temporary Memory", POOLFLAG_TEMP, NULL);
+ zonemempool = Mem_AllocPool("Zone", 0, NULL);
+}
+
+void Memory_Shutdown (void)
+{
+// Mem_FreePool (&zonemempool);
+// Mem_FreePool (&tempmempool);
}
void Memory_Init_Commands (void)
{
- Cmd_AddCommand ("memstats", MemStats_f);
- Cmd_AddCommand ("memlist", MemList_f);
+ Cmd_AddCommand ("memstats", MemStats_f, "prints memory system statistics");
+ Cmd_AddCommand ("memlist", MemList_f, "prints memory pool information (or if used as memlist 5 lists individual allocations of 5K or larger, 0 lists all allocations)");
Cvar_RegisterVariable (&developer_memory);
+ Cvar_RegisterVariable (&developer_memorydebug);
}