mirror of https://github.com/tongzx/nt5src
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
572 lines
13 KiB
572 lines
13 KiB
/****************************************************************************
|
|
|
|
Copyright (c) Microsoft Corporation 1997
|
|
All rights reserved
|
|
|
|
File: DEBUG.CPP
|
|
|
|
Debugging utilities
|
|
|
|
***************************************************************************/
|
|
|
|
#include "pch.h"
|
|
|
|
DEFINE_MODULE("Debugging");
|
|
|
|
#ifdef DEBUG
|
|
|
|
// Constants
|
|
#define DEBUG_OUTPUT_BUFFER_SIZE 512
|
|
|
|
// Globals
|
|
DWORD g_TraceMemoryIndex = 0;
|
|
DWORD g_dwCounter = 0;
|
|
DWORD g_dwTraceFlags = TF_FUNC | TF_CALLS;
|
|
|
|
// Statics
|
|
static const TCHAR g_szNULL[] = TEXT("");
|
|
static const TCHAR g_szTrue[] = TEXT("True");
|
|
static const TCHAR g_szFalse[] = TEXT("False");
|
|
static const TCHAR g_szFormat[] = TEXT("%-40s %-10.10s ");
|
|
static const TCHAR g_szUnknown[] = TEXT("<unknown>");
|
|
|
|
//
|
|
// Debugging strrchr( )
|
|
//
|
|
LPCTSTR
|
|
dbgstrrchr( LPCTSTR lpsz, char ch )
|
|
{
|
|
LPCTSTR psz = lpsz;
|
|
|
|
while ( *psz )
|
|
++psz;
|
|
|
|
while ( psz >= lpsz && *psz != ch )
|
|
--psz;
|
|
|
|
return psz;
|
|
|
|
}
|
|
|
|
//
|
|
// Adds 'g_dwCounter' spaces to debug spew
|
|
//
|
|
void
|
|
dbgspace( void )
|
|
{
|
|
DWORD dw;
|
|
for( dw = 1; dw < g_dwCounter; dw++ )
|
|
DebugMsg( TEXT("| ") );
|
|
}
|
|
|
|
//
|
|
// Takes the filename and line number and put them into a string buffer.
|
|
//
|
|
// NOTE: the buffer is assumed to be of size DEBUG_OUTPUT_BUFFER_SIZE.
|
|
//
|
|
LPTSTR
|
|
dbgmakefilelinestring(
|
|
LPTSTR pszBuf,
|
|
LPCTSTR pszFile,
|
|
UINT uLine )
|
|
{
|
|
LPVOID args[2];
|
|
|
|
args[0] = (LPVOID) pszFile;
|
|
args[1] = (LPVOID) uLine;
|
|
|
|
FormatMessage(
|
|
FORMAT_MESSAGE_FROM_STRING |
|
|
FORMAT_MESSAGE_ARGUMENT_ARRAY,
|
|
TEXT("%1(%2!u!):"),
|
|
0, // error code
|
|
0, // default language
|
|
(LPTSTR) pszBuf, // output buffer
|
|
DEBUG_OUTPUT_BUFFER_SIZE, // size of buffer
|
|
(va_list*) &args ); // arguments
|
|
|
|
return pszBuf;
|
|
}
|
|
|
|
|
|
|
|
//
|
|
// TraceMsg()
|
|
//
|
|
void
|
|
TraceMsg(
|
|
DWORD dwCheckFlags,
|
|
LPCTSTR pszFormat,
|
|
... )
|
|
{
|
|
va_list valist;
|
|
|
|
if (( dwCheckFlags == TF_ALWAYS
|
|
|| !!( g_dwTraceFlags & dwCheckFlags ) ))
|
|
{
|
|
TCHAR szBuf[ DEBUG_OUTPUT_BUFFER_SIZE ];
|
|
|
|
va_start( valist, pszFormat );
|
|
wvsprintf( szBuf, pszFormat, valist );
|
|
va_end( valist );
|
|
|
|
OutputDebugString( szBuf );
|
|
}
|
|
}
|
|
|
|
//
|
|
// TraceMessage()
|
|
//
|
|
void
|
|
TraceMessage(
|
|
LPCTSTR pszFile,
|
|
UINT uLine,
|
|
LPCTSTR pszModule,
|
|
DWORD dwCheckFlags,
|
|
LPCTSTR pszFormat,
|
|
... )
|
|
{
|
|
va_list valist;
|
|
|
|
if (( dwCheckFlags == TF_ALWAYS
|
|
|| !!( g_dwTraceFlags & dwCheckFlags ) ))
|
|
{
|
|
TCHAR szBuf[ DEBUG_OUTPUT_BUFFER_SIZE ];
|
|
|
|
if ( !pszModule )
|
|
{
|
|
pszModule = g_szUnknown;
|
|
}
|
|
|
|
if ( !pszFile )
|
|
{
|
|
wsprintf( szBuf, g_szFormat, g_szNULL, pszModule );
|
|
}
|
|
else
|
|
{
|
|
TCHAR szFileLine[ DEBUG_OUTPUT_BUFFER_SIZE ];
|
|
|
|
dbgmakefilelinestring( szFileLine, pszFile, uLine );
|
|
wsprintf( szBuf, g_szFormat, szFileLine, pszModule );
|
|
}
|
|
|
|
OutputDebugString( szBuf );
|
|
|
|
dbgspace( );
|
|
|
|
va_start( valist, pszFormat );
|
|
wvsprintf( szBuf, pszFormat, valist );
|
|
va_end( valist );
|
|
|
|
OutputDebugString( szBuf );
|
|
}
|
|
|
|
}
|
|
|
|
//
|
|
// DebugMessage()
|
|
//
|
|
void
|
|
DebugMessage(
|
|
LPCTSTR pszFile,
|
|
UINT uLine,
|
|
LPCTSTR pszModule,
|
|
LPCTSTR pszFormat,
|
|
... )
|
|
{
|
|
va_list valist;
|
|
TCHAR szBuf[ DEBUG_OUTPUT_BUFFER_SIZE ];
|
|
|
|
if ( !pszModule )
|
|
{
|
|
pszModule = g_szUnknown;
|
|
}
|
|
|
|
if ( !pszFile )
|
|
{
|
|
wsprintf( szBuf, g_szFormat, g_szNULL, pszModule );
|
|
}
|
|
else
|
|
{
|
|
TCHAR szFileLine[ DEBUG_OUTPUT_BUFFER_SIZE ];
|
|
|
|
dbgmakefilelinestring( szFileLine, pszFile, uLine );
|
|
wsprintf( szBuf, g_szFormat, szFileLine, pszModule );
|
|
}
|
|
|
|
OutputDebugString( szBuf );
|
|
|
|
dbgspace( );
|
|
|
|
va_start( valist, pszFormat );
|
|
wvsprintf( szBuf, pszFormat, valist );
|
|
va_end( valist );
|
|
|
|
OutputDebugString( szBuf );
|
|
|
|
}
|
|
|
|
//
|
|
// DebugMsg()
|
|
//
|
|
void
|
|
DebugMsg(
|
|
LPCTSTR pszFormat,
|
|
... )
|
|
{
|
|
va_list valist;
|
|
TCHAR szBuf[ DEBUG_OUTPUT_BUFFER_SIZE ];
|
|
|
|
va_start( valist, pszFormat );
|
|
wvsprintf( szBuf, pszFormat, valist);
|
|
va_end( valist );
|
|
|
|
OutputDebugString( szBuf );
|
|
}
|
|
|
|
|
|
//
|
|
// Displays a dialog box with the failed assertion. User has the option of
|
|
// breaking.
|
|
//
|
|
BOOL
|
|
AssertMessage(
|
|
LPCTSTR pszFile,
|
|
UINT uLine,
|
|
LPCTSTR pszModule,
|
|
LPCTSTR pszfn,
|
|
BOOL fTrue )
|
|
{
|
|
if ( !fTrue )
|
|
{
|
|
TCHAR szBuf[ DEBUG_OUTPUT_BUFFER_SIZE ];
|
|
TCHAR szFileLine[ DEBUG_OUTPUT_BUFFER_SIZE ];
|
|
|
|
// Make sure everything is cool before we blow up somewhere else.
|
|
if ( pszFile == NULL )
|
|
{
|
|
pszFile = g_szNULL;
|
|
}
|
|
|
|
if ( pszModule == NULL )
|
|
{
|
|
pszModule = g_szNULL;
|
|
}
|
|
|
|
if ( pszfn == NULL )
|
|
{
|
|
pszfn = g_szNULL;
|
|
}
|
|
|
|
dbgmakefilelinestring( szFileLine, pszFile, uLine );
|
|
|
|
wsprintf( szBuf, TEXT("%-40s %-10s ASSERT: %s\n"),
|
|
szFileLine, pszModule, pszfn );
|
|
|
|
OutputDebugString( szBuf );
|
|
|
|
wsprintf( szBuf, TEXT("Module:\t%s\t\nLine:\t%u\t\nFile:\t%s\t\n\nAssertion:\t%s\t\n\nDo you want to break here?"),
|
|
pszModule, uLine, pszFile, pszfn );
|
|
|
|
if ( IDNO == MessageBox( NULL, szBuf, TEXT("Assertion Failed!"),
|
|
MB_YESNO|MB_ICONWARNING ) )
|
|
return FALSE; // don't break
|
|
}
|
|
|
|
return !fTrue;
|
|
|
|
}
|
|
|
|
//
|
|
// Traces HRESULT errors. A dialog will appear is there is an error
|
|
// in the hr.
|
|
//
|
|
HRESULT
|
|
TraceHR(
|
|
LPCTSTR pszFile,
|
|
UINT uLine,
|
|
LPCTSTR pszModule,
|
|
LPCTSTR pszfn,
|
|
HRESULT hr )
|
|
{
|
|
if ( hr )
|
|
{
|
|
TCHAR szBuf[ DEBUG_OUTPUT_BUFFER_SIZE ];
|
|
TCHAR szFileLine[ DEBUG_OUTPUT_BUFFER_SIZE ];
|
|
LPTSTR pszMsgBuf;
|
|
|
|
switch ( hr )
|
|
{
|
|
case S_FALSE:
|
|
pszMsgBuf = TEXT("S_FALSE\n");
|
|
break;
|
|
|
|
default:
|
|
FormatMessage(
|
|
FORMAT_MESSAGE_ALLOCATE_BUFFER
|
|
| FORMAT_MESSAGE_FROM_SYSTEM,
|
|
NULL,
|
|
hr,
|
|
MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
|
|
(LPTSTR)&pszMsgBuf,
|
|
0,
|
|
NULL
|
|
);
|
|
}
|
|
|
|
// Make sure everything is cool before we blow up somewhere else.
|
|
Assert( pszMsgBuf != NULL );
|
|
Assert( pszFile != NULL );
|
|
Assert( pszModule != NULL );
|
|
Assert( pszfn != NULL );
|
|
|
|
dbgmakefilelinestring( szFileLine, pszFile, uLine );
|
|
|
|
wsprintf( szBuf, TEXT("%-40s %-10s HRESULT: hr = 0x%08x - %s"),
|
|
szFileLine, pszModule, hr, pszMsgBuf );
|
|
|
|
OutputDebugString( szBuf );
|
|
|
|
wsprintf( szBuf, TEXT("Module:\t%s\t\nLine:\t%u\t\nFile:\t%s\t\n\nFunction:\t%s\t\nhr =\t0x%08x - %s\t\nDo you want to break here?"),
|
|
pszModule, uLine, pszFile, pszfn, hr, pszMsgBuf );
|
|
|
|
if ( IDYES == MessageBox( NULL, szBuf, TEXT("Trace HRESULT"),
|
|
MB_YESNO|MB_ICONWARNING ) )
|
|
DEBUG_BREAK;
|
|
|
|
LocalFree( pszMsgBuf );
|
|
|
|
}
|
|
|
|
return hr;
|
|
|
|
}
|
|
|
|
|
|
//
|
|
// Memory allocation and tracking
|
|
//
|
|
|
|
typedef struct _MEMORYBLOCK {
|
|
HGLOBAL hglobal;
|
|
DWORD dwBytes;
|
|
UINT uFlags;
|
|
LPCTSTR pszFile;
|
|
UINT uLine;
|
|
LPCTSTR pszModule;
|
|
LPCTSTR pszComment;
|
|
struct _MEMORYBLOCK *pNext;
|
|
} MEMORYBLOCK, *LPMEMORYBLOCK;
|
|
|
|
//
|
|
// Adds a MEMORYBLOCK to the memory tracking list.
|
|
//
|
|
HGLOBAL
|
|
DebugMemoryAdd(
|
|
HGLOBAL hglobal,
|
|
LPCTSTR pszFile,
|
|
UINT uLine,
|
|
LPCTSTR pszModule,
|
|
UINT uFlags,
|
|
DWORD dwBytes,
|
|
LPCTSTR pszComment )
|
|
{
|
|
if ( hglobal )
|
|
{
|
|
LPMEMORYBLOCK pmbHead = (LPMEMORYBLOCK) TlsGetValue( g_TraceMemoryIndex );
|
|
LPMEMORYBLOCK pmb = (LPMEMORYBLOCK) GlobalAlloc(
|
|
GMEM_FIXED,
|
|
sizeof(MEMORYBLOCK) );
|
|
|
|
if ( !pmb )
|
|
{
|
|
GlobalFree( hglobal );
|
|
return NULL;
|
|
}
|
|
|
|
pmb->hglobal = hglobal;
|
|
pmb->dwBytes = dwBytes;
|
|
pmb->uFlags = uFlags;
|
|
pmb->pszFile = pszFile;
|
|
pmb->uLine = uLine;
|
|
pmb->pszModule = pszModule;
|
|
pmb->pszComment = pszComment;
|
|
pmb->pNext = pmbHead;
|
|
|
|
TlsSetValue( g_TraceMemoryIndex, pmb );
|
|
}
|
|
|
|
return hglobal;
|
|
}
|
|
|
|
//
|
|
// Removes a MEMORYBLOCK to the memory tracking list.
|
|
//
|
|
void
|
|
DebugMemoryDelete(
|
|
HGLOBAL hglobal )
|
|
{
|
|
if ( hglobal )
|
|
{
|
|
LPMEMORYBLOCK pmbHead = (LPMEMORYBLOCK) TlsGetValue( g_TraceMemoryIndex );
|
|
LPMEMORYBLOCK pmbLast = NULL;
|
|
|
|
while ( pmbHead && pmbHead->hglobal != hglobal )
|
|
{
|
|
pmbLast = pmbHead;
|
|
pmbHead = pmbLast->pNext;
|
|
}
|
|
|
|
if ( pmbHead )
|
|
{
|
|
if ( pmbLast )
|
|
{
|
|
pmbLast->pNext = pmbHead->pNext;
|
|
}
|
|
else
|
|
{
|
|
TlsSetValue( g_TraceMemoryIndex, pmbHead->pNext );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
//
|
|
// Allocates memory and adds the MEMORYBLOCK to the memory tracking list.
|
|
//
|
|
HGLOBAL
|
|
DebugAlloc(
|
|
LPCTSTR pszFile,
|
|
UINT uLine,
|
|
LPCTSTR pszModule,
|
|
UINT uFlags,
|
|
DWORD dwBytes,
|
|
LPCTSTR pszComment )
|
|
{
|
|
HGLOBAL hglobal = GlobalAlloc( uFlags, dwBytes );
|
|
|
|
return DebugMemoryAdd( hglobal, pszFile, uLine, pszModule, uFlags, dwBytes, pszComment );
|
|
}
|
|
|
|
//
|
|
// Remove the MEMORYBLOCK to the memory tracking list, memsets the
|
|
// memory to 0xFE and then frees the memory.
|
|
//
|
|
HGLOBAL
|
|
DebugFree(
|
|
HGLOBAL hglobal )
|
|
{
|
|
DebugMemoryDelete( hglobal );
|
|
|
|
return GlobalFree( hglobal );
|
|
}
|
|
|
|
//
|
|
// Checks the memory tracking list. If it is not empty, it will dump the
|
|
// list and break.
|
|
//
|
|
void
|
|
DebugMemoryCheck( )
|
|
{
|
|
BOOL fFoundLeak = FALSE;
|
|
LPMEMORYBLOCK pmb = (LPMEMORYBLOCK) TlsGetValue( g_TraceMemoryIndex );
|
|
|
|
while ( pmb )
|
|
{
|
|
LPVOID args[ 5 ];
|
|
TCHAR szOutput[ DEBUG_OUTPUT_BUFFER_SIZE ];
|
|
TCHAR szFileLine[ DEBUG_OUTPUT_BUFFER_SIZE ];
|
|
|
|
if ( fFoundLeak == FALSE )
|
|
{
|
|
OutputDebugString(TEXT("\n***************************** Memory leak detected *****************************\n\n"));
|
|
//OutputDebugString("1234567890123456789012345678901234567890 1234567890 X 0x12345678 12345 1...");
|
|
OutputDebugString(TEXT("Filename(Line Number): Module Addr/HGLOBAL Size String\n"));
|
|
fFoundLeak = TRUE;
|
|
}
|
|
|
|
args[0] = (LPVOID) pmb->hglobal;
|
|
args[1] = (LPVOID) &szFileLine;
|
|
args[2] = (LPVOID) pmb->pszComment;
|
|
args[3] = (LPVOID) pmb->dwBytes;
|
|
args[4] = (LPVOID) pmb->pszModule;
|
|
|
|
dbgmakefilelinestring( szFileLine, pmb->pszFile, pmb->uLine );
|
|
|
|
if ( !!(pmb->uFlags & GMEM_MOVEABLE) )
|
|
{
|
|
FormatMessage(
|
|
FORMAT_MESSAGE_FROM_STRING |
|
|
FORMAT_MESSAGE_ARGUMENT_ARRAY,
|
|
TEXT("%2!-40s! %5!-10s! H 0x%1!08x! %4!-5u! \"%3\"\n"),
|
|
0, // error code
|
|
0, // default language
|
|
(LPTSTR) &szOutput, // output buffer
|
|
ARRAYSIZE( szOutput ), // size of buffer
|
|
(va_list*) &args ); // arguments
|
|
}
|
|
else
|
|
{
|
|
FormatMessage(
|
|
FORMAT_MESSAGE_FROM_STRING |
|
|
FORMAT_MESSAGE_ARGUMENT_ARRAY,
|
|
TEXT("%2!-40s! %5!-10s! A 0x%1!08x! %4!-5u! \"%3\"\n"),
|
|
0, // error code
|
|
0, // default language
|
|
(LPTSTR) &szOutput, // output buffer
|
|
ARRAYSIZE( szOutput ), // size of buffer
|
|
(va_list*) &args ); // arguments
|
|
}
|
|
|
|
OutputDebugString( szOutput );
|
|
|
|
pmb = pmb->pNext;
|
|
}
|
|
|
|
if ( fFoundLeak == TRUE )
|
|
{
|
|
OutputDebugString(TEXT("\n***************************** Memory leak detected *****************************\n\n"));
|
|
}
|
|
|
|
Assert( !fFoundLeak );
|
|
}
|
|
|
|
//
|
|
// Global Management Functions -
|
|
//
|
|
// These are in debug and retail but are internally they change
|
|
// depending on the build.
|
|
//
|
|
|
|
#if 0
|
|
void * __cdecl operator new(unsigned int t_size )
|
|
{
|
|
return DebugAlloc( TEXT(__FILE__), __LINE__, g_szModule, GPTR, t_size, TEXT("new()") );
|
|
}
|
|
|
|
void __cdecl operator delete(void *pv)
|
|
{
|
|
TraceFree( pv );
|
|
}
|
|
#endif
|
|
|
|
#else // ! DEBUG -- It's retail
|
|
|
|
//
|
|
// Global Management Functions -
|
|
//
|
|
// These are in debug and retail but are internally they change
|
|
// depending on the build.
|
|
//
|
|
#if 0
|
|
void * __cdecl operator new(unsigned int t_size )
|
|
{
|
|
return LocalAlloc( GPTR, t_size );
|
|
}
|
|
|
|
void __cdecl operator delete(void *pv)
|
|
{
|
|
LocalFree( pv );
|
|
}
|
|
#endif
|
|
#endif // DEBUG
|