由于Debug和Release模式下,编译器的行为不同,导致有些bug在Debug模式下并不能检查出来,而Release模式下又无法单步调试。因此在Release模式下记录程序崩溃的信息,并定位代码所在的行号是非常有必要的。
该过程分为3步:
- 在当前程序的Release版本中生成
pdb
调试信息文件 - 将程序崩溃时的执行信息保存为
dump
文件; - 指定
pdb
和exe
文件路径,使用WinDbg打开dump
文件定位崩溃时的代码位置。
测试的环境:Qt Creator 4.11.2 + Qt 5.12.8 + MSVC2017
1. Qt Creator在Release下生成 .pdb
调试文件
项目采用qmake编译,在.pro
文件中加入如下语句:
QMAKE_LFLAGS_RELEASE = /INCREMENTAL:NO /DEBUG
或者在项目 —> 构建设置 —> qmake详情
中,选择Release
构建配置,将Generate separate debug info
勾选。
重新构建当前项目,会在release
文件夹下生成.pdb
文件。
2. 将程序崩溃时的执行信息保存为dump
文件
这部分网上文章较多,参考QT 异常崩溃处理,在windows系统下的主要思路是:
- 使用
SetUnhandledExceptionFilter
注册程序的异常捕获回调函数; - 将捕获的异常通过
MiniDumpWriteDump
函数保存。
参考代码(crash.dmp
文件将会保存在程序运行根目录下):
在Pro文件里加入LIBS += -lDbgHelp
#include <Windows.h>
#include <DbgHelp.h>
#include <QApplication>
// 保存程序异常崩溃的信息
LONG ApplicationCrashHandler(EXCEPTION_POINTERS *pException)
{
//创建 Dump 文件
HANDLE hDumpFile = CreateFile(L"crash.dmp", GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
if(hDumpFile != INVALID_HANDLE_VALUE)
{
//Dump 信息
MINIDUMP_EXCEPTION_INFORMATION dumpInfo;
dumpInfo.ExceptionPointers = pException;
dumpInfo.ThreadId = GetCurrentThreadId();
dumpInfo.ClientPointers = TRUE;
// 写入 dump 文件内容
MiniDumpWriteDump(GetCurrentProcess(), GetCurrentProcessId(), hDumpFile, MiniDumpNormal, &dumpInfo, NULL, NULL);
}
//弹出一个错误对话框
QMessageBox msgBox;
msgBox.setText("application crash!");
msgBox.exec();
return EXCEPTION_EXECUTE_HANDLER;
}
int main(int argc, char *argv[])
{
QApplication a(argc, argv);
//注册异常捕获函数
SetUnhandledExceptionFilter((LPTOP_LEVEL_EXCEPTION_FILTER)ApplicationCrashHandler);
// set printf and fprintf out immediately
setvbuf(stdout, NULL, _IONBF, 0);
setvbuf(stderr, NULL, _IONBF, 0);
OctNisus w;
w.show();
return a.exec();
}
非 windows 操作系统,可以采用Google breakpad
实现,参考:跨平台的Qt程序崩溃生成Dump文件Breakpad
3. 使用 WinDbg 分析dump
文件
- 打开
WinDbg(x64)
(windbg.exe); File —> Symbol File Path
,设置.pdb
文件所在的文件夹(注意是文件夹,而不是文件);File —> Source File Path
,设置release版本的.exe
执行文件所在的文件夹;File —> Open Crash Dump
,打开crash.dmp
文件。
注意:
每次发布程序的时候,记得保存对应版本的.pdb
文件,当客户使用软件出现崩溃时,回传dump
文件,即可定位问题的原因,不用拼命的复现场景。
分析过程中可能会提示:缺少ntdll.pdb
、缺少kernelbase.pdb
等等,不用理会,这些是为了定位系统内部方法的。我们只需要知道错误在自己程序的什么函数里面发生。
如果是在同一台电脑上,而且release包、pdb文件、应用程序都是同一个版本时,可以直接定位到具体的代码行号。此时用visual studio
打开crash.dmp
文件,可以直接定位到代码文件中。