PHAL: dump utility functions support
Added dump utility function to create and watch dump
progress for SBE type dumps.
Signed-off-by: Jayanth Othayoth <ojayanth@in.ibm.com>
Change-Id: Ieef2231340aab9ed09aa677dcabdcf4c3b066645
diff --git a/extensions/phal/dump_utils.cpp b/extensions/phal/dump_utils.cpp
new file mode 100644
index 0000000..6356de1
--- /dev/null
+++ b/extensions/phal/dump_utils.cpp
@@ -0,0 +1,171 @@
+#include "dump_utils.hpp"
+
+#include "util.hpp"
+
+#include <fmt/format.h>
+
+#include <phosphor-logging/log.hpp>
+#include <sdbusplus/bus.hpp>
+#include <sdbusplus/exception.hpp>
+#include <sdbusplus/server.hpp>
+
+namespace openpower::phal::dump
+{
+
+using namespace phosphor::logging;
+
+/**
+ * Callback for dump request properties change signal monitor
+ *
+ * @param[in] msg Dbus message from the dbus match infrastructure
+ * @param[in] path The object path we are monitoring
+ * @param[out] inProgress Used to break out of our dbus wait loop
+ * @reutn Always non-zero indicating no error, no cascading callbacks
+ */
+uint32_t dumpStatusChanged(sdbusplus::message::message& msg,
+ const std::string& path, bool& inProgress)
+{
+ // reply (msg) will be a property change message
+ std::string interface;
+ std::map<std::string, std::variant<std::string, uint8_t>> property;
+ msg.read(interface, property);
+
+ // looking for property Status changes
+ std::string propertyType = "Status";
+ auto dumpStatus = property.find(propertyType);
+
+ if (dumpStatus != property.end())
+ {
+ const std::string* status =
+ std::get_if<std::string>(&(dumpStatus->second));
+
+ if ((nullptr != status) && ("xyz.openbmc_project.Common.Progress."
+ "OperationStatus.InProgress" != *status))
+ {
+ // dump is done, trace some info and change in progress flag
+ log<level::INFO>(fmt::format("Dump status({}) : path={}",
+ status->c_str(), path.c_str())
+ .c_str());
+ inProgress = false;
+ }
+ }
+
+ return 1; // non-negative return code for successful callback
+}
+
+/**
+ * Register a callback for dump progress status changes
+ *
+ * @param[in] path The object path of the dump to monitor
+ * @param timeout - timeout - timeout interval in seconds
+ */
+void monitorDump(const std::string& path, const uint32_t timeout)
+{
+ bool inProgress = true; // callback will update this
+
+ // setup the signal match rules and callback
+ std::string matchInterface = "xyz.openbmc_project.Common.Progress";
+ auto bus = sdbusplus::bus::new_system();
+
+ std::unique_ptr<sdbusplus::bus::match_t> match =
+ std::make_unique<sdbusplus::bus::match_t>(
+ bus,
+ sdbusplus::bus::match::rules::propertiesChanged(
+ path.c_str(), matchInterface.c_str()),
+ [&](auto& msg) {
+ return dumpStatusChanged(msg, path, inProgress);
+ });
+
+ // wait for dump status to be completed (complete == true)
+ // or until timeout interval
+ log<level::INFO>("dump requested (waiting)");
+ bool timedOut = false;
+ uint32_t secondsCount = 0;
+ while ((true == inProgress) && !timedOut)
+ {
+ bus.wait(std::chrono::seconds(1));
+ bus.process_discard();
+
+ if (++secondsCount == timeout)
+ {
+ timedOut = true;
+ }
+ }
+ if (timedOut)
+ {
+ log<level::ERR>("Dump progress status did not change to "
+ "complete within the timeout interval, exiting...");
+ }
+}
+
+void requestDump(const DumpParameters& dumpParameters)
+{
+ log<level::INFO>(fmt::format("Requesting Dump PEL({}) Index({})",
+ dumpParameters.logId, dumpParameters.unitId)
+ .c_str());
+
+ constexpr auto path = "/org/openpower/dump";
+ constexpr auto interface = "xyz.openbmc_project.Dump.Create";
+ constexpr auto function = "CreateDump";
+
+ sdbusplus::message::message method;
+
+ auto bus = sdbusplus::bus::new_default();
+
+ try
+ {
+ std::string service = util::getService(bus, path, interface);
+ auto method =
+ bus.new_method_call(service.c_str(), path, interface, function);
+
+ // dbus call arguments
+ std::map<std::string, std::variant<std::string, uint64_t>> createParams;
+ createParams["com.ibm.Dump.Create.CreateParameters.ErrorLogId"] =
+ uint64_t(dumpParameters.logId);
+ if (DumpType::SBE == dumpParameters.dumpType)
+ {
+ createParams["com.ibm.Dump.Create.CreateParameters.DumpType"] =
+ "com.ibm.Dump.Create.DumpType.SBE";
+ createParams["com.ibm.Dump.Create.CreateParameters.FailingUnitId"] =
+ dumpParameters.unitId;
+ }
+ method.append(createParams);
+
+ auto response = bus.call(method);
+
+ // reply will be type dbus::ObjectPath
+ sdbusplus::message::object_path reply;
+ response.read(reply);
+
+ // monitor dump progress
+ monitorDump(reply, dumpParameters.timeout);
+ }
+ catch (const sdbusplus::exception::exception& e)
+ {
+ log<level::ERR>(fmt::format("D-Bus call createDump exception",
+ "OBJPATH={}, INTERFACE={}, EXCEPTION={}",
+ path, interface, e.what())
+ .c_str());
+ constexpr auto ERROR_DUMP_DISABLED =
+ "xyz.openbmc_project.Dump.Create.Error.Disabled";
+ if (e.name() == ERROR_DUMP_DISABLED)
+ {
+ // Dump is disabled, Skip the dump collection.
+ log<level::INFO>(
+ fmt::format("Dump is disabled on({}), skipping dump collection",
+ dumpParameters.unitId)
+ .c_str());
+ }
+ else
+ {
+ throw std::runtime_error(
+ "Error in invoking D-Bus createDump interface");
+ }
+ }
+ catch (const std::exception& e)
+ {
+ throw e;
+ }
+}
+
+} // namespace openpower::phal::dump
diff --git a/extensions/phal/dump_utils.hpp b/extensions/phal/dump_utils.hpp
new file mode 100644
index 0000000..91377f2
--- /dev/null
+++ b/extensions/phal/dump_utils.hpp
@@ -0,0 +1,35 @@
+#include <cstdint>
+
+#pragma once
+
+namespace openpower::phal::dump
+{
+
+constexpr auto SBE_DUMP_TIMEOUT = 4 * 60; // Timeout in seconds
+
+/** @brief Dump types supported by dump request */
+enum class DumpType
+{
+ SBE
+};
+
+/** @brief Structure for dump request parameters */
+struct DumpParameters
+{
+ uint32_t logId;
+ uint32_t unitId;
+ uint32_t timeout;
+ DumpType dumpType;
+};
+
+/**
+ * Request a dump from the dump manager
+ *
+ * Request a dump from the dump manager and register a monitor for observing
+ * the dump progress.
+ *
+ * @param dumpParameters Parameters for the dump request
+ */
+void requestDump(const DumpParameters& dumpParameters);
+
+} // namespace openpower::phal::dump
diff --git a/meson.build b/meson.build
index 4d52f5c..e31f0c7 100644
--- a/meson.build
+++ b/meson.build
@@ -89,6 +89,7 @@
'extensions/phal/pdbg_utils.cpp',
'extensions/phal/create_pel.cpp',
'extensions/phal/phal_error.cpp',
+ 'extensions/phal/dump_utils.cpp',
]
extra_dependencies += [
dependency('libdt-api'),