.NET Profiler - IMetaDataEmit2::DefineMethodSpec 사용법
이해를 돕기 위해 예를 하나 들어 볼까요? 가령 다음과 같은 프로그램이 있을 때,
namespace ConsoleApp1;
internal class Program
{
static void Main(string[] args)
{
Program pg = new Program();
TestClass.InvokeLocalGeneric(pg);
TestClass.InvokeLocalGeneric("TEST");
}
}
public class TestClass
{
public static void InvokeLocalGeneric<T>(T obj)
{
// ...[생략: 사용자 코드]...
}
}
Profiler가 InvokeLocalGeneric을 가로채 별도로 정의한 .NET DLL의 메서드를 호출하도록 만들고 싶은 건데요, 만약 .NET DLL 측의 메서드 정의가 다음과 같이 돼 있다고 가정하면,
namespace ClassLibrary1;
public class Class1
{
public static void InvokeMyMethod(object obj)
{
Console.WriteLine(obj);
}
}
우리는 가로채고 싶은 InvokeLocalGeneric에 다음과 같은 식으로 코드를 추가해 주면 됩니다.
public class TestClass
{
public static void InvokeLocalGeneric<T>(T obj)
{
ldarg.0
box !!T // 제네릭 인자를 object로 박싱
call void [ClassLibrary1]ClassLibrary1.Class1::InvokeMyMethod(object)
// ...[생략: 사용자 코드]...
}
}
그런데, 만약 generic 인자 그대로 받고 싶다면 어떻게 해야 할까요? 즉, 다음과 같은 메서드로 호출을 하고 싶은 건데요,
namespace ClassLibrary1;
public class Class1
{
public static void InvokeMyGeneric<T>(T obj)
{
Console.WriteLine(obj);
}
}
이를 위해 추가해야 할 IL 코드는 생각보다 단순합니다. object에 전달하는 것이 아니므로 box 연산자도 필요 없어 단순히 "ldarg.0" 코드만으로 끝입니다.
public class TestClass
{
public static void InvokeLocalGeneric<T>(T obj)
{
ldarg.0
call void [ClassLibrary1]ClassLibrary1.Class1::InvokeMyGeneric(!!T)
// ...[생략: 사용자 코드]...
}
}
그런데, 단순히 저렇게 처리하고 실행하면 (개인적으로 정말 만나고 싶지 않은) InvalidProgramException 예외가 발생합니다.
System.InvalidProgramException: Common Language Runtime detected an invalid program.
이유가 뭘까요? ^^ 아마도, 뭔가 메타데이터 정의를 더 해야 하는 듯한데 뭐가 바뀌는 것인지 알아내야만 합니다.
이를 위해 유용한 도구가 mdv입니다.
dotnet/metadata-tools
; https://github.com/dotnet/metadata-tools
mdv로 Generic 인자 관련한 테스트를 해본 결과, 제네릭 인자에 전달하는 타입마다 그에 해당하는 MethodSpec을 함께 정의해야 한다는 규칙이 나왔습니다. 예를 들어, 다음과 같은 제네릭 메서드가 있을 때,
static void Invoke<T>(T obj);
T 인자에 대해 다음과 같이 다양한 타입으로 호출을 하게 되면,
string text = "TEST";
Invoke(text); // 제네릭 매개변수에 string 타입 전달
object obj = new object();
Invoke(obj); // 제네릭 매개변수에 object 타입 전달
int n = 50;
Invoke(n); // 제네릭 매개변수에 Int32 타입 전달
Program pg = new Program();
Invoke(pg); // 제네릭 매개변수에 ConsoleApp2.Program 전달
저 호출마다 MethdoSpec 메타데이터가 개별적으로 추가가 되는 것을 볼 수 있습니다.
TypeDef (0x02):
======================================================================================================================================================================================
Name Namespace EnclosingType BaseType Interfaces Fields Methods Attributes ClassSize PackingSize
======================================================================================================================================================================================
1: '<Module>' (#d) nil nil (TypeDef) nil (TypeDef) nil nil nil 0 n/a n/a
2: 'Program' (#1b5) 'ConsoleApp2' (#1) nil (TypeDef) 0x0100000f (TypeRef) nil nil 0x06000001-0x06000003 0x00100000 (BeforeFieldInit) n/a n/a
Method (0x06, 0x1C):
====================================================================================================================================================================================================================================================
Name Signature RVA Parameters GenericParameters Attributes ImplAttributes ImportAttributes ImportName ImportModule
====================================================================================================================================================================================================================================================
1: 'Main' (#1c4) void (string[]) (#3c) 0x00002050 0x08000001-0x08000001 nil 0x00000091 (PrivateScope, Private, Static, HideBySig) 0 0 nil nil (ModuleRef)
2: 'Invoke' (#18) void (!!0) (#42) 0x0000208F 0x08000002-0x08000002 0x2a000001-0x2a000001 0x00000091 (PrivateScope, Private, Static, HideBySig) 0 0 nil nil (ModuleRef)
3: '.ctor' (#1db) void () (#6) 0x00002092 nil nil 0x00001886 (PrivateScope, Public, HideBySig, SpecialName, RTSpecialName) 0 0 nil nil (ModuleRef)
MethodSpec (0x2b):
========================================
Method Signature
========================================
1: 0x06000002 (MethodDef) string (#22)
2: 0x06000002 (MethodDef) object (#26)
3: 0x06000002 (MethodDef) int32 (#2a)
4: 0x06000002 (MethodDef) ConsoleApp2.Program (#2e)
#Blob (size = 264):
...[생략]...
22 (MethodSpec): 0A-01-0E
26 (MethodSpec): 0A-01-1C
2a (MethodSpec): 0A-01-08
2e (MethodSpec): 0A-01-12-08
...[생략]...
추가된 MethodSpec의 #Blob 데이터는 다음과 같이 해석할 수 있습니다.
0A-01-0E
// 0A == IMAGE_CEE_CS_CALLCONV_GENERICINST
// 01 == # of generic args
// 0E == ELEMENT_TYPE_STRING
0A-01-1C
// 0A == IMAGE_CEE_CS_CALLCONV_GENERICINST
// 01 == # of generic args
// 1C == ELEMENT_TYPE_OBJECT
0A-01-08
// 0A == IMAGE_CEE_CS_CALLCONV_GENERICINST
// 01 == # of generic args
// 08 == ELEMENT_TYPE_I4
0A-01-12-08
// 0A == IMAGE_CEE_CS_CALLCONV_GENERICINST
// 01 == # of generic args
// 12 == ELEMENT_TYPE_CLASS
// 08 == ConsoleApp2.Program 타입인 0x02000002에 대한 compressed token 표현
그러니까, 제네릭 메서드의 호출에 대한 인자 대응을 signature로 표현해 MethodSpec으로 등록해 줘야 하는 것입니다.
MethodSpec의 등록은 Profiler에서 (당연히 제네릭을 지원하기 시작한) .NET Framework 2.0부터 제공하는 IMetaDataEmit2 인터페이스에 구현하고 있습니다.
IMetaDataEmit2 Interface
; https://learn.microsoft.com/en-us/dotnet/framework/unmanaged-api/metadata/imetadataemit2-interface
제공하는 함수 중 DefineMethodSpec이 바로 신규 MethodSpec을 등록하는 기능을 제공하는데요, 처음 우리가 작성했던 예제의 경우라면,
public class TestClass
{
public static void InvokeLocalGeneric<T>(T obj)
{
ldarg.0
call void [ClassLibrary1]ClassLibrary1.Class1::InvokeMyGeneric(!!T)
// ...[생략: 사용자 코드]...
}
}
InvokeMyGeneric의 !!T에 호출 측의 메서드인 InvokeLocalGeneric 측에서 정의된 T 인자를 그대로 전달받는 것이기 때문에 MethodSpec에 연결할 호출 signature는 다음과 같이 정의할 수 있습니다.
0A-01-1E-00
// 0A == IMAGE_CEE_CS_CALLCONV_GENERICINST
// 01 == # of generic args
// 1E == ELEMENT_TYPE_MVAR
// 00 == 메서드의 첫 번째 제네릭 인자
따라서 DefineMethodSpec을 호출할 때는 다음과 같이 signature와 함께 제네릭 메서드의 토큰 값을 함께 전달하면,
vector<BYTE> signatures;
signatures.push_back(IMAGE_CEE_CS_CALLCONV_GENERICINST);
signatures.push_back(1);
signatures.push_back(ELEMENT_TYPE_MVAR);
signatures.push_back(0);
tokenMethod = [...ClassLibrary1.Class1::InvokeMyGeneric의 메서드 토큰...]
mdMethodSpec methodSpec = mdTokenNil;
HRESULT hr = pMetaDataEmit2->DefineMethodSpec(tokenMethod, signatures.data(), (ULONG)signatures.size(), &methodSpec);
if (IsNilToken(methodSpec) == false)
{
// ...[생략]...
}
MethodSpec에 신규, 또는 기존에 동일한 항목이 있다면 이미 등록된 토큰 값을 4번째 인자로 전달한 methodSpec 변수로 받을 수 있습니다. 그럼, 이제 우리가 원래 호출하려고 했던 코드에서 "call void [ClassLibrary1]ClassLibrary1.Class1::InvokeMyGeneric(!!T)" 대신 methodSpec을 넣도록 변경합니다.
public class TestClass
{
public static void InvokeLocalGeneric<T>(T obj)
{
ldarg.0
call [...methodSepc...]
// ...[생략: 사용자 코드]...
}
}
이후 실행하면 잘 동작하는 것을 확인할 수 있습니다.
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]