Minidump方式保留程序崩溃现场

介绍部分转自https://www.cnblogs.com/lisuyun/p/5245609.html

程序部分为原创。

Minidump方式保留程序崩溃现场

在Windows平台下用C++开发应用程序，最不想见到的情况恐怕就是程序崩溃，而要想解决引起问题的bug，最困难的应该就是调试release版本了。因为release版本来就少了很多调试信息，更何况一般都是发布出去由用户使用，crash的现场很难保留和重现。目前有一些方法可以解决：崩溃地址 + MAP文件；MAP文件；SetUnhandledExceptionFilter + Minidump。本文重点关注SetUnhandledExceptionFilter + Minidump方式。

一、Minidump文件生成

1、Minidump概念

minidump（小存储器转储）可以理解为一个dump文件，里面记录了能够帮助调试crash的最小有用信息。实际上，如果你在系统属性 -> 高级 -> 启动和故障恢复 -> 设置 -> 写入调试信息中选择“小内存转储(64 KB)”的话，当系统意外停止时都会在C:\Windows\Minidump\路径下生成一个.dmp后缀的文件，这个文件就是minidump文件，只不过这个是内核态的minidump。

我们要生成的是用户态的minidump，文件中包含了程序运行的模块信息、线程信息、堆栈调用信息等。而且为了符合其mini的特性，dump文件是压缩过的。

2、生成minidump文件

通过drwtsn32、NTSD、CDB等调试工具生成Dump文件， drwtsn32存在的缺点虽然NTSD、CDB可以完全解决，但并不是所有的操作系统中都安装了NTSD、CDB等调试工具。根据MiniDumpWriteDump接口，完全可以程序自动生成Dump文件。MiniDumpWriteDump是MS DbgHelp.dll中的一个API，用于导出当前运行程序的dump。

3、自动生成Minidump文件

当程序遇到未处理异常(主要指非指针造成)导致程序崩溃死，如果在异常发生之前调用了SetUnhandledExceptionFilter()函数，异常交给函数处理。MSDN中描述为：

Issuing SetUnhandledExceptionFilter replaces the existing top-level exception filter for all existing and all future threads in the calling process.

因而，在程序开始处增加SetUnhandledExceptionFilter()函数，并在函数中利用适当的方法生成Dump文件，即可实现需要的功能。

#include <DbgHelp.h>
#pragma comment(lib,"DbgHelp.lib")

//main函数中调用SetUnhandledExceptionFilter
SetUnhandledExceptionFilter(DumpCallback);


LONG WINAPI DumpCallback(_EXCEPTION_POINTERS* excp) {
  boost::mutex::scoped_lock lock(g_dump_mutex);
  CreateDump(excp);
  return EXCEPTION_EXECUTE_HANDLER;
}


VOID CreateDump(struct _EXCEPTION_POINTERS *pExceptionPointers) {
  //收集信息
  CStringW strBuild;
  strBuild.Format(L"Build: %s %s", __DATE__, __TIME__);
  CStringW strError;
  WCHAR* szModuleName = L"my_module_name";
  strError.Format(L"%s %d , %d ,%d.", szModuleName, pExceptionPointers->ExceptionRecord->ExceptionCode, 

pExceptionPointers->ExceptionRecord->ExceptionFlags, pExceptionPointers->ExceptionRecord->ExceptionAddress);

  //生成 mini crash dump
  BOOL bMiniDumpSuccessful;
  WCHAR* szPath = L"./";
  WCHAR szFileName[MAX_PATH];
  WCHAR* szAppName = L"DumpFile";
  WCHAR* szVersion = L"v1.0";
  DWORD dwBufferSize = MAX_PATH;
  HANDLE hDumpFile;
  SYSTEMTIME stLocalTime;
  MINIDUMP_EXCEPTION_INFORMATION ExpParam;
  GetLocalTime(&stLocalTime);
  //GetTempPathW(dwBufferSize, szPath);
  StringCchPrintfW(szFileName, MAX_PATH, L"%s%s", szPath, szAppName);
  CreateDirectoryW(szFileName, NULL);
  //std::wcout << szFileName;
  StringCchPrintfW(szFileName, MAX_PATH, L"%s%s//%s-%04d%02d%02d-%02d%02d%02d-%ld-%ld.dmp",
    szPath, szAppName, szVersion,
    stLocalTime.wYear, stLocalTime.wMonth, stLocalTime.wDay,
    stLocalTime.wHour, stLocalTime.wMinute, stLocalTime.wSecond,
    GetCurrentProcessId(), GetCurrentThreadId());
  hDumpFile = CreateFileW(szFileName, GENERIC_READ | GENERIC_WRITE,
    FILE_SHARE_WRITE | FILE_SHARE_READ, 0, CREATE_ALWAYS, 0, 0);

  MINIDUMP_USER_STREAM UserStream[2];
  MINIDUMP_USER_STREAM_INFORMATION UserInfo;
  UserInfo.UserStreamCount = 1;
  UserInfo.UserStreamArray = UserStream;
  UserStream[0].Type = CommentStreamW;
  UserStream[0].BufferSize = strBuild.GetLength()*sizeof(WCHAR);
  UserStream[0].Buffer = strBuild.GetBuffer();
  UserStream[1].Type = CommentStreamW;
  UserStream[1].BufferSize = strError.GetLength()*sizeof(WCHAR);
  UserStream[1].Buffer = strError.GetBuffer();

  ExpParam.ThreadId = GetCurrentThreadId();
  ExpParam.ExceptionPointers = pExceptionPointers;
  ExpParam.ClientPointers = TRUE;

  MINIDUMP_TYPE MiniDumpWithDataSegs = (MINIDUMP_TYPE)(MiniDumpNormal
    | MiniDumpWithHandleData
    | MiniDumpWithUnloadedModules
    | MiniDumpWithIndirectlyReferencedMemory
    | MiniDumpScanMemory
    | MiniDumpWithProcessThreadData
    | MiniDumpWithThreadInfo);

  bMiniDumpSuccessful = MiniDumpWriteDump(GetCurrentProcess(), GetCurrentProcessId(),
    hDumpFile, MiniDumpWithDataSegs, &ExpParam, NULL, NULL);

  return;
}

二、调试Minidump文件

双击minidump文件（*.dmp）。默认会启动VisualStudio。
菜单Tools/Options, Debugging/Symbols，增加PDB文件路径。注：如果minidump文件与pdb文件在同一目录，就不用设置这个了。
若调试的程序需要微软基础库的PDB信息，可以增加一个路径为：http://msdl.microsoft.com/download/symbols
在界面下方Cache Symbol From symbol…选择本地存储这些Symbols的路径。注：如果本地已存储过微软基础库的pdb，就直接按照此步操作设置本地路径，不必执行上一步操作了。
设置代码路径：刚打开的dmp工程，进入解决方案的属性。在这里输入源程序的代码路径。注：一定是sln所在的路径，而不是vcproj的路径！

6. 按F5，debug吧。

Minidump方式保留程序崩溃现场

猜你喜欢