11da66f75SEd Tanous /* 21da66f75SEd Tanous // Copyright (c) 2018 Intel Corporation 31da66f75SEd Tanous // 41da66f75SEd Tanous // Licensed under the Apache License, Version 2.0 (the "License"); 51da66f75SEd Tanous // you may not use this file except in compliance with the License. 61da66f75SEd Tanous // You may obtain a copy of the License at 71da66f75SEd Tanous // 81da66f75SEd Tanous // http://www.apache.org/licenses/LICENSE-2.0 91da66f75SEd Tanous // 101da66f75SEd Tanous // Unless required by applicable law or agreed to in writing, software 111da66f75SEd Tanous // distributed under the License is distributed on an "AS IS" BASIS, 121da66f75SEd Tanous // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 131da66f75SEd Tanous // See the License for the specific language governing permissions and 141da66f75SEd Tanous // limitations under the License. 151da66f75SEd Tanous */ 161da66f75SEd Tanous #pragma once 171da66f75SEd Tanous 18b7028ebfSSpencer Ku #include "gzfile.hpp" 19647b3cdcSGeorge Liu #include "http_utility.hpp" 20b7028ebfSSpencer Ku #include "human_sort.hpp" 214851d45dSJason M. Bills #include "registries.hpp" 224851d45dSJason M. Bills #include "registries/base_message_registry.hpp" 234851d45dSJason M. Bills #include "registries/openbmc_message_registry.hpp" 2446229577SJames Feist #include "task.hpp" 251da66f75SEd Tanous 26e1f26343SJason M. Bills #include <systemd/sd-journal.h> 27400fd1fbSAdriana Kobylak #include <unistd.h> 28e1f26343SJason M. Bills 297e860f15SJohn Edward Broadbent #include <app.hpp> 30400fd1fbSAdriana Kobylak #include <boost/algorithm/string/replace.hpp> 314851d45dSJason M. Bills #include <boost/algorithm/string/split.hpp> 324851d45dSJason M. Bills #include <boost/beast/core/span.hpp> 33400fd1fbSAdriana Kobylak #include <boost/beast/http.hpp> 341da66f75SEd Tanous #include <boost/container/flat_map.hpp> 351ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp> 36cb92c03bSAndrew Geissler #include <error_messages.hpp> 37ed398213SEd Tanous #include <registries/privilege_registry.hpp> 381214b7e7SGunnar Mills 39647b3cdcSGeorge Liu #include <charconv> 404418c7f0SJames Feist #include <filesystem> 4175710de2SXiaochao Ma #include <optional> 4226702d01SEd Tanous #include <span> 43cd225da8SJason M. Bills #include <string_view> 44abf2add6SEd Tanous #include <variant> 451da66f75SEd Tanous 461da66f75SEd Tanous namespace redfish 471da66f75SEd Tanous { 481da66f75SEd Tanous 495b61b5e8SJason M. Bills constexpr char const* crashdumpObject = "com.intel.crashdump"; 505b61b5e8SJason M. Bills constexpr char const* crashdumpPath = "/com/intel/crashdump"; 515b61b5e8SJason M. Bills constexpr char const* crashdumpInterface = "com.intel.crashdump"; 525b61b5e8SJason M. Bills constexpr char const* deleteAllInterface = 535b61b5e8SJason M. Bills "xyz.openbmc_project.Collection.DeleteAll"; 545b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandInterface = 55424c4176SJason M. Bills "com.intel.crashdump.OnDemand"; 566eda7685SKenny L. Ku constexpr char const* crashdumpTelemetryInterface = 576eda7685SKenny L. Ku "com.intel.crashdump.Telemetry"; 581da66f75SEd Tanous 594851d45dSJason M. Bills namespace message_registries 604851d45dSJason M. Bills { 6126702d01SEd Tanous static const Message* 6226702d01SEd Tanous getMessageFromRegistry(const std::string& messageKey, 6326702d01SEd Tanous const std::span<const MessageEntry> registry) 644851d45dSJason M. Bills { 6526702d01SEd Tanous std::span<const MessageEntry>::iterator messageIt = std::find_if( 6626702d01SEd Tanous registry.begin(), registry.end(), 674851d45dSJason M. Bills [&messageKey](const MessageEntry& messageEntry) { 6826702d01SEd Tanous return !std::strcmp(messageEntry.first, messageKey.c_str()); 694851d45dSJason M. Bills }); 7026702d01SEd Tanous if (messageIt != registry.end()) 714851d45dSJason M. Bills { 724851d45dSJason M. Bills return &messageIt->second; 734851d45dSJason M. Bills } 744851d45dSJason M. Bills 754851d45dSJason M. Bills return nullptr; 764851d45dSJason M. Bills } 774851d45dSJason M. Bills 784851d45dSJason M. Bills static const Message* getMessage(const std::string_view& messageID) 794851d45dSJason M. Bills { 804851d45dSJason M. Bills // Redfish MessageIds are in the form 814851d45dSJason M. Bills // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 824851d45dSJason M. Bills // the right Message 834851d45dSJason M. Bills std::vector<std::string> fields; 844851d45dSJason M. Bills fields.reserve(4); 854851d45dSJason M. Bills boost::split(fields, messageID, boost::is_any_of(".")); 864851d45dSJason M. Bills std::string& registryName = fields[0]; 874851d45dSJason M. Bills std::string& messageKey = fields[3]; 884851d45dSJason M. Bills 894851d45dSJason M. Bills // Find the right registry and check it for the MessageKey 904851d45dSJason M. Bills if (std::string(base::header.registryPrefix) == registryName) 914851d45dSJason M. Bills { 924851d45dSJason M. Bills return getMessageFromRegistry( 9326702d01SEd Tanous messageKey, std::span<const MessageEntry>(base::registry)); 944851d45dSJason M. Bills } 954851d45dSJason M. Bills if (std::string(openbmc::header.registryPrefix) == registryName) 964851d45dSJason M. Bills { 974851d45dSJason M. Bills return getMessageFromRegistry( 9826702d01SEd Tanous messageKey, std::span<const MessageEntry>(openbmc::registry)); 994851d45dSJason M. Bills } 1004851d45dSJason M. Bills return nullptr; 1014851d45dSJason M. Bills } 1024851d45dSJason M. Bills } // namespace message_registries 1034851d45dSJason M. Bills 104f6150403SJames Feist namespace fs = std::filesystem; 1051da66f75SEd Tanous 106cb92c03bSAndrew Geissler using GetManagedPropertyType = boost::container::flat_map< 10719bd78d9SPatrick Williams std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t, 108cb92c03bSAndrew Geissler int32_t, uint32_t, int64_t, uint64_t, double>>; 109cb92c03bSAndrew Geissler 110cb92c03bSAndrew Geissler using GetManagedObjectsType = boost::container::flat_map< 111cb92c03bSAndrew Geissler sdbusplus::message::object_path, 112cb92c03bSAndrew Geissler boost::container::flat_map<std::string, GetManagedPropertyType>>; 113cb92c03bSAndrew Geissler 114cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s) 115cb92c03bSAndrew Geissler { 116d4d25793SEd Tanous if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") || 117d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") || 118d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") || 119d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Error")) 120cb92c03bSAndrew Geissler { 121cb92c03bSAndrew Geissler return "Critical"; 122cb92c03bSAndrew Geissler } 1233174e4dfSEd Tanous if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") || 124d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") || 125d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Notice")) 126cb92c03bSAndrew Geissler { 127cb92c03bSAndrew Geissler return "OK"; 128cb92c03bSAndrew Geissler } 1293174e4dfSEd Tanous if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning") 130cb92c03bSAndrew Geissler { 131cb92c03bSAndrew Geissler return "Warning"; 132cb92c03bSAndrew Geissler } 133cb92c03bSAndrew Geissler return ""; 134cb92c03bSAndrew Geissler } 135cb92c03bSAndrew Geissler 1367e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal, 13739e77504SEd Tanous const std::string_view& field, 13839e77504SEd Tanous std::string_view& contents) 13916428a1aSJason M. Bills { 14016428a1aSJason M. Bills const char* data = nullptr; 14116428a1aSJason M. Bills size_t length = 0; 14216428a1aSJason M. Bills int ret = 0; 14316428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 144271584abSEd Tanous ret = sd_journal_get_data(journal, field.data(), 145271584abSEd Tanous reinterpret_cast<const void**>(&data), &length); 14616428a1aSJason M. Bills if (ret < 0) 14716428a1aSJason M. Bills { 14816428a1aSJason M. Bills return ret; 14916428a1aSJason M. Bills } 15039e77504SEd Tanous contents = std::string_view(data, length); 15116428a1aSJason M. Bills // Only use the content after the "=" character. 15281ce609eSEd Tanous contents.remove_prefix(std::min(contents.find('=') + 1, contents.size())); 15316428a1aSJason M. Bills return ret; 15416428a1aSJason M. Bills } 15516428a1aSJason M. Bills 1567e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal, 1577e860f15SJohn Edward Broadbent const std::string_view& field, 1587e860f15SJohn Edward Broadbent const int& base, long int& contents) 15916428a1aSJason M. Bills { 16016428a1aSJason M. Bills int ret = 0; 16139e77504SEd Tanous std::string_view metadata; 16216428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 16316428a1aSJason M. Bills ret = getJournalMetadata(journal, field, metadata); 16416428a1aSJason M. Bills if (ret < 0) 16516428a1aSJason M. Bills { 16616428a1aSJason M. Bills return ret; 16716428a1aSJason M. Bills } 168b01bf299SEd Tanous contents = strtol(metadata.data(), nullptr, base); 16916428a1aSJason M. Bills return ret; 17016428a1aSJason M. Bills } 17116428a1aSJason M. Bills 1727e860f15SJohn Edward Broadbent inline static bool getEntryTimestamp(sd_journal* journal, 1737e860f15SJohn Edward Broadbent std::string& entryTimestamp) 174a3316fc6SZhikuiRen { 175a3316fc6SZhikuiRen int ret = 0; 176a3316fc6SZhikuiRen uint64_t timestamp = 0; 177a3316fc6SZhikuiRen ret = sd_journal_get_realtime_usec(journal, ×tamp); 178a3316fc6SZhikuiRen if (ret < 0) 179a3316fc6SZhikuiRen { 180a3316fc6SZhikuiRen BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 181a3316fc6SZhikuiRen << strerror(-ret); 182a3316fc6SZhikuiRen return false; 183a3316fc6SZhikuiRen } 1849c620e21SAsmitha Karunanithi entryTimestamp = crow::utility::getDateTime( 1859c620e21SAsmitha Karunanithi static_cast<std::time_t>(timestamp / 1000 / 1000)); 1869c620e21SAsmitha Karunanithi return true; 187a3316fc6SZhikuiRen } 188a3316fc6SZhikuiRen 1898d1b46d7Szhanghch05 static bool getSkipParam(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1908d1b46d7Szhanghch05 const crow::Request& req, uint64_t& skip) 19116428a1aSJason M. Bills { 192d32c4fa9SEd Tanous boost::urls::query_params_view::iterator it = req.urlParams.find("$skip"); 1935a7e877eSJames Feist if (it != req.urlParams.end()) 19416428a1aSJason M. Bills { 1955a7e877eSJames Feist std::string skipParam = it->value(); 19616428a1aSJason M. Bills char* ptr = nullptr; 1975a7e877eSJames Feist skip = std::strtoul(skipParam.c_str(), &ptr, 10); 1985a7e877eSJames Feist if (skipParam.empty() || *ptr != '\0') 19916428a1aSJason M. Bills { 20016428a1aSJason M. Bills 2018d1b46d7Szhanghch05 messages::queryParameterValueTypeError( 2028d1b46d7Szhanghch05 asyncResp->res, std::string(skipParam), "$skip"); 20316428a1aSJason M. Bills return false; 20416428a1aSJason M. Bills } 20516428a1aSJason M. Bills } 20616428a1aSJason M. Bills return true; 20716428a1aSJason M. Bills } 20816428a1aSJason M. Bills 209271584abSEd Tanous static constexpr const uint64_t maxEntriesPerPage = 1000; 2108d1b46d7Szhanghch05 static bool getTopParam(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2118d1b46d7Szhanghch05 const crow::Request& req, uint64_t& top) 21216428a1aSJason M. Bills { 213d32c4fa9SEd Tanous boost::urls::query_params_view::iterator it = req.urlParams.find("$top"); 2145a7e877eSJames Feist if (it != req.urlParams.end()) 21516428a1aSJason M. Bills { 2165a7e877eSJames Feist std::string topParam = it->value(); 21716428a1aSJason M. Bills char* ptr = nullptr; 2185a7e877eSJames Feist top = std::strtoul(topParam.c_str(), &ptr, 10); 2195a7e877eSJames Feist if (topParam.empty() || *ptr != '\0') 22016428a1aSJason M. Bills { 2218d1b46d7Szhanghch05 messages::queryParameterValueTypeError( 2228d1b46d7Szhanghch05 asyncResp->res, std::string(topParam), "$top"); 22316428a1aSJason M. Bills return false; 22416428a1aSJason M. Bills } 225271584abSEd Tanous if (top < 1U || top > maxEntriesPerPage) 22616428a1aSJason M. Bills { 22716428a1aSJason M. Bills 22816428a1aSJason M. Bills messages::queryParameterOutOfRange( 2298d1b46d7Szhanghch05 asyncResp->res, std::to_string(top), "$top", 23016428a1aSJason M. Bills "1-" + std::to_string(maxEntriesPerPage)); 23116428a1aSJason M. Bills return false; 23216428a1aSJason M. Bills } 23316428a1aSJason M. Bills } 23416428a1aSJason M. Bills return true; 23516428a1aSJason M. Bills } 23616428a1aSJason M. Bills 2377e860f15SJohn Edward Broadbent inline static bool getUniqueEntryID(sd_journal* journal, std::string& entryID, 238e85d6b16SJason M. Bills const bool firstEntry = true) 23916428a1aSJason M. Bills { 24016428a1aSJason M. Bills int ret = 0; 24116428a1aSJason M. Bills static uint64_t prevTs = 0; 24216428a1aSJason M. Bills static int index = 0; 243e85d6b16SJason M. Bills if (firstEntry) 244e85d6b16SJason M. Bills { 245e85d6b16SJason M. Bills prevTs = 0; 246e85d6b16SJason M. Bills } 247e85d6b16SJason M. Bills 24816428a1aSJason M. Bills // Get the entry timestamp 24916428a1aSJason M. Bills uint64_t curTs = 0; 25016428a1aSJason M. Bills ret = sd_journal_get_realtime_usec(journal, &curTs); 25116428a1aSJason M. Bills if (ret < 0) 25216428a1aSJason M. Bills { 25316428a1aSJason M. Bills BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 25416428a1aSJason M. Bills << strerror(-ret); 25516428a1aSJason M. Bills return false; 25616428a1aSJason M. Bills } 25716428a1aSJason M. Bills // If the timestamp isn't unique, increment the index 25816428a1aSJason M. Bills if (curTs == prevTs) 25916428a1aSJason M. Bills { 26016428a1aSJason M. Bills index++; 26116428a1aSJason M. Bills } 26216428a1aSJason M. Bills else 26316428a1aSJason M. Bills { 26416428a1aSJason M. Bills // Otherwise, reset it 26516428a1aSJason M. Bills index = 0; 26616428a1aSJason M. Bills } 26716428a1aSJason M. Bills // Save the timestamp 26816428a1aSJason M. Bills prevTs = curTs; 26916428a1aSJason M. Bills 27016428a1aSJason M. Bills entryID = std::to_string(curTs); 27116428a1aSJason M. Bills if (index > 0) 27216428a1aSJason M. Bills { 27316428a1aSJason M. Bills entryID += "_" + std::to_string(index); 27416428a1aSJason M. Bills } 27516428a1aSJason M. Bills return true; 27616428a1aSJason M. Bills } 27716428a1aSJason M. Bills 278e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID, 279e85d6b16SJason M. Bills const bool firstEntry = true) 28095820184SJason M. Bills { 281271584abSEd Tanous static time_t prevTs = 0; 28295820184SJason M. Bills static int index = 0; 283e85d6b16SJason M. Bills if (firstEntry) 284e85d6b16SJason M. Bills { 285e85d6b16SJason M. Bills prevTs = 0; 286e85d6b16SJason M. Bills } 287e85d6b16SJason M. Bills 28895820184SJason M. Bills // Get the entry timestamp 289271584abSEd Tanous std::time_t curTs = 0; 29095820184SJason M. Bills std::tm timeStruct = {}; 29195820184SJason M. Bills std::istringstream entryStream(logEntry); 29295820184SJason M. Bills if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 29395820184SJason M. Bills { 29495820184SJason M. Bills curTs = std::mktime(&timeStruct); 29595820184SJason M. Bills } 29695820184SJason M. Bills // If the timestamp isn't unique, increment the index 29795820184SJason M. Bills if (curTs == prevTs) 29895820184SJason M. Bills { 29995820184SJason M. Bills index++; 30095820184SJason M. Bills } 30195820184SJason M. Bills else 30295820184SJason M. Bills { 30395820184SJason M. Bills // Otherwise, reset it 30495820184SJason M. Bills index = 0; 30595820184SJason M. Bills } 30695820184SJason M. Bills // Save the timestamp 30795820184SJason M. Bills prevTs = curTs; 30895820184SJason M. Bills 30995820184SJason M. Bills entryID = std::to_string(curTs); 31095820184SJason M. Bills if (index > 0) 31195820184SJason M. Bills { 31295820184SJason M. Bills entryID += "_" + std::to_string(index); 31395820184SJason M. Bills } 31495820184SJason M. Bills return true; 31595820184SJason M. Bills } 31695820184SJason M. Bills 3177e860f15SJohn Edward Broadbent inline static bool 3188d1b46d7Szhanghch05 getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3198d1b46d7Szhanghch05 const std::string& entryID, uint64_t& timestamp, 3208d1b46d7Szhanghch05 uint64_t& index) 32116428a1aSJason M. Bills { 32216428a1aSJason M. Bills if (entryID.empty()) 32316428a1aSJason M. Bills { 32416428a1aSJason M. Bills return false; 32516428a1aSJason M. Bills } 32616428a1aSJason M. Bills // Convert the unique ID back to a timestamp to find the entry 32739e77504SEd Tanous std::string_view tsStr(entryID); 32816428a1aSJason M. Bills 32981ce609eSEd Tanous auto underscorePos = tsStr.find('_'); 33016428a1aSJason M. Bills if (underscorePos != tsStr.npos) 33116428a1aSJason M. Bills { 33216428a1aSJason M. Bills // Timestamp has an index 33316428a1aSJason M. Bills tsStr.remove_suffix(tsStr.size() - underscorePos); 33439e77504SEd Tanous std::string_view indexStr(entryID); 33516428a1aSJason M. Bills indexStr.remove_prefix(underscorePos + 1); 336c0bd5e4bSEd Tanous auto [ptr, ec] = std::from_chars( 337c0bd5e4bSEd Tanous indexStr.data(), indexStr.data() + indexStr.size(), index); 338c0bd5e4bSEd Tanous if (ec != std::errc()) 33916428a1aSJason M. Bills { 3408d1b46d7Szhanghch05 messages::resourceMissingAtURI(asyncResp->res, entryID); 34116428a1aSJason M. Bills return false; 34216428a1aSJason M. Bills } 34316428a1aSJason M. Bills } 34416428a1aSJason M. Bills // Timestamp has no index 345c0bd5e4bSEd Tanous auto [ptr, ec] = 346c0bd5e4bSEd Tanous std::from_chars(tsStr.data(), tsStr.data() + tsStr.size(), timestamp); 347c0bd5e4bSEd Tanous if (ec != std::errc()) 34816428a1aSJason M. Bills { 3498d1b46d7Szhanghch05 messages::resourceMissingAtURI(asyncResp->res, entryID); 35016428a1aSJason M. Bills return false; 35116428a1aSJason M. Bills } 35216428a1aSJason M. Bills return true; 35316428a1aSJason M. Bills } 35416428a1aSJason M. Bills 35595820184SJason M. Bills static bool 35695820184SJason M. Bills getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles) 35795820184SJason M. Bills { 35895820184SJason M. Bills static const std::filesystem::path redfishLogDir = "/var/log"; 35995820184SJason M. Bills static const std::string redfishLogFilename = "redfish"; 36095820184SJason M. Bills 36195820184SJason M. Bills // Loop through the directory looking for redfish log files 36295820184SJason M. Bills for (const std::filesystem::directory_entry& dirEnt : 36395820184SJason M. Bills std::filesystem::directory_iterator(redfishLogDir)) 36495820184SJason M. Bills { 36595820184SJason M. Bills // If we find a redfish log file, save the path 36695820184SJason M. Bills std::string filename = dirEnt.path().filename(); 36795820184SJason M. Bills if (boost::starts_with(filename, redfishLogFilename)) 36895820184SJason M. Bills { 36995820184SJason M. Bills redfishLogFiles.emplace_back(redfishLogDir / filename); 37095820184SJason M. Bills } 37195820184SJason M. Bills } 37295820184SJason M. Bills // As the log files rotate, they are appended with a ".#" that is higher for 37395820184SJason M. Bills // the older logs. Since we don't expect more than 10 log files, we 37495820184SJason M. Bills // can just sort the list to get them in order from newest to oldest 37595820184SJason M. Bills std::sort(redfishLogFiles.begin(), redfishLogFiles.end()); 37695820184SJason M. Bills 37795820184SJason M. Bills return !redfishLogFiles.empty(); 37895820184SJason M. Bills } 37995820184SJason M. Bills 3808d1b46d7Szhanghch05 inline void 3818d1b46d7Szhanghch05 getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3825cb1dd27SAsmitha Karunanithi const std::string& dumpType) 3835cb1dd27SAsmitha Karunanithi { 3845cb1dd27SAsmitha Karunanithi std::string dumpPath; 3855cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 3865cb1dd27SAsmitha Karunanithi { 3875cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 3885cb1dd27SAsmitha Karunanithi } 3895cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 3905cb1dd27SAsmitha Karunanithi { 3915cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 3925cb1dd27SAsmitha Karunanithi } 3935cb1dd27SAsmitha Karunanithi else 3945cb1dd27SAsmitha Karunanithi { 3955cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType; 3965cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 3975cb1dd27SAsmitha Karunanithi return; 3985cb1dd27SAsmitha Karunanithi } 3995cb1dd27SAsmitha Karunanithi 4005cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 4015cb1dd27SAsmitha Karunanithi [asyncResp, dumpPath, dumpType](const boost::system::error_code ec, 4025cb1dd27SAsmitha Karunanithi GetManagedObjectsType& resp) { 4035cb1dd27SAsmitha Karunanithi if (ec) 4045cb1dd27SAsmitha Karunanithi { 4055cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 4065cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4075cb1dd27SAsmitha Karunanithi return; 4085cb1dd27SAsmitha Karunanithi } 4095cb1dd27SAsmitha Karunanithi 4105cb1dd27SAsmitha Karunanithi nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"]; 4115cb1dd27SAsmitha Karunanithi entriesArray = nlohmann::json::array(); 412b47452b2SAsmitha Karunanithi std::string dumpEntryPath = 413b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 414b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)) + 415b47452b2SAsmitha Karunanithi "/entry/"; 4165cb1dd27SAsmitha Karunanithi 4175cb1dd27SAsmitha Karunanithi for (auto& object : resp) 4185cb1dd27SAsmitha Karunanithi { 419b47452b2SAsmitha Karunanithi if (object.first.str.find(dumpEntryPath) == std::string::npos) 4205cb1dd27SAsmitha Karunanithi { 4215cb1dd27SAsmitha Karunanithi continue; 4225cb1dd27SAsmitha Karunanithi } 4235cb1dd27SAsmitha Karunanithi std::time_t timestamp; 4245cb1dd27SAsmitha Karunanithi uint64_t size = 0; 42535440d18SAsmitha Karunanithi std::string dumpStatus; 42635440d18SAsmitha Karunanithi nlohmann::json thisEntry; 4272dfd18efSEd Tanous 4282dfd18efSEd Tanous std::string entryID = object.first.filename(); 4292dfd18efSEd Tanous if (entryID.empty()) 4305cb1dd27SAsmitha Karunanithi { 4315cb1dd27SAsmitha Karunanithi continue; 4325cb1dd27SAsmitha Karunanithi } 4335cb1dd27SAsmitha Karunanithi 4345cb1dd27SAsmitha Karunanithi for (auto& interfaceMap : object.second) 4355cb1dd27SAsmitha Karunanithi { 43635440d18SAsmitha Karunanithi if (interfaceMap.first == 43735440d18SAsmitha Karunanithi "xyz.openbmc_project.Common.Progress") 43835440d18SAsmitha Karunanithi { 43935440d18SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 44035440d18SAsmitha Karunanithi { 44135440d18SAsmitha Karunanithi if (propertyMap.first == "Status") 44235440d18SAsmitha Karunanithi { 44335440d18SAsmitha Karunanithi auto status = std::get_if<std::string>( 44435440d18SAsmitha Karunanithi &propertyMap.second); 44535440d18SAsmitha Karunanithi if (status == nullptr) 44635440d18SAsmitha Karunanithi { 44735440d18SAsmitha Karunanithi messages::internalError(asyncResp->res); 44835440d18SAsmitha Karunanithi break; 44935440d18SAsmitha Karunanithi } 45035440d18SAsmitha Karunanithi dumpStatus = *status; 45135440d18SAsmitha Karunanithi } 45235440d18SAsmitha Karunanithi } 45335440d18SAsmitha Karunanithi } 45435440d18SAsmitha Karunanithi else if (interfaceMap.first == 45535440d18SAsmitha Karunanithi "xyz.openbmc_project.Dump.Entry") 4565cb1dd27SAsmitha Karunanithi { 4575cb1dd27SAsmitha Karunanithi 4585cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 4595cb1dd27SAsmitha Karunanithi { 4605cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Size") 4615cb1dd27SAsmitha Karunanithi { 4625cb1dd27SAsmitha Karunanithi auto sizePtr = 4635cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 4645cb1dd27SAsmitha Karunanithi if (sizePtr == nullptr) 4655cb1dd27SAsmitha Karunanithi { 4665cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4675cb1dd27SAsmitha Karunanithi break; 4685cb1dd27SAsmitha Karunanithi } 4695cb1dd27SAsmitha Karunanithi size = *sizePtr; 4705cb1dd27SAsmitha Karunanithi break; 4715cb1dd27SAsmitha Karunanithi } 4725cb1dd27SAsmitha Karunanithi } 4735cb1dd27SAsmitha Karunanithi } 4745cb1dd27SAsmitha Karunanithi else if (interfaceMap.first == 4755cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Time.EpochTime") 4765cb1dd27SAsmitha Karunanithi { 4775cb1dd27SAsmitha Karunanithi 4785cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 4795cb1dd27SAsmitha Karunanithi { 4805cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Elapsed") 4815cb1dd27SAsmitha Karunanithi { 4825cb1dd27SAsmitha Karunanithi const uint64_t* usecsTimeStamp = 4835cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 4845cb1dd27SAsmitha Karunanithi if (usecsTimeStamp == nullptr) 4855cb1dd27SAsmitha Karunanithi { 4865cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4875cb1dd27SAsmitha Karunanithi break; 4885cb1dd27SAsmitha Karunanithi } 4895cb1dd27SAsmitha Karunanithi timestamp = 4905cb1dd27SAsmitha Karunanithi static_cast<std::time_t>(*usecsTimeStamp); 4915cb1dd27SAsmitha Karunanithi break; 4925cb1dd27SAsmitha Karunanithi } 4935cb1dd27SAsmitha Karunanithi } 4945cb1dd27SAsmitha Karunanithi } 4955cb1dd27SAsmitha Karunanithi } 4965cb1dd27SAsmitha Karunanithi 4970fda0f12SGeorge Liu if (dumpStatus != 4980fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 49935440d18SAsmitha Karunanithi !dumpStatus.empty()) 50035440d18SAsmitha Karunanithi { 50135440d18SAsmitha Karunanithi // Dump status is not Complete, no need to enumerate 50235440d18SAsmitha Karunanithi continue; 50335440d18SAsmitha Karunanithi } 50435440d18SAsmitha Karunanithi 505647b3cdcSGeorge Liu thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 5065cb1dd27SAsmitha Karunanithi thisEntry["@odata.id"] = dumpPath + entryID; 5075cb1dd27SAsmitha Karunanithi thisEntry["Id"] = entryID; 5085cb1dd27SAsmitha Karunanithi thisEntry["EntryType"] = "Event"; 5095cb1dd27SAsmitha Karunanithi thisEntry["Created"] = crow::utility::getDateTime(timestamp); 5105cb1dd27SAsmitha Karunanithi thisEntry["Name"] = dumpType + " Dump Entry"; 5115cb1dd27SAsmitha Karunanithi 512d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataSizeBytes"] = size; 5135cb1dd27SAsmitha Karunanithi 5145cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 5155cb1dd27SAsmitha Karunanithi { 516d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "Manager"; 517d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataURI"] = 518de8d94a3SAbhishek Patel "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/" + 519de8d94a3SAbhishek Patel entryID + "/attachment"; 5205cb1dd27SAsmitha Karunanithi } 5215cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 5225cb1dd27SAsmitha Karunanithi { 523d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "OEM"; 524d337bb72SAsmitha Karunanithi thisEntry["OEMDiagnosticDataType"] = "System"; 525d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataURI"] = 526de8d94a3SAbhishek Patel "/redfish/v1/Systems/system/LogServices/Dump/Entries/" + 527de8d94a3SAbhishek Patel entryID + "/attachment"; 5285cb1dd27SAsmitha Karunanithi } 52935440d18SAsmitha Karunanithi entriesArray.push_back(std::move(thisEntry)); 5305cb1dd27SAsmitha Karunanithi } 5315cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Members@odata.count"] = 5325cb1dd27SAsmitha Karunanithi entriesArray.size(); 5335cb1dd27SAsmitha Karunanithi }, 5345cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 5355cb1dd27SAsmitha Karunanithi "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 5365cb1dd27SAsmitha Karunanithi } 5375cb1dd27SAsmitha Karunanithi 5388d1b46d7Szhanghch05 inline void 5398d1b46d7Szhanghch05 getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 5408d1b46d7Szhanghch05 const std::string& entryID, const std::string& dumpType) 5415cb1dd27SAsmitha Karunanithi { 5425cb1dd27SAsmitha Karunanithi std::string dumpPath; 5435cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 5445cb1dd27SAsmitha Karunanithi { 5455cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 5465cb1dd27SAsmitha Karunanithi } 5475cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 5485cb1dd27SAsmitha Karunanithi { 5495cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 5505cb1dd27SAsmitha Karunanithi } 5515cb1dd27SAsmitha Karunanithi else 5525cb1dd27SAsmitha Karunanithi { 5535cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType; 5545cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5555cb1dd27SAsmitha Karunanithi return; 5565cb1dd27SAsmitha Karunanithi } 5575cb1dd27SAsmitha Karunanithi 5585cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 5595cb1dd27SAsmitha Karunanithi [asyncResp, entryID, dumpPath, dumpType]( 5605cb1dd27SAsmitha Karunanithi const boost::system::error_code ec, GetManagedObjectsType& resp) { 5615cb1dd27SAsmitha Karunanithi if (ec) 5625cb1dd27SAsmitha Karunanithi { 5635cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 5645cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5655cb1dd27SAsmitha Karunanithi return; 5665cb1dd27SAsmitha Karunanithi } 5675cb1dd27SAsmitha Karunanithi 568b47452b2SAsmitha Karunanithi bool foundDumpEntry = false; 569b47452b2SAsmitha Karunanithi std::string dumpEntryPath = 570b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 571b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)) + 572b47452b2SAsmitha Karunanithi "/entry/"; 573b47452b2SAsmitha Karunanithi 5745cb1dd27SAsmitha Karunanithi for (auto& objectPath : resp) 5755cb1dd27SAsmitha Karunanithi { 576b47452b2SAsmitha Karunanithi if (objectPath.first.str != dumpEntryPath + entryID) 5775cb1dd27SAsmitha Karunanithi { 5785cb1dd27SAsmitha Karunanithi continue; 5795cb1dd27SAsmitha Karunanithi } 5805cb1dd27SAsmitha Karunanithi 5815cb1dd27SAsmitha Karunanithi foundDumpEntry = true; 5825cb1dd27SAsmitha Karunanithi std::time_t timestamp; 5835cb1dd27SAsmitha Karunanithi uint64_t size = 0; 58435440d18SAsmitha Karunanithi std::string dumpStatus; 5855cb1dd27SAsmitha Karunanithi 5865cb1dd27SAsmitha Karunanithi for (auto& interfaceMap : objectPath.second) 5875cb1dd27SAsmitha Karunanithi { 58835440d18SAsmitha Karunanithi if (interfaceMap.first == 58935440d18SAsmitha Karunanithi "xyz.openbmc_project.Common.Progress") 59035440d18SAsmitha Karunanithi { 59135440d18SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 59235440d18SAsmitha Karunanithi { 59335440d18SAsmitha Karunanithi if (propertyMap.first == "Status") 59435440d18SAsmitha Karunanithi { 59535440d18SAsmitha Karunanithi auto status = std::get_if<std::string>( 59635440d18SAsmitha Karunanithi &propertyMap.second); 59735440d18SAsmitha Karunanithi if (status == nullptr) 59835440d18SAsmitha Karunanithi { 59935440d18SAsmitha Karunanithi messages::internalError(asyncResp->res); 60035440d18SAsmitha Karunanithi break; 60135440d18SAsmitha Karunanithi } 60235440d18SAsmitha Karunanithi dumpStatus = *status; 60335440d18SAsmitha Karunanithi } 60435440d18SAsmitha Karunanithi } 60535440d18SAsmitha Karunanithi } 60635440d18SAsmitha Karunanithi else if (interfaceMap.first == 60735440d18SAsmitha Karunanithi "xyz.openbmc_project.Dump.Entry") 6085cb1dd27SAsmitha Karunanithi { 6095cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 6105cb1dd27SAsmitha Karunanithi { 6115cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Size") 6125cb1dd27SAsmitha Karunanithi { 6135cb1dd27SAsmitha Karunanithi auto sizePtr = 6145cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 6155cb1dd27SAsmitha Karunanithi if (sizePtr == nullptr) 6165cb1dd27SAsmitha Karunanithi { 6175cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6185cb1dd27SAsmitha Karunanithi break; 6195cb1dd27SAsmitha Karunanithi } 6205cb1dd27SAsmitha Karunanithi size = *sizePtr; 6215cb1dd27SAsmitha Karunanithi break; 6225cb1dd27SAsmitha Karunanithi } 6235cb1dd27SAsmitha Karunanithi } 6245cb1dd27SAsmitha Karunanithi } 6255cb1dd27SAsmitha Karunanithi else if (interfaceMap.first == 6265cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Time.EpochTime") 6275cb1dd27SAsmitha Karunanithi { 6285cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 6295cb1dd27SAsmitha Karunanithi { 6305cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Elapsed") 6315cb1dd27SAsmitha Karunanithi { 6325cb1dd27SAsmitha Karunanithi const uint64_t* usecsTimeStamp = 6335cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 6345cb1dd27SAsmitha Karunanithi if (usecsTimeStamp == nullptr) 6355cb1dd27SAsmitha Karunanithi { 6365cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6375cb1dd27SAsmitha Karunanithi break; 6385cb1dd27SAsmitha Karunanithi } 6395cb1dd27SAsmitha Karunanithi timestamp = 6405cb1dd27SAsmitha Karunanithi static_cast<std::time_t>(*usecsTimeStamp); 6415cb1dd27SAsmitha Karunanithi break; 6425cb1dd27SAsmitha Karunanithi } 6435cb1dd27SAsmitha Karunanithi } 6445cb1dd27SAsmitha Karunanithi } 6455cb1dd27SAsmitha Karunanithi } 6465cb1dd27SAsmitha Karunanithi 6470fda0f12SGeorge Liu if (dumpStatus != 6480fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 64935440d18SAsmitha Karunanithi !dumpStatus.empty()) 65035440d18SAsmitha Karunanithi { 65135440d18SAsmitha Karunanithi // Dump status is not Complete 65235440d18SAsmitha Karunanithi // return not found until status is changed to Completed 65335440d18SAsmitha Karunanithi messages::resourceNotFound(asyncResp->res, 65435440d18SAsmitha Karunanithi dumpType + " dump", entryID); 65535440d18SAsmitha Karunanithi return; 65635440d18SAsmitha Karunanithi } 65735440d18SAsmitha Karunanithi 6585cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 659647b3cdcSGeorge Liu "#LogEntry.v1_8_0.LogEntry"; 6605cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.id"] = dumpPath + entryID; 6615cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = entryID; 6625cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["EntryType"] = "Event"; 6635cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Created"] = 6645cb1dd27SAsmitha Karunanithi crow::utility::getDateTime(timestamp); 6655cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry"; 6665cb1dd27SAsmitha Karunanithi 667d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 6685cb1dd27SAsmitha Karunanithi 6695cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 6705cb1dd27SAsmitha Karunanithi { 671d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager"; 672d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 673de8d94a3SAbhishek Patel "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/" + 674de8d94a3SAbhishek Patel entryID + "/attachment"; 6755cb1dd27SAsmitha Karunanithi } 6765cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 6775cb1dd27SAsmitha Karunanithi { 678d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM"; 679d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["OEMDiagnosticDataType"] = 6805cb1dd27SAsmitha Karunanithi "System"; 681d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 682de8d94a3SAbhishek Patel "/redfish/v1/Systems/system/LogServices/Dump/Entries/" + 683de8d94a3SAbhishek Patel entryID + "/attachment"; 6845cb1dd27SAsmitha Karunanithi } 6855cb1dd27SAsmitha Karunanithi } 686b47452b2SAsmitha Karunanithi if (foundDumpEntry == false) 687b47452b2SAsmitha Karunanithi { 688b47452b2SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Can't find Dump Entry"; 689b47452b2SAsmitha Karunanithi messages::internalError(asyncResp->res); 690b47452b2SAsmitha Karunanithi return; 691b47452b2SAsmitha Karunanithi } 6925cb1dd27SAsmitha Karunanithi }, 6935cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 6945cb1dd27SAsmitha Karunanithi "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 6955cb1dd27SAsmitha Karunanithi } 6965cb1dd27SAsmitha Karunanithi 6978d1b46d7Szhanghch05 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 6989878256fSStanley Chu const std::string& entryID, 699b47452b2SAsmitha Karunanithi const std::string& dumpType) 7005cb1dd27SAsmitha Karunanithi { 7013de8d8baSGeorge Liu auto respHandler = [asyncResp, 7023de8d8baSGeorge Liu entryID](const boost::system::error_code ec) { 7035cb1dd27SAsmitha Karunanithi BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done"; 7045cb1dd27SAsmitha Karunanithi if (ec) 7055cb1dd27SAsmitha Karunanithi { 7063de8d8baSGeorge Liu if (ec.value() == EBADR) 7073de8d8baSGeorge Liu { 7083de8d8baSGeorge Liu messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 7093de8d8baSGeorge Liu return; 7103de8d8baSGeorge Liu } 7115cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error " 7125cb1dd27SAsmitha Karunanithi << ec; 7135cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 7145cb1dd27SAsmitha Karunanithi return; 7155cb1dd27SAsmitha Karunanithi } 7165cb1dd27SAsmitha Karunanithi }; 7175cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 7185cb1dd27SAsmitha Karunanithi respHandler, "xyz.openbmc_project.Dump.Manager", 719b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 720b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/" + 721b47452b2SAsmitha Karunanithi entryID, 7225cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Object.Delete", "Delete"); 7235cb1dd27SAsmitha Karunanithi } 7245cb1dd27SAsmitha Karunanithi 7258d1b46d7Szhanghch05 inline void 726*98be3e39SEd Tanous createDumpTaskCallback(task::Payload&& payload, 7278d1b46d7Szhanghch05 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 7288d1b46d7Szhanghch05 const uint32_t& dumpId, const std::string& dumpPath, 729a43be80fSAsmitha Karunanithi const std::string& dumpType) 730a43be80fSAsmitha Karunanithi { 731a43be80fSAsmitha Karunanithi std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 7326145ed6fSAsmitha Karunanithi [dumpId, dumpPath, dumpType]( 733a43be80fSAsmitha Karunanithi boost::system::error_code err, sdbusplus::message::message& m, 734a43be80fSAsmitha Karunanithi const std::shared_ptr<task::TaskData>& taskData) { 735cb13a392SEd Tanous if (err) 736cb13a392SEd Tanous { 7376145ed6fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Error in creating a dump"; 7386145ed6fSAsmitha Karunanithi taskData->state = "Cancelled"; 7396145ed6fSAsmitha Karunanithi return task::completed; 740cb13a392SEd Tanous } 741a43be80fSAsmitha Karunanithi std::vector<std::pair< 742a43be80fSAsmitha Karunanithi std::string, 743a43be80fSAsmitha Karunanithi std::vector<std::pair<std::string, std::variant<std::string>>>>> 744a43be80fSAsmitha Karunanithi interfacesList; 745a43be80fSAsmitha Karunanithi 746a43be80fSAsmitha Karunanithi sdbusplus::message::object_path objPath; 747a43be80fSAsmitha Karunanithi 748a43be80fSAsmitha Karunanithi m.read(objPath, interfacesList); 749a43be80fSAsmitha Karunanithi 750b47452b2SAsmitha Karunanithi if (objPath.str == 751b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 752b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)) + 753b47452b2SAsmitha Karunanithi "/entry/" + std::to_string(dumpId)) 754a43be80fSAsmitha Karunanithi { 755a43be80fSAsmitha Karunanithi nlohmann::json retMessage = messages::success(); 756a43be80fSAsmitha Karunanithi taskData->messages.emplace_back(retMessage); 757a43be80fSAsmitha Karunanithi 758a43be80fSAsmitha Karunanithi std::string headerLoc = 759a43be80fSAsmitha Karunanithi "Location: " + dumpPath + std::to_string(dumpId); 760a43be80fSAsmitha Karunanithi taskData->payload->httpHeaders.emplace_back( 761a43be80fSAsmitha Karunanithi std::move(headerLoc)); 762a43be80fSAsmitha Karunanithi 763a43be80fSAsmitha Karunanithi taskData->state = "Completed"; 764b47452b2SAsmitha Karunanithi return task::completed; 7656145ed6fSAsmitha Karunanithi } 766a43be80fSAsmitha Karunanithi return task::completed; 767a43be80fSAsmitha Karunanithi }, 768a43be80fSAsmitha Karunanithi "type='signal',interface='org.freedesktop.DBus." 769a43be80fSAsmitha Karunanithi "ObjectManager'," 770a43be80fSAsmitha Karunanithi "member='InterfacesAdded', " 771a43be80fSAsmitha Karunanithi "path='/xyz/openbmc_project/dump'"); 772a43be80fSAsmitha Karunanithi 773a43be80fSAsmitha Karunanithi task->startTimer(std::chrono::minutes(3)); 774a43be80fSAsmitha Karunanithi task->populateResp(asyncResp->res); 775*98be3e39SEd Tanous task->payload.emplace(std::move(payload)); 776a43be80fSAsmitha Karunanithi } 777a43be80fSAsmitha Karunanithi 7788d1b46d7Szhanghch05 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 7798d1b46d7Szhanghch05 const crow::Request& req, const std::string& dumpType) 780a43be80fSAsmitha Karunanithi { 781a43be80fSAsmitha Karunanithi 782a43be80fSAsmitha Karunanithi std::string dumpPath; 783a43be80fSAsmitha Karunanithi if (dumpType == "BMC") 784a43be80fSAsmitha Karunanithi { 785a43be80fSAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 786a43be80fSAsmitha Karunanithi } 787a43be80fSAsmitha Karunanithi else if (dumpType == "System") 788a43be80fSAsmitha Karunanithi { 789a43be80fSAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 790a43be80fSAsmitha Karunanithi } 791a43be80fSAsmitha Karunanithi else 792a43be80fSAsmitha Karunanithi { 793a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Invalid dump type: " << dumpType; 794a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 795a43be80fSAsmitha Karunanithi return; 796a43be80fSAsmitha Karunanithi } 797a43be80fSAsmitha Karunanithi 798a43be80fSAsmitha Karunanithi std::optional<std::string> diagnosticDataType; 799a43be80fSAsmitha Karunanithi std::optional<std::string> oemDiagnosticDataType; 800a43be80fSAsmitha Karunanithi 801a43be80fSAsmitha Karunanithi if (!redfish::json_util::readJson( 802a43be80fSAsmitha Karunanithi req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 803a43be80fSAsmitha Karunanithi "OEMDiagnosticDataType", oemDiagnosticDataType)) 804a43be80fSAsmitha Karunanithi { 805a43be80fSAsmitha Karunanithi return; 806a43be80fSAsmitha Karunanithi } 807a43be80fSAsmitha Karunanithi 808a43be80fSAsmitha Karunanithi if (dumpType == "System") 809a43be80fSAsmitha Karunanithi { 810a43be80fSAsmitha Karunanithi if (!oemDiagnosticDataType || !diagnosticDataType) 811a43be80fSAsmitha Karunanithi { 812a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump action parameter " 813a43be80fSAsmitha Karunanithi "'DiagnosticDataType'/" 814a43be80fSAsmitha Karunanithi "'OEMDiagnosticDataType' value not found!"; 815a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 816a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", 817a43be80fSAsmitha Karunanithi "DiagnosticDataType & OEMDiagnosticDataType"); 818a43be80fSAsmitha Karunanithi return; 819a43be80fSAsmitha Karunanithi } 8203174e4dfSEd Tanous if ((*oemDiagnosticDataType != "System") || 821a43be80fSAsmitha Karunanithi (*diagnosticDataType != "OEM")) 822a43be80fSAsmitha Karunanithi { 823a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Wrong parameter values passed"; 824a43be80fSAsmitha Karunanithi messages::invalidObject(asyncResp->res, 825a43be80fSAsmitha Karunanithi "System Dump creation parameters"); 826a43be80fSAsmitha Karunanithi return; 827a43be80fSAsmitha Karunanithi } 828a43be80fSAsmitha Karunanithi } 829a43be80fSAsmitha Karunanithi else if (dumpType == "BMC") 830a43be80fSAsmitha Karunanithi { 831a43be80fSAsmitha Karunanithi if (!diagnosticDataType) 832a43be80fSAsmitha Karunanithi { 8330fda0f12SGeorge Liu BMCWEB_LOG_ERROR 8340fda0f12SGeorge Liu << "CreateDump action parameter 'DiagnosticDataType' not found!"; 835a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 836a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType"); 837a43be80fSAsmitha Karunanithi return; 838a43be80fSAsmitha Karunanithi } 8393174e4dfSEd Tanous if (*diagnosticDataType != "Manager") 840a43be80fSAsmitha Karunanithi { 841a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR 842a43be80fSAsmitha Karunanithi << "Wrong parameter value passed for 'DiagnosticDataType'"; 843a43be80fSAsmitha Karunanithi messages::invalidObject(asyncResp->res, 844a43be80fSAsmitha Karunanithi "BMC Dump creation parameters"); 845a43be80fSAsmitha Karunanithi return; 846a43be80fSAsmitha Karunanithi } 847a43be80fSAsmitha Karunanithi } 848a43be80fSAsmitha Karunanithi 849a43be80fSAsmitha Karunanithi crow::connections::systemBus->async_method_call( 850*98be3e39SEd Tanous [asyncResp, payload(task::Payload(req)), dumpPath, 851*98be3e39SEd Tanous dumpType](const boost::system::error_code ec, 852*98be3e39SEd Tanous const uint32_t& dumpId) mutable { 853a43be80fSAsmitha Karunanithi if (ec) 854a43be80fSAsmitha Karunanithi { 855a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec; 856a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 857a43be80fSAsmitha Karunanithi return; 858a43be80fSAsmitha Karunanithi } 859a43be80fSAsmitha Karunanithi BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId; 860a43be80fSAsmitha Karunanithi 861*98be3e39SEd Tanous createDumpTaskCallback(std::move(payload), asyncResp, dumpId, 862*98be3e39SEd Tanous dumpPath, dumpType); 863a43be80fSAsmitha Karunanithi }, 864b47452b2SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", 865b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + 866b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)), 867a43be80fSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create", "CreateDump"); 868a43be80fSAsmitha Karunanithi } 869a43be80fSAsmitha Karunanithi 8708d1b46d7Szhanghch05 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 8718d1b46d7Szhanghch05 const std::string& dumpType) 87280319af1SAsmitha Karunanithi { 873b47452b2SAsmitha Karunanithi std::string dumpTypeLowerCopy = 874b47452b2SAsmitha Karunanithi std::string(boost::algorithm::to_lower_copy(dumpType)); 8758d1b46d7Szhanghch05 87680319af1SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 877b47452b2SAsmitha Karunanithi [asyncResp, dumpType](const boost::system::error_code ec, 87880319af1SAsmitha Karunanithi const std::vector<std::string>& subTreePaths) { 87980319af1SAsmitha Karunanithi if (ec) 88080319af1SAsmitha Karunanithi { 88180319af1SAsmitha Karunanithi BMCWEB_LOG_ERROR << "resp_handler got error " << ec; 88280319af1SAsmitha Karunanithi messages::internalError(asyncResp->res); 88380319af1SAsmitha Karunanithi return; 88480319af1SAsmitha Karunanithi } 88580319af1SAsmitha Karunanithi 88680319af1SAsmitha Karunanithi for (const std::string& path : subTreePaths) 88780319af1SAsmitha Karunanithi { 8882dfd18efSEd Tanous sdbusplus::message::object_path objPath(path); 8892dfd18efSEd Tanous std::string logID = objPath.filename(); 8902dfd18efSEd Tanous if (logID.empty()) 89180319af1SAsmitha Karunanithi { 8922dfd18efSEd Tanous continue; 89380319af1SAsmitha Karunanithi } 8942dfd18efSEd Tanous deleteDumpEntry(asyncResp, logID, dumpType); 89580319af1SAsmitha Karunanithi } 89680319af1SAsmitha Karunanithi }, 89780319af1SAsmitha Karunanithi "xyz.openbmc_project.ObjectMapper", 89880319af1SAsmitha Karunanithi "/xyz/openbmc_project/object_mapper", 89980319af1SAsmitha Karunanithi "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 900b47452b2SAsmitha Karunanithi "/xyz/openbmc_project/dump/" + dumpTypeLowerCopy, 0, 901b47452b2SAsmitha Karunanithi std::array<std::string, 1>{"xyz.openbmc_project.Dump.Entry." + 902b47452b2SAsmitha Karunanithi dumpType}); 90380319af1SAsmitha Karunanithi } 90480319af1SAsmitha Karunanithi 9057e860f15SJohn Edward Broadbent inline static void parseCrashdumpParameters( 906043a0536SJohnathan Mantey const std::vector<std::pair<std::string, VariantType>>& params, 907043a0536SJohnathan Mantey std::string& filename, std::string& timestamp, std::string& logfile) 908043a0536SJohnathan Mantey { 909043a0536SJohnathan Mantey for (auto property : params) 910043a0536SJohnathan Mantey { 911043a0536SJohnathan Mantey if (property.first == "Timestamp") 912043a0536SJohnathan Mantey { 913043a0536SJohnathan Mantey const std::string* value = 9148d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 915043a0536SJohnathan Mantey if (value != nullptr) 916043a0536SJohnathan Mantey { 917043a0536SJohnathan Mantey timestamp = *value; 918043a0536SJohnathan Mantey } 919043a0536SJohnathan Mantey } 920043a0536SJohnathan Mantey else if (property.first == "Filename") 921043a0536SJohnathan Mantey { 922043a0536SJohnathan Mantey const std::string* value = 9238d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 924043a0536SJohnathan Mantey if (value != nullptr) 925043a0536SJohnathan Mantey { 926043a0536SJohnathan Mantey filename = *value; 927043a0536SJohnathan Mantey } 928043a0536SJohnathan Mantey } 929043a0536SJohnathan Mantey else if (property.first == "Log") 930043a0536SJohnathan Mantey { 931043a0536SJohnathan Mantey const std::string* value = 9328d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 933043a0536SJohnathan Mantey if (value != nullptr) 934043a0536SJohnathan Mantey { 935043a0536SJohnathan Mantey logfile = *value; 936043a0536SJohnathan Mantey } 937043a0536SJohnathan Mantey } 938043a0536SJohnathan Mantey } 939043a0536SJohnathan Mantey } 940043a0536SJohnathan Mantey 941a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode"; 9427e860f15SJohn Edward Broadbent inline void requestRoutesSystemLogServiceCollection(App& app) 9431da66f75SEd Tanous { 944c4bf6374SJason M. Bills /** 945c4bf6374SJason M. Bills * Functions triggers appropriate requests on DBus 946c4bf6374SJason M. Bills */ 9477e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/") 948ed398213SEd Tanous .privileges(redfish::privileges::getLogServiceCollection) 9497e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 9507e860f15SJohn Edward Broadbent [](const crow::Request&, 9517e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 9527e860f15SJohn Edward Broadbent 953c4bf6374SJason M. Bills { 9547e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 9557e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 956c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 957c4bf6374SJason M. Bills "#LogServiceCollection.LogServiceCollection"; 958c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 959029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices"; 9607e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Name"] = 9617e860f15SJohn Edward Broadbent "System Log Services Collection"; 962c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 963c4bf6374SJason M. Bills "Collection of LogServices for this Computer System"; 9647e860f15SJohn Edward Broadbent nlohmann::json& logServiceArray = 9657e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members"]; 966c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 967029573d4SEd Tanous logServiceArray.push_back( 9687e860f15SJohn Edward Broadbent {{"@odata.id", 9697e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/EventLog"}}); 9705cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 971c9bb6861Sraviteja-b logServiceArray.push_back( 9727e860f15SJohn Edward Broadbent {{"@odata.id", 9737e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump"}}); 974c9bb6861Sraviteja-b #endif 975c9bb6861Sraviteja-b 976d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG 977d53dd41fSJason M. Bills logServiceArray.push_back( 978cb92c03bSAndrew Geissler {{"@odata.id", 979424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"}}); 980d53dd41fSJason M. Bills #endif 981b7028ebfSSpencer Ku 982b7028ebfSSpencer Ku #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER 983b7028ebfSSpencer Ku logServiceArray.push_back( 984b7028ebfSSpencer Ku {{"@odata.id", 985b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger"}}); 986b7028ebfSSpencer Ku #endif 987c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 988c4bf6374SJason M. Bills logServiceArray.size(); 989a3316fc6SZhikuiRen 990a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 991a3316fc6SZhikuiRen [asyncResp](const boost::system::error_code ec, 992a3316fc6SZhikuiRen const std::vector<std::string>& subtreePath) { 993a3316fc6SZhikuiRen if (ec) 994a3316fc6SZhikuiRen { 995a3316fc6SZhikuiRen BMCWEB_LOG_ERROR << ec; 996a3316fc6SZhikuiRen return; 997a3316fc6SZhikuiRen } 998a3316fc6SZhikuiRen 999a3316fc6SZhikuiRen for (auto& pathStr : subtreePath) 1000a3316fc6SZhikuiRen { 1001a3316fc6SZhikuiRen if (pathStr.find("PostCode") != std::string::npos) 1002a3316fc6SZhikuiRen { 100323a21a1cSEd Tanous nlohmann::json& logServiceArrayLocal = 1004a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"]; 100523a21a1cSEd Tanous logServiceArrayLocal.push_back( 10060fda0f12SGeorge Liu {{"@odata.id", 10070fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes"}}); 10087e860f15SJohn Edward Broadbent asyncResp->res 10097e860f15SJohn Edward Broadbent .jsonValue["Members@odata.count"] = 101023a21a1cSEd Tanous logServiceArrayLocal.size(); 1011a3316fc6SZhikuiRen return; 1012a3316fc6SZhikuiRen } 1013a3316fc6SZhikuiRen } 1014a3316fc6SZhikuiRen }, 1015a3316fc6SZhikuiRen "xyz.openbmc_project.ObjectMapper", 1016a3316fc6SZhikuiRen "/xyz/openbmc_project/object_mapper", 10177e860f15SJohn Edward Broadbent "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 10187e860f15SJohn Edward Broadbent 0, std::array<const char*, 1>{postCodeIface}); 10197e860f15SJohn Edward Broadbent }); 1020c4bf6374SJason M. Bills } 1021c4bf6374SJason M. Bills 10227e860f15SJohn Edward Broadbent inline void requestRoutesEventLogService(App& app) 1023c4bf6374SJason M. Bills { 10247e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/") 1025ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 10267e860f15SJohn Edward Broadbent .methods( 10277e860f15SJohn Edward Broadbent boost::beast::http::verb:: 10287e860f15SJohn Edward Broadbent get)([](const crow::Request&, 10297e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1030c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1031029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 1032c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1033c4bf6374SJason M. Bills "#LogService.v1_1_0.LogService"; 1034c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "Event Log Service"; 10357e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Description"] = 10367e860f15SJohn Edward Broadbent "System Event Log Service"; 1037c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "EventLog"; 1038c4bf6374SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 10397c8c4058STejas Patil 10407c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 10417c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 10427c8c4058STejas Patil 10437c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 10447c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 10457c8c4058STejas Patil redfishDateTimeOffset.second; 10467c8c4058STejas Patil 1047c4bf6374SJason M. Bills asyncResp->res.jsonValue["Entries"] = { 1048c4bf6374SJason M. Bills {"@odata.id", 1049029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}}; 1050e7d6c8b2SGunnar Mills asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 1051e7d6c8b2SGunnar Mills 10520fda0f12SGeorge Liu {"target", 10530fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog"}}; 10547e860f15SJohn Edward Broadbent }); 1055489640c6SJason M. Bills } 1056489640c6SJason M. Bills 10577e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogClear(App& app) 1058489640c6SJason M. Bills { 10597e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/" 1060489640c6SJason M. Bills "LogService.ClearLog/") 1061432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 10627e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 10637e860f15SJohn Edward Broadbent [](const crow::Request&, 10647e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1065489640c6SJason M. Bills // Clear the EventLog by deleting the log files 1066489640c6SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1067489640c6SJason M. Bills if (getRedfishLogFiles(redfishLogFiles)) 1068489640c6SJason M. Bills { 1069489640c6SJason M. Bills for (const std::filesystem::path& file : redfishLogFiles) 1070489640c6SJason M. Bills { 1071489640c6SJason M. Bills std::error_code ec; 1072489640c6SJason M. Bills std::filesystem::remove(file, ec); 1073489640c6SJason M. Bills } 1074489640c6SJason M. Bills } 1075489640c6SJason M. Bills 1076489640c6SJason M. Bills // Reload rsyslog so it knows to start new log files 1077489640c6SJason M. Bills crow::connections::systemBus->async_method_call( 1078489640c6SJason M. Bills [asyncResp](const boost::system::error_code ec) { 1079489640c6SJason M. Bills if (ec) 1080489640c6SJason M. Bills { 10817e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " 10827e860f15SJohn Edward Broadbent << ec; 1083489640c6SJason M. Bills messages::internalError(asyncResp->res); 1084489640c6SJason M. Bills return; 1085489640c6SJason M. Bills } 1086489640c6SJason M. Bills 1087489640c6SJason M. Bills messages::success(asyncResp->res); 1088489640c6SJason M. Bills }, 1089489640c6SJason M. Bills "org.freedesktop.systemd1", "/org/freedesktop/systemd1", 10907e860f15SJohn Edward Broadbent "org.freedesktop.systemd1.Manager", "ReloadUnit", 10917e860f15SJohn Edward Broadbent "rsyslog.service", "replace"); 10927e860f15SJohn Edward Broadbent }); 1093c4bf6374SJason M. Bills } 1094c4bf6374SJason M. Bills 109595820184SJason M. Bills static int fillEventLogEntryJson(const std::string& logEntryID, 1096b5a76932SEd Tanous const std::string& logEntry, 109795820184SJason M. Bills nlohmann::json& logEntryJson) 1098c4bf6374SJason M. Bills { 109995820184SJason M. Bills // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1100cd225da8SJason M. Bills // First get the Timestamp 1101f23b7296SEd Tanous size_t space = logEntry.find_first_of(' '); 1102cd225da8SJason M. Bills if (space == std::string::npos) 110395820184SJason M. Bills { 110495820184SJason M. Bills return 1; 110595820184SJason M. Bills } 1106cd225da8SJason M. Bills std::string timestamp = logEntry.substr(0, space); 1107cd225da8SJason M. Bills // Then get the log contents 1108f23b7296SEd Tanous size_t entryStart = logEntry.find_first_not_of(' ', space); 1109cd225da8SJason M. Bills if (entryStart == std::string::npos) 1110cd225da8SJason M. Bills { 1111cd225da8SJason M. Bills return 1; 1112cd225da8SJason M. Bills } 1113cd225da8SJason M. Bills std::string_view entry(logEntry); 1114cd225da8SJason M. Bills entry.remove_prefix(entryStart); 1115cd225da8SJason M. Bills // Use split to separate the entry into its fields 1116cd225da8SJason M. Bills std::vector<std::string> logEntryFields; 1117cd225da8SJason M. Bills boost::split(logEntryFields, entry, boost::is_any_of(","), 1118cd225da8SJason M. Bills boost::token_compress_on); 1119cd225da8SJason M. Bills // We need at least a MessageId to be valid 1120cd225da8SJason M. Bills if (logEntryFields.size() < 1) 1121cd225da8SJason M. Bills { 1122cd225da8SJason M. Bills return 1; 1123cd225da8SJason M. Bills } 1124cd225da8SJason M. Bills std::string& messageID = logEntryFields[0]; 112595820184SJason M. Bills 11264851d45dSJason M. Bills // Get the Message from the MessageRegistry 11274851d45dSJason M. Bills const message_registries::Message* message = 11284851d45dSJason M. Bills message_registries::getMessage(messageID); 1129c4bf6374SJason M. Bills 11304851d45dSJason M. Bills std::string msg; 11314851d45dSJason M. Bills std::string severity; 11324851d45dSJason M. Bills if (message != nullptr) 1133c4bf6374SJason M. Bills { 11344851d45dSJason M. Bills msg = message->message; 11354851d45dSJason M. Bills severity = message->severity; 1136c4bf6374SJason M. Bills } 1137c4bf6374SJason M. Bills 113815a86ff6SJason M. Bills // Get the MessageArgs from the log if there are any 113926702d01SEd Tanous std::span<std::string> messageArgs; 114015a86ff6SJason M. Bills if (logEntryFields.size() > 1) 114115a86ff6SJason M. Bills { 114215a86ff6SJason M. Bills std::string& messageArgsStart = logEntryFields[1]; 114315a86ff6SJason M. Bills // If the first string is empty, assume there are no MessageArgs 114415a86ff6SJason M. Bills std::size_t messageArgsSize = 0; 114515a86ff6SJason M. Bills if (!messageArgsStart.empty()) 114615a86ff6SJason M. Bills { 114715a86ff6SJason M. Bills messageArgsSize = logEntryFields.size() - 1; 114815a86ff6SJason M. Bills } 114915a86ff6SJason M. Bills 115023a21a1cSEd Tanous messageArgs = {&messageArgsStart, messageArgsSize}; 1151c4bf6374SJason M. Bills 11524851d45dSJason M. Bills // Fill the MessageArgs into the Message 115395820184SJason M. Bills int i = 0; 115495820184SJason M. Bills for (const std::string& messageArg : messageArgs) 11554851d45dSJason M. Bills { 115695820184SJason M. Bills std::string argStr = "%" + std::to_string(++i); 11574851d45dSJason M. Bills size_t argPos = msg.find(argStr); 11584851d45dSJason M. Bills if (argPos != std::string::npos) 11594851d45dSJason M. Bills { 116095820184SJason M. Bills msg.replace(argPos, argStr.length(), messageArg); 11614851d45dSJason M. Bills } 11624851d45dSJason M. Bills } 116315a86ff6SJason M. Bills } 11644851d45dSJason M. Bills 116595820184SJason M. Bills // Get the Created time from the timestamp. The log timestamp is in RFC3339 116695820184SJason M. Bills // format which matches the Redfish format except for the fractional seconds 116795820184SJason M. Bills // between the '.' and the '+', so just remove them. 1168f23b7296SEd Tanous std::size_t dot = timestamp.find_first_of('.'); 1169f23b7296SEd Tanous std::size_t plus = timestamp.find_first_of('+'); 117095820184SJason M. Bills if (dot != std::string::npos && plus != std::string::npos) 1171c4bf6374SJason M. Bills { 117295820184SJason M. Bills timestamp.erase(dot, plus - dot); 1173c4bf6374SJason M. Bills } 1174c4bf6374SJason M. Bills 1175c4bf6374SJason M. Bills // Fill in the log entry with the gathered data 117695820184SJason M. Bills logEntryJson = { 1177647b3cdcSGeorge Liu {"@odata.type", "#LogEntry.v1_8_0.LogEntry"}, 1178029573d4SEd Tanous {"@odata.id", 1179897967deSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 118095820184SJason M. Bills logEntryID}, 1181c4bf6374SJason M. Bills {"Name", "System Event Log Entry"}, 118295820184SJason M. Bills {"Id", logEntryID}, 118395820184SJason M. Bills {"Message", std::move(msg)}, 118495820184SJason M. Bills {"MessageId", std::move(messageID)}, 1185f23b7296SEd Tanous {"MessageArgs", messageArgs}, 1186c4bf6374SJason M. Bills {"EntryType", "Event"}, 118795820184SJason M. Bills {"Severity", std::move(severity)}, 118895820184SJason M. Bills {"Created", std::move(timestamp)}}; 1189c4bf6374SJason M. Bills return 0; 1190c4bf6374SJason M. Bills } 1191c4bf6374SJason M. Bills 11927e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntryCollection(App& app) 1193c4bf6374SJason M. Bills { 11947e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 11957e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") 11968b6a35f0SGunnar Mills .privileges(redfish::privileges::getLogEntryCollection) 11977e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 11987e860f15SJohn Edward Broadbent [](const crow::Request& req, 11997e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1200271584abSEd Tanous uint64_t skip = 0; 1201271584abSEd Tanous uint64_t top = maxEntriesPerPage; // Show max entries by default 12028d1b46d7Szhanghch05 if (!getSkipParam(asyncResp, req, skip)) 1203c4bf6374SJason M. Bills { 1204c4bf6374SJason M. Bills return; 1205c4bf6374SJason M. Bills } 12068d1b46d7Szhanghch05 if (!getTopParam(asyncResp, req, top)) 1207c4bf6374SJason M. Bills { 1208c4bf6374SJason M. Bills return; 1209c4bf6374SJason M. Bills } 12107e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 12117e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1212c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1213c4bf6374SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 1214c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1215029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1216c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 1217c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 1218c4bf6374SJason M. Bills "Collection of System Event Log Entries"; 1219cb92c03bSAndrew Geissler 12207e860f15SJohn Edward Broadbent nlohmann::json& logEntryArray = 12217e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members"]; 1222c4bf6374SJason M. Bills logEntryArray = nlohmann::json::array(); 12237e860f15SJohn Edward Broadbent // Go through the log files and create a unique ID for each 12247e860f15SJohn Edward Broadbent // entry 122595820184SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 122695820184SJason M. Bills getRedfishLogFiles(redfishLogFiles); 1227b01bf299SEd Tanous uint64_t entryCount = 0; 1228cd225da8SJason M. Bills std::string logEntry; 122995820184SJason M. Bills 12307e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 12317e860f15SJohn Edward Broadbent // backwards 12327e860f15SJohn Edward Broadbent for (auto it = redfishLogFiles.rbegin(); 12337e860f15SJohn Edward Broadbent it < redfishLogFiles.rend(); it++) 1234c4bf6374SJason M. Bills { 1235cd225da8SJason M. Bills std::ifstream logStream(*it); 123695820184SJason M. Bills if (!logStream.is_open()) 1237c4bf6374SJason M. Bills { 1238c4bf6374SJason M. Bills continue; 1239c4bf6374SJason M. Bills } 1240c4bf6374SJason M. Bills 1241e85d6b16SJason M. Bills // Reset the unique ID on the first entry 1242e85d6b16SJason M. Bills bool firstEntry = true; 124395820184SJason M. Bills while (std::getline(logStream, logEntry)) 124495820184SJason M. Bills { 1245c4bf6374SJason M. Bills entryCount++; 12467e860f15SJohn Edward Broadbent // Handle paging using skip (number of entries to skip 12477e860f15SJohn Edward Broadbent // from the start) and top (number of entries to 12487e860f15SJohn Edward Broadbent // display) 1249c4bf6374SJason M. Bills if (entryCount <= skip || entryCount > skip + top) 1250c4bf6374SJason M. Bills { 1251c4bf6374SJason M. Bills continue; 1252c4bf6374SJason M. Bills } 1253c4bf6374SJason M. Bills 1254c4bf6374SJason M. Bills std::string idStr; 1255e85d6b16SJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1256c4bf6374SJason M. Bills { 1257c4bf6374SJason M. Bills continue; 1258c4bf6374SJason M. Bills } 1259c4bf6374SJason M. Bills 1260e85d6b16SJason M. Bills if (firstEntry) 1261e85d6b16SJason M. Bills { 1262e85d6b16SJason M. Bills firstEntry = false; 1263e85d6b16SJason M. Bills } 1264e85d6b16SJason M. Bills 1265c4bf6374SJason M. Bills logEntryArray.push_back({}); 1266c4bf6374SJason M. Bills nlohmann::json& bmcLogEntry = logEntryArray.back(); 12677e860f15SJohn Edward Broadbent if (fillEventLogEntryJson(idStr, logEntry, 12687e860f15SJohn Edward Broadbent bmcLogEntry) != 0) 1269c4bf6374SJason M. Bills { 1270c4bf6374SJason M. Bills messages::internalError(asyncResp->res); 1271c4bf6374SJason M. Bills return; 1272c4bf6374SJason M. Bills } 1273c4bf6374SJason M. Bills } 127495820184SJason M. Bills } 1275c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 1276c4bf6374SJason M. Bills if (skip + top < entryCount) 1277c4bf6374SJason M. Bills { 1278c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 127995820184SJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/" 128095820184SJason M. Bills "Entries?$skip=" + 1281c4bf6374SJason M. Bills std::to_string(skip + top); 1282c4bf6374SJason M. Bills } 12837e860f15SJohn Edward Broadbent }); 1284897967deSJason M. Bills } 1285897967deSJason M. Bills 12867e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntry(App& app) 1287897967deSJason M. Bills { 12887e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 12897e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1290ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 12917e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 12927e860f15SJohn Edward Broadbent [](const crow::Request&, 12937e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 12947e860f15SJohn Edward Broadbent const std::string& param) { 12957e860f15SJohn Edward Broadbent const std::string& targetID = param; 12968d1b46d7Szhanghch05 12977e860f15SJohn Edward Broadbent // Go through the log files and check the unique ID for each 12987e860f15SJohn Edward Broadbent // entry to find the target entry 1299897967deSJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1300897967deSJason M. Bills getRedfishLogFiles(redfishLogFiles); 1301897967deSJason M. Bills std::string logEntry; 1302897967deSJason M. Bills 13037e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 13047e860f15SJohn Edward Broadbent // backwards 13057e860f15SJohn Edward Broadbent for (auto it = redfishLogFiles.rbegin(); 13067e860f15SJohn Edward Broadbent it < redfishLogFiles.rend(); it++) 1307897967deSJason M. Bills { 1308897967deSJason M. Bills std::ifstream logStream(*it); 1309897967deSJason M. Bills if (!logStream.is_open()) 1310897967deSJason M. Bills { 1311897967deSJason M. Bills continue; 1312897967deSJason M. Bills } 1313897967deSJason M. Bills 1314897967deSJason M. Bills // Reset the unique ID on the first entry 1315897967deSJason M. Bills bool firstEntry = true; 1316897967deSJason M. Bills while (std::getline(logStream, logEntry)) 1317897967deSJason M. Bills { 1318897967deSJason M. Bills std::string idStr; 1319897967deSJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1320897967deSJason M. Bills { 1321897967deSJason M. Bills continue; 1322897967deSJason M. Bills } 1323897967deSJason M. Bills 1324897967deSJason M. Bills if (firstEntry) 1325897967deSJason M. Bills { 1326897967deSJason M. Bills firstEntry = false; 1327897967deSJason M. Bills } 1328897967deSJason M. Bills 1329897967deSJason M. Bills if (idStr == targetID) 1330897967deSJason M. Bills { 13317e860f15SJohn Edward Broadbent if (fillEventLogEntryJson( 13327e860f15SJohn Edward Broadbent idStr, logEntry, 1333897967deSJason M. Bills asyncResp->res.jsonValue) != 0) 1334897967deSJason M. Bills { 1335897967deSJason M. Bills messages::internalError(asyncResp->res); 1336897967deSJason M. Bills return; 1337897967deSJason M. Bills } 1338897967deSJason M. Bills return; 1339897967deSJason M. Bills } 1340897967deSJason M. Bills } 1341897967deSJason M. Bills } 1342897967deSJason M. Bills // Requested ID was not found 1343897967deSJason M. Bills messages::resourceMissingAtURI(asyncResp->res, targetID); 13447e860f15SJohn Edward Broadbent }); 134508a4e4b5SAnthony Wilson } 134608a4e4b5SAnthony Wilson 13477e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryCollection(App& app) 134808a4e4b5SAnthony Wilson { 13497e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 13507e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") 1351ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 13527e860f15SJohn Edward Broadbent .methods( 13537e860f15SJohn Edward Broadbent boost::beast::http::verb:: 13547e860f15SJohn Edward Broadbent get)([](const crow::Request&, 13557e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 13567e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 13577e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 135808a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.type"] = 135908a4e4b5SAnthony Wilson "#LogEntryCollection.LogEntryCollection"; 136008a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.id"] = 136108a4e4b5SAnthony Wilson "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 136208a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 136308a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Description"] = 136408a4e4b5SAnthony Wilson "Collection of System Event Log Entries"; 136508a4e4b5SAnthony Wilson 1366cb92c03bSAndrew Geissler // DBus implementation of EventLog/Entries 1367cb92c03bSAndrew Geissler // Make call to Logging Service to find all log entry objects 1368cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 1369cb92c03bSAndrew Geissler [asyncResp](const boost::system::error_code ec, 1370cb92c03bSAndrew Geissler GetManagedObjectsType& resp) { 1371cb92c03bSAndrew Geissler if (ec) 1372cb92c03bSAndrew Geissler { 1373cb92c03bSAndrew Geissler // TODO Handle for specific error code 1374cb92c03bSAndrew Geissler BMCWEB_LOG_ERROR 1375cb92c03bSAndrew Geissler << "getLogEntriesIfaceData resp_handler got error " 1376cb92c03bSAndrew Geissler << ec; 1377cb92c03bSAndrew Geissler messages::internalError(asyncResp->res); 1378cb92c03bSAndrew Geissler return; 1379cb92c03bSAndrew Geissler } 1380cb92c03bSAndrew Geissler nlohmann::json& entriesArray = 1381cb92c03bSAndrew Geissler asyncResp->res.jsonValue["Members"]; 1382cb92c03bSAndrew Geissler entriesArray = nlohmann::json::array(); 1383cb92c03bSAndrew Geissler for (auto& objectPath : resp) 1384cb92c03bSAndrew Geissler { 138566664f25SEd Tanous uint32_t* id = nullptr; 138666664f25SEd Tanous std::time_t timestamp{}; 1387d139c236SGeorge Liu std::time_t updateTimestamp{}; 138866664f25SEd Tanous std::string* severity = nullptr; 138966664f25SEd Tanous std::string* message = nullptr; 1390f86bb901SAdriana Kobylak std::string* filePath = nullptr; 139175710de2SXiaochao Ma bool resolved = false; 1392f86bb901SAdriana Kobylak for (auto& interfaceMap : objectPath.second) 1393f86bb901SAdriana Kobylak { 1394f86bb901SAdriana Kobylak if (interfaceMap.first == 1395f86bb901SAdriana Kobylak "xyz.openbmc_project.Logging.Entry") 1396f86bb901SAdriana Kobylak { 1397cb92c03bSAndrew Geissler for (auto& propertyMap : interfaceMap.second) 1398cb92c03bSAndrew Geissler { 1399cb92c03bSAndrew Geissler if (propertyMap.first == "Id") 1400cb92c03bSAndrew Geissler { 1401f86bb901SAdriana Kobylak id = std::get_if<uint32_t>( 1402f86bb901SAdriana Kobylak &propertyMap.second); 1403cb92c03bSAndrew Geissler } 1404cb92c03bSAndrew Geissler else if (propertyMap.first == "Timestamp") 1405cb92c03bSAndrew Geissler { 1406cb92c03bSAndrew Geissler const uint64_t* millisTimeStamp = 1407f86bb901SAdriana Kobylak std::get_if<uint64_t>( 1408f86bb901SAdriana Kobylak &propertyMap.second); 1409ae34c8e8SAdriana Kobylak if (millisTimeStamp != nullptr) 1410ebd45906SGeorge Liu { 14117e860f15SJohn Edward Broadbent timestamp = 14127e860f15SJohn Edward Broadbent crow::utility::getTimestamp( 14137e860f15SJohn Edward Broadbent *millisTimeStamp); 14147e860f15SJohn Edward Broadbent } 14157e860f15SJohn Edward Broadbent } 14167e860f15SJohn Edward Broadbent else if (propertyMap.first == 14177e860f15SJohn Edward Broadbent "UpdateTimestamp") 14187e860f15SJohn Edward Broadbent { 14197e860f15SJohn Edward Broadbent const uint64_t* millisTimeStamp = 14207e860f15SJohn Edward Broadbent std::get_if<uint64_t>( 14217e860f15SJohn Edward Broadbent &propertyMap.second); 14227e860f15SJohn Edward Broadbent if (millisTimeStamp != nullptr) 14237e860f15SJohn Edward Broadbent { 14247e860f15SJohn Edward Broadbent updateTimestamp = 14257e860f15SJohn Edward Broadbent crow::utility::getTimestamp( 14267e860f15SJohn Edward Broadbent *millisTimeStamp); 14277e860f15SJohn Edward Broadbent } 14287e860f15SJohn Edward Broadbent } 14297e860f15SJohn Edward Broadbent else if (propertyMap.first == "Severity") 14307e860f15SJohn Edward Broadbent { 14317e860f15SJohn Edward Broadbent severity = std::get_if<std::string>( 14327e860f15SJohn Edward Broadbent &propertyMap.second); 14337e860f15SJohn Edward Broadbent } 14347e860f15SJohn Edward Broadbent else if (propertyMap.first == "Message") 14357e860f15SJohn Edward Broadbent { 14367e860f15SJohn Edward Broadbent message = std::get_if<std::string>( 14377e860f15SJohn Edward Broadbent &propertyMap.second); 14387e860f15SJohn Edward Broadbent } 14397e860f15SJohn Edward Broadbent else if (propertyMap.first == "Resolved") 14407e860f15SJohn Edward Broadbent { 14417e860f15SJohn Edward Broadbent bool* resolveptr = std::get_if<bool>( 14427e860f15SJohn Edward Broadbent &propertyMap.second); 14437e860f15SJohn Edward Broadbent if (resolveptr == nullptr) 14447e860f15SJohn Edward Broadbent { 14457e860f15SJohn Edward Broadbent messages::internalError( 14467e860f15SJohn Edward Broadbent asyncResp->res); 14477e860f15SJohn Edward Broadbent return; 14487e860f15SJohn Edward Broadbent } 14497e860f15SJohn Edward Broadbent resolved = *resolveptr; 14507e860f15SJohn Edward Broadbent } 14517e860f15SJohn Edward Broadbent } 14527e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 14537e860f15SJohn Edward Broadbent severity == nullptr) 14547e860f15SJohn Edward Broadbent { 14557e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 14567e860f15SJohn Edward Broadbent return; 14577e860f15SJohn Edward Broadbent } 14587e860f15SJohn Edward Broadbent } 14597e860f15SJohn Edward Broadbent else if (interfaceMap.first == 14607e860f15SJohn Edward Broadbent "xyz.openbmc_project.Common.FilePath") 14617e860f15SJohn Edward Broadbent { 14627e860f15SJohn Edward Broadbent for (auto& propertyMap : interfaceMap.second) 14637e860f15SJohn Edward Broadbent { 14647e860f15SJohn Edward Broadbent if (propertyMap.first == "Path") 14657e860f15SJohn Edward Broadbent { 14667e860f15SJohn Edward Broadbent filePath = std::get_if<std::string>( 14677e860f15SJohn Edward Broadbent &propertyMap.second); 14687e860f15SJohn Edward Broadbent } 14697e860f15SJohn Edward Broadbent } 14707e860f15SJohn Edward Broadbent } 14717e860f15SJohn Edward Broadbent } 14727e860f15SJohn Edward Broadbent // Object path without the 14737e860f15SJohn Edward Broadbent // xyz.openbmc_project.Logging.Entry interface, ignore 14747e860f15SJohn Edward Broadbent // and continue. 14757e860f15SJohn Edward Broadbent if (id == nullptr || message == nullptr || 14767e860f15SJohn Edward Broadbent severity == nullptr) 14777e860f15SJohn Edward Broadbent { 14787e860f15SJohn Edward Broadbent continue; 14797e860f15SJohn Edward Broadbent } 14807e860f15SJohn Edward Broadbent entriesArray.push_back({}); 14817e860f15SJohn Edward Broadbent nlohmann::json& thisEntry = entriesArray.back(); 14827e860f15SJohn Edward Broadbent thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry"; 14837e860f15SJohn Edward Broadbent thisEntry["@odata.id"] = 14840fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 14857e860f15SJohn Edward Broadbent std::to_string(*id); 14867e860f15SJohn Edward Broadbent thisEntry["Name"] = "System Event Log Entry"; 14877e860f15SJohn Edward Broadbent thisEntry["Id"] = std::to_string(*id); 14887e860f15SJohn Edward Broadbent thisEntry["Message"] = *message; 14897e860f15SJohn Edward Broadbent thisEntry["Resolved"] = resolved; 14907e860f15SJohn Edward Broadbent thisEntry["EntryType"] = "Event"; 14917e860f15SJohn Edward Broadbent thisEntry["Severity"] = 14927e860f15SJohn Edward Broadbent translateSeverityDbusToRedfish(*severity); 14937e860f15SJohn Edward Broadbent thisEntry["Created"] = 14947e860f15SJohn Edward Broadbent crow::utility::getDateTime(timestamp); 14957e860f15SJohn Edward Broadbent thisEntry["Modified"] = 14967e860f15SJohn Edward Broadbent crow::utility::getDateTime(updateTimestamp); 14977e860f15SJohn Edward Broadbent if (filePath != nullptr) 14987e860f15SJohn Edward Broadbent { 14997e860f15SJohn Edward Broadbent thisEntry["AdditionalDataURI"] = 15000fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 15017e860f15SJohn Edward Broadbent std::to_string(*id) + "/attachment"; 15027e860f15SJohn Edward Broadbent } 15037e860f15SJohn Edward Broadbent } 15047e860f15SJohn Edward Broadbent std::sort(entriesArray.begin(), entriesArray.end(), 15057e860f15SJohn Edward Broadbent [](const nlohmann::json& left, 15067e860f15SJohn Edward Broadbent const nlohmann::json& right) { 15077e860f15SJohn Edward Broadbent return (left["Id"] <= right["Id"]); 15087e860f15SJohn Edward Broadbent }); 15097e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members@odata.count"] = 15107e860f15SJohn Edward Broadbent entriesArray.size(); 15117e860f15SJohn Edward Broadbent }, 15127e860f15SJohn Edward Broadbent "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging", 15137e860f15SJohn Edward Broadbent "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 15147e860f15SJohn Edward Broadbent }); 15157e860f15SJohn Edward Broadbent } 15167e860f15SJohn Edward Broadbent 15177e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app) 15187e860f15SJohn Edward Broadbent { 15197e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 15207e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1521ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 15227e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 15237e860f15SJohn Edward Broadbent [](const crow::Request&, 15247e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 15257e860f15SJohn Edward Broadbent const std::string& param) 15267e860f15SJohn Edward Broadbent 15277e860f15SJohn Edward Broadbent { 15287e860f15SJohn Edward Broadbent std::string entryID = param; 15297e860f15SJohn Edward Broadbent dbus::utility::escapePathForDbus(entryID); 15307e860f15SJohn Edward Broadbent 15317e860f15SJohn Edward Broadbent // DBus implementation of EventLog/Entries 15327e860f15SJohn Edward Broadbent // Make call to Logging Service to find all log entry objects 15337e860f15SJohn Edward Broadbent crow::connections::systemBus->async_method_call( 15347e860f15SJohn Edward Broadbent [asyncResp, entryID](const boost::system::error_code ec, 15357e860f15SJohn Edward Broadbent GetManagedPropertyType& resp) { 15367e860f15SJohn Edward Broadbent if (ec.value() == EBADR) 15377e860f15SJohn Edward Broadbent { 15387e860f15SJohn Edward Broadbent messages::resourceNotFound( 15397e860f15SJohn Edward Broadbent asyncResp->res, "EventLogEntry", entryID); 15407e860f15SJohn Edward Broadbent return; 15417e860f15SJohn Edward Broadbent } 15427e860f15SJohn Edward Broadbent if (ec) 15437e860f15SJohn Edward Broadbent { 15440fda0f12SGeorge Liu BMCWEB_LOG_ERROR 15450fda0f12SGeorge Liu << "EventLogEntry (DBus) resp_handler got error " 15467e860f15SJohn Edward Broadbent << ec; 15477e860f15SJohn Edward Broadbent messages::internalError(asyncResp->res); 15487e860f15SJohn Edward Broadbent return; 15497e860f15SJohn Edward Broadbent } 15507e860f15SJohn Edward Broadbent uint32_t* id = nullptr; 15517e860f15SJohn Edward Broadbent std::time_t timestamp{}; 15527e860f15SJohn Edward Broadbent std::time_t updateTimestamp{}; 15537e860f15SJohn Edward Broadbent std::string* severity = nullptr; 15547e860f15SJohn Edward Broadbent std::string* message = nullptr; 15557e860f15SJohn Edward Broadbent std::string* filePath = nullptr; 15567e860f15SJohn Edward Broadbent bool resolved = false; 15577e860f15SJohn Edward Broadbent 15587e860f15SJohn Edward Broadbent for (auto& propertyMap : resp) 15597e860f15SJohn Edward Broadbent { 15607e860f15SJohn Edward Broadbent if (propertyMap.first == "Id") 15617e860f15SJohn Edward Broadbent { 15627e860f15SJohn Edward Broadbent id = std::get_if<uint32_t>(&propertyMap.second); 15637e860f15SJohn Edward Broadbent } 15647e860f15SJohn Edward Broadbent else if (propertyMap.first == "Timestamp") 15657e860f15SJohn Edward Broadbent { 15667e860f15SJohn Edward Broadbent const uint64_t* millisTimeStamp = 15677e860f15SJohn Edward Broadbent std::get_if<uint64_t>(&propertyMap.second); 15687e860f15SJohn Edward Broadbent if (millisTimeStamp != nullptr) 15697e860f15SJohn Edward Broadbent { 1570d139c236SGeorge Liu timestamp = crow::utility::getTimestamp( 1571cb92c03bSAndrew Geissler *millisTimeStamp); 1572d139c236SGeorge Liu } 1573ebd45906SGeorge Liu } 1574d139c236SGeorge Liu else if (propertyMap.first == "UpdateTimestamp") 1575d139c236SGeorge Liu { 1576d139c236SGeorge Liu const uint64_t* millisTimeStamp = 15777e860f15SJohn Edward Broadbent std::get_if<uint64_t>(&propertyMap.second); 1578ae34c8e8SAdriana Kobylak if (millisTimeStamp != nullptr) 1579ebd45906SGeorge Liu { 1580ebd45906SGeorge Liu updateTimestamp = 1581ebd45906SGeorge Liu crow::utility::getTimestamp( 1582d139c236SGeorge Liu *millisTimeStamp); 1583cb92c03bSAndrew Geissler } 1584ebd45906SGeorge Liu } 1585cb92c03bSAndrew Geissler else if (propertyMap.first == "Severity") 1586cb92c03bSAndrew Geissler { 1587cb92c03bSAndrew Geissler severity = std::get_if<std::string>( 1588cb92c03bSAndrew Geissler &propertyMap.second); 1589cb92c03bSAndrew Geissler } 1590cb92c03bSAndrew Geissler else if (propertyMap.first == "Message") 1591cb92c03bSAndrew Geissler { 1592cb92c03bSAndrew Geissler message = std::get_if<std::string>( 1593cb92c03bSAndrew Geissler &propertyMap.second); 1594ae34c8e8SAdriana Kobylak } 159575710de2SXiaochao Ma else if (propertyMap.first == "Resolved") 159675710de2SXiaochao Ma { 159775710de2SXiaochao Ma bool* resolveptr = 159875710de2SXiaochao Ma std::get_if<bool>(&propertyMap.second); 159975710de2SXiaochao Ma if (resolveptr == nullptr) 160075710de2SXiaochao Ma { 160175710de2SXiaochao Ma messages::internalError(asyncResp->res); 160275710de2SXiaochao Ma return; 160375710de2SXiaochao Ma } 160475710de2SXiaochao Ma resolved = *resolveptr; 160575710de2SXiaochao Ma } 16067e860f15SJohn Edward Broadbent else if (propertyMap.first == "Path") 1607f86bb901SAdriana Kobylak { 1608f86bb901SAdriana Kobylak filePath = std::get_if<std::string>( 1609f86bb901SAdriana Kobylak &propertyMap.second); 1610f86bb901SAdriana Kobylak } 1611f86bb901SAdriana Kobylak } 1612f86bb901SAdriana Kobylak if (id == nullptr || message == nullptr || 1613f86bb901SAdriana Kobylak severity == nullptr) 1614f86bb901SAdriana Kobylak { 1615ae34c8e8SAdriana Kobylak messages::internalError(asyncResp->res); 1616271584abSEd Tanous return; 1617271584abSEd Tanous } 1618f86bb901SAdriana Kobylak asyncResp->res.jsonValue["@odata.type"] = 1619f86bb901SAdriana Kobylak "#LogEntry.v1_8_0.LogEntry"; 1620f86bb901SAdriana Kobylak asyncResp->res.jsonValue["@odata.id"] = 16210fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 1622f86bb901SAdriana Kobylak std::to_string(*id); 16237e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Name"] = 16247e860f15SJohn Edward Broadbent "System Event Log Entry"; 1625f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Id"] = std::to_string(*id); 1626f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Message"] = *message; 1627f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Resolved"] = resolved; 1628f86bb901SAdriana Kobylak asyncResp->res.jsonValue["EntryType"] = "Event"; 1629f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Severity"] = 1630f86bb901SAdriana Kobylak translateSeverityDbusToRedfish(*severity); 1631f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Created"] = 1632f86bb901SAdriana Kobylak crow::utility::getDateTime(timestamp); 1633f86bb901SAdriana Kobylak asyncResp->res.jsonValue["Modified"] = 1634f86bb901SAdriana Kobylak crow::utility::getDateTime(updateTimestamp); 1635f86bb901SAdriana Kobylak if (filePath != nullptr) 1636f86bb901SAdriana Kobylak { 1637f86bb901SAdriana Kobylak asyncResp->res.jsonValue["AdditionalDataURI"] = 16380fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/attachment/" + 16397e860f15SJohn Edward Broadbent std::to_string(*id); 1640f86bb901SAdriana Kobylak } 1641cb92c03bSAndrew Geissler }, 1642cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging", 1643cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging/entry/" + entryID, 1644f86bb901SAdriana Kobylak "org.freedesktop.DBus.Properties", "GetAll", ""); 16457e860f15SJohn Edward Broadbent }); 1646336e96c6SChicago Duan 16477e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 16487e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1649ed398213SEd Tanous .privileges(redfish::privileges::patchLogEntry) 16507e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::patch)( 16517e860f15SJohn Edward Broadbent [](const crow::Request& req, 16527e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 16537e860f15SJohn Edward Broadbent const std::string& entryId) { 165475710de2SXiaochao Ma std::optional<bool> resolved; 165575710de2SXiaochao Ma 16567e860f15SJohn Edward Broadbent if (!json_util::readJson(req, asyncResp->res, "Resolved", 16577e860f15SJohn Edward Broadbent resolved)) 165875710de2SXiaochao Ma { 165975710de2SXiaochao Ma return; 166075710de2SXiaochao Ma } 166175710de2SXiaochao Ma BMCWEB_LOG_DEBUG << "Set Resolved"; 166275710de2SXiaochao Ma 166375710de2SXiaochao Ma crow::connections::systemBus->async_method_call( 16644f48d5f6SEd Tanous [asyncResp, entryId](const boost::system::error_code ec) { 166575710de2SXiaochao Ma if (ec) 166675710de2SXiaochao Ma { 166775710de2SXiaochao Ma BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 166875710de2SXiaochao Ma messages::internalError(asyncResp->res); 166975710de2SXiaochao Ma return; 167075710de2SXiaochao Ma } 167175710de2SXiaochao Ma }, 167275710de2SXiaochao Ma "xyz.openbmc_project.Logging", 167375710de2SXiaochao Ma "/xyz/openbmc_project/logging/entry/" + entryId, 167475710de2SXiaochao Ma "org.freedesktop.DBus.Properties", "Set", 167575710de2SXiaochao Ma "xyz.openbmc_project.Logging.Entry", "Resolved", 167675710de2SXiaochao Ma std::variant<bool>(*resolved)); 16777e860f15SJohn Edward Broadbent }); 167875710de2SXiaochao Ma 16797e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 16807e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/") 1681ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 1682ed398213SEd Tanous 16837e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::delete_)( 16847e860f15SJohn Edward Broadbent [](const crow::Request&, 16857e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 16867e860f15SJohn Edward Broadbent const std::string& param) 16877e860f15SJohn Edward Broadbent 1688336e96c6SChicago Duan { 1689336e96c6SChicago Duan BMCWEB_LOG_DEBUG << "Do delete single event entries."; 1690336e96c6SChicago Duan 16917e860f15SJohn Edward Broadbent std::string entryID = param; 1692336e96c6SChicago Duan 1693336e96c6SChicago Duan dbus::utility::escapePathForDbus(entryID); 1694336e96c6SChicago Duan 1695336e96c6SChicago Duan // Process response from Logging service. 16967e860f15SJohn Edward Broadbent auto respHandler = [asyncResp, entryID]( 16977e860f15SJohn Edward Broadbent const boost::system::error_code ec) { 16987e860f15SJohn Edward Broadbent BMCWEB_LOG_DEBUG 16997e860f15SJohn Edward Broadbent << "EventLogEntry (DBus) doDelete callback: Done"; 1700336e96c6SChicago Duan if (ec) 1701336e96c6SChicago Duan { 17023de8d8baSGeorge Liu if (ec.value() == EBADR) 17033de8d8baSGeorge Liu { 17047e860f15SJohn Edward Broadbent messages::resourceNotFound(asyncResp->res, 17057e860f15SJohn Edward Broadbent "LogEntry", entryID); 17063de8d8baSGeorge Liu return; 17073de8d8baSGeorge Liu } 1708336e96c6SChicago Duan // TODO Handle for specific error code 17090fda0f12SGeorge Liu BMCWEB_LOG_ERROR 17100fda0f12SGeorge Liu << "EventLogEntry (DBus) doDelete respHandler got error " 1711336e96c6SChicago Duan << ec; 1712336e96c6SChicago Duan asyncResp->res.result( 1713336e96c6SChicago Duan boost::beast::http::status::internal_server_error); 1714336e96c6SChicago Duan return; 1715336e96c6SChicago Duan } 1716336e96c6SChicago Duan 1717336e96c6SChicago Duan asyncResp->res.result(boost::beast::http::status::ok); 1718336e96c6SChicago Duan }; 1719336e96c6SChicago Duan 1720336e96c6SChicago Duan // Make call to Logging service to request Delete Log 1721336e96c6SChicago Duan crow::connections::systemBus->async_method_call( 1722336e96c6SChicago Duan respHandler, "xyz.openbmc_project.Logging", 1723336e96c6SChicago Duan "/xyz/openbmc_project/logging/entry/" + entryID, 1724336e96c6SChicago Duan "xyz.openbmc_project.Object.Delete", "Delete"); 17257e860f15SJohn Edward Broadbent }); 1726400fd1fbSAdriana Kobylak } 1727400fd1fbSAdriana Kobylak 17287e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryDownload(App& app) 1729400fd1fbSAdriana Kobylak { 17300fda0f12SGeorge Liu BMCWEB_ROUTE( 17310fda0f12SGeorge Liu app, 17320fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/attachment") 1733ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 17347e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 17357e860f15SJohn Edward Broadbent [](const crow::Request& req, 17367e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 17377e860f15SJohn Edward Broadbent const std::string& param) 1738400fd1fbSAdriana Kobylak 17397e860f15SJohn Edward Broadbent { 1740647b3cdcSGeorge Liu if (!http_helpers::isOctetAccepted( 1741647b3cdcSGeorge Liu req.getHeaderValue("Accept"))) 1742400fd1fbSAdriana Kobylak { 17437e860f15SJohn Edward Broadbent asyncResp->res.result( 17447e860f15SJohn Edward Broadbent boost::beast::http::status::bad_request); 1745400fd1fbSAdriana Kobylak return; 1746400fd1fbSAdriana Kobylak } 1747400fd1fbSAdriana Kobylak 17487e860f15SJohn Edward Broadbent std::string entryID = param; 1749400fd1fbSAdriana Kobylak dbus::utility::escapePathForDbus(entryID); 1750400fd1fbSAdriana Kobylak 1751400fd1fbSAdriana Kobylak crow::connections::systemBus->async_method_call( 17527e860f15SJohn Edward Broadbent [asyncResp, 17537e860f15SJohn Edward Broadbent entryID](const boost::system::error_code ec, 1754400fd1fbSAdriana Kobylak const sdbusplus::message::unix_fd& unixfd) { 1755400fd1fbSAdriana Kobylak if (ec.value() == EBADR) 1756400fd1fbSAdriana Kobylak { 17577e860f15SJohn Edward Broadbent messages::resourceNotFound( 17587e860f15SJohn Edward Broadbent asyncResp->res, "EventLogAttachment", entryID); 1759400fd1fbSAdriana Kobylak return; 1760400fd1fbSAdriana Kobylak } 1761400fd1fbSAdriana Kobylak if (ec) 1762400fd1fbSAdriana Kobylak { 1763400fd1fbSAdriana Kobylak BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 1764400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1765400fd1fbSAdriana Kobylak return; 1766400fd1fbSAdriana Kobylak } 1767400fd1fbSAdriana Kobylak 1768400fd1fbSAdriana Kobylak int fd = -1; 1769400fd1fbSAdriana Kobylak fd = dup(unixfd); 1770400fd1fbSAdriana Kobylak if (fd == -1) 1771400fd1fbSAdriana Kobylak { 1772400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1773400fd1fbSAdriana Kobylak return; 1774400fd1fbSAdriana Kobylak } 1775400fd1fbSAdriana Kobylak 1776400fd1fbSAdriana Kobylak long long int size = lseek(fd, 0, SEEK_END); 1777400fd1fbSAdriana Kobylak if (size == -1) 1778400fd1fbSAdriana Kobylak { 1779400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1780400fd1fbSAdriana Kobylak return; 1781400fd1fbSAdriana Kobylak } 1782400fd1fbSAdriana Kobylak 1783400fd1fbSAdriana Kobylak // Arbitrary max size of 64kb 1784400fd1fbSAdriana Kobylak constexpr int maxFileSize = 65536; 1785400fd1fbSAdriana Kobylak if (size > maxFileSize) 1786400fd1fbSAdriana Kobylak { 1787400fd1fbSAdriana Kobylak BMCWEB_LOG_ERROR 1788400fd1fbSAdriana Kobylak << "File size exceeds maximum allowed size of " 1789400fd1fbSAdriana Kobylak << maxFileSize; 1790400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1791400fd1fbSAdriana Kobylak return; 1792400fd1fbSAdriana Kobylak } 1793400fd1fbSAdriana Kobylak std::vector<char> data(static_cast<size_t>(size)); 1794400fd1fbSAdriana Kobylak long long int rc = lseek(fd, 0, SEEK_SET); 1795400fd1fbSAdriana Kobylak if (rc == -1) 1796400fd1fbSAdriana Kobylak { 1797400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1798400fd1fbSAdriana Kobylak return; 1799400fd1fbSAdriana Kobylak } 1800400fd1fbSAdriana Kobylak rc = read(fd, data.data(), data.size()); 1801400fd1fbSAdriana Kobylak if ((rc == -1) || (rc != size)) 1802400fd1fbSAdriana Kobylak { 1803400fd1fbSAdriana Kobylak messages::internalError(asyncResp->res); 1804400fd1fbSAdriana Kobylak return; 1805400fd1fbSAdriana Kobylak } 1806400fd1fbSAdriana Kobylak close(fd); 1807400fd1fbSAdriana Kobylak 1808400fd1fbSAdriana Kobylak std::string_view strData(data.data(), data.size()); 18097e860f15SJohn Edward Broadbent std::string output = 18107e860f15SJohn Edward Broadbent crow::utility::base64encode(strData); 1811400fd1fbSAdriana Kobylak 1812400fd1fbSAdriana Kobylak asyncResp->res.addHeader("Content-Type", 1813400fd1fbSAdriana Kobylak "application/octet-stream"); 18147e860f15SJohn Edward Broadbent asyncResp->res.addHeader("Content-Transfer-Encoding", 18157e860f15SJohn Edward Broadbent "Base64"); 1816400fd1fbSAdriana Kobylak asyncResp->res.body() = std::move(output); 1817400fd1fbSAdriana Kobylak }, 1818400fd1fbSAdriana Kobylak "xyz.openbmc_project.Logging", 1819400fd1fbSAdriana Kobylak "/xyz/openbmc_project/logging/entry/" + entryID, 1820400fd1fbSAdriana Kobylak "xyz.openbmc_project.Logging.Entry", "GetEntry"); 18217e860f15SJohn Edward Broadbent }); 18221da66f75SEd Tanous } 18231da66f75SEd Tanous 1824b7028ebfSSpencer Ku constexpr const char* hostLoggerFolderPath = "/var/log/console"; 1825b7028ebfSSpencer Ku 1826b7028ebfSSpencer Ku inline bool 1827b7028ebfSSpencer Ku getHostLoggerFiles(const std::string& hostLoggerFilePath, 1828b7028ebfSSpencer Ku std::vector<std::filesystem::path>& hostLoggerFiles) 1829b7028ebfSSpencer Ku { 1830b7028ebfSSpencer Ku std::error_code ec; 1831b7028ebfSSpencer Ku std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec); 1832b7028ebfSSpencer Ku if (ec) 1833b7028ebfSSpencer Ku { 1834b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << ec.message(); 1835b7028ebfSSpencer Ku return false; 1836b7028ebfSSpencer Ku } 1837b7028ebfSSpencer Ku for (const std::filesystem::directory_entry& it : logPath) 1838b7028ebfSSpencer Ku { 1839b7028ebfSSpencer Ku std::string filename = it.path().filename(); 1840b7028ebfSSpencer Ku // Prefix of each log files is "log". Find the file and save the 1841b7028ebfSSpencer Ku // path 1842b7028ebfSSpencer Ku if (boost::starts_with(filename, "log")) 1843b7028ebfSSpencer Ku { 1844b7028ebfSSpencer Ku hostLoggerFiles.emplace_back(it.path()); 1845b7028ebfSSpencer Ku } 1846b7028ebfSSpencer Ku } 1847b7028ebfSSpencer Ku // As the log files rotate, they are appended with a ".#" that is higher for 1848b7028ebfSSpencer Ku // the older logs. Since we start from oldest logs, sort the name in 1849b7028ebfSSpencer Ku // descending order. 1850b7028ebfSSpencer Ku std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(), 1851b7028ebfSSpencer Ku AlphanumLess<std::string>()); 1852b7028ebfSSpencer Ku 1853b7028ebfSSpencer Ku return true; 1854b7028ebfSSpencer Ku } 1855b7028ebfSSpencer Ku 1856b7028ebfSSpencer Ku inline bool 1857b7028ebfSSpencer Ku getHostLoggerEntries(std::vector<std::filesystem::path>& hostLoggerFiles, 1858b7028ebfSSpencer Ku uint64_t& skip, uint64_t& top, 1859b7028ebfSSpencer Ku std::vector<std::string>& logEntries, size_t& logCount) 1860b7028ebfSSpencer Ku { 1861b7028ebfSSpencer Ku GzFileReader logFile; 1862b7028ebfSSpencer Ku 1863b7028ebfSSpencer Ku // Go though all log files and expose host logs. 1864b7028ebfSSpencer Ku for (const std::filesystem::path& it : hostLoggerFiles) 1865b7028ebfSSpencer Ku { 1866b7028ebfSSpencer Ku if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount)) 1867b7028ebfSSpencer Ku { 1868b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << "fail to expose host logs"; 1869b7028ebfSSpencer Ku return false; 1870b7028ebfSSpencer Ku } 1871b7028ebfSSpencer Ku } 1872b7028ebfSSpencer Ku // Get lastMessage from constructor by getter 1873b7028ebfSSpencer Ku std::string lastMessage = logFile.getLastMessage(); 1874b7028ebfSSpencer Ku if (!lastMessage.empty()) 1875b7028ebfSSpencer Ku { 1876b7028ebfSSpencer Ku logCount++; 1877b7028ebfSSpencer Ku if (logCount > skip && logCount <= (skip + top)) 1878b7028ebfSSpencer Ku { 1879b7028ebfSSpencer Ku logEntries.push_back(lastMessage); 1880b7028ebfSSpencer Ku } 1881b7028ebfSSpencer Ku } 1882b7028ebfSSpencer Ku return true; 1883b7028ebfSSpencer Ku } 1884b7028ebfSSpencer Ku 1885b7028ebfSSpencer Ku inline void fillHostLoggerEntryJson(const std::string& logEntryID, 1886b7028ebfSSpencer Ku const std::string& msg, 1887b7028ebfSSpencer Ku nlohmann::json& logEntryJson) 1888b7028ebfSSpencer Ku { 1889b7028ebfSSpencer Ku // Fill in the log entry with the gathered data. 1890b7028ebfSSpencer Ku logEntryJson = { 1891b7028ebfSSpencer Ku {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 1892b7028ebfSSpencer Ku {"@odata.id", 1893b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/" + 1894b7028ebfSSpencer Ku logEntryID}, 1895b7028ebfSSpencer Ku {"Name", "Host Logger Entry"}, 1896b7028ebfSSpencer Ku {"Id", logEntryID}, 1897b7028ebfSSpencer Ku {"Message", msg}, 1898b7028ebfSSpencer Ku {"EntryType", "Oem"}, 1899b7028ebfSSpencer Ku {"Severity", "OK"}, 1900b7028ebfSSpencer Ku {"OemRecordFormat", "Host Logger Entry"}}; 1901b7028ebfSSpencer Ku } 1902b7028ebfSSpencer Ku 1903b7028ebfSSpencer Ku inline void requestRoutesSystemHostLogger(App& app) 1904b7028ebfSSpencer Ku { 1905b7028ebfSSpencer Ku BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/HostLogger/") 1906b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogService) 19070fda0f12SGeorge Liu .methods( 19080fda0f12SGeorge Liu boost::beast::http::verb:: 19090fda0f12SGeorge Liu get)([](const crow::Request&, 1910b7028ebfSSpencer Ku const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1911b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 1912b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger"; 1913b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 1914b7028ebfSSpencer Ku "#LogService.v1_1_0.LogService"; 1915b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "Host Logger Service"; 1916b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = "Host Logger Service"; 1917b7028ebfSSpencer Ku asyncResp->res.jsonValue["Id"] = "HostLogger"; 1918b7028ebfSSpencer Ku asyncResp->res.jsonValue["Entries"] = { 19190fda0f12SGeorge Liu {"@odata.id", 19200fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"}}; 1921b7028ebfSSpencer Ku }); 1922b7028ebfSSpencer Ku } 1923b7028ebfSSpencer Ku 1924b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerCollection(App& app) 1925b7028ebfSSpencer Ku { 1926b7028ebfSSpencer Ku BMCWEB_ROUTE(app, 1927b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/") 1928b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 19290fda0f12SGeorge Liu .methods( 19300fda0f12SGeorge Liu boost::beast::http::verb:: 19310fda0f12SGeorge Liu get)([](const crow::Request& req, 1932b7028ebfSSpencer Ku const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 1933b7028ebfSSpencer Ku uint64_t skip = 0; 1934b7028ebfSSpencer Ku uint64_t top = maxEntriesPerPage; // Show max 1000 entries by 1935b7028ebfSSpencer Ku // default, allow range 1 to 1936b7028ebfSSpencer Ku // 1000 entries per page. 1937b7028ebfSSpencer Ku if (!getSkipParam(asyncResp, req, skip)) 1938b7028ebfSSpencer Ku { 1939b7028ebfSSpencer Ku return; 1940b7028ebfSSpencer Ku } 1941b7028ebfSSpencer Ku if (!getTopParam(asyncResp, req, top)) 1942b7028ebfSSpencer Ku { 1943b7028ebfSSpencer Ku return; 1944b7028ebfSSpencer Ku } 1945b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.id"] = 1946b7028ebfSSpencer Ku "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"; 1947b7028ebfSSpencer Ku asyncResp->res.jsonValue["@odata.type"] = 1948b7028ebfSSpencer Ku "#LogEntryCollection.LogEntryCollection"; 1949b7028ebfSSpencer Ku asyncResp->res.jsonValue["Name"] = "HostLogger Entries"; 1950b7028ebfSSpencer Ku asyncResp->res.jsonValue["Description"] = 1951b7028ebfSSpencer Ku "Collection of HostLogger Entries"; 19520fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1953b7028ebfSSpencer Ku logEntryArray = nlohmann::json::array(); 1954b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = 0; 1955b7028ebfSSpencer Ku 1956b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 1957b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 1958b7028ebfSSpencer Ku { 1959b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << "fail to get host log file path"; 1960b7028ebfSSpencer Ku return; 1961b7028ebfSSpencer Ku } 1962b7028ebfSSpencer Ku 1963b7028ebfSSpencer Ku size_t logCount = 0; 1964b7028ebfSSpencer Ku // This vector only store the entries we want to expose that 1965b7028ebfSSpencer Ku // control by skip and top. 1966b7028ebfSSpencer Ku std::vector<std::string> logEntries; 19670fda0f12SGeorge Liu if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries, 19680fda0f12SGeorge Liu logCount)) 1969b7028ebfSSpencer Ku { 1970b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 1971b7028ebfSSpencer Ku return; 1972b7028ebfSSpencer Ku } 1973b7028ebfSSpencer Ku // If vector is empty, that means skip value larger than total 1974b7028ebfSSpencer Ku // log count 1975b7028ebfSSpencer Ku if (logEntries.size() == 0) 1976b7028ebfSSpencer Ku { 1977b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 1978b7028ebfSSpencer Ku return; 1979b7028ebfSSpencer Ku } 1980b7028ebfSSpencer Ku if (logEntries.size() > 0) 1981b7028ebfSSpencer Ku { 1982b7028ebfSSpencer Ku for (size_t i = 0; i < logEntries.size(); i++) 1983b7028ebfSSpencer Ku { 1984b7028ebfSSpencer Ku logEntryArray.push_back({}); 1985b7028ebfSSpencer Ku nlohmann::json& hostLogEntry = logEntryArray.back(); 1986b7028ebfSSpencer Ku fillHostLoggerEntryJson(std::to_string(skip + i), 1987b7028ebfSSpencer Ku logEntries[i], hostLogEntry); 1988b7028ebfSSpencer Ku } 1989b7028ebfSSpencer Ku 1990b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.count"] = logCount; 1991b7028ebfSSpencer Ku if (skip + top < logCount) 1992b7028ebfSSpencer Ku { 1993b7028ebfSSpencer Ku asyncResp->res.jsonValue["Members@odata.nextLink"] = 19940fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/HostLogger/Entries?$skip=" + 1995b7028ebfSSpencer Ku std::to_string(skip + top); 1996b7028ebfSSpencer Ku } 1997b7028ebfSSpencer Ku } 1998b7028ebfSSpencer Ku }); 1999b7028ebfSSpencer Ku } 2000b7028ebfSSpencer Ku 2001b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerLogEntry(App& app) 2002b7028ebfSSpencer Ku { 2003b7028ebfSSpencer Ku BMCWEB_ROUTE( 2004b7028ebfSSpencer Ku app, "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/<str>/") 2005b7028ebfSSpencer Ku .privileges(redfish::privileges::getLogEntry) 2006b7028ebfSSpencer Ku .methods(boost::beast::http::verb::get)( 2007b7028ebfSSpencer Ku [](const crow::Request&, 2008b7028ebfSSpencer Ku const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2009b7028ebfSSpencer Ku const std::string& param) { 2010b7028ebfSSpencer Ku const std::string& targetID = param; 2011b7028ebfSSpencer Ku 2012b7028ebfSSpencer Ku uint64_t idInt = 0; 2013b7028ebfSSpencer Ku auto [ptr, ec] = std::from_chars( 2014b7028ebfSSpencer Ku targetID.data(), targetID.data() + targetID.size(), idInt); 2015b7028ebfSSpencer Ku if (ec == std::errc::invalid_argument) 2016b7028ebfSSpencer Ku { 2017b7028ebfSSpencer Ku messages::resourceMissingAtURI(asyncResp->res, targetID); 2018b7028ebfSSpencer Ku return; 2019b7028ebfSSpencer Ku } 2020b7028ebfSSpencer Ku if (ec == std::errc::result_out_of_range) 2021b7028ebfSSpencer Ku { 2022b7028ebfSSpencer Ku messages::resourceMissingAtURI(asyncResp->res, targetID); 2023b7028ebfSSpencer Ku return; 2024b7028ebfSSpencer Ku } 2025b7028ebfSSpencer Ku 2026b7028ebfSSpencer Ku std::vector<std::filesystem::path> hostLoggerFiles; 2027b7028ebfSSpencer Ku if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles)) 2028b7028ebfSSpencer Ku { 2029b7028ebfSSpencer Ku BMCWEB_LOG_ERROR << "fail to get host log file path"; 2030b7028ebfSSpencer Ku return; 2031b7028ebfSSpencer Ku } 2032b7028ebfSSpencer Ku 2033b7028ebfSSpencer Ku size_t logCount = 0; 2034b7028ebfSSpencer Ku uint64_t top = 1; 2035b7028ebfSSpencer Ku std::vector<std::string> logEntries; 2036b7028ebfSSpencer Ku // We can get specific entry by skip and top. For example, if we 2037b7028ebfSSpencer Ku // want to get nth entry, we can set skip = n-1 and top = 1 to 2038b7028ebfSSpencer Ku // get that entry 2039b7028ebfSSpencer Ku if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, 2040b7028ebfSSpencer Ku logEntries, logCount)) 2041b7028ebfSSpencer Ku { 2042b7028ebfSSpencer Ku messages::internalError(asyncResp->res); 2043b7028ebfSSpencer Ku return; 2044b7028ebfSSpencer Ku } 2045b7028ebfSSpencer Ku 2046b7028ebfSSpencer Ku if (!logEntries.empty()) 2047b7028ebfSSpencer Ku { 2048b7028ebfSSpencer Ku fillHostLoggerEntryJson(targetID, logEntries[0], 2049b7028ebfSSpencer Ku asyncResp->res.jsonValue); 2050b7028ebfSSpencer Ku return; 2051b7028ebfSSpencer Ku } 2052b7028ebfSSpencer Ku 2053b7028ebfSSpencer Ku // Requested ID was not found 2054b7028ebfSSpencer Ku messages::resourceMissingAtURI(asyncResp->res, targetID); 2055b7028ebfSSpencer Ku }); 2056b7028ebfSSpencer Ku } 2057b7028ebfSSpencer Ku 20587e860f15SJohn Edward Broadbent inline void requestRoutesBMCLogServiceCollection(App& app) 20591da66f75SEd Tanous { 20607e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/") 2061ad89dcf0SGunnar Mills .privileges(redfish::privileges::getLogServiceCollection) 20627e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 20637e860f15SJohn Edward Broadbent [](const crow::Request&, 20647e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 20657e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 20667e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2067e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 20681da66f75SEd Tanous "#LogServiceCollection.LogServiceCollection"; 2069e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 2070e1f26343SJason M. Bills "/redfish/v1/Managers/bmc/LogServices"; 20717e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Name"] = 20727e860f15SJohn Edward Broadbent "Open BMC Log Services Collection"; 2073e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 20741da66f75SEd Tanous "Collection of LogServices for this Manager"; 20757e860f15SJohn Edward Broadbent nlohmann::json& logServiceArray = 20767e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members"]; 2077c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 20785cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 20795cb1dd27SAsmitha Karunanithi logServiceArray.push_back( 20807e860f15SJohn Edward Broadbent {{"@odata.id", 20817e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump"}}); 20825cb1dd27SAsmitha Karunanithi #endif 2083c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL 2084c4bf6374SJason M. Bills logServiceArray.push_back( 20857e860f15SJohn Edward Broadbent {{"@odata.id", 20867e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Journal"}}); 2087c4bf6374SJason M. Bills #endif 2088e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 2089c4bf6374SJason M. Bills logServiceArray.size(); 20907e860f15SJohn Edward Broadbent }); 2091e1f26343SJason M. Bills } 2092e1f26343SJason M. Bills 20937e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogService(App& app) 2094e1f26343SJason M. Bills { 20957e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/") 2096ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 20977e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 20987e860f15SJohn Edward Broadbent [](const crow::Request&, 20997e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 21008d1b46d7Szhanghch05 21017e860f15SJohn Edward Broadbent { 2102e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2103e1f26343SJason M. Bills "#LogService.v1_1_0.LogService"; 21040f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 21050f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal"; 21067e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Name"] = 21077e860f15SJohn Edward Broadbent "Open BMC Journal Log Service"; 21087e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Description"] = 21097e860f15SJohn Edward Broadbent "BMC Journal Log Service"; 2110c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "BMC Journal"; 2111e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 21127c8c4058STejas Patil 21137c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 21147c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 21157c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = 21167c8c4058STejas Patil redfishDateTimeOffset.first; 21177c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 21187c8c4058STejas Patil redfishDateTimeOffset.second; 21197c8c4058STejas Patil 2120cd50aa42SJason M. Bills asyncResp->res.jsonValue["Entries"] = { 2121cd50aa42SJason M. Bills {"@odata.id", 2122086be238SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}}; 21237e860f15SJohn Edward Broadbent }); 2124e1f26343SJason M. Bills } 2125e1f26343SJason M. Bills 2126c4bf6374SJason M. Bills static int fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID, 2127e1f26343SJason M. Bills sd_journal* journal, 2128c4bf6374SJason M. Bills nlohmann::json& bmcJournalLogEntryJson) 2129e1f26343SJason M. Bills { 2130e1f26343SJason M. Bills // Get the Log Entry contents 2131e1f26343SJason M. Bills int ret = 0; 2132e1f26343SJason M. Bills 2133a8fe54f0SJason M. Bills std::string message; 2134a8fe54f0SJason M. Bills std::string_view syslogID; 2135a8fe54f0SJason M. Bills ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID); 2136a8fe54f0SJason M. Bills if (ret < 0) 2137a8fe54f0SJason M. Bills { 2138a8fe54f0SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read SYSLOG_IDENTIFIER field: " 2139a8fe54f0SJason M. Bills << strerror(-ret); 2140a8fe54f0SJason M. Bills } 2141a8fe54f0SJason M. Bills if (!syslogID.empty()) 2142a8fe54f0SJason M. Bills { 2143a8fe54f0SJason M. Bills message += std::string(syslogID) + ": "; 2144a8fe54f0SJason M. Bills } 2145a8fe54f0SJason M. Bills 214639e77504SEd Tanous std::string_view msg; 214716428a1aSJason M. Bills ret = getJournalMetadata(journal, "MESSAGE", msg); 2148e1f26343SJason M. Bills if (ret < 0) 2149e1f26343SJason M. Bills { 2150e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret); 2151e1f26343SJason M. Bills return 1; 2152e1f26343SJason M. Bills } 2153a8fe54f0SJason M. Bills message += std::string(msg); 2154e1f26343SJason M. Bills 2155e1f26343SJason M. Bills // Get the severity from the PRIORITY field 2156271584abSEd Tanous long int severity = 8; // Default to an invalid priority 215716428a1aSJason M. Bills ret = getJournalMetadata(journal, "PRIORITY", 10, severity); 2158e1f26343SJason M. Bills if (ret < 0) 2159e1f26343SJason M. Bills { 2160e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret); 2161e1f26343SJason M. Bills } 2162e1f26343SJason M. Bills 2163e1f26343SJason M. Bills // Get the Created time from the timestamp 216416428a1aSJason M. Bills std::string entryTimeStr; 216516428a1aSJason M. Bills if (!getEntryTimestamp(journal, entryTimeStr)) 2166e1f26343SJason M. Bills { 216716428a1aSJason M. Bills return 1; 2168e1f26343SJason M. Bills } 2169e1f26343SJason M. Bills 2170e1f26343SJason M. Bills // Fill in the log entry with the gathered data 2171c4bf6374SJason M. Bills bmcJournalLogEntryJson = { 2172647b3cdcSGeorge Liu {"@odata.type", "#LogEntry.v1_8_0.LogEntry"}, 2173c4bf6374SJason M. Bills {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" + 2174c4bf6374SJason M. Bills bmcJournalLogEntryID}, 2175e1f26343SJason M. Bills {"Name", "BMC Journal Entry"}, 2176c4bf6374SJason M. Bills {"Id", bmcJournalLogEntryID}, 2177a8fe54f0SJason M. Bills {"Message", std::move(message)}, 2178e1f26343SJason M. Bills {"EntryType", "Oem"}, 2179738c1e61SPatrick Williams {"Severity", severity <= 2 ? "Critical" 2180738c1e61SPatrick Williams : severity <= 4 ? "Warning" 2181738c1e61SPatrick Williams : "OK"}, 2182086be238SEd Tanous {"OemRecordFormat", "BMC Journal Entry"}, 2183e1f26343SJason M. Bills {"Created", std::move(entryTimeStr)}}; 2184e1f26343SJason M. Bills return 0; 2185e1f26343SJason M. Bills } 2186e1f26343SJason M. Bills 21877e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntryCollection(App& app) 2188e1f26343SJason M. Bills { 21897e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/") 2190ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 21910fda0f12SGeorge Liu .methods( 21920fda0f12SGeorge Liu boost::beast::http::verb:: 21930fda0f12SGeorge Liu get)([](const crow::Request& req, 21947e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2195193ad2faSJason M. Bills static constexpr const long maxEntriesPerPage = 1000; 2196271584abSEd Tanous uint64_t skip = 0; 2197271584abSEd Tanous uint64_t top = maxEntriesPerPage; // Show max entries by default 21988d1b46d7Szhanghch05 if (!getSkipParam(asyncResp, req, skip)) 2199193ad2faSJason M. Bills { 2200193ad2faSJason M. Bills return; 2201193ad2faSJason M. Bills } 22028d1b46d7Szhanghch05 if (!getTopParam(asyncResp, req, top)) 2203193ad2faSJason M. Bills { 2204193ad2faSJason M. Bills return; 2205193ad2faSJason M. Bills } 22067e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 22077e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2208e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2209e1f26343SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 22100f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 22110f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 2212e1f26343SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries"; 2213e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2214e1f26343SJason M. Bills "Collection of BMC Journal Entries"; 22150fda0f12SGeorge Liu nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2216e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 2217e1f26343SJason M. Bills 22187e860f15SJohn Edward Broadbent // Go through the journal and use the timestamp to create a 22197e860f15SJohn Edward Broadbent // unique ID for each entry 2220e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2221e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2222e1f26343SJason M. Bills if (ret < 0) 2223e1f26343SJason M. Bills { 22247e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR << "failed to open journal: " 22257e860f15SJohn Edward Broadbent << strerror(-ret); 2226f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2227e1f26343SJason M. Bills return; 2228e1f26343SJason M. Bills } 22290fda0f12SGeorge Liu std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 22300fda0f12SGeorge Liu journalTmp, sd_journal_close); 2231e1f26343SJason M. Bills journalTmp = nullptr; 2232b01bf299SEd Tanous uint64_t entryCount = 0; 2233e85d6b16SJason M. Bills // Reset the unique ID on the first entry 2234e85d6b16SJason M. Bills bool firstEntry = true; 2235e1f26343SJason M. Bills SD_JOURNAL_FOREACH(journal.get()) 2236e1f26343SJason M. Bills { 2237193ad2faSJason M. Bills entryCount++; 22387e860f15SJohn Edward Broadbent // Handle paging using skip (number of entries to skip from 22397e860f15SJohn Edward Broadbent // the start) and top (number of entries to display) 2240193ad2faSJason M. Bills if (entryCount <= skip || entryCount > skip + top) 2241193ad2faSJason M. Bills { 2242193ad2faSJason M. Bills continue; 2243193ad2faSJason M. Bills } 2244193ad2faSJason M. Bills 224516428a1aSJason M. Bills std::string idStr; 2246e85d6b16SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2247e1f26343SJason M. Bills { 2248e1f26343SJason M. Bills continue; 2249e1f26343SJason M. Bills } 2250e1f26343SJason M. Bills 2251e85d6b16SJason M. Bills if (firstEntry) 2252e85d6b16SJason M. Bills { 2253e85d6b16SJason M. Bills firstEntry = false; 2254e85d6b16SJason M. Bills } 2255e85d6b16SJason M. Bills 2256e1f26343SJason M. Bills logEntryArray.push_back({}); 2257c4bf6374SJason M. Bills nlohmann::json& bmcJournalLogEntry = logEntryArray.back(); 2258c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(idStr, journal.get(), 2259c4bf6374SJason M. Bills bmcJournalLogEntry) != 0) 2260e1f26343SJason M. Bills { 2261f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2262e1f26343SJason M. Bills return; 2263e1f26343SJason M. Bills } 2264e1f26343SJason M. Bills } 2265193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 2266193ad2faSJason M. Bills if (skip + top < entryCount) 2267193ad2faSJason M. Bills { 2268193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 22690fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" + 2270193ad2faSJason M. Bills std::to_string(skip + top); 2271193ad2faSJason M. Bills } 22727e860f15SJohn Edward Broadbent }); 2273e1f26343SJason M. Bills } 2274e1f26343SJason M. Bills 22757e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntry(App& app) 2276e1f26343SJason M. Bills { 22777e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 22787e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/") 2279ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 22807e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 22817e860f15SJohn Edward Broadbent [](const crow::Request&, 22827e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 22837e860f15SJohn Edward Broadbent const std::string& entryID) { 2284e1f26343SJason M. Bills // Convert the unique ID back to a timestamp to find the entry 2285e1f26343SJason M. Bills uint64_t ts = 0; 2286271584abSEd Tanous uint64_t index = 0; 22878d1b46d7Szhanghch05 if (!getTimestampFromID(asyncResp, entryID, ts, index)) 2288e1f26343SJason M. Bills { 228916428a1aSJason M. Bills return; 2290e1f26343SJason M. Bills } 2291e1f26343SJason M. Bills 2292e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 2293e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 2294e1f26343SJason M. Bills if (ret < 0) 2295e1f26343SJason M. Bills { 22967e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR << "failed to open journal: " 22977e860f15SJohn Edward Broadbent << strerror(-ret); 2298f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2299e1f26343SJason M. Bills return; 2300e1f26343SJason M. Bills } 23017e860f15SJohn Edward Broadbent std::unique_ptr<sd_journal, decltype(&sd_journal_close)> 23027e860f15SJohn Edward Broadbent journal(journalTmp, sd_journal_close); 2303e1f26343SJason M. Bills journalTmp = nullptr; 23047e860f15SJohn Edward Broadbent // Go to the timestamp in the log and move to the entry at the 23057e860f15SJohn Edward Broadbent // index tracking the unique ID 2306af07e3f5SJason M. Bills std::string idStr; 2307af07e3f5SJason M. Bills bool firstEntry = true; 2308e1f26343SJason M. Bills ret = sd_journal_seek_realtime_usec(journal.get(), ts); 23092056b6d1SManojkiran Eda if (ret < 0) 23102056b6d1SManojkiran Eda { 23112056b6d1SManojkiran Eda BMCWEB_LOG_ERROR << "failed to seek to an entry in journal" 23122056b6d1SManojkiran Eda << strerror(-ret); 23132056b6d1SManojkiran Eda messages::internalError(asyncResp->res); 23142056b6d1SManojkiran Eda return; 23152056b6d1SManojkiran Eda } 2316271584abSEd Tanous for (uint64_t i = 0; i <= index; i++) 2317e1f26343SJason M. Bills { 2318e1f26343SJason M. Bills sd_journal_next(journal.get()); 2319af07e3f5SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 2320af07e3f5SJason M. Bills { 2321af07e3f5SJason M. Bills messages::internalError(asyncResp->res); 2322af07e3f5SJason M. Bills return; 2323af07e3f5SJason M. Bills } 2324af07e3f5SJason M. Bills if (firstEntry) 2325af07e3f5SJason M. Bills { 2326af07e3f5SJason M. Bills firstEntry = false; 2327af07e3f5SJason M. Bills } 2328e1f26343SJason M. Bills } 2329c4bf6374SJason M. Bills // Confirm that the entry ID matches what was requested 2330af07e3f5SJason M. Bills if (idStr != entryID) 2331c4bf6374SJason M. Bills { 2332c4bf6374SJason M. Bills messages::resourceMissingAtURI(asyncResp->res, entryID); 2333c4bf6374SJason M. Bills return; 2334c4bf6374SJason M. Bills } 2335c4bf6374SJason M. Bills 2336c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(entryID, journal.get(), 2337e1f26343SJason M. Bills asyncResp->res.jsonValue) != 0) 2338e1f26343SJason M. Bills { 2339f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2340e1f26343SJason M. Bills return; 2341e1f26343SJason M. Bills } 23427e860f15SJohn Edward Broadbent }); 2343c9bb6861Sraviteja-b } 2344c9bb6861Sraviteja-b 23457e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpService(App& app) 2346c9bb6861Sraviteja-b { 23477e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/") 2348ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 23490fda0f12SGeorge Liu .methods( 23500fda0f12SGeorge Liu boost::beast::http::verb:: 23510fda0f12SGeorge Liu get)([](const crow::Request&, 23527e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2353c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.id"] = 23545cb1dd27SAsmitha Karunanithi "/redfish/v1/Managers/bmc/LogServices/Dump"; 2355c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.type"] = 2356d337bb72SAsmitha Karunanithi "#LogService.v1_2_0.LogService"; 2357c9bb6861Sraviteja-b asyncResp->res.jsonValue["Name"] = "Dump LogService"; 23585cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Description"] = "BMC Dump LogService"; 23595cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = "Dump"; 2360c9bb6861Sraviteja-b asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 23617c8c4058STejas Patil 23627c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 23637c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 23640fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 23657c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 23667c8c4058STejas Patil redfishDateTimeOffset.second; 23677c8c4058STejas Patil 2368c9bb6861Sraviteja-b asyncResp->res.jsonValue["Entries"] = { 23697e860f15SJohn Edward Broadbent {"@odata.id", 23707e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"}}; 23715cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Actions"] = { 23725cb1dd27SAsmitha Karunanithi {"#LogService.ClearLog", 23730fda0f12SGeorge Liu {{"target", 23740fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog"}}}, 2375d337bb72SAsmitha Karunanithi {"#LogService.CollectDiagnosticData", 23760fda0f12SGeorge Liu {{"target", 23770fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData"}}}}; 23787e860f15SJohn Edward Broadbent }); 2379c9bb6861Sraviteja-b } 2380c9bb6861Sraviteja-b 23817e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntryCollection(App& app) 23827e860f15SJohn Edward Broadbent { 23837e860f15SJohn Edward Broadbent 2384c9bb6861Sraviteja-b /** 2385c9bb6861Sraviteja-b * Functions triggers appropriate requests on DBus 2386c9bb6861Sraviteja-b */ 23877e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/") 2388ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 23897e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 23907e860f15SJohn Edward Broadbent [](const crow::Request&, 23917e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 2392c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.type"] = 2393c9bb6861Sraviteja-b "#LogEntryCollection.LogEntryCollection"; 2394c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.id"] = 23955cb1dd27SAsmitha Karunanithi "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"; 23965cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = "BMC Dump Entries"; 2397c9bb6861Sraviteja-b asyncResp->res.jsonValue["Description"] = 23985cb1dd27SAsmitha Karunanithi "Collection of BMC Dump Entries"; 2399c9bb6861Sraviteja-b 24005cb1dd27SAsmitha Karunanithi getDumpEntryCollection(asyncResp, "BMC"); 24017e860f15SJohn Edward Broadbent }); 2402c9bb6861Sraviteja-b } 2403c9bb6861Sraviteja-b 24047e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app) 2405c9bb6861Sraviteja-b { 24067e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 24077e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2408ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 24097e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 24107e860f15SJohn Edward Broadbent [](const crow::Request&, 24117e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 24127e860f15SJohn Edward Broadbent const std::string& param) { 24137e860f15SJohn Edward Broadbent getDumpEntryById(asyncResp, param, "BMC"); 24147e860f15SJohn Edward Broadbent }); 24157e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 24167e860f15SJohn Edward Broadbent "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/") 2417ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 24187e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::delete_)( 24197e860f15SJohn Edward Broadbent [](const crow::Request&, 24207e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 24217e860f15SJohn Edward Broadbent const std::string& param) { 24227e860f15SJohn Edward Broadbent deleteDumpEntry(asyncResp, param, "bmc"); 24237e860f15SJohn Edward Broadbent }); 2424c9bb6861Sraviteja-b } 2425c9bb6861Sraviteja-b 24267e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app) 2427c9bb6861Sraviteja-b { 24288d1b46d7Szhanghch05 24290fda0f12SGeorge Liu BMCWEB_ROUTE( 24300fda0f12SGeorge Liu app, 24310fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2432ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 24337e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 24347e860f15SJohn Edward Broadbent [](const crow::Request& req, 24357e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 24368d1b46d7Szhanghch05 createDump(asyncResp, req, "BMC"); 24377e860f15SJohn Edward Broadbent }); 2438a43be80fSAsmitha Karunanithi } 2439a43be80fSAsmitha Karunanithi 24407e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app) 244180319af1SAsmitha Karunanithi { 24420fda0f12SGeorge Liu BMCWEB_ROUTE( 24430fda0f12SGeorge Liu app, 24440fda0f12SGeorge Liu "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog/") 2445ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 24467e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 24477e860f15SJohn Edward Broadbent [](const crow::Request&, 24487e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 24498d1b46d7Szhanghch05 clearDump(asyncResp, "BMC"); 24507e860f15SJohn Edward Broadbent }); 24515cb1dd27SAsmitha Karunanithi } 24525cb1dd27SAsmitha Karunanithi 24537e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app) 24545cb1dd27SAsmitha Karunanithi { 24557e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/") 2456ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 24577e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 24587e860f15SJohn Edward Broadbent [](const crow::Request&, 24597e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 24605cb1dd27SAsmitha Karunanithi 24617e860f15SJohn Edward Broadbent { 24625cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.id"] = 24635cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump"; 24645cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 2465d337bb72SAsmitha Karunanithi "#LogService.v1_2_0.LogService"; 24665cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = "Dump LogService"; 24677e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Description"] = 24687e860f15SJohn Edward Broadbent "System Dump LogService"; 24695cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = "Dump"; 24705cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 24717c8c4058STejas Patil 24727c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 24737c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 24747c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = 24757c8c4058STejas Patil redfishDateTimeOffset.first; 24767c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 24777c8c4058STejas Patil redfishDateTimeOffset.second; 24787c8c4058STejas Patil 24795cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Entries"] = { 24805cb1dd27SAsmitha Karunanithi {"@odata.id", 24815cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump/Entries"}}; 24825cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Actions"] = { 24835cb1dd27SAsmitha Karunanithi {"#LogService.ClearLog", 24847e860f15SJohn Edward Broadbent {{"target", 24850fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog"}}}, 2486d337bb72SAsmitha Karunanithi {"#LogService.CollectDiagnosticData", 24877e860f15SJohn Edward Broadbent {{"target", 24880fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData"}}}}; 24897e860f15SJohn Edward Broadbent }); 24905cb1dd27SAsmitha Karunanithi } 24915cb1dd27SAsmitha Karunanithi 24927e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app) 24937e860f15SJohn Edward Broadbent { 24947e860f15SJohn Edward Broadbent 24955cb1dd27SAsmitha Karunanithi /** 24965cb1dd27SAsmitha Karunanithi * Functions triggers appropriate requests on DBus 24975cb1dd27SAsmitha Karunanithi */ 2498b2a3289dSAsmitha Karunanithi BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/") 2499ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 25007e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 25017e860f15SJohn Edward Broadbent [](const crow::Request&, 2502864d6a17SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 25035cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 25045cb1dd27SAsmitha Karunanithi "#LogEntryCollection.LogEntryCollection"; 25055cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.id"] = 25065cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump/Entries"; 25075cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = "System Dump Entries"; 25085cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Description"] = 25095cb1dd27SAsmitha Karunanithi "Collection of System Dump Entries"; 25105cb1dd27SAsmitha Karunanithi 25115cb1dd27SAsmitha Karunanithi getDumpEntryCollection(asyncResp, "System"); 25127e860f15SJohn Edward Broadbent }); 25135cb1dd27SAsmitha Karunanithi } 25145cb1dd27SAsmitha Karunanithi 25157e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app) 25165cb1dd27SAsmitha Karunanithi { 25177e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 2518864d6a17SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/") 2519ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 2520ed398213SEd Tanous 25217e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 25227e860f15SJohn Edward Broadbent [](const crow::Request&, 25237e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 25247e860f15SJohn Edward Broadbent const std::string& param) { 25257e860f15SJohn Edward Broadbent getDumpEntryById(asyncResp, param, "System"); 25267e860f15SJohn Edward Broadbent }); 25278d1b46d7Szhanghch05 25287e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 2529864d6a17SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/") 2530ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 25317e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::delete_)( 25327e860f15SJohn Edward Broadbent [](const crow::Request&, 25337e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 25347e860f15SJohn Edward Broadbent const std::string& param) { 25357e860f15SJohn Edward Broadbent deleteDumpEntry(asyncResp, param, "system"); 25367e860f15SJohn Edward Broadbent }); 25375cb1dd27SAsmitha Karunanithi } 2538c9bb6861Sraviteja-b 25397e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app) 2540c9bb6861Sraviteja-b { 25410fda0f12SGeorge Liu BMCWEB_ROUTE( 25420fda0f12SGeorge Liu app, 25430fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2544ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 25457e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 25467e860f15SJohn Edward Broadbent [](const crow::Request& req, 25477e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 25487e860f15SJohn Edward Broadbent 25497e860f15SJohn Edward Broadbent { createDump(asyncResp, req, "System"); }); 2550a43be80fSAsmitha Karunanithi } 2551a43be80fSAsmitha Karunanithi 25527e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app) 2553a43be80fSAsmitha Karunanithi { 25540fda0f12SGeorge Liu BMCWEB_ROUTE( 25550fda0f12SGeorge Liu app, 25560fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog/") 2557ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 25587e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 25597e860f15SJohn Edward Broadbent [](const crow::Request&, 25607e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 25617e860f15SJohn Edward Broadbent 25627e860f15SJohn Edward Broadbent { clearDump(asyncResp, "System"); }); 2563013487e5Sraviteja-b } 2564013487e5Sraviteja-b 25657e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app) 25661da66f75SEd Tanous { 25673946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 25683946028dSAppaRao Puli // method for security reasons. 25691da66f75SEd Tanous /** 25701da66f75SEd Tanous * Functions triggers appropriate requests on DBus 25711da66f75SEd Tanous */ 25727e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Crashdump/") 2573ed398213SEd Tanous // This is incorrect, should be: 2574ed398213SEd Tanous //.privileges(redfish::privileges::getLogService) 2575432a890cSEd Tanous .privileges({{"ConfigureManager"}}) 25767e860f15SJohn Edward Broadbent .methods( 25777e860f15SJohn Edward Broadbent boost::beast::http::verb:: 25787e860f15SJohn Edward Broadbent get)([](const crow::Request&, 25797e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 25807e860f15SJohn Edward Broadbent // Copy over the static data to include the entries added by 25817e860f15SJohn Edward Broadbent // SubRoute 25820f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2583424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"; 2584e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 25858e6c099aSJason M. Bills "#LogService.v1_2_0.LogService"; 25864f50ae4bSGunnar Mills asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service"; 25874f50ae4bSGunnar Mills asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service"; 25884f50ae4bSGunnar Mills asyncResp->res.jsonValue["Id"] = "Oem Crashdump"; 2589e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 2590e1f26343SJason M. Bills asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; 25917c8c4058STejas Patil 25927c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 25937c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 25947c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 25957c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 25967c8c4058STejas Patil redfishDateTimeOffset.second; 25977c8c4058STejas Patil 2598cd50aa42SJason M. Bills asyncResp->res.jsonValue["Entries"] = { 2599cd50aa42SJason M. Bills {"@odata.id", 2600424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}}; 2601e1f26343SJason M. Bills asyncResp->res.jsonValue["Actions"] = { 26025b61b5e8SJason M. Bills {"#LogService.ClearLog", 26030fda0f12SGeorge Liu {{"target", 26040fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog"}}}, 26058e6c099aSJason M. Bills {"#LogService.CollectDiagnosticData", 26060fda0f12SGeorge Liu {{"target", 26070fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData"}}}}; 26087e860f15SJohn Edward Broadbent }); 26091da66f75SEd Tanous } 26101da66f75SEd Tanous 26117e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app) 26125b61b5e8SJason M. Bills { 26130fda0f12SGeorge Liu BMCWEB_ROUTE( 26140fda0f12SGeorge Liu app, 26150fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog/") 2616ed398213SEd Tanous // This is incorrect, should be: 2617ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 2618432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 26197e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 26207e860f15SJohn Edward Broadbent [](const crow::Request&, 26217e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 26225b61b5e8SJason M. Bills crow::connections::systemBus->async_method_call( 26235b61b5e8SJason M. Bills [asyncResp](const boost::system::error_code ec, 2624cb13a392SEd Tanous const std::string&) { 26255b61b5e8SJason M. Bills if (ec) 26265b61b5e8SJason M. Bills { 26275b61b5e8SJason M. Bills messages::internalError(asyncResp->res); 26285b61b5e8SJason M. Bills return; 26295b61b5e8SJason M. Bills } 26305b61b5e8SJason M. Bills messages::success(asyncResp->res); 26315b61b5e8SJason M. Bills }, 26327e860f15SJohn Edward Broadbent crashdumpObject, crashdumpPath, deleteAllInterface, 26337e860f15SJohn Edward Broadbent "DeleteAll"); 26347e860f15SJohn Edward Broadbent }); 26355b61b5e8SJason M. Bills } 26365b61b5e8SJason M. Bills 26378d1b46d7Szhanghch05 static void 26388d1b46d7Szhanghch05 logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 26398d1b46d7Szhanghch05 const std::string& logID, nlohmann::json& logEntryJson) 2640e855dd28SJason M. Bills { 2641043a0536SJohnathan Mantey auto getStoredLogCallback = 2642043a0536SJohnathan Mantey [asyncResp, logID, &logEntryJson]( 2643e855dd28SJason M. Bills const boost::system::error_code ec, 2644043a0536SJohnathan Mantey const std::vector<std::pair<std::string, VariantType>>& params) { 2645e855dd28SJason M. Bills if (ec) 2646e855dd28SJason M. Bills { 2647e855dd28SJason M. Bills BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 26481ddcf01aSJason M. Bills if (ec.value() == 26491ddcf01aSJason M. Bills boost::system::linux_error::bad_request_descriptor) 26501ddcf01aSJason M. Bills { 2651043a0536SJohnathan Mantey messages::resourceNotFound(asyncResp->res, "LogEntry", 2652043a0536SJohnathan Mantey logID); 26531ddcf01aSJason M. Bills } 26541ddcf01aSJason M. Bills else 26551ddcf01aSJason M. Bills { 2656e855dd28SJason M. Bills messages::internalError(asyncResp->res); 26571ddcf01aSJason M. Bills } 2658e855dd28SJason M. Bills return; 2659e855dd28SJason M. Bills } 2660043a0536SJohnathan Mantey 2661043a0536SJohnathan Mantey std::string timestamp{}; 2662043a0536SJohnathan Mantey std::string filename{}; 2663043a0536SJohnathan Mantey std::string logfile{}; 26642c70f800SEd Tanous parseCrashdumpParameters(params, filename, timestamp, logfile); 2665043a0536SJohnathan Mantey 2666043a0536SJohnathan Mantey if (filename.empty() || timestamp.empty()) 2667e855dd28SJason M. Bills { 2668043a0536SJohnathan Mantey messages::resourceMissingAtURI(asyncResp->res, logID); 2669e855dd28SJason M. Bills return; 2670e855dd28SJason M. Bills } 2671e855dd28SJason M. Bills 2672043a0536SJohnathan Mantey std::string crashdumpURI = 2673e855dd28SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + 2674043a0536SJohnathan Mantey logID + "/" + filename; 2675d0dbeefdSEd Tanous logEntryJson = {{"@odata.type", "#LogEntry.v1_7_0.LogEntry"}, 2676043a0536SJohnathan Mantey {"@odata.id", "/redfish/v1/Systems/system/" 2677043a0536SJohnathan Mantey "LogServices/Crashdump/Entries/" + 2678e855dd28SJason M. Bills logID}, 2679e855dd28SJason M. Bills {"Name", "CPU Crashdump"}, 2680e855dd28SJason M. Bills {"Id", logID}, 2681e855dd28SJason M. Bills {"EntryType", "Oem"}, 26828e6c099aSJason M. Bills {"AdditionalDataURI", std::move(crashdumpURI)}, 26838e6c099aSJason M. Bills {"DiagnosticDataType", "OEM"}, 26848e6c099aSJason M. Bills {"OEMDiagnosticDataType", "PECICrashdump"}, 2685043a0536SJohnathan Mantey {"Created", std::move(timestamp)}}; 2686e855dd28SJason M. Bills }; 2687e855dd28SJason M. Bills crow::connections::systemBus->async_method_call( 26885b61b5e8SJason M. Bills std::move(getStoredLogCallback), crashdumpObject, 26895b61b5e8SJason M. Bills crashdumpPath + std::string("/") + logID, 2690043a0536SJohnathan Mantey "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface); 2691e855dd28SJason M. Bills } 2692e855dd28SJason M. Bills 26937e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app) 26941da66f75SEd Tanous { 26953946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 26963946028dSAppaRao Puli // method for security reasons. 26971da66f75SEd Tanous /** 26981da66f75SEd Tanous * Functions triggers appropriate requests on DBus 26991da66f75SEd Tanous */ 27007e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 27017e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/") 2702ed398213SEd Tanous // This is incorrect, should be. 2703ed398213SEd Tanous //.privileges(redfish::privileges::postLogEntryCollection) 2704432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 27057e860f15SJohn Edward Broadbent .methods( 27067e860f15SJohn Edward Broadbent boost::beast::http::verb:: 27077e860f15SJohn Edward Broadbent get)([](const crow::Request&, 27087e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 27097e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 27107e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 2711e1f26343SJason M. Bills auto getLogEntriesCallback = [asyncResp]( 2712e1f26343SJason M. Bills const boost::system::error_code ec, 27137e860f15SJohn Edward Broadbent const std::vector<std::string>& 27147e860f15SJohn Edward Broadbent resp) { 27151da66f75SEd Tanous if (ec) 27161da66f75SEd Tanous { 27171da66f75SEd Tanous if (ec.value() != 27181da66f75SEd Tanous boost::system::errc::no_such_file_or_directory) 27191da66f75SEd Tanous { 27201da66f75SEd Tanous BMCWEB_LOG_DEBUG << "failed to get entries ec: " 27211da66f75SEd Tanous << ec.message(); 2722f12894f8SJason M. Bills messages::internalError(asyncResp->res); 27231da66f75SEd Tanous return; 27241da66f75SEd Tanous } 27251da66f75SEd Tanous } 2726e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 27271da66f75SEd Tanous "#LogEntryCollection.LogEntryCollection"; 27280f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2729424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 2730424c4176SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries"; 2731e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2732424c4176SJason M. Bills "Collection of Crashdump Entries"; 27337e860f15SJohn Edward Broadbent nlohmann::json& logEntryArray = 27347e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["Members"]; 2735e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 2736e855dd28SJason M. Bills std::vector<std::string> logIDs; 2737e855dd28SJason M. Bills // Get the list of log entries and build up an empty array big 2738e855dd28SJason M. Bills // enough to hold them 27391da66f75SEd Tanous for (const std::string& objpath : resp) 27401da66f75SEd Tanous { 2741e855dd28SJason M. Bills // Get the log ID 2742f23b7296SEd Tanous std::size_t lastPos = objpath.rfind('/'); 2743e855dd28SJason M. Bills if (lastPos == std::string::npos) 27441da66f75SEd Tanous { 2745e855dd28SJason M. Bills continue; 27461da66f75SEd Tanous } 2747e855dd28SJason M. Bills logIDs.emplace_back(objpath.substr(lastPos + 1)); 2748e855dd28SJason M. Bills 2749e855dd28SJason M. Bills // Add a space for the log entry to the array 2750e855dd28SJason M. Bills logEntryArray.push_back({}); 2751e855dd28SJason M. Bills } 2752e855dd28SJason M. Bills // Now go through and set up async calls to fill in the entries 2753e855dd28SJason M. Bills size_t index = 0; 2754e855dd28SJason M. Bills for (const std::string& logID : logIDs) 2755e855dd28SJason M. Bills { 2756e855dd28SJason M. Bills // Add the log entry to the array 2757e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, logEntryArray[index++]); 27581da66f75SEd Tanous } 2759e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 2760e1f26343SJason M. Bills logEntryArray.size(); 27611da66f75SEd Tanous }; 27621da66f75SEd Tanous crow::connections::systemBus->async_method_call( 27631da66f75SEd Tanous std::move(getLogEntriesCallback), 27641da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", 27651da66f75SEd Tanous "/xyz/openbmc_project/object_mapper", 27661da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0, 27675b61b5e8SJason M. Bills std::array<const char*, 1>{crashdumpInterface}); 27687e860f15SJohn Edward Broadbent }); 27691da66f75SEd Tanous } 27701da66f75SEd Tanous 27717e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app) 27721da66f75SEd Tanous { 27733946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 27743946028dSAppaRao Puli // method for security reasons. 27751da66f75SEd Tanous 27767e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 27777e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/") 2778ed398213SEd Tanous // this is incorrect, should be 2779ed398213SEd Tanous // .privileges(redfish::privileges::getLogEntry) 2780432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 27817e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 27827e860f15SJohn Edward Broadbent [](const crow::Request&, 27837e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 27847e860f15SJohn Edward Broadbent const std::string& param) { 27857e860f15SJohn Edward Broadbent const std::string& logID = param; 2786e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue); 27877e860f15SJohn Edward Broadbent }); 2788e855dd28SJason M. Bills } 2789e855dd28SJason M. Bills 27907e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app) 2791e855dd28SJason M. Bills { 27923946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 27933946028dSAppaRao Puli // method for security reasons. 27947e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 27957e860f15SJohn Edward Broadbent app, 27967e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/<str>/") 2797ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 27987e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 27997e860f15SJohn Edward Broadbent [](const crow::Request&, 28007e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 28017e860f15SJohn Edward Broadbent const std::string& logID, const std::string& fileName) { 2802043a0536SJohnathan Mantey auto getStoredLogCallback = 2803043a0536SJohnathan Mantey [asyncResp, logID, fileName]( 2804abf2add6SEd Tanous const boost::system::error_code ec, 28057e860f15SJohn Edward Broadbent const std::vector<std::pair<std::string, VariantType>>& 28067e860f15SJohn Edward Broadbent resp) { 28071da66f75SEd Tanous if (ec) 28081da66f75SEd Tanous { 2809043a0536SJohnathan Mantey BMCWEB_LOG_DEBUG << "failed to get log ec: " 2810043a0536SJohnathan Mantey << ec.message(); 2811f12894f8SJason M. Bills messages::internalError(asyncResp->res); 28121da66f75SEd Tanous return; 28131da66f75SEd Tanous } 2814e855dd28SJason M. Bills 2815043a0536SJohnathan Mantey std::string dbusFilename{}; 2816043a0536SJohnathan Mantey std::string dbusTimestamp{}; 2817043a0536SJohnathan Mantey std::string dbusFilepath{}; 2818043a0536SJohnathan Mantey 28197e860f15SJohn Edward Broadbent parseCrashdumpParameters(resp, dbusFilename, 28207e860f15SJohn Edward Broadbent dbusTimestamp, dbusFilepath); 2821043a0536SJohnathan Mantey 2822043a0536SJohnathan Mantey if (dbusFilename.empty() || dbusTimestamp.empty() || 2823043a0536SJohnathan Mantey dbusFilepath.empty()) 28241da66f75SEd Tanous { 28257e860f15SJohn Edward Broadbent messages::resourceMissingAtURI(asyncResp->res, 28267e860f15SJohn Edward Broadbent fileName); 28271da66f75SEd Tanous return; 28281da66f75SEd Tanous } 2829e855dd28SJason M. Bills 2830043a0536SJohnathan Mantey // Verify the file name parameter is correct 2831043a0536SJohnathan Mantey if (fileName != dbusFilename) 2832043a0536SJohnathan Mantey { 28337e860f15SJohn Edward Broadbent messages::resourceMissingAtURI(asyncResp->res, 28347e860f15SJohn Edward Broadbent fileName); 2835043a0536SJohnathan Mantey return; 2836043a0536SJohnathan Mantey } 2837043a0536SJohnathan Mantey 2838043a0536SJohnathan Mantey if (!std::filesystem::exists(dbusFilepath)) 2839043a0536SJohnathan Mantey { 28407e860f15SJohn Edward Broadbent messages::resourceMissingAtURI(asyncResp->res, 28417e860f15SJohn Edward Broadbent fileName); 2842043a0536SJohnathan Mantey return; 2843043a0536SJohnathan Mantey } 2844043a0536SJohnathan Mantey std::ifstream ifs(dbusFilepath, std::ios::in | 2845043a0536SJohnathan Mantey std::ios::binary | 2846043a0536SJohnathan Mantey std::ios::ate); 2847043a0536SJohnathan Mantey std::ifstream::pos_type fileSize = ifs.tellg(); 2848043a0536SJohnathan Mantey if (fileSize < 0) 2849043a0536SJohnathan Mantey { 2850043a0536SJohnathan Mantey messages::generalError(asyncResp->res); 2851043a0536SJohnathan Mantey return; 2852043a0536SJohnathan Mantey } 2853043a0536SJohnathan Mantey ifs.seekg(0, std::ios::beg); 2854043a0536SJohnathan Mantey 2855043a0536SJohnathan Mantey auto crashData = std::make_unique<char[]>( 2856043a0536SJohnathan Mantey static_cast<unsigned int>(fileSize)); 2857043a0536SJohnathan Mantey 2858043a0536SJohnathan Mantey ifs.read(crashData.get(), static_cast<int>(fileSize)); 2859043a0536SJohnathan Mantey 28607e860f15SJohn Edward Broadbent // The cast to std::string is intentional in order to 28617e860f15SJohn Edward Broadbent // use the assign() that applies move mechanics 2862043a0536SJohnathan Mantey asyncResp->res.body().assign( 2863043a0536SJohnathan Mantey static_cast<std::string>(crashData.get())); 2864043a0536SJohnathan Mantey 28657e860f15SJohn Edward Broadbent // Configure this to be a file download when accessed 28667e860f15SJohn Edward Broadbent // from a browser 28677e860f15SJohn Edward Broadbent asyncResp->res.addHeader("Content-Disposition", 28687e860f15SJohn Edward Broadbent "attachment"); 28691da66f75SEd Tanous }; 28701da66f75SEd Tanous crow::connections::systemBus->async_method_call( 28715b61b5e8SJason M. Bills std::move(getStoredLogCallback), crashdumpObject, 28725b61b5e8SJason M. Bills crashdumpPath + std::string("/") + logID, 28737e860f15SJohn Edward Broadbent "org.freedesktop.DBus.Properties", "GetAll", 28747e860f15SJohn Edward Broadbent crashdumpInterface); 28757e860f15SJohn Edward Broadbent }); 28761da66f75SEd Tanous } 28771da66f75SEd Tanous 28787e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app) 28791da66f75SEd Tanous { 28803946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 28813946028dSAppaRao Puli // method for security reasons. 28820fda0f12SGeorge Liu BMCWEB_ROUTE( 28830fda0f12SGeorge Liu app, 28840fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/") 2885ed398213SEd Tanous // The below is incorrect; Should be ConfigureManager 2886ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 2887432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 28887e860f15SJohn Edward Broadbent .methods( 28897e860f15SJohn Edward Broadbent boost::beast::http::verb:: 28907e860f15SJohn Edward Broadbent post)([](const crow::Request& req, 28917e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 28928e6c099aSJason M. Bills std::string diagnosticDataType; 28938e6c099aSJason M. Bills std::string oemDiagnosticDataType; 28948e6c099aSJason M. Bills if (!redfish::json_util::readJson( 28957e860f15SJohn Edward Broadbent req, asyncResp->res, "DiagnosticDataType", 28967e860f15SJohn Edward Broadbent diagnosticDataType, "OEMDiagnosticDataType", 28977e860f15SJohn Edward Broadbent oemDiagnosticDataType)) 28988e6c099aSJason M. Bills { 28998e6c099aSJason M. Bills return; 29008e6c099aSJason M. Bills } 29018e6c099aSJason M. Bills 29028e6c099aSJason M. Bills if (diagnosticDataType != "OEM") 29038e6c099aSJason M. Bills { 29048e6c099aSJason M. Bills BMCWEB_LOG_ERROR 29058e6c099aSJason M. Bills << "Only OEM DiagnosticDataType supported for Crashdump"; 29068e6c099aSJason M. Bills messages::actionParameterValueFormatError( 29078e6c099aSJason M. Bills asyncResp->res, diagnosticDataType, "DiagnosticDataType", 29088e6c099aSJason M. Bills "CollectDiagnosticData"); 29098e6c099aSJason M. Bills return; 29108e6c099aSJason M. Bills } 29118e6c099aSJason M. Bills 2912*98be3e39SEd Tanous auto collectCrashdumpCallback = [asyncResp, 2913*98be3e39SEd Tanous payload(task::Payload(req))]( 29147e860f15SJohn Edward Broadbent const boost::system::error_code 29157e860f15SJohn Edward Broadbent ec, 2916*98be3e39SEd Tanous const std::string&) mutable { 29171da66f75SEd Tanous if (ec) 29181da66f75SEd Tanous { 29197e860f15SJohn Edward Broadbent if (ec.value() == 29207e860f15SJohn Edward Broadbent boost::system::errc::operation_not_supported) 29211da66f75SEd Tanous { 2922f12894f8SJason M. Bills messages::resourceInStandby(asyncResp->res); 29231da66f75SEd Tanous } 29244363d3b2SJason M. Bills else if (ec.value() == 29254363d3b2SJason M. Bills boost::system::errc::device_or_resource_busy) 29264363d3b2SJason M. Bills { 29274363d3b2SJason M. Bills messages::serviceTemporarilyUnavailable(asyncResp->res, 29284363d3b2SJason M. Bills "60"); 29294363d3b2SJason M. Bills } 29301da66f75SEd Tanous else 29311da66f75SEd Tanous { 2932f12894f8SJason M. Bills messages::internalError(asyncResp->res); 29331da66f75SEd Tanous } 29341da66f75SEd Tanous return; 29351da66f75SEd Tanous } 29360fda0f12SGeorge Liu std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 29377e860f15SJohn Edward Broadbent [](boost::system::error_code err, 29387e860f15SJohn Edward Broadbent sdbusplus::message::message&, 293966afe4faSJames Feist const std::shared_ptr<task::TaskData>& taskData) { 294066afe4faSJames Feist if (!err) 294166afe4faSJames Feist { 2942e5d5006bSJames Feist taskData->messages.emplace_back( 2943e5d5006bSJames Feist messages::taskCompletedOK( 2944e5d5006bSJames Feist std::to_string(taskData->index))); 2945831d6b09SJames Feist taskData->state = "Completed"; 294666afe4faSJames Feist } 294732898ceaSJames Feist return task::completed; 294866afe4faSJames Feist }, 29497e860f15SJohn Edward Broadbent "type='signal',interface='org.freedesktop.DBus." 29507e860f15SJohn Edward Broadbent "Properties'," 29510fda0f12SGeorge Liu "member='PropertiesChanged',arg0namespace='com.intel.crashdump'"); 295246229577SJames Feist task->startTimer(std::chrono::minutes(5)); 295346229577SJames Feist task->populateResp(asyncResp->res); 2954*98be3e39SEd Tanous task->payload.emplace(std::move(payload)); 29551da66f75SEd Tanous }; 29568e6c099aSJason M. Bills 29578e6c099aSJason M. Bills if (oemDiagnosticDataType == "OnDemand") 29588e6c099aSJason M. Bills { 29591da66f75SEd Tanous crow::connections::systemBus->async_method_call( 29608e6c099aSJason M. Bills std::move(collectCrashdumpCallback), crashdumpObject, 29618e6c099aSJason M. Bills crashdumpPath, crashdumpOnDemandInterface, 29628e6c099aSJason M. Bills "GenerateOnDemandLog"); 29631da66f75SEd Tanous } 29648e6c099aSJason M. Bills else if (oemDiagnosticDataType == "Telemetry") 29656eda7685SKenny L. Ku { 29668e6c099aSJason M. Bills crow::connections::systemBus->async_method_call( 29678e6c099aSJason M. Bills std::move(collectCrashdumpCallback), crashdumpObject, 29688e6c099aSJason M. Bills crashdumpPath, crashdumpTelemetryInterface, 29698e6c099aSJason M. Bills "GenerateTelemetryLog"); 29706eda7685SKenny L. Ku } 29716eda7685SKenny L. Ku else 29726eda7685SKenny L. Ku { 29738e6c099aSJason M. Bills BMCWEB_LOG_ERROR << "Unsupported OEMDiagnosticDataType: " 29748e6c099aSJason M. Bills << oemDiagnosticDataType; 29758e6c099aSJason M. Bills messages::actionParameterValueFormatError( 29767e860f15SJohn Edward Broadbent asyncResp->res, oemDiagnosticDataType, 29777e860f15SJohn Edward Broadbent "OEMDiagnosticDataType", "CollectDiagnosticData"); 29786eda7685SKenny L. Ku return; 29796eda7685SKenny L. Ku } 29807e860f15SJohn Edward Broadbent }); 29816eda7685SKenny L. Ku } 29826eda7685SKenny L. Ku 2983cb92c03bSAndrew Geissler /** 2984cb92c03bSAndrew Geissler * DBusLogServiceActionsClear class supports POST method for ClearLog action. 2985cb92c03bSAndrew Geissler */ 29867e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app) 2987cb92c03bSAndrew Geissler { 2988cb92c03bSAndrew Geissler /** 2989cb92c03bSAndrew Geissler * Function handles POST method request. 2990cb92c03bSAndrew Geissler * The Clear Log actions does not require any parameter.The action deletes 2991cb92c03bSAndrew Geissler * all entries found in the Entries collection for this Log Service. 2992cb92c03bSAndrew Geissler */ 29937e860f15SJohn Edward Broadbent 29940fda0f12SGeorge Liu BMCWEB_ROUTE( 29950fda0f12SGeorge Liu app, 29960fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog/") 2997ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 29987e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 29997e860f15SJohn Edward Broadbent [](const crow::Request&, 30007e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 3001cb92c03bSAndrew Geissler BMCWEB_LOG_DEBUG << "Do delete all entries."; 3002cb92c03bSAndrew Geissler 3003cb92c03bSAndrew Geissler // Process response from Logging service. 30047e860f15SJohn Edward Broadbent auto respHandler = [asyncResp]( 30057e860f15SJohn Edward Broadbent const boost::system::error_code ec) { 30067e860f15SJohn Edward Broadbent BMCWEB_LOG_DEBUG 30077e860f15SJohn Edward Broadbent << "doClearLog resp_handler callback: Done"; 3008cb92c03bSAndrew Geissler if (ec) 3009cb92c03bSAndrew Geissler { 3010cb92c03bSAndrew Geissler // TODO Handle for specific error code 30117e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " 30127e860f15SJohn Edward Broadbent << ec; 3013cb92c03bSAndrew Geissler asyncResp->res.result( 3014cb92c03bSAndrew Geissler boost::beast::http::status::internal_server_error); 3015cb92c03bSAndrew Geissler return; 3016cb92c03bSAndrew Geissler } 3017cb92c03bSAndrew Geissler 30187e860f15SJohn Edward Broadbent asyncResp->res.result( 30197e860f15SJohn Edward Broadbent boost::beast::http::status::no_content); 3020cb92c03bSAndrew Geissler }; 3021cb92c03bSAndrew Geissler 3022cb92c03bSAndrew Geissler // Make call to Logging service to request Clear Log 3023cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 30242c70f800SEd Tanous respHandler, "xyz.openbmc_project.Logging", 3025cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging", 3026cb92c03bSAndrew Geissler "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 30277e860f15SJohn Edward Broadbent }); 3028cb92c03bSAndrew Geissler } 3029a3316fc6SZhikuiRen 3030a3316fc6SZhikuiRen /**************************************************** 3031a3316fc6SZhikuiRen * Redfish PostCode interfaces 3032a3316fc6SZhikuiRen * using DBUS interface: getPostCodesTS 3033a3316fc6SZhikuiRen ******************************************************/ 30347e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesLogService(App& app) 3035a3316fc6SZhikuiRen { 30367e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/PostCodes/") 3037ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 30380fda0f12SGeorge Liu .methods( 30390fda0f12SGeorge Liu boost::beast::http::verb:: 30400fda0f12SGeorge Liu get)([](const crow::Request&, 30417e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 3042a3316fc6SZhikuiRen asyncResp->res.jsonValue = { 30437e860f15SJohn Edward Broadbent {"@odata.id", 30447e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/PostCodes"}, 3045a3316fc6SZhikuiRen {"@odata.type", "#LogService.v1_1_0.LogService"}, 3046a3316fc6SZhikuiRen {"Name", "POST Code Log Service"}, 3047a3316fc6SZhikuiRen {"Description", "POST Code Log Service"}, 3048a3316fc6SZhikuiRen {"Id", "BIOS POST Code Log"}, 3049a3316fc6SZhikuiRen {"OverWritePolicy", "WrapsWhenFull"}, 3050a3316fc6SZhikuiRen {"Entries", 30510fda0f12SGeorge Liu {{"@odata.id", 30520fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"}}}}; 30537c8c4058STejas Patil 30547c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 30557c8c4058STejas Patil crow::utility::getDateTimeOffsetNow(); 30560fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 30577c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 30587c8c4058STejas Patil redfishDateTimeOffset.second; 30597c8c4058STejas Patil 3060a3316fc6SZhikuiRen asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 30617e860f15SJohn Edward Broadbent {"target", 30620fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog"}}; 30637e860f15SJohn Edward Broadbent }); 3064a3316fc6SZhikuiRen } 3065a3316fc6SZhikuiRen 30667e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesClear(App& app) 3067a3316fc6SZhikuiRen { 30680fda0f12SGeorge Liu BMCWEB_ROUTE( 30690fda0f12SGeorge Liu app, 30700fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog/") 3071ed398213SEd Tanous // The following privilege is incorrect; It should be ConfigureManager 3072ed398213SEd Tanous //.privileges(redfish::privileges::postLogService) 3073432a890cSEd Tanous .privileges({{"ConfigureComponents"}}) 30747e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 30757e860f15SJohn Edward Broadbent [](const crow::Request&, 30767e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 3077a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Do delete all postcodes entries."; 3078a3316fc6SZhikuiRen 3079a3316fc6SZhikuiRen // Make call to post-code service to request clear all 3080a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3081a3316fc6SZhikuiRen [asyncResp](const boost::system::error_code ec) { 3082a3316fc6SZhikuiRen if (ec) 3083a3316fc6SZhikuiRen { 3084a3316fc6SZhikuiRen // TODO Handle for specific error code 3085a3316fc6SZhikuiRen BMCWEB_LOG_ERROR 30867e860f15SJohn Edward Broadbent << "doClearPostCodes resp_handler got error " 30877e860f15SJohn Edward Broadbent << ec; 30887e860f15SJohn Edward Broadbent asyncResp->res.result(boost::beast::http::status:: 30897e860f15SJohn Edward Broadbent internal_server_error); 3090a3316fc6SZhikuiRen messages::internalError(asyncResp->res); 3091a3316fc6SZhikuiRen return; 3092a3316fc6SZhikuiRen } 3093a3316fc6SZhikuiRen }, 309415124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 309515124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3096a3316fc6SZhikuiRen "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 30977e860f15SJohn Edward Broadbent }); 3098a3316fc6SZhikuiRen } 3099a3316fc6SZhikuiRen 3100a3316fc6SZhikuiRen static void fillPostCodeEntry( 31018d1b46d7Szhanghch05 const std::shared_ptr<bmcweb::AsyncResp>& aResp, 31026c9a279eSManojkiran Eda const boost::container::flat_map< 31036c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode, 3104a3316fc6SZhikuiRen const uint16_t bootIndex, const uint64_t codeIndex = 0, 3105a3316fc6SZhikuiRen const uint64_t skip = 0, const uint64_t top = 0) 3106a3316fc6SZhikuiRen { 3107a3316fc6SZhikuiRen // Get the Message from the MessageRegistry 3108a3316fc6SZhikuiRen const message_registries::Message* message = 31094a0bf539SManojkiran Eda message_registries::getMessage("OpenBMC.0.2.BIOSPOSTCode"); 3110a3316fc6SZhikuiRen 3111a3316fc6SZhikuiRen uint64_t currentCodeIndex = 0; 3112a3316fc6SZhikuiRen nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"]; 3113a3316fc6SZhikuiRen 3114a3316fc6SZhikuiRen uint64_t firstCodeTimeUs = 0; 31156c9a279eSManojkiran Eda for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 31166c9a279eSManojkiran Eda code : postcode) 3117a3316fc6SZhikuiRen { 3118a3316fc6SZhikuiRen currentCodeIndex++; 3119a3316fc6SZhikuiRen std::string postcodeEntryID = 3120a3316fc6SZhikuiRen "B" + std::to_string(bootIndex) + "-" + 3121a3316fc6SZhikuiRen std::to_string(currentCodeIndex); // 1 based index in EntryID string 3122a3316fc6SZhikuiRen 3123a3316fc6SZhikuiRen uint64_t usecSinceEpoch = code.first; 3124a3316fc6SZhikuiRen uint64_t usTimeOffset = 0; 3125a3316fc6SZhikuiRen 3126a3316fc6SZhikuiRen if (1 == currentCodeIndex) 3127a3316fc6SZhikuiRen { // already incremented 3128a3316fc6SZhikuiRen firstCodeTimeUs = code.first; 3129a3316fc6SZhikuiRen } 3130a3316fc6SZhikuiRen else 3131a3316fc6SZhikuiRen { 3132a3316fc6SZhikuiRen usTimeOffset = code.first - firstCodeTimeUs; 3133a3316fc6SZhikuiRen } 3134a3316fc6SZhikuiRen 3135a3316fc6SZhikuiRen // skip if no specific codeIndex is specified and currentCodeIndex does 3136a3316fc6SZhikuiRen // not fall between top and skip 3137a3316fc6SZhikuiRen if ((codeIndex == 0) && 3138a3316fc6SZhikuiRen (currentCodeIndex <= skip || currentCodeIndex > top)) 3139a3316fc6SZhikuiRen { 3140a3316fc6SZhikuiRen continue; 3141a3316fc6SZhikuiRen } 3142a3316fc6SZhikuiRen 31434e0453b1SGunnar Mills // skip if a specific codeIndex is specified and does not match the 3144a3316fc6SZhikuiRen // currentIndex 3145a3316fc6SZhikuiRen if ((codeIndex > 0) && (currentCodeIndex != codeIndex)) 3146a3316fc6SZhikuiRen { 3147a3316fc6SZhikuiRen // This is done for simplicity. 1st entry is needed to calculate 3148a3316fc6SZhikuiRen // time offset. To improve efficiency, one can get to the entry 3149a3316fc6SZhikuiRen // directly (possibly with flatmap's nth method) 3150a3316fc6SZhikuiRen continue; 3151a3316fc6SZhikuiRen } 3152a3316fc6SZhikuiRen 3153a3316fc6SZhikuiRen // currentCodeIndex is within top and skip or equal to specified code 3154a3316fc6SZhikuiRen // index 3155a3316fc6SZhikuiRen 3156a3316fc6SZhikuiRen // Get the Created time from the timestamp 3157a3316fc6SZhikuiRen std::string entryTimeStr; 31589c620e21SAsmitha Karunanithi entryTimeStr = crow::utility::getDateTime( 31599c620e21SAsmitha Karunanithi static_cast<std::time_t>(usecSinceEpoch / 1000 / 1000)); 3160a3316fc6SZhikuiRen 3161a3316fc6SZhikuiRen // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex) 3162a3316fc6SZhikuiRen std::ostringstream hexCode; 3163a3316fc6SZhikuiRen hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex 31646c9a279eSManojkiran Eda << std::get<0>(code.second); 3165a3316fc6SZhikuiRen std::ostringstream timeOffsetStr; 3166a3316fc6SZhikuiRen // Set Fixed -Point Notation 3167a3316fc6SZhikuiRen timeOffsetStr << std::fixed; 3168a3316fc6SZhikuiRen // Set precision to 4 digits 3169a3316fc6SZhikuiRen timeOffsetStr << std::setprecision(4); 3170a3316fc6SZhikuiRen // Add double to stream 3171a3316fc6SZhikuiRen timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000; 3172a3316fc6SZhikuiRen std::vector<std::string> messageArgs = { 3173a3316fc6SZhikuiRen std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()}; 3174a3316fc6SZhikuiRen 3175a3316fc6SZhikuiRen // Get MessageArgs template from message registry 3176a3316fc6SZhikuiRen std::string msg; 3177a3316fc6SZhikuiRen if (message != nullptr) 3178a3316fc6SZhikuiRen { 3179a3316fc6SZhikuiRen msg = message->message; 3180a3316fc6SZhikuiRen 3181a3316fc6SZhikuiRen // fill in this post code value 3182a3316fc6SZhikuiRen int i = 0; 3183a3316fc6SZhikuiRen for (const std::string& messageArg : messageArgs) 3184a3316fc6SZhikuiRen { 3185a3316fc6SZhikuiRen std::string argStr = "%" + std::to_string(++i); 3186a3316fc6SZhikuiRen size_t argPos = msg.find(argStr); 3187a3316fc6SZhikuiRen if (argPos != std::string::npos) 3188a3316fc6SZhikuiRen { 3189a3316fc6SZhikuiRen msg.replace(argPos, argStr.length(), messageArg); 3190a3316fc6SZhikuiRen } 3191a3316fc6SZhikuiRen } 3192a3316fc6SZhikuiRen } 3193a3316fc6SZhikuiRen 3194d4342a92STim Lee // Get Severity template from message registry 3195d4342a92STim Lee std::string severity; 3196d4342a92STim Lee if (message != nullptr) 3197d4342a92STim Lee { 3198d4342a92STim Lee severity = message->severity; 3199d4342a92STim Lee } 3200d4342a92STim Lee 3201a3316fc6SZhikuiRen // add to AsyncResp 3202a3316fc6SZhikuiRen logEntryArray.push_back({}); 3203a3316fc6SZhikuiRen nlohmann::json& bmcLogEntry = logEntryArray.back(); 32040fda0f12SGeorge Liu bmcLogEntry = { 32050fda0f12SGeorge Liu {"@odata.type", "#LogEntry.v1_8_0.LogEntry"}, 32060fda0f12SGeorge Liu {"@odata.id", 32070fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 3208a3316fc6SZhikuiRen postcodeEntryID}, 3209a3316fc6SZhikuiRen {"Name", "POST Code Log Entry"}, 3210a3316fc6SZhikuiRen {"Id", postcodeEntryID}, 3211a3316fc6SZhikuiRen {"Message", std::move(msg)}, 32124a0bf539SManojkiran Eda {"MessageId", "OpenBMC.0.2.BIOSPOSTCode"}, 3213a3316fc6SZhikuiRen {"MessageArgs", std::move(messageArgs)}, 3214a3316fc6SZhikuiRen {"EntryType", "Event"}, 3215a3316fc6SZhikuiRen {"Severity", std::move(severity)}, 32169c620e21SAsmitha Karunanithi {"Created", entryTimeStr}}; 3217647b3cdcSGeorge Liu if (!std::get<std::vector<uint8_t>>(code.second).empty()) 3218647b3cdcSGeorge Liu { 3219647b3cdcSGeorge Liu bmcLogEntry["AdditionalDataURI"] = 3220647b3cdcSGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" + 3221647b3cdcSGeorge Liu postcodeEntryID + "/attachment"; 3222647b3cdcSGeorge Liu } 3223a3316fc6SZhikuiRen } 3224a3316fc6SZhikuiRen } 3225a3316fc6SZhikuiRen 32268d1b46d7Szhanghch05 static void getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3227a3316fc6SZhikuiRen const uint16_t bootIndex, 3228a3316fc6SZhikuiRen const uint64_t codeIndex) 3229a3316fc6SZhikuiRen { 3230a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 32316c9a279eSManojkiran Eda [aResp, bootIndex, 32326c9a279eSManojkiran Eda codeIndex](const boost::system::error_code ec, 32336c9a279eSManojkiran Eda const boost::container::flat_map< 32346c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 32356c9a279eSManojkiran Eda postcode) { 3236a3316fc6SZhikuiRen if (ec) 3237a3316fc6SZhikuiRen { 3238a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3239a3316fc6SZhikuiRen messages::internalError(aResp->res); 3240a3316fc6SZhikuiRen return; 3241a3316fc6SZhikuiRen } 3242a3316fc6SZhikuiRen 3243a3316fc6SZhikuiRen // skip the empty postcode boots 3244a3316fc6SZhikuiRen if (postcode.empty()) 3245a3316fc6SZhikuiRen { 3246a3316fc6SZhikuiRen return; 3247a3316fc6SZhikuiRen } 3248a3316fc6SZhikuiRen 3249a3316fc6SZhikuiRen fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex); 3250a3316fc6SZhikuiRen 3251a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = 3252a3316fc6SZhikuiRen aResp->res.jsonValue["Members"].size(); 3253a3316fc6SZhikuiRen }, 325415124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 325515124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3256a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3257a3316fc6SZhikuiRen bootIndex); 3258a3316fc6SZhikuiRen } 3259a3316fc6SZhikuiRen 32608d1b46d7Szhanghch05 static void getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3261a3316fc6SZhikuiRen const uint16_t bootIndex, 3262a3316fc6SZhikuiRen const uint16_t bootCount, 3263a3316fc6SZhikuiRen const uint64_t entryCount, const uint64_t skip, 3264a3316fc6SZhikuiRen const uint64_t top) 3265a3316fc6SZhikuiRen { 3266a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3267a3316fc6SZhikuiRen [aResp, bootIndex, bootCount, entryCount, skip, 3268a3316fc6SZhikuiRen top](const boost::system::error_code ec, 32696c9a279eSManojkiran Eda const boost::container::flat_map< 32706c9a279eSManojkiran Eda uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& 32716c9a279eSManojkiran Eda postcode) { 3272a3316fc6SZhikuiRen if (ec) 3273a3316fc6SZhikuiRen { 3274a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3275a3316fc6SZhikuiRen messages::internalError(aResp->res); 3276a3316fc6SZhikuiRen return; 3277a3316fc6SZhikuiRen } 3278a3316fc6SZhikuiRen 3279a3316fc6SZhikuiRen uint64_t endCount = entryCount; 3280a3316fc6SZhikuiRen if (!postcode.empty()) 3281a3316fc6SZhikuiRen { 3282a3316fc6SZhikuiRen endCount = entryCount + postcode.size(); 3283a3316fc6SZhikuiRen 3284a3316fc6SZhikuiRen if ((skip < endCount) && ((top + skip) > entryCount)) 3285a3316fc6SZhikuiRen { 3286a3316fc6SZhikuiRen uint64_t thisBootSkip = 3287a3316fc6SZhikuiRen std::max(skip, entryCount) - entryCount; 3288a3316fc6SZhikuiRen uint64_t thisBootTop = 3289a3316fc6SZhikuiRen std::min(top + skip, endCount) - entryCount; 3290a3316fc6SZhikuiRen 3291a3316fc6SZhikuiRen fillPostCodeEntry(aResp, postcode, bootIndex, 0, 3292a3316fc6SZhikuiRen thisBootSkip, thisBootTop); 3293a3316fc6SZhikuiRen } 3294a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = endCount; 3295a3316fc6SZhikuiRen } 3296a3316fc6SZhikuiRen 3297a3316fc6SZhikuiRen // continue to previous bootIndex 3298a3316fc6SZhikuiRen if (bootIndex < bootCount) 3299a3316fc6SZhikuiRen { 3300a3316fc6SZhikuiRen getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1), 3301a3316fc6SZhikuiRen bootCount, endCount, skip, top); 3302a3316fc6SZhikuiRen } 3303a3316fc6SZhikuiRen else 3304a3316fc6SZhikuiRen { 3305a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.nextLink"] = 33060fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=" + 3307a3316fc6SZhikuiRen std::to_string(skip + top); 3308a3316fc6SZhikuiRen } 3309a3316fc6SZhikuiRen }, 331015124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 331115124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3312a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3313a3316fc6SZhikuiRen bootIndex); 3314a3316fc6SZhikuiRen } 3315a3316fc6SZhikuiRen 33168d1b46d7Szhanghch05 static void 33178d1b46d7Szhanghch05 getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& aResp, 3318a3316fc6SZhikuiRen const uint64_t skip, const uint64_t top) 3319a3316fc6SZhikuiRen { 3320a3316fc6SZhikuiRen uint64_t entryCount = 0; 3321a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3322a3316fc6SZhikuiRen [aResp, entryCount, skip, 3323a3316fc6SZhikuiRen top](const boost::system::error_code ec, 3324a3316fc6SZhikuiRen const std::variant<uint16_t>& bootCount) { 3325a3316fc6SZhikuiRen if (ec) 3326a3316fc6SZhikuiRen { 3327a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3328a3316fc6SZhikuiRen messages::internalError(aResp->res); 3329a3316fc6SZhikuiRen return; 3330a3316fc6SZhikuiRen } 3331a3316fc6SZhikuiRen auto pVal = std::get_if<uint16_t>(&bootCount); 3332a3316fc6SZhikuiRen if (pVal) 3333a3316fc6SZhikuiRen { 3334a3316fc6SZhikuiRen getPostCodeForBoot(aResp, 1, *pVal, entryCount, skip, top); 3335a3316fc6SZhikuiRen } 3336a3316fc6SZhikuiRen else 3337a3316fc6SZhikuiRen { 3338a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Post code boot index failed."; 3339a3316fc6SZhikuiRen } 3340a3316fc6SZhikuiRen }, 334115124765SJonathan Doman "xyz.openbmc_project.State.Boot.PostCode0", 334215124765SJonathan Doman "/xyz/openbmc_project/State/Boot/PostCode0", 3343a3316fc6SZhikuiRen "org.freedesktop.DBus.Properties", "Get", 3344a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount"); 3345a3316fc6SZhikuiRen } 3346a3316fc6SZhikuiRen 33477e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntryCollection(App& app) 3348a3316fc6SZhikuiRen { 33497e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 33507e860f15SJohn Edward Broadbent "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/") 3351ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 33527e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 33537e860f15SJohn Edward Broadbent [](const crow::Request& req, 33547e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 3355a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.type"] = 3356a3316fc6SZhikuiRen "#LogEntryCollection.LogEntryCollection"; 3357a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 3358a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3359a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3360a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3361a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3362a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3363a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 3364a3316fc6SZhikuiRen 3365a3316fc6SZhikuiRen uint64_t skip = 0; 3366a3316fc6SZhikuiRen uint64_t top = maxEntriesPerPage; // Show max entries by default 33678d1b46d7Szhanghch05 if (!getSkipParam(asyncResp, req, skip)) 3368a3316fc6SZhikuiRen { 3369a3316fc6SZhikuiRen return; 3370a3316fc6SZhikuiRen } 33718d1b46d7Szhanghch05 if (!getTopParam(asyncResp, req, top)) 3372a3316fc6SZhikuiRen { 3373a3316fc6SZhikuiRen return; 3374a3316fc6SZhikuiRen } 3375a3316fc6SZhikuiRen getCurrentBootNumber(asyncResp, skip, top); 33767e860f15SJohn Edward Broadbent }); 3377a3316fc6SZhikuiRen } 3378a3316fc6SZhikuiRen 3379647b3cdcSGeorge Liu /** 3380647b3cdcSGeorge Liu * @brief Parse post code ID and get the current value and index value 3381647b3cdcSGeorge Liu * eg: postCodeID=B1-2, currentValue=1, index=2 3382647b3cdcSGeorge Liu * 3383647b3cdcSGeorge Liu * @param[in] postCodeID Post Code ID 3384647b3cdcSGeorge Liu * @param[out] currentValue Current value 3385647b3cdcSGeorge Liu * @param[out] index Index value 3386647b3cdcSGeorge Liu * 3387647b3cdcSGeorge Liu * @return bool true if the parsing is successful, false the parsing fails 3388647b3cdcSGeorge Liu */ 3389647b3cdcSGeorge Liu inline static bool parsePostCode(const std::string& postCodeID, 3390647b3cdcSGeorge Liu uint64_t& currentValue, uint16_t& index) 3391647b3cdcSGeorge Liu { 3392647b3cdcSGeorge Liu std::vector<std::string> split; 3393647b3cdcSGeorge Liu boost::algorithm::split(split, postCodeID, boost::is_any_of("-")); 3394647b3cdcSGeorge Liu if (split.size() != 2 || split[0].length() < 2 || split[0].front() != 'B') 3395647b3cdcSGeorge Liu { 3396647b3cdcSGeorge Liu return false; 3397647b3cdcSGeorge Liu } 3398647b3cdcSGeorge Liu 3399647b3cdcSGeorge Liu const char* start = split[0].data() + 1; 3400647b3cdcSGeorge Liu const char* end = split[0].data() + split[0].size(); 3401647b3cdcSGeorge Liu auto [ptrIndex, ecIndex] = std::from_chars(start, end, index); 3402647b3cdcSGeorge Liu 3403647b3cdcSGeorge Liu if (ptrIndex != end || ecIndex != std::errc()) 3404647b3cdcSGeorge Liu { 3405647b3cdcSGeorge Liu return false; 3406647b3cdcSGeorge Liu } 3407647b3cdcSGeorge Liu 3408647b3cdcSGeorge Liu start = split[1].data(); 3409647b3cdcSGeorge Liu end = split[1].data() + split[1].size(); 3410647b3cdcSGeorge Liu auto [ptrValue, ecValue] = std::from_chars(start, end, currentValue); 3411647b3cdcSGeorge Liu if (ptrValue != end || ecValue != std::errc()) 3412647b3cdcSGeorge Liu { 3413647b3cdcSGeorge Liu return false; 3414647b3cdcSGeorge Liu } 3415647b3cdcSGeorge Liu 3416647b3cdcSGeorge Liu return true; 3417647b3cdcSGeorge Liu } 3418647b3cdcSGeorge Liu 3419647b3cdcSGeorge Liu inline void requestRoutesPostCodesEntryAdditionalData(App& app) 3420647b3cdcSGeorge Liu { 34210fda0f12SGeorge Liu BMCWEB_ROUTE( 34220fda0f12SGeorge Liu app, 34230fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/attachment/") 3424647b3cdcSGeorge Liu .privileges(redfish::privileges::getLogEntry) 3425647b3cdcSGeorge Liu .methods(boost::beast::http::verb::get)( 3426647b3cdcSGeorge Liu [](const crow::Request& req, 3427647b3cdcSGeorge Liu const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3428647b3cdcSGeorge Liu const std::string& postCodeID) { 3429647b3cdcSGeorge Liu if (!http_helpers::isOctetAccepted( 3430647b3cdcSGeorge Liu req.getHeaderValue("Accept"))) 3431647b3cdcSGeorge Liu { 3432647b3cdcSGeorge Liu asyncResp->res.result( 3433647b3cdcSGeorge Liu boost::beast::http::status::bad_request); 3434647b3cdcSGeorge Liu return; 3435647b3cdcSGeorge Liu } 3436647b3cdcSGeorge Liu 3437647b3cdcSGeorge Liu uint64_t currentValue = 0; 3438647b3cdcSGeorge Liu uint16_t index = 0; 3439647b3cdcSGeorge Liu if (!parsePostCode(postCodeID, currentValue, index)) 3440647b3cdcSGeorge Liu { 3441647b3cdcSGeorge Liu messages::resourceNotFound(asyncResp->res, "LogEntry", 3442647b3cdcSGeorge Liu postCodeID); 3443647b3cdcSGeorge Liu return; 3444647b3cdcSGeorge Liu } 3445647b3cdcSGeorge Liu 3446647b3cdcSGeorge Liu crow::connections::systemBus->async_method_call( 3447647b3cdcSGeorge Liu [asyncResp, postCodeID, currentValue]( 3448647b3cdcSGeorge Liu const boost::system::error_code ec, 3449647b3cdcSGeorge Liu const std::vector<std::tuple< 3450647b3cdcSGeorge Liu uint64_t, std::vector<uint8_t>>>& postcodes) { 3451647b3cdcSGeorge Liu if (ec.value() == EBADR) 3452647b3cdcSGeorge Liu { 3453647b3cdcSGeorge Liu messages::resourceNotFound(asyncResp->res, 3454647b3cdcSGeorge Liu "LogEntry", postCodeID); 3455647b3cdcSGeorge Liu return; 3456647b3cdcSGeorge Liu } 3457647b3cdcSGeorge Liu if (ec) 3458647b3cdcSGeorge Liu { 3459647b3cdcSGeorge Liu BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3460647b3cdcSGeorge Liu messages::internalError(asyncResp->res); 3461647b3cdcSGeorge Liu return; 3462647b3cdcSGeorge Liu } 3463647b3cdcSGeorge Liu 3464647b3cdcSGeorge Liu size_t value = static_cast<size_t>(currentValue) - 1; 3465647b3cdcSGeorge Liu if (value == std::string::npos || 3466647b3cdcSGeorge Liu postcodes.size() < currentValue) 3467647b3cdcSGeorge Liu { 3468647b3cdcSGeorge Liu BMCWEB_LOG_ERROR << "Wrong currentValue value"; 3469647b3cdcSGeorge Liu messages::resourceNotFound(asyncResp->res, 3470647b3cdcSGeorge Liu "LogEntry", postCodeID); 3471647b3cdcSGeorge Liu return; 3472647b3cdcSGeorge Liu } 3473647b3cdcSGeorge Liu 3474647b3cdcSGeorge Liu auto& [tID, code] = postcodes[value]; 3475647b3cdcSGeorge Liu if (code.empty()) 3476647b3cdcSGeorge Liu { 3477647b3cdcSGeorge Liu BMCWEB_LOG_INFO << "No found post code data"; 3478647b3cdcSGeorge Liu messages::resourceNotFound(asyncResp->res, 3479647b3cdcSGeorge Liu "LogEntry", postCodeID); 3480647b3cdcSGeorge Liu return; 3481647b3cdcSGeorge Liu } 3482647b3cdcSGeorge Liu 3483647b3cdcSGeorge Liu std::string_view strData( 3484647b3cdcSGeorge Liu reinterpret_cast<const char*>(code.data()), 3485647b3cdcSGeorge Liu code.size()); 3486647b3cdcSGeorge Liu 3487647b3cdcSGeorge Liu asyncResp->res.addHeader("Content-Type", 3488647b3cdcSGeorge Liu "application/octet-stream"); 3489647b3cdcSGeorge Liu asyncResp->res.addHeader("Content-Transfer-Encoding", 3490647b3cdcSGeorge Liu "Base64"); 3491647b3cdcSGeorge Liu asyncResp->res.body() = 3492647b3cdcSGeorge Liu crow::utility::base64encode(strData); 3493647b3cdcSGeorge Liu }, 3494647b3cdcSGeorge Liu "xyz.openbmc_project.State.Boot.PostCode0", 3495647b3cdcSGeorge Liu "/xyz/openbmc_project/State/Boot/PostCode0", 3496647b3cdcSGeorge Liu "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", 3497647b3cdcSGeorge Liu index); 3498647b3cdcSGeorge Liu }); 3499647b3cdcSGeorge Liu } 3500647b3cdcSGeorge Liu 35017e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntry(App& app) 3502a3316fc6SZhikuiRen { 35037e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 35047e860f15SJohn Edward Broadbent app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/") 3505ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 35067e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 35077e860f15SJohn Edward Broadbent [](const crow::Request&, 35087e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 35097e860f15SJohn Edward Broadbent const std::string& targetID) { 3510647b3cdcSGeorge Liu uint16_t bootIndex = 0; 3511647b3cdcSGeorge Liu uint64_t codeIndex = 0; 3512647b3cdcSGeorge Liu if (!parsePostCode(targetID, codeIndex, bootIndex)) 3513a3316fc6SZhikuiRen { 3514a3316fc6SZhikuiRen // Requested ID was not found 3515a3316fc6SZhikuiRen messages::resourceMissingAtURI(asyncResp->res, targetID); 3516a3316fc6SZhikuiRen return; 3517a3316fc6SZhikuiRen } 3518a3316fc6SZhikuiRen if (bootIndex == 0 || codeIndex == 0) 3519a3316fc6SZhikuiRen { 3520a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string " 35217e860f15SJohn Edward Broadbent << targetID; 3522a3316fc6SZhikuiRen } 3523a3316fc6SZhikuiRen 35247e860f15SJohn Edward Broadbent asyncResp->res.jsonValue["@odata.type"] = 35257e860f15SJohn Edward Broadbent "#LogEntry.v1_4_0.LogEntry"; 3526a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 35270fda0f12SGeorge Liu "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3528a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3529a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3530a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3531a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3532a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 3533a3316fc6SZhikuiRen 3534a3316fc6SZhikuiRen getPostCodeForEntry(asyncResp, bootIndex, codeIndex); 35357e860f15SJohn Edward Broadbent }); 3536a3316fc6SZhikuiRen } 3537a3316fc6SZhikuiRen 35381da66f75SEd Tanous } // namespace redfish 3539