编写的windows程序，崩溃时产生crash dump文件的办法

一、引言

dump文件是C++程序发生异常时，保存当时程序运行状态的文件，是调试异常程序重要的方法，所以程序崩溃时，除了日志文件，dump文件便成了我们查找错误的最后一根救命的稻草。windows程序产生dump文件和linux程序产生dump文件的方式不一样，linux默认是不让产生core dump文件，只要在用户自己的~/.bash_profile文件中增加

ulimit -S -c unlimited > /dev/null 2>&1

这样程序崩溃就可以产生可调试的core dump文件了。但是windows环境就得写代码才能实现了。

二、原理

windows程序当遇到异常，没有try-catch或者try-catch也无法捕获到的异常时，程序就会自动退出，如果这时候没有dump文件的话，我们是没有得到任何程序退出的信息。在windows程序异常退出之前，会预先调用一个在程序中注册的异常处理回调函数（默认是没有设置），只要我们在这个回调函数中调用MiniDumpWriteDump函数就可以产生我们想要的dump文件。

三、实现

1.调用SetUnhandledExceptionFilter注册一个自定义的异常处理回调函数

SetUnhandledExceptionFilter(MyUnhandledExceptionFilter);

异常处理回调函数的原型

LONG __stdcall MyUnhandledExceptionFilter(PEXCEPTION_POINTERS pExceptionInfo);

2.CreateFile创建dump文件，调用MiniDumpWriteDump函数往dump文件写异常信息

