C# - GUID 타입 전용의 UnmanagedType.LPStruct
LPStruct 옵션에 대한 좋은 글이 있군요. ^^
The confusing UnmanagedType.LPStruct marshaling directive
; https://learn.microsoft.com/en-us/archive/blogs/adam_nathan/the-confusing-unmanagedtype-lpstruct-marshaling-directive
UnmanagedType.LPStruct is only supported for one specific case: treating a System.Guid value type as an unmanaged GUID with an extra level of indirection. In other words, this directive makes the marshaler add a level of indirection to System.Guid when marshaling it from managed to unmanaged code, and remove a level of indirection from GUID when marshaling it from unmanaged to managed code.
글에서도 나오지만, 하위 호환성만 아니면 이름을 바꿨을 거라고 합니다. 또한 다음의 공식 문서에서도,
Native interoperability best practices
; https://learn.microsoft.com/en-us/dotnet/standard/native-interop/best-practices
GUIDs
GUIDs are usable directly in signatures. Many Windows APIs take GUID& type aliases like REFIID. When passed by ref, they can either be passed by ref or with the [MarshalAs(UnmanagedType.LPStruct)] attribute.
DO NOT Use [MarshalAs(UnmanagedType.LPStruct)] for anything other than ref GUID parameters.
분명하게
GUID를 위한 옵션이라고 강조하고 있습니다. 그런데 사실, 이게 좀 더 문제가 되는 것은 UnmanagedType enum 문서에,
UnmanagedType Enum
; https://learn.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.unmanagedtype
LPStruct
A pointer to a C-style structure that you use to marshal managed formatted classes. This member is valid for platform invoke methods only.
LPStruct가 일반적인 타입에도 사용할 수 있을 것처럼 쓰여 있기 때문입니다. 실제로 어느 쪽이 맞는지 간단하게 테스트를 한 번 해볼까요? ^^
C++로는 다음과 같은 예제 코드의 경우,
__declspec(dllexport) void __stdcall GuidFunc(GUID* pGuid)
{
wchar_t buf[1024] = { 0 };
StringFromGUID2(*pGuid, buf, 1024);
wcout << buf << endl;
}
GUID 타입이기 때문에 C# 측에서는 다음과 같이 다양하게 interop 옵션으로 C++ 코드와 연동할 수 있습니다.
[DllImport("Dll1.dll", EntryPoint = "GuidFunc")]
static extern void GuidFunc1(IntPtr ptr);
[DllImport("Dll1.dll", EntryPoint = "GuidFunc")]
unsafe static extern void GuidFunc2(Guid* ptr);
[DllImport("Dll1.dll", EntryPoint = "GuidFunc")]
static extern void GuidFunc3([MarshalAs(UnmanagedType.LPStruct)] Guid ptr);
{
Guid iUnk = new Guid("{00000000-0000-0000-C000-000000000046}");
{
IntPtr pGuid = Marshal.AllocHGlobal(16);
Marshal.StructureToPtr(iUnk, pGuid, true);
GuidFunc1(pGuid);
Marshal.FreeHGlobal(pGuid);
}
unsafe
{
GuidFunc2(&iUnk);
}
{
GuidFunc3(iUnk);
}
}
사실 가장 직관적인 연동은 두 번째에 해당하는 "Guid*"이지만, LPStruct를 이용하면 포인터임에도 불구하고 마치 값 형식처럼 간단하게 전달할 수 있고 이에 대한 처리는 CLR 측의 마샬러가 자동으로 해줍니다.
혹시 동일하게 16바이트로 구성한 구조체라면 LPStruct를 사용할 수 있지 않을까요? 그래서 C++ 측의 코드를,
#pragma pack(push, 1)
typedef struct tagMyStruct
{
int a;
int b;
int c;
int d;
} MyStruct;
#pragma pack(pop)
__declspec(dllexport) void __stdcall StructFunc(MyStruct* pGuid)
{
cout << pGuid->a << ", " << pGuid->b << ", " << pGuid->c << ", " << pGuid->d << endl;
}
GUID 예제와 마찬가지로 C#에서 다음과 같이 interop하면,
[DllImport("Dll1.dll", EntryPoint = "StructFunc")]
static extern void StructFunc1(IntPtr ptr);
[DllImport("Dll1.dll", EntryPoint = "StructFunc")]
unsafe static extern void StructFunc2(MyStruct* ptr);
[DllImport("Dll1.dll", EntryPoint = "StructFunc")]
static extern void StructFunc3([MarshalAs(UnmanagedType.LPStruct)] MyStruct MyStruct);
{
MyStruct instance = new MyStruct();
{
instance.a = 5;
instance.b = 6;
instance.c = 7;
instance.d = 8;
int size = Marshal.SizeOf(typeof(MyStruct));
IntPtr pInstance = Marshal.AllocHGlobal(size);
Marshal.StructureToPtr(instance, pInstance, true);
StructFunc1(pInstance);
Marshal.FreeHGlobal(pInstance);
}
unsafe
{
StructFunc2(&instance);
}
{
StructFunc3(instance);
}
}
3번째 UnmanagedType.LPStruct를 사용한 메서드에서 다음과 같은 오류가 발생합니다.
Unhandled Exception: System.Runtime.InteropServices.MarshalDirectiveException: Cannot marshal 'parameter #1': Invalid managed/unmanaged type combination (this value type must be paired with Struct).
at lpStruct.Program.StructFunc3(MyStruct MyStruct)
at lpStruct.Program.Main(String[] args) in C:\lpStruct\lpStruct\Program.cs:line 84
또한, 지난 글에서처럼,
C# PInvoke - C++의 매개변수에 대한 마샬링을 tlbexp.exe를 이용해 확인하는 방법
; https://www.sysnet.pe.kr/2/0/12443
tlbexp.exe를 실행시켜 보면 마찬가지의 경고 메시지가 뜨면서 해당 메서드 자체를 누락시켜 버립니다.
TlbExp : warning TX801311A6 : Type library exporter warning processing '...'. Warning: The method or field has an invalid managed/unmanaged type combination, check the MarshalAs directive.
그런데, UnmanagedType 문서의 설명에서,
LPStruct
A pointer to a C-style structure that you use to marshal managed formatted classes. This member is valid for platform invoke methods only.
저렇게 "only"로 끝나는 제약이 약간 마음에 걸립니다. 즉, LPStruct + GUID는 메서드의 직접적인 인자로 전달할 때만 정상적인 마샬링 혜택을 받고 그 외의 경우에는 아니라는 의미인 듯합니다. 실제로, 필드로 정의한 GUID인 경우 LPStruct를 지정하면,
[StructLayout(LayoutKind.Sequential, Pack = 1)]
public struct MyGuid
{
[MarshalAs(UnmanagedType.LPStruct)]
public Guid CLSID;
}
[DllImport("Dll1.dll")]
static extern void GuidStructFunc(MyGuid instance);
/*
// tlbexp로 확인히면,
struct tagMyGuid {
GUID* CLSID;
} MyGuid;
*/
이번에는 일반 구조체인 경우와 동일한 오류가 발생합니다.
Unhandled Exception: System.TypeLoadException: Cannot marshal field 'CLSID' of type 'lpStruct.MyGuid': Invalid managed/unmanaged type combination (this value type must be paired with Struct).
at System.StubHelpers.ValueClassMarshaler.ConvertToNative(IntPtr dst, IntPtr src, IntPtr pMT, CleanupWorkList& pCleanupWorkList)
at lpStruct.Program.GuidStructFunc(MyGuid instance)
at lpStruct.Program.Main(String[] args) in C:\temp\lpStruct\Program.cs:line 113
또한 SizeOf 연산조차도 할 수 없습니다.
// System.ArgumentException: 'Type 'lpStruct.MyGuid' cannot be marshaled as an unmanaged structure; no meaningful size or offset can be computed.'
int size = Marshal.SizeOf(instance);
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
정리해 보면, 일반적인 구조체인 경우 LPStruct를 이용해 포인터를 경유한 마샬링은 할 수 없습니다. 또한, LPStruct의 마샬링 혜택을 받는 GUID라고 해도 다른 구조체의 멤버로 있을 때는 예외가 발생합니다.
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]