Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
(연관된 글이 1개 있습니다.)

C# - (LSA_UNICODE_STRING 예제로) CustomMarshaler 사용법

지난 글을 통해,

C# Interop 예제 - (LSA_UNICODE_STRING 예제로) 구조체를 C++에 전달하는 방법
; https://www.sysnet.pe.kr/2/0/13203

C/C++ 측의 구조체를 Interop하는 방법을 살펴봤는데요, 그런데 해당 예제를 다르게 접근하는 것도 가능합니다. 사실, LSA_UNICODE_STRING 구조체는 엄밀히 구분하면 string의 표현 방식에 불과합니다. 따라서, 보다 더 C# 언어의 방식처럼 다룬다면 더 좋지 않을까요?

예를 들어, C#에서 LSA_UNICODE_STRING 구조체를 직접 다루기보다는 그냥 DllImprt 함수를 다음과 같은 식으로 쓰고 싶은 것입니다.

internal class Program
{
    // 지난 글에 작성한 C/C++ Struct_TestFunc 예제 함수
    [DllImport("Dll1.dll")]
    static extern int Struct_TestFunc(string value);

    static void Main(string[] args)
    {
        Struct_TestFunc("test is");
    }
}

저런 식의 표현이 가능하려면 뭐가 필요할까요? 당연히, string 타입을 LSA_UNICODE_STRING 구조체에 맞게 상호 변환할 수 있는 코드가 있어야 합니다. 하지만 string이 C/C++ 측에서 구현한 문자열의 다양한 표현 방식을 닷넷 런타임이 어떻게 알고 맞춰줄 수 있을까요?

물론, 기본적으로는 해당 변환을 닷넷 런타임은 하지 못합니다. 대신 닷넷 런타임은 인자를 넘기고/받을 때 사용자의 "변환 코드"를 수행할 수 있는 확장 모드를 제공합니다. 바로 그것이 이번 글의 주제인 CustomMarshaler입니다.

ICustomMarshaler Interface
; https://learn.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.icustommarshaler




CustomMarshaler의 구현은, 왠지 어려운 듯하지만 역할 자체가 간단하므로 직관적으로 풀어나갈 수 있습니다. 즉, 닷넷에서 네이티브로 인자를 넘길 때 직렬화하는 코드와, 네이티브에서 다시 닷넷으로 넘어갈 때의 직렬화를 적절하게 처리해 주면 되는 것입니다.

가령, 이 글에서 예를 든 LSA_UNICODE_STRING과 string 타입의 변환은 다음과 같은 사용자 정의 마샬러 코드를 작성하는 것으로 해결할 수 있습니다.

// https://www.pinvoke.net/default.aspx/advapi32/lsaopenpolicy.html

public class LSAStringMarshaler : ICustomMarshaler
{
    Hashtable myAllocated = new Hashtable();
    int _itemSize;

    public static ICustomMarshaler GetInstance(string cookie)
    {
        return new LSAStringMarshaler { _itemSize = Marshal.SizeOf(typeof(LSA_UNICODE_STRING)) };
    }

#nullable disable
    // C/C++에서 C# 측으로 인자가 반환될 때 호출되는 함수 (따라서 out, ref인 경우 호출됨)
    public object MarshalNativeToManaged(System.IntPtr pNativeData)
    {
        if (pNativeData != IntPtr.Zero)
        {
            LSA_UNICODE_STRING lus = (LSA_UNICODE_STRING)Marshal.PtrToStructure(pNativeData, typeof(LSA_UNICODE_STRING));
            return lus.ToString();
        }

        return null;
    }
#nullable restore

    // C#에서 C/C++로 인자를 넘길 때 호출되는 함수 (따라서 out을 제외하고는 ref와 일반 인자 호출에서 사용)
    public System.IntPtr MarshalManagedToNative(object ManagedObj)
    {
        LSA_UNICODE_STRING lus = new LSA_UNICODE_STRING((string)ManagedObj);
        IntPtr memory = Marshal.AllocHGlobal(_itemSize);
        myAllocated[memory] = memory;
        Marshal.StructureToPtr(lus, memory, true);

        return memory;
    }

    public void CleanUpManagedData(object ManagedObj)
    {
    }

    public int GetNativeDataSize()
    {
        return _itemSize;
    }

    public void CleanUpNativeData(System.IntPtr pNativeData)
    {
        if (myAllocated.ContainsKey(pNativeData))
        {
            myAllocated.Remove(pNativeData);

            LSA_UNICODE_STRING? lus = (LSA_UNICODE_STRING?)Marshal.PtrToStructure(pNativeData, typeof(LSA_UNICODE_STRING));
            lus?.Dispose();
            Marshal.FreeHGlobal(pNativeData);
        }
    }
}

