189fa082aSMatt Spinler #pragma once 289fa082aSMatt Spinler #include "bcd_time.hpp" 389fa082aSMatt Spinler #include "pel.hpp" 489fa082aSMatt Spinler 589fa082aSMatt Spinler #include <algorithm> 60ff00485SMatt Spinler #include <bitset> 789fa082aSMatt Spinler #include <filesystem> 8475e574dSMatt Spinler #include <map> 989fa082aSMatt Spinler 1089fa082aSMatt Spinler namespace openpower 1189fa082aSMatt Spinler { 1289fa082aSMatt Spinler namespace pels 1389fa082aSMatt Spinler { 1489fa082aSMatt Spinler 1589fa082aSMatt Spinler /** 1689fa082aSMatt Spinler * @class Repository 1789fa082aSMatt Spinler * 1889fa082aSMatt Spinler * The class handles saving and retrieving PELs on the BMC. 1989fa082aSMatt Spinler */ 2089fa082aSMatt Spinler class Repository 2189fa082aSMatt Spinler { 2289fa082aSMatt Spinler public: 23475e574dSMatt Spinler /** 240ff00485SMatt Spinler * @brief Structure of commonly used PEL attributes. 250ff00485SMatt Spinler */ 260ff00485SMatt Spinler struct PELAttributes 270ff00485SMatt Spinler { 280ff00485SMatt Spinler std::filesystem::path path; 290ff00485SMatt Spinler std::bitset<16> actionFlags; 30346f99a1SMatt Spinler TransmissionState hostState; 31346f99a1SMatt Spinler TransmissionState hmcState; 320ff00485SMatt Spinler 330ff00485SMatt Spinler PELAttributes() = delete; 340ff00485SMatt Spinler 35346f99a1SMatt Spinler PELAttributes(const std::filesystem::path& p, uint16_t flags, 36346f99a1SMatt Spinler TransmissionState hostState, TransmissionState hmcState) : 37346f99a1SMatt Spinler path(p), 38346f99a1SMatt Spinler actionFlags(flags), hostState(hostState), hmcState(hmcState) 390ff00485SMatt Spinler { 400ff00485SMatt Spinler } 410ff00485SMatt Spinler }; 420ff00485SMatt Spinler 430ff00485SMatt Spinler /** 44475e574dSMatt Spinler * @brief A structure that holds both the PEL and corresponding 45475e574dSMatt Spinler * OpenBMC IDs. 46475e574dSMatt Spinler * Used for correlating the IDs with their data files for quick 47475e574dSMatt Spinler * lookup. To find a PEL based on just one of the IDs, just use 48475e574dSMatt Spinler * the constructor that takes that ID. 49475e574dSMatt Spinler */ 50475e574dSMatt Spinler struct LogID 51475e574dSMatt Spinler { 52475e574dSMatt Spinler struct Pel 53475e574dSMatt Spinler { 54475e574dSMatt Spinler uint32_t id; 55475e574dSMatt Spinler explicit Pel(uint32_t i) : id(i) 56475e574dSMatt Spinler { 57475e574dSMatt Spinler } 58475e574dSMatt Spinler }; 59475e574dSMatt Spinler struct Obmc 60475e574dSMatt Spinler { 61475e574dSMatt Spinler uint32_t id; 62475e574dSMatt Spinler explicit Obmc(uint32_t i) : id(i) 63475e574dSMatt Spinler { 64475e574dSMatt Spinler } 65475e574dSMatt Spinler }; 66475e574dSMatt Spinler 67475e574dSMatt Spinler Pel pelID; 68475e574dSMatt Spinler 69475e574dSMatt Spinler Obmc obmcID; 70475e574dSMatt Spinler 71475e574dSMatt Spinler LogID(Pel pel, Obmc obmc) : pelID(pel), obmcID(obmc) 72475e574dSMatt Spinler { 73475e574dSMatt Spinler } 74475e574dSMatt Spinler 75475e574dSMatt Spinler explicit LogID(Pel id) : pelID(id), obmcID(0) 76475e574dSMatt Spinler { 77475e574dSMatt Spinler } 78475e574dSMatt Spinler 79475e574dSMatt Spinler explicit LogID(Obmc id) : pelID(0), obmcID(id) 80475e574dSMatt Spinler { 81475e574dSMatt Spinler } 82475e574dSMatt Spinler 83475e574dSMatt Spinler LogID() = delete; 84475e574dSMatt Spinler 85475e574dSMatt Spinler /** 86475e574dSMatt Spinler * @brief A == operator that will match on either ID 87475e574dSMatt Spinler * being equal if the other is zero, so that 88475e574dSMatt Spinler * one can look up a PEL with just one of the IDs. 89475e574dSMatt Spinler */ 90475e574dSMatt Spinler bool operator==(const LogID& id) const 91475e574dSMatt Spinler { 92475e574dSMatt Spinler if (id.pelID.id != 0) 93475e574dSMatt Spinler { 94475e574dSMatt Spinler return id.pelID.id == pelID.id; 95475e574dSMatt Spinler } 96475e574dSMatt Spinler if (id.obmcID.id != 0) 97475e574dSMatt Spinler { 98475e574dSMatt Spinler return id.obmcID.id == obmcID.id; 99475e574dSMatt Spinler } 100475e574dSMatt Spinler return false; 101475e574dSMatt Spinler } 102475e574dSMatt Spinler 103475e574dSMatt Spinler bool operator<(const LogID& id) const 104475e574dSMatt Spinler { 105475e574dSMatt Spinler return pelID.id < id.pelID.id; 106475e574dSMatt Spinler } 107475e574dSMatt Spinler }; 108475e574dSMatt Spinler 10989fa082aSMatt Spinler Repository() = delete; 11089fa082aSMatt Spinler ~Repository() = default; 11189fa082aSMatt Spinler Repository(const Repository&) = default; 11289fa082aSMatt Spinler Repository& operator=(const Repository&) = default; 11389fa082aSMatt Spinler Repository(Repository&&) = default; 11489fa082aSMatt Spinler Repository& operator=(Repository&&) = default; 11589fa082aSMatt Spinler 11689fa082aSMatt Spinler /** 11789fa082aSMatt Spinler * @brief Constructor 11889fa082aSMatt Spinler * 11989fa082aSMatt Spinler * @param[in] basePath - the base filesystem path for the repository 12089fa082aSMatt Spinler */ 12189fa082aSMatt Spinler Repository(const std::filesystem::path& basePath); 12289fa082aSMatt Spinler 12389fa082aSMatt Spinler /** 12489fa082aSMatt Spinler * @brief Adds a PEL to the repository 12589fa082aSMatt Spinler * 12689fa082aSMatt Spinler * Throws File.Error.Open or File.Error.Write exceptions on failure 12789fa082aSMatt Spinler * 12889fa082aSMatt Spinler * @param[in] pel - the PEL to add 12989fa082aSMatt Spinler */ 13089fa082aSMatt Spinler void add(std::unique_ptr<PEL>& pel); 13189fa082aSMatt Spinler 13289fa082aSMatt Spinler /** 133475e574dSMatt Spinler * @brief Removes a PEL from the repository 134475e574dSMatt Spinler * 135475e574dSMatt Spinler * @param[in] id - the ID (either the pel ID, OBMC ID, or both) to remove 136475e574dSMatt Spinler */ 137475e574dSMatt Spinler void remove(const LogID& id); 138475e574dSMatt Spinler 139475e574dSMatt Spinler /** 14089fa082aSMatt Spinler * @brief Generates the filename to use for the PEL ID and BCDTime. 14189fa082aSMatt Spinler * 14289fa082aSMatt Spinler * @param[in] pelID - the PEL ID 14389fa082aSMatt Spinler * @param[in] time - the BCD time 14489fa082aSMatt Spinler * 14589fa082aSMatt Spinler * @return string - A filename string of <BCD_time>_<pelID> 14689fa082aSMatt Spinler */ 14789fa082aSMatt Spinler static std::string getPELFilename(uint32_t pelID, const BCDTime& time); 14889fa082aSMatt Spinler 149475e574dSMatt Spinler /** 150475e574dSMatt Spinler * @brief Returns true if the PEL with the specified ID is in the repo. 151475e574dSMatt Spinler * 152475e574dSMatt Spinler * @param[in] id - the ID (either the pel ID, OBMC ID, or both) 153475e574dSMatt Spinler * @return bool - true if that PEL is present 154475e574dSMatt Spinler */ 155475e574dSMatt Spinler inline bool hasPEL(const LogID& id) 156475e574dSMatt Spinler { 1570ff00485SMatt Spinler return findPEL(id) != _pelAttributes.end(); 158475e574dSMatt Spinler } 159475e574dSMatt Spinler 1602813f36dSMatt Spinler /** 1612813f36dSMatt Spinler * @brief Returns the PEL data based on its ID. 1622813f36dSMatt Spinler * 1632813f36dSMatt Spinler * If the data can't be found for that ID, then the optional object 1642813f36dSMatt Spinler * will be empty. 1652813f36dSMatt Spinler * 1662813f36dSMatt Spinler * @param[in] id - the LogID to get the PEL for, which can be either a 1672813f36dSMatt Spinler * PEL ID or OpenBMC log ID. 1682813f36dSMatt Spinler * @return std::optional<std::vector<uint8_t>> - the PEL data 1692813f36dSMatt Spinler */ 1702813f36dSMatt Spinler std::optional<std::vector<uint8_t>> getPELData(const LogID& id); 1712813f36dSMatt Spinler 172*6d51224bSMatt Spinler /** 173*6d51224bSMatt Spinler * @brief Get a file descriptor to the PEL data 174*6d51224bSMatt Spinler * 175*6d51224bSMatt Spinler * @param[in] id - The ID to get the FD for 176*6d51224bSMatt Spinler * 177*6d51224bSMatt Spinler * @return std::optional<sdbusplus::message::unix_fd> - 178*6d51224bSMatt Spinler * The FD, or an empty optional object. 179*6d51224bSMatt Spinler */ 180*6d51224bSMatt Spinler std::optional<sdbusplus::message::unix_fd> getPELFD(const LogID& id); 181*6d51224bSMatt Spinler 1821ea78801SMatt Spinler using ForEachFunc = std::function<bool(const PEL&)>; 1831ea78801SMatt Spinler 1841ea78801SMatt Spinler /** 1851ea78801SMatt Spinler * @brief Run a user defined function on every PEL in the repository. 1861ea78801SMatt Spinler * 1871ea78801SMatt Spinler * ForEachFunc takes a const PEL reference, and should return 1881ea78801SMatt Spinler * true to stop iterating and return out of for_each. 1891ea78801SMatt Spinler * 1901ea78801SMatt Spinler * For example, to save up to 100 IDs in the repo into a vector: 1911ea78801SMatt Spinler * 1921ea78801SMatt Spinler * std::vector<uint32_t> ids; 1931ea78801SMatt Spinler * ForEachFunc f = [&ids](const PEL& pel) { 1941ea78801SMatt Spinler * ids.push_back(pel.id()); 1951ea78801SMatt Spinler * return ids.size() == 100 ? true : false; 1961ea78801SMatt Spinler * }; 1971ea78801SMatt Spinler * 1981ea78801SMatt Spinler * @param[in] func - The function to run. 1991ea78801SMatt Spinler */ 2001ea78801SMatt Spinler void for_each(ForEachFunc func) const; 2011ea78801SMatt Spinler 202421f6531SMatt Spinler using AddCallback = std::function<void(const PEL&)>; 203421f6531SMatt Spinler 204421f6531SMatt Spinler /** 205421f6531SMatt Spinler * @brief Subscribe to PELs being added to the repository. 206421f6531SMatt Spinler * 207421f6531SMatt Spinler * Every time a PEL is added to the repository, the provided 208421f6531SMatt Spinler * function will be called with the new PEL as the argument. 209421f6531SMatt Spinler * 210421f6531SMatt Spinler * The function must be of type void(const PEL&). 211421f6531SMatt Spinler * 212421f6531SMatt Spinler * @param[in] name - The subscription name 213421f6531SMatt Spinler * @param[in] func - The callback function 214421f6531SMatt Spinler */ 215421f6531SMatt Spinler void subscribeToAdds(const std::string& name, AddCallback func) 216421f6531SMatt Spinler { 217421f6531SMatt Spinler if (_addSubscriptions.find(name) == _addSubscriptions.end()) 218421f6531SMatt Spinler { 219421f6531SMatt Spinler _addSubscriptions.emplace(name, func); 220421f6531SMatt Spinler } 221421f6531SMatt Spinler } 222421f6531SMatt Spinler 223421f6531SMatt Spinler /** 224421f6531SMatt Spinler * @brief Unsubscribe from new PELs. 225421f6531SMatt Spinler * 226421f6531SMatt Spinler * @param[in] name - The subscription name 227421f6531SMatt Spinler */ 228421f6531SMatt Spinler void unsubscribeFromAdds(const std::string& name) 229421f6531SMatt Spinler { 230421f6531SMatt Spinler _addSubscriptions.erase(name); 231421f6531SMatt Spinler } 232421f6531SMatt Spinler 233421f6531SMatt Spinler using DeleteCallback = std::function<void(uint32_t)>; 234421f6531SMatt Spinler 235421f6531SMatt Spinler /** 236421f6531SMatt Spinler * @brief Subscribe to PELs being deleted from the repository. 237421f6531SMatt Spinler * 238421f6531SMatt Spinler * Every time a PEL is deleted from the repository, the provided 239421f6531SMatt Spinler * function will be called with the PEL ID as the argument. 240421f6531SMatt Spinler * 241421f6531SMatt Spinler * The function must be of type void(const uint32_t). 242421f6531SMatt Spinler * 243421f6531SMatt Spinler * @param[in] name - The subscription name 244421f6531SMatt Spinler * @param[in] func - The callback function 245421f6531SMatt Spinler */ 246421f6531SMatt Spinler void subscribeToDeletes(const std::string& name, DeleteCallback func) 247421f6531SMatt Spinler { 248421f6531SMatt Spinler if (_deleteSubscriptions.find(name) == _deleteSubscriptions.end()) 249421f6531SMatt Spinler { 250421f6531SMatt Spinler _deleteSubscriptions.emplace(name, func); 251421f6531SMatt Spinler } 252421f6531SMatt Spinler } 253421f6531SMatt Spinler 254421f6531SMatt Spinler /** 255421f6531SMatt Spinler * @brief Unsubscribe from deleted PELs. 256421f6531SMatt Spinler * 257421f6531SMatt Spinler * @param[in] name - The subscription name 258421f6531SMatt Spinler */ 259421f6531SMatt Spinler void unsubscribeFromDeletes(const std::string& name) 260421f6531SMatt Spinler { 261421f6531SMatt Spinler _deleteSubscriptions.erase(name); 262421f6531SMatt Spinler } 263421f6531SMatt Spinler 2640ff00485SMatt Spinler /** 2650ff00485SMatt Spinler * @brief Get the PEL attributes for a PEL 2660ff00485SMatt Spinler * 2670ff00485SMatt Spinler * @param[in] id - The ID to find the attributes for 2680ff00485SMatt Spinler * 2690ff00485SMatt Spinler * @return The attributes or an empty optional if not found 2700ff00485SMatt Spinler */ 2710ff00485SMatt Spinler std::optional<std::reference_wrapper<const PELAttributes>> 2720ff00485SMatt Spinler getPELAttributes(const LogID& id) const; 2730ff00485SMatt Spinler 27429d18c11SMatt Spinler /** 27529d18c11SMatt Spinler * @brief Sets the host transmission state on a PEL file 27629d18c11SMatt Spinler * 27729d18c11SMatt Spinler * Writes the host transmission state field in the User Header 27829d18c11SMatt Spinler * section in the PEL data specified by the ID. 27929d18c11SMatt Spinler * 28029d18c11SMatt Spinler * @param[in] pelID - The PEL ID 28129d18c11SMatt Spinler * @param[in] state - The state to write 28229d18c11SMatt Spinler */ 28329d18c11SMatt Spinler void setPELHostTransState(uint32_t pelID, TransmissionState state); 28429d18c11SMatt Spinler 28529d18c11SMatt Spinler /** 28629d18c11SMatt Spinler * @brief Sets the HMC transmission state on a PEL file 28729d18c11SMatt Spinler * 28829d18c11SMatt Spinler * Writes the HMC transmission state field in the User Header 28929d18c11SMatt Spinler * section in the PEL data specified by the ID. 29029d18c11SMatt Spinler * 29129d18c11SMatt Spinler * @param[in] pelID - The PEL ID 29229d18c11SMatt Spinler * @param[in] state - The state to write 29329d18c11SMatt Spinler */ 29429d18c11SMatt Spinler void setPELHMCTransState(uint32_t pelID, TransmissionState state); 29529d18c11SMatt Spinler 29689fa082aSMatt Spinler private: 29729d18c11SMatt Spinler using PELUpdateFunc = std::function<void(PEL&)>; 29829d18c11SMatt Spinler 29929d18c11SMatt Spinler /** 30029d18c11SMatt Spinler * @brief Lets a function modify a PEL and saves the results 30129d18c11SMatt Spinler * 30229d18c11SMatt Spinler * Runs updateFunc (a void(PEL&) function) on the PEL data 30329d18c11SMatt Spinler * on the file specified, and writes the results back to the file. 30429d18c11SMatt Spinler * 30529d18c11SMatt Spinler * @param[in] path - The file path to use 30629d18c11SMatt Spinler * @param[in] updateFunc - The function to run to update the PEL. 30729d18c11SMatt Spinler */ 30829d18c11SMatt Spinler void updatePEL(const std::filesystem::path& path, PELUpdateFunc updateFunc); 30929d18c11SMatt Spinler 31089fa082aSMatt Spinler /** 3110ff00485SMatt Spinler * @brief Finds an entry in the _pelAttributes map. 312475e574dSMatt Spinler * 313475e574dSMatt Spinler * @param[in] id - the ID (either the pel ID, OBMC ID, or both) 314475e574dSMatt Spinler * 315475e574dSMatt Spinler * @return an iterator to the entry 316475e574dSMatt Spinler */ 3170ff00485SMatt Spinler std::map<LogID, PELAttributes>::const_iterator 3180ff00485SMatt Spinler findPEL(const LogID& id) const 319475e574dSMatt Spinler { 3200ff00485SMatt Spinler return std::find_if(_pelAttributes.begin(), _pelAttributes.end(), 3210ff00485SMatt Spinler [&id](const auto& a) { return a.first == id; }); 322475e574dSMatt Spinler } 323475e574dSMatt Spinler 324475e574dSMatt Spinler /** 325421f6531SMatt Spinler * @brief Call any subscribed functions for new PELs 326421f6531SMatt Spinler * 327421f6531SMatt Spinler * @param[in] pel - The new PEL 328421f6531SMatt Spinler */ 329421f6531SMatt Spinler void processAddCallbacks(const PEL& pel) const; 330421f6531SMatt Spinler 331421f6531SMatt Spinler /** 332421f6531SMatt Spinler * @brief Call any subscribed functions for deleted PELs 333421f6531SMatt Spinler * 334421f6531SMatt Spinler * @param[in] id - The ID of the deleted PEL 335421f6531SMatt Spinler */ 336421f6531SMatt Spinler void processDeleteCallbacks(uint32_t id) const; 337421f6531SMatt Spinler 338421f6531SMatt Spinler /** 3390ff00485SMatt Spinler * @brief Restores the _pelAttributes map on startup based on the existing 340475e574dSMatt Spinler * PEL data files. 341475e574dSMatt Spinler */ 342475e574dSMatt Spinler void restore(); 343475e574dSMatt Spinler 344475e574dSMatt Spinler /** 345ab1b97feSMatt Spinler * @brief Stores a PEL object in the filesystem. 346ab1b97feSMatt Spinler * 347ab1b97feSMatt Spinler * @param[in] pel - The PEL to write 348ab1b97feSMatt Spinler * @param[in] path - The file to write to 349ab1b97feSMatt Spinler * 350ab1b97feSMatt Spinler * Throws exceptions on failures. 351ab1b97feSMatt Spinler */ 352ab1b97feSMatt Spinler void write(const PEL& pel, const std::filesystem::path& path); 353ab1b97feSMatt Spinler 354ab1b97feSMatt Spinler /** 35589fa082aSMatt Spinler * @brief The filesystem path to the PEL logs. 35689fa082aSMatt Spinler */ 35789fa082aSMatt Spinler const std::filesystem::path _logPath; 358475e574dSMatt Spinler 359475e574dSMatt Spinler /** 3600ff00485SMatt Spinler * @brief A map of the PEL/OBMC IDs to PEL attributes. 361475e574dSMatt Spinler */ 3620ff00485SMatt Spinler std::map<LogID, PELAttributes> _pelAttributes; 363421f6531SMatt Spinler 364421f6531SMatt Spinler /** 365421f6531SMatt Spinler * @brief Subcriptions for new PELs. 366421f6531SMatt Spinler */ 367421f6531SMatt Spinler std::map<std::string, AddCallback> _addSubscriptions; 368421f6531SMatt Spinler 369421f6531SMatt Spinler /** 370421f6531SMatt Spinler * @brief Subscriptions for deleted PELs. 371421f6531SMatt Spinler */ 372421f6531SMatt Spinler std::map<std::string, DeleteCallback> _deleteSubscriptions; 37389fa082aSMatt Spinler }; 37489fa082aSMatt Spinler 37589fa082aSMatt Spinler } // namespace pels 37689fa082aSMatt Spinler } // namespace openpower 377