feat(crashreporter): Call Stack

Author: skuzzis

.vscode/settings.json

@@ -78,6 +78,7 @@
         "cinttypes": "cpp",
         "typeindex": "cpp",
         "typeinfo": "cpp",
-        "variant": "cpp"
+        "variant": "cpp",
+        "expected": "cpp"
     }
 }

src/commands/Command.cpp

@@ -1,10 +1,11 @@
 #include "Command.h"
 
+#include "../crashreporter/CallStack.h"
 #include "../plugins/PluginManager.h"
 
 Command::~Command()
 {
-    Plugin *plugin = g_pluginManager->FetchPlugin(this->m_pluginName);
+    Plugin* plugin = g_pluginManager->FetchPlugin(this->m_pluginName);
     if (!plugin)
         return;
 
@@ -16,10 +17,11 @@ Command::~Command()
 
 void Command::Execute(int slot, std::vector<std::string> args, bool silent, std::string prefix)
 {
+    REGISTER_CALLSTACK(this->m_pluginName, string_format("Command::Execute(command_name=\"%s\",slot=%d,args=\"%s\",silent=%d,prefix=\"%s\")", this->m_commandName.c_str(), slot, implode(args, " ").c_str(), silent, prefix.c_str()));
     if (this->m_funcPtr == nullptr)
         return;
 
-    Plugin *plugin = g_pluginManager->FetchPlugin(this->m_pluginName);
+    Plugin* plugin = g_pluginManager->FetchPlugin(this->m_pluginName);
     if (!plugin)
         return;
 

src/crashreporter/CallStack.cpp

@@ -0,0 +1,30 @@
+#include "CallStack.h"
+#include "../utils/utils.h"
+
+std::string CallStack::RegisterPluginCallstack(std::string plugin_name, std::string stackMsg)
+{
+    std::string stackID = get_uuid();
+    if (callStacks.find(plugin_name) == callStacks.end())
+        callStacks.insert({ plugin_name, {} });
+
+    while (callStacks[plugin_name].find(stackID) != callStacks[plugin_name].end())
+        stackID = get_uuid();
+
+    callStacks[plugin_name].insert({ stackID, stackMsg });
+
+    return stackID;
+}
+void CallStack::UnregisterPluginCallstack(std::string plugin_name, std::string stackID)
+{
+    if (callStacks.find(plugin_name) == callStacks.end()) return;
+    if (callStacks[plugin_name].find(stackID) == callStacks[plugin_name].end()) return;
+
+    callStacks[plugin_name].erase(stackID);
+}
+
+std::unordered_map<std::string, std::string> CallStack::GetPluginCallstack(std::string plugin_name)
+{
+    if (callStacks.find(plugin_name) == callStacks.end()) return {};
+
+    return callStacks[plugin_name];
+}

src/crashreporter/CallStack.h

@@ -0,0 +1,26 @@
+#ifndef _callstack_h
+#define _callstack_h
+
+#include <string>
+#include <map>
+#include <unordered_map>
+#include "RegisterCallStack.h"
+
+#define REGISTER_CALLSTACK(plugin_name, stack_str) RegisterCallStack OUIERGBNHI9U43HBG98734VHBW9(plugin_name, stack_str)
+
+class CallStack
+{
+private:
+    std::map<std::string, std::unordered_map<std::string, std::string>> callStacks;
+public:
+    CallStack() = default;
+
+    std::string RegisterPluginCallstack(std::string plugin_name, std::string stackMsg);
+    void UnregisterPluginCallstack(std::string plugin_name, std::string stackID);
+
+    std::unordered_map<std::string, std::string> GetPluginCallstack(std::string plugin_name);
+};
+
+extern CallStack* g_callStack;
+
+#endif

src/crashreporter/CrashReport.cpp

@@ -23,60 +23,62 @@ bool BeginCrashListener() { return true; }
 #include "../files/Files.h"
 #include "../common.h"
 #include "../entrypoint.h"
+#include "../plugins/PluginManager.h"
+#include "CallStack.h"
 
 std::string startup_cmd = "None";
 
-const char *ws = " \t\n\r\f\v";
+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)
+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)
+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)
+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];
+    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);
+    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;
+            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 - 1, callstack[i],
-                     status == 0 ? demangled : info.dli_sname == 0 ? symbols[i]
-                                                                   : info.dli_sname,
-                     (char *)callstack[i] - (char *)info.dli_saddr);
+                i - 1, 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 - 1, callstack[i], symbols[i]);
+                i - 1, callstack[i], symbols[i]);
         }
         trace_buf << buf;
     }
