/*  Starshatter OpenSource Distribution
    Copyright (c) 1997-2004, Destroyer Studios LLC.
    All Rights Reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    * Neither the name "Destroyer Studios" nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.

    SUBSYSTEM:    foundation
    FILE:         MemDebug.cpp
    AUTHOR:       John DiCamillo


    OVERVIEW
    ========
    Memory Debugging class
*/

#include "MemDebug.h"

#include <stdio.h>
#include <string.h>
#include <crtdbg.h>
#include <malloc.h>

// +--------------------------------------------------------------------+

#ifndef FOUNDATION_USE_MFC
static Memory::LEVEL mem_chk_level = Memory::PERIODIC;
#endif

#ifdef _DEBUG
static _CrtMemState  mem_chk_p1,
                     mem_chk_p2;
#endif

static HANDLE        mem_log_file = 0;

// +--------------------------------------------------------------------+

#ifdef _DEBUG
#define CrtSetDebugField(a) _CrtSetDbgFlag((a)  | _CrtSetDbgFlag(_CRTDBG_REPORT_FLAG))
#define CrtClrDebugField(a) _CrtSetDbgFlag(~(a) & _CrtSetDbgFlag(_CRTDBG_REPORT_FLAG))
#endif

#ifdef FOUNDATION_USE_MFC

#ifndef _DEBUG

void* __cdecl operator new(unsigned int s, const char*, int)
{ 
	return ::operator new(s);
}

void  __cdecl operator delete(void* p, const char*, int)
{ 
	::operator delete(p);
}

#else

// No definitions for the following:
//void* __cdecl operator new(unsigned int s, const char*, int) {}
//void  __cdecl operator delete(void* p, const char*, int) {}

#endif

#else // if not defined FOUNDATION_USE_MFC

#ifndef _DEBUG

void* __cdecl operator new(unsigned int s, const char*, int)
{ 
	return ::operator new(s);
}

void  __cdecl operator delete(void* p, const char*, int)
{ 
	::operator delete(p);
}

#else

// No definitions for the following:
//void* __cdecl operator new(unsigned int, int, const char*, int) {}

void* __cdecl operator new(unsigned int s, const char* f, int l)
{
	return ::operator new(s, 1, f, l);
}

void* __cdecl operator new(unsigned int s)
{
	return ::operator new(s, 1, __FILE__, __LINE__);
}

void  __cdecl operator delete(void* p, const char*, int)
{
	::operator delete(p);
}

#endif  // _DEBUG

#endif  // FOUNDATION_USE_MFC

static void heapdump()
{
   _HEAPINFO   hinfo;
   int         heapstatus;
   DWORD       used  = 0;
   DWORD       avail = 0;
   char        report[256];

   hinfo._pentry = NULL;
   while ((heapstatus = _heapwalk( &hinfo )) == _HEAPOK) { 
      sprintf_s(report, "%6s block at %Fp of size %4.4X\n",
               ( hinfo._useflag == _USEDENTRY ? "USED" : "FREE" ),
                 hinfo._pentry, hinfo._size);

      _RPT0(_CRT_WARN, report);

      if (hinfo._useflag == _USEDENTRY)
         used  += hinfo._size;
      else
         avail += hinfo._size;
   }

   sprintf_s(report, "------\nUsed Blocks:  %d\nAvail Blocks: %d\nTotal Blocks: %d\n", used, avail, used+avail); //-V576
   _RPT0(_CRT_WARN, report);

   switch (heapstatus) {
   case _HEAPEMPTY:
      _RPT0(_CRT_WARN,  "OK - empty heap\n" );
      break;
   case _HEAPEND:
      _RPT0(_CRT_WARN,  "OK - end of heap\n" );
      break;
   case _HEAPBADPTR:
      _RPT0(_CRT_WARN,  "ERROR - bad pointer to heap\n" );
      break;
   case _HEAPBADBEGIN:
      _RPT0(_CRT_WARN,  "ERROR - bad start of heap\n" );
      break;
   case _HEAPBADNODE:
      _RPT0(_CRT_WARN,  "ERROR - bad node in heap\n" );
      break;
   }
}

// +--------------------------------------------------------------------+

