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> 412b82937eSEd Tanous #include <utils/time_utils.hpp> 421214b7e7SGunnar Mills 43647b3cdcSGeorge Liu #include <charconv> 444418c7f0SJames Feist #include <filesystem> 4575710de2SXiaochao Ma #include <optional> 4626702d01SEd Tanous #include <span> 47cd225da8SJason M. Bills #include <string_view> 48abf2add6SEd Tanous #include <variant> 491da66f75SEd Tanous 501da66f75SEd Tanous namespace redfish 511da66f75SEd Tanous { 521da66f75SEd Tanous 535b61b5e8SJason M. Bills constexpr char const* crashdumpObject = "com.intel.crashdump"; 545b61b5e8SJason M. Bills constexpr char const* crashdumpPath = "/com/intel/crashdump"; 555b61b5e8SJason M. Bills constexpr char const* crashdumpInterface = "com.intel.crashdump"; 565b61b5e8SJason M. Bills constexpr char const* deleteAllInterface = 575b61b5e8SJason M. Bills "xyz.openbmc_project.Collection.DeleteAll"; 585b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandInterface = 59424c4176SJason M. Bills "com.intel.crashdump.OnDemand"; 606eda7685SKenny L. Ku constexpr char const* crashdumpTelemetryInterface = 616eda7685SKenny L. Ku "com.intel.crashdump.Telemetry"; 621da66f75SEd Tanous 63fffb8c1fSEd Tanous namespace registries 644851d45dSJason M. Bills { 6526702d01SEd Tanous static const Message* 6626702d01SEd Tanous getMessageFromRegistry(const std::string& messageKey, 6726702d01SEd Tanous const std::span<const MessageEntry> registry) 684851d45dSJason M. Bills { 69002d39b4SEd Tanous std::span<const MessageEntry>::iterator messageIt = 70002d39b4SEd Tanous std::find_if(registry.begin(), registry.end(), 714851d45dSJason M. Bills [&messageKey](const MessageEntry& messageEntry) { 72e662eae8SEd Tanous return std::strcmp(messageEntry.first, messageKey.c_str()) == 0; 734851d45dSJason M. Bills }); 7426702d01SEd Tanous if (messageIt != registry.end()) 754851d45dSJason M. Bills { 764851d45dSJason M. Bills return &messageIt->second; 774851d45dSJason M. Bills } 784851d45dSJason M. Bills 794851d45dSJason M. Bills return nullptr; 804851d45dSJason M. Bills } 814851d45dSJason M. Bills 824851d45dSJason M. Bills static const Message* getMessage(const std::string_view& messageID) 834851d45dSJason M. Bills { 844851d45dSJason M. Bills // Redfish MessageIds are in the form 854851d45dSJason M. Bills // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 864851d45dSJason M. Bills // the right Message 874851d45dSJason M. Bills std::vector<std::string> fields; 884851d45dSJason M. Bills fields.reserve(4); 894851d45dSJason M. Bills boost::split(fields, messageID, boost::is_any_of(".")); 9002cad96eSEd Tanous const std::string& registryName = fields[0]; 9102cad96eSEd Tanous const std::string& messageKey = fields[3]; 924851d45dSJason M. Bills 934851d45dSJason M. Bills // Find the right registry and check it for the MessageKey 944851d45dSJason M. Bills if (std::string(base::header.registryPrefix) == registryName) 954851d45dSJason M. Bills { 964851d45dSJason M. Bills return getMessageFromRegistry( 9726702d01SEd Tanous messageKey, std::span<const MessageEntry>(base::registry)); 984851d45dSJason M. Bills } 994851d45dSJason M. Bills if (std::string(openbmc::header.registryPrefix) == registryName) 1004851d45dSJason M. Bills { 1014851d45dSJason M. Bills return getMessageFromRegistry( 10226702d01SEd Tanous messageKey, std::span<const MessageEntry>(openbmc::registry)); 1034851d45dSJason M. Bills } 1044851d45dSJason M. Bills return nullptr; 1054851d45dSJason M. Bills } 106fffb8c1fSEd Tanous } // namespace registries 1074851d45dSJason M. Bills 108f6150403SJames Feist namespace fs = std::filesystem; 1091da66f75SEd Tanous 110cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s) 111cb92c03bSAndrew Geissler { 112d4d25793SEd Tanous if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") || 113d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") || 114d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") || 115d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Error")) 116cb92c03bSAndrew Geissler { 117cb92c03bSAndrew Geissler return "Critical"; 118cb92c03bSAndrew Geissler } 1193174e4dfSEd Tanous if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") || 120d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") || 121d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Notice")) 122cb92c03bSAndrew Geissler { 123cb92c03bSAndrew Geissler return "OK"; 124cb92c03bSAndrew Geissler } 1253174e4dfSEd Tanous if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning") 126cb92c03bSAndrew Geissler { 127cb92c03bSAndrew Geissler return "Warning"; 128cb92c03bSAndrew Geissler } 129cb92c03bSAndrew Geissler return ""; 130cb92c03bSAndrew Geissler } 131cb92c03bSAndrew Geissler 1327e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal, 13339e77504SEd Tanous const std::string_view& field, 13439e77504SEd Tanous std::string_view& contents) 13516428a1aSJason M. Bills { 13616428a1aSJason M. Bills const char* data = nullptr; 13716428a1aSJason M. Bills size_t length = 0; 13816428a1aSJason M. Bills int ret = 0; 13916428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 14046ff87baSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) 14146ff87baSEd Tanous const void** dataVoid = reinterpret_cast<const void**>(&data); 14246ff87baSEd Tanous 14346ff87baSEd Tanous ret = sd_journal_get_data(journal, field.data(), dataVoid, &length); 14416428a1aSJason M. Bills if (ret < 0) 14516428a1aSJason M. Bills { 14616428a1aSJason M. Bills return ret; 14716428a1aSJason M. Bills } 14839e77504SEd Tanous contents = std::string_view(data, length); 14916428a1aSJason M. Bills // Only use the content after the "=" character. 15081ce609eSEd Tanous contents.remove_prefix(std::min(contents.find('=') + 1, contents.size())); 15116428a1aSJason M. Bills return ret; 15216428a1aSJason M. Bills } 15316428a1aSJason M. Bills 1547e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal, 1557e860f15SJohn Edward Broadbent const std::string_view& field, 1567e860f15SJohn Edward Broadbent const int& base, long int& contents) 15716428a1aSJason M. Bills { 15816428a1aSJason M. Bills int ret = 0; 15939e77504SEd Tanous std::string_view metadata; 16016428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 16116428a1aSJason M. Bills ret = getJournalMetadata(journal, field, metadata); 16216428a1aSJason M. Bills if (ret < 0) 16316428a1aSJason M. Bills { 16416428a1aSJason M. Bills return ret; 16516428a1aSJason M. Bills } 166b01bf299SEd Tanous contents = strtol(metadata.data(), nullptr, base); 16716428a1aSJason M. Bills return ret; 16816428a1aSJason M. Bills } 16916428a1aSJason M. Bills 1707e860f15SJohn Edward Broadbent inline static bool getEntryTimestamp(sd_journal* journal, 1717e860f15SJohn Edward Broadbent std::string& entryTimestamp) 172a3316fc6SZhikuiRen { 173a3316fc6SZhikuiRen int ret = 0; 174a3316fc6SZhikuiRen uint64_t timestamp = 0; 175a3316fc6SZhikuiRen ret = sd_journal_get_realtime_usec(journal, ×tamp); 176a3316fc6SZhikuiRen if (ret < 0) 177a3316fc6SZhikuiRen { 178a3316fc6SZhikuiRen BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 179a3316fc6SZhikuiRen << strerror(-ret); 180a3316fc6SZhikuiRen return false; 181a3316fc6SZhikuiRen } 1822b82937eSEd Tanous entryTimestamp = 1832b82937eSEd Tanous redfish::time_utils::getDateTimeUint(timestamp / 1000 / 1000); 1849c620e21SAsmitha Karunanithi return true; 185a3316fc6SZhikuiRen } 18650b8a43aSEd Tanous 1877e860f15SJohn Edward Broadbent inline static bool getUniqueEntryID(sd_journal* journal, std::string& entryID, 188e85d6b16SJason M. Bills const bool firstEntry = true) 18916428a1aSJason M. Bills { 19016428a1aSJason M. Bills int ret = 0; 19116428a1aSJason M. Bills static uint64_t prevTs = 0; 19216428a1aSJason M. Bills static int index = 0; 193e85d6b16SJason M. Bills if (firstEntry) 194e85d6b16SJason M. Bills { 195e85d6b16SJason M. Bills prevTs = 0; 196e85d6b16SJason M. Bills } 197e85d6b16SJason M. Bills 19816428a1aSJason M. Bills // Get the entry timestamp 19916428a1aSJason M. Bills uint64_t curTs = 0; 20016428a1aSJason M. Bills ret = sd_journal_get_realtime_usec(journal, &curTs); 20116428a1aSJason M. Bills if (ret < 0) 20216428a1aSJason M. Bills { 20316428a1aSJason M. Bills BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 20416428a1aSJason M. Bills << strerror(-ret); 20516428a1aSJason M. Bills return false; 20616428a1aSJason M. Bills } 20716428a1aSJason M. Bills // If the timestamp isn't unique, increment the index 20816428a1aSJason M. Bills if (curTs == prevTs) 20916428a1aSJason M. Bills { 21016428a1aSJason M. Bills index++; 21116428a1aSJason M. Bills } 21216428a1aSJason M. Bills else 21316428a1aSJason M. Bills { 21416428a1aSJason M. Bills // Otherwise, reset it 21516428a1aSJason M. Bills index = 0; 21616428a1aSJason M. Bills } 21716428a1aSJason M. Bills // Save the timestamp 21816428a1aSJason M. Bills prevTs = curTs; 21916428a1aSJason M. Bills 22016428a1aSJason M. Bills entryID = std::to_string(curTs); 22116428a1aSJason M. Bills if (index > 0) 22216428a1aSJason M. Bills { 22316428a1aSJason M. Bills entryID += "_" + std::to_string(index); 22416428a1aSJason M. Bills } 22516428a1aSJason M. Bills return true; 22616428a1aSJason M. Bills } 22716428a1aSJason M. Bills 228e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID, 229e85d6b16SJason M. Bills const bool firstEntry = true) 23095820184SJason M. Bills { 231271584abSEd Tanous static time_t prevTs = 0; 23295820184SJason M. Bills static int index = 0; 233e85d6b16SJason M. Bills if (firstEntry) 234e85d6b16SJason M. Bills { 235e85d6b16SJason M. Bills prevTs = 0; 236e85d6b16SJason M. Bills } 237e85d6b16SJason M. Bills 23895820184SJason M. Bills // Get the entry timestamp 239271584abSEd Tanous std::time_t curTs = 0; 24095820184SJason M. Bills std::tm timeStruct = {}; 24195820184SJason M. Bills std::istringstream entryStream(logEntry); 24295820184SJason M. Bills if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 24395820184SJason M. Bills { 24495820184SJason M. Bills curTs = std::mktime(&timeStruct); 24595820184SJason M. Bills } 24695820184SJason M. Bills // If the timestamp isn't unique, increment the index 24795820184SJason M. Bills if (curTs == prevTs) 24895820184SJason M. Bills { 24995820184SJason M. Bills index++; 25095820184SJason M. Bills } 25195820184SJason M. Bills else 25295820184SJason M. Bills { 25395820184SJason M. Bills // Otherwise, reset it 25495820184SJason M. Bills index = 0; 25595820184SJason M. Bills } 25695820184SJason M. Bills // Save the timestamp 25795820184SJason M. Bills prevTs = curTs; 25895820184SJason M. Bills 25995820184SJason M. Bills entryID = std::to_string(curTs); 26095820184SJason M. Bills if (index > 0) 26195820184SJason M. Bills { 26295820184SJason M. Bills entryID += "_" + std::to_string(index); 26395820184SJason M. Bills } 26495820184SJason M. Bills return true; 26595820184SJason M. Bills } 26695820184SJason M. Bills 2677e860f15SJohn Edward Broadbent inline static bool 2688d1b46d7Szhanghch05 getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2698d1b46d7Szhanghch05 const std::string& entryID, uint64_t& timestamp, 2708d1b46d7Szhanghch05 uint64_t& index) 27116428a1aSJason M. Bills { 27216428a1aSJason M. Bills if (entryID.empty()) 27316428a1aSJason M. Bills { 27416428a1aSJason M. Bills return false; 27516428a1aSJason M. Bills } 27616428a1aSJason M. Bills // Convert the unique ID back to a timestamp to find the entry 27739e77504SEd Tanous std::string_view tsStr(entryID); 27816428a1aSJason M. Bills 27981ce609eSEd Tanous auto underscorePos = tsStr.find('_'); 28071d5d8dbSEd Tanous if (underscorePos != std::string_view::npos) 28116428a1aSJason M. Bills { 28216428a1aSJason M. Bills // Timestamp has an index 28316428a1aSJason M. Bills tsStr.remove_suffix(tsStr.size() - underscorePos); 28439e77504SEd Tanous std::string_view indexStr(entryID); 28516428a1aSJason M. Bills indexStr.remove_prefix(underscorePos + 1); 286c0bd5e4bSEd Tanous auto [ptr, ec] = std::from_chars( 287c0bd5e4bSEd Tanous indexStr.data(), indexStr.data() + indexStr.size(), index); 288c0bd5e4bSEd Tanous if (ec != std::errc()) 28916428a1aSJason M. Bills { 290ace85d60SEd Tanous messages::resourceMissingAtURI( 291ace85d60SEd Tanous asyncResp->res, crow::utility::urlFromPieces(entryID)); 29216428a1aSJason M. Bills return false; 29316428a1aSJason M. Bills } 29416428a1aSJason M. Bills } 29516428a1aSJason M. Bills // Timestamp has no index 296c0bd5e4bSEd Tanous auto [ptr, ec] = 297c0bd5e4bSEd Tanous std::from_chars(tsStr.data(), tsStr.data() + tsStr.size(), timestamp); 298c0bd5e4bSEd Tanous if (ec != std::errc()) 29916428a1aSJason M. Bills { 300ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, 301ace85d60SEd Tanous crow::utility::urlFromPieces(entryID)); 30216428a1aSJason M. Bills return false; 30316428a1aSJason M. Bills } 30416428a1aSJason M. Bills return true; 30516428a1aSJason M. Bills } 30616428a1aSJason M. Bills 30795820184SJason M. Bills static bool 30895820184SJason M. Bills getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles) 30995820184SJason M. Bills { 31095820184SJason M. Bills static const std::filesystem::path redfishLogDir = "/var/log"; 31195820184SJason M. Bills static const std::string redfishLogFilename = "redfish"; 31295820184SJason M. Bills 31395820184SJason M. Bills // Loop through the directory looking for redfish log files 31495820184SJason M. Bills for (const std::filesystem::directory_entry& dirEnt : 31595820184SJason M. Bills std::filesystem::directory_iterator(redfishLogDir)) 31695820184SJason M. Bills { 31795820184SJason M. Bills // If we find a redfish log file, save the path 31895820184SJason M. Bills std::string filename = dirEnt.path().filename(); 31911ba3979SEd Tanous if (filename.starts_with(redfishLogFilename)) 32095820184SJason M. Bills { 32195820184SJason M. Bills redfishLogFiles.emplace_back(redfishLogDir / filename); 32295820184SJason M. Bills } 32395820184SJason M. Bills } 32495820184SJason M. Bills // As the log files rotate, they are appended with a ".#" that is higher for 32595820184SJason M. Bills // the older logs. Since we don't expect more than 10 log files, we 32695820184SJason M. Bills // can just sort the list to get them in order from newest to oldest 32795820184SJason M. Bills std::sort(redfishLogFiles.begin(), redfishLogFiles.end()); 32895820184SJason M. Bills 32995820184SJason M. Bills return !redfishLogFiles.empty(); 33095820184SJason M. Bills } 33195820184SJason M. Bills 332aefe3786SClaire Weinan inline void parseDumpEntryFromDbusObject( 3332d613eb6SJiaqing Zhao const dbus::utility::ManagedObjectType::value_type& object, 3342d613eb6SJiaqing Zhao std::string& dumpStatus, uint64_t& size, uint64_t& timestamp, 335aefe3786SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 336aefe3786SClaire Weinan { 337aefe3786SClaire Weinan for (const auto& interfaceMap : object.second) 338aefe3786SClaire Weinan { 339aefe3786SClaire Weinan if (interfaceMap.first == "xyz.openbmc_project.Common.Progress") 340aefe3786SClaire Weinan { 341aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 342aefe3786SClaire Weinan { 343aefe3786SClaire Weinan if (propertyMap.first == "Status") 344aefe3786SClaire Weinan { 345aefe3786SClaire Weinan const auto* status = 346aefe3786SClaire Weinan std::get_if<std::string>(&propertyMap.second); 347aefe3786SClaire Weinan if (status == nullptr) 348aefe3786SClaire Weinan { 349aefe3786SClaire Weinan messages::internalError(asyncResp->res); 350aefe3786SClaire Weinan break; 351aefe3786SClaire Weinan } 352aefe3786SClaire Weinan dumpStatus = *status; 353aefe3786SClaire Weinan } 354aefe3786SClaire Weinan } 355aefe3786SClaire Weinan } 356aefe3786SClaire Weinan else if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") 357aefe3786SClaire Weinan { 358aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 359aefe3786SClaire Weinan { 360aefe3786SClaire Weinan if (propertyMap.first == "Size") 361aefe3786SClaire Weinan { 362aefe3786SClaire Weinan const auto* sizePtr = 363aefe3786SClaire Weinan std::get_if<uint64_t>(&propertyMap.second); 364aefe3786SClaire Weinan if (sizePtr == nullptr) 365aefe3786SClaire Weinan { 366aefe3786SClaire Weinan messages::internalError(asyncResp->res); 367aefe3786SClaire Weinan break; 368aefe3786SClaire Weinan } 369aefe3786SClaire Weinan size = *sizePtr; 370aefe3786SClaire Weinan break; 371aefe3786SClaire Weinan } 372aefe3786SClaire Weinan } 373aefe3786SClaire Weinan } 374aefe3786SClaire Weinan else if (interfaceMap.first == "xyz.openbmc_project.Time.EpochTime") 375aefe3786SClaire Weinan { 376aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 377aefe3786SClaire Weinan { 378aefe3786SClaire Weinan if (propertyMap.first == "Elapsed") 379aefe3786SClaire Weinan { 380aefe3786SClaire Weinan const uint64_t* usecsTimeStamp = 381aefe3786SClaire Weinan std::get_if<uint64_t>(&propertyMap.second); 382aefe3786SClaire Weinan if (usecsTimeStamp == nullptr) 383aefe3786SClaire Weinan { 384aefe3786SClaire Weinan messages::internalError(asyncResp->res); 385aefe3786SClaire Weinan break; 386aefe3786SClaire Weinan } 387c21c64b6SClaire Weinan timestamp = (*usecsTimeStamp / 1000 / 1000); 388aefe3786SClaire Weinan break; 389aefe3786SClaire Weinan } 390aefe3786SClaire Weinan } 391aefe3786SClaire Weinan } 392aefe3786SClaire Weinan } 393aefe3786SClaire Weinan } 394aefe3786SClaire Weinan 39521ab404cSNan Zhou static std::string getDumpEntriesPath(const std::string& dumpType) 396fdd26906SClaire Weinan { 397fdd26906SClaire Weinan std::string entriesPath; 398fdd26906SClaire Weinan 399fdd26906SClaire Weinan if (dumpType == "BMC") 400fdd26906SClaire Weinan { 401fdd26906SClaire Weinan entriesPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 402fdd26906SClaire Weinan } 403fdd26906SClaire Weinan else if (dumpType == "FaultLog") 404fdd26906SClaire Weinan { 405fdd26906SClaire Weinan entriesPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/"; 406fdd26906SClaire Weinan } 407fdd26906SClaire Weinan else if (dumpType == "System") 408fdd26906SClaire Weinan { 409fdd26906SClaire Weinan entriesPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 410fdd26906SClaire Weinan } 411fdd26906SClaire Weinan else 412fdd26906SClaire Weinan { 413fdd26906SClaire Weinan BMCWEB_LOG_ERROR << "getDumpEntriesPath() invalid dump type: " 414fdd26906SClaire Weinan << dumpType; 415fdd26906SClaire Weinan } 416fdd26906SClaire Weinan 417fdd26906SClaire Weinan // Returns empty string on error 418fdd26906SClaire Weinan return entriesPath; 419fdd26906SClaire Weinan } 420fdd26906SClaire Weinan 4218d1b46d7Szhanghch05 inline void 4228d1b46d7Szhanghch05 getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 4235cb1dd27SAsmitha Karunanithi const std::string& dumpType) 4245cb1dd27SAsmitha Karunanithi { 425fdd26906SClaire Weinan std::string entriesPath = getDumpEntriesPath(dumpType); 426fdd26906SClaire Weinan if (entriesPath.empty()) 4275cb1dd27SAsmitha Karunanithi { 4285cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4295cb1dd27SAsmitha Karunanithi return; 4305cb1dd27SAsmitha Karunanithi } 4315cb1dd27SAsmitha Karunanithi 4325cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 433fdd26906SClaire Weinan [asyncResp, entriesPath, 434711ac7a9SEd Tanous dumpType](const boost::system::error_code ec, 435711ac7a9SEd Tanous dbus::utility::ManagedObjectType& resp) { 4365cb1dd27SAsmitha Karunanithi if (ec) 4375cb1dd27SAsmitha Karunanithi { 4385cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 4395cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4405cb1dd27SAsmitha Karunanithi return; 4415cb1dd27SAsmitha Karunanithi } 4425cb1dd27SAsmitha Karunanithi 443fdd26906SClaire Weinan // Remove ending slash 444fdd26906SClaire Weinan std::string odataIdStr = entriesPath; 445fdd26906SClaire Weinan if (!odataIdStr.empty()) 446fdd26906SClaire Weinan { 447fdd26906SClaire Weinan odataIdStr.pop_back(); 448fdd26906SClaire Weinan } 449fdd26906SClaire Weinan 450fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.type"] = 451fdd26906SClaire Weinan "#LogEntryCollection.LogEntryCollection"; 452fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = std::move(odataIdStr); 453fdd26906SClaire Weinan asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entries"; 454fdd26906SClaire Weinan asyncResp->res.jsonValue["Description"] = 455fdd26906SClaire Weinan "Collection of " + dumpType + " Dump Entries"; 456fdd26906SClaire Weinan 4575cb1dd27SAsmitha Karunanithi nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"]; 4585cb1dd27SAsmitha Karunanithi entriesArray = nlohmann::json::array(); 459b47452b2SAsmitha Karunanithi std::string dumpEntryPath = 460b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 461002d39b4SEd Tanous std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/"; 4625cb1dd27SAsmitha Karunanithi 463002d39b4SEd Tanous std::sort(resp.begin(), resp.end(), [](const auto& l, const auto& r) { 464002d39b4SEd Tanous return AlphanumLess<std::string>()(l.first.filename(), 465002d39b4SEd Tanous r.first.filename()); 466565dfb6fSClaire Weinan }); 467565dfb6fSClaire Weinan 4685cb1dd27SAsmitha Karunanithi for (auto& object : resp) 4695cb1dd27SAsmitha Karunanithi { 470b47452b2SAsmitha Karunanithi if (object.first.str.find(dumpEntryPath) == std::string::npos) 4715cb1dd27SAsmitha Karunanithi { 4725cb1dd27SAsmitha Karunanithi continue; 4735cb1dd27SAsmitha Karunanithi } 4741d8782e7SNan Zhou uint64_t timestamp = 0; 4755cb1dd27SAsmitha Karunanithi uint64_t size = 0; 47635440d18SAsmitha Karunanithi std::string dumpStatus; 477433b68b4SJason M. Bills nlohmann::json::object_t thisEntry; 4782dfd18efSEd Tanous 4792dfd18efSEd Tanous std::string entryID = object.first.filename(); 4802dfd18efSEd Tanous if (entryID.empty()) 4815cb1dd27SAsmitha Karunanithi { 4825cb1dd27SAsmitha Karunanithi continue; 4835cb1dd27SAsmitha Karunanithi } 4845cb1dd27SAsmitha Karunanithi 485aefe3786SClaire Weinan parseDumpEntryFromDbusObject(object, dumpStatus, size, timestamp, 486aefe3786SClaire Weinan asyncResp); 4875cb1dd27SAsmitha Karunanithi 4880fda0f12SGeorge Liu if (dumpStatus != 4890fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 49035440d18SAsmitha Karunanithi !dumpStatus.empty()) 49135440d18SAsmitha Karunanithi { 49235440d18SAsmitha Karunanithi // Dump status is not Complete, no need to enumerate 49335440d18SAsmitha Karunanithi continue; 49435440d18SAsmitha Karunanithi } 49535440d18SAsmitha Karunanithi 496647b3cdcSGeorge Liu thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 497fdd26906SClaire Weinan thisEntry["@odata.id"] = entriesPath + entryID; 4985cb1dd27SAsmitha Karunanithi thisEntry["Id"] = entryID; 4995cb1dd27SAsmitha Karunanithi thisEntry["EntryType"] = "Event"; 5002b82937eSEd Tanous thisEntry["Created"] = 5012b82937eSEd Tanous redfish::time_utils::getDateTimeUint(timestamp); 5025cb1dd27SAsmitha Karunanithi thisEntry["Name"] = dumpType + " Dump Entry"; 5035cb1dd27SAsmitha Karunanithi 5045cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 5055cb1dd27SAsmitha Karunanithi { 506d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "Manager"; 507d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataURI"] = 508fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 509fdd26906SClaire Weinan thisEntry["AdditionalDataSizeBytes"] = size; 5105cb1dd27SAsmitha Karunanithi } 5115cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 5125cb1dd27SAsmitha Karunanithi { 513d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "OEM"; 514d337bb72SAsmitha Karunanithi thisEntry["OEMDiagnosticDataType"] = "System"; 515d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataURI"] = 516fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 517fdd26906SClaire Weinan thisEntry["AdditionalDataSizeBytes"] = size; 5185cb1dd27SAsmitha Karunanithi } 51935440d18SAsmitha Karunanithi entriesArray.push_back(std::move(thisEntry)); 5205cb1dd27SAsmitha Karunanithi } 521002d39b4SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size(); 5225cb1dd27SAsmitha Karunanithi }, 5235cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 5245cb1dd27SAsmitha Karunanithi "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 5255cb1dd27SAsmitha Karunanithi } 5265cb1dd27SAsmitha Karunanithi 5278d1b46d7Szhanghch05 inline void 528c7a6d660SClaire Weinan getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 5298d1b46d7Szhanghch05 const std::string& entryID, const std::string& dumpType) 5305cb1dd27SAsmitha Karunanithi { 531fdd26906SClaire Weinan std::string entriesPath = getDumpEntriesPath(dumpType); 532fdd26906SClaire Weinan if (entriesPath.empty()) 5335cb1dd27SAsmitha Karunanithi { 5345cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5355cb1dd27SAsmitha Karunanithi return; 5365cb1dd27SAsmitha Karunanithi } 5375cb1dd27SAsmitha Karunanithi 5385cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 539fdd26906SClaire Weinan [asyncResp, entryID, dumpType, 540fdd26906SClaire Weinan entriesPath](const boost::system::error_code ec, 54102cad96eSEd Tanous const dbus::utility::ManagedObjectType& resp) { 5425cb1dd27SAsmitha Karunanithi if (ec) 5435cb1dd27SAsmitha Karunanithi { 5445cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 5455cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5465cb1dd27SAsmitha Karunanithi return; 5475cb1dd27SAsmitha Karunanithi } 5485cb1dd27SAsmitha Karunanithi 549b47452b2SAsmitha Karunanithi bool foundDumpEntry = false; 550b47452b2SAsmitha Karunanithi std::string dumpEntryPath = 551b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 552002d39b4SEd Tanous std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/"; 553b47452b2SAsmitha Karunanithi 5549eb808c1SEd Tanous for (const auto& objectPath : resp) 5555cb1dd27SAsmitha Karunanithi { 556b47452b2SAsmitha Karunanithi if (objectPath.first.str != dumpEntryPath + entryID) 5575cb1dd27SAsmitha Karunanithi { 5585cb1dd27SAsmitha Karunanithi continue; 5595cb1dd27SAsmitha Karunanithi } 5605cb1dd27SAsmitha Karunanithi 5615cb1dd27SAsmitha Karunanithi foundDumpEntry = true; 5621d8782e7SNan Zhou uint64_t timestamp = 0; 5635cb1dd27SAsmitha Karunanithi uint64_t size = 0; 56435440d18SAsmitha Karunanithi std::string dumpStatus; 5655cb1dd27SAsmitha Karunanithi 566aefe3786SClaire Weinan parseDumpEntryFromDbusObject(objectPath, dumpStatus, size, 567aefe3786SClaire Weinan timestamp, asyncResp); 5685cb1dd27SAsmitha Karunanithi 5690fda0f12SGeorge Liu if (dumpStatus != 5700fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 57135440d18SAsmitha Karunanithi !dumpStatus.empty()) 57235440d18SAsmitha Karunanithi { 57335440d18SAsmitha Karunanithi // Dump status is not Complete 57435440d18SAsmitha Karunanithi // return not found until status is changed to Completed 575*d8a5d5d8SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 57635440d18SAsmitha Karunanithi return; 57735440d18SAsmitha Karunanithi } 57835440d18SAsmitha Karunanithi 5795cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 580647b3cdcSGeorge Liu "#LogEntry.v1_8_0.LogEntry"; 581fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = entriesPath + entryID; 5825cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = entryID; 5835cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["EntryType"] = "Event"; 5845cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Created"] = 5852b82937eSEd Tanous redfish::time_utils::getDateTimeUint(timestamp); 5865cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry"; 5875cb1dd27SAsmitha Karunanithi 5885cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 5895cb1dd27SAsmitha Karunanithi { 590d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager"; 591d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 592fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 593fdd26906SClaire Weinan asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 5945cb1dd27SAsmitha Karunanithi } 5955cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 5965cb1dd27SAsmitha Karunanithi { 597d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM"; 598002d39b4SEd Tanous asyncResp->res.jsonValue["OEMDiagnosticDataType"] = "System"; 599d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 600fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 601fdd26906SClaire Weinan asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 6025cb1dd27SAsmitha Karunanithi } 6035cb1dd27SAsmitha Karunanithi } 604e05aec50SEd Tanous if (!foundDumpEntry) 605b47452b2SAsmitha Karunanithi { 606b47452b2SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Can't find Dump Entry"; 607b47452b2SAsmitha Karunanithi messages::internalError(asyncResp->res); 608b47452b2SAsmitha Karunanithi return; 609b47452b2SAsmitha Karunanithi } 6105cb1dd27SAsmitha Karunanithi }, 6115cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 6125cb1dd27SAsmitha Karunanithi "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 6135cb1dd27SAsmitha Karunanithi } 6145cb1dd27SAsmitha Karunanithi 6158d1b46d7Szhanghch05 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 6169878256fSStanley Chu const std::string& entryID, 617b47452b2SAsmitha Karunanithi const std::string& dumpType) 6185cb1dd27SAsmitha Karunanithi { 619002d39b4SEd Tanous auto respHandler = 620002d39b4SEd Tanous [asyncResp, entryID](const boost::system::error_code ec) { 6215cb1dd27SAsmitha Karunanithi BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done"; 6225cb1dd27SAsmitha Karunanithi if (ec) 6235cb1dd27SAsmitha Karunanithi { 6243de8d8baSGeorge Liu if (ec.value() == EBADR) 6253de8d8baSGeorge Liu { 6263de8d8baSGeorge Liu messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 6273de8d8baSGeorge Liu return; 6283de8d8baSGeorge Liu } 6295cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error " 630fdd26906SClaire Weinan << ec << " entryID=" << entryID; 6315cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6325cb1dd27SAsmitha Karunanithi return; 6335cb1dd27SAsmitha Karunanithi } 6345cb1dd27SAsmitha Karunanithi }; 6355cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 6365cb1dd27SAsmitha Karunanithi respHandler, "xyz.openbmc_project.Dump.Manager", 637b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 638b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/" + 639b47452b2SAsmitha Karunanithi entryID, 6405cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Object.Delete", "Delete"); 6415cb1dd27SAsmitha Karunanithi } 6425cb1dd27SAsmitha Karunanithi 6438d1b46d7Szhanghch05 inline void 64498be3e39SEd Tanous createDumpTaskCallback(task::Payload&& payload, 6458d1b46d7Szhanghch05 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 6468d1b46d7Szhanghch05 const uint32_t& dumpId, const std::string& dumpPath, 647a43be80fSAsmitha Karunanithi const std::string& dumpType) 648a43be80fSAsmitha Karunanithi { 649a43be80fSAsmitha Karunanithi std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 65059d494eeSPatrick Williams [dumpId, dumpPath, 65159d494eeSPatrick Williams dumpType](boost::system::error_code err, sdbusplus::message_t& m, 652a43be80fSAsmitha Karunanithi const std::shared_ptr<task::TaskData>& taskData) { 653cb13a392SEd Tanous if (err) 654cb13a392SEd Tanous { 6556145ed6fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Error in creating a dump"; 6566145ed6fSAsmitha Karunanithi taskData->state = "Cancelled"; 6576145ed6fSAsmitha Karunanithi return task::completed; 658cb13a392SEd Tanous } 659b9d36b47SEd Tanous 660b9d36b47SEd Tanous dbus::utility::DBusInteracesMap interfacesList; 661a43be80fSAsmitha Karunanithi 662a43be80fSAsmitha Karunanithi sdbusplus::message::object_path objPath; 663a43be80fSAsmitha Karunanithi 664a43be80fSAsmitha Karunanithi m.read(objPath, interfacesList); 665a43be80fSAsmitha Karunanithi 666b47452b2SAsmitha Karunanithi if (objPath.str == 667b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 668b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)) + 669b47452b2SAsmitha Karunanithi "/entry/" + std::to_string(dumpId)) 670a43be80fSAsmitha Karunanithi { 671a43be80fSAsmitha Karunanithi nlohmann::json retMessage = messages::success(); 672a43be80fSAsmitha Karunanithi taskData->messages.emplace_back(retMessage); 673a43be80fSAsmitha Karunanithi 674a43be80fSAsmitha Karunanithi std::string headerLoc = 675a43be80fSAsmitha Karunanithi "Location: " + dumpPath + std::to_string(dumpId); 676002d39b4SEd Tanous taskData->payload->httpHeaders.emplace_back(std::move(headerLoc)); 677a43be80fSAsmitha Karunanithi 678a43be80fSAsmitha Karunanithi taskData->state = "Completed"; 679b47452b2SAsmitha Karunanithi return task::completed; 6806145ed6fSAsmitha Karunanithi } 681a43be80fSAsmitha Karunanithi return task::completed; 682a43be80fSAsmitha Karunanithi }, 6834978b63fSJason M. Bills "type='signal',interface='org.freedesktop.DBus.ObjectManager'," 684a43be80fSAsmitha Karunanithi "member='InterfacesAdded', " 685a43be80fSAsmitha Karunanithi "path='/xyz/openbmc_project/dump'"); 686a43be80fSAsmitha Karunanithi 687a43be80fSAsmitha Karunanithi task->startTimer(std::chrono::minutes(3)); 688a43be80fSAsmitha Karunanithi task->populateResp(asyncResp->res); 68998be3e39SEd Tanous task->payload.emplace(std::move(payload)); 690a43be80fSAsmitha Karunanithi } 691a43be80fSAsmitha Karunanithi 6928d1b46d7Szhanghch05 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 6938d1b46d7Szhanghch05 const crow::Request& req, const std::string& dumpType) 694a43be80fSAsmitha Karunanithi { 695fdd26906SClaire Weinan std::string dumpPath = getDumpEntriesPath(dumpType); 696fdd26906SClaire Weinan if (dumpPath.empty()) 697a43be80fSAsmitha Karunanithi { 698a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 699a43be80fSAsmitha Karunanithi return; 700a43be80fSAsmitha Karunanithi } 701a43be80fSAsmitha Karunanithi 702a43be80fSAsmitha Karunanithi std::optional<std::string> diagnosticDataType; 703a43be80fSAsmitha Karunanithi std::optional<std::string> oemDiagnosticDataType; 704a43be80fSAsmitha Karunanithi 70515ed6780SWilly Tu if (!redfish::json_util::readJsonAction( 706a43be80fSAsmitha Karunanithi req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 707a43be80fSAsmitha Karunanithi "OEMDiagnosticDataType", oemDiagnosticDataType)) 708a43be80fSAsmitha Karunanithi { 709a43be80fSAsmitha Karunanithi return; 710a43be80fSAsmitha Karunanithi } 711a43be80fSAsmitha Karunanithi 712a43be80fSAsmitha Karunanithi if (dumpType == "System") 713a43be80fSAsmitha Karunanithi { 714a43be80fSAsmitha Karunanithi if (!oemDiagnosticDataType || !diagnosticDataType) 715a43be80fSAsmitha Karunanithi { 7164978b63fSJason M. Bills BMCWEB_LOG_ERROR 7174978b63fSJason M. Bills << "CreateDump action parameter 'DiagnosticDataType'/'OEMDiagnosticDataType' value not found!"; 718a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 719a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", 720a43be80fSAsmitha Karunanithi "DiagnosticDataType & OEMDiagnosticDataType"); 721a43be80fSAsmitha Karunanithi return; 722a43be80fSAsmitha Karunanithi } 7233174e4dfSEd Tanous if ((*oemDiagnosticDataType != "System") || 724a43be80fSAsmitha Karunanithi (*diagnosticDataType != "OEM")) 725a43be80fSAsmitha Karunanithi { 726a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Wrong parameter values passed"; 727ace85d60SEd Tanous messages::internalError(asyncResp->res); 728a43be80fSAsmitha Karunanithi return; 729a43be80fSAsmitha Karunanithi } 7305907571dSAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/"; 731a43be80fSAsmitha Karunanithi } 732a43be80fSAsmitha Karunanithi else if (dumpType == "BMC") 733a43be80fSAsmitha Karunanithi { 734a43be80fSAsmitha Karunanithi if (!diagnosticDataType) 735a43be80fSAsmitha Karunanithi { 7360fda0f12SGeorge Liu BMCWEB_LOG_ERROR 7370fda0f12SGeorge Liu << "CreateDump action parameter 'DiagnosticDataType' not found!"; 738a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 739a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType"); 740a43be80fSAsmitha Karunanithi return; 741a43be80fSAsmitha Karunanithi } 7423174e4dfSEd Tanous if (*diagnosticDataType != "Manager") 743a43be80fSAsmitha Karunanithi { 744a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR 745a43be80fSAsmitha Karunanithi << "Wrong parameter value passed for 'DiagnosticDataType'"; 746ace85d60SEd Tanous messages::internalError(asyncResp->res); 747a43be80fSAsmitha Karunanithi return; 748a43be80fSAsmitha Karunanithi } 7495907571dSAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/"; 7505907571dSAsmitha Karunanithi } 7515907571dSAsmitha Karunanithi else 7525907571dSAsmitha Karunanithi { 7535907571dSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump failed. Unknown dump type"; 7545907571dSAsmitha Karunanithi messages::internalError(asyncResp->res); 7555907571dSAsmitha Karunanithi return; 756a43be80fSAsmitha Karunanithi } 757a43be80fSAsmitha Karunanithi 758a43be80fSAsmitha Karunanithi crow::connections::systemBus->async_method_call( 75998be3e39SEd Tanous [asyncResp, payload(task::Payload(req)), dumpPath, 76098be3e39SEd Tanous dumpType](const boost::system::error_code ec, 7615907571dSAsmitha Karunanithi const sdbusplus::message::message& msg, 76298be3e39SEd Tanous const uint32_t& dumpId) mutable { 763a43be80fSAsmitha Karunanithi if (ec) 764a43be80fSAsmitha Karunanithi { 765a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec; 7665907571dSAsmitha Karunanithi const sd_bus_error* dbusError = msg.get_error(); 7675907571dSAsmitha Karunanithi if (dbusError == nullptr) 7685907571dSAsmitha Karunanithi { 7695907571dSAsmitha Karunanithi messages::internalError(asyncResp->res); 7705907571dSAsmitha Karunanithi return; 7715907571dSAsmitha Karunanithi } 7725907571dSAsmitha Karunanithi 7735907571dSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump DBus error: " << dbusError->name 7745907571dSAsmitha Karunanithi << " and error msg: " << dbusError->message; 7755907571dSAsmitha Karunanithi if (std::string_view( 7765907571dSAsmitha Karunanithi "xyz.openbmc_project.Common.Error.NotAllowed") == 7775907571dSAsmitha Karunanithi dbusError->name) 7785907571dSAsmitha Karunanithi { 7795907571dSAsmitha Karunanithi messages::resourceInStandby(asyncResp->res); 7805907571dSAsmitha Karunanithi return; 7815907571dSAsmitha Karunanithi } 7825907571dSAsmitha Karunanithi if (std::string_view( 7835907571dSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create.Error.Disabled") == 7845907571dSAsmitha Karunanithi dbusError->name) 7855907571dSAsmitha Karunanithi { 7865907571dSAsmitha Karunanithi messages::serviceDisabled(asyncResp->res, dumpPath); 7875907571dSAsmitha Karunanithi return; 7885907571dSAsmitha Karunanithi } 7895907571dSAsmitha Karunanithi if (std::string_view( 7905907571dSAsmitha Karunanithi "xyz.openbmc_project.Common.Error.Unavailable") == 7915907571dSAsmitha Karunanithi dbusError->name) 7925907571dSAsmitha Karunanithi { 7935907571dSAsmitha Karunanithi messages::resourceInUse(asyncResp->res); 7945907571dSAsmitha Karunanithi return; 7955907571dSAsmitha Karunanithi } 7965907571dSAsmitha Karunanithi // Other Dbus errors such as: 7975907571dSAsmitha Karunanithi // xyz.openbmc_project.Common.Error.InvalidArgument & 7985907571dSAsmitha Karunanithi // org.freedesktop.DBus.Error.InvalidArgs are all related to 7995907571dSAsmitha Karunanithi // the dbus call that is made here in the bmcweb 8005907571dSAsmitha Karunanithi // implementation and has nothing to do with the client's 8015907571dSAsmitha Karunanithi // input in the request. Hence, returning internal error 8025907571dSAsmitha Karunanithi // back to the client. 803a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 804a43be80fSAsmitha Karunanithi return; 805a43be80fSAsmitha Karunanithi } 806a43be80fSAsmitha Karunanithi BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId; 807a43be80fSAsmitha Karunanithi 808002d39b4SEd Tanous createDumpTaskCallback(std::move(payload), asyncResp, dumpId, dumpPath, 809002d39b4SEd Tanous dumpType); 810a43be80fSAsmitha Karunanithi }, 811b47452b2SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", 812b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 813b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)), 814a43be80fSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create", "CreateDump"); 815a43be80fSAsmitha Karunanithi } 816a43be80fSAsmitha Karunanithi 8178d1b46d7Szhanghch05 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 8188d1b46d7Szhanghch05 const std::string& dumpType) 81980319af1SAsmitha Karunanithi { 820b47452b2SAsmitha Karunanithi std::string dumpTypeLowerCopy = 821b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)); 8228d1b46d7Szhanghch05 82380319af1SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 824b9d36b47SEd Tanous [asyncResp, dumpType]( 825b9d36b47SEd Tanous const boost::system::error_code ec, 826b9d36b47SEd Tanous const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 82780319af1SAsmitha Karunanithi if (ec) 82880319af1SAsmitha Karunanithi { 82980319af1SAsmitha Karunanithi BMCWEB_LOG_ERROR << "resp_handler got error " << ec; 83080319af1SAsmitha Karunanithi messages::internalError(asyncResp->res); 83180319af1SAsmitha Karunanithi return; 83280319af1SAsmitha Karunanithi } 83380319af1SAsmitha Karunanithi 83480319af1SAsmitha Karunanithi for (const std::string& path : subTreePaths) 83580319af1SAsmitha Karunanithi { 8362dfd18efSEd Tanous sdbusplus::message::object_path objPath(path); 8372dfd18efSEd Tanous std::string logID = objPath.filename(); 8382dfd18efSEd Tanous if (logID.empty()) 83980319af1SAsmitha Karunanithi { 8402dfd18efSEd Tanous continue; 84180319af1SAsmitha Karunanithi } 8422dfd18efSEd Tanous deleteDumpEntry(asyncResp, logID, dumpType); 84380319af1SAsmitha Karunanithi } 84480319af1SAsmitha Karunanithi }, 84580319af1SAsmitha Karunanithi "xyz.openbmc_project.ObjectMapper", 84680319af1SAsmitha Karunanithi "/xyz/openbmc_project/object_mapper", 84780319af1SAsmitha Karunanithi "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 848b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + dumpTypeLowerCopy, 0, 849b47452b2SAsmitha Karunanithi std::array<std::string, 1>{"xyz.openbmc_project.Dump.Entry." + 850b47452b2SAsmitha Karunanithi dumpType}); 85180319af1SAsmitha Karunanithi } 85280319af1SAsmitha Karunanithi 853b9d36b47SEd Tanous inline static void 854b9d36b47SEd Tanous parseCrashdumpParameters(const dbus::utility::DBusPropertiesMap& params, 855b9d36b47SEd Tanous std::string& filename, std::string& timestamp, 856b9d36b47SEd Tanous std::string& logfile) 857043a0536SJohnathan Mantey { 858043a0536SJohnathan Mantey for (auto property : params) 859043a0536SJohnathan Mantey { 860043a0536SJohnathan Mantey if (property.first == "Timestamp") 861043a0536SJohnathan Mantey { 862043a0536SJohnathan Mantey const std::string* value = 8638d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 864043a0536SJohnathan Mantey if (value != nullptr) 865043a0536SJohnathan Mantey { 866043a0536SJohnathan Mantey timestamp = *value; 867043a0536SJohnathan Mantey } 868043a0536SJohnathan Mantey } 869043a0536SJohnathan Mantey else if (property.first == "Filename") 870043a0536SJohnathan Mantey { 871043a0536SJohnathan Mantey const std::string* value = 8728d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 873043a0536SJohnathan Mantey if (value != nullptr) 874043a0536SJohnathan Mantey { 875043a0536SJohnathan Mantey filename = *value; 876043a0536SJohnathan Mantey } 877043a0536SJohnathan Mantey } 878043a0536SJohnathan Mantey else if (property.first == "Log") 879043a0536SJohnathan Mantey { 880043a0536SJohnathan Mantey const std::string* value = 8818d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 882043a0536SJohnathan Mantey if (value != nullptr) 883043a0536SJohnathan Mantey { 884043a0536SJohnathan Mantey logfile = *value; 885043a0536SJohnathan Mantey } 886043a0536SJohnathan Mantey } 887043a0536SJohnathan Mantey } 888043a0536SJohnathan Mantey } 889043a0536SJohnathan Mantey 890a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode"; 8917e860f15SJohn Edward Broadbent inline void requestRoutesSystemLogServiceCollection(App& app) 8921da66f75SEd Tanous { 893c4bf6374SJason M. Bills /** 894c4bf6374SJason M. Bills * Functions triggers appropriate requests on DBus 895c4bf6374SJason M. Bills */ 8967e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/") 897ed398213SEd Tanous .privileges(redfish::privileges::getLogServiceCollection) 898002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 899002d39b4SEd Tanous [&app](const crow::Request& req, 900002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 9013ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 902c4bf6374SJason M. Bills { 90345ca1b86SEd Tanous return; 90445ca1b86SEd Tanous } 9057e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 9067e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 907c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 908c4bf6374SJason M. Bills "#LogServiceCollection.LogServiceCollection"; 909c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 910029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices"; 91145ca1b86SEd Tanous asyncResp->res.jsonValue["Name"] = "System Log Services Collection"; 912c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 913c4bf6374SJason M. Bills "Collection of LogServices for this Computer System"; 914002d39b4SEd Tanous nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 915c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 9161476687dSEd Tanous nlohmann::json::object_t eventLog; 9171476687dSEd Tanous eventLog["@odata.id"] = 9181476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 9191476687dSEd Tanous logServiceArray.push_back(std::move(eventLog)); 9205cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 9211476687dSEd Tanous nlohmann::json::object_t dumpLog; 922002d39b4SEd Tanous dumpLog["@odata.id"] = "/redfish/v1/Systems/system/LogServices/Dump"; 9231476687dSEd Tanous logServiceArray.push_back(std::move(dumpLog)); 924c9bb6861Sraviteja-b #endif 925c9bb6861Sraviteja-b 926d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG 9271476687dSEd Tanous nlohmann::json::object_t crashdump; 9281476687dSEd Tanous crashdump["@odata.id"] = 9291476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump"; 9301476687dSEd Tanous logServiceArray.push_back(std::move(crashdump)); 931d53dd41fSJason M. Bills #endif 932b7028ebfSSpencer Ku 933b7028ebfSSpencer Ku #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER 9341476687dSEd Tanous nlohmann::json::object_t hostlogger; 9351476687dSEd Tanous hostlogger["@odata.id"] = 9361476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger"; 9371476687dSEd Tanous logServiceArray.push_back(std::move(hostlogger)); 938b7028ebfSSpencer Ku #endif 939c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 940c4bf6374SJason M. Bills logServiceArray.size(); 941a3316fc6SZhikuiRen 942a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 94345ca1b86SEd Tanous [asyncResp](const boost::system::error_code ec, 944b9d36b47SEd Tanous const dbus::utility::MapperGetSubTreePathsResponse& 945b9d36b47SEd Tanous subtreePath) { 946a3316fc6SZhikuiRen if (ec) 947a3316fc6SZhikuiRen { 948a3316fc6SZhikuiRen BMCWEB_LOG_ERROR << ec; 949a3316fc6SZhikuiRen return; 950a3316fc6SZhikuiRen } 951a3316fc6SZhikuiRen 95255f79e6fSEd Tanous for (const auto& pathStr : subtreePath) 953a3316fc6SZhikuiRen { 954a3316fc6SZhikuiRen if (pathStr.find("PostCode") != std::string::npos) 955a3316fc6SZhikuiRen { 95623a21a1cSEd Tanous nlohmann::json& logServiceArrayLocal = 957a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"]; 95823a21a1cSEd Tanous logServiceArrayLocal.push_back( 9590fda0f12SGeorge Liu {{"@odata.id", 9600fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes"}}); 96145ca1b86SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = 96223a21a1cSEd Tanous logServiceArrayLocal.size(); 963a3316fc6SZhikuiRen return; 964a3316fc6SZhikuiRen } 965a3316fc6SZhikuiRen } 966a3316fc6SZhikuiRen }, 967a3316fc6SZhikuiRen "xyz.openbmc_project.ObjectMapper", 968a3316fc6SZhikuiRen "/xyz/openbmc_project/object_mapper", 96945ca1b86SEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 0, 97045ca1b86SEd Tanous std::array<const char*, 1>{postCodeIface}); 9717e860f15SJohn Edward Broadbent }); 972c4bf6374SJason M. Bills } 973c4bf6374SJason M. Bills 9747e860f15SJohn Edward Broadbent inline void requestRoutesEventLogService(App& app) 975c4bf6374SJason M. Bills { 9767e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/") 977ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 978002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 979002d39b4SEd Tanous [&app](const crow::Request& req, 980002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 9813ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 98245ca1b86SEd Tanous { 98345ca1b86SEd Tanous return; 98445ca1b86SEd Tanous } 985c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 986029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 987c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 988c4bf6374SJason M. Bills "#LogService.v1_1_0.LogService"; 989c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "Event Log Service"; 990002d39b4SEd Tanous asyncResp->res.jsonValue["Description"] = "System Event Log Service"; 991c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "EventLog"; 992c4bf6374SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 9937c8c4058STejas Patil 9947c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 9952b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 9967c8c4058STejas Patil 9977c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 9987c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 9997c8c4058STejas Patil redfishDateTimeOffset.second; 10007c8c4058STejas Patil 10011476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 10021476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1003e7d6c8b2SGunnar Mills asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 1004e7d6c8b2SGunnar Mills 10050fda0f12SGeorge Liu {"target", 10060fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog"}}; 10077e860f15SJohn Edward Broadbent }); 1008489640c6SJason M. Bills } 1009489640c6SJason M. Bills 10107e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogClear(App& app) 1011489640c6SJason M. Bills { 10124978b63fSJason M. Bills BMCWEB_ROUTE( 10134978b63fSJason M. Bills app, 10144978b63fSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog/") 1015432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 10167e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 101745ca1b86SEd Tanous [&app](const crow::Request& req, 10187e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 10193ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 102045ca1b86SEd Tanous { 102145ca1b86SEd Tanous return; 102245ca1b86SEd Tanous } 1023489640c6SJason M. Bills // Clear the EventLog by deleting the log files 1024489640c6SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1025489640c6SJason M. Bills if (getRedfishLogFiles(redfishLogFiles)) 1026489640c6SJason M. Bills { 1027489640c6SJason M. Bills for (const std::filesystem::path& file : redfishLogFiles) 1028489640c6SJason M. Bills { 1029489640c6SJason M. Bills std::error_code ec; 1030489640c6SJason M. Bills std::filesystem::remove(file, ec); 1031489640c6SJason M. Bills } 1032489640c6SJason M. Bills } 1033489640c6SJason M. Bills 1034489640c6SJason M. Bills // Reload rsyslog so it knows to start new log files 1035489640c6SJason M. Bills crow::connections::systemBus->async_method_call( 1036489640c6SJason M. Bills [asyncResp](const boost::system::error_code ec) { 1037489640c6SJason M. Bills if (ec) 1038489640c6SJason M. Bills { 1039002d39b4SEd Tanous BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec; 1040489640c6SJason M. Bills messages::internalError(asyncResp->res); 1041489640c6SJason M. Bills return; 1042489640c6SJason M. Bills } 1043489640c6SJason M. Bills 1044489640c6SJason M. Bills messages::success(asyncResp->res); 1045489640c6SJason M. Bills }, 1046489640c6SJason M. Bills "org.freedesktop.systemd1", "/org/freedesktop/systemd1", 1047002d39b4SEd Tanous "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service", 1048002d39b4SEd Tanous "replace"); 10497e860f15SJohn Edward Broadbent }); 1050c4bf6374SJason M. Bills } 1051c4bf6374SJason M. Bills 1052ac992cdeSJason M. Bills enum class LogParseError 1053ac992cdeSJason M. Bills { 1054ac992cdeSJason M. Bills success, 1055ac992cdeSJason M. Bills parseFailed, 1056ac992cdeSJason M. Bills messageIdNotInRegistry, 1057ac992cdeSJason M. Bills }; 1058ac992cdeSJason M. Bills 1059ac992cdeSJason M. Bills static LogParseError 1060ac992cdeSJason M. Bills fillEventLogEntryJson(const std::string& logEntryID, 1061b5a76932SEd Tanous const std::string& logEntry, 1062de703c5dSJason M. Bills nlohmann::json::object_t& logEntryJson) 1063c4bf6374SJason M. Bills { 106495820184SJason M. Bills // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1065cd225da8SJason M. Bills // First get the Timestamp 1066f23b7296SEd Tanous size_t space = logEntry.find_first_of(' '); 1067cd225da8SJason M. Bills if (space == std::string::npos) 106895820184SJason M. Bills { 1069ac992cdeSJason M. Bills return LogParseError::parseFailed; 107095820184SJason M. Bills } 1071cd225da8SJason M. Bills std::string timestamp = logEntry.substr(0, space); 1072cd225da8SJason M. Bills // Then get the log contents 1073f23b7296SEd Tanous size_t entryStart = logEntry.find_first_not_of(' ', space); 1074cd225da8SJason M. Bills if (entryStart == std::string::npos) 1075cd225da8SJason M. Bills { 1076ac992cdeSJason M. Bills return LogParseError::parseFailed; 1077cd225da8SJason M. Bills } 1078cd225da8SJason M. Bills std::string_view entry(logEntry); 1079cd225da8SJason M. Bills entry.remove_prefix(entryStart); 1080cd225da8SJason M. Bills // Use split to separate the entry into its fields 1081cd225da8SJason M. Bills std::vector<std::string> logEntryFields; 1082cd225da8SJason M. Bills boost::split(logEntryFields, entry, boost::is_any_of(","), 1083cd225da8SJason M. Bills boost::token_compress_on); 1084cd225da8SJason M. Bills // We need at least a MessageId to be valid 108526f6976fSEd Tanous if (logEntryFields.empty()) 1086cd225da8SJason M. Bills { 1087ac992cdeSJason M. Bills return LogParseError::parseFailed; 1088cd225da8SJason M. Bills } 1089cd225da8SJason M. Bills std::string& messageID = logEntryFields[0]; 109095820184SJason M. Bills 10914851d45dSJason M. Bills // Get the Message from the MessageRegistry 1092fffb8c1fSEd Tanous const registries::Message* message = registries::getMessage(messageID); 1093c4bf6374SJason M. Bills 109454417b02SSui Chen if (message == nullptr) 1095c4bf6374SJason M. Bills { 109654417b02SSui Chen BMCWEB_LOG_WARNING << "Log entry not found in registry: " << logEntry; 1097ac992cdeSJason M. Bills return LogParseError::messageIdNotInRegistry; 1098c4bf6374SJason M. Bills } 1099c4bf6374SJason M. Bills 110054417b02SSui Chen std::string msg = message->message; 110154417b02SSui Chen 110215a86ff6SJason M. Bills // Get the MessageArgs from the log if there are any 110326702d01SEd Tanous std::span<std::string> messageArgs; 110415a86ff6SJason M. Bills if (logEntryFields.size() > 1) 110515a86ff6SJason M. Bills { 110615a86ff6SJason M. Bills std::string& messageArgsStart = logEntryFields[1]; 110715a86ff6SJason M. Bills // If the first string is empty, assume there are no MessageArgs 110815a86ff6SJason M. Bills std::size_t messageArgsSize = 0; 110915a86ff6SJason M. Bills if (!messageArgsStart.empty()) 111015a86ff6SJason M. Bills { 111115a86ff6SJason M. Bills messageArgsSize = logEntryFields.size() - 1; 111215a86ff6SJason M. Bills } 111315a86ff6SJason M. Bills 111423a21a1cSEd Tanous messageArgs = {&messageArgsStart, messageArgsSize}; 1115c4bf6374SJason M. Bills 11164851d45dSJason M. Bills // Fill the MessageArgs into the Message 111795820184SJason M. Bills int i = 0; 111895820184SJason M. Bills for (const std::string& messageArg : messageArgs) 11194851d45dSJason M. Bills { 112095820184SJason M. Bills std::string argStr = "%" + std::to_string(++i); 11214851d45dSJason M. Bills size_t argPos = msg.find(argStr); 11224851d45dSJason M. Bills if (argPos != std::string::npos) 11234851d45dSJason M. Bills { 112495820184SJason M. Bills msg.replace(argPos, argStr.length(), messageArg); 11254851d45dSJason M. Bills } 11264851d45dSJason M. Bills } 112715a86ff6SJason M. Bills } 11284851d45dSJason M. Bills 112995820184SJason M. Bills // Get the Created time from the timestamp. The log timestamp is in RFC3339 113095820184SJason M. Bills // format which matches the Redfish format except for the fractional seconds 113195820184SJason M. Bills // between the '.' and the '+', so just remove them. 1132f23b7296SEd Tanous std::size_t dot = timestamp.find_first_of('.'); 1133f23b7296SEd Tanous std::size_t plus = timestamp.find_first_of('+'); 113495820184SJason M. Bills if (dot != std::string::npos && plus != std::string::npos) 1135c4bf6374SJason M. Bills { 113695820184SJason M. Bills timestamp.erase(dot, plus - dot); 1137c4bf6374SJason M. Bills } 1138c4bf6374SJason M. Bills 1139c4bf6374SJason M. Bills // Fill in the log entry with the gathered data 114084afc48bSJason M. Bills logEntryJson["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 114184afc48bSJason M. Bills logEntryJson["@odata.id"] = 114284afc48bSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + logEntryID; 114384afc48bSJason M. Bills logEntryJson["Name"] = "System Event Log Entry"; 114484afc48bSJason M. Bills logEntryJson["Id"] = logEntryID; 114584afc48bSJason M. Bills logEntryJson["Message"] = std::move(msg); 114684afc48bSJason M. Bills logEntryJson["MessageId"] = std::move(messageID); 114784afc48bSJason M. Bills logEntryJson["MessageArgs"] = messageArgs; 114884afc48bSJason M. Bills logEntryJson["EntryType"] = "Event"; 114984afc48bSJason M. Bills logEntryJson["Severity"] = message->messageSeverity; 115084afc48bSJason M. Bills logEntryJson["Created"] = std::move(timestamp); 1151ac992cdeSJason M. Bills return LogParseError::success; 1152c4bf6374SJason M. Bills } 1153c4bf6374SJason M. Bills 11547e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntryCollection(App& app) 1155c4bf6374SJason M. Bills { 11567e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 11577e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") 11588b6a35f0SGunnar Mills .privileges(redfish::privileges::getLogEntryCollection) 1159002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1160002d39b4SEd Tanous [&app](const crow::Request& req, 1161002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1162c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 1163c937d2bfSEd Tanous .canDelegateTop = true, 1164c937d2bfSEd Tanous .canDelegateSkip = true, 1165c937d2bfSEd Tanous }; 1166c937d2bfSEd Tanous query_param::Query delegatedQuery; 1167c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 11683ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 1169c4bf6374SJason M. Bills { 1170c4bf6374SJason M. Bills return; 1171c4bf6374SJason M. Bills } 11725143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 11733648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 11743648c8beSEd Tanous 11757e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 11767e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1177c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1178c4bf6374SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 1179c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1180029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1181c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 1182c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 1183c4bf6374SJason M. Bills "Collection of System Event Log Entries"; 1184cb92c03bSAndrew Geissler 11854978b63fSJason M. Bills nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1186c4bf6374SJason M. Bills logEntryArray = nlohmann::json::array(); 11877e860f15SJohn Edward Broadbent // Go through the log files and create a unique ID for each 11887e860f15SJohn Edward Broadbent // entry 118995820184SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 119095820184SJason M. Bills getRedfishLogFiles(redfishLogFiles); 1191b01bf299SEd Tanous uint64_t entryCount = 0; 1192cd225da8SJason M. Bills std::string logEntry; 119395820184SJason M. Bills 11947e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 11957e860f15SJohn Edward Broadbent // backwards 1196002d39b4SEd Tanous for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1197002d39b4SEd Tanous it++) 1198c4bf6374SJason M. Bills { 1199cd225da8SJason M. Bills std::ifstream logStream(*it); 120095820184SJason M. Bills if (!logStream.is_open()) 1201c4bf6374SJason M. Bills { 1202c4bf6374SJason M. Bills continue; 1203c4bf6374SJason M. Bills } 1204c4bf6374SJason M. Bills 1205e85d6b16SJason M. Bills // Reset the unique ID on the first entry 1206e85d6b16SJason M. Bills bool firstEntry = true; 120795820184SJason M. Bills while (std::getline(logStream, logEntry)) 120895820184SJason M. Bills { 1209c4bf6374SJason M. Bills std::string idStr; 1210e85d6b16SJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1211c4bf6374SJason M. Bills { 1212c4bf6374SJason M. Bills continue; 1213c4bf6374SJason M. Bills } 1214e85d6b16SJason M. Bills firstEntry = false; 1215e85d6b16SJason M. Bills 1216de703c5dSJason M. Bills nlohmann::json::object_t bmcLogEntry; 1217ac992cdeSJason M. Bills LogParseError status = 1218ac992cdeSJason M. Bills fillEventLogEntryJson(idStr, logEntry, bmcLogEntry); 1219ac992cdeSJason M. Bills if (status == LogParseError::messageIdNotInRegistry) 1220ac992cdeSJason M. Bills { 1221ac992cdeSJason M. Bills continue; 1222ac992cdeSJason M. Bills } 1223ac992cdeSJason M. Bills if (status != LogParseError::success) 1224c4bf6374SJason M. Bills { 1225c4bf6374SJason M. Bills messages::internalError(asyncResp->res); 1226c4bf6374SJason M. Bills return; 1227c4bf6374SJason M. Bills } 1228de703c5dSJason M. Bills 1229de703c5dSJason M. Bills entryCount++; 1230de703c5dSJason M. Bills // Handle paging using skip (number of entries to skip from the 1231de703c5dSJason M. Bills // start) and top (number of entries to display) 12323648c8beSEd Tanous if (entryCount <= skip || entryCount > skip + top) 1233de703c5dSJason M. Bills { 1234de703c5dSJason M. Bills continue; 1235de703c5dSJason M. Bills } 1236de703c5dSJason M. Bills 1237de703c5dSJason M. Bills logEntryArray.push_back(std::move(bmcLogEntry)); 1238c4bf6374SJason M. Bills } 123995820184SJason M. Bills } 1240c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 12413648c8beSEd Tanous if (skip + top < entryCount) 1242c4bf6374SJason M. Bills { 1243c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 12444978b63fSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries?$skip=" + 12453648c8beSEd Tanous std::to_string(skip + top); 1246c4bf6374SJason M. Bills } 12477e860f15SJohn Edward Broadbent }); 1248897967deSJason M. Bills } 1249897967deSJason M. Bills 12507e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntry(App& app) 1251897967deSJason M. Bills { 12527e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 12537e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1254ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 12557e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 125645ca1b86SEd Tanous [&app](const crow::Request& req, 12577e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 12587e860f15SJohn Edward Broadbent const std::string& param) { 12593ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 126045ca1b86SEd Tanous { 126145ca1b86SEd Tanous return; 126245ca1b86SEd Tanous } 12637e860f15SJohn Edward Broadbent const std::string& targetID = param; 12648d1b46d7Szhanghch05 12657e860f15SJohn Edward Broadbent // Go through the log files and check the unique ID for each 12667e860f15SJohn Edward Broadbent // entry to find the target entry 1267897967deSJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1268897967deSJason M. Bills getRedfishLogFiles(redfishLogFiles); 1269897967deSJason M. Bills std::string logEntry; 1270897967deSJason M. Bills 12717e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 12727e860f15SJohn Edward Broadbent // backwards 1273002d39b4SEd Tanous for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1274002d39b4SEd Tanous it++) 1275897967deSJason M. Bills { 1276897967deSJason M. Bills std::ifstream logStream(*it); 1277897967deSJason M. Bills if (!logStream.is_open()) 1278897967deSJason M. Bills { 1279897967deSJason M. Bills continue; 1280897967deSJason M. Bills } 1281897967deSJason M. Bills 1282897967deSJason M. Bills // Reset the unique ID on the first entry 1283897967deSJason M. Bills bool firstEntry = true; 1284897967deSJason M. Bills while (std::getline(logStream, logEntry)) 1285897967deSJason M. Bills { 1286897967deSJason M. Bills std::string idStr; 1287897967deSJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1288897967deSJason M. Bills { 1289897967deSJason M. Bills continue; 1290897967deSJason M. Bills } 1291897967deSJason M. Bills firstEntry = false; 1292897967deSJason M. Bills 1293897967deSJason M. Bills if (idStr == targetID) 1294897967deSJason M. Bills { 1295de703c5dSJason M. Bills nlohmann::json::object_t bmcLogEntry; 1296ac992cdeSJason M. Bills LogParseError status = 1297ac992cdeSJason M. Bills fillEventLogEntryJson(idStr, logEntry, bmcLogEntry); 1298ac992cdeSJason M. Bills if (status != LogParseError::success) 1299897967deSJason M. Bills { 1300897967deSJason M. Bills messages::internalError(asyncResp->res); 1301897967deSJason M. Bills return; 1302897967deSJason M. Bills } 1303d405bb51SJason M. Bills asyncResp->res.jsonValue.update(bmcLogEntry); 1304897967deSJason M. Bills return; 1305897967deSJason M. Bills } 1306897967deSJason M. Bills } 1307897967deSJason M. Bills } 1308897967deSJason M. Bills // Requested ID was not found 1309002d39b4SEd Tanous messages::resourceMissingAtURI(asyncResp->res, 1310002d39b4SEd Tanous crow::utility::urlFromPieces(targetID)); 13117e860f15SJohn Edward Broadbent }); 131208a4e4b5SAnthony Wilson } 131308a4e4b5SAnthony Wilson 13147e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryCollection(App& app) 131508a4e4b5SAnthony Wilson { 13167e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 13177e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") 1318ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 1319002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1320002d39b4SEd Tanous [&app](const crow::Request& req, 1321002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 13223ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 132345ca1b86SEd Tanous { 132445ca1b86SEd Tanous return; 132545ca1b86SEd Tanous } 13267e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 13277e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 132808a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.type"] = 132908a4e4b5SAnthony Wilson "#LogEntryCollection.LogEntryCollection"; 133008a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.id"] = 133108a4e4b5SAnthony Wilson "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 133208a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 133308a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Description"] = 133408a4e4b5SAnthony Wilson "Collection of System Event Log Entries"; 133508a4e4b5SAnthony Wilson 1336cb92c03bSAndrew Geissler // DBus implementation of EventLog/Entries 1337cb92c03bSAndrew Geissler // Make call to Logging Service to find all log entry objects 1338cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 1339cb92c03bSAndrew Geissler [asyncResp](const boost::system::error_code ec, 1340914e2d5dSEd Tanous const dbus::utility::ManagedObjectType& resp) { 1341cb92c03bSAndrew Geissler if (ec) 1342cb92c03bSAndrew Geissler { 1343cb92c03bSAndrew Geissler // TODO Handle for specific error code 1344cb92c03bSAndrew Geissler BMCWEB_LOG_ERROR 1345002d39b4SEd Tanous << "getLogEntriesIfaceData resp_handler got error " << ec; 1346cb92c03bSAndrew Geissler messages::internalError(asyncResp->res); 1347cb92c03bSAndrew Geissler return; 1348cb92c03bSAndrew Geissler } 1349002d39b4SEd Tanous nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"]; 1350cb92c03bSAndrew Geissler entriesArray = nlohmann::json::array(); 13519eb808c1SEd Tanous for (const auto& objectPath : resp) 1352cb92c03bSAndrew Geissler { 1353914e2d5dSEd Tanous const uint32_t* id = nullptr; 1354c419c759SEd Tanous const uint64_t* timestamp = nullptr; 1355c419c759SEd Tanous const uint64_t* updateTimestamp = nullptr; 1356914e2d5dSEd Tanous const std::string* severity = nullptr; 1357914e2d5dSEd Tanous const std::string* message = nullptr; 1358914e2d5dSEd Tanous const std::string* filePath = nullptr; 135975710de2SXiaochao Ma bool resolved = false; 13609eb808c1SEd Tanous for (const auto& interfaceMap : objectPath.second) 1361f86bb901SAdriana Kobylak { 1362f86bb901SAdriana Kobylak if (interfaceMap.first == 1363f86bb901SAdriana Kobylak "xyz.openbmc_project.Logging.Entry") 1364f86bb901SAdriana Kobylak { 1365002d39b4SEd Tanous for (const auto& propertyMap : interfaceMap.second) 1366cb92c03bSAndrew Geissler { 1367cb92c03bSAndrew Geissler if (propertyMap.first == "Id") 1368cb92c03bSAndrew Geissler { 1369002d39b4SEd Tanous id = std::get_if<uint32_t>(&propertyMap.second); 1370cb92c03bSAndrew Geissler } 1371cb92c03bSAndrew Geissler else if (propertyMap.first == "Timestamp") 1372cb92c03bSAndrew Geissler { 1373002d39b4SEd Tanous timestamp = 1374002d39b4SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 13757e860f15SJohn Edward Broadbent } 1376002d39b4SEd Tanous else if (propertyMap.first == "UpdateTimestamp") 13777e860f15SJohn Edward Broadbent { 1378002d39b4SEd Tanous updateTimestamp = 1379002d39b4SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 13807e860f15SJohn Edward Broadbent } 13817e860f15SJohn Edward Broadbent else if (propertyMap.first == "Severity") 13827e860f15SJohn Edward Broadbent { 13837e860f15SJohn Edward Broadbent severity = std::get_if<std::string>( 13847e860f15SJohn Edward Broadbent &propertyMap.second); 13857e860f15SJohn Edward Broadbent } 13867e860f15SJohn Edward Broadbent else if (propertyMap.first == "Message") 13877e860f15SJohn Edward Broadbent { 13887e860f15SJohn Edward Broadbent message = std::get_if<std::string>( 13897e860f15SJohn Edward Broadbent &propertyMap.second); 13907e860f15SJohn Edward Broadbent } 13917e860f15SJohn Edward Broadbent else if (propertyMap.first == "Resolved") 13927e860f15SJohn Edward Broadbent { 1393914e2d5dSEd Tanous const bool* resolveptr = 1394002d39b4SEd Tanous std::get_if<bool>(&propertyMap.second); 13957e860f15SJohn Edward Broadbent if (resolveptr == nullptr) 13967e860f15SJohn Edward Broadbent { 1397002d39b4SEd Tanous messages::internalError(asyncResp->res); 13987e860f15SJohn Edward Broadbent return; 13997e860f15SJohn Edward Broadbent } 14007e860f15SJohn Edward Broadbent resolved = *resolveptr; 14017e860f15SJohn Edward Broadbent } 14027e860f15SJohn Edward Broadbent } 14037e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 14047e860f15SJohn Edward Broadbent severity == nullptr) 14057e860f15SJohn Edward Broadbent { 14067e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 14077e860f15SJohn Edward Broadbent return; 14087e860f15SJohn Edward Broadbent } 14097e860f15SJohn Edward Broadbent } 14107e860f15SJohn Edward Broadbent else if (interfaceMap.first == 14117e860f15SJohn Edward Broadbent "xyz.openbmc_project.Common.FilePath") 14127e860f15SJohn Edward Broadbent { 1413002d39b4SEd Tanous for (const auto& propertyMap : interfaceMap.second) 14147e860f15SJohn Edward Broadbent { 14157e860f15SJohn Edward Broadbent if (propertyMap.first == "Path") 14167e860f15SJohn Edward Broadbent { 14177e860f15SJohn Edward Broadbent filePath = std::get_if<std::string>( 14187e860f15SJohn Edward Broadbent &propertyMap.second); 14197e860f15SJohn Edward Broadbent } 14207e860f15SJohn Edward Broadbent } 14217e860f15SJohn Edward Broadbent } 14227e860f15SJohn Edward Broadbent } 14237e860f15SJohn Edward Broadbent // Object path without the 14247e860f15SJohn Edward Broadbent // xyz.openbmc_project.Logging.Entry interface, ignore 14257e860f15SJohn Edward Broadbent // and continue. 14267e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 1427c419c759SEd Tanous severity == nullptr || timestamp == nullptr || 1428c419c759SEd Tanous updateTimestamp == nullptr) 14297e860f15SJohn Edward Broadbent { 14307e860f15SJohn Edward Broadbent continue; 14317e860f15SJohn Edward Broadbent } 14327e860f15SJohn Edward Broadbent entriesArray.push_back({}); 14337e860f15SJohn Edward Broadbent nlohmann::json& thisEntry = entriesArray.back(); 14347e860f15SJohn Edward Broadbent thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 14357e860f15SJohn Edward Broadbent thisEntry["@odata.id"] = 14360fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 14377e860f15SJohn Edward Broadbent std::to_string(*id); 14387e860f15SJohn Edward Broadbent thisEntry["Name"] = "System Event Log Entry"; 14397e860f15SJohn Edward Broadbent thisEntry["Id"] = std::to_string(*id); 14407e860f15SJohn Edward Broadbent thisEntry["Message"] = *message; 14417e860f15SJohn Edward Broadbent thisEntry["Resolved"] = resolved; 14427e860f15SJohn Edward Broadbent thisEntry["EntryType"] = "Event"; 14437e860f15SJohn Edward Broadbent thisEntry["Severity"] = 14447e860f15SJohn Edward Broadbent translateSeverityDbusToRedfish(*severity); 14457e860f15SJohn Edward Broadbent thisEntry["Created"] = 14462b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*timestamp); 14477e860f15SJohn Edward Broadbent thisEntry["Modified"] = 14482b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 14497e860f15SJohn Edward Broadbent if (filePath != nullptr) 14507e860f15SJohn Edward Broadbent { 14517e860f15SJohn Edward Broadbent thisEntry["AdditionalDataURI"] = 14520fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 14537e860f15SJohn Edward Broadbent std::to_string(*id) + "/attachment"; 14547e860f15SJohn Edward Broadbent } 14557e860f15SJohn Edward Broadbent } 1456002d39b4SEd Tanous std::sort( 1457002d39b4SEd Tanous entriesArray.begin(), entriesArray.end(), 1458002d39b4SEd Tanous [](const nlohmann::json& left, const nlohmann::json& right) { 14597e860f15SJohn Edward Broadbent return (left["Id"] <= right["Id"]); 14607e860f15SJohn Edward Broadbent }); 14617e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members@odata.count"] = 14627e860f15SJohn Edward Broadbent entriesArray.size(); 14637e860f15SJohn Edward Broadbent }, 14647e860f15SJohn Edward Broadbent "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging", 14657e860f15SJohn Edward Broadbent "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 14667e860f15SJohn Edward Broadbent }); 14677e860f15SJohn Edward Broadbent } 14687e860f15SJohn Edward Broadbent 14697e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app) 14707e860f15SJohn Edward Broadbent { 14717e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 14727e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1473ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 1474002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1475002d39b4SEd Tanous [&app](const crow::Request& req, 14767e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 147745ca1b86SEd Tanous const std::string& param) { 14783ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 14797e860f15SJohn Edward Broadbent { 148045ca1b86SEd Tanous return; 148145ca1b86SEd Tanous } 14827e860f15SJohn Edward Broadbent std::string entryID = param; 14837e860f15SJohn Edward Broadbent dbus::utility::escapePathForDbus(entryID); 14847e860f15SJohn Edward Broadbent 14857e860f15SJohn Edward Broadbent // DBus implementation of EventLog/Entries 14867e860f15SJohn Edward Broadbent // Make call to Logging Service to find all log entry objects 14877e860f15SJohn Edward Broadbent crow::connections::systemBus->async_method_call( 1488002d39b4SEd Tanous [asyncResp, entryID](const boost::system::error_code ec, 1489b9d36b47SEd Tanous const dbus::utility::DBusPropertiesMap& resp) { 14907e860f15SJohn Edward Broadbent if (ec.value() == EBADR) 14917e860f15SJohn Edward Broadbent { 1492*d8a5d5d8SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 14937e860f15SJohn Edward Broadbent return; 14947e860f15SJohn Edward Broadbent } 14957e860f15SJohn Edward Broadbent if (ec) 14967e860f15SJohn Edward Broadbent { 14970fda0f12SGeorge Liu BMCWEB_LOG_ERROR 1498002d39b4SEd Tanous << "EventLogEntry (DBus) resp_handler got error " << ec; 14997e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 15007e860f15SJohn Edward Broadbent return; 15017e860f15SJohn Edward Broadbent } 1502914e2d5dSEd Tanous const uint32_t* id = nullptr; 1503c419c759SEd Tanous const uint64_t* timestamp = nullptr; 1504c419c759SEd Tanous const uint64_t* updateTimestamp = nullptr; 1505914e2d5dSEd Tanous const std::string* severity = nullptr; 1506914e2d5dSEd Tanous const std::string* message = nullptr; 1507914e2d5dSEd Tanous const std::string* filePath = nullptr; 15087e860f15SJohn Edward Broadbent bool resolved = false; 15097e860f15SJohn Edward Broadbent 15109eb808c1SEd Tanous for (const auto& propertyMap : resp) 15117e860f15SJohn Edward Broadbent { 15127e860f15SJohn Edward Broadbent if (propertyMap.first == "Id") 15137e860f15SJohn Edward Broadbent { 15147e860f15SJohn Edward Broadbent id = std::get_if<uint32_t>(&propertyMap.second); 15157e860f15SJohn Edward Broadbent } 15167e860f15SJohn Edward Broadbent else if (propertyMap.first == "Timestamp") 15177e860f15SJohn Edward Broadbent { 1518002d39b4SEd Tanous timestamp = std::get_if<uint64_t>(&propertyMap.second); 1519ebd45906SGeorge Liu } 1520d139c236SGeorge Liu else if (propertyMap.first == "UpdateTimestamp") 1521d139c236SGeorge Liu { 1522ebd45906SGeorge Liu updateTimestamp = 1523c419c759SEd Tanous std::get_if<uint64_t>(&propertyMap.second); 1524ebd45906SGeorge Liu } 1525cb92c03bSAndrew Geissler else if (propertyMap.first == "Severity") 1526cb92c03bSAndrew Geissler { 1527002d39b4SEd Tanous severity = std::get_if<std::string>(&propertyMap.second); 1528cb92c03bSAndrew Geissler } 1529cb92c03bSAndrew Geissler else if (propertyMap.first == "Message") 1530cb92c03bSAndrew Geissler { 1531002d39b4SEd Tanous message = std::get_if<std::string>(&propertyMap.second); 1532ae34c8e8SAdriana Kobylak } 153375710de2SXiaochao Ma else if (propertyMap.first == "Resolved") 153475710de2SXiaochao Ma { 1535914e2d5dSEd Tanous const bool* resolveptr = 153675710de2SXiaochao Ma std::get_if<bool>(&propertyMap.second); 153775710de2SXiaochao Ma if (resolveptr == nullptr) 153875710de2SXiaochao Ma { 153975710de2SXiaochao Ma messages::internalError(asyncResp->res); 154075710de2SXiaochao Ma return; 154175710de2SXiaochao Ma } 154275710de2SXiaochao Ma resolved = *resolveptr; 154375710de2SXiaochao Ma } 15447e860f15SJohn Edward Broadbent else if (propertyMap.first == "Path") 1545f86bb901SAdriana Kobylak { 1546002d39b4SEd Tanous filePath = std::get_if<std::string>(&propertyMap.second); 1547f86bb901SAdriana Kobylak } 1548f86bb901SAdriana Kobylak } 1549002d39b4SEd Tanous if (id == nullptr || message == nullptr || severity == nullptr || 1550002d39b4SEd Tanous timestamp == nullptr || updateTimestamp == nullptr) 1551f86bb901SAdriana Kobylak { 1552ae34c8e8SAdriana Kobylak messages::internalError(asyncResp->res); 1553271584abSEd Tanous return; 1554271584abSEd Tanous } 1555f86bb901SAdriana Kobylak asyncResp->res.jsonValue["@odata.type"] = 1556f86bb901SAdriana Kobylak "#LogEntry.v1_8_0.LogEntry"; 1557f86bb901SAdriana Kobylak asyncResp->res.jsonValue["@odata.id"] = 15580fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1559f86bb901SAdriana Kobylak std::to_string(*id); 156045ca1b86SEd Tanous asyncResp->res.jsonValue["Name"] = "System Event Log Entry"; 1561f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Id"] = std::to_string(*id); 1562f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Message"] = *message; 1563f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Resolved"] = resolved; 1564f86bb901SAdriana Kobylak asyncResp->res.jsonValue["EntryType"] = "Event"; 1565f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Severity"] = 1566f86bb901SAdriana Kobylak translateSeverityDbusToRedfish(*severity); 1567f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Created"] = 15682b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*timestamp); 1569f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Modified"] = 15702b82937eSEd Tanous redfish::time_utils::getDateTimeUintMs(*updateTimestamp); 1571f86bb901SAdriana Kobylak if (filePath != nullptr) 1572f86bb901SAdriana Kobylak { 1573f86bb901SAdriana Kobylak asyncResp->res.jsonValue["AdditionalDataURI"] = 1574e7dbd530SPotin Lai "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1575e7dbd530SPotin Lai std::to_string(*id) + "/attachment"; 1576f86bb901SAdriana Kobylak } 1577cb92c03bSAndrew Geissler }, 1578cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging", 1579cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging/entry/" + entryID, 1580f86bb901SAdriana Kobylak "org.freedesktop.DBus.Properties", "GetAll", ""); 15817e860f15SJohn Edward Broadbent }); 1582336e96c6SChicago Duan 15837e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 15847e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1585ed398213SEd Tanous .privileges(redfish::privileges::patchLogEntry) 15867e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::patch)( 158745ca1b86SEd Tanous [&app](const crow::Request& req, 15887e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 15897e860f15SJohn Edward Broadbent const std::string& entryId) { 15903ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 159145ca1b86SEd Tanous { 159245ca1b86SEd Tanous return; 159345ca1b86SEd Tanous } 159475710de2SXiaochao Ma std::optional<bool> resolved; 159575710de2SXiaochao Ma 159615ed6780SWilly Tu if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved", 15977e860f15SJohn Edward Broadbent resolved)) 159875710de2SXiaochao Ma { 159975710de2SXiaochao Ma return; 160075710de2SXiaochao Ma } 160175710de2SXiaochao Ma BMCWEB_LOG_DEBUG << "Set Resolved"; 160275710de2SXiaochao Ma 160375710de2SXiaochao Ma crow::connections::systemBus->async_method_call( 16044f48d5f6SEd Tanous [asyncResp, entryId](const boost::system::error_code ec) { 160575710de2SXiaochao Ma if (ec) 160675710de2SXiaochao Ma { 160775710de2SXiaochao Ma BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 160875710de2SXiaochao Ma messages::internalError(asyncResp->res); 160975710de2SXiaochao Ma return; 161075710de2SXiaochao Ma } 161175710de2SXiaochao Ma }, 161275710de2SXiaochao Ma "xyz.openbmc_project.Logging", 161375710de2SXiaochao Ma "/xyz/openbmc_project/logging/entry/" + entryId, 161475710de2SXiaochao Ma "org.freedesktop.DBus.Properties", "Set", 161575710de2SXiaochao Ma "xyz.openbmc_project.Logging.Entry", "Resolved", 1616168e20c1SEd Tanous dbus::utility::DbusVariantType(*resolved)); 16177e860f15SJohn Edward Broadbent }); 161875710de2SXiaochao Ma 16197e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 16207e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1621ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 1622ed398213SEd Tanous 1623002d39b4SEd Tanous .methods(boost::beast::http::verb::delete_)( 1624002d39b4SEd Tanous [&app](const crow::Request& req, 1625002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 162645ca1b86SEd Tanous const std::string& param) { 16273ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1628336e96c6SChicago Duan { 162945ca1b86SEd Tanous return; 163045ca1b86SEd Tanous } 1631336e96c6SChicago Duan BMCWEB_LOG_DEBUG << "Do delete single event entries."; 1632336e96c6SChicago Duan 16337e860f15SJohn Edward Broadbent std::string entryID = param; 1634336e96c6SChicago Duan 1635336e96c6SChicago Duan dbus::utility::escapePathForDbus(entryID); 1636336e96c6SChicago Duan 1637336e96c6SChicago Duan // Process response from Logging service. 1638002d39b4SEd Tanous auto respHandler = 1639002d39b4SEd Tanous [asyncResp, entryID](const boost::system::error_code ec) { 1640002d39b4SEd Tanous BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done"; 1641336e96c6SChicago Duan if (ec) 1642336e96c6SChicago Duan { 16433de8d8baSGeorge Liu if (ec.value() == EBADR) 16443de8d8baSGeorge Liu { 164545ca1b86SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 164645ca1b86SEd Tanous entryID); 16473de8d8baSGeorge Liu return; 16483de8d8baSGeorge Liu } 1649336e96c6SChicago Duan // TODO Handle for specific error code 16500fda0f12SGeorge Liu BMCWEB_LOG_ERROR 16510fda0f12SGeorge Liu << "EventLogEntry (DBus) doDelete respHandler got error " 1652336e96c6SChicago Duan << ec; 1653336e96c6SChicago Duan asyncResp->res.result( 1654336e96c6SChicago Duan boost::beast::http::status::internal_server_error); 1655336e96c6SChicago Duan return; 1656336e96c6SChicago Duan } 1657336e96c6SChicago Duan 1658336e96c6SChicago Duan asyncResp->res.result(boost::beast::http::status::ok); 1659336e96c6SChicago Duan }; 1660336e96c6SChicago Duan 1661336e96c6SChicago Duan // Make call to Logging service to request Delete Log 1662336e96c6SChicago Duan crow::connections::systemBus->async_method_call( 1663336e96c6SChicago Duan respHandler, "xyz.openbmc_project.Logging", 1664336e96c6SChicago Duan "/xyz/openbmc_project/logging/entry/" + entryID, 1665336e96c6SChicago Duan "xyz.openbmc_project.Object.Delete", "Delete"); 16667e860f15SJohn Edward Broadbent }); 1667400fd1fbSAdriana Kobylak } 1668400fd1fbSAdriana Kobylak 16697e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryDownload(App& app) 1670400fd1fbSAdriana Kobylak { 16710fda0f12SGeorge Liu BMCWEB_ROUTE( 16720fda0f12SGeorge Liu app, 16730fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/attachment") 1674ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 16757e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 167645ca1b86SEd Tanous [&app](const crow::Request& req, 16777e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 167845ca1b86SEd Tanous const std::string& param) { 16793ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 16807e860f15SJohn Edward Broadbent { 168145ca1b86SEd Tanous return; 168245ca1b86SEd Tanous } 1683002d39b4SEd Tanous if (!http_helpers::isOctetAccepted(req.getHeaderValue("Accept"))) 1684400fd1fbSAdriana Kobylak { 1685002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::bad_request); 1686400fd1fbSAdriana Kobylak return; 1687400fd1fbSAdriana Kobylak } 1688400fd1fbSAdriana Kobylak 16897e860f15SJohn Edward Broadbent std::string entryID = param; 1690400fd1fbSAdriana Kobylak dbus::utility::escapePathForDbus(entryID); 1691400fd1fbSAdriana Kobylak 1692400fd1fbSAdriana Kobylak crow::connections::systemBus->async_method_call( 1693002d39b4SEd Tanous [asyncResp, entryID](const boost::system::error_code ec, 1694400fd1fbSAdriana Kobylak const sdbusplus::message::unix_fd& unixfd) { 1695400fd1fbSAdriana Kobylak if (ec.value() == EBADR) 1696400fd1fbSAdriana Kobylak { 1697002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "EventLogAttachment", 1698002d39b4SEd Tanous entryID); 1699400fd1fbSAdriana Kobylak return; 1700400fd1fbSAdriana Kobylak } 1701400fd1fbSAdriana Kobylak if (ec) 1702400fd1fbSAdriana Kobylak { 1703400fd1fbSAdriana Kobylak BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 1704400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1705400fd1fbSAdriana Kobylak return; 1706400fd1fbSAdriana Kobylak } 1707400fd1fbSAdriana Kobylak 1708400fd1fbSAdriana Kobylak int fd = -1; 1709400fd1fbSAdriana Kobylak fd = dup(unixfd); 1710400fd1fbSAdriana Kobylak if (fd == -1) 1711400fd1fbSAdriana Kobylak { 1712400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1713400fd1fbSAdriana Kobylak return; 1714400fd1fbSAdriana Kobylak } 1715400fd1fbSAdriana Kobylak 1716400fd1fbSAdriana Kobylak long long int size = lseek(fd, 0, SEEK_END); 1717400fd1fbSAdriana Kobylak if (size == -1) 1718400fd1fbSAdriana Kobylak { 1719400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1720400fd1fbSAdriana Kobylak return; 1721400fd1fbSAdriana Kobylak } 1722400fd1fbSAdriana Kobylak 1723400fd1fbSAdriana Kobylak // Arbitrary max size of 64kb 1724400fd1fbSAdriana Kobylak constexpr int maxFileSize = 65536; 1725400fd1fbSAdriana Kobylak if (size > maxFileSize) 1726400fd1fbSAdriana Kobylak { 1727002d39b4SEd Tanous BMCWEB_LOG_ERROR << "File size exceeds maximum allowed size of " 1728400fd1fbSAdriana Kobylak << maxFileSize; 1729400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1730400fd1fbSAdriana Kobylak return; 1731400fd1fbSAdriana Kobylak } 1732400fd1fbSAdriana Kobylak std::vector<char> data(static_cast<size_t>(size)); 1733400fd1fbSAdriana Kobylak long long int rc = lseek(fd, 0, SEEK_SET); 1734400fd1fbSAdriana Kobylak if (rc == -1) 1735400fd1fbSAdriana Kobylak { 1736400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1737400fd1fbSAdriana Kobylak return; 1738400fd1fbSAdriana Kobylak } 1739400fd1fbSAdriana Kobylak rc = read(fd, data.data(), data.size()); 1740400fd1fbSAdriana Kobylak if ((rc == -1) || (rc != size)) 1741400fd1fbSAdriana Kobylak { 1742400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1743400fd1fbSAdriana Kobylak return; 1744400fd1fbSAdriana Kobylak } 1745400fd1fbSAdriana Kobylak close(fd); 1746400fd1fbSAdriana Kobylak 1747400fd1fbSAdriana Kobylak std::string_view strData(data.data(), data.size()); 1748002d39b4SEd Tanous std::string output = crow::utility::base64encode(strData); 1749400fd1fbSAdriana Kobylak 1750d9f6c621SEd Tanous asyncResp->res.addHeader(boost::beast::http::field::content_type, 1751400fd1fbSAdriana Kobylak "application/octet-stream"); 1752d9f6c621SEd Tanous asyncResp->res.addHeader( 1753d9f6c621SEd Tanous boost::beast::http::field::content_transfer_encoding, "Base64"); 1754400fd1fbSAdriana Kobylak asyncResp->res.body() = std::move(output); 1755400fd1fbSAdriana Kobylak }, 1756400fd1fbSAdriana Kobylak "xyz.openbmc_project.Logging", 1757400fd1fbSAdriana Kobylak "/xyz/openbmc_project/logging/entry/" + entryID, 1758400fd1fbSAdriana Kobylak "xyz.openbmc_project.Logging.Entry", "GetEntry"); 17597e860f15SJohn Edward Broadbent }); 17601da66f75SEd Tanous } 17611da66f75SEd Tanous 1762b7028ebfSSpencer Ku constexpr const char* hostLoggerFolderPath = "/var/log/console"; 1763b7028ebfSSpencer Ku 1764b7028ebfSSpencer Ku inline bool 1765b7028ebfSSpencer Ku getHostLoggerFiles(const std::string& hostLoggerFilePath, 1766b7028ebfSSpencer Ku std::vector<std::filesystem::path>& hostLoggerFiles) 1767b7028ebfSSpencer Ku { 1768b7028ebfSSpencer Ku std::error_code ec; 1769b7028ebfSSpencer Ku std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec); 1770b7028ebfSSpencer Ku if (ec) 1771b7028ebfSSpencer Ku { 1772b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << ec.message(); 1773b7028ebfSSpencer Ku return false; 1774b7028ebfSSpencer Ku } 1775b7028ebfSSpencer Ku for (const std::filesystem::directory_entry& it : logPath) 1776b7028ebfSSpencer Ku { 1777b7028ebfSSpencer Ku std::string filename = it.path().filename(); 1778b7028ebfSSpencer Ku // Prefix of each log files is "log". Find the file and save the 1779b7028ebfSSpencer Ku // path 178011ba3979SEd Tanous if (filename.starts_with("log")) 1781b7028ebfSSpencer Ku { 1782b7028ebfSSpencer Ku hostLoggerFiles.emplace_back(it.path()); 1783b7028ebfSSpencer Ku } 1784b7028ebfSSpencer Ku } 1785b7028ebfSSpencer Ku // As the log files rotate, they are appended with a ".#" that is higher for 1786b7028ebfSSpencer Ku // the older logs. Since we start from oldest logs, sort the name in 1787b7028ebfSSpencer Ku // descending order. 1788b7028ebfSSpencer Ku std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(), 1789b7028ebfSSpencer Ku AlphanumLess<std::string>()); 1790b7028ebfSSpencer Ku 1791b7028ebfSSpencer Ku return true; 1792b7028ebfSSpencer Ku } 1793b7028ebfSSpencer Ku 179402cad96eSEd Tanous inline bool getHostLoggerEntries( 179502cad96eSEd Tanous const std::vector<std::filesystem::path>& hostLoggerFiles, uint64_t skip, 179602cad96eSEd Tanous uint64_t top, std::vector<std::string>& logEntries, size_t& logCount) 1797b7028ebfSSpencer Ku { 1798b7028ebfSSpencer Ku GzFileReader logFile; 1799b7028ebfSSpencer Ku 1800b7028ebfSSpencer Ku // Go though all log files and expose host logs. 1801b7028ebfSSpencer Ku for (const std::filesystem::path& it : hostLoggerFiles) 1802b7028ebfSSpencer Ku { 1803b7028ebfSSpencer Ku if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount)) 1804b7028ebfSSpencer Ku { 1805b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << "fail to expose host logs"; 1806b7028ebfSSpencer Ku return false; 1807b7028ebfSSpencer Ku } 1808b7028ebfSSpencer Ku } 1809b7028ebfSSpencer Ku // Get lastMessage from constructor by getter 1810b7028ebfSSpencer Ku std::string lastMessage = logFile.getLastMessage(); 1811b7028ebfSSpencer Ku if (!lastMessage.empty()) 1812b7028ebfSSpencer Ku { 1813b7028ebfSSpencer Ku logCount++; 1814b7028ebfSSpencer Ku if (logCount > skip && logCount <= (skip + top)) 1815b7028ebfSSpencer Ku { 1816b7028ebfSSpencer Ku logEntries.push_back(lastMessage); 1817b7028ebfSSpencer Ku } 1818b7028ebfSSpencer Ku } 1819b7028ebfSSpencer Ku return true; 1820b7028ebfSSpencer Ku } 1821b7028ebfSSpencer Ku 1822b7028ebfSSpencer Ku inline void fillHostLoggerEntryJson(const std::string& logEntryID, 1823b7028ebfSSpencer Ku const std::string& msg, 18246d6574c9SJason M. Bills nlohmann::json::object_t& logEntryJson) 1825b7028ebfSSpencer Ku { 1826b7028ebfSSpencer Ku // Fill in the log entry with the gathered data. 18276d6574c9SJason M. Bills logEntryJson["@odata.type"] = "#LogEntry.v1_4_0.LogEntry"; 18286d6574c9SJason M. Bills logEntryJson["@odata.id"] = 1829b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/" + 18306d6574c9SJason M. Bills logEntryID; 18316d6574c9SJason M. Bills logEntryJson["Name"] = "Host Logger Entry"; 18326d6574c9SJason M. Bills logEntryJson["Id"] = logEntryID; 18336d6574c9SJason M. Bills logEntryJson["Message"] = msg; 18346d6574c9SJason M. Bills logEntryJson["EntryType"] = "Oem"; 18356d6574c9SJason M. Bills logEntryJson["Severity"] = "OK"; 18366d6574c9SJason M. Bills logEntryJson["OemRecordFormat"] = "Host Logger Entry"; 1837b7028ebfSSpencer Ku } 1838b7028ebfSSpencer Ku 1839b7028ebfSSpencer Ku inline void requestRoutesSystemHostLogger(App& app) 1840b7028ebfSSpencer Ku { 1841b7028ebfSSpencer Ku BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/HostLogger/") 1842b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogService) 18431476687dSEd Tanous .methods(boost::beast::http::verb::get)( 18441476687dSEd Tanous [&app](const crow::Request& req, 18451476687dSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 18463ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 184745ca1b86SEd Tanous { 184845ca1b86SEd Tanous return; 184945ca1b86SEd Tanous } 1850b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 1851b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger"; 1852b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 1853b7028ebfSSpencer Ku "#LogService.v1_1_0.LogService"; 1854b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "Host Logger Service"; 1855b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = "Host Logger Service"; 1856b7028ebfSSpencer Ku asyncResp->res.jsonValue["Id"] = "HostLogger"; 18571476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 18581476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 1859b7028ebfSSpencer Ku }); 1860b7028ebfSSpencer Ku } 1861b7028ebfSSpencer Ku 1862b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerCollection(App& app) 1863b7028ebfSSpencer Ku { 1864b7028ebfSSpencer Ku BMCWEB_ROUTE(app, 1865b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/") 1866b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 1867002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1868002d39b4SEd Tanous [&app](const crow::Request& req, 1869002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1870c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 1871c937d2bfSEd Tanous .canDelegateTop = true, 1872c937d2bfSEd Tanous .canDelegateSkip = true, 1873c937d2bfSEd Tanous }; 1874c937d2bfSEd Tanous query_param::Query delegatedQuery; 1875c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 18763ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 1877b7028ebfSSpencer Ku { 1878b7028ebfSSpencer Ku return; 1879b7028ebfSSpencer Ku } 1880b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 1881b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 1882b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 1883b7028ebfSSpencer Ku "#LogEntryCollection.LogEntryCollection"; 1884b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "HostLogger Entries"; 1885b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = 1886b7028ebfSSpencer Ku "Collection of HostLogger Entries"; 18870fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1888b7028ebfSSpencer Ku logEntryArray = nlohmann::json::array(); 1889b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = 0; 1890b7028ebfSSpencer Ku 1891b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 1892b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 1893b7028ebfSSpencer Ku { 1894b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << "fail to get host log file path"; 1895b7028ebfSSpencer Ku return; 1896b7028ebfSSpencer Ku } 18973648c8beSEd Tanous // If we weren't provided top and skip limits, use the defaults. 18983648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 18995143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 1900b7028ebfSSpencer Ku size_t logCount = 0; 1901b7028ebfSSpencer Ku // This vector only store the entries we want to expose that 1902b7028ebfSSpencer Ku // control by skip and top. 1903b7028ebfSSpencer Ku std::vector<std::string> logEntries; 19043648c8beSEd Tanous if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries, 19053648c8beSEd Tanous logCount)) 1906b7028ebfSSpencer Ku { 1907b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 1908b7028ebfSSpencer Ku return; 1909b7028ebfSSpencer Ku } 1910b7028ebfSSpencer Ku // If vector is empty, that means skip value larger than total 1911b7028ebfSSpencer Ku // log count 191226f6976fSEd Tanous if (logEntries.empty()) 1913b7028ebfSSpencer Ku { 1914b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 1915b7028ebfSSpencer Ku return; 1916b7028ebfSSpencer Ku } 191726f6976fSEd Tanous if (!logEntries.empty()) 1918b7028ebfSSpencer Ku { 1919b7028ebfSSpencer Ku for (size_t i = 0; i < logEntries.size(); i++) 1920b7028ebfSSpencer Ku { 19216d6574c9SJason M. Bills nlohmann::json::object_t hostLogEntry; 19223648c8beSEd Tanous fillHostLoggerEntryJson(std::to_string(skip + i), logEntries[i], 19233648c8beSEd Tanous hostLogEntry); 19246d6574c9SJason M. Bills logEntryArray.push_back(std::move(hostLogEntry)); 1925b7028ebfSSpencer Ku } 1926b7028ebfSSpencer Ku 1927b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 19283648c8beSEd Tanous if (skip + top < logCount) 1929b7028ebfSSpencer Ku { 1930b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.nextLink"] = 19310fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/HostLogger/Entries?$skip=" + 19323648c8beSEd Tanous std::to_string(skip + top); 1933b7028ebfSSpencer Ku } 1934b7028ebfSSpencer Ku } 1935b7028ebfSSpencer Ku }); 1936b7028ebfSSpencer Ku } 1937b7028ebfSSpencer Ku 1938b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerLogEntry(App& app) 1939b7028ebfSSpencer Ku { 1940b7028ebfSSpencer Ku BMCWEB_ROUTE( 1941b7028ebfSSpencer Ku app, "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/<str>/") 1942b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 1943b7028ebfSSpencer Ku .methods(boost::beast::http::verb::get)( 194445ca1b86SEd Tanous [&app](const crow::Request& req, 1945b7028ebfSSpencer Ku const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1946b7028ebfSSpencer Ku const std::string& param) { 19473ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 194845ca1b86SEd Tanous { 194945ca1b86SEd Tanous return; 195045ca1b86SEd Tanous } 1951b7028ebfSSpencer Ku const std::string& targetID = param; 1952b7028ebfSSpencer Ku 1953b7028ebfSSpencer Ku uint64_t idInt = 0; 1954ca45aa3cSEd Tanous 1955ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 1956ca45aa3cSEd Tanous const char* end = targetID.data() + targetID.size(); 1957ca45aa3cSEd Tanous 1958ca45aa3cSEd Tanous auto [ptr, ec] = std::from_chars(targetID.data(), end, idInt); 1959b7028ebfSSpencer Ku if (ec == std::errc::invalid_argument) 1960b7028ebfSSpencer Ku { 1961ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 1962b7028ebfSSpencer Ku return; 1963b7028ebfSSpencer Ku } 1964b7028ebfSSpencer Ku if (ec == std::errc::result_out_of_range) 1965b7028ebfSSpencer Ku { 1966ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 1967b7028ebfSSpencer Ku return; 1968b7028ebfSSpencer Ku } 1969b7028ebfSSpencer Ku 1970b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 1971b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 1972b7028ebfSSpencer Ku { 1973b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << "fail to get host log file path"; 1974b7028ebfSSpencer Ku return; 1975b7028ebfSSpencer Ku } 1976b7028ebfSSpencer Ku 1977b7028ebfSSpencer Ku size_t logCount = 0; 19783648c8beSEd Tanous size_t top = 1; 1979b7028ebfSSpencer Ku std::vector<std::string> logEntries; 1980b7028ebfSSpencer Ku // We can get specific entry by skip and top. For example, if we 1981b7028ebfSSpencer Ku // want to get nth entry, we can set skip = n-1 and top = 1 to 1982b7028ebfSSpencer Ku // get that entry 1983002d39b4SEd Tanous if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, logEntries, 1984002d39b4SEd Tanous logCount)) 1985b7028ebfSSpencer Ku { 1986b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 1987b7028ebfSSpencer Ku return; 1988b7028ebfSSpencer Ku } 1989b7028ebfSSpencer Ku 1990b7028ebfSSpencer Ku if (!logEntries.empty()) 1991b7028ebfSSpencer Ku { 19926d6574c9SJason M. Bills nlohmann::json::object_t hostLogEntry; 19936d6574c9SJason M. Bills fillHostLoggerEntryJson(targetID, logEntries[0], hostLogEntry); 19946d6574c9SJason M. Bills asyncResp->res.jsonValue.update(hostLogEntry); 1995b7028ebfSSpencer Ku return; 1996b7028ebfSSpencer Ku } 1997b7028ebfSSpencer Ku 1998b7028ebfSSpencer Ku // Requested ID was not found 1999ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 2000b7028ebfSSpencer Ku }); 2001b7028ebfSSpencer Ku } 2002b7028ebfSSpencer Ku 2003fdd26906SClaire Weinan constexpr char const* dumpManagerIface = 2004fdd26906SClaire Weinan "xyz.openbmc_project.Collection.DeleteAll"; 2005dd72e87bSClaire Weinan inline void handleBMCLogServicesCollectionGet( 2006fdd26906SClaire Weinan crow::App& app, const crow::Request& req, 2007fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 20081da66f75SEd Tanous { 20093ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 201045ca1b86SEd Tanous { 201145ca1b86SEd Tanous return; 201245ca1b86SEd Tanous } 20137e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 20147e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2015e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 20161da66f75SEd Tanous "#LogServiceCollection.LogServiceCollection"; 2017e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 2018e1f26343SJason M. Bills "/redfish/v1/Managers/bmc/LogServices"; 2019002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection"; 2020e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 20211da66f75SEd Tanous "Collection of LogServices for this Manager"; 2022002d39b4SEd Tanous nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 2023c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 2024fdd26906SClaire Weinan 2025c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL 2026c4bf6374SJason M. Bills logServiceArray.push_back( 2027002d39b4SEd Tanous {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal"}}); 2028c4bf6374SJason M. Bills #endif 2029fdd26906SClaire Weinan 2030fdd26906SClaire Weinan asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size(); 2031fdd26906SClaire Weinan 2032fdd26906SClaire Weinan #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 2033fdd26906SClaire Weinan auto respHandler = 2034fdd26906SClaire Weinan [asyncResp]( 2035fdd26906SClaire Weinan const boost::system::error_code ec, 2036fdd26906SClaire Weinan const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 2037fdd26906SClaire Weinan if (ec) 2038fdd26906SClaire Weinan { 2039fdd26906SClaire Weinan BMCWEB_LOG_ERROR 2040dd72e87bSClaire Weinan << "handleBMCLogServicesCollectionGet respHandler got error " 2041fdd26906SClaire Weinan << ec; 2042fdd26906SClaire Weinan // Assume that getting an error simply means there are no dump 2043fdd26906SClaire Weinan // LogServices. Return without adding any error response. 2044fdd26906SClaire Weinan return; 2045fdd26906SClaire Weinan } 2046fdd26906SClaire Weinan 2047fdd26906SClaire Weinan nlohmann::json& logServiceArrayLocal = 2048fdd26906SClaire Weinan asyncResp->res.jsonValue["Members"]; 2049fdd26906SClaire Weinan 2050fdd26906SClaire Weinan for (const std::string& path : subTreePaths) 2051fdd26906SClaire Weinan { 2052fdd26906SClaire Weinan if (path == "/xyz/openbmc_project/dump/bmc") 2053fdd26906SClaire Weinan { 2054fdd26906SClaire Weinan logServiceArrayLocal.push_back( 2055fdd26906SClaire Weinan {{"@odata.id", 2056fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/Dump"}}); 2057fdd26906SClaire Weinan } 2058fdd26906SClaire Weinan else if (path == "/xyz/openbmc_project/dump/faultlog") 2059fdd26906SClaire Weinan { 2060fdd26906SClaire Weinan logServiceArrayLocal.push_back( 2061fdd26906SClaire Weinan {{"@odata.id", 2062fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog"}}); 2063fdd26906SClaire Weinan } 2064fdd26906SClaire Weinan } 2065fdd26906SClaire Weinan 2066e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 2067fdd26906SClaire Weinan logServiceArrayLocal.size(); 2068fdd26906SClaire Weinan }; 2069fdd26906SClaire Weinan 2070fdd26906SClaire Weinan crow::connections::systemBus->async_method_call( 2071fdd26906SClaire Weinan respHandler, "xyz.openbmc_project.ObjectMapper", 2072fdd26906SClaire Weinan "/xyz/openbmc_project/object_mapper", 2073fdd26906SClaire Weinan "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 2074fdd26906SClaire Weinan "/xyz/openbmc_project/dump", 0, 2075fdd26906SClaire Weinan std::array<const char*, 1>{dumpManagerIface}); 2076fdd26906SClaire Weinan #endif 2077fdd26906SClaire Weinan } 2078fdd26906SClaire Weinan 2079fdd26906SClaire Weinan inline void requestRoutesBMCLogServiceCollection(App& app) 2080fdd26906SClaire Weinan { 2081fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/") 2082fdd26906SClaire Weinan .privileges(redfish::privileges::getLogServiceCollection) 2083fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 2084dd72e87bSClaire Weinan std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app))); 2085e1f26343SJason M. Bills } 2086e1f26343SJason M. Bills 20877e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogService(App& app) 2088e1f26343SJason M. Bills { 20897e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/") 2090ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 20917e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 209245ca1b86SEd Tanous [&app](const crow::Request& req, 209345ca1b86SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 20943ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 20957e860f15SJohn Edward Broadbent { 209645ca1b86SEd Tanous return; 209745ca1b86SEd Tanous } 2098e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2099e1f26343SJason M. Bills "#LogService.v1_1_0.LogService"; 21000f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 21010f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal"; 2102002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service"; 2103002d39b4SEd Tanous asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service"; 2104c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "BMC Journal"; 2105e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 21067c8c4058STejas Patil 21077c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 21082b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 2109002d39b4SEd Tanous asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 21107c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 21117c8c4058STejas Patil redfishDateTimeOffset.second; 21127c8c4058STejas Patil 21131476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 21141476687dSEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 21157e860f15SJohn Edward Broadbent }); 2116e1f26343SJason M. Bills } 2117e1f26343SJason M. Bills 21183a48b3a2SJason M. Bills static int 21193a48b3a2SJason M. Bills fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID, 2120e1f26343SJason M. Bills sd_journal* journal, 21213a48b3a2SJason M. Bills nlohmann::json::object_t& bmcJournalLogEntryJson) 2122e1f26343SJason M. Bills { 2123e1f26343SJason M. Bills // Get the Log Entry contents 2124e1f26343SJason M. Bills int ret = 0; 2125e1f26343SJason M. Bills 2126a8fe54f0SJason M. Bills std::string message; 2127a8fe54f0SJason M. Bills std::string_view syslogID; 2128a8fe54f0SJason M. Bills ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID); 2129a8fe54f0SJason M. Bills if (ret < 0) 2130a8fe54f0SJason M. Bills { 2131a8fe54f0SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read SYSLOG_IDENTIFIER field: " 2132a8fe54f0SJason M. Bills << strerror(-ret); 2133a8fe54f0SJason M. Bills } 2134a8fe54f0SJason M. Bills if (!syslogID.empty()) 2135a8fe54f0SJason M. Bills { 2136a8fe54f0SJason M. Bills message += std::string(syslogID) + ": "; 2137a8fe54f0SJason M. Bills } 2138a8fe54f0SJason M. Bills 213939e77504SEd Tanous std::string_view msg; 214016428a1aSJason M. Bills ret = getJournalMetadata(journal, "MESSAGE", msg); 2141e1f26343SJason M. Bills if (ret < 0) 2142e1f26343SJason M. Bills { 2143e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret); 2144e1f26343SJason M. Bills return 1; 2145e1f26343SJason M. Bills } 2146a8fe54f0SJason M. Bills message += std::string(msg); 2147e1f26343SJason M. Bills 2148e1f26343SJason M. Bills // Get the severity from the PRIORITY field 2149271584abSEd Tanous long int severity = 8; // Default to an invalid priority 215016428a1aSJason M. Bills ret = getJournalMetadata(journal, "PRIORITY", 10, severity); 2151e1f26343SJason M. Bills if (ret < 0) 2152e1f26343SJason M. Bills { 2153e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret); 2154e1f26343SJason M. Bills } 2155e1f26343SJason M. Bills 2156e1f26343SJason M. Bills // Get the Created time from the timestamp 215716428a1aSJason M. Bills std::string entryTimeStr; 215816428a1aSJason M. Bills if (!getEntryTimestamp(journal, entryTimeStr)) 2159e1f26343SJason M. Bills { 216016428a1aSJason M. Bills return 1; 2161e1f26343SJason M. Bills } 2162e1f26343SJason M. Bills 2163e1f26343SJason M. Bills // Fill in the log entry with the gathered data 216484afc48bSJason M. Bills bmcJournalLogEntryJson["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 216584afc48bSJason M. Bills bmcJournalLogEntryJson["@odata.id"] = 216684afc48bSJason M. Bills "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" + 216784afc48bSJason M. Bills bmcJournalLogEntryID; 216884afc48bSJason M. Bills bmcJournalLogEntryJson["Name"] = "BMC Journal Entry"; 216984afc48bSJason M. Bills bmcJournalLogEntryJson["Id"] = bmcJournalLogEntryID; 217084afc48bSJason M. Bills bmcJournalLogEntryJson["Message"] = std::move(message); 217184afc48bSJason M. Bills bmcJournalLogEntryJson["EntryType"] = "Oem"; 217284afc48bSJason M. Bills bmcJournalLogEntryJson["Severity"] = severity <= 2 ? "Critical" 2173738c1e61SPatrick Williams : severity <= 4 ? "Warning" 217484afc48bSJason M. Bills : "OK"; 217584afc48bSJason M. Bills bmcJournalLogEntryJson["OemRecordFormat"] = "BMC Journal Entry"; 217684afc48bSJason M. Bills bmcJournalLogEntryJson["Created"] = std::move(entryTimeStr); 2177e1f26343SJason M. Bills return 0; 2178e1f26343SJason M. Bills } 2179e1f26343SJason M. Bills 21807e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntryCollection(App& app) 2181e1f26343SJason M. Bills { 21827e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/") 2183ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 2184002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2185002d39b4SEd Tanous [&app](const crow::Request& req, 2186002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2187c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 2188c937d2bfSEd Tanous .canDelegateTop = true, 2189c937d2bfSEd Tanous .canDelegateSkip = true, 2190c937d2bfSEd Tanous }; 2191c937d2bfSEd Tanous query_param::Query delegatedQuery; 2192c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 21933ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 2194193ad2faSJason M. Bills { 2195193ad2faSJason M. Bills return; 2196193ad2faSJason M. Bills } 21973648c8beSEd Tanous 21983648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 21995143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 22003648c8beSEd Tanous 22017e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 22027e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2203e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2204e1f26343SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 22050f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 22060f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 2207e1f26343SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries"; 2208e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2209e1f26343SJason M. Bills "Collection of BMC Journal Entries"; 22100fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2211e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 2212e1f26343SJason M. Bills 22137e860f15SJohn Edward Broadbent // Go through the journal and use the timestamp to create a 22147e860f15SJohn Edward Broadbent // unique ID for each entry 2215e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2216e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2217e1f26343SJason M. Bills if (ret < 0) 2218e1f26343SJason M. Bills { 2219002d39b4SEd Tanous BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 2220f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2221e1f26343SJason M. Bills return; 2222e1f26343SJason M. Bills } 22230fda0f12SGeorge Liu std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 22240fda0f12SGeorge Liu journalTmp, sd_journal_close); 2225e1f26343SJason M. Bills journalTmp = nullptr; 2226b01bf299SEd Tanous uint64_t entryCount = 0; 2227e85d6b16SJason M. Bills // Reset the unique ID on the first entry 2228e85d6b16SJason M. Bills bool firstEntry = true; 2229e1f26343SJason M. Bills SD_JOURNAL_FOREACH(journal.get()) 2230e1f26343SJason M. Bills { 2231193ad2faSJason M. Bills entryCount++; 22327e860f15SJohn Edward Broadbent // Handle paging using skip (number of entries to skip from 22337e860f15SJohn Edward Broadbent // the start) and top (number of entries to display) 22343648c8beSEd Tanous if (entryCount <= skip || entryCount > skip + top) 2235193ad2faSJason M. Bills { 2236193ad2faSJason M. Bills continue; 2237193ad2faSJason M. Bills } 2238193ad2faSJason M. Bills 223916428a1aSJason M. Bills std::string idStr; 2240e85d6b16SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2241e1f26343SJason M. Bills { 2242e1f26343SJason M. Bills continue; 2243e1f26343SJason M. Bills } 2244e85d6b16SJason M. Bills firstEntry = false; 2245e85d6b16SJason M. Bills 22463a48b3a2SJason M. Bills nlohmann::json::object_t bmcJournalLogEntry; 2247c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(idStr, journal.get(), 2248c4bf6374SJason M. Bills bmcJournalLogEntry) != 0) 2249e1f26343SJason M. Bills { 2250f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2251e1f26343SJason M. Bills return; 2252e1f26343SJason M. Bills } 22533a48b3a2SJason M. Bills logEntryArray.push_back(std::move(bmcJournalLogEntry)); 2254e1f26343SJason M. Bills } 2255193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 22563648c8beSEd Tanous if (skip + top < entryCount) 2257193ad2faSJason M. Bills { 2258193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 22590fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" + 22603648c8beSEd Tanous std::to_string(skip + top); 2261193ad2faSJason M. Bills } 22627e860f15SJohn Edward Broadbent }); 2263e1f26343SJason M. Bills } 2264e1f26343SJason M. Bills 22657e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntry(App& app) 2266e1f26343SJason M. Bills { 22677e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 22687e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/") 2269ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 22707e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 227145ca1b86SEd Tanous [&app](const crow::Request& req, 22727e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 22737e860f15SJohn Edward Broadbent const std::string& entryID) { 22743ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 227545ca1b86SEd Tanous { 227645ca1b86SEd Tanous return; 227745ca1b86SEd Tanous } 2278e1f26343SJason M. Bills // Convert the unique ID back to a timestamp to find the entry 2279e1f26343SJason M. Bills uint64_t ts = 0; 2280271584abSEd Tanous uint64_t index = 0; 22818d1b46d7Szhanghch05 if (!getTimestampFromID(asyncResp, entryID, ts, index)) 2282e1f26343SJason M. Bills { 228316428a1aSJason M. Bills return; 2284e1f26343SJason M. Bills } 2285e1f26343SJason M. Bills 2286e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2287e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2288e1f26343SJason M. Bills if (ret < 0) 2289e1f26343SJason M. Bills { 2290002d39b4SEd Tanous BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 2291f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2292e1f26343SJason M. Bills return; 2293e1f26343SJason M. Bills } 2294002d39b4SEd Tanous std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 2295002d39b4SEd Tanous journalTmp, sd_journal_close); 2296e1f26343SJason M. Bills journalTmp = nullptr; 22977e860f15SJohn Edward Broadbent // Go to the timestamp in the log and move to the entry at the 22987e860f15SJohn Edward Broadbent // index tracking the unique ID 2299af07e3f5SJason M. Bills std::string idStr; 2300af07e3f5SJason M. Bills bool firstEntry = true; 2301e1f26343SJason M. Bills ret = sd_journal_seek_realtime_usec(journal.get(), ts); 23022056b6d1SManojkiran Eda if (ret < 0) 23032056b6d1SManojkiran Eda { 23042056b6d1SManojkiran Eda BMCWEB_LOG_ERROR << "failed to seek to an entry in journal" 23052056b6d1SManojkiran Eda << strerror(-ret); 23062056b6d1SManojkiran Eda messages::internalError(asyncResp->res); 23072056b6d1SManojkiran Eda return; 23082056b6d1SManojkiran Eda } 2309271584abSEd Tanous for (uint64_t i = 0; i <= index; i++) 2310e1f26343SJason M. Bills { 2311e1f26343SJason M. Bills sd_journal_next(journal.get()); 2312af07e3f5SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2313af07e3f5SJason M. Bills { 2314af07e3f5SJason M. Bills messages::internalError(asyncResp->res); 2315af07e3f5SJason M. Bills return; 2316af07e3f5SJason M. Bills } 2317af07e3f5SJason M. Bills firstEntry = false; 2318af07e3f5SJason M. Bills } 2319c4bf6374SJason M. Bills // Confirm that the entry ID matches what was requested 2320af07e3f5SJason M. Bills if (idStr != entryID) 2321c4bf6374SJason M. Bills { 2322ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 2323c4bf6374SJason M. Bills return; 2324c4bf6374SJason M. Bills } 2325c4bf6374SJason M. Bills 23263a48b3a2SJason M. Bills nlohmann::json::object_t bmcJournalLogEntry; 2327c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(entryID, journal.get(), 23283a48b3a2SJason M. Bills bmcJournalLogEntry) != 0) 2329e1f26343SJason M. Bills { 2330f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2331e1f26343SJason M. Bills return; 2332e1f26343SJason M. Bills } 2333d405bb51SJason M. Bills asyncResp->res.jsonValue.update(bmcJournalLogEntry); 23347e860f15SJohn Edward Broadbent }); 2335c9bb6861Sraviteja-b } 2336c9bb6861Sraviteja-b 2337fdd26906SClaire Weinan inline void 2338fdd26906SClaire Weinan getDumpServiceInfo(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2339fdd26906SClaire Weinan const std::string& dumpType) 2340c9bb6861Sraviteja-b { 2341fdd26906SClaire Weinan std::string dumpPath; 2342fdd26906SClaire Weinan std::string overWritePolicy; 2343fdd26906SClaire Weinan bool collectDiagnosticDataSupported = false; 2344fdd26906SClaire Weinan 2345fdd26906SClaire Weinan if (dumpType == "BMC") 234645ca1b86SEd Tanous { 2347fdd26906SClaire Weinan dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump"; 2348fdd26906SClaire Weinan overWritePolicy = "WrapsWhenFull"; 2349fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2350fdd26906SClaire Weinan } 2351fdd26906SClaire Weinan else if (dumpType == "FaultLog") 2352fdd26906SClaire Weinan { 2353fdd26906SClaire Weinan dumpPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog"; 2354fdd26906SClaire Weinan overWritePolicy = "Unknown"; 2355fdd26906SClaire Weinan collectDiagnosticDataSupported = false; 2356fdd26906SClaire Weinan } 2357fdd26906SClaire Weinan else if (dumpType == "System") 2358fdd26906SClaire Weinan { 2359fdd26906SClaire Weinan dumpPath = "/redfish/v1/Systems/system/LogServices/Dump"; 2360fdd26906SClaire Weinan overWritePolicy = "WrapsWhenFull"; 2361fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2362fdd26906SClaire Weinan } 2363fdd26906SClaire Weinan else 2364fdd26906SClaire Weinan { 2365fdd26906SClaire Weinan BMCWEB_LOG_ERROR << "getDumpServiceInfo() invalid dump type: " 2366fdd26906SClaire Weinan << dumpType; 2367fdd26906SClaire Weinan messages::internalError(asyncResp->res); 236845ca1b86SEd Tanous return; 236945ca1b86SEd Tanous } 2370fdd26906SClaire Weinan 2371fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = dumpPath; 2372fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService"; 2373c9bb6861Sraviteja-b asyncResp->res.jsonValue["Name"] = "Dump LogService"; 2374fdd26906SClaire Weinan asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService"; 2375fdd26906SClaire Weinan asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename(); 2376fdd26906SClaire Weinan asyncResp->res.jsonValue["OverWritePolicy"] = std::move(overWritePolicy); 23777c8c4058STejas Patil 23787c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 23792b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 23800fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 23817c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 23827c8c4058STejas Patil redfishDateTimeOffset.second; 23837c8c4058STejas Patil 2384fdd26906SClaire Weinan asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries"; 2385002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 2386fdd26906SClaire Weinan dumpPath + "/Actions/LogService.ClearLog"; 2387fdd26906SClaire Weinan 2388fdd26906SClaire Weinan if (collectDiagnosticDataSupported) 2389fdd26906SClaire Weinan { 2390002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 23911476687dSEd Tanous ["target"] = 2392fdd26906SClaire Weinan dumpPath + "/Actions/LogService.CollectDiagnosticData"; 2393fdd26906SClaire Weinan } 2394c9bb6861Sraviteja-b } 2395c9bb6861Sraviteja-b 2396fdd26906SClaire Weinan inline void handleLogServicesDumpServiceGet( 2397fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2398fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 23997e860f15SJohn Edward Broadbent { 24003ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 240145ca1b86SEd Tanous { 240245ca1b86SEd Tanous return; 240345ca1b86SEd Tanous } 2404fdd26906SClaire Weinan getDumpServiceInfo(asyncResp, dumpType); 2405fdd26906SClaire Weinan } 2406c9bb6861Sraviteja-b 2407fdd26906SClaire Weinan inline void handleLogServicesDumpEntriesCollectionGet( 2408fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2409fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2410fdd26906SClaire Weinan { 2411fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2412fdd26906SClaire Weinan { 2413fdd26906SClaire Weinan return; 2414fdd26906SClaire Weinan } 2415fdd26906SClaire Weinan getDumpEntryCollection(asyncResp, dumpType); 2416fdd26906SClaire Weinan } 2417fdd26906SClaire Weinan 2418fdd26906SClaire Weinan inline void handleLogServicesDumpEntryGet( 2419fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2420fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2421fdd26906SClaire Weinan const std::string& dumpId) 2422fdd26906SClaire Weinan { 2423fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2424fdd26906SClaire Weinan { 2425fdd26906SClaire Weinan return; 2426fdd26906SClaire Weinan } 2427fdd26906SClaire Weinan getDumpEntryById(asyncResp, dumpId, dumpType); 2428fdd26906SClaire Weinan } 2429fdd26906SClaire Weinan 2430fdd26906SClaire Weinan inline void handleLogServicesDumpEntryDelete( 2431fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2432fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2433fdd26906SClaire Weinan const std::string& dumpId) 2434fdd26906SClaire Weinan { 2435fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2436fdd26906SClaire Weinan { 2437fdd26906SClaire Weinan return; 2438fdd26906SClaire Weinan } 2439fdd26906SClaire Weinan deleteDumpEntry(asyncResp, dumpId, dumpType); 2440fdd26906SClaire Weinan } 2441fdd26906SClaire Weinan 2442fdd26906SClaire Weinan inline void handleLogServicesDumpCollectDiagnosticDataPost( 2443fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2444fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2445fdd26906SClaire Weinan { 2446fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2447fdd26906SClaire Weinan { 2448fdd26906SClaire Weinan return; 2449fdd26906SClaire Weinan } 2450fdd26906SClaire Weinan createDump(asyncResp, req, dumpType); 2451fdd26906SClaire Weinan } 2452fdd26906SClaire Weinan 2453fdd26906SClaire Weinan inline void handleLogServicesDumpClearLogPost( 2454fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2455fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 2456fdd26906SClaire Weinan { 2457fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2458fdd26906SClaire Weinan { 2459fdd26906SClaire Weinan return; 2460fdd26906SClaire Weinan } 2461fdd26906SClaire Weinan clearDump(asyncResp, dumpType); 2462fdd26906SClaire Weinan } 2463fdd26906SClaire Weinan 2464fdd26906SClaire Weinan inline void requestRoutesBMCDumpService(App& app) 2465fdd26906SClaire Weinan { 2466fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/") 2467fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 2468fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2469fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "BMC")); 2470fdd26906SClaire Weinan } 2471fdd26906SClaire Weinan 2472fdd26906SClaire Weinan inline void requestRoutesBMCDumpEntryCollection(App& app) 2473fdd26906SClaire Weinan { 2474fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/") 2475fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 2476fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2477fdd26906SClaire Weinan handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC")); 2478c9bb6861Sraviteja-b } 2479c9bb6861Sraviteja-b 24807e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app) 2481c9bb6861Sraviteja-b { 24827e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 24837e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2484ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 2485fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2486fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "BMC")); 2487fdd26906SClaire Weinan 24887e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 24897e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2490ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 2491fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 2492fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "BMC")); 2493c9bb6861Sraviteja-b } 2494c9bb6861Sraviteja-b 24957e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app) 2496c9bb6861Sraviteja-b { 24970fda0f12SGeorge Liu BMCWEB_ROUTE( 24980fda0f12SGeorge Liu app, 24990fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2500ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 25017e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 2502fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost, 2503fdd26906SClaire Weinan std::ref(app), "BMC")); 2504a43be80fSAsmitha Karunanithi } 2505a43be80fSAsmitha Karunanithi 25067e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app) 250780319af1SAsmitha Karunanithi { 25080fda0f12SGeorge Liu BMCWEB_ROUTE( 25090fda0f12SGeorge Liu app, 25100fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog/") 2511ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 2512fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 2513fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "BMC")); 251445ca1b86SEd Tanous } 2515fdd26906SClaire Weinan 2516fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpService(App& app) 2517fdd26906SClaire Weinan { 2518fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/") 2519fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 2520fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2521fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "FaultLog")); 2522fdd26906SClaire Weinan } 2523fdd26906SClaire Weinan 2524fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntryCollection(App& app) 2525fdd26906SClaire Weinan { 2526fdd26906SClaire Weinan BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/") 2527fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 2528fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 2529fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpEntriesCollectionGet, 2530fdd26906SClaire Weinan std::ref(app), "FaultLog")); 2531fdd26906SClaire Weinan } 2532fdd26906SClaire Weinan 2533fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntry(App& app) 2534fdd26906SClaire Weinan { 2535fdd26906SClaire Weinan BMCWEB_ROUTE(app, 2536fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 2537fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntry) 2538fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2539fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "FaultLog")); 2540fdd26906SClaire Weinan 2541fdd26906SClaire Weinan BMCWEB_ROUTE(app, 2542fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/") 2543fdd26906SClaire Weinan .privileges(redfish::privileges::deleteLogEntry) 2544fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 2545fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog")); 2546fdd26906SClaire Weinan } 2547fdd26906SClaire Weinan 2548fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpClear(App& app) 2549fdd26906SClaire Weinan { 2550fdd26906SClaire Weinan BMCWEB_ROUTE( 2551fdd26906SClaire Weinan app, 2552fdd26906SClaire Weinan "/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog/") 2553fdd26906SClaire Weinan .privileges(redfish::privileges::postLogService) 2554fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 2555fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog")); 25565cb1dd27SAsmitha Karunanithi } 25575cb1dd27SAsmitha Karunanithi 25587e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app) 25595cb1dd27SAsmitha Karunanithi { 25607e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/") 2561ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 2562002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2563002d39b4SEd Tanous [&app](const crow::Request& req, 2564002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 25653ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 25667e860f15SJohn Edward Broadbent { 256745ca1b86SEd Tanous return; 256845ca1b86SEd Tanous } 25695cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.id"] = 25705cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump"; 25715cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 2572d337bb72SAsmitha Karunanithi "#LogService.v1_2_0.LogService"; 25735cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = "Dump LogService"; 257445ca1b86SEd Tanous asyncResp->res.jsonValue["Description"] = "System Dump LogService"; 25755cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = "Dump"; 25765cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 25777c8c4058STejas Patil 25787c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 25792b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 258045ca1b86SEd Tanous asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 25817c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 25827c8c4058STejas Patil redfishDateTimeOffset.second; 25837c8c4058STejas Patil 25841476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 25851476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Dump/Entries"; 2586002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 25871476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog"; 25881476687dSEd Tanous 2589002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 25901476687dSEd Tanous ["target"] = 25911476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData"; 25927e860f15SJohn Edward Broadbent }); 25935cb1dd27SAsmitha Karunanithi } 25945cb1dd27SAsmitha Karunanithi 25957e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app) 25967e860f15SJohn Edward Broadbent { 25977e860f15SJohn Edward Broadbent 25985cb1dd27SAsmitha Karunanithi /** 25995cb1dd27SAsmitha Karunanithi * Functions triggers appropriate requests on DBus 26005cb1dd27SAsmitha Karunanithi */ 2601b2a3289dSAsmitha Karunanithi BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/") 2602ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 26037e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 260445ca1b86SEd Tanous [&app](const crow::Request& req, 2605864d6a17SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 26063ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 260745ca1b86SEd Tanous { 260845ca1b86SEd Tanous return; 260945ca1b86SEd Tanous } 26105cb1dd27SAsmitha Karunanithi getDumpEntryCollection(asyncResp, "System"); 26117e860f15SJohn Edward Broadbent }); 26125cb1dd27SAsmitha Karunanithi } 26135cb1dd27SAsmitha Karunanithi 26147e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app) 26155cb1dd27SAsmitha Karunanithi { 26167e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 2617864d6a17SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/") 2618ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 2619ed398213SEd Tanous 26207e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 262145ca1b86SEd Tanous [&app](const crow::Request& req, 26227e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 26237e860f15SJohn Edward Broadbent const std::string& param) { 26243ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2625c7a6d660SClaire Weinan { 2626c7a6d660SClaire Weinan return; 2627c7a6d660SClaire Weinan } 2628c7a6d660SClaire Weinan getDumpEntryById(asyncResp, param, "System"); 26297e860f15SJohn Edward Broadbent }); 26308d1b46d7Szhanghch05 26317e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 2632864d6a17SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/") 2633ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 26347e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::delete_)( 263545ca1b86SEd Tanous [&app](const crow::Request& req, 26367e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 26377e860f15SJohn Edward Broadbent const std::string& param) { 26383ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 263945ca1b86SEd Tanous { 264045ca1b86SEd Tanous return; 264145ca1b86SEd Tanous } 26427e860f15SJohn Edward Broadbent deleteDumpEntry(asyncResp, param, "system"); 26437e860f15SJohn Edward Broadbent }); 26445cb1dd27SAsmitha Karunanithi } 2645c9bb6861Sraviteja-b 26467e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app) 2647c9bb6861Sraviteja-b { 26480fda0f12SGeorge Liu BMCWEB_ROUTE( 26490fda0f12SGeorge Liu app, 26500fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2651ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 26527e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 265345ca1b86SEd Tanous [&app](const crow::Request& req, 265445ca1b86SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 26553ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 265645ca1b86SEd Tanous { 265745ca1b86SEd Tanous return; 265845ca1b86SEd Tanous } 265945ca1b86SEd Tanous createDump(asyncResp, req, "System"); 266045ca1b86SEd Tanous }); 2661a43be80fSAsmitha Karunanithi } 2662a43be80fSAsmitha Karunanithi 26637e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app) 2664a43be80fSAsmitha Karunanithi { 26650fda0f12SGeorge Liu BMCWEB_ROUTE( 26660fda0f12SGeorge Liu app, 26670fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog/") 2668ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 26697e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 267045ca1b86SEd Tanous [&app](const crow::Request& req, 26717e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 26727e860f15SJohn Edward Broadbent 267345ca1b86SEd Tanous { 26743ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 267545ca1b86SEd Tanous { 267645ca1b86SEd Tanous return; 267745ca1b86SEd Tanous } 267845ca1b86SEd Tanous clearDump(asyncResp, "System"); 267945ca1b86SEd Tanous }); 2680013487e5Sraviteja-b } 2681013487e5Sraviteja-b 26827e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app) 26831da66f75SEd Tanous { 26843946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 26853946028dSAppaRao Puli // method for security reasons. 26861da66f75SEd Tanous /** 26871da66f75SEd Tanous * Functions triggers appropriate requests on DBus 26881da66f75SEd Tanous */ 26897e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Crashdump/") 2690ed398213SEd Tanous // This is incorrect, should be: 2691ed398213SEd Tanous //.privileges(redfish::privileges::getLogService) 2692432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 2693002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2694002d39b4SEd Tanous [&app](const crow::Request& req, 2695002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 26963ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 269745ca1b86SEd Tanous { 269845ca1b86SEd Tanous return; 269945ca1b86SEd Tanous } 27007e860f15SJohn Edward Broadbent // Copy over the static data to include the entries added by 27017e860f15SJohn Edward Broadbent // SubRoute 27020f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2703424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"; 2704e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 27058e6c099aSJason M. Bills "#LogService.v1_2_0.LogService"; 27064f50ae4bSGunnar Mills asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service"; 27074f50ae4bSGunnar Mills asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service"; 27084f50ae4bSGunnar Mills asyncResp->res.jsonValue["Id"] = "Oem Crashdump"; 2709e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 2710e1f26343SJason M. Bills asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; 27117c8c4058STejas Patil 27127c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 27132b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 27147c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 27157c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 27167c8c4058STejas Patil redfishDateTimeOffset.second; 27177c8c4058STejas Patil 27181476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 27191476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 2720002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] = 27211476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog"; 2722002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 27231476687dSEd Tanous ["target"] = 27241476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData"; 27257e860f15SJohn Edward Broadbent }); 27261da66f75SEd Tanous } 27271da66f75SEd Tanous 27287e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app) 27295b61b5e8SJason M. Bills { 27300fda0f12SGeorge Liu BMCWEB_ROUTE( 27310fda0f12SGeorge Liu app, 27320fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog/") 2733ed398213SEd Tanous // This is incorrect, should be: 2734ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 2735432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 27367e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 273745ca1b86SEd Tanous [&app](const crow::Request& req, 27387e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 27393ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 274045ca1b86SEd Tanous { 274145ca1b86SEd Tanous return; 274245ca1b86SEd Tanous } 27435b61b5e8SJason M. Bills crow::connections::systemBus->async_method_call( 27445b61b5e8SJason M. Bills [asyncResp](const boost::system::error_code ec, 2745cb13a392SEd Tanous const std::string&) { 27465b61b5e8SJason M. Bills if (ec) 27475b61b5e8SJason M. Bills { 27485b61b5e8SJason M. Bills messages::internalError(asyncResp->res); 27495b61b5e8SJason M. Bills return; 27505b61b5e8SJason M. Bills } 27515b61b5e8SJason M. Bills messages::success(asyncResp->res); 27525b61b5e8SJason M. Bills }, 2753002d39b4SEd Tanous crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll"); 27547e860f15SJohn Edward Broadbent }); 27555b61b5e8SJason M. Bills } 27565b61b5e8SJason M. Bills 27578d1b46d7Szhanghch05 static void 27588d1b46d7Szhanghch05 logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 27598d1b46d7Szhanghch05 const std::string& logID, nlohmann::json& logEntryJson) 2760e855dd28SJason M. Bills { 2761043a0536SJohnathan Mantey auto getStoredLogCallback = 2762b9d36b47SEd Tanous [asyncResp, logID, 2763b9d36b47SEd Tanous &logEntryJson](const boost::system::error_code ec, 2764b9d36b47SEd Tanous const dbus::utility::DBusPropertiesMap& params) { 2765e855dd28SJason M. Bills if (ec) 2766e855dd28SJason M. Bills { 2767e855dd28SJason M. Bills BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 27681ddcf01aSJason M. Bills if (ec.value() == 27691ddcf01aSJason M. Bills boost::system::linux_error::bad_request_descriptor) 27701ddcf01aSJason M. Bills { 2771002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 27721ddcf01aSJason M. Bills } 27731ddcf01aSJason M. Bills else 27741ddcf01aSJason M. Bills { 2775e855dd28SJason M. Bills messages::internalError(asyncResp->res); 27761ddcf01aSJason M. Bills } 2777e855dd28SJason M. Bills return; 2778e855dd28SJason M. Bills } 2779043a0536SJohnathan Mantey 2780043a0536SJohnathan Mantey std::string timestamp{}; 2781043a0536SJohnathan Mantey std::string filename{}; 2782043a0536SJohnathan Mantey std::string logfile{}; 27832c70f800SEd Tanous parseCrashdumpParameters(params, filename, timestamp, logfile); 2784043a0536SJohnathan Mantey 2785043a0536SJohnathan Mantey if (filename.empty() || timestamp.empty()) 2786e855dd28SJason M. Bills { 2787002d39b4SEd Tanous messages::resourceMissingAtURI(asyncResp->res, 2788002d39b4SEd Tanous crow::utility::urlFromPieces(logID)); 2789e855dd28SJason M. Bills return; 2790e855dd28SJason M. Bills } 2791e855dd28SJason M. Bills 2792043a0536SJohnathan Mantey std::string crashdumpURI = 2793e855dd28SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + 2794043a0536SJohnathan Mantey logID + "/" + filename; 279584afc48bSJason M. Bills nlohmann::json::object_t logEntry; 279684afc48bSJason M. Bills logEntry["@odata.type"] = "#LogEntry.v1_7_0.LogEntry"; 279784afc48bSJason M. Bills logEntry["@odata.id"] = 279884afc48bSJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + logID; 279984afc48bSJason M. Bills logEntry["Name"] = "CPU Crashdump"; 280084afc48bSJason M. Bills logEntry["Id"] = logID; 280184afc48bSJason M. Bills logEntry["EntryType"] = "Oem"; 280284afc48bSJason M. Bills logEntry["AdditionalDataURI"] = std::move(crashdumpURI); 280384afc48bSJason M. Bills logEntry["DiagnosticDataType"] = "OEM"; 280484afc48bSJason M. Bills logEntry["OEMDiagnosticDataType"] = "PECICrashdump"; 280584afc48bSJason M. Bills logEntry["Created"] = std::move(timestamp); 28062b20ef6eSJason M. Bills 28072b20ef6eSJason M. Bills // If logEntryJson references an array of LogEntry resources 28082b20ef6eSJason M. Bills // ('Members' list), then push this as a new entry, otherwise set it 28092b20ef6eSJason M. Bills // directly 28102b20ef6eSJason M. Bills if (logEntryJson.is_array()) 28112b20ef6eSJason M. Bills { 28122b20ef6eSJason M. Bills logEntryJson.push_back(logEntry); 28132b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 28142b20ef6eSJason M. Bills logEntryJson.size(); 28152b20ef6eSJason M. Bills } 28162b20ef6eSJason M. Bills else 28172b20ef6eSJason M. Bills { 2818d405bb51SJason M. Bills logEntryJson.update(logEntry); 28192b20ef6eSJason M. Bills } 2820e855dd28SJason M. Bills }; 2821e855dd28SJason M. Bills crow::connections::systemBus->async_method_call( 28225b61b5e8SJason M. Bills std::move(getStoredLogCallback), crashdumpObject, 28235b61b5e8SJason M. Bills crashdumpPath + std::string("/") + logID, 2824043a0536SJohnathan Mantey "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface); 2825e855dd28SJason M. Bills } 2826e855dd28SJason M. Bills 28277e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app) 28281da66f75SEd Tanous { 28293946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 28303946028dSAppaRao Puli // method for security reasons. 28311da66f75SEd Tanous /** 28321da66f75SEd Tanous * Functions triggers appropriate requests on DBus 28331da66f75SEd Tanous */ 28347e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 28357e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/") 2836ed398213SEd Tanous // This is incorrect, should be. 2837ed398213SEd Tanous //.privileges(redfish::privileges::postLogEntryCollection) 2838432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 2839002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 2840002d39b4SEd Tanous [&app](const crow::Request& req, 2841002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 28423ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 284345ca1b86SEd Tanous { 284445ca1b86SEd Tanous return; 284545ca1b86SEd Tanous } 28462b20ef6eSJason M. Bills crow::connections::systemBus->async_method_call( 28472b20ef6eSJason M. Bills [asyncResp](const boost::system::error_code ec, 28482b20ef6eSJason M. Bills const std::vector<std::string>& resp) { 28491da66f75SEd Tanous if (ec) 28501da66f75SEd Tanous { 28511da66f75SEd Tanous if (ec.value() != 28521da66f75SEd Tanous boost::system::errc::no_such_file_or_directory) 28531da66f75SEd Tanous { 28541da66f75SEd Tanous BMCWEB_LOG_DEBUG << "failed to get entries ec: " 28551da66f75SEd Tanous << ec.message(); 2856f12894f8SJason M. Bills messages::internalError(asyncResp->res); 28571da66f75SEd Tanous return; 28581da66f75SEd Tanous } 28591da66f75SEd Tanous } 2860e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 28611da66f75SEd Tanous "#LogEntryCollection.LogEntryCollection"; 28620f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2863424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 2864002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries"; 2865e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2866424c4176SJason M. Bills "Collection of Crashdump Entries"; 2867002d39b4SEd Tanous asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 2868a2dd60a6SBrandon Kim asyncResp->res.jsonValue["Members@odata.count"] = 0; 28692b20ef6eSJason M. Bills 28702b20ef6eSJason M. Bills for (const std::string& path : resp) 28711da66f75SEd Tanous { 28722b20ef6eSJason M. Bills const sdbusplus::message::object_path objPath(path); 2873e855dd28SJason M. Bills // Get the log ID 28742b20ef6eSJason M. Bills std::string logID = objPath.filename(); 28752b20ef6eSJason M. Bills if (logID.empty()) 28761da66f75SEd Tanous { 2877e855dd28SJason M. Bills continue; 28781da66f75SEd Tanous } 2879e855dd28SJason M. Bills // Add the log entry to the array 28802b20ef6eSJason M. Bills logCrashdumpEntry(asyncResp, logID, 28812b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members"]); 28821da66f75SEd Tanous } 28832b20ef6eSJason M. Bills }, 28841da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", 28851da66f75SEd Tanous "/xyz/openbmc_project/object_mapper", 28861da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0, 28875b61b5e8SJason M. Bills std::array<const char*, 1>{crashdumpInterface}); 28887e860f15SJohn Edward Broadbent }); 28891da66f75SEd Tanous } 28901da66f75SEd Tanous 28917e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app) 28921da66f75SEd Tanous { 28933946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 28943946028dSAppaRao Puli // method for security reasons. 28951da66f75SEd Tanous 28967e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 28977e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/") 2898ed398213SEd Tanous // this is incorrect, should be 2899ed398213SEd Tanous // .privileges(redfish::privileges::getLogEntry) 2900432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 29017e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 290245ca1b86SEd Tanous [&app](const crow::Request& req, 29037e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 29047e860f15SJohn Edward Broadbent const std::string& param) { 29053ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 290645ca1b86SEd Tanous { 290745ca1b86SEd Tanous return; 290845ca1b86SEd Tanous } 29097e860f15SJohn Edward Broadbent const std::string& logID = param; 2910e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue); 29117e860f15SJohn Edward Broadbent }); 2912e855dd28SJason M. Bills } 2913e855dd28SJason M. Bills 29147e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app) 2915e855dd28SJason M. Bills { 29163946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 29173946028dSAppaRao Puli // method for security reasons. 29187e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 29197e860f15SJohn Edward Broadbent app, 29207e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/<str>/") 2921ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 29227e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 2923a4ce114aSNan Zhou [](const crow::Request& req, 29247e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 29257e860f15SJohn Edward Broadbent const std::string& logID, const std::string& fileName) { 29262a9beeedSShounak Mitra // Do not call getRedfishRoute here since the crashdump file is not a 29272a9beeedSShounak Mitra // Redfish resource. 2928043a0536SJohnathan Mantey auto getStoredLogCallback = 2929002d39b4SEd Tanous [asyncResp, logID, fileName, url(boost::urls::url(req.urlView))]( 2930abf2add6SEd Tanous const boost::system::error_code ec, 2931002d39b4SEd Tanous const std::vector< 2932002d39b4SEd Tanous std::pair<std::string, dbus::utility::DbusVariantType>>& 29337e860f15SJohn Edward Broadbent resp) { 29341da66f75SEd Tanous if (ec) 29351da66f75SEd Tanous { 2936002d39b4SEd Tanous BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 2937f12894f8SJason M. Bills messages::internalError(asyncResp->res); 29381da66f75SEd Tanous return; 29391da66f75SEd Tanous } 2940e855dd28SJason M. Bills 2941043a0536SJohnathan Mantey std::string dbusFilename{}; 2942043a0536SJohnathan Mantey std::string dbusTimestamp{}; 2943043a0536SJohnathan Mantey std::string dbusFilepath{}; 2944043a0536SJohnathan Mantey 2945002d39b4SEd Tanous parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp, 2946002d39b4SEd Tanous dbusFilepath); 2947043a0536SJohnathan Mantey 2948043a0536SJohnathan Mantey if (dbusFilename.empty() || dbusTimestamp.empty() || 2949043a0536SJohnathan Mantey dbusFilepath.empty()) 29501da66f75SEd Tanous { 2951ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, url); 29521da66f75SEd Tanous return; 29531da66f75SEd Tanous } 2954e855dd28SJason M. Bills 2955043a0536SJohnathan Mantey // Verify the file name parameter is correct 2956043a0536SJohnathan Mantey if (fileName != dbusFilename) 2957043a0536SJohnathan Mantey { 2958ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, url); 2959043a0536SJohnathan Mantey return; 2960043a0536SJohnathan Mantey } 2961043a0536SJohnathan Mantey 2962043a0536SJohnathan Mantey if (!std::filesystem::exists(dbusFilepath)) 2963043a0536SJohnathan Mantey { 2964ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, url); 2965043a0536SJohnathan Mantey return; 2966043a0536SJohnathan Mantey } 2967002d39b4SEd Tanous std::ifstream ifs(dbusFilepath, std::ios::in | std::ios::binary); 2968002d39b4SEd Tanous asyncResp->res.body() = 2969002d39b4SEd Tanous std::string(std::istreambuf_iterator<char>{ifs}, {}); 2970043a0536SJohnathan Mantey 29717e860f15SJohn Edward Broadbent // Configure this to be a file download when accessed 29727e860f15SJohn Edward Broadbent // from a browser 2973d9f6c621SEd Tanous asyncResp->res.addHeader( 2974d9f6c621SEd Tanous boost::beast::http::field::content_disposition, "attachment"); 29751da66f75SEd Tanous }; 29761da66f75SEd Tanous crow::connections::systemBus->async_method_call( 29775b61b5e8SJason M. Bills std::move(getStoredLogCallback), crashdumpObject, 29785b61b5e8SJason M. Bills crashdumpPath + std::string("/") + logID, 2979002d39b4SEd Tanous "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface); 29807e860f15SJohn Edward Broadbent }); 29811da66f75SEd Tanous } 29821da66f75SEd Tanous 2983c5a4c82aSJason M. Bills enum class OEMDiagnosticType 2984c5a4c82aSJason M. Bills { 2985c5a4c82aSJason M. Bills onDemand, 2986c5a4c82aSJason M. Bills telemetry, 2987c5a4c82aSJason M. Bills invalid, 2988c5a4c82aSJason M. Bills }; 2989c5a4c82aSJason M. Bills 2990f7725d79SEd Tanous inline OEMDiagnosticType 2991f7725d79SEd Tanous getOEMDiagnosticType(const std::string_view& oemDiagStr) 2992c5a4c82aSJason M. Bills { 2993c5a4c82aSJason M. Bills if (oemDiagStr == "OnDemand") 2994c5a4c82aSJason M. Bills { 2995c5a4c82aSJason M. Bills return OEMDiagnosticType::onDemand; 2996c5a4c82aSJason M. Bills } 2997c5a4c82aSJason M. Bills if (oemDiagStr == "Telemetry") 2998c5a4c82aSJason M. Bills { 2999c5a4c82aSJason M. Bills return OEMDiagnosticType::telemetry; 3000c5a4c82aSJason M. Bills } 3001c5a4c82aSJason M. Bills 3002c5a4c82aSJason M. Bills return OEMDiagnosticType::invalid; 3003c5a4c82aSJason M. Bills } 3004c5a4c82aSJason M. Bills 30057e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app) 30061da66f75SEd Tanous { 30073946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 30083946028dSAppaRao Puli // method for security reasons. 30090fda0f12SGeorge Liu BMCWEB_ROUTE( 30100fda0f12SGeorge Liu app, 30110fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/") 3012ed398213SEd Tanous // The below is incorrect; Should be ConfigureManager 3013ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3014432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 3015002d39b4SEd Tanous .methods(boost::beast::http::verb::post)( 3016002d39b4SEd Tanous [&app](const crow::Request& req, 30177e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 30183ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 301945ca1b86SEd Tanous { 302045ca1b86SEd Tanous return; 302145ca1b86SEd Tanous } 30228e6c099aSJason M. Bills std::string diagnosticDataType; 30238e6c099aSJason M. Bills std::string oemDiagnosticDataType; 302415ed6780SWilly Tu if (!redfish::json_util::readJsonAction( 3025002d39b4SEd Tanous req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 3026002d39b4SEd Tanous "OEMDiagnosticDataType", oemDiagnosticDataType)) 30278e6c099aSJason M. Bills { 30288e6c099aSJason M. Bills return; 30298e6c099aSJason M. Bills } 30308e6c099aSJason M. Bills 30318e6c099aSJason M. Bills if (diagnosticDataType != "OEM") 30328e6c099aSJason M. Bills { 30338e6c099aSJason M. Bills BMCWEB_LOG_ERROR 30348e6c099aSJason M. Bills << "Only OEM DiagnosticDataType supported for Crashdump"; 30358e6c099aSJason M. Bills messages::actionParameterValueFormatError( 30368e6c099aSJason M. Bills asyncResp->res, diagnosticDataType, "DiagnosticDataType", 30378e6c099aSJason M. Bills "CollectDiagnosticData"); 30388e6c099aSJason M. Bills return; 30398e6c099aSJason M. Bills } 30408e6c099aSJason M. Bills 3041c5a4c82aSJason M. Bills OEMDiagnosticType oemDiagType = 3042c5a4c82aSJason M. Bills getOEMDiagnosticType(oemDiagnosticDataType); 3043c5a4c82aSJason M. Bills 3044c5a4c82aSJason M. Bills std::string iface; 3045c5a4c82aSJason M. Bills std::string method; 3046c5a4c82aSJason M. Bills std::string taskMatchStr; 3047c5a4c82aSJason M. Bills if (oemDiagType == OEMDiagnosticType::onDemand) 3048c5a4c82aSJason M. Bills { 3049c5a4c82aSJason M. Bills iface = crashdumpOnDemandInterface; 3050c5a4c82aSJason M. Bills method = "GenerateOnDemandLog"; 3051c5a4c82aSJason M. Bills taskMatchStr = "type='signal'," 3052c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 3053c5a4c82aSJason M. Bills "member='PropertiesChanged'," 3054c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 3055c5a4c82aSJason M. Bills } 3056c5a4c82aSJason M. Bills else if (oemDiagType == OEMDiagnosticType::telemetry) 3057c5a4c82aSJason M. Bills { 3058c5a4c82aSJason M. Bills iface = crashdumpTelemetryInterface; 3059c5a4c82aSJason M. Bills method = "GenerateTelemetryLog"; 3060c5a4c82aSJason M. Bills taskMatchStr = "type='signal'," 3061c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 3062c5a4c82aSJason M. Bills "member='PropertiesChanged'," 3063c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 3064c5a4c82aSJason M. Bills } 3065c5a4c82aSJason M. Bills else 3066c5a4c82aSJason M. Bills { 3067c5a4c82aSJason M. Bills BMCWEB_LOG_ERROR << "Unsupported OEMDiagnosticDataType: " 3068c5a4c82aSJason M. Bills << oemDiagnosticDataType; 3069c5a4c82aSJason M. Bills messages::actionParameterValueFormatError( 3070002d39b4SEd Tanous asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType", 3071002d39b4SEd Tanous "CollectDiagnosticData"); 3072c5a4c82aSJason M. Bills return; 3073c5a4c82aSJason M. Bills } 3074c5a4c82aSJason M. Bills 3075c5a4c82aSJason M. Bills auto collectCrashdumpCallback = 3076c5a4c82aSJason M. Bills [asyncResp, payload(task::Payload(req)), 3077c5a4c82aSJason M. Bills taskMatchStr](const boost::system::error_code ec, 307898be3e39SEd Tanous const std::string&) mutable { 30791da66f75SEd Tanous if (ec) 30801da66f75SEd Tanous { 3081002d39b4SEd Tanous if (ec.value() == boost::system::errc::operation_not_supported) 30821da66f75SEd Tanous { 3083f12894f8SJason M. Bills messages::resourceInStandby(asyncResp->res); 30841da66f75SEd Tanous } 30854363d3b2SJason M. Bills else if (ec.value() == 30864363d3b2SJason M. Bills boost::system::errc::device_or_resource_busy) 30874363d3b2SJason M. Bills { 3088002d39b4SEd Tanous messages::serviceTemporarilyUnavailable(asyncResp->res, 3089002d39b4SEd Tanous "60"); 30904363d3b2SJason M. Bills } 30911da66f75SEd Tanous else 30921da66f75SEd Tanous { 3093f12894f8SJason M. Bills messages::internalError(asyncResp->res); 30941da66f75SEd Tanous } 30951da66f75SEd Tanous return; 30961da66f75SEd Tanous } 3097002d39b4SEd Tanous std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 309859d494eeSPatrick Williams [](boost::system::error_code err, sdbusplus::message_t&, 3099002d39b4SEd Tanous const std::shared_ptr<task::TaskData>& taskData) { 310066afe4faSJames Feist if (!err) 310166afe4faSJames Feist { 3102002d39b4SEd Tanous taskData->messages.emplace_back(messages::taskCompletedOK( 3103e5d5006bSJames Feist std::to_string(taskData->index))); 3104831d6b09SJames Feist taskData->state = "Completed"; 310566afe4faSJames Feist } 310632898ceaSJames Feist return task::completed; 310766afe4faSJames Feist }, 3108c5a4c82aSJason M. Bills taskMatchStr); 3109c5a4c82aSJason M. Bills 311046229577SJames Feist task->startTimer(std::chrono::minutes(5)); 311146229577SJames Feist task->populateResp(asyncResp->res); 311298be3e39SEd Tanous task->payload.emplace(std::move(payload)); 31131da66f75SEd Tanous }; 31148e6c099aSJason M. Bills 31151da66f75SEd Tanous crow::connections::systemBus->async_method_call( 3116002d39b4SEd Tanous std::move(collectCrashdumpCallback), crashdumpObject, crashdumpPath, 3117002d39b4SEd Tanous iface, method); 31187e860f15SJohn Edward Broadbent }); 31196eda7685SKenny L. Ku } 31206eda7685SKenny L. Ku 3121cb92c03bSAndrew Geissler /** 3122cb92c03bSAndrew Geissler * DBusLogServiceActionsClear class supports POST method for ClearLog action. 3123cb92c03bSAndrew Geissler */ 31247e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app) 3125cb92c03bSAndrew Geissler { 3126cb92c03bSAndrew Geissler /** 3127cb92c03bSAndrew Geissler * Function handles POST method request. 3128cb92c03bSAndrew Geissler * The Clear Log actions does not require any parameter.The action deletes 3129cb92c03bSAndrew Geissler * all entries found in the Entries collection for this Log Service. 3130cb92c03bSAndrew Geissler */ 31317e860f15SJohn Edward Broadbent 31320fda0f12SGeorge Liu BMCWEB_ROUTE( 31330fda0f12SGeorge Liu app, 31340fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog/") 3135ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 31367e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 313745ca1b86SEd Tanous [&app](const crow::Request& req, 31387e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 31393ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 314045ca1b86SEd Tanous { 314145ca1b86SEd Tanous return; 314245ca1b86SEd Tanous } 3143cb92c03bSAndrew Geissler BMCWEB_LOG_DEBUG << "Do delete all entries."; 3144cb92c03bSAndrew Geissler 3145cb92c03bSAndrew Geissler // Process response from Logging service. 3146002d39b4SEd Tanous auto respHandler = [asyncResp](const boost::system::error_code ec) { 3147002d39b4SEd Tanous BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done"; 3148cb92c03bSAndrew Geissler if (ec) 3149cb92c03bSAndrew Geissler { 3150cb92c03bSAndrew Geissler // TODO Handle for specific error code 3151002d39b4SEd Tanous BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec; 3152cb92c03bSAndrew Geissler asyncResp->res.result( 3153cb92c03bSAndrew Geissler boost::beast::http::status::internal_server_error); 3154cb92c03bSAndrew Geissler return; 3155cb92c03bSAndrew Geissler } 3156cb92c03bSAndrew Geissler 3157002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::no_content); 3158cb92c03bSAndrew Geissler }; 3159cb92c03bSAndrew Geissler 3160cb92c03bSAndrew Geissler // Make call to Logging service to request Clear Log 3161cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 31622c70f800SEd Tanous respHandler, "xyz.openbmc_project.Logging", 3163cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging", 3164cb92c03bSAndrew Geissler "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 31657e860f15SJohn Edward Broadbent }); 3166cb92c03bSAndrew Geissler } 3167a3316fc6SZhikuiRen 3168a3316fc6SZhikuiRen /**************************************************** 3169a3316fc6SZhikuiRen * Redfish PostCode interfaces 3170a3316fc6SZhikuiRen * using DBUS interface: getPostCodesTS 3171a3316fc6SZhikuiRen ******************************************************/ 31727e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesLogService(App& app) 3173a3316fc6SZhikuiRen { 31747e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/PostCodes/") 3175ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 3176002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 3177002d39b4SEd Tanous [&app](const crow::Request& req, 3178002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 31793ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 318045ca1b86SEd Tanous { 318145ca1b86SEd Tanous return; 318245ca1b86SEd Tanous } 31831476687dSEd Tanous 31841476687dSEd Tanous asyncResp->res.jsonValue["@odata.id"] = 31851476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes"; 31861476687dSEd Tanous asyncResp->res.jsonValue["@odata.type"] = 31871476687dSEd Tanous "#LogService.v1_1_0.LogService"; 31881476687dSEd Tanous asyncResp->res.jsonValue["Name"] = "POST Code Log Service"; 31891476687dSEd Tanous asyncResp->res.jsonValue["Description"] = "POST Code Log Service"; 31901476687dSEd Tanous asyncResp->res.jsonValue["Id"] = "BIOS POST Code Log"; 31911476687dSEd Tanous asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 31921476687dSEd Tanous asyncResp->res.jsonValue["Entries"]["@odata.id"] = 31931476687dSEd Tanous "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 31947c8c4058STejas Patil 31957c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 31962b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 31970fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 31987c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 31997c8c4058STejas Patil redfishDateTimeOffset.second; 32007c8c4058STejas Patil 3201a3316fc6SZhikuiRen asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 32027e860f15SJohn Edward Broadbent {"target", 32030fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog"}}; 32047e860f15SJohn Edward Broadbent }); 3205a3316fc6SZhikuiRen } 3206a3316fc6SZhikuiRen 32077e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesClear(App& app) 3208a3316fc6SZhikuiRen { 32090fda0f12SGeorge Liu BMCWEB_ROUTE( 32100fda0f12SGeorge Liu app, 32110fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog/") 3212ed398213SEd Tanous // The following privilege is incorrect; It should be ConfigureManager 3213ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3214432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 32157e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 321645ca1b86SEd Tanous [&app](const crow::Request& req, 32177e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 32183ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 321945ca1b86SEd Tanous { 322045ca1b86SEd Tanous return; 322145ca1b86SEd Tanous } 3222a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Do delete all postcodes entries."; 3223a3316fc6SZhikuiRen 3224a3316fc6SZhikuiRen // Make call to post-code service to request clear all 3225a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3226a3316fc6SZhikuiRen [asyncResp](const boost::system::error_code ec) { 3227a3316fc6SZhikuiRen if (ec) 3228a3316fc6SZhikuiRen { 3229a3316fc6SZhikuiRen // TODO Handle for specific error code 3230002d39b4SEd Tanous BMCWEB_LOG_ERROR << "doClearPostCodes resp_handler got error " 32317e860f15SJohn Edward Broadbent << ec; 3232002d39b4SEd Tanous asyncResp->res.result( 3233002d39b4SEd Tanous boost::beast::http::status::internal_server_error); 3234a3316fc6SZhikuiRen messages::internalError(asyncResp->res); 3235a3316fc6SZhikuiRen return; 3236a3316fc6SZhikuiRen } 3237a3316fc6SZhikuiRen }, 323815124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 323915124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3240a3316fc6SZhikuiRen "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 32417e860f15SJohn Edward Broadbent }); 3242a3316fc6SZhikuiRen } 3243a3316fc6SZhikuiRen 3244a3316fc6SZhikuiRen static void fillPostCodeEntry( 32458d1b46d7Szhanghch05 const std::shared_ptr<bmcweb::AsyncResp>& aResp, 32466c9a279eSManojkiran Eda const boost::container::flat_map< 32476c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode, 3248a3316fc6SZhikuiRen const uint16_t bootIndex, const uint64_t codeIndex = 0, 3249a3316fc6SZhikuiRen const uint64_t skip = 0, const uint64_t top = 0) 3250a3316fc6SZhikuiRen { 3251a3316fc6SZhikuiRen // Get the Message from the MessageRegistry 3252fffb8c1fSEd Tanous const registries::Message* message = 3253fffb8c1fSEd Tanous registries::getMessage("OpenBMC.0.2.BIOSPOSTCode"); 3254a3316fc6SZhikuiRen 3255a3316fc6SZhikuiRen uint64_t currentCodeIndex = 0; 3256a3316fc6SZhikuiRen nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"]; 3257a3316fc6SZhikuiRen 3258a3316fc6SZhikuiRen uint64_t firstCodeTimeUs = 0; 32596c9a279eSManojkiran Eda for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 32606c9a279eSManojkiran Eda code : postcode) 3261a3316fc6SZhikuiRen { 3262a3316fc6SZhikuiRen currentCodeIndex++; 3263a3316fc6SZhikuiRen std::string postcodeEntryID = 3264a3316fc6SZhikuiRen "B" + std::to_string(bootIndex) + "-" + 3265a3316fc6SZhikuiRen std::to_string(currentCodeIndex); // 1 based index in EntryID string 3266a3316fc6SZhikuiRen 3267a3316fc6SZhikuiRen uint64_t usecSinceEpoch = code.first; 3268a3316fc6SZhikuiRen uint64_t usTimeOffset = 0; 3269a3316fc6SZhikuiRen 3270a3316fc6SZhikuiRen if (1 == currentCodeIndex) 3271a3316fc6SZhikuiRen { // already incremented 3272a3316fc6SZhikuiRen firstCodeTimeUs = code.first; 3273a3316fc6SZhikuiRen } 3274a3316fc6SZhikuiRen else 3275a3316fc6SZhikuiRen { 3276a3316fc6SZhikuiRen usTimeOffset = code.first - firstCodeTimeUs; 3277a3316fc6SZhikuiRen } 3278a3316fc6SZhikuiRen 3279a3316fc6SZhikuiRen // skip if no specific codeIndex is specified and currentCodeIndex does 3280a3316fc6SZhikuiRen // not fall between top and skip 3281a3316fc6SZhikuiRen if ((codeIndex == 0) && 3282a3316fc6SZhikuiRen (currentCodeIndex <= skip || currentCodeIndex > top)) 3283a3316fc6SZhikuiRen { 3284a3316fc6SZhikuiRen continue; 3285a3316fc6SZhikuiRen } 3286a3316fc6SZhikuiRen 32874e0453b1SGunnar Mills // skip if a specific codeIndex is specified and does not match the 3288a3316fc6SZhikuiRen // currentIndex 3289a3316fc6SZhikuiRen if ((codeIndex > 0) && (currentCodeIndex != codeIndex)) 3290a3316fc6SZhikuiRen { 3291a3316fc6SZhikuiRen // This is done for simplicity. 1st entry is needed to calculate 3292a3316fc6SZhikuiRen // time offset. To improve efficiency, one can get to the entry 3293a3316fc6SZhikuiRen // directly (possibly with flatmap's nth method) 3294a3316fc6SZhikuiRen continue; 3295a3316fc6SZhikuiRen } 3296a3316fc6SZhikuiRen 3297a3316fc6SZhikuiRen // currentCodeIndex is within top and skip or equal to specified code 3298a3316fc6SZhikuiRen // index 3299a3316fc6SZhikuiRen 3300a3316fc6SZhikuiRen // Get the Created time from the timestamp 3301a3316fc6SZhikuiRen std::string entryTimeStr; 33021d8782e7SNan Zhou entryTimeStr = 33032b82937eSEd Tanous redfish::time_utils::getDateTimeUint(usecSinceEpoch / 1000 / 1000); 3304a3316fc6SZhikuiRen 3305a3316fc6SZhikuiRen // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex) 3306a3316fc6SZhikuiRen std::ostringstream hexCode; 3307a3316fc6SZhikuiRen hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex 33086c9a279eSManojkiran Eda << std::get<0>(code.second); 3309a3316fc6SZhikuiRen std::ostringstream timeOffsetStr; 3310a3316fc6SZhikuiRen // Set Fixed -Point Notation 3311a3316fc6SZhikuiRen timeOffsetStr << std::fixed; 3312a3316fc6SZhikuiRen // Set precision to 4 digits 3313a3316fc6SZhikuiRen timeOffsetStr << std::setprecision(4); 3314a3316fc6SZhikuiRen // Add double to stream 3315a3316fc6SZhikuiRen timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000; 3316a3316fc6SZhikuiRen std::vector<std::string> messageArgs = { 3317a3316fc6SZhikuiRen std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()}; 3318a3316fc6SZhikuiRen 3319a3316fc6SZhikuiRen // Get MessageArgs template from message registry 3320a3316fc6SZhikuiRen std::string msg; 3321a3316fc6SZhikuiRen if (message != nullptr) 3322a3316fc6SZhikuiRen { 3323a3316fc6SZhikuiRen msg = message->message; 3324a3316fc6SZhikuiRen 3325a3316fc6SZhikuiRen // fill in this post code value 3326a3316fc6SZhikuiRen int i = 0; 3327a3316fc6SZhikuiRen for (const std::string& messageArg : messageArgs) 3328a3316fc6SZhikuiRen { 3329a3316fc6SZhikuiRen std::string argStr = "%" + std::to_string(++i); 3330a3316fc6SZhikuiRen size_t argPos = msg.find(argStr); 3331a3316fc6SZhikuiRen if (argPos != std::string::npos) 3332a3316fc6SZhikuiRen { 3333a3316fc6SZhikuiRen msg.replace(argPos, argStr.length(), messageArg); 3334a3316fc6SZhikuiRen } 3335a3316fc6SZhikuiRen } 3336a3316fc6SZhikuiRen } 3337a3316fc6SZhikuiRen 3338d4342a92STim Lee // Get Severity template from message registry 3339d4342a92STim Lee std::string severity; 3340d4342a92STim Lee if (message != nullptr) 3341d4342a92STim Lee { 33425f2b84eeSEd Tanous severity = message->messageSeverity; 3343d4342a92STim Lee } 3344d4342a92STim Lee 3345a3316fc6SZhikuiRen // add to AsyncResp 3346a3316fc6SZhikuiRen logEntryArray.push_back({}); 3347a3316fc6SZhikuiRen nlohmann::json& bmcLogEntry = logEntryArray.back(); 334884afc48bSJason M. Bills bmcLogEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 334984afc48bSJason M. Bills bmcLogEntry["@odata.id"] = 33500fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 335184afc48bSJason M. Bills postcodeEntryID; 335284afc48bSJason M. Bills bmcLogEntry["Name"] = "POST Code Log Entry"; 335384afc48bSJason M. Bills bmcLogEntry["Id"] = postcodeEntryID; 335484afc48bSJason M. Bills bmcLogEntry["Message"] = std::move(msg); 335584afc48bSJason M. Bills bmcLogEntry["MessageId"] = "OpenBMC.0.2.BIOSPOSTCode"; 335684afc48bSJason M. Bills bmcLogEntry["MessageArgs"] = std::move(messageArgs); 335784afc48bSJason M. Bills bmcLogEntry["EntryType"] = "Event"; 335884afc48bSJason M. Bills bmcLogEntry["Severity"] = std::move(severity); 335984afc48bSJason M. Bills bmcLogEntry["Created"] = entryTimeStr; 3360647b3cdcSGeorge Liu if (!std::get<std::vector<uint8_t>>(code.second).empty()) 3361647b3cdcSGeorge Liu { 3362647b3cdcSGeorge Liu bmcLogEntry["AdditionalDataURI"] = 3363647b3cdcSGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 3364647b3cdcSGeorge Liu postcodeEntryID + "/attachment"; 3365647b3cdcSGeorge Liu } 3366a3316fc6SZhikuiRen } 3367a3316fc6SZhikuiRen } 3368a3316fc6SZhikuiRen 33698d1b46d7Szhanghch05 static void getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3370a3316fc6SZhikuiRen const uint16_t bootIndex, 3371a3316fc6SZhikuiRen const uint64_t codeIndex) 3372a3316fc6SZhikuiRen { 3373a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 33746c9a279eSManojkiran Eda [aResp, bootIndex, 33756c9a279eSManojkiran Eda codeIndex](const boost::system::error_code ec, 33766c9a279eSManojkiran Eda const boost::container::flat_map< 33776c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 33786c9a279eSManojkiran Eda postcode) { 3379a3316fc6SZhikuiRen if (ec) 3380a3316fc6SZhikuiRen { 3381a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3382a3316fc6SZhikuiRen messages::internalError(aResp->res); 3383a3316fc6SZhikuiRen return; 3384a3316fc6SZhikuiRen } 3385a3316fc6SZhikuiRen 3386a3316fc6SZhikuiRen // skip the empty postcode boots 3387a3316fc6SZhikuiRen if (postcode.empty()) 3388a3316fc6SZhikuiRen { 3389a3316fc6SZhikuiRen return; 3390a3316fc6SZhikuiRen } 3391a3316fc6SZhikuiRen 3392a3316fc6SZhikuiRen fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex); 3393a3316fc6SZhikuiRen 3394a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = 3395a3316fc6SZhikuiRen aResp->res.jsonValue["Members"].size(); 3396a3316fc6SZhikuiRen }, 339715124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 339815124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3399a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3400a3316fc6SZhikuiRen bootIndex); 3401a3316fc6SZhikuiRen } 3402a3316fc6SZhikuiRen 34038d1b46d7Szhanghch05 static void getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3404a3316fc6SZhikuiRen const uint16_t bootIndex, 3405a3316fc6SZhikuiRen const uint16_t bootCount, 34063648c8beSEd Tanous const uint64_t entryCount, size_t skip, 34073648c8beSEd Tanous size_t top) 3408a3316fc6SZhikuiRen { 3409a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3410a3316fc6SZhikuiRen [aResp, bootIndex, bootCount, entryCount, skip, 3411a3316fc6SZhikuiRen top](const boost::system::error_code ec, 34126c9a279eSManojkiran Eda const boost::container::flat_map< 34136c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 34146c9a279eSManojkiran Eda postcode) { 3415a3316fc6SZhikuiRen if (ec) 3416a3316fc6SZhikuiRen { 3417a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3418a3316fc6SZhikuiRen messages::internalError(aResp->res); 3419a3316fc6SZhikuiRen return; 3420a3316fc6SZhikuiRen } 3421a3316fc6SZhikuiRen 3422a3316fc6SZhikuiRen uint64_t endCount = entryCount; 3423a3316fc6SZhikuiRen if (!postcode.empty()) 3424a3316fc6SZhikuiRen { 3425a3316fc6SZhikuiRen endCount = entryCount + postcode.size(); 34263648c8beSEd Tanous if (skip < endCount && (top + skip) > entryCount) 3427a3316fc6SZhikuiRen { 34283648c8beSEd Tanous uint64_t thisBootSkip = 34293648c8beSEd Tanous std::max(static_cast<uint64_t>(skip), entryCount) - 34303648c8beSEd Tanous entryCount; 3431a3316fc6SZhikuiRen uint64_t thisBootTop = 34323648c8beSEd Tanous std::min(static_cast<uint64_t>(top + skip), endCount) - 34333648c8beSEd Tanous entryCount; 3434a3316fc6SZhikuiRen 3435002d39b4SEd Tanous fillPostCodeEntry(aResp, postcode, bootIndex, 0, thisBootSkip, 3436002d39b4SEd Tanous thisBootTop); 3437a3316fc6SZhikuiRen } 3438a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = endCount; 3439a3316fc6SZhikuiRen } 3440a3316fc6SZhikuiRen 3441a3316fc6SZhikuiRen // continue to previous bootIndex 3442a3316fc6SZhikuiRen if (bootIndex < bootCount) 3443a3316fc6SZhikuiRen { 3444a3316fc6SZhikuiRen getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1), 3445a3316fc6SZhikuiRen bootCount, endCount, skip, top); 3446a3316fc6SZhikuiRen } 344781584abeSJiaqing Zhao else if (skip + top < endCount) 3448a3316fc6SZhikuiRen { 3449a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.nextLink"] = 34500fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=" + 3451a3316fc6SZhikuiRen std::to_string(skip + top); 3452a3316fc6SZhikuiRen } 3453a3316fc6SZhikuiRen }, 345415124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 345515124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3456a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3457a3316fc6SZhikuiRen bootIndex); 3458a3316fc6SZhikuiRen } 3459a3316fc6SZhikuiRen 34608d1b46d7Szhanghch05 static void 34618d1b46d7Szhanghch05 getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 34623648c8beSEd Tanous size_t skip, size_t top) 3463a3316fc6SZhikuiRen { 3464a3316fc6SZhikuiRen uint64_t entryCount = 0; 34651e1e598dSJonathan Doman sdbusplus::asio::getProperty<uint16_t>( 34661e1e598dSJonathan Doman *crow::connections::systemBus, 34671e1e598dSJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 34681e1e598dSJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 34691e1e598dSJonathan Doman "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount", 34701e1e598dSJonathan Doman [aResp, entryCount, skip, top](const boost::system::error_code ec, 34711e1e598dSJonathan Doman const uint16_t bootCount) { 3472a3316fc6SZhikuiRen if (ec) 3473a3316fc6SZhikuiRen { 3474a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3475a3316fc6SZhikuiRen messages::internalError(aResp->res); 3476a3316fc6SZhikuiRen return; 3477a3316fc6SZhikuiRen } 34781e1e598dSJonathan Doman getPostCodeForBoot(aResp, 1, bootCount, entryCount, skip, top); 34791e1e598dSJonathan Doman }); 3480a3316fc6SZhikuiRen } 3481a3316fc6SZhikuiRen 34827e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntryCollection(App& app) 3483a3316fc6SZhikuiRen { 34847e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 34857e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/") 3486ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 34877e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 348845ca1b86SEd Tanous [&app](const crow::Request& req, 34897e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 3490c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 3491c937d2bfSEd Tanous .canDelegateTop = true, 3492c937d2bfSEd Tanous .canDelegateSkip = true, 3493c937d2bfSEd Tanous }; 3494c937d2bfSEd Tanous query_param::Query delegatedQuery; 3495c937d2bfSEd Tanous if (!redfish::setUpRedfishRouteWithDelegation( 34963ba00073SCarson Labrado app, req, asyncResp, delegatedQuery, capabilities)) 349745ca1b86SEd Tanous { 349845ca1b86SEd Tanous return; 349945ca1b86SEd Tanous } 3500a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.type"] = 3501a3316fc6SZhikuiRen "#LogEntryCollection.LogEntryCollection"; 3502a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 3503a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3504a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3505a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3506a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3507a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3508a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 35093648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 35105143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 35113648c8beSEd Tanous getCurrentBootNumber(asyncResp, skip, top); 35127e860f15SJohn Edward Broadbent }); 3513a3316fc6SZhikuiRen } 3514a3316fc6SZhikuiRen 3515647b3cdcSGeorge Liu /** 3516647b3cdcSGeorge Liu * @brief Parse post code ID and get the current value and index value 3517647b3cdcSGeorge Liu * eg: postCodeID=B1-2, currentValue=1, index=2 3518647b3cdcSGeorge Liu * 3519647b3cdcSGeorge Liu * @param[in] postCodeID Post Code ID 3520647b3cdcSGeorge Liu * @param[out] currentValue Current value 3521647b3cdcSGeorge Liu * @param[out] index Index value 3522647b3cdcSGeorge Liu * 3523647b3cdcSGeorge Liu * @return bool true if the parsing is successful, false the parsing fails 3524647b3cdcSGeorge Liu */ 3525647b3cdcSGeorge Liu inline static bool parsePostCode(const std::string& postCodeID, 3526647b3cdcSGeorge Liu uint64_t& currentValue, uint16_t& index) 3527647b3cdcSGeorge Liu { 3528647b3cdcSGeorge Liu std::vector<std::string> split; 3529647b3cdcSGeorge Liu boost::algorithm::split(split, postCodeID, boost::is_any_of("-")); 3530647b3cdcSGeorge Liu if (split.size() != 2 || split[0].length() < 2 || split[0].front() != 'B') 3531647b3cdcSGeorge Liu { 3532647b3cdcSGeorge Liu return false; 3533647b3cdcSGeorge Liu } 3534647b3cdcSGeorge Liu 3535ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3536647b3cdcSGeorge Liu const char* start = split[0].data() + 1; 3537ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3538647b3cdcSGeorge Liu const char* end = split[0].data() + split[0].size(); 3539647b3cdcSGeorge Liu auto [ptrIndex, ecIndex] = std::from_chars(start, end, index); 3540647b3cdcSGeorge Liu 3541647b3cdcSGeorge Liu if (ptrIndex != end || ecIndex != std::errc()) 3542647b3cdcSGeorge Liu { 3543647b3cdcSGeorge Liu return false; 3544647b3cdcSGeorge Liu } 3545647b3cdcSGeorge Liu 3546647b3cdcSGeorge Liu start = split[1].data(); 3547ca45aa3cSEd Tanous 3548ca45aa3cSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic) 3549647b3cdcSGeorge Liu end = split[1].data() + split[1].size(); 3550647b3cdcSGeorge Liu auto [ptrValue, ecValue] = std::from_chars(start, end, currentValue); 3551647b3cdcSGeorge Liu 3552517d9a58STony Lee return ptrValue == end && ecValue == std::errc(); 3553647b3cdcSGeorge Liu } 3554647b3cdcSGeorge Liu 3555647b3cdcSGeorge Liu inline void requestRoutesPostCodesEntryAdditionalData(App& app) 3556647b3cdcSGeorge Liu { 35570fda0f12SGeorge Liu BMCWEB_ROUTE( 35580fda0f12SGeorge Liu app, 35590fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/attachment/") 3560647b3cdcSGeorge Liu .privileges(redfish::privileges::getLogEntry) 3561647b3cdcSGeorge Liu .methods(boost::beast::http::verb::get)( 356245ca1b86SEd Tanous [&app](const crow::Request& req, 3563647b3cdcSGeorge Liu const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3564647b3cdcSGeorge Liu const std::string& postCodeID) { 35653ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 356645ca1b86SEd Tanous { 356745ca1b86SEd Tanous return; 356845ca1b86SEd Tanous } 3569002d39b4SEd Tanous if (!http_helpers::isOctetAccepted(req.getHeaderValue("Accept"))) 3570647b3cdcSGeorge Liu { 3571002d39b4SEd Tanous asyncResp->res.result(boost::beast::http::status::bad_request); 3572647b3cdcSGeorge Liu return; 3573647b3cdcSGeorge Liu } 3574647b3cdcSGeorge Liu 3575647b3cdcSGeorge Liu uint64_t currentValue = 0; 3576647b3cdcSGeorge Liu uint16_t index = 0; 3577647b3cdcSGeorge Liu if (!parsePostCode(postCodeID, currentValue, index)) 3578647b3cdcSGeorge Liu { 3579002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", postCodeID); 3580647b3cdcSGeorge Liu return; 3581647b3cdcSGeorge Liu } 3582647b3cdcSGeorge Liu 3583647b3cdcSGeorge Liu crow::connections::systemBus->async_method_call( 3584647b3cdcSGeorge Liu [asyncResp, postCodeID, currentValue]( 3585647b3cdcSGeorge Liu const boost::system::error_code ec, 3586002d39b4SEd Tanous const std::vector<std::tuple<uint64_t, std::vector<uint8_t>>>& 3587002d39b4SEd Tanous postcodes) { 3588647b3cdcSGeorge Liu if (ec.value() == EBADR) 3589647b3cdcSGeorge Liu { 3590002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 3591002d39b4SEd Tanous postCodeID); 3592647b3cdcSGeorge Liu return; 3593647b3cdcSGeorge Liu } 3594647b3cdcSGeorge Liu if (ec) 3595647b3cdcSGeorge Liu { 3596647b3cdcSGeorge Liu BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3597647b3cdcSGeorge Liu messages::internalError(asyncResp->res); 3598647b3cdcSGeorge Liu return; 3599647b3cdcSGeorge Liu } 3600647b3cdcSGeorge Liu 3601647b3cdcSGeorge Liu size_t value = static_cast<size_t>(currentValue) - 1; 3602002d39b4SEd Tanous if (value == std::string::npos || postcodes.size() < currentValue) 3603647b3cdcSGeorge Liu { 3604647b3cdcSGeorge Liu BMCWEB_LOG_ERROR << "Wrong currentValue value"; 3605002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 3606002d39b4SEd Tanous postCodeID); 3607647b3cdcSGeorge Liu return; 3608647b3cdcSGeorge Liu } 3609647b3cdcSGeorge Liu 36109eb808c1SEd Tanous const auto& [tID, c] = postcodes[value]; 361146ff87baSEd Tanous if (c.empty()) 3612647b3cdcSGeorge Liu { 3613647b3cdcSGeorge Liu BMCWEB_LOG_INFO << "No found post code data"; 3614002d39b4SEd Tanous messages::resourceNotFound(asyncResp->res, "LogEntry", 3615002d39b4SEd Tanous postCodeID); 3616647b3cdcSGeorge Liu return; 3617647b3cdcSGeorge Liu } 361846ff87baSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) 361946ff87baSEd Tanous const char* d = reinterpret_cast<const char*>(c.data()); 362046ff87baSEd Tanous std::string_view strData(d, c.size()); 3621647b3cdcSGeorge Liu 3622d9f6c621SEd Tanous asyncResp->res.addHeader(boost::beast::http::field::content_type, 3623647b3cdcSGeorge Liu "application/octet-stream"); 3624d9f6c621SEd Tanous asyncResp->res.addHeader( 3625d9f6c621SEd Tanous boost::beast::http::field::content_transfer_encoding, "Base64"); 3626002d39b4SEd Tanous asyncResp->res.body() = crow::utility::base64encode(strData); 3627647b3cdcSGeorge Liu }, 3628647b3cdcSGeorge Liu "xyz.openbmc_project.State.Boot.PostCode0", 3629647b3cdcSGeorge Liu "/xyz/openbmc_project/State/Boot/PostCode0", 3630002d39b4SEd Tanous "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", index); 3631647b3cdcSGeorge Liu }); 3632647b3cdcSGeorge Liu } 3633647b3cdcSGeorge Liu 36347e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntry(App& app) 3635a3316fc6SZhikuiRen { 36367e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 36377e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/") 3638ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 36397e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 364045ca1b86SEd Tanous [&app](const crow::Request& req, 36417e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 36427e860f15SJohn Edward Broadbent const std::string& targetID) { 36433ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 364445ca1b86SEd Tanous { 364545ca1b86SEd Tanous return; 364645ca1b86SEd Tanous } 3647647b3cdcSGeorge Liu uint16_t bootIndex = 0; 3648647b3cdcSGeorge Liu uint64_t codeIndex = 0; 3649647b3cdcSGeorge Liu if (!parsePostCode(targetID, codeIndex, bootIndex)) 3650a3316fc6SZhikuiRen { 3651a3316fc6SZhikuiRen // Requested ID was not found 3652ace85d60SEd Tanous messages::resourceMissingAtURI(asyncResp->res, req.urlView); 3653a3316fc6SZhikuiRen return; 3654a3316fc6SZhikuiRen } 3655a3316fc6SZhikuiRen if (bootIndex == 0 || codeIndex == 0) 3656a3316fc6SZhikuiRen { 3657a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string " 36587e860f15SJohn Edward Broadbent << targetID; 3659a3316fc6SZhikuiRen } 3660a3316fc6SZhikuiRen 3661002d39b4SEd Tanous asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_4_0.LogEntry"; 3662a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 36630fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3664a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3665a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3666a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3667a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3668a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 3669a3316fc6SZhikuiRen 3670a3316fc6SZhikuiRen getPostCodeForEntry(asyncResp, bootIndex, codeIndex); 36717e860f15SJohn Edward Broadbent }); 3672a3316fc6SZhikuiRen } 3673a3316fc6SZhikuiRen 36741da66f75SEd Tanous } // namespace redfish 3675