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