Moved dbghelp interaction to DbgHelpLoader

Author: slurmlord

Core/GameEngine/CMakeLists.txt

@@ -72,7 +72,6 @@ set(GAMEENGINE_SRC
 #    Include/Common/MapReaderWriterInfo.h
 #    Include/Common/MessageStream.h
     Include/Common/MiniDumper.h
-    Include/Common/MiniDumper_compat.h
 #    Include/Common/MiniLog.h
     Include/Common/MiscAudio.h
 #    Include/Common/MissionStats.h

Core/GameEngine/Include/Common/MiniDumper.h

@@ -19,8 +19,7 @@
 #pragma once
 
 #ifdef RTS_ENABLE_CRASHDUMP
-#include <imagehlp.h>
-#include "Common/MiniDumper_compat.h"
+#include "DbgHelpLoader.h"
 
 enum DumpType CPP_11(: Int)
 {
@@ -87,12 +86,8 @@ class MiniDumper
 	// Path buffers
 	Char m_dumpDir[MAX_PATH];
 	Char m_dumpFile[MAX_PATH];
-	Char m_sysDbgHelpPath[MAX_PATH];
 	WideChar m_executablePath[MAX_PATH];
 
-	// Module handles
-	HMODULE m_dbgHlp;
-
 	// Event handles
 	HANDLE m_dumpRequested;
 	HANDLE m_dumpComplete;
@@ -110,19 +105,6 @@ class MiniDumper
 
 	AllocationRangeIterator m_rangeIter;
 #endif
-
-	// Function pointer to MiniDumpWriteDump in dbghelp.dll
-	typedef BOOL(WINAPI* MiniDumpWriteDump_t)(
-		HANDLE hProcess,
-		DWORD ProcessId,
-		HANDLE hFile,
-		MINIDUMP_TYPE DumpType,
-		PMINIDUMP_EXCEPTION_INFORMATION ExceptionParam,
-		PMINIDUMP_USER_STREAM_INFORMATION UserStreamParam,
-		PMINIDUMP_CALLBACK_INFORMATION CallbackParam
-		);
-
-	MiniDumpWriteDump_t m_pMiniDumpWriteDump;
 };
 
 extern MiniDumper* TheMiniDumper;

Core/GameEngine/Source/Common/System/MiniDumper.cpp

@@ -60,8 +60,6 @@ MiniDumper::MiniDumper()
 {
 	m_miniDumpInitialized = false;
 	m_requestedDumpType = DUMP_TYPE_MINIMAL;
-	m_dbgHlp = NULL;
-	m_pMiniDumpWriteDump = NULL;
 	m_dumpRequested = NULL;
 	m_dumpComplete = NULL;
 	m_quitting = NULL;
@@ -74,7 +72,6 @@ MiniDumper::MiniDumper()
 #endif
 	memset(m_dumpDir, 0, ARRAY_SIZE(m_dumpDir));
 	memset(m_dumpFile, 0, ARRAY_SIZE(m_dumpFile));
-	memset(m_sysDbgHelpPath, 0, ARRAY_SIZE(m_sysDbgHelpPath));
 	memset(m_executablePath, 0, ARRAY_SIZE(m_executablePath));
 };
 
@@ -148,36 +145,12 @@ void MiniDumper::TriggerMiniDumpForException(struct _EXCEPTION_POINTERS* e_info,
 
 void MiniDumper::Initialize(const AsciiString& userDirPath)
 {
-	// Find the full path to the dbghelp.dll file in the system32 dir
-	::GetSystemDirectory(m_sysDbgHelpPath, MAX_PATH);
-	strlcat(m_sysDbgHelpPath, "\\dbghelp.dll", MAX_PATH);
+	bool success = DbgHelpLoader::load();
 
 	// We want to only use the dbghelp.dll from the OS installation, as the one bundled with the game does not support MiniDump functionality
-	Bool loadedDbgHelp = false;
-	HMODULE m_dbgHlp = ::GetModuleHandle(m_sysDbgHelpPath);
-	if (m_dbgHlp == NULL)
+	if (!(success && DbgHelpLoader::isLoadedFromSystem()))
 	{
-		// Load the dbghelp library from the system folder
-		m_dbgHlp = ::LoadLibrary(m_sysDbgHelpPath);
-		if (m_dbgHlp == NULL)
-		{
-			DEBUG_LOG(("MiniDumper::Initialize: Unable to load system-provided dbghelp.dll from '%s': error=%u", m_sysDbgHelpPath, ::GetLastError()));
-			return;
-		}
-
-		loadedDbgHelp = true;
-	}
-
-	m_pMiniDumpWriteDump = reinterpret_cast<MiniDumpWriteDump_t>(::GetProcAddress(m_dbgHlp, "MiniDumpWriteDump"));
-	if (m_pMiniDumpWriteDump == NULL)
-	{
-		if (loadedDbgHelp)
-		{
-			::FreeLibrary(m_dbgHlp);
-			m_dbgHlp = NULL;
-		}
-
-		DEBUG_LOG(("MiniDumper::Initialize: Could not get address of proc MiniDumpWriteDump from '%s'!", m_sysDbgHelpPath));
+		DEBUG_LOG(("MiniDumper::Initialize: Unable to load system-provided dbghelp.dll, minidump functionality disabled."));
 		return;
 	}
 
@@ -291,11 +264,7 @@ void MiniDumper::CleanupResources()
 		m_quitting = NULL;
 	}
 
-	if (m_dbgHlp != NULL)
-	{
-		::FreeModule(m_dbgHlp);
-		m_dbgHlp = NULL;
-	}
+	DbgHelpLoader::unload();
 }
 
 void MiniDumper::ShutDown()
@@ -438,7 +407,7 @@ void MiniDumper::CreateMiniDump(DumpType dumpType)
 	}
 
 	MINIDUMP_TYPE miniDumpType = static_cast<MINIDUMP_TYPE>(dumpTypeFlags);
