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" 315b90429aSEd Tanous #include "task_messages.hpp" 323ccb3adbSEd Tanous #include "utils/dbus_utils.hpp" 335b90429aSEd Tanous #include "utils/json_utils.hpp" 343ccb3adbSEd Tanous #include "utils/time_utils.hpp" 351da66f75SEd Tanous 3675e8e218SMyung Bae #include <systemd/sd-id128.h> 37e1f26343SJason M. Bills #include <systemd/sd-journal.h> 388e31778eSAsmitha Karunanithi #include <tinyxml2.h> 39400fd1fbSAdriana Kobylak #include <unistd.h> 40e1f26343SJason M. Bills 4107c8c20dSEd Tanous #include <boost/beast/http/verb.hpp> 421da66f75SEd Tanous #include <boost/container/flat_map.hpp> 431ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp> 44ef4c65b7SEd Tanous #include <boost/url/format.hpp> 45d1bde9e5SKrzysztof Grobelny #include <sdbusplus/asio/property.hpp> 46d1bde9e5SKrzysztof Grobelny #include <sdbusplus/unpack_properties.hpp> 471214b7e7SGunnar Mills 487a1dbc48SGeorge Liu #include <array> 49647b3cdcSGeorge Liu #include <charconv> 50b5f288d2SAbhilash Raju #include <cstddef> 514418c7f0SJames Feist #include <filesystem> 5218f8f608SEd Tanous #include <iterator> 5375710de2SXiaochao Ma #include <optional> 543544d2a7SEd Tanous #include <ranges> 5526702d01SEd Tanous #include <span> 5618f8f608SEd Tanous #include <string> 57cd225da8SJason M. Bills #include <string_view> 58abf2add6SEd Tanous #include <variant> 591da66f75SEd Tanous 601da66f75SEd Tanous namespace redfish 611da66f75SEd Tanous { 621da66f75SEd Tanous 6389492a15SPatrick Williams constexpr const char* crashdumpObject = "com.intel.crashdump"; 6489492a15SPatrick Williams constexpr const char* crashdumpPath = "/com/intel/crashdump"; 6589492a15SPatrick Williams constexpr const char* crashdumpInterface = "com.intel.crashdump"; 6689492a15SPatrick Williams constexpr const char* deleteAllInterface = 675b61b5e8SJason M. Bills "xyz.openbmc_project.Collection.DeleteAll"; 6889492a15SPatrick Williams constexpr const char* crashdumpOnDemandInterface = 69424c4176SJason M. Bills "com.intel.crashdump.OnDemand"; 7089492a15SPatrick Williams constexpr const char* crashdumpTelemetryInterface = 716eda7685SKenny L. Ku "com.intel.crashdump.Telemetry"; 721da66f75SEd Tanous 738e31778eSAsmitha Karunanithi enum class DumpCreationProgress 748e31778eSAsmitha Karunanithi { 758e31778eSAsmitha Karunanithi DUMP_CREATE_SUCCESS, 768e31778eSAsmitha Karunanithi DUMP_CREATE_FAILED, 778e31778eSAsmitha Karunanithi DUMP_CREATE_INPROGRESS 788e31778eSAsmitha Karunanithi }; 798e31778eSAsmitha Karunanithi 80f6150403SJames Feist namespace fs = std::filesystem; 811da66f75SEd Tanous 82cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s) 83cb92c03bSAndrew Geissler { 84d4d25793SEd Tanous if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") || 85d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") || 86d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") || 87d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Error")) 88cb92c03bSAndrew Geissler { 89cb92c03bSAndrew Geissler return "Critical"; 90cb92c03bSAndrew Geissler } 913174e4dfSEd Tanous if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") || 92d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") || 93d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Notice")) 94cb92c03bSAndrew Geissler { 95cb92c03bSAndrew Geissler return "OK"; 96cb92c03bSAndrew Geissler } 973174e4dfSEd Tanous if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning") 98cb92c03bSAndrew Geissler { 99cb92c03bSAndrew Geissler return "Warning"; 100cb92c03bSAndrew Geissler } 101cb92c03bSAndrew Geissler return ""; 102cb92c03bSAndrew Geissler } 103cb92c03bSAndrew Geissler 1049017faf2SAbhishek Patel inline std::optional<bool> getProviderNotifyAction(const std::string& notify) 1059017faf2SAbhishek Patel { 1069017faf2SAbhishek Patel std::optional<bool> notifyAction; 1079017faf2SAbhishek Patel if (notify == "xyz.openbmc_project.Logging.Entry.Notify.Notify") 1089017faf2SAbhishek Patel { 1099017faf2SAbhishek Patel notifyAction = true; 1109017faf2SAbhishek Patel } 1119017faf2SAbhishek Patel else if (notify == "xyz.openbmc_project.Logging.Entry.Notify.Inhibit") 1129017faf2SAbhishek Patel { 1139017faf2SAbhishek Patel notifyAction = false; 1149017faf2SAbhishek Patel } 1159017faf2SAbhishek Patel 1169017faf2SAbhishek Patel return notifyAction; 1179017faf2SAbhishek Patel } 1189017faf2SAbhishek Patel 11918f8f608SEd Tanous inline std::string getDumpPath(std::string_view dumpType) 12018f8f608SEd Tanous { 12118f8f608SEd Tanous std::string dbusDumpPath = "/xyz/openbmc_project/dump/"; 12218f8f608SEd Tanous std::ranges::transform(dumpType, std::back_inserter(dbusDumpPath), 12318f8f608SEd Tanous bmcweb::asciiToLower); 12418f8f608SEd Tanous 12518f8f608SEd Tanous return dbusDumpPath; 12618f8f608SEd Tanous } 12718f8f608SEd Tanous 128df254f2cSEd Tanous inline int getJournalMetadata(sd_journal* journal, std::string_view field, 12939e77504SEd Tanous std::string_view& contents) 13016428a1aSJason M. Bills { 13116428a1aSJason M. Bills const char* data = nullptr; 13216428a1aSJason M. Bills size_t length = 0; 13316428a1aSJason M. Bills int ret = 0; 13416428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 13546ff87baSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) 13646ff87baSEd Tanous const void** dataVoid = reinterpret_cast<const void**>(&data); 13746ff87baSEd Tanous 13846ff87baSEd Tanous ret = sd_journal_get_data(journal, field.data(), dataVoid, &length); 13916428a1aSJason M. Bills if (ret < 0) 14016428a1aSJason M. Bills { 14116428a1aSJason M. Bills return ret; 14216428a1aSJason M. Bills } 14339e77504SEd Tanous contents = std::string_view(data, length); 14416428a1aSJason M. Bills // Only use the content after the "=" character. 14581ce609eSEd Tanous contents.remove_prefix(std::min(contents.find('=') + 1, contents.size())); 14616428a1aSJason M. Bills return ret; 14716428a1aSJason M. Bills } 14816428a1aSJason M. Bills 149df254f2cSEd Tanous inline int getJournalMetadata(sd_journal* journal, std::string_view field, 150df254f2cSEd Tanous const int& base, 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 164df254f2cSEd Tanous inline bool getEntryTimestamp(sd_journal* journal, std::string& entryTimestamp) 165a3316fc6SZhikuiRen { 166a3316fc6SZhikuiRen int ret = 0; 167a3316fc6SZhikuiRen uint64_t timestamp = 0; 168a3316fc6SZhikuiRen ret = sd_journal_get_realtime_usec(journal, ×tamp); 169a3316fc6SZhikuiRen if (ret < 0) 170a3316fc6SZhikuiRen { 17162598e31SEd Tanous BMCWEB_LOG_ERROR("Failed to read entry timestamp: {}", strerror(-ret)); 172a3316fc6SZhikuiRen return false; 173a3316fc6SZhikuiRen } 174e645c5e6SKonstantin Aladyshev entryTimestamp = redfish::time_utils::getDateTimeUintUs(timestamp); 1759c620e21SAsmitha Karunanithi return true; 176a3316fc6SZhikuiRen } 17750b8a43aSEd Tanous 178df254f2cSEd Tanous inline bool getUniqueEntryID(sd_journal* journal, std::string& entryID, 179e85d6b16SJason M. Bills const bool firstEntry = true) 18016428a1aSJason M. Bills { 18116428a1aSJason M. Bills int ret = 0; 18275e8e218SMyung Bae static sd_id128_t prevBootID{}; 18316428a1aSJason M. Bills static uint64_t prevTs = 0; 18416428a1aSJason M. Bills static int index = 0; 185e85d6b16SJason M. Bills if (firstEntry) 186e85d6b16SJason M. Bills { 18775e8e218SMyung Bae prevBootID = {}; 188e85d6b16SJason M. Bills prevTs = 0; 189e85d6b16SJason M. Bills } 190e85d6b16SJason M. Bills 19116428a1aSJason M. Bills // Get the entry timestamp 19216428a1aSJason M. Bills uint64_t curTs = 0; 19375e8e218SMyung Bae sd_id128_t curBootID{}; 19475e8e218SMyung Bae ret = sd_journal_get_monotonic_usec(journal, &curTs, &curBootID); 19516428a1aSJason M. Bills if (ret < 0) 19616428a1aSJason M. Bills { 19762598e31SEd Tanous BMCWEB_LOG_ERROR("Failed to read entry timestamp: {}", strerror(-ret)); 19816428a1aSJason M. Bills return false; 19916428a1aSJason M. Bills } 20075e8e218SMyung Bae // If the timestamp isn't unique on the same boot, increment the index 20175e8e218SMyung Bae bool sameBootIDs = sd_id128_equal(curBootID, prevBootID) != 0; 20275e8e218SMyung Bae if (sameBootIDs && (curTs == prevTs)) 20316428a1aSJason M. Bills { 20416428a1aSJason M. Bills index++; 20516428a1aSJason M. Bills } 20616428a1aSJason M. Bills else 20716428a1aSJason M. Bills { 20816428a1aSJason M. Bills // Otherwise, reset it 20916428a1aSJason M. Bills index = 0; 21016428a1aSJason M. Bills } 21175e8e218SMyung Bae 21275e8e218SMyung Bae if (!sameBootIDs) 21375e8e218SMyung Bae { 21475e8e218SMyung Bae // Save the bootID 21575e8e218SMyung Bae prevBootID = curBootID; 21675e8e218SMyung Bae } 21716428a1aSJason M. Bills // Save the timestamp 21816428a1aSJason M. Bills prevTs = curTs; 21916428a1aSJason M. Bills 22075e8e218SMyung Bae // make entryID as <bootID>_<timestamp>[_<index>] 22175e8e218SMyung Bae std::array<char, SD_ID128_STRING_MAX> bootIDStr{}; 22275e8e218SMyung Bae sd_id128_to_string(curBootID, bootIDStr.data()); 22375e8e218SMyung Bae entryID = std::format("{}_{}", bootIDStr.data(), curTs); 22416428a1aSJason M. Bills if (index > 0) 22516428a1aSJason M. Bills { 22616428a1aSJason M. Bills entryID += "_" + std::to_string(index); 22716428a1aSJason M. Bills } 22816428a1aSJason M. Bills return true; 22916428a1aSJason M. Bills } 23016428a1aSJason M. Bills 231e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID, 232e85d6b16SJason M. Bills const bool firstEntry = true) 23395820184SJason M. Bills { 234271584abSEd Tanous static time_t prevTs = 0; 23595820184SJason M. Bills static int index = 0; 236e85d6b16SJason M. Bills if (firstEntry) 237e85d6b16SJason M. Bills { 238e85d6b16SJason M. Bills prevTs = 0; 239e85d6b16SJason M. Bills } 240e85d6b16SJason M. Bills 24195820184SJason M. Bills // Get the entry timestamp 242271584abSEd Tanous std::time_t curTs = 0; 24395820184SJason M. Bills std::tm timeStruct = {}; 24495820184SJason M. Bills std::istringstream entryStream(logEntry); 24595820184SJason M. Bills if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 24695820184SJason M. Bills { 24795820184SJason M. Bills curTs = std::mktime(&timeStruct); 24895820184SJason M. Bills } 24995820184SJason M. Bills // If the timestamp isn't unique, increment the index 25095820184SJason M. Bills if (curTs == prevTs) 25195820184SJason M. Bills { 25295820184SJason M. Bills index++; 25395820184SJason M. Bills } 25495820184SJason M. Bills else 25595820184SJason M. Bills { 25695820184SJason M. Bills // Otherwise, reset it 25795820184SJason M. Bills index = 0; 25895820184SJason M. Bills } 25995820184SJason M. Bills // Save the timestamp 26095820184SJason M. Bills prevTs = curTs; 26195820184SJason M. Bills 26295820184SJason M. Bills entryID = std::to_string(curTs); 26395820184SJason M. Bills if (index > 0) 26495820184SJason M. Bills { 26595820184SJason M. Bills entryID += "_" + std::to_string(index); 26695820184SJason M. Bills } 26795820184SJason M. Bills return true; 26895820184SJason M. Bills } 26995820184SJason M. Bills 27075e8e218SMyung Bae // Entry is formed like "BootID_timestamp" or "BootID_timestamp_index" 271df254f2cSEd Tanous inline bool 2728d1b46d7Szhanghch05 getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 273099984c1SEd Tanous std::string_view entryIDStrView, sd_id128_t& bootID, 27475e8e218SMyung Bae uint64_t& timestamp, uint64_t& index) 27516428a1aSJason M. Bills { 27675e8e218SMyung Bae // Convert the unique ID back to a bootID + timestamp to find the entry 27775e8e218SMyung Bae auto underscore1Pos = entryIDStrView.find('_'); 27875e8e218SMyung Bae if (underscore1Pos == std::string_view::npos) 27975e8e218SMyung Bae { 28075e8e218SMyung Bae // EntryID has no bootID or timestamp 281099984c1SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryIDStrView); 28275e8e218SMyung Bae return false; 28375e8e218SMyung Bae } 28475e8e218SMyung Bae 28575e8e218SMyung Bae // EntryID has bootID + timestamp 28675e8e218SMyung Bae 28775e8e218SMyung Bae // Convert entryIDViewString to BootID 28875e8e218SMyung Bae // NOTE: bootID string which needs to be null-terminated for 28975e8e218SMyung Bae // sd_id128_from_string() 290099984c1SEd Tanous std::string bootIDStr(entryIDStrView.substr(0, underscore1Pos)); 29175e8e218SMyung Bae if (sd_id128_from_string(bootIDStr.c_str(), &bootID) < 0) 29275e8e218SMyung Bae { 293099984c1SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryIDStrView); 29475e8e218SMyung Bae return false; 29575e8e218SMyung Bae } 29675e8e218SMyung Bae 29775e8e218SMyung Bae // Get the timestamp from entryID 298099984c1SEd Tanous entryIDStrView.remove_prefix(underscore1Pos + 1); 29975e8e218SMyung Bae 300099984c1SEd Tanous auto [timestampEnd, tstampEc] = std::from_chars( 301099984c1SEd Tanous entryIDStrView.begin(), entryIDStrView.end(), timestamp); 302099984c1SEd Tanous if (tstampEc != std::errc()) 30316428a1aSJason M. Bills { 304099984c1SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryIDStrView); 30516428a1aSJason M. Bills return false; 30616428a1aSJason M. Bills } 307099984c1SEd Tanous entryIDStrView = std::string_view( 308099984c1SEd Tanous timestampEnd, 309099984c1SEd Tanous static_cast<size_t>(std::distance(timestampEnd, entryIDStrView.end()))); 310099984c1SEd Tanous if (entryIDStrView.empty()) 31116428a1aSJason M. Bills { 312099984c1SEd Tanous index = 0U; 313099984c1SEd Tanous return true; 314099984c1SEd Tanous } 315099984c1SEd Tanous // Timestamp might include optional index, if two events happened at the 316099984c1SEd Tanous // same "time". 317099984c1SEd Tanous if (entryIDStrView[0] != '_') 318099984c1SEd Tanous { 319099984c1SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryIDStrView); 320099984c1SEd Tanous return false; 321099984c1SEd Tanous } 322099984c1SEd Tanous entryIDStrView.remove_prefix(1); 323099984c1SEd Tanous auto [ptr, indexEc] = std::from_chars(entryIDStrView.begin(), 324099984c1SEd Tanous entryIDStrView.end(), index); 325099984c1SEd Tanous if (indexEc != std::errc() || ptr != entryIDStrView.end()) 326099984c1SEd Tanous { 327099984c1SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryIDStrView); 32816428a1aSJason M. Bills return false; 32916428a1aSJason M. Bills } 33016428a1aSJason M. Bills return true; 33116428a1aSJason M. Bills } 33216428a1aSJason M. Bills 33395820184SJason M. Bills static bool 33495820184SJason M. Bills getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles) 33595820184SJason M. Bills { 33695820184SJason M. Bills static const std::filesystem::path redfishLogDir = "/var/log"; 33795820184SJason M. Bills static const std::string redfishLogFilename = "redfish"; 33895820184SJason M. Bills 33995820184SJason M. Bills // Loop through the directory looking for redfish log files 34095820184SJason M. Bills for (const std::filesystem::directory_entry& dirEnt : 34195820184SJason M. Bills std::filesystem::directory_iterator(redfishLogDir)) 34295820184SJason M. Bills { 34395820184SJason M. Bills // If we find a redfish log file, save the path 34495820184SJason M. Bills std::string filename = dirEnt.path().filename(); 34511ba3979SEd Tanous if (filename.starts_with(redfishLogFilename)) 34695820184SJason M. Bills { 34795820184SJason M. Bills redfishLogFiles.emplace_back(redfishLogDir / filename); 34895820184SJason M. Bills } 34995820184SJason M. Bills } 35095820184SJason M. Bills // As the log files rotate, they are appended with a ".#" that is higher for 35195820184SJason M. Bills // the older logs. Since we don't expect more than 10 log files, we 35295820184SJason M. Bills // can just sort the list to get them in order from newest to oldest 3533544d2a7SEd Tanous std::ranges::sort(redfishLogFiles); 35495820184SJason M. Bills 35595820184SJason M. Bills return !redfishLogFiles.empty(); 35695820184SJason M. Bills } 35795820184SJason M. Bills 35868dd075aSAsmitha Karunanithi inline log_entry::OriginatorTypes 35968dd075aSAsmitha Karunanithi mapDbusOriginatorTypeToRedfish(const std::string& originatorType) 36068dd075aSAsmitha Karunanithi { 36168dd075aSAsmitha Karunanithi if (originatorType == 36268dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client") 36368dd075aSAsmitha Karunanithi { 36468dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::Client; 36568dd075aSAsmitha Karunanithi } 36668dd075aSAsmitha Karunanithi if (originatorType == 36768dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Internal") 36868dd075aSAsmitha Karunanithi { 36968dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::Internal; 37068dd075aSAsmitha Karunanithi } 37168dd075aSAsmitha Karunanithi if (originatorType == 37268dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.SupportingService") 37368dd075aSAsmitha Karunanithi { 37468dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::SupportingService; 37568dd075aSAsmitha Karunanithi } 37668dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::Invalid; 37768dd075aSAsmitha Karunanithi } 37868dd075aSAsmitha Karunanithi 379aefe3786SClaire Weinan inline void parseDumpEntryFromDbusObject( 3802d613eb6SJiaqing Zhao const dbus::utility::ManagedObjectType::value_type& object, 381c6fecdabSClaire Weinan std::string& dumpStatus, uint64_t& size, uint64_t& timestampUs, 38268dd075aSAsmitha Karunanithi std::string& originatorId, log_entry::OriginatorTypes& originatorType, 383aefe3786SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 384aefe3786SClaire Weinan { 385aefe3786SClaire Weinan for (const auto& interfaceMap : object.second) 386aefe3786SClaire Weinan { 387aefe3786SClaire Weinan if (interfaceMap.first == "xyz.openbmc_project.Common.Progress") 388aefe3786SClaire Weinan { 389aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 390aefe3786SClaire Weinan { 391aefe3786SClaire Weinan if (propertyMap.first == "Status") 392aefe3786SClaire Weinan { 393aefe3786SClaire Weinan const auto* status = 394aefe3786SClaire Weinan std::get_if<std::string>(&propertyMap.second); 395aefe3786SClaire Weinan if (status == nullptr) 396aefe3786SClaire Weinan { 397aefe3786SClaire Weinan messages::internalError(asyncResp->res); 398aefe3786SClaire Weinan break; 399aefe3786SClaire Weinan } 400aefe3786SClaire Weinan dumpStatus = *status; 401aefe3786SClaire Weinan } 402aefe3786SClaire Weinan } 403aefe3786SClaire Weinan } 404aefe3786SClaire Weinan else if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") 405aefe3786SClaire Weinan { 406aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 407aefe3786SClaire Weinan { 408aefe3786SClaire Weinan if (propertyMap.first == "Size") 409aefe3786SClaire Weinan { 410aefe3786SClaire Weinan const auto* sizePtr = 411aefe3786SClaire Weinan std::get_if<uint64_t>(&propertyMap.second); 412aefe3786SClaire Weinan if (sizePtr == nullptr) 413aefe3786SClaire Weinan { 414aefe3786SClaire Weinan messages::internalError(asyncResp->res); 415aefe3786SClaire Weinan break; 416aefe3786SClaire Weinan } 417aefe3786SClaire Weinan size = *sizePtr; 418aefe3786SClaire Weinan break; 419aefe3786SClaire Weinan } 420aefe3786SClaire Weinan } 421aefe3786SClaire Weinan } 422aefe3786SClaire Weinan else if (interfaceMap.first == "xyz.openbmc_project.Time.EpochTime") 423aefe3786SClaire Weinan { 424aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 425aefe3786SClaire Weinan { 426aefe3786SClaire Weinan if (propertyMap.first == "Elapsed") 427aefe3786SClaire Weinan { 428aefe3786SClaire Weinan const uint64_t* usecsTimeStamp = 429aefe3786SClaire Weinan std::get_if<uint64_t>(&propertyMap.second); 430aefe3786SClaire Weinan if (usecsTimeStamp == nullptr) 431aefe3786SClaire Weinan { 432aefe3786SClaire Weinan messages::internalError(asyncResp->res); 433aefe3786SClaire Weinan break; 434aefe3786SClaire Weinan } 435c6fecdabSClaire Weinan timestampUs = *usecsTimeStamp; 436aefe3786SClaire Weinan break; 437aefe3786SClaire Weinan } 438aefe3786SClaire Weinan } 439aefe3786SClaire Weinan } 44068dd075aSAsmitha Karunanithi else if (interfaceMap.first == 44168dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy") 44268dd075aSAsmitha Karunanithi { 44368dd075aSAsmitha Karunanithi for (const auto& propertyMap : interfaceMap.second) 44468dd075aSAsmitha Karunanithi { 44568dd075aSAsmitha Karunanithi if (propertyMap.first == "OriginatorId") 44668dd075aSAsmitha Karunanithi { 44768dd075aSAsmitha Karunanithi const std::string* id = 44868dd075aSAsmitha Karunanithi std::get_if<std::string>(&propertyMap.second); 44968dd075aSAsmitha Karunanithi if (id == nullptr) 45068dd075aSAsmitha Karunanithi { 45168dd075aSAsmitha Karunanithi messages::internalError(asyncResp->res); 45268dd075aSAsmitha Karunanithi break; 45368dd075aSAsmitha Karunanithi } 45468dd075aSAsmitha Karunanithi originatorId = *id; 45568dd075aSAsmitha Karunanithi } 45668dd075aSAsmitha Karunanithi 45768dd075aSAsmitha Karunanithi if (propertyMap.first == "OriginatorType") 45868dd075aSAsmitha Karunanithi { 45968dd075aSAsmitha Karunanithi const std::string* type = 46068dd075aSAsmitha Karunanithi std::get_if<std::string>(&propertyMap.second); 46168dd075aSAsmitha Karunanithi if (type == nullptr) 46268dd075aSAsmitha Karunanithi { 46368dd075aSAsmitha Karunanithi messages::internalError(asyncResp->res); 46468dd075aSAsmitha Karunanithi break; 46568dd075aSAsmitha Karunanithi } 46668dd075aSAsmitha Karunanithi 46768dd075aSAsmitha Karunanithi originatorType = mapDbusOriginatorTypeToRedfish(*type); 46868dd075aSAsmitha Karunanithi if (originatorType == log_entry::OriginatorTypes::Invalid) 46968dd075aSAsmitha Karunanithi { 47068dd075aSAsmitha Karunanithi messages::internalError(asyncResp->res); 47168dd075aSAsmitha Karunanithi break; 47268dd075aSAsmitha Karunanithi } 47368dd075aSAsmitha Karunanithi } 47468dd075aSAsmitha Karunanithi } 47568dd075aSAsmitha Karunanithi } 476aefe3786SClaire Weinan } 477aefe3786SClaire Weinan } 478aefe3786SClaire Weinan 47921ab404cSNan Zhou static std::string getDumpEntriesPath(const std::string& dumpType) 480fdd26906SClaire Weinan { 481fdd26906SClaire Weinan std::string entriesPath; 482fdd26906SClaire Weinan 483fdd26906SClaire Weinan if (dumpType == "BMC") 484fdd26906SClaire Weinan { 485fdd26906SClaire Weinan entriesPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 486fdd26906SClaire Weinan } 487fdd26906SClaire Weinan else if (dumpType == "FaultLog") 488fdd26906SClaire Weinan { 489fdd26906SClaire Weinan entriesPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/"; 490fdd26906SClaire Weinan } 491fdd26906SClaire Weinan else if (dumpType == "System") 492fdd26906SClaire Weinan { 493fdd26906SClaire Weinan entriesPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 494fdd26906SClaire Weinan } 495fdd26906SClaire Weinan else 496fdd26906SClaire Weinan { 49762598e31SEd Tanous BMCWEB_LOG_ERROR("getDumpEntriesPath() invalid dump type: {}", 49862598e31SEd Tanous dumpType); 499fdd26906SClaire Weinan } 500fdd26906SClaire Weinan 501fdd26906SClaire Weinan // Returns empty string on error 502fdd26906SClaire Weinan return entriesPath; 503fdd26906SClaire Weinan } 504fdd26906SClaire Weinan 5058d1b46d7Szhanghch05 inline void 5068d1b46d7Szhanghch05 getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 5075cb1dd27SAsmitha Karunanithi const std::string& dumpType) 5085cb1dd27SAsmitha Karunanithi { 509fdd26906SClaire Weinan std::string entriesPath = getDumpEntriesPath(dumpType); 510fdd26906SClaire Weinan if (entriesPath.empty()) 5115cb1dd27SAsmitha Karunanithi { 5125cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5135cb1dd27SAsmitha Karunanithi return; 5145cb1dd27SAsmitha Karunanithi } 5155cb1dd27SAsmitha Karunanithi 5165eb468daSGeorge Liu sdbusplus::message::object_path path("/xyz/openbmc_project/dump"); 5175eb468daSGeorge Liu dbus::utility::getManagedObjects( 5185eb468daSGeorge Liu "xyz.openbmc_project.Dump.Manager", path, 519fdd26906SClaire Weinan [asyncResp, entriesPath, 5205e7e2dc5SEd Tanous dumpType](const boost::system::error_code& ec, 5215eb468daSGeorge Liu const dbus::utility::ManagedObjectType& objects) { 5225cb1dd27SAsmitha Karunanithi if (ec) 5235cb1dd27SAsmitha Karunanithi { 52462598e31SEd Tanous BMCWEB_LOG_ERROR("DumpEntry resp_handler got error {}", ec); 5255cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5265cb1dd27SAsmitha Karunanithi return; 5275cb1dd27SAsmitha Karunanithi } 5285cb1dd27SAsmitha Karunanithi 529fdd26906SClaire Weinan // Remove ending slash 530fdd26906SClaire Weinan std::string odataIdStr = entriesPath; 531fdd26906SClaire Weinan if (!odataIdStr.empty()) 532fdd26906SClaire Weinan { 533fdd26906SClaire Weinan odataIdStr.pop_back(); 534fdd26906SClaire Weinan } 535fdd26906SClaire Weinan 536fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.type"] = 537fdd26906SClaire Weinan "#LogEntryCollection.LogEntryCollection"; 538fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = std::move(odataIdStr); 539fdd26906SClaire Weinan asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entries"; 54089492a15SPatrick Williams asyncResp->res.jsonValue["Description"] = "Collection of " + dumpType + 54189492a15SPatrick Williams " Dump Entries"; 542fdd26906SClaire Weinan 5433544d2a7SEd Tanous nlohmann::json::array_t entriesArray; 54418f8f608SEd Tanous std::string dumpEntryPath = getDumpPath(dumpType) + "/entry/"; 5455cb1dd27SAsmitha Karunanithi 5465eb468daSGeorge Liu dbus::utility::ManagedObjectType resp(objects); 5473544d2a7SEd Tanous std::ranges::sort(resp, [](const auto& l, const auto& r) { 548002d39b4SEd Tanous return AlphanumLess<std::string>()(l.first.filename(), 549002d39b4SEd Tanous r.first.filename()); 550565dfb6fSClaire Weinan }); 551565dfb6fSClaire Weinan 5525cb1dd27SAsmitha Karunanithi for (auto& object : resp) 5535cb1dd27SAsmitha Karunanithi { 554b47452b2SAsmitha Karunanithi if (object.first.str.find(dumpEntryPath) == std::string::npos) 5555cb1dd27SAsmitha Karunanithi { 5565cb1dd27SAsmitha Karunanithi continue; 5575cb1dd27SAsmitha Karunanithi } 558c6fecdabSClaire Weinan uint64_t timestampUs = 0; 5595cb1dd27SAsmitha Karunanithi uint64_t size = 0; 56035440d18SAsmitha Karunanithi std::string dumpStatus; 56168dd075aSAsmitha Karunanithi std::string originatorId; 56268dd075aSAsmitha Karunanithi log_entry::OriginatorTypes originatorType = 56368dd075aSAsmitha Karunanithi log_entry::OriginatorTypes::Internal; 564433b68b4SJason M. Bills nlohmann::json::object_t thisEntry; 5652dfd18efSEd Tanous 5662dfd18efSEd Tanous std::string entryID = object.first.filename(); 5672dfd18efSEd Tanous if (entryID.empty()) 5685cb1dd27SAsmitha Karunanithi { 5695cb1dd27SAsmitha Karunanithi continue; 5705cb1dd27SAsmitha Karunanithi } 5715cb1dd27SAsmitha Karunanithi 572c6fecdabSClaire Weinan parseDumpEntryFromDbusObject(object, dumpStatus, size, timestampUs, 57368dd075aSAsmitha Karunanithi originatorId, originatorType, 574aefe3786SClaire Weinan asyncResp); 5755cb1dd27SAsmitha Karunanithi 5760fda0f12SGeorge Liu if (dumpStatus != 5770fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 57835440d18SAsmitha Karunanithi !dumpStatus.empty()) 57935440d18SAsmitha Karunanithi { 58035440d18SAsmitha Karunanithi // Dump status is not Complete, no need to enumerate 58135440d18SAsmitha Karunanithi continue; 58235440d18SAsmitha Karunanithi } 58335440d18SAsmitha Karunanithi 58468dd075aSAsmitha Karunanithi thisEntry["@odata.type"] = "#LogEntry.v1_11_0.LogEntry"; 585fdd26906SClaire Weinan thisEntry["@odata.id"] = entriesPath + entryID; 5865cb1dd27SAsmitha Karunanithi thisEntry["Id"] = entryID; 5875cb1dd27SAsmitha Karunanithi thisEntry["EntryType"] = "Event"; 5885cb1dd27SAsmitha Karunanithi thisEntry["Name"] = dumpType + " Dump Entry"; 589bbd80db8SClaire Weinan thisEntry["Created"] = 590bbd80db8SClaire Weinan redfish::time_utils::getDateTimeUintUs(timestampUs); 5915cb1dd27SAsmitha Karunanithi 59268dd075aSAsmitha Karunanithi if (!originatorId.empty()) 59368dd075aSAsmitha Karunanithi { 59468dd075aSAsmitha Karunanithi thisEntry["Originator"] = originatorId; 59568dd075aSAsmitha Karunanithi thisEntry["OriginatorType"] = originatorType; 59668dd075aSAsmitha Karunanithi } 59768dd075aSAsmitha Karunanithi 5985cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 5995cb1dd27SAsmitha Karunanithi { 600d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "Manager"; 60189492a15SPatrick Williams thisEntry["AdditionalDataURI"] = entriesPath + entryID + 60289492a15SPatrick Williams "/attachment"; 603fdd26906SClaire Weinan thisEntry["AdditionalDataSizeBytes"] = size; 6045cb1dd27SAsmitha Karunanithi } 6055cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 6065cb1dd27SAsmitha Karunanithi { 607d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "OEM"; 608d337bb72SAsmitha Karunanithi thisEntry["OEMDiagnosticDataType"] = "System"; 60989492a15SPatrick Williams thisEntry["AdditionalDataURI"] = entriesPath + entryID + 61089492a15SPatrick Williams "/attachment"; 611fdd26906SClaire Weinan thisEntry["AdditionalDataSizeBytes"] = size; 6125cb1dd27SAsmitha Karunanithi } 613b2ba3072SPatrick Williams entriesArray.emplace_back(std::move(thisEntry)); 6145cb1dd27SAsmitha Karunanithi } 615002d39b4SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size(); 6163544d2a7SEd Tanous asyncResp->res.jsonValue["Members"] = std::move(entriesArray); 6175eb468daSGeorge Liu }); 6185cb1dd27SAsmitha Karunanithi } 6195cb1dd27SAsmitha Karunanithi 6208d1b46d7Szhanghch05 inline void 621c7a6d660SClaire Weinan getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 6228d1b46d7Szhanghch05 const std::string& entryID, const std::string& dumpType) 6235cb1dd27SAsmitha Karunanithi { 624fdd26906SClaire Weinan std::string entriesPath = getDumpEntriesPath(dumpType); 625fdd26906SClaire Weinan if (entriesPath.empty()) 6265cb1dd27SAsmitha Karunanithi { 6275cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6285cb1dd27SAsmitha Karunanithi return; 6295cb1dd27SAsmitha Karunanithi } 6305cb1dd27SAsmitha Karunanithi 6315eb468daSGeorge Liu sdbusplus::message::object_path path("/xyz/openbmc_project/dump"); 6325eb468daSGeorge Liu dbus::utility::getManagedObjects( 6335eb468daSGeorge Liu "xyz.openbmc_project.Dump.Manager", path, 634fdd26906SClaire Weinan [asyncResp, entryID, dumpType, 6355e7e2dc5SEd Tanous entriesPath](const boost::system::error_code& ec, 63602cad96eSEd Tanous const dbus::utility::ManagedObjectType& resp) { 6375cb1dd27SAsmitha Karunanithi if (ec) 6385cb1dd27SAsmitha Karunanithi { 63962598e31SEd Tanous BMCWEB_LOG_ERROR("DumpEntry resp_handler got error {}", ec); 6405cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6415cb1dd27SAsmitha Karunanithi return; 6425cb1dd27SAsmitha Karunanithi } 6435cb1dd27SAsmitha Karunanithi 644b47452b2SAsmitha Karunanithi bool foundDumpEntry = false; 64518f8f608SEd Tanous std::string dumpEntryPath = getDumpPath(dumpType) + "/entry/"; 646b47452b2SAsmitha Karunanithi 6479eb808c1SEd Tanous for (const auto& objectPath : resp) 6485cb1dd27SAsmitha Karunanithi { 649b47452b2SAsmitha Karunanithi if (objectPath.first.str != dumpEntryPath + entryID) 6505cb1dd27SAsmitha Karunanithi { 6515cb1dd27SAsmitha Karunanithi continue; 6525cb1dd27SAsmitha Karunanithi } 6535cb1dd27SAsmitha Karunanithi 6545cb1dd27SAsmitha Karunanithi foundDumpEntry = true; 655c6fecdabSClaire Weinan uint64_t timestampUs = 0; 6565cb1dd27SAsmitha Karunanithi uint64_t size = 0; 65735440d18SAsmitha Karunanithi std::string dumpStatus; 65868dd075aSAsmitha Karunanithi std::string originatorId; 65968dd075aSAsmitha Karunanithi log_entry::OriginatorTypes originatorType = 66068dd075aSAsmitha Karunanithi log_entry::OriginatorTypes::Internal; 6615cb1dd27SAsmitha Karunanithi 662aefe3786SClaire Weinan parseDumpEntryFromDbusObject(objectPath, dumpStatus, size, 66368dd075aSAsmitha Karunanithi timestampUs, originatorId, 66468dd075aSAsmitha Karunanithi originatorType, asyncResp); 6655cb1dd27SAsmitha Karunanithi 6660fda0f12SGeorge Liu if (dumpStatus != 6670fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 66835440d18SAsmitha Karunanithi !dumpStatus.empty()) 66935440d18SAsmitha Karunanithi { 67035440d18SAsmitha Karunanithi // Dump status is not Complete 67135440d18SAsmitha Karunanithi // return not found until status is changed to Completed 672d1bde9e5SKrzysztof Grobelny messages::resourceNotFound(asyncResp->res, dumpType + " dump", 673d1bde9e5SKrzysztof Grobelny entryID); 67435440d18SAsmitha Karunanithi return; 67535440d18SAsmitha Karunanithi } 67635440d18SAsmitha Karunanithi 6775cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 67868dd075aSAsmitha Karunanithi "#LogEntry.v1_11_0.LogEntry"; 679fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = entriesPath + entryID; 6805cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = entryID; 6815cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["EntryType"] = "Event"; 6825cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry"; 683bbd80db8SClaire Weinan asyncResp->res.jsonValue["Created"] = 684bbd80db8SClaire Weinan redfish::time_utils::getDateTimeUintUs(timestampUs); 6855cb1dd27SAsmitha Karunanithi 68668dd075aSAsmitha Karunanithi if (!originatorId.empty()) 68768dd075aSAsmitha Karunanithi { 68868dd075aSAsmitha Karunanithi asyncResp->res.jsonValue["Originator"] = originatorId; 68968dd075aSAsmitha Karunanithi asyncResp->res.jsonValue["OriginatorType"] = originatorType; 69068dd075aSAsmitha Karunanithi } 69168dd075aSAsmitha Karunanithi 6925cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 6935cb1dd27SAsmitha Karunanithi { 694d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager"; 695d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 696fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 697fdd26906SClaire Weinan asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 6985cb1dd27SAsmitha Karunanithi } 6995cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 7005cb1dd27SAsmitha Karunanithi { 701d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM"; 702002d39b4SEd Tanous asyncResp->res.jsonValue["OEMDiagnosticDataType"] = "System"; 703d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 704fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 705fdd26906SClaire Weinan asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 7065cb1dd27SAsmitha Karunanithi } 7075cb1dd27SAsmitha Karunanithi } 708e05aec50SEd Tanous if (!foundDumpEntry) 709b47452b2SAsmitha Karunanithi { 71062598e31SEd Tanous BMCWEB_LOG_WARNING("Can't find Dump Entry {}", entryID); 711b90d14f2SMyung Bae messages::resourceNotFound(asyncResp->res, dumpType + " dump", 712b90d14f2SMyung Bae entryID); 713b47452b2SAsmitha Karunanithi return; 714b47452b2SAsmitha Karunanithi } 7155eb468daSGeorge Liu }); 7165cb1dd27SAsmitha Karunanithi } 7175cb1dd27SAsmitha Karunanithi 7188d1b46d7Szhanghch05 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 7199878256fSStanley Chu const std::string& entryID, 720b47452b2SAsmitha Karunanithi const std::string& dumpType) 7215cb1dd27SAsmitha Karunanithi { 7225a39f77aSPatrick Williams auto respHandler = [asyncResp, 7235a39f77aSPatrick Williams entryID](const boost::system::error_code& ec) { 72462598e31SEd Tanous BMCWEB_LOG_DEBUG("Dump Entry doDelete callback: Done"); 7255cb1dd27SAsmitha Karunanithi if (ec) 7265cb1dd27SAsmitha Karunanithi { 7273de8d8baSGeorge Liu if (ec.value() == EBADR) 7283de8d8baSGeorge Liu { 7293de8d8baSGeorge Liu messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 7303de8d8baSGeorge Liu return; 7313de8d8baSGeorge Liu } 73262598e31SEd Tanous BMCWEB_LOG_ERROR( 73362598e31SEd Tanous "Dump (DBus) doDelete respHandler got error {} entryID={}", ec, 73462598e31SEd Tanous entryID); 7355cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 7365cb1dd27SAsmitha Karunanithi return; 7375cb1dd27SAsmitha Karunanithi } 7385cb1dd27SAsmitha Karunanithi }; 73918f8f608SEd Tanous 7405cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 7415cb1dd27SAsmitha Karunanithi respHandler, "xyz.openbmc_project.Dump.Manager", 74218f8f608SEd Tanous std::format("{}/entry/{}", getDumpPath(dumpType), entryID), 7435cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Object.Delete", "Delete"); 7445cb1dd27SAsmitha Karunanithi } 745b5f288d2SAbhilash Raju inline bool checkSizeLimit(int fd, crow::Response& res) 746b5f288d2SAbhilash Raju { 747b5f288d2SAbhilash Raju long long int size = lseek(fd, 0, SEEK_END); 748b5f288d2SAbhilash Raju if (size <= 0) 749b5f288d2SAbhilash Raju { 750b5f288d2SAbhilash Raju BMCWEB_LOG_ERROR("Failed to get size of file, lseek() returned {}", 751b5f288d2SAbhilash Raju size); 752b5f288d2SAbhilash Raju messages::internalError(res); 753b5f288d2SAbhilash Raju return false; 754b5f288d2SAbhilash Raju } 7555cb1dd27SAsmitha Karunanithi 756b5f288d2SAbhilash Raju // Arbitrary max size of 20MB to accommodate BMC dumps 757b5f288d2SAbhilash Raju constexpr long long int maxFileSize = 20LL * 1024LL * 1024LL; 758b5f288d2SAbhilash Raju if (size > maxFileSize) 759b5f288d2SAbhilash Raju { 760b5f288d2SAbhilash Raju BMCWEB_LOG_ERROR("File size {} exceeds maximum allowed size of {}", 761b5f288d2SAbhilash Raju size, maxFileSize); 762b5f288d2SAbhilash Raju messages::internalError(res); 763b5f288d2SAbhilash Raju return false; 764b5f288d2SAbhilash Raju } 765b5f288d2SAbhilash Raju off_t rc = lseek(fd, 0, SEEK_SET); 766b5f288d2SAbhilash Raju if (rc < 0) 767b5f288d2SAbhilash Raju { 768b5f288d2SAbhilash Raju BMCWEB_LOG_ERROR("Failed to reset file offset to 0"); 769b5f288d2SAbhilash Raju messages::internalError(res); 770b5f288d2SAbhilash Raju return false; 771b5f288d2SAbhilash Raju } 772b5f288d2SAbhilash Raju return true; 773b5f288d2SAbhilash Raju } 774168d1b1aSCarson Labrado inline void 775168d1b1aSCarson Labrado downloadEntryCallback(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 776168d1b1aSCarson Labrado const std::string& entryID, 777168d1b1aSCarson Labrado const std::string& downloadEntryType, 778168d1b1aSCarson Labrado const boost::system::error_code& ec, 779168d1b1aSCarson Labrado const sdbusplus::message::unix_fd& unixfd) 780168d1b1aSCarson Labrado { 781168d1b1aSCarson Labrado if (ec.value() == EBADR) 782168d1b1aSCarson Labrado { 783168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, "EntryAttachment", entryID); 784168d1b1aSCarson Labrado return; 785168d1b1aSCarson Labrado } 786168d1b1aSCarson Labrado if (ec) 787168d1b1aSCarson Labrado { 788168d1b1aSCarson Labrado BMCWEB_LOG_ERROR("DBUS response error: {}", ec); 789168d1b1aSCarson Labrado messages::internalError(asyncResp->res); 790168d1b1aSCarson Labrado return; 791168d1b1aSCarson Labrado } 792168d1b1aSCarson Labrado 793168d1b1aSCarson Labrado // Make sure we know how to process the retrieved entry attachment 794168d1b1aSCarson Labrado if ((downloadEntryType != "BMC") && (downloadEntryType != "System")) 795168d1b1aSCarson Labrado { 796168d1b1aSCarson Labrado BMCWEB_LOG_ERROR("downloadEntryCallback() invalid entry type: {}", 797168d1b1aSCarson Labrado downloadEntryType); 798168d1b1aSCarson Labrado messages::internalError(asyncResp->res); 799168d1b1aSCarson Labrado } 800168d1b1aSCarson Labrado 801168d1b1aSCarson Labrado int fd = -1; 802168d1b1aSCarson Labrado fd = dup(unixfd); 803168d1b1aSCarson Labrado if (fd < 0) 804168d1b1aSCarson Labrado { 805168d1b1aSCarson Labrado BMCWEB_LOG_ERROR("Failed to open file"); 806168d1b1aSCarson Labrado messages::internalError(asyncResp->res); 807168d1b1aSCarson Labrado return; 808168d1b1aSCarson Labrado } 809b5f288d2SAbhilash Raju if (!checkSizeLimit(fd, asyncResp->res)) 810168d1b1aSCarson Labrado { 811168d1b1aSCarson Labrado close(fd); 812168d1b1aSCarson Labrado return; 813168d1b1aSCarson Labrado } 814168d1b1aSCarson Labrado if (downloadEntryType == "System") 815168d1b1aSCarson Labrado { 816b5f288d2SAbhilash Raju if (!asyncResp->res.openFd(fd, bmcweb::EncodingType::Base64)) 817b5f288d2SAbhilash Raju { 818b5f288d2SAbhilash Raju messages::internalError(asyncResp->res); 819b5f288d2SAbhilash Raju close(fd); 820b5f288d2SAbhilash Raju return; 821b5f288d2SAbhilash Raju } 822168d1b1aSCarson Labrado asyncResp->res.addHeader( 823168d1b1aSCarson Labrado boost::beast::http::field::content_transfer_encoding, "Base64"); 824b5f288d2SAbhilash Raju return; 825168d1b1aSCarson Labrado } 826b5f288d2SAbhilash Raju if (!asyncResp->res.openFd(fd)) 82727b0cf90SEd Tanous { 828b5f288d2SAbhilash Raju messages::internalError(asyncResp->res); 829b5f288d2SAbhilash Raju close(fd); 830b5f288d2SAbhilash Raju return; 83127b0cf90SEd Tanous } 832168d1b1aSCarson Labrado asyncResp->res.addHeader(boost::beast::http::field::content_type, 833168d1b1aSCarson Labrado "application/octet-stream"); 834168d1b1aSCarson Labrado } 835168d1b1aSCarson Labrado 836168d1b1aSCarson Labrado inline void 837168d1b1aSCarson Labrado downloadDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 838168d1b1aSCarson Labrado const std::string& entryID, const std::string& dumpType) 839168d1b1aSCarson Labrado { 840168d1b1aSCarson Labrado if (dumpType != "BMC") 841168d1b1aSCarson Labrado { 842168d1b1aSCarson Labrado BMCWEB_LOG_WARNING("Can't find Dump Entry {}", entryID); 843168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, dumpType + " dump", entryID); 844168d1b1aSCarson Labrado return; 845168d1b1aSCarson Labrado } 846168d1b1aSCarson Labrado 84718f8f608SEd Tanous std::string dumpEntryPath = std::format("{}/entry/{}", 84818f8f608SEd Tanous getDumpPath(dumpType), entryID); 849168d1b1aSCarson Labrado 850168d1b1aSCarson Labrado auto downloadDumpEntryHandler = 851168d1b1aSCarson Labrado [asyncResp, entryID, 852168d1b1aSCarson Labrado dumpType](const boost::system::error_code& ec, 853168d1b1aSCarson Labrado const sdbusplus::message::unix_fd& unixfd) { 854168d1b1aSCarson Labrado downloadEntryCallback(asyncResp, entryID, dumpType, ec, unixfd); 855168d1b1aSCarson Labrado }; 856168d1b1aSCarson Labrado 857168d1b1aSCarson Labrado crow::connections::systemBus->async_method_call( 858168d1b1aSCarson Labrado std::move(downloadDumpEntryHandler), "xyz.openbmc_project.Dump.Manager", 859168d1b1aSCarson Labrado dumpEntryPath, "xyz.openbmc_project.Dump.Entry", "GetFileHandle"); 860168d1b1aSCarson Labrado } 861168d1b1aSCarson Labrado 862168d1b1aSCarson Labrado inline void 863168d1b1aSCarson Labrado downloadEventLogEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 864168d1b1aSCarson Labrado const std::string& systemName, 865168d1b1aSCarson Labrado const std::string& entryID, 866168d1b1aSCarson Labrado const std::string& dumpType) 867168d1b1aSCarson Labrado { 868*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 869168d1b1aSCarson Labrado { 870168d1b1aSCarson Labrado // Option currently returns no systems. TBD 871168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, "ComputerSystem", 872168d1b1aSCarson Labrado systemName); 873168d1b1aSCarson Labrado return; 874168d1b1aSCarson Labrado } 875168d1b1aSCarson Labrado if (systemName != "system") 876168d1b1aSCarson Labrado { 877168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, "ComputerSystem", 878168d1b1aSCarson Labrado systemName); 879168d1b1aSCarson Labrado return; 880168d1b1aSCarson Labrado } 881168d1b1aSCarson Labrado 882168d1b1aSCarson Labrado std::string entryPath = 883168d1b1aSCarson Labrado sdbusplus::message::object_path("/xyz/openbmc_project/logging/entry") / 884168d1b1aSCarson Labrado entryID; 885168d1b1aSCarson Labrado 886168d1b1aSCarson Labrado auto downloadEventLogEntryHandler = 887168d1b1aSCarson Labrado [asyncResp, entryID, 888168d1b1aSCarson Labrado dumpType](const boost::system::error_code& ec, 889168d1b1aSCarson Labrado const sdbusplus::message::unix_fd& unixfd) { 890168d1b1aSCarson Labrado downloadEntryCallback(asyncResp, entryID, dumpType, ec, unixfd); 891168d1b1aSCarson Labrado }; 892168d1b1aSCarson Labrado 893168d1b1aSCarson Labrado crow::connections::systemBus->async_method_call( 894168d1b1aSCarson Labrado std::move(downloadEventLogEntryHandler), "xyz.openbmc_project.Logging", 895168d1b1aSCarson Labrado entryPath, "xyz.openbmc_project.Logging.Entry", "GetEntry"); 896168d1b1aSCarson Labrado } 897168d1b1aSCarson Labrado 8988e31778eSAsmitha Karunanithi inline DumpCreationProgress 8998e31778eSAsmitha Karunanithi mapDbusStatusToDumpProgress(const std::string& status) 900a43be80fSAsmitha Karunanithi { 9018e31778eSAsmitha Karunanithi if (status == 9028e31778eSAsmitha Karunanithi "xyz.openbmc_project.Common.Progress.OperationStatus.Failed" || 9038e31778eSAsmitha Karunanithi status == "xyz.openbmc_project.Common.Progress.OperationStatus.Aborted") 9048e31778eSAsmitha Karunanithi { 9058e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_FAILED; 9068e31778eSAsmitha Karunanithi } 9078e31778eSAsmitha Karunanithi if (status == 9088e31778eSAsmitha Karunanithi "xyz.openbmc_project.Common.Progress.OperationStatus.Completed") 9098e31778eSAsmitha Karunanithi { 9108e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_SUCCESS; 9118e31778eSAsmitha Karunanithi } 9128e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_INPROGRESS; 9138e31778eSAsmitha Karunanithi } 9148e31778eSAsmitha Karunanithi 9158e31778eSAsmitha Karunanithi inline DumpCreationProgress 9168e31778eSAsmitha Karunanithi getDumpCompletionStatus(const dbus::utility::DBusPropertiesMap& values) 9178e31778eSAsmitha Karunanithi { 9188e31778eSAsmitha Karunanithi for (const auto& [key, val] : values) 9198e31778eSAsmitha Karunanithi { 9208e31778eSAsmitha Karunanithi if (key == "Status") 9218e31778eSAsmitha Karunanithi { 9228e31778eSAsmitha Karunanithi const std::string* value = std::get_if<std::string>(&val); 9238e31778eSAsmitha Karunanithi if (value == nullptr) 9248e31778eSAsmitha Karunanithi { 92562598e31SEd Tanous BMCWEB_LOG_ERROR("Status property value is null"); 9268e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_FAILED; 9278e31778eSAsmitha Karunanithi } 9288e31778eSAsmitha Karunanithi return mapDbusStatusToDumpProgress(*value); 9298e31778eSAsmitha Karunanithi } 9308e31778eSAsmitha Karunanithi } 9318e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_INPROGRESS; 9328e31778eSAsmitha Karunanithi } 9338e31778eSAsmitha Karunanithi 9348e31778eSAsmitha Karunanithi inline std::string getDumpEntryPath(const std::string& dumpPath) 9358e31778eSAsmitha Karunanithi { 9368e31778eSAsmitha Karunanithi if (dumpPath == "/xyz/openbmc_project/dump/bmc/entry") 9378e31778eSAsmitha Karunanithi { 9388e31778eSAsmitha Karunanithi return "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 9398e31778eSAsmitha Karunanithi } 9408e31778eSAsmitha Karunanithi if (dumpPath == "/xyz/openbmc_project/dump/system/entry") 9418e31778eSAsmitha Karunanithi { 9428e31778eSAsmitha Karunanithi return "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 9438e31778eSAsmitha Karunanithi } 9448e31778eSAsmitha Karunanithi return ""; 9458e31778eSAsmitha Karunanithi } 9468e31778eSAsmitha Karunanithi 9478e31778eSAsmitha Karunanithi inline void createDumpTaskCallback( 9488e31778eSAsmitha Karunanithi task::Payload&& payload, 9498e31778eSAsmitha Karunanithi const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 9508e31778eSAsmitha Karunanithi const sdbusplus::message::object_path& createdObjPath) 9518e31778eSAsmitha Karunanithi { 9528e31778eSAsmitha Karunanithi const std::string dumpPath = createdObjPath.parent_path().str; 9538e31778eSAsmitha Karunanithi const std::string dumpId = createdObjPath.filename(); 9548e31778eSAsmitha Karunanithi 9558e31778eSAsmitha Karunanithi std::string dumpEntryPath = getDumpEntryPath(dumpPath); 9568e31778eSAsmitha Karunanithi 9578e31778eSAsmitha Karunanithi if (dumpEntryPath.empty()) 9588e31778eSAsmitha Karunanithi { 95962598e31SEd Tanous BMCWEB_LOG_ERROR("Invalid dump type received"); 9608e31778eSAsmitha Karunanithi messages::internalError(asyncResp->res); 9618e31778eSAsmitha Karunanithi return; 9628e31778eSAsmitha Karunanithi } 9638e31778eSAsmitha Karunanithi 9648e31778eSAsmitha Karunanithi crow::connections::systemBus->async_method_call( 9658cb2c024SEd Tanous [asyncResp, payload = std::move(payload), createdObjPath, 9668e31778eSAsmitha Karunanithi dumpEntryPath{std::move(dumpEntryPath)}, 9675e7e2dc5SEd Tanous dumpId](const boost::system::error_code& ec, 9688e31778eSAsmitha Karunanithi const std::string& introspectXml) { 9698e31778eSAsmitha Karunanithi if (ec) 9708e31778eSAsmitha Karunanithi { 97162598e31SEd Tanous BMCWEB_LOG_ERROR("Introspect call failed with error: {}", 97262598e31SEd Tanous ec.message()); 9738e31778eSAsmitha Karunanithi messages::internalError(asyncResp->res); 9748e31778eSAsmitha Karunanithi return; 9758e31778eSAsmitha Karunanithi } 9768e31778eSAsmitha Karunanithi 9778e31778eSAsmitha Karunanithi // Check if the created dump object has implemented Progress 9788e31778eSAsmitha Karunanithi // interface to track dump completion. If yes, fetch the "Status" 9798e31778eSAsmitha Karunanithi // property of the interface, modify the task state accordingly. 9808e31778eSAsmitha Karunanithi // Else, return task completed. 9818e31778eSAsmitha Karunanithi tinyxml2::XMLDocument doc; 9828e31778eSAsmitha Karunanithi 9838e31778eSAsmitha Karunanithi doc.Parse(introspectXml.data(), introspectXml.size()); 9848e31778eSAsmitha Karunanithi tinyxml2::XMLNode* pRoot = doc.FirstChildElement("node"); 9858e31778eSAsmitha Karunanithi if (pRoot == nullptr) 9868e31778eSAsmitha Karunanithi { 98762598e31SEd Tanous BMCWEB_LOG_ERROR("XML document failed to parse"); 9888e31778eSAsmitha Karunanithi messages::internalError(asyncResp->res); 9898e31778eSAsmitha Karunanithi return; 9908e31778eSAsmitha Karunanithi } 9918e31778eSAsmitha Karunanithi tinyxml2::XMLElement* interfaceNode = 9928e31778eSAsmitha Karunanithi pRoot->FirstChildElement("interface"); 9938e31778eSAsmitha Karunanithi 9948e31778eSAsmitha Karunanithi bool isProgressIntfPresent = false; 9958e31778eSAsmitha Karunanithi while (interfaceNode != nullptr) 9968e31778eSAsmitha Karunanithi { 9978e31778eSAsmitha Karunanithi const char* thisInterfaceName = interfaceNode->Attribute("name"); 9988e31778eSAsmitha Karunanithi if (thisInterfaceName != nullptr) 9998e31778eSAsmitha Karunanithi { 10008e31778eSAsmitha Karunanithi if (thisInterfaceName == 10018e31778eSAsmitha Karunanithi std::string_view("xyz.openbmc_project.Common.Progress")) 10028e31778eSAsmitha Karunanithi { 10038e31778eSAsmitha Karunanithi interfaceNode = 10048e31778eSAsmitha Karunanithi interfaceNode->NextSiblingElement("interface"); 10058e31778eSAsmitha Karunanithi continue; 10068e31778eSAsmitha Karunanithi } 10078e31778eSAsmitha Karunanithi isProgressIntfPresent = true; 10088e31778eSAsmitha Karunanithi break; 10098e31778eSAsmitha Karunanithi } 10108e31778eSAsmitha Karunanithi interfaceNode = interfaceNode->NextSiblingElement("interface"); 10118e31778eSAsmitha Karunanithi } 10128e31778eSAsmitha Karunanithi 1013a43be80fSAsmitha Karunanithi std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 10148e31778eSAsmitha Karunanithi [createdObjPath, dumpEntryPath, dumpId, isProgressIntfPresent]( 10158b24275dSEd Tanous const boost::system::error_code& ec2, sdbusplus::message_t& msg, 1016a43be80fSAsmitha Karunanithi const std::shared_ptr<task::TaskData>& taskData) { 10178b24275dSEd Tanous if (ec2) 1018cb13a392SEd Tanous { 101962598e31SEd Tanous BMCWEB_LOG_ERROR("{}: Error in creating dump", 102062598e31SEd Tanous createdObjPath.str); 10218e31778eSAsmitha Karunanithi taskData->messages.emplace_back(messages::internalError()); 10226145ed6fSAsmitha Karunanithi taskData->state = "Cancelled"; 10236145ed6fSAsmitha Karunanithi return task::completed; 1024cb13a392SEd Tanous } 1025b9d36b47SEd Tanous 10268e31778eSAsmitha Karunanithi if (isProgressIntfPresent) 1027a43be80fSAsmitha Karunanithi { 10288e31778eSAsmitha Karunanithi dbus::utility::DBusPropertiesMap values; 10298e31778eSAsmitha Karunanithi std::string prop; 10308e31778eSAsmitha Karunanithi msg.read(prop, values); 10318e31778eSAsmitha Karunanithi 10328e31778eSAsmitha Karunanithi DumpCreationProgress dumpStatus = 10338e31778eSAsmitha Karunanithi getDumpCompletionStatus(values); 10348e31778eSAsmitha Karunanithi if (dumpStatus == DumpCreationProgress::DUMP_CREATE_FAILED) 10358e31778eSAsmitha Karunanithi { 103662598e31SEd Tanous BMCWEB_LOG_ERROR("{}: Error in creating dump", 103762598e31SEd Tanous createdObjPath.str); 10388e31778eSAsmitha Karunanithi taskData->state = "Cancelled"; 10398e31778eSAsmitha Karunanithi return task::completed; 10408e31778eSAsmitha Karunanithi } 10418e31778eSAsmitha Karunanithi 10428e31778eSAsmitha Karunanithi if (dumpStatus == DumpCreationProgress::DUMP_CREATE_INPROGRESS) 10438e31778eSAsmitha Karunanithi { 104462598e31SEd Tanous BMCWEB_LOG_DEBUG("{}: Dump creation task is in progress", 104562598e31SEd Tanous createdObjPath.str); 10468e31778eSAsmitha Karunanithi return !task::completed; 10478e31778eSAsmitha Karunanithi } 10488e31778eSAsmitha Karunanithi } 10498e31778eSAsmitha Karunanithi 1050a43be80fSAsmitha Karunanithi nlohmann::json retMessage = messages::success(); 1051a43be80fSAsmitha Karunanithi taskData->messages.emplace_back(retMessage); 1052a43be80fSAsmitha Karunanithi 1053c51a58eeSEd Tanous boost::urls::url url = boost::urls::format( 1054c51a58eeSEd Tanous "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/{}", dumpId); 1055c51a58eeSEd Tanous 1056c51a58eeSEd Tanous std::string headerLoc = "Location: "; 1057c51a58eeSEd Tanous headerLoc += url.buffer(); 1058c51a58eeSEd Tanous 1059002d39b4SEd Tanous taskData->payload->httpHeaders.emplace_back(std::move(headerLoc)); 1060a43be80fSAsmitha Karunanithi 106162598e31SEd Tanous BMCWEB_LOG_DEBUG("{}: Dump creation task completed", 106262598e31SEd Tanous createdObjPath.str); 1063a43be80fSAsmitha Karunanithi taskData->state = "Completed"; 1064b47452b2SAsmitha Karunanithi return task::completed; 1065a43be80fSAsmitha Karunanithi }, 10668e31778eSAsmitha Karunanithi "type='signal',interface='org.freedesktop.DBus.Properties'," 10678e31778eSAsmitha Karunanithi "member='PropertiesChanged',path='" + 10688e31778eSAsmitha Karunanithi createdObjPath.str + "'"); 1069a43be80fSAsmitha Karunanithi 10708e31778eSAsmitha Karunanithi // The task timer is set to max time limit within which the 10718e31778eSAsmitha Karunanithi // requested dump will be collected. 10728e31778eSAsmitha Karunanithi task->startTimer(std::chrono::minutes(6)); 1073a43be80fSAsmitha Karunanithi task->populateResp(asyncResp->res); 10748e31778eSAsmitha Karunanithi task->payload.emplace(payload); 10758e31778eSAsmitha Karunanithi }, 10768e31778eSAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", createdObjPath, 10778e31778eSAsmitha Karunanithi "org.freedesktop.DBus.Introspectable", "Introspect"); 1078a43be80fSAsmitha Karunanithi } 1079a43be80fSAsmitha Karunanithi 10808d1b46d7Szhanghch05 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 10818d1b46d7Szhanghch05 const crow::Request& req, const std::string& dumpType) 1082a43be80fSAsmitha Karunanithi { 1083fdd26906SClaire Weinan std::string dumpPath = getDumpEntriesPath(dumpType); 1084fdd26906SClaire Weinan if (dumpPath.empty()) 1085a43be80fSAsmitha Karunanithi { 1086a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 1087a43be80fSAsmitha Karunanithi return; 1088a43be80fSAsmitha Karunanithi } 1089a43be80fSAsmitha Karunanithi 1090a43be80fSAsmitha Karunanithi std::optional<std::string> diagnosticDataType; 1091a43be80fSAsmitha Karunanithi std::optional<std::string> oemDiagnosticDataType; 1092a43be80fSAsmitha Karunanithi 109315ed6780SWilly Tu if (!redfish::json_util::readJsonAction( 1094a43be80fSAsmitha Karunanithi req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 1095a43be80fSAsmitha Karunanithi "OEMDiagnosticDataType", oemDiagnosticDataType)) 1096a43be80fSAsmitha Karunanithi { 1097a43be80fSAsmitha Karunanithi return; 1098a43be80fSAsmitha Karunanithi } 1099a43be80fSAsmitha Karunanithi 1100a43be80fSAsmitha Karunanithi if (dumpType == "System") 1101a43be80fSAsmitha Karunanithi { 1102a43be80fSAsmitha Karunanithi if (!oemDiagnosticDataType || !diagnosticDataType) 1103a43be80fSAsmitha Karunanithi { 110462598e31SEd Tanous BMCWEB_LOG_ERROR( 110562598e31SEd Tanous "CreateDump action parameter 'DiagnosticDataType'/'OEMDiagnosticDataType' value not found!"); 1106a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 1107a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", 1108a43be80fSAsmitha Karunanithi "DiagnosticDataType & OEMDiagnosticDataType"); 1109a43be80fSAsmitha Karunanithi return; 1110a43be80fSAsmitha Karunanithi } 11113174e4dfSEd Tanous if ((*oemDiagnosticDataType != "System") || 1112a43be80fSAsmitha Karunanithi (*diagnosticDataType != "OEM")) 1113a43be80fSAsmitha Karunanithi { 111462598e31SEd Tanous BMCWEB_LOG_ERROR("Wrong parameter values passed"); 1115ace85d60SEd Tanous messages::internalError(asyncResp->res); 1116a43be80fSAsmitha Karunanithi return; 1117a43be80fSAsmitha Karunanithi } 11185907571dSAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/"; 1119a43be80fSAsmitha Karunanithi } 1120a43be80fSAsmitha Karunanithi else if (dumpType == "BMC") 1121a43be80fSAsmitha Karunanithi { 1122a43be80fSAsmitha Karunanithi if (!diagnosticDataType) 1123a43be80fSAsmitha Karunanithi { 112462598e31SEd Tanous BMCWEB_LOG_ERROR( 112562598e31SEd Tanous "CreateDump action parameter 'DiagnosticDataType' not found!"); 1126a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 1127a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType"); 1128a43be80fSAsmitha Karunanithi return; 1129a43be80fSAsmitha Karunanithi } 11303174e4dfSEd Tanous if (*diagnosticDataType != "Manager") 1131a43be80fSAsmitha Karunanithi { 113262598e31SEd Tanous BMCWEB_LOG_ERROR( 113362598e31SEd Tanous "Wrong parameter value passed for 'DiagnosticDataType'"); 1134ace85d60SEd Tanous messages::internalError(asyncResp->res); 1135a43be80fSAsmitha Karunanithi return; 1136a43be80fSAsmitha Karunanithi } 11375907571dSAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/"; 11385907571dSAsmitha Karunanithi } 11395907571dSAsmitha Karunanithi else 11405907571dSAsmitha Karunanithi { 114162598e31SEd Tanous BMCWEB_LOG_ERROR("CreateDump failed. Unknown dump type"); 11425907571dSAsmitha Karunanithi messages::internalError(asyncResp->res); 11435907571dSAsmitha Karunanithi return; 1144a43be80fSAsmitha Karunanithi } 1145a43be80fSAsmitha Karunanithi 11468e31778eSAsmitha Karunanithi std::vector<std::pair<std::string, std::variant<std::string, uint64_t>>> 11478e31778eSAsmitha Karunanithi createDumpParamVec; 11488e31778eSAsmitha Karunanithi 1149f574a8e1SCarson Labrado if (req.session != nullptr) 1150f574a8e1SCarson Labrado { 115168dd075aSAsmitha Karunanithi createDumpParamVec.emplace_back( 115268dd075aSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorId", 115368dd075aSAsmitha Karunanithi req.session->clientIp); 115468dd075aSAsmitha Karunanithi createDumpParamVec.emplace_back( 115568dd075aSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorType", 115668dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client"); 1157f574a8e1SCarson Labrado } 115868dd075aSAsmitha Karunanithi 1159a43be80fSAsmitha Karunanithi crow::connections::systemBus->async_method_call( 11605e7e2dc5SEd Tanous [asyncResp, payload(task::Payload(req)), 11615e7e2dc5SEd Tanous dumpPath](const boost::system::error_code& ec, 11625e7e2dc5SEd Tanous const sdbusplus::message_t& msg, 11638e31778eSAsmitha Karunanithi const sdbusplus::message::object_path& objPath) mutable { 1164a43be80fSAsmitha Karunanithi if (ec) 1165a43be80fSAsmitha Karunanithi { 116662598e31SEd Tanous BMCWEB_LOG_ERROR("CreateDump resp_handler got error {}", ec); 11675907571dSAsmitha Karunanithi const sd_bus_error* dbusError = msg.get_error(); 11685907571dSAsmitha Karunanithi if (dbusError == nullptr) 11695907571dSAsmitha Karunanithi { 11705907571dSAsmitha Karunanithi messages::internalError(asyncResp->res); 11715907571dSAsmitha Karunanithi return; 11725907571dSAsmitha Karunanithi } 11735907571dSAsmitha Karunanithi 117462598e31SEd Tanous BMCWEB_LOG_ERROR("CreateDump DBus error: {} and error msg: {}", 117562598e31SEd Tanous dbusError->name, dbusError->message); 11765907571dSAsmitha Karunanithi if (std::string_view( 11775907571dSAsmitha Karunanithi "xyz.openbmc_project.Common.Error.NotAllowed") == 11785907571dSAsmitha Karunanithi dbusError->name) 11795907571dSAsmitha Karunanithi { 11805907571dSAsmitha Karunanithi messages::resourceInStandby(asyncResp->res); 11815907571dSAsmitha Karunanithi return; 11825907571dSAsmitha Karunanithi } 11835907571dSAsmitha Karunanithi if (std::string_view( 11845907571dSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create.Error.Disabled") == 11855907571dSAsmitha Karunanithi dbusError->name) 11865907571dSAsmitha Karunanithi { 11875907571dSAsmitha Karunanithi messages::serviceDisabled(asyncResp->res, dumpPath); 11885907571dSAsmitha Karunanithi return; 11895907571dSAsmitha Karunanithi } 11905907571dSAsmitha Karunanithi if (std::string_view( 11915907571dSAsmitha Karunanithi "xyz.openbmc_project.Common.Error.Unavailable") == 11925907571dSAsmitha Karunanithi dbusError->name) 11935907571dSAsmitha Karunanithi { 11945907571dSAsmitha Karunanithi messages::resourceInUse(asyncResp->res); 11955907571dSAsmitha Karunanithi return; 11965907571dSAsmitha Karunanithi } 11975907571dSAsmitha Karunanithi // Other Dbus errors such as: 11985907571dSAsmitha Karunanithi // xyz.openbmc_project.Common.Error.InvalidArgument & 11995907571dSAsmitha Karunanithi // org.freedesktop.DBus.Error.InvalidArgs are all related to 12005907571dSAsmitha Karunanithi // the dbus call that is made here in the bmcweb 12015907571dSAsmitha Karunanithi // implementation and has nothing to do with the client's 12025907571dSAsmitha Karunanithi // input in the request. Hence, returning internal error 12035907571dSAsmitha Karunanithi // back to the client. 1204a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 1205a43be80fSAsmitha Karunanithi return; 1206a43be80fSAsmitha Karunanithi } 120762598e31SEd Tanous BMCWEB_LOG_DEBUG("Dump Created. Path: {}", objPath.str); 12088e31778eSAsmitha Karunanithi createDumpTaskCallback(std::move(payload), asyncResp, objPath); 1209a43be80fSAsmitha Karunanithi }, 121018f8f608SEd Tanous "xyz.openbmc_project.Dump.Manager", getDumpPath(dumpType), 12118e31778eSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create", "CreateDump", createDumpParamVec); 1212a43be80fSAsmitha Karunanithi } 1213a43be80fSAsmitha Karunanithi 12148d1b46d7Szhanghch05 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 12158d1b46d7Szhanghch05 const std::string& dumpType) 121680319af1SAsmitha Karunanithi { 12170d946211SClaire Weinan crow::connections::systemBus->async_method_call( 12180d946211SClaire Weinan [asyncResp](const boost::system::error_code& ec) { 121980319af1SAsmitha Karunanithi if (ec) 122080319af1SAsmitha Karunanithi { 122162598e31SEd Tanous BMCWEB_LOG_ERROR("clearDump resp_handler got error {}", ec); 122280319af1SAsmitha Karunanithi messages::internalError(asyncResp->res); 122380319af1SAsmitha Karunanithi return; 122480319af1SAsmitha Karunanithi } 12250d946211SClaire Weinan }, 122618f8f608SEd Tanous "xyz.openbmc_project.Dump.Manager", getDumpPath(dumpType), 12270d946211SClaire Weinan "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 122880319af1SAsmitha Karunanithi } 122980319af1SAsmitha Karunanithi 1230df254f2cSEd Tanous inline void 1231b9d36b47SEd Tanous parseCrashdumpParameters(const dbus::utility::DBusPropertiesMap& params, 1232b9d36b47SEd Tanous std::string& filename, std::string& timestamp, 1233b9d36b47SEd Tanous std::string& logfile) 1234043a0536SJohnathan Mantey { 1235d1bde9e5SKrzysztof Grobelny const std::string* filenamePtr = nullptr; 1236d1bde9e5SKrzysztof Grobelny const std::string* timestampPtr = nullptr; 1237d1bde9e5SKrzysztof Grobelny const std::string* logfilePtr = nullptr; 1238d1bde9e5SKrzysztof Grobelny 1239d1bde9e5SKrzysztof Grobelny const bool success = sdbusplus::unpackPropertiesNoThrow( 1240d1bde9e5SKrzysztof Grobelny dbus_utils::UnpackErrorPrinter(), params, "Timestamp", timestampPtr, 1241d1bde9e5SKrzysztof Grobelny "Filename", filenamePtr, "Log", logfilePtr); 1242d1bde9e5SKrzysztof Grobelny 1243d1bde9e5SKrzysztof Grobelny if (!success) 1244043a0536SJohnathan Mantey { 1245d1bde9e5SKrzysztof Grobelny return; 1246043a0536SJohnathan Mantey } 1247d1bde9e5SKrzysztof Grobelny 1248d1bde9e5SKrzysztof Grobelny if (filenamePtr != nullptr) 1249043a0536SJohnathan Mantey { 1250d1bde9e5SKrzysztof Grobelny filename = *filenamePtr; 1251d1bde9e5SKrzysztof Grobelny } 1252d1bde9e5SKrzysztof Grobelny 1253d1bde9e5SKrzysztof Grobelny if (timestampPtr != nullptr) 1254043a0536SJohnathan Mantey { 1255d1bde9e5SKrzysztof Grobelny timestamp = *timestampPtr; 1256043a0536SJohnathan Mantey } 1257d1bde9e5SKrzysztof Grobelny 1258d1bde9e5SKrzysztof Grobelny if (logfilePtr != nullptr) 1259043a0536SJohnathan Mantey { 1260d1bde9e5SKrzysztof Grobelny logfile = *logfilePtr; 1261043a0536SJohnathan Mantey } 1262043a0536SJohnathan Mantey } 1263043a0536SJohnathan Mantey 12647e860f15SJohn Edward Broadbent inline void requestRoutesSystemLogServiceCollection(App& app) 12651da66f75SEd Tanous { 1266c4bf6374SJason M. Bills /** 1267c4bf6374SJason M. Bills * Functions triggers appropriate requests on DBus 1268c4bf6374SJason M. Bills */ 126922d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/") 1270ed398213SEd Tanous .privileges(redfish::privileges::getLogServiceCollection) 1271002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1272002d39b4SEd Tanous [&app](const crow::Request& req, 127322d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 127422d268cbSEd Tanous const std::string& systemName) { 12753ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1276c4bf6374SJason M. Bills { 127745ca1b86SEd Tanous return; 127845ca1b86SEd Tanous } 1279*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 12807f3e84a1SEd Tanous { 12817f3e84a1SEd Tanous // Option currently returns no systems. TBD 12827f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 12837f3e84a1SEd Tanous systemName); 12847f3e84a1SEd Tanous return; 12857f3e84a1SEd Tanous } 128622d268cbSEd Tanous if (systemName != "system") 128722d268cbSEd Tanous { 128822d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 128922d268cbSEd Tanous systemName); 129022d268cbSEd Tanous return; 129122d268cbSEd Tanous } 129222d268cbSEd Tanous 12937e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 12947e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1295c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1296c4bf6374SJason M. Bills "#LogServiceCollection.LogServiceCollection"; 1297c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1298029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices"; 129945ca1b86SEd Tanous asyncResp->res.jsonValue["Name"] = "System Log Services Collection"; 1300c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 1301c4bf6374SJason M. Bills "Collection of LogServices for this Computer System"; 1302002d39b4SEd Tanous nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 1303c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 13041476687dSEd Tanous nlohmann::json::object_t eventLog; 13051476687dSEd Tanous eventLog["@odata.id"] = 13061476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 1307b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(eventLog)); 1308*25b54dbaSEd Tanous if constexpr (BMCWEB_REDFISH_DUMP_LOG) 1309*25b54dbaSEd Tanous { 13101476687dSEd Tanous nlohmann::json::object_t dumpLog; 1311*25b54dbaSEd Tanous dumpLog["@odata.id"] = 1312*25b54dbaSEd Tanous "/redfish/v1/Systems/system/LogServices/Dump"; 1313b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(dumpLog)); 1314*25b54dbaSEd Tanous } 1315c9bb6861Sraviteja-b 1316*25b54dbaSEd Tanous if constexpr (BMCWEB_REDFISH_DUMP_LOG) 1317*25b54dbaSEd Tanous { 13181476687dSEd Tanous nlohmann::json::object_t crashdump; 13191476687dSEd Tanous crashdump["@odata.id"] = 13201476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump"; 1321b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(crashdump)); 1322*25b54dbaSEd Tanous } 1323b7028ebfSSpencer Ku 1324*25b54dbaSEd Tanous if constexpr (BMCWEB_REDFISH_HOST_LOGGER) 1325*25b54dbaSEd Tanous { 13261476687dSEd Tanous nlohmann::json::object_t hostlogger; 13271476687dSEd Tanous hostlogger["@odata.id"] = 13281476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger"; 1329b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(hostlogger)); 1330*25b54dbaSEd Tanous } 1331c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 1332c4bf6374SJason M. Bills logServiceArray.size(); 1333a3316fc6SZhikuiRen 13347a1dbc48SGeorge Liu constexpr std::array<std::string_view, 1> interfaces = { 13357a1dbc48SGeorge Liu "xyz.openbmc_project.State.Boot.PostCode"}; 13367a1dbc48SGeorge Liu dbus::utility::getSubTreePaths( 13377a1dbc48SGeorge Liu "/", 0, interfaces, 13387a1dbc48SGeorge Liu [asyncResp](const boost::system::error_code& ec, 1339b9d36b47SEd Tanous const dbus::utility::MapperGetSubTreePathsResponse& 1340b9d36b47SEd Tanous subtreePath) { 1341a3316fc6SZhikuiRen if (ec) 1342a3316fc6SZhikuiRen { 134362598e31SEd Tanous BMCWEB_LOG_ERROR("{}", ec); 1344a3316fc6SZhikuiRen return; 1345a3316fc6SZhikuiRen } 1346a3316fc6SZhikuiRen 134755f79e6fSEd Tanous for (const auto& pathStr : subtreePath) 1348a3316fc6SZhikuiRen { 1349a3316fc6SZhikuiRen if (pathStr.find("PostCode") != std::string::npos) 1350a3316fc6SZhikuiRen { 135123a21a1cSEd Tanous nlohmann::json& logServiceArrayLocal = 1352a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"]; 1353613dabeaSEd Tanous nlohmann::json::object_t member; 1354613dabeaSEd Tanous member["@odata.id"] = 1355613dabeaSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes"; 1356613dabeaSEd Tanous 1357b2ba3072SPatrick Williams logServiceArrayLocal.emplace_back(std::move(member)); 1358613dabeaSEd Tanous 135945ca1b86SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = 136023a21a1cSEd Tanous logServiceArrayLocal.size(); 1361a3316fc6SZhikuiRen return; 1362a3316fc6SZhikuiRen } 1363a3316fc6SZhikuiRen } 13647a1dbc48SGeorge Liu }); 13657e860f15SJohn Edward Broadbent }); 1366c4bf6374SJason M. Bills } 1367c4bf6374SJason M. Bills 13687e860f15SJohn Edward Broadbent inline void requestRoutesEventLogService(App& app) 1369c4bf6374SJason M. Bills { 137022d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/") 1371ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 1372002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1373002d39b4SEd Tanous [&app](const crow::Request& req, 137422d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 137522d268cbSEd Tanous const std::string& systemName) { 13763ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 137745ca1b86SEd Tanous { 137845ca1b86SEd Tanous return; 137945ca1b86SEd Tanous } 138022d268cbSEd Tanous if (systemName != "system") 138122d268cbSEd Tanous { 138222d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 138322d268cbSEd Tanous systemName); 138422d268cbSEd Tanous return; 138522d268cbSEd Tanous } 1386c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1387029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 1388c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1389b25644a1SJanet Adkins "#LogService.v1_2_0.LogService"; 1390c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "Event Log Service"; 1391002d39b4SEd Tanous asyncResp->res.jsonValue["Description"] = "System Event Log Service"; 1392c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "EventLog"; 1393c4bf6374SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 13947c8c4058STejas Patil 13957c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 13962b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 13977c8c4058STejas Patil 13987c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 13997c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 14007c8c4058STejas Patil redfishDateTimeOffset.second; 14017c8c4058STejas Patil 14021476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 14031476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1404e7d6c8b2SGunnar Mills asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 1405e7d6c8b2SGunnar Mills 14060fda0f12SGeorge Liu {"target", 14070fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog"}}; 14087e860f15SJohn Edward Broadbent }); 1409489640c6SJason M. Bills } 1410489640c6SJason M. Bills 14117e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogClear(App& app) 1412489640c6SJason M. Bills { 14134978b63fSJason M. Bills BMCWEB_ROUTE( 14144978b63fSJason M. Bills app, 141522d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/") 1416432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 14177e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 141845ca1b86SEd Tanous [&app](const crow::Request& req, 141922d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 142022d268cbSEd Tanous const std::string& systemName) { 14213ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 142245ca1b86SEd Tanous { 142345ca1b86SEd Tanous return; 142445ca1b86SEd Tanous } 142522d268cbSEd Tanous if (systemName != "system") 142622d268cbSEd Tanous { 142722d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 142822d268cbSEd Tanous systemName); 142922d268cbSEd Tanous return; 143022d268cbSEd Tanous } 1431489640c6SJason M. Bills // Clear the EventLog by deleting the log files 1432489640c6SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1433489640c6SJason M. Bills if (getRedfishLogFiles(redfishLogFiles)) 1434489640c6SJason M. Bills { 1435489640c6SJason M. Bills for (const std::filesystem::path& file : redfishLogFiles) 1436489640c6SJason M. Bills { 1437489640c6SJason M. Bills std::error_code ec; 1438489640c6SJason M. Bills std::filesystem::remove(file, ec); 1439489640c6SJason M. Bills } 1440489640c6SJason M. Bills } 1441489640c6SJason M. Bills 1442489640c6SJason M. Bills // Reload rsyslog so it knows to start new log files 1443489640c6SJason M. Bills crow::connections::systemBus->async_method_call( 14445e7e2dc5SEd Tanous [asyncResp](const boost::system::error_code& ec) { 1445489640c6SJason M. Bills if (ec) 1446489640c6SJason M. Bills { 144762598e31SEd Tanous BMCWEB_LOG_ERROR("Failed to reload rsyslog: {}", ec); 1448489640c6SJason M. Bills messages::internalError(asyncResp->res); 1449489640c6SJason M. Bills return; 1450489640c6SJason M. Bills } 1451489640c6SJason M. Bills 1452489640c6SJason M. Bills messages::success(asyncResp->res); 1453489640c6SJason M. Bills }, 1454489640c6SJason M. Bills "org.freedesktop.systemd1", "/org/freedesktop/systemd1", 1455002d39b4SEd Tanous "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service", 1456002d39b4SEd Tanous "replace"); 14577e860f15SJohn Edward Broadbent }); 1458c4bf6374SJason M. Bills } 1459c4bf6374SJason M. Bills 1460ac992cdeSJason M. Bills enum class LogParseError 1461ac992cdeSJason M. Bills { 1462ac992cdeSJason M. Bills success, 1463ac992cdeSJason M. Bills parseFailed, 1464ac992cdeSJason M. Bills messageIdNotInRegistry, 1465ac992cdeSJason M. Bills }; 1466ac992cdeSJason M. Bills 1467ac992cdeSJason M. Bills static LogParseError 1468ac992cdeSJason M. Bills fillEventLogEntryJson(const std::string& logEntryID, 1469b5a76932SEd Tanous const std::string& logEntry, 1470de703c5dSJason M. Bills nlohmann::json::object_t& logEntryJson) 1471c4bf6374SJason M. Bills { 147295820184SJason M. Bills // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1473cd225da8SJason M. Bills // First get the Timestamp 1474f23b7296SEd Tanous size_t space = logEntry.find_first_of(' '); 1475cd225da8SJason M. Bills if (space == std::string::npos) 147695820184SJason M. Bills { 1477ac992cdeSJason M. Bills return LogParseError::parseFailed; 147895820184SJason M. Bills } 1479cd225da8SJason M. Bills std::string timestamp = logEntry.substr(0, space); 1480cd225da8SJason M. Bills // Then get the log contents 1481f23b7296SEd Tanous size_t entryStart = logEntry.find_first_not_of(' ', space); 1482cd225da8SJason M. Bills if (entryStart == std::string::npos) 1483cd225da8SJason M. Bills { 1484ac992cdeSJason M. Bills return LogParseError::parseFailed; 1485cd225da8SJason M. Bills } 1486cd225da8SJason M. Bills std::string_view entry(logEntry); 1487cd225da8SJason M. Bills entry.remove_prefix(entryStart); 1488cd225da8SJason M. Bills // Use split to separate the entry into its fields 1489cd225da8SJason M. Bills std::vector<std::string> logEntryFields; 149050ebd4afSEd Tanous bmcweb::split(logEntryFields, entry, ','); 1491cd225da8SJason M. Bills // We need at least a MessageId to be valid 14921e6deaf6SEd Tanous auto logEntryIter = logEntryFields.begin(); 14931e6deaf6SEd Tanous if (logEntryIter == logEntryFields.end()) 1494cd225da8SJason M. Bills { 1495ac992cdeSJason M. Bills return LogParseError::parseFailed; 1496cd225da8SJason M. Bills } 14971e6deaf6SEd Tanous std::string& messageID = *logEntryIter; 14984851d45dSJason M. Bills // Get the Message from the MessageRegistry 1499fffb8c1fSEd Tanous const registries::Message* message = registries::getMessage(messageID); 1500c4bf6374SJason M. Bills 15011e6deaf6SEd Tanous logEntryIter++; 150254417b02SSui Chen if (message == nullptr) 1503c4bf6374SJason M. Bills { 150462598e31SEd Tanous BMCWEB_LOG_WARNING("Log entry not found in registry: {}", logEntry); 1505ac992cdeSJason M. Bills return LogParseError::messageIdNotInRegistry; 1506c4bf6374SJason M. Bills } 1507c4bf6374SJason M. Bills 15081e6deaf6SEd Tanous std::vector<std::string_view> messageArgs(logEntryIter, 15091e6deaf6SEd Tanous logEntryFields.end()); 1510c05bba45SEd Tanous messageArgs.resize(message->numberOfArgs); 1511c05bba45SEd Tanous 15121e6deaf6SEd Tanous std::string msg = redfish::registries::fillMessageArgs(messageArgs, 15131e6deaf6SEd Tanous message->message); 15141e6deaf6SEd Tanous if (msg.empty()) 151515a86ff6SJason M. Bills { 15161e6deaf6SEd Tanous return LogParseError::parseFailed; 151715a86ff6SJason M. Bills } 15184851d45dSJason M. Bills 151995820184SJason M. Bills // Get the Created time from the timestamp. The log timestamp is in RFC3339 152095820184SJason M. Bills // format which matches the Redfish format except for the fractional seconds 152195820184SJason M. Bills // between the '.' and the '+', so just remove them. 1522f23b7296SEd Tanous std::size_t dot = timestamp.find_first_of('.'); 1523f23b7296SEd Tanous std::size_t plus = timestamp.find_first_of('+'); 152495820184SJason M. Bills if (dot != std::string::npos && plus != std::string::npos) 1525c4bf6374SJason M. Bills { 152695820184SJason M. Bills timestamp.erase(dot, plus - dot); 1527c4bf6374SJason M. Bills } 1528c4bf6374SJason M. Bills 1529c4bf6374SJason M. Bills // Fill in the log entry with the gathered data 15309c11a172SVijay Lobo logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 1531ef4c65b7SEd Tanous logEntryJson["@odata.id"] = boost::urls::format( 1532ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}", 1533ef4c65b7SEd Tanous logEntryID); 153484afc48bSJason M. Bills logEntryJson["Name"] = "System Event Log Entry"; 153584afc48bSJason M. Bills logEntryJson["Id"] = logEntryID; 153684afc48bSJason M. Bills logEntryJson["Message"] = std::move(msg); 153784afc48bSJason M. Bills logEntryJson["MessageId"] = std::move(messageID); 153884afc48bSJason M. Bills logEntryJson["MessageArgs"] = messageArgs; 153984afc48bSJason M. Bills logEntryJson["EntryType"] = "Event"; 154084afc48bSJason M. Bills logEntryJson["Severity"] = message->messageSeverity; 154184afc48bSJason M. Bills logEntryJson["Created"] = std::move(timestamp); 1542ac992cdeSJason M. Bills return LogParseError::success; 1543c4bf6374SJason M. Bills } 1544c4bf6374SJason M. Bills 15457e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntryCollection(App& app) 1546c4bf6374SJason M. Bills { 154722d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/") 15488b6a35f0SGunnar Mills .privileges(redfish::privileges::getLogEntryCollection) 1549002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1550002d39b4SEd Tanous [&app](const crow::Request& req, 155122d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 155222d268cbSEd Tanous const std::string& systemName) { 1553c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 1554c937d2bfSEd Tanous .canDelegateTop = true, 1555c937d2bfSEd Tanous .canDelegateSkip = true, 1556c937d2bfSEd Tanous }; 1557c937d2bfSEd Tanous query_param::Query delegatedQuery; 1558c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 15593ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 1560c4bf6374SJason M. Bills { 1561c4bf6374SJason M. Bills return; 1562c4bf6374SJason M. Bills } 1563*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 15647f3e84a1SEd Tanous { 15657f3e84a1SEd Tanous // Option currently returns no systems. TBD 15667f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 15677f3e84a1SEd Tanous systemName); 15687f3e84a1SEd Tanous return; 15697f3e84a1SEd Tanous } 157022d268cbSEd Tanous if (systemName != "system") 157122d268cbSEd Tanous { 157222d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 157322d268cbSEd Tanous systemName); 157422d268cbSEd Tanous return; 157522d268cbSEd Tanous } 157622d268cbSEd Tanous 15775143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 15783648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 15793648c8beSEd Tanous 15807e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 15817e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1582c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1583c4bf6374SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 1584c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1585029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1586c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 1587c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 1588c4bf6374SJason M. Bills "Collection of System Event Log Entries"; 1589cb92c03bSAndrew Geissler 15904978b63fSJason M. Bills nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1591c4bf6374SJason M. Bills logEntryArray = nlohmann::json::array(); 15927e860f15SJohn Edward Broadbent // Go through the log files and create a unique ID for each 15937e860f15SJohn Edward Broadbent // entry 159495820184SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 159595820184SJason M. Bills getRedfishLogFiles(redfishLogFiles); 1596b01bf299SEd Tanous uint64_t entryCount = 0; 1597cd225da8SJason M. Bills std::string logEntry; 159895820184SJason M. Bills 15997e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 16007e860f15SJohn Edward Broadbent // backwards 1601002d39b4SEd Tanous for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1602002d39b4SEd Tanous it++) 1603c4bf6374SJason M. Bills { 1604cd225da8SJason M. Bills std::ifstream logStream(*it); 160595820184SJason M. Bills if (!logStream.is_open()) 1606c4bf6374SJason M. Bills { 1607c4bf6374SJason M. Bills continue; 1608c4bf6374SJason M. Bills } 1609c4bf6374SJason M. Bills 1610e85d6b16SJason M. Bills // Reset the unique ID on the first entry 1611e85d6b16SJason M. Bills bool firstEntry = true; 161295820184SJason M. Bills while (std::getline(logStream, logEntry)) 161395820184SJason M. Bills { 1614c4bf6374SJason M. Bills std::string idStr; 1615e85d6b16SJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1616c4bf6374SJason M. Bills { 1617c4bf6374SJason M. Bills continue; 1618c4bf6374SJason M. Bills } 1619e85d6b16SJason M. Bills firstEntry = false; 1620e85d6b16SJason M. Bills 1621de703c5dSJason M. Bills nlohmann::json::object_t bmcLogEntry; 162289492a15SPatrick Williams LogParseError status = fillEventLogEntryJson(idStr, logEntry, 162389492a15SPatrick Williams bmcLogEntry); 1624ac992cdeSJason M. Bills if (status == LogParseError::messageIdNotInRegistry) 1625ac992cdeSJason M. Bills { 1626ac992cdeSJason M. Bills continue; 1627ac992cdeSJason M. Bills } 1628ac992cdeSJason M. Bills if (status != LogParseError::success) 1629c4bf6374SJason M. Bills { 1630c4bf6374SJason M. Bills messages::internalError(asyncResp->res); 1631c4bf6374SJason M. Bills return; 1632c4bf6374SJason M. Bills } 1633de703c5dSJason M. Bills 1634de703c5dSJason M. Bills entryCount++; 1635de703c5dSJason M. Bills // Handle paging using skip (number of entries to skip from the 1636de703c5dSJason M. Bills // start) and top (number of entries to display) 16373648c8beSEd Tanous if (entryCount <= skip || entryCount > skip + top) 1638de703c5dSJason M. Bills { 1639de703c5dSJason M. Bills continue; 1640de703c5dSJason M. Bills } 1641de703c5dSJason M. Bills 1642b2ba3072SPatrick Williams logEntryArray.emplace_back(std::move(bmcLogEntry)); 1643c4bf6374SJason M. Bills } 164495820184SJason M. Bills } 1645c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 16463648c8beSEd Tanous if (skip + top < entryCount) 1647c4bf6374SJason M. Bills { 1648c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 16494978b63fSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries?$skip=" + 16503648c8beSEd Tanous std::to_string(skip + top); 1651c4bf6374SJason M. Bills } 16527e860f15SJohn Edward Broadbent }); 1653897967deSJason M. Bills } 1654897967deSJason M. Bills 16557e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntry(App& app) 1656897967deSJason M. Bills { 16577e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 165822d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 1659ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 16607e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 166145ca1b86SEd Tanous [&app](const crow::Request& req, 16627e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 166322d268cbSEd Tanous const std::string& systemName, const std::string& param) { 16643ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 166545ca1b86SEd Tanous { 166645ca1b86SEd Tanous return; 166745ca1b86SEd Tanous } 1668*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 16697f3e84a1SEd Tanous { 16707f3e84a1SEd Tanous // Option currently returns no systems. TBD 16717f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 16727f3e84a1SEd Tanous systemName); 16737f3e84a1SEd Tanous return; 16747f3e84a1SEd Tanous } 167522d268cbSEd Tanous 167622d268cbSEd Tanous if (systemName != "system") 167722d268cbSEd Tanous { 167822d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 167922d268cbSEd Tanous systemName); 168022d268cbSEd Tanous return; 168122d268cbSEd Tanous } 168222d268cbSEd Tanous 16837e860f15SJohn Edward Broadbent const std::string& targetID = param; 16848d1b46d7Szhanghch05 16857e860f15SJohn Edward Broadbent // Go through the log files and check the unique ID for each 16867e860f15SJohn Edward Broadbent // entry to find the target entry 1687897967deSJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1688897967deSJason M. Bills getRedfishLogFiles(redfishLogFiles); 1689897967deSJason M. Bills std::string logEntry; 1690897967deSJason M. Bills 16917e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 16927e860f15SJohn Edward Broadbent // backwards 1693002d39b4SEd Tanous for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1694002d39b4SEd Tanous it++) 1695897967deSJason M. Bills { 1696897967deSJason M. Bills std::ifstream logStream(*it); 1697897967deSJason M. Bills if (!logStream.is_open()) 1698897967deSJason M. Bills { 1699897967deSJason M. Bills continue; 1700897967deSJason M. Bills } 1701897967deSJason M. Bills 1702897967deSJason M. Bills // Reset the unique ID on the first entry 1703897967deSJason M. Bills bool firstEntry = true; 1704897967deSJason M. Bills while (std::getline(logStream, logEntry)) 1705897967deSJason M. Bills { 1706897967deSJason M. Bills std::string idStr; 1707897967deSJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1708897967deSJason M. Bills { 1709897967deSJason M. Bills continue; 1710897967deSJason M. Bills } 1711897967deSJason M. Bills firstEntry = false; 1712897967deSJason M. Bills 1713897967deSJason M. Bills if (idStr == targetID) 1714897967deSJason M. Bills { 1715de703c5dSJason M. Bills nlohmann::json::object_t bmcLogEntry; 1716ac992cdeSJason M. Bills LogParseError status = 1717ac992cdeSJason M. Bills fillEventLogEntryJson(idStr, logEntry, bmcLogEntry); 1718ac992cdeSJason M. Bills if (status != LogParseError::success) 1719897967deSJason M. Bills { 1720897967deSJason M. Bills messages::internalError(asyncResp->res); 1721897967deSJason M. Bills return; 1722897967deSJason M. Bills } 1723d405bb51SJason M. Bills asyncResp->res.jsonValue.update(bmcLogEntry); 1724897967deSJason M. Bills return; 1725897967deSJason M. Bills } 1726897967deSJason M. Bills } 1727897967deSJason M. Bills } 1728897967deSJason M. Bills // Requested ID was not found 17299db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", targetID); 17307e860f15SJohn Edward Broadbent }); 173108a4e4b5SAnthony Wilson } 173208a4e4b5SAnthony Wilson 17337e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryCollection(App& app) 173408a4e4b5SAnthony Wilson { 173522d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/") 1736ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 1737002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1738002d39b4SEd Tanous [&app](const crow::Request& req, 173922d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 174022d268cbSEd Tanous const std::string& systemName) { 17413ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 174245ca1b86SEd Tanous { 174345ca1b86SEd Tanous return; 174445ca1b86SEd Tanous } 1745*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 17467f3e84a1SEd Tanous { 17477f3e84a1SEd Tanous // Option currently returns no systems. TBD 17487f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 17497f3e84a1SEd Tanous systemName); 17507f3e84a1SEd Tanous return; 17517f3e84a1SEd Tanous } 175222d268cbSEd Tanous if (systemName != "system") 175322d268cbSEd Tanous { 175422d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 175522d268cbSEd Tanous systemName); 175622d268cbSEd Tanous return; 175722d268cbSEd Tanous } 175822d268cbSEd Tanous 17597e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 17607e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 176108a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.type"] = 176208a4e4b5SAnthony Wilson "#LogEntryCollection.LogEntryCollection"; 176308a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.id"] = 176408a4e4b5SAnthony Wilson "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 176508a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 176608a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Description"] = 176708a4e4b5SAnthony Wilson "Collection of System Event Log Entries"; 176808a4e4b5SAnthony Wilson 1769cb92c03bSAndrew Geissler // DBus implementation of EventLog/Entries 1770cb92c03bSAndrew Geissler // Make call to Logging Service to find all log entry objects 17715eb468daSGeorge Liu sdbusplus::message::object_path path("/xyz/openbmc_project/logging"); 17725eb468daSGeorge Liu dbus::utility::getManagedObjects( 17735eb468daSGeorge Liu "xyz.openbmc_project.Logging", path, 17745e7e2dc5SEd Tanous [asyncResp](const boost::system::error_code& ec, 1775914e2d5dSEd Tanous const dbus::utility::ManagedObjectType& resp) { 1776cb92c03bSAndrew Geissler if (ec) 1777cb92c03bSAndrew Geissler { 1778cb92c03bSAndrew Geissler // TODO Handle for specific error code 177962598e31SEd Tanous BMCWEB_LOG_ERROR( 178062598e31SEd Tanous "getLogEntriesIfaceData resp_handler got error {}", ec); 1781cb92c03bSAndrew Geissler messages::internalError(asyncResp->res); 1782cb92c03bSAndrew Geissler return; 1783cb92c03bSAndrew Geissler } 17843544d2a7SEd Tanous nlohmann::json::array_t entriesArray; 17859eb808c1SEd Tanous for (const auto& objectPath : resp) 1786cb92c03bSAndrew Geissler { 1787914e2d5dSEd Tanous const uint32_t* id = nullptr; 1788c419c759SEd Tanous const uint64_t* timestamp = nullptr; 1789c419c759SEd Tanous const uint64_t* updateTimestamp = nullptr; 1790914e2d5dSEd Tanous const std::string* severity = nullptr; 1791914e2d5dSEd Tanous const std::string* message = nullptr; 1792914e2d5dSEd Tanous const std::string* filePath = nullptr; 17939c11a172SVijay Lobo const std::string* resolution = nullptr; 179475710de2SXiaochao Ma bool resolved = false; 17959017faf2SAbhishek Patel const std::string* notify = nullptr; 17969017faf2SAbhishek Patel 17979eb808c1SEd Tanous for (const auto& interfaceMap : objectPath.second) 1798f86bb901SAdriana Kobylak { 1799f86bb901SAdriana Kobylak if (interfaceMap.first == 1800f86bb901SAdriana Kobylak "xyz.openbmc_project.Logging.Entry") 1801f86bb901SAdriana Kobylak { 1802002d39b4SEd Tanous for (const auto& propertyMap : interfaceMap.second) 1803cb92c03bSAndrew Geissler { 1804cb92c03bSAndrew Geissler if (propertyMap.first == "Id") 1805cb92c03bSAndrew Geissler { 1806002d39b4SEd Tanous id = std::get_if<uint32_t>(&propertyMap.second); 1807cb92c03bSAndrew Geissler } 1808cb92c03bSAndrew Geissler else if (propertyMap.first == "Timestamp") 1809cb92c03bSAndrew Geissler { 1810002d39b4SEd Tanous timestamp = 1811002d39b4SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 18127e860f15SJohn Edward Broadbent } 1813002d39b4SEd Tanous else if (propertyMap.first == "UpdateTimestamp") 18147e860f15SJohn Edward Broadbent { 1815002d39b4SEd Tanous updateTimestamp = 1816002d39b4SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 18177e860f15SJohn Edward Broadbent } 18187e860f15SJohn Edward Broadbent else if (propertyMap.first == "Severity") 18197e860f15SJohn Edward Broadbent { 18207e860f15SJohn Edward Broadbent severity = std::get_if<std::string>( 18217e860f15SJohn Edward Broadbent &propertyMap.second); 18227e860f15SJohn Edward Broadbent } 18239c11a172SVijay Lobo else if (propertyMap.first == "Resolution") 18249c11a172SVijay Lobo { 18259c11a172SVijay Lobo resolution = std::get_if<std::string>( 18269c11a172SVijay Lobo &propertyMap.second); 18279c11a172SVijay Lobo } 18287e860f15SJohn Edward Broadbent else if (propertyMap.first == "Message") 18297e860f15SJohn Edward Broadbent { 18307e860f15SJohn Edward Broadbent message = std::get_if<std::string>( 18317e860f15SJohn Edward Broadbent &propertyMap.second); 18327e860f15SJohn Edward Broadbent } 18337e860f15SJohn Edward Broadbent else if (propertyMap.first == "Resolved") 18347e860f15SJohn Edward Broadbent { 1835914e2d5dSEd Tanous const bool* resolveptr = 1836002d39b4SEd Tanous std::get_if<bool>(&propertyMap.second); 18377e860f15SJohn Edward Broadbent if (resolveptr == nullptr) 18387e860f15SJohn Edward Broadbent { 1839002d39b4SEd Tanous messages::internalError(asyncResp->res); 18407e860f15SJohn Edward Broadbent return; 18417e860f15SJohn Edward Broadbent } 18427e860f15SJohn Edward Broadbent resolved = *resolveptr; 18437e860f15SJohn Edward Broadbent } 18449017faf2SAbhishek Patel else if (propertyMap.first == 18459017faf2SAbhishek Patel "ServiceProviderNotify") 18469017faf2SAbhishek Patel { 18479017faf2SAbhishek Patel notify = std::get_if<std::string>( 18489017faf2SAbhishek Patel &propertyMap.second); 18499017faf2SAbhishek Patel if (notify == nullptr) 18509017faf2SAbhishek Patel { 18519017faf2SAbhishek Patel messages::internalError(asyncResp->res); 18529017faf2SAbhishek Patel return; 18539017faf2SAbhishek Patel } 18549017faf2SAbhishek Patel } 18557e860f15SJohn Edward Broadbent } 18567e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 18577e860f15SJohn Edward Broadbent severity == nullptr) 18587e860f15SJohn Edward Broadbent { 18597e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 18607e860f15SJohn Edward Broadbent return; 18617e860f15SJohn Edward Broadbent } 18627e860f15SJohn Edward Broadbent } 18637e860f15SJohn Edward Broadbent else if (interfaceMap.first == 18647e860f15SJohn Edward Broadbent "xyz.openbmc_project.Common.FilePath") 18657e860f15SJohn Edward Broadbent { 1866002d39b4SEd Tanous for (const auto& propertyMap : interfaceMap.second) 18677e860f15SJohn Edward Broadbent { 18687e860f15SJohn Edward Broadbent if (propertyMap.first == "Path") 18697e860f15SJohn Edward Broadbent { 18707e860f15SJohn Edward Broadbent filePath = std::get_if<std::string>( 18717e860f15SJohn Edward Broadbent &propertyMap.second); 18727e860f15SJohn Edward Broadbent } 18737e860f15SJohn Edward Broadbent } 18747e860f15SJohn Edward Broadbent } 18757e860f15SJohn Edward Broadbent } 18767e860f15SJohn Edward Broadbent // Object path without the 18777e860f15SJohn Edward Broadbent // xyz.openbmc_project.Logging.Entry interface, ignore 18787e860f15SJohn Edward Broadbent // and continue. 18797e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 1880c419c759SEd Tanous severity == nullptr || timestamp == nullptr || 1881c419c759SEd Tanous updateTimestamp == nullptr) 18827e860f15SJohn Edward Broadbent { 18837e860f15SJohn Edward Broadbent continue; 18847e860f15SJohn Edward Broadbent } 18853544d2a7SEd Tanous nlohmann::json& thisEntry = entriesArray.emplace_back(); 18869c11a172SVijay Lobo thisEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 1887ef4c65b7SEd Tanous thisEntry["@odata.id"] = boost::urls::format( 1888ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}", 1889ef4c65b7SEd Tanous std::to_string(*id)); 18907e860f15SJohn Edward Broadbent thisEntry["Name"] = "System Event Log Entry"; 18917e860f15SJohn Edward Broadbent thisEntry["Id"] = std::to_string(*id); 18927e860f15SJohn Edward Broadbent thisEntry["Message"] = *message; 18937e860f15SJohn Edward Broadbent thisEntry["Resolved"] = resolved; 18949c11a172SVijay Lobo if ((resolution != nullptr) && (!(*resolution).empty())) 18959c11a172SVijay Lobo { 18969c11a172SVijay Lobo thisEntry["Resolution"] = *resolution; 18979c11a172SVijay Lobo } 18989017faf2SAbhishek Patel std::optional<bool> notifyAction = 18999017faf2SAbhishek Patel getProviderNotifyAction(*notify); 19009017faf2SAbhishek Patel if (notifyAction) 19019017faf2SAbhishek Patel { 19029017faf2SAbhishek Patel thisEntry["ServiceProviderNotified"] = *notifyAction; 19039017faf2SAbhishek Patel } 19047e860f15SJohn Edward Broadbent thisEntry["EntryType"] = "Event"; 19057e860f15SJohn Edward Broadbent thisEntry["Severity"] = 19067e860f15SJohn Edward Broadbent translateSeverityDbusToRedfish(*severity); 19077e860f15SJohn Edward Broadbent thisEntry["Created"] = 19082b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*timestamp); 19097e860f15SJohn Edward Broadbent thisEntry["Modified"] = 19102b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 19117e860f15SJohn Edward Broadbent if (filePath != nullptr) 19127e860f15SJohn Edward Broadbent { 19137e860f15SJohn Edward Broadbent thisEntry["AdditionalDataURI"] = 19140fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 19157e860f15SJohn Edward Broadbent std::to_string(*id) + "/attachment"; 19167e860f15SJohn Edward Broadbent } 19177e860f15SJohn Edward Broadbent } 19183544d2a7SEd Tanous std::ranges::sort(entriesArray, [](const nlohmann::json& left, 19193544d2a7SEd Tanous const nlohmann::json& right) { 19207e860f15SJohn Edward Broadbent return (left["Id"] <= right["Id"]); 19217e860f15SJohn Edward Broadbent }); 19227e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members@odata.count"] = 19237e860f15SJohn Edward Broadbent entriesArray.size(); 19243544d2a7SEd Tanous asyncResp->res.jsonValue["Members"] = std::move(entriesArray); 19255eb468daSGeorge Liu }); 19267e860f15SJohn Edward Broadbent }); 19277e860f15SJohn Edward Broadbent } 19287e860f15SJohn Edward Broadbent 19297e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app) 19307e860f15SJohn Edward Broadbent { 19317e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 193222d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 1933ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 1934002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1935002d39b4SEd Tanous [&app](const crow::Request& req, 19367e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 193722d268cbSEd Tanous const std::string& systemName, const std::string& param) { 19383ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 19397e860f15SJohn Edward Broadbent { 194045ca1b86SEd Tanous return; 194145ca1b86SEd Tanous } 1942*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 19437f3e84a1SEd Tanous { 19447f3e84a1SEd Tanous // Option currently returns no systems. TBD 19457f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 19467f3e84a1SEd Tanous systemName); 19477f3e84a1SEd Tanous return; 19487f3e84a1SEd Tanous } 194922d268cbSEd Tanous if (systemName != "system") 195022d268cbSEd Tanous { 195122d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 195222d268cbSEd Tanous systemName); 195322d268cbSEd Tanous return; 195422d268cbSEd Tanous } 195522d268cbSEd Tanous 19567e860f15SJohn Edward Broadbent std::string entryID = param; 19577e860f15SJohn Edward Broadbent dbus::utility::escapePathForDbus(entryID); 19587e860f15SJohn Edward Broadbent 19597e860f15SJohn Edward Broadbent // DBus implementation of EventLog/Entries 19607e860f15SJohn Edward Broadbent // Make call to Logging Service to find all log entry objects 1961d1bde9e5SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 1962d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, "xyz.openbmc_project.Logging", 1963d1bde9e5SKrzysztof Grobelny "/xyz/openbmc_project/logging/entry/" + entryID, "", 19645e7e2dc5SEd Tanous [asyncResp, entryID](const boost::system::error_code& ec, 1965b9d36b47SEd Tanous const dbus::utility::DBusPropertiesMap& resp) { 19667e860f15SJohn Edward Broadbent if (ec.value() == EBADR) 19677e860f15SJohn Edward Broadbent { 1968d1bde9e5SKrzysztof Grobelny messages::resourceNotFound(asyncResp->res, "EventLogEntry", 1969d1bde9e5SKrzysztof Grobelny entryID); 19707e860f15SJohn Edward Broadbent return; 19717e860f15SJohn Edward Broadbent } 19727e860f15SJohn Edward Broadbent if (ec) 19737e860f15SJohn Edward Broadbent { 197462598e31SEd Tanous BMCWEB_LOG_ERROR( 197562598e31SEd Tanous "EventLogEntry (DBus) resp_handler got error {}", ec); 19767e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 19777e860f15SJohn Edward Broadbent return; 19787e860f15SJohn Edward Broadbent } 1979914e2d5dSEd Tanous const uint32_t* id = nullptr; 1980c419c759SEd Tanous const uint64_t* timestamp = nullptr; 1981c419c759SEd Tanous const uint64_t* updateTimestamp = nullptr; 1982914e2d5dSEd Tanous const std::string* severity = nullptr; 1983914e2d5dSEd Tanous const std::string* message = nullptr; 1984914e2d5dSEd Tanous const std::string* filePath = nullptr; 19859c11a172SVijay Lobo const std::string* resolution = nullptr; 19867e860f15SJohn Edward Broadbent bool resolved = false; 19879017faf2SAbhishek Patel const std::string* notify = nullptr; 19887e860f15SJohn Edward Broadbent 1989d1bde9e5SKrzysztof Grobelny const bool success = sdbusplus::unpackPropertiesNoThrow( 1990d1bde9e5SKrzysztof Grobelny dbus_utils::UnpackErrorPrinter(), resp, "Id", id, "Timestamp", 1991d1bde9e5SKrzysztof Grobelny timestamp, "UpdateTimestamp", updateTimestamp, "Severity", 19929c11a172SVijay Lobo severity, "Message", message, "Resolved", resolved, 19939017faf2SAbhishek Patel "Resolution", resolution, "Path", filePath, 19949017faf2SAbhishek Patel "ServiceProviderNotify", notify); 1995d1bde9e5SKrzysztof Grobelny 1996d1bde9e5SKrzysztof Grobelny if (!success) 199775710de2SXiaochao Ma { 199875710de2SXiaochao Ma messages::internalError(asyncResp->res); 199975710de2SXiaochao Ma return; 200075710de2SXiaochao Ma } 2001d1bde9e5SKrzysztof Grobelny 2002002d39b4SEd Tanous if (id == nullptr || message == nullptr || severity == nullptr || 20039017faf2SAbhishek Patel timestamp == nullptr || updateTimestamp == nullptr || 20049017faf2SAbhishek Patel notify == nullptr) 2005f86bb901SAdriana Kobylak { 2006ae34c8e8SAdriana Kobylak messages::internalError(asyncResp->res); 2007271584abSEd Tanous return; 2008271584abSEd Tanous } 20099017faf2SAbhishek Patel 2010f86bb901SAdriana Kobylak asyncResp->res.jsonValue["@odata.type"] = 20119c11a172SVijay Lobo "#LogEntry.v1_9_0.LogEntry"; 2012ef4c65b7SEd Tanous asyncResp->res.jsonValue["@odata.id"] = boost::urls::format( 2013ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}", 2014ef4c65b7SEd Tanous std::to_string(*id)); 201545ca1b86SEd Tanous asyncResp->res.jsonValue["Name"] = "System Event Log Entry"; 2016f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Id"] = std::to_string(*id); 2017f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Message"] = *message; 2018f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Resolved"] = resolved; 20199017faf2SAbhishek Patel std::optional<bool> notifyAction = getProviderNotifyAction(*notify); 20209017faf2SAbhishek Patel if (notifyAction) 20219017faf2SAbhishek Patel { 20229017faf2SAbhishek Patel asyncResp->res.jsonValue["ServiceProviderNotified"] = 20239017faf2SAbhishek Patel *notifyAction; 20249017faf2SAbhishek Patel } 20259c11a172SVijay Lobo if ((resolution != nullptr) && (!(*resolution).empty())) 20269c11a172SVijay Lobo { 20279c11a172SVijay Lobo asyncResp->res.jsonValue["Resolution"] = *resolution; 20289c11a172SVijay Lobo } 2029f86bb901SAdriana Kobylak asyncResp->res.jsonValue["EntryType"] = "Event"; 2030f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Severity"] = 2031f86bb901SAdriana Kobylak translateSeverityDbusToRedfish(*severity); 2032f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Created"] = 20332b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*timestamp); 2034f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Modified"] = 20352b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 2036f86bb901SAdriana Kobylak if (filePath != nullptr) 2037f86bb901SAdriana Kobylak { 2038f86bb901SAdriana Kobylak asyncResp->res.jsonValue["AdditionalDataURI"] = 2039e7dbd530SPotin Lai "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 2040e7dbd530SPotin Lai std::to_string(*id) + "/attachment"; 2041f86bb901SAdriana Kobylak } 2042d1bde9e5SKrzysztof Grobelny }); 20437e860f15SJohn Edward Broadbent }); 2044336e96c6SChicago Duan 20457e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 204622d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 2047ed398213SEd Tanous .privileges(redfish::privileges::patchLogEntry) 20487e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::patch)( 204945ca1b86SEd Tanous [&app](const crow::Request& req, 20507e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 205122d268cbSEd Tanous const std::string& systemName, const std::string& entryId) { 20523ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 205345ca1b86SEd Tanous { 205445ca1b86SEd Tanous return; 205545ca1b86SEd Tanous } 2056*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 20577f3e84a1SEd Tanous { 20587f3e84a1SEd Tanous // Option currently returns no systems. TBD 20597f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 20607f3e84a1SEd Tanous systemName); 20617f3e84a1SEd Tanous return; 20627f3e84a1SEd Tanous } 206322d268cbSEd Tanous if (systemName != "system") 206422d268cbSEd Tanous { 206522d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 206622d268cbSEd Tanous systemName); 206722d268cbSEd Tanous return; 206822d268cbSEd Tanous } 206975710de2SXiaochao Ma std::optional<bool> resolved; 207075710de2SXiaochao Ma 207115ed6780SWilly Tu if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved", 20727e860f15SJohn Edward Broadbent resolved)) 207375710de2SXiaochao Ma { 207475710de2SXiaochao Ma return; 207575710de2SXiaochao Ma } 207662598e31SEd Tanous BMCWEB_LOG_DEBUG("Set Resolved"); 207775710de2SXiaochao Ma 20783eb66652SAsmitha Karunanithi setDbusProperty(asyncResp, "xyz.openbmc_project.Logging", 20799ae226faSGeorge Liu "/xyz/openbmc_project/logging/entry/" + entryId, 20803eb66652SAsmitha Karunanithi "xyz.openbmc_project.Logging.Entry", "Resolved", 20813eb66652SAsmitha Karunanithi "Resolved", *resolved); 20827e860f15SJohn Edward Broadbent }); 208375710de2SXiaochao Ma 20847e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 208522d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 2086ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 2087ed398213SEd Tanous 2088002d39b4SEd Tanous .methods(boost::beast::http::verb::delete_)( 2089002d39b4SEd Tanous [&app](const crow::Request& req, 2090002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 209122d268cbSEd Tanous const std::string& systemName, const std::string& param) { 20923ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2093336e96c6SChicago Duan { 209445ca1b86SEd Tanous return; 209545ca1b86SEd Tanous } 2096*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 20977f3e84a1SEd Tanous { 20987f3e84a1SEd Tanous // Option currently returns no systems. TBD 20997f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 21007f3e84a1SEd Tanous systemName); 21017f3e84a1SEd Tanous return; 21027f3e84a1SEd Tanous } 210322d268cbSEd Tanous if (systemName != "system") 210422d268cbSEd Tanous { 210522d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 210622d268cbSEd Tanous systemName); 210722d268cbSEd Tanous return; 210822d268cbSEd Tanous } 210962598e31SEd Tanous BMCWEB_LOG_DEBUG("Do delete single event entries."); 2110336e96c6SChicago Duan 21117e860f15SJohn Edward Broadbent std::string entryID = param; 2112336e96c6SChicago Duan 2113336e96c6SChicago Duan dbus::utility::escapePathForDbus(entryID); 2114336e96c6SChicago Duan 2115336e96c6SChicago Duan // Process response from Logging service. 21165a39f77aSPatrick Williams auto respHandler = [asyncResp, 21175a39f77aSPatrick Williams entryID](const boost::system::error_code& ec) { 211862598e31SEd Tanous BMCWEB_LOG_DEBUG("EventLogEntry (DBus) doDelete callback: Done"); 2119336e96c6SChicago Duan if (ec) 2120336e96c6SChicago Duan { 21213de8d8baSGeorge Liu if (ec.value() == EBADR) 21223de8d8baSGeorge Liu { 212345ca1b86SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 212445ca1b86SEd Tanous entryID); 21253de8d8baSGeorge Liu return; 21263de8d8baSGeorge Liu } 2127336e96c6SChicago Duan // TODO Handle for specific error code 212862598e31SEd Tanous BMCWEB_LOG_ERROR( 212962598e31SEd Tanous "EventLogEntry (DBus) doDelete respHandler got error {}", 213062598e31SEd Tanous ec); 2131336e96c6SChicago Duan asyncResp->res.result( 2132336e96c6SChicago Duan boost::beast::http::status::internal_server_error); 2133336e96c6SChicago Duan return; 2134336e96c6SChicago Duan } 2135336e96c6SChicago Duan 2136336e96c6SChicago Duan asyncResp->res.result(boost::beast::http::status::ok); 2137336e96c6SChicago Duan }; 2138336e96c6SChicago Duan 2139336e96c6SChicago Duan // Make call to Logging service to request Delete Log 2140336e96c6SChicago Duan crow::connections::systemBus->async_method_call( 2141336e96c6SChicago Duan respHandler, "xyz.openbmc_project.Logging", 2142336e96c6SChicago Duan "/xyz/openbmc_project/logging/entry/" + entryID, 2143336e96c6SChicago Duan "xyz.openbmc_project.Object.Delete", "Delete"); 21447e860f15SJohn Edward Broadbent }); 2145400fd1fbSAdriana Kobylak } 2146400fd1fbSAdriana Kobylak 2147b7028ebfSSpencer Ku constexpr const char* hostLoggerFolderPath = "/var/log/console"; 2148b7028ebfSSpencer Ku 2149b7028ebfSSpencer Ku inline bool 2150b7028ebfSSpencer Ku getHostLoggerFiles(const std::string& hostLoggerFilePath, 2151b7028ebfSSpencer Ku std::vector<std::filesystem::path>& hostLoggerFiles) 2152b7028ebfSSpencer Ku { 2153b7028ebfSSpencer Ku std::error_code ec; 2154b7028ebfSSpencer Ku std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec); 2155b7028ebfSSpencer Ku if (ec) 2156b7028ebfSSpencer Ku { 2157bf2ddedeSCarson Labrado BMCWEB_LOG_WARNING("{}", ec.message()); 2158b7028ebfSSpencer Ku return false; 2159b7028ebfSSpencer Ku } 2160b7028ebfSSpencer Ku for (const std::filesystem::directory_entry& it : logPath) 2161b7028ebfSSpencer Ku { 2162b7028ebfSSpencer Ku std::string filename = it.path().filename(); 2163b7028ebfSSpencer Ku // Prefix of each log files is "log". Find the file and save the 2164b7028ebfSSpencer Ku // path 216511ba3979SEd Tanous if (filename.starts_with("log")) 2166b7028ebfSSpencer Ku { 2167b7028ebfSSpencer Ku hostLoggerFiles.emplace_back(it.path()); 2168b7028ebfSSpencer Ku } 2169b7028ebfSSpencer Ku } 2170b7028ebfSSpencer Ku // As the log files rotate, they are appended with a ".#" that is higher for 2171b7028ebfSSpencer Ku // the older logs. Since we start from oldest logs, sort the name in 2172b7028ebfSSpencer Ku // descending order. 2173b7028ebfSSpencer Ku std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(), 2174b7028ebfSSpencer Ku AlphanumLess<std::string>()); 2175b7028ebfSSpencer Ku 2176b7028ebfSSpencer Ku return true; 2177b7028ebfSSpencer Ku } 2178b7028ebfSSpencer Ku 217902cad96eSEd Tanous inline bool getHostLoggerEntries( 218002cad96eSEd Tanous const std::vector<std::filesystem::path>& hostLoggerFiles, uint64_t skip, 218102cad96eSEd Tanous uint64_t top, std::vector<std::string>& logEntries, size_t& logCount) 2182b7028ebfSSpencer Ku { 2183b7028ebfSSpencer Ku GzFileReader logFile; 2184b7028ebfSSpencer Ku 2185b7028ebfSSpencer Ku // Go though all log files and expose host logs. 2186b7028ebfSSpencer Ku for (const std::filesystem::path& it : hostLoggerFiles) 2187b7028ebfSSpencer Ku { 2188b7028ebfSSpencer Ku if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount)) 2189b7028ebfSSpencer Ku { 219062598e31SEd Tanous BMCWEB_LOG_ERROR("fail to expose host logs"); 2191b7028ebfSSpencer Ku return false; 2192b7028ebfSSpencer Ku } 2193b7028ebfSSpencer Ku } 2194b7028ebfSSpencer Ku // Get lastMessage from constructor by getter 2195b7028ebfSSpencer Ku std::string lastMessage = logFile.getLastMessage(); 2196b7028ebfSSpencer Ku if (!lastMessage.empty()) 2197b7028ebfSSpencer Ku { 2198b7028ebfSSpencer Ku logCount++; 2199b7028ebfSSpencer Ku if (logCount > skip && logCount <= (skip + top)) 2200b7028ebfSSpencer Ku { 2201b7028ebfSSpencer Ku logEntries.push_back(lastMessage); 2202b7028ebfSSpencer Ku } 2203b7028ebfSSpencer Ku } 2204b7028ebfSSpencer Ku return true; 2205b7028ebfSSpencer Ku } 2206b7028ebfSSpencer Ku 22076f056f24SEd Tanous inline void fillHostLoggerEntryJson(std::string_view logEntryID, 22086f056f24SEd Tanous std::string_view msg, 22096d6574c9SJason M. Bills nlohmann::json::object_t& logEntryJson) 2210b7028ebfSSpencer Ku { 2211b7028ebfSSpencer Ku // Fill in the log entry with the gathered data. 22129c11a172SVijay Lobo logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 2213ef4c65b7SEd Tanous logEntryJson["@odata.id"] = boost::urls::format( 2214ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/{}", 2215ef4c65b7SEd Tanous logEntryID); 22166d6574c9SJason M. Bills logEntryJson["Name"] = "Host Logger Entry"; 22176d6574c9SJason M. Bills logEntryJson["Id"] = logEntryID; 22186d6574c9SJason M. Bills logEntryJson["Message"] = msg; 22196d6574c9SJason M. Bills logEntryJson["EntryType"] = "Oem"; 22206d6574c9SJason M. Bills logEntryJson["Severity"] = "OK"; 22216d6574c9SJason M. Bills logEntryJson["OemRecordFormat"] = "Host Logger Entry"; 2222b7028ebfSSpencer Ku } 2223b7028ebfSSpencer Ku 2224b7028ebfSSpencer Ku inline void requestRoutesSystemHostLogger(App& app) 2225b7028ebfSSpencer Ku { 222622d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/") 2227b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogService) 22281476687dSEd Tanous .methods(boost::beast::http::verb::get)( 22291476687dSEd Tanous [&app](const crow::Request& req, 223022d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 223122d268cbSEd Tanous const std::string& systemName) { 22323ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 223345ca1b86SEd Tanous { 223445ca1b86SEd Tanous return; 223545ca1b86SEd Tanous } 2236*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 22377f3e84a1SEd Tanous { 22387f3e84a1SEd Tanous // Option currently returns no systems. TBD 22397f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 22407f3e84a1SEd Tanous systemName); 22417f3e84a1SEd Tanous return; 22427f3e84a1SEd Tanous } 224322d268cbSEd Tanous if (systemName != "system") 224422d268cbSEd Tanous { 224522d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 224622d268cbSEd Tanous systemName); 224722d268cbSEd Tanous return; 224822d268cbSEd Tanous } 2249b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 2250b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger"; 2251b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 2252b25644a1SJanet Adkins "#LogService.v1_2_0.LogService"; 2253b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "Host Logger Service"; 2254b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = "Host Logger Service"; 2255b7028ebfSSpencer Ku asyncResp->res.jsonValue["Id"] = "HostLogger"; 22561476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 22571476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 2258b7028ebfSSpencer Ku }); 2259b7028ebfSSpencer Ku } 2260b7028ebfSSpencer Ku 2261b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerCollection(App& app) 2262b7028ebfSSpencer Ku { 2263b7028ebfSSpencer Ku BMCWEB_ROUTE(app, 226422d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/") 2265b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 2266002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2267002d39b4SEd Tanous [&app](const crow::Request& req, 226822d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 226922d268cbSEd Tanous const std::string& systemName) { 2270c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 2271c937d2bfSEd Tanous .canDelegateTop = true, 2272c937d2bfSEd Tanous .canDelegateSkip = true, 2273c937d2bfSEd Tanous }; 2274c937d2bfSEd Tanous query_param::Query delegatedQuery; 2275c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 22763ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 2277b7028ebfSSpencer Ku { 2278b7028ebfSSpencer Ku return; 2279b7028ebfSSpencer Ku } 2280*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 22817f3e84a1SEd Tanous { 22827f3e84a1SEd Tanous // Option currently returns no systems. TBD 22837f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 22847f3e84a1SEd Tanous systemName); 22857f3e84a1SEd Tanous return; 22867f3e84a1SEd Tanous } 228722d268cbSEd Tanous if (systemName != "system") 228822d268cbSEd Tanous { 228922d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 229022d268cbSEd Tanous systemName); 229122d268cbSEd Tanous return; 229222d268cbSEd Tanous } 2293b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 2294b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 2295b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 2296b7028ebfSSpencer Ku "#LogEntryCollection.LogEntryCollection"; 2297b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "HostLogger Entries"; 2298b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = 2299b7028ebfSSpencer Ku "Collection of HostLogger Entries"; 23000fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2301b7028ebfSSpencer Ku logEntryArray = nlohmann::json::array(); 2302b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = 0; 2303b7028ebfSSpencer Ku 2304b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 2305b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 2306b7028ebfSSpencer Ku { 2307bf2ddedeSCarson Labrado BMCWEB_LOG_DEBUG("Failed to get host log file path"); 2308b7028ebfSSpencer Ku return; 2309b7028ebfSSpencer Ku } 23103648c8beSEd Tanous // If we weren't provided top and skip limits, use the defaults. 23113648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 23125143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 2313b7028ebfSSpencer Ku size_t logCount = 0; 2314b7028ebfSSpencer Ku // This vector only store the entries we want to expose that 2315b7028ebfSSpencer Ku // control by skip and top. 2316b7028ebfSSpencer Ku std::vector<std::string> logEntries; 23173648c8beSEd Tanous if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries, 23183648c8beSEd Tanous logCount)) 2319b7028ebfSSpencer Ku { 2320b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 2321b7028ebfSSpencer Ku return; 2322b7028ebfSSpencer Ku } 2323b7028ebfSSpencer Ku // If vector is empty, that means skip value larger than total 2324b7028ebfSSpencer Ku // log count 232526f6976fSEd Tanous if (logEntries.empty()) 2326b7028ebfSSpencer Ku { 2327b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 2328b7028ebfSSpencer Ku return; 2329b7028ebfSSpencer Ku } 233026f6976fSEd Tanous if (!logEntries.empty()) 2331b7028ebfSSpencer Ku { 2332b7028ebfSSpencer Ku for (size_t i = 0; i < logEntries.size(); i++) 2333b7028ebfSSpencer Ku { 23346d6574c9SJason M. Bills nlohmann::json::object_t hostLogEntry; 23353648c8beSEd Tanous fillHostLoggerEntryJson(std::to_string(skip + i), logEntries[i], 23363648c8beSEd Tanous hostLogEntry); 2337b2ba3072SPatrick Williams logEntryArray.emplace_back(std::move(hostLogEntry)); 2338b7028ebfSSpencer Ku } 2339b7028ebfSSpencer Ku 2340b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 23413648c8beSEd Tanous if (skip + top < logCount) 2342b7028ebfSSpencer Ku { 2343b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.nextLink"] = 23440fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/HostLogger/Entries?$skip=" + 23453648c8beSEd Tanous std::to_string(skip + top); 2346b7028ebfSSpencer Ku } 2347b7028ebfSSpencer Ku } 2348b7028ebfSSpencer Ku }); 2349b7028ebfSSpencer Ku } 2350b7028ebfSSpencer Ku 2351b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerLogEntry(App& app) 2352b7028ebfSSpencer Ku { 2353b7028ebfSSpencer Ku BMCWEB_ROUTE( 235422d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/<str>/") 2355b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 2356b7028ebfSSpencer Ku .methods(boost::beast::http::verb::get)( 235745ca1b86SEd Tanous [&app](const crow::Request& req, 2358b7028ebfSSpencer Ku const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 235922d268cbSEd Tanous const std::string& systemName, const std::string& param) { 23603ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 236145ca1b86SEd Tanous { 236245ca1b86SEd Tanous return; 236345ca1b86SEd Tanous } 2364*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 23657f3e84a1SEd Tanous { 23667f3e84a1SEd Tanous // Option currently returns no systems. TBD 23677f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 23687f3e84a1SEd Tanous systemName); 23697f3e84a1SEd Tanous return; 23707f3e84a1SEd Tanous } 237122d268cbSEd Tanous if (systemName != "system") 237222d268cbSEd Tanous { 237322d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 237422d268cbSEd Tanous systemName); 237522d268cbSEd Tanous return; 237622d268cbSEd Tanous } 23776f056f24SEd Tanous std::string_view targetID = param; 2378b7028ebfSSpencer Ku 2379b7028ebfSSpencer Ku uint64_t idInt = 0; 2380ca45aa3cSEd Tanous 23816f056f24SEd Tanous auto [ptr, ec] = std::from_chars(targetID.begin(), targetID.end(), 238284396af9SPatrick Williams idInt); 23836f056f24SEd Tanous if (ec != std::errc{} || ptr != targetID.end()) 2384b7028ebfSSpencer Ku { 23859db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", param); 2386b7028ebfSSpencer Ku return; 2387b7028ebfSSpencer Ku } 2388b7028ebfSSpencer Ku 2389b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 2390b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 2391b7028ebfSSpencer Ku { 2392bf2ddedeSCarson Labrado BMCWEB_LOG_DEBUG("Failed to get host log file path"); 2393b7028ebfSSpencer Ku return; 2394b7028ebfSSpencer Ku } 2395b7028ebfSSpencer Ku 2396b7028ebfSSpencer Ku size_t logCount = 0; 23973648c8beSEd Tanous size_t top = 1; 2398b7028ebfSSpencer Ku std::vector<std::string> logEntries; 2399b7028ebfSSpencer Ku // We can get specific entry by skip and top. For example, if we 2400b7028ebfSSpencer Ku // want to get nth entry, we can set skip = n-1 and top = 1 to 2401b7028ebfSSpencer Ku // get that entry 2402002d39b4SEd Tanous if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, logEntries, 2403002d39b4SEd Tanous logCount)) 2404b7028ebfSSpencer Ku { 2405b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 2406b7028ebfSSpencer Ku return; 2407b7028ebfSSpencer Ku } 2408b7028ebfSSpencer Ku 2409b7028ebfSSpencer Ku if (!logEntries.empty()) 2410b7028ebfSSpencer Ku { 24116d6574c9SJason M. Bills nlohmann::json::object_t hostLogEntry; 24126d6574c9SJason M. Bills fillHostLoggerEntryJson(targetID, logEntries[0], hostLogEntry); 24136d6574c9SJason M. Bills asyncResp->res.jsonValue.update(hostLogEntry); 2414b7028ebfSSpencer Ku return; 2415b7028ebfSSpencer Ku } 2416b7028ebfSSpencer Ku 2417b7028ebfSSpencer Ku // Requested ID was not found 24189db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", param); 2419b7028ebfSSpencer Ku }); 2420b7028ebfSSpencer Ku } 2421b7028ebfSSpencer Ku 2422dd72e87bSClaire Weinan inline void handleBMCLogServicesCollectionGet( 2423fdd26906SClaire Weinan crow::App& app, const crow::Request& req, 2424fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 24251da66f75SEd Tanous { 24263ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 242745ca1b86SEd Tanous { 242845ca1b86SEd Tanous return; 242945ca1b86SEd Tanous } 24307e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 24317e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2432e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 24331da66f75SEd Tanous "#LogServiceCollection.LogServiceCollection"; 2434e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 2435e1f26343SJason M. Bills "/redfish/v1/Managers/bmc/LogServices"; 2436002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection"; 2437e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 24381da66f75SEd Tanous "Collection of LogServices for this Manager"; 2439002d39b4SEd Tanous nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 2440c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 2441fdd26906SClaire Weinan 2442*25b54dbaSEd Tanous if constexpr (BMCWEB_REDFISH_BMC_JOURNAL) 2443*25b54dbaSEd Tanous { 2444613dabeaSEd Tanous nlohmann::json::object_t journal; 2445613dabeaSEd Tanous journal["@odata.id"] = "/redfish/v1/Managers/bmc/LogServices/Journal"; 2446b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(journal)); 2447*25b54dbaSEd Tanous } 2448fdd26906SClaire Weinan 2449fdd26906SClaire Weinan asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size(); 2450fdd26906SClaire Weinan 2451*25b54dbaSEd Tanous if constexpr (BMCWEB_REDFISH_DUMP_LOG) 2452*25b54dbaSEd Tanous { 245315912159SGeorge Liu constexpr std::array<std::string_view, 1> interfaces = { 24547a1dbc48SGeorge Liu "xyz.openbmc_project.Collection.DeleteAll"}; 24557a1dbc48SGeorge Liu dbus::utility::getSubTreePaths( 24567a1dbc48SGeorge Liu "/xyz/openbmc_project/dump", 0, interfaces, 2457*25b54dbaSEd Tanous [asyncResp](const boost::system::error_code& ec, 2458*25b54dbaSEd Tanous const dbus::utility::MapperGetSubTreePathsResponse& 2459*25b54dbaSEd Tanous subTreePaths) { 2460fdd26906SClaire Weinan if (ec) 2461fdd26906SClaire Weinan { 246262598e31SEd Tanous BMCWEB_LOG_ERROR( 246362598e31SEd Tanous "handleBMCLogServicesCollectionGet respHandler got error {}", 246462598e31SEd Tanous ec); 2465fdd26906SClaire Weinan // Assume that getting an error simply means there are no dump 2466fdd26906SClaire Weinan // LogServices. Return without adding any error response. 2467fdd26906SClaire Weinan return; 2468fdd26906SClaire Weinan } 2469fdd26906SClaire Weinan 2470fdd26906SClaire Weinan nlohmann::json& logServiceArrayLocal = 2471fdd26906SClaire Weinan asyncResp->res.jsonValue["Members"]; 2472fdd26906SClaire Weinan 2473fdd26906SClaire Weinan for (const std::string& path : subTreePaths) 2474fdd26906SClaire Weinan { 2475fdd26906SClaire Weinan if (path == "/xyz/openbmc_project/dump/bmc") 2476fdd26906SClaire Weinan { 2477613dabeaSEd Tanous nlohmann::json::object_t member; 2478613dabeaSEd Tanous member["@odata.id"] = 2479613dabeaSEd Tanous "/redfish/v1/Managers/bmc/LogServices/Dump"; 2480b2ba3072SPatrick Williams logServiceArrayLocal.emplace_back(std::move(member)); 2481fdd26906SClaire Weinan } 2482fdd26906SClaire Weinan else if (path == "/xyz/openbmc_project/dump/faultlog") 2483fdd26906SClaire Weinan { 2484613dabeaSEd Tanous nlohmann::json::object_t member; 2485613dabeaSEd Tanous member["@odata.id"] = 2486613dabeaSEd Tanous "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2487b2ba3072SPatrick Williams logServiceArrayLocal.emplace_back(std::move(member)); 2488fdd26906SClaire Weinan } 2489fdd26906SClaire Weinan } 2490fdd26906SClaire Weinan 2491e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 2492fdd26906SClaire Weinan logServiceArrayLocal.size(); 24937a1dbc48SGeorge Liu }); 2494*25b54dbaSEd Tanous } 2495fdd26906SClaire Weinan } 2496fdd26906SClaire Weinan 2497fdd26906SClaire Weinan inline void requestRoutesBMCLogServiceCollection(App& app) 2498fdd26906SClaire Weinan { 2499fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/") 2500fdd26906SClaire Weinan .privileges(redfish::privileges::getLogServiceCollection) 2501fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 2502dd72e87bSClaire Weinan std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app))); 2503e1f26343SJason M. Bills } 2504e1f26343SJason M. Bills 25057e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogService(App& app) 2506e1f26343SJason M. Bills { 25077e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/") 2508ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 25097e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 251045ca1b86SEd Tanous [&app](const crow::Request& req, 251145ca1b86SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 25123ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 25137e860f15SJohn Edward Broadbent { 251445ca1b86SEd Tanous return; 251545ca1b86SEd Tanous } 2516e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2517b25644a1SJanet Adkins "#LogService.v1_2_0.LogService"; 25180f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 25190f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal"; 2520002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service"; 2521002d39b4SEd Tanous asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service"; 2522ed34a4adSEd Tanous asyncResp->res.jsonValue["Id"] = "Journal"; 2523e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 25247c8c4058STejas Patil 25257c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 25262b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 2527002d39b4SEd Tanous asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 25287c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 25297c8c4058STejas Patil redfishDateTimeOffset.second; 25307c8c4058STejas Patil 25311476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 25321476687dSEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 25337e860f15SJohn Edward Broadbent }); 2534e1f26343SJason M. Bills } 2535e1f26343SJason M. Bills 25363a48b3a2SJason M. Bills static int 25373a48b3a2SJason M. Bills fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID, 2538e1f26343SJason M. Bills sd_journal* journal, 25393a48b3a2SJason M. Bills nlohmann::json::object_t& bmcJournalLogEntryJson) 2540e1f26343SJason M. Bills { 2541e1f26343SJason M. Bills // Get the Log Entry contents 2542e1f26343SJason M. Bills int ret = 0; 2543e1f26343SJason M. Bills 2544a8fe54f0SJason M. Bills std::string message; 2545a8fe54f0SJason M. Bills std::string_view syslogID; 2546a8fe54f0SJason M. Bills ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID); 2547a8fe54f0SJason M. Bills if (ret < 0) 2548a8fe54f0SJason M. Bills { 2549bf2ddedeSCarson Labrado BMCWEB_LOG_DEBUG("Failed to read SYSLOG_IDENTIFIER field: {}", 255062598e31SEd Tanous strerror(-ret)); 2551a8fe54f0SJason M. Bills } 2552a8fe54f0SJason M. Bills if (!syslogID.empty()) 2553a8fe54f0SJason M. Bills { 2554a8fe54f0SJason M. Bills message += std::string(syslogID) + ": "; 2555a8fe54f0SJason M. Bills } 2556a8fe54f0SJason M. Bills 255739e77504SEd Tanous std::string_view msg; 255816428a1aSJason M. Bills ret = getJournalMetadata(journal, "MESSAGE", msg); 2559e1f26343SJason M. Bills if (ret < 0) 2560e1f26343SJason M. Bills { 256162598e31SEd Tanous BMCWEB_LOG_ERROR("Failed to read MESSAGE field: {}", strerror(-ret)); 2562e1f26343SJason M. Bills return 1; 2563e1f26343SJason M. Bills } 2564a8fe54f0SJason M. Bills message += std::string(msg); 2565e1f26343SJason M. Bills 2566e1f26343SJason M. Bills // Get the severity from the PRIORITY field 2567271584abSEd Tanous long int severity = 8; // Default to an invalid priority 256816428a1aSJason M. Bills ret = getJournalMetadata(journal, "PRIORITY", 10, severity); 2569e1f26343SJason M. Bills if (ret < 0) 2570e1f26343SJason M. Bills { 2571bf2ddedeSCarson Labrado BMCWEB_LOG_DEBUG("Failed to read PRIORITY field: {}", strerror(-ret)); 2572e1f26343SJason M. Bills } 2573e1f26343SJason M. Bills 2574e1f26343SJason M. Bills // Get the Created time from the timestamp 257516428a1aSJason M. Bills std::string entryTimeStr; 257616428a1aSJason M. Bills if (!getEntryTimestamp(journal, entryTimeStr)) 2577e1f26343SJason M. Bills { 257816428a1aSJason M. Bills return 1; 2579e1f26343SJason M. Bills } 2580e1f26343SJason M. Bills 2581e1f26343SJason M. Bills // Fill in the log entry with the gathered data 25829c11a172SVijay Lobo bmcJournalLogEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 2583ef4c65b7SEd Tanous bmcJournalLogEntryJson["@odata.id"] = boost::urls::format( 2584ef4c65b7SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/{}", 2585eddfc437SWilly Tu bmcJournalLogEntryID); 258684afc48bSJason M. Bills bmcJournalLogEntryJson["Name"] = "BMC Journal Entry"; 258784afc48bSJason M. Bills bmcJournalLogEntryJson["Id"] = bmcJournalLogEntryID; 258884afc48bSJason M. Bills bmcJournalLogEntryJson["Message"] = std::move(message); 258984afc48bSJason M. Bills bmcJournalLogEntryJson["EntryType"] = "Oem"; 2590ddf3564eSEd Tanous log_entry::EventSeverity severityEnum = log_entry::EventSeverity::OK; 2591ddf3564eSEd Tanous if (severity <= 2) 2592ddf3564eSEd Tanous { 2593ddf3564eSEd Tanous severityEnum = log_entry::EventSeverity::Critical; 2594ddf3564eSEd Tanous } 2595ddf3564eSEd Tanous else if (severity <= 4) 2596ddf3564eSEd Tanous { 2597ddf3564eSEd Tanous severityEnum = log_entry::EventSeverity::Warning; 2598ddf3564eSEd Tanous } 2599ddf3564eSEd Tanous 2600ddf3564eSEd Tanous bmcJournalLogEntryJson["Severity"] = severityEnum; 260184afc48bSJason M. Bills bmcJournalLogEntryJson["OemRecordFormat"] = "BMC Journal Entry"; 260284afc48bSJason M. Bills bmcJournalLogEntryJson["Created"] = std::move(entryTimeStr); 2603e1f26343SJason M. Bills return 0; 2604e1f26343SJason M. Bills } 2605e1f26343SJason M. Bills 26067e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntryCollection(App& app) 2607e1f26343SJason M. Bills { 26087e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/") 2609ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 2610002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2611002d39b4SEd Tanous [&app](const crow::Request& req, 2612002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2613c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 2614c937d2bfSEd Tanous .canDelegateTop = true, 2615c937d2bfSEd Tanous .canDelegateSkip = true, 2616c937d2bfSEd Tanous }; 2617c937d2bfSEd Tanous query_param::Query delegatedQuery; 2618c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 26193ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 2620193ad2faSJason M. Bills { 2621193ad2faSJason M. Bills return; 2622193ad2faSJason M. Bills } 26233648c8beSEd Tanous 26243648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 26255143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 26263648c8beSEd Tanous 26277e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 26287e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2629e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2630e1f26343SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 26310f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 26320f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 2633e1f26343SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries"; 2634e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2635e1f26343SJason M. Bills "Collection of BMC Journal Entries"; 26360fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2637e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 2638e1f26343SJason M. Bills 26397e860f15SJohn Edward Broadbent // Go through the journal and use the timestamp to create a 26407e860f15SJohn Edward Broadbent // unique ID for each entry 2641e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2642e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2643e1f26343SJason M. Bills if (ret < 0) 2644e1f26343SJason M. Bills { 264562598e31SEd Tanous BMCWEB_LOG_ERROR("failed to open journal: {}", strerror(-ret)); 2646f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2647e1f26343SJason M. Bills return; 2648e1f26343SJason M. Bills } 26490fda0f12SGeorge Liu std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 26500fda0f12SGeorge Liu journalTmp, sd_journal_close); 2651e1f26343SJason M. Bills journalTmp = nullptr; 2652b01bf299SEd Tanous uint64_t entryCount = 0; 2653e85d6b16SJason M. Bills // Reset the unique ID on the first entry 2654e85d6b16SJason M. Bills bool firstEntry = true; 2655e1f26343SJason M. Bills SD_JOURNAL_FOREACH(journal.get()) 2656e1f26343SJason M. Bills { 2657193ad2faSJason M. Bills entryCount++; 26587e860f15SJohn Edward Broadbent // Handle paging using skip (number of entries to skip from 26597e860f15SJohn Edward Broadbent // the start) and top (number of entries to display) 26603648c8beSEd Tanous if (entryCount <= skip || entryCount > skip + top) 2661193ad2faSJason M. Bills { 2662193ad2faSJason M. Bills continue; 2663193ad2faSJason M. Bills } 2664193ad2faSJason M. Bills 266516428a1aSJason M. Bills std::string idStr; 2666e85d6b16SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2667e1f26343SJason M. Bills { 2668e1f26343SJason M. Bills continue; 2669e1f26343SJason M. Bills } 2670e85d6b16SJason M. Bills firstEntry = false; 2671e85d6b16SJason M. Bills 26723a48b3a2SJason M. Bills nlohmann::json::object_t bmcJournalLogEntry; 2673c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(idStr, journal.get(), 2674c4bf6374SJason M. Bills bmcJournalLogEntry) != 0) 2675e1f26343SJason M. Bills { 2676f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2677e1f26343SJason M. Bills return; 2678e1f26343SJason M. Bills } 2679b2ba3072SPatrick Williams logEntryArray.emplace_back(std::move(bmcJournalLogEntry)); 2680e1f26343SJason M. Bills } 2681193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 26823648c8beSEd Tanous if (skip + top < entryCount) 2683193ad2faSJason M. Bills { 2684193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 26850fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" + 26863648c8beSEd Tanous std::to_string(skip + top); 2687193ad2faSJason M. Bills } 26887e860f15SJohn Edward Broadbent }); 2689e1f26343SJason M. Bills } 2690e1f26343SJason M. Bills 26917e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntry(App& app) 2692e1f26343SJason M. Bills { 26937e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 26947e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/") 2695ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 26967e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 269745ca1b86SEd Tanous [&app](const crow::Request& req, 26987e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 26997e860f15SJohn Edward Broadbent const std::string& entryID) { 27003ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 270145ca1b86SEd Tanous { 270245ca1b86SEd Tanous return; 270345ca1b86SEd Tanous } 2704e1f26343SJason M. Bills // Convert the unique ID back to a timestamp to find the entry 270575e8e218SMyung Bae sd_id128_t bootID{}; 2706e1f26343SJason M. Bills uint64_t ts = 0; 2707271584abSEd Tanous uint64_t index = 0; 270875e8e218SMyung Bae if (!getTimestampFromID(asyncResp, entryID, bootID, ts, index)) 2709e1f26343SJason M. Bills { 271016428a1aSJason M. Bills return; 2711e1f26343SJason M. Bills } 2712e1f26343SJason M. Bills 2713e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2714e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2715e1f26343SJason M. Bills if (ret < 0) 2716e1f26343SJason M. Bills { 271762598e31SEd Tanous BMCWEB_LOG_ERROR("failed to open journal: {}", strerror(-ret)); 2718f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2719e1f26343SJason M. Bills return; 2720e1f26343SJason M. Bills } 2721002d39b4SEd Tanous std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 2722002d39b4SEd Tanous journalTmp, sd_journal_close); 2723e1f26343SJason M. Bills journalTmp = nullptr; 27247e860f15SJohn Edward Broadbent // Go to the timestamp in the log and move to the entry at the 27257e860f15SJohn Edward Broadbent // index tracking the unique ID 2726af07e3f5SJason M. Bills std::string idStr; 2727af07e3f5SJason M. Bills bool firstEntry = true; 272875e8e218SMyung Bae ret = sd_journal_seek_monotonic_usec(journal.get(), bootID, ts); 27292056b6d1SManojkiran Eda if (ret < 0) 27302056b6d1SManojkiran Eda { 273162598e31SEd Tanous BMCWEB_LOG_ERROR("failed to seek to an entry in journal{}", 273262598e31SEd Tanous strerror(-ret)); 27332056b6d1SManojkiran Eda messages::internalError(asyncResp->res); 27342056b6d1SManojkiran Eda return; 27352056b6d1SManojkiran Eda } 2736271584abSEd Tanous for (uint64_t i = 0; i <= index; i++) 2737e1f26343SJason M. Bills { 2738e1f26343SJason M. Bills sd_journal_next(journal.get()); 2739af07e3f5SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2740af07e3f5SJason M. Bills { 2741af07e3f5SJason M. Bills messages::internalError(asyncResp->res); 2742af07e3f5SJason M. Bills return; 2743af07e3f5SJason M. Bills } 2744af07e3f5SJason M. Bills firstEntry = false; 2745af07e3f5SJason M. Bills } 2746c4bf6374SJason M. Bills // Confirm that the entry ID matches what was requested 2747af07e3f5SJason M. Bills if (idStr != entryID) 2748c4bf6374SJason M. Bills { 27499db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 2750c4bf6374SJason M. Bills return; 2751c4bf6374SJason M. Bills } 2752c4bf6374SJason M. Bills 27533a48b3a2SJason M. Bills nlohmann::json::object_t bmcJournalLogEntry; 2754c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(entryID, journal.get(), 27553a48b3a2SJason M. Bills bmcJournalLogEntry) != 0) 2756e1f26343SJason M. Bills { 2757f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2758e1f26343SJason M. Bills return; 2759e1f26343SJason M. Bills } 2760d405bb51SJason M. Bills asyncResp->res.jsonValue.update(bmcJournalLogEntry); 27617e860f15SJohn Edward Broadbent }); 2762c9bb6861Sraviteja-b } 2763c9bb6861Sraviteja-b 2764fdd26906SClaire Weinan inline void 2765fdd26906SClaire Weinan getDumpServiceInfo(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2766fdd26906SClaire Weinan const std::string& dumpType) 2767c9bb6861Sraviteja-b { 2768fdd26906SClaire Weinan std::string dumpPath; 2769fdd26906SClaire Weinan std::string overWritePolicy; 2770fdd26906SClaire Weinan bool collectDiagnosticDataSupported = false; 2771fdd26906SClaire Weinan 2772fdd26906SClaire Weinan if (dumpType == "BMC") 277345ca1b86SEd Tanous { 2774fdd26906SClaire Weinan dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump"; 2775fdd26906SClaire Weinan overWritePolicy = "WrapsWhenFull"; 2776fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2777fdd26906SClaire Weinan } 2778fdd26906SClaire Weinan else if (dumpType == "FaultLog") 2779fdd26906SClaire Weinan { 2780fdd26906SClaire Weinan dumpPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2781fdd26906SClaire Weinan overWritePolicy = "Unknown"; 2782fdd26906SClaire Weinan collectDiagnosticDataSupported = false; 2783fdd26906SClaire Weinan } 2784fdd26906SClaire Weinan else if (dumpType == "System") 2785fdd26906SClaire Weinan { 2786fdd26906SClaire Weinan dumpPath = "/redfish/v1/Systems/system/LogServices/Dump"; 2787fdd26906SClaire Weinan overWritePolicy = "WrapsWhenFull"; 2788fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2789fdd26906SClaire Weinan } 2790fdd26906SClaire Weinan else 2791fdd26906SClaire Weinan { 279262598e31SEd Tanous BMCWEB_LOG_ERROR("getDumpServiceInfo() invalid dump type: {}", 279362598e31SEd Tanous dumpType); 2794fdd26906SClaire Weinan messages::internalError(asyncResp->res); 279545ca1b86SEd Tanous return; 279645ca1b86SEd Tanous } 2797fdd26906SClaire Weinan 2798fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = dumpPath; 2799fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService"; 2800c9bb6861Sraviteja-b asyncResp->res.jsonValue["Name"] = "Dump LogService"; 2801fdd26906SClaire Weinan asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService"; 2802fdd26906SClaire Weinan asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename(); 2803fdd26906SClaire Weinan asyncResp->res.jsonValue["OverWritePolicy"] = std::move(overWritePolicy); 28047c8c4058STejas Patil 28057c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 28062b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 28070fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 28087c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 28097c8c4058STejas Patil redfishDateTimeOffset.second; 28107c8c4058STejas Patil 2811fdd26906SClaire Weinan asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries"; 2812fdd26906SClaire Weinan 2813fdd26906SClaire Weinan if (collectDiagnosticDataSupported) 2814fdd26906SClaire Weinan { 2815002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 28161476687dSEd Tanous ["target"] = 2817fdd26906SClaire Weinan dumpPath + "/Actions/LogService.CollectDiagnosticData"; 2818fdd26906SClaire Weinan } 28190d946211SClaire Weinan 28200d946211SClaire Weinan constexpr std::array<std::string_view, 1> interfaces = {deleteAllInterface}; 28210d946211SClaire Weinan dbus::utility::getSubTreePaths( 28220d946211SClaire Weinan "/xyz/openbmc_project/dump", 0, interfaces, 28230d946211SClaire Weinan [asyncResp, dumpType, dumpPath]( 28240d946211SClaire Weinan const boost::system::error_code& ec, 28250d946211SClaire Weinan const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 28260d946211SClaire Weinan if (ec) 28270d946211SClaire Weinan { 282862598e31SEd Tanous BMCWEB_LOG_ERROR("getDumpServiceInfo respHandler got error {}", ec); 28290d946211SClaire Weinan // Assume that getting an error simply means there are no dump 28300d946211SClaire Weinan // LogServices. Return without adding any error response. 28310d946211SClaire Weinan return; 28320d946211SClaire Weinan } 283318f8f608SEd Tanous std::string dbusDumpPath = getDumpPath(dumpType); 28340d946211SClaire Weinan for (const std::string& path : subTreePaths) 28350d946211SClaire Weinan { 28360d946211SClaire Weinan if (path == dbusDumpPath) 28370d946211SClaire Weinan { 28380d946211SClaire Weinan asyncResp->res 28390d946211SClaire Weinan .jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 28400d946211SClaire Weinan dumpPath + "/Actions/LogService.ClearLog"; 28410d946211SClaire Weinan break; 28420d946211SClaire Weinan } 28430d946211SClaire Weinan } 28440d946211SClaire Weinan }); 2845c9bb6861Sraviteja-b } 2846c9bb6861Sraviteja-b 2847fdd26906SClaire Weinan inline void handleLogServicesDumpServiceGet( 2848fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2849fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 28507e860f15SJohn Edward Broadbent { 28513ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 285245ca1b86SEd Tanous { 285345ca1b86SEd Tanous return; 285445ca1b86SEd Tanous } 2855fdd26906SClaire Weinan getDumpServiceInfo(asyncResp, dumpType); 2856fdd26906SClaire Weinan } 2857c9bb6861Sraviteja-b 285822d268cbSEd Tanous inline void handleLogServicesDumpServiceComputerSystemGet( 285922d268cbSEd Tanous crow::App& app, const crow::Request& req, 286022d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 286122d268cbSEd Tanous const std::string& chassisId) 286222d268cbSEd Tanous { 286322d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 286422d268cbSEd Tanous { 286522d268cbSEd Tanous return; 286622d268cbSEd Tanous } 286722d268cbSEd Tanous if (chassisId != "system") 286822d268cbSEd Tanous { 286922d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 287022d268cbSEd Tanous return; 287122d268cbSEd Tanous } 287222d268cbSEd Tanous getDumpServiceInfo(asyncResp, "System"); 287322d268cbSEd Tanous } 287422d268cbSEd Tanous 2875fdd26906SClaire Weinan inline void handleLogServicesDumpEntriesCollectionGet( 2876fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2877fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2878fdd26906SClaire Weinan { 2879fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2880fdd26906SClaire Weinan { 2881fdd26906SClaire Weinan return; 2882fdd26906SClaire Weinan } 2883fdd26906SClaire Weinan getDumpEntryCollection(asyncResp, dumpType); 2884fdd26906SClaire Weinan } 2885fdd26906SClaire Weinan 288622d268cbSEd Tanous inline void handleLogServicesDumpEntriesCollectionComputerSystemGet( 288722d268cbSEd Tanous crow::App& app, const crow::Request& req, 288822d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 288922d268cbSEd Tanous const std::string& chassisId) 289022d268cbSEd Tanous { 289122d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 289222d268cbSEd Tanous { 289322d268cbSEd Tanous return; 289422d268cbSEd Tanous } 289522d268cbSEd Tanous if (chassisId != "system") 289622d268cbSEd Tanous { 289722d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 289822d268cbSEd Tanous return; 289922d268cbSEd Tanous } 290022d268cbSEd Tanous getDumpEntryCollection(asyncResp, "System"); 290122d268cbSEd Tanous } 290222d268cbSEd Tanous 2903fdd26906SClaire Weinan inline void handleLogServicesDumpEntryGet( 2904fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2905fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2906fdd26906SClaire Weinan const std::string& dumpId) 2907fdd26906SClaire Weinan { 2908fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2909fdd26906SClaire Weinan { 2910fdd26906SClaire Weinan return; 2911fdd26906SClaire Weinan } 2912fdd26906SClaire Weinan getDumpEntryById(asyncResp, dumpId, dumpType); 2913fdd26906SClaire Weinan } 2914168d1b1aSCarson Labrado 291522d268cbSEd Tanous inline void handleLogServicesDumpEntryComputerSystemGet( 291622d268cbSEd Tanous crow::App& app, const crow::Request& req, 291722d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 291822d268cbSEd Tanous const std::string& chassisId, const std::string& dumpId) 291922d268cbSEd Tanous { 292022d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 292122d268cbSEd Tanous { 292222d268cbSEd Tanous return; 292322d268cbSEd Tanous } 292422d268cbSEd Tanous if (chassisId != "system") 292522d268cbSEd Tanous { 292622d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 292722d268cbSEd Tanous return; 292822d268cbSEd Tanous } 292922d268cbSEd Tanous getDumpEntryById(asyncResp, dumpId, "System"); 293022d268cbSEd Tanous } 2931fdd26906SClaire Weinan 2932fdd26906SClaire Weinan inline void handleLogServicesDumpEntryDelete( 2933fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2934fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2935fdd26906SClaire Weinan const std::string& dumpId) 2936fdd26906SClaire Weinan { 2937fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2938fdd26906SClaire Weinan { 2939fdd26906SClaire Weinan return; 2940fdd26906SClaire Weinan } 2941fdd26906SClaire Weinan deleteDumpEntry(asyncResp, dumpId, dumpType); 2942fdd26906SClaire Weinan } 2943fdd26906SClaire Weinan 294422d268cbSEd Tanous inline void handleLogServicesDumpEntryComputerSystemDelete( 294522d268cbSEd Tanous crow::App& app, const crow::Request& req, 294622d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 294722d268cbSEd Tanous const std::string& chassisId, const std::string& dumpId) 294822d268cbSEd Tanous { 294922d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 295022d268cbSEd Tanous { 295122d268cbSEd Tanous return; 295222d268cbSEd Tanous } 295322d268cbSEd Tanous if (chassisId != "system") 295422d268cbSEd Tanous { 295522d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 295622d268cbSEd Tanous return; 295722d268cbSEd Tanous } 295822d268cbSEd Tanous deleteDumpEntry(asyncResp, dumpId, "System"); 295922d268cbSEd Tanous } 296022d268cbSEd Tanous 2961168d1b1aSCarson Labrado inline void handleLogServicesDumpEntryDownloadGet( 2962168d1b1aSCarson Labrado crow::App& app, const std::string& dumpType, const crow::Request& req, 2963168d1b1aSCarson Labrado const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2964168d1b1aSCarson Labrado const std::string& dumpId) 2965168d1b1aSCarson Labrado { 2966168d1b1aSCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2967168d1b1aSCarson Labrado { 2968168d1b1aSCarson Labrado return; 2969168d1b1aSCarson Labrado } 2970168d1b1aSCarson Labrado downloadDumpEntry(asyncResp, dumpId, dumpType); 2971168d1b1aSCarson Labrado } 2972168d1b1aSCarson Labrado 2973168d1b1aSCarson Labrado inline void handleDBusEventLogEntryDownloadGet( 2974168d1b1aSCarson Labrado crow::App& app, const std::string& dumpType, const crow::Request& req, 2975168d1b1aSCarson Labrado const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2976168d1b1aSCarson Labrado const std::string& systemName, const std::string& entryID) 2977168d1b1aSCarson Labrado { 2978168d1b1aSCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2979168d1b1aSCarson Labrado { 2980168d1b1aSCarson Labrado return; 2981168d1b1aSCarson Labrado } 2982168d1b1aSCarson Labrado if (!http_helpers::isContentTypeAllowed( 2983168d1b1aSCarson Labrado req.getHeaderValue("Accept"), 2984168d1b1aSCarson Labrado http_helpers::ContentType::OctetStream, true)) 2985168d1b1aSCarson Labrado { 2986168d1b1aSCarson Labrado asyncResp->res.result(boost::beast::http::status::bad_request); 2987168d1b1aSCarson Labrado return; 2988168d1b1aSCarson Labrado } 2989168d1b1aSCarson Labrado downloadEventLogEntry(asyncResp, systemName, entryID, dumpType); 2990168d1b1aSCarson Labrado } 2991168d1b1aSCarson Labrado 2992fdd26906SClaire Weinan inline void handleLogServicesDumpCollectDiagnosticDataPost( 2993fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2994fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2995fdd26906SClaire Weinan { 2996fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2997fdd26906SClaire Weinan { 2998fdd26906SClaire Weinan return; 2999fdd26906SClaire Weinan } 3000fdd26906SClaire Weinan createDump(asyncResp, req, dumpType); 3001fdd26906SClaire Weinan } 3002fdd26906SClaire Weinan 300322d268cbSEd Tanous inline void handleLogServicesDumpCollectDiagnosticDataComputerSystemPost( 300422d268cbSEd Tanous crow::App& app, const crow::Request& req, 300522d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 30067f3e84a1SEd Tanous const std::string& systemName) 300722d268cbSEd Tanous { 300822d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 300922d268cbSEd Tanous { 301022d268cbSEd Tanous return; 301122d268cbSEd Tanous } 30127f3e84a1SEd Tanous 3013*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 301422d268cbSEd Tanous { 30157f3e84a1SEd Tanous // Option currently returns no systems. TBD 30167f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 30177f3e84a1SEd Tanous systemName); 30187f3e84a1SEd Tanous return; 30197f3e84a1SEd Tanous } 30207f3e84a1SEd Tanous if (systemName != "system") 30217f3e84a1SEd Tanous { 30227f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 30237f3e84a1SEd Tanous systemName); 302422d268cbSEd Tanous return; 302522d268cbSEd Tanous } 302622d268cbSEd Tanous createDump(asyncResp, req, "System"); 302722d268cbSEd Tanous } 302822d268cbSEd Tanous 3029fdd26906SClaire Weinan inline void handleLogServicesDumpClearLogPost( 3030fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 3031fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 3032fdd26906SClaire Weinan { 3033fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 3034fdd26906SClaire Weinan { 3035fdd26906SClaire Weinan return; 3036fdd26906SClaire Weinan } 3037fdd26906SClaire Weinan clearDump(asyncResp, dumpType); 3038fdd26906SClaire Weinan } 3039fdd26906SClaire Weinan 304022d268cbSEd Tanous inline void handleLogServicesDumpClearLogComputerSystemPost( 304122d268cbSEd Tanous crow::App& app, const crow::Request& req, 304222d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 30437f3e84a1SEd Tanous const std::string& systemName) 304422d268cbSEd Tanous { 304522d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 304622d268cbSEd Tanous { 304722d268cbSEd Tanous return; 304822d268cbSEd Tanous } 3049*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 305022d268cbSEd Tanous { 30517f3e84a1SEd Tanous // Option currently returns no systems. TBD 30527f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 30537f3e84a1SEd Tanous systemName); 30547f3e84a1SEd Tanous return; 30557f3e84a1SEd Tanous } 30567f3e84a1SEd Tanous if (systemName != "system") 30577f3e84a1SEd Tanous { 30587f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 30597f3e84a1SEd Tanous systemName); 306022d268cbSEd Tanous return; 306122d268cbSEd Tanous } 306222d268cbSEd Tanous clearDump(asyncResp, "System"); 306322d268cbSEd Tanous } 306422d268cbSEd Tanous 3065fdd26906SClaire Weinan inline void requestRoutesBMCDumpService(App& app) 3066fdd26906SClaire Weinan { 3067fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/") 3068fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 3069fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 3070fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "BMC")); 3071fdd26906SClaire Weinan } 3072fdd26906SClaire Weinan 3073fdd26906SClaire Weinan inline void requestRoutesBMCDumpEntryCollection(App& app) 3074fdd26906SClaire Weinan { 3075fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/") 3076fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 3077fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 3078fdd26906SClaire Weinan handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC")); 3079c9bb6861Sraviteja-b } 3080c9bb6861Sraviteja-b 30817e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app) 3082c9bb6861Sraviteja-b { 30837e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 30847e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 3085ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 3086fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 3087fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "BMC")); 3088fdd26906SClaire Weinan 30897e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 30907e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 3091ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 3092fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 3093fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "BMC")); 3094c9bb6861Sraviteja-b } 3095c9bb6861Sraviteja-b 3096168d1b1aSCarson Labrado inline void requestRoutesBMCDumpEntryDownload(App& app) 3097168d1b1aSCarson Labrado { 3098168d1b1aSCarson Labrado BMCWEB_ROUTE( 3099168d1b1aSCarson Labrado app, 31009e9d99daSRavi Teja "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/attachment/") 3101168d1b1aSCarson Labrado .privileges(redfish::privileges::getLogEntry) 3102168d1b1aSCarson Labrado .methods(boost::beast::http::verb::get)(std::bind_front( 3103168d1b1aSCarson Labrado handleLogServicesDumpEntryDownloadGet, std::ref(app), "BMC")); 3104168d1b1aSCarson Labrado } 3105168d1b1aSCarson Labrado 31067e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app) 3107c9bb6861Sraviteja-b { 31080fda0f12SGeorge Liu BMCWEB_ROUTE( 31090fda0f12SGeorge Liu app, 31100fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 3111ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 31127e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 3113fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost, 3114fdd26906SClaire Weinan std::ref(app), "BMC")); 3115a43be80fSAsmitha Karunanithi } 3116a43be80fSAsmitha Karunanithi 31177e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app) 311880319af1SAsmitha Karunanithi { 31190fda0f12SGeorge Liu BMCWEB_ROUTE( 31200fda0f12SGeorge Liu app, 31210fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog/") 3122ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 3123fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 3124fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "BMC")); 312545ca1b86SEd Tanous } 3126fdd26906SClaire Weinan 3127168d1b1aSCarson Labrado inline void requestRoutesDBusEventLogEntryDownload(App& app) 3128168d1b1aSCarson Labrado { 3129168d1b1aSCarson Labrado BMCWEB_ROUTE( 3130168d1b1aSCarson Labrado app, 31319e9d99daSRavi Teja "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/attachment/") 3132168d1b1aSCarson Labrado .privileges(redfish::privileges::getLogEntry) 3133168d1b1aSCarson Labrado .methods(boost::beast::http::verb::get)(std::bind_front( 3134168d1b1aSCarson Labrado handleDBusEventLogEntryDownloadGet, std::ref(app), "System")); 3135168d1b1aSCarson Labrado } 3136168d1b1aSCarson Labrado 3137fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpService(App& app) 3138fdd26906SClaire Weinan { 3139fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/") 3140fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 3141fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 3142fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "FaultLog")); 3143fdd26906SClaire Weinan } 3144fdd26906SClaire Weinan 3145fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntryCollection(App& app) 3146fdd26906SClaire Weinan { 3147fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/") 3148fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 3149fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 3150fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpEntriesCollectionGet, 3151fdd26906SClaire Weinan std::ref(app), "FaultLog")); 3152fdd26906SClaire Weinan } 3153fdd26906SClaire Weinan 3154fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntry(App& app) 3155fdd26906SClaire Weinan { 3156fdd26906SClaire Weinan BMCWEB_ROUTE(app, 3157fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 3158fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntry) 3159fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 3160fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "FaultLog")); 3161fdd26906SClaire Weinan 3162fdd26906SClaire Weinan BMCWEB_ROUTE(app, 3163fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 3164fdd26906SClaire Weinan .privileges(redfish::privileges::deleteLogEntry) 3165fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 3166fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog")); 3167fdd26906SClaire Weinan } 3168fdd26906SClaire Weinan 3169fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpClear(App& app) 3170fdd26906SClaire Weinan { 3171fdd26906SClaire Weinan BMCWEB_ROUTE( 3172fdd26906SClaire Weinan app, 3173fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog/") 3174fdd26906SClaire Weinan .privileges(redfish::privileges::postLogService) 3175fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 3176fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog")); 31775cb1dd27SAsmitha Karunanithi } 31785cb1dd27SAsmitha Karunanithi 31797e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app) 31805cb1dd27SAsmitha Karunanithi { 318122d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/") 3182ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 31836ab9ad54SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 318422d268cbSEd Tanous handleLogServicesDumpServiceComputerSystemGet, std::ref(app))); 31855cb1dd27SAsmitha Karunanithi } 31865cb1dd27SAsmitha Karunanithi 31877e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app) 31887e860f15SJohn Edward Broadbent { 318922d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/") 3190ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 319122d268cbSEd Tanous .methods(boost::beast::http::verb::get)(std::bind_front( 319222d268cbSEd Tanous handleLogServicesDumpEntriesCollectionComputerSystemGet, 319322d268cbSEd Tanous std::ref(app))); 31945cb1dd27SAsmitha Karunanithi } 31955cb1dd27SAsmitha Karunanithi 31967e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app) 31975cb1dd27SAsmitha Karunanithi { 31987e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 319922d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/") 3200ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 32016ab9ad54SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 320222d268cbSEd Tanous handleLogServicesDumpEntryComputerSystemGet, std::ref(app))); 32038d1b46d7Szhanghch05 32047e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 320522d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/") 3206ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 32076ab9ad54SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 320822d268cbSEd Tanous handleLogServicesDumpEntryComputerSystemDelete, std::ref(app))); 32095cb1dd27SAsmitha Karunanithi } 3210c9bb6861Sraviteja-b 32117e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app) 3212c9bb6861Sraviteja-b { 32130fda0f12SGeorge Liu BMCWEB_ROUTE( 32140fda0f12SGeorge Liu app, 321522d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 3216ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 321722d268cbSEd Tanous .methods(boost::beast::http::verb::post)(std::bind_front( 321822d268cbSEd Tanous handleLogServicesDumpCollectDiagnosticDataComputerSystemPost, 321922d268cbSEd Tanous std::ref(app))); 3220a43be80fSAsmitha Karunanithi } 3221a43be80fSAsmitha Karunanithi 32227e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app) 3223a43be80fSAsmitha Karunanithi { 32240fda0f12SGeorge Liu BMCWEB_ROUTE( 32250fda0f12SGeorge Liu app, 322622d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.ClearLog/") 3227ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 32286ab9ad54SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 322922d268cbSEd Tanous handleLogServicesDumpClearLogComputerSystemPost, std::ref(app))); 3230013487e5Sraviteja-b } 3231013487e5Sraviteja-b 32327e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app) 32331da66f75SEd Tanous { 32343946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 32353946028dSAppaRao Puli // method for security reasons. 32361da66f75SEd Tanous /** 32371da66f75SEd Tanous * Functions triggers appropriate requests on DBus 32381da66f75SEd Tanous */ 323922d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/") 3240ed398213SEd Tanous // This is incorrect, should be: 3241ed398213SEd Tanous //.privileges(redfish::privileges::getLogService) 3242432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 3243002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 3244002d39b4SEd Tanous [&app](const crow::Request& req, 324522d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 324622d268cbSEd Tanous const std::string& systemName) { 32473ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 324845ca1b86SEd Tanous { 324945ca1b86SEd Tanous return; 325045ca1b86SEd Tanous } 3251*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 32527f3e84a1SEd Tanous { 32537f3e84a1SEd Tanous // Option currently returns no systems. TBD 32547f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 32557f3e84a1SEd Tanous systemName); 32567f3e84a1SEd Tanous return; 32577f3e84a1SEd Tanous } 325822d268cbSEd Tanous if (systemName != "system") 325922d268cbSEd Tanous { 326022d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 326122d268cbSEd Tanous systemName); 326222d268cbSEd Tanous return; 326322d268cbSEd Tanous } 326422d268cbSEd Tanous 32657e860f15SJohn Edward Broadbent // Copy over the static data to include the entries added by 32667e860f15SJohn Edward Broadbent // SubRoute 32670f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 3268424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"; 3269e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 32708e6c099aSJason M. Bills "#LogService.v1_2_0.LogService"; 32714f50ae4bSGunnar Mills asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service"; 32724f50ae4bSGunnar Mills asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service"; 327315b89725SV-Sanjana asyncResp->res.jsonValue["Id"] = "Crashdump"; 3274e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 3275e1f26343SJason M. Bills asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; 32767c8c4058STejas Patil 32777c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 32782b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 32797c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 32807c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 32817c8c4058STejas Patil redfishDateTimeOffset.second; 32827c8c4058STejas Patil 32831476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 3284ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 3285002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 32861476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog"; 3287002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 32881476687dSEd Tanous ["target"] = 32891476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData"; 32907e860f15SJohn Edward Broadbent }); 32911da66f75SEd Tanous } 32921da66f75SEd Tanous 32937e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app) 32945b61b5e8SJason M. Bills { 32950fda0f12SGeorge Liu BMCWEB_ROUTE( 32960fda0f12SGeorge Liu app, 329722d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.ClearLog/") 3298ed398213SEd Tanous // This is incorrect, should be: 3299ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3300432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 33017e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 330245ca1b86SEd Tanous [&app](const crow::Request& req, 330322d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 330422d268cbSEd Tanous const std::string& systemName) { 33053ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 330645ca1b86SEd Tanous { 330745ca1b86SEd Tanous return; 330845ca1b86SEd Tanous } 3309*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 33107f3e84a1SEd Tanous { 33117f3e84a1SEd Tanous // Option currently returns no systems. TBD 33127f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 33137f3e84a1SEd Tanous systemName); 33147f3e84a1SEd Tanous return; 33157f3e84a1SEd Tanous } 331622d268cbSEd Tanous if (systemName != "system") 331722d268cbSEd Tanous { 331822d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 331922d268cbSEd Tanous systemName); 332022d268cbSEd Tanous return; 332122d268cbSEd Tanous } 33225b61b5e8SJason M. Bills crow::connections::systemBus->async_method_call( 33235e7e2dc5SEd Tanous [asyncResp](const boost::system::error_code& ec, 3324cb13a392SEd Tanous const std::string&) { 33255b61b5e8SJason M. Bills if (ec) 33265b61b5e8SJason M. Bills { 33275b61b5e8SJason M. Bills messages::internalError(asyncResp->res); 33285b61b5e8SJason M. Bills return; 33295b61b5e8SJason M. Bills } 33305b61b5e8SJason M. Bills messages::success(asyncResp->res); 33315b61b5e8SJason M. Bills }, 3332002d39b4SEd Tanous crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll"); 33337e860f15SJohn Edward Broadbent }); 33345b61b5e8SJason M. Bills } 33355b61b5e8SJason M. Bills 33368d1b46d7Szhanghch05 static void 33378d1b46d7Szhanghch05 logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 33388d1b46d7Szhanghch05 const std::string& logID, nlohmann::json& logEntryJson) 3339e855dd28SJason M. Bills { 3340043a0536SJohnathan Mantey auto getStoredLogCallback = 3341b9d36b47SEd Tanous [asyncResp, logID, 33425e7e2dc5SEd Tanous &logEntryJson](const boost::system::error_code& ec, 3343b9d36b47SEd Tanous const dbus::utility::DBusPropertiesMap& params) { 3344e855dd28SJason M. Bills if (ec) 3345e855dd28SJason M. Bills { 334662598e31SEd Tanous BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message()); 33471ddcf01aSJason M. Bills if (ec.value() == 33481ddcf01aSJason M. Bills boost::system::linux_error::bad_request_descriptor) 33491ddcf01aSJason M. Bills { 3350002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 33511ddcf01aSJason M. Bills } 33521ddcf01aSJason M. Bills else 33531ddcf01aSJason M. Bills { 3354e855dd28SJason M. Bills messages::internalError(asyncResp->res); 33551ddcf01aSJason M. Bills } 3356e855dd28SJason M. Bills return; 3357e855dd28SJason M. Bills } 3358043a0536SJohnathan Mantey 3359043a0536SJohnathan Mantey std::string timestamp{}; 3360043a0536SJohnathan Mantey std::string filename{}; 3361043a0536SJohnathan Mantey std::string logfile{}; 33622c70f800SEd Tanous parseCrashdumpParameters(params, filename, timestamp, logfile); 3363043a0536SJohnathan Mantey 3364043a0536SJohnathan Mantey if (filename.empty() || timestamp.empty()) 3365e855dd28SJason M. Bills { 33669db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 3367e855dd28SJason M. Bills return; 3368e855dd28SJason M. Bills } 3369e855dd28SJason M. Bills 3370043a0536SJohnathan Mantey std::string crashdumpURI = 3371e855dd28SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + 3372043a0536SJohnathan Mantey logID + "/" + filename; 337384afc48bSJason M. Bills nlohmann::json::object_t logEntry; 33749c11a172SVijay Lobo logEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 3375ef4c65b7SEd Tanous logEntry["@odata.id"] = boost::urls::format( 3376ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/{}", 3377ef4c65b7SEd Tanous logID); 337884afc48bSJason M. Bills logEntry["Name"] = "CPU Crashdump"; 337984afc48bSJason M. Bills logEntry["Id"] = logID; 338084afc48bSJason M. Bills logEntry["EntryType"] = "Oem"; 338184afc48bSJason M. Bills logEntry["AdditionalDataURI"] = std::move(crashdumpURI); 338284afc48bSJason M. Bills logEntry["DiagnosticDataType"] = "OEM"; 338384afc48bSJason M. Bills logEntry["OEMDiagnosticDataType"] = "PECICrashdump"; 338484afc48bSJason M. Bills logEntry["Created"] = std::move(timestamp); 33852b20ef6eSJason M. Bills 33862b20ef6eSJason M. Bills // If logEntryJson references an array of LogEntry resources 33872b20ef6eSJason M. Bills // ('Members' list), then push this as a new entry, otherwise set it 33882b20ef6eSJason M. Bills // directly 33892b20ef6eSJason M. Bills if (logEntryJson.is_array()) 33902b20ef6eSJason M. Bills { 33912b20ef6eSJason M. Bills logEntryJson.push_back(logEntry); 33922b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 33932b20ef6eSJason M. Bills logEntryJson.size(); 33942b20ef6eSJason M. Bills } 33952b20ef6eSJason M. Bills else 33962b20ef6eSJason M. Bills { 3397d405bb51SJason M. Bills logEntryJson.update(logEntry); 33982b20ef6eSJason M. Bills } 3399e855dd28SJason M. Bills }; 3400d1bde9e5SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 3401d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, crashdumpObject, 3402d1bde9e5SKrzysztof Grobelny crashdumpPath + std::string("/") + logID, crashdumpInterface, 3403d1bde9e5SKrzysztof Grobelny std::move(getStoredLogCallback)); 3404e855dd28SJason M. Bills } 3405e855dd28SJason M. Bills 34067e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app) 34071da66f75SEd Tanous { 34083946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 34093946028dSAppaRao Puli // method for security reasons. 34101da66f75SEd Tanous /** 34111da66f75SEd Tanous * Functions triggers appropriate requests on DBus 34121da66f75SEd Tanous */ 34137e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 341422d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/") 3415ed398213SEd Tanous // This is incorrect, should be. 3416ed398213SEd Tanous //.privileges(redfish::privileges::postLogEntryCollection) 3417432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 3418002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 3419002d39b4SEd Tanous [&app](const crow::Request& req, 342022d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 342122d268cbSEd Tanous const std::string& systemName) { 34223ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 342345ca1b86SEd Tanous { 342445ca1b86SEd Tanous return; 342545ca1b86SEd Tanous } 3426*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 34277f3e84a1SEd Tanous { 34287f3e84a1SEd Tanous // Option currently returns no systems. TBD 34297f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 34307f3e84a1SEd Tanous systemName); 34317f3e84a1SEd Tanous return; 34327f3e84a1SEd Tanous } 343322d268cbSEd Tanous if (systemName != "system") 343422d268cbSEd Tanous { 343522d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 343622d268cbSEd Tanous systemName); 343722d268cbSEd Tanous return; 343822d268cbSEd Tanous } 343922d268cbSEd Tanous 34407a1dbc48SGeorge Liu constexpr std::array<std::string_view, 1> interfaces = { 34417a1dbc48SGeorge Liu crashdumpInterface}; 34427a1dbc48SGeorge Liu dbus::utility::getSubTreePaths( 34437a1dbc48SGeorge Liu "/", 0, interfaces, 34447a1dbc48SGeorge Liu [asyncResp](const boost::system::error_code& ec, 34452b20ef6eSJason M. Bills const std::vector<std::string>& resp) { 34461da66f75SEd Tanous if (ec) 34471da66f75SEd Tanous { 34481da66f75SEd Tanous if (ec.value() != 34491da66f75SEd Tanous boost::system::errc::no_such_file_or_directory) 34501da66f75SEd Tanous { 345162598e31SEd Tanous BMCWEB_LOG_DEBUG("failed to get entries ec: {}", 345262598e31SEd Tanous ec.message()); 3453f12894f8SJason M. Bills messages::internalError(asyncResp->res); 34541da66f75SEd Tanous return; 34551da66f75SEd Tanous } 34561da66f75SEd Tanous } 3457e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 34581da66f75SEd Tanous "#LogEntryCollection.LogEntryCollection"; 34590f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 3460424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 3461002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries"; 3462e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 3463424c4176SJason M. Bills "Collection of Crashdump Entries"; 3464002d39b4SEd Tanous asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3465a2dd60a6SBrandon Kim asyncResp->res.jsonValue["Members@odata.count"] = 0; 34662b20ef6eSJason M. Bills 34672b20ef6eSJason M. Bills for (const std::string& path : resp) 34681da66f75SEd Tanous { 34692b20ef6eSJason M. Bills const sdbusplus::message::object_path objPath(path); 3470e855dd28SJason M. Bills // Get the log ID 34712b20ef6eSJason M. Bills std::string logID = objPath.filename(); 34722b20ef6eSJason M. Bills if (logID.empty()) 34731da66f75SEd Tanous { 3474e855dd28SJason M. Bills continue; 34751da66f75SEd Tanous } 3476e855dd28SJason M. Bills // Add the log entry to the array 34772b20ef6eSJason M. Bills logCrashdumpEntry(asyncResp, logID, 34782b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members"]); 34791da66f75SEd Tanous } 34807a1dbc48SGeorge Liu }); 34817e860f15SJohn Edward Broadbent }); 34821da66f75SEd Tanous } 34831da66f75SEd Tanous 34847e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app) 34851da66f75SEd Tanous { 34863946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 34873946028dSAppaRao Puli // method for security reasons. 34881da66f75SEd Tanous 34897e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 349022d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/") 3491ed398213SEd Tanous // this is incorrect, should be 3492ed398213SEd Tanous // .privileges(redfish::privileges::getLogEntry) 3493432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 34947e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 349545ca1b86SEd Tanous [&app](const crow::Request& req, 34967e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 349722d268cbSEd Tanous const std::string& systemName, const std::string& param) { 34983ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 349945ca1b86SEd Tanous { 350045ca1b86SEd Tanous return; 350145ca1b86SEd Tanous } 3502*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 35037f3e84a1SEd Tanous { 35047f3e84a1SEd Tanous // Option currently returns no systems. TBD 35057f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 35067f3e84a1SEd Tanous systemName); 35077f3e84a1SEd Tanous return; 35087f3e84a1SEd Tanous } 350922d268cbSEd Tanous if (systemName != "system") 351022d268cbSEd Tanous { 351122d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 351222d268cbSEd Tanous systemName); 351322d268cbSEd Tanous return; 351422d268cbSEd Tanous } 35157e860f15SJohn Edward Broadbent const std::string& logID = param; 3516e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue); 35177e860f15SJohn Edward Broadbent }); 3518e855dd28SJason M. Bills } 3519e855dd28SJason M. Bills 35207e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app) 3521e855dd28SJason M. Bills { 35223946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 35233946028dSAppaRao Puli // method for security reasons. 35247e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 35257e860f15SJohn Edward Broadbent app, 352622d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/<str>/") 3527ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 35287e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 3529a4ce114aSNan Zhou [](const crow::Request& req, 35307e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 353122d268cbSEd Tanous const std::string& systemName, const std::string& logID, 353222d268cbSEd Tanous const std::string& fileName) { 35332a9beeedSShounak Mitra // Do not call getRedfishRoute here since the crashdump file is not a 35342a9beeedSShounak Mitra // Redfish resource. 353522d268cbSEd Tanous 3536*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 35377f3e84a1SEd Tanous { 35387f3e84a1SEd Tanous // Option currently returns no systems. TBD 35397f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 35407f3e84a1SEd Tanous systemName); 35417f3e84a1SEd Tanous return; 35427f3e84a1SEd Tanous } 354322d268cbSEd Tanous if (systemName != "system") 354422d268cbSEd Tanous { 354522d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 354622d268cbSEd Tanous systemName); 354722d268cbSEd Tanous return; 354822d268cbSEd Tanous } 354922d268cbSEd Tanous 3550043a0536SJohnathan Mantey auto getStoredLogCallback = 355139662a3bSEd Tanous [asyncResp, logID, fileName, url(boost::urls::url(req.url()))]( 35525e7e2dc5SEd Tanous const boost::system::error_code& ec, 3553002d39b4SEd Tanous const std::vector< 3554002d39b4SEd Tanous std::pair<std::string, dbus::utility::DbusVariantType>>& 35557e860f15SJohn Edward Broadbent resp) { 35561da66f75SEd Tanous if (ec) 35571da66f75SEd Tanous { 355862598e31SEd Tanous BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message()); 3559f12894f8SJason M. Bills messages::internalError(asyncResp->res); 35601da66f75SEd Tanous return; 35611da66f75SEd Tanous } 3562e855dd28SJason M. Bills 3563043a0536SJohnathan Mantey std::string dbusFilename{}; 3564043a0536SJohnathan Mantey std::string dbusTimestamp{}; 3565043a0536SJohnathan Mantey std::string dbusFilepath{}; 3566043a0536SJohnathan Mantey 3567002d39b4SEd Tanous parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp, 3568002d39b4SEd Tanous dbusFilepath); 3569043a0536SJohnathan Mantey 3570043a0536SJohnathan Mantey if (dbusFilename.empty() || dbusTimestamp.empty() || 3571043a0536SJohnathan Mantey dbusFilepath.empty()) 35721da66f75SEd Tanous { 35739db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 35741da66f75SEd Tanous return; 35751da66f75SEd Tanous } 3576e855dd28SJason M. Bills 3577043a0536SJohnathan Mantey // Verify the file name parameter is correct 3578043a0536SJohnathan Mantey if (fileName != dbusFilename) 3579043a0536SJohnathan Mantey { 35809db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 3581043a0536SJohnathan Mantey return; 3582043a0536SJohnathan Mantey } 3583043a0536SJohnathan Mantey 358427b0cf90SEd Tanous if (!asyncResp->res.openFile(dbusFilepath)) 3585043a0536SJohnathan Mantey { 35869db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 3587043a0536SJohnathan Mantey return; 3588043a0536SJohnathan Mantey } 3589043a0536SJohnathan Mantey 35907e860f15SJohn Edward Broadbent // Configure this to be a file download when accessed 35917e860f15SJohn Edward Broadbent // from a browser 3592d9f6c621SEd Tanous asyncResp->res.addHeader( 3593d9f6c621SEd Tanous boost::beast::http::field::content_disposition, "attachment"); 35941da66f75SEd Tanous }; 3595d1bde9e5SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 3596d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, crashdumpObject, 3597d1bde9e5SKrzysztof Grobelny crashdumpPath + std::string("/") + logID, crashdumpInterface, 3598d1bde9e5SKrzysztof Grobelny std::move(getStoredLogCallback)); 35997e860f15SJohn Edward Broadbent }); 36001da66f75SEd Tanous } 36011da66f75SEd Tanous 3602c5a4c82aSJason M. Bills enum class OEMDiagnosticType 3603c5a4c82aSJason M. Bills { 3604c5a4c82aSJason M. Bills onDemand, 3605c5a4c82aSJason M. Bills telemetry, 3606c5a4c82aSJason M. Bills invalid, 3607c5a4c82aSJason M. Bills }; 3608c5a4c82aSJason M. Bills 360926ccae32SEd Tanous inline OEMDiagnosticType getOEMDiagnosticType(std::string_view oemDiagStr) 3610c5a4c82aSJason M. Bills { 3611c5a4c82aSJason M. Bills if (oemDiagStr == "OnDemand") 3612c5a4c82aSJason M. Bills { 3613c5a4c82aSJason M. Bills return OEMDiagnosticType::onDemand; 3614c5a4c82aSJason M. Bills } 3615c5a4c82aSJason M. Bills if (oemDiagStr == "Telemetry") 3616c5a4c82aSJason M. Bills { 3617c5a4c82aSJason M. Bills return OEMDiagnosticType::telemetry; 3618c5a4c82aSJason M. Bills } 3619c5a4c82aSJason M. Bills 3620c5a4c82aSJason M. Bills return OEMDiagnosticType::invalid; 3621c5a4c82aSJason M. Bills } 3622c5a4c82aSJason M. Bills 36237e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app) 36241da66f75SEd Tanous { 36253946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 36263946028dSAppaRao Puli // method for security reasons. 36270fda0f12SGeorge Liu BMCWEB_ROUTE( 36280fda0f12SGeorge Liu app, 362922d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/") 3630ed398213SEd Tanous // The below is incorrect; Should be ConfigureManager 3631ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3632432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 3633002d39b4SEd Tanous .methods(boost::beast::http::verb::post)( 3634002d39b4SEd Tanous [&app](const crow::Request& req, 363522d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 363622d268cbSEd Tanous const std::string& systemName) { 36373ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 363845ca1b86SEd Tanous { 363945ca1b86SEd Tanous return; 364045ca1b86SEd Tanous } 364122d268cbSEd Tanous 3642*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 36437f3e84a1SEd Tanous { 36447f3e84a1SEd Tanous // Option currently returns no systems. TBD 36457f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 36467f3e84a1SEd Tanous systemName); 36477f3e84a1SEd Tanous return; 36487f3e84a1SEd Tanous } 364922d268cbSEd Tanous if (systemName != "system") 365022d268cbSEd Tanous { 365122d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 365222d268cbSEd Tanous systemName); 365322d268cbSEd Tanous return; 365422d268cbSEd Tanous } 365522d268cbSEd Tanous 36568e6c099aSJason M. Bills std::string diagnosticDataType; 36578e6c099aSJason M. Bills std::string oemDiagnosticDataType; 365815ed6780SWilly Tu if (!redfish::json_util::readJsonAction( 3659002d39b4SEd Tanous req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 3660002d39b4SEd Tanous "OEMDiagnosticDataType", oemDiagnosticDataType)) 36618e6c099aSJason M. Bills { 36628e6c099aSJason M. Bills return; 36638e6c099aSJason M. Bills } 36648e6c099aSJason M. Bills 36658e6c099aSJason M. Bills if (diagnosticDataType != "OEM") 36668e6c099aSJason M. Bills { 366762598e31SEd Tanous BMCWEB_LOG_ERROR( 366862598e31SEd Tanous "Only OEM DiagnosticDataType supported for Crashdump"); 36698e6c099aSJason M. Bills messages::actionParameterValueFormatError( 36708e6c099aSJason M. Bills asyncResp->res, diagnosticDataType, "DiagnosticDataType", 36718e6c099aSJason M. Bills "CollectDiagnosticData"); 36728e6c099aSJason M. Bills return; 36738e6c099aSJason M. Bills } 36748e6c099aSJason M. Bills 3675c5a4c82aSJason M. Bills OEMDiagnosticType oemDiagType = 3676c5a4c82aSJason M. Bills getOEMDiagnosticType(oemDiagnosticDataType); 3677c5a4c82aSJason M. Bills 3678c5a4c82aSJason M. Bills std::string iface; 3679c5a4c82aSJason M. Bills std::string method; 3680c5a4c82aSJason M. Bills std::string taskMatchStr; 3681c5a4c82aSJason M. Bills if (oemDiagType == OEMDiagnosticType::onDemand) 3682c5a4c82aSJason M. Bills { 3683c5a4c82aSJason M. Bills iface = crashdumpOnDemandInterface; 3684c5a4c82aSJason M. Bills method = "GenerateOnDemandLog"; 3685c5a4c82aSJason M. Bills taskMatchStr = "type='signal'," 3686c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 3687c5a4c82aSJason M. Bills "member='PropertiesChanged'," 3688c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 3689c5a4c82aSJason M. Bills } 3690c5a4c82aSJason M. Bills else if (oemDiagType == OEMDiagnosticType::telemetry) 3691c5a4c82aSJason M. Bills { 3692c5a4c82aSJason M. Bills iface = crashdumpTelemetryInterface; 3693c5a4c82aSJason M. Bills method = "GenerateTelemetryLog"; 3694c5a4c82aSJason M. Bills taskMatchStr = "type='signal'," 3695c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 3696c5a4c82aSJason M. Bills "member='PropertiesChanged'," 3697c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 3698c5a4c82aSJason M. Bills } 3699c5a4c82aSJason M. Bills else 3700c5a4c82aSJason M. Bills { 370162598e31SEd Tanous BMCWEB_LOG_ERROR("Unsupported OEMDiagnosticDataType: {}", 370262598e31SEd Tanous oemDiagnosticDataType); 3703c5a4c82aSJason M. Bills messages::actionParameterValueFormatError( 3704002d39b4SEd Tanous asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType", 3705002d39b4SEd Tanous "CollectDiagnosticData"); 3706c5a4c82aSJason M. Bills return; 3707c5a4c82aSJason M. Bills } 3708c5a4c82aSJason M. Bills 3709c5a4c82aSJason M. Bills auto collectCrashdumpCallback = 3710c5a4c82aSJason M. Bills [asyncResp, payload(task::Payload(req)), 37115e7e2dc5SEd Tanous taskMatchStr](const boost::system::error_code& ec, 371298be3e39SEd Tanous const std::string&) mutable { 37131da66f75SEd Tanous if (ec) 37141da66f75SEd Tanous { 3715002d39b4SEd Tanous if (ec.value() == boost::system::errc::operation_not_supported) 37161da66f75SEd Tanous { 3717f12894f8SJason M. Bills messages::resourceInStandby(asyncResp->res); 37181da66f75SEd Tanous } 37194363d3b2SJason M. Bills else if (ec.value() == 37204363d3b2SJason M. Bills boost::system::errc::device_or_resource_busy) 37214363d3b2SJason M. Bills { 3722002d39b4SEd Tanous messages::serviceTemporarilyUnavailable(asyncResp->res, 3723002d39b4SEd Tanous "60"); 37244363d3b2SJason M. Bills } 37251da66f75SEd Tanous else 37261da66f75SEd Tanous { 3727f12894f8SJason M. Bills messages::internalError(asyncResp->res); 37281da66f75SEd Tanous } 37291da66f75SEd Tanous return; 37301da66f75SEd Tanous } 3731002d39b4SEd Tanous std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 37328b24275dSEd Tanous [](const boost::system::error_code& ec2, sdbusplus::message_t&, 3733002d39b4SEd Tanous const std::shared_ptr<task::TaskData>& taskData) { 37348b24275dSEd Tanous if (!ec2) 373566afe4faSJames Feist { 3736002d39b4SEd Tanous taskData->messages.emplace_back(messages::taskCompletedOK( 3737e5d5006bSJames Feist std::to_string(taskData->index))); 3738831d6b09SJames Feist taskData->state = "Completed"; 373966afe4faSJames Feist } 374032898ceaSJames Feist return task::completed; 374166afe4faSJames Feist }, 3742c5a4c82aSJason M. Bills taskMatchStr); 3743c5a4c82aSJason M. Bills 374446229577SJames Feist task->startTimer(std::chrono::minutes(5)); 374546229577SJames Feist task->populateResp(asyncResp->res); 374698be3e39SEd Tanous task->payload.emplace(std::move(payload)); 37471da66f75SEd Tanous }; 37488e6c099aSJason M. Bills 37491da66f75SEd Tanous crow::connections::systemBus->async_method_call( 3750002d39b4SEd Tanous std::move(collectCrashdumpCallback), crashdumpObject, crashdumpPath, 3751002d39b4SEd Tanous iface, method); 37527e860f15SJohn Edward Broadbent }); 37536eda7685SKenny L. Ku } 37546eda7685SKenny L. Ku 3755cb92c03bSAndrew Geissler /** 3756cb92c03bSAndrew Geissler * DBusLogServiceActionsClear class supports POST method for ClearLog action. 3757cb92c03bSAndrew Geissler */ 37587e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app) 3759cb92c03bSAndrew Geissler { 3760cb92c03bSAndrew Geissler /** 3761cb92c03bSAndrew Geissler * Function handles POST method request. 3762cb92c03bSAndrew Geissler * The Clear Log actions does not require any parameter.The action deletes 3763cb92c03bSAndrew Geissler * all entries found in the Entries collection for this Log Service. 3764cb92c03bSAndrew Geissler */ 37657e860f15SJohn Edward Broadbent 37660fda0f12SGeorge Liu BMCWEB_ROUTE( 37670fda0f12SGeorge Liu app, 376822d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/") 3769ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 37707e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 377145ca1b86SEd Tanous [&app](const crow::Request& req, 377222d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 377322d268cbSEd Tanous const std::string& systemName) { 37743ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 377545ca1b86SEd Tanous { 377645ca1b86SEd Tanous return; 377745ca1b86SEd Tanous } 3778*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 37797f3e84a1SEd Tanous { 37807f3e84a1SEd Tanous // Option currently returns no systems. TBD 37817f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 37827f3e84a1SEd Tanous systemName); 37837f3e84a1SEd Tanous return; 37847f3e84a1SEd Tanous } 378522d268cbSEd Tanous if (systemName != "system") 378622d268cbSEd Tanous { 378722d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 378822d268cbSEd Tanous systemName); 378922d268cbSEd Tanous return; 379022d268cbSEd Tanous } 379162598e31SEd Tanous BMCWEB_LOG_DEBUG("Do delete all entries."); 3792cb92c03bSAndrew Geissler 3793cb92c03bSAndrew Geissler // Process response from Logging service. 37945e7e2dc5SEd Tanous auto respHandler = [asyncResp](const boost::system::error_code& ec) { 379562598e31SEd Tanous BMCWEB_LOG_DEBUG("doClearLog resp_handler callback: Done"); 3796cb92c03bSAndrew Geissler if (ec) 3797cb92c03bSAndrew Geissler { 3798cb92c03bSAndrew Geissler // TODO Handle for specific error code 379962598e31SEd Tanous BMCWEB_LOG_ERROR("doClearLog resp_handler got error {}", ec); 3800cb92c03bSAndrew Geissler asyncResp->res.result( 3801cb92c03bSAndrew Geissler boost::beast::http::status::internal_server_error); 3802cb92c03bSAndrew Geissler return; 3803cb92c03bSAndrew Geissler } 3804cb92c03bSAndrew Geissler 3805002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::no_content); 3806cb92c03bSAndrew Geissler }; 3807cb92c03bSAndrew Geissler 3808cb92c03bSAndrew Geissler // Make call to Logging service to request Clear Log 3809cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 38102c70f800SEd Tanous respHandler, "xyz.openbmc_project.Logging", 3811cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging", 3812cb92c03bSAndrew Geissler "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 38137e860f15SJohn Edward Broadbent }); 3814cb92c03bSAndrew Geissler } 3815a3316fc6SZhikuiRen 3816a3316fc6SZhikuiRen /**************************************************** 3817a3316fc6SZhikuiRen * Redfish PostCode interfaces 3818a3316fc6SZhikuiRen * using DBUS interface: getPostCodesTS 3819a3316fc6SZhikuiRen ******************************************************/ 38207e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesLogService(App& app) 3821a3316fc6SZhikuiRen { 382222d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/") 3823ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 3824002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 3825002d39b4SEd Tanous [&app](const crow::Request& req, 382622d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 382722d268cbSEd Tanous const std::string& systemName) { 38283ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 382945ca1b86SEd Tanous { 383045ca1b86SEd Tanous return; 383145ca1b86SEd Tanous } 3832*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 38337f3e84a1SEd Tanous { 38347f3e84a1SEd Tanous // Option currently returns no systems. TBD 38357f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 38367f3e84a1SEd Tanous systemName); 38377f3e84a1SEd Tanous return; 38387f3e84a1SEd Tanous } 383922d268cbSEd Tanous if (systemName != "system") 384022d268cbSEd Tanous { 384122d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 384222d268cbSEd Tanous systemName); 384322d268cbSEd Tanous return; 384422d268cbSEd Tanous } 38451476687dSEd Tanous asyncResp->res.jsonValue["@odata.id"] = 38461476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes"; 38471476687dSEd Tanous asyncResp->res.jsonValue["@odata.type"] = 3848b25644a1SJanet Adkins "#LogService.v1_2_0.LogService"; 38491476687dSEd Tanous asyncResp->res.jsonValue["Name"] = "POST Code Log Service"; 38501476687dSEd Tanous asyncResp->res.jsonValue["Description"] = "POST Code Log Service"; 3851ed34a4adSEd Tanous asyncResp->res.jsonValue["Id"] = "PostCodes"; 38521476687dSEd Tanous asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 38531476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 38541476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 38557c8c4058STejas Patil 38567c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 38572b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 38580fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 38597c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 38607c8c4058STejas Patil redfishDateTimeOffset.second; 38617c8c4058STejas Patil 3862a3316fc6SZhikuiRen asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 38637e860f15SJohn Edward Broadbent {"target", 38640fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog"}}; 38657e860f15SJohn Edward Broadbent }); 3866a3316fc6SZhikuiRen } 3867a3316fc6SZhikuiRen 38687e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesClear(App& app) 3869a3316fc6SZhikuiRen { 38700fda0f12SGeorge Liu BMCWEB_ROUTE( 38710fda0f12SGeorge Liu app, 387222d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/PostCodes/Actions/LogService.ClearLog/") 3873ed398213SEd Tanous // The following privilege is incorrect; It should be ConfigureManager 3874ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3875432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 38767e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 387745ca1b86SEd Tanous [&app](const crow::Request& req, 387822d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 387922d268cbSEd Tanous const std::string& systemName) { 38803ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 388145ca1b86SEd Tanous { 388245ca1b86SEd Tanous return; 388345ca1b86SEd Tanous } 3884*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 38857f3e84a1SEd Tanous { 38867f3e84a1SEd Tanous // Option currently returns no systems. TBD 38877f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 38887f3e84a1SEd Tanous systemName); 38897f3e84a1SEd Tanous return; 38907f3e84a1SEd Tanous } 389122d268cbSEd Tanous if (systemName != "system") 389222d268cbSEd Tanous { 389322d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 389422d268cbSEd Tanous systemName); 389522d268cbSEd Tanous return; 389622d268cbSEd Tanous } 389762598e31SEd Tanous BMCWEB_LOG_DEBUG("Do delete all postcodes entries."); 3898a3316fc6SZhikuiRen 3899a3316fc6SZhikuiRen // Make call to post-code service to request clear all 3900a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 39015e7e2dc5SEd Tanous [asyncResp](const boost::system::error_code& ec) { 3902a3316fc6SZhikuiRen if (ec) 3903a3316fc6SZhikuiRen { 3904a3316fc6SZhikuiRen // TODO Handle for specific error code 390562598e31SEd Tanous BMCWEB_LOG_ERROR("doClearPostCodes resp_handler got error {}", 390662598e31SEd Tanous ec); 3907002d39b4SEd Tanous asyncResp->res.result( 3908002d39b4SEd Tanous boost::beast::http::status::internal_server_error); 3909a3316fc6SZhikuiRen messages::internalError(asyncResp->res); 3910a3316fc6SZhikuiRen return; 3911a3316fc6SZhikuiRen } 391218fc70c0STony Lee messages::success(asyncResp->res); 3913a3316fc6SZhikuiRen }, 391415124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 391515124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3916a3316fc6SZhikuiRen "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 39177e860f15SJohn Edward Broadbent }); 3918a3316fc6SZhikuiRen } 3919a3316fc6SZhikuiRen 39206f284d24SJiaqing Zhao /** 39216f284d24SJiaqing Zhao * @brief Parse post code ID and get the current value and index value 39226f284d24SJiaqing Zhao * eg: postCodeID=B1-2, currentValue=1, index=2 39236f284d24SJiaqing Zhao * 39246f284d24SJiaqing Zhao * @param[in] postCodeID Post Code ID 39256f284d24SJiaqing Zhao * @param[out] currentValue Current value 39266f284d24SJiaqing Zhao * @param[out] index Index value 39276f284d24SJiaqing Zhao * 39286f284d24SJiaqing Zhao * @return bool true if the parsing is successful, false the parsing fails 39296f284d24SJiaqing Zhao */ 39306f056f24SEd Tanous inline bool parsePostCode(std::string_view postCodeID, uint64_t& currentValue, 3931df254f2cSEd Tanous uint16_t& index) 39326f284d24SJiaqing Zhao { 39336f284d24SJiaqing Zhao std::vector<std::string> split; 393450ebd4afSEd Tanous bmcweb::split(split, postCodeID, '-'); 39356f056f24SEd Tanous if (split.size() != 2) 39366f056f24SEd Tanous { 39376f056f24SEd Tanous return false; 39386f056f24SEd Tanous } 39396f056f24SEd Tanous std::string_view postCodeNumber = split[0]; 39406f056f24SEd Tanous if (postCodeNumber.size() < 2) 39416f056f24SEd Tanous { 39426f056f24SEd Tanous return false; 39436f056f24SEd Tanous } 39446f056f24SEd Tanous if (postCodeNumber[0] != 'B') 39456f056f24SEd Tanous { 39466f056f24SEd Tanous return false; 39476f056f24SEd Tanous } 39486f056f24SEd Tanous postCodeNumber.remove_prefix(1); 39496f056f24SEd Tanous auto [ptrIndex, ecIndex] = std::from_chars(postCodeNumber.begin(), 39506f056f24SEd Tanous postCodeNumber.end(), index); 39516f056f24SEd Tanous if (ptrIndex != postCodeNumber.end() || ecIndex != std::errc()) 39526f284d24SJiaqing Zhao { 39536f284d24SJiaqing Zhao return false; 39546f284d24SJiaqing Zhao } 39556f284d24SJiaqing Zhao 39566f056f24SEd Tanous std::string_view postCodeIndex = split[1]; 39576f284d24SJiaqing Zhao 39586f056f24SEd Tanous auto [ptrValue, ecValue] = std::from_chars( 39596f056f24SEd Tanous postCodeIndex.begin(), postCodeIndex.end(), currentValue); 39606f284d24SJiaqing Zhao 39616f056f24SEd Tanous return ptrValue == postCodeIndex.end() && ecValue == std::errc(); 39626f284d24SJiaqing Zhao } 39636f284d24SJiaqing Zhao 39646f284d24SJiaqing Zhao static bool fillPostCodeEntry( 3965ac106bf6SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 39666c9a279eSManojkiran Eda const boost::container::flat_map< 39676c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode, 3968a3316fc6SZhikuiRen const uint16_t bootIndex, const uint64_t codeIndex = 0, 3969a3316fc6SZhikuiRen const uint64_t skip = 0, const uint64_t top = 0) 3970a3316fc6SZhikuiRen { 3971a3316fc6SZhikuiRen // Get the Message from the MessageRegistry 3972fffb8c1fSEd Tanous const registries::Message* message = 3973fffb8c1fSEd Tanous registries::getMessage("OpenBMC.0.2.BIOSPOSTCode"); 3974dc8cfa66SEd Tanous if (message == nullptr) 3975dc8cfa66SEd Tanous { 3976dc8cfa66SEd Tanous BMCWEB_LOG_ERROR("Couldn't find known message?"); 3977dc8cfa66SEd Tanous return false; 3978dc8cfa66SEd Tanous } 3979a3316fc6SZhikuiRen uint64_t currentCodeIndex = 0; 3980a3316fc6SZhikuiRen uint64_t firstCodeTimeUs = 0; 39816c9a279eSManojkiran Eda for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 39826c9a279eSManojkiran Eda code : postcode) 3983a3316fc6SZhikuiRen { 3984a3316fc6SZhikuiRen currentCodeIndex++; 3985a3316fc6SZhikuiRen std::string postcodeEntryID = 3986a3316fc6SZhikuiRen "B" + std::to_string(bootIndex) + "-" + 3987a3316fc6SZhikuiRen std::to_string(currentCodeIndex); // 1 based index in EntryID string 3988a3316fc6SZhikuiRen 3989a3316fc6SZhikuiRen uint64_t usecSinceEpoch = code.first; 3990a3316fc6SZhikuiRen uint64_t usTimeOffset = 0; 3991a3316fc6SZhikuiRen 3992a3316fc6SZhikuiRen if (1 == currentCodeIndex) 3993a3316fc6SZhikuiRen { // already incremented 3994a3316fc6SZhikuiRen firstCodeTimeUs = code.first; 3995a3316fc6SZhikuiRen } 3996a3316fc6SZhikuiRen else 3997a3316fc6SZhikuiRen { 3998a3316fc6SZhikuiRen usTimeOffset = code.first - firstCodeTimeUs; 3999a3316fc6SZhikuiRen } 4000a3316fc6SZhikuiRen 4001a3316fc6SZhikuiRen // skip if no specific codeIndex is specified and currentCodeIndex does 4002a3316fc6SZhikuiRen // not fall between top and skip 4003a3316fc6SZhikuiRen if ((codeIndex == 0) && 4004a3316fc6SZhikuiRen (currentCodeIndex <= skip || currentCodeIndex > top)) 4005a3316fc6SZhikuiRen { 4006a3316fc6SZhikuiRen continue; 4007a3316fc6SZhikuiRen } 4008a3316fc6SZhikuiRen 40094e0453b1SGunnar Mills // skip if a specific codeIndex is specified and does not match the 4010a3316fc6SZhikuiRen // currentIndex 4011a3316fc6SZhikuiRen if ((codeIndex > 0) && (currentCodeIndex != codeIndex)) 4012a3316fc6SZhikuiRen { 4013a3316fc6SZhikuiRen // This is done for simplicity. 1st entry is needed to calculate 4014a3316fc6SZhikuiRen // time offset. To improve efficiency, one can get to the entry 4015a3316fc6SZhikuiRen // directly (possibly with flatmap's nth method) 4016a3316fc6SZhikuiRen continue; 4017a3316fc6SZhikuiRen } 4018a3316fc6SZhikuiRen 4019a3316fc6SZhikuiRen // currentCodeIndex is within top and skip or equal to specified code 4020a3316fc6SZhikuiRen // index 4021a3316fc6SZhikuiRen 4022a3316fc6SZhikuiRen // Get the Created time from the timestamp 4023a3316fc6SZhikuiRen std::string entryTimeStr; 40242a025611SKonstantin Aladyshev entryTimeStr = redfish::time_utils::getDateTimeUintUs(usecSinceEpoch); 4025a3316fc6SZhikuiRen 4026a3316fc6SZhikuiRen // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex) 4027a3316fc6SZhikuiRen std::ostringstream hexCode; 4028a3316fc6SZhikuiRen hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex 40296c9a279eSManojkiran Eda << std::get<0>(code.second); 4030a3316fc6SZhikuiRen std::ostringstream timeOffsetStr; 4031a3316fc6SZhikuiRen // Set Fixed -Point Notation 4032a3316fc6SZhikuiRen timeOffsetStr << std::fixed; 4033a3316fc6SZhikuiRen // Set precision to 4 digits 4034a3316fc6SZhikuiRen timeOffsetStr << std::setprecision(4); 4035a3316fc6SZhikuiRen // Add double to stream 4036a3316fc6SZhikuiRen timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000; 4037a3316fc6SZhikuiRen 40381e6deaf6SEd Tanous std::string bootIndexStr = std::to_string(bootIndex); 40391e6deaf6SEd Tanous std::string timeOffsetString = timeOffsetStr.str(); 40401e6deaf6SEd Tanous std::string hexCodeStr = hexCode.str(); 4041a3316fc6SZhikuiRen 40421e6deaf6SEd Tanous std::array<std::string_view, 3> messageArgs = { 40431e6deaf6SEd Tanous bootIndexStr, timeOffsetString, hexCodeStr}; 40441e6deaf6SEd Tanous 40451e6deaf6SEd Tanous std::string msg = 40461e6deaf6SEd Tanous redfish::registries::fillMessageArgs(messageArgs, message->message); 40471e6deaf6SEd Tanous if (msg.empty()) 4048a3316fc6SZhikuiRen { 40491e6deaf6SEd Tanous messages::internalError(asyncResp->res); 40501e6deaf6SEd Tanous return false; 4051a3316fc6SZhikuiRen } 4052a3316fc6SZhikuiRen 4053d4342a92STim Lee // Get Severity template from message registry 4054d4342a92STim Lee std::string severity; 4055d4342a92STim Lee if (message != nullptr) 4056d4342a92STim Lee { 40575f2b84eeSEd Tanous severity = message->messageSeverity; 4058d4342a92STim Lee } 4059d4342a92STim Lee 40606f284d24SJiaqing Zhao // Format entry 40616f284d24SJiaqing Zhao nlohmann::json::object_t bmcLogEntry; 40629c11a172SVijay Lobo bmcLogEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 4063ef4c65b7SEd Tanous bmcLogEntry["@odata.id"] = boost::urls::format( 4064ef4c65b7SEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/{}", 4065ef4c65b7SEd Tanous postcodeEntryID); 406684afc48bSJason M. Bills bmcLogEntry["Name"] = "POST Code Log Entry"; 406784afc48bSJason M. Bills bmcLogEntry["Id"] = postcodeEntryID; 406884afc48bSJason M. Bills bmcLogEntry["Message"] = std::move(msg); 406984afc48bSJason M. Bills bmcLogEntry["MessageId"] = "OpenBMC.0.2.BIOSPOSTCode"; 40701e6deaf6SEd Tanous bmcLogEntry["MessageArgs"] = messageArgs; 407184afc48bSJason M. Bills bmcLogEntry["EntryType"] = "Event"; 407284afc48bSJason M. Bills bmcLogEntry["Severity"] = std::move(severity); 407384afc48bSJason M. Bills bmcLogEntry["Created"] = entryTimeStr; 4074647b3cdcSGeorge Liu if (!std::get<std::vector<uint8_t>>(code.second).empty()) 4075647b3cdcSGeorge Liu { 4076647b3cdcSGeorge Liu bmcLogEntry["AdditionalDataURI"] = 4077647b3cdcSGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 4078647b3cdcSGeorge Liu postcodeEntryID + "/attachment"; 4079647b3cdcSGeorge Liu } 40806f284d24SJiaqing Zhao 40816f284d24SJiaqing Zhao // codeIndex is only specified when querying single entry, return only 40826f284d24SJiaqing Zhao // that entry in this case 40836f284d24SJiaqing Zhao if (codeIndex != 0) 40846f284d24SJiaqing Zhao { 4085ac106bf6SEd Tanous asyncResp->res.jsonValue.update(bmcLogEntry); 40866f284d24SJiaqing Zhao return true; 4087a3316fc6SZhikuiRen } 40886f284d24SJiaqing Zhao 4089ac106bf6SEd Tanous nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 4090b2ba3072SPatrick Williams logEntryArray.emplace_back(std::move(bmcLogEntry)); 40916f284d24SJiaqing Zhao } 40926f284d24SJiaqing Zhao 40936f284d24SJiaqing Zhao // Return value is always false when querying multiple entries 40946f284d24SJiaqing Zhao return false; 4095a3316fc6SZhikuiRen } 4096a3316fc6SZhikuiRen 4097ac106bf6SEd Tanous static void 4098ac106bf6SEd Tanous getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 40996f284d24SJiaqing Zhao const std::string& entryId) 4100a3316fc6SZhikuiRen { 41016f284d24SJiaqing Zhao uint16_t bootIndex = 0; 41026f284d24SJiaqing Zhao uint64_t codeIndex = 0; 41036f284d24SJiaqing Zhao if (!parsePostCode(entryId, codeIndex, bootIndex)) 41046f284d24SJiaqing Zhao { 41056f284d24SJiaqing Zhao // Requested ID was not found 4106ac106bf6SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryId); 41076f284d24SJiaqing Zhao return; 41086f284d24SJiaqing Zhao } 41096f284d24SJiaqing Zhao 41106f284d24SJiaqing Zhao if (bootIndex == 0 || codeIndex == 0) 41116f284d24SJiaqing Zhao { 41126f284d24SJiaqing Zhao // 0 is an invalid index 4113ac106bf6SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryId); 41146f284d24SJiaqing Zhao return; 41156f284d24SJiaqing Zhao } 41166f284d24SJiaqing Zhao 4117a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 4118ac106bf6SEd Tanous [asyncResp, entryId, bootIndex, 41195e7e2dc5SEd Tanous codeIndex](const boost::system::error_code& ec, 41206c9a279eSManojkiran Eda const boost::container::flat_map< 41216c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 41226c9a279eSManojkiran Eda postcode) { 4123a3316fc6SZhikuiRen if (ec) 4124a3316fc6SZhikuiRen { 412562598e31SEd Tanous BMCWEB_LOG_DEBUG("DBUS POST CODE PostCode response error"); 4126ac106bf6SEd Tanous messages::internalError(asyncResp->res); 4127a3316fc6SZhikuiRen return; 4128a3316fc6SZhikuiRen } 4129a3316fc6SZhikuiRen 4130a3316fc6SZhikuiRen if (postcode.empty()) 4131a3316fc6SZhikuiRen { 4132ac106bf6SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryId); 4133a3316fc6SZhikuiRen return; 4134a3316fc6SZhikuiRen } 4135a3316fc6SZhikuiRen 4136ac106bf6SEd Tanous if (!fillPostCodeEntry(asyncResp, postcode, bootIndex, codeIndex)) 41376f284d24SJiaqing Zhao { 4138ac106bf6SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", entryId); 41396f284d24SJiaqing Zhao return; 41406f284d24SJiaqing Zhao } 4141a3316fc6SZhikuiRen }, 414215124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 414315124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 4144a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 4145a3316fc6SZhikuiRen bootIndex); 4146a3316fc6SZhikuiRen } 4147a3316fc6SZhikuiRen 4148ac106bf6SEd Tanous static void 4149ac106bf6SEd Tanous getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 4150ac106bf6SEd Tanous const uint16_t bootIndex, const uint16_t bootCount, 4151ac106bf6SEd Tanous const uint64_t entryCount, size_t skip, size_t top) 4152a3316fc6SZhikuiRen { 4153a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 4154ac106bf6SEd Tanous [asyncResp, bootIndex, bootCount, entryCount, skip, 41555e7e2dc5SEd Tanous top](const boost::system::error_code& ec, 41566c9a279eSManojkiran Eda const boost::container::flat_map< 41576c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 41586c9a279eSManojkiran Eda postcode) { 4159a3316fc6SZhikuiRen if (ec) 4160a3316fc6SZhikuiRen { 416162598e31SEd Tanous BMCWEB_LOG_DEBUG("DBUS POST CODE PostCode response error"); 4162ac106bf6SEd Tanous messages::internalError(asyncResp->res); 4163a3316fc6SZhikuiRen return; 4164a3316fc6SZhikuiRen } 4165a3316fc6SZhikuiRen 4166a3316fc6SZhikuiRen uint64_t endCount = entryCount; 4167a3316fc6SZhikuiRen if (!postcode.empty()) 4168a3316fc6SZhikuiRen { 4169a3316fc6SZhikuiRen endCount = entryCount + postcode.size(); 41703648c8beSEd Tanous if (skip < endCount && (top + skip) > entryCount) 4171a3316fc6SZhikuiRen { 417289492a15SPatrick Williams uint64_t thisBootSkip = std::max(static_cast<uint64_t>(skip), 417389492a15SPatrick Williams entryCount) - 41743648c8beSEd Tanous entryCount; 4175a3316fc6SZhikuiRen uint64_t thisBootTop = 41763648c8beSEd Tanous std::min(static_cast<uint64_t>(top + skip), endCount) - 41773648c8beSEd Tanous entryCount; 4178a3316fc6SZhikuiRen 4179ac106bf6SEd Tanous fillPostCodeEntry(asyncResp, postcode, bootIndex, 0, 4180ac106bf6SEd Tanous thisBootSkip, thisBootTop); 4181a3316fc6SZhikuiRen } 4182ac106bf6SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = endCount; 4183a3316fc6SZhikuiRen } 4184a3316fc6SZhikuiRen 4185a3316fc6SZhikuiRen // continue to previous bootIndex 4186a3316fc6SZhikuiRen if (bootIndex < bootCount) 4187a3316fc6SZhikuiRen { 4188ac106bf6SEd Tanous getPostCodeForBoot(asyncResp, static_cast<uint16_t>(bootIndex + 1), 4189a3316fc6SZhikuiRen bootCount, endCount, skip, top); 4190a3316fc6SZhikuiRen } 419181584abeSJiaqing Zhao else if (skip + top < endCount) 4192a3316fc6SZhikuiRen { 4193ac106bf6SEd Tanous asyncResp->res.jsonValue["Members@odata.nextLink"] = 41940fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=" + 4195a3316fc6SZhikuiRen std::to_string(skip + top); 4196a3316fc6SZhikuiRen } 4197a3316fc6SZhikuiRen }, 419815124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 419915124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 4200a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 4201a3316fc6SZhikuiRen bootIndex); 4202a3316fc6SZhikuiRen } 4203a3316fc6SZhikuiRen 42048d1b46d7Szhanghch05 static void 4205ac106bf6SEd Tanous getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 42063648c8beSEd Tanous size_t skip, size_t top) 4207a3316fc6SZhikuiRen { 4208a3316fc6SZhikuiRen uint64_t entryCount = 0; 42091e1e598dSJonathan Doman sdbusplus::asio::getProperty<uint16_t>( 42101e1e598dSJonathan Doman *crow::connections::systemBus, 42111e1e598dSJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 42121e1e598dSJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 42131e1e598dSJonathan Doman "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount", 4214ac106bf6SEd Tanous [asyncResp, entryCount, skip, top](const boost::system::error_code& ec, 42151e1e598dSJonathan Doman const uint16_t bootCount) { 4216a3316fc6SZhikuiRen if (ec) 4217a3316fc6SZhikuiRen { 421862598e31SEd Tanous BMCWEB_LOG_DEBUG("DBUS response error {}", ec); 4219ac106bf6SEd Tanous messages::internalError(asyncResp->res); 4220a3316fc6SZhikuiRen return; 4221a3316fc6SZhikuiRen } 4222ac106bf6SEd Tanous getPostCodeForBoot(asyncResp, 1, bootCount, entryCount, skip, top); 42231e1e598dSJonathan Doman }); 4224a3316fc6SZhikuiRen } 4225a3316fc6SZhikuiRen 42267e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntryCollection(App& app) 4227a3316fc6SZhikuiRen { 42287e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 422922d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/") 4230ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 42317e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 423245ca1b86SEd Tanous [&app](const crow::Request& req, 423322d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 423422d268cbSEd Tanous const std::string& systemName) { 4235c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 4236c937d2bfSEd Tanous .canDelegateTop = true, 4237c937d2bfSEd Tanous .canDelegateSkip = true, 4238c937d2bfSEd Tanous }; 4239c937d2bfSEd Tanous query_param::Query delegatedQuery; 4240c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 42413ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 424245ca1b86SEd Tanous { 424345ca1b86SEd Tanous return; 424445ca1b86SEd Tanous } 4245*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 42467f3e84a1SEd Tanous { 42477f3e84a1SEd Tanous // Option currently returns no systems. TBD 42487f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 42497f3e84a1SEd Tanous systemName); 42507f3e84a1SEd Tanous return; 42517f3e84a1SEd Tanous } 425222d268cbSEd Tanous 425322d268cbSEd Tanous if (systemName != "system") 425422d268cbSEd Tanous { 425522d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 425622d268cbSEd Tanous systemName); 425722d268cbSEd Tanous return; 425822d268cbSEd Tanous } 4259a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.type"] = 4260a3316fc6SZhikuiRen "#LogEntryCollection.LogEntryCollection"; 4261a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 4262a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 4263a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 4264a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 4265a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 4266a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 4267a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 42683648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 42695143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 42703648c8beSEd Tanous getCurrentBootNumber(asyncResp, skip, top); 42717e860f15SJohn Edward Broadbent }); 4272a3316fc6SZhikuiRen } 4273a3316fc6SZhikuiRen 4274647b3cdcSGeorge Liu inline void requestRoutesPostCodesEntryAdditionalData(App& app) 4275647b3cdcSGeorge Liu { 42760fda0f12SGeorge Liu BMCWEB_ROUTE( 42770fda0f12SGeorge Liu app, 427822d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/attachment/") 4279647b3cdcSGeorge Liu .privileges(redfish::privileges::getLogEntry) 4280647b3cdcSGeorge Liu .methods(boost::beast::http::verb::get)( 428145ca1b86SEd Tanous [&app](const crow::Request& req, 4282647b3cdcSGeorge Liu const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 428322d268cbSEd Tanous const std::string& systemName, 4284647b3cdcSGeorge Liu const std::string& postCodeID) { 42853ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 428645ca1b86SEd Tanous { 428745ca1b86SEd Tanous return; 428845ca1b86SEd Tanous } 428972e21377SMatt Spinler if (!http_helpers::isContentTypeAllowed( 429099351cd8SEd Tanous req.getHeaderValue("Accept"), 42914a0e1a0cSEd Tanous http_helpers::ContentType::OctetStream, true)) 4292647b3cdcSGeorge Liu { 4293002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::bad_request); 4294647b3cdcSGeorge Liu return; 4295647b3cdcSGeorge Liu } 4296*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 42977f3e84a1SEd Tanous { 42987f3e84a1SEd Tanous // Option currently returns no systems. TBD 42997f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 43007f3e84a1SEd Tanous systemName); 43017f3e84a1SEd Tanous return; 43027f3e84a1SEd Tanous } 430322d268cbSEd Tanous if (systemName != "system") 430422d268cbSEd Tanous { 430522d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 430622d268cbSEd Tanous systemName); 430722d268cbSEd Tanous return; 430822d268cbSEd Tanous } 4309647b3cdcSGeorge Liu 4310647b3cdcSGeorge Liu uint64_t currentValue = 0; 4311647b3cdcSGeorge Liu uint16_t index = 0; 4312647b3cdcSGeorge Liu if (!parsePostCode(postCodeID, currentValue, index)) 4313647b3cdcSGeorge Liu { 4314002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", postCodeID); 4315647b3cdcSGeorge Liu return; 4316647b3cdcSGeorge Liu } 4317647b3cdcSGeorge Liu 4318647b3cdcSGeorge Liu crow::connections::systemBus->async_method_call( 4319647b3cdcSGeorge Liu [asyncResp, postCodeID, currentValue]( 43205e7e2dc5SEd Tanous const boost::system::error_code& ec, 4321002d39b4SEd Tanous const std::vector<std::tuple<uint64_t, std::vector<uint8_t>>>& 4322002d39b4SEd Tanous postcodes) { 4323647b3cdcSGeorge Liu if (ec.value() == EBADR) 4324647b3cdcSGeorge Liu { 4325002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 4326002d39b4SEd Tanous postCodeID); 4327647b3cdcSGeorge Liu return; 4328647b3cdcSGeorge Liu } 4329647b3cdcSGeorge Liu if (ec) 4330647b3cdcSGeorge Liu { 433162598e31SEd Tanous BMCWEB_LOG_DEBUG("DBUS response error {}", ec); 4332647b3cdcSGeorge Liu messages::internalError(asyncResp->res); 4333647b3cdcSGeorge Liu return; 4334647b3cdcSGeorge Liu } 4335647b3cdcSGeorge Liu 4336647b3cdcSGeorge Liu size_t value = static_cast<size_t>(currentValue) - 1; 4337002d39b4SEd Tanous if (value == std::string::npos || postcodes.size() < currentValue) 4338647b3cdcSGeorge Liu { 433962598e31SEd Tanous BMCWEB_LOG_WARNING("Wrong currentValue value"); 4340002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 4341002d39b4SEd Tanous postCodeID); 4342647b3cdcSGeorge Liu return; 4343647b3cdcSGeorge Liu } 4344647b3cdcSGeorge Liu 43459eb808c1SEd Tanous const auto& [tID, c] = postcodes[value]; 434646ff87baSEd Tanous if (c.empty()) 4347647b3cdcSGeorge Liu { 434862598e31SEd Tanous BMCWEB_LOG_WARNING("No found post code data"); 4349002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 4350002d39b4SEd Tanous postCodeID); 4351647b3cdcSGeorge Liu return; 4352647b3cdcSGeorge Liu } 435346ff87baSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) 435446ff87baSEd Tanous const char* d = reinterpret_cast<const char*>(c.data()); 435546ff87baSEd Tanous std::string_view strData(d, c.size()); 4356647b3cdcSGeorge Liu 4357d9f6c621SEd Tanous asyncResp->res.addHeader(boost::beast::http::field::content_type, 4358647b3cdcSGeorge Liu "application/octet-stream"); 4359d9f6c621SEd Tanous asyncResp->res.addHeader( 4360d9f6c621SEd Tanous boost::beast::http::field::content_transfer_encoding, "Base64"); 436127b0cf90SEd Tanous asyncResp->res.write(crow::utility::base64encode(strData)); 4362647b3cdcSGeorge Liu }, 4363647b3cdcSGeorge Liu "xyz.openbmc_project.State.Boot.PostCode0", 4364647b3cdcSGeorge Liu "/xyz/openbmc_project/State/Boot/PostCode0", 4365002d39b4SEd Tanous "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", index); 4366647b3cdcSGeorge Liu }); 4367647b3cdcSGeorge Liu } 4368647b3cdcSGeorge Liu 43697e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntry(App& app) 4370a3316fc6SZhikuiRen { 43717e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 437222d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/") 4373ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 43747e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 437545ca1b86SEd Tanous [&app](const crow::Request& req, 43767e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 437722d268cbSEd Tanous const std::string& systemName, const std::string& targetID) { 43783ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 437945ca1b86SEd Tanous { 438045ca1b86SEd Tanous return; 438145ca1b86SEd Tanous } 4382*25b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 43837f3e84a1SEd Tanous { 43847f3e84a1SEd Tanous // Option currently returns no systems. TBD 43857f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 43867f3e84a1SEd Tanous systemName); 43877f3e84a1SEd Tanous return; 43887f3e84a1SEd Tanous } 438922d268cbSEd Tanous if (systemName != "system") 439022d268cbSEd Tanous { 439122d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 439222d268cbSEd Tanous systemName); 439322d268cbSEd Tanous return; 439422d268cbSEd Tanous } 439522d268cbSEd Tanous 43966f284d24SJiaqing Zhao getPostCodeForEntry(asyncResp, targetID); 43977e860f15SJohn Edward Broadbent }); 4398a3316fc6SZhikuiRen } 4399a3316fc6SZhikuiRen 44001da66f75SEd Tanous } // namespace redfish 4401