使用dbghelp獲取調(diào)用堆棧--release下的調(diào)試方法學(xué)

Author : Kevin Lynx

當(dāng)軟件作為release模式被發(fā)布給用戶時(shí)，當(dāng)程序崩潰時(shí)我們很難去查找原因。常見的手法是輸出LOG文件，根據(jù)LOG文件分析
程序崩潰時(shí)的運(yùn)行情況。我們可以通過SEH來捕獲程序錯(cuò)誤，然后輸出一些有用的信息作為我們分析錯(cuò)誤的資料。一般我們需要
輸出的信息包括：系統(tǒng)信息、CPU寄存器信息、堆棧信息、調(diào)用堆棧等。而調(diào)用堆棧則是最有用的部分，它可以直接幫我們定位
到程序崩潰時(shí)所處的位置(在何處崩潰)。(codeproject上關(guān)于這個(gè)專題的常見開場白 = =#)

要獲取call stack(所謂的調(diào)用堆棧)，就需要查看(unwind)stack的內(nèi)容。We could conceivably attempt to unwind the
stack ourselves using inline assembly. But stack frames can be organized in different ways, depending on compiler
optimizations and calling conventions, so it could become complicated to do it that way.(摘自vld文檔)要獲取棧的
內(nèi)容，我們可以自己使用內(nèi)聯(lián)匯編獲取，但是考慮到兼容性，內(nèi)聯(lián)匯編并不是一個(gè)好的解決方案。我們可以使用微軟的dbghelp
中的StackWalk64來獲取棧的內(nèi)容。

StackWalk64聲明如下：
BOOL StackWalk64(
  DWORD MachineType,
  HANDLE hProcess,
  HANDLE hThread,
  LPSTACKFRAME64 StackFrame,
  PVOID ContextRecord,
  PREAD_PROCESS_MEMORY_ROUTINE64 ReadMemoryRoutine,
  PFUNCTION_TABLE_ACCESS_ROUTINE64 FunctionTableAccessRoutine,
  PGET_MODULE_BASE_ROUTINE64 GetModuleBaseRoutine,
  PTRANSLATE_ADDRESS_ROUTINE64 TranslateAddress
);

具體每個(gè)參數(shù)的含義可以參見MSDN。這里說下ContextRecord參數(shù)，該參數(shù)指定了CPU各個(gè)寄存器的內(nèi)容。StackFrame指定了stack
frame的內(nèi)容。stack frame是什么，我也不知道。(= =) StackWalk64函數(shù)需要用戶指定當(dāng)前frame的地址，以及當(dāng)前程序的指令
地址。這兩個(gè)信息都被填充進(jìn)ContextRecord，然后傳進(jìn)StackWalk64函數(shù)。

那么如何獲取當(dāng)前的stack frame地址和當(dāng)前程序指令地址呢？如前所說，你可以使用內(nèi)聯(lián)匯編。(對于程序指令地址，因?yàn)橐@取
EIP寄存器的內(nèi)容，而該寄存器不能被軟件訪問)也可以使用GetThreadContext一次性獲取當(dāng)前線程當(dāng)前運(yùn)行情況下的CPU各個(gè)寄存器
內(nèi)容。補(bǔ)充下，當(dāng)前frame地址被放在EBP寄存器里，當(dāng)前程序指令地址放在EIP寄存器里。但是，如同MSDN對GetThreadContext函數(shù)
的說明一樣，該函數(shù)可能獲取到錯(cuò)誤的寄存器內(nèi)容(You cannot get a valid context for a running thread)。

另一種獲取Context(包含EBP and EIP)的方法就是使用SEH(結(jié)構(gòu)化異常處理)，在__except中使用GetExceptionInformation獲取。

GetExceptionInformation 傳回一個(gè)LPEXCEPTION_POINTERS指針，該指針指向一個(gè)EXCEPTION_POINTERS結(jié)構(gòu)，該結(jié)構(gòu)里包含一個(gè)
Context的指針，即達(dá)到目標(biāo)，可以使用StackWalk函數(shù)。

補(bǔ)充一下，你可以直接使用StackWalk函數(shù)，StackWalk被define為StackWalk64(windows平臺相關(guān))。

