(닷넷 프로세스를 대상으로) 디버거 방식이 아닌 CLR Profiler를 이용해 procdump.exe 기능 구현
예전 글에서,
풀 덤프 파일을 남기는 방법
; https://www.sysnet.pe.kr/2/0/991
procdump.exe에 대해 소개한 적이 있는데요. 대상을 닷넷 프로그램으로 제한한다면 이와 유사한 프로그램을 CLR Profiler 기법을 이용해서도,
기본적인 CLR Profiler 소스 코드 설명
; https://www.sysnet.pe.kr/2/0/10950
만들 수 있습니다. 예를 들어, 특정 메서드가 처음 실행되는 순간을
JITCompilationStarted 이벤트로 잡아,
HRESULT CDAEProfiler::JITCompilationStarted(FunctionID functionId, BOOL fIsSafeToBlock)
{
ClassID classId;
ModuleID moduleId = 0;
mdToken methodToken = 0;
HRESULT hr = m_pICorProfilerInfo->GetFunctionInfo(functionId, &classId, &moduleId, &methodToken);
IMetaDataImport* pMetaDataImport = nullptr;
IMetaDataAssemblyImport* pMetaDataAssemblyImport = nullptr;
IMetaDataEmit* pMetaDataEmit = nullptr;
IMethodMalloc* pMalloc = nullptr;
do
{
hr = m_pICorProfilerInfo->GetModuleMetaData(moduleId, (ofRead | ofWrite), IID_IMetaDataAssemblyImport, (LPUNKNOWN*)&pMetaDataAssemblyImport);
pMetaDataAssemblyImport->QueryInterface(IID_IMetaDataImport, (LPVOID*)&pMetaDataImport);
ULONG cchFunction;
mdToken typeToken;
wchar_t szFunction[2048];
wchar_t szClass[2048];
hr = pMetaDataImport->GetMethodProps(methodToken,
&typeToken,
szFunction,
2048,
&cchFunction,
NULL, NULL, NULL, NULL, NULL);
if (S_OK != hr)
{
break;
}
ULONG cchClass;
hr = pMetaDataImport->GetTypeDefProps(typeToken,
szClass,
2048,
&cchClass,
0, 0);
if (S_OK != hr)
{
break;
}
HRESULT hr = pMetaDataAssemblyImport->QueryInterface(IID_IMetaDataEmit, (LPVOID*)&pMetaDataEmit);
if (S_OK != hr)
{
break;
}
hr = m_pICorProfilerInfo->GetILFunctionBodyAllocator(moduleId, &pMalloc);
if (S_OK != hr)
{
break;
}
const int bufLen = 2048;
wchar_t buf[bufLen];
_snwprintf_s(buf, bufLen, _TRUNCATE, L"%s.%s", szClass, szFunction);
if (wcscmp(buf, L"...[원하는 메서드]...") == 0)
{
// 가장 처음 실행되었을 때...
// dump를 남기는 식의 동작 가능
break;
}
} while (false);
if (pMalloc != nullptr)
{
pMalloc->Release();
}
if (pMetaDataEmit != nullptr)
{
pMetaDataEmit->Release();
}
if (pMetaDataAssemblyImport != nullptr)
{
pMetaDataAssemblyImport->Release();
}
if (pMetaDataImport != nullptr)
{
pMetaDataImport->Release();
}
return S_OK;
}
다음의 코드와 결합시키면 덤프를 남기는 것도 가능합니다.
코드(C#)를 통한 풀 덤프 만드는 방법
; https://www.sysnet.pe.kr/2/0/995
또는 지난번에 설명한 예제를 곁들이면,
CLR Profiler - 별도 정의한 .NET 코드를 호출하도록 IL 코드 변경
; https://www.sysnet.pe.kr/2/0/10959
특정 메서드가 몇 번째 수행되었을 때...라는 식의 조건을 추가할 수 있습니다. 하지만, 대개의 경우 진단 목적이라면 예외 발생 시점에 대한 문제 분석이 중요할 텐데요, 이런 경우라면 다음과 같이 예외가 발생하는 순간을 잡아,
HRESULT CDAEProfiler::ExceptionThrown(ObjectID thrownObjectId)
{
ClassID classId;
ModuleID moduleId;
mdTypeDef typeDefToken;
m_pICorProfilerInfo->GetClassFromObject(thrownObjectId, &classId);
m_pICorProfilerInfo->GetClassIDInfo(classId, &moduleId, &typeDefToken);
IMetaDataImport* pMetaDataImport = nullptr;
do
{
m_pICorProfilerInfo->GetModuleMetaData(moduleId, ofRead, IID_IMetaDataImport, (LPUNKNOWN*)&pMetaDataImport);
mdToken tkExtends;
DWORD dwTypeDefFlags;
ULONG chTypeDef;
const ULONG cchTypeDef = 1024;
wchar_t szTypeDef[cchTypeDef];
pMetaDataImport->GetTypeDefProps(typeDefToken, szTypeDef, cchTypeDef, &chTypeDef, &dwTypeDefFlags, &tkExtends);
printf("ExceptionThrown == %S (ObjectID == %x)\n", szTypeDef, thrownObjectId);
} while (false);
if (pMetaDataImport != nullptr)
{
pMetaDataImport->Release();
}
{
// 예외가 발생했을 때 프로그램을 멈추거나,
printf("Waiting for being attached from debugger, or press any key to continue...\n");
getchar();
// 덤프를 남기는 것도 가능
}
return S_OK;
}
마찬가지로 덤프를 남기거나, 또는 디버거를 attach할 수 있도록 실행을 멈출 수 있습니다. 물론, 코드만 약간 수정하면 n번째 발생한 예외에 대해서만 덤프를 남기는 식으로도 구현할 수 있습니다.
응용하기에 따라, (유독 고객사에서만 발생하는 ^^) 데스크톱 용 프로그램의 예외 발생 상황을 분석하는데 활용할 수도 있을 것입니다. 만약 w3wp.exe에 적용하고 싶다면 아래의 글에 설명한 레지스트리를 통해 Profiler 관련 환경 변수를 설정하거나,
w3wp.exe에 환경 변수 전달하는 방법
; https://www.sysnet.pe.kr/2/0/840
아니면 (약간 더 귀찮아지겠지만) 전역 시스템 환경 변수에 설정하면 됩니다.
이 글의 예제는 다음의 github에 있습니다.
stjeong/DebugAtException
; https://github.com/stjeong/DebugAtException
빌드하면 "daeProxy" 프로젝트의 출력 폴더에 모든 DLL/EXE들이 모이고 다음과 같이 (일부러 예외가 발생하도록 만든) SampleApp.exe를 인자로 실행시키면,
D:\temp\daeProxy\bin\Debug> daeProxy.exe SampleApp.exe
ExceptionThrown == System.IO.FileNotFoundException (ObjectID == 1475df86da0)
Waiting for being attached from debugger, or press any key to continue...
FileNotFoundException이 발생하는 시점에 실행이 멈추게 됩니다. 원한다면 이때 디버거를 attach하거나 덤프를 뜨는 식의 부가 동작을 하면 됩니다. 혹은 요청을 하시면 ^^ 그에 대한 옵션을 만들어 나가는 식으로 살을 붙이겠습니다. (또는, 아예 Pull Request를 날리시는 것도! ^^)
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]