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 181da66f75SEd Tanous #include "node.hpp" 194851d45dSJason M. Bills #include "registries.hpp" 204851d45dSJason M. Bills #include "registries/base_message_registry.hpp" 214851d45dSJason M. Bills #include "registries/openbmc_message_registry.hpp" 2246229577SJames Feist #include "task.hpp" 231da66f75SEd Tanous 24e1f26343SJason M. Bills #include <systemd/sd-journal.h> 25e1f26343SJason M. Bills 264851d45dSJason M. Bills #include <boost/algorithm/string/split.hpp> 274851d45dSJason M. Bills #include <boost/beast/core/span.hpp> 281da66f75SEd Tanous #include <boost/container/flat_map.hpp> 291ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp> 30cb92c03bSAndrew Geissler #include <error_messages.hpp> 311214b7e7SGunnar Mills 324418c7f0SJames Feist #include <filesystem> 33cd225da8SJason M. Bills #include <string_view> 34abf2add6SEd Tanous #include <variant> 351da66f75SEd Tanous 361da66f75SEd Tanous namespace redfish 371da66f75SEd Tanous { 381da66f75SEd Tanous 395b61b5e8SJason M. Bills constexpr char const* crashdumpObject = "com.intel.crashdump"; 405b61b5e8SJason M. Bills constexpr char const* crashdumpPath = "/com/intel/crashdump"; 415b61b5e8SJason M. Bills constexpr char const* crashdumpInterface = "com.intel.crashdump"; 425b61b5e8SJason M. Bills constexpr char const* deleteAllInterface = 435b61b5e8SJason M. Bills "xyz.openbmc_project.Collection.DeleteAll"; 445b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandInterface = 45424c4176SJason M. Bills "com.intel.crashdump.OnDemand"; 465b61b5e8SJason M. Bills constexpr char const* crashdumpRawPECIInterface = 47424c4176SJason M. Bills "com.intel.crashdump.SendRawPeci"; 486eda7685SKenny L. Ku constexpr char const* crashdumpTelemetryInterface = 496eda7685SKenny L. Ku "com.intel.crashdump.Telemetry"; 501da66f75SEd Tanous 514851d45dSJason M. Bills namespace message_registries 524851d45dSJason M. Bills { 534851d45dSJason M. Bills static const Message* getMessageFromRegistry( 544851d45dSJason M. Bills const std::string& messageKey, 554851d45dSJason M. Bills const boost::beast::span<const MessageEntry> registry) 564851d45dSJason M. Bills { 574851d45dSJason M. Bills boost::beast::span<const MessageEntry>::const_iterator messageIt = 584851d45dSJason M. Bills std::find_if(registry.cbegin(), registry.cend(), 594851d45dSJason M. Bills [&messageKey](const MessageEntry& messageEntry) { 604851d45dSJason M. Bills return !std::strcmp(messageEntry.first, 614851d45dSJason M. Bills messageKey.c_str()); 624851d45dSJason M. Bills }); 634851d45dSJason M. Bills if (messageIt != registry.cend()) 644851d45dSJason M. Bills { 654851d45dSJason M. Bills return &messageIt->second; 664851d45dSJason M. Bills } 674851d45dSJason M. Bills 684851d45dSJason M. Bills return nullptr; 694851d45dSJason M. Bills } 704851d45dSJason M. Bills 714851d45dSJason M. Bills static const Message* getMessage(const std::string_view& messageID) 724851d45dSJason M. Bills { 734851d45dSJason M. Bills // Redfish MessageIds are in the form 744851d45dSJason M. Bills // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 754851d45dSJason M. Bills // the right Message 764851d45dSJason M. Bills std::vector<std::string> fields; 774851d45dSJason M. Bills fields.reserve(4); 784851d45dSJason M. Bills boost::split(fields, messageID, boost::is_any_of(".")); 794851d45dSJason M. Bills std::string& registryName = fields[0]; 804851d45dSJason M. Bills std::string& messageKey = fields[3]; 814851d45dSJason M. Bills 824851d45dSJason M. Bills // Find the right registry and check it for the MessageKey 834851d45dSJason M. Bills if (std::string(base::header.registryPrefix) == registryName) 844851d45dSJason M. Bills { 854851d45dSJason M. Bills return getMessageFromRegistry( 864851d45dSJason M. Bills messageKey, boost::beast::span<const MessageEntry>(base::registry)); 874851d45dSJason M. Bills } 884851d45dSJason M. Bills if (std::string(openbmc::header.registryPrefix) == registryName) 894851d45dSJason M. Bills { 904851d45dSJason M. Bills return getMessageFromRegistry( 914851d45dSJason M. Bills messageKey, 924851d45dSJason M. Bills boost::beast::span<const MessageEntry>(openbmc::registry)); 934851d45dSJason M. Bills } 944851d45dSJason M. Bills return nullptr; 954851d45dSJason M. Bills } 964851d45dSJason M. Bills } // namespace message_registries 974851d45dSJason M. Bills 98f6150403SJames Feist namespace fs = std::filesystem; 991da66f75SEd Tanous 100cb92c03bSAndrew Geissler using GetManagedPropertyType = boost::container::flat_map< 10119bd78d9SPatrick Williams std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t, 102cb92c03bSAndrew Geissler int32_t, uint32_t, int64_t, uint64_t, double>>; 103cb92c03bSAndrew Geissler 104cb92c03bSAndrew Geissler using GetManagedObjectsType = boost::container::flat_map< 105cb92c03bSAndrew Geissler sdbusplus::message::object_path, 106cb92c03bSAndrew Geissler boost::container::flat_map<std::string, GetManagedPropertyType>>; 107cb92c03bSAndrew Geissler 108cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s) 109cb92c03bSAndrew Geissler { 110cb92c03bSAndrew Geissler if (s == "xyz.openbmc_project.Logging.Entry.Level.Alert") 111cb92c03bSAndrew Geissler { 112cb92c03bSAndrew Geissler return "Critical"; 113cb92c03bSAndrew Geissler } 114cb92c03bSAndrew Geissler else if (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") 115cb92c03bSAndrew Geissler { 116cb92c03bSAndrew Geissler return "Critical"; 117cb92c03bSAndrew Geissler } 118cb92c03bSAndrew Geissler else if (s == "xyz.openbmc_project.Logging.Entry.Level.Debug") 119cb92c03bSAndrew Geissler { 120cb92c03bSAndrew Geissler return "OK"; 121cb92c03bSAndrew Geissler } 122cb92c03bSAndrew Geissler else if (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") 123cb92c03bSAndrew Geissler { 124cb92c03bSAndrew Geissler return "Critical"; 125cb92c03bSAndrew Geissler } 126cb92c03bSAndrew Geissler else if (s == "xyz.openbmc_project.Logging.Entry.Level.Error") 127cb92c03bSAndrew Geissler { 128cb92c03bSAndrew Geissler return "Critical"; 129cb92c03bSAndrew Geissler } 130cb92c03bSAndrew Geissler else if (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") 131cb92c03bSAndrew Geissler { 132cb92c03bSAndrew Geissler return "OK"; 133cb92c03bSAndrew Geissler } 134cb92c03bSAndrew Geissler else if (s == "xyz.openbmc_project.Logging.Entry.Level.Notice") 135cb92c03bSAndrew Geissler { 136cb92c03bSAndrew Geissler return "OK"; 137cb92c03bSAndrew Geissler } 138cb92c03bSAndrew Geissler else if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning") 139cb92c03bSAndrew Geissler { 140cb92c03bSAndrew Geissler return "Warning"; 141cb92c03bSAndrew Geissler } 142cb92c03bSAndrew Geissler return ""; 143cb92c03bSAndrew Geissler } 144cb92c03bSAndrew Geissler 14516428a1aSJason M. Bills static int getJournalMetadata(sd_journal* journal, 14639e77504SEd Tanous const std::string_view& field, 14739e77504SEd Tanous std::string_view& contents) 14816428a1aSJason M. Bills { 14916428a1aSJason M. Bills const char* data = nullptr; 15016428a1aSJason M. Bills size_t length = 0; 15116428a1aSJason M. Bills int ret = 0; 15216428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 153271584abSEd Tanous ret = sd_journal_get_data(journal, field.data(), 154271584abSEd Tanous reinterpret_cast<const void**>(&data), &length); 15516428a1aSJason M. Bills if (ret < 0) 15616428a1aSJason M. Bills { 15716428a1aSJason M. Bills return ret; 15816428a1aSJason M. Bills } 15939e77504SEd Tanous contents = std::string_view(data, length); 16016428a1aSJason M. Bills // Only use the content after the "=" character. 16116428a1aSJason M. Bills contents.remove_prefix(std::min(contents.find("=") + 1, contents.size())); 16216428a1aSJason M. Bills return ret; 16316428a1aSJason M. Bills } 16416428a1aSJason M. Bills 16516428a1aSJason M. Bills static int getJournalMetadata(sd_journal* journal, 16639e77504SEd Tanous const std::string_view& field, const int& base, 167271584abSEd Tanous long int& contents) 16816428a1aSJason M. Bills { 16916428a1aSJason M. Bills int ret = 0; 17039e77504SEd Tanous std::string_view metadata; 17116428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 17216428a1aSJason M. Bills ret = getJournalMetadata(journal, field, metadata); 17316428a1aSJason M. Bills if (ret < 0) 17416428a1aSJason M. Bills { 17516428a1aSJason M. Bills return ret; 17616428a1aSJason M. Bills } 177b01bf299SEd Tanous contents = strtol(metadata.data(), nullptr, base); 17816428a1aSJason M. Bills return ret; 17916428a1aSJason M. Bills } 18016428a1aSJason M. Bills 181a3316fc6SZhikuiRen static bool getEntryTimestamp(sd_journal* journal, std::string& entryTimestamp) 182a3316fc6SZhikuiRen { 183a3316fc6SZhikuiRen int ret = 0; 184a3316fc6SZhikuiRen uint64_t timestamp = 0; 185a3316fc6SZhikuiRen ret = sd_journal_get_realtime_usec(journal, ×tamp); 186a3316fc6SZhikuiRen if (ret < 0) 187a3316fc6SZhikuiRen { 188a3316fc6SZhikuiRen BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 189a3316fc6SZhikuiRen << strerror(-ret); 190a3316fc6SZhikuiRen return false; 191a3316fc6SZhikuiRen } 1929c620e21SAsmitha Karunanithi entryTimestamp = crow::utility::getDateTime( 1939c620e21SAsmitha Karunanithi static_cast<std::time_t>(timestamp / 1000 / 1000)); 1949c620e21SAsmitha Karunanithi return true; 195a3316fc6SZhikuiRen } 196a3316fc6SZhikuiRen 19716428a1aSJason M. Bills static bool getSkipParam(crow::Response& res, const crow::Request& req, 198271584abSEd Tanous uint64_t& skip) 19916428a1aSJason M. Bills { 2005a7e877eSJames Feist boost::urls::url_view::params_type::iterator it = 2015a7e877eSJames Feist req.urlParams.find("$skip"); 2025a7e877eSJames Feist if (it != req.urlParams.end()) 20316428a1aSJason M. Bills { 2045a7e877eSJames Feist std::string skipParam = it->value(); 20516428a1aSJason M. Bills char* ptr = nullptr; 2065a7e877eSJames Feist skip = std::strtoul(skipParam.c_str(), &ptr, 10); 2075a7e877eSJames Feist if (skipParam.empty() || *ptr != '\0') 20816428a1aSJason M. Bills { 20916428a1aSJason M. Bills 21016428a1aSJason M. Bills messages::queryParameterValueTypeError(res, std::string(skipParam), 21116428a1aSJason M. Bills "$skip"); 21216428a1aSJason M. Bills return false; 21316428a1aSJason M. Bills } 21416428a1aSJason M. Bills } 21516428a1aSJason M. Bills return true; 21616428a1aSJason M. Bills } 21716428a1aSJason M. Bills 218271584abSEd Tanous static constexpr const uint64_t maxEntriesPerPage = 1000; 21916428a1aSJason M. Bills static bool getTopParam(crow::Response& res, const crow::Request& req, 220271584abSEd Tanous uint64_t& top) 22116428a1aSJason M. Bills { 2225a7e877eSJames Feist boost::urls::url_view::params_type::iterator it = 2235a7e877eSJames Feist req.urlParams.find("$top"); 2245a7e877eSJames Feist if (it != req.urlParams.end()) 22516428a1aSJason M. Bills { 2265a7e877eSJames Feist std::string topParam = it->value(); 22716428a1aSJason M. Bills char* ptr = nullptr; 2285a7e877eSJames Feist top = std::strtoul(topParam.c_str(), &ptr, 10); 2295a7e877eSJames Feist if (topParam.empty() || *ptr != '\0') 23016428a1aSJason M. Bills { 23116428a1aSJason M. Bills messages::queryParameterValueTypeError(res, std::string(topParam), 23216428a1aSJason M. Bills "$top"); 23316428a1aSJason M. Bills return false; 23416428a1aSJason M. Bills } 235271584abSEd Tanous if (top < 1U || top > maxEntriesPerPage) 23616428a1aSJason M. Bills { 23716428a1aSJason M. Bills 23816428a1aSJason M. Bills messages::queryParameterOutOfRange( 23916428a1aSJason M. Bills res, std::to_string(top), "$top", 24016428a1aSJason M. Bills "1-" + std::to_string(maxEntriesPerPage)); 24116428a1aSJason M. Bills return false; 24216428a1aSJason M. Bills } 24316428a1aSJason M. Bills } 24416428a1aSJason M. Bills return true; 24516428a1aSJason M. Bills } 24616428a1aSJason M. Bills 247e85d6b16SJason M. Bills static bool getUniqueEntryID(sd_journal* journal, std::string& entryID, 248e85d6b16SJason M. Bills const bool firstEntry = true) 24916428a1aSJason M. Bills { 25016428a1aSJason M. Bills int ret = 0; 25116428a1aSJason M. Bills static uint64_t prevTs = 0; 25216428a1aSJason M. Bills static int index = 0; 253e85d6b16SJason M. Bills if (firstEntry) 254e85d6b16SJason M. Bills { 255e85d6b16SJason M. Bills prevTs = 0; 256e85d6b16SJason M. Bills } 257e85d6b16SJason M. Bills 25816428a1aSJason M. Bills // Get the entry timestamp 25916428a1aSJason M. Bills uint64_t curTs = 0; 26016428a1aSJason M. Bills ret = sd_journal_get_realtime_usec(journal, &curTs); 26116428a1aSJason M. Bills if (ret < 0) 26216428a1aSJason M. Bills { 26316428a1aSJason M. Bills BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 26416428a1aSJason M. Bills << strerror(-ret); 26516428a1aSJason M. Bills return false; 26616428a1aSJason M. Bills } 26716428a1aSJason M. Bills // If the timestamp isn't unique, increment the index 26816428a1aSJason M. Bills if (curTs == prevTs) 26916428a1aSJason M. Bills { 27016428a1aSJason M. Bills index++; 27116428a1aSJason M. Bills } 27216428a1aSJason M. Bills else 27316428a1aSJason M. Bills { 27416428a1aSJason M. Bills // Otherwise, reset it 27516428a1aSJason M. Bills index = 0; 27616428a1aSJason M. Bills } 27716428a1aSJason M. Bills // Save the timestamp 27816428a1aSJason M. Bills prevTs = curTs; 27916428a1aSJason M. Bills 28016428a1aSJason M. Bills entryID = std::to_string(curTs); 28116428a1aSJason M. Bills if (index > 0) 28216428a1aSJason M. Bills { 28316428a1aSJason M. Bills entryID += "_" + std::to_string(index); 28416428a1aSJason M. Bills } 28516428a1aSJason M. Bills return true; 28616428a1aSJason M. Bills } 28716428a1aSJason M. Bills 288e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID, 289e85d6b16SJason M. Bills const bool firstEntry = true) 29095820184SJason M. Bills { 291271584abSEd Tanous static time_t prevTs = 0; 29295820184SJason M. Bills static int index = 0; 293e85d6b16SJason M. Bills if (firstEntry) 294e85d6b16SJason M. Bills { 295e85d6b16SJason M. Bills prevTs = 0; 296e85d6b16SJason M. Bills } 297e85d6b16SJason M. Bills 29895820184SJason M. Bills // Get the entry timestamp 299271584abSEd Tanous std::time_t curTs = 0; 30095820184SJason M. Bills std::tm timeStruct = {}; 30195820184SJason M. Bills std::istringstream entryStream(logEntry); 30295820184SJason M. Bills if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 30395820184SJason M. Bills { 30495820184SJason M. Bills curTs = std::mktime(&timeStruct); 30595820184SJason M. Bills } 30695820184SJason M. Bills // If the timestamp isn't unique, increment the index 30795820184SJason M. Bills if (curTs == prevTs) 30895820184SJason M. Bills { 30995820184SJason M. Bills index++; 31095820184SJason M. Bills } 31195820184SJason M. Bills else 31295820184SJason M. Bills { 31395820184SJason M. Bills // Otherwise, reset it 31495820184SJason M. Bills index = 0; 31595820184SJason M. Bills } 31695820184SJason M. Bills // Save the timestamp 31795820184SJason M. Bills prevTs = curTs; 31895820184SJason M. Bills 31995820184SJason M. Bills entryID = std::to_string(curTs); 32095820184SJason M. Bills if (index > 0) 32195820184SJason M. Bills { 32295820184SJason M. Bills entryID += "_" + std::to_string(index); 32395820184SJason M. Bills } 32495820184SJason M. Bills return true; 32595820184SJason M. Bills } 32695820184SJason M. Bills 32716428a1aSJason M. Bills static bool getTimestampFromID(crow::Response& res, const std::string& entryID, 328271584abSEd Tanous uint64_t& timestamp, uint64_t& index) 32916428a1aSJason M. Bills { 33016428a1aSJason M. Bills if (entryID.empty()) 33116428a1aSJason M. Bills { 33216428a1aSJason M. Bills return false; 33316428a1aSJason M. Bills } 33416428a1aSJason M. Bills // Convert the unique ID back to a timestamp to find the entry 33539e77504SEd Tanous std::string_view tsStr(entryID); 33616428a1aSJason M. Bills 33716428a1aSJason M. Bills auto underscorePos = tsStr.find("_"); 33816428a1aSJason M. Bills if (underscorePos != tsStr.npos) 33916428a1aSJason M. Bills { 34016428a1aSJason M. Bills // Timestamp has an index 34116428a1aSJason M. Bills tsStr.remove_suffix(tsStr.size() - underscorePos); 34239e77504SEd Tanous std::string_view indexStr(entryID); 34316428a1aSJason M. Bills indexStr.remove_prefix(underscorePos + 1); 34416428a1aSJason M. Bills std::size_t pos; 34516428a1aSJason M. Bills try 34616428a1aSJason M. Bills { 34739e77504SEd Tanous index = std::stoul(std::string(indexStr), &pos); 34816428a1aSJason M. Bills } 349271584abSEd Tanous catch (std::invalid_argument&) 35016428a1aSJason M. Bills { 35116428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 35216428a1aSJason M. Bills return false; 35316428a1aSJason M. Bills } 354271584abSEd Tanous catch (std::out_of_range&) 35516428a1aSJason M. Bills { 35616428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 35716428a1aSJason M. Bills return false; 35816428a1aSJason M. Bills } 35916428a1aSJason M. Bills if (pos != indexStr.size()) 36016428a1aSJason M. Bills { 36116428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 36216428a1aSJason M. Bills return false; 36316428a1aSJason M. Bills } 36416428a1aSJason M. Bills } 36516428a1aSJason M. Bills // Timestamp has no index 36616428a1aSJason M. Bills std::size_t pos; 36716428a1aSJason M. Bills try 36816428a1aSJason M. Bills { 36939e77504SEd Tanous timestamp = std::stoull(std::string(tsStr), &pos); 37016428a1aSJason M. Bills } 371271584abSEd Tanous catch (std::invalid_argument&) 37216428a1aSJason M. Bills { 37316428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 37416428a1aSJason M. Bills return false; 37516428a1aSJason M. Bills } 376271584abSEd Tanous catch (std::out_of_range&) 37716428a1aSJason M. Bills { 37816428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 37916428a1aSJason M. Bills return false; 38016428a1aSJason M. Bills } 38116428a1aSJason M. Bills if (pos != tsStr.size()) 38216428a1aSJason M. Bills { 38316428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 38416428a1aSJason M. Bills return false; 38516428a1aSJason M. Bills } 38616428a1aSJason M. Bills return true; 38716428a1aSJason M. Bills } 38816428a1aSJason M. Bills 38995820184SJason M. Bills static bool 39095820184SJason M. Bills getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles) 39195820184SJason M. Bills { 39295820184SJason M. Bills static const std::filesystem::path redfishLogDir = "/var/log"; 39395820184SJason M. Bills static const std::string redfishLogFilename = "redfish"; 39495820184SJason M. Bills 39595820184SJason M. Bills // Loop through the directory looking for redfish log files 39695820184SJason M. Bills for (const std::filesystem::directory_entry& dirEnt : 39795820184SJason M. Bills std::filesystem::directory_iterator(redfishLogDir)) 39895820184SJason M. Bills { 39995820184SJason M. Bills // If we find a redfish log file, save the path 40095820184SJason M. Bills std::string filename = dirEnt.path().filename(); 40195820184SJason M. Bills if (boost::starts_with(filename, redfishLogFilename)) 40295820184SJason M. Bills { 40395820184SJason M. Bills redfishLogFiles.emplace_back(redfishLogDir / filename); 40495820184SJason M. Bills } 40595820184SJason M. Bills } 40695820184SJason M. Bills // As the log files rotate, they are appended with a ".#" that is higher for 40795820184SJason M. Bills // the older logs. Since we don't expect more than 10 log files, we 40895820184SJason M. Bills // can just sort the list to get them in order from newest to oldest 40995820184SJason M. Bills std::sort(redfishLogFiles.begin(), redfishLogFiles.end()); 41095820184SJason M. Bills 41195820184SJason M. Bills return !redfishLogFiles.empty(); 41295820184SJason M. Bills } 41395820184SJason M. Bills 4145cb1dd27SAsmitha Karunanithi inline void getDumpEntryCollection(std::shared_ptr<AsyncResp>& asyncResp, 4155cb1dd27SAsmitha Karunanithi const std::string& dumpType) 4165cb1dd27SAsmitha Karunanithi { 4175cb1dd27SAsmitha Karunanithi std::string dumpPath; 4185cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 4195cb1dd27SAsmitha Karunanithi { 4205cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 4215cb1dd27SAsmitha Karunanithi } 4225cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 4235cb1dd27SAsmitha Karunanithi { 4245cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 4255cb1dd27SAsmitha Karunanithi } 4265cb1dd27SAsmitha Karunanithi else 4275cb1dd27SAsmitha Karunanithi { 4285cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType; 4295cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4305cb1dd27SAsmitha Karunanithi return; 4315cb1dd27SAsmitha Karunanithi } 4325cb1dd27SAsmitha Karunanithi 4335cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 4345cb1dd27SAsmitha Karunanithi [asyncResp, dumpPath, dumpType](const boost::system::error_code ec, 4355cb1dd27SAsmitha Karunanithi GetManagedObjectsType& resp) { 4365cb1dd27SAsmitha Karunanithi if (ec) 4375cb1dd27SAsmitha Karunanithi { 4385cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 4395cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4405cb1dd27SAsmitha Karunanithi return; 4415cb1dd27SAsmitha Karunanithi } 4425cb1dd27SAsmitha Karunanithi 4435cb1dd27SAsmitha Karunanithi nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"]; 4445cb1dd27SAsmitha Karunanithi entriesArray = nlohmann::json::array(); 4455cb1dd27SAsmitha Karunanithi 4465cb1dd27SAsmitha Karunanithi for (auto& object : resp) 4475cb1dd27SAsmitha Karunanithi { 4485cb1dd27SAsmitha Karunanithi bool foundDumpEntry = false; 4495cb1dd27SAsmitha Karunanithi for (auto& interfaceMap : object.second) 4505cb1dd27SAsmitha Karunanithi { 4515cb1dd27SAsmitha Karunanithi if (interfaceMap.first == 4525cb1dd27SAsmitha Karunanithi ("xyz.openbmc_project.Dump.Entry." + dumpType)) 4535cb1dd27SAsmitha Karunanithi { 4545cb1dd27SAsmitha Karunanithi foundDumpEntry = true; 4555cb1dd27SAsmitha Karunanithi break; 4565cb1dd27SAsmitha Karunanithi } 4575cb1dd27SAsmitha Karunanithi } 4585cb1dd27SAsmitha Karunanithi 4595cb1dd27SAsmitha Karunanithi if (foundDumpEntry == false) 4605cb1dd27SAsmitha Karunanithi { 4615cb1dd27SAsmitha Karunanithi continue; 4625cb1dd27SAsmitha Karunanithi } 4635cb1dd27SAsmitha Karunanithi std::time_t timestamp; 4645cb1dd27SAsmitha Karunanithi uint64_t size = 0; 4655cb1dd27SAsmitha Karunanithi entriesArray.push_back({}); 4665cb1dd27SAsmitha Karunanithi nlohmann::json& thisEntry = entriesArray.back(); 4675cb1dd27SAsmitha Karunanithi const std::string& path = 4685cb1dd27SAsmitha Karunanithi static_cast<const std::string&>(object.first); 4695cb1dd27SAsmitha Karunanithi std::size_t lastPos = path.rfind("/"); 4705cb1dd27SAsmitha Karunanithi if (lastPos == std::string::npos) 4715cb1dd27SAsmitha Karunanithi { 4725cb1dd27SAsmitha Karunanithi continue; 4735cb1dd27SAsmitha Karunanithi } 4745cb1dd27SAsmitha Karunanithi std::string entryID = path.substr(lastPos + 1); 4755cb1dd27SAsmitha Karunanithi 4765cb1dd27SAsmitha Karunanithi for (auto& interfaceMap : object.second) 4775cb1dd27SAsmitha Karunanithi { 4785cb1dd27SAsmitha Karunanithi if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") 4795cb1dd27SAsmitha Karunanithi { 4805cb1dd27SAsmitha Karunanithi 4815cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 4825cb1dd27SAsmitha Karunanithi { 4835cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Size") 4845cb1dd27SAsmitha Karunanithi { 4855cb1dd27SAsmitha Karunanithi auto sizePtr = 4865cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 4875cb1dd27SAsmitha Karunanithi if (sizePtr == nullptr) 4885cb1dd27SAsmitha Karunanithi { 4895cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4905cb1dd27SAsmitha Karunanithi break; 4915cb1dd27SAsmitha Karunanithi } 4925cb1dd27SAsmitha Karunanithi size = *sizePtr; 4935cb1dd27SAsmitha Karunanithi break; 4945cb1dd27SAsmitha Karunanithi } 4955cb1dd27SAsmitha Karunanithi } 4965cb1dd27SAsmitha Karunanithi } 4975cb1dd27SAsmitha Karunanithi else if (interfaceMap.first == 4985cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Time.EpochTime") 4995cb1dd27SAsmitha Karunanithi { 5005cb1dd27SAsmitha Karunanithi 5015cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 5025cb1dd27SAsmitha Karunanithi { 5035cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Elapsed") 5045cb1dd27SAsmitha Karunanithi { 5055cb1dd27SAsmitha Karunanithi const uint64_t* usecsTimeStamp = 5065cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 5075cb1dd27SAsmitha Karunanithi if (usecsTimeStamp == nullptr) 5085cb1dd27SAsmitha Karunanithi { 5095cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5105cb1dd27SAsmitha Karunanithi break; 5115cb1dd27SAsmitha Karunanithi } 5125cb1dd27SAsmitha Karunanithi timestamp = 5135cb1dd27SAsmitha Karunanithi static_cast<std::time_t>(*usecsTimeStamp); 5145cb1dd27SAsmitha Karunanithi break; 5155cb1dd27SAsmitha Karunanithi } 5165cb1dd27SAsmitha Karunanithi } 5175cb1dd27SAsmitha Karunanithi } 5185cb1dd27SAsmitha Karunanithi } 5195cb1dd27SAsmitha Karunanithi 520d337bb72SAsmitha Karunanithi thisEntry["@odata.type"] = "#LogEntry.v1_7_0.LogEntry"; 5215cb1dd27SAsmitha Karunanithi thisEntry["@odata.id"] = dumpPath + entryID; 5225cb1dd27SAsmitha Karunanithi thisEntry["Id"] = entryID; 5235cb1dd27SAsmitha Karunanithi thisEntry["EntryType"] = "Event"; 5245cb1dd27SAsmitha Karunanithi thisEntry["Created"] = crow::utility::getDateTime(timestamp); 5255cb1dd27SAsmitha Karunanithi thisEntry["Name"] = dumpType + " Dump Entry"; 5265cb1dd27SAsmitha Karunanithi 527d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataSizeBytes"] = size; 5285cb1dd27SAsmitha Karunanithi 5295cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 5305cb1dd27SAsmitha Karunanithi { 531d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "Manager"; 532d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataURI"] = 533d337bb72SAsmitha Karunanithi "/redfish/v1/Managers/bmc/LogServices/Dump/" 534d337bb72SAsmitha Karunanithi "attachment/" + 535d337bb72SAsmitha Karunanithi entryID; 5365cb1dd27SAsmitha Karunanithi } 5375cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 5385cb1dd27SAsmitha Karunanithi { 539d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "OEM"; 540d337bb72SAsmitha Karunanithi thisEntry["OEMDiagnosticDataType"] = "System"; 541d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataURI"] = 542d337bb72SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump/" 543d337bb72SAsmitha Karunanithi "attachment/" + 544d337bb72SAsmitha Karunanithi entryID; 5455cb1dd27SAsmitha Karunanithi } 5465cb1dd27SAsmitha Karunanithi } 5475cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Members@odata.count"] = 5485cb1dd27SAsmitha Karunanithi entriesArray.size(); 5495cb1dd27SAsmitha Karunanithi }, 5505cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 5515cb1dd27SAsmitha Karunanithi "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 5525cb1dd27SAsmitha Karunanithi } 5535cb1dd27SAsmitha Karunanithi 5545cb1dd27SAsmitha Karunanithi inline void getDumpEntryById(std::shared_ptr<AsyncResp>& asyncResp, 5555cb1dd27SAsmitha Karunanithi const std::string& entryID, 5565cb1dd27SAsmitha Karunanithi const std::string& dumpType) 5575cb1dd27SAsmitha Karunanithi { 5585cb1dd27SAsmitha Karunanithi std::string dumpPath; 5595cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 5605cb1dd27SAsmitha Karunanithi { 5615cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 5625cb1dd27SAsmitha Karunanithi } 5635cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 5645cb1dd27SAsmitha Karunanithi { 5655cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 5665cb1dd27SAsmitha Karunanithi } 5675cb1dd27SAsmitha Karunanithi else 5685cb1dd27SAsmitha Karunanithi { 5695cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType; 5705cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5715cb1dd27SAsmitha Karunanithi return; 5725cb1dd27SAsmitha Karunanithi } 5735cb1dd27SAsmitha Karunanithi 5745cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 5755cb1dd27SAsmitha Karunanithi [asyncResp, entryID, dumpPath, dumpType]( 5765cb1dd27SAsmitha Karunanithi const boost::system::error_code ec, GetManagedObjectsType& resp) { 5775cb1dd27SAsmitha Karunanithi if (ec) 5785cb1dd27SAsmitha Karunanithi { 5795cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 5805cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5815cb1dd27SAsmitha Karunanithi return; 5825cb1dd27SAsmitha Karunanithi } 5835cb1dd27SAsmitha Karunanithi 5845cb1dd27SAsmitha Karunanithi for (auto& objectPath : resp) 5855cb1dd27SAsmitha Karunanithi { 5865cb1dd27SAsmitha Karunanithi if (objectPath.first.str.find( 5875cb1dd27SAsmitha Karunanithi "/xyz/openbmc_project/dump/entry/" + entryID) == 5885cb1dd27SAsmitha Karunanithi std::string::npos) 5895cb1dd27SAsmitha Karunanithi { 5905cb1dd27SAsmitha Karunanithi continue; 5915cb1dd27SAsmitha Karunanithi } 5925cb1dd27SAsmitha Karunanithi 5935cb1dd27SAsmitha Karunanithi bool foundDumpEntry = false; 5945cb1dd27SAsmitha Karunanithi for (auto& interfaceMap : objectPath.second) 5955cb1dd27SAsmitha Karunanithi { 5965cb1dd27SAsmitha Karunanithi if (interfaceMap.first == 5975cb1dd27SAsmitha Karunanithi ("xyz.openbmc_project.Dump.Entry." + dumpType)) 5985cb1dd27SAsmitha Karunanithi { 5995cb1dd27SAsmitha Karunanithi foundDumpEntry = true; 6005cb1dd27SAsmitha Karunanithi break; 6015cb1dd27SAsmitha Karunanithi } 6025cb1dd27SAsmitha Karunanithi } 6035cb1dd27SAsmitha Karunanithi if (foundDumpEntry == false) 6045cb1dd27SAsmitha Karunanithi { 6055cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Can't find Dump Entry"; 6065cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6075cb1dd27SAsmitha Karunanithi return; 6085cb1dd27SAsmitha Karunanithi } 6095cb1dd27SAsmitha Karunanithi 6105cb1dd27SAsmitha Karunanithi std::time_t timestamp; 6115cb1dd27SAsmitha Karunanithi uint64_t size = 0; 6125cb1dd27SAsmitha Karunanithi 6135cb1dd27SAsmitha Karunanithi for (auto& interfaceMap : objectPath.second) 6145cb1dd27SAsmitha Karunanithi { 6155cb1dd27SAsmitha Karunanithi if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") 6165cb1dd27SAsmitha Karunanithi { 6175cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 6185cb1dd27SAsmitha Karunanithi { 6195cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Size") 6205cb1dd27SAsmitha Karunanithi { 6215cb1dd27SAsmitha Karunanithi auto sizePtr = 6225cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 6235cb1dd27SAsmitha Karunanithi if (sizePtr == nullptr) 6245cb1dd27SAsmitha Karunanithi { 6255cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6265cb1dd27SAsmitha Karunanithi break; 6275cb1dd27SAsmitha Karunanithi } 6285cb1dd27SAsmitha Karunanithi size = *sizePtr; 6295cb1dd27SAsmitha Karunanithi break; 6305cb1dd27SAsmitha Karunanithi } 6315cb1dd27SAsmitha Karunanithi } 6325cb1dd27SAsmitha Karunanithi } 6335cb1dd27SAsmitha Karunanithi else if (interfaceMap.first == 6345cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Time.EpochTime") 6355cb1dd27SAsmitha Karunanithi { 6365cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 6375cb1dd27SAsmitha Karunanithi { 6385cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Elapsed") 6395cb1dd27SAsmitha Karunanithi { 6405cb1dd27SAsmitha Karunanithi const uint64_t* usecsTimeStamp = 6415cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 6425cb1dd27SAsmitha Karunanithi if (usecsTimeStamp == nullptr) 6435cb1dd27SAsmitha Karunanithi { 6445cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6455cb1dd27SAsmitha Karunanithi break; 6465cb1dd27SAsmitha Karunanithi } 6475cb1dd27SAsmitha Karunanithi timestamp = 6485cb1dd27SAsmitha Karunanithi static_cast<std::time_t>(*usecsTimeStamp); 6495cb1dd27SAsmitha Karunanithi break; 6505cb1dd27SAsmitha Karunanithi } 6515cb1dd27SAsmitha Karunanithi } 6525cb1dd27SAsmitha Karunanithi } 6535cb1dd27SAsmitha Karunanithi } 6545cb1dd27SAsmitha Karunanithi 6555cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 656d337bb72SAsmitha Karunanithi "#LogEntry.v1_7_0.LogEntry"; 6575cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.id"] = dumpPath + entryID; 6585cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = entryID; 6595cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["EntryType"] = "Event"; 6605cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Created"] = 6615cb1dd27SAsmitha Karunanithi crow::utility::getDateTime(timestamp); 6625cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry"; 6635cb1dd27SAsmitha Karunanithi 664d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 6655cb1dd27SAsmitha Karunanithi 6665cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 6675cb1dd27SAsmitha Karunanithi { 668d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager"; 669d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 6705cb1dd27SAsmitha Karunanithi "/redfish/v1/Managers/bmc/LogServices/Dump/" 6715cb1dd27SAsmitha Karunanithi "attachment/" + 6725cb1dd27SAsmitha Karunanithi entryID; 6735cb1dd27SAsmitha Karunanithi } 6745cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 6755cb1dd27SAsmitha Karunanithi { 676d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM"; 677d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["OEMDiagnosticDataType"] = 6785cb1dd27SAsmitha Karunanithi "System"; 679d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 6805cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump/" 6815cb1dd27SAsmitha Karunanithi "attachment/" + 6825cb1dd27SAsmitha Karunanithi entryID; 6835cb1dd27SAsmitha Karunanithi } 6845cb1dd27SAsmitha Karunanithi } 6855cb1dd27SAsmitha Karunanithi }, 6865cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 6875cb1dd27SAsmitha Karunanithi "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 6885cb1dd27SAsmitha Karunanithi } 6895cb1dd27SAsmitha Karunanithi 6905cb1dd27SAsmitha Karunanithi inline void deleteDumpEntry(crow::Response& res, const std::string& entryID) 6915cb1dd27SAsmitha Karunanithi { 6925cb1dd27SAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 6935cb1dd27SAsmitha Karunanithi 6945cb1dd27SAsmitha Karunanithi auto respHandler = [asyncResp](const boost::system::error_code ec) { 6955cb1dd27SAsmitha Karunanithi BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done"; 6965cb1dd27SAsmitha Karunanithi if (ec) 6975cb1dd27SAsmitha Karunanithi { 6985cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error " 6995cb1dd27SAsmitha Karunanithi << ec; 7005cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 7015cb1dd27SAsmitha Karunanithi return; 7025cb1dd27SAsmitha Karunanithi } 7035cb1dd27SAsmitha Karunanithi }; 7045cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 7055cb1dd27SAsmitha Karunanithi respHandler, "xyz.openbmc_project.Dump.Manager", 7065cb1dd27SAsmitha Karunanithi "/xyz/openbmc_project/dump/entry/" + entryID, 7075cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Object.Delete", "Delete"); 7085cb1dd27SAsmitha Karunanithi } 7095cb1dd27SAsmitha Karunanithi 710a43be80fSAsmitha Karunanithi inline void createDumpTaskCallback(const crow::Request& req, 711a43be80fSAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp, 712a43be80fSAsmitha Karunanithi const uint32_t& dumpId, 713a43be80fSAsmitha Karunanithi const std::string& dumpPath, 714a43be80fSAsmitha Karunanithi const std::string& dumpType) 715a43be80fSAsmitha Karunanithi { 716a43be80fSAsmitha Karunanithi std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 717*6145ed6fSAsmitha Karunanithi [dumpId, dumpPath, dumpType]( 718a43be80fSAsmitha Karunanithi boost::system::error_code err, sdbusplus::message::message& m, 719a43be80fSAsmitha Karunanithi const std::shared_ptr<task::TaskData>& taskData) { 720cb13a392SEd Tanous if (err) 721cb13a392SEd Tanous { 722*6145ed6fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Error in creating a dump"; 723*6145ed6fSAsmitha Karunanithi taskData->state = "Cancelled"; 724*6145ed6fSAsmitha Karunanithi return task::completed; 725cb13a392SEd Tanous } 726a43be80fSAsmitha Karunanithi std::vector<std::pair< 727a43be80fSAsmitha Karunanithi std::string, 728a43be80fSAsmitha Karunanithi std::vector<std::pair<std::string, std::variant<std::string>>>>> 729a43be80fSAsmitha Karunanithi interfacesList; 730a43be80fSAsmitha Karunanithi 731a43be80fSAsmitha Karunanithi sdbusplus::message::object_path objPath; 732a43be80fSAsmitha Karunanithi 733a43be80fSAsmitha Karunanithi m.read(objPath, interfacesList); 734a43be80fSAsmitha Karunanithi 735a43be80fSAsmitha Karunanithi for (auto& interface : interfacesList) 736a43be80fSAsmitha Karunanithi { 737a43be80fSAsmitha Karunanithi if (interface.first == 738a43be80fSAsmitha Karunanithi ("xyz.openbmc_project.Dump.Entry." + dumpType)) 739a43be80fSAsmitha Karunanithi { 740a43be80fSAsmitha Karunanithi nlohmann::json retMessage = messages::success(); 741a43be80fSAsmitha Karunanithi taskData->messages.emplace_back(retMessage); 742a43be80fSAsmitha Karunanithi 743a43be80fSAsmitha Karunanithi std::string headerLoc = 744a43be80fSAsmitha Karunanithi "Location: " + dumpPath + std::to_string(dumpId); 745a43be80fSAsmitha Karunanithi taskData->payload->httpHeaders.emplace_back( 746a43be80fSAsmitha Karunanithi std::move(headerLoc)); 747a43be80fSAsmitha Karunanithi 748a43be80fSAsmitha Karunanithi taskData->state = "Completed"; 749*6145ed6fSAsmitha Karunanithi break; 750*6145ed6fSAsmitha Karunanithi } 751*6145ed6fSAsmitha Karunanithi } 752a43be80fSAsmitha Karunanithi return task::completed; 753a43be80fSAsmitha Karunanithi }, 754a43be80fSAsmitha Karunanithi "type='signal',interface='org.freedesktop.DBus." 755a43be80fSAsmitha Karunanithi "ObjectManager'," 756a43be80fSAsmitha Karunanithi "member='InterfacesAdded', " 757a43be80fSAsmitha Karunanithi "path='/xyz/openbmc_project/dump'"); 758a43be80fSAsmitha Karunanithi 759a43be80fSAsmitha Karunanithi task->startTimer(std::chrono::minutes(3)); 760a43be80fSAsmitha Karunanithi task->populateResp(asyncResp->res); 761a43be80fSAsmitha Karunanithi task->payload.emplace(req); 762a43be80fSAsmitha Karunanithi } 763a43be80fSAsmitha Karunanithi 764a43be80fSAsmitha Karunanithi inline void createDump(crow::Response& res, const crow::Request& req, 765a43be80fSAsmitha Karunanithi const std::string& dumpType) 766a43be80fSAsmitha Karunanithi { 767a43be80fSAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 768a43be80fSAsmitha Karunanithi 769a43be80fSAsmitha Karunanithi std::string dumpPath; 770a43be80fSAsmitha Karunanithi if (dumpType == "BMC") 771a43be80fSAsmitha Karunanithi { 772a43be80fSAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 773a43be80fSAsmitha Karunanithi } 774a43be80fSAsmitha Karunanithi else if (dumpType == "System") 775a43be80fSAsmitha Karunanithi { 776a43be80fSAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 777a43be80fSAsmitha Karunanithi } 778a43be80fSAsmitha Karunanithi else 779a43be80fSAsmitha Karunanithi { 780a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Invalid dump type: " << dumpType; 781a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 782a43be80fSAsmitha Karunanithi return; 783a43be80fSAsmitha Karunanithi } 784a43be80fSAsmitha Karunanithi 785a43be80fSAsmitha Karunanithi std::optional<std::string> diagnosticDataType; 786a43be80fSAsmitha Karunanithi std::optional<std::string> oemDiagnosticDataType; 787a43be80fSAsmitha Karunanithi 788a43be80fSAsmitha Karunanithi if (!redfish::json_util::readJson( 789a43be80fSAsmitha Karunanithi req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 790a43be80fSAsmitha Karunanithi "OEMDiagnosticDataType", oemDiagnosticDataType)) 791a43be80fSAsmitha Karunanithi { 792a43be80fSAsmitha Karunanithi return; 793a43be80fSAsmitha Karunanithi } 794a43be80fSAsmitha Karunanithi 795a43be80fSAsmitha Karunanithi if (dumpType == "System") 796a43be80fSAsmitha Karunanithi { 797a43be80fSAsmitha Karunanithi if (!oemDiagnosticDataType || !diagnosticDataType) 798a43be80fSAsmitha Karunanithi { 799a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump action parameter " 800a43be80fSAsmitha Karunanithi "'DiagnosticDataType'/" 801a43be80fSAsmitha Karunanithi "'OEMDiagnosticDataType' value not found!"; 802a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 803a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", 804a43be80fSAsmitha Karunanithi "DiagnosticDataType & OEMDiagnosticDataType"); 805a43be80fSAsmitha Karunanithi return; 806a43be80fSAsmitha Karunanithi } 807a43be80fSAsmitha Karunanithi else if ((*oemDiagnosticDataType != "System") || 808a43be80fSAsmitha Karunanithi (*diagnosticDataType != "OEM")) 809a43be80fSAsmitha Karunanithi { 810a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Wrong parameter values passed"; 811a43be80fSAsmitha Karunanithi messages::invalidObject(asyncResp->res, 812a43be80fSAsmitha Karunanithi "System Dump creation parameters"); 813a43be80fSAsmitha Karunanithi return; 814a43be80fSAsmitha Karunanithi } 815a43be80fSAsmitha Karunanithi } 816a43be80fSAsmitha Karunanithi else if (dumpType == "BMC") 817a43be80fSAsmitha Karunanithi { 818a43be80fSAsmitha Karunanithi if (!diagnosticDataType) 819a43be80fSAsmitha Karunanithi { 820a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump action parameter " 821a43be80fSAsmitha Karunanithi "'DiagnosticDataType' not found!"; 822a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 823a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType"); 824a43be80fSAsmitha Karunanithi return; 825a43be80fSAsmitha Karunanithi } 826a43be80fSAsmitha Karunanithi else if (*diagnosticDataType != "Manager") 827a43be80fSAsmitha Karunanithi { 828a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR 829a43be80fSAsmitha Karunanithi << "Wrong parameter value passed for 'DiagnosticDataType'"; 830a43be80fSAsmitha Karunanithi messages::invalidObject(asyncResp->res, 831a43be80fSAsmitha Karunanithi "BMC Dump creation parameters"); 832a43be80fSAsmitha Karunanithi return; 833a43be80fSAsmitha Karunanithi } 834a43be80fSAsmitha Karunanithi } 835a43be80fSAsmitha Karunanithi 836a43be80fSAsmitha Karunanithi crow::connections::systemBus->async_method_call( 837a43be80fSAsmitha Karunanithi [asyncResp, req, dumpPath, dumpType](const boost::system::error_code ec, 838a43be80fSAsmitha Karunanithi const uint32_t& dumpId) { 839a43be80fSAsmitha Karunanithi if (ec) 840a43be80fSAsmitha Karunanithi { 841a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec; 842a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 843a43be80fSAsmitha Karunanithi return; 844a43be80fSAsmitha Karunanithi } 845a43be80fSAsmitha Karunanithi BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId; 846a43be80fSAsmitha Karunanithi 847a43be80fSAsmitha Karunanithi createDumpTaskCallback(req, asyncResp, dumpId, dumpPath, dumpType); 848a43be80fSAsmitha Karunanithi }, 849a43be80fSAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 850a43be80fSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create", "CreateDump"); 851a43be80fSAsmitha Karunanithi } 852a43be80fSAsmitha Karunanithi 85380319af1SAsmitha Karunanithi inline void clearDump(crow::Response& res, const std::string& dumpInterface) 85480319af1SAsmitha Karunanithi { 85580319af1SAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 85680319af1SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 85780319af1SAsmitha Karunanithi [asyncResp](const boost::system::error_code ec, 85880319af1SAsmitha Karunanithi const std::vector<std::string>& subTreePaths) { 85980319af1SAsmitha Karunanithi if (ec) 86080319af1SAsmitha Karunanithi { 86180319af1SAsmitha Karunanithi BMCWEB_LOG_ERROR << "resp_handler got error " << ec; 86280319af1SAsmitha Karunanithi messages::internalError(asyncResp->res); 86380319af1SAsmitha Karunanithi return; 86480319af1SAsmitha Karunanithi } 86580319af1SAsmitha Karunanithi 86680319af1SAsmitha Karunanithi for (const std::string& path : subTreePaths) 86780319af1SAsmitha Karunanithi { 86880319af1SAsmitha Karunanithi std::size_t pos = path.rfind("/"); 86980319af1SAsmitha Karunanithi if (pos != std::string::npos) 87080319af1SAsmitha Karunanithi { 87180319af1SAsmitha Karunanithi std::string logID = path.substr(pos + 1); 87280319af1SAsmitha Karunanithi deleteDumpEntry(asyncResp->res, logID); 87380319af1SAsmitha Karunanithi } 87480319af1SAsmitha Karunanithi } 87580319af1SAsmitha Karunanithi }, 87680319af1SAsmitha Karunanithi "xyz.openbmc_project.ObjectMapper", 87780319af1SAsmitha Karunanithi "/xyz/openbmc_project/object_mapper", 87880319af1SAsmitha Karunanithi "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 87980319af1SAsmitha Karunanithi "/xyz/openbmc_project/dump", 0, 88080319af1SAsmitha Karunanithi std::array<std::string, 1>{dumpInterface}); 88180319af1SAsmitha Karunanithi } 88280319af1SAsmitha Karunanithi 883043a0536SJohnathan Mantey static void ParseCrashdumpParameters( 884043a0536SJohnathan Mantey const std::vector<std::pair<std::string, VariantType>>& params, 885043a0536SJohnathan Mantey std::string& filename, std::string& timestamp, std::string& logfile) 886043a0536SJohnathan Mantey { 887043a0536SJohnathan Mantey for (auto property : params) 888043a0536SJohnathan Mantey { 889043a0536SJohnathan Mantey if (property.first == "Timestamp") 890043a0536SJohnathan Mantey { 891043a0536SJohnathan Mantey const std::string* value = 8928d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 893043a0536SJohnathan Mantey if (value != nullptr) 894043a0536SJohnathan Mantey { 895043a0536SJohnathan Mantey timestamp = *value; 896043a0536SJohnathan Mantey } 897043a0536SJohnathan Mantey } 898043a0536SJohnathan Mantey else if (property.first == "Filename") 899043a0536SJohnathan Mantey { 900043a0536SJohnathan Mantey const std::string* value = 9018d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 902043a0536SJohnathan Mantey if (value != nullptr) 903043a0536SJohnathan Mantey { 904043a0536SJohnathan Mantey filename = *value; 905043a0536SJohnathan Mantey } 906043a0536SJohnathan Mantey } 907043a0536SJohnathan Mantey else if (property.first == "Log") 908043a0536SJohnathan Mantey { 909043a0536SJohnathan Mantey const std::string* value = 9108d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 911043a0536SJohnathan Mantey if (value != nullptr) 912043a0536SJohnathan Mantey { 913043a0536SJohnathan Mantey logfile = *value; 914043a0536SJohnathan Mantey } 915043a0536SJohnathan Mantey } 916043a0536SJohnathan Mantey } 917043a0536SJohnathan Mantey } 918043a0536SJohnathan Mantey 919a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode"; 920c4bf6374SJason M. Bills class SystemLogServiceCollection : public Node 9211da66f75SEd Tanous { 9221da66f75SEd Tanous public: 92352cc112dSEd Tanous SystemLogServiceCollection(App& app) : 924029573d4SEd Tanous Node(app, "/redfish/v1/Systems/system/LogServices/") 925c4bf6374SJason M. Bills { 926c4bf6374SJason M. Bills entityPrivileges = { 927c4bf6374SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 928c4bf6374SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 929c4bf6374SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 930c4bf6374SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 931c4bf6374SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 932c4bf6374SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 933c4bf6374SJason M. Bills } 934c4bf6374SJason M. Bills 935c4bf6374SJason M. Bills private: 936c4bf6374SJason M. Bills /** 937c4bf6374SJason M. Bills * Functions triggers appropriate requests on DBus 938c4bf6374SJason M. Bills */ 939cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 940cb13a392SEd Tanous const std::vector<std::string>&) override 941c4bf6374SJason M. Bills { 942c4bf6374SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 943c4bf6374SJason M. Bills // Collections don't include the static data added by SubRoute because 944c4bf6374SJason M. Bills // it has a duplicate entry for members 945c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 946c4bf6374SJason M. Bills "#LogServiceCollection.LogServiceCollection"; 947c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 948029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices"; 949c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "System Log Services Collection"; 950c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 951c4bf6374SJason M. Bills "Collection of LogServices for this Computer System"; 952c4bf6374SJason M. Bills nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 953c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 954029573d4SEd Tanous logServiceArray.push_back( 955029573d4SEd Tanous {{"@odata.id", "/redfish/v1/Systems/system/LogServices/EventLog"}}); 9565cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 957c9bb6861Sraviteja-b logServiceArray.push_back( 9585cb1dd27SAsmitha Karunanithi {{"@odata.id", "/redfish/v1/Systems/system/LogServices/Dump"}}); 959c9bb6861Sraviteja-b #endif 960c9bb6861Sraviteja-b 961d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG 962d53dd41fSJason M. Bills logServiceArray.push_back( 963cb92c03bSAndrew Geissler {{"@odata.id", 964424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"}}); 965d53dd41fSJason M. Bills #endif 966c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 967c4bf6374SJason M. Bills logServiceArray.size(); 968a3316fc6SZhikuiRen 969a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 970a3316fc6SZhikuiRen [asyncResp](const boost::system::error_code ec, 971a3316fc6SZhikuiRen const std::vector<std::string>& subtreePath) { 972a3316fc6SZhikuiRen if (ec) 973a3316fc6SZhikuiRen { 974a3316fc6SZhikuiRen BMCWEB_LOG_ERROR << ec; 975a3316fc6SZhikuiRen return; 976a3316fc6SZhikuiRen } 977a3316fc6SZhikuiRen 978a3316fc6SZhikuiRen for (auto& pathStr : subtreePath) 979a3316fc6SZhikuiRen { 980a3316fc6SZhikuiRen if (pathStr.find("PostCode") != std::string::npos) 981a3316fc6SZhikuiRen { 98223a21a1cSEd Tanous nlohmann::json& logServiceArrayLocal = 983a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"]; 98423a21a1cSEd Tanous logServiceArrayLocal.push_back( 985a3316fc6SZhikuiRen {{"@odata.id", "/redfish/v1/Systems/system/" 986a3316fc6SZhikuiRen "LogServices/PostCodes"}}); 987a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 98823a21a1cSEd Tanous logServiceArrayLocal.size(); 989a3316fc6SZhikuiRen return; 990a3316fc6SZhikuiRen } 991a3316fc6SZhikuiRen } 992a3316fc6SZhikuiRen }, 993a3316fc6SZhikuiRen "xyz.openbmc_project.ObjectMapper", 994a3316fc6SZhikuiRen "/xyz/openbmc_project/object_mapper", 995a3316fc6SZhikuiRen "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 0, 996a3316fc6SZhikuiRen std::array<const char*, 1>{postCodeIface}); 997c4bf6374SJason M. Bills } 998c4bf6374SJason M. Bills }; 999c4bf6374SJason M. Bills 1000c4bf6374SJason M. Bills class EventLogService : public Node 1001c4bf6374SJason M. Bills { 1002c4bf6374SJason M. Bills public: 100352cc112dSEd Tanous EventLogService(App& app) : 1004029573d4SEd Tanous Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/") 1005c4bf6374SJason M. Bills { 1006c4bf6374SJason M. Bills entityPrivileges = { 1007c4bf6374SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1008c4bf6374SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1009c4bf6374SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1010c4bf6374SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1011c4bf6374SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1012c4bf6374SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1013c4bf6374SJason M. Bills } 1014c4bf6374SJason M. Bills 1015c4bf6374SJason M. Bills private: 1016cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 1017cb13a392SEd Tanous const std::vector<std::string>&) override 1018c4bf6374SJason M. Bills { 1019c4bf6374SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1020c4bf6374SJason M. Bills 1021c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1022029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 1023c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1024c4bf6374SJason M. Bills "#LogService.v1_1_0.LogService"; 1025c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "Event Log Service"; 1026c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = "System Event Log Service"; 1027c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "EventLog"; 1028c4bf6374SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 1029c4bf6374SJason M. Bills asyncResp->res.jsonValue["Entries"] = { 1030c4bf6374SJason M. Bills {"@odata.id", 1031029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}}; 1032e7d6c8b2SGunnar Mills asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 1033e7d6c8b2SGunnar Mills 1034e7d6c8b2SGunnar Mills {"target", "/redfish/v1/Systems/system/LogServices/EventLog/" 1035e7d6c8b2SGunnar Mills "Actions/LogService.ClearLog"}}; 1036489640c6SJason M. Bills } 1037489640c6SJason M. Bills }; 1038489640c6SJason M. Bills 10391f56a3a6STim Lee class JournalEventLogClear : public Node 1040489640c6SJason M. Bills { 1041489640c6SJason M. Bills public: 104252cc112dSEd Tanous JournalEventLogClear(App& app) : 1043489640c6SJason M. Bills Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/" 1044489640c6SJason M. Bills "LogService.ClearLog/") 1045489640c6SJason M. Bills { 1046489640c6SJason M. Bills entityPrivileges = { 1047489640c6SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1048489640c6SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1049489640c6SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 1050489640c6SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 1051489640c6SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 1052489640c6SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 1053489640c6SJason M. Bills } 1054489640c6SJason M. Bills 1055489640c6SJason M. Bills private: 1056cb13a392SEd Tanous void doPost(crow::Response& res, const crow::Request&, 1057cb13a392SEd Tanous const std::vector<std::string>&) override 1058489640c6SJason M. Bills { 1059489640c6SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1060489640c6SJason M. Bills 1061489640c6SJason M. Bills // Clear the EventLog by deleting the log files 1062489640c6SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1063489640c6SJason M. Bills if (getRedfishLogFiles(redfishLogFiles)) 1064489640c6SJason M. Bills { 1065489640c6SJason M. Bills for (const std::filesystem::path& file : redfishLogFiles) 1066489640c6SJason M. Bills { 1067489640c6SJason M. Bills std::error_code ec; 1068489640c6SJason M. Bills std::filesystem::remove(file, ec); 1069489640c6SJason M. Bills } 1070489640c6SJason M. Bills } 1071489640c6SJason M. Bills 1072489640c6SJason M. Bills // Reload rsyslog so it knows to start new log files 1073489640c6SJason M. Bills crow::connections::systemBus->async_method_call( 1074489640c6SJason M. Bills [asyncResp](const boost::system::error_code ec) { 1075489640c6SJason M. Bills if (ec) 1076489640c6SJason M. Bills { 1077489640c6SJason M. Bills BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec; 1078489640c6SJason M. Bills messages::internalError(asyncResp->res); 1079489640c6SJason M. Bills return; 1080489640c6SJason M. Bills } 1081489640c6SJason M. Bills 1082489640c6SJason M. Bills messages::success(asyncResp->res); 1083489640c6SJason M. Bills }, 1084489640c6SJason M. Bills "org.freedesktop.systemd1", "/org/freedesktop/systemd1", 1085489640c6SJason M. Bills "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service", 1086489640c6SJason M. Bills "replace"); 1087c4bf6374SJason M. Bills } 1088c4bf6374SJason M. Bills }; 1089c4bf6374SJason M. Bills 109095820184SJason M. Bills static int fillEventLogEntryJson(const std::string& logEntryID, 109195820184SJason M. Bills const std::string logEntry, 109295820184SJason M. Bills nlohmann::json& logEntryJson) 1093c4bf6374SJason M. Bills { 109495820184SJason M. Bills // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1095cd225da8SJason M. Bills // First get the Timestamp 1096cd225da8SJason M. Bills size_t space = logEntry.find_first_of(" "); 1097cd225da8SJason M. Bills if (space == std::string::npos) 109895820184SJason M. Bills { 109995820184SJason M. Bills return 1; 110095820184SJason M. Bills } 1101cd225da8SJason M. Bills std::string timestamp = logEntry.substr(0, space); 1102cd225da8SJason M. Bills // Then get the log contents 1103cd225da8SJason M. Bills size_t entryStart = logEntry.find_first_not_of(" ", space); 1104cd225da8SJason M. Bills if (entryStart == std::string::npos) 1105cd225da8SJason M. Bills { 1106cd225da8SJason M. Bills return 1; 1107cd225da8SJason M. Bills } 1108cd225da8SJason M. Bills std::string_view entry(logEntry); 1109cd225da8SJason M. Bills entry.remove_prefix(entryStart); 1110cd225da8SJason M. Bills // Use split to separate the entry into its fields 1111cd225da8SJason M. Bills std::vector<std::string> logEntryFields; 1112cd225da8SJason M. Bills boost::split(logEntryFields, entry, boost::is_any_of(","), 1113cd225da8SJason M. Bills boost::token_compress_on); 1114cd225da8SJason M. Bills // We need at least a MessageId to be valid 1115cd225da8SJason M. Bills if (logEntryFields.size() < 1) 1116cd225da8SJason M. Bills { 1117cd225da8SJason M. Bills return 1; 1118cd225da8SJason M. Bills } 1119cd225da8SJason M. Bills std::string& messageID = logEntryFields[0]; 112095820184SJason M. Bills 11214851d45dSJason M. Bills // Get the Message from the MessageRegistry 11224851d45dSJason M. Bills const message_registries::Message* message = 11234851d45dSJason M. Bills message_registries::getMessage(messageID); 1124c4bf6374SJason M. Bills 11254851d45dSJason M. Bills std::string msg; 11264851d45dSJason M. Bills std::string severity; 11274851d45dSJason M. Bills if (message != nullptr) 1128c4bf6374SJason M. Bills { 11294851d45dSJason M. Bills msg = message->message; 11304851d45dSJason M. Bills severity = message->severity; 1131c4bf6374SJason M. Bills } 1132c4bf6374SJason M. Bills 113315a86ff6SJason M. Bills // Get the MessageArgs from the log if there are any 113415a86ff6SJason M. Bills boost::beast::span<std::string> messageArgs; 113515a86ff6SJason M. Bills if (logEntryFields.size() > 1) 113615a86ff6SJason M. Bills { 113715a86ff6SJason M. Bills std::string& messageArgsStart = logEntryFields[1]; 113815a86ff6SJason M. Bills // If the first string is empty, assume there are no MessageArgs 113915a86ff6SJason M. Bills std::size_t messageArgsSize = 0; 114015a86ff6SJason M. Bills if (!messageArgsStart.empty()) 114115a86ff6SJason M. Bills { 114215a86ff6SJason M. Bills messageArgsSize = logEntryFields.size() - 1; 114315a86ff6SJason M. Bills } 114415a86ff6SJason M. Bills 114523a21a1cSEd Tanous messageArgs = {&messageArgsStart, messageArgsSize}; 1146c4bf6374SJason M. Bills 11474851d45dSJason M. Bills // Fill the MessageArgs into the Message 114895820184SJason M. Bills int i = 0; 114995820184SJason M. Bills for (const std::string& messageArg : messageArgs) 11504851d45dSJason M. Bills { 115195820184SJason M. Bills std::string argStr = "%" + std::to_string(++i); 11524851d45dSJason M. Bills size_t argPos = msg.find(argStr); 11534851d45dSJason M. Bills if (argPos != std::string::npos) 11544851d45dSJason M. Bills { 115595820184SJason M. Bills msg.replace(argPos, argStr.length(), messageArg); 11564851d45dSJason M. Bills } 11574851d45dSJason M. Bills } 115815a86ff6SJason M. Bills } 11594851d45dSJason M. Bills 116095820184SJason M. Bills // Get the Created time from the timestamp. The log timestamp is in RFC3339 116195820184SJason M. Bills // format which matches the Redfish format except for the fractional seconds 116295820184SJason M. Bills // between the '.' and the '+', so just remove them. 116395820184SJason M. Bills std::size_t dot = timestamp.find_first_of("."); 116495820184SJason M. Bills std::size_t plus = timestamp.find_first_of("+"); 116595820184SJason M. Bills if (dot != std::string::npos && plus != std::string::npos) 1166c4bf6374SJason M. Bills { 116795820184SJason M. Bills timestamp.erase(dot, plus - dot); 1168c4bf6374SJason M. Bills } 1169c4bf6374SJason M. Bills 1170c4bf6374SJason M. Bills // Fill in the log entry with the gathered data 117195820184SJason M. Bills logEntryJson = { 1172cb92c03bSAndrew Geissler {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 1173029573d4SEd Tanous {"@odata.id", 1174897967deSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 117595820184SJason M. Bills logEntryID}, 1176c4bf6374SJason M. Bills {"Name", "System Event Log Entry"}, 117795820184SJason M. Bills {"Id", logEntryID}, 117895820184SJason M. Bills {"Message", std::move(msg)}, 117995820184SJason M. Bills {"MessageId", std::move(messageID)}, 1180c4bf6374SJason M. Bills {"MessageArgs", std::move(messageArgs)}, 1181c4bf6374SJason M. Bills {"EntryType", "Event"}, 118295820184SJason M. Bills {"Severity", std::move(severity)}, 118395820184SJason M. Bills {"Created", std::move(timestamp)}}; 1184c4bf6374SJason M. Bills return 0; 1185c4bf6374SJason M. Bills } 1186c4bf6374SJason M. Bills 118727062605SAnthony Wilson class JournalEventLogEntryCollection : public Node 1188c4bf6374SJason M. Bills { 1189c4bf6374SJason M. Bills public: 119052cc112dSEd Tanous JournalEventLogEntryCollection(App& app) : 1191029573d4SEd Tanous Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") 1192c4bf6374SJason M. Bills { 1193c4bf6374SJason M. Bills entityPrivileges = { 1194c4bf6374SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1195c4bf6374SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1196c4bf6374SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1197c4bf6374SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1198c4bf6374SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1199c4bf6374SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1200c4bf6374SJason M. Bills } 1201c4bf6374SJason M. Bills 1202c4bf6374SJason M. Bills private: 1203c4bf6374SJason M. Bills void doGet(crow::Response& res, const crow::Request& req, 1204cb13a392SEd Tanous const std::vector<std::string>&) override 1205c4bf6374SJason M. Bills { 1206c4bf6374SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1207271584abSEd Tanous uint64_t skip = 0; 1208271584abSEd Tanous uint64_t top = maxEntriesPerPage; // Show max entries by default 1209c4bf6374SJason M. Bills if (!getSkipParam(asyncResp->res, req, skip)) 1210c4bf6374SJason M. Bills { 1211c4bf6374SJason M. Bills return; 1212c4bf6374SJason M. Bills } 1213c4bf6374SJason M. Bills if (!getTopParam(asyncResp->res, req, top)) 1214c4bf6374SJason M. Bills { 1215c4bf6374SJason M. Bills return; 1216c4bf6374SJason M. Bills } 1217c4bf6374SJason M. Bills // Collections don't include the static data added by SubRoute because 1218c4bf6374SJason M. Bills // it has a duplicate entry for members 1219c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1220c4bf6374SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 1221c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1222029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1223c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 1224c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 1225c4bf6374SJason M. Bills "Collection of System Event Log Entries"; 1226cb92c03bSAndrew Geissler 1227c4bf6374SJason M. Bills nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1228c4bf6374SJason M. Bills logEntryArray = nlohmann::json::array(); 122995820184SJason M. Bills // Go through the log files and create a unique ID for each entry 123095820184SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 123195820184SJason M. Bills getRedfishLogFiles(redfishLogFiles); 1232b01bf299SEd Tanous uint64_t entryCount = 0; 1233cd225da8SJason M. Bills std::string logEntry; 123495820184SJason M. Bills 123595820184SJason M. Bills // Oldest logs are in the last file, so start there and loop backwards 1236cd225da8SJason M. Bills for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1237cd225da8SJason M. Bills it++) 1238c4bf6374SJason M. Bills { 1239cd225da8SJason M. Bills std::ifstream logStream(*it); 124095820184SJason M. Bills if (!logStream.is_open()) 1241c4bf6374SJason M. Bills { 1242c4bf6374SJason M. Bills continue; 1243c4bf6374SJason M. Bills } 1244c4bf6374SJason M. Bills 1245e85d6b16SJason M. Bills // Reset the unique ID on the first entry 1246e85d6b16SJason M. Bills bool firstEntry = true; 124795820184SJason M. Bills while (std::getline(logStream, logEntry)) 124895820184SJason M. Bills { 1249c4bf6374SJason M. Bills entryCount++; 1250c4bf6374SJason M. Bills // Handle paging using skip (number of entries to skip from the 1251c4bf6374SJason M. Bills // start) and top (number of entries to display) 1252c4bf6374SJason M. Bills if (entryCount <= skip || entryCount > skip + top) 1253c4bf6374SJason M. Bills { 1254c4bf6374SJason M. Bills continue; 1255c4bf6374SJason M. Bills } 1256c4bf6374SJason M. Bills 1257c4bf6374SJason M. Bills std::string idStr; 1258e85d6b16SJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1259c4bf6374SJason M. Bills { 1260c4bf6374SJason M. Bills continue; 1261c4bf6374SJason M. Bills } 1262c4bf6374SJason M. Bills 1263e85d6b16SJason M. Bills if (firstEntry) 1264e85d6b16SJason M. Bills { 1265e85d6b16SJason M. Bills firstEntry = false; 1266e85d6b16SJason M. Bills } 1267e85d6b16SJason M. Bills 1268c4bf6374SJason M. Bills logEntryArray.push_back({}); 1269c4bf6374SJason M. Bills nlohmann::json& bmcLogEntry = logEntryArray.back(); 127095820184SJason M. Bills if (fillEventLogEntryJson(idStr, logEntry, bmcLogEntry) != 0) 1271c4bf6374SJason M. Bills { 1272c4bf6374SJason M. Bills messages::internalError(asyncResp->res); 1273c4bf6374SJason M. Bills return; 1274c4bf6374SJason M. Bills } 1275c4bf6374SJason M. Bills } 127695820184SJason M. Bills } 1277c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 1278c4bf6374SJason M. Bills if (skip + top < entryCount) 1279c4bf6374SJason M. Bills { 1280c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 128195820184SJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/" 128295820184SJason M. Bills "Entries?$skip=" + 1283c4bf6374SJason M. Bills std::to_string(skip + top); 1284c4bf6374SJason M. Bills } 128508a4e4b5SAnthony Wilson } 128608a4e4b5SAnthony Wilson }; 128708a4e4b5SAnthony Wilson 1288897967deSJason M. Bills class JournalEventLogEntry : public Node 1289897967deSJason M. Bills { 1290897967deSJason M. Bills public: 129152cc112dSEd Tanous JournalEventLogEntry(App& app) : 1292897967deSJason M. Bills Node(app, 1293897967deSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/", 1294897967deSJason M. Bills std::string()) 1295897967deSJason M. Bills { 1296897967deSJason M. Bills entityPrivileges = { 1297897967deSJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1298897967deSJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1299897967deSJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1300897967deSJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1301897967deSJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1302897967deSJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1303897967deSJason M. Bills } 1304897967deSJason M. Bills 1305897967deSJason M. Bills private: 1306cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 1307897967deSJason M. Bills const std::vector<std::string>& params) override 1308897967deSJason M. Bills { 1309897967deSJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1310897967deSJason M. Bills if (params.size() != 1) 1311897967deSJason M. Bills { 1312897967deSJason M. Bills messages::internalError(asyncResp->res); 1313897967deSJason M. Bills return; 1314897967deSJason M. Bills } 1315897967deSJason M. Bills const std::string& targetID = params[0]; 1316897967deSJason M. Bills 1317897967deSJason M. Bills // Go through the log files and check the unique ID for each entry to 1318897967deSJason M. Bills // find the target entry 1319897967deSJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1320897967deSJason M. Bills getRedfishLogFiles(redfishLogFiles); 1321897967deSJason M. Bills std::string logEntry; 1322897967deSJason M. Bills 1323897967deSJason M. Bills // Oldest logs are in the last file, so start there and loop backwards 1324897967deSJason M. Bills for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1325897967deSJason M. Bills it++) 1326897967deSJason M. Bills { 1327897967deSJason M. Bills std::ifstream logStream(*it); 1328897967deSJason M. Bills if (!logStream.is_open()) 1329897967deSJason M. Bills { 1330897967deSJason M. Bills continue; 1331897967deSJason M. Bills } 1332897967deSJason M. Bills 1333897967deSJason M. Bills // Reset the unique ID on the first entry 1334897967deSJason M. Bills bool firstEntry = true; 1335897967deSJason M. Bills while (std::getline(logStream, logEntry)) 1336897967deSJason M. Bills { 1337897967deSJason M. Bills std::string idStr; 1338897967deSJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1339897967deSJason M. Bills { 1340897967deSJason M. Bills continue; 1341897967deSJason M. Bills } 1342897967deSJason M. Bills 1343897967deSJason M. Bills if (firstEntry) 1344897967deSJason M. Bills { 1345897967deSJason M. Bills firstEntry = false; 1346897967deSJason M. Bills } 1347897967deSJason M. Bills 1348897967deSJason M. Bills if (idStr == targetID) 1349897967deSJason M. Bills { 1350897967deSJason M. Bills if (fillEventLogEntryJson(idStr, logEntry, 1351897967deSJason M. Bills asyncResp->res.jsonValue) != 0) 1352897967deSJason M. Bills { 1353897967deSJason M. Bills messages::internalError(asyncResp->res); 1354897967deSJason M. Bills return; 1355897967deSJason M. Bills } 1356897967deSJason M. Bills return; 1357897967deSJason M. Bills } 1358897967deSJason M. Bills } 1359897967deSJason M. Bills } 1360897967deSJason M. Bills // Requested ID was not found 1361897967deSJason M. Bills messages::resourceMissingAtURI(asyncResp->res, targetID); 1362897967deSJason M. Bills } 1363897967deSJason M. Bills }; 1364897967deSJason M. Bills 136508a4e4b5SAnthony Wilson class DBusEventLogEntryCollection : public Node 136608a4e4b5SAnthony Wilson { 136708a4e4b5SAnthony Wilson public: 136852cc112dSEd Tanous DBusEventLogEntryCollection(App& app) : 136908a4e4b5SAnthony Wilson Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") 137008a4e4b5SAnthony Wilson { 137108a4e4b5SAnthony Wilson entityPrivileges = { 137208a4e4b5SAnthony Wilson {boost::beast::http::verb::get, {{"Login"}}}, 137308a4e4b5SAnthony Wilson {boost::beast::http::verb::head, {{"Login"}}}, 137408a4e4b5SAnthony Wilson {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 137508a4e4b5SAnthony Wilson {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 137608a4e4b5SAnthony Wilson {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 137708a4e4b5SAnthony Wilson {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 137808a4e4b5SAnthony Wilson } 137908a4e4b5SAnthony Wilson 138008a4e4b5SAnthony Wilson private: 1381cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 1382cb13a392SEd Tanous const std::vector<std::string>&) override 138308a4e4b5SAnthony Wilson { 138408a4e4b5SAnthony Wilson std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 138508a4e4b5SAnthony Wilson 138608a4e4b5SAnthony Wilson // Collections don't include the static data added by SubRoute because 138708a4e4b5SAnthony Wilson // it has a duplicate entry for members 138808a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.type"] = 138908a4e4b5SAnthony Wilson "#LogEntryCollection.LogEntryCollection"; 139008a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.id"] = 139108a4e4b5SAnthony Wilson "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 139208a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 139308a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Description"] = 139408a4e4b5SAnthony Wilson "Collection of System Event Log Entries"; 139508a4e4b5SAnthony Wilson 1396cb92c03bSAndrew Geissler // DBus implementation of EventLog/Entries 1397cb92c03bSAndrew Geissler // Make call to Logging Service to find all log entry objects 1398cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 1399cb92c03bSAndrew Geissler [asyncResp](const boost::system::error_code ec, 1400cb92c03bSAndrew Geissler GetManagedObjectsType& resp) { 1401cb92c03bSAndrew Geissler if (ec) 1402cb92c03bSAndrew Geissler { 1403cb92c03bSAndrew Geissler // TODO Handle for specific error code 1404cb92c03bSAndrew Geissler BMCWEB_LOG_ERROR 1405cb92c03bSAndrew Geissler << "getLogEntriesIfaceData resp_handler got error " 1406cb92c03bSAndrew Geissler << ec; 1407cb92c03bSAndrew Geissler messages::internalError(asyncResp->res); 1408cb92c03bSAndrew Geissler return; 1409cb92c03bSAndrew Geissler } 1410cb92c03bSAndrew Geissler nlohmann::json& entriesArray = 1411cb92c03bSAndrew Geissler asyncResp->res.jsonValue["Members"]; 1412cb92c03bSAndrew Geissler entriesArray = nlohmann::json::array(); 1413cb92c03bSAndrew Geissler for (auto& objectPath : resp) 1414cb92c03bSAndrew Geissler { 1415cb92c03bSAndrew Geissler for (auto& interfaceMap : objectPath.second) 1416cb92c03bSAndrew Geissler { 1417cb92c03bSAndrew Geissler if (interfaceMap.first != 1418cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging.Entry") 1419cb92c03bSAndrew Geissler { 1420cb92c03bSAndrew Geissler BMCWEB_LOG_DEBUG << "Bailing early on " 1421cb92c03bSAndrew Geissler << interfaceMap.first; 1422cb92c03bSAndrew Geissler continue; 1423cb92c03bSAndrew Geissler } 1424cb92c03bSAndrew Geissler entriesArray.push_back({}); 1425cb92c03bSAndrew Geissler nlohmann::json& thisEntry = entriesArray.back(); 142666664f25SEd Tanous uint32_t* id = nullptr; 142766664f25SEd Tanous std::time_t timestamp{}; 1428d139c236SGeorge Liu std::time_t updateTimestamp{}; 142966664f25SEd Tanous std::string* severity = nullptr; 143066664f25SEd Tanous std::string* message = nullptr; 1431d139c236SGeorge Liu 1432cb92c03bSAndrew Geissler for (auto& propertyMap : interfaceMap.second) 1433cb92c03bSAndrew Geissler { 1434cb92c03bSAndrew Geissler if (propertyMap.first == "Id") 1435cb92c03bSAndrew Geissler { 14368d78b7a9SPatrick Williams id = std::get_if<uint32_t>(&propertyMap.second); 1437cb92c03bSAndrew Geissler if (id == nullptr) 1438cb92c03bSAndrew Geissler { 14390f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1440cb92c03bSAndrew Geissler } 1441cb92c03bSAndrew Geissler } 1442cb92c03bSAndrew Geissler else if (propertyMap.first == "Timestamp") 1443cb92c03bSAndrew Geissler { 1444cb92c03bSAndrew Geissler const uint64_t* millisTimeStamp = 1445cb92c03bSAndrew Geissler std::get_if<uint64_t>(&propertyMap.second); 1446cb92c03bSAndrew Geissler if (millisTimeStamp == nullptr) 1447cb92c03bSAndrew Geissler { 14480f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1449cb92c03bSAndrew Geissler } 1450ebd45906SGeorge Liu else 1451ebd45906SGeorge Liu { 1452d139c236SGeorge Liu timestamp = crow::utility::getTimestamp( 1453cb92c03bSAndrew Geissler *millisTimeStamp); 1454d139c236SGeorge Liu } 1455ebd45906SGeorge Liu } 1456d139c236SGeorge Liu else if (propertyMap.first == "UpdateTimestamp") 1457d139c236SGeorge Liu { 1458d139c236SGeorge Liu const uint64_t* millisTimeStamp = 1459d139c236SGeorge Liu std::get_if<uint64_t>(&propertyMap.second); 1460d139c236SGeorge Liu if (millisTimeStamp == nullptr) 1461d139c236SGeorge Liu { 1462d139c236SGeorge Liu messages::internalError(asyncResp->res); 1463d139c236SGeorge Liu } 1464ebd45906SGeorge Liu else 1465ebd45906SGeorge Liu { 1466ebd45906SGeorge Liu updateTimestamp = 1467ebd45906SGeorge Liu crow::utility::getTimestamp( 1468d139c236SGeorge Liu *millisTimeStamp); 1469cb92c03bSAndrew Geissler } 1470ebd45906SGeorge Liu } 1471cb92c03bSAndrew Geissler else if (propertyMap.first == "Severity") 1472cb92c03bSAndrew Geissler { 1473cb92c03bSAndrew Geissler severity = std::get_if<std::string>( 1474cb92c03bSAndrew Geissler &propertyMap.second); 1475cb92c03bSAndrew Geissler if (severity == nullptr) 1476cb92c03bSAndrew Geissler { 14770f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1478cb92c03bSAndrew Geissler } 1479cb92c03bSAndrew Geissler } 1480cb92c03bSAndrew Geissler else if (propertyMap.first == "Message") 1481cb92c03bSAndrew Geissler { 1482cb92c03bSAndrew Geissler message = std::get_if<std::string>( 1483cb92c03bSAndrew Geissler &propertyMap.second); 1484cb92c03bSAndrew Geissler if (message == nullptr) 1485cb92c03bSAndrew Geissler { 14860f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1487cb92c03bSAndrew Geissler } 1488cb92c03bSAndrew Geissler } 1489cb92c03bSAndrew Geissler } 1490cb92c03bSAndrew Geissler thisEntry = { 1491d139c236SGeorge Liu {"@odata.type", "#LogEntry.v1_6_0.LogEntry"}, 1492cb92c03bSAndrew Geissler {"@odata.id", 1493cb92c03bSAndrew Geissler "/redfish/v1/Systems/system/LogServices/EventLog/" 1494cb92c03bSAndrew Geissler "Entries/" + 1495cb92c03bSAndrew Geissler std::to_string(*id)}, 149627062605SAnthony Wilson {"Name", "System Event Log Entry"}, 1497cb92c03bSAndrew Geissler {"Id", std::to_string(*id)}, 1498cb92c03bSAndrew Geissler {"Message", *message}, 1499cb92c03bSAndrew Geissler {"EntryType", "Event"}, 1500cb92c03bSAndrew Geissler {"Severity", 1501cb92c03bSAndrew Geissler translateSeverityDbusToRedfish(*severity)}, 1502d139c236SGeorge Liu {"Created", crow::utility::getDateTime(timestamp)}, 1503d139c236SGeorge Liu {"Modified", 1504d139c236SGeorge Liu crow::utility::getDateTime(updateTimestamp)}}; 1505cb92c03bSAndrew Geissler } 1506cb92c03bSAndrew Geissler } 1507cb92c03bSAndrew Geissler std::sort(entriesArray.begin(), entriesArray.end(), 1508cb92c03bSAndrew Geissler [](const nlohmann::json& left, 1509cb92c03bSAndrew Geissler const nlohmann::json& right) { 1510cb92c03bSAndrew Geissler return (left["Id"] <= right["Id"]); 1511cb92c03bSAndrew Geissler }); 1512cb92c03bSAndrew Geissler asyncResp->res.jsonValue["Members@odata.count"] = 1513cb92c03bSAndrew Geissler entriesArray.size(); 1514cb92c03bSAndrew Geissler }, 1515cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging", 1516cb92c03bSAndrew Geissler "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 1517c4bf6374SJason M. Bills } 1518c4bf6374SJason M. Bills }; 1519c4bf6374SJason M. Bills 152008a4e4b5SAnthony Wilson class DBusEventLogEntry : public Node 1521c4bf6374SJason M. Bills { 1522c4bf6374SJason M. Bills public: 152352cc112dSEd Tanous DBusEventLogEntry(App& app) : 1524c4bf6374SJason M. Bills Node(app, 1525029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/", 1526029573d4SEd Tanous std::string()) 1527c4bf6374SJason M. Bills { 1528c4bf6374SJason M. Bills entityPrivileges = { 1529c4bf6374SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1530c4bf6374SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1531c4bf6374SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1532c4bf6374SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1533c4bf6374SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1534c4bf6374SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1535c4bf6374SJason M. Bills } 1536c4bf6374SJason M. Bills 1537c4bf6374SJason M. Bills private: 1538cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 1539c4bf6374SJason M. Bills const std::vector<std::string>& params) override 1540c4bf6374SJason M. Bills { 1541c4bf6374SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1542029573d4SEd Tanous if (params.size() != 1) 1543c4bf6374SJason M. Bills { 1544c4bf6374SJason M. Bills messages::internalError(asyncResp->res); 1545c4bf6374SJason M. Bills return; 1546c4bf6374SJason M. Bills } 1547029573d4SEd Tanous const std::string& entryID = params[0]; 1548cb92c03bSAndrew Geissler 1549cb92c03bSAndrew Geissler // DBus implementation of EventLog/Entries 1550cb92c03bSAndrew Geissler // Make call to Logging Service to find all log entry objects 1551cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 1552cb92c03bSAndrew Geissler [asyncResp, entryID](const boost::system::error_code ec, 1553cb92c03bSAndrew Geissler GetManagedPropertyType& resp) { 1554cb92c03bSAndrew Geissler if (ec) 1555cb92c03bSAndrew Geissler { 1556cb92c03bSAndrew Geissler BMCWEB_LOG_ERROR 1557cb92c03bSAndrew Geissler << "EventLogEntry (DBus) resp_handler got error " << ec; 1558cb92c03bSAndrew Geissler messages::internalError(asyncResp->res); 1559cb92c03bSAndrew Geissler return; 1560cb92c03bSAndrew Geissler } 156166664f25SEd Tanous uint32_t* id = nullptr; 156266664f25SEd Tanous std::time_t timestamp{}; 1563d139c236SGeorge Liu std::time_t updateTimestamp{}; 156466664f25SEd Tanous std::string* severity = nullptr; 156566664f25SEd Tanous std::string* message = nullptr; 1566d139c236SGeorge Liu 1567cb92c03bSAndrew Geissler for (auto& propertyMap : resp) 1568cb92c03bSAndrew Geissler { 1569cb92c03bSAndrew Geissler if (propertyMap.first == "Id") 1570cb92c03bSAndrew Geissler { 1571cb92c03bSAndrew Geissler id = std::get_if<uint32_t>(&propertyMap.second); 1572cb92c03bSAndrew Geissler if (id == nullptr) 1573cb92c03bSAndrew Geissler { 15740f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1575cb92c03bSAndrew Geissler } 1576cb92c03bSAndrew Geissler } 1577cb92c03bSAndrew Geissler else if (propertyMap.first == "Timestamp") 1578cb92c03bSAndrew Geissler { 1579cb92c03bSAndrew Geissler const uint64_t* millisTimeStamp = 1580cb92c03bSAndrew Geissler std::get_if<uint64_t>(&propertyMap.second); 1581cb92c03bSAndrew Geissler if (millisTimeStamp == nullptr) 1582cb92c03bSAndrew Geissler { 15830f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1584cb92c03bSAndrew Geissler } 1585ebd45906SGeorge Liu else 1586ebd45906SGeorge Liu { 1587cb92c03bSAndrew Geissler timestamp = 1588d139c236SGeorge Liu crow::utility::getTimestamp(*millisTimeStamp); 1589d139c236SGeorge Liu } 1590ebd45906SGeorge Liu } 1591d139c236SGeorge Liu else if (propertyMap.first == "UpdateTimestamp") 1592d139c236SGeorge Liu { 1593d139c236SGeorge Liu const uint64_t* millisTimeStamp = 1594d139c236SGeorge Liu std::get_if<uint64_t>(&propertyMap.second); 1595d139c236SGeorge Liu if (millisTimeStamp == nullptr) 1596d139c236SGeorge Liu { 1597d139c236SGeorge Liu messages::internalError(asyncResp->res); 1598d139c236SGeorge Liu } 1599ebd45906SGeorge Liu else 1600ebd45906SGeorge Liu { 1601d139c236SGeorge Liu updateTimestamp = 1602d139c236SGeorge Liu crow::utility::getTimestamp(*millisTimeStamp); 1603cb92c03bSAndrew Geissler } 1604ebd45906SGeorge Liu } 1605cb92c03bSAndrew Geissler else if (propertyMap.first == "Severity") 1606cb92c03bSAndrew Geissler { 1607cb92c03bSAndrew Geissler severity = 1608cb92c03bSAndrew Geissler std::get_if<std::string>(&propertyMap.second); 1609cb92c03bSAndrew Geissler if (severity == nullptr) 1610cb92c03bSAndrew Geissler { 16110f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1612cb92c03bSAndrew Geissler } 1613cb92c03bSAndrew Geissler } 1614cb92c03bSAndrew Geissler else if (propertyMap.first == "Message") 1615cb92c03bSAndrew Geissler { 1616cb92c03bSAndrew Geissler message = std::get_if<std::string>(&propertyMap.second); 1617cb92c03bSAndrew Geissler if (message == nullptr) 1618cb92c03bSAndrew Geissler { 16190f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1620cb92c03bSAndrew Geissler } 1621cb92c03bSAndrew Geissler } 1622cb92c03bSAndrew Geissler } 1623271584abSEd Tanous if (id == nullptr || message == nullptr || severity == nullptr) 1624271584abSEd Tanous { 1625271584abSEd Tanous return; 1626271584abSEd Tanous } 1627cb92c03bSAndrew Geissler asyncResp->res.jsonValue = { 1628d139c236SGeorge Liu {"@odata.type", "#LogEntry.v1_6_0.LogEntry"}, 1629cb92c03bSAndrew Geissler {"@odata.id", 1630cb92c03bSAndrew Geissler "/redfish/v1/Systems/system/LogServices/EventLog/" 1631cb92c03bSAndrew Geissler "Entries/" + 1632cb92c03bSAndrew Geissler std::to_string(*id)}, 163327062605SAnthony Wilson {"Name", "System Event Log Entry"}, 1634cb92c03bSAndrew Geissler {"Id", std::to_string(*id)}, 1635cb92c03bSAndrew Geissler {"Message", *message}, 1636cb92c03bSAndrew Geissler {"EntryType", "Event"}, 1637cb92c03bSAndrew Geissler {"Severity", translateSeverityDbusToRedfish(*severity)}, 1638d139c236SGeorge Liu {"Created", crow::utility::getDateTime(timestamp)}, 1639d139c236SGeorge Liu {"Modified", crow::utility::getDateTime(updateTimestamp)}}; 1640cb92c03bSAndrew Geissler }, 1641cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging", 1642cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging/entry/" + entryID, 1643cb92c03bSAndrew Geissler "org.freedesktop.DBus.Properties", "GetAll", 1644cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging.Entry"); 1645c4bf6374SJason M. Bills } 1646336e96c6SChicago Duan 1647cb13a392SEd Tanous void doDelete(crow::Response& res, const crow::Request&, 1648336e96c6SChicago Duan const std::vector<std::string>& params) override 1649336e96c6SChicago Duan { 1650336e96c6SChicago Duan 1651336e96c6SChicago Duan BMCWEB_LOG_DEBUG << "Do delete single event entries."; 1652336e96c6SChicago Duan 1653336e96c6SChicago Duan auto asyncResp = std::make_shared<AsyncResp>(res); 1654336e96c6SChicago Duan 1655336e96c6SChicago Duan if (params.size() != 1) 1656336e96c6SChicago Duan { 1657336e96c6SChicago Duan messages::internalError(asyncResp->res); 1658336e96c6SChicago Duan return; 1659336e96c6SChicago Duan } 1660336e96c6SChicago Duan std::string entryID = params[0]; 1661336e96c6SChicago Duan 1662336e96c6SChicago Duan dbus::utility::escapePathForDbus(entryID); 1663336e96c6SChicago Duan 1664336e96c6SChicago Duan // Process response from Logging service. 1665336e96c6SChicago Duan auto respHandler = [asyncResp](const boost::system::error_code ec) { 1666336e96c6SChicago Duan BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done"; 1667336e96c6SChicago Duan if (ec) 1668336e96c6SChicago Duan { 1669336e96c6SChicago Duan // TODO Handle for specific error code 1670336e96c6SChicago Duan BMCWEB_LOG_ERROR 1671336e96c6SChicago Duan << "EventLogEntry (DBus) doDelete respHandler got error " 1672336e96c6SChicago Duan << ec; 1673336e96c6SChicago Duan asyncResp->res.result( 1674336e96c6SChicago Duan boost::beast::http::status::internal_server_error); 1675336e96c6SChicago Duan return; 1676336e96c6SChicago Duan } 1677336e96c6SChicago Duan 1678336e96c6SChicago Duan asyncResp->res.result(boost::beast::http::status::ok); 1679336e96c6SChicago Duan }; 1680336e96c6SChicago Duan 1681336e96c6SChicago Duan // Make call to Logging service to request Delete Log 1682336e96c6SChicago Duan crow::connections::systemBus->async_method_call( 1683336e96c6SChicago Duan respHandler, "xyz.openbmc_project.Logging", 1684336e96c6SChicago Duan "/xyz/openbmc_project/logging/entry/" + entryID, 1685336e96c6SChicago Duan "xyz.openbmc_project.Object.Delete", "Delete"); 1686336e96c6SChicago Duan } 1687c4bf6374SJason M. Bills }; 1688c4bf6374SJason M. Bills 1689c4bf6374SJason M. Bills class BMCLogServiceCollection : public Node 1690c4bf6374SJason M. Bills { 1691c4bf6374SJason M. Bills public: 169252cc112dSEd Tanous BMCLogServiceCollection(App& app) : 16934ed77cd5SEd Tanous Node(app, "/redfish/v1/Managers/bmc/LogServices/") 16941da66f75SEd Tanous { 16951da66f75SEd Tanous entityPrivileges = { 1696e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1697e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1698e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1699e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1700e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1701e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 17021da66f75SEd Tanous } 17031da66f75SEd Tanous 17041da66f75SEd Tanous private: 17051da66f75SEd Tanous /** 17061da66f75SEd Tanous * Functions triggers appropriate requests on DBus 17071da66f75SEd Tanous */ 1708cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 1709cb13a392SEd Tanous const std::vector<std::string>&) override 17101da66f75SEd Tanous { 1711e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 17121da66f75SEd Tanous // Collections don't include the static data added by SubRoute because 17131da66f75SEd Tanous // it has a duplicate entry for members 1714e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 17151da66f75SEd Tanous "#LogServiceCollection.LogServiceCollection"; 1716e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1717e1f26343SJason M. Bills "/redfish/v1/Managers/bmc/LogServices"; 1718e1f26343SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection"; 1719e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 17201da66f75SEd Tanous "Collection of LogServices for this Manager"; 1721c4bf6374SJason M. Bills nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 1722c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 17235cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 17245cb1dd27SAsmitha Karunanithi logServiceArray.push_back( 17255cb1dd27SAsmitha Karunanithi {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump"}}); 17265cb1dd27SAsmitha Karunanithi #endif 1727c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL 1728c4bf6374SJason M. Bills logServiceArray.push_back( 172908a4e4b5SAnthony Wilson {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal"}}); 1730c4bf6374SJason M. Bills #endif 1731e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 1732c4bf6374SJason M. Bills logServiceArray.size(); 17331da66f75SEd Tanous } 17341da66f75SEd Tanous }; 17351da66f75SEd Tanous 1736c4bf6374SJason M. Bills class BMCJournalLogService : public Node 17371da66f75SEd Tanous { 17381da66f75SEd Tanous public: 173952cc112dSEd Tanous BMCJournalLogService(App& app) : 1740c4bf6374SJason M. Bills Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/") 1741e1f26343SJason M. Bills { 1742e1f26343SJason M. Bills entityPrivileges = { 1743e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1744e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1745e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1746e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1747e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1748e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1749e1f26343SJason M. Bills } 1750e1f26343SJason M. Bills 1751e1f26343SJason M. Bills private: 1752cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 1753cb13a392SEd Tanous const std::vector<std::string>&) override 1754e1f26343SJason M. Bills { 1755e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1756e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1757e1f26343SJason M. Bills "#LogService.v1_1_0.LogService"; 17580f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 17590f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal"; 1760c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service"; 1761c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service"; 1762c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "BMC Journal"; 1763e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 1764cd50aa42SJason M. Bills asyncResp->res.jsonValue["Entries"] = { 1765cd50aa42SJason M. Bills {"@odata.id", 1766086be238SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}}; 1767e1f26343SJason M. Bills } 1768e1f26343SJason M. Bills }; 1769e1f26343SJason M. Bills 1770c4bf6374SJason M. Bills static int fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID, 1771e1f26343SJason M. Bills sd_journal* journal, 1772c4bf6374SJason M. Bills nlohmann::json& bmcJournalLogEntryJson) 1773e1f26343SJason M. Bills { 1774e1f26343SJason M. Bills // Get the Log Entry contents 1775e1f26343SJason M. Bills int ret = 0; 1776e1f26343SJason M. Bills 177739e77504SEd Tanous std::string_view msg; 177816428a1aSJason M. Bills ret = getJournalMetadata(journal, "MESSAGE", msg); 1779e1f26343SJason M. Bills if (ret < 0) 1780e1f26343SJason M. Bills { 1781e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret); 1782e1f26343SJason M. Bills return 1; 1783e1f26343SJason M. Bills } 1784e1f26343SJason M. Bills 1785e1f26343SJason M. Bills // Get the severity from the PRIORITY field 1786271584abSEd Tanous long int severity = 8; // Default to an invalid priority 178716428a1aSJason M. Bills ret = getJournalMetadata(journal, "PRIORITY", 10, severity); 1788e1f26343SJason M. Bills if (ret < 0) 1789e1f26343SJason M. Bills { 1790e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret); 1791e1f26343SJason M. Bills } 1792e1f26343SJason M. Bills 1793e1f26343SJason M. Bills // Get the Created time from the timestamp 179416428a1aSJason M. Bills std::string entryTimeStr; 179516428a1aSJason M. Bills if (!getEntryTimestamp(journal, entryTimeStr)) 1796e1f26343SJason M. Bills { 179716428a1aSJason M. Bills return 1; 1798e1f26343SJason M. Bills } 1799e1f26343SJason M. Bills 1800e1f26343SJason M. Bills // Fill in the log entry with the gathered data 1801c4bf6374SJason M. Bills bmcJournalLogEntryJson = { 1802cb92c03bSAndrew Geissler {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 1803c4bf6374SJason M. Bills {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" + 1804c4bf6374SJason M. Bills bmcJournalLogEntryID}, 1805e1f26343SJason M. Bills {"Name", "BMC Journal Entry"}, 1806c4bf6374SJason M. Bills {"Id", bmcJournalLogEntryID}, 180716428a1aSJason M. Bills {"Message", msg}, 1808e1f26343SJason M. Bills {"EntryType", "Oem"}, 1809e1f26343SJason M. Bills {"Severity", 1810b6a61a5eSJason M. Bills severity <= 2 ? "Critical" : severity <= 4 ? "Warning" : "OK"}, 1811086be238SEd Tanous {"OemRecordFormat", "BMC Journal Entry"}, 1812e1f26343SJason M. Bills {"Created", std::move(entryTimeStr)}}; 1813e1f26343SJason M. Bills return 0; 1814e1f26343SJason M. Bills } 1815e1f26343SJason M. Bills 1816c4bf6374SJason M. Bills class BMCJournalLogEntryCollection : public Node 1817e1f26343SJason M. Bills { 1818e1f26343SJason M. Bills public: 181952cc112dSEd Tanous BMCJournalLogEntryCollection(App& app) : 1820c4bf6374SJason M. Bills Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/") 1821e1f26343SJason M. Bills { 1822e1f26343SJason M. Bills entityPrivileges = { 1823e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1824e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1825e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1826e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1827e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1828e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1829e1f26343SJason M. Bills } 1830e1f26343SJason M. Bills 1831e1f26343SJason M. Bills private: 1832e1f26343SJason M. Bills void doGet(crow::Response& res, const crow::Request& req, 1833cb13a392SEd Tanous const std::vector<std::string>&) override 1834e1f26343SJason M. Bills { 1835e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1836193ad2faSJason M. Bills static constexpr const long maxEntriesPerPage = 1000; 1837271584abSEd Tanous uint64_t skip = 0; 1838271584abSEd Tanous uint64_t top = maxEntriesPerPage; // Show max entries by default 183916428a1aSJason M. Bills if (!getSkipParam(asyncResp->res, req, skip)) 1840193ad2faSJason M. Bills { 1841193ad2faSJason M. Bills return; 1842193ad2faSJason M. Bills } 184316428a1aSJason M. Bills if (!getTopParam(asyncResp->res, req, top)) 1844193ad2faSJason M. Bills { 1845193ad2faSJason M. Bills return; 1846193ad2faSJason M. Bills } 1847e1f26343SJason M. Bills // Collections don't include the static data added by SubRoute because 1848e1f26343SJason M. Bills // it has a duplicate entry for members 1849e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1850e1f26343SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 18510f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 18520f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 1853e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1854c4bf6374SJason M. Bills "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 1855e1f26343SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries"; 1856e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 1857e1f26343SJason M. Bills "Collection of BMC Journal Entries"; 18580f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 18590f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/BmcLog/Entries"; 1860e1f26343SJason M. Bills nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1861e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 1862e1f26343SJason M. Bills 1863e1f26343SJason M. Bills // Go through the journal and use the timestamp to create a unique ID 1864e1f26343SJason M. Bills // for each entry 1865e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 1866e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 1867e1f26343SJason M. Bills if (ret < 0) 1868e1f26343SJason M. Bills { 1869e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 1870f12894f8SJason M. Bills messages::internalError(asyncResp->res); 1871e1f26343SJason M. Bills return; 1872e1f26343SJason M. Bills } 1873e1f26343SJason M. Bills std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 1874e1f26343SJason M. Bills journalTmp, sd_journal_close); 1875e1f26343SJason M. Bills journalTmp = nullptr; 1876b01bf299SEd Tanous uint64_t entryCount = 0; 1877e85d6b16SJason M. Bills // Reset the unique ID on the first entry 1878e85d6b16SJason M. Bills bool firstEntry = true; 1879e1f26343SJason M. Bills SD_JOURNAL_FOREACH(journal.get()) 1880e1f26343SJason M. Bills { 1881193ad2faSJason M. Bills entryCount++; 1882193ad2faSJason M. Bills // Handle paging using skip (number of entries to skip from the 1883193ad2faSJason M. Bills // start) and top (number of entries to display) 1884193ad2faSJason M. Bills if (entryCount <= skip || entryCount > skip + top) 1885193ad2faSJason M. Bills { 1886193ad2faSJason M. Bills continue; 1887193ad2faSJason M. Bills } 1888193ad2faSJason M. Bills 188916428a1aSJason M. Bills std::string idStr; 1890e85d6b16SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 1891e1f26343SJason M. Bills { 1892e1f26343SJason M. Bills continue; 1893e1f26343SJason M. Bills } 1894e1f26343SJason M. Bills 1895e85d6b16SJason M. Bills if (firstEntry) 1896e85d6b16SJason M. Bills { 1897e85d6b16SJason M. Bills firstEntry = false; 1898e85d6b16SJason M. Bills } 1899e85d6b16SJason M. Bills 1900e1f26343SJason M. Bills logEntryArray.push_back({}); 1901c4bf6374SJason M. Bills nlohmann::json& bmcJournalLogEntry = logEntryArray.back(); 1902c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(idStr, journal.get(), 1903c4bf6374SJason M. Bills bmcJournalLogEntry) != 0) 1904e1f26343SJason M. Bills { 1905f12894f8SJason M. Bills messages::internalError(asyncResp->res); 1906e1f26343SJason M. Bills return; 1907e1f26343SJason M. Bills } 1908e1f26343SJason M. Bills } 1909193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 1910193ad2faSJason M. Bills if (skip + top < entryCount) 1911193ad2faSJason M. Bills { 1912193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 1913c4bf6374SJason M. Bills "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" + 1914193ad2faSJason M. Bills std::to_string(skip + top); 1915193ad2faSJason M. Bills } 1916e1f26343SJason M. Bills } 1917e1f26343SJason M. Bills }; 1918e1f26343SJason M. Bills 1919c4bf6374SJason M. Bills class BMCJournalLogEntry : public Node 1920e1f26343SJason M. Bills { 1921e1f26343SJason M. Bills public: 192252cc112dSEd Tanous BMCJournalLogEntry(App& app) : 1923c4bf6374SJason M. Bills Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/", 1924e1f26343SJason M. Bills std::string()) 1925e1f26343SJason M. Bills { 1926e1f26343SJason M. Bills entityPrivileges = { 1927e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1928e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1929e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1930e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1931e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1932e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1933e1f26343SJason M. Bills } 1934e1f26343SJason M. Bills 1935e1f26343SJason M. Bills private: 1936cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 1937e1f26343SJason M. Bills const std::vector<std::string>& params) override 1938e1f26343SJason M. Bills { 1939e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1940e1f26343SJason M. Bills if (params.size() != 1) 1941e1f26343SJason M. Bills { 1942f12894f8SJason M. Bills messages::internalError(asyncResp->res); 1943e1f26343SJason M. Bills return; 1944e1f26343SJason M. Bills } 194516428a1aSJason M. Bills const std::string& entryID = params[0]; 1946e1f26343SJason M. Bills // Convert the unique ID back to a timestamp to find the entry 1947e1f26343SJason M. Bills uint64_t ts = 0; 1948271584abSEd Tanous uint64_t index = 0; 194916428a1aSJason M. Bills if (!getTimestampFromID(asyncResp->res, entryID, ts, index)) 1950e1f26343SJason M. Bills { 195116428a1aSJason M. Bills return; 1952e1f26343SJason M. Bills } 1953e1f26343SJason M. Bills 1954e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 1955e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 1956e1f26343SJason M. Bills if (ret < 0) 1957e1f26343SJason M. Bills { 1958e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 1959f12894f8SJason M. Bills messages::internalError(asyncResp->res); 1960e1f26343SJason M. Bills return; 1961e1f26343SJason M. Bills } 1962e1f26343SJason M. Bills std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 1963e1f26343SJason M. Bills journalTmp, sd_journal_close); 1964e1f26343SJason M. Bills journalTmp = nullptr; 1965e1f26343SJason M. Bills // Go to the timestamp in the log and move to the entry at the index 1966af07e3f5SJason M. Bills // tracking the unique ID 1967af07e3f5SJason M. Bills std::string idStr; 1968af07e3f5SJason M. Bills bool firstEntry = true; 1969e1f26343SJason M. Bills ret = sd_journal_seek_realtime_usec(journal.get(), ts); 19702056b6d1SManojkiran Eda if (ret < 0) 19712056b6d1SManojkiran Eda { 19722056b6d1SManojkiran Eda BMCWEB_LOG_ERROR << "failed to seek to an entry in journal" 19732056b6d1SManojkiran Eda << strerror(-ret); 19742056b6d1SManojkiran Eda messages::internalError(asyncResp->res); 19752056b6d1SManojkiran Eda return; 19762056b6d1SManojkiran Eda } 1977271584abSEd Tanous for (uint64_t i = 0; i <= index; i++) 1978e1f26343SJason M. Bills { 1979e1f26343SJason M. Bills sd_journal_next(journal.get()); 1980af07e3f5SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 1981af07e3f5SJason M. Bills { 1982af07e3f5SJason M. Bills messages::internalError(asyncResp->res); 1983af07e3f5SJason M. Bills return; 1984af07e3f5SJason M. Bills } 1985af07e3f5SJason M. Bills if (firstEntry) 1986af07e3f5SJason M. Bills { 1987af07e3f5SJason M. Bills firstEntry = false; 1988af07e3f5SJason M. Bills } 1989e1f26343SJason M. Bills } 1990c4bf6374SJason M. Bills // Confirm that the entry ID matches what was requested 1991af07e3f5SJason M. Bills if (idStr != entryID) 1992c4bf6374SJason M. Bills { 1993c4bf6374SJason M. Bills messages::resourceMissingAtURI(asyncResp->res, entryID); 1994c4bf6374SJason M. Bills return; 1995c4bf6374SJason M. Bills } 1996c4bf6374SJason M. Bills 1997c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(entryID, journal.get(), 1998e1f26343SJason M. Bills asyncResp->res.jsonValue) != 0) 1999e1f26343SJason M. Bills { 2000f12894f8SJason M. Bills messages::internalError(asyncResp->res); 2001e1f26343SJason M. Bills return; 2002e1f26343SJason M. Bills } 2003e1f26343SJason M. Bills } 2004e1f26343SJason M. Bills }; 2005e1f26343SJason M. Bills 20065cb1dd27SAsmitha Karunanithi class BMCDumpService : public Node 2007c9bb6861Sraviteja-b { 2008c9bb6861Sraviteja-b public: 200952cc112dSEd Tanous BMCDumpService(App& app) : 20105cb1dd27SAsmitha Karunanithi Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/") 2011c9bb6861Sraviteja-b { 2012c9bb6861Sraviteja-b entityPrivileges = { 2013c9bb6861Sraviteja-b {boost::beast::http::verb::get, {{"Login"}}}, 2014c9bb6861Sraviteja-b {boost::beast::http::verb::head, {{"Login"}}}, 2015c9bb6861Sraviteja-b {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2016c9bb6861Sraviteja-b {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2017c9bb6861Sraviteja-b {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2018c9bb6861Sraviteja-b {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2019c9bb6861Sraviteja-b } 2020c9bb6861Sraviteja-b 2021c9bb6861Sraviteja-b private: 2022cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2023cb13a392SEd Tanous const std::vector<std::string>&) override 2024c9bb6861Sraviteja-b { 2025c9bb6861Sraviteja-b std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 2026c9bb6861Sraviteja-b 2027c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.id"] = 20285cb1dd27SAsmitha Karunanithi "/redfish/v1/Managers/bmc/LogServices/Dump"; 2029c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.type"] = 2030d337bb72SAsmitha Karunanithi "#LogService.v1_2_0.LogService"; 2031c9bb6861Sraviteja-b asyncResp->res.jsonValue["Name"] = "Dump LogService"; 20325cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Description"] = "BMC Dump LogService"; 20335cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = "Dump"; 2034c9bb6861Sraviteja-b asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 2035c9bb6861Sraviteja-b asyncResp->res.jsonValue["Entries"] = { 20365cb1dd27SAsmitha Karunanithi {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"}}; 20375cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Actions"] = { 20385cb1dd27SAsmitha Karunanithi {"#LogService.ClearLog", 20395cb1dd27SAsmitha Karunanithi {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/" 20405cb1dd27SAsmitha Karunanithi "Actions/LogService.ClearLog"}}}, 2041d337bb72SAsmitha Karunanithi {"#LogService.CollectDiagnosticData", 2042d337bb72SAsmitha Karunanithi {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/" 2043d337bb72SAsmitha Karunanithi "Actions/LogService.CollectDiagnosticData"}}}}; 2044c9bb6861Sraviteja-b } 2045c9bb6861Sraviteja-b }; 2046c9bb6861Sraviteja-b 20475cb1dd27SAsmitha Karunanithi class BMCDumpEntryCollection : public Node 2048c9bb6861Sraviteja-b { 2049c9bb6861Sraviteja-b public: 205052cc112dSEd Tanous BMCDumpEntryCollection(App& app) : 20515cb1dd27SAsmitha Karunanithi Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/") 2052c9bb6861Sraviteja-b { 2053c9bb6861Sraviteja-b entityPrivileges = { 2054c9bb6861Sraviteja-b {boost::beast::http::verb::get, {{"Login"}}}, 2055c9bb6861Sraviteja-b {boost::beast::http::verb::head, {{"Login"}}}, 2056c9bb6861Sraviteja-b {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2057c9bb6861Sraviteja-b {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2058c9bb6861Sraviteja-b {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2059c9bb6861Sraviteja-b {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2060c9bb6861Sraviteja-b } 2061c9bb6861Sraviteja-b 2062c9bb6861Sraviteja-b private: 2063c9bb6861Sraviteja-b /** 2064c9bb6861Sraviteja-b * Functions triggers appropriate requests on DBus 2065c9bb6861Sraviteja-b */ 2066cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2067cb13a392SEd Tanous const std::vector<std::string>&) override 2068c9bb6861Sraviteja-b { 2069c9bb6861Sraviteja-b std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 2070c9bb6861Sraviteja-b 2071c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.type"] = 2072c9bb6861Sraviteja-b "#LogEntryCollection.LogEntryCollection"; 2073c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.id"] = 20745cb1dd27SAsmitha Karunanithi "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"; 20755cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = "BMC Dump Entries"; 2076c9bb6861Sraviteja-b asyncResp->res.jsonValue["Description"] = 20775cb1dd27SAsmitha Karunanithi "Collection of BMC Dump Entries"; 2078c9bb6861Sraviteja-b 20795cb1dd27SAsmitha Karunanithi getDumpEntryCollection(asyncResp, "BMC"); 2080c9bb6861Sraviteja-b } 2081c9bb6861Sraviteja-b }; 2082c9bb6861Sraviteja-b 20835cb1dd27SAsmitha Karunanithi class BMCDumpEntry : public Node 2084c9bb6861Sraviteja-b { 2085c9bb6861Sraviteja-b public: 208652cc112dSEd Tanous BMCDumpEntry(App& app) : 20875cb1dd27SAsmitha Karunanithi Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/", 2088c9bb6861Sraviteja-b std::string()) 2089c9bb6861Sraviteja-b { 2090c9bb6861Sraviteja-b entityPrivileges = { 2091c9bb6861Sraviteja-b {boost::beast::http::verb::get, {{"Login"}}}, 2092c9bb6861Sraviteja-b {boost::beast::http::verb::head, {{"Login"}}}, 2093c9bb6861Sraviteja-b {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2094c9bb6861Sraviteja-b {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2095c9bb6861Sraviteja-b {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2096c9bb6861Sraviteja-b {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2097c9bb6861Sraviteja-b } 2098c9bb6861Sraviteja-b 2099c9bb6861Sraviteja-b private: 2100cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2101c9bb6861Sraviteja-b const std::vector<std::string>& params) override 2102c9bb6861Sraviteja-b { 2103c9bb6861Sraviteja-b std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 2104c9bb6861Sraviteja-b if (params.size() != 1) 2105c9bb6861Sraviteja-b { 2106c9bb6861Sraviteja-b messages::internalError(asyncResp->res); 2107c9bb6861Sraviteja-b return; 2108c9bb6861Sraviteja-b } 21095cb1dd27SAsmitha Karunanithi getDumpEntryById(asyncResp, params[0], "BMC"); 2110c9bb6861Sraviteja-b } 2111c9bb6861Sraviteja-b 2112cb13a392SEd Tanous void doDelete(crow::Response& res, const crow::Request&, 2113c9bb6861Sraviteja-b const std::vector<std::string>& params) override 2114c9bb6861Sraviteja-b { 21155cb1dd27SAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 2116c9bb6861Sraviteja-b if (params.size() != 1) 2117c9bb6861Sraviteja-b { 2118c9bb6861Sraviteja-b messages::internalError(asyncResp->res); 2119c9bb6861Sraviteja-b return; 2120c9bb6861Sraviteja-b } 21215cb1dd27SAsmitha Karunanithi deleteDumpEntry(asyncResp->res, params[0]); 21225cb1dd27SAsmitha Karunanithi } 21235cb1dd27SAsmitha Karunanithi }; 2124c9bb6861Sraviteja-b 2125a43be80fSAsmitha Karunanithi class BMCDumpCreate : public Node 2126a43be80fSAsmitha Karunanithi { 2127a43be80fSAsmitha Karunanithi public: 212852cc112dSEd Tanous BMCDumpCreate(App& app) : 2129a43be80fSAsmitha Karunanithi Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/" 2130d337bb72SAsmitha Karunanithi "Actions/" 2131d337bb72SAsmitha Karunanithi "LogService.CollectDiagnosticData/") 2132a43be80fSAsmitha Karunanithi { 2133a43be80fSAsmitha Karunanithi entityPrivileges = { 2134a43be80fSAsmitha Karunanithi {boost::beast::http::verb::get, {{"Login"}}}, 2135a43be80fSAsmitha Karunanithi {boost::beast::http::verb::head, {{"Login"}}}, 2136a43be80fSAsmitha Karunanithi {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2137a43be80fSAsmitha Karunanithi {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2138a43be80fSAsmitha Karunanithi {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2139a43be80fSAsmitha Karunanithi {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2140a43be80fSAsmitha Karunanithi } 2141a43be80fSAsmitha Karunanithi 2142a43be80fSAsmitha Karunanithi private: 2143a43be80fSAsmitha Karunanithi void doPost(crow::Response& res, const crow::Request& req, 2144cb13a392SEd Tanous const std::vector<std::string>&) override 2145a43be80fSAsmitha Karunanithi { 2146a43be80fSAsmitha Karunanithi createDump(res, req, "BMC"); 2147a43be80fSAsmitha Karunanithi } 2148a43be80fSAsmitha Karunanithi }; 2149a43be80fSAsmitha Karunanithi 215080319af1SAsmitha Karunanithi class BMCDumpClear : public Node 215180319af1SAsmitha Karunanithi { 215280319af1SAsmitha Karunanithi public: 215352cc112dSEd Tanous BMCDumpClear(App& app) : 215480319af1SAsmitha Karunanithi Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/" 215580319af1SAsmitha Karunanithi "Actions/" 215680319af1SAsmitha Karunanithi "LogService.ClearLog/") 215780319af1SAsmitha Karunanithi { 215880319af1SAsmitha Karunanithi entityPrivileges = { 215980319af1SAsmitha Karunanithi {boost::beast::http::verb::get, {{"Login"}}}, 216080319af1SAsmitha Karunanithi {boost::beast::http::verb::head, {{"Login"}}}, 216180319af1SAsmitha Karunanithi {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 216280319af1SAsmitha Karunanithi {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 216380319af1SAsmitha Karunanithi {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 216480319af1SAsmitha Karunanithi {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 216580319af1SAsmitha Karunanithi } 216680319af1SAsmitha Karunanithi 216780319af1SAsmitha Karunanithi private: 2168cb13a392SEd Tanous void doPost(crow::Response& res, const crow::Request&, 2169cb13a392SEd Tanous const std::vector<std::string>&) override 217080319af1SAsmitha Karunanithi { 217180319af1SAsmitha Karunanithi clearDump(res, "xyz.openbmc_project.Dump.Entry.BMC"); 217280319af1SAsmitha Karunanithi } 217380319af1SAsmitha Karunanithi }; 217480319af1SAsmitha Karunanithi 21755cb1dd27SAsmitha Karunanithi class SystemDumpService : public Node 2176c9bb6861Sraviteja-b { 21775cb1dd27SAsmitha Karunanithi public: 217852cc112dSEd Tanous SystemDumpService(App& app) : 21795cb1dd27SAsmitha Karunanithi Node(app, "/redfish/v1/Systems/system/LogServices/Dump/") 21805cb1dd27SAsmitha Karunanithi { 21815cb1dd27SAsmitha Karunanithi entityPrivileges = { 21825cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::get, {{"Login"}}}, 21835cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::head, {{"Login"}}}, 21845cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 21855cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 21865cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 21875cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 21885cb1dd27SAsmitha Karunanithi } 21895cb1dd27SAsmitha Karunanithi 21905cb1dd27SAsmitha Karunanithi private: 2191cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2192cb13a392SEd Tanous const std::vector<std::string>&) override 21935cb1dd27SAsmitha Karunanithi { 21945cb1dd27SAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 21955cb1dd27SAsmitha Karunanithi 21965cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.id"] = 21975cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump"; 21985cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 2199d337bb72SAsmitha Karunanithi "#LogService.v1_2_0.LogService"; 22005cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = "Dump LogService"; 22015cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Description"] = "System Dump LogService"; 22025cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = "Dump"; 22035cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 22045cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Entries"] = { 22055cb1dd27SAsmitha Karunanithi {"@odata.id", 22065cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump/Entries"}}; 22075cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Actions"] = { 22085cb1dd27SAsmitha Karunanithi {"#LogService.ClearLog", 22095cb1dd27SAsmitha Karunanithi {{"target", "/redfish/v1/Systems/system/LogServices/Dump/Actions/" 22105cb1dd27SAsmitha Karunanithi "LogService.ClearLog"}}}, 2211d337bb72SAsmitha Karunanithi {"#LogService.CollectDiagnosticData", 2212d337bb72SAsmitha Karunanithi {{"target", "/redfish/v1/Systems/system/LogServices/Dump/Actions/" 2213d337bb72SAsmitha Karunanithi "LogService.CollectDiagnosticData"}}}}; 22145cb1dd27SAsmitha Karunanithi } 22155cb1dd27SAsmitha Karunanithi }; 22165cb1dd27SAsmitha Karunanithi 22175cb1dd27SAsmitha Karunanithi class SystemDumpEntryCollection : public Node 22185cb1dd27SAsmitha Karunanithi { 22195cb1dd27SAsmitha Karunanithi public: 222052cc112dSEd Tanous SystemDumpEntryCollection(App& app) : 22215cb1dd27SAsmitha Karunanithi Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/") 22225cb1dd27SAsmitha Karunanithi { 22235cb1dd27SAsmitha Karunanithi entityPrivileges = { 22245cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::get, {{"Login"}}}, 22255cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::head, {{"Login"}}}, 22265cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 22275cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 22285cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 22295cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 22305cb1dd27SAsmitha Karunanithi } 22315cb1dd27SAsmitha Karunanithi 22325cb1dd27SAsmitha Karunanithi private: 22335cb1dd27SAsmitha Karunanithi /** 22345cb1dd27SAsmitha Karunanithi * Functions triggers appropriate requests on DBus 22355cb1dd27SAsmitha Karunanithi */ 2236cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2237cb13a392SEd Tanous const std::vector<std::string>&) override 22385cb1dd27SAsmitha Karunanithi { 22395cb1dd27SAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 22405cb1dd27SAsmitha Karunanithi 22415cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 22425cb1dd27SAsmitha Karunanithi "#LogEntryCollection.LogEntryCollection"; 22435cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.id"] = 22445cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump/Entries"; 22455cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = "System Dump Entries"; 22465cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Description"] = 22475cb1dd27SAsmitha Karunanithi "Collection of System Dump Entries"; 22485cb1dd27SAsmitha Karunanithi 22495cb1dd27SAsmitha Karunanithi getDumpEntryCollection(asyncResp, "System"); 22505cb1dd27SAsmitha Karunanithi } 22515cb1dd27SAsmitha Karunanithi }; 22525cb1dd27SAsmitha Karunanithi 22535cb1dd27SAsmitha Karunanithi class SystemDumpEntry : public Node 22545cb1dd27SAsmitha Karunanithi { 22555cb1dd27SAsmitha Karunanithi public: 225652cc112dSEd Tanous SystemDumpEntry(App& app) : 22575cb1dd27SAsmitha Karunanithi Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/", 22585cb1dd27SAsmitha Karunanithi std::string()) 22595cb1dd27SAsmitha Karunanithi { 22605cb1dd27SAsmitha Karunanithi entityPrivileges = { 22615cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::get, {{"Login"}}}, 22625cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::head, {{"Login"}}}, 22635cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 22645cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 22655cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 22665cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 22675cb1dd27SAsmitha Karunanithi } 22685cb1dd27SAsmitha Karunanithi 22695cb1dd27SAsmitha Karunanithi private: 2270cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 22715cb1dd27SAsmitha Karunanithi const std::vector<std::string>& params) override 22725cb1dd27SAsmitha Karunanithi { 22735cb1dd27SAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 22745cb1dd27SAsmitha Karunanithi if (params.size() != 1) 22755cb1dd27SAsmitha Karunanithi { 2276c9bb6861Sraviteja-b messages::internalError(asyncResp->res); 2277c9bb6861Sraviteja-b return; 2278c9bb6861Sraviteja-b } 22795cb1dd27SAsmitha Karunanithi getDumpEntryById(asyncResp, params[0], "System"); 22805cb1dd27SAsmitha Karunanithi } 2281c9bb6861Sraviteja-b 2282cb13a392SEd Tanous void doDelete(crow::Response& res, const crow::Request&, 22835cb1dd27SAsmitha Karunanithi const std::vector<std::string>& params) override 2284c9bb6861Sraviteja-b { 22855cb1dd27SAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 22865cb1dd27SAsmitha Karunanithi if (params.size() != 1) 2287c9bb6861Sraviteja-b { 22885cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 2289c9bb6861Sraviteja-b return; 2290c9bb6861Sraviteja-b } 22915cb1dd27SAsmitha Karunanithi deleteDumpEntry(asyncResp->res, params[0]); 2292c9bb6861Sraviteja-b } 2293c9bb6861Sraviteja-b }; 2294c9bb6861Sraviteja-b 2295a43be80fSAsmitha Karunanithi class SystemDumpCreate : public Node 2296a43be80fSAsmitha Karunanithi { 2297a43be80fSAsmitha Karunanithi public: 229852cc112dSEd Tanous SystemDumpCreate(App& app) : 2299a43be80fSAsmitha Karunanithi Node(app, "/redfish/v1/Systems/system/LogServices/Dump/" 2300d337bb72SAsmitha Karunanithi "Actions/" 2301d337bb72SAsmitha Karunanithi "LogService.CollectDiagnosticData/") 2302a43be80fSAsmitha Karunanithi { 2303a43be80fSAsmitha Karunanithi entityPrivileges = { 2304a43be80fSAsmitha Karunanithi {boost::beast::http::verb::get, {{"Login"}}}, 2305a43be80fSAsmitha Karunanithi {boost::beast::http::verb::head, {{"Login"}}}, 2306a43be80fSAsmitha Karunanithi {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2307a43be80fSAsmitha Karunanithi {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2308a43be80fSAsmitha Karunanithi {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2309a43be80fSAsmitha Karunanithi {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2310a43be80fSAsmitha Karunanithi } 2311a43be80fSAsmitha Karunanithi 2312a43be80fSAsmitha Karunanithi private: 2313a43be80fSAsmitha Karunanithi void doPost(crow::Response& res, const crow::Request& req, 2314cb13a392SEd Tanous const std::vector<std::string>&) override 2315a43be80fSAsmitha Karunanithi { 2316a43be80fSAsmitha Karunanithi createDump(res, req, "System"); 2317a43be80fSAsmitha Karunanithi } 2318a43be80fSAsmitha Karunanithi }; 2319a43be80fSAsmitha Karunanithi 2320013487e5Sraviteja-b class SystemDumpClear : public Node 2321013487e5Sraviteja-b { 2322013487e5Sraviteja-b public: 232352cc112dSEd Tanous SystemDumpClear(App& app) : 232480319af1SAsmitha Karunanithi Node(app, "/redfish/v1/Systems/system/LogServices/Dump/" 2325013487e5Sraviteja-b "Actions/" 2326013487e5Sraviteja-b "LogService.ClearLog/") 2327013487e5Sraviteja-b { 2328013487e5Sraviteja-b entityPrivileges = { 2329013487e5Sraviteja-b {boost::beast::http::verb::get, {{"Login"}}}, 2330013487e5Sraviteja-b {boost::beast::http::verb::head, {{"Login"}}}, 233180319af1SAsmitha Karunanithi {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 233280319af1SAsmitha Karunanithi {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 233380319af1SAsmitha Karunanithi {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2334013487e5Sraviteja-b {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2335013487e5Sraviteja-b } 2336013487e5Sraviteja-b 2337013487e5Sraviteja-b private: 2338cb13a392SEd Tanous void doPost(crow::Response& res, const crow::Request&, 2339cb13a392SEd Tanous const std::vector<std::string>&) override 2340013487e5Sraviteja-b { 234180319af1SAsmitha Karunanithi clearDump(res, "xyz.openbmc_project.Dump.Entry.System"); 2342013487e5Sraviteja-b } 2343013487e5Sraviteja-b }; 2344013487e5Sraviteja-b 2345424c4176SJason M. Bills class CrashdumpService : public Node 2346e1f26343SJason M. Bills { 2347e1f26343SJason M. Bills public: 234852cc112dSEd Tanous CrashdumpService(App& app) : 2349424c4176SJason M. Bills Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/") 23501da66f75SEd Tanous { 23513946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 23523946028dSAppaRao Puli // method for security reasons. 23531da66f75SEd Tanous entityPrivileges = { 23543946028dSAppaRao Puli {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 23553946028dSAppaRao Puli {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 2356e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2357e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2358e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2359e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 23601da66f75SEd Tanous } 23611da66f75SEd Tanous 23621da66f75SEd Tanous private: 23631da66f75SEd Tanous /** 23641da66f75SEd Tanous * Functions triggers appropriate requests on DBus 23651da66f75SEd Tanous */ 2366cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2367cb13a392SEd Tanous const std::vector<std::string>&) override 23681da66f75SEd Tanous { 2369e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 23701da66f75SEd Tanous // Copy over the static data to include the entries added by SubRoute 23710f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2372424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"; 2373e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2374e1f26343SJason M. Bills "#LogService.v1_1_0.LogService"; 23754f50ae4bSGunnar Mills asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service"; 23764f50ae4bSGunnar Mills asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service"; 23774f50ae4bSGunnar Mills asyncResp->res.jsonValue["Id"] = "Oem Crashdump"; 2378e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 2379e1f26343SJason M. Bills asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; 2380cd50aa42SJason M. Bills asyncResp->res.jsonValue["Entries"] = { 2381cd50aa42SJason M. Bills {"@odata.id", 2382424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}}; 2383e1f26343SJason M. Bills asyncResp->res.jsonValue["Actions"] = { 23845b61b5e8SJason M. Bills {"#LogService.ClearLog", 23855b61b5e8SJason M. Bills {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/" 23865b61b5e8SJason M. Bills "Actions/LogService.ClearLog"}}}, 23871da66f75SEd Tanous {"Oem", 2388424c4176SJason M. Bills {{"#Crashdump.OnDemand", 2389424c4176SJason M. Bills {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/" 23906eda7685SKenny L. Ku "Actions/Oem/Crashdump.OnDemand"}}}, 23916eda7685SKenny L. Ku {"#Crashdump.Telemetry", 23926eda7685SKenny L. Ku {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/" 23936eda7685SKenny L. Ku "Actions/Oem/Crashdump.Telemetry"}}}}}}; 23941da66f75SEd Tanous 23951da66f75SEd Tanous #ifdef BMCWEB_ENABLE_REDFISH_RAW_PECI 2396e1f26343SJason M. Bills asyncResp->res.jsonValue["Actions"]["Oem"].push_back( 2397424c4176SJason M. Bills {"#Crashdump.SendRawPeci", 239808a4e4b5SAnthony Wilson {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/" 2399424c4176SJason M. Bills "Actions/Oem/Crashdump.SendRawPeci"}}}); 24001da66f75SEd Tanous #endif 24011da66f75SEd Tanous } 24021da66f75SEd Tanous }; 24031da66f75SEd Tanous 24045b61b5e8SJason M. Bills class CrashdumpClear : public Node 24055b61b5e8SJason M. Bills { 24065b61b5e8SJason M. Bills public: 240752cc112dSEd Tanous CrashdumpClear(App& app) : 24085b61b5e8SJason M. Bills Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/" 24095b61b5e8SJason M. Bills "LogService.ClearLog/") 24105b61b5e8SJason M. Bills { 24113946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 24123946028dSAppaRao Puli // method for security reasons. 24135b61b5e8SJason M. Bills entityPrivileges = { 24143946028dSAppaRao Puli {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 24153946028dSAppaRao Puli {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 24165b61b5e8SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 24175b61b5e8SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 24185b61b5e8SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 24195b61b5e8SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 24205b61b5e8SJason M. Bills } 24215b61b5e8SJason M. Bills 24225b61b5e8SJason M. Bills private: 2423cb13a392SEd Tanous void doPost(crow::Response& res, const crow::Request&, 2424cb13a392SEd Tanous const std::vector<std::string>&) override 24255b61b5e8SJason M. Bills { 24265b61b5e8SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 24275b61b5e8SJason M. Bills 24285b61b5e8SJason M. Bills crow::connections::systemBus->async_method_call( 24295b61b5e8SJason M. Bills [asyncResp](const boost::system::error_code ec, 2430cb13a392SEd Tanous const std::string&) { 24315b61b5e8SJason M. Bills if (ec) 24325b61b5e8SJason M. Bills { 24335b61b5e8SJason M. Bills messages::internalError(asyncResp->res); 24345b61b5e8SJason M. Bills return; 24355b61b5e8SJason M. Bills } 24365b61b5e8SJason M. Bills messages::success(asyncResp->res); 24375b61b5e8SJason M. Bills }, 24385b61b5e8SJason M. Bills crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll"); 24395b61b5e8SJason M. Bills } 24405b61b5e8SJason M. Bills }; 24415b61b5e8SJason M. Bills 2442e855dd28SJason M. Bills static void logCrashdumpEntry(std::shared_ptr<AsyncResp> asyncResp, 2443e855dd28SJason M. Bills const std::string& logID, 2444e855dd28SJason M. Bills nlohmann::json& logEntryJson) 2445e855dd28SJason M. Bills { 2446043a0536SJohnathan Mantey auto getStoredLogCallback = 2447043a0536SJohnathan Mantey [asyncResp, logID, &logEntryJson]( 2448e855dd28SJason M. Bills const boost::system::error_code ec, 2449043a0536SJohnathan Mantey const std::vector<std::pair<std::string, VariantType>>& params) { 2450e855dd28SJason M. Bills if (ec) 2451e855dd28SJason M. Bills { 2452e855dd28SJason M. Bills BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 24531ddcf01aSJason M. Bills if (ec.value() == 24541ddcf01aSJason M. Bills boost::system::linux_error::bad_request_descriptor) 24551ddcf01aSJason M. Bills { 2456043a0536SJohnathan Mantey messages::resourceNotFound(asyncResp->res, "LogEntry", 2457043a0536SJohnathan Mantey logID); 24581ddcf01aSJason M. Bills } 24591ddcf01aSJason M. Bills else 24601ddcf01aSJason M. Bills { 2461e855dd28SJason M. Bills messages::internalError(asyncResp->res); 24621ddcf01aSJason M. Bills } 2463e855dd28SJason M. Bills return; 2464e855dd28SJason M. Bills } 2465043a0536SJohnathan Mantey 2466043a0536SJohnathan Mantey std::string timestamp{}; 2467043a0536SJohnathan Mantey std::string filename{}; 2468043a0536SJohnathan Mantey std::string logfile{}; 2469043a0536SJohnathan Mantey ParseCrashdumpParameters(params, filename, timestamp, logfile); 2470043a0536SJohnathan Mantey 2471043a0536SJohnathan Mantey if (filename.empty() || timestamp.empty()) 2472e855dd28SJason M. Bills { 2473043a0536SJohnathan Mantey messages::resourceMissingAtURI(asyncResp->res, logID); 2474e855dd28SJason M. Bills return; 2475e855dd28SJason M. Bills } 2476e855dd28SJason M. Bills 2477043a0536SJohnathan Mantey std::string crashdumpURI = 2478e855dd28SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + 2479043a0536SJohnathan Mantey logID + "/" + filename; 2480043a0536SJohnathan Mantey logEntryJson = {{"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 2481043a0536SJohnathan Mantey {"@odata.id", "/redfish/v1/Systems/system/" 2482043a0536SJohnathan Mantey "LogServices/Crashdump/Entries/" + 2483e855dd28SJason M. Bills logID}, 2484e855dd28SJason M. Bills {"Name", "CPU Crashdump"}, 2485e855dd28SJason M. Bills {"Id", logID}, 2486e855dd28SJason M. Bills {"EntryType", "Oem"}, 2487e855dd28SJason M. Bills {"OemRecordFormat", "Crashdump URI"}, 2488043a0536SJohnathan Mantey {"Message", std::move(crashdumpURI)}, 2489043a0536SJohnathan Mantey {"Created", std::move(timestamp)}}; 2490e855dd28SJason M. Bills }; 2491e855dd28SJason M. Bills crow::connections::systemBus->async_method_call( 24925b61b5e8SJason M. Bills std::move(getStoredLogCallback), crashdumpObject, 24935b61b5e8SJason M. Bills crashdumpPath + std::string("/") + logID, 2494043a0536SJohnathan Mantey "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface); 2495e855dd28SJason M. Bills } 2496e855dd28SJason M. Bills 2497424c4176SJason M. Bills class CrashdumpEntryCollection : public Node 24981da66f75SEd Tanous { 24991da66f75SEd Tanous public: 250052cc112dSEd Tanous CrashdumpEntryCollection(App& app) : 2501424c4176SJason M. Bills Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/") 25021da66f75SEd Tanous { 25033946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 25043946028dSAppaRao Puli // method for security reasons. 25051da66f75SEd Tanous entityPrivileges = { 25063946028dSAppaRao Puli {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 25073946028dSAppaRao Puli {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 2508e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2509e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2510e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2511e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 25121da66f75SEd Tanous } 25131da66f75SEd Tanous 25141da66f75SEd Tanous private: 25151da66f75SEd Tanous /** 25161da66f75SEd Tanous * Functions triggers appropriate requests on DBus 25171da66f75SEd Tanous */ 2518cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2519cb13a392SEd Tanous const std::vector<std::string>&) override 25201da66f75SEd Tanous { 2521e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 25221da66f75SEd Tanous // Collections don't include the static data added by SubRoute because 25231da66f75SEd Tanous // it has a duplicate entry for members 2524e1f26343SJason M. Bills auto getLogEntriesCallback = [asyncResp]( 2525e1f26343SJason M. Bills const boost::system::error_code ec, 25261da66f75SEd Tanous const std::vector<std::string>& resp) { 25271da66f75SEd Tanous if (ec) 25281da66f75SEd Tanous { 25291da66f75SEd Tanous if (ec.value() != 25301da66f75SEd Tanous boost::system::errc::no_such_file_or_directory) 25311da66f75SEd Tanous { 25321da66f75SEd Tanous BMCWEB_LOG_DEBUG << "failed to get entries ec: " 25331da66f75SEd Tanous << ec.message(); 2534f12894f8SJason M. Bills messages::internalError(asyncResp->res); 25351da66f75SEd Tanous return; 25361da66f75SEd Tanous } 25371da66f75SEd Tanous } 2538e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 25391da66f75SEd Tanous "#LogEntryCollection.LogEntryCollection"; 25400f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2541424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 2542424c4176SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries"; 2543e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2544424c4176SJason M. Bills "Collection of Crashdump Entries"; 2545e1f26343SJason M. Bills nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2546e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 2547e855dd28SJason M. Bills std::vector<std::string> logIDs; 2548e855dd28SJason M. Bills // Get the list of log entries and build up an empty array big 2549e855dd28SJason M. Bills // enough to hold them 25501da66f75SEd Tanous for (const std::string& objpath : resp) 25511da66f75SEd Tanous { 2552e855dd28SJason M. Bills // Get the log ID 25534ed77cd5SEd Tanous std::size_t lastPos = objpath.rfind("/"); 2554e855dd28SJason M. Bills if (lastPos == std::string::npos) 25551da66f75SEd Tanous { 2556e855dd28SJason M. Bills continue; 25571da66f75SEd Tanous } 2558e855dd28SJason M. Bills logIDs.emplace_back(objpath.substr(lastPos + 1)); 2559e855dd28SJason M. Bills 2560e855dd28SJason M. Bills // Add a space for the log entry to the array 2561e855dd28SJason M. Bills logEntryArray.push_back({}); 2562e855dd28SJason M. Bills } 2563e855dd28SJason M. Bills // Now go through and set up async calls to fill in the entries 2564e855dd28SJason M. Bills size_t index = 0; 2565e855dd28SJason M. Bills for (const std::string& logID : logIDs) 2566e855dd28SJason M. Bills { 2567e855dd28SJason M. Bills // Add the log entry to the array 2568e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, logEntryArray[index++]); 25691da66f75SEd Tanous } 2570e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 2571e1f26343SJason M. Bills logEntryArray.size(); 25721da66f75SEd Tanous }; 25731da66f75SEd Tanous crow::connections::systemBus->async_method_call( 25741da66f75SEd Tanous std::move(getLogEntriesCallback), 25751da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", 25761da66f75SEd Tanous "/xyz/openbmc_project/object_mapper", 25771da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0, 25785b61b5e8SJason M. Bills std::array<const char*, 1>{crashdumpInterface}); 25791da66f75SEd Tanous } 25801da66f75SEd Tanous }; 25811da66f75SEd Tanous 2582424c4176SJason M. Bills class CrashdumpEntry : public Node 25831da66f75SEd Tanous { 25841da66f75SEd Tanous public: 258552cc112dSEd Tanous CrashdumpEntry(App& app) : 2586d53dd41fSJason M. Bills Node(app, 2587424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/", 25881da66f75SEd Tanous std::string()) 25891da66f75SEd Tanous { 25903946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 25913946028dSAppaRao Puli // method for security reasons. 25921da66f75SEd Tanous entityPrivileges = { 25933946028dSAppaRao Puli {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 25943946028dSAppaRao Puli {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 2595e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2596e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2597e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2598e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 25991da66f75SEd Tanous } 26001da66f75SEd Tanous 26011da66f75SEd Tanous private: 2602cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 26031da66f75SEd Tanous const std::vector<std::string>& params) override 26041da66f75SEd Tanous { 2605e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 26061da66f75SEd Tanous if (params.size() != 1) 26071da66f75SEd Tanous { 2608f12894f8SJason M. Bills messages::internalError(asyncResp->res); 26091da66f75SEd Tanous return; 26101da66f75SEd Tanous } 2611e855dd28SJason M. Bills const std::string& logID = params[0]; 2612e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue); 2613e855dd28SJason M. Bills } 2614e855dd28SJason M. Bills }; 2615e855dd28SJason M. Bills 2616e855dd28SJason M. Bills class CrashdumpFile : public Node 2617e855dd28SJason M. Bills { 2618e855dd28SJason M. Bills public: 261952cc112dSEd Tanous CrashdumpFile(App& app) : 2620e855dd28SJason M. Bills Node(app, 2621e855dd28SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/" 2622e855dd28SJason M. Bills "<str>/", 2623e855dd28SJason M. Bills std::string(), std::string()) 2624e855dd28SJason M. Bills { 26253946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 26263946028dSAppaRao Puli // method for security reasons. 2627e855dd28SJason M. Bills entityPrivileges = { 26283946028dSAppaRao Puli {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 26293946028dSAppaRao Puli {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 2630e855dd28SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2631e855dd28SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2632e855dd28SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2633e855dd28SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2634e855dd28SJason M. Bills } 2635e855dd28SJason M. Bills 2636e855dd28SJason M. Bills private: 2637cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2638e855dd28SJason M. Bills const std::vector<std::string>& params) override 2639e855dd28SJason M. Bills { 2640e855dd28SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 2641e855dd28SJason M. Bills if (params.size() != 2) 2642e855dd28SJason M. Bills { 2643e855dd28SJason M. Bills messages::internalError(asyncResp->res); 2644e855dd28SJason M. Bills return; 2645e855dd28SJason M. Bills } 2646e855dd28SJason M. Bills const std::string& logID = params[0]; 2647e855dd28SJason M. Bills const std::string& fileName = params[1]; 2648e855dd28SJason M. Bills 2649043a0536SJohnathan Mantey auto getStoredLogCallback = 2650043a0536SJohnathan Mantey [asyncResp, logID, fileName]( 2651abf2add6SEd Tanous const boost::system::error_code ec, 2652043a0536SJohnathan Mantey const std::vector<std::pair<std::string, VariantType>>& resp) { 26531da66f75SEd Tanous if (ec) 26541da66f75SEd Tanous { 2655043a0536SJohnathan Mantey BMCWEB_LOG_DEBUG << "failed to get log ec: " 2656043a0536SJohnathan Mantey << ec.message(); 2657f12894f8SJason M. Bills messages::internalError(asyncResp->res); 26581da66f75SEd Tanous return; 26591da66f75SEd Tanous } 2660e855dd28SJason M. Bills 2661043a0536SJohnathan Mantey std::string dbusFilename{}; 2662043a0536SJohnathan Mantey std::string dbusTimestamp{}; 2663043a0536SJohnathan Mantey std::string dbusFilepath{}; 2664043a0536SJohnathan Mantey 2665043a0536SJohnathan Mantey ParseCrashdumpParameters(resp, dbusFilename, dbusTimestamp, 2666043a0536SJohnathan Mantey dbusFilepath); 2667043a0536SJohnathan Mantey 2668043a0536SJohnathan Mantey if (dbusFilename.empty() || dbusTimestamp.empty() || 2669043a0536SJohnathan Mantey dbusFilepath.empty()) 26701da66f75SEd Tanous { 2671e855dd28SJason M. Bills messages::resourceMissingAtURI(asyncResp->res, fileName); 26721da66f75SEd Tanous return; 26731da66f75SEd Tanous } 2674e855dd28SJason M. Bills 2675043a0536SJohnathan Mantey // Verify the file name parameter is correct 2676043a0536SJohnathan Mantey if (fileName != dbusFilename) 2677043a0536SJohnathan Mantey { 2678043a0536SJohnathan Mantey messages::resourceMissingAtURI(asyncResp->res, fileName); 2679043a0536SJohnathan Mantey return; 2680043a0536SJohnathan Mantey } 2681043a0536SJohnathan Mantey 2682043a0536SJohnathan Mantey if (!std::filesystem::exists(dbusFilepath)) 2683043a0536SJohnathan Mantey { 2684043a0536SJohnathan Mantey messages::resourceMissingAtURI(asyncResp->res, fileName); 2685043a0536SJohnathan Mantey return; 2686043a0536SJohnathan Mantey } 2687043a0536SJohnathan Mantey std::ifstream ifs(dbusFilepath, std::ios::in | 2688043a0536SJohnathan Mantey std::ios::binary | 2689043a0536SJohnathan Mantey std::ios::ate); 2690043a0536SJohnathan Mantey std::ifstream::pos_type fileSize = ifs.tellg(); 2691043a0536SJohnathan Mantey if (fileSize < 0) 2692043a0536SJohnathan Mantey { 2693043a0536SJohnathan Mantey messages::generalError(asyncResp->res); 2694043a0536SJohnathan Mantey return; 2695043a0536SJohnathan Mantey } 2696043a0536SJohnathan Mantey ifs.seekg(0, std::ios::beg); 2697043a0536SJohnathan Mantey 2698043a0536SJohnathan Mantey auto crashData = std::make_unique<char[]>( 2699043a0536SJohnathan Mantey static_cast<unsigned int>(fileSize)); 2700043a0536SJohnathan Mantey 2701043a0536SJohnathan Mantey ifs.read(crashData.get(), static_cast<int>(fileSize)); 2702043a0536SJohnathan Mantey 2703043a0536SJohnathan Mantey // The cast to std::string is intentional in order to use the 2704043a0536SJohnathan Mantey // assign() that applies move mechanics 2705043a0536SJohnathan Mantey asyncResp->res.body().assign( 2706043a0536SJohnathan Mantey static_cast<std::string>(crashData.get())); 2707043a0536SJohnathan Mantey 2708043a0536SJohnathan Mantey // Configure this to be a file download when accessed from 2709043a0536SJohnathan Mantey // a browser 2710e855dd28SJason M. Bills asyncResp->res.addHeader("Content-Disposition", "attachment"); 27111da66f75SEd Tanous }; 27121da66f75SEd Tanous crow::connections::systemBus->async_method_call( 27135b61b5e8SJason M. Bills std::move(getStoredLogCallback), crashdumpObject, 27145b61b5e8SJason M. Bills crashdumpPath + std::string("/") + logID, 2715043a0536SJohnathan Mantey "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface); 27161da66f75SEd Tanous } 27171da66f75SEd Tanous }; 27181da66f75SEd Tanous 2719424c4176SJason M. Bills class OnDemandCrashdump : public Node 27201da66f75SEd Tanous { 27211da66f75SEd Tanous public: 272252cc112dSEd Tanous OnDemandCrashdump(App& app) : 2723424c4176SJason M. Bills Node(app, 2724424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/" 2725424c4176SJason M. Bills "Crashdump.OnDemand/") 27261da66f75SEd Tanous { 27273946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 27283946028dSAppaRao Puli // method for security reasons. 27291da66f75SEd Tanous entityPrivileges = { 27303946028dSAppaRao Puli {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 27313946028dSAppaRao Puli {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 27323946028dSAppaRao Puli {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 27333946028dSAppaRao Puli {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 27343946028dSAppaRao Puli {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 27353946028dSAppaRao Puli {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 27361da66f75SEd Tanous } 27371da66f75SEd Tanous 27381da66f75SEd Tanous private: 27391da66f75SEd Tanous void doPost(crow::Response& res, const crow::Request& req, 2740cb13a392SEd Tanous const std::vector<std::string>&) override 27411da66f75SEd Tanous { 2742e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 27431da66f75SEd Tanous 2744fe306728SJames Feist auto generateonDemandLogCallback = [asyncResp, 2745fe306728SJames Feist req](const boost::system::error_code 274646229577SJames Feist ec, 2747cb13a392SEd Tanous const std::string&) { 27481da66f75SEd Tanous if (ec) 27491da66f75SEd Tanous { 275046229577SJames Feist if (ec.value() == boost::system::errc::operation_not_supported) 27511da66f75SEd Tanous { 2752f12894f8SJason M. Bills messages::resourceInStandby(asyncResp->res); 27531da66f75SEd Tanous } 27544363d3b2SJason M. Bills else if (ec.value() == 27554363d3b2SJason M. Bills boost::system::errc::device_or_resource_busy) 27564363d3b2SJason M. Bills { 27574363d3b2SJason M. Bills messages::serviceTemporarilyUnavailable(asyncResp->res, 27584363d3b2SJason M. Bills "60"); 27594363d3b2SJason M. Bills } 27601da66f75SEd Tanous else 27611da66f75SEd Tanous { 2762f12894f8SJason M. Bills messages::internalError(asyncResp->res); 27631da66f75SEd Tanous } 27641da66f75SEd Tanous return; 27651da66f75SEd Tanous } 276646229577SJames Feist std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 276766afe4faSJames Feist [](boost::system::error_code err, sdbusplus::message::message&, 276866afe4faSJames Feist const std::shared_ptr<task::TaskData>& taskData) { 276966afe4faSJames Feist if (!err) 277066afe4faSJames Feist { 2771e5d5006bSJames Feist taskData->messages.emplace_back( 2772e5d5006bSJames Feist messages::taskCompletedOK( 2773e5d5006bSJames Feist std::to_string(taskData->index))); 2774831d6b09SJames Feist taskData->state = "Completed"; 277566afe4faSJames Feist } 277632898ceaSJames Feist return task::completed; 277766afe4faSJames Feist }, 277846229577SJames Feist "type='signal',interface='org.freedesktop.DBus.Properties'," 277946229577SJames Feist "member='PropertiesChanged',arg0namespace='com.intel." 278046229577SJames Feist "crashdump'"); 278146229577SJames Feist task->startTimer(std::chrono::minutes(5)); 278246229577SJames Feist task->populateResp(asyncResp->res); 2783fe306728SJames Feist task->payload.emplace(req); 27841da66f75SEd Tanous }; 27851da66f75SEd Tanous crow::connections::systemBus->async_method_call( 27865b61b5e8SJason M. Bills std::move(generateonDemandLogCallback), crashdumpObject, 27875b61b5e8SJason M. Bills crashdumpPath, crashdumpOnDemandInterface, "GenerateOnDemandLog"); 27881da66f75SEd Tanous } 27891da66f75SEd Tanous }; 27901da66f75SEd Tanous 27916eda7685SKenny L. Ku class TelemetryCrashdump : public Node 27926eda7685SKenny L. Ku { 27936eda7685SKenny L. Ku public: 279452cc112dSEd Tanous TelemetryCrashdump(App& app) : 27956eda7685SKenny L. Ku Node(app, 27966eda7685SKenny L. Ku "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/" 27976eda7685SKenny L. Ku "Crashdump.Telemetry/") 27986eda7685SKenny L. Ku { 27996eda7685SKenny L. Ku // Note: Deviated from redfish privilege registry for GET & HEAD 28006eda7685SKenny L. Ku // method for security reasons. 28016eda7685SKenny L. Ku entityPrivileges = { 28026eda7685SKenny L. Ku {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 28036eda7685SKenny L. Ku {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 28046eda7685SKenny L. Ku {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 28056eda7685SKenny L. Ku {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 28066eda7685SKenny L. Ku {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 28076eda7685SKenny L. Ku {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 28086eda7685SKenny L. Ku } 28096eda7685SKenny L. Ku 28106eda7685SKenny L. Ku private: 28116eda7685SKenny L. Ku void doPost(crow::Response& res, const crow::Request& req, 2812cb13a392SEd Tanous const std::vector<std::string>&) override 28136eda7685SKenny L. Ku { 28146eda7685SKenny L. Ku std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 28156eda7685SKenny L. Ku 28166eda7685SKenny L. Ku auto generateTelemetryLogCallback = [asyncResp, req]( 28176eda7685SKenny L. Ku const boost::system::error_code 28186eda7685SKenny L. Ku ec, 2819cb13a392SEd Tanous const std::string&) { 28206eda7685SKenny L. Ku if (ec) 28216eda7685SKenny L. Ku { 28226eda7685SKenny L. Ku if (ec.value() == boost::system::errc::operation_not_supported) 28236eda7685SKenny L. Ku { 28246eda7685SKenny L. Ku messages::resourceInStandby(asyncResp->res); 28256eda7685SKenny L. Ku } 28266eda7685SKenny L. Ku else if (ec.value() == 28276eda7685SKenny L. Ku boost::system::errc::device_or_resource_busy) 28286eda7685SKenny L. Ku { 28296eda7685SKenny L. Ku messages::serviceTemporarilyUnavailable(asyncResp->res, 28306eda7685SKenny L. Ku "60"); 28316eda7685SKenny L. Ku } 28326eda7685SKenny L. Ku else 28336eda7685SKenny L. Ku { 28346eda7685SKenny L. Ku messages::internalError(asyncResp->res); 28356eda7685SKenny L. Ku } 28366eda7685SKenny L. Ku return; 28376eda7685SKenny L. Ku } 28386eda7685SKenny L. Ku std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 28396eda7685SKenny L. Ku [](boost::system::error_code err, sdbusplus::message::message&, 28406eda7685SKenny L. Ku const std::shared_ptr<task::TaskData>& taskData) { 28416eda7685SKenny L. Ku if (!err) 28426eda7685SKenny L. Ku { 28436eda7685SKenny L. Ku taskData->messages.emplace_back( 28446eda7685SKenny L. Ku messages::taskCompletedOK( 28456eda7685SKenny L. Ku std::to_string(taskData->index))); 28466eda7685SKenny L. Ku taskData->state = "Completed"; 28476eda7685SKenny L. Ku } 28486eda7685SKenny L. Ku return task::completed; 28496eda7685SKenny L. Ku }, 28506eda7685SKenny L. Ku "type='signal',interface='org.freedesktop.DBus.Properties'," 28516eda7685SKenny L. Ku "member='PropertiesChanged',arg0namespace='com.intel." 28526eda7685SKenny L. Ku "crashdump'"); 28536eda7685SKenny L. Ku task->startTimer(std::chrono::minutes(5)); 28546eda7685SKenny L. Ku task->populateResp(asyncResp->res); 28556eda7685SKenny L. Ku task->payload.emplace(req); 28566eda7685SKenny L. Ku }; 28576eda7685SKenny L. Ku crow::connections::systemBus->async_method_call( 28586eda7685SKenny L. Ku std::move(generateTelemetryLogCallback), crashdumpObject, 28596eda7685SKenny L. Ku crashdumpPath, crashdumpTelemetryInterface, "GenerateTelemetryLog"); 28606eda7685SKenny L. Ku } 28616eda7685SKenny L. Ku }; 28626eda7685SKenny L. Ku 2863e1f26343SJason M. Bills class SendRawPECI : public Node 28641da66f75SEd Tanous { 28651da66f75SEd Tanous public: 286652cc112dSEd Tanous SendRawPECI(App& app) : 2867424c4176SJason M. Bills Node(app, 2868424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/" 2869424c4176SJason M. Bills "Crashdump.SendRawPeci/") 28701da66f75SEd Tanous { 28713946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 28723946028dSAppaRao Puli // method for security reasons. 28731da66f75SEd Tanous entityPrivileges = { 28741da66f75SEd Tanous {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 28751da66f75SEd Tanous {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 28761da66f75SEd Tanous {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 28771da66f75SEd Tanous {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 28781da66f75SEd Tanous {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 28791da66f75SEd Tanous {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 28801da66f75SEd Tanous } 28811da66f75SEd Tanous 28821da66f75SEd Tanous private: 28831da66f75SEd Tanous void doPost(crow::Response& res, const crow::Request& req, 2884cb13a392SEd Tanous const std::vector<std::string>&) override 28851da66f75SEd Tanous { 2886e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 28878724c297SKarthick Sundarrajan std::vector<std::vector<uint8_t>> peciCommands; 28888724c297SKarthick Sundarrajan 28898724c297SKarthick Sundarrajan if (!json_util::readJson(req, res, "PECICommands", peciCommands)) 28908724c297SKarthick Sundarrajan { 28918724c297SKarthick Sundarrajan return; 28928724c297SKarthick Sundarrajan } 28938724c297SKarthick Sundarrajan uint32_t idx = 0; 28948724c297SKarthick Sundarrajan for (auto const& cmd : peciCommands) 28958724c297SKarthick Sundarrajan { 28968724c297SKarthick Sundarrajan if (cmd.size() < 3) 28978724c297SKarthick Sundarrajan { 28988724c297SKarthick Sundarrajan std::string s("["); 28998724c297SKarthick Sundarrajan for (auto const& val : cmd) 29008724c297SKarthick Sundarrajan { 29018724c297SKarthick Sundarrajan if (val != *cmd.begin()) 29028724c297SKarthick Sundarrajan { 29038724c297SKarthick Sundarrajan s += ","; 29048724c297SKarthick Sundarrajan } 29058724c297SKarthick Sundarrajan s += std::to_string(val); 29068724c297SKarthick Sundarrajan } 29078724c297SKarthick Sundarrajan s += "]"; 29088724c297SKarthick Sundarrajan messages::actionParameterValueFormatError( 29098724c297SKarthick Sundarrajan res, s, "PECICommands[" + std::to_string(idx) + "]", 29108724c297SKarthick Sundarrajan "SendRawPeci"); 29118724c297SKarthick Sundarrajan return; 29128724c297SKarthick Sundarrajan } 29138724c297SKarthick Sundarrajan idx++; 29148724c297SKarthick Sundarrajan } 29151da66f75SEd Tanous // Callback to return the Raw PECI response 2916e1f26343SJason M. Bills auto sendRawPECICallback = 2917e1f26343SJason M. Bills [asyncResp](const boost::system::error_code ec, 29188724c297SKarthick Sundarrajan const std::vector<std::vector<uint8_t>>& resp) { 29191da66f75SEd Tanous if (ec) 29201da66f75SEd Tanous { 29218724c297SKarthick Sundarrajan BMCWEB_LOG_DEBUG << "failed to process PECI commands ec: " 29221da66f75SEd Tanous << ec.message(); 2923f12894f8SJason M. Bills messages::internalError(asyncResp->res); 29241da66f75SEd Tanous return; 29251da66f75SEd Tanous } 2926e1f26343SJason M. Bills asyncResp->res.jsonValue = {{"Name", "PECI Command Response"}, 29271da66f75SEd Tanous {"PECIResponse", resp}}; 29281da66f75SEd Tanous }; 29291da66f75SEd Tanous // Call the SendRawPECI command with the provided data 29301da66f75SEd Tanous crow::connections::systemBus->async_method_call( 29315b61b5e8SJason M. Bills std::move(sendRawPECICallback), crashdumpObject, crashdumpPath, 29328724c297SKarthick Sundarrajan crashdumpRawPECIInterface, "SendRawPeci", peciCommands); 29331da66f75SEd Tanous } 29341da66f75SEd Tanous }; 29351da66f75SEd Tanous 2936cb92c03bSAndrew Geissler /** 2937cb92c03bSAndrew Geissler * DBusLogServiceActionsClear class supports POST method for ClearLog action. 2938cb92c03bSAndrew Geissler */ 2939cb92c03bSAndrew Geissler class DBusLogServiceActionsClear : public Node 2940cb92c03bSAndrew Geissler { 2941cb92c03bSAndrew Geissler public: 294252cc112dSEd Tanous DBusLogServiceActionsClear(App& app) : 2943cb92c03bSAndrew Geissler Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/" 29447af91514SGunnar Mills "LogService.ClearLog/") 2945cb92c03bSAndrew Geissler { 2946cb92c03bSAndrew Geissler entityPrivileges = { 2947cb92c03bSAndrew Geissler {boost::beast::http::verb::get, {{"Login"}}}, 2948cb92c03bSAndrew Geissler {boost::beast::http::verb::head, {{"Login"}}}, 2949cb92c03bSAndrew Geissler {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2950cb92c03bSAndrew Geissler {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2951cb92c03bSAndrew Geissler {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2952cb92c03bSAndrew Geissler {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2953cb92c03bSAndrew Geissler } 2954cb92c03bSAndrew Geissler 2955cb92c03bSAndrew Geissler private: 2956cb92c03bSAndrew Geissler /** 2957cb92c03bSAndrew Geissler * Function handles POST method request. 2958cb92c03bSAndrew Geissler * The Clear Log actions does not require any parameter.The action deletes 2959cb92c03bSAndrew Geissler * all entries found in the Entries collection for this Log Service. 2960cb92c03bSAndrew Geissler */ 2961cb13a392SEd Tanous void doPost(crow::Response& res, const crow::Request&, 2962cb13a392SEd Tanous const std::vector<std::string>&) override 2963cb92c03bSAndrew Geissler { 2964cb92c03bSAndrew Geissler BMCWEB_LOG_DEBUG << "Do delete all entries."; 2965cb92c03bSAndrew Geissler 2966cb92c03bSAndrew Geissler auto asyncResp = std::make_shared<AsyncResp>(res); 2967cb92c03bSAndrew Geissler // Process response from Logging service. 2968cb92c03bSAndrew Geissler auto resp_handler = [asyncResp](const boost::system::error_code ec) { 2969cb92c03bSAndrew Geissler BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done"; 2970cb92c03bSAndrew Geissler if (ec) 2971cb92c03bSAndrew Geissler { 2972cb92c03bSAndrew Geissler // TODO Handle for specific error code 2973cb92c03bSAndrew Geissler BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec; 2974cb92c03bSAndrew Geissler asyncResp->res.result( 2975cb92c03bSAndrew Geissler boost::beast::http::status::internal_server_error); 2976cb92c03bSAndrew Geissler return; 2977cb92c03bSAndrew Geissler } 2978cb92c03bSAndrew Geissler 2979cb92c03bSAndrew Geissler asyncResp->res.result(boost::beast::http::status::no_content); 2980cb92c03bSAndrew Geissler }; 2981cb92c03bSAndrew Geissler 2982cb92c03bSAndrew Geissler // Make call to Logging service to request Clear Log 2983cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 2984cb92c03bSAndrew Geissler resp_handler, "xyz.openbmc_project.Logging", 2985cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging", 2986cb92c03bSAndrew Geissler "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 2987cb92c03bSAndrew Geissler } 2988cb92c03bSAndrew Geissler }; 2989a3316fc6SZhikuiRen 2990a3316fc6SZhikuiRen /**************************************************** 2991a3316fc6SZhikuiRen * Redfish PostCode interfaces 2992a3316fc6SZhikuiRen * using DBUS interface: getPostCodesTS 2993a3316fc6SZhikuiRen ******************************************************/ 2994a3316fc6SZhikuiRen class PostCodesLogService : public Node 2995a3316fc6SZhikuiRen { 2996a3316fc6SZhikuiRen public: 299752cc112dSEd Tanous PostCodesLogService(App& app) : 2998a3316fc6SZhikuiRen Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/") 2999a3316fc6SZhikuiRen { 3000a3316fc6SZhikuiRen entityPrivileges = { 3001a3316fc6SZhikuiRen {boost::beast::http::verb::get, {{"Login"}}}, 3002a3316fc6SZhikuiRen {boost::beast::http::verb::head, {{"Login"}}}, 3003a3316fc6SZhikuiRen {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 3004a3316fc6SZhikuiRen {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 3005a3316fc6SZhikuiRen {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 3006a3316fc6SZhikuiRen {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 3007a3316fc6SZhikuiRen } 3008a3316fc6SZhikuiRen 3009a3316fc6SZhikuiRen private: 3010cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 3011cb13a392SEd Tanous const std::vector<std::string>&) override 3012a3316fc6SZhikuiRen { 3013a3316fc6SZhikuiRen std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 3014a3316fc6SZhikuiRen 3015a3316fc6SZhikuiRen asyncResp->res.jsonValue = { 3016a3316fc6SZhikuiRen {"@odata.id", "/redfish/v1/Systems/system/LogServices/PostCodes"}, 3017a3316fc6SZhikuiRen {"@odata.type", "#LogService.v1_1_0.LogService"}, 3018a3316fc6SZhikuiRen {"@odata.context", "/redfish/v1/$metadata#LogService.LogService"}, 3019a3316fc6SZhikuiRen {"Name", "POST Code Log Service"}, 3020a3316fc6SZhikuiRen {"Description", "POST Code Log Service"}, 3021a3316fc6SZhikuiRen {"Id", "BIOS POST Code Log"}, 3022a3316fc6SZhikuiRen {"OverWritePolicy", "WrapsWhenFull"}, 3023a3316fc6SZhikuiRen {"Entries", 3024a3316fc6SZhikuiRen {{"@odata.id", 3025a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"}}}}; 3026a3316fc6SZhikuiRen asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 3027a3316fc6SZhikuiRen {"target", "/redfish/v1/Systems/system/LogServices/PostCodes/" 3028a3316fc6SZhikuiRen "Actions/LogService.ClearLog"}}; 3029a3316fc6SZhikuiRen } 3030a3316fc6SZhikuiRen }; 3031a3316fc6SZhikuiRen 3032a3316fc6SZhikuiRen class PostCodesClear : public Node 3033a3316fc6SZhikuiRen { 3034a3316fc6SZhikuiRen public: 303552cc112dSEd Tanous PostCodesClear(App& app) : 3036a3316fc6SZhikuiRen Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/" 3037a3316fc6SZhikuiRen "LogService.ClearLog/") 3038a3316fc6SZhikuiRen { 3039a3316fc6SZhikuiRen entityPrivileges = { 3040a3316fc6SZhikuiRen {boost::beast::http::verb::get, {{"Login"}}}, 3041a3316fc6SZhikuiRen {boost::beast::http::verb::head, {{"Login"}}}, 30423946028dSAppaRao Puli {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 30433946028dSAppaRao Puli {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 30443946028dSAppaRao Puli {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 30453946028dSAppaRao Puli {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 3046a3316fc6SZhikuiRen } 3047a3316fc6SZhikuiRen 3048a3316fc6SZhikuiRen private: 3049cb13a392SEd Tanous void doPost(crow::Response& res, const crow::Request&, 3050cb13a392SEd Tanous const std::vector<std::string>&) override 3051a3316fc6SZhikuiRen { 3052a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Do delete all postcodes entries."; 3053a3316fc6SZhikuiRen 3054a3316fc6SZhikuiRen std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 3055a3316fc6SZhikuiRen // Make call to post-code service to request clear all 3056a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3057a3316fc6SZhikuiRen [asyncResp](const boost::system::error_code ec) { 3058a3316fc6SZhikuiRen if (ec) 3059a3316fc6SZhikuiRen { 3060a3316fc6SZhikuiRen // TODO Handle for specific error code 3061a3316fc6SZhikuiRen BMCWEB_LOG_ERROR 3062a3316fc6SZhikuiRen << "doClearPostCodes resp_handler got error " << ec; 3063a3316fc6SZhikuiRen asyncResp->res.result( 3064a3316fc6SZhikuiRen boost::beast::http::status::internal_server_error); 3065a3316fc6SZhikuiRen messages::internalError(asyncResp->res); 3066a3316fc6SZhikuiRen return; 3067a3316fc6SZhikuiRen } 3068a3316fc6SZhikuiRen }, 3069a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", 3070a3316fc6SZhikuiRen "/xyz/openbmc_project/State/Boot/PostCode", 3071a3316fc6SZhikuiRen "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 3072a3316fc6SZhikuiRen } 3073a3316fc6SZhikuiRen }; 3074a3316fc6SZhikuiRen 3075a3316fc6SZhikuiRen static void fillPostCodeEntry( 3076a3316fc6SZhikuiRen std::shared_ptr<AsyncResp> aResp, 3077a3316fc6SZhikuiRen const boost::container::flat_map<uint64_t, uint64_t>& postcode, 3078a3316fc6SZhikuiRen const uint16_t bootIndex, const uint64_t codeIndex = 0, 3079a3316fc6SZhikuiRen const uint64_t skip = 0, const uint64_t top = 0) 3080a3316fc6SZhikuiRen { 3081a3316fc6SZhikuiRen // Get the Message from the MessageRegistry 3082a3316fc6SZhikuiRen const message_registries::Message* message = 3083a3316fc6SZhikuiRen message_registries::getMessage("OpenBMC.0.1.BIOSPOSTCode"); 3084a3316fc6SZhikuiRen 3085a3316fc6SZhikuiRen uint64_t currentCodeIndex = 0; 3086a3316fc6SZhikuiRen nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"]; 3087a3316fc6SZhikuiRen 3088a3316fc6SZhikuiRen uint64_t firstCodeTimeUs = 0; 3089a3316fc6SZhikuiRen for (const std::pair<uint64_t, uint64_t>& code : postcode) 3090a3316fc6SZhikuiRen { 3091a3316fc6SZhikuiRen currentCodeIndex++; 3092a3316fc6SZhikuiRen std::string postcodeEntryID = 3093a3316fc6SZhikuiRen "B" + std::to_string(bootIndex) + "-" + 3094a3316fc6SZhikuiRen std::to_string(currentCodeIndex); // 1 based index in EntryID string 3095a3316fc6SZhikuiRen 3096a3316fc6SZhikuiRen uint64_t usecSinceEpoch = code.first; 3097a3316fc6SZhikuiRen uint64_t usTimeOffset = 0; 3098a3316fc6SZhikuiRen 3099a3316fc6SZhikuiRen if (1 == currentCodeIndex) 3100a3316fc6SZhikuiRen { // already incremented 3101a3316fc6SZhikuiRen firstCodeTimeUs = code.first; 3102a3316fc6SZhikuiRen } 3103a3316fc6SZhikuiRen else 3104a3316fc6SZhikuiRen { 3105a3316fc6SZhikuiRen usTimeOffset = code.first - firstCodeTimeUs; 3106a3316fc6SZhikuiRen } 3107a3316fc6SZhikuiRen 3108a3316fc6SZhikuiRen // skip if no specific codeIndex is specified and currentCodeIndex does 3109a3316fc6SZhikuiRen // not fall between top and skip 3110a3316fc6SZhikuiRen if ((codeIndex == 0) && 3111a3316fc6SZhikuiRen (currentCodeIndex <= skip || currentCodeIndex > top)) 3112a3316fc6SZhikuiRen { 3113a3316fc6SZhikuiRen continue; 3114a3316fc6SZhikuiRen } 3115a3316fc6SZhikuiRen 31164e0453b1SGunnar Mills // skip if a specific codeIndex is specified and does not match the 3117a3316fc6SZhikuiRen // currentIndex 3118a3316fc6SZhikuiRen if ((codeIndex > 0) && (currentCodeIndex != codeIndex)) 3119a3316fc6SZhikuiRen { 3120a3316fc6SZhikuiRen // This is done for simplicity. 1st entry is needed to calculate 3121a3316fc6SZhikuiRen // time offset. To improve efficiency, one can get to the entry 3122a3316fc6SZhikuiRen // directly (possibly with flatmap's nth method) 3123a3316fc6SZhikuiRen continue; 3124a3316fc6SZhikuiRen } 3125a3316fc6SZhikuiRen 3126a3316fc6SZhikuiRen // currentCodeIndex is within top and skip or equal to specified code 3127a3316fc6SZhikuiRen // index 3128a3316fc6SZhikuiRen 3129a3316fc6SZhikuiRen // Get the Created time from the timestamp 3130a3316fc6SZhikuiRen std::string entryTimeStr; 31319c620e21SAsmitha Karunanithi entryTimeStr = crow::utility::getDateTime( 31329c620e21SAsmitha Karunanithi static_cast<std::time_t>(usecSinceEpoch / 1000 / 1000)); 3133a3316fc6SZhikuiRen 3134a3316fc6SZhikuiRen // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex) 3135a3316fc6SZhikuiRen std::ostringstream hexCode; 3136a3316fc6SZhikuiRen hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex 3137a3316fc6SZhikuiRen << code.second; 3138a3316fc6SZhikuiRen std::ostringstream timeOffsetStr; 3139a3316fc6SZhikuiRen // Set Fixed -Point Notation 3140a3316fc6SZhikuiRen timeOffsetStr << std::fixed; 3141a3316fc6SZhikuiRen // Set precision to 4 digits 3142a3316fc6SZhikuiRen timeOffsetStr << std::setprecision(4); 3143a3316fc6SZhikuiRen // Add double to stream 3144a3316fc6SZhikuiRen timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000; 3145a3316fc6SZhikuiRen std::vector<std::string> messageArgs = { 3146a3316fc6SZhikuiRen std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()}; 3147a3316fc6SZhikuiRen 3148a3316fc6SZhikuiRen // Get MessageArgs template from message registry 3149a3316fc6SZhikuiRen std::string msg; 3150a3316fc6SZhikuiRen if (message != nullptr) 3151a3316fc6SZhikuiRen { 3152a3316fc6SZhikuiRen msg = message->message; 3153a3316fc6SZhikuiRen 3154a3316fc6SZhikuiRen // fill in this post code value 3155a3316fc6SZhikuiRen int i = 0; 3156a3316fc6SZhikuiRen for (const std::string& messageArg : messageArgs) 3157a3316fc6SZhikuiRen { 3158a3316fc6SZhikuiRen std::string argStr = "%" + std::to_string(++i); 3159a3316fc6SZhikuiRen size_t argPos = msg.find(argStr); 3160a3316fc6SZhikuiRen if (argPos != std::string::npos) 3161a3316fc6SZhikuiRen { 3162a3316fc6SZhikuiRen msg.replace(argPos, argStr.length(), messageArg); 3163a3316fc6SZhikuiRen } 3164a3316fc6SZhikuiRen } 3165a3316fc6SZhikuiRen } 3166a3316fc6SZhikuiRen 3167d4342a92STim Lee // Get Severity template from message registry 3168d4342a92STim Lee std::string severity; 3169d4342a92STim Lee if (message != nullptr) 3170d4342a92STim Lee { 3171d4342a92STim Lee severity = message->severity; 3172d4342a92STim Lee } 3173d4342a92STim Lee 3174a3316fc6SZhikuiRen // add to AsyncResp 3175a3316fc6SZhikuiRen logEntryArray.push_back({}); 3176a3316fc6SZhikuiRen nlohmann::json& bmcLogEntry = logEntryArray.back(); 3177a3316fc6SZhikuiRen bmcLogEntry = { 3178a3316fc6SZhikuiRen {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 3179a3316fc6SZhikuiRen {"@odata.context", "/redfish/v1/$metadata#LogEntry.LogEntry"}, 3180a3316fc6SZhikuiRen {"@odata.id", "/redfish/v1/Systems/system/LogServices/" 3181a3316fc6SZhikuiRen "PostCodes/Entries/" + 3182a3316fc6SZhikuiRen postcodeEntryID}, 3183a3316fc6SZhikuiRen {"Name", "POST Code Log Entry"}, 3184a3316fc6SZhikuiRen {"Id", postcodeEntryID}, 3185a3316fc6SZhikuiRen {"Message", std::move(msg)}, 3186a3316fc6SZhikuiRen {"MessageId", "OpenBMC.0.1.BIOSPOSTCode"}, 3187a3316fc6SZhikuiRen {"MessageArgs", std::move(messageArgs)}, 3188a3316fc6SZhikuiRen {"EntryType", "Event"}, 3189a3316fc6SZhikuiRen {"Severity", std::move(severity)}, 31909c620e21SAsmitha Karunanithi {"Created", entryTimeStr}}; 3191a3316fc6SZhikuiRen } 3192a3316fc6SZhikuiRen } 3193a3316fc6SZhikuiRen 3194a3316fc6SZhikuiRen static void getPostCodeForEntry(std::shared_ptr<AsyncResp> aResp, 3195a3316fc6SZhikuiRen const uint16_t bootIndex, 3196a3316fc6SZhikuiRen const uint64_t codeIndex) 3197a3316fc6SZhikuiRen { 3198a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3199a3316fc6SZhikuiRen [aResp, bootIndex, codeIndex]( 3200a3316fc6SZhikuiRen const boost::system::error_code ec, 3201a3316fc6SZhikuiRen const boost::container::flat_map<uint64_t, uint64_t>& postcode) { 3202a3316fc6SZhikuiRen if (ec) 3203a3316fc6SZhikuiRen { 3204a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3205a3316fc6SZhikuiRen messages::internalError(aResp->res); 3206a3316fc6SZhikuiRen return; 3207a3316fc6SZhikuiRen } 3208a3316fc6SZhikuiRen 3209a3316fc6SZhikuiRen // skip the empty postcode boots 3210a3316fc6SZhikuiRen if (postcode.empty()) 3211a3316fc6SZhikuiRen { 3212a3316fc6SZhikuiRen return; 3213a3316fc6SZhikuiRen } 3214a3316fc6SZhikuiRen 3215a3316fc6SZhikuiRen fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex); 3216a3316fc6SZhikuiRen 3217a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = 3218a3316fc6SZhikuiRen aResp->res.jsonValue["Members"].size(); 3219a3316fc6SZhikuiRen }, 3220a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", 3221a3316fc6SZhikuiRen "/xyz/openbmc_project/State/Boot/PostCode", 3222a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3223a3316fc6SZhikuiRen bootIndex); 3224a3316fc6SZhikuiRen } 3225a3316fc6SZhikuiRen 3226a3316fc6SZhikuiRen static void getPostCodeForBoot(std::shared_ptr<AsyncResp> aResp, 3227a3316fc6SZhikuiRen const uint16_t bootIndex, 3228a3316fc6SZhikuiRen const uint16_t bootCount, 3229a3316fc6SZhikuiRen const uint64_t entryCount, const uint64_t skip, 3230a3316fc6SZhikuiRen const uint64_t top) 3231a3316fc6SZhikuiRen { 3232a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3233a3316fc6SZhikuiRen [aResp, bootIndex, bootCount, entryCount, skip, 3234a3316fc6SZhikuiRen top](const boost::system::error_code ec, 3235a3316fc6SZhikuiRen const boost::container::flat_map<uint64_t, uint64_t>& 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 uint64_t endCount = entryCount; 3244a3316fc6SZhikuiRen if (!postcode.empty()) 3245a3316fc6SZhikuiRen { 3246a3316fc6SZhikuiRen endCount = entryCount + postcode.size(); 3247a3316fc6SZhikuiRen 3248a3316fc6SZhikuiRen if ((skip < endCount) && ((top + skip) > entryCount)) 3249a3316fc6SZhikuiRen { 3250a3316fc6SZhikuiRen uint64_t thisBootSkip = 3251a3316fc6SZhikuiRen std::max(skip, entryCount) - entryCount; 3252a3316fc6SZhikuiRen uint64_t thisBootTop = 3253a3316fc6SZhikuiRen std::min(top + skip, endCount) - entryCount; 3254a3316fc6SZhikuiRen 3255a3316fc6SZhikuiRen fillPostCodeEntry(aResp, postcode, bootIndex, 0, 3256a3316fc6SZhikuiRen thisBootSkip, thisBootTop); 3257a3316fc6SZhikuiRen } 3258a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = endCount; 3259a3316fc6SZhikuiRen } 3260a3316fc6SZhikuiRen 3261a3316fc6SZhikuiRen // continue to previous bootIndex 3262a3316fc6SZhikuiRen if (bootIndex < bootCount) 3263a3316fc6SZhikuiRen { 3264a3316fc6SZhikuiRen getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1), 3265a3316fc6SZhikuiRen bootCount, endCount, skip, top); 3266a3316fc6SZhikuiRen } 3267a3316fc6SZhikuiRen else 3268a3316fc6SZhikuiRen { 3269a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.nextLink"] = 3270a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/" 3271a3316fc6SZhikuiRen "Entries?$skip=" + 3272a3316fc6SZhikuiRen std::to_string(skip + top); 3273a3316fc6SZhikuiRen } 3274a3316fc6SZhikuiRen }, 3275a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", 3276a3316fc6SZhikuiRen "/xyz/openbmc_project/State/Boot/PostCode", 3277a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3278a3316fc6SZhikuiRen bootIndex); 3279a3316fc6SZhikuiRen } 3280a3316fc6SZhikuiRen 3281a3316fc6SZhikuiRen static void getCurrentBootNumber(std::shared_ptr<AsyncResp> aResp, 3282a3316fc6SZhikuiRen const uint64_t skip, const uint64_t top) 3283a3316fc6SZhikuiRen { 3284a3316fc6SZhikuiRen uint64_t entryCount = 0; 3285a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3286a3316fc6SZhikuiRen [aResp, entryCount, skip, 3287a3316fc6SZhikuiRen top](const boost::system::error_code ec, 3288a3316fc6SZhikuiRen const std::variant<uint16_t>& bootCount) { 3289a3316fc6SZhikuiRen if (ec) 3290a3316fc6SZhikuiRen { 3291a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3292a3316fc6SZhikuiRen messages::internalError(aResp->res); 3293a3316fc6SZhikuiRen return; 3294a3316fc6SZhikuiRen } 3295a3316fc6SZhikuiRen auto pVal = std::get_if<uint16_t>(&bootCount); 3296a3316fc6SZhikuiRen if (pVal) 3297a3316fc6SZhikuiRen { 3298a3316fc6SZhikuiRen getPostCodeForBoot(aResp, 1, *pVal, entryCount, skip, top); 3299a3316fc6SZhikuiRen } 3300a3316fc6SZhikuiRen else 3301a3316fc6SZhikuiRen { 3302a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Post code boot index failed."; 3303a3316fc6SZhikuiRen } 3304a3316fc6SZhikuiRen }, 3305a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", 3306a3316fc6SZhikuiRen "/xyz/openbmc_project/State/Boot/PostCode", 3307a3316fc6SZhikuiRen "org.freedesktop.DBus.Properties", "Get", 3308a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount"); 3309a3316fc6SZhikuiRen } 3310a3316fc6SZhikuiRen 3311a3316fc6SZhikuiRen class PostCodesEntryCollection : public Node 3312a3316fc6SZhikuiRen { 3313a3316fc6SZhikuiRen public: 331452cc112dSEd Tanous PostCodesEntryCollection(App& app) : 3315a3316fc6SZhikuiRen Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/") 3316a3316fc6SZhikuiRen { 3317a3316fc6SZhikuiRen entityPrivileges = { 3318a3316fc6SZhikuiRen {boost::beast::http::verb::get, {{"Login"}}}, 3319a3316fc6SZhikuiRen {boost::beast::http::verb::head, {{"Login"}}}, 3320a3316fc6SZhikuiRen {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 3321a3316fc6SZhikuiRen {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 3322a3316fc6SZhikuiRen {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 3323a3316fc6SZhikuiRen {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 3324a3316fc6SZhikuiRen } 3325a3316fc6SZhikuiRen 3326a3316fc6SZhikuiRen private: 3327a3316fc6SZhikuiRen void doGet(crow::Response& res, const crow::Request& req, 3328cb13a392SEd Tanous const std::vector<std::string>&) override 3329a3316fc6SZhikuiRen { 3330a3316fc6SZhikuiRen std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 3331a3316fc6SZhikuiRen 3332a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.type"] = 3333a3316fc6SZhikuiRen "#LogEntryCollection.LogEntryCollection"; 3334a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.context"] = 3335a3316fc6SZhikuiRen "/redfish/v1/" 3336a3316fc6SZhikuiRen "$metadata#LogEntryCollection.LogEntryCollection"; 3337a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 3338a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3339a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3340a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3341a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3342a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3343a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 3344a3316fc6SZhikuiRen 3345a3316fc6SZhikuiRen uint64_t skip = 0; 3346a3316fc6SZhikuiRen uint64_t top = maxEntriesPerPage; // Show max entries by default 3347a3316fc6SZhikuiRen if (!getSkipParam(asyncResp->res, req, skip)) 3348a3316fc6SZhikuiRen { 3349a3316fc6SZhikuiRen return; 3350a3316fc6SZhikuiRen } 3351a3316fc6SZhikuiRen if (!getTopParam(asyncResp->res, req, top)) 3352a3316fc6SZhikuiRen { 3353a3316fc6SZhikuiRen return; 3354a3316fc6SZhikuiRen } 3355a3316fc6SZhikuiRen getCurrentBootNumber(asyncResp, skip, top); 3356a3316fc6SZhikuiRen } 3357a3316fc6SZhikuiRen }; 3358a3316fc6SZhikuiRen 3359a3316fc6SZhikuiRen class PostCodesEntry : public Node 3360a3316fc6SZhikuiRen { 3361a3316fc6SZhikuiRen public: 336252cc112dSEd Tanous PostCodesEntry(App& app) : 3363a3316fc6SZhikuiRen Node(app, 3364a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/", 3365a3316fc6SZhikuiRen std::string()) 3366a3316fc6SZhikuiRen { 3367a3316fc6SZhikuiRen entityPrivileges = { 3368a3316fc6SZhikuiRen {boost::beast::http::verb::get, {{"Login"}}}, 3369a3316fc6SZhikuiRen {boost::beast::http::verb::head, {{"Login"}}}, 3370a3316fc6SZhikuiRen {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 3371a3316fc6SZhikuiRen {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 3372a3316fc6SZhikuiRen {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 3373a3316fc6SZhikuiRen {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 3374a3316fc6SZhikuiRen } 3375a3316fc6SZhikuiRen 3376a3316fc6SZhikuiRen private: 3377cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 3378a3316fc6SZhikuiRen const std::vector<std::string>& params) override 3379a3316fc6SZhikuiRen { 3380a3316fc6SZhikuiRen std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 3381a3316fc6SZhikuiRen if (params.size() != 1) 3382a3316fc6SZhikuiRen { 3383a3316fc6SZhikuiRen messages::internalError(asyncResp->res); 3384a3316fc6SZhikuiRen return; 3385a3316fc6SZhikuiRen } 3386a3316fc6SZhikuiRen 3387a3316fc6SZhikuiRen const std::string& targetID = params[0]; 3388a3316fc6SZhikuiRen 3389a3316fc6SZhikuiRen size_t bootPos = targetID.find('B'); 3390a3316fc6SZhikuiRen if (bootPos == std::string::npos) 3391a3316fc6SZhikuiRen { 3392a3316fc6SZhikuiRen // Requested ID was not found 3393a3316fc6SZhikuiRen messages::resourceMissingAtURI(asyncResp->res, targetID); 3394a3316fc6SZhikuiRen return; 3395a3316fc6SZhikuiRen } 3396a3316fc6SZhikuiRen std::string_view bootIndexStr(targetID); 3397a3316fc6SZhikuiRen bootIndexStr.remove_prefix(bootPos + 1); 3398a3316fc6SZhikuiRen uint16_t bootIndex = 0; 3399a3316fc6SZhikuiRen uint64_t codeIndex = 0; 3400a3316fc6SZhikuiRen size_t dashPos = bootIndexStr.find('-'); 3401a3316fc6SZhikuiRen 3402a3316fc6SZhikuiRen if (dashPos == std::string::npos) 3403a3316fc6SZhikuiRen { 3404a3316fc6SZhikuiRen return; 3405a3316fc6SZhikuiRen } 3406a3316fc6SZhikuiRen std::string_view codeIndexStr(bootIndexStr); 3407a3316fc6SZhikuiRen bootIndexStr.remove_suffix(dashPos); 3408a3316fc6SZhikuiRen codeIndexStr.remove_prefix(dashPos + 1); 3409a3316fc6SZhikuiRen 3410a3316fc6SZhikuiRen bootIndex = static_cast<uint16_t>( 341123a21a1cSEd Tanous strtoul(std::string(bootIndexStr).c_str(), nullptr, 0)); 341223a21a1cSEd Tanous codeIndex = strtoul(std::string(codeIndexStr).c_str(), nullptr, 0); 3413a3316fc6SZhikuiRen if (bootIndex == 0 || codeIndex == 0) 3414a3316fc6SZhikuiRen { 3415a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string " 3416a3316fc6SZhikuiRen << params[0]; 3417a3316fc6SZhikuiRen } 3418a3316fc6SZhikuiRen 3419a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_4_0.LogEntry"; 3420a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.context"] = 3421a3316fc6SZhikuiRen "/redfish/v1/$metadata#LogEntry.LogEntry"; 3422a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 3423a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/" 3424a3316fc6SZhikuiRen "Entries"; 3425a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3426a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3427a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3428a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3429a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 3430a3316fc6SZhikuiRen 3431a3316fc6SZhikuiRen getPostCodeForEntry(asyncResp, bootIndex, codeIndex); 3432a3316fc6SZhikuiRen } 3433a3316fc6SZhikuiRen }; 3434a3316fc6SZhikuiRen 34351da66f75SEd Tanous } // namespace redfish 3436