C# - GUID 타입 전용의 UnmanagedType.LPStruct - 두 번째 이야기

이전 글에서,

C# - GUID 타입 전용의 UnmanagedType.LPStruct
; https://www.sysnet.pe.kr/2/0/12444

포인터 형의 GUID* 인자를 받는 API로,

__declspec(dllexport) void __stdcall GuidFunc(GUID* pGuid)
{
    wchar_t buf[1024] = { 0 };
    StringFromGUID2(*pGuid, buf, 1024);
    wcout << buf << endl;
}

UnmanagedType.LPStruct 특성을 지정한 Guid 인자를 넘겨줄 수 있다고 했습니다.

[DllImport("Dll1.dll", EntryPoint = "GuidFunc")]
static extern void GuidFunc([MarshalAs(UnmanagedType.LPStruct)] Guid ptr);

지난 글에 설명했지만, 원래 struct 값 형식은 닷넷 런타임이 마샬링 작업을 수행하지 않습니다. 하지만, 위와 같이 LPStruct를 지정한 경우에는 Guid 타입에 대해 마샬링을 수행하는데요, 이것을 포인터를 출력함으로써 확인할 수 있습니다.

__declspec(dllexport) void __stdcall GuidFunc(GUID* pGuid)
{
    wchar_t buf[1024] = { 0 };
    std::ignore = StringFromGUID2(*pGuid, buf, 1024);
    wcout << L"[GuidFunc] " << buf << L", ptr == " << pGuid << endl;
}

Guid iUnk = new Guid("{00000000-0000-0000-C000-000000000046}");

unsafe 
{
    Guid* ptr = &iUnk;
    Console.WriteLine($"[C#] ptr: {new IntPtr(ptr).ToInt64():X}");
    GuidFunc(iUnk);
}

/* 출력 결과:
    Console.WriteLine(iUnk);
[C#] ptr: bfe9a8
[GuidFunc] {00000000-0000-0000-C000-000000000046}, ptr == 0000000000BFE960
*/

포인터 값이 다르다는 것으로, 즉 닷넷 런타임은 Guid 값을 받아 별도의 메모리에 복사한 후 C/C++ API에 그 포인터 위치를 넘겨준 것으로 해석할 수 있습니다.

---

문서에도 나오지만, 엄밀히 UnmanagedType.LPStruct은 REFIID 타입으로 정의한 인자를 위해 만든 것입니다.

Native interoperability best practices
; https://learn.microsoft.com/en-us/dotnet/standard/native-interop/best-practices>

단지, 저것이 GUID* 포인터 타입에도 문제없이 적용되는 이유는 GUID& 타입이 내부적으로는 포인터와 다를 바가 없기 때문입니다. (실제로 REFIID의 경우 C++에서 GUID&로, C 언어에서는 GUID* 타입으로 정의합니다.)

하지만, 포인터로 받는 경우에 LPStruct를 쓰는 것은 포인터가 [In, Out]의 의미를 갖는다는 점에서 어울리지 않습니다. 일례로, GuidFunc 내부에서 Guid* 인자의 값을 변경하는 경우,

__declspec(dllexport) void __stdcall GuidFunc(GUID* pGuid)
{
    ((byte *)pGuid)[0] = 0xFF;
}

C# 호출 측에서는,

[DllImport("Dll1.dll")]
static extern void GuidFunc([MarshalAs(UnmanagedType.LPStruct)] Guid ptr);

Guid iUnk = new Guid("{00000000-0000-0000-C000-000000000046}");
GuidFunc(iUnk); // iUnk의 값이 바뀌지 않음

값이 바뀌지는 않습니다. 이런 경우, 만약 Guid가 (struct가 아닌) class 참조 형식이었다면 [In, Out]을 함께 곁들여,

[DllImport("Dll1.dll")]
static extern void GuidFunc([In, Out, MarshalAs(UnmanagedType.LPStruct)] Guid ptr);

정상적으로 C# 호출 측의 값이 바뀌게 만들 수도 있었을 것입니다. 하지만, In, Out은 참조 형식의 인스턴스를 마샬링할 때만 관여하므로 위와 같이 Guid struct에 대해서는 아무런 역할도 하지 않으므로 의도한 동작을 수행할 수 없습니다.

