2006-03-20 17:12:09 +00:00
|
|
|
/*
|
2014-06-01 17:55:23 +00:00
|
|
|
* Portions of this file are copyright Rebirth contributors and licensed as
|
|
|
|
* described in COPYING.txt.
|
|
|
|
* Portions of this file are copyright Parallax Software and licensed
|
|
|
|
* according to the Parallax license below.
|
|
|
|
* See COPYING.txt for license details.
|
|
|
|
|
2006-03-20 17:12:09 +00:00
|
|
|
THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
|
|
|
|
SOFTWARE CORPORATION ("PARALLAX"). PARALLAX, IN DISTRIBUTING THE CODE TO
|
|
|
|
END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
|
|
|
|
ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
|
|
|
|
IN USING, DISPLAYING, AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
|
|
|
|
SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
|
|
|
|
FREE PURPOSES. IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
|
|
|
|
CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES. THE END-USER UNDERSTANDS
|
|
|
|
AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
|
|
|
|
COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION. ALL RIGHTS RESERVED.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
*
|
|
|
|
* Files for debugging memory allocator
|
|
|
|
*
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <stdlib.h>
|
|
|
|
#include <string.h>
|
|
|
|
#include "pstypes.h"
|
2012-07-07 18:35:06 +00:00
|
|
|
#include "dxxerror.h"
|
2007-07-18 22:23:06 +00:00
|
|
|
#include "args.h"
|
2008-04-06 20:23:28 +00:00
|
|
|
#include "console.h"
|
2014-08-18 03:00:50 +00:00
|
|
|
#include "u_mem.h"
|
2020-05-02 21:18:42 +00:00
|
|
|
#include <array>
|
2016-10-29 23:16:15 +00:00
|
|
|
|
2015-12-13 18:00:49 +00:00
|
|
|
namespace dcx {
|
2015-12-05 22:57:24 +00:00
|
|
|
|
2007-07-18 22:23:06 +00:00
|
|
|
#define MEMSTATS 0
|
2006-03-20 17:12:09 +00:00
|
|
|
#define FULL_MEM_CHECKING 1
|
|
|
|
|
2012-05-20 18:51:21 +00:00
|
|
|
#ifdef DEBUG_MEMORY_ALLOCATIONS
|
|
|
|
#if defined(FULL_MEM_CHECKING)
|
2006-03-20 17:12:09 +00:00
|
|
|
|
|
|
|
#define CHECKSIZE 16
|
|
|
|
#define CHECKBYTE 0xFC
|
|
|
|
|
|
|
|
#define MAX_INDEX 10000
|
|
|
|
|
2020-05-02 21:18:42 +00:00
|
|
|
static std::array<void *, MAX_INDEX> MallocBase;
|
|
|
|
static std::array<unsigned int, MAX_INDEX> MallocSize;
|
|
|
|
static std::array<unsigned char, MAX_INDEX> Present;
|
|
|
|
static std::array<const char *, MAX_INDEX> Filename;
|
|
|
|
static std::array<const char *, MAX_INDEX> Varname;
|
|
|
|
static std::array<int, MAX_INDEX> LineNum;
|
2006-03-20 17:12:09 +00:00
|
|
|
static int BytesMalloced = 0;
|
|
|
|
|
|
|
|
static int free_list[MAX_INDEX];
|
|
|
|
|
|
|
|
static int num_blocks = 0;
|
|
|
|
|
|
|
|
static int Initialized = 0;
|
|
|
|
static int LargestIndex = 0;
|
2015-06-13 22:42:15 +00:00
|
|
|
static int out_of_memory = 0;
|
2006-03-20 17:12:09 +00:00
|
|
|
|
|
|
|
void mem_init()
|
|
|
|
{
|
|
|
|
Initialized = 1;
|
|
|
|
|
2016-10-29 23:16:15 +00:00
|
|
|
MallocBase = {};
|
|
|
|
MallocSize = {};
|
|
|
|
Present = {};
|
|
|
|
Filename = {};
|
|
|
|
Varname = {};
|
|
|
|
LineNum = {};
|
2014-09-26 02:42:12 +00:00
|
|
|
for (int i=0; i<MAX_INDEX; i++ )
|
2006-03-20 17:12:09 +00:00
|
|
|
{
|
|
|
|
free_list[i] = i;
|
|
|
|
}
|
|
|
|
|
|
|
|
num_blocks = 0;
|
|
|
|
LargestIndex = 0;
|
|
|
|
|
|
|
|
atexit(mem_display_blocks);
|
|
|
|
}
|
|
|
|
|
2013-10-27 22:00:14 +00:00
|
|
|
static void PrintInfo( int id )
|
2006-03-20 17:12:09 +00:00
|
|
|
{
|
2013-12-07 00:47:27 +00:00
|
|
|
con_printf(CON_CRITICAL, "\tBlock '%s' created in %s, line %d.", Varname[id], Filename[id], LineNum[id] );
|
2006-03-20 17:12:09 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2015-01-23 03:55:05 +00:00
|
|
|
void *mem_malloc(size_t size, const char * var, const char * filename, unsigned line)
|
2006-03-20 17:12:09 +00:00
|
|
|
{
|
2014-09-26 02:42:12 +00:00
|
|
|
int id;
|
2006-03-20 17:12:09 +00:00
|
|
|
void *ptr;
|
|
|
|
char * pc;
|
|
|
|
|
|
|
|
if (Initialized==0)
|
|
|
|
mem_init();
|
|
|
|
|
|
|
|
#if MEMSTATS
|
|
|
|
{
|
|
|
|
unsigned long theFreeMem = 0;
|
|
|
|
|
|
|
|
if (sMemStatsFileInitialized)
|
|
|
|
{
|
|
|
|
theFreeMem = FreeMem();
|
|
|
|
|
|
|
|
fprintf(sMemStatsFile,
|
|
|
|
"\n%9u bytes free before attempting: MALLOC %9u bytes.",
|
|
|
|
theFreeMem,
|
|
|
|
size);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
#endif // end of ifdef memstats
|
|
|
|
|
|
|
|
if ( num_blocks >= MAX_INDEX ) {
|
2013-12-07 00:47:27 +00:00
|
|
|
con_printf(CON_CRITICAL,"\nMEM_OUT_OF_SLOTS: Not enough space in mem.c to hold all the mallocs." );
|
|
|
|
con_printf(CON_CRITICAL, "\tBlock '%s' created in %s, line %d.", var, filename, line );
|
2006-03-20 17:12:09 +00:00
|
|
|
Error( "MEM_OUT_OF_SLOTS" );
|
|
|
|
}
|
|
|
|
|
|
|
|
id = free_list[ num_blocks++ ];
|
|
|
|
|
|
|
|
if (id > LargestIndex ) LargestIndex = id;
|
|
|
|
|
|
|
|
if (id==-1)
|
|
|
|
{
|
2013-12-07 00:47:27 +00:00
|
|
|
con_printf(CON_CRITICAL,"\nMEM_OUT_OF_SLOTS: Not enough space in mem.c to hold all the mallocs." );
|
|
|
|
//con_printf(CON_CRITICAL, "\tBlock '%s' created in %s, line %d.", Varname[id], Filename[id], LineNum[id] );
|
2006-03-20 17:12:09 +00:00
|
|
|
Error( "MEM_OUT_OF_SLOTS" );
|
|
|
|
}
|
2015-06-13 22:42:15 +00:00
|
|
|
ptr = malloc(size + DXX_DEBUG_BIAS_MEMORY_ALLOCATION + CHECKSIZE);
|
2006-03-20 17:12:09 +00:00
|
|
|
|
|
|
|
if (ptr==NULL)
|
|
|
|
{
|
|
|
|
out_of_memory = 1;
|
2013-12-07 00:47:27 +00:00
|
|
|
con_printf(CON_CRITICAL, "\nMEM_OUT_OF_MEMORY: Malloc returned NULL" );
|
|
|
|
con_printf(CON_CRITICAL, "\tBlock '%s' created in %s, line %d.", Varname[id], Filename[id], LineNum[id] );
|
2006-03-20 17:12:09 +00:00
|
|
|
Error( "MEM_OUT_OF_MEMORY" );
|
|
|
|
}
|
2015-06-13 22:42:15 +00:00
|
|
|
ptr = reinterpret_cast<char *>(ptr) + DXX_DEBUG_BIAS_MEMORY_ALLOCATION;
|
2006-03-20 17:12:09 +00:00
|
|
|
MallocBase[id] = ptr;
|
|
|
|
MallocSize[id] = size;
|
|
|
|
Varname[id] = var;
|
|
|
|
Filename[id] = filename;
|
|
|
|
LineNum[id] = line;
|
|
|
|
Present[id] = 1;
|
|
|
|
|
2016-06-05 01:04:26 +00:00
|
|
|
pc = reinterpret_cast<char *>(ptr);
|
2006-03-20 17:12:09 +00:00
|
|
|
|
|
|
|
BytesMalloced += size;
|
|
|
|
|
2014-09-26 02:42:12 +00:00
|
|
|
for (int i=0; i<CHECKSIZE; i++ )
|
2006-03-20 17:12:09 +00:00
|
|
|
pc[size+i] = CHECKBYTE;
|
|
|
|
|
|
|
|
return ptr;
|
2013-07-13 04:23:18 +00:00
|
|
|
}
|
2006-03-20 17:12:09 +00:00
|
|
|
|
2013-07-13 04:23:18 +00:00
|
|
|
void *(mem_calloc)( size_t nmemb, size_t size, const char * var, const char * filename, unsigned line)
|
|
|
|
{
|
|
|
|
size_t threshold = 1, request = nmemb * size;
|
|
|
|
threshold <<= (4 * sizeof(threshold));
|
|
|
|
if ((nmemb | size) >= threshold) {
|
|
|
|
/* possible overflow condition */
|
|
|
|
if (request / size != nmemb)
|
2016-06-05 01:04:26 +00:00
|
|
|
request = ~static_cast<size_t>(0);
|
2013-07-13 04:23:18 +00:00
|
|
|
}
|
|
|
|
void *ptr = mem_malloc(request, var, filename, line);
|
|
|
|
if (ptr)
|
|
|
|
memset( ptr, 0, request );
|
|
|
|
return ptr;
|
2006-03-20 17:12:09 +00:00
|
|
|
}
|
|
|
|
|
2013-10-27 22:00:14 +00:00
|
|
|
static int mem_find_id( void * buffer )
|
2006-03-20 17:12:09 +00:00
|
|
|
{
|
2014-09-26 02:42:12 +00:00
|
|
|
for (int i=0; i<=LargestIndex; i++ )
|
2006-03-20 17:12:09 +00:00
|
|
|
if (Present[i]==1)
|
|
|
|
if (MallocBase[i] == buffer )
|
|
|
|
return i;
|
|
|
|
|
|
|
|
// Didn't find id.
|
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
|
2013-10-27 22:00:14 +00:00
|
|
|
static int mem_check_integrity( int block_number )
|
2006-03-20 17:12:09 +00:00
|
|
|
{
|
2014-09-26 02:42:12 +00:00
|
|
|
int ErrorCount;
|
2016-07-14 01:59:02 +00:00
|
|
|
uint8_t * CheckData;
|
2006-03-20 17:12:09 +00:00
|
|
|
|
2016-07-03 00:54:15 +00:00
|
|
|
CheckData = reinterpret_cast<uint8_t *>(reinterpret_cast<char *>(MallocBase[block_number]) + MallocSize[block_number]);
|
2006-03-20 17:12:09 +00:00
|
|
|
|
|
|
|
ErrorCount = 0;
|
|
|
|
|
2014-09-26 02:42:12 +00:00
|
|
|
for (int i=0; i<CHECKSIZE; i++ )
|
2006-03-20 17:12:09 +00:00
|
|
|
if (CheckData[i] != CHECKBYTE ) {
|
|
|
|
ErrorCount++;
|
2008-04-06 20:23:28 +00:00
|
|
|
con_printf(CON_CRITICAL, "OA: %p ", &CheckData[i] );
|
2006-03-20 17:12:09 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (ErrorCount && (!out_of_memory)) {
|
2013-12-07 00:47:27 +00:00
|
|
|
con_printf(CON_CRITICAL, "\nMEM_OVERWRITE: Memory after the end of allocated block overwritten." );
|
2006-03-20 17:12:09 +00:00
|
|
|
PrintInfo( block_number );
|
2013-12-07 00:47:27 +00:00
|
|
|
con_printf(CON_CRITICAL, "\t%d/%d check bytes were overwritten.", ErrorCount, CHECKSIZE );
|
2006-03-20 17:12:09 +00:00
|
|
|
Int3();
|
|
|
|
}
|
|
|
|
|
|
|
|
return ErrorCount;
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
void mem_free( void * buffer )
|
|
|
|
{
|
|
|
|
int id;
|
|
|
|
|
|
|
|
if (Initialized==0)
|
|
|
|
mem_init();
|
|
|
|
|
|
|
|
#if MEMSTATS
|
|
|
|
{
|
|
|
|
unsigned long theFreeMem = 0;
|
|
|
|
|
|
|
|
if (sMemStatsFileInitialized)
|
|
|
|
{
|
|
|
|
theFreeMem = FreeMem();
|
|
|
|
|
|
|
|
fprintf(sMemStatsFile,
|
|
|
|
"\n%9u bytes free before attempting: FREE", theFreeMem);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
#endif // end of ifdef memstats
|
|
|
|
|
|
|
|
if (buffer==NULL && (!out_of_memory))
|
|
|
|
{
|
2013-12-07 00:47:27 +00:00
|
|
|
con_printf(CON_CRITICAL, "\nMEM_FREE_NULL: An attempt was made to free the null pointer." );
|
2006-03-20 17:12:09 +00:00
|
|
|
Warning( "MEM: Freeing the NULL pointer!" );
|
|
|
|
Int3();
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
id = mem_find_id( buffer );
|
|
|
|
|
|
|
|
if (id==-1 && (!out_of_memory))
|
|
|
|
{
|
2013-12-07 00:47:27 +00:00
|
|
|
con_printf(CON_CRITICAL, "\nMEM_FREE_NOMALLOC: An attempt was made to free a ptr that wasn't\nallocated with mem.h included." );
|
2006-03-20 17:12:09 +00:00
|
|
|
Warning( "MEM: Freeing a non-malloced pointer!" );
|
|
|
|
Int3();
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
mem_check_integrity( id );
|
|
|
|
|
|
|
|
BytesMalloced -= MallocSize[id];
|
|
|
|
|
2015-06-13 22:42:15 +00:00
|
|
|
buffer = reinterpret_cast<char *>(buffer) - DXX_DEBUG_BIAS_MEMORY_ALLOCATION;
|
2006-03-20 17:12:09 +00:00
|
|
|
free( buffer );
|
2007-07-18 22:23:06 +00:00
|
|
|
|
2006-03-20 17:12:09 +00:00
|
|
|
Present[id] = 0;
|
|
|
|
MallocBase[id] = 0;
|
|
|
|
MallocSize[id] = 0;
|
|
|
|
|
|
|
|
free_list[ --num_blocks ] = id;
|
|
|
|
}
|
|
|
|
|
2015-01-29 04:27:35 +00:00
|
|
|
void *mem_realloc(void *buffer, size_t size, const char *var, const char *filename, unsigned line)
|
2006-03-20 17:12:09 +00:00
|
|
|
{
|
|
|
|
void *newbuffer;
|
|
|
|
int id;
|
|
|
|
|
|
|
|
if (Initialized==0)
|
|
|
|
mem_init();
|
|
|
|
|
|
|
|
if (size == 0) {
|
|
|
|
mem_free(buffer);
|
|
|
|
newbuffer = NULL;
|
|
|
|
} else if (buffer == NULL) {
|
2013-07-13 04:23:18 +00:00
|
|
|
newbuffer = mem_malloc(size, var, filename, line);
|
2006-03-20 17:12:09 +00:00
|
|
|
} else {
|
2013-07-13 04:23:18 +00:00
|
|
|
newbuffer = mem_malloc(size, var, filename, line);
|
2006-03-20 17:12:09 +00:00
|
|
|
if (newbuffer != NULL) {
|
|
|
|
id = mem_find_id(buffer);
|
|
|
|
if (MallocSize[id] < size)
|
|
|
|
size = MallocSize[id];
|
|
|
|
memcpy(newbuffer, buffer, size);
|
|
|
|
mem_free(buffer);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return newbuffer;
|
|
|
|
}
|
|
|
|
|
|
|
|
void mem_display_blocks()
|
|
|
|
{
|
2014-09-26 02:42:12 +00:00
|
|
|
int numleft;
|
2006-03-20 17:12:09 +00:00
|
|
|
|
|
|
|
if (Initialized==0) return;
|
|
|
|
|
|
|
|
#if MEMSTATS
|
|
|
|
{
|
|
|
|
if (sMemStatsFileInitialized)
|
|
|
|
{
|
|
|
|
unsigned long theFreeMem = 0;
|
|
|
|
|
|
|
|
theFreeMem = FreeMem();
|
|
|
|
|
|
|
|
fprintf(sMemStatsFile,
|
|
|
|
"\n%9u bytes free before closing MEMSTATS file.", theFreeMem);
|
|
|
|
fprintf(sMemStatsFile, "\nMemory Stats File Closed.");
|
|
|
|
fclose(sMemStatsFile);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
#endif // end of ifdef memstats
|
|
|
|
|
|
|
|
numleft = 0;
|
2014-09-26 02:42:12 +00:00
|
|
|
for (int i=0; i<=LargestIndex; i++ )
|
2006-03-20 17:12:09 +00:00
|
|
|
{
|
|
|
|
if (Present[i]==1 && (!out_of_memory))
|
|
|
|
{
|
|
|
|
numleft++;
|
2015-08-11 03:05:55 +00:00
|
|
|
if (CGameArg.DbgShowMemInfo) {
|
2013-12-07 00:47:27 +00:00
|
|
|
con_printf(CON_CRITICAL, "\nMEM_LEAKAGE: Memory block has not been freed." );
|
2006-03-20 17:12:09 +00:00
|
|
|
PrintInfo( i );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (numleft && (!out_of_memory))
|
|
|
|
{
|
|
|
|
Warning( "MEM: %d blocks were left allocated!\n", numleft );
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
void mem_validate_heap()
|
|
|
|
{
|
2014-09-26 02:42:12 +00:00
|
|
|
for (int i=0; i<LargestIndex; i++ )
|
2006-03-20 17:12:09 +00:00
|
|
|
if (Present[i]==1 )
|
|
|
|
mem_check_integrity( i );
|
|
|
|
}
|
|
|
|
|
|
|
|
#else
|
|
|
|
|
|
|
|
static int Initialized = 0;
|
|
|
|
static unsigned int SmallestAddress = 0xFFFFFFF;
|
|
|
|
static unsigned int LargestAddress = 0x0;
|
|
|
|
static unsigned int BytesMalloced = 0;
|
|
|
|
|
|
|
|
void mem_init()
|
|
|
|
{
|
|
|
|
Initialized = 1;
|
|
|
|
|
|
|
|
SmallestAddress = 0xFFFFFFF;
|
|
|
|
LargestAddress = 0x0;
|
|
|
|
|
|
|
|
atexit(mem_display_blocks);
|
|
|
|
}
|
|
|
|
|
|
|
|
void mem_display_blocks()
|
|
|
|
{
|
|
|
|
if (Initialized==0) return;
|
|
|
|
|
|
|
|
#if MEMSTATS
|
|
|
|
{
|
|
|
|
if (sMemStatsFileInitialized)
|
|
|
|
{
|
|
|
|
unsigned long theFreeMem = 0;
|
|
|
|
|
|
|
|
theFreeMem = FreeMem();
|
|
|
|
|
|
|
|
fprintf(sMemStatsFile,
|
|
|
|
"\n%9u bytes free before closing MEMSTATS file.", theFreeMem);
|
|
|
|
fprintf(sMemStatsFile, "\nMemory Stats File Closed.");
|
|
|
|
fclose(sMemStatsFile);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
#endif // end of ifdef memstats
|
|
|
|
|
|
|
|
if (BytesMalloced != 0 ) {
|
2013-12-07 00:47:27 +00:00
|
|
|
con_printf(CON_CRITICAL, "\nMEM_LEAKAGE: %d bytes of memory have not been freed.", BytesMalloced );
|
2006-03-20 17:12:09 +00:00
|
|
|
}
|
|
|
|
|
2015-08-11 03:05:55 +00:00
|
|
|
if (CGameArg.DbgShowMemInfo) {
|
2013-12-07 00:47:27 +00:00
|
|
|
con_printf(CON_CRITICAL, "\n\nMEMORY USAGE:" );
|
|
|
|
con_printf(CON_CRITICAL, " %u Kbytes dynamic data", (LargestAddress-SmallestAddress+512)/1024 );
|
|
|
|
con_printf(CON_CRITICAL, " %u Kbytes code/static data.", (SmallestAddress-(4*1024*1024)+512)/1024 );
|
|
|
|
con_printf(CON_CRITICAL, " ---------------------------" );
|
|
|
|
con_printf(CON_CRITICAL, " %u Kbytes required.", (LargestAddress-(4*1024*1024)+512)/1024 );
|
2006-03-20 17:12:09 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void mem_validate_heap()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif
|
2012-05-20 18:51:21 +00:00
|
|
|
#endif
|
2015-12-05 22:57:24 +00:00
|
|
|
|
|
|
|
}
|