优秀开源项目之四：CrashRptProbe，查询程序奔溃的利器

1.背景：

　　在开发人员进行项目开发和调试代码时，有一个非常困扰的问题，就是程序在调试运行过程中会莫名其妙地异常退出。由于导致异常退出的问题非常多，因此在面对这种无任何提示的异常退出时，开发人员会非常无奈。因为他需要考虑最近的那些更改有可能导致这个错误的发生，万不得已，可能就需要把代码回退到某个版本，然后去慢慢验证了。这当然是非常影响工作效率的。

　　后来，项目经理前段时间介绍了一个新的库，用这个库可以非常准确地定位上一次奔溃的出错位置。这样开发人员便可以在奔溃的位置添加断点，进行调试。

　　自从知道有这个工具后，我就爱不释手。从此，再也不怕遇到程序异常退出的情况了。因为你知道，那里有一个助手帮你监视着程序的一举一动，随时等待你的召唤。

　　下面就介绍一下这个工具，它的名字叫：**CrashRptProbe。**Probe是探针的意思，顾名思义，就是探测程序奔溃并发送报告的一个工具。这个工具在Github上的地址为：https://github.com/bitshares/devshares/tree/master/CrashRpt

2. CrashRptProbe的基本介绍：

　　目前我是将这个库引入了VS2012开发C++的项目中，在其他开发工具和语言上还没有试过。

　　这个工具是作为第三方库引入项目中的。它的地位就和之前引入的其他第三方库，如DCMTK, VTK, ITK, GTEST, OpenCV, log4cplus等一样。

　　从Github上把这个包下载下来，并解压到项目中的thirdparty中即可。或者从以下的链接中下载这个包。

　　具体的放置位置如下图所示：

由于需要把该工具引入到项目中。因此需要将它在放置在和本项目的应用程序的入口函数main.cpp的同级目录内。并且需要定义一个当系统奔溃时，奔溃报告的存放位置。因此，在main.cpp的同级目录下，创建两个文件：
CrashHandler.h和CrashHandler.cpp。

CrashHandler.h的代码为：

#ifndef _DXCRASHHANDLER_H_
#define _DXCRASHHANDLER_H_
#include <QString>
class DxCrashHandler
{
public:
DxCrashHandler();
~DxCrashHandler();
private:
QString AddAppPath(const QString relativepath);
};
#endif // _DXCRASHHANDLER_H_

CrashHandler.cpp的代码为：

