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 18b7028ebfSSpencer Ku #include "gzfile.hpp" 19647b3cdcSGeorge Liu #include "http_utility.hpp" 20b7028ebfSSpencer Ku #include "human_sort.hpp" 214851d45dSJason M. Bills #include "registries.hpp" 224851d45dSJason M. Bills #include "registries/base_message_registry.hpp" 234851d45dSJason M. Bills #include "registries/openbmc_message_registry.hpp" 2446229577SJames Feist #include "task.hpp" 251da66f75SEd Tanous 26e1f26343SJason M. Bills #include <systemd/sd-journal.h> 27400fd1fbSAdriana Kobylak #include <unistd.h> 28e1f26343SJason M. Bills 297e860f15SJohn Edward Broadbent #include <app.hpp> 30400fd1fbSAdriana Kobylak #include <boost/algorithm/string/replace.hpp> 314851d45dSJason M. Bills #include <boost/algorithm/string/split.hpp> 32400fd1fbSAdriana Kobylak #include <boost/beast/http.hpp> 331da66f75SEd Tanous #include <boost/container/flat_map.hpp> 341ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp> 35168e20c1SEd Tanous #include <dbus_utility.hpp> 36cb92c03bSAndrew Geissler #include <error_messages.hpp> 3745ca1b86SEd Tanous #include <query.hpp> 38ed398213SEd Tanous #include <registries/privilege_registry.hpp> 391214b7e7SGunnar Mills 40647b3cdcSGeorge Liu #include <charconv> 414418c7f0SJames Feist #include <filesystem> 4275710de2SXiaochao Ma #include <optional> 4326702d01SEd Tanous #include <span> 44cd225da8SJason M. Bills #include <string_view> 45abf2add6SEd Tanous #include <variant> 461da66f75SEd Tanous 471da66f75SEd Tanous namespace redfish 481da66f75SEd Tanous { 491da66f75SEd Tanous 505b61b5e8SJason M. Bills constexpr char const* crashdumpObject = "com.intel.crashdump"; 515b61b5e8SJason M. Bills constexpr char const* crashdumpPath = "/com/intel/crashdump"; 525b61b5e8SJason M. Bills constexpr char const* crashdumpInterface = "com.intel.crashdump"; 535b61b5e8SJason M. Bills constexpr char const* deleteAllInterface = 545b61b5e8SJason M. Bills "xyz.openbmc_project.Collection.DeleteAll"; 555b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandInterface = 56424c4176SJason M. Bills "com.intel.crashdump.OnDemand"; 576eda7685SKenny L. Ku constexpr char const* crashdumpTelemetryInterface = 586eda7685SKenny L. Ku "com.intel.crashdump.Telemetry"; 591da66f75SEd Tanous 60fffb8c1fSEd Tanous namespace registries 614851d45dSJason M. Bills { 6226702d01SEd Tanous static const Message* 6326702d01SEd Tanous getMessageFromRegistry(const std::string& messageKey, 6426702d01SEd Tanous const std::span<const MessageEntry> registry) 654851d45dSJason M. Bills { 66002d39b4SEd Tanous std::span<const MessageEntry>::iterator messageIt = 67002d39b4SEd Tanous std::find_if(registry.begin(), registry.end(), 684851d45dSJason M. Bills [&messageKey](const MessageEntry& messageEntry) { 69e662eae8SEd Tanous return std::strcmp(messageEntry.first, messageKey.c_str()) == 0; 704851d45dSJason M. Bills }); 7126702d01SEd Tanous if (messageIt != registry.end()) 724851d45dSJason M. Bills { 734851d45dSJason M. Bills return &messageIt->second; 744851d45dSJason M. Bills } 754851d45dSJason M. Bills 764851d45dSJason M. Bills return nullptr; 774851d45dSJason M. Bills } 784851d45dSJason M. Bills 794851d45dSJason M. Bills static const Message* getMessage(const std::string_view& messageID) 804851d45dSJason M. Bills { 814851d45dSJason M. Bills // Redfish MessageIds are in the form 824851d45dSJason M. Bills // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 834851d45dSJason M. Bills // the right Message 844851d45dSJason M. Bills std::vector<std::string> fields; 854851d45dSJason M. Bills fields.reserve(4); 864851d45dSJason M. Bills boost::split(fields, messageID, boost::is_any_of(".")); 874851d45dSJason M. Bills std::string& registryName = fields[0]; 884851d45dSJason M. Bills std::string& messageKey = fields[3]; 894851d45dSJason M. Bills 904851d45dSJason M. Bills // Find the right registry and check it for the MessageKey 914851d45dSJason M. Bills if (std::string(base::header.registryPrefix) == registryName) 924851d45dSJason M. Bills { 934851d45dSJason M. Bills return getMessageFromRegistry( 9426702d01SEd Tanous messageKey, std::span<const MessageEntry>(base::registry)); 954851d45dSJason M. Bills } 964851d45dSJason M. Bills if (std::string(openbmc::header.registryPrefix) == registryName) 974851d45dSJason M. Bills { 984851d45dSJason M. Bills return getMessageFromRegistry( 9926702d01SEd Tanous messageKey, std::span<const MessageEntry>(openbmc::registry)); 1004851d45dSJason M. Bills } 1014851d45dSJason M. Bills return nullptr; 1024851d45dSJason M. Bills } 103fffb8c1fSEd Tanous } // namespace registries 1044851d45dSJason M. Bills 105f6150403SJames Feist namespace fs = std::filesystem; 1061da66f75SEd Tanous 107cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s) 108cb92c03bSAndrew Geissler { 109d4d25793SEd Tanous if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") || 110d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") || 111d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") || 112d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Error")) 113cb92c03bSAndrew Geissler { 114cb92c03bSAndrew Geissler return "Critical"; 115cb92c03bSAndrew Geissler } 1163174e4dfSEd Tanous if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") || 117d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") || 118d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Notice")) 119cb92c03bSAndrew Geissler { 120cb92c03bSAndrew Geissler return "OK"; 121cb92c03bSAndrew Geissler } 1223174e4dfSEd Tanous if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning") 123cb92c03bSAndrew Geissler { 124cb92c03bSAndrew Geissler return "Warning"; 125cb92c03bSAndrew Geissler } 126cb92c03bSAndrew Geissler return ""; 127cb92c03bSAndrew Geissler } 128cb92c03bSAndrew Geissler 1297e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal, 13039e77504SEd Tanous const std::string_view& field, 13139e77504SEd Tanous std::string_view& contents) 13216428a1aSJason M. Bills { 13316428a1aSJason M. Bills const char* data = nullptr; 13416428a1aSJason M. Bills size_t length = 0; 13516428a1aSJason M. Bills int ret = 0; 13616428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 13746ff87baSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) 13846ff87baSEd Tanous const void** dataVoid = reinterpret_cast<const void**>(&data); 13946ff87baSEd Tanous 14046ff87baSEd Tanous ret = sd_journal_get_data(journal, field.data(), dataVoid, &length); 14116428a1aSJason M. Bills if (ret < 0) 14216428a1aSJason M. Bills { 14316428a1aSJason M. Bills return ret; 14416428a1aSJason M. Bills } 14539e77504SEd Tanous contents = std::string_view(data, length); 14616428a1aSJason M. Bills // Only use the content after the "=" character. 14781ce609eSEd Tanous contents.remove_prefix(std::min(contents.find('=') + 1, contents.size())); 14816428a1aSJason M. Bills return ret; 14916428a1aSJason M. Bills } 15016428a1aSJason M. Bills 1517e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal, 1527e860f15SJohn Edward Broadbent const std::string_view& field, 1537e860f15SJohn Edward Broadbent const int& base, long int& contents) 15416428a1aSJason M. Bills { 15516428a1aSJason M. Bills int ret = 0; 15639e77504SEd Tanous std::string_view metadata; 15716428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 15816428a1aSJason M. Bills ret = getJournalMetadata(journal, field, metadata); 15916428a1aSJason M. Bills if (ret < 0) 16016428a1aSJason M. Bills { 16116428a1aSJason M. Bills return ret; 16216428a1aSJason M. Bills } 163b01bf299SEd Tanous contents = strtol(metadata.data(), nullptr, base); 16416428a1aSJason M. Bills return ret; 16516428a1aSJason M. Bills } 16616428a1aSJason M. Bills 1677e860f15SJohn Edward Broadbent inline static bool getEntryTimestamp(sd_journal* journal, 1687e860f15SJohn Edward Broadbent std::string& entryTimestamp) 169a3316fc6SZhikuiRen { 170a3316fc6SZhikuiRen int ret = 0; 171a3316fc6SZhikuiRen uint64_t timestamp = 0; 172a3316fc6SZhikuiRen ret = sd_journal_get_realtime_usec(journal, ×tamp); 173a3316fc6SZhikuiRen if (ret < 0) 174a3316fc6SZhikuiRen { 175a3316fc6SZhikuiRen BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 176a3316fc6SZhikuiRen << strerror(-ret); 177a3316fc6SZhikuiRen return false; 178a3316fc6SZhikuiRen } 1791d8782e7SNan Zhou entryTimestamp = crow::utility::getDateTimeUint(timestamp / 1000 / 1000); 1809c620e21SAsmitha Karunanithi return true; 181a3316fc6SZhikuiRen } 18250b8a43aSEd Tanous 1837e860f15SJohn Edward Broadbent inline static bool getUniqueEntryID(sd_journal* journal, std::string& entryID, 184e85d6b16SJason M. Bills const bool firstEntry = true) 18516428a1aSJason M. Bills { 18616428a1aSJason M. Bills int ret = 0; 18716428a1aSJason M. Bills static uint64_t prevTs = 0; 18816428a1aSJason M. Bills static int index = 0; 189e85d6b16SJason M. Bills if (firstEntry) 190e85d6b16SJason M. Bills { 191e85d6b16SJason M. Bills prevTs = 0; 192e85d6b16SJason M. Bills } 193e85d6b16SJason M. Bills 19416428a1aSJason M. Bills // Get the entry timestamp 19516428a1aSJason M. Bills uint64_t curTs = 0; 19616428a1aSJason M. Bills ret = sd_journal_get_realtime_usec(journal, &curTs); 19716428a1aSJason M. Bills if (ret < 0) 19816428a1aSJason M. Bills { 19916428a1aSJason M. Bills BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 20016428a1aSJason M. Bills << strerror(-ret); 20116428a1aSJason M. Bills return false; 20216428a1aSJason M. Bills } 20316428a1aSJason M. Bills // If the timestamp isn't unique, increment the index 20416428a1aSJason M. Bills if (curTs == prevTs) 20516428a1aSJason M. Bills { 20616428a1aSJason M. Bills index++; 20716428a1aSJason M. Bills } 20816428a1aSJason M. Bills else 20916428a1aSJason M. Bills { 21016428a1aSJason M. Bills // Otherwise, reset it 21116428a1aSJason M. Bills index = 0; 21216428a1aSJason M. Bills } 21316428a1aSJason M. Bills // Save the timestamp 21416428a1aSJason M. Bills prevTs = curTs; 21516428a1aSJason M. Bills 21616428a1aSJason M. Bills entryID = std::to_string(curTs); 21716428a1aSJason M. Bills if (index > 0) 21816428a1aSJason M. Bills { 21916428a1aSJason M. Bills entryID += "_" + std::to_string(index); 22016428a1aSJason M. Bills } 22116428a1aSJason M. Bills return true; 22216428a1aSJason M. Bills } 22316428a1aSJason M. Bills 224e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID, 225e85d6b16SJason M. Bills const bool firstEntry = true) 22695820184SJason M. Bills { 227271584abSEd Tanous static time_t prevTs = 0; 22895820184SJason M. Bills static int index = 0; 229e85d6b16SJason M. Bills if (firstEntry) 230e85d6b16SJason M. Bills { 231e85d6b16SJason M. Bills prevTs = 0; 232e85d6b16SJason M. Bills } 233e85d6b16SJason M. Bills 23495820184SJason M. Bills // Get the entry timestamp 235271584abSEd Tanous std::time_t curTs = 0; 23695820184SJason M. Bills std::tm timeStruct = {}; 23795820184SJason M. Bills std::istringstream entryStream(logEntry); 23895820184SJason M. Bills if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 23995820184SJason M. Bills { 24095820184SJason M. Bills curTs = std::mktime(&timeStruct); 24195820184SJason M. Bills } 24295820184SJason M. Bills // If the timestamp isn't unique, increment the index 24395820184SJason M. Bills if (curTs == prevTs) 24495820184SJason M. Bills { 24595820184SJason M. Bills index++; 24695820184SJason M. Bills } 24795820184SJason M. Bills else 24895820184SJason M. Bills { 24995820184SJason M. Bills // Otherwise, reset it 25095820184SJason M. Bills index = 0; 25195820184SJason M. Bills } 25295820184SJason M. Bills // Save the timestamp 25395820184SJason M. Bills prevTs = curTs; 25495820184SJason M. Bills 25595820184SJason M. Bills entryID = std::to_string(curTs); 25695820184SJason M. Bills if (index > 0) 25795820184SJason M. Bills { 25895820184SJason M. Bills entryID += "_" + std::to_string(index); 25995820184SJason M. Bills } 26095820184SJason M. Bills return true; 26195820184SJason M. Bills } 26295820184SJason M. Bills 2637e860f15SJohn Edward Broadbent inline static bool 2648d1b46d7Szhanghch05 getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2658d1b46d7Szhanghch05 const std::string& entryID, uint64_t& timestamp, 2668d1b46d7Szhanghch05 uint64_t& index) 26716428a1aSJason M. Bills { 26816428a1aSJason M. Bills if (entryID.empty()) 26916428a1aSJason M. Bills { 27016428a1aSJason M. Bills return false; 27116428a1aSJason M. Bills } 27216428a1aSJason M. Bills // Convert the unique ID back to a timestamp to find the entry 27339e77504SEd Tanous std::string_view tsStr(entryID); 27416428a1aSJason M. Bills 27581ce609eSEd Tanous auto underscorePos = tsStr.find('_'); 27671d5d8dbSEd Tanous if (underscorePos != std::string_view::npos) 27716428a1aSJason M. Bills { 27816428a1aSJason M. Bills // Timestamp has an index 27916428a1aSJason M. Bills tsStr.remove_suffix(tsStr.size() - underscorePos); 28039e77504SEd Tanous std::string_view indexStr(entryID); 28116428a1aSJason M. Bills indexStr.remove_prefix(underscorePos + 1); 282c0bd5e4bSEd Tanous auto [ptr, ec] = std::from_chars( 283c0bd5e4bSEd Tanous indexStr.data(), indexStr.data() + indexStr.size(), index); 284c0bd5e4bSEd Tanous if (ec != std::errc()) 28516428a1aSJason M. Bills { 286ace85d60SEd Tanous messages::resourceMissingAtURI( 287ace85d60SEd Tanous asyncResp->res, crow::utility::urlFromPieces(entryID)); 28816428a1aSJason M. Bills return false; 28916428a1aSJason M. Bills } 29016428a1aSJason M. Bills } 29116428a1aSJason M. Bills // Timestamp has no index 292c0bd5e4bSEd Tanous auto [ptr, ec] = 293c0bd5e4bSEd Tanous std::from_chars(tsStr.data(), tsStr.data() + tsStr.size(), timestamp); 294c0bd5e4bSEd Tanous if (ec != std::errc()) 29516428a1aSJason M. Bills { 296ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, 297ace85d60SEd Tanous crow::utility::urlFromPieces(entryID)); 29816428a1aSJason M. Bills return false; 29916428a1aSJason M. Bills } 30016428a1aSJason M. Bills return true; 30116428a1aSJason M. Bills } 30216428a1aSJason M. Bills 30395820184SJason M. Bills static bool 30495820184SJason M. Bills getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles) 30595820184SJason M. Bills { 30695820184SJason M. Bills static const std::filesystem::path redfishLogDir = "/var/log"; 30795820184SJason M. Bills static const std::string redfishLogFilename = "redfish"; 30895820184SJason M. Bills 30995820184SJason M. Bills // Loop through the directory looking for redfish log files 31095820184SJason M. Bills for (const std::filesystem::directory_entry& dirEnt : 31195820184SJason M. Bills std::filesystem::directory_iterator(redfishLogDir)) 31295820184SJason M. Bills { 31395820184SJason M. Bills // If we find a redfish log file, save the path 31495820184SJason M. Bills std::string filename = dirEnt.path().filename(); 31595820184SJason M. Bills if (boost::starts_with(filename, redfishLogFilename)) 31695820184SJason M. Bills { 31795820184SJason M. Bills redfishLogFiles.emplace_back(redfishLogDir / filename); 31895820184SJason M. Bills } 31995820184SJason M. Bills } 32095820184SJason M. Bills // As the log files rotate, they are appended with a ".#" that is higher for 32195820184SJason M. Bills // the older logs. Since we don't expect more than 10 log files, we 32295820184SJason M. Bills // can just sort the list to get them in order from newest to oldest 32395820184SJason M. Bills std::sort(redfishLogFiles.begin(), redfishLogFiles.end()); 32495820184SJason M. Bills 32595820184SJason M. Bills return !redfishLogFiles.empty(); 32695820184SJason M. Bills } 32795820184SJason M. Bills 32821ab404cSNan Zhou static std::string getDumpEntriesPath(const std::string& dumpType) 329fdd26906SClaire Weinan { 330fdd26906SClaire Weinan std::string entriesPath; 331fdd26906SClaire Weinan 332fdd26906SClaire Weinan if (dumpType == "BMC") 333fdd26906SClaire Weinan { 334fdd26906SClaire Weinan entriesPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 335fdd26906SClaire Weinan } 336fdd26906SClaire Weinan else if (dumpType == "FaultLog") 337fdd26906SClaire Weinan { 338fdd26906SClaire Weinan entriesPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/"; 339fdd26906SClaire Weinan } 340fdd26906SClaire Weinan else if (dumpType == "System") 341fdd26906SClaire Weinan { 342fdd26906SClaire Weinan entriesPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 343fdd26906SClaire Weinan } 344fdd26906SClaire Weinan else 345fdd26906SClaire Weinan { 346fdd26906SClaire Weinan BMCWEB_LOG_ERROR << "getDumpEntriesPath() invalid dump type: " 347fdd26906SClaire Weinan << dumpType; 348fdd26906SClaire Weinan } 349fdd26906SClaire Weinan 350fdd26906SClaire Weinan // Returns empty string on error 351fdd26906SClaire Weinan return entriesPath; 352fdd26906SClaire Weinan } 353fdd26906SClaire Weinan 3548d1b46d7Szhanghch05 inline void 3558d1b46d7Szhanghch05 getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3565cb1dd27SAsmitha Karunanithi const std::string& dumpType) 3575cb1dd27SAsmitha Karunanithi { 358fdd26906SClaire Weinan std::string entriesPath = getDumpEntriesPath(dumpType); 359fdd26906SClaire Weinan if (entriesPath.empty()) 3605cb1dd27SAsmitha Karunanithi { 3615cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 3625cb1dd27SAsmitha Karunanithi return; 3635cb1dd27SAsmitha Karunanithi } 3645cb1dd27SAsmitha Karunanithi 3655cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 366fdd26906SClaire Weinan [asyncResp, entriesPath, 367711ac7a9SEd Tanous dumpType](const boost::system::error_code ec, 368711ac7a9SEd Tanous dbus::utility::ManagedObjectType& resp) { 3695cb1dd27SAsmitha Karunanithi if (ec) 3705cb1dd27SAsmitha Karunanithi { 3715cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 3725cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 3735cb1dd27SAsmitha Karunanithi return; 3745cb1dd27SAsmitha Karunanithi } 3755cb1dd27SAsmitha Karunanithi 376fdd26906SClaire Weinan // Remove ending slash 377fdd26906SClaire Weinan std::string odataIdStr = entriesPath; 378fdd26906SClaire Weinan if (!odataIdStr.empty()) 379fdd26906SClaire Weinan { 380fdd26906SClaire Weinan odataIdStr.pop_back(); 381fdd26906SClaire Weinan } 382fdd26906SClaire Weinan 383fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.type"] = 384fdd26906SClaire Weinan "#LogEntryCollection.LogEntryCollection"; 385fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = std::move(odataIdStr); 386fdd26906SClaire Weinan asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entries"; 387fdd26906SClaire Weinan asyncResp->res.jsonValue["Description"] = 388fdd26906SClaire Weinan "Collection of " + dumpType + " Dump Entries"; 389fdd26906SClaire Weinan 3905cb1dd27SAsmitha Karunanithi nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"]; 3915cb1dd27SAsmitha Karunanithi entriesArray = nlohmann::json::array(); 392b47452b2SAsmitha Karunanithi std::string dumpEntryPath = 393b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 394002d39b4SEd Tanous std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/"; 3955cb1dd27SAsmitha Karunanithi 396002d39b4SEd Tanous std::sort(resp.begin(), resp.end(), [](const auto& l, const auto& r) { 397002d39b4SEd Tanous return AlphanumLess<std::string>()(l.first.filename(), 398002d39b4SEd Tanous r.first.filename()); 399565dfb6fSClaire Weinan }); 400565dfb6fSClaire Weinan 4015cb1dd27SAsmitha Karunanithi for (auto& object : resp) 4025cb1dd27SAsmitha Karunanithi { 403b47452b2SAsmitha Karunanithi if (object.first.str.find(dumpEntryPath) == std::string::npos) 4045cb1dd27SAsmitha Karunanithi { 4055cb1dd27SAsmitha Karunanithi continue; 4065cb1dd27SAsmitha Karunanithi } 4071d8782e7SNan Zhou uint64_t timestamp = 0; 4085cb1dd27SAsmitha Karunanithi uint64_t size = 0; 40935440d18SAsmitha Karunanithi std::string dumpStatus; 41035440d18SAsmitha Karunanithi nlohmann::json thisEntry; 4112dfd18efSEd Tanous 4122dfd18efSEd Tanous std::string entryID = object.first.filename(); 4132dfd18efSEd Tanous if (entryID.empty()) 4145cb1dd27SAsmitha Karunanithi { 4155cb1dd27SAsmitha Karunanithi continue; 4165cb1dd27SAsmitha Karunanithi } 4175cb1dd27SAsmitha Karunanithi 4185cb1dd27SAsmitha Karunanithi for (auto& interfaceMap : object.second) 4195cb1dd27SAsmitha Karunanithi { 420002d39b4SEd Tanous if (interfaceMap.first == "xyz.openbmc_project.Common.Progress") 42135440d18SAsmitha Karunanithi { 4229eb808c1SEd Tanous for (const auto& propertyMap : interfaceMap.second) 42335440d18SAsmitha Karunanithi { 42435440d18SAsmitha Karunanithi if (propertyMap.first == "Status") 42535440d18SAsmitha Karunanithi { 426002d39b4SEd Tanous const auto* status = 427002d39b4SEd Tanous std::get_if<std::string>(&propertyMap.second); 42835440d18SAsmitha Karunanithi if (status == nullptr) 42935440d18SAsmitha Karunanithi { 43035440d18SAsmitha Karunanithi messages::internalError(asyncResp->res); 43135440d18SAsmitha Karunanithi break; 43235440d18SAsmitha Karunanithi } 43335440d18SAsmitha Karunanithi dumpStatus = *status; 43435440d18SAsmitha Karunanithi } 43535440d18SAsmitha Karunanithi } 43635440d18SAsmitha Karunanithi } 437002d39b4SEd Tanous else if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") 4385cb1dd27SAsmitha Karunanithi { 4395cb1dd27SAsmitha Karunanithi 4405cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 4415cb1dd27SAsmitha Karunanithi { 4425cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Size") 4435cb1dd27SAsmitha Karunanithi { 44455f79e6fSEd Tanous const auto* sizePtr = 4455cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 4465cb1dd27SAsmitha Karunanithi if (sizePtr == nullptr) 4475cb1dd27SAsmitha Karunanithi { 4485cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4495cb1dd27SAsmitha Karunanithi break; 4505cb1dd27SAsmitha Karunanithi } 4515cb1dd27SAsmitha Karunanithi size = *sizePtr; 4525cb1dd27SAsmitha Karunanithi break; 4535cb1dd27SAsmitha Karunanithi } 4545cb1dd27SAsmitha Karunanithi } 4555cb1dd27SAsmitha Karunanithi } 4565cb1dd27SAsmitha Karunanithi else if (interfaceMap.first == 4575cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Time.EpochTime") 4585cb1dd27SAsmitha Karunanithi { 4595cb1dd27SAsmitha Karunanithi 4609eb808c1SEd Tanous for (const auto& propertyMap : interfaceMap.second) 4615cb1dd27SAsmitha Karunanithi { 4625cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Elapsed") 4635cb1dd27SAsmitha Karunanithi { 4645cb1dd27SAsmitha Karunanithi const uint64_t* usecsTimeStamp = 4655cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 4665cb1dd27SAsmitha Karunanithi if (usecsTimeStamp == nullptr) 4675cb1dd27SAsmitha Karunanithi { 4685cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4695cb1dd27SAsmitha Karunanithi break; 4705cb1dd27SAsmitha Karunanithi } 4711d8782e7SNan Zhou timestamp = (*usecsTimeStamp / 1000 / 1000); 4725cb1dd27SAsmitha Karunanithi break; 4735cb1dd27SAsmitha Karunanithi } 4745cb1dd27SAsmitha Karunanithi } 4755cb1dd27SAsmitha Karunanithi } 4765cb1dd27SAsmitha Karunanithi } 4775cb1dd27SAsmitha Karunanithi 4780fda0f12SGeorge Liu if (dumpStatus != 4790fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 48035440d18SAsmitha Karunanithi !dumpStatus.empty()) 48135440d18SAsmitha Karunanithi { 48235440d18SAsmitha Karunanithi // Dump status is not Complete, no need to enumerate 48335440d18SAsmitha Karunanithi continue; 48435440d18SAsmitha Karunanithi } 48535440d18SAsmitha Karunanithi 486647b3cdcSGeorge Liu thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 487fdd26906SClaire Weinan thisEntry["@odata.id"] = entriesPath + entryID; 4885cb1dd27SAsmitha Karunanithi thisEntry["Id"] = entryID; 4895cb1dd27SAsmitha Karunanithi thisEntry["EntryType"] = "Event"; 490002d39b4SEd Tanous thisEntry["Created"] = crow::utility::getDateTimeUint(timestamp); 4915cb1dd27SAsmitha Karunanithi thisEntry["Name"] = dumpType + " Dump Entry"; 4925cb1dd27SAsmitha Karunanithi 4935cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 4945cb1dd27SAsmitha Karunanithi { 495d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "Manager"; 496d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataURI"] = 497fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 498fdd26906SClaire Weinan thisEntry["AdditionalDataSizeBytes"] = size; 4995cb1dd27SAsmitha Karunanithi } 5005cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 5015cb1dd27SAsmitha Karunanithi { 502d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "OEM"; 503d337bb72SAsmitha Karunanithi thisEntry["OEMDiagnosticDataType"] = "System"; 504d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataURI"] = 505fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 506fdd26906SClaire Weinan thisEntry["AdditionalDataSizeBytes"] = size; 5075cb1dd27SAsmitha Karunanithi } 50835440d18SAsmitha Karunanithi entriesArray.push_back(std::move(thisEntry)); 5095cb1dd27SAsmitha Karunanithi } 510002d39b4SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size(); 5115cb1dd27SAsmitha Karunanithi }, 5125cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 5135cb1dd27SAsmitha Karunanithi "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 5145cb1dd27SAsmitha Karunanithi } 5155cb1dd27SAsmitha Karunanithi 5168d1b46d7Szhanghch05 inline void 517c7a6d660SClaire Weinan getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 5188d1b46d7Szhanghch05 const std::string& entryID, const std::string& dumpType) 5195cb1dd27SAsmitha Karunanithi { 520fdd26906SClaire Weinan std::string entriesPath = getDumpEntriesPath(dumpType); 521fdd26906SClaire Weinan if (entriesPath.empty()) 5225cb1dd27SAsmitha Karunanithi { 5235cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5245cb1dd27SAsmitha Karunanithi return; 5255cb1dd27SAsmitha Karunanithi } 5265cb1dd27SAsmitha Karunanithi 5275cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 528fdd26906SClaire Weinan [asyncResp, entryID, dumpType, 529fdd26906SClaire Weinan entriesPath](const boost::system::error_code ec, 530711ac7a9SEd Tanous dbus::utility::ManagedObjectType& resp) { 5315cb1dd27SAsmitha Karunanithi if (ec) 5325cb1dd27SAsmitha Karunanithi { 5335cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 5345cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5355cb1dd27SAsmitha Karunanithi return; 5365cb1dd27SAsmitha Karunanithi } 5375cb1dd27SAsmitha Karunanithi 538b47452b2SAsmitha Karunanithi bool foundDumpEntry = false; 539b47452b2SAsmitha Karunanithi std::string dumpEntryPath = 540b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 541002d39b4SEd Tanous std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/"; 542b47452b2SAsmitha Karunanithi 5439eb808c1SEd Tanous for (const auto& objectPath : resp) 5445cb1dd27SAsmitha Karunanithi { 545b47452b2SAsmitha Karunanithi if (objectPath.first.str != dumpEntryPath + entryID) 5465cb1dd27SAsmitha Karunanithi { 5475cb1dd27SAsmitha Karunanithi continue; 5485cb1dd27SAsmitha Karunanithi } 5495cb1dd27SAsmitha Karunanithi 5505cb1dd27SAsmitha Karunanithi foundDumpEntry = true; 5511d8782e7SNan Zhou uint64_t timestamp = 0; 5525cb1dd27SAsmitha Karunanithi uint64_t size = 0; 55335440d18SAsmitha Karunanithi std::string dumpStatus; 5545cb1dd27SAsmitha Karunanithi 5559eb808c1SEd Tanous for (const auto& interfaceMap : objectPath.second) 5565cb1dd27SAsmitha Karunanithi { 557002d39b4SEd Tanous if (interfaceMap.first == "xyz.openbmc_project.Common.Progress") 55835440d18SAsmitha Karunanithi { 5599eb808c1SEd Tanous for (const auto& propertyMap : interfaceMap.second) 56035440d18SAsmitha Karunanithi { 56135440d18SAsmitha Karunanithi if (propertyMap.first == "Status") 56235440d18SAsmitha Karunanithi { 5639eb808c1SEd Tanous const std::string* status = 564002d39b4SEd Tanous std::get_if<std::string>(&propertyMap.second); 56535440d18SAsmitha Karunanithi if (status == nullptr) 56635440d18SAsmitha Karunanithi { 56735440d18SAsmitha Karunanithi messages::internalError(asyncResp->res); 56835440d18SAsmitha Karunanithi break; 56935440d18SAsmitha Karunanithi } 57035440d18SAsmitha Karunanithi dumpStatus = *status; 57135440d18SAsmitha Karunanithi } 57235440d18SAsmitha Karunanithi } 57335440d18SAsmitha Karunanithi } 574002d39b4SEd Tanous else if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") 5755cb1dd27SAsmitha Karunanithi { 5769eb808c1SEd Tanous for (const auto& propertyMap : interfaceMap.second) 5775cb1dd27SAsmitha Karunanithi { 5785cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Size") 5795cb1dd27SAsmitha Karunanithi { 5809eb808c1SEd Tanous const uint64_t* sizePtr = 5815cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 5825cb1dd27SAsmitha Karunanithi if (sizePtr == nullptr) 5835cb1dd27SAsmitha Karunanithi { 5845cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5855cb1dd27SAsmitha Karunanithi break; 5865cb1dd27SAsmitha Karunanithi } 5875cb1dd27SAsmitha Karunanithi size = *sizePtr; 5885cb1dd27SAsmitha Karunanithi break; 5895cb1dd27SAsmitha Karunanithi } 5905cb1dd27SAsmitha Karunanithi } 5915cb1dd27SAsmitha Karunanithi } 5925cb1dd27SAsmitha Karunanithi else if (interfaceMap.first == 5935cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Time.EpochTime") 5945cb1dd27SAsmitha Karunanithi { 5959eb808c1SEd Tanous for (const auto& propertyMap : interfaceMap.second) 5965cb1dd27SAsmitha Karunanithi { 5975cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Elapsed") 5985cb1dd27SAsmitha Karunanithi { 5995cb1dd27SAsmitha Karunanithi const uint64_t* usecsTimeStamp = 6005cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 6015cb1dd27SAsmitha Karunanithi if (usecsTimeStamp == nullptr) 6025cb1dd27SAsmitha Karunanithi { 6035cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6045cb1dd27SAsmitha Karunanithi break; 6055cb1dd27SAsmitha Karunanithi } 6061d8782e7SNan Zhou timestamp = *usecsTimeStamp / 1000 / 1000; 6075cb1dd27SAsmitha Karunanithi break; 6085cb1dd27SAsmitha Karunanithi } 6095cb1dd27SAsmitha Karunanithi } 6105cb1dd27SAsmitha Karunanithi } 6115cb1dd27SAsmitha Karunanithi } 6125cb1dd27SAsmitha Karunanithi 6130fda0f12SGeorge Liu if (dumpStatus != 6140fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 61535440d18SAsmitha Karunanithi !dumpStatus.empty()) 61635440d18SAsmitha Karunanithi { 61735440d18SAsmitha Karunanithi // Dump status is not Complete 61835440d18SAsmitha Karunanithi // return not found until status is changed to Completed 619002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, dumpType + " dump", 620002d39b4SEd Tanous entryID); 62135440d18SAsmitha Karunanithi return; 62235440d18SAsmitha Karunanithi } 62335440d18SAsmitha Karunanithi 6245cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 625647b3cdcSGeorge Liu "#LogEntry.v1_8_0.LogEntry"; 626fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = entriesPath + entryID; 6275cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = entryID; 6285cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["EntryType"] = "Event"; 6295cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Created"] = 6301d8782e7SNan Zhou crow::utility::getDateTimeUint(timestamp); 6315cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry"; 6325cb1dd27SAsmitha Karunanithi 6335cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 6345cb1dd27SAsmitha Karunanithi { 635d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager"; 636d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 637fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 638fdd26906SClaire Weinan asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 6395cb1dd27SAsmitha Karunanithi } 6405cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 6415cb1dd27SAsmitha Karunanithi { 642d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM"; 643002d39b4SEd Tanous asyncResp->res.jsonValue["OEMDiagnosticDataType"] = "System"; 644d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 645fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 646fdd26906SClaire Weinan asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 6475cb1dd27SAsmitha Karunanithi } 6485cb1dd27SAsmitha Karunanithi } 649e05aec50SEd Tanous if (!foundDumpEntry) 650b47452b2SAsmitha Karunanithi { 651b47452b2SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Can't find Dump Entry"; 652b47452b2SAsmitha Karunanithi messages::internalError(asyncResp->res); 653b47452b2SAsmitha Karunanithi return; 654b47452b2SAsmitha Karunanithi } 6555cb1dd27SAsmitha Karunanithi }, 6565cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 6575cb1dd27SAsmitha Karunanithi "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 6585cb1dd27SAsmitha Karunanithi } 6595cb1dd27SAsmitha Karunanithi 6608d1b46d7Szhanghch05 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 6619878256fSStanley Chu const std::string& entryID, 662b47452b2SAsmitha Karunanithi const std::string& dumpType) 6635cb1dd27SAsmitha Karunanithi { 664002d39b4SEd Tanous auto respHandler = 665002d39b4SEd Tanous [asyncResp, entryID](const boost::system::error_code ec) { 6665cb1dd27SAsmitha Karunanithi BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done"; 6675cb1dd27SAsmitha Karunanithi if (ec) 6685cb1dd27SAsmitha Karunanithi { 6693de8d8baSGeorge Liu if (ec.value() == EBADR) 6703de8d8baSGeorge Liu { 6713de8d8baSGeorge Liu messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 6723de8d8baSGeorge Liu return; 6733de8d8baSGeorge Liu } 6745cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error " 675fdd26906SClaire Weinan << ec << " entryID=" << entryID; 6765cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6775cb1dd27SAsmitha Karunanithi return; 6785cb1dd27SAsmitha Karunanithi } 6795cb1dd27SAsmitha Karunanithi }; 6805cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 6815cb1dd27SAsmitha Karunanithi respHandler, "xyz.openbmc_project.Dump.Manager", 682b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 683b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/" + 684b47452b2SAsmitha Karunanithi entryID, 6855cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Object.Delete", "Delete"); 6865cb1dd27SAsmitha Karunanithi } 6875cb1dd27SAsmitha Karunanithi 6888d1b46d7Szhanghch05 inline void 68998be3e39SEd Tanous createDumpTaskCallback(task::Payload&& payload, 6908d1b46d7Szhanghch05 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 6918d1b46d7Szhanghch05 const uint32_t& dumpId, const std::string& dumpPath, 692a43be80fSAsmitha Karunanithi const std::string& dumpType) 693a43be80fSAsmitha Karunanithi { 694a43be80fSAsmitha Karunanithi std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 6956145ed6fSAsmitha Karunanithi [dumpId, dumpPath, dumpType]( 696a43be80fSAsmitha Karunanithi boost::system::error_code err, sdbusplus::message::message& m, 697a43be80fSAsmitha Karunanithi const std::shared_ptr<task::TaskData>& taskData) { 698cb13a392SEd Tanous if (err) 699cb13a392SEd Tanous { 7006145ed6fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Error in creating a dump"; 7016145ed6fSAsmitha Karunanithi taskData->state = "Cancelled"; 7026145ed6fSAsmitha Karunanithi return task::completed; 703cb13a392SEd Tanous } 704b9d36b47SEd Tanous 705b9d36b47SEd Tanous dbus::utility::DBusInteracesMap interfacesList; 706a43be80fSAsmitha Karunanithi 707a43be80fSAsmitha Karunanithi sdbusplus::message::object_path objPath; 708a43be80fSAsmitha Karunanithi 709a43be80fSAsmitha Karunanithi m.read(objPath, interfacesList); 710a43be80fSAsmitha Karunanithi 711b47452b2SAsmitha Karunanithi if (objPath.str == 712b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 713b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)) + 714b47452b2SAsmitha Karunanithi "/entry/" + std::to_string(dumpId)) 715a43be80fSAsmitha Karunanithi { 716a43be80fSAsmitha Karunanithi nlohmann::json retMessage = messages::success(); 717a43be80fSAsmitha Karunanithi taskData->messages.emplace_back(retMessage); 718a43be80fSAsmitha Karunanithi 719a43be80fSAsmitha Karunanithi std::string headerLoc = 720a43be80fSAsmitha Karunanithi "Location: " + dumpPath + std::to_string(dumpId); 721002d39b4SEd Tanous taskData->payload->httpHeaders.emplace_back(std::move(headerLoc)); 722a43be80fSAsmitha Karunanithi 723a43be80fSAsmitha Karunanithi taskData->state = "Completed"; 724b47452b2SAsmitha Karunanithi return task::completed; 7256145ed6fSAsmitha Karunanithi } 726a43be80fSAsmitha Karunanithi return task::completed; 727a43be80fSAsmitha Karunanithi }, 7284978b63fSJason M. Bills "type='signal',interface='org.freedesktop.DBus.ObjectManager'," 729a43be80fSAsmitha Karunanithi "member='InterfacesAdded', " 730a43be80fSAsmitha Karunanithi "path='/xyz/openbmc_project/dump'"); 731a43be80fSAsmitha Karunanithi 732a43be80fSAsmitha Karunanithi task->startTimer(std::chrono::minutes(3)); 733a43be80fSAsmitha Karunanithi task->populateResp(asyncResp->res); 73498be3e39SEd Tanous task->payload.emplace(std::move(payload)); 735a43be80fSAsmitha Karunanithi } 736a43be80fSAsmitha Karunanithi 7378d1b46d7Szhanghch05 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 7388d1b46d7Szhanghch05 const crow::Request& req, const std::string& dumpType) 739a43be80fSAsmitha Karunanithi { 740fdd26906SClaire Weinan std::string dumpPath = getDumpEntriesPath(dumpType); 741fdd26906SClaire Weinan if (dumpPath.empty()) 742a43be80fSAsmitha Karunanithi { 743a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 744a43be80fSAsmitha Karunanithi return; 745a43be80fSAsmitha Karunanithi } 746a43be80fSAsmitha Karunanithi 747a43be80fSAsmitha Karunanithi std::optional<std::string> diagnosticDataType; 748a43be80fSAsmitha Karunanithi std::optional<std::string> oemDiagnosticDataType; 749a43be80fSAsmitha Karunanithi 75015ed6780SWilly Tu if (!redfish::json_util::readJsonAction( 751a43be80fSAsmitha Karunanithi req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 752a43be80fSAsmitha Karunanithi "OEMDiagnosticDataType", oemDiagnosticDataType)) 753a43be80fSAsmitha Karunanithi { 754a43be80fSAsmitha Karunanithi return; 755a43be80fSAsmitha Karunanithi } 756a43be80fSAsmitha Karunanithi 757a43be80fSAsmitha Karunanithi if (dumpType == "System") 758a43be80fSAsmitha Karunanithi { 759a43be80fSAsmitha Karunanithi if (!oemDiagnosticDataType || !diagnosticDataType) 760a43be80fSAsmitha Karunanithi { 7614978b63fSJason M. Bills BMCWEB_LOG_ERROR 7624978b63fSJason M. Bills << "CreateDump action parameter 'DiagnosticDataType'/'OEMDiagnosticDataType' value not found!"; 763a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 764a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", 765a43be80fSAsmitha Karunanithi "DiagnosticDataType & OEMDiagnosticDataType"); 766a43be80fSAsmitha Karunanithi return; 767a43be80fSAsmitha Karunanithi } 7683174e4dfSEd Tanous if ((*oemDiagnosticDataType != "System") || 769a43be80fSAsmitha Karunanithi (*diagnosticDataType != "OEM")) 770a43be80fSAsmitha Karunanithi { 771a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Wrong parameter values passed"; 772ace85d60SEd Tanous messages::internalError(asyncResp->res); 773a43be80fSAsmitha Karunanithi return; 774a43be80fSAsmitha Karunanithi } 775a43be80fSAsmitha Karunanithi } 776a43be80fSAsmitha Karunanithi else if (dumpType == "BMC") 777a43be80fSAsmitha Karunanithi { 778a43be80fSAsmitha Karunanithi if (!diagnosticDataType) 779a43be80fSAsmitha Karunanithi { 7800fda0f12SGeorge Liu BMCWEB_LOG_ERROR 7810fda0f12SGeorge Liu << "CreateDump action parameter 'DiagnosticDataType' not found!"; 782a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 783a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType"); 784a43be80fSAsmitha Karunanithi return; 785a43be80fSAsmitha Karunanithi } 7863174e4dfSEd Tanous if (*diagnosticDataType != "Manager") 787a43be80fSAsmitha Karunanithi { 788a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR 789a43be80fSAsmitha Karunanithi << "Wrong parameter value passed for 'DiagnosticDataType'"; 790ace85d60SEd Tanous messages::internalError(asyncResp->res); 791a43be80fSAsmitha Karunanithi return; 792a43be80fSAsmitha Karunanithi } 793a43be80fSAsmitha Karunanithi } 794a43be80fSAsmitha Karunanithi 795a43be80fSAsmitha Karunanithi crow::connections::systemBus->async_method_call( 79698be3e39SEd Tanous [asyncResp, payload(task::Payload(req)), dumpPath, 79798be3e39SEd Tanous dumpType](const boost::system::error_code ec, 79898be3e39SEd Tanous const uint32_t& dumpId) mutable { 799a43be80fSAsmitha Karunanithi if (ec) 800a43be80fSAsmitha Karunanithi { 801a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec; 802a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 803a43be80fSAsmitha Karunanithi return; 804a43be80fSAsmitha Karunanithi } 805a43be80fSAsmitha Karunanithi BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId; 806a43be80fSAsmitha Karunanithi 807002d39b4SEd Tanous createDumpTaskCallback(std::move(payload), asyncResp, dumpId, dumpPath, 808002d39b4SEd Tanous dumpType); 809a43be80fSAsmitha Karunanithi }, 810b47452b2SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", 811b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 812b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)), 813a43be80fSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create", "CreateDump"); 814a43be80fSAsmitha Karunanithi } 815a43be80fSAsmitha Karunanithi 8168d1b46d7Szhanghch05 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 8178d1b46d7Szhanghch05 const std::string& dumpType) 81880319af1SAsmitha Karunanithi { 819b47452b2SAsmitha Karunanithi std::string dumpTypeLowerCopy = 820b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)); 8218d1b46d7Szhanghch05 82280319af1SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 823b9d36b47SEd Tanous [asyncResp, dumpType]( 824b9d36b47SEd Tanous const boost::system::error_code ec, 825b9d36b47SEd Tanous const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 82680319af1SAsmitha Karunanithi if (ec) 82780319af1SAsmitha Karunanithi { 82880319af1SAsmitha Karunanithi BMCWEB_LOG_ERROR << "resp_handler got error " << ec; 82980319af1SAsmitha Karunanithi messages::internalError(asyncResp->res); 83080319af1SAsmitha Karunanithi return; 83180319af1SAsmitha Karunanithi } 83280319af1SAsmitha Karunanithi 83380319af1SAsmitha Karunanithi for (const std::string& path : subTreePaths) 83480319af1SAsmitha Karunanithi { 8352dfd18efSEd Tanous sdbusplus::message::object_path objPath(path); 8362dfd18efSEd Tanous std::string logID = objPath.filename(); 8372dfd18efSEd Tanous if (logID.empty()) 83880319af1SAsmitha Karunanithi { 8392dfd18efSEd Tanous continue; 84080319af1SAsmitha Karunanithi } 8412dfd18efSEd Tanous deleteDumpEntry(asyncResp, logID, dumpType); 84280319af1SAsmitha Karunanithi } 84380319af1SAsmitha Karunanithi }, 84480319af1SAsmitha Karunanithi "xyz.openbmc_project.ObjectMapper", 84580319af1SAsmitha Karunanithi "/xyz/openbmc_project/object_mapper", 84680319af1SAsmitha Karunanithi "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 847b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + dumpTypeLowerCopy, 0, 848b47452b2SAsmitha Karunanithi std::array<std::string, 1>{"xyz.openbmc_project.Dump.Entry." + 849b47452b2SAsmitha Karunanithi dumpType}); 85080319af1SAsmitha Karunanithi } 85180319af1SAsmitha Karunanithi 852b9d36b47SEd Tanous inline static void 853b9d36b47SEd Tanous parseCrashdumpParameters(const dbus::utility::DBusPropertiesMap& params, 854b9d36b47SEd Tanous std::string& filename, std::string& timestamp, 855b9d36b47SEd Tanous std::string& logfile) 856043a0536SJohnathan Mantey { 857043a0536SJohnathan Mantey for (auto property : params) 858043a0536SJohnathan Mantey { 859043a0536SJohnathan Mantey if (property.first == "Timestamp") 860043a0536SJohnathan Mantey { 861043a0536SJohnathan Mantey const std::string* value = 8628d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 863043a0536SJohnathan Mantey if (value != nullptr) 864043a0536SJohnathan Mantey { 865043a0536SJohnathan Mantey timestamp = *value; 866043a0536SJohnathan Mantey } 867043a0536SJohnathan Mantey } 868043a0536SJohnathan Mantey else if (property.first == "Filename") 869043a0536SJohnathan Mantey { 870043a0536SJohnathan Mantey const std::string* value = 8718d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 872043a0536SJohnathan Mantey if (value != nullptr) 873043a0536SJohnathan Mantey { 874043a0536SJohnathan Mantey filename = *value; 875043a0536SJohnathan Mantey } 876043a0536SJohnathan Mantey } 877043a0536SJohnathan Mantey else if (property.first == "Log") 878043a0536SJohnathan Mantey { 879043a0536SJohnathan Mantey const std::string* value = 8808d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 881043a0536SJohnathan Mantey if (value != nullptr) 882043a0536SJohnathan Mantey { 883043a0536SJohnathan Mantey logfile = *value; 884043a0536SJohnathan Mantey } 885043a0536SJohnathan Mantey } 886043a0536SJohnathan Mantey } 887043a0536SJohnathan Mantey } 888043a0536SJohnathan Mantey 889a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode"; 8907e860f15SJohn Edward Broadbent inline void requestRoutesSystemLogServiceCollection(App& app) 8911da66f75SEd Tanous { 892c4bf6374SJason M. Bills /** 893c4bf6374SJason M. Bills * Functions triggers appropriate requests on DBus 894c4bf6374SJason M. Bills */ 8957e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/") 896ed398213SEd Tanous .privileges(redfish::privileges::getLogServiceCollection) 897002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 898002d39b4SEd Tanous [&app](const crow::Request& req, 899002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 9003ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 901c4bf6374SJason M. Bills { 90245ca1b86SEd Tanous return; 90345ca1b86SEd Tanous } 9047e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 9057e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 906c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 907c4bf6374SJason M. Bills "#LogServiceCollection.LogServiceCollection"; 908c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 909029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices"; 91045ca1b86SEd Tanous asyncResp->res.jsonValue["Name"] = "System Log Services Collection"; 911c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 912c4bf6374SJason M. Bills "Collection of LogServices for this Computer System"; 913002d39b4SEd Tanous nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 914c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 9151476687dSEd Tanous nlohmann::json::object_t eventLog; 9161476687dSEd Tanous eventLog["@odata.id"] = 9171476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 9181476687dSEd Tanous logServiceArray.push_back(std::move(eventLog)); 9195cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 9201476687dSEd Tanous nlohmann::json::object_t dumpLog; 921002d39b4SEd Tanous dumpLog["@odata.id"] = "/redfish/v1/Systems/system/LogServices/Dump"; 9221476687dSEd Tanous logServiceArray.push_back(std::move(dumpLog)); 923c9bb6861Sraviteja-b #endif 924c9bb6861Sraviteja-b 925d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG 9261476687dSEd Tanous nlohmann::json::object_t crashdump; 9271476687dSEd Tanous crashdump["@odata.id"] = 9281476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump"; 9291476687dSEd Tanous logServiceArray.push_back(std::move(crashdump)); 930d53dd41fSJason M. Bills #endif 931b7028ebfSSpencer Ku 932b7028ebfSSpencer Ku #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER 9331476687dSEd Tanous nlohmann::json::object_t hostlogger; 9341476687dSEd Tanous hostlogger["@odata.id"] = 9351476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger"; 9361476687dSEd Tanous logServiceArray.push_back(std::move(hostlogger)); 937b7028ebfSSpencer Ku #endif 938c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 939c4bf6374SJason M. Bills logServiceArray.size(); 940a3316fc6SZhikuiRen 941a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 94245ca1b86SEd Tanous [asyncResp](const boost::system::error_code ec, 943b9d36b47SEd Tanous const dbus::utility::MapperGetSubTreePathsResponse& 944b9d36b47SEd Tanous subtreePath) { 945a3316fc6SZhikuiRen if (ec) 946a3316fc6SZhikuiRen { 947a3316fc6SZhikuiRen BMCWEB_LOG_ERROR << ec; 948a3316fc6SZhikuiRen return; 949a3316fc6SZhikuiRen } 950a3316fc6SZhikuiRen 95155f79e6fSEd Tanous for (const auto& pathStr : subtreePath) 952a3316fc6SZhikuiRen { 953a3316fc6SZhikuiRen if (pathStr.find("PostCode") != std::string::npos) 954a3316fc6SZhikuiRen { 95523a21a1cSEd Tanous nlohmann::json& logServiceArrayLocal = 956a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"]; 95723a21a1cSEd Tanous logServiceArrayLocal.push_back( 9580fda0f12SGeorge Liu {{"@odata.id", 9590fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes"}}); 96045ca1b86SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = 96123a21a1cSEd Tanous logServiceArrayLocal.size(); 962a3316fc6SZhikuiRen return; 963a3316fc6SZhikuiRen } 964a3316fc6SZhikuiRen } 965a3316fc6SZhikuiRen }, 966a3316fc6SZhikuiRen "xyz.openbmc_project.ObjectMapper", 967a3316fc6SZhikuiRen "/xyz/openbmc_project/object_mapper", 96845ca1b86SEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 0, 96945ca1b86SEd Tanous std::array<const char*, 1>{postCodeIface}); 9707e860f15SJohn Edward Broadbent }); 971c4bf6374SJason M. Bills } 972c4bf6374SJason M. Bills 9737e860f15SJohn Edward Broadbent inline void requestRoutesEventLogService(App& app) 974c4bf6374SJason M. Bills { 9757e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/") 976ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 977002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 978002d39b4SEd Tanous [&app](const crow::Request& req, 979002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 9803ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 98145ca1b86SEd Tanous { 98245ca1b86SEd Tanous return; 98345ca1b86SEd Tanous } 984c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 985029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 986c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 987c4bf6374SJason M. Bills "#LogService.v1_1_0.LogService"; 988c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "Event Log Service"; 989002d39b4SEd Tanous asyncResp->res.jsonValue["Description"] = "System Event Log Service"; 990c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "EventLog"; 991c4bf6374SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 9927c8c4058STejas Patil 9937c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 9947c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 9957c8c4058STejas Patil 9967c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 9977c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 9987c8c4058STejas Patil redfishDateTimeOffset.second; 9997c8c4058STejas Patil 10001476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 10011476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1002e7d6c8b2SGunnar Mills asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 1003e7d6c8b2SGunnar Mills 10040fda0f12SGeorge Liu {"target", 10050fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog"}}; 10067e860f15SJohn Edward Broadbent }); 1007489640c6SJason M. Bills } 1008489640c6SJason M. Bills 10097e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogClear(App& app) 1010489640c6SJason M. Bills { 10114978b63fSJason M. Bills BMCWEB_ROUTE( 10124978b63fSJason M. Bills app, 10134978b63fSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog/") 1014432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 10157e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 101645ca1b86SEd Tanous [&app](const crow::Request& req, 10177e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 10183ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 101945ca1b86SEd Tanous { 102045ca1b86SEd Tanous return; 102145ca1b86SEd Tanous } 1022489640c6SJason M. Bills // Clear the EventLog by deleting the log files 1023489640c6SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1024489640c6SJason M. Bills if (getRedfishLogFiles(redfishLogFiles)) 1025489640c6SJason M. Bills { 1026489640c6SJason M. Bills for (const std::filesystem::path& file : redfishLogFiles) 1027489640c6SJason M. Bills { 1028489640c6SJason M. Bills std::error_code ec; 1029489640c6SJason M. Bills std::filesystem::remove(file, ec); 1030489640c6SJason M. Bills } 1031489640c6SJason M. Bills } 1032489640c6SJason M. Bills 1033489640c6SJason M. Bills // Reload rsyslog so it knows to start new log files 1034489640c6SJason M. Bills crow::connections::systemBus->async_method_call( 1035489640c6SJason M. Bills [asyncResp](const boost::system::error_code ec) { 1036489640c6SJason M. Bills if (ec) 1037489640c6SJason M. Bills { 1038002d39b4SEd Tanous BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec; 1039489640c6SJason M. Bills messages::internalError(asyncResp->res); 1040489640c6SJason M. Bills return; 1041489640c6SJason M. Bills } 1042489640c6SJason M. Bills 1043489640c6SJason M. Bills messages::success(asyncResp->res); 1044489640c6SJason M. Bills }, 1045489640c6SJason M. Bills "org.freedesktop.systemd1", "/org/freedesktop/systemd1", 1046002d39b4SEd Tanous "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service", 1047002d39b4SEd Tanous "replace"); 10487e860f15SJohn Edward Broadbent }); 1049c4bf6374SJason M. Bills } 1050c4bf6374SJason M. Bills 105195820184SJason M. Bills static int fillEventLogEntryJson(const std::string& logEntryID, 1052b5a76932SEd Tanous const std::string& logEntry, 1053de703c5dSJason M. Bills nlohmann::json::object_t& logEntryJson) 1054c4bf6374SJason M. Bills { 105595820184SJason M. Bills // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1056cd225da8SJason M. Bills // First get the Timestamp 1057f23b7296SEd Tanous size_t space = logEntry.find_first_of(' '); 1058cd225da8SJason M. Bills if (space == std::string::npos) 105995820184SJason M. Bills { 106095820184SJason M. Bills return 1; 106195820184SJason M. Bills } 1062cd225da8SJason M. Bills std::string timestamp = logEntry.substr(0, space); 1063cd225da8SJason M. Bills // Then get the log contents 1064f23b7296SEd Tanous size_t entryStart = logEntry.find_first_not_of(' ', space); 1065cd225da8SJason M. Bills if (entryStart == std::string::npos) 1066cd225da8SJason M. Bills { 1067cd225da8SJason M. Bills return 1; 1068cd225da8SJason M. Bills } 1069cd225da8SJason M. Bills std::string_view entry(logEntry); 1070cd225da8SJason M. Bills entry.remove_prefix(entryStart); 1071cd225da8SJason M. Bills // Use split to separate the entry into its fields 1072cd225da8SJason M. Bills std::vector<std::string> logEntryFields; 1073cd225da8SJason M. Bills boost::split(logEntryFields, entry, boost::is_any_of(","), 1074cd225da8SJason M. Bills boost::token_compress_on); 1075cd225da8SJason M. Bills // We need at least a MessageId to be valid 107626f6976fSEd Tanous if (logEntryFields.empty()) 1077cd225da8SJason M. Bills { 1078cd225da8SJason M. Bills return 1; 1079cd225da8SJason M. Bills } 1080cd225da8SJason M. Bills std::string& messageID = logEntryFields[0]; 108195820184SJason M. Bills 10824851d45dSJason M. Bills // Get the Message from the MessageRegistry 1083fffb8c1fSEd Tanous const registries::Message* message = registries::getMessage(messageID); 1084c4bf6374SJason M. Bills 108554417b02SSui Chen if (message == nullptr) 1086c4bf6374SJason M. Bills { 108754417b02SSui Chen BMCWEB_LOG_WARNING << "Log entry not found in registry: " << logEntry; 108854417b02SSui Chen return 0; 1089c4bf6374SJason M. Bills } 1090c4bf6374SJason M. Bills 109154417b02SSui Chen std::string msg = message->message; 109254417b02SSui Chen 109315a86ff6SJason M. Bills // Get the MessageArgs from the log if there are any 109426702d01SEd Tanous std::span<std::string> messageArgs; 109515a86ff6SJason M. Bills if (logEntryFields.size() > 1) 109615a86ff6SJason M. Bills { 109715a86ff6SJason M. Bills std::string& messageArgsStart = logEntryFields[1]; 109815a86ff6SJason M. Bills // If the first string is empty, assume there are no MessageArgs 109915a86ff6SJason M. Bills std::size_t messageArgsSize = 0; 110015a86ff6SJason M. Bills if (!messageArgsStart.empty()) 110115a86ff6SJason M. Bills { 110215a86ff6SJason M. Bills messageArgsSize = logEntryFields.size() - 1; 110315a86ff6SJason M. Bills } 110415a86ff6SJason M. Bills 110523a21a1cSEd Tanous messageArgs = {&messageArgsStart, messageArgsSize}; 1106c4bf6374SJason M. Bills 11074851d45dSJason M. Bills // Fill the MessageArgs into the Message 110895820184SJason M. Bills int i = 0; 110995820184SJason M. Bills for (const std::string& messageArg : messageArgs) 11104851d45dSJason M. Bills { 111195820184SJason M. Bills std::string argStr = "%" + std::to_string(++i); 11124851d45dSJason M. Bills size_t argPos = msg.find(argStr); 11134851d45dSJason M. Bills if (argPos != std::string::npos) 11144851d45dSJason M. Bills { 111595820184SJason M. Bills msg.replace(argPos, argStr.length(), messageArg); 11164851d45dSJason M. Bills } 11174851d45dSJason M. Bills } 111815a86ff6SJason M. Bills } 11194851d45dSJason M. Bills 112095820184SJason M. Bills // Get the Created time from the timestamp. The log timestamp is in RFC3339 112195820184SJason M. Bills // format which matches the Redfish format except for the fractional seconds 112295820184SJason M. Bills // between the '.' and the '+', so just remove them. 1123f23b7296SEd Tanous std::size_t dot = timestamp.find_first_of('.'); 1124f23b7296SEd Tanous std::size_t plus = timestamp.find_first_of('+'); 112595820184SJason M. Bills if (dot != std::string::npos && plus != std::string::npos) 1126c4bf6374SJason M. Bills { 112795820184SJason M. Bills timestamp.erase(dot, plus - dot); 1128c4bf6374SJason M. Bills } 1129c4bf6374SJason M. Bills 1130c4bf6374SJason M. Bills // Fill in the log entry with the gathered data 1131*84afc48bSJason M. Bills logEntryJson["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 1132*84afc48bSJason M. Bills logEntryJson["@odata.id"] = 1133*84afc48bSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + logEntryID; 1134*84afc48bSJason M. Bills logEntryJson["Name"] = "System Event Log Entry"; 1135*84afc48bSJason M. Bills logEntryJson["Id"] = logEntryID; 1136*84afc48bSJason M. Bills logEntryJson["Message"] = std::move(msg); 1137*84afc48bSJason M. Bills logEntryJson["MessageId"] = std::move(messageID); 1138*84afc48bSJason M. Bills logEntryJson["MessageArgs"] = messageArgs; 1139*84afc48bSJason M. Bills logEntryJson["EntryType"] = "Event"; 1140*84afc48bSJason M. Bills logEntryJson["Severity"] = message->messageSeverity; 1141*84afc48bSJason M. Bills logEntryJson["Created"] = std::move(timestamp); 1142c4bf6374SJason M. Bills return 0; 1143c4bf6374SJason M. Bills } 1144c4bf6374SJason M. Bills 11457e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntryCollection(App& app) 1146c4bf6374SJason M. Bills { 11477e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 11487e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") 11498b6a35f0SGunnar Mills .privileges(redfish::privileges::getLogEntryCollection) 1150002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1151002d39b4SEd Tanous [&app](const crow::Request& req, 1152002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1153c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 1154c937d2bfSEd Tanous .canDelegateTop = true, 1155c937d2bfSEd Tanous .canDelegateSkip = true, 1156c937d2bfSEd Tanous }; 1157c937d2bfSEd Tanous query_param::Query delegatedQuery; 1158c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 11593ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 1160c4bf6374SJason M. Bills { 1161c4bf6374SJason M. Bills return; 1162c4bf6374SJason M. Bills } 11637e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 11647e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1165c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1166c4bf6374SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 1167c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1168029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1169c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 1170c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 1171c4bf6374SJason M. Bills "Collection of System Event Log Entries"; 1172cb92c03bSAndrew Geissler 11734978b63fSJason M. Bills nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1174c4bf6374SJason M. Bills logEntryArray = nlohmann::json::array(); 11757e860f15SJohn Edward Broadbent // Go through the log files and create a unique ID for each 11767e860f15SJohn Edward Broadbent // entry 117795820184SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 117895820184SJason M. Bills getRedfishLogFiles(redfishLogFiles); 1179b01bf299SEd Tanous uint64_t entryCount = 0; 1180cd225da8SJason M. Bills std::string logEntry; 118195820184SJason M. Bills 11827e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 11837e860f15SJohn Edward Broadbent // backwards 1184002d39b4SEd Tanous for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1185002d39b4SEd Tanous it++) 1186c4bf6374SJason M. Bills { 1187cd225da8SJason M. Bills std::ifstream logStream(*it); 118895820184SJason M. Bills if (!logStream.is_open()) 1189c4bf6374SJason M. Bills { 1190c4bf6374SJason M. Bills continue; 1191c4bf6374SJason M. Bills } 1192c4bf6374SJason M. Bills 1193e85d6b16SJason M. Bills // Reset the unique ID on the first entry 1194e85d6b16SJason M. Bills bool firstEntry = true; 119595820184SJason M. Bills while (std::getline(logStream, logEntry)) 119695820184SJason M. Bills { 1197c4bf6374SJason M. Bills std::string idStr; 1198e85d6b16SJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1199c4bf6374SJason M. Bills { 1200c4bf6374SJason M. Bills continue; 1201c4bf6374SJason M. Bills } 1202e85d6b16SJason M. Bills firstEntry = false; 1203e85d6b16SJason M. Bills 1204de703c5dSJason M. Bills nlohmann::json::object_t bmcLogEntry; 1205002d39b4SEd Tanous if (fillEventLogEntryJson(idStr, logEntry, bmcLogEntry) != 0) 1206c4bf6374SJason M. Bills { 1207c4bf6374SJason M. Bills messages::internalError(asyncResp->res); 1208c4bf6374SJason M. Bills return; 1209c4bf6374SJason M. Bills } 1210de703c5dSJason M. Bills 1211de703c5dSJason M. Bills if (bmcLogEntry.empty()) 1212de703c5dSJason M. Bills { 1213de703c5dSJason M. Bills continue; 1214de703c5dSJason M. Bills } 1215de703c5dSJason M. Bills 1216de703c5dSJason M. Bills entryCount++; 1217de703c5dSJason M. Bills // Handle paging using skip (number of entries to skip from the 1218de703c5dSJason M. Bills // start) and top (number of entries to display) 1219de703c5dSJason M. Bills if (entryCount <= delegatedQuery.skip || 1220de703c5dSJason M. Bills entryCount > delegatedQuery.skip + delegatedQuery.top) 1221de703c5dSJason M. Bills { 1222de703c5dSJason M. Bills continue; 1223de703c5dSJason M. Bills } 1224de703c5dSJason M. Bills 1225de703c5dSJason M. Bills logEntryArray.push_back(std::move(bmcLogEntry)); 1226c4bf6374SJason M. Bills } 122795820184SJason M. Bills } 1228c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 1229c937d2bfSEd Tanous if (delegatedQuery.skip + delegatedQuery.top < entryCount) 1230c4bf6374SJason M. Bills { 1231c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 12324978b63fSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries?$skip=" + 1233c937d2bfSEd Tanous std::to_string(delegatedQuery.skip + delegatedQuery.top); 1234c4bf6374SJason M. Bills } 12357e860f15SJohn Edward Broadbent }); 1236897967deSJason M. Bills } 1237897967deSJason M. Bills 12387e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntry(App& app) 1239897967deSJason M. Bills { 12407e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 12417e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1242ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 12437e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 124445ca1b86SEd Tanous [&app](const crow::Request& req, 12457e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 12467e860f15SJohn Edward Broadbent const std::string& param) { 12473ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 124845ca1b86SEd Tanous { 124945ca1b86SEd Tanous return; 125045ca1b86SEd Tanous } 12517e860f15SJohn Edward Broadbent const std::string& targetID = param; 12528d1b46d7Szhanghch05 12537e860f15SJohn Edward Broadbent // Go through the log files and check the unique ID for each 12547e860f15SJohn Edward Broadbent // entry to find the target entry 1255897967deSJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1256897967deSJason M. Bills getRedfishLogFiles(redfishLogFiles); 1257897967deSJason M. Bills std::string logEntry; 1258897967deSJason M. Bills 12597e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 12607e860f15SJohn Edward Broadbent // backwards 1261002d39b4SEd Tanous for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1262002d39b4SEd Tanous it++) 1263897967deSJason M. Bills { 1264897967deSJason M. Bills std::ifstream logStream(*it); 1265897967deSJason M. Bills if (!logStream.is_open()) 1266897967deSJason M. Bills { 1267897967deSJason M. Bills continue; 1268897967deSJason M. Bills } 1269897967deSJason M. Bills 1270897967deSJason M. Bills // Reset the unique ID on the first entry 1271897967deSJason M. Bills bool firstEntry = true; 1272897967deSJason M. Bills while (std::getline(logStream, logEntry)) 1273897967deSJason M. Bills { 1274897967deSJason M. Bills std::string idStr; 1275897967deSJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1276897967deSJason M. Bills { 1277897967deSJason M. Bills continue; 1278897967deSJason M. Bills } 1279897967deSJason M. Bills firstEntry = false; 1280897967deSJason M. Bills 1281897967deSJason M. Bills if (idStr == targetID) 1282897967deSJason M. Bills { 1283de703c5dSJason M. Bills nlohmann::json::object_t bmcLogEntry; 1284de703c5dSJason M. Bills if (fillEventLogEntryJson(idStr, logEntry, bmcLogEntry) != 1285de703c5dSJason M. Bills 0) 1286897967deSJason M. Bills { 1287897967deSJason M. Bills messages::internalError(asyncResp->res); 1288897967deSJason M. Bills return; 1289897967deSJason M. Bills } 1290d405bb51SJason M. Bills asyncResp->res.jsonValue.update(bmcLogEntry); 1291897967deSJason M. Bills return; 1292897967deSJason M. Bills } 1293897967deSJason M. Bills } 1294897967deSJason M. Bills } 1295897967deSJason M. Bills // Requested ID was not found 1296002d39b4SEd Tanous messages::resourceMissingAtURI(asyncResp->res, 1297002d39b4SEd Tanous crow::utility::urlFromPieces(targetID)); 12987e860f15SJohn Edward Broadbent }); 129908a4e4b5SAnthony Wilson } 130008a4e4b5SAnthony Wilson 13017e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryCollection(App& app) 130208a4e4b5SAnthony Wilson { 13037e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 13047e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") 1305ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 1306002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1307002d39b4SEd Tanous [&app](const crow::Request& req, 1308002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 13093ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 131045ca1b86SEd Tanous { 131145ca1b86SEd Tanous return; 131245ca1b86SEd Tanous } 13137e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 13147e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 131508a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.type"] = 131608a4e4b5SAnthony Wilson "#LogEntryCollection.LogEntryCollection"; 131708a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.id"] = 131808a4e4b5SAnthony Wilson "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 131908a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 132008a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Description"] = 132108a4e4b5SAnthony Wilson "Collection of System Event Log Entries"; 132208a4e4b5SAnthony Wilson 1323cb92c03bSAndrew Geissler // DBus implementation of EventLog/Entries 1324cb92c03bSAndrew Geissler // Make call to Logging Service to find all log entry objects 1325cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 1326cb92c03bSAndrew Geissler [asyncResp](const boost::system::error_code ec, 1327914e2d5dSEd Tanous const dbus::utility::ManagedObjectType& resp) { 1328cb92c03bSAndrew Geissler if (ec) 1329cb92c03bSAndrew Geissler { 1330cb92c03bSAndrew Geissler // TODO Handle for specific error code 1331cb92c03bSAndrew Geissler BMCWEB_LOG_ERROR 1332002d39b4SEd Tanous << "getLogEntriesIfaceData resp_handler got error " << ec; 1333cb92c03bSAndrew Geissler messages::internalError(asyncResp->res); 1334cb92c03bSAndrew Geissler return; 1335cb92c03bSAndrew Geissler } 1336002d39b4SEd Tanous nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"]; 1337cb92c03bSAndrew Geissler entriesArray = nlohmann::json::array(); 13389eb808c1SEd Tanous for (const auto& objectPath : resp) 1339cb92c03bSAndrew Geissler { 1340914e2d5dSEd Tanous const uint32_t* id = nullptr; 1341c419c759SEd Tanous const uint64_t* timestamp = nullptr; 1342c419c759SEd Tanous const uint64_t* updateTimestamp = nullptr; 1343914e2d5dSEd Tanous const std::string* severity = nullptr; 1344914e2d5dSEd Tanous const std::string* message = nullptr; 1345914e2d5dSEd Tanous const std::string* filePath = nullptr; 134675710de2SXiaochao Ma bool resolved = false; 13479eb808c1SEd Tanous for (const auto& interfaceMap : objectPath.second) 1348f86bb901SAdriana Kobylak { 1349f86bb901SAdriana Kobylak if (interfaceMap.first == 1350f86bb901SAdriana Kobylak "xyz.openbmc_project.Logging.Entry") 1351f86bb901SAdriana Kobylak { 1352002d39b4SEd Tanous for (const auto& propertyMap : interfaceMap.second) 1353cb92c03bSAndrew Geissler { 1354cb92c03bSAndrew Geissler if (propertyMap.first == "Id") 1355cb92c03bSAndrew Geissler { 1356002d39b4SEd Tanous id = std::get_if<uint32_t>(&propertyMap.second); 1357cb92c03bSAndrew Geissler } 1358cb92c03bSAndrew Geissler else if (propertyMap.first == "Timestamp") 1359cb92c03bSAndrew Geissler { 1360002d39b4SEd Tanous timestamp = 1361002d39b4SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 13627e860f15SJohn Edward Broadbent } 1363002d39b4SEd Tanous else if (propertyMap.first == "UpdateTimestamp") 13647e860f15SJohn Edward Broadbent { 1365002d39b4SEd Tanous updateTimestamp = 1366002d39b4SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 13677e860f15SJohn Edward Broadbent } 13687e860f15SJohn Edward Broadbent else if (propertyMap.first == "Severity") 13697e860f15SJohn Edward Broadbent { 13707e860f15SJohn Edward Broadbent severity = std::get_if<std::string>( 13717e860f15SJohn Edward Broadbent &propertyMap.second); 13727e860f15SJohn Edward Broadbent } 13737e860f15SJohn Edward Broadbent else if (propertyMap.first == "Message") 13747e860f15SJohn Edward Broadbent { 13757e860f15SJohn Edward Broadbent message = std::get_if<std::string>( 13767e860f15SJohn Edward Broadbent &propertyMap.second); 13777e860f15SJohn Edward Broadbent } 13787e860f15SJohn Edward Broadbent else if (propertyMap.first == "Resolved") 13797e860f15SJohn Edward Broadbent { 1380914e2d5dSEd Tanous const bool* resolveptr = 1381002d39b4SEd Tanous std::get_if<bool>(&propertyMap.second); 13827e860f15SJohn Edward Broadbent if (resolveptr == nullptr) 13837e860f15SJohn Edward Broadbent { 1384002d39b4SEd Tanous messages::internalError(asyncResp->res); 13857e860f15SJohn Edward Broadbent return; 13867e860f15SJohn Edward Broadbent } 13877e860f15SJohn Edward Broadbent resolved = *resolveptr; 13887e860f15SJohn Edward Broadbent } 13897e860f15SJohn Edward Broadbent } 13907e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 13917e860f15SJohn Edward Broadbent severity == nullptr) 13927e860f15SJohn Edward Broadbent { 13937e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 13947e860f15SJohn Edward Broadbent return; 13957e860f15SJohn Edward Broadbent } 13967e860f15SJohn Edward Broadbent } 13977e860f15SJohn Edward Broadbent else if (interfaceMap.first == 13987e860f15SJohn Edward Broadbent "xyz.openbmc_project.Common.FilePath") 13997e860f15SJohn Edward Broadbent { 1400002d39b4SEd Tanous for (const auto& propertyMap : interfaceMap.second) 14017e860f15SJohn Edward Broadbent { 14027e860f15SJohn Edward Broadbent if (propertyMap.first == "Path") 14037e860f15SJohn Edward Broadbent { 14047e860f15SJohn Edward Broadbent filePath = std::get_if<std::string>( 14057e860f15SJohn Edward Broadbent &propertyMap.second); 14067e860f15SJohn Edward Broadbent } 14077e860f15SJohn Edward Broadbent } 14087e860f15SJohn Edward Broadbent } 14097e860f15SJohn Edward Broadbent } 14107e860f15SJohn Edward Broadbent // Object path without the 14117e860f15SJohn Edward Broadbent // xyz.openbmc_project.Logging.Entry interface, ignore 14127e860f15SJohn Edward Broadbent // and continue. 14137e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 1414c419c759SEd Tanous severity == nullptr || timestamp == nullptr || 1415c419c759SEd Tanous updateTimestamp == nullptr) 14167e860f15SJohn Edward Broadbent { 14177e860f15SJohn Edward Broadbent continue; 14187e860f15SJohn Edward Broadbent } 14197e860f15SJohn Edward Broadbent entriesArray.push_back({}); 14207e860f15SJohn Edward Broadbent nlohmann::json& thisEntry = entriesArray.back(); 14217e860f15SJohn Edward Broadbent thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 14227e860f15SJohn Edward Broadbent thisEntry["@odata.id"] = 14230fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 14247e860f15SJohn Edward Broadbent std::to_string(*id); 14257e860f15SJohn Edward Broadbent thisEntry["Name"] = "System Event Log Entry"; 14267e860f15SJohn Edward Broadbent thisEntry["Id"] = std::to_string(*id); 14277e860f15SJohn Edward Broadbent thisEntry["Message"] = *message; 14287e860f15SJohn Edward Broadbent thisEntry["Resolved"] = resolved; 14297e860f15SJohn Edward Broadbent thisEntry["EntryType"] = "Event"; 14307e860f15SJohn Edward Broadbent thisEntry["Severity"] = 14317e860f15SJohn Edward Broadbent translateSeverityDbusToRedfish(*severity); 14327e860f15SJohn Edward Broadbent thisEntry["Created"] = 1433c419c759SEd Tanous crow::utility::getDateTimeUintMs(*timestamp); 14347e860f15SJohn Edward Broadbent thisEntry["Modified"] = 1435c419c759SEd Tanous crow::utility::getDateTimeUintMs(*updateTimestamp); 14367e860f15SJohn Edward Broadbent if (filePath != nullptr) 14377e860f15SJohn Edward Broadbent { 14387e860f15SJohn Edward Broadbent thisEntry["AdditionalDataURI"] = 14390fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 14407e860f15SJohn Edward Broadbent std::to_string(*id) + "/attachment"; 14417e860f15SJohn Edward Broadbent } 14427e860f15SJohn Edward Broadbent } 1443002d39b4SEd Tanous std::sort( 1444002d39b4SEd Tanous entriesArray.begin(), entriesArray.end(), 1445002d39b4SEd Tanous [](const nlohmann::json& left, const nlohmann::json& right) { 14467e860f15SJohn Edward Broadbent return (left["Id"] <= right["Id"]); 14477e860f15SJohn Edward Broadbent }); 14487e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members@odata.count"] = 14497e860f15SJohn Edward Broadbent entriesArray.size(); 14507e860f15SJohn Edward Broadbent }, 14517e860f15SJohn Edward Broadbent "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging", 14527e860f15SJohn Edward Broadbent "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 14537e860f15SJohn Edward Broadbent }); 14547e860f15SJohn Edward Broadbent } 14557e860f15SJohn Edward Broadbent 14567e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app) 14577e860f15SJohn Edward Broadbent { 14587e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 14597e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1460ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 1461002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1462002d39b4SEd Tanous [&app](const crow::Request& req, 14637e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 146445ca1b86SEd Tanous const std::string& param) { 14653ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 14667e860f15SJohn Edward Broadbent { 146745ca1b86SEd Tanous return; 146845ca1b86SEd Tanous } 14697e860f15SJohn Edward Broadbent std::string entryID = param; 14707e860f15SJohn Edward Broadbent dbus::utility::escapePathForDbus(entryID); 14717e860f15SJohn Edward Broadbent 14727e860f15SJohn Edward Broadbent // DBus implementation of EventLog/Entries 14737e860f15SJohn Edward Broadbent // Make call to Logging Service to find all log entry objects 14747e860f15SJohn Edward Broadbent crow::connections::systemBus->async_method_call( 1475002d39b4SEd Tanous [asyncResp, entryID](const boost::system::error_code ec, 1476b9d36b47SEd Tanous const dbus::utility::DBusPropertiesMap& resp) { 14777e860f15SJohn Edward Broadbent if (ec.value() == EBADR) 14787e860f15SJohn Edward Broadbent { 1479002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "EventLogEntry", 1480002d39b4SEd Tanous entryID); 14817e860f15SJohn Edward Broadbent return; 14827e860f15SJohn Edward Broadbent } 14837e860f15SJohn Edward Broadbent if (ec) 14847e860f15SJohn Edward Broadbent { 14850fda0f12SGeorge Liu BMCWEB_LOG_ERROR 1486002d39b4SEd Tanous << "EventLogEntry (DBus) resp_handler got error " << ec; 14877e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 14887e860f15SJohn Edward Broadbent return; 14897e860f15SJohn Edward Broadbent } 1490914e2d5dSEd Tanous const uint32_t* id = nullptr; 1491c419c759SEd Tanous const uint64_t* timestamp = nullptr; 1492c419c759SEd Tanous const uint64_t* updateTimestamp = nullptr; 1493914e2d5dSEd Tanous const std::string* severity = nullptr; 1494914e2d5dSEd Tanous const std::string* message = nullptr; 1495914e2d5dSEd Tanous const std::string* filePath = nullptr; 14967e860f15SJohn Edward Broadbent bool resolved = false; 14977e860f15SJohn Edward Broadbent 14989eb808c1SEd Tanous for (const auto& propertyMap : resp) 14997e860f15SJohn Edward Broadbent { 15007e860f15SJohn Edward Broadbent if (propertyMap.first == "Id") 15017e860f15SJohn Edward Broadbent { 15027e860f15SJohn Edward Broadbent id = std::get_if<uint32_t>(&propertyMap.second); 15037e860f15SJohn Edward Broadbent } 15047e860f15SJohn Edward Broadbent else if (propertyMap.first == "Timestamp") 15057e860f15SJohn Edward Broadbent { 1506002d39b4SEd Tanous timestamp = std::get_if<uint64_t>(&propertyMap.second); 1507ebd45906SGeorge Liu } 1508d139c236SGeorge Liu else if (propertyMap.first == "UpdateTimestamp") 1509d139c236SGeorge Liu { 1510ebd45906SGeorge Liu updateTimestamp = 1511c419c759SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 1512ebd45906SGeorge Liu } 1513cb92c03bSAndrew Geissler else if (propertyMap.first == "Severity") 1514cb92c03bSAndrew Geissler { 1515002d39b4SEd Tanous severity = std::get_if<std::string>(&propertyMap.second); 1516cb92c03bSAndrew Geissler } 1517cb92c03bSAndrew Geissler else if (propertyMap.first == "Message") 1518cb92c03bSAndrew Geissler { 1519002d39b4SEd Tanous message = std::get_if<std::string>(&propertyMap.second); 1520ae34c8e8SAdriana Kobylak } 152175710de2SXiaochao Ma else if (propertyMap.first == "Resolved") 152275710de2SXiaochao Ma { 1523914e2d5dSEd Tanous const bool* resolveptr = 152475710de2SXiaochao Ma std::get_if<bool>(&propertyMap.second); 152575710de2SXiaochao Ma if (resolveptr == nullptr) 152675710de2SXiaochao Ma { 152775710de2SXiaochao Ma messages::internalError(asyncResp->res); 152875710de2SXiaochao Ma return; 152975710de2SXiaochao Ma } 153075710de2SXiaochao Ma resolved = *resolveptr; 153175710de2SXiaochao Ma } 15327e860f15SJohn Edward Broadbent else if (propertyMap.first == "Path") 1533f86bb901SAdriana Kobylak { 1534002d39b4SEd Tanous filePath = std::get_if<std::string>(&propertyMap.second); 1535f86bb901SAdriana Kobylak } 1536f86bb901SAdriana Kobylak } 1537002d39b4SEd Tanous if (id == nullptr || message == nullptr || severity == nullptr || 1538002d39b4SEd Tanous timestamp == nullptr || updateTimestamp == nullptr) 1539f86bb901SAdriana Kobylak { 1540ae34c8e8SAdriana Kobylak messages::internalError(asyncResp->res); 1541271584abSEd Tanous return; 1542271584abSEd Tanous } 1543f86bb901SAdriana Kobylak asyncResp->res.jsonValue["@odata.type"] = 1544f86bb901SAdriana Kobylak "#LogEntry.v1_8_0.LogEntry"; 1545f86bb901SAdriana Kobylak asyncResp->res.jsonValue["@odata.id"] = 15460fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1547f86bb901SAdriana Kobylak std::to_string(*id); 154845ca1b86SEd Tanous asyncResp->res.jsonValue["Name"] = "System Event Log Entry"; 1549f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Id"] = std::to_string(*id); 1550f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Message"] = *message; 1551f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Resolved"] = resolved; 1552f86bb901SAdriana Kobylak asyncResp->res.jsonValue["EntryType"] = "Event"; 1553f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Severity"] = 1554f86bb901SAdriana Kobylak translateSeverityDbusToRedfish(*severity); 1555f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Created"] = 1556c419c759SEd Tanous crow::utility::getDateTimeUintMs(*timestamp); 1557f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Modified"] = 1558c419c759SEd Tanous crow::utility::getDateTimeUintMs(*updateTimestamp); 1559f86bb901SAdriana Kobylak if (filePath != nullptr) 1560f86bb901SAdriana Kobylak { 1561f86bb901SAdriana Kobylak asyncResp->res.jsonValue["AdditionalDataURI"] = 1562e7dbd530SPotin Lai "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1563e7dbd530SPotin Lai std::to_string(*id) + "/attachment"; 1564f86bb901SAdriana Kobylak } 1565cb92c03bSAndrew Geissler }, 1566cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging", 1567cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging/entry/" + entryID, 1568f86bb901SAdriana Kobylak "org.freedesktop.DBus.Properties", "GetAll", ""); 15697e860f15SJohn Edward Broadbent }); 1570336e96c6SChicago Duan 15717e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 15727e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1573ed398213SEd Tanous .privileges(redfish::privileges::patchLogEntry) 15747e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::patch)( 157545ca1b86SEd Tanous [&app](const crow::Request& req, 15767e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 15777e860f15SJohn Edward Broadbent const std::string& entryId) { 15783ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 157945ca1b86SEd Tanous { 158045ca1b86SEd Tanous return; 158145ca1b86SEd Tanous } 158275710de2SXiaochao Ma std::optional<bool> resolved; 158375710de2SXiaochao Ma 158415ed6780SWilly Tu if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved", 15857e860f15SJohn Edward Broadbent resolved)) 158675710de2SXiaochao Ma { 158775710de2SXiaochao Ma return; 158875710de2SXiaochao Ma } 158975710de2SXiaochao Ma BMCWEB_LOG_DEBUG << "Set Resolved"; 159075710de2SXiaochao Ma 159175710de2SXiaochao Ma crow::connections::systemBus->async_method_call( 15924f48d5f6SEd Tanous [asyncResp, entryId](const boost::system::error_code ec) { 159375710de2SXiaochao Ma if (ec) 159475710de2SXiaochao Ma { 159575710de2SXiaochao Ma BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 159675710de2SXiaochao Ma messages::internalError(asyncResp->res); 159775710de2SXiaochao Ma return; 159875710de2SXiaochao Ma } 159975710de2SXiaochao Ma }, 160075710de2SXiaochao Ma "xyz.openbmc_project.Logging", 160175710de2SXiaochao Ma "/xyz/openbmc_project/logging/entry/" + entryId, 160275710de2SXiaochao Ma "org.freedesktop.DBus.Properties", "Set", 160375710de2SXiaochao Ma "xyz.openbmc_project.Logging.Entry", "Resolved", 1604168e20c1SEd Tanous dbus::utility::DbusVariantType(*resolved)); 16057e860f15SJohn Edward Broadbent }); 160675710de2SXiaochao Ma 16077e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 16087e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1609ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 1610ed398213SEd Tanous 1611002d39b4SEd Tanous .methods(boost::beast::http::verb::delete_)( 1612002d39b4SEd Tanous [&app](const crow::Request& req, 1613002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 161445ca1b86SEd Tanous const std::string& param) { 16153ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1616336e96c6SChicago Duan { 161745ca1b86SEd Tanous return; 161845ca1b86SEd Tanous } 1619336e96c6SChicago Duan BMCWEB_LOG_DEBUG << "Do delete single event entries."; 1620336e96c6SChicago Duan 16217e860f15SJohn Edward Broadbent std::string entryID = param; 1622336e96c6SChicago Duan 1623336e96c6SChicago Duan dbus::utility::escapePathForDbus(entryID); 1624336e96c6SChicago Duan 1625336e96c6SChicago Duan // Process response from Logging service. 1626002d39b4SEd Tanous auto respHandler = 1627002d39b4SEd Tanous [asyncResp, entryID](const boost::system::error_code ec) { 1628002d39b4SEd Tanous BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done"; 1629336e96c6SChicago Duan if (ec) 1630336e96c6SChicago Duan { 16313de8d8baSGeorge Liu if (ec.value() == EBADR) 16323de8d8baSGeorge Liu { 163345ca1b86SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 163445ca1b86SEd Tanous entryID); 16353de8d8baSGeorge Liu return; 16363de8d8baSGeorge Liu } 1637336e96c6SChicago Duan // TODO Handle for specific error code 16380fda0f12SGeorge Liu BMCWEB_LOG_ERROR 16390fda0f12SGeorge Liu << "EventLogEntry (DBus) doDelete respHandler got error " 1640336e96c6SChicago Duan << ec; 1641336e96c6SChicago Duan asyncResp->res.result( 1642336e96c6SChicago Duan boost::beast::http::status::internal_server_error); 1643336e96c6SChicago Duan return; 1644336e96c6SChicago Duan } 1645336e96c6SChicago Duan 1646336e96c6SChicago Duan asyncResp->res.result(boost::beast::http::status::ok); 1647336e96c6SChicago Duan }; 1648336e96c6SChicago Duan 1649336e96c6SChicago Duan // Make call to Logging service to request Delete Log 1650336e96c6SChicago Duan crow::connections::systemBus->async_method_call( 1651336e96c6SChicago Duan respHandler, "xyz.openbmc_project.Logging", 1652336e96c6SChicago Duan "/xyz/openbmc_project/logging/entry/" + entryID, 1653336e96c6SChicago Duan "xyz.openbmc_project.Object.Delete", "Delete"); 16547e860f15SJohn Edward Broadbent }); 1655400fd1fbSAdriana Kobylak } 1656400fd1fbSAdriana Kobylak 16577e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryDownload(App& app) 1658400fd1fbSAdriana Kobylak { 16590fda0f12SGeorge Liu BMCWEB_ROUTE( 16600fda0f12SGeorge Liu app, 16610fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/attachment") 1662ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 16637e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 166445ca1b86SEd Tanous [&app](const crow::Request& req, 16657e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 166645ca1b86SEd Tanous const std::string& param) { 16673ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 16687e860f15SJohn Edward Broadbent { 166945ca1b86SEd Tanous return; 167045ca1b86SEd Tanous } 1671002d39b4SEd Tanous if (!http_helpers::isOctetAccepted(req.getHeaderValue("Accept"))) 1672400fd1fbSAdriana Kobylak { 1673002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::bad_request); 1674400fd1fbSAdriana Kobylak return; 1675400fd1fbSAdriana Kobylak } 1676400fd1fbSAdriana Kobylak 16777e860f15SJohn Edward Broadbent std::string entryID = param; 1678400fd1fbSAdriana Kobylak dbus::utility::escapePathForDbus(entryID); 1679400fd1fbSAdriana Kobylak 1680400fd1fbSAdriana Kobylak crow::connections::systemBus->async_method_call( 1681002d39b4SEd Tanous [asyncResp, entryID](const boost::system::error_code ec, 1682400fd1fbSAdriana Kobylak const sdbusplus::message::unix_fd& unixfd) { 1683400fd1fbSAdriana Kobylak if (ec.value() == EBADR) 1684400fd1fbSAdriana Kobylak { 1685002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "EventLogAttachment", 1686002d39b4SEd Tanous entryID); 1687400fd1fbSAdriana Kobylak return; 1688400fd1fbSAdriana Kobylak } 1689400fd1fbSAdriana Kobylak if (ec) 1690400fd1fbSAdriana Kobylak { 1691400fd1fbSAdriana Kobylak BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 1692400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1693400fd1fbSAdriana Kobylak return; 1694400fd1fbSAdriana Kobylak } 1695400fd1fbSAdriana Kobylak 1696400fd1fbSAdriana Kobylak int fd = -1; 1697400fd1fbSAdriana Kobylak fd = dup(unixfd); 1698400fd1fbSAdriana Kobylak if (fd == -1) 1699400fd1fbSAdriana Kobylak { 1700400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1701400fd1fbSAdriana Kobylak return; 1702400fd1fbSAdriana Kobylak } 1703400fd1fbSAdriana Kobylak 1704400fd1fbSAdriana Kobylak long long int size = lseek(fd, 0, SEEK_END); 1705400fd1fbSAdriana Kobylak if (size == -1) 1706400fd1fbSAdriana Kobylak { 1707400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1708400fd1fbSAdriana Kobylak return; 1709400fd1fbSAdriana Kobylak } 1710400fd1fbSAdriana Kobylak 1711400fd1fbSAdriana Kobylak // Arbitrary max size of 64kb 1712400fd1fbSAdriana Kobylak constexpr int maxFileSize = 65536; 1713400fd1fbSAdriana Kobylak if (size > maxFileSize) 1714400fd1fbSAdriana Kobylak { 1715002d39b4SEd Tanous BMCWEB_LOG_ERROR << "File size exceeds maximum allowed size of " 1716400fd1fbSAdriana Kobylak << maxFileSize; 1717400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1718400fd1fbSAdriana Kobylak return; 1719400fd1fbSAdriana Kobylak } 1720400fd1fbSAdriana Kobylak std::vector<char> data(static_cast<size_t>(size)); 1721400fd1fbSAdriana Kobylak long long int rc = lseek(fd, 0, SEEK_SET); 1722400fd1fbSAdriana Kobylak if (rc == -1) 1723400fd1fbSAdriana Kobylak { 1724400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1725400fd1fbSAdriana Kobylak return; 1726400fd1fbSAdriana Kobylak } 1727400fd1fbSAdriana Kobylak rc = read(fd, data.data(), data.size()); 1728400fd1fbSAdriana Kobylak if ((rc == -1) || (rc != size)) 1729400fd1fbSAdriana Kobylak { 1730400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1731400fd1fbSAdriana Kobylak return; 1732400fd1fbSAdriana Kobylak } 1733400fd1fbSAdriana Kobylak close(fd); 1734400fd1fbSAdriana Kobylak 1735400fd1fbSAdriana Kobylak std::string_view strData(data.data(), data.size()); 1736002d39b4SEd Tanous std::string output = crow::utility::base64encode(strData); 1737400fd1fbSAdriana Kobylak 1738400fd1fbSAdriana Kobylak asyncResp->res.addHeader("Content-Type", 1739400fd1fbSAdriana Kobylak "application/octet-stream"); 1740002d39b4SEd Tanous asyncResp->res.addHeader("Content-Transfer-Encoding", "Base64"); 1741400fd1fbSAdriana Kobylak asyncResp->res.body() = std::move(output); 1742400fd1fbSAdriana Kobylak }, 1743400fd1fbSAdriana Kobylak "xyz.openbmc_project.Logging", 1744400fd1fbSAdriana Kobylak "/xyz/openbmc_project/logging/entry/" + entryID, 1745400fd1fbSAdriana Kobylak "xyz.openbmc_project.Logging.Entry", "GetEntry"); 17467e860f15SJohn Edward Broadbent }); 17471da66f75SEd Tanous } 17481da66f75SEd Tanous 1749b7028ebfSSpencer Ku constexpr const char* hostLoggerFolderPath = "/var/log/console"; 1750b7028ebfSSpencer Ku 1751b7028ebfSSpencer Ku inline bool 1752b7028ebfSSpencer Ku getHostLoggerFiles(const std::string& hostLoggerFilePath, 1753b7028ebfSSpencer Ku std::vector<std::filesystem::path>& hostLoggerFiles) 1754b7028ebfSSpencer Ku { 1755b7028ebfSSpencer Ku std::error_code ec; 1756b7028ebfSSpencer Ku std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec); 1757b7028ebfSSpencer Ku if (ec) 1758b7028ebfSSpencer Ku { 1759b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << ec.message(); 1760b7028ebfSSpencer Ku return false; 1761b7028ebfSSpencer Ku } 1762b7028ebfSSpencer Ku for (const std::filesystem::directory_entry& it : logPath) 1763b7028ebfSSpencer Ku { 1764b7028ebfSSpencer Ku std::string filename = it.path().filename(); 1765b7028ebfSSpencer Ku // Prefix of each log files is "log". Find the file and save the 1766b7028ebfSSpencer Ku // path 1767b7028ebfSSpencer Ku if (boost::starts_with(filename, "log")) 1768b7028ebfSSpencer Ku { 1769b7028ebfSSpencer Ku hostLoggerFiles.emplace_back(it.path()); 1770b7028ebfSSpencer Ku } 1771b7028ebfSSpencer Ku } 1772b7028ebfSSpencer Ku // As the log files rotate, they are appended with a ".#" that is higher for 1773b7028ebfSSpencer Ku // the older logs. Since we start from oldest logs, sort the name in 1774b7028ebfSSpencer Ku // descending order. 1775b7028ebfSSpencer Ku std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(), 1776b7028ebfSSpencer Ku AlphanumLess<std::string>()); 1777b7028ebfSSpencer Ku 1778b7028ebfSSpencer Ku return true; 1779b7028ebfSSpencer Ku } 1780b7028ebfSSpencer Ku 1781b7028ebfSSpencer Ku inline bool 1782b7028ebfSSpencer Ku getHostLoggerEntries(std::vector<std::filesystem::path>& hostLoggerFiles, 1783c937d2bfSEd Tanous uint64_t skip, uint64_t top, 1784b7028ebfSSpencer Ku std::vector<std::string>& logEntries, size_t& logCount) 1785b7028ebfSSpencer Ku { 1786b7028ebfSSpencer Ku GzFileReader logFile; 1787b7028ebfSSpencer Ku 1788b7028ebfSSpencer Ku // Go though all log files and expose host logs. 1789b7028ebfSSpencer Ku for (const std::filesystem::path& it : hostLoggerFiles) 1790b7028ebfSSpencer Ku { 1791b7028ebfSSpencer Ku if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount)) 1792b7028ebfSSpencer Ku { 1793b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << "fail to expose host logs"; 1794b7028ebfSSpencer Ku return false; 1795b7028ebfSSpencer Ku } 1796b7028ebfSSpencer Ku } 1797b7028ebfSSpencer Ku // Get lastMessage from constructor by getter 1798b7028ebfSSpencer Ku std::string lastMessage = logFile.getLastMessage(); 1799b7028ebfSSpencer Ku if (!lastMessage.empty()) 1800b7028ebfSSpencer Ku { 1801b7028ebfSSpencer Ku logCount++; 1802b7028ebfSSpencer Ku if (logCount > skip && logCount <= (skip + top)) 1803b7028ebfSSpencer Ku { 1804b7028ebfSSpencer Ku logEntries.push_back(lastMessage); 1805b7028ebfSSpencer Ku } 1806b7028ebfSSpencer Ku } 1807b7028ebfSSpencer Ku return true; 1808b7028ebfSSpencer Ku } 1809b7028ebfSSpencer Ku 1810b7028ebfSSpencer Ku inline void fillHostLoggerEntryJson(const std::string& logEntryID, 1811b7028ebfSSpencer Ku const std::string& msg, 1812b7028ebfSSpencer Ku nlohmann::json& logEntryJson) 1813b7028ebfSSpencer Ku { 1814b7028ebfSSpencer Ku // Fill in the log entry with the gathered data. 1815b7028ebfSSpencer Ku logEntryJson = { 1816b7028ebfSSpencer Ku {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 1817b7028ebfSSpencer Ku {"@odata.id", 1818b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/" + 1819b7028ebfSSpencer Ku logEntryID}, 1820b7028ebfSSpencer Ku {"Name", "Host Logger Entry"}, 1821b7028ebfSSpencer Ku {"Id", logEntryID}, 1822b7028ebfSSpencer Ku {"Message", msg}, 1823b7028ebfSSpencer Ku {"EntryType", "Oem"}, 1824b7028ebfSSpencer Ku {"Severity", "OK"}, 1825b7028ebfSSpencer Ku {"OemRecordFormat", "Host Logger Entry"}}; 1826b7028ebfSSpencer Ku } 1827b7028ebfSSpencer Ku 1828b7028ebfSSpencer Ku inline void requestRoutesSystemHostLogger(App& app) 1829b7028ebfSSpencer Ku { 1830b7028ebfSSpencer Ku BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/HostLogger/") 1831b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogService) 18321476687dSEd Tanous .methods(boost::beast::http::verb::get)( 18331476687dSEd Tanous [&app](const crow::Request& req, 18341476687dSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 18353ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 183645ca1b86SEd Tanous { 183745ca1b86SEd Tanous return; 183845ca1b86SEd Tanous } 1839b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 1840b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger"; 1841b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 1842b7028ebfSSpencer Ku "#LogService.v1_1_0.LogService"; 1843b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "Host Logger Service"; 1844b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = "Host Logger Service"; 1845b7028ebfSSpencer Ku asyncResp->res.jsonValue["Id"] = "HostLogger"; 18461476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 18471476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 1848b7028ebfSSpencer Ku }); 1849b7028ebfSSpencer Ku } 1850b7028ebfSSpencer Ku 1851b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerCollection(App& app) 1852b7028ebfSSpencer Ku { 1853b7028ebfSSpencer Ku BMCWEB_ROUTE(app, 1854b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/") 1855b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 1856002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1857002d39b4SEd Tanous [&app](const crow::Request& req, 1858002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1859c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 1860c937d2bfSEd Tanous .canDelegateTop = true, 1861c937d2bfSEd Tanous .canDelegateSkip = true, 1862c937d2bfSEd Tanous }; 1863c937d2bfSEd Tanous query_param::Query delegatedQuery; 1864c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 18653ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 1866b7028ebfSSpencer Ku { 1867b7028ebfSSpencer Ku return; 1868b7028ebfSSpencer Ku } 1869b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 1870b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 1871b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 1872b7028ebfSSpencer Ku "#LogEntryCollection.LogEntryCollection"; 1873b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "HostLogger Entries"; 1874b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = 1875b7028ebfSSpencer Ku "Collection of HostLogger Entries"; 18760fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1877b7028ebfSSpencer Ku logEntryArray = nlohmann::json::array(); 1878b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = 0; 1879b7028ebfSSpencer Ku 1880b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 1881b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 1882b7028ebfSSpencer Ku { 1883b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << "fail to get host log file path"; 1884b7028ebfSSpencer Ku return; 1885b7028ebfSSpencer Ku } 1886b7028ebfSSpencer Ku 1887b7028ebfSSpencer Ku size_t logCount = 0; 1888b7028ebfSSpencer Ku // This vector only store the entries we want to expose that 1889b7028ebfSSpencer Ku // control by skip and top. 1890b7028ebfSSpencer Ku std::vector<std::string> logEntries; 1891c937d2bfSEd Tanous if (!getHostLoggerEntries(hostLoggerFiles, delegatedQuery.skip, 1892c937d2bfSEd Tanous delegatedQuery.top, logEntries, logCount)) 1893b7028ebfSSpencer Ku { 1894b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 1895b7028ebfSSpencer Ku return; 1896b7028ebfSSpencer Ku } 1897b7028ebfSSpencer Ku // If vector is empty, that means skip value larger than total 1898b7028ebfSSpencer Ku // log count 189926f6976fSEd Tanous if (logEntries.empty()) 1900b7028ebfSSpencer Ku { 1901b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 1902b7028ebfSSpencer Ku return; 1903b7028ebfSSpencer Ku } 190426f6976fSEd Tanous if (!logEntries.empty()) 1905b7028ebfSSpencer Ku { 1906b7028ebfSSpencer Ku for (size_t i = 0; i < logEntries.size(); i++) 1907b7028ebfSSpencer Ku { 1908b7028ebfSSpencer Ku logEntryArray.push_back({}); 1909b7028ebfSSpencer Ku nlohmann::json& hostLogEntry = logEntryArray.back(); 1910002d39b4SEd Tanous fillHostLoggerEntryJson(std::to_string(delegatedQuery.skip + i), 1911002d39b4SEd Tanous logEntries[i], hostLogEntry); 1912b7028ebfSSpencer Ku } 1913b7028ebfSSpencer Ku 1914b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 1915c937d2bfSEd Tanous if (delegatedQuery.skip + delegatedQuery.top < logCount) 1916b7028ebfSSpencer Ku { 1917b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.nextLink"] = 19180fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/HostLogger/Entries?$skip=" + 1919002d39b4SEd Tanous std::to_string(delegatedQuery.skip + delegatedQuery.top); 1920b7028ebfSSpencer Ku } 1921b7028ebfSSpencer Ku } 1922b7028ebfSSpencer Ku }); 1923b7028ebfSSpencer Ku } 1924b7028ebfSSpencer Ku 1925b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerLogEntry(App& app) 1926b7028ebfSSpencer Ku { 1927b7028ebfSSpencer Ku BMCWEB_ROUTE( 1928b7028ebfSSpencer Ku app, "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/<str>/") 1929b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 1930b7028ebfSSpencer Ku .methods(boost::beast::http::verb::get)( 193145ca1b86SEd Tanous [&app](const crow::Request& req, 1932b7028ebfSSpencer Ku const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1933b7028ebfSSpencer Ku const std::string& param) { 19343ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 193545ca1b86SEd Tanous { 193645ca1b86SEd Tanous return; 193745ca1b86SEd Tanous } 1938b7028ebfSSpencer Ku const std::string& targetID = param; 1939b7028ebfSSpencer Ku 1940b7028ebfSSpencer Ku uint64_t idInt = 0; 1941ca45aa3cSEd Tanous 1942ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 1943ca45aa3cSEd Tanous const char* end = targetID.data() + targetID.size(); 1944ca45aa3cSEd Tanous 1945ca45aa3cSEd Tanous auto [ptr, ec] = std::from_chars(targetID.data(), end, idInt); 1946b7028ebfSSpencer Ku if (ec == std::errc::invalid_argument) 1947b7028ebfSSpencer Ku { 1948ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 1949b7028ebfSSpencer Ku return; 1950b7028ebfSSpencer Ku } 1951b7028ebfSSpencer Ku if (ec == std::errc::result_out_of_range) 1952b7028ebfSSpencer Ku { 1953ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 1954b7028ebfSSpencer Ku return; 1955b7028ebfSSpencer Ku } 1956b7028ebfSSpencer Ku 1957b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 1958b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 1959b7028ebfSSpencer Ku { 1960b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << "fail to get host log file path"; 1961b7028ebfSSpencer Ku return; 1962b7028ebfSSpencer Ku } 1963b7028ebfSSpencer Ku 1964b7028ebfSSpencer Ku size_t logCount = 0; 1965b7028ebfSSpencer Ku uint64_t top = 1; 1966b7028ebfSSpencer Ku std::vector<std::string> logEntries; 1967b7028ebfSSpencer Ku // We can get specific entry by skip and top. For example, if we 1968b7028ebfSSpencer Ku // want to get nth entry, we can set skip = n-1 and top = 1 to 1969b7028ebfSSpencer Ku // get that entry 1970002d39b4SEd Tanous if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, logEntries, 1971002d39b4SEd Tanous logCount)) 1972b7028ebfSSpencer Ku { 1973b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 1974b7028ebfSSpencer Ku return; 1975b7028ebfSSpencer Ku } 1976b7028ebfSSpencer Ku 1977b7028ebfSSpencer Ku if (!logEntries.empty()) 1978b7028ebfSSpencer Ku { 1979b7028ebfSSpencer Ku fillHostLoggerEntryJson(targetID, logEntries[0], 1980b7028ebfSSpencer Ku asyncResp->res.jsonValue); 1981b7028ebfSSpencer Ku return; 1982b7028ebfSSpencer Ku } 1983b7028ebfSSpencer Ku 1984b7028ebfSSpencer Ku // Requested ID was not found 1985ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 1986b7028ebfSSpencer Ku }); 1987b7028ebfSSpencer Ku } 1988b7028ebfSSpencer Ku 1989fdd26906SClaire Weinan constexpr char const* dumpManagerIface = 1990fdd26906SClaire Weinan "xyz.openbmc_project.Collection.DeleteAll"; 1991fdd26906SClaire Weinan inline void handleLogServicesCollectionGet( 1992fdd26906SClaire Weinan crow::App& app, const crow::Request& req, 1993fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 19941da66f75SEd Tanous { 19953ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 199645ca1b86SEd Tanous { 199745ca1b86SEd Tanous return; 199845ca1b86SEd Tanous } 19997e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 20007e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2001e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 20021da66f75SEd Tanous "#LogServiceCollection.LogServiceCollection"; 2003e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 2004e1f26343SJason M. Bills "/redfish/v1/Managers/bmc/LogServices"; 2005002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection"; 2006e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 20071da66f75SEd Tanous "Collection of LogServices for this Manager"; 2008002d39b4SEd Tanous nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 2009c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 2010fdd26906SClaire Weinan 2011c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL 2012c4bf6374SJason M. Bills logServiceArray.push_back( 2013002d39b4SEd Tanous {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal"}}); 2014c4bf6374SJason M. Bills #endif 2015fdd26906SClaire Weinan 2016fdd26906SClaire Weinan asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size(); 2017fdd26906SClaire Weinan 2018fdd26906SClaire Weinan #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 2019fdd26906SClaire Weinan auto respHandler = 2020fdd26906SClaire Weinan [asyncResp]( 2021fdd26906SClaire Weinan const boost::system::error_code ec, 2022fdd26906SClaire Weinan const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 2023fdd26906SClaire Weinan if (ec) 2024fdd26906SClaire Weinan { 2025fdd26906SClaire Weinan BMCWEB_LOG_ERROR 2026fdd26906SClaire Weinan << "handleLogServicesCollectionGet respHandler got error " 2027fdd26906SClaire Weinan << ec; 2028fdd26906SClaire Weinan // Assume that getting an error simply means there are no dump 2029fdd26906SClaire Weinan // LogServices. Return without adding any error response. 2030fdd26906SClaire Weinan return; 2031fdd26906SClaire Weinan } 2032fdd26906SClaire Weinan 2033fdd26906SClaire Weinan nlohmann::json& logServiceArrayLocal = 2034fdd26906SClaire Weinan asyncResp->res.jsonValue["Members"]; 2035fdd26906SClaire Weinan 2036fdd26906SClaire Weinan for (const std::string& path : subTreePaths) 2037fdd26906SClaire Weinan { 2038fdd26906SClaire Weinan if (path == "/xyz/openbmc_project/dump/bmc") 2039fdd26906SClaire Weinan { 2040fdd26906SClaire Weinan logServiceArrayLocal.push_back( 2041fdd26906SClaire Weinan {{"@odata.id", 2042fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/Dump"}}); 2043fdd26906SClaire Weinan } 2044fdd26906SClaire Weinan else if (path == "/xyz/openbmc_project/dump/faultlog") 2045fdd26906SClaire Weinan { 2046fdd26906SClaire Weinan logServiceArrayLocal.push_back( 2047fdd26906SClaire Weinan {{"@odata.id", 2048fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog"}}); 2049fdd26906SClaire Weinan } 2050fdd26906SClaire Weinan } 2051fdd26906SClaire Weinan 2052e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 2053fdd26906SClaire Weinan logServiceArrayLocal.size(); 2054fdd26906SClaire Weinan }; 2055fdd26906SClaire Weinan 2056fdd26906SClaire Weinan crow::connections::systemBus->async_method_call( 2057fdd26906SClaire Weinan respHandler, "xyz.openbmc_project.ObjectMapper", 2058fdd26906SClaire Weinan "/xyz/openbmc_project/object_mapper", 2059fdd26906SClaire Weinan "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 2060fdd26906SClaire Weinan "/xyz/openbmc_project/dump", 0, 2061fdd26906SClaire Weinan std::array<const char*, 1>{dumpManagerIface}); 2062fdd26906SClaire Weinan #endif 2063fdd26906SClaire Weinan } 2064fdd26906SClaire Weinan 2065fdd26906SClaire Weinan inline void requestRoutesBMCLogServiceCollection(App& app) 2066fdd26906SClaire Weinan { 2067fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/") 2068fdd26906SClaire Weinan .privileges(redfish::privileges::getLogServiceCollection) 2069fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 2070fdd26906SClaire Weinan std::bind_front(handleLogServicesCollectionGet, std::ref(app))); 2071e1f26343SJason M. Bills } 2072e1f26343SJason M. Bills 20737e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogService(App& app) 2074e1f26343SJason M. Bills { 20757e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/") 2076ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 20777e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 207845ca1b86SEd Tanous [&app](const crow::Request& req, 207945ca1b86SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 20803ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 20817e860f15SJohn Edward Broadbent { 208245ca1b86SEd Tanous return; 208345ca1b86SEd Tanous } 2084e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2085e1f26343SJason M. Bills "#LogService.v1_1_0.LogService"; 20860f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 20870f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal"; 2088002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service"; 2089002d39b4SEd Tanous asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service"; 2090c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "BMC Journal"; 2091e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 20927c8c4058STejas Patil 20937c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 20947c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 2095002d39b4SEd Tanous asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 20967c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 20977c8c4058STejas Patil redfishDateTimeOffset.second; 20987c8c4058STejas Patil 20991476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 21001476687dSEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 21017e860f15SJohn Edward Broadbent }); 2102e1f26343SJason M. Bills } 2103e1f26343SJason M. Bills 21043a48b3a2SJason M. Bills static int 21053a48b3a2SJason M. Bills fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID, 2106e1f26343SJason M. Bills sd_journal* journal, 21073a48b3a2SJason M. Bills nlohmann::json::object_t& bmcJournalLogEntryJson) 2108e1f26343SJason M. Bills { 2109e1f26343SJason M. Bills // Get the Log Entry contents 2110e1f26343SJason M. Bills int ret = 0; 2111e1f26343SJason M. Bills 2112a8fe54f0SJason M. Bills std::string message; 2113a8fe54f0SJason M. Bills std::string_view syslogID; 2114a8fe54f0SJason M. Bills ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID); 2115a8fe54f0SJason M. Bills if (ret < 0) 2116a8fe54f0SJason M. Bills { 2117a8fe54f0SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read SYSLOG_IDENTIFIER field: " 2118a8fe54f0SJason M. Bills << strerror(-ret); 2119a8fe54f0SJason M. Bills } 2120a8fe54f0SJason M. Bills if (!syslogID.empty()) 2121a8fe54f0SJason M. Bills { 2122a8fe54f0SJason M. Bills message += std::string(syslogID) + ": "; 2123a8fe54f0SJason M. Bills } 2124a8fe54f0SJason M. Bills 212539e77504SEd Tanous std::string_view msg; 212616428a1aSJason M. Bills ret = getJournalMetadata(journal, "MESSAGE", msg); 2127e1f26343SJason M. Bills if (ret < 0) 2128e1f26343SJason M. Bills { 2129e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret); 2130e1f26343SJason M. Bills return 1; 2131e1f26343SJason M. Bills } 2132a8fe54f0SJason M. Bills message += std::string(msg); 2133e1f26343SJason M. Bills 2134e1f26343SJason M. Bills // Get the severity from the PRIORITY field 2135271584abSEd Tanous long int severity = 8; // Default to an invalid priority 213616428a1aSJason M. Bills ret = getJournalMetadata(journal, "PRIORITY", 10, severity); 2137e1f26343SJason M. Bills if (ret < 0) 2138e1f26343SJason M. Bills { 2139e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret); 2140e1f26343SJason M. Bills } 2141e1f26343SJason M. Bills 2142e1f26343SJason M. Bills // Get the Created time from the timestamp 214316428a1aSJason M. Bills std::string entryTimeStr; 214416428a1aSJason M. Bills if (!getEntryTimestamp(journal, entryTimeStr)) 2145e1f26343SJason M. Bills { 214616428a1aSJason M. Bills return 1; 2147e1f26343SJason M. Bills } 2148e1f26343SJason M. Bills 2149e1f26343SJason M. Bills // Fill in the log entry with the gathered data 2150*84afc48bSJason M. Bills bmcJournalLogEntryJson["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 2151*84afc48bSJason M. Bills bmcJournalLogEntryJson["@odata.id"] = 2152*84afc48bSJason M. Bills "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" + 2153*84afc48bSJason M. Bills bmcJournalLogEntryID; 2154*84afc48bSJason M. Bills bmcJournalLogEntryJson["Name"] = "BMC Journal Entry"; 2155*84afc48bSJason M. Bills bmcJournalLogEntryJson["Id"] = bmcJournalLogEntryID; 2156*84afc48bSJason M. Bills bmcJournalLogEntryJson["Message"] = std::move(message); 2157*84afc48bSJason M. Bills bmcJournalLogEntryJson["EntryType"] = "Oem"; 2158*84afc48bSJason M. Bills bmcJournalLogEntryJson["Severity"] = severity <= 2 ? "Critical" 2159738c1e61SPatrick Williams : severity <= 4 ? "Warning" 2160*84afc48bSJason M. Bills : "OK"; 2161*84afc48bSJason M. Bills bmcJournalLogEntryJson["OemRecordFormat"] = "BMC Journal Entry"; 2162*84afc48bSJason M. Bills bmcJournalLogEntryJson["Created"] = std::move(entryTimeStr); 2163e1f26343SJason M. Bills return 0; 2164e1f26343SJason M. Bills } 2165e1f26343SJason M. Bills 21667e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntryCollection(App& app) 2167e1f26343SJason M. Bills { 21687e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/") 2169ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 2170002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2171002d39b4SEd Tanous [&app](const crow::Request& req, 2172002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2173c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 2174c937d2bfSEd Tanous .canDelegateTop = true, 2175c937d2bfSEd Tanous .canDelegateSkip = true, 2176c937d2bfSEd Tanous }; 2177c937d2bfSEd Tanous query_param::Query delegatedQuery; 2178c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 21793ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 2180193ad2faSJason M. Bills { 2181193ad2faSJason M. Bills return; 2182193ad2faSJason M. Bills } 21837e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 21847e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2185e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2186e1f26343SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 21870f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 21880f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 2189e1f26343SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries"; 2190e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2191e1f26343SJason M. Bills "Collection of BMC Journal Entries"; 21920fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2193e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 2194e1f26343SJason M. Bills 21957e860f15SJohn Edward Broadbent // Go through the journal and use the timestamp to create a 21967e860f15SJohn Edward Broadbent // unique ID for each entry 2197e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2198e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2199e1f26343SJason M. Bills if (ret < 0) 2200e1f26343SJason M. Bills { 2201002d39b4SEd Tanous BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 2202f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2203e1f26343SJason M. Bills return; 2204e1f26343SJason M. Bills } 22050fda0f12SGeorge Liu std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 22060fda0f12SGeorge Liu journalTmp, sd_journal_close); 2207e1f26343SJason M. Bills journalTmp = nullptr; 2208b01bf299SEd Tanous uint64_t entryCount = 0; 2209e85d6b16SJason M. Bills // Reset the unique ID on the first entry 2210e85d6b16SJason M. Bills bool firstEntry = true; 2211e1f26343SJason M. Bills SD_JOURNAL_FOREACH(journal.get()) 2212e1f26343SJason M. Bills { 2213193ad2faSJason M. Bills entryCount++; 22147e860f15SJohn Edward Broadbent // Handle paging using skip (number of entries to skip from 22157e860f15SJohn Edward Broadbent // the start) and top (number of entries to display) 2216c937d2bfSEd Tanous if (entryCount <= delegatedQuery.skip || 2217c937d2bfSEd Tanous entryCount > delegatedQuery.skip + delegatedQuery.top) 2218193ad2faSJason M. Bills { 2219193ad2faSJason M. Bills continue; 2220193ad2faSJason M. Bills } 2221193ad2faSJason M. Bills 222216428a1aSJason M. Bills std::string idStr; 2223e85d6b16SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2224e1f26343SJason M. Bills { 2225e1f26343SJason M. Bills continue; 2226e1f26343SJason M. Bills } 2227e85d6b16SJason M. Bills firstEntry = false; 2228e85d6b16SJason M. Bills 22293a48b3a2SJason M. Bills nlohmann::json::object_t bmcJournalLogEntry; 2230c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(idStr, journal.get(), 2231c4bf6374SJason M. Bills bmcJournalLogEntry) != 0) 2232e1f26343SJason M. Bills { 2233f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2234e1f26343SJason M. Bills return; 2235e1f26343SJason M. Bills } 22363a48b3a2SJason M. Bills logEntryArray.push_back(std::move(bmcJournalLogEntry)); 2237e1f26343SJason M. Bills } 2238193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 2239c937d2bfSEd Tanous if (delegatedQuery.skip + delegatedQuery.top < entryCount) 2240193ad2faSJason M. Bills { 2241193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 22420fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" + 2243c937d2bfSEd Tanous std::to_string(delegatedQuery.skip + delegatedQuery.top); 2244193ad2faSJason M. Bills } 22457e860f15SJohn Edward Broadbent }); 2246e1f26343SJason M. Bills } 2247e1f26343SJason M. Bills 22487e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntry(App& app) 2249e1f26343SJason M. Bills { 22507e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 22517e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/") 2252ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 22537e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 225445ca1b86SEd Tanous [&app](const crow::Request& req, 22557e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 22567e860f15SJohn Edward Broadbent const std::string& entryID) { 22573ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 225845ca1b86SEd Tanous { 225945ca1b86SEd Tanous return; 226045ca1b86SEd Tanous } 2261e1f26343SJason M. Bills // Convert the unique ID back to a timestamp to find the entry 2262e1f26343SJason M. Bills uint64_t ts = 0; 2263271584abSEd Tanous uint64_t index = 0; 22648d1b46d7Szhanghch05 if (!getTimestampFromID(asyncResp, entryID, ts, index)) 2265e1f26343SJason M. Bills { 226616428a1aSJason M. Bills return; 2267e1f26343SJason M. Bills } 2268e1f26343SJason M. Bills 2269e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2270e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2271e1f26343SJason M. Bills if (ret < 0) 2272e1f26343SJason M. Bills { 2273002d39b4SEd Tanous BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 2274f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2275e1f26343SJason M. Bills return; 2276e1f26343SJason M. Bills } 2277002d39b4SEd Tanous std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 2278002d39b4SEd Tanous journalTmp, sd_journal_close); 2279e1f26343SJason M. Bills journalTmp = nullptr; 22807e860f15SJohn Edward Broadbent // Go to the timestamp in the log and move to the entry at the 22817e860f15SJohn Edward Broadbent // index tracking the unique ID 2282af07e3f5SJason M. Bills std::string idStr; 2283af07e3f5SJason M. Bills bool firstEntry = true; 2284e1f26343SJason M. Bills ret = sd_journal_seek_realtime_usec(journal.get(), ts); 22852056b6d1SManojkiran Eda if (ret < 0) 22862056b6d1SManojkiran Eda { 22872056b6d1SManojkiran Eda BMCWEB_LOG_ERROR << "failed to seek to an entry in journal" 22882056b6d1SManojkiran Eda << strerror(-ret); 22892056b6d1SManojkiran Eda messages::internalError(asyncResp->res); 22902056b6d1SManojkiran Eda return; 22912056b6d1SManojkiran Eda } 2292271584abSEd Tanous for (uint64_t i = 0; i <= index; i++) 2293e1f26343SJason M. Bills { 2294e1f26343SJason M. Bills sd_journal_next(journal.get()); 2295af07e3f5SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2296af07e3f5SJason M. Bills { 2297af07e3f5SJason M. Bills messages::internalError(asyncResp->res); 2298af07e3f5SJason M. Bills return; 2299af07e3f5SJason M. Bills } 2300af07e3f5SJason M. Bills firstEntry = false; 2301af07e3f5SJason M. Bills } 2302c4bf6374SJason M. Bills // Confirm that the entry ID matches what was requested 2303af07e3f5SJason M. Bills if (idStr != entryID) 2304c4bf6374SJason M. Bills { 2305ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 2306c4bf6374SJason M. Bills return; 2307c4bf6374SJason M. Bills } 2308c4bf6374SJason M. Bills 23093a48b3a2SJason M. Bills nlohmann::json::object_t bmcJournalLogEntry; 2310c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(entryID, journal.get(), 23113a48b3a2SJason M. Bills bmcJournalLogEntry) != 0) 2312e1f26343SJason M. Bills { 2313f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2314e1f26343SJason M. Bills return; 2315e1f26343SJason M. Bills } 2316d405bb51SJason M. Bills asyncResp->res.jsonValue.update(bmcJournalLogEntry); 23177e860f15SJohn Edward Broadbent }); 2318c9bb6861Sraviteja-b } 2319c9bb6861Sraviteja-b 2320fdd26906SClaire Weinan inline void 2321fdd26906SClaire Weinan getDumpServiceInfo(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2322fdd26906SClaire Weinan const std::string& dumpType) 2323c9bb6861Sraviteja-b { 2324fdd26906SClaire Weinan std::string dumpPath; 2325fdd26906SClaire Weinan std::string overWritePolicy; 2326fdd26906SClaire Weinan bool collectDiagnosticDataSupported = false; 2327fdd26906SClaire Weinan 2328fdd26906SClaire Weinan if (dumpType == "BMC") 232945ca1b86SEd Tanous { 2330fdd26906SClaire Weinan dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump"; 2331fdd26906SClaire Weinan overWritePolicy = "WrapsWhenFull"; 2332fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2333fdd26906SClaire Weinan } 2334fdd26906SClaire Weinan else if (dumpType == "FaultLog") 2335fdd26906SClaire Weinan { 2336fdd26906SClaire Weinan dumpPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2337fdd26906SClaire Weinan overWritePolicy = "Unknown"; 2338fdd26906SClaire Weinan collectDiagnosticDataSupported = false; 2339fdd26906SClaire Weinan } 2340fdd26906SClaire Weinan else if (dumpType == "System") 2341fdd26906SClaire Weinan { 2342fdd26906SClaire Weinan dumpPath = "/redfish/v1/Systems/system/LogServices/Dump"; 2343fdd26906SClaire Weinan overWritePolicy = "WrapsWhenFull"; 2344fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2345fdd26906SClaire Weinan } 2346fdd26906SClaire Weinan else 2347fdd26906SClaire Weinan { 2348fdd26906SClaire Weinan BMCWEB_LOG_ERROR << "getDumpServiceInfo() invalid dump type: " 2349fdd26906SClaire Weinan << dumpType; 2350fdd26906SClaire Weinan messages::internalError(asyncResp->res); 235145ca1b86SEd Tanous return; 235245ca1b86SEd Tanous } 2353fdd26906SClaire Weinan 2354fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = dumpPath; 2355fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService"; 2356c9bb6861Sraviteja-b asyncResp->res.jsonValue["Name"] = "Dump LogService"; 2357fdd26906SClaire Weinan asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService"; 2358fdd26906SClaire Weinan asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename(); 2359fdd26906SClaire Weinan asyncResp->res.jsonValue["OverWritePolicy"] = std::move(overWritePolicy); 23607c8c4058STejas Patil 23617c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 23627c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 23630fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 23647c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 23657c8c4058STejas Patil redfishDateTimeOffset.second; 23667c8c4058STejas Patil 2367fdd26906SClaire Weinan asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries"; 2368002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 2369fdd26906SClaire Weinan dumpPath + "/Actions/LogService.ClearLog"; 2370fdd26906SClaire Weinan 2371fdd26906SClaire Weinan if (collectDiagnosticDataSupported) 2372fdd26906SClaire Weinan { 2373002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 23741476687dSEd Tanous ["target"] = 2375fdd26906SClaire Weinan dumpPath + "/Actions/LogService.CollectDiagnosticData"; 2376fdd26906SClaire Weinan } 2377c9bb6861Sraviteja-b } 2378c9bb6861Sraviteja-b 2379fdd26906SClaire Weinan inline void handleLogServicesDumpServiceGet( 2380fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2381fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 23827e860f15SJohn Edward Broadbent { 23833ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 238445ca1b86SEd Tanous { 238545ca1b86SEd Tanous return; 238645ca1b86SEd Tanous } 2387fdd26906SClaire Weinan getDumpServiceInfo(asyncResp, dumpType); 2388fdd26906SClaire Weinan } 2389c9bb6861Sraviteja-b 2390fdd26906SClaire Weinan inline void handleLogServicesDumpEntriesCollectionGet( 2391fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2392fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2393fdd26906SClaire Weinan { 2394fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2395fdd26906SClaire Weinan { 2396fdd26906SClaire Weinan return; 2397fdd26906SClaire Weinan } 2398fdd26906SClaire Weinan getDumpEntryCollection(asyncResp, dumpType); 2399fdd26906SClaire Weinan } 2400fdd26906SClaire Weinan 2401fdd26906SClaire Weinan inline void handleLogServicesDumpEntryGet( 2402fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2403fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2404fdd26906SClaire Weinan const std::string& dumpId) 2405fdd26906SClaire Weinan { 2406fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2407fdd26906SClaire Weinan { 2408fdd26906SClaire Weinan return; 2409fdd26906SClaire Weinan } 2410fdd26906SClaire Weinan getDumpEntryById(asyncResp, dumpId, dumpType); 2411fdd26906SClaire Weinan } 2412fdd26906SClaire Weinan 2413fdd26906SClaire Weinan inline void handleLogServicesDumpEntryDelete( 2414fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2415fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2416fdd26906SClaire Weinan const std::string& dumpId) 2417fdd26906SClaire Weinan { 2418fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2419fdd26906SClaire Weinan { 2420fdd26906SClaire Weinan return; 2421fdd26906SClaire Weinan } 2422fdd26906SClaire Weinan deleteDumpEntry(asyncResp, dumpId, dumpType); 2423fdd26906SClaire Weinan } 2424fdd26906SClaire Weinan 2425fdd26906SClaire Weinan inline void handleLogServicesDumpCollectDiagnosticDataPost( 2426fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2427fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2428fdd26906SClaire Weinan { 2429fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2430fdd26906SClaire Weinan { 2431fdd26906SClaire Weinan return; 2432fdd26906SClaire Weinan } 2433fdd26906SClaire Weinan createDump(asyncResp, req, dumpType); 2434fdd26906SClaire Weinan } 2435fdd26906SClaire Weinan 2436fdd26906SClaire Weinan inline void handleLogServicesDumpClearLogPost( 2437fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2438fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2439fdd26906SClaire Weinan { 2440fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2441fdd26906SClaire Weinan { 2442fdd26906SClaire Weinan return; 2443fdd26906SClaire Weinan } 2444fdd26906SClaire Weinan clearDump(asyncResp, dumpType); 2445fdd26906SClaire Weinan } 2446fdd26906SClaire Weinan 2447fdd26906SClaire Weinan inline void requestRoutesBMCDumpService(App& app) 2448fdd26906SClaire Weinan { 2449fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/") 2450fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 2451fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2452fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "BMC")); 2453fdd26906SClaire Weinan } 2454fdd26906SClaire Weinan 2455fdd26906SClaire Weinan inline void requestRoutesBMCDumpEntryCollection(App& app) 2456fdd26906SClaire Weinan { 2457fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/") 2458fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 2459fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2460fdd26906SClaire Weinan handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC")); 2461c9bb6861Sraviteja-b } 2462c9bb6861Sraviteja-b 24637e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app) 2464c9bb6861Sraviteja-b { 24657e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 24667e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2467ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 2468fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2469fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "BMC")); 2470fdd26906SClaire Weinan 24717e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 24727e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2473ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 2474fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 2475fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "BMC")); 2476c9bb6861Sraviteja-b } 2477c9bb6861Sraviteja-b 24787e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app) 2479c9bb6861Sraviteja-b { 24800fda0f12SGeorge Liu BMCWEB_ROUTE( 24810fda0f12SGeorge Liu app, 24820fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2483ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 24847e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 2485fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost, 2486fdd26906SClaire Weinan std::ref(app), "BMC")); 2487a43be80fSAsmitha Karunanithi } 2488a43be80fSAsmitha Karunanithi 24897e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app) 249080319af1SAsmitha Karunanithi { 24910fda0f12SGeorge Liu BMCWEB_ROUTE( 24920fda0f12SGeorge Liu app, 24930fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog/") 2494ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 2495fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 2496fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "BMC")); 249745ca1b86SEd Tanous } 2498fdd26906SClaire Weinan 2499fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpService(App& app) 2500fdd26906SClaire Weinan { 2501fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/") 2502fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 2503fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2504fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "FaultLog")); 2505fdd26906SClaire Weinan } 2506fdd26906SClaire Weinan 2507fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntryCollection(App& app) 2508fdd26906SClaire Weinan { 2509fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/") 2510fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 2511fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 2512fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpEntriesCollectionGet, 2513fdd26906SClaire Weinan std::ref(app), "FaultLog")); 2514fdd26906SClaire Weinan } 2515fdd26906SClaire Weinan 2516fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntry(App& app) 2517fdd26906SClaire Weinan { 2518fdd26906SClaire Weinan BMCWEB_ROUTE(app, 2519fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 2520fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntry) 2521fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2522fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "FaultLog")); 2523fdd26906SClaire Weinan 2524fdd26906SClaire Weinan BMCWEB_ROUTE(app, 2525fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 2526fdd26906SClaire Weinan .privileges(redfish::privileges::deleteLogEntry) 2527fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 2528fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog")); 2529fdd26906SClaire Weinan } 2530fdd26906SClaire Weinan 2531fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpClear(App& app) 2532fdd26906SClaire Weinan { 2533fdd26906SClaire Weinan BMCWEB_ROUTE( 2534fdd26906SClaire Weinan app, 2535fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog/") 2536fdd26906SClaire Weinan .privileges(redfish::privileges::postLogService) 2537fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 2538fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog")); 25395cb1dd27SAsmitha Karunanithi } 25405cb1dd27SAsmitha Karunanithi 25417e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app) 25425cb1dd27SAsmitha Karunanithi { 25437e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/") 2544ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 2545002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2546002d39b4SEd Tanous [&app](const crow::Request& req, 2547002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 25483ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 25497e860f15SJohn Edward Broadbent { 255045ca1b86SEd Tanous return; 255145ca1b86SEd Tanous } 25525cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.id"] = 25535cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump"; 25545cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 2555d337bb72SAsmitha Karunanithi "#LogService.v1_2_0.LogService"; 25565cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = "Dump LogService"; 255745ca1b86SEd Tanous asyncResp->res.jsonValue["Description"] = "System Dump LogService"; 25585cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = "Dump"; 25595cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 25607c8c4058STejas Patil 25617c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 25627c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 256345ca1b86SEd Tanous asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 25647c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 25657c8c4058STejas Patil redfishDateTimeOffset.second; 25667c8c4058STejas Patil 25671476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 25681476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Dump/Entries"; 2569002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 25701476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog"; 25711476687dSEd Tanous 2572002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 25731476687dSEd Tanous ["target"] = 25741476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData"; 25757e860f15SJohn Edward Broadbent }); 25765cb1dd27SAsmitha Karunanithi } 25775cb1dd27SAsmitha Karunanithi 25787e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app) 25797e860f15SJohn Edward Broadbent { 25807e860f15SJohn Edward Broadbent 25815cb1dd27SAsmitha Karunanithi /** 25825cb1dd27SAsmitha Karunanithi * Functions triggers appropriate requests on DBus 25835cb1dd27SAsmitha Karunanithi */ 2584b2a3289dSAsmitha Karunanithi BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/") 2585ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 25867e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 258745ca1b86SEd Tanous [&app](const crow::Request& req, 2588864d6a17SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 25893ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 259045ca1b86SEd Tanous { 259145ca1b86SEd Tanous return; 259245ca1b86SEd Tanous } 25935cb1dd27SAsmitha Karunanithi getDumpEntryCollection(asyncResp, "System"); 25947e860f15SJohn Edward Broadbent }); 25955cb1dd27SAsmitha Karunanithi } 25965cb1dd27SAsmitha Karunanithi 25977e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app) 25985cb1dd27SAsmitha Karunanithi { 25997e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 2600864d6a17SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/") 2601ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 2602ed398213SEd Tanous 26037e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 260445ca1b86SEd Tanous [&app](const crow::Request& req, 26057e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 26067e860f15SJohn Edward Broadbent const std::string& param) { 26073ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2608c7a6d660SClaire Weinan { 2609c7a6d660SClaire Weinan return; 2610c7a6d660SClaire Weinan } 2611c7a6d660SClaire Weinan getDumpEntryById(asyncResp, param, "System"); 26127e860f15SJohn Edward Broadbent }); 26138d1b46d7Szhanghch05 26147e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 2615864d6a17SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/") 2616ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 26177e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::delete_)( 261845ca1b86SEd Tanous [&app](const crow::Request& req, 26197e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 26207e860f15SJohn Edward Broadbent const std::string& param) { 26213ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 262245ca1b86SEd Tanous { 262345ca1b86SEd Tanous return; 262445ca1b86SEd Tanous } 26257e860f15SJohn Edward Broadbent deleteDumpEntry(asyncResp, param, "system"); 26267e860f15SJohn Edward Broadbent }); 26275cb1dd27SAsmitha Karunanithi } 2628c9bb6861Sraviteja-b 26297e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app) 2630c9bb6861Sraviteja-b { 26310fda0f12SGeorge Liu BMCWEB_ROUTE( 26320fda0f12SGeorge Liu app, 26330fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2634ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 26357e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 263645ca1b86SEd Tanous [&app](const crow::Request& req, 263745ca1b86SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 26383ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 263945ca1b86SEd Tanous { 264045ca1b86SEd Tanous return; 264145ca1b86SEd Tanous } 264245ca1b86SEd Tanous createDump(asyncResp, req, "System"); 264345ca1b86SEd Tanous }); 2644a43be80fSAsmitha Karunanithi } 2645a43be80fSAsmitha Karunanithi 26467e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app) 2647a43be80fSAsmitha Karunanithi { 26480fda0f12SGeorge Liu BMCWEB_ROUTE( 26490fda0f12SGeorge Liu app, 26500fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog/") 2651ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 26527e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 265345ca1b86SEd Tanous [&app](const crow::Request& req, 26547e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 26557e860f15SJohn Edward Broadbent 265645ca1b86SEd Tanous { 26573ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 265845ca1b86SEd Tanous { 265945ca1b86SEd Tanous return; 266045ca1b86SEd Tanous } 266145ca1b86SEd Tanous clearDump(asyncResp, "System"); 266245ca1b86SEd Tanous }); 2663013487e5Sraviteja-b } 2664013487e5Sraviteja-b 26657e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app) 26661da66f75SEd Tanous { 26673946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 26683946028dSAppaRao Puli // method for security reasons. 26691da66f75SEd Tanous /** 26701da66f75SEd Tanous * Functions triggers appropriate requests on DBus 26711da66f75SEd Tanous */ 26727e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Crashdump/") 2673ed398213SEd Tanous // This is incorrect, should be: 2674ed398213SEd Tanous //.privileges(redfish::privileges::getLogService) 2675432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 2676002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2677002d39b4SEd Tanous [&app](const crow::Request& req, 2678002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 26793ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 268045ca1b86SEd Tanous { 268145ca1b86SEd Tanous return; 268245ca1b86SEd Tanous } 26837e860f15SJohn Edward Broadbent // Copy over the static data to include the entries added by 26847e860f15SJohn Edward Broadbent // SubRoute 26850f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2686424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"; 2687e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 26888e6c099aSJason M. Bills "#LogService.v1_2_0.LogService"; 26894f50ae4bSGunnar Mills asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service"; 26904f50ae4bSGunnar Mills asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service"; 26914f50ae4bSGunnar Mills asyncResp->res.jsonValue["Id"] = "Oem Crashdump"; 2692e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 2693e1f26343SJason M. Bills asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; 26947c8c4058STejas Patil 26957c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 26967c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 26977c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 26987c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 26997c8c4058STejas Patil redfishDateTimeOffset.second; 27007c8c4058STejas Patil 27011476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 27021476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 2703002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 27041476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog"; 2705002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 27061476687dSEd Tanous ["target"] = 27071476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData"; 27087e860f15SJohn Edward Broadbent }); 27091da66f75SEd Tanous } 27101da66f75SEd Tanous 27117e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app) 27125b61b5e8SJason M. Bills { 27130fda0f12SGeorge Liu BMCWEB_ROUTE( 27140fda0f12SGeorge Liu app, 27150fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog/") 2716ed398213SEd Tanous // This is incorrect, should be: 2717ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 2718432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 27197e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 272045ca1b86SEd Tanous [&app](const crow::Request& req, 27217e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 27223ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 272345ca1b86SEd Tanous { 272445ca1b86SEd Tanous return; 272545ca1b86SEd Tanous } 27265b61b5e8SJason M. Bills crow::connections::systemBus->async_method_call( 27275b61b5e8SJason M. Bills [asyncResp](const boost::system::error_code ec, 2728cb13a392SEd Tanous const std::string&) { 27295b61b5e8SJason M. Bills if (ec) 27305b61b5e8SJason M. Bills { 27315b61b5e8SJason M. Bills messages::internalError(asyncResp->res); 27325b61b5e8SJason M. Bills return; 27335b61b5e8SJason M. Bills } 27345b61b5e8SJason M. Bills messages::success(asyncResp->res); 27355b61b5e8SJason M. Bills }, 2736002d39b4SEd Tanous crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll"); 27377e860f15SJohn Edward Broadbent }); 27385b61b5e8SJason M. Bills } 27395b61b5e8SJason M. Bills 27408d1b46d7Szhanghch05 static void 27418d1b46d7Szhanghch05 logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 27428d1b46d7Szhanghch05 const std::string& logID, nlohmann::json& logEntryJson) 2743e855dd28SJason M. Bills { 2744043a0536SJohnathan Mantey auto getStoredLogCallback = 2745b9d36b47SEd Tanous [asyncResp, logID, 2746b9d36b47SEd Tanous &logEntryJson](const boost::system::error_code ec, 2747b9d36b47SEd Tanous const dbus::utility::DBusPropertiesMap& params) { 2748e855dd28SJason M. Bills if (ec) 2749e855dd28SJason M. Bills { 2750e855dd28SJason M. Bills BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 27511ddcf01aSJason M. Bills if (ec.value() == 27521ddcf01aSJason M. Bills boost::system::linux_error::bad_request_descriptor) 27531ddcf01aSJason M. Bills { 2754002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 27551ddcf01aSJason M. Bills } 27561ddcf01aSJason M. Bills else 27571ddcf01aSJason M. Bills { 2758e855dd28SJason M. Bills messages::internalError(asyncResp->res); 27591ddcf01aSJason M. Bills } 2760e855dd28SJason M. Bills return; 2761e855dd28SJason M. Bills } 2762043a0536SJohnathan Mantey 2763043a0536SJohnathan Mantey std::string timestamp{}; 2764043a0536SJohnathan Mantey std::string filename{}; 2765043a0536SJohnathan Mantey std::string logfile{}; 27662c70f800SEd Tanous parseCrashdumpParameters(params, filename, timestamp, logfile); 2767043a0536SJohnathan Mantey 2768043a0536SJohnathan Mantey if (filename.empty() || timestamp.empty()) 2769e855dd28SJason M. Bills { 2770002d39b4SEd Tanous messages::resourceMissingAtURI(asyncResp->res, 2771002d39b4SEd Tanous crow::utility::urlFromPieces(logID)); 2772e855dd28SJason M. Bills return; 2773e855dd28SJason M. Bills } 2774e855dd28SJason M. Bills 2775043a0536SJohnathan Mantey std::string crashdumpURI = 2776e855dd28SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + 2777043a0536SJohnathan Mantey logID + "/" + filename; 2778*84afc48bSJason M. Bills nlohmann::json::object_t logEntry; 2779*84afc48bSJason M. Bills logEntry["@odata.type"] = "#LogEntry.v1_7_0.LogEntry"; 2780*84afc48bSJason M. Bills logEntry["@odata.id"] = 2781*84afc48bSJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + logID; 2782*84afc48bSJason M. Bills logEntry["Name"] = "CPU Crashdump"; 2783*84afc48bSJason M. Bills logEntry["Id"] = logID; 2784*84afc48bSJason M. Bills logEntry["EntryType"] = "Oem"; 2785*84afc48bSJason M. Bills logEntry["AdditionalDataURI"] = std::move(crashdumpURI); 2786*84afc48bSJason M. Bills logEntry["DiagnosticDataType"] = "OEM"; 2787*84afc48bSJason M. Bills logEntry["OEMDiagnosticDataType"] = "PECICrashdump"; 2788*84afc48bSJason M. Bills logEntry["Created"] = std::move(timestamp); 27892b20ef6eSJason M. Bills 27902b20ef6eSJason M. Bills // If logEntryJson references an array of LogEntry resources 27912b20ef6eSJason M. Bills // ('Members' list), then push this as a new entry, otherwise set it 27922b20ef6eSJason M. Bills // directly 27932b20ef6eSJason M. Bills if (logEntryJson.is_array()) 27942b20ef6eSJason M. Bills { 27952b20ef6eSJason M. Bills logEntryJson.push_back(logEntry); 27962b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 27972b20ef6eSJason M. Bills logEntryJson.size(); 27982b20ef6eSJason M. Bills } 27992b20ef6eSJason M. Bills else 28002b20ef6eSJason M. Bills { 2801d405bb51SJason M. Bills logEntryJson.update(logEntry); 28022b20ef6eSJason M. Bills } 2803e855dd28SJason M. Bills }; 2804e855dd28SJason M. Bills crow::connections::systemBus->async_method_call( 28055b61b5e8SJason M. Bills std::move(getStoredLogCallback), crashdumpObject, 28065b61b5e8SJason M. Bills crashdumpPath + std::string("/") + logID, 2807043a0536SJohnathan Mantey "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface); 2808e855dd28SJason M. Bills } 2809e855dd28SJason M. Bills 28107e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app) 28111da66f75SEd Tanous { 28123946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 28133946028dSAppaRao Puli // method for security reasons. 28141da66f75SEd Tanous /** 28151da66f75SEd Tanous * Functions triggers appropriate requests on DBus 28161da66f75SEd Tanous */ 28177e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 28187e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/") 2819ed398213SEd Tanous // This is incorrect, should be. 2820ed398213SEd Tanous //.privileges(redfish::privileges::postLogEntryCollection) 2821432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 2822002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2823002d39b4SEd Tanous [&app](const crow::Request& req, 2824002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 28253ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 282645ca1b86SEd Tanous { 282745ca1b86SEd Tanous return; 282845ca1b86SEd Tanous } 28292b20ef6eSJason M. Bills crow::connections::systemBus->async_method_call( 28302b20ef6eSJason M. Bills [asyncResp](const boost::system::error_code ec, 28312b20ef6eSJason M. Bills const std::vector<std::string>& resp) { 28321da66f75SEd Tanous if (ec) 28331da66f75SEd Tanous { 28341da66f75SEd Tanous if (ec.value() != 28351da66f75SEd Tanous boost::system::errc::no_such_file_or_directory) 28361da66f75SEd Tanous { 28371da66f75SEd Tanous BMCWEB_LOG_DEBUG << "failed to get entries ec: " 28381da66f75SEd Tanous << ec.message(); 2839f12894f8SJason M. Bills messages::internalError(asyncResp->res); 28401da66f75SEd Tanous return; 28411da66f75SEd Tanous } 28421da66f75SEd Tanous } 2843e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 28441da66f75SEd Tanous "#LogEntryCollection.LogEntryCollection"; 28450f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2846424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 2847002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries"; 2848e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2849424c4176SJason M. Bills "Collection of Crashdump Entries"; 2850002d39b4SEd Tanous asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 2851a2dd60a6SBrandon Kim asyncResp->res.jsonValue["Members@odata.count"] = 0; 28522b20ef6eSJason M. Bills 28532b20ef6eSJason M. Bills for (const std::string& path : resp) 28541da66f75SEd Tanous { 28552b20ef6eSJason M. Bills const sdbusplus::message::object_path objPath(path); 2856e855dd28SJason M. Bills // Get the log ID 28572b20ef6eSJason M. Bills std::string logID = objPath.filename(); 28582b20ef6eSJason M. Bills if (logID.empty()) 28591da66f75SEd Tanous { 2860e855dd28SJason M. Bills continue; 28611da66f75SEd Tanous } 2862e855dd28SJason M. Bills // Add the log entry to the array 28632b20ef6eSJason M. Bills logCrashdumpEntry(asyncResp, logID, 28642b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members"]); 28651da66f75SEd Tanous } 28662b20ef6eSJason M. Bills }, 28671da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", 28681da66f75SEd Tanous "/xyz/openbmc_project/object_mapper", 28691da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0, 28705b61b5e8SJason M. Bills std::array<const char*, 1>{crashdumpInterface}); 28717e860f15SJohn Edward Broadbent }); 28721da66f75SEd Tanous } 28731da66f75SEd Tanous 28747e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app) 28751da66f75SEd Tanous { 28763946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 28773946028dSAppaRao Puli // method for security reasons. 28781da66f75SEd Tanous 28797e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 28807e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/") 2881ed398213SEd Tanous // this is incorrect, should be 2882ed398213SEd Tanous // .privileges(redfish::privileges::getLogEntry) 2883432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 28847e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 288545ca1b86SEd Tanous [&app](const crow::Request& req, 28867e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 28877e860f15SJohn Edward Broadbent const std::string& param) { 28883ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 288945ca1b86SEd Tanous { 289045ca1b86SEd Tanous return; 289145ca1b86SEd Tanous } 28927e860f15SJohn Edward Broadbent const std::string& logID = param; 2893e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue); 28947e860f15SJohn Edward Broadbent }); 2895e855dd28SJason M. Bills } 2896e855dd28SJason M. Bills 28977e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app) 2898e855dd28SJason M. Bills { 28993946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 29003946028dSAppaRao Puli // method for security reasons. 29017e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 29027e860f15SJohn Edward Broadbent app, 29037e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/<str>/") 2904ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 29057e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 290645ca1b86SEd Tanous [&app](const crow::Request& req, 29077e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 29087e860f15SJohn Edward Broadbent const std::string& logID, const std::string& fileName) { 29093ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 291045ca1b86SEd Tanous { 291145ca1b86SEd Tanous return; 291245ca1b86SEd Tanous } 2913043a0536SJohnathan Mantey auto getStoredLogCallback = 2914002d39b4SEd Tanous [asyncResp, logID, fileName, url(boost::urls::url(req.urlView))]( 2915abf2add6SEd Tanous const boost::system::error_code ec, 2916002d39b4SEd Tanous const std::vector< 2917002d39b4SEd Tanous std::pair<std::string, dbus::utility::DbusVariantType>>& 29187e860f15SJohn Edward Broadbent resp) { 29191da66f75SEd Tanous if (ec) 29201da66f75SEd Tanous { 2921002d39b4SEd Tanous BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 2922f12894f8SJason M. Bills messages::internalError(asyncResp->res); 29231da66f75SEd Tanous return; 29241da66f75SEd Tanous } 2925e855dd28SJason M. Bills 2926043a0536SJohnathan Mantey std::string dbusFilename{}; 2927043a0536SJohnathan Mantey std::string dbusTimestamp{}; 2928043a0536SJohnathan Mantey std::string dbusFilepath{}; 2929043a0536SJohnathan Mantey 2930002d39b4SEd Tanous parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp, 2931002d39b4SEd Tanous dbusFilepath); 2932043a0536SJohnathan Mantey 2933043a0536SJohnathan Mantey if (dbusFilename.empty() || dbusTimestamp.empty() || 2934043a0536SJohnathan Mantey dbusFilepath.empty()) 29351da66f75SEd Tanous { 2936ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, url); 29371da66f75SEd Tanous return; 29381da66f75SEd Tanous } 2939e855dd28SJason M. Bills 2940043a0536SJohnathan Mantey // Verify the file name parameter is correct 2941043a0536SJohnathan Mantey if (fileName != dbusFilename) 2942043a0536SJohnathan Mantey { 2943ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, url); 2944043a0536SJohnathan Mantey return; 2945043a0536SJohnathan Mantey } 2946043a0536SJohnathan Mantey 2947043a0536SJohnathan Mantey if (!std::filesystem::exists(dbusFilepath)) 2948043a0536SJohnathan Mantey { 2949ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, url); 2950043a0536SJohnathan Mantey return; 2951043a0536SJohnathan Mantey } 2952002d39b4SEd Tanous std::ifstream ifs(dbusFilepath, std::ios::in | std::ios::binary); 2953002d39b4SEd Tanous asyncResp->res.body() = 2954002d39b4SEd Tanous std::string(std::istreambuf_iterator<char>{ifs}, {}); 2955043a0536SJohnathan Mantey 29567e860f15SJohn Edward Broadbent // Configure this to be a file download when accessed 29577e860f15SJohn Edward Broadbent // from a browser 2958002d39b4SEd Tanous asyncResp->res.addHeader("Content-Disposition", "attachment"); 29591da66f75SEd Tanous }; 29601da66f75SEd Tanous crow::connections::systemBus->async_method_call( 29615b61b5e8SJason M. Bills std::move(getStoredLogCallback), crashdumpObject, 29625b61b5e8SJason M. Bills crashdumpPath + std::string("/") + logID, 2963002d39b4SEd Tanous "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface); 29647e860f15SJohn Edward Broadbent }); 29651da66f75SEd Tanous } 29661da66f75SEd Tanous 2967c5a4c82aSJason M. Bills enum class OEMDiagnosticType 2968c5a4c82aSJason M. Bills { 2969c5a4c82aSJason M. Bills onDemand, 2970c5a4c82aSJason M. Bills telemetry, 2971c5a4c82aSJason M. Bills invalid, 2972c5a4c82aSJason M. Bills }; 2973c5a4c82aSJason M. Bills 2974f7725d79SEd Tanous inline OEMDiagnosticType 2975f7725d79SEd Tanous getOEMDiagnosticType(const std::string_view& oemDiagStr) 2976c5a4c82aSJason M. Bills { 2977c5a4c82aSJason M. Bills if (oemDiagStr == "OnDemand") 2978c5a4c82aSJason M. Bills { 2979c5a4c82aSJason M. Bills return OEMDiagnosticType::onDemand; 2980c5a4c82aSJason M. Bills } 2981c5a4c82aSJason M. Bills if (oemDiagStr == "Telemetry") 2982c5a4c82aSJason M. Bills { 2983c5a4c82aSJason M. Bills return OEMDiagnosticType::telemetry; 2984c5a4c82aSJason M. Bills } 2985c5a4c82aSJason M. Bills 2986c5a4c82aSJason M. Bills return OEMDiagnosticType::invalid; 2987c5a4c82aSJason M. Bills } 2988c5a4c82aSJason M. Bills 29897e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app) 29901da66f75SEd Tanous { 29913946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 29923946028dSAppaRao Puli // method for security reasons. 29930fda0f12SGeorge Liu BMCWEB_ROUTE( 29940fda0f12SGeorge Liu app, 29950fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/") 2996ed398213SEd Tanous // The below is incorrect; Should be ConfigureManager 2997ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 2998432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 2999002d39b4SEd Tanous .methods(boost::beast::http::verb::post)( 3000002d39b4SEd Tanous [&app](const crow::Request& req, 30017e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 30023ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 300345ca1b86SEd Tanous { 300445ca1b86SEd Tanous return; 300545ca1b86SEd Tanous } 30068e6c099aSJason M. Bills std::string diagnosticDataType; 30078e6c099aSJason M. Bills std::string oemDiagnosticDataType; 300815ed6780SWilly Tu if (!redfish::json_util::readJsonAction( 3009002d39b4SEd Tanous req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 3010002d39b4SEd Tanous "OEMDiagnosticDataType", oemDiagnosticDataType)) 30118e6c099aSJason M. Bills { 30128e6c099aSJason M. Bills return; 30138e6c099aSJason M. Bills } 30148e6c099aSJason M. Bills 30158e6c099aSJason M. Bills if (diagnosticDataType != "OEM") 30168e6c099aSJason M. Bills { 30178e6c099aSJason M. Bills BMCWEB_LOG_ERROR 30188e6c099aSJason M. Bills << "Only OEM DiagnosticDataType supported for Crashdump"; 30198e6c099aSJason M. Bills messages::actionParameterValueFormatError( 30208e6c099aSJason M. Bills asyncResp->res, diagnosticDataType, "DiagnosticDataType", 30218e6c099aSJason M. Bills "CollectDiagnosticData"); 30228e6c099aSJason M. Bills return; 30238e6c099aSJason M. Bills } 30248e6c099aSJason M. Bills 3025c5a4c82aSJason M. Bills OEMDiagnosticType oemDiagType = 3026c5a4c82aSJason M. Bills getOEMDiagnosticType(oemDiagnosticDataType); 3027c5a4c82aSJason M. Bills 3028c5a4c82aSJason M. Bills std::string iface; 3029c5a4c82aSJason M. Bills std::string method; 3030c5a4c82aSJason M. Bills std::string taskMatchStr; 3031c5a4c82aSJason M. Bills if (oemDiagType == OEMDiagnosticType::onDemand) 3032c5a4c82aSJason M. Bills { 3033c5a4c82aSJason M. Bills iface = crashdumpOnDemandInterface; 3034c5a4c82aSJason M. Bills method = "GenerateOnDemandLog"; 3035c5a4c82aSJason M. Bills taskMatchStr = "type='signal'," 3036c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 3037c5a4c82aSJason M. Bills "member='PropertiesChanged'," 3038c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 3039c5a4c82aSJason M. Bills } 3040c5a4c82aSJason M. Bills else if (oemDiagType == OEMDiagnosticType::telemetry) 3041c5a4c82aSJason M. Bills { 3042c5a4c82aSJason M. Bills iface = crashdumpTelemetryInterface; 3043c5a4c82aSJason M. Bills method = "GenerateTelemetryLog"; 3044c5a4c82aSJason M. Bills taskMatchStr = "type='signal'," 3045c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 3046c5a4c82aSJason M. Bills "member='PropertiesChanged'," 3047c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 3048c5a4c82aSJason M. Bills } 3049c5a4c82aSJason M. Bills else 3050c5a4c82aSJason M. Bills { 3051c5a4c82aSJason M. Bills BMCWEB_LOG_ERROR << "Unsupported OEMDiagnosticDataType: " 3052c5a4c82aSJason M. Bills << oemDiagnosticDataType; 3053c5a4c82aSJason M. Bills messages::actionParameterValueFormatError( 3054002d39b4SEd Tanous asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType", 3055002d39b4SEd Tanous "CollectDiagnosticData"); 3056c5a4c82aSJason M. Bills return; 3057c5a4c82aSJason M. Bills } 3058c5a4c82aSJason M. Bills 3059c5a4c82aSJason M. Bills auto collectCrashdumpCallback = 3060c5a4c82aSJason M. Bills [asyncResp, payload(task::Payload(req)), 3061c5a4c82aSJason M. Bills taskMatchStr](const boost::system::error_code ec, 306298be3e39SEd Tanous const std::string&) mutable { 30631da66f75SEd Tanous if (ec) 30641da66f75SEd Tanous { 3065002d39b4SEd Tanous if (ec.value() == boost::system::errc::operation_not_supported) 30661da66f75SEd Tanous { 3067f12894f8SJason M. Bills messages::resourceInStandby(asyncResp->res); 30681da66f75SEd Tanous } 30694363d3b2SJason M. Bills else if (ec.value() == 30704363d3b2SJason M. Bills boost::system::errc::device_or_resource_busy) 30714363d3b2SJason M. Bills { 3072002d39b4SEd Tanous messages::serviceTemporarilyUnavailable(asyncResp->res, 3073002d39b4SEd Tanous "60"); 30744363d3b2SJason M. Bills } 30751da66f75SEd Tanous else 30761da66f75SEd Tanous { 3077f12894f8SJason M. Bills messages::internalError(asyncResp->res); 30781da66f75SEd Tanous } 30791da66f75SEd Tanous return; 30801da66f75SEd Tanous } 3081002d39b4SEd Tanous std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 3082002d39b4SEd Tanous [](boost::system::error_code err, sdbusplus::message::message&, 3083002d39b4SEd Tanous const std::shared_ptr<task::TaskData>& taskData) { 308466afe4faSJames Feist if (!err) 308566afe4faSJames Feist { 3086002d39b4SEd Tanous taskData->messages.emplace_back(messages::taskCompletedOK( 3087e5d5006bSJames Feist std::to_string(taskData->index))); 3088831d6b09SJames Feist taskData->state = "Completed"; 308966afe4faSJames Feist } 309032898ceaSJames Feist return task::completed; 309166afe4faSJames Feist }, 3092c5a4c82aSJason M. Bills taskMatchStr); 3093c5a4c82aSJason M. Bills 309446229577SJames Feist task->startTimer(std::chrono::minutes(5)); 309546229577SJames Feist task->populateResp(asyncResp->res); 309698be3e39SEd Tanous task->payload.emplace(std::move(payload)); 30971da66f75SEd Tanous }; 30988e6c099aSJason M. Bills 30991da66f75SEd Tanous crow::connections::systemBus->async_method_call( 3100002d39b4SEd Tanous std::move(collectCrashdumpCallback), crashdumpObject, crashdumpPath, 3101002d39b4SEd Tanous iface, method); 31027e860f15SJohn Edward Broadbent }); 31036eda7685SKenny L. Ku } 31046eda7685SKenny L. Ku 3105cb92c03bSAndrew Geissler /** 3106cb92c03bSAndrew Geissler * DBusLogServiceActionsClear class supports POST method for ClearLog action. 3107cb92c03bSAndrew Geissler */ 31087e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app) 3109cb92c03bSAndrew Geissler { 3110cb92c03bSAndrew Geissler /** 3111cb92c03bSAndrew Geissler * Function handles POST method request. 3112cb92c03bSAndrew Geissler * The Clear Log actions does not require any parameter.The action deletes 3113cb92c03bSAndrew Geissler * all entries found in the Entries collection for this Log Service. 3114cb92c03bSAndrew Geissler */ 31157e860f15SJohn Edward Broadbent 31160fda0f12SGeorge Liu BMCWEB_ROUTE( 31170fda0f12SGeorge Liu app, 31180fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog/") 3119ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 31207e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 312145ca1b86SEd Tanous [&app](const crow::Request& req, 31227e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 31233ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 312445ca1b86SEd Tanous { 312545ca1b86SEd Tanous return; 312645ca1b86SEd Tanous } 3127cb92c03bSAndrew Geissler BMCWEB_LOG_DEBUG << "Do delete all entries."; 3128cb92c03bSAndrew Geissler 3129cb92c03bSAndrew Geissler // Process response from Logging service. 3130002d39b4SEd Tanous auto respHandler = [asyncResp](const boost::system::error_code ec) { 3131002d39b4SEd Tanous BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done"; 3132cb92c03bSAndrew Geissler if (ec) 3133cb92c03bSAndrew Geissler { 3134cb92c03bSAndrew Geissler // TODO Handle for specific error code 3135002d39b4SEd Tanous BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec; 3136cb92c03bSAndrew Geissler asyncResp->res.result( 3137cb92c03bSAndrew Geissler boost::beast::http::status::internal_server_error); 3138cb92c03bSAndrew Geissler return; 3139cb92c03bSAndrew Geissler } 3140cb92c03bSAndrew Geissler 3141002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::no_content); 3142cb92c03bSAndrew Geissler }; 3143cb92c03bSAndrew Geissler 3144cb92c03bSAndrew Geissler // Make call to Logging service to request Clear Log 3145cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 31462c70f800SEd Tanous respHandler, "xyz.openbmc_project.Logging", 3147cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging", 3148cb92c03bSAndrew Geissler "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 31497e860f15SJohn Edward Broadbent }); 3150cb92c03bSAndrew Geissler } 3151a3316fc6SZhikuiRen 3152a3316fc6SZhikuiRen /**************************************************** 3153a3316fc6SZhikuiRen * Redfish PostCode interfaces 3154a3316fc6SZhikuiRen * using DBUS interface: getPostCodesTS 3155a3316fc6SZhikuiRen ******************************************************/ 31567e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesLogService(App& app) 3157a3316fc6SZhikuiRen { 31587e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/PostCodes/") 3159ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 3160002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 3161002d39b4SEd Tanous [&app](const crow::Request& req, 3162002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 31633ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 316445ca1b86SEd Tanous { 316545ca1b86SEd Tanous return; 316645ca1b86SEd Tanous } 31671476687dSEd Tanous 31681476687dSEd Tanous asyncResp->res.jsonValue["@odata.id"] = 31691476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes"; 31701476687dSEd Tanous asyncResp->res.jsonValue["@odata.type"] = 31711476687dSEd Tanous "#LogService.v1_1_0.LogService"; 31721476687dSEd Tanous asyncResp->res.jsonValue["Name"] = "POST Code Log Service"; 31731476687dSEd Tanous asyncResp->res.jsonValue["Description"] = "POST Code Log Service"; 31741476687dSEd Tanous asyncResp->res.jsonValue["Id"] = "BIOS POST Code Log"; 31751476687dSEd Tanous asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 31761476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 31771476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 31787c8c4058STejas Patil 31797c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 31807c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 31810fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 31827c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 31837c8c4058STejas Patil redfishDateTimeOffset.second; 31847c8c4058STejas Patil 3185a3316fc6SZhikuiRen asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 31867e860f15SJohn Edward Broadbent {"target", 31870fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog"}}; 31887e860f15SJohn Edward Broadbent }); 3189a3316fc6SZhikuiRen } 3190a3316fc6SZhikuiRen 31917e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesClear(App& app) 3192a3316fc6SZhikuiRen { 31930fda0f12SGeorge Liu BMCWEB_ROUTE( 31940fda0f12SGeorge Liu app, 31950fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog/") 3196ed398213SEd Tanous // The following privilege is incorrect; It should be ConfigureManager 3197ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3198432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 31997e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 320045ca1b86SEd Tanous [&app](const crow::Request& req, 32017e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 32023ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 320345ca1b86SEd Tanous { 320445ca1b86SEd Tanous return; 320545ca1b86SEd Tanous } 3206a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Do delete all postcodes entries."; 3207a3316fc6SZhikuiRen 3208a3316fc6SZhikuiRen // Make call to post-code service to request clear all 3209a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3210a3316fc6SZhikuiRen [asyncResp](const boost::system::error_code ec) { 3211a3316fc6SZhikuiRen if (ec) 3212a3316fc6SZhikuiRen { 3213a3316fc6SZhikuiRen // TODO Handle for specific error code 3214002d39b4SEd Tanous BMCWEB_LOG_ERROR << "doClearPostCodes resp_handler got error " 32157e860f15SJohn Edward Broadbent << ec; 3216002d39b4SEd Tanous asyncResp->res.result( 3217002d39b4SEd Tanous boost::beast::http::status::internal_server_error); 3218a3316fc6SZhikuiRen messages::internalError(asyncResp->res); 3219a3316fc6SZhikuiRen return; 3220a3316fc6SZhikuiRen } 3221a3316fc6SZhikuiRen }, 322215124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 322315124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3224a3316fc6SZhikuiRen "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 32257e860f15SJohn Edward Broadbent }); 3226a3316fc6SZhikuiRen } 3227a3316fc6SZhikuiRen 3228a3316fc6SZhikuiRen static void fillPostCodeEntry( 32298d1b46d7Szhanghch05 const std::shared_ptr<bmcweb::AsyncResp>& aResp, 32306c9a279eSManojkiran Eda const boost::container::flat_map< 32316c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode, 3232a3316fc6SZhikuiRen const uint16_t bootIndex, const uint64_t codeIndex = 0, 3233a3316fc6SZhikuiRen const uint64_t skip = 0, const uint64_t top = 0) 3234a3316fc6SZhikuiRen { 3235a3316fc6SZhikuiRen // Get the Message from the MessageRegistry 3236fffb8c1fSEd Tanous const registries::Message* message = 3237fffb8c1fSEd Tanous registries::getMessage("OpenBMC.0.2.BIOSPOSTCode"); 3238a3316fc6SZhikuiRen 3239a3316fc6SZhikuiRen uint64_t currentCodeIndex = 0; 3240a3316fc6SZhikuiRen nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"]; 3241a3316fc6SZhikuiRen 3242a3316fc6SZhikuiRen uint64_t firstCodeTimeUs = 0; 32436c9a279eSManojkiran Eda for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 32446c9a279eSManojkiran Eda code : postcode) 3245a3316fc6SZhikuiRen { 3246a3316fc6SZhikuiRen currentCodeIndex++; 3247a3316fc6SZhikuiRen std::string postcodeEntryID = 3248a3316fc6SZhikuiRen "B" + std::to_string(bootIndex) + "-" + 3249a3316fc6SZhikuiRen std::to_string(currentCodeIndex); // 1 based index in EntryID string 3250a3316fc6SZhikuiRen 3251a3316fc6SZhikuiRen uint64_t usecSinceEpoch = code.first; 3252a3316fc6SZhikuiRen uint64_t usTimeOffset = 0; 3253a3316fc6SZhikuiRen 3254a3316fc6SZhikuiRen if (1 == currentCodeIndex) 3255a3316fc6SZhikuiRen { // already incremented 3256a3316fc6SZhikuiRen firstCodeTimeUs = code.first; 3257a3316fc6SZhikuiRen } 3258a3316fc6SZhikuiRen else 3259a3316fc6SZhikuiRen { 3260a3316fc6SZhikuiRen usTimeOffset = code.first - firstCodeTimeUs; 3261a3316fc6SZhikuiRen } 3262a3316fc6SZhikuiRen 3263a3316fc6SZhikuiRen // skip if no specific codeIndex is specified and currentCodeIndex does 3264a3316fc6SZhikuiRen // not fall between top and skip 3265a3316fc6SZhikuiRen if ((codeIndex == 0) && 3266a3316fc6SZhikuiRen (currentCodeIndex <= skip || currentCodeIndex > top)) 3267a3316fc6SZhikuiRen { 3268a3316fc6SZhikuiRen continue; 3269a3316fc6SZhikuiRen } 3270a3316fc6SZhikuiRen 32714e0453b1SGunnar Mills // skip if a specific codeIndex is specified and does not match the 3272a3316fc6SZhikuiRen // currentIndex 3273a3316fc6SZhikuiRen if ((codeIndex > 0) && (currentCodeIndex != codeIndex)) 3274a3316fc6SZhikuiRen { 3275a3316fc6SZhikuiRen // This is done for simplicity. 1st entry is needed to calculate 3276a3316fc6SZhikuiRen // time offset. To improve efficiency, one can get to the entry 3277a3316fc6SZhikuiRen // directly (possibly with flatmap's nth method) 3278a3316fc6SZhikuiRen continue; 3279a3316fc6SZhikuiRen } 3280a3316fc6SZhikuiRen 3281a3316fc6SZhikuiRen // currentCodeIndex is within top and skip or equal to specified code 3282a3316fc6SZhikuiRen // index 3283a3316fc6SZhikuiRen 3284a3316fc6SZhikuiRen // Get the Created time from the timestamp 3285a3316fc6SZhikuiRen std::string entryTimeStr; 32861d8782e7SNan Zhou entryTimeStr = 32871d8782e7SNan Zhou crow::utility::getDateTimeUint(usecSinceEpoch / 1000 / 1000); 3288a3316fc6SZhikuiRen 3289a3316fc6SZhikuiRen // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex) 3290a3316fc6SZhikuiRen std::ostringstream hexCode; 3291a3316fc6SZhikuiRen hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex 32926c9a279eSManojkiran Eda << std::get<0>(code.second); 3293a3316fc6SZhikuiRen std::ostringstream timeOffsetStr; 3294a3316fc6SZhikuiRen // Set Fixed -Point Notation 3295a3316fc6SZhikuiRen timeOffsetStr << std::fixed; 3296a3316fc6SZhikuiRen // Set precision to 4 digits 3297a3316fc6SZhikuiRen timeOffsetStr << std::setprecision(4); 3298a3316fc6SZhikuiRen // Add double to stream 3299a3316fc6SZhikuiRen timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000; 3300a3316fc6SZhikuiRen std::vector<std::string> messageArgs = { 3301a3316fc6SZhikuiRen std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()}; 3302a3316fc6SZhikuiRen 3303a3316fc6SZhikuiRen // Get MessageArgs template from message registry 3304a3316fc6SZhikuiRen std::string msg; 3305a3316fc6SZhikuiRen if (message != nullptr) 3306a3316fc6SZhikuiRen { 3307a3316fc6SZhikuiRen msg = message->message; 3308a3316fc6SZhikuiRen 3309a3316fc6SZhikuiRen // fill in this post code value 3310a3316fc6SZhikuiRen int i = 0; 3311a3316fc6SZhikuiRen for (const std::string& messageArg : messageArgs) 3312a3316fc6SZhikuiRen { 3313a3316fc6SZhikuiRen std::string argStr = "%" + std::to_string(++i); 3314a3316fc6SZhikuiRen size_t argPos = msg.find(argStr); 3315a3316fc6SZhikuiRen if (argPos != std::string::npos) 3316a3316fc6SZhikuiRen { 3317a3316fc6SZhikuiRen msg.replace(argPos, argStr.length(), messageArg); 3318a3316fc6SZhikuiRen } 3319a3316fc6SZhikuiRen } 3320a3316fc6SZhikuiRen } 3321a3316fc6SZhikuiRen 3322d4342a92STim Lee // Get Severity template from message registry 3323d4342a92STim Lee std::string severity; 3324d4342a92STim Lee if (message != nullptr) 3325d4342a92STim Lee { 33265f2b84eeSEd Tanous severity = message->messageSeverity; 3327d4342a92STim Lee } 3328d4342a92STim Lee 3329a3316fc6SZhikuiRen // add to AsyncResp 3330a3316fc6SZhikuiRen logEntryArray.push_back({}); 3331a3316fc6SZhikuiRen nlohmann::json& bmcLogEntry = logEntryArray.back(); 3332*84afc48bSJason M. Bills bmcLogEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 3333*84afc48bSJason M. Bills bmcLogEntry["@odata.id"] = 33340fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 3335*84afc48bSJason M. Bills postcodeEntryID; 3336*84afc48bSJason M. Bills bmcLogEntry["Name"] = "POST Code Log Entry"; 3337*84afc48bSJason M. Bills bmcLogEntry["Id"] = postcodeEntryID; 3338*84afc48bSJason M. Bills bmcLogEntry["Message"] = std::move(msg); 3339*84afc48bSJason M. Bills bmcLogEntry["MessageId"] = "OpenBMC.0.2.BIOSPOSTCode"; 3340*84afc48bSJason M. Bills bmcLogEntry["MessageArgs"] = std::move(messageArgs); 3341*84afc48bSJason M. Bills bmcLogEntry["EntryType"] = "Event"; 3342*84afc48bSJason M. Bills bmcLogEntry["Severity"] = std::move(severity); 3343*84afc48bSJason M. Bills bmcLogEntry["Created"] = entryTimeStr; 3344647b3cdcSGeorge Liu if (!std::get<std::vector<uint8_t>>(code.second).empty()) 3345647b3cdcSGeorge Liu { 3346647b3cdcSGeorge Liu bmcLogEntry["AdditionalDataURI"] = 3347647b3cdcSGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 3348647b3cdcSGeorge Liu postcodeEntryID + "/attachment"; 3349647b3cdcSGeorge Liu } 3350a3316fc6SZhikuiRen } 3351a3316fc6SZhikuiRen } 3352a3316fc6SZhikuiRen 33538d1b46d7Szhanghch05 static void getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3354a3316fc6SZhikuiRen const uint16_t bootIndex, 3355a3316fc6SZhikuiRen const uint64_t codeIndex) 3356a3316fc6SZhikuiRen { 3357a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 33586c9a279eSManojkiran Eda [aResp, bootIndex, 33596c9a279eSManojkiran Eda codeIndex](const boost::system::error_code ec, 33606c9a279eSManojkiran Eda const boost::container::flat_map< 33616c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 33626c9a279eSManojkiran Eda postcode) { 3363a3316fc6SZhikuiRen if (ec) 3364a3316fc6SZhikuiRen { 3365a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3366a3316fc6SZhikuiRen messages::internalError(aResp->res); 3367a3316fc6SZhikuiRen return; 3368a3316fc6SZhikuiRen } 3369a3316fc6SZhikuiRen 3370a3316fc6SZhikuiRen // skip the empty postcode boots 3371a3316fc6SZhikuiRen if (postcode.empty()) 3372a3316fc6SZhikuiRen { 3373a3316fc6SZhikuiRen return; 3374a3316fc6SZhikuiRen } 3375a3316fc6SZhikuiRen 3376a3316fc6SZhikuiRen fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex); 3377a3316fc6SZhikuiRen 3378a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = 3379a3316fc6SZhikuiRen aResp->res.jsonValue["Members"].size(); 3380a3316fc6SZhikuiRen }, 338115124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 338215124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3383a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3384a3316fc6SZhikuiRen bootIndex); 3385a3316fc6SZhikuiRen } 3386a3316fc6SZhikuiRen 33878d1b46d7Szhanghch05 static void getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3388a3316fc6SZhikuiRen const uint16_t bootIndex, 3389a3316fc6SZhikuiRen const uint16_t bootCount, 3390a3316fc6SZhikuiRen const uint64_t entryCount, const uint64_t skip, 3391a3316fc6SZhikuiRen const uint64_t top) 3392a3316fc6SZhikuiRen { 3393a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3394a3316fc6SZhikuiRen [aResp, bootIndex, bootCount, entryCount, skip, 3395a3316fc6SZhikuiRen top](const boost::system::error_code ec, 33966c9a279eSManojkiran Eda const boost::container::flat_map< 33976c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 33986c9a279eSManojkiran Eda postcode) { 3399a3316fc6SZhikuiRen if (ec) 3400a3316fc6SZhikuiRen { 3401a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3402a3316fc6SZhikuiRen messages::internalError(aResp->res); 3403a3316fc6SZhikuiRen return; 3404a3316fc6SZhikuiRen } 3405a3316fc6SZhikuiRen 3406a3316fc6SZhikuiRen uint64_t endCount = entryCount; 3407a3316fc6SZhikuiRen if (!postcode.empty()) 3408a3316fc6SZhikuiRen { 3409a3316fc6SZhikuiRen endCount = entryCount + postcode.size(); 3410a3316fc6SZhikuiRen 3411a3316fc6SZhikuiRen if ((skip < endCount) && ((top + skip) > entryCount)) 3412a3316fc6SZhikuiRen { 3413002d39b4SEd Tanous uint64_t thisBootSkip = std::max(skip, entryCount) - entryCount; 3414a3316fc6SZhikuiRen uint64_t thisBootTop = 3415a3316fc6SZhikuiRen std::min(top + skip, endCount) - entryCount; 3416a3316fc6SZhikuiRen 3417002d39b4SEd Tanous fillPostCodeEntry(aResp, postcode, bootIndex, 0, thisBootSkip, 3418002d39b4SEd Tanous thisBootTop); 3419a3316fc6SZhikuiRen } 3420a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = endCount; 3421a3316fc6SZhikuiRen } 3422a3316fc6SZhikuiRen 3423a3316fc6SZhikuiRen // continue to previous bootIndex 3424a3316fc6SZhikuiRen if (bootIndex < bootCount) 3425a3316fc6SZhikuiRen { 3426a3316fc6SZhikuiRen getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1), 3427a3316fc6SZhikuiRen bootCount, endCount, skip, top); 3428a3316fc6SZhikuiRen } 3429a3316fc6SZhikuiRen else 3430a3316fc6SZhikuiRen { 3431a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.nextLink"] = 34320fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=" + 3433a3316fc6SZhikuiRen std::to_string(skip + top); 3434a3316fc6SZhikuiRen } 3435a3316fc6SZhikuiRen }, 343615124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 343715124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3438a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3439a3316fc6SZhikuiRen bootIndex); 3440a3316fc6SZhikuiRen } 3441a3316fc6SZhikuiRen 34428d1b46d7Szhanghch05 static void 34438d1b46d7Szhanghch05 getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3444a3316fc6SZhikuiRen const uint64_t skip, const uint64_t top) 3445a3316fc6SZhikuiRen { 3446a3316fc6SZhikuiRen uint64_t entryCount = 0; 34471e1e598dSJonathan Doman sdbusplus::asio::getProperty<uint16_t>( 34481e1e598dSJonathan Doman *crow::connections::systemBus, 34491e1e598dSJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 34501e1e598dSJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 34511e1e598dSJonathan Doman "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount", 34521e1e598dSJonathan Doman [aResp, entryCount, skip, top](const boost::system::error_code ec, 34531e1e598dSJonathan Doman const uint16_t bootCount) { 3454a3316fc6SZhikuiRen if (ec) 3455a3316fc6SZhikuiRen { 3456a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3457a3316fc6SZhikuiRen messages::internalError(aResp->res); 3458a3316fc6SZhikuiRen return; 3459a3316fc6SZhikuiRen } 34601e1e598dSJonathan Doman getPostCodeForBoot(aResp, 1, bootCount, entryCount, skip, top); 34611e1e598dSJonathan Doman }); 3462a3316fc6SZhikuiRen } 3463a3316fc6SZhikuiRen 34647e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntryCollection(App& app) 3465a3316fc6SZhikuiRen { 34667e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 34677e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/") 3468ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 34697e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 347045ca1b86SEd Tanous [&app](const crow::Request& req, 34717e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 3472c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 3473c937d2bfSEd Tanous .canDelegateTop = true, 3474c937d2bfSEd Tanous .canDelegateSkip = true, 3475c937d2bfSEd Tanous }; 3476c937d2bfSEd Tanous query_param::Query delegatedQuery; 3477c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 34783ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 347945ca1b86SEd Tanous { 348045ca1b86SEd Tanous return; 348145ca1b86SEd Tanous } 3482a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.type"] = 3483a3316fc6SZhikuiRen "#LogEntryCollection.LogEntryCollection"; 3484a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 3485a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3486a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3487a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3488a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3489a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3490a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 3491a3316fc6SZhikuiRen 3492c937d2bfSEd Tanous getCurrentBootNumber(asyncResp, delegatedQuery.skip, 3493c937d2bfSEd Tanous delegatedQuery.top); 34947e860f15SJohn Edward Broadbent }); 3495a3316fc6SZhikuiRen } 3496a3316fc6SZhikuiRen 3497647b3cdcSGeorge Liu /** 3498647b3cdcSGeorge Liu * @brief Parse post code ID and get the current value and index value 3499647b3cdcSGeorge Liu * eg: postCodeID=B1-2, currentValue=1, index=2 3500647b3cdcSGeorge Liu * 3501647b3cdcSGeorge Liu * @param[in] postCodeID Post Code ID 3502647b3cdcSGeorge Liu * @param[out] currentValue Current value 3503647b3cdcSGeorge Liu * @param[out] index Index value 3504647b3cdcSGeorge Liu * 3505647b3cdcSGeorge Liu * @return bool true if the parsing is successful, false the parsing fails 3506647b3cdcSGeorge Liu */ 3507647b3cdcSGeorge Liu inline static bool parsePostCode(const std::string& postCodeID, 3508647b3cdcSGeorge Liu uint64_t& currentValue, uint16_t& index) 3509647b3cdcSGeorge Liu { 3510647b3cdcSGeorge Liu std::vector<std::string> split; 3511647b3cdcSGeorge Liu boost::algorithm::split(split, postCodeID, boost::is_any_of("-")); 3512647b3cdcSGeorge Liu if (split.size() != 2 || split[0].length() < 2 || split[0].front() != 'B') 3513647b3cdcSGeorge Liu { 3514647b3cdcSGeorge Liu return false; 3515647b3cdcSGeorge Liu } 3516647b3cdcSGeorge Liu 3517ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3518647b3cdcSGeorge Liu const char* start = split[0].data() + 1; 3519ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3520647b3cdcSGeorge Liu const char* end = split[0].data() + split[0].size(); 3521647b3cdcSGeorge Liu auto [ptrIndex, ecIndex] = std::from_chars(start, end, index); 3522647b3cdcSGeorge Liu 3523647b3cdcSGeorge Liu if (ptrIndex != end || ecIndex != std::errc()) 3524647b3cdcSGeorge Liu { 3525647b3cdcSGeorge Liu return false; 3526647b3cdcSGeorge Liu } 3527647b3cdcSGeorge Liu 3528647b3cdcSGeorge Liu start = split[1].data(); 3529ca45aa3cSEd Tanous 3530ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3531647b3cdcSGeorge Liu end = split[1].data() + split[1].size(); 3532647b3cdcSGeorge Liu auto [ptrValue, ecValue] = std::from_chars(start, end, currentValue); 3533647b3cdcSGeorge Liu 3534dcf2ebc0SEd Tanous return ptrValue == end && ecValue != std::errc(); 3535647b3cdcSGeorge Liu } 3536647b3cdcSGeorge Liu 3537647b3cdcSGeorge Liu inline void requestRoutesPostCodesEntryAdditionalData(App& app) 3538647b3cdcSGeorge Liu { 35390fda0f12SGeorge Liu BMCWEB_ROUTE( 35400fda0f12SGeorge Liu app, 35410fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/attachment/") 3542647b3cdcSGeorge Liu .privileges(redfish::privileges::getLogEntry) 3543647b3cdcSGeorge Liu .methods(boost::beast::http::verb::get)( 354445ca1b86SEd Tanous [&app](const crow::Request& req, 3545647b3cdcSGeorge Liu const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3546647b3cdcSGeorge Liu const std::string& postCodeID) { 35473ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 354845ca1b86SEd Tanous { 354945ca1b86SEd Tanous return; 355045ca1b86SEd Tanous } 3551002d39b4SEd Tanous if (!http_helpers::isOctetAccepted(req.getHeaderValue("Accept"))) 3552647b3cdcSGeorge Liu { 3553002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::bad_request); 3554647b3cdcSGeorge Liu return; 3555647b3cdcSGeorge Liu } 3556647b3cdcSGeorge Liu 3557647b3cdcSGeorge Liu uint64_t currentValue = 0; 3558647b3cdcSGeorge Liu uint16_t index = 0; 3559647b3cdcSGeorge Liu if (!parsePostCode(postCodeID, currentValue, index)) 3560647b3cdcSGeorge Liu { 3561002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", postCodeID); 3562647b3cdcSGeorge Liu return; 3563647b3cdcSGeorge Liu } 3564647b3cdcSGeorge Liu 3565647b3cdcSGeorge Liu crow::connections::systemBus->async_method_call( 3566647b3cdcSGeorge Liu [asyncResp, postCodeID, currentValue]( 3567647b3cdcSGeorge Liu const boost::system::error_code ec, 3568002d39b4SEd Tanous const std::vector<std::tuple<uint64_t, std::vector<uint8_t>>>& 3569002d39b4SEd Tanous postcodes) { 3570647b3cdcSGeorge Liu if (ec.value() == EBADR) 3571647b3cdcSGeorge Liu { 3572002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 3573002d39b4SEd Tanous postCodeID); 3574647b3cdcSGeorge Liu return; 3575647b3cdcSGeorge Liu } 3576647b3cdcSGeorge Liu if (ec) 3577647b3cdcSGeorge Liu { 3578647b3cdcSGeorge Liu BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3579647b3cdcSGeorge Liu messages::internalError(asyncResp->res); 3580647b3cdcSGeorge Liu return; 3581647b3cdcSGeorge Liu } 3582647b3cdcSGeorge Liu 3583647b3cdcSGeorge Liu size_t value = static_cast<size_t>(currentValue) - 1; 3584002d39b4SEd Tanous if (value == std::string::npos || postcodes.size() < currentValue) 3585647b3cdcSGeorge Liu { 3586647b3cdcSGeorge Liu BMCWEB_LOG_ERROR << "Wrong currentValue value"; 3587002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 3588002d39b4SEd Tanous postCodeID); 3589647b3cdcSGeorge Liu return; 3590647b3cdcSGeorge Liu } 3591647b3cdcSGeorge Liu 35929eb808c1SEd Tanous const auto& [tID, c] = postcodes[value]; 359346ff87baSEd Tanous if (c.empty()) 3594647b3cdcSGeorge Liu { 3595647b3cdcSGeorge Liu BMCWEB_LOG_INFO << "No found post code data"; 3596002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 3597002d39b4SEd Tanous postCodeID); 3598647b3cdcSGeorge Liu return; 3599647b3cdcSGeorge Liu } 360046ff87baSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) 360146ff87baSEd Tanous const char* d = reinterpret_cast<const char*>(c.data()); 360246ff87baSEd Tanous std::string_view strData(d, c.size()); 3603647b3cdcSGeorge Liu 3604647b3cdcSGeorge Liu asyncResp->res.addHeader("Content-Type", 3605647b3cdcSGeorge Liu "application/octet-stream"); 3606002d39b4SEd Tanous asyncResp->res.addHeader("Content-Transfer-Encoding", "Base64"); 3607002d39b4SEd Tanous asyncResp->res.body() = crow::utility::base64encode(strData); 3608647b3cdcSGeorge Liu }, 3609647b3cdcSGeorge Liu "xyz.openbmc_project.State.Boot.PostCode0", 3610647b3cdcSGeorge Liu "/xyz/openbmc_project/State/Boot/PostCode0", 3611002d39b4SEd Tanous "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", index); 3612647b3cdcSGeorge Liu }); 3613647b3cdcSGeorge Liu } 3614647b3cdcSGeorge Liu 36157e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntry(App& app) 3616a3316fc6SZhikuiRen { 36177e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 36187e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/") 3619ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 36207e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 362145ca1b86SEd Tanous [&app](const crow::Request& req, 36227e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 36237e860f15SJohn Edward Broadbent const std::string& targetID) { 36243ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 362545ca1b86SEd Tanous { 362645ca1b86SEd Tanous return; 362745ca1b86SEd Tanous } 3628647b3cdcSGeorge Liu uint16_t bootIndex = 0; 3629647b3cdcSGeorge Liu uint64_t codeIndex = 0; 3630647b3cdcSGeorge Liu if (!parsePostCode(targetID, codeIndex, bootIndex)) 3631a3316fc6SZhikuiRen { 3632a3316fc6SZhikuiRen // Requested ID was not found 3633ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 3634a3316fc6SZhikuiRen return; 3635a3316fc6SZhikuiRen } 3636a3316fc6SZhikuiRen if (bootIndex == 0 || codeIndex == 0) 3637a3316fc6SZhikuiRen { 3638a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string " 36397e860f15SJohn Edward Broadbent << targetID; 3640a3316fc6SZhikuiRen } 3641a3316fc6SZhikuiRen 3642002d39b4SEd Tanous asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_4_0.LogEntry"; 3643a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 36440fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3645a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3646a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3647a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3648a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3649a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 3650a3316fc6SZhikuiRen 3651a3316fc6SZhikuiRen getPostCodeForEntry(asyncResp, bootIndex, codeIndex); 36527e860f15SJohn Edward Broadbent }); 3653a3316fc6SZhikuiRen } 3654a3316fc6SZhikuiRen 36551da66f75SEd Tanous } // namespace redfish 3656