이렇게 작성한 CustomMarshaler가 있으면, 이제 DllImport 메서드에 string을 LSAStringMarshaler를 이용해 직렬화하라는 힌트를 추가합니다.,

[DllImport("Dll1.dll")]
static extern int Struct_TestFunc([MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(LSAStringMarshaler))] string value);

끝입니다. 이제 앞으로는 C#의 string 타입으로 호출하는 것이 가능합니다.

Struct_TestFunc("test is");

오~~~ 멋지죠? ^^




혹시 ref 지정도 가능할까요?

[DllImport("Dll1.dll")]
static extern int PPStruct_TestFunc(
    [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(LSAStringMarshaler))] ref string value);

이럴 때는 원래의 C#에서 제공하는 ref처럼 동작하는 것을 가정해야 합니다. 즉, 피-호출 측에서 value에 넘겨주는 값 자체를 변경하는 것이 가능하기 때문에 위와 같은 형식을 C/C++ 언어에서 받기 위해서는 2중 포인터를 사용한 함수를 정의해야 합니다.

// 헤더
__declspec(dllexport) int PPStruct_TestFunc(PLSA_UNICODE_STRING* ptr);

// CPP
__declspec(dllexport) int PPStruct_TestFunc(LSA_UNICODE_STRING** ptr)
{
    LSA_UNICODE_STRING* pItem = *ptr;
    printf("Text: %S, Len: %d, Max: %d\n", pItem->Buffer, pItem->Length, pItem->MaximumLength);
    return 0;
}

그럼 이렇게 호출하는 것이 가능하고,

string text = "good";
PPStruct_TestFunc(ref text);

"ref"의 적용으로 인해 C/C++ 측의 함수 반환 후 관리 코드로 넘어오는 단계에서 CustomMarshaler 코드의 ICustomMarshaler.MarshalNativeToManaged 메서드가 호출돼 변화된 값을 호출 측의 변수에 적용하는 것이 가능해집니다.

실제로, C/C++ 측에서 다음과 같이 값을 바꾸면,

__declspec(dllexport) int PPStruct_TestFunc(LSA_UNICODE_STRING** ptr)
{
    LSA_UNICODE_STRING* pItem = *ptr;
    printf("Text: %S, Len: %d, Max: %d\n", pItem->Buffer, pItem->Length, pItem->MaximumLength);

    pItem->Buffer[0] = 't';
    return 0;
}

호출 측의 "text" 변숫값이 바뀌게 됩니다. 완벽하게 C# 본연의 ref 역할을 하게 된 것입니다.

string text = "good";
PPStruct_TestFunc(ref text);
Console.WriteLine(text); // 출력 결과: tood

(사실 위의 예제에서라면, 어차피 Buffer가 포인터이기 때문에 ref를 사용하지 않아도 값은 바뀝니다.)




그렇다면, 배열에도 적용할 수 있을까요?

// 지난 글에 작성한 C/C++ Struct_TestFunc 예제 함수
[DllImport("Dll1.dll")]
static extern int PStructWithLen_TestFunc(
    [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(LSAStringMarshaler))] string[] value, int length);

실제로 해보면, ICustomMarshaler.MarshalManagedToNative에서,

// 인자로 전달된 ManagedObj의 타입은 string[]

public System.IntPtr MarshalManagedToNative(object ManagedObj)
{
    LSA_UNICODE_STRING lus = new LSA_UNICODE_STRING((string)ManagedObj); // 이 단계에서 System.InvalidCastException 예외 발생
    IntPtr memory = Marshal.AllocHGlobal(_itemSize);
    myAllocated[memory] = memory;
    Marshal.StructureToPtr(lus, memory, true);

    return memory;
}

예외가 발생합니다. 이 오류를 해결할 수 있는 방법은 대충 2가지 정도로 나뉩니다. 인자인 ManagedObj가 배열인지 판정해서 그것에 맞게 마샬링을 하거나, 아니면 배열인 경우를 위해 아예 독립적인 CustomMarshaler를 만드는 것입니다. 아래의 코드는 아예 새롭게 만든 예이고,

public class LSAStringArrayMarshaler : ICustomMarshaler
{
    Hashtable myAllocated = new Hashtable();
    int _arraySize = 0;
    int _itemSize = 0;

    public static ICustomMarshaler GetInstance(string cookie)
    {
        return new LSAStringArrayMarshaler { _itemSize = Marshal.SizeOf(typeof(LSA_UNICODE_STRING)) };
    }

#nullable disable
    public object MarshalNativeToManaged(System.IntPtr pNativeData)
    {
        if (pNativeData != IntPtr.Zero)
        {
            string[] texts = new string[_arraySize];
            for (int i = 0; i < _arraySize; i++)
            {
                LSA_UNICODE_STRING lus = (LSA_UNICODE_STRING)Marshal.PtrToStructure(pNativeData, typeof(LSA_UNICODE_STRING));
                texts[i] = lus.ToString();
                pNativeData = IntPtr.Add(pNativeData, _itemSize);
            }
            return texts;
        }

