Microsoft MVP성태의 닷넷 이야기
.NET Framework: 978. C# - GUID 타입 전용의 UnmanagedType.LPStruct [링크 복사], [링크+제목 복사]
조회: 977
글쓴 사람
정성태 (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)
12383정성태11/22/20201445.NET Framework: 956. C# 9.0 - (7) 패턴 일치 개선 사항(Pattern matching enhancements) [1]파일 다운로드1
12382정성태11/13/20201076오류 유형: 671. dotnet build - The local source '...' doesn't exist
12381정성태10/26/20201212VC++: 137. C++ stl map의 사용자 정의 타입을 key로 사용하는 방법파일 다운로드1
12380정성태10/26/2020850오류 유형: 670. Visual Studio - Squash_FailureCommitsReset
12379정성태10/26/20201342.NET Framework: 955. .NET 메서드의 Signature 바이트 코드 분석파일 다운로드2
12378정성태10/20/20201392.NET Framework: 954. C# - x86/x64 환경에 따라 달라지는 P/Invoke 함수의 export 이름파일 다운로드1
12377정성태10/29/20201451디버깅 기술: 172. windbg - 파일 열기 시점에 bp를 걸어 파일명 알아내는 방법(Managed/Unmanaged)
12376정성태10/15/20201195오류 유형: 669. windbg - sos의 name2ee 명령어 실행 시 "Failed to request module list." 오류
12375정성태10/15/20201530Windows: 177. 윈도우 탐색기에서 띄우는 cmd.exe 창의 디렉터리 구분 문자가 'Yen(&#0165;)' 기호로 나오는 경우 [1]
12374정성태11/22/20201887.NET Framework: 953. C# 9.0 - (6) 함수 포인터(Function pointers) [1]파일 다운로드2
12373정성태10/14/20201067.NET Framework: 952. OpCodes.Box와 관련해 IL 형식으로 직접 코딩 시 유의할 점
12372정성태11/22/20201635.NET Framework: 951. C# 9.0 - (5) 로컬 함수에 특성 지정 가능(Attributes on local functions)파일 다운로드1
12371정성태10/13/20201150개발 환경 구성: 519. Visual Studio의 Ctrl+Shift+U (Edit.MakeUppercase) 단축키가 동작하지 않는 경우
12370정성태5/6/20211334Linux: 33. Linux - nmcli를 이용한 고정 IP 설정
12369정성태10/21/20202472Windows: 176. Raymond Chen이 한글날에 밝히는 윈도우의 한글 자모 분리 현상 [1]
12368정성태10/12/20201271오류 유형: 668. VSIX 확장 빌드 - The "GetDeploymentPathFromVsixManifest" task failed unexpectedly.
12367정성태10/12/20202190오류 유형: 667. Ubuntu - Temporary failure resolving 'kr.archive.ubuntu.com'
12366정성태11/22/20201547.NET Framework: 950. C# 9.0 - (4) 원시 크기 정수(Native ints) [1]파일 다운로드1
12365정성태11/22/20201395.NET Framework: 949. C# 9.0 - (3) 람다 메서드의 매개 변수 무시(Lambda discard parameters)파일 다운로드1
12364정성태11/22/20201659.NET Framework: 948. C# 9.0 - (2) localsinit 플래그 내보내기 무시(Suppress emitting localsinit flag)파일 다운로드1
12363정성태11/22/20202034.NET Framework: 947. C# 9.0 - (1) 대상으로 형식화된 new 식(Target-typed new expressions) [2]파일 다운로드1
12362정성태10/11/20201125VS.NET IDE: 151. Visual Studio 2019에 .NET 5 rc/preview 적용하는 방법
12361정성태10/19/20201668.NET Framework: 946. C# 9.0을 위한 개발 환경 구성
12360정성태10/8/2020945오류 유형: 666. The type or namespace name '...' does not exist in the namespace 'Microsoft.VisualStudio.TestTools' (are you missing an assembly reference?)
12359정성태10/7/20201162오류 유형: 665. Windows - 재부팅 후 iSCSI 연결이 끊기는 문제
12358정성태10/7/20201060오류 유형: 664. Web Deploy 설치 시 "A newer version of Microsoft Web Deploy 3.6 was found on this machine." 오류
1  2  3  4  5  6  7  8  9  10  11  12  [13]  14  15  ...