Microsoft MVP성태의 닷넷 이야기
닷넷: 2290. C# - 간이 dotnet-dump 프로그램 만들기 [링크 복사], [링크+제목 복사],
조회: 12722
글쓴 사람
정성태 (seongtaejeong at gmail.com)
홈페이지
첨부 파일

(시리즈 글이 2개 있습니다.)
닷넷: 2289. "dotnet-dump ps" 명령어가 닷넷 프로세스를 찾는 방법
; https://www.sysnet.pe.kr/2/0/13703

닷넷: 2290. C# - 간이 dotnet-dump 프로그램 만들기
; https://www.sysnet.pe.kr/2/0/13704




C# - 간이 dotnet-dump 프로그램 만들기

이전에 설명한 대로,

"dotnet-dump ps" 명령어가 닷넷 프로세스를 찾는 방법
; https://www.sysnet.pe.kr/2/0/13703

dotnet-dump는 대상 프로세스가 열어놓은 IPC 채널(윈도우: 파이프, 리눅스/MAC: Unix Domain 소켓)을 통해 메모리 덤프를 합니다. github repo에 있는 WriteDump 메서드에 그 과정이 나오는데요,

// .\Microsoft.Diagnostics.NETCore.Client\DiagnosticsClient\DiagnosticsClient.cs
// https://learn.microsoft.com/en-us/dotnet/core/diagnostics/microsoft-diagnostics-netcore-client

public void WriteDump(DumpType dumpType, string dumpPath, WriteDumpFlags flags)
{
    IpcMessage request = CreateWriteDumpMessage(DumpCommandId.GenerateCoreDump3, dumpType, dumpPath, flags);
    IpcMessage response = IpcClient.SendMessage(_endpoint, request);
    if (!ValidateResponseMessage(response, "Write dump", ValidateResponseOptions.UnknownCommandReturnsFalse | ValidateResponseOptions.ErrorMessageReturned))
    {
        request = CreateWriteDumpMessage(DumpCommandId.GenerateCoreDump2, dumpType, dumpPath, flags);
        response = IpcClient.SendMessage(_endpoint, request);
        if (!ValidateResponseMessage(response, "Write dump", ValidateResponseOptions.UnknownCommandReturnsFalse))
        {
            if ((flags & ~WriteDumpFlags.LoggingEnabled) != 0)
            {
                throw new ArgumentException($"Only {nameof(WriteDumpFlags.LoggingEnabled)} flag is supported by this runtime version", nameof(flags));
            }
            request = CreateWriteDumpMessage(dumpType, dumpPath, logDumpGeneration: (flags & WriteDumpFlags.LoggingEnabled) != 0);
            response = IpcClient.SendMessage(_endpoint, request);
            ValidateResponseMessage(response, "Write dump");
        }
    }
}

internal enum DumpCommandId : byte
{
    GenerateCoreDump = 0x01,
    GenerateCoreDump2 = 0x02,
    GenerateCoreDump3 = 0x03,
}

이렇게 GenerateCoreDump3 명령어에 해당하는 메시지를 IPC 채널로 전송한 후, 실패하면 다시 GenerateCoreDump2, 또다시 실패하면 GenerateCoreDump 메시지를 보내게 됩니다. 그러니까, dotnet-dump 자체가 메모리 덤프를 위해 하는 일은 대상 프로세스 스스로 덤프를 뜨도록 신호를 보내는 것뿐이 없습니다.

따라서, 그 과정만 대충 흉내 내면 우리도 dotnet-dump와 유사한 프로그램을 만들 수 있는데요, 실제로 구현을 해보겠습니다. ^^




우선, Dump 하라는 명령어의 구조는 이런 식입니다.

- [byte] CommandSet
- [byte] CommandId
- [byte 배열] Payload 
    - [string] DumpPath
    - [uint] DumpType
    - [uint] Flags

Payload의 구성부터 해볼 텐데요, 간단하게 다음과 같이 처리할 수 있습니다.

DumpCommandId commandId = DumpCommandId.GenerateCoreDump;
byte[] payload = GetPayload(dumpPath, DumpType.Full, 0);

