C# - bool / BOOL / VARIANT_BOOL에 대한 Interop

아래의 Q&A를 보완/정리하면,

LPBOOL Win32 마샬링 질문이 있습니다.
; https://www.sysnet.pe.kr/3/0/5427

(Visual C++를 사용하는) 윈도우 환경의 Boolean 타입은 3가지가 있습니다.

1. BOOL (typedef int BOOL) 4바이트
2. bool(_Bool) 1바이트
3. VARIANT_BOOL (typedef short VARIANT_BOOL) 2바이트

윈도우에서 닷넷 타입의 bool을 아무런 MarshalAs 특성 정보 없이 사용하면 BOOL로 기본 마샬링 처리를 합니다.

그 외에, bool 또는 VARIANT_BOOL로 마샬링을 하고 싶다면 명시적으로 바이트 수를 MarshalAs로 지정하는 것이 권장됩니다.

기본값 (BOOL)
    [MarshalAs(UnmanagedType.Bool)]

bool 
    [MarshalAs(UnmanagedType.I1)]

VARIANT_BOOL
    [MarshalAs(UnmanagedType.I2)] 또는 [MarshalAs(UnmanagedType.VariantBool]

---

실제로 간단한 테스트를 해볼까요?

C++로 다음과 같이 코드를 마련하고,

#include "pch.h"

static bool _gBool = false;
static BOOL _gBOOL = false;
static VARIANT_BOOL _gVariantBool = VARIANT_FALSE;

__declspec(dllexport) bool __stdcall GetBool()
{
    return _gBool;
}

__declspec(dllexport) void __stdcall SetBool(bool bSet)
{
    _gBool = bSet;
}

__declspec(dllexport) BOOL __stdcall GetBOOL()
{
    return _gBOOL;
}

__declspec(dllexport) void __stdcall SetBOOL(BOOL bSet)
{
    _gBOOL = bSet;
}


__declspec(dllexport) VARIANT_BOOL __stdcall GetVARIANTBOOL()
{
    return _gVariantBool;
}

__declspec(dllexport) void __stdcall SetVARIANTBOOL(VARIANT_BOOL bSet)
{
    _gVariantBool = bSet;
}

C#에서 이렇게 사용할 수 있습니다.

#define USE_MARSHALAS

using System;
using System.Runtime.InteropServices;

class Program
{
    [DllImport("Dll1.dll")]
#if USE_MARSHALAS
    [return: MarshalAs(UnmanagedType.I1)]
#endif
    extern static bool GetBool();

    [DllImport("Dll1.dll")]
    extern static void SetBool(
#if USE_MARSHALAS
        [MarshalAs(UnmanagedType.I1)]
#endif
    bool bSet);

    [DllImport("Dll1.dll")]
    extern static bool GetBOOL();

    [DllImport("Dll1.dll")]
    extern static void SetBOOL(bool bSet);

    [DllImport("Dll1.dll")]
#if USE_MARSHALAS
    [return: MarshalAs(UnmanagedType.VariantBool)]
#endif
    extern static bool GetVARIANTBOOL();

    [DllImport("Dll1.dll")]
    extern static void SetVARIANTBOOL(
#if USE_MARSHALAS
        [MarshalAs(UnmanagedType.VariantBool)]
#endif
    bool bSet);

    static void Main(string[] args)
    {
        {
            SetBool(true);
            Console.WriteLine(GetBool());

            SetBool(false);
            Console.WriteLine(GetBool());

            SetBool(true);
            Console.WriteLine(GetBool());
        }
        
        Console.WriteLine();

        {
            SetBOOL(true);
            Console.WriteLine(GetBOOL());

            SetBOOL(false);
            Console.WriteLine(GetBOOL());

            SetBOOL(true);
            Console.WriteLine(GetBOOL());
        }

        Console.WriteLine();

        {
            SetVARIANTBOOL(true);
            Console.WriteLine(GetVARIANTBOOL());

            SetVARIANTBOOL(false);
            Console.WriteLine(GetVARIANTBOOL());

            SetVARIANTBOOL(true);
            Console.WriteLine(GetVARIANTBOOL());
        }
    }
}

/* 출력 결과
True
False
True

True
False
True

True
False
True
*/

그런데, 위의 코드에서 USE_MARSHALAS 전처리 지시자를 빼고 실행해도 출력 결과는 같습니다. 왜냐하면, 기본 4바이트 BOOL 마샬링을 해도 bool, VARIANT_BOOL인 경우 어차피 4바이트 레지스터 또는 스택에 값을 4바이트로 (Visual C++는) 채워 넣기 때문입니다.

실제로 Visual C++는 bool 1바이트를 return 문에 사용해도 다음과 같이,

movzx ax, byte ptr [_gBool]

movzx 명령어를 이용해 ax 레지스터 전체에 값을 채우는 코드로 번역해 줍니다. 따라서, 만약 C++ 컴파일러가 다르거나 어떤 식으로든 최적화에 따라 저 명령어가 다음과 같이 바뀌게 된다면,

mov al, byte ptr [_gBool]

이제 ax 레지스터 중 상위 3바이트는 쓰레기 값으로 채워지고 하위 1바이트만 1 또는 0의 값을 담기 때문에 이렇게 되면 C#의 기본 4바이트 마샬링에서 적절하지 않은 변환을 하게 됩니다. (따라서, 대개의 경우 정상동작은 하지만 MarshalAs 사용을 권장합니다.)

---

그 외에도, 기본 마샬링 동작에 의존해서는 안 되는 경우가 바로 사용자 정의 타입의 멤버로 bool/BOOL/VARIANT_BOOL이 사용될 때입니다.

만약 bool/BOOL/VARIANT_BOOL 멤버를 포함한 C++의 구조체를,

#pragma pack(push, 1)
typedef struct tagUserDefinedBool
{
    BOOL b1;
    bool b2;
    VARIANT_BOOL b3;
} UserDefinedBool;
#pragma pack(pop)

C#에서 MarshalAs 없이 정의하게 되면,

[StructLayout(LayoutKind.Sequential, Pack = 1)]
public struct UserDefinedBool
{
    public bool b1;
    public bool b2;
    public bool b3;

    public override string ToString()
    {
        return $"{b1}, {b2}, {b3}";
    }
}

바이트 크기 문제로 간섭이 발생합니다. 왜냐하면 C/C++의 경우 4바이트, 1바이트, 2바이트로 채워져 있는 공간을 C#에서 4바이트, 4바이트, 4바이트로 다루기 때문에 서로의 값에 영향을 주게 되는 것입니다. 일례로 MarshalAs 없이 정의된 위의 UserDefinedBool 구조체를 C/C++과 함께 사용하면,

{
    UserDefinedBool udb = new UserDefinedBool();
    udb.b1 = false;
    udb.b2 = false;
    udb.b3 = true;
    SetUserDefinedBool(udb); // C++ DllImport 함수

    GetUserDefinedBool(out udb); // C++ DllImport 함수
    Console.WriteLine(udb); // 출력 결과 False, False, False
}

의도한 "False, False, True"가 안 나오고 false, false, false로 다뤄지는 것을 볼 수 있습니다. 따라서 이런 경우에는 반드시 MarshalAs를 지정해야만,

[StructLayout(LayoutKind.Sequential, Pack = 1)]
public struct UserDefinedBool
{
    [MarshalAs(UnmanagedType.Bool)] /* 생략 가능 */
    public bool b1;
    [MarshalAs(UnmanagedType.I1)]
    public bool b2;
    [MarshalAs(UnmanagedType.VariantBool)]
    public bool b3;

    public override string ToString()
    {
        return $"{b1}, {b2}, {b3}";
    }
}

정상적인 실행 결과가 나옵니다.

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

---

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

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


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

by SeongTae Jeong, mailto:techsharer at outlook.com