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

C# - Win32 API에 대한 P/Invoke를 대신하는 Microsoft.Windows.CsWin32 패키지

아래의 글에 재미있는 소식이 있습니다. ^^

Making Win32 APIs More Accessible to More Languages
; https://blogs.windows.com/windowsdeveloper/2021/01/21/making-win32-apis-more-accessible-to-more-languages/

microsoft/win32metadata - Tooling to generate metadata for Win32 APIs in the Windows SDK.
; https://github.com/microsoft/win32metadata

C#/Win32
; https://github.com/microsoft/CsWin32

설명 대신 곧바로 ^^ 코드로 들어가 볼까요?

우선, C# 프로젝트를 생성한 다음 Nuget으로부터 Microsoft.Windows.CsWin32 패키지를 참조 추가합니다.

Install-Package Microsoft.Windows.CsWin32 -Version 0.1.422-beta

그다음, NativeMethods.txt 파일을 프로젝트에 추가하고 호출을 원하는 Win32 API 함수를 적어놓습니다. 가령 지난 글의 실습으로 RTT(Round-Trip Time) 값을 구할 수 있는 방법으로 "GetRTTAndHopCount" API를 소개만 하고 지나갔는데요,

BDP(Bandwidth-delay product)와 TCP Receive Window
; https://www.sysnet.pe.kr/2/0/12536

이 함수를 사용하기 위해 NativeMethods.txt 파일에 다음과 같이 함수 이름을 (라인 하나당) 하나 기입합니다. (asterisk(*)를 이용한 와일드카드 사용도 가능합니다.)

GetRTTAndHopCount 

이후 다음과 같이 using 문과 (정의한 적도 없는) PInvoke 타입의 정적 멤버로 GetRTTAndHopCount를 호출할 수 있습니다.

using System;
using System.Net;
using Microsoft.Windows.Sdk;

class Program
{
    static void Main(string[] args)
    {
        foreach (IPAddress addr in Dns.GetHostAddresses("www.microsoft.com"))
        {
            if (addr.AddressFamily != System.Net.Sockets.AddressFamily.InterNetwork)
            {
                continue;
            }

            if (PInvoke.GetRTTAndHopCount((uint)addr.Address, out uint hopCount, 30, out uint roundTripTime) == true)
            {
                Console.WriteLine($"{addr} {roundTripTime}(ms), {hopCount}");
            }
        }
    }
}

/* 출력 결과
23.201.37.168 2(ms), 9
*/




그냥 보면 마법 같아 보이지만, 사실 이에는 "Source Generator" 기술이 숨겨져 있습니다.

C# - Source Generator 소개
; https://www.sysnet.pe.kr/2/0/12223

C# - Source Generator를 적용한 XmlCodeGenerator
; https://www.sysnet.pe.kr/2/0/12228

따라서, 참조 추가했던 Microsoft.Windows.CsWin32 패키지는 "Analyzers"에도 추가되어 "NativeMethods.txt" 파일이 프로젝트와 같은 폴더에 존재하면 그 파일 내에 지정된 Win32 API를 포함하는 PInvoke 타입을 다음과 같이 만들어 빌드에 포함시킵니다.

// %LOCALAPPDATA%\Temp\VisualStudioSourceGeneratedDocuments\dd7594ed-db9c-471a-82b2-2e0635bc62ba\Microsoft.Windows.CsWin32\Microsoft.Windows.CsWin32.SourceGenerator\PInvoke.IPHlpApi.cs

using System;
using System.Runtime.InteropServices;

namespace Microsoft.Windows.Sdk
{
    internal static class PInvoke
    {
        internal unsafe static BOOL GetRTTAndHopCount(uint DestIpAddress, out uint HopCount, uint MaxHops, out uint RTT)
        {
            fixed (uint* ptr = &RTT)
            {
                uint* RTTLocal = ptr;
                fixed (uint* ptr2 = &HopCount)
                {
                    uint* HopCountLocal = ptr2;
                    return PInvoke.GetRTTAndHopCount(DestIpAddress, HopCountLocal, MaxHops, RTTLocal);
                }
            }
        }

        [DllImport("IPHlpApi", ExactSpelling = true, SetLastError = true)]
        internal unsafe static extern BOOL GetRTTAndHopCount(uint DestIpAddress, [Out] uint* HopCount, uint MaxHops, [Out] uint* RTT);
    }
}

따라서 비록 베타 버전이긴 해도 그 자체의 기능을 이용하는 것이 아닌, 별도로 생성한 (그리고 눈으로 확인할 수 있는) 코드 파일을 사용하는 것이므로 정식 버전을 기다릴 필요 없이 지금 당장 사용해도 무방합니다.

그 외에 약간 사용자 정의할 수 있는 부분들이 제공되는데 이에 대해서는 다음의 json 파일을 참고하세요.

settings.schema.json
; https://raw.githubusercontent.com/microsoft/CsWin32/main/src/Microsoft.Windows.CsWin32/settings.schema.json

마지막으로, 문서 상으로는 "C# 9 + .NET 5 SDK" 또는 "비주얼 스튜디오 2019 (16.8) 버전"을 요구합니다. 하지만 프로젝트의 닷넷 버전도 문제가 될 수 있는데요, 가령 제가 테스트해 본 바에 의하면 .NET Core 2.0 미만 프로젝트와 .NET Framework 4.6.1 미만에서는 동작하지 않았습니다.