#ifndef FOUNDATION_USE_MFC
void
Memory::OpenLog(const char* filename)
{
#ifdef _DEBUG
   if (!filename || !strlen(filename))
      filename = "memdbg.txt";

   mem_log_file = CreateFile(filename, GENERIC_WRITE, 0, 0, CREATE_ALWAYS, 0, 0);
   
   if (mem_log_file) {
      _CrtSetReportMode(_CRT_WARN,   _CRTDBG_MODE_FILE | _CRTDBG_MODE_DEBUG);
      _CrtSetReportFile(_CRT_WARN,   mem_log_file);
      _CrtSetReportMode(_CRT_ERROR,  _CRTDBG_MODE_FILE | _CRTDBG_MODE_DEBUG);
      _CrtSetReportFile(_CRT_ERROR,  mem_log_file);
      _CrtSetReportMode(_CRT_ASSERT, _CRTDBG_MODE_FILE | _CRTDBG_MODE_DEBUG);
      _CrtSetReportFile(_CRT_ASSERT, mem_log_file);
   }

   _CrtMemCheckpoint(&mem_chk_p1);
#endif
}

// +--------------------------------------------------------------------+

void
Memory::CloseLog()
{
#ifdef _DEBUG
   if (mem_log_file) {
      CloseHandle(mem_log_file);
      mem_log_file = 0;

      _CrtSetReportMode(_CRT_WARN,   _CRTDBG_MODE_FILE);
      _CrtSetReportFile(_CRT_WARN,   _CRTDBG_FILE_STDOUT);
      _CrtSetReportMode(_CRT_ERROR,  _CRTDBG_MODE_FILE);
      _CrtSetReportFile(_CRT_ERROR,  _CRTDBG_FILE_STDOUT);
      _CrtSetReportMode(_CRT_ASSERT, _CRTDBG_MODE_FILE);
      _CrtSetReportFile(_CRT_ASSERT, _CRTDBG_FILE_STDOUT);
   }
#endif   
}

// +--------------------------------------------------------------------+

void
Memory::Check()
{
#ifdef _DEBUG
   if (! _CrtCheckMemory()) {
      _RPT0(_CRT_ERROR, "\n\nMemory Check Failed.\n");
      heapdump();
      Checkpoint();
      _asm { int 3 }
      exit(1111);
   }
#endif   
}

// +--------------------------------------------------------------------+

void
Memory::Checkpoint()
{
#ifdef _DEBUG
   if (mem_chk_level < PERIODIC) return;

   _RPT0(_CRT_WARN, "\n\nMemory Checkpoint:\n"
         "--------------------------------------------------\n");

   _CrtMemState s;
   _CrtMemCheckpoint(&mem_chk_p2);
   _CrtMemDifference(&s, &mem_chk_p1, &mem_chk_p2);
   _CrtMemDumpStatistics(&s);
   
   memcpy(&mem_chk_p1, &mem_chk_p2, sizeof(mem_chk_p1));
#endif   
}

// +--------------------------------------------------------------------+

void
Memory::Stats()
{
#ifdef _DEBUG
   if (mem_chk_level < PERIODIC) return;

   _RPT0(_CRT_WARN, "\n\nMemory Stats:\n"
         "--------------------------------------------------\n");

   _CrtMemState s;
   _CrtMemCheckpoint(&s);
   _CrtMemDumpStatistics(&s);
#endif   
}

// +--------------------------------------------------------------------+

void
Memory::DumpLeaks()
{
#ifdef _DEBUG
   _RPT0(_CRT_WARN, "\n\nMemory Dump Leaks:\n"
         "--------------------------------------------------\n");
   _CrtDumpMemoryLeaks();
#endif   
}

// +--------------------------------------------------------------------+

void
Memory::SetLevel(LEVEL l)
{
#ifdef _DEBUG
   mem_chk_level = l;
   
   _CrtSetDbgFlag(0);
   
   switch (mem_chk_level) {
   case MAXIMAL:  CrtSetDebugField(_CRTDBG_CHECK_ALWAYS_DF);
   case PERIODIC: CrtSetDebugField(_CRTDBG_DELAY_FREE_MEM_DF);
   case LEAKS:    CrtSetDebugField(_CRTDBG_LEAK_CHECK_DF);
   case OFF:      
   default:       break;
   }
#endif   
}

#endif