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