C# - .NET 7부터 UnmanagedCallersOnly 함수 export 기능을 AOT 빌드에 통합
예전에,
.NET 5 / .NET Core - UnmanagedCallersOnly 특성을 사용한 함수 내보내기
; https://www.sysnet.pe.kr/2/0/12413
UnmanagedCallersOnly 특성을 이용해 .NET DLL에서 Win32 API와 같은 식의 export 기능을 소개한 적이 있습니다. 그런데, 이 과정이
.NET 7의 "PublishAot" 옵션과 만나면서 더 쉽게 바뀌었습니다.
그래서
예전 글의 예제를, 단순히 다음과 같이 구현해 주고,
using System.Runtime.InteropServices;
namespace ClassLibrary2;
public class Class1
{
[UnmanagedCallersOnly(EntryPoint = "mymethod")]
public static void MyMethod(nint ptrText)
{
if (ptrText == IntPtr.Zero)
{
return;
}
string? text = Marshal.PtrToStringUni(ptrText);
Console.WriteLine($"{DateTime.Now} {text}");
}
}
csproj에 PublishAot, RuntimeIdentifier 옵션만 추가한 다음,
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net7.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<RuntimeIdentifier>win-x64</RuntimeIdentifier>
<PublishAot>true</PublishAot>
</PropertyGroup>
</Project>
명령행에서 "dotnet publish" 명령만 수행하면 됩니다.
C:\temp\ClassLibrary2> dotnet publish
MSBuild version 17.8.3+195e7f5a3 for .NET
Determining projects to restore...
All projects are up-to-date for restore.
ClassLibrary2 -> C:\temp\ClassLibrary2\bin\Debug\net7.0\win-x64\ClassLibrary2.dll
Generating native code
Creating library bin\Debug\net7.0\win-x64\native\ClassLibrary2.lib and object bin\Debug\net7.0\win-x64\native\ClassLibrary2.exp
ClassLibrary2 -> C:\temp\ClassLibrary2\bin\Debug\net7.0\win-x64\publish\
그럼, 소스 코드 내에서의
UnmanagedCallersOnly + EntryPoint 값이 부여된 것에 대해 자동으로 Win32 EXPORT 함수로 등록해 줍니다.
이후 사용하는 측에서는, 저렇게 생성한 (AOT로 빌드된) ClassLibrary2.dll 파일을 EXE 측에 복사해 둔 다음 DllImport를 연결한 코드를 수행하면 됩니다.
using System.Runtime.InteropServices;
namespace ConsoleApp1;
internal class Program
{
// 받는 측에서 text 인자를 Unicode로 취급하므로 반드시 MarshalAs로 LPWStr 값을 지정 (기본값은 ANSI)
[DllImport(@"ClassLibrary2.dll")]
private static extern int mymethod([MarshalAs(UnmanagedType.LPWStr)] string text);
static void Main(string[] args)
{
mymethod("TEST");
}
}
개발을 좀 편리하게 하려면, (AOT로 publish된) ClassLibrary2.dll 출력 파일을 EXE 프로젝트 측에 연결하는 것이 좋습니다.
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<None Include="..\ClassLibrary2\bin\$(Configuration)\net7.0\win-x64\publish\*">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
</ItemGroup>
</Project>
비록 여전히 ClassLibrary2 프로젝트의 소스 코드가 변경되면 명령행에서 "dotnet publish"를 수행해야 하지만 그래도 일단 배포가 되면 CopyToOutputDirectory까지 연결이 되므로 그 외의 수작업은 줄어듭니다.
게다가 PDB 파일까지 함께 배포되므로, ClassLibrary2의 코드를 디버깅할 수도 있는데요, 단지 AOT로 빌드된 네이티브 코드로 다뤄지기 때문에 "Launch Profiles" 설정에서 "Enable native code debugging" 옵션은 켜야 합니다.
Enable debugging for managed and native code together, also known as mixed-mode debugging.
하는 김에, 할당한 메모리를 반환값으로 사용하는 경우 호출 측에서의 메모리 해제를 다뤄볼까요? ^^ 이를 위해 다음과 같은 export 함수를 만들고,
[UnmanagedCallersOnly(EntryPoint = "Concat")]
public static char* Concat(char* text1, char* text2)
{
int len1 = GetTextLen(text1);
int len2 = GetTextLen(text2);
int dstSize = (len1 + len2 + 1) * 2;
nint pBuffer = Marshal.AllocHGlobal(dstSize);
System.Buffer.MemoryCopy(text1, (void*)pBuffer, dstSize, len1 * 2);
System.Buffer.MemoryCopy(text2, (void*)(pBuffer + (len1 * 2)), dstSize - (len1 * 2), len2 * 2);
*((char*)(pBuffer + dstSize - 2)) = '\0';
return (char*)pBuffer;
}
private static int GetTextLen(char* ptr)
{
int len = 0;
while (*ptr != 0)
{
len++;
ptr++;
}
return len;
}
사용은 이렇게 할 텐데요,
using System.Runtime.InteropServices;
namespace ConsoleApp1;
internal partial class Program
{
[DllImport(@"ClassLibrary2.dll")]
[return: MarshalAs(UnmanagedType.LPWStr)]
public static extern string Concat([MarshalAs(UnmanagedType.LPWStr)] string text1, [MarshalAs(UnmanagedType.LPWStr)] string text2);
static void Main(string[] args)
{
while (true)
{
Console.WriteLine($"Concat-Output: {Concat("test is ", "good")}");
}
}
}
그렇다면, 저 코드는 Marshal.AllocHGlobal을 무한 루프로 실행하기 때문에 메모리 누수가 발생할까요? 의외로, 발생하지 않습니다. 왜냐하면, string으로
마샬링을 처리하는 런타임 생성 코드에서 자동으로 Marshal.FreeHGlobal을 호출해 주기 때문입니다.
물론, string이 아닌, 포인터로 직접 받도록 signature를 지정하면,
[DllImport(@"ClassLibrary2.dll")]
public static extern nint Concat([MarshalAs(UnmanagedType.LPWStr)] string text1,
[MarshalAs(UnmanagedType.LPWStr)] string text2);
static void Main(string[] args)
{
mymethod("TEST");
while (true)
{
nint result = Concat("test is ", "good"); // 메모리 누수
}
}
이때는 메모리 누수가 발생하게 됩니다. 따라서 저렇게 했다면 반드시 호출 측에서 메모리 정리까지 해야 합니다.
nint result = Concat("test is ", "good");
Marshal.FreeHGlobal(result); // 호출 측에서 명시적인 메모리 해제
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]