.NET Framework 및 .NET 5 - UnmanagedCallersOnly 특성 사용
UnmanagedCallersOnly 특성은,
UnmanagedCallersOnlyAttribute Class
; https://learn.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.unmanagedcallersonlyattribute
Improvements in native code interop in .NET 5.0
; https://devblogs.microsoft.com/dotnet/improvements-in-native-code-interop-in-net-5-0/
관리 코드를 native에서 접근하기 위한 다양한 방법에 사용됩니다. 대표적으로 C# 9.0에서도 function pointer와 함께 native 측으로 런타임에 닷넷 함수를 노출할 때도 사용할 수 있습니다. 따라서 이 기능으로만 제한한다면 UnmanagedCallersOnly 특성은 (단지 C# 9.0 컴파일러로 빌드할 수 있다면) 모든 플랫폼에서 사용하는 것이 가능합니다.
사용 예제를 들어가기에 앞서 기존 문제점을 먼저 짚어 보겠습니다. 가령, 윈도우 운영체제에 실행 중인 윈도우(Window)를 열거할 때 EnumWindows Win32 API로,
EnumWindows function (winuser.h)
; https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-enumwindows
다음과 같이 callback을 받아 사용할 수 있습니다.
using PInvoke;
using System;
using System.Windows.Forms;
namespace WindowsFormsApp1
{
// dotnet / pinvoke
// https://github.com/dotnet/pinvoke
// Install-Package PInvoke.User32
public partial class Form1 : Form
{
public Form1()
{
InitializeComponent();
}
static bool ewCallback(IntPtr hwnd, IntPtr userContext)
{
string title = "";
try
{
title = User32.GetWindowText(hwnd);
if (string.IsNullOrEmpty(title) == true)
{
return true;
}
}
catch (System.ComponentModel.Win32Exception)
{
return true;
}
System.Diagnostics.Trace.WriteLine($"{title}: {hwnd}");
return true;
}
private void Form1_Load(object sender, EventArgs e)
{
User32.EnumWindows(ewCallback, IntPtr.Zero);
// 위의 코드는 결국 이렇게 호출한 것과 동일
// User32.WNDENUMPROC lpEnumProc = new User32.WNDENUMPROC(ewCallback);
// User32.EnumWindows(lpEnumProc, IntPtr.Zero);
}
}
}
그러니까, (위의 경우 WNDENUMPROC) Delegate 타입의 인스턴스에 닷넷 메서드를 포장해 전달하고 있습니다. 대개의 경우, 이번 EnumWindows처럼 해당 호출의 내부 실행 중에 콜백이 전부 발생한다면 문제가 발생할 여지는 없습니다. 하지만, 간혹 비동기적으로 콜백을 호출하는... 예를 들어 SetTimer와 같은 경우는,
SetTimer function (winuser.h)
; https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-settimer
using System;
using System.Runtime.InteropServices;
using System.Windows.Forms;
namespace WindowsFormsApp1
{
public partial class Form1 : Form
{
[DllImport("user32.dll", ExactSpelling = true)]
static extern IntPtr SetTimer(IntPtr hWnd, IntPtr nIDEvent, uint uElapse, TimerProc lpTimerFunc);
delegate void TimerProc(IntPtr hWnd, uint uMsg, IntPtr nIDEvent, uint dwTime);
public Form1()
{
InitializeComponent();
}
static void timerCallback(IntPtr hWnd, uint uMsg, IntPtr nIDEvent, uint dwTime)
{
Console.WriteLine($"timerCallback - {dwTime}");
}
private void Form1_Load(object sender, EventArgs e)
{
SetTimer(this.Handle, IntPtr.Zero, 1000, timerCallback);
// 위의 코드는 결국 이렇게 호출한 것과 동일
// TimerProc timerProc = new TimerProc(timerCallback);
// SetTimer(this.Handle, IntPtr.Zero, 1000, timerProc);
}
}
}
호출 이후, 초기에는 1초 간격으로 timerCallback이 잘 동작하지만 어느 순간부터, 디버깅 중이라면 비주얼 스튜디오에서 이런 오류 창을 보여줄 것이고,
Managed Debugging Assistant 'CallbackOnCollectedDelegate'
Message=Managed Debugging Assistant 'CallbackOnCollectedDelegate' : 'A callback was made on a garbage collected delegate of type 'WindowsFormsApp1!WindowsFormsApp1.Form1+TimerProc::Invoke'. This may cause application crashes, corruption and data loss. When passing delegates to unmanaged code, they must be kept alive by the managed application until it is guaranteed that they will never be called.'
그렇지 않다면, 비정상 종료하면서 이벤트 로그에 그 기록이 남을 것입니다. 관련해서는 이전에도 여러 번 글을 쓴 적이 있습니다. ^^
CallbackOnCollectedDelegate was detected
; https://www.sysnet.pe.kr/2/0/710
C#에서 C/C++ 함수로 콜백 함수를 전달하는 예제 코드
; https://www.sysnet.pe.kr/2/0/11099
OpenGL.NET 예제 실행 시 "Managed Debugging Assistant 'CallbackOnCollectedDelegate'" 예외 발생
; https://www.sysnet.pe.kr/2/0/11786
이런 문제를, 게다가 더욱 쉬운 방법으로 해결할 수 있는 것이 바로
C# 9.0의 function pointer와 UnmanagedCallersOnly 특성의 조합입니다. 위의 예제와 같은 경우라면 콜백 메서드에 UnmanagedCallersOnly 특성과 함께 함수 포인터를 받도록 pinvoke를 마련하고,
[DllImport("user32.dll", ExactSpelling = true)]
static unsafe extern IntPtr SetTimer(IntPtr hWnd, IntPtr nIDEvent, uint uElapse, delegate* unmanaged[Stdcall]<IntPtr, uint, IntPtr, uint, void> lpTimerFunc);
[UnmanagedCallersOnly(CallConvs = new Type[] { typeof(CallConvStdcall) })]
static void timerCallback(IntPtr hWnd, uint uMsg, IntPtr nIDEvent, uint dwTime)
{
Console.WriteLine($@"{(IntPtr.Size == 4 ? "x86" : "x64")}: {DateTime.Now}");
}
이렇게 바로 SetTimer를 호출하면 됩니다.
SetTimer(this.Handle, IntPtr.Zero, 1000, &timerCallback);
이 방법은
함수의 위치를 가리키는 포인터 주솟값을 곧바로 native 측에 전달하는 것이기 때문에, 기존에 Delegate 개체가 GC되었을 때 오동작하게 되는 문제에서 자연스럽게 벗어납니다.
그야말로... 성능도 좋고, 구문도 간단해지고, GC 문제도 없어지니 안 쓸 이유가 없지만 한 가지 유의할 사항이 있습니다. UnmanagedCallersOnly 특성이 부여된 메서드는 분명히 "unmanaged" 환경이라는 것을 알아야 합니다. 이런 영향 때문에, 메서드의 인자로 전달할 수 있는 타입은
blittable 유형만 가능하며, (Delegate로 경유했을 때는 "managed" 환경이므로 콜백 메서드를 인스턴스 멤버로 정의해 내부에서 "this"를 사용하는 것도 가능하지만) 반드시 static 메서드로 정의해야 한다는 차이점도 발생합니다.
또한 닷넷 코드에서 직접 UnmanagedCallersOnly가 적용된 메서드를 호출하면 이런 오류가 발생합니다.
private void button1_Click(object sender, EventArgs e)
{
// 컴파일 오류 - Error CS8901 'Form1.timerCallback(IntPtr, uint, IntPtr, uint)' is attributed with 'UnmanagedCallersOnly' and cannot be called directly. Obtain a function pointer to this method.
timerCallback(this.Handle, 0, IntPtr.Zero, 0);
}
메시지에도 나오듯이, 직접 호출은 할 수 없지만 대신 함수 포인터를 이용하면 닷넷에서도 호출이 가능합니다.
private unsafe void button1_Click(object sender, EventArgs e)
{
// timerCallback(this.Handle, 0, IntPtr.Zero, 0);
delegate* unmanaged[Stdcall]<IntPtr, uint, IntPtr, uint, void> lpTimerFunc = &timerCallback;
lpTimerFunc(this.Handle, 0, IntPtr.Zero, 0);
}
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
참고로, UnmanagedCallersOnly 특성은 .NET 5의 BCL에만 있으므로, NET Framework에서는 다음과 같이 그냥 클래스만 정의해 포함하면 됩니다.
#if !NET5_0
namespace System.Runtime.InteropServices
{
[AttributeUsage(AttributeTargets.Method, Inherited = false)]
public sealed class UnmanagedCallersOnlyAttribute : Attribute
{
public Type[] CallConvs;
public string EntryPoint;
}
}
#endif
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]