unwind棧后，可以進(jìn)一步獲取一個(gè)stack frame的內(nèi)容，例如函數(shù)名。這里涉及到SymFromAddr函數(shù)，該函數(shù)可以根據(jù)一個(gè)地址返回
符號名(函數(shù)名)。還有一個(gè)有意思的函數(shù)：SymGetLineFromAddr，可以獲取函數(shù)對應(yīng)的源代碼的文件名和行號。

當(dāng)然，這一切都依賴于VC產(chǎn)生的程序數(shù)據(jù)庫文件(pdb)，以及提供以上API函數(shù)的dbghelp.dll。

參考一段簡單的代碼：

/**////
///
///
#include <windows.h>
#include <stdio.h>
#include <dbghelp.h>

#pragma comment( lib, "dbghelp.lib" )

void dump_callstack( CONTEXT *context )
{
 STACKFRAME sf;
 memset( &sf, 0, sizeof( STACKFRAME ) );

 sf.AddrPC.Offset = context->Eip;
 sf.AddrPC.Mode = AddrModeFlat;
 sf.AddrStack.Offset = context->Esp;
 sf.AddrStack.Mode = AddrModeFlat;
 sf.AddrFrame.Offset = context->Ebp;
 sf.AddrFrame.Mode = AddrModeFlat;

 DWORD machineType = IMAGE_FILE_MACHINE_I386;

 HANDLE hProcess = GetCurrentProcess();
 HANDLE hThread = GetCurrentThread();

 for( ; ; )
 {
  if( !StackWalk(machineType, hProcess, hThread, &sf, context, 0, SymFunctionTableAccess, SymGetModuleBase, 0 ) )
  {
   break;
  }

  if( sf.AddrFrame.Offset == 0 )
  {
   break;
  }
  BYTE symbolBuffer[ sizeof( SYMBOL_INFO ) + 1024 ];
  PSYMBOL_INFO pSymbol = ( PSYMBOL_INFO ) symbolBuffer;
 
  pSymbol->SizeOfStruct = sizeof( symbolBuffer );
  pSymbol->MaxNameLen = 1024;

  DWORD64 symDisplacement = 0;
  if( SymFromAddr( hProcess, sf.AddrPC.Offset, 0, pSymbol ) )
  {
   printf( "Function : %s\n", pSymbol->Name );
  }
  else
  {
   printf( "SymFromAdd failed!\n" );
  }

  IMAGEHLP_LINE lineInfo = { sizeof(IMAGEHLP_LINE) };
  DWORD dwLineDisplacement;

  if( SymGetLineFromAddr( hProcess, sf.AddrPC.Offset, &dwLineDisplacement, &lineInfo ) )
  {
   printf( "[Source File : %s]\n", lineInfo.FileName ); 
   printf( "[Source Line : %u]\n", lineInfo.LineNumber ); 
  }
  else
  {
   printf( "SymGetLineFromAddr failed!\n" );
  }
 }
}

DWORD excep_filter( LPEXCEPTION_POINTERS lpEP )
{
 /**//// init dbghelp.dll
 if( SymInitialize( GetCurrentProcess(), NULL, TRUE ) )
 {
  printf( "Init dbghelp ok.\n" );
 }

 dump_callstack( lpEP->ContextRecord );

 if( SymCleanup( GetCurrentProcess() ) )
 {
  printf( "Cleanup dbghelp ok.\n" );
 }

 return EXCEPTION_EXECUTE_HANDLER;
}

void func1( int i )
{
 int *p = 0;
 *p = i;
}

void func2( int i )
{
 func1( i - 1 );
}

void func3( int i )
{
 func2( i - 1 );
}

void test( int i )
{
 func3( i - 1 );
}

int main()
{
 __try
 {
  test( 10 );
 }
 __except( excep_filter( GetExceptionInformation() ) )
 {
  printf( "Some exception occures.\n" );
 }

 return 0;
}

以上代碼在release模式下需要關(guān)掉優(yōu)化，否則調(diào)用堆棧顯示不正確(某些函數(shù)被去掉了?)，同時(shí)需要pdb文件。

posted on 2008-03-28 16:37 Kevin Lynx 閱讀(13718) 評論(10)  編輯 收藏 引用 所屬分類: 通用編程