@@ -97,11 +99,11 @@ TextTable GetBacktrace()
     backtraceTable.add(" Address ");
     backtraceTable.endOfRow();
 
-    void *callstack[128];
+    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);
+    char** symbols = backtrace_symbols(callstack, nFrames);
 
     for (int i = 2; i < nFrames; i++)
     {
@@ -113,13 +115,13 @@ TextTable GetBacktrace()
         Dl_info info;
         if (dladdr(callstack[i], &info) && info.dli_sname)
         {
-            char *demangled = NULL;
+            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);
+                : info.dli_sname);
 
             backtraceTable.add(string_format(" %s ", (funcName.size() > 36 ? (funcName.substr(0, 33) + "...") : funcName).c_str()));
             free(demangled);
@@ -136,11 +138,27 @@ TextTable GetBacktrace()
     return backtraceTable;
 }
 
+std::string WritePluginsCallStack()
+{
+    std::string callstacks = "";
+    for (Plugin* plugin : g_pluginManager->GetPluginsList()) {
+        auto callstack = g_callStack->GetPluginCallstack(plugin->GetName());
+        if (callstack.size() > 0) {
+            callstacks += string_format("Plugin %s:\n", plugin->GetName().c_str());
+            for (auto it = callstack.begin(); it != callstack.end(); ++it)
+                callstacks += string_format("    - %s\n", it->second.c_str());
+
+            callstacks += "\n";
+        }
+    }
+    return callstacks;
+}
+
 void signal_handler(int signumber)
 {
     try
     {
-        void *tracePointers[20];
+        void* tracePointers[20];
         size_t count = backtrace(tracePointers, 20);
 
         PLUGIN_PRINTF("Crash Reporter", "A crash has occured and a dump has been created:\n");
@@ -153,10 +171,10 @@ void signal_handler(int signumber)
         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);
+        Files::Append(file_path, string_format("================================\nCommand: %s\nMap: %s\n================================\n\n%s\n%s", startup_cmd.c_str(), engine->GetServerGlobals() ? engine->GetServerGlobals()->mapname.ToCStr() : "None", backtraceData.c_str(), WritePluginsCallStack().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)
+    catch (const std::runtime_error& e)
     {
         PLUGIN_PRINTF("Crash Reporter", "Error crash handling: %s\n", e.what());
     }

src/crashreporter/RegisterCallStack.cpp

@@ -0,0 +1,12 @@
+#include "CallStack.h"
+#include "RegisterCallStack.h"
+
+RegisterCallStack::RegisterCallStack(std::string plugin_name, std::string stack_msg)
+{
+    this->plugin_name = plugin_name;
+    this->id = g_callStack->RegisterPluginCallstack(plugin_name, stack_msg);
+}
+RegisterCallStack::~RegisterCallStack()
+{
+    g_callStack->UnregisterPluginCallstack(plugin_name, this->id);
+}

src/crashreporter/RegisterCallStack.h

@@ -0,0 +1,17 @@
+#ifndef _registercallstack_h
+#define _registercallstack_h
+
+#include <string>
+
+class RegisterCallStack
+{
+private:
+    std::string plugin_name;
+    std::string id;
+
+public:
+    RegisterCallStack(std::string plugin_name, std::string stack_msg);
+    ~RegisterCallStack();
+};
+
+#endif