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"로 추가하는 식으로 사용할 수 없습니다.
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]