feat(core): Crash Reporter

Author: skuzzis

.github/workflows/main.yml

@@ -52,7 +52,7 @@ jobs:
               working-directory: swiftly
               shell: bash
               run: |
-                  sudo apt install -y libreadline-dev
+                  sudo apt install -y libreadline-dev libboost-all-dev
                   bash ./setup.sh
 
             - name: Prepare Build - Windows

.vscode/settings.json

@@ -101,7 +101,8 @@
         "complex": "cpp",
         "scoped_allocator": "cpp",
         "typeindex": "cpp",
-        "valarray": "cpp"
+        "valarray": "cpp",
+        "*.ipp": "cpp"
     },
     "C_Cpp.default.compilerPath": "C:\\msys64\\mingw64\\bin\\g++.exe",
     "C_Cpp.formatting": "clangFormat"

AMBuilder

@@ -68,8 +68,8 @@ for sdk_target in MMSPlugin.sdk_targets:
     binary.compiler.defines += ['HAVE_STRUCT_TIMESPEC']
 
   if binary.compiler.target.platform == 'linux':
-    binary.compiler.postlink += ['-lrt', '-lssl', '-lcrypto', '-fexceptions', '-lidn2', '-lpsl', '-lbrotlidec', '-lz']
-    binary.compiler.defines += ["LUA_USE_LINUX", "LUA_USE_READLINE"]
+    binary.compiler.postlink += ['-lrt', '-lssl', '-lcrypto', '-fexceptions', '-lidn2', '-lpsl', '-lbrotlidec', '-lz', '-lbacktrace']
+    binary.compiler.defines += ["LUA_USE_LINUX", "LUA_USE_READLINE", "BOOST_STACKTRACE_USE_BACKTRACE"]
   elif binary.compiler.target.platform == 'windows':
     binary.compiler.postlink += [
       os.path.join('psapi.lib'),

src/common.h

@@ -51,6 +51,8 @@ class SwiftlyPlugin : public ISmmPlugin, public IMetamodListener
     void OnLevelShutdown();
     void NextFrame(std::function<void()> fn);
 
+    std::string GetMap();
+
 public:
     void Hook_StartupServer(const GameSessionConfiguration_t &config, ISource2WorldSession *, const char *);
     void Hook_GameFrame(bool simulating, bool bFirstTick, bool bLastTick);

src/dumps/CrashDump.cpp

@@ -0,0 +1,109 @@
+#include "CrashDump.h"
+
+#ifdef _WIN32
+bool BeginCrashListener() { return true; }
+#else
+
+#include <boost/stacktrace.hpp>
+#include <boost/exception/all.hpp>
+#include <rapidjson/document.h>
+#include <rapidjson/writer.h>
+#include <rapidjson/stringbuffer.h>
+
+#include <random>
+
+#include <tier0/icommandline.h>
+
+#include "../files/Files.h"
+#include "../http/HTTPManager.h"
+#include "../common.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";
+
+void signal_handler(int signumber)
+{
+    try
+    {
+        auto boostStackTrace = boost::stacktrace::stacktrace();
+
+        std::string stacktrace = boost::to_string(boost::stacktrace::stacktrace());
+        std::string coredumpdata = stacktrace;
+        std::vector<std::string> splitted_dump = explode(coredumpdata, "\n");
+        PRINTF("Crash Reporter", "A crash has occured and a dump has been created:\n");
+        for (int i = 0; i < splitted_dump.size() - 1; i++)
+            PRINTF("Crash Reporter", "%s\n", splitted_dump[i].c_str());
+
+        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(), g_Plugin.GetMap().c_str(), coredumpdata.c_str()), false);
+        PRINTF("Crash Reporter", "A dump log file has been created at: %s\n", file_path.c_str());
+        PRINTF("Crash Reporter", "A crash report has been sent to Swiftly Crash Reporter Server.\n");
+
+        rapidjson::Document document(rapidjson::kObjectType);
+
+        document.AddMember(rapidjson::Value().SetString("coredumpdata", document.GetAllocator()), rapidjson::Value().SetString(coredumpdata.c_str(), document.GetAllocator()), document.GetAllocator());
+        document.AddMember(rapidjson::Value().SetString("startup_cmd", document.GetAllocator()), rapidjson::Value().SetString(startup_cmd.c_str(), document.GetAllocator()), document.GetAllocator());
+        document.AddMember(rapidjson::Value().SetString("map", document.GetAllocator()), rapidjson::Value().SetString(g_Plugin.GetMap().c_str(), document.GetAllocator()), document.GetAllocator());
+
+        rapidjson::StringBuffer buffer;
+        rapidjson::Writer<rapidjson::StringBuffer> writer(buffer);
+        document.Accept(writer);
+
+        std::string json = std::string(buffer.GetString());
+
+        uint64_t requestid = g_httpManager->CreateRequest("https://crashreporter.swiftlycs2.net");
+        HTTPRequest *req = g_httpManager->FetchRequest(requestid);
+        req->SetBody(json);
+        req->SetContentType(ContentType::APPLICATION_JSON);
+        req->Post("/");
+        g_httpManager->DeleteRequest(requestid);
+    }
+    catch (const std::runtime_error &e)
+    {
+        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"))
+        {
+            PRINTF("Crash Listener", "Couldn't create dumps folder.\n");
+            return false;
+        }
+    }
+
+    startup_cmd = CommandLine()->GetCmdLine();
+
+    ::signal(SIGSEGV, &signal_handler);
+    return true;
+}
+
+#endif

