织梦CMS - 轻松建站从此开始!

罗索

当前位置: 主页>杂项技术>VC(MFC)>

让程序在崩溃时体面的退出之CallStack

落鹤生 发布于 2012-07-11 10:20 点击:次 
如果在程序崩溃的时候得到CallStack,那么就能定位程序崩溃的具体位置,并最终找到解决方法。那么有没有什么方法在程序崩溃的时候得到CallStack呢?答案是肯定的。微软提供了一个DbgHelp.dll,里面包含了一系列的 Windows API来供开发者调用。
TAG:

在我的那篇《让程序在崩溃时体面的退出之Unhandled Exception》 中提供了一个捕捉程序崩溃事件的方法,可以添加代码在程序崩溃的时候做出适当的处理。不过,只知道程序在什么时候崩溃,但是不知道为什么崩溃,这对于程序 开发者来说没有任何意义。因为如果不知道程序崩溃的原因,就没法去找到代码中的缺陷,当然就没法去修改代码而避免程序的崩溃。
所有调试过代码的开发者都知道CallStack的重要性。如果在程序崩溃的时候得到CallStack,那么就能定位程序崩溃的具体位置,并最终找到解 决方法。那么有没有什么方法在程序崩溃的时候得到CallStack呢?答案是肯定的。微软提供了一个DbgHelp.dll,里面包含了一系列的 Windows API来供开发者调用。它是一个调试跟踪相关的模块,用于跟踪进程工作,在进程崩溃时收集程序产生异常时的堆栈信息,以供开发人员分析,从而很快找出使程 序出现异常的原因。
下面用具体的例子代码来说明怎样使用DbgHelp.dll中的Windows API来得到CallStack。代码里面有详细的注释来帮助理解。
用VC创建一个名为Test的控制台程序,添加下面的代码。

  1. // 一个有函数调用的类 
  2. //  
  3. class CrashTest 
  4. public
  5.     void Test()  
  6.     {  
  7.         Crash();  
  8.     } 
  9.  
  10. private
  11.     void Crash()  
  12.     {  
  13.         // 除零,人为的使程序崩溃 
  14.         // 
  15.         int i = 13; 
  16.         int j = 0; 
  17.         int m = i / j; 
  18.     } 
  19. }; 
  20.  
  21. int _tmain(int argc, _TCHAR* argv[]) 
  22.     CrashTest test; 
  23.     test.Test(); 
  24.  
  25.     return 0; 

