Add exception component

src/client/component/exception.cpp

@@ -1 +1,261 @@
-#include <std_include.hpp>
+#include <std_include.hpp>
+#include "loader/component_loader.hpp"
+#include "system_check.hpp"
+#include "scheduler.hpp"
+
+#include "game/game.hpp"
+
+#include <utils/hook.hpp>
+#include <utils/io.hpp>
+#include <utils/string.hpp>
+#include <utils/thread.hpp>
+#include <utils/compression.hpp>
+
+#include <exception/minidump.hpp>
+
+#include <version.hpp>
+
+#include "game/dvars.hpp"
+
+namespace exception
+{
+	namespace
+	{
+		thread_local struct
+		{
+			DWORD code = 0;
+			PVOID address = nullptr;
+		} exception_data;
+
+		struct
+		{
+			std::chrono::time_point<std::chrono::high_resolution_clock> last_recovery{};
+			std::atomic<int> recovery_counts = {0};
+		} recovery_data;
+
+		bool is_game_thread()
+		{
+			static std::vector<int> allowed_threads =
+			{
+				game::THREAD_CONTEXT_MAIN,
+			};
+
+			const auto self_id = GetCurrentThreadId();
+			for (const auto& index : allowed_threads)
+			{
+				if (game::threadIds[index] == self_id)
+				{
+					return true;
+				}
+			}
+
+			return false;
+		}
+
+		bool is_exception_interval_too_short()
+		{
+			const auto delta = std::chrono::high_resolution_clock::now() - recovery_data.last_recovery;
+			return delta < 1min;
+		}
+
+		bool too_many_exceptions_occured()
+		{
+			return recovery_data.recovery_counts >= 3;
+		}
+
+		volatile bool& is_initialized()
+		{
+			static volatile bool initialized = false;
+			return initialized;
+		}
+
+		bool is_recoverable()
+		{
+			return is_initialized()
+				&& is_game_thread()
+				&& !is_exception_interval_too_short()
+				&& !too_many_exceptions_occured();
+		}
+
+		void show_mouse_cursor()
+		{
+			while (ShowCursor(TRUE) < 0);
+		}
+
+		void display_error_dialog()
+		{
+			std::string error_str = utils::string::va("Fatal error (0x%08X) at 0x%p.\n"
+			                                          "A minidump has been written.\n\n",
+			                                          exception_data.code, exception_data.address);
+
+			if (!system_check::is_valid())
+			{
+				error_str += "Make sure to get supported game files to avoid such crashes!";
+			}
+			else
+			{
+				error_str += "Make sure to update your graphics card drivers and install operating system updates!";
+			}
+
+			utils::thread::suspend_other_threads();
+			show_mouse_cursor();
+
+			MessageBoxA(nullptr, error_str.data(), "H1-Mod ERROR", MB_ICONERROR);
+			TerminateProcess(GetCurrentProcess(), exception_data.code);
+		}
+
+		void reset_state()
+		{
+			if (dvars::cg_legacyCrashHandling && dvars::cg_legacyCrashHandling->current.enabled)
+			{
+				display_error_dialog();
+			}
+
+			// TODO: Add a limit for dedi restarts
+			if (game::environment::is_dedi())
+			{
+				utils::nt::relaunch_self();
+				utils::nt::terminate(exception_data.code);
+			}
+
+			if (is_recoverable())
+			{
+				recovery_data.last_recovery = std::chrono::high_resolution_clock::now();
+				++recovery_data.recovery_counts;
+
+				game::Com_Error(game::ERR_DROP, "Fatal error (0x%08X) at 0x%p.\nA minidump has been written.\n\n"
+				                "H1-Mod has tried to recover your game, but it might not run stable anymore.\n\n"
+				                "Make sure to update your graphics card drivers and install operating system updates!\n"
+				                "Closing or restarting Steam might also help.",
+				                exception_data.code, exception_data.address);
+			}
+			else
+			{
+				display_error_dialog();
+			}
+		}
+
+		size_t get_reset_state_stub()
+		{
+			static auto* stub = utils::hook::assemble([](utils::hook::assembler& a)
+			{
+				a.sub(rsp, 0x10);
+				a.or_(rsp, 0x8);
+				a.jmp(reset_state);
+			});
+
+			return reinterpret_cast<size_t>(stub);
+		}
+
+		std::string get_timestamp()
+		{
+			tm ltime{};
+			char timestamp[MAX_PATH] = {0};
+			const auto time = _time64(nullptr);
+
+			_localtime64_s(&ltime, &time);
+			strftime(timestamp, sizeof(timestamp) - 1, "%Y-%m-%d-%H-%M-%S", &ltime);
+
+			return timestamp;
+		}
+
+		std::string generate_crash_info(const LPEXCEPTION_POINTERS exceptioninfo)
+		{
+			std::string info{};
+			const auto line = [&info](const std::string& text)
+			{
+				info.append(text);
+				info.append("\r\n");
+			};
+
+			line("H1-Mod Crash Dump");
+			line("");
+			line("Version: "s + VERSION);
+			line("Environment: "s + game::environment::get_string());
+			line("Timestamp: "s + get_timestamp());
+			line("Clean game: "s + (system_check::is_valid() ? "Yes" : "No"));
+			line(utils::string::va("Exception: 0x%08X", exceptioninfo->ExceptionRecord->ExceptionCode));
+			line(utils::string::va("Address: 0x%llX", exceptioninfo->ExceptionRecord->ExceptionAddress));
+
+#pragma warning(push)
+#pragma warning(disable: 4996)
+			OSVERSIONINFOEXA version_info;
+			ZeroMemory(&version_info, sizeof(version_info));
+			version_info.dwOSVersionInfoSize = sizeof(version_info);
+			GetVersionExA(reinterpret_cast<LPOSVERSIONINFOA>(&version_info));
+#pragma warning(pop)
+
+			line(utils::string::va("OS Version: %u.%u", version_info.dwMajorVersion, version_info.dwMinorVersion));
+
+			return info;
+		}
+
+		void write_minidump(const LPEXCEPTION_POINTERS exceptioninfo)
+		{
+			const std::string crash_name = utils::string::va("minidumps/h1-mod-crash-%d-%s.zip",
+			                                                 game::environment::get_real_mode(),
+			                                                 get_timestamp().data());
+
+			utils::compression::zip::archive zip_file{};
+			zip_file.add("crash.dmp", create_minidump(exceptioninfo));
+			zip_file.add("info.txt", generate_crash_info(exceptioninfo));
+			zip_file.write(crash_name, "H1-Mod Crash Dump");
+		}
+
+		bool is_harmless_error(const LPEXCEPTION_POINTERS exceptioninfo)
+		{
+			const auto code = exceptioninfo->ExceptionRecord->ExceptionCode;
+			return code == STATUS_INTEGER_OVERFLOW || code == STATUS_FLOAT_OVERFLOW || code == STATUS_SINGLE_STEP;
+		}
+
+		LONG WINAPI exception_filter(const LPEXCEPTION_POINTERS exceptioninfo)
+		{
+			if (is_harmless_error(exceptioninfo))
+			{
+				return EXCEPTION_CONTINUE_EXECUTION;
+			}
+
+			write_minidump(exceptioninfo);
+
+			exception_data.code = exceptioninfo->ExceptionRecord->ExceptionCode;
+			exception_data.address = exceptioninfo->ExceptionRecord->ExceptionAddress;
+			exceptioninfo->ContextRecord->Rip = get_reset_state_stub();
+
+			return EXCEPTION_CONTINUE_EXECUTION;
+		}
+
+		LPTOP_LEVEL_EXCEPTION_FILTER WINAPI set_unhandled_exception_filter_stub(LPTOP_LEVEL_EXCEPTION_FILTER)
+		{
+			// Don't register anything here...
+			return &exception_filter;
+		}
+	}
+
+	class component final : public component_interface
+	{
+	public:
+		component()
+		{
+			SetUnhandledExceptionFilter(exception_filter);
+		}
+
+		void post_load() override
+		{
+			SetUnhandledExceptionFilter(exception_filter);
+			utils::hook::jump(SetUnhandledExceptionFilter, set_unhandled_exception_filter_stub, true);
+
+			scheduler::on_game_initialized([]()
+			{
+				is_initialized() = true;
+			});
+		}
+
+		void post_unpack() override
+		{
+			dvars::cg_legacyCrashHandling = dvars::register_bool("cg_legacyCrashHandling", 
+				false, game::DVAR_FLAG_SAVED, true);
+		}
+	};
+}
+
+REGISTER_COMPONENT(exception::component)

src/client/component/game_console.cpp

@@ -151,8 +151,6 @@ namespace game_console
 				color);
 		}
 
-
-
 		void draw_input_text_and_over(const char* str, float* color)
 		{
 			game::R_AddCmdDrawText(str, 0x7FFFFFFF, console_font, con.globals.x,
@@ -178,7 +176,6 @@ namespace game_console
 			game::R_AddCmdDrawText(text, 0x7FFFFFFF, console_font, con.globals.x + offset, _y, 1.0f, 1.0f, 0.0f, color, 0);
 		}
 
-
 		bool match_compare(const std::string& input, const std::string& text, const bool exact)
 		{
 			if (exact && text == input) return true;
@@ -226,6 +223,7 @@ namespace game_console
 						return;
 					}
 				}
+
 				cmd = cmd->next;
 			}
 		}