Add elog dump type to common create
This commit modifies the Elog BMC dump creation process
to utilize the common BMC dump creation interface. Elog
BMC dumps are a special type of dumps triggered upon the
logging of certain predefined set of error logs. These
dumps incorporate data based on the type of the error log.
If no error log type is specified, a default elog dump
will be generated. In the existing process, upon occurrence
of a predefined error log, the error log manager would
inform the dump manager via an internal DBus interface. Now,
with this change, the error log manager will request the
dump manager to create an Elog BMC dump that includes the
relevant error data, error type, and the object path of the
error log entry via the common create DBus interface.
Test:
Create an InternalFailure and sure dump is created
>busctl call xyz.openbmc_project.Logging \
/xyz/openbmc_project/logging \
xyz.openbmc_project.Logging.Create Create ssa{ss} \
xyz.openbmc_project.Common.Error.InternalFailure \
xyz.openbmc_project.Logging.Entry.Level.Error 0
Trace:
phosphor-dump-manager[542]: Initiating new BMC dump \
with type: elog path: /xyz/openbmc_project/logging/entry/12
phosphor-dump-manager[2918]: Report is available in \
/var/lib/phosphor-debug-collector/dumps/6
Change-Id: I734b052fc24e7893a61755790be49e8a1e594be5
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>
diff --git a/dump_utils.hpp b/dump_utils.hpp
index c3d9d36..953022e 100644
--- a/dump_utils.hpp
+++ b/dump_utils.hpp
@@ -5,11 +5,13 @@
#include <systemd/sd-event.h>
#include <unistd.h>
+#include <errors_map.hpp>
#include <phosphor-logging/elog-errors.hpp>
#include <phosphor-logging/elog.hpp>
#include <phosphor-logging/lg2.hpp>
#include <sdbusplus/bus.hpp>
#include <xyz/openbmc_project/Common/error.hpp>
+#include <xyz/openbmc_project/Dump/Create/common.hpp>
#include <xyz/openbmc_project/Dump/Create/server.hpp>
#include <xyz/openbmc_project/State/Boot/Progress/server.hpp>
#include <xyz/openbmc_project/State/Host/server.hpp>
@@ -356,5 +358,35 @@
return T{};
}
+/**
+ * @brief This function fetches the dump type associated with a particular
+ * error.
+ *
+ * @param[in] params The map of parameters passed as input.
+ *
+ * @return The dump type associated with the error. If no additional error type
+ * is specified a generic elog type dump will be generated.
+ */
+inline DumpTypes getErrorDumpType(phosphor::dump::DumpCreateParams& params)
+{
+ using CreateParameters =
+ sdbusplus::xyz::openbmc_project::Dump::server::Create::CreateParameters;
+ using DumpIntr = sdbusplus::common::xyz::openbmc_project::dump::Create;
+ DumpTypes dumpType = DumpTypes::ELOG;
+ std::string errorType = extractParameter<std::string>(
+ DumpIntr::convertCreateParametersToString(CreateParameters::ErrorType),
+ params);
+ const auto elogIt = errorMap.find(errorType);
+ if (elogIt != errorMap.end())
+ {
+ auto type = stringToDumpType(errorType);
+ if (type.has_value())
+ {
+ dumpType = type.value();
+ }
+ }
+ return dumpType;
+}
+
} // namespace dump
} // namespace phosphor