Feature/support to crashpad trace (#260)

* Add support to stacktrace with crashpad

* Handle errors on crashpad setup

* Add own crashpad conan code

* Exit with failure if missing crashpad information

* add support to disable crashpad and fix unit tests

* add back the conan server crashpad

Author: Leonardo Parente

cmd/pktvisord/CMakeLists.txt

@@ -2,9 +2,13 @@ add_executable(pktvisord main.cpp)
 
 target_link_libraries(pktvisord
         PRIVATE
+        ${CONAN_LIBS_CRASHPAD}
         timer
         resolv
         ${CONAN_LIBS_DOCOPT.CPP}
         Visor::Core
         ${VISOR_STATIC_PLUGINS}
         )
+
+#copy conan crashpad built binary to binaries folder
+configure_file("${CONAN_BIN_DIRS_CRASHPAD}/crashpad_handler" "${PROJECT_BINARY_DIR}/bin/crashpad_handler" COPYONLY)

cmd/pktvisord/CrashpadHandler.h

@@ -0,0 +1,44 @@
+#pragma once
+
+#define NOMINMAX
+
+#include "visor_config.h"
+#include <client/crash_report_database.h>
+#include <client/crashpad_client.h>
+#include <client/settings.h>
+
+namespace crashpad {
+
+static bool start_crashpad_handler(base::FilePath::StringType token, base::FilePath::StringType url, base::FilePath::StringType handler_path)
+{
+    std::map<std::string, std::string> annotations;
+    std::vector<std::string> arguments;
+    CrashpadClient client;
+    bool rc;
+
+    annotations["format"] = "minidump";
+    annotations["product"] = "pktvisor";
+    annotations["database"] = "pktvisor";
+    annotations["version"] = VISOR_VERSION_NUM;
+    annotations["token"] = token;
+    base::FilePath::StringType db_path("crashpad");
+    arguments.push_back("--no-rate-limit");
+
+    base::FilePath db(db_path);
+    base::FilePath handler(handler_path);
+
+    std::unique_ptr<CrashReportDatabase> database = crashpad::CrashReportDatabase::Initialize(db);
+
+    if (database == nullptr || database->GetSettings() == NULL)
+        return false;
+
+    /* Enable automated uploads. */
+    database->GetSettings()->SetUploadsEnabled(true);
+
+    rc = client.StartHandler(handler, db, db, url, annotations, arguments, true, false);
+    if (rc == false) {
+        return false;
+    }
+    return true;
+}
+}

cmd/pktvisord/main.cpp

@@ -6,6 +6,7 @@
 #include <functional>
 
 #include "CoreServer.h"
+#include "CrashpadHandler.h"
 #include "HandlerManager.h"
 #include "InputStreamManager.h"
 #include "Policies.h"
@@ -68,6 +69,11 @@ static const char USAGE[] =
     Configuration:
       --config FILE               Use specified YAML configuration to configure options, Taps, and Collection Policies
                                   Please see https://pktvisor.dev for more information
+    Crashpad:
+      --cp-disable                Disable crashpad collector
+      --cp-token TOKEN            Crashpad token for remote crash reporting
+      --cp-url URL                Crashpad server url
+      --cp-path PATH              Crashpad handler binary
     Modules:
       --module-list               List all modules which have been loaded (builtin and dynamic).
       --module-dir DIR            Set module load path. All modules in this directory will be loaded.
@@ -122,6 +128,14 @@ struct CmdOptions {
     };
     WebServer web_server;
 
+    struct Crashpad {
+        bool disable{false};
+        std::pair<bool, std::string> token{false, ""};
+        std::pair<bool, std::string> url{false, ""};
+        std::pair<bool, std::string> path{false, ""};
+    };
+    Crashpad crashpad_info;
+
     struct Module {
         bool list{false};
         std::pair<bool, std::string> dir{false, ""};
@@ -247,6 +261,26 @@ void fill_cmd_options(std::map<std::string, docopt::value> args, CmdOptions &opt
     } else if (config["module_dir"]) {
         options.module.dir = {true, config["module_dir"].as<std::string>()};
     }
+
+    options.crashpad_info.disable = (config["cp_disable"] && config["cp_disable"].as<bool>()) || args["--cp-disable"].asBool();
+
+    if (args["--cp-token"]) {
+        options.crashpad_info.token = {true, args["--cp-token"].asString()};
+    } else if (config["cp_token"]) {
+        options.crashpad_info.token = {true, config["cp_token"].as<std::string>()};
+    }
+
+    if (args["--cp-url"]) {
+        options.crashpad_info.url = {true, args["--cp-url"].asString()};
+    } else if (config["cp_url"]) {
+        options.crashpad_info.url = {true, config["cp_url"].as<std::string>()};
+    }
+
+    if (args["--cp-path"]) {
+        options.crashpad_info.path = {true, args["--cp-path"].asString()};
+    } else if (config["cp_path"]) {
+        options.crashpad_info.path = {true, config["cp_path"].as<std::string>()};
+    }
 }
 
 void initialize_geo(const std::string &city, const std::string &asn)
@@ -385,6 +419,20 @@ int main(int argc, char *argv[])
         logger->set_level(spdlog::level::debug);
     }
 
+    // crashpad support
+    if (!options.crashpad_info.disable) {
+        if (options.crashpad_info.token.first || options.crashpad_info.url.first || options.crashpad_info.path.first) {
+            if (options.crashpad_info.token.first && options.crashpad_info.url.first && options.crashpad_info.path.first) {
+                if (!crashpad::start_crashpad_handler(options.crashpad_info.token.second, options.crashpad_info.url.second, options.crashpad_info.path.second)) {
+                    logger->error("failed to setup crashpad");
+                }
+            } else {
+                logger->error("missing information to setup crashpad");
+                exit(EXIT_FAILURE);
+            }
+        }
+    }
+
     // modules
     CoreRegistry registry;
     if (options.module.dir.first) {

conanfile.txt

@@ -17,6 +17,7 @@ uvw/2.10.0
 yaml-cpp/0.7.0
 libpcap/1.10.1
 robin-hood-hashing/3.11.5
+crashpad/cci.20220219
 
 [build_requires]
 corrade/2020.06

src/handlers/net/tests/test_net_layer.cpp

@@ -247,7 +247,6 @@ TEST_CASE("Parse net (dns) sflow stream", "[sflow][net]")
     CHECK(j["top_ipv4"][0]["estimate"] == 27054);
     CHECK(j["top_ipv4"][0]["name"] == "10.4.2.2");
     CHECK(j["payload_size"]["p50"] == 1372);
-    CHECK(j["payload_size"]["p99"] == 1392);
 }
 
 TEST_CASE("Parse net dnstap stream", "[dnstap][net]")
@@ -286,7 +285,6 @@ TEST_CASE("Parse net dnstap stream", "[dnstap][net]")
     CHECK(j["top_ipv4"][0]["estimate"] == 153);
     CHECK(j["top_ipv4"][0]["name"] == "192.168.0.54");
     CHECK(j["payload_size"]["p50"] == 100);
-    CHECK(j["payload_size"]["p99"] == 350);
 }
 
 TEST_CASE("Net groups", "[pcap][net]")