C# PInvoke - C++의 매개변수에 대한 마샬링을 tlbexp.exe를 이용해 확인하는 방법
예전에, C# DLL -> TLB -> CPP 헤더 파일로 변환하는 방법을 설명했었는데요,
C# DLL로부터 TLB 및 C/C++ 헤더 파일(TLH)을 생성하는 방법
; https://www.sysnet.pe.kr/2/0/12220
우연히 다음의 글을 읽으면서,
The confusing UnmanagedType.LPStruct marshaling directive
; https://learn.microsoft.com/en-us/archive/blogs/adam_nathan/the-confusing-unmanagedtype-lpstruct-marshaling-directive
Note that the type library exporter (TLBEXP.EXE) is a great tool for statically understanding how managed parameters/fields/return types get marshaled, since the signatures created by the exporter are required to match what the marshaler does at run-time. Even if you're wondering about the parameters of a PInvoke method, you can do this trick by temporarily pasting the method into a public interface (removing the "static", "extern", etc.) then running TLBEXP.EXE on your assembly.
C# 메서드의 매개변수가 어떻게 C++ 함수에 대응하는지 쉽게 파악하는 도구로도 사용될 수 있다는 것을 깨달았습니다. ^^; 가령, 만약에 여러분이 호출해야 할 C++의 함수와 그것의 인자에 들어가는 구조체를 보고,
struct MyStruct
{
int Age;
char* ptrName;
char* ptrAddr;
char Name[80];
};
__declspec(dllexport) void __stdcall TestMethod(MyStruct* pAttr);
다음과 같이 C# 코드로 맞췄다고 가정해 보겠습니다.
public struct MyStruct
{
public int Age;
public IntPtr ptrName;
public IntPtr ptrAddr;
public char[] Name;
}
public class Test
{
[DllImport("test.dll")]
static extern void TestMethod(ref MyStruct pAttr);
}
이때 저 함수와 구조체의 정의가 실제로 C++의 것과 일치하는지 직접 확인하고 싶다면 tlbexp.exe를 이용할 수 있습니다. 실습을 위해 간단한 더미 C# DLL 프로젝트를 하나 만들고, 그 안에 위의 코드를 복사해 interface를 구성한 후,
using System;
using System.Runtime.InteropServices;
[assembly: ComVisible(true)]
namespace ClassLibrary1
{
public struct MyStruct
{
public int Age;
public IntPtr ptrName;
public IntPtr ptrAddr;
public char[] Name;
}
[Guid("2AFBAFEE-68A9-4EF8-A38C-A7941D47CC16")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IMyInteropTest
{
[DispId(1)]
void TestMethod(ref MyStruct pAttr);
}
}
빌드 결과물인 DLL을
tlbexp.exe에 넘기면 Type Library(tlb) 파일이 생성됩니다.
C:\temp> tlbexp ClassLibrary1.dll
마지막으로 tlb 파일을
oleview.exe를 이용해 C++로 번역된 결과를 볼 수 있습니다.
[
uuid(B833A7ED-D142-4FDA-9474-6C536851852B),
version(1.0),
custom(90883F05-3D28-11D2-8F17-00A0C9A6186D, "ClassLibrary1, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null")
]
library ClassLibrary1
{
importlib("stdole2.tlb");
interface IMyInteropTest;
typedef [uuid(F2947813-305C-3BB1-BA28-FCD9B7A01162), version(1.0) ,
custom(0F21F359-AB84-41E8-9A78-36D110E6D2F9, "ClassLibrary1.MyStruct")
]
struct tagMyStruct {
long Age;
long ptrName;
long ptrAddr;
SAFEARRAY(unsigned char) Name;
} MyStruct;
[
odl,
uuid(2AFBAFEE-68A9-4EF8-A38C-A7941D47CC16),
version(1.0),
oleautomation,
custom(0F21F359-AB84-41E8-9A78-36D110E6D2F9, "ClassLibrary1.IMyInteropTest")
]
interface IMyInteropTest : IUnknown {
HRESULT _stdcall TestMethod([in, out] MyStruct* pAttribute);
};
};
"ref MyStruct"는 "MyStruct*"로 대응했으니 원했던 바이고, IntPtr 타입이 long 형으로 변환된 것은 C# DLL을 "Any CPU" 또는 "x86" 대상으로 빌드를 했기 때문입니다. 만약 C# DLL을 "x64" 대상으로 빌드하면 다음과 같이 tagMyStruct의 ptrName, ptrAddr 필드가 int64로 바뀝니다. (Native라는 C++의 환경을 고려하면 IntPtr이 저렇게 변경되는 것은 당연합니다.)
struct tagMyStruct {
long Age;
int64 ptrName;
int64 ptrAddr;
SAFEARRAY(unsigned char) Name;
} MyStruct;
그나저나 char [] 타입이 기대했던 데로 되지 않았다는 것을 알 수 있습니다. 따라서 바꿔야 할 텐데요, MarshalAs 특성을 이용해 좀 더 정보를 줘야 하는데, 예를 들어 이렇게 (잘못된) 설정을 해보겠습니다.
public struct MyStruct
{
public int Age;
public IntPtr ptrName;
public IntPtr ptrAddr;
[MarshalAs(UnmanagedType.LPStr, SizeConst = 80)]
public char[] Name;
}
이후 빌드하고 TLB를 생성하기 위해 tlbexp.exe를 실행하면 다음과 같은 경고를 볼 수 있습니다.
C:\temp\ClassLibrary1\ClassLibrary1\bin\Debug> tlbexp ClassLibrary1.dll
Microsoft (R) .NET Framework Assembly to Type Library Converter 4.8.4084.0
Copyright (C) Microsoft Corporation. All rights reserved.
TlbExp : warning TX00131175 : When cross-compiling, all type library references should be included on the command line to ensure the correct bit-specific type libraries are loaded.
TlbExp : warning TX801311A6 : Type library exporter warning processing 'ClassLibrary1.MyStruct.Name, ClassLibrary1'. Warning: The method or field has an invalid managed/unmanaged type combination, check the MarshalAs directive.
Assembly exported to 'C:\temp\ClassLibrary1\ClassLibrary1\bin\Debug\ClassLibrary1.tlb'
경고라고 해서 무시하면 안 되는데, 실제로 생성된 tlb를 oleview에서 보면 아예 Name 필드가 누락된 확인할 수 있습니다.
struct tagMyStruct {
long Age;
int64 ptrName;
int64 ptrAddr;
} MyStruct;
즉, "The method or field has an invalid managed/unmanaged type combination, check the MarshalAs directive." 오류는 적절하지 않은 조합으로 MarshalAs 특성 값이 사용돼 해당 필드의 타입을 결정할 수 없게 만든 것입니다. (사실 이러면 ^^; 에러여야 하는데.)
자, 그럼 다시 올바르게 수정해 볼까요?
public struct MyStruct
{
public int Age;
public IntPtr ptrName;
public IntPtr ptrAddr;
[MarshalAs(UnmanagedType.ByValArray, /* 생략 가능 */ ArraySubType = UnmanagedType.I1, SizeConst = 80)]
public char[] Name;
}
tlbexp + oleview를 통해 확인까지 하고,
struct tagMyStruct {
long Age;
int64 ptrName;
int64 ptrAddr;
unsigned char Name[80];
} MyStruct;
따라서 C++ 코드와의 interop이 기대했던 대로 동작할 거라는 것을 예상할 수 있습니다.
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]