编译上面的代码,到工程的Debug目录下找到编译好的Test.exe,双击运行,程序就会崩溃。从代码我们知道函数调用顺序是main() -> CrashTest::Test() -> CrashTest::Crash()。那么怎么在程序崩溃的时候得到CallStack呢?首先,先添加一些工具函数。

  1. #include <Windows.h> 
  2. #include <DbgHelp.h> 
  3. #include <iostream> 
  4. #include <vector> 
  5.  
  6. // 添加对dbghelp.lib的编译依赖 
  7. // 
  8. #pragma comment(lib, "dbghelp.lib") 
  9.  
  10. using namespace std; 
  11.  
  12. const int MAX_ADDRESS_LENGTH = 32; 
  13. const int MAX_NAME_LENGTH = 1024; 
  14.  
  15. // 崩溃信息 
  16. //  
  17. struct CrashInfo 
  18.     CHAR ErrorCode[MAX_ADDRESS_LENGTH]; 
  19.     CHAR Address[MAX_ADDRESS_LENGTH]; 
  20.     CHAR Flags[MAX_ADDRESS_LENGTH]; 
  21. }; 
  22.  
  23. // CallStack信息 
  24. //  
  25. struct CallStackInfo 
  26.     CHAR ModuleName[MAX_NAME_LENGTH]; 
  27.     CHAR MethodName[MAX_NAME_LENGTH]; 
  28.     CHAR FileName[MAX_NAME_LENGTH]; 
  29.     CHAR LineNumber[MAX_NAME_LENGTH]; 
  30. }; 
  31.  
  32. // 安全拷贝字符串函数 
  33. // 
  34. void SafeStrCpy(char* szDest, size_t nMaxDestSize, const char* szSrc) 
  35.     if (nMaxDestSize <= 0) return
  36.     if (strlen(szSrc) < nMaxDestSize) 
  37.     { 
  38.         strcpy_s(szDest, nMaxDestSize, szSrc); 
  39.     } 
  40.     else 
  41.     { 
  42.         strncpy_s(szDest, nMaxDestSize, szSrc, nMaxDestSize); 
  43.         szDest[nMaxDestSize-1] = '\0'
  44.     } 
  45. }   
  46.  
  47. // 得到程序崩溃信息 
  48. // 
  49. CrashInfo GetCrashInfo(const EXCEPTION_RECORD *pRecord) 
  50.     CrashInfo crashinfo; 
  51.     SafeStrCpy(crashinfo.Address, MAX_ADDRESS_LENGTH, "N/A"); 
  52.     SafeStrCpy(crashinfo.ErrorCode, MAX_ADDRESS_LENGTH, "N/A"); 
  53.     SafeStrCpy(crashinfo.Flags, MAX_ADDRESS_LENGTH, "N/A"); 
  54.  
  55.     sprintf_s(crashinfo.Address, "%08X", pRecord->ExceptionAddress); 
  56.     sprintf_s(crashinfo.ErrorCode, "%08X", pRecord->ExceptionCode); 
  57.     sprintf_s(crashinfo.Flags, "%08X", pRecord->ExceptionFlags); 
  58.  
  59.     return crashinfo; 
  60.  
  61. // 得到CallStack信息 
  62. // 
  63. vector<CallStackInfo> GetCallStack(const CONTEXT *pContext) 
  64.     HANDLE hProcess = GetCurrentProcess(); 
  65.  
  66.     SymInitialize(hProcess, NULL, TRUE); 
  67.  
  68.     vector<CallStackInfo> arrCallStackInfo; 
  69.  
  70.     CONTEXT c = *pContext; 
  71.  
  72.     STACKFRAME64 sf; 
  73.     memset(&sf, 0, sizeof(STACKFRAME64)); 
  74.     DWORD dwImageType = IMAGE_FILE_MACHINE_I386; 
  75.  
  76.     // 不同的CPU类型,具体信息可查询MSDN 
  77.     // 
  78. #ifdef _M_IX86 
  79.     sf.AddrPC.Offset = c.Eip; 
  80.     sf.AddrPC.Mode = AddrModeFlat; 
  81.     sf.AddrStack.Offset = c.Esp; 
  82.     sf.AddrStack.Mode = AddrModeFlat; 
  83.     sf.AddrFrame.Offset = c.Ebp; 
  84.     sf.AddrFrame.Mode = AddrModeFlat; 
  85. #elif _M_X64 
  86.     dwImageType = IMAGE_FILE_MACHINE_AMD64; 
  87.     sf.AddrPC.Offset = c.Rip; 
  88.     sf.AddrPC.Mode = AddrModeFlat; 
  89.     sf.AddrFrame.Offset = c.Rsp; 
  90.     sf.AddrFrame.Mode = AddrModeFlat; 
  91.     sf.AddrStack.Offset = c.Rsp; 
  92.     sf.AddrStack.Mode = AddrModeFlat; 
  93. #elif _M_IA64 
  94.     dwImageType = IMAGE_FILE_MACHINE_IA64; 
  95.     sf.AddrPC.Offset = c.StIIP; 
  96.     sf.AddrPC.Mode = AddrModeFlat; 
  97.     sf.AddrFrame.Offset = c.IntSp; 
  98.     sf.AddrFrame.Mode = AddrModeFlat; 
  99.     sf.AddrBStore.Offset = c.RsBSP; 
  100.     sf.AddrBStore.Mode = AddrModeFlat; 
  101.     sf.AddrStack.Offset = c.IntSp; 
  102.     sf.AddrStack.Mode = AddrModeFlat; 
  103. #else 
  104.     #error "Platform not supported!" 
  105. #endif 
  106.  
  107.     HANDLE hThread = GetCurrentThread(); 
  108.  
  109.     while (true
  110.     { 
  111.         // 该函数是实现这个功能的最重要的一个函数 
  112.         // 函数的用法以及参数和返回值的具体解释可以查询MSDN 
  113.         // 
  114.         if (!StackWalk64(dwImageType, hProcess, hThread, &sf, &c, NULL
  115. , SymFunctionTableAccess64, SymGetModuleBase64, NULL)) 
  116.         { 
  117.             break
  118.         } 
  119.  
  120.         if (sf.AddrFrame.Offset == 0) 
  121.         { 
  122.             break
  123.         } 
  124.                  
  125.         CallStackInfo callstackinfo; 
  126.         SafeStrCpy(callstackinfo.MethodName, MAX_NAME_LENGTH, "N/A"); 
  127.         SafeStrCpy(callstackinfo.FileName, MAX_NAME_LENGTH, "N/A"); 
  128.         SafeStrCpy(callstackinfo.ModuleName, MAX_NAME_LENGTH, "N/A"); 
  129.         SafeStrCpy(callstackinfo.LineNumber, MAX_NAME_LENGTH, "N/A"); 
  130.  
  131.         BYTE symbolBuffer[sizeof(IMAGEHLP_SYMBOL64) + MAX_NAME_LENGTH]; 
  132.         IMAGEHLP_SYMBOL64 *pSymbol = (IMAGEHLP_SYMBOL64*)symbolBuffer; 
  133.         memset(pSymbol, 0, sizeof(IMAGEHLP_SYMBOL64) + MAX_NAME_LENGTH); 
  134.  
  135.         pSymbol->SizeOfStruct = sizeof(symbolBuffer); 
  136.         pSymbol->MaxNameLength = MAX_NAME_LENGTH; 
  137.  
  138.         DWORD symDisplacement = 0; 
  139.          
  140.         // 得到函数名 
  141.         // 
  142.         if (SymGetSymFromAddr64(hProcess, sf.AddrPC.Offset, NULL, pSymbol)) 
  143.         { 
  144.             SafeStrCpy(callstackinfo.MethodName, MAX_NAME_LENGTH, pSymbol->Name); 
  145.         } 
  146.  
  147.         IMAGEHLP_LINE64 lineInfo; 
  148.         memset(&lineInfo, 0, sizeof(IMAGEHLP_LINE64)); 
  149.  
  150.         lineInfo.SizeOfStruct = sizeof(IMAGEHLP_LINE64); 
  151.  
  152.         DWORD dwLineDisplacement; 
  153.  
  154.         // 得到文件名和所在的代码行 
  155.         // 
  156.         if (SymGetLineFromAddr64(hProcess, sf.AddrPC.Offset, &dwLineDisplacement, &lineInfo)) 
  157.         { 
  158.             SafeStrCpy(callstackinfo.FileName, MAX_NAME_LENGTH, lineInfo.FileName); 
  159.             sprintf_s(callstackinfo.LineNumber, "%d", lineInfo.LineNumber); 
  160.         } 
  161.  
  162.         IMAGEHLP_MODULE64 moduleInfo; 
  163.         memset(&moduleInfo, 0, sizeof(IMAGEHLP_MODULE64)); 
  164.  
  165.         moduleInfo.SizeOfStruct = sizeof(IMAGEHLP_MODULE64); 
  166.  
  167.         // 得到模块名 
  168.         // 
  169.         if (SymGetModuleInfo64(hProcess, sf.AddrPC.Offset, &moduleInfo)) 
  170.         { 
  171.             SafeStrCpy(callstackinfo.ModuleName, MAX_NAME_LENGTH, moduleInfo.ModuleName); 
  172.         } 
  173.  
  174.         arrCallStackInfo.push_back(callstackinfo); 
  175.     } 
  176.  
  177.     SymCleanup(hProcess); 
  178.  
  179.     return arrCallStackInfo; 

然后,就可以用《让程序在崩溃时体面的退出之Unhandled Exception》中提供的捕捉程序崩溃事件的方法添加一个回调函数,在这个函数里面调用上面的函数来得到程序崩溃时的CallStack。

  1. // 处理Unhandled Exception的回调函数 
  2. // 
  3. LONG ApplicationCrashHandler(EXCEPTION_POINTERS *pException) 
  4. {    
  5.     // 确保有足够的栈空间 
  6.     // 
  7. #ifdef _M_IX86 
  8.     if (pException->ExceptionRecord->ExceptionCode == EXCEPTION_STACK_OVERFLOW) 
  9.     { 
  10.         static char TempStack[1024 * 128]; 
  11.         __asm mov eax,offset TempStack[1024 * 128]; 
  12.         __asm mov esp,eax; 
  13.     } 
  14. #endif   
  15.  
  16.     CrashInfo crashinfo = GetCrashInfo(pException->ExceptionRecord); 
  17.  
  18.     // 输出Crash信息 
  19.     // 
  20.     cout << "ErrorCode: " << crashinfo.ErrorCode << endl; 
  21.     cout << "Address: " << crashinfo.Address << endl; 
  22.     cout << "Flags: " << crashinfo.Flags << endl; 
  23.      
  24.     vector<CallStackInfo> arrCallStackInfo = GetCallStack(pException->ContextRecord); 
  25.  
  26.     // 输出CallStack 
  27.     // 
  28.     cout << "CallStack: " << endl; 
  29.     for (vector<CallStackInfo>::iterator i = arrCallStackInfo.begin()
  30. ; i != arrCallStackInfo.end(); ++i) 
  31.     { 
  32.         CallStackInfo callstackinfo = (*i); 
  33.  
  34.         cout << callstackinfo.MethodName << "() : [" << callstackinfo.ModuleName
  35.  << "] (File: " << callstackinfo.FileName << " @Line " << callstackinfo.LineNumber
  36.  << ")" << endl; 
  37.     } 
  38.  
  39.     // 这里弹出一个错误对话框并退出程序 
  40.     // 
  41.     FatalAppExit(-1,  _T("*** Unhandled Exception! ***")); 
  42.  
  43.     return EXCEPTION_EXECUTE_HANDLER; 

最后,在main函数的开头添加下面的代码。

  1. // 设置处理Unhandled Exception的回调函数 
  2. //  
  3. SetUnhandledExceptionFilter((LPTOP_LEVEL_EXCEPTION_FILTER)ApplicationCrashHandler);  

编译上面的代码,到工程的Debug目录下找到编译好的Test.exe,双击运行,程序在崩溃的时候就会输出CallStack。

(starlee)
本站文章除注明转载外,均为本站原创或编译欢迎任何形式的转载,但请务必注明出处,尊重他人劳动,同学习共成长。转载请注明:文章转载自:罗索实验室 [http://www.rosoo.net/a/201207/16149.html]
本文出处:CSDN博客 作者:starlee
顶一下
(3)
100%
踩一下
(0)
0%
------分隔线----------------------------
发表评论
请自觉遵守互联网相关的政策法规,严禁发布色情、暴力、反动的言论。
评价:
表情:
用户名: 验证码:点击我更换图片
栏目列表
将本文分享到微信
织梦二维码生成器
推荐内容