feat(core): Crash Reporter

Author: skuzzis

setup.ps1

@@ -7,7 +7,7 @@ if (-not $env:GITHUB_SHA) {
 if (!(Test-Path -Path "$PSScriptRoot\build")) {
     mkdir build
     Set-Location build
-    python ../configure.py --enable-optimize --symbol-files -s cs2
+    python ../configure.py --enable-optimize -s cs2
     Set-Location ..
 }
 

setup.sh

@@ -10,7 +10,7 @@ fi
 if [ ! -d build ]; then
     mkdir build
     cd build
-    CC=gcc CXX=g++ python ../configure.py --enable-optimize --symbol-files -s cs2
+    CC=gcc CXX=g++ python ../configure.py --enable-optimize -s cs2
     cd ..
 fi
 

src/crashreporter/CrashReport.cpp

@@ -0,0 +1,220 @@
+#include "CrashReport.h"
+
+#ifdef _WIN32
+bool BeginCrashListener() { return true; }
+#else
+
+#include <rapidjson/document.h>
+#include <rapidjson/writer.h>
+#include <rapidjson/stringbuffer.h>
+
+#include <execinfo.h>
+#include <dlfcn.h>
+#include <cxxabi.h>
+#include <signal.h>
+
+#include <tier0/icommandline.h>
+
+#include <TextTable.h>
+#include <sstream>
+
+#include <random>
+
+#include "../files/Files.h"
+#include "../common.h"
+#include "../entrypoint.h"
+
+std::string get_uuid()
+{
+    static std::random_device dev;
+    static std::mt19937 rng(dev());
+
+    std::uniform_int_distribution<int> dist(0, 15);
+
+    const char *v = "0123456789abcdef";
+    const bool dash[] = {0, 0, 0, 0, 1, 0, 1, 0, 1, 0, 1, 0, 0, 0, 0, 0};
+
+    std::string res;
+    for (int i = 0; i < 16; i++)
+    {
+        if (dash[i])
+            res += "-";
+        res += v[dist(rng)];
+        res += v[dist(rng)];
+    }
+    return res;
+}
+
+std::string startup_cmd = "None";
+
+const char *ws = " \t\n\r\f\v";
+
+// trim from end of string (right)
+inline std::string &rtrim(std::string &s, const char *t = ws)
+{
+    s.erase(s.find_last_not_of(t) + 1);
+    return s;
+}
+
+// trim from beginning of string (left)
+inline std::string &ltrim(std::string &s, const char *t = ws)
+{
+    s.erase(0, s.find_first_not_of(t));
+    return s;
+}
+
+// trim from both ends of string (right then left)
+inline std::string &trim(std::string &s, const char *t = ws)
+{
+    return ltrim(rtrim(s, t), t);
+}
+
+std::string BacktraceRaw(int skip = 1)
+{
+    void *callstack[128];
+    const int nMaxFrames = sizeof(callstack) / sizeof(callstack[0]);
+    char buf[1024];
+    int nFrames = backtrace(callstack, nMaxFrames);
+    char **symbols = backtrace_symbols(callstack, nFrames);
+
+    std::ostringstream trace_buf;
+    for (int i = skip; i < nFrames; i++)
+    {
+        Dl_info info;
+        if (dladdr(callstack[i], &info) && info.dli_sname)
+        {
+            char *demangled = NULL;
+            int status = -1;
+            if (info.dli_sname[0] == '_')
+                demangled = abi::__cxa_demangle(info.dli_sname, NULL, 0, &status);
+            snprintf(buf, sizeof(buf), "%02d. %p %s + %zd\n",
+                     i, int(2 + sizeof(void *) * 2), callstack[i],
+                     status == 0 ? demangled : info.dli_sname == 0 ? symbols[i]
+                                                                   : info.dli_sname,
+                     (char *)callstack[i] - (char *)info.dli_saddr);
+            free(demangled);
+        }
+        else
+        {
+            snprintf(buf, sizeof(buf), "%02d. %p %s\n",
+                     i, callstack[i], symbols[i]);
+        }
+        trace_buf << buf;
+    }
+    free(symbols);
+    if (nFrames == nMaxFrames)
+        trace_buf << "[truncated]\n";
+    return trace_buf.str();
+}
+
+TextTable GetBacktrace()
+{
+    TextTable backtraceTable('-', '|', '+');
+
+    backtraceTable.add(" ID ");
+    backtraceTable.add(" File ");
+    backtraceTable.add(" Function ");
+    backtraceTable.add(" Offset ");
+    backtraceTable.add(" Address ");
+    backtraceTable.endOfRow();
+
+    void *callstack[128];
+    const int nMaxFrames = sizeof(callstack) / sizeof(callstack[0]);
+    char buf[1024];
+    int nFrames = backtrace(callstack, nMaxFrames);
+    char **symbols = backtrace_symbols(callstack, nFrames);
+
+    for (int i = 2; i < nFrames; i++)
+    {
+        backtraceTable.add(string_format(" %02d. ", i));
+
+        std::vector<std::string> symbolExploded = explode(symbols[i], "/");
+        backtraceTable.add(string_format(" %s ", explode(symbolExploded[symbolExploded.size() - 1], "(")[0].c_str()));
+
+        Dl_info info;
+        if (dladdr(callstack[i], &info) && info.dli_sname)
+        {
+            char *demangled = NULL;
+            int status = -1;
+            if (info.dli_sname[0] == '_')
+                demangled = abi::__cxa_demangle(info.dli_sname, NULL, 0, &status);
+
+            std::string funcName = (status == 0 ? demangled : info.dli_sname == 0 ? "-"
+                                                                                  : info.dli_sname);
+
+            backtraceTable.add(string_format(" %s ", (funcName.size() > 36 ? (funcName.substr(0, 33) + "...") : funcName).c_str()));
+            free(demangled);
+        }
+        else
+            backtraceTable.add(" - ");
+
+        backtraceTable.add(string_format(" %s ", explode(explode(symbolExploded[symbolExploded.size() - 1], "+")[1], ")")[0].c_str()));
+        backtraceTable.add(string_format(" %p ", callstack[i]));
+        backtraceTable.endOfRow();
+    }
+    free(symbols);
+
+    return backtraceTable;
+}
+
+void signal_handler(int signumber)
+{
+    try
+    {
+        void *tracePointers[20];
+        size_t count = backtrace(tracePointers, 20);
+
+        PLUGIN_PRINTF("Crash Reporter", "A crash has occured and a dump has been created:\n");
+        std::string backtraceData = BacktraceRaw();
+
+        TextTable traceTable = GetBacktrace();
+        PrintTextTable("Crash Reporter", traceTable);
+
+        std::string file_path = string_format("addons/swiftly/dumps/crash.%s.log", get_uuid().c_str());
+        if (Files::ExistsPath(file_path))
+            Files::Delete(file_path);
+
+        Files::Append(file_path, string_format("================================\nCommand: %s\nMap: %s\n================================\n\n%s", startup_cmd.c_str(), engine->GetServerGlobals() ? engine->GetServerGlobals()->mapname.ToCStr() : "None", backtraceData.c_str()), false);
+        PLUGIN_PRINTF("Crash Reporter", "A dump log file has been created at: %s\n", file_path.c_str());
+    }
+    catch (const std::runtime_error &e)
+    {
+        PLUGIN_PRINTF("Crash Reporter", "Error crash handling: %s\n", e.what());
+    }
+
+    exit(EXIT_FAILURE);
+}
+
+bool BeginCrashListener()
+{
+    if (!Files::ExistsPath("addons/swiftly/dumps"))
+    {
+        if (!Files::CreateDirectory("addons/swiftly/dumps"))
+        {
+            PLUGIN_PRINTF("Crash Listener", "Couldn't create dumps folder.\n");
+            return false;
+        }
+    }
+
+    ::signal(SIGSEGV, &signal_handler);
+
+    startup_cmd = CommandLine()->GetCmdLine();
+    std::vector<std::string> exp = explode(startup_cmd, " ");
+    std::vector<std::string> exp2;
+    for (int i = 1; i < exp.size(); i++)
+    {
+        std::string str = trim(exp[i]);
+        if (str.length() == 0)
+            continue;
+        if (exp2.size() > 0)
+            if (ends_with(exp2[exp2.size() - 1], "sv_setsteamaccount") || ends_with(exp2[exp2.size() - 1], "authkey"))
+                str = "REDACTED";
+
+        exp2.push_back(str);
+    }
+    startup_cmd = implode(exp2, " ");
+
+    return true;
+}
+
+#endif

src/crashreporter/CrashReport.h

@@ -0,0 +1,3 @@
+#pragma once
+
+bool BeginCrashListener();

src/entrypoint.cpp

@@ -7,11 +7,12 @@
 
 #include <steam/steam_gameserver.h>
 
+#include "crashreporter/CrashReport.h"
+#include "hooks/NativeHooks.h"
 #include "player/PlayerManager.h"
 #include "plugins/PluginManager.h"
 #include "signatures/Signatures.h"
 #include "signatures/Offsets.h"
-#include "hooks/NativeHooks.h"
 
 SH_DECL_HOOK3_void(INetworkServerService, StartupServer, SH_NOATTRIB, 0, const GameSessionConfiguration_t &, ISource2WorldSession *, const char *);
 SH_DECL_HOOK3_void(IServerGameDLL, GameFrame, SH_NOATTRIB, 0, bool, bool, bool);
@@ -113,6 +114,9 @@ bool Swiftly::Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlen, bool
 
     ConVar_Register(FCVAR_RELEASE | FCVAR_SERVER_CAN_EXECUTE | FCVAR_CLIENT_CAN_EXECUTE | FCVAR_GAMEDLL);
 
+    if (!BeginCrashListener())
+        PRINTRET("Crash Reporter failed to initialize.\n", false)
+
     g_pluginManager = new PluginManager();
     g_Signatures = new Signatures();
     g_Offsets = new Offsets();