.NET 스레드 콜 스택 덤프 (7) - ClrMD(Microsoft.Diagnostics.Runtime)를 이용한 방법
스레드 콜 스택 덤프 관련해 결국 한 번 더 쓰게 되는군요. ^^
외부 프로세스에서 디버거를 붙이는 MDbg 방법보다 더 나은 CLRMD가 있어서 소개해드립니다. ^^
github - Microsoft / clrmd
; https://github.com/Microsoft/clrmd
예제 코드까지 포함하고 있는 데다 실제로 사용 방법도 전형적이어서 쉽게 쓸 수 있습니다. 이렇게!
// Install-Package Microsoft.Diagnostics.Runtime -Version 1.1.142101
using (DataTarget target = DataTarget.AttachToProcess(Process.GetCurrentProcess().Id, 5000, AttachFlag.Passive))
{
ClrRuntime runtime = target.ClrVersions.First().CreateRuntime();
foreach (ClrThread thread in runtime.Threads)
{
if (_managed.Contains(thread.ManagedThreadId) != true)
{
continue;
}
IList<ClrStackFrame> stackFrames = thread.StackTrace;
foreach (ClrStackFrame item in stackFrames)
{
if (item.Kind == ClrStackFrameType.ManagedMethod)
{
FileAndLineNumber info = item.GetSourceLocation();
if (info.Line != 0)
{
Console.WriteLine("0x{0:x} 0x{1:x} {2} in {3} at {4}", item.InstructionPointer, item.StackPointer, item.DisplayString, info.File, info.Line);
}
else
{
Console.WriteLine("0x{0:x} 0x{1:x} {2}", item.InstructionPointer, item.StackPointer, item.DisplayString);
}
}
}
}
runtime.Flush();
}
보시면 AttachToProcess 메서드의 3번째 인자인 AttachFlag가 Passive로 넘어가는데, 같은 프로세스에 디버거를 붙이는 것을 의미합니다. 하지만, 내부적으로는 Attach되는 어떠한 명시적인 동작은 없고 단지 mscoree.dll 측의 CLR 관련 인터페이스를 구하는 작업만 합니다.
CLRMD 라이브러리에 아쉬운 점이 있다면 버그가 좀 있다는 점입니다. 가령, 반복 호출하면 메모리 누수가 있고 x64 EXE인 경우 콜 스택이 "UNKNOWN"으로만 나옵니다. 몇몇 문제들은 ClrMd를 fork한 다른 github repo에서 이미 해결했고 저도 나름대로 그것들을 기반으로 다음의 이슈들을 해결한 fork를 가지고 있습니다.
commit fc6b4eac7c37ff2d900bedcb3a0fdeedd26b6fe9 - x64에서 "UNKNOWN" 콜스택이 나오는 문제
commit 2535724f0aa95f70763592d35a8efba009fb9310 - PDB 파일 분석 시 "Unknown custom metadata item kind: 6" 예외 발생하는 문제
commit e699965a623635e3d246c03b1cfc6ec5bf9aac3f - private PDB 파일인 경우 PdbException 발생하는 문제
commit 3e6120d7f4505a4957550e4eace459353870fcf0 - PdbInfo 타입에 GetHashCode / Equals 메서드 구현
commit 1de3a2d1fd8ed3cf6dbada0b370213db8c0f60d2 - PEBuffer 클래스에 있는 메모리 누수 문제
commit 7eb4235a71929bbd7edcfc493465e96c253619da - PEFile.GetPdbSignature 메서드에 있는 메모리 누수 문제
commit d8dfb06ec6c11e90b14d6a9a13eb3168ad6e50fd - x64에서 문제가 발생하는 Clrobject
commit c0940f9001e319c4ef22edff40a20eb2bfeb7806 - C# 2.0 컴파일러에서도 빌드가 가능하도록 C# 상위 버전의 문법 대체
commit 8aeae6e86292c838b2fc93b752b092b86479ade6 - C# 2.0 컴파일러에서도 빌드가 가능하도록 LINQ 의존성 제거
마이크로소프트 측의 원본 CLRMD repo는 현재 (오늘 기준으로) 마지막 업데이트가 지난 4월인데 그 이후로 더 이상의 개선이 없는 상태입니다. (즉, Pull Request도 병합되지 않고 있습니다.) 따라서, 가능한 다른 fork repo를 이용하거나 제 것을 사용하시는 것이 좋습니다. (2021-01-04: 현재 기준 2.0.161401 버전까지 지속적으로 업데이트되고 있습니다.)
첨부한 파일은 제가 clrmd를 변경한 소스 코드와 함께 이 글의 예제 프로젝트를 포함합니다.
Microsoft.Diagnostics.Runtime 패키지의 DataTarget.CreateSnapshotAndAttach 메서드를 호출 시 3가지 정도의 상황에서 오류가 발생할 수 있습니다.
1) 만약, 64비트 프로세스에서 32비트 프로세스에 연결해 CreateSnapshotFromProcess 메서드를 호출하는 경우 이런 오류가 발생합니다.
The system detected an overrun of a stack-based buffer in this application. This overrun could potentially allow a malicious user to gain control of this application.
Unhandled Exception: System.InvalidOperationException: Sequence contains no elements
at System.Linq.ThrowHelper.ThrowNoElementsException() + 0x2b
at System.Linq.Enumerable.First[TSource](IEnumerable`1) + 0x27
at System.Linq.ImmutableArrayExtensions.First[T](ImmutableArray`1) + 0x19
...[생략]...
2) 리눅스 환경에서 .NET Core 3.0 이하의 응용 프로그램에서는 이렇게 오류 발생하고,
Unhandled Exception: Microsoft.Diagnostics.NETCore.Client.ServerNotAvailableException: Unable to connect to Process 1. Please verify that /tmp/ is writable by the current user. If the target process has environment variable TMPDIR set, please set TMPDIR to the same directory. Please see
https://aka.ms/dotnet-diagnostics-port for more information
at Microsoft.Diagnostics.NETCore.Client.PidIpcEndpoint.GetDefaultAddress(Int32) + 0x1f3
at Microsoft.Diagnostics.NETCore.Client.PidIpcEndpoint.Connect(TimeSpan) + 0x17
at Microsoft.Diagnostics.NETCore.Client.IpcClient.SendMessageGetContinuation(IpcEndpoint, IpcMessage) + 0x1c
at Microsoft.Diagnostics.NETCore.Client.IpcClient.SendMessage(IpcEndpoint, IpcMessage) + 0x1a
at Microsoft.Diagnostics.NETCore.Client.DiagnosticsClient.WriteDump(DumpType, String, WriteDumpFlags) + 0x36
at Microsoft.Diagnostics.Runtime.LinuxSnapshotTarget.CreateSnapshotFromProcess(Int32) + 0x7e
at Microsoft.Diagnostics.Runtime.DataTarget.CreateSnapshotAndAttach(Int32, TokenCredential) + 0xcb
...[생략]...
3) Windows Server 2008 R2 이하의 운영체제에서는 이렇게 오류 발생합니다.
Unhandled Exception: System.EntryPointNotFoundException: Unable to find an entry point named 'PssCaptureSnapshot' in native library 'kernel32.dll'.
at Internal.Runtime.CompilerHelpers.InteropHelpers.FixupMethodCell(IntPtr, InteropHelpers.MethodFixupCell*) + 0x161
at Internal.Runtime.CompilerHelpers.InteropHelpers.ResolvePInvokeSlow(InteropHelpers.MethodFixupCell*) + 0x3d
at Microsoft.Diagnostics.Runtime.WindowsProcessDataReader.PssCaptureSnapshot(IntPtr, PSS_CAPTURE_FLAGS, Int32, IntPtr&) + 0x35
at Microsoft.Diagnostics.Runtime.WindowsProcessDataReader..ctor(Int32, WindowsProcessDataReaderMode) + 0x85
at Microsoft.Diagnostics.Runtime.DataTarget.CreateSnapshotAndAttach(Int32, TokenCredential) + 0x11a
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]