Window調試中的符號文件與源代碼管理

    游戲開始進行第二次封閉測試，這次參與人數較多，隨之而來的便是無數的崩潰dump。雖然在自動構建流程中已經對PDB和EXE按版本號進行了保存，但由于構建操作人員手動修改構建號，出現多個版本對應相同版本號的問題，以及BUG單填寫人以基線版本號而非真實版本號提交的情況，經常浪費開發人員的時間和精力去找對應的PDB，降低了崩潰解決的響應速度。所以非常有必要建立一套自動化方案，得到dump文件后啟動WinDbg進行分析時能夠自動獲取對應的PDB和源代碼，WinDbg就提供了這樣一套方便實用的工具。

1. 建立源代碼索引

     WinDbg提供了一套用于管理pdb對應的源代碼的工具，位于其安裝目錄的srcsrv下，對VSS、SVN、CVS、Perforce提供了支持，分別對應vssindex.cmd、svnindex.cmd、cvsindex.cmd、p4index.cmd這四個perl腳本。其實，ssindex.cmd才是具體實現，它根據傳入的版本控制系統標識，調用對應的perl module。

     svnindex.cmd通過/source和/symbols參數來指定源代碼目錄和PDB目錄，/debug可輸出處理的詳細信息，/user和/pass提供svn賬戶和密碼。PDB文件中有一節專門用于存放源代碼文件列表及處理命令，可通過pdbstr -r -p:PdbFileName -s:srcsrv查看。

     svnindex.cmd /debug /source="E:\CodeBase_SVN\Client\trunk\tools\CutSceneEditor" /symbols="E:\CodeBase_SVN\Client\trunk\bin\Release\CutSceneEditor" /user="user" /pass="pwd"

     在執行上面命令前，確保Perl和Subversion已經被安裝且設置了PATH環境變量。該命令將提取source code的服務器路徑和當前Revision，然后寫入PDB。下面是通過pdbstr獲取的信息：

     上面輸出是經過格式化的，原始信息可以通過srctool -n查看：

     可以看出，原始代碼路徑后面跟了一條svn cat指令，由于沒有指定sourcepath，所以%targ%缺省為當前路徑（"C:\Program Files\Debugging Tools for Windows (x64)\srcsrv"）。 

2. 創建符號服務器

    所謂符號服務器，最簡單的形式就是文件共享服務器。我們使用symstore命令，將1中產生的pdb添加到一個文件共享服務器上，如：

     symstore.exe add /f "E:\CodeBase_SVN\Client\trunk\bin\Release\CutSceneEditor\*.pdb" /s "\\server.com\pub\Symbols" /t "CutSceneEditor" /v "Build 4171" /c "fix memory leak"

     該命令會根據PDB的signature和age產生一個GUID，并將PDB放置于以改GUID為名字的目錄下：

    當debug時，將UNC路徑添加到_NT_SYMBOL_PATH中（如：_NT_SYMBOL_PATH=CACHE*F:\Symbols;SRV*http://msdl.microsoft.com/download/symbols;SRV*\\server.com\pub\Symbols），調試器會自動到指定的符號服務器上去搜索對應的pdb文件。

     symstore大大簡化了符號的版本管理問題，關于它的詳細介紹可參考symstore介紹。

     值得注意的是，symstore沒有鎖機制，并不支持多人同時操作。實際情況中，也只有自動構建時才會做此操作。

3. 使用WinDbg分析Dump文件

      我們在代碼中加入發生異常寫MiniDump的功能，在程序崩潰時產生dump文件。在使用WinDbg分析dump文件時，需要設置Symbol File Path和Source File Path，也可以直接設置環境變量_NT_SYMBOL_PATH和_NT_SOURCE_PATH。在設置_NT_SOURCE_PATH時使用"SRV*CachePath"將表示啟用代碼提取功能，執行svn cat寫入到CachePath指定的目錄，否則將使用原始路徑。此后，通過點擊Call Stack中的函數調用便會觸發從svn讀取對應代碼的操作（通常會有一個安全警告窗口彈出）。

     對于使用WinDbg進行調試在此就不多講了，推薦一本不錯的書《Advanced Windows Debugging》。

參考資料

[1] Source Indexing and Symbol Servers: A Guide to Easier Debugging

[2] Source Server Helps You Kill Bugs Dead In Visual Studio 2005

posted on 2012-03-26 23:10 Heath 閱讀(3979) 評論(2)  編輯 收藏 引用 所屬分類: Game Development