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> 309896eaedSEd Tanous #include <boost/algorithm/string/case_conv.hpp> 3111ba3979SEd Tanous #include <boost/algorithm/string/classification.hpp> 32400fd1fbSAdriana Kobylak #include <boost/algorithm/string/replace.hpp> 334851d45dSJason M. Bills #include <boost/algorithm/string/split.hpp> 3407c8c20dSEd Tanous #include <boost/beast/http/verb.hpp> 351da66f75SEd Tanous #include <boost/container/flat_map.hpp> 361ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp> 37168e20c1SEd Tanous #include <dbus_utility.hpp> 38cb92c03bSAndrew Geissler #include <error_messages.hpp> 3945ca1b86SEd Tanous #include <query.hpp> 40ed398213SEd Tanous #include <registries/privilege_registry.hpp> 41d1bde9e5SKrzysztof Grobelny #include <sdbusplus/asio/property.hpp> 42d1bde9e5SKrzysztof Grobelny #include <sdbusplus/unpack_properties.hpp> 43d1bde9e5SKrzysztof Grobelny #include <utils/dbus_utils.hpp> 442b82937eSEd Tanous #include <utils/time_utils.hpp> 451214b7e7SGunnar Mills 46647b3cdcSGeorge Liu #include <charconv> 474418c7f0SJames Feist #include <filesystem> 4875710de2SXiaochao Ma #include <optional> 4926702d01SEd Tanous #include <span> 50cd225da8SJason M. Bills #include <string_view> 51abf2add6SEd Tanous #include <variant> 521da66f75SEd Tanous 531da66f75SEd Tanous namespace redfish 541da66f75SEd Tanous { 551da66f75SEd Tanous 565b61b5e8SJason M. Bills constexpr char const* crashdumpObject = "com.intel.crashdump"; 575b61b5e8SJason M. Bills constexpr char const* crashdumpPath = "/com/intel/crashdump"; 585b61b5e8SJason M. Bills constexpr char const* crashdumpInterface = "com.intel.crashdump"; 595b61b5e8SJason M. Bills constexpr char const* deleteAllInterface = 605b61b5e8SJason M. Bills "xyz.openbmc_project.Collection.DeleteAll"; 615b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandInterface = 62424c4176SJason M. Bills "com.intel.crashdump.OnDemand"; 636eda7685SKenny L. Ku constexpr char const* crashdumpTelemetryInterface = 646eda7685SKenny L. Ku "com.intel.crashdump.Telemetry"; 651da66f75SEd Tanous 66fffb8c1fSEd Tanous namespace registries 674851d45dSJason M. Bills { 6826702d01SEd Tanous static const Message* 6926702d01SEd Tanous getMessageFromRegistry(const std::string& messageKey, 7026702d01SEd Tanous const std::span<const MessageEntry> registry) 714851d45dSJason M. Bills { 72002d39b4SEd Tanous std::span<const MessageEntry>::iterator messageIt = 73002d39b4SEd Tanous std::find_if(registry.begin(), registry.end(), 744851d45dSJason M. Bills [&messageKey](const MessageEntry& messageEntry) { 75e662eae8SEd Tanous return std::strcmp(messageEntry.first, messageKey.c_str()) == 0; 764851d45dSJason M. Bills }); 7726702d01SEd Tanous if (messageIt != registry.end()) 784851d45dSJason M. Bills { 794851d45dSJason M. Bills return &messageIt->second; 804851d45dSJason M. Bills } 814851d45dSJason M. Bills 824851d45dSJason M. Bills return nullptr; 834851d45dSJason M. Bills } 844851d45dSJason M. Bills 854851d45dSJason M. Bills static const Message* getMessage(const std::string_view& messageID) 864851d45dSJason M. Bills { 874851d45dSJason M. Bills // Redfish MessageIds are in the form 884851d45dSJason M. Bills // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 894851d45dSJason M. Bills // the right Message 904851d45dSJason M. Bills std::vector<std::string> fields; 914851d45dSJason M. Bills fields.reserve(4); 924851d45dSJason M. Bills boost::split(fields, messageID, boost::is_any_of(".")); 9302cad96eSEd Tanous const std::string& registryName = fields[0]; 9402cad96eSEd Tanous const std::string& messageKey = fields[3]; 954851d45dSJason M. Bills 964851d45dSJason M. Bills // Find the right registry and check it for the MessageKey 974851d45dSJason M. Bills if (std::string(base::header.registryPrefix) == registryName) 984851d45dSJason M. Bills { 994851d45dSJason M. Bills return getMessageFromRegistry( 10026702d01SEd Tanous messageKey, std::span<const MessageEntry>(base::registry)); 1014851d45dSJason M. Bills } 1024851d45dSJason M. Bills if (std::string(openbmc::header.registryPrefix) == registryName) 1034851d45dSJason M. Bills { 1044851d45dSJason M. Bills return getMessageFromRegistry( 10526702d01SEd Tanous messageKey, std::span<const MessageEntry>(openbmc::registry)); 1064851d45dSJason M. Bills } 1074851d45dSJason M. Bills return nullptr; 1084851d45dSJason M. Bills } 109fffb8c1fSEd Tanous } // namespace registries 1104851d45dSJason M. Bills 111f6150403SJames Feist namespace fs = std::filesystem; 1121da66f75SEd Tanous 113cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s) 114cb92c03bSAndrew Geissler { 115d4d25793SEd Tanous if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") || 116d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") || 117d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") || 118d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Error")) 119cb92c03bSAndrew Geissler { 120cb92c03bSAndrew Geissler return "Critical"; 121cb92c03bSAndrew Geissler } 1223174e4dfSEd Tanous if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") || 123d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") || 124d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Notice")) 125cb92c03bSAndrew Geissler { 126cb92c03bSAndrew Geissler return "OK"; 127cb92c03bSAndrew Geissler } 1283174e4dfSEd Tanous if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning") 129cb92c03bSAndrew Geissler { 130cb92c03bSAndrew Geissler return "Warning"; 131cb92c03bSAndrew Geissler } 132cb92c03bSAndrew Geissler return ""; 133cb92c03bSAndrew Geissler } 134cb92c03bSAndrew Geissler 1357e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal, 13639e77504SEd Tanous const std::string_view& field, 13739e77504SEd Tanous std::string_view& contents) 13816428a1aSJason M. Bills { 13916428a1aSJason M. Bills const char* data = nullptr; 14016428a1aSJason M. Bills size_t length = 0; 14116428a1aSJason M. Bills int ret = 0; 14216428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 14346ff87baSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) 14446ff87baSEd Tanous const void** dataVoid = reinterpret_cast<const void**>(&data); 14546ff87baSEd Tanous 14646ff87baSEd Tanous ret = sd_journal_get_data(journal, field.data(), dataVoid, &length); 14716428a1aSJason M. Bills if (ret < 0) 14816428a1aSJason M. Bills { 14916428a1aSJason M. Bills return ret; 15016428a1aSJason M. Bills } 15139e77504SEd Tanous contents = std::string_view(data, length); 15216428a1aSJason M. Bills // Only use the content after the "=" character. 15381ce609eSEd Tanous contents.remove_prefix(std::min(contents.find('=') + 1, contents.size())); 15416428a1aSJason M. Bills return ret; 15516428a1aSJason M. Bills } 15616428a1aSJason M. Bills 1577e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal, 1587e860f15SJohn Edward Broadbent const std::string_view& field, 1597e860f15SJohn Edward Broadbent const int& base, long int& contents) 16016428a1aSJason M. Bills { 16116428a1aSJason M. Bills int ret = 0; 16239e77504SEd Tanous std::string_view metadata; 16316428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 16416428a1aSJason M. Bills ret = getJournalMetadata(journal, field, metadata); 16516428a1aSJason M. Bills if (ret < 0) 16616428a1aSJason M. Bills { 16716428a1aSJason M. Bills return ret; 16816428a1aSJason M. Bills } 169b01bf299SEd Tanous contents = strtol(metadata.data(), nullptr, base); 17016428a1aSJason M. Bills return ret; 17116428a1aSJason M. Bills } 17216428a1aSJason M. Bills 1737e860f15SJohn Edward Broadbent inline static bool getEntryTimestamp(sd_journal* journal, 1747e860f15SJohn Edward Broadbent std::string& entryTimestamp) 175a3316fc6SZhikuiRen { 176a3316fc6SZhikuiRen int ret = 0; 177a3316fc6SZhikuiRen uint64_t timestamp = 0; 178a3316fc6SZhikuiRen ret = sd_journal_get_realtime_usec(journal, ×tamp); 179a3316fc6SZhikuiRen if (ret < 0) 180a3316fc6SZhikuiRen { 181a3316fc6SZhikuiRen BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 182a3316fc6SZhikuiRen << strerror(-ret); 183a3316fc6SZhikuiRen return false; 184a3316fc6SZhikuiRen } 1852b82937eSEd Tanous entryTimestamp = 1862b82937eSEd Tanous redfish::time_utils::getDateTimeUint(timestamp / 1000 / 1000); 1879c620e21SAsmitha Karunanithi return true; 188a3316fc6SZhikuiRen } 18950b8a43aSEd Tanous 1907e860f15SJohn Edward Broadbent inline static bool getUniqueEntryID(sd_journal* journal, std::string& entryID, 191e85d6b16SJason M. Bills const bool firstEntry = true) 19216428a1aSJason M. Bills { 19316428a1aSJason M. Bills int ret = 0; 19416428a1aSJason M. Bills static uint64_t prevTs = 0; 19516428a1aSJason M. Bills static int index = 0; 196e85d6b16SJason M. Bills if (firstEntry) 197e85d6b16SJason M. Bills { 198e85d6b16SJason M. Bills prevTs = 0; 199e85d6b16SJason M. Bills } 200e85d6b16SJason M. Bills 20116428a1aSJason M. Bills // Get the entry timestamp 20216428a1aSJason M. Bills uint64_t curTs = 0; 20316428a1aSJason M. Bills ret = sd_journal_get_realtime_usec(journal, &curTs); 20416428a1aSJason M. Bills if (ret < 0) 20516428a1aSJason M. Bills { 20616428a1aSJason M. Bills BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 20716428a1aSJason M. Bills << strerror(-ret); 20816428a1aSJason M. Bills return false; 20916428a1aSJason M. Bills } 21016428a1aSJason M. Bills // If the timestamp isn't unique, increment the index 21116428a1aSJason M. Bills if (curTs == prevTs) 21216428a1aSJason M. Bills { 21316428a1aSJason M. Bills index++; 21416428a1aSJason M. Bills } 21516428a1aSJason M. Bills else 21616428a1aSJason M. Bills { 21716428a1aSJason M. Bills // Otherwise, reset it 21816428a1aSJason M. Bills index = 0; 21916428a1aSJason M. Bills } 22016428a1aSJason M. Bills // Save the timestamp 22116428a1aSJason M. Bills prevTs = curTs; 22216428a1aSJason M. Bills 22316428a1aSJason M. Bills entryID = std::to_string(curTs); 22416428a1aSJason M. Bills if (index > 0) 22516428a1aSJason M. Bills { 22616428a1aSJason M. Bills entryID += "_" + std::to_string(index); 22716428a1aSJason M. Bills } 22816428a1aSJason M. Bills return true; 22916428a1aSJason M. Bills } 23016428a1aSJason M. Bills 231e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID, 232e85d6b16SJason M. Bills const bool firstEntry = true) 23395820184SJason M. Bills { 234271584abSEd Tanous static time_t prevTs = 0; 23595820184SJason M. Bills static int index = 0; 236e85d6b16SJason M. Bills if (firstEntry) 237e85d6b16SJason M. Bills { 238e85d6b16SJason M. Bills prevTs = 0; 239e85d6b16SJason M. Bills } 240e85d6b16SJason M. Bills 24195820184SJason M. Bills // Get the entry timestamp 242271584abSEd Tanous std::time_t curTs = 0; 24395820184SJason M. Bills std::tm timeStruct = {}; 24495820184SJason M. Bills std::istringstream entryStream(logEntry); 24595820184SJason M. Bills if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 24695820184SJason M. Bills { 24795820184SJason M. Bills curTs = std::mktime(&timeStruct); 24895820184SJason M. Bills } 24995820184SJason M. Bills // If the timestamp isn't unique, increment the index 25095820184SJason M. Bills if (curTs == prevTs) 25195820184SJason M. Bills { 25295820184SJason M. Bills index++; 25395820184SJason M. Bills } 25495820184SJason M. Bills else 25595820184SJason M. Bills { 25695820184SJason M. Bills // Otherwise, reset it 25795820184SJason M. Bills index = 0; 25895820184SJason M. Bills } 25995820184SJason M. Bills // Save the timestamp 26095820184SJason M. Bills prevTs = curTs; 26195820184SJason M. Bills 26295820184SJason M. Bills entryID = std::to_string(curTs); 26395820184SJason M. Bills if (index > 0) 26495820184SJason M. Bills { 26595820184SJason M. Bills entryID += "_" + std::to_string(index); 26695820184SJason M. Bills } 26795820184SJason M. Bills return true; 26895820184SJason M. Bills } 26995820184SJason M. Bills 2707e860f15SJohn Edward Broadbent inline static bool 2718d1b46d7Szhanghch05 getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2728d1b46d7Szhanghch05 const std::string& entryID, uint64_t& timestamp, 2738d1b46d7Szhanghch05 uint64_t& index) 27416428a1aSJason M. Bills { 27516428a1aSJason M. Bills if (entryID.empty()) 27616428a1aSJason M. Bills { 27716428a1aSJason M. Bills return false; 27816428a1aSJason M. Bills } 27916428a1aSJason M. Bills // Convert the unique ID back to a timestamp to find the entry 28039e77504SEd Tanous std::string_view tsStr(entryID); 28116428a1aSJason M. Bills 28281ce609eSEd Tanous auto underscorePos = tsStr.find('_'); 28371d5d8dbSEd Tanous if (underscorePos != std::string_view::npos) 28416428a1aSJason M. Bills { 28516428a1aSJason M. Bills // Timestamp has an index 28616428a1aSJason M. Bills tsStr.remove_suffix(tsStr.size() - underscorePos); 28739e77504SEd Tanous std::string_view indexStr(entryID); 28816428a1aSJason M. Bills indexStr.remove_prefix(underscorePos + 1); 289c0bd5e4bSEd Tanous auto [ptr, ec] = std::from_chars( 290c0bd5e4bSEd Tanous indexStr.data(), indexStr.data() + indexStr.size(), index); 291c0bd5e4bSEd Tanous if (ec != std::errc()) 29216428a1aSJason M. Bills { 293ace85d60SEd Tanous messages::resourceMissingAtURI( 294ace85d60SEd Tanous asyncResp->res, crow::utility::urlFromPieces(entryID)); 29516428a1aSJason M. Bills return false; 29616428a1aSJason M. Bills } 29716428a1aSJason M. Bills } 29816428a1aSJason M. Bills // Timestamp has no index 299c0bd5e4bSEd Tanous auto [ptr, ec] = 300c0bd5e4bSEd Tanous std::from_chars(tsStr.data(), tsStr.data() + tsStr.size(), timestamp); 301c0bd5e4bSEd Tanous if (ec != std::errc()) 30216428a1aSJason M. Bills { 303ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, 304ace85d60SEd Tanous crow::utility::urlFromPieces(entryID)); 30516428a1aSJason M. Bills return false; 30616428a1aSJason M. Bills } 30716428a1aSJason M. Bills return true; 30816428a1aSJason M. Bills } 30916428a1aSJason M. Bills 31095820184SJason M. Bills static bool 31195820184SJason M. Bills getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles) 31295820184SJason M. Bills { 31395820184SJason M. Bills static const std::filesystem::path redfishLogDir = "/var/log"; 31495820184SJason M. Bills static const std::string redfishLogFilename = "redfish"; 31595820184SJason M. Bills 31695820184SJason M. Bills // Loop through the directory looking for redfish log files 31795820184SJason M. Bills for (const std::filesystem::directory_entry& dirEnt : 31895820184SJason M. Bills std::filesystem::directory_iterator(redfishLogDir)) 31995820184SJason M. Bills { 32095820184SJason M. Bills // If we find a redfish log file, save the path 32195820184SJason M. Bills std::string filename = dirEnt.path().filename(); 32211ba3979SEd Tanous if (filename.starts_with(redfishLogFilename)) 32395820184SJason M. Bills { 32495820184SJason M. Bills redfishLogFiles.emplace_back(redfishLogDir / filename); 32595820184SJason M. Bills } 32695820184SJason M. Bills } 32795820184SJason M. Bills // As the log files rotate, they are appended with a ".#" that is higher for 32895820184SJason M. Bills // the older logs. Since we don't expect more than 10 log files, we 32995820184SJason M. Bills // can just sort the list to get them in order from newest to oldest 33095820184SJason M. Bills std::sort(redfishLogFiles.begin(), redfishLogFiles.end()); 33195820184SJason M. Bills 33295820184SJason M. Bills return !redfishLogFiles.empty(); 33395820184SJason M. Bills } 33495820184SJason M. Bills 335aefe3786SClaire Weinan inline void parseDumpEntryFromDbusObject( 3362d613eb6SJiaqing Zhao const dbus::utility::ManagedObjectType::value_type& object, 337c6fecdabSClaire Weinan std::string& dumpStatus, uint64_t& size, uint64_t& timestampUs, 338aefe3786SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 339aefe3786SClaire Weinan { 340aefe3786SClaire Weinan for (const auto& interfaceMap : object.second) 341aefe3786SClaire Weinan { 342aefe3786SClaire Weinan if (interfaceMap.first == "xyz.openbmc_project.Common.Progress") 343aefe3786SClaire Weinan { 344aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 345aefe3786SClaire Weinan { 346aefe3786SClaire Weinan if (propertyMap.first == "Status") 347aefe3786SClaire Weinan { 348aefe3786SClaire Weinan const auto* status = 349aefe3786SClaire Weinan std::get_if<std::string>(&propertyMap.second); 350aefe3786SClaire Weinan if (status == nullptr) 351aefe3786SClaire Weinan { 352aefe3786SClaire Weinan messages::internalError(asyncResp->res); 353aefe3786SClaire Weinan break; 354aefe3786SClaire Weinan } 355aefe3786SClaire Weinan dumpStatus = *status; 356aefe3786SClaire Weinan } 357aefe3786SClaire Weinan } 358aefe3786SClaire Weinan } 359aefe3786SClaire Weinan else if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") 360aefe3786SClaire Weinan { 361aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 362aefe3786SClaire Weinan { 363aefe3786SClaire Weinan if (propertyMap.first == "Size") 364aefe3786SClaire Weinan { 365aefe3786SClaire Weinan const auto* sizePtr = 366aefe3786SClaire Weinan std::get_if<uint64_t>(&propertyMap.second); 367aefe3786SClaire Weinan if (sizePtr == nullptr) 368aefe3786SClaire Weinan { 369aefe3786SClaire Weinan messages::internalError(asyncResp->res); 370aefe3786SClaire Weinan break; 371aefe3786SClaire Weinan } 372aefe3786SClaire Weinan size = *sizePtr; 373aefe3786SClaire Weinan break; 374aefe3786SClaire Weinan } 375aefe3786SClaire Weinan } 376aefe3786SClaire Weinan } 377aefe3786SClaire Weinan else if (interfaceMap.first == "xyz.openbmc_project.Time.EpochTime") 378aefe3786SClaire Weinan { 379aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 380aefe3786SClaire Weinan { 381aefe3786SClaire Weinan if (propertyMap.first == "Elapsed") 382aefe3786SClaire Weinan { 383aefe3786SClaire Weinan const uint64_t* usecsTimeStamp = 384aefe3786SClaire Weinan std::get_if<uint64_t>(&propertyMap.second); 385aefe3786SClaire Weinan if (usecsTimeStamp == nullptr) 386aefe3786SClaire Weinan { 387aefe3786SClaire Weinan messages::internalError(asyncResp->res); 388aefe3786SClaire Weinan break; 389aefe3786SClaire Weinan } 390c6fecdabSClaire Weinan timestampUs = *usecsTimeStamp; 391aefe3786SClaire Weinan break; 392aefe3786SClaire Weinan } 393aefe3786SClaire Weinan } 394aefe3786SClaire Weinan } 395aefe3786SClaire Weinan } 396aefe3786SClaire Weinan } 397aefe3786SClaire Weinan 39821ab404cSNan Zhou static std::string getDumpEntriesPath(const std::string& dumpType) 399fdd26906SClaire Weinan { 400fdd26906SClaire Weinan std::string entriesPath; 401fdd26906SClaire Weinan 402fdd26906SClaire Weinan if (dumpType == "BMC") 403fdd26906SClaire Weinan { 404fdd26906SClaire Weinan entriesPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 405fdd26906SClaire Weinan } 406fdd26906SClaire Weinan else if (dumpType == "FaultLog") 407fdd26906SClaire Weinan { 408fdd26906SClaire Weinan entriesPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/"; 409fdd26906SClaire Weinan } 410fdd26906SClaire Weinan else if (dumpType == "System") 411fdd26906SClaire Weinan { 412fdd26906SClaire Weinan entriesPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 413fdd26906SClaire Weinan } 414fdd26906SClaire Weinan else 415fdd26906SClaire Weinan { 416fdd26906SClaire Weinan BMCWEB_LOG_ERROR << "getDumpEntriesPath() invalid dump type: " 417fdd26906SClaire Weinan << dumpType; 418fdd26906SClaire Weinan } 419fdd26906SClaire Weinan 420fdd26906SClaire Weinan // Returns empty string on error 421fdd26906SClaire Weinan return entriesPath; 422fdd26906SClaire Weinan } 423fdd26906SClaire Weinan 4248d1b46d7Szhanghch05 inline void 4258d1b46d7Szhanghch05 getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 4265cb1dd27SAsmitha Karunanithi const std::string& dumpType) 4275cb1dd27SAsmitha Karunanithi { 428fdd26906SClaire Weinan std::string entriesPath = getDumpEntriesPath(dumpType); 429fdd26906SClaire Weinan if (entriesPath.empty()) 4305cb1dd27SAsmitha Karunanithi { 4315cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4325cb1dd27SAsmitha Karunanithi return; 4335cb1dd27SAsmitha Karunanithi } 4345cb1dd27SAsmitha Karunanithi 4355cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 436fdd26906SClaire Weinan [asyncResp, entriesPath, 437711ac7a9SEd Tanous dumpType](const boost::system::error_code ec, 438711ac7a9SEd Tanous dbus::utility::ManagedObjectType& resp) { 4395cb1dd27SAsmitha Karunanithi if (ec) 4405cb1dd27SAsmitha Karunanithi { 4415cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 4425cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4435cb1dd27SAsmitha Karunanithi return; 4445cb1dd27SAsmitha Karunanithi } 4455cb1dd27SAsmitha Karunanithi 446fdd26906SClaire Weinan // Remove ending slash 447fdd26906SClaire Weinan std::string odataIdStr = entriesPath; 448fdd26906SClaire Weinan if (!odataIdStr.empty()) 449fdd26906SClaire Weinan { 450fdd26906SClaire Weinan odataIdStr.pop_back(); 451fdd26906SClaire Weinan } 452fdd26906SClaire Weinan 453fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.type"] = 454fdd26906SClaire Weinan "#LogEntryCollection.LogEntryCollection"; 455fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = std::move(odataIdStr); 456fdd26906SClaire Weinan asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entries"; 457fdd26906SClaire Weinan asyncResp->res.jsonValue["Description"] = 458fdd26906SClaire Weinan "Collection of " + dumpType + " Dump Entries"; 459fdd26906SClaire Weinan 4605cb1dd27SAsmitha Karunanithi nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"]; 4615cb1dd27SAsmitha Karunanithi entriesArray = nlohmann::json::array(); 462b47452b2SAsmitha Karunanithi std::string dumpEntryPath = 463b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 464002d39b4SEd Tanous std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/"; 4655cb1dd27SAsmitha Karunanithi 466002d39b4SEd Tanous std::sort(resp.begin(), resp.end(), [](const auto& l, const auto& r) { 467002d39b4SEd Tanous return AlphanumLess<std::string>()(l.first.filename(), 468002d39b4SEd Tanous r.first.filename()); 469565dfb6fSClaire Weinan }); 470565dfb6fSClaire Weinan 4715cb1dd27SAsmitha Karunanithi for (auto& object : resp) 4725cb1dd27SAsmitha Karunanithi { 473b47452b2SAsmitha Karunanithi if (object.first.str.find(dumpEntryPath) == std::string::npos) 4745cb1dd27SAsmitha Karunanithi { 4755cb1dd27SAsmitha Karunanithi continue; 4765cb1dd27SAsmitha Karunanithi } 477c6fecdabSClaire Weinan uint64_t timestampUs = 0; 4785cb1dd27SAsmitha Karunanithi uint64_t size = 0; 47935440d18SAsmitha Karunanithi std::string dumpStatus; 480433b68b4SJason M. Bills nlohmann::json::object_t thisEntry; 4812dfd18efSEd Tanous 4822dfd18efSEd Tanous std::string entryID = object.first.filename(); 4832dfd18efSEd Tanous if (entryID.empty()) 4845cb1dd27SAsmitha Karunanithi { 4855cb1dd27SAsmitha Karunanithi continue; 4865cb1dd27SAsmitha Karunanithi } 4875cb1dd27SAsmitha Karunanithi 488c6fecdabSClaire Weinan parseDumpEntryFromDbusObject(object, dumpStatus, size, timestampUs, 489aefe3786SClaire Weinan asyncResp); 4905cb1dd27SAsmitha Karunanithi 4910fda0f12SGeorge Liu if (dumpStatus != 4920fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 49335440d18SAsmitha Karunanithi !dumpStatus.empty()) 49435440d18SAsmitha Karunanithi { 49535440d18SAsmitha Karunanithi // Dump status is not Complete, no need to enumerate 49635440d18SAsmitha Karunanithi continue; 49735440d18SAsmitha Karunanithi } 49835440d18SAsmitha Karunanithi 499*9c11a172SVijay Lobo thisEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 500fdd26906SClaire Weinan thisEntry["@odata.id"] = entriesPath + entryID; 5015cb1dd27SAsmitha Karunanithi thisEntry["Id"] = entryID; 5025cb1dd27SAsmitha Karunanithi thisEntry["EntryType"] = "Event"; 5035cb1dd27SAsmitha Karunanithi thisEntry["Name"] = dumpType + " Dump Entry"; 5045cb1dd27SAsmitha Karunanithi 5055cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 5065cb1dd27SAsmitha Karunanithi { 507c6fecdabSClaire Weinan thisEntry["Created"] = redfish::time_utils::getDateTimeUint( 508c6fecdabSClaire Weinan timestampUs / 1000 / 1000); 509d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "Manager"; 510d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataURI"] = 511fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 512fdd26906SClaire Weinan thisEntry["AdditionalDataSizeBytes"] = size; 5135cb1dd27SAsmitha Karunanithi } 514c6fecdabSClaire Weinan else if (dumpType == "FaultLog") 515c6fecdabSClaire Weinan { 516c6fecdabSClaire Weinan thisEntry["Created"] = 517c6fecdabSClaire Weinan redfish::time_utils::getDateTimeUintUs(timestampUs); 518c6fecdabSClaire Weinan } 5195cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 5205cb1dd27SAsmitha Karunanithi { 521c6fecdabSClaire Weinan thisEntry["Created"] = redfish::time_utils::getDateTimeUint( 522c6fecdabSClaire Weinan timestampUs / 1000 / 1000); 523d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "OEM"; 524d337bb72SAsmitha Karunanithi thisEntry["OEMDiagnosticDataType"] = "System"; 525d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataURI"] = 526fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 527fdd26906SClaire Weinan thisEntry["AdditionalDataSizeBytes"] = size; 5285cb1dd27SAsmitha Karunanithi } 52935440d18SAsmitha Karunanithi entriesArray.push_back(std::move(thisEntry)); 5305cb1dd27SAsmitha Karunanithi } 531002d39b4SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size(); 5325cb1dd27SAsmitha Karunanithi }, 5335cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 5345cb1dd27SAsmitha Karunanithi "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 5355cb1dd27SAsmitha Karunanithi } 5365cb1dd27SAsmitha Karunanithi 5378d1b46d7Szhanghch05 inline void 538c7a6d660SClaire Weinan getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 5398d1b46d7Szhanghch05 const std::string& entryID, const std::string& dumpType) 5405cb1dd27SAsmitha Karunanithi { 541fdd26906SClaire Weinan std::string entriesPath = getDumpEntriesPath(dumpType); 542fdd26906SClaire Weinan if (entriesPath.empty()) 5435cb1dd27SAsmitha Karunanithi { 5445cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5455cb1dd27SAsmitha Karunanithi return; 5465cb1dd27SAsmitha Karunanithi } 5475cb1dd27SAsmitha Karunanithi 5485cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 549fdd26906SClaire Weinan [asyncResp, entryID, dumpType, 550fdd26906SClaire Weinan entriesPath](const boost::system::error_code ec, 55102cad96eSEd Tanous const dbus::utility::ManagedObjectType& resp) { 5525cb1dd27SAsmitha Karunanithi if (ec) 5535cb1dd27SAsmitha Karunanithi { 5545cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 5555cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5565cb1dd27SAsmitha Karunanithi return; 5575cb1dd27SAsmitha Karunanithi } 5585cb1dd27SAsmitha Karunanithi 559b47452b2SAsmitha Karunanithi bool foundDumpEntry = false; 560b47452b2SAsmitha Karunanithi std::string dumpEntryPath = 561b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 562002d39b4SEd Tanous std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/"; 563b47452b2SAsmitha Karunanithi 5649eb808c1SEd Tanous for (const auto& objectPath : resp) 5655cb1dd27SAsmitha Karunanithi { 566b47452b2SAsmitha Karunanithi if (objectPath.first.str != dumpEntryPath + entryID) 5675cb1dd27SAsmitha Karunanithi { 5685cb1dd27SAsmitha Karunanithi continue; 5695cb1dd27SAsmitha Karunanithi } 5705cb1dd27SAsmitha Karunanithi 5715cb1dd27SAsmitha Karunanithi foundDumpEntry = true; 572c6fecdabSClaire Weinan uint64_t timestampUs = 0; 5735cb1dd27SAsmitha Karunanithi uint64_t size = 0; 57435440d18SAsmitha Karunanithi std::string dumpStatus; 5755cb1dd27SAsmitha Karunanithi 576aefe3786SClaire Weinan parseDumpEntryFromDbusObject(objectPath, dumpStatus, size, 577c6fecdabSClaire Weinan timestampUs, asyncResp); 5785cb1dd27SAsmitha Karunanithi 5790fda0f12SGeorge Liu if (dumpStatus != 5800fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 58135440d18SAsmitha Karunanithi !dumpStatus.empty()) 58235440d18SAsmitha Karunanithi { 58335440d18SAsmitha Karunanithi // Dump status is not Complete 58435440d18SAsmitha Karunanithi // return not found until status is changed to Completed 585d1bde9e5SKrzysztof Grobelny messages::resourceNotFound(asyncResp->res, dumpType + " dump", 586d1bde9e5SKrzysztof Grobelny entryID); 58735440d18SAsmitha Karunanithi return; 58835440d18SAsmitha Karunanithi } 58935440d18SAsmitha Karunanithi 5905cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 591*9c11a172SVijay Lobo "#LogEntry.v1_9_0.LogEntry"; 592fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = entriesPath + entryID; 5935cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = entryID; 5945cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["EntryType"] = "Event"; 5955cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry"; 5965cb1dd27SAsmitha Karunanithi 5975cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 5985cb1dd27SAsmitha Karunanithi { 599c6fecdabSClaire Weinan asyncResp->res.jsonValue["Created"] = 600c6fecdabSClaire Weinan redfish::time_utils::getDateTimeUint(timestampUs / 1000 / 601c6fecdabSClaire Weinan 1000); 602d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager"; 603d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 604fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 605fdd26906SClaire Weinan asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 6065cb1dd27SAsmitha Karunanithi } 607c6fecdabSClaire Weinan else if (dumpType == "FaultLog") 608c6fecdabSClaire Weinan { 609c6fecdabSClaire Weinan asyncResp->res.jsonValue["Created"] = 610c6fecdabSClaire Weinan redfish::time_utils::getDateTimeUintUs(timestampUs); 611c6fecdabSClaire Weinan } 6125cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 6135cb1dd27SAsmitha Karunanithi { 614c6fecdabSClaire Weinan asyncResp->res.jsonValue["Created"] = 615c6fecdabSClaire Weinan redfish::time_utils::getDateTimeUint(timestampUs / 1000 / 616c6fecdabSClaire Weinan 1000); 617d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM"; 618002d39b4SEd Tanous asyncResp->res.jsonValue["OEMDiagnosticDataType"] = "System"; 619d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 620fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 621fdd26906SClaire Weinan asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 6225cb1dd27SAsmitha Karunanithi } 6235cb1dd27SAsmitha Karunanithi } 624e05aec50SEd Tanous if (!foundDumpEntry) 625b47452b2SAsmitha Karunanithi { 626b47452b2SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Can't find Dump Entry"; 627b47452b2SAsmitha Karunanithi messages::internalError(asyncResp->res); 628b47452b2SAsmitha Karunanithi return; 629b47452b2SAsmitha Karunanithi } 6305cb1dd27SAsmitha Karunanithi }, 6315cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 6325cb1dd27SAsmitha Karunanithi "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 6335cb1dd27SAsmitha Karunanithi } 6345cb1dd27SAsmitha Karunanithi 6358d1b46d7Szhanghch05 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 6369878256fSStanley Chu const std::string& entryID, 637b47452b2SAsmitha Karunanithi const std::string& dumpType) 6385cb1dd27SAsmitha Karunanithi { 639002d39b4SEd Tanous auto respHandler = 640002d39b4SEd Tanous [asyncResp, entryID](const boost::system::error_code ec) { 6415cb1dd27SAsmitha Karunanithi BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done"; 6425cb1dd27SAsmitha Karunanithi if (ec) 6435cb1dd27SAsmitha Karunanithi { 6443de8d8baSGeorge Liu if (ec.value() == EBADR) 6453de8d8baSGeorge Liu { 6463de8d8baSGeorge Liu messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 6473de8d8baSGeorge Liu return; 6483de8d8baSGeorge Liu } 6495cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error " 650fdd26906SClaire Weinan << ec << " entryID=" << entryID; 6515cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6525cb1dd27SAsmitha Karunanithi return; 6535cb1dd27SAsmitha Karunanithi } 6545cb1dd27SAsmitha Karunanithi }; 6555cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 6565cb1dd27SAsmitha Karunanithi respHandler, "xyz.openbmc_project.Dump.Manager", 657b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 658b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/" + 659b47452b2SAsmitha Karunanithi entryID, 6605cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Object.Delete", "Delete"); 6615cb1dd27SAsmitha Karunanithi } 6625cb1dd27SAsmitha Karunanithi 6638d1b46d7Szhanghch05 inline void 66498be3e39SEd Tanous createDumpTaskCallback(task::Payload&& payload, 6658d1b46d7Szhanghch05 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 6668d1b46d7Szhanghch05 const uint32_t& dumpId, const std::string& dumpPath, 667a43be80fSAsmitha Karunanithi const std::string& dumpType) 668a43be80fSAsmitha Karunanithi { 669a43be80fSAsmitha Karunanithi std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 67059d494eeSPatrick Williams [dumpId, dumpPath, 67159d494eeSPatrick Williams dumpType](boost::system::error_code err, sdbusplus::message_t& m, 672a43be80fSAsmitha Karunanithi const std::shared_ptr<task::TaskData>& taskData) { 673cb13a392SEd Tanous if (err) 674cb13a392SEd Tanous { 6756145ed6fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Error in creating a dump"; 6766145ed6fSAsmitha Karunanithi taskData->state = "Cancelled"; 6776145ed6fSAsmitha Karunanithi return task::completed; 678cb13a392SEd Tanous } 679b9d36b47SEd Tanous 680b9d36b47SEd Tanous dbus::utility::DBusInteracesMap interfacesList; 681a43be80fSAsmitha Karunanithi 682a43be80fSAsmitha Karunanithi sdbusplus::message::object_path objPath; 683a43be80fSAsmitha Karunanithi 684a43be80fSAsmitha Karunanithi m.read(objPath, interfacesList); 685a43be80fSAsmitha Karunanithi 686b47452b2SAsmitha Karunanithi if (objPath.str == 687b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 688b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)) + 689b47452b2SAsmitha Karunanithi "/entry/" + std::to_string(dumpId)) 690a43be80fSAsmitha Karunanithi { 691a43be80fSAsmitha Karunanithi nlohmann::json retMessage = messages::success(); 692a43be80fSAsmitha Karunanithi taskData->messages.emplace_back(retMessage); 693a43be80fSAsmitha Karunanithi 694a43be80fSAsmitha Karunanithi std::string headerLoc = 695a43be80fSAsmitha Karunanithi "Location: " + dumpPath + std::to_string(dumpId); 696002d39b4SEd Tanous taskData->payload->httpHeaders.emplace_back(std::move(headerLoc)); 697a43be80fSAsmitha Karunanithi 698a43be80fSAsmitha Karunanithi taskData->state = "Completed"; 699b47452b2SAsmitha Karunanithi return task::completed; 7006145ed6fSAsmitha Karunanithi } 701a43be80fSAsmitha Karunanithi return task::completed; 702a43be80fSAsmitha Karunanithi }, 7034978b63fSJason M. Bills "type='signal',interface='org.freedesktop.DBus.ObjectManager'," 704a43be80fSAsmitha Karunanithi "member='InterfacesAdded', " 705a43be80fSAsmitha Karunanithi "path='/xyz/openbmc_project/dump'"); 706a43be80fSAsmitha Karunanithi 707a43be80fSAsmitha Karunanithi task->startTimer(std::chrono::minutes(3)); 708a43be80fSAsmitha Karunanithi task->populateResp(asyncResp->res); 70998be3e39SEd Tanous task->payload.emplace(std::move(payload)); 710a43be80fSAsmitha Karunanithi } 711a43be80fSAsmitha Karunanithi 7128d1b46d7Szhanghch05 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 7138d1b46d7Szhanghch05 const crow::Request& req, const std::string& dumpType) 714a43be80fSAsmitha Karunanithi { 715fdd26906SClaire Weinan std::string dumpPath = getDumpEntriesPath(dumpType); 716fdd26906SClaire Weinan if (dumpPath.empty()) 717a43be80fSAsmitha Karunanithi { 718a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 719a43be80fSAsmitha Karunanithi return; 720a43be80fSAsmitha Karunanithi } 721a43be80fSAsmitha Karunanithi 722a43be80fSAsmitha Karunanithi std::optional<std::string> diagnosticDataType; 723a43be80fSAsmitha Karunanithi std::optional<std::string> oemDiagnosticDataType; 724a43be80fSAsmitha Karunanithi 72515ed6780SWilly Tu if (!redfish::json_util::readJsonAction( 726a43be80fSAsmitha Karunanithi req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 727a43be80fSAsmitha Karunanithi "OEMDiagnosticDataType", oemDiagnosticDataType)) 728a43be80fSAsmitha Karunanithi { 729a43be80fSAsmitha Karunanithi return; 730a43be80fSAsmitha Karunanithi } 731a43be80fSAsmitha Karunanithi 732a43be80fSAsmitha Karunanithi if (dumpType == "System") 733a43be80fSAsmitha Karunanithi { 734a43be80fSAsmitha Karunanithi if (!oemDiagnosticDataType || !diagnosticDataType) 735a43be80fSAsmitha Karunanithi { 7364978b63fSJason M. Bills BMCWEB_LOG_ERROR 7374978b63fSJason M. Bills << "CreateDump action parameter 'DiagnosticDataType'/'OEMDiagnosticDataType' value not found!"; 738a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 739a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", 740a43be80fSAsmitha Karunanithi "DiagnosticDataType & OEMDiagnosticDataType"); 741a43be80fSAsmitha Karunanithi return; 742a43be80fSAsmitha Karunanithi } 7433174e4dfSEd Tanous if ((*oemDiagnosticDataType != "System") || 744a43be80fSAsmitha Karunanithi (*diagnosticDataType != "OEM")) 745a43be80fSAsmitha Karunanithi { 746a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Wrong parameter values passed"; 747ace85d60SEd Tanous messages::internalError(asyncResp->res); 748a43be80fSAsmitha Karunanithi return; 749a43be80fSAsmitha Karunanithi } 7505907571dSAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/"; 751a43be80fSAsmitha Karunanithi } 752a43be80fSAsmitha Karunanithi else if (dumpType == "BMC") 753a43be80fSAsmitha Karunanithi { 754a43be80fSAsmitha Karunanithi if (!diagnosticDataType) 755a43be80fSAsmitha Karunanithi { 7560fda0f12SGeorge Liu BMCWEB_LOG_ERROR 7570fda0f12SGeorge Liu << "CreateDump action parameter 'DiagnosticDataType' not found!"; 758a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 759a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType"); 760a43be80fSAsmitha Karunanithi return; 761a43be80fSAsmitha Karunanithi } 7623174e4dfSEd Tanous if (*diagnosticDataType != "Manager") 763a43be80fSAsmitha Karunanithi { 764a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR 765a43be80fSAsmitha Karunanithi << "Wrong parameter value passed for 'DiagnosticDataType'"; 766ace85d60SEd Tanous messages::internalError(asyncResp->res); 767a43be80fSAsmitha Karunanithi return; 768a43be80fSAsmitha Karunanithi } 7695907571dSAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/"; 7705907571dSAsmitha Karunanithi } 7715907571dSAsmitha Karunanithi else 7725907571dSAsmitha Karunanithi { 7735907571dSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump failed. Unknown dump type"; 7745907571dSAsmitha Karunanithi messages::internalError(asyncResp->res); 7755907571dSAsmitha Karunanithi return; 776a43be80fSAsmitha Karunanithi } 777a43be80fSAsmitha Karunanithi 778a43be80fSAsmitha Karunanithi crow::connections::systemBus->async_method_call( 77998be3e39SEd Tanous [asyncResp, payload(task::Payload(req)), dumpPath, 78098be3e39SEd Tanous dumpType](const boost::system::error_code ec, 7815907571dSAsmitha Karunanithi const sdbusplus::message::message& msg, 78298be3e39SEd Tanous const uint32_t& dumpId) mutable { 783a43be80fSAsmitha Karunanithi if (ec) 784a43be80fSAsmitha Karunanithi { 785a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec; 7865907571dSAsmitha Karunanithi const sd_bus_error* dbusError = msg.get_error(); 7875907571dSAsmitha Karunanithi if (dbusError == nullptr) 7885907571dSAsmitha Karunanithi { 7895907571dSAsmitha Karunanithi messages::internalError(asyncResp->res); 7905907571dSAsmitha Karunanithi return; 7915907571dSAsmitha Karunanithi } 7925907571dSAsmitha Karunanithi 7935907571dSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump DBus error: " << dbusError->name 7945907571dSAsmitha Karunanithi << " and error msg: " << dbusError->message; 7955907571dSAsmitha Karunanithi if (std::string_view( 7965907571dSAsmitha Karunanithi "xyz.openbmc_project.Common.Error.NotAllowed") == 7975907571dSAsmitha Karunanithi dbusError->name) 7985907571dSAsmitha Karunanithi { 7995907571dSAsmitha Karunanithi messages::resourceInStandby(asyncResp->res); 8005907571dSAsmitha Karunanithi return; 8015907571dSAsmitha Karunanithi } 8025907571dSAsmitha Karunanithi if (std::string_view( 8035907571dSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create.Error.Disabled") == 8045907571dSAsmitha Karunanithi dbusError->name) 8055907571dSAsmitha Karunanithi { 8065907571dSAsmitha Karunanithi messages::serviceDisabled(asyncResp->res, dumpPath); 8075907571dSAsmitha Karunanithi return; 8085907571dSAsmitha Karunanithi } 8095907571dSAsmitha Karunanithi if (std::string_view( 8105907571dSAsmitha Karunanithi "xyz.openbmc_project.Common.Error.Unavailable") == 8115907571dSAsmitha Karunanithi dbusError->name) 8125907571dSAsmitha Karunanithi { 8135907571dSAsmitha Karunanithi messages::resourceInUse(asyncResp->res); 8145907571dSAsmitha Karunanithi return; 8155907571dSAsmitha Karunanithi } 8165907571dSAsmitha Karunanithi // Other Dbus errors such as: 8175907571dSAsmitha Karunanithi // xyz.openbmc_project.Common.Error.InvalidArgument & 8185907571dSAsmitha Karunanithi // org.freedesktop.DBus.Error.InvalidArgs are all related to 8195907571dSAsmitha Karunanithi // the dbus call that is made here in the bmcweb 8205907571dSAsmitha Karunanithi // implementation and has nothing to do with the client's 8215907571dSAsmitha Karunanithi // input in the request. Hence, returning internal error 8225907571dSAsmitha Karunanithi // back to the client. 823a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 824a43be80fSAsmitha Karunanithi return; 825a43be80fSAsmitha Karunanithi } 826a43be80fSAsmitha Karunanithi BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId; 827a43be80fSAsmitha Karunanithi 828002d39b4SEd Tanous createDumpTaskCallback(std::move(payload), asyncResp, dumpId, dumpPath, 829002d39b4SEd Tanous dumpType); 830a43be80fSAsmitha Karunanithi }, 831b47452b2SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", 832b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 833b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)), 834a43be80fSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create", "CreateDump"); 835a43be80fSAsmitha Karunanithi } 836a43be80fSAsmitha Karunanithi 8378d1b46d7Szhanghch05 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 8388d1b46d7Szhanghch05 const std::string& dumpType) 83980319af1SAsmitha Karunanithi { 840b47452b2SAsmitha Karunanithi std::string dumpTypeLowerCopy = 841b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)); 8428d1b46d7Szhanghch05 84380319af1SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 844b9d36b47SEd Tanous [asyncResp, dumpType]( 845b9d36b47SEd Tanous const boost::system::error_code ec, 846b9d36b47SEd Tanous const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 84780319af1SAsmitha Karunanithi if (ec) 84880319af1SAsmitha Karunanithi { 84980319af1SAsmitha Karunanithi BMCWEB_LOG_ERROR << "resp_handler got error " << ec; 85080319af1SAsmitha Karunanithi messages::internalError(asyncResp->res); 85180319af1SAsmitha Karunanithi return; 85280319af1SAsmitha Karunanithi } 85380319af1SAsmitha Karunanithi 85480319af1SAsmitha Karunanithi for (const std::string& path : subTreePaths) 85580319af1SAsmitha Karunanithi { 8562dfd18efSEd Tanous sdbusplus::message::object_path objPath(path); 8572dfd18efSEd Tanous std::string logID = objPath.filename(); 8582dfd18efSEd Tanous if (logID.empty()) 85980319af1SAsmitha Karunanithi { 8602dfd18efSEd Tanous continue; 86180319af1SAsmitha Karunanithi } 8622dfd18efSEd Tanous deleteDumpEntry(asyncResp, logID, dumpType); 86380319af1SAsmitha Karunanithi } 86480319af1SAsmitha Karunanithi }, 86580319af1SAsmitha Karunanithi "xyz.openbmc_project.ObjectMapper", 86680319af1SAsmitha Karunanithi "/xyz/openbmc_project/object_mapper", 86780319af1SAsmitha Karunanithi "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 868b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + dumpTypeLowerCopy, 0, 869b47452b2SAsmitha Karunanithi std::array<std::string, 1>{"xyz.openbmc_project.Dump.Entry." + 870b47452b2SAsmitha Karunanithi dumpType}); 87180319af1SAsmitha Karunanithi } 87280319af1SAsmitha Karunanithi 873b9d36b47SEd Tanous inline static void 874b9d36b47SEd Tanous parseCrashdumpParameters(const dbus::utility::DBusPropertiesMap& params, 875b9d36b47SEd Tanous std::string& filename, std::string& timestamp, 876b9d36b47SEd Tanous std::string& logfile) 877043a0536SJohnathan Mantey { 878d1bde9e5SKrzysztof Grobelny const std::string* filenamePtr = nullptr; 879d1bde9e5SKrzysztof Grobelny const std::string* timestampPtr = nullptr; 880d1bde9e5SKrzysztof Grobelny const std::string* logfilePtr = nullptr; 881d1bde9e5SKrzysztof Grobelny 882d1bde9e5SKrzysztof Grobelny const bool success = sdbusplus::unpackPropertiesNoThrow( 883d1bde9e5SKrzysztof Grobelny dbus_utils::UnpackErrorPrinter(), params, "Timestamp", timestampPtr, 884d1bde9e5SKrzysztof Grobelny "Filename", filenamePtr, "Log", logfilePtr); 885d1bde9e5SKrzysztof Grobelny 886d1bde9e5SKrzysztof Grobelny if (!success) 887043a0536SJohnathan Mantey { 888d1bde9e5SKrzysztof Grobelny return; 889043a0536SJohnathan Mantey } 890d1bde9e5SKrzysztof Grobelny 891d1bde9e5SKrzysztof Grobelny if (filenamePtr != nullptr) 892043a0536SJohnathan Mantey { 893d1bde9e5SKrzysztof Grobelny filename = *filenamePtr; 894d1bde9e5SKrzysztof Grobelny } 895d1bde9e5SKrzysztof Grobelny 896d1bde9e5SKrzysztof Grobelny if (timestampPtr != nullptr) 897043a0536SJohnathan Mantey { 898d1bde9e5SKrzysztof Grobelny timestamp = *timestampPtr; 899043a0536SJohnathan Mantey } 900d1bde9e5SKrzysztof Grobelny 901d1bde9e5SKrzysztof Grobelny if (logfilePtr != nullptr) 902043a0536SJohnathan Mantey { 903d1bde9e5SKrzysztof Grobelny logfile = *logfilePtr; 904043a0536SJohnathan Mantey } 905043a0536SJohnathan Mantey } 906043a0536SJohnathan Mantey 907a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode"; 9087e860f15SJohn Edward Broadbent inline void requestRoutesSystemLogServiceCollection(App& app) 9091da66f75SEd Tanous { 910c4bf6374SJason M. Bills /** 911c4bf6374SJason M. Bills * Functions triggers appropriate requests on DBus 912c4bf6374SJason M. Bills */ 9137e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/") 914ed398213SEd Tanous .privileges(redfish::privileges::getLogServiceCollection) 915002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 916002d39b4SEd Tanous [&app](const crow::Request& req, 917002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 9183ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 919c4bf6374SJason M. Bills { 92045ca1b86SEd Tanous return; 92145ca1b86SEd Tanous } 9227e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 9237e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 924c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 925c4bf6374SJason M. Bills "#LogServiceCollection.LogServiceCollection"; 926c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 927029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices"; 92845ca1b86SEd Tanous asyncResp->res.jsonValue["Name"] = "System Log Services Collection"; 929c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 930c4bf6374SJason M. Bills "Collection of LogServices for this Computer System"; 931002d39b4SEd Tanous nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 932c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 9331476687dSEd Tanous nlohmann::json::object_t eventLog; 9341476687dSEd Tanous eventLog["@odata.id"] = 9351476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 9361476687dSEd Tanous logServiceArray.push_back(std::move(eventLog)); 9375cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 9381476687dSEd Tanous nlohmann::json::object_t dumpLog; 939002d39b4SEd Tanous dumpLog["@odata.id"] = "/redfish/v1/Systems/system/LogServices/Dump"; 9401476687dSEd Tanous logServiceArray.push_back(std::move(dumpLog)); 941c9bb6861Sraviteja-b #endif 942c9bb6861Sraviteja-b 943d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG 9441476687dSEd Tanous nlohmann::json::object_t crashdump; 9451476687dSEd Tanous crashdump["@odata.id"] = 9461476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump"; 9471476687dSEd Tanous logServiceArray.push_back(std::move(crashdump)); 948d53dd41fSJason M. Bills #endif 949b7028ebfSSpencer Ku 950b7028ebfSSpencer Ku #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER 9511476687dSEd Tanous nlohmann::json::object_t hostlogger; 9521476687dSEd Tanous hostlogger["@odata.id"] = 9531476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger"; 9541476687dSEd Tanous logServiceArray.push_back(std::move(hostlogger)); 955b7028ebfSSpencer Ku #endif 956c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 957c4bf6374SJason M. Bills logServiceArray.size(); 958a3316fc6SZhikuiRen 959a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 96045ca1b86SEd Tanous [asyncResp](const boost::system::error_code ec, 961b9d36b47SEd Tanous const dbus::utility::MapperGetSubTreePathsResponse& 962b9d36b47SEd Tanous subtreePath) { 963a3316fc6SZhikuiRen if (ec) 964a3316fc6SZhikuiRen { 965a3316fc6SZhikuiRen BMCWEB_LOG_ERROR << ec; 966a3316fc6SZhikuiRen return; 967a3316fc6SZhikuiRen } 968a3316fc6SZhikuiRen 96955f79e6fSEd Tanous for (const auto& pathStr : subtreePath) 970a3316fc6SZhikuiRen { 971a3316fc6SZhikuiRen if (pathStr.find("PostCode") != std::string::npos) 972a3316fc6SZhikuiRen { 97323a21a1cSEd Tanous nlohmann::json& logServiceArrayLocal = 974a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"]; 975613dabeaSEd Tanous nlohmann::json::object_t member; 976613dabeaSEd Tanous member["@odata.id"] = 977613dabeaSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes"; 978613dabeaSEd Tanous 979613dabeaSEd Tanous logServiceArrayLocal.push_back(std::move(member)); 980613dabeaSEd Tanous 98145ca1b86SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = 98223a21a1cSEd Tanous logServiceArrayLocal.size(); 983a3316fc6SZhikuiRen return; 984a3316fc6SZhikuiRen } 985a3316fc6SZhikuiRen } 986a3316fc6SZhikuiRen }, 987a3316fc6SZhikuiRen "xyz.openbmc_project.ObjectMapper", 988a3316fc6SZhikuiRen "/xyz/openbmc_project/object_mapper", 98945ca1b86SEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 0, 99045ca1b86SEd Tanous std::array<const char*, 1>{postCodeIface}); 9917e860f15SJohn Edward Broadbent }); 992c4bf6374SJason M. Bills } 993c4bf6374SJason M. Bills 9947e860f15SJohn Edward Broadbent inline void requestRoutesEventLogService(App& app) 995c4bf6374SJason M. Bills { 9967e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/") 997ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 998002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 999002d39b4SEd Tanous [&app](const crow::Request& req, 1000002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 10013ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 100245ca1b86SEd Tanous { 100345ca1b86SEd Tanous return; 100445ca1b86SEd Tanous } 1005c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1006029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 1007c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1008c4bf6374SJason M. Bills "#LogService.v1_1_0.LogService"; 1009c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "Event Log Service"; 1010002d39b4SEd Tanous asyncResp->res.jsonValue["Description"] = "System Event Log Service"; 1011c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "EventLog"; 1012c4bf6374SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 10137c8c4058STejas Patil 10147c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 10152b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 10167c8c4058STejas Patil 10177c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 10187c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 10197c8c4058STejas Patil redfishDateTimeOffset.second; 10207c8c4058STejas Patil 10211476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 10221476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1023e7d6c8b2SGunnar Mills asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 1024e7d6c8b2SGunnar Mills 10250fda0f12SGeorge Liu {"target", 10260fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog"}}; 10277e860f15SJohn Edward Broadbent }); 1028489640c6SJason M. Bills } 1029489640c6SJason M. Bills 10307e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogClear(App& app) 1031489640c6SJason M. Bills { 10324978b63fSJason M. Bills BMCWEB_ROUTE( 10334978b63fSJason M. Bills app, 10344978b63fSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog/") 1035432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 10367e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 103745ca1b86SEd Tanous [&app](const crow::Request& req, 10387e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 10393ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 104045ca1b86SEd Tanous { 104145ca1b86SEd Tanous return; 104245ca1b86SEd Tanous } 1043489640c6SJason M. Bills // Clear the EventLog by deleting the log files 1044489640c6SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1045489640c6SJason M. Bills if (getRedfishLogFiles(redfishLogFiles)) 1046489640c6SJason M. Bills { 1047489640c6SJason M. Bills for (const std::filesystem::path& file : redfishLogFiles) 1048489640c6SJason M. Bills { 1049489640c6SJason M. Bills std::error_code ec; 1050489640c6SJason M. Bills std::filesystem::remove(file, ec); 1051489640c6SJason M. Bills } 1052489640c6SJason M. Bills } 1053489640c6SJason M. Bills 1054489640c6SJason M. Bills // Reload rsyslog so it knows to start new log files 1055489640c6SJason M. Bills crow::connections::systemBus->async_method_call( 1056489640c6SJason M. Bills [asyncResp](const boost::system::error_code ec) { 1057489640c6SJason M. Bills if (ec) 1058489640c6SJason M. Bills { 1059002d39b4SEd Tanous BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec; 1060489640c6SJason M. Bills messages::internalError(asyncResp->res); 1061489640c6SJason M. Bills return; 1062489640c6SJason M. Bills } 1063489640c6SJason M. Bills 1064489640c6SJason M. Bills messages::success(asyncResp->res); 1065489640c6SJason M. Bills }, 1066489640c6SJason M. Bills "org.freedesktop.systemd1", "/org/freedesktop/systemd1", 1067002d39b4SEd Tanous "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service", 1068002d39b4SEd Tanous "replace"); 10697e860f15SJohn Edward Broadbent }); 1070c4bf6374SJason M. Bills } 1071c4bf6374SJason M. Bills 1072ac992cdeSJason M. Bills enum class LogParseError 1073ac992cdeSJason M. Bills { 1074ac992cdeSJason M. Bills success, 1075ac992cdeSJason M. Bills parseFailed, 1076ac992cdeSJason M. Bills messageIdNotInRegistry, 1077ac992cdeSJason M. Bills }; 1078ac992cdeSJason M. Bills 1079ac992cdeSJason M. Bills static LogParseError 1080ac992cdeSJason M. Bills fillEventLogEntryJson(const std::string& logEntryID, 1081b5a76932SEd Tanous const std::string& logEntry, 1082de703c5dSJason M. Bills nlohmann::json::object_t& logEntryJson) 1083c4bf6374SJason M. Bills { 108495820184SJason M. Bills // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1085cd225da8SJason M. Bills // First get the Timestamp 1086f23b7296SEd Tanous size_t space = logEntry.find_first_of(' '); 1087cd225da8SJason M. Bills if (space == std::string::npos) 108895820184SJason M. Bills { 1089ac992cdeSJason M. Bills return LogParseError::parseFailed; 109095820184SJason M. Bills } 1091cd225da8SJason M. Bills std::string timestamp = logEntry.substr(0, space); 1092cd225da8SJason M. Bills // Then get the log contents 1093f23b7296SEd Tanous size_t entryStart = logEntry.find_first_not_of(' ', space); 1094cd225da8SJason M. Bills if (entryStart == std::string::npos) 1095cd225da8SJason M. Bills { 1096ac992cdeSJason M. Bills return LogParseError::parseFailed; 1097cd225da8SJason M. Bills } 1098cd225da8SJason M. Bills std::string_view entry(logEntry); 1099cd225da8SJason M. Bills entry.remove_prefix(entryStart); 1100cd225da8SJason M. Bills // Use split to separate the entry into its fields 1101cd225da8SJason M. Bills std::vector<std::string> logEntryFields; 1102cd225da8SJason M. Bills boost::split(logEntryFields, entry, boost::is_any_of(","), 1103cd225da8SJason M. Bills boost::token_compress_on); 1104cd225da8SJason M. Bills // We need at least a MessageId to be valid 110526f6976fSEd Tanous if (logEntryFields.empty()) 1106cd225da8SJason M. Bills { 1107ac992cdeSJason M. Bills return LogParseError::parseFailed; 1108cd225da8SJason M. Bills } 1109cd225da8SJason M. Bills std::string& messageID = logEntryFields[0]; 111095820184SJason M. Bills 11114851d45dSJason M. Bills // Get the Message from the MessageRegistry 1112fffb8c1fSEd Tanous const registries::Message* message = registries::getMessage(messageID); 1113c4bf6374SJason M. Bills 111454417b02SSui Chen if (message == nullptr) 1115c4bf6374SJason M. Bills { 111654417b02SSui Chen BMCWEB_LOG_WARNING << "Log entry not found in registry: " << logEntry; 1117ac992cdeSJason M. Bills return LogParseError::messageIdNotInRegistry; 1118c4bf6374SJason M. Bills } 1119c4bf6374SJason M. Bills 112054417b02SSui Chen std::string msg = message->message; 112154417b02SSui Chen 112215a86ff6SJason M. Bills // Get the MessageArgs from the log if there are any 112326702d01SEd Tanous std::span<std::string> messageArgs; 112415a86ff6SJason M. Bills if (logEntryFields.size() > 1) 112515a86ff6SJason M. Bills { 112615a86ff6SJason M. Bills std::string& messageArgsStart = logEntryFields[1]; 112715a86ff6SJason M. Bills // If the first string is empty, assume there are no MessageArgs 112815a86ff6SJason M. Bills std::size_t messageArgsSize = 0; 112915a86ff6SJason M. Bills if (!messageArgsStart.empty()) 113015a86ff6SJason M. Bills { 113115a86ff6SJason M. Bills messageArgsSize = logEntryFields.size() - 1; 113215a86ff6SJason M. Bills } 113315a86ff6SJason M. Bills 113423a21a1cSEd Tanous messageArgs = {&messageArgsStart, messageArgsSize}; 1135c4bf6374SJason M. Bills 11364851d45dSJason M. Bills // Fill the MessageArgs into the Message 113795820184SJason M. Bills int i = 0; 113895820184SJason M. Bills for (const std::string& messageArg : messageArgs) 11394851d45dSJason M. Bills { 114095820184SJason M. Bills std::string argStr = "%" + std::to_string(++i); 11414851d45dSJason M. Bills size_t argPos = msg.find(argStr); 11424851d45dSJason M. Bills if (argPos != std::string::npos) 11434851d45dSJason M. Bills { 114495820184SJason M. Bills msg.replace(argPos, argStr.length(), messageArg); 11454851d45dSJason M. Bills } 11464851d45dSJason M. Bills } 114715a86ff6SJason M. Bills } 11484851d45dSJason M. Bills 114995820184SJason M. Bills // Get the Created time from the timestamp. The log timestamp is in RFC3339 115095820184SJason M. Bills // format which matches the Redfish format except for the fractional seconds 115195820184SJason M. Bills // between the '.' and the '+', so just remove them. 1152f23b7296SEd Tanous std::size_t dot = timestamp.find_first_of('.'); 1153f23b7296SEd Tanous std::size_t plus = timestamp.find_first_of('+'); 115495820184SJason M. Bills if (dot != std::string::npos && plus != std::string::npos) 1155c4bf6374SJason M. Bills { 115695820184SJason M. Bills timestamp.erase(dot, plus - dot); 1157c4bf6374SJason M. Bills } 1158c4bf6374SJason M. Bills 1159c4bf6374SJason M. Bills // Fill in the log entry with the gathered data 1160*9c11a172SVijay Lobo logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 116184afc48bSJason M. Bills logEntryJson["@odata.id"] = 116284afc48bSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + logEntryID; 116384afc48bSJason M. Bills logEntryJson["Name"] = "System Event Log Entry"; 116484afc48bSJason M. Bills logEntryJson["Id"] = logEntryID; 116584afc48bSJason M. Bills logEntryJson["Message"] = std::move(msg); 116684afc48bSJason M. Bills logEntryJson["MessageId"] = std::move(messageID); 116784afc48bSJason M. Bills logEntryJson["MessageArgs"] = messageArgs; 116884afc48bSJason M. Bills logEntryJson["EntryType"] = "Event"; 116984afc48bSJason M. Bills logEntryJson["Severity"] = message->messageSeverity; 117084afc48bSJason M. Bills logEntryJson["Created"] = std::move(timestamp); 1171ac992cdeSJason M. Bills return LogParseError::success; 1172c4bf6374SJason M. Bills } 1173c4bf6374SJason M. Bills 11747e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntryCollection(App& app) 1175c4bf6374SJason M. Bills { 11767e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 11777e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") 11788b6a35f0SGunnar Mills .privileges(redfish::privileges::getLogEntryCollection) 1179002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1180002d39b4SEd Tanous [&app](const crow::Request& req, 1181002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1182c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 1183c937d2bfSEd Tanous .canDelegateTop = true, 1184c937d2bfSEd Tanous .canDelegateSkip = true, 1185c937d2bfSEd Tanous }; 1186c937d2bfSEd Tanous query_param::Query delegatedQuery; 1187c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 11883ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 1189c4bf6374SJason M. Bills { 1190c4bf6374SJason M. Bills return; 1191c4bf6374SJason M. Bills } 11925143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 11933648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 11943648c8beSEd Tanous 11957e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 11967e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1197c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1198c4bf6374SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 1199c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1200029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1201c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 1202c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 1203c4bf6374SJason M. Bills "Collection of System Event Log Entries"; 1204cb92c03bSAndrew Geissler 12054978b63fSJason M. Bills nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1206c4bf6374SJason M. Bills logEntryArray = nlohmann::json::array(); 12077e860f15SJohn Edward Broadbent // Go through the log files and create a unique ID for each 12087e860f15SJohn Edward Broadbent // entry 120995820184SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 121095820184SJason M. Bills getRedfishLogFiles(redfishLogFiles); 1211b01bf299SEd Tanous uint64_t entryCount = 0; 1212cd225da8SJason M. Bills std::string logEntry; 121395820184SJason M. Bills 12147e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 12157e860f15SJohn Edward Broadbent // backwards 1216002d39b4SEd Tanous for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1217002d39b4SEd Tanous it++) 1218c4bf6374SJason M. Bills { 1219cd225da8SJason M. Bills std::ifstream logStream(*it); 122095820184SJason M. Bills if (!logStream.is_open()) 1221c4bf6374SJason M. Bills { 1222c4bf6374SJason M. Bills continue; 1223c4bf6374SJason M. Bills } 1224c4bf6374SJason M. Bills 1225e85d6b16SJason M. Bills // Reset the unique ID on the first entry 1226e85d6b16SJason M. Bills bool firstEntry = true; 122795820184SJason M. Bills while (std::getline(logStream, logEntry)) 122895820184SJason M. Bills { 1229c4bf6374SJason M. Bills std::string idStr; 1230e85d6b16SJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1231c4bf6374SJason M. Bills { 1232c4bf6374SJason M. Bills continue; 1233c4bf6374SJason M. Bills } 1234e85d6b16SJason M. Bills firstEntry = false; 1235e85d6b16SJason M. Bills 1236de703c5dSJason M. Bills nlohmann::json::object_t bmcLogEntry; 1237ac992cdeSJason M. Bills LogParseError status = 1238ac992cdeSJason M. Bills fillEventLogEntryJson(idStr, logEntry, bmcLogEntry); 1239ac992cdeSJason M. Bills if (status == LogParseError::messageIdNotInRegistry) 1240ac992cdeSJason M. Bills { 1241ac992cdeSJason M. Bills continue; 1242ac992cdeSJason M. Bills } 1243ac992cdeSJason M. Bills if (status != LogParseError::success) 1244c4bf6374SJason M. Bills { 1245c4bf6374SJason M. Bills messages::internalError(asyncResp->res); 1246c4bf6374SJason M. Bills return; 1247c4bf6374SJason M. Bills } 1248de703c5dSJason M. Bills 1249de703c5dSJason M. Bills entryCount++; 1250de703c5dSJason M. Bills // Handle paging using skip (number of entries to skip from the 1251de703c5dSJason M. Bills // start) and top (number of entries to display) 12523648c8beSEd Tanous if (entryCount <= skip || entryCount > skip + top) 1253de703c5dSJason M. Bills { 1254de703c5dSJason M. Bills continue; 1255de703c5dSJason M. Bills } 1256de703c5dSJason M. Bills 1257de703c5dSJason M. Bills logEntryArray.push_back(std::move(bmcLogEntry)); 1258c4bf6374SJason M. Bills } 125995820184SJason M. Bills } 1260c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 12613648c8beSEd Tanous if (skip + top < entryCount) 1262c4bf6374SJason M. Bills { 1263c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 12644978b63fSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries?$skip=" + 12653648c8beSEd Tanous std::to_string(skip + top); 1266c4bf6374SJason M. Bills } 12677e860f15SJohn Edward Broadbent }); 1268897967deSJason M. Bills } 1269897967deSJason M. Bills 12707e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntry(App& app) 1271897967deSJason M. Bills { 12727e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 12737e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1274ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 12757e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 127645ca1b86SEd Tanous [&app](const crow::Request& req, 12777e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 12787e860f15SJohn Edward Broadbent const std::string& param) { 12793ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 128045ca1b86SEd Tanous { 128145ca1b86SEd Tanous return; 128245ca1b86SEd Tanous } 12837e860f15SJohn Edward Broadbent const std::string& targetID = param; 12848d1b46d7Szhanghch05 12857e860f15SJohn Edward Broadbent // Go through the log files and check the unique ID for each 12867e860f15SJohn Edward Broadbent // entry to find the target entry 1287897967deSJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1288897967deSJason M. Bills getRedfishLogFiles(redfishLogFiles); 1289897967deSJason M. Bills std::string logEntry; 1290897967deSJason M. Bills 12917e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 12927e860f15SJohn Edward Broadbent // backwards 1293002d39b4SEd Tanous for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1294002d39b4SEd Tanous it++) 1295897967deSJason M. Bills { 1296897967deSJason M. Bills std::ifstream logStream(*it); 1297897967deSJason M. Bills if (!logStream.is_open()) 1298897967deSJason M. Bills { 1299897967deSJason M. Bills continue; 1300897967deSJason M. Bills } 1301897967deSJason M. Bills 1302897967deSJason M. Bills // Reset the unique ID on the first entry 1303897967deSJason M. Bills bool firstEntry = true; 1304897967deSJason M. Bills while (std::getline(logStream, logEntry)) 1305897967deSJason M. Bills { 1306897967deSJason M. Bills std::string idStr; 1307897967deSJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1308897967deSJason M. Bills { 1309897967deSJason M. Bills continue; 1310897967deSJason M. Bills } 1311897967deSJason M. Bills firstEntry = false; 1312897967deSJason M. Bills 1313897967deSJason M. Bills if (idStr == targetID) 1314897967deSJason M. Bills { 1315de703c5dSJason M. Bills nlohmann::json::object_t bmcLogEntry; 1316ac992cdeSJason M. Bills LogParseError status = 1317ac992cdeSJason M. Bills fillEventLogEntryJson(idStr, logEntry, bmcLogEntry); 1318ac992cdeSJason M. Bills if (status != LogParseError::success) 1319897967deSJason M. Bills { 1320897967deSJason M. Bills messages::internalError(asyncResp->res); 1321897967deSJason M. Bills return; 1322897967deSJason M. Bills } 1323d405bb51SJason M. Bills asyncResp->res.jsonValue.update(bmcLogEntry); 1324897967deSJason M. Bills return; 1325897967deSJason M. Bills } 1326897967deSJason M. Bills } 1327897967deSJason M. Bills } 1328897967deSJason M. Bills // Requested ID was not found 1329002d39b4SEd Tanous messages::resourceMissingAtURI(asyncResp->res, 1330002d39b4SEd Tanous crow::utility::urlFromPieces(targetID)); 13317e860f15SJohn Edward Broadbent }); 133208a4e4b5SAnthony Wilson } 133308a4e4b5SAnthony Wilson 13347e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryCollection(App& app) 133508a4e4b5SAnthony Wilson { 13367e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 13377e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") 1338ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 1339002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1340002d39b4SEd Tanous [&app](const crow::Request& req, 1341002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 13423ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 134345ca1b86SEd Tanous { 134445ca1b86SEd Tanous return; 134545ca1b86SEd Tanous } 13467e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 13477e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 134808a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.type"] = 134908a4e4b5SAnthony Wilson "#LogEntryCollection.LogEntryCollection"; 135008a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.id"] = 135108a4e4b5SAnthony Wilson "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 135208a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 135308a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Description"] = 135408a4e4b5SAnthony Wilson "Collection of System Event Log Entries"; 135508a4e4b5SAnthony Wilson 1356cb92c03bSAndrew Geissler // DBus implementation of EventLog/Entries 1357cb92c03bSAndrew Geissler // Make call to Logging Service to find all log entry objects 1358cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 1359cb92c03bSAndrew Geissler [asyncResp](const boost::system::error_code ec, 1360914e2d5dSEd Tanous const dbus::utility::ManagedObjectType& resp) { 1361cb92c03bSAndrew Geissler if (ec) 1362cb92c03bSAndrew Geissler { 1363cb92c03bSAndrew Geissler // TODO Handle for specific error code 1364cb92c03bSAndrew Geissler BMCWEB_LOG_ERROR 1365002d39b4SEd Tanous << "getLogEntriesIfaceData resp_handler got error " << ec; 1366cb92c03bSAndrew Geissler messages::internalError(asyncResp->res); 1367cb92c03bSAndrew Geissler return; 1368cb92c03bSAndrew Geissler } 1369002d39b4SEd Tanous nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"]; 1370cb92c03bSAndrew Geissler entriesArray = nlohmann::json::array(); 13719eb808c1SEd Tanous for (const auto& objectPath : resp) 1372cb92c03bSAndrew Geissler { 1373914e2d5dSEd Tanous const uint32_t* id = nullptr; 1374c419c759SEd Tanous const uint64_t* timestamp = nullptr; 1375c419c759SEd Tanous const uint64_t* updateTimestamp = nullptr; 1376914e2d5dSEd Tanous const std::string* severity = nullptr; 1377914e2d5dSEd Tanous const std::string* message = nullptr; 1378914e2d5dSEd Tanous const std::string* filePath = nullptr; 1379*9c11a172SVijay Lobo const std::string* resolution = nullptr; 138075710de2SXiaochao Ma bool resolved = false; 13819eb808c1SEd Tanous for (const auto& interfaceMap : objectPath.second) 1382f86bb901SAdriana Kobylak { 1383f86bb901SAdriana Kobylak if (interfaceMap.first == 1384f86bb901SAdriana Kobylak "xyz.openbmc_project.Logging.Entry") 1385f86bb901SAdriana Kobylak { 1386002d39b4SEd Tanous for (const auto& propertyMap : interfaceMap.second) 1387cb92c03bSAndrew Geissler { 1388cb92c03bSAndrew Geissler if (propertyMap.first == "Id") 1389cb92c03bSAndrew Geissler { 1390002d39b4SEd Tanous id = std::get_if<uint32_t>(&propertyMap.second); 1391cb92c03bSAndrew Geissler } 1392cb92c03bSAndrew Geissler else if (propertyMap.first == "Timestamp") 1393cb92c03bSAndrew Geissler { 1394002d39b4SEd Tanous timestamp = 1395002d39b4SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 13967e860f15SJohn Edward Broadbent } 1397002d39b4SEd Tanous else if (propertyMap.first == "UpdateTimestamp") 13987e860f15SJohn Edward Broadbent { 1399002d39b4SEd Tanous updateTimestamp = 1400002d39b4SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 14017e860f15SJohn Edward Broadbent } 14027e860f15SJohn Edward Broadbent else if (propertyMap.first == "Severity") 14037e860f15SJohn Edward Broadbent { 14047e860f15SJohn Edward Broadbent severity = std::get_if<std::string>( 14057e860f15SJohn Edward Broadbent &propertyMap.second); 14067e860f15SJohn Edward Broadbent } 1407*9c11a172SVijay Lobo else if (propertyMap.first == "Resolution") 1408*9c11a172SVijay Lobo { 1409*9c11a172SVijay Lobo resolution = std::get_if<std::string>( 1410*9c11a172SVijay Lobo &propertyMap.second); 1411*9c11a172SVijay Lobo } 14127e860f15SJohn Edward Broadbent else if (propertyMap.first == "Message") 14137e860f15SJohn Edward Broadbent { 14147e860f15SJohn Edward Broadbent message = std::get_if<std::string>( 14157e860f15SJohn Edward Broadbent &propertyMap.second); 14167e860f15SJohn Edward Broadbent } 14177e860f15SJohn Edward Broadbent else if (propertyMap.first == "Resolved") 14187e860f15SJohn Edward Broadbent { 1419914e2d5dSEd Tanous const bool* resolveptr = 1420002d39b4SEd Tanous std::get_if<bool>(&propertyMap.second); 14217e860f15SJohn Edward Broadbent if (resolveptr == nullptr) 14227e860f15SJohn Edward Broadbent { 1423002d39b4SEd Tanous messages::internalError(asyncResp->res); 14247e860f15SJohn Edward Broadbent return; 14257e860f15SJohn Edward Broadbent } 14267e860f15SJohn Edward Broadbent resolved = *resolveptr; 14277e860f15SJohn Edward Broadbent } 14287e860f15SJohn Edward Broadbent } 14297e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 14307e860f15SJohn Edward Broadbent severity == nullptr) 14317e860f15SJohn Edward Broadbent { 14327e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 14337e860f15SJohn Edward Broadbent return; 14347e860f15SJohn Edward Broadbent } 14357e860f15SJohn Edward Broadbent } 14367e860f15SJohn Edward Broadbent else if (interfaceMap.first == 14377e860f15SJohn Edward Broadbent "xyz.openbmc_project.Common.FilePath") 14387e860f15SJohn Edward Broadbent { 1439002d39b4SEd Tanous for (const auto& propertyMap : interfaceMap.second) 14407e860f15SJohn Edward Broadbent { 14417e860f15SJohn Edward Broadbent if (propertyMap.first == "Path") 14427e860f15SJohn Edward Broadbent { 14437e860f15SJohn Edward Broadbent filePath = std::get_if<std::string>( 14447e860f15SJohn Edward Broadbent &propertyMap.second); 14457e860f15SJohn Edward Broadbent } 14467e860f15SJohn Edward Broadbent } 14477e860f15SJohn Edward Broadbent } 14487e860f15SJohn Edward Broadbent } 14497e860f15SJohn Edward Broadbent // Object path without the 14507e860f15SJohn Edward Broadbent // xyz.openbmc_project.Logging.Entry interface, ignore 14517e860f15SJohn Edward Broadbent // and continue. 14527e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 1453c419c759SEd Tanous severity == nullptr || timestamp == nullptr || 1454c419c759SEd Tanous updateTimestamp == nullptr) 14557e860f15SJohn Edward Broadbent { 14567e860f15SJohn Edward Broadbent continue; 14577e860f15SJohn Edward Broadbent } 14587e860f15SJohn Edward Broadbent entriesArray.push_back({}); 14597e860f15SJohn Edward Broadbent nlohmann::json& thisEntry = entriesArray.back(); 1460*9c11a172SVijay Lobo thisEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 14617e860f15SJohn Edward Broadbent thisEntry["@odata.id"] = 14620fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 14637e860f15SJohn Edward Broadbent std::to_string(*id); 14647e860f15SJohn Edward Broadbent thisEntry["Name"] = "System Event Log Entry"; 14657e860f15SJohn Edward Broadbent thisEntry["Id"] = std::to_string(*id); 14667e860f15SJohn Edward Broadbent thisEntry["Message"] = *message; 14677e860f15SJohn Edward Broadbent thisEntry["Resolved"] = resolved; 1468*9c11a172SVijay Lobo if ((resolution != nullptr) && (!(*resolution).empty())) 1469*9c11a172SVijay Lobo { 1470*9c11a172SVijay Lobo thisEntry["Resolution"] = *resolution; 1471*9c11a172SVijay Lobo } 14727e860f15SJohn Edward Broadbent thisEntry["EntryType"] = "Event"; 14737e860f15SJohn Edward Broadbent thisEntry["Severity"] = 14747e860f15SJohn Edward Broadbent translateSeverityDbusToRedfish(*severity); 14757e860f15SJohn Edward Broadbent thisEntry["Created"] = 14762b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*timestamp); 14777e860f15SJohn Edward Broadbent thisEntry["Modified"] = 14782b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 14797e860f15SJohn Edward Broadbent if (filePath != nullptr) 14807e860f15SJohn Edward Broadbent { 14817e860f15SJohn Edward Broadbent thisEntry["AdditionalDataURI"] = 14820fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 14837e860f15SJohn Edward Broadbent std::to_string(*id) + "/attachment"; 14847e860f15SJohn Edward Broadbent } 14857e860f15SJohn Edward Broadbent } 1486002d39b4SEd Tanous std::sort( 1487002d39b4SEd Tanous entriesArray.begin(), entriesArray.end(), 1488002d39b4SEd Tanous [](const nlohmann::json& left, const nlohmann::json& right) { 14897e860f15SJohn Edward Broadbent return (left["Id"] <= right["Id"]); 14907e860f15SJohn Edward Broadbent }); 14917e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members@odata.count"] = 14927e860f15SJohn Edward Broadbent entriesArray.size(); 14937e860f15SJohn Edward Broadbent }, 14947e860f15SJohn Edward Broadbent "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging", 14957e860f15SJohn Edward Broadbent "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 14967e860f15SJohn Edward Broadbent }); 14977e860f15SJohn Edward Broadbent } 14987e860f15SJohn Edward Broadbent 14997e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app) 15007e860f15SJohn Edward Broadbent { 15017e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 15027e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1503ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 1504002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1505002d39b4SEd Tanous [&app](const crow::Request& req, 15067e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 150745ca1b86SEd Tanous const std::string& param) { 15083ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 15097e860f15SJohn Edward Broadbent { 151045ca1b86SEd Tanous return; 151145ca1b86SEd Tanous } 15127e860f15SJohn Edward Broadbent std::string entryID = param; 15137e860f15SJohn Edward Broadbent dbus::utility::escapePathForDbus(entryID); 15147e860f15SJohn Edward Broadbent 15157e860f15SJohn Edward Broadbent // DBus implementation of EventLog/Entries 15167e860f15SJohn Edward Broadbent // Make call to Logging Service to find all log entry objects 1517d1bde9e5SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 1518d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, "xyz.openbmc_project.Logging", 1519d1bde9e5SKrzysztof Grobelny "/xyz/openbmc_project/logging/entry/" + entryID, "", 1520002d39b4SEd Tanous [asyncResp, entryID](const boost::system::error_code ec, 1521b9d36b47SEd Tanous const dbus::utility::DBusPropertiesMap& resp) { 15227e860f15SJohn Edward Broadbent if (ec.value() == EBADR) 15237e860f15SJohn Edward Broadbent { 1524d1bde9e5SKrzysztof Grobelny messages::resourceNotFound(asyncResp->res, "EventLogEntry", 1525d1bde9e5SKrzysztof Grobelny entryID); 15267e860f15SJohn Edward Broadbent return; 15277e860f15SJohn Edward Broadbent } 15287e860f15SJohn Edward Broadbent if (ec) 15297e860f15SJohn Edward Broadbent { 15300fda0f12SGeorge Liu BMCWEB_LOG_ERROR 1531002d39b4SEd Tanous << "EventLogEntry (DBus) resp_handler got error " << ec; 15327e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 15337e860f15SJohn Edward Broadbent return; 15347e860f15SJohn Edward Broadbent } 1535914e2d5dSEd Tanous const uint32_t* id = nullptr; 1536c419c759SEd Tanous const uint64_t* timestamp = nullptr; 1537c419c759SEd Tanous const uint64_t* updateTimestamp = nullptr; 1538914e2d5dSEd Tanous const std::string* severity = nullptr; 1539914e2d5dSEd Tanous const std::string* message = nullptr; 1540914e2d5dSEd Tanous const std::string* filePath = nullptr; 1541*9c11a172SVijay Lobo const std::string* resolution = nullptr; 15427e860f15SJohn Edward Broadbent bool resolved = false; 15437e860f15SJohn Edward Broadbent 1544d1bde9e5SKrzysztof Grobelny const bool success = sdbusplus::unpackPropertiesNoThrow( 1545d1bde9e5SKrzysztof Grobelny dbus_utils::UnpackErrorPrinter(), resp, "Id", id, "Timestamp", 1546d1bde9e5SKrzysztof Grobelny timestamp, "UpdateTimestamp", updateTimestamp, "Severity", 1547*9c11a172SVijay Lobo severity, "Message", message, "Resolved", resolved, 1548*9c11a172SVijay Lobo "Resolution", resolution, "Path", filePath); 1549d1bde9e5SKrzysztof Grobelny 1550d1bde9e5SKrzysztof Grobelny if (!success) 155175710de2SXiaochao Ma { 155275710de2SXiaochao Ma messages::internalError(asyncResp->res); 155375710de2SXiaochao Ma return; 155475710de2SXiaochao Ma } 1555d1bde9e5SKrzysztof Grobelny 1556002d39b4SEd Tanous if (id == nullptr || message == nullptr || severity == nullptr || 1557002d39b4SEd Tanous timestamp == nullptr || updateTimestamp == nullptr) 1558f86bb901SAdriana Kobylak { 1559ae34c8e8SAdriana Kobylak messages::internalError(asyncResp->res); 1560271584abSEd Tanous return; 1561271584abSEd Tanous } 1562f86bb901SAdriana Kobylak asyncResp->res.jsonValue["@odata.type"] = 1563*9c11a172SVijay Lobo "#LogEntry.v1_9_0.LogEntry"; 1564f86bb901SAdriana Kobylak asyncResp->res.jsonValue["@odata.id"] = 15650fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1566f86bb901SAdriana Kobylak std::to_string(*id); 156745ca1b86SEd Tanous asyncResp->res.jsonValue["Name"] = "System Event Log Entry"; 1568f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Id"] = std::to_string(*id); 1569f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Message"] = *message; 1570f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Resolved"] = resolved; 1571*9c11a172SVijay Lobo if ((resolution != nullptr) && (!(*resolution).empty())) 1572*9c11a172SVijay Lobo { 1573*9c11a172SVijay Lobo asyncResp->res.jsonValue["Resolution"] = *resolution; 1574*9c11a172SVijay Lobo } 1575f86bb901SAdriana Kobylak asyncResp->res.jsonValue["EntryType"] = "Event"; 1576f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Severity"] = 1577f86bb901SAdriana Kobylak translateSeverityDbusToRedfish(*severity); 1578f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Created"] = 15792b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*timestamp); 1580f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Modified"] = 15812b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 1582f86bb901SAdriana Kobylak if (filePath != nullptr) 1583f86bb901SAdriana Kobylak { 1584f86bb901SAdriana Kobylak asyncResp->res.jsonValue["AdditionalDataURI"] = 1585e7dbd530SPotin Lai "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1586e7dbd530SPotin Lai std::to_string(*id) + "/attachment"; 1587f86bb901SAdriana Kobylak } 1588d1bde9e5SKrzysztof Grobelny }); 15897e860f15SJohn Edward Broadbent }); 1590336e96c6SChicago Duan 15917e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 15927e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1593ed398213SEd Tanous .privileges(redfish::privileges::patchLogEntry) 15947e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::patch)( 159545ca1b86SEd Tanous [&app](const crow::Request& req, 15967e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 15977e860f15SJohn Edward Broadbent const std::string& entryId) { 15983ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 159945ca1b86SEd Tanous { 160045ca1b86SEd Tanous return; 160145ca1b86SEd Tanous } 160275710de2SXiaochao Ma std::optional<bool> resolved; 160375710de2SXiaochao Ma 160415ed6780SWilly Tu if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved", 16057e860f15SJohn Edward Broadbent resolved)) 160675710de2SXiaochao Ma { 160775710de2SXiaochao Ma return; 160875710de2SXiaochao Ma } 160975710de2SXiaochao Ma BMCWEB_LOG_DEBUG << "Set Resolved"; 161075710de2SXiaochao Ma 161175710de2SXiaochao Ma crow::connections::systemBus->async_method_call( 16124f48d5f6SEd Tanous [asyncResp, entryId](const boost::system::error_code ec) { 161375710de2SXiaochao Ma if (ec) 161475710de2SXiaochao Ma { 161575710de2SXiaochao Ma BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 161675710de2SXiaochao Ma messages::internalError(asyncResp->res); 161775710de2SXiaochao Ma return; 161875710de2SXiaochao Ma } 161975710de2SXiaochao Ma }, 162075710de2SXiaochao Ma "xyz.openbmc_project.Logging", 162175710de2SXiaochao Ma "/xyz/openbmc_project/logging/entry/" + entryId, 162275710de2SXiaochao Ma "org.freedesktop.DBus.Properties", "Set", 162375710de2SXiaochao Ma "xyz.openbmc_project.Logging.Entry", "Resolved", 1624168e20c1SEd Tanous dbus::utility::DbusVariantType(*resolved)); 16257e860f15SJohn Edward Broadbent }); 162675710de2SXiaochao Ma 16277e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 16287e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1629ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 1630ed398213SEd Tanous 1631002d39b4SEd Tanous .methods(boost::beast::http::verb::delete_)( 1632002d39b4SEd Tanous [&app](const crow::Request& req, 1633002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 163445ca1b86SEd Tanous const std::string& param) { 16353ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1636336e96c6SChicago Duan { 163745ca1b86SEd Tanous return; 163845ca1b86SEd Tanous } 1639336e96c6SChicago Duan BMCWEB_LOG_DEBUG << "Do delete single event entries."; 1640336e96c6SChicago Duan 16417e860f15SJohn Edward Broadbent std::string entryID = param; 1642336e96c6SChicago Duan 1643336e96c6SChicago Duan dbus::utility::escapePathForDbus(entryID); 1644336e96c6SChicago Duan 1645336e96c6SChicago Duan // Process response from Logging service. 1646002d39b4SEd Tanous auto respHandler = 1647002d39b4SEd Tanous [asyncResp, entryID](const boost::system::error_code ec) { 1648002d39b4SEd Tanous BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done"; 1649336e96c6SChicago Duan if (ec) 1650336e96c6SChicago Duan { 16513de8d8baSGeorge Liu if (ec.value() == EBADR) 16523de8d8baSGeorge Liu { 165345ca1b86SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 165445ca1b86SEd Tanous entryID); 16553de8d8baSGeorge Liu return; 16563de8d8baSGeorge Liu } 1657336e96c6SChicago Duan // TODO Handle for specific error code 16580fda0f12SGeorge Liu BMCWEB_LOG_ERROR 16590fda0f12SGeorge Liu << "EventLogEntry (DBus) doDelete respHandler got error " 1660336e96c6SChicago Duan << ec; 1661336e96c6SChicago Duan asyncResp->res.result( 1662336e96c6SChicago Duan boost::beast::http::status::internal_server_error); 1663336e96c6SChicago Duan return; 1664336e96c6SChicago Duan } 1665336e96c6SChicago Duan 1666336e96c6SChicago Duan asyncResp->res.result(boost::beast::http::status::ok); 1667336e96c6SChicago Duan }; 1668336e96c6SChicago Duan 1669336e96c6SChicago Duan // Make call to Logging service to request Delete Log 1670336e96c6SChicago Duan crow::connections::systemBus->async_method_call( 1671336e96c6SChicago Duan respHandler, "xyz.openbmc_project.Logging", 1672336e96c6SChicago Duan "/xyz/openbmc_project/logging/entry/" + entryID, 1673336e96c6SChicago Duan "xyz.openbmc_project.Object.Delete", "Delete"); 16747e860f15SJohn Edward Broadbent }); 1675400fd1fbSAdriana Kobylak } 1676400fd1fbSAdriana Kobylak 16777e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryDownload(App& app) 1678400fd1fbSAdriana Kobylak { 16790fda0f12SGeorge Liu BMCWEB_ROUTE( 16800fda0f12SGeorge Liu app, 16810fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/attachment") 1682ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 16837e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 168445ca1b86SEd Tanous [&app](const crow::Request& req, 16857e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 168645ca1b86SEd Tanous const std::string& param) { 16873ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 16887e860f15SJohn Edward Broadbent { 168945ca1b86SEd Tanous return; 169045ca1b86SEd Tanous } 169199351cd8SEd Tanous if (http_helpers::isContentTypeAllowed( 169299351cd8SEd Tanous req.getHeaderValue("Accept"), 16934a0e1a0cSEd Tanous http_helpers::ContentType::OctetStream, true)) 1694400fd1fbSAdriana Kobylak { 1695002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::bad_request); 1696400fd1fbSAdriana Kobylak return; 1697400fd1fbSAdriana Kobylak } 1698400fd1fbSAdriana Kobylak 16997e860f15SJohn Edward Broadbent std::string entryID = param; 1700400fd1fbSAdriana Kobylak dbus::utility::escapePathForDbus(entryID); 1701400fd1fbSAdriana Kobylak 1702400fd1fbSAdriana Kobylak crow::connections::systemBus->async_method_call( 1703002d39b4SEd Tanous [asyncResp, entryID](const boost::system::error_code ec, 1704400fd1fbSAdriana Kobylak const sdbusplus::message::unix_fd& unixfd) { 1705400fd1fbSAdriana Kobylak if (ec.value() == EBADR) 1706400fd1fbSAdriana Kobylak { 1707002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "EventLogAttachment", 1708002d39b4SEd Tanous entryID); 1709400fd1fbSAdriana Kobylak return; 1710400fd1fbSAdriana Kobylak } 1711400fd1fbSAdriana Kobylak if (ec) 1712400fd1fbSAdriana Kobylak { 1713400fd1fbSAdriana Kobylak BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 1714400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1715400fd1fbSAdriana Kobylak return; 1716400fd1fbSAdriana Kobylak } 1717400fd1fbSAdriana Kobylak 1718400fd1fbSAdriana Kobylak int fd = -1; 1719400fd1fbSAdriana Kobylak fd = dup(unixfd); 1720400fd1fbSAdriana Kobylak if (fd == -1) 1721400fd1fbSAdriana Kobylak { 1722400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1723400fd1fbSAdriana Kobylak return; 1724400fd1fbSAdriana Kobylak } 1725400fd1fbSAdriana Kobylak 1726400fd1fbSAdriana Kobylak long long int size = lseek(fd, 0, SEEK_END); 1727400fd1fbSAdriana Kobylak if (size == -1) 1728400fd1fbSAdriana Kobylak { 1729400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1730400fd1fbSAdriana Kobylak return; 1731400fd1fbSAdriana Kobylak } 1732400fd1fbSAdriana Kobylak 1733400fd1fbSAdriana Kobylak // Arbitrary max size of 64kb 1734400fd1fbSAdriana Kobylak constexpr int maxFileSize = 65536; 1735400fd1fbSAdriana Kobylak if (size > maxFileSize) 1736400fd1fbSAdriana Kobylak { 1737002d39b4SEd Tanous BMCWEB_LOG_ERROR << "File size exceeds maximum allowed size of " 1738400fd1fbSAdriana Kobylak << maxFileSize; 1739400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1740400fd1fbSAdriana Kobylak return; 1741400fd1fbSAdriana Kobylak } 1742400fd1fbSAdriana Kobylak std::vector<char> data(static_cast<size_t>(size)); 1743400fd1fbSAdriana Kobylak long long int rc = lseek(fd, 0, SEEK_SET); 1744400fd1fbSAdriana Kobylak if (rc == -1) 1745400fd1fbSAdriana Kobylak { 1746400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1747400fd1fbSAdriana Kobylak return; 1748400fd1fbSAdriana Kobylak } 1749400fd1fbSAdriana Kobylak rc = read(fd, data.data(), data.size()); 1750400fd1fbSAdriana Kobylak if ((rc == -1) || (rc != size)) 1751400fd1fbSAdriana Kobylak { 1752400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1753400fd1fbSAdriana Kobylak return; 1754400fd1fbSAdriana Kobylak } 1755400fd1fbSAdriana Kobylak close(fd); 1756400fd1fbSAdriana Kobylak 1757400fd1fbSAdriana Kobylak std::string_view strData(data.data(), data.size()); 1758002d39b4SEd Tanous std::string output = crow::utility::base64encode(strData); 1759400fd1fbSAdriana Kobylak 1760d9f6c621SEd Tanous asyncResp->res.addHeader(boost::beast::http::field::content_type, 1761400fd1fbSAdriana Kobylak "application/octet-stream"); 1762d9f6c621SEd Tanous asyncResp->res.addHeader( 1763d9f6c621SEd Tanous boost::beast::http::field::content_transfer_encoding, "Base64"); 1764400fd1fbSAdriana Kobylak asyncResp->res.body() = std::move(output); 1765400fd1fbSAdriana Kobylak }, 1766400fd1fbSAdriana Kobylak "xyz.openbmc_project.Logging", 1767400fd1fbSAdriana Kobylak "/xyz/openbmc_project/logging/entry/" + entryID, 1768400fd1fbSAdriana Kobylak "xyz.openbmc_project.Logging.Entry", "GetEntry"); 17697e860f15SJohn Edward Broadbent }); 17701da66f75SEd Tanous } 17711da66f75SEd Tanous 1772b7028ebfSSpencer Ku constexpr const char* hostLoggerFolderPath = "/var/log/console"; 1773b7028ebfSSpencer Ku 1774b7028ebfSSpencer Ku inline bool 1775b7028ebfSSpencer Ku getHostLoggerFiles(const std::string& hostLoggerFilePath, 1776b7028ebfSSpencer Ku std::vector<std::filesystem::path>& hostLoggerFiles) 1777b7028ebfSSpencer Ku { 1778b7028ebfSSpencer Ku std::error_code ec; 1779b7028ebfSSpencer Ku std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec); 1780b7028ebfSSpencer Ku if (ec) 1781b7028ebfSSpencer Ku { 1782b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << ec.message(); 1783b7028ebfSSpencer Ku return false; 1784b7028ebfSSpencer Ku } 1785b7028ebfSSpencer Ku for (const std::filesystem::directory_entry& it : logPath) 1786b7028ebfSSpencer Ku { 1787b7028ebfSSpencer Ku std::string filename = it.path().filename(); 1788b7028ebfSSpencer Ku // Prefix of each log files is "log". Find the file and save the 1789b7028ebfSSpencer Ku // path 179011ba3979SEd Tanous if (filename.starts_with("log")) 1791b7028ebfSSpencer Ku { 1792b7028ebfSSpencer Ku hostLoggerFiles.emplace_back(it.path()); 1793b7028ebfSSpencer Ku } 1794b7028ebfSSpencer Ku } 1795b7028ebfSSpencer Ku // As the log files rotate, they are appended with a ".#" that is higher for 1796b7028ebfSSpencer Ku // the older logs. Since we start from oldest logs, sort the name in 1797b7028ebfSSpencer Ku // descending order. 1798b7028ebfSSpencer Ku std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(), 1799b7028ebfSSpencer Ku AlphanumLess<std::string>()); 1800b7028ebfSSpencer Ku 1801b7028ebfSSpencer Ku return true; 1802b7028ebfSSpencer Ku } 1803b7028ebfSSpencer Ku 180402cad96eSEd Tanous inline bool getHostLoggerEntries( 180502cad96eSEd Tanous const std::vector<std::filesystem::path>& hostLoggerFiles, uint64_t skip, 180602cad96eSEd Tanous uint64_t top, std::vector<std::string>& logEntries, size_t& logCount) 1807b7028ebfSSpencer Ku { 1808b7028ebfSSpencer Ku GzFileReader logFile; 1809b7028ebfSSpencer Ku 1810b7028ebfSSpencer Ku // Go though all log files and expose host logs. 1811b7028ebfSSpencer Ku for (const std::filesystem::path& it : hostLoggerFiles) 1812b7028ebfSSpencer Ku { 1813b7028ebfSSpencer Ku if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount)) 1814b7028ebfSSpencer Ku { 1815b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << "fail to expose host logs"; 1816b7028ebfSSpencer Ku return false; 1817b7028ebfSSpencer Ku } 1818b7028ebfSSpencer Ku } 1819b7028ebfSSpencer Ku // Get lastMessage from constructor by getter 1820b7028ebfSSpencer Ku std::string lastMessage = logFile.getLastMessage(); 1821b7028ebfSSpencer Ku if (!lastMessage.empty()) 1822b7028ebfSSpencer Ku { 1823b7028ebfSSpencer Ku logCount++; 1824b7028ebfSSpencer Ku if (logCount > skip && logCount <= (skip + top)) 1825b7028ebfSSpencer Ku { 1826b7028ebfSSpencer Ku logEntries.push_back(lastMessage); 1827b7028ebfSSpencer Ku } 1828b7028ebfSSpencer Ku } 1829b7028ebfSSpencer Ku return true; 1830b7028ebfSSpencer Ku } 1831b7028ebfSSpencer Ku 1832b7028ebfSSpencer Ku inline void fillHostLoggerEntryJson(const std::string& logEntryID, 1833b7028ebfSSpencer Ku const std::string& msg, 18346d6574c9SJason M. Bills nlohmann::json::object_t& logEntryJson) 1835b7028ebfSSpencer Ku { 1836b7028ebfSSpencer Ku // Fill in the log entry with the gathered data. 1837*9c11a172SVijay Lobo logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 18386d6574c9SJason M. Bills logEntryJson["@odata.id"] = 1839b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/" + 18406d6574c9SJason M. Bills logEntryID; 18416d6574c9SJason M. Bills logEntryJson["Name"] = "Host Logger Entry"; 18426d6574c9SJason M. Bills logEntryJson["Id"] = logEntryID; 18436d6574c9SJason M. Bills logEntryJson["Message"] = msg; 18446d6574c9SJason M. Bills logEntryJson["EntryType"] = "Oem"; 18456d6574c9SJason M. Bills logEntryJson["Severity"] = "OK"; 18466d6574c9SJason M. Bills logEntryJson["OemRecordFormat"] = "Host Logger Entry"; 1847b7028ebfSSpencer Ku } 1848b7028ebfSSpencer Ku 1849b7028ebfSSpencer Ku inline void requestRoutesSystemHostLogger(App& app) 1850b7028ebfSSpencer Ku { 1851b7028ebfSSpencer Ku BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/HostLogger/") 1852b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogService) 18531476687dSEd Tanous .methods(boost::beast::http::verb::get)( 18541476687dSEd Tanous [&app](const crow::Request& req, 18551476687dSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 18563ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 185745ca1b86SEd Tanous { 185845ca1b86SEd Tanous return; 185945ca1b86SEd Tanous } 1860b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 1861b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger"; 1862b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 1863b7028ebfSSpencer Ku "#LogService.v1_1_0.LogService"; 1864b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "Host Logger Service"; 1865b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = "Host Logger Service"; 1866b7028ebfSSpencer Ku asyncResp->res.jsonValue["Id"] = "HostLogger"; 18671476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 18681476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 1869b7028ebfSSpencer Ku }); 1870b7028ebfSSpencer Ku } 1871b7028ebfSSpencer Ku 1872b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerCollection(App& app) 1873b7028ebfSSpencer Ku { 1874b7028ebfSSpencer Ku BMCWEB_ROUTE(app, 1875b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/") 1876b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 1877002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1878002d39b4SEd Tanous [&app](const crow::Request& req, 1879002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1880c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 1881c937d2bfSEd Tanous .canDelegateTop = true, 1882c937d2bfSEd Tanous .canDelegateSkip = true, 1883c937d2bfSEd Tanous }; 1884c937d2bfSEd Tanous query_param::Query delegatedQuery; 1885c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 18863ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 1887b7028ebfSSpencer Ku { 1888b7028ebfSSpencer Ku return; 1889b7028ebfSSpencer Ku } 1890b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 1891b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 1892b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 1893b7028ebfSSpencer Ku "#LogEntryCollection.LogEntryCollection"; 1894b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "HostLogger Entries"; 1895b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = 1896b7028ebfSSpencer Ku "Collection of HostLogger Entries"; 18970fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1898b7028ebfSSpencer Ku logEntryArray = nlohmann::json::array(); 1899b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = 0; 1900b7028ebfSSpencer Ku 1901b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 1902b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 1903b7028ebfSSpencer Ku { 1904b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << "fail to get host log file path"; 1905b7028ebfSSpencer Ku return; 1906b7028ebfSSpencer Ku } 19073648c8beSEd Tanous // If we weren't provided top and skip limits, use the defaults. 19083648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 19095143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 1910b7028ebfSSpencer Ku size_t logCount = 0; 1911b7028ebfSSpencer Ku // This vector only store the entries we want to expose that 1912b7028ebfSSpencer Ku // control by skip and top. 1913b7028ebfSSpencer Ku std::vector<std::string> logEntries; 19143648c8beSEd Tanous if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries, 19153648c8beSEd Tanous logCount)) 1916b7028ebfSSpencer Ku { 1917b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 1918b7028ebfSSpencer Ku return; 1919b7028ebfSSpencer Ku } 1920b7028ebfSSpencer Ku // If vector is empty, that means skip value larger than total 1921b7028ebfSSpencer Ku // log count 192226f6976fSEd Tanous if (logEntries.empty()) 1923b7028ebfSSpencer Ku { 1924b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 1925b7028ebfSSpencer Ku return; 1926b7028ebfSSpencer Ku } 192726f6976fSEd Tanous if (!logEntries.empty()) 1928b7028ebfSSpencer Ku { 1929b7028ebfSSpencer Ku for (size_t i = 0; i < logEntries.size(); i++) 1930b7028ebfSSpencer Ku { 19316d6574c9SJason M. Bills nlohmann::json::object_t hostLogEntry; 19323648c8beSEd Tanous fillHostLoggerEntryJson(std::to_string(skip + i), logEntries[i], 19333648c8beSEd Tanous hostLogEntry); 19346d6574c9SJason M. Bills logEntryArray.push_back(std::move(hostLogEntry)); 1935b7028ebfSSpencer Ku } 1936b7028ebfSSpencer Ku 1937b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 19383648c8beSEd Tanous if (skip + top < logCount) 1939b7028ebfSSpencer Ku { 1940b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.nextLink"] = 19410fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/HostLogger/Entries?$skip=" + 19423648c8beSEd Tanous std::to_string(skip + top); 1943b7028ebfSSpencer Ku } 1944b7028ebfSSpencer Ku } 1945b7028ebfSSpencer Ku }); 1946b7028ebfSSpencer Ku } 1947b7028ebfSSpencer Ku 1948b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerLogEntry(App& app) 1949b7028ebfSSpencer Ku { 1950b7028ebfSSpencer Ku BMCWEB_ROUTE( 1951b7028ebfSSpencer Ku app, "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/<str>/") 1952b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 1953b7028ebfSSpencer Ku .methods(boost::beast::http::verb::get)( 195445ca1b86SEd Tanous [&app](const crow::Request& req, 1955b7028ebfSSpencer Ku const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1956b7028ebfSSpencer Ku const std::string& param) { 19573ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 195845ca1b86SEd Tanous { 195945ca1b86SEd Tanous return; 196045ca1b86SEd Tanous } 1961b7028ebfSSpencer Ku const std::string& targetID = param; 1962b7028ebfSSpencer Ku 1963b7028ebfSSpencer Ku uint64_t idInt = 0; 1964ca45aa3cSEd Tanous 1965ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 1966ca45aa3cSEd Tanous const char* end = targetID.data() + targetID.size(); 1967ca45aa3cSEd Tanous 1968ca45aa3cSEd Tanous auto [ptr, ec] = std::from_chars(targetID.data(), end, idInt); 1969b7028ebfSSpencer Ku if (ec == std::errc::invalid_argument) 1970b7028ebfSSpencer Ku { 1971ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 1972b7028ebfSSpencer Ku return; 1973b7028ebfSSpencer Ku } 1974b7028ebfSSpencer Ku if (ec == std::errc::result_out_of_range) 1975b7028ebfSSpencer Ku { 1976ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 1977b7028ebfSSpencer Ku return; 1978b7028ebfSSpencer Ku } 1979b7028ebfSSpencer Ku 1980b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 1981b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 1982b7028ebfSSpencer Ku { 1983b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << "fail to get host log file path"; 1984b7028ebfSSpencer Ku return; 1985b7028ebfSSpencer Ku } 1986b7028ebfSSpencer Ku 1987b7028ebfSSpencer Ku size_t logCount = 0; 19883648c8beSEd Tanous size_t top = 1; 1989b7028ebfSSpencer Ku std::vector<std::string> logEntries; 1990b7028ebfSSpencer Ku // We can get specific entry by skip and top. For example, if we 1991b7028ebfSSpencer Ku // want to get nth entry, we can set skip = n-1 and top = 1 to 1992b7028ebfSSpencer Ku // get that entry 1993002d39b4SEd Tanous if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, logEntries, 1994002d39b4SEd Tanous logCount)) 1995b7028ebfSSpencer Ku { 1996b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 1997b7028ebfSSpencer Ku return; 1998b7028ebfSSpencer Ku } 1999b7028ebfSSpencer Ku 2000b7028ebfSSpencer Ku if (!logEntries.empty()) 2001b7028ebfSSpencer Ku { 20026d6574c9SJason M. Bills nlohmann::json::object_t hostLogEntry; 20036d6574c9SJason M. Bills fillHostLoggerEntryJson(targetID, logEntries[0], hostLogEntry); 20046d6574c9SJason M. Bills asyncResp->res.jsonValue.update(hostLogEntry); 2005b7028ebfSSpencer Ku return; 2006b7028ebfSSpencer Ku } 2007b7028ebfSSpencer Ku 2008b7028ebfSSpencer Ku // Requested ID was not found 2009ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 2010b7028ebfSSpencer Ku }); 2011b7028ebfSSpencer Ku } 2012b7028ebfSSpencer Ku 2013fdd26906SClaire Weinan constexpr char const* dumpManagerIface = 2014fdd26906SClaire Weinan "xyz.openbmc_project.Collection.DeleteAll"; 2015dd72e87bSClaire Weinan inline void handleBMCLogServicesCollectionGet( 2016fdd26906SClaire Weinan crow::App& app, const crow::Request& req, 2017fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 20181da66f75SEd Tanous { 20193ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 202045ca1b86SEd Tanous { 202145ca1b86SEd Tanous return; 202245ca1b86SEd Tanous } 20237e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 20247e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2025e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 20261da66f75SEd Tanous "#LogServiceCollection.LogServiceCollection"; 2027e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 2028e1f26343SJason M. Bills "/redfish/v1/Managers/bmc/LogServices"; 2029002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection"; 2030e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 20311da66f75SEd Tanous "Collection of LogServices for this Manager"; 2032002d39b4SEd Tanous nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 2033c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 2034fdd26906SClaire Weinan 2035c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL 2036613dabeaSEd Tanous nlohmann::json::object_t journal; 2037613dabeaSEd Tanous journal["@odata.id"] = "/redfish/v1/Managers/bmc/LogServices/Journal"; 2038613dabeaSEd Tanous logServiceArray.push_back(std::move(journal)); 2039c4bf6374SJason M. Bills #endif 2040fdd26906SClaire Weinan 2041fdd26906SClaire Weinan asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size(); 2042fdd26906SClaire Weinan 2043fdd26906SClaire Weinan #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 2044fdd26906SClaire Weinan auto respHandler = 2045fdd26906SClaire Weinan [asyncResp]( 2046fdd26906SClaire Weinan const boost::system::error_code ec, 2047fdd26906SClaire Weinan const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 2048fdd26906SClaire Weinan if (ec) 2049fdd26906SClaire Weinan { 2050fdd26906SClaire Weinan BMCWEB_LOG_ERROR 2051dd72e87bSClaire Weinan << "handleBMCLogServicesCollectionGet respHandler got error " 2052fdd26906SClaire Weinan << ec; 2053fdd26906SClaire Weinan // Assume that getting an error simply means there are no dump 2054fdd26906SClaire Weinan // LogServices. Return without adding any error response. 2055fdd26906SClaire Weinan return; 2056fdd26906SClaire Weinan } 2057fdd26906SClaire Weinan 2058fdd26906SClaire Weinan nlohmann::json& logServiceArrayLocal = 2059fdd26906SClaire Weinan asyncResp->res.jsonValue["Members"]; 2060fdd26906SClaire Weinan 2061fdd26906SClaire Weinan for (const std::string& path : subTreePaths) 2062fdd26906SClaire Weinan { 2063fdd26906SClaire Weinan if (path == "/xyz/openbmc_project/dump/bmc") 2064fdd26906SClaire Weinan { 2065613dabeaSEd Tanous nlohmann::json::object_t member; 2066613dabeaSEd Tanous member["@odata.id"] = 2067613dabeaSEd Tanous "/redfish/v1/Managers/bmc/LogServices/Dump"; 2068613dabeaSEd Tanous logServiceArrayLocal.push_back(std::move(member)); 2069fdd26906SClaire Weinan } 2070fdd26906SClaire Weinan else if (path == "/xyz/openbmc_project/dump/faultlog") 2071fdd26906SClaire Weinan { 2072613dabeaSEd Tanous nlohmann::json::object_t member; 2073613dabeaSEd Tanous member["@odata.id"] = 2074613dabeaSEd Tanous "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2075613dabeaSEd Tanous logServiceArrayLocal.push_back(std::move(member)); 2076fdd26906SClaire Weinan } 2077fdd26906SClaire Weinan } 2078fdd26906SClaire Weinan 2079e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 2080fdd26906SClaire Weinan logServiceArrayLocal.size(); 2081fdd26906SClaire Weinan }; 2082fdd26906SClaire Weinan 2083fdd26906SClaire Weinan crow::connections::systemBus->async_method_call( 2084fdd26906SClaire Weinan respHandler, "xyz.openbmc_project.ObjectMapper", 2085fdd26906SClaire Weinan "/xyz/openbmc_project/object_mapper", 2086fdd26906SClaire Weinan "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 2087fdd26906SClaire Weinan "/xyz/openbmc_project/dump", 0, 2088fdd26906SClaire Weinan std::array<const char*, 1>{dumpManagerIface}); 2089fdd26906SClaire Weinan #endif 2090fdd26906SClaire Weinan } 2091fdd26906SClaire Weinan 2092fdd26906SClaire Weinan inline void requestRoutesBMCLogServiceCollection(App& app) 2093fdd26906SClaire Weinan { 2094fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/") 2095fdd26906SClaire Weinan .privileges(redfish::privileges::getLogServiceCollection) 2096fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 2097dd72e87bSClaire Weinan std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app))); 2098e1f26343SJason M. Bills } 2099e1f26343SJason M. Bills 21007e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogService(App& app) 2101e1f26343SJason M. Bills { 21027e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/") 2103ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 21047e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 210545ca1b86SEd Tanous [&app](const crow::Request& req, 210645ca1b86SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 21073ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 21087e860f15SJohn Edward Broadbent { 210945ca1b86SEd Tanous return; 211045ca1b86SEd Tanous } 2111e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2112e1f26343SJason M. Bills "#LogService.v1_1_0.LogService"; 21130f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 21140f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal"; 2115002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service"; 2116002d39b4SEd Tanous asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service"; 2117c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "BMC Journal"; 2118e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 21197c8c4058STejas Patil 21207c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 21212b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 2122002d39b4SEd Tanous asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 21237c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 21247c8c4058STejas Patil redfishDateTimeOffset.second; 21257c8c4058STejas Patil 21261476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 21271476687dSEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 21287e860f15SJohn Edward Broadbent }); 2129e1f26343SJason M. Bills } 2130e1f26343SJason M. Bills 21313a48b3a2SJason M. Bills static int 21323a48b3a2SJason M. Bills fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID, 2133e1f26343SJason M. Bills sd_journal* journal, 21343a48b3a2SJason M. Bills nlohmann::json::object_t& bmcJournalLogEntryJson) 2135e1f26343SJason M. Bills { 2136e1f26343SJason M. Bills // Get the Log Entry contents 2137e1f26343SJason M. Bills int ret = 0; 2138e1f26343SJason M. Bills 2139a8fe54f0SJason M. Bills std::string message; 2140a8fe54f0SJason M. Bills std::string_view syslogID; 2141a8fe54f0SJason M. Bills ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID); 2142a8fe54f0SJason M. Bills if (ret < 0) 2143a8fe54f0SJason M. Bills { 2144a8fe54f0SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read SYSLOG_IDENTIFIER field: " 2145a8fe54f0SJason M. Bills << strerror(-ret); 2146a8fe54f0SJason M. Bills } 2147a8fe54f0SJason M. Bills if (!syslogID.empty()) 2148a8fe54f0SJason M. Bills { 2149a8fe54f0SJason M. Bills message += std::string(syslogID) + ": "; 2150a8fe54f0SJason M. Bills } 2151a8fe54f0SJason M. Bills 215239e77504SEd Tanous std::string_view msg; 215316428a1aSJason M. Bills ret = getJournalMetadata(journal, "MESSAGE", msg); 2154e1f26343SJason M. Bills if (ret < 0) 2155e1f26343SJason M. Bills { 2156e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret); 2157e1f26343SJason M. Bills return 1; 2158e1f26343SJason M. Bills } 2159a8fe54f0SJason M. Bills message += std::string(msg); 2160e1f26343SJason M. Bills 2161e1f26343SJason M. Bills // Get the severity from the PRIORITY field 2162271584abSEd Tanous long int severity = 8; // Default to an invalid priority 216316428a1aSJason M. Bills ret = getJournalMetadata(journal, "PRIORITY", 10, severity); 2164e1f26343SJason M. Bills if (ret < 0) 2165e1f26343SJason M. Bills { 2166e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret); 2167e1f26343SJason M. Bills } 2168e1f26343SJason M. Bills 2169e1f26343SJason M. Bills // Get the Created time from the timestamp 217016428a1aSJason M. Bills std::string entryTimeStr; 217116428a1aSJason M. Bills if (!getEntryTimestamp(journal, entryTimeStr)) 2172e1f26343SJason M. Bills { 217316428a1aSJason M. Bills return 1; 2174e1f26343SJason M. Bills } 2175e1f26343SJason M. Bills 2176e1f26343SJason M. Bills // Fill in the log entry with the gathered data 2177*9c11a172SVijay Lobo bmcJournalLogEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 217884afc48bSJason M. Bills bmcJournalLogEntryJson["@odata.id"] = 217984afc48bSJason M. Bills "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" + 218084afc48bSJason M. Bills bmcJournalLogEntryID; 218184afc48bSJason M. Bills bmcJournalLogEntryJson["Name"] = "BMC Journal Entry"; 218284afc48bSJason M. Bills bmcJournalLogEntryJson["Id"] = bmcJournalLogEntryID; 218384afc48bSJason M. Bills bmcJournalLogEntryJson["Message"] = std::move(message); 218484afc48bSJason M. Bills bmcJournalLogEntryJson["EntryType"] = "Oem"; 218584afc48bSJason M. Bills bmcJournalLogEntryJson["Severity"] = severity <= 2 ? "Critical" 2186738c1e61SPatrick Williams : severity <= 4 ? "Warning" 218784afc48bSJason M. Bills : "OK"; 218884afc48bSJason M. Bills bmcJournalLogEntryJson["OemRecordFormat"] = "BMC Journal Entry"; 218984afc48bSJason M. Bills bmcJournalLogEntryJson["Created"] = std::move(entryTimeStr); 2190e1f26343SJason M. Bills return 0; 2191e1f26343SJason M. Bills } 2192e1f26343SJason M. Bills 21937e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntryCollection(App& app) 2194e1f26343SJason M. Bills { 21957e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/") 2196ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 2197002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2198002d39b4SEd Tanous [&app](const crow::Request& req, 2199002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2200c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 2201c937d2bfSEd Tanous .canDelegateTop = true, 2202c937d2bfSEd Tanous .canDelegateSkip = true, 2203c937d2bfSEd Tanous }; 2204c937d2bfSEd Tanous query_param::Query delegatedQuery; 2205c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 22063ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 2207193ad2faSJason M. Bills { 2208193ad2faSJason M. Bills return; 2209193ad2faSJason M. Bills } 22103648c8beSEd Tanous 22113648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 22125143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 22133648c8beSEd Tanous 22147e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 22157e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2216e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2217e1f26343SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 22180f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 22190f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 2220e1f26343SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries"; 2221e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2222e1f26343SJason M. Bills "Collection of BMC Journal Entries"; 22230fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2224e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 2225e1f26343SJason M. Bills 22267e860f15SJohn Edward Broadbent // Go through the journal and use the timestamp to create a 22277e860f15SJohn Edward Broadbent // unique ID for each entry 2228e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2229e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2230e1f26343SJason M. Bills if (ret < 0) 2231e1f26343SJason M. Bills { 2232002d39b4SEd Tanous BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 2233f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2234e1f26343SJason M. Bills return; 2235e1f26343SJason M. Bills } 22360fda0f12SGeorge Liu std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 22370fda0f12SGeorge Liu journalTmp, sd_journal_close); 2238e1f26343SJason M. Bills journalTmp = nullptr; 2239b01bf299SEd Tanous uint64_t entryCount = 0; 2240e85d6b16SJason M. Bills // Reset the unique ID on the first entry 2241e85d6b16SJason M. Bills bool firstEntry = true; 2242e1f26343SJason M. Bills SD_JOURNAL_FOREACH(journal.get()) 2243e1f26343SJason M. Bills { 2244193ad2faSJason M. Bills entryCount++; 22457e860f15SJohn Edward Broadbent // Handle paging using skip (number of entries to skip from 22467e860f15SJohn Edward Broadbent // the start) and top (number of entries to display) 22473648c8beSEd Tanous if (entryCount <= skip || entryCount > skip + top) 2248193ad2faSJason M. Bills { 2249193ad2faSJason M. Bills continue; 2250193ad2faSJason M. Bills } 2251193ad2faSJason M. Bills 225216428a1aSJason M. Bills std::string idStr; 2253e85d6b16SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2254e1f26343SJason M. Bills { 2255e1f26343SJason M. Bills continue; 2256e1f26343SJason M. Bills } 2257e85d6b16SJason M. Bills firstEntry = false; 2258e85d6b16SJason M. Bills 22593a48b3a2SJason M. Bills nlohmann::json::object_t bmcJournalLogEntry; 2260c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(idStr, journal.get(), 2261c4bf6374SJason M. Bills bmcJournalLogEntry) != 0) 2262e1f26343SJason M. Bills { 2263f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2264e1f26343SJason M. Bills return; 2265e1f26343SJason M. Bills } 22663a48b3a2SJason M. Bills logEntryArray.push_back(std::move(bmcJournalLogEntry)); 2267e1f26343SJason M. Bills } 2268193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 22693648c8beSEd Tanous if (skip + top < entryCount) 2270193ad2faSJason M. Bills { 2271193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 22720fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" + 22733648c8beSEd Tanous std::to_string(skip + top); 2274193ad2faSJason M. Bills } 22757e860f15SJohn Edward Broadbent }); 2276e1f26343SJason M. Bills } 2277e1f26343SJason M. Bills 22787e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntry(App& app) 2279e1f26343SJason M. Bills { 22807e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 22817e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/") 2282ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 22837e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 228445ca1b86SEd Tanous [&app](const crow::Request& req, 22857e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 22867e860f15SJohn Edward Broadbent const std::string& entryID) { 22873ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 228845ca1b86SEd Tanous { 228945ca1b86SEd Tanous return; 229045ca1b86SEd Tanous } 2291e1f26343SJason M. Bills // Convert the unique ID back to a timestamp to find the entry 2292e1f26343SJason M. Bills uint64_t ts = 0; 2293271584abSEd Tanous uint64_t index = 0; 22948d1b46d7Szhanghch05 if (!getTimestampFromID(asyncResp, entryID, ts, index)) 2295e1f26343SJason M. Bills { 229616428a1aSJason M. Bills return; 2297e1f26343SJason M. Bills } 2298e1f26343SJason M. Bills 2299e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2300e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2301e1f26343SJason M. Bills if (ret < 0) 2302e1f26343SJason M. Bills { 2303002d39b4SEd Tanous BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 2304f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2305e1f26343SJason M. Bills return; 2306e1f26343SJason M. Bills } 2307002d39b4SEd Tanous std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 2308002d39b4SEd Tanous journalTmp, sd_journal_close); 2309e1f26343SJason M. Bills journalTmp = nullptr; 23107e860f15SJohn Edward Broadbent // Go to the timestamp in the log and move to the entry at the 23117e860f15SJohn Edward Broadbent // index tracking the unique ID 2312af07e3f5SJason M. Bills std::string idStr; 2313af07e3f5SJason M. Bills bool firstEntry = true; 2314e1f26343SJason M. Bills ret = sd_journal_seek_realtime_usec(journal.get(), ts); 23152056b6d1SManojkiran Eda if (ret < 0) 23162056b6d1SManojkiran Eda { 23172056b6d1SManojkiran Eda BMCWEB_LOG_ERROR << "failed to seek to an entry in journal" 23182056b6d1SManojkiran Eda << strerror(-ret); 23192056b6d1SManojkiran Eda messages::internalError(asyncResp->res); 23202056b6d1SManojkiran Eda return; 23212056b6d1SManojkiran Eda } 2322271584abSEd Tanous for (uint64_t i = 0; i <= index; i++) 2323e1f26343SJason M. Bills { 2324e1f26343SJason M. Bills sd_journal_next(journal.get()); 2325af07e3f5SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2326af07e3f5SJason M. Bills { 2327af07e3f5SJason M. Bills messages::internalError(asyncResp->res); 2328af07e3f5SJason M. Bills return; 2329af07e3f5SJason M. Bills } 2330af07e3f5SJason M. Bills firstEntry = false; 2331af07e3f5SJason M. Bills } 2332c4bf6374SJason M. Bills // Confirm that the entry ID matches what was requested 2333af07e3f5SJason M. Bills if (idStr != entryID) 2334c4bf6374SJason M. Bills { 2335ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 2336c4bf6374SJason M. Bills return; 2337c4bf6374SJason M. Bills } 2338c4bf6374SJason M. Bills 23393a48b3a2SJason M. Bills nlohmann::json::object_t bmcJournalLogEntry; 2340c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(entryID, journal.get(), 23413a48b3a2SJason M. Bills bmcJournalLogEntry) != 0) 2342e1f26343SJason M. Bills { 2343f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2344e1f26343SJason M. Bills return; 2345e1f26343SJason M. Bills } 2346d405bb51SJason M. Bills asyncResp->res.jsonValue.update(bmcJournalLogEntry); 23477e860f15SJohn Edward Broadbent }); 2348c9bb6861Sraviteja-b } 2349c9bb6861Sraviteja-b 2350fdd26906SClaire Weinan inline void 2351fdd26906SClaire Weinan getDumpServiceInfo(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2352fdd26906SClaire Weinan const std::string& dumpType) 2353c9bb6861Sraviteja-b { 2354fdd26906SClaire Weinan std::string dumpPath; 2355fdd26906SClaire Weinan std::string overWritePolicy; 2356fdd26906SClaire Weinan bool collectDiagnosticDataSupported = false; 2357fdd26906SClaire Weinan 2358fdd26906SClaire Weinan if (dumpType == "BMC") 235945ca1b86SEd Tanous { 2360fdd26906SClaire Weinan dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump"; 2361fdd26906SClaire Weinan overWritePolicy = "WrapsWhenFull"; 2362fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2363fdd26906SClaire Weinan } 2364fdd26906SClaire Weinan else if (dumpType == "FaultLog") 2365fdd26906SClaire Weinan { 2366fdd26906SClaire Weinan dumpPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2367fdd26906SClaire Weinan overWritePolicy = "Unknown"; 2368fdd26906SClaire Weinan collectDiagnosticDataSupported = false; 2369fdd26906SClaire Weinan } 2370fdd26906SClaire Weinan else if (dumpType == "System") 2371fdd26906SClaire Weinan { 2372fdd26906SClaire Weinan dumpPath = "/redfish/v1/Systems/system/LogServices/Dump"; 2373fdd26906SClaire Weinan overWritePolicy = "WrapsWhenFull"; 2374fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2375fdd26906SClaire Weinan } 2376fdd26906SClaire Weinan else 2377fdd26906SClaire Weinan { 2378fdd26906SClaire Weinan BMCWEB_LOG_ERROR << "getDumpServiceInfo() invalid dump type: " 2379fdd26906SClaire Weinan << dumpType; 2380fdd26906SClaire Weinan messages::internalError(asyncResp->res); 238145ca1b86SEd Tanous return; 238245ca1b86SEd Tanous } 2383fdd26906SClaire Weinan 2384fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = dumpPath; 2385fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService"; 2386c9bb6861Sraviteja-b asyncResp->res.jsonValue["Name"] = "Dump LogService"; 2387fdd26906SClaire Weinan asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService"; 2388fdd26906SClaire Weinan asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename(); 2389fdd26906SClaire Weinan asyncResp->res.jsonValue["OverWritePolicy"] = std::move(overWritePolicy); 23907c8c4058STejas Patil 23917c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 23922b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 23930fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 23947c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 23957c8c4058STejas Patil redfishDateTimeOffset.second; 23967c8c4058STejas Patil 2397fdd26906SClaire Weinan asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries"; 2398002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 2399fdd26906SClaire Weinan dumpPath + "/Actions/LogService.ClearLog"; 2400fdd26906SClaire Weinan 2401fdd26906SClaire Weinan if (collectDiagnosticDataSupported) 2402fdd26906SClaire Weinan { 2403002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 24041476687dSEd Tanous ["target"] = 2405fdd26906SClaire Weinan dumpPath + "/Actions/LogService.CollectDiagnosticData"; 2406fdd26906SClaire Weinan } 2407c9bb6861Sraviteja-b } 2408c9bb6861Sraviteja-b 2409fdd26906SClaire Weinan inline void handleLogServicesDumpServiceGet( 2410fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2411fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 24127e860f15SJohn Edward Broadbent { 24133ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 241445ca1b86SEd Tanous { 241545ca1b86SEd Tanous return; 241645ca1b86SEd Tanous } 2417fdd26906SClaire Weinan getDumpServiceInfo(asyncResp, dumpType); 2418fdd26906SClaire Weinan } 2419c9bb6861Sraviteja-b 2420fdd26906SClaire Weinan inline void handleLogServicesDumpEntriesCollectionGet( 2421fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2422fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2423fdd26906SClaire Weinan { 2424fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2425fdd26906SClaire Weinan { 2426fdd26906SClaire Weinan return; 2427fdd26906SClaire Weinan } 2428fdd26906SClaire Weinan getDumpEntryCollection(asyncResp, dumpType); 2429fdd26906SClaire Weinan } 2430fdd26906SClaire Weinan 2431fdd26906SClaire Weinan inline void handleLogServicesDumpEntryGet( 2432fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2433fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2434fdd26906SClaire Weinan const std::string& dumpId) 2435fdd26906SClaire Weinan { 2436fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2437fdd26906SClaire Weinan { 2438fdd26906SClaire Weinan return; 2439fdd26906SClaire Weinan } 2440fdd26906SClaire Weinan getDumpEntryById(asyncResp, dumpId, dumpType); 2441fdd26906SClaire Weinan } 2442fdd26906SClaire Weinan 2443fdd26906SClaire Weinan inline void handleLogServicesDumpEntryDelete( 2444fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2445fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2446fdd26906SClaire Weinan const std::string& dumpId) 2447fdd26906SClaire Weinan { 2448fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2449fdd26906SClaire Weinan { 2450fdd26906SClaire Weinan return; 2451fdd26906SClaire Weinan } 2452fdd26906SClaire Weinan deleteDumpEntry(asyncResp, dumpId, dumpType); 2453fdd26906SClaire Weinan } 2454fdd26906SClaire Weinan 2455fdd26906SClaire Weinan inline void handleLogServicesDumpCollectDiagnosticDataPost( 2456fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2457fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2458fdd26906SClaire Weinan { 2459fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2460fdd26906SClaire Weinan { 2461fdd26906SClaire Weinan return; 2462fdd26906SClaire Weinan } 2463fdd26906SClaire Weinan createDump(asyncResp, req, dumpType); 2464fdd26906SClaire Weinan } 2465fdd26906SClaire Weinan 2466fdd26906SClaire Weinan inline void handleLogServicesDumpClearLogPost( 2467fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2468fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2469fdd26906SClaire Weinan { 2470fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2471fdd26906SClaire Weinan { 2472fdd26906SClaire Weinan return; 2473fdd26906SClaire Weinan } 2474fdd26906SClaire Weinan clearDump(asyncResp, dumpType); 2475fdd26906SClaire Weinan } 2476fdd26906SClaire Weinan 2477fdd26906SClaire Weinan inline void requestRoutesBMCDumpService(App& app) 2478fdd26906SClaire Weinan { 2479fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/") 2480fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 2481fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2482fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "BMC")); 2483fdd26906SClaire Weinan } 2484fdd26906SClaire Weinan 2485fdd26906SClaire Weinan inline void requestRoutesBMCDumpEntryCollection(App& app) 2486fdd26906SClaire Weinan { 2487fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/") 2488fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 2489fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2490fdd26906SClaire Weinan handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC")); 2491c9bb6861Sraviteja-b } 2492c9bb6861Sraviteja-b 24937e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app) 2494c9bb6861Sraviteja-b { 24957e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 24967e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2497ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 2498fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2499fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "BMC")); 2500fdd26906SClaire Weinan 25017e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 25027e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2503ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 2504fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 2505fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "BMC")); 2506c9bb6861Sraviteja-b } 2507c9bb6861Sraviteja-b 25087e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app) 2509c9bb6861Sraviteja-b { 25100fda0f12SGeorge Liu BMCWEB_ROUTE( 25110fda0f12SGeorge Liu app, 25120fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2513ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 25147e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 2515fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost, 2516fdd26906SClaire Weinan std::ref(app), "BMC")); 2517a43be80fSAsmitha Karunanithi } 2518a43be80fSAsmitha Karunanithi 25197e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app) 252080319af1SAsmitha Karunanithi { 25210fda0f12SGeorge Liu BMCWEB_ROUTE( 25220fda0f12SGeorge Liu app, 25230fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog/") 2524ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 2525fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 2526fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "BMC")); 252745ca1b86SEd Tanous } 2528fdd26906SClaire Weinan 2529fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpService(App& app) 2530fdd26906SClaire Weinan { 2531fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/") 2532fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 2533fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2534fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "FaultLog")); 2535fdd26906SClaire Weinan } 2536fdd26906SClaire Weinan 2537fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntryCollection(App& app) 2538fdd26906SClaire Weinan { 2539fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/") 2540fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 2541fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 2542fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpEntriesCollectionGet, 2543fdd26906SClaire Weinan std::ref(app), "FaultLog")); 2544fdd26906SClaire Weinan } 2545fdd26906SClaire Weinan 2546fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntry(App& app) 2547fdd26906SClaire Weinan { 2548fdd26906SClaire Weinan BMCWEB_ROUTE(app, 2549fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 2550fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntry) 2551fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2552fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "FaultLog")); 2553fdd26906SClaire Weinan 2554fdd26906SClaire Weinan BMCWEB_ROUTE(app, 2555fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 2556fdd26906SClaire Weinan .privileges(redfish::privileges::deleteLogEntry) 2557fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 2558fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog")); 2559fdd26906SClaire Weinan } 2560fdd26906SClaire Weinan 2561fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpClear(App& app) 2562fdd26906SClaire Weinan { 2563fdd26906SClaire Weinan BMCWEB_ROUTE( 2564fdd26906SClaire Weinan app, 2565fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog/") 2566fdd26906SClaire Weinan .privileges(redfish::privileges::postLogService) 2567fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 2568fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog")); 25695cb1dd27SAsmitha Karunanithi } 25705cb1dd27SAsmitha Karunanithi 25717e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app) 25725cb1dd27SAsmitha Karunanithi { 25737e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/") 2574ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 25756ab9ad54SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 25766ab9ad54SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "System")); 25775cb1dd27SAsmitha Karunanithi } 25785cb1dd27SAsmitha Karunanithi 25797e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app) 25807e860f15SJohn Edward Broadbent { 2581b2a3289dSAsmitha Karunanithi BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/") 2582ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 25837e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 25846ab9ad54SClaire Weinan std::bind_front(handleLogServicesDumpEntriesCollectionGet, 25856ab9ad54SClaire Weinan std::ref(app), "System")); 25865cb1dd27SAsmitha Karunanithi } 25875cb1dd27SAsmitha Karunanithi 25887e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app) 25895cb1dd27SAsmitha Karunanithi { 25907e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 2591864d6a17SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/") 2592ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 25936ab9ad54SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 25946ab9ad54SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "System")); 25958d1b46d7Szhanghch05 25967e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 2597864d6a17SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/") 2598ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 25996ab9ad54SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 26006ab9ad54SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "System")); 26015cb1dd27SAsmitha Karunanithi } 2602c9bb6861Sraviteja-b 26037e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app) 2604c9bb6861Sraviteja-b { 26050fda0f12SGeorge Liu BMCWEB_ROUTE( 26060fda0f12SGeorge Liu app, 26070fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2608ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 26097e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 26106ab9ad54SClaire Weinan std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost, 26116ab9ad54SClaire Weinan std::ref(app), "System")); 2612a43be80fSAsmitha Karunanithi } 2613a43be80fSAsmitha Karunanithi 26147e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app) 2615a43be80fSAsmitha Karunanithi { 26160fda0f12SGeorge Liu BMCWEB_ROUTE( 26170fda0f12SGeorge Liu app, 26180fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog/") 2619ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 26206ab9ad54SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 26216ab9ad54SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "System")); 2622013487e5Sraviteja-b } 2623013487e5Sraviteja-b 26247e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app) 26251da66f75SEd Tanous { 26263946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 26273946028dSAppaRao Puli // method for security reasons. 26281da66f75SEd Tanous /** 26291da66f75SEd Tanous * Functions triggers appropriate requests on DBus 26301da66f75SEd Tanous */ 26317e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Crashdump/") 2632ed398213SEd Tanous // This is incorrect, should be: 2633ed398213SEd Tanous //.privileges(redfish::privileges::getLogService) 2634432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 2635002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2636002d39b4SEd Tanous [&app](const crow::Request& req, 2637002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 26383ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 263945ca1b86SEd Tanous { 264045ca1b86SEd Tanous return; 264145ca1b86SEd Tanous } 26427e860f15SJohn Edward Broadbent // Copy over the static data to include the entries added by 26437e860f15SJohn Edward Broadbent // SubRoute 26440f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2645424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"; 2646e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 26478e6c099aSJason M. Bills "#LogService.v1_2_0.LogService"; 26484f50ae4bSGunnar Mills asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service"; 26494f50ae4bSGunnar Mills asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service"; 26504f50ae4bSGunnar Mills asyncResp->res.jsonValue["Id"] = "Oem Crashdump"; 2651e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 2652e1f26343SJason M. Bills asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; 26537c8c4058STejas Patil 26547c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 26552b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 26567c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 26577c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 26587c8c4058STejas Patil redfishDateTimeOffset.second; 26597c8c4058STejas Patil 26601476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 26611476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 2662002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 26631476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog"; 2664002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 26651476687dSEd Tanous ["target"] = 26661476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData"; 26677e860f15SJohn Edward Broadbent }); 26681da66f75SEd Tanous } 26691da66f75SEd Tanous 26707e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app) 26715b61b5e8SJason M. Bills { 26720fda0f12SGeorge Liu BMCWEB_ROUTE( 26730fda0f12SGeorge Liu app, 26740fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog/") 2675ed398213SEd Tanous // This is incorrect, should be: 2676ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 2677432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 26787e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 267945ca1b86SEd Tanous [&app](const crow::Request& req, 26807e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 26813ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 268245ca1b86SEd Tanous { 268345ca1b86SEd Tanous return; 268445ca1b86SEd Tanous } 26855b61b5e8SJason M. Bills crow::connections::systemBus->async_method_call( 26865b61b5e8SJason M. Bills [asyncResp](const boost::system::error_code ec, 2687cb13a392SEd Tanous const std::string&) { 26885b61b5e8SJason M. Bills if (ec) 26895b61b5e8SJason M. Bills { 26905b61b5e8SJason M. Bills messages::internalError(asyncResp->res); 26915b61b5e8SJason M. Bills return; 26925b61b5e8SJason M. Bills } 26935b61b5e8SJason M. Bills messages::success(asyncResp->res); 26945b61b5e8SJason M. Bills }, 2695002d39b4SEd Tanous crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll"); 26967e860f15SJohn Edward Broadbent }); 26975b61b5e8SJason M. Bills } 26985b61b5e8SJason M. Bills 26998d1b46d7Szhanghch05 static void 27008d1b46d7Szhanghch05 logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 27018d1b46d7Szhanghch05 const std::string& logID, nlohmann::json& logEntryJson) 2702e855dd28SJason M. Bills { 2703043a0536SJohnathan Mantey auto getStoredLogCallback = 2704b9d36b47SEd Tanous [asyncResp, logID, 2705b9d36b47SEd Tanous &logEntryJson](const boost::system::error_code ec, 2706b9d36b47SEd Tanous const dbus::utility::DBusPropertiesMap& params) { 2707e855dd28SJason M. Bills if (ec) 2708e855dd28SJason M. Bills { 2709e855dd28SJason M. Bills BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 27101ddcf01aSJason M. Bills if (ec.value() == 27111ddcf01aSJason M. Bills boost::system::linux_error::bad_request_descriptor) 27121ddcf01aSJason M. Bills { 2713002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 27141ddcf01aSJason M. Bills } 27151ddcf01aSJason M. Bills else 27161ddcf01aSJason M. Bills { 2717e855dd28SJason M. Bills messages::internalError(asyncResp->res); 27181ddcf01aSJason M. Bills } 2719e855dd28SJason M. Bills return; 2720e855dd28SJason M. Bills } 2721043a0536SJohnathan Mantey 2722043a0536SJohnathan Mantey std::string timestamp{}; 2723043a0536SJohnathan Mantey std::string filename{}; 2724043a0536SJohnathan Mantey std::string logfile{}; 27252c70f800SEd Tanous parseCrashdumpParameters(params, filename, timestamp, logfile); 2726043a0536SJohnathan Mantey 2727043a0536SJohnathan Mantey if (filename.empty() || timestamp.empty()) 2728e855dd28SJason M. Bills { 2729002d39b4SEd Tanous messages::resourceMissingAtURI(asyncResp->res, 2730002d39b4SEd Tanous crow::utility::urlFromPieces(logID)); 2731e855dd28SJason M. Bills return; 2732e855dd28SJason M. Bills } 2733e855dd28SJason M. Bills 2734043a0536SJohnathan Mantey std::string crashdumpURI = 2735e855dd28SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + 2736043a0536SJohnathan Mantey logID + "/" + filename; 273784afc48bSJason M. Bills nlohmann::json::object_t logEntry; 2738*9c11a172SVijay Lobo logEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 273984afc48bSJason M. Bills logEntry["@odata.id"] = 274084afc48bSJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + logID; 274184afc48bSJason M. Bills logEntry["Name"] = "CPU Crashdump"; 274284afc48bSJason M. Bills logEntry["Id"] = logID; 274384afc48bSJason M. Bills logEntry["EntryType"] = "Oem"; 274484afc48bSJason M. Bills logEntry["AdditionalDataURI"] = std::move(crashdumpURI); 274584afc48bSJason M. Bills logEntry["DiagnosticDataType"] = "OEM"; 274684afc48bSJason M. Bills logEntry["OEMDiagnosticDataType"] = "PECICrashdump"; 274784afc48bSJason M. Bills logEntry["Created"] = std::move(timestamp); 27482b20ef6eSJason M. Bills 27492b20ef6eSJason M. Bills // If logEntryJson references an array of LogEntry resources 27502b20ef6eSJason M. Bills // ('Members' list), then push this as a new entry, otherwise set it 27512b20ef6eSJason M. Bills // directly 27522b20ef6eSJason M. Bills if (logEntryJson.is_array()) 27532b20ef6eSJason M. Bills { 27542b20ef6eSJason M. Bills logEntryJson.push_back(logEntry); 27552b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 27562b20ef6eSJason M. Bills logEntryJson.size(); 27572b20ef6eSJason M. Bills } 27582b20ef6eSJason M. Bills else 27592b20ef6eSJason M. Bills { 2760d405bb51SJason M. Bills logEntryJson.update(logEntry); 27612b20ef6eSJason M. Bills } 2762e855dd28SJason M. Bills }; 2763d1bde9e5SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 2764d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, crashdumpObject, 2765d1bde9e5SKrzysztof Grobelny crashdumpPath + std::string("/") + logID, crashdumpInterface, 2766d1bde9e5SKrzysztof Grobelny std::move(getStoredLogCallback)); 2767e855dd28SJason M. Bills } 2768e855dd28SJason M. Bills 27697e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app) 27701da66f75SEd Tanous { 27713946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 27723946028dSAppaRao Puli // method for security reasons. 27731da66f75SEd Tanous /** 27741da66f75SEd Tanous * Functions triggers appropriate requests on DBus 27751da66f75SEd Tanous */ 27767e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 27777e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/") 2778ed398213SEd Tanous // This is incorrect, should be. 2779ed398213SEd Tanous //.privileges(redfish::privileges::postLogEntryCollection) 2780432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 2781002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2782002d39b4SEd Tanous [&app](const crow::Request& req, 2783002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 27843ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 278545ca1b86SEd Tanous { 278645ca1b86SEd Tanous return; 278745ca1b86SEd Tanous } 27882b20ef6eSJason M. Bills crow::connections::systemBus->async_method_call( 27892b20ef6eSJason M. Bills [asyncResp](const boost::system::error_code ec, 27902b20ef6eSJason M. Bills const std::vector<std::string>& resp) { 27911da66f75SEd Tanous if (ec) 27921da66f75SEd Tanous { 27931da66f75SEd Tanous if (ec.value() != 27941da66f75SEd Tanous boost::system::errc::no_such_file_or_directory) 27951da66f75SEd Tanous { 27961da66f75SEd Tanous BMCWEB_LOG_DEBUG << "failed to get entries ec: " 27971da66f75SEd Tanous << ec.message(); 2798f12894f8SJason M. Bills messages::internalError(asyncResp->res); 27991da66f75SEd Tanous return; 28001da66f75SEd Tanous } 28011da66f75SEd Tanous } 2802e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 28031da66f75SEd Tanous "#LogEntryCollection.LogEntryCollection"; 28040f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2805424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 2806002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries"; 2807e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2808424c4176SJason M. Bills "Collection of Crashdump Entries"; 2809002d39b4SEd Tanous asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 2810a2dd60a6SBrandon Kim asyncResp->res.jsonValue["Members@odata.count"] = 0; 28112b20ef6eSJason M. Bills 28122b20ef6eSJason M. Bills for (const std::string& path : resp) 28131da66f75SEd Tanous { 28142b20ef6eSJason M. Bills const sdbusplus::message::object_path objPath(path); 2815e855dd28SJason M. Bills // Get the log ID 28162b20ef6eSJason M. Bills std::string logID = objPath.filename(); 28172b20ef6eSJason M. Bills if (logID.empty()) 28181da66f75SEd Tanous { 2819e855dd28SJason M. Bills continue; 28201da66f75SEd Tanous } 2821e855dd28SJason M. Bills // Add the log entry to the array 28222b20ef6eSJason M. Bills logCrashdumpEntry(asyncResp, logID, 28232b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members"]); 28241da66f75SEd Tanous } 28252b20ef6eSJason M. Bills }, 28261da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", 28271da66f75SEd Tanous "/xyz/openbmc_project/object_mapper", 28281da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0, 28295b61b5e8SJason M. Bills std::array<const char*, 1>{crashdumpInterface}); 28307e860f15SJohn Edward Broadbent }); 28311da66f75SEd Tanous } 28321da66f75SEd Tanous 28337e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app) 28341da66f75SEd Tanous { 28353946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 28363946028dSAppaRao Puli // method for security reasons. 28371da66f75SEd Tanous 28387e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 28397e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/") 2840ed398213SEd Tanous // this is incorrect, should be 2841ed398213SEd Tanous // .privileges(redfish::privileges::getLogEntry) 2842432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 28437e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 284445ca1b86SEd Tanous [&app](const crow::Request& req, 28457e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 28467e860f15SJohn Edward Broadbent const std::string& param) { 28473ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 284845ca1b86SEd Tanous { 284945ca1b86SEd Tanous return; 285045ca1b86SEd Tanous } 28517e860f15SJohn Edward Broadbent const std::string& logID = param; 2852e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue); 28537e860f15SJohn Edward Broadbent }); 2854e855dd28SJason M. Bills } 2855e855dd28SJason M. Bills 28567e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app) 2857e855dd28SJason M. Bills { 28583946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 28593946028dSAppaRao Puli // method for security reasons. 28607e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 28617e860f15SJohn Edward Broadbent app, 28627e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/<str>/") 2863ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 28647e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 2865a4ce114aSNan Zhou [](const crow::Request& req, 28667e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 28677e860f15SJohn Edward Broadbent const std::string& logID, const std::string& fileName) { 28682a9beeedSShounak Mitra // Do not call getRedfishRoute here since the crashdump file is not a 28692a9beeedSShounak Mitra // Redfish resource. 2870043a0536SJohnathan Mantey auto getStoredLogCallback = 2871002d39b4SEd Tanous [asyncResp, logID, fileName, url(boost::urls::url(req.urlView))]( 2872abf2add6SEd Tanous const boost::system::error_code ec, 2873002d39b4SEd Tanous const std::vector< 2874002d39b4SEd Tanous std::pair<std::string, dbus::utility::DbusVariantType>>& 28757e860f15SJohn Edward Broadbent resp) { 28761da66f75SEd Tanous if (ec) 28771da66f75SEd Tanous { 2878002d39b4SEd Tanous BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 2879f12894f8SJason M. Bills messages::internalError(asyncResp->res); 28801da66f75SEd Tanous return; 28811da66f75SEd Tanous } 2882e855dd28SJason M. Bills 2883043a0536SJohnathan Mantey std::string dbusFilename{}; 2884043a0536SJohnathan Mantey std::string dbusTimestamp{}; 2885043a0536SJohnathan Mantey std::string dbusFilepath{}; 2886043a0536SJohnathan Mantey 2887002d39b4SEd Tanous parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp, 2888002d39b4SEd Tanous dbusFilepath); 2889043a0536SJohnathan Mantey 2890043a0536SJohnathan Mantey if (dbusFilename.empty() || dbusTimestamp.empty() || 2891043a0536SJohnathan Mantey dbusFilepath.empty()) 28921da66f75SEd Tanous { 2893ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, url); 28941da66f75SEd Tanous return; 28951da66f75SEd Tanous } 2896e855dd28SJason M. Bills 2897043a0536SJohnathan Mantey // Verify the file name parameter is correct 2898043a0536SJohnathan Mantey if (fileName != dbusFilename) 2899043a0536SJohnathan Mantey { 2900ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, url); 2901043a0536SJohnathan Mantey return; 2902043a0536SJohnathan Mantey } 2903043a0536SJohnathan Mantey 2904043a0536SJohnathan Mantey if (!std::filesystem::exists(dbusFilepath)) 2905043a0536SJohnathan Mantey { 2906ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, url); 2907043a0536SJohnathan Mantey return; 2908043a0536SJohnathan Mantey } 2909002d39b4SEd Tanous std::ifstream ifs(dbusFilepath, std::ios::in | std::ios::binary); 2910002d39b4SEd Tanous asyncResp->res.body() = 2911002d39b4SEd Tanous std::string(std::istreambuf_iterator<char>{ifs}, {}); 2912043a0536SJohnathan Mantey 29137e860f15SJohn Edward Broadbent // Configure this to be a file download when accessed 29147e860f15SJohn Edward Broadbent // from a browser 2915d9f6c621SEd Tanous asyncResp->res.addHeader( 2916d9f6c621SEd Tanous boost::beast::http::field::content_disposition, "attachment"); 29171da66f75SEd Tanous }; 2918d1bde9e5SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 2919d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, crashdumpObject, 2920d1bde9e5SKrzysztof Grobelny crashdumpPath + std::string("/") + logID, crashdumpInterface, 2921d1bde9e5SKrzysztof Grobelny std::move(getStoredLogCallback)); 29227e860f15SJohn Edward Broadbent }); 29231da66f75SEd Tanous } 29241da66f75SEd Tanous 2925c5a4c82aSJason M. Bills enum class OEMDiagnosticType 2926c5a4c82aSJason M. Bills { 2927c5a4c82aSJason M. Bills onDemand, 2928c5a4c82aSJason M. Bills telemetry, 2929c5a4c82aSJason M. Bills invalid, 2930c5a4c82aSJason M. Bills }; 2931c5a4c82aSJason M. Bills 2932f7725d79SEd Tanous inline OEMDiagnosticType 2933f7725d79SEd Tanous getOEMDiagnosticType(const std::string_view& oemDiagStr) 2934c5a4c82aSJason M. Bills { 2935c5a4c82aSJason M. Bills if (oemDiagStr == "OnDemand") 2936c5a4c82aSJason M. Bills { 2937c5a4c82aSJason M. Bills return OEMDiagnosticType::onDemand; 2938c5a4c82aSJason M. Bills } 2939c5a4c82aSJason M. Bills if (oemDiagStr == "Telemetry") 2940c5a4c82aSJason M. Bills { 2941c5a4c82aSJason M. Bills return OEMDiagnosticType::telemetry; 2942c5a4c82aSJason M. Bills } 2943c5a4c82aSJason M. Bills 2944c5a4c82aSJason M. Bills return OEMDiagnosticType::invalid; 2945c5a4c82aSJason M. Bills } 2946c5a4c82aSJason M. Bills 29477e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app) 29481da66f75SEd Tanous { 29493946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 29503946028dSAppaRao Puli // method for security reasons. 29510fda0f12SGeorge Liu BMCWEB_ROUTE( 29520fda0f12SGeorge Liu app, 29530fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/") 2954ed398213SEd Tanous // The below is incorrect; Should be ConfigureManager 2955ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 2956432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 2957002d39b4SEd Tanous .methods(boost::beast::http::verb::post)( 2958002d39b4SEd Tanous [&app](const crow::Request& req, 29597e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 29603ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 296145ca1b86SEd Tanous { 296245ca1b86SEd Tanous return; 296345ca1b86SEd Tanous } 29648e6c099aSJason M. Bills std::string diagnosticDataType; 29658e6c099aSJason M. Bills std::string oemDiagnosticDataType; 296615ed6780SWilly Tu if (!redfish::json_util::readJsonAction( 2967002d39b4SEd Tanous req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 2968002d39b4SEd Tanous "OEMDiagnosticDataType", oemDiagnosticDataType)) 29698e6c099aSJason M. Bills { 29708e6c099aSJason M. Bills return; 29718e6c099aSJason M. Bills } 29728e6c099aSJason M. Bills 29738e6c099aSJason M. Bills if (diagnosticDataType != "OEM") 29748e6c099aSJason M. Bills { 29758e6c099aSJason M. Bills BMCWEB_LOG_ERROR 29768e6c099aSJason M. Bills << "Only OEM DiagnosticDataType supported for Crashdump"; 29778e6c099aSJason M. Bills messages::actionParameterValueFormatError( 29788e6c099aSJason M. Bills asyncResp->res, diagnosticDataType, "DiagnosticDataType", 29798e6c099aSJason M. Bills "CollectDiagnosticData"); 29808e6c099aSJason M. Bills return; 29818e6c099aSJason M. Bills } 29828e6c099aSJason M. Bills 2983c5a4c82aSJason M. Bills OEMDiagnosticType oemDiagType = 2984c5a4c82aSJason M. Bills getOEMDiagnosticType(oemDiagnosticDataType); 2985c5a4c82aSJason M. Bills 2986c5a4c82aSJason M. Bills std::string iface; 2987c5a4c82aSJason M. Bills std::string method; 2988c5a4c82aSJason M. Bills std::string taskMatchStr; 2989c5a4c82aSJason M. Bills if (oemDiagType == OEMDiagnosticType::onDemand) 2990c5a4c82aSJason M. Bills { 2991c5a4c82aSJason M. Bills iface = crashdumpOnDemandInterface; 2992c5a4c82aSJason M. Bills method = "GenerateOnDemandLog"; 2993c5a4c82aSJason M. Bills taskMatchStr = "type='signal'," 2994c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 2995c5a4c82aSJason M. Bills "member='PropertiesChanged'," 2996c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 2997c5a4c82aSJason M. Bills } 2998c5a4c82aSJason M. Bills else if (oemDiagType == OEMDiagnosticType::telemetry) 2999c5a4c82aSJason M. Bills { 3000c5a4c82aSJason M. Bills iface = crashdumpTelemetryInterface; 3001c5a4c82aSJason M. Bills method = "GenerateTelemetryLog"; 3002c5a4c82aSJason M. Bills taskMatchStr = "type='signal'," 3003c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 3004c5a4c82aSJason M. Bills "member='PropertiesChanged'," 3005c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 3006c5a4c82aSJason M. Bills } 3007c5a4c82aSJason M. Bills else 3008c5a4c82aSJason M. Bills { 3009c5a4c82aSJason M. Bills BMCWEB_LOG_ERROR << "Unsupported OEMDiagnosticDataType: " 3010c5a4c82aSJason M. Bills << oemDiagnosticDataType; 3011c5a4c82aSJason M. Bills messages::actionParameterValueFormatError( 3012002d39b4SEd Tanous asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType", 3013002d39b4SEd Tanous "CollectDiagnosticData"); 3014c5a4c82aSJason M. Bills return; 3015c5a4c82aSJason M. Bills } 3016c5a4c82aSJason M. Bills 3017c5a4c82aSJason M. Bills auto collectCrashdumpCallback = 3018c5a4c82aSJason M. Bills [asyncResp, payload(task::Payload(req)), 3019c5a4c82aSJason M. Bills taskMatchStr](const boost::system::error_code ec, 302098be3e39SEd Tanous const std::string&) mutable { 30211da66f75SEd Tanous if (ec) 30221da66f75SEd Tanous { 3023002d39b4SEd Tanous if (ec.value() == boost::system::errc::operation_not_supported) 30241da66f75SEd Tanous { 3025f12894f8SJason M. Bills messages::resourceInStandby(asyncResp->res); 30261da66f75SEd Tanous } 30274363d3b2SJason M. Bills else if (ec.value() == 30284363d3b2SJason M. Bills boost::system::errc::device_or_resource_busy) 30294363d3b2SJason M. Bills { 3030002d39b4SEd Tanous messages::serviceTemporarilyUnavailable(asyncResp->res, 3031002d39b4SEd Tanous "60"); 30324363d3b2SJason M. Bills } 30331da66f75SEd Tanous else 30341da66f75SEd Tanous { 3035f12894f8SJason M. Bills messages::internalError(asyncResp->res); 30361da66f75SEd Tanous } 30371da66f75SEd Tanous return; 30381da66f75SEd Tanous } 3039002d39b4SEd Tanous std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 304059d494eeSPatrick Williams [](boost::system::error_code err, sdbusplus::message_t&, 3041002d39b4SEd Tanous const std::shared_ptr<task::TaskData>& taskData) { 304266afe4faSJames Feist if (!err) 304366afe4faSJames Feist { 3044002d39b4SEd Tanous taskData->messages.emplace_back(messages::taskCompletedOK( 3045e5d5006bSJames Feist std::to_string(taskData->index))); 3046831d6b09SJames Feist taskData->state = "Completed"; 304766afe4faSJames Feist } 304832898ceaSJames Feist return task::completed; 304966afe4faSJames Feist }, 3050c5a4c82aSJason M. Bills taskMatchStr); 3051c5a4c82aSJason M. Bills 305246229577SJames Feist task->startTimer(std::chrono::minutes(5)); 305346229577SJames Feist task->populateResp(asyncResp->res); 305498be3e39SEd Tanous task->payload.emplace(std::move(payload)); 30551da66f75SEd Tanous }; 30568e6c099aSJason M. Bills 30571da66f75SEd Tanous crow::connections::systemBus->async_method_call( 3058002d39b4SEd Tanous std::move(collectCrashdumpCallback), crashdumpObject, crashdumpPath, 3059002d39b4SEd Tanous iface, method); 30607e860f15SJohn Edward Broadbent }); 30616eda7685SKenny L. Ku } 30626eda7685SKenny L. Ku 3063cb92c03bSAndrew Geissler /** 3064cb92c03bSAndrew Geissler * DBusLogServiceActionsClear class supports POST method for ClearLog action. 3065cb92c03bSAndrew Geissler */ 30667e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app) 3067cb92c03bSAndrew Geissler { 3068cb92c03bSAndrew Geissler /** 3069cb92c03bSAndrew Geissler * Function handles POST method request. 3070cb92c03bSAndrew Geissler * The Clear Log actions does not require any parameter.The action deletes 3071cb92c03bSAndrew Geissler * all entries found in the Entries collection for this Log Service. 3072cb92c03bSAndrew Geissler */ 30737e860f15SJohn Edward Broadbent 30740fda0f12SGeorge Liu BMCWEB_ROUTE( 30750fda0f12SGeorge Liu app, 30760fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog/") 3077ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 30787e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 307945ca1b86SEd Tanous [&app](const crow::Request& req, 30807e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 30813ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 308245ca1b86SEd Tanous { 308345ca1b86SEd Tanous return; 308445ca1b86SEd Tanous } 3085cb92c03bSAndrew Geissler BMCWEB_LOG_DEBUG << "Do delete all entries."; 3086cb92c03bSAndrew Geissler 3087cb92c03bSAndrew Geissler // Process response from Logging service. 3088002d39b4SEd Tanous auto respHandler = [asyncResp](const boost::system::error_code ec) { 3089002d39b4SEd Tanous BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done"; 3090cb92c03bSAndrew Geissler if (ec) 3091cb92c03bSAndrew Geissler { 3092cb92c03bSAndrew Geissler // TODO Handle for specific error code 3093002d39b4SEd Tanous BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec; 3094cb92c03bSAndrew Geissler asyncResp->res.result( 3095cb92c03bSAndrew Geissler boost::beast::http::status::internal_server_error); 3096cb92c03bSAndrew Geissler return; 3097cb92c03bSAndrew Geissler } 3098cb92c03bSAndrew Geissler 3099002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::no_content); 3100cb92c03bSAndrew Geissler }; 3101cb92c03bSAndrew Geissler 3102cb92c03bSAndrew Geissler // Make call to Logging service to request Clear Log 3103cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 31042c70f800SEd Tanous respHandler, "xyz.openbmc_project.Logging", 3105cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging", 3106cb92c03bSAndrew Geissler "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 31077e860f15SJohn Edward Broadbent }); 3108cb92c03bSAndrew Geissler } 3109a3316fc6SZhikuiRen 3110a3316fc6SZhikuiRen /**************************************************** 3111a3316fc6SZhikuiRen * Redfish PostCode interfaces 3112a3316fc6SZhikuiRen * using DBUS interface: getPostCodesTS 3113a3316fc6SZhikuiRen ******************************************************/ 31147e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesLogService(App& app) 3115a3316fc6SZhikuiRen { 31167e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/PostCodes/") 3117ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 3118002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 3119002d39b4SEd Tanous [&app](const crow::Request& req, 3120002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 31213ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 312245ca1b86SEd Tanous { 312345ca1b86SEd Tanous return; 312445ca1b86SEd Tanous } 31251476687dSEd Tanous 31261476687dSEd Tanous asyncResp->res.jsonValue["@odata.id"] = 31271476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes"; 31281476687dSEd Tanous asyncResp->res.jsonValue["@odata.type"] = 31291476687dSEd Tanous "#LogService.v1_1_0.LogService"; 31301476687dSEd Tanous asyncResp->res.jsonValue["Name"] = "POST Code Log Service"; 31311476687dSEd Tanous asyncResp->res.jsonValue["Description"] = "POST Code Log Service"; 31321476687dSEd Tanous asyncResp->res.jsonValue["Id"] = "BIOS POST Code Log"; 31331476687dSEd Tanous asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 31341476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 31351476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 31367c8c4058STejas Patil 31377c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 31382b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 31390fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 31407c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 31417c8c4058STejas Patil redfishDateTimeOffset.second; 31427c8c4058STejas Patil 3143a3316fc6SZhikuiRen asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 31447e860f15SJohn Edward Broadbent {"target", 31450fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog"}}; 31467e860f15SJohn Edward Broadbent }); 3147a3316fc6SZhikuiRen } 3148a3316fc6SZhikuiRen 31497e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesClear(App& app) 3150a3316fc6SZhikuiRen { 31510fda0f12SGeorge Liu BMCWEB_ROUTE( 31520fda0f12SGeorge Liu app, 31530fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog/") 3154ed398213SEd Tanous // The following privilege is incorrect; It should be ConfigureManager 3155ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3156432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 31577e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 315845ca1b86SEd Tanous [&app](const crow::Request& req, 31597e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 31603ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 316145ca1b86SEd Tanous { 316245ca1b86SEd Tanous return; 316345ca1b86SEd Tanous } 3164a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Do delete all postcodes entries."; 3165a3316fc6SZhikuiRen 3166a3316fc6SZhikuiRen // Make call to post-code service to request clear all 3167a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3168a3316fc6SZhikuiRen [asyncResp](const boost::system::error_code ec) { 3169a3316fc6SZhikuiRen if (ec) 3170a3316fc6SZhikuiRen { 3171a3316fc6SZhikuiRen // TODO Handle for specific error code 3172002d39b4SEd Tanous BMCWEB_LOG_ERROR << "doClearPostCodes resp_handler got error " 31737e860f15SJohn Edward Broadbent << ec; 3174002d39b4SEd Tanous asyncResp->res.result( 3175002d39b4SEd Tanous boost::beast::http::status::internal_server_error); 3176a3316fc6SZhikuiRen messages::internalError(asyncResp->res); 3177a3316fc6SZhikuiRen return; 3178a3316fc6SZhikuiRen } 3179a3316fc6SZhikuiRen }, 318015124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 318115124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3182a3316fc6SZhikuiRen "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 31837e860f15SJohn Edward Broadbent }); 3184a3316fc6SZhikuiRen } 3185a3316fc6SZhikuiRen 3186a3316fc6SZhikuiRen static void fillPostCodeEntry( 31878d1b46d7Szhanghch05 const std::shared_ptr<bmcweb::AsyncResp>& aResp, 31886c9a279eSManojkiran Eda const boost::container::flat_map< 31896c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode, 3190a3316fc6SZhikuiRen const uint16_t bootIndex, const uint64_t codeIndex = 0, 3191a3316fc6SZhikuiRen const uint64_t skip = 0, const uint64_t top = 0) 3192a3316fc6SZhikuiRen { 3193a3316fc6SZhikuiRen // Get the Message from the MessageRegistry 3194fffb8c1fSEd Tanous const registries::Message* message = 3195fffb8c1fSEd Tanous registries::getMessage("OpenBMC.0.2.BIOSPOSTCode"); 3196a3316fc6SZhikuiRen 3197a3316fc6SZhikuiRen uint64_t currentCodeIndex = 0; 3198a3316fc6SZhikuiRen nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"]; 3199a3316fc6SZhikuiRen 3200a3316fc6SZhikuiRen uint64_t firstCodeTimeUs = 0; 32016c9a279eSManojkiran Eda for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 32026c9a279eSManojkiran Eda code : postcode) 3203a3316fc6SZhikuiRen { 3204a3316fc6SZhikuiRen currentCodeIndex++; 3205a3316fc6SZhikuiRen std::string postcodeEntryID = 3206a3316fc6SZhikuiRen "B" + std::to_string(bootIndex) + "-" + 3207a3316fc6SZhikuiRen std::to_string(currentCodeIndex); // 1 based index in EntryID string 3208a3316fc6SZhikuiRen 3209a3316fc6SZhikuiRen uint64_t usecSinceEpoch = code.first; 3210a3316fc6SZhikuiRen uint64_t usTimeOffset = 0; 3211a3316fc6SZhikuiRen 3212a3316fc6SZhikuiRen if (1 == currentCodeIndex) 3213a3316fc6SZhikuiRen { // already incremented 3214a3316fc6SZhikuiRen firstCodeTimeUs = code.first; 3215a3316fc6SZhikuiRen } 3216a3316fc6SZhikuiRen else 3217a3316fc6SZhikuiRen { 3218a3316fc6SZhikuiRen usTimeOffset = code.first - firstCodeTimeUs; 3219a3316fc6SZhikuiRen } 3220a3316fc6SZhikuiRen 3221a3316fc6SZhikuiRen // skip if no specific codeIndex is specified and currentCodeIndex does 3222a3316fc6SZhikuiRen // not fall between top and skip 3223a3316fc6SZhikuiRen if ((codeIndex == 0) && 3224a3316fc6SZhikuiRen (currentCodeIndex <= skip || currentCodeIndex > top)) 3225a3316fc6SZhikuiRen { 3226a3316fc6SZhikuiRen continue; 3227a3316fc6SZhikuiRen } 3228a3316fc6SZhikuiRen 32294e0453b1SGunnar Mills // skip if a specific codeIndex is specified and does not match the 3230a3316fc6SZhikuiRen // currentIndex 3231a3316fc6SZhikuiRen if ((codeIndex > 0) && (currentCodeIndex != codeIndex)) 3232a3316fc6SZhikuiRen { 3233a3316fc6SZhikuiRen // This is done for simplicity. 1st entry is needed to calculate 3234a3316fc6SZhikuiRen // time offset. To improve efficiency, one can get to the entry 3235a3316fc6SZhikuiRen // directly (possibly with flatmap's nth method) 3236a3316fc6SZhikuiRen continue; 3237a3316fc6SZhikuiRen } 3238a3316fc6SZhikuiRen 3239a3316fc6SZhikuiRen // currentCodeIndex is within top and skip or equal to specified code 3240a3316fc6SZhikuiRen // index 3241a3316fc6SZhikuiRen 3242a3316fc6SZhikuiRen // Get the Created time from the timestamp 3243a3316fc6SZhikuiRen std::string entryTimeStr; 32441d8782e7SNan Zhou entryTimeStr = 32452b82937eSEd Tanous redfish::time_utils::getDateTimeUint(usecSinceEpoch / 1000 / 1000); 3246a3316fc6SZhikuiRen 3247a3316fc6SZhikuiRen // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex) 3248a3316fc6SZhikuiRen std::ostringstream hexCode; 3249a3316fc6SZhikuiRen hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex 32506c9a279eSManojkiran Eda << std::get<0>(code.second); 3251a3316fc6SZhikuiRen std::ostringstream timeOffsetStr; 3252a3316fc6SZhikuiRen // Set Fixed -Point Notation 3253a3316fc6SZhikuiRen timeOffsetStr << std::fixed; 3254a3316fc6SZhikuiRen // Set precision to 4 digits 3255a3316fc6SZhikuiRen timeOffsetStr << std::setprecision(4); 3256a3316fc6SZhikuiRen // Add double to stream 3257a3316fc6SZhikuiRen timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000; 3258a3316fc6SZhikuiRen std::vector<std::string> messageArgs = { 3259a3316fc6SZhikuiRen std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()}; 3260a3316fc6SZhikuiRen 3261a3316fc6SZhikuiRen // Get MessageArgs template from message registry 3262a3316fc6SZhikuiRen std::string msg; 3263a3316fc6SZhikuiRen if (message != nullptr) 3264a3316fc6SZhikuiRen { 3265a3316fc6SZhikuiRen msg = message->message; 3266a3316fc6SZhikuiRen 3267a3316fc6SZhikuiRen // fill in this post code value 3268a3316fc6SZhikuiRen int i = 0; 3269a3316fc6SZhikuiRen for (const std::string& messageArg : messageArgs) 3270a3316fc6SZhikuiRen { 3271a3316fc6SZhikuiRen std::string argStr = "%" + std::to_string(++i); 3272a3316fc6SZhikuiRen size_t argPos = msg.find(argStr); 3273a3316fc6SZhikuiRen if (argPos != std::string::npos) 3274a3316fc6SZhikuiRen { 3275a3316fc6SZhikuiRen msg.replace(argPos, argStr.length(), messageArg); 3276a3316fc6SZhikuiRen } 3277a3316fc6SZhikuiRen } 3278a3316fc6SZhikuiRen } 3279a3316fc6SZhikuiRen 3280d4342a92STim Lee // Get Severity template from message registry 3281d4342a92STim Lee std::string severity; 3282d4342a92STim Lee if (message != nullptr) 3283d4342a92STim Lee { 32845f2b84eeSEd Tanous severity = message->messageSeverity; 3285d4342a92STim Lee } 3286d4342a92STim Lee 3287a3316fc6SZhikuiRen // add to AsyncResp 3288a3316fc6SZhikuiRen logEntryArray.push_back({}); 3289a3316fc6SZhikuiRen nlohmann::json& bmcLogEntry = logEntryArray.back(); 3290*9c11a172SVijay Lobo bmcLogEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 329184afc48bSJason M. Bills bmcLogEntry["@odata.id"] = 32920fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 329384afc48bSJason M. Bills postcodeEntryID; 329484afc48bSJason M. Bills bmcLogEntry["Name"] = "POST Code Log Entry"; 329584afc48bSJason M. Bills bmcLogEntry["Id"] = postcodeEntryID; 329684afc48bSJason M. Bills bmcLogEntry["Message"] = std::move(msg); 329784afc48bSJason M. Bills bmcLogEntry["MessageId"] = "OpenBMC.0.2.BIOSPOSTCode"; 329884afc48bSJason M. Bills bmcLogEntry["MessageArgs"] = std::move(messageArgs); 329984afc48bSJason M. Bills bmcLogEntry["EntryType"] = "Event"; 330084afc48bSJason M. Bills bmcLogEntry["Severity"] = std::move(severity); 330184afc48bSJason M. Bills bmcLogEntry["Created"] = entryTimeStr; 3302647b3cdcSGeorge Liu if (!std::get<std::vector<uint8_t>>(code.second).empty()) 3303647b3cdcSGeorge Liu { 3304647b3cdcSGeorge Liu bmcLogEntry["AdditionalDataURI"] = 3305647b3cdcSGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 3306647b3cdcSGeorge Liu postcodeEntryID + "/attachment"; 3307647b3cdcSGeorge Liu } 3308a3316fc6SZhikuiRen } 3309a3316fc6SZhikuiRen } 3310a3316fc6SZhikuiRen 33118d1b46d7Szhanghch05 static void getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3312a3316fc6SZhikuiRen const uint16_t bootIndex, 3313a3316fc6SZhikuiRen const uint64_t codeIndex) 3314a3316fc6SZhikuiRen { 3315a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 33166c9a279eSManojkiran Eda [aResp, bootIndex, 33176c9a279eSManojkiran Eda codeIndex](const boost::system::error_code ec, 33186c9a279eSManojkiran Eda const boost::container::flat_map< 33196c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 33206c9a279eSManojkiran Eda postcode) { 3321a3316fc6SZhikuiRen if (ec) 3322a3316fc6SZhikuiRen { 3323a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3324a3316fc6SZhikuiRen messages::internalError(aResp->res); 3325a3316fc6SZhikuiRen return; 3326a3316fc6SZhikuiRen } 3327a3316fc6SZhikuiRen 3328a3316fc6SZhikuiRen // skip the empty postcode boots 3329a3316fc6SZhikuiRen if (postcode.empty()) 3330a3316fc6SZhikuiRen { 3331a3316fc6SZhikuiRen return; 3332a3316fc6SZhikuiRen } 3333a3316fc6SZhikuiRen 3334a3316fc6SZhikuiRen fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex); 3335a3316fc6SZhikuiRen 3336a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = 3337a3316fc6SZhikuiRen aResp->res.jsonValue["Members"].size(); 3338a3316fc6SZhikuiRen }, 333915124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 334015124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3341a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3342a3316fc6SZhikuiRen bootIndex); 3343a3316fc6SZhikuiRen } 3344a3316fc6SZhikuiRen 33458d1b46d7Szhanghch05 static void getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3346a3316fc6SZhikuiRen const uint16_t bootIndex, 3347a3316fc6SZhikuiRen const uint16_t bootCount, 33483648c8beSEd Tanous const uint64_t entryCount, size_t skip, 33493648c8beSEd Tanous size_t top) 3350a3316fc6SZhikuiRen { 3351a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3352a3316fc6SZhikuiRen [aResp, bootIndex, bootCount, entryCount, skip, 3353a3316fc6SZhikuiRen top](const boost::system::error_code ec, 33546c9a279eSManojkiran Eda const boost::container::flat_map< 33556c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 33566c9a279eSManojkiran Eda postcode) { 3357a3316fc6SZhikuiRen if (ec) 3358a3316fc6SZhikuiRen { 3359a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3360a3316fc6SZhikuiRen messages::internalError(aResp->res); 3361a3316fc6SZhikuiRen return; 3362a3316fc6SZhikuiRen } 3363a3316fc6SZhikuiRen 3364a3316fc6SZhikuiRen uint64_t endCount = entryCount; 3365a3316fc6SZhikuiRen if (!postcode.empty()) 3366a3316fc6SZhikuiRen { 3367a3316fc6SZhikuiRen endCount = entryCount + postcode.size(); 33683648c8beSEd Tanous if (skip < endCount && (top + skip) > entryCount) 3369a3316fc6SZhikuiRen { 33703648c8beSEd Tanous uint64_t thisBootSkip = 33713648c8beSEd Tanous std::max(static_cast<uint64_t>(skip), entryCount) - 33723648c8beSEd Tanous entryCount; 3373a3316fc6SZhikuiRen uint64_t thisBootTop = 33743648c8beSEd Tanous std::min(static_cast<uint64_t>(top + skip), endCount) - 33753648c8beSEd Tanous entryCount; 3376a3316fc6SZhikuiRen 3377002d39b4SEd Tanous fillPostCodeEntry(aResp, postcode, bootIndex, 0, thisBootSkip, 3378002d39b4SEd Tanous thisBootTop); 3379a3316fc6SZhikuiRen } 3380a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = endCount; 3381a3316fc6SZhikuiRen } 3382a3316fc6SZhikuiRen 3383a3316fc6SZhikuiRen // continue to previous bootIndex 3384a3316fc6SZhikuiRen if (bootIndex < bootCount) 3385a3316fc6SZhikuiRen { 3386a3316fc6SZhikuiRen getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1), 3387a3316fc6SZhikuiRen bootCount, endCount, skip, top); 3388a3316fc6SZhikuiRen } 338981584abeSJiaqing Zhao else if (skip + top < endCount) 3390a3316fc6SZhikuiRen { 3391a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.nextLink"] = 33920fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=" + 3393a3316fc6SZhikuiRen std::to_string(skip + top); 3394a3316fc6SZhikuiRen } 3395a3316fc6SZhikuiRen }, 339615124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 339715124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3398a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3399a3316fc6SZhikuiRen bootIndex); 3400a3316fc6SZhikuiRen } 3401a3316fc6SZhikuiRen 34028d1b46d7Szhanghch05 static void 34038d1b46d7Szhanghch05 getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 34043648c8beSEd Tanous size_t skip, size_t top) 3405a3316fc6SZhikuiRen { 3406a3316fc6SZhikuiRen uint64_t entryCount = 0; 34071e1e598dSJonathan Doman sdbusplus::asio::getProperty<uint16_t>( 34081e1e598dSJonathan Doman *crow::connections::systemBus, 34091e1e598dSJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 34101e1e598dSJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 34111e1e598dSJonathan Doman "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount", 34121e1e598dSJonathan Doman [aResp, entryCount, skip, top](const boost::system::error_code ec, 34131e1e598dSJonathan Doman const uint16_t bootCount) { 3414a3316fc6SZhikuiRen if (ec) 3415a3316fc6SZhikuiRen { 3416a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3417a3316fc6SZhikuiRen messages::internalError(aResp->res); 3418a3316fc6SZhikuiRen return; 3419a3316fc6SZhikuiRen } 34201e1e598dSJonathan Doman getPostCodeForBoot(aResp, 1, bootCount, entryCount, skip, top); 34211e1e598dSJonathan Doman }); 3422a3316fc6SZhikuiRen } 3423a3316fc6SZhikuiRen 34247e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntryCollection(App& app) 3425a3316fc6SZhikuiRen { 34267e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 34277e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/") 3428ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 34297e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 343045ca1b86SEd Tanous [&app](const crow::Request& req, 34317e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 3432c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 3433c937d2bfSEd Tanous .canDelegateTop = true, 3434c937d2bfSEd Tanous .canDelegateSkip = true, 3435c937d2bfSEd Tanous }; 3436c937d2bfSEd Tanous query_param::Query delegatedQuery; 3437c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 34383ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 343945ca1b86SEd Tanous { 344045ca1b86SEd Tanous return; 344145ca1b86SEd Tanous } 3442a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.type"] = 3443a3316fc6SZhikuiRen "#LogEntryCollection.LogEntryCollection"; 3444a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 3445a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3446a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3447a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3448a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3449a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3450a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 34513648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 34525143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 34533648c8beSEd Tanous getCurrentBootNumber(asyncResp, skip, top); 34547e860f15SJohn Edward Broadbent }); 3455a3316fc6SZhikuiRen } 3456a3316fc6SZhikuiRen 3457647b3cdcSGeorge Liu /** 3458647b3cdcSGeorge Liu * @brief Parse post code ID and get the current value and index value 3459647b3cdcSGeorge Liu * eg: postCodeID=B1-2, currentValue=1, index=2 3460647b3cdcSGeorge Liu * 3461647b3cdcSGeorge Liu * @param[in] postCodeID Post Code ID 3462647b3cdcSGeorge Liu * @param[out] currentValue Current value 3463647b3cdcSGeorge Liu * @param[out] index Index value 3464647b3cdcSGeorge Liu * 3465647b3cdcSGeorge Liu * @return bool true if the parsing is successful, false the parsing fails 3466647b3cdcSGeorge Liu */ 3467647b3cdcSGeorge Liu inline static bool parsePostCode(const std::string& postCodeID, 3468647b3cdcSGeorge Liu uint64_t& currentValue, uint16_t& index) 3469647b3cdcSGeorge Liu { 3470647b3cdcSGeorge Liu std::vector<std::string> split; 3471647b3cdcSGeorge Liu boost::algorithm::split(split, postCodeID, boost::is_any_of("-")); 3472647b3cdcSGeorge Liu if (split.size() != 2 || split[0].length() < 2 || split[0].front() != 'B') 3473647b3cdcSGeorge Liu { 3474647b3cdcSGeorge Liu return false; 3475647b3cdcSGeorge Liu } 3476647b3cdcSGeorge Liu 3477ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3478647b3cdcSGeorge Liu const char* start = split[0].data() + 1; 3479ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3480647b3cdcSGeorge Liu const char* end = split[0].data() + split[0].size(); 3481647b3cdcSGeorge Liu auto [ptrIndex, ecIndex] = std::from_chars(start, end, index); 3482647b3cdcSGeorge Liu 3483647b3cdcSGeorge Liu if (ptrIndex != end || ecIndex != std::errc()) 3484647b3cdcSGeorge Liu { 3485647b3cdcSGeorge Liu return false; 3486647b3cdcSGeorge Liu } 3487647b3cdcSGeorge Liu 3488647b3cdcSGeorge Liu start = split[1].data(); 3489ca45aa3cSEd Tanous 3490ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3491647b3cdcSGeorge Liu end = split[1].data() + split[1].size(); 3492647b3cdcSGeorge Liu auto [ptrValue, ecValue] = std::from_chars(start, end, currentValue); 3493647b3cdcSGeorge Liu 3494517d9a58STony Lee return ptrValue == end && ecValue == std::errc(); 3495647b3cdcSGeorge Liu } 3496647b3cdcSGeorge Liu 3497647b3cdcSGeorge Liu inline void requestRoutesPostCodesEntryAdditionalData(App& app) 3498647b3cdcSGeorge Liu { 34990fda0f12SGeorge Liu BMCWEB_ROUTE( 35000fda0f12SGeorge Liu app, 35010fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/attachment/") 3502647b3cdcSGeorge Liu .privileges(redfish::privileges::getLogEntry) 3503647b3cdcSGeorge Liu .methods(boost::beast::http::verb::get)( 350445ca1b86SEd Tanous [&app](const crow::Request& req, 3505647b3cdcSGeorge Liu const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3506647b3cdcSGeorge Liu const std::string& postCodeID) { 35073ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 350845ca1b86SEd Tanous { 350945ca1b86SEd Tanous return; 351045ca1b86SEd Tanous } 351199351cd8SEd Tanous if (http_helpers::isContentTypeAllowed( 351299351cd8SEd Tanous req.getHeaderValue("Accept"), 35134a0e1a0cSEd Tanous http_helpers::ContentType::OctetStream, true)) 3514647b3cdcSGeorge Liu { 3515002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::bad_request); 3516647b3cdcSGeorge Liu return; 3517647b3cdcSGeorge Liu } 3518647b3cdcSGeorge Liu 3519647b3cdcSGeorge Liu uint64_t currentValue = 0; 3520647b3cdcSGeorge Liu uint16_t index = 0; 3521647b3cdcSGeorge Liu if (!parsePostCode(postCodeID, currentValue, index)) 3522647b3cdcSGeorge Liu { 3523002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", postCodeID); 3524647b3cdcSGeorge Liu return; 3525647b3cdcSGeorge Liu } 3526647b3cdcSGeorge Liu 3527647b3cdcSGeorge Liu crow::connections::systemBus->async_method_call( 3528647b3cdcSGeorge Liu [asyncResp, postCodeID, currentValue]( 3529647b3cdcSGeorge Liu const boost::system::error_code ec, 3530002d39b4SEd Tanous const std::vector<std::tuple<uint64_t, std::vector<uint8_t>>>& 3531002d39b4SEd Tanous postcodes) { 3532647b3cdcSGeorge Liu if (ec.value() == EBADR) 3533647b3cdcSGeorge Liu { 3534002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 3535002d39b4SEd Tanous postCodeID); 3536647b3cdcSGeorge Liu return; 3537647b3cdcSGeorge Liu } 3538647b3cdcSGeorge Liu if (ec) 3539647b3cdcSGeorge Liu { 3540647b3cdcSGeorge Liu BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3541647b3cdcSGeorge Liu messages::internalError(asyncResp->res); 3542647b3cdcSGeorge Liu return; 3543647b3cdcSGeorge Liu } 3544647b3cdcSGeorge Liu 3545647b3cdcSGeorge Liu size_t value = static_cast<size_t>(currentValue) - 1; 3546002d39b4SEd Tanous if (value == std::string::npos || postcodes.size() < currentValue) 3547647b3cdcSGeorge Liu { 3548647b3cdcSGeorge Liu BMCWEB_LOG_ERROR << "Wrong currentValue value"; 3549002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 3550002d39b4SEd Tanous postCodeID); 3551647b3cdcSGeorge Liu return; 3552647b3cdcSGeorge Liu } 3553647b3cdcSGeorge Liu 35549eb808c1SEd Tanous const auto& [tID, c] = postcodes[value]; 355546ff87baSEd Tanous if (c.empty()) 3556647b3cdcSGeorge Liu { 3557647b3cdcSGeorge Liu BMCWEB_LOG_INFO << "No found post code data"; 3558002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 3559002d39b4SEd Tanous postCodeID); 3560647b3cdcSGeorge Liu return; 3561647b3cdcSGeorge Liu } 356246ff87baSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) 356346ff87baSEd Tanous const char* d = reinterpret_cast<const char*>(c.data()); 356446ff87baSEd Tanous std::string_view strData(d, c.size()); 3565647b3cdcSGeorge Liu 3566d9f6c621SEd Tanous asyncResp->res.addHeader(boost::beast::http::field::content_type, 3567647b3cdcSGeorge Liu "application/octet-stream"); 3568d9f6c621SEd Tanous asyncResp->res.addHeader( 3569d9f6c621SEd Tanous boost::beast::http::field::content_transfer_encoding, "Base64"); 3570002d39b4SEd Tanous asyncResp->res.body() = crow::utility::base64encode(strData); 3571647b3cdcSGeorge Liu }, 3572647b3cdcSGeorge Liu "xyz.openbmc_project.State.Boot.PostCode0", 3573647b3cdcSGeorge Liu "/xyz/openbmc_project/State/Boot/PostCode0", 3574002d39b4SEd Tanous "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", index); 3575647b3cdcSGeorge Liu }); 3576647b3cdcSGeorge Liu } 3577647b3cdcSGeorge Liu 35787e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntry(App& app) 3579a3316fc6SZhikuiRen { 35807e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 35817e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/") 3582ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 35837e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 358445ca1b86SEd Tanous [&app](const crow::Request& req, 35857e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 35867e860f15SJohn Edward Broadbent const std::string& targetID) { 35873ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 358845ca1b86SEd Tanous { 358945ca1b86SEd Tanous return; 359045ca1b86SEd Tanous } 3591647b3cdcSGeorge Liu uint16_t bootIndex = 0; 3592647b3cdcSGeorge Liu uint64_t codeIndex = 0; 3593647b3cdcSGeorge Liu if (!parsePostCode(targetID, codeIndex, bootIndex)) 3594a3316fc6SZhikuiRen { 3595a3316fc6SZhikuiRen // Requested ID was not found 3596ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 3597a3316fc6SZhikuiRen return; 3598a3316fc6SZhikuiRen } 3599a3316fc6SZhikuiRen if (bootIndex == 0 || codeIndex == 0) 3600a3316fc6SZhikuiRen { 3601a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string " 36027e860f15SJohn Edward Broadbent << targetID; 3603a3316fc6SZhikuiRen } 3604a3316fc6SZhikuiRen 3605*9c11a172SVijay Lobo asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 3606a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 36070fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3608a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3609a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3610a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3611a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3612a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 3613a3316fc6SZhikuiRen 3614a3316fc6SZhikuiRen getPostCodeForEntry(asyncResp, bootIndex, codeIndex); 36157e860f15SJohn Edward Broadbent }); 3616a3316fc6SZhikuiRen } 3617a3316fc6SZhikuiRen 36181da66f75SEd Tanous } // namespace redfish 3619