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)
12576정성태3/25/2021799개발 환경 구성: 558. Docker Desktop for Windows에서 DockerDesktopVM 기반의 Kubernetes 구성 (2) - k8s 서비스 위치
12575정성태3/24/2021737개발 환경 구성: 557. Docker Desktop for Windows에서 DockerDesktopVM 기반의 Kubernetes 구성
12574정성태3/23/20211151.NET Framework: 1030. C# Socket의 Close/Shutdown 동작 (동기 모드)
12573정성태3/22/2021905개발 환경 구성: 556. WSL 인스턴스 초기 설정 명령어
12572정성태3/22/2021809.NET Framework: 1029. C# - GC 호출로 인한 메모리 압축(Compaction)을 확인하는 방법파일 다운로드1
12571정성태3/21/2021816오류 유형: 706. WSL 2 기반으로 "Enable Kubernetes" 활성화 시 초기화 실패 [1]
12570정성태3/19/2021844개발 환경 구성: 555. openssl - CA로부터 인증받은 새로운 인증서를 생성하는 방법
12569정성태3/18/20211023개발 환경 구성: 554. WSL 인스턴스 export/import 방법 및 단축 아이콘 설정 방법
12568정성태3/18/2021673오류 유형: 705. C# 빌드 - Couldn't process file ... due to its being in the Internet or Restricted zone or having the mark of the web on the file.
12567정성태3/17/2021721개발 환경 구성: 553. Docker Desktop for Windows를 위한 k8s 대시보드 활성화 [1]
12566정성태3/17/2021805개발 환경 구성: 552. Kubernetes - kube-apiserver와 REST API 통신하는 방법 (Docker Desktop for Windows 환경)
12565정성태3/17/2021586오류 유형: 704. curl.exe 실행 시 dll not found 오류
12564정성태3/16/2021684VS.NET IDE: 160. 새 프로젝트 창에 C++/CLI 프로젝트 템플릿이 없는 경우
12563정성태3/16/2021739개발 환경 구성: 551. C# - JIRA REST API 사용 정리 (3) jira-oauth-cli 도구를 이용한 키 관리
12562정성태3/15/2021834개발 환경 구성: 550. C# - JIRA REST API 사용 정리 (2) JIRA OAuth 토큰으로 API 사용하는 방법파일 다운로드1
12561정성태3/12/2021659VS.NET IDE: 159. Visual Studio에서 개행(\n, \r) 등의 제어 문자를 치환하는 방법 - 정규 표현식 사용
12560정성태3/11/20211057개발 환경 구성: 549. ssh-keygen으로 생성한 개인키/공개키 파일을 각각 PKCS8/PEM 형식으로 변환하는 방법
12559정성태3/11/2021741.NET Framework: 1028. 닷넷 5 환경의 Web API에 OpenAPI 적용을 위한 NSwag 또는 Swashbuckle 패키지 사용파일 다운로드1
12558정성태3/10/20211038Windows: 192. Power Automate Desktop (Preview) 소개 - Bitvise SSH Client 제어 [1]
12557정성태3/10/2021585Windows: 191. 탐색기의 보안 탭에 있는 "Object name" 경로에 LEFT-TO-RIGHT EMBEDDING 제어 문자가 포함되는 문제
12556정성태3/9/2021540오류 유형: 703. PowerShell ISE의 Debug / Toggle Breakpoint 메뉴가 비활성 상태인 경우
12555정성태3/8/2021775Windows: 190. C# - 레지스트리에 등록된 DigitalProductId로부터 라이선스 키(Product Key)를 알아내는 방법파일 다운로드2
12554정성태3/8/2021981.NET Framework: 1027. 닷넷 응용 프로그램을 위한 PDB 옵션 - full, pdbonly, portable, embedded
12553정성태3/5/2021842개발 환경 구성: 548. 기존 .NET Framework 프로젝트를 .NET Core 용으로 변환해 주는 upgrade-assistant, try-convert 도구 소개
12552정성태3/5/2021640개발 환경 구성: 547. github workflow/actions에서 Visual Studio Marketplace 패키지 등록하는 방법
12551정성태3/5/2021661오류 유형: 702. 비주얼 스튜디오 - The 'CascadePackage' package did not load correctly. (2)
1  2  3  4  5  6  7  8  9  10  11  [12]  13  14  15  ...