unknownworlds/ns
0
0
Fork 0
mirror of https://github.com/unknownworlds/NS.git synced 2024-11-15 09:11:55 +00:00
Code Issues Projects Releases Packages Wiki Activity
ns/main/source/util/Stacktrace.cpp
XP-Cagey 60007652a3 The big merge... 
git-svn-id: https://unknownworlds.svn.cloudforge.com/ns1@21 67975925-1194-0748-b3d5-c16f83f1a3a1
2005-04-01 03:04:57 +00:00

590 lines
No EOL
19 KiB
C++
Raw Blame History

// ZASSERT AND STACKTRACE are an improved assertion system which augments
// the WIN32 assert.h standard _assert.
// (c) 1999 Zachary B. Simpson
// Code may be used and distributed freely as long as all
// changes are noted appropriately.
#pragma warning(disable: 311 312 313)
#ifdef WIN32
#include "windows.h"
#endif
#include "stdio.h"
#include "string.h"
#include "stacktrace.h"
char *stackTrace( int skipAssert ) {
// Becuase this code may be running during a fatal,
// I am weary of allocating large buffers. Thus,
// the output will be written into this static
// buffer. Teh OUTS macro simplifies writing into it.
static char output[2048];
output[0] = 0;
#define OUTS sprintf( output+strlen(output),
#ifdef WIN32
// Get the exe name from the command line
// It is surrounded by quotes in some cases
char *exeName = GetCommandLine();
if( *exeName == '"' ) {
exeName++;
}
char *space = strchr( exeName, ' ' );
if( space ) {
*space = 0;
}
char *quote = strchr( exeName, '"' );
if( quote ) {
*quote = 0;
}
// Figure the base load address with GetModuleHandle
unsigned int baseAddress = (int)GetModuleHandle( NULL );
// Walk up the stack placing pointers to functions
// in the stackTrace array and pointers to argument
// lists into the argBase array.
#define STACK_TRACE_SIZE 30
unsigned int stackTrace[STACK_TRACE_SIZE];
unsigned int argBase[STACK_TRACE_SIZE];
int stackTraceCount = 0;
volatile unsigned int *currBP;
__asm mov [currBP], ebp;
try {
for( stackTraceCount=0; stackTraceCount<STACK_TRACE_SIZE; stackTraceCount++ ) {
argBase[stackTraceCount] = (unsigned)(currBP+2);
stackTrace[stackTraceCount] = *(currBP+1) - baseAddress;
currBP = (unsigned *)*(currBP);
}
}
catch( ... ) {
}
// memory map the exec file. This is done becuase
// it is much harder to parse in memory since it
// parts of it are moved around by the loader.
// Also, we must use CreateFile here because of file sharing
// since the file is currently opened by the process.
HANDLE hFile = CreateFile( exeName, GENERIC_READ, FILE_SHARE_READ,
NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0
);
if( hFile == INVALID_HANDLE_VALUE ) {
return NULL;
}
HANDLE hFileMapping = CreateFileMapping( hFile, NULL, PAGE_READONLY, 0, 0, NULL );
if( hFileMapping == NULL ) {
CloseHandle( hFile );
return NULL;
}
char *basePtr = (char *)MapViewOfFile( hFileMapping, FILE_MAP_READ, 0, 0, 0 );
if( basePtr == NULL ) {
CloseHandle( hFileMapping );
CloseHandle( hFile );
return NULL;
}
// Now parse the file extracting the debug information
// This involves quite a lot of header parsing
// Ultimately, we will find there three variables:
int numDebugFormats = 0;
// How many debug format are in this exe
int coffDebugInfoOffset = 0;
// where the coff debug info starts
IMAGE_DEBUG_DIRECTORY *debugDir = NULL;
// primary debug headers
// These two macros simplify traversing the structures
#define MAKEPTR(type, var, offset) type *var = (type *)(basePtr + offset)
// This macro help us make pointer relative to the base
#define SETPTR(type, var, offset) var = (type *)(basePtr + offset)
// This macro help us make pointer relative to the base
// Get pointers to the primary headers...
MAKEPTR( IMAGE_DOS_HEADER, dosHeader, 0 );
MAKEPTR( IMAGE_NT_HEADERS, ntHeader, dosHeader->e_lfanew );
// Go through each section looking for the .rdata section
for( int i=0; i<ntHeader->FileHeader.NumberOfSections; i++ ) {
IMAGE_SECTION_HEADER *secHead = &(IMAGE_FIRST_SECTION( ntHeader ))[i];
if( ! stricmp( (char *)&secHead->Name[0], ".rdata" ) ) {
numDebugFormats =
ntHeader->OptionalHeader.DataDirectory[IMAGE_DIRECTORY_ENTRY_DEBUG].Size
/ sizeof(IMAGE_DEBUG_DIRECTORY)
;
if( numDebugFormats != 0 ) {
SETPTR( IMAGE_DEBUG_DIRECTORY, debugDir,
secHead->PointerToRawData +
(
ntHeader->OptionalHeader.DataDirectory
[IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress
- secHead->VirtualAddress
)
);
break;
}
}
}
// Now have pointer to primary debug headers (debugDir) and
// a count of number of debug formats (numDebugFormats)
// Parse these to find the COFF headers
IMAGE_COFF_SYMBOLS_HEADER *coffHeader = 0;
for( i=0; i<numDebugFormats; i++, debugDir++ ) {
if(
debugDir->Type == IMAGE_DEBUG_TYPE_COFF &&
ntHeader->FileHeader.PointerToSymbolTable
) {
SETPTR( IMAGE_COFF_SYMBOLS_HEADER, coffHeader, debugDir->PointerToRawData );
break;
}
}
if( !coffHeader ) {
// There was not COFF debug information available.
OUTS "Stack symbol information only available "
"when linked with COFF debug symbols.\n"
"Dumping hex trace instead:\n"
);
for( i=0; i<stackTraceCount; i++ ) {
OUTS "%08X(", baseAddress+stackTrace[i] );
try {
int *a = (int *)argBase[i+1];
for( int j=0; j<5; j++, a++ ) {
OUTS "%s 0x%X", j==0?"":",", *a );
}
}
catch( ... ) { }
OUTS ")\r\n" );
}
CloseHandle( hFileMapping );
CloseHandle( hFile );
return output;
}
// Now have pointer to coff info. (coffHeader)
// Use this to find line numbers,
// IMAGE_LINENUMBER *lineNums = (IMAGE_LINENUMBER *)(
// (char *)coffHeader + coffHeader->LvaToFirstLinenumber
// );
// int count = coffHeader->NumberOfLinenumbers;
// for( i=0; i<count; i++, lineNums++ ) {
// printf( "Addr: %05X Line: %04X\n", lineNums->Type.VirtualAddress, lineNums->Linenumber );
// }
// Now extract the COFF symbol table
MAKEPTR( IMAGE_SYMBOL, coffSym, ntHeader->FileHeader.PointerToSymbolTable );
int coffSymbolCount = ntHeader->FileHeader.NumberOfSymbols;
// The string table apparently starts right after the symbol table
char *stringTable = (PSTR)&coffSym[coffSymbolCount];
// Becuase this code may be running during a fatal,
// I am weary of allocating large buffers. Thus, I perform
// this search without the help of any index or hash.
IMAGE_SYMBOL *matchingStackSymbols[STACK_TRACE_SIZE];
memset( matchingStackSymbols, 0, sizeof(IMAGE_SYMBOL *) * STACK_TRACE_SIZE );
IMAGE_SYMBOL *lastSymbol = coffSym++;
for( i=0; i<coffSymbolCount-1; i++ ) {
char *symName =
(char *)coffSym->N.Name.Short != 0 ?
(char *)coffSym->N.ShortName :
(char *)(stringTable + coffSym->N.Name.Long)
;
for( int j=0; j<stackTraceCount; j++ ) {
if(
stackTrace[j] < coffSym->Value &&
stackTrace[j] >= lastSymbol->Value &&
lastSymbol->Type == 0x20
) {
matchingStackSymbols[j] = lastSymbol;
}
}
lastSymbol = coffSym;
// Take into account any aux symbols
i += coffSym->NumberOfAuxSymbols;
coffSym += coffSym->NumberOfAuxSymbols;
coffSym++;
}
for( i=0; i<stackTraceCount; i++ ) {
if( matchingStackSymbols[i] == NULL ) {
OUTS "%X = Undefined Symbol\n", stackTrace[i] );
}
else {
char *symName =
(char *)matchingStackSymbols[i]->N.Name.Short != 0 ?
(char *)matchingStackSymbols[i]->N.ShortName :
(char *)(stringTable + matchingStackSymbols[i]->N.Name.Long)
;
char args[30]={0,};
char funcName[128]={0,};
char *open = NULL;
int numArgs = 0;
if( skipAssert && strstr(symName,"assert") ) {
continue;
}
// The function names are mangled, which tells us
// what the arguments are. Unfortunatly, the name
// demangler is not perfect (since I had to reverse
// engineer it). So in cases when it fails, we
// just print five arguments hoping that this is
// sufficient.
char *success = demangleMSDEVFuncName( symName, funcName, 128, args, 30, numArgs );
if( strstr( symName, "mainCRTStartup" ) ) {
break;
}
OUTS "%s(", funcName );
if( success ) {
// Name demangler succeeded. Print
// out a trace of the arguments. For
// pointer args, print out a small
// memory dump of that pointer
unsigned int *a = (unsigned int *)argBase[i+1];
for( int j=0; j<numArgs; j++, a++ ) {
try {
OUTS "%s ", j==0?"":"," );
switch( args[j] ) {
case 'D': case 'E': case 'F':
case 'G': case 'H': case 'I':
if( *a >= 0x10000 ) {
OUTS "0x%X", *a );
}
else {
OUTS "%d", *a );
}
break;
case 'M':
OUTS "%f", *a );
break;
case 'N':
// TODO
break;
case 'P':
OUTS "PTR(0x%X)", *a );
break;
default:
OUTS "?" );
}
}
catch( ... ) { }
}
}
else {
// The name demanagler failed, so just
// print 5 arguments under the theory that
// it is better than nothing.
OUTS "?? " );
int *a = (int *)argBase[i+1];
for( int j=0; j<5; j++, a++ ) {
OUTS "%s 0x%X", j==0?"":",", *a );
}
}
OUTS " )\n" );
if( success ) {
// Name mangler succeeded, go back and
// print out a hex dump for each pointer.
try {
int *a = (int *)argBase[i+1];
for( int j=0; j<numArgs; j++, a++ ) {
if( args[j] == 'P' ) {
unsigned char *ptr = (unsigned char *)*a;
if( ptr >= (unsigned char *)baseAddress ) {
for( int k=0; k<3; k++, ptr+=16 ) {
OUTS " %X: ", ptr );
for( int l=0; l<16; l++ ) OUTS "%02X ", ptr[l] );
OUTS " " );
for( l=0; l<16; l++ ) OUTS "%c", ptr[l]>=31&&ptr[l]<127?ptr[l]:'.' );
OUTS "\n" );
}
}
}
}
}
catch( ... ) { }
}
}
}
CloseHandle( hFileMapping );
CloseHandle( hFile );
#else // WIN32
// UNIX code
OUTS "UNIX Stack Trace Currently unavailable\n" );
#endif // WIN32
return output;
}
#ifdef WIN32
char *demangleMSDEVFuncName(
char *mangledName,
char funcName[], int funcNameMax,
char args[], int maxArgs,
int &numArgs
) {
// Print out arguments. This is a big pain in the ass
// because the argument list needs to be parsed.
// This fills in the funcName and args buffers.
// Both of which need to pass in buffer sizes.
// numArgs is filled out.
// Returns a full string ready for printing or NULL on error
// The args array is encoded as follows:
// D=char, E=uchar, F=short, G=ushort, H=int, I=uint,
// J=, K=, L=, M=float, N=double, O=, P=ptr, Q=, R=,
// S=, T=, U=STRUCT, V=, W=, X=void, Y=, Z=...
static char demangled[128] = {0,};
memset( demangled, 0, 128 );
numArgs = 0;
char *atomicTypes[] = { "REF", "", "", "char", "uchar", "short",
"ushort", "int", "uint", "", "", "",
"float", "double", "", "PTR", "", "", "", "",
"STRUCT", "", "", "void", "", "..."
};
int retType = 0, funcType;
enum {sSTART,sNAME,sCLASSNAME,sFUNCYPE,sERROR,sRETTYPE,sSTRUCT,sARGS,sTYPE,sRETTYPEDONE,sARGSDONE,sEND};
enum {ftFREEFUNC, ftMETHOD, ftVIRTUAL, ftSTATIC,};
char name[128]={0,};
char classname[128]={0,};
int state = sSTART;
int stateStack[30];
int stateStackTop = 0;
int lastType = 0;
#define PUSHSTATE stateStack[stateStackTop++] = state;
#define POPSTATE state = stateStack[--stateStackTop];
char *p = mangledName;
while( *p || state == sEND ) {
switch( state ) {
case sSTART:
if( *p == '_' ) {
strncpy( funcName, p, funcNameMax-1 );
funcName[funcNameMax-1] = 0;
return NULL;
}
if( *p == '?' ) state = sNAME;
else state = sERROR;
break;
case sNAME:
if( *p=='@' && *(p+1)=='@' ) {
p++;
state = sFUNCYPE;
}
else if( *p=='@' ) state = sCLASSNAME;
else name[strlen(name)]=*p;
break;
case sCLASSNAME:
if( *p == '@' && *(p+1)=='@' ) {
p++;
state = sFUNCYPE;
}
else classname[strlen(classname)]=*p;
break;
case sFUNCYPE:
if( *p=='Y' ) funcType = ftFREEFUNC;
if( *p=='Q' ) funcType = ftMETHOD;
if( *p=='U' ) funcType = ftVIRTUAL;
if( *p=='S' ) funcType = ftSTATIC;
// Skip const, volatile, etc.
p++;
if( funcType == ftMETHOD || funcType == ftVIRTUAL ) {
p++;// Some unknown parameter, mostly 'E'
// Maybe it stands for "this"
//args[numArgs++] = 'P';
//if( numArgs >= maxArgs ) state = sERROR;
}
state = sRETTYPE;
break;
case sTYPE:
if( *p == '?' ) {
p++;
if( *p != 'B' && *p != 'A' ) state = sERROR; // 'B' means const, 'A' means copy?
break;
}
else if( *p == 'P' || *p == 'Q' || *p == 'A' ) {
if(lastType==0) lastType='P';
p++; // Read the modifier
if( !(*p>='A' && *p<='C') ) state=sERROR;
else {
PUSHSTATE;
}
}
else if( *p>='D' && *p<='O' || *p == 'X' ) {
// Simple atomic type
if(lastType==0) lastType=*p;
}
else if( *p == 'U' ) {
if(lastType==0) lastType=*p;
// A structure, gobble it up
while( *p++ != '@' );
}
else if( *p == 'Y' ) {
// An array length, gobble it up
do {
p++;
} while( *p >= '0' && *p <= '9' );
p--;
break;
}
if( stateStackTop > 0 ) POPSTATE;
break;
case sRETTYPE:
lastType = 0;
state = sRETTYPEDONE;
PUSHSTATE;
state = sTYPE;
p--;
break;
case sRETTYPEDONE:
retType = lastType;
state = sARGS;
p--;
break;
case sARGS:
if( *p=='@' ) state = sEND;
else if( *p=='Z' && *(p+1)!='Z' ) {
//argCount = 0;
state = sEND;
}
else if( *p=='Z' && *(p+1)=='Z' ) {
args[numArgs++] = 'Z';
if( numArgs >= maxArgs ) state = sERROR;
else state = sEND;
}
else {
lastType = 0;
state = sARGSDONE;
PUSHSTATE;
state = sTYPE;
p--;
}
break;
case sARGSDONE:
args[numArgs++] = lastType;
if( numArgs >= maxArgs ) state = sERROR;
else state = sARGS;
p--;
break;
case sEND: {
strcat( demangled, classname );
if( *classname ) strcat( demangled, "::" );
strcat( demangled, name );
strncpy( funcName, demangled, funcNameMax-1 );
funcName[funcNameMax-1] = 0;
*demangled = 0;
if((char)retType >= 'A')
{
strcat( demangled, atomicTypes[retType-'A'] );
strcat( demangled, " " );
strcat( demangled, classname );
if( *classname ) strcat( demangled, "::" );
strcat( demangled, name );
strcat( demangled, "(" );
for( int i=0; i<numArgs; i++ ) {
if( args[i] >= 'A' && args[i] <= 'Z' ) {
strcat( demangled, i==0?" ":", " );
strcat( demangled, atomicTypes[args[i]-'A'] );
}
}
strcat( demangled, " )" );
}
else
{
strcpy(demangled, funcName);
}
goto stop;
}
case sERROR:
return NULL;
goto stop;
}
p++;
}
stop:;
return demangled;
}
#endif
#ifdef REGRESSION
// This is test code for the name mangler parser
void main( int argc, char **argv ) {
void regressionTestDemangler();
}
void regressionTestDemangler() {
char *cases[] = {
"void oink( Oink * )", "?oink@@YAXPAUOink@@@Z", "void oink( PTR )",
"void oink( const int * )", "?oink@@YAXPBH@Z", "void oink( PTR )",
"void oink( int * const )", "?oink@@YAXQAH@Z", "void oink( PTR )",
"void oink( const int & )", "?oink@@YAXABH@Z", "void oink( PTR )",
"void oink( volatile int * )", "?oink@@YAXPCH@Z", "void oink( PTR )",
"void oink( int c[4][1] )", "?oink@@YAXQAY00H@Z", "void oink( PTR )",
"void oink( int c[4] )", "?oink@@YAXQAH@Z", "void oink( PTR )",
"void oink( )", "?oink@@YAXXZ", "void oink( void )",
"void Boink::oink()", "?oink@Boink@@QAEXXZ", "void Boink::oink( void )",
"void Boink::oink() const", "?oink@Boink@@QBEXXZ", "void Boink::oink( void )",
"void Boink::oink() volatile", "?oink@Boink@@QCEXXZ", "void Boink::oink( void )",
"virtual void Boink::oink()", "?oink@Boink@@UAEXXZ", "void Boink::oink( void )",
"static void Boink::oink()", "?oink@Boink@@SAXXZ", "void Boink::oink( void )",
"void oink( int c[4][2] )", "?oink@@YAXQAY01H@Z", "void oink( PTR )",
"void oink( int c[5][2] )", "?oink@@YAXQAY01H@Z", "void oink( PTR )",
"void oink( int c[5][2][1] )", "?oink@@YAXQAY110H@Z", "void oink( PTR )",
"void oink( char, char )", "?oink@@YAXDD@Z", "void oink( char, char )",
"void oink( Oink )", "?oink@@YAXUOink@@@Z", "void oink( STRUCT )",
"Boink oink( )", "?oink@@YA?AUBoink@@XZ", "STRUCT oink( void )",
"Boink *oink( )", "?oink@@YAPAUBoink@@XZ", "PTR oink( void )",
"void oink( int [] )", "?oink@@YAXQAH@Z", "void oink( PTR )",
"void oink( int, ... )", "?oink@@YAXHZZ", "void oink( int, ... )",
"const int oink( )", "?oink@@YA?BHXZ", "int oink( void )",
"void *oink( )", "?oink@@YAPAXXZ", "PTR oink( void )",
"int &oink( )", "?oink@@YAAAHXZ", "PTR oink( void )",
"void oink( int * )", "?oink@@YAXPAH@Z", "void oink( PTR )",
"void oink( int ** )", "?oink@@YAXPAPAH@Z", "void oink( PTR )",
"void oink( int & )", "?oink@@YAXAAH@Z", "void oink( PTR )",
"int oink( char *, char ** )", "?oink@@YAHPADPAPAD@Z", "int oink( PTR, PTR )",
"char oink( )", "?oink@@YADXZ", "char oink( void )",
"unsigned char oink( )", "?oink@@YAEXZ", "uchar oink( void )",
"short oink( )", "?oink@@YAFXZ", "short oink( void )",
"unsigned short oink( )", "?oink@@YAGXZ", "ushort oink( void )",
"int oink( )", "?oink@@YAHXZ", "int oink( void )",
"unsigned int oink( )", "?oink@@YAIXZ", "uint oink( void )",
"float oink( )", "?oink@@YAMXZ", "float oink( void )",
"double oink( )", "?oink@@YANXZ", "double oink( void )",
"void oink( char )", "?oink@@YAXD@Z", "void oink( char )",
"void oink( int )", "?oink@@YAXH@Z", "void oink( int )",
// TODO: function ptrs, operators
//"void oink( __int64 )", "?oink@@YAX_J@Z",
//"typedef void (*FPTR)();"
//"void oink( FPTR )", "?oink@@YAXP6AXXZ@Z",
//"typedef void (*FPTR)(int);"
//"void oink( FPTR )", "?oink@@YAXP6AXH@Z@Z",
//"int Boink::operator +(int a)", "??HBoink@@QAEHH@Z",
//"int Boink::operator -(int a)", "??GBoink@@QAEHH@Z",
//"Boink::operator char *()", "??BBoink@@QAEPADXZ",
};
int count = sizeof(cases)/sizeof(cases[0]);
for( int i=0; i<count; i+=3 ) {
char args[100];
int numArgs;
char *str = demangle( cases[i+1], "", 1, args, 100, numArgs );
printf( "%s = %s\nshould be:%s\n got:%s\n\n", cases[i], cases[i+1], cases[i+2], str );
if( strcmp( str, cases[i+2] ) ) {
printf( "Regression failed i=%d\n", i );
}
}
}
#endif
Reference in a new issue View git blame Copy permalink