MiniDumpWriteDump是MS DbgHelp.dll 中一個(gè)API, 用于導(dǎo)出當(dāng)前運(yùn)行的程序的Dump. 這個(gè)dll程序系統(tǒng)中就有, 但是很多軟件, 都在自己的安裝目錄下保存了這個(gè).dll的最新的版本.
為了測(cè)試這個(gè)API, 參考網(wǎng)上一些資料, 寫(xiě)了一個(gè)簡(jiǎn)單的C++ 程序. 目的是當(dāng)有異常發(fā)生的時(shí)候, 自動(dòng)生成Dump文件供之后的分析.
有了Dump文件, 我們就可以使用WinDBG等調(diào)試器來(lái)分析異常發(fā)生時(shí)的情況. 其實(shí)這個(gè)功能很多軟件都有, 比如QQ, 魔獸世界, 等等.
它們?cè)诔霈F(xiàn)了異常的時(shí)候會(huì)彈出一個(gè)對(duì)話(huà)框, 讓用戶(hù)輸入異常發(fā)生時(shí)的情況, 然后把異常的dump文件用email發(fā)回, 供開(kāi)發(fā)者們分析修改bug.
不過(guò)有一點(diǎn), 這里需要程序的調(diào)試符號(hào)文件(pdb文件). 對(duì)于Debug版來(lái)說(shuō), 是生成的, 但是Release版來(lái)說(shuō)默認(rèn)是不生成的.
可以設(shè)置VC的編譯器, 讓它在Release版的時(shí)候也生成調(diào)試信息. 這帶來(lái)一個(gè)新的問(wèn)題, 因?yàn)?pdb里面是保存了源文件的信息的,
為了避免泄密, 可以采用VS中的CVPack工具, 從中去除敏感的信息.
程序需要使用Dbghelp.h 和 Dbghelp.lib . 它們可以從MSDN找到.
//最主要的函數(shù), 生成Dump
static void DumpMiniDump(HANDLE hFile, PEXCEPTION_POINTERS excpInfo)
{
if (excpInfo == NULL) //如果沒(méi)有傳入異常, 比如是在程序里面調(diào)用的, 生成一個(gè)異常
{
// 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(); //把需要的信息添進(jìn)去
eInfo.ExceptionPointers = excpInfo;
eInfo.ClientPointers = FALSE;
// 調(diào)用, 生成Dump. 98不支持
// Dump的類(lèi)型是小型的, 節(jié)省空間. 可以參考MSDN生成更詳細(xì)的Dump.
MiniDumpWriteDump(
GetCurrentProcess(),
GetCurrentProcessId(),
hFile,
MiniDumpNormal,
excpInfo ? &eInfo : NULL,
NULL,
NULL);
}
}
下面的是程序部分:
int _tmain(int argc, _TCHAR* argv[])
{
// 創(chuàng)建一個(gè)Dump文件
HANDLE hFile = CreateFile( _T("MiniDump.dmp"), GENERIC_READ | GENERIC_WRITE,
0, NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL );
int code;
__try
{
// 把自己實(shí)現(xiàn)的main函數(shù)包裝一下, 放在try .. except 塊中. 這樣出現(xiàn)了異常可以自動(dòng)生成dump
main_wrapper(argc, argv);
}
__except( code=GetExceptionCode(), DumpMiniDump(hFile, GetExceptionInformation() ), EXCEPTION_EXECUTE_HANDLER ) //出現(xiàn)了異常, 記錄異常的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); //顯示消息給用戶(hù)
}
CloseHandle( hFile ); //關(guān)閉Dump文件
getchar();
return 0;
}
最下面是兩個(gè)測(cè)試的函數(shù), main_wrapper函數(shù)將調(diào)用test1, test1將會(huì)生成一個(gè)異常(非法內(nèi)存寫(xiě))
void test1() {
int *p;
p = (int*)0x100;
*p = 0; //寫(xiě)0x100地址, 這個(gè)是非法的
}
void main_wrapper(int argc, _TCHAR* argv[]) {
test1();
}
運(yùn)行, 異常被捕獲了:
同時(shí), dump文件也生成了:
用WinDBG打開(kāi)Dump文件, 可以清楚的看出異常出現(xiàn)的情況:
從中可以比較清楚的看到異常發(fā)生的情況(Exception code), 異常出現(xiàn)的地址(test1函數(shù), 偏移0x28). 因?yàn)檫@次測(cè)試的是Debug版, 有保存了源代碼的.pdb文件, 所以WinDbg把源代碼也列出來(lái)了. 這樣可以非常容易的發(fā)現(xiàn)問(wèn)題.
============================================
參考:
DbgHelp中的DumpAPI例子: http://www.debuginfo.com/examples/src/effminidumps/MiniDump.cpp
CrashReport: 程序出現(xiàn)異常的時(shí)候顯示發(fā)送錯(cuò)誤的對(duì)話(huà)框, 并把Dump文件發(fā)送到指定的地址. http://code.google.com/p/crashrpt/
XCrashReport: 與上面的類(lèi)似的一個(gè)開(kāi)源項(xiàng)目. http://www.codeproject.com/KB/debug/XCrashReportPt1.aspx
作者：<leohe.leohe@gmail.com>
Linux系統(tǒng)中在應(yīng)用程序運(yùn)行過(guò)程中經(jīng)常會(huì)遇到程序突然崩潰，提示：Segmentation
fault，這是因?yàn)閼?yīng)用程序收到了SIGSEGV信號(hào)。這個(gè)信號(hào)提示當(dāng)進(jìn)程發(fā)生了無(wú)效的存儲(chǔ)訪問(wèn)，當(dāng)接收到這個(gè)信號(hào)時(shí)，缺省動(dòng)作是：終止w/core。
終止w/core的含義是：在進(jìn)程當(dāng)前目錄生成core文件，并將進(jìn)程的內(nèi)存映象復(fù)制到core文件中，core文件的默認(rèn)名稱(chēng)就是“core”（這是
Unix類(lèi)系統(tǒng)的一個(gè)由來(lái)已久的功能）。
事實(shí)上，并不是只有SIGSEGV信號(hào)產(chǎn)生coredump，還有下面一些信號(hào)也產(chǎn)生coredump：SIGABRT（異常終止）、SIGBUS（硬件
故障）、SIGEMT（硬件故障）、SIGFPE（算術(shù)異常）、SIGILL（非法硬件指令）、SIGIOT（硬件故
障），SIGQUIT，SIGSYS（無(wú)效系統(tǒng)調(diào)用），SIGTRAP（硬件故障）等。
在程序的開(kāi)發(fā)調(diào)試階段（尤其是大型軟件開(kāi)發(fā)），發(fā)生程序異常崩潰時(shí)常規(guī)的調(diào)試方法常常是無(wú)比的痛苦：無(wú)窮的log中也不見(jiàn)得有什么有意義的信息。好在GDB提供和利用core文件進(jìn)行調(diào)試的途徑，大大方便了這類(lèi)問(wèn)題的調(diào)試。
下面我們通過(guò)一個(gè)簡(jiǎn)單的例子來(lái)看看怎么通過(guò)GDB來(lái)調(diào)試一個(gè)違規(guī)訪問(wèn)內(nèi)存導(dǎo)致的程序崩潰。這里我們順便講講動(dòng)態(tài)庫(kù)的調(diào)試。
/******** 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 ###############
首先將上面的代碼分別存儲(chǔ)到相應(yīng)的目錄,名稱(chēng)為：mylib.h、mylib.c、main.c、Makefile。
1）編譯測(cè)試代碼。注）編譯時(shí)的 -g 選項(xiàng)是必須的。
[xxx@yyy]$ make
gcc mylib.c -g -I. -fPIC -shared -o libmylib.so
gcc main.c -g -I. -L. -lmylib -o t
通過(guò)ls命令我們可以看到生成了測(cè)試程序test.
[xxx@yyy]$ ls
libmylib.so main.c Makefile mylib.c mylib.h test
2）執(zhí)行測(cè)試程序
[xxx@yyy]$ ./test
./test: error while loading shared libraries: libmylib.so: cannot open shared object file: No such file or directory
這個(gè)錯(cuò)誤表明程序在運(yùn)行階段不能找到相應(yīng)的動(dòng)態(tài)庫(kù)文件，此時(shí)需要通過(guò)環(huán)境變量 LD_LIBRARY_PATH 來(lái)指定運(yùn)行期動(dòng)態(tài)庫(kù)的搜索目錄，我們的動(dòng)態(tài)庫(kù)就在當(dāng)前目錄，如下：
[xxx@yyy]$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:.
3）再次執(zhí)行測(cè)試程序
[leo@localhost debug]$ ./test
Segmentation fault
[leo@localhost debug]$ ls
libmylib.so main.c Makefile mylib.c mylib.h test
4）設(shè)置core文件大小
Segmentation fault如期而至，但是卻沒(méi)有我們更想見(jiàn)到的core文件！
原來(lái)系統(tǒng)在默認(rèn)情況下core文件的大小設(shè)置為0，換句話(huà)講也就是不產(chǎn)生core文件。我們可以通過(guò) ulimit 命令來(lái)修改core文件的大小，unlimited表示不限制core文件的大小，如下（設(shè)置core文件的大小需要root權(quán)限）：
[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）設(shè)置core文件的格式，輸出路徑
通過(guò)下面命令我們還可以指定core文件的命名格式，路徑等（需要root權(quán)限）：
[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）調(diào)試
[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 ?? ()
?? ()并不是我們想看到的，之所以這樣，是因?yàn)镚DB不能正確加載我們編寫(xiě)的動(dòng)態(tài)庫(kù)libmylib.so，我們需要在這里設(shè)置GDB的動(dòng)態(tài)庫(kù)搜索路徑,如下：
(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已經(jīng)加載了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)
這次我們期待的結(jié)果出現(xiàn)了，GDB清楚的列出了錯(cuò)誤出現(xiàn)的位置：mylib.c的第8行，好了，到那里去改code吧！