PEL: Add PEL Manager class
This class will have the logic for how to handle PELs. It will
also eventually provide D-Bus interfaces.
This first commit has stubs, plus some basic code to find if a PEL
is being passed in with the OpenBMC event log.
Signed-off-by: Matt Spinler <spinler@us.ibm.com>
Change-Id: I55a5da4d2239c688fded31c112895c3c92bab56d
diff --git a/extensions/openpower-pels/entry_points.cpp b/extensions/openpower-pels/entry_points.cpp
index 1b29ec5..5adeb40 100644
--- a/extensions/openpower-pels/entry_points.cpp
+++ b/extensions/openpower-pels/entry_points.cpp
@@ -1,6 +1,6 @@
#include "elog_entry.hpp"
#include "extensions.hpp"
-#include "sdbusplus/bus.hpp"
+#include "manager.hpp"
namespace openpower
{
@@ -9,10 +9,13 @@
using namespace phosphor::logging;
+std::unique_ptr<Manager> manager;
+
DISABLE_LOG_ENTRY_CAPS();
void pelStartup(internal::Manager& logManager)
{
+ manager = std::make_unique<Manager>(logManager);
}
REGISTER_EXTENSION_FUNCTION(pelStartup);
@@ -21,19 +24,21 @@
Entry::Level severity, const AdditionalDataArg& additionalData,
const AssociationEndpointsArg& assocs)
{
+ manager->create(message, id, timestamp, severity, additionalData, assocs);
}
REGISTER_EXTENSION_FUNCTION(pelCreate);
void pelDelete(uint32_t id)
{
+ return manager->erase(id);
}
REGISTER_EXTENSION_FUNCTION(pelDelete);
void pelDeleteProhibited(uint32_t id, bool& prohibited)
{
- prohibited = false;
+ prohibited = manager->isDeleteProhibited(id);
}
REGISTER_EXTENSION_FUNCTION(pelDeleteProhibited);
diff --git a/extensions/openpower-pels/manager.cpp b/extensions/openpower-pels/manager.cpp
new file mode 100644
index 0000000..3e22336
--- /dev/null
+++ b/extensions/openpower-pels/manager.cpp
@@ -0,0 +1,59 @@
+#include "manager.hpp"
+
+#include "additional_data.hpp"
+
+namespace openpower
+{
+namespace pels
+{
+
+using namespace phosphor::logging;
+
+namespace additional_data
+{
+constexpr auto rawPEL = "RAWPEL";
+}
+
+void Manager::create(const std::string& message, uint32_t obmcLogID,
+ uint64_t timestamp, Entry::Level severity,
+ const std::vector<std::string>& additionalData,
+ const std::vector<std::string>& associations)
+{
+ AdditionalData ad{additionalData};
+
+ // If a PEL was passed in, use that. Otherwise, create one.
+ auto rawPelPath = ad.getValue(additional_data::rawPEL);
+ if (rawPelPath)
+ {
+ addRawPEL(*rawPelPath, obmcLogID);
+ }
+ else
+ {
+ createPEL(message, obmcLogID, timestamp, severity, additionalData,
+ associations);
+ }
+}
+
+void Manager::addRawPEL(const std::string& rawPelPath, uint32_t obmcLogID)
+{
+}
+
+void Manager::erase(uint32_t obmcLogID)
+{
+}
+
+bool Manager::isDeleteProhibited(uint32_t obmcLogID)
+{
+ return false;
+}
+
+void Manager::createPEL(const std::string& message, uint32_t obmcLogID,
+ uint64_t timestamp,
+ phosphor::logging::Entry::Level severity,
+ const std::vector<std::string>& additionalData,
+ const std::vector<std::string>& associations)
+{
+}
+
+} // namespace pels
+} // namespace openpower
diff --git a/extensions/openpower-pels/manager.hpp b/extensions/openpower-pels/manager.hpp
new file mode 100644
index 0000000..e57be98
--- /dev/null
+++ b/extensions/openpower-pels/manager.hpp
@@ -0,0 +1,102 @@
+#pragma once
+
+#include "elog_entry.hpp"
+#include "log_manager.hpp"
+
+namespace openpower
+{
+namespace pels
+{
+
+using namespace phosphor::logging;
+
+/**
+ * @brief PEL manager object
+ */
+class Manager
+{
+ public:
+ Manager() = delete;
+ ~Manager() = default;
+ Manager(const Manager&) = default;
+ Manager& operator=(const Manager&) = default;
+ Manager(Manager&&) = default;
+ Manager& operator=(Manager&&) = default;
+
+ /**
+ * @brief constructor
+ *
+ * @param[in] logManager - internal::Manager object
+ */
+ explicit Manager(internal::Manager& logManager) : _logManager(logManager)
+ {
+ }
+
+ /**
+ * @brief Creates a PEL based on the OpenBMC event log contents. If
+ * a PEL was passed in via the RAWPEL specifier in the
+ * additionalData parameter, use that instead.
+ *
+ * @param[in] message - the event log message property
+ * @param[in] obmcLogID - the corresponding OpenBMC event log id
+ * @param[in] timestamp - the Timestamp property
+ * @param[in] severity - the event log severity
+ * @param[in] additionalData - the AdditionalData property
+ * @param[in] associations - the Associations property
+ */
+ void create(const std::string& message, uint32_t obmcLogID,
+ uint64_t timestamp, Entry::Level severity,
+ const std::vector<std::string>& additionalData,
+ const std::vector<std::string>& associations);
+
+ /**
+ * @brief Erase a PEL based on its OpenBMC event log ID
+ *
+ * @param[in] obmcLogID - the corresponding OpenBMC event log id
+ */
+ void erase(uint32_t obmcLogID);
+
+ /** @brief Says if an OpenBMC event log may not be manually deleted at this
+ * time because its corresponding PEL cannot be.
+ *
+ * There are PEL retention policies that can prohibit the manual deletion
+ * of PELs (and therefore OpenBMC event logs).
+ *
+ * @param[in] obmcLogID - the OpenBMC event log ID
+ * @return bool - true if prohibited
+ */
+ bool isDeleteProhibited(uint32_t obmcLogID);
+
+ private:
+ /**
+ * @brief Adds a received raw PEL to the PEL repository
+ *
+ * @param[in] rawPelPath - The path to the file that contains the
+ * raw PEL.
+ * @param[in] obmcLogID - the corresponding OpenBMC event log id
+ */
+ void addRawPEL(const std::string& rawPelPath, uint32_t obmcLogID);
+
+ /**
+ * @brief Creates a PEL based on the OpenBMC event log contents.
+ *
+ * @param[in] message - The event log message property
+ * @param[in] obmcLogID - the corresponding OpenBMC event log id
+ * @param[in] timestamp - The timestamp property
+ * @param[in] severity - The event log severity
+ * @param[in] additionalData - The AdditionalData property
+ * @param[in] associations - The associations property
+ */
+ void createPEL(const std::string& message, uint32_t obmcLogID,
+ uint64_t timestamp, Entry::Level severity,
+ const std::vector<std::string>& additionalData,
+ const std::vector<std::string>& associations);
+
+ /**
+ * @brief Reference to phosphor-logging's Manager class
+ */
+ internal::Manager& _logManager;
+};
+
+} // namespace pels
+} // namespace openpower
diff --git a/extensions/openpower-pels/openpower-pels.mk b/extensions/openpower-pels/openpower-pels.mk
index 717fdca..1030171 100644
--- a/extensions/openpower-pels/openpower-pels.mk
+++ b/extensions/openpower-pels/openpower-pels.mk
@@ -1,3 +1,4 @@
phosphor_log_manager_SOURCES += \
- extensions/openpower-pels/entry_points.cpp
+ extensions/openpower-pels/entry_points.cpp \
+ extensions/openpower-pels/manager.cpp