Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일

C# - ETW 이벤트의 Keywords에 속한 EventId 구하는 방법 (1) PInvoke

일례로 예전 ETW 글에서,

C# - (.NET Core 2.2부터 가능한) 프로세스 내부에서 CLR ETW 이벤트 수신
; https://www.sysnet.pe.kr/2/0/12474

"Microsoft-Windows-DotNETRuntime" ETW 제공자의 Exception 키워드(keyword) 범주에 속하는 이벤트를,

.NET runtime exception events
; https://docs.microsoft.com/en-us/dotnet/fundamentals/diagnostics/runtime-exception-events

활성화시켰습니다. 그리고 해당 키워드에 속한 이벤트가 여러 개 있는데 그것들에도 각각 "Event ID"라는 것이 부여되어 있어 식별이 가능합니다. 가령 Exception 범주의 경우 위의 문서에 나오듯이 아래와 같은 ID로 구별되는 이벤트가 발생합니다.

  • ExceptionThrown_V1 - Event ID == 80
  • ExceptionCatchStart - Event ID == 250
  • ExceptionCatchStop - Event ID == 251
  • ExceptionFinallyStart - Event ID == 252
  • ExceptionFinallyStop - Event ID == 253
  • ExceptionFilterStart - Event ID == 254
  • ExceptionFilterStop - Event ID == 255
  • ExceptionThrownStop - Event ID == 256

사실 이 정보들은 ETW manifest 파일에 기록돼 있긴 합니다.

C:\Windows\Microsoft.NET\Framework\v4.0.30319\CLR-ETW.man
C:\Windows\Microsoft.NET\Framework64\v4.0.30319\CLR-ETW.man

<instrumentationManifest xmlns="http://schemas.microsoft.com/win/2004/08/events">
    <instrumentation xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:win="http://manifests.microsoft.com/win/2004/08/windows/events">
        <events xmlns="http://schemas.microsoft.com/win/2004/08/events">
            <!--CLR Runtime Publisher-->
            <provider name="Microsoft-Windows-DotNETRuntime" guid="{e13c0d23-ccbc-4e12-931b-d9cc2eee27e4}" symbol="MICROSOFT_WINDOWS_DOTNETRUNTIME_PROVIDER" resourceFileName="%WINDIR%\Microsoft.NET\Framework64\v4.0.30319\clretwrc.dll" messageFileName="%WINDIR%\Microsoft.NET\Framework64\v4.0.30319\clretwrc.dll">
                <!--Keywords-->
                <keywords>
                    <keyword name="GCKeyword" mask="0x1" message="$(string.RuntimePublisher.GCKeywordMessage)" symbol="CLR_GC_KEYWORD"/>
                    ...[생략]...
                    <keyword name="ExceptionKeyword" mask="0x8000" message="$(string.RuntimePublisher.ExceptionKeywordMessage)" symbol="CLR_EXCEPTION_KEYWORD"/>
                    ...[생략]...
                </keywords>
                ..[생략]...
                <events>
                    <!-- CLR GC events, value reserved from 0 to 39 and 200 to 239 -->
                    <!-- Note the opcode's for GC events do include 0 to 9 for backward compatibility, even though
          they don't mean what those predefined opcodes are supposed to mean -->
                    <event value="1" version="0" level="win:Informational" template="GCStart" keywords="GCKeyword" opcode="win:Start" task="GarbageCollection" symbol="GCStart" message="$(string.RuntimePublisher.GCStartEventMessage)"/>
                    ..[생략]...
                    <!-- CLR Exception events -->
                    <event value="80" version="0" level="win:Informational" opcode="win:Start" task="Exception" symbol="ExceptionThrown" message="$(string.RuntimePublisher.ExceptionExceptionThrownEventMessage)"/>
                    <event value="80" version="1" level="win:Error" template="Exception" keywords="ExceptionKeyword MonitoringKeyword" opcode="win:Start" task="Exception" symbol="ExceptionThrown_V1" message="$(string.RuntimePublisher.ExceptionExceptionThrown_V1EventMessage)"/>
                    <event value="250" version="0" level="win:Informational" template="ExceptionHandling" keywords="ExceptionKeyword" opcode="win:Start" task="ExceptionCatch" symbol="ExceptionCatchStart" message="$(string.RuntimePublisher.ExceptionExceptionHandlingEventMessage)"/>
                    <event value="251" version="0" level="win:Informational" keywords="ExceptionKeyword" opcode="win:Stop" task="ExceptionCatch" symbol="ExceptionCatchStop" message="$(string.RuntimePublisher.ExceptionExceptionHandlingNoneEventMessage)"/>
                    <event value="252" version="0" level="win:Informational" template="ExceptionHandling" keywords="ExceptionKeyword" opcode="win:Start" task="ExceptionFinally" symbol="ExceptionFinallyStart" message="$(string.RuntimePublisher.ExceptionExceptionHandlingEventMessage)"/>
                    <event value="253" version="0" level="win:Informational" keywords="ExceptionKeyword" opcode="win:Stop" task="ExceptionFinally" symbol="ExceptionFinallyStop" message="$(string.RuntimePublisher.ExceptionExceptionHandlingNoneEventMessage)"/>
                    <event value="254" version="0" level="win:Informational" template="ExceptionHandling" keywords="ExceptionKeyword" opcode="win:Start" task="ExceptionFilter" symbol="ExceptionFilterStart" message="$(string.RuntimePublisher.ExceptionExceptionHandlingEventMessage)"/>
                    <event value="255" version="0" level="win:Informational" keywords="ExceptionKeyword" opcode="win:Stop" task="ExceptionFilter" symbol="ExceptionFilterStop" message="$(string.RuntimePublisher.ExceptionExceptionHandlingNoneEventMessage)"/>                                                                                                       
                    <event value="256" version="0" level="win:Informational" keywords="ExceptionKeyword" opcode="win:Stop" task="Exception" symbol="ExceptionThrownStop" message="$(string.RuntimePublisher.ExceptionExceptionHandlingNoneEventMessage)"/>
                    <!-- CLR Contention events -->
                    ..[생략]...
                </events>
            </provider>
            ..[생략]...
        </resources>
    </localization>
