目录
- 1. 使用qBreakpad
- 1.1. 下载
- 1.2. 编译
- 1.3. 使用
- 2. 使用dump文件
- 2.1. 编译breakpad
- 2.2. 解析dmp文件
- 生成sym文件
- 2.3. 解析dmp
- 可能遇到的问题
- 问题一
Qt程序的release版本交付给用户或者测试后,如果出现崩溃,很多时候都比较难重现,如果程序能自动定位到出错的位置,可以大大降低重现难度。
google的qBreakpad库提供了在Qt程序崩溃时生成dump文件的功能,dump文件配合breakpad的工具可以定位到程序出错的函数及其行号。
1. 使用qBreakpad
1.1. 下载
qBreakpad依赖了breakpad和lss,所以要把breakpad和lss也下载了。
qBreakpad下载地址:https://github.com/buzzySmile/qBreakpad
breakpad下载地址:https://github.com/google/breakpad/tree/v2021.08.09
lss下载地址:https://github.com/ithaibo/linux-syscall-support
编译qBreakpad的时候可能会报各种错误,应该跟版本不兼容有关,网上给出的解决方案也因为版本不一致的缘故,不一定有用,如果编译不过的话可以参考我选的版本。
1.2. 编译
把下载好的breakpad和linux-syscall-support解压后分别改名为breakpad和lss,放到qBreakpad的third_party路径下,如下图所示。
用qtcreator打开qBreakpad.pro,项目里包含了demo、handler、tests三个子模块,对它们分别进行编译。
三个模块都编译没有出错,代表版本的兼容性没有问题。
其中handler模块编译出来的库是我们需要的,另外两个模块可以不管,主要用来测试能不能编得过。
进入handler可以看到以下文件,代表编译成功。
1.3. 使用
创建一个测试项目crash_demo,把qBreakpad/handler里的.h和.a文件复制到项目中,如下图所示。
然后在crash_demo.pro里加入以下语句。
#qBreakpad用到network模块
QT += network
#添加qBreakpad库
LIBS += -L$$PWD/qBreakpad/ -lqBreakpad
INCLUDEPATH += $$PWD/qBreakpad/
DEPENDPATH += $$PWD/qBreakpad/
#添加调试信息
QMAKE_CXXFLAGS_RELEASE = $$QMAKE_CFLAGS_RELEASE_WITH_DEBUGINFO
QMAKE_LFLAGS_RELEASE = $$QMAKE_LFLAGS_RELEASE_WITH_DEBUGINFO
在main.cpp加入以下代码。
#include "mainwindow.h"
#include <QApplication>
#include <QBreakpadHandler.h>
#include <QBreakpadHttpUploader.h>
int main(int argc, char *argv[])
{
QApplication a(argc, argv);
QBreakpadInstance.setDumpPath("crashes"); //设置dump生成的路径为crashes
MainWindow w;
w.show();
return a.exec();
}
接下来,在项目中添加引起崩溃的代码,以下是我测试用的示例。
界面
代码,将界面上的两个按钮的点击信号和槽绑定。
void MainWindow::on_pushButton_clicked()
{
int *a = new int;
*a = 20;
int *i = NULL;
*i = 10;
}
void MainWindow::on_pushButton_2_clicked()
{
int *i = NULL;
*i = 10;
}
编译项目并运行,触发崩溃代码之后会看到dmp文件已被生成。
2. 使用dump文件
dump文件是经过加密的,打开后全是乱码,需要用工具来解析,breakpad提供了这样的工具。
2.1. 编译breakpad
编译需要breakpad和linux-syscall-support源码,直接编译上一节下载的源码即可,下面是编译的步骤。
- 把linux-syscall-support改名为lss,放到breakpad/src/third_party下,如图所示。
- 回到breakpad目录,打开终端,执行以下命令。
./configure
make -j4
- 编译完成后,可以看到breakpad/src/tools/linux/dump_syms路径下生成了dump_syms可执行文件,如图所示,编译完成。
如果编译的过程中出错,或者发现dump_syms没有被生成,可以直接去下载别人编译好的,不必纠结那么多,解决问题挺浪费时间的。
别人编译好的:https://download.csdn.net/download/a343981218/9722549
2.2. 解析dmp文件
生成sym文件
直接解析dmp文件只能看到函数的地址信息,看不到函数名,这样可读性很差,配合sym文件来解析dmp可以定位到函数名及其行号。
把crash_demo的可执行文件复制到dump_syms的同级目录下,如图所示。
打开终端,执行以下指令,这时候会生成一个crash_demo.sym文件。
./dump_syms ./crash_demo > crash_demo.sym
用编辑器打开crash_demo.sym,找到下图中框住的字符串,复制到剪切板,我这里的sym文件是F3001B6F0C80C8C37F6926EB67F753830。
sym文件需要用规定的目录结构来存放,创建以下目录结构,把sym文件放进去,如图所示。
symbol/crash_demo/F3001B6F0C80C8C37F6926EB67F753830
2.3. 解析dmp
把上一节生成的symbol文件夹和应用程序生成的crashes文件夹都复制到breakpad/src/processor.
打开终端,执行以下命令。
./minidump_stackwalk ./crashes/ba428698-a447-42bc-b7ab5380-d191d36f.dmp ./symbol > result.txt
执行完毕后会生成result.txt文件,打开它就可以看到程序的崩溃信息,与代码是相对应的。
可能遇到的问题
问题一
解析dmp文件后,得到的result.txt可能会只显示了十六进制的地址,没有显示函数名和行号,出现这种情况就代表解析时未找到sym文件。
解决方法:检查sym和dmp是否匹配,检查sym的路径是否有问题。