private static byte[] GetPayload(string path, DumpType dumpType, WriteDumpFlags flags)
{
    string data1 = path;
    uint data2 = (uint)dumpType;
    uint data3 = (uint)flags;

    using (MemoryStream stream = new())
    using (BinaryWriter writer = new(stream))
    {
        writer.WriteString(data1);
        writer.Write(data2);
        writer.Write(data3);

        writer.Flush();
        return stream.ToArray();
    }
}

그리고 위의 Payload를 담은 메시지는 대략 이렇게 구성할 수 있습니다.

IpcDiagnosticsMessage msg = new IpcDiagnosticsMessage(DiagnosticsServerCommandSet.Dump, commandId, payload);

public class IpcDiagnosticsMessage
{
    byte _commandSet;
    byte _command;
    public byte CommandId => _command;

    byte[] _payload;
    public byte[] Payload => _payload;

    public IpcDiagnosticsMessage(DiagnosticsServerCommandSet commandSet, DumpCommandId command, byte[] payload)
    {
        _commandSet = (byte)commandSet;
        _command = (byte)command;
        _payload = payload;
    }
}

자, 그럼 저 메시지를 (윈도우의 경우) NamedPipe로 전송하면 되는데요, 이를 위해 NamedPipeClientStream으로 대상 프로세스의 Pipe에 연결하고,

int processId = ...[닷넷 프로세스 ID]...;

string pipeName = $"dotnet-diagnostic-{processId}";
NamedPipeClientStream namedPipe = new(
                    ".",
                    pipeName,
                    PipeDirection.InOut,
                    PipeOptions.None,
                    TokenImpersonationLevel.Impersonation);
namedPipe.Connect();

이후 IpcDiagnosticsMessage를 직렬화해 Stream에 쓰고(Request), 응답(Response)을 받습니다.

SendMessage(namedPipe, msg);
IpcDiagnosticsMessage response = ReceiveResponse(namedPipe);

private static void SendMessage(NamedPipeClientStream namedPipe, IpcDiagnosticsMessage msg)
{
    byte[] packet = msg.Serialize();
    namedPipe.Write(packet, 0, packet.Length);
}

private static IpcDiagnosticsMessage ReceiveResponse(NamedPipeClientStream namedPipe)
{
    using (BinaryReader reader = new(namedPipe, Encoding.UTF8, true))
    {
        return IpcDiagnosticsMessage.Parse(reader);
    }
}

public class IpcDiagnosticsMessage
{
    public const ushort HeaderSizeInBytes = 20;
    private const ushort MagicSizeInBytes = 14;
    public byte[] Magic = DotnetIpcV1; // byte[14] in native code
    public static byte[] DotnetIpcV1 => Encoding.ASCII.GetBytes("DOTNET_IPC_V1" + '\0');

    // ...[생략]...

    public byte[] Serialize()
    {
        byte[]? serializedData = null;

        ushort packetSize = checked((ushort)(HeaderSizeInBytes + _payload.Length));
        byte[] headerBytes = SerializeHeader(packetSize);

        using (MemoryStream stream = new())
        using (BinaryWriter writer = new(stream))
        {
            writer.Write(headerBytes);
            writer.Write(_payload);
            writer.Flush();
            serializedData = stream.ToArray();
        }

        return serializedData;
    }

    byte[] SerializeHeader(ushort packetSize)
    {
        using (MemoryStream stream = new())
        using (BinaryWriter writer = new(stream))
        {
            writer.Write(Magic);
            Debug.Assert(Magic.Length == MagicSizeInBytes);
            writer.Write(packetSize);
            writer.Write(_commandSet);
            writer.Write(_command);
            writer.Write((ushort)0x0000);
            writer.Flush();
            return stream.ToArray();
        }
    }

    public static IpcDiagnosticsMessage Parse(BinaryReader reader)
    {
        byte[] magic = reader.ReadBytes(14);
        ushort size = reader.ReadUInt16();
        byte commandSet = reader.ReadByte();
        byte commandId = reader.ReadByte();
        ushort reserved = reader.ReadUInt16();

        byte[] payload = reader.ReadBytes(size - HeaderSizeInBytes);

        return new IpcDiagnosticsMessage((DiagnosticsServerCommandSet)commandSet, (DumpCommandId)commandId, payload);
    }
}