-	BOOL success = m_pMiniDumpWriteDump(
+	BOOL success = DbgHelpLoader::miniDumpWriteDump(
 		::GetCurrentProcess(),
 		currentProcessId,
 		dumpFile,

Core/Libraries/Source/WWVegas/WWLib/CMakeLists.txt

@@ -36,6 +36,7 @@ set(WWLIB_SRC
     DbgHelpGuard.h
     DbgHelpLoader.cpp
     DbgHelpLoader.h
+    DbgHelpLoader_minidump.h
     Except.cpp
     Except.h
     FastAllocator.cpp

Core/Libraries/Source/WWVegas/WWLib/DbgHelpLoader.cpp

@@ -22,7 +22,8 @@
 DbgHelpLoader* DbgHelpLoader::Inst = NULL;
 
 DbgHelpLoader::DbgHelpLoader()
-	: m_symInitialize(NULL)
+	: m_miniDumpWriteDump(NULL)
+	, m_symInitialize(NULL)
 	, m_symCleanup(NULL)
 	, m_symLoadModule(NULL)
 	, m_symUnloadModule(NULL)
@@ -86,6 +87,7 @@ bool DbgHelpLoader::load()
 		Inst->m_loadedFromSystem = true;
 	}
 
+	Inst->m_miniDumpWriteDump = reinterpret_cast<MiniDumpWriteDump_t>(::GetProcAddress(Inst->m_dllModule, "MiniDumpWriteDump"));
 	Inst->m_symInitialize = reinterpret_cast<SymInitialize_t>(::GetProcAddress(Inst->m_dllModule, "SymInitialize"));
 	Inst->m_symCleanup = reinterpret_cast<SymCleanup_t>(::GetProcAddress(Inst->m_dllModule, "SymCleanup"));
 	Inst->m_symLoadModule = reinterpret_cast<SymLoadModule_t>(::GetProcAddress(Inst->m_dllModule, "SymLoadModule"));
@@ -134,6 +136,23 @@ void DbgHelpLoader::unload()
 	Inst = NULL;
 }
 
+#ifdef RTS_ENABLE_CRASHDUMP
+BOOL DbgHelpLoader::miniDumpWriteDump(
+	HANDLE hProcess,
+	DWORD ProcessId,
+	HANDLE hFile,
+	MINIDUMP_TYPE DumpType,
+	PMINIDUMP_EXCEPTION_INFORMATION ExceptionParam,
+	PMINIDUMP_USER_STREAM_INFORMATION UserStreamParam,
+	PMINIDUMP_CALLBACK_INFORMATION CallbackParam)
+{
+	if (Inst != NULL && Inst->m_miniDumpWriteDump)
+		return Inst->m_miniDumpWriteDump(hProcess, ProcessId, hFile, DumpType, ExceptionParam, UserStreamParam, CallbackParam);
+
+	return FALSE;
+}
+#endif
+
 BOOL DbgHelpLoader::symInitialize(
 	HANDLE hProcess,
 	LPSTR UserSearchPath,

Core/Libraries/Source/WWVegas/WWLib/DbgHelpLoader.h

@@ -23,6 +23,9 @@
 #include <win.h>
 #include <imagehlp.h> // Must be included after Windows.h
 #include <set>
+#ifdef RTS_ENABLE_CRASHDUMP
+#include <DbgHelpLoader_minidump.h>
+#endif
 
 #include "SystemAllocator.h"
 
@@ -50,6 +53,17 @@ class DbgHelpLoader
 	static bool reload();
 	static void unload();
 
+#ifdef RTS_ENABLE_CRASHDUMP
+	static BOOL WINAPI miniDumpWriteDump(
+		HANDLE hProcess,
+		DWORD ProcessId,
+		HANDLE hFile,
+		MINIDUMP_TYPE DumpType,
+		PMINIDUMP_EXCEPTION_INFORMATION ExceptionParam,
+		PMINIDUMP_USER_STREAM_INFORMATION UserStreamParam,
+		PMINIDUMP_CALLBACK_INFORMATION CallbackParam);
+#endif
+
 	static BOOL WINAPI symInitialize(
 		HANDLE hProcess,
 		LPSTR UserSearchPath,
@@ -106,6 +120,17 @@ class DbgHelpLoader
 
 private:
 
+#ifdef RTS_ENABLE_CRASHDUMP
+	typedef BOOL(WINAPI* MiniDumpWriteDump_t)(
+		HANDLE hProcess,
+		DWORD ProcessId,
+		HANDLE hFile,
+		MINIDUMP_TYPE DumpType,
+		PMINIDUMP_EXCEPTION_INFORMATION ExceptionParam,
+		PMINIDUMP_USER_STREAM_INFORMATION UserStreamParam,
+		PMINIDUMP_CALLBACK_INFORMATION CallbackParam);
+#endif
+
 	typedef BOOL (WINAPI *SymInitialize_t) (
 		HANDLE hProcess,
 		LPSTR UserSearchPath,
@@ -160,6 +185,9 @@ class DbgHelpLoader
 		PGET_MODULE_BASE_ROUTINE GetModuleBaseRoutine,
 		PTRANSLATE_ADDRESS_ROUTINE TranslateAddress);
 
+#ifdef RTS_ENABLE_CRASHDUMP
+	MiniDumpWriteDump_t m_miniDumpWriteDump;
+#endif
 	SymInitialize_t m_symInitialize;
 	SymCleanup_t m_symCleanup;
 	SymLoadModule_t m_symLoadModule;

Core/GameEngine/Include/Common/MiniDumper_compat.h renamed to Core/Libraries/Source/WWVegas/WWLib/DbgHelpLoader_minidump.h

@@ -4,8 +4,9 @@
 
 // Backported defines from minidumpapiset.h for VC6.
 // minidumpapiset.h is Copyright (C) Microsoft Corporation. All rights reserved.
+
 #if defined(_MSC_VER) && _MSC_VER < 1300
-#pragma pack(push, 4)
+#include <pshpack4.h>
 
 typedef enum _MINIDUMP_CALLBACK_TYPE {
 	ModuleCallback,
@@ -249,6 +250,6 @@ typedef enum _MODULE_WRITE_FLAGS {
 	ModuleWriteCodeSegs = 0x0040,
 } MODULE_WRITE_FLAGS;
 
-#pragma pack(pop)
+#include <poppack.h>
 #endif
 #endif