Microsoft MVP성태의 닷넷 이야기
.NET Framework: 978. C# - GUID 타입 전용의 UnmanagedType.LPStruct [링크 복사], [링크+제목 복사]
조회: 839
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일

C# - GUID 타입 전용의 UnmanagedType.LPStruct

LPStruct 옵션에 대한 좋은 글이 있군요. ^^

The confusing UnmanagedType.LPStruct marshaling directive
; https://docs.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://docs.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://docs.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라고 해도 다른 구조체의 멤버로 있을 때는 예외가 발생합니다.




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

[연관 글]


donaricano-btn



[최초 등록일: ]
[최종 수정일: 12/9/2020 ]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 쓴 사람
 




[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
12641정성태5/13/202133디버깅 기술: 179. 윈도우 용 .NET Core 3 이상에서 Windbg의 sos 사용법
12640정성태5/13/202114오류 유형: 716. RDP 연결 - Because of a protocol error (code: 0x112f), the remote session will be disconnected.
12639정성태5/12/202115오류 유형: 715. Arduino: Open Serial Monitor - The module '...\detection.node' was compiled against a different Node.js version using NODE_MODULE_VERSION
12638정성태5/12/202132사물인터넷: 63. NodeMCU v1 ESP8266 - 펌웨어 내 파일 시스템(SPIFFS, LittleFS) 및 EEPROM 활용
12637정성태5/10/202132사물인터넷: 62. NodeMCU v1 ESP8266 보드의 A0 핀에 다중 아날로그 센서 연결
12636정성태5/10/202147사물인터넷: 61. NodeMCU v1 ESP8266 보드의 A0 핀 사용법 - FSR-402 아날로그 압력 센서 연동파일 다운로드1
12635정성태5/9/202158기타: 81. OpenTabletDriver를 (관리자 권한으로 실행하지 않고도) 관리자 권한의 프로그램에서 동작하게 만드는 방법
12634정성태5/9/202161개발 환경 구성: 572. .NET에서의 신뢰도 등급 조정 - 외부 Manifest 파일을 두는 방법파일 다운로드1
12633정성태5/7/202191개발 환경 구성: 571. UAC - 관리자 권한 없이 UIPI 제약을 없애는 방법
12632정성태5/8/202193기타: 80. (WACOM도 지원하는) Tablet 공통 디바이스 드라이버 - OpenTabletDriver
12631정성태5/7/2021103사물인터넷: 60. ThingSpeak 사물인터넷 플랫폼에 ESP8266 NodeMCU v1 + 조도 센서 장비 연동파일 다운로드1
12630정성태5/12/202178사물인터넷: 59. NodeMCU v1 ESP8266 보드의 A0 핀 사용법 - CdS Cell(GL3526) 조도 센서 연동파일 다운로드1
12629정성태5/5/2021164.NET Framework: 1057. C# - CoAP 서버 및 클라이언트 제작 (UDP 소켓 통신)파일 다운로드1
12628정성태5/4/202146Linux: 39. Eclipse 원격 디버깅 - Cannot run program "gdb": Launching failed
12627정성태5/4/202150Linux: 38. 라즈베리 파이 제로 용 프로그램 개발을 위한 Eclipse C/C++ 윈도우 환경 설정
12626정성태5/14/202172.NET Framework: 1056. C# - Thread.Suspend 호출 시 응용 프로그램 hang 현상 (2)파일 다운로드1
12625정성태5/3/202142오류 유형: 714. error CS5001: Program does not contain a static 'Main' method suitable for an entry point
12624정성태5/3/2021262.NET Framework: 1055. C# - struct/class가 스택/힙에 할당되는 사례 정리 [6]파일 다운로드1
12623정성태5/2/2021130.NET Framework: 1054. C# 9 최상위 문에 STAThread 사용파일 다운로드1
12622정성태5/3/202143오류 유형: 713. XSD 파일을 포함한 프로젝트 - The type or namespace name 'TypedTableBase<>' does not exist in the namespace 'System.Data'
12621정성태5/1/2021154.NET Framework: 1053. C# - 특정 레지스트리 변경 시 알림을 받는 방법파일 다운로드1
12620정성태5/3/2021367.NET Framework: 1052. C# - 왜 구조체는 16 바이트의 크기가 적합한가? [1]파일 다운로드1
12619정성태4/29/2021316.NET Framework: 1051. C# - 구조체의 크기가 16바이트가 넘어가면 힙에 할당된다? [1]파일 다운로드1
12618정성태5/12/2021113사물인터넷: 58. NodeMCU v1 ESP8266 CP2102 Module을 이용한 WiFi UDP 통신파일 다운로드1
12617정성태4/26/202169.NET Framework: 1050. C# - ETW EventListener의 Keywords 별 EventId에 따른 필터링 방법파일 다운로드1
[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...