간단하죠? ^^ 남은 작업은, 응답에 대해 성공 여부를 가려내면 되는데요,

ValidateResponseOptions options = ValidateResponseOptions.None;

switch ((DiagnosticsServerResponseId)response.CommandId)
{
    case DiagnosticsServerResponseId.OK:
        Console.WriteLine($"Supported: {commandId}");
        break;

    case DiagnosticsServerResponseId.Error:
        uint hr = BinaryPrimitives.ReadUInt32LittleEndian(new ReadOnlySpan<byte>(response.Payload, 0, 4));
        Console.WriteLine($"Not supported: {commandId}, hr == {hr:x}");
        // ...[생략]...
        throw new ServerErrorException(message);

    default:
        throw new ServerErrorException($"{commandId} failed - Server responded with unknown response.");
}

Fail 시 반환하는 오류 메시지를 제외하면 사실상 OK, Fail 2가지 상태는 CommandId 필드 하나로 결정할 수 있습니다. 간단하죠?!!! ^^

(첨부 파일은 이 글의 예제 코드를 포함합니다.)




테스트를 하면서 알게 된 사실인데, 현재 윈도우 환경의 .NET Core 3.0 응용 프로그램을 대상으로 위의 코드로 덤프를 시도하면 이런 오류가 발생합니다.

Unhandled exception. Microsoft.Diagnostics.NETCore.Client.UnsupportedCommandException: Write dump failed - Command is not supported.
   at Microsoft.Diagnostics.NETCore.Client.DiagnosticsClient.ValidateResponseMessage(IpcMessage responseMessage, String operationName, ValidateResponseOptions options)
   at Microsoft.Diagnostics.NETCore.Client.DiagnosticsClient.WriteDump(DumpType dumpType, String dumpPath, WriteDumpFlags flags)
   at Microsoft.Diagnostics.NETCore.Client.DiagnosticsClient.WriteDump(DumpType dumpType, String dumpPath, Boolean logDumpGeneration)
   ...[생략]...

그러니까, IPC 채널로 GenerateCoreDump 명령어를 보냈는데 응답으로 DiagnosticsServerResponseId.Error / DiagnosticsIpcError.UnknownCommand 값이 온 것입니다. 다시 말해 .NET Core 3.0 윈도우 앱은 저 채널에 대해 GenerateCoreDump 명령어를 지원하지 않습니다. (반면 리눅스 버전의 .NET Core 3.0은 덤프 명령어를 지원합니다.)

반면, dotnet-dump로 하면 정상적으로 메모리 덤프 파일이 남습니다. 이유가 뭘까요? ^^ 왜냐하면,

// https://github.com/dotnet/diagnostics/blob/main/src/Tools/dotnet-dump/Dumper.cs#L95

// ...[생략]...

if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
    if (crashreport)
    {
        Console.WriteLine("Crash reports not supported on Windows.");
        return -1;
    }

    // https://github.com/dotnet/diagnostics/blob/main/src/Tools/dotnet-dump/Dumper.Windows.cs#L16
    Windows.CollectDump(processId, output, type);
}
else
{
    DiagnosticsClient client = new(processId);

    // ...[생략]...
    // Send the command to the runtime to initiate the core dump
    client.WriteDump(dumpType, output, flags);
}

윈도우 버전의 경우 dotnet-dump는 IPC 채널이 아닌 Windows.CollectDump를 호출하고, 그것은 결국 MiniDumpWriteDump Win32 API를 호출하기 때문입니다.

재미있는 건, .NET 5+ 버전부터는 IPC 방식을 윈도우 닷넷 런타임에서 지원함에도 dotnet-dump는 고정적으로 MiniDumpWriteDump를 호출하게 코드가 만들어져 있습니다.

더욱 재미있는 건, 자기 자신에게 IPC 연결을 하는 것도 가능하고, 이를 통해 자기 자신에게 덤프를 뜨는 것도 가능합니다. ^^




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]







[최초 등록일: ]
[최종 수정일: 8/6/2024]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 




