| Alexander Hansen | 40fb549 | 2025-10-28 17:56:12 +0100 | [diff] [blame^] | 1 | // SPDX-License-Identifier: Apache-2.0 |
| 2 | // SPDX-FileCopyrightText: Copyright 2019 IBM Corporation |
| 3 | |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 4 | #include "config.h" |
| 5 | |
| Patrick Williams | 2544b41 | 2022-10-04 08:41:06 -0500 | [diff] [blame] | 6 | #include "config_main.h" |
| 7 | |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 8 | #include "../bcd_time.hpp" |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 9 | #include "../json_utils.hpp" |
| Harisuddin Mohamed Isa | 0f717e1 | 2020-01-15 20:05:33 +0800 | [diff] [blame] | 10 | #include "../paths.hpp" |
| Aatir | 186ce8c | 2019-10-20 15:13:39 -0500 | [diff] [blame] | 11 | #include "../pel.hpp" |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 12 | #include "../pel_types.hpp" |
| 13 | #include "../pel_values.hpp" |
| Aatir | 186ce8c | 2019-10-20 15:13:39 -0500 | [diff] [blame] | 14 | |
| Harisuddin Mohamed Isa | f67bafd | 2020-07-06 17:51:21 +0800 | [diff] [blame] | 15 | #include <Python.h> |
| 16 | |
| Aatir | 186ce8c | 2019-10-20 15:13:39 -0500 | [diff] [blame] | 17 | #include <CLI/CLI.hpp> |
| Matt Spinler | a561ff6 | 2023-07-17 08:43:55 -0500 | [diff] [blame] | 18 | #include <phosphor-logging/log.hpp> |
| Patrick Williams | 2544b41 | 2022-10-04 08:41:06 -0500 | [diff] [blame] | 19 | |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 20 | #include <bitset> |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 21 | #include <fstream> |
| Aatir | 186ce8c | 2019-10-20 15:13:39 -0500 | [diff] [blame] | 22 | #include <iostream> |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 23 | #include <regex> |
| Aatir | 186ce8c | 2019-10-20 15:13:39 -0500 | [diff] [blame] | 24 | #include <string> |
| 25 | |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 26 | namespace fs = std::filesystem; |
| Matt Spinler | a561ff6 | 2023-07-17 08:43:55 -0500 | [diff] [blame] | 27 | using namespace phosphor::logging; |
| Aatir | 186ce8c | 2019-10-20 15:13:39 -0500 | [diff] [blame] | 28 | using namespace openpower::pels; |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 29 | namespace message = openpower::pels::message; |
| 30 | namespace pv = openpower::pels::pel_values; |
| Aatir | 186ce8c | 2019-10-20 15:13:39 -0500 | [diff] [blame] | 31 | |
| Miguel Gomez | 011ccae | 2021-03-25 23:42:09 +0000 | [diff] [blame] | 32 | const uint8_t critSysTermSeverity = 0x51; |
| 33 | |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 34 | using PELFunc = std::function<void(const PEL&, bool hexDump)>; |
| Matt Spinler | 0d804ef | 2020-05-12 16:16:26 -0500 | [diff] [blame] | 35 | message::Registry registry(getPELReadOnlyDataPath() / message::registryFileName, |
| Matt Spinler | d8e2900 | 2020-04-09 09:11:22 -0500 | [diff] [blame] | 36 | false); |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 37 | namespace service |
| 38 | { |
| 39 | constexpr auto logging = "xyz.openbmc_project.Logging"; |
| 40 | } // namespace service |
| 41 | |
| 42 | namespace interface |
| 43 | { |
| 44 | constexpr auto deleteObj = "xyz.openbmc_project.Object.Delete"; |
| 45 | constexpr auto deleteAll = "xyz.openbmc_project.Collection.DeleteAll"; |
| 46 | } // namespace interface |
| 47 | |
| 48 | namespace object_path |
| 49 | { |
| 50 | constexpr auto logEntry = "/xyz/openbmc_project/logging/entry/"; |
| 51 | constexpr auto logging = "/xyz/openbmc_project/logging"; |
| 52 | } // namespace object_path |
| 53 | |
| William A. Kennington III | b6b2557 | 2021-05-19 17:09:41 -0700 | [diff] [blame] | 54 | std::string pelLogDir() |
| 55 | { |
| Patrick Williams | fa2d962 | 2024-09-30 16:25:43 -0400 | [diff] [blame] | 56 | return std::string(phosphor::logging::paths::extension()) + "/pels/logs"; |
| William A. Kennington III | b6b2557 | 2021-05-19 17:09:41 -0700 | [diff] [blame] | 57 | } |
| 58 | |
| Aatir | e340c13 | 2019-12-09 14:19:29 -0600 | [diff] [blame] | 59 | /** |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 60 | * @brief helper function to get PEL commit timestamp from file name |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 61 | * @retrun uint64_t - PEL commit timestamp |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 62 | * @param[in] std::string - file name |
| 63 | */ |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 64 | uint64_t fileNameToTimestamp(const std::string& fileName) |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 65 | { |
| 66 | std::string token = fileName.substr(0, fileName.find("_")); |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 67 | uint64_t bcdTime = 0; |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 68 | if (token.length() >= 14) |
| 69 | { |
| Matt Spinler | be952d2 | 2022-07-01 11:30:11 -0500 | [diff] [blame] | 70 | int i = 0; |
| 71 | |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 72 | try |
| 73 | { |
| Matt Spinler | 6f07df3 | 2025-05-09 11:42:39 -0500 | [diff] [blame] | 74 | auto tmp = std::stoul(token.substr(i, 2), nullptr, 16); |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 75 | bcdTime |= (static_cast<uint64_t>(tmp) << 56); |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 76 | } |
| Patrick Williams | 66491c6 | 2021-10-06 12:23:37 -0500 | [diff] [blame] | 77 | catch (const std::exception& err) |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 78 | { |
| 79 | std::cout << "Conversion failure: " << err.what() << std::endl; |
| 80 | } |
| 81 | i += 2; |
| 82 | try |
| 83 | { |
| Matt Spinler | 6f07df3 | 2025-05-09 11:42:39 -0500 | [diff] [blame] | 84 | auto tmp = std::stoul(token.substr(i, 2), nullptr, 16); |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 85 | bcdTime |= (static_cast<uint64_t>(tmp) << 48); |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 86 | } |
| Patrick Williams | 66491c6 | 2021-10-06 12:23:37 -0500 | [diff] [blame] | 87 | catch (const std::exception& err) |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 88 | { |
| 89 | std::cout << "Conversion failure: " << err.what() << std::endl; |
| 90 | } |
| 91 | i += 2; |
| 92 | try |
| 93 | { |
| Matt Spinler | 6f07df3 | 2025-05-09 11:42:39 -0500 | [diff] [blame] | 94 | auto tmp = std::stoul(token.substr(i, 2), nullptr, 16); |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 95 | bcdTime |= (static_cast<uint64_t>(tmp) << 40); |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 96 | } |
| Patrick Williams | 66491c6 | 2021-10-06 12:23:37 -0500 | [diff] [blame] | 97 | catch (const std::exception& err) |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 98 | { |
| 99 | std::cout << "Conversion failure: " << err.what() << std::endl; |
| 100 | } |
| 101 | i += 2; |
| 102 | try |
| 103 | { |
| Matt Spinler | 6f07df3 | 2025-05-09 11:42:39 -0500 | [diff] [blame] | 104 | auto tmp = std::stoul(token.substr(i, 2), nullptr, 16); |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 105 | bcdTime |= (static_cast<uint64_t>(tmp) << 32); |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 106 | } |
| Patrick Williams | 66491c6 | 2021-10-06 12:23:37 -0500 | [diff] [blame] | 107 | catch (const std::exception& err) |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 108 | { |
| 109 | std::cout << "Conversion failure: " << err.what() << std::endl; |
| 110 | } |
| 111 | i += 2; |
| 112 | try |
| 113 | { |
| Matt Spinler | 6f07df3 | 2025-05-09 11:42:39 -0500 | [diff] [blame] | 114 | auto tmp = std::stoul(token.substr(i, 2), nullptr, 16); |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 115 | bcdTime |= (tmp << 24); |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 116 | } |
| Patrick Williams | 66491c6 | 2021-10-06 12:23:37 -0500 | [diff] [blame] | 117 | catch (const std::exception& err) |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 118 | { |
| 119 | std::cout << "Conversion failure: " << err.what() << std::endl; |
| 120 | } |
| 121 | i += 2; |
| 122 | try |
| 123 | { |
| Matt Spinler | 6f07df3 | 2025-05-09 11:42:39 -0500 | [diff] [blame] | 124 | auto tmp = std::stoul(token.substr(i, 2), nullptr, 16); |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 125 | bcdTime |= (tmp << 16); |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 126 | } |
| Patrick Williams | 66491c6 | 2021-10-06 12:23:37 -0500 | [diff] [blame] | 127 | catch (const std::exception& err) |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 128 | { |
| 129 | std::cout << "Conversion failure: " << err.what() << std::endl; |
| 130 | } |
| 131 | i += 2; |
| 132 | try |
| 133 | { |
| Matt Spinler | 6f07df3 | 2025-05-09 11:42:39 -0500 | [diff] [blame] | 134 | auto tmp = std::stoul(token.substr(i, 2), nullptr, 16); |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 135 | bcdTime |= (tmp << 8); |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 136 | } |
| Patrick Williams | 66491c6 | 2021-10-06 12:23:37 -0500 | [diff] [blame] | 137 | catch (const std::exception& err) |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 138 | { |
| 139 | std::cout << "Conversion failure: " << err.what() << std::endl; |
| 140 | } |
| 141 | i += 2; |
| 142 | try |
| 143 | { |
| Matt Spinler | 6f07df3 | 2025-05-09 11:42:39 -0500 | [diff] [blame] | 144 | auto tmp = std::stoul(token.substr(i, 2), nullptr, 16); |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 145 | bcdTime |= tmp; |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 146 | } |
| Patrick Williams | 66491c6 | 2021-10-06 12:23:37 -0500 | [diff] [blame] | 147 | catch (const std::exception& err) |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 148 | { |
| 149 | std::cout << "Conversion failure: " << err.what() << std::endl; |
| 150 | } |
| 151 | } |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 152 | return bcdTime; |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 153 | } |
| 154 | |
| 155 | /** |
| 156 | * @brief helper function to get PEL id from file name |
| 157 | * @retrun uint32_t - PEL id |
| 158 | * @param[in] std::string - file name |
| 159 | */ |
| 160 | uint32_t fileNameToPELId(const std::string& fileName) |
| 161 | { |
| 162 | uint32_t num = 0; |
| 163 | try |
| 164 | { |
| Matt Spinler | 6f07df3 | 2025-05-09 11:42:39 -0500 | [diff] [blame] | 165 | num = std::stoul(fileName.substr(fileName.find("_") + 1), nullptr, 16); |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 166 | } |
| Patrick Williams | 66491c6 | 2021-10-06 12:23:37 -0500 | [diff] [blame] | 167 | catch (const std::exception& err) |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 168 | { |
| 169 | std::cout << "Conversion failure: " << err.what() << std::endl; |
| 170 | } |
| 171 | return num; |
| 172 | } |
| 173 | |
| 174 | /** |
| Matt Spinler | 80129fe | 2023-01-19 15:09:05 -0600 | [diff] [blame] | 175 | * @brief Check if the string ends with the PEL ID string passed in |
| 176 | * @param[in] str - string to check for PEL ID |
| 177 | * @param[in] pelID - PEL id string |
| 178 | * |
| 179 | * @return bool - true with suffix matches |
| Aatir | e340c13 | 2019-12-09 14:19:29 -0600 | [diff] [blame] | 180 | */ |
| Matt Spinler | 80129fe | 2023-01-19 15:09:05 -0600 | [diff] [blame] | 181 | bool endsWithPelID(const std::string& str, const std::string& pelID) |
| Aatir | e340c13 | 2019-12-09 14:19:29 -0600 | [diff] [blame] | 182 | { |
| Matt Spinler | 80129fe | 2023-01-19 15:09:05 -0600 | [diff] [blame] | 183 | constexpr size_t pelIDSize = 8; |
| 184 | |
| 185 | if (pelID.size() != pelIDSize) |
| 186 | { |
| 187 | return false; |
| 188 | } |
| 189 | |
| 190 | size_t slen = str.size(), elen = pelID.size(); |
| Aatir | e340c13 | 2019-12-09 14:19:29 -0600 | [diff] [blame] | 191 | if (slen < elen) |
| 192 | return false; |
| 193 | while (elen) |
| 194 | { |
| Matt Spinler | 80129fe | 2023-01-19 15:09:05 -0600 | [diff] [blame] | 195 | if (str[--slen] != pelID[--elen]) |
| Aatir | e340c13 | 2019-12-09 14:19:29 -0600 | [diff] [blame] | 196 | return false; |
| 197 | } |
| 198 | return true; |
| 199 | } |
| 200 | |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 201 | /** |
| 202 | * @brief get data form raw PEL file. |
| 203 | * @param[in] std::string Name of file with raw PEL |
| 204 | * @return std::vector<uint8_t> char vector read from raw PEL file. |
| 205 | */ |
| Aatir | bad5f8a | 2019-12-10 15:27:16 -0600 | [diff] [blame] | 206 | std::vector<uint8_t> getFileData(const std::string& name) |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 207 | { |
| 208 | std::ifstream file(name, std::ifstream::in); |
| 209 | if (file.good()) |
| 210 | { |
| 211 | std::vector<uint8_t> data{std::istreambuf_iterator<char>(file), |
| 212 | std::istreambuf_iterator<char>()}; |
| 213 | return data; |
| 214 | } |
| 215 | else |
| 216 | { |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 217 | return {}; |
| 218 | } |
| 219 | } |
| 220 | |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 221 | /** |
| Harisuddin Mohamed Isa | f67bafd | 2020-07-06 17:51:21 +0800 | [diff] [blame] | 222 | * @brief Initialize Python interpreter and gather all UD parser modules under |
| 223 | * the paths found in Python sys.path and the current user directory. |
| 224 | * This is to prevent calling a non-existant module which causes Python |
| 225 | * to print an import error message and breaking JSON output. |
| 226 | * |
| 227 | * @return std::vector<std::string> Vector of plugins found in filesystem |
| 228 | */ |
| 229 | std::vector<std::string> getPlugins() |
| 230 | { |
| 231 | Py_Initialize(); |
| 232 | std::vector<std::string> plugins; |
| 233 | std::vector<std::string> siteDirs; |
| Harisuddin Mohamed Isa | c8d6cc6 | 2020-08-19 22:47:19 +0800 | [diff] [blame] | 234 | std::array<std::string, 2> parserDirs = {"udparsers", "srcparsers"}; |
| Harisuddin Mohamed Isa | f67bafd | 2020-07-06 17:51:21 +0800 | [diff] [blame] | 235 | PyObject* pName = PyUnicode_FromString("sys"); |
| 236 | PyObject* pModule = PyImport_Import(pName); |
| 237 | Py_XDECREF(pName); |
| 238 | PyObject* pDict = PyModule_GetDict(pModule); |
| 239 | Py_XDECREF(pModule); |
| 240 | PyObject* pResult = PyDict_GetItemString(pDict, "path"); |
| 241 | PyObject* pValue = PyUnicode_FromString("."); |
| 242 | PyList_Append(pResult, pValue); |
| 243 | Py_XDECREF(pValue); |
| 244 | auto list_size = PyList_Size(pResult); |
| 245 | for (auto i = 0; i < list_size; i++) |
| 246 | { |
| 247 | PyObject* item = PyList_GetItem(pResult, i); |
| 248 | PyObject* pBytes = PyUnicode_AsEncodedString(item, "utf-8", "~E~"); |
| 249 | const char* output = PyBytes_AS_STRING(pBytes); |
| 250 | Py_XDECREF(pBytes); |
| 251 | std::string tmpStr(output); |
| 252 | siteDirs.push_back(tmpStr); |
| 253 | } |
| 254 | for (const auto& dir : siteDirs) |
| 255 | { |
| Harisuddin Mohamed Isa | c8d6cc6 | 2020-08-19 22:47:19 +0800 | [diff] [blame] | 256 | for (const auto& parserDir : parserDirs) |
| Harisuddin Mohamed Isa | f67bafd | 2020-07-06 17:51:21 +0800 | [diff] [blame] | 257 | { |
| Harisuddin Mohamed Isa | c8d6cc6 | 2020-08-19 22:47:19 +0800 | [diff] [blame] | 258 | if (fs::exists(dir + "/" + parserDir)) |
| Harisuddin Mohamed Isa | f67bafd | 2020-07-06 17:51:21 +0800 | [diff] [blame] | 259 | { |
| Harisuddin Mohamed Isa | c8d6cc6 | 2020-08-19 22:47:19 +0800 | [diff] [blame] | 260 | for (const auto& entry : |
| 261 | fs::directory_iterator(dir + "/" + parserDir)) |
| Harisuddin Mohamed Isa | f67bafd | 2020-07-06 17:51:21 +0800 | [diff] [blame] | 262 | { |
| Harisuddin Mohamed Isa | c8d6cc6 | 2020-08-19 22:47:19 +0800 | [diff] [blame] | 263 | if (entry.is_directory() and |
| 264 | fs::exists(entry.path().string() + "/" + |
| 265 | entry.path().stem().string() + ".py")) |
| 266 | { |
| 267 | plugins.push_back(entry.path().stem()); |
| 268 | } |
| Harisuddin Mohamed Isa | f67bafd | 2020-07-06 17:51:21 +0800 | [diff] [blame] | 269 | } |
| 270 | } |
| 271 | } |
| 272 | } |
| 273 | return plugins; |
| 274 | } |
| 275 | |
| 276 | /** |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 277 | * @brief Creates JSON string of a PEL entry if fullPEL is false or prints to |
| 278 | * stdout the full PEL in JSON if fullPEL is true |
| 279 | * @param[in] itr - std::map iterator of <uint32_t, BCDTime> |
| 280 | * @param[in] hidden - Boolean to include hidden PELs |
| Harisuddin Mohamed Isa | 0c57a67 | 2020-03-27 14:16:28 +0800 | [diff] [blame] | 281 | * @param[in] includeInfo - Boolean to include informational PELs |
| Miguel Gomez | 011ccae | 2021-03-25 23:42:09 +0000 | [diff] [blame] | 282 | * @param[in] critSysTerm - Boolean to include critical error and system |
| 283 | * termination PELs |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 284 | * @param[in] fullPEL - Boolean to print full JSON representation of PEL |
| 285 | * @param[in] foundPEL - Boolean to check if any PEL is present |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 286 | * @param[in] scrubRegex - SRC regex object |
| Harisuddin Mohamed Isa | f67bafd | 2020-07-06 17:51:21 +0800 | [diff] [blame] | 287 | * @param[in] plugins - Vector of strings of plugins found in filesystem |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 288 | * @param[in] hexDump - Boolean to print hexdump of PEL instead of JSON |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 289 | * @return std::string - JSON string of PEL entry (empty if fullPEL is true) |
| 290 | */ |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 291 | template <typename T> |
| Patrick Williams | 075c792 | 2024-08-16 15:19:49 -0400 | [diff] [blame] | 292 | std::string genPELJSON( |
| 293 | T itr, bool hidden, bool includeInfo, bool critSysTerm, bool fullPEL, |
| 294 | bool& foundPEL, const std::optional<std::regex>& scrubRegex, |
| 295 | const std::vector<std::string>& plugins, bool hexDump, bool archive) |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 296 | { |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 297 | std::string val; |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 298 | std::string listStr; |
| William A. Kennington III | b6b2557 | 2021-05-19 17:09:41 -0700 | [diff] [blame] | 299 | char name[51]; |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 300 | sprintf(name, "/%.2X%.2X%.2X%.2X%.2X%.2X%.2X%.2X_%.8X", |
| 301 | static_cast<uint8_t>((itr.second >> 56) & 0xFF), |
| 302 | static_cast<uint8_t>((itr.second >> 48) & 0xFF), |
| 303 | static_cast<uint8_t>((itr.second >> 40) & 0xFF), |
| 304 | static_cast<uint8_t>((itr.second >> 32) & 0xFF), |
| 305 | static_cast<uint8_t>((itr.second >> 24) & 0xFF), |
| 306 | static_cast<uint8_t>((itr.second >> 16) & 0xFF), |
| 307 | static_cast<uint8_t>((itr.second >> 8) & 0xFF), |
| 308 | static_cast<uint8_t>(itr.second & 0xFF), itr.first); |
| 309 | |
| Sumit Kumar | 1d8835b | 2021-06-07 09:35:30 -0500 | [diff] [blame] | 310 | auto fileName = (archive ? pelLogDir() + "/archive" : pelLogDir()) + name; |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 311 | try |
| 312 | { |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 313 | std::vector<uint8_t> data = getFileData(fileName); |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 314 | if (data.empty()) |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 315 | { |
| Matt Spinler | a561ff6 | 2023-07-17 08:43:55 -0500 | [diff] [blame] | 316 | log<level::ERR>("Empty PEL file", |
| 317 | entry("FILENAME=%s", fileName.c_str())); |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 318 | return listStr; |
| 319 | } |
| 320 | PEL pel{data}; |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 321 | if (!pel.valid()) |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 322 | { |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 323 | return listStr; |
| 324 | } |
| Harisuddin Mohamed Isa | 0c57a67 | 2020-03-27 14:16:28 +0800 | [diff] [blame] | 325 | if (!includeInfo && pel.userHeader().severity() == 0) |
| 326 | { |
| 327 | return listStr; |
| 328 | } |
| Miguel Gomez | 011ccae | 2021-03-25 23:42:09 +0000 | [diff] [blame] | 329 | if (critSysTerm && pel.userHeader().severity() != critSysTermSeverity) |
| 330 | { |
| 331 | return listStr; |
| 332 | } |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 333 | std::bitset<16> actionFlags{pel.userHeader().actionFlags()}; |
| 334 | if (!hidden && actionFlags.test(hiddenFlagBit)) |
| 335 | { |
| 336 | return listStr; |
| 337 | } |
| 338 | if (pel.primarySRC() && scrubRegex) |
| 339 | { |
| 340 | val = pel.primarySRC().value()->asciiString(); |
| 341 | if (std::regex_search(trimEnd(val), scrubRegex.value(), |
| 342 | std::regex_constants::match_not_null)) |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 343 | { |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 344 | return listStr; |
| 345 | } |
| 346 | } |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 347 | if (hexDump) |
| 348 | { |
| Arya K Padman | 8c8aaa0 | 2024-04-28 23:23:45 -0500 | [diff] [blame] | 349 | std::cout |
| 350 | << dumpHex(std::data(pel.data()), pel.size(), 0, false).get() |
| 351 | << std::endl; |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 352 | } |
| 353 | else if (fullPEL) |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 354 | { |
| 355 | if (!foundPEL) |
| 356 | { |
| 357 | std::cout << "[\n"; |
| 358 | foundPEL = true; |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 359 | } |
| 360 | else |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 361 | { |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 362 | std::cout << ",\n\n"; |
| 363 | } |
| Harisuddin Mohamed Isa | f67bafd | 2020-07-06 17:51:21 +0800 | [diff] [blame] | 364 | pel.toJSON(registry, plugins); |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 365 | } |
| 366 | else |
| 367 | { |
| 368 | // id |
| Matt Spinler | 3025d0b | 2021-06-02 15:12:52 -0600 | [diff] [blame] | 369 | listStr += " \"" + |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 370 | getNumberString("0x%X", pel.privateHeader().id()) + |
| 371 | "\": {\n"; |
| 372 | // ASCII |
| 373 | if (pel.primarySRC()) |
| 374 | { |
| 375 | val = pel.primarySRC().value()->asciiString(); |
| Matt Spinler | 3025d0b | 2021-06-02 15:12:52 -0600 | [diff] [blame] | 376 | jsonInsert(listStr, "SRC", trimEnd(val), 2); |
| 377 | |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 378 | // Registry message |
| 379 | auto regVal = pel.primarySRC().value()->getErrorDetails( |
| 380 | registry, DetailLevel::message, true); |
| 381 | if (regVal) |
| Harisuddin Mohamed Isa | 0f717e1 | 2020-01-15 20:05:33 +0800 | [diff] [blame] | 382 | { |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 383 | val = regVal.value(); |
| Matt Spinler | 3025d0b | 2021-06-02 15:12:52 -0600 | [diff] [blame] | 384 | jsonInsert(listStr, "Message", val, 2); |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 385 | } |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 386 | } |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 387 | else |
| 388 | { |
| Matt Spinler | 3025d0b | 2021-06-02 15:12:52 -0600 | [diff] [blame] | 389 | jsonInsert(listStr, "SRC", "No SRC", 2); |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 390 | } |
| Matt Spinler | 3025d0b | 2021-06-02 15:12:52 -0600 | [diff] [blame] | 391 | |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 392 | // platformid |
| Matt Spinler | 3025d0b | 2021-06-02 15:12:52 -0600 | [diff] [blame] | 393 | jsonInsert(listStr, "PLID", |
| 394 | getNumberString("0x%X", pel.privateHeader().plid()), 2); |
| 395 | |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 396 | // creatorid |
| 397 | std::string creatorID = |
| 398 | getNumberString("%c", pel.privateHeader().creatorID()); |
| 399 | val = pv::creatorIDs.count(creatorID) ? pv::creatorIDs.at(creatorID) |
| 400 | : "Unknown Creator ID"; |
| Matt Spinler | 3025d0b | 2021-06-02 15:12:52 -0600 | [diff] [blame] | 401 | jsonInsert(listStr, "CreatorID", val, 2); |
| 402 | |
| 403 | // subsystem |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 404 | std::string subsystem = pv::getValue(pel.userHeader().subsystem(), |
| 405 | pel_values::subsystemValues); |
| Matt Spinler | 3025d0b | 2021-06-02 15:12:52 -0600 | [diff] [blame] | 406 | jsonInsert(listStr, "Subsystem", subsystem, 2); |
| 407 | |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 408 | // commit time |
| Matt Spinler | be952d2 | 2022-07-01 11:30:11 -0500 | [diff] [blame] | 409 | char tmpValStr[50]; |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 410 | sprintf(tmpValStr, "%02X/%02X/%02X%02X %02X:%02X:%02X", |
| 411 | pel.privateHeader().commitTimestamp().month, |
| 412 | pel.privateHeader().commitTimestamp().day, |
| 413 | pel.privateHeader().commitTimestamp().yearMSB, |
| 414 | pel.privateHeader().commitTimestamp().yearLSB, |
| 415 | pel.privateHeader().commitTimestamp().hour, |
| 416 | pel.privateHeader().commitTimestamp().minutes, |
| 417 | pel.privateHeader().commitTimestamp().seconds); |
| Matt Spinler | 3025d0b | 2021-06-02 15:12:52 -0600 | [diff] [blame] | 418 | jsonInsert(listStr, "Commit Time", tmpValStr, 2); |
| 419 | |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 420 | // severity |
| 421 | std::string severity = pv::getValue(pel.userHeader().severity(), |
| 422 | pel_values::severityValues); |
| Matt Spinler | 3025d0b | 2021-06-02 15:12:52 -0600 | [diff] [blame] | 423 | jsonInsert(listStr, "Sev", severity, 2); |
| 424 | |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 425 | // compID |
| Matt Spinler | 9a80870 | 2023-03-28 09:39:26 -0500 | [diff] [blame] | 426 | jsonInsert( |
| 427 | listStr, "CompID", |
| 428 | getComponentName(pel.privateHeader().header().componentID, |
| 429 | pel.privateHeader().creatorID()), |
| 430 | 2); |
| Matt Spinler | 3025d0b | 2021-06-02 15:12:52 -0600 | [diff] [blame] | 431 | |
| Matt Spinler | be952d2 | 2022-07-01 11:30:11 -0500 | [diff] [blame] | 432 | auto found = listStr.rfind(","); |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 433 | if (found != std::string::npos) |
| 434 | { |
| 435 | listStr.replace(found, 1, ""); |
| Matt Spinler | 3025d0b | 2021-06-02 15:12:52 -0600 | [diff] [blame] | 436 | listStr += " },\n"; |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 437 | } |
| 438 | foundPEL = true; |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 439 | } |
| 440 | } |
| Patrick Williams | 66491c6 | 2021-10-06 12:23:37 -0500 | [diff] [blame] | 441 | catch (const std::exception& e) |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 442 | { |
| Matt Spinler | a561ff6 | 2023-07-17 08:43:55 -0500 | [diff] [blame] | 443 | log<level::ERR>("Hit exception while reading PEL File", |
| 444 | entry("FILENAME=%s", fileName.c_str()), |
| 445 | entry("ERROR=%s", e.what())); |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 446 | } |
| 447 | return listStr; |
| 448 | } |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 449 | |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 450 | /** |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 451 | * @brief Print a list of PELs or a JSON array of PELs |
| 452 | * @param[in] order - Boolean to print in reverse orser |
| 453 | * @param[in] hidden - Boolean to include hidden PELs |
| Harisuddin Mohamed Isa | 0c57a67 | 2020-03-27 14:16:28 +0800 | [diff] [blame] | 454 | * @param[in] includeInfo - Boolean to include informational PELs |
| Miguel Gomez | 011ccae | 2021-03-25 23:42:09 +0000 | [diff] [blame] | 455 | * @param[in] critSysTerm - Boolean to include critical error and system |
| 456 | * termination PELs |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 457 | * @param[in] fullPEL - Boolean to print full PEL into a JSON array |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 458 | * @param[in] scrubRegex - SRC regex object |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 459 | * @param[in] hexDump - Boolean to print hexdump of PEL instead of JSON |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 460 | */ |
| Miguel Gomez | 011ccae | 2021-03-25 23:42:09 +0000 | [diff] [blame] | 461 | void printPELs(bool order, bool hidden, bool includeInfo, bool critSysTerm, |
| 462 | bool fullPEL, const std::optional<std::regex>& scrubRegex, |
| Sumit Kumar | 1d8835b | 2021-06-07 09:35:30 -0500 | [diff] [blame] | 463 | bool hexDump, bool archive = false) |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 464 | { |
| 465 | std::string listStr; |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 466 | std::vector<std::pair<uint32_t, uint64_t>> PELs; |
| Harisuddin Mohamed Isa | f67bafd | 2020-07-06 17:51:21 +0800 | [diff] [blame] | 467 | std::vector<std::string> plugins; |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 468 | listStr = "{\n"; |
| Sumit Kumar | 1d8835b | 2021-06-07 09:35:30 -0500 | [diff] [blame] | 469 | for (auto it = (archive ? fs::directory_iterator(pelLogDir() + "/archive") |
| 470 | : fs::directory_iterator(pelLogDir())); |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 471 | it != fs::directory_iterator(); ++it) |
| 472 | { |
| 473 | if (!fs::is_regular_file((*it).path())) |
| 474 | { |
| 475 | continue; |
| 476 | } |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 477 | else |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 478 | { |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 479 | PELs.emplace_back(fileNameToPELId((*it).path().filename()), |
| 480 | fileNameToTimestamp((*it).path().filename())); |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 481 | } |
| 482 | } |
| Sumit Kumar | 1d8835b | 2021-06-07 09:35:30 -0500 | [diff] [blame] | 483 | |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 484 | // Sort the pairs based on second time parameter |
| Matt Spinler | be952d2 | 2022-07-01 11:30:11 -0500 | [diff] [blame] | 485 | std::sort(PELs.begin(), PELs.end(), |
| 486 | [](const auto& left, const auto& right) { |
| Patrick Williams | 075c792 | 2024-08-16 15:19:49 -0400 | [diff] [blame] | 487 | return left.second < right.second; |
| 488 | }); |
| Sumit Kumar | 104c796 | 2022-02-09 06:30:39 -0600 | [diff] [blame] | 489 | |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 490 | bool foundPEL = false; |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 491 | |
| 492 | if (fullPEL && !hexDump) |
| Harisuddin Mohamed Isa | f67bafd | 2020-07-06 17:51:21 +0800 | [diff] [blame] | 493 | { |
| 494 | plugins = getPlugins(); |
| 495 | } |
| Miguel Gomez | 011ccae | 2021-03-25 23:42:09 +0000 | [diff] [blame] | 496 | auto buildJSON = [&listStr, &hidden, &includeInfo, &critSysTerm, &fullPEL, |
| Sumit Kumar | 1d8835b | 2021-06-07 09:35:30 -0500 | [diff] [blame] | 497 | &foundPEL, &scrubRegex, &plugins, &hexDump, |
| 498 | &archive](const auto& i) { |
| Miguel Gomez | 011ccae | 2021-03-25 23:42:09 +0000 | [diff] [blame] | 499 | listStr += genPELJSON(i, hidden, includeInfo, critSysTerm, fullPEL, |
| Sumit Kumar | 1d8835b | 2021-06-07 09:35:30 -0500 | [diff] [blame] | 500 | foundPEL, scrubRegex, plugins, hexDump, archive); |
| Aatir | 37822f6 | 2019-12-10 14:40:27 -0600 | [diff] [blame] | 501 | }; |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 502 | if (order) |
| 503 | { |
| 504 | std::for_each(PELs.rbegin(), PELs.rend(), buildJSON); |
| 505 | } |
| 506 | else |
| 507 | { |
| 508 | std::for_each(PELs.begin(), PELs.end(), buildJSON); |
| 509 | } |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 510 | if (hexDump) |
| 511 | { |
| 512 | return; |
| 513 | } |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 514 | if (foundPEL) |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 515 | { |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 516 | if (fullPEL) |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 517 | { |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 518 | std::cout << "]" << std::endl; |
| 519 | } |
| 520 | else |
| 521 | { |
| 522 | std::size_t found; |
| 523 | found = listStr.rfind(","); |
| 524 | if (found != std::string::npos) |
| 525 | { |
| 526 | listStr.replace(found, 1, ""); |
| 527 | listStr += "}\n"; |
| 528 | printf("%s", listStr.c_str()); |
| 529 | } |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 530 | } |
| 531 | } |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 532 | else |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 533 | { |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 534 | std::string emptyJSON = fullPEL ? "[]" : "{}"; |
| 535 | std::cout << emptyJSON << std::endl; |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 536 | } |
| 537 | } |
| Aatir | 186ce8c | 2019-10-20 15:13:39 -0500 | [diff] [blame] | 538 | |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 539 | /** |
| 540 | * @brief Calls the function passed in on the PEL with the ID |
| 541 | * passed in. |
| 542 | * |
| Harisuddin Mohamed Isa | 58d3a98 | 2020-09-17 19:48:05 +0800 | [diff] [blame] | 543 | * @param[in] id - The string version of the PEL or BMC Log ID, either with or |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 544 | * without the 0x prefix. |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 545 | * @param[in] func - The std::function<void(const PEL&, bool hexDump)> function |
| 546 | * to run. |
| Harisuddin Mohamed Isa | 58d3a98 | 2020-09-17 19:48:05 +0800 | [diff] [blame] | 547 | * @param[in] useBMC - if true, search by BMC Log ID, else search by PEL ID |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 548 | * @param[in] hexDump - Boolean to print hexdump of PEL instead of JSON |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 549 | */ |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 550 | void callFunctionOnPEL(const std::string& id, const PELFunc& func, |
| Sumit Kumar | 1d8835b | 2021-06-07 09:35:30 -0500 | [diff] [blame] | 551 | bool useBMC = false, bool hexDump = false, |
| 552 | bool archive = false) |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 553 | { |
| 554 | std::string pelID{id}; |
| Harisuddin Mohamed Isa | 58d3a98 | 2020-09-17 19:48:05 +0800 | [diff] [blame] | 555 | if (!useBMC) |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 556 | { |
| Harisuddin Mohamed Isa | 58d3a98 | 2020-09-17 19:48:05 +0800 | [diff] [blame] | 557 | std::transform(pelID.begin(), pelID.end(), pelID.begin(), toupper); |
| 558 | |
| Matt Spinler | be952d2 | 2022-07-01 11:30:11 -0500 | [diff] [blame] | 559 | if (pelID.starts_with("0X")) |
| Harisuddin Mohamed Isa | 58d3a98 | 2020-09-17 19:48:05 +0800 | [diff] [blame] | 560 | { |
| 561 | pelID.erase(0, 2); |
| 562 | } |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 563 | } |
| 564 | |
| 565 | bool found = false; |
| 566 | |
| Sumit Kumar | 1d8835b | 2021-06-07 09:35:30 -0500 | [diff] [blame] | 567 | for (auto it = (archive ? fs::directory_iterator(pelLogDir() + "/archive") |
| 568 | : fs::directory_iterator(pelLogDir())); |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 569 | it != fs::directory_iterator(); ++it) |
| 570 | { |
| Harisuddin Mohamed Isa | 58d3a98 | 2020-09-17 19:48:05 +0800 | [diff] [blame] | 571 | // The PEL ID is part of the filename, so use that to find the PEL if |
| 572 | // "useBMC" is set to false, otherwise we have to search within the PEL |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 573 | |
| 574 | if (!fs::is_regular_file((*it).path())) |
| 575 | { |
| 576 | continue; |
| 577 | } |
| 578 | |
| Matt Spinler | 80129fe | 2023-01-19 15:09:05 -0600 | [diff] [blame] | 579 | if ((endsWithPelID((*it).path(), pelID) && !useBMC) || useBMC) |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 580 | { |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 581 | auto data = getFileData((*it).path()); |
| 582 | if (!data.empty()) |
| 583 | { |
| 584 | PEL pel{data}; |
| Harisuddin Mohamed Isa | 58d3a98 | 2020-09-17 19:48:05 +0800 | [diff] [blame] | 585 | if (!useBMC || |
| 586 | (useBMC && pel.obmcLogID() == std::stoul(id, nullptr, 0))) |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 587 | { |
| Harisuddin Mohamed Isa | 58d3a98 | 2020-09-17 19:48:05 +0800 | [diff] [blame] | 588 | found = true; |
| 589 | try |
| 590 | { |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 591 | func(pel, hexDump); |
| Harisuddin Mohamed Isa | 58d3a98 | 2020-09-17 19:48:05 +0800 | [diff] [blame] | 592 | break; |
| 593 | } |
| Patrick Williams | 66491c6 | 2021-10-06 12:23:37 -0500 | [diff] [blame] | 594 | catch (const std::exception& e) |
| Harisuddin Mohamed Isa | 58d3a98 | 2020-09-17 19:48:05 +0800 | [diff] [blame] | 595 | { |
| 596 | std::cerr << " Internal function threw an exception: " |
| 597 | << e.what() << "\n"; |
| 598 | exit(1); |
| 599 | } |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 600 | } |
| 601 | } |
| 602 | else |
| 603 | { |
| 604 | std::cerr << "Could not read PEL file\n"; |
| 605 | exit(1); |
| 606 | } |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 607 | } |
| 608 | } |
| 609 | |
| 610 | if (!found) |
| 611 | { |
| 612 | std::cerr << "PEL not found\n"; |
| 613 | exit(1); |
| 614 | } |
| 615 | } |
| 616 | |
| 617 | /** |
| Matt Spinler | 25d986c | 2021-02-10 13:26:18 -0600 | [diff] [blame] | 618 | * @brief Delete a PEL file. |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 619 | * |
| Matt Spinler | 25d986c | 2021-02-10 13:26:18 -0600 | [diff] [blame] | 620 | * @param[in] id - The PEL ID to delete. |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 621 | */ |
| Matt Spinler | 25d986c | 2021-02-10 13:26:18 -0600 | [diff] [blame] | 622 | void deletePEL(const std::string& id) |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 623 | { |
| Matt Spinler | 25d986c | 2021-02-10 13:26:18 -0600 | [diff] [blame] | 624 | std::string pelID{id}; |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 625 | |
| Matt Spinler | 25d986c | 2021-02-10 13:26:18 -0600 | [diff] [blame] | 626 | std::transform(pelID.begin(), pelID.end(), pelID.begin(), toupper); |
| 627 | |
| Matt Spinler | be952d2 | 2022-07-01 11:30:11 -0500 | [diff] [blame] | 628 | if (pelID.starts_with("0X")) |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 629 | { |
| Matt Spinler | 25d986c | 2021-02-10 13:26:18 -0600 | [diff] [blame] | 630 | pelID.erase(0, 2); |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 631 | } |
| Matt Spinler | 25d986c | 2021-02-10 13:26:18 -0600 | [diff] [blame] | 632 | |
| William A. Kennington III | b6b2557 | 2021-05-19 17:09:41 -0700 | [diff] [blame] | 633 | for (auto it = fs::directory_iterator(pelLogDir()); |
| Matt Spinler | 25d986c | 2021-02-10 13:26:18 -0600 | [diff] [blame] | 634 | it != fs::directory_iterator(); ++it) |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 635 | { |
| Matt Spinler | 80129fe | 2023-01-19 15:09:05 -0600 | [diff] [blame] | 636 | if (endsWithPelID((*it).path(), pelID)) |
| Matt Spinler | 25d986c | 2021-02-10 13:26:18 -0600 | [diff] [blame] | 637 | { |
| 638 | fs::remove((*it).path()); |
| 639 | } |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 640 | } |
| 641 | } |
| 642 | |
| 643 | /** |
| Matt Spinler | 25d986c | 2021-02-10 13:26:18 -0600 | [diff] [blame] | 644 | * @brief Delete all PEL files. |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 645 | */ |
| 646 | void deleteAllPELs() |
| 647 | { |
| Matt Spinler | a561ff6 | 2023-07-17 08:43:55 -0500 | [diff] [blame] | 648 | log<level::INFO>("peltool deleting all event logs"); |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 649 | |
| William A. Kennington III | b6b2557 | 2021-05-19 17:09:41 -0700 | [diff] [blame] | 650 | for (const auto& entry : fs::directory_iterator(pelLogDir())) |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 651 | { |
| Sumit Kumar | 1d8835b | 2021-06-07 09:35:30 -0500 | [diff] [blame] | 652 | if (!fs::is_regular_file(entry.path())) |
| 653 | { |
| 654 | continue; |
| 655 | } |
| Matt Spinler | 25d986c | 2021-02-10 13:26:18 -0600 | [diff] [blame] | 656 | fs::remove(entry.path()); |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 657 | } |
| 658 | } |
| 659 | |
| Matt Spinler | 1b420bc | 2020-02-21 08:54:25 -0600 | [diff] [blame] | 660 | /** |
| 661 | * @brief Display a single PEL |
| 662 | * |
| 663 | * @param[in] pel - the PEL to display |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 664 | * @param[in] hexDump - Boolean to print hexdump of PEL instead of JSON |
| Matt Spinler | 1b420bc | 2020-02-21 08:54:25 -0600 | [diff] [blame] | 665 | */ |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 666 | void displayPEL(const PEL& pel, bool hexDump) |
| Matt Spinler | 1b420bc | 2020-02-21 08:54:25 -0600 | [diff] [blame] | 667 | { |
| 668 | if (pel.valid()) |
| 669 | { |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 670 | if (hexDump) |
| 671 | { |
| Arya K Padman | 8c8aaa0 | 2024-04-28 23:23:45 -0500 | [diff] [blame] | 672 | std::string dstr = |
| 673 | dumpHex(std::data(pel.data()), pel.size(), 0, false).get(); |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 674 | std::cout << dstr << std::endl; |
| 675 | } |
| 676 | else |
| 677 | { |
| 678 | auto plugins = getPlugins(); |
| 679 | pel.toJSON(registry, plugins); |
| 680 | } |
| Matt Spinler | 1b420bc | 2020-02-21 08:54:25 -0600 | [diff] [blame] | 681 | } |
| 682 | else |
| 683 | { |
| 684 | std::cerr << "PEL was malformed\n"; |
| 685 | exit(1); |
| 686 | } |
| 687 | } |
| 688 | |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 689 | /** |
| 690 | * @brief Print number of PELs |
| 691 | * @param[in] hidden - Bool to include hidden logs |
| Harisuddin Mohamed Isa | 0c57a67 | 2020-03-27 14:16:28 +0800 | [diff] [blame] | 692 | * @param[in] includeInfo - Bool to include informational logs |
| Miguel Gomez | 011ccae | 2021-03-25 23:42:09 +0000 | [diff] [blame] | 693 | * @param[in] critSysTerm - Bool to include CritSysTerm |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 694 | * @param[in] scrubRegex - SRC regex object |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 695 | */ |
| Miguel Gomez | 011ccae | 2021-03-25 23:42:09 +0000 | [diff] [blame] | 696 | void printPELCount(bool hidden, bool includeInfo, bool critSysTerm, |
| Harisuddin Mohamed Isa | 0c57a67 | 2020-03-27 14:16:28 +0800 | [diff] [blame] | 697 | const std::optional<std::regex>& scrubRegex) |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 698 | { |
| 699 | std::size_t count = 0; |
| William A. Kennington III | b6b2557 | 2021-05-19 17:09:41 -0700 | [diff] [blame] | 700 | |
| 701 | for (auto it = fs::directory_iterator(pelLogDir()); |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 702 | it != fs::directory_iterator(); ++it) |
| 703 | { |
| 704 | if (!fs::is_regular_file((*it).path())) |
| 705 | { |
| 706 | continue; |
| 707 | } |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 708 | std::vector<uint8_t> data = getFileData((*it).path()); |
| 709 | if (data.empty()) |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 710 | { |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 711 | continue; |
| 712 | } |
| 713 | PEL pel{data}; |
| 714 | if (!pel.valid()) |
| 715 | { |
| 716 | continue; |
| 717 | } |
| Harisuddin Mohamed Isa | 0c57a67 | 2020-03-27 14:16:28 +0800 | [diff] [blame] | 718 | if (!includeInfo && pel.userHeader().severity() == 0) |
| 719 | { |
| 720 | continue; |
| 721 | } |
| Miguel Gomez | 011ccae | 2021-03-25 23:42:09 +0000 | [diff] [blame] | 722 | if (critSysTerm && pel.userHeader().severity() != critSysTermSeverity) |
| 723 | { |
| 724 | continue; |
| 725 | } |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 726 | std::bitset<16> actionFlags{pel.userHeader().actionFlags()}; |
| 727 | if (!hidden && actionFlags.test(hiddenFlagBit)) |
| 728 | { |
| 729 | continue; |
| 730 | } |
| 731 | if (pel.primarySRC() && scrubRegex) |
| 732 | { |
| 733 | std::string val = pel.primarySRC().value()->asciiString(); |
| 734 | if (std::regex_search(trimEnd(val), scrubRegex.value(), |
| 735 | std::regex_constants::match_not_null)) |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 736 | { |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 737 | continue; |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 738 | } |
| 739 | } |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 740 | count++; |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 741 | } |
| 742 | std::cout << "{\n" |
| 743 | << " \"Number of PELs found\": " |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 744 | << getNumberString("%d", count) << "\n}\n"; |
| 745 | } |
| 746 | |
| 747 | /** |
| 748 | * @brief Generate regex pattern object from file contents |
| 749 | * @param[in] scrubFile - File containing regex pattern |
| 750 | * @return std::regex - SRC regex object |
| 751 | */ |
| 752 | std::regex genRegex(std::string& scrubFile) |
| 753 | { |
| 754 | std::string pattern; |
| 755 | std::ifstream contents(scrubFile); |
| 756 | if (contents.fail()) |
| 757 | { |
| 758 | std::cerr << "Can't open \"" << scrubFile << "\"\n"; |
| 759 | exit(1); |
| 760 | } |
| 761 | std::string line; |
| 762 | while (std::getline(contents, line)) |
| 763 | { |
| 764 | if (!line.empty()) |
| 765 | { |
| 766 | pattern.append(line + "|"); |
| 767 | } |
| 768 | } |
| 769 | try |
| 770 | { |
| 771 | std::regex scrubRegex(pattern, std::regex::icase); |
| 772 | return scrubRegex; |
| 773 | } |
| Patrick Williams | 66491c6 | 2021-10-06 12:23:37 -0500 | [diff] [blame] | 774 | catch (const std::regex_error& e) |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 775 | { |
| 776 | if (e.code() == std::regex_constants::error_collate) |
| 777 | std::cerr << "Invalid collating element request\n"; |
| 778 | else if (e.code() == std::regex_constants::error_ctype) |
| 779 | std::cerr << "Invalid character class\n"; |
| 780 | else if (e.code() == std::regex_constants::error_escape) |
| 781 | std::cerr << "Invalid escape character or trailing escape\n"; |
| 782 | else if (e.code() == std::regex_constants::error_backref) |
| 783 | std::cerr << "Invalid back reference\n"; |
| 784 | else if (e.code() == std::regex_constants::error_brack) |
| 785 | std::cerr << "Mismatched bracket ([ or ])\n"; |
| 786 | else if (e.code() == std::regex_constants::error_paren) |
| 787 | { |
| 788 | // to catch return code error_badrepeat when error_paren is retured |
| 789 | // instead |
| 790 | size_t pos = pattern.find_first_of("*+?{"); |
| 791 | while (pos != std::string::npos) |
| 792 | { |
| 793 | if (pos == 0 || pattern.substr(pos - 1, 1) == "|") |
| 794 | { |
| 795 | std::cerr |
| 796 | << "A repetition character (*, ?, +, or {) was not " |
| 797 | "preceded by a valid regular expression\n"; |
| 798 | exit(1); |
| 799 | } |
| 800 | pos = pattern.find_first_of("*+?{", pos + 1); |
| 801 | } |
| 802 | std::cerr << "Mismatched parentheses (( or ))\n"; |
| 803 | } |
| 804 | else if (e.code() == std::regex_constants::error_brace) |
| 805 | std::cerr << "Mismatched brace ({ or })\n"; |
| 806 | else if (e.code() == std::regex_constants::error_badbrace) |
| 807 | std::cerr << "Invalid range inside a { }\n"; |
| 808 | else if (e.code() == std::regex_constants::error_range) |
| 809 | std::cerr << "Invalid character range (e.g., [z-a])\n"; |
| 810 | else if (e.code() == std::regex_constants::error_space) |
| 811 | std::cerr << "Insufficient memory to handle regular expression\n"; |
| 812 | else if (e.code() == std::regex_constants::error_badrepeat) |
| 813 | std::cerr << "A repetition character (*, ?, +, or {) was not " |
| 814 | "preceded by a valid regular expression\n"; |
| 815 | else if (e.code() == std::regex_constants::error_complexity) |
| 816 | std::cerr << "The requested match is too complex\n"; |
| 817 | else if (e.code() == std::regex_constants::error_stack) |
| 818 | std::cerr << "Insufficient memory to evaluate a match\n"; |
| 819 | exit(1); |
| 820 | } |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 821 | } |
| 822 | |
| Aatir | 186ce8c | 2019-10-20 15:13:39 -0500 | [diff] [blame] | 823 | static void exitWithError(const std::string& help, const char* err) |
| 824 | { |
| 825 | std::cerr << "ERROR: " << err << std::endl << help << std::endl; |
| 826 | exit(-1); |
| 827 | } |
| 828 | |
| 829 | int main(int argc, char** argv) |
| 830 | { |
| 831 | CLI::App app{"OpenBMC PEL Tool"}; |
| 832 | std::string fileName; |
| Aatir | e340c13 | 2019-12-09 14:19:29 -0600 | [diff] [blame] | 833 | std::string idPEL; |
| Harisuddin Mohamed Isa | 58d3a98 | 2020-09-17 19:48:05 +0800 | [diff] [blame] | 834 | std::string bmcId; |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 835 | std::string idToDelete; |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 836 | std::string scrubFile; |
| 837 | std::optional<std::regex> scrubRegex; |
| Aatir | e340c13 | 2019-12-09 14:19:29 -0600 | [diff] [blame] | 838 | bool listPEL = false; |
| 839 | bool listPELDescOrd = false; |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 840 | bool hidden = false; |
| Harisuddin Mohamed Isa | 0c57a67 | 2020-03-27 14:16:28 +0800 | [diff] [blame] | 841 | bool includeInfo = false; |
| Miguel Gomez | 011ccae | 2021-03-25 23:42:09 +0000 | [diff] [blame] | 842 | bool critSysTerm = false; |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 843 | bool deleteAll = false; |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 844 | bool showPELCount = false; |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 845 | bool fullPEL = false; |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 846 | bool hexDump = false; |
| Sumit Kumar | 1d8835b | 2021-06-07 09:35:30 -0500 | [diff] [blame] | 847 | bool archive = false; |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 848 | |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 849 | app.set_help_flag("--help", "Print this help message and exit"); |
| Harisuddin Mohamed Isa | 0c57a67 | 2020-03-27 14:16:28 +0800 | [diff] [blame] | 850 | app.add_option("--file", fileName, "Display a PEL using its Raw PEL file"); |
| Aatir | e340c13 | 2019-12-09 14:19:29 -0600 | [diff] [blame] | 851 | app.add_option("-i, --id", idPEL, "Display a PEL based on its ID"); |
| Harisuddin Mohamed Isa | 58d3a98 | 2020-09-17 19:48:05 +0800 | [diff] [blame] | 852 | app.add_option("--bmc-id", bmcId, |
| 853 | "Display a PEL based on its BMC Event ID"); |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 854 | app.add_flag("-a", fullPEL, "Display all PELs"); |
| Aatir | bad5f8a | 2019-12-10 15:27:16 -0600 | [diff] [blame] | 855 | app.add_flag("-l", listPEL, "List PELs"); |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 856 | app.add_flag("-n", showPELCount, "Show number of PELs"); |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 857 | app.add_flag("-r", listPELDescOrd, "Reverse order of output"); |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 858 | app.add_flag("-h", hidden, "Include hidden PELs"); |
| Harisuddin Mohamed Isa | 0c57a67 | 2020-03-27 14:16:28 +0800 | [diff] [blame] | 859 | app.add_flag("-f,--info", includeInfo, "Include informational PELs"); |
| Miguel Gomez | 011ccae | 2021-03-25 23:42:09 +0000 | [diff] [blame] | 860 | app.add_flag("-t, --termination", critSysTerm, |
| 861 | "List only critical system terminating PELs"); |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 862 | app.add_option("-d, --delete", idToDelete, "Delete a PEL based on its ID"); |
| 863 | app.add_flag("-D, --delete-all", deleteAll, "Delete all PELs"); |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 864 | app.add_option("-s, --scrub", scrubFile, |
| 865 | "File containing SRC regular expressions to ignore"); |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 866 | app.add_flag("-x", hexDump, "Display PEL(s) in hexdump instead of JSON"); |
| Sumit Kumar | 1d8835b | 2021-06-07 09:35:30 -0500 | [diff] [blame] | 867 | app.add_flag("--archive", archive, "List or display archived PELs"); |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 868 | |
| Aatir | 186ce8c | 2019-10-20 15:13:39 -0500 | [diff] [blame] | 869 | CLI11_PARSE(app, argc, argv); |
| 870 | |
| 871 | if (!fileName.empty()) |
| 872 | { |
| 873 | std::vector<uint8_t> data = getFileData(fileName); |
| 874 | if (!data.empty()) |
| 875 | { |
| 876 | PEL pel{data}; |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 877 | if (hexDump) |
| 878 | { |
| Arya K Padman | 8c8aaa0 | 2024-04-28 23:23:45 -0500 | [diff] [blame] | 879 | std::string dstr = |
| 880 | dumpHex(std::data(pel.data()), pel.size(), 0, false).get(); |
| Harisuddin Mohamed Isa | ed32c8d | 2020-10-01 18:12:39 +0800 | [diff] [blame] | 881 | std::cout << dstr << std::endl; |
| 882 | } |
| 883 | else |
| 884 | { |
| 885 | auto plugins = getPlugins(); |
| 886 | pel.toJSON(registry, plugins); |
| 887 | } |
| Aatir | 186ce8c | 2019-10-20 15:13:39 -0500 | [diff] [blame] | 888 | } |
| 889 | else |
| 890 | { |
| 891 | exitWithError(app.help("", CLI::AppFormatMode::All), |
| 892 | "Raw PEL file can't be read."); |
| 893 | } |
| 894 | } |
| Aatir | e340c13 | 2019-12-09 14:19:29 -0600 | [diff] [blame] | 895 | else if (!idPEL.empty()) |
| 896 | { |
| Sumit Kumar | 1d8835b | 2021-06-07 09:35:30 -0500 | [diff] [blame] | 897 | callFunctionOnPEL(idPEL, displayPEL, false, hexDump, archive); |
| Harisuddin Mohamed Isa | 58d3a98 | 2020-09-17 19:48:05 +0800 | [diff] [blame] | 898 | } |
| 899 | else if (!bmcId.empty()) |
| 900 | { |
| Sumit Kumar | 1d8835b | 2021-06-07 09:35:30 -0500 | [diff] [blame] | 901 | callFunctionOnPEL(bmcId, displayPEL, true, hexDump, archive); |
| Aatir | e340c13 | 2019-12-09 14:19:29 -0600 | [diff] [blame] | 902 | } |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 903 | else if (fullPEL || listPEL) |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 904 | { |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 905 | if (!scrubFile.empty()) |
| 906 | { |
| 907 | scrubRegex = genRegex(scrubFile); |
| 908 | } |
| Miguel Gomez | 011ccae | 2021-03-25 23:42:09 +0000 | [diff] [blame] | 909 | printPELs(listPELDescOrd, hidden, includeInfo, critSysTerm, fullPEL, |
| Sumit Kumar | 1d8835b | 2021-06-07 09:35:30 -0500 | [diff] [blame] | 910 | scrubRegex, hexDump, archive); |
| Harisuddin Mohamed Isa | d4002f3 | 2020-02-26 16:19:58 +0800 | [diff] [blame] | 911 | } |
| 912 | else if (showPELCount) |
| 913 | { |
| Harisuddin Mohamed Isa | 6f00519 | 2020-03-10 17:39:53 +0800 | [diff] [blame] | 914 | if (!scrubFile.empty()) |
| 915 | { |
| 916 | scrubRegex = genRegex(scrubFile); |
| 917 | } |
| Miguel Gomez | 011ccae | 2021-03-25 23:42:09 +0000 | [diff] [blame] | 918 | printPELCount(hidden, includeInfo, critSysTerm, scrubRegex); |
| Aatir | 7b291ec | 2019-11-19 10:37:37 -0600 | [diff] [blame] | 919 | } |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 920 | else if (!idToDelete.empty()) |
| 921 | { |
| Matt Spinler | 25d986c | 2021-02-10 13:26:18 -0600 | [diff] [blame] | 922 | deletePEL(idToDelete); |
| Matt Spinler | 27de6f3 | 2020-02-21 08:35:57 -0600 | [diff] [blame] | 923 | } |
| 924 | else if (deleteAll) |
| 925 | { |
| 926 | deleteAllPELs(); |
| 927 | } |
| Aatir | 186ce8c | 2019-10-20 15:13:39 -0500 | [diff] [blame] | 928 | else |
| 929 | { |
| Harisuddin Mohamed Isa | a214ed3 | 2020-02-28 15:58:23 +0800 | [diff] [blame] | 930 | std::cout << app.help("", CLI::AppFormatMode::All) << std::endl; |
| Aatir | 186ce8c | 2019-10-20 15:13:39 -0500 | [diff] [blame] | 931 | } |
| Harisuddin Mohamed Isa | f67bafd | 2020-07-06 17:51:21 +0800 | [diff] [blame] | 932 | Py_Finalize(); |
| Aatir | 186ce8c | 2019-10-20 15:13:39 -0500 | [diff] [blame] | 933 | return 0; |
| 934 | } |