아직 Prerelease 상태이므로 다음과 같이 추가하는 경우 오류가 발생합니다.

PM> Install-Package Microsoft.Windows.CsWin32
Install-Package : Unable to find package 'Microsoft.Windows.CsWin32'
At line:1 char:1
+ Install-Package Microsoft.Windows.CsWin32
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [Install-Package], Exception
    + FullyQualifiedErrorId : NuGetCmdletUnhandledException,NuGet.PackageManagement.PowerShellCmdlets.InstallPackageCommand
 
Time Elapsed: 00:00:00.0433365

현재(2021-02-17) 기준으로 버전을 반드시 명시해야 합니다.

또한, NativeMethods.txt 파일은 프로젝트에 명시적으로 등록하지 않아도 됩니다. 즉, csproj 파일과 같은 폴더에 있기만 하면 됩니다. 이 때문에 서로 다른 프로젝트에서 기존 NativeMethods.txt 파일을 재사용할 수 없습니다. 즉, "Add as Link"로 추가하는 식으로 사용할 수 없습니다.




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



donaricano-btn



[최초 등록일: ]
[최종 수정일: 6/12/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)
12551정성태3/5/2021662오류 유형: 702. 비주얼 스튜디오 - The 'CascadePackage' package did not load correctly. (2)
12550정성태3/5/2021603오류 유형: 701. Live Share 1.0.3713.0 버전을 1.0.3884.0으로 업데이트 이후 ContactServiceModelPackage 오류 발생하는 문제
12549정성태3/4/2021633오류 유형: 700. VsixPublisher를 이용한 등록 시 다양한 오류 유형 해결책
12548정성태3/4/2021678개발 환경 구성: 546. github workflow/actions에서 nuget 패키지 등록하는 방법
12547정성태3/3/2021903오류 유형: 699. 비주얼 스튜디오 - The 'CascadePackage' package did not load correctly.
12546정성태3/3/2021765개발 환경 구성: 545. github workflow/actions에서 빌드시 snk 파일 다루는 방법 - Encrypted secrets
12545정성태3/2/20211509.NET Framework: 1026. 닷넷 5에 추가된 POH (Pinned Object Heap) [7]
12544정성태2/26/20211169.NET Framework: 1025. C# - Control의 Invalidate, Update, Refresh 차이점 [2]
12543정성태2/26/20211118VS.NET IDE: 158. C# - 디자인 타임(design-time)과 런타임(runtime)의 코드 실행 구분
12542정성태2/20/20211264개발 환경 구성: 544. github repo의 Release 활성화 및 Actions를 이용한 자동화 방법
12541정성태2/18/2021993개발 환경 구성: 543. 애저듣보잡 - Github Workflow/Actions 소개
12540정성태2/17/2021990.NET Framework: 1024. C# - Win32 API에 대한 P/Invoke를 대신하는 Microsoft.Windows.CsWin32 패키지
12539정성태2/16/20211077Windows: 189. WM_TIMER의 동작 방식 개요파일 다운로드1
12538정성태2/15/20211273.NET Framework: 1023. C# - GC 힙이 아닌 Native 힙에 인스턴스 생성 - 0SuperComicLib.LowLevel 라이브러리 소개 [2]
12537정성태2/11/20211366.NET Framework: 1022. UI 요소의 접근은 반드시 그 UI를 만든 스레드에서! - 두 번째 이야기
12536정성태2/9/20211309개발 환경 구성: 542. BDP(Bandwidth-delay product)와 TCP Receive Window
12535정성태2/9/2021907개발 환경 구성: 541. Wireshark로 확인하는 LSO(Large Send Offload), RSC(Receive Segment Coalescing) 옵션
12534정성태2/8/20211223개발 환경 구성: 540. Wireshark + C/C++로 확인하는 TCP 연결에서의 closesocket 동작 [1]파일 다운로드1
12533정성태2/8/20211189개발 환경 구성: 539. Wireshark + C/C++로 확인하는 TCP 연결에서의 shutdown 동작파일 다운로드1
12532정성태2/6/20211057개발 환경 구성: 538. Wireshark + C#으로 확인하는 ReceiveBufferSize(SO_RCVBUF), SendBufferSize(SO_SNDBUF) [1]
12531정성태2/5/2021941개발 환경 구성: 537. Wireshark + C#으로 확인하는 PSH flag와 Nagle 알고리듬파일 다운로드1
12530정성태2/4/20211402개발 환경 구성: 536. Wireshark + C#으로 확인하는 TCP 통신의 Receive Window
12529정성태2/4/20211012개발 환경 구성: 535. Wireshark + C#으로 확인하는 TCP 통신의 MIN RTO [1]
12528정성태2/1/20211082개발 환경 구성: 534. Wireshark + C#으로 확인하는 TCP 통신의 MSS(Maximum Segment Size) - 윈도우 환경
12527정성태2/1/20211067개발 환경 구성: 533. Wireshark + C#으로 확인하는 TCP 통신의 MSS(Maximum Segment Size) - 리눅스 환경파일 다운로드1
12526정성태2/1/2021861개발 환경 구성: 532. Azure Devops의 파이프라인 빌드 시 snk 파일 다루는 방법 - Secure file
1  2  3  4  5  6  7  8  9  10  11  12  [13]  14  15  ...