16552de05SJayanth Othayoth #pragma once 26552de05SJayanth Othayoth 3*2b30dea1SMarri Devender Rao #include "xyz/openbmc_project/Logging/Entry/server.hpp" 4*2b30dea1SMarri Devender Rao 52eb31ad2SJayanth Othayoth #include <phal_exception.H> 62eb31ad2SJayanth Othayoth 76552de05SJayanth Othayoth #include <nlohmann/json.hpp> 86552de05SJayanth Othayoth 96552de05SJayanth Othayoth #include <string> 106552de05SJayanth Othayoth #include <vector> 116552de05SJayanth Othayoth namespace openpower 126552de05SJayanth Othayoth { 136552de05SJayanth Othayoth namespace pel 146552de05SJayanth Othayoth { 156552de05SJayanth Othayoth using FFDCData = std::vector<std::pair<std::string, std::string>>; 166552de05SJayanth Othayoth 176552de05SJayanth Othayoth using json = nlohmann::json; 186552de05SJayanth Othayoth 192eb31ad2SJayanth Othayoth using namespace openpower::phal; 20*2b30dea1SMarri Devender Rao using Severity = sdbusplus::xyz::openbmc_project::Logging::server::Entry::Level; 216552de05SJayanth Othayoth /** 228fe9ff91SJayanth Othayoth * @brief Create PEL with additional parameters and callout 236552de05SJayanth Othayoth * 248fe9ff91SJayanth Othayoth * @param[in] event - the event type 256552de05SJayanth Othayoth * @param[in] calloutData - callout data to append to PEL 268fe9ff91SJayanth Othayoth * @param[in] ffdcData - failure data to append to PEL 276552de05SJayanth Othayoth */ 288fe9ff91SJayanth Othayoth void createErrorPEL(const std::string& event, const json& calloutData = {}, 298fe9ff91SJayanth Othayoth const FFDCData& ffdcData = {}); 306552de05SJayanth Othayoth 316552de05SJayanth Othayoth /** 32fe37aea0SJayanth Othayoth * @brief Create SBE boot error PEL and return id 332eb31ad2SJayanth Othayoth * 342eb31ad2SJayanth Othayoth * @param[in] event - the event type 352eb31ad2SJayanth Othayoth * @param[in] sbeError - SBE error object 362eb31ad2SJayanth Othayoth * @param[in] ffdcData - failure data to append to PEL 37*2b30dea1SMarri Devender Rao * @param[in] severity - severity of the log 38fe37aea0SJayanth Othayoth * @return Platform log id 392eb31ad2SJayanth Othayoth */ 40fe37aea0SJayanth Othayoth uint32_t createSbeErrorPEL(const std::string& event, const sbeError_t& sbeError, 41*2b30dea1SMarri Devender Rao const FFDCData& ffdcData, 42*2b30dea1SMarri Devender Rao const Severity severity = Severity::Error); 432eb31ad2SJayanth Othayoth 442eb31ad2SJayanth Othayoth /** 45a8d2f710SJayanth Othayoth * @brief Create a PEL for the specified event type and additional data 466552de05SJayanth Othayoth * 472eb31ad2SJayanth Othayoth * @param[in] event - the event type 48a8d2f710SJayanth Othayoth * @param[in] ffdcData - failure data to append to PEL 496552de05SJayanth Othayoth */ 50a8d2f710SJayanth Othayoth void createPEL(const std::string& event, const FFDCData& ffdcData = {}); 516552de05SJayanth Othayoth 526552de05SJayanth Othayoth /** 536552de05SJayanth Othayoth * @class FFDCFile 546552de05SJayanth Othayoth * @brief This class is used to create ffdc data file and to get fd 556552de05SJayanth Othayoth */ 566552de05SJayanth Othayoth class FFDCFile 576552de05SJayanth Othayoth { 586552de05SJayanth Othayoth public: 596552de05SJayanth Othayoth FFDCFile() = delete; 606552de05SJayanth Othayoth FFDCFile(const FFDCFile&) = delete; 616552de05SJayanth Othayoth FFDCFile& operator=(const FFDCFile&) = delete; 626552de05SJayanth Othayoth FFDCFile(FFDCFile&&) = delete; 636552de05SJayanth Othayoth FFDCFile& operator=(FFDCFile&&) = delete; 646552de05SJayanth Othayoth 656552de05SJayanth Othayoth /** 666552de05SJayanth Othayoth * Used to pass json object to create unique ffdc file by using 676552de05SJayanth Othayoth * passed json data. 686552de05SJayanth Othayoth */ 696552de05SJayanth Othayoth explicit FFDCFile(const json& pHALCalloutData); 706552de05SJayanth Othayoth 716552de05SJayanth Othayoth /** 726552de05SJayanth Othayoth * Used to remove created ffdc file. 736552de05SJayanth Othayoth */ 746552de05SJayanth Othayoth ~FFDCFile(); 756552de05SJayanth Othayoth 766552de05SJayanth Othayoth /** 776552de05SJayanth Othayoth * Used to get created ffdc file file descriptor id. 786552de05SJayanth Othayoth * 796552de05SJayanth Othayoth * @return file descriptor id 806552de05SJayanth Othayoth */ 816552de05SJayanth Othayoth int getFileFD() const; 826552de05SJayanth Othayoth 836552de05SJayanth Othayoth private: 846552de05SJayanth Othayoth /** 856552de05SJayanth Othayoth * Used to store callout ffdc data from passed json object. 866552de05SJayanth Othayoth */ 876552de05SJayanth Othayoth std::string calloutData; 886552de05SJayanth Othayoth 896552de05SJayanth Othayoth /** 906552de05SJayanth Othayoth * Used to store unique ffdc file name. 916552de05SJayanth Othayoth */ 926552de05SJayanth Othayoth std::string calloutFile; 936552de05SJayanth Othayoth 946552de05SJayanth Othayoth /** 956552de05SJayanth Othayoth * Used to store created ffdc file descriptor id. 966552de05SJayanth Othayoth */ 976552de05SJayanth Othayoth int fileFD; 986552de05SJayanth Othayoth 996552de05SJayanth Othayoth /** 1006552de05SJayanth Othayoth * Used to create ffdc file to pass PEL api for creating 1016552de05SJayanth Othayoth * pel records. 1026552de05SJayanth Othayoth * 1036552de05SJayanth Othayoth * @return NULL 1046552de05SJayanth Othayoth */ 1056552de05SJayanth Othayoth void prepareFFDCFile(); 1066552de05SJayanth Othayoth 1076552de05SJayanth Othayoth /** 1086552de05SJayanth Othayoth * Create unique ffdc file. 1096552de05SJayanth Othayoth * 1106552de05SJayanth Othayoth * @return NULL 1116552de05SJayanth Othayoth */ 1126552de05SJayanth Othayoth void createCalloutFile(); 1136552de05SJayanth Othayoth 1146552de05SJayanth Othayoth /** 1156552de05SJayanth Othayoth * Used write json object value into created file. 1166552de05SJayanth Othayoth * 1176552de05SJayanth Othayoth * @return NULL 1186552de05SJayanth Othayoth */ 1196552de05SJayanth Othayoth void writeCalloutData(); 1206552de05SJayanth Othayoth 1216552de05SJayanth Othayoth /** 1226552de05SJayanth Othayoth * Used set ffdc file seek position begining to consume by PEL 1236552de05SJayanth Othayoth * 1246552de05SJayanth Othayoth * @return NULL 1256552de05SJayanth Othayoth */ 1266552de05SJayanth Othayoth void setCalloutFileSeekPos(); 1276552de05SJayanth Othayoth 1286552de05SJayanth Othayoth /** 1296552de05SJayanth Othayoth * Used to remove created ffdc file. 1306552de05SJayanth Othayoth * 1316552de05SJayanth Othayoth * @return NULL 1326552de05SJayanth Othayoth */ 1336552de05SJayanth Othayoth void removeCalloutFile(); 1346552de05SJayanth Othayoth 1356552de05SJayanth Othayoth }; // FFDCFile end 1366552de05SJayanth Othayoth 1376552de05SJayanth Othayoth } // namespace pel 1386552de05SJayanth Othayoth } // namespace openpower 139