C# - DLL Surrogate를 이용한 Out-of-process COM 개체 제작
DLL Surrogate를 사용하면,
DLL Surrogate의 또 다른 활용 - 32bit 응용 프로그램에서 64bit COM 개체 호출
; https://www.sysnet.pe.kr/2/1/1059
DLL Surrogates
; https://learn.microsoft.com/en-us/windows/win32/com/dll-surrogates
기존의 InprocServer 형식의 COM 개체도 dllhost.exe에 실어 호스팅하는 것이 가능합니다. 방법은 아래의 문서에서 잘 설명하고 있습니다.
Registering the DLL Server for Surrogate Activation
; https://learn.microsoft.com/en-us/windows/win32/com/registering-the-dll-server-for-surrogate-activation
- CLSID에 등록된 COM GUID 하위에 AppID 키 등록
- CLSID에 등록된 COM GUID 하위에는 LocalServer32, LocalServer, LocalService 등의 키가 없어야 함
- COM 개체 생성 호출에서 CLSCTX_LOCAL_SERVER 비트 설정
- AppID 경로 하위에 DllSurrogate 키 등록
자, 그럼 실제로 한번 실습을 해볼까요? ^^
이를 위해 C#으로 Inproc COM 개체를 하나 만듭니다.
// ClassLibrary1 DLL 프로젝트
using System;
using System.Diagnostics;
using System.Runtime.InteropServices;
namespace ClassLibrary1
{
[ComVisible(true)]
[Guid("62A4A0A9-8791-444B-ABF7-8BFD23DFF0FB")]
[InterfaceType(ComInterfaceType.InterfaceIsDual)]
public interface ITest
{
long GetValue();
}
[ComVisible(true)]
[Guid("296A7E30-8592-4EE5-8FE1-E9DAF86D146E")]
[ClassInterface(ClassInterfaceType.AutoDual)]
public class CTest : ITest
{
public long GetValue()
{
long pid = Process.GetCurrentProcess().Id;
long tid = AppDomain.GetCurrentThreadId();
return tid | (pid << 32);
}
}
}
그리고 regasm을 이용해 위의 DLL을 등록한 후,
C:\temp> regasm.exe ClassLibrary1.dll /codebase /tlb:ClassLibrary1.tlb
현재 상태에서 CTest COM 개체를 사용하면 Inproc으로 활성화되는 것을 확인할 수 있습니다.
using ClassLibrary1;
using System;
using System.Diagnostics;
namespace ConsoleApp1
{
class Program
{
static void Main(string[] args)
{
Console.WriteLine($"Current: pid = {Process.GetCurrentProcess().Id}, tid = {AppDomain.GetCurrentThreadId()}");
Guid guid = new Guid("{296A7E30-8592-4EE5-8FE1-E9DAF86D146E}");
Type type = Type.GetTypeFromCLSID(guid);
object comObject = Activator.CreateInstance(type);
ITest ac = comObject as ITest;
long result = ac.GetValue();
Console.WriteLine($"COM: pid = {result >> 32}, tid = {result & UInt32.MaxValue}");
}
}
}
/* 출력 결과
Current: pid = 23928, tid = 16536
COM: pid = 23928, tid = 16536
*/
출력 결과를 보면, Process Id와 Thread Id가 모두 Console EXE 프로세스의 것과 동일합니다.
자, 그럼 이 상태에서 CTest 개체를 DLL Surrogate에 호스팅하도록 설정해 보겠습니다. 이를 위해 COM 개체 측에서 해야 할 작업은 다음의 레지스트리 값을 2개 설정하는 것이 전부입니다.
// CTest의 CLSID == {296A7E30-8592-4EE5-8FE1-E9DAF86D146E}
경로: HKEY_CLASSES_ROOT\CLSID\{296A7E30-8592-4EE5-8FE1-E9DAF86D146E}
키 이름: AppID
키 형식: REG_SZ
키 값: {296A7E30-8592-4EE5-8FE1-E9DAF86D146E}
경로: HKEY_LOCAL_MACHINE\SOFTWARE\Classes\AppID\{296A7E30-8592-4EE5-8FE1-E9DAF86D146E}
키 이름: DllSurrogate
키 형식: REG_SZ
키 값: (empty)
이제 남은 작업은 해당 COM 개체를 생성할 때 Inproc이 아닌, Out-of-proc으로 생성하라는 "
CLSCTX_LOCAL_SERVER" 옵션을 지정하는 것입니다.
문제는 .NET의 기본 라이브러리에서는 CLSCTX_LOCAL_SERVER 옵션을 적용할 방법이 없습니다. 따라서, 이 부분은 C++로 먼저 실습을 해보겠습니다. 예전에 한 번 설명했던 내용에 따라,
C# 개발자를 위한 C++ COM 객체의 기본 구현 방식 설명
; https://www.sysnet.pe.kr/2/0/11175
CoGetClassObject를 이용해 IClassFactory로부터 다음과 같이 surrogate된 COM 개체를 생성할 수 있습니다.
#include <Windows.h>
#import "..\bin\ClassLibrary1.tlb" raw_interfaces_only
int main()
{
CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED);
printf("Current: pid = %d, tid = %d\n", ::GetCurrentProcessId(), ::GetCurrentThreadId());
HRESULT hr;
ClassLibrary1::ITest* itestPtr;
IClassFactory* pFactory;
hr = CoGetClassObject(__uuidof(ClassLibrary1::CTest), CLSCTX_LOCAL_SERVER, nullptr, __uuidof(IClassFactory), (LPVOID*)&pFactory);
if (hr == S_OK)
{
hr = pFactory->CreateInstance(nullptr, __uuidof(ClassLibrary1::ITest), (LPVOID*)&itestPtr);
if (hr == S_OK)
{
__int64 value;
itestPtr->GetValue(&value);
printf("COM: pid = %lld, tid = %lld\n", value >> 32, value & 0xFFFFFFFF);
itestPtr->Release();
}
pFactory->Release();
}
CoUninitialize();
}
/* 출력 결과
Current: pid = 8244, tid = 22372
COM: pid = 30484, tid = 23908
*/
보는 바와 같이, C++ 콘솔 프로세스와 COM 개체가 반환한 PID가 다른 것을 확인할 수 있습니다. 그리고 이것을 CoCreateInstance로 좀 더 간단하게 구현할 수도 있습니다.
int main()
{
// ...[생략]...
{
HRESULT hr;
ClassLibrary1::ITest* itestPtr;
hr = CoCreateInstance(__uuidof(ClassLibrary1::CTest), nullptr, CLSCTX_LOCAL_SERVER, __uuidof(ClassLibrary1::ITest), (LPVOID *)&itestPtr);
if (hr == S_OK)
{
__int64 value;
itestPtr->GetValue(&value);
printf("COM: pid = %lld, tid = %lld\n", value >> 32, value & 0xFFFFFFFF);
itestPtr->Release();
}
}
// ...[생략]...
}
결과는 동일한데요, 재미 삼아 2개의 COM 개체를 한꺼번에 생성하면 어떻게 될까요? 그럼 COM 측에서 반환하는 pid는 고정인 반면 tid는 (때에 따라) 변경되는 것을 볼 수 있습니다.
또한, 개체를 생성하는 시점에 dllhost.exe가 실행돼 서비스를 시작하고, 해당 개체를 Release 해 COM 개체의 참조 횟수가 0으로 내려가면 자동으로 dllhost.exe도 (약간의 시간이 흐른 후) 프로세스가 종료됩니다.
C++에서 확인을 했으니, 이제 C#에서도 확인을 해봐야겠지요. ^^ CLSCTX_LOCAL_SERVER 옵션의 문제로 인해 어쩔 수 없이 PInvoke를 거쳐야 하는데요, 이를 위해 C++에서처럼 CoCreateInstance(또는
CoCreateInstanceEx)를 그대로 사용할 수 있습니다.
using ClassLibrary1;
using System;
using System.Diagnostics;
using System.Runtime.InteropServices;
class Program
{
[Flags]
enum CLSCTX : uint
{
// ...[생략]...
LOCAL_SERVER = 0x4,
// ...[생략]...
}
[DllImport("ole32.dll")]
static extern int CoCreateInstance([In, MarshalAs(UnmanagedType.LPStruct)] Guid rclsid,
[MarshalAs(UnmanagedType.IUnknown)] object pUnkOuter,
CLSCTX dwClsCtx, [In, MarshalAs(UnmanagedType.LPStruct)] Guid riid, [In, Out] ref IntPtr ppv);
static void Main(string[] args)
{
Console.WriteLine($"Current: pid = {Process.GetCurrentProcess().Id}, tid = {AppDomain.GetCurrentThreadId()}");
Guid clsid = new Guid("{296A7E30-8592-4EE5-8FE1-E9DAF86D146E}");
Guid IID_IUnknown = new Guid("{00000000-0000-0000-C000-000000000046}");
IntPtr pUnknown = IntPtr.Zero;
int hr = CoCreateInstance(clsid, null, CLSCTX.LOCAL_SERVER, IID_IUnknown, ref pUnknown);
if (hr == 0)
{
ITest testObj = Marshal.GetTypedObjectForIUnknown(pUnknown, typeof(ITest)) as ITest;
long result = testObj.GetValue();
Console.WriteLine($"COM: pid = {result >> 32}, tid = {result & UInt32.MaxValue}");
Marshal.ReleaseComObject(testObj);
Marshal.Release(pUnknown);
}
}
}
/* 출력 결과
Current: pid = 35312, tid = 20536
COM: pid = 31416, tid = 25952
*/
참고로, GetTypedObjectForIUnknown이 반환하는 값은
RCW(Runtime Callable Wrapper)로 닷넷이 해제를 관리하는 반면, CoCreateInstance로 반환받은 pUnknown은 순수 native 자원이기 때문에 닷넷 측에서 관리가 안 됩니다.
이로 인해, 만약 COM 개체를 해제할 때 다음과 같이 하는 것은 허용이 되지만,
// RCW 해제는 명시하지 않아도 닷넷이 GC로 관리
// Marshal.ReleaseComObject(testObj);
Marshal.Release(pUnknown);
반대로 pUnknown의 해제를 빼먹는 것은 허용이 안 됩니다.
Marshal.ReleaseComObject(testObj);
// 이런 경우 COM 개체가 해제가 안 됨.
// Marshal.Release(pUnknown);
여기서 "허용이 안 된다는" 의미는, 개체를 해제한 이후에도 dllhost.exe가 여전히 살아 있게 됩니다. 따라서 자칫하면 dllhost.exe 측에서 꾸준히 메모리 누수가 발생할 여지가 있으므로 자원 해제에 주의를 기울여야 합니다. 팁이라면, COM 참조 관리의 특성상 pUnknown은 GetTypedObjectForIUnknown 사용 후 곧바로 Release 시켜도 됩니다. (Release 해도 ITest에 의한 참조 횟수 덕분에 0으로 내려가지 않아 ITest를 해제하기 전까지는 COM 개체가 내려가지 않습니다.)
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
만약 DLL Surrogate를 사용하겠다고 정했으면 현실적인 수준에서 배포를 고민해야 합니다. COM 개체 등록 자체는 regasm.exe로 가능하지만, 이후의 AppID 관련 키들을 부가적으로 더 추가를 해야 합니다. 이를 위해, 간단하게는 다음과 같은 식의 reg 파일을 만들어 두고,
REGEDIT4
[HKEY_CLASSES_ROOT\CLSID\{296A7E30-8592-4EE5-8FE1-E9DAF86D146E}]
"AppID"="{296A7E30-8592-4EE5-8FE1-E9DAF86D146E}"
[HKEY_LOCAL_MACHINE\SOFTWARE\Classes\AppID\{296A7E30-8592-4EE5-8FE1-E9DAF86D146E}]
"DllSurrogate"=""
제품 설치 시에 regasm.exe 이후 위의 파일을 등록하도록 reg.exe로 처리할 수 있습니다.
C:\temp> reg import ClassLibrary1.reg
The operation completed successfully.
또는, DllExport와 DllRegisterServer 메서드의 구현으로,
C# 개발자를 위한 C++ COM 객체의 기본 구현 방식 설명
; https://www.sysnet.pe.kr/2/0/11175#dll_register
일반적인 regsvr32.exe의 등록 과정을 취하도록 할 수도 있습니다.
regsvr32 ClassLibrary1.dll
관련해서 아래와 같은 글도 있으니 읽어보시고, ^^
Hosting COM DLLs in a Surrogate Process (mhtml 파일로 이 글의 첨부 파일에 추가했습니다.)
; https://flylib.com/books/en/3.357.1.52/1/
Hosting a .NET DLL as an Out-Of-Process COM Server (EXE)
; https://dzone.com/articles/hosting-net-dll-out-process
위의 글 중에서 "Hosting COM DLLs in a Surrogate Process"는 DLL Surrogate 지정을
OLEViewer를 이용한 방법을 보여줍니다.
또한 아래는 마이크로소프트의 공식 예제 코드이고,
Out-of-process COM Server Demo
; https://learn.microsoft.com/en-us/samples/dotnet/samples/out-of-process-com-server/
dotnet/samples
; https://github.com/dotnet/samples/tree/main/core/extensions/OutOfProcCOM
위의 경우, DLL Surrogate와 순수 Out-of-proc Server 유형을 함께 포함하고 있습니다.
DLL surrogate: dotnet msbuild -target:ServerUsage DllServer
Executable server: dotnet msbuild -target:ServerUsage ExeServer
그나저나... 15년 전쯤에 이런 내용을 정리했다면 좀 더 유용했겠는데... 지금에야 다루고 있다니... ^^;
C# - CoCreateInstance 관련 Inteop 오류 정리
; https://www.sysnet.pe.kr/2/0/12678
Wslhub.Sdk 사용으로 알아보는 CoInitializeSecurity 사용 제약
; https://www.sysnet.pe.kr/2/0/12665
별도 DLL에 포함된 타입을 STAThread Main 메서드에서 사용하는 경우 CoInitializeSecurity 자동 호출
; https://www.sysnet.pe.kr/2/0/12666
COM+ 서버 응용 프로그램을 이용해 CoInitializeSecurity 제약 해결
; https://www.sysnet.pe.kr/2/0/12667
ionescu007/lxss github repo에 공개된 lxssmanager.dll의 CLSID_LxssUserSession/IID_ILxssSession 사용법
; https://www.sysnet.pe.kr/2/0/12676
역공학을 통한 lxssmanager.dll의 ILxssSession 사용법 분석
; https://www.sysnet.pe.kr/2/0/12677
C# - DLL Surrogate를 이용한 Out-of-process COM 개체 제작
; https://www.sysnet.pe.kr/2/0/12668
DLL Surrogate를 이용한 Out-of-process COM 개체에서의 CoInitializeSecurity 문제
; https://www.sysnet.pe.kr/2/0/12670
CoInitializeSecurity의 전역 설정을 재정의하는 CoSetProxyBlanket 함수 사용법
; https://www.sysnet.pe.kr/2/0/12679
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]