C#에서 Union 구조체 다루기
가끔 고객사의 질문이 재미있는 경우가 있습니다.
CallbackOnCollectedDelegate was detected
; https://www.sysnet.pe.kr/2/0/710
이번에도 위의 ^^ C/C++ 관련 질문을 했던 그 고객사에서 질문을 해왔는데요. C/C++의 Union 구조체를 C#에서 만들어서 Win32 DLL 함수에 전달해야 하는데, 이 과정에서 오류가 발생한다는 것이었습니다. 고객사로부터 전달되어진 코드는 다음과 같습니다.
[StructLayoutAttribute(LayoutKind.Explicit)]
public struct InvalidUnionStruct
{
[FieldOffsetAttribute(0)]
public uint uintValue;
[FieldOffsetAttribute(0)]
[MarshalAs(UnmanagedType.ByValArray, SizeConst = 10, ArraySubType = UnmanagedType.U2)]
public ushort [] ushortArrays;
}
static void Main(string[] args)
{
InvalidUnionStruct union = new InvalidUnionStruct(); // 실행시키기 전에 오류 발생
}
오류 메시지는 다음과 같습니다.
An unhandled exception of type 'System.TypeLoadException' occurred in Unknown Module.
Additional information: Could not load type 'InteropTest.InvalidUnionStruct' from assembly 'InteropTest, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null' because it contains an object field at offset 0 that is incorrectly aligned or overlapped by a non-object field.
무슨 오류인지 대강 설명이 되지요. managed에서의 배열은 참조형이기 때문에 정상적으로 union 데이터 정렬에 맞춰질 수 없습니다. 단지, 오류가 나는 상황이 재미있는데 InvalidUnionStruct 구조체를 사용하기도 전에 Main 메서드가 JIT 컴파일되는 순간에 오류가 발생합니다.
문제 해결은 다음의 글에서 설명하는 것처럼 간단합니다.
Arrays inside of structures
; https://learn.microsoft.com/en-us/archive/blogs/ericgu/arrays-inside-of-structures
결국, C# 2.0부터 struct 멤버에 fixed 배열 선언이 가능해졌기 때문에 아래와 같이 수정을 하면 정상적으로 빌드할 수 있습니다.
[StructLayoutAttribute(LayoutKind.Explicit)]
public unsafe struct UnionStruct
{
[FieldOffsetAttribute(0)] public uint uintValue;
[FieldOffsetAttribute(0)] public fixed ushort ushortArrays[10];
}
위와 같이 답변을 해주었는데, 또다시 메일이 왔습니다. 이번에는 그렇게 설정된 union 구조에 값을 넣고 Win32 DLL 함수에 전달하려는 데 다음과 같은 오류가 발생한다는 것이었습니다.
An unhandled exception of type 'System.TypeLoadException' occurred in InteropTest.exe
Additional information: Cannot marshal field 'ushortArrays' of type 'InteropTest.UnionStruct': Invalid managed/unmanaged type combination (this value type must be paired with Struct).
'InteropTest.UnionStruct' 형식의 'ushortArrays' 필드를 마샬링할 수 없습니다. 이 필드의 형식 정의에 레이아웃 정보가 있지만 관리되는/관리되지 않는 형식 조합이 잘못되었거나, 형식 정의를 마샬링할 수 없습니다.
보내온 코드는 다음과 같습니다.
[StructLayoutAttribute(LayoutKind.Explicit)]
public unsafe struct UnionStruct
{
[FieldOffsetAttribute(0)] public uint uintValue;
[MarshalAsAttribute(UnmanagedType.ByValArray, SizeConst = 7, ArraySubType = UnmanagedType.I2)]
[FieldOffsetAttribute(0)]
public fixed ushort ushortArrays[10];
}
오류가 발생할 수밖에 없습니다. fixed 배열을 선언했기 때문에 더 이상 MarshalAs로 지정해서는 안되기 때문입니다. 즉, "Invalid managed/unmanaged type combination"라는 메시지가 지적하고 있는 내용입니다. 물론, MarshalAs 특성을 제거하면 오류는 더 이상 발생하지 않습니다.
몇 가지 재미있는 팁을 더 알려드리자면.
이렇게 fixed를 포함하는 구조체의 크기를 구하려면 다음과 같이 2가지 방식을 사용할 수 있습니다.
UnionStruct item = new UnionStruct();
item.uintValue = 5;
int marshalSize;
// 첫 번째 방식: unsafe 문맥 안에서 sizeof 호출
unsafe
{
marshalSize = sizeof(UnionStruct);
}
// 두 번째 방식: Marshal.SizeOf를 사용하여 인스턴스의 크기를 반환
int marshalSize = Marshal.SizeOf(item);
fixed로 지정된 배열의 크기에 따라 위의 2가지 방식에서 속도 차이가 확연하게 납니다.
10개
첫 번째 방식: 18
두 번째 방식: 65
100000개
첫 번째 방식: 18
두 번째 방식: 2607
* Stopwatch 사용
아시겠지요? 첫 번째 방식은 타입 정보에 있는 것을 가져오는 정도로 끝나지만 두 번째 방식은 런타임 시에 해당 인스턴스의 메모리 구조를 열람하면서 크기를 구하는 것입니다. (비록 첫 번째 방식이 빠르긴 하지만 상황에 따라서는 반드시 두 번째 방식을 써야할 때도 있습니다.)
구조체를 Win32 DLL에서 export하고 있는 함수에 넘겨주는 방법도 2가지입니다. (사실, 코드를 꼬는 방법에 따라서 더 다양해질 수 있지만.)
예를 들어, 위의 구조체를 전달받는 C/C++ API의 signature가 다음과 같은 경우,
__declspec(dllexport) int fnInteropWin32(UnionStruct *Struct);
간단하게 DllImport에 ref 키워드를 사용해서 전달하는 방법과,
[DllImport("InteropWin32.dll")]
public static extern int fnInteropWin32(ref UnionStruct Struct);
UnionStruct item = new UnionStruct();
item.uintValue = 5;
fnInteropWin32(ref item)
ref 참조 전달 방식이 아닌 IntPtr로 전달하는 것도 가능합니다.
[DllImport("InteropWin32.dll")]
public static extern int fnInteropWin32(IntPtr pStruct);
UnionStruct item = new UnionStruct();
item.uintValue = 5;
int marshalSize;
unsafe
{
marshalSize = sizeof(UnionStruct);
}
IntPtr pStruct = Marshal.AllocCoTaskMem(marshalSize);
Marshal.StructureToPtr(item, pStruct, false);
fnInteropWin32(pStruct);
Marshal.FreeCoTaskMem(pStruct);
이때 주의할 점은, 반드시 AllocCoTaskMem으로 할당한 메모리를 FreeCoTaskMem으로 풀어주어야 한다는 것입니다. (말할 필요도 없겠지만, 그렇지 않은 경우 메모리 누수 현상이 발생합니다.)
어느 방법을 선호할지는 개인 취향이겠지만, 당연히 ref를 이용한 참조 전달이 바람직하겠습니다. 물론 Interop이 매우 복잡한 경우에는 IntPtr로 구성해야 하는 경우도 생길 수도 있겠지만.
*
첨부된 솔루션 파일은 위의 사항을 테스트해볼 수 있는 C/C++ 프로젝트와 C# 프로젝트가 포함되어 있습니다.
[이 토픽에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]