src/dumps/CrashDump.h

@@ -0,0 +1,6 @@
+#ifndef _crashdump_h
+#define _crashdump_h
+
+bool BeginCrashListener();
+
+#endif

src/entrypoint.cpp

@@ -27,6 +27,7 @@
 #include "entities/EntityManager.h"
 #include "precacher/Precacher.h"
 #include "menus/Menus.h"
+#include "dumps/CrashDump.h"
 
 #define LOAD_COMPONENT(TYPE, VARIABLE_NAME) \
     {                                       \
@@ -135,7 +136,10 @@ bool SwiftlyPlugin::Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlen,
     if (g_Config->LoadConfiguration())
         PRINT("Configurations", "The configurations has been succesfully loaded.\n");
     else
+    {
         PRINT("Configurations", "Failed to load configurations. The plugin will not work.\n");
+        return false;
+    }
 
     g_SMAPI->AddListener(this, this);
 
@@ -182,6 +186,9 @@ bool SwiftlyPlugin::Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlen,
     if (g_Config->FetchValue<bool>("core.console_filtering"))
         g_conFilter->Toggle();
 
+    if (!BeginCrashListener())
+        return false;
+
     PRINT("Components", "Loading components...\n");
 
     LOAD_COMPONENT(BasicComponent, basic_component);
@@ -289,7 +296,12 @@ void SwiftlyPlugin::Hook_GameServerSteamAPIActivated()
     RETURN_META(MRES_IGNORED);
 }
 
-std::string map;
+std::string map = "None";
+
+std::string SwiftlyPlugin::GetMap()
+{
+    return map;
+}
 
 void SwiftlyPlugin::OnLevelInit(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background)
 {

src/files/Files.cpp

@@ -78,7 +78,7 @@ void Files::Delete(std::string path)
     std::filesystem::remove(path);
 }
 
-void Files::Append(std::string path, std::string content)
+void Files::Append(std::string path, std::string content, bool hasdate)
 {
     ChangePath();
     std::filesystem::create_directories(Files::getBase(path));
@@ -91,12 +91,13 @@ void Files::Append(std::string path, std::string content)
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-Wformat-truncation"
 #endif
-    snprintf(date, sizeof(date), "[%02d/%02d/%04d - %02d:%02d:%02d] ", ltm->tm_mday, ltm->tm_mon + 1, ltm->tm_year + 1900, ltm->tm_hour, ltm->tm_min, ltm->tm_sec);
+    if (hasdate)
+        snprintf(date, sizeof(date), "[%02d/%02d/%04d - %02d:%02d:%02d] ", ltm->tm_mday, ltm->tm_mon + 1, ltm->tm_year + 1900, ltm->tm_hour, ltm->tm_min, ltm->tm_sec);
 #if GCC_COMPILER
 #pragma GCC diagnostic pop
 #endif
     std::ofstream File(path, std::ios_base::app);
-    File << date << content << std::endl;
+    File << (hasdate ? date : "") << content << std::endl;
     File.close();
 }
 
@@ -112,6 +113,12 @@ bool Files::IsDirectory(std::string path)
     return std::filesystem::is_directory(path);
 }
 
+bool Files::CreateDirectory(std::string path)
+{
+    ChangePath();
+    return std::filesystem::create_directory(path);
+}
+
 std::vector<std::string> Files::FetchFileNames(std::string path)
 {
     ChangePath();

src/files/Files.h

@@ -10,13 +10,14 @@
 namespace Files
 {
     std::string Read(std::string path);
-    void Append(std::string path, std::string content);
+    void Append(std::string path, std::string content, bool hasdate = true);
     void Delete(std::string path);
     std::string getBase(std::string filePath);
     bool ExistsPath(std::string path);
     bool IsDirectory(std::string path);
     std::vector<std::string> FetchFileNames(std::string path);
     std::vector<std::string> FetchDirectories(std::string path);
+    bool CreateDirectory(std::string path);
 };
 
 #endif