dump-collect: Add application for SBE dump collection
This series of commits introduces the `dump-collect` application, a new
command-line tool designed to facilitate the collection of dumps from
the SBE. The tool is capable of asynchronous operation, allowing it
to initiate dump collection from different SBEs at the same time.
Key Highlights:
- The base implementation sets up the application to accept necessary
parameters for dump collection, including dump type, dump ID,
destination path for collected data, and the ID of the failing unit.
- An implementation of the dump collection class and the initiation
method enables the start of the dump collection process
asynchronously.
- The `dump-collect` application is designed to be invoked from scripts,
which collect various data in the case of system failures.
Tests:
Validated parameters passed
Starting dump collection method
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>
Change-Id: If6f44075d33af20e09a442d7968d235dc6e8ea16
diff --git a/dump/dump_collect_main.cpp b/dump/dump_collect_main.cpp
new file mode 100644
index 0000000..c77b089
--- /dev/null
+++ b/dump/dump_collect_main.cpp
@@ -0,0 +1,82 @@
+#include "sbe_consts.hpp"
+#include "sbe_dump_collector.hpp"
+
+#include <CLI/App.hpp>
+#include <CLI/Config.hpp>
+#include <CLI/Formatter.hpp>
+
+#include <filesystem>
+#include <iostream>
+
+int main(int argc, char** argv)
+{
+ using namespace openpower::dump::sbe_chipop;
+ using std::filesystem::path;
+ using namespace openpower::dump::SBE;
+
+ CLI::App app{"Dump Collector Application", "dump-collect"};
+ app.description(
+ "Collects dumps from the Self Boot Engine (SBE) based on "
+ "provided parameters.\nSupports different types of dumps and requires "
+ "specific options based on the dump type.");
+
+ int type = 0;
+ uint32_t id;
+ std::string pathStr;
+ std::optional<uint64_t> failingUnit;
+
+ app.add_option("--type, -t", type, "Type of the dump")
+ ->required()
+ ->check(
+ CLI::IsMember({SBE_DUMP_TYPE_HARDWARE, SBE_DUMP_TYPE_HOSTBOOT}));
+
+ app.add_option("--id, -i", id, "ID of the dump")->required();
+
+ app.add_option("--path, -p", pathStr,
+ "Path to store the collected dump files")
+ ->required();
+
+ app.add_option("--failingunit, -f", failingUnit, "ID of the failing unit");
+
+ try
+ {
+ CLI11_PARSE(app, argc, argv);
+ }
+ catch (const CLI::ParseError& e)
+ {
+ return app.exit(e);
+ }
+
+ if (type == SBE_DUMP_TYPE_HARDWARE && !failingUnit.has_value())
+ {
+ std::cerr << "Failing unit ID is required for Hardware type dumps\n";
+ return EXIT_FAILURE;
+ }
+
+ // Directory creation should happen here, after successful parsing
+ std::filesystem::path dirPath{pathStr};
+ if (!std::filesystem::exists(dirPath))
+ {
+ std::filesystem::create_directories(dirPath);
+ }
+
+ SbeDumpCollector dumpCollector;
+
+ auto failingUnitId = 0xFFFFFF; // Default or unspecified value
+ if (failingUnit.has_value())
+ {
+ failingUnitId = failingUnit.value();
+ }
+
+ try
+ {
+ dumpCollector.collectDump(type, id, failingUnitId, pathStr);
+ }
+ catch (const std::exception& e)
+ {
+ std::cerr << "Failed to collect dump: " << e.what() << std::endl;
+ std::exit(EXIT_FAILURE);
+ }
+
+ return 0;
+}