... 61  62  63  64  65  66  67  68  69  70  71  72  73  74  [75]  ...
NoWriterDateCnt.TitleFile(s)
12153정성태2/23/202024355.NET Framework: 898. Trampoline을 이용한 후킹의 한계파일 다운로드1
12152정성태2/23/202021397.NET Framework: 897. 실행 시에 메서드 가로채기 - CLR Injection: Runtime Method Replacer 개선 - 세 번째 이야기(Trampoline 후킹)파일 다운로드1
12151정성태2/22/202024042.NET Framework: 896. C# - Win32 API를 Trampoline 기법을 이용해 C# 메서드로 가로채는 방법 - 두 번째 이야기 (원본 함수 호출)파일 다운로드1
12150정성태2/21/202024114.NET Framework: 895. C# - Win32 API를 Trampoline 기법을 이용해 C# 메서드로 가로채는 방법 [1]파일 다운로드1
12149정성태2/20/202021015.NET Framework: 894. eBEST C# XingAPI 래퍼 - 연속 조회 처리 방법 [1]
12148정성태2/19/202025676디버깅 기술: 163. x64 환경에서 구현하는 다양한 Trampoline 기법 [1]
12147정성태2/19/202020992디버깅 기술: 162. x86/x64의 기계어 코드 최대 길이
12146정성태2/18/202022204.NET Framework: 893. eBEST C# XingAPI 래퍼 - 로그인 처리파일 다운로드1
12145정성태2/18/202023822.NET Framework: 892. eBEST C# XingAPI 래퍼 - Sqlite 지원 추가파일 다운로드1
12144정성태2/13/202024005.NET Framework: 891. 실행 시에 메서드 가로채기 - CLR Injection: Runtime Method Replacer 개선 - 두 번째 이야기파일 다운로드1
12143정성태2/13/202018420.NET Framework: 890. 상황별 GetFunctionPointer 반환값 정리 - x64파일 다운로드1
12142정성태2/12/202022333.NET Framework: 889. C# 코드로 접근하는 MethodDesc, MethodTable파일 다운로드1
12141정성태2/10/202021334.NET Framework: 888. C# - ASP.NET Core 웹 응용 프로그램의 출력 가로채기 [2]파일 다운로드1
12140정성태2/10/202022687.NET Framework: 887. C# - ASP.NET 웹 응용 프로그램의 출력 가로채기파일 다운로드1
12139정성태2/9/202022367.NET Framework: 886. C# - Console 응용 프로그램에서 UI 스레드 구현 방법
12138정성태2/9/202028587.NET Framework: 885. C# - 닷넷 응용 프로그램에서 SQLite 사용 [6]파일 다운로드1
12137정성태2/9/202020218오류 유형: 592. [AhnLab] 경고 - 디버거 실행을 탐지했습니다.
12136정성태2/6/202021882Windows: 168. Windows + S(또는 Q)로 뜨는 작업 표시줄의 검색 바가 동작하지 않는 경우
12135정성태2/6/202027685개발 환경 구성: 468. Nuget 패키지의 로컬 보관 폴더를 옮기는 방법 [2]
12134정성태2/5/202024955.NET Framework: 884. eBEST XingAPI의 C# 래퍼 버전 - XingAPINet Nuget 패키지 [5]파일 다운로드1
12133정성태2/5/202022703디버깅 기술: 161. Windbg 환경에서 확인해 본 .NET 메서드 JIT 컴파일 전과 후 - 두 번째 이야기
12132정성태1/28/202025724.NET Framework: 883. C#으로 구현하는 Win32 API 후킹(예: Sleep 호출 가로채기) [1]파일 다운로드1
12131정성태1/27/202024452개발 환경 구성: 467. LocaleEmulator를 이용해 유니코드를 지원하지 않는(한글이 깨지는) 프로그램을 실행하는 방법 [1]
12130정성태1/26/202022029VS.NET IDE: 142. Visual Studio에서 windbg의 "Open Executable..."처럼 EXE를 직접 열어 디버깅을 시작하는 방법
12129정성태1/26/202029032.NET Framework: 882. C# - 키움 Open API+ 사용 시 Registry 등록 없이 KHOpenAPI.ocx 사용하는 방법 [3]
12128정성태1/26/202023151오류 유형: 591. The code execution cannot proceed because mfc100.dll was not found. Reinstalling the program may fix this problem.
... 61  62  63  64  65  66  67  68  69  70  71  72  73  74  [75]  ...