1 /* 2 // Copyright (c) 2018 Intel 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 #pragma once 17 18 #include "app.hpp" 19 #include "dbus_utility.hpp" 20 #include "error_messages.hpp" 21 #include "gzfile.hpp" 22 #include "http_utility.hpp" 23 #include "human_sort.hpp" 24 #include "query.hpp" 25 #include "registries.hpp" 26 #include "registries/base_message_registry.hpp" 27 #include "registries/openbmc_message_registry.hpp" 28 #include "registries/privilege_registry.hpp" 29 #include "task.hpp" 30 #include "utils/dbus_utils.hpp" 31 #include "utils/time_utils.hpp" 32 33 #include <systemd/sd-journal.h> 34 #include <tinyxml2.h> 35 #include <unistd.h> 36 37 #include <boost/algorithm/string/case_conv.hpp> 38 #include <boost/algorithm/string/classification.hpp> 39 #include <boost/algorithm/string/replace.hpp> 40 #include <boost/algorithm/string/split.hpp> 41 #include <boost/beast/http/verb.hpp> 42 #include <boost/container/flat_map.hpp> 43 #include <boost/system/linux_error.hpp> 44 #include <sdbusplus/asio/property.hpp> 45 #include <sdbusplus/unpack_properties.hpp> 46 47 #include <array> 48 #include <charconv> 49 #include <filesystem> 50 #include <optional> 51 #include <span> 52 #include <string_view> 53 #include <variant> 54 55 namespace redfish 56 { 57 58 constexpr char const* crashdumpObject = "com.intel.crashdump"; 59 constexpr char const* crashdumpPath = "/com/intel/crashdump"; 60 constexpr char const* crashdumpInterface = "com.intel.crashdump"; 61 constexpr char const* deleteAllInterface = 62 "xyz.openbmc_project.Collection.DeleteAll"; 63 constexpr char const* crashdumpOnDemandInterface = 64 "com.intel.crashdump.OnDemand"; 65 constexpr char const* crashdumpTelemetryInterface = 66 "com.intel.crashdump.Telemetry"; 67 68 enum class DumpCreationProgress 69 { 70 DUMP_CREATE_SUCCESS, 71 DUMP_CREATE_FAILED, 72 DUMP_CREATE_INPROGRESS 73 }; 74 75 namespace registries 76 { 77 static const Message* 78 getMessageFromRegistry(const std::string& messageKey, 79 const std::span<const MessageEntry> registry) 80 { 81 std::span<const MessageEntry>::iterator messageIt = 82 std::find_if(registry.begin(), registry.end(), 83 [&messageKey](const MessageEntry& messageEntry) { 84 return std::strcmp(messageEntry.first, messageKey.c_str()) == 0; 85 }); 86 if (messageIt != registry.end()) 87 { 88 return &messageIt->second; 89 } 90 91 return nullptr; 92 } 93 94 static const Message* getMessage(const std::string_view& messageID) 95 { 96 // Redfish MessageIds are in the form 97 // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 98 // the right Message 99 std::vector<std::string> fields; 100 fields.reserve(4); 101 bmcweb::split(fields, messageID, '.'); 102 const std::string& registryName = fields[0]; 103 const std::string& messageKey = fields[3]; 104 105 // Find the right registry and check it for the MessageKey 106 if (std::string(base::header.registryPrefix) == registryName) 107 { 108 return getMessageFromRegistry( 109 messageKey, std::span<const MessageEntry>(base::registry)); 110 } 111 if (std::string(openbmc::header.registryPrefix) == registryName) 112 { 113 return getMessageFromRegistry( 114 messageKey, std::span<const MessageEntry>(openbmc::registry)); 115 } 116 return nullptr; 117 } 118 } // namespace registries 119 120 namespace fs = std::filesystem; 121 122 inline std::string translateSeverityDbusToRedfish(const std::string& s) 123 { 124 if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") || 125 (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") || 126 (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") || 127 (s == "xyz.openbmc_project.Logging.Entry.Level.Error")) 128 { 129 return "Critical"; 130 } 131 if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") || 132 (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") || 133 (s == "xyz.openbmc_project.Logging.Entry.Level.Notice")) 134 { 135 return "OK"; 136 } 137 if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning") 138 { 139 return "Warning"; 140 } 141 return ""; 142 } 143 144 inline std::optional<bool> getProviderNotifyAction(const std::string& notify) 145 { 146 std::optional<bool> notifyAction; 147 if (notify == "xyz.openbmc_project.Logging.Entry.Notify.Notify") 148 { 149 notifyAction = true; 150 } 151 else if (notify == "xyz.openbmc_project.Logging.Entry.Notify.Inhibit") 152 { 153 notifyAction = false; 154 } 155 156 return notifyAction; 157 } 158 159 inline static int getJournalMetadata(sd_journal* journal, 160 const std::string_view& field, 161 std::string_view& contents) 162 { 163 const char* data = nullptr; 164 size_t length = 0; 165 int ret = 0; 166 // Get the metadata from the requested field of the journal entry 167 // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) 168 const void** dataVoid = reinterpret_cast<const void**>(&data); 169 170 ret = sd_journal_get_data(journal, field.data(), dataVoid, &length); 171 if (ret < 0) 172 { 173 return ret; 174 } 175 contents = std::string_view(data, length); 176 // Only use the content after the "=" character. 177 contents.remove_prefix(std::min(contents.find('=') + 1, contents.size())); 178 return ret; 179 } 180 181 inline static int getJournalMetadata(sd_journal* journal, 182 const std::string_view& field, 183 const int& base, long int& contents) 184 { 185 int ret = 0; 186 std::string_view metadata; 187 // Get the metadata from the requested field of the journal entry 188 ret = getJournalMetadata(journal, field, metadata); 189 if (ret < 0) 190 { 191 return ret; 192 } 193 contents = strtol(metadata.data(), nullptr, base); 194 return ret; 195 } 196 197 inline static bool getEntryTimestamp(sd_journal* journal, 198 std::string& entryTimestamp) 199 { 200 int ret = 0; 201 uint64_t timestamp = 0; 202 ret = sd_journal_get_realtime_usec(journal, ×tamp); 203 if (ret < 0) 204 { 205 BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 206 << strerror(-ret); 207 return false; 208 } 209 entryTimestamp = 210 redfish::time_utils::getDateTimeUint(timestamp / 1000 / 1000); 211 return true; 212 } 213 214 inline static bool getUniqueEntryID(sd_journal* journal, std::string& entryID, 215 const bool firstEntry = true) 216 { 217 int ret = 0; 218 static uint64_t prevTs = 0; 219 static int index = 0; 220 if (firstEntry) 221 { 222 prevTs = 0; 223 } 224 225 // Get the entry timestamp 226 uint64_t curTs = 0; 227 ret = sd_journal_get_realtime_usec(journal, &curTs); 228 if (ret < 0) 229 { 230 BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 231 << strerror(-ret); 232 return false; 233 } 234 // If the timestamp isn't unique, increment the index 235 if (curTs == prevTs) 236 { 237 index++; 238 } 239 else 240 { 241 // Otherwise, reset it 242 index = 0; 243 } 244 // Save the timestamp 245 prevTs = curTs; 246 247 entryID = std::to_string(curTs); 248 if (index > 0) 249 { 250 entryID += "_" + std::to_string(index); 251 } 252 return true; 253 } 254 255 static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID, 256 const bool firstEntry = true) 257 { 258 static time_t prevTs = 0; 259 static int index = 0; 260 if (firstEntry) 261 { 262 prevTs = 0; 263 } 264 265 // Get the entry timestamp 266 std::time_t curTs = 0; 267 std::tm timeStruct = {}; 268 std::istringstream entryStream(logEntry); 269 if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 270 { 271 curTs = std::mktime(&timeStruct); 272 } 273 // If the timestamp isn't unique, increment the index 274 if (curTs == prevTs) 275 { 276 index++; 277 } 278 else 279 { 280 // Otherwise, reset it 281 index = 0; 282 } 283 // Save the timestamp 284 prevTs = curTs; 285 286 entryID = std::to_string(curTs); 287 if (index > 0) 288 { 289 entryID += "_" + std::to_string(index); 290 } 291 return true; 292 } 293 294 inline static bool 295 getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 296 const std::string& entryID, uint64_t& timestamp, 297 uint64_t& index) 298 { 299 if (entryID.empty()) 300 { 301 return false; 302 } 303 // Convert the unique ID back to a timestamp to find the entry 304 std::string_view tsStr(entryID); 305 306 auto underscorePos = tsStr.find('_'); 307 if (underscorePos != std::string_view::npos) 308 { 309 // Timestamp has an index 310 tsStr.remove_suffix(tsStr.size() - underscorePos); 311 std::string_view indexStr(entryID); 312 indexStr.remove_prefix(underscorePos + 1); 313 auto [ptr, ec] = std::from_chars( 314 indexStr.data(), indexStr.data() + indexStr.size(), index); 315 if (ec != std::errc()) 316 { 317 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 318 return false; 319 } 320 } 321 // Timestamp has no index 322 auto [ptr, ec] = 323 std::from_chars(tsStr.data(), tsStr.data() + tsStr.size(), timestamp); 324 if (ec != std::errc()) 325 { 326 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 327 return false; 328 } 329 return true; 330 } 331 332 static bool 333 getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles) 334 { 335 static const std::filesystem::path redfishLogDir = "/var/log"; 336 static const std::string redfishLogFilename = "redfish"; 337 338 // Loop through the directory looking for redfish log files 339 for (const std::filesystem::directory_entry& dirEnt : 340 std::filesystem::directory_iterator(redfishLogDir)) 341 { 342 // If we find a redfish log file, save the path 343 std::string filename = dirEnt.path().filename(); 344 if (filename.starts_with(redfishLogFilename)) 345 { 346 redfishLogFiles.emplace_back(redfishLogDir / filename); 347 } 348 } 349 // As the log files rotate, they are appended with a ".#" that is higher for 350 // the older logs. Since we don't expect more than 10 log files, we 351 // can just sort the list to get them in order from newest to oldest 352 std::sort(redfishLogFiles.begin(), redfishLogFiles.end()); 353 354 return !redfishLogFiles.empty(); 355 } 356 357 inline void parseDumpEntryFromDbusObject( 358 const dbus::utility::ManagedObjectType::value_type& object, 359 std::string& dumpStatus, uint64_t& size, uint64_t& timestampUs, 360 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 361 { 362 for (const auto& interfaceMap : object.second) 363 { 364 if (interfaceMap.first == "xyz.openbmc_project.Common.Progress") 365 { 366 for (const auto& propertyMap : interfaceMap.second) 367 { 368 if (propertyMap.first == "Status") 369 { 370 const auto* status = 371 std::get_if<std::string>(&propertyMap.second); 372 if (status == nullptr) 373 { 374 messages::internalError(asyncResp->res); 375 break; 376 } 377 dumpStatus = *status; 378 } 379 } 380 } 381 else if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") 382 { 383 for (const auto& propertyMap : interfaceMap.second) 384 { 385 if (propertyMap.first == "Size") 386 { 387 const auto* sizePtr = 388 std::get_if<uint64_t>(&propertyMap.second); 389 if (sizePtr == nullptr) 390 { 391 messages::internalError(asyncResp->res); 392 break; 393 } 394 size = *sizePtr; 395 break; 396 } 397 } 398 } 399 else if (interfaceMap.first == "xyz.openbmc_project.Time.EpochTime") 400 { 401 for (const auto& propertyMap : interfaceMap.second) 402 { 403 if (propertyMap.first == "Elapsed") 404 { 405 const uint64_t* usecsTimeStamp = 406 std::get_if<uint64_t>(&propertyMap.second); 407 if (usecsTimeStamp == nullptr) 408 { 409 messages::internalError(asyncResp->res); 410 break; 411 } 412 timestampUs = *usecsTimeStamp; 413 break; 414 } 415 } 416 } 417 } 418 } 419 420 static std::string getDumpEntriesPath(const std::string& dumpType) 421 { 422 std::string entriesPath; 423 424 if (dumpType == "BMC") 425 { 426 entriesPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 427 } 428 else if (dumpType == "FaultLog") 429 { 430 entriesPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/"; 431 } 432 else if (dumpType == "System") 433 { 434 entriesPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 435 } 436 else 437 { 438 BMCWEB_LOG_ERROR << "getDumpEntriesPath() invalid dump type: " 439 << dumpType; 440 } 441 442 // Returns empty string on error 443 return entriesPath; 444 } 445 446 inline void 447 getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 448 const std::string& dumpType) 449 { 450 std::string entriesPath = getDumpEntriesPath(dumpType); 451 if (entriesPath.empty()) 452 { 453 messages::internalError(asyncResp->res); 454 return; 455 } 456 457 crow::connections::systemBus->async_method_call( 458 [asyncResp, entriesPath, 459 dumpType](const boost::system::error_code ec, 460 dbus::utility::ManagedObjectType& resp) { 461 if (ec) 462 { 463 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 464 messages::internalError(asyncResp->res); 465 return; 466 } 467 468 // Remove ending slash 469 std::string odataIdStr = entriesPath; 470 if (!odataIdStr.empty()) 471 { 472 odataIdStr.pop_back(); 473 } 474 475 asyncResp->res.jsonValue["@odata.type"] = 476 "#LogEntryCollection.LogEntryCollection"; 477 asyncResp->res.jsonValue["@odata.id"] = std::move(odataIdStr); 478 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entries"; 479 asyncResp->res.jsonValue["Description"] = 480 "Collection of " + dumpType + " Dump Entries"; 481 482 nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"]; 483 entriesArray = nlohmann::json::array(); 484 std::string dumpEntryPath = 485 "/xyz/openbmc_project/dump/" + 486 std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/"; 487 488 std::sort(resp.begin(), resp.end(), [](const auto& l, const auto& r) { 489 return AlphanumLess<std::string>()(l.first.filename(), 490 r.first.filename()); 491 }); 492 493 for (auto& object : resp) 494 { 495 if (object.first.str.find(dumpEntryPath) == std::string::npos) 496 { 497 continue; 498 } 499 uint64_t timestampUs = 0; 500 uint64_t size = 0; 501 std::string dumpStatus; 502 nlohmann::json::object_t thisEntry; 503 504 std::string entryID = object.first.filename(); 505 if (entryID.empty()) 506 { 507 continue; 508 } 509 510 parseDumpEntryFromDbusObject(object, dumpStatus, size, timestampUs, 511 asyncResp); 512 513 if (dumpStatus != 514 "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 515 !dumpStatus.empty()) 516 { 517 // Dump status is not Complete, no need to enumerate 518 continue; 519 } 520 521 thisEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 522 thisEntry["@odata.id"] = entriesPath + entryID; 523 thisEntry["Id"] = entryID; 524 thisEntry["EntryType"] = "Event"; 525 thisEntry["Name"] = dumpType + " Dump Entry"; 526 thisEntry["Created"] = 527 redfish::time_utils::getDateTimeUintUs(timestampUs); 528 529 if (dumpType == "BMC") 530 { 531 thisEntry["DiagnosticDataType"] = "Manager"; 532 thisEntry["AdditionalDataURI"] = 533 entriesPath + entryID + "/attachment"; 534 thisEntry["AdditionalDataSizeBytes"] = size; 535 } 536 else if (dumpType == "System") 537 { 538 thisEntry["DiagnosticDataType"] = "OEM"; 539 thisEntry["OEMDiagnosticDataType"] = "System"; 540 thisEntry["AdditionalDataURI"] = 541 entriesPath + entryID + "/attachment"; 542 thisEntry["AdditionalDataSizeBytes"] = size; 543 } 544 entriesArray.push_back(std::move(thisEntry)); 545 } 546 asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size(); 547 }, 548 "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 549 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 550 } 551 552 inline void 553 getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 554 const std::string& entryID, const std::string& dumpType) 555 { 556 std::string entriesPath = getDumpEntriesPath(dumpType); 557 if (entriesPath.empty()) 558 { 559 messages::internalError(asyncResp->res); 560 return; 561 } 562 563 crow::connections::systemBus->async_method_call( 564 [asyncResp, entryID, dumpType, 565 entriesPath](const boost::system::error_code ec, 566 const dbus::utility::ManagedObjectType& resp) { 567 if (ec) 568 { 569 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 570 messages::internalError(asyncResp->res); 571 return; 572 } 573 574 bool foundDumpEntry = false; 575 std::string dumpEntryPath = 576 "/xyz/openbmc_project/dump/" + 577 std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/"; 578 579 for (const auto& objectPath : resp) 580 { 581 if (objectPath.first.str != dumpEntryPath + entryID) 582 { 583 continue; 584 } 585 586 foundDumpEntry = true; 587 uint64_t timestampUs = 0; 588 uint64_t size = 0; 589 std::string dumpStatus; 590 591 parseDumpEntryFromDbusObject(objectPath, dumpStatus, size, 592 timestampUs, asyncResp); 593 594 if (dumpStatus != 595 "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 596 !dumpStatus.empty()) 597 { 598 // Dump status is not Complete 599 // return not found until status is changed to Completed 600 messages::resourceNotFound(asyncResp->res, dumpType + " dump", 601 entryID); 602 return; 603 } 604 605 asyncResp->res.jsonValue["@odata.type"] = 606 "#LogEntry.v1_9_0.LogEntry"; 607 asyncResp->res.jsonValue["@odata.id"] = entriesPath + entryID; 608 asyncResp->res.jsonValue["Id"] = entryID; 609 asyncResp->res.jsonValue["EntryType"] = "Event"; 610 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry"; 611 asyncResp->res.jsonValue["Created"] = 612 redfish::time_utils::getDateTimeUintUs(timestampUs); 613 614 if (dumpType == "BMC") 615 { 616 asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager"; 617 asyncResp->res.jsonValue["AdditionalDataURI"] = 618 entriesPath + entryID + "/attachment"; 619 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 620 } 621 else if (dumpType == "System") 622 { 623 asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM"; 624 asyncResp->res.jsonValue["OEMDiagnosticDataType"] = "System"; 625 asyncResp->res.jsonValue["AdditionalDataURI"] = 626 entriesPath + entryID + "/attachment"; 627 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 628 } 629 } 630 if (!foundDumpEntry) 631 { 632 BMCWEB_LOG_ERROR << "Can't find Dump Entry"; 633 messages::internalError(asyncResp->res); 634 return; 635 } 636 }, 637 "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 638 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 639 } 640 641 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 642 const std::string& entryID, 643 const std::string& dumpType) 644 { 645 auto respHandler = 646 [asyncResp, entryID](const boost::system::error_code ec) { 647 BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done"; 648 if (ec) 649 { 650 if (ec.value() == EBADR) 651 { 652 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 653 return; 654 } 655 BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error " 656 << ec << " entryID=" << entryID; 657 messages::internalError(asyncResp->res); 658 return; 659 } 660 }; 661 crow::connections::systemBus->async_method_call( 662 respHandler, "xyz.openbmc_project.Dump.Manager", 663 "/xyz/openbmc_project/dump/" + 664 std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/" + 665 entryID, 666 "xyz.openbmc_project.Object.Delete", "Delete"); 667 } 668 669 inline DumpCreationProgress 670 mapDbusStatusToDumpProgress(const std::string& status) 671 { 672 if (status == 673 "xyz.openbmc_project.Common.Progress.OperationStatus.Failed" || 674 status == "xyz.openbmc_project.Common.Progress.OperationStatus.Aborted") 675 { 676 return DumpCreationProgress::DUMP_CREATE_FAILED; 677 } 678 if (status == 679 "xyz.openbmc_project.Common.Progress.OperationStatus.Completed") 680 { 681 return DumpCreationProgress::DUMP_CREATE_SUCCESS; 682 } 683 return DumpCreationProgress::DUMP_CREATE_INPROGRESS; 684 } 685 686 inline DumpCreationProgress 687 getDumpCompletionStatus(const dbus::utility::DBusPropertiesMap& values) 688 { 689 for (const auto& [key, val] : values) 690 { 691 if (key == "Status") 692 { 693 const std::string* value = std::get_if<std::string>(&val); 694 if (value == nullptr) 695 { 696 BMCWEB_LOG_ERROR << "Status property value is null"; 697 return DumpCreationProgress::DUMP_CREATE_FAILED; 698 } 699 return mapDbusStatusToDumpProgress(*value); 700 } 701 } 702 return DumpCreationProgress::DUMP_CREATE_INPROGRESS; 703 } 704 705 inline std::string getDumpEntryPath(const std::string& dumpPath) 706 { 707 if (dumpPath == "/xyz/openbmc_project/dump/bmc/entry") 708 { 709 return "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 710 } 711 if (dumpPath == "/xyz/openbmc_project/dump/system/entry") 712 { 713 return "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 714 } 715 return ""; 716 } 717 718 inline void createDumpTaskCallback( 719 task::Payload&& payload, 720 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 721 const sdbusplus::message::object_path& createdObjPath) 722 { 723 const std::string dumpPath = createdObjPath.parent_path().str; 724 const std::string dumpId = createdObjPath.filename(); 725 726 std::string dumpEntryPath = getDumpEntryPath(dumpPath); 727 728 if (dumpEntryPath.empty()) 729 { 730 BMCWEB_LOG_ERROR << "Invalid dump type received"; 731 messages::internalError(asyncResp->res); 732 return; 733 } 734 735 crow::connections::systemBus->async_method_call( 736 [asyncResp, payload, createdObjPath, 737 dumpEntryPath{std::move(dumpEntryPath)}, 738 dumpId](const boost::system::error_code ec, 739 const std::string& introspectXml) { 740 if (ec) 741 { 742 BMCWEB_LOG_ERROR << "Introspect call failed with error: " 743 << ec.message(); 744 messages::internalError(asyncResp->res); 745 return; 746 } 747 748 // Check if the created dump object has implemented Progress 749 // interface to track dump completion. If yes, fetch the "Status" 750 // property of the interface, modify the task state accordingly. 751 // Else, return task completed. 752 tinyxml2::XMLDocument doc; 753 754 doc.Parse(introspectXml.data(), introspectXml.size()); 755 tinyxml2::XMLNode* pRoot = doc.FirstChildElement("node"); 756 if (pRoot == nullptr) 757 { 758 BMCWEB_LOG_ERROR << "XML document failed to parse"; 759 messages::internalError(asyncResp->res); 760 return; 761 } 762 tinyxml2::XMLElement* interfaceNode = 763 pRoot->FirstChildElement("interface"); 764 765 bool isProgressIntfPresent = false; 766 while (interfaceNode != nullptr) 767 { 768 const char* thisInterfaceName = interfaceNode->Attribute("name"); 769 if (thisInterfaceName != nullptr) 770 { 771 if (thisInterfaceName == 772 std::string_view("xyz.openbmc_project.Common.Progress")) 773 { 774 interfaceNode = 775 interfaceNode->NextSiblingElement("interface"); 776 continue; 777 } 778 isProgressIntfPresent = true; 779 break; 780 } 781 interfaceNode = interfaceNode->NextSiblingElement("interface"); 782 } 783 784 std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 785 [createdObjPath, dumpEntryPath, dumpId, isProgressIntfPresent]( 786 boost::system::error_code err, sdbusplus::message_t& msg, 787 const std::shared_ptr<task::TaskData>& taskData) { 788 if (err) 789 { 790 BMCWEB_LOG_ERROR << createdObjPath.str 791 << ": Error in creating dump"; 792 taskData->messages.emplace_back(messages::internalError()); 793 taskData->state = "Cancelled"; 794 return task::completed; 795 } 796 797 if (isProgressIntfPresent) 798 { 799 dbus::utility::DBusPropertiesMap values; 800 std::string prop; 801 msg.read(prop, values); 802 803 DumpCreationProgress dumpStatus = 804 getDumpCompletionStatus(values); 805 if (dumpStatus == DumpCreationProgress::DUMP_CREATE_FAILED) 806 { 807 BMCWEB_LOG_ERROR << createdObjPath.str 808 << ": Error in creating dump"; 809 taskData->state = "Cancelled"; 810 return task::completed; 811 } 812 813 if (dumpStatus == DumpCreationProgress::DUMP_CREATE_INPROGRESS) 814 { 815 BMCWEB_LOG_DEBUG << createdObjPath.str 816 << ": Dump creation task is in progress"; 817 return !task::completed; 818 } 819 } 820 821 nlohmann::json retMessage = messages::success(); 822 taskData->messages.emplace_back(retMessage); 823 824 std::string headerLoc = 825 "Location: " + dumpEntryPath + http_helpers::urlEncode(dumpId); 826 taskData->payload->httpHeaders.emplace_back(std::move(headerLoc)); 827 828 BMCWEB_LOG_DEBUG << createdObjPath.str 829 << ": Dump creation task completed"; 830 taskData->state = "Completed"; 831 return task::completed; 832 }, 833 "type='signal',interface='org.freedesktop.DBus.Properties'," 834 "member='PropertiesChanged',path='" + 835 createdObjPath.str + "'"); 836 837 // The task timer is set to max time limit within which the 838 // requested dump will be collected. 839 task->startTimer(std::chrono::minutes(6)); 840 task->populateResp(asyncResp->res); 841 task->payload.emplace(payload); 842 }, 843 "xyz.openbmc_project.Dump.Manager", createdObjPath, 844 "org.freedesktop.DBus.Introspectable", "Introspect"); 845 } 846 847 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 848 const crow::Request& req, const std::string& dumpType) 849 { 850 std::string dumpPath = getDumpEntriesPath(dumpType); 851 if (dumpPath.empty()) 852 { 853 messages::internalError(asyncResp->res); 854 return; 855 } 856 857 std::optional<std::string> diagnosticDataType; 858 std::optional<std::string> oemDiagnosticDataType; 859 860 if (!redfish::json_util::readJsonAction( 861 req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 862 "OEMDiagnosticDataType", oemDiagnosticDataType)) 863 { 864 return; 865 } 866 867 if (dumpType == "System") 868 { 869 if (!oemDiagnosticDataType || !diagnosticDataType) 870 { 871 BMCWEB_LOG_ERROR 872 << "CreateDump action parameter 'DiagnosticDataType'/'OEMDiagnosticDataType' value not found!"; 873 messages::actionParameterMissing( 874 asyncResp->res, "CollectDiagnosticData", 875 "DiagnosticDataType & OEMDiagnosticDataType"); 876 return; 877 } 878 if ((*oemDiagnosticDataType != "System") || 879 (*diagnosticDataType != "OEM")) 880 { 881 BMCWEB_LOG_ERROR << "Wrong parameter values passed"; 882 messages::internalError(asyncResp->res); 883 return; 884 } 885 dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/"; 886 } 887 else if (dumpType == "BMC") 888 { 889 if (!diagnosticDataType) 890 { 891 BMCWEB_LOG_ERROR 892 << "CreateDump action parameter 'DiagnosticDataType' not found!"; 893 messages::actionParameterMissing( 894 asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType"); 895 return; 896 } 897 if (*diagnosticDataType != "Manager") 898 { 899 BMCWEB_LOG_ERROR 900 << "Wrong parameter value passed for 'DiagnosticDataType'"; 901 messages::internalError(asyncResp->res); 902 return; 903 } 904 dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/"; 905 } 906 else 907 { 908 BMCWEB_LOG_ERROR << "CreateDump failed. Unknown dump type"; 909 messages::internalError(asyncResp->res); 910 return; 911 } 912 913 std::vector<std::pair<std::string, std::variant<std::string, uint64_t>>> 914 createDumpParamVec; 915 916 crow::connections::systemBus->async_method_call( 917 [asyncResp, payload(task::Payload(req)), dumpPath]( 918 const boost::system::error_code ec, const sdbusplus::message_t& msg, 919 const sdbusplus::message::object_path& objPath) mutable { 920 if (ec) 921 { 922 BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec; 923 const sd_bus_error* dbusError = msg.get_error(); 924 if (dbusError == nullptr) 925 { 926 messages::internalError(asyncResp->res); 927 return; 928 } 929 930 BMCWEB_LOG_ERROR << "CreateDump DBus error: " << dbusError->name 931 << " and error msg: " << dbusError->message; 932 if (std::string_view( 933 "xyz.openbmc_project.Common.Error.NotAllowed") == 934 dbusError->name) 935 { 936 messages::resourceInStandby(asyncResp->res); 937 return; 938 } 939 if (std::string_view( 940 "xyz.openbmc_project.Dump.Create.Error.Disabled") == 941 dbusError->name) 942 { 943 messages::serviceDisabled(asyncResp->res, dumpPath); 944 return; 945 } 946 if (std::string_view( 947 "xyz.openbmc_project.Common.Error.Unavailable") == 948 dbusError->name) 949 { 950 messages::resourceInUse(asyncResp->res); 951 return; 952 } 953 // Other Dbus errors such as: 954 // xyz.openbmc_project.Common.Error.InvalidArgument & 955 // org.freedesktop.DBus.Error.InvalidArgs are all related to 956 // the dbus call that is made here in the bmcweb 957 // implementation and has nothing to do with the client's 958 // input in the request. Hence, returning internal error 959 // back to the client. 960 messages::internalError(asyncResp->res); 961 return; 962 } 963 BMCWEB_LOG_DEBUG << "Dump Created. Path: " << objPath.str; 964 createDumpTaskCallback(std::move(payload), asyncResp, objPath); 965 }, 966 "xyz.openbmc_project.Dump.Manager", 967 "/xyz/openbmc_project/dump/" + 968 std::string(boost::algorithm::to_lower_copy(dumpType)), 969 "xyz.openbmc_project.Dump.Create", "CreateDump", createDumpParamVec); 970 } 971 972 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 973 const std::string& dumpType) 974 { 975 std::string dumpTypeLowerCopy = 976 std::string(boost::algorithm::to_lower_copy(dumpType)); 977 978 crow::connections::systemBus->async_method_call( 979 [asyncResp](const boost::system::error_code& ec) { 980 if (ec) 981 { 982 BMCWEB_LOG_ERROR << "clearDump resp_handler got error " << ec; 983 messages::internalError(asyncResp->res); 984 return; 985 } 986 }, 987 "xyz.openbmc_project.Dump.Manager", 988 "/xyz/openbmc_project/dump/" + dumpTypeLowerCopy, 989 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 990 } 991 992 inline static void 993 parseCrashdumpParameters(const dbus::utility::DBusPropertiesMap& params, 994 std::string& filename, std::string& timestamp, 995 std::string& logfile) 996 { 997 const std::string* filenamePtr = nullptr; 998 const std::string* timestampPtr = nullptr; 999 const std::string* logfilePtr = nullptr; 1000 1001 const bool success = sdbusplus::unpackPropertiesNoThrow( 1002 dbus_utils::UnpackErrorPrinter(), params, "Timestamp", timestampPtr, 1003 "Filename", filenamePtr, "Log", logfilePtr); 1004 1005 if (!success) 1006 { 1007 return; 1008 } 1009 1010 if (filenamePtr != nullptr) 1011 { 1012 filename = *filenamePtr; 1013 } 1014 1015 if (timestampPtr != nullptr) 1016 { 1017 timestamp = *timestampPtr; 1018 } 1019 1020 if (logfilePtr != nullptr) 1021 { 1022 logfile = *logfilePtr; 1023 } 1024 } 1025 1026 inline void requestRoutesSystemLogServiceCollection(App& app) 1027 { 1028 /** 1029 * Functions triggers appropriate requests on DBus 1030 */ 1031 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/") 1032 .privileges(redfish::privileges::getLogServiceCollection) 1033 .methods(boost::beast::http::verb::get)( 1034 [&app](const crow::Request& req, 1035 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1036 const std::string& systemName) { 1037 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1038 { 1039 return; 1040 } 1041 if (systemName != "system") 1042 { 1043 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 1044 systemName); 1045 return; 1046 } 1047 1048 // Collections don't include the static data added by SubRoute 1049 // because it has a duplicate entry for members 1050 asyncResp->res.jsonValue["@odata.type"] = 1051 "#LogServiceCollection.LogServiceCollection"; 1052 asyncResp->res.jsonValue["@odata.id"] = 1053 "/redfish/v1/Systems/system/LogServices"; 1054 asyncResp->res.jsonValue["Name"] = "System Log Services Collection"; 1055 asyncResp->res.jsonValue["Description"] = 1056 "Collection of LogServices for this Computer System"; 1057 nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 1058 logServiceArray = nlohmann::json::array(); 1059 nlohmann::json::object_t eventLog; 1060 eventLog["@odata.id"] = 1061 "/redfish/v1/Systems/system/LogServices/EventLog"; 1062 logServiceArray.push_back(std::move(eventLog)); 1063 #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 1064 nlohmann::json::object_t dumpLog; 1065 dumpLog["@odata.id"] = "/redfish/v1/Systems/system/LogServices/Dump"; 1066 logServiceArray.push_back(std::move(dumpLog)); 1067 #endif 1068 1069 #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG 1070 nlohmann::json::object_t crashdump; 1071 crashdump["@odata.id"] = 1072 "/redfish/v1/Systems/system/LogServices/Crashdump"; 1073 logServiceArray.push_back(std::move(crashdump)); 1074 #endif 1075 1076 #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER 1077 nlohmann::json::object_t hostlogger; 1078 hostlogger["@odata.id"] = 1079 "/redfish/v1/Systems/system/LogServices/HostLogger"; 1080 logServiceArray.push_back(std::move(hostlogger)); 1081 #endif 1082 asyncResp->res.jsonValue["Members@odata.count"] = 1083 logServiceArray.size(); 1084 1085 constexpr std::array<std::string_view, 1> interfaces = { 1086 "xyz.openbmc_project.State.Boot.PostCode"}; 1087 dbus::utility::getSubTreePaths( 1088 "/", 0, interfaces, 1089 [asyncResp](const boost::system::error_code& ec, 1090 const dbus::utility::MapperGetSubTreePathsResponse& 1091 subtreePath) { 1092 if (ec) 1093 { 1094 BMCWEB_LOG_ERROR << ec; 1095 return; 1096 } 1097 1098 for (const auto& pathStr : subtreePath) 1099 { 1100 if (pathStr.find("PostCode") != std::string::npos) 1101 { 1102 nlohmann::json& logServiceArrayLocal = 1103 asyncResp->res.jsonValue["Members"]; 1104 nlohmann::json::object_t member; 1105 member["@odata.id"] = 1106 "/redfish/v1/Systems/system/LogServices/PostCodes"; 1107 1108 logServiceArrayLocal.push_back(std::move(member)); 1109 1110 asyncResp->res.jsonValue["Members@odata.count"] = 1111 logServiceArrayLocal.size(); 1112 return; 1113 } 1114 } 1115 }); 1116 }); 1117 } 1118 1119 inline void requestRoutesEventLogService(App& app) 1120 { 1121 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/") 1122 .privileges(redfish::privileges::getLogService) 1123 .methods(boost::beast::http::verb::get)( 1124 [&app](const crow::Request& req, 1125 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1126 const std::string& systemName) { 1127 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1128 { 1129 return; 1130 } 1131 if (systemName != "system") 1132 { 1133 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 1134 systemName); 1135 return; 1136 } 1137 asyncResp->res.jsonValue["@odata.id"] = 1138 "/redfish/v1/Systems/system/LogServices/EventLog"; 1139 asyncResp->res.jsonValue["@odata.type"] = 1140 "#LogService.v1_1_0.LogService"; 1141 asyncResp->res.jsonValue["Name"] = "Event Log Service"; 1142 asyncResp->res.jsonValue["Description"] = "System Event Log Service"; 1143 asyncResp->res.jsonValue["Id"] = "EventLog"; 1144 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 1145 1146 std::pair<std::string, std::string> redfishDateTimeOffset = 1147 redfish::time_utils::getDateTimeOffsetNow(); 1148 1149 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 1150 asyncResp->res.jsonValue["DateTimeLocalOffset"] = 1151 redfishDateTimeOffset.second; 1152 1153 asyncResp->res.jsonValue["Entries"]["@odata.id"] = 1154 "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1155 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 1156 1157 {"target", 1158 "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog"}}; 1159 }); 1160 } 1161 1162 inline void requestRoutesJournalEventLogClear(App& app) 1163 { 1164 BMCWEB_ROUTE( 1165 app, 1166 "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/") 1167 .privileges({{"ConfigureComponents"}}) 1168 .methods(boost::beast::http::verb::post)( 1169 [&app](const crow::Request& req, 1170 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1171 const std::string& systemName) { 1172 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1173 { 1174 return; 1175 } 1176 if (systemName != "system") 1177 { 1178 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 1179 systemName); 1180 return; 1181 } 1182 // Clear the EventLog by deleting the log files 1183 std::vector<std::filesystem::path> redfishLogFiles; 1184 if (getRedfishLogFiles(redfishLogFiles)) 1185 { 1186 for (const std::filesystem::path& file : redfishLogFiles) 1187 { 1188 std::error_code ec; 1189 std::filesystem::remove(file, ec); 1190 } 1191 } 1192 1193 // Reload rsyslog so it knows to start new log files 1194 crow::connections::systemBus->async_method_call( 1195 [asyncResp](const boost::system::error_code ec) { 1196 if (ec) 1197 { 1198 BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec; 1199 messages::internalError(asyncResp->res); 1200 return; 1201 } 1202 1203 messages::success(asyncResp->res); 1204 }, 1205 "org.freedesktop.systemd1", "/org/freedesktop/systemd1", 1206 "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service", 1207 "replace"); 1208 }); 1209 } 1210 1211 enum class LogParseError 1212 { 1213 success, 1214 parseFailed, 1215 messageIdNotInRegistry, 1216 }; 1217 1218 static LogParseError 1219 fillEventLogEntryJson(const std::string& logEntryID, 1220 const std::string& logEntry, 1221 nlohmann::json::object_t& logEntryJson) 1222 { 1223 // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1224 // First get the Timestamp 1225 size_t space = logEntry.find_first_of(' '); 1226 if (space == std::string::npos) 1227 { 1228 return LogParseError::parseFailed; 1229 } 1230 std::string timestamp = logEntry.substr(0, space); 1231 // Then get the log contents 1232 size_t entryStart = logEntry.find_first_not_of(' ', space); 1233 if (entryStart == std::string::npos) 1234 { 1235 return LogParseError::parseFailed; 1236 } 1237 std::string_view entry(logEntry); 1238 entry.remove_prefix(entryStart); 1239 // Use split to separate the entry into its fields 1240 std::vector<std::string> logEntryFields; 1241 bmcweb::split(logEntryFields, entry, ','); 1242 // We need at least a MessageId to be valid 1243 if (logEntryFields.empty()) 1244 { 1245 return LogParseError::parseFailed; 1246 } 1247 std::string& messageID = logEntryFields[0]; 1248 1249 // Get the Message from the MessageRegistry 1250 const registries::Message* message = registries::getMessage(messageID); 1251 1252 if (message == nullptr) 1253 { 1254 BMCWEB_LOG_WARNING << "Log entry not found in registry: " << logEntry; 1255 return LogParseError::messageIdNotInRegistry; 1256 } 1257 1258 std::string msg = message->message; 1259 1260 // Get the MessageArgs from the log if there are any 1261 std::span<std::string> messageArgs; 1262 if (logEntryFields.size() > 1) 1263 { 1264 std::string& messageArgsStart = logEntryFields[1]; 1265 // If the first string is empty, assume there are no MessageArgs 1266 std::size_t messageArgsSize = 0; 1267 if (!messageArgsStart.empty()) 1268 { 1269 messageArgsSize = logEntryFields.size() - 1; 1270 } 1271 1272 messageArgs = {&messageArgsStart, messageArgsSize}; 1273 1274 // Fill the MessageArgs into the Message 1275 int i = 0; 1276 for (const std::string& messageArg : messageArgs) 1277 { 1278 std::string argStr = "%" + std::to_string(++i); 1279 size_t argPos = msg.find(argStr); 1280 if (argPos != std::string::npos) 1281 { 1282 msg.replace(argPos, argStr.length(), messageArg); 1283 } 1284 } 1285 } 1286 1287 // Get the Created time from the timestamp. The log timestamp is in RFC3339 1288 // format which matches the Redfish format except for the fractional seconds 1289 // between the '.' and the '+', so just remove them. 1290 std::size_t dot = timestamp.find_first_of('.'); 1291 std::size_t plus = timestamp.find_first_of('+'); 1292 if (dot != std::string::npos && plus != std::string::npos) 1293 { 1294 timestamp.erase(dot, plus - dot); 1295 } 1296 1297 // Fill in the log entry with the gathered data 1298 logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 1299 logEntryJson["@odata.id"] = 1300 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + logEntryID; 1301 logEntryJson["Name"] = "System Event Log Entry"; 1302 logEntryJson["Id"] = logEntryID; 1303 logEntryJson["Message"] = std::move(msg); 1304 logEntryJson["MessageId"] = std::move(messageID); 1305 logEntryJson["MessageArgs"] = messageArgs; 1306 logEntryJson["EntryType"] = "Event"; 1307 logEntryJson["Severity"] = message->messageSeverity; 1308 logEntryJson["Created"] = std::move(timestamp); 1309 return LogParseError::success; 1310 } 1311 1312 inline void requestRoutesJournalEventLogEntryCollection(App& app) 1313 { 1314 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/") 1315 .privileges(redfish::privileges::getLogEntryCollection) 1316 .methods(boost::beast::http::verb::get)( 1317 [&app](const crow::Request& req, 1318 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1319 const std::string& systemName) { 1320 query_param::QueryCapabilities capabilities = { 1321 .canDelegateTop = true, 1322 .canDelegateSkip = true, 1323 }; 1324 query_param::Query delegatedQuery; 1325 if (!redfish::setUpRedfishRouteWithDelegation( 1326 app, req, asyncResp, delegatedQuery, capabilities)) 1327 { 1328 return; 1329 } 1330 if (systemName != "system") 1331 { 1332 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 1333 systemName); 1334 return; 1335 } 1336 1337 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 1338 size_t skip = delegatedQuery.skip.value_or(0); 1339 1340 // Collections don't include the static data added by SubRoute 1341 // because it has a duplicate entry for members 1342 asyncResp->res.jsonValue["@odata.type"] = 1343 "#LogEntryCollection.LogEntryCollection"; 1344 asyncResp->res.jsonValue["@odata.id"] = 1345 "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1346 asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 1347 asyncResp->res.jsonValue["Description"] = 1348 "Collection of System Event Log Entries"; 1349 1350 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1351 logEntryArray = nlohmann::json::array(); 1352 // Go through the log files and create a unique ID for each 1353 // entry 1354 std::vector<std::filesystem::path> redfishLogFiles; 1355 getRedfishLogFiles(redfishLogFiles); 1356 uint64_t entryCount = 0; 1357 std::string logEntry; 1358 1359 // Oldest logs are in the last file, so start there and loop 1360 // backwards 1361 for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1362 it++) 1363 { 1364 std::ifstream logStream(*it); 1365 if (!logStream.is_open()) 1366 { 1367 continue; 1368 } 1369 1370 // Reset the unique ID on the first entry 1371 bool firstEntry = true; 1372 while (std::getline(logStream, logEntry)) 1373 { 1374 std::string idStr; 1375 if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1376 { 1377 continue; 1378 } 1379 firstEntry = false; 1380 1381 nlohmann::json::object_t bmcLogEntry; 1382 LogParseError status = 1383 fillEventLogEntryJson(idStr, logEntry, bmcLogEntry); 1384 if (status == LogParseError::messageIdNotInRegistry) 1385 { 1386 continue; 1387 } 1388 if (status != LogParseError::success) 1389 { 1390 messages::internalError(asyncResp->res); 1391 return; 1392 } 1393 1394 entryCount++; 1395 // Handle paging using skip (number of entries to skip from the 1396 // start) and top (number of entries to display) 1397 if (entryCount <= skip || entryCount > skip + top) 1398 { 1399 continue; 1400 } 1401 1402 logEntryArray.push_back(std::move(bmcLogEntry)); 1403 } 1404 } 1405 asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 1406 if (skip + top < entryCount) 1407 { 1408 asyncResp->res.jsonValue["Members@odata.nextLink"] = 1409 "/redfish/v1/Systems/system/LogServices/EventLog/Entries?$skip=" + 1410 std::to_string(skip + top); 1411 } 1412 }); 1413 } 1414 1415 inline void requestRoutesJournalEventLogEntry(App& app) 1416 { 1417 BMCWEB_ROUTE( 1418 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 1419 .privileges(redfish::privileges::getLogEntry) 1420 .methods(boost::beast::http::verb::get)( 1421 [&app](const crow::Request& req, 1422 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1423 const std::string& systemName, const std::string& param) { 1424 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1425 { 1426 return; 1427 } 1428 1429 if (systemName != "system") 1430 { 1431 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 1432 systemName); 1433 return; 1434 } 1435 1436 const std::string& targetID = param; 1437 1438 // Go through the log files and check the unique ID for each 1439 // entry to find the target entry 1440 std::vector<std::filesystem::path> redfishLogFiles; 1441 getRedfishLogFiles(redfishLogFiles); 1442 std::string logEntry; 1443 1444 // Oldest logs are in the last file, so start there and loop 1445 // backwards 1446 for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1447 it++) 1448 { 1449 std::ifstream logStream(*it); 1450 if (!logStream.is_open()) 1451 { 1452 continue; 1453 } 1454 1455 // Reset the unique ID on the first entry 1456 bool firstEntry = true; 1457 while (std::getline(logStream, logEntry)) 1458 { 1459 std::string idStr; 1460 if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1461 { 1462 continue; 1463 } 1464 firstEntry = false; 1465 1466 if (idStr == targetID) 1467 { 1468 nlohmann::json::object_t bmcLogEntry; 1469 LogParseError status = 1470 fillEventLogEntryJson(idStr, logEntry, bmcLogEntry); 1471 if (status != LogParseError::success) 1472 { 1473 messages::internalError(asyncResp->res); 1474 return; 1475 } 1476 asyncResp->res.jsonValue.update(bmcLogEntry); 1477 return; 1478 } 1479 } 1480 } 1481 // Requested ID was not found 1482 messages::resourceNotFound(asyncResp->res, "LogEntry", targetID); 1483 }); 1484 } 1485 1486 inline void requestRoutesDBusEventLogEntryCollection(App& app) 1487 { 1488 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/") 1489 .privileges(redfish::privileges::getLogEntryCollection) 1490 .methods(boost::beast::http::verb::get)( 1491 [&app](const crow::Request& req, 1492 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1493 const std::string& systemName) { 1494 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1495 { 1496 return; 1497 } 1498 if (systemName != "system") 1499 { 1500 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 1501 systemName); 1502 return; 1503 } 1504 1505 // Collections don't include the static data added by SubRoute 1506 // because it has a duplicate entry for members 1507 asyncResp->res.jsonValue["@odata.type"] = 1508 "#LogEntryCollection.LogEntryCollection"; 1509 asyncResp->res.jsonValue["@odata.id"] = 1510 "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1511 asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 1512 asyncResp->res.jsonValue["Description"] = 1513 "Collection of System Event Log Entries"; 1514 1515 // DBus implementation of EventLog/Entries 1516 // Make call to Logging Service to find all log entry objects 1517 crow::connections::systemBus->async_method_call( 1518 [asyncResp](const boost::system::error_code ec, 1519 const dbus::utility::ManagedObjectType& resp) { 1520 if (ec) 1521 { 1522 // TODO Handle for specific error code 1523 BMCWEB_LOG_ERROR 1524 << "getLogEntriesIfaceData resp_handler got error " << ec; 1525 messages::internalError(asyncResp->res); 1526 return; 1527 } 1528 nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"]; 1529 entriesArray = nlohmann::json::array(); 1530 for (const auto& objectPath : resp) 1531 { 1532 const uint32_t* id = nullptr; 1533 const uint64_t* timestamp = nullptr; 1534 const uint64_t* updateTimestamp = nullptr; 1535 const std::string* severity = nullptr; 1536 const std::string* message = nullptr; 1537 const std::string* filePath = nullptr; 1538 const std::string* resolution = nullptr; 1539 bool resolved = false; 1540 const std::string* notify = nullptr; 1541 1542 for (const auto& interfaceMap : objectPath.second) 1543 { 1544 if (interfaceMap.first == 1545 "xyz.openbmc_project.Logging.Entry") 1546 { 1547 for (const auto& propertyMap : interfaceMap.second) 1548 { 1549 if (propertyMap.first == "Id") 1550 { 1551 id = std::get_if<uint32_t>(&propertyMap.second); 1552 } 1553 else if (propertyMap.first == "Timestamp") 1554 { 1555 timestamp = 1556 std::get_if<uint64_t>(&propertyMap.second); 1557 } 1558 else if (propertyMap.first == "UpdateTimestamp") 1559 { 1560 updateTimestamp = 1561 std::get_if<uint64_t>(&propertyMap.second); 1562 } 1563 else if (propertyMap.first == "Severity") 1564 { 1565 severity = std::get_if<std::string>( 1566 &propertyMap.second); 1567 } 1568 else if (propertyMap.first == "Resolution") 1569 { 1570 resolution = std::get_if<std::string>( 1571 &propertyMap.second); 1572 } 1573 else if (propertyMap.first == "Message") 1574 { 1575 message = std::get_if<std::string>( 1576 &propertyMap.second); 1577 } 1578 else if (propertyMap.first == "Resolved") 1579 { 1580 const bool* resolveptr = 1581 std::get_if<bool>(&propertyMap.second); 1582 if (resolveptr == nullptr) 1583 { 1584 messages::internalError(asyncResp->res); 1585 return; 1586 } 1587 resolved = *resolveptr; 1588 } 1589 else if (propertyMap.first == 1590 "ServiceProviderNotify") 1591 { 1592 notify = std::get_if<std::string>( 1593 &propertyMap.second); 1594 if (notify == nullptr) 1595 { 1596 messages::internalError(asyncResp->res); 1597 return; 1598 } 1599 } 1600 } 1601 if (id == nullptr || message == nullptr || 1602 severity == nullptr) 1603 { 1604 messages::internalError(asyncResp->res); 1605 return; 1606 } 1607 } 1608 else if (interfaceMap.first == 1609 "xyz.openbmc_project.Common.FilePath") 1610 { 1611 for (const auto& propertyMap : interfaceMap.second) 1612 { 1613 if (propertyMap.first == "Path") 1614 { 1615 filePath = std::get_if<std::string>( 1616 &propertyMap.second); 1617 } 1618 } 1619 } 1620 } 1621 // Object path without the 1622 // xyz.openbmc_project.Logging.Entry interface, ignore 1623 // and continue. 1624 if (id == nullptr || message == nullptr || 1625 severity == nullptr || timestamp == nullptr || 1626 updateTimestamp == nullptr) 1627 { 1628 continue; 1629 } 1630 entriesArray.push_back({}); 1631 nlohmann::json& thisEntry = entriesArray.back(); 1632 thisEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 1633 thisEntry["@odata.id"] = 1634 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1635 std::to_string(*id); 1636 thisEntry["Name"] = "System Event Log Entry"; 1637 thisEntry["Id"] = std::to_string(*id); 1638 thisEntry["Message"] = *message; 1639 thisEntry["Resolved"] = resolved; 1640 if ((resolution != nullptr) && (!(*resolution).empty())) 1641 { 1642 thisEntry["Resolution"] = *resolution; 1643 } 1644 std::optional<bool> notifyAction = 1645 getProviderNotifyAction(*notify); 1646 if (notifyAction) 1647 { 1648 thisEntry["ServiceProviderNotified"] = *notifyAction; 1649 } 1650 thisEntry["EntryType"] = "Event"; 1651 thisEntry["Severity"] = 1652 translateSeverityDbusToRedfish(*severity); 1653 thisEntry["Created"] = 1654 redfish::time_utils::getDateTimeUintMs(*timestamp); 1655 thisEntry["Modified"] = 1656 redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 1657 if (filePath != nullptr) 1658 { 1659 thisEntry["AdditionalDataURI"] = 1660 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1661 std::to_string(*id) + "/attachment"; 1662 } 1663 } 1664 std::sort( 1665 entriesArray.begin(), entriesArray.end(), 1666 [](const nlohmann::json& left, const nlohmann::json& right) { 1667 return (left["Id"] <= right["Id"]); 1668 }); 1669 asyncResp->res.jsonValue["Members@odata.count"] = 1670 entriesArray.size(); 1671 }, 1672 "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging", 1673 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 1674 }); 1675 } 1676 1677 inline void requestRoutesDBusEventLogEntry(App& app) 1678 { 1679 BMCWEB_ROUTE( 1680 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 1681 .privileges(redfish::privileges::getLogEntry) 1682 .methods(boost::beast::http::verb::get)( 1683 [&app](const crow::Request& req, 1684 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1685 const std::string& systemName, const std::string& param) { 1686 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1687 { 1688 return; 1689 } 1690 if (systemName != "system") 1691 { 1692 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 1693 systemName); 1694 return; 1695 } 1696 1697 std::string entryID = param; 1698 dbus::utility::escapePathForDbus(entryID); 1699 1700 // DBus implementation of EventLog/Entries 1701 // Make call to Logging Service to find all log entry objects 1702 sdbusplus::asio::getAllProperties( 1703 *crow::connections::systemBus, "xyz.openbmc_project.Logging", 1704 "/xyz/openbmc_project/logging/entry/" + entryID, "", 1705 [asyncResp, entryID](const boost::system::error_code ec, 1706 const dbus::utility::DBusPropertiesMap& resp) { 1707 if (ec.value() == EBADR) 1708 { 1709 messages::resourceNotFound(asyncResp->res, "EventLogEntry", 1710 entryID); 1711 return; 1712 } 1713 if (ec) 1714 { 1715 BMCWEB_LOG_ERROR 1716 << "EventLogEntry (DBus) resp_handler got error " << ec; 1717 messages::internalError(asyncResp->res); 1718 return; 1719 } 1720 const uint32_t* id = nullptr; 1721 const uint64_t* timestamp = nullptr; 1722 const uint64_t* updateTimestamp = nullptr; 1723 const std::string* severity = nullptr; 1724 const std::string* message = nullptr; 1725 const std::string* filePath = nullptr; 1726 const std::string* resolution = nullptr; 1727 bool resolved = false; 1728 const std::string* notify = nullptr; 1729 1730 const bool success = sdbusplus::unpackPropertiesNoThrow( 1731 dbus_utils::UnpackErrorPrinter(), resp, "Id", id, "Timestamp", 1732 timestamp, "UpdateTimestamp", updateTimestamp, "Severity", 1733 severity, "Message", message, "Resolved", resolved, 1734 "Resolution", resolution, "Path", filePath, 1735 "ServiceProviderNotify", notify); 1736 1737 if (!success) 1738 { 1739 messages::internalError(asyncResp->res); 1740 return; 1741 } 1742 1743 if (id == nullptr || message == nullptr || severity == nullptr || 1744 timestamp == nullptr || updateTimestamp == nullptr || 1745 notify == nullptr) 1746 { 1747 messages::internalError(asyncResp->res); 1748 return; 1749 } 1750 1751 asyncResp->res.jsonValue["@odata.type"] = 1752 "#LogEntry.v1_9_0.LogEntry"; 1753 asyncResp->res.jsonValue["@odata.id"] = 1754 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1755 std::to_string(*id); 1756 asyncResp->res.jsonValue["Name"] = "System Event Log Entry"; 1757 asyncResp->res.jsonValue["Id"] = std::to_string(*id); 1758 asyncResp->res.jsonValue["Message"] = *message; 1759 asyncResp->res.jsonValue["Resolved"] = resolved; 1760 std::optional<bool> notifyAction = getProviderNotifyAction(*notify); 1761 if (notifyAction) 1762 { 1763 asyncResp->res.jsonValue["ServiceProviderNotified"] = 1764 *notifyAction; 1765 } 1766 if ((resolution != nullptr) && (!(*resolution).empty())) 1767 { 1768 asyncResp->res.jsonValue["Resolution"] = *resolution; 1769 } 1770 asyncResp->res.jsonValue["EntryType"] = "Event"; 1771 asyncResp->res.jsonValue["Severity"] = 1772 translateSeverityDbusToRedfish(*severity); 1773 asyncResp->res.jsonValue["Created"] = 1774 redfish::time_utils::getDateTimeUintMs(*timestamp); 1775 asyncResp->res.jsonValue["Modified"] = 1776 redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 1777 if (filePath != nullptr) 1778 { 1779 asyncResp->res.jsonValue["AdditionalDataURI"] = 1780 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1781 std::to_string(*id) + "/attachment"; 1782 } 1783 }); 1784 }); 1785 1786 BMCWEB_ROUTE( 1787 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 1788 .privileges(redfish::privileges::patchLogEntry) 1789 .methods(boost::beast::http::verb::patch)( 1790 [&app](const crow::Request& req, 1791 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1792 const std::string& systemName, const std::string& entryId) { 1793 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1794 { 1795 return; 1796 } 1797 if (systemName != "system") 1798 { 1799 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 1800 systemName); 1801 return; 1802 } 1803 std::optional<bool> resolved; 1804 1805 if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved", 1806 resolved)) 1807 { 1808 return; 1809 } 1810 BMCWEB_LOG_DEBUG << "Set Resolved"; 1811 1812 crow::connections::systemBus->async_method_call( 1813 [asyncResp, entryId](const boost::system::error_code ec) { 1814 if (ec) 1815 { 1816 BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 1817 messages::internalError(asyncResp->res); 1818 return; 1819 } 1820 }, 1821 "xyz.openbmc_project.Logging", 1822 "/xyz/openbmc_project/logging/entry/" + entryId, 1823 "org.freedesktop.DBus.Properties", "Set", 1824 "xyz.openbmc_project.Logging.Entry", "Resolved", 1825 dbus::utility::DbusVariantType(*resolved)); 1826 }); 1827 1828 BMCWEB_ROUTE( 1829 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 1830 .privileges(redfish::privileges::deleteLogEntry) 1831 1832 .methods(boost::beast::http::verb::delete_)( 1833 [&app](const crow::Request& req, 1834 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1835 const std::string& systemName, const std::string& param) { 1836 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1837 { 1838 return; 1839 } 1840 if (systemName != "system") 1841 { 1842 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 1843 systemName); 1844 return; 1845 } 1846 BMCWEB_LOG_DEBUG << "Do delete single event entries."; 1847 1848 std::string entryID = param; 1849 1850 dbus::utility::escapePathForDbus(entryID); 1851 1852 // Process response from Logging service. 1853 auto respHandler = 1854 [asyncResp, entryID](const boost::system::error_code ec) { 1855 BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done"; 1856 if (ec) 1857 { 1858 if (ec.value() == EBADR) 1859 { 1860 messages::resourceNotFound(asyncResp->res, "LogEntry", 1861 entryID); 1862 return; 1863 } 1864 // TODO Handle for specific error code 1865 BMCWEB_LOG_ERROR 1866 << "EventLogEntry (DBus) doDelete respHandler got error " 1867 << ec; 1868 asyncResp->res.result( 1869 boost::beast::http::status::internal_server_error); 1870 return; 1871 } 1872 1873 asyncResp->res.result(boost::beast::http::status::ok); 1874 }; 1875 1876 // Make call to Logging service to request Delete Log 1877 crow::connections::systemBus->async_method_call( 1878 respHandler, "xyz.openbmc_project.Logging", 1879 "/xyz/openbmc_project/logging/entry/" + entryID, 1880 "xyz.openbmc_project.Object.Delete", "Delete"); 1881 }); 1882 } 1883 1884 inline void requestRoutesDBusEventLogEntryDownload(App& app) 1885 { 1886 BMCWEB_ROUTE( 1887 app, 1888 "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/attachment") 1889 .privileges(redfish::privileges::getLogEntry) 1890 .methods(boost::beast::http::verb::get)( 1891 [&app](const crow::Request& req, 1892 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1893 const std::string& systemName, const std::string& param) { 1894 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1895 { 1896 return; 1897 } 1898 if (http_helpers::isContentTypeAllowed( 1899 req.getHeaderValue("Accept"), 1900 http_helpers::ContentType::OctetStream, true)) 1901 { 1902 asyncResp->res.result(boost::beast::http::status::bad_request); 1903 return; 1904 } 1905 if (systemName != "system") 1906 { 1907 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 1908 systemName); 1909 return; 1910 } 1911 1912 std::string entryID = param; 1913 dbus::utility::escapePathForDbus(entryID); 1914 1915 crow::connections::systemBus->async_method_call( 1916 [asyncResp, entryID](const boost::system::error_code ec, 1917 const sdbusplus::message::unix_fd& unixfd) { 1918 if (ec.value() == EBADR) 1919 { 1920 messages::resourceNotFound(asyncResp->res, "EventLogAttachment", 1921 entryID); 1922 return; 1923 } 1924 if (ec) 1925 { 1926 BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 1927 messages::internalError(asyncResp->res); 1928 return; 1929 } 1930 1931 int fd = -1; 1932 fd = dup(unixfd); 1933 if (fd == -1) 1934 { 1935 messages::internalError(asyncResp->res); 1936 return; 1937 } 1938 1939 long long int size = lseek(fd, 0, SEEK_END); 1940 if (size == -1) 1941 { 1942 messages::internalError(asyncResp->res); 1943 return; 1944 } 1945 1946 // Arbitrary max size of 64kb 1947 constexpr int maxFileSize = 65536; 1948 if (size > maxFileSize) 1949 { 1950 BMCWEB_LOG_ERROR << "File size exceeds maximum allowed size of " 1951 << maxFileSize; 1952 messages::internalError(asyncResp->res); 1953 return; 1954 } 1955 std::vector<char> data(static_cast<size_t>(size)); 1956 long long int rc = lseek(fd, 0, SEEK_SET); 1957 if (rc == -1) 1958 { 1959 messages::internalError(asyncResp->res); 1960 return; 1961 } 1962 rc = read(fd, data.data(), data.size()); 1963 if ((rc == -1) || (rc != size)) 1964 { 1965 messages::internalError(asyncResp->res); 1966 return; 1967 } 1968 close(fd); 1969 1970 std::string_view strData(data.data(), data.size()); 1971 std::string output = crow::utility::base64encode(strData); 1972 1973 asyncResp->res.addHeader(boost::beast::http::field::content_type, 1974 "application/octet-stream"); 1975 asyncResp->res.addHeader( 1976 boost::beast::http::field::content_transfer_encoding, "Base64"); 1977 asyncResp->res.body() = std::move(output); 1978 }, 1979 "xyz.openbmc_project.Logging", 1980 "/xyz/openbmc_project/logging/entry/" + entryID, 1981 "xyz.openbmc_project.Logging.Entry", "GetEntry"); 1982 }); 1983 } 1984 1985 constexpr const char* hostLoggerFolderPath = "/var/log/console"; 1986 1987 inline bool 1988 getHostLoggerFiles(const std::string& hostLoggerFilePath, 1989 std::vector<std::filesystem::path>& hostLoggerFiles) 1990 { 1991 std::error_code ec; 1992 std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec); 1993 if (ec) 1994 { 1995 BMCWEB_LOG_ERROR << ec.message(); 1996 return false; 1997 } 1998 for (const std::filesystem::directory_entry& it : logPath) 1999 { 2000 std::string filename = it.path().filename(); 2001 // Prefix of each log files is "log". Find the file and save the 2002 // path 2003 if (filename.starts_with("log")) 2004 { 2005 hostLoggerFiles.emplace_back(it.path()); 2006 } 2007 } 2008 // As the log files rotate, they are appended with a ".#" that is higher for 2009 // the older logs. Since we start from oldest logs, sort the name in 2010 // descending order. 2011 std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(), 2012 AlphanumLess<std::string>()); 2013 2014 return true; 2015 } 2016 2017 inline bool getHostLoggerEntries( 2018 const std::vector<std::filesystem::path>& hostLoggerFiles, uint64_t skip, 2019 uint64_t top, std::vector<std::string>& logEntries, size_t& logCount) 2020 { 2021 GzFileReader logFile; 2022 2023 // Go though all log files and expose host logs. 2024 for (const std::filesystem::path& it : hostLoggerFiles) 2025 { 2026 if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount)) 2027 { 2028 BMCWEB_LOG_ERROR << "fail to expose host logs"; 2029 return false; 2030 } 2031 } 2032 // Get lastMessage from constructor by getter 2033 std::string lastMessage = logFile.getLastMessage(); 2034 if (!lastMessage.empty()) 2035 { 2036 logCount++; 2037 if (logCount > skip && logCount <= (skip + top)) 2038 { 2039 logEntries.push_back(lastMessage); 2040 } 2041 } 2042 return true; 2043 } 2044 2045 inline void fillHostLoggerEntryJson(const std::string& logEntryID, 2046 const std::string& msg, 2047 nlohmann::json::object_t& logEntryJson) 2048 { 2049 // Fill in the log entry with the gathered data. 2050 logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 2051 logEntryJson["@odata.id"] = 2052 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/" + 2053 logEntryID; 2054 logEntryJson["Name"] = "Host Logger Entry"; 2055 logEntryJson["Id"] = logEntryID; 2056 logEntryJson["Message"] = msg; 2057 logEntryJson["EntryType"] = "Oem"; 2058 logEntryJson["Severity"] = "OK"; 2059 logEntryJson["OemRecordFormat"] = "Host Logger Entry"; 2060 } 2061 2062 inline void requestRoutesSystemHostLogger(App& app) 2063 { 2064 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/") 2065 .privileges(redfish::privileges::getLogService) 2066 .methods(boost::beast::http::verb::get)( 2067 [&app](const crow::Request& req, 2068 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2069 const std::string& systemName) { 2070 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2071 { 2072 return; 2073 } 2074 if (systemName != "system") 2075 { 2076 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 2077 systemName); 2078 return; 2079 } 2080 asyncResp->res.jsonValue["@odata.id"] = 2081 "/redfish/v1/Systems/system/LogServices/HostLogger"; 2082 asyncResp->res.jsonValue["@odata.type"] = 2083 "#LogService.v1_1_0.LogService"; 2084 asyncResp->res.jsonValue["Name"] = "Host Logger Service"; 2085 asyncResp->res.jsonValue["Description"] = "Host Logger Service"; 2086 asyncResp->res.jsonValue["Id"] = "HostLogger"; 2087 asyncResp->res.jsonValue["Entries"]["@odata.id"] = 2088 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 2089 }); 2090 } 2091 2092 inline void requestRoutesSystemHostLoggerCollection(App& app) 2093 { 2094 BMCWEB_ROUTE(app, 2095 "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/") 2096 .privileges(redfish::privileges::getLogEntry) 2097 .methods(boost::beast::http::verb::get)( 2098 [&app](const crow::Request& req, 2099 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2100 const std::string& systemName) { 2101 query_param::QueryCapabilities capabilities = { 2102 .canDelegateTop = true, 2103 .canDelegateSkip = true, 2104 }; 2105 query_param::Query delegatedQuery; 2106 if (!redfish::setUpRedfishRouteWithDelegation( 2107 app, req, asyncResp, delegatedQuery, capabilities)) 2108 { 2109 return; 2110 } 2111 if (systemName != "system") 2112 { 2113 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 2114 systemName); 2115 return; 2116 } 2117 asyncResp->res.jsonValue["@odata.id"] = 2118 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 2119 asyncResp->res.jsonValue["@odata.type"] = 2120 "#LogEntryCollection.LogEntryCollection"; 2121 asyncResp->res.jsonValue["Name"] = "HostLogger Entries"; 2122 asyncResp->res.jsonValue["Description"] = 2123 "Collection of HostLogger Entries"; 2124 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2125 logEntryArray = nlohmann::json::array(); 2126 asyncResp->res.jsonValue["Members@odata.count"] = 0; 2127 2128 std::vector<std::filesystem::path> hostLoggerFiles; 2129 if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 2130 { 2131 BMCWEB_LOG_ERROR << "fail to get host log file path"; 2132 return; 2133 } 2134 // If we weren't provided top and skip limits, use the defaults. 2135 size_t skip = delegatedQuery.skip.value_or(0); 2136 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 2137 size_t logCount = 0; 2138 // This vector only store the entries we want to expose that 2139 // control by skip and top. 2140 std::vector<std::string> logEntries; 2141 if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries, 2142 logCount)) 2143 { 2144 messages::internalError(asyncResp->res); 2145 return; 2146 } 2147 // If vector is empty, that means skip value larger than total 2148 // log count 2149 if (logEntries.empty()) 2150 { 2151 asyncResp->res.jsonValue["Members@odata.count"] = logCount; 2152 return; 2153 } 2154 if (!logEntries.empty()) 2155 { 2156 for (size_t i = 0; i < logEntries.size(); i++) 2157 { 2158 nlohmann::json::object_t hostLogEntry; 2159 fillHostLoggerEntryJson(std::to_string(skip + i), logEntries[i], 2160 hostLogEntry); 2161 logEntryArray.push_back(std::move(hostLogEntry)); 2162 } 2163 2164 asyncResp->res.jsonValue["Members@odata.count"] = logCount; 2165 if (skip + top < logCount) 2166 { 2167 asyncResp->res.jsonValue["Members@odata.nextLink"] = 2168 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries?$skip=" + 2169 std::to_string(skip + top); 2170 } 2171 } 2172 }); 2173 } 2174 2175 inline void requestRoutesSystemHostLoggerLogEntry(App& app) 2176 { 2177 BMCWEB_ROUTE( 2178 app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/<str>/") 2179 .privileges(redfish::privileges::getLogEntry) 2180 .methods(boost::beast::http::verb::get)( 2181 [&app](const crow::Request& req, 2182 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2183 const std::string& systemName, const std::string& param) { 2184 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2185 { 2186 return; 2187 } 2188 if (systemName != "system") 2189 { 2190 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 2191 systemName); 2192 return; 2193 } 2194 const std::string& targetID = param; 2195 2196 uint64_t idInt = 0; 2197 2198 // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 2199 const char* end = targetID.data() + targetID.size(); 2200 2201 auto [ptr, ec] = std::from_chars(targetID.data(), end, idInt); 2202 if (ec == std::errc::invalid_argument || 2203 ec == std::errc::result_out_of_range) 2204 { 2205 messages::resourceNotFound(asyncResp->res, "LogEntry", param); 2206 return; 2207 } 2208 2209 std::vector<std::filesystem::path> hostLoggerFiles; 2210 if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 2211 { 2212 BMCWEB_LOG_ERROR << "fail to get host log file path"; 2213 return; 2214 } 2215 2216 size_t logCount = 0; 2217 size_t top = 1; 2218 std::vector<std::string> logEntries; 2219 // We can get specific entry by skip and top. For example, if we 2220 // want to get nth entry, we can set skip = n-1 and top = 1 to 2221 // get that entry 2222 if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, logEntries, 2223 logCount)) 2224 { 2225 messages::internalError(asyncResp->res); 2226 return; 2227 } 2228 2229 if (!logEntries.empty()) 2230 { 2231 nlohmann::json::object_t hostLogEntry; 2232 fillHostLoggerEntryJson(targetID, logEntries[0], hostLogEntry); 2233 asyncResp->res.jsonValue.update(hostLogEntry); 2234 return; 2235 } 2236 2237 // Requested ID was not found 2238 messages::resourceNotFound(asyncResp->res, "LogEntry", param); 2239 }); 2240 } 2241 2242 inline void handleBMCLogServicesCollectionGet( 2243 crow::App& app, const crow::Request& req, 2244 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2245 { 2246 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2247 { 2248 return; 2249 } 2250 // Collections don't include the static data added by SubRoute 2251 // because it has a duplicate entry for members 2252 asyncResp->res.jsonValue["@odata.type"] = 2253 "#LogServiceCollection.LogServiceCollection"; 2254 asyncResp->res.jsonValue["@odata.id"] = 2255 "/redfish/v1/Managers/bmc/LogServices"; 2256 asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection"; 2257 asyncResp->res.jsonValue["Description"] = 2258 "Collection of LogServices for this Manager"; 2259 nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 2260 logServiceArray = nlohmann::json::array(); 2261 2262 #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL 2263 nlohmann::json::object_t journal; 2264 journal["@odata.id"] = "/redfish/v1/Managers/bmc/LogServices/Journal"; 2265 logServiceArray.push_back(std::move(journal)); 2266 #endif 2267 2268 asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size(); 2269 2270 #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 2271 constexpr std::array<std::string_view, 1> interfaces = { 2272 "xyz.openbmc_project.Collection.DeleteAll"}; 2273 dbus::utility::getSubTreePaths( 2274 "/xyz/openbmc_project/dump", 0, interfaces, 2275 [asyncResp]( 2276 const boost::system::error_code& ec, 2277 const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 2278 if (ec) 2279 { 2280 BMCWEB_LOG_ERROR 2281 << "handleBMCLogServicesCollectionGet respHandler got error " 2282 << ec; 2283 // Assume that getting an error simply means there are no dump 2284 // LogServices. Return without adding any error response. 2285 return; 2286 } 2287 2288 nlohmann::json& logServiceArrayLocal = 2289 asyncResp->res.jsonValue["Members"]; 2290 2291 for (const std::string& path : subTreePaths) 2292 { 2293 if (path == "/xyz/openbmc_project/dump/bmc") 2294 { 2295 nlohmann::json::object_t member; 2296 member["@odata.id"] = 2297 "/redfish/v1/Managers/bmc/LogServices/Dump"; 2298 logServiceArrayLocal.push_back(std::move(member)); 2299 } 2300 else if (path == "/xyz/openbmc_project/dump/faultlog") 2301 { 2302 nlohmann::json::object_t member; 2303 member["@odata.id"] = 2304 "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2305 logServiceArrayLocal.push_back(std::move(member)); 2306 } 2307 } 2308 2309 asyncResp->res.jsonValue["Members@odata.count"] = 2310 logServiceArrayLocal.size(); 2311 }); 2312 #endif 2313 } 2314 2315 inline void requestRoutesBMCLogServiceCollection(App& app) 2316 { 2317 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/") 2318 .privileges(redfish::privileges::getLogServiceCollection) 2319 .methods(boost::beast::http::verb::get)( 2320 std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app))); 2321 } 2322 2323 inline void requestRoutesBMCJournalLogService(App& app) 2324 { 2325 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/") 2326 .privileges(redfish::privileges::getLogService) 2327 .methods(boost::beast::http::verb::get)( 2328 [&app](const crow::Request& req, 2329 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2330 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2331 { 2332 return; 2333 } 2334 asyncResp->res.jsonValue["@odata.type"] = 2335 "#LogService.v1_1_0.LogService"; 2336 asyncResp->res.jsonValue["@odata.id"] = 2337 "/redfish/v1/Managers/bmc/LogServices/Journal"; 2338 asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service"; 2339 asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service"; 2340 asyncResp->res.jsonValue["Id"] = "Journal"; 2341 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 2342 2343 std::pair<std::string, std::string> redfishDateTimeOffset = 2344 redfish::time_utils::getDateTimeOffsetNow(); 2345 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 2346 asyncResp->res.jsonValue["DateTimeLocalOffset"] = 2347 redfishDateTimeOffset.second; 2348 2349 asyncResp->res.jsonValue["Entries"]["@odata.id"] = 2350 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 2351 }); 2352 } 2353 2354 static int 2355 fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID, 2356 sd_journal* journal, 2357 nlohmann::json::object_t& bmcJournalLogEntryJson) 2358 { 2359 // Get the Log Entry contents 2360 int ret = 0; 2361 2362 std::string message; 2363 std::string_view syslogID; 2364 ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID); 2365 if (ret < 0) 2366 { 2367 BMCWEB_LOG_ERROR << "Failed to read SYSLOG_IDENTIFIER field: " 2368 << strerror(-ret); 2369 } 2370 if (!syslogID.empty()) 2371 { 2372 message += std::string(syslogID) + ": "; 2373 } 2374 2375 std::string_view msg; 2376 ret = getJournalMetadata(journal, "MESSAGE", msg); 2377 if (ret < 0) 2378 { 2379 BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret); 2380 return 1; 2381 } 2382 message += std::string(msg); 2383 2384 // Get the severity from the PRIORITY field 2385 long int severity = 8; // Default to an invalid priority 2386 ret = getJournalMetadata(journal, "PRIORITY", 10, severity); 2387 if (ret < 0) 2388 { 2389 BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret); 2390 } 2391 2392 // Get the Created time from the timestamp 2393 std::string entryTimeStr; 2394 if (!getEntryTimestamp(journal, entryTimeStr)) 2395 { 2396 return 1; 2397 } 2398 2399 // Fill in the log entry with the gathered data 2400 bmcJournalLogEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 2401 bmcJournalLogEntryJson["@odata.id"] = 2402 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" + 2403 bmcJournalLogEntryID; 2404 bmcJournalLogEntryJson["Name"] = "BMC Journal Entry"; 2405 bmcJournalLogEntryJson["Id"] = bmcJournalLogEntryID; 2406 bmcJournalLogEntryJson["Message"] = std::move(message); 2407 bmcJournalLogEntryJson["EntryType"] = "Oem"; 2408 bmcJournalLogEntryJson["Severity"] = severity <= 2 ? "Critical" 2409 : severity <= 4 ? "Warning" 2410 : "OK"; 2411 bmcJournalLogEntryJson["OemRecordFormat"] = "BMC Journal Entry"; 2412 bmcJournalLogEntryJson["Created"] = std::move(entryTimeStr); 2413 return 0; 2414 } 2415 2416 inline void requestRoutesBMCJournalLogEntryCollection(App& app) 2417 { 2418 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/") 2419 .privileges(redfish::privileges::getLogEntryCollection) 2420 .methods(boost::beast::http::verb::get)( 2421 [&app](const crow::Request& req, 2422 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2423 query_param::QueryCapabilities capabilities = { 2424 .canDelegateTop = true, 2425 .canDelegateSkip = true, 2426 }; 2427 query_param::Query delegatedQuery; 2428 if (!redfish::setUpRedfishRouteWithDelegation( 2429 app, req, asyncResp, delegatedQuery, capabilities)) 2430 { 2431 return; 2432 } 2433 2434 size_t skip = delegatedQuery.skip.value_or(0); 2435 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 2436 2437 // Collections don't include the static data added by SubRoute 2438 // because it has a duplicate entry for members 2439 asyncResp->res.jsonValue["@odata.type"] = 2440 "#LogEntryCollection.LogEntryCollection"; 2441 asyncResp->res.jsonValue["@odata.id"] = 2442 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 2443 asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries"; 2444 asyncResp->res.jsonValue["Description"] = 2445 "Collection of BMC Journal Entries"; 2446 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2447 logEntryArray = nlohmann::json::array(); 2448 2449 // Go through the journal and use the timestamp to create a 2450 // unique ID for each entry 2451 sd_journal* journalTmp = nullptr; 2452 int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2453 if (ret < 0) 2454 { 2455 BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 2456 messages::internalError(asyncResp->res); 2457 return; 2458 } 2459 std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 2460 journalTmp, sd_journal_close); 2461 journalTmp = nullptr; 2462 uint64_t entryCount = 0; 2463 // Reset the unique ID on the first entry 2464 bool firstEntry = true; 2465 SD_JOURNAL_FOREACH(journal.get()) 2466 { 2467 entryCount++; 2468 // Handle paging using skip (number of entries to skip from 2469 // the start) and top (number of entries to display) 2470 if (entryCount <= skip || entryCount > skip + top) 2471 { 2472 continue; 2473 } 2474 2475 std::string idStr; 2476 if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2477 { 2478 continue; 2479 } 2480 firstEntry = false; 2481 2482 nlohmann::json::object_t bmcJournalLogEntry; 2483 if (fillBMCJournalLogEntryJson(idStr, journal.get(), 2484 bmcJournalLogEntry) != 0) 2485 { 2486 messages::internalError(asyncResp->res); 2487 return; 2488 } 2489 logEntryArray.push_back(std::move(bmcJournalLogEntry)); 2490 } 2491 asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 2492 if (skip + top < entryCount) 2493 { 2494 asyncResp->res.jsonValue["Members@odata.nextLink"] = 2495 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" + 2496 std::to_string(skip + top); 2497 } 2498 }); 2499 } 2500 2501 inline void requestRoutesBMCJournalLogEntry(App& app) 2502 { 2503 BMCWEB_ROUTE(app, 2504 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/") 2505 .privileges(redfish::privileges::getLogEntry) 2506 .methods(boost::beast::http::verb::get)( 2507 [&app](const crow::Request& req, 2508 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2509 const std::string& entryID) { 2510 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2511 { 2512 return; 2513 } 2514 // Convert the unique ID back to a timestamp to find the entry 2515 uint64_t ts = 0; 2516 uint64_t index = 0; 2517 if (!getTimestampFromID(asyncResp, entryID, ts, index)) 2518 { 2519 return; 2520 } 2521 2522 sd_journal* journalTmp = nullptr; 2523 int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2524 if (ret < 0) 2525 { 2526 BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 2527 messages::internalError(asyncResp->res); 2528 return; 2529 } 2530 std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 2531 journalTmp, sd_journal_close); 2532 journalTmp = nullptr; 2533 // Go to the timestamp in the log and move to the entry at the 2534 // index tracking the unique ID 2535 std::string idStr; 2536 bool firstEntry = true; 2537 ret = sd_journal_seek_realtime_usec(journal.get(), ts); 2538 if (ret < 0) 2539 { 2540 BMCWEB_LOG_ERROR << "failed to seek to an entry in journal" 2541 << strerror(-ret); 2542 messages::internalError(asyncResp->res); 2543 return; 2544 } 2545 for (uint64_t i = 0; i <= index; i++) 2546 { 2547 sd_journal_next(journal.get()); 2548 if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2549 { 2550 messages::internalError(asyncResp->res); 2551 return; 2552 } 2553 firstEntry = false; 2554 } 2555 // Confirm that the entry ID matches what was requested 2556 if (idStr != entryID) 2557 { 2558 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 2559 return; 2560 } 2561 2562 nlohmann::json::object_t bmcJournalLogEntry; 2563 if (fillBMCJournalLogEntryJson(entryID, journal.get(), 2564 bmcJournalLogEntry) != 0) 2565 { 2566 messages::internalError(asyncResp->res); 2567 return; 2568 } 2569 asyncResp->res.jsonValue.update(bmcJournalLogEntry); 2570 }); 2571 } 2572 2573 inline void 2574 getDumpServiceInfo(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2575 const std::string& dumpType) 2576 { 2577 std::string dumpPath; 2578 std::string overWritePolicy; 2579 bool collectDiagnosticDataSupported = false; 2580 2581 if (dumpType == "BMC") 2582 { 2583 dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump"; 2584 overWritePolicy = "WrapsWhenFull"; 2585 collectDiagnosticDataSupported = true; 2586 } 2587 else if (dumpType == "FaultLog") 2588 { 2589 dumpPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2590 overWritePolicy = "Unknown"; 2591 collectDiagnosticDataSupported = false; 2592 } 2593 else if (dumpType == "System") 2594 { 2595 dumpPath = "/redfish/v1/Systems/system/LogServices/Dump"; 2596 overWritePolicy = "WrapsWhenFull"; 2597 collectDiagnosticDataSupported = true; 2598 } 2599 else 2600 { 2601 BMCWEB_LOG_ERROR << "getDumpServiceInfo() invalid dump type: " 2602 << dumpType; 2603 messages::internalError(asyncResp->res); 2604 return; 2605 } 2606 2607 asyncResp->res.jsonValue["@odata.id"] = dumpPath; 2608 asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService"; 2609 asyncResp->res.jsonValue["Name"] = "Dump LogService"; 2610 asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService"; 2611 asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename(); 2612 asyncResp->res.jsonValue["OverWritePolicy"] = std::move(overWritePolicy); 2613 2614 std::pair<std::string, std::string> redfishDateTimeOffset = 2615 redfish::time_utils::getDateTimeOffsetNow(); 2616 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 2617 asyncResp->res.jsonValue["DateTimeLocalOffset"] = 2618 redfishDateTimeOffset.second; 2619 2620 asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries"; 2621 2622 if (collectDiagnosticDataSupported) 2623 { 2624 asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 2625 ["target"] = 2626 dumpPath + "/Actions/LogService.CollectDiagnosticData"; 2627 } 2628 2629 constexpr std::array<std::string_view, 1> interfaces = {deleteAllInterface}; 2630 dbus::utility::getSubTreePaths( 2631 "/xyz/openbmc_project/dump", 0, interfaces, 2632 [asyncResp, dumpType, dumpPath]( 2633 const boost::system::error_code& ec, 2634 const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 2635 if (ec) 2636 { 2637 BMCWEB_LOG_ERROR << "getDumpServiceInfo respHandler got error " 2638 << ec; 2639 // Assume that getting an error simply means there are no dump 2640 // LogServices. Return without adding any error response. 2641 return; 2642 } 2643 2644 const std::string dbusDumpPath = 2645 "/xyz/openbmc_project/dump/" + 2646 boost::algorithm::to_lower_copy(dumpType); 2647 2648 for (const std::string& path : subTreePaths) 2649 { 2650 if (path == dbusDumpPath) 2651 { 2652 asyncResp->res 2653 .jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 2654 dumpPath + "/Actions/LogService.ClearLog"; 2655 break; 2656 } 2657 } 2658 }); 2659 } 2660 2661 inline void handleLogServicesDumpServiceGet( 2662 crow::App& app, const std::string& dumpType, const crow::Request& req, 2663 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2664 { 2665 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2666 { 2667 return; 2668 } 2669 getDumpServiceInfo(asyncResp, dumpType); 2670 } 2671 2672 inline void handleLogServicesDumpServiceComputerSystemGet( 2673 crow::App& app, const crow::Request& req, 2674 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2675 const std::string& chassisId) 2676 { 2677 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2678 { 2679 return; 2680 } 2681 if (chassisId != "system") 2682 { 2683 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 2684 return; 2685 } 2686 getDumpServiceInfo(asyncResp, "System"); 2687 } 2688 2689 inline void handleLogServicesDumpEntriesCollectionGet( 2690 crow::App& app, const std::string& dumpType, const crow::Request& req, 2691 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2692 { 2693 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2694 { 2695 return; 2696 } 2697 getDumpEntryCollection(asyncResp, dumpType); 2698 } 2699 2700 inline void handleLogServicesDumpEntriesCollectionComputerSystemGet( 2701 crow::App& app, const crow::Request& req, 2702 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2703 const std::string& chassisId) 2704 { 2705 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2706 { 2707 return; 2708 } 2709 if (chassisId != "system") 2710 { 2711 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 2712 return; 2713 } 2714 getDumpEntryCollection(asyncResp, "System"); 2715 } 2716 2717 inline void handleLogServicesDumpEntryGet( 2718 crow::App& app, const std::string& dumpType, const crow::Request& req, 2719 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2720 const std::string& dumpId) 2721 { 2722 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2723 { 2724 return; 2725 } 2726 getDumpEntryById(asyncResp, dumpId, dumpType); 2727 } 2728 inline void handleLogServicesDumpEntryComputerSystemGet( 2729 crow::App& app, const crow::Request& req, 2730 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2731 const std::string& chassisId, const std::string& dumpId) 2732 { 2733 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2734 { 2735 return; 2736 } 2737 if (chassisId != "system") 2738 { 2739 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 2740 return; 2741 } 2742 getDumpEntryById(asyncResp, dumpId, "System"); 2743 } 2744 2745 inline void handleLogServicesDumpEntryDelete( 2746 crow::App& app, const std::string& dumpType, const crow::Request& req, 2747 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2748 const std::string& dumpId) 2749 { 2750 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2751 { 2752 return; 2753 } 2754 deleteDumpEntry(asyncResp, dumpId, dumpType); 2755 } 2756 2757 inline void handleLogServicesDumpEntryComputerSystemDelete( 2758 crow::App& app, const crow::Request& req, 2759 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2760 const std::string& chassisId, const std::string& dumpId) 2761 { 2762 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2763 { 2764 return; 2765 } 2766 if (chassisId != "system") 2767 { 2768 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 2769 return; 2770 } 2771 deleteDumpEntry(asyncResp, dumpId, "System"); 2772 } 2773 2774 inline void handleLogServicesDumpCollectDiagnosticDataPost( 2775 crow::App& app, const std::string& dumpType, const crow::Request& req, 2776 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2777 { 2778 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2779 { 2780 return; 2781 } 2782 createDump(asyncResp, req, dumpType); 2783 } 2784 2785 inline void handleLogServicesDumpCollectDiagnosticDataComputerSystemPost( 2786 crow::App& app, const crow::Request& req, 2787 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2788 const std::string& chassisId) 2789 { 2790 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2791 { 2792 return; 2793 } 2794 if (chassisId != "system") 2795 { 2796 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 2797 return; 2798 } 2799 createDump(asyncResp, req, "System"); 2800 } 2801 2802 inline void handleLogServicesDumpClearLogPost( 2803 crow::App& app, const std::string& dumpType, const crow::Request& req, 2804 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2805 { 2806 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2807 { 2808 return; 2809 } 2810 clearDump(asyncResp, dumpType); 2811 } 2812 2813 inline void handleLogServicesDumpClearLogComputerSystemPost( 2814 crow::App& app, const crow::Request& req, 2815 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2816 const std::string& chassisId) 2817 { 2818 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2819 { 2820 return; 2821 } 2822 if (chassisId != "system") 2823 { 2824 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 2825 return; 2826 } 2827 clearDump(asyncResp, "System"); 2828 } 2829 2830 inline void requestRoutesBMCDumpService(App& app) 2831 { 2832 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/") 2833 .privileges(redfish::privileges::getLogService) 2834 .methods(boost::beast::http::verb::get)(std::bind_front( 2835 handleLogServicesDumpServiceGet, std::ref(app), "BMC")); 2836 } 2837 2838 inline void requestRoutesBMCDumpEntryCollection(App& app) 2839 { 2840 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/") 2841 .privileges(redfish::privileges::getLogEntryCollection) 2842 .methods(boost::beast::http::verb::get)(std::bind_front( 2843 handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC")); 2844 } 2845 2846 inline void requestRoutesBMCDumpEntry(App& app) 2847 { 2848 BMCWEB_ROUTE(app, 2849 "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2850 .privileges(redfish::privileges::getLogEntry) 2851 .methods(boost::beast::http::verb::get)(std::bind_front( 2852 handleLogServicesDumpEntryGet, std::ref(app), "BMC")); 2853 2854 BMCWEB_ROUTE(app, 2855 "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2856 .privileges(redfish::privileges::deleteLogEntry) 2857 .methods(boost::beast::http::verb::delete_)(std::bind_front( 2858 handleLogServicesDumpEntryDelete, std::ref(app), "BMC")); 2859 } 2860 2861 inline void requestRoutesBMCDumpCreate(App& app) 2862 { 2863 BMCWEB_ROUTE( 2864 app, 2865 "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2866 .privileges(redfish::privileges::postLogService) 2867 .methods(boost::beast::http::verb::post)( 2868 std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost, 2869 std::ref(app), "BMC")); 2870 } 2871 2872 inline void requestRoutesBMCDumpClear(App& app) 2873 { 2874 BMCWEB_ROUTE( 2875 app, 2876 "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog/") 2877 .privileges(redfish::privileges::postLogService) 2878 .methods(boost::beast::http::verb::post)(std::bind_front( 2879 handleLogServicesDumpClearLogPost, std::ref(app), "BMC")); 2880 } 2881 2882 inline void requestRoutesFaultLogDumpService(App& app) 2883 { 2884 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/") 2885 .privileges(redfish::privileges::getLogService) 2886 .methods(boost::beast::http::verb::get)(std::bind_front( 2887 handleLogServicesDumpServiceGet, std::ref(app), "FaultLog")); 2888 } 2889 2890 inline void requestRoutesFaultLogDumpEntryCollection(App& app) 2891 { 2892 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/") 2893 .privileges(redfish::privileges::getLogEntryCollection) 2894 .methods(boost::beast::http::verb::get)( 2895 std::bind_front(handleLogServicesDumpEntriesCollectionGet, 2896 std::ref(app), "FaultLog")); 2897 } 2898 2899 inline void requestRoutesFaultLogDumpEntry(App& app) 2900 { 2901 BMCWEB_ROUTE(app, 2902 "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 2903 .privileges(redfish::privileges::getLogEntry) 2904 .methods(boost::beast::http::verb::get)(std::bind_front( 2905 handleLogServicesDumpEntryGet, std::ref(app), "FaultLog")); 2906 2907 BMCWEB_ROUTE(app, 2908 "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 2909 .privileges(redfish::privileges::deleteLogEntry) 2910 .methods(boost::beast::http::verb::delete_)(std::bind_front( 2911 handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog")); 2912 } 2913 2914 inline void requestRoutesFaultLogDumpClear(App& app) 2915 { 2916 BMCWEB_ROUTE( 2917 app, 2918 "/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog/") 2919 .privileges(redfish::privileges::postLogService) 2920 .methods(boost::beast::http::verb::post)(std::bind_front( 2921 handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog")); 2922 } 2923 2924 inline void requestRoutesSystemDumpService(App& app) 2925 { 2926 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/") 2927 .privileges(redfish::privileges::getLogService) 2928 .methods(boost::beast::http::verb::get)(std::bind_front( 2929 handleLogServicesDumpServiceComputerSystemGet, std::ref(app))); 2930 } 2931 2932 inline void requestRoutesSystemDumpEntryCollection(App& app) 2933 { 2934 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/") 2935 .privileges(redfish::privileges::getLogEntryCollection) 2936 .methods(boost::beast::http::verb::get)(std::bind_front( 2937 handleLogServicesDumpEntriesCollectionComputerSystemGet, 2938 std::ref(app))); 2939 } 2940 2941 inline void requestRoutesSystemDumpEntry(App& app) 2942 { 2943 BMCWEB_ROUTE(app, 2944 "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/") 2945 .privileges(redfish::privileges::getLogEntry) 2946 .methods(boost::beast::http::verb::get)(std::bind_front( 2947 handleLogServicesDumpEntryComputerSystemGet, std::ref(app))); 2948 2949 BMCWEB_ROUTE(app, 2950 "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/") 2951 .privileges(redfish::privileges::deleteLogEntry) 2952 .methods(boost::beast::http::verb::delete_)(std::bind_front( 2953 handleLogServicesDumpEntryComputerSystemDelete, std::ref(app))); 2954 } 2955 2956 inline void requestRoutesSystemDumpCreate(App& app) 2957 { 2958 BMCWEB_ROUTE( 2959 app, 2960 "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2961 .privileges(redfish::privileges::postLogService) 2962 .methods(boost::beast::http::verb::post)(std::bind_front( 2963 handleLogServicesDumpCollectDiagnosticDataComputerSystemPost, 2964 std::ref(app))); 2965 } 2966 2967 inline void requestRoutesSystemDumpClear(App& app) 2968 { 2969 BMCWEB_ROUTE( 2970 app, 2971 "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.ClearLog/") 2972 .privileges(redfish::privileges::postLogService) 2973 .methods(boost::beast::http::verb::post)(std::bind_front( 2974 handleLogServicesDumpClearLogComputerSystemPost, std::ref(app))); 2975 } 2976 2977 inline void requestRoutesCrashdumpService(App& app) 2978 { 2979 // Note: Deviated from redfish privilege registry for GET & HEAD 2980 // method for security reasons. 2981 /** 2982 * Functions triggers appropriate requests on DBus 2983 */ 2984 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/") 2985 // This is incorrect, should be: 2986 //.privileges(redfish::privileges::getLogService) 2987 .privileges({{"ConfigureManager"}}) 2988 .methods(boost::beast::http::verb::get)( 2989 [&app](const crow::Request& req, 2990 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2991 const std::string& systemName) { 2992 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2993 { 2994 return; 2995 } 2996 if (systemName != "system") 2997 { 2998 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 2999 systemName); 3000 return; 3001 } 3002 3003 // Copy over the static data to include the entries added by 3004 // SubRoute 3005 asyncResp->res.jsonValue["@odata.id"] = 3006 "/redfish/v1/Systems/system/LogServices/Crashdump"; 3007 asyncResp->res.jsonValue["@odata.type"] = 3008 "#LogService.v1_2_0.LogService"; 3009 asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service"; 3010 asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service"; 3011 asyncResp->res.jsonValue["Id"] = "Oem Crashdump"; 3012 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 3013 asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; 3014 3015 std::pair<std::string, std::string> redfishDateTimeOffset = 3016 redfish::time_utils::getDateTimeOffsetNow(); 3017 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 3018 asyncResp->res.jsonValue["DateTimeLocalOffset"] = 3019 redfishDateTimeOffset.second; 3020 3021 asyncResp->res.jsonValue["Entries"]["@odata.id"] = 3022 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 3023 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 3024 "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog"; 3025 asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 3026 ["target"] = 3027 "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData"; 3028 }); 3029 } 3030 3031 void inline requestRoutesCrashdumpClear(App& app) 3032 { 3033 BMCWEB_ROUTE( 3034 app, 3035 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.ClearLog/") 3036 // This is incorrect, should be: 3037 //.privileges(redfish::privileges::postLogService) 3038 .privileges({{"ConfigureComponents"}}) 3039 .methods(boost::beast::http::verb::post)( 3040 [&app](const crow::Request& req, 3041 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3042 const std::string& systemName) { 3043 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3044 { 3045 return; 3046 } 3047 if (systemName != "system") 3048 { 3049 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 3050 systemName); 3051 return; 3052 } 3053 crow::connections::systemBus->async_method_call( 3054 [asyncResp](const boost::system::error_code ec, 3055 const std::string&) { 3056 if (ec) 3057 { 3058 messages::internalError(asyncResp->res); 3059 return; 3060 } 3061 messages::success(asyncResp->res); 3062 }, 3063 crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll"); 3064 }); 3065 } 3066 3067 static void 3068 logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3069 const std::string& logID, nlohmann::json& logEntryJson) 3070 { 3071 auto getStoredLogCallback = 3072 [asyncResp, logID, 3073 &logEntryJson](const boost::system::error_code ec, 3074 const dbus::utility::DBusPropertiesMap& params) { 3075 if (ec) 3076 { 3077 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 3078 if (ec.value() == 3079 boost::system::linux_error::bad_request_descriptor) 3080 { 3081 messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 3082 } 3083 else 3084 { 3085 messages::internalError(asyncResp->res); 3086 } 3087 return; 3088 } 3089 3090 std::string timestamp{}; 3091 std::string filename{}; 3092 std::string logfile{}; 3093 parseCrashdumpParameters(params, filename, timestamp, logfile); 3094 3095 if (filename.empty() || timestamp.empty()) 3096 { 3097 messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 3098 return; 3099 } 3100 3101 std::string crashdumpURI = 3102 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + 3103 logID + "/" + filename; 3104 nlohmann::json::object_t logEntry; 3105 logEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 3106 logEntry["@odata.id"] = 3107 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + logID; 3108 logEntry["Name"] = "CPU Crashdump"; 3109 logEntry["Id"] = logID; 3110 logEntry["EntryType"] = "Oem"; 3111 logEntry["AdditionalDataURI"] = std::move(crashdumpURI); 3112 logEntry["DiagnosticDataType"] = "OEM"; 3113 logEntry["OEMDiagnosticDataType"] = "PECICrashdump"; 3114 logEntry["Created"] = std::move(timestamp); 3115 3116 // If logEntryJson references an array of LogEntry resources 3117 // ('Members' list), then push this as a new entry, otherwise set it 3118 // directly 3119 if (logEntryJson.is_array()) 3120 { 3121 logEntryJson.push_back(logEntry); 3122 asyncResp->res.jsonValue["Members@odata.count"] = 3123 logEntryJson.size(); 3124 } 3125 else 3126 { 3127 logEntryJson.update(logEntry); 3128 } 3129 }; 3130 sdbusplus::asio::getAllProperties( 3131 *crow::connections::systemBus, crashdumpObject, 3132 crashdumpPath + std::string("/") + logID, crashdumpInterface, 3133 std::move(getStoredLogCallback)); 3134 } 3135 3136 inline void requestRoutesCrashdumpEntryCollection(App& app) 3137 { 3138 // Note: Deviated from redfish privilege registry for GET & HEAD 3139 // method for security reasons. 3140 /** 3141 * Functions triggers appropriate requests on DBus 3142 */ 3143 BMCWEB_ROUTE(app, 3144 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/") 3145 // This is incorrect, should be. 3146 //.privileges(redfish::privileges::postLogEntryCollection) 3147 .privileges({{"ConfigureComponents"}}) 3148 .methods(boost::beast::http::verb::get)( 3149 [&app](const crow::Request& req, 3150 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3151 const std::string& systemName) { 3152 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3153 { 3154 return; 3155 } 3156 if (systemName != "system") 3157 { 3158 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 3159 systemName); 3160 return; 3161 } 3162 3163 constexpr std::array<std::string_view, 1> interfaces = { 3164 crashdumpInterface}; 3165 dbus::utility::getSubTreePaths( 3166 "/", 0, interfaces, 3167 [asyncResp](const boost::system::error_code& ec, 3168 const std::vector<std::string>& resp) { 3169 if (ec) 3170 { 3171 if (ec.value() != 3172 boost::system::errc::no_such_file_or_directory) 3173 { 3174 BMCWEB_LOG_DEBUG << "failed to get entries ec: " 3175 << ec.message(); 3176 messages::internalError(asyncResp->res); 3177 return; 3178 } 3179 } 3180 asyncResp->res.jsonValue["@odata.type"] = 3181 "#LogEntryCollection.LogEntryCollection"; 3182 asyncResp->res.jsonValue["@odata.id"] = 3183 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 3184 asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries"; 3185 asyncResp->res.jsonValue["Description"] = 3186 "Collection of Crashdump Entries"; 3187 asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3188 asyncResp->res.jsonValue["Members@odata.count"] = 0; 3189 3190 for (const std::string& path : resp) 3191 { 3192 const sdbusplus::message::object_path objPath(path); 3193 // Get the log ID 3194 std::string logID = objPath.filename(); 3195 if (logID.empty()) 3196 { 3197 continue; 3198 } 3199 // Add the log entry to the array 3200 logCrashdumpEntry(asyncResp, logID, 3201 asyncResp->res.jsonValue["Members"]); 3202 } 3203 }); 3204 }); 3205 } 3206 3207 inline void requestRoutesCrashdumpEntry(App& app) 3208 { 3209 // Note: Deviated from redfish privilege registry for GET & HEAD 3210 // method for security reasons. 3211 3212 BMCWEB_ROUTE( 3213 app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/") 3214 // this is incorrect, should be 3215 // .privileges(redfish::privileges::getLogEntry) 3216 .privileges({{"ConfigureComponents"}}) 3217 .methods(boost::beast::http::verb::get)( 3218 [&app](const crow::Request& req, 3219 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3220 const std::string& systemName, const std::string& param) { 3221 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3222 { 3223 return; 3224 } 3225 if (systemName != "system") 3226 { 3227 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 3228 systemName); 3229 return; 3230 } 3231 const std::string& logID = param; 3232 logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue); 3233 }); 3234 } 3235 3236 inline void requestRoutesCrashdumpFile(App& app) 3237 { 3238 // Note: Deviated from redfish privilege registry for GET & HEAD 3239 // method for security reasons. 3240 BMCWEB_ROUTE( 3241 app, 3242 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/<str>/") 3243 .privileges(redfish::privileges::getLogEntry) 3244 .methods(boost::beast::http::verb::get)( 3245 [](const crow::Request& req, 3246 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3247 const std::string& systemName, const std::string& logID, 3248 const std::string& fileName) { 3249 // Do not call getRedfishRoute here since the crashdump file is not a 3250 // Redfish resource. 3251 3252 if (systemName != "system") 3253 { 3254 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 3255 systemName); 3256 return; 3257 } 3258 3259 auto getStoredLogCallback = 3260 [asyncResp, logID, fileName, url(boost::urls::url(req.urlView))]( 3261 const boost::system::error_code ec, 3262 const std::vector< 3263 std::pair<std::string, dbus::utility::DbusVariantType>>& 3264 resp) { 3265 if (ec) 3266 { 3267 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 3268 messages::internalError(asyncResp->res); 3269 return; 3270 } 3271 3272 std::string dbusFilename{}; 3273 std::string dbusTimestamp{}; 3274 std::string dbusFilepath{}; 3275 3276 parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp, 3277 dbusFilepath); 3278 3279 if (dbusFilename.empty() || dbusTimestamp.empty() || 3280 dbusFilepath.empty()) 3281 { 3282 messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 3283 return; 3284 } 3285 3286 // Verify the file name parameter is correct 3287 if (fileName != dbusFilename) 3288 { 3289 messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 3290 return; 3291 } 3292 3293 if (!std::filesystem::exists(dbusFilepath)) 3294 { 3295 messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 3296 return; 3297 } 3298 std::ifstream ifs(dbusFilepath, std::ios::in | std::ios::binary); 3299 asyncResp->res.body() = 3300 std::string(std::istreambuf_iterator<char>{ifs}, {}); 3301 3302 // Configure this to be a file download when accessed 3303 // from a browser 3304 asyncResp->res.addHeader( 3305 boost::beast::http::field::content_disposition, "attachment"); 3306 }; 3307 sdbusplus::asio::getAllProperties( 3308 *crow::connections::systemBus, crashdumpObject, 3309 crashdumpPath + std::string("/") + logID, crashdumpInterface, 3310 std::move(getStoredLogCallback)); 3311 }); 3312 } 3313 3314 enum class OEMDiagnosticType 3315 { 3316 onDemand, 3317 telemetry, 3318 invalid, 3319 }; 3320 3321 inline OEMDiagnosticType 3322 getOEMDiagnosticType(const std::string_view& oemDiagStr) 3323 { 3324 if (oemDiagStr == "OnDemand") 3325 { 3326 return OEMDiagnosticType::onDemand; 3327 } 3328 if (oemDiagStr == "Telemetry") 3329 { 3330 return OEMDiagnosticType::telemetry; 3331 } 3332 3333 return OEMDiagnosticType::invalid; 3334 } 3335 3336 inline void requestRoutesCrashdumpCollect(App& app) 3337 { 3338 // Note: Deviated from redfish privilege registry for GET & HEAD 3339 // method for security reasons. 3340 BMCWEB_ROUTE( 3341 app, 3342 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/") 3343 // The below is incorrect; Should be ConfigureManager 3344 //.privileges(redfish::privileges::postLogService) 3345 .privileges({{"ConfigureComponents"}}) 3346 .methods(boost::beast::http::verb::post)( 3347 [&app](const crow::Request& req, 3348 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3349 const std::string& systemName) { 3350 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3351 { 3352 return; 3353 } 3354 3355 if (systemName != "system") 3356 { 3357 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 3358 systemName); 3359 return; 3360 } 3361 3362 std::string diagnosticDataType; 3363 std::string oemDiagnosticDataType; 3364 if (!redfish::json_util::readJsonAction( 3365 req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 3366 "OEMDiagnosticDataType", oemDiagnosticDataType)) 3367 { 3368 return; 3369 } 3370 3371 if (diagnosticDataType != "OEM") 3372 { 3373 BMCWEB_LOG_ERROR 3374 << "Only OEM DiagnosticDataType supported for Crashdump"; 3375 messages::actionParameterValueFormatError( 3376 asyncResp->res, diagnosticDataType, "DiagnosticDataType", 3377 "CollectDiagnosticData"); 3378 return; 3379 } 3380 3381 OEMDiagnosticType oemDiagType = 3382 getOEMDiagnosticType(oemDiagnosticDataType); 3383 3384 std::string iface; 3385 std::string method; 3386 std::string taskMatchStr; 3387 if (oemDiagType == OEMDiagnosticType::onDemand) 3388 { 3389 iface = crashdumpOnDemandInterface; 3390 method = "GenerateOnDemandLog"; 3391 taskMatchStr = "type='signal'," 3392 "interface='org.freedesktop.DBus.Properties'," 3393 "member='PropertiesChanged'," 3394 "arg0namespace='com.intel.crashdump'"; 3395 } 3396 else if (oemDiagType == OEMDiagnosticType::telemetry) 3397 { 3398 iface = crashdumpTelemetryInterface; 3399 method = "GenerateTelemetryLog"; 3400 taskMatchStr = "type='signal'," 3401 "interface='org.freedesktop.DBus.Properties'," 3402 "member='PropertiesChanged'," 3403 "arg0namespace='com.intel.crashdump'"; 3404 } 3405 else 3406 { 3407 BMCWEB_LOG_ERROR << "Unsupported OEMDiagnosticDataType: " 3408 << oemDiagnosticDataType; 3409 messages::actionParameterValueFormatError( 3410 asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType", 3411 "CollectDiagnosticData"); 3412 return; 3413 } 3414 3415 auto collectCrashdumpCallback = 3416 [asyncResp, payload(task::Payload(req)), 3417 taskMatchStr](const boost::system::error_code ec, 3418 const std::string&) mutable { 3419 if (ec) 3420 { 3421 if (ec.value() == boost::system::errc::operation_not_supported) 3422 { 3423 messages::resourceInStandby(asyncResp->res); 3424 } 3425 else if (ec.value() == 3426 boost::system::errc::device_or_resource_busy) 3427 { 3428 messages::serviceTemporarilyUnavailable(asyncResp->res, 3429 "60"); 3430 } 3431 else 3432 { 3433 messages::internalError(asyncResp->res); 3434 } 3435 return; 3436 } 3437 std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 3438 [](boost::system::error_code err, sdbusplus::message_t&, 3439 const std::shared_ptr<task::TaskData>& taskData) { 3440 if (!err) 3441 { 3442 taskData->messages.emplace_back(messages::taskCompletedOK( 3443 std::to_string(taskData->index))); 3444 taskData->state = "Completed"; 3445 } 3446 return task::completed; 3447 }, 3448 taskMatchStr); 3449 3450 task->startTimer(std::chrono::minutes(5)); 3451 task->populateResp(asyncResp->res); 3452 task->payload.emplace(std::move(payload)); 3453 }; 3454 3455 crow::connections::systemBus->async_method_call( 3456 std::move(collectCrashdumpCallback), crashdumpObject, crashdumpPath, 3457 iface, method); 3458 }); 3459 } 3460 3461 /** 3462 * DBusLogServiceActionsClear class supports POST method for ClearLog action. 3463 */ 3464 inline void requestRoutesDBusLogServiceActionsClear(App& app) 3465 { 3466 /** 3467 * Function handles POST method request. 3468 * The Clear Log actions does not require any parameter.The action deletes 3469 * all entries found in the Entries collection for this Log Service. 3470 */ 3471 3472 BMCWEB_ROUTE( 3473 app, 3474 "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/") 3475 .privileges(redfish::privileges::postLogService) 3476 .methods(boost::beast::http::verb::post)( 3477 [&app](const crow::Request& req, 3478 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3479 const std::string& systemName) { 3480 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3481 { 3482 return; 3483 } 3484 if (systemName != "system") 3485 { 3486 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 3487 systemName); 3488 return; 3489 } 3490 BMCWEB_LOG_DEBUG << "Do delete all entries."; 3491 3492 // Process response from Logging service. 3493 auto respHandler = [asyncResp](const boost::system::error_code ec) { 3494 BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done"; 3495 if (ec) 3496 { 3497 // TODO Handle for specific error code 3498 BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec; 3499 asyncResp->res.result( 3500 boost::beast::http::status::internal_server_error); 3501 return; 3502 } 3503 3504 asyncResp->res.result(boost::beast::http::status::no_content); 3505 }; 3506 3507 // Make call to Logging service to request Clear Log 3508 crow::connections::systemBus->async_method_call( 3509 respHandler, "xyz.openbmc_project.Logging", 3510 "/xyz/openbmc_project/logging", 3511 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 3512 }); 3513 } 3514 3515 /**************************************************** 3516 * Redfish PostCode interfaces 3517 * using DBUS interface: getPostCodesTS 3518 ******************************************************/ 3519 inline void requestRoutesPostCodesLogService(App& app) 3520 { 3521 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/") 3522 .privileges(redfish::privileges::getLogService) 3523 .methods(boost::beast::http::verb::get)( 3524 [&app](const crow::Request& req, 3525 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3526 const std::string& systemName) { 3527 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3528 { 3529 return; 3530 } 3531 if (systemName != "system") 3532 { 3533 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 3534 systemName); 3535 return; 3536 } 3537 asyncResp->res.jsonValue["@odata.id"] = 3538 "/redfish/v1/Systems/system/LogServices/PostCodes"; 3539 asyncResp->res.jsonValue["@odata.type"] = 3540 "#LogService.v1_1_0.LogService"; 3541 asyncResp->res.jsonValue["Name"] = "POST Code Log Service"; 3542 asyncResp->res.jsonValue["Description"] = "POST Code Log Service"; 3543 asyncResp->res.jsonValue["Id"] = "PostCodes"; 3544 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 3545 asyncResp->res.jsonValue["Entries"]["@odata.id"] = 3546 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3547 3548 std::pair<std::string, std::string> redfishDateTimeOffset = 3549 redfish::time_utils::getDateTimeOffsetNow(); 3550 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 3551 asyncResp->res.jsonValue["DateTimeLocalOffset"] = 3552 redfishDateTimeOffset.second; 3553 3554 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 3555 {"target", 3556 "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog"}}; 3557 }); 3558 } 3559 3560 inline void requestRoutesPostCodesClear(App& app) 3561 { 3562 BMCWEB_ROUTE( 3563 app, 3564 "/redfish/v1/Systems/<str>/LogServices/PostCodes/Actions/LogService.ClearLog/") 3565 // The following privilege is incorrect; It should be ConfigureManager 3566 //.privileges(redfish::privileges::postLogService) 3567 .privileges({{"ConfigureComponents"}}) 3568 .methods(boost::beast::http::verb::post)( 3569 [&app](const crow::Request& req, 3570 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3571 const std::string& systemName) { 3572 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3573 { 3574 return; 3575 } 3576 if (systemName != "system") 3577 { 3578 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 3579 systemName); 3580 return; 3581 } 3582 BMCWEB_LOG_DEBUG << "Do delete all postcodes entries."; 3583 3584 // Make call to post-code service to request clear all 3585 crow::connections::systemBus->async_method_call( 3586 [asyncResp](const boost::system::error_code ec) { 3587 if (ec) 3588 { 3589 // TODO Handle for specific error code 3590 BMCWEB_LOG_ERROR << "doClearPostCodes resp_handler got error " 3591 << ec; 3592 asyncResp->res.result( 3593 boost::beast::http::status::internal_server_error); 3594 messages::internalError(asyncResp->res); 3595 return; 3596 } 3597 }, 3598 "xyz.openbmc_project.State.Boot.PostCode0", 3599 "/xyz/openbmc_project/State/Boot/PostCode0", 3600 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 3601 }); 3602 } 3603 3604 /** 3605 * @brief Parse post code ID and get the current value and index value 3606 * eg: postCodeID=B1-2, currentValue=1, index=2 3607 * 3608 * @param[in] postCodeID Post Code ID 3609 * @param[out] currentValue Current value 3610 * @param[out] index Index value 3611 * 3612 * @return bool true if the parsing is successful, false the parsing fails 3613 */ 3614 inline static bool parsePostCode(const std::string& postCodeID, 3615 uint64_t& currentValue, uint16_t& index) 3616 { 3617 std::vector<std::string> split; 3618 bmcweb::split(split, postCodeID, '-'); 3619 if (split.size() != 2 || split[0].length() < 2 || split[0].front() != 'B') 3620 { 3621 return false; 3622 } 3623 3624 // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3625 const char* start = split[0].data() + 1; 3626 // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3627 const char* end = split[0].data() + split[0].size(); 3628 auto [ptrIndex, ecIndex] = std::from_chars(start, end, index); 3629 3630 if (ptrIndex != end || ecIndex != std::errc()) 3631 { 3632 return false; 3633 } 3634 3635 start = split[1].data(); 3636 3637 // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3638 end = split[1].data() + split[1].size(); 3639 auto [ptrValue, ecValue] = std::from_chars(start, end, currentValue); 3640 3641 return ptrValue == end && ecValue == std::errc(); 3642 } 3643 3644 static bool fillPostCodeEntry( 3645 const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3646 const boost::container::flat_map< 3647 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode, 3648 const uint16_t bootIndex, const uint64_t codeIndex = 0, 3649 const uint64_t skip = 0, const uint64_t top = 0) 3650 { 3651 // Get the Message from the MessageRegistry 3652 const registries::Message* message = 3653 registries::getMessage("OpenBMC.0.2.BIOSPOSTCode"); 3654 3655 uint64_t currentCodeIndex = 0; 3656 uint64_t firstCodeTimeUs = 0; 3657 for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 3658 code : postcode) 3659 { 3660 currentCodeIndex++; 3661 std::string postcodeEntryID = 3662 "B" + std::to_string(bootIndex) + "-" + 3663 std::to_string(currentCodeIndex); // 1 based index in EntryID string 3664 3665 uint64_t usecSinceEpoch = code.first; 3666 uint64_t usTimeOffset = 0; 3667 3668 if (1 == currentCodeIndex) 3669 { // already incremented 3670 firstCodeTimeUs = code.first; 3671 } 3672 else 3673 { 3674 usTimeOffset = code.first - firstCodeTimeUs; 3675 } 3676 3677 // skip if no specific codeIndex is specified and currentCodeIndex does 3678 // not fall between top and skip 3679 if ((codeIndex == 0) && 3680 (currentCodeIndex <= skip || currentCodeIndex > top)) 3681 { 3682 continue; 3683 } 3684 3685 // skip if a specific codeIndex is specified and does not match the 3686 // currentIndex 3687 if ((codeIndex > 0) && (currentCodeIndex != codeIndex)) 3688 { 3689 // This is done for simplicity. 1st entry is needed to calculate 3690 // time offset. To improve efficiency, one can get to the entry 3691 // directly (possibly with flatmap's nth method) 3692 continue; 3693 } 3694 3695 // currentCodeIndex is within top and skip or equal to specified code 3696 // index 3697 3698 // Get the Created time from the timestamp 3699 std::string entryTimeStr; 3700 entryTimeStr = 3701 redfish::time_utils::getDateTimeUint(usecSinceEpoch / 1000 / 1000); 3702 3703 // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex) 3704 std::ostringstream hexCode; 3705 hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex 3706 << std::get<0>(code.second); 3707 std::ostringstream timeOffsetStr; 3708 // Set Fixed -Point Notation 3709 timeOffsetStr << std::fixed; 3710 // Set precision to 4 digits 3711 timeOffsetStr << std::setprecision(4); 3712 // Add double to stream 3713 timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000; 3714 std::vector<std::string> messageArgs = { 3715 std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()}; 3716 3717 // Get MessageArgs template from message registry 3718 std::string msg; 3719 if (message != nullptr) 3720 { 3721 msg = message->message; 3722 3723 // fill in this post code value 3724 int i = 0; 3725 for (const std::string& messageArg : messageArgs) 3726 { 3727 std::string argStr = "%" + std::to_string(++i); 3728 size_t argPos = msg.find(argStr); 3729 if (argPos != std::string::npos) 3730 { 3731 msg.replace(argPos, argStr.length(), messageArg); 3732 } 3733 } 3734 } 3735 3736 // Get Severity template from message registry 3737 std::string severity; 3738 if (message != nullptr) 3739 { 3740 severity = message->messageSeverity; 3741 } 3742 3743 // Format entry 3744 nlohmann::json::object_t bmcLogEntry; 3745 bmcLogEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 3746 bmcLogEntry["@odata.id"] = 3747 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 3748 postcodeEntryID; 3749 bmcLogEntry["Name"] = "POST Code Log Entry"; 3750 bmcLogEntry["Id"] = postcodeEntryID; 3751 bmcLogEntry["Message"] = std::move(msg); 3752 bmcLogEntry["MessageId"] = "OpenBMC.0.2.BIOSPOSTCode"; 3753 bmcLogEntry["MessageArgs"] = std::move(messageArgs); 3754 bmcLogEntry["EntryType"] = "Event"; 3755 bmcLogEntry["Severity"] = std::move(severity); 3756 bmcLogEntry["Created"] = entryTimeStr; 3757 if (!std::get<std::vector<uint8_t>>(code.second).empty()) 3758 { 3759 bmcLogEntry["AdditionalDataURI"] = 3760 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 3761 postcodeEntryID + "/attachment"; 3762 } 3763 3764 // codeIndex is only specified when querying single entry, return only 3765 // that entry in this case 3766 if (codeIndex != 0) 3767 { 3768 aResp->res.jsonValue.update(bmcLogEntry); 3769 return true; 3770 } 3771 3772 nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"]; 3773 logEntryArray.push_back(std::move(bmcLogEntry)); 3774 } 3775 3776 // Return value is always false when querying multiple entries 3777 return false; 3778 } 3779 3780 static void getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3781 const std::string& entryId) 3782 { 3783 uint16_t bootIndex = 0; 3784 uint64_t codeIndex = 0; 3785 if (!parsePostCode(entryId, codeIndex, bootIndex)) 3786 { 3787 // Requested ID was not found 3788 messages::resourceNotFound(aResp->res, "LogEntry", entryId); 3789 return; 3790 } 3791 3792 if (bootIndex == 0 || codeIndex == 0) 3793 { 3794 // 0 is an invalid index 3795 messages::resourceNotFound(aResp->res, "LogEntry", entryId); 3796 return; 3797 } 3798 3799 crow::connections::systemBus->async_method_call( 3800 [aResp, entryId, bootIndex, 3801 codeIndex](const boost::system::error_code ec, 3802 const boost::container::flat_map< 3803 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 3804 postcode) { 3805 if (ec) 3806 { 3807 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3808 messages::internalError(aResp->res); 3809 return; 3810 } 3811 3812 if (postcode.empty()) 3813 { 3814 messages::resourceNotFound(aResp->res, "LogEntry", entryId); 3815 return; 3816 } 3817 3818 if (!fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex)) 3819 { 3820 messages::resourceNotFound(aResp->res, "LogEntry", entryId); 3821 return; 3822 } 3823 }, 3824 "xyz.openbmc_project.State.Boot.PostCode0", 3825 "/xyz/openbmc_project/State/Boot/PostCode0", 3826 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3827 bootIndex); 3828 } 3829 3830 static void getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3831 const uint16_t bootIndex, 3832 const uint16_t bootCount, 3833 const uint64_t entryCount, size_t skip, 3834 size_t top) 3835 { 3836 crow::connections::systemBus->async_method_call( 3837 [aResp, bootIndex, bootCount, entryCount, skip, 3838 top](const boost::system::error_code ec, 3839 const boost::container::flat_map< 3840 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 3841 postcode) { 3842 if (ec) 3843 { 3844 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3845 messages::internalError(aResp->res); 3846 return; 3847 } 3848 3849 uint64_t endCount = entryCount; 3850 if (!postcode.empty()) 3851 { 3852 endCount = entryCount + postcode.size(); 3853 if (skip < endCount && (top + skip) > entryCount) 3854 { 3855 uint64_t thisBootSkip = 3856 std::max(static_cast<uint64_t>(skip), entryCount) - 3857 entryCount; 3858 uint64_t thisBootTop = 3859 std::min(static_cast<uint64_t>(top + skip), endCount) - 3860 entryCount; 3861 3862 fillPostCodeEntry(aResp, postcode, bootIndex, 0, thisBootSkip, 3863 thisBootTop); 3864 } 3865 aResp->res.jsonValue["Members@odata.count"] = endCount; 3866 } 3867 3868 // continue to previous bootIndex 3869 if (bootIndex < bootCount) 3870 { 3871 getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1), 3872 bootCount, endCount, skip, top); 3873 } 3874 else if (skip + top < endCount) 3875 { 3876 aResp->res.jsonValue["Members@odata.nextLink"] = 3877 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=" + 3878 std::to_string(skip + top); 3879 } 3880 }, 3881 "xyz.openbmc_project.State.Boot.PostCode0", 3882 "/xyz/openbmc_project/State/Boot/PostCode0", 3883 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3884 bootIndex); 3885 } 3886 3887 static void 3888 getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3889 size_t skip, size_t top) 3890 { 3891 uint64_t entryCount = 0; 3892 sdbusplus::asio::getProperty<uint16_t>( 3893 *crow::connections::systemBus, 3894 "xyz.openbmc_project.State.Boot.PostCode0", 3895 "/xyz/openbmc_project/State/Boot/PostCode0", 3896 "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount", 3897 [aResp, entryCount, skip, top](const boost::system::error_code ec, 3898 const uint16_t bootCount) { 3899 if (ec) 3900 { 3901 BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3902 messages::internalError(aResp->res); 3903 return; 3904 } 3905 getPostCodeForBoot(aResp, 1, bootCount, entryCount, skip, top); 3906 }); 3907 } 3908 3909 inline void requestRoutesPostCodesEntryCollection(App& app) 3910 { 3911 BMCWEB_ROUTE(app, 3912 "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/") 3913 .privileges(redfish::privileges::getLogEntryCollection) 3914 .methods(boost::beast::http::verb::get)( 3915 [&app](const crow::Request& req, 3916 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3917 const std::string& systemName) { 3918 query_param::QueryCapabilities capabilities = { 3919 .canDelegateTop = true, 3920 .canDelegateSkip = true, 3921 }; 3922 query_param::Query delegatedQuery; 3923 if (!redfish::setUpRedfishRouteWithDelegation( 3924 app, req, asyncResp, delegatedQuery, capabilities)) 3925 { 3926 return; 3927 } 3928 3929 if (systemName != "system") 3930 { 3931 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 3932 systemName); 3933 return; 3934 } 3935 asyncResp->res.jsonValue["@odata.type"] = 3936 "#LogEntryCollection.LogEntryCollection"; 3937 asyncResp->res.jsonValue["@odata.id"] = 3938 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3939 asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3940 asyncResp->res.jsonValue["Description"] = 3941 "Collection of POST Code Log Entries"; 3942 asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3943 asyncResp->res.jsonValue["Members@odata.count"] = 0; 3944 size_t skip = delegatedQuery.skip.value_or(0); 3945 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 3946 getCurrentBootNumber(asyncResp, skip, top); 3947 }); 3948 } 3949 3950 inline void requestRoutesPostCodesEntryAdditionalData(App& app) 3951 { 3952 BMCWEB_ROUTE( 3953 app, 3954 "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/attachment/") 3955 .privileges(redfish::privileges::getLogEntry) 3956 .methods(boost::beast::http::verb::get)( 3957 [&app](const crow::Request& req, 3958 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3959 const std::string& systemName, 3960 const std::string& postCodeID) { 3961 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3962 { 3963 return; 3964 } 3965 if (http_helpers::isContentTypeAllowed( 3966 req.getHeaderValue("Accept"), 3967 http_helpers::ContentType::OctetStream, true)) 3968 { 3969 asyncResp->res.result(boost::beast::http::status::bad_request); 3970 return; 3971 } 3972 if (systemName != "system") 3973 { 3974 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 3975 systemName); 3976 return; 3977 } 3978 3979 uint64_t currentValue = 0; 3980 uint16_t index = 0; 3981 if (!parsePostCode(postCodeID, currentValue, index)) 3982 { 3983 messages::resourceNotFound(asyncResp->res, "LogEntry", postCodeID); 3984 return; 3985 } 3986 3987 crow::connections::systemBus->async_method_call( 3988 [asyncResp, postCodeID, currentValue]( 3989 const boost::system::error_code ec, 3990 const std::vector<std::tuple<uint64_t, std::vector<uint8_t>>>& 3991 postcodes) { 3992 if (ec.value() == EBADR) 3993 { 3994 messages::resourceNotFound(asyncResp->res, "LogEntry", 3995 postCodeID); 3996 return; 3997 } 3998 if (ec) 3999 { 4000 BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 4001 messages::internalError(asyncResp->res); 4002 return; 4003 } 4004 4005 size_t value = static_cast<size_t>(currentValue) - 1; 4006 if (value == std::string::npos || postcodes.size() < currentValue) 4007 { 4008 BMCWEB_LOG_ERROR << "Wrong currentValue value"; 4009 messages::resourceNotFound(asyncResp->res, "LogEntry", 4010 postCodeID); 4011 return; 4012 } 4013 4014 const auto& [tID, c] = postcodes[value]; 4015 if (c.empty()) 4016 { 4017 BMCWEB_LOG_INFO << "No found post code data"; 4018 messages::resourceNotFound(asyncResp->res, "LogEntry", 4019 postCodeID); 4020 return; 4021 } 4022 // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) 4023 const char* d = reinterpret_cast<const char*>(c.data()); 4024 std::string_view strData(d, c.size()); 4025 4026 asyncResp->res.addHeader(boost::beast::http::field::content_type, 4027 "application/octet-stream"); 4028 asyncResp->res.addHeader( 4029 boost::beast::http::field::content_transfer_encoding, "Base64"); 4030 asyncResp->res.body() = crow::utility::base64encode(strData); 4031 }, 4032 "xyz.openbmc_project.State.Boot.PostCode0", 4033 "/xyz/openbmc_project/State/Boot/PostCode0", 4034 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", index); 4035 }); 4036 } 4037 4038 inline void requestRoutesPostCodesEntry(App& app) 4039 { 4040 BMCWEB_ROUTE( 4041 app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/") 4042 .privileges(redfish::privileges::getLogEntry) 4043 .methods(boost::beast::http::verb::get)( 4044 [&app](const crow::Request& req, 4045 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 4046 const std::string& systemName, const std::string& targetID) { 4047 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 4048 { 4049 return; 4050 } 4051 if (systemName != "system") 4052 { 4053 messages::resourceNotFound(asyncResp->res, "ComputerSystem", 4054 systemName); 4055 return; 4056 } 4057 4058 getPostCodeForEntry(asyncResp, targetID); 4059 }); 4060 } 4061 4062 } // namespace redfish 4063