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; 300ff00485SMatt Spinler 310ff00485SMatt Spinler PELAttributes() = delete; 320ff00485SMatt Spinler 330ff00485SMatt Spinler PELAttributes(const std::filesystem::path& path, uint16_t flags) : 340ff00485SMatt Spinler path(path), actionFlags(flags) 350ff00485SMatt Spinler { 360ff00485SMatt Spinler } 370ff00485SMatt Spinler }; 380ff00485SMatt Spinler 390ff00485SMatt Spinler /** 40475e574dSMatt Spinler * @brief A structure that holds both the PEL and corresponding 41475e574dSMatt Spinler * OpenBMC IDs. 42475e574dSMatt Spinler * Used for correlating the IDs with their data files for quick 43475e574dSMatt Spinler * lookup. To find a PEL based on just one of the IDs, just use 44475e574dSMatt Spinler * the constructor that takes that ID. 45475e574dSMatt Spinler */ 46475e574dSMatt Spinler struct LogID 47475e574dSMatt Spinler { 48475e574dSMatt Spinler struct Pel 49475e574dSMatt Spinler { 50475e574dSMatt Spinler uint32_t id; 51475e574dSMatt Spinler explicit Pel(uint32_t i) : id(i) 52475e574dSMatt Spinler { 53475e574dSMatt Spinler } 54475e574dSMatt Spinler }; 55475e574dSMatt Spinler struct Obmc 56475e574dSMatt Spinler { 57475e574dSMatt Spinler uint32_t id; 58475e574dSMatt Spinler explicit Obmc(uint32_t i) : id(i) 59475e574dSMatt Spinler { 60475e574dSMatt Spinler } 61475e574dSMatt Spinler }; 62475e574dSMatt Spinler 63475e574dSMatt Spinler Pel pelID; 64475e574dSMatt Spinler 65475e574dSMatt Spinler Obmc obmcID; 66475e574dSMatt Spinler 67475e574dSMatt Spinler LogID(Pel pel, Obmc obmc) : pelID(pel), obmcID(obmc) 68475e574dSMatt Spinler { 69475e574dSMatt Spinler } 70475e574dSMatt Spinler 71475e574dSMatt Spinler explicit LogID(Pel id) : pelID(id), obmcID(0) 72475e574dSMatt Spinler { 73475e574dSMatt Spinler } 74475e574dSMatt Spinler 75475e574dSMatt Spinler explicit LogID(Obmc id) : pelID(0), obmcID(id) 76475e574dSMatt Spinler { 77475e574dSMatt Spinler } 78475e574dSMatt Spinler 79475e574dSMatt Spinler LogID() = delete; 80475e574dSMatt Spinler 81475e574dSMatt Spinler /** 82475e574dSMatt Spinler * @brief A == operator that will match on either ID 83475e574dSMatt Spinler * being equal if the other is zero, so that 84475e574dSMatt Spinler * one can look up a PEL with just one of the IDs. 85475e574dSMatt Spinler */ 86475e574dSMatt Spinler bool operator==(const LogID& id) const 87475e574dSMatt Spinler { 88475e574dSMatt Spinler if (id.pelID.id != 0) 89475e574dSMatt Spinler { 90475e574dSMatt Spinler return id.pelID.id == pelID.id; 91475e574dSMatt Spinler } 92475e574dSMatt Spinler if (id.obmcID.id != 0) 93475e574dSMatt Spinler { 94475e574dSMatt Spinler return id.obmcID.id == obmcID.id; 95475e574dSMatt Spinler } 96475e574dSMatt Spinler return false; 97475e574dSMatt Spinler } 98475e574dSMatt Spinler 99475e574dSMatt Spinler bool operator<(const LogID& id) const 100475e574dSMatt Spinler { 101475e574dSMatt Spinler return pelID.id < id.pelID.id; 102475e574dSMatt Spinler } 103475e574dSMatt Spinler }; 104475e574dSMatt Spinler 10589fa082aSMatt Spinler Repository() = delete; 10689fa082aSMatt Spinler ~Repository() = default; 10789fa082aSMatt Spinler Repository(const Repository&) = default; 10889fa082aSMatt Spinler Repository& operator=(const Repository&) = default; 10989fa082aSMatt Spinler Repository(Repository&&) = default; 11089fa082aSMatt Spinler Repository& operator=(Repository&&) = default; 11189fa082aSMatt Spinler 11289fa082aSMatt Spinler /** 11389fa082aSMatt Spinler * @brief Constructor 11489fa082aSMatt Spinler * 11589fa082aSMatt Spinler * @param[in] basePath - the base filesystem path for the repository 11689fa082aSMatt Spinler */ 11789fa082aSMatt Spinler Repository(const std::filesystem::path& basePath); 11889fa082aSMatt Spinler 11989fa082aSMatt Spinler /** 12089fa082aSMatt Spinler * @brief Adds a PEL to the repository 12189fa082aSMatt Spinler * 12289fa082aSMatt Spinler * Throws File.Error.Open or File.Error.Write exceptions on failure 12389fa082aSMatt Spinler * 12489fa082aSMatt Spinler * @param[in] pel - the PEL to add 12589fa082aSMatt Spinler */ 12689fa082aSMatt Spinler void add(std::unique_ptr<PEL>& pel); 12789fa082aSMatt Spinler 12889fa082aSMatt Spinler /** 129475e574dSMatt Spinler * @brief Removes a PEL from the repository 130475e574dSMatt Spinler * 131475e574dSMatt Spinler * @param[in] id - the ID (either the pel ID, OBMC ID, or both) to remove 132475e574dSMatt Spinler */ 133475e574dSMatt Spinler void remove(const LogID& id); 134475e574dSMatt Spinler 135475e574dSMatt Spinler /** 13689fa082aSMatt Spinler * @brief Generates the filename to use for the PEL ID and BCDTime. 13789fa082aSMatt Spinler * 13889fa082aSMatt Spinler * @param[in] pelID - the PEL ID 13989fa082aSMatt Spinler * @param[in] time - the BCD time 14089fa082aSMatt Spinler * 14189fa082aSMatt Spinler * @return string - A filename string of <BCD_time>_<pelID> 14289fa082aSMatt Spinler */ 14389fa082aSMatt Spinler static std::string getPELFilename(uint32_t pelID, const BCDTime& time); 14489fa082aSMatt Spinler 145475e574dSMatt Spinler /** 146475e574dSMatt Spinler * @brief Returns true if the PEL with the specified ID is in the repo. 147475e574dSMatt Spinler * 148475e574dSMatt Spinler * @param[in] id - the ID (either the pel ID, OBMC ID, or both) 149475e574dSMatt Spinler * @return bool - true if that PEL is present 150475e574dSMatt Spinler */ 151475e574dSMatt Spinler inline bool hasPEL(const LogID& id) 152475e574dSMatt Spinler { 1530ff00485SMatt Spinler return findPEL(id) != _pelAttributes.end(); 154475e574dSMatt Spinler } 155475e574dSMatt Spinler 1562813f36dSMatt Spinler /** 1572813f36dSMatt Spinler * @brief Returns the PEL data based on its ID. 1582813f36dSMatt Spinler * 1592813f36dSMatt Spinler * If the data can't be found for that ID, then the optional object 1602813f36dSMatt Spinler * will be empty. 1612813f36dSMatt Spinler * 1622813f36dSMatt Spinler * @param[in] id - the LogID to get the PEL for, which can be either a 1632813f36dSMatt Spinler * PEL ID or OpenBMC log ID. 1642813f36dSMatt Spinler * @return std::optional<std::vector<uint8_t>> - the PEL data 1652813f36dSMatt Spinler */ 1662813f36dSMatt Spinler std::optional<std::vector<uint8_t>> getPELData(const LogID& id); 1672813f36dSMatt Spinler 1681ea78801SMatt Spinler using ForEachFunc = std::function<bool(const PEL&)>; 1691ea78801SMatt Spinler 1701ea78801SMatt Spinler /** 1711ea78801SMatt Spinler * @brief Run a user defined function on every PEL in the repository. 1721ea78801SMatt Spinler * 1731ea78801SMatt Spinler * ForEachFunc takes a const PEL reference, and should return 1741ea78801SMatt Spinler * true to stop iterating and return out of for_each. 1751ea78801SMatt Spinler * 1761ea78801SMatt Spinler * For example, to save up to 100 IDs in the repo into a vector: 1771ea78801SMatt Spinler * 1781ea78801SMatt Spinler * std::vector<uint32_t> ids; 1791ea78801SMatt Spinler * ForEachFunc f = [&ids](const PEL& pel) { 1801ea78801SMatt Spinler * ids.push_back(pel.id()); 1811ea78801SMatt Spinler * return ids.size() == 100 ? true : false; 1821ea78801SMatt Spinler * }; 1831ea78801SMatt Spinler * 1841ea78801SMatt Spinler * @param[in] func - The function to run. 1851ea78801SMatt Spinler */ 1861ea78801SMatt Spinler void for_each(ForEachFunc func) const; 1871ea78801SMatt Spinler 188421f6531SMatt Spinler using AddCallback = std::function<void(const PEL&)>; 189421f6531SMatt Spinler 190421f6531SMatt Spinler /** 191421f6531SMatt Spinler * @brief Subscribe to PELs being added to the repository. 192421f6531SMatt Spinler * 193421f6531SMatt Spinler * Every time a PEL is added to the repository, the provided 194421f6531SMatt Spinler * function will be called with the new PEL as the argument. 195421f6531SMatt Spinler * 196421f6531SMatt Spinler * The function must be of type void(const PEL&). 197421f6531SMatt Spinler * 198421f6531SMatt Spinler * @param[in] name - The subscription name 199421f6531SMatt Spinler * @param[in] func - The callback function 200421f6531SMatt Spinler */ 201421f6531SMatt Spinler void subscribeToAdds(const std::string& name, AddCallback func) 202421f6531SMatt Spinler { 203421f6531SMatt Spinler if (_addSubscriptions.find(name) == _addSubscriptions.end()) 204421f6531SMatt Spinler { 205421f6531SMatt Spinler _addSubscriptions.emplace(name, func); 206421f6531SMatt Spinler } 207421f6531SMatt Spinler } 208421f6531SMatt Spinler 209421f6531SMatt Spinler /** 210421f6531SMatt Spinler * @brief Unsubscribe from new PELs. 211421f6531SMatt Spinler * 212421f6531SMatt Spinler * @param[in] name - The subscription name 213421f6531SMatt Spinler */ 214421f6531SMatt Spinler void unsubscribeFromAdds(const std::string& name) 215421f6531SMatt Spinler { 216421f6531SMatt Spinler _addSubscriptions.erase(name); 217421f6531SMatt Spinler } 218421f6531SMatt Spinler 219421f6531SMatt Spinler using DeleteCallback = std::function<void(uint32_t)>; 220421f6531SMatt Spinler 221421f6531SMatt Spinler /** 222421f6531SMatt Spinler * @brief Subscribe to PELs being deleted from the repository. 223421f6531SMatt Spinler * 224421f6531SMatt Spinler * Every time a PEL is deleted from the repository, the provided 225421f6531SMatt Spinler * function will be called with the PEL ID as the argument. 226421f6531SMatt Spinler * 227421f6531SMatt Spinler * The function must be of type void(const uint32_t). 228421f6531SMatt Spinler * 229421f6531SMatt Spinler * @param[in] name - The subscription name 230421f6531SMatt Spinler * @param[in] func - The callback function 231421f6531SMatt Spinler */ 232421f6531SMatt Spinler void subscribeToDeletes(const std::string& name, DeleteCallback func) 233421f6531SMatt Spinler { 234421f6531SMatt Spinler if (_deleteSubscriptions.find(name) == _deleteSubscriptions.end()) 235421f6531SMatt Spinler { 236421f6531SMatt Spinler _deleteSubscriptions.emplace(name, func); 237421f6531SMatt Spinler } 238421f6531SMatt Spinler } 239421f6531SMatt Spinler 240421f6531SMatt Spinler /** 241421f6531SMatt Spinler * @brief Unsubscribe from deleted PELs. 242421f6531SMatt Spinler * 243421f6531SMatt Spinler * @param[in] name - The subscription name 244421f6531SMatt Spinler */ 245421f6531SMatt Spinler void unsubscribeFromDeletes(const std::string& name) 246421f6531SMatt Spinler { 247421f6531SMatt Spinler _deleteSubscriptions.erase(name); 248421f6531SMatt Spinler } 249421f6531SMatt Spinler 2500ff00485SMatt Spinler /** 2510ff00485SMatt Spinler * @brief Get the PEL attributes for a PEL 2520ff00485SMatt Spinler * 2530ff00485SMatt Spinler * @param[in] id - The ID to find the attributes for 2540ff00485SMatt Spinler * 2550ff00485SMatt Spinler * @return The attributes or an empty optional if not found 2560ff00485SMatt Spinler */ 2570ff00485SMatt Spinler std::optional<std::reference_wrapper<const PELAttributes>> 2580ff00485SMatt Spinler getPELAttributes(const LogID& id) const; 2590ff00485SMatt Spinler 26089fa082aSMatt Spinler private: 26189fa082aSMatt Spinler /** 2620ff00485SMatt Spinler * @brief Finds an entry in the _pelAttributes map. 263475e574dSMatt Spinler * 264475e574dSMatt Spinler * @param[in] id - the ID (either the pel ID, OBMC ID, or both) 265475e574dSMatt Spinler * 266475e574dSMatt Spinler * @return an iterator to the entry 267475e574dSMatt Spinler */ 2680ff00485SMatt Spinler std::map<LogID, PELAttributes>::const_iterator 2690ff00485SMatt Spinler findPEL(const LogID& id) const 270475e574dSMatt Spinler { 2710ff00485SMatt Spinler return std::find_if(_pelAttributes.begin(), _pelAttributes.end(), 2720ff00485SMatt Spinler [&id](const auto& a) { return a.first == id; }); 273475e574dSMatt Spinler } 274475e574dSMatt Spinler 275475e574dSMatt Spinler /** 276421f6531SMatt Spinler * @brief Call any subscribed functions for new PELs 277421f6531SMatt Spinler * 278421f6531SMatt Spinler * @param[in] pel - The new PEL 279421f6531SMatt Spinler */ 280421f6531SMatt Spinler void processAddCallbacks(const PEL& pel) const; 281421f6531SMatt Spinler 282421f6531SMatt Spinler /** 283421f6531SMatt Spinler * @brief Call any subscribed functions for deleted PELs 284421f6531SMatt Spinler * 285421f6531SMatt Spinler * @param[in] id - The ID of the deleted PEL 286421f6531SMatt Spinler */ 287421f6531SMatt Spinler void processDeleteCallbacks(uint32_t id) const; 288421f6531SMatt Spinler 289421f6531SMatt Spinler /** 2900ff00485SMatt Spinler * @brief Restores the _pelAttributes map on startup based on the existing 291475e574dSMatt Spinler * PEL data files. 292475e574dSMatt Spinler */ 293475e574dSMatt Spinler void restore(); 294475e574dSMatt Spinler 295475e574dSMatt Spinler /** 296*ab1b97feSMatt Spinler * @brief Stores a PEL object in the filesystem. 297*ab1b97feSMatt Spinler * 298*ab1b97feSMatt Spinler * @param[in] pel - The PEL to write 299*ab1b97feSMatt Spinler * @param[in] path - The file to write to 300*ab1b97feSMatt Spinler * 301*ab1b97feSMatt Spinler * Throws exceptions on failures. 302*ab1b97feSMatt Spinler */ 303*ab1b97feSMatt Spinler void write(const PEL& pel, const std::filesystem::path& path); 304*ab1b97feSMatt Spinler 305*ab1b97feSMatt Spinler /** 30689fa082aSMatt Spinler * @brief The filesystem path to the PEL logs. 30789fa082aSMatt Spinler */ 30889fa082aSMatt Spinler const std::filesystem::path _logPath; 309475e574dSMatt Spinler 310475e574dSMatt Spinler /** 3110ff00485SMatt Spinler * @brief A map of the PEL/OBMC IDs to PEL attributes. 312475e574dSMatt Spinler */ 3130ff00485SMatt Spinler std::map<LogID, PELAttributes> _pelAttributes; 314421f6531SMatt Spinler 315421f6531SMatt Spinler /** 316421f6531SMatt Spinler * @brief Subcriptions for new PELs. 317421f6531SMatt Spinler */ 318421f6531SMatt Spinler std::map<std::string, AddCallback> _addSubscriptions; 319421f6531SMatt Spinler 320421f6531SMatt Spinler /** 321421f6531SMatt Spinler * @brief Subscriptions for deleted PELs. 322421f6531SMatt Spinler */ 323421f6531SMatt Spinler std::map<std::string, DeleteCallback> _deleteSubscriptions; 32489fa082aSMatt Spinler }; 32589fa082aSMatt Spinler 32689fa082aSMatt Spinler } // namespace pels 32789fa082aSMatt Spinler } // namespace openpower 328