---

그나저나, LPStruct를 REFIID 인자를 갖는 API에 대해 사용하라고 했는데... 좀 이상하지 않나요? GUID&는 결국 포인터인데 그렇다면 그것도 [In, Out] 의미를 갖는 유형이므로 단순히 LPStruct만 지정해서는 안 될 것 같습니다.

하지만, 그래도 되는 것이 REFIID의 엄밀한 정의에는 const를 포함하고 있기 때문입니다.

#define REFIID const IID &

그렇기 때문에 애당초 해당 API에서는 인자로 넘어온 GUID 값을 수정하지 못할 것임을 보장하므로,

__declspec(dllexport) void __stdcall GuidReadOnlyRefFunc(REFIID refGuid)
{
    refGuid.Data3 = 0x05; // 컴파일 오류
    // Error C3490 'Data3' cannot be modified because it is being accessed through a const object
}

별도의 [Out] 의미를 기대하지 않고 LPStruct 처리가 가능한 것입니다.

---

정리해 보면, Win32 API, 특히 COM 함수와 연동할 때 아래와 같이 정의돼 있다면,

virtual HRESULT STDMETHODCALLTYPE GetItem(/* [out] */ __RPC__out GUID *pguidKey) = 0;

이런 경우는 GUID* 포인터이지만 __RPC__out 힌트가 있으므로 [Out] 의미만 갖는다고 짐작할 수 있습니다. 따라서 C# 측에서는 마샬링 없는 유형의 out 인자로 호출할 수 있습니다.

uint GetItemByIndex(out Guid pGuidKey);

반면, 이렇게 정의한 경우라면,

virtual HRESULT STDMETHODCALLTYPE GetResource(/* [annotation][in] */ _In_  REFIID riid) = 0;

REFIID로 명시한 경우이므로 LPStruct를 활용해 인자 전달을 할 수 있습니다.

uint GuidRefFunc([MarshalAs(UnmanagedType.LPStruct)] Guid riid);

단지, 이런 경우 아쉬운 점이라면 내부적으로 마샬링을 수행하므로 Guid 값 복사 부하가 발생합니다. 이것을 없애기 위해서는 포인터로 전달해야 하지만 그러면 불필요하게 unsafe 문맥도 필요해지고 포인터를 구해야 하는 코드도 넣어야 합니다.

[DllImport("Dll1.dll", EntryPoint = "GuidFunc")]
static unsafe extern void GuidFunc2(Guid* ptr);

unsafe
{
    GuidFunc2(&iUnk);
}

저렇게 하면 속도는 빨라질 수 있지만 REFIID의 ([Out]이 없는) [In] 의미와는 또 맞지 않게 됩니다. 재미있는 건, 이런 양쪽의 장/단점을 모두 해결할 수 있는 문법이 C# 7.2부터 (값 형식의 성능 개선을 목적으로) 제공되는 in 변경자입니다.

[DllImport("Dll1.dll", EntryPoint = "GuidFunc")]
static extern void GuidInFunc(in Guid ptr);

GuidInFunc(in iUnk); // 값 복사도 없고, [In] 의미도 맞고!

혹은, C# 12부터 추가된 ref readonly 변경자를 써도 됩니다.

[DllImport("Dll1.dll", EntryPoint = "GuidFunc")]
static extern void GuidRefReadonlyFunc(ref readonly Guid ptr);

GuidRefReadonlyFunc(ref iUnk);

하지만, 여기서 주의할 점은, "in" 또는 "ref readonly"의 사용이 REFIID와 의미상으로 맞는다는 것이지, 실제로 [Out] 동작을 막을 수는 없다는 점입니다. 따라서 REFIID가 아닌 일반 Guid* 포인터 인자에 사용하게 되면 해당 C/C++ 함수의 내부에서 값을 변경하는 경우 C# 측의 인자에도 그대로 반영되므로 유의해야 합니다.

(첨부 파일은 이 글의 예제 코드를 포함>합니다.)

---

[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[최초 등록일: 4/29/2024]
[최종 수정일: 4/29/2024]


이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.

by SeongTae Jeong, mailto:techsharer at outlook.com