</instrumentationManifest>

그래서 Event ID 목록을 man 파일로부터 구하는 것이 가능하지만, 혹시 프로그래밍으로도 가능할까요? 아쉽게도 "C# - (.NET Core 2.2부터 가능한) 프로세스 내부에서 CLR ETW 이벤트 수신" 글에서 사용한 EventSource 타입으로는 해당 이벤트 목록을 구할 수 공식적인 방법이 없습니다.

대안으로 생각해 볼 수 있는 것이 지난 글의,

C# - ETW 관련 Win32 API 사용 예제 코드 (1)
; https://www.sysnet.pe.kr/2/0/12292#trace_event_cs

TraceEventSession.cs 파일처럼 P/Invoke 호출을 해보는 건데요, 그래서 아래의 함수를 더 추가하면,

TdhEnumerateManifestProviderEvents function (tdh.h)
; https://docs.microsoft.com/en-us/windows/win32/api/tdh/nf-tdh-tdhenumeratemanifestproviderevents

TRACE_PROVIDER_INFO structure (tdh.h)
; https://docs.microsoft.com/en-us/windows/win32/api/tdh/ns-tdh-trace_provider_info

EVENT_DESCRIPTOR structure (evntprov.h)
; https://docs.microsoft.com/en-us/windows/win32/api/evntprov/ns-evntprov-event_descriptor

다음과 같이 코딩해 특정 Keyword에 해당하는 이벤트 ID 목록을 구하는 것이 가능합니다.

EVENT_DESCRIPTOR[] eventDescs = GetEventProviders(guid); // guid == e13c0d23-ccbc-4e12-931b-d9cc2eee27e4 ("Microsoft-Windows-DotNETRuntime")

Console.WriteLine("EventIDs at Keyword == Exception: ");
foreach (EVENT_DESCRIPTOR desc in eventDescs)
{
    if ((desc.Keyword & 0x8000) == 0x8000) // 0x8000 == Exception keyword mask
    {
        Console.WriteLine("\t" + desc);
    }
}

/* 출력 결과
EventIDs at Keyword == Exception:
        250 at 32768
        251 at 32768
        252 at 32768
        253 at 32768
        254 at 32768
        255 at 32768
        256 at 32768
        80 at 8589967360
*/

private static EVENT_DESCRIPTOR[] GetEventProviders(Guid guid)
{
    uint bufSize = 0;
    int result = 0;
    IntPtr ptr = IntPtr.Zero;

    try
    {
        do
        {
            if (bufSize != 0)
            {
                ptr = Marshal.AllocHGlobal((int)bufSize);
            }

            result = NativeMethods.TdhEnumerateManifestProviderEvents(ref guid, ptr, ref bufSize);

            if (ptr != IntPtr.Zero && result != 0)
            {
                Marshal.FreeHGlobal(ptr);
                ptr = IntPtr.Zero;
            }

        } while (result == (int)TDHSTATUS.ERROR_INSUFFICIENT_BUFFER);

        /* PROVIDER_EVENT_INFO */
        int offset = 0;
        uint numberOfEvents = (uint)Marshal.ReadInt32(ptr, 0);
        offset += sizeof(uint);

        // unused
        // uint reserved = (uint)Marshal.ReadInt32(ptr, offset);
        offset += sizeof(uint);

        EVENT_DESCRIPTOR[] descs = new EVENT_DESCRIPTOR[numberOfEvents];
        int descSize = Marshal.SizeOf(descs[0]);
        int nDesc = (int)((bufSize - offset) / descSize);

        Debug.Assert(numberOfEvents == nDesc);

        for (int i = 0; i < nDesc; i++)
        {
            descs[i] = (EVENT_DESCRIPTOR)Marshal.PtrToStructure(ptr + (offset + i * descSize), typeof(EVENT_DESCRIPTOR));
        }

        return descs;
    }
    finally
    {
        if (ptr != IntPtr.Zero)
        {
            Marshal.FreeHGlobal(ptr);
        }
    }
}

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




