Linux 上的 .NET 如何自主生成 Dump
一：背景
1. 講故事
前幾天微信上有位朋友找到我，說他程式的 執行緒數 會偶發性瞬時飆高，讓我看下大概是什麼原因，截圖如下：
如果這種問題每天都會出現，比較好的做法就是用 dotnet-trace 捕獲 ThreadCreated 事件，但可氣的是朋友說大概一個月發生次把，這種情況下用 dotnet-trace 持續監視就沒必要了，弄不好把硬碟給爆掉了。
那怎麼辦呢？還能怎麼辦，藉助第三方工具 來生成dump，比如 procdump，dotnet-dump 等等，但這裡又有限制了，很多人不願意在docker中再開啟一個程序，希望讓程式自己生成dump，這個其實能理解，很多商業化工具都具有 crash dump 的功能，比如：騰訊會議，有道字典 等等，本篇就來聊一聊如何自主生成 dump。
二：如何自主生成 dump
1. Windows 平臺上如何自主
熟悉 Windows 平臺的朋友都知道，在 Win32 API 中有一個 MiniDumpWriteDump 的方法宣告，方法實現是在 dbghelp.dll中，而且 dbghelp 是作業系統自帶的，有了這些知識，我們可以將 dbghelp.lib 靜態連結過來生成dump，參考程式碼如下：
#include <iostream>
#include <Windows.h>
#include <minidumpapiset.h>
#include "Dbghelp.h"
#pragma comment(lib, "dbghelp.lib")
int main()
{
//1. 建立檔案
HANDLE hFile = CreateFile(L"D:\\testdump\\MiniDump.dmp", GENERIC_READ | GENERIC_WRITE, 0, NULL,
CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
MiniDumpWriteDump(GetCurrentProcess(), GetCurrentProcessId(), hFile, MiniDumpWithFullMemory, NULL,
NULL, NULL);
CloseHandle(hFile);
}
將程式跑起來後，就會生成一個 dump 檔案。
這裡簡單提醒一下，預設用的 dbghelp.dll 是 Windows 系統目錄下的，版本比較老，新功能可能不支援，如果我想用新版本的 dbghelp.dll 去哪裡找呢？
其實有一個快捷途徑，就是windbg 的安裝目錄下都會有最新的 dbghelp.dll，可以用 .chain 去尋找。
0:000> .chain
Extension DLL chain:
dbghelp: image 10.0.25877.1004, API 10.0.6,
[path: C:\Program Files\WindowsApps\Microsoft.WinDbg_1.2306.14001.0_x64__8wekyb3d8bbwe\amd64\dbghelp.dll]
exts: image 10.0.25877.1004, API 1.0.0,
[path: C:\Program Files\WindowsApps\Microsoft.WinDbg_1.2306.14001.0_x64__8wekyb3d8bbwe\amd64\WINXP\exts.dll]
...
哈哈，上面的 dbghelp 就是，接下來用 LoadLibrary 載入進來即可，失敗邏輯就不寫了哈，參考程式碼如下：
#include <iostream>
#include <windows.h>
#include <dbghelp.h>
typedef BOOL(WINAPI* MiniDumpWriteDumpT)(
HANDLE,
DWORD,
HANDLE,
MINIDUMP_TYPE,
PMINIDUMP_EXCEPTION_INFORMATION,
PMINIDUMP_USER_STREAM_INFORMATION,
PMINIDUMP_CALLBACK_INFORMATION);
int main()
{
//1. 建立檔案
HANDLE hFile = CreateFile(L"D:\\testdump\\MiniDump2.dmp", GENERIC_READ | GENERIC_WRITE, 0, NULL,
CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
HMODULE hDbgHelp = LoadLibrary(L"dbghelp.dll");
MiniDumpWriteDumpT pfnMinidumpWriteDump = (MiniDumpWriteDumpT)GetProcAddress(hDbgHelp, "MiniDumpWriteDump");
pfnMinidumpWriteDump(GetCurrentProcess(), GetCurrentProcessId(), hFile, MiniDumpWithFullMemory, NULL,
NULL, NULL);
CloseHandle(hFile);
}
跑起來後就能看到 Dump 啦。
2. Linux 平臺上如何自主
在 Linux 平臺上確實沒有找到類似 MiniDumpWriteDump 的辦法，那怎麼生成呢？ 後來我就在想 dotnet-dump 它為什麼能生成dump，沿著這個思路，找到了原來微軟還有一個叫使用者端診斷庫的API Microsoft.Diagnostics.NETCore.Client，它可以幫助我們生成 dump 檔案。
原來它是微軟提供的 EventPipe 收集機制，可以收集 .NET 的 ETW 和 EventSource 發生的事件，挺好用的，更多詳情可以觀察微軟的官方檔案。
有了這些基礎，接下來就可以寫個測試案例，從 nuget 拉一下 Microsoft.Diagnostics.NETCore.Client 包。
測試程式碼如下：
internal class Program
{
static void Main(string[] args)
{
Task.Run(() =>
{
Console.WriteLine("指標異常，要抓 dump 啦！");
Dumper.TriggerCoreDump(Environment.ProcessId);
});
Console.ReadLine();
}
public class Dumper
{
public static void TriggerCoreDump(int processId)
{
var client = new DiagnosticsClient(processId);
client.WriteDump(DumpType.Full, "/data/minidump.dmp");
}
}
}
上傳到 Linux ，執行 dotnet Example_5_1_7.dll 後，minidump.dmp 就出來了，輸出如下：
[root@localhost data2]# dotnet Example_5_1_7.dll
指標異常，要抓 dump 啦！
[createdump] Gathering state for process 4061 dotnet
[createdump] Writing full dump to file /data/minidump.dmp
[createdump] Written 147349504 bytes (35974 pages) to core file
[createdump] Target process is alive
[createdump] Dump successfully written
[root@localhost data2]# ls -lh /data
total 141M
-rw-------. 1 root root 141M Jun 30 10:09 minidump.dmp
可以看到這個 dump 有 141M，接下來用 windbg 驗證下是否完好，一切正常，參考如下：
0:000> !t
ThreadCount: 9
UnstartedThread: 0
BackgroundThread: 8
PendingThread: 0
DeadThread: 0
Hosted Runtime: no
Lock
DBG ID OSID ThreadOBJ State GC Mode GC Alloc Context Domain Count Apt Exception
0 1 fb0 000055DF915CD9C0 20020 Preemptive 00007F06AC01B0F0:00007F06AC01BFD0 000055df915b4e90 -00001 Ukn
5 2 fb5 000055DF915DB010 21220 Preemptive 0000000000000000:0000000000000000 000055df915b4e90 -00001 Ukn (Finalizer)
6 3 fb6 000055DF91606F80 21220 Preemptive 0000000000000000:0000000000000000 000055df915b4e90 -00001 Ukn
7 4 fb7 000055DF9163A4C0 3021220 Preemptive 00007F06AC032DB0:00007F06AC033FD0 000055df915b4e90 -00001 Ukn (Threadpool Worker)
8 5 fb8 000055DF9163BE50 3021220 Preemptive 00007F06AC00D8C0:00007F06AC00F040 000055df915b4e90 -00001 Ukn (Threadpool Worker)
9 6 fb9 00007F069C002B70 1021220 Preemptive 00007F06AC0371D0:00007F06AC037FD0 000055df915b4e90 -00001 Ukn (Threadpool Worker)
11 7 fbb 00007F069C04F060 21220 Preemptive 00007F06AC02D768:00007F06AC02F3F0 000055df915b4e90 -00001 Ukn
12 8 fbd 00007F0694001680 1021220 Preemptive 00007F06AC034388:00007F06AC035FD0 000055df915b4e90 -00001 Ukn (Threadpool Worker)
13 9 fbe 00007F068C0013E0 1021220 Preemptive 00007F06AC0383A0:00007F06AC039FD0 000055df915b4e90 -00001 Ukn (Threadpool Worker)
0:000> ~0s
libpthread_2_17+0xe75d:
00007f07`5c1e575d 488b3c24 mov rdi,qword ptr [rsp] ss:00007ffd`2c48ead0=0000000000000000
0:000> !clrstack
OS Thread Id: 0xfb0 (0)
Child SP IP Call Site
00007FFD2C48EB10 00007f075c1e575d [InlinedCallFrame: 00007ffd2c48eb10] Interop+Sys.ReadStdin(Byte*, Int32)
00007FFD2C48EB10 00007f06e1c42c08 [InlinedCallFrame: 00007ffd2c48eb10] Interop+Sys.ReadStdin(Byte*, Int32)
00007FFD2C48EB00 00007f06e1c42c08 ILStubClass.IL_STUB_PInvoke(Byte*, Int32)
00007FFD2C48EB90 00007f06e1d327d9 System.IO.StdInReader.ReadKey() [/_/src/libraries/System.Console/src/System/IO/StdInReader.cs @ 458]
00007FFD2C48F0C0 00007f06e1d31ded System.IO.StdInReader.ReadLineCore(Boolean) [/_/src/libraries/System.Console/src/System/IO/StdInReader.cs @ 154]
00007FFD2C48F1E0 00007f06e1d31a5a System.IO.StdInReader.ReadLine() [/_/src/libraries/System.Console/src/System/IO/StdInReader.cs @ 86]
00007FFD2C48F200 00007f06e1d311a0 System.IO.SyncTextReader.ReadLine() [/_/src/libraries/System.Console/src/System/IO/SyncTextReader.cs @ 76]
00007FFD2C48F230 00007f06e1d2748c System.Console.ReadLine() [/_/src/libraries/System.Console/src/System/Console.cs @ 721]
00007FFD2C48F240 00007f06e1c336d6 Example_5_1_7.Program.Main(System.String[]) [D:\skyfly\5.20230426\src\Example\Example_5_1_7\Program.cs @ 20]
三：總結
個人感覺自主生成 Dump 的方式在 Docker 場景下特別適用，通過一點寫死來避免開啟 多程序 的折中方式太棒了，相信這位朋友肯定有了好的思路。