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_8_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_8_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_8_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 bool resolved = false; 1380 for (const auto& interfaceMap : objectPath.second) 1381 { 1382 if (interfaceMap.first == 1383 "xyz.openbmc_project.Logging.Entry") 1384 { 1385 for (const auto& propertyMap : interfaceMap.second) 1386 { 1387 if (propertyMap.first == "Id") 1388 { 1389 id = std::get_if<uint32_t>(&propertyMap.second); 1390 } 1391 else if (propertyMap.first == "Timestamp") 1392 { 1393 timestamp = 1394 std::get_if<uint64_t>(&propertyMap.second); 1395 } 1396 else if (propertyMap.first == "UpdateTimestamp") 1397 { 1398 updateTimestamp = 1399 std::get_if<uint64_t>(&propertyMap.second); 1400 } 1401 else if (propertyMap.first == "Severity") 1402 { 1403 severity = std::get_if<std::string>( 1404 &propertyMap.second); 1405 } 1406 else if (propertyMap.first == "Message") 1407 { 1408 message = std::get_if<std::string>( 1409 &propertyMap.second); 1410 } 1411 else if (propertyMap.first == "Resolved") 1412 { 1413 const bool* resolveptr = 1414 std::get_if<bool>(&propertyMap.second); 1415 if (resolveptr == nullptr) 1416 { 1417 messages::internalError(asyncResp->res); 1418 return; 1419 } 1420 resolved = *resolveptr; 1421 } 1422 } 1423 if (id == nullptr || message == nullptr || 1424 severity == nullptr) 1425 { 1426 messages::internalError(asyncResp->res); 1427 return; 1428 } 1429 } 1430 else if (interfaceMap.first == 1431 "xyz.openbmc_project.Common.FilePath") 1432 { 1433 for (const auto& propertyMap : interfaceMap.second) 1434 { 1435 if (propertyMap.first == "Path") 1436 { 1437 filePath = std::get_if<std::string>( 1438 &propertyMap.second); 1439 } 1440 } 1441 } 1442 } 1443 // Object path without the 1444 // xyz.openbmc_project.Logging.Entry interface, ignore 1445 // and continue. 1446 if (id == nullptr || message == nullptr || 1447 severity == nullptr || timestamp == nullptr || 1448 updateTimestamp == nullptr) 1449 { 1450 continue; 1451 } 1452 entriesArray.push_back({}); 1453 nlohmann::json& thisEntry = entriesArray.back(); 1454 thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 1455 thisEntry["@odata.id"] = 1456 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1457 std::to_string(*id); 1458 thisEntry["Name"] = "System Event Log Entry"; 1459 thisEntry["Id"] = std::to_string(*id); 1460 thisEntry["Message"] = *message; 1461 thisEntry["Resolved"] = resolved; 1462 thisEntry["EntryType"] = "Event"; 1463 thisEntry["Severity"] = 1464 translateSeverityDbusToRedfish(*severity); 1465 thisEntry["Created"] = 1466 redfish::time_utils::getDateTimeUintMs(*timestamp); 1467 thisEntry["Modified"] = 1468 redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 1469 if (filePath != nullptr) 1470 { 1471 thisEntry["AdditionalDataURI"] = 1472 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1473 std::to_string(*id) + "/attachment"; 1474 } 1475 } 1476 std::sort( 1477 entriesArray.begin(), entriesArray.end(), 1478 [](const nlohmann::json& left, const nlohmann::json& right) { 1479 return (left["Id"] <= right["Id"]); 1480 }); 1481 asyncResp->res.jsonValue["Members@odata.count"] = 1482 entriesArray.size(); 1483 }, 1484 "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging", 1485 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 1486 }); 1487 } 1488 1489 inline void requestRoutesDBusEventLogEntry(App& app) 1490 { 1491 BMCWEB_ROUTE( 1492 app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1493 .privileges(redfish::privileges::getLogEntry) 1494 .methods(boost::beast::http::verb::get)( 1495 [&app](const crow::Request& req, 1496 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1497 const std::string& param) { 1498 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1499 { 1500 return; 1501 } 1502 std::string entryID = param; 1503 dbus::utility::escapePathForDbus(entryID); 1504 1505 // DBus implementation of EventLog/Entries 1506 // Make call to Logging Service to find all log entry objects 1507 sdbusplus::asio::getAllProperties( 1508 *crow::connections::systemBus, "xyz.openbmc_project.Logging", 1509 "/xyz/openbmc_project/logging/entry/" + entryID, "", 1510 [asyncResp, entryID](const boost::system::error_code ec, 1511 const dbus::utility::DBusPropertiesMap& resp) { 1512 if (ec.value() == EBADR) 1513 { 1514 messages::resourceNotFound(asyncResp->res, "EventLogEntry", 1515 entryID); 1516 return; 1517 } 1518 if (ec) 1519 { 1520 BMCWEB_LOG_ERROR 1521 << "EventLogEntry (DBus) resp_handler got error " << ec; 1522 messages::internalError(asyncResp->res); 1523 return; 1524 } 1525 const uint32_t* id = nullptr; 1526 const uint64_t* timestamp = nullptr; 1527 const uint64_t* updateTimestamp = nullptr; 1528 const std::string* severity = nullptr; 1529 const std::string* message = nullptr; 1530 const std::string* filePath = nullptr; 1531 bool resolved = false; 1532 1533 const bool success = sdbusplus::unpackPropertiesNoThrow( 1534 dbus_utils::UnpackErrorPrinter(), resp, "Id", id, "Timestamp", 1535 timestamp, "UpdateTimestamp", updateTimestamp, "Severity", 1536 severity, "Message", message, "Resolved", resolved, "Path", 1537 filePath); 1538 1539 if (!success) 1540 { 1541 messages::internalError(asyncResp->res); 1542 return; 1543 } 1544 1545 if (id == nullptr || message == nullptr || severity == nullptr || 1546 timestamp == nullptr || updateTimestamp == nullptr) 1547 { 1548 messages::internalError(asyncResp->res); 1549 return; 1550 } 1551 asyncResp->res.jsonValue["@odata.type"] = 1552 "#LogEntry.v1_8_0.LogEntry"; 1553 asyncResp->res.jsonValue["@odata.id"] = 1554 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1555 std::to_string(*id); 1556 asyncResp->res.jsonValue["Name"] = "System Event Log Entry"; 1557 asyncResp->res.jsonValue["Id"] = std::to_string(*id); 1558 asyncResp->res.jsonValue["Message"] = *message; 1559 asyncResp->res.jsonValue["Resolved"] = resolved; 1560 asyncResp->res.jsonValue["EntryType"] = "Event"; 1561 asyncResp->res.jsonValue["Severity"] = 1562 translateSeverityDbusToRedfish(*severity); 1563 asyncResp->res.jsonValue["Created"] = 1564 redfish::time_utils::getDateTimeUintMs(*timestamp); 1565 asyncResp->res.jsonValue["Modified"] = 1566 redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 1567 if (filePath != nullptr) 1568 { 1569 asyncResp->res.jsonValue["AdditionalDataURI"] = 1570 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1571 std::to_string(*id) + "/attachment"; 1572 } 1573 }); 1574 }); 1575 1576 BMCWEB_ROUTE( 1577 app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1578 .privileges(redfish::privileges::patchLogEntry) 1579 .methods(boost::beast::http::verb::patch)( 1580 [&app](const crow::Request& req, 1581 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1582 const std::string& entryId) { 1583 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1584 { 1585 return; 1586 } 1587 std::optional<bool> resolved; 1588 1589 if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved", 1590 resolved)) 1591 { 1592 return; 1593 } 1594 BMCWEB_LOG_DEBUG << "Set Resolved"; 1595 1596 crow::connections::systemBus->async_method_call( 1597 [asyncResp, entryId](const boost::system::error_code ec) { 1598 if (ec) 1599 { 1600 BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 1601 messages::internalError(asyncResp->res); 1602 return; 1603 } 1604 }, 1605 "xyz.openbmc_project.Logging", 1606 "/xyz/openbmc_project/logging/entry/" + entryId, 1607 "org.freedesktop.DBus.Properties", "Set", 1608 "xyz.openbmc_project.Logging.Entry", "Resolved", 1609 dbus::utility::DbusVariantType(*resolved)); 1610 }); 1611 1612 BMCWEB_ROUTE( 1613 app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1614 .privileges(redfish::privileges::deleteLogEntry) 1615 1616 .methods(boost::beast::http::verb::delete_)( 1617 [&app](const crow::Request& req, 1618 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1619 const std::string& param) { 1620 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1621 { 1622 return; 1623 } 1624 BMCWEB_LOG_DEBUG << "Do delete single event entries."; 1625 1626 std::string entryID = param; 1627 1628 dbus::utility::escapePathForDbus(entryID); 1629 1630 // Process response from Logging service. 1631 auto respHandler = 1632 [asyncResp, entryID](const boost::system::error_code ec) { 1633 BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done"; 1634 if (ec) 1635 { 1636 if (ec.value() == EBADR) 1637 { 1638 messages::resourceNotFound(asyncResp->res, "LogEntry", 1639 entryID); 1640 return; 1641 } 1642 // TODO Handle for specific error code 1643 BMCWEB_LOG_ERROR 1644 << "EventLogEntry (DBus) doDelete respHandler got error " 1645 << ec; 1646 asyncResp->res.result( 1647 boost::beast::http::status::internal_server_error); 1648 return; 1649 } 1650 1651 asyncResp->res.result(boost::beast::http::status::ok); 1652 }; 1653 1654 // Make call to Logging service to request Delete Log 1655 crow::connections::systemBus->async_method_call( 1656 respHandler, "xyz.openbmc_project.Logging", 1657 "/xyz/openbmc_project/logging/entry/" + entryID, 1658 "xyz.openbmc_project.Object.Delete", "Delete"); 1659 }); 1660 } 1661 1662 inline void requestRoutesDBusEventLogEntryDownload(App& app) 1663 { 1664 BMCWEB_ROUTE( 1665 app, 1666 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/attachment") 1667 .privileges(redfish::privileges::getLogEntry) 1668 .methods(boost::beast::http::verb::get)( 1669 [&app](const crow::Request& req, 1670 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1671 const std::string& param) { 1672 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1673 { 1674 return; 1675 } 1676 if (!http_helpers::isOctetAccepted(req.getHeaderValue("Accept"))) 1677 { 1678 asyncResp->res.result(boost::beast::http::status::bad_request); 1679 return; 1680 } 1681 1682 std::string entryID = param; 1683 dbus::utility::escapePathForDbus(entryID); 1684 1685 crow::connections::systemBus->async_method_call( 1686 [asyncResp, entryID](const boost::system::error_code ec, 1687 const sdbusplus::message::unix_fd& unixfd) { 1688 if (ec.value() == EBADR) 1689 { 1690 messages::resourceNotFound(asyncResp->res, "EventLogAttachment", 1691 entryID); 1692 return; 1693 } 1694 if (ec) 1695 { 1696 BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 1697 messages::internalError(asyncResp->res); 1698 return; 1699 } 1700 1701 int fd = -1; 1702 fd = dup(unixfd); 1703 if (fd == -1) 1704 { 1705 messages::internalError(asyncResp->res); 1706 return; 1707 } 1708 1709 long long int size = lseek(fd, 0, SEEK_END); 1710 if (size == -1) 1711 { 1712 messages::internalError(asyncResp->res); 1713 return; 1714 } 1715 1716 // Arbitrary max size of 64kb 1717 constexpr int maxFileSize = 65536; 1718 if (size > maxFileSize) 1719 { 1720 BMCWEB_LOG_ERROR << "File size exceeds maximum allowed size of " 1721 << maxFileSize; 1722 messages::internalError(asyncResp->res); 1723 return; 1724 } 1725 std::vector<char> data(static_cast<size_t>(size)); 1726 long long int rc = lseek(fd, 0, SEEK_SET); 1727 if (rc == -1) 1728 { 1729 messages::internalError(asyncResp->res); 1730 return; 1731 } 1732 rc = read(fd, data.data(), data.size()); 1733 if ((rc == -1) || (rc != size)) 1734 { 1735 messages::internalError(asyncResp->res); 1736 return; 1737 } 1738 close(fd); 1739 1740 std::string_view strData(data.data(), data.size()); 1741 std::string output = crow::utility::base64encode(strData); 1742 1743 asyncResp->res.addHeader(boost::beast::http::field::content_type, 1744 "application/octet-stream"); 1745 asyncResp->res.addHeader( 1746 boost::beast::http::field::content_transfer_encoding, "Base64"); 1747 asyncResp->res.body() = std::move(output); 1748 }, 1749 "xyz.openbmc_project.Logging", 1750 "/xyz/openbmc_project/logging/entry/" + entryID, 1751 "xyz.openbmc_project.Logging.Entry", "GetEntry"); 1752 }); 1753 } 1754 1755 constexpr const char* hostLoggerFolderPath = "/var/log/console"; 1756 1757 inline bool 1758 getHostLoggerFiles(const std::string& hostLoggerFilePath, 1759 std::vector<std::filesystem::path>& hostLoggerFiles) 1760 { 1761 std::error_code ec; 1762 std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec); 1763 if (ec) 1764 { 1765 BMCWEB_LOG_ERROR << ec.message(); 1766 return false; 1767 } 1768 for (const std::filesystem::directory_entry& it : logPath) 1769 { 1770 std::string filename = it.path().filename(); 1771 // Prefix of each log files is "log". Find the file and save the 1772 // path 1773 if (filename.starts_with("log")) 1774 { 1775 hostLoggerFiles.emplace_back(it.path()); 1776 } 1777 } 1778 // As the log files rotate, they are appended with a ".#" that is higher for 1779 // the older logs. Since we start from oldest logs, sort the name in 1780 // descending order. 1781 std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(), 1782 AlphanumLess<std::string>()); 1783 1784 return true; 1785 } 1786 1787 inline bool getHostLoggerEntries( 1788 const std::vector<std::filesystem::path>& hostLoggerFiles, uint64_t skip, 1789 uint64_t top, std::vector<std::string>& logEntries, size_t& logCount) 1790 { 1791 GzFileReader logFile; 1792 1793 // Go though all log files and expose host logs. 1794 for (const std::filesystem::path& it : hostLoggerFiles) 1795 { 1796 if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount)) 1797 { 1798 BMCWEB_LOG_ERROR << "fail to expose host logs"; 1799 return false; 1800 } 1801 } 1802 // Get lastMessage from constructor by getter 1803 std::string lastMessage = logFile.getLastMessage(); 1804 if (!lastMessage.empty()) 1805 { 1806 logCount++; 1807 if (logCount > skip && logCount <= (skip + top)) 1808 { 1809 logEntries.push_back(lastMessage); 1810 } 1811 } 1812 return true; 1813 } 1814 1815 inline void fillHostLoggerEntryJson(const std::string& logEntryID, 1816 const std::string& msg, 1817 nlohmann::json::object_t& logEntryJson) 1818 { 1819 // Fill in the log entry with the gathered data. 1820 logEntryJson["@odata.type"] = "#LogEntry.v1_4_0.LogEntry"; 1821 logEntryJson["@odata.id"] = 1822 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/" + 1823 logEntryID; 1824 logEntryJson["Name"] = "Host Logger Entry"; 1825 logEntryJson["Id"] = logEntryID; 1826 logEntryJson["Message"] = msg; 1827 logEntryJson["EntryType"] = "Oem"; 1828 logEntryJson["Severity"] = "OK"; 1829 logEntryJson["OemRecordFormat"] = "Host Logger Entry"; 1830 } 1831 1832 inline void requestRoutesSystemHostLogger(App& app) 1833 { 1834 BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/HostLogger/") 1835 .privileges(redfish::privileges::getLogService) 1836 .methods(boost::beast::http::verb::get)( 1837 [&app](const crow::Request& req, 1838 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1839 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1840 { 1841 return; 1842 } 1843 asyncResp->res.jsonValue["@odata.id"] = 1844 "/redfish/v1/Systems/system/LogServices/HostLogger"; 1845 asyncResp->res.jsonValue["@odata.type"] = 1846 "#LogService.v1_1_0.LogService"; 1847 asyncResp->res.jsonValue["Name"] = "Host Logger Service"; 1848 asyncResp->res.jsonValue["Description"] = "Host Logger Service"; 1849 asyncResp->res.jsonValue["Id"] = "HostLogger"; 1850 asyncResp->res.jsonValue["Entries"]["@odata.id"] = 1851 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 1852 }); 1853 } 1854 1855 inline void requestRoutesSystemHostLoggerCollection(App& app) 1856 { 1857 BMCWEB_ROUTE(app, 1858 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/") 1859 .privileges(redfish::privileges::getLogEntry) 1860 .methods(boost::beast::http::verb::get)( 1861 [&app](const crow::Request& req, 1862 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1863 query_param::QueryCapabilities capabilities = { 1864 .canDelegateTop = true, 1865 .canDelegateSkip = true, 1866 }; 1867 query_param::Query delegatedQuery; 1868 if (!redfish::setUpRedfishRouteWithDelegation( 1869 app, req, asyncResp, delegatedQuery, capabilities)) 1870 { 1871 return; 1872 } 1873 asyncResp->res.jsonValue["@odata.id"] = 1874 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 1875 asyncResp->res.jsonValue["@odata.type"] = 1876 "#LogEntryCollection.LogEntryCollection"; 1877 asyncResp->res.jsonValue["Name"] = "HostLogger Entries"; 1878 asyncResp->res.jsonValue["Description"] = 1879 "Collection of HostLogger Entries"; 1880 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1881 logEntryArray = nlohmann::json::array(); 1882 asyncResp->res.jsonValue["Members@odata.count"] = 0; 1883 1884 std::vector<std::filesystem::path> hostLoggerFiles; 1885 if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 1886 { 1887 BMCWEB_LOG_ERROR << "fail to get host log file path"; 1888 return; 1889 } 1890 // If we weren't provided top and skip limits, use the defaults. 1891 size_t skip = delegatedQuery.skip.value_or(0); 1892 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 1893 size_t logCount = 0; 1894 // This vector only store the entries we want to expose that 1895 // control by skip and top. 1896 std::vector<std::string> logEntries; 1897 if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries, 1898 logCount)) 1899 { 1900 messages::internalError(asyncResp->res); 1901 return; 1902 } 1903 // If vector is empty, that means skip value larger than total 1904 // log count 1905 if (logEntries.empty()) 1906 { 1907 asyncResp->res.jsonValue["Members@odata.count"] = logCount; 1908 return; 1909 } 1910 if (!logEntries.empty()) 1911 { 1912 for (size_t i = 0; i < logEntries.size(); i++) 1913 { 1914 nlohmann::json::object_t hostLogEntry; 1915 fillHostLoggerEntryJson(std::to_string(skip + i), logEntries[i], 1916 hostLogEntry); 1917 logEntryArray.push_back(std::move(hostLogEntry)); 1918 } 1919 1920 asyncResp->res.jsonValue["Members@odata.count"] = logCount; 1921 if (skip + top < logCount) 1922 { 1923 asyncResp->res.jsonValue["Members@odata.nextLink"] = 1924 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries?$skip=" + 1925 std::to_string(skip + top); 1926 } 1927 } 1928 }); 1929 } 1930 1931 inline void requestRoutesSystemHostLoggerLogEntry(App& app) 1932 { 1933 BMCWEB_ROUTE( 1934 app, "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/<str>/") 1935 .privileges(redfish::privileges::getLogEntry) 1936 .methods(boost::beast::http::verb::get)( 1937 [&app](const crow::Request& req, 1938 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1939 const std::string& param) { 1940 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1941 { 1942 return; 1943 } 1944 const std::string& targetID = param; 1945 1946 uint64_t idInt = 0; 1947 1948 // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 1949 const char* end = targetID.data() + targetID.size(); 1950 1951 auto [ptr, ec] = std::from_chars(targetID.data(), end, idInt); 1952 if (ec == std::errc::invalid_argument) 1953 { 1954 messages::resourceMissingAtURI(asyncResp->res, req.urlView); 1955 return; 1956 } 1957 if (ec == std::errc::result_out_of_range) 1958 { 1959 messages::resourceMissingAtURI(asyncResp->res, req.urlView); 1960 return; 1961 } 1962 1963 std::vector<std::filesystem::path> hostLoggerFiles; 1964 if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 1965 { 1966 BMCWEB_LOG_ERROR << "fail to get host log file path"; 1967 return; 1968 } 1969 1970 size_t logCount = 0; 1971 size_t top = 1; 1972 std::vector<std::string> logEntries; 1973 // We can get specific entry by skip and top. For example, if we 1974 // want to get nth entry, we can set skip = n-1 and top = 1 to 1975 // get that entry 1976 if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, logEntries, 1977 logCount)) 1978 { 1979 messages::internalError(asyncResp->res); 1980 return; 1981 } 1982 1983 if (!logEntries.empty()) 1984 { 1985 nlohmann::json::object_t hostLogEntry; 1986 fillHostLoggerEntryJson(targetID, logEntries[0], hostLogEntry); 1987 asyncResp->res.jsonValue.update(hostLogEntry); 1988 return; 1989 } 1990 1991 // Requested ID was not found 1992 messages::resourceMissingAtURI(asyncResp->res, req.urlView); 1993 }); 1994 } 1995 1996 constexpr char const* dumpManagerIface = 1997 "xyz.openbmc_project.Collection.DeleteAll"; 1998 inline void handleBMCLogServicesCollectionGet( 1999 crow::App& app, const crow::Request& req, 2000 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2001 { 2002 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2003 { 2004 return; 2005 } 2006 // Collections don't include the static data added by SubRoute 2007 // because it has a duplicate entry for members 2008 asyncResp->res.jsonValue["@odata.type"] = 2009 "#LogServiceCollection.LogServiceCollection"; 2010 asyncResp->res.jsonValue["@odata.id"] = 2011 "/redfish/v1/Managers/bmc/LogServices"; 2012 asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection"; 2013 asyncResp->res.jsonValue["Description"] = 2014 "Collection of LogServices for this Manager"; 2015 nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 2016 logServiceArray = nlohmann::json::array(); 2017 2018 #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL 2019 nlohmann::json::object_t journal; 2020 journal["@odata.id"] = "/redfish/v1/Managers/bmc/LogServices/Journal"; 2021 logServiceArray.push_back(std::move(journal)); 2022 #endif 2023 2024 asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size(); 2025 2026 #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 2027 auto respHandler = 2028 [asyncResp]( 2029 const boost::system::error_code ec, 2030 const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 2031 if (ec) 2032 { 2033 BMCWEB_LOG_ERROR 2034 << "handleBMCLogServicesCollectionGet respHandler got error " 2035 << ec; 2036 // Assume that getting an error simply means there are no dump 2037 // LogServices. Return without adding any error response. 2038 return; 2039 } 2040 2041 nlohmann::json& logServiceArrayLocal = 2042 asyncResp->res.jsonValue["Members"]; 2043 2044 for (const std::string& path : subTreePaths) 2045 { 2046 if (path == "/xyz/openbmc_project/dump/bmc") 2047 { 2048 nlohmann::json::object_t member; 2049 member["@odata.id"] = 2050 "/redfish/v1/Managers/bmc/LogServices/Dump"; 2051 logServiceArrayLocal.push_back(std::move(member)); 2052 } 2053 else if (path == "/xyz/openbmc_project/dump/faultlog") 2054 { 2055 nlohmann::json::object_t member; 2056 member["@odata.id"] = 2057 "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2058 logServiceArrayLocal.push_back(std::move(member)); 2059 } 2060 } 2061 2062 asyncResp->res.jsonValue["Members@odata.count"] = 2063 logServiceArrayLocal.size(); 2064 }; 2065 2066 crow::connections::systemBus->async_method_call( 2067 respHandler, "xyz.openbmc_project.ObjectMapper", 2068 "/xyz/openbmc_project/object_mapper", 2069 "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 2070 "/xyz/openbmc_project/dump", 0, 2071 std::array<const char*, 1>{dumpManagerIface}); 2072 #endif 2073 } 2074 2075 inline void requestRoutesBMCLogServiceCollection(App& app) 2076 { 2077 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/") 2078 .privileges(redfish::privileges::getLogServiceCollection) 2079 .methods(boost::beast::http::verb::get)( 2080 std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app))); 2081 } 2082 2083 inline void requestRoutesBMCJournalLogService(App& app) 2084 { 2085 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/") 2086 .privileges(redfish::privileges::getLogService) 2087 .methods(boost::beast::http::verb::get)( 2088 [&app](const crow::Request& req, 2089 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2090 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2091 { 2092 return; 2093 } 2094 asyncResp->res.jsonValue["@odata.type"] = 2095 "#LogService.v1_1_0.LogService"; 2096 asyncResp->res.jsonValue["@odata.id"] = 2097 "/redfish/v1/Managers/bmc/LogServices/Journal"; 2098 asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service"; 2099 asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service"; 2100 asyncResp->res.jsonValue["Id"] = "BMC Journal"; 2101 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 2102 2103 std::pair<std::string, std::string> redfishDateTimeOffset = 2104 redfish::time_utils::getDateTimeOffsetNow(); 2105 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 2106 asyncResp->res.jsonValue["DateTimeLocalOffset"] = 2107 redfishDateTimeOffset.second; 2108 2109 asyncResp->res.jsonValue["Entries"]["@odata.id"] = 2110 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 2111 }); 2112 } 2113 2114 static int 2115 fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID, 2116 sd_journal* journal, 2117 nlohmann::json::object_t& bmcJournalLogEntryJson) 2118 { 2119 // Get the Log Entry contents 2120 int ret = 0; 2121 2122 std::string message; 2123 std::string_view syslogID; 2124 ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID); 2125 if (ret < 0) 2126 { 2127 BMCWEB_LOG_ERROR << "Failed to read SYSLOG_IDENTIFIER field: " 2128 << strerror(-ret); 2129 } 2130 if (!syslogID.empty()) 2131 { 2132 message += std::string(syslogID) + ": "; 2133 } 2134 2135 std::string_view msg; 2136 ret = getJournalMetadata(journal, "MESSAGE", msg); 2137 if (ret < 0) 2138 { 2139 BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret); 2140 return 1; 2141 } 2142 message += std::string(msg); 2143 2144 // Get the severity from the PRIORITY field 2145 long int severity = 8; // Default to an invalid priority 2146 ret = getJournalMetadata(journal, "PRIORITY", 10, severity); 2147 if (ret < 0) 2148 { 2149 BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret); 2150 } 2151 2152 // Get the Created time from the timestamp 2153 std::string entryTimeStr; 2154 if (!getEntryTimestamp(journal, entryTimeStr)) 2155 { 2156 return 1; 2157 } 2158 2159 // Fill in the log entry with the gathered data 2160 bmcJournalLogEntryJson["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 2161 bmcJournalLogEntryJson["@odata.id"] = 2162 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" + 2163 bmcJournalLogEntryID; 2164 bmcJournalLogEntryJson["Name"] = "BMC Journal Entry"; 2165 bmcJournalLogEntryJson["Id"] = bmcJournalLogEntryID; 2166 bmcJournalLogEntryJson["Message"] = std::move(message); 2167 bmcJournalLogEntryJson["EntryType"] = "Oem"; 2168 bmcJournalLogEntryJson["Severity"] = severity <= 2 ? "Critical" 2169 : severity <= 4 ? "Warning" 2170 : "OK"; 2171 bmcJournalLogEntryJson["OemRecordFormat"] = "BMC Journal Entry"; 2172 bmcJournalLogEntryJson["Created"] = std::move(entryTimeStr); 2173 return 0; 2174 } 2175 2176 inline void requestRoutesBMCJournalLogEntryCollection(App& app) 2177 { 2178 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/") 2179 .privileges(redfish::privileges::getLogEntryCollection) 2180 .methods(boost::beast::http::verb::get)( 2181 [&app](const crow::Request& req, 2182 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2183 query_param::QueryCapabilities capabilities = { 2184 .canDelegateTop = true, 2185 .canDelegateSkip = true, 2186 }; 2187 query_param::Query delegatedQuery; 2188 if (!redfish::setUpRedfishRouteWithDelegation( 2189 app, req, asyncResp, delegatedQuery, capabilities)) 2190 { 2191 return; 2192 } 2193 2194 size_t skip = delegatedQuery.skip.value_or(0); 2195 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 2196 2197 // Collections don't include the static data added by SubRoute 2198 // because it has a duplicate entry for members 2199 asyncResp->res.jsonValue["@odata.type"] = 2200 "#LogEntryCollection.LogEntryCollection"; 2201 asyncResp->res.jsonValue["@odata.id"] = 2202 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 2203 asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries"; 2204 asyncResp->res.jsonValue["Description"] = 2205 "Collection of BMC Journal Entries"; 2206 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2207 logEntryArray = nlohmann::json::array(); 2208 2209 // Go through the journal and use the timestamp to create a 2210 // unique ID for each entry 2211 sd_journal* journalTmp = nullptr; 2212 int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2213 if (ret < 0) 2214 { 2215 BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 2216 messages::internalError(asyncResp->res); 2217 return; 2218 } 2219 std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 2220 journalTmp, sd_journal_close); 2221 journalTmp = nullptr; 2222 uint64_t entryCount = 0; 2223 // Reset the unique ID on the first entry 2224 bool firstEntry = true; 2225 SD_JOURNAL_FOREACH(journal.get()) 2226 { 2227 entryCount++; 2228 // Handle paging using skip (number of entries to skip from 2229 // the start) and top (number of entries to display) 2230 if (entryCount <= skip || entryCount > skip + top) 2231 { 2232 continue; 2233 } 2234 2235 std::string idStr; 2236 if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2237 { 2238 continue; 2239 } 2240 firstEntry = false; 2241 2242 nlohmann::json::object_t bmcJournalLogEntry; 2243 if (fillBMCJournalLogEntryJson(idStr, journal.get(), 2244 bmcJournalLogEntry) != 0) 2245 { 2246 messages::internalError(asyncResp->res); 2247 return; 2248 } 2249 logEntryArray.push_back(std::move(bmcJournalLogEntry)); 2250 } 2251 asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 2252 if (skip + top < entryCount) 2253 { 2254 asyncResp->res.jsonValue["Members@odata.nextLink"] = 2255 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" + 2256 std::to_string(skip + top); 2257 } 2258 }); 2259 } 2260 2261 inline void requestRoutesBMCJournalLogEntry(App& app) 2262 { 2263 BMCWEB_ROUTE(app, 2264 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/") 2265 .privileges(redfish::privileges::getLogEntry) 2266 .methods(boost::beast::http::verb::get)( 2267 [&app](const crow::Request& req, 2268 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2269 const std::string& entryID) { 2270 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2271 { 2272 return; 2273 } 2274 // Convert the unique ID back to a timestamp to find the entry 2275 uint64_t ts = 0; 2276 uint64_t index = 0; 2277 if (!getTimestampFromID(asyncResp, entryID, ts, index)) 2278 { 2279 return; 2280 } 2281 2282 sd_journal* journalTmp = nullptr; 2283 int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2284 if (ret < 0) 2285 { 2286 BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 2287 messages::internalError(asyncResp->res); 2288 return; 2289 } 2290 std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 2291 journalTmp, sd_journal_close); 2292 journalTmp = nullptr; 2293 // Go to the timestamp in the log and move to the entry at the 2294 // index tracking the unique ID 2295 std::string idStr; 2296 bool firstEntry = true; 2297 ret = sd_journal_seek_realtime_usec(journal.get(), ts); 2298 if (ret < 0) 2299 { 2300 BMCWEB_LOG_ERROR << "failed to seek to an entry in journal" 2301 << strerror(-ret); 2302 messages::internalError(asyncResp->res); 2303 return; 2304 } 2305 for (uint64_t i = 0; i <= index; i++) 2306 { 2307 sd_journal_next(journal.get()); 2308 if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2309 { 2310 messages::internalError(asyncResp->res); 2311 return; 2312 } 2313 firstEntry = false; 2314 } 2315 // Confirm that the entry ID matches what was requested 2316 if (idStr != entryID) 2317 { 2318 messages::resourceMissingAtURI(asyncResp->res, req.urlView); 2319 return; 2320 } 2321 2322 nlohmann::json::object_t bmcJournalLogEntry; 2323 if (fillBMCJournalLogEntryJson(entryID, journal.get(), 2324 bmcJournalLogEntry) != 0) 2325 { 2326 messages::internalError(asyncResp->res); 2327 return; 2328 } 2329 asyncResp->res.jsonValue.update(bmcJournalLogEntry); 2330 }); 2331 } 2332 2333 inline void 2334 getDumpServiceInfo(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2335 const std::string& dumpType) 2336 { 2337 std::string dumpPath; 2338 std::string overWritePolicy; 2339 bool collectDiagnosticDataSupported = false; 2340 2341 if (dumpType == "BMC") 2342 { 2343 dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump"; 2344 overWritePolicy = "WrapsWhenFull"; 2345 collectDiagnosticDataSupported = true; 2346 } 2347 else if (dumpType == "FaultLog") 2348 { 2349 dumpPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2350 overWritePolicy = "Unknown"; 2351 collectDiagnosticDataSupported = false; 2352 } 2353 else if (dumpType == "System") 2354 { 2355 dumpPath = "/redfish/v1/Systems/system/LogServices/Dump"; 2356 overWritePolicy = "WrapsWhenFull"; 2357 collectDiagnosticDataSupported = true; 2358 } 2359 else 2360 { 2361 BMCWEB_LOG_ERROR << "getDumpServiceInfo() invalid dump type: " 2362 << dumpType; 2363 messages::internalError(asyncResp->res); 2364 return; 2365 } 2366 2367 asyncResp->res.jsonValue["@odata.id"] = dumpPath; 2368 asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService"; 2369 asyncResp->res.jsonValue["Name"] = "Dump LogService"; 2370 asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService"; 2371 asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename(); 2372 asyncResp->res.jsonValue["OverWritePolicy"] = std::move(overWritePolicy); 2373 2374 std::pair<std::string, std::string> redfishDateTimeOffset = 2375 redfish::time_utils::getDateTimeOffsetNow(); 2376 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 2377 asyncResp->res.jsonValue["DateTimeLocalOffset"] = 2378 redfishDateTimeOffset.second; 2379 2380 asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries"; 2381 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 2382 dumpPath + "/Actions/LogService.ClearLog"; 2383 2384 if (collectDiagnosticDataSupported) 2385 { 2386 asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 2387 ["target"] = 2388 dumpPath + "/Actions/LogService.CollectDiagnosticData"; 2389 } 2390 } 2391 2392 inline void handleLogServicesDumpServiceGet( 2393 crow::App& app, const std::string& dumpType, const crow::Request& req, 2394 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2395 { 2396 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2397 { 2398 return; 2399 } 2400 getDumpServiceInfo(asyncResp, dumpType); 2401 } 2402 2403 inline void handleLogServicesDumpEntriesCollectionGet( 2404 crow::App& app, const std::string& dumpType, const crow::Request& req, 2405 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2406 { 2407 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2408 { 2409 return; 2410 } 2411 getDumpEntryCollection(asyncResp, dumpType); 2412 } 2413 2414 inline void handleLogServicesDumpEntryGet( 2415 crow::App& app, const std::string& dumpType, const crow::Request& req, 2416 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2417 const std::string& dumpId) 2418 { 2419 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2420 { 2421 return; 2422 } 2423 getDumpEntryById(asyncResp, dumpId, dumpType); 2424 } 2425 2426 inline void handleLogServicesDumpEntryDelete( 2427 crow::App& app, const std::string& dumpType, const crow::Request& req, 2428 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2429 const std::string& dumpId) 2430 { 2431 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2432 { 2433 return; 2434 } 2435 deleteDumpEntry(asyncResp, dumpId, dumpType); 2436 } 2437 2438 inline void handleLogServicesDumpCollectDiagnosticDataPost( 2439 crow::App& app, const std::string& dumpType, const crow::Request& req, 2440 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2441 { 2442 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2443 { 2444 return; 2445 } 2446 createDump(asyncResp, req, dumpType); 2447 } 2448 2449 inline void handleLogServicesDumpClearLogPost( 2450 crow::App& app, const std::string& dumpType, const crow::Request& req, 2451 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2452 { 2453 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2454 { 2455 return; 2456 } 2457 clearDump(asyncResp, dumpType); 2458 } 2459 2460 inline void requestRoutesBMCDumpService(App& app) 2461 { 2462 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/") 2463 .privileges(redfish::privileges::getLogService) 2464 .methods(boost::beast::http::verb::get)(std::bind_front( 2465 handleLogServicesDumpServiceGet, std::ref(app), "BMC")); 2466 } 2467 2468 inline void requestRoutesBMCDumpEntryCollection(App& app) 2469 { 2470 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/") 2471 .privileges(redfish::privileges::getLogEntryCollection) 2472 .methods(boost::beast::http::verb::get)(std::bind_front( 2473 handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC")); 2474 } 2475 2476 inline void requestRoutesBMCDumpEntry(App& app) 2477 { 2478 BMCWEB_ROUTE(app, 2479 "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2480 .privileges(redfish::privileges::getLogEntry) 2481 .methods(boost::beast::http::verb::get)(std::bind_front( 2482 handleLogServicesDumpEntryGet, std::ref(app), "BMC")); 2483 2484 BMCWEB_ROUTE(app, 2485 "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2486 .privileges(redfish::privileges::deleteLogEntry) 2487 .methods(boost::beast::http::verb::delete_)(std::bind_front( 2488 handleLogServicesDumpEntryDelete, std::ref(app), "BMC")); 2489 } 2490 2491 inline void requestRoutesBMCDumpCreate(App& app) 2492 { 2493 BMCWEB_ROUTE( 2494 app, 2495 "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2496 .privileges(redfish::privileges::postLogService) 2497 .methods(boost::beast::http::verb::post)( 2498 std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost, 2499 std::ref(app), "BMC")); 2500 } 2501 2502 inline void requestRoutesBMCDumpClear(App& app) 2503 { 2504 BMCWEB_ROUTE( 2505 app, 2506 "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog/") 2507 .privileges(redfish::privileges::postLogService) 2508 .methods(boost::beast::http::verb::post)(std::bind_front( 2509 handleLogServicesDumpClearLogPost, std::ref(app), "BMC")); 2510 } 2511 2512 inline void requestRoutesFaultLogDumpService(App& app) 2513 { 2514 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/") 2515 .privileges(redfish::privileges::getLogService) 2516 .methods(boost::beast::http::verb::get)(std::bind_front( 2517 handleLogServicesDumpServiceGet, std::ref(app), "FaultLog")); 2518 } 2519 2520 inline void requestRoutesFaultLogDumpEntryCollection(App& app) 2521 { 2522 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/") 2523 .privileges(redfish::privileges::getLogEntryCollection) 2524 .methods(boost::beast::http::verb::get)( 2525 std::bind_front(handleLogServicesDumpEntriesCollectionGet, 2526 std::ref(app), "FaultLog")); 2527 } 2528 2529 inline void requestRoutesFaultLogDumpEntry(App& app) 2530 { 2531 BMCWEB_ROUTE(app, 2532 "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 2533 .privileges(redfish::privileges::getLogEntry) 2534 .methods(boost::beast::http::verb::get)(std::bind_front( 2535 handleLogServicesDumpEntryGet, std::ref(app), "FaultLog")); 2536 2537 BMCWEB_ROUTE(app, 2538 "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 2539 .privileges(redfish::privileges::deleteLogEntry) 2540 .methods(boost::beast::http::verb::delete_)(std::bind_front( 2541 handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog")); 2542 } 2543 2544 inline void requestRoutesFaultLogDumpClear(App& app) 2545 { 2546 BMCWEB_ROUTE( 2547 app, 2548 "/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog/") 2549 .privileges(redfish::privileges::postLogService) 2550 .methods(boost::beast::http::verb::post)(std::bind_front( 2551 handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog")); 2552 } 2553 2554 inline void requestRoutesSystemDumpService(App& app) 2555 { 2556 BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/") 2557 .privileges(redfish::privileges::getLogService) 2558 .methods(boost::beast::http::verb::get)( 2559 [&app](const crow::Request& req, 2560 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2561 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2562 { 2563 return; 2564 } 2565 asyncResp->res.jsonValue["@odata.id"] = 2566 "/redfish/v1/Systems/system/LogServices/Dump"; 2567 asyncResp->res.jsonValue["@odata.type"] = 2568 "#LogService.v1_2_0.LogService"; 2569 asyncResp->res.jsonValue["Name"] = "Dump LogService"; 2570 asyncResp->res.jsonValue["Description"] = "System Dump LogService"; 2571 asyncResp->res.jsonValue["Id"] = "Dump"; 2572 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 2573 2574 std::pair<std::string, std::string> redfishDateTimeOffset = 2575 redfish::time_utils::getDateTimeOffsetNow(); 2576 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 2577 asyncResp->res.jsonValue["DateTimeLocalOffset"] = 2578 redfishDateTimeOffset.second; 2579 2580 asyncResp->res.jsonValue["Entries"]["@odata.id"] = 2581 "/redfish/v1/Systems/system/LogServices/Dump/Entries"; 2582 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 2583 "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog"; 2584 2585 asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 2586 ["target"] = 2587 "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData"; 2588 }); 2589 } 2590 2591 inline void requestRoutesSystemDumpEntryCollection(App& app) 2592 { 2593 2594 /** 2595 * Functions triggers appropriate requests on DBus 2596 */ 2597 BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/") 2598 .privileges(redfish::privileges::getLogEntryCollection) 2599 .methods(boost::beast::http::verb::get)( 2600 [&app](const crow::Request& req, 2601 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2602 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2603 { 2604 return; 2605 } 2606 getDumpEntryCollection(asyncResp, "System"); 2607 }); 2608 } 2609 2610 inline void requestRoutesSystemDumpEntry(App& app) 2611 { 2612 BMCWEB_ROUTE(app, 2613 "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/") 2614 .privileges(redfish::privileges::getLogEntry) 2615 2616 .methods(boost::beast::http::verb::get)( 2617 [&app](const crow::Request& req, 2618 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2619 const std::string& param) { 2620 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2621 { 2622 return; 2623 } 2624 getDumpEntryById(asyncResp, param, "System"); 2625 }); 2626 2627 BMCWEB_ROUTE(app, 2628 "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/") 2629 .privileges(redfish::privileges::deleteLogEntry) 2630 .methods(boost::beast::http::verb::delete_)( 2631 [&app](const crow::Request& req, 2632 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2633 const std::string& param) { 2634 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2635 { 2636 return; 2637 } 2638 deleteDumpEntry(asyncResp, param, "system"); 2639 }); 2640 } 2641 2642 inline void requestRoutesSystemDumpCreate(App& app) 2643 { 2644 BMCWEB_ROUTE( 2645 app, 2646 "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2647 .privileges(redfish::privileges::postLogService) 2648 .methods(boost::beast::http::verb::post)( 2649 [&app](const crow::Request& req, 2650 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2651 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2652 { 2653 return; 2654 } 2655 createDump(asyncResp, req, "System"); 2656 }); 2657 } 2658 2659 inline void requestRoutesSystemDumpClear(App& app) 2660 { 2661 BMCWEB_ROUTE( 2662 app, 2663 "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog/") 2664 .privileges(redfish::privileges::postLogService) 2665 .methods(boost::beast::http::verb::post)( 2666 [&app](const crow::Request& req, 2667 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2668 2669 { 2670 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2671 { 2672 return; 2673 } 2674 clearDump(asyncResp, "System"); 2675 }); 2676 } 2677 2678 inline void requestRoutesCrashdumpService(App& app) 2679 { 2680 // Note: Deviated from redfish privilege registry for GET & HEAD 2681 // method for security reasons. 2682 /** 2683 * Functions triggers appropriate requests on DBus 2684 */ 2685 BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Crashdump/") 2686 // This is incorrect, should be: 2687 //.privileges(redfish::privileges::getLogService) 2688 .privileges({{"ConfigureManager"}}) 2689 .methods(boost::beast::http::verb::get)( 2690 [&app](const crow::Request& req, 2691 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2692 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2693 { 2694 return; 2695 } 2696 // Copy over the static data to include the entries added by 2697 // SubRoute 2698 asyncResp->res.jsonValue["@odata.id"] = 2699 "/redfish/v1/Systems/system/LogServices/Crashdump"; 2700 asyncResp->res.jsonValue["@odata.type"] = 2701 "#LogService.v1_2_0.LogService"; 2702 asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service"; 2703 asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service"; 2704 asyncResp->res.jsonValue["Id"] = "Oem Crashdump"; 2705 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 2706 asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; 2707 2708 std::pair<std::string, std::string> redfishDateTimeOffset = 2709 redfish::time_utils::getDateTimeOffsetNow(); 2710 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 2711 asyncResp->res.jsonValue["DateTimeLocalOffset"] = 2712 redfishDateTimeOffset.second; 2713 2714 asyncResp->res.jsonValue["Entries"]["@odata.id"] = 2715 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 2716 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 2717 "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog"; 2718 asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 2719 ["target"] = 2720 "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData"; 2721 }); 2722 } 2723 2724 void inline requestRoutesCrashdumpClear(App& app) 2725 { 2726 BMCWEB_ROUTE( 2727 app, 2728 "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog/") 2729 // This is incorrect, should be: 2730 //.privileges(redfish::privileges::postLogService) 2731 .privileges({{"ConfigureComponents"}}) 2732 .methods(boost::beast::http::verb::post)( 2733 [&app](const crow::Request& req, 2734 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2735 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2736 { 2737 return; 2738 } 2739 crow::connections::systemBus->async_method_call( 2740 [asyncResp](const boost::system::error_code ec, 2741 const std::string&) { 2742 if (ec) 2743 { 2744 messages::internalError(asyncResp->res); 2745 return; 2746 } 2747 messages::success(asyncResp->res); 2748 }, 2749 crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll"); 2750 }); 2751 } 2752 2753 static void 2754 logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2755 const std::string& logID, nlohmann::json& logEntryJson) 2756 { 2757 auto getStoredLogCallback = 2758 [asyncResp, logID, 2759 &logEntryJson](const boost::system::error_code ec, 2760 const dbus::utility::DBusPropertiesMap& params) { 2761 if (ec) 2762 { 2763 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 2764 if (ec.value() == 2765 boost::system::linux_error::bad_request_descriptor) 2766 { 2767 messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 2768 } 2769 else 2770 { 2771 messages::internalError(asyncResp->res); 2772 } 2773 return; 2774 } 2775 2776 std::string timestamp{}; 2777 std::string filename{}; 2778 std::string logfile{}; 2779 parseCrashdumpParameters(params, filename, timestamp, logfile); 2780 2781 if (filename.empty() || timestamp.empty()) 2782 { 2783 messages::resourceMissingAtURI(asyncResp->res, 2784 crow::utility::urlFromPieces(logID)); 2785 return; 2786 } 2787 2788 std::string crashdumpURI = 2789 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + 2790 logID + "/" + filename; 2791 nlohmann::json::object_t logEntry; 2792 logEntry["@odata.type"] = "#LogEntry.v1_7_0.LogEntry"; 2793 logEntry["@odata.id"] = 2794 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + logID; 2795 logEntry["Name"] = "CPU Crashdump"; 2796 logEntry["Id"] = logID; 2797 logEntry["EntryType"] = "Oem"; 2798 logEntry["AdditionalDataURI"] = std::move(crashdumpURI); 2799 logEntry["DiagnosticDataType"] = "OEM"; 2800 logEntry["OEMDiagnosticDataType"] = "PECICrashdump"; 2801 logEntry["Created"] = std::move(timestamp); 2802 2803 // If logEntryJson references an array of LogEntry resources 2804 // ('Members' list), then push this as a new entry, otherwise set it 2805 // directly 2806 if (logEntryJson.is_array()) 2807 { 2808 logEntryJson.push_back(logEntry); 2809 asyncResp->res.jsonValue["Members@odata.count"] = 2810 logEntryJson.size(); 2811 } 2812 else 2813 { 2814 logEntryJson.update(logEntry); 2815 } 2816 }; 2817 sdbusplus::asio::getAllProperties( 2818 *crow::connections::systemBus, crashdumpObject, 2819 crashdumpPath + std::string("/") + logID, crashdumpInterface, 2820 std::move(getStoredLogCallback)); 2821 } 2822 2823 inline void requestRoutesCrashdumpEntryCollection(App& app) 2824 { 2825 // Note: Deviated from redfish privilege registry for GET & HEAD 2826 // method for security reasons. 2827 /** 2828 * Functions triggers appropriate requests on DBus 2829 */ 2830 BMCWEB_ROUTE(app, 2831 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/") 2832 // This is incorrect, should be. 2833 //.privileges(redfish::privileges::postLogEntryCollection) 2834 .privileges({{"ConfigureComponents"}}) 2835 .methods(boost::beast::http::verb::get)( 2836 [&app](const crow::Request& req, 2837 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2838 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2839 { 2840 return; 2841 } 2842 crow::connections::systemBus->async_method_call( 2843 [asyncResp](const boost::system::error_code ec, 2844 const std::vector<std::string>& resp) { 2845 if (ec) 2846 { 2847 if (ec.value() != 2848 boost::system::errc::no_such_file_or_directory) 2849 { 2850 BMCWEB_LOG_DEBUG << "failed to get entries ec: " 2851 << ec.message(); 2852 messages::internalError(asyncResp->res); 2853 return; 2854 } 2855 } 2856 asyncResp->res.jsonValue["@odata.type"] = 2857 "#LogEntryCollection.LogEntryCollection"; 2858 asyncResp->res.jsonValue["@odata.id"] = 2859 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 2860 asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries"; 2861 asyncResp->res.jsonValue["Description"] = 2862 "Collection of Crashdump Entries"; 2863 asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 2864 asyncResp->res.jsonValue["Members@odata.count"] = 0; 2865 2866 for (const std::string& path : resp) 2867 { 2868 const sdbusplus::message::object_path objPath(path); 2869 // Get the log ID 2870 std::string logID = objPath.filename(); 2871 if (logID.empty()) 2872 { 2873 continue; 2874 } 2875 // Add the log entry to the array 2876 logCrashdumpEntry(asyncResp, logID, 2877 asyncResp->res.jsonValue["Members"]); 2878 } 2879 }, 2880 "xyz.openbmc_project.ObjectMapper", 2881 "/xyz/openbmc_project/object_mapper", 2882 "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0, 2883 std::array<const char*, 1>{crashdumpInterface}); 2884 }); 2885 } 2886 2887 inline void requestRoutesCrashdumpEntry(App& app) 2888 { 2889 // Note: Deviated from redfish privilege registry for GET & HEAD 2890 // method for security reasons. 2891 2892 BMCWEB_ROUTE( 2893 app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/") 2894 // this is incorrect, should be 2895 // .privileges(redfish::privileges::getLogEntry) 2896 .privileges({{"ConfigureComponents"}}) 2897 .methods(boost::beast::http::verb::get)( 2898 [&app](const crow::Request& req, 2899 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2900 const std::string& param) { 2901 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2902 { 2903 return; 2904 } 2905 const std::string& logID = param; 2906 logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue); 2907 }); 2908 } 2909 2910 inline void requestRoutesCrashdumpFile(App& app) 2911 { 2912 // Note: Deviated from redfish privilege registry for GET & HEAD 2913 // method for security reasons. 2914 BMCWEB_ROUTE( 2915 app, 2916 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/<str>/") 2917 .privileges(redfish::privileges::getLogEntry) 2918 .methods(boost::beast::http::verb::get)( 2919 [](const crow::Request& req, 2920 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2921 const std::string& logID, const std::string& fileName) { 2922 // Do not call getRedfishRoute here since the crashdump file is not a 2923 // Redfish resource. 2924 auto getStoredLogCallback = 2925 [asyncResp, logID, fileName, url(boost::urls::url(req.urlView))]( 2926 const boost::system::error_code ec, 2927 const std::vector< 2928 std::pair<std::string, dbus::utility::DbusVariantType>>& 2929 resp) { 2930 if (ec) 2931 { 2932 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 2933 messages::internalError(asyncResp->res); 2934 return; 2935 } 2936 2937 std::string dbusFilename{}; 2938 std::string dbusTimestamp{}; 2939 std::string dbusFilepath{}; 2940 2941 parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp, 2942 dbusFilepath); 2943 2944 if (dbusFilename.empty() || dbusTimestamp.empty() || 2945 dbusFilepath.empty()) 2946 { 2947 messages::resourceMissingAtURI(asyncResp->res, url); 2948 return; 2949 } 2950 2951 // Verify the file name parameter is correct 2952 if (fileName != dbusFilename) 2953 { 2954 messages::resourceMissingAtURI(asyncResp->res, url); 2955 return; 2956 } 2957 2958 if (!std::filesystem::exists(dbusFilepath)) 2959 { 2960 messages::resourceMissingAtURI(asyncResp->res, url); 2961 return; 2962 } 2963 std::ifstream ifs(dbusFilepath, std::ios::in | std::ios::binary); 2964 asyncResp->res.body() = 2965 std::string(std::istreambuf_iterator<char>{ifs}, {}); 2966 2967 // Configure this to be a file download when accessed 2968 // from a browser 2969 asyncResp->res.addHeader( 2970 boost::beast::http::field::content_disposition, "attachment"); 2971 }; 2972 sdbusplus::asio::getAllProperties( 2973 *crow::connections::systemBus, crashdumpObject, 2974 crashdumpPath + std::string("/") + logID, crashdumpInterface, 2975 std::move(getStoredLogCallback)); 2976 }); 2977 } 2978 2979 enum class OEMDiagnosticType 2980 { 2981 onDemand, 2982 telemetry, 2983 invalid, 2984 }; 2985 2986 inline OEMDiagnosticType 2987 getOEMDiagnosticType(const std::string_view& oemDiagStr) 2988 { 2989 if (oemDiagStr == "OnDemand") 2990 { 2991 return OEMDiagnosticType::onDemand; 2992 } 2993 if (oemDiagStr == "Telemetry") 2994 { 2995 return OEMDiagnosticType::telemetry; 2996 } 2997 2998 return OEMDiagnosticType::invalid; 2999 } 3000 3001 inline void requestRoutesCrashdumpCollect(App& app) 3002 { 3003 // Note: Deviated from redfish privilege registry for GET & HEAD 3004 // method for security reasons. 3005 BMCWEB_ROUTE( 3006 app, 3007 "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/") 3008 // The below is incorrect; Should be ConfigureManager 3009 //.privileges(redfish::privileges::postLogService) 3010 .privileges({{"ConfigureComponents"}}) 3011 .methods(boost::beast::http::verb::post)( 3012 [&app](const crow::Request& req, 3013 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 3014 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3015 { 3016 return; 3017 } 3018 std::string diagnosticDataType; 3019 std::string oemDiagnosticDataType; 3020 if (!redfish::json_util::readJsonAction( 3021 req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 3022 "OEMDiagnosticDataType", oemDiagnosticDataType)) 3023 { 3024 return; 3025 } 3026 3027 if (diagnosticDataType != "OEM") 3028 { 3029 BMCWEB_LOG_ERROR 3030 << "Only OEM DiagnosticDataType supported for Crashdump"; 3031 messages::actionParameterValueFormatError( 3032 asyncResp->res, diagnosticDataType, "DiagnosticDataType", 3033 "CollectDiagnosticData"); 3034 return; 3035 } 3036 3037 OEMDiagnosticType oemDiagType = 3038 getOEMDiagnosticType(oemDiagnosticDataType); 3039 3040 std::string iface; 3041 std::string method; 3042 std::string taskMatchStr; 3043 if (oemDiagType == OEMDiagnosticType::onDemand) 3044 { 3045 iface = crashdumpOnDemandInterface; 3046 method = "GenerateOnDemandLog"; 3047 taskMatchStr = "type='signal'," 3048 "interface='org.freedesktop.DBus.Properties'," 3049 "member='PropertiesChanged'," 3050 "arg0namespace='com.intel.crashdump'"; 3051 } 3052 else if (oemDiagType == OEMDiagnosticType::telemetry) 3053 { 3054 iface = crashdumpTelemetryInterface; 3055 method = "GenerateTelemetryLog"; 3056 taskMatchStr = "type='signal'," 3057 "interface='org.freedesktop.DBus.Properties'," 3058 "member='PropertiesChanged'," 3059 "arg0namespace='com.intel.crashdump'"; 3060 } 3061 else 3062 { 3063 BMCWEB_LOG_ERROR << "Unsupported OEMDiagnosticDataType: " 3064 << oemDiagnosticDataType; 3065 messages::actionParameterValueFormatError( 3066 asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType", 3067 "CollectDiagnosticData"); 3068 return; 3069 } 3070 3071 auto collectCrashdumpCallback = 3072 [asyncResp, payload(task::Payload(req)), 3073 taskMatchStr](const boost::system::error_code ec, 3074 const std::string&) mutable { 3075 if (ec) 3076 { 3077 if (ec.value() == boost::system::errc::operation_not_supported) 3078 { 3079 messages::resourceInStandby(asyncResp->res); 3080 } 3081 else if (ec.value() == 3082 boost::system::errc::device_or_resource_busy) 3083 { 3084 messages::serviceTemporarilyUnavailable(asyncResp->res, 3085 "60"); 3086 } 3087 else 3088 { 3089 messages::internalError(asyncResp->res); 3090 } 3091 return; 3092 } 3093 std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 3094 [](boost::system::error_code err, sdbusplus::message_t&, 3095 const std::shared_ptr<task::TaskData>& taskData) { 3096 if (!err) 3097 { 3098 taskData->messages.emplace_back(messages::taskCompletedOK( 3099 std::to_string(taskData->index))); 3100 taskData->state = "Completed"; 3101 } 3102 return task::completed; 3103 }, 3104 taskMatchStr); 3105 3106 task->startTimer(std::chrono::minutes(5)); 3107 task->populateResp(asyncResp->res); 3108 task->payload.emplace(std::move(payload)); 3109 }; 3110 3111 crow::connections::systemBus->async_method_call( 3112 std::move(collectCrashdumpCallback), crashdumpObject, crashdumpPath, 3113 iface, method); 3114 }); 3115 } 3116 3117 /** 3118 * DBusLogServiceActionsClear class supports POST method for ClearLog action. 3119 */ 3120 inline void requestRoutesDBusLogServiceActionsClear(App& app) 3121 { 3122 /** 3123 * Function handles POST method request. 3124 * The Clear Log actions does not require any parameter.The action deletes 3125 * all entries found in the Entries collection for this Log Service. 3126 */ 3127 3128 BMCWEB_ROUTE( 3129 app, 3130 "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog/") 3131 .privileges(redfish::privileges::postLogService) 3132 .methods(boost::beast::http::verb::post)( 3133 [&app](const crow::Request& req, 3134 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 3135 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3136 { 3137 return; 3138 } 3139 BMCWEB_LOG_DEBUG << "Do delete all entries."; 3140 3141 // Process response from Logging service. 3142 auto respHandler = [asyncResp](const boost::system::error_code ec) { 3143 BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done"; 3144 if (ec) 3145 { 3146 // TODO Handle for specific error code 3147 BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec; 3148 asyncResp->res.result( 3149 boost::beast::http::status::internal_server_error); 3150 return; 3151 } 3152 3153 asyncResp->res.result(boost::beast::http::status::no_content); 3154 }; 3155 3156 // Make call to Logging service to request Clear Log 3157 crow::connections::systemBus->async_method_call( 3158 respHandler, "xyz.openbmc_project.Logging", 3159 "/xyz/openbmc_project/logging", 3160 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 3161 }); 3162 } 3163 3164 /**************************************************** 3165 * Redfish PostCode interfaces 3166 * using DBUS interface: getPostCodesTS 3167 ******************************************************/ 3168 inline void requestRoutesPostCodesLogService(App& app) 3169 { 3170 BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/PostCodes/") 3171 .privileges(redfish::privileges::getLogService) 3172 .methods(boost::beast::http::verb::get)( 3173 [&app](const crow::Request& req, 3174 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 3175 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3176 { 3177 return; 3178 } 3179 3180 asyncResp->res.jsonValue["@odata.id"] = 3181 "/redfish/v1/Systems/system/LogServices/PostCodes"; 3182 asyncResp->res.jsonValue["@odata.type"] = 3183 "#LogService.v1_1_0.LogService"; 3184 asyncResp->res.jsonValue["Name"] = "POST Code Log Service"; 3185 asyncResp->res.jsonValue["Description"] = "POST Code Log Service"; 3186 asyncResp->res.jsonValue["Id"] = "BIOS POST Code Log"; 3187 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 3188 asyncResp->res.jsonValue["Entries"]["@odata.id"] = 3189 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3190 3191 std::pair<std::string, std::string> redfishDateTimeOffset = 3192 redfish::time_utils::getDateTimeOffsetNow(); 3193 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 3194 asyncResp->res.jsonValue["DateTimeLocalOffset"] = 3195 redfishDateTimeOffset.second; 3196 3197 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 3198 {"target", 3199 "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog"}}; 3200 }); 3201 } 3202 3203 inline void requestRoutesPostCodesClear(App& app) 3204 { 3205 BMCWEB_ROUTE( 3206 app, 3207 "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog/") 3208 // The following privilege is incorrect; It should be ConfigureManager 3209 //.privileges(redfish::privileges::postLogService) 3210 .privileges({{"ConfigureComponents"}}) 3211 .methods(boost::beast::http::verb::post)( 3212 [&app](const crow::Request& req, 3213 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 3214 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3215 { 3216 return; 3217 } 3218 BMCWEB_LOG_DEBUG << "Do delete all postcodes entries."; 3219 3220 // Make call to post-code service to request clear all 3221 crow::connections::systemBus->async_method_call( 3222 [asyncResp](const boost::system::error_code ec) { 3223 if (ec) 3224 { 3225 // TODO Handle for specific error code 3226 BMCWEB_LOG_ERROR << "doClearPostCodes resp_handler got error " 3227 << ec; 3228 asyncResp->res.result( 3229 boost::beast::http::status::internal_server_error); 3230 messages::internalError(asyncResp->res); 3231 return; 3232 } 3233 }, 3234 "xyz.openbmc_project.State.Boot.PostCode0", 3235 "/xyz/openbmc_project/State/Boot/PostCode0", 3236 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 3237 }); 3238 } 3239 3240 static void fillPostCodeEntry( 3241 const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3242 const boost::container::flat_map< 3243 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode, 3244 const uint16_t bootIndex, const uint64_t codeIndex = 0, 3245 const uint64_t skip = 0, const uint64_t top = 0) 3246 { 3247 // Get the Message from the MessageRegistry 3248 const registries::Message* message = 3249 registries::getMessage("OpenBMC.0.2.BIOSPOSTCode"); 3250 3251 uint64_t currentCodeIndex = 0; 3252 nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"]; 3253 3254 uint64_t firstCodeTimeUs = 0; 3255 for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 3256 code : postcode) 3257 { 3258 currentCodeIndex++; 3259 std::string postcodeEntryID = 3260 "B" + std::to_string(bootIndex) + "-" + 3261 std::to_string(currentCodeIndex); // 1 based index in EntryID string 3262 3263 uint64_t usecSinceEpoch = code.first; 3264 uint64_t usTimeOffset = 0; 3265 3266 if (1 == currentCodeIndex) 3267 { // already incremented 3268 firstCodeTimeUs = code.first; 3269 } 3270 else 3271 { 3272 usTimeOffset = code.first - firstCodeTimeUs; 3273 } 3274 3275 // skip if no specific codeIndex is specified and currentCodeIndex does 3276 // not fall between top and skip 3277 if ((codeIndex == 0) && 3278 (currentCodeIndex <= skip || currentCodeIndex > top)) 3279 { 3280 continue; 3281 } 3282 3283 // skip if a specific codeIndex is specified and does not match the 3284 // currentIndex 3285 if ((codeIndex > 0) && (currentCodeIndex != codeIndex)) 3286 { 3287 // This is done for simplicity. 1st entry is needed to calculate 3288 // time offset. To improve efficiency, one can get to the entry 3289 // directly (possibly with flatmap's nth method) 3290 continue; 3291 } 3292 3293 // currentCodeIndex is within top and skip or equal to specified code 3294 // index 3295 3296 // Get the Created time from the timestamp 3297 std::string entryTimeStr; 3298 entryTimeStr = 3299 redfish::time_utils::getDateTimeUint(usecSinceEpoch / 1000 / 1000); 3300 3301 // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex) 3302 std::ostringstream hexCode; 3303 hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex 3304 << std::get<0>(code.second); 3305 std::ostringstream timeOffsetStr; 3306 // Set Fixed -Point Notation 3307 timeOffsetStr << std::fixed; 3308 // Set precision to 4 digits 3309 timeOffsetStr << std::setprecision(4); 3310 // Add double to stream 3311 timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000; 3312 std::vector<std::string> messageArgs = { 3313 std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()}; 3314 3315 // Get MessageArgs template from message registry 3316 std::string msg; 3317 if (message != nullptr) 3318 { 3319 msg = message->message; 3320 3321 // fill in this post code value 3322 int i = 0; 3323 for (const std::string& messageArg : messageArgs) 3324 { 3325 std::string argStr = "%" + std::to_string(++i); 3326 size_t argPos = msg.find(argStr); 3327 if (argPos != std::string::npos) 3328 { 3329 msg.replace(argPos, argStr.length(), messageArg); 3330 } 3331 } 3332 } 3333 3334 // Get Severity template from message registry 3335 std::string severity; 3336 if (message != nullptr) 3337 { 3338 severity = message->messageSeverity; 3339 } 3340 3341 // add to AsyncResp 3342 logEntryArray.push_back({}); 3343 nlohmann::json& bmcLogEntry = logEntryArray.back(); 3344 bmcLogEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 3345 bmcLogEntry["@odata.id"] = 3346 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 3347 postcodeEntryID; 3348 bmcLogEntry["Name"] = "POST Code Log Entry"; 3349 bmcLogEntry["Id"] = postcodeEntryID; 3350 bmcLogEntry["Message"] = std::move(msg); 3351 bmcLogEntry["MessageId"] = "OpenBMC.0.2.BIOSPOSTCode"; 3352 bmcLogEntry["MessageArgs"] = std::move(messageArgs); 3353 bmcLogEntry["EntryType"] = "Event"; 3354 bmcLogEntry["Severity"] = std::move(severity); 3355 bmcLogEntry["Created"] = entryTimeStr; 3356 if (!std::get<std::vector<uint8_t>>(code.second).empty()) 3357 { 3358 bmcLogEntry["AdditionalDataURI"] = 3359 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 3360 postcodeEntryID + "/attachment"; 3361 } 3362 } 3363 } 3364 3365 static void getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3366 const uint16_t bootIndex, 3367 const uint64_t codeIndex) 3368 { 3369 crow::connections::systemBus->async_method_call( 3370 [aResp, bootIndex, 3371 codeIndex](const boost::system::error_code ec, 3372 const boost::container::flat_map< 3373 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 3374 postcode) { 3375 if (ec) 3376 { 3377 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3378 messages::internalError(aResp->res); 3379 return; 3380 } 3381 3382 // skip the empty postcode boots 3383 if (postcode.empty()) 3384 { 3385 return; 3386 } 3387 3388 fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex); 3389 3390 aResp->res.jsonValue["Members@odata.count"] = 3391 aResp->res.jsonValue["Members"].size(); 3392 }, 3393 "xyz.openbmc_project.State.Boot.PostCode0", 3394 "/xyz/openbmc_project/State/Boot/PostCode0", 3395 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3396 bootIndex); 3397 } 3398 3399 static void getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3400 const uint16_t bootIndex, 3401 const uint16_t bootCount, 3402 const uint64_t entryCount, size_t skip, 3403 size_t top) 3404 { 3405 crow::connections::systemBus->async_method_call( 3406 [aResp, bootIndex, bootCount, entryCount, skip, 3407 top](const boost::system::error_code ec, 3408 const boost::container::flat_map< 3409 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 3410 postcode) { 3411 if (ec) 3412 { 3413 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3414 messages::internalError(aResp->res); 3415 return; 3416 } 3417 3418 uint64_t endCount = entryCount; 3419 if (!postcode.empty()) 3420 { 3421 endCount = entryCount + postcode.size(); 3422 if (skip < endCount && (top + skip) > entryCount) 3423 { 3424 uint64_t thisBootSkip = 3425 std::max(static_cast<uint64_t>(skip), entryCount) - 3426 entryCount; 3427 uint64_t thisBootTop = 3428 std::min(static_cast<uint64_t>(top + skip), endCount) - 3429 entryCount; 3430 3431 fillPostCodeEntry(aResp, postcode, bootIndex, 0, thisBootSkip, 3432 thisBootTop); 3433 } 3434 aResp->res.jsonValue["Members@odata.count"] = endCount; 3435 } 3436 3437 // continue to previous bootIndex 3438 if (bootIndex < bootCount) 3439 { 3440 getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1), 3441 bootCount, endCount, skip, top); 3442 } 3443 else if (skip + top < endCount) 3444 { 3445 aResp->res.jsonValue["Members@odata.nextLink"] = 3446 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=" + 3447 std::to_string(skip + top); 3448 } 3449 }, 3450 "xyz.openbmc_project.State.Boot.PostCode0", 3451 "/xyz/openbmc_project/State/Boot/PostCode0", 3452 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3453 bootIndex); 3454 } 3455 3456 static void 3457 getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3458 size_t skip, size_t top) 3459 { 3460 uint64_t entryCount = 0; 3461 sdbusplus::asio::getProperty<uint16_t>( 3462 *crow::connections::systemBus, 3463 "xyz.openbmc_project.State.Boot.PostCode0", 3464 "/xyz/openbmc_project/State/Boot/PostCode0", 3465 "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount", 3466 [aResp, entryCount, skip, top](const boost::system::error_code ec, 3467 const uint16_t bootCount) { 3468 if (ec) 3469 { 3470 BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3471 messages::internalError(aResp->res); 3472 return; 3473 } 3474 getPostCodeForBoot(aResp, 1, bootCount, entryCount, skip, top); 3475 }); 3476 } 3477 3478 inline void requestRoutesPostCodesEntryCollection(App& app) 3479 { 3480 BMCWEB_ROUTE(app, 3481 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/") 3482 .privileges(redfish::privileges::getLogEntryCollection) 3483 .methods(boost::beast::http::verb::get)( 3484 [&app](const crow::Request& req, 3485 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 3486 query_param::QueryCapabilities capabilities = { 3487 .canDelegateTop = true, 3488 .canDelegateSkip = true, 3489 }; 3490 query_param::Query delegatedQuery; 3491 if (!redfish::setUpRedfishRouteWithDelegation( 3492 app, req, asyncResp, delegatedQuery, capabilities)) 3493 { 3494 return; 3495 } 3496 asyncResp->res.jsonValue["@odata.type"] = 3497 "#LogEntryCollection.LogEntryCollection"; 3498 asyncResp->res.jsonValue["@odata.id"] = 3499 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3500 asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3501 asyncResp->res.jsonValue["Description"] = 3502 "Collection of POST Code Log Entries"; 3503 asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3504 asyncResp->res.jsonValue["Members@odata.count"] = 0; 3505 size_t skip = delegatedQuery.skip.value_or(0); 3506 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 3507 getCurrentBootNumber(asyncResp, skip, top); 3508 }); 3509 } 3510 3511 /** 3512 * @brief Parse post code ID and get the current value and index value 3513 * eg: postCodeID=B1-2, currentValue=1, index=2 3514 * 3515 * @param[in] postCodeID Post Code ID 3516 * @param[out] currentValue Current value 3517 * @param[out] index Index value 3518 * 3519 * @return bool true if the parsing is successful, false the parsing fails 3520 */ 3521 inline static bool parsePostCode(const std::string& postCodeID, 3522 uint64_t& currentValue, uint16_t& index) 3523 { 3524 std::vector<std::string> split; 3525 boost::algorithm::split(split, postCodeID, boost::is_any_of("-")); 3526 if (split.size() != 2 || split[0].length() < 2 || split[0].front() != 'B') 3527 { 3528 return false; 3529 } 3530 3531 // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3532 const char* start = split[0].data() + 1; 3533 // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3534 const char* end = split[0].data() + split[0].size(); 3535 auto [ptrIndex, ecIndex] = std::from_chars(start, end, index); 3536 3537 if (ptrIndex != end || ecIndex != std::errc()) 3538 { 3539 return false; 3540 } 3541 3542 start = split[1].data(); 3543 3544 // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3545 end = split[1].data() + split[1].size(); 3546 auto [ptrValue, ecValue] = std::from_chars(start, end, currentValue); 3547 3548 return ptrValue == end && ecValue == std::errc(); 3549 } 3550 3551 inline void requestRoutesPostCodesEntryAdditionalData(App& app) 3552 { 3553 BMCWEB_ROUTE( 3554 app, 3555 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/attachment/") 3556 .privileges(redfish::privileges::getLogEntry) 3557 .methods(boost::beast::http::verb::get)( 3558 [&app](const crow::Request& req, 3559 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3560 const std::string& postCodeID) { 3561 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3562 { 3563 return; 3564 } 3565 if (!http_helpers::isOctetAccepted(req.getHeaderValue("Accept"))) 3566 { 3567 asyncResp->res.result(boost::beast::http::status::bad_request); 3568 return; 3569 } 3570 3571 uint64_t currentValue = 0; 3572 uint16_t index = 0; 3573 if (!parsePostCode(postCodeID, currentValue, index)) 3574 { 3575 messages::resourceNotFound(asyncResp->res, "LogEntry", postCodeID); 3576 return; 3577 } 3578 3579 crow::connections::systemBus->async_method_call( 3580 [asyncResp, postCodeID, currentValue]( 3581 const boost::system::error_code ec, 3582 const std::vector<std::tuple<uint64_t, std::vector<uint8_t>>>& 3583 postcodes) { 3584 if (ec.value() == EBADR) 3585 { 3586 messages::resourceNotFound(asyncResp->res, "LogEntry", 3587 postCodeID); 3588 return; 3589 } 3590 if (ec) 3591 { 3592 BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3593 messages::internalError(asyncResp->res); 3594 return; 3595 } 3596 3597 size_t value = static_cast<size_t>(currentValue) - 1; 3598 if (value == std::string::npos || postcodes.size() < currentValue) 3599 { 3600 BMCWEB_LOG_ERROR << "Wrong currentValue value"; 3601 messages::resourceNotFound(asyncResp->res, "LogEntry", 3602 postCodeID); 3603 return; 3604 } 3605 3606 const auto& [tID, c] = postcodes[value]; 3607 if (c.empty()) 3608 { 3609 BMCWEB_LOG_INFO << "No found post code data"; 3610 messages::resourceNotFound(asyncResp->res, "LogEntry", 3611 postCodeID); 3612 return; 3613 } 3614 // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) 3615 const char* d = reinterpret_cast<const char*>(c.data()); 3616 std::string_view strData(d, c.size()); 3617 3618 asyncResp->res.addHeader(boost::beast::http::field::content_type, 3619 "application/octet-stream"); 3620 asyncResp->res.addHeader( 3621 boost::beast::http::field::content_transfer_encoding, "Base64"); 3622 asyncResp->res.body() = crow::utility::base64encode(strData); 3623 }, 3624 "xyz.openbmc_project.State.Boot.PostCode0", 3625 "/xyz/openbmc_project/State/Boot/PostCode0", 3626 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", index); 3627 }); 3628 } 3629 3630 inline void requestRoutesPostCodesEntry(App& app) 3631 { 3632 BMCWEB_ROUTE( 3633 app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/") 3634 .privileges(redfish::privileges::getLogEntry) 3635 .methods(boost::beast::http::verb::get)( 3636 [&app](const crow::Request& req, 3637 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3638 const std::string& targetID) { 3639 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3640 { 3641 return; 3642 } 3643 uint16_t bootIndex = 0; 3644 uint64_t codeIndex = 0; 3645 if (!parsePostCode(targetID, codeIndex, bootIndex)) 3646 { 3647 // Requested ID was not found 3648 messages::resourceMissingAtURI(asyncResp->res, req.urlView); 3649 return; 3650 } 3651 if (bootIndex == 0 || codeIndex == 0) 3652 { 3653 BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string " 3654 << targetID; 3655 } 3656 3657 asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_4_0.LogEntry"; 3658 asyncResp->res.jsonValue["@odata.id"] = 3659 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3660 asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3661 asyncResp->res.jsonValue["Description"] = 3662 "Collection of POST Code Log Entries"; 3663 asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3664 asyncResp->res.jsonValue["Members@odata.count"] = 0; 3665 3666 getPostCodeForEntry(asyncResp, bootIndex, codeIndex); 3667 }); 3668 } 3669 3670 } // namespace redfish 3671