참고로, PowerShell의 Get-WinEvent를 명령어를 이용해서도 구할 수 있습니다.

PS C:\temp> (Get-WinEvent -ListProvider Microsoft-Windows-DotNETRuntime).Events | Format-Table ID, Keywords

 Id Keywords
 -- --------
...[생략]...
 80 {MonitoringKeyword, ExceptionKeyword}
...[생략]...
250 {ExceptionKeyword}
251 {ExceptionKeyword}
252 {ExceptionKeyword}
253 {ExceptionKeyword}
254 {ExceptionKeyword}
255 {ExceptionKeyword}
256 {ExceptionKeyword}




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

[연관 글]


donaricano-btn



[최초 등록일: ]
[최종 수정일: 4/23/2021

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

비밀번호

댓글 쓴 사람
 




1  2  3  4  5  6  7  [8]  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
12565정성태3/17/2021346오류 유형: 704. curl.exe 실행 시 dll not found 오류
12564정성태3/16/2021369VS.NET IDE: 160. 새 프로젝트 창에 C++/CLI 프로젝트 템플릿이 없는 경우
12563정성태3/16/2021458개발 환경 구성: 551. C# - JIRA REST API 사용 정리 (3) jira-oauth-cli 도구를 이용한 키 관리
12562정성태3/15/2021524개발 환경 구성: 550. C# - JIRA REST API 사용 정리 (2) JIRA OAuth 토큰으로 API 사용하는 방법파일 다운로드1
12561정성태3/12/2021428VS.NET IDE: 159. Visual Studio에서 개행(\n, \r) 등의 제어 문자를 치환하는 방법 - 정규 표현식 사용
12560정성태3/11/2021539개발 환경 구성: 549. ssh-keygen으로 생성한 개인키/공개키 파일을 각각 PKCS8/PEM 형식으로 변환하는 방법
12559정성태3/11/2021436.NET Framework: 1028. 닷넷 5 환경의 Web API에 OpenAPI 적용을 위한 NSwag 또는 Swashbuckle 패키지 사용파일 다운로드1
12558정성태3/10/2021603Windows: 192. Power Automate Desktop (Preview) 소개 - Bitvise SSH Client 제어 [1]
12557정성태3/10/2021322Windows: 191. 탐색기의 보안 탭에 있는 "Object name" 경로에 LEFT-TO-RIGHT EMBEDDING 제어 문자가 포함되는 문제
12556정성태3/9/2021289오류 유형: 703. PowerShell ISE의 Debug / Toggle Breakpoint 메뉴가 비활성 상태인 경우
12555정성태3/8/2021515Windows: 190. C# - 레지스트리에 등록된 DigitalProductId로부터 라이선스 키(Product Key)를 알아내는 방법파일 다운로드2
12554정성태3/8/2021538.NET Framework: 1027. 닷넷 응용 프로그램을 위한 PDB 옵션 - full, pdbonly, portable, embedded
12553정성태3/5/2021567개발 환경 구성: 548. 기존 .NET Framework 프로젝트를 .NET Core 용으로 변환해 주는 upgrade-assistant, try-convert 도구 소개
12552정성태3/5/2021409개발 환경 구성: 547. github workflow/actions에서 Visual Studio Marketplace 패키지 등록하는 방법
12551정성태3/5/2021408오류 유형: 702. 비주얼 스튜디오 - The 'CascadePackage' package did not load correctly. (2)
12550정성태3/5/2021369오류 유형: 701. Live Share 1.0.3713.0 버전을 1.0.3884.0으로 업데이트 이후 ContactServiceModelPackage 오류 발생하는 문제
12549정성태3/4/2021406오류 유형: 700. VsixPublisher를 이용한 등록 시 다양한 오류 유형 해결책
12548정성태3/4/2021431개발 환경 구성: 546. github workflow/actions에서 nuget 패키지 등록하는 방법
12547정성태3/3/2021502오류 유형: 699. 비주얼 스튜디오 - The 'CascadePackage' package did not load correctly.
12546정성태3/3/2021438개발 환경 구성: 545. github workflow/actions에서 빌드시 snk 파일 다루는 방법 - Encrypted secrets
12545정성태3/2/20211095.NET Framework: 1026. 닷넷 5에 추가된 POH (Pinned Object Heap) [7]
12544정성태2/26/2021765.NET Framework: 1025. C# - Control의 Invalidate, Update, Refresh 차이점 [2]
12543정성태2/26/2021650VS.NET IDE: 158. C# - 디자인 타임(design-time)과 런타임(runtime)의 코드 실행 구분
12542정성태2/20/2021731개발 환경 구성: 544. github repo의 Release 활성화 및 Actions를 이용한 자동화 방법
12541정성태2/18/2021690개발 환경 구성: 543. 애저듣보잡 - Github Workflow/Actions 소개
12540정성태2/17/2021694.NET Framework: 1024. C# - Win32 API에 대한 P/Invoke를 대신하는 Microsoft.Windows.CsWin32 패키지
1  2  3  4  5  6  7  [8]  9  10  11  12  13  14  15  ...