11da66f75SEd Tanous /* 21da66f75SEd Tanous // Copyright (c) 2018 Intel Corporation 31da66f75SEd Tanous // 41da66f75SEd Tanous // Licensed under the Apache License, Version 2.0 (the "License"); 51da66f75SEd Tanous // you may not use this file except in compliance with the License. 61da66f75SEd Tanous // You may obtain a copy of the License at 71da66f75SEd Tanous // 81da66f75SEd Tanous // http://www.apache.org/licenses/LICENSE-2.0 91da66f75SEd Tanous // 101da66f75SEd Tanous // Unless required by applicable law or agreed to in writing, software 111da66f75SEd Tanous // distributed under the License is distributed on an "AS IS" BASIS, 121da66f75SEd Tanous // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 131da66f75SEd Tanous // See the License for the specific language governing permissions and 141da66f75SEd Tanous // limitations under the License. 151da66f75SEd Tanous */ 161da66f75SEd Tanous #pragma once 171da66f75SEd Tanous 183ccb3adbSEd Tanous #include "app.hpp" 197a1dbc48SGeorge Liu #include "dbus_utility.hpp" 203ccb3adbSEd Tanous #include "error_messages.hpp" 2168dd075aSAsmitha Karunanithi #include "generated/enums/log_entry.hpp" 22b7028ebfSSpencer Ku #include "gzfile.hpp" 23647b3cdcSGeorge Liu #include "http_utility.hpp" 24b7028ebfSSpencer Ku #include "human_sort.hpp" 253ccb3adbSEd Tanous #include "query.hpp" 264851d45dSJason M. Bills #include "registries.hpp" 274851d45dSJason M. Bills #include "registries/base_message_registry.hpp" 284851d45dSJason M. Bills #include "registries/openbmc_message_registry.hpp" 293ccb3adbSEd Tanous #include "registries/privilege_registry.hpp" 3046229577SJames Feist #include "task.hpp" 313ccb3adbSEd Tanous #include "utils/dbus_utils.hpp" 323ccb3adbSEd Tanous #include "utils/time_utils.hpp" 331da66f75SEd Tanous 3475e8e218SMyung Bae #include <systemd/sd-id128.h> 35e1f26343SJason M. Bills #include <systemd/sd-journal.h> 368e31778eSAsmitha Karunanithi #include <tinyxml2.h> 37400fd1fbSAdriana Kobylak #include <unistd.h> 38e1f26343SJason M. Bills 3907c8c20dSEd Tanous #include <boost/beast/http/verb.hpp> 401da66f75SEd Tanous #include <boost/container/flat_map.hpp> 411ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp> 42ef4c65b7SEd Tanous #include <boost/url/format.hpp> 43d1bde9e5SKrzysztof Grobelny #include <sdbusplus/asio/property.hpp> 44d1bde9e5SKrzysztof Grobelny #include <sdbusplus/unpack_properties.hpp> 451214b7e7SGunnar Mills 467a1dbc48SGeorge Liu #include <array> 47647b3cdcSGeorge Liu #include <charconv> 48*b5f288d2SAbhilash Raju #include <cstddef> 494418c7f0SJames Feist #include <filesystem> 5018f8f608SEd Tanous #include <iterator> 5175710de2SXiaochao Ma #include <optional> 523544d2a7SEd Tanous #include <ranges> 5326702d01SEd Tanous #include <span> 5418f8f608SEd Tanous #include <string> 55cd225da8SJason M. Bills #include <string_view> 56abf2add6SEd Tanous #include <variant> 571da66f75SEd Tanous 581da66f75SEd Tanous namespace redfish 591da66f75SEd Tanous { 601da66f75SEd Tanous 6189492a15SPatrick Williams constexpr const char* crashdumpObject = "com.intel.crashdump"; 6289492a15SPatrick Williams constexpr const char* crashdumpPath = "/com/intel/crashdump"; 6389492a15SPatrick Williams constexpr const char* crashdumpInterface = "com.intel.crashdump"; 6489492a15SPatrick Williams constexpr const char* deleteAllInterface = 655b61b5e8SJason M. Bills "xyz.openbmc_project.Collection.DeleteAll"; 6689492a15SPatrick Williams constexpr const char* crashdumpOnDemandInterface = 67424c4176SJason M. Bills "com.intel.crashdump.OnDemand"; 6889492a15SPatrick Williams constexpr const char* crashdumpTelemetryInterface = 696eda7685SKenny L. Ku "com.intel.crashdump.Telemetry"; 701da66f75SEd Tanous 718e31778eSAsmitha Karunanithi enum class DumpCreationProgress 728e31778eSAsmitha Karunanithi { 738e31778eSAsmitha Karunanithi DUMP_CREATE_SUCCESS, 748e31778eSAsmitha Karunanithi DUMP_CREATE_FAILED, 758e31778eSAsmitha Karunanithi DUMP_CREATE_INPROGRESS 768e31778eSAsmitha Karunanithi }; 778e31778eSAsmitha Karunanithi 78f6150403SJames Feist namespace fs = std::filesystem; 791da66f75SEd Tanous 80cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s) 81cb92c03bSAndrew Geissler { 82d4d25793SEd Tanous if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") || 83d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") || 84d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") || 85d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Error")) 86cb92c03bSAndrew Geissler { 87cb92c03bSAndrew Geissler return "Critical"; 88cb92c03bSAndrew Geissler } 893174e4dfSEd Tanous if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") || 90d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") || 91d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Notice")) 92cb92c03bSAndrew Geissler { 93cb92c03bSAndrew Geissler return "OK"; 94cb92c03bSAndrew Geissler } 953174e4dfSEd Tanous if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning") 96cb92c03bSAndrew Geissler { 97cb92c03bSAndrew Geissler return "Warning"; 98cb92c03bSAndrew Geissler } 99cb92c03bSAndrew Geissler return ""; 100cb92c03bSAndrew Geissler } 101cb92c03bSAndrew Geissler 1029017faf2SAbhishek Patel inline std::optional<bool> getProviderNotifyAction(const std::string& notify) 1039017faf2SAbhishek Patel { 1049017faf2SAbhishek Patel std::optional<bool> notifyAction; 1059017faf2SAbhishek Patel if (notify == "xyz.openbmc_project.Logging.Entry.Notify.Notify") 1069017faf2SAbhishek Patel { 1079017faf2SAbhishek Patel notifyAction = true; 1089017faf2SAbhishek Patel } 1099017faf2SAbhishek Patel else if (notify == "xyz.openbmc_project.Logging.Entry.Notify.Inhibit") 1109017faf2SAbhishek Patel { 1119017faf2SAbhishek Patel notifyAction = false; 1129017faf2SAbhishek Patel } 1139017faf2SAbhishek Patel 1149017faf2SAbhishek Patel return notifyAction; 1159017faf2SAbhishek Patel } 1169017faf2SAbhishek Patel 11718f8f608SEd Tanous inline std::string getDumpPath(std::string_view dumpType) 11818f8f608SEd Tanous { 11918f8f608SEd Tanous std::string dbusDumpPath = "/xyz/openbmc_project/dump/"; 12018f8f608SEd Tanous std::ranges::transform(dumpType, std::back_inserter(dbusDumpPath), 12118f8f608SEd Tanous bmcweb::asciiToLower); 12218f8f608SEd Tanous 12318f8f608SEd Tanous return dbusDumpPath; 12418f8f608SEd Tanous } 12518f8f608SEd Tanous 1267e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal, 12726ccae32SEd Tanous std::string_view field, 12839e77504SEd Tanous std::string_view& contents) 12916428a1aSJason M. Bills { 13016428a1aSJason M. Bills const char* data = nullptr; 13116428a1aSJason M. Bills size_t length = 0; 13216428a1aSJason M. Bills int ret = 0; 13316428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 13446ff87baSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) 13546ff87baSEd Tanous const void** dataVoid = reinterpret_cast<const void**>(&data); 13646ff87baSEd Tanous 13746ff87baSEd Tanous ret = sd_journal_get_data(journal, field.data(), dataVoid, &length); 13816428a1aSJason M. Bills if (ret < 0) 13916428a1aSJason M. Bills { 14016428a1aSJason M. Bills return ret; 14116428a1aSJason M. Bills } 14239e77504SEd Tanous contents = std::string_view(data, length); 14316428a1aSJason M. Bills // Only use the content after the "=" character. 14481ce609eSEd Tanous contents.remove_prefix(std::min(contents.find('=') + 1, contents.size())); 14516428a1aSJason M. Bills return ret; 14616428a1aSJason M. Bills } 14716428a1aSJason M. Bills 1487e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal, 14926ccae32SEd Tanous std::string_view field, const int& base, 15026ccae32SEd Tanous long int& contents) 15116428a1aSJason M. Bills { 15216428a1aSJason M. Bills int ret = 0; 15339e77504SEd Tanous std::string_view metadata; 15416428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 15516428a1aSJason M. Bills ret = getJournalMetadata(journal, field, metadata); 15616428a1aSJason M. Bills if (ret < 0) 15716428a1aSJason M. Bills { 15816428a1aSJason M. Bills return ret; 15916428a1aSJason M. Bills } 160b01bf299SEd Tanous contents = strtol(metadata.data(), nullptr, base); 16116428a1aSJason M. Bills return ret; 16216428a1aSJason M. Bills } 16316428a1aSJason M. Bills 1647e860f15SJohn Edward Broadbent inline static bool getEntryTimestamp(sd_journal* journal, 1657e860f15SJohn Edward Broadbent std::string& entryTimestamp) 166a3316fc6SZhikuiRen { 167a3316fc6SZhikuiRen int ret = 0; 168a3316fc6SZhikuiRen uint64_t timestamp = 0; 169a3316fc6SZhikuiRen ret = sd_journal_get_realtime_usec(journal, ×tamp); 170a3316fc6SZhikuiRen if (ret < 0) 171a3316fc6SZhikuiRen { 17262598e31SEd Tanous BMCWEB_LOG_ERROR("Failed to read entry timestamp: {}", strerror(-ret)); 173a3316fc6SZhikuiRen return false; 174a3316fc6SZhikuiRen } 175e645c5e6SKonstantin Aladyshev entryTimestamp = redfish::time_utils::getDateTimeUintUs(timestamp); 1769c620e21SAsmitha Karunanithi return true; 177a3316fc6SZhikuiRen } 17850b8a43aSEd Tanous 1797e860f15SJohn Edward Broadbent inline static bool getUniqueEntryID(sd_journal* journal, std::string& entryID, 180e85d6b16SJason M. Bills const bool firstEntry = true) 18116428a1aSJason M. Bills { 18216428a1aSJason M. Bills int ret = 0; 18375e8e218SMyung Bae static sd_id128_t prevBootID{}; 18416428a1aSJason M. Bills static uint64_t prevTs = 0; 18516428a1aSJason M. Bills static int index = 0; 186e85d6b16SJason M. Bills if (firstEntry) 187e85d6b16SJason M. Bills { 18875e8e218SMyung Bae prevBootID = {}; 189e85d6b16SJason M. Bills prevTs = 0; 190e85d6b16SJason M. Bills } 191e85d6b16SJason M. Bills 19216428a1aSJason M. Bills // Get the entry timestamp 19316428a1aSJason M. Bills uint64_t curTs = 0; 19475e8e218SMyung Bae sd_id128_t curBootID{}; 19575e8e218SMyung Bae ret = sd_journal_get_monotonic_usec(journal, &curTs, &curBootID); 19616428a1aSJason M. Bills if (ret < 0) 19716428a1aSJason M. Bills { 19862598e31SEd Tanous BMCWEB_LOG_ERROR("Failed to read entry timestamp: {}", strerror(-ret)); 19916428a1aSJason M. Bills return false; 20016428a1aSJason M. Bills } 20175e8e218SMyung Bae // If the timestamp isn't unique on the same boot, increment the index 20275e8e218SMyung Bae bool sameBootIDs = sd_id128_equal(curBootID, prevBootID) != 0; 20375e8e218SMyung Bae if (sameBootIDs && (curTs == prevTs)) 20416428a1aSJason M. Bills { 20516428a1aSJason M. Bills index++; 20616428a1aSJason M. Bills } 20716428a1aSJason M. Bills else 20816428a1aSJason M. Bills { 20916428a1aSJason M. Bills // Otherwise, reset it 21016428a1aSJason M. Bills index = 0; 21116428a1aSJason M. Bills } 21275e8e218SMyung Bae 21375e8e218SMyung Bae if (!sameBootIDs) 21475e8e218SMyung Bae { 21575e8e218SMyung Bae // Save the bootID 21675e8e218SMyung Bae prevBootID = curBootID; 21775e8e218SMyung Bae } 21816428a1aSJason M. Bills // Save the timestamp 21916428a1aSJason M. Bills prevTs = curTs; 22016428a1aSJason M. Bills 22175e8e218SMyung Bae // make entryID as <bootID>_<timestamp>[_<index>] 22275e8e218SMyung Bae std::array<char, SD_ID128_STRING_MAX> bootIDStr{}; 22375e8e218SMyung Bae sd_id128_to_string(curBootID, bootIDStr.data()); 22475e8e218SMyung Bae entryID = std::format("{}_{}", bootIDStr.data(), curTs); 22516428a1aSJason M. Bills if (index > 0) 22616428a1aSJason M. Bills { 22716428a1aSJason M. Bills entryID += "_" + std::to_string(index); 22816428a1aSJason M. Bills } 22916428a1aSJason M. Bills return true; 23016428a1aSJason M. Bills } 23116428a1aSJason M. Bills 232e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID, 233e85d6b16SJason M. Bills const bool firstEntry = true) 23495820184SJason M. Bills { 235271584abSEd Tanous static time_t prevTs = 0; 23695820184SJason M. Bills static int index = 0; 237e85d6b16SJason M. Bills if (firstEntry) 238e85d6b16SJason M. Bills { 239e85d6b16SJason M. Bills prevTs = 0; 240e85d6b16SJason M. Bills } 241e85d6b16SJason M. Bills 24295820184SJason M. Bills // Get the entry timestamp 243271584abSEd Tanous std::time_t curTs = 0; 24495820184SJason M. Bills std::tm timeStruct = {}; 24595820184SJason M. Bills std::istringstream entryStream(logEntry); 24695820184SJason M. Bills if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 24795820184SJason M. Bills { 24895820184SJason M. Bills curTs = std::mktime(&timeStruct); 24995820184SJason M. Bills } 25095820184SJason M. Bills // If the timestamp isn't unique, increment the index 25195820184SJason M. Bills if (curTs == prevTs) 25295820184SJason M. Bills { 25395820184SJason M. Bills index++; 25495820184SJason M. Bills } 25595820184SJason M. Bills else 25695820184SJason M. Bills { 25795820184SJason M. Bills // Otherwise, reset it 25895820184SJason M. Bills index = 0; 25995820184SJason M. Bills } 26095820184SJason M. Bills // Save the timestamp 26195820184SJason M. Bills prevTs = curTs; 26295820184SJason M. Bills 26395820184SJason M. Bills entryID = std::to_string(curTs); 26495820184SJason M. Bills if (index > 0) 26595820184SJason M. Bills { 26695820184SJason M. Bills entryID += "_" + std::to_string(index); 26795820184SJason M. Bills } 26895820184SJason M. Bills return true; 26995820184SJason M. Bills } 27095820184SJason M. Bills 27175e8e218SMyung Bae // Entry is formed like "BootID_timestamp" or "BootID_timestamp_index" 2727e860f15SJohn Edward Broadbent inline static bool 2738d1b46d7Szhanghch05 getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 27475e8e218SMyung Bae const std::string& entryID, sd_id128_t& bootID, 27575e8e218SMyung Bae uint64_t& timestamp, uint64_t& index) 27616428a1aSJason M. Bills { 27716428a1aSJason M. Bills if (entryID.empty()) 27816428a1aSJason M. Bills { 27916428a1aSJason M. Bills return false; 28016428a1aSJason M. Bills } 28116428a1aSJason M. Bills 28275e8e218SMyung Bae // Convert the unique ID back to a bootID + timestamp to find the entry 28375e8e218SMyung Bae std::string_view entryIDStrView(entryID); 28475e8e218SMyung Bae auto underscore1Pos = entryIDStrView.find('_'); 28575e8e218SMyung Bae if (underscore1Pos == std::string_view::npos) 28675e8e218SMyung Bae { 28775e8e218SMyung Bae // EntryID has no bootID or timestamp 28875e8e218SMyung Bae messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 28975e8e218SMyung Bae return false; 29075e8e218SMyung Bae } 29175e8e218SMyung Bae 29275e8e218SMyung Bae // EntryID has bootID + timestamp 29375e8e218SMyung Bae 29475e8e218SMyung Bae // Convert entryIDViewString to BootID 29575e8e218SMyung Bae // NOTE: bootID string which needs to be null-terminated for 29675e8e218SMyung Bae // sd_id128_from_string() 29775e8e218SMyung Bae std::string bootIDStr(entryID, 0, underscore1Pos); 29875e8e218SMyung Bae if (sd_id128_from_string(bootIDStr.c_str(), &bootID) < 0) 29975e8e218SMyung Bae { 30075e8e218SMyung Bae messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 30175e8e218SMyung Bae return false; 30275e8e218SMyung Bae } 30375e8e218SMyung Bae 30475e8e218SMyung Bae // Get the timestamp from entryID 30575e8e218SMyung Bae std::string_view timestampStrView = entryIDStrView; 30675e8e218SMyung Bae timestampStrView.remove_prefix(underscore1Pos + 1); 30775e8e218SMyung Bae 30875e8e218SMyung Bae // Check the index in timestamp 30975e8e218SMyung Bae auto underscore2Pos = timestampStrView.find('_'); 31075e8e218SMyung Bae if (underscore2Pos != std::string_view::npos) 31116428a1aSJason M. Bills { 31216428a1aSJason M. Bills // Timestamp has an index 31375e8e218SMyung Bae timestampStrView.remove_suffix(timestampStrView.size() - 31475e8e218SMyung Bae underscore2Pos); 31575e8e218SMyung Bae std::string_view indexStr(timestampStrView); 31675e8e218SMyung Bae indexStr.remove_prefix(underscore2Pos + 1); 31784396af9SPatrick Williams auto [ptr, ec] = std::from_chars(indexStr.begin(), indexStr.end(), 31884396af9SPatrick Williams index); 319c0bd5e4bSEd Tanous if (ec != std::errc()) 32016428a1aSJason M. Bills { 3219db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 32216428a1aSJason M. Bills return false; 32316428a1aSJason M. Bills } 32416428a1aSJason M. Bills } 32575e8e218SMyung Bae 32675e8e218SMyung Bae // Now timestamp has no index 32775e8e218SMyung Bae auto [ptr, ec] = std::from_chars(timestampStrView.begin(), 32875e8e218SMyung Bae timestampStrView.end(), timestamp); 329c0bd5e4bSEd Tanous if (ec != std::errc()) 33016428a1aSJason M. Bills { 3319db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 33216428a1aSJason M. Bills return false; 33316428a1aSJason M. Bills } 33416428a1aSJason M. Bills return true; 33516428a1aSJason M. Bills } 33616428a1aSJason M. Bills 33795820184SJason M. Bills static bool 33895820184SJason M. Bills getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles) 33995820184SJason M. Bills { 34095820184SJason M. Bills static const std::filesystem::path redfishLogDir = "/var/log"; 34195820184SJason M. Bills static const std::string redfishLogFilename = "redfish"; 34295820184SJason M. Bills 34395820184SJason M. Bills // Loop through the directory looking for redfish log files 34495820184SJason M. Bills for (const std::filesystem::directory_entry& dirEnt : 34595820184SJason M. Bills std::filesystem::directory_iterator(redfishLogDir)) 34695820184SJason M. Bills { 34795820184SJason M. Bills // If we find a redfish log file, save the path 34895820184SJason M. Bills std::string filename = dirEnt.path().filename(); 34911ba3979SEd Tanous if (filename.starts_with(redfishLogFilename)) 35095820184SJason M. Bills { 35195820184SJason M. Bills redfishLogFiles.emplace_back(redfishLogDir / filename); 35295820184SJason M. Bills } 35395820184SJason M. Bills } 35495820184SJason M. Bills // As the log files rotate, they are appended with a ".#" that is higher for 35595820184SJason M. Bills // the older logs. Since we don't expect more than 10 log files, we 35695820184SJason M. Bills // can just sort the list to get them in order from newest to oldest 3573544d2a7SEd Tanous std::ranges::sort(redfishLogFiles); 35895820184SJason M. Bills 35995820184SJason M. Bills return !redfishLogFiles.empty(); 36095820184SJason M. Bills } 36195820184SJason M. Bills 36268dd075aSAsmitha Karunanithi inline log_entry::OriginatorTypes 36368dd075aSAsmitha Karunanithi mapDbusOriginatorTypeToRedfish(const std::string& originatorType) 36468dd075aSAsmitha Karunanithi { 36568dd075aSAsmitha Karunanithi if (originatorType == 36668dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client") 36768dd075aSAsmitha Karunanithi { 36868dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::Client; 36968dd075aSAsmitha Karunanithi } 37068dd075aSAsmitha Karunanithi if (originatorType == 37168dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Internal") 37268dd075aSAsmitha Karunanithi { 37368dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::Internal; 37468dd075aSAsmitha Karunanithi } 37568dd075aSAsmitha Karunanithi if (originatorType == 37668dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.SupportingService") 37768dd075aSAsmitha Karunanithi { 37868dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::SupportingService; 37968dd075aSAsmitha Karunanithi } 38068dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::Invalid; 38168dd075aSAsmitha Karunanithi } 38268dd075aSAsmitha Karunanithi 383aefe3786SClaire Weinan inline void parseDumpEntryFromDbusObject( 3842d613eb6SJiaqing Zhao const dbus::utility::ManagedObjectType::value_type& object, 385c6fecdabSClaire Weinan std::string& dumpStatus, uint64_t& size, uint64_t& timestampUs, 38668dd075aSAsmitha Karunanithi std::string& originatorId, log_entry::OriginatorTypes& originatorType, 387aefe3786SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 388aefe3786SClaire Weinan { 389aefe3786SClaire Weinan for (const auto& interfaceMap : object.second) 390aefe3786SClaire Weinan { 391aefe3786SClaire Weinan if (interfaceMap.first == "xyz.openbmc_project.Common.Progress") 392aefe3786SClaire Weinan { 393aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 394aefe3786SClaire Weinan { 395aefe3786SClaire Weinan if (propertyMap.first == "Status") 396aefe3786SClaire Weinan { 397aefe3786SClaire Weinan const auto* status = 398aefe3786SClaire Weinan std::get_if<std::string>(&propertyMap.second); 399aefe3786SClaire Weinan if (status == nullptr) 400aefe3786SClaire Weinan { 401aefe3786SClaire Weinan messages::internalError(asyncResp->res); 402aefe3786SClaire Weinan break; 403aefe3786SClaire Weinan } 404aefe3786SClaire Weinan dumpStatus = *status; 405aefe3786SClaire Weinan } 406aefe3786SClaire Weinan } 407aefe3786SClaire Weinan } 408aefe3786SClaire Weinan else if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") 409aefe3786SClaire Weinan { 410aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 411aefe3786SClaire Weinan { 412aefe3786SClaire Weinan if (propertyMap.first == "Size") 413aefe3786SClaire Weinan { 414aefe3786SClaire Weinan const auto* sizePtr = 415aefe3786SClaire Weinan std::get_if<uint64_t>(&propertyMap.second); 416aefe3786SClaire Weinan if (sizePtr == nullptr) 417aefe3786SClaire Weinan { 418aefe3786SClaire Weinan messages::internalError(asyncResp->res); 419aefe3786SClaire Weinan break; 420aefe3786SClaire Weinan } 421aefe3786SClaire Weinan size = *sizePtr; 422aefe3786SClaire Weinan break; 423aefe3786SClaire Weinan } 424aefe3786SClaire Weinan } 425aefe3786SClaire Weinan } 426aefe3786SClaire Weinan else if (interfaceMap.first == "xyz.openbmc_project.Time.EpochTime") 427aefe3786SClaire Weinan { 428aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 429aefe3786SClaire Weinan { 430aefe3786SClaire Weinan if (propertyMap.first == "Elapsed") 431aefe3786SClaire Weinan { 432aefe3786SClaire Weinan const uint64_t* usecsTimeStamp = 433aefe3786SClaire Weinan std::get_if<uint64_t>(&propertyMap.second); 434aefe3786SClaire Weinan if (usecsTimeStamp == nullptr) 435aefe3786SClaire Weinan { 436aefe3786SClaire Weinan messages::internalError(asyncResp->res); 437aefe3786SClaire Weinan break; 438aefe3786SClaire Weinan } 439c6fecdabSClaire Weinan timestampUs = *usecsTimeStamp; 440aefe3786SClaire Weinan break; 441aefe3786SClaire Weinan } 442aefe3786SClaire Weinan } 443aefe3786SClaire Weinan } 44468dd075aSAsmitha Karunanithi else if (interfaceMap.first == 44568dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy") 44668dd075aSAsmitha Karunanithi { 44768dd075aSAsmitha Karunanithi for (const auto& propertyMap : interfaceMap.second) 44868dd075aSAsmitha Karunanithi { 44968dd075aSAsmitha Karunanithi if (propertyMap.first == "OriginatorId") 45068dd075aSAsmitha Karunanithi { 45168dd075aSAsmitha Karunanithi const std::string* id = 45268dd075aSAsmitha Karunanithi std::get_if<std::string>(&propertyMap.second); 45368dd075aSAsmitha Karunanithi if (id == nullptr) 45468dd075aSAsmitha Karunanithi { 45568dd075aSAsmitha Karunanithi messages::internalError(asyncResp->res); 45668dd075aSAsmitha Karunanithi break; 45768dd075aSAsmitha Karunanithi } 45868dd075aSAsmitha Karunanithi originatorId = *id; 45968dd075aSAsmitha Karunanithi } 46068dd075aSAsmitha Karunanithi 46168dd075aSAsmitha Karunanithi if (propertyMap.first == "OriginatorType") 46268dd075aSAsmitha Karunanithi { 46368dd075aSAsmitha Karunanithi const std::string* type = 46468dd075aSAsmitha Karunanithi std::get_if<std::string>(&propertyMap.second); 46568dd075aSAsmitha Karunanithi if (type == nullptr) 46668dd075aSAsmitha Karunanithi { 46768dd075aSAsmitha Karunanithi messages::internalError(asyncResp->res); 46868dd075aSAsmitha Karunanithi break; 46968dd075aSAsmitha Karunanithi } 47068dd075aSAsmitha Karunanithi 47168dd075aSAsmitha Karunanithi originatorType = mapDbusOriginatorTypeToRedfish(*type); 47268dd075aSAsmitha Karunanithi if (originatorType == log_entry::OriginatorTypes::Invalid) 47368dd075aSAsmitha Karunanithi { 47468dd075aSAsmitha Karunanithi messages::internalError(asyncResp->res); 47568dd075aSAsmitha Karunanithi break; 47668dd075aSAsmitha Karunanithi } 47768dd075aSAsmitha Karunanithi } 47868dd075aSAsmitha Karunanithi } 47968dd075aSAsmitha Karunanithi } 480aefe3786SClaire Weinan } 481aefe3786SClaire Weinan } 482aefe3786SClaire Weinan 48321ab404cSNan Zhou static std::string getDumpEntriesPath(const std::string& dumpType) 484fdd26906SClaire Weinan { 485fdd26906SClaire Weinan std::string entriesPath; 486fdd26906SClaire Weinan 487fdd26906SClaire Weinan if (dumpType == "BMC") 488fdd26906SClaire Weinan { 489fdd26906SClaire Weinan entriesPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 490fdd26906SClaire Weinan } 491fdd26906SClaire Weinan else if (dumpType == "FaultLog") 492fdd26906SClaire Weinan { 493fdd26906SClaire Weinan entriesPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/"; 494fdd26906SClaire Weinan } 495fdd26906SClaire Weinan else if (dumpType == "System") 496fdd26906SClaire Weinan { 497fdd26906SClaire Weinan entriesPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 498fdd26906SClaire Weinan } 499fdd26906SClaire Weinan else 500fdd26906SClaire Weinan { 50162598e31SEd Tanous BMCWEB_LOG_ERROR("getDumpEntriesPath() invalid dump type: {}", 50262598e31SEd Tanous dumpType); 503fdd26906SClaire Weinan } 504fdd26906SClaire Weinan 505fdd26906SClaire Weinan // Returns empty string on error 506fdd26906SClaire Weinan return entriesPath; 507fdd26906SClaire Weinan } 508fdd26906SClaire Weinan 5098d1b46d7Szhanghch05 inline void 5108d1b46d7Szhanghch05 getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 5115cb1dd27SAsmitha Karunanithi const std::string& dumpType) 5125cb1dd27SAsmitha Karunanithi { 513fdd26906SClaire Weinan std::string entriesPath = getDumpEntriesPath(dumpType); 514fdd26906SClaire Weinan if (entriesPath.empty()) 5155cb1dd27SAsmitha Karunanithi { 5165cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5175cb1dd27SAsmitha Karunanithi return; 5185cb1dd27SAsmitha Karunanithi } 5195cb1dd27SAsmitha Karunanithi 5205eb468daSGeorge Liu sdbusplus::message::object_path path("/xyz/openbmc_project/dump"); 5215eb468daSGeorge Liu dbus::utility::getManagedObjects( 5225eb468daSGeorge Liu "xyz.openbmc_project.Dump.Manager", path, 523fdd26906SClaire Weinan [asyncResp, entriesPath, 5245e7e2dc5SEd Tanous dumpType](const boost::system::error_code& ec, 5255eb468daSGeorge Liu const dbus::utility::ManagedObjectType& objects) { 5265cb1dd27SAsmitha Karunanithi if (ec) 5275cb1dd27SAsmitha Karunanithi { 52862598e31SEd Tanous BMCWEB_LOG_ERROR("DumpEntry resp_handler got error {}", ec); 5295cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5305cb1dd27SAsmitha Karunanithi return; 5315cb1dd27SAsmitha Karunanithi } 5325cb1dd27SAsmitha Karunanithi 533fdd26906SClaire Weinan // Remove ending slash 534fdd26906SClaire Weinan std::string odataIdStr = entriesPath; 535fdd26906SClaire Weinan if (!odataIdStr.empty()) 536fdd26906SClaire Weinan { 537fdd26906SClaire Weinan odataIdStr.pop_back(); 538fdd26906SClaire Weinan } 539fdd26906SClaire Weinan 540fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.type"] = 541fdd26906SClaire Weinan "#LogEntryCollection.LogEntryCollection"; 542fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = std::move(odataIdStr); 543fdd26906SClaire Weinan asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entries"; 54489492a15SPatrick Williams asyncResp->res.jsonValue["Description"] = "Collection of " + dumpType + 54589492a15SPatrick Williams " Dump Entries"; 546fdd26906SClaire Weinan 5473544d2a7SEd Tanous nlohmann::json::array_t entriesArray; 54818f8f608SEd Tanous std::string dumpEntryPath = getDumpPath(dumpType) + "/entry/"; 5495cb1dd27SAsmitha Karunanithi 5505eb468daSGeorge Liu dbus::utility::ManagedObjectType resp(objects); 5513544d2a7SEd Tanous std::ranges::sort(resp, [](const auto& l, const auto& r) { 552002d39b4SEd Tanous return AlphanumLess<std::string>()(l.first.filename(), 553002d39b4SEd Tanous r.first.filename()); 554565dfb6fSClaire Weinan }); 555565dfb6fSClaire Weinan 5565cb1dd27SAsmitha Karunanithi for (auto& object : resp) 5575cb1dd27SAsmitha Karunanithi { 558b47452b2SAsmitha Karunanithi if (object.first.str.find(dumpEntryPath) == std::string::npos) 5595cb1dd27SAsmitha Karunanithi { 5605cb1dd27SAsmitha Karunanithi continue; 5615cb1dd27SAsmitha Karunanithi } 562c6fecdabSClaire Weinan uint64_t timestampUs = 0; 5635cb1dd27SAsmitha Karunanithi uint64_t size = 0; 56435440d18SAsmitha Karunanithi std::string dumpStatus; 56568dd075aSAsmitha Karunanithi std::string originatorId; 56668dd075aSAsmitha Karunanithi log_entry::OriginatorTypes originatorType = 56768dd075aSAsmitha Karunanithi log_entry::OriginatorTypes::Internal; 568433b68b4SJason M. Bills nlohmann::json::object_t thisEntry; 5692dfd18efSEd Tanous 5702dfd18efSEd Tanous std::string entryID = object.first.filename(); 5712dfd18efSEd Tanous if (entryID.empty()) 5725cb1dd27SAsmitha Karunanithi { 5735cb1dd27SAsmitha Karunanithi continue; 5745cb1dd27SAsmitha Karunanithi } 5755cb1dd27SAsmitha Karunanithi 576c6fecdabSClaire Weinan parseDumpEntryFromDbusObject(object, dumpStatus, size, timestampUs, 57768dd075aSAsmitha Karunanithi originatorId, originatorType, 578aefe3786SClaire Weinan asyncResp); 5795cb1dd27SAsmitha Karunanithi 5800fda0f12SGeorge Liu if (dumpStatus != 5810fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 58235440d18SAsmitha Karunanithi !dumpStatus.empty()) 58335440d18SAsmitha Karunanithi { 58435440d18SAsmitha Karunanithi // Dump status is not Complete, no need to enumerate 58535440d18SAsmitha Karunanithi continue; 58635440d18SAsmitha Karunanithi } 58735440d18SAsmitha Karunanithi 58868dd075aSAsmitha Karunanithi thisEntry["@odata.type"] = "#LogEntry.v1_11_0.LogEntry"; 589fdd26906SClaire Weinan thisEntry["@odata.id"] = entriesPath + entryID; 5905cb1dd27SAsmitha Karunanithi thisEntry["Id"] = entryID; 5915cb1dd27SAsmitha Karunanithi thisEntry["EntryType"] = "Event"; 5925cb1dd27SAsmitha Karunanithi thisEntry["Name"] = dumpType + " Dump Entry"; 593bbd80db8SClaire Weinan thisEntry["Created"] = 594bbd80db8SClaire Weinan redfish::time_utils::getDateTimeUintUs(timestampUs); 5955cb1dd27SAsmitha Karunanithi 59668dd075aSAsmitha Karunanithi if (!originatorId.empty()) 59768dd075aSAsmitha Karunanithi { 59868dd075aSAsmitha Karunanithi thisEntry["Originator"] = originatorId; 59968dd075aSAsmitha Karunanithi thisEntry["OriginatorType"] = originatorType; 60068dd075aSAsmitha Karunanithi } 60168dd075aSAsmitha Karunanithi 6025cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 6035cb1dd27SAsmitha Karunanithi { 604d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "Manager"; 60589492a15SPatrick Williams thisEntry["AdditionalDataURI"] = entriesPath + entryID + 60689492a15SPatrick Williams "/attachment"; 607fdd26906SClaire Weinan thisEntry["AdditionalDataSizeBytes"] = size; 6085cb1dd27SAsmitha Karunanithi } 6095cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 6105cb1dd27SAsmitha Karunanithi { 611d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "OEM"; 612d337bb72SAsmitha Karunanithi thisEntry["OEMDiagnosticDataType"] = "System"; 61389492a15SPatrick Williams thisEntry["AdditionalDataURI"] = entriesPath + entryID + 61489492a15SPatrick Williams "/attachment"; 615fdd26906SClaire Weinan thisEntry["AdditionalDataSizeBytes"] = size; 6165cb1dd27SAsmitha Karunanithi } 617b2ba3072SPatrick Williams entriesArray.emplace_back(std::move(thisEntry)); 6185cb1dd27SAsmitha Karunanithi } 619002d39b4SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size(); 6203544d2a7SEd Tanous asyncResp->res.jsonValue["Members"] = std::move(entriesArray); 6215eb468daSGeorge Liu }); 6225cb1dd27SAsmitha Karunanithi } 6235cb1dd27SAsmitha Karunanithi 6248d1b46d7Szhanghch05 inline void 625c7a6d660SClaire Weinan getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 6268d1b46d7Szhanghch05 const std::string& entryID, const std::string& dumpType) 6275cb1dd27SAsmitha Karunanithi { 628fdd26906SClaire Weinan std::string entriesPath = getDumpEntriesPath(dumpType); 629fdd26906SClaire Weinan if (entriesPath.empty()) 6305cb1dd27SAsmitha Karunanithi { 6315cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6325cb1dd27SAsmitha Karunanithi return; 6335cb1dd27SAsmitha Karunanithi } 6345cb1dd27SAsmitha Karunanithi 6355eb468daSGeorge Liu sdbusplus::message::object_path path("/xyz/openbmc_project/dump"); 6365eb468daSGeorge Liu dbus::utility::getManagedObjects( 6375eb468daSGeorge Liu "xyz.openbmc_project.Dump.Manager", path, 638fdd26906SClaire Weinan [asyncResp, entryID, dumpType, 6395e7e2dc5SEd Tanous entriesPath](const boost::system::error_code& ec, 64002cad96eSEd Tanous const dbus::utility::ManagedObjectType& resp) { 6415cb1dd27SAsmitha Karunanithi if (ec) 6425cb1dd27SAsmitha Karunanithi { 64362598e31SEd Tanous BMCWEB_LOG_ERROR("DumpEntry resp_handler got error {}", ec); 6445cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6455cb1dd27SAsmitha Karunanithi return; 6465cb1dd27SAsmitha Karunanithi } 6475cb1dd27SAsmitha Karunanithi 648b47452b2SAsmitha Karunanithi bool foundDumpEntry = false; 64918f8f608SEd Tanous std::string dumpEntryPath = getDumpPath(dumpType) + "/entry/"; 650b47452b2SAsmitha Karunanithi 6519eb808c1SEd Tanous for (const auto& objectPath : resp) 6525cb1dd27SAsmitha Karunanithi { 653b47452b2SAsmitha Karunanithi if (objectPath.first.str != dumpEntryPath + entryID) 6545cb1dd27SAsmitha Karunanithi { 6555cb1dd27SAsmitha Karunanithi continue; 6565cb1dd27SAsmitha Karunanithi } 6575cb1dd27SAsmitha Karunanithi 6585cb1dd27SAsmitha Karunanithi foundDumpEntry = true; 659c6fecdabSClaire Weinan uint64_t timestampUs = 0; 6605cb1dd27SAsmitha Karunanithi uint64_t size = 0; 66135440d18SAsmitha Karunanithi std::string dumpStatus; 66268dd075aSAsmitha Karunanithi std::string originatorId; 66368dd075aSAsmitha Karunanithi log_entry::OriginatorTypes originatorType = 66468dd075aSAsmitha Karunanithi log_entry::OriginatorTypes::Internal; 6655cb1dd27SAsmitha Karunanithi 666aefe3786SClaire Weinan parseDumpEntryFromDbusObject(objectPath, dumpStatus, size, 66768dd075aSAsmitha Karunanithi timestampUs, originatorId, 66868dd075aSAsmitha Karunanithi originatorType, asyncResp); 6695cb1dd27SAsmitha Karunanithi 6700fda0f12SGeorge Liu if (dumpStatus != 6710fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 67235440d18SAsmitha Karunanithi !dumpStatus.empty()) 67335440d18SAsmitha Karunanithi { 67435440d18SAsmitha Karunanithi // Dump status is not Complete 67535440d18SAsmitha Karunanithi // return not found until status is changed to Completed 676d1bde9e5SKrzysztof Grobelny messages::resourceNotFound(asyncResp->res, dumpType + " dump", 677d1bde9e5SKrzysztof Grobelny entryID); 67835440d18SAsmitha Karunanithi return; 67935440d18SAsmitha Karunanithi } 68035440d18SAsmitha Karunanithi 6815cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 68268dd075aSAsmitha Karunanithi "#LogEntry.v1_11_0.LogEntry"; 683fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = entriesPath + entryID; 6845cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = entryID; 6855cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["EntryType"] = "Event"; 6865cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry"; 687bbd80db8SClaire Weinan asyncResp->res.jsonValue["Created"] = 688bbd80db8SClaire Weinan redfish::time_utils::getDateTimeUintUs(timestampUs); 6895cb1dd27SAsmitha Karunanithi 69068dd075aSAsmitha Karunanithi if (!originatorId.empty()) 69168dd075aSAsmitha Karunanithi { 69268dd075aSAsmitha Karunanithi asyncResp->res.jsonValue["Originator"] = originatorId; 69368dd075aSAsmitha Karunanithi asyncResp->res.jsonValue["OriginatorType"] = originatorType; 69468dd075aSAsmitha Karunanithi } 69568dd075aSAsmitha Karunanithi 6965cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 6975cb1dd27SAsmitha Karunanithi { 698d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager"; 699d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 700fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 701fdd26906SClaire Weinan asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 7025cb1dd27SAsmitha Karunanithi } 7035cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 7045cb1dd27SAsmitha Karunanithi { 705d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM"; 706002d39b4SEd Tanous asyncResp->res.jsonValue["OEMDiagnosticDataType"] = "System"; 707d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 708fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 709fdd26906SClaire Weinan asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 7105cb1dd27SAsmitha Karunanithi } 7115cb1dd27SAsmitha Karunanithi } 712e05aec50SEd Tanous if (!foundDumpEntry) 713b47452b2SAsmitha Karunanithi { 71462598e31SEd Tanous BMCWEB_LOG_WARNING("Can't find Dump Entry {}", entryID); 715b90d14f2SMyung Bae messages::resourceNotFound(asyncResp->res, dumpType + " dump", 716b90d14f2SMyung Bae entryID); 717b47452b2SAsmitha Karunanithi return; 718b47452b2SAsmitha Karunanithi } 7195eb468daSGeorge Liu }); 7205cb1dd27SAsmitha Karunanithi } 7215cb1dd27SAsmitha Karunanithi 7228d1b46d7Szhanghch05 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 7239878256fSStanley Chu const std::string& entryID, 724b47452b2SAsmitha Karunanithi const std::string& dumpType) 7255cb1dd27SAsmitha Karunanithi { 7265a39f77aSPatrick Williams auto respHandler = [asyncResp, 7275a39f77aSPatrick Williams entryID](const boost::system::error_code& ec) { 72862598e31SEd Tanous BMCWEB_LOG_DEBUG("Dump Entry doDelete callback: Done"); 7295cb1dd27SAsmitha Karunanithi if (ec) 7305cb1dd27SAsmitha Karunanithi { 7313de8d8baSGeorge Liu if (ec.value() == EBADR) 7323de8d8baSGeorge Liu { 7333de8d8baSGeorge Liu messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 7343de8d8baSGeorge Liu return; 7353de8d8baSGeorge Liu } 73662598e31SEd Tanous BMCWEB_LOG_ERROR( 73762598e31SEd Tanous "Dump (DBus) doDelete respHandler got error {} entryID={}", ec, 73862598e31SEd Tanous entryID); 7395cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 7405cb1dd27SAsmitha Karunanithi return; 7415cb1dd27SAsmitha Karunanithi } 7425cb1dd27SAsmitha Karunanithi }; 74318f8f608SEd Tanous 7445cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 7455cb1dd27SAsmitha Karunanithi respHandler, "xyz.openbmc_project.Dump.Manager", 74618f8f608SEd Tanous std::format("{}/entry/{}", getDumpPath(dumpType), entryID), 7475cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Object.Delete", "Delete"); 7485cb1dd27SAsmitha Karunanithi } 749*b5f288d2SAbhilash Raju inline bool checkSizeLimit(int fd, crow::Response& res) 750*b5f288d2SAbhilash Raju { 751*b5f288d2SAbhilash Raju long long int size = lseek(fd, 0, SEEK_END); 752*b5f288d2SAbhilash Raju if (size <= 0) 753*b5f288d2SAbhilash Raju { 754*b5f288d2SAbhilash Raju BMCWEB_LOG_ERROR("Failed to get size of file, lseek() returned {}", 755*b5f288d2SAbhilash Raju size); 756*b5f288d2SAbhilash Raju messages::internalError(res); 757*b5f288d2SAbhilash Raju return false; 758*b5f288d2SAbhilash Raju } 7595cb1dd27SAsmitha Karunanithi 760*b5f288d2SAbhilash Raju // Arbitrary max size of 20MB to accommodate BMC dumps 761*b5f288d2SAbhilash Raju constexpr long long int maxFileSize = 20LL * 1024LL * 1024LL; 762*b5f288d2SAbhilash Raju if (size > maxFileSize) 763*b5f288d2SAbhilash Raju { 764*b5f288d2SAbhilash Raju BMCWEB_LOG_ERROR("File size {} exceeds maximum allowed size of {}", 765*b5f288d2SAbhilash Raju size, maxFileSize); 766*b5f288d2SAbhilash Raju messages::internalError(res); 767*b5f288d2SAbhilash Raju return false; 768*b5f288d2SAbhilash Raju } 769*b5f288d2SAbhilash Raju off_t rc = lseek(fd, 0, SEEK_SET); 770*b5f288d2SAbhilash Raju if (rc < 0) 771*b5f288d2SAbhilash Raju { 772*b5f288d2SAbhilash Raju BMCWEB_LOG_ERROR("Failed to reset file offset to 0"); 773*b5f288d2SAbhilash Raju messages::internalError(res); 774*b5f288d2SAbhilash Raju return false; 775*b5f288d2SAbhilash Raju } 776*b5f288d2SAbhilash Raju return true; 777*b5f288d2SAbhilash Raju } 778168d1b1aSCarson Labrado inline void 779168d1b1aSCarson Labrado downloadEntryCallback(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 780168d1b1aSCarson Labrado const std::string& entryID, 781168d1b1aSCarson Labrado const std::string& downloadEntryType, 782168d1b1aSCarson Labrado const boost::system::error_code& ec, 783168d1b1aSCarson Labrado const sdbusplus::message::unix_fd& unixfd) 784168d1b1aSCarson Labrado { 785168d1b1aSCarson Labrado if (ec.value() == EBADR) 786168d1b1aSCarson Labrado { 787168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, "EntryAttachment", entryID); 788168d1b1aSCarson Labrado return; 789168d1b1aSCarson Labrado } 790168d1b1aSCarson Labrado if (ec) 791168d1b1aSCarson Labrado { 792168d1b1aSCarson Labrado BMCWEB_LOG_ERROR("DBUS response error: {}", ec); 793168d1b1aSCarson Labrado messages::internalError(asyncResp->res); 794168d1b1aSCarson Labrado return; 795168d1b1aSCarson Labrado } 796168d1b1aSCarson Labrado 797168d1b1aSCarson Labrado // Make sure we know how to process the retrieved entry attachment 798168d1b1aSCarson Labrado if ((downloadEntryType != "BMC") && (downloadEntryType != "System")) 799168d1b1aSCarson Labrado { 800168d1b1aSCarson Labrado BMCWEB_LOG_ERROR("downloadEntryCallback() invalid entry type: {}", 801168d1b1aSCarson Labrado downloadEntryType); 802168d1b1aSCarson Labrado messages::internalError(asyncResp->res); 803168d1b1aSCarson Labrado } 804168d1b1aSCarson Labrado 805168d1b1aSCarson Labrado int fd = -1; 806168d1b1aSCarson Labrado fd = dup(unixfd); 807168d1b1aSCarson Labrado if (fd < 0) 808168d1b1aSCarson Labrado { 809168d1b1aSCarson Labrado BMCWEB_LOG_ERROR("Failed to open file"); 810168d1b1aSCarson Labrado messages::internalError(asyncResp->res); 811168d1b1aSCarson Labrado return; 812168d1b1aSCarson Labrado } 813*b5f288d2SAbhilash Raju if (!checkSizeLimit(fd, asyncResp->res)) 814168d1b1aSCarson Labrado { 815168d1b1aSCarson Labrado close(fd); 816168d1b1aSCarson Labrado return; 817168d1b1aSCarson Labrado } 818168d1b1aSCarson Labrado if (downloadEntryType == "System") 819168d1b1aSCarson Labrado { 820*b5f288d2SAbhilash Raju if (!asyncResp->res.openFd(fd, bmcweb::EncodingType::Base64)) 821*b5f288d2SAbhilash Raju { 822*b5f288d2SAbhilash Raju messages::internalError(asyncResp->res); 823*b5f288d2SAbhilash Raju close(fd); 824*b5f288d2SAbhilash Raju return; 825*b5f288d2SAbhilash Raju } 826168d1b1aSCarson Labrado asyncResp->res.addHeader( 827168d1b1aSCarson Labrado boost::beast::http::field::content_transfer_encoding, "Base64"); 828*b5f288d2SAbhilash Raju return; 829168d1b1aSCarson Labrado } 830*b5f288d2SAbhilash Raju if (!asyncResp->res.openFd(fd)) 83127b0cf90SEd Tanous { 832*b5f288d2SAbhilash Raju messages::internalError(asyncResp->res); 833*b5f288d2SAbhilash Raju close(fd); 834*b5f288d2SAbhilash Raju return; 83527b0cf90SEd Tanous } 836168d1b1aSCarson Labrado asyncResp->res.addHeader(boost::beast::http::field::content_type, 837168d1b1aSCarson Labrado "application/octet-stream"); 838168d1b1aSCarson Labrado } 839168d1b1aSCarson Labrado 840168d1b1aSCarson Labrado inline void 841168d1b1aSCarson Labrado downloadDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 842168d1b1aSCarson Labrado const std::string& entryID, const std::string& dumpType) 843168d1b1aSCarson Labrado { 844168d1b1aSCarson Labrado if (dumpType != "BMC") 845168d1b1aSCarson Labrado { 846168d1b1aSCarson Labrado BMCWEB_LOG_WARNING("Can't find Dump Entry {}", entryID); 847168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, dumpType + " dump", entryID); 848168d1b1aSCarson Labrado return; 849168d1b1aSCarson Labrado } 850168d1b1aSCarson Labrado 85118f8f608SEd Tanous std::string dumpEntryPath = std::format("{}/entry/{}", 85218f8f608SEd Tanous getDumpPath(dumpType), entryID); 853168d1b1aSCarson Labrado 854168d1b1aSCarson Labrado auto downloadDumpEntryHandler = 855168d1b1aSCarson Labrado [asyncResp, entryID, 856168d1b1aSCarson Labrado dumpType](const boost::system::error_code& ec, 857168d1b1aSCarson Labrado const sdbusplus::message::unix_fd& unixfd) { 858168d1b1aSCarson Labrado downloadEntryCallback(asyncResp, entryID, dumpType, ec, unixfd); 859168d1b1aSCarson Labrado }; 860168d1b1aSCarson Labrado 861168d1b1aSCarson Labrado crow::connections::systemBus->async_method_call( 862168d1b1aSCarson Labrado std::move(downloadDumpEntryHandler), "xyz.openbmc_project.Dump.Manager", 863168d1b1aSCarson Labrado dumpEntryPath, "xyz.openbmc_project.Dump.Entry", "GetFileHandle"); 864168d1b1aSCarson Labrado } 865168d1b1aSCarson Labrado 866168d1b1aSCarson Labrado inline void 867168d1b1aSCarson Labrado downloadEventLogEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 868168d1b1aSCarson Labrado const std::string& systemName, 869168d1b1aSCarson Labrado const std::string& entryID, 870168d1b1aSCarson Labrado const std::string& dumpType) 871168d1b1aSCarson Labrado { 872168d1b1aSCarson Labrado if constexpr (bmcwebEnableMultiHost) 873168d1b1aSCarson Labrado { 874168d1b1aSCarson Labrado // Option currently returns no systems. TBD 875168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, "ComputerSystem", 876168d1b1aSCarson Labrado systemName); 877168d1b1aSCarson Labrado return; 878168d1b1aSCarson Labrado } 879168d1b1aSCarson Labrado if (systemName != "system") 880168d1b1aSCarson Labrado { 881168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, "ComputerSystem", 882168d1b1aSCarson Labrado systemName); 883168d1b1aSCarson Labrado return; 884168d1b1aSCarson Labrado } 885168d1b1aSCarson Labrado 886168d1b1aSCarson Labrado std::string entryPath = 887168d1b1aSCarson Labrado sdbusplus::message::object_path("/xyz/openbmc_project/logging/entry") / 888168d1b1aSCarson Labrado entryID; 889168d1b1aSCarson Labrado 890168d1b1aSCarson Labrado auto downloadEventLogEntryHandler = 891168d1b1aSCarson Labrado [asyncResp, entryID, 892168d1b1aSCarson Labrado dumpType](const boost::system::error_code& ec, 893168d1b1aSCarson Labrado const sdbusplus::message::unix_fd& unixfd) { 894168d1b1aSCarson Labrado downloadEntryCallback(asyncResp, entryID, dumpType, ec, unixfd); 895168d1b1aSCarson Labrado }; 896168d1b1aSCarson Labrado 897168d1b1aSCarson Labrado crow::connections::systemBus->async_method_call( 898168d1b1aSCarson Labrado std::move(downloadEventLogEntryHandler), "xyz.openbmc_project.Logging", 899168d1b1aSCarson Labrado entryPath, "xyz.openbmc_project.Logging.Entry", "GetEntry"); 900168d1b1aSCarson Labrado } 901168d1b1aSCarson Labrado 9028e31778eSAsmitha Karunanithi inline DumpCreationProgress 9038e31778eSAsmitha Karunanithi mapDbusStatusToDumpProgress(const std::string& status) 904a43be80fSAsmitha Karunanithi { 9058e31778eSAsmitha Karunanithi if (status == 9068e31778eSAsmitha Karunanithi "xyz.openbmc_project.Common.Progress.OperationStatus.Failed" || 9078e31778eSAsmitha Karunanithi status == "xyz.openbmc_project.Common.Progress.OperationStatus.Aborted") 9088e31778eSAsmitha Karunanithi { 9098e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_FAILED; 9108e31778eSAsmitha Karunanithi } 9118e31778eSAsmitha Karunanithi if (status == 9128e31778eSAsmitha Karunanithi "xyz.openbmc_project.Common.Progress.OperationStatus.Completed") 9138e31778eSAsmitha Karunanithi { 9148e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_SUCCESS; 9158e31778eSAsmitha Karunanithi } 9168e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_INPROGRESS; 9178e31778eSAsmitha Karunanithi } 9188e31778eSAsmitha Karunanithi 9198e31778eSAsmitha Karunanithi inline DumpCreationProgress 9208e31778eSAsmitha Karunanithi getDumpCompletionStatus(const dbus::utility::DBusPropertiesMap& values) 9218e31778eSAsmitha Karunanithi { 9228e31778eSAsmitha Karunanithi for (const auto& [key, val] : values) 9238e31778eSAsmitha Karunanithi { 9248e31778eSAsmitha Karunanithi if (key == "Status") 9258e31778eSAsmitha Karunanithi { 9268e31778eSAsmitha Karunanithi const std::string* value = std::get_if<std::string>(&val); 9278e31778eSAsmitha Karunanithi if (value == nullptr) 9288e31778eSAsmitha Karunanithi { 92962598e31SEd Tanous BMCWEB_LOG_ERROR("Status property value is null"); 9308e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_FAILED; 9318e31778eSAsmitha Karunanithi } 9328e31778eSAsmitha Karunanithi return mapDbusStatusToDumpProgress(*value); 9338e31778eSAsmitha Karunanithi } 9348e31778eSAsmitha Karunanithi } 9358e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_INPROGRESS; 9368e31778eSAsmitha Karunanithi } 9378e31778eSAsmitha Karunanithi 9388e31778eSAsmitha Karunanithi inline std::string getDumpEntryPath(const std::string& dumpPath) 9398e31778eSAsmitha Karunanithi { 9408e31778eSAsmitha Karunanithi if (dumpPath == "/xyz/openbmc_project/dump/bmc/entry") 9418e31778eSAsmitha Karunanithi { 9428e31778eSAsmitha Karunanithi return "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 9438e31778eSAsmitha Karunanithi } 9448e31778eSAsmitha Karunanithi if (dumpPath == "/xyz/openbmc_project/dump/system/entry") 9458e31778eSAsmitha Karunanithi { 9468e31778eSAsmitha Karunanithi return "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 9478e31778eSAsmitha Karunanithi } 9488e31778eSAsmitha Karunanithi return ""; 9498e31778eSAsmitha Karunanithi } 9508e31778eSAsmitha Karunanithi 9518e31778eSAsmitha Karunanithi inline void createDumpTaskCallback( 9528e31778eSAsmitha Karunanithi task::Payload&& payload, 9538e31778eSAsmitha Karunanithi const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 9548e31778eSAsmitha Karunanithi const sdbusplus::message::object_path& createdObjPath) 9558e31778eSAsmitha Karunanithi { 9568e31778eSAsmitha Karunanithi const std::string dumpPath = createdObjPath.parent_path().str; 9578e31778eSAsmitha Karunanithi const std::string dumpId = createdObjPath.filename(); 9588e31778eSAsmitha Karunanithi 9598e31778eSAsmitha Karunanithi std::string dumpEntryPath = getDumpEntryPath(dumpPath); 9608e31778eSAsmitha Karunanithi 9618e31778eSAsmitha Karunanithi if (dumpEntryPath.empty()) 9628e31778eSAsmitha Karunanithi { 96362598e31SEd Tanous BMCWEB_LOG_ERROR("Invalid dump type received"); 9648e31778eSAsmitha Karunanithi messages::internalError(asyncResp->res); 9658e31778eSAsmitha Karunanithi return; 9668e31778eSAsmitha Karunanithi } 9678e31778eSAsmitha Karunanithi 9688e31778eSAsmitha Karunanithi crow::connections::systemBus->async_method_call( 9698e31778eSAsmitha Karunanithi [asyncResp, payload, createdObjPath, 9708e31778eSAsmitha Karunanithi dumpEntryPath{std::move(dumpEntryPath)}, 9715e7e2dc5SEd Tanous dumpId](const boost::system::error_code& ec, 9728e31778eSAsmitha Karunanithi const std::string& introspectXml) { 9738e31778eSAsmitha Karunanithi if (ec) 9748e31778eSAsmitha Karunanithi { 97562598e31SEd Tanous BMCWEB_LOG_ERROR("Introspect call failed with error: {}", 97662598e31SEd Tanous ec.message()); 9778e31778eSAsmitha Karunanithi messages::internalError(asyncResp->res); 9788e31778eSAsmitha Karunanithi return; 9798e31778eSAsmitha Karunanithi } 9808e31778eSAsmitha Karunanithi 9818e31778eSAsmitha Karunanithi // Check if the created dump object has implemented Progress 9828e31778eSAsmitha Karunanithi // interface to track dump completion. If yes, fetch the "Status" 9838e31778eSAsmitha Karunanithi // property of the interface, modify the task state accordingly. 9848e31778eSAsmitha Karunanithi // Else, return task completed. 9858e31778eSAsmitha Karunanithi tinyxml2::XMLDocument doc; 9868e31778eSAsmitha Karunanithi 9878e31778eSAsmitha Karunanithi doc.Parse(introspectXml.data(), introspectXml.size()); 9888e31778eSAsmitha Karunanithi tinyxml2::XMLNode* pRoot = doc.FirstChildElement("node"); 9898e31778eSAsmitha Karunanithi if (pRoot == nullptr) 9908e31778eSAsmitha Karunanithi { 99162598e31SEd Tanous BMCWEB_LOG_ERROR("XML document failed to parse"); 9928e31778eSAsmitha Karunanithi messages::internalError(asyncResp->res); 9938e31778eSAsmitha Karunanithi return; 9948e31778eSAsmitha Karunanithi } 9958e31778eSAsmitha Karunanithi tinyxml2::XMLElement* interfaceNode = 9968e31778eSAsmitha Karunanithi pRoot->FirstChildElement("interface"); 9978e31778eSAsmitha Karunanithi 9988e31778eSAsmitha Karunanithi bool isProgressIntfPresent = false; 9998e31778eSAsmitha Karunanithi while (interfaceNode != nullptr) 10008e31778eSAsmitha Karunanithi { 10018e31778eSAsmitha Karunanithi const char* thisInterfaceName = interfaceNode->Attribute("name"); 10028e31778eSAsmitha Karunanithi if (thisInterfaceName != nullptr) 10038e31778eSAsmitha Karunanithi { 10048e31778eSAsmitha Karunanithi if (thisInterfaceName == 10058e31778eSAsmitha Karunanithi std::string_view("xyz.openbmc_project.Common.Progress")) 10068e31778eSAsmitha Karunanithi { 10078e31778eSAsmitha Karunanithi interfaceNode = 10088e31778eSAsmitha Karunanithi interfaceNode->NextSiblingElement("interface"); 10098e31778eSAsmitha Karunanithi continue; 10108e31778eSAsmitha Karunanithi } 10118e31778eSAsmitha Karunanithi isProgressIntfPresent = true; 10128e31778eSAsmitha Karunanithi break; 10138e31778eSAsmitha Karunanithi } 10148e31778eSAsmitha Karunanithi interfaceNode = interfaceNode->NextSiblingElement("interface"); 10158e31778eSAsmitha Karunanithi } 10168e31778eSAsmitha Karunanithi 1017a43be80fSAsmitha Karunanithi std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 10188e31778eSAsmitha Karunanithi [createdObjPath, dumpEntryPath, dumpId, isProgressIntfPresent]( 10198b24275dSEd Tanous const boost::system::error_code& ec2, sdbusplus::message_t& msg, 1020a43be80fSAsmitha Karunanithi const std::shared_ptr<task::TaskData>& taskData) { 10218b24275dSEd Tanous if (ec2) 1022cb13a392SEd Tanous { 102362598e31SEd Tanous BMCWEB_LOG_ERROR("{}: Error in creating dump", 102462598e31SEd Tanous createdObjPath.str); 10258e31778eSAsmitha Karunanithi taskData->messages.emplace_back(messages::internalError()); 10266145ed6fSAsmitha Karunanithi taskData->state = "Cancelled"; 10276145ed6fSAsmitha Karunanithi return task::completed; 1028cb13a392SEd Tanous } 1029b9d36b47SEd Tanous 10308e31778eSAsmitha Karunanithi if (isProgressIntfPresent) 1031a43be80fSAsmitha Karunanithi { 10328e31778eSAsmitha Karunanithi dbus::utility::DBusPropertiesMap values; 10338e31778eSAsmitha Karunanithi std::string prop; 10348e31778eSAsmitha Karunanithi msg.read(prop, values); 10358e31778eSAsmitha Karunanithi 10368e31778eSAsmitha Karunanithi DumpCreationProgress dumpStatus = 10378e31778eSAsmitha Karunanithi getDumpCompletionStatus(values); 10388e31778eSAsmitha Karunanithi if (dumpStatus == DumpCreationProgress::DUMP_CREATE_FAILED) 10398e31778eSAsmitha Karunanithi { 104062598e31SEd Tanous BMCWEB_LOG_ERROR("{}: Error in creating dump", 104162598e31SEd Tanous createdObjPath.str); 10428e31778eSAsmitha Karunanithi taskData->state = "Cancelled"; 10438e31778eSAsmitha Karunanithi return task::completed; 10448e31778eSAsmitha Karunanithi } 10458e31778eSAsmitha Karunanithi 10468e31778eSAsmitha Karunanithi if (dumpStatus == DumpCreationProgress::DUMP_CREATE_INPROGRESS) 10478e31778eSAsmitha Karunanithi { 104862598e31SEd Tanous BMCWEB_LOG_DEBUG("{}: Dump creation task is in progress", 104962598e31SEd Tanous createdObjPath.str); 10508e31778eSAsmitha Karunanithi return !task::completed; 10518e31778eSAsmitha Karunanithi } 10528e31778eSAsmitha Karunanithi } 10538e31778eSAsmitha Karunanithi 1054a43be80fSAsmitha Karunanithi nlohmann::json retMessage = messages::success(); 1055a43be80fSAsmitha Karunanithi taskData->messages.emplace_back(retMessage); 1056a43be80fSAsmitha Karunanithi 1057c51a58eeSEd Tanous boost::urls::url url = boost::urls::format( 1058c51a58eeSEd Tanous "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/{}", dumpId); 1059c51a58eeSEd Tanous 1060c51a58eeSEd Tanous std::string headerLoc = "Location: "; 1061c51a58eeSEd Tanous headerLoc += url.buffer(); 1062c51a58eeSEd Tanous 1063002d39b4SEd Tanous taskData->payload->httpHeaders.emplace_back(std::move(headerLoc)); 1064a43be80fSAsmitha Karunanithi 106562598e31SEd Tanous BMCWEB_LOG_DEBUG("{}: Dump creation task completed", 106662598e31SEd Tanous createdObjPath.str); 1067a43be80fSAsmitha Karunanithi taskData->state = "Completed"; 1068b47452b2SAsmitha Karunanithi return task::completed; 1069a43be80fSAsmitha Karunanithi }, 10708e31778eSAsmitha Karunanithi "type='signal',interface='org.freedesktop.DBus.Properties'," 10718e31778eSAsmitha Karunanithi "member='PropertiesChanged',path='" + 10728e31778eSAsmitha Karunanithi createdObjPath.str + "'"); 1073a43be80fSAsmitha Karunanithi 10748e31778eSAsmitha Karunanithi // The task timer is set to max time limit within which the 10758e31778eSAsmitha Karunanithi // requested dump will be collected. 10768e31778eSAsmitha Karunanithi task->startTimer(std::chrono::minutes(6)); 1077a43be80fSAsmitha Karunanithi task->populateResp(asyncResp->res); 10788e31778eSAsmitha Karunanithi task->payload.emplace(payload); 10798e31778eSAsmitha Karunanithi }, 10808e31778eSAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", createdObjPath, 10818e31778eSAsmitha Karunanithi "org.freedesktop.DBus.Introspectable", "Introspect"); 1082a43be80fSAsmitha Karunanithi } 1083a43be80fSAsmitha Karunanithi 10848d1b46d7Szhanghch05 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 10858d1b46d7Szhanghch05 const crow::Request& req, const std::string& dumpType) 1086a43be80fSAsmitha Karunanithi { 1087fdd26906SClaire Weinan std::string dumpPath = getDumpEntriesPath(dumpType); 1088fdd26906SClaire Weinan if (dumpPath.empty()) 1089a43be80fSAsmitha Karunanithi { 1090a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 1091a43be80fSAsmitha Karunanithi return; 1092a43be80fSAsmitha Karunanithi } 1093a43be80fSAsmitha Karunanithi 1094a43be80fSAsmitha Karunanithi std::optional<std::string> diagnosticDataType; 1095a43be80fSAsmitha Karunanithi std::optional<std::string> oemDiagnosticDataType; 1096a43be80fSAsmitha Karunanithi 109715ed6780SWilly Tu if (!redfish::json_util::readJsonAction( 1098a43be80fSAsmitha Karunanithi req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 1099a43be80fSAsmitha Karunanithi "OEMDiagnosticDataType", oemDiagnosticDataType)) 1100a43be80fSAsmitha Karunanithi { 1101a43be80fSAsmitha Karunanithi return; 1102a43be80fSAsmitha Karunanithi } 1103a43be80fSAsmitha Karunanithi 1104a43be80fSAsmitha Karunanithi if (dumpType == "System") 1105a43be80fSAsmitha Karunanithi { 1106a43be80fSAsmitha Karunanithi if (!oemDiagnosticDataType || !diagnosticDataType) 1107a43be80fSAsmitha Karunanithi { 110862598e31SEd Tanous BMCWEB_LOG_ERROR( 110962598e31SEd Tanous "CreateDump action parameter 'DiagnosticDataType'/'OEMDiagnosticDataType' value not found!"); 1110a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 1111a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", 1112a43be80fSAsmitha Karunanithi "DiagnosticDataType & OEMDiagnosticDataType"); 1113a43be80fSAsmitha Karunanithi return; 1114a43be80fSAsmitha Karunanithi } 11153174e4dfSEd Tanous if ((*oemDiagnosticDataType != "System") || 1116a43be80fSAsmitha Karunanithi (*diagnosticDataType != "OEM")) 1117a43be80fSAsmitha Karunanithi { 111862598e31SEd Tanous BMCWEB_LOG_ERROR("Wrong parameter values passed"); 1119ace85d60SEd Tanous messages::internalError(asyncResp->res); 1120a43be80fSAsmitha Karunanithi return; 1121a43be80fSAsmitha Karunanithi } 11225907571dSAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/"; 1123a43be80fSAsmitha Karunanithi } 1124a43be80fSAsmitha Karunanithi else if (dumpType == "BMC") 1125a43be80fSAsmitha Karunanithi { 1126a43be80fSAsmitha Karunanithi if (!diagnosticDataType) 1127a43be80fSAsmitha Karunanithi { 112862598e31SEd Tanous BMCWEB_LOG_ERROR( 112962598e31SEd Tanous "CreateDump action parameter 'DiagnosticDataType' not found!"); 1130a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 1131a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType"); 1132a43be80fSAsmitha Karunanithi return; 1133a43be80fSAsmitha Karunanithi } 11343174e4dfSEd Tanous if (*diagnosticDataType != "Manager") 1135a43be80fSAsmitha Karunanithi { 113662598e31SEd Tanous BMCWEB_LOG_ERROR( 113762598e31SEd Tanous "Wrong parameter value passed for 'DiagnosticDataType'"); 1138ace85d60SEd Tanous messages::internalError(asyncResp->res); 1139a43be80fSAsmitha Karunanithi return; 1140a43be80fSAsmitha Karunanithi } 11415907571dSAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/"; 11425907571dSAsmitha Karunanithi } 11435907571dSAsmitha Karunanithi else 11445907571dSAsmitha Karunanithi { 114562598e31SEd Tanous BMCWEB_LOG_ERROR("CreateDump failed. Unknown dump type"); 11465907571dSAsmitha Karunanithi messages::internalError(asyncResp->res); 11475907571dSAsmitha Karunanithi return; 1148a43be80fSAsmitha Karunanithi } 1149a43be80fSAsmitha Karunanithi 11508e31778eSAsmitha Karunanithi std::vector<std::pair<std::string, std::variant<std::string, uint64_t>>> 11518e31778eSAsmitha Karunanithi createDumpParamVec; 11528e31778eSAsmitha Karunanithi 1153f574a8e1SCarson Labrado if (req.session != nullptr) 1154f574a8e1SCarson Labrado { 115568dd075aSAsmitha Karunanithi createDumpParamVec.emplace_back( 115668dd075aSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorId", 115768dd075aSAsmitha Karunanithi req.session->clientIp); 115868dd075aSAsmitha Karunanithi createDumpParamVec.emplace_back( 115968dd075aSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorType", 116068dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client"); 1161f574a8e1SCarson Labrado } 116268dd075aSAsmitha Karunanithi 1163a43be80fSAsmitha Karunanithi crow::connections::systemBus->async_method_call( 11645e7e2dc5SEd Tanous [asyncResp, payload(task::Payload(req)), 11655e7e2dc5SEd Tanous dumpPath](const boost::system::error_code& ec, 11665e7e2dc5SEd Tanous const sdbusplus::message_t& msg, 11678e31778eSAsmitha Karunanithi const sdbusplus::message::object_path& objPath) mutable { 1168a43be80fSAsmitha Karunanithi if (ec) 1169a43be80fSAsmitha Karunanithi { 117062598e31SEd Tanous BMCWEB_LOG_ERROR("CreateDump resp_handler got error {}", ec); 11715907571dSAsmitha Karunanithi const sd_bus_error* dbusError = msg.get_error(); 11725907571dSAsmitha Karunanithi if (dbusError == nullptr) 11735907571dSAsmitha Karunanithi { 11745907571dSAsmitha Karunanithi messages::internalError(asyncResp->res); 11755907571dSAsmitha Karunanithi return; 11765907571dSAsmitha Karunanithi } 11775907571dSAsmitha Karunanithi 117862598e31SEd Tanous BMCWEB_LOG_ERROR("CreateDump DBus error: {} and error msg: {}", 117962598e31SEd Tanous dbusError->name, dbusError->message); 11805907571dSAsmitha Karunanithi if (std::string_view( 11815907571dSAsmitha Karunanithi "xyz.openbmc_project.Common.Error.NotAllowed") == 11825907571dSAsmitha Karunanithi dbusError->name) 11835907571dSAsmitha Karunanithi { 11845907571dSAsmitha Karunanithi messages::resourceInStandby(asyncResp->res); 11855907571dSAsmitha Karunanithi return; 11865907571dSAsmitha Karunanithi } 11875907571dSAsmitha Karunanithi if (std::string_view( 11885907571dSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create.Error.Disabled") == 11895907571dSAsmitha Karunanithi dbusError->name) 11905907571dSAsmitha Karunanithi { 11915907571dSAsmitha Karunanithi messages::serviceDisabled(asyncResp->res, dumpPath); 11925907571dSAsmitha Karunanithi return; 11935907571dSAsmitha Karunanithi } 11945907571dSAsmitha Karunanithi if (std::string_view( 11955907571dSAsmitha Karunanithi "xyz.openbmc_project.Common.Error.Unavailable") == 11965907571dSAsmitha Karunanithi dbusError->name) 11975907571dSAsmitha Karunanithi { 11985907571dSAsmitha Karunanithi messages::resourceInUse(asyncResp->res); 11995907571dSAsmitha Karunanithi return; 12005907571dSAsmitha Karunanithi } 12015907571dSAsmitha Karunanithi // Other Dbus errors such as: 12025907571dSAsmitha Karunanithi // xyz.openbmc_project.Common.Error.InvalidArgument & 12035907571dSAsmitha Karunanithi // org.freedesktop.DBus.Error.InvalidArgs are all related to 12045907571dSAsmitha Karunanithi // the dbus call that is made here in the bmcweb 12055907571dSAsmitha Karunanithi // implementation and has nothing to do with the client's 12065907571dSAsmitha Karunanithi // input in the request. Hence, returning internal error 12075907571dSAsmitha Karunanithi // back to the client. 1208a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 1209a43be80fSAsmitha Karunanithi return; 1210a43be80fSAsmitha Karunanithi } 121162598e31SEd Tanous BMCWEB_LOG_DEBUG("Dump Created. Path: {}", objPath.str); 12128e31778eSAsmitha Karunanithi createDumpTaskCallback(std::move(payload), asyncResp, objPath); 1213a43be80fSAsmitha Karunanithi }, 121418f8f608SEd Tanous "xyz.openbmc_project.Dump.Manager", getDumpPath(dumpType), 12158e31778eSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create", "CreateDump", createDumpParamVec); 1216a43be80fSAsmitha Karunanithi } 1217a43be80fSAsmitha Karunanithi 12188d1b46d7Szhanghch05 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 12198d1b46d7Szhanghch05 const std::string& dumpType) 122080319af1SAsmitha Karunanithi { 12210d946211SClaire Weinan crow::connections::systemBus->async_method_call( 12220d946211SClaire Weinan [asyncResp](const boost::system::error_code& ec) { 122380319af1SAsmitha Karunanithi if (ec) 122480319af1SAsmitha Karunanithi { 122562598e31SEd Tanous BMCWEB_LOG_ERROR("clearDump resp_handler got error {}", ec); 122680319af1SAsmitha Karunanithi messages::internalError(asyncResp->res); 122780319af1SAsmitha Karunanithi return; 122880319af1SAsmitha Karunanithi } 12290d946211SClaire Weinan }, 123018f8f608SEd Tanous "xyz.openbmc_project.Dump.Manager", getDumpPath(dumpType), 12310d946211SClaire Weinan "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 123280319af1SAsmitha Karunanithi } 123380319af1SAsmitha Karunanithi 1234b9d36b47SEd Tanous inline static void 1235b9d36b47SEd Tanous parseCrashdumpParameters(const dbus::utility::DBusPropertiesMap& params, 1236b9d36b47SEd Tanous std::string& filename, std::string& timestamp, 1237b9d36b47SEd Tanous std::string& logfile) 1238043a0536SJohnathan Mantey { 1239d1bde9e5SKrzysztof Grobelny const std::string* filenamePtr = nullptr; 1240d1bde9e5SKrzysztof Grobelny const std::string* timestampPtr = nullptr; 1241d1bde9e5SKrzysztof Grobelny const std::string* logfilePtr = nullptr; 1242d1bde9e5SKrzysztof Grobelny 1243d1bde9e5SKrzysztof Grobelny const bool success = sdbusplus::unpackPropertiesNoThrow( 1244d1bde9e5SKrzysztof Grobelny dbus_utils::UnpackErrorPrinter(), params, "Timestamp", timestampPtr, 1245d1bde9e5SKrzysztof Grobelny "Filename", filenamePtr, "Log", logfilePtr); 1246d1bde9e5SKrzysztof Grobelny 1247d1bde9e5SKrzysztof Grobelny if (!success) 1248043a0536SJohnathan Mantey { 1249d1bde9e5SKrzysztof Grobelny return; 1250043a0536SJohnathan Mantey } 1251d1bde9e5SKrzysztof Grobelny 1252d1bde9e5SKrzysztof Grobelny if (filenamePtr != nullptr) 1253043a0536SJohnathan Mantey { 1254d1bde9e5SKrzysztof Grobelny filename = *filenamePtr; 1255d1bde9e5SKrzysztof Grobelny } 1256d1bde9e5SKrzysztof Grobelny 1257d1bde9e5SKrzysztof Grobelny if (timestampPtr != nullptr) 1258043a0536SJohnathan Mantey { 1259d1bde9e5SKrzysztof Grobelny timestamp = *timestampPtr; 1260043a0536SJohnathan Mantey } 1261d1bde9e5SKrzysztof Grobelny 1262d1bde9e5SKrzysztof Grobelny if (logfilePtr != nullptr) 1263043a0536SJohnathan Mantey { 1264d1bde9e5SKrzysztof Grobelny logfile = *logfilePtr; 1265043a0536SJohnathan Mantey } 1266043a0536SJohnathan Mantey } 1267043a0536SJohnathan Mantey 12687e860f15SJohn Edward Broadbent inline void requestRoutesSystemLogServiceCollection(App& app) 12691da66f75SEd Tanous { 1270c4bf6374SJason M. Bills /** 1271c4bf6374SJason M. Bills * Functions triggers appropriate requests on DBus 1272c4bf6374SJason M. Bills */ 127322d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/") 1274ed398213SEd Tanous .privileges(redfish::privileges::getLogServiceCollection) 1275002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1276002d39b4SEd Tanous [&app](const crow::Request& req, 127722d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 127822d268cbSEd Tanous const std::string& systemName) { 12793ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1280c4bf6374SJason M. Bills { 128145ca1b86SEd Tanous return; 128245ca1b86SEd Tanous } 12837f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 12847f3e84a1SEd Tanous { 12857f3e84a1SEd Tanous // Option currently returns no systems. TBD 12867f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 12877f3e84a1SEd Tanous systemName); 12887f3e84a1SEd Tanous return; 12897f3e84a1SEd Tanous } 129022d268cbSEd Tanous if (systemName != "system") 129122d268cbSEd Tanous { 129222d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 129322d268cbSEd Tanous systemName); 129422d268cbSEd Tanous return; 129522d268cbSEd Tanous } 129622d268cbSEd Tanous 12977e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 12987e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1299c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1300c4bf6374SJason M. Bills "#LogServiceCollection.LogServiceCollection"; 1301c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1302029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices"; 130345ca1b86SEd Tanous asyncResp->res.jsonValue["Name"] = "System Log Services Collection"; 1304c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 1305c4bf6374SJason M. Bills "Collection of LogServices for this Computer System"; 1306002d39b4SEd Tanous nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 1307c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 13081476687dSEd Tanous nlohmann::json::object_t eventLog; 13091476687dSEd Tanous eventLog["@odata.id"] = 13101476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 1311b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(eventLog)); 13125cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 13131476687dSEd Tanous nlohmann::json::object_t dumpLog; 1314002d39b4SEd Tanous dumpLog["@odata.id"] = "/redfish/v1/Systems/system/LogServices/Dump"; 1315b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(dumpLog)); 1316c9bb6861Sraviteja-b #endif 1317c9bb6861Sraviteja-b 1318d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG 13191476687dSEd Tanous nlohmann::json::object_t crashdump; 13201476687dSEd Tanous crashdump["@odata.id"] = 13211476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump"; 1322b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(crashdump)); 1323d53dd41fSJason M. Bills #endif 1324b7028ebfSSpencer Ku 1325b7028ebfSSpencer Ku #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER 13261476687dSEd Tanous nlohmann::json::object_t hostlogger; 13271476687dSEd Tanous hostlogger["@odata.id"] = 13281476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger"; 1329b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(hostlogger)); 1330b7028ebfSSpencer Ku #endif 1331c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 1332c4bf6374SJason M. Bills logServiceArray.size(); 1333a3316fc6SZhikuiRen 13347a1dbc48SGeorge Liu constexpr std::array<std::string_view, 1> interfaces = { 13357a1dbc48SGeorge Liu "xyz.openbmc_project.State.Boot.PostCode"}; 13367a1dbc48SGeorge Liu dbus::utility::getSubTreePaths( 13377a1dbc48SGeorge Liu "/", 0, interfaces, 13387a1dbc48SGeorge Liu [asyncResp](const boost::system::error_code& ec, 1339b9d36b47SEd Tanous const dbus::utility::MapperGetSubTreePathsResponse& 1340b9d36b47SEd Tanous subtreePath) { 1341a3316fc6SZhikuiRen if (ec) 1342a3316fc6SZhikuiRen { 134362598e31SEd Tanous BMCWEB_LOG_ERROR("{}", ec); 1344a3316fc6SZhikuiRen return; 1345a3316fc6SZhikuiRen } 1346a3316fc6SZhikuiRen 134755f79e6fSEd Tanous for (const auto& pathStr : subtreePath) 1348a3316fc6SZhikuiRen { 1349a3316fc6SZhikuiRen if (pathStr.find("PostCode") != std::string::npos) 1350a3316fc6SZhikuiRen { 135123a21a1cSEd Tanous nlohmann::json& logServiceArrayLocal = 1352a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"]; 1353613dabeaSEd Tanous nlohmann::json::object_t member; 1354613dabeaSEd Tanous member["@odata.id"] = 1355613dabeaSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes"; 1356613dabeaSEd Tanous 1357b2ba3072SPatrick Williams logServiceArrayLocal.emplace_back(std::move(member)); 1358613dabeaSEd Tanous 135945ca1b86SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = 136023a21a1cSEd Tanous logServiceArrayLocal.size(); 1361a3316fc6SZhikuiRen return; 1362a3316fc6SZhikuiRen } 1363a3316fc6SZhikuiRen } 13647a1dbc48SGeorge Liu }); 13657e860f15SJohn Edward Broadbent }); 1366c4bf6374SJason M. Bills } 1367c4bf6374SJason M. Bills 13687e860f15SJohn Edward Broadbent inline void requestRoutesEventLogService(App& app) 1369c4bf6374SJason M. Bills { 137022d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/") 1371ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 1372002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1373002d39b4SEd Tanous [&app](const crow::Request& req, 137422d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 137522d268cbSEd Tanous const std::string& systemName) { 13763ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 137745ca1b86SEd Tanous { 137845ca1b86SEd Tanous return; 137945ca1b86SEd Tanous } 138022d268cbSEd Tanous if (systemName != "system") 138122d268cbSEd Tanous { 138222d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 138322d268cbSEd Tanous systemName); 138422d268cbSEd Tanous return; 138522d268cbSEd Tanous } 1386c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1387029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 1388c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1389b25644a1SJanet Adkins "#LogService.v1_2_0.LogService"; 1390c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "Event Log Service"; 1391002d39b4SEd Tanous asyncResp->res.jsonValue["Description"] = "System Event Log Service"; 1392c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "EventLog"; 1393c4bf6374SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 13947c8c4058STejas Patil 13957c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 13962b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 13977c8c4058STejas Patil 13987c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 13997c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 14007c8c4058STejas Patil redfishDateTimeOffset.second; 14017c8c4058STejas Patil 14021476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 14031476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1404e7d6c8b2SGunnar Mills asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 1405e7d6c8b2SGunnar Mills 14060fda0f12SGeorge Liu {"target", 14070fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog"}}; 14087e860f15SJohn Edward Broadbent }); 1409489640c6SJason M. Bills } 1410489640c6SJason M. Bills 14117e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogClear(App& app) 1412489640c6SJason M. Bills { 14134978b63fSJason M. Bills BMCWEB_ROUTE( 14144978b63fSJason M. Bills app, 141522d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/") 1416432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 14177e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 141845ca1b86SEd Tanous [&app](const crow::Request& req, 141922d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 142022d268cbSEd Tanous const std::string& systemName) { 14213ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 142245ca1b86SEd Tanous { 142345ca1b86SEd Tanous return; 142445ca1b86SEd Tanous } 142522d268cbSEd Tanous if (systemName != "system") 142622d268cbSEd Tanous { 142722d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 142822d268cbSEd Tanous systemName); 142922d268cbSEd Tanous return; 143022d268cbSEd Tanous } 1431489640c6SJason M. Bills // Clear the EventLog by deleting the log files 1432489640c6SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1433489640c6SJason M. Bills if (getRedfishLogFiles(redfishLogFiles)) 1434489640c6SJason M. Bills { 1435489640c6SJason M. Bills for (const std::filesystem::path& file : redfishLogFiles) 1436489640c6SJason M. Bills { 1437489640c6SJason M. Bills std::error_code ec; 1438489640c6SJason M. Bills std::filesystem::remove(file, ec); 1439489640c6SJason M. Bills } 1440489640c6SJason M. Bills } 1441489640c6SJason M. Bills 1442489640c6SJason M. Bills // Reload rsyslog so it knows to start new log files 1443489640c6SJason M. Bills crow::connections::systemBus->async_method_call( 14445e7e2dc5SEd Tanous [asyncResp](const boost::system::error_code& ec) { 1445489640c6SJason M. Bills if (ec) 1446489640c6SJason M. Bills { 144762598e31SEd Tanous BMCWEB_LOG_ERROR("Failed to reload rsyslog: {}", ec); 1448489640c6SJason M. Bills messages::internalError(asyncResp->res); 1449489640c6SJason M. Bills return; 1450489640c6SJason M. Bills } 1451489640c6SJason M. Bills 1452489640c6SJason M. Bills messages::success(asyncResp->res); 1453489640c6SJason M. Bills }, 1454489640c6SJason M. Bills "org.freedesktop.systemd1", "/org/freedesktop/systemd1", 1455002d39b4SEd Tanous "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service", 1456002d39b4SEd Tanous "replace"); 14577e860f15SJohn Edward Broadbent }); 1458c4bf6374SJason M. Bills } 1459c4bf6374SJason M. Bills 1460ac992cdeSJason M. Bills enum class LogParseError 1461ac992cdeSJason M. Bills { 1462ac992cdeSJason M. Bills success, 1463ac992cdeSJason M. Bills parseFailed, 1464ac992cdeSJason M. Bills messageIdNotInRegistry, 1465ac992cdeSJason M. Bills }; 1466ac992cdeSJason M. Bills 1467ac992cdeSJason M. Bills static LogParseError 1468ac992cdeSJason M. Bills fillEventLogEntryJson(const std::string& logEntryID, 1469b5a76932SEd Tanous const std::string& logEntry, 1470de703c5dSJason M. Bills nlohmann::json::object_t& logEntryJson) 1471c4bf6374SJason M. Bills { 147295820184SJason M. Bills // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1473cd225da8SJason M. Bills // First get the Timestamp 1474f23b7296SEd Tanous size_t space = logEntry.find_first_of(' '); 1475cd225da8SJason M. Bills if (space == std::string::npos) 147695820184SJason M. Bills { 1477ac992cdeSJason M. Bills return LogParseError::parseFailed; 147895820184SJason M. Bills } 1479cd225da8SJason M. Bills std::string timestamp = logEntry.substr(0, space); 1480cd225da8SJason M. Bills // Then get the log contents 1481f23b7296SEd Tanous size_t entryStart = logEntry.find_first_not_of(' ', space); 1482cd225da8SJason M. Bills if (entryStart == std::string::npos) 1483cd225da8SJason M. Bills { 1484ac992cdeSJason M. Bills return LogParseError::parseFailed; 1485cd225da8SJason M. Bills } 1486cd225da8SJason M. Bills std::string_view entry(logEntry); 1487cd225da8SJason M. Bills entry.remove_prefix(entryStart); 1488cd225da8SJason M. Bills // Use split to separate the entry into its fields 1489cd225da8SJason M. Bills std::vector<std::string> logEntryFields; 149050ebd4afSEd Tanous bmcweb::split(logEntryFields, entry, ','); 1491cd225da8SJason M. Bills // We need at least a MessageId to be valid 14921e6deaf6SEd Tanous auto logEntryIter = logEntryFields.begin(); 14931e6deaf6SEd Tanous if (logEntryIter == logEntryFields.end()) 1494cd225da8SJason M. Bills { 1495ac992cdeSJason M. Bills return LogParseError::parseFailed; 1496cd225da8SJason M. Bills } 14971e6deaf6SEd Tanous std::string& messageID = *logEntryIter; 14984851d45dSJason M. Bills // Get the Message from the MessageRegistry 1499fffb8c1fSEd Tanous const registries::Message* message = registries::getMessage(messageID); 1500c4bf6374SJason M. Bills 15011e6deaf6SEd Tanous logEntryIter++; 150254417b02SSui Chen if (message == nullptr) 1503c4bf6374SJason M. Bills { 150462598e31SEd Tanous BMCWEB_LOG_WARNING("Log entry not found in registry: {}", logEntry); 1505ac992cdeSJason M. Bills return LogParseError::messageIdNotInRegistry; 1506c4bf6374SJason M. Bills } 1507c4bf6374SJason M. Bills 15081e6deaf6SEd Tanous std::vector<std::string_view> messageArgs(logEntryIter, 15091e6deaf6SEd Tanous logEntryFields.end()); 1510c05bba45SEd Tanous messageArgs.resize(message->numberOfArgs); 1511c05bba45SEd Tanous 15121e6deaf6SEd Tanous std::string msg = redfish::registries::fillMessageArgs(messageArgs, 15131e6deaf6SEd Tanous message->message); 15141e6deaf6SEd Tanous if (msg.empty()) 151515a86ff6SJason M. Bills { 15161e6deaf6SEd Tanous return LogParseError::parseFailed; 151715a86ff6SJason M. Bills } 15184851d45dSJason M. Bills 151995820184SJason M. Bills // Get the Created time from the timestamp. The log timestamp is in RFC3339 152095820184SJason M. Bills // format which matches the Redfish format except for the fractional seconds 152195820184SJason M. Bills // between the '.' and the '+', so just remove them. 1522f23b7296SEd Tanous std::size_t dot = timestamp.find_first_of('.'); 1523f23b7296SEd Tanous std::size_t plus = timestamp.find_first_of('+'); 152495820184SJason M. Bills if (dot != std::string::npos && plus != std::string::npos) 1525c4bf6374SJason M. Bills { 152695820184SJason M. Bills timestamp.erase(dot, plus - dot); 1527c4bf6374SJason M. Bills } 1528c4bf6374SJason M. Bills 1529c4bf6374SJason M. Bills // Fill in the log entry with the gathered data 15309c11a172SVijay Lobo logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 1531ef4c65b7SEd Tanous logEntryJson["@odata.id"] = boost::urls::format( 1532ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}", 1533ef4c65b7SEd Tanous logEntryID); 153484afc48bSJason M. Bills logEntryJson["Name"] = "System Event Log Entry"; 153584afc48bSJason M. Bills logEntryJson["Id"] = logEntryID; 153684afc48bSJason M. Bills logEntryJson["Message"] = std::move(msg); 153784afc48bSJason M. Bills logEntryJson["MessageId"] = std::move(messageID); 153884afc48bSJason M. Bills logEntryJson["MessageArgs"] = messageArgs; 153984afc48bSJason M. Bills logEntryJson["EntryType"] = "Event"; 154084afc48bSJason M. Bills logEntryJson["Severity"] = message->messageSeverity; 154184afc48bSJason M. Bills logEntryJson["Created"] = std::move(timestamp); 1542ac992cdeSJason M. Bills return LogParseError::success; 1543c4bf6374SJason M. Bills } 1544c4bf6374SJason M. Bills 15457e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntryCollection(App& app) 1546c4bf6374SJason M. Bills { 154722d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/") 15488b6a35f0SGunnar Mills .privileges(redfish::privileges::getLogEntryCollection) 1549002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1550002d39b4SEd Tanous [&app](const crow::Request& req, 155122d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 155222d268cbSEd Tanous const std::string& systemName) { 1553c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 1554c937d2bfSEd Tanous .canDelegateTop = true, 1555c937d2bfSEd Tanous .canDelegateSkip = true, 1556c937d2bfSEd Tanous }; 1557c937d2bfSEd Tanous query_param::Query delegatedQuery; 1558c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 15593ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 1560c4bf6374SJason M. Bills { 1561c4bf6374SJason M. Bills return; 1562c4bf6374SJason M. Bills } 15637f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 15647f3e84a1SEd Tanous { 15657f3e84a1SEd Tanous // Option currently returns no systems. TBD 15667f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 15677f3e84a1SEd Tanous systemName); 15687f3e84a1SEd Tanous return; 15697f3e84a1SEd Tanous } 157022d268cbSEd Tanous if (systemName != "system") 157122d268cbSEd Tanous { 157222d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 157322d268cbSEd Tanous systemName); 157422d268cbSEd Tanous return; 157522d268cbSEd Tanous } 157622d268cbSEd Tanous 15775143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 15783648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 15793648c8beSEd Tanous 15807e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 15817e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1582c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1583c4bf6374SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 1584c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1585029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1586c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 1587c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 1588c4bf6374SJason M. Bills "Collection of System Event Log Entries"; 1589cb92c03bSAndrew Geissler 15904978b63fSJason M. Bills nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1591c4bf6374SJason M. Bills logEntryArray = nlohmann::json::array(); 15927e860f15SJohn Edward Broadbent // Go through the log files and create a unique ID for each 15937e860f15SJohn Edward Broadbent // entry 159495820184SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 159595820184SJason M. Bills getRedfishLogFiles(redfishLogFiles); 1596b01bf299SEd Tanous uint64_t entryCount = 0; 1597cd225da8SJason M. Bills std::string logEntry; 159895820184SJason M. Bills 15997e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 16007e860f15SJohn Edward Broadbent // backwards 1601002d39b4SEd Tanous for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1602002d39b4SEd Tanous it++) 1603c4bf6374SJason M. Bills { 1604cd225da8SJason M. Bills std::ifstream logStream(*it); 160595820184SJason M. Bills if (!logStream.is_open()) 1606c4bf6374SJason M. Bills { 1607c4bf6374SJason M. Bills continue; 1608c4bf6374SJason M. Bills } 1609c4bf6374SJason M. Bills 1610e85d6b16SJason M. Bills // Reset the unique ID on the first entry 1611e85d6b16SJason M. Bills bool firstEntry = true; 161295820184SJason M. Bills while (std::getline(logStream, logEntry)) 161395820184SJason M. Bills { 1614c4bf6374SJason M. Bills std::string idStr; 1615e85d6b16SJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1616c4bf6374SJason M. Bills { 1617c4bf6374SJason M. Bills continue; 1618c4bf6374SJason M. Bills } 1619e85d6b16SJason M. Bills firstEntry = false; 1620e85d6b16SJason M. Bills 1621de703c5dSJason M. Bills nlohmann::json::object_t bmcLogEntry; 162289492a15SPatrick Williams LogParseError status = fillEventLogEntryJson(idStr, logEntry, 162389492a15SPatrick Williams bmcLogEntry); 1624ac992cdeSJason M. Bills if (status == LogParseError::messageIdNotInRegistry) 1625ac992cdeSJason M. Bills { 1626ac992cdeSJason M. Bills continue; 1627ac992cdeSJason M. Bills } 1628ac992cdeSJason M. Bills if (status != LogParseError::success) 1629c4bf6374SJason M. Bills { 1630c4bf6374SJason M. Bills messages::internalError(asyncResp->res); 1631c4bf6374SJason M. Bills return; 1632c4bf6374SJason M. Bills } 1633de703c5dSJason M. Bills 1634de703c5dSJason M. Bills entryCount++; 1635de703c5dSJason M. Bills // Handle paging using skip (number of entries to skip from the 1636de703c5dSJason M. Bills // start) and top (number of entries to display) 16373648c8beSEd Tanous if (entryCount <= skip || entryCount > skip + top) 1638de703c5dSJason M. Bills { 1639de703c5dSJason M. Bills continue; 1640de703c5dSJason M. Bills } 1641de703c5dSJason M. Bills 1642b2ba3072SPatrick Williams logEntryArray.emplace_back(std::move(bmcLogEntry)); 1643c4bf6374SJason M. Bills } 164495820184SJason M. Bills } 1645c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 16463648c8beSEd Tanous if (skip + top < entryCount) 1647c4bf6374SJason M. Bills { 1648c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 16494978b63fSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries?$skip=" + 16503648c8beSEd Tanous std::to_string(skip + top); 1651c4bf6374SJason M. Bills } 16527e860f15SJohn Edward Broadbent }); 1653897967deSJason M. Bills } 1654897967deSJason M. Bills 16557e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntry(App& app) 1656897967deSJason M. Bills { 16577e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 165822d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 1659ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 16607e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 166145ca1b86SEd Tanous [&app](const crow::Request& req, 16627e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 166322d268cbSEd Tanous const std::string& systemName, const std::string& param) { 16643ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 166545ca1b86SEd Tanous { 166645ca1b86SEd Tanous return; 166745ca1b86SEd Tanous } 16687f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 16697f3e84a1SEd Tanous { 16707f3e84a1SEd Tanous // Option currently returns no systems. TBD 16717f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 16727f3e84a1SEd Tanous systemName); 16737f3e84a1SEd Tanous return; 16747f3e84a1SEd Tanous } 167522d268cbSEd Tanous 167622d268cbSEd Tanous if (systemName != "system") 167722d268cbSEd Tanous { 167822d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 167922d268cbSEd Tanous systemName); 168022d268cbSEd Tanous return; 168122d268cbSEd Tanous } 168222d268cbSEd Tanous 16837e860f15SJohn Edward Broadbent const std::string& targetID = param; 16848d1b46d7Szhanghch05 16857e860f15SJohn Edward Broadbent // Go through the log files and check the unique ID for each 16867e860f15SJohn Edward Broadbent // entry to find the target entry 1687897967deSJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1688897967deSJason M. Bills getRedfishLogFiles(redfishLogFiles); 1689897967deSJason M. Bills std::string logEntry; 1690897967deSJason M. Bills 16917e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 16927e860f15SJohn Edward Broadbent // backwards 1693002d39b4SEd Tanous for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1694002d39b4SEd Tanous it++) 1695897967deSJason M. Bills { 1696897967deSJason M. Bills std::ifstream logStream(*it); 1697897967deSJason M. Bills if (!logStream.is_open()) 1698897967deSJason M. Bills { 1699897967deSJason M. Bills continue; 1700897967deSJason M. Bills } 1701897967deSJason M. Bills 1702897967deSJason M. Bills // Reset the unique ID on the first entry 1703897967deSJason M. Bills bool firstEntry = true; 1704897967deSJason M. Bills while (std::getline(logStream, logEntry)) 1705897967deSJason M. Bills { 1706897967deSJason M. Bills std::string idStr; 1707897967deSJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1708897967deSJason M. Bills { 1709897967deSJason M. Bills continue; 1710897967deSJason M. Bills } 1711897967deSJason M. Bills firstEntry = false; 1712897967deSJason M. Bills 1713897967deSJason M. Bills if (idStr == targetID) 1714897967deSJason M. Bills { 1715de703c5dSJason M. Bills nlohmann::json::object_t bmcLogEntry; 1716ac992cdeSJason M. Bills LogParseError status = 1717ac992cdeSJason M. Bills fillEventLogEntryJson(idStr, logEntry, bmcLogEntry); 1718ac992cdeSJason M. Bills if (status != LogParseError::success) 1719897967deSJason M. Bills { 1720897967deSJason M. Bills messages::internalError(asyncResp->res); 1721897967deSJason M. Bills return; 1722897967deSJason M. Bills } 1723d405bb51SJason M. Bills asyncResp->res.jsonValue.update(bmcLogEntry); 1724897967deSJason M. Bills return; 1725897967deSJason M. Bills } 1726897967deSJason M. Bills } 1727897967deSJason M. Bills } 1728897967deSJason M. Bills // Requested ID was not found 17299db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", targetID); 17307e860f15SJohn Edward Broadbent }); 173108a4e4b5SAnthony Wilson } 173208a4e4b5SAnthony Wilson 17337e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryCollection(App& app) 173408a4e4b5SAnthony Wilson { 173522d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/") 1736ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 1737002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1738002d39b4SEd Tanous [&app](const crow::Request& req, 173922d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 174022d268cbSEd Tanous const std::string& systemName) { 17413ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 174245ca1b86SEd Tanous { 174345ca1b86SEd Tanous return; 174445ca1b86SEd Tanous } 17457f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 17467f3e84a1SEd Tanous { 17477f3e84a1SEd Tanous // Option currently returns no systems. TBD 17487f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 17497f3e84a1SEd Tanous systemName); 17507f3e84a1SEd Tanous return; 17517f3e84a1SEd Tanous } 175222d268cbSEd Tanous if (systemName != "system") 175322d268cbSEd Tanous { 175422d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 175522d268cbSEd Tanous systemName); 175622d268cbSEd Tanous return; 175722d268cbSEd Tanous } 175822d268cbSEd Tanous 17597e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 17607e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 176108a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.type"] = 176208a4e4b5SAnthony Wilson "#LogEntryCollection.LogEntryCollection"; 176308a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.id"] = 176408a4e4b5SAnthony Wilson "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 176508a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 176608a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Description"] = 176708a4e4b5SAnthony Wilson "Collection of System Event Log Entries"; 176808a4e4b5SAnthony Wilson 1769cb92c03bSAndrew Geissler // DBus implementation of EventLog/Entries 1770cb92c03bSAndrew Geissler // Make call to Logging Service to find all log entry objects 17715eb468daSGeorge Liu sdbusplus::message::object_path path("/xyz/openbmc_project/logging"); 17725eb468daSGeorge Liu dbus::utility::getManagedObjects( 17735eb468daSGeorge Liu "xyz.openbmc_project.Logging", path, 17745e7e2dc5SEd Tanous [asyncResp](const boost::system::error_code& ec, 1775914e2d5dSEd Tanous const dbus::utility::ManagedObjectType& resp) { 1776cb92c03bSAndrew Geissler if (ec) 1777cb92c03bSAndrew Geissler { 1778cb92c03bSAndrew Geissler // TODO Handle for specific error code 177962598e31SEd Tanous BMCWEB_LOG_ERROR( 178062598e31SEd Tanous "getLogEntriesIfaceData resp_handler got error {}", ec); 1781cb92c03bSAndrew Geissler messages::internalError(asyncResp->res); 1782cb92c03bSAndrew Geissler return; 1783cb92c03bSAndrew Geissler } 17843544d2a7SEd Tanous nlohmann::json::array_t entriesArray; 17859eb808c1SEd Tanous for (const auto& objectPath : resp) 1786cb92c03bSAndrew Geissler { 1787914e2d5dSEd Tanous const uint32_t* id = nullptr; 1788c419c759SEd Tanous const uint64_t* timestamp = nullptr; 1789c419c759SEd Tanous const uint64_t* updateTimestamp = nullptr; 1790914e2d5dSEd Tanous const std::string* severity = nullptr; 1791914e2d5dSEd Tanous const std::string* message = nullptr; 1792914e2d5dSEd Tanous const std::string* filePath = nullptr; 17939c11a172SVijay Lobo const std::string* resolution = nullptr; 179475710de2SXiaochao Ma bool resolved = false; 17959017faf2SAbhishek Patel const std::string* notify = nullptr; 17969017faf2SAbhishek Patel 17979eb808c1SEd Tanous for (const auto& interfaceMap : objectPath.second) 1798f86bb901SAdriana Kobylak { 1799f86bb901SAdriana Kobylak if (interfaceMap.first == 1800f86bb901SAdriana Kobylak "xyz.openbmc_project.Logging.Entry") 1801f86bb901SAdriana Kobylak { 1802002d39b4SEd Tanous for (const auto& propertyMap : interfaceMap.second) 1803cb92c03bSAndrew Geissler { 1804cb92c03bSAndrew Geissler if (propertyMap.first == "Id") 1805cb92c03bSAndrew Geissler { 1806002d39b4SEd Tanous id = std::get_if<uint32_t>(&propertyMap.second); 1807cb92c03bSAndrew Geissler } 1808cb92c03bSAndrew Geissler else if (propertyMap.first == "Timestamp") 1809cb92c03bSAndrew Geissler { 1810002d39b4SEd Tanous timestamp = 1811002d39b4SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 18127e860f15SJohn Edward Broadbent } 1813002d39b4SEd Tanous else if (propertyMap.first == "UpdateTimestamp") 18147e860f15SJohn Edward Broadbent { 1815002d39b4SEd Tanous updateTimestamp = 1816002d39b4SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 18177e860f15SJohn Edward Broadbent } 18187e860f15SJohn Edward Broadbent else if (propertyMap.first == "Severity") 18197e860f15SJohn Edward Broadbent { 18207e860f15SJohn Edward Broadbent severity = std::get_if<std::string>( 18217e860f15SJohn Edward Broadbent &propertyMap.second); 18227e860f15SJohn Edward Broadbent } 18239c11a172SVijay Lobo else if (propertyMap.first == "Resolution") 18249c11a172SVijay Lobo { 18259c11a172SVijay Lobo resolution = std::get_if<std::string>( 18269c11a172SVijay Lobo &propertyMap.second); 18279c11a172SVijay Lobo } 18287e860f15SJohn Edward Broadbent else if (propertyMap.first == "Message") 18297e860f15SJohn Edward Broadbent { 18307e860f15SJohn Edward Broadbent message = std::get_if<std::string>( 18317e860f15SJohn Edward Broadbent &propertyMap.second); 18327e860f15SJohn Edward Broadbent } 18337e860f15SJohn Edward Broadbent else if (propertyMap.first == "Resolved") 18347e860f15SJohn Edward Broadbent { 1835914e2d5dSEd Tanous const bool* resolveptr = 1836002d39b4SEd Tanous std::get_if<bool>(&propertyMap.second); 18377e860f15SJohn Edward Broadbent if (resolveptr == nullptr) 18387e860f15SJohn Edward Broadbent { 1839002d39b4SEd Tanous messages::internalError(asyncResp->res); 18407e860f15SJohn Edward Broadbent return; 18417e860f15SJohn Edward Broadbent } 18427e860f15SJohn Edward Broadbent resolved = *resolveptr; 18437e860f15SJohn Edward Broadbent } 18449017faf2SAbhishek Patel else if (propertyMap.first == 18459017faf2SAbhishek Patel "ServiceProviderNotify") 18469017faf2SAbhishek Patel { 18479017faf2SAbhishek Patel notify = std::get_if<std::string>( 18489017faf2SAbhishek Patel &propertyMap.second); 18499017faf2SAbhishek Patel if (notify == nullptr) 18509017faf2SAbhishek Patel { 18519017faf2SAbhishek Patel messages::internalError(asyncResp->res); 18529017faf2SAbhishek Patel return; 18539017faf2SAbhishek Patel } 18549017faf2SAbhishek Patel } 18557e860f15SJohn Edward Broadbent } 18567e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 18577e860f15SJohn Edward Broadbent severity == nullptr) 18587e860f15SJohn Edward Broadbent { 18597e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 18607e860f15SJohn Edward Broadbent return; 18617e860f15SJohn Edward Broadbent } 18627e860f15SJohn Edward Broadbent } 18637e860f15SJohn Edward Broadbent else if (interfaceMap.first == 18647e860f15SJohn Edward Broadbent "xyz.openbmc_project.Common.FilePath") 18657e860f15SJohn Edward Broadbent { 1866002d39b4SEd Tanous for (const auto& propertyMap : interfaceMap.second) 18677e860f15SJohn Edward Broadbent { 18687e860f15SJohn Edward Broadbent if (propertyMap.first == "Path") 18697e860f15SJohn Edward Broadbent { 18707e860f15SJohn Edward Broadbent filePath = std::get_if<std::string>( 18717e860f15SJohn Edward Broadbent &propertyMap.second); 18727e860f15SJohn Edward Broadbent } 18737e860f15SJohn Edward Broadbent } 18747e860f15SJohn Edward Broadbent } 18757e860f15SJohn Edward Broadbent } 18767e860f15SJohn Edward Broadbent // Object path without the 18777e860f15SJohn Edward Broadbent // xyz.openbmc_project.Logging.Entry interface, ignore 18787e860f15SJohn Edward Broadbent // and continue. 18797e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 1880c419c759SEd Tanous severity == nullptr || timestamp == nullptr || 1881c419c759SEd Tanous updateTimestamp == nullptr) 18827e860f15SJohn Edward Broadbent { 18837e860f15SJohn Edward Broadbent continue; 18847e860f15SJohn Edward Broadbent } 18853544d2a7SEd Tanous nlohmann::json& thisEntry = entriesArray.emplace_back(); 18869c11a172SVijay Lobo thisEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 1887ef4c65b7SEd Tanous thisEntry["@odata.id"] = boost::urls::format( 1888ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}", 1889ef4c65b7SEd Tanous std::to_string(*id)); 18907e860f15SJohn Edward Broadbent thisEntry["Name"] = "System Event Log Entry"; 18917e860f15SJohn Edward Broadbent thisEntry["Id"] = std::to_string(*id); 18927e860f15SJohn Edward Broadbent thisEntry["Message"] = *message; 18937e860f15SJohn Edward Broadbent thisEntry["Resolved"] = resolved; 18949c11a172SVijay Lobo if ((resolution != nullptr) && (!(*resolution).empty())) 18959c11a172SVijay Lobo { 18969c11a172SVijay Lobo thisEntry["Resolution"] = *resolution; 18979c11a172SVijay Lobo } 18989017faf2SAbhishek Patel std::optional<bool> notifyAction = 18999017faf2SAbhishek Patel getProviderNotifyAction(*notify); 19009017faf2SAbhishek Patel if (notifyAction) 19019017faf2SAbhishek Patel { 19029017faf2SAbhishek Patel thisEntry["ServiceProviderNotified"] = *notifyAction; 19039017faf2SAbhishek Patel } 19047e860f15SJohn Edward Broadbent thisEntry["EntryType"] = "Event"; 19057e860f15SJohn Edward Broadbent thisEntry["Severity"] = 19067e860f15SJohn Edward Broadbent translateSeverityDbusToRedfish(*severity); 19077e860f15SJohn Edward Broadbent thisEntry["Created"] = 19082b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*timestamp); 19097e860f15SJohn Edward Broadbent thisEntry["Modified"] = 19102b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 19117e860f15SJohn Edward Broadbent if (filePath != nullptr) 19127e860f15SJohn Edward Broadbent { 19137e860f15SJohn Edward Broadbent thisEntry["AdditionalDataURI"] = 19140fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 19157e860f15SJohn Edward Broadbent std::to_string(*id) + "/attachment"; 19167e860f15SJohn Edward Broadbent } 19177e860f15SJohn Edward Broadbent } 19183544d2a7SEd Tanous std::ranges::sort(entriesArray, [](const nlohmann::json& left, 19193544d2a7SEd Tanous const nlohmann::json& right) { 19207e860f15SJohn Edward Broadbent return (left["Id"] <= right["Id"]); 19217e860f15SJohn Edward Broadbent }); 19227e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members@odata.count"] = 19237e860f15SJohn Edward Broadbent entriesArray.size(); 19243544d2a7SEd Tanous asyncResp->res.jsonValue["Members"] = std::move(entriesArray); 19255eb468daSGeorge Liu }); 19267e860f15SJohn Edward Broadbent }); 19277e860f15SJohn Edward Broadbent } 19287e860f15SJohn Edward Broadbent 19297e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app) 19307e860f15SJohn Edward Broadbent { 19317e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 193222d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 1933ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 1934002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1935002d39b4SEd Tanous [&app](const crow::Request& req, 19367e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 193722d268cbSEd Tanous const std::string& systemName, const std::string& param) { 19383ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 19397e860f15SJohn Edward Broadbent { 194045ca1b86SEd Tanous return; 194145ca1b86SEd Tanous } 19427f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 19437f3e84a1SEd Tanous { 19447f3e84a1SEd Tanous // Option currently returns no systems. TBD 19457f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 19467f3e84a1SEd Tanous systemName); 19477f3e84a1SEd Tanous return; 19487f3e84a1SEd Tanous } 194922d268cbSEd Tanous if (systemName != "system") 195022d268cbSEd Tanous { 195122d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 195222d268cbSEd Tanous systemName); 195322d268cbSEd Tanous return; 195422d268cbSEd Tanous } 195522d268cbSEd Tanous 19567e860f15SJohn Edward Broadbent std::string entryID = param; 19577e860f15SJohn Edward Broadbent dbus::utility::escapePathForDbus(entryID); 19587e860f15SJohn Edward Broadbent 19597e860f15SJohn Edward Broadbent // DBus implementation of EventLog/Entries 19607e860f15SJohn Edward Broadbent // Make call to Logging Service to find all log entry objects 1961d1bde9e5SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 1962d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, "xyz.openbmc_project.Logging", 1963d1bde9e5SKrzysztof Grobelny "/xyz/openbmc_project/logging/entry/" + entryID, "", 19645e7e2dc5SEd Tanous [asyncResp, entryID](const boost::system::error_code& ec, 1965b9d36b47SEd Tanous const dbus::utility::DBusPropertiesMap& resp) { 19667e860f15SJohn Edward Broadbent if (ec.value() == EBADR) 19677e860f15SJohn Edward Broadbent { 1968d1bde9e5SKrzysztof Grobelny messages::resourceNotFound(asyncResp->res, "EventLogEntry", 1969d1bde9e5SKrzysztof Grobelny entryID); 19707e860f15SJohn Edward Broadbent return; 19717e860f15SJohn Edward Broadbent } 19727e860f15SJohn Edward Broadbent if (ec) 19737e860f15SJohn Edward Broadbent { 197462598e31SEd Tanous BMCWEB_LOG_ERROR( 197562598e31SEd Tanous "EventLogEntry (DBus) resp_handler got error {}", ec); 19767e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 19777e860f15SJohn Edward Broadbent return; 19787e860f15SJohn Edward Broadbent } 1979914e2d5dSEd Tanous const uint32_t* id = nullptr; 1980c419c759SEd Tanous const uint64_t* timestamp = nullptr; 1981c419c759SEd Tanous const uint64_t* updateTimestamp = nullptr; 1982914e2d5dSEd Tanous const std::string* severity = nullptr; 1983914e2d5dSEd Tanous const std::string* message = nullptr; 1984914e2d5dSEd Tanous const std::string* filePath = nullptr; 19859c11a172SVijay Lobo const std::string* resolution = nullptr; 19867e860f15SJohn Edward Broadbent bool resolved = false; 19879017faf2SAbhishek Patel const std::string* notify = nullptr; 19887e860f15SJohn Edward Broadbent 1989d1bde9e5SKrzysztof Grobelny const bool success = sdbusplus::unpackPropertiesNoThrow( 1990d1bde9e5SKrzysztof Grobelny dbus_utils::UnpackErrorPrinter(), resp, "Id", id, "Timestamp", 1991d1bde9e5SKrzysztof Grobelny timestamp, "UpdateTimestamp", updateTimestamp, "Severity", 19929c11a172SVijay Lobo severity, "Message", message, "Resolved", resolved, 19939017faf2SAbhishek Patel "Resolution", resolution, "Path", filePath, 19949017faf2SAbhishek Patel "ServiceProviderNotify", notify); 1995d1bde9e5SKrzysztof Grobelny 1996d1bde9e5SKrzysztof Grobelny if (!success) 199775710de2SXiaochao Ma { 199875710de2SXiaochao Ma messages::internalError(asyncResp->res); 199975710de2SXiaochao Ma return; 200075710de2SXiaochao Ma } 2001d1bde9e5SKrzysztof Grobelny 2002002d39b4SEd Tanous if (id == nullptr || message == nullptr || severity == nullptr || 20039017faf2SAbhishek Patel timestamp == nullptr || updateTimestamp == nullptr || 20049017faf2SAbhishek Patel notify == nullptr) 2005f86bb901SAdriana Kobylak { 2006ae34c8e8SAdriana Kobylak messages::internalError(asyncResp->res); 2007271584abSEd Tanous return; 2008271584abSEd Tanous } 20099017faf2SAbhishek Patel 2010f86bb901SAdriana Kobylak asyncResp->res.jsonValue["@odata.type"] = 20119c11a172SVijay Lobo "#LogEntry.v1_9_0.LogEntry"; 2012ef4c65b7SEd Tanous asyncResp->res.jsonValue["@odata.id"] = boost::urls::format( 2013ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}", 2014ef4c65b7SEd Tanous std::to_string(*id)); 201545ca1b86SEd Tanous asyncResp->res.jsonValue["Name"] = "System Event Log Entry"; 2016f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Id"] = std::to_string(*id); 2017f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Message"] = *message; 2018f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Resolved"] = resolved; 20199017faf2SAbhishek Patel std::optional<bool> notifyAction = getProviderNotifyAction(*notify); 20209017faf2SAbhishek Patel if (notifyAction) 20219017faf2SAbhishek Patel { 20229017faf2SAbhishek Patel asyncResp->res.jsonValue["ServiceProviderNotified"] = 20239017faf2SAbhishek Patel *notifyAction; 20249017faf2SAbhishek Patel } 20259c11a172SVijay Lobo if ((resolution != nullptr) && (!(*resolution).empty())) 20269c11a172SVijay Lobo { 20279c11a172SVijay Lobo asyncResp->res.jsonValue["Resolution"] = *resolution; 20289c11a172SVijay Lobo } 2029f86bb901SAdriana Kobylak asyncResp->res.jsonValue["EntryType"] = "Event"; 2030f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Severity"] = 2031f86bb901SAdriana Kobylak translateSeverityDbusToRedfish(*severity); 2032f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Created"] = 20332b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*timestamp); 2034f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Modified"] = 20352b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 2036f86bb901SAdriana Kobylak if (filePath != nullptr) 2037f86bb901SAdriana Kobylak { 2038f86bb901SAdriana Kobylak asyncResp->res.jsonValue["AdditionalDataURI"] = 2039e7dbd530SPotin Lai "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 2040e7dbd530SPotin Lai std::to_string(*id) + "/attachment"; 2041f86bb901SAdriana Kobylak } 2042d1bde9e5SKrzysztof Grobelny }); 20437e860f15SJohn Edward Broadbent }); 2044336e96c6SChicago Duan 20457e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 204622d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 2047ed398213SEd Tanous .privileges(redfish::privileges::patchLogEntry) 20487e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::patch)( 204945ca1b86SEd Tanous [&app](const crow::Request& req, 20507e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 205122d268cbSEd Tanous const std::string& systemName, const std::string& entryId) { 20523ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 205345ca1b86SEd Tanous { 205445ca1b86SEd Tanous return; 205545ca1b86SEd Tanous } 20567f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 20577f3e84a1SEd Tanous { 20587f3e84a1SEd Tanous // Option currently returns no systems. TBD 20597f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 20607f3e84a1SEd Tanous systemName); 20617f3e84a1SEd Tanous return; 20627f3e84a1SEd Tanous } 206322d268cbSEd Tanous if (systemName != "system") 206422d268cbSEd Tanous { 206522d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 206622d268cbSEd Tanous systemName); 206722d268cbSEd Tanous return; 206822d268cbSEd Tanous } 206975710de2SXiaochao Ma std::optional<bool> resolved; 207075710de2SXiaochao Ma 207115ed6780SWilly Tu if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved", 20727e860f15SJohn Edward Broadbent resolved)) 207375710de2SXiaochao Ma { 207475710de2SXiaochao Ma return; 207575710de2SXiaochao Ma } 207662598e31SEd Tanous BMCWEB_LOG_DEBUG("Set Resolved"); 207775710de2SXiaochao Ma 20789ae226faSGeorge Liu sdbusplus::asio::setProperty( 20799ae226faSGeorge Liu *crow::connections::systemBus, "xyz.openbmc_project.Logging", 20809ae226faSGeorge Liu "/xyz/openbmc_project/logging/entry/" + entryId, 20819ae226faSGeorge Liu "xyz.openbmc_project.Logging.Entry", "Resolved", *resolved, 20825e7e2dc5SEd Tanous [asyncResp, entryId](const boost::system::error_code& ec) { 208375710de2SXiaochao Ma if (ec) 208475710de2SXiaochao Ma { 208562598e31SEd Tanous BMCWEB_LOG_DEBUG("DBUS response error {}", ec); 208675710de2SXiaochao Ma messages::internalError(asyncResp->res); 208775710de2SXiaochao Ma return; 208875710de2SXiaochao Ma } 20899ae226faSGeorge Liu }); 20907e860f15SJohn Edward Broadbent }); 209175710de2SXiaochao Ma 20927e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 209322d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 2094ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 2095ed398213SEd Tanous 2096002d39b4SEd Tanous .methods(boost::beast::http::verb::delete_)( 2097002d39b4SEd Tanous [&app](const crow::Request& req, 2098002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 209922d268cbSEd Tanous const std::string& systemName, const std::string& param) { 21003ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2101336e96c6SChicago Duan { 210245ca1b86SEd Tanous return; 210345ca1b86SEd Tanous } 21047f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 21057f3e84a1SEd Tanous { 21067f3e84a1SEd Tanous // Option currently returns no systems. TBD 21077f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 21087f3e84a1SEd Tanous systemName); 21097f3e84a1SEd Tanous return; 21107f3e84a1SEd Tanous } 211122d268cbSEd Tanous if (systemName != "system") 211222d268cbSEd Tanous { 211322d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 211422d268cbSEd Tanous systemName); 211522d268cbSEd Tanous return; 211622d268cbSEd Tanous } 211762598e31SEd Tanous BMCWEB_LOG_DEBUG("Do delete single event entries."); 2118336e96c6SChicago Duan 21197e860f15SJohn Edward Broadbent std::string entryID = param; 2120336e96c6SChicago Duan 2121336e96c6SChicago Duan dbus::utility::escapePathForDbus(entryID); 2122336e96c6SChicago Duan 2123336e96c6SChicago Duan // Process response from Logging service. 21245a39f77aSPatrick Williams auto respHandler = [asyncResp, 21255a39f77aSPatrick Williams entryID](const boost::system::error_code& ec) { 212662598e31SEd Tanous BMCWEB_LOG_DEBUG("EventLogEntry (DBus) doDelete callback: Done"); 2127336e96c6SChicago Duan if (ec) 2128336e96c6SChicago Duan { 21293de8d8baSGeorge Liu if (ec.value() == EBADR) 21303de8d8baSGeorge Liu { 213145ca1b86SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 213245ca1b86SEd Tanous entryID); 21333de8d8baSGeorge Liu return; 21343de8d8baSGeorge Liu } 2135336e96c6SChicago Duan // TODO Handle for specific error code 213662598e31SEd Tanous BMCWEB_LOG_ERROR( 213762598e31SEd Tanous "EventLogEntry (DBus) doDelete respHandler got error {}", 213862598e31SEd Tanous ec); 2139336e96c6SChicago Duan asyncResp->res.result( 2140336e96c6SChicago Duan boost::beast::http::status::internal_server_error); 2141336e96c6SChicago Duan return; 2142336e96c6SChicago Duan } 2143336e96c6SChicago Duan 2144336e96c6SChicago Duan asyncResp->res.result(boost::beast::http::status::ok); 2145336e96c6SChicago Duan }; 2146336e96c6SChicago Duan 2147336e96c6SChicago Duan // Make call to Logging service to request Delete Log 2148336e96c6SChicago Duan crow::connections::systemBus->async_method_call( 2149336e96c6SChicago Duan respHandler, "xyz.openbmc_project.Logging", 2150336e96c6SChicago Duan "/xyz/openbmc_project/logging/entry/" + entryID, 2151336e96c6SChicago Duan "xyz.openbmc_project.Object.Delete", "Delete"); 21527e860f15SJohn Edward Broadbent }); 2153400fd1fbSAdriana Kobylak } 2154400fd1fbSAdriana Kobylak 2155b7028ebfSSpencer Ku constexpr const char* hostLoggerFolderPath = "/var/log/console"; 2156b7028ebfSSpencer Ku 2157b7028ebfSSpencer Ku inline bool 2158b7028ebfSSpencer Ku getHostLoggerFiles(const std::string& hostLoggerFilePath, 2159b7028ebfSSpencer Ku std::vector<std::filesystem::path>& hostLoggerFiles) 2160b7028ebfSSpencer Ku { 2161b7028ebfSSpencer Ku std::error_code ec; 2162b7028ebfSSpencer Ku std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec); 2163b7028ebfSSpencer Ku if (ec) 2164b7028ebfSSpencer Ku { 2165bf2ddedeSCarson Labrado BMCWEB_LOG_WARNING("{}", ec.message()); 2166b7028ebfSSpencer Ku return false; 2167b7028ebfSSpencer Ku } 2168b7028ebfSSpencer Ku for (const std::filesystem::directory_entry& it : logPath) 2169b7028ebfSSpencer Ku { 2170b7028ebfSSpencer Ku std::string filename = it.path().filename(); 2171b7028ebfSSpencer Ku // Prefix of each log files is "log". Find the file and save the 2172b7028ebfSSpencer Ku // path 217311ba3979SEd Tanous if (filename.starts_with("log")) 2174b7028ebfSSpencer Ku { 2175b7028ebfSSpencer Ku hostLoggerFiles.emplace_back(it.path()); 2176b7028ebfSSpencer Ku } 2177b7028ebfSSpencer Ku } 2178b7028ebfSSpencer Ku // As the log files rotate, they are appended with a ".#" that is higher for 2179b7028ebfSSpencer Ku // the older logs. Since we start from oldest logs, sort the name in 2180b7028ebfSSpencer Ku // descending order. 2181b7028ebfSSpencer Ku std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(), 2182b7028ebfSSpencer Ku AlphanumLess<std::string>()); 2183b7028ebfSSpencer Ku 2184b7028ebfSSpencer Ku return true; 2185b7028ebfSSpencer Ku } 2186b7028ebfSSpencer Ku 218702cad96eSEd Tanous inline bool getHostLoggerEntries( 218802cad96eSEd Tanous const std::vector<std::filesystem::path>& hostLoggerFiles, uint64_t skip, 218902cad96eSEd Tanous uint64_t top, std::vector<std::string>& logEntries, size_t& logCount) 2190b7028ebfSSpencer Ku { 2191b7028ebfSSpencer Ku GzFileReader logFile; 2192b7028ebfSSpencer Ku 2193b7028ebfSSpencer Ku // Go though all log files and expose host logs. 2194b7028ebfSSpencer Ku for (const std::filesystem::path& it : hostLoggerFiles) 2195b7028ebfSSpencer Ku { 2196b7028ebfSSpencer Ku if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount)) 2197b7028ebfSSpencer Ku { 219862598e31SEd Tanous BMCWEB_LOG_ERROR("fail to expose host logs"); 2199b7028ebfSSpencer Ku return false; 2200b7028ebfSSpencer Ku } 2201b7028ebfSSpencer Ku } 2202b7028ebfSSpencer Ku // Get lastMessage from constructor by getter 2203b7028ebfSSpencer Ku std::string lastMessage = logFile.getLastMessage(); 2204b7028ebfSSpencer Ku if (!lastMessage.empty()) 2205b7028ebfSSpencer Ku { 2206b7028ebfSSpencer Ku logCount++; 2207b7028ebfSSpencer Ku if (logCount > skip && logCount <= (skip + top)) 2208b7028ebfSSpencer Ku { 2209b7028ebfSSpencer Ku logEntries.push_back(lastMessage); 2210b7028ebfSSpencer Ku } 2211b7028ebfSSpencer Ku } 2212b7028ebfSSpencer Ku return true; 2213b7028ebfSSpencer Ku } 2214b7028ebfSSpencer Ku 2215b7028ebfSSpencer Ku inline void fillHostLoggerEntryJson(const std::string& logEntryID, 2216b7028ebfSSpencer Ku const std::string& msg, 22176d6574c9SJason M. Bills nlohmann::json::object_t& logEntryJson) 2218b7028ebfSSpencer Ku { 2219b7028ebfSSpencer Ku // Fill in the log entry with the gathered data. 22209c11a172SVijay Lobo logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 2221ef4c65b7SEd Tanous logEntryJson["@odata.id"] = boost::urls::format( 2222ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/{}", 2223ef4c65b7SEd Tanous logEntryID); 22246d6574c9SJason M. Bills logEntryJson["Name"] = "Host Logger Entry"; 22256d6574c9SJason M. Bills logEntryJson["Id"] = logEntryID; 22266d6574c9SJason M. Bills logEntryJson["Message"] = msg; 22276d6574c9SJason M. Bills logEntryJson["EntryType"] = "Oem"; 22286d6574c9SJason M. Bills logEntryJson["Severity"] = "OK"; 22296d6574c9SJason M. Bills logEntryJson["OemRecordFormat"] = "Host Logger Entry"; 2230b7028ebfSSpencer Ku } 2231b7028ebfSSpencer Ku 2232b7028ebfSSpencer Ku inline void requestRoutesSystemHostLogger(App& app) 2233b7028ebfSSpencer Ku { 223422d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/") 2235b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogService) 22361476687dSEd Tanous .methods(boost::beast::http::verb::get)( 22371476687dSEd Tanous [&app](const crow::Request& req, 223822d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 223922d268cbSEd Tanous const std::string& systemName) { 22403ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 224145ca1b86SEd Tanous { 224245ca1b86SEd Tanous return; 224345ca1b86SEd Tanous } 22447f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 22457f3e84a1SEd Tanous { 22467f3e84a1SEd Tanous // Option currently returns no systems. TBD 22477f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 22487f3e84a1SEd Tanous systemName); 22497f3e84a1SEd Tanous return; 22507f3e84a1SEd Tanous } 225122d268cbSEd Tanous if (systemName != "system") 225222d268cbSEd Tanous { 225322d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 225422d268cbSEd Tanous systemName); 225522d268cbSEd Tanous return; 225622d268cbSEd Tanous } 2257b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 2258b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger"; 2259b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 2260b25644a1SJanet Adkins "#LogService.v1_2_0.LogService"; 2261b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "Host Logger Service"; 2262b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = "Host Logger Service"; 2263b7028ebfSSpencer Ku asyncResp->res.jsonValue["Id"] = "HostLogger"; 22641476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 22651476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 2266b7028ebfSSpencer Ku }); 2267b7028ebfSSpencer Ku } 2268b7028ebfSSpencer Ku 2269b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerCollection(App& app) 2270b7028ebfSSpencer Ku { 2271b7028ebfSSpencer Ku BMCWEB_ROUTE(app, 227222d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/") 2273b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 2274002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2275002d39b4SEd Tanous [&app](const crow::Request& req, 227622d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 227722d268cbSEd Tanous const std::string& systemName) { 2278c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 2279c937d2bfSEd Tanous .canDelegateTop = true, 2280c937d2bfSEd Tanous .canDelegateSkip = true, 2281c937d2bfSEd Tanous }; 2282c937d2bfSEd Tanous query_param::Query delegatedQuery; 2283c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 22843ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 2285b7028ebfSSpencer Ku { 2286b7028ebfSSpencer Ku return; 2287b7028ebfSSpencer Ku } 22887f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 22897f3e84a1SEd Tanous { 22907f3e84a1SEd Tanous // Option currently returns no systems. TBD 22917f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 22927f3e84a1SEd Tanous systemName); 22937f3e84a1SEd Tanous return; 22947f3e84a1SEd Tanous } 229522d268cbSEd Tanous if (systemName != "system") 229622d268cbSEd Tanous { 229722d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 229822d268cbSEd Tanous systemName); 229922d268cbSEd Tanous return; 230022d268cbSEd Tanous } 2301b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 2302b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 2303b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 2304b7028ebfSSpencer Ku "#LogEntryCollection.LogEntryCollection"; 2305b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "HostLogger Entries"; 2306b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = 2307b7028ebfSSpencer Ku "Collection of HostLogger Entries"; 23080fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2309b7028ebfSSpencer Ku logEntryArray = nlohmann::json::array(); 2310b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = 0; 2311b7028ebfSSpencer Ku 2312b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 2313b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 2314b7028ebfSSpencer Ku { 2315bf2ddedeSCarson Labrado BMCWEB_LOG_DEBUG("Failed to get host log file path"); 2316b7028ebfSSpencer Ku return; 2317b7028ebfSSpencer Ku } 23183648c8beSEd Tanous // If we weren't provided top and skip limits, use the defaults. 23193648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 23205143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 2321b7028ebfSSpencer Ku size_t logCount = 0; 2322b7028ebfSSpencer Ku // This vector only store the entries we want to expose that 2323b7028ebfSSpencer Ku // control by skip and top. 2324b7028ebfSSpencer Ku std::vector<std::string> logEntries; 23253648c8beSEd Tanous if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries, 23263648c8beSEd Tanous logCount)) 2327b7028ebfSSpencer Ku { 2328b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 2329b7028ebfSSpencer Ku return; 2330b7028ebfSSpencer Ku } 2331b7028ebfSSpencer Ku // If vector is empty, that means skip value larger than total 2332b7028ebfSSpencer Ku // log count 233326f6976fSEd Tanous if (logEntries.empty()) 2334b7028ebfSSpencer Ku { 2335b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 2336b7028ebfSSpencer Ku return; 2337b7028ebfSSpencer Ku } 233826f6976fSEd Tanous if (!logEntries.empty()) 2339b7028ebfSSpencer Ku { 2340b7028ebfSSpencer Ku for (size_t i = 0; i < logEntries.size(); i++) 2341b7028ebfSSpencer Ku { 23426d6574c9SJason M. Bills nlohmann::json::object_t hostLogEntry; 23433648c8beSEd Tanous fillHostLoggerEntryJson(std::to_string(skip + i), logEntries[i], 23443648c8beSEd Tanous hostLogEntry); 2345b2ba3072SPatrick Williams logEntryArray.emplace_back(std::move(hostLogEntry)); 2346b7028ebfSSpencer Ku } 2347b7028ebfSSpencer Ku 2348b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 23493648c8beSEd Tanous if (skip + top < logCount) 2350b7028ebfSSpencer Ku { 2351b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.nextLink"] = 23520fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/HostLogger/Entries?$skip=" + 23533648c8beSEd Tanous std::to_string(skip + top); 2354b7028ebfSSpencer Ku } 2355b7028ebfSSpencer Ku } 2356b7028ebfSSpencer Ku }); 2357b7028ebfSSpencer Ku } 2358b7028ebfSSpencer Ku 2359b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerLogEntry(App& app) 2360b7028ebfSSpencer Ku { 2361b7028ebfSSpencer Ku BMCWEB_ROUTE( 236222d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/<str>/") 2363b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 2364b7028ebfSSpencer Ku .methods(boost::beast::http::verb::get)( 236545ca1b86SEd Tanous [&app](const crow::Request& req, 2366b7028ebfSSpencer Ku const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 236722d268cbSEd Tanous const std::string& systemName, const std::string& param) { 23683ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 236945ca1b86SEd Tanous { 237045ca1b86SEd Tanous return; 237145ca1b86SEd Tanous } 23727f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 23737f3e84a1SEd Tanous { 23747f3e84a1SEd Tanous // Option currently returns no systems. TBD 23757f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 23767f3e84a1SEd Tanous systemName); 23777f3e84a1SEd Tanous return; 23787f3e84a1SEd Tanous } 237922d268cbSEd Tanous if (systemName != "system") 238022d268cbSEd Tanous { 238122d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 238222d268cbSEd Tanous systemName); 238322d268cbSEd Tanous return; 238422d268cbSEd Tanous } 2385b7028ebfSSpencer Ku const std::string& targetID = param; 2386b7028ebfSSpencer Ku 2387b7028ebfSSpencer Ku uint64_t idInt = 0; 2388ca45aa3cSEd Tanous 238984396af9SPatrick Williams auto [ptr, ec] = std::from_chars(&*targetID.begin(), &*targetID.end(), 239084396af9SPatrick Williams idInt); 23919db4ba25SJiaqing Zhao if (ec == std::errc::invalid_argument || 23929db4ba25SJiaqing Zhao ec == std::errc::result_out_of_range) 2393b7028ebfSSpencer Ku { 23949db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", param); 2395b7028ebfSSpencer Ku return; 2396b7028ebfSSpencer Ku } 2397b7028ebfSSpencer Ku 2398b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 2399b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 2400b7028ebfSSpencer Ku { 2401bf2ddedeSCarson Labrado BMCWEB_LOG_DEBUG("Failed to get host log file path"); 2402b7028ebfSSpencer Ku return; 2403b7028ebfSSpencer Ku } 2404b7028ebfSSpencer Ku 2405b7028ebfSSpencer Ku size_t logCount = 0; 24063648c8beSEd Tanous size_t top = 1; 2407b7028ebfSSpencer Ku std::vector<std::string> logEntries; 2408b7028ebfSSpencer Ku // We can get specific entry by skip and top. For example, if we 2409b7028ebfSSpencer Ku // want to get nth entry, we can set skip = n-1 and top = 1 to 2410b7028ebfSSpencer Ku // get that entry 2411002d39b4SEd Tanous if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, logEntries, 2412002d39b4SEd Tanous logCount)) 2413b7028ebfSSpencer Ku { 2414b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 2415b7028ebfSSpencer Ku return; 2416b7028ebfSSpencer Ku } 2417b7028ebfSSpencer Ku 2418b7028ebfSSpencer Ku if (!logEntries.empty()) 2419b7028ebfSSpencer Ku { 24206d6574c9SJason M. Bills nlohmann::json::object_t hostLogEntry; 24216d6574c9SJason M. Bills fillHostLoggerEntryJson(targetID, logEntries[0], hostLogEntry); 24226d6574c9SJason M. Bills asyncResp->res.jsonValue.update(hostLogEntry); 2423b7028ebfSSpencer Ku return; 2424b7028ebfSSpencer Ku } 2425b7028ebfSSpencer Ku 2426b7028ebfSSpencer Ku // Requested ID was not found 24279db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", param); 2428b7028ebfSSpencer Ku }); 2429b7028ebfSSpencer Ku } 2430b7028ebfSSpencer Ku 2431dd72e87bSClaire Weinan inline void handleBMCLogServicesCollectionGet( 2432fdd26906SClaire Weinan crow::App& app, const crow::Request& req, 2433fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 24341da66f75SEd Tanous { 24353ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 243645ca1b86SEd Tanous { 243745ca1b86SEd Tanous return; 243845ca1b86SEd Tanous } 24397e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 24407e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2441e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 24421da66f75SEd Tanous "#LogServiceCollection.LogServiceCollection"; 2443e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 2444e1f26343SJason M. Bills "/redfish/v1/Managers/bmc/LogServices"; 2445002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection"; 2446e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 24471da66f75SEd Tanous "Collection of LogServices for this Manager"; 2448002d39b4SEd Tanous nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 2449c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 2450fdd26906SClaire Weinan 2451c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL 2452613dabeaSEd Tanous nlohmann::json::object_t journal; 2453613dabeaSEd Tanous journal["@odata.id"] = "/redfish/v1/Managers/bmc/LogServices/Journal"; 2454b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(journal)); 2455c4bf6374SJason M. Bills #endif 2456fdd26906SClaire Weinan 2457fdd26906SClaire Weinan asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size(); 2458fdd26906SClaire Weinan 2459fdd26906SClaire Weinan #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 246015912159SGeorge Liu constexpr std::array<std::string_view, 1> interfaces = { 24617a1dbc48SGeorge Liu "xyz.openbmc_project.Collection.DeleteAll"}; 24627a1dbc48SGeorge Liu dbus::utility::getSubTreePaths( 24637a1dbc48SGeorge Liu "/xyz/openbmc_project/dump", 0, interfaces, 2464fdd26906SClaire Weinan [asyncResp]( 24657a1dbc48SGeorge Liu const boost::system::error_code& ec, 2466fdd26906SClaire Weinan const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 2467fdd26906SClaire Weinan if (ec) 2468fdd26906SClaire Weinan { 246962598e31SEd Tanous BMCWEB_LOG_ERROR( 247062598e31SEd Tanous "handleBMCLogServicesCollectionGet respHandler got error {}", 247162598e31SEd Tanous ec); 2472fdd26906SClaire Weinan // Assume that getting an error simply means there are no dump 2473fdd26906SClaire Weinan // LogServices. Return without adding any error response. 2474fdd26906SClaire Weinan return; 2475fdd26906SClaire Weinan } 2476fdd26906SClaire Weinan 2477fdd26906SClaire Weinan nlohmann::json& logServiceArrayLocal = 2478fdd26906SClaire Weinan asyncResp->res.jsonValue["Members"]; 2479fdd26906SClaire Weinan 2480fdd26906SClaire Weinan for (const std::string& path : subTreePaths) 2481fdd26906SClaire Weinan { 2482fdd26906SClaire Weinan if (path == "/xyz/openbmc_project/dump/bmc") 2483fdd26906SClaire Weinan { 2484613dabeaSEd Tanous nlohmann::json::object_t member; 2485613dabeaSEd Tanous member["@odata.id"] = 2486613dabeaSEd Tanous "/redfish/v1/Managers/bmc/LogServices/Dump"; 2487b2ba3072SPatrick Williams logServiceArrayLocal.emplace_back(std::move(member)); 2488fdd26906SClaire Weinan } 2489fdd26906SClaire Weinan else if (path == "/xyz/openbmc_project/dump/faultlog") 2490fdd26906SClaire Weinan { 2491613dabeaSEd Tanous nlohmann::json::object_t member; 2492613dabeaSEd Tanous member["@odata.id"] = 2493613dabeaSEd Tanous "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2494b2ba3072SPatrick Williams logServiceArrayLocal.emplace_back(std::move(member)); 2495fdd26906SClaire Weinan } 2496fdd26906SClaire Weinan } 2497fdd26906SClaire Weinan 2498e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 2499fdd26906SClaire Weinan logServiceArrayLocal.size(); 25007a1dbc48SGeorge Liu }); 2501fdd26906SClaire Weinan #endif 2502fdd26906SClaire Weinan } 2503fdd26906SClaire Weinan 2504fdd26906SClaire Weinan inline void requestRoutesBMCLogServiceCollection(App& app) 2505fdd26906SClaire Weinan { 2506fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/") 2507fdd26906SClaire Weinan .privileges(redfish::privileges::getLogServiceCollection) 2508fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 2509dd72e87bSClaire Weinan std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app))); 2510e1f26343SJason M. Bills } 2511e1f26343SJason M. Bills 25127e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogService(App& app) 2513e1f26343SJason M. Bills { 25147e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/") 2515ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 25167e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 251745ca1b86SEd Tanous [&app](const crow::Request& req, 251845ca1b86SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 25193ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 25207e860f15SJohn Edward Broadbent { 252145ca1b86SEd Tanous return; 252245ca1b86SEd Tanous } 2523e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2524b25644a1SJanet Adkins "#LogService.v1_2_0.LogService"; 25250f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 25260f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal"; 2527002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service"; 2528002d39b4SEd Tanous asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service"; 2529ed34a4adSEd Tanous asyncResp->res.jsonValue["Id"] = "Journal"; 2530e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 25317c8c4058STejas Patil 25327c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 25332b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 2534002d39b4SEd Tanous asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 25357c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 25367c8c4058STejas Patil redfishDateTimeOffset.second; 25377c8c4058STejas Patil 25381476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 25391476687dSEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 25407e860f15SJohn Edward Broadbent }); 2541e1f26343SJason M. Bills } 2542e1f26343SJason M. Bills 25433a48b3a2SJason M. Bills static int 25443a48b3a2SJason M. Bills fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID, 2545e1f26343SJason M. Bills sd_journal* journal, 25463a48b3a2SJason M. Bills nlohmann::json::object_t& bmcJournalLogEntryJson) 2547e1f26343SJason M. Bills { 2548e1f26343SJason M. Bills // Get the Log Entry contents 2549e1f26343SJason M. Bills int ret = 0; 2550e1f26343SJason M. Bills 2551a8fe54f0SJason M. Bills std::string message; 2552a8fe54f0SJason M. Bills std::string_view syslogID; 2553a8fe54f0SJason M. Bills ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID); 2554a8fe54f0SJason M. Bills if (ret < 0) 2555a8fe54f0SJason M. Bills { 2556bf2ddedeSCarson Labrado BMCWEB_LOG_DEBUG("Failed to read SYSLOG_IDENTIFIER field: {}", 255762598e31SEd Tanous strerror(-ret)); 2558a8fe54f0SJason M. Bills } 2559a8fe54f0SJason M. Bills if (!syslogID.empty()) 2560a8fe54f0SJason M. Bills { 2561a8fe54f0SJason M. Bills message += std::string(syslogID) + ": "; 2562a8fe54f0SJason M. Bills } 2563a8fe54f0SJason M. Bills 256439e77504SEd Tanous std::string_view msg; 256516428a1aSJason M. Bills ret = getJournalMetadata(journal, "MESSAGE", msg); 2566e1f26343SJason M. Bills if (ret < 0) 2567e1f26343SJason M. Bills { 256862598e31SEd Tanous BMCWEB_LOG_ERROR("Failed to read MESSAGE field: {}", strerror(-ret)); 2569e1f26343SJason M. Bills return 1; 2570e1f26343SJason M. Bills } 2571a8fe54f0SJason M. Bills message += std::string(msg); 2572e1f26343SJason M. Bills 2573e1f26343SJason M. Bills // Get the severity from the PRIORITY field 2574271584abSEd Tanous long int severity = 8; // Default to an invalid priority 257516428a1aSJason M. Bills ret = getJournalMetadata(journal, "PRIORITY", 10, severity); 2576e1f26343SJason M. Bills if (ret < 0) 2577e1f26343SJason M. Bills { 2578bf2ddedeSCarson Labrado BMCWEB_LOG_DEBUG("Failed to read PRIORITY field: {}", strerror(-ret)); 2579e1f26343SJason M. Bills } 2580e1f26343SJason M. Bills 2581e1f26343SJason M. Bills // Get the Created time from the timestamp 258216428a1aSJason M. Bills std::string entryTimeStr; 258316428a1aSJason M. Bills if (!getEntryTimestamp(journal, entryTimeStr)) 2584e1f26343SJason M. Bills { 258516428a1aSJason M. Bills return 1; 2586e1f26343SJason M. Bills } 2587e1f26343SJason M. Bills 2588e1f26343SJason M. Bills // Fill in the log entry with the gathered data 25899c11a172SVijay Lobo bmcJournalLogEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 2590ef4c65b7SEd Tanous bmcJournalLogEntryJson["@odata.id"] = boost::urls::format( 2591ef4c65b7SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/{}", 2592eddfc437SWilly Tu bmcJournalLogEntryID); 259384afc48bSJason M. Bills bmcJournalLogEntryJson["Name"] = "BMC Journal Entry"; 259484afc48bSJason M. Bills bmcJournalLogEntryJson["Id"] = bmcJournalLogEntryID; 259584afc48bSJason M. Bills bmcJournalLogEntryJson["Message"] = std::move(message); 259684afc48bSJason M. Bills bmcJournalLogEntryJson["EntryType"] = "Oem"; 259784afc48bSJason M. Bills bmcJournalLogEntryJson["Severity"] = severity <= 2 ? "Critical" 2598738c1e61SPatrick Williams : severity <= 4 ? "Warning" 259984afc48bSJason M. Bills : "OK"; 260084afc48bSJason M. Bills bmcJournalLogEntryJson["OemRecordFormat"] = "BMC Journal Entry"; 260184afc48bSJason M. Bills bmcJournalLogEntryJson["Created"] = std::move(entryTimeStr); 2602e1f26343SJason M. Bills return 0; 2603e1f26343SJason M. Bills } 2604e1f26343SJason M. Bills 26057e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntryCollection(App& app) 2606e1f26343SJason M. Bills { 26077e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/") 2608ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 2609002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2610002d39b4SEd Tanous [&app](const crow::Request& req, 2611002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2612c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 2613c937d2bfSEd Tanous .canDelegateTop = true, 2614c937d2bfSEd Tanous .canDelegateSkip = true, 2615c937d2bfSEd Tanous }; 2616c937d2bfSEd Tanous query_param::Query delegatedQuery; 2617c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 26183ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 2619193ad2faSJason M. Bills { 2620193ad2faSJason M. Bills return; 2621193ad2faSJason M. Bills } 26223648c8beSEd Tanous 26233648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 26245143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 26253648c8beSEd Tanous 26267e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 26277e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2628e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2629e1f26343SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 26300f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 26310f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 2632e1f26343SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries"; 2633e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2634e1f26343SJason M. Bills "Collection of BMC Journal Entries"; 26350fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2636e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 2637e1f26343SJason M. Bills 26387e860f15SJohn Edward Broadbent // Go through the journal and use the timestamp to create a 26397e860f15SJohn Edward Broadbent // unique ID for each entry 2640e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2641e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2642e1f26343SJason M. Bills if (ret < 0) 2643e1f26343SJason M. Bills { 264462598e31SEd Tanous BMCWEB_LOG_ERROR("failed to open journal: {}", strerror(-ret)); 2645f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2646e1f26343SJason M. Bills return; 2647e1f26343SJason M. Bills } 26480fda0f12SGeorge Liu std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 26490fda0f12SGeorge Liu journalTmp, sd_journal_close); 2650e1f26343SJason M. Bills journalTmp = nullptr; 2651b01bf299SEd Tanous uint64_t entryCount = 0; 2652e85d6b16SJason M. Bills // Reset the unique ID on the first entry 2653e85d6b16SJason M. Bills bool firstEntry = true; 2654e1f26343SJason M. Bills SD_JOURNAL_FOREACH(journal.get()) 2655e1f26343SJason M. Bills { 2656193ad2faSJason M. Bills entryCount++; 26577e860f15SJohn Edward Broadbent // Handle paging using skip (number of entries to skip from 26587e860f15SJohn Edward Broadbent // the start) and top (number of entries to display) 26593648c8beSEd Tanous if (entryCount <= skip || entryCount > skip + top) 2660193ad2faSJason M. Bills { 2661193ad2faSJason M. Bills continue; 2662193ad2faSJason M. Bills } 2663193ad2faSJason M. Bills 266416428a1aSJason M. Bills std::string idStr; 2665e85d6b16SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2666e1f26343SJason M. Bills { 2667e1f26343SJason M. Bills continue; 2668e1f26343SJason M. Bills } 2669e85d6b16SJason M. Bills firstEntry = false; 2670e85d6b16SJason M. Bills 26713a48b3a2SJason M. Bills nlohmann::json::object_t bmcJournalLogEntry; 2672c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(idStr, journal.get(), 2673c4bf6374SJason M. Bills bmcJournalLogEntry) != 0) 2674e1f26343SJason M. Bills { 2675f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2676e1f26343SJason M. Bills return; 2677e1f26343SJason M. Bills } 2678b2ba3072SPatrick Williams logEntryArray.emplace_back(std::move(bmcJournalLogEntry)); 2679e1f26343SJason M. Bills } 2680193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 26813648c8beSEd Tanous if (skip + top < entryCount) 2682193ad2faSJason M. Bills { 2683193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 26840fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" + 26853648c8beSEd Tanous std::to_string(skip + top); 2686193ad2faSJason M. Bills } 26877e860f15SJohn Edward Broadbent }); 2688e1f26343SJason M. Bills } 2689e1f26343SJason M. Bills 26907e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntry(App& app) 2691e1f26343SJason M. Bills { 26927e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 26937e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/") 2694ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 26957e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 269645ca1b86SEd Tanous [&app](const crow::Request& req, 26977e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 26987e860f15SJohn Edward Broadbent const std::string& entryID) { 26993ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 270045ca1b86SEd Tanous { 270145ca1b86SEd Tanous return; 270245ca1b86SEd Tanous } 2703e1f26343SJason M. Bills // Convert the unique ID back to a timestamp to find the entry 270475e8e218SMyung Bae sd_id128_t bootID{}; 2705e1f26343SJason M. Bills uint64_t ts = 0; 2706271584abSEd Tanous uint64_t index = 0; 270775e8e218SMyung Bae if (!getTimestampFromID(asyncResp, entryID, bootID, ts, index)) 2708e1f26343SJason M. Bills { 270916428a1aSJason M. Bills return; 2710e1f26343SJason M. Bills } 2711e1f26343SJason M. Bills 2712e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2713e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2714e1f26343SJason M. Bills if (ret < 0) 2715e1f26343SJason M. Bills { 271662598e31SEd Tanous BMCWEB_LOG_ERROR("failed to open journal: {}", strerror(-ret)); 2717f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2718e1f26343SJason M. Bills return; 2719e1f26343SJason M. Bills } 2720002d39b4SEd Tanous std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 2721002d39b4SEd Tanous journalTmp, sd_journal_close); 2722e1f26343SJason M. Bills journalTmp = nullptr; 27237e860f15SJohn Edward Broadbent // Go to the timestamp in the log and move to the entry at the 27247e860f15SJohn Edward Broadbent // index tracking the unique ID 2725af07e3f5SJason M. Bills std::string idStr; 2726af07e3f5SJason M. Bills bool firstEntry = true; 272775e8e218SMyung Bae ret = sd_journal_seek_monotonic_usec(journal.get(), bootID, ts); 27282056b6d1SManojkiran Eda if (ret < 0) 27292056b6d1SManojkiran Eda { 273062598e31SEd Tanous BMCWEB_LOG_ERROR("failed to seek to an entry in journal{}", 273162598e31SEd Tanous strerror(-ret)); 27322056b6d1SManojkiran Eda messages::internalError(asyncResp->res); 27332056b6d1SManojkiran Eda return; 27342056b6d1SManojkiran Eda } 2735271584abSEd Tanous for (uint64_t i = 0; i <= index; i++) 2736e1f26343SJason M. Bills { 2737e1f26343SJason M. Bills sd_journal_next(journal.get()); 2738af07e3f5SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2739af07e3f5SJason M. Bills { 2740af07e3f5SJason M. Bills messages::internalError(asyncResp->res); 2741af07e3f5SJason M. Bills return; 2742af07e3f5SJason M. Bills } 2743af07e3f5SJason M. Bills firstEntry = false; 2744af07e3f5SJason M. Bills } 2745c4bf6374SJason M. Bills // Confirm that the entry ID matches what was requested 2746af07e3f5SJason M. Bills if (idStr != entryID) 2747c4bf6374SJason M. Bills { 27489db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 2749c4bf6374SJason M. Bills return; 2750c4bf6374SJason M. Bills } 2751c4bf6374SJason M. Bills 27523a48b3a2SJason M. Bills nlohmann::json::object_t bmcJournalLogEntry; 2753c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(entryID, journal.get(), 27543a48b3a2SJason M. Bills bmcJournalLogEntry) != 0) 2755e1f26343SJason M. Bills { 2756f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2757e1f26343SJason M. Bills return; 2758e1f26343SJason M. Bills } 2759d405bb51SJason M. Bills asyncResp->res.jsonValue.update(bmcJournalLogEntry); 27607e860f15SJohn Edward Broadbent }); 2761c9bb6861Sraviteja-b } 2762c9bb6861Sraviteja-b 2763fdd26906SClaire Weinan inline void 2764fdd26906SClaire Weinan getDumpServiceInfo(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2765fdd26906SClaire Weinan const std::string& dumpType) 2766c9bb6861Sraviteja-b { 2767fdd26906SClaire Weinan std::string dumpPath; 2768fdd26906SClaire Weinan std::string overWritePolicy; 2769fdd26906SClaire Weinan bool collectDiagnosticDataSupported = false; 2770fdd26906SClaire Weinan 2771fdd26906SClaire Weinan if (dumpType == "BMC") 277245ca1b86SEd Tanous { 2773fdd26906SClaire Weinan dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump"; 2774fdd26906SClaire Weinan overWritePolicy = "WrapsWhenFull"; 2775fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2776fdd26906SClaire Weinan } 2777fdd26906SClaire Weinan else if (dumpType == "FaultLog") 2778fdd26906SClaire Weinan { 2779fdd26906SClaire Weinan dumpPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2780fdd26906SClaire Weinan overWritePolicy = "Unknown"; 2781fdd26906SClaire Weinan collectDiagnosticDataSupported = false; 2782fdd26906SClaire Weinan } 2783fdd26906SClaire Weinan else if (dumpType == "System") 2784fdd26906SClaire Weinan { 2785fdd26906SClaire Weinan dumpPath = "/redfish/v1/Systems/system/LogServices/Dump"; 2786fdd26906SClaire Weinan overWritePolicy = "WrapsWhenFull"; 2787fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2788fdd26906SClaire Weinan } 2789fdd26906SClaire Weinan else 2790fdd26906SClaire Weinan { 279162598e31SEd Tanous BMCWEB_LOG_ERROR("getDumpServiceInfo() invalid dump type: {}", 279262598e31SEd Tanous dumpType); 2793fdd26906SClaire Weinan messages::internalError(asyncResp->res); 279445ca1b86SEd Tanous return; 279545ca1b86SEd Tanous } 2796fdd26906SClaire Weinan 2797fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = dumpPath; 2798fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService"; 2799c9bb6861Sraviteja-b asyncResp->res.jsonValue["Name"] = "Dump LogService"; 2800fdd26906SClaire Weinan asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService"; 2801fdd26906SClaire Weinan asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename(); 2802fdd26906SClaire Weinan asyncResp->res.jsonValue["OverWritePolicy"] = std::move(overWritePolicy); 28037c8c4058STejas Patil 28047c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 28052b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 28060fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 28077c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 28087c8c4058STejas Patil redfishDateTimeOffset.second; 28097c8c4058STejas Patil 2810fdd26906SClaire Weinan asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries"; 2811fdd26906SClaire Weinan 2812fdd26906SClaire Weinan if (collectDiagnosticDataSupported) 2813fdd26906SClaire Weinan { 2814002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 28151476687dSEd Tanous ["target"] = 2816fdd26906SClaire Weinan dumpPath + "/Actions/LogService.CollectDiagnosticData"; 2817fdd26906SClaire Weinan } 28180d946211SClaire Weinan 28190d946211SClaire Weinan constexpr std::array<std::string_view, 1> interfaces = {deleteAllInterface}; 28200d946211SClaire Weinan dbus::utility::getSubTreePaths( 28210d946211SClaire Weinan "/xyz/openbmc_project/dump", 0, interfaces, 28220d946211SClaire Weinan [asyncResp, dumpType, dumpPath]( 28230d946211SClaire Weinan const boost::system::error_code& ec, 28240d946211SClaire Weinan const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 28250d946211SClaire Weinan if (ec) 28260d946211SClaire Weinan { 282762598e31SEd Tanous BMCWEB_LOG_ERROR("getDumpServiceInfo respHandler got error {}", ec); 28280d946211SClaire Weinan // Assume that getting an error simply means there are no dump 28290d946211SClaire Weinan // LogServices. Return without adding any error response. 28300d946211SClaire Weinan return; 28310d946211SClaire Weinan } 283218f8f608SEd Tanous std::string dbusDumpPath = getDumpPath(dumpType); 28330d946211SClaire Weinan for (const std::string& path : subTreePaths) 28340d946211SClaire Weinan { 28350d946211SClaire Weinan if (path == dbusDumpPath) 28360d946211SClaire Weinan { 28370d946211SClaire Weinan asyncResp->res 28380d946211SClaire Weinan .jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 28390d946211SClaire Weinan dumpPath + "/Actions/LogService.ClearLog"; 28400d946211SClaire Weinan break; 28410d946211SClaire Weinan } 28420d946211SClaire Weinan } 28430d946211SClaire Weinan }); 2844c9bb6861Sraviteja-b } 2845c9bb6861Sraviteja-b 2846fdd26906SClaire Weinan inline void handleLogServicesDumpServiceGet( 2847fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2848fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 28497e860f15SJohn Edward Broadbent { 28503ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 285145ca1b86SEd Tanous { 285245ca1b86SEd Tanous return; 285345ca1b86SEd Tanous } 2854fdd26906SClaire Weinan getDumpServiceInfo(asyncResp, dumpType); 2855fdd26906SClaire Weinan } 2856c9bb6861Sraviteja-b 285722d268cbSEd Tanous inline void handleLogServicesDumpServiceComputerSystemGet( 285822d268cbSEd Tanous crow::App& app, const crow::Request& req, 285922d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 286022d268cbSEd Tanous const std::string& chassisId) 286122d268cbSEd Tanous { 286222d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 286322d268cbSEd Tanous { 286422d268cbSEd Tanous return; 286522d268cbSEd Tanous } 286622d268cbSEd Tanous if (chassisId != "system") 286722d268cbSEd Tanous { 286822d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 286922d268cbSEd Tanous return; 287022d268cbSEd Tanous } 287122d268cbSEd Tanous getDumpServiceInfo(asyncResp, "System"); 287222d268cbSEd Tanous } 287322d268cbSEd Tanous 2874fdd26906SClaire Weinan inline void handleLogServicesDumpEntriesCollectionGet( 2875fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2876fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2877fdd26906SClaire Weinan { 2878fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2879fdd26906SClaire Weinan { 2880fdd26906SClaire Weinan return; 2881fdd26906SClaire Weinan } 2882fdd26906SClaire Weinan getDumpEntryCollection(asyncResp, dumpType); 2883fdd26906SClaire Weinan } 2884fdd26906SClaire Weinan 288522d268cbSEd Tanous inline void handleLogServicesDumpEntriesCollectionComputerSystemGet( 288622d268cbSEd Tanous crow::App& app, const crow::Request& req, 288722d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 288822d268cbSEd Tanous const std::string& chassisId) 288922d268cbSEd Tanous { 289022d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 289122d268cbSEd Tanous { 289222d268cbSEd Tanous return; 289322d268cbSEd Tanous } 289422d268cbSEd Tanous if (chassisId != "system") 289522d268cbSEd Tanous { 289622d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 289722d268cbSEd Tanous return; 289822d268cbSEd Tanous } 289922d268cbSEd Tanous getDumpEntryCollection(asyncResp, "System"); 290022d268cbSEd Tanous } 290122d268cbSEd Tanous 2902fdd26906SClaire Weinan inline void handleLogServicesDumpEntryGet( 2903fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2904fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2905fdd26906SClaire Weinan const std::string& dumpId) 2906fdd26906SClaire Weinan { 2907fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2908fdd26906SClaire Weinan { 2909fdd26906SClaire Weinan return; 2910fdd26906SClaire Weinan } 2911fdd26906SClaire Weinan getDumpEntryById(asyncResp, dumpId, dumpType); 2912fdd26906SClaire Weinan } 2913168d1b1aSCarson Labrado 291422d268cbSEd Tanous inline void handleLogServicesDumpEntryComputerSystemGet( 291522d268cbSEd Tanous crow::App& app, const crow::Request& req, 291622d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 291722d268cbSEd Tanous const std::string& chassisId, const std::string& dumpId) 291822d268cbSEd Tanous { 291922d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 292022d268cbSEd Tanous { 292122d268cbSEd Tanous return; 292222d268cbSEd Tanous } 292322d268cbSEd Tanous if (chassisId != "system") 292422d268cbSEd Tanous { 292522d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 292622d268cbSEd Tanous return; 292722d268cbSEd Tanous } 292822d268cbSEd Tanous getDumpEntryById(asyncResp, dumpId, "System"); 292922d268cbSEd Tanous } 2930fdd26906SClaire Weinan 2931fdd26906SClaire Weinan inline void handleLogServicesDumpEntryDelete( 2932fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2933fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2934fdd26906SClaire Weinan const std::string& dumpId) 2935fdd26906SClaire Weinan { 2936fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2937fdd26906SClaire Weinan { 2938fdd26906SClaire Weinan return; 2939fdd26906SClaire Weinan } 2940fdd26906SClaire Weinan deleteDumpEntry(asyncResp, dumpId, dumpType); 2941fdd26906SClaire Weinan } 2942fdd26906SClaire Weinan 294322d268cbSEd Tanous inline void handleLogServicesDumpEntryComputerSystemDelete( 294422d268cbSEd Tanous crow::App& app, const crow::Request& req, 294522d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 294622d268cbSEd Tanous const std::string& chassisId, const std::string& dumpId) 294722d268cbSEd Tanous { 294822d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 294922d268cbSEd Tanous { 295022d268cbSEd Tanous return; 295122d268cbSEd Tanous } 295222d268cbSEd Tanous if (chassisId != "system") 295322d268cbSEd Tanous { 295422d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 295522d268cbSEd Tanous return; 295622d268cbSEd Tanous } 295722d268cbSEd Tanous deleteDumpEntry(asyncResp, dumpId, "System"); 295822d268cbSEd Tanous } 295922d268cbSEd Tanous 2960168d1b1aSCarson Labrado inline void handleLogServicesDumpEntryDownloadGet( 2961168d1b1aSCarson Labrado crow::App& app, const std::string& dumpType, const crow::Request& req, 2962168d1b1aSCarson Labrado const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2963168d1b1aSCarson Labrado const std::string& dumpId) 2964168d1b1aSCarson Labrado { 2965168d1b1aSCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2966168d1b1aSCarson Labrado { 2967168d1b1aSCarson Labrado return; 2968168d1b1aSCarson Labrado } 2969168d1b1aSCarson Labrado downloadDumpEntry(asyncResp, dumpId, dumpType); 2970168d1b1aSCarson Labrado } 2971168d1b1aSCarson Labrado 2972168d1b1aSCarson Labrado inline void handleDBusEventLogEntryDownloadGet( 2973168d1b1aSCarson Labrado crow::App& app, const std::string& dumpType, const crow::Request& req, 2974168d1b1aSCarson Labrado const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2975168d1b1aSCarson Labrado const std::string& systemName, const std::string& entryID) 2976168d1b1aSCarson Labrado { 2977168d1b1aSCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2978168d1b1aSCarson Labrado { 2979168d1b1aSCarson Labrado return; 2980168d1b1aSCarson Labrado } 2981168d1b1aSCarson Labrado if (!http_helpers::isContentTypeAllowed( 2982168d1b1aSCarson Labrado req.getHeaderValue("Accept"), 2983168d1b1aSCarson Labrado http_helpers::ContentType::OctetStream, true)) 2984168d1b1aSCarson Labrado { 2985168d1b1aSCarson Labrado asyncResp->res.result(boost::beast::http::status::bad_request); 2986168d1b1aSCarson Labrado return; 2987168d1b1aSCarson Labrado } 2988168d1b1aSCarson Labrado downloadEventLogEntry(asyncResp, systemName, entryID, dumpType); 2989168d1b1aSCarson Labrado } 2990168d1b1aSCarson Labrado 2991fdd26906SClaire Weinan inline void handleLogServicesDumpCollectDiagnosticDataPost( 2992fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2993fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2994fdd26906SClaire Weinan { 2995fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2996fdd26906SClaire Weinan { 2997fdd26906SClaire Weinan return; 2998fdd26906SClaire Weinan } 2999fdd26906SClaire Weinan createDump(asyncResp, req, dumpType); 3000fdd26906SClaire Weinan } 3001fdd26906SClaire Weinan 300222d268cbSEd Tanous inline void handleLogServicesDumpCollectDiagnosticDataComputerSystemPost( 300322d268cbSEd Tanous crow::App& app, const crow::Request& req, 300422d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 30057f3e84a1SEd Tanous const std::string& systemName) 300622d268cbSEd Tanous { 300722d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 300822d268cbSEd Tanous { 300922d268cbSEd Tanous return; 301022d268cbSEd Tanous } 30117f3e84a1SEd Tanous 30127f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 301322d268cbSEd Tanous { 30147f3e84a1SEd Tanous // Option currently returns no systems. TBD 30157f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 30167f3e84a1SEd Tanous systemName); 30177f3e84a1SEd Tanous return; 30187f3e84a1SEd Tanous } 30197f3e84a1SEd Tanous if (systemName != "system") 30207f3e84a1SEd Tanous { 30217f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 30227f3e84a1SEd Tanous systemName); 302322d268cbSEd Tanous return; 302422d268cbSEd Tanous } 302522d268cbSEd Tanous createDump(asyncResp, req, "System"); 302622d268cbSEd Tanous } 302722d268cbSEd Tanous 3028fdd26906SClaire Weinan inline void handleLogServicesDumpClearLogPost( 3029fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 3030fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 3031fdd26906SClaire Weinan { 3032fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3033fdd26906SClaire Weinan { 3034fdd26906SClaire Weinan return; 3035fdd26906SClaire Weinan } 3036fdd26906SClaire Weinan clearDump(asyncResp, dumpType); 3037fdd26906SClaire Weinan } 3038fdd26906SClaire Weinan 303922d268cbSEd Tanous inline void handleLogServicesDumpClearLogComputerSystemPost( 304022d268cbSEd Tanous crow::App& app, const crow::Request& req, 304122d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 30427f3e84a1SEd Tanous const std::string& systemName) 304322d268cbSEd Tanous { 304422d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 304522d268cbSEd Tanous { 304622d268cbSEd Tanous return; 304722d268cbSEd Tanous } 30487f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 304922d268cbSEd Tanous { 30507f3e84a1SEd Tanous // Option currently returns no systems. TBD 30517f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 30527f3e84a1SEd Tanous systemName); 30537f3e84a1SEd Tanous return; 30547f3e84a1SEd Tanous } 30557f3e84a1SEd Tanous if (systemName != "system") 30567f3e84a1SEd Tanous { 30577f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 30587f3e84a1SEd Tanous systemName); 305922d268cbSEd Tanous return; 306022d268cbSEd Tanous } 306122d268cbSEd Tanous clearDump(asyncResp, "System"); 306222d268cbSEd Tanous } 306322d268cbSEd Tanous 3064fdd26906SClaire Weinan inline void requestRoutesBMCDumpService(App& app) 3065fdd26906SClaire Weinan { 3066fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/") 3067fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 3068fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 3069fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "BMC")); 3070fdd26906SClaire Weinan } 3071fdd26906SClaire Weinan 3072fdd26906SClaire Weinan inline void requestRoutesBMCDumpEntryCollection(App& app) 3073fdd26906SClaire Weinan { 3074fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/") 3075fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 3076fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 3077fdd26906SClaire Weinan handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC")); 3078c9bb6861Sraviteja-b } 3079c9bb6861Sraviteja-b 30807e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app) 3081c9bb6861Sraviteja-b { 30827e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 30837e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 3084ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 3085fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 3086fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "BMC")); 3087fdd26906SClaire Weinan 30887e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 30897e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 3090ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 3091fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 3092fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "BMC")); 3093c9bb6861Sraviteja-b } 3094c9bb6861Sraviteja-b 3095168d1b1aSCarson Labrado inline void requestRoutesBMCDumpEntryDownload(App& app) 3096168d1b1aSCarson Labrado { 3097168d1b1aSCarson Labrado BMCWEB_ROUTE( 3098168d1b1aSCarson Labrado app, 30999e9d99daSRavi Teja "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/attachment/") 3100168d1b1aSCarson Labrado .privileges(redfish::privileges::getLogEntry) 3101168d1b1aSCarson Labrado .methods(boost::beast::http::verb::get)(std::bind_front( 3102168d1b1aSCarson Labrado handleLogServicesDumpEntryDownloadGet, std::ref(app), "BMC")); 3103168d1b1aSCarson Labrado } 3104168d1b1aSCarson Labrado 31057e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app) 3106c9bb6861Sraviteja-b { 31070fda0f12SGeorge Liu BMCWEB_ROUTE( 31080fda0f12SGeorge Liu app, 31090fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 3110ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 31117e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 3112fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost, 3113fdd26906SClaire Weinan std::ref(app), "BMC")); 3114a43be80fSAsmitha Karunanithi } 3115a43be80fSAsmitha Karunanithi 31167e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app) 311780319af1SAsmitha Karunanithi { 31180fda0f12SGeorge Liu BMCWEB_ROUTE( 31190fda0f12SGeorge Liu app, 31200fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog/") 3121ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 3122fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 3123fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "BMC")); 312445ca1b86SEd Tanous } 3125fdd26906SClaire Weinan 3126168d1b1aSCarson Labrado inline void requestRoutesDBusEventLogEntryDownload(App& app) 3127168d1b1aSCarson Labrado { 3128168d1b1aSCarson Labrado BMCWEB_ROUTE( 3129168d1b1aSCarson Labrado app, 31309e9d99daSRavi Teja "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/attachment/") 3131168d1b1aSCarson Labrado .privileges(redfish::privileges::getLogEntry) 3132168d1b1aSCarson Labrado .methods(boost::beast::http::verb::get)(std::bind_front( 3133168d1b1aSCarson Labrado handleDBusEventLogEntryDownloadGet, std::ref(app), "System")); 3134168d1b1aSCarson Labrado } 3135168d1b1aSCarson Labrado 3136fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpService(App& app) 3137fdd26906SClaire Weinan { 3138fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/") 3139fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 3140fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 3141fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "FaultLog")); 3142fdd26906SClaire Weinan } 3143fdd26906SClaire Weinan 3144fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntryCollection(App& app) 3145fdd26906SClaire Weinan { 3146fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/") 3147fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 3148fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 3149fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpEntriesCollectionGet, 3150fdd26906SClaire Weinan std::ref(app), "FaultLog")); 3151fdd26906SClaire Weinan } 3152fdd26906SClaire Weinan 3153fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntry(App& app) 3154fdd26906SClaire Weinan { 3155fdd26906SClaire Weinan BMCWEB_ROUTE(app, 3156fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 3157fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntry) 3158fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 3159fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "FaultLog")); 3160fdd26906SClaire Weinan 3161fdd26906SClaire Weinan BMCWEB_ROUTE(app, 3162fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 3163fdd26906SClaire Weinan .privileges(redfish::privileges::deleteLogEntry) 3164fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 3165fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog")); 3166fdd26906SClaire Weinan } 3167fdd26906SClaire Weinan 3168fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpClear(App& app) 3169fdd26906SClaire Weinan { 3170fdd26906SClaire Weinan BMCWEB_ROUTE( 3171fdd26906SClaire Weinan app, 3172fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog/") 3173fdd26906SClaire Weinan .privileges(redfish::privileges::postLogService) 3174fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 3175fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog")); 31765cb1dd27SAsmitha Karunanithi } 31775cb1dd27SAsmitha Karunanithi 31787e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app) 31795cb1dd27SAsmitha Karunanithi { 318022d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/") 3181ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 31826ab9ad54SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 318322d268cbSEd Tanous handleLogServicesDumpServiceComputerSystemGet, std::ref(app))); 31845cb1dd27SAsmitha Karunanithi } 31855cb1dd27SAsmitha Karunanithi 31867e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app) 31877e860f15SJohn Edward Broadbent { 318822d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/") 3189ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 319022d268cbSEd Tanous .methods(boost::beast::http::verb::get)(std::bind_front( 319122d268cbSEd Tanous handleLogServicesDumpEntriesCollectionComputerSystemGet, 319222d268cbSEd Tanous std::ref(app))); 31935cb1dd27SAsmitha Karunanithi } 31945cb1dd27SAsmitha Karunanithi 31957e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app) 31965cb1dd27SAsmitha Karunanithi { 31977e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 319822d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/") 3199ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 32006ab9ad54SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 320122d268cbSEd Tanous handleLogServicesDumpEntryComputerSystemGet, std::ref(app))); 32028d1b46d7Szhanghch05 32037e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 320422d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/") 3205ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 32066ab9ad54SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 320722d268cbSEd Tanous handleLogServicesDumpEntryComputerSystemDelete, std::ref(app))); 32085cb1dd27SAsmitha Karunanithi } 3209c9bb6861Sraviteja-b 32107e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app) 3211c9bb6861Sraviteja-b { 32120fda0f12SGeorge Liu BMCWEB_ROUTE( 32130fda0f12SGeorge Liu app, 321422d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 3215ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 321622d268cbSEd Tanous .methods(boost::beast::http::verb::post)(std::bind_front( 321722d268cbSEd Tanous handleLogServicesDumpCollectDiagnosticDataComputerSystemPost, 321822d268cbSEd Tanous std::ref(app))); 3219a43be80fSAsmitha Karunanithi } 3220a43be80fSAsmitha Karunanithi 32217e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app) 3222a43be80fSAsmitha Karunanithi { 32230fda0f12SGeorge Liu BMCWEB_ROUTE( 32240fda0f12SGeorge Liu app, 322522d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.ClearLog/") 3226ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 32276ab9ad54SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 322822d268cbSEd Tanous handleLogServicesDumpClearLogComputerSystemPost, std::ref(app))); 3229013487e5Sraviteja-b } 3230013487e5Sraviteja-b 32317e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app) 32321da66f75SEd Tanous { 32333946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 32343946028dSAppaRao Puli // method for security reasons. 32351da66f75SEd Tanous /** 32361da66f75SEd Tanous * Functions triggers appropriate requests on DBus 32371da66f75SEd Tanous */ 323822d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/") 3239ed398213SEd Tanous // This is incorrect, should be: 3240ed398213SEd Tanous //.privileges(redfish::privileges::getLogService) 3241432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 3242002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 3243002d39b4SEd Tanous [&app](const crow::Request& req, 324422d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 324522d268cbSEd Tanous const std::string& systemName) { 32463ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 324745ca1b86SEd Tanous { 324845ca1b86SEd Tanous return; 324945ca1b86SEd Tanous } 32507f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 32517f3e84a1SEd Tanous { 32527f3e84a1SEd Tanous // Option currently returns no systems. TBD 32537f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 32547f3e84a1SEd Tanous systemName); 32557f3e84a1SEd Tanous return; 32567f3e84a1SEd Tanous } 325722d268cbSEd Tanous if (systemName != "system") 325822d268cbSEd Tanous { 325922d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 326022d268cbSEd Tanous systemName); 326122d268cbSEd Tanous return; 326222d268cbSEd Tanous } 326322d268cbSEd Tanous 32647e860f15SJohn Edward Broadbent // Copy over the static data to include the entries added by 32657e860f15SJohn Edward Broadbent // SubRoute 32660f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 3267424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"; 3268e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 32698e6c099aSJason M. Bills "#LogService.v1_2_0.LogService"; 32704f50ae4bSGunnar Mills asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service"; 32714f50ae4bSGunnar Mills asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service"; 327215b89725SV-Sanjana asyncResp->res.jsonValue["Id"] = "Crashdump"; 3273e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 3274e1f26343SJason M. Bills asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; 32757c8c4058STejas Patil 32767c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 32772b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 32787c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 32797c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 32807c8c4058STejas Patil redfishDateTimeOffset.second; 32817c8c4058STejas Patil 32821476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 3283ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 3284002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 32851476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog"; 3286002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 32871476687dSEd Tanous ["target"] = 32881476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData"; 32897e860f15SJohn Edward Broadbent }); 32901da66f75SEd Tanous } 32911da66f75SEd Tanous 32927e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app) 32935b61b5e8SJason M. Bills { 32940fda0f12SGeorge Liu BMCWEB_ROUTE( 32950fda0f12SGeorge Liu app, 329622d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.ClearLog/") 3297ed398213SEd Tanous // This is incorrect, should be: 3298ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3299432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 33007e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 330145ca1b86SEd Tanous [&app](const crow::Request& req, 330222d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 330322d268cbSEd Tanous const std::string& systemName) { 33043ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 330545ca1b86SEd Tanous { 330645ca1b86SEd Tanous return; 330745ca1b86SEd Tanous } 33087f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 33097f3e84a1SEd Tanous { 33107f3e84a1SEd Tanous // Option currently returns no systems. TBD 33117f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 33127f3e84a1SEd Tanous systemName); 33137f3e84a1SEd Tanous return; 33147f3e84a1SEd Tanous } 331522d268cbSEd Tanous if (systemName != "system") 331622d268cbSEd Tanous { 331722d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 331822d268cbSEd Tanous systemName); 331922d268cbSEd Tanous return; 332022d268cbSEd Tanous } 33215b61b5e8SJason M. Bills crow::connections::systemBus->async_method_call( 33225e7e2dc5SEd Tanous [asyncResp](const boost::system::error_code& ec, 3323cb13a392SEd Tanous const std::string&) { 33245b61b5e8SJason M. Bills if (ec) 33255b61b5e8SJason M. Bills { 33265b61b5e8SJason M. Bills messages::internalError(asyncResp->res); 33275b61b5e8SJason M. Bills return; 33285b61b5e8SJason M. Bills } 33295b61b5e8SJason M. Bills messages::success(asyncResp->res); 33305b61b5e8SJason M. Bills }, 3331002d39b4SEd Tanous crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll"); 33327e860f15SJohn Edward Broadbent }); 33335b61b5e8SJason M. Bills } 33345b61b5e8SJason M. Bills 33358d1b46d7Szhanghch05 static void 33368d1b46d7Szhanghch05 logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 33378d1b46d7Szhanghch05 const std::string& logID, nlohmann::json& logEntryJson) 3338e855dd28SJason M. Bills { 3339043a0536SJohnathan Mantey auto getStoredLogCallback = 3340b9d36b47SEd Tanous [asyncResp, logID, 33415e7e2dc5SEd Tanous &logEntryJson](const boost::system::error_code& ec, 3342b9d36b47SEd Tanous const dbus::utility::DBusPropertiesMap& params) { 3343e855dd28SJason M. Bills if (ec) 3344e855dd28SJason M. Bills { 334562598e31SEd Tanous BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message()); 33461ddcf01aSJason M. Bills if (ec.value() == 33471ddcf01aSJason M. Bills boost::system::linux_error::bad_request_descriptor) 33481ddcf01aSJason M. Bills { 3349002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 33501ddcf01aSJason M. Bills } 33511ddcf01aSJason M. Bills else 33521ddcf01aSJason M. Bills { 3353e855dd28SJason M. Bills messages::internalError(asyncResp->res); 33541ddcf01aSJason M. Bills } 3355e855dd28SJason M. Bills return; 3356e855dd28SJason M. Bills } 3357043a0536SJohnathan Mantey 3358043a0536SJohnathan Mantey std::string timestamp{}; 3359043a0536SJohnathan Mantey std::string filename{}; 3360043a0536SJohnathan Mantey std::string logfile{}; 33612c70f800SEd Tanous parseCrashdumpParameters(params, filename, timestamp, logfile); 3362043a0536SJohnathan Mantey 3363043a0536SJohnathan Mantey if (filename.empty() || timestamp.empty()) 3364e855dd28SJason M. Bills { 33659db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 3366e855dd28SJason M. Bills return; 3367e855dd28SJason M. Bills } 3368e855dd28SJason M. Bills 3369043a0536SJohnathan Mantey std::string crashdumpURI = 3370e855dd28SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + 3371043a0536SJohnathan Mantey logID + "/" + filename; 337284afc48bSJason M. Bills nlohmann::json::object_t logEntry; 33739c11a172SVijay Lobo logEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 3374ef4c65b7SEd Tanous logEntry["@odata.id"] = boost::urls::format( 3375ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/{}", 3376ef4c65b7SEd Tanous logID); 337784afc48bSJason M. Bills logEntry["Name"] = "CPU Crashdump"; 337884afc48bSJason M. Bills logEntry["Id"] = logID; 337984afc48bSJason M. Bills logEntry["EntryType"] = "Oem"; 338084afc48bSJason M. Bills logEntry["AdditionalDataURI"] = std::move(crashdumpURI); 338184afc48bSJason M. Bills logEntry["DiagnosticDataType"] = "OEM"; 338284afc48bSJason M. Bills logEntry["OEMDiagnosticDataType"] = "PECICrashdump"; 338384afc48bSJason M. Bills logEntry["Created"] = std::move(timestamp); 33842b20ef6eSJason M. Bills 33852b20ef6eSJason M. Bills // If logEntryJson references an array of LogEntry resources 33862b20ef6eSJason M. Bills // ('Members' list), then push this as a new entry, otherwise set it 33872b20ef6eSJason M. Bills // directly 33882b20ef6eSJason M. Bills if (logEntryJson.is_array()) 33892b20ef6eSJason M. Bills { 33902b20ef6eSJason M. Bills logEntryJson.push_back(logEntry); 33912b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 33922b20ef6eSJason M. Bills logEntryJson.size(); 33932b20ef6eSJason M. Bills } 33942b20ef6eSJason M. Bills else 33952b20ef6eSJason M. Bills { 3396d405bb51SJason M. Bills logEntryJson.update(logEntry); 33972b20ef6eSJason M. Bills } 3398e855dd28SJason M. Bills }; 3399d1bde9e5SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 3400d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, crashdumpObject, 3401d1bde9e5SKrzysztof Grobelny crashdumpPath + std::string("/") + logID, crashdumpInterface, 3402d1bde9e5SKrzysztof Grobelny std::move(getStoredLogCallback)); 3403e855dd28SJason M. Bills } 3404e855dd28SJason M. Bills 34057e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app) 34061da66f75SEd Tanous { 34073946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 34083946028dSAppaRao Puli // method for security reasons. 34091da66f75SEd Tanous /** 34101da66f75SEd Tanous * Functions triggers appropriate requests on DBus 34111da66f75SEd Tanous */ 34127e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 341322d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/") 3414ed398213SEd Tanous // This is incorrect, should be. 3415ed398213SEd Tanous //.privileges(redfish::privileges::postLogEntryCollection) 3416432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 3417002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 3418002d39b4SEd Tanous [&app](const crow::Request& req, 341922d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 342022d268cbSEd Tanous const std::string& systemName) { 34213ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 342245ca1b86SEd Tanous { 342345ca1b86SEd Tanous return; 342445ca1b86SEd Tanous } 34257f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 34267f3e84a1SEd Tanous { 34277f3e84a1SEd Tanous // Option currently returns no systems. TBD 34287f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 34297f3e84a1SEd Tanous systemName); 34307f3e84a1SEd Tanous return; 34317f3e84a1SEd Tanous } 343222d268cbSEd Tanous if (systemName != "system") 343322d268cbSEd Tanous { 343422d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 343522d268cbSEd Tanous systemName); 343622d268cbSEd Tanous return; 343722d268cbSEd Tanous } 343822d268cbSEd Tanous 34397a1dbc48SGeorge Liu constexpr std::array<std::string_view, 1> interfaces = { 34407a1dbc48SGeorge Liu crashdumpInterface}; 34417a1dbc48SGeorge Liu dbus::utility::getSubTreePaths( 34427a1dbc48SGeorge Liu "/", 0, interfaces, 34437a1dbc48SGeorge Liu [asyncResp](const boost::system::error_code& ec, 34442b20ef6eSJason M. Bills const std::vector<std::string>& resp) { 34451da66f75SEd Tanous if (ec) 34461da66f75SEd Tanous { 34471da66f75SEd Tanous if (ec.value() != 34481da66f75SEd Tanous boost::system::errc::no_such_file_or_directory) 34491da66f75SEd Tanous { 345062598e31SEd Tanous BMCWEB_LOG_DEBUG("failed to get entries ec: {}", 345162598e31SEd Tanous ec.message()); 3452f12894f8SJason M. Bills messages::internalError(asyncResp->res); 34531da66f75SEd Tanous return; 34541da66f75SEd Tanous } 34551da66f75SEd Tanous } 3456e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 34571da66f75SEd Tanous "#LogEntryCollection.LogEntryCollection"; 34580f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 3459424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 3460002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries"; 3461e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 3462424c4176SJason M. Bills "Collection of Crashdump Entries"; 3463002d39b4SEd Tanous asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3464a2dd60a6SBrandon Kim asyncResp->res.jsonValue["Members@odata.count"] = 0; 34652b20ef6eSJason M. Bills 34662b20ef6eSJason M. Bills for (const std::string& path : resp) 34671da66f75SEd Tanous { 34682b20ef6eSJason M. Bills const sdbusplus::message::object_path objPath(path); 3469e855dd28SJason M. Bills // Get the log ID 34702b20ef6eSJason M. Bills std::string logID = objPath.filename(); 34712b20ef6eSJason M. Bills if (logID.empty()) 34721da66f75SEd Tanous { 3473e855dd28SJason M. Bills continue; 34741da66f75SEd Tanous } 3475e855dd28SJason M. Bills // Add the log entry to the array 34762b20ef6eSJason M. Bills logCrashdumpEntry(asyncResp, logID, 34772b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members"]); 34781da66f75SEd Tanous } 34797a1dbc48SGeorge Liu }); 34807e860f15SJohn Edward Broadbent }); 34811da66f75SEd Tanous } 34821da66f75SEd Tanous 34837e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app) 34841da66f75SEd Tanous { 34853946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 34863946028dSAppaRao Puli // method for security reasons. 34871da66f75SEd Tanous 34887e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 348922d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/") 3490ed398213SEd Tanous // this is incorrect, should be 3491ed398213SEd Tanous // .privileges(redfish::privileges::getLogEntry) 3492432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 34937e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 349445ca1b86SEd Tanous [&app](const crow::Request& req, 34957e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 349622d268cbSEd Tanous const std::string& systemName, const std::string& param) { 34973ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 349845ca1b86SEd Tanous { 349945ca1b86SEd Tanous return; 350045ca1b86SEd Tanous } 35017f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 35027f3e84a1SEd Tanous { 35037f3e84a1SEd Tanous // Option currently returns no systems. TBD 35047f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 35057f3e84a1SEd Tanous systemName); 35067f3e84a1SEd Tanous return; 35077f3e84a1SEd Tanous } 350822d268cbSEd Tanous if (systemName != "system") 350922d268cbSEd Tanous { 351022d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 351122d268cbSEd Tanous systemName); 351222d268cbSEd Tanous return; 351322d268cbSEd Tanous } 35147e860f15SJohn Edward Broadbent const std::string& logID = param; 3515e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue); 35167e860f15SJohn Edward Broadbent }); 3517e855dd28SJason M. Bills } 3518e855dd28SJason M. Bills 35197e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app) 3520e855dd28SJason M. Bills { 35213946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 35223946028dSAppaRao Puli // method for security reasons. 35237e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 35247e860f15SJohn Edward Broadbent app, 352522d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/<str>/") 3526ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 35277e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 3528a4ce114aSNan Zhou [](const crow::Request& req, 35297e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 353022d268cbSEd Tanous const std::string& systemName, const std::string& logID, 353122d268cbSEd Tanous const std::string& fileName) { 35322a9beeedSShounak Mitra // Do not call getRedfishRoute here since the crashdump file is not a 35332a9beeedSShounak Mitra // Redfish resource. 353422d268cbSEd Tanous 35357f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 35367f3e84a1SEd Tanous { 35377f3e84a1SEd Tanous // Option currently returns no systems. TBD 35387f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 35397f3e84a1SEd Tanous systemName); 35407f3e84a1SEd Tanous return; 35417f3e84a1SEd Tanous } 354222d268cbSEd Tanous if (systemName != "system") 354322d268cbSEd Tanous { 354422d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 354522d268cbSEd Tanous systemName); 354622d268cbSEd Tanous return; 354722d268cbSEd Tanous } 354822d268cbSEd Tanous 3549043a0536SJohnathan Mantey auto getStoredLogCallback = 355039662a3bSEd Tanous [asyncResp, logID, fileName, url(boost::urls::url(req.url()))]( 35515e7e2dc5SEd Tanous const boost::system::error_code& ec, 3552002d39b4SEd Tanous const std::vector< 3553002d39b4SEd Tanous std::pair<std::string, dbus::utility::DbusVariantType>>& 35547e860f15SJohn Edward Broadbent resp) { 35551da66f75SEd Tanous if (ec) 35561da66f75SEd Tanous { 355762598e31SEd Tanous BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message()); 3558f12894f8SJason M. Bills messages::internalError(asyncResp->res); 35591da66f75SEd Tanous return; 35601da66f75SEd Tanous } 3561e855dd28SJason M. Bills 3562043a0536SJohnathan Mantey std::string dbusFilename{}; 3563043a0536SJohnathan Mantey std::string dbusTimestamp{}; 3564043a0536SJohnathan Mantey std::string dbusFilepath{}; 3565043a0536SJohnathan Mantey 3566002d39b4SEd Tanous parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp, 3567002d39b4SEd Tanous dbusFilepath); 3568043a0536SJohnathan Mantey 3569043a0536SJohnathan Mantey if (dbusFilename.empty() || dbusTimestamp.empty() || 3570043a0536SJohnathan Mantey dbusFilepath.empty()) 35711da66f75SEd Tanous { 35729db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 35731da66f75SEd Tanous return; 35741da66f75SEd Tanous } 3575e855dd28SJason M. Bills 3576043a0536SJohnathan Mantey // Verify the file name parameter is correct 3577043a0536SJohnathan Mantey if (fileName != dbusFilename) 3578043a0536SJohnathan Mantey { 35799db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 3580043a0536SJohnathan Mantey return; 3581043a0536SJohnathan Mantey } 3582043a0536SJohnathan Mantey 358327b0cf90SEd Tanous if (!asyncResp->res.openFile(dbusFilepath)) 3584043a0536SJohnathan Mantey { 35859db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 3586043a0536SJohnathan Mantey return; 3587043a0536SJohnathan Mantey } 3588043a0536SJohnathan Mantey 35897e860f15SJohn Edward Broadbent // Configure this to be a file download when accessed 35907e860f15SJohn Edward Broadbent // from a browser 3591d9f6c621SEd Tanous asyncResp->res.addHeader( 3592d9f6c621SEd Tanous boost::beast::http::field::content_disposition, "attachment"); 35931da66f75SEd Tanous }; 3594d1bde9e5SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 3595d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, crashdumpObject, 3596d1bde9e5SKrzysztof Grobelny crashdumpPath + std::string("/") + logID, crashdumpInterface, 3597d1bde9e5SKrzysztof Grobelny std::move(getStoredLogCallback)); 35987e860f15SJohn Edward Broadbent }); 35991da66f75SEd Tanous } 36001da66f75SEd Tanous 3601c5a4c82aSJason M. Bills enum class OEMDiagnosticType 3602c5a4c82aSJason M. Bills { 3603c5a4c82aSJason M. Bills onDemand, 3604c5a4c82aSJason M. Bills telemetry, 3605c5a4c82aSJason M. Bills invalid, 3606c5a4c82aSJason M. Bills }; 3607c5a4c82aSJason M. Bills 360826ccae32SEd Tanous inline OEMDiagnosticType getOEMDiagnosticType(std::string_view oemDiagStr) 3609c5a4c82aSJason M. Bills { 3610c5a4c82aSJason M. Bills if (oemDiagStr == "OnDemand") 3611c5a4c82aSJason M. Bills { 3612c5a4c82aSJason M. Bills return OEMDiagnosticType::onDemand; 3613c5a4c82aSJason M. Bills } 3614c5a4c82aSJason M. Bills if (oemDiagStr == "Telemetry") 3615c5a4c82aSJason M. Bills { 3616c5a4c82aSJason M. Bills return OEMDiagnosticType::telemetry; 3617c5a4c82aSJason M. Bills } 3618c5a4c82aSJason M. Bills 3619c5a4c82aSJason M. Bills return OEMDiagnosticType::invalid; 3620c5a4c82aSJason M. Bills } 3621c5a4c82aSJason M. Bills 36227e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app) 36231da66f75SEd Tanous { 36243946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 36253946028dSAppaRao Puli // method for security reasons. 36260fda0f12SGeorge Liu BMCWEB_ROUTE( 36270fda0f12SGeorge Liu app, 362822d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/") 3629ed398213SEd Tanous // The below is incorrect; Should be ConfigureManager 3630ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3631432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 3632002d39b4SEd Tanous .methods(boost::beast::http::verb::post)( 3633002d39b4SEd Tanous [&app](const crow::Request& req, 363422d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 363522d268cbSEd Tanous const std::string& systemName) { 36363ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 363745ca1b86SEd Tanous { 363845ca1b86SEd Tanous return; 363945ca1b86SEd Tanous } 364022d268cbSEd Tanous 36417f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 36427f3e84a1SEd Tanous { 36437f3e84a1SEd Tanous // Option currently returns no systems. TBD 36447f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 36457f3e84a1SEd Tanous systemName); 36467f3e84a1SEd Tanous return; 36477f3e84a1SEd Tanous } 364822d268cbSEd Tanous if (systemName != "system") 364922d268cbSEd Tanous { 365022d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 365122d268cbSEd Tanous systemName); 365222d268cbSEd Tanous return; 365322d268cbSEd Tanous } 365422d268cbSEd Tanous 36558e6c099aSJason M. Bills std::string diagnosticDataType; 36568e6c099aSJason M. Bills std::string oemDiagnosticDataType; 365715ed6780SWilly Tu if (!redfish::json_util::readJsonAction( 3658002d39b4SEd Tanous req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 3659002d39b4SEd Tanous "OEMDiagnosticDataType", oemDiagnosticDataType)) 36608e6c099aSJason M. Bills { 36618e6c099aSJason M. Bills return; 36628e6c099aSJason M. Bills } 36638e6c099aSJason M. Bills 36648e6c099aSJason M. Bills if (diagnosticDataType != "OEM") 36658e6c099aSJason M. Bills { 366662598e31SEd Tanous BMCWEB_LOG_ERROR( 366762598e31SEd Tanous "Only OEM DiagnosticDataType supported for Crashdump"); 36688e6c099aSJason M. Bills messages::actionParameterValueFormatError( 36698e6c099aSJason M. Bills asyncResp->res, diagnosticDataType, "DiagnosticDataType", 36708e6c099aSJason M. Bills "CollectDiagnosticData"); 36718e6c099aSJason M. Bills return; 36728e6c099aSJason M. Bills } 36738e6c099aSJason M. Bills 3674c5a4c82aSJason M. Bills OEMDiagnosticType oemDiagType = 3675c5a4c82aSJason M. Bills getOEMDiagnosticType(oemDiagnosticDataType); 3676c5a4c82aSJason M. Bills 3677c5a4c82aSJason M. Bills std::string iface; 3678c5a4c82aSJason M. Bills std::string method; 3679c5a4c82aSJason M. Bills std::string taskMatchStr; 3680c5a4c82aSJason M. Bills if (oemDiagType == OEMDiagnosticType::onDemand) 3681c5a4c82aSJason M. Bills { 3682c5a4c82aSJason M. Bills iface = crashdumpOnDemandInterface; 3683c5a4c82aSJason M. Bills method = "GenerateOnDemandLog"; 3684c5a4c82aSJason M. Bills taskMatchStr = "type='signal'," 3685c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 3686c5a4c82aSJason M. Bills "member='PropertiesChanged'," 3687c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 3688c5a4c82aSJason M. Bills } 3689c5a4c82aSJason M. Bills else if (oemDiagType == OEMDiagnosticType::telemetry) 3690c5a4c82aSJason M. Bills { 3691c5a4c82aSJason M. Bills iface = crashdumpTelemetryInterface; 3692c5a4c82aSJason M. Bills method = "GenerateTelemetryLog"; 3693c5a4c82aSJason M. Bills taskMatchStr = "type='signal'," 3694c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 3695c5a4c82aSJason M. Bills "member='PropertiesChanged'," 3696c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 3697c5a4c82aSJason M. Bills } 3698c5a4c82aSJason M. Bills else 3699c5a4c82aSJason M. Bills { 370062598e31SEd Tanous BMCWEB_LOG_ERROR("Unsupported OEMDiagnosticDataType: {}", 370162598e31SEd Tanous oemDiagnosticDataType); 3702c5a4c82aSJason M. Bills messages::actionParameterValueFormatError( 3703002d39b4SEd Tanous asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType", 3704002d39b4SEd Tanous "CollectDiagnosticData"); 3705c5a4c82aSJason M. Bills return; 3706c5a4c82aSJason M. Bills } 3707c5a4c82aSJason M. Bills 3708c5a4c82aSJason M. Bills auto collectCrashdumpCallback = 3709c5a4c82aSJason M. Bills [asyncResp, payload(task::Payload(req)), 37105e7e2dc5SEd Tanous taskMatchStr](const boost::system::error_code& ec, 371198be3e39SEd Tanous const std::string&) mutable { 37121da66f75SEd Tanous if (ec) 37131da66f75SEd Tanous { 3714002d39b4SEd Tanous if (ec.value() == boost::system::errc::operation_not_supported) 37151da66f75SEd Tanous { 3716f12894f8SJason M. Bills messages::resourceInStandby(asyncResp->res); 37171da66f75SEd Tanous } 37184363d3b2SJason M. Bills else if (ec.value() == 37194363d3b2SJason M. Bills boost::system::errc::device_or_resource_busy) 37204363d3b2SJason M. Bills { 3721002d39b4SEd Tanous messages::serviceTemporarilyUnavailable(asyncResp->res, 3722002d39b4SEd Tanous "60"); 37234363d3b2SJason M. Bills } 37241da66f75SEd Tanous else 37251da66f75SEd Tanous { 3726f12894f8SJason M. Bills messages::internalError(asyncResp->res); 37271da66f75SEd Tanous } 37281da66f75SEd Tanous return; 37291da66f75SEd Tanous } 3730002d39b4SEd Tanous std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 37318b24275dSEd Tanous [](const boost::system::error_code& ec2, sdbusplus::message_t&, 3732002d39b4SEd Tanous const std::shared_ptr<task::TaskData>& taskData) { 37338b24275dSEd Tanous if (!ec2) 373466afe4faSJames Feist { 3735002d39b4SEd Tanous taskData->messages.emplace_back(messages::taskCompletedOK( 3736e5d5006bSJames Feist std::to_string(taskData->index))); 3737831d6b09SJames Feist taskData->state = "Completed"; 373866afe4faSJames Feist } 373932898ceaSJames Feist return task::completed; 374066afe4faSJames Feist }, 3741c5a4c82aSJason M. Bills taskMatchStr); 3742c5a4c82aSJason M. Bills 374346229577SJames Feist task->startTimer(std::chrono::minutes(5)); 374446229577SJames Feist task->populateResp(asyncResp->res); 374598be3e39SEd Tanous task->payload.emplace(std::move(payload)); 37461da66f75SEd Tanous }; 37478e6c099aSJason M. Bills 37481da66f75SEd Tanous crow::connections::systemBus->async_method_call( 3749002d39b4SEd Tanous std::move(collectCrashdumpCallback), crashdumpObject, crashdumpPath, 3750002d39b4SEd Tanous iface, method); 37517e860f15SJohn Edward Broadbent }); 37526eda7685SKenny L. Ku } 37536eda7685SKenny L. Ku 3754cb92c03bSAndrew Geissler /** 3755cb92c03bSAndrew Geissler * DBusLogServiceActionsClear class supports POST method for ClearLog action. 3756cb92c03bSAndrew Geissler */ 37577e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app) 3758cb92c03bSAndrew Geissler { 3759cb92c03bSAndrew Geissler /** 3760cb92c03bSAndrew Geissler * Function handles POST method request. 3761cb92c03bSAndrew Geissler * The Clear Log actions does not require any parameter.The action deletes 3762cb92c03bSAndrew Geissler * all entries found in the Entries collection for this Log Service. 3763cb92c03bSAndrew Geissler */ 37647e860f15SJohn Edward Broadbent 37650fda0f12SGeorge Liu BMCWEB_ROUTE( 37660fda0f12SGeorge Liu app, 376722d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/") 3768ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 37697e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 377045ca1b86SEd Tanous [&app](const crow::Request& req, 377122d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 377222d268cbSEd Tanous const std::string& systemName) { 37733ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 377445ca1b86SEd Tanous { 377545ca1b86SEd Tanous return; 377645ca1b86SEd Tanous } 37777f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 37787f3e84a1SEd Tanous { 37797f3e84a1SEd Tanous // Option currently returns no systems. TBD 37807f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 37817f3e84a1SEd Tanous systemName); 37827f3e84a1SEd Tanous return; 37837f3e84a1SEd Tanous } 378422d268cbSEd Tanous if (systemName != "system") 378522d268cbSEd Tanous { 378622d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 378722d268cbSEd Tanous systemName); 378822d268cbSEd Tanous return; 378922d268cbSEd Tanous } 379062598e31SEd Tanous BMCWEB_LOG_DEBUG("Do delete all entries."); 3791cb92c03bSAndrew Geissler 3792cb92c03bSAndrew Geissler // Process response from Logging service. 37935e7e2dc5SEd Tanous auto respHandler = [asyncResp](const boost::system::error_code& ec) { 379462598e31SEd Tanous BMCWEB_LOG_DEBUG("doClearLog resp_handler callback: Done"); 3795cb92c03bSAndrew Geissler if (ec) 3796cb92c03bSAndrew Geissler { 3797cb92c03bSAndrew Geissler // TODO Handle for specific error code 379862598e31SEd Tanous BMCWEB_LOG_ERROR("doClearLog resp_handler got error {}", ec); 3799cb92c03bSAndrew Geissler asyncResp->res.result( 3800cb92c03bSAndrew Geissler boost::beast::http::status::internal_server_error); 3801cb92c03bSAndrew Geissler return; 3802cb92c03bSAndrew Geissler } 3803cb92c03bSAndrew Geissler 3804002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::no_content); 3805cb92c03bSAndrew Geissler }; 3806cb92c03bSAndrew Geissler 3807cb92c03bSAndrew Geissler // Make call to Logging service to request Clear Log 3808cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 38092c70f800SEd Tanous respHandler, "xyz.openbmc_project.Logging", 3810cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging", 3811cb92c03bSAndrew Geissler "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 38127e860f15SJohn Edward Broadbent }); 3813cb92c03bSAndrew Geissler } 3814a3316fc6SZhikuiRen 3815a3316fc6SZhikuiRen /**************************************************** 3816a3316fc6SZhikuiRen * Redfish PostCode interfaces 3817a3316fc6SZhikuiRen * using DBUS interface: getPostCodesTS 3818a3316fc6SZhikuiRen ******************************************************/ 38197e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesLogService(App& app) 3820a3316fc6SZhikuiRen { 382122d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/") 3822ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 3823002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 3824002d39b4SEd Tanous [&app](const crow::Request& req, 382522d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 382622d268cbSEd Tanous const std::string& systemName) { 38273ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 382845ca1b86SEd Tanous { 382945ca1b86SEd Tanous return; 383045ca1b86SEd Tanous } 38317f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 38327f3e84a1SEd Tanous { 38337f3e84a1SEd Tanous // Option currently returns no systems. TBD 38347f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 38357f3e84a1SEd Tanous systemName); 38367f3e84a1SEd Tanous return; 38377f3e84a1SEd Tanous } 383822d268cbSEd Tanous if (systemName != "system") 383922d268cbSEd Tanous { 384022d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 384122d268cbSEd Tanous systemName); 384222d268cbSEd Tanous return; 384322d268cbSEd Tanous } 38441476687dSEd Tanous asyncResp->res.jsonValue["@odata.id"] = 38451476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes"; 38461476687dSEd Tanous asyncResp->res.jsonValue["@odata.type"] = 3847b25644a1SJanet Adkins "#LogService.v1_2_0.LogService"; 38481476687dSEd Tanous asyncResp->res.jsonValue["Name"] = "POST Code Log Service"; 38491476687dSEd Tanous asyncResp->res.jsonValue["Description"] = "POST Code Log Service"; 3850ed34a4adSEd Tanous asyncResp->res.jsonValue["Id"] = "PostCodes"; 38511476687dSEd Tanous asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 38521476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 38531476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 38547c8c4058STejas Patil 38557c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 38562b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 38570fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 38587c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 38597c8c4058STejas Patil redfishDateTimeOffset.second; 38607c8c4058STejas Patil 3861a3316fc6SZhikuiRen asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 38627e860f15SJohn Edward Broadbent {"target", 38630fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog"}}; 38647e860f15SJohn Edward Broadbent }); 3865a3316fc6SZhikuiRen } 3866a3316fc6SZhikuiRen 38677e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesClear(App& app) 3868a3316fc6SZhikuiRen { 38690fda0f12SGeorge Liu BMCWEB_ROUTE( 38700fda0f12SGeorge Liu app, 387122d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/PostCodes/Actions/LogService.ClearLog/") 3872ed398213SEd Tanous // The following privilege is incorrect; It should be ConfigureManager 3873ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3874432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 38757e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 387645ca1b86SEd Tanous [&app](const crow::Request& req, 387722d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 387822d268cbSEd Tanous const std::string& systemName) { 38793ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 388045ca1b86SEd Tanous { 388145ca1b86SEd Tanous return; 388245ca1b86SEd Tanous } 38837f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 38847f3e84a1SEd Tanous { 38857f3e84a1SEd Tanous // Option currently returns no systems. TBD 38867f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 38877f3e84a1SEd Tanous systemName); 38887f3e84a1SEd Tanous return; 38897f3e84a1SEd Tanous } 389022d268cbSEd Tanous if (systemName != "system") 389122d268cbSEd Tanous { 389222d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 389322d268cbSEd Tanous systemName); 389422d268cbSEd Tanous return; 389522d268cbSEd Tanous } 389662598e31SEd Tanous BMCWEB_LOG_DEBUG("Do delete all postcodes entries."); 3897a3316fc6SZhikuiRen 3898a3316fc6SZhikuiRen // Make call to post-code service to request clear all 3899a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 39005e7e2dc5SEd Tanous [asyncResp](const boost::system::error_code& ec) { 3901a3316fc6SZhikuiRen if (ec) 3902a3316fc6SZhikuiRen { 3903a3316fc6SZhikuiRen // TODO Handle for specific error code 390462598e31SEd Tanous BMCWEB_LOG_ERROR("doClearPostCodes resp_handler got error {}", 390562598e31SEd Tanous ec); 3906002d39b4SEd Tanous asyncResp->res.result( 3907002d39b4SEd Tanous boost::beast::http::status::internal_server_error); 3908a3316fc6SZhikuiRen messages::internalError(asyncResp->res); 3909a3316fc6SZhikuiRen return; 3910a3316fc6SZhikuiRen } 391118fc70c0STony Lee messages::success(asyncResp->res); 3912a3316fc6SZhikuiRen }, 391315124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 391415124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3915a3316fc6SZhikuiRen "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 39167e860f15SJohn Edward Broadbent }); 3917a3316fc6SZhikuiRen } 3918a3316fc6SZhikuiRen 39196f284d24SJiaqing Zhao /** 39206f284d24SJiaqing Zhao * @brief Parse post code ID and get the current value and index value 39216f284d24SJiaqing Zhao * eg: postCodeID=B1-2, currentValue=1, index=2 39226f284d24SJiaqing Zhao * 39236f284d24SJiaqing Zhao * @param[in] postCodeID Post Code ID 39246f284d24SJiaqing Zhao * @param[out] currentValue Current value 39256f284d24SJiaqing Zhao * @param[out] index Index value 39266f284d24SJiaqing Zhao * 39276f284d24SJiaqing Zhao * @return bool true if the parsing is successful, false the parsing fails 39286f284d24SJiaqing Zhao */ 39296f284d24SJiaqing Zhao inline static bool parsePostCode(const std::string& postCodeID, 39306f284d24SJiaqing Zhao uint64_t& currentValue, uint16_t& index) 39316f284d24SJiaqing Zhao { 39326f284d24SJiaqing Zhao std::vector<std::string> split; 393350ebd4afSEd Tanous bmcweb::split(split, postCodeID, '-'); 39346f284d24SJiaqing Zhao if (split.size() != 2 || split[0].length() < 2 || split[0].front() != 'B') 39356f284d24SJiaqing Zhao { 39366f284d24SJiaqing Zhao return false; 39376f284d24SJiaqing Zhao } 39386f284d24SJiaqing Zhao 393984396af9SPatrick Williams auto start = std::next(split[0].begin()); 394084396af9SPatrick Williams auto end = split[0].end(); 394184396af9SPatrick Williams auto [ptrIndex, ecIndex] = std::from_chars(&*start, &*end, index); 39426f284d24SJiaqing Zhao 394384396af9SPatrick Williams if (ptrIndex != &*end || ecIndex != std::errc()) 39446f284d24SJiaqing Zhao { 39456f284d24SJiaqing Zhao return false; 39466f284d24SJiaqing Zhao } 39476f284d24SJiaqing Zhao 394884396af9SPatrick Williams start = split[1].begin(); 394984396af9SPatrick Williams end = split[1].end(); 39506f284d24SJiaqing Zhao 395184396af9SPatrick Williams auto [ptrValue, ecValue] = std::from_chars(&*start, &*end, currentValue); 39526f284d24SJiaqing Zhao 395384396af9SPatrick Williams return ptrValue == &*end && ecValue == std::errc(); 39546f284d24SJiaqing Zhao } 39556f284d24SJiaqing Zhao 39566f284d24SJiaqing Zhao static bool fillPostCodeEntry( 3957ac106bf6SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 39586c9a279eSManojkiran Eda const boost::container::flat_map< 39596c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode, 3960a3316fc6SZhikuiRen const uint16_t bootIndex, const uint64_t codeIndex = 0, 3961a3316fc6SZhikuiRen const uint64_t skip = 0, const uint64_t top = 0) 3962a3316fc6SZhikuiRen { 3963a3316fc6SZhikuiRen // Get the Message from the MessageRegistry 3964fffb8c1fSEd Tanous const registries::Message* message = 3965fffb8c1fSEd Tanous registries::getMessage("OpenBMC.0.2.BIOSPOSTCode"); 3966a3316fc6SZhikuiRen 3967a3316fc6SZhikuiRen uint64_t currentCodeIndex = 0; 3968a3316fc6SZhikuiRen uint64_t firstCodeTimeUs = 0; 39696c9a279eSManojkiran Eda for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 39706c9a279eSManojkiran Eda code : postcode) 3971a3316fc6SZhikuiRen { 3972a3316fc6SZhikuiRen currentCodeIndex++; 3973a3316fc6SZhikuiRen std::string postcodeEntryID = 3974a3316fc6SZhikuiRen "B" + std::to_string(bootIndex) + "-" + 3975a3316fc6SZhikuiRen std::to_string(currentCodeIndex); // 1 based index in EntryID string 3976a3316fc6SZhikuiRen 3977a3316fc6SZhikuiRen uint64_t usecSinceEpoch = code.first; 3978a3316fc6SZhikuiRen uint64_t usTimeOffset = 0; 3979a3316fc6SZhikuiRen 3980a3316fc6SZhikuiRen if (1 == currentCodeIndex) 3981a3316fc6SZhikuiRen { // already incremented 3982a3316fc6SZhikuiRen firstCodeTimeUs = code.first; 3983a3316fc6SZhikuiRen } 3984a3316fc6SZhikuiRen else 3985a3316fc6SZhikuiRen { 3986a3316fc6SZhikuiRen usTimeOffset = code.first - firstCodeTimeUs; 3987a3316fc6SZhikuiRen } 3988a3316fc6SZhikuiRen 3989a3316fc6SZhikuiRen // skip if no specific codeIndex is specified and currentCodeIndex does 3990a3316fc6SZhikuiRen // not fall between top and skip 3991a3316fc6SZhikuiRen if ((codeIndex == 0) && 3992a3316fc6SZhikuiRen (currentCodeIndex <= skip || currentCodeIndex > top)) 3993a3316fc6SZhikuiRen { 3994a3316fc6SZhikuiRen continue; 3995a3316fc6SZhikuiRen } 3996a3316fc6SZhikuiRen 39974e0453b1SGunnar Mills // skip if a specific codeIndex is specified and does not match the 3998a3316fc6SZhikuiRen // currentIndex 3999a3316fc6SZhikuiRen if ((codeIndex > 0) && (currentCodeIndex != codeIndex)) 4000a3316fc6SZhikuiRen { 4001a3316fc6SZhikuiRen // This is done for simplicity. 1st entry is needed to calculate 4002a3316fc6SZhikuiRen // time offset. To improve efficiency, one can get to the entry 4003a3316fc6SZhikuiRen // directly (possibly with flatmap's nth method) 4004a3316fc6SZhikuiRen continue; 4005a3316fc6SZhikuiRen } 4006a3316fc6SZhikuiRen 4007a3316fc6SZhikuiRen // currentCodeIndex is within top and skip or equal to specified code 4008a3316fc6SZhikuiRen // index 4009a3316fc6SZhikuiRen 4010a3316fc6SZhikuiRen // Get the Created time from the timestamp 4011a3316fc6SZhikuiRen std::string entryTimeStr; 40122a025611SKonstantin Aladyshev entryTimeStr = redfish::time_utils::getDateTimeUintUs(usecSinceEpoch); 4013a3316fc6SZhikuiRen 4014a3316fc6SZhikuiRen // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex) 4015a3316fc6SZhikuiRen std::ostringstream hexCode; 4016a3316fc6SZhikuiRen hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex 40176c9a279eSManojkiran Eda << std::get<0>(code.second); 4018a3316fc6SZhikuiRen std::ostringstream timeOffsetStr; 4019a3316fc6SZhikuiRen // Set Fixed -Point Notation 4020a3316fc6SZhikuiRen timeOffsetStr << std::fixed; 4021a3316fc6SZhikuiRen // Set precision to 4 digits 4022a3316fc6SZhikuiRen timeOffsetStr << std::setprecision(4); 4023a3316fc6SZhikuiRen // Add double to stream 4024a3316fc6SZhikuiRen timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000; 4025a3316fc6SZhikuiRen 40261e6deaf6SEd Tanous std::string bootIndexStr = std::to_string(bootIndex); 40271e6deaf6SEd Tanous std::string timeOffsetString = timeOffsetStr.str(); 40281e6deaf6SEd Tanous std::string hexCodeStr = hexCode.str(); 4029a3316fc6SZhikuiRen 40301e6deaf6SEd Tanous std::array<std::string_view, 3> messageArgs = { 40311e6deaf6SEd Tanous bootIndexStr, timeOffsetString, hexCodeStr}; 40321e6deaf6SEd Tanous 40331e6deaf6SEd Tanous std::string msg = 40341e6deaf6SEd Tanous redfish::registries::fillMessageArgs(messageArgs, message->message); 40351e6deaf6SEd Tanous if (msg.empty()) 4036a3316fc6SZhikuiRen { 40371e6deaf6SEd Tanous messages::internalError(asyncResp->res); 40381e6deaf6SEd Tanous return false; 4039a3316fc6SZhikuiRen } 4040a3316fc6SZhikuiRen 4041d4342a92STim Lee // Get Severity template from message registry 4042d4342a92STim Lee std::string severity; 4043d4342a92STim Lee if (message != nullptr) 4044d4342a92STim Lee { 40455f2b84eeSEd Tanous severity = message->messageSeverity; 4046d4342a92STim Lee } 4047d4342a92STim Lee 40486f284d24SJiaqing Zhao // Format entry 40496f284d24SJiaqing Zhao nlohmann::json::object_t bmcLogEntry; 40509c11a172SVijay Lobo bmcLogEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 4051ef4c65b7SEd Tanous bmcLogEntry["@odata.id"] = boost::urls::format( 4052ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/{}", 4053ef4c65b7SEd Tanous postcodeEntryID); 405484afc48bSJason M. Bills bmcLogEntry["Name"] = "POST Code Log Entry"; 405584afc48bSJason M. Bills bmcLogEntry["Id"] = postcodeEntryID; 405684afc48bSJason M. Bills bmcLogEntry["Message"] = std::move(msg); 405784afc48bSJason M. Bills bmcLogEntry["MessageId"] = "OpenBMC.0.2.BIOSPOSTCode"; 40581e6deaf6SEd Tanous bmcLogEntry["MessageArgs"] = messageArgs; 405984afc48bSJason M. Bills bmcLogEntry["EntryType"] = "Event"; 406084afc48bSJason M. Bills bmcLogEntry["Severity"] = std::move(severity); 406184afc48bSJason M. Bills bmcLogEntry["Created"] = entryTimeStr; 4062647b3cdcSGeorge Liu if (!std::get<std::vector<uint8_t>>(code.second).empty()) 4063647b3cdcSGeorge Liu { 4064647b3cdcSGeorge Liu bmcLogEntry["AdditionalDataURI"] = 4065647b3cdcSGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 4066647b3cdcSGeorge Liu postcodeEntryID + "/attachment"; 4067647b3cdcSGeorge Liu } 40686f284d24SJiaqing Zhao 40696f284d24SJiaqing Zhao // codeIndex is only specified when querying single entry, return only 40706f284d24SJiaqing Zhao // that entry in this case 40716f284d24SJiaqing Zhao if (codeIndex != 0) 40726f284d24SJiaqing Zhao { 4073ac106bf6SEd Tanous asyncResp->res.jsonValue.update(bmcLogEntry); 40746f284d24SJiaqing Zhao return true; 4075a3316fc6SZhikuiRen } 40766f284d24SJiaqing Zhao 4077ac106bf6SEd Tanous nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 4078b2ba3072SPatrick Williams logEntryArray.emplace_back(std::move(bmcLogEntry)); 40796f284d24SJiaqing Zhao } 40806f284d24SJiaqing Zhao 40816f284d24SJiaqing Zhao // Return value is always false when querying multiple entries 40826f284d24SJiaqing Zhao return false; 4083a3316fc6SZhikuiRen } 4084a3316fc6SZhikuiRen 4085ac106bf6SEd Tanous static void 4086ac106bf6SEd Tanous getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 40876f284d24SJiaqing Zhao const std::string& entryId) 4088a3316fc6SZhikuiRen { 40896f284d24SJiaqing Zhao uint16_t bootIndex = 0; 40906f284d24SJiaqing Zhao uint64_t codeIndex = 0; 40916f284d24SJiaqing Zhao if (!parsePostCode(entryId, codeIndex, bootIndex)) 40926f284d24SJiaqing Zhao { 40936f284d24SJiaqing Zhao // Requested ID was not found 4094ac106bf6SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryId); 40956f284d24SJiaqing Zhao return; 40966f284d24SJiaqing Zhao } 40976f284d24SJiaqing Zhao 40986f284d24SJiaqing Zhao if (bootIndex == 0 || codeIndex == 0) 40996f284d24SJiaqing Zhao { 41006f284d24SJiaqing Zhao // 0 is an invalid index 4101ac106bf6SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryId); 41026f284d24SJiaqing Zhao return; 41036f284d24SJiaqing Zhao } 41046f284d24SJiaqing Zhao 4105a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 4106ac106bf6SEd Tanous [asyncResp, entryId, bootIndex, 41075e7e2dc5SEd Tanous codeIndex](const boost::system::error_code& ec, 41086c9a279eSManojkiran Eda const boost::container::flat_map< 41096c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 41106c9a279eSManojkiran Eda postcode) { 4111a3316fc6SZhikuiRen if (ec) 4112a3316fc6SZhikuiRen { 411362598e31SEd Tanous BMCWEB_LOG_DEBUG("DBUS POST CODE PostCode response error"); 4114ac106bf6SEd Tanous messages::internalError(asyncResp->res); 4115a3316fc6SZhikuiRen return; 4116a3316fc6SZhikuiRen } 4117a3316fc6SZhikuiRen 4118a3316fc6SZhikuiRen if (postcode.empty()) 4119a3316fc6SZhikuiRen { 4120ac106bf6SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryId); 4121a3316fc6SZhikuiRen return; 4122a3316fc6SZhikuiRen } 4123a3316fc6SZhikuiRen 4124ac106bf6SEd Tanous if (!fillPostCodeEntry(asyncResp, postcode, bootIndex, codeIndex)) 41256f284d24SJiaqing Zhao { 4126ac106bf6SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryId); 41276f284d24SJiaqing Zhao return; 41286f284d24SJiaqing Zhao } 4129a3316fc6SZhikuiRen }, 413015124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 413115124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 4132a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 4133a3316fc6SZhikuiRen bootIndex); 4134a3316fc6SZhikuiRen } 4135a3316fc6SZhikuiRen 4136ac106bf6SEd Tanous static void 4137ac106bf6SEd Tanous getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 4138ac106bf6SEd Tanous const uint16_t bootIndex, const uint16_t bootCount, 4139ac106bf6SEd Tanous const uint64_t entryCount, size_t skip, size_t top) 4140a3316fc6SZhikuiRen { 4141a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 4142ac106bf6SEd Tanous [asyncResp, bootIndex, bootCount, entryCount, skip, 41435e7e2dc5SEd Tanous top](const boost::system::error_code& ec, 41446c9a279eSManojkiran Eda const boost::container::flat_map< 41456c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 41466c9a279eSManojkiran Eda postcode) { 4147a3316fc6SZhikuiRen if (ec) 4148a3316fc6SZhikuiRen { 414962598e31SEd Tanous BMCWEB_LOG_DEBUG("DBUS POST CODE PostCode response error"); 4150ac106bf6SEd Tanous messages::internalError(asyncResp->res); 4151a3316fc6SZhikuiRen return; 4152a3316fc6SZhikuiRen } 4153a3316fc6SZhikuiRen 4154a3316fc6SZhikuiRen uint64_t endCount = entryCount; 4155a3316fc6SZhikuiRen if (!postcode.empty()) 4156a3316fc6SZhikuiRen { 4157a3316fc6SZhikuiRen endCount = entryCount + postcode.size(); 41583648c8beSEd Tanous if (skip < endCount && (top + skip) > entryCount) 4159a3316fc6SZhikuiRen { 416089492a15SPatrick Williams uint64_t thisBootSkip = std::max(static_cast<uint64_t>(skip), 416189492a15SPatrick Williams entryCount) - 41623648c8beSEd Tanous entryCount; 4163a3316fc6SZhikuiRen uint64_t thisBootTop = 41643648c8beSEd Tanous std::min(static_cast<uint64_t>(top + skip), endCount) - 41653648c8beSEd Tanous entryCount; 4166a3316fc6SZhikuiRen 4167ac106bf6SEd Tanous fillPostCodeEntry(asyncResp, postcode, bootIndex, 0, 4168ac106bf6SEd Tanous thisBootSkip, thisBootTop); 4169a3316fc6SZhikuiRen } 4170ac106bf6SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = endCount; 4171a3316fc6SZhikuiRen } 4172a3316fc6SZhikuiRen 4173a3316fc6SZhikuiRen // continue to previous bootIndex 4174a3316fc6SZhikuiRen if (bootIndex < bootCount) 4175a3316fc6SZhikuiRen { 4176ac106bf6SEd Tanous getPostCodeForBoot(asyncResp, static_cast<uint16_t>(bootIndex + 1), 4177a3316fc6SZhikuiRen bootCount, endCount, skip, top); 4178a3316fc6SZhikuiRen } 417981584abeSJiaqing Zhao else if (skip + top < endCount) 4180a3316fc6SZhikuiRen { 4181ac106bf6SEd Tanous asyncResp->res.jsonValue["Members@odata.nextLink"] = 41820fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=" + 4183a3316fc6SZhikuiRen std::to_string(skip + top); 4184a3316fc6SZhikuiRen } 4185a3316fc6SZhikuiRen }, 418615124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 418715124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 4188a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 4189a3316fc6SZhikuiRen bootIndex); 4190a3316fc6SZhikuiRen } 4191a3316fc6SZhikuiRen 41928d1b46d7Szhanghch05 static void 4193ac106bf6SEd Tanous getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 41943648c8beSEd Tanous size_t skip, size_t top) 4195a3316fc6SZhikuiRen { 4196a3316fc6SZhikuiRen uint64_t entryCount = 0; 41971e1e598dSJonathan Doman sdbusplus::asio::getProperty<uint16_t>( 41981e1e598dSJonathan Doman *crow::connections::systemBus, 41991e1e598dSJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 42001e1e598dSJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 42011e1e598dSJonathan Doman "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount", 4202ac106bf6SEd Tanous [asyncResp, entryCount, skip, top](const boost::system::error_code& ec, 42031e1e598dSJonathan Doman const uint16_t bootCount) { 4204a3316fc6SZhikuiRen if (ec) 4205a3316fc6SZhikuiRen { 420662598e31SEd Tanous BMCWEB_LOG_DEBUG("DBUS response error {}", ec); 4207ac106bf6SEd Tanous messages::internalError(asyncResp->res); 4208a3316fc6SZhikuiRen return; 4209a3316fc6SZhikuiRen } 4210ac106bf6SEd Tanous getPostCodeForBoot(asyncResp, 1, bootCount, entryCount, skip, top); 42111e1e598dSJonathan Doman }); 4212a3316fc6SZhikuiRen } 4213a3316fc6SZhikuiRen 42147e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntryCollection(App& app) 4215a3316fc6SZhikuiRen { 42167e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 421722d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/") 4218ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 42197e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 422045ca1b86SEd Tanous [&app](const crow::Request& req, 422122d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 422222d268cbSEd Tanous const std::string& systemName) { 4223c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 4224c937d2bfSEd Tanous .canDelegateTop = true, 4225c937d2bfSEd Tanous .canDelegateSkip = true, 4226c937d2bfSEd Tanous }; 4227c937d2bfSEd Tanous query_param::Query delegatedQuery; 4228c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 42293ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 423045ca1b86SEd Tanous { 423145ca1b86SEd Tanous return; 423245ca1b86SEd Tanous } 42337f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 42347f3e84a1SEd Tanous { 42357f3e84a1SEd Tanous // Option currently returns no systems. TBD 42367f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 42377f3e84a1SEd Tanous systemName); 42387f3e84a1SEd Tanous return; 42397f3e84a1SEd Tanous } 424022d268cbSEd Tanous 424122d268cbSEd Tanous if (systemName != "system") 424222d268cbSEd Tanous { 424322d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 424422d268cbSEd Tanous systemName); 424522d268cbSEd Tanous return; 424622d268cbSEd Tanous } 4247a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.type"] = 4248a3316fc6SZhikuiRen "#LogEntryCollection.LogEntryCollection"; 4249a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 4250a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 4251a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 4252a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 4253a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 4254a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 4255a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 42563648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 42575143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 42583648c8beSEd Tanous getCurrentBootNumber(asyncResp, skip, top); 42597e860f15SJohn Edward Broadbent }); 4260a3316fc6SZhikuiRen } 4261a3316fc6SZhikuiRen 4262647b3cdcSGeorge Liu inline void requestRoutesPostCodesEntryAdditionalData(App& app) 4263647b3cdcSGeorge Liu { 42640fda0f12SGeorge Liu BMCWEB_ROUTE( 42650fda0f12SGeorge Liu app, 426622d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/attachment/") 4267647b3cdcSGeorge Liu .privileges(redfish::privileges::getLogEntry) 4268647b3cdcSGeorge Liu .methods(boost::beast::http::verb::get)( 426945ca1b86SEd Tanous [&app](const crow::Request& req, 4270647b3cdcSGeorge Liu const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 427122d268cbSEd Tanous const std::string& systemName, 4272647b3cdcSGeorge Liu const std::string& postCodeID) { 42733ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 427445ca1b86SEd Tanous { 427545ca1b86SEd Tanous return; 427645ca1b86SEd Tanous } 427772e21377SMatt Spinler if (!http_helpers::isContentTypeAllowed( 427899351cd8SEd Tanous req.getHeaderValue("Accept"), 42794a0e1a0cSEd Tanous http_helpers::ContentType::OctetStream, true)) 4280647b3cdcSGeorge Liu { 4281002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::bad_request); 4282647b3cdcSGeorge Liu return; 4283647b3cdcSGeorge Liu } 42847f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 42857f3e84a1SEd Tanous { 42867f3e84a1SEd Tanous // Option currently returns no systems. TBD 42877f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 42887f3e84a1SEd Tanous systemName); 42897f3e84a1SEd Tanous return; 42907f3e84a1SEd Tanous } 429122d268cbSEd Tanous if (systemName != "system") 429222d268cbSEd Tanous { 429322d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 429422d268cbSEd Tanous systemName); 429522d268cbSEd Tanous return; 429622d268cbSEd Tanous } 4297647b3cdcSGeorge Liu 4298647b3cdcSGeorge Liu uint64_t currentValue = 0; 4299647b3cdcSGeorge Liu uint16_t index = 0; 4300647b3cdcSGeorge Liu if (!parsePostCode(postCodeID, currentValue, index)) 4301647b3cdcSGeorge Liu { 4302002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", postCodeID); 4303647b3cdcSGeorge Liu return; 4304647b3cdcSGeorge Liu } 4305647b3cdcSGeorge Liu 4306647b3cdcSGeorge Liu crow::connections::systemBus->async_method_call( 4307647b3cdcSGeorge Liu [asyncResp, postCodeID, currentValue]( 43085e7e2dc5SEd Tanous const boost::system::error_code& ec, 4309002d39b4SEd Tanous const std::vector<std::tuple<uint64_t, std::vector<uint8_t>>>& 4310002d39b4SEd Tanous postcodes) { 4311647b3cdcSGeorge Liu if (ec.value() == EBADR) 4312647b3cdcSGeorge Liu { 4313002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 4314002d39b4SEd Tanous postCodeID); 4315647b3cdcSGeorge Liu return; 4316647b3cdcSGeorge Liu } 4317647b3cdcSGeorge Liu if (ec) 4318647b3cdcSGeorge Liu { 431962598e31SEd Tanous BMCWEB_LOG_DEBUG("DBUS response error {}", ec); 4320647b3cdcSGeorge Liu messages::internalError(asyncResp->res); 4321647b3cdcSGeorge Liu return; 4322647b3cdcSGeorge Liu } 4323647b3cdcSGeorge Liu 4324647b3cdcSGeorge Liu size_t value = static_cast<size_t>(currentValue) - 1; 4325002d39b4SEd Tanous if (value == std::string::npos || postcodes.size() < currentValue) 4326647b3cdcSGeorge Liu { 432762598e31SEd Tanous BMCWEB_LOG_WARNING("Wrong currentValue value"); 4328002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 4329002d39b4SEd Tanous postCodeID); 4330647b3cdcSGeorge Liu return; 4331647b3cdcSGeorge Liu } 4332647b3cdcSGeorge Liu 43339eb808c1SEd Tanous const auto& [tID, c] = postcodes[value]; 433446ff87baSEd Tanous if (c.empty()) 4335647b3cdcSGeorge Liu { 433662598e31SEd Tanous BMCWEB_LOG_WARNING("No found post code data"); 4337002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 4338002d39b4SEd Tanous postCodeID); 4339647b3cdcSGeorge Liu return; 4340647b3cdcSGeorge Liu } 434146ff87baSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) 434246ff87baSEd Tanous const char* d = reinterpret_cast<const char*>(c.data()); 434346ff87baSEd Tanous std::string_view strData(d, c.size()); 4344647b3cdcSGeorge Liu 4345d9f6c621SEd Tanous asyncResp->res.addHeader(boost::beast::http::field::content_type, 4346647b3cdcSGeorge Liu "application/octet-stream"); 4347d9f6c621SEd Tanous asyncResp->res.addHeader( 4348d9f6c621SEd Tanous boost::beast::http::field::content_transfer_encoding, "Base64"); 434927b0cf90SEd Tanous asyncResp->res.write(crow::utility::base64encode(strData)); 4350647b3cdcSGeorge Liu }, 4351647b3cdcSGeorge Liu "xyz.openbmc_project.State.Boot.PostCode0", 4352647b3cdcSGeorge Liu "/xyz/openbmc_project/State/Boot/PostCode0", 4353002d39b4SEd Tanous "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", index); 4354647b3cdcSGeorge Liu }); 4355647b3cdcSGeorge Liu } 4356647b3cdcSGeorge Liu 43577e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntry(App& app) 4358a3316fc6SZhikuiRen { 43597e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 436022d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/") 4361ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 43627e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 436345ca1b86SEd Tanous [&app](const crow::Request& req, 43647e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 436522d268cbSEd Tanous const std::string& systemName, const std::string& targetID) { 43663ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 436745ca1b86SEd Tanous { 436845ca1b86SEd Tanous return; 436945ca1b86SEd Tanous } 43707f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 43717f3e84a1SEd Tanous { 43727f3e84a1SEd Tanous // Option currently returns no systems. TBD 43737f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 43747f3e84a1SEd Tanous systemName); 43757f3e84a1SEd Tanous return; 43767f3e84a1SEd Tanous } 437722d268cbSEd Tanous if (systemName != "system") 437822d268cbSEd Tanous { 437922d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 438022d268cbSEd Tanous systemName); 438122d268cbSEd Tanous return; 438222d268cbSEd Tanous } 438322d268cbSEd Tanous 43846f284d24SJiaqing Zhao getPostCodeForEntry(asyncResp, targetID); 43857e860f15SJohn Edward Broadbent }); 4386a3316fc6SZhikuiRen } 4387a3316fc6SZhikuiRen 43881da66f75SEd Tanous } // namespace redfish 4389