X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f13b39c0c3064fb073276370488161ca194839d4..035fa7f78c8915a24114d26728fa805773f2c4b5:/src/common/memory.cpp?ds=sidebyside diff --git a/src/common/memory.cpp b/src/common/memory.cpp index 45d0b50816..4253bae38e 100644 --- a/src/common/memory.cpp +++ b/src/common/memory.cpp @@ -1,80 +1,57 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: memory.cpp +// Name: src/common/memory.cpp // Purpose: Memory checking implementation // Author: Arthur Seaton, Julian Smart // Modified by: // Created: 04/01/98 // RCS-ID: $Id$ -// Copyright: (c) Julian Smart and Markus Holzem -// Licence: wxWindows license +// Copyright: (c) Julian Smart +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ -#pragma implementation "memory.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ -#pragma hdrstop -#endif - -#ifndef WX_PRECOMP -#include "wx/defs.h" + #pragma hdrstop #endif -#if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT +#if wxUSE_MEMORY_TRACING || wxUSE_DEBUG_CONTEXT -#ifdef __GNUG__ -// #pragma implementation -#endif +#include "wx/memory.h" #ifndef WX_PRECOMP -#include "wx/utils.h" -#include "wx/app.h" + #ifdef __WXMSW__ + #include "wx/msw/wrapwin.h" + #endif + #include "wx/utils.h" + #include "wx/app.h" + #include "wx/hash.h" + #include "wx/log.h" #endif #if wxUSE_THREADS -#include "wx/thread.h" + #include "wx/thread.h" #endif -#include "wx/log.h" #include #include "wx/ioswrap.h" -// Obsolete -#if 0 -#if wxUSE_IOSTREAMH - #include -#else - #include -#endif -#endif - #if !defined(__WATCOMC__) && !(defined(__VMS__) && ( __VMS_VER < 70000000 ) )\ - && !defined( __MWERKS__ ) && !defined(__SALFORDC__) + && !defined( __MWERKS__ ) #include #endif #include #include -#ifdef __WXMSW__ -#include - -#ifdef GetClassInfo -#undef GetClassInfo -#endif - -#ifdef GetClassName -#undef GetClassName -#endif - +#if wxUSE_THREADS +#define USE_THREADSAFE_MEMORY_ALLOCATION 1 +#else +#define USE_THREADSAFE_MEMORY_ALLOCATION 0 #endif -#include "wx/memory.h" #ifdef new #undef new @@ -118,7 +95,7 @@ */ void wxMemStruct::ErrorMsg (const char * mesg) { - wxLogMessage(wxT("wxWindows memory checking error: %s"), mesg); + wxLogMessage(wxT("wxWidgets memory checking error: %s"), mesg); PrintNode (); } @@ -127,7 +104,7 @@ void wxMemStruct::ErrorMsg (const char * mesg) */ void wxMemStruct::ErrorMsg () { - wxLogMessage(wxT("wxWindows over/underwrite memory error:")); + wxLogMessage(wxT("wxWidgets over/underwrite memory error:")); PrintNode (); } @@ -141,8 +118,9 @@ void wxMemStruct::ErrorMsg () */ int wxMemStruct::AssertList () { - if (wxDebugContext::GetHead () != 0 && ! (wxDebugContext::GetHead ())->AssertIt () || - wxDebugContext::GetTail () != 0 && ! wxDebugContext::GetTail ()->AssertIt ()) { + if ((wxDebugContext::GetHead() && !wxDebugContext::GetHead()->AssertIt()) || + (wxDebugContext::GetTail() && !wxDebugContext::GetTail()->AssertIt())) + { ErrorMsg ("Head or tail pointers trashed"); return 0; } @@ -333,7 +311,7 @@ void wxMemStruct::PrintNode () // Let's put this in standard form so IDEs can load the file at the appropriate // line - wxString msg(wxT("")); + wxString msg; if (m_fileName) msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum); @@ -344,20 +322,20 @@ void wxMemStruct::PrintNode () msg += wxT("object"); wxString msg2; - msg2.Printf(wxT(" at $%lX, size %d"), (long)GetActualData(), (int)RequestSize()); + msg2.Printf(wxT(" at 0x%lX, size %d"), (long)GetActualData(), (int)RequestSize()); msg += msg2; wxLogMessage(msg); } else { - wxString msg(""); + wxString msg; if (m_fileName) msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum); msg += wxT("non-object data"); wxString msg2; - msg2.Printf(wxT(" at $%lX, size %d\n"), (long)GetActualData(), (int)RequestSize()); + msg2.Printf(wxT(" at 0x%lX, size %d\n"), (long)GetActualData(), (int)RequestSize()); msg += msg2; wxLogMessage(msg); @@ -372,7 +350,7 @@ void wxMemStruct::Dump () { wxObject *obj = (wxObject *)m_actualData; - wxString msg(wxT("")); + wxString msg; if (m_fileName) msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum); @@ -389,22 +367,22 @@ void wxMemStruct::Dump () else msg += wxT("unknown object class"); - wxString msg2(""); - msg2.Printf(wxT(" at $%lX, size %d"), (long)GetActualData(), (int)RequestSize()); + wxString msg2; + msg2.Printf(wxT(" at 0x%lX, size %d"), (long)GetActualData(), (int)RequestSize()); msg += msg2; - wxLogMessage(msg); + wxDebugContext::OutputDumpLine(msg.c_str()); } else { - wxString msg(wxT("")); + wxString msg; if (m_fileName) msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum); - wxString msg2(""); - msg2.Printf(wxT("non-object data at $%lX, size %d"), (long)GetActualData(), (int)RequestSize() ); + wxString msg2; + msg2.Printf(wxT("non-object data at 0x%lX, size %d"), (long)GetActualData(), (int)RequestSize() ); msg += msg2; - wxLogMessage(msg); + wxDebugContext::OutputDumpLine(msg.c_str()); } } @@ -465,9 +443,9 @@ int wxMemStruct::ValidateNode () wxMemStruct *wxDebugContext::m_head = NULL; wxMemStruct *wxDebugContext::m_tail = NULL; -bool wxDebugContext::m_checkPrevious = FALSE; +bool wxDebugContext::m_checkPrevious = false; int wxDebugContext::debugLevel = 1; -bool wxDebugContext::debugOn = TRUE; +bool wxDebugContext::debugOn = true; wxMemStruct *wxDebugContext::checkPoint = NULL; // For faster alignment calculation @@ -475,6 +453,9 @@ static wxMarkerType markerCalc[2]; int wxDebugContext::m_balign = (int)((char *)&markerCalc[1] - (char*)&markerCalc[0]); int wxDebugContext::m_balignmask = (int)((char *)&markerCalc[1] - (char*)&markerCalc[0]) - 1; +// Pointer to global function to call at shutdown +wxShutdownNotifyFunction wxDebugContext::sm_shutdownFn; + wxDebugContext::wxDebugContext(void) { } @@ -595,45 +576,36 @@ void wxDebugContext::TraverseList (PmSFV func, wxMemStruct *from) */ bool wxDebugContext::PrintList (void) { -#ifdef __WXDEBUG__ - TraverseList ((PmSFV)&wxMemStruct::PrintNode, (checkPoint ? checkPoint->m_next : (wxMemStruct*)NULL)); + TraverseList ((PmSFV)&wxMemStruct::PrintNode, (checkPoint ? checkPoint->m_next : NULL)); - return TRUE; -#else - return FALSE; -#endif + return true; } bool wxDebugContext::Dump(void) { -#ifdef __WXDEBUG__ { - wxChar* appName = (wxChar*) wxT("application"); - wxString appNameStr(""); + const wxChar* appName = wxT("application"); + wxString appNameStr; if (wxTheApp) { appNameStr = wxTheApp->GetAppName(); - appName = WXSTRINGCAST appNameStr; - wxLogMessage(wxT("----- Memory dump of %s at %s -----"), appName, WXSTRINGCAST wxNow() ); + appName = appNameStr.c_str(); + OutputDumpLine(wxT("----- Memory dump of %s at %s -----"), appName, static_cast(wxNow().c_str())); } else { - wxLogMessage( wxT("----- Memory dump -----") ); + OutputDumpLine( wxT("----- Memory dump -----") ); } } - TraverseList ((PmSFV)&wxMemStruct::Dump, (checkPoint ? checkPoint->m_next : (wxMemStruct*)NULL)); + TraverseList ((PmSFV)&wxMemStruct::Dump, (checkPoint ? checkPoint->m_next : NULL)); - wxLogMessage( wxT("") ); - wxLogMessage( wxT("") ); + OutputDumpLine(wxEmptyString); + OutputDumpLine(wxEmptyString); - return TRUE; -#else - return FALSE; -#endif + return true; } -#ifdef __WXDEBUG__ struct wxDebugStatsStruct { long instanceCount; @@ -658,28 +630,26 @@ static wxDebugStatsStruct *InsertStatsStruct(wxDebugStatsStruct *head, wxDebugSt st->next = head; return st; } -#endif bool wxDebugContext::PrintStatistics(bool detailed) { -#ifdef __WXDEBUG__ { - wxChar* appName = (wxChar*) wxT("application"); - wxString appNameStr(wxT("")); + const wxChar* appName = wxT("application"); + wxString appNameStr; if (wxTheApp) { appNameStr = wxTheApp->GetAppName(); - appName = WXSTRINGCAST appNameStr; - wxLogMessage(wxT("----- Memory statistics of %s at %s -----"), appName, WXSTRINGCAST wxNow() ); + appName = appNameStr.c_str(); + OutputDumpLine(wxT("----- Memory statistics of %s at %s -----"), appName, static_cast(wxNow().c_str())); } else { - wxLogMessage( wxT("----- Memory statistics -----") ); + OutputDumpLine( wxT("----- Memory statistics -----") ); } } bool currentMode = GetDebugMode(); - SetDebugMode(FALSE); + SetDebugMode(false); long noNonObjectNodes = 0; long noObjectNodes = 0; @@ -687,7 +657,7 @@ bool wxDebugContext::PrintStatistics(bool detailed) wxDebugStatsStruct *list = NULL; - wxMemStruct *from = (checkPoint ? checkPoint->m_next : (wxMemStruct*)NULL ); + wxMemStruct *from = (checkPoint ? checkPoint->m_next : NULL ); if (!from) from = wxDebugContext::GetHead (); @@ -731,52 +701,47 @@ bool wxDebugContext::PrintStatistics(bool detailed) { while (list) { - wxLogMessage(wxT("%ld objects of class %s, total size %ld"), + OutputDumpLine(wxT("%ld objects of class %s, total size %ld"), list->instanceCount, list->instanceClass, list->totalSize); wxDebugStatsStruct *old = list; list = old->next; free((char *)old); } - wxLogMessage(wxT("")); + OutputDumpLine(wxEmptyString); } SetDebugMode(currentMode); - wxLogMessage(wxT("Number of object items: %ld"), noObjectNodes); - wxLogMessage(wxT("Number of non-object items: %ld"), noNonObjectNodes); - wxLogMessage(wxT("Total allocated size: %ld"), totalSize); - wxLogMessage(wxT("")); - wxLogMessage(wxT("")); + OutputDumpLine(wxT("Number of object items: %ld"), noObjectNodes); + OutputDumpLine(wxT("Number of non-object items: %ld"), noNonObjectNodes); + OutputDumpLine(wxT("Total allocated size: %ld"), totalSize); + OutputDumpLine(wxEmptyString); + OutputDumpLine(wxEmptyString); - return TRUE; -#else - (void)detailed; - return FALSE; -#endif + return true; } bool wxDebugContext::PrintClasses(void) { { - wxChar* appName = (wxChar*) wxT("application"); - wxString appNameStr(wxT("")); + const wxChar* appName = wxT("application"); + wxString appNameStr; if (wxTheApp) { appNameStr = wxTheApp->GetAppName(); - appName = WXSTRINGCAST appNameStr; + appName = appNameStr.c_str(); wxLogMessage(wxT("----- Classes in %s -----"), appName); } } int n = 0; - wxNode *node; - wxClassInfo *info; + const wxClassInfo *info; - wxClassInfo::sm_classTable->BeginFind(); - node = wxClassInfo::sm_classTable->Next(); - while (node) + for (wxClassInfo::const_iterator node = wxClassInfo::begin_classinfo(), + end = wxClassInfo::end_classinfo(); + node != end; ++node) { - info = (wxClassInfo *)node->Data(); + info = *node; if (info->GetClassName()) { wxString msg(info->GetClassName()); @@ -799,14 +764,13 @@ bool wxDebugContext::PrintClasses(void) wxLogMessage(msg); } - node = wxClassInfo::sm_classTable->Next(); n ++; } - wxLogMessage(wxT("")); + wxLogMessage(wxEmptyString); wxLogMessage(wxT("There are %d classes derived from wxObject."), n); - wxLogMessage(wxT("")); - wxLogMessage(wxT("")); - return TRUE; + wxLogMessage(wxEmptyString); + wxLogMessage(wxEmptyString); + return true; } void wxDebugContext::SetCheckpoint(bool all) @@ -822,7 +786,7 @@ int wxDebugContext::Check(bool checkAll) { int nFailures = 0; - wxMemStruct *from = (checkPoint ? checkPoint->m_next : (wxMemStruct*)NULL ); + wxMemStruct *from = (checkPoint ? checkPoint->m_next : NULL ); if (!from || checkAll) from = wxDebugContext::GetHead (); @@ -859,22 +823,55 @@ int wxDebugContext::CountObjectsLeft(bool sinceCheckpoint) return n ; } -#if wxUSE_THREADS -static bool memSectionOk = FALSE; +// This function is used to output the dump +void wxDebugContext::OutputDumpLine(const wxChar *szFormat, ...) +{ + // a buffer of 2048 bytes should be long enough for a file name + // and a class name + wxChar buf[2048]; + int count; + va_list argptr; + va_start(argptr, szFormat); + buf[WXSIZEOF(buf)-1] = wxT('\0'); + + // keep 3 bytes for a \r\n\0 + count = wxVsnprintf(buf, WXSIZEOF(buf)-3, szFormat, argptr); + + if ( count < 0 ) + count = WXSIZEOF(buf)-3; + buf[count]=wxT('\r'); + buf[count+1]=wxT('\n'); + buf[count+2]=wxT('\0'); + + wxMessageOutputDebug dbgout; + dbgout.Printf(buf); +} + +void wxDebugContext::SetShutdownNotifyFunction(wxShutdownNotifyFunction shutdownFn) +{ + sm_shutdownFn = shutdownFn; +} + + +#if USE_THREADSAFE_MEMORY_ALLOCATION +static bool memSectionOk = false; class MemoryCriticalSection : public wxCriticalSection { public: - MemoryCriticalSection() { - memSectionOk = TRUE; - } + MemoryCriticalSection() { + memSectionOk = true; + } + ~MemoryCriticalSection() { + memSectionOk = false; + } }; class MemoryCriticalSectionLocker { public: inline MemoryCriticalSectionLocker(wxCriticalSection& critsect) - : m_critsect(critsect), m_locked(memSectionOk) { if(m_locked) m_critsect.Enter(); } + : m_critsect(critsect), m_locked(memSectionOk) { if(m_locked) m_critsect.Enter(); } inline ~MemoryCriticalSectionLocker() { if(m_locked) m_critsect.Leave(); } private: @@ -883,16 +880,54 @@ private: MemoryCriticalSectionLocker& operator=(const MemoryCriticalSectionLocker&); wxCriticalSection& m_critsect; - bool m_locked; + bool m_locked; }; static MemoryCriticalSection memLocker; -#endif + +#endif // USE_THREADSAFE_MEMORY_ALLOCATION + + +#if !(defined(__WXMSW__) && (defined(WXUSINGDLL) || defined(WXMAKINGDLL_BASE))) +#if wxUSE_GLOBAL_MEMORY_OPERATORS +void * operator new (size_t size, wxChar * fileName, int lineNum) +{ + return wxDebugAlloc(size, fileName, lineNum, false, false); +} + +void * operator new (size_t size) +{ + return wxDebugAlloc(size, NULL, 0, false); +} + +void operator delete (void * buf) +{ + wxDebugFree(buf, false); +} + +#if wxUSE_ARRAY_MEMORY_OPERATORS +void * operator new[] (size_t size) +{ + return wxDebugAlloc(size, NULL, 0, false, true); +} + +void * operator new[] (size_t size, wxChar * fileName, int lineNum) +{ + return wxDebugAlloc(size, fileName, lineNum, false, true); +} + +void operator delete[] (void * buf) +{ + wxDebugFree(buf, true); +} +#endif // wxUSE_ARRAY_MEMORY_OPERATORS +#endif // wxUSE_GLOBAL_MEMORY_OPERATORS +#endif // !(defined(__WXMSW__) && (defined(WXUSINGDLL) || defined(WXMAKINGDLL_BASE))) // TODO: store whether this is a vector or not. void * wxDebugAlloc(size_t size, wxChar * fileName, int lineNum, bool isObject, bool WXUNUSED(isVect) ) { -#if wxUSE_THREADS +#if USE_THREADSAFE_MEMORY_ALLOCATION MemoryCriticalSectionLocker lock(memLocker); #endif @@ -952,7 +987,7 @@ void * wxDebugAlloc(size_t size, wxChar * fileName, int lineNum, bool isObject, // TODO: check whether was allocated as a vector void wxDebugFree(void * buf, bool WXUNUSED(isVect) ) { -#if wxUSE_THREADS +#if USE_THREADSAFE_MEMORY_ALLOCATION MemoryCriticalSectionLocker lock(memLocker); #endif @@ -1076,13 +1111,43 @@ void wxTraceLevel(int, const wxChar * ...) #endif } -#else // wxUSE_MEMORY_TRACING && defined(__WXDEBUG__) -void wxTrace(const char *WXUNUSED(fmt) ...) +//---------------------------------------------------------------------------- +// Final cleanup after all global objects in all files have been destroyed +//---------------------------------------------------------------------------- + +// Don't set it to 0 by dynamic initialization +// Some compilers will really do the assignment later +// All global variables are initialized to 0 at the very beginning, and this is just fine. +int wxDebugContextDumpDelayCounter::sm_count; + +wxDebugContextDumpDelayCounter::wxDebugContextDumpDelayCounter() { + sm_count++; } -void wxTraceLevel(int WXUNUSED(level), const char *WXUNUSED(fmt) ...) +wxDebugContextDumpDelayCounter::~wxDebugContextDumpDelayCounter() { + if ( !--sm_count ) + { + // Notify app if we've been asked to do that + if( wxDebugContext::sm_shutdownFn ) + wxDebugContext::sm_shutdownFn(); + DoDump(); + } } -#endif +void wxDebugContextDumpDelayCounter::DoDump() +{ + if (wxDebugContext::CountObjectsLeft(true) > 0) + { + wxDebugContext::OutputDumpLine(wxT("There were memory leaks.\n")); + wxDebugContext::Dump(); + wxDebugContext::PrintStatistics(); + } +} + +// Even if there is nothing else, make sure that there is at +// least one cleanup counter object +static wxDebugContextDumpDelayCounter wxDebugContextDumpDelayCounter_One; + +#endif // wxUSE_MEMORY_TRACING || wxUSE_DEBUG_CONTEXT