Google Breakpad 完全解析（一） —— Windows入門篇
2011年01月23日 — Asp J
原創文章，轉載請標明出處：Soul Apogee (http://bigasp.com)，謝謝。
Google breakpad是 一個非常實用的跨平臺的崩潰轉儲和分析模塊，他支持Windows，Linux和Mac和Solaris。由于他本身跨平臺，所以很大的減少我們在平臺移 植時的工作，畢竟崩潰轉儲，每個平臺下都不同，使用起來很難統一，而Google breakpad就幫我們做到了這一點，不管是哪個平臺下的崩潰，都能夠進行統一的分析。現在很多工程都在使用他：最著名的幾個如 Chrome，Firefox，Picasa和Google Earth。另外他的License是BSD的，也就是說，我們即便是在商業軟件中使用，也是合法的，哈哈，這么好的東西，我們能放過么？現在就讓我們來 看看這個神奇的軟件吧。
原理簡介
breakpad抓取dump的方式和一般我們抓取dump的方式不一樣。在breakpad的wiki上有一幅圖可以很好的概括他的原理。
breakpad把應用程序分成三個部分，代碼，breakpad客戶端和調試信息。
1. 在build system中，通過symbol dumper用平臺相關的調試信息生成平臺無關的symbol文件。這樣做的好處很明顯，一旦平臺無關了，所有平臺的崩潰就可以做統一的分析了。
2. breakpad采取進程外轉儲和分析崩潰的方式，他使用C/S結構，客戶端用來捕獲當前進程中發生的崩潰，并通知服務端崩潰發生。服務端用來響應客戶端，抓取dump文件。這樣做的目的是為了減少崩潰進程對dump的影響。
3. Dump生成后轉發到崩潰分析器中，這個部分可以在本地也可以在服務器上，他對Dump文件進行解析，生成可讀的堆棧信息。
這就是breakpad處理dump大概的流程。
對于原理的介紹google寫的已經相當好了。更多的詳細信息，可以直接移步到breakpad的wiki。
安裝和編譯
breakpad的編譯比較曲折，所以在此記錄一下。
編譯breakpad，請確認你的機器上裝有以下的軟件：
1. python 2.4.3
請不要使用python3，會報錯。另外python2中推薦這個版本，使用新的版本在編譯其他google的工程時有時會報錯
2. Windows SDK 7
如果沒有這個，編譯會報錯。另外這個是在線安裝，時間很久，最好并行做其他的事情。
3. VS2005的補丁
KB918559
KB926601
KB935225
KB943969
KB947315
已經安裝了以上軟件的童鞋，就可以開始進行下面的工作鳥
1. 使用svn把代碼checkout下來
1 2 | # Non-members may check out a read-only working copy anonymously over HTTP.
svn checkout http://google-breakpad.googlecode.com/svn/trunk/ google-breakpad-read-only
|
2. 設置Windows SDK 7
裝過其他版本Windows SDK的童鞋，記得一定要進行這一步，SDK的安裝程序，并不會幫你設置VS。
運行開始菜單->程序->Microsoft Windows SDK v7.0->Visual Studio Registration->Windows SDK Configuration Tool，選擇v7.0，點擊Make Current。
3. 為python設置環境變量
由于breakpad使用python來生成Windows下的工程文件，所以需要將python所在目錄，設置到環境變量PATH中去。
4. 生成Windows工程文件
1 2 3 4 | cd "源碼目錄/src/tools/gyp"
# 注意，此處不能使用全路徑，不然會出錯
gyp.bat "../../client/windows/breakpad_client.gyp"
|
此時，在src/client/windows下就可以看到生成好的breakpad_client.sln了。運行吧！
5. Hello World!
編譯build all，現在一般是不會報錯了，如果報錯，請檢查是不是漏了什么步驟，特別是補丁。
編譯完成之后，運行crash_generation_app吧，這是他的測試程序，dump的默認位置保存在C:Dumps下，請注意先建立好目錄，不然會無法使用。
啟動測試程序之后，此時還不能抓取dump，因為這個是breakpad中的服務器端，需要再啟動一個測試程序，在第二個測試程序中，我們就可以試驗Client菜單中的各種崩潰了。這些崩潰都會被抓住轉存到C:Dumps目錄下。
如何使用breakpad
在Windows下使用breakpad的方法很簡單，只需要創建一個ExceptionHandler的類即可，大家可以在crash_generation_app這個工程中找到示例代碼，也可以直接移步Wiki，上面說的也很詳細。
1.進程內抓取Dump文件
進程內抓取Dump文件是最簡單的breakpad的用法。使用方法很簡單：
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | const std::wstring s_strCrashDir = L"c:\dumps";
bool
InitBreakpad()
{
google_breakpad::ExceptionHandler *pCrashHandler =
new google_breakpad::ExceptionHandler(s_strCrashDir,
onExceptionFilter,
onMinidumpDumped,
NULL,
google_breakpad::ExceptionHandler::HANDLER_ALL,
MiniDumpNormal,
NULL,
NULL);
if(pCrashHandler == NULL) {
return false;
}
return true;
}
|
2.進程外抓取Dump文件
使用進程外抓取Dump時，需要指定服務端和客戶端，在服務端中需要創建CrashGenerationServer的實例，而在客戶端中則只需要創建ExceptionHandler即可。此外，如果服務端自己需要抓進程內的Dump，請將pipe的參數置為NULL。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 | const wchar_t s_pPipeName[] = L"\\.\pipe\breakpad\crash_handler_server";
const std::wstring s_strCrashDir = L"c:\dumps";
bool
InitBreakpad()
{
google_breakpad::CrashGenerationServer *pCrashServer =
new google_breakpad::CrashGenerationServer(s_pPipeName,
NULL,
onClientConnected,
NULL,
onClientDumpRequest,
NULL,
onClientExited,
NULL,
true,
&s_strCrashDir);
if(pCrashServer == NULL) {
return false;
}
// 如果已經服務端已經啟動了，此處啟動會失敗
if(!pCrashServer->Start()) {
delete pCrashServer;
pCrashServer = NULL;
}
google_breakpad::ExceptionHandler *pCrashHandler =
new google_breakpad::ExceptionHandler(s_strCrashDir,
onExceptionFilter,
onMinidumpDumped,
NULL,
google_breakpad::ExceptionHandler::HANDLER_ALL,
MiniDumpNormal,
(pCrashServer == NULL) ? s_pPipeName : NULL, // 如果是服務端，則直接使用進程內dump
NULL);
if(pCrashHandler == NULL) {
return false;
}
return true;
}
|
使用breakpad的時候，有兩個地方需要注意：
1. 記得把breakpad的solution下的幾個工程，包含到你開發的工程中，或者直接包含他們的lib。
common：基礎功能，包含一個對GUID的封裝和http上傳的類。
exception_handler：用來捕獲崩潰的類。
crash_generation_server：breakpad的服務端，用來在產生崩潰時抓取dump。
crash_generation_client：breakpad的客戶端，用來捕獲當前進程的崩潰。
2. 在初始化breakpad之前，記得先創建好dump文件的目錄，不然breakpad服務端將不能正常的寫dump，這會導致breakpad客戶端在崩潰時無限等待服務端dump寫完的消息，最后失去響應。