extensions/openpower-pels/manager.hpp

11 #include "pel.hpp"
15 #include <org/open_power/Logging/PEL/Entry/server.hpp>
16 #include <org/open_power/Logging/PEL/server.hpp>
28     sdbusplus::org::open_power::Logging::server::PEL>;
31  * @brief PEL manager object
102      * @brief Creates a PEL based on the OpenBMC event log contents.  If
103      *        a PEL was passed in via the RAWPEL specifier in the
122      * @brief Erase a PEL based on its OpenBMC event log ID
137      *         time because its corresponding PEL cannot be.
139      * There are PEL retention policies that can prohibit the manual deletion
148      * @brief Return a file descriptor to the raw PEL data
150      * Throws InvalidArgument if the PEL ID isn't found,
153      * @param[in] pelID - The PEL ID to get the data for
155      * @return unix_fd - File descriptor to the file that contains the PEL
160      * @brief Returns data for the PEL corresponding to an OpenBMC
165      * @return vector<uint8_t> - The raw PEL data
171      *        a PEL.
174      * 'Ack PEL' PLDM message from the host, which indicates the host
178      * @param[in] pelID - The PEL ID
183      * @brief D-Bus method called when the host rejects a PEL.
186      * 'Ack PEL' PLDM message from the host with a payload that says
191      *  * Malrformed PEL - The host received an invalid PEL
193      * @param[in] pelID - The PEL ID
199      * @brief D-Bus method to create a PEL/OpenBMC event log and
200      *        return the created OpenBMC and PEL log IDs.
220      * @brief D-Bus method to return the PEL in JSON format
224      * @return std::string - The fully parsed PEL in JSON
230      *        vector of uint8_ts that just contains the PEL data.
238      * @return std::vector<uint8_t> - The contained PEL data
243      * @brief Generate resolution string from the PEL
245      * @param[in] pel - The PEL to use
247     std::string getResolution(const openpower::pels::PEL& pel) const;
250      * @brief Generate event ID from the PEL
252      * @param[in] pel - The PEL to use
254     std::string getEventId(const openpower::pels::PEL& pel) const;
258      *  Returns the PEL Id (aka Entry ID (EID)) based on the given
261      *  @param[in] bmcLogId - The BMC event log id of the PEL to retrieve
262      *                        the PEL id.
264      *  @return uint32_t - The Id of the PEL.
271      *  Returns the BMC event log id based on the given PEL id
274      *  @param[in] pelId - The PEL id to retrieve the BMC event log id.
276      *  @return uint32_t - The BMC event log id of the PEL.
284      * @param[in] pel - The PEL to use
286     void updateProgressSRC(std::unique_ptr<openpower::pels::PEL>& pel) const;
301      * @brief Adds a received raw PEL to the PEL repository
304      *                         raw PEL.
310      * @brief Creates a PEL based on the OpenBMC event log contents.
348      * @brief Adds a PEL to the repository given its data
350      * @param[in] pelData - The PEL to add as a vector of uint8_ts
356      * @brief Adds the PEL stored in the ESEL field of the AdditionalData
366      *        structure understood by the PEL code.
370      * @return PelFFDC - The PEL FFDC data structure
375      * @brief Schedules a PEL repository prune to occur from
392      * @brief Sets up an inotify watch to watch for deleted PEL
399      *        detects a PEL file was deleted.
401      * Will tell the Repository class about the deleted PEL, and then tell
407      * @brief Check if the input PEL should cause a quiesce of the system
409      * If QuiesceOnHwError is enabled within phosphor-settings and the PEL
413      * @param[in] pel - The PEL to check
415     void checkPelAndQuiesce(std::unique_ptr<openpower::pels::PEL>& pel);
421      * PEL created
423      * @param[in] pel - The PEL to use
425     void updateEventId(std::unique_ptr<openpower::pels::PEL>& pel);
434      * @brief Sets the FilePath of the specified error log entry to the PEL file
442      * @brief Sets the serviceProviderNotify D-bus property of PEL.
451      * Update the resolution property of D-bus with callouts extracted from PEL
453      * @param[in] pel - The PEL to use
457     bool updateResolution(const openpower::pels::PEL& pel);
461      *        needs to be updated based on the final PEL severity,
464      * @param[in] pel - The PEL to operate on.
466     void updateDBusSeverity(const openpower::pels::PEL& pel);
496      * @brief Clears the deconfig flag in the PEL if necessary.
498      * If the passed in location code is in a callout and it's a PEL with
502      * @param[inout] pel - The PEL to check and modify.
503      * @return bool - true if the flag was cleared for this PEL
506                                               openpower::pels::PEL& pel);
512      * Clears the 'Deconfig' flag in any PEL that has the location code
526      *        the PEL extension code
531      * @brief The PEL repository object
536      * @brief The PEL message registry object
546      * @brief The API the PEL sections use to gather data
556      * @brief The map used to keep track of PEL entry pointer associated with
561                  sdbusplus::server::org::open_power::logging::pel::Entry>>
571      * @brief The event source for closing a PEL file descriptor after
584      *        Used when its corresponding PEL is invalid.
589      * @brief The even source for watching for deleted PEL files.
595      *        for watching for deleted PEL files.