1. inline void CreateMiniDump(PEXCEPTION_POINTERS pep, LPCTSTR strFileName)
2. {
3. HANDLE hFile = CreateFile(strFileName, GENERIC_READ | GENERIC_WRITE,
4. FILE_SHARE_WRITE, NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
5. if((hFile != NULL) && (hFile != INVALID_HANDLE_VALUE))
6. {
7. MINIDUMP_EXCEPTION_INFORMATION mdei;
8. mdei.ThreadId           = GetCurrentThreadId();
9. mdei.ExceptionPointers  = pep;
10. mdei.ClientPointers     = NULL;
11. MINIDUMP_CALLBACK_INFORMATION mci;
12. mci.CallbackRoutine     = (MINIDUMP_CALLBACK_ROUTINE)MiniDumpCallback;
13. mci.CallbackParam       = 0;
14. ::MiniDumpWriteDump(::GetCurrentProcess(), ::GetCurrentProcessId(), hFile, MiniDumpNormal, (pep != 0) ? &mdei : 0, NULL, &mci);
15. CloseHandle(hFile);
16. }
17. }

CreateMiniDump函数是在异常处理回调函数MyUnhandledExceptionFilter中调用的

1. LONG __stdcall MyUnhandledExceptionFilter(PEXCEPTION_POINTERS pExceptionInfo)
2. {
3. CreateMiniDump(pExceptionInfo, "core.dmp");
4. return EXCEPTION_EXECUTE_HANDLER;
5. }

3.将SetUnhandledExceptionFilter失效

vs2005中，编译的过程中，编译器会自动给你的程序加上一句SetUnhandledExceptionFilter(NULL)，这就会导致你之前自定义的

SetUnhandledExceptionFilter(MyUnhandledExceptionFilter);

无效，就有可能不会产生dump文件，因此我们必须在自定义的SetUnhandledExceptionFilter之后，让之后调用的SetUnhandledExceptionFilter无效。增加以下代码：

1. // 此函数一旦成功调用，之后对 SetUnhandledExceptionFilter 的调用将无效
2. void DisableSetUnhandledExceptionFilter()
3. {
4. void* addr = (void*)GetProcAddress(LoadLibrary("kernel32.dll"),
5. "SetUnhandledExceptionFilter");
6. if (addr)
7. {
8. unsigned char code[16];
9. int size = 0;
10. code[size++] = 0x33;
11. code[size++] = 0xC0;
12. code[size++] = 0xC2;
13. code[size++] = 0x04;
14. code[size++] = 0x00;
15. DWORD dwOldFlag, dwTempFlag;
16. VirtualProtect(addr, size, PAGE_READWRITE, &dwOldFlag);
17. WriteProcessMemory(GetCurrentProcess(), addr, code, size, NULL);
18. VirtualProtect(addr, size, dwOldFlag, &dwTempFlag);
19. }
20. }

最终代码整理：

//minidump.h

1. #pragma once
2. #include <windows.h>
3. #include <DbgHelp.h>
4. #include <stdlib.h>
5. #pragma comment(lib, "dbghelp.lib")
6. #ifndef _M_IX86
7. #error "The following code only works for x86!"
8. #endif
9. inline BOOL IsDataSectionNeeded(const WCHAR* pModuleName)
10. {
11. if(pModuleName == 0)
12. {
13. return FALSE;
14. }
15. WCHAR szFileName[_MAX_FNAME] = L"";
16. _wsplitpath(pModuleName, NULL, NULL, szFileName, NULL);
17. if(wcsicmp(szFileName, L"ntdll") == 0)
18. return TRUE;
19. return FALSE;
20. }
21. inline BOOL CALLBACK MiniDumpCallback(PVOID                            pParam,
22. const PMINIDUMP_CALLBACK_INPUT   pInput,
23. PMINIDUMP_CALLBACK_OUTPUT        pOutput)
24. {
25. if(pInput == 0 || pOutput == 0)
26. return FALSE;
27. switch(pInput->CallbackType)
28. {
29. case ModuleCallback:
30. if(pOutput->ModuleWriteFlags & ModuleWriteDataSeg)
31. if(!IsDataSectionNeeded(pInput->Module.FullPath))
32. pOutput->ModuleWriteFlags &= (~ModuleWriteDataSeg);
33. case IncludeModuleCallback:
34. case IncludeThreadCallback:
35. case ThreadCallback:
36. case ThreadExCallback:
37. return TRUE;
38. default:;
39. }
40. return FALSE;
41. }
42. inline void CreateMiniDump(PEXCEPTION_POINTERS pep, LPCTSTR strFileName)
43. {
44. HANDLE hFile = CreateFile(strFileName, GENERIC_READ | GENERIC_WRITE,
45. FILE_SHARE_WRITE, NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
46. if((hFile != NULL) && (hFile != INVALID_HANDLE_VALUE))
47. {
48. MINIDUMP_EXCEPTION_INFORMATION mdei;
49. mdei.ThreadId           = GetCurrentThreadId();
50. mdei.ExceptionPointers  = pep;
51. mdei.ClientPointers     = NULL;
52. MINIDUMP_CALLBACK_INFORMATION mci;
53. mci.CallbackRoutine     = (MINIDUMP_CALLBACK_ROUTINE)MiniDumpCallback;
54. mci.CallbackParam       = 0;
55. ::MiniDumpWriteDump(::GetCurrentProcess(), ::GetCurrentProcessId(), hFile, MiniDumpNormal, (pep != 0) ? &mdei : 0, NULL, &mci);
56. CloseHandle(hFile);
57. }
58. }
59. LONG __stdcall MyUnhandledExceptionFilter(PEXCEPTION_POINTERS pExceptionInfo)
60. {
61. CreateMiniDump(pExceptionInfo, "core.dmp");
62. return EXCEPTION_EXECUTE_HANDLER;
63. }
64. // 此函数一旦成功调用，之后对 SetUnhandledExceptionFilter 的调用将无效
65. void DisableSetUnhandledExceptionFilter()
66. {
67. void* addr = (void*)GetProcAddress(LoadLibrary("kernel32.dll"),
68. "SetUnhandledExceptionFilter");
69. if (addr)
70. {
71. unsigned char code[16];
72. int size = 0;
73. code[size++] = 0x33;
74. code[size++] = 0xC0;
75. code[size++] = 0xC2;
76. code[size++] = 0x04;
77. code[size++] = 0x00;
78. DWORD dwOldFlag, dwTempFlag;
79. VirtualProtect(addr, size, PAGE_READWRITE, &dwOldFlag);
80. WriteProcessMemory(GetCurrentProcess(), addr, code, size, NULL);
81. VirtualProtect(addr, size, dwOldFlag, &dwTempFlag);
82. }
83. }
84. void InitMinDump()
85. {
86. //注册异常处理函数
87. SetUnhandledExceptionFilter(MyUnhandledExceptionFilter);
88. //使SetUnhandledExceptionFilter
89. DisableSetUnhandledExceptionFilter();
90. }

4.测试代码

//test.cpp

1. #include <iostream>
2. #include "minidump.h"
3. void test()
4. {
5. std::string s = "abcd";
6. try{
7. s[100] = 'b';
8. }
9. catch(std::exception& e)
10. {
11. std::cout << "with exception:[" << e.what() << "]" << std::endl;
12. }
13. catch(...)
14. {
15. std::cout << "with unknown exception" << std::endl;
16. }
17. }
18. void main()
19. {
20. InitMinDump();
21. test();
22. system("pause");
23. }