记录：MSVC+Qt生成dump文件

傷城~ 2022-10-29 09:24 406阅读 0赞

本文只是记录下 MSVC+Qt 生成 dump 的代码。

dump 文件能够保存程序内部的内存、堆栈、句柄、线程等程序运行相关的信息，当程序异常无法在调试环境里解决时，dump 文件是分析问题的重要手段。

相关 win API 文档可以在 MSDN 查看：[https://docs.microsoft.com/zh-cn/search/?terms=MiniDumpWriteDump][https_docs.microsoft.com_zh-cn_search_terms_MiniDumpWriteDump]

DUMPTYPE 参数我只使用了 MiniDumpNormal，可以根据文档加上自己需要的。

dump 文件一般配合 pdb 文件使用，通过 pdb 可以找到堆栈地址对应的函数、行号等。

如果使用的 QtCreator，可以打开如下设置：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70][]

如果使用 VS ，可以打开如下两个设置：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70 1][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70 2][]

生成 dump 完整代码：

#include "mainwindow.h"
    #include "CrashDump.h"
    
    #include <QApplication>
    
    int main(int argc, char *argv[])
    {
        CrashDump::init("Test");
    
        QApplication a(argc, argv);
        MainWindow w;
        w.show();
        return a.exec();
    }

#pragma once
    
    #include <QObject>
    #include <QCalendar>
    #include <QDateTime>
    #include <QFileInfo>
    #include <QDir>
    #include <Windows.h>
    #include <DbgHelp.h>
    #pragma comment(lib, "DbgHelp")
    #include <iostream>
    
    static QString __module_name;
    
    /**
     * @brief MSVC+Qt 生成dump文件
     * @author 龚建波
     * @date 2021-2-11
     * @details 配合pdb文件使用，生成exe时记得生成dpb
     */
    class CrashDump
    {
    public:
        //初始化注册
        static void init(const QString &module)
        {
            __module_name=module;
            //异常捕获
            ::SetUnhandledExceptionFilter((LPTOP_LEVEL_EXCEPTION_FILTER)exceptionFilter);
        }
    
        //获取exe路径
        static QString getAppPath()
        {
            DWORD v;
            QVarLengthArray<char, 2048> buffer;
            size_t size = 0;
            do {
                size += 2048;
                buffer.resize((int)size);
                v = ::GetModuleFileNameA(NULL, buffer.data(), DWORD(buffer.size()));
            } while (v >= size);
    
            return QString::fromLocal8Bit(buffer.data(), v);
        }
    
        //生成dump路径，可以自定义路径以及命名格式
        static QString getDumpPath()
        {
            QFileInfo app_info(getAppPath());
            QString dump_path=QString("%1/dump/%2 %3.dmp")
                    .arg(app_info.absolutePath())
                    .arg(__module_name)
                    .arg(QDateTime::currentDateTime().toString("yyyy_MM_dd hh.mm.ss"));
            QFileInfo dump_info(dump_path);
            if(!dump_info.dir().exists()&&!dump_info.dir().mkpath(dump_info.absolutePath()))
                dump_path=QString("%1.dump").arg(__module_name);
            return dump_path;
        }
    
        //异常处理
        static LONG exceptionFilter(LPEXCEPTION_POINTERS lpExceptionInfo)
        {
            QString dump_path = getDumpPath();
            std::cerr<<"crash dump:"<<dump_path.toStdString()<<std::endl;
    
            //创建文件
            HANDLE file_handle = ::CreateFileA(dump_path.toLocal8Bit().data(), GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
            if (file_handle != INVALID_HANDLE_VALUE) {
                DWORD dump_type = MiniDumpNormal; //可以加上需要的其他枚举值
                MINIDUMP_EXCEPTION_INFORMATION dump_info;
                dump_info.ClientPointers = TRUE;
                dump_info.ExceptionPointers = lpExceptionInfo;
                dump_info.ThreadId = ::GetCurrentThreadId();
                //写入dump
                ::MiniDumpWriteDump(GetCurrentProcess(), GetCurrentProcessId(), file_handle, (MINIDUMP_TYPE)dump_type, &dump_info, NULL, NULL);
            }
            ::CloseHandle(file_handle);
            //这里可以把程序拉起来
            return EXCEPTION_CONTINUE_SEARCH; //or EXCEPTION_EXECUTE_HANDLER
        }
    };

程序遇到异常生成 dump 文件后，可以使用 VS 打开：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70 3][]

这里符号路径我只设置了 exe 对应 pdb 的路径：

![20210211191053958.png][]

最后点仅限本机调试就可以看到异常现场了：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70 4][]

（2021-3-26）要注意的是，SetUnhandledExceptionFilter 并不能捕获所有的异常，可以搜索其他的相关函数：

//terminate()
        set_terminate(terminateHandler);
        //printf(NULL)
        _set_invalid_parameter_handler(invalidParameterHandler);
        //调用纯虚函数
        _set_purecall_handler(purecallHandler);
        //new异常
        _set_new_handler(newHandler);

[https_docs.microsoft.com_zh-cn_search_terms_MiniDumpWriteDump]: https://docs.microsoft.com/zh-cn/search/?terms=MiniDumpWriteDump
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70]: /images/20221024/929e83ed33bf4265909a745a6627b88b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70 1]: /images/20221024/2e18a186f72b4e9d93e12a75a9bf607e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70 2]: /images/20221024/5ae36c58e16840ffbc91b5982f8c87d7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70 3]: /images/20221024/09b31db053f947b690da84e5d43283fd.png
[20210211191053958.png]: /images/20221024/a0beaca69886495aa39cd191c10dfd5c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70 4]: /images/20221024/440ad894cf384bda86295ef91a7274f2.png