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> 48b5f288d2SAbhilash 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, 274*099984c1SEd Tanous std::string_view entryIDStrView, sd_id128_t& bootID, 27575e8e218SMyung Bae uint64_t& timestamp, uint64_t& index) 27616428a1aSJason M. Bills { 27775e8e218SMyung Bae // Convert the unique ID back to a bootID + timestamp to find the entry 27875e8e218SMyung Bae auto underscore1Pos = entryIDStrView.find('_'); 27975e8e218SMyung Bae if (underscore1Pos == std::string_view::npos) 28075e8e218SMyung Bae { 28175e8e218SMyung Bae // EntryID has no bootID or timestamp 282*099984c1SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryIDStrView); 28375e8e218SMyung Bae return false; 28475e8e218SMyung Bae } 28575e8e218SMyung Bae 28675e8e218SMyung Bae // EntryID has bootID + timestamp 28775e8e218SMyung Bae 28875e8e218SMyung Bae // Convert entryIDViewString to BootID 28975e8e218SMyung Bae // NOTE: bootID string which needs to be null-terminated for 29075e8e218SMyung Bae // sd_id128_from_string() 291*099984c1SEd Tanous std::string bootIDStr(entryIDStrView.substr(0, underscore1Pos)); 29275e8e218SMyung Bae if (sd_id128_from_string(bootIDStr.c_str(), &bootID) < 0) 29375e8e218SMyung Bae { 294*099984c1SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryIDStrView); 29575e8e218SMyung Bae return false; 29675e8e218SMyung Bae } 29775e8e218SMyung Bae 29875e8e218SMyung Bae // Get the timestamp from entryID 299*099984c1SEd Tanous entryIDStrView.remove_prefix(underscore1Pos + 1); 30075e8e218SMyung Bae 301*099984c1SEd Tanous auto [timestampEnd, tstampEc] = std::from_chars( 302*099984c1SEd Tanous entryIDStrView.begin(), entryIDStrView.end(), timestamp); 303*099984c1SEd Tanous if (tstampEc != std::errc()) 30416428a1aSJason M. Bills { 305*099984c1SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryIDStrView); 30616428a1aSJason M. Bills return false; 30716428a1aSJason M. Bills } 308*099984c1SEd Tanous entryIDStrView = std::string_view( 309*099984c1SEd Tanous timestampEnd, 310*099984c1SEd Tanous static_cast<size_t>(std::distance(timestampEnd, entryIDStrView.end()))); 311*099984c1SEd Tanous if (entryIDStrView.empty()) 31216428a1aSJason M. Bills { 313*099984c1SEd Tanous index = 0U; 314*099984c1SEd Tanous return true; 315*099984c1SEd Tanous } 316*099984c1SEd Tanous // Timestamp might include optional index, if two events happened at the 317*099984c1SEd Tanous // same "time". 318*099984c1SEd Tanous if (entryIDStrView[0] != '_') 319*099984c1SEd Tanous { 320*099984c1SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryIDStrView); 321*099984c1SEd Tanous return false; 322*099984c1SEd Tanous } 323*099984c1SEd Tanous entryIDStrView.remove_prefix(1); 324*099984c1SEd Tanous auto [ptr, indexEc] = std::from_chars(entryIDStrView.begin(), 325*099984c1SEd Tanous entryIDStrView.end(), index); 326*099984c1SEd Tanous if (indexEc != std::errc() || ptr != entryIDStrView.end()) 327*099984c1SEd Tanous { 328*099984c1SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryIDStrView); 32916428a1aSJason M. Bills return false; 33016428a1aSJason M. Bills } 33116428a1aSJason M. Bills return true; 33216428a1aSJason M. Bills } 33316428a1aSJason M. Bills 33495820184SJason M. Bills static bool 33595820184SJason M. Bills getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles) 33695820184SJason M. Bills { 33795820184SJason M. Bills static const std::filesystem::path redfishLogDir = "/var/log"; 33895820184SJason M. Bills static const std::string redfishLogFilename = "redfish"; 33995820184SJason M. Bills 34095820184SJason M. Bills // Loop through the directory looking for redfish log files 34195820184SJason M. Bills for (const std::filesystem::directory_entry& dirEnt : 34295820184SJason M. Bills std::filesystem::directory_iterator(redfishLogDir)) 34395820184SJason M. Bills { 34495820184SJason M. Bills // If we find a redfish log file, save the path 34595820184SJason M. Bills std::string filename = dirEnt.path().filename(); 34611ba3979SEd Tanous if (filename.starts_with(redfishLogFilename)) 34795820184SJason M. Bills { 34895820184SJason M. Bills redfishLogFiles.emplace_back(redfishLogDir / filename); 34995820184SJason M. Bills } 35095820184SJason M. Bills } 35195820184SJason M. Bills // As the log files rotate, they are appended with a ".#" that is higher for 35295820184SJason M. Bills // the older logs. Since we don't expect more than 10 log files, we 35395820184SJason M. Bills // can just sort the list to get them in order from newest to oldest 3543544d2a7SEd Tanous std::ranges::sort(redfishLogFiles); 35595820184SJason M. Bills 35695820184SJason M. Bills return !redfishLogFiles.empty(); 35795820184SJason M. Bills } 35895820184SJason M. Bills 35968dd075aSAsmitha Karunanithi inline log_entry::OriginatorTypes 36068dd075aSAsmitha Karunanithi mapDbusOriginatorTypeToRedfish(const std::string& originatorType) 36168dd075aSAsmitha Karunanithi { 36268dd075aSAsmitha Karunanithi if (originatorType == 36368dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client") 36468dd075aSAsmitha Karunanithi { 36568dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::Client; 36668dd075aSAsmitha Karunanithi } 36768dd075aSAsmitha Karunanithi if (originatorType == 36868dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Internal") 36968dd075aSAsmitha Karunanithi { 37068dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::Internal; 37168dd075aSAsmitha Karunanithi } 37268dd075aSAsmitha Karunanithi if (originatorType == 37368dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.SupportingService") 37468dd075aSAsmitha Karunanithi { 37568dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::SupportingService; 37668dd075aSAsmitha Karunanithi } 37768dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::Invalid; 37868dd075aSAsmitha Karunanithi } 37968dd075aSAsmitha Karunanithi 380aefe3786SClaire Weinan inline void parseDumpEntryFromDbusObject( 3812d613eb6SJiaqing Zhao const dbus::utility::ManagedObjectType::value_type& object, 382c6fecdabSClaire Weinan std::string& dumpStatus, uint64_t& size, uint64_t& timestampUs, 38368dd075aSAsmitha Karunanithi std::string& originatorId, log_entry::OriginatorTypes& originatorType, 384aefe3786SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 385aefe3786SClaire Weinan { 386aefe3786SClaire Weinan for (const auto& interfaceMap : object.second) 387aefe3786SClaire Weinan { 388aefe3786SClaire Weinan if (interfaceMap.first == "xyz.openbmc_project.Common.Progress") 389aefe3786SClaire Weinan { 390aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 391aefe3786SClaire Weinan { 392aefe3786SClaire Weinan if (propertyMap.first == "Status") 393aefe3786SClaire Weinan { 394aefe3786SClaire Weinan const auto* status = 395aefe3786SClaire Weinan std::get_if<std::string>(&propertyMap.second); 396aefe3786SClaire Weinan if (status == nullptr) 397aefe3786SClaire Weinan { 398aefe3786SClaire Weinan messages::internalError(asyncResp->res); 399aefe3786SClaire Weinan break; 400aefe3786SClaire Weinan } 401aefe3786SClaire Weinan dumpStatus = *status; 402aefe3786SClaire Weinan } 403aefe3786SClaire Weinan } 404aefe3786SClaire Weinan } 405aefe3786SClaire Weinan else if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") 406aefe3786SClaire Weinan { 407aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 408aefe3786SClaire Weinan { 409aefe3786SClaire Weinan if (propertyMap.first == "Size") 410aefe3786SClaire Weinan { 411aefe3786SClaire Weinan const auto* sizePtr = 412aefe3786SClaire Weinan std::get_if<uint64_t>(&propertyMap.second); 413aefe3786SClaire Weinan if (sizePtr == nullptr) 414aefe3786SClaire Weinan { 415aefe3786SClaire Weinan messages::internalError(asyncResp->res); 416aefe3786SClaire Weinan break; 417aefe3786SClaire Weinan } 418aefe3786SClaire Weinan size = *sizePtr; 419aefe3786SClaire Weinan break; 420aefe3786SClaire Weinan } 421aefe3786SClaire Weinan } 422aefe3786SClaire Weinan } 423aefe3786SClaire Weinan else if (interfaceMap.first == "xyz.openbmc_project.Time.EpochTime") 424aefe3786SClaire Weinan { 425aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 426aefe3786SClaire Weinan { 427aefe3786SClaire Weinan if (propertyMap.first == "Elapsed") 428aefe3786SClaire Weinan { 429aefe3786SClaire Weinan const uint64_t* usecsTimeStamp = 430aefe3786SClaire Weinan std::get_if<uint64_t>(&propertyMap.second); 431aefe3786SClaire Weinan if (usecsTimeStamp == nullptr) 432aefe3786SClaire Weinan { 433aefe3786SClaire Weinan messages::internalError(asyncResp->res); 434aefe3786SClaire Weinan break; 435aefe3786SClaire Weinan } 436c6fecdabSClaire Weinan timestampUs = *usecsTimeStamp; 437aefe3786SClaire Weinan break; 438aefe3786SClaire Weinan } 439aefe3786SClaire Weinan } 440aefe3786SClaire Weinan } 44168dd075aSAsmitha Karunanithi else if (interfaceMap.first == 44268dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy") 44368dd075aSAsmitha Karunanithi { 44468dd075aSAsmitha Karunanithi for (const auto& propertyMap : interfaceMap.second) 44568dd075aSAsmitha Karunanithi { 44668dd075aSAsmitha Karunanithi if (propertyMap.first == "OriginatorId") 44768dd075aSAsmitha Karunanithi { 44868dd075aSAsmitha Karunanithi const std::string* id = 44968dd075aSAsmitha Karunanithi std::get_if<std::string>(&propertyMap.second); 45068dd075aSAsmitha Karunanithi if (id == nullptr) 45168dd075aSAsmitha Karunanithi { 45268dd075aSAsmitha Karunanithi messages::internalError(asyncResp->res); 45368dd075aSAsmitha Karunanithi break; 45468dd075aSAsmitha Karunanithi } 45568dd075aSAsmitha Karunanithi originatorId = *id; 45668dd075aSAsmitha Karunanithi } 45768dd075aSAsmitha Karunanithi 45868dd075aSAsmitha Karunanithi if (propertyMap.first == "OriginatorType") 45968dd075aSAsmitha Karunanithi { 46068dd075aSAsmitha Karunanithi const std::string* type = 46168dd075aSAsmitha Karunanithi std::get_if<std::string>(&propertyMap.second); 46268dd075aSAsmitha Karunanithi if (type == nullptr) 46368dd075aSAsmitha Karunanithi { 46468dd075aSAsmitha Karunanithi messages::internalError(asyncResp->res); 46568dd075aSAsmitha Karunanithi break; 46668dd075aSAsmitha Karunanithi } 46768dd075aSAsmitha Karunanithi 46868dd075aSAsmitha Karunanithi originatorType = mapDbusOriginatorTypeToRedfish(*type); 46968dd075aSAsmitha Karunanithi if (originatorType == log_entry::OriginatorTypes::Invalid) 47068dd075aSAsmitha Karunanithi { 47168dd075aSAsmitha Karunanithi messages::internalError(asyncResp->res); 47268dd075aSAsmitha Karunanithi break; 47368dd075aSAsmitha Karunanithi } 47468dd075aSAsmitha Karunanithi } 47568dd075aSAsmitha Karunanithi } 47668dd075aSAsmitha Karunanithi } 477aefe3786SClaire Weinan } 478aefe3786SClaire Weinan } 479aefe3786SClaire Weinan 48021ab404cSNan Zhou static std::string getDumpEntriesPath(const std::string& dumpType) 481fdd26906SClaire Weinan { 482fdd26906SClaire Weinan std::string entriesPath; 483fdd26906SClaire Weinan 484fdd26906SClaire Weinan if (dumpType == "BMC") 485fdd26906SClaire Weinan { 486fdd26906SClaire Weinan entriesPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 487fdd26906SClaire Weinan } 488fdd26906SClaire Weinan else if (dumpType == "FaultLog") 489fdd26906SClaire Weinan { 490fdd26906SClaire Weinan entriesPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/"; 491fdd26906SClaire Weinan } 492fdd26906SClaire Weinan else if (dumpType == "System") 493fdd26906SClaire Weinan { 494fdd26906SClaire Weinan entriesPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 495fdd26906SClaire Weinan } 496fdd26906SClaire Weinan else 497fdd26906SClaire Weinan { 49862598e31SEd Tanous BMCWEB_LOG_ERROR("getDumpEntriesPath() invalid dump type: {}", 49962598e31SEd Tanous dumpType); 500fdd26906SClaire Weinan } 501fdd26906SClaire Weinan 502fdd26906SClaire Weinan // Returns empty string on error 503fdd26906SClaire Weinan return entriesPath; 504fdd26906SClaire Weinan } 505fdd26906SClaire Weinan 5068d1b46d7Szhanghch05 inline void 5078d1b46d7Szhanghch05 getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 5085cb1dd27SAsmitha Karunanithi const std::string& dumpType) 5095cb1dd27SAsmitha Karunanithi { 510fdd26906SClaire Weinan std::string entriesPath = getDumpEntriesPath(dumpType); 511fdd26906SClaire Weinan if (entriesPath.empty()) 5125cb1dd27SAsmitha Karunanithi { 5135cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5145cb1dd27SAsmitha Karunanithi return; 5155cb1dd27SAsmitha Karunanithi } 5165cb1dd27SAsmitha Karunanithi 5175eb468daSGeorge Liu sdbusplus::message::object_path path("/xyz/openbmc_project/dump"); 5185eb468daSGeorge Liu dbus::utility::getManagedObjects( 5195eb468daSGeorge Liu "xyz.openbmc_project.Dump.Manager", path, 520fdd26906SClaire Weinan [asyncResp, entriesPath, 5215e7e2dc5SEd Tanous dumpType](const boost::system::error_code& ec, 5225eb468daSGeorge Liu const dbus::utility::ManagedObjectType& objects) { 5235cb1dd27SAsmitha Karunanithi if (ec) 5245cb1dd27SAsmitha Karunanithi { 52562598e31SEd Tanous BMCWEB_LOG_ERROR("DumpEntry resp_handler got error {}", ec); 5265cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5275cb1dd27SAsmitha Karunanithi return; 5285cb1dd27SAsmitha Karunanithi } 5295cb1dd27SAsmitha Karunanithi 530fdd26906SClaire Weinan // Remove ending slash 531fdd26906SClaire Weinan std::string odataIdStr = entriesPath; 532fdd26906SClaire Weinan if (!odataIdStr.empty()) 533fdd26906SClaire Weinan { 534fdd26906SClaire Weinan odataIdStr.pop_back(); 535fdd26906SClaire Weinan } 536fdd26906SClaire Weinan 537fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.type"] = 538fdd26906SClaire Weinan "#LogEntryCollection.LogEntryCollection"; 539fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = std::move(odataIdStr); 540fdd26906SClaire Weinan asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entries"; 54189492a15SPatrick Williams asyncResp->res.jsonValue["Description"] = "Collection of " + dumpType + 54289492a15SPatrick Williams " Dump Entries"; 543fdd26906SClaire Weinan 5443544d2a7SEd Tanous nlohmann::json::array_t entriesArray; 54518f8f608SEd Tanous std::string dumpEntryPath = getDumpPath(dumpType) + "/entry/"; 5465cb1dd27SAsmitha Karunanithi 5475eb468daSGeorge Liu dbus::utility::ManagedObjectType resp(objects); 5483544d2a7SEd Tanous std::ranges::sort(resp, [](const auto& l, const auto& r) { 549002d39b4SEd Tanous return AlphanumLess<std::string>()(l.first.filename(), 550002d39b4SEd Tanous r.first.filename()); 551565dfb6fSClaire Weinan }); 552565dfb6fSClaire Weinan 5535cb1dd27SAsmitha Karunanithi for (auto& object : resp) 5545cb1dd27SAsmitha Karunanithi { 555b47452b2SAsmitha Karunanithi if (object.first.str.find(dumpEntryPath) == std::string::npos) 5565cb1dd27SAsmitha Karunanithi { 5575cb1dd27SAsmitha Karunanithi continue; 5585cb1dd27SAsmitha Karunanithi } 559c6fecdabSClaire Weinan uint64_t timestampUs = 0; 5605cb1dd27SAsmitha Karunanithi uint64_t size = 0; 56135440d18SAsmitha Karunanithi std::string dumpStatus; 56268dd075aSAsmitha Karunanithi std::string originatorId; 56368dd075aSAsmitha Karunanithi log_entry::OriginatorTypes originatorType = 56468dd075aSAsmitha Karunanithi log_entry::OriginatorTypes::Internal; 565433b68b4SJason M. Bills nlohmann::json::object_t thisEntry; 5662dfd18efSEd Tanous 5672dfd18efSEd Tanous std::string entryID = object.first.filename(); 5682dfd18efSEd Tanous if (entryID.empty()) 5695cb1dd27SAsmitha Karunanithi { 5705cb1dd27SAsmitha Karunanithi continue; 5715cb1dd27SAsmitha Karunanithi } 5725cb1dd27SAsmitha Karunanithi 573c6fecdabSClaire Weinan parseDumpEntryFromDbusObject(object, dumpStatus, size, timestampUs, 57468dd075aSAsmitha Karunanithi originatorId, originatorType, 575aefe3786SClaire Weinan asyncResp); 5765cb1dd27SAsmitha Karunanithi 5770fda0f12SGeorge Liu if (dumpStatus != 5780fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 57935440d18SAsmitha Karunanithi !dumpStatus.empty()) 58035440d18SAsmitha Karunanithi { 58135440d18SAsmitha Karunanithi // Dump status is not Complete, no need to enumerate 58235440d18SAsmitha Karunanithi continue; 58335440d18SAsmitha Karunanithi } 58435440d18SAsmitha Karunanithi 58568dd075aSAsmitha Karunanithi thisEntry["@odata.type"] = "#LogEntry.v1_11_0.LogEntry"; 586fdd26906SClaire Weinan thisEntry["@odata.id"] = entriesPath + entryID; 5875cb1dd27SAsmitha Karunanithi thisEntry["Id"] = entryID; 5885cb1dd27SAsmitha Karunanithi thisEntry["EntryType"] = "Event"; 5895cb1dd27SAsmitha Karunanithi thisEntry["Name"] = dumpType + " Dump Entry"; 590bbd80db8SClaire Weinan thisEntry["Created"] = 591bbd80db8SClaire Weinan redfish::time_utils::getDateTimeUintUs(timestampUs); 5925cb1dd27SAsmitha Karunanithi 59368dd075aSAsmitha Karunanithi if (!originatorId.empty()) 59468dd075aSAsmitha Karunanithi { 59568dd075aSAsmitha Karunanithi thisEntry["Originator"] = originatorId; 59668dd075aSAsmitha Karunanithi thisEntry["OriginatorType"] = originatorType; 59768dd075aSAsmitha Karunanithi } 59868dd075aSAsmitha Karunanithi 5995cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 6005cb1dd27SAsmitha Karunanithi { 601d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "Manager"; 60289492a15SPatrick Williams thisEntry["AdditionalDataURI"] = entriesPath + entryID + 60389492a15SPatrick Williams "/attachment"; 604fdd26906SClaire Weinan thisEntry["AdditionalDataSizeBytes"] = size; 6055cb1dd27SAsmitha Karunanithi } 6065cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 6075cb1dd27SAsmitha Karunanithi { 608d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "OEM"; 609d337bb72SAsmitha Karunanithi thisEntry["OEMDiagnosticDataType"] = "System"; 61089492a15SPatrick Williams thisEntry["AdditionalDataURI"] = entriesPath + entryID + 61189492a15SPatrick Williams "/attachment"; 612fdd26906SClaire Weinan thisEntry["AdditionalDataSizeBytes"] = size; 6135cb1dd27SAsmitha Karunanithi } 614b2ba3072SPatrick Williams entriesArray.emplace_back(std::move(thisEntry)); 6155cb1dd27SAsmitha Karunanithi } 616002d39b4SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size(); 6173544d2a7SEd Tanous asyncResp->res.jsonValue["Members"] = std::move(entriesArray); 6185eb468daSGeorge Liu }); 6195cb1dd27SAsmitha Karunanithi } 6205cb1dd27SAsmitha Karunanithi 6218d1b46d7Szhanghch05 inline void 622c7a6d660SClaire Weinan getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 6238d1b46d7Szhanghch05 const std::string& entryID, const std::string& dumpType) 6245cb1dd27SAsmitha Karunanithi { 625fdd26906SClaire Weinan std::string entriesPath = getDumpEntriesPath(dumpType); 626fdd26906SClaire Weinan if (entriesPath.empty()) 6275cb1dd27SAsmitha Karunanithi { 6285cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6295cb1dd27SAsmitha Karunanithi return; 6305cb1dd27SAsmitha Karunanithi } 6315cb1dd27SAsmitha Karunanithi 6325eb468daSGeorge Liu sdbusplus::message::object_path path("/xyz/openbmc_project/dump"); 6335eb468daSGeorge Liu dbus::utility::getManagedObjects( 6345eb468daSGeorge Liu "xyz.openbmc_project.Dump.Manager", path, 635fdd26906SClaire Weinan [asyncResp, entryID, dumpType, 6365e7e2dc5SEd Tanous entriesPath](const boost::system::error_code& ec, 63702cad96eSEd Tanous const dbus::utility::ManagedObjectType& resp) { 6385cb1dd27SAsmitha Karunanithi if (ec) 6395cb1dd27SAsmitha Karunanithi { 64062598e31SEd Tanous BMCWEB_LOG_ERROR("DumpEntry resp_handler got error {}", ec); 6415cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6425cb1dd27SAsmitha Karunanithi return; 6435cb1dd27SAsmitha Karunanithi } 6445cb1dd27SAsmitha Karunanithi 645b47452b2SAsmitha Karunanithi bool foundDumpEntry = false; 64618f8f608SEd Tanous std::string dumpEntryPath = getDumpPath(dumpType) + "/entry/"; 647b47452b2SAsmitha Karunanithi 6489eb808c1SEd Tanous for (const auto& objectPath : resp) 6495cb1dd27SAsmitha Karunanithi { 650b47452b2SAsmitha Karunanithi if (objectPath.first.str != dumpEntryPath + entryID) 6515cb1dd27SAsmitha Karunanithi { 6525cb1dd27SAsmitha Karunanithi continue; 6535cb1dd27SAsmitha Karunanithi } 6545cb1dd27SAsmitha Karunanithi 6555cb1dd27SAsmitha Karunanithi foundDumpEntry = true; 656c6fecdabSClaire Weinan uint64_t timestampUs = 0; 6575cb1dd27SAsmitha Karunanithi uint64_t size = 0; 65835440d18SAsmitha Karunanithi std::string dumpStatus; 65968dd075aSAsmitha Karunanithi std::string originatorId; 66068dd075aSAsmitha Karunanithi log_entry::OriginatorTypes originatorType = 66168dd075aSAsmitha Karunanithi log_entry::OriginatorTypes::Internal; 6625cb1dd27SAsmitha Karunanithi 663aefe3786SClaire Weinan parseDumpEntryFromDbusObject(objectPath, dumpStatus, size, 66468dd075aSAsmitha Karunanithi timestampUs, originatorId, 66568dd075aSAsmitha Karunanithi originatorType, asyncResp); 6665cb1dd27SAsmitha Karunanithi 6670fda0f12SGeorge Liu if (dumpStatus != 6680fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 66935440d18SAsmitha Karunanithi !dumpStatus.empty()) 67035440d18SAsmitha Karunanithi { 67135440d18SAsmitha Karunanithi // Dump status is not Complete 67235440d18SAsmitha Karunanithi // return not found until status is changed to Completed 673d1bde9e5SKrzysztof Grobelny messages::resourceNotFound(asyncResp->res, dumpType + " dump", 674d1bde9e5SKrzysztof Grobelny entryID); 67535440d18SAsmitha Karunanithi return; 67635440d18SAsmitha Karunanithi } 67735440d18SAsmitha Karunanithi 6785cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 67968dd075aSAsmitha Karunanithi "#LogEntry.v1_11_0.LogEntry"; 680fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = entriesPath + entryID; 6815cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = entryID; 6825cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["EntryType"] = "Event"; 6835cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry"; 684bbd80db8SClaire Weinan asyncResp->res.jsonValue["Created"] = 685bbd80db8SClaire Weinan redfish::time_utils::getDateTimeUintUs(timestampUs); 6865cb1dd27SAsmitha Karunanithi 68768dd075aSAsmitha Karunanithi if (!originatorId.empty()) 68868dd075aSAsmitha Karunanithi { 68968dd075aSAsmitha Karunanithi asyncResp->res.jsonValue["Originator"] = originatorId; 69068dd075aSAsmitha Karunanithi asyncResp->res.jsonValue["OriginatorType"] = originatorType; 69168dd075aSAsmitha Karunanithi } 69268dd075aSAsmitha Karunanithi 6935cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 6945cb1dd27SAsmitha Karunanithi { 695d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager"; 696d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 697fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 698fdd26906SClaire Weinan asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 6995cb1dd27SAsmitha Karunanithi } 7005cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 7015cb1dd27SAsmitha Karunanithi { 702d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM"; 703002d39b4SEd Tanous asyncResp->res.jsonValue["OEMDiagnosticDataType"] = "System"; 704d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 705fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 706fdd26906SClaire Weinan asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 7075cb1dd27SAsmitha Karunanithi } 7085cb1dd27SAsmitha Karunanithi } 709e05aec50SEd Tanous if (!foundDumpEntry) 710b47452b2SAsmitha Karunanithi { 71162598e31SEd Tanous BMCWEB_LOG_WARNING("Can't find Dump Entry {}", entryID); 712b90d14f2SMyung Bae messages::resourceNotFound(asyncResp->res, dumpType + " dump", 713b90d14f2SMyung Bae entryID); 714b47452b2SAsmitha Karunanithi return; 715b47452b2SAsmitha Karunanithi } 7165eb468daSGeorge Liu }); 7175cb1dd27SAsmitha Karunanithi } 7185cb1dd27SAsmitha Karunanithi 7198d1b46d7Szhanghch05 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 7209878256fSStanley Chu const std::string& entryID, 721b47452b2SAsmitha Karunanithi const std::string& dumpType) 7225cb1dd27SAsmitha Karunanithi { 7235a39f77aSPatrick Williams auto respHandler = [asyncResp, 7245a39f77aSPatrick Williams entryID](const boost::system::error_code& ec) { 72562598e31SEd Tanous BMCWEB_LOG_DEBUG("Dump Entry doDelete callback: Done"); 7265cb1dd27SAsmitha Karunanithi if (ec) 7275cb1dd27SAsmitha Karunanithi { 7283de8d8baSGeorge Liu if (ec.value() == EBADR) 7293de8d8baSGeorge Liu { 7303de8d8baSGeorge Liu messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 7313de8d8baSGeorge Liu return; 7323de8d8baSGeorge Liu } 73362598e31SEd Tanous BMCWEB_LOG_ERROR( 73462598e31SEd Tanous "Dump (DBus) doDelete respHandler got error {} entryID={}", ec, 73562598e31SEd Tanous entryID); 7365cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 7375cb1dd27SAsmitha Karunanithi return; 7385cb1dd27SAsmitha Karunanithi } 7395cb1dd27SAsmitha Karunanithi }; 74018f8f608SEd Tanous 7415cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 7425cb1dd27SAsmitha Karunanithi respHandler, "xyz.openbmc_project.Dump.Manager", 74318f8f608SEd Tanous std::format("{}/entry/{}", getDumpPath(dumpType), entryID), 7445cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Object.Delete", "Delete"); 7455cb1dd27SAsmitha Karunanithi } 746b5f288d2SAbhilash Raju inline bool checkSizeLimit(int fd, crow::Response& res) 747b5f288d2SAbhilash Raju { 748b5f288d2SAbhilash Raju long long int size = lseek(fd, 0, SEEK_END); 749b5f288d2SAbhilash Raju if (size <= 0) 750b5f288d2SAbhilash Raju { 751b5f288d2SAbhilash Raju BMCWEB_LOG_ERROR("Failed to get size of file, lseek() returned {}", 752b5f288d2SAbhilash Raju size); 753b5f288d2SAbhilash Raju messages::internalError(res); 754b5f288d2SAbhilash Raju return false; 755b5f288d2SAbhilash Raju } 7565cb1dd27SAsmitha Karunanithi 757b5f288d2SAbhilash Raju // Arbitrary max size of 20MB to accommodate BMC dumps 758b5f288d2SAbhilash Raju constexpr long long int maxFileSize = 20LL * 1024LL * 1024LL; 759b5f288d2SAbhilash Raju if (size > maxFileSize) 760b5f288d2SAbhilash Raju { 761b5f288d2SAbhilash Raju BMCWEB_LOG_ERROR("File size {} exceeds maximum allowed size of {}", 762b5f288d2SAbhilash Raju size, maxFileSize); 763b5f288d2SAbhilash Raju messages::internalError(res); 764b5f288d2SAbhilash Raju return false; 765b5f288d2SAbhilash Raju } 766b5f288d2SAbhilash Raju off_t rc = lseek(fd, 0, SEEK_SET); 767b5f288d2SAbhilash Raju if (rc < 0) 768b5f288d2SAbhilash Raju { 769b5f288d2SAbhilash Raju BMCWEB_LOG_ERROR("Failed to reset file offset to 0"); 770b5f288d2SAbhilash Raju messages::internalError(res); 771b5f288d2SAbhilash Raju return false; 772b5f288d2SAbhilash Raju } 773b5f288d2SAbhilash Raju return true; 774b5f288d2SAbhilash Raju } 775168d1b1aSCarson Labrado inline void 776168d1b1aSCarson Labrado downloadEntryCallback(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 777168d1b1aSCarson Labrado const std::string& entryID, 778168d1b1aSCarson Labrado const std::string& downloadEntryType, 779168d1b1aSCarson Labrado const boost::system::error_code& ec, 780168d1b1aSCarson Labrado const sdbusplus::message::unix_fd& unixfd) 781168d1b1aSCarson Labrado { 782168d1b1aSCarson Labrado if (ec.value() == EBADR) 783168d1b1aSCarson Labrado { 784168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, "EntryAttachment", entryID); 785168d1b1aSCarson Labrado return; 786168d1b1aSCarson Labrado } 787168d1b1aSCarson Labrado if (ec) 788168d1b1aSCarson Labrado { 789168d1b1aSCarson Labrado BMCWEB_LOG_ERROR("DBUS response error: {}", ec); 790168d1b1aSCarson Labrado messages::internalError(asyncResp->res); 791168d1b1aSCarson Labrado return; 792168d1b1aSCarson Labrado } 793168d1b1aSCarson Labrado 794168d1b1aSCarson Labrado // Make sure we know how to process the retrieved entry attachment 795168d1b1aSCarson Labrado if ((downloadEntryType != "BMC") && (downloadEntryType != "System")) 796168d1b1aSCarson Labrado { 797168d1b1aSCarson Labrado BMCWEB_LOG_ERROR("downloadEntryCallback() invalid entry type: {}", 798168d1b1aSCarson Labrado downloadEntryType); 799168d1b1aSCarson Labrado messages::internalError(asyncResp->res); 800168d1b1aSCarson Labrado } 801168d1b1aSCarson Labrado 802168d1b1aSCarson Labrado int fd = -1; 803168d1b1aSCarson Labrado fd = dup(unixfd); 804168d1b1aSCarson Labrado if (fd < 0) 805168d1b1aSCarson Labrado { 806168d1b1aSCarson Labrado BMCWEB_LOG_ERROR("Failed to open file"); 807168d1b1aSCarson Labrado messages::internalError(asyncResp->res); 808168d1b1aSCarson Labrado return; 809168d1b1aSCarson Labrado } 810b5f288d2SAbhilash Raju if (!checkSizeLimit(fd, asyncResp->res)) 811168d1b1aSCarson Labrado { 812168d1b1aSCarson Labrado close(fd); 813168d1b1aSCarson Labrado return; 814168d1b1aSCarson Labrado } 815168d1b1aSCarson Labrado if (downloadEntryType == "System") 816168d1b1aSCarson Labrado { 817b5f288d2SAbhilash Raju if (!asyncResp->res.openFd(fd, bmcweb::EncodingType::Base64)) 818b5f288d2SAbhilash Raju { 819b5f288d2SAbhilash Raju messages::internalError(asyncResp->res); 820b5f288d2SAbhilash Raju close(fd); 821b5f288d2SAbhilash Raju return; 822b5f288d2SAbhilash Raju } 823168d1b1aSCarson Labrado asyncResp->res.addHeader( 824168d1b1aSCarson Labrado boost::beast::http::field::content_transfer_encoding, "Base64"); 825b5f288d2SAbhilash Raju return; 826168d1b1aSCarson Labrado } 827b5f288d2SAbhilash Raju if (!asyncResp->res.openFd(fd)) 82827b0cf90SEd Tanous { 829b5f288d2SAbhilash Raju messages::internalError(asyncResp->res); 830b5f288d2SAbhilash Raju close(fd); 831b5f288d2SAbhilash Raju return; 83227b0cf90SEd Tanous } 833168d1b1aSCarson Labrado asyncResp->res.addHeader(boost::beast::http::field::content_type, 834168d1b1aSCarson Labrado "application/octet-stream"); 835168d1b1aSCarson Labrado } 836168d1b1aSCarson Labrado 837168d1b1aSCarson Labrado inline void 838168d1b1aSCarson Labrado downloadDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 839168d1b1aSCarson Labrado const std::string& entryID, const std::string& dumpType) 840168d1b1aSCarson Labrado { 841168d1b1aSCarson Labrado if (dumpType != "BMC") 842168d1b1aSCarson Labrado { 843168d1b1aSCarson Labrado BMCWEB_LOG_WARNING("Can't find Dump Entry {}", entryID); 844168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, dumpType + " dump", entryID); 845168d1b1aSCarson Labrado return; 846168d1b1aSCarson Labrado } 847168d1b1aSCarson Labrado 84818f8f608SEd Tanous std::string dumpEntryPath = std::format("{}/entry/{}", 84918f8f608SEd Tanous getDumpPath(dumpType), entryID); 850168d1b1aSCarson Labrado 851168d1b1aSCarson Labrado auto downloadDumpEntryHandler = 852168d1b1aSCarson Labrado [asyncResp, entryID, 853168d1b1aSCarson Labrado dumpType](const boost::system::error_code& ec, 854168d1b1aSCarson Labrado const sdbusplus::message::unix_fd& unixfd) { 855168d1b1aSCarson Labrado downloadEntryCallback(asyncResp, entryID, dumpType, ec, unixfd); 856168d1b1aSCarson Labrado }; 857168d1b1aSCarson Labrado 858168d1b1aSCarson Labrado crow::connections::systemBus->async_method_call( 859168d1b1aSCarson Labrado std::move(downloadDumpEntryHandler), "xyz.openbmc_project.Dump.Manager", 860168d1b1aSCarson Labrado dumpEntryPath, "xyz.openbmc_project.Dump.Entry", "GetFileHandle"); 861168d1b1aSCarson Labrado } 862168d1b1aSCarson Labrado 863168d1b1aSCarson Labrado inline void 864168d1b1aSCarson Labrado downloadEventLogEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 865168d1b1aSCarson Labrado const std::string& systemName, 866168d1b1aSCarson Labrado const std::string& entryID, 867168d1b1aSCarson Labrado const std::string& dumpType) 868168d1b1aSCarson Labrado { 869168d1b1aSCarson Labrado if constexpr (bmcwebEnableMultiHost) 870168d1b1aSCarson Labrado { 871168d1b1aSCarson Labrado // Option currently returns no systems. TBD 872168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, "ComputerSystem", 873168d1b1aSCarson Labrado systemName); 874168d1b1aSCarson Labrado return; 875168d1b1aSCarson Labrado } 876168d1b1aSCarson Labrado if (systemName != "system") 877168d1b1aSCarson Labrado { 878168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, "ComputerSystem", 879168d1b1aSCarson Labrado systemName); 880168d1b1aSCarson Labrado return; 881168d1b1aSCarson Labrado } 882168d1b1aSCarson Labrado 883168d1b1aSCarson Labrado std::string entryPath = 884168d1b1aSCarson Labrado sdbusplus::message::object_path("/xyz/openbmc_project/logging/entry") / 885168d1b1aSCarson Labrado entryID; 886168d1b1aSCarson Labrado 887168d1b1aSCarson Labrado auto downloadEventLogEntryHandler = 888168d1b1aSCarson Labrado [asyncResp, entryID, 889168d1b1aSCarson Labrado dumpType](const boost::system::error_code& ec, 890168d1b1aSCarson Labrado const sdbusplus::message::unix_fd& unixfd) { 891168d1b1aSCarson Labrado downloadEntryCallback(asyncResp, entryID, dumpType, ec, unixfd); 892168d1b1aSCarson Labrado }; 893168d1b1aSCarson Labrado 894168d1b1aSCarson Labrado crow::connections::systemBus->async_method_call( 895168d1b1aSCarson Labrado std::move(downloadEventLogEntryHandler), "xyz.openbmc_project.Logging", 896168d1b1aSCarson Labrado entryPath, "xyz.openbmc_project.Logging.Entry", "GetEntry"); 897168d1b1aSCarson Labrado } 898168d1b1aSCarson Labrado 8998e31778eSAsmitha Karunanithi inline DumpCreationProgress 9008e31778eSAsmitha Karunanithi mapDbusStatusToDumpProgress(const std::string& status) 901a43be80fSAsmitha Karunanithi { 9028e31778eSAsmitha Karunanithi if (status == 9038e31778eSAsmitha Karunanithi "xyz.openbmc_project.Common.Progress.OperationStatus.Failed" || 9048e31778eSAsmitha Karunanithi status == "xyz.openbmc_project.Common.Progress.OperationStatus.Aborted") 9058e31778eSAsmitha Karunanithi { 9068e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_FAILED; 9078e31778eSAsmitha Karunanithi } 9088e31778eSAsmitha Karunanithi if (status == 9098e31778eSAsmitha Karunanithi "xyz.openbmc_project.Common.Progress.OperationStatus.Completed") 9108e31778eSAsmitha Karunanithi { 9118e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_SUCCESS; 9128e31778eSAsmitha Karunanithi } 9138e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_INPROGRESS; 9148e31778eSAsmitha Karunanithi } 9158e31778eSAsmitha Karunanithi 9168e31778eSAsmitha Karunanithi inline DumpCreationProgress 9178e31778eSAsmitha Karunanithi getDumpCompletionStatus(const dbus::utility::DBusPropertiesMap& values) 9188e31778eSAsmitha Karunanithi { 9198e31778eSAsmitha Karunanithi for (const auto& [key, val] : values) 9208e31778eSAsmitha Karunanithi { 9218e31778eSAsmitha Karunanithi if (key == "Status") 9228e31778eSAsmitha Karunanithi { 9238e31778eSAsmitha Karunanithi const std::string* value = std::get_if<std::string>(&val); 9248e31778eSAsmitha Karunanithi if (value == nullptr) 9258e31778eSAsmitha Karunanithi { 92662598e31SEd Tanous BMCWEB_LOG_ERROR("Status property value is null"); 9278e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_FAILED; 9288e31778eSAsmitha Karunanithi } 9298e31778eSAsmitha Karunanithi return mapDbusStatusToDumpProgress(*value); 9308e31778eSAsmitha Karunanithi } 9318e31778eSAsmitha Karunanithi } 9328e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_INPROGRESS; 9338e31778eSAsmitha Karunanithi } 9348e31778eSAsmitha Karunanithi 9358e31778eSAsmitha Karunanithi inline std::string getDumpEntryPath(const std::string& dumpPath) 9368e31778eSAsmitha Karunanithi { 9378e31778eSAsmitha Karunanithi if (dumpPath == "/xyz/openbmc_project/dump/bmc/entry") 9388e31778eSAsmitha Karunanithi { 9398e31778eSAsmitha Karunanithi return "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 9408e31778eSAsmitha Karunanithi } 9418e31778eSAsmitha Karunanithi if (dumpPath == "/xyz/openbmc_project/dump/system/entry") 9428e31778eSAsmitha Karunanithi { 9438e31778eSAsmitha Karunanithi return "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 9448e31778eSAsmitha Karunanithi } 9458e31778eSAsmitha Karunanithi return ""; 9468e31778eSAsmitha Karunanithi } 9478e31778eSAsmitha Karunanithi 9488e31778eSAsmitha Karunanithi inline void createDumpTaskCallback( 9498e31778eSAsmitha Karunanithi task::Payload&& payload, 9508e31778eSAsmitha Karunanithi const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 9518e31778eSAsmitha Karunanithi const sdbusplus::message::object_path& createdObjPath) 9528e31778eSAsmitha Karunanithi { 9538e31778eSAsmitha Karunanithi const std::string dumpPath = createdObjPath.parent_path().str; 9548e31778eSAsmitha Karunanithi const std::string dumpId = createdObjPath.filename(); 9558e31778eSAsmitha Karunanithi 9568e31778eSAsmitha Karunanithi std::string dumpEntryPath = getDumpEntryPath(dumpPath); 9578e31778eSAsmitha Karunanithi 9588e31778eSAsmitha Karunanithi if (dumpEntryPath.empty()) 9598e31778eSAsmitha Karunanithi { 96062598e31SEd Tanous BMCWEB_LOG_ERROR("Invalid dump type received"); 9618e31778eSAsmitha Karunanithi messages::internalError(asyncResp->res); 9628e31778eSAsmitha Karunanithi return; 9638e31778eSAsmitha Karunanithi } 9648e31778eSAsmitha Karunanithi 9658e31778eSAsmitha Karunanithi crow::connections::systemBus->async_method_call( 9668e31778eSAsmitha Karunanithi [asyncResp, payload, createdObjPath, 9678e31778eSAsmitha Karunanithi dumpEntryPath{std::move(dumpEntryPath)}, 9685e7e2dc5SEd Tanous dumpId](const boost::system::error_code& ec, 9698e31778eSAsmitha Karunanithi const std::string& introspectXml) { 9708e31778eSAsmitha Karunanithi if (ec) 9718e31778eSAsmitha Karunanithi { 97262598e31SEd Tanous BMCWEB_LOG_ERROR("Introspect call failed with error: {}", 97362598e31SEd Tanous ec.message()); 9748e31778eSAsmitha Karunanithi messages::internalError(asyncResp->res); 9758e31778eSAsmitha Karunanithi return; 9768e31778eSAsmitha Karunanithi } 9778e31778eSAsmitha Karunanithi 9788e31778eSAsmitha Karunanithi // Check if the created dump object has implemented Progress 9798e31778eSAsmitha Karunanithi // interface to track dump completion. If yes, fetch the "Status" 9808e31778eSAsmitha Karunanithi // property of the interface, modify the task state accordingly. 9818e31778eSAsmitha Karunanithi // Else, return task completed. 9828e31778eSAsmitha Karunanithi tinyxml2::XMLDocument doc; 9838e31778eSAsmitha Karunanithi 9848e31778eSAsmitha Karunanithi doc.Parse(introspectXml.data(), introspectXml.size()); 9858e31778eSAsmitha Karunanithi tinyxml2::XMLNode* pRoot = doc.FirstChildElement("node"); 9868e31778eSAsmitha Karunanithi if (pRoot == nullptr) 9878e31778eSAsmitha Karunanithi { 98862598e31SEd Tanous BMCWEB_LOG_ERROR("XML document failed to parse"); 9898e31778eSAsmitha Karunanithi messages::internalError(asyncResp->res); 9908e31778eSAsmitha Karunanithi return; 9918e31778eSAsmitha Karunanithi } 9928e31778eSAsmitha Karunanithi tinyxml2::XMLElement* interfaceNode = 9938e31778eSAsmitha Karunanithi pRoot->FirstChildElement("interface"); 9948e31778eSAsmitha Karunanithi 9958e31778eSAsmitha Karunanithi bool isProgressIntfPresent = false; 9968e31778eSAsmitha Karunanithi while (interfaceNode != nullptr) 9978e31778eSAsmitha Karunanithi { 9988e31778eSAsmitha Karunanithi const char* thisInterfaceName = interfaceNode->Attribute("name"); 9998e31778eSAsmitha Karunanithi if (thisInterfaceName != nullptr) 10008e31778eSAsmitha Karunanithi { 10018e31778eSAsmitha Karunanithi if (thisInterfaceName == 10028e31778eSAsmitha Karunanithi std::string_view("xyz.openbmc_project.Common.Progress")) 10038e31778eSAsmitha Karunanithi { 10048e31778eSAsmitha Karunanithi interfaceNode = 10058e31778eSAsmitha Karunanithi interfaceNode->NextSiblingElement("interface"); 10068e31778eSAsmitha Karunanithi continue; 10078e31778eSAsmitha Karunanithi } 10088e31778eSAsmitha Karunanithi isProgressIntfPresent = true; 10098e31778eSAsmitha Karunanithi break; 10108e31778eSAsmitha Karunanithi } 10118e31778eSAsmitha Karunanithi interfaceNode = interfaceNode->NextSiblingElement("interface"); 10128e31778eSAsmitha Karunanithi } 10138e31778eSAsmitha Karunanithi 1014a43be80fSAsmitha Karunanithi std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 10158e31778eSAsmitha Karunanithi [createdObjPath, dumpEntryPath, dumpId, isProgressIntfPresent]( 10168b24275dSEd Tanous const boost::system::error_code& ec2, sdbusplus::message_t& msg, 1017a43be80fSAsmitha Karunanithi const std::shared_ptr<task::TaskData>& taskData) { 10188b24275dSEd Tanous if (ec2) 1019cb13a392SEd Tanous { 102062598e31SEd Tanous BMCWEB_LOG_ERROR("{}: Error in creating dump", 102162598e31SEd Tanous createdObjPath.str); 10228e31778eSAsmitha Karunanithi taskData->messages.emplace_back(messages::internalError()); 10236145ed6fSAsmitha Karunanithi taskData->state = "Cancelled"; 10246145ed6fSAsmitha Karunanithi return task::completed; 1025cb13a392SEd Tanous } 1026b9d36b47SEd Tanous 10278e31778eSAsmitha Karunanithi if (isProgressIntfPresent) 1028a43be80fSAsmitha Karunanithi { 10298e31778eSAsmitha Karunanithi dbus::utility::DBusPropertiesMap values; 10308e31778eSAsmitha Karunanithi std::string prop; 10318e31778eSAsmitha Karunanithi msg.read(prop, values); 10328e31778eSAsmitha Karunanithi 10338e31778eSAsmitha Karunanithi DumpCreationProgress dumpStatus = 10348e31778eSAsmitha Karunanithi getDumpCompletionStatus(values); 10358e31778eSAsmitha Karunanithi if (dumpStatus == DumpCreationProgress::DUMP_CREATE_FAILED) 10368e31778eSAsmitha Karunanithi { 103762598e31SEd Tanous BMCWEB_LOG_ERROR("{}: Error in creating dump", 103862598e31SEd Tanous createdObjPath.str); 10398e31778eSAsmitha Karunanithi taskData->state = "Cancelled"; 10408e31778eSAsmitha Karunanithi return task::completed; 10418e31778eSAsmitha Karunanithi } 10428e31778eSAsmitha Karunanithi 10438e31778eSAsmitha Karunanithi if (dumpStatus == DumpCreationProgress::DUMP_CREATE_INPROGRESS) 10448e31778eSAsmitha Karunanithi { 104562598e31SEd Tanous BMCWEB_LOG_DEBUG("{}: Dump creation task is in progress", 104662598e31SEd Tanous createdObjPath.str); 10478e31778eSAsmitha Karunanithi return !task::completed; 10488e31778eSAsmitha Karunanithi } 10498e31778eSAsmitha Karunanithi } 10508e31778eSAsmitha Karunanithi 1051a43be80fSAsmitha Karunanithi nlohmann::json retMessage = messages::success(); 1052a43be80fSAsmitha Karunanithi taskData->messages.emplace_back(retMessage); 1053a43be80fSAsmitha Karunanithi 1054c51a58eeSEd Tanous boost::urls::url url = boost::urls::format( 1055c51a58eeSEd Tanous "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/{}", dumpId); 1056c51a58eeSEd Tanous 1057c51a58eeSEd Tanous std::string headerLoc = "Location: "; 1058c51a58eeSEd Tanous headerLoc += url.buffer(); 1059c51a58eeSEd Tanous 1060002d39b4SEd Tanous taskData->payload->httpHeaders.emplace_back(std::move(headerLoc)); 1061a43be80fSAsmitha Karunanithi 106262598e31SEd Tanous BMCWEB_LOG_DEBUG("{}: Dump creation task completed", 106362598e31SEd Tanous createdObjPath.str); 1064a43be80fSAsmitha Karunanithi taskData->state = "Completed"; 1065b47452b2SAsmitha Karunanithi return task::completed; 1066a43be80fSAsmitha Karunanithi }, 10678e31778eSAsmitha Karunanithi "type='signal',interface='org.freedesktop.DBus.Properties'," 10688e31778eSAsmitha Karunanithi "member='PropertiesChanged',path='" + 10698e31778eSAsmitha Karunanithi createdObjPath.str + "'"); 1070a43be80fSAsmitha Karunanithi 10718e31778eSAsmitha Karunanithi // The task timer is set to max time limit within which the 10728e31778eSAsmitha Karunanithi // requested dump will be collected. 10738e31778eSAsmitha Karunanithi task->startTimer(std::chrono::minutes(6)); 1074a43be80fSAsmitha Karunanithi task->populateResp(asyncResp->res); 10758e31778eSAsmitha Karunanithi task->payload.emplace(payload); 10768e31778eSAsmitha Karunanithi }, 10778e31778eSAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", createdObjPath, 10788e31778eSAsmitha Karunanithi "org.freedesktop.DBus.Introspectable", "Introspect"); 1079a43be80fSAsmitha Karunanithi } 1080a43be80fSAsmitha Karunanithi 10818d1b46d7Szhanghch05 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 10828d1b46d7Szhanghch05 const crow::Request& req, const std::string& dumpType) 1083a43be80fSAsmitha Karunanithi { 1084fdd26906SClaire Weinan std::string dumpPath = getDumpEntriesPath(dumpType); 1085fdd26906SClaire Weinan if (dumpPath.empty()) 1086a43be80fSAsmitha Karunanithi { 1087a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 1088a43be80fSAsmitha Karunanithi return; 1089a43be80fSAsmitha Karunanithi } 1090a43be80fSAsmitha Karunanithi 1091a43be80fSAsmitha Karunanithi std::optional<std::string> diagnosticDataType; 1092a43be80fSAsmitha Karunanithi std::optional<std::string> oemDiagnosticDataType; 1093a43be80fSAsmitha Karunanithi 109415ed6780SWilly Tu if (!redfish::json_util::readJsonAction( 1095a43be80fSAsmitha Karunanithi req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 1096a43be80fSAsmitha Karunanithi "OEMDiagnosticDataType", oemDiagnosticDataType)) 1097a43be80fSAsmitha Karunanithi { 1098a43be80fSAsmitha Karunanithi return; 1099a43be80fSAsmitha Karunanithi } 1100a43be80fSAsmitha Karunanithi 1101a43be80fSAsmitha Karunanithi if (dumpType == "System") 1102a43be80fSAsmitha Karunanithi { 1103a43be80fSAsmitha Karunanithi if (!oemDiagnosticDataType || !diagnosticDataType) 1104a43be80fSAsmitha Karunanithi { 110562598e31SEd Tanous BMCWEB_LOG_ERROR( 110662598e31SEd Tanous "CreateDump action parameter 'DiagnosticDataType'/'OEMDiagnosticDataType' value not found!"); 1107a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 1108a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", 1109a43be80fSAsmitha Karunanithi "DiagnosticDataType & OEMDiagnosticDataType"); 1110a43be80fSAsmitha Karunanithi return; 1111a43be80fSAsmitha Karunanithi } 11123174e4dfSEd Tanous if ((*oemDiagnosticDataType != "System") || 1113a43be80fSAsmitha Karunanithi (*diagnosticDataType != "OEM")) 1114a43be80fSAsmitha Karunanithi { 111562598e31SEd Tanous BMCWEB_LOG_ERROR("Wrong parameter values passed"); 1116ace85d60SEd Tanous messages::internalError(asyncResp->res); 1117a43be80fSAsmitha Karunanithi return; 1118a43be80fSAsmitha Karunanithi } 11195907571dSAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/"; 1120a43be80fSAsmitha Karunanithi } 1121a43be80fSAsmitha Karunanithi else if (dumpType == "BMC") 1122a43be80fSAsmitha Karunanithi { 1123a43be80fSAsmitha Karunanithi if (!diagnosticDataType) 1124a43be80fSAsmitha Karunanithi { 112562598e31SEd Tanous BMCWEB_LOG_ERROR( 112662598e31SEd Tanous "CreateDump action parameter 'DiagnosticDataType' not found!"); 1127a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 1128a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType"); 1129a43be80fSAsmitha Karunanithi return; 1130a43be80fSAsmitha Karunanithi } 11313174e4dfSEd Tanous if (*diagnosticDataType != "Manager") 1132a43be80fSAsmitha Karunanithi { 113362598e31SEd Tanous BMCWEB_LOG_ERROR( 113462598e31SEd Tanous "Wrong parameter value passed for 'DiagnosticDataType'"); 1135ace85d60SEd Tanous messages::internalError(asyncResp->res); 1136a43be80fSAsmitha Karunanithi return; 1137a43be80fSAsmitha Karunanithi } 11385907571dSAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/"; 11395907571dSAsmitha Karunanithi } 11405907571dSAsmitha Karunanithi else 11415907571dSAsmitha Karunanithi { 114262598e31SEd Tanous BMCWEB_LOG_ERROR("CreateDump failed. Unknown dump type"); 11435907571dSAsmitha Karunanithi messages::internalError(asyncResp->res); 11445907571dSAsmitha Karunanithi return; 1145a43be80fSAsmitha Karunanithi } 1146a43be80fSAsmitha Karunanithi 11478e31778eSAsmitha Karunanithi std::vector<std::pair<std::string, std::variant<std::string, uint64_t>>> 11488e31778eSAsmitha Karunanithi createDumpParamVec; 11498e31778eSAsmitha Karunanithi 1150f574a8e1SCarson Labrado if (req.session != nullptr) 1151f574a8e1SCarson Labrado { 115268dd075aSAsmitha Karunanithi createDumpParamVec.emplace_back( 115368dd075aSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorId", 115468dd075aSAsmitha Karunanithi req.session->clientIp); 115568dd075aSAsmitha Karunanithi createDumpParamVec.emplace_back( 115668dd075aSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorType", 115768dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client"); 1158f574a8e1SCarson Labrado } 115968dd075aSAsmitha Karunanithi 1160a43be80fSAsmitha Karunanithi crow::connections::systemBus->async_method_call( 11615e7e2dc5SEd Tanous [asyncResp, payload(task::Payload(req)), 11625e7e2dc5SEd Tanous dumpPath](const boost::system::error_code& ec, 11635e7e2dc5SEd Tanous const sdbusplus::message_t& msg, 11648e31778eSAsmitha Karunanithi const sdbusplus::message::object_path& objPath) mutable { 1165a43be80fSAsmitha Karunanithi if (ec) 1166a43be80fSAsmitha Karunanithi { 116762598e31SEd Tanous BMCWEB_LOG_ERROR("CreateDump resp_handler got error {}", ec); 11685907571dSAsmitha Karunanithi const sd_bus_error* dbusError = msg.get_error(); 11695907571dSAsmitha Karunanithi if (dbusError == nullptr) 11705907571dSAsmitha Karunanithi { 11715907571dSAsmitha Karunanithi messages::internalError(asyncResp->res); 11725907571dSAsmitha Karunanithi return; 11735907571dSAsmitha Karunanithi } 11745907571dSAsmitha Karunanithi 117562598e31SEd Tanous BMCWEB_LOG_ERROR("CreateDump DBus error: {} and error msg: {}", 117662598e31SEd Tanous dbusError->name, dbusError->message); 11775907571dSAsmitha Karunanithi if (std::string_view( 11785907571dSAsmitha Karunanithi "xyz.openbmc_project.Common.Error.NotAllowed") == 11795907571dSAsmitha Karunanithi dbusError->name) 11805907571dSAsmitha Karunanithi { 11815907571dSAsmitha Karunanithi messages::resourceInStandby(asyncResp->res); 11825907571dSAsmitha Karunanithi return; 11835907571dSAsmitha Karunanithi } 11845907571dSAsmitha Karunanithi if (std::string_view( 11855907571dSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create.Error.Disabled") == 11865907571dSAsmitha Karunanithi dbusError->name) 11875907571dSAsmitha Karunanithi { 11885907571dSAsmitha Karunanithi messages::serviceDisabled(asyncResp->res, dumpPath); 11895907571dSAsmitha Karunanithi return; 11905907571dSAsmitha Karunanithi } 11915907571dSAsmitha Karunanithi if (std::string_view( 11925907571dSAsmitha Karunanithi "xyz.openbmc_project.Common.Error.Unavailable") == 11935907571dSAsmitha Karunanithi dbusError->name) 11945907571dSAsmitha Karunanithi { 11955907571dSAsmitha Karunanithi messages::resourceInUse(asyncResp->res); 11965907571dSAsmitha Karunanithi return; 11975907571dSAsmitha Karunanithi } 11985907571dSAsmitha Karunanithi // Other Dbus errors such as: 11995907571dSAsmitha Karunanithi // xyz.openbmc_project.Common.Error.InvalidArgument & 12005907571dSAsmitha Karunanithi // org.freedesktop.DBus.Error.InvalidArgs are all related to 12015907571dSAsmitha Karunanithi // the dbus call that is made here in the bmcweb 12025907571dSAsmitha Karunanithi // implementation and has nothing to do with the client's 12035907571dSAsmitha Karunanithi // input in the request. Hence, returning internal error 12045907571dSAsmitha Karunanithi // back to the client. 1205a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 1206a43be80fSAsmitha Karunanithi return; 1207a43be80fSAsmitha Karunanithi } 120862598e31SEd Tanous BMCWEB_LOG_DEBUG("Dump Created. Path: {}", objPath.str); 12098e31778eSAsmitha Karunanithi createDumpTaskCallback(std::move(payload), asyncResp, objPath); 1210a43be80fSAsmitha Karunanithi }, 121118f8f608SEd Tanous "xyz.openbmc_project.Dump.Manager", getDumpPath(dumpType), 12128e31778eSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create", "CreateDump", createDumpParamVec); 1213a43be80fSAsmitha Karunanithi } 1214a43be80fSAsmitha Karunanithi 12158d1b46d7Szhanghch05 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 12168d1b46d7Szhanghch05 const std::string& dumpType) 121780319af1SAsmitha Karunanithi { 12180d946211SClaire Weinan crow::connections::systemBus->async_method_call( 12190d946211SClaire Weinan [asyncResp](const boost::system::error_code& ec) { 122080319af1SAsmitha Karunanithi if (ec) 122180319af1SAsmitha Karunanithi { 122262598e31SEd Tanous BMCWEB_LOG_ERROR("clearDump resp_handler got error {}", ec); 122380319af1SAsmitha Karunanithi messages::internalError(asyncResp->res); 122480319af1SAsmitha Karunanithi return; 122580319af1SAsmitha Karunanithi } 12260d946211SClaire Weinan }, 122718f8f608SEd Tanous "xyz.openbmc_project.Dump.Manager", getDumpPath(dumpType), 12280d946211SClaire Weinan "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 122980319af1SAsmitha Karunanithi } 123080319af1SAsmitha Karunanithi 1231b9d36b47SEd Tanous inline static void 1232b9d36b47SEd Tanous parseCrashdumpParameters(const dbus::utility::DBusPropertiesMap& params, 1233b9d36b47SEd Tanous std::string& filename, std::string& timestamp, 1234b9d36b47SEd Tanous std::string& logfile) 1235043a0536SJohnathan Mantey { 1236d1bde9e5SKrzysztof Grobelny const std::string* filenamePtr = nullptr; 1237d1bde9e5SKrzysztof Grobelny const std::string* timestampPtr = nullptr; 1238d1bde9e5SKrzysztof Grobelny const std::string* logfilePtr = nullptr; 1239d1bde9e5SKrzysztof Grobelny 1240d1bde9e5SKrzysztof Grobelny const bool success = sdbusplus::unpackPropertiesNoThrow( 1241d1bde9e5SKrzysztof Grobelny dbus_utils::UnpackErrorPrinter(), params, "Timestamp", timestampPtr, 1242d1bde9e5SKrzysztof Grobelny "Filename", filenamePtr, "Log", logfilePtr); 1243d1bde9e5SKrzysztof Grobelny 1244d1bde9e5SKrzysztof Grobelny if (!success) 1245043a0536SJohnathan Mantey { 1246d1bde9e5SKrzysztof Grobelny return; 1247043a0536SJohnathan Mantey } 1248d1bde9e5SKrzysztof Grobelny 1249d1bde9e5SKrzysztof Grobelny if (filenamePtr != nullptr) 1250043a0536SJohnathan Mantey { 1251d1bde9e5SKrzysztof Grobelny filename = *filenamePtr; 1252d1bde9e5SKrzysztof Grobelny } 1253d1bde9e5SKrzysztof Grobelny 1254d1bde9e5SKrzysztof Grobelny if (timestampPtr != nullptr) 1255043a0536SJohnathan Mantey { 1256d1bde9e5SKrzysztof Grobelny timestamp = *timestampPtr; 1257043a0536SJohnathan Mantey } 1258d1bde9e5SKrzysztof Grobelny 1259d1bde9e5SKrzysztof Grobelny if (logfilePtr != nullptr) 1260043a0536SJohnathan Mantey { 1261d1bde9e5SKrzysztof Grobelny logfile = *logfilePtr; 1262043a0536SJohnathan Mantey } 1263043a0536SJohnathan Mantey } 1264043a0536SJohnathan Mantey 12657e860f15SJohn Edward Broadbent inline void requestRoutesSystemLogServiceCollection(App& app) 12661da66f75SEd Tanous { 1267c4bf6374SJason M. Bills /** 1268c4bf6374SJason M. Bills * Functions triggers appropriate requests on DBus 1269c4bf6374SJason M. Bills */ 127022d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/") 1271ed398213SEd Tanous .privileges(redfish::privileges::getLogServiceCollection) 1272002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1273002d39b4SEd Tanous [&app](const crow::Request& req, 127422d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 127522d268cbSEd Tanous const std::string& systemName) { 12763ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1277c4bf6374SJason M. Bills { 127845ca1b86SEd Tanous return; 127945ca1b86SEd Tanous } 12807f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 12817f3e84a1SEd Tanous { 12827f3e84a1SEd Tanous // Option currently returns no systems. TBD 12837f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 12847f3e84a1SEd Tanous systemName); 12857f3e84a1SEd Tanous return; 12867f3e84a1SEd Tanous } 128722d268cbSEd Tanous if (systemName != "system") 128822d268cbSEd Tanous { 128922d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 129022d268cbSEd Tanous systemName); 129122d268cbSEd Tanous return; 129222d268cbSEd Tanous } 129322d268cbSEd Tanous 12947e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 12957e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1296c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1297c4bf6374SJason M. Bills "#LogServiceCollection.LogServiceCollection"; 1298c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1299029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices"; 130045ca1b86SEd Tanous asyncResp->res.jsonValue["Name"] = "System Log Services Collection"; 1301c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 1302c4bf6374SJason M. Bills "Collection of LogServices for this Computer System"; 1303002d39b4SEd Tanous nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 1304c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 13051476687dSEd Tanous nlohmann::json::object_t eventLog; 13061476687dSEd Tanous eventLog["@odata.id"] = 13071476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 1308b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(eventLog)); 13095cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 13101476687dSEd Tanous nlohmann::json::object_t dumpLog; 1311002d39b4SEd Tanous dumpLog["@odata.id"] = "/redfish/v1/Systems/system/LogServices/Dump"; 1312b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(dumpLog)); 1313c9bb6861Sraviteja-b #endif 1314c9bb6861Sraviteja-b 1315d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG 13161476687dSEd Tanous nlohmann::json::object_t crashdump; 13171476687dSEd Tanous crashdump["@odata.id"] = 13181476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump"; 1319b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(crashdump)); 1320d53dd41fSJason M. Bills #endif 1321b7028ebfSSpencer Ku 1322b7028ebfSSpencer Ku #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER 13231476687dSEd Tanous nlohmann::json::object_t hostlogger; 13241476687dSEd Tanous hostlogger["@odata.id"] = 13251476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger"; 1326b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(hostlogger)); 1327b7028ebfSSpencer Ku #endif 1328c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 1329c4bf6374SJason M. Bills logServiceArray.size(); 1330a3316fc6SZhikuiRen 13317a1dbc48SGeorge Liu constexpr std::array<std::string_view, 1> interfaces = { 13327a1dbc48SGeorge Liu "xyz.openbmc_project.State.Boot.PostCode"}; 13337a1dbc48SGeorge Liu dbus::utility::getSubTreePaths( 13347a1dbc48SGeorge Liu "/", 0, interfaces, 13357a1dbc48SGeorge Liu [asyncResp](const boost::system::error_code& ec, 1336b9d36b47SEd Tanous const dbus::utility::MapperGetSubTreePathsResponse& 1337b9d36b47SEd Tanous subtreePath) { 1338a3316fc6SZhikuiRen if (ec) 1339a3316fc6SZhikuiRen { 134062598e31SEd Tanous BMCWEB_LOG_ERROR("{}", ec); 1341a3316fc6SZhikuiRen return; 1342a3316fc6SZhikuiRen } 1343a3316fc6SZhikuiRen 134455f79e6fSEd Tanous for (const auto& pathStr : subtreePath) 1345a3316fc6SZhikuiRen { 1346a3316fc6SZhikuiRen if (pathStr.find("PostCode") != std::string::npos) 1347a3316fc6SZhikuiRen { 134823a21a1cSEd Tanous nlohmann::json& logServiceArrayLocal = 1349a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"]; 1350613dabeaSEd Tanous nlohmann::json::object_t member; 1351613dabeaSEd Tanous member["@odata.id"] = 1352613dabeaSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes"; 1353613dabeaSEd Tanous 1354b2ba3072SPatrick Williams logServiceArrayLocal.emplace_back(std::move(member)); 1355613dabeaSEd Tanous 135645ca1b86SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = 135723a21a1cSEd Tanous logServiceArrayLocal.size(); 1358a3316fc6SZhikuiRen return; 1359a3316fc6SZhikuiRen } 1360a3316fc6SZhikuiRen } 13617a1dbc48SGeorge Liu }); 13627e860f15SJohn Edward Broadbent }); 1363c4bf6374SJason M. Bills } 1364c4bf6374SJason M. Bills 13657e860f15SJohn Edward Broadbent inline void requestRoutesEventLogService(App& app) 1366c4bf6374SJason M. Bills { 136722d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/") 1368ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 1369002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1370002d39b4SEd Tanous [&app](const crow::Request& req, 137122d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 137222d268cbSEd Tanous const std::string& systemName) { 13733ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 137445ca1b86SEd Tanous { 137545ca1b86SEd Tanous return; 137645ca1b86SEd Tanous } 137722d268cbSEd Tanous if (systemName != "system") 137822d268cbSEd Tanous { 137922d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 138022d268cbSEd Tanous systemName); 138122d268cbSEd Tanous return; 138222d268cbSEd Tanous } 1383c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1384029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 1385c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1386b25644a1SJanet Adkins "#LogService.v1_2_0.LogService"; 1387c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "Event Log Service"; 1388002d39b4SEd Tanous asyncResp->res.jsonValue["Description"] = "System Event Log Service"; 1389c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "EventLog"; 1390c4bf6374SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 13917c8c4058STejas Patil 13927c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 13932b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 13947c8c4058STejas Patil 13957c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 13967c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 13977c8c4058STejas Patil redfishDateTimeOffset.second; 13987c8c4058STejas Patil 13991476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 14001476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1401e7d6c8b2SGunnar Mills asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 1402e7d6c8b2SGunnar Mills 14030fda0f12SGeorge Liu {"target", 14040fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog"}}; 14057e860f15SJohn Edward Broadbent }); 1406489640c6SJason M. Bills } 1407489640c6SJason M. Bills 14087e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogClear(App& app) 1409489640c6SJason M. Bills { 14104978b63fSJason M. Bills BMCWEB_ROUTE( 14114978b63fSJason M. Bills app, 141222d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/") 1413432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 14147e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 141545ca1b86SEd Tanous [&app](const crow::Request& req, 141622d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 141722d268cbSEd Tanous const std::string& systemName) { 14183ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 141945ca1b86SEd Tanous { 142045ca1b86SEd Tanous return; 142145ca1b86SEd Tanous } 142222d268cbSEd Tanous if (systemName != "system") 142322d268cbSEd Tanous { 142422d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 142522d268cbSEd Tanous systemName); 142622d268cbSEd Tanous return; 142722d268cbSEd Tanous } 1428489640c6SJason M. Bills // Clear the EventLog by deleting the log files 1429489640c6SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1430489640c6SJason M. Bills if (getRedfishLogFiles(redfishLogFiles)) 1431489640c6SJason M. Bills { 1432489640c6SJason M. Bills for (const std::filesystem::path& file : redfishLogFiles) 1433489640c6SJason M. Bills { 1434489640c6SJason M. Bills std::error_code ec; 1435489640c6SJason M. Bills std::filesystem::remove(file, ec); 1436489640c6SJason M. Bills } 1437489640c6SJason M. Bills } 1438489640c6SJason M. Bills 1439489640c6SJason M. Bills // Reload rsyslog so it knows to start new log files 1440489640c6SJason M. Bills crow::connections::systemBus->async_method_call( 14415e7e2dc5SEd Tanous [asyncResp](const boost::system::error_code& ec) { 1442489640c6SJason M. Bills if (ec) 1443489640c6SJason M. Bills { 144462598e31SEd Tanous BMCWEB_LOG_ERROR("Failed to reload rsyslog: {}", ec); 1445489640c6SJason M. Bills messages::internalError(asyncResp->res); 1446489640c6SJason M. Bills return; 1447489640c6SJason M. Bills } 1448489640c6SJason M. Bills 1449489640c6SJason M. Bills messages::success(asyncResp->res); 1450489640c6SJason M. Bills }, 1451489640c6SJason M. Bills "org.freedesktop.systemd1", "/org/freedesktop/systemd1", 1452002d39b4SEd Tanous "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service", 1453002d39b4SEd Tanous "replace"); 14547e860f15SJohn Edward Broadbent }); 1455c4bf6374SJason M. Bills } 1456c4bf6374SJason M. Bills 1457ac992cdeSJason M. Bills enum class LogParseError 1458ac992cdeSJason M. Bills { 1459ac992cdeSJason M. Bills success, 1460ac992cdeSJason M. Bills parseFailed, 1461ac992cdeSJason M. Bills messageIdNotInRegistry, 1462ac992cdeSJason M. Bills }; 1463ac992cdeSJason M. Bills 1464ac992cdeSJason M. Bills static LogParseError 1465ac992cdeSJason M. Bills fillEventLogEntryJson(const std::string& logEntryID, 1466b5a76932SEd Tanous const std::string& logEntry, 1467de703c5dSJason M. Bills nlohmann::json::object_t& logEntryJson) 1468c4bf6374SJason M. Bills { 146995820184SJason M. Bills // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1470cd225da8SJason M. Bills // First get the Timestamp 1471f23b7296SEd Tanous size_t space = logEntry.find_first_of(' '); 1472cd225da8SJason M. Bills if (space == std::string::npos) 147395820184SJason M. Bills { 1474ac992cdeSJason M. Bills return LogParseError::parseFailed; 147595820184SJason M. Bills } 1476cd225da8SJason M. Bills std::string timestamp = logEntry.substr(0, space); 1477cd225da8SJason M. Bills // Then get the log contents 1478f23b7296SEd Tanous size_t entryStart = logEntry.find_first_not_of(' ', space); 1479cd225da8SJason M. Bills if (entryStart == std::string::npos) 1480cd225da8SJason M. Bills { 1481ac992cdeSJason M. Bills return LogParseError::parseFailed; 1482cd225da8SJason M. Bills } 1483cd225da8SJason M. Bills std::string_view entry(logEntry); 1484cd225da8SJason M. Bills entry.remove_prefix(entryStart); 1485cd225da8SJason M. Bills // Use split to separate the entry into its fields 1486cd225da8SJason M. Bills std::vector<std::string> logEntryFields; 148750ebd4afSEd Tanous bmcweb::split(logEntryFields, entry, ','); 1488cd225da8SJason M. Bills // We need at least a MessageId to be valid 14891e6deaf6SEd Tanous auto logEntryIter = logEntryFields.begin(); 14901e6deaf6SEd Tanous if (logEntryIter == logEntryFields.end()) 1491cd225da8SJason M. Bills { 1492ac992cdeSJason M. Bills return LogParseError::parseFailed; 1493cd225da8SJason M. Bills } 14941e6deaf6SEd Tanous std::string& messageID = *logEntryIter; 14954851d45dSJason M. Bills // Get the Message from the MessageRegistry 1496fffb8c1fSEd Tanous const registries::Message* message = registries::getMessage(messageID); 1497c4bf6374SJason M. Bills 14981e6deaf6SEd Tanous logEntryIter++; 149954417b02SSui Chen if (message == nullptr) 1500c4bf6374SJason M. Bills { 150162598e31SEd Tanous BMCWEB_LOG_WARNING("Log entry not found in registry: {}", logEntry); 1502ac992cdeSJason M. Bills return LogParseError::messageIdNotInRegistry; 1503c4bf6374SJason M. Bills } 1504c4bf6374SJason M. Bills 15051e6deaf6SEd Tanous std::vector<std::string_view> messageArgs(logEntryIter, 15061e6deaf6SEd Tanous logEntryFields.end()); 1507c05bba45SEd Tanous messageArgs.resize(message->numberOfArgs); 1508c05bba45SEd Tanous 15091e6deaf6SEd Tanous std::string msg = redfish::registries::fillMessageArgs(messageArgs, 15101e6deaf6SEd Tanous message->message); 15111e6deaf6SEd Tanous if (msg.empty()) 151215a86ff6SJason M. Bills { 15131e6deaf6SEd Tanous return LogParseError::parseFailed; 151415a86ff6SJason M. Bills } 15154851d45dSJason M. Bills 151695820184SJason M. Bills // Get the Created time from the timestamp. The log timestamp is in RFC3339 151795820184SJason M. Bills // format which matches the Redfish format except for the fractional seconds 151895820184SJason M. Bills // between the '.' and the '+', so just remove them. 1519f23b7296SEd Tanous std::size_t dot = timestamp.find_first_of('.'); 1520f23b7296SEd Tanous std::size_t plus = timestamp.find_first_of('+'); 152195820184SJason M. Bills if (dot != std::string::npos && plus != std::string::npos) 1522c4bf6374SJason M. Bills { 152395820184SJason M. Bills timestamp.erase(dot, plus - dot); 1524c4bf6374SJason M. Bills } 1525c4bf6374SJason M. Bills 1526c4bf6374SJason M. Bills // Fill in the log entry with the gathered data 15279c11a172SVijay Lobo logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 1528ef4c65b7SEd Tanous logEntryJson["@odata.id"] = boost::urls::format( 1529ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}", 1530ef4c65b7SEd Tanous logEntryID); 153184afc48bSJason M. Bills logEntryJson["Name"] = "System Event Log Entry"; 153284afc48bSJason M. Bills logEntryJson["Id"] = logEntryID; 153384afc48bSJason M. Bills logEntryJson["Message"] = std::move(msg); 153484afc48bSJason M. Bills logEntryJson["MessageId"] = std::move(messageID); 153584afc48bSJason M. Bills logEntryJson["MessageArgs"] = messageArgs; 153684afc48bSJason M. Bills logEntryJson["EntryType"] = "Event"; 153784afc48bSJason M. Bills logEntryJson["Severity"] = message->messageSeverity; 153884afc48bSJason M. Bills logEntryJson["Created"] = std::move(timestamp); 1539ac992cdeSJason M. Bills return LogParseError::success; 1540c4bf6374SJason M. Bills } 1541c4bf6374SJason M. Bills 15427e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntryCollection(App& app) 1543c4bf6374SJason M. Bills { 154422d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/") 15458b6a35f0SGunnar Mills .privileges(redfish::privileges::getLogEntryCollection) 1546002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1547002d39b4SEd Tanous [&app](const crow::Request& req, 154822d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 154922d268cbSEd Tanous const std::string& systemName) { 1550c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 1551c937d2bfSEd Tanous .canDelegateTop = true, 1552c937d2bfSEd Tanous .canDelegateSkip = true, 1553c937d2bfSEd Tanous }; 1554c937d2bfSEd Tanous query_param::Query delegatedQuery; 1555c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 15563ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 1557c4bf6374SJason M. Bills { 1558c4bf6374SJason M. Bills return; 1559c4bf6374SJason M. Bills } 15607f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 15617f3e84a1SEd Tanous { 15627f3e84a1SEd Tanous // Option currently returns no systems. TBD 15637f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 15647f3e84a1SEd Tanous systemName); 15657f3e84a1SEd Tanous return; 15667f3e84a1SEd Tanous } 156722d268cbSEd Tanous if (systemName != "system") 156822d268cbSEd Tanous { 156922d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 157022d268cbSEd Tanous systemName); 157122d268cbSEd Tanous return; 157222d268cbSEd Tanous } 157322d268cbSEd Tanous 15745143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 15753648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 15763648c8beSEd Tanous 15777e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 15787e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1579c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1580c4bf6374SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 1581c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1582029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1583c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 1584c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 1585c4bf6374SJason M. Bills "Collection of System Event Log Entries"; 1586cb92c03bSAndrew Geissler 15874978b63fSJason M. Bills nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1588c4bf6374SJason M. Bills logEntryArray = nlohmann::json::array(); 15897e860f15SJohn Edward Broadbent // Go through the log files and create a unique ID for each 15907e860f15SJohn Edward Broadbent // entry 159195820184SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 159295820184SJason M. Bills getRedfishLogFiles(redfishLogFiles); 1593b01bf299SEd Tanous uint64_t entryCount = 0; 1594cd225da8SJason M. Bills std::string logEntry; 159595820184SJason M. Bills 15967e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 15977e860f15SJohn Edward Broadbent // backwards 1598002d39b4SEd Tanous for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1599002d39b4SEd Tanous it++) 1600c4bf6374SJason M. Bills { 1601cd225da8SJason M. Bills std::ifstream logStream(*it); 160295820184SJason M. Bills if (!logStream.is_open()) 1603c4bf6374SJason M. Bills { 1604c4bf6374SJason M. Bills continue; 1605c4bf6374SJason M. Bills } 1606c4bf6374SJason M. Bills 1607e85d6b16SJason M. Bills // Reset the unique ID on the first entry 1608e85d6b16SJason M. Bills bool firstEntry = true; 160995820184SJason M. Bills while (std::getline(logStream, logEntry)) 161095820184SJason M. Bills { 1611c4bf6374SJason M. Bills std::string idStr; 1612e85d6b16SJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1613c4bf6374SJason M. Bills { 1614c4bf6374SJason M. Bills continue; 1615c4bf6374SJason M. Bills } 1616e85d6b16SJason M. Bills firstEntry = false; 1617e85d6b16SJason M. Bills 1618de703c5dSJason M. Bills nlohmann::json::object_t bmcLogEntry; 161989492a15SPatrick Williams LogParseError status = fillEventLogEntryJson(idStr, logEntry, 162089492a15SPatrick Williams bmcLogEntry); 1621ac992cdeSJason M. Bills if (status == LogParseError::messageIdNotInRegistry) 1622ac992cdeSJason M. Bills { 1623ac992cdeSJason M. Bills continue; 1624ac992cdeSJason M. Bills } 1625ac992cdeSJason M. Bills if (status != LogParseError::success) 1626c4bf6374SJason M. Bills { 1627c4bf6374SJason M. Bills messages::internalError(asyncResp->res); 1628c4bf6374SJason M. Bills return; 1629c4bf6374SJason M. Bills } 1630de703c5dSJason M. Bills 1631de703c5dSJason M. Bills entryCount++; 1632de703c5dSJason M. Bills // Handle paging using skip (number of entries to skip from the 1633de703c5dSJason M. Bills // start) and top (number of entries to display) 16343648c8beSEd Tanous if (entryCount <= skip || entryCount > skip + top) 1635de703c5dSJason M. Bills { 1636de703c5dSJason M. Bills continue; 1637de703c5dSJason M. Bills } 1638de703c5dSJason M. Bills 1639b2ba3072SPatrick Williams logEntryArray.emplace_back(std::move(bmcLogEntry)); 1640c4bf6374SJason M. Bills } 164195820184SJason M. Bills } 1642c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 16433648c8beSEd Tanous if (skip + top < entryCount) 1644c4bf6374SJason M. Bills { 1645c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 16464978b63fSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries?$skip=" + 16473648c8beSEd Tanous std::to_string(skip + top); 1648c4bf6374SJason M. Bills } 16497e860f15SJohn Edward Broadbent }); 1650897967deSJason M. Bills } 1651897967deSJason M. Bills 16527e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntry(App& app) 1653897967deSJason M. Bills { 16547e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 165522d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 1656ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 16577e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 165845ca1b86SEd Tanous [&app](const crow::Request& req, 16597e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 166022d268cbSEd Tanous const std::string& systemName, const std::string& param) { 16613ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 166245ca1b86SEd Tanous { 166345ca1b86SEd Tanous return; 166445ca1b86SEd Tanous } 16657f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 16667f3e84a1SEd Tanous { 16677f3e84a1SEd Tanous // Option currently returns no systems. TBD 16687f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 16697f3e84a1SEd Tanous systemName); 16707f3e84a1SEd Tanous return; 16717f3e84a1SEd Tanous } 167222d268cbSEd Tanous 167322d268cbSEd Tanous if (systemName != "system") 167422d268cbSEd Tanous { 167522d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 167622d268cbSEd Tanous systemName); 167722d268cbSEd Tanous return; 167822d268cbSEd Tanous } 167922d268cbSEd Tanous 16807e860f15SJohn Edward Broadbent const std::string& targetID = param; 16818d1b46d7Szhanghch05 16827e860f15SJohn Edward Broadbent // Go through the log files and check the unique ID for each 16837e860f15SJohn Edward Broadbent // entry to find the target entry 1684897967deSJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1685897967deSJason M. Bills getRedfishLogFiles(redfishLogFiles); 1686897967deSJason M. Bills std::string logEntry; 1687897967deSJason M. Bills 16887e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 16897e860f15SJohn Edward Broadbent // backwards 1690002d39b4SEd Tanous for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1691002d39b4SEd Tanous it++) 1692897967deSJason M. Bills { 1693897967deSJason M. Bills std::ifstream logStream(*it); 1694897967deSJason M. Bills if (!logStream.is_open()) 1695897967deSJason M. Bills { 1696897967deSJason M. Bills continue; 1697897967deSJason M. Bills } 1698897967deSJason M. Bills 1699897967deSJason M. Bills // Reset the unique ID on the first entry 1700897967deSJason M. Bills bool firstEntry = true; 1701897967deSJason M. Bills while (std::getline(logStream, logEntry)) 1702897967deSJason M. Bills { 1703897967deSJason M. Bills std::string idStr; 1704897967deSJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1705897967deSJason M. Bills { 1706897967deSJason M. Bills continue; 1707897967deSJason M. Bills } 1708897967deSJason M. Bills firstEntry = false; 1709897967deSJason M. Bills 1710897967deSJason M. Bills if (idStr == targetID) 1711897967deSJason M. Bills { 1712de703c5dSJason M. Bills nlohmann::json::object_t bmcLogEntry; 1713ac992cdeSJason M. Bills LogParseError status = 1714ac992cdeSJason M. Bills fillEventLogEntryJson(idStr, logEntry, bmcLogEntry); 1715ac992cdeSJason M. Bills if (status != LogParseError::success) 1716897967deSJason M. Bills { 1717897967deSJason M. Bills messages::internalError(asyncResp->res); 1718897967deSJason M. Bills return; 1719897967deSJason M. Bills } 1720d405bb51SJason M. Bills asyncResp->res.jsonValue.update(bmcLogEntry); 1721897967deSJason M. Bills return; 1722897967deSJason M. Bills } 1723897967deSJason M. Bills } 1724897967deSJason M. Bills } 1725897967deSJason M. Bills // Requested ID was not found 17269db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", targetID); 17277e860f15SJohn Edward Broadbent }); 172808a4e4b5SAnthony Wilson } 172908a4e4b5SAnthony Wilson 17307e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryCollection(App& app) 173108a4e4b5SAnthony Wilson { 173222d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/") 1733ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 1734002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1735002d39b4SEd Tanous [&app](const crow::Request& req, 173622d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 173722d268cbSEd Tanous const std::string& systemName) { 17383ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 173945ca1b86SEd Tanous { 174045ca1b86SEd Tanous return; 174145ca1b86SEd Tanous } 17427f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 17437f3e84a1SEd Tanous { 17447f3e84a1SEd Tanous // Option currently returns no systems. TBD 17457f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 17467f3e84a1SEd Tanous systemName); 17477f3e84a1SEd Tanous return; 17487f3e84a1SEd Tanous } 174922d268cbSEd Tanous if (systemName != "system") 175022d268cbSEd Tanous { 175122d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 175222d268cbSEd Tanous systemName); 175322d268cbSEd Tanous return; 175422d268cbSEd Tanous } 175522d268cbSEd Tanous 17567e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 17577e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 175808a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.type"] = 175908a4e4b5SAnthony Wilson "#LogEntryCollection.LogEntryCollection"; 176008a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.id"] = 176108a4e4b5SAnthony Wilson "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 176208a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 176308a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Description"] = 176408a4e4b5SAnthony Wilson "Collection of System Event Log Entries"; 176508a4e4b5SAnthony Wilson 1766cb92c03bSAndrew Geissler // DBus implementation of EventLog/Entries 1767cb92c03bSAndrew Geissler // Make call to Logging Service to find all log entry objects 17685eb468daSGeorge Liu sdbusplus::message::object_path path("/xyz/openbmc_project/logging"); 17695eb468daSGeorge Liu dbus::utility::getManagedObjects( 17705eb468daSGeorge Liu "xyz.openbmc_project.Logging", path, 17715e7e2dc5SEd Tanous [asyncResp](const boost::system::error_code& ec, 1772914e2d5dSEd Tanous const dbus::utility::ManagedObjectType& resp) { 1773cb92c03bSAndrew Geissler if (ec) 1774cb92c03bSAndrew Geissler { 1775cb92c03bSAndrew Geissler // TODO Handle for specific error code 177662598e31SEd Tanous BMCWEB_LOG_ERROR( 177762598e31SEd Tanous "getLogEntriesIfaceData resp_handler got error {}", ec); 1778cb92c03bSAndrew Geissler messages::internalError(asyncResp->res); 1779cb92c03bSAndrew Geissler return; 1780cb92c03bSAndrew Geissler } 17813544d2a7SEd Tanous nlohmann::json::array_t entriesArray; 17829eb808c1SEd Tanous for (const auto& objectPath : resp) 1783cb92c03bSAndrew Geissler { 1784914e2d5dSEd Tanous const uint32_t* id = nullptr; 1785c419c759SEd Tanous const uint64_t* timestamp = nullptr; 1786c419c759SEd Tanous const uint64_t* updateTimestamp = nullptr; 1787914e2d5dSEd Tanous const std::string* severity = nullptr; 1788914e2d5dSEd Tanous const std::string* message = nullptr; 1789914e2d5dSEd Tanous const std::string* filePath = nullptr; 17909c11a172SVijay Lobo const std::string* resolution = nullptr; 179175710de2SXiaochao Ma bool resolved = false; 17929017faf2SAbhishek Patel const std::string* notify = nullptr; 17939017faf2SAbhishek Patel 17949eb808c1SEd Tanous for (const auto& interfaceMap : objectPath.second) 1795f86bb901SAdriana Kobylak { 1796f86bb901SAdriana Kobylak if (interfaceMap.first == 1797f86bb901SAdriana Kobylak "xyz.openbmc_project.Logging.Entry") 1798f86bb901SAdriana Kobylak { 1799002d39b4SEd Tanous for (const auto& propertyMap : interfaceMap.second) 1800cb92c03bSAndrew Geissler { 1801cb92c03bSAndrew Geissler if (propertyMap.first == "Id") 1802cb92c03bSAndrew Geissler { 1803002d39b4SEd Tanous id = std::get_if<uint32_t>(&propertyMap.second); 1804cb92c03bSAndrew Geissler } 1805cb92c03bSAndrew Geissler else if (propertyMap.first == "Timestamp") 1806cb92c03bSAndrew Geissler { 1807002d39b4SEd Tanous timestamp = 1808002d39b4SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 18097e860f15SJohn Edward Broadbent } 1810002d39b4SEd Tanous else if (propertyMap.first == "UpdateTimestamp") 18117e860f15SJohn Edward Broadbent { 1812002d39b4SEd Tanous updateTimestamp = 1813002d39b4SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 18147e860f15SJohn Edward Broadbent } 18157e860f15SJohn Edward Broadbent else if (propertyMap.first == "Severity") 18167e860f15SJohn Edward Broadbent { 18177e860f15SJohn Edward Broadbent severity = std::get_if<std::string>( 18187e860f15SJohn Edward Broadbent &propertyMap.second); 18197e860f15SJohn Edward Broadbent } 18209c11a172SVijay Lobo else if (propertyMap.first == "Resolution") 18219c11a172SVijay Lobo { 18229c11a172SVijay Lobo resolution = std::get_if<std::string>( 18239c11a172SVijay Lobo &propertyMap.second); 18249c11a172SVijay Lobo } 18257e860f15SJohn Edward Broadbent else if (propertyMap.first == "Message") 18267e860f15SJohn Edward Broadbent { 18277e860f15SJohn Edward Broadbent message = std::get_if<std::string>( 18287e860f15SJohn Edward Broadbent &propertyMap.second); 18297e860f15SJohn Edward Broadbent } 18307e860f15SJohn Edward Broadbent else if (propertyMap.first == "Resolved") 18317e860f15SJohn Edward Broadbent { 1832914e2d5dSEd Tanous const bool* resolveptr = 1833002d39b4SEd Tanous std::get_if<bool>(&propertyMap.second); 18347e860f15SJohn Edward Broadbent if (resolveptr == nullptr) 18357e860f15SJohn Edward Broadbent { 1836002d39b4SEd Tanous messages::internalError(asyncResp->res); 18377e860f15SJohn Edward Broadbent return; 18387e860f15SJohn Edward Broadbent } 18397e860f15SJohn Edward Broadbent resolved = *resolveptr; 18407e860f15SJohn Edward Broadbent } 18419017faf2SAbhishek Patel else if (propertyMap.first == 18429017faf2SAbhishek Patel "ServiceProviderNotify") 18439017faf2SAbhishek Patel { 18449017faf2SAbhishek Patel notify = std::get_if<std::string>( 18459017faf2SAbhishek Patel &propertyMap.second); 18469017faf2SAbhishek Patel if (notify == nullptr) 18479017faf2SAbhishek Patel { 18489017faf2SAbhishek Patel messages::internalError(asyncResp->res); 18499017faf2SAbhishek Patel return; 18509017faf2SAbhishek Patel } 18519017faf2SAbhishek Patel } 18527e860f15SJohn Edward Broadbent } 18537e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 18547e860f15SJohn Edward Broadbent severity == nullptr) 18557e860f15SJohn Edward Broadbent { 18567e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 18577e860f15SJohn Edward Broadbent return; 18587e860f15SJohn Edward Broadbent } 18597e860f15SJohn Edward Broadbent } 18607e860f15SJohn Edward Broadbent else if (interfaceMap.first == 18617e860f15SJohn Edward Broadbent "xyz.openbmc_project.Common.FilePath") 18627e860f15SJohn Edward Broadbent { 1863002d39b4SEd Tanous for (const auto& propertyMap : interfaceMap.second) 18647e860f15SJohn Edward Broadbent { 18657e860f15SJohn Edward Broadbent if (propertyMap.first == "Path") 18667e860f15SJohn Edward Broadbent { 18677e860f15SJohn Edward Broadbent filePath = std::get_if<std::string>( 18687e860f15SJohn Edward Broadbent &propertyMap.second); 18697e860f15SJohn Edward Broadbent } 18707e860f15SJohn Edward Broadbent } 18717e860f15SJohn Edward Broadbent } 18727e860f15SJohn Edward Broadbent } 18737e860f15SJohn Edward Broadbent // Object path without the 18747e860f15SJohn Edward Broadbent // xyz.openbmc_project.Logging.Entry interface, ignore 18757e860f15SJohn Edward Broadbent // and continue. 18767e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 1877c419c759SEd Tanous severity == nullptr || timestamp == nullptr || 1878c419c759SEd Tanous updateTimestamp == nullptr) 18797e860f15SJohn Edward Broadbent { 18807e860f15SJohn Edward Broadbent continue; 18817e860f15SJohn Edward Broadbent } 18823544d2a7SEd Tanous nlohmann::json& thisEntry = entriesArray.emplace_back(); 18839c11a172SVijay Lobo thisEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 1884ef4c65b7SEd Tanous thisEntry["@odata.id"] = boost::urls::format( 1885ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}", 1886ef4c65b7SEd Tanous std::to_string(*id)); 18877e860f15SJohn Edward Broadbent thisEntry["Name"] = "System Event Log Entry"; 18887e860f15SJohn Edward Broadbent thisEntry["Id"] = std::to_string(*id); 18897e860f15SJohn Edward Broadbent thisEntry["Message"] = *message; 18907e860f15SJohn Edward Broadbent thisEntry["Resolved"] = resolved; 18919c11a172SVijay Lobo if ((resolution != nullptr) && (!(*resolution).empty())) 18929c11a172SVijay Lobo { 18939c11a172SVijay Lobo thisEntry["Resolution"] = *resolution; 18949c11a172SVijay Lobo } 18959017faf2SAbhishek Patel std::optional<bool> notifyAction = 18969017faf2SAbhishek Patel getProviderNotifyAction(*notify); 18979017faf2SAbhishek Patel if (notifyAction) 18989017faf2SAbhishek Patel { 18999017faf2SAbhishek Patel thisEntry["ServiceProviderNotified"] = *notifyAction; 19009017faf2SAbhishek Patel } 19017e860f15SJohn Edward Broadbent thisEntry["EntryType"] = "Event"; 19027e860f15SJohn Edward Broadbent thisEntry["Severity"] = 19037e860f15SJohn Edward Broadbent translateSeverityDbusToRedfish(*severity); 19047e860f15SJohn Edward Broadbent thisEntry["Created"] = 19052b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*timestamp); 19067e860f15SJohn Edward Broadbent thisEntry["Modified"] = 19072b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 19087e860f15SJohn Edward Broadbent if (filePath != nullptr) 19097e860f15SJohn Edward Broadbent { 19107e860f15SJohn Edward Broadbent thisEntry["AdditionalDataURI"] = 19110fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 19127e860f15SJohn Edward Broadbent std::to_string(*id) + "/attachment"; 19137e860f15SJohn Edward Broadbent } 19147e860f15SJohn Edward Broadbent } 19153544d2a7SEd Tanous std::ranges::sort(entriesArray, [](const nlohmann::json& left, 19163544d2a7SEd Tanous const nlohmann::json& right) { 19177e860f15SJohn Edward Broadbent return (left["Id"] <= right["Id"]); 19187e860f15SJohn Edward Broadbent }); 19197e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members@odata.count"] = 19207e860f15SJohn Edward Broadbent entriesArray.size(); 19213544d2a7SEd Tanous asyncResp->res.jsonValue["Members"] = std::move(entriesArray); 19225eb468daSGeorge Liu }); 19237e860f15SJohn Edward Broadbent }); 19247e860f15SJohn Edward Broadbent } 19257e860f15SJohn Edward Broadbent 19267e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app) 19277e860f15SJohn Edward Broadbent { 19287e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 192922d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 1930ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 1931002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1932002d39b4SEd Tanous [&app](const crow::Request& req, 19337e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 193422d268cbSEd Tanous const std::string& systemName, const std::string& param) { 19353ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 19367e860f15SJohn Edward Broadbent { 193745ca1b86SEd Tanous return; 193845ca1b86SEd Tanous } 19397f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 19407f3e84a1SEd Tanous { 19417f3e84a1SEd Tanous // Option currently returns no systems. TBD 19427f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 19437f3e84a1SEd Tanous systemName); 19447f3e84a1SEd Tanous return; 19457f3e84a1SEd Tanous } 194622d268cbSEd Tanous if (systemName != "system") 194722d268cbSEd Tanous { 194822d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 194922d268cbSEd Tanous systemName); 195022d268cbSEd Tanous return; 195122d268cbSEd Tanous } 195222d268cbSEd Tanous 19537e860f15SJohn Edward Broadbent std::string entryID = param; 19547e860f15SJohn Edward Broadbent dbus::utility::escapePathForDbus(entryID); 19557e860f15SJohn Edward Broadbent 19567e860f15SJohn Edward Broadbent // DBus implementation of EventLog/Entries 19577e860f15SJohn Edward Broadbent // Make call to Logging Service to find all log entry objects 1958d1bde9e5SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 1959d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, "xyz.openbmc_project.Logging", 1960d1bde9e5SKrzysztof Grobelny "/xyz/openbmc_project/logging/entry/" + entryID, "", 19615e7e2dc5SEd Tanous [asyncResp, entryID](const boost::system::error_code& ec, 1962b9d36b47SEd Tanous const dbus::utility::DBusPropertiesMap& resp) { 19637e860f15SJohn Edward Broadbent if (ec.value() == EBADR) 19647e860f15SJohn Edward Broadbent { 1965d1bde9e5SKrzysztof Grobelny messages::resourceNotFound(asyncResp->res, "EventLogEntry", 1966d1bde9e5SKrzysztof Grobelny entryID); 19677e860f15SJohn Edward Broadbent return; 19687e860f15SJohn Edward Broadbent } 19697e860f15SJohn Edward Broadbent if (ec) 19707e860f15SJohn Edward Broadbent { 197162598e31SEd Tanous BMCWEB_LOG_ERROR( 197262598e31SEd Tanous "EventLogEntry (DBus) resp_handler got error {}", ec); 19737e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 19747e860f15SJohn Edward Broadbent return; 19757e860f15SJohn Edward Broadbent } 1976914e2d5dSEd Tanous const uint32_t* id = nullptr; 1977c419c759SEd Tanous const uint64_t* timestamp = nullptr; 1978c419c759SEd Tanous const uint64_t* updateTimestamp = nullptr; 1979914e2d5dSEd Tanous const std::string* severity = nullptr; 1980914e2d5dSEd Tanous const std::string* message = nullptr; 1981914e2d5dSEd Tanous const std::string* filePath = nullptr; 19829c11a172SVijay Lobo const std::string* resolution = nullptr; 19837e860f15SJohn Edward Broadbent bool resolved = false; 19849017faf2SAbhishek Patel const std::string* notify = nullptr; 19857e860f15SJohn Edward Broadbent 1986d1bde9e5SKrzysztof Grobelny const bool success = sdbusplus::unpackPropertiesNoThrow( 1987d1bde9e5SKrzysztof Grobelny dbus_utils::UnpackErrorPrinter(), resp, "Id", id, "Timestamp", 1988d1bde9e5SKrzysztof Grobelny timestamp, "UpdateTimestamp", updateTimestamp, "Severity", 19899c11a172SVijay Lobo severity, "Message", message, "Resolved", resolved, 19909017faf2SAbhishek Patel "Resolution", resolution, "Path", filePath, 19919017faf2SAbhishek Patel "ServiceProviderNotify", notify); 1992d1bde9e5SKrzysztof Grobelny 1993d1bde9e5SKrzysztof Grobelny if (!success) 199475710de2SXiaochao Ma { 199575710de2SXiaochao Ma messages::internalError(asyncResp->res); 199675710de2SXiaochao Ma return; 199775710de2SXiaochao Ma } 1998d1bde9e5SKrzysztof Grobelny 1999002d39b4SEd Tanous if (id == nullptr || message == nullptr || severity == nullptr || 20009017faf2SAbhishek Patel timestamp == nullptr || updateTimestamp == nullptr || 20019017faf2SAbhishek Patel notify == nullptr) 2002f86bb901SAdriana Kobylak { 2003ae34c8e8SAdriana Kobylak messages::internalError(asyncResp->res); 2004271584abSEd Tanous return; 2005271584abSEd Tanous } 20069017faf2SAbhishek Patel 2007f86bb901SAdriana Kobylak asyncResp->res.jsonValue["@odata.type"] = 20089c11a172SVijay Lobo "#LogEntry.v1_9_0.LogEntry"; 2009ef4c65b7SEd Tanous asyncResp->res.jsonValue["@odata.id"] = boost::urls::format( 2010ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}", 2011ef4c65b7SEd Tanous std::to_string(*id)); 201245ca1b86SEd Tanous asyncResp->res.jsonValue["Name"] = "System Event Log Entry"; 2013f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Id"] = std::to_string(*id); 2014f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Message"] = *message; 2015f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Resolved"] = resolved; 20169017faf2SAbhishek Patel std::optional<bool> notifyAction = getProviderNotifyAction(*notify); 20179017faf2SAbhishek Patel if (notifyAction) 20189017faf2SAbhishek Patel { 20199017faf2SAbhishek Patel asyncResp->res.jsonValue["ServiceProviderNotified"] = 20209017faf2SAbhishek Patel *notifyAction; 20219017faf2SAbhishek Patel } 20229c11a172SVijay Lobo if ((resolution != nullptr) && (!(*resolution).empty())) 20239c11a172SVijay Lobo { 20249c11a172SVijay Lobo asyncResp->res.jsonValue["Resolution"] = *resolution; 20259c11a172SVijay Lobo } 2026f86bb901SAdriana Kobylak asyncResp->res.jsonValue["EntryType"] = "Event"; 2027f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Severity"] = 2028f86bb901SAdriana Kobylak translateSeverityDbusToRedfish(*severity); 2029f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Created"] = 20302b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*timestamp); 2031f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Modified"] = 20322b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 2033f86bb901SAdriana Kobylak if (filePath != nullptr) 2034f86bb901SAdriana Kobylak { 2035f86bb901SAdriana Kobylak asyncResp->res.jsonValue["AdditionalDataURI"] = 2036e7dbd530SPotin Lai "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 2037e7dbd530SPotin Lai std::to_string(*id) + "/attachment"; 2038f86bb901SAdriana Kobylak } 2039d1bde9e5SKrzysztof Grobelny }); 20407e860f15SJohn Edward Broadbent }); 2041336e96c6SChicago Duan 20427e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 204322d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 2044ed398213SEd Tanous .privileges(redfish::privileges::patchLogEntry) 20457e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::patch)( 204645ca1b86SEd Tanous [&app](const crow::Request& req, 20477e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 204822d268cbSEd Tanous const std::string& systemName, const std::string& entryId) { 20493ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 205045ca1b86SEd Tanous { 205145ca1b86SEd Tanous return; 205245ca1b86SEd Tanous } 20537f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 20547f3e84a1SEd Tanous { 20557f3e84a1SEd Tanous // Option currently returns no systems. TBD 20567f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 20577f3e84a1SEd Tanous systemName); 20587f3e84a1SEd Tanous return; 20597f3e84a1SEd Tanous } 206022d268cbSEd Tanous if (systemName != "system") 206122d268cbSEd Tanous { 206222d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 206322d268cbSEd Tanous systemName); 206422d268cbSEd Tanous return; 206522d268cbSEd Tanous } 206675710de2SXiaochao Ma std::optional<bool> resolved; 206775710de2SXiaochao Ma 206815ed6780SWilly Tu if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved", 20697e860f15SJohn Edward Broadbent resolved)) 207075710de2SXiaochao Ma { 207175710de2SXiaochao Ma return; 207275710de2SXiaochao Ma } 207362598e31SEd Tanous BMCWEB_LOG_DEBUG("Set Resolved"); 207475710de2SXiaochao Ma 20753eb66652SAsmitha Karunanithi setDbusProperty(asyncResp, "xyz.openbmc_project.Logging", 20769ae226faSGeorge Liu "/xyz/openbmc_project/logging/entry/" + entryId, 20773eb66652SAsmitha Karunanithi "xyz.openbmc_project.Logging.Entry", "Resolved", 20783eb66652SAsmitha Karunanithi "Resolved", *resolved); 20797e860f15SJohn Edward Broadbent }); 208075710de2SXiaochao Ma 20817e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 208222d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 2083ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 2084ed398213SEd Tanous 2085002d39b4SEd Tanous .methods(boost::beast::http::verb::delete_)( 2086002d39b4SEd Tanous [&app](const crow::Request& req, 2087002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 208822d268cbSEd Tanous const std::string& systemName, const std::string& param) { 20893ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2090336e96c6SChicago Duan { 209145ca1b86SEd Tanous return; 209245ca1b86SEd Tanous } 20937f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 20947f3e84a1SEd Tanous { 20957f3e84a1SEd Tanous // Option currently returns no systems. TBD 20967f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 20977f3e84a1SEd Tanous systemName); 20987f3e84a1SEd Tanous return; 20997f3e84a1SEd Tanous } 210022d268cbSEd Tanous if (systemName != "system") 210122d268cbSEd Tanous { 210222d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 210322d268cbSEd Tanous systemName); 210422d268cbSEd Tanous return; 210522d268cbSEd Tanous } 210662598e31SEd Tanous BMCWEB_LOG_DEBUG("Do delete single event entries."); 2107336e96c6SChicago Duan 21087e860f15SJohn Edward Broadbent std::string entryID = param; 2109336e96c6SChicago Duan 2110336e96c6SChicago Duan dbus::utility::escapePathForDbus(entryID); 2111336e96c6SChicago Duan 2112336e96c6SChicago Duan // Process response from Logging service. 21135a39f77aSPatrick Williams auto respHandler = [asyncResp, 21145a39f77aSPatrick Williams entryID](const boost::system::error_code& ec) { 211562598e31SEd Tanous BMCWEB_LOG_DEBUG("EventLogEntry (DBus) doDelete callback: Done"); 2116336e96c6SChicago Duan if (ec) 2117336e96c6SChicago Duan { 21183de8d8baSGeorge Liu if (ec.value() == EBADR) 21193de8d8baSGeorge Liu { 212045ca1b86SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 212145ca1b86SEd Tanous entryID); 21223de8d8baSGeorge Liu return; 21233de8d8baSGeorge Liu } 2124336e96c6SChicago Duan // TODO Handle for specific error code 212562598e31SEd Tanous BMCWEB_LOG_ERROR( 212662598e31SEd Tanous "EventLogEntry (DBus) doDelete respHandler got error {}", 212762598e31SEd Tanous ec); 2128336e96c6SChicago Duan asyncResp->res.result( 2129336e96c6SChicago Duan boost::beast::http::status::internal_server_error); 2130336e96c6SChicago Duan return; 2131336e96c6SChicago Duan } 2132336e96c6SChicago Duan 2133336e96c6SChicago Duan asyncResp->res.result(boost::beast::http::status::ok); 2134336e96c6SChicago Duan }; 2135336e96c6SChicago Duan 2136336e96c6SChicago Duan // Make call to Logging service to request Delete Log 2137336e96c6SChicago Duan crow::connections::systemBus->async_method_call( 2138336e96c6SChicago Duan respHandler, "xyz.openbmc_project.Logging", 2139336e96c6SChicago Duan "/xyz/openbmc_project/logging/entry/" + entryID, 2140336e96c6SChicago Duan "xyz.openbmc_project.Object.Delete", "Delete"); 21417e860f15SJohn Edward Broadbent }); 2142400fd1fbSAdriana Kobylak } 2143400fd1fbSAdriana Kobylak 2144b7028ebfSSpencer Ku constexpr const char* hostLoggerFolderPath = "/var/log/console"; 2145b7028ebfSSpencer Ku 2146b7028ebfSSpencer Ku inline bool 2147b7028ebfSSpencer Ku getHostLoggerFiles(const std::string& hostLoggerFilePath, 2148b7028ebfSSpencer Ku std::vector<std::filesystem::path>& hostLoggerFiles) 2149b7028ebfSSpencer Ku { 2150b7028ebfSSpencer Ku std::error_code ec; 2151b7028ebfSSpencer Ku std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec); 2152b7028ebfSSpencer Ku if (ec) 2153b7028ebfSSpencer Ku { 2154bf2ddedeSCarson Labrado BMCWEB_LOG_WARNING("{}", ec.message()); 2155b7028ebfSSpencer Ku return false; 2156b7028ebfSSpencer Ku } 2157b7028ebfSSpencer Ku for (const std::filesystem::directory_entry& it : logPath) 2158b7028ebfSSpencer Ku { 2159b7028ebfSSpencer Ku std::string filename = it.path().filename(); 2160b7028ebfSSpencer Ku // Prefix of each log files is "log". Find the file and save the 2161b7028ebfSSpencer Ku // path 216211ba3979SEd Tanous if (filename.starts_with("log")) 2163b7028ebfSSpencer Ku { 2164b7028ebfSSpencer Ku hostLoggerFiles.emplace_back(it.path()); 2165b7028ebfSSpencer Ku } 2166b7028ebfSSpencer Ku } 2167b7028ebfSSpencer Ku // As the log files rotate, they are appended with a ".#" that is higher for 2168b7028ebfSSpencer Ku // the older logs. Since we start from oldest logs, sort the name in 2169b7028ebfSSpencer Ku // descending order. 2170b7028ebfSSpencer Ku std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(), 2171b7028ebfSSpencer Ku AlphanumLess<std::string>()); 2172b7028ebfSSpencer Ku 2173b7028ebfSSpencer Ku return true; 2174b7028ebfSSpencer Ku } 2175b7028ebfSSpencer Ku 217602cad96eSEd Tanous inline bool getHostLoggerEntries( 217702cad96eSEd Tanous const std::vector<std::filesystem::path>& hostLoggerFiles, uint64_t skip, 217802cad96eSEd Tanous uint64_t top, std::vector<std::string>& logEntries, size_t& logCount) 2179b7028ebfSSpencer Ku { 2180b7028ebfSSpencer Ku GzFileReader logFile; 2181b7028ebfSSpencer Ku 2182b7028ebfSSpencer Ku // Go though all log files and expose host logs. 2183b7028ebfSSpencer Ku for (const std::filesystem::path& it : hostLoggerFiles) 2184b7028ebfSSpencer Ku { 2185b7028ebfSSpencer Ku if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount)) 2186b7028ebfSSpencer Ku { 218762598e31SEd Tanous BMCWEB_LOG_ERROR("fail to expose host logs"); 2188b7028ebfSSpencer Ku return false; 2189b7028ebfSSpencer Ku } 2190b7028ebfSSpencer Ku } 2191b7028ebfSSpencer Ku // Get lastMessage from constructor by getter 2192b7028ebfSSpencer Ku std::string lastMessage = logFile.getLastMessage(); 2193b7028ebfSSpencer Ku if (!lastMessage.empty()) 2194b7028ebfSSpencer Ku { 2195b7028ebfSSpencer Ku logCount++; 2196b7028ebfSSpencer Ku if (logCount > skip && logCount <= (skip + top)) 2197b7028ebfSSpencer Ku { 2198b7028ebfSSpencer Ku logEntries.push_back(lastMessage); 2199b7028ebfSSpencer Ku } 2200b7028ebfSSpencer Ku } 2201b7028ebfSSpencer Ku return true; 2202b7028ebfSSpencer Ku } 2203b7028ebfSSpencer Ku 2204b7028ebfSSpencer Ku inline void fillHostLoggerEntryJson(const std::string& logEntryID, 2205b7028ebfSSpencer Ku const std::string& msg, 22066d6574c9SJason M. Bills nlohmann::json::object_t& logEntryJson) 2207b7028ebfSSpencer Ku { 2208b7028ebfSSpencer Ku // Fill in the log entry with the gathered data. 22099c11a172SVijay Lobo logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 2210ef4c65b7SEd Tanous logEntryJson["@odata.id"] = boost::urls::format( 2211ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/{}", 2212ef4c65b7SEd Tanous logEntryID); 22136d6574c9SJason M. Bills logEntryJson["Name"] = "Host Logger Entry"; 22146d6574c9SJason M. Bills logEntryJson["Id"] = logEntryID; 22156d6574c9SJason M. Bills logEntryJson["Message"] = msg; 22166d6574c9SJason M. Bills logEntryJson["EntryType"] = "Oem"; 22176d6574c9SJason M. Bills logEntryJson["Severity"] = "OK"; 22186d6574c9SJason M. Bills logEntryJson["OemRecordFormat"] = "Host Logger Entry"; 2219b7028ebfSSpencer Ku } 2220b7028ebfSSpencer Ku 2221b7028ebfSSpencer Ku inline void requestRoutesSystemHostLogger(App& app) 2222b7028ebfSSpencer Ku { 222322d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/") 2224b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogService) 22251476687dSEd Tanous .methods(boost::beast::http::verb::get)( 22261476687dSEd Tanous [&app](const crow::Request& req, 222722d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 222822d268cbSEd Tanous const std::string& systemName) { 22293ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 223045ca1b86SEd Tanous { 223145ca1b86SEd Tanous return; 223245ca1b86SEd Tanous } 22337f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 22347f3e84a1SEd Tanous { 22357f3e84a1SEd Tanous // Option currently returns no systems. TBD 22367f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 22377f3e84a1SEd Tanous systemName); 22387f3e84a1SEd Tanous return; 22397f3e84a1SEd Tanous } 224022d268cbSEd Tanous if (systemName != "system") 224122d268cbSEd Tanous { 224222d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 224322d268cbSEd Tanous systemName); 224422d268cbSEd Tanous return; 224522d268cbSEd Tanous } 2246b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 2247b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger"; 2248b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 2249b25644a1SJanet Adkins "#LogService.v1_2_0.LogService"; 2250b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "Host Logger Service"; 2251b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = "Host Logger Service"; 2252b7028ebfSSpencer Ku asyncResp->res.jsonValue["Id"] = "HostLogger"; 22531476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 22541476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 2255b7028ebfSSpencer Ku }); 2256b7028ebfSSpencer Ku } 2257b7028ebfSSpencer Ku 2258b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerCollection(App& app) 2259b7028ebfSSpencer Ku { 2260b7028ebfSSpencer Ku BMCWEB_ROUTE(app, 226122d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/") 2262b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 2263002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2264002d39b4SEd Tanous [&app](const crow::Request& req, 226522d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 226622d268cbSEd Tanous const std::string& systemName) { 2267c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 2268c937d2bfSEd Tanous .canDelegateTop = true, 2269c937d2bfSEd Tanous .canDelegateSkip = true, 2270c937d2bfSEd Tanous }; 2271c937d2bfSEd Tanous query_param::Query delegatedQuery; 2272c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 22733ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 2274b7028ebfSSpencer Ku { 2275b7028ebfSSpencer Ku return; 2276b7028ebfSSpencer Ku } 22777f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 22787f3e84a1SEd Tanous { 22797f3e84a1SEd Tanous // Option currently returns no systems. TBD 22807f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 22817f3e84a1SEd Tanous systemName); 22827f3e84a1SEd Tanous return; 22837f3e84a1SEd Tanous } 228422d268cbSEd Tanous if (systemName != "system") 228522d268cbSEd Tanous { 228622d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 228722d268cbSEd Tanous systemName); 228822d268cbSEd Tanous return; 228922d268cbSEd Tanous } 2290b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 2291b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 2292b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 2293b7028ebfSSpencer Ku "#LogEntryCollection.LogEntryCollection"; 2294b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "HostLogger Entries"; 2295b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = 2296b7028ebfSSpencer Ku "Collection of HostLogger Entries"; 22970fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2298b7028ebfSSpencer Ku logEntryArray = nlohmann::json::array(); 2299b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = 0; 2300b7028ebfSSpencer Ku 2301b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 2302b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 2303b7028ebfSSpencer Ku { 2304bf2ddedeSCarson Labrado BMCWEB_LOG_DEBUG("Failed to get host log file path"); 2305b7028ebfSSpencer Ku return; 2306b7028ebfSSpencer Ku } 23073648c8beSEd Tanous // If we weren't provided top and skip limits, use the defaults. 23083648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 23095143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 2310b7028ebfSSpencer Ku size_t logCount = 0; 2311b7028ebfSSpencer Ku // This vector only store the entries we want to expose that 2312b7028ebfSSpencer Ku // control by skip and top. 2313b7028ebfSSpencer Ku std::vector<std::string> logEntries; 23143648c8beSEd Tanous if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries, 23153648c8beSEd Tanous logCount)) 2316b7028ebfSSpencer Ku { 2317b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 2318b7028ebfSSpencer Ku return; 2319b7028ebfSSpencer Ku } 2320b7028ebfSSpencer Ku // If vector is empty, that means skip value larger than total 2321b7028ebfSSpencer Ku // log count 232226f6976fSEd Tanous if (logEntries.empty()) 2323b7028ebfSSpencer Ku { 2324b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 2325b7028ebfSSpencer Ku return; 2326b7028ebfSSpencer Ku } 232726f6976fSEd Tanous if (!logEntries.empty()) 2328b7028ebfSSpencer Ku { 2329b7028ebfSSpencer Ku for (size_t i = 0; i < logEntries.size(); i++) 2330b7028ebfSSpencer Ku { 23316d6574c9SJason M. Bills nlohmann::json::object_t hostLogEntry; 23323648c8beSEd Tanous fillHostLoggerEntryJson(std::to_string(skip + i), logEntries[i], 23333648c8beSEd Tanous hostLogEntry); 2334b2ba3072SPatrick Williams logEntryArray.emplace_back(std::move(hostLogEntry)); 2335b7028ebfSSpencer Ku } 2336b7028ebfSSpencer Ku 2337b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 23383648c8beSEd Tanous if (skip + top < logCount) 2339b7028ebfSSpencer Ku { 2340b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.nextLink"] = 23410fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/HostLogger/Entries?$skip=" + 23423648c8beSEd Tanous std::to_string(skip + top); 2343b7028ebfSSpencer Ku } 2344b7028ebfSSpencer Ku } 2345b7028ebfSSpencer Ku }); 2346b7028ebfSSpencer Ku } 2347b7028ebfSSpencer Ku 2348b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerLogEntry(App& app) 2349b7028ebfSSpencer Ku { 2350b7028ebfSSpencer Ku BMCWEB_ROUTE( 235122d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/<str>/") 2352b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 2353b7028ebfSSpencer Ku .methods(boost::beast::http::verb::get)( 235445ca1b86SEd Tanous [&app](const crow::Request& req, 2355b7028ebfSSpencer Ku const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 235622d268cbSEd Tanous const std::string& systemName, const std::string& param) { 23573ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 235845ca1b86SEd Tanous { 235945ca1b86SEd Tanous return; 236045ca1b86SEd Tanous } 23617f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 23627f3e84a1SEd Tanous { 23637f3e84a1SEd Tanous // Option currently returns no systems. TBD 23647f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 23657f3e84a1SEd Tanous systemName); 23667f3e84a1SEd Tanous return; 23677f3e84a1SEd Tanous } 236822d268cbSEd Tanous if (systemName != "system") 236922d268cbSEd Tanous { 237022d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 237122d268cbSEd Tanous systemName); 237222d268cbSEd Tanous return; 237322d268cbSEd Tanous } 2374b7028ebfSSpencer Ku const std::string& targetID = param; 2375b7028ebfSSpencer Ku 2376b7028ebfSSpencer Ku uint64_t idInt = 0; 2377ca45aa3cSEd Tanous 237884396af9SPatrick Williams auto [ptr, ec] = std::from_chars(&*targetID.begin(), &*targetID.end(), 237984396af9SPatrick Williams idInt); 23809db4ba25SJiaqing Zhao if (ec == std::errc::invalid_argument || 23819db4ba25SJiaqing Zhao ec == std::errc::result_out_of_range) 2382b7028ebfSSpencer Ku { 23839db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", param); 2384b7028ebfSSpencer Ku return; 2385b7028ebfSSpencer Ku } 2386b7028ebfSSpencer Ku 2387b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 2388b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 2389b7028ebfSSpencer Ku { 2390bf2ddedeSCarson Labrado BMCWEB_LOG_DEBUG("Failed to get host log file path"); 2391b7028ebfSSpencer Ku return; 2392b7028ebfSSpencer Ku } 2393b7028ebfSSpencer Ku 2394b7028ebfSSpencer Ku size_t logCount = 0; 23953648c8beSEd Tanous size_t top = 1; 2396b7028ebfSSpencer Ku std::vector<std::string> logEntries; 2397b7028ebfSSpencer Ku // We can get specific entry by skip and top. For example, if we 2398b7028ebfSSpencer Ku // want to get nth entry, we can set skip = n-1 and top = 1 to 2399b7028ebfSSpencer Ku // get that entry 2400002d39b4SEd Tanous if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, logEntries, 2401002d39b4SEd Tanous logCount)) 2402b7028ebfSSpencer Ku { 2403b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 2404b7028ebfSSpencer Ku return; 2405b7028ebfSSpencer Ku } 2406b7028ebfSSpencer Ku 2407b7028ebfSSpencer Ku if (!logEntries.empty()) 2408b7028ebfSSpencer Ku { 24096d6574c9SJason M. Bills nlohmann::json::object_t hostLogEntry; 24106d6574c9SJason M. Bills fillHostLoggerEntryJson(targetID, logEntries[0], hostLogEntry); 24116d6574c9SJason M. Bills asyncResp->res.jsonValue.update(hostLogEntry); 2412b7028ebfSSpencer Ku return; 2413b7028ebfSSpencer Ku } 2414b7028ebfSSpencer Ku 2415b7028ebfSSpencer Ku // Requested ID was not found 24169db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", param); 2417b7028ebfSSpencer Ku }); 2418b7028ebfSSpencer Ku } 2419b7028ebfSSpencer Ku 2420dd72e87bSClaire Weinan inline void handleBMCLogServicesCollectionGet( 2421fdd26906SClaire Weinan crow::App& app, const crow::Request& req, 2422fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 24231da66f75SEd Tanous { 24243ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 242545ca1b86SEd Tanous { 242645ca1b86SEd Tanous return; 242745ca1b86SEd Tanous } 24287e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 24297e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2430e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 24311da66f75SEd Tanous "#LogServiceCollection.LogServiceCollection"; 2432e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 2433e1f26343SJason M. Bills "/redfish/v1/Managers/bmc/LogServices"; 2434002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection"; 2435e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 24361da66f75SEd Tanous "Collection of LogServices for this Manager"; 2437002d39b4SEd Tanous nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 2438c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 2439fdd26906SClaire Weinan 2440c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL 2441613dabeaSEd Tanous nlohmann::json::object_t journal; 2442613dabeaSEd Tanous journal["@odata.id"] = "/redfish/v1/Managers/bmc/LogServices/Journal"; 2443b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(journal)); 2444c4bf6374SJason M. Bills #endif 2445fdd26906SClaire Weinan 2446fdd26906SClaire Weinan asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size(); 2447fdd26906SClaire Weinan 2448fdd26906SClaire Weinan #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 244915912159SGeorge Liu constexpr std::array<std::string_view, 1> interfaces = { 24507a1dbc48SGeorge Liu "xyz.openbmc_project.Collection.DeleteAll"}; 24517a1dbc48SGeorge Liu dbus::utility::getSubTreePaths( 24527a1dbc48SGeorge Liu "/xyz/openbmc_project/dump", 0, interfaces, 2453fdd26906SClaire Weinan [asyncResp]( 24547a1dbc48SGeorge Liu const boost::system::error_code& ec, 2455fdd26906SClaire Weinan const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 2456fdd26906SClaire Weinan if (ec) 2457fdd26906SClaire Weinan { 245862598e31SEd Tanous BMCWEB_LOG_ERROR( 245962598e31SEd Tanous "handleBMCLogServicesCollectionGet respHandler got error {}", 246062598e31SEd Tanous ec); 2461fdd26906SClaire Weinan // Assume that getting an error simply means there are no dump 2462fdd26906SClaire Weinan // LogServices. Return without adding any error response. 2463fdd26906SClaire Weinan return; 2464fdd26906SClaire Weinan } 2465fdd26906SClaire Weinan 2466fdd26906SClaire Weinan nlohmann::json& logServiceArrayLocal = 2467fdd26906SClaire Weinan asyncResp->res.jsonValue["Members"]; 2468fdd26906SClaire Weinan 2469fdd26906SClaire Weinan for (const std::string& path : subTreePaths) 2470fdd26906SClaire Weinan { 2471fdd26906SClaire Weinan if (path == "/xyz/openbmc_project/dump/bmc") 2472fdd26906SClaire Weinan { 2473613dabeaSEd Tanous nlohmann::json::object_t member; 2474613dabeaSEd Tanous member["@odata.id"] = 2475613dabeaSEd Tanous "/redfish/v1/Managers/bmc/LogServices/Dump"; 2476b2ba3072SPatrick Williams logServiceArrayLocal.emplace_back(std::move(member)); 2477fdd26906SClaire Weinan } 2478fdd26906SClaire Weinan else if (path == "/xyz/openbmc_project/dump/faultlog") 2479fdd26906SClaire Weinan { 2480613dabeaSEd Tanous nlohmann::json::object_t member; 2481613dabeaSEd Tanous member["@odata.id"] = 2482613dabeaSEd Tanous "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2483b2ba3072SPatrick Williams logServiceArrayLocal.emplace_back(std::move(member)); 2484fdd26906SClaire Weinan } 2485fdd26906SClaire Weinan } 2486fdd26906SClaire Weinan 2487e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 2488fdd26906SClaire Weinan logServiceArrayLocal.size(); 24897a1dbc48SGeorge Liu }); 2490fdd26906SClaire Weinan #endif 2491fdd26906SClaire Weinan } 2492fdd26906SClaire Weinan 2493fdd26906SClaire Weinan inline void requestRoutesBMCLogServiceCollection(App& app) 2494fdd26906SClaire Weinan { 2495fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/") 2496fdd26906SClaire Weinan .privileges(redfish::privileges::getLogServiceCollection) 2497fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 2498dd72e87bSClaire Weinan std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app))); 2499e1f26343SJason M. Bills } 2500e1f26343SJason M. Bills 25017e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogService(App& app) 2502e1f26343SJason M. Bills { 25037e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/") 2504ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 25057e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 250645ca1b86SEd Tanous [&app](const crow::Request& req, 250745ca1b86SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 25083ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 25097e860f15SJohn Edward Broadbent { 251045ca1b86SEd Tanous return; 251145ca1b86SEd Tanous } 2512e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2513b25644a1SJanet Adkins "#LogService.v1_2_0.LogService"; 25140f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 25150f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal"; 2516002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service"; 2517002d39b4SEd Tanous asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service"; 2518ed34a4adSEd Tanous asyncResp->res.jsonValue["Id"] = "Journal"; 2519e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 25207c8c4058STejas Patil 25217c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 25222b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 2523002d39b4SEd Tanous asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 25247c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 25257c8c4058STejas Patil redfishDateTimeOffset.second; 25267c8c4058STejas Patil 25271476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 25281476687dSEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 25297e860f15SJohn Edward Broadbent }); 2530e1f26343SJason M. Bills } 2531e1f26343SJason M. Bills 25323a48b3a2SJason M. Bills static int 25333a48b3a2SJason M. Bills fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID, 2534e1f26343SJason M. Bills sd_journal* journal, 25353a48b3a2SJason M. Bills nlohmann::json::object_t& bmcJournalLogEntryJson) 2536e1f26343SJason M. Bills { 2537e1f26343SJason M. Bills // Get the Log Entry contents 2538e1f26343SJason M. Bills int ret = 0; 2539e1f26343SJason M. Bills 2540a8fe54f0SJason M. Bills std::string message; 2541a8fe54f0SJason M. Bills std::string_view syslogID; 2542a8fe54f0SJason M. Bills ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID); 2543a8fe54f0SJason M. Bills if (ret < 0) 2544a8fe54f0SJason M. Bills { 2545bf2ddedeSCarson Labrado BMCWEB_LOG_DEBUG("Failed to read SYSLOG_IDENTIFIER field: {}", 254662598e31SEd Tanous strerror(-ret)); 2547a8fe54f0SJason M. Bills } 2548a8fe54f0SJason M. Bills if (!syslogID.empty()) 2549a8fe54f0SJason M. Bills { 2550a8fe54f0SJason M. Bills message += std::string(syslogID) + ": "; 2551a8fe54f0SJason M. Bills } 2552a8fe54f0SJason M. Bills 255339e77504SEd Tanous std::string_view msg; 255416428a1aSJason M. Bills ret = getJournalMetadata(journal, "MESSAGE", msg); 2555e1f26343SJason M. Bills if (ret < 0) 2556e1f26343SJason M. Bills { 255762598e31SEd Tanous BMCWEB_LOG_ERROR("Failed to read MESSAGE field: {}", strerror(-ret)); 2558e1f26343SJason M. Bills return 1; 2559e1f26343SJason M. Bills } 2560a8fe54f0SJason M. Bills message += std::string(msg); 2561e1f26343SJason M. Bills 2562e1f26343SJason M. Bills // Get the severity from the PRIORITY field 2563271584abSEd Tanous long int severity = 8; // Default to an invalid priority 256416428a1aSJason M. Bills ret = getJournalMetadata(journal, "PRIORITY", 10, severity); 2565e1f26343SJason M. Bills if (ret < 0) 2566e1f26343SJason M. Bills { 2567bf2ddedeSCarson Labrado BMCWEB_LOG_DEBUG("Failed to read PRIORITY field: {}", strerror(-ret)); 2568e1f26343SJason M. Bills } 2569e1f26343SJason M. Bills 2570e1f26343SJason M. Bills // Get the Created time from the timestamp 257116428a1aSJason M. Bills std::string entryTimeStr; 257216428a1aSJason M. Bills if (!getEntryTimestamp(journal, entryTimeStr)) 2573e1f26343SJason M. Bills { 257416428a1aSJason M. Bills return 1; 2575e1f26343SJason M. Bills } 2576e1f26343SJason M. Bills 2577e1f26343SJason M. Bills // Fill in the log entry with the gathered data 25789c11a172SVijay Lobo bmcJournalLogEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 2579ef4c65b7SEd Tanous bmcJournalLogEntryJson["@odata.id"] = boost::urls::format( 2580ef4c65b7SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/{}", 2581eddfc437SWilly Tu bmcJournalLogEntryID); 258284afc48bSJason M. Bills bmcJournalLogEntryJson["Name"] = "BMC Journal Entry"; 258384afc48bSJason M. Bills bmcJournalLogEntryJson["Id"] = bmcJournalLogEntryID; 258484afc48bSJason M. Bills bmcJournalLogEntryJson["Message"] = std::move(message); 258584afc48bSJason M. Bills bmcJournalLogEntryJson["EntryType"] = "Oem"; 2586ddf3564eSEd Tanous log_entry::EventSeverity severityEnum = log_entry::EventSeverity::OK; 2587ddf3564eSEd Tanous if (severity <= 2) 2588ddf3564eSEd Tanous { 2589ddf3564eSEd Tanous severityEnum = log_entry::EventSeverity::Critical; 2590ddf3564eSEd Tanous } 2591ddf3564eSEd Tanous else if (severity <= 4) 2592ddf3564eSEd Tanous { 2593ddf3564eSEd Tanous severityEnum = log_entry::EventSeverity::Warning; 2594ddf3564eSEd Tanous } 2595ddf3564eSEd Tanous 2596ddf3564eSEd Tanous bmcJournalLogEntryJson["Severity"] = severityEnum; 259784afc48bSJason M. Bills bmcJournalLogEntryJson["OemRecordFormat"] = "BMC Journal Entry"; 259884afc48bSJason M. Bills bmcJournalLogEntryJson["Created"] = std::move(entryTimeStr); 2599e1f26343SJason M. Bills return 0; 2600e1f26343SJason M. Bills } 2601e1f26343SJason M. Bills 26027e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntryCollection(App& app) 2603e1f26343SJason M. Bills { 26047e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/") 2605ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 2606002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2607002d39b4SEd Tanous [&app](const crow::Request& req, 2608002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2609c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 2610c937d2bfSEd Tanous .canDelegateTop = true, 2611c937d2bfSEd Tanous .canDelegateSkip = true, 2612c937d2bfSEd Tanous }; 2613c937d2bfSEd Tanous query_param::Query delegatedQuery; 2614c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 26153ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 2616193ad2faSJason M. Bills { 2617193ad2faSJason M. Bills return; 2618193ad2faSJason M. Bills } 26193648c8beSEd Tanous 26203648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 26215143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 26223648c8beSEd Tanous 26237e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 26247e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2625e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2626e1f26343SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 26270f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 26280f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 2629e1f26343SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries"; 2630e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2631e1f26343SJason M. Bills "Collection of BMC Journal Entries"; 26320fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2633e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 2634e1f26343SJason M. Bills 26357e860f15SJohn Edward Broadbent // Go through the journal and use the timestamp to create a 26367e860f15SJohn Edward Broadbent // unique ID for each entry 2637e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2638e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2639e1f26343SJason M. Bills if (ret < 0) 2640e1f26343SJason M. Bills { 264162598e31SEd Tanous BMCWEB_LOG_ERROR("failed to open journal: {}", strerror(-ret)); 2642f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2643e1f26343SJason M. Bills return; 2644e1f26343SJason M. Bills } 26450fda0f12SGeorge Liu std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 26460fda0f12SGeorge Liu journalTmp, sd_journal_close); 2647e1f26343SJason M. Bills journalTmp = nullptr; 2648b01bf299SEd Tanous uint64_t entryCount = 0; 2649e85d6b16SJason M. Bills // Reset the unique ID on the first entry 2650e85d6b16SJason M. Bills bool firstEntry = true; 2651e1f26343SJason M. Bills SD_JOURNAL_FOREACH(journal.get()) 2652e1f26343SJason M. Bills { 2653193ad2faSJason M. Bills entryCount++; 26547e860f15SJohn Edward Broadbent // Handle paging using skip (number of entries to skip from 26557e860f15SJohn Edward Broadbent // the start) and top (number of entries to display) 26563648c8beSEd Tanous if (entryCount <= skip || entryCount > skip + top) 2657193ad2faSJason M. Bills { 2658193ad2faSJason M. Bills continue; 2659193ad2faSJason M. Bills } 2660193ad2faSJason M. Bills 266116428a1aSJason M. Bills std::string idStr; 2662e85d6b16SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2663e1f26343SJason M. Bills { 2664e1f26343SJason M. Bills continue; 2665e1f26343SJason M. Bills } 2666e85d6b16SJason M. Bills firstEntry = false; 2667e85d6b16SJason M. Bills 26683a48b3a2SJason M. Bills nlohmann::json::object_t bmcJournalLogEntry; 2669c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(idStr, journal.get(), 2670c4bf6374SJason M. Bills bmcJournalLogEntry) != 0) 2671e1f26343SJason M. Bills { 2672f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2673e1f26343SJason M. Bills return; 2674e1f26343SJason M. Bills } 2675b2ba3072SPatrick Williams logEntryArray.emplace_back(std::move(bmcJournalLogEntry)); 2676e1f26343SJason M. Bills } 2677193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 26783648c8beSEd Tanous if (skip + top < entryCount) 2679193ad2faSJason M. Bills { 2680193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 26810fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" + 26823648c8beSEd Tanous std::to_string(skip + top); 2683193ad2faSJason M. Bills } 26847e860f15SJohn Edward Broadbent }); 2685e1f26343SJason M. Bills } 2686e1f26343SJason M. Bills 26877e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntry(App& app) 2688e1f26343SJason M. Bills { 26897e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 26907e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/") 2691ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 26927e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 269345ca1b86SEd Tanous [&app](const crow::Request& req, 26947e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 26957e860f15SJohn Edward Broadbent const std::string& entryID) { 26963ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 269745ca1b86SEd Tanous { 269845ca1b86SEd Tanous return; 269945ca1b86SEd Tanous } 2700e1f26343SJason M. Bills // Convert the unique ID back to a timestamp to find the entry 270175e8e218SMyung Bae sd_id128_t bootID{}; 2702e1f26343SJason M. Bills uint64_t ts = 0; 2703271584abSEd Tanous uint64_t index = 0; 270475e8e218SMyung Bae if (!getTimestampFromID(asyncResp, entryID, bootID, ts, index)) 2705e1f26343SJason M. Bills { 270616428a1aSJason M. Bills return; 2707e1f26343SJason M. Bills } 2708e1f26343SJason M. Bills 2709e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2710e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2711e1f26343SJason M. Bills if (ret < 0) 2712e1f26343SJason M. Bills { 271362598e31SEd Tanous BMCWEB_LOG_ERROR("failed to open journal: {}", strerror(-ret)); 2714f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2715e1f26343SJason M. Bills return; 2716e1f26343SJason M. Bills } 2717002d39b4SEd Tanous std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 2718002d39b4SEd Tanous journalTmp, sd_journal_close); 2719e1f26343SJason M. Bills journalTmp = nullptr; 27207e860f15SJohn Edward Broadbent // Go to the timestamp in the log and move to the entry at the 27217e860f15SJohn Edward Broadbent // index tracking the unique ID 2722af07e3f5SJason M. Bills std::string idStr; 2723af07e3f5SJason M. Bills bool firstEntry = true; 272475e8e218SMyung Bae ret = sd_journal_seek_monotonic_usec(journal.get(), bootID, ts); 27252056b6d1SManojkiran Eda if (ret < 0) 27262056b6d1SManojkiran Eda { 272762598e31SEd Tanous BMCWEB_LOG_ERROR("failed to seek to an entry in journal{}", 272862598e31SEd Tanous strerror(-ret)); 27292056b6d1SManojkiran Eda messages::internalError(asyncResp->res); 27302056b6d1SManojkiran Eda return; 27312056b6d1SManojkiran Eda } 2732271584abSEd Tanous for (uint64_t i = 0; i <= index; i++) 2733e1f26343SJason M. Bills { 2734e1f26343SJason M. Bills sd_journal_next(journal.get()); 2735af07e3f5SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2736af07e3f5SJason M. Bills { 2737af07e3f5SJason M. Bills messages::internalError(asyncResp->res); 2738af07e3f5SJason M. Bills return; 2739af07e3f5SJason M. Bills } 2740af07e3f5SJason M. Bills firstEntry = false; 2741af07e3f5SJason M. Bills } 2742c4bf6374SJason M. Bills // Confirm that the entry ID matches what was requested 2743af07e3f5SJason M. Bills if (idStr != entryID) 2744c4bf6374SJason M. Bills { 27459db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 2746c4bf6374SJason M. Bills return; 2747c4bf6374SJason M. Bills } 2748c4bf6374SJason M. Bills 27493a48b3a2SJason M. Bills nlohmann::json::object_t bmcJournalLogEntry; 2750c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(entryID, journal.get(), 27513a48b3a2SJason M. Bills bmcJournalLogEntry) != 0) 2752e1f26343SJason M. Bills { 2753f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2754e1f26343SJason M. Bills return; 2755e1f26343SJason M. Bills } 2756d405bb51SJason M. Bills asyncResp->res.jsonValue.update(bmcJournalLogEntry); 27577e860f15SJohn Edward Broadbent }); 2758c9bb6861Sraviteja-b } 2759c9bb6861Sraviteja-b 2760fdd26906SClaire Weinan inline void 2761fdd26906SClaire Weinan getDumpServiceInfo(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2762fdd26906SClaire Weinan const std::string& dumpType) 2763c9bb6861Sraviteja-b { 2764fdd26906SClaire Weinan std::string dumpPath; 2765fdd26906SClaire Weinan std::string overWritePolicy; 2766fdd26906SClaire Weinan bool collectDiagnosticDataSupported = false; 2767fdd26906SClaire Weinan 2768fdd26906SClaire Weinan if (dumpType == "BMC") 276945ca1b86SEd Tanous { 2770fdd26906SClaire Weinan dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump"; 2771fdd26906SClaire Weinan overWritePolicy = "WrapsWhenFull"; 2772fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2773fdd26906SClaire Weinan } 2774fdd26906SClaire Weinan else if (dumpType == "FaultLog") 2775fdd26906SClaire Weinan { 2776fdd26906SClaire Weinan dumpPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2777fdd26906SClaire Weinan overWritePolicy = "Unknown"; 2778fdd26906SClaire Weinan collectDiagnosticDataSupported = false; 2779fdd26906SClaire Weinan } 2780fdd26906SClaire Weinan else if (dumpType == "System") 2781fdd26906SClaire Weinan { 2782fdd26906SClaire Weinan dumpPath = "/redfish/v1/Systems/system/LogServices/Dump"; 2783fdd26906SClaire Weinan overWritePolicy = "WrapsWhenFull"; 2784fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2785fdd26906SClaire Weinan } 2786fdd26906SClaire Weinan else 2787fdd26906SClaire Weinan { 278862598e31SEd Tanous BMCWEB_LOG_ERROR("getDumpServiceInfo() invalid dump type: {}", 278962598e31SEd Tanous dumpType); 2790fdd26906SClaire Weinan messages::internalError(asyncResp->res); 279145ca1b86SEd Tanous return; 279245ca1b86SEd Tanous } 2793fdd26906SClaire Weinan 2794fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = dumpPath; 2795fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService"; 2796c9bb6861Sraviteja-b asyncResp->res.jsonValue["Name"] = "Dump LogService"; 2797fdd26906SClaire Weinan asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService"; 2798fdd26906SClaire Weinan asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename(); 2799fdd26906SClaire Weinan asyncResp->res.jsonValue["OverWritePolicy"] = std::move(overWritePolicy); 28007c8c4058STejas Patil 28017c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 28022b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 28030fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 28047c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 28057c8c4058STejas Patil redfishDateTimeOffset.second; 28067c8c4058STejas Patil 2807fdd26906SClaire Weinan asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries"; 2808fdd26906SClaire Weinan 2809fdd26906SClaire Weinan if (collectDiagnosticDataSupported) 2810fdd26906SClaire Weinan { 2811002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 28121476687dSEd Tanous ["target"] = 2813fdd26906SClaire Weinan dumpPath + "/Actions/LogService.CollectDiagnosticData"; 2814fdd26906SClaire Weinan } 28150d946211SClaire Weinan 28160d946211SClaire Weinan constexpr std::array<std::string_view, 1> interfaces = {deleteAllInterface}; 28170d946211SClaire Weinan dbus::utility::getSubTreePaths( 28180d946211SClaire Weinan "/xyz/openbmc_project/dump", 0, interfaces, 28190d946211SClaire Weinan [asyncResp, dumpType, dumpPath]( 28200d946211SClaire Weinan const boost::system::error_code& ec, 28210d946211SClaire Weinan const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 28220d946211SClaire Weinan if (ec) 28230d946211SClaire Weinan { 282462598e31SEd Tanous BMCWEB_LOG_ERROR("getDumpServiceInfo respHandler got error {}", ec); 28250d946211SClaire Weinan // Assume that getting an error simply means there are no dump 28260d946211SClaire Weinan // LogServices. Return without adding any error response. 28270d946211SClaire Weinan return; 28280d946211SClaire Weinan } 282918f8f608SEd Tanous std::string dbusDumpPath = getDumpPath(dumpType); 28300d946211SClaire Weinan for (const std::string& path : subTreePaths) 28310d946211SClaire Weinan { 28320d946211SClaire Weinan if (path == dbusDumpPath) 28330d946211SClaire Weinan { 28340d946211SClaire Weinan asyncResp->res 28350d946211SClaire Weinan .jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 28360d946211SClaire Weinan dumpPath + "/Actions/LogService.ClearLog"; 28370d946211SClaire Weinan break; 28380d946211SClaire Weinan } 28390d946211SClaire Weinan } 28400d946211SClaire Weinan }); 2841c9bb6861Sraviteja-b } 2842c9bb6861Sraviteja-b 2843fdd26906SClaire Weinan inline void handleLogServicesDumpServiceGet( 2844fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2845fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 28467e860f15SJohn Edward Broadbent { 28473ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 284845ca1b86SEd Tanous { 284945ca1b86SEd Tanous return; 285045ca1b86SEd Tanous } 2851fdd26906SClaire Weinan getDumpServiceInfo(asyncResp, dumpType); 2852fdd26906SClaire Weinan } 2853c9bb6861Sraviteja-b 285422d268cbSEd Tanous inline void handleLogServicesDumpServiceComputerSystemGet( 285522d268cbSEd Tanous crow::App& app, const crow::Request& req, 285622d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 285722d268cbSEd Tanous const std::string& chassisId) 285822d268cbSEd Tanous { 285922d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 286022d268cbSEd Tanous { 286122d268cbSEd Tanous return; 286222d268cbSEd Tanous } 286322d268cbSEd Tanous if (chassisId != "system") 286422d268cbSEd Tanous { 286522d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 286622d268cbSEd Tanous return; 286722d268cbSEd Tanous } 286822d268cbSEd Tanous getDumpServiceInfo(asyncResp, "System"); 286922d268cbSEd Tanous } 287022d268cbSEd Tanous 2871fdd26906SClaire Weinan inline void handleLogServicesDumpEntriesCollectionGet( 2872fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2873fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2874fdd26906SClaire Weinan { 2875fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2876fdd26906SClaire Weinan { 2877fdd26906SClaire Weinan return; 2878fdd26906SClaire Weinan } 2879fdd26906SClaire Weinan getDumpEntryCollection(asyncResp, dumpType); 2880fdd26906SClaire Weinan } 2881fdd26906SClaire Weinan 288222d268cbSEd Tanous inline void handleLogServicesDumpEntriesCollectionComputerSystemGet( 288322d268cbSEd Tanous crow::App& app, const crow::Request& req, 288422d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 288522d268cbSEd Tanous const std::string& chassisId) 288622d268cbSEd Tanous { 288722d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 288822d268cbSEd Tanous { 288922d268cbSEd Tanous return; 289022d268cbSEd Tanous } 289122d268cbSEd Tanous if (chassisId != "system") 289222d268cbSEd Tanous { 289322d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 289422d268cbSEd Tanous return; 289522d268cbSEd Tanous } 289622d268cbSEd Tanous getDumpEntryCollection(asyncResp, "System"); 289722d268cbSEd Tanous } 289822d268cbSEd Tanous 2899fdd26906SClaire Weinan inline void handleLogServicesDumpEntryGet( 2900fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2901fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2902fdd26906SClaire Weinan const std::string& dumpId) 2903fdd26906SClaire Weinan { 2904fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2905fdd26906SClaire Weinan { 2906fdd26906SClaire Weinan return; 2907fdd26906SClaire Weinan } 2908fdd26906SClaire Weinan getDumpEntryById(asyncResp, dumpId, dumpType); 2909fdd26906SClaire Weinan } 2910168d1b1aSCarson Labrado 291122d268cbSEd Tanous inline void handleLogServicesDumpEntryComputerSystemGet( 291222d268cbSEd Tanous crow::App& app, const crow::Request& req, 291322d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 291422d268cbSEd Tanous const std::string& chassisId, const std::string& dumpId) 291522d268cbSEd Tanous { 291622d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 291722d268cbSEd Tanous { 291822d268cbSEd Tanous return; 291922d268cbSEd Tanous } 292022d268cbSEd Tanous if (chassisId != "system") 292122d268cbSEd Tanous { 292222d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 292322d268cbSEd Tanous return; 292422d268cbSEd Tanous } 292522d268cbSEd Tanous getDumpEntryById(asyncResp, dumpId, "System"); 292622d268cbSEd Tanous } 2927fdd26906SClaire Weinan 2928fdd26906SClaire Weinan inline void handleLogServicesDumpEntryDelete( 2929fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2930fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2931fdd26906SClaire Weinan const std::string& dumpId) 2932fdd26906SClaire Weinan { 2933fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2934fdd26906SClaire Weinan { 2935fdd26906SClaire Weinan return; 2936fdd26906SClaire Weinan } 2937fdd26906SClaire Weinan deleteDumpEntry(asyncResp, dumpId, dumpType); 2938fdd26906SClaire Weinan } 2939fdd26906SClaire Weinan 294022d268cbSEd Tanous inline void handleLogServicesDumpEntryComputerSystemDelete( 294122d268cbSEd Tanous crow::App& app, const crow::Request& req, 294222d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 294322d268cbSEd Tanous const std::string& chassisId, const std::string& dumpId) 294422d268cbSEd Tanous { 294522d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 294622d268cbSEd Tanous { 294722d268cbSEd Tanous return; 294822d268cbSEd Tanous } 294922d268cbSEd Tanous if (chassisId != "system") 295022d268cbSEd Tanous { 295122d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 295222d268cbSEd Tanous return; 295322d268cbSEd Tanous } 295422d268cbSEd Tanous deleteDumpEntry(asyncResp, dumpId, "System"); 295522d268cbSEd Tanous } 295622d268cbSEd Tanous 2957168d1b1aSCarson Labrado inline void handleLogServicesDumpEntryDownloadGet( 2958168d1b1aSCarson Labrado crow::App& app, const std::string& dumpType, const crow::Request& req, 2959168d1b1aSCarson Labrado const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2960168d1b1aSCarson Labrado const std::string& dumpId) 2961168d1b1aSCarson Labrado { 2962168d1b1aSCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2963168d1b1aSCarson Labrado { 2964168d1b1aSCarson Labrado return; 2965168d1b1aSCarson Labrado } 2966168d1b1aSCarson Labrado downloadDumpEntry(asyncResp, dumpId, dumpType); 2967168d1b1aSCarson Labrado } 2968168d1b1aSCarson Labrado 2969168d1b1aSCarson Labrado inline void handleDBusEventLogEntryDownloadGet( 2970168d1b1aSCarson Labrado crow::App& app, const std::string& dumpType, const crow::Request& req, 2971168d1b1aSCarson Labrado const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2972168d1b1aSCarson Labrado const std::string& systemName, const std::string& entryID) 2973168d1b1aSCarson Labrado { 2974168d1b1aSCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2975168d1b1aSCarson Labrado { 2976168d1b1aSCarson Labrado return; 2977168d1b1aSCarson Labrado } 2978168d1b1aSCarson Labrado if (!http_helpers::isContentTypeAllowed( 2979168d1b1aSCarson Labrado req.getHeaderValue("Accept"), 2980168d1b1aSCarson Labrado http_helpers::ContentType::OctetStream, true)) 2981168d1b1aSCarson Labrado { 2982168d1b1aSCarson Labrado asyncResp->res.result(boost::beast::http::status::bad_request); 2983168d1b1aSCarson Labrado return; 2984168d1b1aSCarson Labrado } 2985168d1b1aSCarson Labrado downloadEventLogEntry(asyncResp, systemName, entryID, dumpType); 2986168d1b1aSCarson Labrado } 2987168d1b1aSCarson Labrado 2988fdd26906SClaire Weinan inline void handleLogServicesDumpCollectDiagnosticDataPost( 2989fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2990fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2991fdd26906SClaire Weinan { 2992fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2993fdd26906SClaire Weinan { 2994fdd26906SClaire Weinan return; 2995fdd26906SClaire Weinan } 2996fdd26906SClaire Weinan createDump(asyncResp, req, dumpType); 2997fdd26906SClaire Weinan } 2998fdd26906SClaire Weinan 299922d268cbSEd Tanous inline void handleLogServicesDumpCollectDiagnosticDataComputerSystemPost( 300022d268cbSEd Tanous crow::App& app, const crow::Request& req, 300122d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 30027f3e84a1SEd Tanous const std::string& systemName) 300322d268cbSEd Tanous { 300422d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 300522d268cbSEd Tanous { 300622d268cbSEd Tanous return; 300722d268cbSEd Tanous } 30087f3e84a1SEd Tanous 30097f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 301022d268cbSEd Tanous { 30117f3e84a1SEd Tanous // Option currently returns no systems. TBD 30127f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 30137f3e84a1SEd Tanous systemName); 30147f3e84a1SEd Tanous return; 30157f3e84a1SEd Tanous } 30167f3e84a1SEd Tanous if (systemName != "system") 30177f3e84a1SEd Tanous { 30187f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 30197f3e84a1SEd Tanous systemName); 302022d268cbSEd Tanous return; 302122d268cbSEd Tanous } 302222d268cbSEd Tanous createDump(asyncResp, req, "System"); 302322d268cbSEd Tanous } 302422d268cbSEd Tanous 3025fdd26906SClaire Weinan inline void handleLogServicesDumpClearLogPost( 3026fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 3027fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 3028fdd26906SClaire Weinan { 3029fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3030fdd26906SClaire Weinan { 3031fdd26906SClaire Weinan return; 3032fdd26906SClaire Weinan } 3033fdd26906SClaire Weinan clearDump(asyncResp, dumpType); 3034fdd26906SClaire Weinan } 3035fdd26906SClaire Weinan 303622d268cbSEd Tanous inline void handleLogServicesDumpClearLogComputerSystemPost( 303722d268cbSEd Tanous crow::App& app, const crow::Request& req, 303822d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 30397f3e84a1SEd Tanous const std::string& systemName) 304022d268cbSEd Tanous { 304122d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 304222d268cbSEd Tanous { 304322d268cbSEd Tanous return; 304422d268cbSEd Tanous } 30457f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 304622d268cbSEd Tanous { 30477f3e84a1SEd Tanous // Option currently returns no systems. TBD 30487f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 30497f3e84a1SEd Tanous systemName); 30507f3e84a1SEd Tanous return; 30517f3e84a1SEd Tanous } 30527f3e84a1SEd Tanous if (systemName != "system") 30537f3e84a1SEd Tanous { 30547f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 30557f3e84a1SEd Tanous systemName); 305622d268cbSEd Tanous return; 305722d268cbSEd Tanous } 305822d268cbSEd Tanous clearDump(asyncResp, "System"); 305922d268cbSEd Tanous } 306022d268cbSEd Tanous 3061fdd26906SClaire Weinan inline void requestRoutesBMCDumpService(App& app) 3062fdd26906SClaire Weinan { 3063fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/") 3064fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 3065fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 3066fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "BMC")); 3067fdd26906SClaire Weinan } 3068fdd26906SClaire Weinan 3069fdd26906SClaire Weinan inline void requestRoutesBMCDumpEntryCollection(App& app) 3070fdd26906SClaire Weinan { 3071fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/") 3072fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 3073fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 3074fdd26906SClaire Weinan handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC")); 3075c9bb6861Sraviteja-b } 3076c9bb6861Sraviteja-b 30777e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app) 3078c9bb6861Sraviteja-b { 30797e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 30807e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 3081ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 3082fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 3083fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "BMC")); 3084fdd26906SClaire Weinan 30857e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 30867e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 3087ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 3088fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 3089fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "BMC")); 3090c9bb6861Sraviteja-b } 3091c9bb6861Sraviteja-b 3092168d1b1aSCarson Labrado inline void requestRoutesBMCDumpEntryDownload(App& app) 3093168d1b1aSCarson Labrado { 3094168d1b1aSCarson Labrado BMCWEB_ROUTE( 3095168d1b1aSCarson Labrado app, 30969e9d99daSRavi Teja "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/attachment/") 3097168d1b1aSCarson Labrado .privileges(redfish::privileges::getLogEntry) 3098168d1b1aSCarson Labrado .methods(boost::beast::http::verb::get)(std::bind_front( 3099168d1b1aSCarson Labrado handleLogServicesDumpEntryDownloadGet, std::ref(app), "BMC")); 3100168d1b1aSCarson Labrado } 3101168d1b1aSCarson Labrado 31027e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app) 3103c9bb6861Sraviteja-b { 31040fda0f12SGeorge Liu BMCWEB_ROUTE( 31050fda0f12SGeorge Liu app, 31060fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 3107ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 31087e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 3109fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost, 3110fdd26906SClaire Weinan std::ref(app), "BMC")); 3111a43be80fSAsmitha Karunanithi } 3112a43be80fSAsmitha Karunanithi 31137e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app) 311480319af1SAsmitha Karunanithi { 31150fda0f12SGeorge Liu BMCWEB_ROUTE( 31160fda0f12SGeorge Liu app, 31170fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog/") 3118ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 3119fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 3120fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "BMC")); 312145ca1b86SEd Tanous } 3122fdd26906SClaire Weinan 3123168d1b1aSCarson Labrado inline void requestRoutesDBusEventLogEntryDownload(App& app) 3124168d1b1aSCarson Labrado { 3125168d1b1aSCarson Labrado BMCWEB_ROUTE( 3126168d1b1aSCarson Labrado app, 31279e9d99daSRavi Teja "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/attachment/") 3128168d1b1aSCarson Labrado .privileges(redfish::privileges::getLogEntry) 3129168d1b1aSCarson Labrado .methods(boost::beast::http::verb::get)(std::bind_front( 3130168d1b1aSCarson Labrado handleDBusEventLogEntryDownloadGet, std::ref(app), "System")); 3131168d1b1aSCarson Labrado } 3132168d1b1aSCarson Labrado 3133fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpService(App& app) 3134fdd26906SClaire Weinan { 3135fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/") 3136fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 3137fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 3138fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "FaultLog")); 3139fdd26906SClaire Weinan } 3140fdd26906SClaire Weinan 3141fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntryCollection(App& app) 3142fdd26906SClaire Weinan { 3143fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/") 3144fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 3145fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 3146fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpEntriesCollectionGet, 3147fdd26906SClaire Weinan std::ref(app), "FaultLog")); 3148fdd26906SClaire Weinan } 3149fdd26906SClaire Weinan 3150fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntry(App& app) 3151fdd26906SClaire Weinan { 3152fdd26906SClaire Weinan BMCWEB_ROUTE(app, 3153fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 3154fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntry) 3155fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 3156fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "FaultLog")); 3157fdd26906SClaire Weinan 3158fdd26906SClaire Weinan BMCWEB_ROUTE(app, 3159fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 3160fdd26906SClaire Weinan .privileges(redfish::privileges::deleteLogEntry) 3161fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 3162fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog")); 3163fdd26906SClaire Weinan } 3164fdd26906SClaire Weinan 3165fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpClear(App& app) 3166fdd26906SClaire Weinan { 3167fdd26906SClaire Weinan BMCWEB_ROUTE( 3168fdd26906SClaire Weinan app, 3169fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog/") 3170fdd26906SClaire Weinan .privileges(redfish::privileges::postLogService) 3171fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 3172fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog")); 31735cb1dd27SAsmitha Karunanithi } 31745cb1dd27SAsmitha Karunanithi 31757e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app) 31765cb1dd27SAsmitha Karunanithi { 317722d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/") 3178ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 31796ab9ad54SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 318022d268cbSEd Tanous handleLogServicesDumpServiceComputerSystemGet, std::ref(app))); 31815cb1dd27SAsmitha Karunanithi } 31825cb1dd27SAsmitha Karunanithi 31837e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app) 31847e860f15SJohn Edward Broadbent { 318522d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/") 3186ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 318722d268cbSEd Tanous .methods(boost::beast::http::verb::get)(std::bind_front( 318822d268cbSEd Tanous handleLogServicesDumpEntriesCollectionComputerSystemGet, 318922d268cbSEd Tanous std::ref(app))); 31905cb1dd27SAsmitha Karunanithi } 31915cb1dd27SAsmitha Karunanithi 31927e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app) 31935cb1dd27SAsmitha Karunanithi { 31947e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 319522d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/") 3196ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 31976ab9ad54SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 319822d268cbSEd Tanous handleLogServicesDumpEntryComputerSystemGet, std::ref(app))); 31998d1b46d7Szhanghch05 32007e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 320122d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/") 3202ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 32036ab9ad54SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 320422d268cbSEd Tanous handleLogServicesDumpEntryComputerSystemDelete, std::ref(app))); 32055cb1dd27SAsmitha Karunanithi } 3206c9bb6861Sraviteja-b 32077e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app) 3208c9bb6861Sraviteja-b { 32090fda0f12SGeorge Liu BMCWEB_ROUTE( 32100fda0f12SGeorge Liu app, 321122d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 3212ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 321322d268cbSEd Tanous .methods(boost::beast::http::verb::post)(std::bind_front( 321422d268cbSEd Tanous handleLogServicesDumpCollectDiagnosticDataComputerSystemPost, 321522d268cbSEd Tanous std::ref(app))); 3216a43be80fSAsmitha Karunanithi } 3217a43be80fSAsmitha Karunanithi 32187e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app) 3219a43be80fSAsmitha Karunanithi { 32200fda0f12SGeorge Liu BMCWEB_ROUTE( 32210fda0f12SGeorge Liu app, 322222d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.ClearLog/") 3223ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 32246ab9ad54SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 322522d268cbSEd Tanous handleLogServicesDumpClearLogComputerSystemPost, std::ref(app))); 3226013487e5Sraviteja-b } 3227013487e5Sraviteja-b 32287e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app) 32291da66f75SEd Tanous { 32303946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 32313946028dSAppaRao Puli // method for security reasons. 32321da66f75SEd Tanous /** 32331da66f75SEd Tanous * Functions triggers appropriate requests on DBus 32341da66f75SEd Tanous */ 323522d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/") 3236ed398213SEd Tanous // This is incorrect, should be: 3237ed398213SEd Tanous //.privileges(redfish::privileges::getLogService) 3238432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 3239002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 3240002d39b4SEd Tanous [&app](const crow::Request& req, 324122d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 324222d268cbSEd Tanous const std::string& systemName) { 32433ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 324445ca1b86SEd Tanous { 324545ca1b86SEd Tanous return; 324645ca1b86SEd Tanous } 32477f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 32487f3e84a1SEd Tanous { 32497f3e84a1SEd Tanous // Option currently returns no systems. TBD 32507f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 32517f3e84a1SEd Tanous systemName); 32527f3e84a1SEd Tanous return; 32537f3e84a1SEd Tanous } 325422d268cbSEd Tanous if (systemName != "system") 325522d268cbSEd Tanous { 325622d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 325722d268cbSEd Tanous systemName); 325822d268cbSEd Tanous return; 325922d268cbSEd Tanous } 326022d268cbSEd Tanous 32617e860f15SJohn Edward Broadbent // Copy over the static data to include the entries added by 32627e860f15SJohn Edward Broadbent // SubRoute 32630f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 3264424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"; 3265e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 32668e6c099aSJason M. Bills "#LogService.v1_2_0.LogService"; 32674f50ae4bSGunnar Mills asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service"; 32684f50ae4bSGunnar Mills asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service"; 326915b89725SV-Sanjana asyncResp->res.jsonValue["Id"] = "Crashdump"; 3270e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 3271e1f26343SJason M. Bills asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; 32727c8c4058STejas Patil 32737c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 32742b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 32757c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 32767c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 32777c8c4058STejas Patil redfishDateTimeOffset.second; 32787c8c4058STejas Patil 32791476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 3280ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 3281002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 32821476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog"; 3283002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 32841476687dSEd Tanous ["target"] = 32851476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData"; 32867e860f15SJohn Edward Broadbent }); 32871da66f75SEd Tanous } 32881da66f75SEd Tanous 32897e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app) 32905b61b5e8SJason M. Bills { 32910fda0f12SGeorge Liu BMCWEB_ROUTE( 32920fda0f12SGeorge Liu app, 329322d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.ClearLog/") 3294ed398213SEd Tanous // This is incorrect, should be: 3295ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3296432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 32977e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 329845ca1b86SEd Tanous [&app](const crow::Request& req, 329922d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 330022d268cbSEd Tanous const std::string& systemName) { 33013ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 330245ca1b86SEd Tanous { 330345ca1b86SEd Tanous return; 330445ca1b86SEd Tanous } 33057f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 33067f3e84a1SEd Tanous { 33077f3e84a1SEd Tanous // Option currently returns no systems. TBD 33087f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 33097f3e84a1SEd Tanous systemName); 33107f3e84a1SEd Tanous return; 33117f3e84a1SEd Tanous } 331222d268cbSEd Tanous if (systemName != "system") 331322d268cbSEd Tanous { 331422d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 331522d268cbSEd Tanous systemName); 331622d268cbSEd Tanous return; 331722d268cbSEd Tanous } 33185b61b5e8SJason M. Bills crow::connections::systemBus->async_method_call( 33195e7e2dc5SEd Tanous [asyncResp](const boost::system::error_code& ec, 3320cb13a392SEd Tanous const std::string&) { 33215b61b5e8SJason M. Bills if (ec) 33225b61b5e8SJason M. Bills { 33235b61b5e8SJason M. Bills messages::internalError(asyncResp->res); 33245b61b5e8SJason M. Bills return; 33255b61b5e8SJason M. Bills } 33265b61b5e8SJason M. Bills messages::success(asyncResp->res); 33275b61b5e8SJason M. Bills }, 3328002d39b4SEd Tanous crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll"); 33297e860f15SJohn Edward Broadbent }); 33305b61b5e8SJason M. Bills } 33315b61b5e8SJason M. Bills 33328d1b46d7Szhanghch05 static void 33338d1b46d7Szhanghch05 logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 33348d1b46d7Szhanghch05 const std::string& logID, nlohmann::json& logEntryJson) 3335e855dd28SJason M. Bills { 3336043a0536SJohnathan Mantey auto getStoredLogCallback = 3337b9d36b47SEd Tanous [asyncResp, logID, 33385e7e2dc5SEd Tanous &logEntryJson](const boost::system::error_code& ec, 3339b9d36b47SEd Tanous const dbus::utility::DBusPropertiesMap& params) { 3340e855dd28SJason M. Bills if (ec) 3341e855dd28SJason M. Bills { 334262598e31SEd Tanous BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message()); 33431ddcf01aSJason M. Bills if (ec.value() == 33441ddcf01aSJason M. Bills boost::system::linux_error::bad_request_descriptor) 33451ddcf01aSJason M. Bills { 3346002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 33471ddcf01aSJason M. Bills } 33481ddcf01aSJason M. Bills else 33491ddcf01aSJason M. Bills { 3350e855dd28SJason M. Bills messages::internalError(asyncResp->res); 33511ddcf01aSJason M. Bills } 3352e855dd28SJason M. Bills return; 3353e855dd28SJason M. Bills } 3354043a0536SJohnathan Mantey 3355043a0536SJohnathan Mantey std::string timestamp{}; 3356043a0536SJohnathan Mantey std::string filename{}; 3357043a0536SJohnathan Mantey std::string logfile{}; 33582c70f800SEd Tanous parseCrashdumpParameters(params, filename, timestamp, logfile); 3359043a0536SJohnathan Mantey 3360043a0536SJohnathan Mantey if (filename.empty() || timestamp.empty()) 3361e855dd28SJason M. Bills { 33629db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 3363e855dd28SJason M. Bills return; 3364e855dd28SJason M. Bills } 3365e855dd28SJason M. Bills 3366043a0536SJohnathan Mantey std::string crashdumpURI = 3367e855dd28SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + 3368043a0536SJohnathan Mantey logID + "/" + filename; 336984afc48bSJason M. Bills nlohmann::json::object_t logEntry; 33709c11a172SVijay Lobo logEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 3371ef4c65b7SEd Tanous logEntry["@odata.id"] = boost::urls::format( 3372ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/{}", 3373ef4c65b7SEd Tanous logID); 337484afc48bSJason M. Bills logEntry["Name"] = "CPU Crashdump"; 337584afc48bSJason M. Bills logEntry["Id"] = logID; 337684afc48bSJason M. Bills logEntry["EntryType"] = "Oem"; 337784afc48bSJason M. Bills logEntry["AdditionalDataURI"] = std::move(crashdumpURI); 337884afc48bSJason M. Bills logEntry["DiagnosticDataType"] = "OEM"; 337984afc48bSJason M. Bills logEntry["OEMDiagnosticDataType"] = "PECICrashdump"; 338084afc48bSJason M. Bills logEntry["Created"] = std::move(timestamp); 33812b20ef6eSJason M. Bills 33822b20ef6eSJason M. Bills // If logEntryJson references an array of LogEntry resources 33832b20ef6eSJason M. Bills // ('Members' list), then push this as a new entry, otherwise set it 33842b20ef6eSJason M. Bills // directly 33852b20ef6eSJason M. Bills if (logEntryJson.is_array()) 33862b20ef6eSJason M. Bills { 33872b20ef6eSJason M. Bills logEntryJson.push_back(logEntry); 33882b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 33892b20ef6eSJason M. Bills logEntryJson.size(); 33902b20ef6eSJason M. Bills } 33912b20ef6eSJason M. Bills else 33922b20ef6eSJason M. Bills { 3393d405bb51SJason M. Bills logEntryJson.update(logEntry); 33942b20ef6eSJason M. Bills } 3395e855dd28SJason M. Bills }; 3396d1bde9e5SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 3397d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, crashdumpObject, 3398d1bde9e5SKrzysztof Grobelny crashdumpPath + std::string("/") + logID, crashdumpInterface, 3399d1bde9e5SKrzysztof Grobelny std::move(getStoredLogCallback)); 3400e855dd28SJason M. Bills } 3401e855dd28SJason M. Bills 34027e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app) 34031da66f75SEd Tanous { 34043946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 34053946028dSAppaRao Puli // method for security reasons. 34061da66f75SEd Tanous /** 34071da66f75SEd Tanous * Functions triggers appropriate requests on DBus 34081da66f75SEd Tanous */ 34097e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 341022d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/") 3411ed398213SEd Tanous // This is incorrect, should be. 3412ed398213SEd Tanous //.privileges(redfish::privileges::postLogEntryCollection) 3413432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 3414002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 3415002d39b4SEd Tanous [&app](const crow::Request& req, 341622d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 341722d268cbSEd Tanous const std::string& systemName) { 34183ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 341945ca1b86SEd Tanous { 342045ca1b86SEd Tanous return; 342145ca1b86SEd Tanous } 34227f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 34237f3e84a1SEd Tanous { 34247f3e84a1SEd Tanous // Option currently returns no systems. TBD 34257f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 34267f3e84a1SEd Tanous systemName); 34277f3e84a1SEd Tanous return; 34287f3e84a1SEd Tanous } 342922d268cbSEd Tanous if (systemName != "system") 343022d268cbSEd Tanous { 343122d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 343222d268cbSEd Tanous systemName); 343322d268cbSEd Tanous return; 343422d268cbSEd Tanous } 343522d268cbSEd Tanous 34367a1dbc48SGeorge Liu constexpr std::array<std::string_view, 1> interfaces = { 34377a1dbc48SGeorge Liu crashdumpInterface}; 34387a1dbc48SGeorge Liu dbus::utility::getSubTreePaths( 34397a1dbc48SGeorge Liu "/", 0, interfaces, 34407a1dbc48SGeorge Liu [asyncResp](const boost::system::error_code& ec, 34412b20ef6eSJason M. Bills const std::vector<std::string>& resp) { 34421da66f75SEd Tanous if (ec) 34431da66f75SEd Tanous { 34441da66f75SEd Tanous if (ec.value() != 34451da66f75SEd Tanous boost::system::errc::no_such_file_or_directory) 34461da66f75SEd Tanous { 344762598e31SEd Tanous BMCWEB_LOG_DEBUG("failed to get entries ec: {}", 344862598e31SEd Tanous ec.message()); 3449f12894f8SJason M. Bills messages::internalError(asyncResp->res); 34501da66f75SEd Tanous return; 34511da66f75SEd Tanous } 34521da66f75SEd Tanous } 3453e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 34541da66f75SEd Tanous "#LogEntryCollection.LogEntryCollection"; 34550f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 3456424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 3457002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries"; 3458e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 3459424c4176SJason M. Bills "Collection of Crashdump Entries"; 3460002d39b4SEd Tanous asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3461a2dd60a6SBrandon Kim asyncResp->res.jsonValue["Members@odata.count"] = 0; 34622b20ef6eSJason M. Bills 34632b20ef6eSJason M. Bills for (const std::string& path : resp) 34641da66f75SEd Tanous { 34652b20ef6eSJason M. Bills const sdbusplus::message::object_path objPath(path); 3466e855dd28SJason M. Bills // Get the log ID 34672b20ef6eSJason M. Bills std::string logID = objPath.filename(); 34682b20ef6eSJason M. Bills if (logID.empty()) 34691da66f75SEd Tanous { 3470e855dd28SJason M. Bills continue; 34711da66f75SEd Tanous } 3472e855dd28SJason M. Bills // Add the log entry to the array 34732b20ef6eSJason M. Bills logCrashdumpEntry(asyncResp, logID, 34742b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members"]); 34751da66f75SEd Tanous } 34767a1dbc48SGeorge Liu }); 34777e860f15SJohn Edward Broadbent }); 34781da66f75SEd Tanous } 34791da66f75SEd Tanous 34807e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app) 34811da66f75SEd Tanous { 34823946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 34833946028dSAppaRao Puli // method for security reasons. 34841da66f75SEd Tanous 34857e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 348622d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/") 3487ed398213SEd Tanous // this is incorrect, should be 3488ed398213SEd Tanous // .privileges(redfish::privileges::getLogEntry) 3489432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 34907e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 349145ca1b86SEd Tanous [&app](const crow::Request& req, 34927e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 349322d268cbSEd Tanous const std::string& systemName, const std::string& param) { 34943ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 349545ca1b86SEd Tanous { 349645ca1b86SEd Tanous return; 349745ca1b86SEd Tanous } 34987f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 34997f3e84a1SEd Tanous { 35007f3e84a1SEd Tanous // Option currently returns no systems. TBD 35017f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 35027f3e84a1SEd Tanous systemName); 35037f3e84a1SEd Tanous return; 35047f3e84a1SEd Tanous } 350522d268cbSEd Tanous if (systemName != "system") 350622d268cbSEd Tanous { 350722d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 350822d268cbSEd Tanous systemName); 350922d268cbSEd Tanous return; 351022d268cbSEd Tanous } 35117e860f15SJohn Edward Broadbent const std::string& logID = param; 3512e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue); 35137e860f15SJohn Edward Broadbent }); 3514e855dd28SJason M. Bills } 3515e855dd28SJason M. Bills 35167e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app) 3517e855dd28SJason M. Bills { 35183946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 35193946028dSAppaRao Puli // method for security reasons. 35207e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 35217e860f15SJohn Edward Broadbent app, 352222d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/<str>/") 3523ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 35247e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 3525a4ce114aSNan Zhou [](const crow::Request& req, 35267e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 352722d268cbSEd Tanous const std::string& systemName, const std::string& logID, 352822d268cbSEd Tanous const std::string& fileName) { 35292a9beeedSShounak Mitra // Do not call getRedfishRoute here since the crashdump file is not a 35302a9beeedSShounak Mitra // Redfish resource. 353122d268cbSEd Tanous 35327f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 35337f3e84a1SEd Tanous { 35347f3e84a1SEd Tanous // Option currently returns no systems. TBD 35357f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 35367f3e84a1SEd Tanous systemName); 35377f3e84a1SEd Tanous return; 35387f3e84a1SEd Tanous } 353922d268cbSEd Tanous if (systemName != "system") 354022d268cbSEd Tanous { 354122d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 354222d268cbSEd Tanous systemName); 354322d268cbSEd Tanous return; 354422d268cbSEd Tanous } 354522d268cbSEd Tanous 3546043a0536SJohnathan Mantey auto getStoredLogCallback = 354739662a3bSEd Tanous [asyncResp, logID, fileName, url(boost::urls::url(req.url()))]( 35485e7e2dc5SEd Tanous const boost::system::error_code& ec, 3549002d39b4SEd Tanous const std::vector< 3550002d39b4SEd Tanous std::pair<std::string, dbus::utility::DbusVariantType>>& 35517e860f15SJohn Edward Broadbent resp) { 35521da66f75SEd Tanous if (ec) 35531da66f75SEd Tanous { 355462598e31SEd Tanous BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message()); 3555f12894f8SJason M. Bills messages::internalError(asyncResp->res); 35561da66f75SEd Tanous return; 35571da66f75SEd Tanous } 3558e855dd28SJason M. Bills 3559043a0536SJohnathan Mantey std::string dbusFilename{}; 3560043a0536SJohnathan Mantey std::string dbusTimestamp{}; 3561043a0536SJohnathan Mantey std::string dbusFilepath{}; 3562043a0536SJohnathan Mantey 3563002d39b4SEd Tanous parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp, 3564002d39b4SEd Tanous dbusFilepath); 3565043a0536SJohnathan Mantey 3566043a0536SJohnathan Mantey if (dbusFilename.empty() || dbusTimestamp.empty() || 3567043a0536SJohnathan Mantey dbusFilepath.empty()) 35681da66f75SEd Tanous { 35699db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 35701da66f75SEd Tanous return; 35711da66f75SEd Tanous } 3572e855dd28SJason M. Bills 3573043a0536SJohnathan Mantey // Verify the file name parameter is correct 3574043a0536SJohnathan Mantey if (fileName != dbusFilename) 3575043a0536SJohnathan Mantey { 35769db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 3577043a0536SJohnathan Mantey return; 3578043a0536SJohnathan Mantey } 3579043a0536SJohnathan Mantey 358027b0cf90SEd Tanous if (!asyncResp->res.openFile(dbusFilepath)) 3581043a0536SJohnathan Mantey { 35829db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 3583043a0536SJohnathan Mantey return; 3584043a0536SJohnathan Mantey } 3585043a0536SJohnathan Mantey 35867e860f15SJohn Edward Broadbent // Configure this to be a file download when accessed 35877e860f15SJohn Edward Broadbent // from a browser 3588d9f6c621SEd Tanous asyncResp->res.addHeader( 3589d9f6c621SEd Tanous boost::beast::http::field::content_disposition, "attachment"); 35901da66f75SEd Tanous }; 3591d1bde9e5SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 3592d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, crashdumpObject, 3593d1bde9e5SKrzysztof Grobelny crashdumpPath + std::string("/") + logID, crashdumpInterface, 3594d1bde9e5SKrzysztof Grobelny std::move(getStoredLogCallback)); 35957e860f15SJohn Edward Broadbent }); 35961da66f75SEd Tanous } 35971da66f75SEd Tanous 3598c5a4c82aSJason M. Bills enum class OEMDiagnosticType 3599c5a4c82aSJason M. Bills { 3600c5a4c82aSJason M. Bills onDemand, 3601c5a4c82aSJason M. Bills telemetry, 3602c5a4c82aSJason M. Bills invalid, 3603c5a4c82aSJason M. Bills }; 3604c5a4c82aSJason M. Bills 360526ccae32SEd Tanous inline OEMDiagnosticType getOEMDiagnosticType(std::string_view oemDiagStr) 3606c5a4c82aSJason M. Bills { 3607c5a4c82aSJason M. Bills if (oemDiagStr == "OnDemand") 3608c5a4c82aSJason M. Bills { 3609c5a4c82aSJason M. Bills return OEMDiagnosticType::onDemand; 3610c5a4c82aSJason M. Bills } 3611c5a4c82aSJason M. Bills if (oemDiagStr == "Telemetry") 3612c5a4c82aSJason M. Bills { 3613c5a4c82aSJason M. Bills return OEMDiagnosticType::telemetry; 3614c5a4c82aSJason M. Bills } 3615c5a4c82aSJason M. Bills 3616c5a4c82aSJason M. Bills return OEMDiagnosticType::invalid; 3617c5a4c82aSJason M. Bills } 3618c5a4c82aSJason M. Bills 36197e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app) 36201da66f75SEd Tanous { 36213946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 36223946028dSAppaRao Puli // method for security reasons. 36230fda0f12SGeorge Liu BMCWEB_ROUTE( 36240fda0f12SGeorge Liu app, 362522d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/") 3626ed398213SEd Tanous // The below is incorrect; Should be ConfigureManager 3627ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3628432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 3629002d39b4SEd Tanous .methods(boost::beast::http::verb::post)( 3630002d39b4SEd Tanous [&app](const crow::Request& req, 363122d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 363222d268cbSEd Tanous const std::string& systemName) { 36333ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 363445ca1b86SEd Tanous { 363545ca1b86SEd Tanous return; 363645ca1b86SEd Tanous } 363722d268cbSEd Tanous 36387f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 36397f3e84a1SEd Tanous { 36407f3e84a1SEd Tanous // Option currently returns no systems. TBD 36417f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 36427f3e84a1SEd Tanous systemName); 36437f3e84a1SEd Tanous return; 36447f3e84a1SEd Tanous } 364522d268cbSEd Tanous if (systemName != "system") 364622d268cbSEd Tanous { 364722d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 364822d268cbSEd Tanous systemName); 364922d268cbSEd Tanous return; 365022d268cbSEd Tanous } 365122d268cbSEd Tanous 36528e6c099aSJason M. Bills std::string diagnosticDataType; 36538e6c099aSJason M. Bills std::string oemDiagnosticDataType; 365415ed6780SWilly Tu if (!redfish::json_util::readJsonAction( 3655002d39b4SEd Tanous req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 3656002d39b4SEd Tanous "OEMDiagnosticDataType", oemDiagnosticDataType)) 36578e6c099aSJason M. Bills { 36588e6c099aSJason M. Bills return; 36598e6c099aSJason M. Bills } 36608e6c099aSJason M. Bills 36618e6c099aSJason M. Bills if (diagnosticDataType != "OEM") 36628e6c099aSJason M. Bills { 366362598e31SEd Tanous BMCWEB_LOG_ERROR( 366462598e31SEd Tanous "Only OEM DiagnosticDataType supported for Crashdump"); 36658e6c099aSJason M. Bills messages::actionParameterValueFormatError( 36668e6c099aSJason M. Bills asyncResp->res, diagnosticDataType, "DiagnosticDataType", 36678e6c099aSJason M. Bills "CollectDiagnosticData"); 36688e6c099aSJason M. Bills return; 36698e6c099aSJason M. Bills } 36708e6c099aSJason M. Bills 3671c5a4c82aSJason M. Bills OEMDiagnosticType oemDiagType = 3672c5a4c82aSJason M. Bills getOEMDiagnosticType(oemDiagnosticDataType); 3673c5a4c82aSJason M. Bills 3674c5a4c82aSJason M. Bills std::string iface; 3675c5a4c82aSJason M. Bills std::string method; 3676c5a4c82aSJason M. Bills std::string taskMatchStr; 3677c5a4c82aSJason M. Bills if (oemDiagType == OEMDiagnosticType::onDemand) 3678c5a4c82aSJason M. Bills { 3679c5a4c82aSJason M. Bills iface = crashdumpOnDemandInterface; 3680c5a4c82aSJason M. Bills method = "GenerateOnDemandLog"; 3681c5a4c82aSJason M. Bills taskMatchStr = "type='signal'," 3682c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 3683c5a4c82aSJason M. Bills "member='PropertiesChanged'," 3684c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 3685c5a4c82aSJason M. Bills } 3686c5a4c82aSJason M. Bills else if (oemDiagType == OEMDiagnosticType::telemetry) 3687c5a4c82aSJason M. Bills { 3688c5a4c82aSJason M. Bills iface = crashdumpTelemetryInterface; 3689c5a4c82aSJason M. Bills method = "GenerateTelemetryLog"; 3690c5a4c82aSJason M. Bills taskMatchStr = "type='signal'," 3691c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 3692c5a4c82aSJason M. Bills "member='PropertiesChanged'," 3693c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 3694c5a4c82aSJason M. Bills } 3695c5a4c82aSJason M. Bills else 3696c5a4c82aSJason M. Bills { 369762598e31SEd Tanous BMCWEB_LOG_ERROR("Unsupported OEMDiagnosticDataType: {}", 369862598e31SEd Tanous oemDiagnosticDataType); 3699c5a4c82aSJason M. Bills messages::actionParameterValueFormatError( 3700002d39b4SEd Tanous asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType", 3701002d39b4SEd Tanous "CollectDiagnosticData"); 3702c5a4c82aSJason M. Bills return; 3703c5a4c82aSJason M. Bills } 3704c5a4c82aSJason M. Bills 3705c5a4c82aSJason M. Bills auto collectCrashdumpCallback = 3706c5a4c82aSJason M. Bills [asyncResp, payload(task::Payload(req)), 37075e7e2dc5SEd Tanous taskMatchStr](const boost::system::error_code& ec, 370898be3e39SEd Tanous const std::string&) mutable { 37091da66f75SEd Tanous if (ec) 37101da66f75SEd Tanous { 3711002d39b4SEd Tanous if (ec.value() == boost::system::errc::operation_not_supported) 37121da66f75SEd Tanous { 3713f12894f8SJason M. Bills messages::resourceInStandby(asyncResp->res); 37141da66f75SEd Tanous } 37154363d3b2SJason M. Bills else if (ec.value() == 37164363d3b2SJason M. Bills boost::system::errc::device_or_resource_busy) 37174363d3b2SJason M. Bills { 3718002d39b4SEd Tanous messages::serviceTemporarilyUnavailable(asyncResp->res, 3719002d39b4SEd Tanous "60"); 37204363d3b2SJason M. Bills } 37211da66f75SEd Tanous else 37221da66f75SEd Tanous { 3723f12894f8SJason M. Bills messages::internalError(asyncResp->res); 37241da66f75SEd Tanous } 37251da66f75SEd Tanous return; 37261da66f75SEd Tanous } 3727002d39b4SEd Tanous std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 37288b24275dSEd Tanous [](const boost::system::error_code& ec2, sdbusplus::message_t&, 3729002d39b4SEd Tanous const std::shared_ptr<task::TaskData>& taskData) { 37308b24275dSEd Tanous if (!ec2) 373166afe4faSJames Feist { 3732002d39b4SEd Tanous taskData->messages.emplace_back(messages::taskCompletedOK( 3733e5d5006bSJames Feist std::to_string(taskData->index))); 3734831d6b09SJames Feist taskData->state = "Completed"; 373566afe4faSJames Feist } 373632898ceaSJames Feist return task::completed; 373766afe4faSJames Feist }, 3738c5a4c82aSJason M. Bills taskMatchStr); 3739c5a4c82aSJason M. Bills 374046229577SJames Feist task->startTimer(std::chrono::minutes(5)); 374146229577SJames Feist task->populateResp(asyncResp->res); 374298be3e39SEd Tanous task->payload.emplace(std::move(payload)); 37431da66f75SEd Tanous }; 37448e6c099aSJason M. Bills 37451da66f75SEd Tanous crow::connections::systemBus->async_method_call( 3746002d39b4SEd Tanous std::move(collectCrashdumpCallback), crashdumpObject, crashdumpPath, 3747002d39b4SEd Tanous iface, method); 37487e860f15SJohn Edward Broadbent }); 37496eda7685SKenny L. Ku } 37506eda7685SKenny L. Ku 3751cb92c03bSAndrew Geissler /** 3752cb92c03bSAndrew Geissler * DBusLogServiceActionsClear class supports POST method for ClearLog action. 3753cb92c03bSAndrew Geissler */ 37547e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app) 3755cb92c03bSAndrew Geissler { 3756cb92c03bSAndrew Geissler /** 3757cb92c03bSAndrew Geissler * Function handles POST method request. 3758cb92c03bSAndrew Geissler * The Clear Log actions does not require any parameter.The action deletes 3759cb92c03bSAndrew Geissler * all entries found in the Entries collection for this Log Service. 3760cb92c03bSAndrew Geissler */ 37617e860f15SJohn Edward Broadbent 37620fda0f12SGeorge Liu BMCWEB_ROUTE( 37630fda0f12SGeorge Liu app, 376422d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/") 3765ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 37667e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 376745ca1b86SEd Tanous [&app](const crow::Request& req, 376822d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 376922d268cbSEd Tanous const std::string& systemName) { 37703ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 377145ca1b86SEd Tanous { 377245ca1b86SEd Tanous return; 377345ca1b86SEd Tanous } 37747f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 37757f3e84a1SEd Tanous { 37767f3e84a1SEd Tanous // Option currently returns no systems. TBD 37777f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 37787f3e84a1SEd Tanous systemName); 37797f3e84a1SEd Tanous return; 37807f3e84a1SEd Tanous } 378122d268cbSEd Tanous if (systemName != "system") 378222d268cbSEd Tanous { 378322d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 378422d268cbSEd Tanous systemName); 378522d268cbSEd Tanous return; 378622d268cbSEd Tanous } 378762598e31SEd Tanous BMCWEB_LOG_DEBUG("Do delete all entries."); 3788cb92c03bSAndrew Geissler 3789cb92c03bSAndrew Geissler // Process response from Logging service. 37905e7e2dc5SEd Tanous auto respHandler = [asyncResp](const boost::system::error_code& ec) { 379162598e31SEd Tanous BMCWEB_LOG_DEBUG("doClearLog resp_handler callback: Done"); 3792cb92c03bSAndrew Geissler if (ec) 3793cb92c03bSAndrew Geissler { 3794cb92c03bSAndrew Geissler // TODO Handle for specific error code 379562598e31SEd Tanous BMCWEB_LOG_ERROR("doClearLog resp_handler got error {}", ec); 3796cb92c03bSAndrew Geissler asyncResp->res.result( 3797cb92c03bSAndrew Geissler boost::beast::http::status::internal_server_error); 3798cb92c03bSAndrew Geissler return; 3799cb92c03bSAndrew Geissler } 3800cb92c03bSAndrew Geissler 3801002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::no_content); 3802cb92c03bSAndrew Geissler }; 3803cb92c03bSAndrew Geissler 3804cb92c03bSAndrew Geissler // Make call to Logging service to request Clear Log 3805cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 38062c70f800SEd Tanous respHandler, "xyz.openbmc_project.Logging", 3807cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging", 3808cb92c03bSAndrew Geissler "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 38097e860f15SJohn Edward Broadbent }); 3810cb92c03bSAndrew Geissler } 3811a3316fc6SZhikuiRen 3812a3316fc6SZhikuiRen /**************************************************** 3813a3316fc6SZhikuiRen * Redfish PostCode interfaces 3814a3316fc6SZhikuiRen * using DBUS interface: getPostCodesTS 3815a3316fc6SZhikuiRen ******************************************************/ 38167e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesLogService(App& app) 3817a3316fc6SZhikuiRen { 381822d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/") 3819ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 3820002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 3821002d39b4SEd Tanous [&app](const crow::Request& req, 382222d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 382322d268cbSEd Tanous const std::string& systemName) { 38243ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 382545ca1b86SEd Tanous { 382645ca1b86SEd Tanous return; 382745ca1b86SEd Tanous } 38287f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 38297f3e84a1SEd Tanous { 38307f3e84a1SEd Tanous // Option currently returns no systems. TBD 38317f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 38327f3e84a1SEd Tanous systemName); 38337f3e84a1SEd Tanous return; 38347f3e84a1SEd Tanous } 383522d268cbSEd Tanous if (systemName != "system") 383622d268cbSEd Tanous { 383722d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 383822d268cbSEd Tanous systemName); 383922d268cbSEd Tanous return; 384022d268cbSEd Tanous } 38411476687dSEd Tanous asyncResp->res.jsonValue["@odata.id"] = 38421476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes"; 38431476687dSEd Tanous asyncResp->res.jsonValue["@odata.type"] = 3844b25644a1SJanet Adkins "#LogService.v1_2_0.LogService"; 38451476687dSEd Tanous asyncResp->res.jsonValue["Name"] = "POST Code Log Service"; 38461476687dSEd Tanous asyncResp->res.jsonValue["Description"] = "POST Code Log Service"; 3847ed34a4adSEd Tanous asyncResp->res.jsonValue["Id"] = "PostCodes"; 38481476687dSEd Tanous asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 38491476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 38501476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 38517c8c4058STejas Patil 38527c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 38532b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 38540fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 38557c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 38567c8c4058STejas Patil redfishDateTimeOffset.second; 38577c8c4058STejas Patil 3858a3316fc6SZhikuiRen asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 38597e860f15SJohn Edward Broadbent {"target", 38600fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog"}}; 38617e860f15SJohn Edward Broadbent }); 3862a3316fc6SZhikuiRen } 3863a3316fc6SZhikuiRen 38647e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesClear(App& app) 3865a3316fc6SZhikuiRen { 38660fda0f12SGeorge Liu BMCWEB_ROUTE( 38670fda0f12SGeorge Liu app, 386822d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/PostCodes/Actions/LogService.ClearLog/") 3869ed398213SEd Tanous // The following privilege is incorrect; It should be ConfigureManager 3870ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3871432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 38727e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 387345ca1b86SEd Tanous [&app](const crow::Request& req, 387422d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 387522d268cbSEd Tanous const std::string& systemName) { 38763ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 387745ca1b86SEd Tanous { 387845ca1b86SEd Tanous return; 387945ca1b86SEd Tanous } 38807f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 38817f3e84a1SEd Tanous { 38827f3e84a1SEd Tanous // Option currently returns no systems. TBD 38837f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 38847f3e84a1SEd Tanous systemName); 38857f3e84a1SEd Tanous return; 38867f3e84a1SEd Tanous } 388722d268cbSEd Tanous if (systemName != "system") 388822d268cbSEd Tanous { 388922d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 389022d268cbSEd Tanous systemName); 389122d268cbSEd Tanous return; 389222d268cbSEd Tanous } 389362598e31SEd Tanous BMCWEB_LOG_DEBUG("Do delete all postcodes entries."); 3894a3316fc6SZhikuiRen 3895a3316fc6SZhikuiRen // Make call to post-code service to request clear all 3896a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 38975e7e2dc5SEd Tanous [asyncResp](const boost::system::error_code& ec) { 3898a3316fc6SZhikuiRen if (ec) 3899a3316fc6SZhikuiRen { 3900a3316fc6SZhikuiRen // TODO Handle for specific error code 390162598e31SEd Tanous BMCWEB_LOG_ERROR("doClearPostCodes resp_handler got error {}", 390262598e31SEd Tanous ec); 3903002d39b4SEd Tanous asyncResp->res.result( 3904002d39b4SEd Tanous boost::beast::http::status::internal_server_error); 3905a3316fc6SZhikuiRen messages::internalError(asyncResp->res); 3906a3316fc6SZhikuiRen return; 3907a3316fc6SZhikuiRen } 390818fc70c0STony Lee messages::success(asyncResp->res); 3909a3316fc6SZhikuiRen }, 391015124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 391115124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3912a3316fc6SZhikuiRen "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 39137e860f15SJohn Edward Broadbent }); 3914a3316fc6SZhikuiRen } 3915a3316fc6SZhikuiRen 39166f284d24SJiaqing Zhao /** 39176f284d24SJiaqing Zhao * @brief Parse post code ID and get the current value and index value 39186f284d24SJiaqing Zhao * eg: postCodeID=B1-2, currentValue=1, index=2 39196f284d24SJiaqing Zhao * 39206f284d24SJiaqing Zhao * @param[in] postCodeID Post Code ID 39216f284d24SJiaqing Zhao * @param[out] currentValue Current value 39226f284d24SJiaqing Zhao * @param[out] index Index value 39236f284d24SJiaqing Zhao * 39246f284d24SJiaqing Zhao * @return bool true if the parsing is successful, false the parsing fails 39256f284d24SJiaqing Zhao */ 39266f284d24SJiaqing Zhao inline static bool parsePostCode(const std::string& postCodeID, 39276f284d24SJiaqing Zhao uint64_t& currentValue, uint16_t& index) 39286f284d24SJiaqing Zhao { 39296f284d24SJiaqing Zhao std::vector<std::string> split; 393050ebd4afSEd Tanous bmcweb::split(split, postCodeID, '-'); 39316f284d24SJiaqing Zhao if (split.size() != 2 || split[0].length() < 2 || split[0].front() != 'B') 39326f284d24SJiaqing Zhao { 39336f284d24SJiaqing Zhao return false; 39346f284d24SJiaqing Zhao } 39356f284d24SJiaqing Zhao 393684396af9SPatrick Williams auto start = std::next(split[0].begin()); 393784396af9SPatrick Williams auto end = split[0].end(); 393884396af9SPatrick Williams auto [ptrIndex, ecIndex] = std::from_chars(&*start, &*end, index); 39396f284d24SJiaqing Zhao 394084396af9SPatrick Williams if (ptrIndex != &*end || ecIndex != std::errc()) 39416f284d24SJiaqing Zhao { 39426f284d24SJiaqing Zhao return false; 39436f284d24SJiaqing Zhao } 39446f284d24SJiaqing Zhao 394584396af9SPatrick Williams start = split[1].begin(); 394684396af9SPatrick Williams end = split[1].end(); 39476f284d24SJiaqing Zhao 394884396af9SPatrick Williams auto [ptrValue, ecValue] = std::from_chars(&*start, &*end, currentValue); 39496f284d24SJiaqing Zhao 395084396af9SPatrick Williams return ptrValue == &*end && ecValue == std::errc(); 39516f284d24SJiaqing Zhao } 39526f284d24SJiaqing Zhao 39536f284d24SJiaqing Zhao static bool fillPostCodeEntry( 3954ac106bf6SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 39556c9a279eSManojkiran Eda const boost::container::flat_map< 39566c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode, 3957a3316fc6SZhikuiRen const uint16_t bootIndex, const uint64_t codeIndex = 0, 3958a3316fc6SZhikuiRen const uint64_t skip = 0, const uint64_t top = 0) 3959a3316fc6SZhikuiRen { 3960a3316fc6SZhikuiRen // Get the Message from the MessageRegistry 3961fffb8c1fSEd Tanous const registries::Message* message = 3962fffb8c1fSEd Tanous registries::getMessage("OpenBMC.0.2.BIOSPOSTCode"); 3963a3316fc6SZhikuiRen 3964a3316fc6SZhikuiRen uint64_t currentCodeIndex = 0; 3965a3316fc6SZhikuiRen uint64_t firstCodeTimeUs = 0; 39666c9a279eSManojkiran Eda for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 39676c9a279eSManojkiran Eda code : postcode) 3968a3316fc6SZhikuiRen { 3969a3316fc6SZhikuiRen currentCodeIndex++; 3970a3316fc6SZhikuiRen std::string postcodeEntryID = 3971a3316fc6SZhikuiRen "B" + std::to_string(bootIndex) + "-" + 3972a3316fc6SZhikuiRen std::to_string(currentCodeIndex); // 1 based index in EntryID string 3973a3316fc6SZhikuiRen 3974a3316fc6SZhikuiRen uint64_t usecSinceEpoch = code.first; 3975a3316fc6SZhikuiRen uint64_t usTimeOffset = 0; 3976a3316fc6SZhikuiRen 3977a3316fc6SZhikuiRen if (1 == currentCodeIndex) 3978a3316fc6SZhikuiRen { // already incremented 3979a3316fc6SZhikuiRen firstCodeTimeUs = code.first; 3980a3316fc6SZhikuiRen } 3981a3316fc6SZhikuiRen else 3982a3316fc6SZhikuiRen { 3983a3316fc6SZhikuiRen usTimeOffset = code.first - firstCodeTimeUs; 3984a3316fc6SZhikuiRen } 3985a3316fc6SZhikuiRen 3986a3316fc6SZhikuiRen // skip if no specific codeIndex is specified and currentCodeIndex does 3987a3316fc6SZhikuiRen // not fall between top and skip 3988a3316fc6SZhikuiRen if ((codeIndex == 0) && 3989a3316fc6SZhikuiRen (currentCodeIndex <= skip || currentCodeIndex > top)) 3990a3316fc6SZhikuiRen { 3991a3316fc6SZhikuiRen continue; 3992a3316fc6SZhikuiRen } 3993a3316fc6SZhikuiRen 39944e0453b1SGunnar Mills // skip if a specific codeIndex is specified and does not match the 3995a3316fc6SZhikuiRen // currentIndex 3996a3316fc6SZhikuiRen if ((codeIndex > 0) && (currentCodeIndex != codeIndex)) 3997a3316fc6SZhikuiRen { 3998a3316fc6SZhikuiRen // This is done for simplicity. 1st entry is needed to calculate 3999a3316fc6SZhikuiRen // time offset. To improve efficiency, one can get to the entry 4000a3316fc6SZhikuiRen // directly (possibly with flatmap's nth method) 4001a3316fc6SZhikuiRen continue; 4002a3316fc6SZhikuiRen } 4003a3316fc6SZhikuiRen 4004a3316fc6SZhikuiRen // currentCodeIndex is within top and skip or equal to specified code 4005a3316fc6SZhikuiRen // index 4006a3316fc6SZhikuiRen 4007a3316fc6SZhikuiRen // Get the Created time from the timestamp 4008a3316fc6SZhikuiRen std::string entryTimeStr; 40092a025611SKonstantin Aladyshev entryTimeStr = redfish::time_utils::getDateTimeUintUs(usecSinceEpoch); 4010a3316fc6SZhikuiRen 4011a3316fc6SZhikuiRen // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex) 4012a3316fc6SZhikuiRen std::ostringstream hexCode; 4013a3316fc6SZhikuiRen hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex 40146c9a279eSManojkiran Eda << std::get<0>(code.second); 4015a3316fc6SZhikuiRen std::ostringstream timeOffsetStr; 4016a3316fc6SZhikuiRen // Set Fixed -Point Notation 4017a3316fc6SZhikuiRen timeOffsetStr << std::fixed; 4018a3316fc6SZhikuiRen // Set precision to 4 digits 4019a3316fc6SZhikuiRen timeOffsetStr << std::setprecision(4); 4020a3316fc6SZhikuiRen // Add double to stream 4021a3316fc6SZhikuiRen timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000; 4022a3316fc6SZhikuiRen 40231e6deaf6SEd Tanous std::string bootIndexStr = std::to_string(bootIndex); 40241e6deaf6SEd Tanous std::string timeOffsetString = timeOffsetStr.str(); 40251e6deaf6SEd Tanous std::string hexCodeStr = hexCode.str(); 4026a3316fc6SZhikuiRen 40271e6deaf6SEd Tanous std::array<std::string_view, 3> messageArgs = { 40281e6deaf6SEd Tanous bootIndexStr, timeOffsetString, hexCodeStr}; 40291e6deaf6SEd Tanous 40301e6deaf6SEd Tanous std::string msg = 40311e6deaf6SEd Tanous redfish::registries::fillMessageArgs(messageArgs, message->message); 40321e6deaf6SEd Tanous if (msg.empty()) 4033a3316fc6SZhikuiRen { 40341e6deaf6SEd Tanous messages::internalError(asyncResp->res); 40351e6deaf6SEd Tanous return false; 4036a3316fc6SZhikuiRen } 4037a3316fc6SZhikuiRen 4038d4342a92STim Lee // Get Severity template from message registry 4039d4342a92STim Lee std::string severity; 4040d4342a92STim Lee if (message != nullptr) 4041d4342a92STim Lee { 40425f2b84eeSEd Tanous severity = message->messageSeverity; 4043d4342a92STim Lee } 4044d4342a92STim Lee 40456f284d24SJiaqing Zhao // Format entry 40466f284d24SJiaqing Zhao nlohmann::json::object_t bmcLogEntry; 40479c11a172SVijay Lobo bmcLogEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 4048ef4c65b7SEd Tanous bmcLogEntry["@odata.id"] = boost::urls::format( 4049ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/{}", 4050ef4c65b7SEd Tanous postcodeEntryID); 405184afc48bSJason M. Bills bmcLogEntry["Name"] = "POST Code Log Entry"; 405284afc48bSJason M. Bills bmcLogEntry["Id"] = postcodeEntryID; 405384afc48bSJason M. Bills bmcLogEntry["Message"] = std::move(msg); 405484afc48bSJason M. Bills bmcLogEntry["MessageId"] = "OpenBMC.0.2.BIOSPOSTCode"; 40551e6deaf6SEd Tanous bmcLogEntry["MessageArgs"] = messageArgs; 405684afc48bSJason M. Bills bmcLogEntry["EntryType"] = "Event"; 405784afc48bSJason M. Bills bmcLogEntry["Severity"] = std::move(severity); 405884afc48bSJason M. Bills bmcLogEntry["Created"] = entryTimeStr; 4059647b3cdcSGeorge Liu if (!std::get<std::vector<uint8_t>>(code.second).empty()) 4060647b3cdcSGeorge Liu { 4061647b3cdcSGeorge Liu bmcLogEntry["AdditionalDataURI"] = 4062647b3cdcSGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 4063647b3cdcSGeorge Liu postcodeEntryID + "/attachment"; 4064647b3cdcSGeorge Liu } 40656f284d24SJiaqing Zhao 40666f284d24SJiaqing Zhao // codeIndex is only specified when querying single entry, return only 40676f284d24SJiaqing Zhao // that entry in this case 40686f284d24SJiaqing Zhao if (codeIndex != 0) 40696f284d24SJiaqing Zhao { 4070ac106bf6SEd Tanous asyncResp->res.jsonValue.update(bmcLogEntry); 40716f284d24SJiaqing Zhao return true; 4072a3316fc6SZhikuiRen } 40736f284d24SJiaqing Zhao 4074ac106bf6SEd Tanous nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 4075b2ba3072SPatrick Williams logEntryArray.emplace_back(std::move(bmcLogEntry)); 40766f284d24SJiaqing Zhao } 40776f284d24SJiaqing Zhao 40786f284d24SJiaqing Zhao // Return value is always false when querying multiple entries 40796f284d24SJiaqing Zhao return false; 4080a3316fc6SZhikuiRen } 4081a3316fc6SZhikuiRen 4082ac106bf6SEd Tanous static void 4083ac106bf6SEd Tanous getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 40846f284d24SJiaqing Zhao const std::string& entryId) 4085a3316fc6SZhikuiRen { 40866f284d24SJiaqing Zhao uint16_t bootIndex = 0; 40876f284d24SJiaqing Zhao uint64_t codeIndex = 0; 40886f284d24SJiaqing Zhao if (!parsePostCode(entryId, codeIndex, bootIndex)) 40896f284d24SJiaqing Zhao { 40906f284d24SJiaqing Zhao // Requested ID was not found 4091ac106bf6SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryId); 40926f284d24SJiaqing Zhao return; 40936f284d24SJiaqing Zhao } 40946f284d24SJiaqing Zhao 40956f284d24SJiaqing Zhao if (bootIndex == 0 || codeIndex == 0) 40966f284d24SJiaqing Zhao { 40976f284d24SJiaqing Zhao // 0 is an invalid index 4098ac106bf6SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryId); 40996f284d24SJiaqing Zhao return; 41006f284d24SJiaqing Zhao } 41016f284d24SJiaqing Zhao 4102a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 4103ac106bf6SEd Tanous [asyncResp, entryId, bootIndex, 41045e7e2dc5SEd Tanous codeIndex](const boost::system::error_code& ec, 41056c9a279eSManojkiran Eda const boost::container::flat_map< 41066c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 41076c9a279eSManojkiran Eda postcode) { 4108a3316fc6SZhikuiRen if (ec) 4109a3316fc6SZhikuiRen { 411062598e31SEd Tanous BMCWEB_LOG_DEBUG("DBUS POST CODE PostCode response error"); 4111ac106bf6SEd Tanous messages::internalError(asyncResp->res); 4112a3316fc6SZhikuiRen return; 4113a3316fc6SZhikuiRen } 4114a3316fc6SZhikuiRen 4115a3316fc6SZhikuiRen if (postcode.empty()) 4116a3316fc6SZhikuiRen { 4117ac106bf6SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryId); 4118a3316fc6SZhikuiRen return; 4119a3316fc6SZhikuiRen } 4120a3316fc6SZhikuiRen 4121ac106bf6SEd Tanous if (!fillPostCodeEntry(asyncResp, postcode, bootIndex, codeIndex)) 41226f284d24SJiaqing Zhao { 4123ac106bf6SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryId); 41246f284d24SJiaqing Zhao return; 41256f284d24SJiaqing Zhao } 4126a3316fc6SZhikuiRen }, 412715124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 412815124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 4129a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 4130a3316fc6SZhikuiRen bootIndex); 4131a3316fc6SZhikuiRen } 4132a3316fc6SZhikuiRen 4133ac106bf6SEd Tanous static void 4134ac106bf6SEd Tanous getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 4135ac106bf6SEd Tanous const uint16_t bootIndex, const uint16_t bootCount, 4136ac106bf6SEd Tanous const uint64_t entryCount, size_t skip, size_t top) 4137a3316fc6SZhikuiRen { 4138a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 4139ac106bf6SEd Tanous [asyncResp, bootIndex, bootCount, entryCount, skip, 41405e7e2dc5SEd Tanous top](const boost::system::error_code& ec, 41416c9a279eSManojkiran Eda const boost::container::flat_map< 41426c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 41436c9a279eSManojkiran Eda postcode) { 4144a3316fc6SZhikuiRen if (ec) 4145a3316fc6SZhikuiRen { 414662598e31SEd Tanous BMCWEB_LOG_DEBUG("DBUS POST CODE PostCode response error"); 4147ac106bf6SEd Tanous messages::internalError(asyncResp->res); 4148a3316fc6SZhikuiRen return; 4149a3316fc6SZhikuiRen } 4150a3316fc6SZhikuiRen 4151a3316fc6SZhikuiRen uint64_t endCount = entryCount; 4152a3316fc6SZhikuiRen if (!postcode.empty()) 4153a3316fc6SZhikuiRen { 4154a3316fc6SZhikuiRen endCount = entryCount + postcode.size(); 41553648c8beSEd Tanous if (skip < endCount && (top + skip) > entryCount) 4156a3316fc6SZhikuiRen { 415789492a15SPatrick Williams uint64_t thisBootSkip = std::max(static_cast<uint64_t>(skip), 415889492a15SPatrick Williams entryCount) - 41593648c8beSEd Tanous entryCount; 4160a3316fc6SZhikuiRen uint64_t thisBootTop = 41613648c8beSEd Tanous std::min(static_cast<uint64_t>(top + skip), endCount) - 41623648c8beSEd Tanous entryCount; 4163a3316fc6SZhikuiRen 4164ac106bf6SEd Tanous fillPostCodeEntry(asyncResp, postcode, bootIndex, 0, 4165ac106bf6SEd Tanous thisBootSkip, thisBootTop); 4166a3316fc6SZhikuiRen } 4167ac106bf6SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = endCount; 4168a3316fc6SZhikuiRen } 4169a3316fc6SZhikuiRen 4170a3316fc6SZhikuiRen // continue to previous bootIndex 4171a3316fc6SZhikuiRen if (bootIndex < bootCount) 4172a3316fc6SZhikuiRen { 4173ac106bf6SEd Tanous getPostCodeForBoot(asyncResp, static_cast<uint16_t>(bootIndex + 1), 4174a3316fc6SZhikuiRen bootCount, endCount, skip, top); 4175a3316fc6SZhikuiRen } 417681584abeSJiaqing Zhao else if (skip + top < endCount) 4177a3316fc6SZhikuiRen { 4178ac106bf6SEd Tanous asyncResp->res.jsonValue["Members@odata.nextLink"] = 41790fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=" + 4180a3316fc6SZhikuiRen std::to_string(skip + top); 4181a3316fc6SZhikuiRen } 4182a3316fc6SZhikuiRen }, 418315124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 418415124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 4185a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 4186a3316fc6SZhikuiRen bootIndex); 4187a3316fc6SZhikuiRen } 4188a3316fc6SZhikuiRen 41898d1b46d7Szhanghch05 static void 4190ac106bf6SEd Tanous getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 41913648c8beSEd Tanous size_t skip, size_t top) 4192a3316fc6SZhikuiRen { 4193a3316fc6SZhikuiRen uint64_t entryCount = 0; 41941e1e598dSJonathan Doman sdbusplus::asio::getProperty<uint16_t>( 41951e1e598dSJonathan Doman *crow::connections::systemBus, 41961e1e598dSJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 41971e1e598dSJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 41981e1e598dSJonathan Doman "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount", 4199ac106bf6SEd Tanous [asyncResp, entryCount, skip, top](const boost::system::error_code& ec, 42001e1e598dSJonathan Doman const uint16_t bootCount) { 4201a3316fc6SZhikuiRen if (ec) 4202a3316fc6SZhikuiRen { 420362598e31SEd Tanous BMCWEB_LOG_DEBUG("DBUS response error {}", ec); 4204ac106bf6SEd Tanous messages::internalError(asyncResp->res); 4205a3316fc6SZhikuiRen return; 4206a3316fc6SZhikuiRen } 4207ac106bf6SEd Tanous getPostCodeForBoot(asyncResp, 1, bootCount, entryCount, skip, top); 42081e1e598dSJonathan Doman }); 4209a3316fc6SZhikuiRen } 4210a3316fc6SZhikuiRen 42117e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntryCollection(App& app) 4212a3316fc6SZhikuiRen { 42137e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 421422d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/") 4215ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 42167e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 421745ca1b86SEd Tanous [&app](const crow::Request& req, 421822d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 421922d268cbSEd Tanous const std::string& systemName) { 4220c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 4221c937d2bfSEd Tanous .canDelegateTop = true, 4222c937d2bfSEd Tanous .canDelegateSkip = true, 4223c937d2bfSEd Tanous }; 4224c937d2bfSEd Tanous query_param::Query delegatedQuery; 4225c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 42263ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 422745ca1b86SEd Tanous { 422845ca1b86SEd Tanous return; 422945ca1b86SEd Tanous } 42307f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 42317f3e84a1SEd Tanous { 42327f3e84a1SEd Tanous // Option currently returns no systems. TBD 42337f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 42347f3e84a1SEd Tanous systemName); 42357f3e84a1SEd Tanous return; 42367f3e84a1SEd Tanous } 423722d268cbSEd Tanous 423822d268cbSEd Tanous if (systemName != "system") 423922d268cbSEd Tanous { 424022d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 424122d268cbSEd Tanous systemName); 424222d268cbSEd Tanous return; 424322d268cbSEd Tanous } 4244a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.type"] = 4245a3316fc6SZhikuiRen "#LogEntryCollection.LogEntryCollection"; 4246a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 4247a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 4248a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 4249a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 4250a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 4251a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 4252a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 42533648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 42545143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 42553648c8beSEd Tanous getCurrentBootNumber(asyncResp, skip, top); 42567e860f15SJohn Edward Broadbent }); 4257a3316fc6SZhikuiRen } 4258a3316fc6SZhikuiRen 4259647b3cdcSGeorge Liu inline void requestRoutesPostCodesEntryAdditionalData(App& app) 4260647b3cdcSGeorge Liu { 42610fda0f12SGeorge Liu BMCWEB_ROUTE( 42620fda0f12SGeorge Liu app, 426322d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/attachment/") 4264647b3cdcSGeorge Liu .privileges(redfish::privileges::getLogEntry) 4265647b3cdcSGeorge Liu .methods(boost::beast::http::verb::get)( 426645ca1b86SEd Tanous [&app](const crow::Request& req, 4267647b3cdcSGeorge Liu const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 426822d268cbSEd Tanous const std::string& systemName, 4269647b3cdcSGeorge Liu const std::string& postCodeID) { 42703ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 427145ca1b86SEd Tanous { 427245ca1b86SEd Tanous return; 427345ca1b86SEd Tanous } 427472e21377SMatt Spinler if (!http_helpers::isContentTypeAllowed( 427599351cd8SEd Tanous req.getHeaderValue("Accept"), 42764a0e1a0cSEd Tanous http_helpers::ContentType::OctetStream, true)) 4277647b3cdcSGeorge Liu { 4278002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::bad_request); 4279647b3cdcSGeorge Liu return; 4280647b3cdcSGeorge Liu } 42817f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 42827f3e84a1SEd Tanous { 42837f3e84a1SEd Tanous // Option currently returns no systems. TBD 42847f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 42857f3e84a1SEd Tanous systemName); 42867f3e84a1SEd Tanous return; 42877f3e84a1SEd Tanous } 428822d268cbSEd Tanous if (systemName != "system") 428922d268cbSEd Tanous { 429022d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 429122d268cbSEd Tanous systemName); 429222d268cbSEd Tanous return; 429322d268cbSEd Tanous } 4294647b3cdcSGeorge Liu 4295647b3cdcSGeorge Liu uint64_t currentValue = 0; 4296647b3cdcSGeorge Liu uint16_t index = 0; 4297647b3cdcSGeorge Liu if (!parsePostCode(postCodeID, currentValue, index)) 4298647b3cdcSGeorge Liu { 4299002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", postCodeID); 4300647b3cdcSGeorge Liu return; 4301647b3cdcSGeorge Liu } 4302647b3cdcSGeorge Liu 4303647b3cdcSGeorge Liu crow::connections::systemBus->async_method_call( 4304647b3cdcSGeorge Liu [asyncResp, postCodeID, currentValue]( 43055e7e2dc5SEd Tanous const boost::system::error_code& ec, 4306002d39b4SEd Tanous const std::vector<std::tuple<uint64_t, std::vector<uint8_t>>>& 4307002d39b4SEd Tanous postcodes) { 4308647b3cdcSGeorge Liu if (ec.value() == EBADR) 4309647b3cdcSGeorge Liu { 4310002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 4311002d39b4SEd Tanous postCodeID); 4312647b3cdcSGeorge Liu return; 4313647b3cdcSGeorge Liu } 4314647b3cdcSGeorge Liu if (ec) 4315647b3cdcSGeorge Liu { 431662598e31SEd Tanous BMCWEB_LOG_DEBUG("DBUS response error {}", ec); 4317647b3cdcSGeorge Liu messages::internalError(asyncResp->res); 4318647b3cdcSGeorge Liu return; 4319647b3cdcSGeorge Liu } 4320647b3cdcSGeorge Liu 4321647b3cdcSGeorge Liu size_t value = static_cast<size_t>(currentValue) - 1; 4322002d39b4SEd Tanous if (value == std::string::npos || postcodes.size() < currentValue) 4323647b3cdcSGeorge Liu { 432462598e31SEd Tanous BMCWEB_LOG_WARNING("Wrong currentValue value"); 4325002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 4326002d39b4SEd Tanous postCodeID); 4327647b3cdcSGeorge Liu return; 4328647b3cdcSGeorge Liu } 4329647b3cdcSGeorge Liu 43309eb808c1SEd Tanous const auto& [tID, c] = postcodes[value]; 433146ff87baSEd Tanous if (c.empty()) 4332647b3cdcSGeorge Liu { 433362598e31SEd Tanous BMCWEB_LOG_WARNING("No found post code data"); 4334002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 4335002d39b4SEd Tanous postCodeID); 4336647b3cdcSGeorge Liu return; 4337647b3cdcSGeorge Liu } 433846ff87baSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) 433946ff87baSEd Tanous const char* d = reinterpret_cast<const char*>(c.data()); 434046ff87baSEd Tanous std::string_view strData(d, c.size()); 4341647b3cdcSGeorge Liu 4342d9f6c621SEd Tanous asyncResp->res.addHeader(boost::beast::http::field::content_type, 4343647b3cdcSGeorge Liu "application/octet-stream"); 4344d9f6c621SEd Tanous asyncResp->res.addHeader( 4345d9f6c621SEd Tanous boost::beast::http::field::content_transfer_encoding, "Base64"); 434627b0cf90SEd Tanous asyncResp->res.write(crow::utility::base64encode(strData)); 4347647b3cdcSGeorge Liu }, 4348647b3cdcSGeorge Liu "xyz.openbmc_project.State.Boot.PostCode0", 4349647b3cdcSGeorge Liu "/xyz/openbmc_project/State/Boot/PostCode0", 4350002d39b4SEd Tanous "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", index); 4351647b3cdcSGeorge Liu }); 4352647b3cdcSGeorge Liu } 4353647b3cdcSGeorge Liu 43547e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntry(App& app) 4355a3316fc6SZhikuiRen { 43567e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 435722d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/") 4358ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 43597e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 436045ca1b86SEd Tanous [&app](const crow::Request& req, 43617e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 436222d268cbSEd Tanous const std::string& systemName, const std::string& targetID) { 43633ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 436445ca1b86SEd Tanous { 436545ca1b86SEd Tanous return; 436645ca1b86SEd Tanous } 43677f3e84a1SEd Tanous if constexpr (bmcwebEnableMultiHost) 43687f3e84a1SEd Tanous { 43697f3e84a1SEd Tanous // Option currently returns no systems. TBD 43707f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 43717f3e84a1SEd Tanous systemName); 43727f3e84a1SEd Tanous return; 43737f3e84a1SEd Tanous } 437422d268cbSEd Tanous if (systemName != "system") 437522d268cbSEd Tanous { 437622d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 437722d268cbSEd Tanous systemName); 437822d268cbSEd Tanous return; 437922d268cbSEd Tanous } 438022d268cbSEd Tanous 43816f284d24SJiaqing Zhao getPostCodeForEntry(asyncResp, targetID); 43827e860f15SJohn Edward Broadbent }); 4383a3316fc6SZhikuiRen } 4384a3316fc6SZhikuiRen 43851da66f75SEd Tanous } // namespace redfish 4386