MiniDumpWriteDump是MS DbgHelp.dll 中一個API, 用于導出當前運行的程序的Dump. 這個dll程序系統中就有, 但是很多軟件, 都在自己的安裝目錄下保存了這個.dll的最新的版本.
為了測試這個API, 參考網上一些資料, 寫了一個簡單的C++ 程序. 目的是當有異常發生的時候, 自動生成Dump文件供之后的分析.
有了Dump文件, 我們就可以使用WinDBG等調試器來分析異常發生時的情況. 其實這個功能很多軟件都有, 比如QQ, 魔獸世界, 等等.
它們在出現了異常的時候會彈出一個對話框, 讓用戶輸入異常發生時的情況, 然后把異常的dump文件用email發回, 供開發者們分析修改bug.
不過有一點, 這里需要程序的調試符號文件(pdb文件). 對于Debug版來說, 是生成的, 但是Release版來說默認是不生成的.
可以設置VC的編譯器, 讓它在Release版的時候也生成調試信息. 這帶來一個新的問題, 因為.pdb里面是保存了源文件的信息的,
為了避免泄密, 可以采用VS中的CVPack工具, 從中去除敏感的信息.
程序需要使用Dbghelp.h 和 Dbghelp.lib . 它們可以從MSDN找到.
//最主要的函數, 生成Dump
static void DumpMiniDump(HANDLE hFile, PEXCEPTION_POINTERS excpInfo)
{
if (excpInfo == NULL) //如果沒有傳入異常, 比如是在程序里面調用的, 生成一個異常
{
// Generate exception to get proper context in dump
__try
{
OutputDebugString(_T("raising exception\r\n"));
RaiseException(EXCEPTION_BREAKPOINT, 0, 0, NULL);
}
__except(DumpMiniDump(hFile, GetExceptionInformation()),
EXCEPTION_CONTINUE_EXECUTION)
{
}
}
else
{
OutputDebugString(_T("writing minidump\r\n"));
MINIDUMP_EXCEPTION_INFORMATION eInfo;
eInfo.ThreadId = GetCurrentThreadId(); //把需要的信息添進去
eInfo.ExceptionPointers = excpInfo;
eInfo.ClientPointers = FALSE;
// 調用, 生成Dump. 98不支持
// Dump的類型是小型的, 節省空間. 可以參考MSDN生成更詳細的Dump.
MiniDumpWriteDump(
GetCurrentProcess(),
GetCurrentProcessId(),
hFile,
MiniDumpNormal,
excpInfo ? &eInfo : NULL,
NULL,
NULL);
}
}
下面的是程序部分:
int _tmain(int argc, _TCHAR* argv[])
{
// 創建一個Dump文件
HANDLE hFile = CreateFile( _T("MiniDump.dmp"), GENERIC_READ | GENERIC_WRITE,
0, NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL );
int code;
__try
{
// 把自己實現的main函數包裝一下, 放在try .. except 塊中. 這樣出現了異常可以自動生成dump
main_wrapper(argc, argv);
}
__except( code=GetExceptionCode(), DumpMiniDump(hFile, GetExceptionInformation() ), EXCEPTION_EXECUTE_HANDLER ) //出現了異常, 記錄異常的code, 生成dump!!
{
printf("%x\n", code);
wchar_t msg[512];
wsprintf(msg, L"Exception happened. Exception code is %x", code);
MessageBox(NULL, msg, L"Exception", MB_OK); //顯示消息給用戶
}
CloseHandle( hFile ); //關閉Dump文件
getchar();
return 0;
}
最下面是兩個測試的函數, main_wrapper函數將調用test1, test1將會生成一個異常(非法內存寫)
void test1() {
int *p;
p = (int*)0x100;
*p = 0; //寫0x100地址, 這個是非法的
}
void main_wrapper(int argc, _TCHAR* argv[]) {
test1();
}
運行, 異常被捕獲了:
同時, dump文件也生成了:
用WinDBG打開Dump文件, 可以清楚的看出異常出現的情況:
從中可以比較清楚的看到異常發生的情況(Exception code), 異常出現的地址(test1函數, 偏移0x28). 因為這次測試的是Debug版, 有保存了源代碼的.pdb文件, 所以WinDbg把源代碼也列出來了. 這樣可以非常容易的發現問題.
============================================
參考:
DbgHelp中的DumpAPI例子: http://www.debuginfo.com/examples/src/effminidumps/MiniDump.cpp
CrashReport: 程序出現異常的時候顯示發送錯誤的對話框, 并把Dump文件發送到指定的地址. http://code.google.com/p/crashrpt/
XCrashReport: 與上面的類似的一個開源項目. http://www.codeproject.com/KB/debug/XCrashReportPt1.aspx
作者：<leohe.leohe@gmail.com>
Linux系統中在應用程序運行過程中經常會遇到程序突然崩潰，提示：Segmentation
fault，這是因為應用程序收到了SIGSEGV信號。這個信號提示當進程發生了無效的存儲訪問，當接收到這個信號時，缺省動作是：終止w/core。
終止w/core的含義是：在進程當前目錄生成core文件，并將進程的內存映象復制到core文件中，core文件的默認名稱就是“core”（這是
Unix類系統的一個由來已久的功能）。
事實上，并不是只有SIGSEGV信號產生coredump，還有下面一些信號也產生coredump：SIGABRT（異常終止）、SIGBUS（硬件
故障）、SIGEMT（硬件故障）、SIGFPE（算術異常）、SIGILL（非法硬件指令）、SIGIOT（硬件故
障），SIGQUIT，SIGSYS（無效系統調用），SIGTRAP（硬件故障）等。
在程序的開發調試階段（尤其是大型軟件開發），發生程序異常崩潰時常規的調試方法常常是無比的痛苦：無窮的log中也不見得有什么有意義的信息。好在GDB提供和利用core文件進行調試的途徑，大大方便了這類問題的調試。
下面我們通過一個簡單的例子來看看怎么通過GDB來調試一個違規訪問內存導致的程序崩潰。這里我們順便講講動態庫的調試。
/******** mylib.h **********/
#ifndef __MY_LIB_H__
#define __MY_LIB_H__
int add(int x, int y);
#endif // __MY_LIB_H__
/******** end **********/
/******** mylib.c **********/
#include <stdlib.h>
#include "mylib.h"
int add(int x, int y)
{
char* pc = NULL;
*pc = 10;
return x + y;
}
/******** end **********/
/******** main.c **********/
#include <stdio.h>
#include <stdlib.h>
#include "mylib.h"
int main (void)
{
int ret = -1;
int a = 10, b = 20;
ret = add(a, b);
printf("The result is: %d\n", ret);
return 0;
}
/******** end **********/
#####################################
# File Name: Makefile
#
#####################################
CC = gcc
LD = gcc
all:
$(CC) mylib.c -g -I. -fPIC -shared -o libmylib.so
$(CC) main.c -g -I. -L. -lmylib -o test
clean:
rm *.so test
############# END ###############
首先將上面的代碼分別存儲到相應的目錄,名稱為：mylib.h、mylib.c、main.c、Makefile。
1）編譯測試代碼。注）編譯時的 -g 選項是必須的。
[xxx@yyy]$ make
gcc mylib.c -g -I. -fPIC -shared -o libmylib.so
gcc main.c -g -I. -L. -lmylib -o t
通過ls命令我們可以看到生成了測試程序test.
[xxx@yyy]$ ls
libmylib.so main.c Makefile mylib.c mylib.h test
2）執行測試程序
[xxx@yyy]$ ./test
./test: error while loading shared libraries: libmylib.so: cannot open shared object file: No such file or directory
這個錯誤表明程序在運行階段不能找到相應的動態庫文件，此時需要通過環境變量 LD_LIBRARY_PATH 來指定運行期動態庫的搜索目錄，我們的動態庫就在當前目錄，如下：
[xxx@yyy]$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:.
3）再次執行測試程序
[leo@localhost debug]$ ./test
Segmentation fault
[leo@localhost debug]$ ls
libmylib.so main.c Makefile mylib.c mylib.h test
4）設置core文件大小
Segmentation fault如期而至，但是卻沒有我們更想見到的core文件！
原來系統在默認情況下core文件的大小設置為0，換句話講也就是不產生core文件。我們可以通過 ulimit 命令來修改core文件的大小，unlimited表示不限制core文件的大小，如下（設置core文件的大小需要root權限）：
[root@yyy]# ulimit -c unlimited
[root@yyy]# ./test
Segmentation fault (core dumped)
[root@yyy]# ls
core.2890 libmylib.so main.c Makefile mylib.c mylib.h test
5）設置core文件的格式，輸出路徑
通過下面命令我們還可以指定core文件的命名格式，路徑等（需要root權限）：
[root@yyy]# echo "core_%e_%s" >/proc/sys/kernel/core_pattern
[root@yyy]# ./test
Segmentation fault (core dumped)
[root@yyy]# ls
core.2890 core_test_11.2898 libmylib.so main.c Makefile mylib.c mylib.h test
6）調試
[root@yyy]# gdb test core.2890
GNU gdb Red Hat Linux (6.5-8.fc6rh)
Copyright (C) 2006 Free Software Foundation, Inc.
GDB is free software, covered by the GNU General Public License, and you are
welcome to change it and/or distribute copies of it under certain conditions.
Type "show copying" to see the conditions.
There is absolutely no warranty for GDB. Type "show warranty" for details.
This GDB was configured as "i386-redhat-linux-gnu"...Using host libthread_db library "/lib/libthread_db.so.1".
Core was generated by `./test'.
Program terminated with signal 11, Segmentation fault.
Error while mapping shared library sections:
libmylib.so: Success.
Reading symbols from /home/xxx/tst/libmylib.so...done.
Loaded symbols for libmylib.so
Reading symbols from /lib/i686/libc.so.6...done.
Loaded symbols for /lib/i686/libc.so.6
Reading symbols from /lib/ld-linux.so.2...done.
Loaded symbols for /lib/ld-linux.so.2
#0 0x00a8969c in ?? ()
(gdb)
鍵入GDB命令 where
(gdb) where
#0 0x001ec44c in ?? ()
#1 0x00000000 in ?? ()
?? ()并不是我們想看到的，之所以這樣，是因為GDB不能正確加載我們編寫的動態庫libmylib.so，我們需要在這里設置GDB的動態庫搜索路徑,如下：
(gdb) set solib-search-path .
Reading symbols from /home/xxx/test/tst/libmylib.so...done.
Loaded symbols for /home/xxx/test/tst/libmylib.so
Reading symbols from /lib/i686/libc.so.6...done.
Loaded symbols for /lib/i686/libc.so.6
Reading symbols from /lib/ld-linux.so.2...done.
Loaded symbols for /lib/ld-linux.so.2
可以看到GDB已經加載了libmylib.so，再次鍵入where命令：
(gdb) where
#0 0x001ec44c in add (x=10, y=20) at mylib.c:8
#1 0x0804847c in main () at main.c:12
(gdb)
這次我們期待的結果出現了，GDB清楚的列出了錯誤出現的位置：mylib.c的第8行，好了，到那里去改code吧！