#include "CrashRpt.h"
#include "DxCrashHandler.h"
#include <QApplication>
#include <QDir>
#include <QMainWindow>
#include <QMessageBox>
QString DxCrashHandler::AddAppPath(const QString relativepath)
{
QDir root(QCoreApplication::applicationDirPath());
return QDir::cleanPath(root.absoluteFilePath(relativepath));
}
// Define the callback function that will be called on crash
int CALLBACK CrashCallback(CR_CRASH_CALLBACK_INFO* pInfo)
{
// The application has crashed!
if ( pInfo->nStage == CR_CB_STAGE_PREPARE )
{
// Close log file here when necessary
}
else //CR_CB_STAGE_FINISH
{
QMessageBox::critical(QApplication::activeWindow(), "FTT3D", "There is some critical error in the application. So it will be closed. \nPlease send error reports and related information to the administrators. \nThat will help us to improve the product.");
}
// Return CR_CB_DODEFAULT to generate error report
return CR_CB_NOTIFY_NEXT_STAGE ; //CR_CB_DODEFAULT;
}
DxCrashHandler::DxCrashHandler()
{
// Install crash reporting
CR_INSTALL_INFO info;
memset(&info, 0, sizeof(CR_INSTALL_INFO));
info.cb = sizeof(CR_INSTALL_INFO);
info.pszAppName = "TestAPP"; // Define application name.
info.pszAppVersion = "1.0"; // Define application version.
//Install all available exception handlers.
info.dwFlags |= CR_INST_ALL_POSSIBLE_HANDLERS;
info.dwFlags |= CR_INST_DONT_SEND_REPORT;
info.dwFlags |= CR_INST_STORE_ZIP_ARCHIVES ;
info.dwFlags |= CR_INST_AUTO_THREAD_HANDLERS ;
//Set the error reprot path
char lpsReportPath[MAX_PATH];
strcpy_s(lpsReportPath,
(LPCTSTR)(AddAppPath("ErrorReport")).toLocal8Bit().data()
);
info.pszErrorReportSaveDir = lpsReportPath;
// Article effective minidumps recommand the MiniDumpWithPrivateReadWriteMemory. But it cause the dump file up to 50 MB.
// So we use the MiniDumpWithIndirectlyReferencedMemory as alternative, which lost some information but ensure the
// a reasonable dump size.
// Not all flag will be used due to some callback not provided in crashrpt licrary. If more dump needed, we must modify the
// crashrpt code about crashdump.
info.uMiniDumpType = (MINIDUMP_TYPE)( // MiniDumpWithPrivateReadWriteMemory |
MiniDumpWithDataSegs |
MiniDumpWithHandleData |
// The following parameters are supported by 6.2 and later
MiniDumpWithIndirectlyReferencedMemory |
MiniDumpWithFullMemoryInfo |
MiniDumpWithThreadInfo |
MiniDumpWithUnloadedModules
);
int nResult = crInstall(&info);
if(nResult!=0)
{
QMessageBox::warning(NULL, "TestApp", "Prepare error report handler failed!");
}
// Set crash callback function
crSetCrashCallback(CrashCallback, NULL);
// Add the last application log
crAddFile2(
(LPCTSTR)(AddAppPath("TestApp.App.log")).toLocal8Bit().data(),
"TestApp.app.log",
("Log file"),
CR_AF_MAKE_FILE_COPY |CR_AF_MISSING_FILE_OK );
// Take screenshot of the app window at the moment of crash
crAddScreenshot2(CR_AS_MAIN_WINDOW|CR_AS_USE_JPEG_FORMAT, 95);
}
DxCrashHandler::~DxCrashHandler()
{
//Uninstall crash reporting
}

3. 在项目中引入Thirdparty - CrashRptProbe

根据以上的步骤，将CrashRptProbe的输入奔溃报告的路径指定后，我们便可以将它引入项目中了。

在项目的起始入口函数main.cpp中，需要实例化这个类的一个对象。

int main(int argc, char *argv[])
{
QApplication a(argc, argv);
// Initialize the crash handler
DxCrashHandler crashhandler;
return 0;
}

之后，我们便可以在项目中进行测试了。

以下是我的测试步骤，我在原来某一个文件调用一个指针的方法时，去掉了这个指针的new。因此，当程序运行到这里的时候，便会由于指针未初始化而发生奔溃。

（１）当发生奔溃后，不用担心。这时在Bin目录下面会自动生成一个名字为ErrorReport的文件夹，如图所示。

（２）然后打开这个文件，会出现一些压缩文件和文件夹。根据时间排序，找到最近生成的一个文件夹并打开，便可以看到本次奔溃的报告文件，后缀名为dmp文件。

（３）点击右键，选择VS2012打开该dmp文件，可以看到它会加载程序奔溃时的部分程序并打开。此时，在界面的右上部分的Actions下面，会有一个绿色的按钮，名称为 Debug with Native Only.

（４）点击这个绿色按钮后，会弹出一个异常信息提示框，如图所示。
然后点击这个提示对话框上的Break按钮，则可以看到它已经帮我们定位到了该源代码的第97行。因为，我之前测试时并没有去New这个m_pVolume的指针，因此当程序运行到这里时便会奔溃。

可见，这个工具可以非常高效地帮我们记录程序出现异常的位置，提高我们debug代码和查找异常的效率。

参考链接：

CrashRptProbe在Github上的地址：

https://github.com/bitshares/devshares/tree/master/CrashRpt https://groups.google.com/forum/#!msg/crashrpt/UEnzFEiXyAo/e3M_butCBQAJ

http://blog.csdn.net/caoshangpa/article/details/76575920