        return null;
    }
#nullable restore

    public System.IntPtr MarshalManagedToNative(object ManagedObj)
    {
        string[] items = (string[])ManagedObj;
        this._arraySize = items.Length;

        IntPtr memory = Marshal.AllocHGlobal(this._itemSize * this._arraySize);
        myAllocated[memory] = memory;

        IntPtr ptr = memory;

        foreach (string item in items)
        {
            LSA_UNICODE_STRING lus = new LSA_UNICODE_STRING(item);
            Marshal.StructureToPtr(lus, ptr, false);

            ptr = IntPtr.Add(ptr, this._itemSize);
        }

        return memory;
    }

    public void CleanUpManagedData(object ManagedObj)
    {
    }

    public int GetNativeDataSize()
    {
        return this._itemSize;
    }

    public void CleanUpNativeData(System.IntPtr pNativeData)
    {
        if (myAllocated.ContainsKey(pNativeData))
        {
            myAllocated.Remove(pNativeData);

            IntPtr ptr = pNativeData;

            for (int i = 0; i < this._arraySize; i ++)
            {
                LSA_UNICODE_STRING? lus = (LSA_UNICODE_STRING?)Marshal.PtrToStructure(ptr, typeof(LSA_UNICODE_STRING));
                lus?.Dispose();

                ptr = IntPtr.Add(ptr, this._itemSize);
            }

            Marshal.FreeHGlobal(pNativeData);
        }
    }
}

따라서 배열에 대해 LSAStringArrayMarshaler를 사용하도록 지정하면,

[DllImport("Dll1.dll")]
static extern int PStructWithLen_TestFunc(
    [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(LSAStringArrayMarshaler))] string[] value, int length);

다음과 같이 호출할 수 있습니다.

string[] texts = new string[]
{
    "test is",
    "good",
};

PStructWithLen_TestFunc(texts, 2);

당연히 배열도 ref로 전달할 수 있고,

[DllImport("Dll1.dll")]
static extern int PPStructWithLen_TestFunc(
    [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(LSAStringArrayMarshaler))] ref string[] value, int length);

{
    string[] texts = new string[]
    {
        "test is",
        "good",
    };

    PPStructWithLen_TestFunc(ref texts, 2);

    Console.WriteLine(texts[0]);
    Console.WriteLine(texts[1]);
}

이를 위해서는 C/C++ 측에서도 2중 포인터를 이용한 함수를 제공해야 합니다.

// 헤더
__declspec(dllexport) int PPStructWithLen_TestFunc(PLSA_UNICODE_STRING* value, int length);

// CPP
__declspec(dllexport) int PPStructWithLen_TestFunc(LSA_UNICODE_STRING** value, int length)
{
    PLSA_UNICODE_STRING ptr = *value;

    for (int i = 0; i < length; i++) {
        printf("Text: %S, Len: %d, Max: %d\n", ptr->Buffer, ptr->Length, ptr->MaximumLength);
        ptr++;
    }

    return 0;
}

그런데 2중 포인터를 사용한 C/C++ 함수에 대해 ref 호출을 한 경우, CustomMarshaler를 이용하는 상황에서 한 가지 아쉬운 점이 있습니다. 일례로, ref이기 때문에 C/C++ 측에서 아예 새로운 개수의 LSA_UNICODE_STRING 배열을 반환하는 것도 가능할 텐데요, 문제는 ICustomMarshaler.MarshalNativeToManaged에서 그 배열의 개수를 가져올 수 있는 방법이 없다는 것입니다.

public object MarshalNativeToManaged(System.IntPtr pNativeData)
{
    if (pNativeData != IntPtr.Zero)
    {
        string[] texts = new string[_arraySize];
        for (int i = 0; i &lt; _arraySize; i++)
        {
            LSA_UNICODE_STRING lus = (LSA_UNICODE_STRING)Marshal.PtrToStructure(pNativeData, typeof(LSA_UNICODE_STRING));
            texts[i] = lus.ToString();
            pNativeData = IntPtr.Add(pNativeData, _itemSize);
        }
        return texts;
    }

    return null;
}

위의 코드에 보면, _arraySize를 사용해 배열 크기를 판단하고 있는데 이 값은 관리 코드에서 넘겨준 원본 texts 배열의 크기에 해당합니다. 게다가 MarshalNativeToManaged 메서드 자체에는 IntPtr 포인터만 넘어올 뿐, 비관리 코드에서 넘겨준 배열의 크기에 대한 정보 자체가 없습니다.

