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 499647b3cdcSGeorge Liu thisEntry["@odata.type"] = "#LogEntry.v1_8_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"] = 591647b3cdcSGeorge Liu "#LogEntry.v1_8_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"]; 975*613dabeaSEd Tanous nlohmann::json::object_t member; 976*613dabeaSEd Tanous member["@odata.id"] = 977*613dabeaSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes"; 978*613dabeaSEd Tanous 979*613dabeaSEd Tanous logServiceArrayLocal.push_back(std::move(member)); 980*613dabeaSEd 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 116084afc48bSJason M. Bills logEntryJson["@odata.type"] = "#LogEntry.v1_8_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; 137975710de2SXiaochao Ma bool resolved = false; 13809eb808c1SEd Tanous for (const auto& interfaceMap : objectPath.second) 1381f86bb901SAdriana Kobylak { 1382f86bb901SAdriana Kobylak if (interfaceMap.first == 1383f86bb901SAdriana Kobylak "xyz.openbmc_project.Logging.Entry") 1384f86bb901SAdriana Kobylak { 1385002d39b4SEd Tanous for (const auto& propertyMap : interfaceMap.second) 1386cb92c03bSAndrew Geissler { 1387cb92c03bSAndrew Geissler if (propertyMap.first == "Id") 1388cb92c03bSAndrew Geissler { 1389002d39b4SEd Tanous id = std::get_if<uint32_t>(&propertyMap.second); 1390cb92c03bSAndrew Geissler } 1391cb92c03bSAndrew Geissler else if (propertyMap.first == "Timestamp") 1392cb92c03bSAndrew Geissler { 1393002d39b4SEd Tanous timestamp = 1394002d39b4SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 13957e860f15SJohn Edward Broadbent } 1396002d39b4SEd Tanous else if (propertyMap.first == "UpdateTimestamp") 13977e860f15SJohn Edward Broadbent { 1398002d39b4SEd Tanous updateTimestamp = 1399002d39b4SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 14007e860f15SJohn Edward Broadbent } 14017e860f15SJohn Edward Broadbent else if (propertyMap.first == "Severity") 14027e860f15SJohn Edward Broadbent { 14037e860f15SJohn Edward Broadbent severity = std::get_if<std::string>( 14047e860f15SJohn Edward Broadbent &propertyMap.second); 14057e860f15SJohn Edward Broadbent } 14067e860f15SJohn Edward Broadbent else if (propertyMap.first == "Message") 14077e860f15SJohn Edward Broadbent { 14087e860f15SJohn Edward Broadbent message = std::get_if<std::string>( 14097e860f15SJohn Edward Broadbent &propertyMap.second); 14107e860f15SJohn Edward Broadbent } 14117e860f15SJohn Edward Broadbent else if (propertyMap.first == "Resolved") 14127e860f15SJohn Edward Broadbent { 1413914e2d5dSEd Tanous const bool* resolveptr = 1414002d39b4SEd Tanous std::get_if<bool>(&propertyMap.second); 14157e860f15SJohn Edward Broadbent if (resolveptr == nullptr) 14167e860f15SJohn Edward Broadbent { 1417002d39b4SEd Tanous messages::internalError(asyncResp->res); 14187e860f15SJohn Edward Broadbent return; 14197e860f15SJohn Edward Broadbent } 14207e860f15SJohn Edward Broadbent resolved = *resolveptr; 14217e860f15SJohn Edward Broadbent } 14227e860f15SJohn Edward Broadbent } 14237e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 14247e860f15SJohn Edward Broadbent severity == nullptr) 14257e860f15SJohn Edward Broadbent { 14267e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 14277e860f15SJohn Edward Broadbent return; 14287e860f15SJohn Edward Broadbent } 14297e860f15SJohn Edward Broadbent } 14307e860f15SJohn Edward Broadbent else if (interfaceMap.first == 14317e860f15SJohn Edward Broadbent "xyz.openbmc_project.Common.FilePath") 14327e860f15SJohn Edward Broadbent { 1433002d39b4SEd Tanous for (const auto& propertyMap : interfaceMap.second) 14347e860f15SJohn Edward Broadbent { 14357e860f15SJohn Edward Broadbent if (propertyMap.first == "Path") 14367e860f15SJohn Edward Broadbent { 14377e860f15SJohn Edward Broadbent filePath = std::get_if<std::string>( 14387e860f15SJohn Edward Broadbent &propertyMap.second); 14397e860f15SJohn Edward Broadbent } 14407e860f15SJohn Edward Broadbent } 14417e860f15SJohn Edward Broadbent } 14427e860f15SJohn Edward Broadbent } 14437e860f15SJohn Edward Broadbent // Object path without the 14447e860f15SJohn Edward Broadbent // xyz.openbmc_project.Logging.Entry interface, ignore 14457e860f15SJohn Edward Broadbent // and continue. 14467e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 1447c419c759SEd Tanous severity == nullptr || timestamp == nullptr || 1448c419c759SEd Tanous updateTimestamp == nullptr) 14497e860f15SJohn Edward Broadbent { 14507e860f15SJohn Edward Broadbent continue; 14517e860f15SJohn Edward Broadbent } 14527e860f15SJohn Edward Broadbent entriesArray.push_back({}); 14537e860f15SJohn Edward Broadbent nlohmann::json& thisEntry = entriesArray.back(); 14547e860f15SJohn Edward Broadbent thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 14557e860f15SJohn Edward Broadbent thisEntry["@odata.id"] = 14560fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 14577e860f15SJohn Edward Broadbent std::to_string(*id); 14587e860f15SJohn Edward Broadbent thisEntry["Name"] = "System Event Log Entry"; 14597e860f15SJohn Edward Broadbent thisEntry["Id"] = std::to_string(*id); 14607e860f15SJohn Edward Broadbent thisEntry["Message"] = *message; 14617e860f15SJohn Edward Broadbent thisEntry["Resolved"] = resolved; 14627e860f15SJohn Edward Broadbent thisEntry["EntryType"] = "Event"; 14637e860f15SJohn Edward Broadbent thisEntry["Severity"] = 14647e860f15SJohn Edward Broadbent translateSeverityDbusToRedfish(*severity); 14657e860f15SJohn Edward Broadbent thisEntry["Created"] = 14662b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*timestamp); 14677e860f15SJohn Edward Broadbent thisEntry["Modified"] = 14682b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 14697e860f15SJohn Edward Broadbent if (filePath != nullptr) 14707e860f15SJohn Edward Broadbent { 14717e860f15SJohn Edward Broadbent thisEntry["AdditionalDataURI"] = 14720fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 14737e860f15SJohn Edward Broadbent std::to_string(*id) + "/attachment"; 14747e860f15SJohn Edward Broadbent } 14757e860f15SJohn Edward Broadbent } 1476002d39b4SEd Tanous std::sort( 1477002d39b4SEd Tanous entriesArray.begin(), entriesArray.end(), 1478002d39b4SEd Tanous [](const nlohmann::json& left, const nlohmann::json& right) { 14797e860f15SJohn Edward Broadbent return (left["Id"] <= right["Id"]); 14807e860f15SJohn Edward Broadbent }); 14817e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members@odata.count"] = 14827e860f15SJohn Edward Broadbent entriesArray.size(); 14837e860f15SJohn Edward Broadbent }, 14847e860f15SJohn Edward Broadbent "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging", 14857e860f15SJohn Edward Broadbent "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 14867e860f15SJohn Edward Broadbent }); 14877e860f15SJohn Edward Broadbent } 14887e860f15SJohn Edward Broadbent 14897e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app) 14907e860f15SJohn Edward Broadbent { 14917e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 14927e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1493ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 1494002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1495002d39b4SEd Tanous [&app](const crow::Request& req, 14967e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 149745ca1b86SEd Tanous const std::string& param) { 14983ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 14997e860f15SJohn Edward Broadbent { 150045ca1b86SEd Tanous return; 150145ca1b86SEd Tanous } 15027e860f15SJohn Edward Broadbent std::string entryID = param; 15037e860f15SJohn Edward Broadbent dbus::utility::escapePathForDbus(entryID); 15047e860f15SJohn Edward Broadbent 15057e860f15SJohn Edward Broadbent // DBus implementation of EventLog/Entries 15067e860f15SJohn Edward Broadbent // Make call to Logging Service to find all log entry objects 1507d1bde9e5SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 1508d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, "xyz.openbmc_project.Logging", 1509d1bde9e5SKrzysztof Grobelny "/xyz/openbmc_project/logging/entry/" + entryID, "", 1510002d39b4SEd Tanous [asyncResp, entryID](const boost::system::error_code ec, 1511b9d36b47SEd Tanous const dbus::utility::DBusPropertiesMap& resp) { 15127e860f15SJohn Edward Broadbent if (ec.value() == EBADR) 15137e860f15SJohn Edward Broadbent { 1514d1bde9e5SKrzysztof Grobelny messages::resourceNotFound(asyncResp->res, "EventLogEntry", 1515d1bde9e5SKrzysztof Grobelny entryID); 15167e860f15SJohn Edward Broadbent return; 15177e860f15SJohn Edward Broadbent } 15187e860f15SJohn Edward Broadbent if (ec) 15197e860f15SJohn Edward Broadbent { 15200fda0f12SGeorge Liu BMCWEB_LOG_ERROR 1521002d39b4SEd Tanous << "EventLogEntry (DBus) resp_handler got error " << ec; 15227e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 15237e860f15SJohn Edward Broadbent return; 15247e860f15SJohn Edward Broadbent } 1525914e2d5dSEd Tanous const uint32_t* id = nullptr; 1526c419c759SEd Tanous const uint64_t* timestamp = nullptr; 1527c419c759SEd Tanous const uint64_t* updateTimestamp = nullptr; 1528914e2d5dSEd Tanous const std::string* severity = nullptr; 1529914e2d5dSEd Tanous const std::string* message = nullptr; 1530914e2d5dSEd Tanous const std::string* filePath = nullptr; 15317e860f15SJohn Edward Broadbent bool resolved = false; 15327e860f15SJohn Edward Broadbent 1533d1bde9e5SKrzysztof Grobelny const bool success = sdbusplus::unpackPropertiesNoThrow( 1534d1bde9e5SKrzysztof Grobelny dbus_utils::UnpackErrorPrinter(), resp, "Id", id, "Timestamp", 1535d1bde9e5SKrzysztof Grobelny timestamp, "UpdateTimestamp", updateTimestamp, "Severity", 1536d1bde9e5SKrzysztof Grobelny severity, "Message", message, "Resolved", resolved, "Path", 1537d1bde9e5SKrzysztof Grobelny filePath); 1538d1bde9e5SKrzysztof Grobelny 1539d1bde9e5SKrzysztof Grobelny if (!success) 154075710de2SXiaochao Ma { 154175710de2SXiaochao Ma messages::internalError(asyncResp->res); 154275710de2SXiaochao Ma return; 154375710de2SXiaochao Ma } 1544d1bde9e5SKrzysztof Grobelny 1545002d39b4SEd Tanous if (id == nullptr || message == nullptr || severity == nullptr || 1546002d39b4SEd Tanous timestamp == nullptr || updateTimestamp == nullptr) 1547f86bb901SAdriana Kobylak { 1548ae34c8e8SAdriana Kobylak messages::internalError(asyncResp->res); 1549271584abSEd Tanous return; 1550271584abSEd Tanous } 1551f86bb901SAdriana Kobylak asyncResp->res.jsonValue["@odata.type"] = 1552f86bb901SAdriana Kobylak "#LogEntry.v1_8_0.LogEntry"; 1553f86bb901SAdriana Kobylak asyncResp->res.jsonValue["@odata.id"] = 15540fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1555f86bb901SAdriana Kobylak std::to_string(*id); 155645ca1b86SEd Tanous asyncResp->res.jsonValue["Name"] = "System Event Log Entry"; 1557f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Id"] = std::to_string(*id); 1558f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Message"] = *message; 1559f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Resolved"] = resolved; 1560f86bb901SAdriana Kobylak asyncResp->res.jsonValue["EntryType"] = "Event"; 1561f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Severity"] = 1562f86bb901SAdriana Kobylak translateSeverityDbusToRedfish(*severity); 1563f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Created"] = 15642b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*timestamp); 1565f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Modified"] = 15662b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 1567f86bb901SAdriana Kobylak if (filePath != nullptr) 1568f86bb901SAdriana Kobylak { 1569f86bb901SAdriana Kobylak asyncResp->res.jsonValue["AdditionalDataURI"] = 1570e7dbd530SPotin Lai "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1571e7dbd530SPotin Lai std::to_string(*id) + "/attachment"; 1572f86bb901SAdriana Kobylak } 1573d1bde9e5SKrzysztof Grobelny }); 15747e860f15SJohn Edward Broadbent }); 1575336e96c6SChicago Duan 15767e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 15777e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1578ed398213SEd Tanous .privileges(redfish::privileges::patchLogEntry) 15797e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::patch)( 158045ca1b86SEd Tanous [&app](const crow::Request& req, 15817e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 15827e860f15SJohn Edward Broadbent const std::string& entryId) { 15833ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 158445ca1b86SEd Tanous { 158545ca1b86SEd Tanous return; 158645ca1b86SEd Tanous } 158775710de2SXiaochao Ma std::optional<bool> resolved; 158875710de2SXiaochao Ma 158915ed6780SWilly Tu if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved", 15907e860f15SJohn Edward Broadbent resolved)) 159175710de2SXiaochao Ma { 159275710de2SXiaochao Ma return; 159375710de2SXiaochao Ma } 159475710de2SXiaochao Ma BMCWEB_LOG_DEBUG << "Set Resolved"; 159575710de2SXiaochao Ma 159675710de2SXiaochao Ma crow::connections::systemBus->async_method_call( 15974f48d5f6SEd Tanous [asyncResp, entryId](const boost::system::error_code ec) { 159875710de2SXiaochao Ma if (ec) 159975710de2SXiaochao Ma { 160075710de2SXiaochao Ma BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 160175710de2SXiaochao Ma messages::internalError(asyncResp->res); 160275710de2SXiaochao Ma return; 160375710de2SXiaochao Ma } 160475710de2SXiaochao Ma }, 160575710de2SXiaochao Ma "xyz.openbmc_project.Logging", 160675710de2SXiaochao Ma "/xyz/openbmc_project/logging/entry/" + entryId, 160775710de2SXiaochao Ma "org.freedesktop.DBus.Properties", "Set", 160875710de2SXiaochao Ma "xyz.openbmc_project.Logging.Entry", "Resolved", 1609168e20c1SEd Tanous dbus::utility::DbusVariantType(*resolved)); 16107e860f15SJohn Edward Broadbent }); 161175710de2SXiaochao Ma 16127e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 16137e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1614ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 1615ed398213SEd Tanous 1616002d39b4SEd Tanous .methods(boost::beast::http::verb::delete_)( 1617002d39b4SEd Tanous [&app](const crow::Request& req, 1618002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 161945ca1b86SEd Tanous const std::string& param) { 16203ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1621336e96c6SChicago Duan { 162245ca1b86SEd Tanous return; 162345ca1b86SEd Tanous } 1624336e96c6SChicago Duan BMCWEB_LOG_DEBUG << "Do delete single event entries."; 1625336e96c6SChicago Duan 16267e860f15SJohn Edward Broadbent std::string entryID = param; 1627336e96c6SChicago Duan 1628336e96c6SChicago Duan dbus::utility::escapePathForDbus(entryID); 1629336e96c6SChicago Duan 1630336e96c6SChicago Duan // Process response from Logging service. 1631002d39b4SEd Tanous auto respHandler = 1632002d39b4SEd Tanous [asyncResp, entryID](const boost::system::error_code ec) { 1633002d39b4SEd Tanous BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done"; 1634336e96c6SChicago Duan if (ec) 1635336e96c6SChicago Duan { 16363de8d8baSGeorge Liu if (ec.value() == EBADR) 16373de8d8baSGeorge Liu { 163845ca1b86SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 163945ca1b86SEd Tanous entryID); 16403de8d8baSGeorge Liu return; 16413de8d8baSGeorge Liu } 1642336e96c6SChicago Duan // TODO Handle for specific error code 16430fda0f12SGeorge Liu BMCWEB_LOG_ERROR 16440fda0f12SGeorge Liu << "EventLogEntry (DBus) doDelete respHandler got error " 1645336e96c6SChicago Duan << ec; 1646336e96c6SChicago Duan asyncResp->res.result( 1647336e96c6SChicago Duan boost::beast::http::status::internal_server_error); 1648336e96c6SChicago Duan return; 1649336e96c6SChicago Duan } 1650336e96c6SChicago Duan 1651336e96c6SChicago Duan asyncResp->res.result(boost::beast::http::status::ok); 1652336e96c6SChicago Duan }; 1653336e96c6SChicago Duan 1654336e96c6SChicago Duan // Make call to Logging service to request Delete Log 1655336e96c6SChicago Duan crow::connections::systemBus->async_method_call( 1656336e96c6SChicago Duan respHandler, "xyz.openbmc_project.Logging", 1657336e96c6SChicago Duan "/xyz/openbmc_project/logging/entry/" + entryID, 1658336e96c6SChicago Duan "xyz.openbmc_project.Object.Delete", "Delete"); 16597e860f15SJohn Edward Broadbent }); 1660400fd1fbSAdriana Kobylak } 1661400fd1fbSAdriana Kobylak 16627e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryDownload(App& app) 1663400fd1fbSAdriana Kobylak { 16640fda0f12SGeorge Liu BMCWEB_ROUTE( 16650fda0f12SGeorge Liu app, 16660fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/attachment") 1667ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 16687e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 166945ca1b86SEd Tanous [&app](const crow::Request& req, 16707e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 167145ca1b86SEd Tanous const std::string& param) { 16723ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 16737e860f15SJohn Edward Broadbent { 167445ca1b86SEd Tanous return; 167545ca1b86SEd Tanous } 1676002d39b4SEd Tanous if (!http_helpers::isOctetAccepted(req.getHeaderValue("Accept"))) 1677400fd1fbSAdriana Kobylak { 1678002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::bad_request); 1679400fd1fbSAdriana Kobylak return; 1680400fd1fbSAdriana Kobylak } 1681400fd1fbSAdriana Kobylak 16827e860f15SJohn Edward Broadbent std::string entryID = param; 1683400fd1fbSAdriana Kobylak dbus::utility::escapePathForDbus(entryID); 1684400fd1fbSAdriana Kobylak 1685400fd1fbSAdriana Kobylak crow::connections::systemBus->async_method_call( 1686002d39b4SEd Tanous [asyncResp, entryID](const boost::system::error_code ec, 1687400fd1fbSAdriana Kobylak const sdbusplus::message::unix_fd& unixfd) { 1688400fd1fbSAdriana Kobylak if (ec.value() == EBADR) 1689400fd1fbSAdriana Kobylak { 1690002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "EventLogAttachment", 1691002d39b4SEd Tanous entryID); 1692400fd1fbSAdriana Kobylak return; 1693400fd1fbSAdriana Kobylak } 1694400fd1fbSAdriana Kobylak if (ec) 1695400fd1fbSAdriana Kobylak { 1696400fd1fbSAdriana Kobylak BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 1697400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1698400fd1fbSAdriana Kobylak return; 1699400fd1fbSAdriana Kobylak } 1700400fd1fbSAdriana Kobylak 1701400fd1fbSAdriana Kobylak int fd = -1; 1702400fd1fbSAdriana Kobylak fd = dup(unixfd); 1703400fd1fbSAdriana Kobylak if (fd == -1) 1704400fd1fbSAdriana Kobylak { 1705400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1706400fd1fbSAdriana Kobylak return; 1707400fd1fbSAdriana Kobylak } 1708400fd1fbSAdriana Kobylak 1709400fd1fbSAdriana Kobylak long long int size = lseek(fd, 0, SEEK_END); 1710400fd1fbSAdriana Kobylak if (size == -1) 1711400fd1fbSAdriana Kobylak { 1712400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1713400fd1fbSAdriana Kobylak return; 1714400fd1fbSAdriana Kobylak } 1715400fd1fbSAdriana Kobylak 1716400fd1fbSAdriana Kobylak // Arbitrary max size of 64kb 1717400fd1fbSAdriana Kobylak constexpr int maxFileSize = 65536; 1718400fd1fbSAdriana Kobylak if (size > maxFileSize) 1719400fd1fbSAdriana Kobylak { 1720002d39b4SEd Tanous BMCWEB_LOG_ERROR << "File size exceeds maximum allowed size of " 1721400fd1fbSAdriana Kobylak << maxFileSize; 1722400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1723400fd1fbSAdriana Kobylak return; 1724400fd1fbSAdriana Kobylak } 1725400fd1fbSAdriana Kobylak std::vector<char> data(static_cast<size_t>(size)); 1726400fd1fbSAdriana Kobylak long long int rc = lseek(fd, 0, SEEK_SET); 1727400fd1fbSAdriana Kobylak if (rc == -1) 1728400fd1fbSAdriana Kobylak { 1729400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1730400fd1fbSAdriana Kobylak return; 1731400fd1fbSAdriana Kobylak } 1732400fd1fbSAdriana Kobylak rc = read(fd, data.data(), data.size()); 1733400fd1fbSAdriana Kobylak if ((rc == -1) || (rc != size)) 1734400fd1fbSAdriana Kobylak { 1735400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1736400fd1fbSAdriana Kobylak return; 1737400fd1fbSAdriana Kobylak } 1738400fd1fbSAdriana Kobylak close(fd); 1739400fd1fbSAdriana Kobylak 1740400fd1fbSAdriana Kobylak std::string_view strData(data.data(), data.size()); 1741002d39b4SEd Tanous std::string output = crow::utility::base64encode(strData); 1742400fd1fbSAdriana Kobylak 1743d9f6c621SEd Tanous asyncResp->res.addHeader(boost::beast::http::field::content_type, 1744400fd1fbSAdriana Kobylak "application/octet-stream"); 1745d9f6c621SEd Tanous asyncResp->res.addHeader( 1746d9f6c621SEd Tanous boost::beast::http::field::content_transfer_encoding, "Base64"); 1747400fd1fbSAdriana Kobylak asyncResp->res.body() = std::move(output); 1748400fd1fbSAdriana Kobylak }, 1749400fd1fbSAdriana Kobylak "xyz.openbmc_project.Logging", 1750400fd1fbSAdriana Kobylak "/xyz/openbmc_project/logging/entry/" + entryID, 1751400fd1fbSAdriana Kobylak "xyz.openbmc_project.Logging.Entry", "GetEntry"); 17527e860f15SJohn Edward Broadbent }); 17531da66f75SEd Tanous } 17541da66f75SEd Tanous 1755b7028ebfSSpencer Ku constexpr const char* hostLoggerFolderPath = "/var/log/console"; 1756b7028ebfSSpencer Ku 1757b7028ebfSSpencer Ku inline bool 1758b7028ebfSSpencer Ku getHostLoggerFiles(const std::string& hostLoggerFilePath, 1759b7028ebfSSpencer Ku std::vector<std::filesystem::path>& hostLoggerFiles) 1760b7028ebfSSpencer Ku { 1761b7028ebfSSpencer Ku std::error_code ec; 1762b7028ebfSSpencer Ku std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec); 1763b7028ebfSSpencer Ku if (ec) 1764b7028ebfSSpencer Ku { 1765b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << ec.message(); 1766b7028ebfSSpencer Ku return false; 1767b7028ebfSSpencer Ku } 1768b7028ebfSSpencer Ku for (const std::filesystem::directory_entry& it : logPath) 1769b7028ebfSSpencer Ku { 1770b7028ebfSSpencer Ku std::string filename = it.path().filename(); 1771b7028ebfSSpencer Ku // Prefix of each log files is "log". Find the file and save the 1772b7028ebfSSpencer Ku // path 177311ba3979SEd Tanous if (filename.starts_with("log")) 1774b7028ebfSSpencer Ku { 1775b7028ebfSSpencer Ku hostLoggerFiles.emplace_back(it.path()); 1776b7028ebfSSpencer Ku } 1777b7028ebfSSpencer Ku } 1778b7028ebfSSpencer Ku // As the log files rotate, they are appended with a ".#" that is higher for 1779b7028ebfSSpencer Ku // the older logs. Since we start from oldest logs, sort the name in 1780b7028ebfSSpencer Ku // descending order. 1781b7028ebfSSpencer Ku std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(), 1782b7028ebfSSpencer Ku AlphanumLess<std::string>()); 1783b7028ebfSSpencer Ku 1784b7028ebfSSpencer Ku return true; 1785b7028ebfSSpencer Ku } 1786b7028ebfSSpencer Ku 178702cad96eSEd Tanous inline bool getHostLoggerEntries( 178802cad96eSEd Tanous const std::vector<std::filesystem::path>& hostLoggerFiles, uint64_t skip, 178902cad96eSEd Tanous uint64_t top, std::vector<std::string>& logEntries, size_t& logCount) 1790b7028ebfSSpencer Ku { 1791b7028ebfSSpencer Ku GzFileReader logFile; 1792b7028ebfSSpencer Ku 1793b7028ebfSSpencer Ku // Go though all log files and expose host logs. 1794b7028ebfSSpencer Ku for (const std::filesystem::path& it : hostLoggerFiles) 1795b7028ebfSSpencer Ku { 1796b7028ebfSSpencer Ku if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount)) 1797b7028ebfSSpencer Ku { 1798b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << "fail to expose host logs"; 1799b7028ebfSSpencer Ku return false; 1800b7028ebfSSpencer Ku } 1801b7028ebfSSpencer Ku } 1802b7028ebfSSpencer Ku // Get lastMessage from constructor by getter 1803b7028ebfSSpencer Ku std::string lastMessage = logFile.getLastMessage(); 1804b7028ebfSSpencer Ku if (!lastMessage.empty()) 1805b7028ebfSSpencer Ku { 1806b7028ebfSSpencer Ku logCount++; 1807b7028ebfSSpencer Ku if (logCount > skip && logCount <= (skip + top)) 1808b7028ebfSSpencer Ku { 1809b7028ebfSSpencer Ku logEntries.push_back(lastMessage); 1810b7028ebfSSpencer Ku } 1811b7028ebfSSpencer Ku } 1812b7028ebfSSpencer Ku return true; 1813b7028ebfSSpencer Ku } 1814b7028ebfSSpencer Ku 1815b7028ebfSSpencer Ku inline void fillHostLoggerEntryJson(const std::string& logEntryID, 1816b7028ebfSSpencer Ku const std::string& msg, 18176d6574c9SJason M. Bills nlohmann::json::object_t& logEntryJson) 1818b7028ebfSSpencer Ku { 1819b7028ebfSSpencer Ku // Fill in the log entry with the gathered data. 18206d6574c9SJason M. Bills logEntryJson["@odata.type"] = "#LogEntry.v1_4_0.LogEntry"; 18216d6574c9SJason M. Bills logEntryJson["@odata.id"] = 1822b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/" + 18236d6574c9SJason M. Bills logEntryID; 18246d6574c9SJason M. Bills logEntryJson["Name"] = "Host Logger Entry"; 18256d6574c9SJason M. Bills logEntryJson["Id"] = logEntryID; 18266d6574c9SJason M. Bills logEntryJson["Message"] = msg; 18276d6574c9SJason M. Bills logEntryJson["EntryType"] = "Oem"; 18286d6574c9SJason M. Bills logEntryJson["Severity"] = "OK"; 18296d6574c9SJason M. Bills logEntryJson["OemRecordFormat"] = "Host Logger Entry"; 1830b7028ebfSSpencer Ku } 1831b7028ebfSSpencer Ku 1832b7028ebfSSpencer Ku inline void requestRoutesSystemHostLogger(App& app) 1833b7028ebfSSpencer Ku { 1834b7028ebfSSpencer Ku BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/HostLogger/") 1835b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogService) 18361476687dSEd Tanous .methods(boost::beast::http::verb::get)( 18371476687dSEd Tanous [&app](const crow::Request& req, 18381476687dSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 18393ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 184045ca1b86SEd Tanous { 184145ca1b86SEd Tanous return; 184245ca1b86SEd Tanous } 1843b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 1844b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger"; 1845b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 1846b7028ebfSSpencer Ku "#LogService.v1_1_0.LogService"; 1847b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "Host Logger Service"; 1848b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = "Host Logger Service"; 1849b7028ebfSSpencer Ku asyncResp->res.jsonValue["Id"] = "HostLogger"; 18501476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 18511476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 1852b7028ebfSSpencer Ku }); 1853b7028ebfSSpencer Ku } 1854b7028ebfSSpencer Ku 1855b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerCollection(App& app) 1856b7028ebfSSpencer Ku { 1857b7028ebfSSpencer Ku BMCWEB_ROUTE(app, 1858b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/") 1859b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 1860002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1861002d39b4SEd Tanous [&app](const crow::Request& req, 1862002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1863c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 1864c937d2bfSEd Tanous .canDelegateTop = true, 1865c937d2bfSEd Tanous .canDelegateSkip = true, 1866c937d2bfSEd Tanous }; 1867c937d2bfSEd Tanous query_param::Query delegatedQuery; 1868c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 18693ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 1870b7028ebfSSpencer Ku { 1871b7028ebfSSpencer Ku return; 1872b7028ebfSSpencer Ku } 1873b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 1874b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 1875b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 1876b7028ebfSSpencer Ku "#LogEntryCollection.LogEntryCollection"; 1877b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "HostLogger Entries"; 1878b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = 1879b7028ebfSSpencer Ku "Collection of HostLogger Entries"; 18800fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1881b7028ebfSSpencer Ku logEntryArray = nlohmann::json::array(); 1882b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = 0; 1883b7028ebfSSpencer Ku 1884b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 1885b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 1886b7028ebfSSpencer Ku { 1887b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << "fail to get host log file path"; 1888b7028ebfSSpencer Ku return; 1889b7028ebfSSpencer Ku } 18903648c8beSEd Tanous // If we weren't provided top and skip limits, use the defaults. 18913648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 18925143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 1893b7028ebfSSpencer Ku size_t logCount = 0; 1894b7028ebfSSpencer Ku // This vector only store the entries we want to expose that 1895b7028ebfSSpencer Ku // control by skip and top. 1896b7028ebfSSpencer Ku std::vector<std::string> logEntries; 18973648c8beSEd Tanous if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries, 18983648c8beSEd Tanous logCount)) 1899b7028ebfSSpencer Ku { 1900b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 1901b7028ebfSSpencer Ku return; 1902b7028ebfSSpencer Ku } 1903b7028ebfSSpencer Ku // If vector is empty, that means skip value larger than total 1904b7028ebfSSpencer Ku // log count 190526f6976fSEd Tanous if (logEntries.empty()) 1906b7028ebfSSpencer Ku { 1907b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 1908b7028ebfSSpencer Ku return; 1909b7028ebfSSpencer Ku } 191026f6976fSEd Tanous if (!logEntries.empty()) 1911b7028ebfSSpencer Ku { 1912b7028ebfSSpencer Ku for (size_t i = 0; i < logEntries.size(); i++) 1913b7028ebfSSpencer Ku { 19146d6574c9SJason M. Bills nlohmann::json::object_t hostLogEntry; 19153648c8beSEd Tanous fillHostLoggerEntryJson(std::to_string(skip + i), logEntries[i], 19163648c8beSEd Tanous hostLogEntry); 19176d6574c9SJason M. Bills logEntryArray.push_back(std::move(hostLogEntry)); 1918b7028ebfSSpencer Ku } 1919b7028ebfSSpencer Ku 1920b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 19213648c8beSEd Tanous if (skip + top < logCount) 1922b7028ebfSSpencer Ku { 1923b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.nextLink"] = 19240fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/HostLogger/Entries?$skip=" + 19253648c8beSEd Tanous std::to_string(skip + top); 1926b7028ebfSSpencer Ku } 1927b7028ebfSSpencer Ku } 1928b7028ebfSSpencer Ku }); 1929b7028ebfSSpencer Ku } 1930b7028ebfSSpencer Ku 1931b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerLogEntry(App& app) 1932b7028ebfSSpencer Ku { 1933b7028ebfSSpencer Ku BMCWEB_ROUTE( 1934b7028ebfSSpencer Ku app, "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/<str>/") 1935b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 1936b7028ebfSSpencer Ku .methods(boost::beast::http::verb::get)( 193745ca1b86SEd Tanous [&app](const crow::Request& req, 1938b7028ebfSSpencer Ku const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1939b7028ebfSSpencer Ku const std::string& param) { 19403ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 194145ca1b86SEd Tanous { 194245ca1b86SEd Tanous return; 194345ca1b86SEd Tanous } 1944b7028ebfSSpencer Ku const std::string& targetID = param; 1945b7028ebfSSpencer Ku 1946b7028ebfSSpencer Ku uint64_t idInt = 0; 1947ca45aa3cSEd Tanous 1948ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 1949ca45aa3cSEd Tanous const char* end = targetID.data() + targetID.size(); 1950ca45aa3cSEd Tanous 1951ca45aa3cSEd Tanous auto [ptr, ec] = std::from_chars(targetID.data(), end, idInt); 1952b7028ebfSSpencer Ku if (ec == std::errc::invalid_argument) 1953b7028ebfSSpencer Ku { 1954ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 1955b7028ebfSSpencer Ku return; 1956b7028ebfSSpencer Ku } 1957b7028ebfSSpencer Ku if (ec == std::errc::result_out_of_range) 1958b7028ebfSSpencer Ku { 1959ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 1960b7028ebfSSpencer Ku return; 1961b7028ebfSSpencer Ku } 1962b7028ebfSSpencer Ku 1963b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 1964b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 1965b7028ebfSSpencer Ku { 1966b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << "fail to get host log file path"; 1967b7028ebfSSpencer Ku return; 1968b7028ebfSSpencer Ku } 1969b7028ebfSSpencer Ku 1970b7028ebfSSpencer Ku size_t logCount = 0; 19713648c8beSEd Tanous size_t top = 1; 1972b7028ebfSSpencer Ku std::vector<std::string> logEntries; 1973b7028ebfSSpencer Ku // We can get specific entry by skip and top. For example, if we 1974b7028ebfSSpencer Ku // want to get nth entry, we can set skip = n-1 and top = 1 to 1975b7028ebfSSpencer Ku // get that entry 1976002d39b4SEd Tanous if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, logEntries, 1977002d39b4SEd Tanous logCount)) 1978b7028ebfSSpencer Ku { 1979b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 1980b7028ebfSSpencer Ku return; 1981b7028ebfSSpencer Ku } 1982b7028ebfSSpencer Ku 1983b7028ebfSSpencer Ku if (!logEntries.empty()) 1984b7028ebfSSpencer Ku { 19856d6574c9SJason M. Bills nlohmann::json::object_t hostLogEntry; 19866d6574c9SJason M. Bills fillHostLoggerEntryJson(targetID, logEntries[0], hostLogEntry); 19876d6574c9SJason M. Bills asyncResp->res.jsonValue.update(hostLogEntry); 1988b7028ebfSSpencer Ku return; 1989b7028ebfSSpencer Ku } 1990b7028ebfSSpencer Ku 1991b7028ebfSSpencer Ku // Requested ID was not found 1992ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 1993b7028ebfSSpencer Ku }); 1994b7028ebfSSpencer Ku } 1995b7028ebfSSpencer Ku 1996fdd26906SClaire Weinan constexpr char const* dumpManagerIface = 1997fdd26906SClaire Weinan "xyz.openbmc_project.Collection.DeleteAll"; 1998dd72e87bSClaire Weinan inline void handleBMCLogServicesCollectionGet( 1999fdd26906SClaire Weinan crow::App& app, const crow::Request& req, 2000fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 20011da66f75SEd Tanous { 20023ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 200345ca1b86SEd Tanous { 200445ca1b86SEd Tanous return; 200545ca1b86SEd Tanous } 20067e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 20077e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2008e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 20091da66f75SEd Tanous "#LogServiceCollection.LogServiceCollection"; 2010e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 2011e1f26343SJason M. Bills "/redfish/v1/Managers/bmc/LogServices"; 2012002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection"; 2013e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 20141da66f75SEd Tanous "Collection of LogServices for this Manager"; 2015002d39b4SEd Tanous nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 2016c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 2017fdd26906SClaire Weinan 2018c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL 2019*613dabeaSEd Tanous nlohmann::json::object_t journal; 2020*613dabeaSEd Tanous journal["@odata.id"] = "/redfish/v1/Managers/bmc/LogServices/Journal"; 2021*613dabeaSEd Tanous logServiceArray.push_back(std::move(journal)); 2022c4bf6374SJason M. Bills #endif 2023fdd26906SClaire Weinan 2024fdd26906SClaire Weinan asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size(); 2025fdd26906SClaire Weinan 2026fdd26906SClaire Weinan #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 2027fdd26906SClaire Weinan auto respHandler = 2028fdd26906SClaire Weinan [asyncResp]( 2029fdd26906SClaire Weinan const boost::system::error_code ec, 2030fdd26906SClaire Weinan const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 2031fdd26906SClaire Weinan if (ec) 2032fdd26906SClaire Weinan { 2033fdd26906SClaire Weinan BMCWEB_LOG_ERROR 2034dd72e87bSClaire Weinan << "handleBMCLogServicesCollectionGet respHandler got error " 2035fdd26906SClaire Weinan << ec; 2036fdd26906SClaire Weinan // Assume that getting an error simply means there are no dump 2037fdd26906SClaire Weinan // LogServices. Return without adding any error response. 2038fdd26906SClaire Weinan return; 2039fdd26906SClaire Weinan } 2040fdd26906SClaire Weinan 2041fdd26906SClaire Weinan nlohmann::json& logServiceArrayLocal = 2042fdd26906SClaire Weinan asyncResp->res.jsonValue["Members"]; 2043fdd26906SClaire Weinan 2044fdd26906SClaire Weinan for (const std::string& path : subTreePaths) 2045fdd26906SClaire Weinan { 2046fdd26906SClaire Weinan if (path == "/xyz/openbmc_project/dump/bmc") 2047fdd26906SClaire Weinan { 2048*613dabeaSEd Tanous nlohmann::json::object_t member; 2049*613dabeaSEd Tanous member["@odata.id"] = 2050*613dabeaSEd Tanous "/redfish/v1/Managers/bmc/LogServices/Dump"; 2051*613dabeaSEd Tanous logServiceArrayLocal.push_back(std::move(member)); 2052fdd26906SClaire Weinan } 2053fdd26906SClaire Weinan else if (path == "/xyz/openbmc_project/dump/faultlog") 2054fdd26906SClaire Weinan { 2055*613dabeaSEd Tanous nlohmann::json::object_t member; 2056*613dabeaSEd Tanous member["@odata.id"] = 2057*613dabeaSEd Tanous "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2058*613dabeaSEd Tanous logServiceArrayLocal.push_back(std::move(member)); 2059fdd26906SClaire Weinan } 2060fdd26906SClaire Weinan } 2061fdd26906SClaire Weinan 2062e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 2063fdd26906SClaire Weinan logServiceArrayLocal.size(); 2064fdd26906SClaire Weinan }; 2065fdd26906SClaire Weinan 2066fdd26906SClaire Weinan crow::connections::systemBus->async_method_call( 2067fdd26906SClaire Weinan respHandler, "xyz.openbmc_project.ObjectMapper", 2068fdd26906SClaire Weinan "/xyz/openbmc_project/object_mapper", 2069fdd26906SClaire Weinan "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 2070fdd26906SClaire Weinan "/xyz/openbmc_project/dump", 0, 2071fdd26906SClaire Weinan std::array<const char*, 1>{dumpManagerIface}); 2072fdd26906SClaire Weinan #endif 2073fdd26906SClaire Weinan } 2074fdd26906SClaire Weinan 2075fdd26906SClaire Weinan inline void requestRoutesBMCLogServiceCollection(App& app) 2076fdd26906SClaire Weinan { 2077fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/") 2078fdd26906SClaire Weinan .privileges(redfish::privileges::getLogServiceCollection) 2079fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 2080dd72e87bSClaire Weinan std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app))); 2081e1f26343SJason M. Bills } 2082e1f26343SJason M. Bills 20837e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogService(App& app) 2084e1f26343SJason M. Bills { 20857e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/") 2086ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 20877e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 208845ca1b86SEd Tanous [&app](const crow::Request& req, 208945ca1b86SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 20903ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 20917e860f15SJohn Edward Broadbent { 209245ca1b86SEd Tanous return; 209345ca1b86SEd Tanous } 2094e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2095e1f26343SJason M. Bills "#LogService.v1_1_0.LogService"; 20960f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 20970f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal"; 2098002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service"; 2099002d39b4SEd Tanous asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service"; 2100c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "BMC Journal"; 2101e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 21027c8c4058STejas Patil 21037c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 21042b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 2105002d39b4SEd Tanous asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 21067c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 21077c8c4058STejas Patil redfishDateTimeOffset.second; 21087c8c4058STejas Patil 21091476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 21101476687dSEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 21117e860f15SJohn Edward Broadbent }); 2112e1f26343SJason M. Bills } 2113e1f26343SJason M. Bills 21143a48b3a2SJason M. Bills static int 21153a48b3a2SJason M. Bills fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID, 2116e1f26343SJason M. Bills sd_journal* journal, 21173a48b3a2SJason M. Bills nlohmann::json::object_t& bmcJournalLogEntryJson) 2118e1f26343SJason M. Bills { 2119e1f26343SJason M. Bills // Get the Log Entry contents 2120e1f26343SJason M. Bills int ret = 0; 2121e1f26343SJason M. Bills 2122a8fe54f0SJason M. Bills std::string message; 2123a8fe54f0SJason M. Bills std::string_view syslogID; 2124a8fe54f0SJason M. Bills ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID); 2125a8fe54f0SJason M. Bills if (ret < 0) 2126a8fe54f0SJason M. Bills { 2127a8fe54f0SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read SYSLOG_IDENTIFIER field: " 2128a8fe54f0SJason M. Bills << strerror(-ret); 2129a8fe54f0SJason M. Bills } 2130a8fe54f0SJason M. Bills if (!syslogID.empty()) 2131a8fe54f0SJason M. Bills { 2132a8fe54f0SJason M. Bills message += std::string(syslogID) + ": "; 2133a8fe54f0SJason M. Bills } 2134a8fe54f0SJason M. Bills 213539e77504SEd Tanous std::string_view msg; 213616428a1aSJason M. Bills ret = getJournalMetadata(journal, "MESSAGE", msg); 2137e1f26343SJason M. Bills if (ret < 0) 2138e1f26343SJason M. Bills { 2139e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret); 2140e1f26343SJason M. Bills return 1; 2141e1f26343SJason M. Bills } 2142a8fe54f0SJason M. Bills message += std::string(msg); 2143e1f26343SJason M. Bills 2144e1f26343SJason M. Bills // Get the severity from the PRIORITY field 2145271584abSEd Tanous long int severity = 8; // Default to an invalid priority 214616428a1aSJason M. Bills ret = getJournalMetadata(journal, "PRIORITY", 10, severity); 2147e1f26343SJason M. Bills if (ret < 0) 2148e1f26343SJason M. Bills { 2149e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret); 2150e1f26343SJason M. Bills } 2151e1f26343SJason M. Bills 2152e1f26343SJason M. Bills // Get the Created time from the timestamp 215316428a1aSJason M. Bills std::string entryTimeStr; 215416428a1aSJason M. Bills if (!getEntryTimestamp(journal, entryTimeStr)) 2155e1f26343SJason M. Bills { 215616428a1aSJason M. Bills return 1; 2157e1f26343SJason M. Bills } 2158e1f26343SJason M. Bills 2159e1f26343SJason M. Bills // Fill in the log entry with the gathered data 216084afc48bSJason M. Bills bmcJournalLogEntryJson["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 216184afc48bSJason M. Bills bmcJournalLogEntryJson["@odata.id"] = 216284afc48bSJason M. Bills "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" + 216384afc48bSJason M. Bills bmcJournalLogEntryID; 216484afc48bSJason M. Bills bmcJournalLogEntryJson["Name"] = "BMC Journal Entry"; 216584afc48bSJason M. Bills bmcJournalLogEntryJson["Id"] = bmcJournalLogEntryID; 216684afc48bSJason M. Bills bmcJournalLogEntryJson["Message"] = std::move(message); 216784afc48bSJason M. Bills bmcJournalLogEntryJson["EntryType"] = "Oem"; 216884afc48bSJason M. Bills bmcJournalLogEntryJson["Severity"] = severity <= 2 ? "Critical" 2169738c1e61SPatrick Williams : severity <= 4 ? "Warning" 217084afc48bSJason M. Bills : "OK"; 217184afc48bSJason M. Bills bmcJournalLogEntryJson["OemRecordFormat"] = "BMC Journal Entry"; 217284afc48bSJason M. Bills bmcJournalLogEntryJson["Created"] = std::move(entryTimeStr); 2173e1f26343SJason M. Bills return 0; 2174e1f26343SJason M. Bills } 2175e1f26343SJason M. Bills 21767e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntryCollection(App& app) 2177e1f26343SJason M. Bills { 21787e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/") 2179ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 2180002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2181002d39b4SEd Tanous [&app](const crow::Request& req, 2182002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2183c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 2184c937d2bfSEd Tanous .canDelegateTop = true, 2185c937d2bfSEd Tanous .canDelegateSkip = true, 2186c937d2bfSEd Tanous }; 2187c937d2bfSEd Tanous query_param::Query delegatedQuery; 2188c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 21893ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 2190193ad2faSJason M. Bills { 2191193ad2faSJason M. Bills return; 2192193ad2faSJason M. Bills } 21933648c8beSEd Tanous 21943648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 21955143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 21963648c8beSEd Tanous 21977e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 21987e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2199e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2200e1f26343SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 22010f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 22020f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 2203e1f26343SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries"; 2204e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2205e1f26343SJason M. Bills "Collection of BMC Journal Entries"; 22060fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2207e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 2208e1f26343SJason M. Bills 22097e860f15SJohn Edward Broadbent // Go through the journal and use the timestamp to create a 22107e860f15SJohn Edward Broadbent // unique ID for each entry 2211e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2212e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2213e1f26343SJason M. Bills if (ret < 0) 2214e1f26343SJason M. Bills { 2215002d39b4SEd Tanous BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 2216f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2217e1f26343SJason M. Bills return; 2218e1f26343SJason M. Bills } 22190fda0f12SGeorge Liu std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 22200fda0f12SGeorge Liu journalTmp, sd_journal_close); 2221e1f26343SJason M. Bills journalTmp = nullptr; 2222b01bf299SEd Tanous uint64_t entryCount = 0; 2223e85d6b16SJason M. Bills // Reset the unique ID on the first entry 2224e85d6b16SJason M. Bills bool firstEntry = true; 2225e1f26343SJason M. Bills SD_JOURNAL_FOREACH(journal.get()) 2226e1f26343SJason M. Bills { 2227193ad2faSJason M. Bills entryCount++; 22287e860f15SJohn Edward Broadbent // Handle paging using skip (number of entries to skip from 22297e860f15SJohn Edward Broadbent // the start) and top (number of entries to display) 22303648c8beSEd Tanous if (entryCount <= skip || entryCount > skip + top) 2231193ad2faSJason M. Bills { 2232193ad2faSJason M. Bills continue; 2233193ad2faSJason M. Bills } 2234193ad2faSJason M. Bills 223516428a1aSJason M. Bills std::string idStr; 2236e85d6b16SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2237e1f26343SJason M. Bills { 2238e1f26343SJason M. Bills continue; 2239e1f26343SJason M. Bills } 2240e85d6b16SJason M. Bills firstEntry = false; 2241e85d6b16SJason M. Bills 22423a48b3a2SJason M. Bills nlohmann::json::object_t bmcJournalLogEntry; 2243c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(idStr, journal.get(), 2244c4bf6374SJason M. Bills bmcJournalLogEntry) != 0) 2245e1f26343SJason M. Bills { 2246f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2247e1f26343SJason M. Bills return; 2248e1f26343SJason M. Bills } 22493a48b3a2SJason M. Bills logEntryArray.push_back(std::move(bmcJournalLogEntry)); 2250e1f26343SJason M. Bills } 2251193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 22523648c8beSEd Tanous if (skip + top < entryCount) 2253193ad2faSJason M. Bills { 2254193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 22550fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" + 22563648c8beSEd Tanous std::to_string(skip + top); 2257193ad2faSJason M. Bills } 22587e860f15SJohn Edward Broadbent }); 2259e1f26343SJason M. Bills } 2260e1f26343SJason M. Bills 22617e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntry(App& app) 2262e1f26343SJason M. Bills { 22637e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 22647e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/") 2265ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 22667e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 226745ca1b86SEd Tanous [&app](const crow::Request& req, 22687e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 22697e860f15SJohn Edward Broadbent const std::string& entryID) { 22703ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 227145ca1b86SEd Tanous { 227245ca1b86SEd Tanous return; 227345ca1b86SEd Tanous } 2274e1f26343SJason M. Bills // Convert the unique ID back to a timestamp to find the entry 2275e1f26343SJason M. Bills uint64_t ts = 0; 2276271584abSEd Tanous uint64_t index = 0; 22778d1b46d7Szhanghch05 if (!getTimestampFromID(asyncResp, entryID, ts, index)) 2278e1f26343SJason M. Bills { 227916428a1aSJason M. Bills return; 2280e1f26343SJason M. Bills } 2281e1f26343SJason M. Bills 2282e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2283e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2284e1f26343SJason M. Bills if (ret < 0) 2285e1f26343SJason M. Bills { 2286002d39b4SEd Tanous BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 2287f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2288e1f26343SJason M. Bills return; 2289e1f26343SJason M. Bills } 2290002d39b4SEd Tanous std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 2291002d39b4SEd Tanous journalTmp, sd_journal_close); 2292e1f26343SJason M. Bills journalTmp = nullptr; 22937e860f15SJohn Edward Broadbent // Go to the timestamp in the log and move to the entry at the 22947e860f15SJohn Edward Broadbent // index tracking the unique ID 2295af07e3f5SJason M. Bills std::string idStr; 2296af07e3f5SJason M. Bills bool firstEntry = true; 2297e1f26343SJason M. Bills ret = sd_journal_seek_realtime_usec(journal.get(), ts); 22982056b6d1SManojkiran Eda if (ret < 0) 22992056b6d1SManojkiran Eda { 23002056b6d1SManojkiran Eda BMCWEB_LOG_ERROR << "failed to seek to an entry in journal" 23012056b6d1SManojkiran Eda << strerror(-ret); 23022056b6d1SManojkiran Eda messages::internalError(asyncResp->res); 23032056b6d1SManojkiran Eda return; 23042056b6d1SManojkiran Eda } 2305271584abSEd Tanous for (uint64_t i = 0; i <= index; i++) 2306e1f26343SJason M. Bills { 2307e1f26343SJason M. Bills sd_journal_next(journal.get()); 2308af07e3f5SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2309af07e3f5SJason M. Bills { 2310af07e3f5SJason M. Bills messages::internalError(asyncResp->res); 2311af07e3f5SJason M. Bills return; 2312af07e3f5SJason M. Bills } 2313af07e3f5SJason M. Bills firstEntry = false; 2314af07e3f5SJason M. Bills } 2315c4bf6374SJason M. Bills // Confirm that the entry ID matches what was requested 2316af07e3f5SJason M. Bills if (idStr != entryID) 2317c4bf6374SJason M. Bills { 2318ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 2319c4bf6374SJason M. Bills return; 2320c4bf6374SJason M. Bills } 2321c4bf6374SJason M. Bills 23223a48b3a2SJason M. Bills nlohmann::json::object_t bmcJournalLogEntry; 2323c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(entryID, journal.get(), 23243a48b3a2SJason M. Bills bmcJournalLogEntry) != 0) 2325e1f26343SJason M. Bills { 2326f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2327e1f26343SJason M. Bills return; 2328e1f26343SJason M. Bills } 2329d405bb51SJason M. Bills asyncResp->res.jsonValue.update(bmcJournalLogEntry); 23307e860f15SJohn Edward Broadbent }); 2331c9bb6861Sraviteja-b } 2332c9bb6861Sraviteja-b 2333fdd26906SClaire Weinan inline void 2334fdd26906SClaire Weinan getDumpServiceInfo(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2335fdd26906SClaire Weinan const std::string& dumpType) 2336c9bb6861Sraviteja-b { 2337fdd26906SClaire Weinan std::string dumpPath; 2338fdd26906SClaire Weinan std::string overWritePolicy; 2339fdd26906SClaire Weinan bool collectDiagnosticDataSupported = false; 2340fdd26906SClaire Weinan 2341fdd26906SClaire Weinan if (dumpType == "BMC") 234245ca1b86SEd Tanous { 2343fdd26906SClaire Weinan dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump"; 2344fdd26906SClaire Weinan overWritePolicy = "WrapsWhenFull"; 2345fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2346fdd26906SClaire Weinan } 2347fdd26906SClaire Weinan else if (dumpType == "FaultLog") 2348fdd26906SClaire Weinan { 2349fdd26906SClaire Weinan dumpPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2350fdd26906SClaire Weinan overWritePolicy = "Unknown"; 2351fdd26906SClaire Weinan collectDiagnosticDataSupported = false; 2352fdd26906SClaire Weinan } 2353fdd26906SClaire Weinan else if (dumpType == "System") 2354fdd26906SClaire Weinan { 2355fdd26906SClaire Weinan dumpPath = "/redfish/v1/Systems/system/LogServices/Dump"; 2356fdd26906SClaire Weinan overWritePolicy = "WrapsWhenFull"; 2357fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2358fdd26906SClaire Weinan } 2359fdd26906SClaire Weinan else 2360fdd26906SClaire Weinan { 2361fdd26906SClaire Weinan BMCWEB_LOG_ERROR << "getDumpServiceInfo() invalid dump type: " 2362fdd26906SClaire Weinan << dumpType; 2363fdd26906SClaire Weinan messages::internalError(asyncResp->res); 236445ca1b86SEd Tanous return; 236545ca1b86SEd Tanous } 2366fdd26906SClaire Weinan 2367fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = dumpPath; 2368fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService"; 2369c9bb6861Sraviteja-b asyncResp->res.jsonValue["Name"] = "Dump LogService"; 2370fdd26906SClaire Weinan asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService"; 2371fdd26906SClaire Weinan asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename(); 2372fdd26906SClaire Weinan asyncResp->res.jsonValue["OverWritePolicy"] = std::move(overWritePolicy); 23737c8c4058STejas Patil 23747c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 23752b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 23760fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 23777c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 23787c8c4058STejas Patil redfishDateTimeOffset.second; 23797c8c4058STejas Patil 2380fdd26906SClaire Weinan asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries"; 2381002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 2382fdd26906SClaire Weinan dumpPath + "/Actions/LogService.ClearLog"; 2383fdd26906SClaire Weinan 2384fdd26906SClaire Weinan if (collectDiagnosticDataSupported) 2385fdd26906SClaire Weinan { 2386002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 23871476687dSEd Tanous ["target"] = 2388fdd26906SClaire Weinan dumpPath + "/Actions/LogService.CollectDiagnosticData"; 2389fdd26906SClaire Weinan } 2390c9bb6861Sraviteja-b } 2391c9bb6861Sraviteja-b 2392fdd26906SClaire Weinan inline void handleLogServicesDumpServiceGet( 2393fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2394fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 23957e860f15SJohn Edward Broadbent { 23963ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 239745ca1b86SEd Tanous { 239845ca1b86SEd Tanous return; 239945ca1b86SEd Tanous } 2400fdd26906SClaire Weinan getDumpServiceInfo(asyncResp, dumpType); 2401fdd26906SClaire Weinan } 2402c9bb6861Sraviteja-b 2403fdd26906SClaire Weinan inline void handleLogServicesDumpEntriesCollectionGet( 2404fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2405fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2406fdd26906SClaire Weinan { 2407fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2408fdd26906SClaire Weinan { 2409fdd26906SClaire Weinan return; 2410fdd26906SClaire Weinan } 2411fdd26906SClaire Weinan getDumpEntryCollection(asyncResp, dumpType); 2412fdd26906SClaire Weinan } 2413fdd26906SClaire Weinan 2414fdd26906SClaire Weinan inline void handleLogServicesDumpEntryGet( 2415fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2416fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2417fdd26906SClaire Weinan const std::string& dumpId) 2418fdd26906SClaire Weinan { 2419fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2420fdd26906SClaire Weinan { 2421fdd26906SClaire Weinan return; 2422fdd26906SClaire Weinan } 2423fdd26906SClaire Weinan getDumpEntryById(asyncResp, dumpId, dumpType); 2424fdd26906SClaire Weinan } 2425fdd26906SClaire Weinan 2426fdd26906SClaire Weinan inline void handleLogServicesDumpEntryDelete( 2427fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2428fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2429fdd26906SClaire Weinan const std::string& dumpId) 2430fdd26906SClaire Weinan { 2431fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2432fdd26906SClaire Weinan { 2433fdd26906SClaire Weinan return; 2434fdd26906SClaire Weinan } 2435fdd26906SClaire Weinan deleteDumpEntry(asyncResp, dumpId, dumpType); 2436fdd26906SClaire Weinan } 2437fdd26906SClaire Weinan 2438fdd26906SClaire Weinan inline void handleLogServicesDumpCollectDiagnosticDataPost( 2439fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2440fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2441fdd26906SClaire Weinan { 2442fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2443fdd26906SClaire Weinan { 2444fdd26906SClaire Weinan return; 2445fdd26906SClaire Weinan } 2446fdd26906SClaire Weinan createDump(asyncResp, req, dumpType); 2447fdd26906SClaire Weinan } 2448fdd26906SClaire Weinan 2449fdd26906SClaire Weinan inline void handleLogServicesDumpClearLogPost( 2450fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2451fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2452fdd26906SClaire Weinan { 2453fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2454fdd26906SClaire Weinan { 2455fdd26906SClaire Weinan return; 2456fdd26906SClaire Weinan } 2457fdd26906SClaire Weinan clearDump(asyncResp, dumpType); 2458fdd26906SClaire Weinan } 2459fdd26906SClaire Weinan 2460fdd26906SClaire Weinan inline void requestRoutesBMCDumpService(App& app) 2461fdd26906SClaire Weinan { 2462fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/") 2463fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 2464fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2465fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "BMC")); 2466fdd26906SClaire Weinan } 2467fdd26906SClaire Weinan 2468fdd26906SClaire Weinan inline void requestRoutesBMCDumpEntryCollection(App& app) 2469fdd26906SClaire Weinan { 2470fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/") 2471fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 2472fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2473fdd26906SClaire Weinan handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC")); 2474c9bb6861Sraviteja-b } 2475c9bb6861Sraviteja-b 24767e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app) 2477c9bb6861Sraviteja-b { 24787e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 24797e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2480ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 2481fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2482fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "BMC")); 2483fdd26906SClaire Weinan 24847e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 24857e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2486ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 2487fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 2488fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "BMC")); 2489c9bb6861Sraviteja-b } 2490c9bb6861Sraviteja-b 24917e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app) 2492c9bb6861Sraviteja-b { 24930fda0f12SGeorge Liu BMCWEB_ROUTE( 24940fda0f12SGeorge Liu app, 24950fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2496ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 24977e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 2498fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost, 2499fdd26906SClaire Weinan std::ref(app), "BMC")); 2500a43be80fSAsmitha Karunanithi } 2501a43be80fSAsmitha Karunanithi 25027e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app) 250380319af1SAsmitha Karunanithi { 25040fda0f12SGeorge Liu BMCWEB_ROUTE( 25050fda0f12SGeorge Liu app, 25060fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog/") 2507ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 2508fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 2509fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "BMC")); 251045ca1b86SEd Tanous } 2511fdd26906SClaire Weinan 2512fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpService(App& app) 2513fdd26906SClaire Weinan { 2514fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/") 2515fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 2516fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2517fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "FaultLog")); 2518fdd26906SClaire Weinan } 2519fdd26906SClaire Weinan 2520fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntryCollection(App& app) 2521fdd26906SClaire Weinan { 2522fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/") 2523fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 2524fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 2525fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpEntriesCollectionGet, 2526fdd26906SClaire Weinan std::ref(app), "FaultLog")); 2527fdd26906SClaire Weinan } 2528fdd26906SClaire Weinan 2529fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntry(App& app) 2530fdd26906SClaire Weinan { 2531fdd26906SClaire Weinan BMCWEB_ROUTE(app, 2532fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 2533fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntry) 2534fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2535fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "FaultLog")); 2536fdd26906SClaire Weinan 2537fdd26906SClaire Weinan BMCWEB_ROUTE(app, 2538fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 2539fdd26906SClaire Weinan .privileges(redfish::privileges::deleteLogEntry) 2540fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 2541fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog")); 2542fdd26906SClaire Weinan } 2543fdd26906SClaire Weinan 2544fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpClear(App& app) 2545fdd26906SClaire Weinan { 2546fdd26906SClaire Weinan BMCWEB_ROUTE( 2547fdd26906SClaire Weinan app, 2548fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog/") 2549fdd26906SClaire Weinan .privileges(redfish::privileges::postLogService) 2550fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 2551fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog")); 25525cb1dd27SAsmitha Karunanithi } 25535cb1dd27SAsmitha Karunanithi 25547e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app) 25555cb1dd27SAsmitha Karunanithi { 25567e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/") 2557ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 2558002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2559002d39b4SEd Tanous [&app](const crow::Request& req, 2560002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 25613ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 25627e860f15SJohn Edward Broadbent { 256345ca1b86SEd Tanous return; 256445ca1b86SEd Tanous } 25655cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.id"] = 25665cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump"; 25675cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 2568d337bb72SAsmitha Karunanithi "#LogService.v1_2_0.LogService"; 25695cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = "Dump LogService"; 257045ca1b86SEd Tanous asyncResp->res.jsonValue["Description"] = "System Dump LogService"; 25715cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = "Dump"; 25725cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 25737c8c4058STejas Patil 25747c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 25752b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 257645ca1b86SEd Tanous asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 25777c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 25787c8c4058STejas Patil redfishDateTimeOffset.second; 25797c8c4058STejas Patil 25801476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 25811476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Dump/Entries"; 2582002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 25831476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog"; 25841476687dSEd Tanous 2585002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 25861476687dSEd Tanous ["target"] = 25871476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData"; 25887e860f15SJohn Edward Broadbent }); 25895cb1dd27SAsmitha Karunanithi } 25905cb1dd27SAsmitha Karunanithi 25917e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app) 25927e860f15SJohn Edward Broadbent { 25937e860f15SJohn Edward Broadbent 25945cb1dd27SAsmitha Karunanithi /** 25955cb1dd27SAsmitha Karunanithi * Functions triggers appropriate requests on DBus 25965cb1dd27SAsmitha Karunanithi */ 2597b2a3289dSAsmitha Karunanithi BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/") 2598ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 25997e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 260045ca1b86SEd Tanous [&app](const crow::Request& req, 2601864d6a17SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 26023ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 260345ca1b86SEd Tanous { 260445ca1b86SEd Tanous return; 260545ca1b86SEd Tanous } 26065cb1dd27SAsmitha Karunanithi getDumpEntryCollection(asyncResp, "System"); 26077e860f15SJohn Edward Broadbent }); 26085cb1dd27SAsmitha Karunanithi } 26095cb1dd27SAsmitha Karunanithi 26107e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app) 26115cb1dd27SAsmitha Karunanithi { 26127e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 2613864d6a17SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/") 2614ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 2615ed398213SEd Tanous 26167e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 261745ca1b86SEd Tanous [&app](const crow::Request& req, 26187e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 26197e860f15SJohn Edward Broadbent const std::string& param) { 26203ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2621c7a6d660SClaire Weinan { 2622c7a6d660SClaire Weinan return; 2623c7a6d660SClaire Weinan } 2624c7a6d660SClaire Weinan getDumpEntryById(asyncResp, param, "System"); 26257e860f15SJohn Edward Broadbent }); 26268d1b46d7Szhanghch05 26277e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 2628864d6a17SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/") 2629ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 26307e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::delete_)( 263145ca1b86SEd Tanous [&app](const crow::Request& req, 26327e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 26337e860f15SJohn Edward Broadbent const std::string& param) { 26343ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 263545ca1b86SEd Tanous { 263645ca1b86SEd Tanous return; 263745ca1b86SEd Tanous } 26387e860f15SJohn Edward Broadbent deleteDumpEntry(asyncResp, param, "system"); 26397e860f15SJohn Edward Broadbent }); 26405cb1dd27SAsmitha Karunanithi } 2641c9bb6861Sraviteja-b 26427e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app) 2643c9bb6861Sraviteja-b { 26440fda0f12SGeorge Liu BMCWEB_ROUTE( 26450fda0f12SGeorge Liu app, 26460fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2647ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 26487e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 264945ca1b86SEd Tanous [&app](const crow::Request& req, 265045ca1b86SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 26513ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 265245ca1b86SEd Tanous { 265345ca1b86SEd Tanous return; 265445ca1b86SEd Tanous } 265545ca1b86SEd Tanous createDump(asyncResp, req, "System"); 265645ca1b86SEd Tanous }); 2657a43be80fSAsmitha Karunanithi } 2658a43be80fSAsmitha Karunanithi 26597e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app) 2660a43be80fSAsmitha Karunanithi { 26610fda0f12SGeorge Liu BMCWEB_ROUTE( 26620fda0f12SGeorge Liu app, 26630fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog/") 2664ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 26657e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 266645ca1b86SEd Tanous [&app](const crow::Request& req, 26677e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 26687e860f15SJohn Edward Broadbent 266945ca1b86SEd Tanous { 26703ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 267145ca1b86SEd Tanous { 267245ca1b86SEd Tanous return; 267345ca1b86SEd Tanous } 267445ca1b86SEd Tanous clearDump(asyncResp, "System"); 267545ca1b86SEd Tanous }); 2676013487e5Sraviteja-b } 2677013487e5Sraviteja-b 26787e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app) 26791da66f75SEd Tanous { 26803946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 26813946028dSAppaRao Puli // method for security reasons. 26821da66f75SEd Tanous /** 26831da66f75SEd Tanous * Functions triggers appropriate requests on DBus 26841da66f75SEd Tanous */ 26857e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Crashdump/") 2686ed398213SEd Tanous // This is incorrect, should be: 2687ed398213SEd Tanous //.privileges(redfish::privileges::getLogService) 2688432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 2689002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2690002d39b4SEd Tanous [&app](const crow::Request& req, 2691002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 26923ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 269345ca1b86SEd Tanous { 269445ca1b86SEd Tanous return; 269545ca1b86SEd Tanous } 26967e860f15SJohn Edward Broadbent // Copy over the static data to include the entries added by 26977e860f15SJohn Edward Broadbent // SubRoute 26980f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2699424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"; 2700e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 27018e6c099aSJason M. Bills "#LogService.v1_2_0.LogService"; 27024f50ae4bSGunnar Mills asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service"; 27034f50ae4bSGunnar Mills asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service"; 27044f50ae4bSGunnar Mills asyncResp->res.jsonValue["Id"] = "Oem Crashdump"; 2705e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 2706e1f26343SJason M. Bills asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; 27077c8c4058STejas Patil 27087c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 27092b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 27107c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 27117c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 27127c8c4058STejas Patil redfishDateTimeOffset.second; 27137c8c4058STejas Patil 27141476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 27151476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 2716002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 27171476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog"; 2718002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 27191476687dSEd Tanous ["target"] = 27201476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData"; 27217e860f15SJohn Edward Broadbent }); 27221da66f75SEd Tanous } 27231da66f75SEd Tanous 27247e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app) 27255b61b5e8SJason M. Bills { 27260fda0f12SGeorge Liu BMCWEB_ROUTE( 27270fda0f12SGeorge Liu app, 27280fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog/") 2729ed398213SEd Tanous // This is incorrect, should be: 2730ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 2731432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 27327e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 273345ca1b86SEd Tanous [&app](const crow::Request& req, 27347e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 27353ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 273645ca1b86SEd Tanous { 273745ca1b86SEd Tanous return; 273845ca1b86SEd Tanous } 27395b61b5e8SJason M. Bills crow::connections::systemBus->async_method_call( 27405b61b5e8SJason M. Bills [asyncResp](const boost::system::error_code ec, 2741cb13a392SEd Tanous const std::string&) { 27425b61b5e8SJason M. Bills if (ec) 27435b61b5e8SJason M. Bills { 27445b61b5e8SJason M. Bills messages::internalError(asyncResp->res); 27455b61b5e8SJason M. Bills return; 27465b61b5e8SJason M. Bills } 27475b61b5e8SJason M. Bills messages::success(asyncResp->res); 27485b61b5e8SJason M. Bills }, 2749002d39b4SEd Tanous crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll"); 27507e860f15SJohn Edward Broadbent }); 27515b61b5e8SJason M. Bills } 27525b61b5e8SJason M. Bills 27538d1b46d7Szhanghch05 static void 27548d1b46d7Szhanghch05 logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 27558d1b46d7Szhanghch05 const std::string& logID, nlohmann::json& logEntryJson) 2756e855dd28SJason M. Bills { 2757043a0536SJohnathan Mantey auto getStoredLogCallback = 2758b9d36b47SEd Tanous [asyncResp, logID, 2759b9d36b47SEd Tanous &logEntryJson](const boost::system::error_code ec, 2760b9d36b47SEd Tanous const dbus::utility::DBusPropertiesMap& params) { 2761e855dd28SJason M. Bills if (ec) 2762e855dd28SJason M. Bills { 2763e855dd28SJason M. Bills BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 27641ddcf01aSJason M. Bills if (ec.value() == 27651ddcf01aSJason M. Bills boost::system::linux_error::bad_request_descriptor) 27661ddcf01aSJason M. Bills { 2767002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 27681ddcf01aSJason M. Bills } 27691ddcf01aSJason M. Bills else 27701ddcf01aSJason M. Bills { 2771e855dd28SJason M. Bills messages::internalError(asyncResp->res); 27721ddcf01aSJason M. Bills } 2773e855dd28SJason M. Bills return; 2774e855dd28SJason M. Bills } 2775043a0536SJohnathan Mantey 2776043a0536SJohnathan Mantey std::string timestamp{}; 2777043a0536SJohnathan Mantey std::string filename{}; 2778043a0536SJohnathan Mantey std::string logfile{}; 27792c70f800SEd Tanous parseCrashdumpParameters(params, filename, timestamp, logfile); 2780043a0536SJohnathan Mantey 2781043a0536SJohnathan Mantey if (filename.empty() || timestamp.empty()) 2782e855dd28SJason M. Bills { 2783002d39b4SEd Tanous messages::resourceMissingAtURI(asyncResp->res, 2784002d39b4SEd Tanous crow::utility::urlFromPieces(logID)); 2785e855dd28SJason M. Bills return; 2786e855dd28SJason M. Bills } 2787e855dd28SJason M. Bills 2788043a0536SJohnathan Mantey std::string crashdumpURI = 2789e855dd28SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + 2790043a0536SJohnathan Mantey logID + "/" + filename; 279184afc48bSJason M. Bills nlohmann::json::object_t logEntry; 279284afc48bSJason M. Bills logEntry["@odata.type"] = "#LogEntry.v1_7_0.LogEntry"; 279384afc48bSJason M. Bills logEntry["@odata.id"] = 279484afc48bSJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + logID; 279584afc48bSJason M. Bills logEntry["Name"] = "CPU Crashdump"; 279684afc48bSJason M. Bills logEntry["Id"] = logID; 279784afc48bSJason M. Bills logEntry["EntryType"] = "Oem"; 279884afc48bSJason M. Bills logEntry["AdditionalDataURI"] = std::move(crashdumpURI); 279984afc48bSJason M. Bills logEntry["DiagnosticDataType"] = "OEM"; 280084afc48bSJason M. Bills logEntry["OEMDiagnosticDataType"] = "PECICrashdump"; 280184afc48bSJason M. Bills logEntry["Created"] = std::move(timestamp); 28022b20ef6eSJason M. Bills 28032b20ef6eSJason M. Bills // If logEntryJson references an array of LogEntry resources 28042b20ef6eSJason M. Bills // ('Members' list), then push this as a new entry, otherwise set it 28052b20ef6eSJason M. Bills // directly 28062b20ef6eSJason M. Bills if (logEntryJson.is_array()) 28072b20ef6eSJason M. Bills { 28082b20ef6eSJason M. Bills logEntryJson.push_back(logEntry); 28092b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 28102b20ef6eSJason M. Bills logEntryJson.size(); 28112b20ef6eSJason M. Bills } 28122b20ef6eSJason M. Bills else 28132b20ef6eSJason M. Bills { 2814d405bb51SJason M. Bills logEntryJson.update(logEntry); 28152b20ef6eSJason M. Bills } 2816e855dd28SJason M. Bills }; 2817d1bde9e5SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 2818d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, crashdumpObject, 2819d1bde9e5SKrzysztof Grobelny crashdumpPath + std::string("/") + logID, crashdumpInterface, 2820d1bde9e5SKrzysztof Grobelny std::move(getStoredLogCallback)); 2821e855dd28SJason M. Bills } 2822e855dd28SJason M. Bills 28237e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app) 28241da66f75SEd Tanous { 28253946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 28263946028dSAppaRao Puli // method for security reasons. 28271da66f75SEd Tanous /** 28281da66f75SEd Tanous * Functions triggers appropriate requests on DBus 28291da66f75SEd Tanous */ 28307e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 28317e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/") 2832ed398213SEd Tanous // This is incorrect, should be. 2833ed398213SEd Tanous //.privileges(redfish::privileges::postLogEntryCollection) 2834432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 2835002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2836002d39b4SEd Tanous [&app](const crow::Request& req, 2837002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 28383ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 283945ca1b86SEd Tanous { 284045ca1b86SEd Tanous return; 284145ca1b86SEd Tanous } 28422b20ef6eSJason M. Bills crow::connections::systemBus->async_method_call( 28432b20ef6eSJason M. Bills [asyncResp](const boost::system::error_code ec, 28442b20ef6eSJason M. Bills const std::vector<std::string>& resp) { 28451da66f75SEd Tanous if (ec) 28461da66f75SEd Tanous { 28471da66f75SEd Tanous if (ec.value() != 28481da66f75SEd Tanous boost::system::errc::no_such_file_or_directory) 28491da66f75SEd Tanous { 28501da66f75SEd Tanous BMCWEB_LOG_DEBUG << "failed to get entries ec: " 28511da66f75SEd Tanous << ec.message(); 2852f12894f8SJason M. Bills messages::internalError(asyncResp->res); 28531da66f75SEd Tanous return; 28541da66f75SEd Tanous } 28551da66f75SEd Tanous } 2856e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 28571da66f75SEd Tanous "#LogEntryCollection.LogEntryCollection"; 28580f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2859424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 2860002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries"; 2861e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2862424c4176SJason M. Bills "Collection of Crashdump Entries"; 2863002d39b4SEd Tanous asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 2864a2dd60a6SBrandon Kim asyncResp->res.jsonValue["Members@odata.count"] = 0; 28652b20ef6eSJason M. Bills 28662b20ef6eSJason M. Bills for (const std::string& path : resp) 28671da66f75SEd Tanous { 28682b20ef6eSJason M. Bills const sdbusplus::message::object_path objPath(path); 2869e855dd28SJason M. Bills // Get the log ID 28702b20ef6eSJason M. Bills std::string logID = objPath.filename(); 28712b20ef6eSJason M. Bills if (logID.empty()) 28721da66f75SEd Tanous { 2873e855dd28SJason M. Bills continue; 28741da66f75SEd Tanous } 2875e855dd28SJason M. Bills // Add the log entry to the array 28762b20ef6eSJason M. Bills logCrashdumpEntry(asyncResp, logID, 28772b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members"]); 28781da66f75SEd Tanous } 28792b20ef6eSJason M. Bills }, 28801da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", 28811da66f75SEd Tanous "/xyz/openbmc_project/object_mapper", 28821da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0, 28835b61b5e8SJason M. Bills std::array<const char*, 1>{crashdumpInterface}); 28847e860f15SJohn Edward Broadbent }); 28851da66f75SEd Tanous } 28861da66f75SEd Tanous 28877e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app) 28881da66f75SEd Tanous { 28893946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 28903946028dSAppaRao Puli // method for security reasons. 28911da66f75SEd Tanous 28927e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 28937e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/") 2894ed398213SEd Tanous // this is incorrect, should be 2895ed398213SEd Tanous // .privileges(redfish::privileges::getLogEntry) 2896432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 28977e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 289845ca1b86SEd Tanous [&app](const crow::Request& req, 28997e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 29007e860f15SJohn Edward Broadbent const std::string& param) { 29013ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 290245ca1b86SEd Tanous { 290345ca1b86SEd Tanous return; 290445ca1b86SEd Tanous } 29057e860f15SJohn Edward Broadbent const std::string& logID = param; 2906e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue); 29077e860f15SJohn Edward Broadbent }); 2908e855dd28SJason M. Bills } 2909e855dd28SJason M. Bills 29107e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app) 2911e855dd28SJason M. Bills { 29123946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 29133946028dSAppaRao Puli // method for security reasons. 29147e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 29157e860f15SJohn Edward Broadbent app, 29167e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/<str>/") 2917ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 29187e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 2919a4ce114aSNan Zhou [](const crow::Request& req, 29207e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 29217e860f15SJohn Edward Broadbent const std::string& logID, const std::string& fileName) { 29222a9beeedSShounak Mitra // Do not call getRedfishRoute here since the crashdump file is not a 29232a9beeedSShounak Mitra // Redfish resource. 2924043a0536SJohnathan Mantey auto getStoredLogCallback = 2925002d39b4SEd Tanous [asyncResp, logID, fileName, url(boost::urls::url(req.urlView))]( 2926abf2add6SEd Tanous const boost::system::error_code ec, 2927002d39b4SEd Tanous const std::vector< 2928002d39b4SEd Tanous std::pair<std::string, dbus::utility::DbusVariantType>>& 29297e860f15SJohn Edward Broadbent resp) { 29301da66f75SEd Tanous if (ec) 29311da66f75SEd Tanous { 2932002d39b4SEd Tanous BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 2933f12894f8SJason M. Bills messages::internalError(asyncResp->res); 29341da66f75SEd Tanous return; 29351da66f75SEd Tanous } 2936e855dd28SJason M. Bills 2937043a0536SJohnathan Mantey std::string dbusFilename{}; 2938043a0536SJohnathan Mantey std::string dbusTimestamp{}; 2939043a0536SJohnathan Mantey std::string dbusFilepath{}; 2940043a0536SJohnathan Mantey 2941002d39b4SEd Tanous parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp, 2942002d39b4SEd Tanous dbusFilepath); 2943043a0536SJohnathan Mantey 2944043a0536SJohnathan Mantey if (dbusFilename.empty() || dbusTimestamp.empty() || 2945043a0536SJohnathan Mantey dbusFilepath.empty()) 29461da66f75SEd Tanous { 2947ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, url); 29481da66f75SEd Tanous return; 29491da66f75SEd Tanous } 2950e855dd28SJason M. Bills 2951043a0536SJohnathan Mantey // Verify the file name parameter is correct 2952043a0536SJohnathan Mantey if (fileName != dbusFilename) 2953043a0536SJohnathan Mantey { 2954ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, url); 2955043a0536SJohnathan Mantey return; 2956043a0536SJohnathan Mantey } 2957043a0536SJohnathan Mantey 2958043a0536SJohnathan Mantey if (!std::filesystem::exists(dbusFilepath)) 2959043a0536SJohnathan Mantey { 2960ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, url); 2961043a0536SJohnathan Mantey return; 2962043a0536SJohnathan Mantey } 2963002d39b4SEd Tanous std::ifstream ifs(dbusFilepath, std::ios::in | std::ios::binary); 2964002d39b4SEd Tanous asyncResp->res.body() = 2965002d39b4SEd Tanous std::string(std::istreambuf_iterator<char>{ifs}, {}); 2966043a0536SJohnathan Mantey 29677e860f15SJohn Edward Broadbent // Configure this to be a file download when accessed 29687e860f15SJohn Edward Broadbent // from a browser 2969d9f6c621SEd Tanous asyncResp->res.addHeader( 2970d9f6c621SEd Tanous boost::beast::http::field::content_disposition, "attachment"); 29711da66f75SEd Tanous }; 2972d1bde9e5SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 2973d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, crashdumpObject, 2974d1bde9e5SKrzysztof Grobelny crashdumpPath + std::string("/") + logID, crashdumpInterface, 2975d1bde9e5SKrzysztof Grobelny std::move(getStoredLogCallback)); 29767e860f15SJohn Edward Broadbent }); 29771da66f75SEd Tanous } 29781da66f75SEd Tanous 2979c5a4c82aSJason M. Bills enum class OEMDiagnosticType 2980c5a4c82aSJason M. Bills { 2981c5a4c82aSJason M. Bills onDemand, 2982c5a4c82aSJason M. Bills telemetry, 2983c5a4c82aSJason M. Bills invalid, 2984c5a4c82aSJason M. Bills }; 2985c5a4c82aSJason M. Bills 2986f7725d79SEd Tanous inline OEMDiagnosticType 2987f7725d79SEd Tanous getOEMDiagnosticType(const std::string_view& oemDiagStr) 2988c5a4c82aSJason M. Bills { 2989c5a4c82aSJason M. Bills if (oemDiagStr == "OnDemand") 2990c5a4c82aSJason M. Bills { 2991c5a4c82aSJason M. Bills return OEMDiagnosticType::onDemand; 2992c5a4c82aSJason M. Bills } 2993c5a4c82aSJason M. Bills if (oemDiagStr == "Telemetry") 2994c5a4c82aSJason M. Bills { 2995c5a4c82aSJason M. Bills return OEMDiagnosticType::telemetry; 2996c5a4c82aSJason M. Bills } 2997c5a4c82aSJason M. Bills 2998c5a4c82aSJason M. Bills return OEMDiagnosticType::invalid; 2999c5a4c82aSJason M. Bills } 3000c5a4c82aSJason M. Bills 30017e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app) 30021da66f75SEd Tanous { 30033946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 30043946028dSAppaRao Puli // method for security reasons. 30050fda0f12SGeorge Liu BMCWEB_ROUTE( 30060fda0f12SGeorge Liu app, 30070fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/") 3008ed398213SEd Tanous // The below is incorrect; Should be ConfigureManager 3009ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3010432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 3011002d39b4SEd Tanous .methods(boost::beast::http::verb::post)( 3012002d39b4SEd Tanous [&app](const crow::Request& req, 30137e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 30143ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 301545ca1b86SEd Tanous { 301645ca1b86SEd Tanous return; 301745ca1b86SEd Tanous } 30188e6c099aSJason M. Bills std::string diagnosticDataType; 30198e6c099aSJason M. Bills std::string oemDiagnosticDataType; 302015ed6780SWilly Tu if (!redfish::json_util::readJsonAction( 3021002d39b4SEd Tanous req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 3022002d39b4SEd Tanous "OEMDiagnosticDataType", oemDiagnosticDataType)) 30238e6c099aSJason M. Bills { 30248e6c099aSJason M. Bills return; 30258e6c099aSJason M. Bills } 30268e6c099aSJason M. Bills 30278e6c099aSJason M. Bills if (diagnosticDataType != "OEM") 30288e6c099aSJason M. Bills { 30298e6c099aSJason M. Bills BMCWEB_LOG_ERROR 30308e6c099aSJason M. Bills << "Only OEM DiagnosticDataType supported for Crashdump"; 30318e6c099aSJason M. Bills messages::actionParameterValueFormatError( 30328e6c099aSJason M. Bills asyncResp->res, diagnosticDataType, "DiagnosticDataType", 30338e6c099aSJason M. Bills "CollectDiagnosticData"); 30348e6c099aSJason M. Bills return; 30358e6c099aSJason M. Bills } 30368e6c099aSJason M. Bills 3037c5a4c82aSJason M. Bills OEMDiagnosticType oemDiagType = 3038c5a4c82aSJason M. Bills getOEMDiagnosticType(oemDiagnosticDataType); 3039c5a4c82aSJason M. Bills 3040c5a4c82aSJason M. Bills std::string iface; 3041c5a4c82aSJason M. Bills std::string method; 3042c5a4c82aSJason M. Bills std::string taskMatchStr; 3043c5a4c82aSJason M. Bills if (oemDiagType == OEMDiagnosticType::onDemand) 3044c5a4c82aSJason M. Bills { 3045c5a4c82aSJason M. Bills iface = crashdumpOnDemandInterface; 3046c5a4c82aSJason M. Bills method = "GenerateOnDemandLog"; 3047c5a4c82aSJason M. Bills taskMatchStr = "type='signal'," 3048c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 3049c5a4c82aSJason M. Bills "member='PropertiesChanged'," 3050c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 3051c5a4c82aSJason M. Bills } 3052c5a4c82aSJason M. Bills else if (oemDiagType == OEMDiagnosticType::telemetry) 3053c5a4c82aSJason M. Bills { 3054c5a4c82aSJason M. Bills iface = crashdumpTelemetryInterface; 3055c5a4c82aSJason M. Bills method = "GenerateTelemetryLog"; 3056c5a4c82aSJason M. Bills taskMatchStr = "type='signal'," 3057c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 3058c5a4c82aSJason M. Bills "member='PropertiesChanged'," 3059c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 3060c5a4c82aSJason M. Bills } 3061c5a4c82aSJason M. Bills else 3062c5a4c82aSJason M. Bills { 3063c5a4c82aSJason M. Bills BMCWEB_LOG_ERROR << "Unsupported OEMDiagnosticDataType: " 3064c5a4c82aSJason M. Bills << oemDiagnosticDataType; 3065c5a4c82aSJason M. Bills messages::actionParameterValueFormatError( 3066002d39b4SEd Tanous asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType", 3067002d39b4SEd Tanous "CollectDiagnosticData"); 3068c5a4c82aSJason M. Bills return; 3069c5a4c82aSJason M. Bills } 3070c5a4c82aSJason M. Bills 3071c5a4c82aSJason M. Bills auto collectCrashdumpCallback = 3072c5a4c82aSJason M. Bills [asyncResp, payload(task::Payload(req)), 3073c5a4c82aSJason M. Bills taskMatchStr](const boost::system::error_code ec, 307498be3e39SEd Tanous const std::string&) mutable { 30751da66f75SEd Tanous if (ec) 30761da66f75SEd Tanous { 3077002d39b4SEd Tanous if (ec.value() == boost::system::errc::operation_not_supported) 30781da66f75SEd Tanous { 3079f12894f8SJason M. Bills messages::resourceInStandby(asyncResp->res); 30801da66f75SEd Tanous } 30814363d3b2SJason M. Bills else if (ec.value() == 30824363d3b2SJason M. Bills boost::system::errc::device_or_resource_busy) 30834363d3b2SJason M. Bills { 3084002d39b4SEd Tanous messages::serviceTemporarilyUnavailable(asyncResp->res, 3085002d39b4SEd Tanous "60"); 30864363d3b2SJason M. Bills } 30871da66f75SEd Tanous else 30881da66f75SEd Tanous { 3089f12894f8SJason M. Bills messages::internalError(asyncResp->res); 30901da66f75SEd Tanous } 30911da66f75SEd Tanous return; 30921da66f75SEd Tanous } 3093002d39b4SEd Tanous std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 309459d494eeSPatrick Williams [](boost::system::error_code err, sdbusplus::message_t&, 3095002d39b4SEd Tanous const std::shared_ptr<task::TaskData>& taskData) { 309666afe4faSJames Feist if (!err) 309766afe4faSJames Feist { 3098002d39b4SEd Tanous taskData->messages.emplace_back(messages::taskCompletedOK( 3099e5d5006bSJames Feist std::to_string(taskData->index))); 3100831d6b09SJames Feist taskData->state = "Completed"; 310166afe4faSJames Feist } 310232898ceaSJames Feist return task::completed; 310366afe4faSJames Feist }, 3104c5a4c82aSJason M. Bills taskMatchStr); 3105c5a4c82aSJason M. Bills 310646229577SJames Feist task->startTimer(std::chrono::minutes(5)); 310746229577SJames Feist task->populateResp(asyncResp->res); 310898be3e39SEd Tanous task->payload.emplace(std::move(payload)); 31091da66f75SEd Tanous }; 31108e6c099aSJason M. Bills 31111da66f75SEd Tanous crow::connections::systemBus->async_method_call( 3112002d39b4SEd Tanous std::move(collectCrashdumpCallback), crashdumpObject, crashdumpPath, 3113002d39b4SEd Tanous iface, method); 31147e860f15SJohn Edward Broadbent }); 31156eda7685SKenny L. Ku } 31166eda7685SKenny L. Ku 3117cb92c03bSAndrew Geissler /** 3118cb92c03bSAndrew Geissler * DBusLogServiceActionsClear class supports POST method for ClearLog action. 3119cb92c03bSAndrew Geissler */ 31207e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app) 3121cb92c03bSAndrew Geissler { 3122cb92c03bSAndrew Geissler /** 3123cb92c03bSAndrew Geissler * Function handles POST method request. 3124cb92c03bSAndrew Geissler * The Clear Log actions does not require any parameter.The action deletes 3125cb92c03bSAndrew Geissler * all entries found in the Entries collection for this Log Service. 3126cb92c03bSAndrew Geissler */ 31277e860f15SJohn Edward Broadbent 31280fda0f12SGeorge Liu BMCWEB_ROUTE( 31290fda0f12SGeorge Liu app, 31300fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog/") 3131ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 31327e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 313345ca1b86SEd Tanous [&app](const crow::Request& req, 31347e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 31353ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 313645ca1b86SEd Tanous { 313745ca1b86SEd Tanous return; 313845ca1b86SEd Tanous } 3139cb92c03bSAndrew Geissler BMCWEB_LOG_DEBUG << "Do delete all entries."; 3140cb92c03bSAndrew Geissler 3141cb92c03bSAndrew Geissler // Process response from Logging service. 3142002d39b4SEd Tanous auto respHandler = [asyncResp](const boost::system::error_code ec) { 3143002d39b4SEd Tanous BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done"; 3144cb92c03bSAndrew Geissler if (ec) 3145cb92c03bSAndrew Geissler { 3146cb92c03bSAndrew Geissler // TODO Handle for specific error code 3147002d39b4SEd Tanous BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec; 3148cb92c03bSAndrew Geissler asyncResp->res.result( 3149cb92c03bSAndrew Geissler boost::beast::http::status::internal_server_error); 3150cb92c03bSAndrew Geissler return; 3151cb92c03bSAndrew Geissler } 3152cb92c03bSAndrew Geissler 3153002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::no_content); 3154cb92c03bSAndrew Geissler }; 3155cb92c03bSAndrew Geissler 3156cb92c03bSAndrew Geissler // Make call to Logging service to request Clear Log 3157cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 31582c70f800SEd Tanous respHandler, "xyz.openbmc_project.Logging", 3159cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging", 3160cb92c03bSAndrew Geissler "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 31617e860f15SJohn Edward Broadbent }); 3162cb92c03bSAndrew Geissler } 3163a3316fc6SZhikuiRen 3164a3316fc6SZhikuiRen /**************************************************** 3165a3316fc6SZhikuiRen * Redfish PostCode interfaces 3166a3316fc6SZhikuiRen * using DBUS interface: getPostCodesTS 3167a3316fc6SZhikuiRen ******************************************************/ 31687e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesLogService(App& app) 3169a3316fc6SZhikuiRen { 31707e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/PostCodes/") 3171ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 3172002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 3173002d39b4SEd Tanous [&app](const crow::Request& req, 3174002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 31753ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 317645ca1b86SEd Tanous { 317745ca1b86SEd Tanous return; 317845ca1b86SEd Tanous } 31791476687dSEd Tanous 31801476687dSEd Tanous asyncResp->res.jsonValue["@odata.id"] = 31811476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes"; 31821476687dSEd Tanous asyncResp->res.jsonValue["@odata.type"] = 31831476687dSEd Tanous "#LogService.v1_1_0.LogService"; 31841476687dSEd Tanous asyncResp->res.jsonValue["Name"] = "POST Code Log Service"; 31851476687dSEd Tanous asyncResp->res.jsonValue["Description"] = "POST Code Log Service"; 31861476687dSEd Tanous asyncResp->res.jsonValue["Id"] = "BIOS POST Code Log"; 31871476687dSEd Tanous asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 31881476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 31891476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 31907c8c4058STejas Patil 31917c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 31922b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 31930fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 31947c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 31957c8c4058STejas Patil redfishDateTimeOffset.second; 31967c8c4058STejas Patil 3197a3316fc6SZhikuiRen asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 31987e860f15SJohn Edward Broadbent {"target", 31990fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog"}}; 32007e860f15SJohn Edward Broadbent }); 3201a3316fc6SZhikuiRen } 3202a3316fc6SZhikuiRen 32037e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesClear(App& app) 3204a3316fc6SZhikuiRen { 32050fda0f12SGeorge Liu BMCWEB_ROUTE( 32060fda0f12SGeorge Liu app, 32070fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog/") 3208ed398213SEd Tanous // The following privilege is incorrect; It should be ConfigureManager 3209ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3210432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 32117e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 321245ca1b86SEd Tanous [&app](const crow::Request& req, 32137e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 32143ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 321545ca1b86SEd Tanous { 321645ca1b86SEd Tanous return; 321745ca1b86SEd Tanous } 3218a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Do delete all postcodes entries."; 3219a3316fc6SZhikuiRen 3220a3316fc6SZhikuiRen // Make call to post-code service to request clear all 3221a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3222a3316fc6SZhikuiRen [asyncResp](const boost::system::error_code ec) { 3223a3316fc6SZhikuiRen if (ec) 3224a3316fc6SZhikuiRen { 3225a3316fc6SZhikuiRen // TODO Handle for specific error code 3226002d39b4SEd Tanous BMCWEB_LOG_ERROR << "doClearPostCodes resp_handler got error " 32277e860f15SJohn Edward Broadbent << ec; 3228002d39b4SEd Tanous asyncResp->res.result( 3229002d39b4SEd Tanous boost::beast::http::status::internal_server_error); 3230a3316fc6SZhikuiRen messages::internalError(asyncResp->res); 3231a3316fc6SZhikuiRen return; 3232a3316fc6SZhikuiRen } 3233a3316fc6SZhikuiRen }, 323415124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 323515124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3236a3316fc6SZhikuiRen "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 32377e860f15SJohn Edward Broadbent }); 3238a3316fc6SZhikuiRen } 3239a3316fc6SZhikuiRen 3240a3316fc6SZhikuiRen static void fillPostCodeEntry( 32418d1b46d7Szhanghch05 const std::shared_ptr<bmcweb::AsyncResp>& aResp, 32426c9a279eSManojkiran Eda const boost::container::flat_map< 32436c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode, 3244a3316fc6SZhikuiRen const uint16_t bootIndex, const uint64_t codeIndex = 0, 3245a3316fc6SZhikuiRen const uint64_t skip = 0, const uint64_t top = 0) 3246a3316fc6SZhikuiRen { 3247a3316fc6SZhikuiRen // Get the Message from the MessageRegistry 3248fffb8c1fSEd Tanous const registries::Message* message = 3249fffb8c1fSEd Tanous registries::getMessage("OpenBMC.0.2.BIOSPOSTCode"); 3250a3316fc6SZhikuiRen 3251a3316fc6SZhikuiRen uint64_t currentCodeIndex = 0; 3252a3316fc6SZhikuiRen nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"]; 3253a3316fc6SZhikuiRen 3254a3316fc6SZhikuiRen uint64_t firstCodeTimeUs = 0; 32556c9a279eSManojkiran Eda for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 32566c9a279eSManojkiran Eda code : postcode) 3257a3316fc6SZhikuiRen { 3258a3316fc6SZhikuiRen currentCodeIndex++; 3259a3316fc6SZhikuiRen std::string postcodeEntryID = 3260a3316fc6SZhikuiRen "B" + std::to_string(bootIndex) + "-" + 3261a3316fc6SZhikuiRen std::to_string(currentCodeIndex); // 1 based index in EntryID string 3262a3316fc6SZhikuiRen 3263a3316fc6SZhikuiRen uint64_t usecSinceEpoch = code.first; 3264a3316fc6SZhikuiRen uint64_t usTimeOffset = 0; 3265a3316fc6SZhikuiRen 3266a3316fc6SZhikuiRen if (1 == currentCodeIndex) 3267a3316fc6SZhikuiRen { // already incremented 3268a3316fc6SZhikuiRen firstCodeTimeUs = code.first; 3269a3316fc6SZhikuiRen } 3270a3316fc6SZhikuiRen else 3271a3316fc6SZhikuiRen { 3272a3316fc6SZhikuiRen usTimeOffset = code.first - firstCodeTimeUs; 3273a3316fc6SZhikuiRen } 3274a3316fc6SZhikuiRen 3275a3316fc6SZhikuiRen // skip if no specific codeIndex is specified and currentCodeIndex does 3276a3316fc6SZhikuiRen // not fall between top and skip 3277a3316fc6SZhikuiRen if ((codeIndex == 0) && 3278a3316fc6SZhikuiRen (currentCodeIndex <= skip || currentCodeIndex > top)) 3279a3316fc6SZhikuiRen { 3280a3316fc6SZhikuiRen continue; 3281a3316fc6SZhikuiRen } 3282a3316fc6SZhikuiRen 32834e0453b1SGunnar Mills // skip if a specific codeIndex is specified and does not match the 3284a3316fc6SZhikuiRen // currentIndex 3285a3316fc6SZhikuiRen if ((codeIndex > 0) && (currentCodeIndex != codeIndex)) 3286a3316fc6SZhikuiRen { 3287a3316fc6SZhikuiRen // This is done for simplicity. 1st entry is needed to calculate 3288a3316fc6SZhikuiRen // time offset. To improve efficiency, one can get to the entry 3289a3316fc6SZhikuiRen // directly (possibly with flatmap's nth method) 3290a3316fc6SZhikuiRen continue; 3291a3316fc6SZhikuiRen } 3292a3316fc6SZhikuiRen 3293a3316fc6SZhikuiRen // currentCodeIndex is within top and skip or equal to specified code 3294a3316fc6SZhikuiRen // index 3295a3316fc6SZhikuiRen 3296a3316fc6SZhikuiRen // Get the Created time from the timestamp 3297a3316fc6SZhikuiRen std::string entryTimeStr; 32981d8782e7SNan Zhou entryTimeStr = 32992b82937eSEd Tanous redfish::time_utils::getDateTimeUint(usecSinceEpoch / 1000 / 1000); 3300a3316fc6SZhikuiRen 3301a3316fc6SZhikuiRen // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex) 3302a3316fc6SZhikuiRen std::ostringstream hexCode; 3303a3316fc6SZhikuiRen hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex 33046c9a279eSManojkiran Eda << std::get<0>(code.second); 3305a3316fc6SZhikuiRen std::ostringstream timeOffsetStr; 3306a3316fc6SZhikuiRen // Set Fixed -Point Notation 3307a3316fc6SZhikuiRen timeOffsetStr << std::fixed; 3308a3316fc6SZhikuiRen // Set precision to 4 digits 3309a3316fc6SZhikuiRen timeOffsetStr << std::setprecision(4); 3310a3316fc6SZhikuiRen // Add double to stream 3311a3316fc6SZhikuiRen timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000; 3312a3316fc6SZhikuiRen std::vector<std::string> messageArgs = { 3313a3316fc6SZhikuiRen std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()}; 3314a3316fc6SZhikuiRen 3315a3316fc6SZhikuiRen // Get MessageArgs template from message registry 3316a3316fc6SZhikuiRen std::string msg; 3317a3316fc6SZhikuiRen if (message != nullptr) 3318a3316fc6SZhikuiRen { 3319a3316fc6SZhikuiRen msg = message->message; 3320a3316fc6SZhikuiRen 3321a3316fc6SZhikuiRen // fill in this post code value 3322a3316fc6SZhikuiRen int i = 0; 3323a3316fc6SZhikuiRen for (const std::string& messageArg : messageArgs) 3324a3316fc6SZhikuiRen { 3325a3316fc6SZhikuiRen std::string argStr = "%" + std::to_string(++i); 3326a3316fc6SZhikuiRen size_t argPos = msg.find(argStr); 3327a3316fc6SZhikuiRen if (argPos != std::string::npos) 3328a3316fc6SZhikuiRen { 3329a3316fc6SZhikuiRen msg.replace(argPos, argStr.length(), messageArg); 3330a3316fc6SZhikuiRen } 3331a3316fc6SZhikuiRen } 3332a3316fc6SZhikuiRen } 3333a3316fc6SZhikuiRen 3334d4342a92STim Lee // Get Severity template from message registry 3335d4342a92STim Lee std::string severity; 3336d4342a92STim Lee if (message != nullptr) 3337d4342a92STim Lee { 33385f2b84eeSEd Tanous severity = message->messageSeverity; 3339d4342a92STim Lee } 3340d4342a92STim Lee 3341a3316fc6SZhikuiRen // add to AsyncResp 3342a3316fc6SZhikuiRen logEntryArray.push_back({}); 3343a3316fc6SZhikuiRen nlohmann::json& bmcLogEntry = logEntryArray.back(); 334484afc48bSJason M. Bills bmcLogEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 334584afc48bSJason M. Bills bmcLogEntry["@odata.id"] = 33460fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 334784afc48bSJason M. Bills postcodeEntryID; 334884afc48bSJason M. Bills bmcLogEntry["Name"] = "POST Code Log Entry"; 334984afc48bSJason M. Bills bmcLogEntry["Id"] = postcodeEntryID; 335084afc48bSJason M. Bills bmcLogEntry["Message"] = std::move(msg); 335184afc48bSJason M. Bills bmcLogEntry["MessageId"] = "OpenBMC.0.2.BIOSPOSTCode"; 335284afc48bSJason M. Bills bmcLogEntry["MessageArgs"] = std::move(messageArgs); 335384afc48bSJason M. Bills bmcLogEntry["EntryType"] = "Event"; 335484afc48bSJason M. Bills bmcLogEntry["Severity"] = std::move(severity); 335584afc48bSJason M. Bills bmcLogEntry["Created"] = entryTimeStr; 3356647b3cdcSGeorge Liu if (!std::get<std::vector<uint8_t>>(code.second).empty()) 3357647b3cdcSGeorge Liu { 3358647b3cdcSGeorge Liu bmcLogEntry["AdditionalDataURI"] = 3359647b3cdcSGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 3360647b3cdcSGeorge Liu postcodeEntryID + "/attachment"; 3361647b3cdcSGeorge Liu } 3362a3316fc6SZhikuiRen } 3363a3316fc6SZhikuiRen } 3364a3316fc6SZhikuiRen 33658d1b46d7Szhanghch05 static void getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3366a3316fc6SZhikuiRen const uint16_t bootIndex, 3367a3316fc6SZhikuiRen const uint64_t codeIndex) 3368a3316fc6SZhikuiRen { 3369a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 33706c9a279eSManojkiran Eda [aResp, bootIndex, 33716c9a279eSManojkiran Eda codeIndex](const boost::system::error_code ec, 33726c9a279eSManojkiran Eda const boost::container::flat_map< 33736c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 33746c9a279eSManojkiran Eda postcode) { 3375a3316fc6SZhikuiRen if (ec) 3376a3316fc6SZhikuiRen { 3377a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3378a3316fc6SZhikuiRen messages::internalError(aResp->res); 3379a3316fc6SZhikuiRen return; 3380a3316fc6SZhikuiRen } 3381a3316fc6SZhikuiRen 3382a3316fc6SZhikuiRen // skip the empty postcode boots 3383a3316fc6SZhikuiRen if (postcode.empty()) 3384a3316fc6SZhikuiRen { 3385a3316fc6SZhikuiRen return; 3386a3316fc6SZhikuiRen } 3387a3316fc6SZhikuiRen 3388a3316fc6SZhikuiRen fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex); 3389a3316fc6SZhikuiRen 3390a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = 3391a3316fc6SZhikuiRen aResp->res.jsonValue["Members"].size(); 3392a3316fc6SZhikuiRen }, 339315124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 339415124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3395a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3396a3316fc6SZhikuiRen bootIndex); 3397a3316fc6SZhikuiRen } 3398a3316fc6SZhikuiRen 33998d1b46d7Szhanghch05 static void getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3400a3316fc6SZhikuiRen const uint16_t bootIndex, 3401a3316fc6SZhikuiRen const uint16_t bootCount, 34023648c8beSEd Tanous const uint64_t entryCount, size_t skip, 34033648c8beSEd Tanous size_t top) 3404a3316fc6SZhikuiRen { 3405a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3406a3316fc6SZhikuiRen [aResp, bootIndex, bootCount, entryCount, skip, 3407a3316fc6SZhikuiRen top](const boost::system::error_code ec, 34086c9a279eSManojkiran Eda const boost::container::flat_map< 34096c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 34106c9a279eSManojkiran Eda postcode) { 3411a3316fc6SZhikuiRen if (ec) 3412a3316fc6SZhikuiRen { 3413a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3414a3316fc6SZhikuiRen messages::internalError(aResp->res); 3415a3316fc6SZhikuiRen return; 3416a3316fc6SZhikuiRen } 3417a3316fc6SZhikuiRen 3418a3316fc6SZhikuiRen uint64_t endCount = entryCount; 3419a3316fc6SZhikuiRen if (!postcode.empty()) 3420a3316fc6SZhikuiRen { 3421a3316fc6SZhikuiRen endCount = entryCount + postcode.size(); 34223648c8beSEd Tanous if (skip < endCount && (top + skip) > entryCount) 3423a3316fc6SZhikuiRen { 34243648c8beSEd Tanous uint64_t thisBootSkip = 34253648c8beSEd Tanous std::max(static_cast<uint64_t>(skip), entryCount) - 34263648c8beSEd Tanous entryCount; 3427a3316fc6SZhikuiRen uint64_t thisBootTop = 34283648c8beSEd Tanous std::min(static_cast<uint64_t>(top + skip), endCount) - 34293648c8beSEd Tanous entryCount; 3430a3316fc6SZhikuiRen 3431002d39b4SEd Tanous fillPostCodeEntry(aResp, postcode, bootIndex, 0, thisBootSkip, 3432002d39b4SEd Tanous thisBootTop); 3433a3316fc6SZhikuiRen } 3434a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = endCount; 3435a3316fc6SZhikuiRen } 3436a3316fc6SZhikuiRen 3437a3316fc6SZhikuiRen // continue to previous bootIndex 3438a3316fc6SZhikuiRen if (bootIndex < bootCount) 3439a3316fc6SZhikuiRen { 3440a3316fc6SZhikuiRen getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1), 3441a3316fc6SZhikuiRen bootCount, endCount, skip, top); 3442a3316fc6SZhikuiRen } 344381584abeSJiaqing Zhao else if (skip + top < endCount) 3444a3316fc6SZhikuiRen { 3445a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.nextLink"] = 34460fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=" + 3447a3316fc6SZhikuiRen std::to_string(skip + top); 3448a3316fc6SZhikuiRen } 3449a3316fc6SZhikuiRen }, 345015124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 345115124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3452a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3453a3316fc6SZhikuiRen bootIndex); 3454a3316fc6SZhikuiRen } 3455a3316fc6SZhikuiRen 34568d1b46d7Szhanghch05 static void 34578d1b46d7Szhanghch05 getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 34583648c8beSEd Tanous size_t skip, size_t top) 3459a3316fc6SZhikuiRen { 3460a3316fc6SZhikuiRen uint64_t entryCount = 0; 34611e1e598dSJonathan Doman sdbusplus::asio::getProperty<uint16_t>( 34621e1e598dSJonathan Doman *crow::connections::systemBus, 34631e1e598dSJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 34641e1e598dSJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 34651e1e598dSJonathan Doman "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount", 34661e1e598dSJonathan Doman [aResp, entryCount, skip, top](const boost::system::error_code ec, 34671e1e598dSJonathan Doman const uint16_t bootCount) { 3468a3316fc6SZhikuiRen if (ec) 3469a3316fc6SZhikuiRen { 3470a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3471a3316fc6SZhikuiRen messages::internalError(aResp->res); 3472a3316fc6SZhikuiRen return; 3473a3316fc6SZhikuiRen } 34741e1e598dSJonathan Doman getPostCodeForBoot(aResp, 1, bootCount, entryCount, skip, top); 34751e1e598dSJonathan Doman }); 3476a3316fc6SZhikuiRen } 3477a3316fc6SZhikuiRen 34787e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntryCollection(App& app) 3479a3316fc6SZhikuiRen { 34807e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 34817e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/") 3482ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 34837e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 348445ca1b86SEd Tanous [&app](const crow::Request& req, 34857e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 3486c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 3487c937d2bfSEd Tanous .canDelegateTop = true, 3488c937d2bfSEd Tanous .canDelegateSkip = true, 3489c937d2bfSEd Tanous }; 3490c937d2bfSEd Tanous query_param::Query delegatedQuery; 3491c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 34923ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 349345ca1b86SEd Tanous { 349445ca1b86SEd Tanous return; 349545ca1b86SEd Tanous } 3496a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.type"] = 3497a3316fc6SZhikuiRen "#LogEntryCollection.LogEntryCollection"; 3498a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 3499a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3500a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3501a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3502a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3503a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3504a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 35053648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 35065143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 35073648c8beSEd Tanous getCurrentBootNumber(asyncResp, skip, top); 35087e860f15SJohn Edward Broadbent }); 3509a3316fc6SZhikuiRen } 3510a3316fc6SZhikuiRen 3511647b3cdcSGeorge Liu /** 3512647b3cdcSGeorge Liu * @brief Parse post code ID and get the current value and index value 3513647b3cdcSGeorge Liu * eg: postCodeID=B1-2, currentValue=1, index=2 3514647b3cdcSGeorge Liu * 3515647b3cdcSGeorge Liu * @param[in] postCodeID Post Code ID 3516647b3cdcSGeorge Liu * @param[out] currentValue Current value 3517647b3cdcSGeorge Liu * @param[out] index Index value 3518647b3cdcSGeorge Liu * 3519647b3cdcSGeorge Liu * @return bool true if the parsing is successful, false the parsing fails 3520647b3cdcSGeorge Liu */ 3521647b3cdcSGeorge Liu inline static bool parsePostCode(const std::string& postCodeID, 3522647b3cdcSGeorge Liu uint64_t& currentValue, uint16_t& index) 3523647b3cdcSGeorge Liu { 3524647b3cdcSGeorge Liu std::vector<std::string> split; 3525647b3cdcSGeorge Liu boost::algorithm::split(split, postCodeID, boost::is_any_of("-")); 3526647b3cdcSGeorge Liu if (split.size() != 2 || split[0].length() < 2 || split[0].front() != 'B') 3527647b3cdcSGeorge Liu { 3528647b3cdcSGeorge Liu return false; 3529647b3cdcSGeorge Liu } 3530647b3cdcSGeorge Liu 3531ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3532647b3cdcSGeorge Liu const char* start = split[0].data() + 1; 3533ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3534647b3cdcSGeorge Liu const char* end = split[0].data() + split[0].size(); 3535647b3cdcSGeorge Liu auto [ptrIndex, ecIndex] = std::from_chars(start, end, index); 3536647b3cdcSGeorge Liu 3537647b3cdcSGeorge Liu if (ptrIndex != end || ecIndex != std::errc()) 3538647b3cdcSGeorge Liu { 3539647b3cdcSGeorge Liu return false; 3540647b3cdcSGeorge Liu } 3541647b3cdcSGeorge Liu 3542647b3cdcSGeorge Liu start = split[1].data(); 3543ca45aa3cSEd Tanous 3544ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3545647b3cdcSGeorge Liu end = split[1].data() + split[1].size(); 3546647b3cdcSGeorge Liu auto [ptrValue, ecValue] = std::from_chars(start, end, currentValue); 3547647b3cdcSGeorge Liu 3548517d9a58STony Lee return ptrValue == end && ecValue == std::errc(); 3549647b3cdcSGeorge Liu } 3550647b3cdcSGeorge Liu 3551647b3cdcSGeorge Liu inline void requestRoutesPostCodesEntryAdditionalData(App& app) 3552647b3cdcSGeorge Liu { 35530fda0f12SGeorge Liu BMCWEB_ROUTE( 35540fda0f12SGeorge Liu app, 35550fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/attachment/") 3556647b3cdcSGeorge Liu .privileges(redfish::privileges::getLogEntry) 3557647b3cdcSGeorge Liu .methods(boost::beast::http::verb::get)( 355845ca1b86SEd Tanous [&app](const crow::Request& req, 3559647b3cdcSGeorge Liu const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3560647b3cdcSGeorge Liu const std::string& postCodeID) { 35613ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 356245ca1b86SEd Tanous { 356345ca1b86SEd Tanous return; 356445ca1b86SEd Tanous } 3565002d39b4SEd Tanous if (!http_helpers::isOctetAccepted(req.getHeaderValue("Accept"))) 3566647b3cdcSGeorge Liu { 3567002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::bad_request); 3568647b3cdcSGeorge Liu return; 3569647b3cdcSGeorge Liu } 3570647b3cdcSGeorge Liu 3571647b3cdcSGeorge Liu uint64_t currentValue = 0; 3572647b3cdcSGeorge Liu uint16_t index = 0; 3573647b3cdcSGeorge Liu if (!parsePostCode(postCodeID, currentValue, index)) 3574647b3cdcSGeorge Liu { 3575002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", postCodeID); 3576647b3cdcSGeorge Liu return; 3577647b3cdcSGeorge Liu } 3578647b3cdcSGeorge Liu 3579647b3cdcSGeorge Liu crow::connections::systemBus->async_method_call( 3580647b3cdcSGeorge Liu [asyncResp, postCodeID, currentValue]( 3581647b3cdcSGeorge Liu const boost::system::error_code ec, 3582002d39b4SEd Tanous const std::vector<std::tuple<uint64_t, std::vector<uint8_t>>>& 3583002d39b4SEd Tanous postcodes) { 3584647b3cdcSGeorge Liu if (ec.value() == EBADR) 3585647b3cdcSGeorge Liu { 3586002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 3587002d39b4SEd Tanous postCodeID); 3588647b3cdcSGeorge Liu return; 3589647b3cdcSGeorge Liu } 3590647b3cdcSGeorge Liu if (ec) 3591647b3cdcSGeorge Liu { 3592647b3cdcSGeorge Liu BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3593647b3cdcSGeorge Liu messages::internalError(asyncResp->res); 3594647b3cdcSGeorge Liu return; 3595647b3cdcSGeorge Liu } 3596647b3cdcSGeorge Liu 3597647b3cdcSGeorge Liu size_t value = static_cast<size_t>(currentValue) - 1; 3598002d39b4SEd Tanous if (value == std::string::npos || postcodes.size() < currentValue) 3599647b3cdcSGeorge Liu { 3600647b3cdcSGeorge Liu BMCWEB_LOG_ERROR << "Wrong currentValue value"; 3601002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 3602002d39b4SEd Tanous postCodeID); 3603647b3cdcSGeorge Liu return; 3604647b3cdcSGeorge Liu } 3605647b3cdcSGeorge Liu 36069eb808c1SEd Tanous const auto& [tID, c] = postcodes[value]; 360746ff87baSEd Tanous if (c.empty()) 3608647b3cdcSGeorge Liu { 3609647b3cdcSGeorge Liu BMCWEB_LOG_INFO << "No found post code data"; 3610002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 3611002d39b4SEd Tanous postCodeID); 3612647b3cdcSGeorge Liu return; 3613647b3cdcSGeorge Liu } 361446ff87baSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) 361546ff87baSEd Tanous const char* d = reinterpret_cast<const char*>(c.data()); 361646ff87baSEd Tanous std::string_view strData(d, c.size()); 3617647b3cdcSGeorge Liu 3618d9f6c621SEd Tanous asyncResp->res.addHeader(boost::beast::http::field::content_type, 3619647b3cdcSGeorge Liu "application/octet-stream"); 3620d9f6c621SEd Tanous asyncResp->res.addHeader( 3621d9f6c621SEd Tanous boost::beast::http::field::content_transfer_encoding, "Base64"); 3622002d39b4SEd Tanous asyncResp->res.body() = crow::utility::base64encode(strData); 3623647b3cdcSGeorge Liu }, 3624647b3cdcSGeorge Liu "xyz.openbmc_project.State.Boot.PostCode0", 3625647b3cdcSGeorge Liu "/xyz/openbmc_project/State/Boot/PostCode0", 3626002d39b4SEd Tanous "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", index); 3627647b3cdcSGeorge Liu }); 3628647b3cdcSGeorge Liu } 3629647b3cdcSGeorge Liu 36307e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntry(App& app) 3631a3316fc6SZhikuiRen { 36327e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 36337e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/") 3634ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 36357e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 363645ca1b86SEd Tanous [&app](const crow::Request& req, 36377e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 36387e860f15SJohn Edward Broadbent const std::string& targetID) { 36393ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 364045ca1b86SEd Tanous { 364145ca1b86SEd Tanous return; 364245ca1b86SEd Tanous } 3643647b3cdcSGeorge Liu uint16_t bootIndex = 0; 3644647b3cdcSGeorge Liu uint64_t codeIndex = 0; 3645647b3cdcSGeorge Liu if (!parsePostCode(targetID, codeIndex, bootIndex)) 3646a3316fc6SZhikuiRen { 3647a3316fc6SZhikuiRen // Requested ID was not found 3648ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 3649a3316fc6SZhikuiRen return; 3650a3316fc6SZhikuiRen } 3651a3316fc6SZhikuiRen if (bootIndex == 0 || codeIndex == 0) 3652a3316fc6SZhikuiRen { 3653a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string " 36547e860f15SJohn Edward Broadbent << targetID; 3655a3316fc6SZhikuiRen } 3656a3316fc6SZhikuiRen 3657002d39b4SEd Tanous asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_4_0.LogEntry"; 3658a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 36590fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3660a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3661a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3662a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3663a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3664a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 3665a3316fc6SZhikuiRen 3666a3316fc6SZhikuiRen getPostCodeForEntry(asyncResp, bootIndex, codeIndex); 36677e860f15SJohn Edward Broadbent }); 3668a3316fc6SZhikuiRen } 3669a3316fc6SZhikuiRen 36701da66f75SEd Tanous } // namespace redfish 3671