feat(crashdump): Add crash dump functionality for fatal errors (TheSuperHackers#1594)

Crash dumps are stored in %USERPROFILE%\Documents\Command and Conquer Generals Zero Hour Data\CrashDumps

Author: slurmlord

Core/GameEngine/CMakeLists.txt

@@ -72,6 +72,7 @@ set(GAMEENGINE_SRC
 #    Include/Common/MapObject.h
 #    Include/Common/MapReaderWriterInfo.h
 #    Include/Common/MessageStream.h
+    Include/Common/MiniDumper.h
 #    Include/Common/MiniLog.h
     Include/Common/MiscAudio.h
 #    Include/Common/MissionStats.h
@@ -660,6 +661,7 @@ set(GAMEENGINE_SRC
 #    Source/Common/System/List.cpp
     Source/Common/System/LocalFile.cpp
     Source/Common/System/LocalFileSystem.cpp
+    Source/Common/System/MiniDumper.cpp
     Source/Common/System/ObjectStatusTypes.cpp
 #    Source/Common/System/QuotedPrintable.cpp
     Source/Common/System/Radar.cpp

Core/GameEngine/Include/Common/MiniDumper.h

@@ -0,0 +1,97 @@
+/*
+**	Command & Conquer Generals Zero Hour(tm)
+**	Copyright 2025 TheSuperHackers
+**
+**	This program is free software: you can redistribute it and/or modify
+**	it under the terms of the GNU General Public License as published by
+**	the Free Software Foundation, either version 3 of the License, or
+**	(at your option) any later version.
+**
+**	This program is distributed in the hope that it will be useful,
+**	but WITHOUT ANY WARRANTY; without even the implied warranty of
+**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+**	GNU General Public License for more details.
+**
+**	You should have received a copy of the GNU General Public License
+**	along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+
+#ifdef RTS_ENABLE_CRASHDUMP
+#include "DbgHelpLoader.h"
+
+enum DumpType CPP_11(: Char)
+{
+	// Smallest dump type with call stacks and some supporting variables
+	DumpType_Minimal = 'M',
+	// Largest dump size including complete memory contents of the process
+	DumpType_Full = 'F',
+};
+
+class MiniDumper
+{
+	enum MiniDumperExitCode CPP_11(: Int)
+	{
+		MiniDumperExitCode_Success = 0x0,
+		MiniDumperExitCode_FailureWait = 0x37DA1040,
+		MiniDumperExitCode_FailureParam = 0x4EA527BB,
+		MiniDumperExitCode_ForcedTerminate = 0x158B1154,
+	};
+
+public:
+	MiniDumper();
+	Bool IsInitialized() const;
+	void TriggerMiniDump(DumpType dumpType);
+	void TriggerMiniDumpForException(_EXCEPTION_POINTERS* e_info, DumpType dumpType);
+	static void initMiniDumper(const AsciiString& userDirPath);
+	static void shutdownMiniDumper();
+	static LONG WINAPI DumpingExceptionFilter(_EXCEPTION_POINTERS* e_info);
+
+private:
+	void Initialize(const AsciiString& userDirPath);
+	void ShutDown();
+	void CreateMiniDump(DumpType dumpType);
+	void CleanupResources();
+	Bool IsDumpThreadStillRunning() const;
+	void ShutdownDumpThread();
+
+	// Thread procs
+	static DWORD WINAPI MiniDumpThreadProc(LPVOID lpParam);
+	DWORD ThreadProcInternal();
+
+	// Dump file directory bookkeeping
+	Bool InitializeDumpDirectory(const AsciiString& userDirPath);
+	static void KeepNewestFiles(const std::string& directory, const DumpType dumpType, const Int keepCount);
+
+	// Struct to hold file information
+	struct FileInfo
+	{
+		std::string name;
+		FILETIME lastWriteTime;
+	};
+
+	static bool CompareByLastWriteTime(const FileInfo& a, const FileInfo& b);
+
+private:
+	Bool m_miniDumpInitialized;
+	Bool m_loadedDbgHelp;
+	DumpType m_requestedDumpType;
+
+	// Path buffers
+	Char m_dumpDir[MAX_PATH];
+	Char m_dumpFile[MAX_PATH];
+	WideChar m_executablePath[MAX_PATH];
+
+	// Event handles
+	HANDLE m_dumpRequested;
+	HANDLE m_dumpComplete;
+	HANDLE m_quitting;
+
+	// Thread handles
+	HANDLE m_dumpThread;
+	DWORD m_dumpThreadId;
+};
+
+extern MiniDumper* TheMiniDumper;
+#endif

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

@@ -70,6 +70,9 @@
 #if defined(DEBUG_STACKTRACE) || defined(IG_DEBUG_STACKTRACE)
 	#include "Common/StackDump.h"
 #endif
+#ifdef RTS_ENABLE_CRASHDUMP
+#include "Common/MiniDumper.h"
+#endif
 
 // Horrible reference, but we really, really need to know if we are windowed.
 extern bool DX8Wrapper_IsWindowed;
@@ -727,6 +730,22 @@ double SimpleProfiler::getAverageTime()
 		}
 	}
 
+
+static void TriggerMiniDump()
+{
+#ifdef RTS_ENABLE_CRASHDUMP
+	if (TheMiniDumper && TheMiniDumper->IsInitialized())
+	{
+		// Create both minimal and full memory dumps
+		TheMiniDumper->TriggerMiniDump(DumpType_Minimal);
+		TheMiniDumper->TriggerMiniDump(DumpType_Full);
+	}
+
+	MiniDumper::shutdownMiniDumper();
+#endif
+}
+
+
 void ReleaseCrash(const char *reason)
 {
 	/// do additional reporting on the crash, if possible
@@ -737,6 +756,8 @@ void ReleaseCrash(const char *reason)
 		}
 	}
 
+	TriggerMiniDump();
+
 	char prevbuf[ _MAX_PATH ];
 	char curbuf[ _MAX_PATH ];
 
@@ -813,6 +834,8 @@ void ReleaseCrashLocalized(const AsciiString& p, const AsciiString& m)
 		return;
 	}
 
+	TriggerMiniDump();
+
 	UnicodeString prompt = TheGameText->fetch(p);
 	UnicodeString mesg = TheGameText->fetch(m);