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 184851d45dSJason M. Bills #include "registries.hpp" 194851d45dSJason M. Bills #include "registries/base_message_registry.hpp" 204851d45dSJason M. Bills #include "registries/openbmc_message_registry.hpp" 2146229577SJames Feist #include "task.hpp" 221da66f75SEd Tanous 23e1f26343SJason M. Bills #include <systemd/sd-journal.h> 24400fd1fbSAdriana Kobylak #include <unistd.h> 25e1f26343SJason M. Bills 267e860f15SJohn Edward Broadbent #include <app.hpp> 27400fd1fbSAdriana Kobylak #include <boost/algorithm/string/replace.hpp> 284851d45dSJason M. Bills #include <boost/algorithm/string/split.hpp> 294851d45dSJason M. Bills #include <boost/beast/core/span.hpp> 30400fd1fbSAdriana Kobylak #include <boost/beast/http.hpp> 311da66f75SEd Tanous #include <boost/container/flat_map.hpp> 321ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp> 33cb92c03bSAndrew Geissler #include <error_messages.hpp> 341214b7e7SGunnar Mills 354418c7f0SJames Feist #include <filesystem> 3675710de2SXiaochao Ma #include <optional> 37cd225da8SJason M. Bills #include <string_view> 38abf2add6SEd Tanous #include <variant> 391da66f75SEd Tanous 401da66f75SEd Tanous namespace redfish 411da66f75SEd Tanous { 421da66f75SEd Tanous 435b61b5e8SJason M. Bills constexpr char const* crashdumpObject = "com.intel.crashdump"; 445b61b5e8SJason M. Bills constexpr char const* crashdumpPath = "/com/intel/crashdump"; 455b61b5e8SJason M. Bills constexpr char const* crashdumpInterface = "com.intel.crashdump"; 465b61b5e8SJason M. Bills constexpr char const* deleteAllInterface = 475b61b5e8SJason M. Bills "xyz.openbmc_project.Collection.DeleteAll"; 485b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandInterface = 49424c4176SJason M. Bills "com.intel.crashdump.OnDemand"; 506eda7685SKenny L. Ku constexpr char const* crashdumpTelemetryInterface = 516eda7685SKenny L. Ku "com.intel.crashdump.Telemetry"; 521da66f75SEd Tanous 534851d45dSJason M. Bills namespace message_registries 544851d45dSJason M. Bills { 554851d45dSJason M. Bills static const Message* getMessageFromRegistry( 564851d45dSJason M. Bills const std::string& messageKey, 574851d45dSJason M. Bills const boost::beast::span<const MessageEntry> registry) 584851d45dSJason M. Bills { 594851d45dSJason M. Bills boost::beast::span<const MessageEntry>::const_iterator messageIt = 604851d45dSJason M. Bills std::find_if(registry.cbegin(), registry.cend(), 614851d45dSJason M. Bills [&messageKey](const MessageEntry& messageEntry) { 624851d45dSJason M. Bills return !std::strcmp(messageEntry.first, 634851d45dSJason M. Bills messageKey.c_str()); 644851d45dSJason M. Bills }); 654851d45dSJason M. Bills if (messageIt != registry.cend()) 664851d45dSJason M. Bills { 674851d45dSJason M. Bills return &messageIt->second; 684851d45dSJason M. Bills } 694851d45dSJason M. Bills 704851d45dSJason M. Bills return nullptr; 714851d45dSJason M. Bills } 724851d45dSJason M. Bills 734851d45dSJason M. Bills static const Message* getMessage(const std::string_view& messageID) 744851d45dSJason M. Bills { 754851d45dSJason M. Bills // Redfish MessageIds are in the form 764851d45dSJason M. Bills // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 774851d45dSJason M. Bills // the right Message 784851d45dSJason M. Bills std::vector<std::string> fields; 794851d45dSJason M. Bills fields.reserve(4); 804851d45dSJason M. Bills boost::split(fields, messageID, boost::is_any_of(".")); 814851d45dSJason M. Bills std::string& registryName = fields[0]; 824851d45dSJason M. Bills std::string& messageKey = fields[3]; 834851d45dSJason M. Bills 844851d45dSJason M. Bills // Find the right registry and check it for the MessageKey 854851d45dSJason M. Bills if (std::string(base::header.registryPrefix) == registryName) 864851d45dSJason M. Bills { 874851d45dSJason M. Bills return getMessageFromRegistry( 884851d45dSJason M. Bills messageKey, boost::beast::span<const MessageEntry>(base::registry)); 894851d45dSJason M. Bills } 904851d45dSJason M. Bills if (std::string(openbmc::header.registryPrefix) == registryName) 914851d45dSJason M. Bills { 924851d45dSJason M. Bills return getMessageFromRegistry( 934851d45dSJason M. Bills messageKey, 944851d45dSJason M. Bills boost::beast::span<const MessageEntry>(openbmc::registry)); 954851d45dSJason M. Bills } 964851d45dSJason M. Bills return nullptr; 974851d45dSJason M. Bills } 984851d45dSJason M. Bills } // namespace message_registries 994851d45dSJason M. Bills 100f6150403SJames Feist namespace fs = std::filesystem; 1011da66f75SEd Tanous 102cb92c03bSAndrew Geissler using GetManagedPropertyType = boost::container::flat_map< 10319bd78d9SPatrick Williams std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t, 104cb92c03bSAndrew Geissler int32_t, uint32_t, int64_t, uint64_t, double>>; 105cb92c03bSAndrew Geissler 106cb92c03bSAndrew Geissler using GetManagedObjectsType = boost::container::flat_map< 107cb92c03bSAndrew Geissler sdbusplus::message::object_path, 108cb92c03bSAndrew Geissler boost::container::flat_map<std::string, GetManagedPropertyType>>; 109cb92c03bSAndrew Geissler 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 140271584abSEd Tanous ret = sd_journal_get_data(journal, field.data(), 141271584abSEd Tanous reinterpret_cast<const void**>(&data), &length); 14216428a1aSJason M. Bills if (ret < 0) 14316428a1aSJason M. Bills { 14416428a1aSJason M. Bills return ret; 14516428a1aSJason M. Bills } 14639e77504SEd Tanous contents = std::string_view(data, length); 14716428a1aSJason M. Bills // Only use the content after the "=" character. 14881ce609eSEd Tanous contents.remove_prefix(std::min(contents.find('=') + 1, contents.size())); 14916428a1aSJason M. Bills return ret; 15016428a1aSJason M. Bills } 15116428a1aSJason M. Bills 1527e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal, 1537e860f15SJohn Edward Broadbent const std::string_view& field, 1547e860f15SJohn Edward Broadbent const int& base, long int& contents) 15516428a1aSJason M. Bills { 15616428a1aSJason M. Bills int ret = 0; 15739e77504SEd Tanous std::string_view metadata; 15816428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 15916428a1aSJason M. Bills ret = getJournalMetadata(journal, field, metadata); 16016428a1aSJason M. Bills if (ret < 0) 16116428a1aSJason M. Bills { 16216428a1aSJason M. Bills return ret; 16316428a1aSJason M. Bills } 164b01bf299SEd Tanous contents = strtol(metadata.data(), nullptr, base); 16516428a1aSJason M. Bills return ret; 16616428a1aSJason M. Bills } 16716428a1aSJason M. Bills 1687e860f15SJohn Edward Broadbent inline static bool getEntryTimestamp(sd_journal* journal, 1697e860f15SJohn Edward Broadbent std::string& entryTimestamp) 170a3316fc6SZhikuiRen { 171a3316fc6SZhikuiRen int ret = 0; 172a3316fc6SZhikuiRen uint64_t timestamp = 0; 173a3316fc6SZhikuiRen ret = sd_journal_get_realtime_usec(journal, ×tamp); 174a3316fc6SZhikuiRen if (ret < 0) 175a3316fc6SZhikuiRen { 176a3316fc6SZhikuiRen BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 177a3316fc6SZhikuiRen << strerror(-ret); 178a3316fc6SZhikuiRen return false; 179a3316fc6SZhikuiRen } 1809c620e21SAsmitha Karunanithi entryTimestamp = crow::utility::getDateTime( 1819c620e21SAsmitha Karunanithi static_cast<std::time_t>(timestamp / 1000 / 1000)); 1829c620e21SAsmitha Karunanithi return true; 183a3316fc6SZhikuiRen } 184a3316fc6SZhikuiRen 1858d1b46d7Szhanghch05 static bool getSkipParam(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1868d1b46d7Szhanghch05 const crow::Request& req, uint64_t& skip) 18716428a1aSJason M. Bills { 1885a7e877eSJames Feist boost::urls::url_view::params_type::iterator it = 1895a7e877eSJames Feist req.urlParams.find("$skip"); 1905a7e877eSJames Feist if (it != req.urlParams.end()) 19116428a1aSJason M. Bills { 1925a7e877eSJames Feist std::string skipParam = it->value(); 19316428a1aSJason M. Bills char* ptr = nullptr; 1945a7e877eSJames Feist skip = std::strtoul(skipParam.c_str(), &ptr, 10); 1955a7e877eSJames Feist if (skipParam.empty() || *ptr != '\0') 19616428a1aSJason M. Bills { 19716428a1aSJason M. Bills 1988d1b46d7Szhanghch05 messages::queryParameterValueTypeError( 1998d1b46d7Szhanghch05 asyncResp->res, std::string(skipParam), "$skip"); 20016428a1aSJason M. Bills return false; 20116428a1aSJason M. Bills } 20216428a1aSJason M. Bills } 20316428a1aSJason M. Bills return true; 20416428a1aSJason M. Bills } 20516428a1aSJason M. Bills 206271584abSEd Tanous static constexpr const uint64_t maxEntriesPerPage = 1000; 2078d1b46d7Szhanghch05 static bool getTopParam(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2088d1b46d7Szhanghch05 const crow::Request& req, uint64_t& top) 20916428a1aSJason M. Bills { 2105a7e877eSJames Feist boost::urls::url_view::params_type::iterator it = 2115a7e877eSJames Feist req.urlParams.find("$top"); 2125a7e877eSJames Feist if (it != req.urlParams.end()) 21316428a1aSJason M. Bills { 2145a7e877eSJames Feist std::string topParam = it->value(); 21516428a1aSJason M. Bills char* ptr = nullptr; 2165a7e877eSJames Feist top = std::strtoul(topParam.c_str(), &ptr, 10); 2175a7e877eSJames Feist if (topParam.empty() || *ptr != '\0') 21816428a1aSJason M. Bills { 2198d1b46d7Szhanghch05 messages::queryParameterValueTypeError( 2208d1b46d7Szhanghch05 asyncResp->res, std::string(topParam), "$top"); 22116428a1aSJason M. Bills return false; 22216428a1aSJason M. Bills } 223271584abSEd Tanous if (top < 1U || top > maxEntriesPerPage) 22416428a1aSJason M. Bills { 22516428a1aSJason M. Bills 22616428a1aSJason M. Bills messages::queryParameterOutOfRange( 2278d1b46d7Szhanghch05 asyncResp->res, std::to_string(top), "$top", 22816428a1aSJason M. Bills "1-" + std::to_string(maxEntriesPerPage)); 22916428a1aSJason M. Bills return false; 23016428a1aSJason M. Bills } 23116428a1aSJason M. Bills } 23216428a1aSJason M. Bills return true; 23316428a1aSJason M. Bills } 23416428a1aSJason M. Bills 2357e860f15SJohn Edward Broadbent inline static bool getUniqueEntryID(sd_journal* journal, std::string& entryID, 236e85d6b16SJason M. Bills const bool firstEntry = true) 23716428a1aSJason M. Bills { 23816428a1aSJason M. Bills int ret = 0; 23916428a1aSJason M. Bills static uint64_t prevTs = 0; 24016428a1aSJason M. Bills static int index = 0; 241e85d6b16SJason M. Bills if (firstEntry) 242e85d6b16SJason M. Bills { 243e85d6b16SJason M. Bills prevTs = 0; 244e85d6b16SJason M. Bills } 245e85d6b16SJason M. Bills 24616428a1aSJason M. Bills // Get the entry timestamp 24716428a1aSJason M. Bills uint64_t curTs = 0; 24816428a1aSJason M. Bills ret = sd_journal_get_realtime_usec(journal, &curTs); 24916428a1aSJason M. Bills if (ret < 0) 25016428a1aSJason M. Bills { 25116428a1aSJason M. Bills BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 25216428a1aSJason M. Bills << strerror(-ret); 25316428a1aSJason M. Bills return false; 25416428a1aSJason M. Bills } 25516428a1aSJason M. Bills // If the timestamp isn't unique, increment the index 25616428a1aSJason M. Bills if (curTs == prevTs) 25716428a1aSJason M. Bills { 25816428a1aSJason M. Bills index++; 25916428a1aSJason M. Bills } 26016428a1aSJason M. Bills else 26116428a1aSJason M. Bills { 26216428a1aSJason M. Bills // Otherwise, reset it 26316428a1aSJason M. Bills index = 0; 26416428a1aSJason M. Bills } 26516428a1aSJason M. Bills // Save the timestamp 26616428a1aSJason M. Bills prevTs = curTs; 26716428a1aSJason M. Bills 26816428a1aSJason M. Bills entryID = std::to_string(curTs); 26916428a1aSJason M. Bills if (index > 0) 27016428a1aSJason M. Bills { 27116428a1aSJason M. Bills entryID += "_" + std::to_string(index); 27216428a1aSJason M. Bills } 27316428a1aSJason M. Bills return true; 27416428a1aSJason M. Bills } 27516428a1aSJason M. Bills 276e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID, 277e85d6b16SJason M. Bills const bool firstEntry = true) 27895820184SJason M. Bills { 279271584abSEd Tanous static time_t prevTs = 0; 28095820184SJason M. Bills static int index = 0; 281e85d6b16SJason M. Bills if (firstEntry) 282e85d6b16SJason M. Bills { 283e85d6b16SJason M. Bills prevTs = 0; 284e85d6b16SJason M. Bills } 285e85d6b16SJason M. Bills 28695820184SJason M. Bills // Get the entry timestamp 287271584abSEd Tanous std::time_t curTs = 0; 28895820184SJason M. Bills std::tm timeStruct = {}; 28995820184SJason M. Bills std::istringstream entryStream(logEntry); 29095820184SJason M. Bills if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 29195820184SJason M. Bills { 29295820184SJason M. Bills curTs = std::mktime(&timeStruct); 29395820184SJason M. Bills } 29495820184SJason M. Bills // If the timestamp isn't unique, increment the index 29595820184SJason M. Bills if (curTs == prevTs) 29695820184SJason M. Bills { 29795820184SJason M. Bills index++; 29895820184SJason M. Bills } 29995820184SJason M. Bills else 30095820184SJason M. Bills { 30195820184SJason M. Bills // Otherwise, reset it 30295820184SJason M. Bills index = 0; 30395820184SJason M. Bills } 30495820184SJason M. Bills // Save the timestamp 30595820184SJason M. Bills prevTs = curTs; 30695820184SJason M. Bills 30795820184SJason M. Bills entryID = std::to_string(curTs); 30895820184SJason M. Bills if (index > 0) 30995820184SJason M. Bills { 31095820184SJason M. Bills entryID += "_" + std::to_string(index); 31195820184SJason M. Bills } 31295820184SJason M. Bills return true; 31395820184SJason M. Bills } 31495820184SJason M. Bills 3157e860f15SJohn Edward Broadbent inline static bool 3168d1b46d7Szhanghch05 getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3178d1b46d7Szhanghch05 const std::string& entryID, uint64_t& timestamp, 3188d1b46d7Szhanghch05 uint64_t& index) 31916428a1aSJason M. Bills { 32016428a1aSJason M. Bills if (entryID.empty()) 32116428a1aSJason M. Bills { 32216428a1aSJason M. Bills return false; 32316428a1aSJason M. Bills } 32416428a1aSJason M. Bills // Convert the unique ID back to a timestamp to find the entry 32539e77504SEd Tanous std::string_view tsStr(entryID); 32616428a1aSJason M. Bills 32781ce609eSEd Tanous auto underscorePos = tsStr.find('_'); 32816428a1aSJason M. Bills if (underscorePos != tsStr.npos) 32916428a1aSJason M. Bills { 33016428a1aSJason M. Bills // Timestamp has an index 33116428a1aSJason M. Bills tsStr.remove_suffix(tsStr.size() - underscorePos); 33239e77504SEd Tanous std::string_view indexStr(entryID); 33316428a1aSJason M. Bills indexStr.remove_prefix(underscorePos + 1); 33416428a1aSJason M. Bills std::size_t pos; 33516428a1aSJason M. Bills try 33616428a1aSJason M. Bills { 33739e77504SEd Tanous index = std::stoul(std::string(indexStr), &pos); 33816428a1aSJason M. Bills } 339271584abSEd Tanous catch (std::invalid_argument&) 34016428a1aSJason M. Bills { 3418d1b46d7Szhanghch05 messages::resourceMissingAtURI(asyncResp->res, entryID); 34216428a1aSJason M. Bills return false; 34316428a1aSJason M. Bills } 344271584abSEd Tanous catch (std::out_of_range&) 34516428a1aSJason M. Bills { 3468d1b46d7Szhanghch05 messages::resourceMissingAtURI(asyncResp->res, entryID); 34716428a1aSJason M. Bills return false; 34816428a1aSJason M. Bills } 34916428a1aSJason M. Bills if (pos != indexStr.size()) 35016428a1aSJason M. Bills { 3518d1b46d7Szhanghch05 messages::resourceMissingAtURI(asyncResp->res, entryID); 35216428a1aSJason M. Bills return false; 35316428a1aSJason M. Bills } 35416428a1aSJason M. Bills } 35516428a1aSJason M. Bills // Timestamp has no index 35616428a1aSJason M. Bills std::size_t pos; 35716428a1aSJason M. Bills try 35816428a1aSJason M. Bills { 35939e77504SEd Tanous timestamp = std::stoull(std::string(tsStr), &pos); 36016428a1aSJason M. Bills } 361271584abSEd Tanous catch (std::invalid_argument&) 36216428a1aSJason M. Bills { 3638d1b46d7Szhanghch05 messages::resourceMissingAtURI(asyncResp->res, entryID); 36416428a1aSJason M. Bills return false; 36516428a1aSJason M. Bills } 366271584abSEd Tanous catch (std::out_of_range&) 36716428a1aSJason M. Bills { 3688d1b46d7Szhanghch05 messages::resourceMissingAtURI(asyncResp->res, entryID); 36916428a1aSJason M. Bills return false; 37016428a1aSJason M. Bills } 37116428a1aSJason M. Bills if (pos != tsStr.size()) 37216428a1aSJason M. Bills { 3738d1b46d7Szhanghch05 messages::resourceMissingAtURI(asyncResp->res, entryID); 37416428a1aSJason M. Bills return false; 37516428a1aSJason M. Bills } 37616428a1aSJason M. Bills return true; 37716428a1aSJason M. Bills } 37816428a1aSJason M. Bills 37995820184SJason M. Bills static bool 38095820184SJason M. Bills getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles) 38195820184SJason M. Bills { 38295820184SJason M. Bills static const std::filesystem::path redfishLogDir = "/var/log"; 38395820184SJason M. Bills static const std::string redfishLogFilename = "redfish"; 38495820184SJason M. Bills 38595820184SJason M. Bills // Loop through the directory looking for redfish log files 38695820184SJason M. Bills for (const std::filesystem::directory_entry& dirEnt : 38795820184SJason M. Bills std::filesystem::directory_iterator(redfishLogDir)) 38895820184SJason M. Bills { 38995820184SJason M. Bills // If we find a redfish log file, save the path 39095820184SJason M. Bills std::string filename = dirEnt.path().filename(); 39195820184SJason M. Bills if (boost::starts_with(filename, redfishLogFilename)) 39295820184SJason M. Bills { 39395820184SJason M. Bills redfishLogFiles.emplace_back(redfishLogDir / filename); 39495820184SJason M. Bills } 39595820184SJason M. Bills } 39695820184SJason M. Bills // As the log files rotate, they are appended with a ".#" that is higher for 39795820184SJason M. Bills // the older logs. Since we don't expect more than 10 log files, we 39895820184SJason M. Bills // can just sort the list to get them in order from newest to oldest 39995820184SJason M. Bills std::sort(redfishLogFiles.begin(), redfishLogFiles.end()); 40095820184SJason M. Bills 40195820184SJason M. Bills return !redfishLogFiles.empty(); 40295820184SJason M. Bills } 40395820184SJason M. Bills 4048d1b46d7Szhanghch05 inline void 4058d1b46d7Szhanghch05 getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 4065cb1dd27SAsmitha Karunanithi const std::string& dumpType) 4075cb1dd27SAsmitha Karunanithi { 4085cb1dd27SAsmitha Karunanithi std::string dumpPath; 4095cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 4105cb1dd27SAsmitha Karunanithi { 4115cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 4125cb1dd27SAsmitha Karunanithi } 4135cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 4145cb1dd27SAsmitha Karunanithi { 4155cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 4165cb1dd27SAsmitha Karunanithi } 4175cb1dd27SAsmitha Karunanithi else 4185cb1dd27SAsmitha Karunanithi { 4195cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType; 4205cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4215cb1dd27SAsmitha Karunanithi return; 4225cb1dd27SAsmitha Karunanithi } 4235cb1dd27SAsmitha Karunanithi 4245cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 4255cb1dd27SAsmitha Karunanithi [asyncResp, dumpPath, dumpType](const boost::system::error_code ec, 4265cb1dd27SAsmitha Karunanithi GetManagedObjectsType& resp) { 4275cb1dd27SAsmitha Karunanithi if (ec) 4285cb1dd27SAsmitha Karunanithi { 4295cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 4305cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4315cb1dd27SAsmitha Karunanithi return; 4325cb1dd27SAsmitha Karunanithi } 4335cb1dd27SAsmitha Karunanithi 4345cb1dd27SAsmitha Karunanithi nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"]; 4355cb1dd27SAsmitha Karunanithi entriesArray = nlohmann::json::array(); 436b47452b2SAsmitha Karunanithi std::string dumpEntryPath = 437b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 438b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)) + 439b47452b2SAsmitha Karunanithi "/entry/"; 4405cb1dd27SAsmitha Karunanithi 4415cb1dd27SAsmitha Karunanithi for (auto& object : resp) 4425cb1dd27SAsmitha Karunanithi { 443b47452b2SAsmitha Karunanithi if (object.first.str.find(dumpEntryPath) == std::string::npos) 4445cb1dd27SAsmitha Karunanithi { 4455cb1dd27SAsmitha Karunanithi continue; 4465cb1dd27SAsmitha Karunanithi } 4475cb1dd27SAsmitha Karunanithi std::time_t timestamp; 4485cb1dd27SAsmitha Karunanithi uint64_t size = 0; 4495cb1dd27SAsmitha Karunanithi entriesArray.push_back({}); 4505cb1dd27SAsmitha Karunanithi nlohmann::json& thisEntry = entriesArray.back(); 4512dfd18efSEd Tanous 4522dfd18efSEd Tanous std::string entryID = object.first.filename(); 4532dfd18efSEd Tanous if (entryID.empty()) 4545cb1dd27SAsmitha Karunanithi { 4555cb1dd27SAsmitha Karunanithi continue; 4565cb1dd27SAsmitha Karunanithi } 4575cb1dd27SAsmitha Karunanithi 4585cb1dd27SAsmitha Karunanithi for (auto& interfaceMap : object.second) 4595cb1dd27SAsmitha Karunanithi { 4605cb1dd27SAsmitha Karunanithi if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") 4615cb1dd27SAsmitha Karunanithi { 4625cb1dd27SAsmitha Karunanithi 4635cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 4645cb1dd27SAsmitha Karunanithi { 4655cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Size") 4665cb1dd27SAsmitha Karunanithi { 4675cb1dd27SAsmitha Karunanithi auto sizePtr = 4685cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 4695cb1dd27SAsmitha Karunanithi if (sizePtr == nullptr) 4705cb1dd27SAsmitha Karunanithi { 4715cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4725cb1dd27SAsmitha Karunanithi break; 4735cb1dd27SAsmitha Karunanithi } 4745cb1dd27SAsmitha Karunanithi size = *sizePtr; 4755cb1dd27SAsmitha Karunanithi break; 4765cb1dd27SAsmitha Karunanithi } 4775cb1dd27SAsmitha Karunanithi } 4785cb1dd27SAsmitha Karunanithi } 4795cb1dd27SAsmitha Karunanithi else if (interfaceMap.first == 4805cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Time.EpochTime") 4815cb1dd27SAsmitha Karunanithi { 4825cb1dd27SAsmitha Karunanithi 4835cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 4845cb1dd27SAsmitha Karunanithi { 4855cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Elapsed") 4865cb1dd27SAsmitha Karunanithi { 4875cb1dd27SAsmitha Karunanithi const uint64_t* usecsTimeStamp = 4885cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 4895cb1dd27SAsmitha Karunanithi if (usecsTimeStamp == nullptr) 4905cb1dd27SAsmitha Karunanithi { 4915cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4925cb1dd27SAsmitha Karunanithi break; 4935cb1dd27SAsmitha Karunanithi } 4945cb1dd27SAsmitha Karunanithi timestamp = 4955cb1dd27SAsmitha Karunanithi static_cast<std::time_t>(*usecsTimeStamp); 4965cb1dd27SAsmitha Karunanithi break; 4975cb1dd27SAsmitha Karunanithi } 4985cb1dd27SAsmitha Karunanithi } 4995cb1dd27SAsmitha Karunanithi } 5005cb1dd27SAsmitha Karunanithi } 5015cb1dd27SAsmitha Karunanithi 5020ef217f4SGeorge Liu thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 5035cb1dd27SAsmitha Karunanithi thisEntry["@odata.id"] = dumpPath + entryID; 5045cb1dd27SAsmitha Karunanithi thisEntry["Id"] = entryID; 5055cb1dd27SAsmitha Karunanithi thisEntry["EntryType"] = "Event"; 5065cb1dd27SAsmitha Karunanithi thisEntry["Created"] = crow::utility::getDateTime(timestamp); 5075cb1dd27SAsmitha Karunanithi thisEntry["Name"] = dumpType + " Dump Entry"; 5085cb1dd27SAsmitha Karunanithi 509d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataSizeBytes"] = size; 5105cb1dd27SAsmitha Karunanithi 5115cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 5125cb1dd27SAsmitha Karunanithi { 513d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "Manager"; 514d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataURI"] = 515de8d94a3SAbhishek Patel "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/" + 516de8d94a3SAbhishek Patel entryID + "/attachment"; 5175cb1dd27SAsmitha Karunanithi } 5185cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 5195cb1dd27SAsmitha Karunanithi { 520d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "OEM"; 521d337bb72SAsmitha Karunanithi thisEntry["OEMDiagnosticDataType"] = "System"; 522d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataURI"] = 523de8d94a3SAbhishek Patel "/redfish/v1/Systems/system/LogServices/Dump/Entries/" + 524de8d94a3SAbhishek Patel entryID + "/attachment"; 5255cb1dd27SAsmitha Karunanithi } 5265cb1dd27SAsmitha Karunanithi } 5275cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Members@odata.count"] = 5285cb1dd27SAsmitha Karunanithi entriesArray.size(); 5295cb1dd27SAsmitha Karunanithi }, 5305cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 5315cb1dd27SAsmitha Karunanithi "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 5325cb1dd27SAsmitha Karunanithi } 5335cb1dd27SAsmitha Karunanithi 5348d1b46d7Szhanghch05 inline void 5358d1b46d7Szhanghch05 getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 5368d1b46d7Szhanghch05 const std::string& entryID, const std::string& dumpType) 5375cb1dd27SAsmitha Karunanithi { 5385cb1dd27SAsmitha Karunanithi std::string dumpPath; 5395cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 5405cb1dd27SAsmitha Karunanithi { 5415cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 5425cb1dd27SAsmitha Karunanithi } 5435cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 5445cb1dd27SAsmitha Karunanithi { 5455cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 5465cb1dd27SAsmitha Karunanithi } 5475cb1dd27SAsmitha Karunanithi else 5485cb1dd27SAsmitha Karunanithi { 5495cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType; 5505cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5515cb1dd27SAsmitha Karunanithi return; 5525cb1dd27SAsmitha Karunanithi } 5535cb1dd27SAsmitha Karunanithi 5545cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 5555cb1dd27SAsmitha Karunanithi [asyncResp, entryID, dumpPath, dumpType]( 5565cb1dd27SAsmitha Karunanithi const boost::system::error_code ec, GetManagedObjectsType& resp) { 5575cb1dd27SAsmitha Karunanithi if (ec) 5585cb1dd27SAsmitha Karunanithi { 5595cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 5605cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5615cb1dd27SAsmitha Karunanithi return; 5625cb1dd27SAsmitha Karunanithi } 5635cb1dd27SAsmitha Karunanithi 564b47452b2SAsmitha Karunanithi bool foundDumpEntry = false; 565b47452b2SAsmitha Karunanithi std::string dumpEntryPath = 566b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 567b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)) + 568b47452b2SAsmitha Karunanithi "/entry/"; 569b47452b2SAsmitha Karunanithi 5705cb1dd27SAsmitha Karunanithi for (auto& objectPath : resp) 5715cb1dd27SAsmitha Karunanithi { 572b47452b2SAsmitha Karunanithi if (objectPath.first.str != dumpEntryPath + entryID) 5735cb1dd27SAsmitha Karunanithi { 5745cb1dd27SAsmitha Karunanithi continue; 5755cb1dd27SAsmitha Karunanithi } 5765cb1dd27SAsmitha Karunanithi 5775cb1dd27SAsmitha Karunanithi foundDumpEntry = true; 5785cb1dd27SAsmitha Karunanithi std::time_t timestamp; 5795cb1dd27SAsmitha Karunanithi uint64_t size = 0; 5805cb1dd27SAsmitha Karunanithi 5815cb1dd27SAsmitha Karunanithi for (auto& interfaceMap : objectPath.second) 5825cb1dd27SAsmitha Karunanithi { 5835cb1dd27SAsmitha Karunanithi if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") 5845cb1dd27SAsmitha Karunanithi { 5855cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 5865cb1dd27SAsmitha Karunanithi { 5875cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Size") 5885cb1dd27SAsmitha Karunanithi { 5895cb1dd27SAsmitha Karunanithi auto sizePtr = 5905cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 5915cb1dd27SAsmitha Karunanithi if (sizePtr == nullptr) 5925cb1dd27SAsmitha Karunanithi { 5935cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5945cb1dd27SAsmitha Karunanithi break; 5955cb1dd27SAsmitha Karunanithi } 5965cb1dd27SAsmitha Karunanithi size = *sizePtr; 5975cb1dd27SAsmitha Karunanithi break; 5985cb1dd27SAsmitha Karunanithi } 5995cb1dd27SAsmitha Karunanithi } 6005cb1dd27SAsmitha Karunanithi } 6015cb1dd27SAsmitha Karunanithi else if (interfaceMap.first == 6025cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Time.EpochTime") 6035cb1dd27SAsmitha Karunanithi { 6045cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 6055cb1dd27SAsmitha Karunanithi { 6065cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Elapsed") 6075cb1dd27SAsmitha Karunanithi { 6085cb1dd27SAsmitha Karunanithi const uint64_t* usecsTimeStamp = 6095cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 6105cb1dd27SAsmitha Karunanithi if (usecsTimeStamp == nullptr) 6115cb1dd27SAsmitha Karunanithi { 6125cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6135cb1dd27SAsmitha Karunanithi break; 6145cb1dd27SAsmitha Karunanithi } 6155cb1dd27SAsmitha Karunanithi timestamp = 6165cb1dd27SAsmitha Karunanithi static_cast<std::time_t>(*usecsTimeStamp); 6175cb1dd27SAsmitha Karunanithi break; 6185cb1dd27SAsmitha Karunanithi } 6195cb1dd27SAsmitha Karunanithi } 6205cb1dd27SAsmitha Karunanithi } 6215cb1dd27SAsmitha Karunanithi } 6225cb1dd27SAsmitha Karunanithi 6235cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 6240ef217f4SGeorge Liu "#LogEntry.v1_8_0.LogEntry"; 6255cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.id"] = dumpPath + entryID; 6265cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = entryID; 6275cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["EntryType"] = "Event"; 6285cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Created"] = 6295cb1dd27SAsmitha Karunanithi crow::utility::getDateTime(timestamp); 6305cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry"; 6315cb1dd27SAsmitha Karunanithi 632d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 6335cb1dd27SAsmitha Karunanithi 6345cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 6355cb1dd27SAsmitha Karunanithi { 636d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager"; 637d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 638de8d94a3SAbhishek Patel "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/" + 639de8d94a3SAbhishek Patel entryID + "/attachment"; 6405cb1dd27SAsmitha Karunanithi } 6415cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 6425cb1dd27SAsmitha Karunanithi { 643d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM"; 644d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["OEMDiagnosticDataType"] = 6455cb1dd27SAsmitha Karunanithi "System"; 646d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 647de8d94a3SAbhishek Patel "/redfish/v1/Systems/system/LogServices/Dump/Entries/" + 648de8d94a3SAbhishek Patel entryID + "/attachment"; 6495cb1dd27SAsmitha Karunanithi } 6505cb1dd27SAsmitha Karunanithi } 651b47452b2SAsmitha Karunanithi if (foundDumpEntry == false) 652b47452b2SAsmitha Karunanithi { 653b47452b2SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Can't find Dump Entry"; 654b47452b2SAsmitha Karunanithi messages::internalError(asyncResp->res); 655b47452b2SAsmitha Karunanithi return; 656b47452b2SAsmitha Karunanithi } 6575cb1dd27SAsmitha Karunanithi }, 6585cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 6595cb1dd27SAsmitha Karunanithi "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 6605cb1dd27SAsmitha Karunanithi } 6615cb1dd27SAsmitha Karunanithi 6628d1b46d7Szhanghch05 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 6639878256fSStanley Chu const std::string& entryID, 664b47452b2SAsmitha Karunanithi const std::string& dumpType) 6655cb1dd27SAsmitha Karunanithi { 6663de8d8baSGeorge Liu auto respHandler = [asyncResp, 6673de8d8baSGeorge Liu entryID](const boost::system::error_code ec) { 6685cb1dd27SAsmitha Karunanithi BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done"; 6695cb1dd27SAsmitha Karunanithi if (ec) 6705cb1dd27SAsmitha Karunanithi { 6713de8d8baSGeorge Liu if (ec.value() == EBADR) 6723de8d8baSGeorge Liu { 6733de8d8baSGeorge Liu messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 6743de8d8baSGeorge Liu return; 6753de8d8baSGeorge Liu } 6765cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error " 6775cb1dd27SAsmitha Karunanithi << ec; 6785cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6795cb1dd27SAsmitha Karunanithi return; 6805cb1dd27SAsmitha Karunanithi } 6815cb1dd27SAsmitha Karunanithi }; 6825cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 6835cb1dd27SAsmitha Karunanithi respHandler, "xyz.openbmc_project.Dump.Manager", 684b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 685b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/" + 686b47452b2SAsmitha Karunanithi entryID, 6875cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Object.Delete", "Delete"); 6885cb1dd27SAsmitha Karunanithi } 6895cb1dd27SAsmitha Karunanithi 6908d1b46d7Szhanghch05 inline void 6918d1b46d7Szhanghch05 createDumpTaskCallback(const crow::Request& req, 6928d1b46d7Szhanghch05 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 6938d1b46d7Szhanghch05 const uint32_t& dumpId, const std::string& dumpPath, 694a43be80fSAsmitha Karunanithi const std::string& dumpType) 695a43be80fSAsmitha Karunanithi { 696a43be80fSAsmitha Karunanithi std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 6976145ed6fSAsmitha Karunanithi [dumpId, dumpPath, dumpType]( 698a43be80fSAsmitha Karunanithi boost::system::error_code err, sdbusplus::message::message& m, 699a43be80fSAsmitha Karunanithi const std::shared_ptr<task::TaskData>& taskData) { 700cb13a392SEd Tanous if (err) 701cb13a392SEd Tanous { 7026145ed6fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Error in creating a dump"; 7036145ed6fSAsmitha Karunanithi taskData->state = "Cancelled"; 7046145ed6fSAsmitha Karunanithi return task::completed; 705cb13a392SEd Tanous } 706a43be80fSAsmitha Karunanithi std::vector<std::pair< 707a43be80fSAsmitha Karunanithi std::string, 708a43be80fSAsmitha Karunanithi std::vector<std::pair<std::string, std::variant<std::string>>>>> 709a43be80fSAsmitha Karunanithi interfacesList; 710a43be80fSAsmitha Karunanithi 711a43be80fSAsmitha Karunanithi sdbusplus::message::object_path objPath; 712a43be80fSAsmitha Karunanithi 713a43be80fSAsmitha Karunanithi m.read(objPath, interfacesList); 714a43be80fSAsmitha Karunanithi 715b47452b2SAsmitha Karunanithi if (objPath.str == 716b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 717b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)) + 718b47452b2SAsmitha Karunanithi "/entry/" + std::to_string(dumpId)) 719a43be80fSAsmitha Karunanithi { 720a43be80fSAsmitha Karunanithi nlohmann::json retMessage = messages::success(); 721a43be80fSAsmitha Karunanithi taskData->messages.emplace_back(retMessage); 722a43be80fSAsmitha Karunanithi 723a43be80fSAsmitha Karunanithi std::string headerLoc = 724a43be80fSAsmitha Karunanithi "Location: " + dumpPath + std::to_string(dumpId); 725a43be80fSAsmitha Karunanithi taskData->payload->httpHeaders.emplace_back( 726a43be80fSAsmitha Karunanithi std::move(headerLoc)); 727a43be80fSAsmitha Karunanithi 728a43be80fSAsmitha Karunanithi taskData->state = "Completed"; 729b47452b2SAsmitha Karunanithi return task::completed; 7306145ed6fSAsmitha Karunanithi } 731a43be80fSAsmitha Karunanithi return task::completed; 732a43be80fSAsmitha Karunanithi }, 733a43be80fSAsmitha Karunanithi "type='signal',interface='org.freedesktop.DBus." 734a43be80fSAsmitha Karunanithi "ObjectManager'," 735a43be80fSAsmitha Karunanithi "member='InterfacesAdded', " 736a43be80fSAsmitha Karunanithi "path='/xyz/openbmc_project/dump'"); 737a43be80fSAsmitha Karunanithi 738a43be80fSAsmitha Karunanithi task->startTimer(std::chrono::minutes(3)); 739a43be80fSAsmitha Karunanithi task->populateResp(asyncResp->res); 740a43be80fSAsmitha Karunanithi task->payload.emplace(req); 741a43be80fSAsmitha Karunanithi } 742a43be80fSAsmitha Karunanithi 7438d1b46d7Szhanghch05 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 7448d1b46d7Szhanghch05 const crow::Request& req, const std::string& dumpType) 745a43be80fSAsmitha Karunanithi { 746a43be80fSAsmitha Karunanithi 747a43be80fSAsmitha Karunanithi std::string dumpPath; 748a43be80fSAsmitha Karunanithi if (dumpType == "BMC") 749a43be80fSAsmitha Karunanithi { 750a43be80fSAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 751a43be80fSAsmitha Karunanithi } 752a43be80fSAsmitha Karunanithi else if (dumpType == "System") 753a43be80fSAsmitha Karunanithi { 754a43be80fSAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 755a43be80fSAsmitha Karunanithi } 756a43be80fSAsmitha Karunanithi else 757a43be80fSAsmitha Karunanithi { 758a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Invalid dump type: " << dumpType; 759a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 760a43be80fSAsmitha Karunanithi return; 761a43be80fSAsmitha Karunanithi } 762a43be80fSAsmitha Karunanithi 763a43be80fSAsmitha Karunanithi std::optional<std::string> diagnosticDataType; 764a43be80fSAsmitha Karunanithi std::optional<std::string> oemDiagnosticDataType; 765a43be80fSAsmitha Karunanithi 766a43be80fSAsmitha Karunanithi if (!redfish::json_util::readJson( 767a43be80fSAsmitha Karunanithi req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 768a43be80fSAsmitha Karunanithi "OEMDiagnosticDataType", oemDiagnosticDataType)) 769a43be80fSAsmitha Karunanithi { 770a43be80fSAsmitha Karunanithi return; 771a43be80fSAsmitha Karunanithi } 772a43be80fSAsmitha Karunanithi 773a43be80fSAsmitha Karunanithi if (dumpType == "System") 774a43be80fSAsmitha Karunanithi { 775a43be80fSAsmitha Karunanithi if (!oemDiagnosticDataType || !diagnosticDataType) 776a43be80fSAsmitha Karunanithi { 777a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump action parameter " 778a43be80fSAsmitha Karunanithi "'DiagnosticDataType'/" 779a43be80fSAsmitha Karunanithi "'OEMDiagnosticDataType' value not found!"; 780a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 781a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", 782a43be80fSAsmitha Karunanithi "DiagnosticDataType & OEMDiagnosticDataType"); 783a43be80fSAsmitha Karunanithi return; 784a43be80fSAsmitha Karunanithi } 7853174e4dfSEd Tanous if ((*oemDiagnosticDataType != "System") || 786a43be80fSAsmitha Karunanithi (*diagnosticDataType != "OEM")) 787a43be80fSAsmitha Karunanithi { 788a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Wrong parameter values passed"; 789a43be80fSAsmitha Karunanithi messages::invalidObject(asyncResp->res, 790a43be80fSAsmitha Karunanithi "System Dump creation parameters"); 791a43be80fSAsmitha Karunanithi return; 792a43be80fSAsmitha Karunanithi } 793a43be80fSAsmitha Karunanithi } 794a43be80fSAsmitha Karunanithi else if (dumpType == "BMC") 795a43be80fSAsmitha Karunanithi { 796a43be80fSAsmitha Karunanithi if (!diagnosticDataType) 797a43be80fSAsmitha Karunanithi { 798a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump action parameter " 799a43be80fSAsmitha Karunanithi "'DiagnosticDataType' not found!"; 800a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 801a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType"); 802a43be80fSAsmitha Karunanithi return; 803a43be80fSAsmitha Karunanithi } 8043174e4dfSEd Tanous if (*diagnosticDataType != "Manager") 805a43be80fSAsmitha Karunanithi { 806a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR 807a43be80fSAsmitha Karunanithi << "Wrong parameter value passed for 'DiagnosticDataType'"; 808a43be80fSAsmitha Karunanithi messages::invalidObject(asyncResp->res, 809a43be80fSAsmitha Karunanithi "BMC Dump creation parameters"); 810a43be80fSAsmitha Karunanithi return; 811a43be80fSAsmitha Karunanithi } 812a43be80fSAsmitha Karunanithi } 813a43be80fSAsmitha Karunanithi 814a43be80fSAsmitha Karunanithi crow::connections::systemBus->async_method_call( 815a43be80fSAsmitha Karunanithi [asyncResp, req, dumpPath, dumpType](const boost::system::error_code ec, 816a43be80fSAsmitha Karunanithi const uint32_t& dumpId) { 817a43be80fSAsmitha Karunanithi if (ec) 818a43be80fSAsmitha Karunanithi { 819a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec; 820a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 821a43be80fSAsmitha Karunanithi return; 822a43be80fSAsmitha Karunanithi } 823a43be80fSAsmitha Karunanithi BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId; 824a43be80fSAsmitha Karunanithi 825a43be80fSAsmitha Karunanithi createDumpTaskCallback(req, asyncResp, dumpId, dumpPath, dumpType); 826a43be80fSAsmitha Karunanithi }, 827b47452b2SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", 828b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 829b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)), 830a43be80fSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create", "CreateDump"); 831a43be80fSAsmitha Karunanithi } 832a43be80fSAsmitha Karunanithi 8338d1b46d7Szhanghch05 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 8348d1b46d7Szhanghch05 const std::string& dumpType) 83580319af1SAsmitha Karunanithi { 836b47452b2SAsmitha Karunanithi std::string dumpTypeLowerCopy = 837b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)); 8388d1b46d7Szhanghch05 83980319af1SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 840b47452b2SAsmitha Karunanithi [asyncResp, dumpType](const boost::system::error_code ec, 84180319af1SAsmitha Karunanithi const std::vector<std::string>& subTreePaths) { 84280319af1SAsmitha Karunanithi if (ec) 84380319af1SAsmitha Karunanithi { 84480319af1SAsmitha Karunanithi BMCWEB_LOG_ERROR << "resp_handler got error " << ec; 84580319af1SAsmitha Karunanithi messages::internalError(asyncResp->res); 84680319af1SAsmitha Karunanithi return; 84780319af1SAsmitha Karunanithi } 84880319af1SAsmitha Karunanithi 84980319af1SAsmitha Karunanithi for (const std::string& path : subTreePaths) 85080319af1SAsmitha Karunanithi { 8512dfd18efSEd Tanous sdbusplus::message::object_path objPath(path); 8522dfd18efSEd Tanous std::string logID = objPath.filename(); 8532dfd18efSEd Tanous if (logID.empty()) 85480319af1SAsmitha Karunanithi { 8552dfd18efSEd Tanous continue; 85680319af1SAsmitha Karunanithi } 8572dfd18efSEd Tanous deleteDumpEntry(asyncResp, logID, dumpType); 85880319af1SAsmitha Karunanithi } 85980319af1SAsmitha Karunanithi }, 86080319af1SAsmitha Karunanithi "xyz.openbmc_project.ObjectMapper", 86180319af1SAsmitha Karunanithi "/xyz/openbmc_project/object_mapper", 86280319af1SAsmitha Karunanithi "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 863b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + dumpTypeLowerCopy, 0, 864b47452b2SAsmitha Karunanithi std::array<std::string, 1>{"xyz.openbmc_project.Dump.Entry." + 865b47452b2SAsmitha Karunanithi dumpType}); 86680319af1SAsmitha Karunanithi } 86780319af1SAsmitha Karunanithi 8687e860f15SJohn Edward Broadbent inline static void parseCrashdumpParameters( 869043a0536SJohnathan Mantey const std::vector<std::pair<std::string, VariantType>>& params, 870043a0536SJohnathan Mantey std::string& filename, std::string& timestamp, std::string& logfile) 871043a0536SJohnathan Mantey { 872043a0536SJohnathan Mantey for (auto property : params) 873043a0536SJohnathan Mantey { 874043a0536SJohnathan Mantey if (property.first == "Timestamp") 875043a0536SJohnathan Mantey { 876043a0536SJohnathan Mantey const std::string* value = 8778d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 878043a0536SJohnathan Mantey if (value != nullptr) 879043a0536SJohnathan Mantey { 880043a0536SJohnathan Mantey timestamp = *value; 881043a0536SJohnathan Mantey } 882043a0536SJohnathan Mantey } 883043a0536SJohnathan Mantey else if (property.first == "Filename") 884043a0536SJohnathan Mantey { 885043a0536SJohnathan Mantey const std::string* value = 8868d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 887043a0536SJohnathan Mantey if (value != nullptr) 888043a0536SJohnathan Mantey { 889043a0536SJohnathan Mantey filename = *value; 890043a0536SJohnathan Mantey } 891043a0536SJohnathan Mantey } 892043a0536SJohnathan Mantey else if (property.first == "Log") 893043a0536SJohnathan Mantey { 894043a0536SJohnathan Mantey const std::string* value = 8958d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 896043a0536SJohnathan Mantey if (value != nullptr) 897043a0536SJohnathan Mantey { 898043a0536SJohnathan Mantey logfile = *value; 899043a0536SJohnathan Mantey } 900043a0536SJohnathan Mantey } 901043a0536SJohnathan Mantey } 902043a0536SJohnathan Mantey } 903043a0536SJohnathan Mantey 904a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode"; 9057e860f15SJohn Edward Broadbent inline void requestRoutesSystemLogServiceCollection(App& app) 9061da66f75SEd Tanous { 907c4bf6374SJason M. Bills /** 908c4bf6374SJason M. Bills * Functions triggers appropriate requests on DBus 909c4bf6374SJason M. Bills */ 9107e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/") 911432a890cSEd Tanous .privileges({{"Login"}}) 9127e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 9137e860f15SJohn Edward Broadbent [](const crow::Request&, 9147e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 9157e860f15SJohn Edward Broadbent 916c4bf6374SJason M. Bills { 9177e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 9187e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 919c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 920c4bf6374SJason M. Bills "#LogServiceCollection.LogServiceCollection"; 921c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 922029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices"; 9237e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Name"] = 9247e860f15SJohn Edward Broadbent "System Log Services Collection"; 925c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 926c4bf6374SJason M. Bills "Collection of LogServices for this Computer System"; 9277e860f15SJohn Edward Broadbent nlohmann::json& logServiceArray = 9287e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members"]; 929c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 930029573d4SEd Tanous logServiceArray.push_back( 9317e860f15SJohn Edward Broadbent {{"@odata.id", 9327e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/EventLog"}}); 9335cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 934c9bb6861Sraviteja-b logServiceArray.push_back( 9357e860f15SJohn Edward Broadbent {{"@odata.id", 9367e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump"}}); 937c9bb6861Sraviteja-b #endif 938c9bb6861Sraviteja-b 939d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG 940d53dd41fSJason M. Bills logServiceArray.push_back( 941cb92c03bSAndrew Geissler {{"@odata.id", 942424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"}}); 943d53dd41fSJason M. Bills #endif 944c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 945c4bf6374SJason M. Bills logServiceArray.size(); 946a3316fc6SZhikuiRen 947a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 948a3316fc6SZhikuiRen [asyncResp](const boost::system::error_code ec, 949a3316fc6SZhikuiRen const std::vector<std::string>& subtreePath) { 950a3316fc6SZhikuiRen if (ec) 951a3316fc6SZhikuiRen { 952a3316fc6SZhikuiRen BMCWEB_LOG_ERROR << ec; 953a3316fc6SZhikuiRen return; 954a3316fc6SZhikuiRen } 955a3316fc6SZhikuiRen 956a3316fc6SZhikuiRen for (auto& pathStr : subtreePath) 957a3316fc6SZhikuiRen { 958a3316fc6SZhikuiRen if (pathStr.find("PostCode") != std::string::npos) 959a3316fc6SZhikuiRen { 96023a21a1cSEd Tanous nlohmann::json& logServiceArrayLocal = 961a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"]; 96223a21a1cSEd Tanous logServiceArrayLocal.push_back( 963a3316fc6SZhikuiRen {{"@odata.id", "/redfish/v1/Systems/system/" 964a3316fc6SZhikuiRen "LogServices/PostCodes"}}); 9657e860f15SJohn Edward Broadbent asyncResp->res 9667e860f15SJohn Edward Broadbent .jsonValue["Members@odata.count"] = 96723a21a1cSEd Tanous logServiceArrayLocal.size(); 968a3316fc6SZhikuiRen return; 969a3316fc6SZhikuiRen } 970a3316fc6SZhikuiRen } 971a3316fc6SZhikuiRen }, 972a3316fc6SZhikuiRen "xyz.openbmc_project.ObjectMapper", 973a3316fc6SZhikuiRen "/xyz/openbmc_project/object_mapper", 9747e860f15SJohn Edward Broadbent "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 9757e860f15SJohn Edward Broadbent 0, std::array<const char*, 1>{postCodeIface}); 9767e860f15SJohn Edward Broadbent }); 977c4bf6374SJason M. Bills } 978c4bf6374SJason M. Bills 9797e860f15SJohn Edward Broadbent inline void requestRoutesEventLogService(App& app) 980c4bf6374SJason M. Bills { 9817e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/") 982432a890cSEd Tanous .privileges({{"Login"}}) 9837e860f15SJohn Edward Broadbent .methods( 9847e860f15SJohn Edward Broadbent boost::beast::http::verb:: 9857e860f15SJohn Edward Broadbent get)([](const crow::Request&, 9867e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 987c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 988029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 989c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 990c4bf6374SJason M. Bills "#LogService.v1_1_0.LogService"; 991c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "Event Log Service"; 9927e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Description"] = 9937e860f15SJohn Edward Broadbent "System Event Log Service"; 994c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "EventLog"; 995c4bf6374SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 9967c8c4058STejas Patil 9977c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 9987c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 9997c8c4058STejas Patil 10007c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 10017c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 10027c8c4058STejas Patil redfishDateTimeOffset.second; 10037c8c4058STejas Patil 1004c4bf6374SJason M. Bills asyncResp->res.jsonValue["Entries"] = { 1005c4bf6374SJason M. Bills {"@odata.id", 1006029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}}; 1007e7d6c8b2SGunnar Mills asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 1008e7d6c8b2SGunnar Mills 1009e7d6c8b2SGunnar Mills {"target", "/redfish/v1/Systems/system/LogServices/EventLog/" 1010e7d6c8b2SGunnar Mills "Actions/LogService.ClearLog"}}; 10117e860f15SJohn Edward Broadbent }); 1012489640c6SJason M. Bills } 1013489640c6SJason M. Bills 10147e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogClear(App& app) 1015489640c6SJason M. Bills { 10167e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/" 1017489640c6SJason M. Bills "LogService.ClearLog/") 1018432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 10197e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 10207e860f15SJohn Edward Broadbent [](const crow::Request&, 10217e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1022489640c6SJason M. Bills // Clear the EventLog by deleting the log files 1023489640c6SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1024489640c6SJason M. Bills if (getRedfishLogFiles(redfishLogFiles)) 1025489640c6SJason M. Bills { 1026489640c6SJason M. Bills for (const std::filesystem::path& file : redfishLogFiles) 1027489640c6SJason M. Bills { 1028489640c6SJason M. Bills std::error_code ec; 1029489640c6SJason M. Bills std::filesystem::remove(file, ec); 1030489640c6SJason M. Bills } 1031489640c6SJason M. Bills } 1032489640c6SJason M. Bills 1033489640c6SJason M. Bills // Reload rsyslog so it knows to start new log files 1034489640c6SJason M. Bills crow::connections::systemBus->async_method_call( 1035489640c6SJason M. Bills [asyncResp](const boost::system::error_code ec) { 1036489640c6SJason M. Bills if (ec) 1037489640c6SJason M. Bills { 10387e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " 10397e860f15SJohn Edward Broadbent << 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", 10477e860f15SJohn Edward Broadbent "org.freedesktop.systemd1.Manager", "ReloadUnit", 10487e860f15SJohn Edward Broadbent "rsyslog.service", "replace"); 10497e860f15SJohn Edward Broadbent }); 1050c4bf6374SJason M. Bills } 1051c4bf6374SJason M. Bills 105295820184SJason M. Bills static int fillEventLogEntryJson(const std::string& logEntryID, 1053b5a76932SEd Tanous const std::string& logEntry, 105495820184SJason M. Bills nlohmann::json& logEntryJson) 1055c4bf6374SJason M. Bills { 105695820184SJason M. Bills // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1057cd225da8SJason M. Bills // First get the Timestamp 1058f23b7296SEd Tanous size_t space = logEntry.find_first_of(' '); 1059cd225da8SJason M. Bills if (space == std::string::npos) 106095820184SJason M. Bills { 106195820184SJason M. Bills return 1; 106295820184SJason M. Bills } 1063cd225da8SJason M. Bills std::string timestamp = logEntry.substr(0, space); 1064cd225da8SJason M. Bills // Then get the log contents 1065f23b7296SEd Tanous size_t entryStart = logEntry.find_first_not_of(' ', space); 1066cd225da8SJason M. Bills if (entryStart == std::string::npos) 1067cd225da8SJason M. Bills { 1068cd225da8SJason M. Bills return 1; 1069cd225da8SJason M. Bills } 1070cd225da8SJason M. Bills std::string_view entry(logEntry); 1071cd225da8SJason M. Bills entry.remove_prefix(entryStart); 1072cd225da8SJason M. Bills // Use split to separate the entry into its fields 1073cd225da8SJason M. Bills std::vector<std::string> logEntryFields; 1074cd225da8SJason M. Bills boost::split(logEntryFields, entry, boost::is_any_of(","), 1075cd225da8SJason M. Bills boost::token_compress_on); 1076cd225da8SJason M. Bills // We need at least a MessageId to be valid 1077cd225da8SJason M. Bills if (logEntryFields.size() < 1) 1078cd225da8SJason M. Bills { 1079cd225da8SJason M. Bills return 1; 1080cd225da8SJason M. Bills } 1081cd225da8SJason M. Bills std::string& messageID = logEntryFields[0]; 108295820184SJason M. Bills 10834851d45dSJason M. Bills // Get the Message from the MessageRegistry 10844851d45dSJason M. Bills const message_registries::Message* message = 10854851d45dSJason M. Bills message_registries::getMessage(messageID); 1086c4bf6374SJason M. Bills 10874851d45dSJason M. Bills std::string msg; 10884851d45dSJason M. Bills std::string severity; 10894851d45dSJason M. Bills if (message != nullptr) 1090c4bf6374SJason M. Bills { 10914851d45dSJason M. Bills msg = message->message; 10924851d45dSJason M. Bills severity = message->severity; 1093c4bf6374SJason M. Bills } 1094c4bf6374SJason M. Bills 109515a86ff6SJason M. Bills // Get the MessageArgs from the log if there are any 109615a86ff6SJason M. Bills boost::beast::span<std::string> messageArgs; 109715a86ff6SJason M. Bills if (logEntryFields.size() > 1) 109815a86ff6SJason M. Bills { 109915a86ff6SJason M. Bills std::string& messageArgsStart = logEntryFields[1]; 110015a86ff6SJason M. Bills // If the first string is empty, assume there are no MessageArgs 110115a86ff6SJason M. Bills std::size_t messageArgsSize = 0; 110215a86ff6SJason M. Bills if (!messageArgsStart.empty()) 110315a86ff6SJason M. Bills { 110415a86ff6SJason M. Bills messageArgsSize = logEntryFields.size() - 1; 110515a86ff6SJason M. Bills } 110615a86ff6SJason M. Bills 110723a21a1cSEd Tanous messageArgs = {&messageArgsStart, messageArgsSize}; 1108c4bf6374SJason M. Bills 11094851d45dSJason M. Bills // Fill the MessageArgs into the Message 111095820184SJason M. Bills int i = 0; 111195820184SJason M. Bills for (const std::string& messageArg : messageArgs) 11124851d45dSJason M. Bills { 111395820184SJason M. Bills std::string argStr = "%" + std::to_string(++i); 11144851d45dSJason M. Bills size_t argPos = msg.find(argStr); 11154851d45dSJason M. Bills if (argPos != std::string::npos) 11164851d45dSJason M. Bills { 111795820184SJason M. Bills msg.replace(argPos, argStr.length(), messageArg); 11184851d45dSJason M. Bills } 11194851d45dSJason M. Bills } 112015a86ff6SJason M. Bills } 11214851d45dSJason M. Bills 112295820184SJason M. Bills // Get the Created time from the timestamp. The log timestamp is in RFC3339 112395820184SJason M. Bills // format which matches the Redfish format except for the fractional seconds 112495820184SJason M. Bills // between the '.' and the '+', so just remove them. 1125f23b7296SEd Tanous std::size_t dot = timestamp.find_first_of('.'); 1126f23b7296SEd Tanous std::size_t plus = timestamp.find_first_of('+'); 112795820184SJason M. Bills if (dot != std::string::npos && plus != std::string::npos) 1128c4bf6374SJason M. Bills { 112995820184SJason M. Bills timestamp.erase(dot, plus - dot); 1130c4bf6374SJason M. Bills } 1131c4bf6374SJason M. Bills 1132c4bf6374SJason M. Bills // Fill in the log entry with the gathered data 113395820184SJason M. Bills logEntryJson = { 11340ef217f4SGeorge Liu {"@odata.type", "#LogEntry.v1_8_0.LogEntry"}, 1135029573d4SEd Tanous {"@odata.id", 1136897967deSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 113795820184SJason M. Bills logEntryID}, 1138c4bf6374SJason M. Bills {"Name", "System Event Log Entry"}, 113995820184SJason M. Bills {"Id", logEntryID}, 114095820184SJason M. Bills {"Message", std::move(msg)}, 114195820184SJason M. Bills {"MessageId", std::move(messageID)}, 1142f23b7296SEd Tanous {"MessageArgs", messageArgs}, 1143c4bf6374SJason M. Bills {"EntryType", "Event"}, 114495820184SJason M. Bills {"Severity", std::move(severity)}, 114595820184SJason M. Bills {"Created", std::move(timestamp)}}; 1146c4bf6374SJason M. Bills return 0; 1147c4bf6374SJason M. Bills } 1148c4bf6374SJason M. Bills 11497e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntryCollection(App& app) 1150c4bf6374SJason M. Bills { 11517e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 11527e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") 1153432a890cSEd Tanous .privileges({{"Login"}}) 11547e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 11557e860f15SJohn Edward Broadbent [](const crow::Request& req, 11567e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1157271584abSEd Tanous uint64_t skip = 0; 1158271584abSEd Tanous uint64_t top = maxEntriesPerPage; // Show max entries by default 11598d1b46d7Szhanghch05 if (!getSkipParam(asyncResp, req, skip)) 1160c4bf6374SJason M. Bills { 1161c4bf6374SJason M. Bills return; 1162c4bf6374SJason M. Bills } 11638d1b46d7Szhanghch05 if (!getTopParam(asyncResp, req, top)) 1164c4bf6374SJason M. Bills { 1165c4bf6374SJason M. Bills return; 1166c4bf6374SJason M. Bills } 11677e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 11687e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1169c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1170c4bf6374SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 1171c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1172029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1173c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 1174c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 1175c4bf6374SJason M. Bills "Collection of System Event Log Entries"; 1176cb92c03bSAndrew Geissler 11777e860f15SJohn Edward Broadbent nlohmann::json& logEntryArray = 11787e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members"]; 1179c4bf6374SJason M. Bills logEntryArray = nlohmann::json::array(); 11807e860f15SJohn Edward Broadbent // Go through the log files and create a unique ID for each 11817e860f15SJohn Edward Broadbent // entry 118295820184SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 118395820184SJason M. Bills getRedfishLogFiles(redfishLogFiles); 1184b01bf299SEd Tanous uint64_t entryCount = 0; 1185cd225da8SJason M. Bills std::string logEntry; 118695820184SJason M. Bills 11877e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 11887e860f15SJohn Edward Broadbent // backwards 11897e860f15SJohn Edward Broadbent for (auto it = redfishLogFiles.rbegin(); 11907e860f15SJohn Edward Broadbent it < redfishLogFiles.rend(); it++) 1191c4bf6374SJason M. Bills { 1192cd225da8SJason M. Bills std::ifstream logStream(*it); 119395820184SJason M. Bills if (!logStream.is_open()) 1194c4bf6374SJason M. Bills { 1195c4bf6374SJason M. Bills continue; 1196c4bf6374SJason M. Bills } 1197c4bf6374SJason M. Bills 1198e85d6b16SJason M. Bills // Reset the unique ID on the first entry 1199e85d6b16SJason M. Bills bool firstEntry = true; 120095820184SJason M. Bills while (std::getline(logStream, logEntry)) 120195820184SJason M. Bills { 1202c4bf6374SJason M. Bills entryCount++; 12037e860f15SJohn Edward Broadbent // Handle paging using skip (number of entries to skip 12047e860f15SJohn Edward Broadbent // from the start) and top (number of entries to 12057e860f15SJohn Edward Broadbent // display) 1206c4bf6374SJason M. Bills if (entryCount <= skip || entryCount > skip + top) 1207c4bf6374SJason M. Bills { 1208c4bf6374SJason M. Bills continue; 1209c4bf6374SJason M. Bills } 1210c4bf6374SJason M. Bills 1211c4bf6374SJason M. Bills std::string idStr; 1212e85d6b16SJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1213c4bf6374SJason M. Bills { 1214c4bf6374SJason M. Bills continue; 1215c4bf6374SJason M. Bills } 1216c4bf6374SJason M. Bills 1217e85d6b16SJason M. Bills if (firstEntry) 1218e85d6b16SJason M. Bills { 1219e85d6b16SJason M. Bills firstEntry = false; 1220e85d6b16SJason M. Bills } 1221e85d6b16SJason M. Bills 1222c4bf6374SJason M. Bills logEntryArray.push_back({}); 1223c4bf6374SJason M. Bills nlohmann::json& bmcLogEntry = logEntryArray.back(); 12247e860f15SJohn Edward Broadbent if (fillEventLogEntryJson(idStr, logEntry, 12257e860f15SJohn Edward Broadbent bmcLogEntry) != 0) 1226c4bf6374SJason M. Bills { 1227c4bf6374SJason M. Bills messages::internalError(asyncResp->res); 1228c4bf6374SJason M. Bills return; 1229c4bf6374SJason M. Bills } 1230c4bf6374SJason M. Bills } 123195820184SJason M. Bills } 1232c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 1233c4bf6374SJason M. Bills if (skip + top < entryCount) 1234c4bf6374SJason M. Bills { 1235c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 123695820184SJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/" 123795820184SJason M. Bills "Entries?$skip=" + 1238c4bf6374SJason M. Bills std::to_string(skip + top); 1239c4bf6374SJason M. Bills } 12407e860f15SJohn Edward Broadbent }); 1241897967deSJason M. Bills } 1242897967deSJason M. Bills 12437e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntry(App& app) 1244897967deSJason M. Bills { 12457e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 12467e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1247432a890cSEd Tanous .privileges({{"Login"}}) 12487e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 12497e860f15SJohn Edward Broadbent [](const crow::Request&, 12507e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 12517e860f15SJohn Edward Broadbent const std::string& param) { 12527e860f15SJohn Edward Broadbent const std::string& targetID = param; 12538d1b46d7Szhanghch05 12547e860f15SJohn Edward Broadbent // Go through the log files and check the unique ID for each 12557e860f15SJohn Edward Broadbent // entry to find the target entry 1256897967deSJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1257897967deSJason M. Bills getRedfishLogFiles(redfishLogFiles); 1258897967deSJason M. Bills std::string logEntry; 1259897967deSJason M. Bills 12607e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 12617e860f15SJohn Edward Broadbent // backwards 12627e860f15SJohn Edward Broadbent for (auto it = redfishLogFiles.rbegin(); 12637e860f15SJohn Edward Broadbent it < redfishLogFiles.rend(); it++) 1264897967deSJason M. Bills { 1265897967deSJason M. Bills std::ifstream logStream(*it); 1266897967deSJason M. Bills if (!logStream.is_open()) 1267897967deSJason M. Bills { 1268897967deSJason M. Bills continue; 1269897967deSJason M. Bills } 1270897967deSJason M. Bills 1271897967deSJason M. Bills // Reset the unique ID on the first entry 1272897967deSJason M. Bills bool firstEntry = true; 1273897967deSJason M. Bills while (std::getline(logStream, logEntry)) 1274897967deSJason M. Bills { 1275897967deSJason M. Bills std::string idStr; 1276897967deSJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1277897967deSJason M. Bills { 1278897967deSJason M. Bills continue; 1279897967deSJason M. Bills } 1280897967deSJason M. Bills 1281897967deSJason M. Bills if (firstEntry) 1282897967deSJason M. Bills { 1283897967deSJason M. Bills firstEntry = false; 1284897967deSJason M. Bills } 1285897967deSJason M. Bills 1286897967deSJason M. Bills if (idStr == targetID) 1287897967deSJason M. Bills { 12887e860f15SJohn Edward Broadbent if (fillEventLogEntryJson( 12897e860f15SJohn Edward Broadbent idStr, logEntry, 1290897967deSJason M. Bills asyncResp->res.jsonValue) != 0) 1291897967deSJason M. Bills { 1292897967deSJason M. Bills messages::internalError(asyncResp->res); 1293897967deSJason M. Bills return; 1294897967deSJason M. Bills } 1295897967deSJason M. Bills return; 1296897967deSJason M. Bills } 1297897967deSJason M. Bills } 1298897967deSJason M. Bills } 1299897967deSJason M. Bills // Requested ID was not found 1300897967deSJason M. Bills messages::resourceMissingAtURI(asyncResp->res, targetID); 13017e860f15SJohn Edward Broadbent }); 130208a4e4b5SAnthony Wilson } 130308a4e4b5SAnthony Wilson 13047e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryCollection(App& app) 130508a4e4b5SAnthony Wilson { 13067e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 13077e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") 1308432a890cSEd Tanous .privileges({{"Login"}}) 13097e860f15SJohn Edward Broadbent .methods( 13107e860f15SJohn Edward Broadbent boost::beast::http::verb:: 13117e860f15SJohn Edward Broadbent get)([](const crow::Request&, 13127e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 13137e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 13147e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 131508a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.type"] = 131608a4e4b5SAnthony Wilson "#LogEntryCollection.LogEntryCollection"; 131708a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.id"] = 131808a4e4b5SAnthony Wilson "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 131908a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 132008a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Description"] = 132108a4e4b5SAnthony Wilson "Collection of System Event Log Entries"; 132208a4e4b5SAnthony Wilson 1323cb92c03bSAndrew Geissler // DBus implementation of EventLog/Entries 1324cb92c03bSAndrew Geissler // Make call to Logging Service to find all log entry objects 1325cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 1326cb92c03bSAndrew Geissler [asyncResp](const boost::system::error_code ec, 1327cb92c03bSAndrew Geissler GetManagedObjectsType& resp) { 1328cb92c03bSAndrew Geissler if (ec) 1329cb92c03bSAndrew Geissler { 1330cb92c03bSAndrew Geissler // TODO Handle for specific error code 1331cb92c03bSAndrew Geissler BMCWEB_LOG_ERROR 1332cb92c03bSAndrew Geissler << "getLogEntriesIfaceData resp_handler got error " 1333cb92c03bSAndrew Geissler << ec; 1334cb92c03bSAndrew Geissler messages::internalError(asyncResp->res); 1335cb92c03bSAndrew Geissler return; 1336cb92c03bSAndrew Geissler } 1337cb92c03bSAndrew Geissler nlohmann::json& entriesArray = 1338cb92c03bSAndrew Geissler asyncResp->res.jsonValue["Members"]; 1339cb92c03bSAndrew Geissler entriesArray = nlohmann::json::array(); 1340cb92c03bSAndrew Geissler for (auto& objectPath : resp) 1341cb92c03bSAndrew Geissler { 134266664f25SEd Tanous uint32_t* id = nullptr; 134366664f25SEd Tanous std::time_t timestamp{}; 1344d139c236SGeorge Liu std::time_t updateTimestamp{}; 134566664f25SEd Tanous std::string* severity = nullptr; 134666664f25SEd Tanous std::string* message = nullptr; 1347f86bb901SAdriana Kobylak std::string* filePath = nullptr; 134875710de2SXiaochao Ma bool resolved = false; 1349f86bb901SAdriana Kobylak for (auto& interfaceMap : objectPath.second) 1350f86bb901SAdriana Kobylak { 1351f86bb901SAdriana Kobylak if (interfaceMap.first == 1352f86bb901SAdriana Kobylak "xyz.openbmc_project.Logging.Entry") 1353f86bb901SAdriana Kobylak { 1354cb92c03bSAndrew Geissler for (auto& propertyMap : interfaceMap.second) 1355cb92c03bSAndrew Geissler { 1356cb92c03bSAndrew Geissler if (propertyMap.first == "Id") 1357cb92c03bSAndrew Geissler { 1358f86bb901SAdriana Kobylak id = std::get_if<uint32_t>( 1359f86bb901SAdriana Kobylak &propertyMap.second); 1360cb92c03bSAndrew Geissler } 1361cb92c03bSAndrew Geissler else if (propertyMap.first == "Timestamp") 1362cb92c03bSAndrew Geissler { 1363cb92c03bSAndrew Geissler const uint64_t* millisTimeStamp = 1364f86bb901SAdriana Kobylak std::get_if<uint64_t>( 1365f86bb901SAdriana Kobylak &propertyMap.second); 1366ae34c8e8SAdriana Kobylak if (millisTimeStamp != nullptr) 1367ebd45906SGeorge Liu { 13687e860f15SJohn Edward Broadbent timestamp = 13697e860f15SJohn Edward Broadbent crow::utility::getTimestamp( 13707e860f15SJohn Edward Broadbent *millisTimeStamp); 13717e860f15SJohn Edward Broadbent } 13727e860f15SJohn Edward Broadbent } 13737e860f15SJohn Edward Broadbent else if (propertyMap.first == 13747e860f15SJohn Edward Broadbent "UpdateTimestamp") 13757e860f15SJohn Edward Broadbent { 13767e860f15SJohn Edward Broadbent const uint64_t* millisTimeStamp = 13777e860f15SJohn Edward Broadbent std::get_if<uint64_t>( 13787e860f15SJohn Edward Broadbent &propertyMap.second); 13797e860f15SJohn Edward Broadbent if (millisTimeStamp != nullptr) 13807e860f15SJohn Edward Broadbent { 13817e860f15SJohn Edward Broadbent updateTimestamp = 13827e860f15SJohn Edward Broadbent crow::utility::getTimestamp( 13837e860f15SJohn Edward Broadbent *millisTimeStamp); 13847e860f15SJohn Edward Broadbent } 13857e860f15SJohn Edward Broadbent } 13867e860f15SJohn Edward Broadbent else if (propertyMap.first == "Severity") 13877e860f15SJohn Edward Broadbent { 13887e860f15SJohn Edward Broadbent severity = std::get_if<std::string>( 13897e860f15SJohn Edward Broadbent &propertyMap.second); 13907e860f15SJohn Edward Broadbent } 13917e860f15SJohn Edward Broadbent else if (propertyMap.first == "Message") 13927e860f15SJohn Edward Broadbent { 13937e860f15SJohn Edward Broadbent message = std::get_if<std::string>( 13947e860f15SJohn Edward Broadbent &propertyMap.second); 13957e860f15SJohn Edward Broadbent } 13967e860f15SJohn Edward Broadbent else if (propertyMap.first == "Resolved") 13977e860f15SJohn Edward Broadbent { 13987e860f15SJohn Edward Broadbent bool* resolveptr = std::get_if<bool>( 13997e860f15SJohn Edward Broadbent &propertyMap.second); 14007e860f15SJohn Edward Broadbent if (resolveptr == nullptr) 14017e860f15SJohn Edward Broadbent { 14027e860f15SJohn Edward Broadbent messages::internalError( 14037e860f15SJohn Edward Broadbent asyncResp->res); 14047e860f15SJohn Edward Broadbent return; 14057e860f15SJohn Edward Broadbent } 14067e860f15SJohn Edward Broadbent resolved = *resolveptr; 14077e860f15SJohn Edward Broadbent } 14087e860f15SJohn Edward Broadbent } 14097e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 14107e860f15SJohn Edward Broadbent severity == nullptr) 14117e860f15SJohn Edward Broadbent { 14127e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 14137e860f15SJohn Edward Broadbent return; 14147e860f15SJohn Edward Broadbent } 14157e860f15SJohn Edward Broadbent } 14167e860f15SJohn Edward Broadbent else if (interfaceMap.first == 14177e860f15SJohn Edward Broadbent "xyz.openbmc_project.Common.FilePath") 14187e860f15SJohn Edward Broadbent { 14197e860f15SJohn Edward Broadbent for (auto& propertyMap : interfaceMap.second) 14207e860f15SJohn Edward Broadbent { 14217e860f15SJohn Edward Broadbent if (propertyMap.first == "Path") 14227e860f15SJohn Edward Broadbent { 14237e860f15SJohn Edward Broadbent filePath = std::get_if<std::string>( 14247e860f15SJohn Edward Broadbent &propertyMap.second); 14257e860f15SJohn Edward Broadbent } 14267e860f15SJohn Edward Broadbent } 14277e860f15SJohn Edward Broadbent } 14287e860f15SJohn Edward Broadbent } 14297e860f15SJohn Edward Broadbent // Object path without the 14307e860f15SJohn Edward Broadbent // xyz.openbmc_project.Logging.Entry interface, ignore 14317e860f15SJohn Edward Broadbent // and continue. 14327e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 14337e860f15SJohn Edward Broadbent severity == nullptr) 14347e860f15SJohn Edward Broadbent { 14357e860f15SJohn Edward Broadbent continue; 14367e860f15SJohn Edward Broadbent } 14377e860f15SJohn Edward Broadbent entriesArray.push_back({}); 14387e860f15SJohn Edward Broadbent nlohmann::json& thisEntry = entriesArray.back(); 14397e860f15SJohn Edward Broadbent thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 14407e860f15SJohn Edward Broadbent thisEntry["@odata.id"] = 14417e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/" 14427e860f15SJohn Edward Broadbent "LogServices/EventLog/Entries/" + 14437e860f15SJohn Edward Broadbent std::to_string(*id); 14447e860f15SJohn Edward Broadbent thisEntry["Name"] = "System Event Log Entry"; 14457e860f15SJohn Edward Broadbent thisEntry["Id"] = std::to_string(*id); 14467e860f15SJohn Edward Broadbent thisEntry["Message"] = *message; 14477e860f15SJohn Edward Broadbent thisEntry["Resolved"] = resolved; 14487e860f15SJohn Edward Broadbent thisEntry["EntryType"] = "Event"; 14497e860f15SJohn Edward Broadbent thisEntry["Severity"] = 14507e860f15SJohn Edward Broadbent translateSeverityDbusToRedfish(*severity); 14517e860f15SJohn Edward Broadbent thisEntry["Created"] = 14527e860f15SJohn Edward Broadbent crow::utility::getDateTime(timestamp); 14537e860f15SJohn Edward Broadbent thisEntry["Modified"] = 14547e860f15SJohn Edward Broadbent crow::utility::getDateTime(updateTimestamp); 14557e860f15SJohn Edward Broadbent if (filePath != nullptr) 14567e860f15SJohn Edward Broadbent { 14577e860f15SJohn Edward Broadbent thisEntry["AdditionalDataURI"] = 14587e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/" 14597e860f15SJohn Edward Broadbent "EventLog/" 14607e860f15SJohn Edward Broadbent "Entries/" + 14617e860f15SJohn Edward Broadbent std::to_string(*id) + "/attachment"; 14627e860f15SJohn Edward Broadbent } 14637e860f15SJohn Edward Broadbent } 14647e860f15SJohn Edward Broadbent std::sort(entriesArray.begin(), entriesArray.end(), 14657e860f15SJohn Edward Broadbent [](const nlohmann::json& left, 14667e860f15SJohn Edward Broadbent const nlohmann::json& right) { 14677e860f15SJohn Edward Broadbent return (left["Id"] <= right["Id"]); 14687e860f15SJohn Edward Broadbent }); 14697e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members@odata.count"] = 14707e860f15SJohn Edward Broadbent entriesArray.size(); 14717e860f15SJohn Edward Broadbent }, 14727e860f15SJohn Edward Broadbent "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging", 14737e860f15SJohn Edward Broadbent "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 14747e860f15SJohn Edward Broadbent }); 14757e860f15SJohn Edward Broadbent } 14767e860f15SJohn Edward Broadbent 14777e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app) 14787e860f15SJohn Edward Broadbent { 14797e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 14807e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1481432a890cSEd Tanous .privileges({{"Login"}}) 14827e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 14837e860f15SJohn Edward Broadbent [](const crow::Request&, 14847e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 14857e860f15SJohn Edward Broadbent const std::string& param) 14867e860f15SJohn Edward Broadbent 14877e860f15SJohn Edward Broadbent { 14887e860f15SJohn Edward Broadbent std::string entryID = param; 14897e860f15SJohn Edward Broadbent dbus::utility::escapePathForDbus(entryID); 14907e860f15SJohn Edward Broadbent 14917e860f15SJohn Edward Broadbent // DBus implementation of EventLog/Entries 14927e860f15SJohn Edward Broadbent // Make call to Logging Service to find all log entry objects 14937e860f15SJohn Edward Broadbent crow::connections::systemBus->async_method_call( 14947e860f15SJohn Edward Broadbent [asyncResp, entryID](const boost::system::error_code ec, 14957e860f15SJohn Edward Broadbent GetManagedPropertyType& resp) { 14967e860f15SJohn Edward Broadbent if (ec.value() == EBADR) 14977e860f15SJohn Edward Broadbent { 14987e860f15SJohn Edward Broadbent messages::resourceNotFound( 14997e860f15SJohn Edward Broadbent asyncResp->res, "EventLogEntry", entryID); 15007e860f15SJohn Edward Broadbent return; 15017e860f15SJohn Edward Broadbent } 15027e860f15SJohn Edward Broadbent if (ec) 15037e860f15SJohn Edward Broadbent { 15047e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR << "EventLogEntry (DBus) " 15057e860f15SJohn Edward Broadbent "resp_handler got error " 15067e860f15SJohn Edward Broadbent << ec; 15077e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 15087e860f15SJohn Edward Broadbent return; 15097e860f15SJohn Edward Broadbent } 15107e860f15SJohn Edward Broadbent uint32_t* id = nullptr; 15117e860f15SJohn Edward Broadbent std::time_t timestamp{}; 15127e860f15SJohn Edward Broadbent std::time_t updateTimestamp{}; 15137e860f15SJohn Edward Broadbent std::string* severity = nullptr; 15147e860f15SJohn Edward Broadbent std::string* message = nullptr; 15157e860f15SJohn Edward Broadbent std::string* filePath = nullptr; 15167e860f15SJohn Edward Broadbent bool resolved = false; 15177e860f15SJohn Edward Broadbent 15187e860f15SJohn Edward Broadbent for (auto& propertyMap : resp) 15197e860f15SJohn Edward Broadbent { 15207e860f15SJohn Edward Broadbent if (propertyMap.first == "Id") 15217e860f15SJohn Edward Broadbent { 15227e860f15SJohn Edward Broadbent id = std::get_if<uint32_t>(&propertyMap.second); 15237e860f15SJohn Edward Broadbent } 15247e860f15SJohn Edward Broadbent else if (propertyMap.first == "Timestamp") 15257e860f15SJohn Edward Broadbent { 15267e860f15SJohn Edward Broadbent const uint64_t* millisTimeStamp = 15277e860f15SJohn Edward Broadbent std::get_if<uint64_t>(&propertyMap.second); 15287e860f15SJohn Edward Broadbent if (millisTimeStamp != nullptr) 15297e860f15SJohn Edward Broadbent { 1530d139c236SGeorge Liu timestamp = crow::utility::getTimestamp( 1531cb92c03bSAndrew Geissler *millisTimeStamp); 1532d139c236SGeorge Liu } 1533ebd45906SGeorge Liu } 1534d139c236SGeorge Liu else if (propertyMap.first == "UpdateTimestamp") 1535d139c236SGeorge Liu { 1536d139c236SGeorge Liu const uint64_t* millisTimeStamp = 15377e860f15SJohn Edward Broadbent std::get_if<uint64_t>(&propertyMap.second); 1538ae34c8e8SAdriana Kobylak if (millisTimeStamp != nullptr) 1539ebd45906SGeorge Liu { 1540ebd45906SGeorge Liu updateTimestamp = 1541ebd45906SGeorge Liu crow::utility::getTimestamp( 1542d139c236SGeorge Liu *millisTimeStamp); 1543cb92c03bSAndrew Geissler } 1544ebd45906SGeorge Liu } 1545cb92c03bSAndrew Geissler else if (propertyMap.first == "Severity") 1546cb92c03bSAndrew Geissler { 1547cb92c03bSAndrew Geissler severity = std::get_if<std::string>( 1548cb92c03bSAndrew Geissler &propertyMap.second); 1549cb92c03bSAndrew Geissler } 1550cb92c03bSAndrew Geissler else if (propertyMap.first == "Message") 1551cb92c03bSAndrew Geissler { 1552cb92c03bSAndrew Geissler message = std::get_if<std::string>( 1553cb92c03bSAndrew Geissler &propertyMap.second); 1554ae34c8e8SAdriana Kobylak } 155575710de2SXiaochao Ma else if (propertyMap.first == "Resolved") 155675710de2SXiaochao Ma { 155775710de2SXiaochao Ma bool* resolveptr = 155875710de2SXiaochao Ma std::get_if<bool>(&propertyMap.second); 155975710de2SXiaochao Ma if (resolveptr == nullptr) 156075710de2SXiaochao Ma { 156175710de2SXiaochao Ma messages::internalError(asyncResp->res); 156275710de2SXiaochao Ma return; 156375710de2SXiaochao Ma } 156475710de2SXiaochao Ma resolved = *resolveptr; 156575710de2SXiaochao Ma } 15667e860f15SJohn Edward Broadbent else if (propertyMap.first == "Path") 1567f86bb901SAdriana Kobylak { 1568f86bb901SAdriana Kobylak filePath = std::get_if<std::string>( 1569f86bb901SAdriana Kobylak &propertyMap.second); 1570f86bb901SAdriana Kobylak } 1571f86bb901SAdriana Kobylak } 1572f86bb901SAdriana Kobylak if (id == nullptr || message == nullptr || 1573f86bb901SAdriana Kobylak severity == nullptr) 1574f86bb901SAdriana Kobylak { 1575ae34c8e8SAdriana Kobylak messages::internalError(asyncResp->res); 1576271584abSEd Tanous return; 1577271584abSEd Tanous } 1578f86bb901SAdriana Kobylak asyncResp->res.jsonValue["@odata.type"] = 1579f86bb901SAdriana Kobylak "#LogEntry.v1_8_0.LogEntry"; 1580f86bb901SAdriana Kobylak asyncResp->res.jsonValue["@odata.id"] = 15817e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/EventLog/" 15827e860f15SJohn Edward Broadbent "Entries/" + 1583f86bb901SAdriana Kobylak std::to_string(*id); 15847e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Name"] = 15857e860f15SJohn Edward Broadbent "System Event Log Entry"; 1586f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Id"] = std::to_string(*id); 1587f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Message"] = *message; 1588f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Resolved"] = resolved; 1589f86bb901SAdriana Kobylak asyncResp->res.jsonValue["EntryType"] = "Event"; 1590f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Severity"] = 1591f86bb901SAdriana Kobylak translateSeverityDbusToRedfish(*severity); 1592f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Created"] = 1593f86bb901SAdriana Kobylak crow::utility::getDateTime(timestamp); 1594f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Modified"] = 1595f86bb901SAdriana Kobylak crow::utility::getDateTime(updateTimestamp); 1596f86bb901SAdriana Kobylak if (filePath != nullptr) 1597f86bb901SAdriana Kobylak { 1598f86bb901SAdriana Kobylak asyncResp->res.jsonValue["AdditionalDataURI"] = 15997e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/" 16007e860f15SJohn Edward Broadbent "EventLog/" 16017e860f15SJohn Edward Broadbent "attachment/" + 16027e860f15SJohn Edward Broadbent std::to_string(*id); 1603f86bb901SAdriana Kobylak } 1604cb92c03bSAndrew Geissler }, 1605cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging", 1606cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging/entry/" + entryID, 1607f86bb901SAdriana Kobylak "org.freedesktop.DBus.Properties", "GetAll", ""); 16087e860f15SJohn Edward Broadbent }); 1609336e96c6SChicago Duan 16107e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 16117e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1612432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 16137e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::patch)( 16147e860f15SJohn Edward Broadbent [](const crow::Request& req, 16157e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 16167e860f15SJohn Edward Broadbent const std::string& entryId) { 161775710de2SXiaochao Ma std::optional<bool> resolved; 161875710de2SXiaochao Ma 16197e860f15SJohn Edward Broadbent if (!json_util::readJson(req, asyncResp->res, "Resolved", 16207e860f15SJohn Edward Broadbent resolved)) 162175710de2SXiaochao Ma { 162275710de2SXiaochao Ma return; 162375710de2SXiaochao Ma } 162475710de2SXiaochao Ma BMCWEB_LOG_DEBUG << "Set Resolved"; 162575710de2SXiaochao Ma 162675710de2SXiaochao Ma crow::connections::systemBus->async_method_call( 162775710de2SXiaochao Ma [asyncResp, resolved, 162875710de2SXiaochao Ma entryId](const boost::system::error_code ec) { 162975710de2SXiaochao Ma if (ec) 163075710de2SXiaochao Ma { 163175710de2SXiaochao Ma BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 163275710de2SXiaochao Ma messages::internalError(asyncResp->res); 163375710de2SXiaochao Ma return; 163475710de2SXiaochao Ma } 163575710de2SXiaochao Ma }, 163675710de2SXiaochao Ma "xyz.openbmc_project.Logging", 163775710de2SXiaochao Ma "/xyz/openbmc_project/logging/entry/" + entryId, 163875710de2SXiaochao Ma "org.freedesktop.DBus.Properties", "Set", 163975710de2SXiaochao Ma "xyz.openbmc_project.Logging.Entry", "Resolved", 164075710de2SXiaochao Ma std::variant<bool>(*resolved)); 16417e860f15SJohn Edward Broadbent }); 164275710de2SXiaochao Ma 16437e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 16447e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1645432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 16467e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::delete_)( 16477e860f15SJohn Edward Broadbent [](const crow::Request&, 16487e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 16497e860f15SJohn Edward Broadbent const std::string& param) 16507e860f15SJohn Edward Broadbent 1651336e96c6SChicago Duan { 1652336e96c6SChicago Duan BMCWEB_LOG_DEBUG << "Do delete single event entries."; 1653336e96c6SChicago Duan 16547e860f15SJohn Edward Broadbent std::string entryID = param; 1655336e96c6SChicago Duan 1656336e96c6SChicago Duan dbus::utility::escapePathForDbus(entryID); 1657336e96c6SChicago Duan 1658336e96c6SChicago Duan // Process response from Logging service. 16597e860f15SJohn Edward Broadbent auto respHandler = [asyncResp, entryID]( 16607e860f15SJohn Edward Broadbent const boost::system::error_code ec) { 16617e860f15SJohn Edward Broadbent BMCWEB_LOG_DEBUG 16627e860f15SJohn Edward Broadbent << "EventLogEntry (DBus) doDelete callback: Done"; 1663336e96c6SChicago Duan if (ec) 1664336e96c6SChicago Duan { 16653de8d8baSGeorge Liu if (ec.value() == EBADR) 16663de8d8baSGeorge Liu { 16677e860f15SJohn Edward Broadbent messages::resourceNotFound(asyncResp->res, 16687e860f15SJohn Edward Broadbent "LogEntry", entryID); 16693de8d8baSGeorge Liu return; 16703de8d8baSGeorge Liu } 1671336e96c6SChicago Duan // TODO Handle for specific error code 16727e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR << "EventLogEntry (DBus) doDelete " 16737e860f15SJohn Edward Broadbent "respHandler got error " 1674336e96c6SChicago Duan << ec; 1675336e96c6SChicago Duan asyncResp->res.result( 1676336e96c6SChicago Duan boost::beast::http::status::internal_server_error); 1677336e96c6SChicago Duan return; 1678336e96c6SChicago Duan } 1679336e96c6SChicago Duan 1680336e96c6SChicago Duan asyncResp->res.result(boost::beast::http::status::ok); 1681336e96c6SChicago Duan }; 1682336e96c6SChicago Duan 1683336e96c6SChicago Duan // Make call to Logging service to request Delete Log 1684336e96c6SChicago Duan crow::connections::systemBus->async_method_call( 1685336e96c6SChicago Duan respHandler, "xyz.openbmc_project.Logging", 1686336e96c6SChicago Duan "/xyz/openbmc_project/logging/entry/" + entryID, 1687336e96c6SChicago Duan "xyz.openbmc_project.Object.Delete", "Delete"); 16887e860f15SJohn Edward Broadbent }); 1689400fd1fbSAdriana Kobylak } 1690400fd1fbSAdriana Kobylak 16917e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryDownload(App& app) 1692400fd1fbSAdriana Kobylak { 16937e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" 16947e860f15SJohn Edward Broadbent "<str>/attachment") 1695432a890cSEd Tanous .privileges({{"Login"}}) 16967e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 16977e860f15SJohn Edward Broadbent [](const crow::Request& req, 16987e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 16997e860f15SJohn Edward Broadbent const std::string& param) 1700400fd1fbSAdriana Kobylak 17017e860f15SJohn Edward Broadbent { 1702*753d034dSEd Tanous std::string_view acceptHeader = req.getHeaderValue("Accept"); 1703*753d034dSEd Tanous // The iterators in boost/http/rfc7230.hpp end the string if '/' 1704*753d034dSEd Tanous // is found, so replace it with arbitrary character '|' which is 1705*753d034dSEd Tanous // not part of the Accept header syntax. 1706*753d034dSEd Tanous std::string acceptStr = boost::replace_all_copy( 1707*753d034dSEd Tanous std::string(acceptHeader), "/", "|"); 1708*753d034dSEd Tanous boost::beast::http::ext_list acceptTypes{acceptStr}; 1709*753d034dSEd Tanous bool supported = false; 1710*753d034dSEd Tanous for (const auto& type : acceptTypes) 1711*753d034dSEd Tanous { 1712*753d034dSEd Tanous if ((type.first == "*|*") || 1713*753d034dSEd Tanous (type.first == "application|octet-stream")) 1714*753d034dSEd Tanous { 1715*753d034dSEd Tanous supported = true; 1716*753d034dSEd Tanous break; 1717*753d034dSEd Tanous } 1718*753d034dSEd Tanous } 1719*753d034dSEd Tanous if (!supported) 1720400fd1fbSAdriana Kobylak { 17217e860f15SJohn Edward Broadbent asyncResp->res.result( 17227e860f15SJohn Edward Broadbent boost::beast::http::status::bad_request); 1723400fd1fbSAdriana Kobylak return; 1724400fd1fbSAdriana Kobylak } 1725400fd1fbSAdriana Kobylak 17267e860f15SJohn Edward Broadbent std::string entryID = param; 1727400fd1fbSAdriana Kobylak dbus::utility::escapePathForDbus(entryID); 1728400fd1fbSAdriana Kobylak 1729400fd1fbSAdriana Kobylak crow::connections::systemBus->async_method_call( 17307e860f15SJohn Edward Broadbent [asyncResp, 17317e860f15SJohn Edward Broadbent entryID](const boost::system::error_code ec, 1732400fd1fbSAdriana Kobylak const sdbusplus::message::unix_fd& unixfd) { 1733400fd1fbSAdriana Kobylak if (ec.value() == EBADR) 1734400fd1fbSAdriana Kobylak { 17357e860f15SJohn Edward Broadbent messages::resourceNotFound( 17367e860f15SJohn Edward Broadbent asyncResp->res, "EventLogAttachment", entryID); 1737400fd1fbSAdriana Kobylak return; 1738400fd1fbSAdriana Kobylak } 1739400fd1fbSAdriana Kobylak if (ec) 1740400fd1fbSAdriana Kobylak { 1741400fd1fbSAdriana Kobylak BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 1742400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1743400fd1fbSAdriana Kobylak return; 1744400fd1fbSAdriana Kobylak } 1745400fd1fbSAdriana Kobylak 1746400fd1fbSAdriana Kobylak int fd = -1; 1747400fd1fbSAdriana Kobylak fd = dup(unixfd); 1748400fd1fbSAdriana Kobylak if (fd == -1) 1749400fd1fbSAdriana Kobylak { 1750400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1751400fd1fbSAdriana Kobylak return; 1752400fd1fbSAdriana Kobylak } 1753400fd1fbSAdriana Kobylak 1754400fd1fbSAdriana Kobylak long long int size = lseek(fd, 0, SEEK_END); 1755400fd1fbSAdriana Kobylak if (size == -1) 1756400fd1fbSAdriana Kobylak { 1757400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1758400fd1fbSAdriana Kobylak return; 1759400fd1fbSAdriana Kobylak } 1760400fd1fbSAdriana Kobylak 1761400fd1fbSAdriana Kobylak // Arbitrary max size of 64kb 1762400fd1fbSAdriana Kobylak constexpr int maxFileSize = 65536; 1763400fd1fbSAdriana Kobylak if (size > maxFileSize) 1764400fd1fbSAdriana Kobylak { 1765400fd1fbSAdriana Kobylak BMCWEB_LOG_ERROR 1766400fd1fbSAdriana Kobylak << "File size exceeds maximum allowed size of " 1767400fd1fbSAdriana Kobylak << maxFileSize; 1768400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1769400fd1fbSAdriana Kobylak return; 1770400fd1fbSAdriana Kobylak } 1771400fd1fbSAdriana Kobylak std::vector<char> data(static_cast<size_t>(size)); 1772400fd1fbSAdriana Kobylak long long int rc = lseek(fd, 0, SEEK_SET); 1773400fd1fbSAdriana Kobylak if (rc == -1) 1774400fd1fbSAdriana Kobylak { 1775400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1776400fd1fbSAdriana Kobylak return; 1777400fd1fbSAdriana Kobylak } 1778400fd1fbSAdriana Kobylak rc = read(fd, data.data(), data.size()); 1779400fd1fbSAdriana Kobylak if ((rc == -1) || (rc != size)) 1780400fd1fbSAdriana Kobylak { 1781400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1782400fd1fbSAdriana Kobylak return; 1783400fd1fbSAdriana Kobylak } 1784400fd1fbSAdriana Kobylak close(fd); 1785400fd1fbSAdriana Kobylak 1786400fd1fbSAdriana Kobylak std::string_view strData(data.data(), data.size()); 17877e860f15SJohn Edward Broadbent std::string output = 17887e860f15SJohn Edward Broadbent crow::utility::base64encode(strData); 1789400fd1fbSAdriana Kobylak 1790400fd1fbSAdriana Kobylak asyncResp->res.addHeader("Content-Type", 1791400fd1fbSAdriana Kobylak "application/octet-stream"); 17927e860f15SJohn Edward Broadbent asyncResp->res.addHeader("Content-Transfer-Encoding", 17937e860f15SJohn Edward Broadbent "Base64"); 1794400fd1fbSAdriana Kobylak asyncResp->res.body() = std::move(output); 1795400fd1fbSAdriana Kobylak }, 1796400fd1fbSAdriana Kobylak "xyz.openbmc_project.Logging", 1797400fd1fbSAdriana Kobylak "/xyz/openbmc_project/logging/entry/" + entryID, 1798400fd1fbSAdriana Kobylak "xyz.openbmc_project.Logging.Entry", "GetEntry"); 17997e860f15SJohn Edward Broadbent }); 18001da66f75SEd Tanous } 18011da66f75SEd Tanous 18027e860f15SJohn Edward Broadbent inline void requestRoutesBMCLogServiceCollection(App& app) 18031da66f75SEd Tanous { 18047e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/") 1805432a890cSEd Tanous .privileges({{"Login"}}) 18067e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 18077e860f15SJohn Edward Broadbent [](const crow::Request&, 18087e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 18097e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 18107e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1811e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 18121da66f75SEd Tanous "#LogServiceCollection.LogServiceCollection"; 1813e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1814e1f26343SJason M. Bills "/redfish/v1/Managers/bmc/LogServices"; 18157e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Name"] = 18167e860f15SJohn Edward Broadbent "Open BMC Log Services Collection"; 1817e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 18181da66f75SEd Tanous "Collection of LogServices for this Manager"; 18197e860f15SJohn Edward Broadbent nlohmann::json& logServiceArray = 18207e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members"]; 1821c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 18225cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 18235cb1dd27SAsmitha Karunanithi logServiceArray.push_back( 18247e860f15SJohn Edward Broadbent {{"@odata.id", 18257e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump"}}); 18265cb1dd27SAsmitha Karunanithi #endif 1827c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL 1828c4bf6374SJason M. Bills logServiceArray.push_back( 18297e860f15SJohn Edward Broadbent {{"@odata.id", 18307e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Journal"}}); 1831c4bf6374SJason M. Bills #endif 1832e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 1833c4bf6374SJason M. Bills logServiceArray.size(); 18347e860f15SJohn Edward Broadbent }); 1835e1f26343SJason M. Bills } 1836e1f26343SJason M. Bills 18377e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogService(App& app) 1838e1f26343SJason M. Bills { 18397e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/") 1840432a890cSEd Tanous .privileges({{"Login"}}) 18417e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 18427e860f15SJohn Edward Broadbent [](const crow::Request&, 18437e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 18448d1b46d7Szhanghch05 18457e860f15SJohn Edward Broadbent { 1846e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1847e1f26343SJason M. Bills "#LogService.v1_1_0.LogService"; 18480f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 18490f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal"; 18507e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Name"] = 18517e860f15SJohn Edward Broadbent "Open BMC Journal Log Service"; 18527e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Description"] = 18537e860f15SJohn Edward Broadbent "BMC Journal Log Service"; 1854c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "BMC Journal"; 1855e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 18567c8c4058STejas Patil 18577c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 18587c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 18597c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = 18607c8c4058STejas Patil redfishDateTimeOffset.first; 18617c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 18627c8c4058STejas Patil redfishDateTimeOffset.second; 18637c8c4058STejas Patil 1864cd50aa42SJason M. Bills asyncResp->res.jsonValue["Entries"] = { 1865cd50aa42SJason M. Bills {"@odata.id", 1866086be238SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}}; 18677e860f15SJohn Edward Broadbent }); 1868e1f26343SJason M. Bills } 1869e1f26343SJason M. Bills 1870c4bf6374SJason M. Bills static int fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID, 1871e1f26343SJason M. Bills sd_journal* journal, 1872c4bf6374SJason M. Bills nlohmann::json& bmcJournalLogEntryJson) 1873e1f26343SJason M. Bills { 1874e1f26343SJason M. Bills // Get the Log Entry contents 1875e1f26343SJason M. Bills int ret = 0; 1876e1f26343SJason M. Bills 1877a8fe54f0SJason M. Bills std::string message; 1878a8fe54f0SJason M. Bills std::string_view syslogID; 1879a8fe54f0SJason M. Bills ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID); 1880a8fe54f0SJason M. Bills if (ret < 0) 1881a8fe54f0SJason M. Bills { 1882a8fe54f0SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read SYSLOG_IDENTIFIER field: " 1883a8fe54f0SJason M. Bills << strerror(-ret); 1884a8fe54f0SJason M. Bills } 1885a8fe54f0SJason M. Bills if (!syslogID.empty()) 1886a8fe54f0SJason M. Bills { 1887a8fe54f0SJason M. Bills message += std::string(syslogID) + ": "; 1888a8fe54f0SJason M. Bills } 1889a8fe54f0SJason M. Bills 189039e77504SEd Tanous std::string_view msg; 189116428a1aSJason M. Bills ret = getJournalMetadata(journal, "MESSAGE", msg); 1892e1f26343SJason M. Bills if (ret < 0) 1893e1f26343SJason M. Bills { 1894e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret); 1895e1f26343SJason M. Bills return 1; 1896e1f26343SJason M. Bills } 1897a8fe54f0SJason M. Bills message += std::string(msg); 1898e1f26343SJason M. Bills 1899e1f26343SJason M. Bills // Get the severity from the PRIORITY field 1900271584abSEd Tanous long int severity = 8; // Default to an invalid priority 190116428a1aSJason M. Bills ret = getJournalMetadata(journal, "PRIORITY", 10, severity); 1902e1f26343SJason M. Bills if (ret < 0) 1903e1f26343SJason M. Bills { 1904e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret); 1905e1f26343SJason M. Bills } 1906e1f26343SJason M. Bills 1907e1f26343SJason M. Bills // Get the Created time from the timestamp 190816428a1aSJason M. Bills std::string entryTimeStr; 190916428a1aSJason M. Bills if (!getEntryTimestamp(journal, entryTimeStr)) 1910e1f26343SJason M. Bills { 191116428a1aSJason M. Bills return 1; 1912e1f26343SJason M. Bills } 1913e1f26343SJason M. Bills 1914e1f26343SJason M. Bills // Fill in the log entry with the gathered data 1915c4bf6374SJason M. Bills bmcJournalLogEntryJson = { 19160ef217f4SGeorge Liu {"@odata.type", "#LogEntry.v1_8_0.LogEntry"}, 1917c4bf6374SJason M. Bills {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" + 1918c4bf6374SJason M. Bills bmcJournalLogEntryID}, 1919e1f26343SJason M. Bills {"Name", "BMC Journal Entry"}, 1920c4bf6374SJason M. Bills {"Id", bmcJournalLogEntryID}, 1921a8fe54f0SJason M. Bills {"Message", std::move(message)}, 1922e1f26343SJason M. Bills {"EntryType", "Oem"}, 1923738c1e61SPatrick Williams {"Severity", severity <= 2 ? "Critical" 1924738c1e61SPatrick Williams : severity <= 4 ? "Warning" 1925738c1e61SPatrick Williams : "OK"}, 1926086be238SEd Tanous {"OemRecordFormat", "BMC Journal Entry"}, 1927e1f26343SJason M. Bills {"Created", std::move(entryTimeStr)}}; 1928e1f26343SJason M. Bills return 0; 1929e1f26343SJason M. Bills } 1930e1f26343SJason M. Bills 19317e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntryCollection(App& app) 1932e1f26343SJason M. Bills { 19337e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/") 1934432a890cSEd Tanous .privileges({{"Login"}}) 19357e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 19367e860f15SJohn Edward Broadbent [](const crow::Request& req, 19377e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1938193ad2faSJason M. Bills static constexpr const long maxEntriesPerPage = 1000; 1939271584abSEd Tanous uint64_t skip = 0; 1940271584abSEd Tanous uint64_t top = maxEntriesPerPage; // Show max entries by default 19418d1b46d7Szhanghch05 if (!getSkipParam(asyncResp, req, skip)) 1942193ad2faSJason M. Bills { 1943193ad2faSJason M. Bills return; 1944193ad2faSJason M. Bills } 19458d1b46d7Szhanghch05 if (!getTopParam(asyncResp, req, top)) 1946193ad2faSJason M. Bills { 1947193ad2faSJason M. Bills return; 1948193ad2faSJason M. Bills } 19497e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 19507e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1951e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1952e1f26343SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 19530f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 19540f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 1955e1f26343SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries"; 1956e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 1957e1f26343SJason M. Bills "Collection of BMC Journal Entries"; 19587e860f15SJohn Edward Broadbent nlohmann::json& logEntryArray = 19597e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members"]; 1960e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 1961e1f26343SJason M. Bills 19627e860f15SJohn Edward Broadbent // Go through the journal and use the timestamp to create a 19637e860f15SJohn Edward Broadbent // unique ID for each entry 1964e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 1965e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 1966e1f26343SJason M. Bills if (ret < 0) 1967e1f26343SJason M. Bills { 19687e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR << "failed to open journal: " 19697e860f15SJohn Edward Broadbent << strerror(-ret); 1970f12894f8SJason M. Bills messages::internalError(asyncResp->res); 1971e1f26343SJason M. Bills return; 1972e1f26343SJason M. Bills } 19737e860f15SJohn Edward Broadbent std::unique_ptr<sd_journal, decltype(&sd_journal_close)> 19747e860f15SJohn Edward Broadbent journal(journalTmp, sd_journal_close); 1975e1f26343SJason M. Bills journalTmp = nullptr; 1976b01bf299SEd Tanous uint64_t entryCount = 0; 1977e85d6b16SJason M. Bills // Reset the unique ID on the first entry 1978e85d6b16SJason M. Bills bool firstEntry = true; 1979e1f26343SJason M. Bills SD_JOURNAL_FOREACH(journal.get()) 1980e1f26343SJason M. Bills { 1981193ad2faSJason M. Bills entryCount++; 19827e860f15SJohn Edward Broadbent // Handle paging using skip (number of entries to skip from 19837e860f15SJohn Edward Broadbent // the start) and top (number of entries to display) 1984193ad2faSJason M. Bills if (entryCount <= skip || entryCount > skip + top) 1985193ad2faSJason M. Bills { 1986193ad2faSJason M. Bills continue; 1987193ad2faSJason M. Bills } 1988193ad2faSJason M. Bills 198916428a1aSJason M. Bills std::string idStr; 1990e85d6b16SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 1991e1f26343SJason M. Bills { 1992e1f26343SJason M. Bills continue; 1993e1f26343SJason M. Bills } 1994e1f26343SJason M. Bills 1995e85d6b16SJason M. Bills if (firstEntry) 1996e85d6b16SJason M. Bills { 1997e85d6b16SJason M. Bills firstEntry = false; 1998e85d6b16SJason M. Bills } 1999e85d6b16SJason M. Bills 2000e1f26343SJason M. Bills logEntryArray.push_back({}); 2001c4bf6374SJason M. Bills nlohmann::json& bmcJournalLogEntry = logEntryArray.back(); 2002c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(idStr, journal.get(), 2003c4bf6374SJason M. Bills bmcJournalLogEntry) != 0) 2004e1f26343SJason M. Bills { 2005f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2006e1f26343SJason M. Bills return; 2007e1f26343SJason M. Bills } 2008e1f26343SJason M. Bills } 2009193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 2010193ad2faSJason M. Bills if (skip + top < entryCount) 2011193ad2faSJason M. Bills { 2012193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 20137e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Journal/" 20147e860f15SJohn Edward Broadbent "Entries?$skip=" + 2015193ad2faSJason M. Bills std::to_string(skip + top); 2016193ad2faSJason M. Bills } 20177e860f15SJohn Edward Broadbent }); 2018e1f26343SJason M. Bills } 2019e1f26343SJason M. Bills 20207e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntry(App& app) 2021e1f26343SJason M. Bills { 20227e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 20237e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/") 2024432a890cSEd Tanous .privileges({{"Login"}}) 20257e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 20267e860f15SJohn Edward Broadbent [](const crow::Request&, 20277e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 20287e860f15SJohn Edward Broadbent const std::string& entryID) { 2029e1f26343SJason M. Bills // Convert the unique ID back to a timestamp to find the entry 2030e1f26343SJason M. Bills uint64_t ts = 0; 2031271584abSEd Tanous uint64_t index = 0; 20328d1b46d7Szhanghch05 if (!getTimestampFromID(asyncResp, entryID, ts, index)) 2033e1f26343SJason M. Bills { 203416428a1aSJason M. Bills return; 2035e1f26343SJason M. Bills } 2036e1f26343SJason M. Bills 2037e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2038e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2039e1f26343SJason M. Bills if (ret < 0) 2040e1f26343SJason M. Bills { 20417e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR << "failed to open journal: " 20427e860f15SJohn Edward Broadbent << strerror(-ret); 2043f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2044e1f26343SJason M. Bills return; 2045e1f26343SJason M. Bills } 20467e860f15SJohn Edward Broadbent std::unique_ptr<sd_journal, decltype(&sd_journal_close)> 20477e860f15SJohn Edward Broadbent journal(journalTmp, sd_journal_close); 2048e1f26343SJason M. Bills journalTmp = nullptr; 20497e860f15SJohn Edward Broadbent // Go to the timestamp in the log and move to the entry at the 20507e860f15SJohn Edward Broadbent // index tracking the unique ID 2051af07e3f5SJason M. Bills std::string idStr; 2052af07e3f5SJason M. Bills bool firstEntry = true; 2053e1f26343SJason M. Bills ret = sd_journal_seek_realtime_usec(journal.get(), ts); 20542056b6d1SManojkiran Eda if (ret < 0) 20552056b6d1SManojkiran Eda { 20562056b6d1SManojkiran Eda BMCWEB_LOG_ERROR << "failed to seek to an entry in journal" 20572056b6d1SManojkiran Eda << strerror(-ret); 20582056b6d1SManojkiran Eda messages::internalError(asyncResp->res); 20592056b6d1SManojkiran Eda return; 20602056b6d1SManojkiran Eda } 2061271584abSEd Tanous for (uint64_t i = 0; i <= index; i++) 2062e1f26343SJason M. Bills { 2063e1f26343SJason M. Bills sd_journal_next(journal.get()); 2064af07e3f5SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2065af07e3f5SJason M. Bills { 2066af07e3f5SJason M. Bills messages::internalError(asyncResp->res); 2067af07e3f5SJason M. Bills return; 2068af07e3f5SJason M. Bills } 2069af07e3f5SJason M. Bills if (firstEntry) 2070af07e3f5SJason M. Bills { 2071af07e3f5SJason M. Bills firstEntry = false; 2072af07e3f5SJason M. Bills } 2073e1f26343SJason M. Bills } 2074c4bf6374SJason M. Bills // Confirm that the entry ID matches what was requested 2075af07e3f5SJason M. Bills if (idStr != entryID) 2076c4bf6374SJason M. Bills { 2077c4bf6374SJason M. Bills messages::resourceMissingAtURI(asyncResp->res, entryID); 2078c4bf6374SJason M. Bills return; 2079c4bf6374SJason M. Bills } 2080c4bf6374SJason M. Bills 2081c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(entryID, journal.get(), 2082e1f26343SJason M. Bills asyncResp->res.jsonValue) != 0) 2083e1f26343SJason M. Bills { 2084f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2085e1f26343SJason M. Bills return; 2086e1f26343SJason M. Bills } 20877e860f15SJohn Edward Broadbent }); 2088c9bb6861Sraviteja-b } 2089c9bb6861Sraviteja-b 20907e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpService(App& app) 2091c9bb6861Sraviteja-b { 20927e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/") 2093432a890cSEd Tanous .privileges({{"Login"}}) 20947e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 20957e860f15SJohn Edward Broadbent [](const crow::Request&, 20967e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2097c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.id"] = 20985cb1dd27SAsmitha Karunanithi "/redfish/v1/Managers/bmc/LogServices/Dump"; 2099c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.type"] = 2100d337bb72SAsmitha Karunanithi "#LogService.v1_2_0.LogService"; 2101c9bb6861Sraviteja-b asyncResp->res.jsonValue["Name"] = "Dump LogService"; 21025cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Description"] = "BMC Dump LogService"; 21035cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = "Dump"; 2104c9bb6861Sraviteja-b asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 21057c8c4058STejas Patil 21067c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 21077c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 21087c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = 21097c8c4058STejas Patil redfishDateTimeOffset.first; 21107c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 21117c8c4058STejas Patil redfishDateTimeOffset.second; 21127c8c4058STejas Patil 2113c9bb6861Sraviteja-b asyncResp->res.jsonValue["Entries"] = { 21147e860f15SJohn Edward Broadbent {"@odata.id", 21157e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"}}; 21165cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Actions"] = { 21175cb1dd27SAsmitha Karunanithi {"#LogService.ClearLog", 21185cb1dd27SAsmitha Karunanithi {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/" 21195cb1dd27SAsmitha Karunanithi "Actions/LogService.ClearLog"}}}, 2120d337bb72SAsmitha Karunanithi {"#LogService.CollectDiagnosticData", 2121d337bb72SAsmitha Karunanithi {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/" 2122d337bb72SAsmitha Karunanithi "Actions/LogService.CollectDiagnosticData"}}}}; 21237e860f15SJohn Edward Broadbent }); 2124c9bb6861Sraviteja-b } 2125c9bb6861Sraviteja-b 21267e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntryCollection(App& app) 21277e860f15SJohn Edward Broadbent { 21287e860f15SJohn Edward Broadbent 2129c9bb6861Sraviteja-b /** 2130c9bb6861Sraviteja-b * Functions triggers appropriate requests on DBus 2131c9bb6861Sraviteja-b */ 21327e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/") 2133432a890cSEd Tanous .privileges({{"Login"}}) 21347e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 21357e860f15SJohn Edward Broadbent [](const crow::Request&, 21367e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2137c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.type"] = 2138c9bb6861Sraviteja-b "#LogEntryCollection.LogEntryCollection"; 2139c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.id"] = 21405cb1dd27SAsmitha Karunanithi "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"; 21415cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = "BMC Dump Entries"; 2142c9bb6861Sraviteja-b asyncResp->res.jsonValue["Description"] = 21435cb1dd27SAsmitha Karunanithi "Collection of BMC Dump Entries"; 2144c9bb6861Sraviteja-b 21455cb1dd27SAsmitha Karunanithi getDumpEntryCollection(asyncResp, "BMC"); 21467e860f15SJohn Edward Broadbent }); 2147c9bb6861Sraviteja-b } 2148c9bb6861Sraviteja-b 21497e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app) 2150c9bb6861Sraviteja-b { 21517e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 21527e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2153432a890cSEd Tanous .privileges({{"Login"}}) 21547e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 21557e860f15SJohn Edward Broadbent [](const crow::Request&, 21567e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 21577e860f15SJohn Edward Broadbent const std::string& param) { 21587e860f15SJohn Edward Broadbent getDumpEntryById(asyncResp, param, "BMC"); 21597e860f15SJohn Edward Broadbent }); 21607e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 21617e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2162432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 21637e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::delete_)( 21647e860f15SJohn Edward Broadbent [](const crow::Request&, 21657e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 21667e860f15SJohn Edward Broadbent const std::string& param) { 21677e860f15SJohn Edward Broadbent deleteDumpEntry(asyncResp, param, "bmc"); 21687e860f15SJohn Edward Broadbent }); 2169c9bb6861Sraviteja-b } 2170c9bb6861Sraviteja-b 21717e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app) 2172c9bb6861Sraviteja-b { 21738d1b46d7Szhanghch05 21747e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/" 2175d337bb72SAsmitha Karunanithi "Actions/" 2176d337bb72SAsmitha Karunanithi "LogService.CollectDiagnosticData/") 2177432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 21787e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 21797e860f15SJohn Edward Broadbent [](const crow::Request& req, 21807e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 21818d1b46d7Szhanghch05 createDump(asyncResp, req, "BMC"); 21827e860f15SJohn Edward Broadbent }); 2183a43be80fSAsmitha Karunanithi } 2184a43be80fSAsmitha Karunanithi 21857e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app) 218680319af1SAsmitha Karunanithi { 21877e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/" 218880319af1SAsmitha Karunanithi "Actions/" 218980319af1SAsmitha Karunanithi "LogService.ClearLog/") 2190432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 21917e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 21927e860f15SJohn Edward Broadbent [](const crow::Request&, 21937e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 21948d1b46d7Szhanghch05 clearDump(asyncResp, "BMC"); 21957e860f15SJohn Edward Broadbent }); 21965cb1dd27SAsmitha Karunanithi } 21975cb1dd27SAsmitha Karunanithi 21987e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app) 21995cb1dd27SAsmitha Karunanithi { 22007e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/") 2201432a890cSEd Tanous .privileges({{"Login"}}) 22027e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 22037e860f15SJohn Edward Broadbent [](const crow::Request&, 22047e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 22055cb1dd27SAsmitha Karunanithi 22067e860f15SJohn Edward Broadbent { 22075cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.id"] = 22085cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump"; 22095cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 2210d337bb72SAsmitha Karunanithi "#LogService.v1_2_0.LogService"; 22115cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = "Dump LogService"; 22127e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Description"] = 22137e860f15SJohn Edward Broadbent "System Dump LogService"; 22145cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = "Dump"; 22155cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 22167c8c4058STejas Patil 22177c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 22187c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 22197c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = 22207c8c4058STejas Patil redfishDateTimeOffset.first; 22217c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 22227c8c4058STejas Patil redfishDateTimeOffset.second; 22237c8c4058STejas Patil 22245cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Entries"] = { 22255cb1dd27SAsmitha Karunanithi {"@odata.id", 22265cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump/Entries"}}; 22275cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Actions"] = { 22285cb1dd27SAsmitha Karunanithi {"#LogService.ClearLog", 22297e860f15SJohn Edward Broadbent {{"target", 22307e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump/Actions/" 22315cb1dd27SAsmitha Karunanithi "LogService.ClearLog"}}}, 2232d337bb72SAsmitha Karunanithi {"#LogService.CollectDiagnosticData", 22337e860f15SJohn Edward Broadbent {{"target", 22347e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump/Actions/" 2235d337bb72SAsmitha Karunanithi "LogService.CollectDiagnosticData"}}}}; 22367e860f15SJohn Edward Broadbent }); 22375cb1dd27SAsmitha Karunanithi } 22385cb1dd27SAsmitha Karunanithi 22397e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app) 22407e860f15SJohn Edward Broadbent { 22417e860f15SJohn Edward Broadbent 22425cb1dd27SAsmitha Karunanithi /** 22435cb1dd27SAsmitha Karunanithi * Functions triggers appropriate requests on DBus 22445cb1dd27SAsmitha Karunanithi */ 2245f9a6708cSCharles Boyer BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/") 2246432a890cSEd Tanous .privileges({{"Login"}}) 22477e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 22487e860f15SJohn Edward Broadbent [](const crow::Request&, 2249864d6a17SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 22505cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 22515cb1dd27SAsmitha Karunanithi "#LogEntryCollection.LogEntryCollection"; 22525cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.id"] = 22535cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump/Entries"; 22545cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = "System Dump Entries"; 22555cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Description"] = 22565cb1dd27SAsmitha Karunanithi "Collection of System Dump Entries"; 22575cb1dd27SAsmitha Karunanithi 22585cb1dd27SAsmitha Karunanithi getDumpEntryCollection(asyncResp, "System"); 22597e860f15SJohn Edward Broadbent }); 22605cb1dd27SAsmitha Karunanithi } 22615cb1dd27SAsmitha Karunanithi 22627e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app) 22635cb1dd27SAsmitha Karunanithi { 22647e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 2265864d6a17SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/") 2266432a890cSEd Tanous .privileges({{"Login"}}) 22677e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 22687e860f15SJohn Edward Broadbent [](const crow::Request&, 22697e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 22707e860f15SJohn Edward Broadbent const std::string& param) { 22717e860f15SJohn Edward Broadbent getDumpEntryById(asyncResp, param, "System"); 22727e860f15SJohn Edward Broadbent }); 22738d1b46d7Szhanghch05 22747e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 2275864d6a17SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/") 2276432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 22777e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::delete_)( 22787e860f15SJohn Edward Broadbent [](const crow::Request&, 22797e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 22807e860f15SJohn Edward Broadbent const std::string& param) { 22817e860f15SJohn Edward Broadbent deleteDumpEntry(asyncResp, param, "system"); 22827e860f15SJohn Edward Broadbent }); 22835cb1dd27SAsmitha Karunanithi } 2284c9bb6861Sraviteja-b 22857e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app) 2286c9bb6861Sraviteja-b { 22877e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/" 2288d337bb72SAsmitha Karunanithi "Actions/" 2289d337bb72SAsmitha Karunanithi "LogService.CollectDiagnosticData/") 2290432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 22917e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 22927e860f15SJohn Edward Broadbent [](const crow::Request& req, 22937e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 22947e860f15SJohn Edward Broadbent 22957e860f15SJohn Edward Broadbent { createDump(asyncResp, req, "System"); }); 2296a43be80fSAsmitha Karunanithi } 2297a43be80fSAsmitha Karunanithi 22987e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app) 2299a43be80fSAsmitha Karunanithi { 23007e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/" 2301013487e5Sraviteja-b "Actions/" 2302013487e5Sraviteja-b "LogService.ClearLog/") 2303432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 23047e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 23057e860f15SJohn Edward Broadbent [](const crow::Request&, 23067e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 23077e860f15SJohn Edward Broadbent 23087e860f15SJohn Edward Broadbent { clearDump(asyncResp, "System"); }); 2309013487e5Sraviteja-b } 2310013487e5Sraviteja-b 23117e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app) 23121da66f75SEd Tanous { 23133946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 23143946028dSAppaRao Puli // method for security reasons. 23151da66f75SEd Tanous /** 23161da66f75SEd Tanous * Functions triggers appropriate requests on DBus 23171da66f75SEd Tanous */ 23187e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Crashdump/") 2319432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 23207e860f15SJohn Edward Broadbent .methods( 23217e860f15SJohn Edward Broadbent boost::beast::http::verb:: 23227e860f15SJohn Edward Broadbent get)([](const crow::Request&, 23237e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 23247e860f15SJohn Edward Broadbent // Copy over the static data to include the entries added by 23257e860f15SJohn Edward Broadbent // SubRoute 23260f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2327424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"; 2328e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 23298e6c099aSJason M. Bills "#LogService.v1_2_0.LogService"; 23304f50ae4bSGunnar Mills asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service"; 23314f50ae4bSGunnar Mills asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service"; 23324f50ae4bSGunnar Mills asyncResp->res.jsonValue["Id"] = "Oem Crashdump"; 2333e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 2334e1f26343SJason M. Bills asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; 23357c8c4058STejas Patil 23367c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 23377c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 23387c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 23397c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 23407c8c4058STejas Patil redfishDateTimeOffset.second; 23417c8c4058STejas Patil 2342cd50aa42SJason M. Bills asyncResp->res.jsonValue["Entries"] = { 2343cd50aa42SJason M. Bills {"@odata.id", 2344424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}}; 2345e1f26343SJason M. Bills asyncResp->res.jsonValue["Actions"] = { 23465b61b5e8SJason M. Bills {"#LogService.ClearLog", 23475b61b5e8SJason M. Bills {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/" 23485b61b5e8SJason M. Bills "Actions/LogService.ClearLog"}}}, 23498e6c099aSJason M. Bills {"#LogService.CollectDiagnosticData", 2350424c4176SJason M. Bills {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/" 23518e6c099aSJason M. Bills "Actions/LogService.CollectDiagnosticData"}}}}; 23527e860f15SJohn Edward Broadbent }); 23531da66f75SEd Tanous } 23541da66f75SEd Tanous 23557e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app) 23565b61b5e8SJason M. Bills { 23577e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 23587e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/" 23595b61b5e8SJason M. Bills "LogService.ClearLog/") 2360432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 23617e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 23627e860f15SJohn Edward Broadbent [](const crow::Request&, 23637e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 23645b61b5e8SJason M. Bills crow::connections::systemBus->async_method_call( 23655b61b5e8SJason M. Bills [asyncResp](const boost::system::error_code ec, 2366cb13a392SEd Tanous const std::string&) { 23675b61b5e8SJason M. Bills if (ec) 23685b61b5e8SJason M. Bills { 23695b61b5e8SJason M. Bills messages::internalError(asyncResp->res); 23705b61b5e8SJason M. Bills return; 23715b61b5e8SJason M. Bills } 23725b61b5e8SJason M. Bills messages::success(asyncResp->res); 23735b61b5e8SJason M. Bills }, 23747e860f15SJohn Edward Broadbent crashdumpObject, crashdumpPath, deleteAllInterface, 23757e860f15SJohn Edward Broadbent "DeleteAll"); 23767e860f15SJohn Edward Broadbent }); 23775b61b5e8SJason M. Bills } 23785b61b5e8SJason M. Bills 23798d1b46d7Szhanghch05 static void 23808d1b46d7Szhanghch05 logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 23818d1b46d7Szhanghch05 const std::string& logID, nlohmann::json& logEntryJson) 2382e855dd28SJason M. Bills { 2383043a0536SJohnathan Mantey auto getStoredLogCallback = 2384043a0536SJohnathan Mantey [asyncResp, logID, &logEntryJson]( 2385e855dd28SJason M. Bills const boost::system::error_code ec, 2386043a0536SJohnathan Mantey const std::vector<std::pair<std::string, VariantType>>& params) { 2387e855dd28SJason M. Bills if (ec) 2388e855dd28SJason M. Bills { 2389e855dd28SJason M. Bills BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 23901ddcf01aSJason M. Bills if (ec.value() == 23911ddcf01aSJason M. Bills boost::system::linux_error::bad_request_descriptor) 23921ddcf01aSJason M. Bills { 2393043a0536SJohnathan Mantey messages::resourceNotFound(asyncResp->res, "LogEntry", 2394043a0536SJohnathan Mantey logID); 23951ddcf01aSJason M. Bills } 23961ddcf01aSJason M. Bills else 23971ddcf01aSJason M. Bills { 2398e855dd28SJason M. Bills messages::internalError(asyncResp->res); 23991ddcf01aSJason M. Bills } 2400e855dd28SJason M. Bills return; 2401e855dd28SJason M. Bills } 2402043a0536SJohnathan Mantey 2403043a0536SJohnathan Mantey std::string timestamp{}; 2404043a0536SJohnathan Mantey std::string filename{}; 2405043a0536SJohnathan Mantey std::string logfile{}; 24062c70f800SEd Tanous parseCrashdumpParameters(params, filename, timestamp, logfile); 2407043a0536SJohnathan Mantey 2408043a0536SJohnathan Mantey if (filename.empty() || timestamp.empty()) 2409e855dd28SJason M. Bills { 2410043a0536SJohnathan Mantey messages::resourceMissingAtURI(asyncResp->res, logID); 2411e855dd28SJason M. Bills return; 2412e855dd28SJason M. Bills } 2413e855dd28SJason M. Bills 2414043a0536SJohnathan Mantey std::string crashdumpURI = 2415e855dd28SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + 2416043a0536SJohnathan Mantey logID + "/" + filename; 24170ef217f4SGeorge Liu logEntryJson = {{"@odata.type", "#LogEntry.v1_8_0.LogEntry"}, 2418043a0536SJohnathan Mantey {"@odata.id", "/redfish/v1/Systems/system/" 2419043a0536SJohnathan Mantey "LogServices/Crashdump/Entries/" + 2420e855dd28SJason M. Bills logID}, 2421e855dd28SJason M. Bills {"Name", "CPU Crashdump"}, 2422e855dd28SJason M. Bills {"Id", logID}, 2423e855dd28SJason M. Bills {"EntryType", "Oem"}, 24248e6c099aSJason M. Bills {"AdditionalDataURI", std::move(crashdumpURI)}, 24258e6c099aSJason M. Bills {"DiagnosticDataType", "OEM"}, 24268e6c099aSJason M. Bills {"OEMDiagnosticDataType", "PECICrashdump"}, 2427043a0536SJohnathan Mantey {"Created", std::move(timestamp)}}; 2428e855dd28SJason M. Bills }; 2429e855dd28SJason M. Bills crow::connections::systemBus->async_method_call( 24305b61b5e8SJason M. Bills std::move(getStoredLogCallback), crashdumpObject, 24315b61b5e8SJason M. Bills crashdumpPath + std::string("/") + logID, 2432043a0536SJohnathan Mantey "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface); 2433e855dd28SJason M. Bills } 2434e855dd28SJason M. Bills 24357e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app) 24361da66f75SEd Tanous { 24373946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 24383946028dSAppaRao Puli // method for security reasons. 24391da66f75SEd Tanous /** 24401da66f75SEd Tanous * Functions triggers appropriate requests on DBus 24411da66f75SEd Tanous */ 24427e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 24437e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/") 2444432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 24457e860f15SJohn Edward Broadbent .methods( 24467e860f15SJohn Edward Broadbent boost::beast::http::verb:: 24477e860f15SJohn Edward Broadbent get)([](const crow::Request&, 24487e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 24497e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 24507e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2451e1f26343SJason M. Bills auto getLogEntriesCallback = [asyncResp]( 2452e1f26343SJason M. Bills const boost::system::error_code ec, 24537e860f15SJohn Edward Broadbent const std::vector<std::string>& 24547e860f15SJohn Edward Broadbent resp) { 24551da66f75SEd Tanous if (ec) 24561da66f75SEd Tanous { 24571da66f75SEd Tanous if (ec.value() != 24581da66f75SEd Tanous boost::system::errc::no_such_file_or_directory) 24591da66f75SEd Tanous { 24601da66f75SEd Tanous BMCWEB_LOG_DEBUG << "failed to get entries ec: " 24611da66f75SEd Tanous << ec.message(); 2462f12894f8SJason M. Bills messages::internalError(asyncResp->res); 24631da66f75SEd Tanous return; 24641da66f75SEd Tanous } 24651da66f75SEd Tanous } 2466e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 24671da66f75SEd Tanous "#LogEntryCollection.LogEntryCollection"; 24680f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2469424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 2470424c4176SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries"; 2471e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2472424c4176SJason M. Bills "Collection of Crashdump Entries"; 24737e860f15SJohn Edward Broadbent nlohmann::json& logEntryArray = 24747e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members"]; 2475e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 2476e855dd28SJason M. Bills std::vector<std::string> logIDs; 2477e855dd28SJason M. Bills // Get the list of log entries and build up an empty array big 2478e855dd28SJason M. Bills // enough to hold them 24791da66f75SEd Tanous for (const std::string& objpath : resp) 24801da66f75SEd Tanous { 2481e855dd28SJason M. Bills // Get the log ID 2482f23b7296SEd Tanous std::size_t lastPos = objpath.rfind('/'); 2483e855dd28SJason M. Bills if (lastPos == std::string::npos) 24841da66f75SEd Tanous { 2485e855dd28SJason M. Bills continue; 24861da66f75SEd Tanous } 2487e855dd28SJason M. Bills logIDs.emplace_back(objpath.substr(lastPos + 1)); 2488e855dd28SJason M. Bills 2489e855dd28SJason M. Bills // Add a space for the log entry to the array 2490e855dd28SJason M. Bills logEntryArray.push_back({}); 2491e855dd28SJason M. Bills } 2492e855dd28SJason M. Bills // Now go through and set up async calls to fill in the entries 2493e855dd28SJason M. Bills size_t index = 0; 2494e855dd28SJason M. Bills for (const std::string& logID : logIDs) 2495e855dd28SJason M. Bills { 2496e855dd28SJason M. Bills // Add the log entry to the array 2497e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, logEntryArray[index++]); 24981da66f75SEd Tanous } 2499e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 2500e1f26343SJason M. Bills logEntryArray.size(); 25011da66f75SEd Tanous }; 25021da66f75SEd Tanous crow::connections::systemBus->async_method_call( 25031da66f75SEd Tanous std::move(getLogEntriesCallback), 25041da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", 25051da66f75SEd Tanous "/xyz/openbmc_project/object_mapper", 25061da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0, 25075b61b5e8SJason M. Bills std::array<const char*, 1>{crashdumpInterface}); 25087e860f15SJohn Edward Broadbent }); 25091da66f75SEd Tanous } 25101da66f75SEd Tanous 25117e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app) 25121da66f75SEd Tanous { 25133946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 25143946028dSAppaRao Puli // method for security reasons. 25151da66f75SEd Tanous 25167e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 25177e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/") 2518432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 25197e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 25207e860f15SJohn Edward Broadbent [](const crow::Request&, 25217e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 25227e860f15SJohn Edward Broadbent const std::string& param) { 25237e860f15SJohn Edward Broadbent const std::string& logID = param; 2524e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue); 25257e860f15SJohn Edward Broadbent }); 2526e855dd28SJason M. Bills } 2527e855dd28SJason M. Bills 25287e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app) 2529e855dd28SJason M. Bills { 25303946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 25313946028dSAppaRao Puli // method for security reasons. 25327e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 25337e860f15SJohn Edward Broadbent app, 25347e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/<str>/") 2535432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 25367e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 25377e860f15SJohn Edward Broadbent [](const crow::Request&, 25387e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 25397e860f15SJohn Edward Broadbent const std::string& logID, const std::string& fileName) { 2540043a0536SJohnathan Mantey auto getStoredLogCallback = 2541043a0536SJohnathan Mantey [asyncResp, logID, fileName]( 2542abf2add6SEd Tanous const boost::system::error_code ec, 25437e860f15SJohn Edward Broadbent const std::vector<std::pair<std::string, VariantType>>& 25447e860f15SJohn Edward Broadbent resp) { 25451da66f75SEd Tanous if (ec) 25461da66f75SEd Tanous { 2547043a0536SJohnathan Mantey BMCWEB_LOG_DEBUG << "failed to get log ec: " 2548043a0536SJohnathan Mantey << ec.message(); 2549f12894f8SJason M. Bills messages::internalError(asyncResp->res); 25501da66f75SEd Tanous return; 25511da66f75SEd Tanous } 2552e855dd28SJason M. Bills 2553043a0536SJohnathan Mantey std::string dbusFilename{}; 2554043a0536SJohnathan Mantey std::string dbusTimestamp{}; 2555043a0536SJohnathan Mantey std::string dbusFilepath{}; 2556043a0536SJohnathan Mantey 25577e860f15SJohn Edward Broadbent parseCrashdumpParameters(resp, dbusFilename, 25587e860f15SJohn Edward Broadbent dbusTimestamp, dbusFilepath); 2559043a0536SJohnathan Mantey 2560043a0536SJohnathan Mantey if (dbusFilename.empty() || dbusTimestamp.empty() || 2561043a0536SJohnathan Mantey dbusFilepath.empty()) 25621da66f75SEd Tanous { 25637e860f15SJohn Edward Broadbent messages::resourceMissingAtURI(asyncResp->res, 25647e860f15SJohn Edward Broadbent fileName); 25651da66f75SEd Tanous return; 25661da66f75SEd Tanous } 2567e855dd28SJason M. Bills 2568043a0536SJohnathan Mantey // Verify the file name parameter is correct 2569043a0536SJohnathan Mantey if (fileName != dbusFilename) 2570043a0536SJohnathan Mantey { 25717e860f15SJohn Edward Broadbent messages::resourceMissingAtURI(asyncResp->res, 25727e860f15SJohn Edward Broadbent fileName); 2573043a0536SJohnathan Mantey return; 2574043a0536SJohnathan Mantey } 2575043a0536SJohnathan Mantey 2576043a0536SJohnathan Mantey if (!std::filesystem::exists(dbusFilepath)) 2577043a0536SJohnathan Mantey { 25787e860f15SJohn Edward Broadbent messages::resourceMissingAtURI(asyncResp->res, 25797e860f15SJohn Edward Broadbent fileName); 2580043a0536SJohnathan Mantey return; 2581043a0536SJohnathan Mantey } 2582043a0536SJohnathan Mantey std::ifstream ifs(dbusFilepath, std::ios::in | 2583043a0536SJohnathan Mantey std::ios::binary | 2584043a0536SJohnathan Mantey std::ios::ate); 2585043a0536SJohnathan Mantey std::ifstream::pos_type fileSize = ifs.tellg(); 2586043a0536SJohnathan Mantey if (fileSize < 0) 2587043a0536SJohnathan Mantey { 2588043a0536SJohnathan Mantey messages::generalError(asyncResp->res); 2589043a0536SJohnathan Mantey return; 2590043a0536SJohnathan Mantey } 2591043a0536SJohnathan Mantey ifs.seekg(0, std::ios::beg); 2592043a0536SJohnathan Mantey 2593043a0536SJohnathan Mantey auto crashData = std::make_unique<char[]>( 2594043a0536SJohnathan Mantey static_cast<unsigned int>(fileSize)); 2595043a0536SJohnathan Mantey 2596043a0536SJohnathan Mantey ifs.read(crashData.get(), static_cast<int>(fileSize)); 2597043a0536SJohnathan Mantey 25987e860f15SJohn Edward Broadbent // The cast to std::string is intentional in order to 25997e860f15SJohn Edward Broadbent // use the assign() that applies move mechanics 2600043a0536SJohnathan Mantey asyncResp->res.body().assign( 2601043a0536SJohnathan Mantey static_cast<std::string>(crashData.get())); 2602043a0536SJohnathan Mantey 26037e860f15SJohn Edward Broadbent // Configure this to be a file download when accessed 26047e860f15SJohn Edward Broadbent // from a browser 26057e860f15SJohn Edward Broadbent asyncResp->res.addHeader("Content-Disposition", 26067e860f15SJohn Edward Broadbent "attachment"); 26071da66f75SEd Tanous }; 26081da66f75SEd Tanous crow::connections::systemBus->async_method_call( 26095b61b5e8SJason M. Bills std::move(getStoredLogCallback), crashdumpObject, 26105b61b5e8SJason M. Bills crashdumpPath + std::string("/") + logID, 26117e860f15SJohn Edward Broadbent "org.freedesktop.DBus.Properties", "GetAll", 26127e860f15SJohn Edward Broadbent crashdumpInterface); 26137e860f15SJohn Edward Broadbent }); 26141da66f75SEd Tanous } 26151da66f75SEd Tanous 26167e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app) 26171da66f75SEd Tanous { 26183946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 26193946028dSAppaRao Puli // method for security reasons. 26207e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Crashdump/" 26217e860f15SJohn Edward Broadbent "Actions/LogService.CollectDiagnosticData/") 2622432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 26237e860f15SJohn Edward Broadbent .methods( 26247e860f15SJohn Edward Broadbent boost::beast::http::verb:: 26257e860f15SJohn Edward Broadbent post)([](const crow::Request& req, 26267e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 26278e6c099aSJason M. Bills std::string diagnosticDataType; 26288e6c099aSJason M. Bills std::string oemDiagnosticDataType; 26298e6c099aSJason M. Bills if (!redfish::json_util::readJson( 26307e860f15SJohn Edward Broadbent req, asyncResp->res, "DiagnosticDataType", 26317e860f15SJohn Edward Broadbent diagnosticDataType, "OEMDiagnosticDataType", 26327e860f15SJohn Edward Broadbent oemDiagnosticDataType)) 26338e6c099aSJason M. Bills { 26348e6c099aSJason M. Bills return; 26358e6c099aSJason M. Bills } 26368e6c099aSJason M. Bills 26378e6c099aSJason M. Bills if (diagnosticDataType != "OEM") 26388e6c099aSJason M. Bills { 26398e6c099aSJason M. Bills BMCWEB_LOG_ERROR 26408e6c099aSJason M. Bills << "Only OEM DiagnosticDataType supported for Crashdump"; 26418e6c099aSJason M. Bills messages::actionParameterValueFormatError( 26428e6c099aSJason M. Bills asyncResp->res, diagnosticDataType, "DiagnosticDataType", 26438e6c099aSJason M. Bills "CollectDiagnosticData"); 26448e6c099aSJason M. Bills return; 26458e6c099aSJason M. Bills } 26468e6c099aSJason M. Bills 26478e6c099aSJason M. Bills auto collectCrashdumpCallback = [asyncResp, req]( 26487e860f15SJohn Edward Broadbent const boost::system::error_code 26497e860f15SJohn Edward Broadbent ec, 2650cb13a392SEd Tanous const std::string&) { 26511da66f75SEd Tanous if (ec) 26521da66f75SEd Tanous { 26537e860f15SJohn Edward Broadbent if (ec.value() == 26547e860f15SJohn Edward Broadbent boost::system::errc::operation_not_supported) 26551da66f75SEd Tanous { 2656f12894f8SJason M. Bills messages::resourceInStandby(asyncResp->res); 26571da66f75SEd Tanous } 26584363d3b2SJason M. Bills else if (ec.value() == 26594363d3b2SJason M. Bills boost::system::errc::device_or_resource_busy) 26604363d3b2SJason M. Bills { 26614363d3b2SJason M. Bills messages::serviceTemporarilyUnavailable(asyncResp->res, 26624363d3b2SJason M. Bills "60"); 26634363d3b2SJason M. Bills } 26641da66f75SEd Tanous else 26651da66f75SEd Tanous { 2666f12894f8SJason M. Bills messages::internalError(asyncResp->res); 26671da66f75SEd Tanous } 26681da66f75SEd Tanous return; 26691da66f75SEd Tanous } 26707e860f15SJohn Edward Broadbent std::shared_ptr<task::TaskData> task = 26717e860f15SJohn Edward Broadbent task::TaskData::createTask( 26727e860f15SJohn Edward Broadbent [](boost::system::error_code err, 26737e860f15SJohn Edward Broadbent sdbusplus::message::message&, 267466afe4faSJames Feist const std::shared_ptr<task::TaskData>& taskData) { 267566afe4faSJames Feist if (!err) 267666afe4faSJames Feist { 2677e5d5006bSJames Feist taskData->messages.emplace_back( 2678e5d5006bSJames Feist messages::taskCompletedOK( 2679e5d5006bSJames Feist std::to_string(taskData->index))); 2680831d6b09SJames Feist taskData->state = "Completed"; 268166afe4faSJames Feist } 268232898ceaSJames Feist return task::completed; 268366afe4faSJames Feist }, 26847e860f15SJohn Edward Broadbent "type='signal',interface='org.freedesktop.DBus." 26857e860f15SJohn Edward Broadbent "Properties'," 268646229577SJames Feist "member='PropertiesChanged',arg0namespace='com.intel." 268746229577SJames Feist "crashdump'"); 268846229577SJames Feist task->startTimer(std::chrono::minutes(5)); 268946229577SJames Feist task->populateResp(asyncResp->res); 2690fe306728SJames Feist task->payload.emplace(req); 26911da66f75SEd Tanous }; 26928e6c099aSJason M. Bills 26938e6c099aSJason M. Bills if (oemDiagnosticDataType == "OnDemand") 26948e6c099aSJason M. Bills { 26951da66f75SEd Tanous crow::connections::systemBus->async_method_call( 26968e6c099aSJason M. Bills std::move(collectCrashdumpCallback), crashdumpObject, 26978e6c099aSJason M. Bills crashdumpPath, crashdumpOnDemandInterface, 26988e6c099aSJason M. Bills "GenerateOnDemandLog"); 26991da66f75SEd Tanous } 27008e6c099aSJason M. Bills else if (oemDiagnosticDataType == "Telemetry") 27016eda7685SKenny L. Ku { 27028e6c099aSJason M. Bills crow::connections::systemBus->async_method_call( 27038e6c099aSJason M. Bills std::move(collectCrashdumpCallback), crashdumpObject, 27048e6c099aSJason M. Bills crashdumpPath, crashdumpTelemetryInterface, 27058e6c099aSJason M. Bills "GenerateTelemetryLog"); 27066eda7685SKenny L. Ku } 27076eda7685SKenny L. Ku else 27086eda7685SKenny L. Ku { 27098e6c099aSJason M. Bills BMCWEB_LOG_ERROR << "Unsupported OEMDiagnosticDataType: " 27108e6c099aSJason M. Bills << oemDiagnosticDataType; 27118e6c099aSJason M. Bills messages::actionParameterValueFormatError( 27127e860f15SJohn Edward Broadbent asyncResp->res, oemDiagnosticDataType, 27137e860f15SJohn Edward Broadbent "OEMDiagnosticDataType", "CollectDiagnosticData"); 27146eda7685SKenny L. Ku return; 27156eda7685SKenny L. Ku } 27167e860f15SJohn Edward Broadbent }); 27176eda7685SKenny L. Ku } 27186eda7685SKenny L. Ku 2719cb92c03bSAndrew Geissler /** 2720cb92c03bSAndrew Geissler * DBusLogServiceActionsClear class supports POST method for ClearLog action. 2721cb92c03bSAndrew Geissler */ 27227e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app) 2723cb92c03bSAndrew Geissler { 2724cb92c03bSAndrew Geissler /** 2725cb92c03bSAndrew Geissler * Function handles POST method request. 2726cb92c03bSAndrew Geissler * The Clear Log actions does not require any parameter.The action deletes 2727cb92c03bSAndrew Geissler * all entries found in the Entries collection for this Log Service. 2728cb92c03bSAndrew Geissler */ 27297e860f15SJohn Edward Broadbent 27307e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/" 27317e860f15SJohn Edward Broadbent "LogService.ClearLog/") 2732432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 27337e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 27347e860f15SJohn Edward Broadbent [](const crow::Request&, 27357e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2736cb92c03bSAndrew Geissler BMCWEB_LOG_DEBUG << "Do delete all entries."; 2737cb92c03bSAndrew Geissler 2738cb92c03bSAndrew Geissler // Process response from Logging service. 27397e860f15SJohn Edward Broadbent auto respHandler = [asyncResp]( 27407e860f15SJohn Edward Broadbent const boost::system::error_code ec) { 27417e860f15SJohn Edward Broadbent BMCWEB_LOG_DEBUG 27427e860f15SJohn Edward Broadbent << "doClearLog resp_handler callback: Done"; 2743cb92c03bSAndrew Geissler if (ec) 2744cb92c03bSAndrew Geissler { 2745cb92c03bSAndrew Geissler // TODO Handle for specific error code 27467e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " 27477e860f15SJohn Edward Broadbent << ec; 2748cb92c03bSAndrew Geissler asyncResp->res.result( 2749cb92c03bSAndrew Geissler boost::beast::http::status::internal_server_error); 2750cb92c03bSAndrew Geissler return; 2751cb92c03bSAndrew Geissler } 2752cb92c03bSAndrew Geissler 27537e860f15SJohn Edward Broadbent asyncResp->res.result( 27547e860f15SJohn Edward Broadbent boost::beast::http::status::no_content); 2755cb92c03bSAndrew Geissler }; 2756cb92c03bSAndrew Geissler 2757cb92c03bSAndrew Geissler // Make call to Logging service to request Clear Log 2758cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 27592c70f800SEd Tanous respHandler, "xyz.openbmc_project.Logging", 2760cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging", 2761cb92c03bSAndrew Geissler "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 27627e860f15SJohn Edward Broadbent }); 2763cb92c03bSAndrew Geissler } 2764a3316fc6SZhikuiRen 2765a3316fc6SZhikuiRen /**************************************************** 2766a3316fc6SZhikuiRen * Redfish PostCode interfaces 2767a3316fc6SZhikuiRen * using DBUS interface: getPostCodesTS 2768a3316fc6SZhikuiRen ******************************************************/ 27697e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesLogService(App& app) 2770a3316fc6SZhikuiRen { 27717e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/PostCodes/") 2772432a890cSEd Tanous .privileges({{"Login"}}) 27737e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 27747e860f15SJohn Edward Broadbent [](const crow::Request&, 27757e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2776a3316fc6SZhikuiRen asyncResp->res.jsonValue = { 27777e860f15SJohn Edward Broadbent {"@odata.id", 27787e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/PostCodes"}, 2779a3316fc6SZhikuiRen {"@odata.type", "#LogService.v1_1_0.LogService"}, 2780a3316fc6SZhikuiRen {"Name", "POST Code Log Service"}, 2781a3316fc6SZhikuiRen {"Description", "POST Code Log Service"}, 2782a3316fc6SZhikuiRen {"Id", "BIOS POST Code Log"}, 2783a3316fc6SZhikuiRen {"OverWritePolicy", "WrapsWhenFull"}, 2784a3316fc6SZhikuiRen {"Entries", 27857e860f15SJohn Edward Broadbent {{"@odata.id", "/redfish/v1/Systems/system/LogServices/" 27867e860f15SJohn Edward Broadbent "PostCodes/Entries"}}}}; 27877c8c4058STejas Patil 27887c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 27897c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 27907c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = 27917c8c4058STejas Patil redfishDateTimeOffset.first; 27927c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 27937c8c4058STejas Patil redfishDateTimeOffset.second; 27947c8c4058STejas Patil 2795a3316fc6SZhikuiRen asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 27967e860f15SJohn Edward Broadbent {"target", 27977e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/PostCodes/" 2798a3316fc6SZhikuiRen "Actions/LogService.ClearLog"}}; 27997e860f15SJohn Edward Broadbent }); 2800a3316fc6SZhikuiRen } 2801a3316fc6SZhikuiRen 28027e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesClear(App& app) 2803a3316fc6SZhikuiRen { 28047e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 28057e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/" 2806a3316fc6SZhikuiRen "LogService.ClearLog/") 2807432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 28087e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 28097e860f15SJohn Edward Broadbent [](const crow::Request&, 28107e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2811a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Do delete all postcodes entries."; 2812a3316fc6SZhikuiRen 2813a3316fc6SZhikuiRen // Make call to post-code service to request clear all 2814a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 2815a3316fc6SZhikuiRen [asyncResp](const boost::system::error_code ec) { 2816a3316fc6SZhikuiRen if (ec) 2817a3316fc6SZhikuiRen { 2818a3316fc6SZhikuiRen // TODO Handle for specific error code 2819a3316fc6SZhikuiRen BMCWEB_LOG_ERROR 28207e860f15SJohn Edward Broadbent << "doClearPostCodes resp_handler got error " 28217e860f15SJohn Edward Broadbent << ec; 28227e860f15SJohn Edward Broadbent asyncResp->res.result(boost::beast::http::status:: 28237e860f15SJohn Edward Broadbent internal_server_error); 2824a3316fc6SZhikuiRen messages::internalError(asyncResp->res); 2825a3316fc6SZhikuiRen return; 2826a3316fc6SZhikuiRen } 2827a3316fc6SZhikuiRen }, 282815124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 282915124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 2830a3316fc6SZhikuiRen "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 28317e860f15SJohn Edward Broadbent }); 2832a3316fc6SZhikuiRen } 2833a3316fc6SZhikuiRen 2834a3316fc6SZhikuiRen static void fillPostCodeEntry( 28358d1b46d7Szhanghch05 const std::shared_ptr<bmcweb::AsyncResp>& aResp, 28366c9a279eSManojkiran Eda const boost::container::flat_map< 28376c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode, 2838a3316fc6SZhikuiRen const uint16_t bootIndex, const uint64_t codeIndex = 0, 2839a3316fc6SZhikuiRen const uint64_t skip = 0, const uint64_t top = 0) 2840a3316fc6SZhikuiRen { 2841a3316fc6SZhikuiRen // Get the Message from the MessageRegistry 2842a3316fc6SZhikuiRen const message_registries::Message* message = 28434a0bf539SManojkiran Eda message_registries::getMessage("OpenBMC.0.2.BIOSPOSTCode"); 2844a3316fc6SZhikuiRen 2845a3316fc6SZhikuiRen uint64_t currentCodeIndex = 0; 2846a3316fc6SZhikuiRen nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"]; 2847a3316fc6SZhikuiRen 2848a3316fc6SZhikuiRen uint64_t firstCodeTimeUs = 0; 28496c9a279eSManojkiran Eda for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 28506c9a279eSManojkiran Eda code : postcode) 2851a3316fc6SZhikuiRen { 2852a3316fc6SZhikuiRen currentCodeIndex++; 2853a3316fc6SZhikuiRen std::string postcodeEntryID = 2854a3316fc6SZhikuiRen "B" + std::to_string(bootIndex) + "-" + 2855a3316fc6SZhikuiRen std::to_string(currentCodeIndex); // 1 based index in EntryID string 2856a3316fc6SZhikuiRen 2857a3316fc6SZhikuiRen uint64_t usecSinceEpoch = code.first; 2858a3316fc6SZhikuiRen uint64_t usTimeOffset = 0; 2859a3316fc6SZhikuiRen 2860a3316fc6SZhikuiRen if (1 == currentCodeIndex) 2861a3316fc6SZhikuiRen { // already incremented 2862a3316fc6SZhikuiRen firstCodeTimeUs = code.first; 2863a3316fc6SZhikuiRen } 2864a3316fc6SZhikuiRen else 2865a3316fc6SZhikuiRen { 2866a3316fc6SZhikuiRen usTimeOffset = code.first - firstCodeTimeUs; 2867a3316fc6SZhikuiRen } 2868a3316fc6SZhikuiRen 2869a3316fc6SZhikuiRen // skip if no specific codeIndex is specified and currentCodeIndex does 2870a3316fc6SZhikuiRen // not fall between top and skip 2871a3316fc6SZhikuiRen if ((codeIndex == 0) && 2872a3316fc6SZhikuiRen (currentCodeIndex <= skip || currentCodeIndex > top)) 2873a3316fc6SZhikuiRen { 2874a3316fc6SZhikuiRen continue; 2875a3316fc6SZhikuiRen } 2876a3316fc6SZhikuiRen 28774e0453b1SGunnar Mills // skip if a specific codeIndex is specified and does not match the 2878a3316fc6SZhikuiRen // currentIndex 2879a3316fc6SZhikuiRen if ((codeIndex > 0) && (currentCodeIndex != codeIndex)) 2880a3316fc6SZhikuiRen { 2881a3316fc6SZhikuiRen // This is done for simplicity. 1st entry is needed to calculate 2882a3316fc6SZhikuiRen // time offset. To improve efficiency, one can get to the entry 2883a3316fc6SZhikuiRen // directly (possibly with flatmap's nth method) 2884a3316fc6SZhikuiRen continue; 2885a3316fc6SZhikuiRen } 2886a3316fc6SZhikuiRen 2887a3316fc6SZhikuiRen // currentCodeIndex is within top and skip or equal to specified code 2888a3316fc6SZhikuiRen // index 2889a3316fc6SZhikuiRen 2890a3316fc6SZhikuiRen // Get the Created time from the timestamp 2891a3316fc6SZhikuiRen std::string entryTimeStr; 28929c620e21SAsmitha Karunanithi entryTimeStr = crow::utility::getDateTime( 28939c620e21SAsmitha Karunanithi static_cast<std::time_t>(usecSinceEpoch / 1000 / 1000)); 2894a3316fc6SZhikuiRen 2895a3316fc6SZhikuiRen // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex) 2896a3316fc6SZhikuiRen std::ostringstream hexCode; 2897a3316fc6SZhikuiRen hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex 28986c9a279eSManojkiran Eda << std::get<0>(code.second); 2899a3316fc6SZhikuiRen std::ostringstream timeOffsetStr; 2900a3316fc6SZhikuiRen // Set Fixed -Point Notation 2901a3316fc6SZhikuiRen timeOffsetStr << std::fixed; 2902a3316fc6SZhikuiRen // Set precision to 4 digits 2903a3316fc6SZhikuiRen timeOffsetStr << std::setprecision(4); 2904a3316fc6SZhikuiRen // Add double to stream 2905a3316fc6SZhikuiRen timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000; 2906a3316fc6SZhikuiRen std::vector<std::string> messageArgs = { 2907a3316fc6SZhikuiRen std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()}; 2908a3316fc6SZhikuiRen 2909a3316fc6SZhikuiRen // Get MessageArgs template from message registry 2910a3316fc6SZhikuiRen std::string msg; 2911a3316fc6SZhikuiRen if (message != nullptr) 2912a3316fc6SZhikuiRen { 2913a3316fc6SZhikuiRen msg = message->message; 2914a3316fc6SZhikuiRen 2915a3316fc6SZhikuiRen // fill in this post code value 2916a3316fc6SZhikuiRen int i = 0; 2917a3316fc6SZhikuiRen for (const std::string& messageArg : messageArgs) 2918a3316fc6SZhikuiRen { 2919a3316fc6SZhikuiRen std::string argStr = "%" + std::to_string(++i); 2920a3316fc6SZhikuiRen size_t argPos = msg.find(argStr); 2921a3316fc6SZhikuiRen if (argPos != std::string::npos) 2922a3316fc6SZhikuiRen { 2923a3316fc6SZhikuiRen msg.replace(argPos, argStr.length(), messageArg); 2924a3316fc6SZhikuiRen } 2925a3316fc6SZhikuiRen } 2926a3316fc6SZhikuiRen } 2927a3316fc6SZhikuiRen 2928d4342a92STim Lee // Get Severity template from message registry 2929d4342a92STim Lee std::string severity; 2930d4342a92STim Lee if (message != nullptr) 2931d4342a92STim Lee { 2932d4342a92STim Lee severity = message->severity; 2933d4342a92STim Lee } 2934d4342a92STim Lee 2935a3316fc6SZhikuiRen // add to AsyncResp 2936a3316fc6SZhikuiRen logEntryArray.push_back({}); 2937a3316fc6SZhikuiRen nlohmann::json& bmcLogEntry = logEntryArray.back(); 29380ef217f4SGeorge Liu bmcLogEntry = {{"@odata.type", "#LogEntry.v1_8_0.LogEntry"}, 2939a3316fc6SZhikuiRen {"@odata.id", "/redfish/v1/Systems/system/LogServices/" 2940a3316fc6SZhikuiRen "PostCodes/Entries/" + 2941a3316fc6SZhikuiRen postcodeEntryID}, 2942a3316fc6SZhikuiRen {"Name", "POST Code Log Entry"}, 2943a3316fc6SZhikuiRen {"Id", postcodeEntryID}, 2944a3316fc6SZhikuiRen {"Message", std::move(msg)}, 29454a0bf539SManojkiran Eda {"MessageId", "OpenBMC.0.2.BIOSPOSTCode"}, 2946a3316fc6SZhikuiRen {"MessageArgs", std::move(messageArgs)}, 2947a3316fc6SZhikuiRen {"EntryType", "Event"}, 2948a3316fc6SZhikuiRen {"Severity", std::move(severity)}, 29499c620e21SAsmitha Karunanithi {"Created", entryTimeStr}}; 29500ef217f4SGeorge Liu 29510ef217f4SGeorge Liu if (std::get<std::vector<uint8_t>>(code.second).size()) 29520ef217f4SGeorge Liu { 29530ef217f4SGeorge Liu bmcLogEntry["AdditionalDataURI"] = 29540ef217f4SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 29550ef217f4SGeorge Liu postcodeEntryID + "/attachment"; 29560ef217f4SGeorge Liu } 2957a3316fc6SZhikuiRen } 2958a3316fc6SZhikuiRen } 2959a3316fc6SZhikuiRen 29608d1b46d7Szhanghch05 static void getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 2961a3316fc6SZhikuiRen const uint16_t bootIndex, 2962a3316fc6SZhikuiRen const uint64_t codeIndex) 2963a3316fc6SZhikuiRen { 2964a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 29656c9a279eSManojkiran Eda [aResp, bootIndex, 29666c9a279eSManojkiran Eda codeIndex](const boost::system::error_code ec, 29676c9a279eSManojkiran Eda const boost::container::flat_map< 29686c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 29696c9a279eSManojkiran Eda postcode) { 2970a3316fc6SZhikuiRen if (ec) 2971a3316fc6SZhikuiRen { 2972a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 2973a3316fc6SZhikuiRen messages::internalError(aResp->res); 2974a3316fc6SZhikuiRen return; 2975a3316fc6SZhikuiRen } 2976a3316fc6SZhikuiRen 2977a3316fc6SZhikuiRen // skip the empty postcode boots 2978a3316fc6SZhikuiRen if (postcode.empty()) 2979a3316fc6SZhikuiRen { 2980a3316fc6SZhikuiRen return; 2981a3316fc6SZhikuiRen } 2982a3316fc6SZhikuiRen 2983a3316fc6SZhikuiRen fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex); 2984a3316fc6SZhikuiRen 2985a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = 2986a3316fc6SZhikuiRen aResp->res.jsonValue["Members"].size(); 2987a3316fc6SZhikuiRen }, 298815124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 298915124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 2990a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 2991a3316fc6SZhikuiRen bootIndex); 2992a3316fc6SZhikuiRen } 2993a3316fc6SZhikuiRen 29948d1b46d7Szhanghch05 static void getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 2995a3316fc6SZhikuiRen const uint16_t bootIndex, 2996a3316fc6SZhikuiRen const uint16_t bootCount, 2997a3316fc6SZhikuiRen const uint64_t entryCount, const uint64_t skip, 2998a3316fc6SZhikuiRen const uint64_t top) 2999a3316fc6SZhikuiRen { 3000a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3001a3316fc6SZhikuiRen [aResp, bootIndex, bootCount, entryCount, skip, 3002a3316fc6SZhikuiRen top](const boost::system::error_code ec, 30036c9a279eSManojkiran Eda const boost::container::flat_map< 30046c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 30056c9a279eSManojkiran Eda postcode) { 3006a3316fc6SZhikuiRen if (ec) 3007a3316fc6SZhikuiRen { 3008a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3009a3316fc6SZhikuiRen messages::internalError(aResp->res); 3010a3316fc6SZhikuiRen return; 3011a3316fc6SZhikuiRen } 3012a3316fc6SZhikuiRen 3013a3316fc6SZhikuiRen uint64_t endCount = entryCount; 3014a3316fc6SZhikuiRen if (!postcode.empty()) 3015a3316fc6SZhikuiRen { 3016a3316fc6SZhikuiRen endCount = entryCount + postcode.size(); 3017a3316fc6SZhikuiRen 3018a3316fc6SZhikuiRen if ((skip < endCount) && ((top + skip) > entryCount)) 3019a3316fc6SZhikuiRen { 3020a3316fc6SZhikuiRen uint64_t thisBootSkip = 3021a3316fc6SZhikuiRen std::max(skip, entryCount) - entryCount; 3022a3316fc6SZhikuiRen uint64_t thisBootTop = 3023a3316fc6SZhikuiRen std::min(top + skip, endCount) - entryCount; 3024a3316fc6SZhikuiRen 3025a3316fc6SZhikuiRen fillPostCodeEntry(aResp, postcode, bootIndex, 0, 3026a3316fc6SZhikuiRen thisBootSkip, thisBootTop); 3027a3316fc6SZhikuiRen } 3028a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = endCount; 3029a3316fc6SZhikuiRen } 3030a3316fc6SZhikuiRen 3031a3316fc6SZhikuiRen // continue to previous bootIndex 3032a3316fc6SZhikuiRen if (bootIndex < bootCount) 3033a3316fc6SZhikuiRen { 3034a3316fc6SZhikuiRen getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1), 3035a3316fc6SZhikuiRen bootCount, endCount, skip, top); 3036a3316fc6SZhikuiRen } 3037a3316fc6SZhikuiRen else 3038a3316fc6SZhikuiRen { 3039a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.nextLink"] = 3040a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/" 3041a3316fc6SZhikuiRen "Entries?$skip=" + 3042a3316fc6SZhikuiRen std::to_string(skip + top); 3043a3316fc6SZhikuiRen } 3044a3316fc6SZhikuiRen }, 304515124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 304615124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3047a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3048a3316fc6SZhikuiRen bootIndex); 3049a3316fc6SZhikuiRen } 3050a3316fc6SZhikuiRen 30518d1b46d7Szhanghch05 static void 30528d1b46d7Szhanghch05 getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3053a3316fc6SZhikuiRen const uint64_t skip, const uint64_t top) 3054a3316fc6SZhikuiRen { 3055a3316fc6SZhikuiRen uint64_t entryCount = 0; 3056a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3057a3316fc6SZhikuiRen [aResp, entryCount, skip, 3058a3316fc6SZhikuiRen top](const boost::system::error_code ec, 3059a3316fc6SZhikuiRen const std::variant<uint16_t>& bootCount) { 3060a3316fc6SZhikuiRen if (ec) 3061a3316fc6SZhikuiRen { 3062a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3063a3316fc6SZhikuiRen messages::internalError(aResp->res); 3064a3316fc6SZhikuiRen return; 3065a3316fc6SZhikuiRen } 3066a3316fc6SZhikuiRen auto pVal = std::get_if<uint16_t>(&bootCount); 3067a3316fc6SZhikuiRen if (pVal) 3068a3316fc6SZhikuiRen { 3069a3316fc6SZhikuiRen getPostCodeForBoot(aResp, 1, *pVal, entryCount, skip, top); 3070a3316fc6SZhikuiRen } 3071a3316fc6SZhikuiRen else 3072a3316fc6SZhikuiRen { 3073a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Post code boot index failed."; 3074a3316fc6SZhikuiRen } 3075a3316fc6SZhikuiRen }, 307615124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 307715124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3078a3316fc6SZhikuiRen "org.freedesktop.DBus.Properties", "Get", 3079a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount"); 3080a3316fc6SZhikuiRen } 3081a3316fc6SZhikuiRen 30827e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntryCollection(App& app) 3083a3316fc6SZhikuiRen { 30847e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 30857e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/") 3086432a890cSEd Tanous .privileges({{"Login"}}) 30877e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 30887e860f15SJohn Edward Broadbent [](const crow::Request& req, 30897e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 3090a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.type"] = 3091a3316fc6SZhikuiRen "#LogEntryCollection.LogEntryCollection"; 3092a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 3093a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3094a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3095a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3096a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3097a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3098a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 3099a3316fc6SZhikuiRen 3100a3316fc6SZhikuiRen uint64_t skip = 0; 3101a3316fc6SZhikuiRen uint64_t top = maxEntriesPerPage; // Show max entries by default 31028d1b46d7Szhanghch05 if (!getSkipParam(asyncResp, req, skip)) 3103a3316fc6SZhikuiRen { 3104a3316fc6SZhikuiRen return; 3105a3316fc6SZhikuiRen } 31068d1b46d7Szhanghch05 if (!getTopParam(asyncResp, req, top)) 3107a3316fc6SZhikuiRen { 3108a3316fc6SZhikuiRen return; 3109a3316fc6SZhikuiRen } 3110a3316fc6SZhikuiRen getCurrentBootNumber(asyncResp, skip, top); 31117e860f15SJohn Edward Broadbent }); 3112a3316fc6SZhikuiRen } 3113a3316fc6SZhikuiRen 31147e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntry(App& app) 3115a3316fc6SZhikuiRen { 31167e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 31177e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/") 3118432a890cSEd Tanous .privileges({{"Login"}}) 31197e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 31207e860f15SJohn Edward Broadbent [](const crow::Request&, 31217e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 31227e860f15SJohn Edward Broadbent const std::string& targetID) { 3123a3316fc6SZhikuiRen size_t bootPos = targetID.find('B'); 3124a3316fc6SZhikuiRen if (bootPos == std::string::npos) 3125a3316fc6SZhikuiRen { 3126a3316fc6SZhikuiRen // Requested ID was not found 3127a3316fc6SZhikuiRen messages::resourceMissingAtURI(asyncResp->res, targetID); 3128a3316fc6SZhikuiRen return; 3129a3316fc6SZhikuiRen } 3130a3316fc6SZhikuiRen std::string_view bootIndexStr(targetID); 3131a3316fc6SZhikuiRen bootIndexStr.remove_prefix(bootPos + 1); 3132a3316fc6SZhikuiRen uint16_t bootIndex = 0; 3133a3316fc6SZhikuiRen uint64_t codeIndex = 0; 3134a3316fc6SZhikuiRen size_t dashPos = bootIndexStr.find('-'); 3135a3316fc6SZhikuiRen 3136a3316fc6SZhikuiRen if (dashPos == std::string::npos) 3137a3316fc6SZhikuiRen { 3138a3316fc6SZhikuiRen return; 3139a3316fc6SZhikuiRen } 3140a3316fc6SZhikuiRen std::string_view codeIndexStr(bootIndexStr); 3141a3316fc6SZhikuiRen bootIndexStr.remove_suffix(dashPos); 3142a3316fc6SZhikuiRen codeIndexStr.remove_prefix(dashPos + 1); 3143a3316fc6SZhikuiRen 3144a3316fc6SZhikuiRen bootIndex = static_cast<uint16_t>( 314523a21a1cSEd Tanous strtoul(std::string(bootIndexStr).c_str(), nullptr, 0)); 31467e860f15SJohn Edward Broadbent codeIndex = 31477e860f15SJohn Edward Broadbent strtoul(std::string(codeIndexStr).c_str(), nullptr, 0); 3148a3316fc6SZhikuiRen if (bootIndex == 0 || codeIndex == 0) 3149a3316fc6SZhikuiRen { 3150a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string " 31517e860f15SJohn Edward Broadbent << targetID; 3152a3316fc6SZhikuiRen } 3153a3316fc6SZhikuiRen 31547e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["@odata.type"] = 31557e860f15SJohn Edward Broadbent "#LogEntry.v1_4_0.LogEntry"; 3156a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 3157a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/" 3158a3316fc6SZhikuiRen "Entries"; 3159a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3160a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3161a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3162a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3163a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 3164a3316fc6SZhikuiRen 3165a3316fc6SZhikuiRen getPostCodeForEntry(asyncResp, bootIndex, codeIndex); 31667e860f15SJohn Edward Broadbent }); 3167a3316fc6SZhikuiRen } 3168a3316fc6SZhikuiRen 31691da66f75SEd Tanous } // namespace redfish 3170