따라서, 만약 그런 경우를 원한다면 C/C++ 측과 협의를 해야 합니다. 흔히들 이런 경우 C/C++ 시절에는 배열의 마지막 요소는 null로 채워서 반환해 주는 방식을 썼는데요, 어떤 식으로든 서로 합의만 할 수 있다면 그에 따라 코딩하시면 됩니다. ^^

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




CustomMarshaler는 오직 P/Invoke의 인자에만 적용할 수 있습니다. 만약 struct 등의 필드에 적용했다면 Marshal.PtrToStructure 등의 호출에서 이런 예외를 만나게 됩니다.

System.TypeLoadException: 'Cannot marshal field '...' of type '...': Custom marshalers cannot be used on fields of structures.'




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

[연관 글]






[최초 등록일: ]
[최종 수정일: 4/15/2023]

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)
13312정성태4/8/20233150Windows: 244. Win32 - 시간 만료를 갖는 MessageBox 대화창 구현 (개선된 버전)파일 다운로드1
13311정성태4/7/20233562C/C++: 163. Visual Studio 2022 - DirectShow 예제 컴파일(WAV Dest)
13310정성태4/6/20233158C/C++: 162. Visual Studio - /NODEFAULTLIB 옵션 설정 후 수동으로 추가해야 할 library
13309정성태4/5/20233367.NET Framework: 2107. .NET 6+ FileStream의 구조 변화
13308정성태4/4/20233207스크립트: 47. 파이썬의 time.time() 실숫값을 GoLang / C#에서 사용하는 방법
13307정성태4/4/20233015.NET Framework: 2106. C# - .NET Core/5+ 환경의 Windows Forms 응용 프로그램에서 HINSTANCE 구하는 방법
13306정성태4/3/20232921Windows: 243. Win32 - 윈도우(cbWndExtra) 및 윈도우 클래스(cbClsExtra) 저장소 사용 방법
13305정성태4/1/20233171Windows: 242. Win32 - 시간 만료를 갖는 MessageBox 대화창 구현 (쉬운 버전)파일 다운로드1
13304정성태3/31/20233478VS.NET IDE: 181. Visual Studio - C/C++ 프로젝트에 application manifest 적용하는 방법
13303정성태3/30/20232807Windows: 241. 환경 변수 %PATH%에 DLL을 찾는 규칙
13302정성태3/30/20233412Windows: 240. RDP 환경에서 바뀌는 %TEMP% 디렉터리 경로
13301정성태3/29/20233525Windows: 239. C/C++ - Windows 10 Version 1607부터 지원하는 /DEPENDENTLOADFLAG 옵션파일 다운로드1
13300정성태3/28/20233229Windows: 238. Win32 - Modal UI 창에 올바른 Owner(HWND)를 설정해야 하는 이유
13299정성태3/27/20233017Windows: 237. Win32 - 모든 메시지 루프를 탈출하는 WM_QUIT 메시지
13298정성태3/27/20232930Windows: 236. Win32 - MessageBeep 소리가 안 들린다면?
13297정성태3/26/20233537Windows: 235. Win32 - Code Modal과 UI Modal
13296정성태3/25/20232942Windows: 234. IsDialogMessage와 협업하는 WM_GETDLGCODE Win32 메시지 [1]파일 다운로드1
13295정성태3/24/20233157Windows: 233. Win32 - modeless 대화창을 modal처럼 동작하게 만드는 방법파일 다운로드1
13294정성태3/22/20233373.NET Framework: 2105. LargeAddressAware 옵션이 적용된 닷넷 32비트 프로세스의 가용 메모리 - 두 번째
13293정성태3/22/20233498오류 유형: 853. dumpbin - warning LNK4048: Invalid format file; ignored
13292정성태3/21/20233433Windows: 232. C/C++ - 일반 창에도 사용 가능한 IsDialogMessage파일 다운로드1
13291정성태3/20/20233923.NET Framework: 2104. C# Windows Forms - WndProc 재정의와 IMessageFilter 사용 시의 차이점
13290정성태3/19/20233456.NET Framework: 2103. C# - 윈도우에서 기본 제공하는 FindText 대화창 사용법파일 다운로드1
13289정성태3/18/20232746Windows: 231. Win32 - 대화창 템플릿의 2진 리소스를 읽어들여 자식 윈도우를 생성하는 방법파일 다운로드1
13288정성태3/17/20232830Windows: 230. Win32 - 대화창의 DLU 단위를 pixel로 변경하는 방법파일 다운로드1
13287정성태3/16/20232995Windows: 229. Win32 - 대화창 템플릿의 2진 리소스를 읽어들여 윈도우를 직접 띄우는 방법파일 다운로드1
1  2  3  4  5  6  7  8  9  10  [11]  12  13  14  15  ...